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 /** Get the predecessor block.
264 * Returns the block corresonding to the predecessor pos of block.
266 * There are several ambiguities we resolve with this function:
267 * - The direct predecessor can be a Proj, which is not pinned.
268 * We walk from the predecessor to the next pinned node
269 * (skip_Proj) and return the block that node is in.
270 * - If we encounter the Bad node, this function does not return
271 * Start, but the Bad node.
273 ir_node *get_Block_cfgpred_block(ir_node *node, int pos);
274 bool get_Block_matured (ir_node *node);
275 void set_Block_matured (ir_node *node, bool matured);
277 /** A visited flag only for block nodes.
278 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
279 unsigned long get_Block_block_visited (ir_node *node);
280 void set_Block_block_visited (ir_node *node, unsigned long visit);
283 * Marks a block as dead but do not replace it with a Bad node.
284 * Dead blocks are removed in the con
286 ir_node *set_Block_dead(ir_node *block);
287 int is_Block_dead(const ir_node *block);
289 /* For this current_ir_graph must be set. */
290 void mark_Block_block_visited(ir_node *node);
291 int Block_not_block_visited(ir_node *node);
293 /* Set and remove interprocedural predecessors. If the interprocedural
294 * predecessors are removed, the node has the same predecessors in
296 * @@@ Maybe better: arity is zero if no cg preds. */
297 void set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
298 void set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
299 /* @@@ not supported */
300 ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
301 /** Returns the number of interprocedural predecessors. 0 if none. */
302 int get_Block_cg_n_cfgpreds(ir_node * node);
303 /** Return the interprocedural predecessor at position pos. */
304 ir_node *get_Block_cg_cfgpred(ir_node * node, int pos);
305 /* frees the memory. */
306 void remove_Block_cg_cfgpred_arr(ir_node * node);
308 /** returns the extended basic block a block belongs to */
309 ir_extblk *get_Block_extbb(const ir_node *block);
310 /** sets the extended basic block a block belongs to */
311 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
313 /** Return the number of Keep alive node. */
314 int get_End_n_keepalives(ir_node *end);
316 /** Return the Keep alive node a position pos. */
317 ir_node *get_End_keepalive(ir_node *end, int pos);
319 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
320 void add_End_keepalive (ir_node *end, ir_node *ka);
322 /** Set the Keep alive node at position pos. */
323 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
325 /** Some parts of the End node are allocated separately -- their memory
326 is not recovered by dead_node_elimination if a End node is dead.
327 free_End() frees these data structures. */
328 void free_End (ir_node *end);
331 /* We distinguish three kinds of Cond nodes. These can be distinguished
332 by the mode of the selector operand and an internal flag of type cond_kind.
333 First we distinguish binary Conds and switch Conds.
334 A binary Cond has as selector a boolean value. Proj(0) projects the control
335 flow for case "False", Proj(1) the control flow for "True". A binary Cond
336 is recognized by the boolean selector.
337 The switch Cond has as selector an unsigned integer. It produces as result
338 an n+1 Tuple (cf0, ... , cfn) of control flows.
339 We differ two flavours of this Cond. The first, the dense Cond, passes
340 control along output i if the selector value is i, 0 <= i <= n. If the
341 selector value is >n it passes control along output n.
342 The second Cond flavor diffirences in the treatment of cases not specified in
343 the source program. It magically knows about the existence of Proj nodes.
344 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
345 exists. Else it passes control along output n (even if this Proj does not
346 exist.) This Cond we call "fragmentary". There is a special constructor
347 new_defaultProj that automatically sets the flavor.
348 The two switch flavors are distinguished by a flag of type cond_kind.
349 Default flavor is "dense"
352 dense, /**< Default. Missing Proj nodes are dead control flow. */
353 fragmentary /**< Special. No control flow optimizations allowed. Missing
354 Proj nodes mean default control flow, i.e., Proj(n). */
357 ir_node *get_Cond_selector (ir_node *node);
358 void set_Cond_selector (ir_node *node, ir_node *selector);
359 cond_kind get_Cond_kind (ir_node *node);
360 void set_Cond_kind (ir_node *node, cond_kind kind);
361 long get_Cond_defaultProj (ir_node *node);
364 * Projection numbers for conditions.
367 pn_Cond_false, /**< Control flow if operand is "false". */
368 pn_Cond_true, /**< Control flow if operand is "true". */
369 pn_Cond_max /**< number of projections from a Cond */
370 } pn_Cond; /* Projection numbers for Cond. */
372 ir_node *get_Return_mem (ir_node *node);
373 void set_Return_mem (ir_node *node, ir_node *mem);
374 ir_node **get_Return_res_arr (ir_node *node);
375 int get_Return_n_ress (ir_node *node);
376 ir_node *get_Return_res (ir_node *node, int pos);
377 void set_Return_res (ir_node *node, int pos, ir_node *res);
379 ir_node *get_Raise_mem (ir_node *node);
380 void set_Raise_mem (ir_node *node, ir_node *mem);
381 ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
382 void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
385 * Projection numbers for Raise.
388 pn_Raise_X, /**< Execution result. */
389 pn_Raise_M, /**< Memory result. */
390 pn_Raise_max /**< number of projections from a Raise */
391 } pn_Raise; /* Projection numbers for Raise. */
394 CNST_NULL = 0, /**< The node is a const(0). */
395 CNST_ONE = +1, /**< The node is a const(1). */
396 CNST_ALL_ONE = -1, /**< The node is a const(11111...). */
397 CNST_OTHER = 2, /**< The tarvel of the const has another value. */
398 CNST_SYMCONST = 3, /**< The node is symconst. */
399 CNST_NO_CONST = 4 /**< The node is no const at all. */
402 tarval *get_Const_tarval (ir_node *node);
403 void set_Const_tarval (ir_node *node, tarval *con);
406 * Classify a node concerning constant properties.
407 * @param irn A node to check for.
408 * @return Constant properties of that node.
410 cnst_classify_t classify_Const(ir_node *irn);
412 /** Returns the source language type of a Const node.
413 * Must be an atomic type. Mode of type must be mode of node.
415 type *get_Const_type (ir_node *node);
417 /** Sets the source language type of a Const node. */
418 void set_Const_type (ir_node *node, type *tp);
420 /** This enum names the three different kinds of symbolic Constants
421 represented by SymConst. The content of the attribute type_or_id
422 depends on this tag. Use the proper access routine after testing
425 symconst_type_tag, /**< The SymConst is a type tag for the given type.
426 Type_or_id_p is type *. */
427 symconst_size, /**< The SymConst is the size of the given type.
428 Type_or_id_p is type *. */
429 symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
430 by the linker. The pointer is represented by a string.
431 Type_or_id_p is ident *. */
432 symconst_addr_ent /**< The SymConst is a symbolic pointer to be filled in
433 by the linker. The pointer is represented by an entity.
434 Type_or_id_p is entity *. */
437 /** SymConst attributes
438 This union contains the symbolic information represented by the node */
439 union symconst_symbol {
445 typedef union symconst_symbol symconst_symbol;
448 /** Get the kind of the SymConst. */
449 symconst_kind get_SymConst_kind (const ir_node *node);
450 /** Set the kind of the SymConst. */
451 void set_SymConst_kind (ir_node *node, symconst_kind num);
453 /** Only to access SymConst of kind type_tag or size. Else assertion: */
454 type *get_SymConst_type (ir_node *node);
455 void set_SymConst_type (ir_node *node, type *tp);
457 /** Only to access SymConst of kind addr_name. Else assertion: */
458 ident *get_SymConst_name (ir_node *node);
459 void set_SymConst_name (ir_node *node, ident *name);
461 /** Only to access SymConst of kind addr_ent. Else assertion: */
462 entity *get_SymConst_entity (ir_node *node);
463 void set_SymConst_entity (ir_node *node, entity *ent);
465 /** Sets both: type and ptrinfo. Needed to treat the node independent of
466 its semantics. Does a memcpy for the memory sym points to. */
467 /* write 'union': firmjni then does not create a method... */
468 union symconst_symbol get_SymConst_symbol (ir_node *node);
469 void set_SymConst_symbol (ir_node *node,
470 union symconst_symbol sym);
472 /** Access the type of the value represented by the SymConst.
474 * Example: primitive type int for SymConst size. */
475 type *get_SymConst_value_type (ir_node *node);
476 void set_SymConst_value_type (ir_node *node, type *tp);
478 ir_node *get_Sel_mem (ir_node *node);
479 void set_Sel_mem (ir_node *node, ir_node *mem);
480 ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
481 void set_Sel_ptr (ir_node *node, ir_node *ptr);
482 ir_node **get_Sel_index_arr (ir_node *node);
483 int get_Sel_n_indexs (ir_node *node);
484 ir_node *get_Sel_index (ir_node *node, int pos);
485 void set_Sel_index (ir_node *node, int pos, ir_node *index);
486 entity *get_Sel_entity (ir_node *node); /* entity to select */
487 void set_Sel_entity (ir_node *node, entity *ent);
490 type *get_InstOf_ent (ir_node *node);
491 void set_InstOf_ent (ir_node *node, type *ent);
492 ir_node *get_InstOf_store (ir_node *node);
493 void set_InstOf_store (ir_node *node, ir_node *obj);
494 ir_node *get_InstOf_obj (ir_node *node);
495 void set_InstOf_obj (ir_node *node, ir_node *obj);
498 * Projection numbers for result of Call node: use for Proj nodes!
501 pn_Call_M_regular = 0, /**< The memory result. */
502 pn_Call_T_result = 2, /**< The tuple containing all (0, 1, 2, ...) results */
503 pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
504 passed by value (for compound result types). */
505 pn_Call_X_except = 1, /**< The control flow result branching to the exception handler */
506 pn_Call_M_except = 3, /**< The memory result in case the called method terminated with
508 pn_Call_max = 5 /**< number of projections from a Call */
509 } pn_Call; /* Projection numbers for Call. */
510 #define pn_Call_M pn_Call_M_regular
512 ir_node *get_Call_mem (ir_node *node);
513 void set_Call_mem (ir_node *node, ir_node *mem);
514 ir_node *get_Call_ptr (ir_node *node);
515 void set_Call_ptr (ir_node *node, ir_node *ptr);
516 ir_node **get_Call_param_arr (ir_node *node);
517 /** Gets the number of parameters of a call. */
518 int get_Call_n_params (ir_node *node);
519 /** Gets the call parameter at position pos. */
520 ir_node *get_Call_param (ir_node *node, int pos);
521 /** Sets the call parameter at position pos. */
522 void set_Call_param (ir_node *node, int pos, ir_node *param);
523 /** Gets the type of a call. */
524 type *get_Call_type (ir_node *node);
525 /** Sets the type of a call. */
526 void set_Call_type (ir_node *node, type *tp);
527 /** Gets the arity of a call. Identical to get_Call_n_params(). */
528 int get_Call_arity (ir_node *node);
530 /** Set, get and remove the callee information for a Call node.
532 * The callee information lists all method entities that can be called
533 * from this node. If the address expression can not be analyzed fully,
534 * e.g., as entities can be called that are not in the compilation unit,
535 * the array contains the unknown_entity. The array contains only entities
536 * with peculiarity_existent, but with all kinds of visibility. The entities
537 * not necessarily contain an irg.
539 * The array is only accessible if callee information is valid. See flag
542 * The memory allocated for the array is managed automatically, i.e., it must
543 * not be freed if the Call node is removed from the graph.
545 * @param node A Call node.
547 int Call_has_callees (ir_node *node);
548 int get_Call_n_callees (ir_node *node);
549 entity *get_Call_callee (ir_node *node, int pos);
551 /** Set the full callee array.
553 * The passed array is copied. Assumes current_ir_graph set properly! */
554 void set_Call_callee_arr (ir_node *node, const int n, entity **arr);
555 void remove_Call_callee_arr(ir_node *node);
557 ir_node *get_CallBegin_ptr (ir_node *node);
558 void set_CallBegin_ptr (ir_node *node, ir_node *ptr);
559 ir_node *get_CallBegin_call (ir_node *node);
560 void set_CallBegin_call (ir_node *node, ir_node *call);
562 /* For unary and binary arithmetic operations the access to the
563 operands can be factored out. Left is the first, right the
564 second arithmetic value as listed in tech report 1999-44.
565 unops are: Minus, Abs, Not, Conv, Cast
566 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
567 Shr, Shrs, Rot, Cmp */
568 int is_unop (const ir_node *node);
569 ir_node *get_unop_op (ir_node *node);
570 void set_unop_op (ir_node *node, ir_node *op);
571 int is_binop (const ir_node *node);
572 ir_node *get_binop_left (ir_node *node);
573 void set_binop_left (ir_node *node, ir_node *left);
574 ir_node *get_binop_right (ir_node *node);
575 void set_binop_right (ir_node *node, ir_node *right);
577 ir_node *get_Add_left (ir_node *node);
578 void set_Add_left (ir_node *node, ir_node *left);
579 ir_node *get_Add_right (ir_node *node);
580 void set_Add_right (ir_node *node, ir_node *right);
582 ir_node *get_Sub_left (ir_node *node);
583 void set_Sub_left (ir_node *node, ir_node *left);
584 ir_node *get_Sub_right (ir_node *node);
585 void set_Sub_right (ir_node *node, ir_node *right);
587 ir_node *get_Minus_op (ir_node *node);
588 void set_Minus_op (ir_node *node, ir_node *op);
590 ir_node *get_Mul_left (ir_node *node);
591 void set_Mul_left (ir_node *node, ir_node *left);
592 ir_node *get_Mul_right (ir_node *node);
593 void set_Mul_right (ir_node *node, ir_node *right);
595 ir_node *get_Quot_left (ir_node *node);
596 void set_Quot_left (ir_node *node, ir_node *left);
597 ir_node *get_Quot_right (ir_node *node);
598 void set_Quot_right (ir_node *node, ir_node *right);
599 ir_node *get_Quot_mem (ir_node *node);
600 void set_Quot_mem (ir_node *node, ir_node *mem);
603 * Projection numbers for Quot: use for Proj nodes!
606 pn_Quot_M, /**< Memory result. */
607 pn_Quot_X_except, /**< Execution result if exception occurred. */
608 pn_Quot_res, /**< Result of computation. */
609 pn_Quot_max /**< number of projections from a Quot */
610 } pn_Quot; /* Projection numbers for Quot. */
612 ir_node *get_DivMod_left (ir_node *node);
613 void set_DivMod_left (ir_node *node, ir_node *left);
614 ir_node *get_DivMod_right (ir_node *node);
615 void set_DivMod_right (ir_node *node, ir_node *right);
616 ir_node *get_DivMod_mem (ir_node *node);
617 void set_DivMod_mem (ir_node *node, ir_node *mem);
620 * Projection numbers for DivMod: use for Proj nodes!
623 pn_DivMod_M, /**< Memory result. */
624 pn_DivMod_X_except, /**< Execution result if exception occurred. */
625 pn_DivMod_res_div, /**< Result of computation a / b. */
626 pn_DivMod_res_mod, /**< Result of computation a % b. */
627 pn_DivMod_max /**< number of projections from a DivMod */
628 } pn_DivMod; /* Projection numbers for DivMod. */
630 ir_node *get_Div_left (ir_node *node);
631 void set_Div_left (ir_node *node, ir_node *left);
632 ir_node *get_Div_right (ir_node *node);
633 void set_Div_right (ir_node *node, ir_node *right);
634 ir_node *get_Div_mem (ir_node *node);
635 void set_Div_mem (ir_node *node, ir_node *mem);
638 * Projection numbers for Div: use for Proj nodes!
641 pn_Div_M, /**< Memory result. */
642 pn_Div_X_except, /**< Execution result if exception occurred. */
643 pn_Div_res /**< Result of computation. */
644 } pn_Div; /* Projection numbers for Div. */
646 ir_node *get_Mod_left (ir_node *node);
647 void set_Mod_left (ir_node *node, ir_node *left);
648 ir_node *get_Mod_right (ir_node *node);
649 void set_Mod_right (ir_node *node, ir_node *right);
650 ir_node *get_Mod_mem (ir_node *node);
651 void set_Mod_mem (ir_node *node, ir_node *mem);
654 * Projection numbers for Mod: use for Proj nodes!
657 pn_Mod_M, /**< Memory result. */
658 pn_Mod_X_except, /**< Execution result if exception occurred. */
659 pn_Mod_res, /**< Result of computation. */
660 pn_Mod_max /**< number of projections from a Mod */
661 } pn_Mod; /* Projection numbers for Mod. */
663 ir_node *get_Abs_op (ir_node *node);
664 void set_Abs_op (ir_node *node, ir_node *op);
666 ir_node *get_And_left (ir_node *node);
667 void set_And_left (ir_node *node, ir_node *left);
668 ir_node *get_And_right (ir_node *node);
669 void set_And_right (ir_node *node, ir_node *right);
671 ir_node *get_Or_left (ir_node *node);
672 void set_Or_left (ir_node *node, ir_node *left);
673 ir_node *get_Or_right (ir_node *node);
674 void set_Or_right (ir_node *node, ir_node *right);
676 ir_node *get_Eor_left (ir_node *node);
677 void set_Eor_left (ir_node *node, ir_node *left);
678 ir_node *get_Eor_right (ir_node *node);
679 void set_Eor_right (ir_node *node, ir_node *right);
681 ir_node *get_Not_op (ir_node *node);
682 void set_Not_op (ir_node *node, ir_node *op);
685 * Projection numbers for Cmp are defined several times.
686 * The bit patterns are used for various tests, so don't change.
687 * The "unordered" values are possible results of comparing
688 * floating point numbers.
689 * Note that the encoding is imported, so do NOT change the order.
692 pn_Cmp_False = 0, /**< false */
693 pn_Cmp_Eq = 1, /**< equal */
694 pn_Cmp_Lt = 2, /**< less */
695 pn_Cmp_Le = pn_Cmp_Eq|pn_Cmp_Lt, /**< less or equal */
696 pn_Cmp_Gt = 4, /**< greater */
697 pn_Cmp_Ge = pn_Cmp_Eq|pn_Cmp_Gt, /**< greater or equal */
698 pn_Cmp_Lg = pn_Cmp_Lt|pn_Cmp_Gt, /**< less or greater */
699 pn_Cmp_Leg = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
700 pn_Cmp_Uo = 8, /**< unordered */
701 pn_Cmp_Ue = pn_Cmp_Uo|pn_Cmp_Eq, /**< unordered or equal */
702 pn_Cmp_Ul = pn_Cmp_Uo|pn_Cmp_Lt, /**< unordered or less */
703 pn_Cmp_Ule = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
704 pn_Cmp_Ug = pn_Cmp_Uo|pn_Cmp_Gt, /**< unordered or greater */
705 pn_Cmp_Uge = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
706 pn_Cmp_Ne = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
707 pn_Cmp_True = 15 /**< true */
708 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for jni interface */
709 } pn_Cmp; /* Projection numbers for Cmp */
710 /* #define not_mask pn_Cmp_Leg */
712 /** returns the pnc name from an pnc constant */
713 const char *get_pnc_string(int pnc);
715 /** Calculates the negated (Complement(R)) pnc condition. */
716 int get_negated_pnc(int pnc, ir_mode *mode);
718 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
719 int get_inversed_pnc(int pnc);
721 ir_node *get_Cmp_left (ir_node *node);
722 void set_Cmp_left (ir_node *node, ir_node *left);
723 ir_node *get_Cmp_right (ir_node *node);
724 void set_Cmp_right (ir_node *node, ir_node *right);
726 ir_node *get_Shl_left (ir_node *node);
727 void set_Shl_left (ir_node *node, ir_node *left);
728 ir_node *get_Shl_right (ir_node *node);
729 void set_Shl_right (ir_node *node, ir_node *right);
731 ir_node *get_Shr_left (ir_node *node);
732 void set_Shr_left (ir_node *node, ir_node *left);
733 ir_node *get_Shr_right (ir_node *node);
734 void set_Shr_right (ir_node *node, ir_node *right);
736 ir_node *get_Shrs_left (ir_node *node);
737 void set_Shrs_left (ir_node *node, ir_node *left);
738 ir_node *get_Shrs_right (ir_node *node);
739 void set_Shrs_right (ir_node *node, ir_node *right);
741 ir_node *get_Rot_left (ir_node *node);
742 void set_Rot_left (ir_node *node, ir_node *left);
743 ir_node *get_Rot_right (ir_node *node);
744 void set_Rot_right (ir_node *node, ir_node *right);
746 ir_node *get_Conv_op (ir_node *node);
747 void set_Conv_op (ir_node *node, ir_node *op);
749 /* Does Cast need a mem operator?
750 * Cast should only depend on the type, not on the state of an
751 * entity. But: we initialize various fields after Alloc, that
752 * are accessed in the cast. This required some precaution, to
753 * get the right memory into the Loads generated from the cast.
755 ir_node *get_Cast_op (ir_node *node);
756 void set_Cast_op (ir_node *node, ir_node *op);
757 type *get_Cast_type (ir_node *node);
758 void set_Cast_type (ir_node *node, type *to_tp);
760 /** Checks for upcast.
762 * Returns true if the Cast node casts a class type to a super type.
763 * Works also for pointers to classes (recursively).
765 int is_Cast_upcast(ir_node *node);
767 /** Checks for downcast.
769 * Returns true if the Cast node casts a class type to a sub type.
770 * Works also for pointers to classes (recursively).
772 int is_Cast_downcast(ir_node *node);
775 /** Returns true if n is Phi or Filter in interprocedural_view.
776 Returns false if irg in phase building and the Phi has zero
777 predecessors: it's a Phi0. */
778 int is_Phi (const ir_node *n);
779 /** Returns true if irg in phase building and the Phi has zero
780 predecessors: it's a Phi0. */
781 int is_Phi0 (const ir_node *n);
782 /* These routines also work for Filter nodes in interprocedural view. */
783 ir_node **get_Phi_preds_arr (ir_node *node);
784 int get_Phi_n_preds (ir_node *node);
785 ir_node *get_Phi_pred (ir_node *node, int pos);
786 void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
788 ir_node *get_Filter_pred(ir_node *node);
789 void set_Filter_pred(ir_node *node, ir_node *pred);
790 long get_Filter_proj(ir_node *node);
791 void set_Filter_proj(ir_node *node, long proj);
792 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
793 * @@@ Maybe better: arity is zero if no cg preds. */
794 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
795 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
796 int get_Filter_n_cg_preds(ir_node *node);
797 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
799 /** Return true if parameter is a memory operation.
801 * A memory operation is an operation that changes the
802 * memory. I.e., a Load or a Store operation.
804 int is_memop(ir_node *node);
805 ir_node *get_memop_mem (ir_node *node);
806 void set_memop_mem (ir_node *node, ir_node *mem);
807 ir_node *get_memop_ptr (ir_node *node);
808 void set_memop_ptr (ir_node *node, ir_node *ptr);
811 * Projection numbers for Load: use for Proj nodes!
814 pn_Load_M, /**< Memory result. */
815 pn_Load_X_except, /**< Execution result if exception occurred. */
816 pn_Load_res, /**< Result of load operation. */
817 pn_Load_max /**< number of projections from a Load */
818 } pn_Load; /* Projection numbers for Load. */
820 ir_node *get_Load_mem (ir_node *node);
821 void set_Load_mem (ir_node *node, ir_node *mem);
822 ir_node *get_Load_ptr (ir_node *node);
823 void set_Load_ptr (ir_node *node, ir_node *ptr);
824 ir_mode *get_Load_mode (ir_node *node);
825 void set_Load_mode (ir_node *node, ir_mode *mode);
826 ent_volatility get_Load_volatility (ir_node *node);
827 void set_Load_volatility (ir_node *node, ent_volatility volatility);
830 * Projection numbers for Store: use for Proj nodes!
833 pn_Store_M, /**< Memory result. */
834 pn_Store_X_except, /**< Execution result if exception occurred. */
835 pn_Store_max /**< number of projections from a Store */
836 } pn_Store; /* Projection numbers for Store. */
838 ir_node *get_Store_mem (ir_node *node);
839 void set_Store_mem (ir_node *node, ir_node *mem);
840 ir_node *get_Store_ptr (ir_node *node);
841 void set_Store_ptr (ir_node *node, ir_node *ptr);
842 ir_node *get_Store_value (ir_node *node);
843 void set_Store_value (ir_node *node, ir_node *value);
844 ent_volatility get_Store_volatility (ir_node *node);
845 void set_Store_volatility (ir_node *node, ent_volatility volatility);
848 * Projection numbers for Alloc: use for Proj nodes!
851 pn_Alloc_M, /**< Memory result. */
852 pn_Alloc_X_except, /**< Execution result if exception occurred. */
853 pn_Alloc_res, /**< Result of allocation. */
854 pn_Alloc_max /**< number of projections from an Alloc */
855 } pn_Alloc; /* Projection numbers for Alloc. */
857 ir_node *get_Alloc_mem (ir_node *node);
858 void set_Alloc_mem (ir_node *node, ir_node *mem);
859 ir_node *get_Alloc_size (ir_node *node);
860 void set_Alloc_size (ir_node *node, ir_node *size);
861 type *get_Alloc_type (ir_node *node);
862 void set_Alloc_type (ir_node *node, type *tp);
864 /** The allocation place. */
866 stack_alloc, /**< Alloc allocates the object on the stack. */
867 heap_alloc /**< Alloc allocates the object on the heap. */
870 where_alloc get_Alloc_where (ir_node *node);
871 void set_Alloc_where (ir_node *node, where_alloc where);
873 ir_node *get_Free_mem (ir_node *node);
874 void set_Free_mem (ir_node *node, ir_node *mem);
875 ir_node *get_Free_ptr (ir_node *node);
876 void set_Free_ptr (ir_node *node, ir_node *ptr);
877 ir_node *get_Free_size (ir_node *node);
878 void set_Free_size (ir_node *node, ir_node *size);
879 type *get_Free_type (ir_node *node);
880 void set_Free_type (ir_node *node, type *tp);
882 where_alloc get_Free_where (ir_node *node);
883 void set_Free_where (ir_node *node, where_alloc where);
885 ir_node **get_Sync_preds_arr (ir_node *node);
886 int get_Sync_n_preds (ir_node *node);
887 ir_node *get_Sync_pred (ir_node *node, int pos);
888 void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
890 /** Returns the source language type of a Proj node.
891 * Must be an atomic type. Mode of type must be mode of node.
893 type *get_Proj_type (ir_node *node);
895 /** Return the predecessor of a Proj node. */
896 ir_node *get_Proj_pred (const ir_node *node);
897 void set_Proj_pred (ir_node *node, ir_node *pred);
898 /** Return the projection number of a Proj node. */
899 long get_Proj_proj (const ir_node *node);
900 void set_Proj_proj (ir_node *node, long proj);
902 ir_node **get_Tuple_preds_arr (ir_node *node);
903 int get_Tuple_n_preds (ir_node *node);
904 ir_node *get_Tuple_pred (ir_node *node, int pos);
905 void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
907 ir_node *get_Id_pred (ir_node *node);
908 void set_Id_pred (ir_node *node, ir_node *pred);
910 /** Confirm has a single result and returns 'value' unchanged.
911 * The node expresses a restriction on 'value':
912 * 'value' 'cmp' 'bound' == true. */
913 ir_node *get_Confirm_value (ir_node *node);
914 void set_Confirm_value (ir_node *node, ir_node *value);
915 ir_node *get_Confirm_bound (ir_node *node);
916 void set_Confirm_bound (ir_node *node, ir_node *bound);
917 pn_Cmp get_Confirm_cmp (ir_node *node);
918 void set_Confirm_cmp (ir_node *node, pn_Cmp cmp);
920 ir_node *get_Mux_sel (ir_node *node);
921 void set_Mux_sel (ir_node *node, ir_node *sel);
922 ir_node *get_Mux_false (ir_node *node);
923 void set_Mux_false (ir_node *node, ir_node *ir_false);
924 ir_node *get_Mux_true (ir_node *node);
925 void set_Mux_true (ir_node *node, ir_node *ir_true);
930 * NAME Auxiliary routines
932 * Not properly documented ;-)
936 /** returns operand of node if node is a Proj. */
937 ir_node *skip_Proj (ir_node *node);
938 /** returns operand of node if node is a Id */
939 ir_node *skip_Id (ir_node *node); /* Same as skip_nop. */
940 /* returns corresponding operand of Tuple if node is a Proj from
942 ir_node *skip_Tuple (ir_node *node);
943 /** returns operand of node if node is a Cast */
944 ir_node *skip_Cast (ir_node *node);
945 /** returns operand of node if node is a Confirm */
946 ir_node *skip_Confirm (ir_node *node);
947 /** Skip all high-level Operations. */
948 ir_node *skip_HighLevel(ir_node *node);
949 /** returns true if irn is a Const node. */
950 int is_Const(const ir_node *node);
951 /** returns true if node is a Bad node. */
952 int is_Bad (const ir_node *node);
953 /** returns true if the node is not a Block */
954 int is_no_Block (const ir_node *node);
955 /** returns true if the node is a Block */
956 int is_Block (const ir_node *node);
957 /** returns true if node is a Unknown node. */
958 int is_Unknown (const ir_node *node);
959 /** returns true if node is a Proj node or a Filter node in
960 * intraprocedural view */
961 int is_Proj (const ir_node *node);
962 /** Returns true if the operation manipulates control flow:
963 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
964 int is_cfop(const ir_node *node);
966 /** Returns true if the operation manipulates interprocedural control flow:
967 CallBegin, EndReg, EndExcept */
968 int is_ip_cfop(const ir_node *node);
969 /** Returns true if the operation can change the control flow because
970 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
971 Bad. Raise is not fragile, but a unconditional jump. */
972 int is_fragile_op(const ir_node *node);
973 /** Returns the memory operand of fragile operations. */
974 ir_node *get_fragile_op_mem(ir_node *node);
976 /** Returns true if the operation is a forking control flow
977 * operation: Cond. */
978 int is_forking_op(const ir_node *node);
980 /** Return the type associated with the value produced by n
981 * if the node remarks this type as it is the case for
982 * Cast, Const, SymConst and some Proj nodes. */
983 type *get_irn_type(ir_node *n);
986 * Access custom node data.
987 * The data must have been registered with
988 * register_additional_node_data() before.
989 * @param node The ir node to get the data from.
990 * @param type The type of the data you registered.
991 * @param off The value returned by register_additional_node_data().
992 * @return A pointer of type @p type.
994 #define get_irn_data(node,type,off) \
995 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
998 * Get the pointer to the node some custom data belongs to.
999 * @param data The pointer to the custom data.
1000 * @param off The number as returned by register_additional_node_data().
1001 * @return A pointer to the ir node the custom data belongs to.
1003 #define get_irn_data_base(data,off) \
1004 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1007 * Request additional data to be allocated with an ir node.
1008 * @param size The size of the additional data required.
1009 * @return A positive number, if the operation was successful, which
1010 * must be passed to the access macro get_irn_data(), 0 if the
1011 * registration failed.
1013 unsigned register_additional_node_data(unsigned size);
1016 /*-----------------------------------------------------------------*/
1018 /*-----------------------------------------------------------------*/
1021 /** Debug print the node.
1023 * Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
1024 * is set. Else does nothing. */
1025 void dump_irn(ir_node *n);
1030 /* GNU C has the __FUNCTION__ extension */
1031 #define __MYFUNC__ __FUNCTION__
1033 /* use Filename instead */
1034 #define __MYFUNC__ __FILE__
1038 Don't format with "\", firmjni gets problems */
1039 /** Output location */
1040 #define DDM printf("%s(l.%i).\n", __MYFUNC__, __LINE__);
1041 /** Output the firm kind of the node */
1042 #define DDMK(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, print_firm_kind(X), (void *)(X));
1043 /** Output information about a node */
1045 /*#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))*/
1046 int dump_node_opcode(FILE *F, ir_node *n);
1047 #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)
1049 /** Output information about a node and its block */
1050 #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)))
1051 /** Output information about a type */
1052 #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))
1053 /** Output information about an entity */
1054 #define DDME(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
1055 /** Output information about an entity and its type */
1056 #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))
1057 /** Output information about an entity and its owner */
1058 #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))
1059 /** Output information about a graph */
1060 #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))))
1061 /** Output information about an ident */
1062 #define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_id_str(X), (void *)(X))
1063 /** Output information about a mode */
1064 #define DDMM(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
1065 /** Output information about a loop */
1066 #define DDML(X) printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
1067 /** Output information about a tarVal */
1068 #define DDMV(X) printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
1070 /*@}*/ /* end of ir_node group definition */
1077 # endif /* _IRNODE_H_ */