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"
29 * @author Martin Trapp, Christian Schaefer
31 * Declarations of an ir node.
35 * @defgroup ir_node Declarations of an ir node.
37 * The type definition of ir_node is also in irgraph.h to resolve
38 * recursion between irnode.h and irgraph.h
40 * ir_node - a datatype representing a Firm node
42 * The common fields are:
44 * - firm_kind - A firm_kind tag containing k_type. This is useful
45 * for dynamically checking whether a node is a ir_node.
46 * - arity - The number of predecessors in the Firm graph.
47 * - in - A list with the predecessors in the Firm graph. There are
48 * routines to access individual elements and to obtain the
49 * array. The method returning the array should not be used.
50 * - mode - The mode of the node. There are routines to get the mode
51 * but also to access the mode's fields directly.
52 * - opcode - The opcode of the node. There are routines to get the opcode
53 * but also to access the opcode's fields directly.
54 * - node_nr - A unique number for the node. Available only if debugging
59 #ifndef _IR_NODE_TYPEDEF_
60 #define _IR_NODE_TYPEDEF_
61 typedef struct ir_node ir_node;
69 * you can work on the graph without considering the different types
70 * of nodes, it's just a big graph.
74 * Checks whether a pointer points to a ir node.
76 * @param thing an arbitrary pointer
77 * @return non-zero if the thing is a ir mode, else zero
79 int is_ir_node (const void *thing);
82 * Returns the number of predecessors without the block predecessor.
84 * @param node the IR-node
86 int get_irn_arity (const ir_node *node);
87 int get_irn_intra_arity (const ir_node *node);
88 int get_irn_inter_arity (const ir_node *node);
90 /** Replaces the old in array by a new one that will contain the ins given in
91 the parameters. Conserves the block predecessor. It copies the array passed.
92 This function is necessary to adjust in arrays of blocks, calls and phis.
93 Assumes that current_ir_graph is set to the graph containing "node".
94 "in" must contain all predecessors except the block that are required for
96 void set_irn_in (ir_node *node, int arity, ir_node *in[]);
98 /* to iterate through the predecessors without touching the array. No
99 order of predecessors guaranteed.
100 To iterate over the operands iterate from 0 to i < get_irn_arity(),
101 to iterate including the Block predecessor iterate from i = -1 to
102 i < get_irn_arity. */
103 /* Access predecessor n */
106 * Get the n-th predecessor of a node.
107 * This function removes Id predecessors.
109 ir_node *get_irn_n (const ir_node *node, int n);
110 ir_node *get_irn_intra_n (const ir_node *node, int n);
111 ir_node *get_irn_inter_n (const ir_node *node, int n);
113 /** Replace the n-th predecessor of a node with a new one. */
114 void set_irn_n (ir_node *node, int n, ir_node *in);
115 /* Sets the mode struct of node. */
116 void set_irn_mode (ir_node *node, ir_mode *mode);
117 /** Gets the mode struct of a node. */
118 ir_mode *get_irn_mode (const ir_node *node);
119 /** Gets the mode-enum modecode. */
120 modecode get_irn_modecode (const ir_node *node);
121 /** Gets the ident for a string representation of the mode .*/
122 ident *get_irn_modeident (const ir_node *node);
123 /** Gets the string representation of the mode .*/
124 const char *get_irn_modename (const ir_node *node);
125 /** Gets the opcode struct of the node. */
126 ir_op *get_irn_op (const ir_node *node);
127 /** Sets the opcode struct of the node. */
128 void set_irn_op (ir_node *node, ir_op *op);
129 /** Gets the opcode-enum of the node. */
130 opcode get_irn_opcode (const ir_node *node);
131 /** Get the string representation of the opcode. */
132 const char *get_irn_opname (const ir_node *node);
133 /** Get the ident for a string representation of the opcode. */
134 ident *get_irn_opident (const ir_node *node);
135 /** Gets the visited counter of a node. */
136 unsigned long get_irn_visited (const ir_node *node);
137 /** Sets the visited counter of a node. */
138 void set_irn_visited (ir_node *node, unsigned long visited);
139 /** Sets visited to get_irg_visited(current_ir_graph). */
140 void mark_irn_visited (ir_node *node);
141 /** Returns 1 if visited < get_irg_visited(current_ir_graph). */
142 int irn_not_visited (const ir_node *node);
143 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
144 int irn_visited (const ir_node *node);
147 * Sets the link of a node.
148 * Only allowed if the graph is NOT in phase_building.
150 void set_irn_link (ir_node *node, void *link);
152 /** Returns the link of a node. */
153 void *get_irn_link (const ir_node *node);
155 /** Returns the ir_graph this node belongs to. Only valid if irg
156 * is in state op_pin_state_pinned (irg is only stored in the block. */
157 ir_graph *get_irn_irg (const ir_node *node);
159 /** Outputs a unique number for this node if libFIRM is compiled for
160 debugging, (configure with --enable-debug) else returns address
161 of node cast to long. */
162 long get_irn_node_nr (const ir_node *node);
164 /** Returns the pinned state of a node.
166 * Returns whether the node _always_ must be pinned.
167 * I.e., the node is not floating after global cse.
169 * @returns Either state op_pin_state_pinned or op_pin_state_floats.
171 op_pin_state get_irn_pinned (const ir_node *node);
173 /** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
174 void set_irn_pinned(ir_node *node, op_pin_state state);
176 /** Returns whether the node is currently pinned.
178 * If get_irn_pinned returns op_pin_state_floats and the graph the
179 * node belongs to is in state op_poin_state_floats then this function
180 * returns 'floats', else 'pinned'.
182 op_pin_state is_irn_pinned_in_irg (const ir_node *node);
185 * irnode constructor.
186 * Create a new irnode in irg, with an op, mode, arity and
187 * some incoming irnodes.
188 * This constructor is used in every specified irnode constructor.
190 * @param db Debug info.
191 * @param irg IR-graph on with this new node should be constructed.
192 * @param op The opcode of the new node.
193 * @param mode The mode of the new node.
194 * @param arity The arity of the new node, may be <0 if yet.
195 * @param in An array of arity predecessor nodes.
198 new_ir_node (dbg_info *db,
206 /** Return the block the node belongs to.
208 * This works for all except Block. It can return Blocks or the Bad node.
210 * To express the difference to access routines that work for all
211 * nodes we use infix "nodes" and do not name this function
213 ir_node *get_nodes_block (const ir_node *node);
215 /** Sets the Block of a node. */
216 void set_nodes_block (ir_node *node, ir_node *block);
219 * @function get_irn_block()
220 * @see get_nodes_block()
223 * Projection numbers for result of Start node: use for Proj nodes!
226 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
227 pn_Start_M, /**< Projection on the initial memory. */
228 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
229 pn_Start_P_globals, /**< Projection on the pointer to the data segment
230 containing _all_ global entities. */
231 pn_Start_T_args, /**< Projection on all arguments. */
232 pn_Start_P_value_arg_base, /**< Pointer to region of compound value arguments as defined by
233 type of this method. */
234 pn_Start_max /**< number of projections from a Start */
235 } pn_Start; /* Projection numbers for Start. */
238 /** Test whether arbitrary node is frame pointer.
240 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
241 * from Start. If so returns frame type, else Null. */
242 type *is_frame_pointer(ir_node *n);
244 /** Test whether arbitrary node is globals pointer.
246 * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
247 * from Start. If so returns global type, else Null. */
248 type *is_globals_pointer(ir_node *n);
250 /** Test whether arbitrary node is value arg base.
252 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
253 * from Start. If so returns 1, else 0. */
254 int is_value_arg_pointer(ir_node *n);
257 /* @@@ no more supported */
258 ir_node **get_Block_cfgpred_arr (ir_node *node);
259 int get_Block_n_cfgpreds (ir_node *node);
260 ir_node *get_Block_cfgpred (ir_node *node, int pos);
261 void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
262 bool get_Block_matured (ir_node *node);
263 void set_Block_matured (ir_node *node, bool matured);
265 /** A visited flag only for block nodes.
266 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
267 unsigned long get_Block_block_visited (ir_node *node);
268 void set_Block_block_visited (ir_node *node, unsigned long visit);
271 * Marks a block as dead but do not replace it with a Bad node.
272 * Dead blocks are removed in the con
274 ir_node *set_Block_dead(ir_node *block);
275 int is_Block_dead(const ir_node *block);
277 /* For this current_ir_graph must be set. */
278 void mark_Block_block_visited(ir_node *node);
279 int Block_not_block_visited(ir_node *node);
281 /* Set and remove interprocedural predecessors. If the interprocedural
282 * predecessors are removed, the node has the same predecessors in
284 * @@@ Maybe better: arity is zero if no cg preds. */
285 void set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
286 void set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
287 /* @@@ not supported */
288 ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
289 /** Returns the number of interprocedural predecessors. 0 if none. */
290 int get_Block_cg_n_cfgpreds(ir_node * node);
291 /** Return the interprocedural predecessor at position pos. */
292 ir_node *get_Block_cg_cfgpred(ir_node * node, int pos);
293 /* frees the memory. */
294 void remove_Block_cg_cfgpred_arr(ir_node * node);
296 /** returns the extended basic block a block belongs to */
297 ir_extblk *get_Block_extbb(const ir_node *block);
298 /** sets the extended basic block a block belongs to */
299 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
301 /** Return the number of Keep alive node. */
302 int get_End_n_keepalives(ir_node *end);
304 /** Return the Keep alive node a position pos. */
305 ir_node *get_End_keepalive(ir_node *end, int pos);
307 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
308 void add_End_keepalive (ir_node *end, ir_node *ka);
310 /** Set the Keep alive node at position pos. */
311 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
313 /** Some parts of the End node are allocated separately -- their memory
314 is not recovered by dead_node_elimination if a End node is dead.
315 free_End() frees these data structures. */
316 void free_End (ir_node *end);
319 /* We distinguish three kinds of Cond nodes. These can be distinguished
320 by the mode of the selector operand and an internal flag of type cond_kind.
321 First we distinguish binary Conds and switch Conds.
322 A binary Cond has as selector a boolean value. Proj(0) projects the control
323 flow for case "False", Proj(1) the control flow for "True". A binary Cond
324 is recognized by the boolean selector.
325 The switch Cond has as selector an unsigned integer. It produces as result
326 an n+1 Tuple (cf0, ... , cfn) of control flows.
327 We differ two flavours of this Cond. The first, the dense Cond, passes
328 control along output i if the selector value is i, 0 <= i <= n. If the
329 selector value is >n it passes control along output n.
330 The second Cond flavor diffirences in the treatment of cases not specified in
331 the source program. It magically knows about the existence of Proj nodes.
332 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
333 exists. Else it passes control along output n (even if this Proj does not
334 exist.) This Cond we call "fragmentary". There is a special constructor
335 new_defaultProj that automatically sets the flavor.
336 The two switch flavors are distinguished by a flag of type cond_kind.
337 Default flavor is "dense"
340 dense, /**< Default. Missing Proj nodes are dead control flow. */
341 fragmentary /**< Special. No control flow optimizations allowed. Missing
342 Proj nodes mean default control flow, i.e., Proj(n). */
345 ir_node *get_Cond_selector (ir_node *node);
346 void set_Cond_selector (ir_node *node, ir_node *selector);
347 cond_kind get_Cond_kind (ir_node *node);
348 void set_Cond_kind (ir_node *node, cond_kind kind);
349 long get_Cond_defaultProj (ir_node *node);
352 * Projection numbers for conditions.
355 pn_Cond_false, /**< Control flow if operand is "false". */
356 pn_Cond_true, /**< Control flow if operand is "true". */
357 pn_Cond_max /**< number of projections from a Cond */
358 } pn_Cond; /* Projection numbers for Cond. */
360 ir_node *get_Return_mem (ir_node *node);
361 void set_Return_mem (ir_node *node, ir_node *mem);
362 ir_node **get_Return_res_arr (ir_node *node);
363 int get_Return_n_ress (ir_node *node);
364 ir_node *get_Return_res (ir_node *node, int pos);
365 void set_Return_res (ir_node *node, int pos, ir_node *res);
367 ir_node *get_Raise_mem (ir_node *node);
368 void set_Raise_mem (ir_node *node, ir_node *mem);
369 ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
370 void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
373 * Projection numbers for Raise.
376 pn_Raise_X, /**< Execution result. */
377 pn_Raise_M, /**< Memory result. */
378 pn_Raise_max /**< number of projections from a Raise */
379 } pn_Raise; /* Projection numbers for Raise. */
382 CNST_NULL = 0, /**< The node is a const(0). */
383 CNST_ONE = +1, /**< The node is a const(1). */
384 CNST_ALL_ONE = -1, /**< The node is a const(11111...). */
385 CNST_OTHER = 2, /**< The tarvel of the const has another value. */
386 CNST_SYMCONST = 3, /**< The node is symconst. */
387 CNST_NO_CONST = 4 /**< The node is no const at all. */
390 tarval *get_Const_tarval (ir_node *node);
391 void set_Const_tarval (ir_node *node, tarval *con);
394 * Classify a node concerning constant properties.
395 * @param irn A node to check for.
396 * @return Constant properties of that node.
398 cnst_classify_t classify_Const(ir_node *irn);
400 /** Returns the source language type of a Const node.
401 * Must be an atomic type. Mode of type must be mode of node.
403 type *get_Const_type (ir_node *node);
405 /** Sets the source language type of a Const node. */
406 void set_Const_type (ir_node *node, type *tp);
408 /** This enum names the three different kinds of symbolic Constants
409 represented by SymConst. The content of the attribute type_or_id
410 depends on this tag. Use the proper access routine after testing
413 symconst_type_tag, /**< The SymConst is a type tag for the given type.
414 Type_or_id_p is type *. */
415 symconst_size, /**< The SymConst is the size of the given type.
416 Type_or_id_p is type *. */
417 symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
418 by the linker. The pointer is represented by a string.
419 Type_or_id_p is ident *. */
420 symconst_addr_ent /**< The SymConst is a symbolic pointer to be filled in
421 by the linker. The pointer is represented by an entity.
422 Type_or_id_p is entity *. */
425 /** SymConst attributes
426 This union contains the symbolic information represented by the node */
427 union symconst_symbol {
433 typedef union symconst_symbol symconst_symbol;
436 /** Get the kind of the SymConst. */
437 symconst_kind get_SymConst_kind (const ir_node *node);
438 /** Set the kind of the SymConst. */
439 void set_SymConst_kind (ir_node *node, symconst_kind num);
441 /** Only to access SymConst of kind type_tag or size. Else assertion: */
442 type *get_SymConst_type (ir_node *node);
443 void set_SymConst_type (ir_node *node, type *tp);
445 /** Only to access SymConst of kind addr_name. Else assertion: */
446 ident *get_SymConst_name (ir_node *node);
447 void set_SymConst_name (ir_node *node, ident *name);
449 /** Only to access SymConst of kind addr_ent. Else assertion: */
450 entity *get_SymConst_entity (ir_node *node);
451 void set_SymConst_entity (ir_node *node, entity *ent);
453 /** Sets both: type and ptrinfo. Needed to treat the node independent of
454 its semantics. Does a memcpy for the memory sym points to. */
455 /* write 'union': firmjni then does not create a method... */
456 union symconst_symbol get_SymConst_symbol (ir_node *node);
457 void set_SymConst_symbol (ir_node *node,
458 union symconst_symbol sym);
460 /** Access the type of the value represented by the SymConst.
462 * Example: primitive type int for SymConst size. */
463 type *get_SymConst_value_type (ir_node *node);
464 void set_SymConst_value_type (ir_node *node, type *tp);
466 ir_node *get_Sel_mem (ir_node *node);
467 void set_Sel_mem (ir_node *node, ir_node *mem);
468 ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
469 void set_Sel_ptr (ir_node *node, ir_node *ptr);
470 ir_node **get_Sel_index_arr (ir_node *node);
471 int get_Sel_n_indexs (ir_node *node);
472 ir_node *get_Sel_index (ir_node *node, int pos);
473 void set_Sel_index (ir_node *node, int pos, ir_node *index);
474 entity *get_Sel_entity (ir_node *node); /* entity to select */
475 void set_Sel_entity (ir_node *node, entity *ent);
478 type *get_InstOf_ent (ir_node *node);
479 void set_InstOf_ent (ir_node *node, type *ent);
480 ir_node *get_InstOf_store (ir_node *node);
481 void set_InstOf_store (ir_node *node, ir_node *obj);
482 ir_node *get_InstOf_obj (ir_node *node);
483 void set_InstOf_obj (ir_node *node, ir_node *obj);
486 * Projection numbers for result of Call node: use for Proj nodes!
489 pn_Call_M_regular = 0, /**< The memory result. */
490 pn_Call_T_result = 2, /**< The tuple containing all (0, 1, 2, ...) results */
491 pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
492 passed by value (for compound result types). */
493 pn_Call_X_except = 1, /**< The control flow result branching to the exception handler */
494 pn_Call_M_except = 3, /**< The memory result in case the called method terminated with
496 pn_Call_max = 5 /**< number of projections from a Call */
497 } pn_Call; /* Projection numbers for Call. */
498 #define pn_Call_M pn_Call_M_regular
500 ir_node *get_Call_mem (ir_node *node);
501 void set_Call_mem (ir_node *node, ir_node *mem);
502 ir_node *get_Call_ptr (ir_node *node);
503 void set_Call_ptr (ir_node *node, ir_node *ptr);
504 ir_node **get_Call_param_arr (ir_node *node);
505 /** Gets the number of parameters of a call. */
506 int get_Call_n_params (ir_node *node);
507 /** Gets the call parameter at position pos. */
508 ir_node *get_Call_param (ir_node *node, int pos);
509 /** Sets the call parameter at position pos. */
510 void set_Call_param (ir_node *node, int pos, ir_node *param);
511 /** Gets the type of a call. */
512 type *get_Call_type (ir_node *node);
513 /** Sets the type of a call. */
514 void set_Call_type (ir_node *node, type *tp);
515 /** Gets the arity of a call. Identical to get_Call_n_params(). */
516 int get_Call_arity (ir_node *node);
518 /** Set, get and remove the callee information for a Call node.
520 * The callee information lists all method entities that can be called
521 * from this node. If the address expression can not be analyzed fully,
522 * e.g., as entities can be called that are not in the compilation unit,
523 * the array contains the unknown_entity. The array contains only entities
524 * with peculiarity_existent, but with all kinds of visibility. The entities
525 * not necessarily contain an irg.
527 * The array is only accessible if callee information is valid. See flag
530 * The memory allocated for the array is managed automatically, i.e., it must
531 * not be freed if the Call node is removed from the graph.
533 * @param node A Call node.
535 int Call_has_callees (ir_node *node);
536 int get_Call_n_callees (ir_node *node);
537 entity *get_Call_callee (ir_node *node, int pos);
539 /** Set the full callee array.
541 * The passed array is copied. Assumes current_ir_graph set properly! */
542 void set_Call_callee_arr (ir_node *node, const int n, entity **arr);
543 void remove_Call_callee_arr(ir_node *node);
545 ir_node *get_CallBegin_ptr (ir_node *node);
546 void set_CallBegin_ptr (ir_node *node, ir_node *ptr);
547 ir_node *get_CallBegin_call (ir_node *node);
548 void set_CallBegin_call (ir_node *node, ir_node *call);
550 /* For unary and binary arithmetic operations the access to the
551 operands can be factored out. Left is the first, right the
552 second arithmetic value as listed in tech report 1999-44.
553 unops are: Minus, Abs, Not, Conv, Cast
554 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
555 Shr, Shrs, Rot, Cmp */
556 int is_unop (const ir_node *node);
557 ir_node *get_unop_op (ir_node *node);
558 void set_unop_op (ir_node *node, ir_node *op);
559 int is_binop (const ir_node *node);
560 ir_node *get_binop_left (ir_node *node);
561 void set_binop_left (ir_node *node, ir_node *left);
562 ir_node *get_binop_right (ir_node *node);
563 void set_binop_right (ir_node *node, ir_node *right);
565 ir_node *get_Add_left (ir_node *node);
566 void set_Add_left (ir_node *node, ir_node *left);
567 ir_node *get_Add_right (ir_node *node);
568 void set_Add_right (ir_node *node, ir_node *right);
570 ir_node *get_Sub_left (ir_node *node);
571 void set_Sub_left (ir_node *node, ir_node *left);
572 ir_node *get_Sub_right (ir_node *node);
573 void set_Sub_right (ir_node *node, ir_node *right);
575 ir_node *get_Minus_op (ir_node *node);
576 void set_Minus_op (ir_node *node, ir_node *op);
578 ir_node *get_Mul_left (ir_node *node);
579 void set_Mul_left (ir_node *node, ir_node *left);
580 ir_node *get_Mul_right (ir_node *node);
581 void set_Mul_right (ir_node *node, ir_node *right);
583 ir_node *get_Quot_left (ir_node *node);
584 void set_Quot_left (ir_node *node, ir_node *left);
585 ir_node *get_Quot_right (ir_node *node);
586 void set_Quot_right (ir_node *node, ir_node *right);
587 ir_node *get_Quot_mem (ir_node *node);
588 void set_Quot_mem (ir_node *node, ir_node *mem);
591 * Projection numbers for Quot: use for Proj nodes!
594 pn_Quot_M, /**< Memory result. */
595 pn_Quot_X_except, /**< Execution result if exception occurred. */
596 pn_Quot_res, /**< Result of computation. */
597 pn_Quot_max /**< number of projections from a Quot */
598 } pn_Quot; /* Projection numbers for Quot. */
600 ir_node *get_DivMod_left (ir_node *node);
601 void set_DivMod_left (ir_node *node, ir_node *left);
602 ir_node *get_DivMod_right (ir_node *node);
603 void set_DivMod_right (ir_node *node, ir_node *right);
604 ir_node *get_DivMod_mem (ir_node *node);
605 void set_DivMod_mem (ir_node *node, ir_node *mem);
608 * Projection numbers for DivMod: use for Proj nodes!
611 pn_DivMod_M, /**< Memory result. */
612 pn_DivMod_X_except, /**< Execution result if exception occurred. */
613 pn_DivMod_res_div, /**< Result of computation a / b. */
614 pn_DivMod_res_mod, /**< Result of computation a % b. */
615 pn_DivMod_max /**< number of projections from a DivMod */
616 } pn_DivMod; /* Projection numbers for DivMod. */
618 ir_node *get_Div_left (ir_node *node);
619 void set_Div_left (ir_node *node, ir_node *left);
620 ir_node *get_Div_right (ir_node *node);
621 void set_Div_right (ir_node *node, ir_node *right);
622 ir_node *get_Div_mem (ir_node *node);
623 void set_Div_mem (ir_node *node, ir_node *mem);
626 * Projection numbers for Div: use for Proj nodes!
629 pn_Div_M, /**< Memory result. */
630 pn_Div_X_except, /**< Execution result if exception occurred. */
631 pn_Div_res /**< Result of computation. */
632 } pn_Div; /* Projection numbers for Div. */
634 ir_node *get_Mod_left (ir_node *node);
635 void set_Mod_left (ir_node *node, ir_node *left);
636 ir_node *get_Mod_right (ir_node *node);
637 void set_Mod_right (ir_node *node, ir_node *right);
638 ir_node *get_Mod_mem (ir_node *node);
639 void set_Mod_mem (ir_node *node, ir_node *mem);
642 * Projection numbers for Mod: use for Proj nodes!
645 pn_Mod_M, /**< Memory result. */
646 pn_Mod_X_except, /**< Execution result if exception occurred. */
647 pn_Mod_res, /**< Result of computation. */
648 pn_Mod_max /**< number of projections from a Mod */
649 } pn_Mod; /* Projection numbers for Mod. */
651 ir_node *get_Abs_op (ir_node *node);
652 void set_Abs_op (ir_node *node, ir_node *op);
654 ir_node *get_And_left (ir_node *node);
655 void set_And_left (ir_node *node, ir_node *left);
656 ir_node *get_And_right (ir_node *node);
657 void set_And_right (ir_node *node, ir_node *right);
659 ir_node *get_Or_left (ir_node *node);
660 void set_Or_left (ir_node *node, ir_node *left);
661 ir_node *get_Or_right (ir_node *node);
662 void set_Or_right (ir_node *node, ir_node *right);
664 ir_node *get_Eor_left (ir_node *node);
665 void set_Eor_left (ir_node *node, ir_node *left);
666 ir_node *get_Eor_right (ir_node *node);
667 void set_Eor_right (ir_node *node, ir_node *right);
669 ir_node *get_Not_op (ir_node *node);
670 void set_Not_op (ir_node *node, ir_node *op);
673 * Projection numbers for Cmp are defined several times.
674 * The bit patterns are used for various tests, so don't change.
675 * The "unordered" values are possible results of comparing
676 * floating point numbers.
677 * Note that the encoding is imported, so do NOT change the order.
680 pn_Cmp_False = 0, /**< false */
681 pn_Cmp_Eq = 1, /**< equal */
682 pn_Cmp_Lt = 2, /**< less */
683 pn_Cmp_Le = pn_Cmp_Eq|pn_Cmp_Lt, /**< less or equal */
684 pn_Cmp_Gt = 4, /**< greater */
685 pn_Cmp_Ge = pn_Cmp_Eq|pn_Cmp_Gt, /**< greater or equal */
686 pn_Cmp_Lg = pn_Cmp_Lt|pn_Cmp_Gt, /**< less or greater */
687 pn_Cmp_Leg = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
688 pn_Cmp_Uo = 8, /**< unordered */
689 pn_Cmp_Ue = pn_Cmp_Uo|pn_Cmp_Eq, /**< unordered or equal */
690 pn_Cmp_Ul = pn_Cmp_Uo|pn_Cmp_Lt, /**< unordered or less */
691 pn_Cmp_Ule = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
692 pn_Cmp_Ug = pn_Cmp_Uo|pn_Cmp_Gt, /**< unordered or greater */
693 pn_Cmp_Uge = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
694 pn_Cmp_Ne = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
695 pn_Cmp_True = 15 /**< true */
696 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for jni interface */
697 } pn_Cmp; /* Projection numbers for Cmp */
698 /* #define not_mask pn_Cmp_Leg */
700 /** returns the pnc name from an pnc constant */
701 const char *get_pnc_string(int pnc);
703 /** Calculates the negated (Complement(R)) pnc condition. */
704 int get_negated_pnc(int pnc, ir_mode *mode);
706 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
707 int get_inversed_pnc(int pnc);
709 ir_node *get_Cmp_left (ir_node *node);
710 void set_Cmp_left (ir_node *node, ir_node *left);
711 ir_node *get_Cmp_right (ir_node *node);
712 void set_Cmp_right (ir_node *node, ir_node *right);
714 ir_node *get_Shl_left (ir_node *node);
715 void set_Shl_left (ir_node *node, ir_node *left);
716 ir_node *get_Shl_right (ir_node *node);
717 void set_Shl_right (ir_node *node, ir_node *right);
719 ir_node *get_Shr_left (ir_node *node);
720 void set_Shr_left (ir_node *node, ir_node *left);
721 ir_node *get_Shr_right (ir_node *node);
722 void set_Shr_right (ir_node *node, ir_node *right);
724 ir_node *get_Shrs_left (ir_node *node);
725 void set_Shrs_left (ir_node *node, ir_node *left);
726 ir_node *get_Shrs_right (ir_node *node);
727 void set_Shrs_right (ir_node *node, ir_node *right);
729 ir_node *get_Rot_left (ir_node *node);
730 void set_Rot_left (ir_node *node, ir_node *left);
731 ir_node *get_Rot_right (ir_node *node);
732 void set_Rot_right (ir_node *node, ir_node *right);
734 ir_node *get_Conv_op (ir_node *node);
735 void set_Conv_op (ir_node *node, ir_node *op);
737 /* Does Cast need a mem operator?
738 * Cast should only depend on the type, not on the state of an
739 * entity. But: we initialize various fields after Alloc, that
740 * are accessed in the cast. This required some precaution, to
741 * get the right memory into the Loads generated from the cast.
743 ir_node *get_Cast_op (ir_node *node);
744 void set_Cast_op (ir_node *node, ir_node *op);
745 type *get_Cast_type (ir_node *node);
746 void set_Cast_type (ir_node *node, type *to_tp);
748 /** Checks for upcast.
750 * Returns true if the Cast node casts a class type to a super type.
751 * Works also for pointers to classes (recursively).
753 int is_Cast_upcast(ir_node *node);
755 /** Checks for downcast.
757 * Returns true if the Cast node casts a class type to a sub type.
758 * Works also for pointers to classes (recursively).
760 int is_Cast_downcast(ir_node *node);
763 /** Returns true if n is Phi or Filter in interprocedural_view.
764 Returns false if irg in phase building and the Phi has zero
765 predecessors: it's a Phi0. */
766 int is_Phi (const ir_node *n);
767 /** Returns true if irg in phase building and the Phi has zero
768 predecessors: it's a Phi0. */
769 int is_Phi0 (const ir_node *n);
770 /* These routines also work for Filter nodes in interprocedural view. */
771 ir_node **get_Phi_preds_arr (ir_node *node);
772 int get_Phi_n_preds (ir_node *node);
773 ir_node *get_Phi_pred (ir_node *node, int pos);
774 void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
776 ir_node *get_Filter_pred(ir_node *node);
777 void set_Filter_pred(ir_node *node, ir_node *pred);
778 long get_Filter_proj(ir_node *node);
779 void set_Filter_proj(ir_node *node, long proj);
780 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
781 * @@@ Maybe better: arity is zero if no cg preds. */
782 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
783 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
784 int get_Filter_n_cg_preds(ir_node *node);
785 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
787 /** Return true if parameter is a memory operation.
789 * A memory operation is an operation that changes the
790 * memory. I.e., a Load or a Store operation.
792 int is_memop(ir_node *node);
793 ir_node *get_memop_mem (ir_node *node);
794 void set_memop_mem (ir_node *node, ir_node *mem);
795 ir_node *get_memop_ptr (ir_node *node);
796 void set_memop_ptr (ir_node *node, ir_node *ptr);
799 * Projection numbers for Load: use for Proj nodes!
802 pn_Load_M, /**< Memory result. */
803 pn_Load_X_except, /**< Execution result if exception occurred. */
804 pn_Load_res, /**< Result of load operation. */
805 pn_Load_max /**< number of projections from a Load */
806 } pn_Load; /* Projection numbers for Load. */
808 ir_node *get_Load_mem (ir_node *node);
809 void set_Load_mem (ir_node *node, ir_node *mem);
810 ir_node *get_Load_ptr (ir_node *node);
811 void set_Load_ptr (ir_node *node, ir_node *ptr);
812 ir_mode *get_Load_mode (ir_node *node);
813 void set_Load_mode (ir_node *node, ir_mode *mode);
814 ent_volatility get_Load_volatility (ir_node *node);
815 void set_Load_volatility (ir_node *node, ent_volatility volatility);
818 * Projection numbers for Store: use for Proj nodes!
821 pn_Store_M, /**< Memory result. */
822 pn_Store_X_except, /**< Execution result if exception occurred. */
823 pn_Store_max /**< number of projections from a Store */
824 } pn_Store; /* Projection numbers for Store. */
826 ir_node *get_Store_mem (ir_node *node);
827 void set_Store_mem (ir_node *node, ir_node *mem);
828 ir_node *get_Store_ptr (ir_node *node);
829 void set_Store_ptr (ir_node *node, ir_node *ptr);
830 ir_node *get_Store_value (ir_node *node);
831 void set_Store_value (ir_node *node, ir_node *value);
832 ent_volatility get_Store_volatility (ir_node *node);
833 void set_Store_volatility (ir_node *node, ent_volatility volatility);
836 * Projection numbers for Alloc: use for Proj nodes!
839 pn_Alloc_M, /**< Memory result. */
840 pn_Alloc_X_except, /**< Execution result if exception occurred. */
841 pn_Alloc_res, /**< Result of allocation. */
842 pn_Alloc_max /**< number of projections from an Alloc */
843 } pn_Alloc; /* Projection numbers for Alloc. */
845 ir_node *get_Alloc_mem (ir_node *node);
846 void set_Alloc_mem (ir_node *node, ir_node *mem);
847 ir_node *get_Alloc_size (ir_node *node);
848 void set_Alloc_size (ir_node *node, ir_node *size);
849 type *get_Alloc_type (ir_node *node);
850 void set_Alloc_type (ir_node *node, type *tp);
852 /** The allocation place. */
854 stack_alloc, /**< Alloc allocates the object on the stack. */
855 heap_alloc /**< Alloc allocates the object on the heap. */
858 where_alloc get_Alloc_where (ir_node *node);
859 void set_Alloc_where (ir_node *node, where_alloc where);
861 ir_node *get_Free_mem (ir_node *node);
862 void set_Free_mem (ir_node *node, ir_node *mem);
863 ir_node *get_Free_ptr (ir_node *node);
864 void set_Free_ptr (ir_node *node, ir_node *ptr);
865 ir_node *get_Free_size (ir_node *node);
866 void set_Free_size (ir_node *node, ir_node *size);
867 type *get_Free_type (ir_node *node);
868 void set_Free_type (ir_node *node, type *tp);
870 where_alloc get_Free_where (ir_node *node);
871 void set_Free_where (ir_node *node, where_alloc where);
873 ir_node **get_Sync_preds_arr (ir_node *node);
874 int get_Sync_n_preds (ir_node *node);
875 ir_node *get_Sync_pred (ir_node *node, int pos);
876 void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
878 /** Returns the source language type of a Proj node.
879 * Must be an atomic type. Mode of type must be mode of node.
881 type *get_Proj_type (ir_node *node);
883 /** Return the predecessor of a Proj node. */
884 ir_node *get_Proj_pred (const ir_node *node);
885 void set_Proj_pred (ir_node *node, ir_node *pred);
886 /** Return the projection number of a Proj node. */
887 long get_Proj_proj (const ir_node *node);
888 void set_Proj_proj (ir_node *node, long proj);
890 ir_node **get_Tuple_preds_arr (ir_node *node);
891 int get_Tuple_n_preds (ir_node *node);
892 ir_node *get_Tuple_pred (ir_node *node, int pos);
893 void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
895 ir_node *get_Id_pred (ir_node *node);
896 void set_Id_pred (ir_node *node, ir_node *pred);
898 /** Confirm has a single result and returns 'value' unchanged.
899 * The node expresses a restriction on 'value':
900 * 'value' 'cmp' 'bound' == true. */
901 ir_node *get_Confirm_value (ir_node *node);
902 void set_Confirm_value (ir_node *node, ir_node *value);
903 ir_node *get_Confirm_bound (ir_node *node);
904 void set_Confirm_bound (ir_node *node, ir_node *bound);
905 pn_Cmp get_Confirm_cmp (ir_node *node);
906 void set_Confirm_cmp (ir_node *node, pn_Cmp cmp);
908 ir_node *get_Mux_sel (ir_node *node);
909 void set_Mux_sel (ir_node *node, ir_node *sel);
910 ir_node *get_Mux_false (ir_node *node);
911 void set_Mux_false (ir_node *node, ir_node *ir_false);
912 ir_node *get_Mux_true (ir_node *node);
913 void set_Mux_true (ir_node *node, ir_node *ir_true);
918 * NAME Auxiliary routines
920 * Not properly documented ;-)
924 /** returns operand of node if node is a Proj. */
925 ir_node *skip_Proj (ir_node *node);
926 /** returns operand of node if node is a Id */
927 ir_node *skip_Id (ir_node *node); /* Same as skip_nop. */
928 /* returns corresponding operand of Tuple if node is a Proj from
930 ir_node *skip_Tuple (ir_node *node);
931 /** returns operand of node if node is a Cast */
932 ir_node *skip_Cast (ir_node *node);
933 /** returns operand of node if node is a Confirm */
934 ir_node *skip_Confirm (ir_node *node);
935 /** Skip all high-level Operations. */
936 ir_node *skip_HighLevel(ir_node *node);
937 /** returns true if irn is a Const node. */
938 int is_Const(const ir_node *node);
939 /** returns true if node is a Bad node. */
940 int is_Bad (const ir_node *node);
941 /** returns true if the node is not a Block */
942 int is_no_Block (const ir_node *node);
943 /** returns true if the node is a Block */
944 int is_Block (const ir_node *node);
945 /** returns true if node is a Unknown node. */
946 int is_Unknown (const ir_node *node);
947 /** returns true if node is a Proj node or a Filter node in
948 * intraprocedural view */
949 int is_Proj (const ir_node *node);
950 /** Returns true if the operation manipulates control flow:
951 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
952 int is_cfop(const ir_node *node);
954 /** Returns true if the operation manipulates interprocedural control flow:
955 CallBegin, EndReg, EndExcept */
956 int is_ip_cfop(const ir_node *node);
957 /** Returns true if the operation can change the control flow because
958 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
959 Bad. Raise is not fragile, but a unconditional jump. */
960 int is_fragile_op(const ir_node *node);
961 /** Returns the memory operand of fragile operations. */
962 ir_node *get_fragile_op_mem(ir_node *node);
964 /** Returns true if the operation is a forking control flow
965 * operation: Cond. */
966 int is_forking_op(const ir_node *node);
968 /** Return the type associated with the value produced by n
969 * if the node remarks this type as it is the case for
970 * Cast, Const, SymConst and some Proj nodes. */
971 type *get_irn_type(ir_node *n);
974 * Access custom node data.
975 * The data must have been registered with
976 * register_additional_node_data() before.
977 * @param node The ir node to get the data from.
978 * @param type The type of the data you registered.
979 * @param off The value returned by register_additional_node_data().
980 * @return A pointer of type @p type.
982 #define get_irn_data(node,type,off) \
983 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
986 * Get the pointer to the node some custom data belongs to.
987 * @param data The pointer to the custom data.
988 * @param off The number as returned by register_additional_node_data().
989 * @return A pointer to the ir node the custom data belongs to.
991 #define get_irn_data_base(data,off) \
992 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
995 * Request additional data to be allocated with an ir node.
996 * @param size The size of the additional data required.
997 * @return A positive number, if the operation was successful, which
998 * must be passed to the access macro get_irn_data(), 0 if the
999 * registration failed.
1001 unsigned register_additional_node_data(unsigned size);
1004 /*-----------------------------------------------------------------*/
1006 /*-----------------------------------------------------------------*/
1009 /** Debug print the node.
1011 * Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
1012 * is set. Else does nothing. */
1013 void dump_irn(ir_node *n);
1018 /* GNU C has the __FUNCTION__ extension */
1019 #define __MYFUNC__ __FUNCTION__
1021 /* use Filename instead */
1022 #define __MYFUNC__ __FILE__
1026 Don't format with "\", firmjni gets problems */
1027 /** Output location */
1028 #define DDM printf("%s(l.%i).\n", __MYFUNC__, __LINE__);
1029 /** Output the firm kind of the node */
1030 #define DDMK(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, print_firm_kind(X), (void *)(X));
1031 /** Output information about a node */
1033 /*#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))*/
1034 int dump_node_opcode(FILE *F, ir_node *n);
1035 #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)
1037 /** Output information about a node and its block */
1038 #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)))
1039 /** Output information about a type */
1040 #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))
1041 /** Output information about an entity */
1042 #define DDME(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
1043 /** Output information about an entity and its type */
1044 #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))
1045 /** Output information about an entity and its owner */
1046 #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))
1047 /** Output information about a graph */
1048 #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))))
1049 /** Output information about an ident */
1050 #define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_id_str(X), (void *)(X))
1051 /** Output information about a mode */
1052 #define DDMM(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
1053 /** Output information about a loop */
1054 #define DDML(X) printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
1055 /** Output information about a tarVal */
1056 #define DDMV(X) printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
1058 /*@}*/ /* end of ir_node group definition */
1065 # endif /* _IRNODE_H_ */