2 * Copyright (C) 1995-2007 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
26 * Operators of firm nodes.
28 * This module specifies the opcodes possible for ir nodes. Their
29 * definition is close to the operations specified in UKA Tech-Report
32 #ifndef FIRM_IR_IROP_H
33 #define FIRM_IR_IROP_H
35 #include "firm_types.h"
40 /** The allowed parities */
43 oparity_unary, /**< an unary operator -- considering 'numeric' arguments. */
44 oparity_binary, /**< an binary operator -- considering 'numeric' arguments.*/
45 oparity_trinary, /**< an trinary operator -- considering 'numeric' arguments.*/
46 oparity_zero, /**< no operators, as e.g. Const. */
47 oparity_variable, /**< arity not fixed by opcode, but statically
48 known. E.g., number of arguments to call. */
49 oparity_dynamic, /**< arity depends on state of firm representation.
50 Can change by optimizations...
51 We must allocate a dynamic in array for the node! */
52 oparity_any /**< other arity */
58 irop_flag_none = 0x00000000, /**< Nothing. */
59 irop_flag_labeled = 0x00000001, /**< If set, output edge labels on in-edges in vcg graph. */
60 irop_flag_commutative = 0x00000002, /**< This operation is commutative. */
61 irop_flag_cfopcode = 0x00000004, /**< This operation is a control flow operation. */
62 irop_flag_ip_cfopcode = 0x00000008, /**< This operation manipulates the interprocedural control flow. */
63 irop_flag_fragile = 0x00000010, /**< Set if the operation can change the control flow because
65 irop_flag_forking = 0x00000020, /**< Forking control flow at this operation. */
66 irop_flag_highlevel = 0x00000040, /**< This operation is a pure high-level one and can be
67 skipped in low-level optimizations. */
68 irop_flag_constlike = 0x00000080, /**< This operation has no arguments and is some
69 kind of a constant. */
70 irop_flag_always_opt = 0x00000100, /**< This operation must always be optimized .*/
71 irop_flag_keep = 0x00000200, /**< This operation can be kept in End's keep-alive list. */
72 irop_flag_start_block = 0x00000400, /**< This operation is always placed in the Start block. */
73 irop_flag_side_effect = 0x00000800, /**< this operation produces side effects */
74 irop_flag_machine = 0x00001000, /**< This operation is a machine operation. */
75 irop_flag_machine_op = 0x00002000, /**< This operation is a machine operand. */
76 irop_flag_user = 0x00004000 /**< This flag and all higher ones are free for machine user. */
79 /** The opcodes of the libFirm predefined operations. */
82 iro_Start, iro_End, iro_Jmp, iro_IJmp, iro_Cond, iro_Return,
83 iro_Const, iro_SymConst,
85 iro_Call, iro_Add, iro_Sub, iro_Minus, iro_Mul, iro_Mulh, iro_Quot, iro_DivMod,
86 iro_Div, iro_Mod, iro_Abs, iro_And, iro_Or, iro_Eor, iro_Not,
87 iro_Cmp, iro_Shl, iro_Shr, iro_Shrs, iro_Rot, iro_Conv, iro_Cast,
88 iro_Carry, iro_Borrow,
90 iro_Load, iro_Store, iro_Alloc, iro_Free, iro_Sync,
91 iro_Proj, iro_Tuple, iro_Id, iro_Bad, iro_Confirm,
92 iro_Unknown, iro_Filter, iro_Break, iro_CallBegin, iro_EndReg, iro_EndExcept,
93 iro_NoMem, iro_Mux, iro_Psi, iro_CopyB,
94 iro_InstOf, iro_Raise, iro_Bound,
101 extern ir_op *op_Block; ir_op *get_op_Block (void);
103 extern ir_op *op_Start; ir_op *get_op_Start (void);
104 extern ir_op *op_End; ir_op *get_op_End (void);
105 extern ir_op *op_Jmp; ir_op *get_op_Jmp (void);
106 extern ir_op *op_IJmp; ir_op *get_op_IJmp (void);
107 extern ir_op *op_Cond; ir_op *get_op_Cond (void);
108 extern ir_op *op_Return; ir_op *get_op_Return (void);
109 extern ir_op *op_Sel; ir_op *get_op_Sel (void);
111 extern ir_op *op_Const; ir_op *get_op_Const (void);
112 extern ir_op *op_SymConst; ir_op *get_op_SymConst (void);
114 extern ir_op *op_Call; ir_op *get_op_Call (void);
115 extern ir_op *op_Add; ir_op *get_op_Add (void);
116 extern ir_op *op_Sub; ir_op *get_op_Sub (void);
117 extern ir_op *op_Minus; ir_op *get_op_Minus (void);
118 extern ir_op *op_Mul; ir_op *get_op_Mul (void);
119 extern ir_op *op_Mulh; ir_op *get_op_Mulh (void);
120 extern ir_op *op_Quot; ir_op *get_op_Quot (void);
121 extern ir_op *op_DivMod; ir_op *get_op_DivMod (void);
122 extern ir_op *op_Div; ir_op *get_op_Div (void);
123 extern ir_op *op_Mod; ir_op *get_op_Mod (void);
124 extern ir_op *op_Abs; ir_op *get_op_Abs (void);
125 extern ir_op *op_And; ir_op *get_op_And (void);
126 extern ir_op *op_Or; ir_op *get_op_Or (void);
127 extern ir_op *op_Eor; ir_op *get_op_Eor (void);
128 extern ir_op *op_Not; ir_op *get_op_Not (void);
129 extern ir_op *op_Cmp; ir_op *get_op_Cmp (void);
130 extern ir_op *op_Shl; ir_op *get_op_Shl (void);
131 extern ir_op *op_Shr; ir_op *get_op_Shr (void);
132 extern ir_op *op_Shrs; ir_op *get_op_Shrs (void);
133 extern ir_op *op_Rot; ir_op *get_op_Rot (void);
134 extern ir_op *op_Conv; ir_op *get_op_Conv (void);
135 extern ir_op *op_Cast; ir_op *get_op_Cast (void);
136 extern ir_op *op_Carry; ir_op *get_op_Carry (void);
137 extern ir_op *op_Borrow; ir_op *get_op_Borrow (void);
139 extern ir_op *op_Phi; ir_op *get_op_Phi (void);
141 extern ir_op *op_Load; ir_op *get_op_Load (void);
142 extern ir_op *op_Store; ir_op *get_op_Store (void);
143 extern ir_op *op_Alloc; ir_op *get_op_Alloc (void);
144 extern ir_op *op_Free; ir_op *get_op_Free (void);
146 extern ir_op *op_Sync; ir_op *get_op_Sync (void);
148 extern ir_op *op_Tuple; ir_op *get_op_Tuple (void);
149 extern ir_op *op_Proj; ir_op *get_op_Proj (void);
150 extern ir_op *op_Id; ir_op *get_op_Id (void);
151 extern ir_op *op_Bad; ir_op *get_op_Bad (void);
152 extern ir_op *op_Confirm; ir_op *get_op_Confirm (void);
154 extern ir_op *op_Unknown; ir_op *get_op_Unknown (void);
155 extern ir_op *op_Filter; ir_op *get_op_Filter (void);
156 extern ir_op *op_Break; ir_op *get_op_Break (void);
157 extern ir_op *op_CallBegin; ir_op *get_op_CallBegin (void);
158 extern ir_op *op_EndReg; ir_op *get_op_EndReg (void);
159 extern ir_op *op_EndExcept; ir_op *get_op_EndExcept (void);
161 extern ir_op *op_NoMem; ir_op *get_op_NoMem (void);
162 extern ir_op *op_Mux; ir_op *get_op_Mux (void);
163 extern ir_op *op_Psi; ir_op *get_op_Psi (void);
164 extern ir_op *op_CopyB; ir_op *get_op_CopyB (void);
166 extern ir_op *op_InstOf; ir_op *get_op_InstOf (void);
167 extern ir_op *op_Raise; ir_op *get_op_Raise (void);
168 extern ir_op *op_Bound; ir_op *get_op_Bound (void);
170 extern ir_op *op_Pin; ir_op *get_op_Pin (void);
172 extern ir_op *op_ASM; ir_op *get_op_ASM (void);
174 extern ir_op *op_Anchor; ir_op *get_op_Anchor (void);
176 /** Returns the ident for the opcode name */
177 ident *get_op_ident(const ir_op *op);
179 /** Returns the string for the opcode. */
180 const char *get_op_name(const ir_op *op);
182 /** Returns the enum for the opcode */
183 unsigned get_op_code(const ir_op *op);
185 /** op_pin_state_pinned states */
187 op_pin_state_floats = 0, /**< Nodes of this opcode can be placed in any basic block. */
188 op_pin_state_pinned = 1, /**< Nodes must remain in this basic block. */
189 op_pin_state_exc_pinned, /**< Node must be remain in this basic block if it can throw an
190 exception, else can float. Used internally. */
191 op_pin_state_mem_pinned /**< Node must be remain in this basic block if it can throw an
192 exception or uses memory, else can float. Used internally. */
195 const char *get_op_pin_state_name(op_pin_state s);
197 /** gets pinned state of an opcode */
198 op_pin_state get_op_pinned(const ir_op *op);
200 /** Sets pinned in the opcode. Setting it to floating has no effect
201 for Block, Phi and control flow nodes. */
202 void set_op_pinned(ir_op *op, op_pin_state pinned);
204 /** Returns the next free IR opcode number, allows to register user ops */
205 unsigned get_next_ir_opcode(void);
207 /** Returns the next free n IR opcode number, allows to register a bunch of user ops */
208 unsigned get_next_ir_opcodes(unsigned num);
211 * A generic function pointer.
213 typedef void (*op_func)(void);
215 /** The NULL-function. */
216 #define NULL_FUNC ((generic_func)(NULL))
219 * Returns the generic function pointer from an ir operation.
221 op_func get_generic_function_ptr(const ir_op *op);
224 * Store a generic function pointer into an ir operation.
226 void set_generic_function_ptr(ir_op *op, op_func func);
229 * The compute value operation.
230 * This operation evaluates an IR node into a tarval if possible,
231 * returning tarval_bad otherwise.
233 typedef tarval *(*computed_value_func)(ir_node *self);
236 * The equivalent node operation.
237 * This operation returns an equivalent node for the input node.
238 * It does not create new nodes. It is therefore safe to free self
239 * if the node returned is not self.
240 * If a node returns a Tuple we can not just skip it. If the size of the
241 * in array fits, we transform n into a tuple (e.g., possible for Div).
243 typedef ir_node *(*equivalent_node_func)(ir_node *self);
246 * The transform node operation.
247 * This operation tries several [inplace] [optimizing] transformations
248 * and returns an equivalent node.
249 * The difference to equivalent_node() is that these
250 * transformations _do_ generate new nodes, and thus the old node must
251 * not be freed even if the equivalent node isn't the old one.
253 typedef ir_node *(*transform_node_func)(ir_node *self);
256 * The node attribute compare operation.
257 * Compares the nodes attributes of two nodes of identical opcode
258 * and returns 0 if the attributes are identical, 1 if they differ.
260 typedef int (*node_cmp_attr_func)(ir_node *a, ir_node *b);
263 * The reassociation operation.
264 * Called from a walker. Returns non-zero if
265 * a reassociation rule was applied.
266 * The pointer n is set to the newly created node, if some reassociation
269 typedef int (*reassociate_func)(ir_node **n);
272 * The copy attribute operation.
273 * Copy the node attributes from a 'old' node to a 'new' one.
275 typedef void (*copy_attr_func)(const ir_node *old_node, ir_node *new_node);
278 * The get_type operation.
279 * Return the type of the node self.
281 typedef ir_type *(*get_type_func)(ir_node *self);
284 * The get_type_attr operation. Used to traverse all types that can be
285 * accessed from an ir_graph.
286 * Return the type attribute of the node self.
288 typedef ir_type *(*get_type_attr_func)(ir_node *self);
291 * The get_entity_attr operation. Used to traverse all entities that can be
292 * accessed from an ir_graph.
293 * Return the entity attribute of the node self.
295 typedef ir_entity *(*get_entity_attr_func)(ir_node *self);
298 * The verify_node operation.
299 * Return non-zero if the node verification is ok, else 0.
300 * Depending on the node verification settings, may even assert.
302 * @see do_node_verification()
304 typedef int (*verify_node_func)(ir_node *self, ir_graph *irg);
307 * The verify_node operation for Proj(X).
308 * Return non-zero if the node verification is ok, else 0.
309 * Depending on the node verification settings, may even assert.
311 * @see do_node_verification()
313 typedef int (*verify_proj_node_func)(ir_node *self, ir_node *proj);
316 * Reasons to call the dump_node operation:
319 dump_node_opcode_txt, /**< dump the opcode */
320 dump_node_mode_txt, /**< dump the mode */
321 dump_node_nodeattr_txt, /**< dump node attributes to be shown in the label */
322 dump_node_info_txt /**< dump node attributes into info1 */
326 * The dump_node operation.
327 * Writes several informations requested by reason to
330 typedef int (*dump_node_func)(ir_node *self, FILE *F, dump_reason_t reason);
336 computed_value_func computed_value; /**< Evaluates a node into a tarval if possible. */
337 equivalent_node_func equivalent_node; /**< Optimizes the node by returning an equivalent one. */
338 transform_node_func transform_node; /**< Optimizes the node by transforming it. */
339 node_cmp_attr_func node_cmp_attr; /**< Compares two node attributes. */
340 reassociate_func reassociate; /**< Reassociate a tree. */
341 copy_attr_func copy_attr; /**< Copy node attributes. */
342 get_type_func get_type; /**< Return the type of a node. */
343 get_type_attr_func get_type_attr; /**< Return the type attribute of a node. */
344 get_entity_attr_func get_entity_attr; /**< Return the entity attribute of a node. */
345 verify_node_func verify_node; /**< Verify the node. */
346 verify_proj_node_func verify_proj_node; /**< Verify the Proj node. */
347 dump_node_func dump_node; /**< Dump a node. */
348 op_func generic; /**< A generic function pointer. */
352 * Creates a new ir operation.
354 * @param code the opcode, one of type \c opcode
355 * @param name the printable name of this opcode
356 * @param p whether operations of this opcode are op_pin_state_pinned or floating
357 * @param flags a bitmask of irop_flags describing the behavior of the ir operation
358 * @param opar the parity of this ir operation
359 * @param op_index if the parity is oparity_unary, oparity_binary or oparity_trinary the index
360 * of the left operand
361 * @param ops operations for this opcode, iff NULL default operations are used
362 * @param attr_size attribute size for this ir operation
364 * @return The generated ir operation.
366 * This function can create all standard Firm opcode as well as new ones.
367 * The behavior of new opcode depends on the operations \c ops and the \c flags.
369 ir_op *new_ir_op(unsigned code, const char *name, op_pin_state p,
370 unsigned flags, op_arity opar, int op_index, size_t attr_size,
371 const ir_op_ops *ops);
373 /** Returns the ir_op_ops of an ir_op. */
374 const ir_op_ops *get_op_ops(const ir_op *op);