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