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 block The block the new node belongs to
193 * @param op The opcode of the new node.
194 * @param mode The mode of the new node.
195 * @param arity The arity of the new node, may be <0 if yet.
196 * @param in An array of arity predecessor nodes.
199 new_ir_node (dbg_info *db,
208 * Return the block the node belongs to. This is only
209 * possible for pinned nodes or if the graph is in pinned state.
210 * Otherwise the block may be incorrect. This condition is
211 * now checked by an assertion.
213 * This works for all except Block. It can return Blocks or the Bad node.
215 * To express the difference to access routines that work for all
216 * nodes we use infix "nodes" and do not name this function
217 * get_irn_block(). */
218 ir_node *get_nodes_block (const ir_node *node);
220 /** Sets the Block of a node. */
221 void set_nodes_block (ir_node *node, ir_node *block);
224 * @function get_irn_block()
225 * @see get_nodes_block()
229 * Projection numbers for result of Start node: use for Proj nodes!
232 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
233 pn_Start_M, /**< Projection on the initial memory. */
234 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
235 pn_Start_P_globals, /**< Projection on the pointer to the data segment
236 containing _all_ global entities. */
237 pn_Start_T_args, /**< Projection on all arguments. */
238 pn_Start_P_value_arg_base, /**< Pointer to region of compound value arguments as defined by
239 type of this method. */
240 pn_Start_max /**< number of projections from a Start */
241 } pn_Start; /* Projection numbers for Start. */
244 /** Test whether arbitrary node is frame pointer.
246 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
247 * from Start. If so returns frame type, else Null. */
248 type *is_frame_pointer(ir_node *n);
250 /** Test whether arbitrary node is globals pointer.
252 * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
253 * from Start. If so returns global type, else Null. */
254 type *is_globals_pointer(ir_node *n);
256 /** Test whether arbitrary node is value arg base.
258 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
259 * from Start. If so returns 1, else 0. */
260 int is_value_arg_pointer(ir_node *n);
263 /* @@@ no more supported */
264 ir_node **get_Block_cfgpred_arr (ir_node *node);
265 int get_Block_n_cfgpreds (ir_node *node);
266 ir_node *get_Block_cfgpred (ir_node *node, int pos);
267 void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
268 /** Get the predecessor block.
270 * Returns the block corresonding to the predecessor pos of block.
272 * There are several ambiguities we resolve with this function:
273 * - The direct predecessor can be a Proj, which is not pinned.
274 * We walk from the predecessor to the next pinned node
275 * (skip_Proj) and return the block that node is in.
276 * - If we encounter the Bad node, this function does not return
277 * Start, but the Bad node.
279 ir_node *get_Block_cfgpred_block(ir_node *node, int pos);
280 bool get_Block_matured (ir_node *node);
281 void set_Block_matured (ir_node *node, bool matured);
283 /** A visited flag only for block nodes.
284 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
285 unsigned long get_Block_block_visited (ir_node *node);
286 void set_Block_block_visited (ir_node *node, unsigned long visit);
289 * Marks a block as dead but do not replace it with a Bad node.
290 * Dead blocks are removed in the con
292 ir_node *set_Block_dead(ir_node *block);
293 int is_Block_dead(const ir_node *block);
295 /* For this current_ir_graph must be set. */
296 void mark_Block_block_visited(ir_node *node);
297 int Block_not_block_visited(ir_node *node);
299 /* Set and remove interprocedural predecessors. If the interprocedural
300 * predecessors are removed, the node has the same predecessors in
302 * @@@ Maybe better: arity is zero if no cg preds. */
303 void set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
304 void set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
305 /* @@@ not supported */
306 ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
307 /** Returns the number of interprocedural predecessors. 0 if none. */
308 int get_Block_cg_n_cfgpreds(ir_node * node);
309 /** Return the interprocedural predecessor at position pos. */
310 ir_node *get_Block_cg_cfgpred(ir_node * node, int pos);
311 /* frees the memory. */
312 void remove_Block_cg_cfgpred_arr(ir_node * node);
314 /** returns the extended basic block a block belongs to */
315 ir_extblk *get_Block_extbb(const ir_node *block);
316 /** sets the extended basic block a block belongs to */
317 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
319 /** Return the number of Keep alive node. */
320 int get_End_n_keepalives(ir_node *end);
322 /** Return the Keep alive node a position pos. */
323 ir_node *get_End_keepalive(ir_node *end, int pos);
325 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
326 void add_End_keepalive (ir_node *end, ir_node *ka);
328 /** Set the Keep alive node at position pos. */
329 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
331 /** Some parts of the End node are allocated separately -- their memory
332 is not recovered by dead_node_elimination if a End node is dead.
333 free_End() frees these data structures. */
334 void free_End (ir_node *end);
336 /** Return the target address of an IJmp */
337 ir_node *get_IJmp_target(ir_node *ijmp);
339 /** Sets the target address of an IJmp */
340 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
342 /* We distinguish three kinds of Cond nodes. These can be distinguished
343 by the mode of the selector operand and an internal flag of type cond_kind.
344 First we distinguish binary Conds and switch Conds.
345 A binary Cond has as selector a boolean value. Proj(0) projects the control
346 flow for case "False", Proj(1) the control flow for "True". A binary Cond
347 is recognized by the boolean selector.
348 The switch Cond has as selector an unsigned integer. It produces as result
349 an n+1 Tuple (cf0, ... , cfn) of control flows.
350 We differ two flavors of this Cond. The first, the dense Cond, passes
351 control along output i if the selector value is i, 0 <= i <= n. If the
352 selector value is >n it passes control along output n.
353 The second Cond flavor differences in the treatment of cases not specified in
354 the source program. It magically knows about the existence of Proj nodes.
355 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
356 exists. Else it passes control along output n (even if this Proj does not
357 exist.) This Cond we call "fragmentary". There is a special constructor
358 new_defaultProj that automatically sets the flavor.
359 The two switch flavors are distinguished by a flag of type cond_kind.
360 Default flavor is "dense"
363 dense, /**< Default. Missing Proj nodes are dead control flow. */
364 fragmentary /**< Special. No control flow optimizations allowed. Missing
365 Proj nodes mean default control flow, i.e., Proj(n). */
368 ir_node *get_Cond_selector (ir_node *node);
369 void set_Cond_selector (ir_node *node, ir_node *selector);
370 cond_kind get_Cond_kind (ir_node *node);
371 void set_Cond_kind (ir_node *node, cond_kind kind);
372 long get_Cond_defaultProj (ir_node *node);
375 * Projection numbers for conditions.
378 pn_Cond_false, /**< Control flow if operand is "false". */
379 pn_Cond_true, /**< Control flow if operand is "true". */
380 pn_Cond_max /**< number of projections from a Cond */
381 } pn_Cond; /* Projection numbers for Cond. */
383 ir_node *get_Return_mem (ir_node *node);
384 void set_Return_mem (ir_node *node, ir_node *mem);
385 ir_node **get_Return_res_arr (ir_node *node);
386 int get_Return_n_ress (ir_node *node);
387 ir_node *get_Return_res (ir_node *node, int pos);
388 void set_Return_res (ir_node *node, int pos, ir_node *res);
390 ir_node *get_Raise_mem (ir_node *node);
391 void set_Raise_mem (ir_node *node, ir_node *mem);
392 ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
393 void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
396 * Projection numbers for Raise.
399 pn_Raise_X, /**< Execution result. */
400 pn_Raise_M, /**< Memory result. */
401 pn_Raise_max /**< number of projections from a Raise */
402 } pn_Raise; /* Projection numbers for Raise. */
405 CNST_NULL = 0, /**< The node is a const(0). */
406 CNST_ONE = +1, /**< The node is a const(1). */
407 CNST_ALL_ONE = -1, /**< The node is a const(11111...). */
408 CNST_OTHER = 2, /**< The tarval of the const has another value. */
409 CNST_SYMCONST = 3, /**< The node is symconst. */
410 CNST_NO_CONST = 4 /**< The node is no const at all. */
413 tarval *get_Const_tarval (ir_node *node);
414 void set_Const_tarval (ir_node *node, tarval *con);
417 * Classify a node concerning constant properties.
418 * @param irn A node to check for.
419 * @return Constant properties of that node.
421 cnst_classify_t classify_Const(ir_node *irn);
423 /** Returns the source language type of a Const node.
424 * Must be an atomic type. Mode of type must be mode of node.
426 type *get_Const_type (ir_node *node);
428 /** Sets the source language type of a Const node. */
429 void set_Const_type (ir_node *node, type *tp);
431 /** This enum names the three different kinds of symbolic Constants
432 represented by SymConst. The content of the attribute type_or_id
433 depends on this tag. Use the proper access routine after testing
436 symconst_type_tag, /**< The SymConst is a type tag for the given type.
437 Type_or_id_p is type *. */
438 symconst_size, /**< The SymConst is the size of the given type.
439 Type_or_id_p is type *. */
440 symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
441 by the linker. The pointer is represented by a string.
442 Type_or_id_p is ident *. */
443 symconst_addr_ent /**< The SymConst is a symbolic pointer to be filled in
444 by the linker. The pointer is represented by an entity.
445 Type_or_id_p is entity *. */
448 /** SymConst attributes
449 This union contains the symbolic information represented by the node */
450 union symconst_symbol {
456 typedef union symconst_symbol symconst_symbol;
459 /** Get the kind of the SymConst. */
460 symconst_kind get_SymConst_kind (const ir_node *node);
461 /** Set the kind of the SymConst. */
462 void set_SymConst_kind (ir_node *node, symconst_kind num);
464 /** Only to access SymConst of kind type_tag or size. Else assertion: */
465 type *get_SymConst_type (ir_node *node);
466 void set_SymConst_type (ir_node *node, type *tp);
468 /** Only to access SymConst of kind addr_name. Else assertion: */
469 ident *get_SymConst_name (ir_node *node);
470 void set_SymConst_name (ir_node *node, ident *name);
472 /** Only to access SymConst of kind addr_ent. Else assertion: */
473 entity *get_SymConst_entity (ir_node *node);
474 void set_SymConst_entity (ir_node *node, entity *ent);
476 /** Sets both: type and ptrinfo. Needed to treat the node independent of
477 its semantics. Does a memcpy for the memory sym points to. */
478 /* write 'union': firmjni then does not create a method... */
479 union symconst_symbol get_SymConst_symbol (ir_node *node);
480 void set_SymConst_symbol (ir_node *node,
481 union symconst_symbol sym);
483 /** Access the type of the value represented by the SymConst.
485 * Example: primitive type int for SymConst size. */
486 type *get_SymConst_value_type (ir_node *node);
487 void set_SymConst_value_type (ir_node *node, type *tp);
489 ir_node *get_Sel_mem (ir_node *node);
490 void set_Sel_mem (ir_node *node, ir_node *mem);
491 ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
492 void set_Sel_ptr (ir_node *node, ir_node *ptr);
493 ir_node **get_Sel_index_arr (ir_node *node);
494 int get_Sel_n_indexs (ir_node *node);
495 ir_node *get_Sel_index (ir_node *node, int pos);
496 void set_Sel_index (ir_node *node, int pos, ir_node *index);
497 entity *get_Sel_entity (ir_node *node); /* entity to select */
498 void set_Sel_entity (ir_node *node, entity *ent);
501 type *get_InstOf_ent (ir_node *node);
502 void set_InstOf_ent (ir_node *node, type *ent);
503 ir_node *get_InstOf_store (ir_node *node);
504 void set_InstOf_store (ir_node *node, ir_node *obj);
505 ir_node *get_InstOf_obj (ir_node *node);
506 void set_InstOf_obj (ir_node *node, ir_node *obj);
509 * Projection numbers for result of Call node: use for Proj nodes!
512 pn_Call_M_regular = 0, /**< The memory result. */
513 pn_Call_T_result = 2, /**< The tuple containing all (0, 1, 2, ...) results */
514 pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
515 passed by value (for compound result types). */
516 pn_Call_X_except = 1, /**< The control flow result branching to the exception handler */
517 pn_Call_M_except = 3, /**< The memory result in case the called method terminated with
519 pn_Call_max = 5 /**< number of projections from a Call */
520 } pn_Call; /* Projection numbers for Call. */
521 #define pn_Call_M pn_Call_M_regular
523 ir_node *get_Call_mem (ir_node *node);
524 void set_Call_mem (ir_node *node, ir_node *mem);
525 ir_node *get_Call_ptr (ir_node *node);
526 void set_Call_ptr (ir_node *node, ir_node *ptr);
527 ir_node **get_Call_param_arr (ir_node *node);
528 /** Gets the number of parameters of a call. */
529 int get_Call_n_params (ir_node *node);
530 /** Gets the call parameter at position pos. */
531 ir_node *get_Call_param (ir_node *node, int pos);
532 /** Sets the call parameter at position pos. */
533 void set_Call_param (ir_node *node, int pos, ir_node *param);
534 /** Gets the type of a call. */
535 type *get_Call_type (ir_node *node);
536 /** Sets the type of a call. */
537 void set_Call_type (ir_node *node, type *tp);
538 /** Gets the arity of a call. Identical to get_Call_n_params(). */
539 int get_Call_arity (ir_node *node);
541 /** Set, get and remove the callee information for a Call node.
543 * The callee information lists all method entities that can be called
544 * from this node. If the address expression can not be analyzed fully,
545 * e.g., as entities can be called that are not in the compilation unit,
546 * the array contains the unknown_entity. The array contains only entities
547 * with peculiarity_existent, but with all kinds of visibility. The entities
548 * not necessarily contain an irg.
550 * The array is only accessible if callee information is valid. See flag
553 * The memory allocated for the array is managed automatically, i.e., it must
554 * not be freed if the Call node is removed from the graph.
556 * @param node A Call node.
558 int Call_has_callees (ir_node *node);
559 int get_Call_n_callees (ir_node *node);
560 entity *get_Call_callee (ir_node *node, int pos);
562 /** Set the full callee array.
564 * The passed array is copied. Assumes current_ir_graph set properly! */
565 void set_Call_callee_arr (ir_node *node, const int n, entity **arr);
566 void remove_Call_callee_arr(ir_node *node);
568 ir_node *get_CallBegin_ptr (ir_node *node);
569 void set_CallBegin_ptr (ir_node *node, ir_node *ptr);
570 ir_node *get_CallBegin_call (ir_node *node);
571 void set_CallBegin_call (ir_node *node, ir_node *call);
573 /* For unary and binary arithmetic operations the access to the
574 operands can be factored out. Left is the first, right the
575 second arithmetic value as listed in tech report 1999-44.
576 unops are: Minus, Abs, Not, Conv, Cast
577 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
578 Shr, Shrs, Rot, Cmp */
579 int is_unop (const ir_node *node);
580 ir_node *get_unop_op (ir_node *node);
581 void set_unop_op (ir_node *node, ir_node *op);
582 int is_binop (const ir_node *node);
583 ir_node *get_binop_left (ir_node *node);
584 void set_binop_left (ir_node *node, ir_node *left);
585 ir_node *get_binop_right (ir_node *node);
586 void set_binop_right (ir_node *node, ir_node *right);
588 ir_node *get_Add_left (ir_node *node);
589 void set_Add_left (ir_node *node, ir_node *left);
590 ir_node *get_Add_right (ir_node *node);
591 void set_Add_right (ir_node *node, ir_node *right);
593 ir_node *get_Sub_left (ir_node *node);
594 void set_Sub_left (ir_node *node, ir_node *left);
595 ir_node *get_Sub_right (ir_node *node);
596 void set_Sub_right (ir_node *node, ir_node *right);
598 ir_node *get_Minus_op (ir_node *node);
599 void set_Minus_op (ir_node *node, ir_node *op);
601 ir_node *get_Mul_left (ir_node *node);
602 void set_Mul_left (ir_node *node, ir_node *left);
603 ir_node *get_Mul_right (ir_node *node);
604 void set_Mul_right (ir_node *node, ir_node *right);
606 ir_node *get_Quot_left (ir_node *node);
607 void set_Quot_left (ir_node *node, ir_node *left);
608 ir_node *get_Quot_right (ir_node *node);
609 void set_Quot_right (ir_node *node, ir_node *right);
610 ir_node *get_Quot_mem (ir_node *node);
611 void set_Quot_mem (ir_node *node, ir_node *mem);
614 * Projection numbers for Quot: use for Proj nodes!
617 pn_Quot_M, /**< Memory result. */
618 pn_Quot_X_except, /**< Execution result if exception occurred. */
619 pn_Quot_res, /**< Result of computation. */
620 pn_Quot_max /**< number of projections from a Quot */
621 } pn_Quot; /* Projection numbers for Quot. */
623 ir_node *get_DivMod_left (ir_node *node);
624 void set_DivMod_left (ir_node *node, ir_node *left);
625 ir_node *get_DivMod_right (ir_node *node);
626 void set_DivMod_right (ir_node *node, ir_node *right);
627 ir_node *get_DivMod_mem (ir_node *node);
628 void set_DivMod_mem (ir_node *node, ir_node *mem);
631 * Projection numbers for DivMod: use for Proj nodes!
634 pn_DivMod_M, /**< Memory result. */
635 pn_DivMod_X_except, /**< Execution result if exception occurred. */
636 pn_DivMod_res_div, /**< Result of computation a / b. */
637 pn_DivMod_res_mod, /**< Result of computation a % b. */
638 pn_DivMod_max /**< number of projections from a DivMod */
639 } pn_DivMod; /* Projection numbers for DivMod. */
641 ir_node *get_Div_left (ir_node *node);
642 void set_Div_left (ir_node *node, ir_node *left);
643 ir_node *get_Div_right (ir_node *node);
644 void set_Div_right (ir_node *node, ir_node *right);
645 ir_node *get_Div_mem (ir_node *node);
646 void set_Div_mem (ir_node *node, ir_node *mem);
649 * Projection numbers for Div: use for Proj nodes!
652 pn_Div_M, /**< Memory result. */
653 pn_Div_X_except, /**< Execution result if exception occurred. */
654 pn_Div_res /**< Result of computation. */
655 } pn_Div; /* Projection numbers for Div. */
657 ir_node *get_Mod_left (ir_node *node);
658 void set_Mod_left (ir_node *node, ir_node *left);
659 ir_node *get_Mod_right (ir_node *node);
660 void set_Mod_right (ir_node *node, ir_node *right);
661 ir_node *get_Mod_mem (ir_node *node);
662 void set_Mod_mem (ir_node *node, ir_node *mem);
665 * Projection numbers for Mod: use for Proj nodes!
668 pn_Mod_M, /**< Memory result. */
669 pn_Mod_X_except, /**< Execution result if exception occurred. */
670 pn_Mod_res, /**< Result of computation. */
671 pn_Mod_max /**< number of projections from a Mod */
672 } pn_Mod; /* Projection numbers for Mod. */
674 ir_node *get_Abs_op (ir_node *node);
675 void set_Abs_op (ir_node *node, ir_node *op);
677 ir_node *get_And_left (ir_node *node);
678 void set_And_left (ir_node *node, ir_node *left);
679 ir_node *get_And_right (ir_node *node);
680 void set_And_right (ir_node *node, ir_node *right);
682 ir_node *get_Or_left (ir_node *node);
683 void set_Or_left (ir_node *node, ir_node *left);
684 ir_node *get_Or_right (ir_node *node);
685 void set_Or_right (ir_node *node, ir_node *right);
687 ir_node *get_Eor_left (ir_node *node);
688 void set_Eor_left (ir_node *node, ir_node *left);
689 ir_node *get_Eor_right (ir_node *node);
690 void set_Eor_right (ir_node *node, ir_node *right);
692 ir_node *get_Not_op (ir_node *node);
693 void set_Not_op (ir_node *node, ir_node *op);
696 * Projection numbers for Cmp are defined several times.
697 * The bit patterns are used for various tests, so don't change.
698 * The "unordered" values are possible results of comparing
699 * floating point numbers.
700 * Note that the encoding is imported, so do NOT change the order.
703 pn_Cmp_False = 0, /**< false */
704 pn_Cmp_Eq = 1, /**< equal */
705 pn_Cmp_Lt = 2, /**< less */
706 pn_Cmp_Le = pn_Cmp_Eq|pn_Cmp_Lt, /**< less or equal */
707 pn_Cmp_Gt = 4, /**< greater */
708 pn_Cmp_Ge = pn_Cmp_Eq|pn_Cmp_Gt, /**< greater or equal */
709 pn_Cmp_Lg = pn_Cmp_Lt|pn_Cmp_Gt, /**< less or greater */
710 pn_Cmp_Leg = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
711 pn_Cmp_Uo = 8, /**< unordered */
712 pn_Cmp_Ue = pn_Cmp_Uo|pn_Cmp_Eq, /**< unordered or equal */
713 pn_Cmp_Ul = pn_Cmp_Uo|pn_Cmp_Lt, /**< unordered or less */
714 pn_Cmp_Ule = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
715 pn_Cmp_Ug = pn_Cmp_Uo|pn_Cmp_Gt, /**< unordered or greater */
716 pn_Cmp_Uge = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
717 pn_Cmp_Ne = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
718 pn_Cmp_True = 15 /**< true */
719 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for JNI interface */
720 } pn_Cmp; /* Projection numbers for Cmp */
721 /* #define not_mask pn_Cmp_Leg */
723 /** returns the pnc name from an pnc constant */
724 const char *get_pnc_string(int pnc);
726 /** Calculates the negated (Complement(R)) pnc condition. */
727 int get_negated_pnc(int pnc, ir_mode *mode);
729 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
730 int get_inversed_pnc(int pnc);
732 ir_node *get_Cmp_left (ir_node *node);
733 void set_Cmp_left (ir_node *node, ir_node *left);
734 ir_node *get_Cmp_right (ir_node *node);
735 void set_Cmp_right (ir_node *node, ir_node *right);
737 ir_node *get_Shl_left (ir_node *node);
738 void set_Shl_left (ir_node *node, ir_node *left);
739 ir_node *get_Shl_right (ir_node *node);
740 void set_Shl_right (ir_node *node, ir_node *right);
742 ir_node *get_Shr_left (ir_node *node);
743 void set_Shr_left (ir_node *node, ir_node *left);
744 ir_node *get_Shr_right (ir_node *node);
745 void set_Shr_right (ir_node *node, ir_node *right);
747 ir_node *get_Shrs_left (ir_node *node);
748 void set_Shrs_left (ir_node *node, ir_node *left);
749 ir_node *get_Shrs_right (ir_node *node);
750 void set_Shrs_right (ir_node *node, ir_node *right);
752 ir_node *get_Rot_left (ir_node *node);
753 void set_Rot_left (ir_node *node, ir_node *left);
754 ir_node *get_Rot_right (ir_node *node);
755 void set_Rot_right (ir_node *node, ir_node *right);
757 ir_node *get_Conv_op (ir_node *node);
758 void set_Conv_op (ir_node *node, ir_node *op);
760 /* Does Cast need a mem operator?
761 * Cast should only depend on the type, not on the state of an
762 * entity. But: we initialize various fields after Alloc, that
763 * are accessed in the cast. This required some precaution, to
764 * get the right memory into the Loads generated from the cast.
766 ir_node *get_Cast_op (ir_node *node);
767 void set_Cast_op (ir_node *node, ir_node *op);
768 type *get_Cast_type (ir_node *node);
769 void set_Cast_type (ir_node *node, type *to_tp);
771 /** Checks for upcast.
773 * Returns true if the Cast node casts a class type to a super type.
774 * Works also for pointers to classes (recursively).
776 int is_Cast_upcast(ir_node *node);
778 /** Checks for downcast.
780 * Returns true if the Cast node casts a class type to a sub type.
781 * Works also for pointers to classes (recursively).
783 int is_Cast_downcast(ir_node *node);
786 /** Returns true if n is Phi or Filter in interprocedural_view.
787 Returns false if irg in phase building and the Phi has zero
788 predecessors: it's a Phi0. */
789 int is_Phi (const ir_node *n);
790 /** Returns true if irg in phase building and the Phi has zero
791 predecessors: it's a Phi0. */
792 int is_Phi0 (const ir_node *n);
793 /* These routines also work for Filter nodes in interprocedural view. */
794 ir_node **get_Phi_preds_arr (ir_node *node);
795 int get_Phi_n_preds (ir_node *node);
796 ir_node *get_Phi_pred (ir_node *node, int pos);
797 void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
799 ir_node *get_Filter_pred(ir_node *node);
800 void set_Filter_pred(ir_node *node, ir_node *pred);
801 long get_Filter_proj(ir_node *node);
802 void set_Filter_proj(ir_node *node, long proj);
803 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
804 * @@@ Maybe better: arity is zero if no cg preds. */
805 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
806 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
807 int get_Filter_n_cg_preds(ir_node *node);
808 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
810 /** Return true if parameter is a memory operation.
812 * A memory operation is an operation that changes the
813 * memory. I.e., a Load or a Store operation.
815 int is_memop(ir_node *node);
816 ir_node *get_memop_mem (ir_node *node);
817 void set_memop_mem (ir_node *node, ir_node *mem);
818 ir_node *get_memop_ptr (ir_node *node);
819 void set_memop_ptr (ir_node *node, ir_node *ptr);
822 * Projection numbers for Load: use for Proj nodes!
825 pn_Load_M, /**< Memory result. */
826 pn_Load_X_except, /**< Execution result if exception occurred. */
827 pn_Load_res, /**< Result of load operation. */
828 pn_Load_max /**< number of projections from a Load */
829 } pn_Load; /* Projection numbers for Load. */
831 ir_node *get_Load_mem (ir_node *node);
832 void set_Load_mem (ir_node *node, ir_node *mem);
833 ir_node *get_Load_ptr (ir_node *node);
834 void set_Load_ptr (ir_node *node, ir_node *ptr);
835 ir_mode *get_Load_mode (ir_node *node);
836 void set_Load_mode (ir_node *node, ir_mode *mode);
837 ent_volatility get_Load_volatility (ir_node *node);
838 void set_Load_volatility (ir_node *node, ent_volatility volatility);
841 * Projection numbers for Store: use for Proj nodes!
844 pn_Store_M, /**< Memory result. */
845 pn_Store_X_except, /**< Execution result if exception occurred. */
846 pn_Store_max /**< number of projections from a Store */
847 } pn_Store; /* Projection numbers for Store. */
849 ir_node *get_Store_mem (ir_node *node);
850 void set_Store_mem (ir_node *node, ir_node *mem);
851 ir_node *get_Store_ptr (ir_node *node);
852 void set_Store_ptr (ir_node *node, ir_node *ptr);
853 ir_node *get_Store_value (ir_node *node);
854 void set_Store_value (ir_node *node, ir_node *value);
855 ent_volatility get_Store_volatility (ir_node *node);
856 void set_Store_volatility (ir_node *node, ent_volatility volatility);
859 * Projection numbers for Alloc: use for Proj nodes!
862 pn_Alloc_M, /**< Memory result. */
863 pn_Alloc_X_except, /**< Execution result if exception occurred. */
864 pn_Alloc_res, /**< Result of allocation. */
865 pn_Alloc_max /**< number of projections from an Alloc */
866 } pn_Alloc; /* Projection numbers for Alloc. */
868 ir_node *get_Alloc_mem (ir_node *node);
869 void set_Alloc_mem (ir_node *node, ir_node *mem);
870 ir_node *get_Alloc_size (ir_node *node);
871 void set_Alloc_size (ir_node *node, ir_node *size);
872 type *get_Alloc_type (ir_node *node);
873 void set_Alloc_type (ir_node *node, type *tp);
875 /** The allocation place. */
877 stack_alloc, /**< Alloc allocates the object on the stack. */
878 heap_alloc /**< Alloc allocates the object on the heap. */
881 where_alloc get_Alloc_where (ir_node *node);
882 void set_Alloc_where (ir_node *node, where_alloc where);
884 ir_node *get_Free_mem (ir_node *node);
885 void set_Free_mem (ir_node *node, ir_node *mem);
886 ir_node *get_Free_ptr (ir_node *node);
887 void set_Free_ptr (ir_node *node, ir_node *ptr);
888 ir_node *get_Free_size (ir_node *node);
889 void set_Free_size (ir_node *node, ir_node *size);
890 type *get_Free_type (ir_node *node);
891 void set_Free_type (ir_node *node, type *tp);
893 where_alloc get_Free_where (ir_node *node);
894 void set_Free_where (ir_node *node, where_alloc where);
896 ir_node **get_Sync_preds_arr (ir_node *node);
897 int get_Sync_n_preds (ir_node *node);
898 ir_node *get_Sync_pred (ir_node *node, int pos);
899 void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
901 /** Returns the source language type of a Proj node.
902 * Must be an atomic type. Mode of type must be mode of node.
904 type *get_Proj_type (ir_node *node);
906 /** Return the predecessor of a Proj node. */
907 ir_node *get_Proj_pred (const ir_node *node);
908 void set_Proj_pred (ir_node *node, ir_node *pred);
909 /** Return the projection number of a Proj node. */
910 long get_Proj_proj (const ir_node *node);
911 void set_Proj_proj (ir_node *node, long proj);
913 ir_node **get_Tuple_preds_arr (ir_node *node);
914 int get_Tuple_n_preds (ir_node *node);
915 ir_node *get_Tuple_pred (ir_node *node, int pos);
916 void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
918 ir_node *get_Id_pred (ir_node *node);
919 void set_Id_pred (ir_node *node, ir_node *pred);
921 /** Confirm has a single result and returns 'value' unchanged.
922 * The node expresses a restriction on 'value':
923 * 'value' 'cmp' 'bound' == true. */
924 ir_node *get_Confirm_value (ir_node *node);
925 void set_Confirm_value (ir_node *node, ir_node *value);
926 ir_node *get_Confirm_bound (ir_node *node);
927 void set_Confirm_bound (ir_node *node, ir_node *bound);
928 pn_Cmp get_Confirm_cmp (ir_node *node);
929 void set_Confirm_cmp (ir_node *node, pn_Cmp cmp);
931 ir_node *get_Mux_sel (ir_node *node);
932 void set_Mux_sel (ir_node *node, ir_node *sel);
933 ir_node *get_Mux_false (ir_node *node);
934 void set_Mux_false (ir_node *node, ir_node *ir_false);
935 ir_node *get_Mux_true (ir_node *node);
936 void set_Mux_true (ir_node *node, ir_node *ir_true);
941 * NAME Auxiliary routines
943 * Not properly documented ;-)
947 /** returns operand of node if node is a Proj. */
948 ir_node *skip_Proj (ir_node *node);
949 /** returns operand of node if node is a Id */
950 ir_node *skip_Id (ir_node *node); /* Same as skip_nop. */
951 /** returns corresponding operand of Tuple if node is a Proj from
953 ir_node *skip_Tuple (ir_node *node);
954 /** returns operand of node if node is a Cast */
955 ir_node *skip_Cast (ir_node *node);
956 /** returns operand of node if node is a Confirm */
957 ir_node *skip_Confirm (ir_node *node);
958 /** Skip all high-level Operations. */
959 ir_node *skip_HighLevel(ir_node *node);
960 /** returns true if irn is a Const node. */
961 int is_Const(const ir_node *node);
962 /** returns true if node is a Bad node. */
963 int is_Bad (const ir_node *node);
964 /** returns true if the node is not a Block */
965 int is_no_Block (const ir_node *node);
966 /** returns true if the node is a Block */
967 int is_Block (const ir_node *node);
968 /** returns true if node is a Unknown node. */
969 int is_Unknown (const ir_node *node);
970 /** returns true if node is a Proj node or a Filter node in
971 * intraprocedural view */
972 int is_Proj (const ir_node *node);
973 /** Returns true if the operation manipulates control flow:
974 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
975 int is_cfop(const ir_node *node);
977 /** Returns true if the operation manipulates interprocedural control flow:
978 CallBegin, EndReg, EndExcept */
979 int is_ip_cfop(const ir_node *node);
980 /** Returns true if the operation can change the control flow because
981 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
982 Bad. Raise is not fragile, but a unconditional jump. */
983 int is_fragile_op(const ir_node *node);
984 /** Returns the memory operand of fragile operations. */
985 ir_node *get_fragile_op_mem(ir_node *node);
987 /** Returns true if the operation is a forking control flow
988 * operation: Cond. */
989 int is_forking_op(const ir_node *node);
991 /** Return the type associated with the value produced by n
992 * if the node remarks this type as it is the case for
993 * Cast, Const, SymConst and some Proj nodes. */
994 type *get_irn_type(ir_node *n);
997 * Access custom node data.
998 * The data must have been registered with
999 * register_additional_node_data() before.
1000 * @param node The ir node to get the data from.
1001 * @param type The type of the data you registered.
1002 * @param off The value returned by register_additional_node_data().
1003 * @return A pointer of type @p type.
1005 #define get_irn_data(node,type,off) \
1006 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1009 * Get the pointer to the node some custom data belongs to.
1010 * @param data The pointer to the custom data.
1011 * @param off The number as returned by register_additional_node_data().
1012 * @return A pointer to the ir node the custom data belongs to.
1014 #define get_irn_data_base(data,off) \
1015 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1018 * Request additional data to be allocated with an ir node.
1019 * @param size The size of the additional data required.
1020 * @return A positive number, if the operation was successful, which
1021 * must be passed to the access macro get_irn_data(), 0 if the
1022 * registration failed.
1024 unsigned register_additional_node_data(unsigned size);
1027 /*-----------------------------------------------------------------*/
1029 /*-----------------------------------------------------------------*/
1032 /** Debug print the node.
1034 * Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
1035 * is set. Else does nothing. */
1036 void dump_irn(ir_node *n);
1041 /* GNU C has the __FUNCTION__ extension */
1042 #define __MYFUNC__ __FUNCTION__
1044 /* use Filename instead */
1045 #define __MYFUNC__ __FILE__
1049 Don't format with "\", firmjni gets problems */
1050 /** Output location */
1051 #define DDM printf("%s(l.%i).\n", __MYFUNC__, __LINE__);
1052 /** Output the firm kind of the node */
1053 #define DDMK(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, print_firm_kind(X), (void *)(X));
1054 /** Output information about a node */
1056 /*#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))*/
1057 int dump_node_opcode(FILE *F, ir_node *n);
1058 #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)
1060 /** Output information about a node and its block */
1061 #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)))
1062 /** Output information about a type */
1063 #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))
1064 /** Output information about an entity */
1065 #define DDME(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
1066 /** Output information about an entity and its type */
1067 #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))
1068 /** Output information about an entity and its owner */
1069 #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))
1070 /** Output information about a graph */
1071 #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))))
1072 /** Output information about an ident */
1073 #define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_id_str(X), (void *)(X))
1074 /** Output information about a mode */
1075 #define DDMM(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
1076 /** Output information about a loop */
1077 #define DDML(X) printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
1078 /** Output information about a tarVal */
1079 #define DDMV(X) printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
1081 /*@}*/ /* end of ir_node group definition */
1088 # endif /* _IRNODE_H_ */