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, Michael Beck
9 * Copyright: (c) 1998-2006 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 * IR node constructor.
198 * Create a new IR node in irg, with an op, mode, arity and
199 * some incoming IR nodes.
200 * This constructor is used in every specific IR node 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, <0 if can be changed dynamically.
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. Use for
249 position independent data/code access. */
250 pn_Start_P_tls, /**< Projection on the pointer to the thread local store
251 segment containing _all_thread local variables. */
252 pn_Start_T_args, /**< Projection on all arguments. */
253 pn_Start_P_value_arg_base, /**< Pointer to region of compound value arguments as defined by
254 type of this method. */
255 pn_Start_max /**< number of projections from a Start */
256 } pn_Start; /* Projection numbers for Start. */
258 /** Test whether arbitrary node is frame pointer.
260 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
261 * from Start. If so returns frame type, else Null. */
262 ir_type *is_frame_pointer(ir_node *n);
264 /** Test whether arbitrary node is globals pointer.
266 * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
267 * from Start. If so returns global type, else Null. */
268 ir_type *is_globals_pointer(ir_node *n);
270 /** Test whether arbitrary node is tls pointer.
272 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
273 * from Start. If so returns tls type, else Null. */
274 ir_type *is_tls_pointer(ir_node *n);
276 /** Test whether arbitrary node is value arg base.
278 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
279 * from Start. If so returns 1, else 0. */
280 int is_value_arg_pointer(ir_node *n);
283 /* @@@ no more supported */
284 ir_node **get_Block_cfgpred_arr (ir_node *node);
285 int get_Block_n_cfgpreds (const ir_node *node);
286 ir_node *get_Block_cfgpred (ir_node *node, int pos);
287 void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
288 /** Get the predecessor block.
290 * Returns the block corresponding to the predecessor pos of block.
292 * There are several ambiguities we resolve with this function:
293 * - The direct predecessor can be a Proj, which is not pinned.
294 * We walk from the predecessor to the next pinned node
295 * (skip_Proj) and return the block that node is in.
296 * - If we encounter the Bad node, this function does not return
297 * Start, but the Bad node.
299 ir_node *get_Block_cfgpred_block(ir_node *node, int pos);
300 int get_Block_matured (ir_node *node);
301 void set_Block_matured (ir_node *node, int matured);
303 /** A visited flag only for block nodes.
304 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
305 unsigned long get_Block_block_visited (ir_node *node);
306 void set_Block_block_visited (ir_node *node, unsigned long visit);
309 * Marks a block as dead but do not replace it with a Bad node.
310 * Dead blocks are removed in the con
312 ir_node *set_Block_dead(ir_node *block);
313 int is_Block_dead(const ir_node *block);
315 /* For this current_ir_graph must be set. */
316 void mark_Block_block_visited(ir_node *node);
317 int Block_not_block_visited(ir_node *node);
319 /* Set and remove interprocedural predecessors. If the interprocedural
320 * predecessors are removed, the node has the same predecessors in
322 * @@@ Maybe better: arity is zero if no cg preds. */
323 void set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
324 void set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
325 /* @@@ not supported */
326 ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
327 /** Returns the number of interprocedural predecessors. 0 if none. */
328 int get_Block_cg_n_cfgpreds(ir_node * node);
329 /** Return the interprocedural predecessor at position pos. */
330 ir_node *get_Block_cg_cfgpred(ir_node * node, int pos);
331 /* frees the memory. */
332 void remove_Block_cg_cfgpred_arr(ir_node * node);
334 /** returns the extended basic block a block belongs to */
335 ir_extblk *get_Block_extbb(const ir_node *block);
336 /** sets the extended basic block a block belongs to */
337 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
339 /** Return the number of Keep alive node. */
340 int get_End_n_keepalives(ir_node *end);
342 /** Return the Keep alive node a position pos. */
343 ir_node *get_End_keepalive(ir_node *end, int pos);
345 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
346 void add_End_keepalive (ir_node *end, ir_node *ka);
348 /** Set the Keep alive node at position pos. */
349 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
351 /** Set new keep-alives */
352 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
354 /** Some parts of the End node are allocated separately -- their memory
355 is not recovered by dead_node_elimination if a End node is dead.
356 free_End() frees these data structures. */
357 void free_End (ir_node *end);
359 /** Return the target address of an IJmp */
360 ir_node *get_IJmp_target(ir_node *ijmp);
362 /** Sets the target address of an IJmp */
363 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
365 /* We distinguish three kinds of Cond nodes. These can be distinguished
366 by the mode of the selector operand and an internal flag of type cond_kind.
367 First we distinguish binary Conds and switch Conds.
368 A binary Cond has as selector a boolean value. Proj(0) projects the control
369 flow for case "False", Proj(1) the control flow for "True". A binary Cond
370 is recognized by the boolean selector.
371 The switch Cond has as selector an unsigned integer. It produces as result
372 an n+1 Tuple (cf0, ... , cfn) of control flows.
373 We differ two flavors of this Cond. The first, the dense Cond, passes
374 control along output i if the selector value is i, 0 <= i <= n. If the
375 selector value is >n it passes control along output n.
376 The second Cond flavor differences in the treatment of cases not specified in
377 the source program. It magically knows about the existence of Proj nodes.
378 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
379 exists. Else it passes control along output n (even if this Proj does not
380 exist.) This Cond we call "fragmentary". There is a special constructor
381 new_defaultProj that automatically sets the flavor.
382 The two switch flavors are distinguished by a flag of type cond_kind.
383 Default flavor is "dense"
386 dense, /**< Default. Missing Proj nodes are dead control flow. */
387 fragmentary /**< Special. No control flow optimizations allowed. Missing
388 Proj nodes mean default control flow, i.e., Proj(n). */
391 ir_node *get_Cond_selector (ir_node *node);
392 void set_Cond_selector (ir_node *node, ir_node *selector);
393 cond_kind get_Cond_kind (ir_node *node);
394 void set_Cond_kind (ir_node *node, cond_kind kind);
395 long get_Cond_defaultProj (ir_node *node);
398 * Projection numbers for conditions.
401 pn_Cond_false, /**< Control flow if operand is "false". */
402 pn_Cond_true, /**< Control flow if operand is "true". */
403 pn_Cond_max /**< number of projections from a Cond */
404 } pn_Cond; /* Projection numbers for Cond. */
406 ir_node *get_Return_mem (ir_node *node);
407 void set_Return_mem (ir_node *node, ir_node *mem);
408 ir_node **get_Return_res_arr (ir_node *node);
409 int get_Return_n_ress (ir_node *node);
410 ir_node *get_Return_res (ir_node *node, int pos);
411 void set_Return_res (ir_node *node, int pos, ir_node *res);
414 CNST_NULL = 0, /**< The node is a const(0). */
415 CNST_ONE = +1, /**< The node is a const(1). */
416 CNST_ALL_ONE = -1, /**< The node is a const(11111...). */
417 CNST_OTHER = 2, /**< The tarval of the const has another value. */
418 CNST_SYMCONST = 3, /**< The node is symconst. */
419 CNST_NO_CONST = 4 /**< The node is no const at all. */
422 tarval *get_Const_tarval (ir_node *node);
423 void set_Const_tarval (ir_node *node, tarval *con);
426 * Classify a node concerning constant properties.
427 * @param irn A node to check for.
428 * @return Constant properties of that node.
430 cnst_classify_t classify_Const(ir_node *irn);
432 /** Returns the source language type of a Const node.
433 * Must be an atomic type. Mode of type must be mode of node.
435 ir_type *get_Const_type (ir_node *node);
437 /** Sets the source language type of a Const node. */
438 void set_Const_type (ir_node *node, ir_type *tp);
440 /** This enum names the three different kinds of symbolic Constants
441 represented by SymConst. The content of the attribute type_or_id
442 depends on this tag. Use the proper access routine after testing
445 symconst_type_tag, /**< The SymConst is a type tag for the given type.
446 symconst_symbol is type *. */
447 symconst_type_size, /**< The SymConst is the size of the given type.
448 symconst_symbol is type *. */
449 symconst_type_align, /**< The SymConst is the alignment of the given type.
450 symconst_symbol is type *. */
451 symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
452 by the linker. The pointer is represented by a string.
453 symconst_symbol is ident *. */
454 symconst_addr_ent, /**< The SymConst is a symbolic pointer to be filled in
455 by the linker. The pointer is represented by an entity.
456 symconst_symbol is entity *. */
457 symconst_enum_const /**< The SymConst is a enumeration constant of an
461 /** Returns non-zero if s symconst kind has a type attribute */
462 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
464 /** Returns non-zero if s symconst kind has an ident attribute */
465 #define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)
467 /** Returns non-zero if s symconst kind has an entity attribute */
468 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent)
470 /** Returns non-zero if s symconst kind has an enum_const attribute */
471 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
473 /** SymConst attribute.
475 * This union contains the symbolic information represented by the node.
477 typedef union symconst_symbol {
481 ir_enum_const *enum_p;
484 /** Get the kind of the SymConst. */
485 symconst_kind get_SymConst_kind (const ir_node *node);
486 /** Set the kind of the SymConst. */
487 void set_SymConst_kind (ir_node *node, symconst_kind num);
489 /** Only to access SymConst of kind type_tag or size. Else assertion: */
490 ir_type *get_SymConst_type (ir_node *node);
491 void set_SymConst_type (ir_node *node, ir_type *tp);
493 /** Only to access SymConst of kind addr_name. Else assertion: */
494 ident *get_SymConst_name (ir_node *node);
495 void set_SymConst_name (ir_node *node, ident *name);
497 /** Only to access SymConst of kind addr_ent. Else assertion: */
498 entity *get_SymConst_entity (ir_node *node);
499 void set_SymConst_entity (ir_node *node, entity *ent);
501 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
502 ir_enum_const *get_SymConst_enum (ir_node *node);
503 void set_SymConst_enum (ir_node *node, ir_enum_const *ec);
505 /** Sets both: type and ptrinfo. Needed to treat the node independent of
506 its semantics. Does a memcpy for the memory sym points to. */
507 /* write 'union': firmjni then does not create a method... */
508 union symconst_symbol get_SymConst_symbol (ir_node *node);
509 void set_SymConst_symbol (ir_node *node,
510 union symconst_symbol sym);
512 /** Access the type of the value represented by the SymConst.
514 * Example: primitive type int for SymConst size. */
515 ir_type *get_SymConst_value_type (ir_node *node);
516 void set_SymConst_value_type (ir_node *node, ir_type *tp);
518 ir_node *get_Sel_mem (ir_node *node);
519 void set_Sel_mem (ir_node *node, ir_node *mem);
520 ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
521 void set_Sel_ptr (ir_node *node, ir_node *ptr);
522 ir_node **get_Sel_index_arr (ir_node *node);
523 int get_Sel_n_indexs (ir_node *node);
524 ir_node *get_Sel_index (ir_node *node, int pos);
525 void set_Sel_index (ir_node *node, int pos, ir_node *index);
526 entity *get_Sel_entity (ir_node *node); /* entity to select */
527 void set_Sel_entity (ir_node *node, entity *ent);
530 * Projection numbers for result of Call node: use for Proj nodes!
533 pn_Call_M_regular = 0, /**< The memory result. */
534 pn_Call_T_result = 2, /**< The tuple containing all (0, 1, 2, ...) results */
535 pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
536 passed by value (for compound result types). */
537 pn_Call_X_except = 1, /**< The control flow result branching to the exception handler */
538 pn_Call_M_except = 3, /**< The memory result in case the called method terminated with
540 pn_Call_max = 5 /**< number of projections from a Call */
541 } pn_Call; /* Projection numbers for Call. */
542 #define pn_Call_M pn_Call_M_regular
544 ir_node *get_Call_mem (ir_node *node);
545 void set_Call_mem (ir_node *node, ir_node *mem);
546 ir_node *get_Call_ptr (ir_node *node);
547 void set_Call_ptr (ir_node *node, ir_node *ptr);
548 ir_node **get_Call_param_arr (ir_node *node);
549 /** Gets the number of parameters of a call. */
550 int get_Call_n_params (ir_node *node);
551 /** Gets the call parameter at position pos. */
552 ir_node *get_Call_param (ir_node *node, int pos);
553 /** Sets the call parameter at position pos. */
554 void set_Call_param (ir_node *node, int pos, ir_node *param);
555 /** Gets the type of a call. */
556 ir_type *get_Call_type (ir_node *node);
557 /** Sets the type of a call. */
558 void set_Call_type (ir_node *node, ir_type *tp);
559 /** Gets the arity of a call. Identical to get_Call_n_params(). */
560 int get_Call_arity (ir_node *node);
562 /** Set, get and remove the callee information for a Call node.
564 * The callee information lists all method entities that can be called
565 * from this node. If the address expression can not be analyzed fully,
566 * e.g., as entities can be called that are not in the compilation unit,
567 * the array contains the unknown_entity. The array contains only entities
568 * with peculiarity_existent, but with all kinds of visibility. The entities
569 * not necessarily contain an irg.
571 * The array is only accessible if callee information is valid. See flag
574 * The memory allocated for the array is managed automatically, i.e., it must
575 * not be freed if the Call node is removed from the graph.
577 * @param node A Call node.
579 int Call_has_callees (ir_node *node);
580 int get_Call_n_callees (ir_node *node);
581 entity *get_Call_callee (ir_node *node, int pos);
583 /** Set the full callee array.
585 * The passed array is copied. Assumes current_ir_graph set properly! */
586 void set_Call_callee_arr (ir_node *node, const int n, entity **arr);
587 void remove_Call_callee_arr(ir_node *node);
589 ir_node *get_CallBegin_ptr (ir_node *node);
590 void set_CallBegin_ptr (ir_node *node, ir_node *ptr);
591 ir_node *get_CallBegin_call (ir_node *node);
592 void set_CallBegin_call (ir_node *node, ir_node *call);
594 /* For unary and binary arithmetic operations the access to the
595 operands can be factored out. Left is the first, right the
596 second arithmetic value as listed in tech report 1999-44.
597 unops are: Minus, Abs, Not, Conv, Cast
598 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
599 Shr, Shrs, Rot, Cmp */
600 int is_unop (const ir_node *node);
601 ir_node *get_unop_op (ir_node *node);
602 void set_unop_op (ir_node *node, ir_node *op);
603 int is_binop (const ir_node *node);
604 ir_node *get_binop_left (ir_node *node);
605 void set_binop_left (ir_node *node, ir_node *left);
606 ir_node *get_binop_right (ir_node *node);
607 void set_binop_right (ir_node *node, ir_node *right);
609 ir_node *get_Add_left (ir_node *node);
610 void set_Add_left (ir_node *node, ir_node *left);
611 ir_node *get_Add_right (ir_node *node);
612 void set_Add_right (ir_node *node, ir_node *right);
614 ir_node *get_Sub_left (ir_node *node);
615 void set_Sub_left (ir_node *node, ir_node *left);
616 ir_node *get_Sub_right (ir_node *node);
617 void set_Sub_right (ir_node *node, ir_node *right);
619 ir_node *get_Minus_op (ir_node *node);
620 void set_Minus_op (ir_node *node, ir_node *op);
622 ir_node *get_Mul_left (ir_node *node);
623 void set_Mul_left (ir_node *node, ir_node *left);
624 ir_node *get_Mul_right (ir_node *node);
625 void set_Mul_right (ir_node *node, ir_node *right);
627 ir_node *get_Quot_left (ir_node *node);
628 void set_Quot_left (ir_node *node, ir_node *left);
629 ir_node *get_Quot_right (ir_node *node);
630 void set_Quot_right (ir_node *node, ir_node *right);
631 ir_node *get_Quot_mem (ir_node *node);
632 void set_Quot_mem (ir_node *node, ir_node *mem);
635 * Projection numbers for Quot: use for Proj nodes!
638 pn_Quot_M, /**< Memory result. */
639 pn_Quot_X_except, /**< Execution result if exception occurred. */
640 pn_Quot_res, /**< Result of computation. */
641 pn_Quot_max /**< number of projections from a Quot */
642 } pn_Quot; /* Projection numbers for Quot. */
644 ir_node *get_DivMod_left (ir_node *node);
645 void set_DivMod_left (ir_node *node, ir_node *left);
646 ir_node *get_DivMod_right (ir_node *node);
647 void set_DivMod_right (ir_node *node, ir_node *right);
648 ir_node *get_DivMod_mem (ir_node *node);
649 void set_DivMod_mem (ir_node *node, ir_node *mem);
652 * Projection numbers for DivMod: use for Proj nodes!
655 pn_DivMod_M, /**< Memory result. */
656 pn_DivMod_X_except, /**< Execution result if exception occurred. */
657 pn_DivMod_res_div, /**< Result of computation a / b. */
658 pn_DivMod_res_mod, /**< Result of computation a % b. */
659 pn_DivMod_max /**< number of projections from a DivMod */
660 } pn_DivMod; /* Projection numbers for DivMod. */
662 ir_node *get_Div_left (ir_node *node);
663 void set_Div_left (ir_node *node, ir_node *left);
664 ir_node *get_Div_right (ir_node *node);
665 void set_Div_right (ir_node *node, ir_node *right);
666 ir_node *get_Div_mem (ir_node *node);
667 void set_Div_mem (ir_node *node, ir_node *mem);
670 * Projection numbers for Div: use for Proj nodes!
673 pn_Div_M, /**< Memory result. */
674 pn_Div_X_except, /**< Execution result if exception occurred. */
675 pn_Div_res, /**< Result of computation. */
676 pn_Div_max /**< number of projections from a Div */
677 } pn_Div; /* Projection numbers for Div. */
679 ir_node *get_Mod_left (ir_node *node);
680 void set_Mod_left (ir_node *node, ir_node *left);
681 ir_node *get_Mod_right (ir_node *node);
682 void set_Mod_right (ir_node *node, ir_node *right);
683 ir_node *get_Mod_mem (ir_node *node);
684 void set_Mod_mem (ir_node *node, ir_node *mem);
687 * Projection numbers for Mod: use for Proj nodes!
690 pn_Mod_M, /**< Memory result. */
691 pn_Mod_X_except, /**< Execution result if exception occurred. */
692 pn_Mod_res, /**< Result of computation. */
693 pn_Mod_max /**< number of projections from a Mod */
694 } pn_Mod; /* Projection numbers for Mod. */
696 ir_node *get_Abs_op (ir_node *node);
697 void set_Abs_op (ir_node *node, ir_node *op);
699 ir_node *get_And_left (ir_node *node);
700 void set_And_left (ir_node *node, ir_node *left);
701 ir_node *get_And_right (ir_node *node);
702 void set_And_right (ir_node *node, ir_node *right);
704 ir_node *get_Or_left (ir_node *node);
705 void set_Or_left (ir_node *node, ir_node *left);
706 ir_node *get_Or_right (ir_node *node);
707 void set_Or_right (ir_node *node, ir_node *right);
709 ir_node *get_Eor_left (ir_node *node);
710 void set_Eor_left (ir_node *node, ir_node *left);
711 ir_node *get_Eor_right (ir_node *node);
712 void set_Eor_right (ir_node *node, ir_node *right);
714 ir_node *get_Not_op (ir_node *node);
715 void set_Not_op (ir_node *node, ir_node *op);
718 * Projection numbers for Cmp are defined several times.
719 * The bit patterns are used for various tests, so don't change.
720 * The "unordered" values are possible results of comparing
721 * floating point numbers.
722 * Note that the encoding is imported, so do NOT change the order.
725 pn_Cmp_False = 0, /**< false */
726 pn_Cmp_Eq = 1, /**< equal */
727 pn_Cmp_Lt = 2, /**< less */
728 pn_Cmp_Le = pn_Cmp_Eq|pn_Cmp_Lt, /**< less or equal */
729 pn_Cmp_Gt = 4, /**< greater */
730 pn_Cmp_Ge = pn_Cmp_Eq|pn_Cmp_Gt, /**< greater or equal */
731 pn_Cmp_Lg = pn_Cmp_Lt|pn_Cmp_Gt, /**< less or greater */
732 pn_Cmp_Leg = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
733 pn_Cmp_Uo = 8, /**< unordered */
734 pn_Cmp_Ue = pn_Cmp_Uo|pn_Cmp_Eq, /**< unordered or equal */
735 pn_Cmp_Ul = pn_Cmp_Uo|pn_Cmp_Lt, /**< unordered or less */
736 pn_Cmp_Ule = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
737 pn_Cmp_Ug = pn_Cmp_Uo|pn_Cmp_Gt, /**< unordered or greater */
738 pn_Cmp_Uge = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
739 pn_Cmp_Ne = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
740 pn_Cmp_True = 15 /**< true */
741 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for JNI interface */
742 } pn_Cmp; /* Projection numbers for Cmp */
743 /* #define not_mask pn_Cmp_Leg */
745 /** returns the pnc name from an pnc constant */
746 const char *get_pnc_string(int pnc);
748 /** Calculates the negated (Complement(R)) pnc condition. */
749 int get_negated_pnc(int pnc, ir_mode *mode);
751 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
752 int get_inversed_pnc(int pnc);
754 ir_node *get_Cmp_left (ir_node *node);
755 void set_Cmp_left (ir_node *node, ir_node *left);
756 ir_node *get_Cmp_right (ir_node *node);
757 void set_Cmp_right (ir_node *node, ir_node *right);
759 ir_node *get_Shl_left (ir_node *node);
760 void set_Shl_left (ir_node *node, ir_node *left);
761 ir_node *get_Shl_right (ir_node *node);
762 void set_Shl_right (ir_node *node, ir_node *right);
764 ir_node *get_Shr_left (ir_node *node);
765 void set_Shr_left (ir_node *node, ir_node *left);
766 ir_node *get_Shr_right (ir_node *node);
767 void set_Shr_right (ir_node *node, ir_node *right);
769 ir_node *get_Shrs_left (ir_node *node);
770 void set_Shrs_left (ir_node *node, ir_node *left);
771 ir_node *get_Shrs_right (ir_node *node);
772 void set_Shrs_right (ir_node *node, ir_node *right);
774 ir_node *get_Rot_left (ir_node *node);
775 void set_Rot_left (ir_node *node, ir_node *left);
776 ir_node *get_Rot_right (ir_node *node);
777 void set_Rot_right (ir_node *node, ir_node *right);
779 ir_node *get_Conv_op (ir_node *node);
780 void set_Conv_op (ir_node *node, ir_node *op);
781 int get_Conv_strict (ir_node *node);
782 void set_Conv_strict (ir_node *node, int flag);
784 /* Does Cast need a mem operator?
785 * Cast should only depend on the type, not on the state of an
786 * entity. But: we initialize various fields after Alloc, that
787 * are accessed in the cast. This required some precaution, to
788 * get the right memory into the Loads generated from the cast.
790 ir_node *get_Cast_op (ir_node *node);
791 void set_Cast_op (ir_node *node, ir_node *op);
792 ir_type *get_Cast_type (ir_node *node);
793 void set_Cast_type (ir_node *node, ir_type *to_tp);
795 /** Checks for upcast.
797 * Returns true if the Cast node casts a class type to a super type.
798 * Works also for pointers to classes (recursively).
800 int is_Cast_upcast(ir_node *node);
802 /** Checks for downcast.
804 * Returns true if the Cast node casts a class type to a sub type.
805 * Works also for pointers to classes (recursively).
807 int is_Cast_downcast(ir_node *node);
810 /** Returns true if n is Phi or Filter in interprocedural_view.
811 Returns false if irg in phase building and the Phi has zero
812 predecessors: it's a Phi0. */
813 int is_Phi (const ir_node *n);
814 /** Returns true if irg in phase building and the Phi has zero
815 predecessors: it's a Phi0. */
816 int is_Phi0 (const ir_node *n);
817 /* These routines also work for Filter nodes in interprocedural view. */
818 ir_node **get_Phi_preds_arr (ir_node *node);
819 int get_Phi_n_preds (ir_node *node);
820 ir_node *get_Phi_pred (ir_node *node, int pos);
821 void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
823 ir_node *get_Filter_pred(ir_node *node);
824 void set_Filter_pred(ir_node *node, ir_node *pred);
825 long get_Filter_proj(ir_node *node);
826 void set_Filter_proj(ir_node *node, long proj);
827 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
828 * @@@ Maybe better: arity is zero if no cg preds. */
829 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
830 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
831 int get_Filter_n_cg_preds(ir_node *node);
832 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
834 /** Return true if parameter is a memory operation.
836 * A memory operation is an operation that changes the
837 * memory. I.e., a Load or a Store operation.
839 int is_memop(ir_node *node);
840 ir_node *get_memop_mem (ir_node *node);
841 void set_memop_mem (ir_node *node, ir_node *mem);
842 ir_node *get_memop_ptr (ir_node *node);
843 void set_memop_ptr (ir_node *node, ir_node *ptr);
846 * Projection numbers for Load: use for Proj nodes!
849 pn_Load_M, /**< Memory result. */
850 pn_Load_X_except, /**< Execution result if exception occurred. */
851 pn_Load_res, /**< Result of load operation. */
852 pn_Load_max /**< number of projections from a Load */
853 } pn_Load; /* Projection numbers for Load. */
855 ir_node *get_Load_mem (ir_node *node);
856 void set_Load_mem (ir_node *node, ir_node *mem);
857 ir_node *get_Load_ptr (ir_node *node);
858 void set_Load_ptr (ir_node *node, ir_node *ptr);
859 ir_mode *get_Load_mode (ir_node *node);
860 void set_Load_mode (ir_node *node, ir_mode *mode);
861 ent_volatility get_Load_volatility (ir_node *node);
862 void set_Load_volatility (ir_node *node, ent_volatility volatility);
865 * Projection numbers for Store: use for Proj nodes!
868 pn_Store_M, /**< Memory result. */
869 pn_Store_X_except, /**< Execution result if exception occurred. */
870 pn_Store_max /**< number of projections from a Store */
871 } pn_Store; /* Projection numbers for Store. */
873 ir_node *get_Store_mem (ir_node *node);
874 void set_Store_mem (ir_node *node, ir_node *mem);
875 ir_node *get_Store_ptr (ir_node *node);
876 void set_Store_ptr (ir_node *node, ir_node *ptr);
877 ir_node *get_Store_value (ir_node *node);
878 void set_Store_value (ir_node *node, ir_node *value);
879 ent_volatility get_Store_volatility (ir_node *node);
880 void set_Store_volatility (ir_node *node, ent_volatility volatility);
883 * Projection numbers for Alloc: use for Proj nodes!
886 pn_Alloc_M, /**< Memory result. */
887 pn_Alloc_X_except, /**< Execution result if exception occurred. */
888 pn_Alloc_res, /**< Result of allocation. */
889 pn_Alloc_max /**< number of projections from an Alloc */
890 } pn_Alloc; /* Projection numbers for Alloc. */
892 ir_node *get_Alloc_mem (ir_node *node);
893 void set_Alloc_mem (ir_node *node, ir_node *mem);
894 ir_node *get_Alloc_size (ir_node *node);
895 void set_Alloc_size (ir_node *node, ir_node *size);
896 ir_type *get_Alloc_type (ir_node *node);
897 void set_Alloc_type (ir_node *node, ir_type *tp);
899 /** The allocation place. */
901 stack_alloc, /**< Alloc allocates the object on the stack. */
902 heap_alloc /**< Alloc allocates the object on the heap. */
905 where_alloc get_Alloc_where (ir_node *node);
906 void set_Alloc_where (ir_node *node, where_alloc where);
908 ir_node *get_Free_mem (ir_node *node);
909 void set_Free_mem (ir_node *node, ir_node *mem);
910 ir_node *get_Free_ptr (ir_node *node);
911 void set_Free_ptr (ir_node *node, ir_node *ptr);
912 ir_node *get_Free_size (ir_node *node);
913 void set_Free_size (ir_node *node, ir_node *size);
914 ir_type *get_Free_type (ir_node *node);
915 void set_Free_type (ir_node *node, ir_type *tp);
917 where_alloc get_Free_where (ir_node *node);
918 void set_Free_where (ir_node *node, where_alloc where);
920 ir_node **get_Sync_preds_arr (ir_node *node);
921 int get_Sync_n_preds (ir_node *node);
922 ir_node *get_Sync_pred (ir_node *node, int pos);
923 void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
924 void add_Sync_pred (ir_node *node, ir_node *pred);
926 /** Returns the source language type of a Proj node.
927 * Must be an atomic type. Mode of type must be mode of node.
929 ir_type *get_Proj_type (ir_node *node);
931 /** Return the predecessor of a Proj node. */
932 ir_node *get_Proj_pred (const ir_node *node);
933 void set_Proj_pred (ir_node *node, ir_node *pred);
934 /** Return the projection number of a Proj node. */
935 long get_Proj_proj (const ir_node *node);
936 void set_Proj_proj (ir_node *node, long proj);
938 ir_node **get_Tuple_preds_arr (ir_node *node);
939 int get_Tuple_n_preds (ir_node *node);
940 ir_node *get_Tuple_pred (ir_node *node, int pos);
941 void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
943 ir_node *get_Id_pred (ir_node *node);
944 void set_Id_pred (ir_node *node, ir_node *pred);
946 /** Confirm has a single result and returns 'value' unchanged.
947 * The node expresses a restriction on 'value':
948 * 'value' 'cmp' 'bound' == true. */
949 ir_node *get_Confirm_value (ir_node *node);
950 void set_Confirm_value (ir_node *node, ir_node *value);
951 ir_node *get_Confirm_bound (ir_node *node);
952 void set_Confirm_bound (ir_node *node, ir_node *bound);
953 pn_Cmp get_Confirm_cmp (ir_node *node);
954 void set_Confirm_cmp (ir_node *node, pn_Cmp cmp);
957 * Mux Support: Note that Psi nodes with one condition can be handled
958 * like Mux nodes, and the access functions work as expected.
960 ir_node *get_Mux_sel (ir_node *node);
961 void set_Mux_sel (ir_node *node, ir_node *sel);
962 ir_node *get_Mux_false (ir_node *node);
963 void set_Mux_false (ir_node *node, ir_node *ir_false);
964 ir_node *get_Mux_true (ir_node *node);
965 void set_Mux_true (ir_node *node, ir_node *ir_true);
967 ir_node *get_Psi_cond (ir_node *node, int pos);
968 void set_Psi_cond (ir_node *node, int pos, ir_node *cond);
969 ir_node *get_Psi_val (ir_node *node, int pos);
970 void set_Psi_val (ir_node *node, int pos, ir_node *val);
971 ir_node *get_Psi_default(ir_node *node);
972 void set_Psi_default(ir_node *node, ir_node *val);
973 int get_Psi_n_conds(ir_node *node);
976 * Projection numbers for result of CopyB node: use for Proj nodes!
979 pn_CopyB_M_regular = 0, /**< The memory result. */
980 pn_CopyB_X_except = 1, /**< The control flow result branching to the exception handler */
981 pn_CopyB_M_except = 2, /**< The memory result in case the runtime function terminated with
983 pn_CopyB_max = 3 /**< number of projections from a CopyB */
984 } pn_CopyB; /* Projection numbers for CopyB. */
985 #define pn_CopyB_M pn_CopyB_M_regular
987 ir_node *get_CopyB_mem (ir_node *node);
988 void set_CopyB_mem (ir_node *node, ir_node *mem);
989 ir_node *get_CopyB_dst (ir_node *node);
990 void set_CopyB_dst (ir_node *node, ir_node *dst);
991 ir_node *get_CopyB_src (ir_node *node);
992 void set_CopyB_src (ir_node *node, ir_node *src);
993 ir_type *get_CopyB_type(ir_node *node);
994 void set_CopyB_type(ir_node *node, ir_type *data_type);
997 * Projection numbers for result of InstOf node: use for Proj nodes!
1000 pn_InstOf_M_regular = 0, /**< The memory result. */
1001 pn_InstOf_X_except = 1, /**< The control flow result branching to the exception handler */
1002 pn_InstOf_res = 2, /**< The checked object pointer. */
1003 pn_InstOf_M_except = 3, /**< The memory result in case the runtime function terminated with
1005 pn_InstOf_max = 4 /**< number of projections from an InstOf */
1007 #define pn_InstOf_M pn_InstOf_M_regular
1009 /** InstOf access */
1010 ir_type *get_InstOf_type (ir_node *node);
1011 void set_InstOf_type (ir_node *node, ir_type *type);
1012 ir_node *get_InstOf_store (ir_node *node);
1013 void set_InstOf_store (ir_node *node, ir_node *obj);
1014 ir_node *get_InstOf_obj (ir_node *node);
1015 void set_InstOf_obj (ir_node *node, ir_node *obj);
1018 * Projection numbers for Raise.
1021 pn_Raise_X = 0, /**< The control flow to the exception handler. */
1022 pn_Raise_M = 1, /**< The Memory result. */
1023 pn_Raise_max /**< number of projections from a Raise */
1024 } pn_Raise; /* Projection numbers for Raise. */
1026 ir_node *get_Raise_mem (ir_node *node);
1027 void set_Raise_mem (ir_node *node, ir_node *mem);
1028 ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
1029 void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
1032 * Projection numbers for result of Bound node: use for Proj nodes!
1035 pn_Bound_M = 0, /**< The memory result. */
1036 pn_Bound_X_except = 1, /**< The control flow result branching to the exception handler */
1037 pn_Bound_res = 2, /**< The checked index. */
1038 pn_Bound_max = 3 /**< number of projections from a Bound */
1041 /** Returns the memory input of a Bound operation. */
1042 ir_node *get_Bound_mem(ir_node *bound);
1043 void set_Bound_mem (ir_node *bound, ir_node *mem);
1045 /** Returns the index input of a Bound operation. */
1046 ir_node *get_Bound_index(ir_node *bound);
1047 void set_Bound_index(ir_node *bound, ir_node *idx);
1049 /** Returns the lower bound input of a Bound operation. */
1050 ir_node *get_Bound_lower(ir_node *bound);
1051 void set_Bound_lower(ir_node *bound, ir_node *lower);
1053 /** Returns the upper bound input of a Bound operation. */
1054 ir_node *get_Bound_upper(ir_node *bound);
1055 void set_Bound_upper(ir_node *bound, ir_node *upper);
1057 /** Return the operand of a Pin node. */
1058 ir_node *get_Pin_op(ir_node *pin);
1059 void set_Pin_op(ir_node *pin, ir_node *node);
1064 * NAME Auxiliary routines
1066 * Not properly documented ;-)
1070 /** returns operand of node if node is a Proj. */
1071 ir_node *skip_Proj (ir_node *node);
1072 /** returns operand of node if node is a Id */
1073 ir_node *skip_Id (ir_node *node); /* Old name is skip_nop(). */
1074 /** returns corresponding operand of Tuple if node is a Proj from
1076 ir_node *skip_Tuple (ir_node *node);
1077 /** returns operand of node if node is a Cast */
1078 ir_node *skip_Cast (ir_node *node);
1079 /** returns operand of node if node is a Confirm */
1080 ir_node *skip_Confirm (ir_node *node);
1081 /** Skip all high-level Operations. */
1082 ir_node *skip_HighLevel(ir_node *node);
1083 /** returns true if irn is a Const node. */
1084 int is_Const(const ir_node *node);
1085 /** returns true if node is a Bad node. */
1086 int is_Bad (const ir_node *node);
1087 /** returns true if the node is not a Block */
1088 int is_no_Block (const ir_node *node);
1089 /** returns true if the node is a Block */
1090 int is_Block (const ir_node *node);
1091 /** returns true if node is an Unknown node. */
1092 int is_Unknown (const ir_node *node);
1093 /** returns true if node is a Return node. */
1094 int is_Return (const ir_node *node);
1095 /** returns true if node is a Call node. */
1096 int is_Call (const ir_node *node);
1097 /** returns true if node is a Sel node. */
1098 int is_Sel (const ir_node *node);
1099 /** returns true if node is a Mux node or a Psi with only one condition. */
1100 int is_Mux (const ir_node *node);
1101 /** returns true if node is a Load node. */
1102 int is_Load (const ir_node *node);
1103 /** returns true if node is a Sync node. */
1104 int is_Sync (const ir_node *node);
1105 /** returns true if node is a Confirm node. */
1106 int is_Confirm (const ir_node *node);
1107 /** returns true if node is a SymConst node. */
1108 int is_SymConst (const ir_node *node);
1109 /** returns true if node is a Cond node. */
1110 int is_Cond (const ir_node *node);
1111 /** returns true if node is a Cmp node. */
1112 int is_Cmp (const ir_node *node);
1113 /** returns true if node is a Proj node or a Filter node in
1114 * intraprocedural view */
1115 int is_Proj (const ir_node *node);
1116 /** Returns true if the operation manipulates control flow:
1117 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1118 int is_cfop(const ir_node *node);
1120 /** Returns true if the operation manipulates interprocedural control flow:
1121 CallBegin, EndReg, EndExcept */
1122 int is_ip_cfop(const ir_node *node);
1123 /** Returns true if the operation can change the control flow because
1124 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1125 Bad. Raise is not fragile, but a unconditional jump. */
1126 int is_fragile_op(const ir_node *node);
1127 /** Returns the memory operand of fragile operations. */
1128 ir_node *get_fragile_op_mem(ir_node *node);
1130 /** Returns true if the operation is a forking control flow
1131 * operation: Cond. */
1132 int is_irn_forking(const ir_node *node);
1134 /** Return the type associated with the value produced by n
1135 * if the node remarks this type as it is the case for
1136 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1137 ir_type *get_irn_type(ir_node *n);
1139 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1141 ir_type *get_irn_type_attr(ir_node *n);
1143 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1144 entity *get_irn_entity_attr(ir_node *n);
1146 /** Returns non-zero for constant-like nodes. */
1147 int is_irn_constlike(const ir_node *node);
1150 * Returns non-zero for nodes that must be always optimized
1151 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1153 int is_irn_always_opt(const ir_node *node);
1156 * Returns non-zero for nodes that are allowed to have keep-alives and
1157 * are neither Block nor PhiM.
1159 int is_irn_keep(const ir_node *node);
1162 * Returns non-zero for nodes that are machine operations.
1164 int is_irn_machine_op(const ir_node *node);
1167 * Returns non-zero for nodes that are machine operands.
1169 int is_irn_machine_operand(const ir_node *node);
1172 * Returns non-zero for nodes that have the n'th user machine flag set.
1174 int is_irn_machine_user(const ir_node *node, unsigned n);
1177 * A type to express conditional jump predictions.
1180 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1181 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1182 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1183 } cond_jmp_predicate;
1185 /** Gets the string representation of the jump prediction .*/
1186 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1188 /** Returns the conditional jump prediction of a Cond node. */
1189 cond_jmp_predicate get_Cond_jmp_pred(ir_node *cond);
1191 /** Sets a new conditional jump prediction. */
1192 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1195 * Access custom node data.
1196 * The data must have been registered with
1197 * register_additional_node_data() before.
1198 * @param node The ir node to get the data from.
1199 * @param type The type of the data you registered.
1200 * @param off The value returned by register_additional_node_data().
1201 * @return A pointer of type @p type.
1203 #define get_irn_data(node,type,off) \
1204 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1207 * Get the pointer to the node some custom data belongs to.
1208 * @param data The pointer to the custom data.
1209 * @param off The number as returned by register_additional_node_data().
1210 * @return A pointer to the ir node the custom data belongs to.
1212 #define get_irn_data_base(data,off) \
1213 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1216 * Request additional data to be allocated with an ir node.
1217 * @param size The size of the additional data required.
1218 * @return A positive number, if the operation was successful, which
1219 * must be passed to the access macro get_irn_data(), 0 if the
1220 * registration failed.
1222 unsigned register_additional_node_data(unsigned size);
1225 * Return a pointer to the node attributes.
1226 * Needed for user-defined nodes.
1228 void *get_irn_generic_attr(ir_node *node);
1231 * Returns the unique node index for the node in its graph.
1232 * This index is used to access phase information for this node.
1234 unsigned get_irn_idx(const ir_node *node);
1236 /*-----------------------------------------------------------------*/
1238 /*-----------------------------------------------------------------*/
1241 /** Debug print the node.
1243 * Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
1244 * is set. Else does nothing. */
1245 void dump_irn(ir_node *n);
1251 /* GNU C has the __FUNCTION__ extension */
1252 #define __MYFUNC__ __FUNCTION__
1254 /* use Filename instead */
1255 #define __MYFUNC__ __FILE__
1259 Don't format with "\", firmjni gets problems */
1260 /** Output location */
1261 #define DDM printf("%s(l.%i).\n", __MYFUNC__, __LINE__);
1262 /** Output the firm kind of the node */
1263 #define DDMK(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, print_firm_kind(X), (void *)(X));
1264 /** Output information about a node */
1266 /*#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))*/
1267 int dump_node_opcode(FILE *F, ir_node *n);
1268 #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)
1270 /** Output information about a node and its block */
1271 #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)))
1272 /** Output information about a type */
1273 #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))
1274 /** Output information about an entity */
1275 #define DDME(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
1276 /** Output information about an entity and its type */
1277 #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))
1278 /** Output information about an entity and its owner */
1279 #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))
1280 /** Output information about a graph */
1281 #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))))
1282 /** Output information about an ident */
1283 #define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_id_str(X), (void *)(X))
1284 /** Output information about a mode */
1285 #define DDMM(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
1286 /** Output information about a loop */
1287 #define DDML(X) printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
1288 /** Output information about a tarVal */
1289 #define DDMV(X) printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
1291 /*@}*/ /* end of ir_node group definition */
1298 #endif /* _FIRM_IR_IRNODE_H_ */