3 * File name: ir/ir/irnode.h
4 * Purpose: Representation of an intermediate operation.
5 * Author: Martin Trapp, Christian Schaefer
6 * Modified by: Goetz Lindenmaier
9 * Copyright: (c) 1998-2003 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
19 # include "firm_common.h"
28 * @author Martin Trapp, Christian Schaefer
30 * Declarations of an ir node.
34 * @defgroup ir_node Declarations of an ir node.
36 * The type definition of ir_node is also in irgraph.h to resolve
37 * recursion between irnode.h and irgraph.h
39 * ir_node - a datatype representing a Firm node
41 * The common fields are:
43 * - firm_kind - A firm_kind tag containing k_type. This is useful
44 * for dynamically checking whether a node is a ir_node.
45 * - arity - The number of predecessors in the Firm graph.
46 * - in - A list with the predecessors in the Firm graph. There are
47 * routines to access individual elements and to obtain the
48 * array. The method returning the array should not be used.
49 * - mode - The mode of the node. There are routines to get the mode
50 * but also to access the mode's fields directly.
51 * - opcode - The opcode of the node. There are routines to get the opcode
52 * but also to access the opcode's fields directly.
53 * - node_nr - A unique number for the node. Available only if debugging
58 #ifndef _IR_NODE_TYPEDEF_
59 #define _IR_NODE_TYPEDEF_
60 typedef struct ir_node ir_node;
68 * you can work on the graph without considering the different types
69 * of nodes, it's just a big graph.
73 * Checks whether a pointer points to a ir node.
75 * @param thing an arbitrary pointer
76 * @return non-zero if the thing is a ir mode, else zero
78 int is_ir_node (const void *thing);
81 * Returns the number of predecessors without the block predecessor.
83 * @param node the IR-node
85 int get_irn_arity (const ir_node *node);
86 int get_irn_intra_arity (const ir_node *node);
87 int get_irn_inter_arity (const ir_node *node);
89 /** Replaces the old in array by a new one that will contain the ins given in
90 the parameters. Conserves the block predecessor. It copies the array passed.
91 This function is necessary to adjust in arrays of blocks, calls and phis.
92 Assumes that current_ir_graph is set to the graph containing "node".
93 "in" must contain all predecessors except the block that are required for
95 void set_irn_in (ir_node *node, int arity, ir_node *in[]);
97 /* to iterate through the predecessors without touching the array. No
98 order of predecessors guaranteed.
99 To iterate over the operands iterate from 0 to i < get_irn_arity(),
100 to iterate including the Block predecessor iterate from i = -1 to
101 i < get_irn_arity. */
102 /* Access predecessor n */
105 * Get the n-th predecessor of a node.
106 * This function removes Id predecessors.
108 ir_node *get_irn_n (const ir_node *node, int n);
109 ir_node *get_irn_intra_n (const ir_node *node, int n);
110 ir_node *get_irn_inter_n (const ir_node *node, int n);
112 /** Replace the n-th predecessor of a node with a new one. */
113 void set_irn_n (ir_node *node, int n, ir_node *in);
114 /* Sets the mode struct of node. */
115 void set_irn_mode (ir_node *node, ir_mode *mode);
116 /** Gets the mode struct of a node. */
117 ir_mode *get_irn_mode (const ir_node *node);
118 /** Gets the mode-enum modecode. */
119 modecode get_irn_modecode (const ir_node *node);
120 /** Gets the ident for a string representation of the mode .*/
121 ident *get_irn_modeident (const ir_node *node);
122 /** Gets the string representation of the mode .*/
123 const char *get_irn_modename (const ir_node *node);
124 /** Gets the opcode struct of the node. */
125 ir_op *get_irn_op (const ir_node *node);
126 /** Sets the opcode struct of the node. */
127 void set_irn_op (ir_node *node, ir_op *op);
128 /** Gets the opcode-enum of the node. */
129 opcode get_irn_opcode (const ir_node *node);
130 /** Get the string representation of the opcode. */
131 const char *get_irn_opname (const ir_node *node);
132 /** Get the ident for a string representation of the opcode. */
133 ident *get_irn_opident (const ir_node *node);
134 /** Gets the visited counter of a node. */
135 unsigned long get_irn_visited (const ir_node *node);
136 /** Sets the visited counter of a node. */
137 void set_irn_visited (ir_node *node, unsigned long visited);
138 /** Sets visited to get_irg_visited(current_ir_graph). */
139 void mark_irn_visited (ir_node *node);
140 /** Returns 1 if visited < get_irg_visited(current_ir_graph). */
141 int irn_not_visited (const ir_node *node);
142 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
143 int irn_visited (const ir_node *node);
146 * Sets the link of a node.
147 * Only allowed if the graph is NOT in phase_building.
149 void set_irn_link (ir_node *node, void *link);
151 /** Returns the link of a node. */
152 void *get_irn_link (const ir_node *node);
154 /** Returns the ir_graph this node belongs to. Only valid if irg
155 * is in state op_pin_state_pinned (irg is only stored in the block. */
156 ir_graph *get_irn_irg (const ir_node *node);
158 /** Outputs a unique number for this node if libFIRM is compiled for
159 debugging, (configure with --enable-debug) else returns address
160 of node cast to long. */
161 long get_irn_node_nr (const ir_node *node);
163 /** Returns the pinned state of a node. */
164 op_pin_state get_irn_pinned (const ir_node *node);
166 /** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
167 void set_irn_pinned(ir_node *node, op_pin_state state);
170 * irnode constructor.
171 * Create a new irnode in irg, with an op, mode, arity and
172 * some incoming irnodes.
173 * This constructor is used in every specified irnode constructor.
175 * @param db Debug info.
176 * @param irg IR-graph on with this new node should be constructed.
177 * @param op The opcode of the new node.
178 * @param mode The mode of the new node.
179 * @param arity The arity of the new node, may be <0 if yet.
180 * @param in An array of arity predecessor nodes.
183 new_ir_node (dbg_info *db,
191 /** Return the block the node belongs to.
193 * This works for all except Block. It can return Blocks or the Bad node.
195 * To express the difference to access routines that work for all
196 * nodes we use infix "nodes" and do not name this function
198 ir_node *get_nodes_block (const ir_node *node);
200 /** Sets the Block of a node. */
201 void set_nodes_block (ir_node *node, ir_node *block);
204 * @function get_irn_block()
205 * @see get_nodes_block()
208 * Projection numbers for result of Start node: use for Proj nodes!
211 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
212 pn_Start_M, /**< Projection on the initial memory. */
213 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
214 pn_Start_P_globals, /**< Projection on the pointer to the data segment
215 containing _all_ global entities. */
216 pn_Start_T_args, /**< Projection on all arguments. */
217 pn_Start_P_value_arg_base, /**< Pointer to region of compound value arguments as defined by
218 type of this method. */
219 pn_Start_max /**< number of projections from a Start */
220 } pn_Start; /* Projection numbers for Start. */
223 /** Test whether arbitrary node is frame pointer.
225 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
226 * from Start. If so returns frame type, else Null. */
227 type *is_frame_pointer(ir_node *n);
229 /** Test whether arbitrary node is globals pointer.
231 * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
232 * from Start. If so returns global type, else Null. */
233 type *is_globals_pointer(ir_node *n);
235 /** Test whether arbitrary node is value arg base.
237 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
238 * from Start. If so returns 1, else 0. */
239 int is_value_arg_pointer(ir_node *n);
242 /* @@@ no more supported */
243 ir_node **get_Block_cfgpred_arr (ir_node *node);
244 int get_Block_n_cfgpreds (ir_node *node);
245 ir_node *get_Block_cfgpred (ir_node *node, int pos);
246 void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
247 bool get_Block_matured (ir_node *node);
248 void set_Block_matured (ir_node *node, bool matured);
250 /** A visited flag only for block nodes.
251 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
252 unsigned long get_Block_block_visited (ir_node *node);
253 void set_Block_block_visited (ir_node *node, unsigned long visit);
254 ir_node *set_Block_dead(ir_node *block);
255 int is_Block_dead(const ir_node *block);
257 /* For this current_ir_graph must be set. */
258 void mark_Block_block_visited(ir_node *node);
259 int Block_not_block_visited(ir_node *node);
261 /* Set and remove interprocedural predecessors. If the interprocedural
262 * predecessors are removed, the node has the same predecessors in
264 * @@@ Maybe better: arity is zero if no cg preds. */
265 void set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
266 void set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
267 /* @@@ not supported */
268 ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
269 /** Returns the number of interprocedural predecessors. 0 if none. */
270 int get_Block_cg_n_cfgpreds(ir_node * node);
271 /** Return the interprocedural predecessor at position pos. */
272 ir_node *get_Block_cg_cfgpred(ir_node * node, int pos);
273 /* frees the memory. */
274 void remove_Block_cg_cfgpred_arr(ir_node * node);
276 /** Return the number of Keep alive node. */
277 int get_End_n_keepalives(ir_node *end);
279 /** Return the Keep alive node a position pos. */
280 ir_node *get_End_keepalive(ir_node *end, int pos);
282 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
283 void add_End_keepalive (ir_node *end, ir_node *ka);
285 /** Set the Keep alive node at position pos. */
286 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
288 /** Some parts of the End node are allocated separately -- their memory
289 is not recovered by dead_node_elimination if a End node is dead.
290 free_End() frees these data structures. */
291 void free_End (ir_node *end);
294 /* We distinguish three kinds of Cond nodes. These can be distinguished
295 by the mode of the selector operand and an internal flag of type cond_kind.
296 First we distinguish binary Conds and switch Conds.
297 A binary Cond has as selector a boolean value. Proj(0) projects the control
298 flow for case "False", Proj(1) the control flow for "True". A binary Cond
299 is recognized by the boolean selector.
300 The switch Cond has as selector an unsigned integer. It produces as result
301 an n+1 Tuple (cf0, ... , cfn) of control flows.
302 We differ two flavours of this Cond. The first, the dense Cond, passes
303 control along output i if the selector value is i, 0 <= i <= n. If the
304 selector value is >n it passes control along output n.
305 The second Cond flavor diffirences in the treatment of cases not specified in
306 the source program. It magically knows about the existence of Proj nodes.
307 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
308 exists. Else it passes control along output n (even if this Proj does not
309 exist.) This Cond we call "fragmentary". There is a special constructor
310 new_defaultProj that automatically sets the flavor.
311 The two switch flavors are distinguished by a flag of type cond_kind.
312 Default flavor is "dense"
315 dense, /**< Default. Missing Proj nodes are dead control flow. */
316 fragmentary /**< Special. No control flow optimizations allowed. Missing
317 Proj nodes mean default control flow, i.e., Proj(n). */
320 ir_node *get_Cond_selector (ir_node *node);
321 void set_Cond_selector (ir_node *node, ir_node *selector);
322 cond_kind get_Cond_kind (ir_node *node);
323 void set_Cond_kind (ir_node *node, cond_kind kind);
324 long get_Cond_defaultProj (ir_node *node);
327 * Projection numbers for conditions.
330 pn_Cond_false, /**< Control flow if operand is "false". */
331 pn_Cond_true, /**< Control flow if operand is "true". */
332 pn_Cond_max /**< number of projections from a Cond */
333 } pn_Cond; /* Projection numbers for Cond. */
335 ir_node *get_Return_mem (ir_node *node);
336 void set_Return_mem (ir_node *node, ir_node *mem);
337 ir_node **get_Return_res_arr (ir_node *node);
338 int get_Return_n_ress (ir_node *node);
339 ir_node *get_Return_res (ir_node *node, int pos);
340 void set_Return_res (ir_node *node, int pos, ir_node *res);
342 ir_node *get_Raise_mem (ir_node *node);
343 void set_Raise_mem (ir_node *node, ir_node *mem);
344 ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
345 void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
348 * Projection numbers for Raise.
351 pn_Raise_X, /**< Execution result. */
352 pn_Raise_M, /**< Memory result. */
353 pn_Raise_max /**< number of projections from a Raise */
354 } pn_Raise; /* Projection numbers for Raise. */
357 CNST_NULL = 0, /**< The node is a const(0). */
358 CNST_ONE = +1, /**< The node is a const(1). */
359 CNST_ALL_ONE = -1, /**< The node is a const(11111...). */
360 CNST_OTHER = 2, /**< The tarvel of the const has another value. */
361 CNST_SYMCONST = 3, /**< The node is symconst. */
362 CNST_NO_CONST = 4 /**< The node is no const at all. */
365 tarval *get_Const_tarval (ir_node *node);
366 void set_Const_tarval (ir_node *node, tarval *con);
369 * Classify a node concerning constant properties.
370 * @param irn A node to check for.
371 * @return Constant properties of that node.
373 cnst_classify_t classify_Const(ir_node *irn);
375 /** Returns the source language type of a Const node.
376 * Must be an atomic type. Mode of type must be mode of node.
378 type *get_Const_type (ir_node *node);
380 /** Sets the source language type of a Const node. */
381 void set_Const_type (ir_node *node, type *tp);
383 /** This enum names the three different kinds of symbolic Constants
384 represented by SymConst. The content of the attribute type_or_id
385 depends on this tag. Use the proper access routine after testing
388 symconst_type_tag, /**< The SymConst is a type tag for the given type.
389 Type_or_id_p is type *. */
390 symconst_size, /**< The SymConst is the size of the given type.
391 Type_or_id_p is type *. */
392 symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
393 by the linker. The pointer is represented by a string.
394 Type_or_id_p is ident *. */
395 symconst_addr_ent /**< The SymConst is a symbolic pointer to be filled in
396 by the linker. The pointer is represented by an entity.
397 Type_or_id_p is entity *. */
400 /** SymConst attributes
401 This union contains the symbolic information represented by the node */
402 union symconst_symbol {
408 typedef union symconst_symbol symconst_symbol;
411 /** Get the kind of the SymConst. */
412 symconst_kind get_SymConst_kind (const ir_node *node);
413 /** Set the kind of the SymConst. */
414 void set_SymConst_kind (ir_node *node, symconst_kind num);
416 /** Only to access SymConst of kind type_tag or size. Else assertion: */
417 type *get_SymConst_type (ir_node *node);
418 void set_SymConst_type (ir_node *node, type *tp);
420 /** Only to access SymConst of kind addr_name. Else assertion: */
421 ident *get_SymConst_name (ir_node *node);
422 void set_SymConst_name (ir_node *node, ident *name);
424 /** Only to access SymConst of kind addr_ent. Else assertion: */
425 entity *get_SymConst_entity (ir_node *node);
426 void set_SymConst_entity (ir_node *node, entity *ent);
428 /** Sets both: type and ptrinfo. Needed to treat the node independent of
429 its semantics. Does a memcpy for the memory sym points to. */
430 /* write 'union': firmjni then does not create a method... */
431 union symconst_symbol get_SymConst_symbol (ir_node *node);
432 void set_SymConst_symbol (ir_node *node,
433 union symconst_symbol sym);
435 /** Access the type of the value represented by the SymConst.
437 * Example: primitive type int for SymConst size. */
438 type *get_SymConst_value_type (ir_node *node);
439 void set_SymConst_value_type (ir_node *node, type *tp);
441 ir_node *get_Sel_mem (ir_node *node);
442 void set_Sel_mem (ir_node *node, ir_node *mem);
443 ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
444 void set_Sel_ptr (ir_node *node, ir_node *ptr);
445 ir_node **get_Sel_index_arr (ir_node *node);
446 int get_Sel_n_indexs (ir_node *node);
447 ir_node *get_Sel_index (ir_node *node, int pos);
448 void set_Sel_index (ir_node *node, int pos, ir_node *index);
449 entity *get_Sel_entity (ir_node *node); /* entity to select */
450 void set_Sel_entity (ir_node *node, entity *ent);
453 type *get_InstOf_ent (ir_node *node);
454 void set_InstOf_ent (ir_node *node, type *ent);
455 ir_node *get_InstOf_store (ir_node *node);
456 void set_InstOf_store (ir_node *node, ir_node *obj);
457 ir_node *get_InstOf_obj (ir_node *node);
458 void set_InstOf_obj (ir_node *node, ir_node *obj);
461 * Projection numbers for result of Call node: use for Proj nodes!
464 pn_Call_M_regular = 0, /**< The memory result. */
465 pn_Call_T_result = 2, /**< The tuple containing all (0, 1, 2, ...) results */
466 pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
467 passed by value (for compound result types). */
468 pn_Call_X_except = 1, /**< The control flow result branching to the exception handler */
469 pn_Call_M_except = 3, /**< The memory result in case the called method terminated with
471 pn_Call_max = 5 /**< number of projections from a Call */
472 } pn_Call; /* Projection numbers for Call. */
474 ir_node *get_Call_mem (ir_node *node);
475 void set_Call_mem (ir_node *node, ir_node *mem);
476 ir_node *get_Call_ptr (ir_node *node);
477 void set_Call_ptr (ir_node *node, ir_node *ptr);
478 ir_node **get_Call_param_arr (ir_node *node);
479 /** Gets the number of parameters of a call. */
480 int get_Call_n_params (ir_node *node);
481 /** Gets the call parameter at position pos. */
482 ir_node *get_Call_param (ir_node *node, int pos);
483 /** Sets the call parameter at position pos. */
484 void set_Call_param (ir_node *node, int pos, ir_node *param);
485 /** Gets the type of a call. */
486 type *get_Call_type (ir_node *node);
487 /** Sets the type of a call. */
488 void set_Call_type (ir_node *node, type *tp);
489 /** Gets the arity of a call. Identical to get_Call_n_params(). */
490 int get_Call_arity (ir_node *node);
492 /** Set, get and remove the callee information for a Call node.
494 * The callee information lists all method entities that can be called
495 * from this node. If the address expression can not be analyzed fully,
496 * e.g., as entities can be called that are not in the compilation unit,
497 * the array contains the unknown_entity. The array contains only entities
498 * with peculiarity_existent, but with all kinds of visibility. The entities
499 * not necessarily contain an irg.
501 * The array is only accessible if callee information is valid. See flag
504 * The memory allocated for the array is managed automatically, i.e., it must
505 * not be freed if the Call node is removed from the graph.
507 * @param node A Call node.
509 int Call_has_callees (ir_node *node);
510 int get_Call_n_callees (ir_node *node);
511 entity *get_Call_callee (ir_node *node, int pos);
513 /** Set the full callee array.
515 * The passed array is copied. Assumes current_ir_graph set properly! */
516 void set_Call_callee_arr (ir_node *node, const int n, entity **arr);
517 void remove_Call_callee_arr(ir_node *node);
519 ir_node *get_CallBegin_ptr (ir_node *node);
520 void set_CallBegin_ptr (ir_node *node, ir_node *ptr);
521 ir_node *get_CallBegin_call (ir_node *node);
522 void set_CallBegin_call (ir_node *node, ir_node *call);
524 /* For unary and binary arithmetic operations the access to the
525 operands can be factored out. Left is the first, right the
526 second arithmetic value as listed in tech report 1999-44.
527 unops are: Minus, Abs, Not, Conv, Cast
528 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
529 Shr, Shrs, Rot, Cmp */
530 int is_unop (const ir_node *node);
531 ir_node *get_unop_op (ir_node *node);
532 void set_unop_op (ir_node *node, ir_node *op);
533 int is_binop (const ir_node *node);
534 ir_node *get_binop_left (ir_node *node);
535 void set_binop_left (ir_node *node, ir_node *left);
536 ir_node *get_binop_right (ir_node *node);
537 void set_binop_right (ir_node *node, ir_node *right);
539 ir_node *get_Add_left (ir_node *node);
540 void set_Add_left (ir_node *node, ir_node *left);
541 ir_node *get_Add_right (ir_node *node);
542 void set_Add_right (ir_node *node, ir_node *right);
544 ir_node *get_Sub_left (ir_node *node);
545 void set_Sub_left (ir_node *node, ir_node *left);
546 ir_node *get_Sub_right (ir_node *node);
547 void set_Sub_right (ir_node *node, ir_node *right);
549 ir_node *get_Minus_op (ir_node *node);
550 void set_Minus_op (ir_node *node, ir_node *op);
552 ir_node *get_Mul_left (ir_node *node);
553 void set_Mul_left (ir_node *node, ir_node *left);
554 ir_node *get_Mul_right (ir_node *node);
555 void set_Mul_right (ir_node *node, ir_node *right);
557 ir_node *get_Quot_left (ir_node *node);
558 void set_Quot_left (ir_node *node, ir_node *left);
559 ir_node *get_Quot_right (ir_node *node);
560 void set_Quot_right (ir_node *node, ir_node *right);
561 ir_node *get_Quot_mem (ir_node *node);
562 void set_Quot_mem (ir_node *node, ir_node *mem);
565 * Projection numbers for Quot: use for Proj nodes!
568 pn_Quot_M, /**< Memory result. */
569 pn_Quot_X_except, /**< Execution result if exception occurred. */
570 pn_Quot_res, /**< Result of computation. */
571 pn_Quot_max /**< number of projections from a Quot */
572 } pn_Quot; /* Projection numbers for Quot. */
574 ir_node *get_DivMod_left (ir_node *node);
575 void set_DivMod_left (ir_node *node, ir_node *left);
576 ir_node *get_DivMod_right (ir_node *node);
577 void set_DivMod_right (ir_node *node, ir_node *right);
578 ir_node *get_DivMod_mem (ir_node *node);
579 void set_DivMod_mem (ir_node *node, ir_node *mem);
582 * Projection numbers for DivMod: use for Proj nodes!
585 pn_DivMod_M, /**< Memory result. */
586 pn_DivMod_X_except, /**< Execution result if exception occurred. */
587 pn_DivMod_res_div, /**< Result of computation a / b. */
588 pn_DivMod_res_mod, /**< Result of computation a % b. */
589 pn_DivMod_max /**< number of projections from a DivMod */
590 } pn_DivMod; /* Projection numbers for DivMod. */
592 ir_node *get_Div_left (ir_node *node);
593 void set_Div_left (ir_node *node, ir_node *left);
594 ir_node *get_Div_right (ir_node *node);
595 void set_Div_right (ir_node *node, ir_node *right);
596 ir_node *get_Div_mem (ir_node *node);
597 void set_Div_mem (ir_node *node, ir_node *mem);
600 * Projection numbers for Div: use for Proj nodes!
603 pn_Div_M, /**< Memory result. */
604 pn_Div_X_except, /**< Execution result if exception occurred. */
605 pn_Div_res /**< Result of computation. */
606 } pn_Div; /* Projection numbers for Div. */
608 ir_node *get_Mod_left (ir_node *node);
609 void set_Mod_left (ir_node *node, ir_node *left);
610 ir_node *get_Mod_right (ir_node *node);
611 void set_Mod_right (ir_node *node, ir_node *right);
612 ir_node *get_Mod_mem (ir_node *node);
613 void set_Mod_mem (ir_node *node, ir_node *mem);
616 * Projection numbers for Mod: use for Proj nodes!
619 pn_Mod_M, /**< Memory result. */
620 pn_Mod_X_except, /**< Execution result if exception occurred. */
621 pn_Mod_res, /**< Result of computation. */
622 pn_Mod_max /**< number of projections from a Mod */
623 } pn_Mod; /* Projection numbers for Mod. */
625 ir_node *get_Abs_op (ir_node *node);
626 void set_Abs_op (ir_node *node, ir_node *op);
628 ir_node *get_And_left (ir_node *node);
629 void set_And_left (ir_node *node, ir_node *left);
630 ir_node *get_And_right (ir_node *node);
631 void set_And_right (ir_node *node, ir_node *right);
633 ir_node *get_Or_left (ir_node *node);
634 void set_Or_left (ir_node *node, ir_node *left);
635 ir_node *get_Or_right (ir_node *node);
636 void set_Or_right (ir_node *node, ir_node *right);
638 ir_node *get_Eor_left (ir_node *node);
639 void set_Eor_left (ir_node *node, ir_node *left);
640 ir_node *get_Eor_right (ir_node *node);
641 void set_Eor_right (ir_node *node, ir_node *right);
643 ir_node *get_Not_op (ir_node *node);
644 void set_Not_op (ir_node *node, ir_node *op);
647 * Projection numbers for Cmp are defined several times.
648 * The bit patterns are used for various tests, so don't change.
649 * The "unordered" values are possible results of comparing
650 * floating point numbers.
651 * Note that the encoding is imported, so do NOT change the order.
654 pn_Cmp_False = 0, /**< false */
655 pn_Cmp_Eq = 1, /**< equal */
656 pn_Cmp_Lt = 2, /**< less */
657 pn_Cmp_Le = pn_Cmp_Eq|pn_Cmp_Lt, /**< less or equal */
658 pn_Cmp_Gt = 4, /**< greater */
659 pn_Cmp_Ge = pn_Cmp_Eq|pn_Cmp_Gt, /**< greater or equal */
660 pn_Cmp_Lg = pn_Cmp_Lt|pn_Cmp_Gt, /**< less or greater */
661 pn_Cmp_Leg = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
662 pn_Cmp_Uo = 8, /**< unordered */
663 pn_Cmp_Ue = pn_Cmp_Uo|pn_Cmp_Eq, /**< unordered or equal */
664 pn_Cmp_Ul = pn_Cmp_Uo|pn_Cmp_Lt, /**< unordered or less */
665 pn_Cmp_Ule = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
666 pn_Cmp_Ug = pn_Cmp_Uo|pn_Cmp_Gt, /**< unordered or greater */
667 pn_Cmp_Uge = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
668 pn_Cmp_Ne = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
669 pn_Cmp_True = 15 /**< true */
670 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for jni interface */
671 } pn_Cmp; /* Projection numbers for Cmp */
672 /* #define not_mask pn_Cmp_Leg */
674 /** returns the pnc name from an pnc constant */
675 const char *get_pnc_string(int pnc);
677 /** Calculates the negated pnc condition. */
678 int get_negated_pnc(int pnc);
680 /** Calculates the swapped pnc condition, i.e., "<" --> ">" */
681 int get_swapped_pnc(int pnc);
683 ir_node *get_Cmp_left (ir_node *node);
684 void set_Cmp_left (ir_node *node, ir_node *left);
685 ir_node *get_Cmp_right (ir_node *node);
686 void set_Cmp_right (ir_node *node, ir_node *right);
688 ir_node *get_Shl_left (ir_node *node);
689 void set_Shl_left (ir_node *node, ir_node *left);
690 ir_node *get_Shl_right (ir_node *node);
691 void set_Shl_right (ir_node *node, ir_node *right);
693 ir_node *get_Shr_left (ir_node *node);
694 void set_Shr_left (ir_node *node, ir_node *left);
695 ir_node *get_Shr_right (ir_node *node);
696 void set_Shr_right (ir_node *node, ir_node *right);
698 ir_node *get_Shrs_left (ir_node *node);
699 void set_Shrs_left (ir_node *node, ir_node *left);
700 ir_node *get_Shrs_right (ir_node *node);
701 void set_Shrs_right (ir_node *node, ir_node *right);
703 ir_node *get_Rot_left (ir_node *node);
704 void set_Rot_left (ir_node *node, ir_node *left);
705 ir_node *get_Rot_right (ir_node *node);
706 void set_Rot_right (ir_node *node, ir_node *right);
708 ir_node *get_Conv_op (ir_node *node);
709 void set_Conv_op (ir_node *node, ir_node *op);
711 /* Does Cast need a mem operator?
712 * Cast should only depend on the type, not on the state of an
713 * entity. But: we initialize various fields after Alloc, that
714 * are accessed in the cast. This required some precaution, to
715 * get the right memory into the Loads generated from the cast.
717 ir_node *get_Cast_op (ir_node *node);
718 void set_Cast_op (ir_node *node, ir_node *op);
719 type *get_Cast_type (ir_node *node);
720 void set_Cast_type (ir_node *node, type *to_tp);
722 /** Checks for upcast.
724 * Returns true if the Cast node casts a class type to a super type.
725 * Works also for pointers to classes (recursively).
727 int is_Cast_upcast(ir_node *node);
729 /** Checks for downcast.
731 * Returns true if the Cast node casts a class type to a sub type.
732 * Works also for pointers to classes (recursively).
734 int is_Cast_downcast(ir_node *node);
737 /** Returns true if n is Phi or Filter in interprocedural_view.
738 Returns false if irg in phase building and the Phi has zero
739 predecessors: it's a Phi0. */
740 int is_Phi (const ir_node *n);
741 /** Returns true if irg in phase building and the Phi has zero
742 predecessors: it's a Phi0. */
743 int is_Phi0 (const ir_node *n);
744 /* These routines also work for Filter nodes in interprocedural view. */
745 ir_node **get_Phi_preds_arr (ir_node *node);
746 int get_Phi_n_preds (ir_node *node);
747 ir_node *get_Phi_pred (ir_node *node, int pos);
748 void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
750 ir_node *get_Filter_pred(ir_node *node);
751 void set_Filter_pred(ir_node *node, ir_node *pred);
752 long get_Filter_proj(ir_node *node);
753 void set_Filter_proj(ir_node *node, long proj);
754 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
755 * @@@ Maybe better: arity is zero if no cg preds. */
756 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
757 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
758 int get_Filter_n_cg_preds(ir_node *node);
759 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
761 /** Return true if parameter is a memory operation.
763 * A memory operation is an operation that changes the
764 * memory. I.e., a Load or a Store operation.
766 int is_memop(ir_node *node);
767 ir_node *get_memop_mem (ir_node *node);
768 void set_memop_mem (ir_node *node, ir_node *mem);
769 ir_node *get_memop_ptr (ir_node *node);
770 void set_memop_ptr (ir_node *node, ir_node *ptr);
773 * Projection numbers for Load: use for Proj nodes!
776 pn_Load_M, /**< Memory result. */
777 pn_Load_X_except, /**< Execution result if exception occurred. */
778 pn_Load_res, /**< Result of load operation. */
779 pn_Load_max /**< number of projections from a Load */
780 } pn_Load; /* Projection numbers for Load. */
782 ir_node *get_Load_mem (ir_node *node);
783 void set_Load_mem (ir_node *node, ir_node *mem);
784 ir_node *get_Load_ptr (ir_node *node);
785 void set_Load_ptr (ir_node *node, ir_node *ptr);
786 ir_mode *get_Load_mode (ir_node *node);
787 void set_Load_mode (ir_node *node, ir_mode *mode);
788 ent_volatility get_Load_volatility (ir_node *node);
789 void set_Load_volatility (ir_node *node, ent_volatility volatility);
792 * Projection numbers for Store: use for Proj nodes!
795 pn_Store_M, /**< Memory result. */
796 pn_Store_X_except, /**< Execution result if exception occurred. */
797 pn_Store_max /**< number of projections from a Store */
798 } pn_Store; /* Projection numbers for Store. */
800 ir_node *get_Store_mem (ir_node *node);
801 void set_Store_mem (ir_node *node, ir_node *mem);
802 ir_node *get_Store_ptr (ir_node *node);
803 void set_Store_ptr (ir_node *node, ir_node *ptr);
804 ir_node *get_Store_value (ir_node *node);
805 void set_Store_value (ir_node *node, ir_node *value);
806 ent_volatility get_Store_volatility (ir_node *node);
807 void set_Store_volatility (ir_node *node, ent_volatility volatility);
810 * Projection numbers for Alloc: use for Proj nodes!
813 pn_Alloc_M, /**< Memory result. */
814 pn_Alloc_X_except, /**< Execution result if exception occurred. */
815 pn_Alloc_res, /**< Result of allocation. */
816 pn_Alloc_max /**< number of projections from an Alloc */
817 } pn_Alloc; /* Projection numbers for Alloc. */
819 ir_node *get_Alloc_mem (ir_node *node);
820 void set_Alloc_mem (ir_node *node, ir_node *mem);
821 ir_node *get_Alloc_size (ir_node *node);
822 void set_Alloc_size (ir_node *node, ir_node *size);
823 type *get_Alloc_type (ir_node *node);
824 void set_Alloc_type (ir_node *node, type *tp);
826 /** The allocation place. */
828 stack_alloc, /**< Alloc allocates the object on the stack. */
829 heap_alloc /**< Alloc allocates the object on the heap. */
832 where_alloc get_Alloc_where (ir_node *node);
833 void set_Alloc_where (ir_node *node, where_alloc where);
835 ir_node *get_Free_mem (ir_node *node);
836 void set_Free_mem (ir_node *node, ir_node *mem);
837 ir_node *get_Free_ptr (ir_node *node);
838 void set_Free_ptr (ir_node *node, ir_node *ptr);
839 ir_node *get_Free_size (ir_node *node);
840 void set_Free_size (ir_node *node, ir_node *size);
841 type *get_Free_type (ir_node *node);
842 void set_Free_type (ir_node *node, type *tp);
844 where_alloc get_Free_where (ir_node *node);
845 void set_Free_where (ir_node *node, where_alloc where);
847 ir_node **get_Sync_preds_arr (ir_node *node);
848 int get_Sync_n_preds (ir_node *node);
849 ir_node *get_Sync_pred (ir_node *node, int pos);
850 void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
852 /** Returns the source language type of a Proj node.
853 * Must be an atomic type. Mode of type must be mode of node.
855 type *get_Proj_type (ir_node *node);
857 /** Return the predecessor of a Proj node. */
858 ir_node *get_Proj_pred (ir_node *node);
859 void set_Proj_pred (ir_node *node, ir_node *pred);
860 /** Return the projection number of a Proj node. */
861 long get_Proj_proj (ir_node *node);
862 void set_Proj_proj (ir_node *node, long proj);
864 ir_node **get_Tuple_preds_arr (ir_node *node);
865 int get_Tuple_n_preds (ir_node *node);
866 ir_node *get_Tuple_pred (ir_node *node, int pos);
867 void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
869 ir_node *get_Id_pred (ir_node *node);
870 void set_Id_pred (ir_node *node, ir_node *pred);
872 /** Confirm has a single result and returns 'value' unchanged.
873 * The node expresses a restriction on 'value':
874 * 'value' 'cmp' 'bound' == true. */
875 ir_node *get_Confirm_value (ir_node *node);
876 void set_Confirm_value (ir_node *node, ir_node *value);
877 ir_node *get_Confirm_bound (ir_node *node);
878 void set_Confirm_bound (ir_node *node, ir_node *bound);
879 pn_Cmp get_Confirm_cmp (ir_node *node);
880 void set_Confirm_cmp (ir_node *node, pn_Cmp cmp);
882 ir_node *get_Mux_sel (ir_node *node);
883 void set_Mux_sel (ir_node *node, ir_node *sel);
884 ir_node *get_Mux_false (ir_node *node);
885 void set_Mux_false (ir_node *node, ir_node *ir_false);
886 ir_node *get_Mux_true (ir_node *node);
887 void set_Mux_true (ir_node *node, ir_node *ir_true);
892 * NAME Auxiliary routines
894 * Not properly documented ;-)
898 /** returns operand of node if node is a Proj. */
899 ir_node *skip_Proj (ir_node *node);
900 /** returns operand of node if node is a Id */
901 ir_node *skip_Id (ir_node *node); /* Same as skip_nop. */
902 /* returns corresponding operand of Tuple if node is a Proj from
904 ir_node *skip_Tuple (ir_node *node);
905 /** returns operand of node if node is a Cast */
906 ir_node *skip_Cast (ir_node *node);
907 /** returns true if irn is a Const node. */
908 int is_Const(const ir_node *node);
909 /** returns true if node is a Bad node. */
910 int is_Bad (const ir_node *node);
911 /** returns true if the node is not a Block */
912 int is_no_Block (const ir_node *node);
913 /** returns true if the node is a Block */
914 int is_Block (const ir_node *node);
915 /** returns true if node is a Unknown node. */
916 int is_Unknown (const ir_node *node);
917 /** returns true if node is a Proj node or a Filter node in
918 * intraprocedural view */
919 int is_Proj (const ir_node *node);
920 /** Returns true if the operation manipulates control flow:
921 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
922 int is_cfop(const ir_node *node);
924 /** Returns true if the operation manipulates interprocedural control flow:
925 CallBegin, EndReg, EndExcept */
926 int is_ip_cfop(const ir_node *node);
927 /** Returns true if the operation can change the control flow because
928 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
929 Bad. Raise is not fragile, but a unconditional jump. */
930 int is_fragile_op(const ir_node *node);
931 /** Returns the memory operand of fragile operations. */
932 ir_node *get_fragile_op_mem(ir_node *node);
934 /** Returns true if the operation is a forking control flow
935 * operation: Cond. */
936 int is_forking_op(const ir_node *node);
938 /** Return the type associated with the value produced by n
939 * if the node remarks this type as it is the case for
940 * Cast, Const, SymConst and some Proj nodes. */
941 type *get_irn_type(ir_node *n);
944 * Access custom node data.
945 * The data must have been registered with
946 * register_additional_node_data() before.
947 * @param node The ir node to get the data from.
948 * @param type The type of the data you registered.
949 * @param off The value returned by register_additional_node_data().
950 * @return A pointer of type @p type.
952 #define get_irn_data(node,type,off) \
953 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
956 * Get the pointer to the node some custom data belongs to.
957 * @param data The pointer to the custom data.
958 * @param off The number as returned by register_additional_node_data().
959 * @return A pointer to the ir node the custom data belongs to.
961 #define get_irn_data_base(data,off) \
962 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
965 * Request additional data to be allocated with an ir node.
966 * @param size The size of the additional data required.
967 * @return A positive number, if the operation was successful, which
968 * must be passed to the access macro get_irn_data(), 0 if the
969 * registration failed.
971 unsigned register_additional_node_data(unsigned size);
974 /*-----------------------------------------------------------------*/
976 /*-----------------------------------------------------------------*/
979 /** Debug print the node.
981 * Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
982 * is set. Else does nothing. */
983 void dump_irn(ir_node *n);
988 /* GNU C has the __FUNCTION__ extension */
989 #define __MYFUNC__ __FUNCTION__
991 /* use Filename instead */
992 #define __MYFUNC__ __FILE__
996 Don't format with "\", firmjni gets problems */
997 /** Output location */
998 #define DDM printf("%s(l.%i).\n", __MYFUNC__, __LINE__);
999 /** Output the firm kind of the node */
1000 #define DDMK(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, print_firm_kind(X), (void *)(X));
1001 /** Output information about a node */
1003 /*#define DDMN(X) printf("%s(l.%i) %s%s: %ld (%p)\n", __MYFUNC__, __LINE__, get_irn_opname(X), get_mode_name(get_irn_mode(X)), get_irn_node_nr(X), (void *)(X))*/
1004 int dump_node_opcode(FILE *F, ir_node *n);
1005 #define DDMN(X) do { printf("%s(l.%i) ", __MYFUNC__, __LINE__); dump_node_opcode(stdout, X); printf(": %ld (%p)\n", get_irn_node_nr(X), (void *)(X)); } while (0)
1007 /** Output information about a node and its block */
1008 #define DDMNB(X) printf("%s%s: %ld (in block %ld)\n", get_irn_opname(X), get_mode_name(get_irn_mode(X)), get_irn_node_nr(X), get_irn_node_nr(get_nodes_block(X)))
1009 /** Output information about a type */
1010 #define DDMT(X) printf("%s(l.%i) %s %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_type_tpop_name(X), get_type_name(X), get_type_nr(X), (void *)(X))
1011 /** Output information about an entity */
1012 #define DDME(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
1013 /** Output information about an entity and its type */
1014 #define DDMET(X) printf("%s(l.%i) %s (typ: %s): %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_type_name(get_entity_type(X)), get_entity_nr(X), (void *)(X))
1015 /** Output information about an entity and its owner */
1016 #define DDMEO(X) printf("%s(l.%i) %s (own: %s): %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_type_name(get_entity_owner(X)), get_entity_nr(X), (void *)(X))
1017 /** Output information about a graph */
1018 #define DDMG(X) printf("%s(l.%i) graph %s: %ld (%p) in %s %s.\n", __MYFUNC__, __LINE__, get_entity_name(get_irg_entity(X)), get_irg_graph_nr(X), (void *)(X), get_type_tpop_name(get_entity_owner(get_irg_entity(X))), get_type_name(get_entity_owner(get_irg_entity(X))))
1019 /** Output information about an ident */
1020 #define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_id_str(X), (void *)(X))
1021 /** Output information about a mode */
1022 #define DDMM(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
1023 /** Output information about a loop */
1024 #define DDML(X) printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
1025 /** Output information about a tarVal */
1026 #define DDMV(X) printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
1028 /*@}*/ /* end of ir_node group definition */
1035 # endif /* _IRNODE_H_ */