2 * Copyright (C) 1995-2011 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Representation of opcode of intermediate operation.
23 * @author Christian Schaefer, Goetz Lindenmaier, Michael Beck
24 * @brief Operators of firm nodes.
26 #ifndef FIRM_IR_IROP_H
27 #define FIRM_IR_IROP_H
30 #include "firm_types.h"
37 * @defgroup ir_op Node Opcodes
39 * This module specifies the opcodes possible for ir nodes. Their
40 * definition is close to the operations specified in UKA Tech-Report
46 /** The allowed arities. */
49 oparity_unary, /**< An unary operator -- considering 'numeric' arguments. */
50 oparity_binary, /**< A binary operator -- considering 'numeric' arguments.*/
51 oparity_trinary, /**< A trinary operator -- considering 'numeric' arguments.*/
52 oparity_zero, /**< A zero arity operator, e.g. a Const. */
53 oparity_variable, /**< The arity is not fixed by opcode, but statically
54 known. E.g., number of arguments to call. */
55 oparity_dynamic, /**< The arity depends on state of Firm representation.
56 Can be changed by optimizations...
57 We must allocate a dynamic in array for the node! */
58 oparity_any /**< Any other arity. */
64 irop_flag_none = 0, /**< Nothing. */
65 irop_flag_labeled = 1U << 0, /**< If set, output edge labels on in-edges in vcg graph. */
66 irop_flag_commutative = 1U << 1, /**< This operation is commutative. */
67 irop_flag_cfopcode = 1U << 2, /**< This operation is a control flow operation. */
68 irop_flag_fragile = 1U << 3, /**< Set if the operation can change the
69 control flow because of an exception.
71 irop_flag_forking = 1U << 4, /**< Forking control flow at this operation. */
72 irop_flag_highlevel = 1U << 5, /**< This operation is a pure high-level one and can be
73 skipped in low-level optimizations. */
74 irop_flag_constlike = 1U << 6, /**< This operation has no arguments and is some
75 kind of a constant. */
76 irop_flag_always_opt = 1U << 7, /**< This operation must always be optimized .*/
77 irop_flag_keep = 1U << 8, /**< This operation can be kept in End's keep-alive list. */
78 irop_flag_start_block = 1U << 9, /**< This operation is always placed in the Start block. */
79 irop_flag_uses_memory = 1U << 10, /**< This operation has a memory input and may change the memory state. */
80 irop_flag_dump_noblock = 1U << 11, /**< node should be dumped outside any blocks */
81 irop_flag_dump_noinput = 1U << 12, /**< node is a placeholder for "no input" */
82 irop_flag_cse_neutral = 1U << 13, /**< This operation is CSE neutral to its users. */
83 /** This operation jumps to an unknown destination. The CFG is a
84 * conservative aproximation in this case. You cannot change the destination
85 * of an unknown_jump */
86 irop_flag_unknown_jump = 1U << 14,
89 /** Returns the ident for the opcode name */
90 FIRM_API ident *get_op_ident(const ir_op *op);
92 /** Returns the string for the opcode. */
93 FIRM_API const char *get_op_name(const ir_op *op);
95 /** Returns the enum for the opcode */
96 FIRM_API unsigned get_op_code(const ir_op *op);
98 /** Returns a human readable name of an op_pin_state. */
99 FIRM_API const char *get_op_pin_state_name(op_pin_state s);
101 /** Returns pinned state of an opcode. */
102 FIRM_API op_pin_state get_op_pinned(const ir_op *op);
104 /** Sets pinned in the opcode. Setting it to floating has no effect
105 for Block, Phi and control flow nodes. */
106 FIRM_API void set_op_pinned(ir_op *op, op_pin_state pinned);
108 /** Returns the next free IR opcode number, allows to register user ops. */
109 FIRM_API unsigned get_next_ir_opcode(void);
111 /** Returns the next free n IR opcode number, allows to register a bunch of user ops. */
112 FIRM_API unsigned get_next_ir_opcodes(unsigned num);
115 * A generic function pointer type.
117 typedef void (*op_func)(void);
119 /** The NULL-function. */
120 #define NULL_FUNC ((generic_func)(NULL))
123 * Returns the generic function pointer from an IR operation.
125 FIRM_API op_func get_generic_function_ptr(const ir_op *op);
128 * Stores a generic function pointer into an IR operation.
130 FIRM_API void set_generic_function_ptr(ir_op *op, op_func func);
133 * Returns the irop flags of an IR opcode.
135 FIRM_API irop_flags get_op_flags(const ir_op *op);
138 * The hash operation.
139 * This operation calculates a hash value for a given IR node.
141 typedef unsigned (*hash_func)(const ir_node *self);
144 * The compute value operation.
145 * This operation evaluates an IR node into a tarval if possible,
146 * returning tarval_bad otherwise.
148 typedef ir_tarval *(*computed_value_func)(const ir_node *self);
151 * The equivalent node operation.
152 * This operation returns an equivalent node for the input node.
153 * It does not create new nodes. It is therefore safe to free self
154 * if the node returned is not self.
155 * If a node returns a Tuple we can not just skip it. If the size of the
156 * in array fits, we transform n into a tuple (e.g., possible for Div).
158 typedef ir_node *(*equivalent_node_func)(ir_node *self);
161 * The transform node operation.
162 * This operation tries several [inplace] [optimizing] transformations
163 * and returns an equivalent node.
164 * The difference to equivalent_node() is that these
165 * transformations _do_ generate new nodes, and thus the old node must
166 * not be freed even if the equivalent node isn't the old one.
168 typedef ir_node *(*transform_node_func)(ir_node *self);
171 * The node attribute compare operation.
172 * Compares the nodes attributes of two nodes of identical opcode
173 * and returns 0 if the attributes are identical, 1 if they differ.
175 typedef int (*node_cmp_attr_func)(const ir_node *a, const ir_node *b);
178 * The reassociation operation.
179 * Called from a walker. Returns non-zero if
180 * a reassociation rule was applied.
181 * The pointer n is set to the newly created node, if some reassociation
184 typedef int (*reassociate_func)(ir_node **n);
187 * The copy attribute operation.
188 * Copy the node attributes from an 'old' node to a 'new' one.
190 typedef void (*copy_attr_func)(ir_graph *irg, const ir_node *old_node, ir_node *new_node);
193 * The get_type_attr operation. Used to traverse all types that can be
194 * accessed from an ir_graph.
195 * Returns the type attribute of the node self.
197 typedef ir_type *(*get_type_attr_func)(const ir_node *self);
200 * The get_entity_attr operation. Used to traverse all entities that can be
201 * accessed from an ir_graph.
202 * Returns the entity attribute of the node self.
204 typedef ir_entity *(*get_entity_attr_func)(const ir_node *self);
207 * The verify_node operation.
208 * Returns non-zero if the node verification is ok, else 0.
209 * Depending on the node verification settings, may even assert.
211 * @see do_node_verification()
213 typedef int (*verify_node_func)(const ir_node *node);
216 * The verify_node operation for Proj(X).
217 * Returns non-zero if the node verification is ok, else 0.
218 * Depending on the node verification settings, may even assert.
220 * @see do_node_verification()
222 typedef int (*verify_proj_node_func)(const ir_node *proj);
225 * Reasons to call the dump_node operation:
228 dump_node_opcode_txt, /**< Dump the opcode. */
229 dump_node_mode_txt, /**< Dump the mode. */
230 dump_node_nodeattr_txt, /**< Dump node attributes to be shown in the label. */
231 dump_node_info_txt /**< Dump node attributes into info1. */
235 * The dump_node operation.
236 * Writes several informations requested by reason to
239 typedef void (*dump_node_func)(FILE *out, const ir_node *self, dump_reason_t reason);
245 hash_func hash; /**< Calculate a hash value for an IR node. */
246 computed_value_func computed_value; /**< Evaluates a node into a tarval if possible. */
247 computed_value_func computed_value_Proj; /**< Evaluates a Proj node into a tarval if possible. */
248 equivalent_node_func equivalent_node; /**< Optimizes the node by returning an equivalent one. */
249 equivalent_node_func equivalent_node_Proj; /**< Optimizes the Proj node by returning an equivalent one. */
250 transform_node_func transform_node; /**< Optimizes the node by transforming it. */
251 equivalent_node_func transform_node_Proj; /**< Optimizes the Proj node by transforming it. */
252 node_cmp_attr_func node_cmp_attr; /**< Compares two node attributes. */
253 reassociate_func reassociate; /**< Reassociate a tree. */
254 copy_attr_func copy_attr; /**< Copy node attributes. */
255 get_type_attr_func get_type_attr; /**< Returns the type attribute of a node. */
256 get_entity_attr_func get_entity_attr; /**< Returns the entity attribute of a node. */
257 verify_node_func verify_node; /**< Verify the node. */
258 verify_proj_node_func verify_proj_node; /**< Verify the Proj node. */
259 dump_node_func dump_node; /**< Dump a node. */
260 op_func generic; /**< A generic function pointer. */
261 const arch_irn_ops_t *be_ops; /**< callbacks used by the backend. */
265 * Creates a new IR operation.
267 * @param code the opcode, one of type \c opcode
268 * @param name the printable name of this opcode
269 * @param p whether operations of this opcode are op_pin_state_pinned or floating
270 * @param flags a bitmask of irop_flags describing the behavior of the IR operation
271 * @param opar the parity of this IR operation
272 * @param op_index if the parity is oparity_unary, oparity_binary or oparity_trinary the index
273 * of the left operand
274 * @param ops operations for this opcode, iff NULL default operations are used
275 * @param attr_size attribute size for this IR operation
277 * @return The generated IR operation.
279 * This function can create all standard Firm opcode as well as new ones.
280 * The behavior of new opcode depends on the operations \c ops and the \c flags.
282 FIRM_API ir_op *new_ir_op(unsigned code, const char *name, op_pin_state p,
283 unsigned flags, op_arity opar, int op_index,
284 size_t attr_size, const ir_op_ops *ops);
286 /** Returns one more than the highest opcode code in use. */
287 FIRM_API unsigned ir_get_n_opcodes(void);
290 * Returns the opcode with code @p code.
292 * @p code has to be smaller than get_irp_n_opcode(), returns NULL if
293 * no opcode with the code exists.
295 FIRM_API ir_op *ir_get_opcode(unsigned code);
297 /** Sets the generic function pointer of all opcodes to NULL */
298 FIRM_API void ir_clear_opcodes_generic_func(void);
301 * Sets memory input of operation using memory
303 FIRM_API void ir_op_set_memory_index(ir_op *op, int memory_index);
306 * Sets proj-number for X_regular and X_except projs of fragile nodes.
307 * Note: should only be used immediately after new_ir_op
309 FIRM_API void ir_op_set_fragile_indices(ir_op *op, int pn_x_regular,
312 /** Returns the ir_op_ops of an ir_op. */
313 FIRM_API const ir_op_ops *get_op_ops(const ir_op *op);