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.
12 #ifndef _FIRM_IR_IRNODE_H_
13 #define _FIRM_IR_IRNODE_H_
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.
108 * This function automatically handles intra- and interprocedural views.
110 ir_node *get_irn_n (const ir_node *node, int n);
113 * Get the n-th predecessor of a node in intraprocedural view.
114 * Can be used always if it's know that node is not a split one.
116 ir_node *get_irn_intra_n (const ir_node *node, int n);
119 * Get the n-th predecessor of a node in interprocedural view.
121 ir_node *get_irn_inter_n (const ir_node *node, int n);
123 /** Replace the n-th predecessor of a node with a new one. */
124 void set_irn_n (ir_node *node, int n, ir_node *in);
125 /* Sets the mode struct of node. */
126 void set_irn_mode (ir_node *node, ir_mode *mode);
127 /** Gets the mode struct of a node. */
128 ir_mode *get_irn_mode (const ir_node *node);
129 /** Gets the mode-enum modecode. */
130 modecode get_irn_modecode (const ir_node *node);
131 /** Gets the ident for a string representation of the mode .*/
132 ident *get_irn_modeident (const ir_node *node);
133 /** Gets the string representation of the mode .*/
134 const char *get_irn_modename (const ir_node *node);
135 /** Gets the opcode struct of the node. */
136 ir_op *get_irn_op (const ir_node *node);
137 /** Sets the opcode struct of the node. */
138 void set_irn_op (ir_node *node, ir_op *op);
139 /** Gets the opcode-enum of the node. */
140 opcode get_irn_opcode (const ir_node *node);
141 /** Get the string representation of the opcode. */
142 const char *get_irn_opname (const ir_node *node);
143 /** Get the ident for a string representation of the opcode. */
144 ident *get_irn_opident (const ir_node *node);
145 /** If arg is an argument of the node, returns it's position, -1 otherwise */
146 int get_irn_pred_pos (ir_node *node, ir_node *arg);
147 /** Gets the visited counter of a node. */
148 unsigned long get_irn_visited (const ir_node *node);
149 /** Sets the visited counter of a node. */
150 void set_irn_visited (ir_node *node, unsigned long visited);
151 /** Sets visited to get_irg_visited(current_ir_graph). */
152 void mark_irn_visited (ir_node *node);
153 /** Returns 1 if visited < get_irg_visited(current_ir_graph). */
154 int irn_not_visited (const ir_node *node);
155 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
156 int irn_visited (const ir_node *node);
159 * Sets the link of a node.
160 * Only allowed if the graph is NOT in phase_building.
162 void set_irn_link (ir_node *node, void *link);
164 /** Returns the link of a node. */
165 void *get_irn_link (const ir_node *node);
167 /** Returns the ir_graph this node belongs to. Only valid if irg
168 * is in state op_pin_state_pinned (irg is only stored in the block. */
169 ir_graph *get_irn_irg (const ir_node *node);
171 /** Outputs a unique number for this node if libFIRM is compiled for
172 debugging, (configure with --enable-debug) else returns address
173 of node cast to long. */
174 long get_irn_node_nr (const ir_node *node);
176 /** Returns the pinned state of a node.
178 * Returns whether the node _always_ must be pinned.
179 * I.e., the node is not floating after global cse.
181 * @returns Either state op_pin_state_pinned or op_pin_state_floats.
183 op_pin_state get_irn_pinned (const ir_node *node);
185 /** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
186 void set_irn_pinned(ir_node *node, op_pin_state state);
188 /** Returns whether the node is currently pinned.
190 * If get_irn_pinned returns op_pin_state_floats and the graph the
191 * node belongs to is in state op_poin_state_floats then this function
192 * returns 'floats', else 'pinned'.
194 op_pin_state is_irn_pinned_in_irg (const ir_node *node);
197 * irnode constructor.
198 * Create a new irnode in irg, with an op, mode, arity and
199 * some incoming irnodes.
200 * This constructor is used in every specified irnode constructor.
202 * @param db Debug info.
203 * @param irg IR-graph on with this new node should be constructed.
204 * @param block The block the new node belongs to
205 * @param op The opcode of the new node.
206 * @param mode The mode of the new node.
207 * @param arity The arity of the new node, may be <0 if yet.
208 * @param in An array of arity predecessor nodes.
211 new_ir_node (dbg_info *db,
220 * Return the block the node belongs to. This is only
221 * possible for pinned nodes or if the graph is in pinned state.
222 * Otherwise the block may be incorrect. This condition is
223 * now checked by an assertion.
225 * This works for all except Block. It can return Blocks or the Bad node.
227 * To express the difference to access routines that work for all
228 * nodes we use infix "nodes" and do not name this function
229 * get_irn_block(). */
230 ir_node *get_nodes_block (const ir_node *node);
232 /** Sets the Block of a node. */
233 void set_nodes_block (ir_node *node, ir_node *block);
236 * @function get_irn_block()
237 * @see get_nodes_block()
241 * Projection numbers for result of Start node: use for Proj nodes!
244 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
245 pn_Start_M, /**< Projection on the initial memory. */
246 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
247 pn_Start_P_globals, /**< Projection on the pointer to the data segment
248 containing _all_ global entities. */
249 pn_Start_T_args, /**< Projection on all arguments. */
250 pn_Start_P_value_arg_base, /**< Pointer to region of compound value arguments as defined by
251 type of this method. */
252 pn_Start_max /**< number of projections from a Start */
253 } pn_Start; /* Projection numbers for Start. */
256 /** Test whether arbitrary node is frame pointer.
258 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
259 * from Start. If so returns frame type, else Null. */
260 ir_type *is_frame_pointer(ir_node *n);
262 /** Test whether arbitrary node is globals pointer.
264 * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
265 * from Start. If so returns global type, else Null. */
266 ir_type *is_globals_pointer(ir_node *n);
268 /** Test whether arbitrary node is value arg base.
270 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
271 * from Start. If so returns 1, else 0. */
272 int is_value_arg_pointer(ir_node *n);
275 /* @@@ no more supported */
276 ir_node **get_Block_cfgpred_arr (ir_node *node);
277 int get_Block_n_cfgpreds (ir_node *node);
278 ir_node *get_Block_cfgpred (ir_node *node, int pos);
279 void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
280 /** Get the predecessor block.
282 * Returns the block corresponding to the predecessor pos of block.
284 * There are several ambiguities we resolve with this function:
285 * - The direct predecessor can be a Proj, which is not pinned.
286 * We walk from the predecessor to the next pinned node
287 * (skip_Proj) and return the block that node is in.
288 * - If we encounter the Bad node, this function does not return
289 * Start, but the Bad node.
291 ir_node *get_Block_cfgpred_block(ir_node *node, int pos);
292 int get_Block_matured (ir_node *node);
293 void set_Block_matured (ir_node *node, int matured);
295 /** A visited flag only for block nodes.
296 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
297 unsigned long get_Block_block_visited (ir_node *node);
298 void set_Block_block_visited (ir_node *node, unsigned long visit);
301 * Marks a block as dead but do not replace it with a Bad node.
302 * Dead blocks are removed in the con
304 ir_node *set_Block_dead(ir_node *block);
305 int is_Block_dead(const ir_node *block);
307 /* For this current_ir_graph must be set. */
308 void mark_Block_block_visited(ir_node *node);
309 int Block_not_block_visited(ir_node *node);
311 /* Set and remove interprocedural predecessors. If the interprocedural
312 * predecessors are removed, the node has the same predecessors in
314 * @@@ Maybe better: arity is zero if no cg preds. */
315 void set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
316 void set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
317 /* @@@ not supported */
318 ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
319 /** Returns the number of interprocedural predecessors. 0 if none. */
320 int get_Block_cg_n_cfgpreds(ir_node * node);
321 /** Return the interprocedural predecessor at position pos. */
322 ir_node *get_Block_cg_cfgpred(ir_node * node, int pos);
323 /* frees the memory. */
324 void remove_Block_cg_cfgpred_arr(ir_node * node);
326 /** returns the extended basic block a block belongs to */
327 ir_extblk *get_Block_extbb(const ir_node *block);
328 /** sets the extended basic block a block belongs to */
329 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
331 /** Return the number of Keep alive node. */
332 int get_End_n_keepalives(ir_node *end);
334 /** Return the Keep alive node a position pos. */
335 ir_node *get_End_keepalive(ir_node *end, int pos);
337 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
338 void add_End_keepalive (ir_node *end, ir_node *ka);
340 /** Set the Keep alive node at position pos. */
341 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
343 /** Set new keep-alives */
344 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
346 /** Some parts of the End node are allocated separately -- their memory
347 is not recovered by dead_node_elimination if a End node is dead.
348 free_End() frees these data structures. */
349 void free_End (ir_node *end);
351 /** Return the target address of an IJmp */
352 ir_node *get_IJmp_target(ir_node *ijmp);
354 /** Sets the target address of an IJmp */
355 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
357 /* We distinguish three kinds of Cond nodes. These can be distinguished
358 by the mode of the selector operand and an internal flag of type cond_kind.
359 First we distinguish binary Conds and switch Conds.
360 A binary Cond has as selector a boolean value. Proj(0) projects the control
361 flow for case "False", Proj(1) the control flow for "True". A binary Cond
362 is recognized by the boolean selector.
363 The switch Cond has as selector an unsigned integer. It produces as result
364 an n+1 Tuple (cf0, ... , cfn) of control flows.
365 We differ two flavors of this Cond. The first, the dense Cond, passes
366 control along output i if the selector value is i, 0 <= i <= n. If the
367 selector value is >n it passes control along output n.
368 The second Cond flavor differences in the treatment of cases not specified in
369 the source program. It magically knows about the existence of Proj nodes.
370 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
371 exists. Else it passes control along output n (even if this Proj does not
372 exist.) This Cond we call "fragmentary". There is a special constructor
373 new_defaultProj that automatically sets the flavor.
374 The two switch flavors are distinguished by a flag of type cond_kind.
375 Default flavor is "dense"
378 dense, /**< Default. Missing Proj nodes are dead control flow. */
379 fragmentary /**< Special. No control flow optimizations allowed. Missing
380 Proj nodes mean default control flow, i.e., Proj(n). */
383 ir_node *get_Cond_selector (ir_node *node);
384 void set_Cond_selector (ir_node *node, ir_node *selector);
385 cond_kind get_Cond_kind (ir_node *node);
386 void set_Cond_kind (ir_node *node, cond_kind kind);
387 long get_Cond_defaultProj (ir_node *node);
390 * Projection numbers for conditions.
393 pn_Cond_false, /**< Control flow if operand is "false". */
394 pn_Cond_true, /**< Control flow if operand is "true". */
395 pn_Cond_max /**< number of projections from a Cond */
396 } pn_Cond; /* Projection numbers for Cond. */
398 ir_node *get_Return_mem (ir_node *node);
399 void set_Return_mem (ir_node *node, ir_node *mem);
400 ir_node **get_Return_res_arr (ir_node *node);
401 int get_Return_n_ress (ir_node *node);
402 ir_node *get_Return_res (ir_node *node, int pos);
403 void set_Return_res (ir_node *node, int pos, ir_node *res);
406 CNST_NULL = 0, /**< The node is a const(0). */
407 CNST_ONE = +1, /**< The node is a const(1). */
408 CNST_ALL_ONE = -1, /**< The node is a const(11111...). */
409 CNST_OTHER = 2, /**< The tarval of the const has another value. */
410 CNST_SYMCONST = 3, /**< The node is symconst. */
411 CNST_NO_CONST = 4 /**< The node is no const at all. */
414 tarval *get_Const_tarval (ir_node *node);
415 void set_Const_tarval (ir_node *node, tarval *con);
418 * Classify a node concerning constant properties.
419 * @param irn A node to check for.
420 * @return Constant properties of that node.
422 cnst_classify_t classify_Const(ir_node *irn);
424 /** Returns the source language type of a Const node.
425 * Must be an atomic type. Mode of type must be mode of node.
427 ir_type *get_Const_type (ir_node *node);
429 /** Sets the source language type of a Const node. */
430 void set_Const_type (ir_node *node, ir_type *tp);
432 /** This enum names the three different kinds of symbolic Constants
433 represented by SymConst. The content of the attribute type_or_id
434 depends on this tag. Use the proper access routine after testing
437 symconst_type_tag, /**< The SymConst is a type tag for the given type.
438 symconst_symbol is type *. */
439 symconst_type_size, /**< The SymConst is the size of the given type.
440 symconst_symbol is type *. */
441 symconst_type_align, /**< The SymConst is the alignment of the given type.
442 symconst_symbol is type *. */
443 symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
444 by the linker. The pointer is represented by a string.
445 symconst_symbol is ident *. */
446 symconst_addr_ent /**< The SymConst is a symbolic pointer to be filled in
447 by the linker. The pointer is represented by an entity.
448 symconst_symbol is entity *. */
451 /** Returns non-zero if s symconst kind has a type attribute */
452 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
454 /** Returns non-zero if s symconst kind has an ident attribute */
455 #define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)
457 /** Returns non-zero if s symconst kind has an entity attribute */
458 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent)
460 /** SymConst attribute.
462 * This union contains the symbolic information represented by the node. */
463 typedef union symconst_symbol {
469 /** Get the kind of the SymConst. */
470 symconst_kind get_SymConst_kind (const ir_node *node);
471 /** Set the kind of the SymConst. */
472 void set_SymConst_kind (ir_node *node, symconst_kind num);
474 /** Only to access SymConst of kind type_tag or size. Else assertion: */
475 ir_type *get_SymConst_type (ir_node *node);
476 void set_SymConst_type (ir_node *node, ir_type *tp);
478 /** Only to access SymConst of kind addr_name. Else assertion: */
479 ident *get_SymConst_name (ir_node *node);
480 void set_SymConst_name (ir_node *node, ident *name);
482 /** Only to access SymConst of kind addr_ent. Else assertion: */
483 entity *get_SymConst_entity (ir_node *node);
484 void set_SymConst_entity (ir_node *node, entity *ent);
486 /** Sets both: type and ptrinfo. Needed to treat the node independent of
487 its semantics. Does a memcpy for the memory sym points to. */
488 /* write 'union': firmjni then does not create a method... */
489 union symconst_symbol get_SymConst_symbol (ir_node *node);
490 void set_SymConst_symbol (ir_node *node,
491 union symconst_symbol sym);
493 /** Access the type of the value represented by the SymConst.
495 * Example: primitive type int for SymConst size. */
496 ir_type *get_SymConst_value_type (ir_node *node);
497 void set_SymConst_value_type (ir_node *node, ir_type *tp);
499 ir_node *get_Sel_mem (ir_node *node);
500 void set_Sel_mem (ir_node *node, ir_node *mem);
501 ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
502 void set_Sel_ptr (ir_node *node, ir_node *ptr);
503 ir_node **get_Sel_index_arr (ir_node *node);
504 int get_Sel_n_indexs (ir_node *node);
505 ir_node *get_Sel_index (ir_node *node, int pos);
506 void set_Sel_index (ir_node *node, int pos, ir_node *index);
507 entity *get_Sel_entity (ir_node *node); /* entity to select */
508 void set_Sel_entity (ir_node *node, entity *ent);
511 * Projection numbers for result of Call node: use for Proj nodes!
514 pn_Call_M_regular = 0, /**< The memory result. */
515 pn_Call_T_result = 2, /**< The tuple containing all (0, 1, 2, ...) results */
516 pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
517 passed by value (for compound result types). */
518 pn_Call_X_except = 1, /**< The control flow result branching to the exception handler */
519 pn_Call_M_except = 3, /**< The memory result in case the called method terminated with
521 pn_Call_max = 5 /**< number of projections from a Call */
522 } pn_Call; /* Projection numbers for Call. */
523 #define pn_Call_M pn_Call_M_regular
525 ir_node *get_Call_mem (ir_node *node);
526 void set_Call_mem (ir_node *node, ir_node *mem);
527 ir_node *get_Call_ptr (ir_node *node);
528 void set_Call_ptr (ir_node *node, ir_node *ptr);
529 ir_node **get_Call_param_arr (ir_node *node);
530 /** Gets the number of parameters of a call. */
531 int get_Call_n_params (ir_node *node);
532 /** Gets the call parameter at position pos. */
533 ir_node *get_Call_param (ir_node *node, int pos);
534 /** Sets the call parameter at position pos. */
535 void set_Call_param (ir_node *node, int pos, ir_node *param);
536 /** Gets the type of a call. */
537 ir_type *get_Call_type (ir_node *node);
538 /** Sets the type of a call. */
539 void set_Call_type (ir_node *node, ir_type *tp);
540 /** Gets the arity of a call. Identical to get_Call_n_params(). */
541 int get_Call_arity (ir_node *node);
543 /** Set, get and remove the callee information for a Call node.
545 * The callee information lists all method entities that can be called
546 * from this node. If the address expression can not be analyzed fully,
547 * e.g., as entities can be called that are not in the compilation unit,
548 * the array contains the unknown_entity. The array contains only entities
549 * with peculiarity_existent, but with all kinds of visibility. The entities
550 * not necessarily contain an irg.
552 * The array is only accessible if callee information is valid. See flag
555 * The memory allocated for the array is managed automatically, i.e., it must
556 * not be freed if the Call node is removed from the graph.
558 * @param node A Call node.
560 int Call_has_callees (ir_node *node);
561 int get_Call_n_callees (ir_node *node);
562 entity *get_Call_callee (ir_node *node, int pos);
564 /** Set the full callee array.
566 * The passed array is copied. Assumes current_ir_graph set properly! */
567 void set_Call_callee_arr (ir_node *node, const int n, entity **arr);
568 void remove_Call_callee_arr(ir_node *node);
570 ir_node *get_CallBegin_ptr (ir_node *node);
571 void set_CallBegin_ptr (ir_node *node, ir_node *ptr);
572 ir_node *get_CallBegin_call (ir_node *node);
573 void set_CallBegin_call (ir_node *node, ir_node *call);
575 /* For unary and binary arithmetic operations the access to the
576 operands can be factored out. Left is the first, right the
577 second arithmetic value as listed in tech report 1999-44.
578 unops are: Minus, Abs, Not, Conv, Cast
579 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
580 Shr, Shrs, Rot, Cmp */
581 int is_unop (const ir_node *node);
582 ir_node *get_unop_op (ir_node *node);
583 void set_unop_op (ir_node *node, ir_node *op);
584 int is_binop (const ir_node *node);
585 ir_node *get_binop_left (ir_node *node);
586 void set_binop_left (ir_node *node, ir_node *left);
587 ir_node *get_binop_right (ir_node *node);
588 void set_binop_right (ir_node *node, ir_node *right);
590 ir_node *get_Add_left (ir_node *node);
591 void set_Add_left (ir_node *node, ir_node *left);
592 ir_node *get_Add_right (ir_node *node);
593 void set_Add_right (ir_node *node, ir_node *right);
595 ir_node *get_Sub_left (ir_node *node);
596 void set_Sub_left (ir_node *node, ir_node *left);
597 ir_node *get_Sub_right (ir_node *node);
598 void set_Sub_right (ir_node *node, ir_node *right);
600 ir_node *get_Minus_op (ir_node *node);
601 void set_Minus_op (ir_node *node, ir_node *op);
603 ir_node *get_Mul_left (ir_node *node);
604 void set_Mul_left (ir_node *node, ir_node *left);
605 ir_node *get_Mul_right (ir_node *node);
606 void set_Mul_right (ir_node *node, ir_node *right);
608 ir_node *get_Quot_left (ir_node *node);
609 void set_Quot_left (ir_node *node, ir_node *left);
610 ir_node *get_Quot_right (ir_node *node);
611 void set_Quot_right (ir_node *node, ir_node *right);
612 ir_node *get_Quot_mem (ir_node *node);
613 void set_Quot_mem (ir_node *node, ir_node *mem);
616 * Projection numbers for Quot: use for Proj nodes!
619 pn_Quot_M, /**< Memory result. */
620 pn_Quot_X_except, /**< Execution result if exception occurred. */
621 pn_Quot_res, /**< Result of computation. */
622 pn_Quot_max /**< number of projections from a Quot */
623 } pn_Quot; /* Projection numbers for Quot. */
625 ir_node *get_DivMod_left (ir_node *node);
626 void set_DivMod_left (ir_node *node, ir_node *left);
627 ir_node *get_DivMod_right (ir_node *node);
628 void set_DivMod_right (ir_node *node, ir_node *right);
629 ir_node *get_DivMod_mem (ir_node *node);
630 void set_DivMod_mem (ir_node *node, ir_node *mem);
633 * Projection numbers for DivMod: use for Proj nodes!
636 pn_DivMod_M, /**< Memory result. */
637 pn_DivMod_X_except, /**< Execution result if exception occurred. */
638 pn_DivMod_res_div, /**< Result of computation a / b. */
639 pn_DivMod_res_mod, /**< Result of computation a % b. */
640 pn_DivMod_max /**< number of projections from a DivMod */
641 } pn_DivMod; /* Projection numbers for DivMod. */
643 ir_node *get_Div_left (ir_node *node);
644 void set_Div_left (ir_node *node, ir_node *left);
645 ir_node *get_Div_right (ir_node *node);
646 void set_Div_right (ir_node *node, ir_node *right);
647 ir_node *get_Div_mem (ir_node *node);
648 void set_Div_mem (ir_node *node, ir_node *mem);
651 * Projection numbers for Div: use for Proj nodes!
654 pn_Div_M, /**< Memory result. */
655 pn_Div_X_except, /**< Execution result if exception occurred. */
656 pn_Div_res, /**< Result of computation. */
657 pn_Div_max /**< number of projections from a Div */
658 } pn_Div; /* Projection numbers for Div. */
660 ir_node *get_Mod_left (ir_node *node);
661 void set_Mod_left (ir_node *node, ir_node *left);
662 ir_node *get_Mod_right (ir_node *node);
663 void set_Mod_right (ir_node *node, ir_node *right);
664 ir_node *get_Mod_mem (ir_node *node);
665 void set_Mod_mem (ir_node *node, ir_node *mem);
668 * Projection numbers for Mod: use for Proj nodes!
671 pn_Mod_M, /**< Memory result. */
672 pn_Mod_X_except, /**< Execution result if exception occurred. */
673 pn_Mod_res, /**< Result of computation. */
674 pn_Mod_max /**< number of projections from a Mod */
675 } pn_Mod; /* Projection numbers for Mod. */
677 ir_node *get_Abs_op (ir_node *node);
678 void set_Abs_op (ir_node *node, ir_node *op);
680 ir_node *get_And_left (ir_node *node);
681 void set_And_left (ir_node *node, ir_node *left);
682 ir_node *get_And_right (ir_node *node);
683 void set_And_right (ir_node *node, ir_node *right);
685 ir_node *get_Or_left (ir_node *node);
686 void set_Or_left (ir_node *node, ir_node *left);
687 ir_node *get_Or_right (ir_node *node);
688 void set_Or_right (ir_node *node, ir_node *right);
690 ir_node *get_Eor_left (ir_node *node);
691 void set_Eor_left (ir_node *node, ir_node *left);
692 ir_node *get_Eor_right (ir_node *node);
693 void set_Eor_right (ir_node *node, ir_node *right);
695 ir_node *get_Not_op (ir_node *node);
696 void set_Not_op (ir_node *node, ir_node *op);
699 * Projection numbers for Cmp are defined several times.
700 * The bit patterns are used for various tests, so don't change.
701 * The "unordered" values are possible results of comparing
702 * floating point numbers.
703 * Note that the encoding is imported, so do NOT change the order.
706 pn_Cmp_False = 0, /**< false */
707 pn_Cmp_Eq = 1, /**< equal */
708 pn_Cmp_Lt = 2, /**< less */
709 pn_Cmp_Le = pn_Cmp_Eq|pn_Cmp_Lt, /**< less or equal */
710 pn_Cmp_Gt = 4, /**< greater */
711 pn_Cmp_Ge = pn_Cmp_Eq|pn_Cmp_Gt, /**< greater or equal */
712 pn_Cmp_Lg = pn_Cmp_Lt|pn_Cmp_Gt, /**< less or greater */
713 pn_Cmp_Leg = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
714 pn_Cmp_Uo = 8, /**< unordered */
715 pn_Cmp_Ue = pn_Cmp_Uo|pn_Cmp_Eq, /**< unordered or equal */
716 pn_Cmp_Ul = pn_Cmp_Uo|pn_Cmp_Lt, /**< unordered or less */
717 pn_Cmp_Ule = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
718 pn_Cmp_Ug = pn_Cmp_Uo|pn_Cmp_Gt, /**< unordered or greater */
719 pn_Cmp_Uge = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
720 pn_Cmp_Ne = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
721 pn_Cmp_True = 15 /**< true */
722 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for JNI interface */
723 } pn_Cmp; /* Projection numbers for Cmp */
724 /* #define not_mask pn_Cmp_Leg */
726 /** returns the pnc name from an pnc constant */
727 const char *get_pnc_string(int pnc);
729 /** Calculates the negated (Complement(R)) pnc condition. */
730 int get_negated_pnc(int pnc, ir_mode *mode);
732 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
733 int get_inversed_pnc(int pnc);
735 ir_node *get_Cmp_left (ir_node *node);
736 void set_Cmp_left (ir_node *node, ir_node *left);
737 ir_node *get_Cmp_right (ir_node *node);
738 void set_Cmp_right (ir_node *node, ir_node *right);
740 ir_node *get_Shl_left (ir_node *node);
741 void set_Shl_left (ir_node *node, ir_node *left);
742 ir_node *get_Shl_right (ir_node *node);
743 void set_Shl_right (ir_node *node, ir_node *right);
745 ir_node *get_Shr_left (ir_node *node);
746 void set_Shr_left (ir_node *node, ir_node *left);
747 ir_node *get_Shr_right (ir_node *node);
748 void set_Shr_right (ir_node *node, ir_node *right);
750 ir_node *get_Shrs_left (ir_node *node);
751 void set_Shrs_left (ir_node *node, ir_node *left);
752 ir_node *get_Shrs_right (ir_node *node);
753 void set_Shrs_right (ir_node *node, ir_node *right);
755 ir_node *get_Rot_left (ir_node *node);
756 void set_Rot_left (ir_node *node, ir_node *left);
757 ir_node *get_Rot_right (ir_node *node);
758 void set_Rot_right (ir_node *node, ir_node *right);
760 ir_node *get_Conv_op (ir_node *node);
761 void set_Conv_op (ir_node *node, ir_node *op);
763 /* Does Cast need a mem operator?
764 * Cast should only depend on the type, not on the state of an
765 * entity. But: we initialize various fields after Alloc, that
766 * are accessed in the cast. This required some precaution, to
767 * get the right memory into the Loads generated from the cast.
769 ir_node *get_Cast_op (ir_node *node);
770 void set_Cast_op (ir_node *node, ir_node *op);
771 ir_type *get_Cast_type (ir_node *node);
772 void set_Cast_type (ir_node *node, ir_type *to_tp);
774 /** Checks for upcast.
776 * Returns true if the Cast node casts a class type to a super type.
777 * Works also for pointers to classes (recursively).
779 int is_Cast_upcast(ir_node *node);
781 /** Checks for downcast.
783 * Returns true if the Cast node casts a class type to a sub type.
784 * Works also for pointers to classes (recursively).
786 int is_Cast_downcast(ir_node *node);
789 /** Returns true if n is Phi or Filter in interprocedural_view.
790 Returns false if irg in phase building and the Phi has zero
791 predecessors: it's a Phi0. */
792 int is_Phi (const ir_node *n);
793 /** Returns true if irg in phase building and the Phi has zero
794 predecessors: it's a Phi0. */
795 int is_Phi0 (const ir_node *n);
796 /* These routines also work for Filter nodes in interprocedural view. */
797 ir_node **get_Phi_preds_arr (ir_node *node);
798 int get_Phi_n_preds (ir_node *node);
799 ir_node *get_Phi_pred (ir_node *node, int pos);
800 void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
802 ir_node *get_Filter_pred(ir_node *node);
803 void set_Filter_pred(ir_node *node, ir_node *pred);
804 long get_Filter_proj(ir_node *node);
805 void set_Filter_proj(ir_node *node, long proj);
806 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
807 * @@@ Maybe better: arity is zero if no cg preds. */
808 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
809 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
810 int get_Filter_n_cg_preds(ir_node *node);
811 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
813 /** Return true if parameter is a memory operation.
815 * A memory operation is an operation that changes the
816 * memory. I.e., a Load or a Store operation.
818 int is_memop(ir_node *node);
819 ir_node *get_memop_mem (ir_node *node);
820 void set_memop_mem (ir_node *node, ir_node *mem);
821 ir_node *get_memop_ptr (ir_node *node);
822 void set_memop_ptr (ir_node *node, ir_node *ptr);
825 * Projection numbers for Load: use for Proj nodes!
828 pn_Load_M, /**< Memory result. */
829 pn_Load_X_except, /**< Execution result if exception occurred. */
830 pn_Load_res, /**< Result of load operation. */
831 pn_Load_max /**< number of projections from a Load */
832 } pn_Load; /* Projection numbers for Load. */
834 ir_node *get_Load_mem (ir_node *node);
835 void set_Load_mem (ir_node *node, ir_node *mem);
836 ir_node *get_Load_ptr (ir_node *node);
837 void set_Load_ptr (ir_node *node, ir_node *ptr);
838 ir_mode *get_Load_mode (ir_node *node);
839 void set_Load_mode (ir_node *node, ir_mode *mode);
840 ent_volatility get_Load_volatility (ir_node *node);
841 void set_Load_volatility (ir_node *node, ent_volatility volatility);
844 * Projection numbers for Store: use for Proj nodes!
847 pn_Store_M, /**< Memory result. */
848 pn_Store_X_except, /**< Execution result if exception occurred. */
849 pn_Store_max /**< number of projections from a Store */
850 } pn_Store; /* Projection numbers for Store. */
852 ir_node *get_Store_mem (ir_node *node);
853 void set_Store_mem (ir_node *node, ir_node *mem);
854 ir_node *get_Store_ptr (ir_node *node);
855 void set_Store_ptr (ir_node *node, ir_node *ptr);
856 ir_node *get_Store_value (ir_node *node);
857 void set_Store_value (ir_node *node, ir_node *value);
858 ent_volatility get_Store_volatility (ir_node *node);
859 void set_Store_volatility (ir_node *node, ent_volatility volatility);
862 * Projection numbers for Alloc: use for Proj nodes!
865 pn_Alloc_M, /**< Memory result. */
866 pn_Alloc_X_except, /**< Execution result if exception occurred. */
867 pn_Alloc_res, /**< Result of allocation. */
868 pn_Alloc_max /**< number of projections from an Alloc */
869 } pn_Alloc; /* Projection numbers for Alloc. */
871 ir_node *get_Alloc_mem (ir_node *node);
872 void set_Alloc_mem (ir_node *node, ir_node *mem);
873 ir_node *get_Alloc_size (ir_node *node);
874 void set_Alloc_size (ir_node *node, ir_node *size);
875 ir_type *get_Alloc_type (ir_node *node);
876 void set_Alloc_type (ir_node *node, ir_type *tp);
878 /** The allocation place. */
880 stack_alloc, /**< Alloc allocates the object on the stack. */
881 heap_alloc /**< Alloc allocates the object on the heap. */
884 where_alloc get_Alloc_where (ir_node *node);
885 void set_Alloc_where (ir_node *node, where_alloc where);
887 ir_node *get_Free_mem (ir_node *node);
888 void set_Free_mem (ir_node *node, ir_node *mem);
889 ir_node *get_Free_ptr (ir_node *node);
890 void set_Free_ptr (ir_node *node, ir_node *ptr);
891 ir_node *get_Free_size (ir_node *node);
892 void set_Free_size (ir_node *node, ir_node *size);
893 ir_type *get_Free_type (ir_node *node);
894 void set_Free_type (ir_node *node, ir_type *tp);
896 where_alloc get_Free_where (ir_node *node);
897 void set_Free_where (ir_node *node, where_alloc where);
899 ir_node **get_Sync_preds_arr (ir_node *node);
900 int get_Sync_n_preds (ir_node *node);
901 ir_node *get_Sync_pred (ir_node *node, int pos);
902 void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
903 void add_Sync_pred (ir_node *node, ir_node *pred);
905 /** Returns the source language type of a Proj node.
906 * Must be an atomic type. Mode of type must be mode of node.
908 ir_type *get_Proj_type (ir_node *node);
910 /** Return the predecessor of a Proj node. */
911 ir_node *get_Proj_pred (const ir_node *node);
912 void set_Proj_pred (ir_node *node, ir_node *pred);
913 /** Return the projection number of a Proj node. */
914 long get_Proj_proj (const ir_node *node);
915 void set_Proj_proj (ir_node *node, long proj);
917 ir_node **get_Tuple_preds_arr (ir_node *node);
918 int get_Tuple_n_preds (ir_node *node);
919 ir_node *get_Tuple_pred (ir_node *node, int pos);
920 void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
922 ir_node *get_Id_pred (ir_node *node);
923 void set_Id_pred (ir_node *node, ir_node *pred);
925 /** Confirm has a single result and returns 'value' unchanged.
926 * The node expresses a restriction on 'value':
927 * 'value' 'cmp' 'bound' == true. */
928 ir_node *get_Confirm_value (ir_node *node);
929 void set_Confirm_value (ir_node *node, ir_node *value);
930 ir_node *get_Confirm_bound (ir_node *node);
931 void set_Confirm_bound (ir_node *node, ir_node *bound);
932 pn_Cmp get_Confirm_cmp (ir_node *node);
933 void set_Confirm_cmp (ir_node *node, pn_Cmp cmp);
936 * Mux Support: Note that Psi nodes with one condition can be handled
937 * like Mux nodes, and the access functions work as expected.
939 ir_node *get_Mux_sel (ir_node *node);
940 void set_Mux_sel (ir_node *node, ir_node *sel);
941 ir_node *get_Mux_false (ir_node *node);
942 void set_Mux_false (ir_node *node, ir_node *ir_false);
943 ir_node *get_Mux_true (ir_node *node);
944 void set_Mux_true (ir_node *node, ir_node *ir_true);
946 ir_node *get_Psi_cond (ir_node *node, int pos);
947 void set_Psi_cond (ir_node *node, int pos, ir_node *cond);
948 ir_node *get_Psi_val (ir_node *node, int pos);
949 void set_Psi_val (ir_node *node, int pos, ir_node *val);
950 ir_node *get_Psi_default(ir_node *node);
951 void set_Psi_default(ir_node *node, ir_node *val);
952 int get_Psi_n_conds(ir_node *node);
955 * Projection numbers for result of CopyB node: use for Proj nodes!
958 pn_CopyB_M_regular = 0, /**< The memory result. */
959 pn_CopyB_X_except = 1, /**< The control flow result branching to the exception handler */
960 pn_CopyB_M_except = 2, /**< The memory result in case the runtime function terminated with
962 pn_CopyB_max = 3 /**< number of projections from a CopyB */
963 } pn_CopyB; /* Projection numbers for CopyB. */
964 #define pn_CopyB_M pn_CopyB_M_regular
966 ir_node *get_CopyB_mem (ir_node *node);
967 void set_CopyB_mem (ir_node *node, ir_node *mem);
968 ir_node *get_CopyB_dst (ir_node *node);
969 void set_CopyB_dst (ir_node *node, ir_node *dst);
970 ir_node *get_CopyB_src (ir_node *node);
971 void set_CopyB_src (ir_node *node, ir_node *src);
972 ir_type *get_CopyB_type(ir_node *node);
973 void set_CopyB_type(ir_node *node, ir_type *data_type);
976 * Projection numbers for result of InstOf node: use for Proj nodes!
979 pn_InstOf_M_regular = 0, /**< The memory result. */
980 pn_InstOf_X_except = 1, /**< The control flow result branching to the exception handler */
981 pn_InstOf_res = 2, /**< The checked object pointer. */
982 pn_InstOf_M_except = 3, /**< The memory result in case the runtime function terminated with
984 pn_InstOf_max = 4 /**< number of projections from an InstOf */
986 #define pn_InstOf_M pn_InstOf_M_regular
989 ir_type *get_InstOf_type (ir_node *node);
990 void set_InstOf_type (ir_node *node, ir_type *type);
991 ir_node *get_InstOf_store (ir_node *node);
992 void set_InstOf_store (ir_node *node, ir_node *obj);
993 ir_node *get_InstOf_obj (ir_node *node);
994 void set_InstOf_obj (ir_node *node, ir_node *obj);
997 * Projection numbers for Raise.
1000 pn_Raise_X = 0, /**< The control flow to the exception handler. */
1001 pn_Raise_M = 1, /**< The Memory result. */
1002 pn_Raise_max /**< number of projections from a Raise */
1003 } pn_Raise; /* Projection numbers for Raise. */
1005 ir_node *get_Raise_mem (ir_node *node);
1006 void set_Raise_mem (ir_node *node, ir_node *mem);
1007 ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
1008 void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
1011 * Projection numbers for result of Bound node: use for Proj nodes!
1014 pn_Bound_M_regular = 0, /**< The memory result. */
1015 pn_Bound_X_except = 1, /**< The control flow result branching to the exception handler */
1016 pn_Bound_res = 2, /**< The checked index. */
1017 pn_Bound_M_except = 3, /**< The memory result in case the runtime function terminated with
1019 pn_Bound_max = 4 /**< number of projections from a Bound */
1021 #define pn_Bound_M pn_Bound_M_regular
1023 /** Returns the memory input of a Bound operation. */
1024 ir_node *get_Bound_mem(ir_node *bound);
1025 void set_Bound_mem (ir_node *bound, ir_node *mem);
1027 /** Returns the index input of a Bound operation. */
1028 ir_node *get_Bound_index(ir_node *bound);
1029 void set_Bound_index(ir_node *bound, ir_node *idx);
1031 /** Returns the lower bound input of a Bound operation. */
1032 ir_node *get_Bound_lower(ir_node *bound);
1033 void set_Bound_lower(ir_node *bound, ir_node *lower);
1035 /** Returns the upper bound input of a Bound operation. */
1036 ir_node *get_Bound_upper(ir_node *bound);
1037 void set_Bound_upper(ir_node *bound, ir_node *upper);
1041 * NAME Auxiliary routines
1043 * Not properly documented ;-)
1047 /** returns operand of node if node is a Proj. */
1048 ir_node *skip_Proj (ir_node *node);
1049 /** returns operand of node if node is a Id */
1050 ir_node *skip_Id (ir_node *node); /* Old name is skip_nop(). */
1051 /** returns corresponding operand of Tuple if node is a Proj from
1053 ir_node *skip_Tuple (ir_node *node);
1054 /** returns operand of node if node is a Cast */
1055 ir_node *skip_Cast (ir_node *node);
1056 /** returns operand of node if node is a Confirm */
1057 ir_node *skip_Confirm (ir_node *node);
1058 /** Skip all high-level Operations. */
1059 ir_node *skip_HighLevel(ir_node *node);
1060 /** returns true if irn is a Const node. */
1061 int is_Const(const ir_node *node);
1062 /** returns true if node is a Bad node. */
1063 int is_Bad (const ir_node *node);
1064 /** returns true if the node is not a Block */
1065 int is_no_Block (const ir_node *node);
1066 /** returns true if the node is a Block */
1067 int is_Block (const ir_node *node);
1068 /** returns true if node is an Unknown node. */
1069 int is_Unknown (const ir_node *node);
1070 /** returns true if node is a Return node. */
1071 int is_Return (const ir_node *node);
1072 /** returns true if node is a Call node. */
1073 int is_Call (const ir_node *node);
1074 /** returns true if node is a Sel node. */
1075 int is_Sel (const ir_node *node);
1076 /** returns true if node is a Mux node or a Psi with only one condition. */
1077 int is_Mux (const ir_node *node);
1078 /** returns true if node is a Load node. */
1079 int is_Load (const ir_node *node);
1080 /** returns true if node is a Sync node. */
1081 int is_Sync (const ir_node *node);
1082 /** returns true if node is a Confirm node. */
1083 int is_Confirm (const ir_node *node);
1084 /** returns true if node is a Proj node or a Filter node in
1085 * intraprocedural view */
1086 int is_Proj (const ir_node *node);
1087 /** Returns true if the operation manipulates control flow:
1088 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1089 int is_cfop(const ir_node *node);
1091 /** Returns true if the operation manipulates interprocedural control flow:
1092 CallBegin, EndReg, EndExcept */
1093 int is_ip_cfop(const ir_node *node);
1094 /** Returns true if the operation can change the control flow because
1095 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1096 Bad. Raise is not fragile, but a unconditional jump. */
1097 int is_fragile_op(const ir_node *node);
1098 /** Returns the memory operand of fragile operations. */
1099 ir_node *get_fragile_op_mem(ir_node *node);
1101 /** Returns true if the operation is a forking control flow
1102 * operation: Cond. */
1103 int is_irn_forking(const ir_node *node);
1105 /** Return the type associated with the value produced by n
1106 * if the node remarks this type as it is the case for
1107 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1108 ir_type *get_irn_type(ir_node *n);
1110 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1112 ir_type *get_irn_type_attr(ir_node *n);
1114 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1115 entity *get_irn_entity_attr(ir_node *n);
1117 /** Returns non-zero for constant-like nodes. */
1118 int is_irn_constlike(const ir_node *node);
1121 * Returns non-zero for nodes that are allowed to have keep-alives and
1122 * are neither Block nor PhiM.
1124 int is_irn_keep(const ir_node *node);
1127 * Returns non-zero for nodes that are machine operations.
1129 int is_irn_machine_op(const ir_node *node);
1132 * Returns non-zero for nodes that are machine operands.
1134 int is_irn_machine_operand(const ir_node *node);
1137 * Returns non-zero for nodes that have the n'th user machine flag set.
1139 int is_irn_machine_user(const ir_node *node, unsigned n);
1142 * A type to express conditional jump predictions.
1145 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1146 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1147 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1148 } cond_jmp_predicate;
1150 /** Gets the string representation of the jump prediction .*/
1151 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1153 /** Returns the conditional jump prediction of a Cond node. */
1154 cond_jmp_predicate get_Cond_jmp_pred(ir_node *cond);
1156 /** Sets a new conditional jump prediction. */
1157 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1160 * Access custom node data.
1161 * The data must have been registered with
1162 * register_additional_node_data() before.
1163 * @param node The ir node to get the data from.
1164 * @param type The type of the data you registered.
1165 * @param off The value returned by register_additional_node_data().
1166 * @return A pointer of type @p type.
1168 #define get_irn_data(node,type,off) \
1169 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1172 * Get the pointer to the node some custom data belongs to.
1173 * @param data The pointer to the custom data.
1174 * @param off The number as returned by register_additional_node_data().
1175 * @return A pointer to the ir node the custom data belongs to.
1177 #define get_irn_data_base(data,off) \
1178 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1181 * Request additional data to be allocated with an ir node.
1182 * @param size The size of the additional data required.
1183 * @return A positive number, if the operation was successful, which
1184 * must be passed to the access macro get_irn_data(), 0 if the
1185 * registration failed.
1187 unsigned register_additional_node_data(unsigned size);
1190 * Return a pointer to the node attributes.
1191 * Needed for user-defined nodes.
1193 void *get_irn_generic_attr(ir_node *node);
1196 * Returns the unique node index for the node in its graph.
1197 * This index is used to access phase information for this node.
1199 unsigned get_irn_idx(const ir_node *node);
1201 /*-----------------------------------------------------------------*/
1203 /*-----------------------------------------------------------------*/
1206 /** Debug print the node.
1208 * Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
1209 * is set. Else does nothing. */
1210 void dump_irn(ir_node *n);
1216 /* GNU C has the __FUNCTION__ extension */
1217 #define __MYFUNC__ __FUNCTION__
1219 /* use Filename instead */
1220 #define __MYFUNC__ __FILE__
1224 Don't format with "\", firmjni gets problems */
1225 /** Output location */
1226 #define DDM printf("%s(l.%i).\n", __MYFUNC__, __LINE__);
1227 /** Output the firm kind of the node */
1228 #define DDMK(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, print_firm_kind(X), (void *)(X));
1229 /** Output information about a node */
1231 /*#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))*/
1232 int dump_node_opcode(FILE *F, ir_node *n);
1233 #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)
1235 /** Output information about a node and its block */
1236 #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)))
1237 /** Output information about a type */
1238 #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))
1239 /** Output information about an entity */
1240 #define DDME(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
1241 /** Output information about an entity and its type */
1242 #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))
1243 /** Output information about an entity and its owner */
1244 #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))
1245 /** Output information about a graph */
1246 #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))))
1247 /** Output information about an ident */
1248 #define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_id_str(X), (void *)(X))
1249 /** Output information about a mode */
1250 #define DDMM(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
1251 /** Output information about a loop */
1252 #define DDML(X) printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
1253 /** Output information about a tarVal */
1254 #define DDMV(X) printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
1256 /*@}*/ /* end of ir_node group definition */
1263 #endif /* _FIRM_IR_IRNODE_H_ */