2 * Copyright (C) 1995-2008 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
36 #include "firm_types.h"
40 /** The allowed arities. */
43 oparity_unary, /**< An unary operator -- considering 'numeric' arguments. */
44 oparity_binary, /**< A binary operator -- considering 'numeric' arguments.*/
45 oparity_trinary, /**< A trinary operator -- considering 'numeric' arguments.*/
46 oparity_zero, /**< A zero arity operator, e.g. a Const. */
47 oparity_variable, /**< The arity is not fixed by opcode, but statically
48 known. E.g., number of arguments to call. */
49 oparity_dynamic, /**< The arity depends on state of Firm representation.
50 Can be changed by optimizations...
51 We must allocate a dynamic in array for the node! */
52 oparity_any /**< 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_uses_memory = 0x00000800, /**< This operation has a memory input and may change the memory state. */
74 irop_flag_dump_noblock = 0x00001000, /**< node should be dumped outside any blocks */
75 irop_flag_dump_noinput = 0x00002000, /**< node is a placeholder for "no input" */
76 irop_flag_machine = 0x00010000, /**< This operation is a machine operation. */
77 irop_flag_machine_op = 0x00020000, /**< This operation is a machine operand. */
78 irop_flag_cse_neutral = 0x00040000, /**< This operation is CSE neutral to its users. */
79 irop_flag_user = 0x00080000 /**< This flag and all higher ones are free for machine user. */
82 /** The opcodes of the libFirm predefined operations. */
85 iro_First = iro_Block,
86 iro_Start, iro_End, iro_Jmp, iro_IJmp, iro_Cond, iro_Return,
87 iro_Const, iro_SymConst,
89 iro_Call, iro_Add, iro_Sub, iro_Minus, iro_Mul, iro_Mulh, iro_Quot, iro_DivMod,
90 iro_Div, iro_Mod, iro_Abs, iro_And, iro_Or, iro_Eor, iro_Not,
91 iro_Cmp, iro_Shl, iro_Shr, iro_Shrs, iro_Rotl, iro_Conv, iro_Cast,
92 iro_Carry, iro_Borrow,
94 iro_Load, iro_Store, iro_Alloc, iro_Free, iro_Sync,
95 iro_Proj, iro_Tuple, iro_Id, iro_Bad, iro_Confirm,
96 iro_Unknown, iro_Filter, iro_Break, iro_CallBegin, iro_EndReg, iro_EndExcept,
97 iro_NoMem, iro_Mux, iro_CopyB,
98 iro_InstOf, iro_Raise, iro_Bound,
100 iro_ASM, iro_Builtin,
103 /* first not middleend node number */
104 iro_Last = iro_Anchor,
105 /* first backend node number */
107 /* backend specific nodes */
108 beo_Spill = beo_First,
123 /* last backend node number */
124 beo_Last = beo_Barrier,
125 /* first unfixed number. Dynamic node numbers start here */
129 FIRM_API ir_op *op_Abs;
130 FIRM_API ir_op *op_Add;
131 FIRM_API ir_op *op_Alloc;
132 FIRM_API ir_op *op_Anchor;
133 FIRM_API ir_op *op_And;
134 FIRM_API ir_op *op_ASM;
135 FIRM_API ir_op *op_Bad;
136 FIRM_API ir_op *op_Block;
137 FIRM_API ir_op *op_Borrow;
138 FIRM_API ir_op *op_Bound;
139 FIRM_API ir_op *op_Break;
140 FIRM_API ir_op *op_Builtin;
141 FIRM_API ir_op *op_Call;
142 FIRM_API ir_op *op_CallBegin;
143 FIRM_API ir_op *op_Carry;
144 FIRM_API ir_op *op_Cast;
145 FIRM_API ir_op *op_Cmp;
146 FIRM_API ir_op *op_Cond;
147 FIRM_API ir_op *op_Confirm;
148 FIRM_API ir_op *op_Const;
149 FIRM_API ir_op *op_Conv;
150 FIRM_API ir_op *op_CopyB;
151 FIRM_API ir_op *op_Div;
152 FIRM_API ir_op *op_DivMod;
153 FIRM_API ir_op *op_Dummy;
154 FIRM_API ir_op *op_End;
155 FIRM_API ir_op *op_EndExcept;
156 FIRM_API ir_op *op_EndReg;
157 FIRM_API ir_op *op_Eor;
158 FIRM_API ir_op *op_Filter;
159 FIRM_API ir_op *op_Free;
160 FIRM_API ir_op *op_Id;
161 FIRM_API ir_op *op_IJmp;
162 FIRM_API ir_op *op_InstOf;
163 FIRM_API ir_op *op_Jmp;
164 FIRM_API ir_op *op_Load;
165 FIRM_API ir_op *op_Minus;
166 FIRM_API ir_op *op_Mod;
167 FIRM_API ir_op *op_Mul;
168 FIRM_API ir_op *op_Mulh;
169 FIRM_API ir_op *op_Mux;
170 FIRM_API ir_op *op_NoMem;
171 FIRM_API ir_op *op_Not;
172 FIRM_API ir_op *op_Or;
173 FIRM_API ir_op *op_Phi;
174 FIRM_API ir_op *op_Pin;
175 FIRM_API ir_op *op_Proj;
176 FIRM_API ir_op *op_Quot;
177 FIRM_API ir_op *op_Raise;
178 FIRM_API ir_op *op_Return;
179 FIRM_API ir_op *op_Rotl;
180 FIRM_API ir_op *op_Sel;
181 FIRM_API ir_op *op_Shl;
182 FIRM_API ir_op *op_Shrs;
183 FIRM_API ir_op *op_Shr;
184 FIRM_API ir_op *op_Start;
185 FIRM_API ir_op *op_Store;
186 FIRM_API ir_op *op_Sub;
187 FIRM_API ir_op *op_SymConst;
188 FIRM_API ir_op *op_Sync;
189 FIRM_API ir_op *op_Tuple;
190 FIRM_API ir_op *op_Unknown;
192 FIRM_API ir_op *get_op_Abs (void);
193 FIRM_API ir_op *get_op_Add (void);
194 FIRM_API ir_op *get_op_Alloc (void);
195 FIRM_API ir_op *get_op_Anchor (void);
196 FIRM_API ir_op *get_op_And (void);
197 FIRM_API ir_op *get_op_ASM (void);
198 FIRM_API ir_op *get_op_Bad (void);
199 FIRM_API ir_op *get_op_Block (void);
200 FIRM_API ir_op *get_op_Borrow (void);
201 FIRM_API ir_op *get_op_Bound (void);
202 FIRM_API ir_op *get_op_Break (void);
203 FIRM_API ir_op *get_op_Builtin (void);
204 FIRM_API ir_op *get_op_CallBegin (void);
205 FIRM_API ir_op *get_op_Call (void);
206 FIRM_API ir_op *get_op_Carry (void);
207 FIRM_API ir_op *get_op_Cast (void);
208 FIRM_API ir_op *get_op_Cmp (void);
209 FIRM_API ir_op *get_op_Cond (void);
210 FIRM_API ir_op *get_op_Confirm (void);
211 FIRM_API ir_op *get_op_Const (void);
212 FIRM_API ir_op *get_op_Conv (void);
213 FIRM_API ir_op *get_op_CopyB (void);
214 FIRM_API ir_op *get_op_DivMod (void);
215 FIRM_API ir_op *get_op_Div (void);
216 FIRM_API ir_op *get_op_Dummy (void);
217 FIRM_API ir_op *get_op_EndExcept (void);
218 FIRM_API ir_op *get_op_EndReg (void);
219 FIRM_API ir_op *get_op_End (void);
220 FIRM_API ir_op *get_op_Eor (void);
221 FIRM_API ir_op *get_op_Filter (void);
222 FIRM_API ir_op *get_op_Free (void);
223 FIRM_API ir_op *get_op_Id (void);
224 FIRM_API ir_op *get_op_IJmp (void);
225 FIRM_API ir_op *get_op_InstOf (void);
226 FIRM_API ir_op *get_op_Jmp (void);
227 FIRM_API ir_op *get_op_Load (void);
228 FIRM_API ir_op *get_op_Minus (void);
229 FIRM_API ir_op *get_op_Mod (void);
230 FIRM_API ir_op *get_op_Mulh (void);
231 FIRM_API ir_op *get_op_Mul (void);
232 FIRM_API ir_op *get_op_Mux (void);
233 FIRM_API ir_op *get_op_NoMem (void);
234 FIRM_API ir_op *get_op_Not (void);
235 FIRM_API ir_op *get_op_Or (void);
236 FIRM_API ir_op *get_op_Phi (void);
237 FIRM_API ir_op *get_op_Pin (void);
238 FIRM_API ir_op *get_op_Proj (void);
239 FIRM_API ir_op *get_op_Quot (void);
240 FIRM_API ir_op *get_op_Raise (void);
241 FIRM_API ir_op *get_op_Return (void);
242 FIRM_API ir_op *get_op_Rotl (void);
243 FIRM_API ir_op *get_op_Sel (void);
244 FIRM_API ir_op *get_op_Shl (void);
245 FIRM_API ir_op *get_op_Shrs (void);
246 FIRM_API ir_op *get_op_Shr (void);
247 FIRM_API ir_op *get_op_Start (void);
248 FIRM_API ir_op *get_op_Store (void);
249 FIRM_API ir_op *get_op_Sub (void);
250 FIRM_API ir_op *get_op_SymConst (void);
251 FIRM_API ir_op *get_op_Sync (void);
252 FIRM_API ir_op *get_op_Tuple (void);
253 FIRM_API ir_op *get_op_Unknown (void);
255 /** Returns the ident for the opcode name */
256 FIRM_API ident *get_op_ident(const ir_op *op);
258 /** Returns the string for the opcode. */
259 FIRM_API const char *get_op_name(const ir_op *op);
261 /** Returns the enum for the opcode */
262 FIRM_API unsigned get_op_code(const ir_op *op);
264 /** Returns a human readable name of an op_pin_state. */
265 FIRM_API const char *get_op_pin_state_name(op_pin_state s);
267 /** Gets pinned state of an opcode. */
268 FIRM_API op_pin_state get_op_pinned(const ir_op *op);
270 /** Sets pinned in the opcode. Setting it to floating has no effect
271 for Block, Phi and control flow nodes. */
272 FIRM_API void set_op_pinned(ir_op *op, op_pin_state pinned);
274 /** Returns the next free IR opcode number, allows to register user ops. */
275 FIRM_API unsigned get_next_ir_opcode(void);
277 /** Returns the next free n IR opcode number, allows to register a bunch of user ops. */
278 FIRM_API unsigned get_next_ir_opcodes(unsigned num);
281 * A generic function pointer type.
283 typedef void (*op_func)(void);
285 /** The NULL-function. */
286 #define NULL_FUNC ((generic_func)(NULL))
289 * Returns the generic function pointer from an IR operation.
291 FIRM_API op_func get_generic_function_ptr(const ir_op *op);
294 * Store a generic function pointer into an IR operation.
296 FIRM_API void set_generic_function_ptr(ir_op *op, op_func func);
299 * Return the irop flags of an IR opcode.
301 FIRM_API irop_flags get_op_flags(const ir_op *op);
304 * The hash operation.
305 * This operation calculates a hash value for a given IR node.
307 typedef unsigned (*hash_func)(const ir_node *self);
310 * The compute value operation.
311 * This operation evaluates an IR node into a tarval if possible,
312 * returning tarval_bad otherwise.
314 typedef tarval *(*computed_value_func)(const ir_node *self);
317 * The equivalent node operation.
318 * This operation returns an equivalent node for the input node.
319 * It does not create new nodes. It is therefore safe to free self
320 * if the node returned is not self.
321 * If a node returns a Tuple we can not just skip it. If the size of the
322 * in array fits, we transform n into a tuple (e.g., possible for Div).
324 typedef ir_node *(*equivalent_node_func)(ir_node *self);
327 * The transform node operation.
328 * This operation tries several [inplace] [optimizing] transformations
329 * and returns an equivalent node.
330 * The difference to equivalent_node() is that these
331 * transformations _do_ generate new nodes, and thus the old node must
332 * not be freed even if the equivalent node isn't the old one.
334 typedef ir_node *(*transform_node_func)(ir_node *self);
337 * The node attribute compare operation.
338 * Compares the nodes attributes of two nodes of identical opcode
339 * and returns 0 if the attributes are identical, 1 if they differ.
341 typedef int (*node_cmp_attr_func)(ir_node *a, ir_node *b);
344 * The reassociation operation.
345 * Called from a walker. Returns non-zero if
346 * a reassociation rule was applied.
347 * The pointer n is set to the newly created node, if some reassociation
350 typedef int (*reassociate_func)(ir_node **n);
353 * The copy attribute operation.
354 * Copy the node attributes from an 'old' node to a 'new' one.
356 typedef void (*copy_attr_func)(ir_graph *irg, const ir_node *old_node, ir_node *new_node);
359 * The get_type operation.
360 * Return the type of the node self.
362 typedef ir_type *(*get_type_func)(const ir_node *self);
365 * The get_type_attr operation. Used to traverse all types that can be
366 * accessed from an ir_graph.
367 * Return the type attribute of the node self.
369 typedef ir_type *(*get_type_attr_func)(const ir_node *self);
372 * The get_entity_attr operation. Used to traverse all entities that can be
373 * accessed from an ir_graph.
374 * Return the entity attribute of the node self.
376 typedef ir_entity *(*get_entity_attr_func)(const ir_node *self);
379 * The verify_node operation.
380 * Return non-zero if the node verification is ok, else 0.
381 * Depending on the node verification settings, may even assert.
383 * @see do_node_verification()
385 typedef int (*verify_node_func)(ir_node *self, ir_graph *irg);
388 * The verify_node operation for Proj(X).
389 * Return non-zero if the node verification is ok, else 0.
390 * Depending on the node verification settings, may even assert.
392 * @see do_node_verification()
394 typedef int (*verify_proj_node_func)(ir_node *self, ir_node *proj);
397 * Reasons to call the dump_node operation:
400 dump_node_opcode_txt, /**< Dump the opcode. */
401 dump_node_mode_txt, /**< Dump the mode. */
402 dump_node_nodeattr_txt, /**< Dump node attributes to be shown in the label. */
403 dump_node_info_txt /**< Dump node attributes into info1. */
407 * The dump_node operation.
408 * Writes several informations requested by reason to
411 typedef int (*dump_node_func)(ir_node *self, FILE *F, dump_reason_t reason);
417 hash_func hash; /**< Calculate a hash value for an IR node. */
418 computed_value_func computed_value; /**< Evaluates a node into a tarval if possible. */
419 computed_value_func computed_value_Proj; /**< Evaluates a Proj node into a tarval if possible. */
420 equivalent_node_func equivalent_node; /**< Optimizes the node by returning an equivalent one. */
421 equivalent_node_func equivalent_node_Proj; /**< Optimizes the Proj node by returning an equivalent one. */
422 transform_node_func transform_node; /**< Optimizes the node by transforming it. */
423 equivalent_node_func transform_node_Proj; /**< Optimizes the Proj node by transforming it. */
424 node_cmp_attr_func node_cmp_attr; /**< Compares two node attributes. */
425 reassociate_func reassociate; /**< Reassociate a tree. */
426 copy_attr_func copy_attr; /**< Copy node attributes. */
427 get_type_func get_type; /**< Return the type of a node. */
428 get_type_attr_func get_type_attr; /**< Return the type attribute of a node. */
429 get_entity_attr_func get_entity_attr; /**< Return the entity attribute of a node. */
430 verify_node_func verify_node; /**< Verify the node. */
431 verify_proj_node_func verify_proj_node; /**< Verify the Proj node. */
432 dump_node_func dump_node; /**< Dump a node. */
433 op_func generic; /**< A generic function pointer. */
434 const arch_irn_ops_t *be_ops; /**< callbacks used by the backend. */
438 * Creates a new IR operation.
440 * @param code the opcode, one of type \c opcode
441 * @param name the printable name of this opcode
442 * @param p whether operations of this opcode are op_pin_state_pinned or floating
443 * @param flags a bitmask of irop_flags describing the behavior of the IR operation
444 * @param opar the parity of this IR operation
445 * @param op_index if the parity is oparity_unary, oparity_binary or oparity_trinary the index
446 * of the left operand
447 * @param ops operations for this opcode, iff NULL default operations are used
448 * @param attr_size attribute size for this IR operation
450 * @return The generated IR operation.
452 * This function can create all standard Firm opcode as well as new ones.
453 * The behavior of new opcode depends on the operations \c ops and the \c flags.
455 FIRM_API ir_op *new_ir_op(unsigned code, const char *name, op_pin_state p,
456 unsigned flags, op_arity opar, int op_index,
457 size_t attr_size, const ir_op_ops *ops);
459 /** Returns the ir_op_ops of an ir_op. */
460 FIRM_API const ir_op_ops *get_op_ops(const ir_op *op);