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 * Add a artificial dependency to the node.
114 * The dependency is only inserted if it is not there already.
115 * @param node The node.
116 * @param dep The dependency target.
117 * @return The index in the array (get_irn_dep() with that index returns @p dep).
119 int add_irn_dep(ir_node *node, ir_node *dep);
122 * Copy all dependencies from a node to another.
123 * @param tgt The node which sould be enriched.
124 * @param src The node whose dependencies shall be copied.
126 void add_irn_deps(ir_node *tgt, ir_node *src);
129 * Get the length of the dependency array.
130 * @param node The node.
131 * @return The length of the dependency array or 0 if it has not yet been allocated.
133 int get_irn_deps(const ir_node *node);
136 * Get an entry of the dependency array.
137 * @param node The node.
138 * @param pos The position.
139 * @return The node at that position.
141 ir_node *get_irn_dep(const ir_node *node, int pos);
144 * Set an entry of the dependency array.
145 * @param node The node.
146 * @param pos The position.
147 * @param dep The dependency target.
149 void set_irn_dep(ir_node *node, int pos, ir_node *dep);
153 * Get the n-th predecessor of a node in intraprocedural view.
154 * Can be used always if it's know that node is not a split one.
156 ir_node *get_irn_intra_n (const ir_node *node, int n);
159 * Get the n-th predecessor of a node in interprocedural view.
161 ir_node *get_irn_inter_n (const ir_node *node, int n);
163 /** Replace the n-th predecessor of a node with a new one. */
164 void set_irn_n (ir_node *node, int n, ir_node *in);
165 /* Sets the mode struct of node. */
166 void set_irn_mode (ir_node *node, ir_mode *mode);
167 /** Gets the mode struct of a node. */
168 ir_mode *get_irn_mode (const ir_node *node);
169 /** Gets the mode-enum modecode. */
170 modecode get_irn_modecode (const ir_node *node);
171 /** Gets the ident for a string representation of the mode .*/
172 ident *get_irn_modeident (const ir_node *node);
173 /** Gets the string representation of the mode .*/
174 const char *get_irn_modename (const ir_node *node);
175 /** Gets the opcode struct of the node. */
176 ir_op *get_irn_op (const ir_node *node);
177 /** Sets the opcode struct of the node. */
178 void set_irn_op (ir_node *node, ir_op *op);
179 /** Gets the opcode-enum of the node. */
180 opcode get_irn_opcode (const ir_node *node);
181 /** Get the string representation of the opcode. */
182 const char *get_irn_opname (const ir_node *node);
183 /** Get the ident for a string representation of the opcode. */
184 ident *get_irn_opident (const ir_node *node);
185 /** If arg is an argument of the node, returns it's position, -1 otherwise */
186 int get_irn_pred_pos (ir_node *node, ir_node *arg);
187 /** Gets the visited counter of a node. */
188 unsigned long get_irn_visited (const ir_node *node);
189 /** Sets the visited counter of a node. */
190 void set_irn_visited (ir_node *node, unsigned long visited);
191 /** Sets visited to get_irg_visited(current_ir_graph). */
192 void mark_irn_visited (ir_node *node);
193 /** Returns 1 if visited < get_irg_visited(current_ir_graph). */
194 int irn_not_visited (const ir_node *node);
195 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
196 int irn_visited (const ir_node *node);
199 * Sets the link of a node.
200 * Only allowed if the graph is NOT in phase_building.
202 void set_irn_link (ir_node *node, void *link);
204 /** Returns the link of a node. */
205 void *get_irn_link (const ir_node *node);
207 /** Returns the ir_graph this node belongs to. Only valid if irg
208 * is in state op_pin_state_pinned (irg is only stored in the block. */
209 ir_graph *get_irn_irg (const ir_node *node);
211 /** Outputs a unique number for this node if libFIRM is compiled for
212 debugging, (configure with --enable-debug) else returns address
213 of node cast to long. */
214 long get_irn_node_nr (const ir_node *node);
216 /** Returns the pinned state of a node.
218 * Returns whether the node _always_ must be pinned.
219 * I.e., the node is not floating after global cse.
221 * @returns Either state op_pin_state_pinned or op_pin_state_floats.
223 op_pin_state get_irn_pinned (const ir_node *node);
225 /** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
226 void set_irn_pinned(ir_node *node, op_pin_state state);
228 /** Returns whether the node is currently pinned.
230 * If get_irn_pinned returns op_pin_state_floats and the graph the
231 * node belongs to is in state op_poin_state_floats then this function
232 * returns 'floats', else 'pinned'.
234 op_pin_state is_irn_pinned_in_irg (const ir_node *node);
237 * IR node constructor.
238 * Create a new IR node in irg, with an op, mode, arity and
239 * some incoming IR nodes.
240 * This constructor is used in every specific IR node constructor.
242 * @param db Debug info.
243 * @param irg IR-graph on with this new node should be constructed.
244 * @param block The block the new node belongs to
245 * @param op The opcode of the new node.
246 * @param mode The mode of the new node.
247 * @param arity The arity of the new node, <0 if can be changed dynamically.
248 * @param in An array of arity predecessor nodes.
251 new_ir_node (dbg_info *db,
260 * Return the block the node belongs to. This is only
261 * possible for pinned nodes or if the graph is in pinned state.
262 * Otherwise the block may be incorrect. This condition is
263 * now checked by an assertion.
265 * This works for all except Block. It can return Blocks or the Bad node.
267 * To express the difference to access routines that work for all
268 * nodes we use infix "nodes" and do not name this function
269 * get_irn_block(). */
270 ir_node *get_nodes_block (const ir_node *node);
272 /** Sets the Block of a node. */
273 void set_nodes_block (ir_node *node, ir_node *block);
276 * @function get_irn_block()
277 * @see get_nodes_block()
281 * Projection numbers for result of Start node: use for Proj nodes!
284 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
285 pn_Start_M, /**< Projection on the initial memory. */
286 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
287 pn_Start_P_globals, /**< Projection on the pointer to the data segment
288 containing _all_ global entities. Use for
289 position independent data/code access. */
290 pn_Start_P_tls, /**< Projection on the pointer to the thread local store
291 segment containing _all_thread local variables. */
292 pn_Start_T_args, /**< Projection on all arguments. */
293 pn_Start_P_value_arg_base, /**< Pointer to region of compound value arguments as defined by
294 type of this method. */
295 pn_Start_max /**< number of projections from a Start */
296 } pn_Start; /* Projection numbers for Start. */
298 /** Test whether arbitrary node is frame pointer.
300 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
301 * from Start. If so returns frame type, else Null. */
302 ir_type *is_frame_pointer(ir_node *n);
304 /** Test whether arbitrary node is globals pointer.
306 * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
307 * from Start. If so returns global type, else Null. */
308 ir_type *is_globals_pointer(ir_node *n);
310 /** Test whether arbitrary node is tls pointer.
312 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
313 * from Start. If so returns tls type, else Null. */
314 ir_type *is_tls_pointer(ir_node *n);
316 /** Test whether arbitrary node is value arg base.
318 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
319 * from Start. If so returns 1, else 0. */
320 int is_value_arg_pointer(ir_node *n);
323 /* @@@ no more supported */
324 ir_node **get_Block_cfgpred_arr (ir_node *node);
325 int get_Block_n_cfgpreds (const ir_node *node);
326 ir_node *get_Block_cfgpred (ir_node *node, int pos);
327 void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
328 /** Get the predecessor block.
330 * Returns the block corresponding to the predecessor pos of block.
332 * There are several ambiguities we resolve with this function:
333 * - The direct predecessor can be a Proj, which is not pinned.
334 * We walk from the predecessor to the next pinned node
335 * (skip_Proj) and return the block that node is in.
336 * - If we encounter the Bad node, this function does not return
337 * Start, but the Bad node.
339 ir_node *get_Block_cfgpred_block(ir_node *node, int pos);
340 int get_Block_matured (ir_node *node);
341 void set_Block_matured (ir_node *node, int matured);
343 /** A visited flag only for block nodes.
344 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
345 unsigned long get_Block_block_visited (ir_node *node);
346 void set_Block_block_visited (ir_node *node, unsigned long visit);
349 * Marks a block as dead but do not replace it with a Bad node.
350 * Dead blocks are removed in the con
352 ir_node *set_Block_dead(ir_node *block);
353 int is_Block_dead(const ir_node *block);
355 /* For this current_ir_graph must be set. */
356 void mark_Block_block_visited(ir_node *node);
357 int Block_not_block_visited(ir_node *node);
359 /* Set and remove interprocedural predecessors. If the interprocedural
360 * predecessors are removed, the node has the same predecessors in
362 * @@@ Maybe better: arity is zero if no cg preds. */
363 void set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
364 void set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
365 /* @@@ not supported */
366 ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
367 /** Returns the number of interprocedural predecessors. 0 if none. */
368 int get_Block_cg_n_cfgpreds(ir_node * node);
369 /** Return the interprocedural predecessor at position pos. */
370 ir_node *get_Block_cg_cfgpred(ir_node * node, int pos);
371 /* frees the memory. */
372 void remove_Block_cg_cfgpred_arr(ir_node * node);
374 /** returns the extended basic block a block belongs to */
375 ir_extblk *get_Block_extbb(const ir_node *block);
376 /** sets the extended basic block a block belongs to */
377 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
379 /** Return the number of Keep alive node. */
380 int get_End_n_keepalives(ir_node *end);
382 /** Return the Keep alive node a position pos. */
383 ir_node *get_End_keepalive(ir_node *end, int pos);
385 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
386 void add_End_keepalive (ir_node *end, ir_node *ka);
388 /** Set the Keep alive node at position pos. */
389 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
391 /** Set new keep-alives */
392 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
394 /** Some parts of the End node are allocated separately -- their memory
395 is not recovered by dead_node_elimination if a End node is dead.
396 free_End() frees these data structures. */
397 void free_End (ir_node *end);
399 /** Return the target address of an IJmp */
400 ir_node *get_IJmp_target(ir_node *ijmp);
402 /** Sets the target address of an IJmp */
403 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
405 /* We distinguish three kinds of Cond nodes. These can be distinguished
406 by the mode of the selector operand and an internal flag of type cond_kind.
407 First we distinguish binary Conds and switch Conds.
408 A binary Cond has as selector a boolean value. Proj(0) projects the control
409 flow for case "False", Proj(1) the control flow for "True". A binary Cond
410 is recognized by the boolean selector.
411 The switch Cond has as selector an unsigned integer. It produces as result
412 an n+1 Tuple (cf0, ... , cfn) of control flows.
413 We differ two flavors of this Cond. The first, the dense Cond, passes
414 control along output i if the selector value is i, 0 <= i <= n. If the
415 selector value is >n it passes control along output n.
416 The second Cond flavor differences in the treatment of cases not specified in
417 the source program. It magically knows about the existence of Proj nodes.
418 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
419 exists. Else it passes control along output n (even if this Proj does not
420 exist.) This Cond we call "fragmentary". There is a special constructor
421 new_defaultProj that automatically sets the flavor.
422 The two switch flavors are distinguished by a flag of type cond_kind.
423 Default flavor is "dense"
426 dense, /**< Default. Missing Proj nodes are dead control flow. */
427 fragmentary /**< Special. No control flow optimizations allowed. Missing
428 Proj nodes mean default control flow, i.e., Proj(n). */
431 ir_node *get_Cond_selector (ir_node *node);
432 void set_Cond_selector (ir_node *node, ir_node *selector);
433 cond_kind get_Cond_kind (ir_node *node);
434 void set_Cond_kind (ir_node *node, cond_kind kind);
435 long get_Cond_defaultProj (ir_node *node);
438 * Projection numbers for conditions.
441 pn_Cond_false, /**< Control flow if operand is "false". */
442 pn_Cond_true, /**< Control flow if operand is "true". */
443 pn_Cond_max /**< number of projections from a Cond */
444 } pn_Cond; /* Projection numbers for Cond. */
446 ir_node *get_Return_mem (ir_node *node);
447 void set_Return_mem (ir_node *node, ir_node *mem);
448 ir_node **get_Return_res_arr (ir_node *node);
449 int get_Return_n_ress (ir_node *node);
450 ir_node *get_Return_res (ir_node *node, int pos);
451 void set_Return_res (ir_node *node, int pos, ir_node *res);
454 CNST_NULL = 0, /**< The node is a const(0). */
455 CNST_ONE = +1, /**< The node is a const(1). */
456 CNST_ALL_ONE = -1, /**< The node is a const(11111...). */
457 CNST_OTHER = 2, /**< The tarval of the const has another value. */
458 CNST_SYMCONST = 3, /**< The node is symconst. */
459 CNST_NO_CONST = 4 /**< The node is no const at all. */
462 tarval *get_Const_tarval (ir_node *node);
463 void set_Const_tarval (ir_node *node, tarval *con);
466 * Classify a node concerning constant properties.
467 * @param irn A node to check for.
468 * @return Constant properties of that node.
470 cnst_classify_t classify_Const(ir_node *irn);
472 /** Returns the source language type of a Const node.
473 * Must be an atomic type. Mode of type must be mode of node.
475 ir_type *get_Const_type (ir_node *node);
477 /** Sets the source language type of a Const node. */
478 void set_Const_type (ir_node *node, ir_type *tp);
480 /** This enum names the three different kinds of symbolic Constants
481 represented by SymConst. The content of the attribute type_or_id
482 depends on this tag. Use the proper access routine after testing
485 symconst_type_tag, /**< The SymConst is a type tag for the given type.
486 symconst_symbol is type *. */
487 symconst_type_size, /**< The SymConst is the size of the given type.
488 symconst_symbol is type *. */
489 symconst_type_align, /**< The SymConst is the alignment of the given type.
490 symconst_symbol is type *. */
491 symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
492 by the linker. The pointer is represented by a string.
493 symconst_symbol is ident *. */
494 symconst_addr_ent, /**< The SymConst is a symbolic pointer to be filled in
495 by the linker. The pointer is represented by an entity.
496 symconst_symbol is entity *. */
497 symconst_enum_const /**< The SymConst is a enumeration constant of an
501 /** Returns non-zero if s symconst kind has a type attribute */
502 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
504 /** Returns non-zero if s symconst kind has an ident attribute */
505 #define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)
507 /** Returns non-zero if s symconst kind has an entity attribute */
508 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent)
510 /** Returns non-zero if s symconst kind has an enum_const attribute */
511 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
513 /** SymConst attribute.
515 * This union contains the symbolic information represented by the node.
517 typedef union symconst_symbol {
521 ir_enum_const *enum_p;
524 /** Get the kind of the SymConst. */
525 symconst_kind get_SymConst_kind (const ir_node *node);
526 /** Set the kind of the SymConst. */
527 void set_SymConst_kind (ir_node *node, symconst_kind num);
529 /** Only to access SymConst of kind type_tag or size. Else assertion: */
530 ir_type *get_SymConst_type (ir_node *node);
531 void set_SymConst_type (ir_node *node, ir_type *tp);
533 /** Only to access SymConst of kind addr_name. Else assertion: */
534 ident *get_SymConst_name (ir_node *node);
535 void set_SymConst_name (ir_node *node, ident *name);
537 /** Only to access SymConst of kind addr_ent. Else assertion: */
538 entity *get_SymConst_entity (ir_node *node);
539 void set_SymConst_entity (ir_node *node, entity *ent);
541 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
542 ir_enum_const *get_SymConst_enum (ir_node *node);
543 void set_SymConst_enum (ir_node *node, ir_enum_const *ec);
545 /** Sets both: type and ptrinfo. Needed to treat the node independent of
546 its semantics. Does a memcpy for the memory sym points to. */
547 /* write 'union': firmjni then does not create a method... */
548 union symconst_symbol get_SymConst_symbol (ir_node *node);
549 void set_SymConst_symbol (ir_node *node,
550 union symconst_symbol sym);
552 /** Access the type of the value represented by the SymConst.
554 * Example: primitive type int for SymConst size. */
555 ir_type *get_SymConst_value_type (ir_node *node);
556 void set_SymConst_value_type (ir_node *node, ir_type *tp);
558 ir_node *get_Sel_mem (ir_node *node);
559 void set_Sel_mem (ir_node *node, ir_node *mem);
560 ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
561 void set_Sel_ptr (ir_node *node, ir_node *ptr);
562 ir_node **get_Sel_index_arr (ir_node *node);
563 int get_Sel_n_indexs (ir_node *node);
564 ir_node *get_Sel_index (ir_node *node, int pos);
565 void set_Sel_index (ir_node *node, int pos, ir_node *index);
566 entity *get_Sel_entity (ir_node *node); /* entity to select */
567 void set_Sel_entity (ir_node *node, entity *ent);
570 * Projection numbers for result of Call node: use for Proj nodes!
573 pn_Call_M_regular = 0, /**< The memory result. */
574 pn_Call_T_result = 2, /**< The tuple containing all (0, 1, 2, ...) results */
575 pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
576 passed by value (for compound result types). */
577 pn_Call_X_except = 1, /**< The control flow result branching to the exception handler */
578 pn_Call_M_except = 3, /**< The memory result in case the called method terminated with
580 pn_Call_max = 5 /**< number of projections from a Call */
581 } pn_Call; /* Projection numbers for Call. */
582 #define pn_Call_M pn_Call_M_regular
584 ir_node *get_Call_mem (ir_node *node);
585 void set_Call_mem (ir_node *node, ir_node *mem);
586 ir_node *get_Call_ptr (ir_node *node);
587 void set_Call_ptr (ir_node *node, ir_node *ptr);
588 ir_node **get_Call_param_arr (ir_node *node);
589 /** Gets the number of parameters of a call. */
590 int get_Call_n_params (ir_node *node);
591 /** Gets the call parameter at position pos. */
592 ir_node *get_Call_param (ir_node *node, int pos);
593 /** Sets the call parameter at position pos. */
594 void set_Call_param (ir_node *node, int pos, ir_node *param);
595 /** Gets the type of a call. */
596 ir_type *get_Call_type (ir_node *node);
597 /** Sets the type of a call. */
598 void set_Call_type (ir_node *node, ir_type *tp);
599 /** Gets the arity of a call. Identical to get_Call_n_params(). */
600 int get_Call_arity (ir_node *node);
602 /** Set, get and remove the callee information for a Call node.
604 * The callee information lists all method entities that can be called
605 * from this node. If the address expression can not be analyzed fully,
606 * e.g., as entities can be called that are not in the compilation unit,
607 * the array contains the unknown_entity. The array contains only entities
608 * with peculiarity_existent, but with all kinds of visibility. The entities
609 * not necessarily contain an irg.
611 * The array is only accessible if callee information is valid. See flag
614 * The memory allocated for the array is managed automatically, i.e., it must
615 * not be freed if the Call node is removed from the graph.
617 * @param node A Call node.
619 int Call_has_callees (ir_node *node);
620 int get_Call_n_callees (ir_node *node);
621 entity *get_Call_callee (ir_node *node, int pos);
623 /** Set the full callee array.
625 * The passed array is copied. Assumes current_ir_graph set properly! */
626 void set_Call_callee_arr (ir_node *node, const int n, entity **arr);
627 void remove_Call_callee_arr(ir_node *node);
629 ir_node *get_CallBegin_ptr (ir_node *node);
630 void set_CallBegin_ptr (ir_node *node, ir_node *ptr);
631 ir_node *get_CallBegin_call (ir_node *node);
632 void set_CallBegin_call (ir_node *node, ir_node *call);
634 /* For unary and binary arithmetic operations the access to the
635 operands can be factored out. Left is the first, right the
636 second arithmetic value as listed in tech report 1999-44.
637 unops are: Minus, Abs, Not, Conv, Cast
638 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
639 Shr, Shrs, Rot, Cmp */
640 int is_unop (const ir_node *node);
641 ir_node *get_unop_op (ir_node *node);
642 void set_unop_op (ir_node *node, ir_node *op);
643 int is_binop (const ir_node *node);
644 ir_node *get_binop_left (ir_node *node);
645 void set_binop_left (ir_node *node, ir_node *left);
646 ir_node *get_binop_right (ir_node *node);
647 void set_binop_right (ir_node *node, ir_node *right);
649 ir_node *get_Add_left (ir_node *node);
650 void set_Add_left (ir_node *node, ir_node *left);
651 ir_node *get_Add_right (ir_node *node);
652 void set_Add_right (ir_node *node, ir_node *right);
654 ir_node *get_Sub_left (ir_node *node);
655 void set_Sub_left (ir_node *node, ir_node *left);
656 ir_node *get_Sub_right (ir_node *node);
657 void set_Sub_right (ir_node *node, ir_node *right);
659 ir_node *get_Minus_op (ir_node *node);
660 void set_Minus_op (ir_node *node, ir_node *op);
662 ir_node *get_Mul_left (ir_node *node);
663 void set_Mul_left (ir_node *node, ir_node *left);
664 ir_node *get_Mul_right (ir_node *node);
665 void set_Mul_right (ir_node *node, ir_node *right);
667 ir_node *get_Quot_left (ir_node *node);
668 void set_Quot_left (ir_node *node, ir_node *left);
669 ir_node *get_Quot_right (ir_node *node);
670 void set_Quot_right (ir_node *node, ir_node *right);
671 ir_node *get_Quot_mem (ir_node *node);
672 void set_Quot_mem (ir_node *node, ir_node *mem);
675 * Projection numbers for Quot: use for Proj nodes!
678 pn_Quot_M, /**< Memory result. */
679 pn_Quot_X_except, /**< Execution result if exception occurred. */
680 pn_Quot_res, /**< Result of computation. */
681 pn_Quot_max /**< number of projections from a Quot */
682 } pn_Quot; /* Projection numbers for Quot. */
684 ir_node *get_DivMod_left (ir_node *node);
685 void set_DivMod_left (ir_node *node, ir_node *left);
686 ir_node *get_DivMod_right (ir_node *node);
687 void set_DivMod_right (ir_node *node, ir_node *right);
688 ir_node *get_DivMod_mem (ir_node *node);
689 void set_DivMod_mem (ir_node *node, ir_node *mem);
692 * Projection numbers for DivMod: use for Proj nodes!
695 pn_DivMod_M, /**< Memory result. */
696 pn_DivMod_X_except, /**< Execution result if exception occurred. */
697 pn_DivMod_res_div, /**< Result of computation a / b. */
698 pn_DivMod_res_mod, /**< Result of computation a % b. */
699 pn_DivMod_max /**< number of projections from a DivMod */
700 } pn_DivMod; /* Projection numbers for DivMod. */
702 ir_node *get_Div_left (ir_node *node);
703 void set_Div_left (ir_node *node, ir_node *left);
704 ir_node *get_Div_right (ir_node *node);
705 void set_Div_right (ir_node *node, ir_node *right);
706 ir_node *get_Div_mem (ir_node *node);
707 void set_Div_mem (ir_node *node, ir_node *mem);
710 * Projection numbers for Div: use for Proj nodes!
713 pn_Div_M, /**< Memory result. */
714 pn_Div_X_except, /**< Execution result if exception occurred. */
715 pn_Div_res, /**< Result of computation. */
716 pn_Div_max /**< number of projections from a Div */
717 } pn_Div; /* Projection numbers for Div. */
719 ir_node *get_Mod_left (ir_node *node);
720 void set_Mod_left (ir_node *node, ir_node *left);
721 ir_node *get_Mod_right (ir_node *node);
722 void set_Mod_right (ir_node *node, ir_node *right);
723 ir_node *get_Mod_mem (ir_node *node);
724 void set_Mod_mem (ir_node *node, ir_node *mem);
727 * Projection numbers for Mod: use for Proj nodes!
730 pn_Mod_M, /**< Memory result. */
731 pn_Mod_X_except, /**< Execution result if exception occurred. */
732 pn_Mod_res, /**< Result of computation. */
733 pn_Mod_max /**< number of projections from a Mod */
734 } pn_Mod; /* Projection numbers for Mod. */
736 ir_node *get_Abs_op (ir_node *node);
737 void set_Abs_op (ir_node *node, ir_node *op);
739 ir_node *get_And_left (ir_node *node);
740 void set_And_left (ir_node *node, ir_node *left);
741 ir_node *get_And_right (ir_node *node);
742 void set_And_right (ir_node *node, ir_node *right);
744 ir_node *get_Or_left (ir_node *node);
745 void set_Or_left (ir_node *node, ir_node *left);
746 ir_node *get_Or_right (ir_node *node);
747 void set_Or_right (ir_node *node, ir_node *right);
749 ir_node *get_Eor_left (ir_node *node);
750 void set_Eor_left (ir_node *node, ir_node *left);
751 ir_node *get_Eor_right (ir_node *node);
752 void set_Eor_right (ir_node *node, ir_node *right);
754 ir_node *get_Not_op (ir_node *node);
755 void set_Not_op (ir_node *node, ir_node *op);
758 * Projection numbers for Cmp are defined several times.
759 * The bit patterns are used for various tests, so don't change.
760 * The "unordered" values are possible results of comparing
761 * floating point numbers.
762 * Note that the encoding is imported, so do NOT change the order.
765 pn_Cmp_False = 0, /**< false */
766 pn_Cmp_Eq = 1, /**< equal */
767 pn_Cmp_Lt = 2, /**< less */
768 pn_Cmp_Le = pn_Cmp_Eq|pn_Cmp_Lt, /**< less or equal */
769 pn_Cmp_Gt = 4, /**< greater */
770 pn_Cmp_Ge = pn_Cmp_Eq|pn_Cmp_Gt, /**< greater or equal */
771 pn_Cmp_Lg = pn_Cmp_Lt|pn_Cmp_Gt, /**< less or greater */
772 pn_Cmp_Leg = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
773 pn_Cmp_Uo = 8, /**< unordered */
774 pn_Cmp_Ue = pn_Cmp_Uo|pn_Cmp_Eq, /**< unordered or equal */
775 pn_Cmp_Ul = pn_Cmp_Uo|pn_Cmp_Lt, /**< unordered or less */
776 pn_Cmp_Ule = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
777 pn_Cmp_Ug = pn_Cmp_Uo|pn_Cmp_Gt, /**< unordered or greater */
778 pn_Cmp_Uge = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
779 pn_Cmp_Ne = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
780 pn_Cmp_True = 15 /**< true */
781 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for JNI interface */
782 } pn_Cmp; /* Projection numbers for Cmp */
783 /* #define not_mask pn_Cmp_Leg */
785 /** returns the pnc name from an pnc constant */
786 const char *get_pnc_string(int pnc);
788 /** Calculates the negated (Complement(R)) pnc condition. */
789 int get_negated_pnc(int pnc, ir_mode *mode);
791 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
792 int get_inversed_pnc(int pnc);
794 ir_node *get_Cmp_left (ir_node *node);
795 void set_Cmp_left (ir_node *node, ir_node *left);
796 ir_node *get_Cmp_right (ir_node *node);
797 void set_Cmp_right (ir_node *node, ir_node *right);
799 ir_node *get_Shl_left (ir_node *node);
800 void set_Shl_left (ir_node *node, ir_node *left);
801 ir_node *get_Shl_right (ir_node *node);
802 void set_Shl_right (ir_node *node, ir_node *right);
804 ir_node *get_Shr_left (ir_node *node);
805 void set_Shr_left (ir_node *node, ir_node *left);
806 ir_node *get_Shr_right (ir_node *node);
807 void set_Shr_right (ir_node *node, ir_node *right);
809 ir_node *get_Shrs_left (ir_node *node);
810 void set_Shrs_left (ir_node *node, ir_node *left);
811 ir_node *get_Shrs_right (ir_node *node);
812 void set_Shrs_right (ir_node *node, ir_node *right);
814 ir_node *get_Rot_left (ir_node *node);
815 void set_Rot_left (ir_node *node, ir_node *left);
816 ir_node *get_Rot_right (ir_node *node);
817 void set_Rot_right (ir_node *node, ir_node *right);
819 ir_node *get_Conv_op (ir_node *node);
820 void set_Conv_op (ir_node *node, ir_node *op);
821 int get_Conv_strict (ir_node *node);
822 void set_Conv_strict (ir_node *node, int flag);
824 /* Does Cast need a mem operator?
825 * Cast should only depend on the type, not on the state of an
826 * entity. But: we initialize various fields after Alloc, that
827 * are accessed in the cast. This required some precaution, to
828 * get the right memory into the Loads generated from the cast.
830 ir_node *get_Cast_op (ir_node *node);
831 void set_Cast_op (ir_node *node, ir_node *op);
832 ir_type *get_Cast_type (ir_node *node);
833 void set_Cast_type (ir_node *node, ir_type *to_tp);
835 /** Checks for upcast.
837 * Returns true if the Cast node casts a class type to a super type.
838 * Works also for pointers to classes (recursively).
840 int is_Cast_upcast(ir_node *node);
842 /** Checks for downcast.
844 * Returns true if the Cast node casts a class type to a sub type.
845 * Works also for pointers to classes (recursively).
847 int is_Cast_downcast(ir_node *node);
850 /** Returns true if n is Phi or Filter in interprocedural_view.
851 Returns false if irg in phase building and the Phi has zero
852 predecessors: it's a Phi0. */
853 int is_Phi (const ir_node *n);
854 /** Returns true if irg in phase building and the Phi has zero
855 predecessors: it's a Phi0. */
856 int is_Phi0 (const ir_node *n);
857 /* These routines also work for Filter nodes in interprocedural view. */
858 ir_node **get_Phi_preds_arr (ir_node *node);
859 int get_Phi_n_preds (ir_node *node);
860 ir_node *get_Phi_pred (ir_node *node, int pos);
861 void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
863 ir_node *get_Filter_pred(ir_node *node);
864 void set_Filter_pred(ir_node *node, ir_node *pred);
865 long get_Filter_proj(ir_node *node);
866 void set_Filter_proj(ir_node *node, long proj);
867 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
868 * @@@ Maybe better: arity is zero if no cg preds. */
869 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
870 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
871 int get_Filter_n_cg_preds(ir_node *node);
872 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
874 /** Return true if parameter is a memory operation.
876 * A memory operation is an operation that changes the
877 * memory. I.e., a Load or a Store operation.
879 int is_memop(ir_node *node);
880 ir_node *get_memop_mem (ir_node *node);
881 void set_memop_mem (ir_node *node, ir_node *mem);
882 ir_node *get_memop_ptr (ir_node *node);
883 void set_memop_ptr (ir_node *node, ir_node *ptr);
886 * Projection numbers for Load: use for Proj nodes!
889 pn_Load_M, /**< Memory result. */
890 pn_Load_X_except, /**< Execution result if exception occurred. */
891 pn_Load_res, /**< Result of load operation. */
892 pn_Load_max /**< number of projections from a Load */
893 } pn_Load; /* Projection numbers for Load. */
895 ir_node *get_Load_mem (ir_node *node);
896 void set_Load_mem (ir_node *node, ir_node *mem);
897 ir_node *get_Load_ptr (ir_node *node);
898 void set_Load_ptr (ir_node *node, ir_node *ptr);
899 ir_mode *get_Load_mode (ir_node *node);
900 void set_Load_mode (ir_node *node, ir_mode *mode);
901 ent_volatility get_Load_volatility (ir_node *node);
902 void set_Load_volatility (ir_node *node, ent_volatility volatility);
905 * Projection numbers for Store: use for Proj nodes!
908 pn_Store_M, /**< Memory result. */
909 pn_Store_X_except, /**< Execution result if exception occurred. */
910 pn_Store_max /**< number of projections from a Store */
911 } pn_Store; /* Projection numbers for Store. */
913 ir_node *get_Store_mem (ir_node *node);
914 void set_Store_mem (ir_node *node, ir_node *mem);
915 ir_node *get_Store_ptr (ir_node *node);
916 void set_Store_ptr (ir_node *node, ir_node *ptr);
917 ir_node *get_Store_value (ir_node *node);
918 void set_Store_value (ir_node *node, ir_node *value);
919 ent_volatility get_Store_volatility (ir_node *node);
920 void set_Store_volatility (ir_node *node, ent_volatility volatility);
923 * Projection numbers for Alloc: use for Proj nodes!
926 pn_Alloc_M, /**< Memory result. */
927 pn_Alloc_X_except, /**< Execution result if exception occurred. */
928 pn_Alloc_res, /**< Result of allocation. */
929 pn_Alloc_max /**< number of projections from an Alloc */
930 } pn_Alloc; /* Projection numbers for Alloc. */
932 ir_node *get_Alloc_mem (ir_node *node);
933 void set_Alloc_mem (ir_node *node, ir_node *mem);
934 ir_node *get_Alloc_size (ir_node *node);
935 void set_Alloc_size (ir_node *node, ir_node *size);
936 ir_type *get_Alloc_type (ir_node *node);
937 void set_Alloc_type (ir_node *node, ir_type *tp);
939 /** The allocation place. */
941 stack_alloc, /**< Alloc allocates the object on the stack. */
942 heap_alloc /**< Alloc allocates the object on the heap. */
945 where_alloc get_Alloc_where (ir_node *node);
946 void set_Alloc_where (ir_node *node, where_alloc where);
948 ir_node *get_Free_mem (ir_node *node);
949 void set_Free_mem (ir_node *node, ir_node *mem);
950 ir_node *get_Free_ptr (ir_node *node);
951 void set_Free_ptr (ir_node *node, ir_node *ptr);
952 ir_node *get_Free_size (ir_node *node);
953 void set_Free_size (ir_node *node, ir_node *size);
954 ir_type *get_Free_type (ir_node *node);
955 void set_Free_type (ir_node *node, ir_type *tp);
957 where_alloc get_Free_where (ir_node *node);
958 void set_Free_where (ir_node *node, where_alloc where);
960 ir_node **get_Sync_preds_arr (ir_node *node);
961 int get_Sync_n_preds (ir_node *node);
962 ir_node *get_Sync_pred (ir_node *node, int pos);
963 void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
964 void add_Sync_pred (ir_node *node, ir_node *pred);
966 /** Returns the source language type of a Proj node.
967 * Must be an atomic type. Mode of type must be mode of node.
969 ir_type *get_Proj_type (ir_node *node);
971 /** Return the predecessor of a Proj node. */
972 ir_node *get_Proj_pred (const ir_node *node);
973 void set_Proj_pred (ir_node *node, ir_node *pred);
974 /** Return the projection number of a Proj node. */
975 long get_Proj_proj (const ir_node *node);
976 void set_Proj_proj (ir_node *node, long proj);
978 ir_node **get_Tuple_preds_arr (ir_node *node);
979 int get_Tuple_n_preds (ir_node *node);
980 ir_node *get_Tuple_pred (ir_node *node, int pos);
981 void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
983 ir_node *get_Id_pred (ir_node *node);
984 void set_Id_pred (ir_node *node, ir_node *pred);
986 /** Confirm has a single result and returns 'value' unchanged.
987 * The node expresses a restriction on 'value':
988 * 'value' 'cmp' 'bound' == true. */
989 ir_node *get_Confirm_value (ir_node *node);
990 void set_Confirm_value (ir_node *node, ir_node *value);
991 ir_node *get_Confirm_bound (ir_node *node);
992 void set_Confirm_bound (ir_node *node, ir_node *bound);
993 pn_Cmp get_Confirm_cmp (ir_node *node);
994 void set_Confirm_cmp (ir_node *node, pn_Cmp cmp);
997 * Mux Support: Note that Psi nodes with one condition can be handled
998 * like Mux nodes, and the access functions work as expected.
1000 ir_node *get_Mux_sel (ir_node *node);
1001 void set_Mux_sel (ir_node *node, ir_node *sel);
1002 ir_node *get_Mux_false (ir_node *node);
1003 void set_Mux_false (ir_node *node, ir_node *ir_false);
1004 ir_node *get_Mux_true (ir_node *node);
1005 void set_Mux_true (ir_node *node, ir_node *ir_true);
1007 ir_node *get_Psi_cond (ir_node *node, int pos);
1008 void set_Psi_cond (ir_node *node, int pos, ir_node *cond);
1009 ir_node *get_Psi_val (ir_node *node, int pos);
1010 void set_Psi_val (ir_node *node, int pos, ir_node *val);
1011 ir_node *get_Psi_default(ir_node *node);
1012 void set_Psi_default(ir_node *node, ir_node *val);
1013 int get_Psi_n_conds(ir_node *node);
1016 * Projection numbers for result of CopyB node: use for Proj nodes!
1019 pn_CopyB_M_regular = 0, /**< The memory result. */
1020 pn_CopyB_X_except = 1, /**< The control flow result branching to the exception handler */
1021 pn_CopyB_M_except = 2, /**< The memory result in case the runtime function terminated with
1023 pn_CopyB_max = 3 /**< number of projections from a CopyB */
1024 } pn_CopyB; /* Projection numbers for CopyB. */
1025 #define pn_CopyB_M pn_CopyB_M_regular
1027 ir_node *get_CopyB_mem (ir_node *node);
1028 void set_CopyB_mem (ir_node *node, ir_node *mem);
1029 ir_node *get_CopyB_dst (ir_node *node);
1030 void set_CopyB_dst (ir_node *node, ir_node *dst);
1031 ir_node *get_CopyB_src (ir_node *node);
1032 void set_CopyB_src (ir_node *node, ir_node *src);
1033 ir_type *get_CopyB_type(ir_node *node);
1034 void set_CopyB_type(ir_node *node, ir_type *data_type);
1037 * Projection numbers for result of InstOf node: use for Proj nodes!
1040 pn_InstOf_M_regular = 0, /**< The memory result. */
1041 pn_InstOf_X_except = 1, /**< The control flow result branching to the exception handler */
1042 pn_InstOf_res = 2, /**< The checked object pointer. */
1043 pn_InstOf_M_except = 3, /**< The memory result in case the runtime function terminated with
1045 pn_InstOf_max = 4 /**< number of projections from an InstOf */
1047 #define pn_InstOf_M pn_InstOf_M_regular
1049 /** InstOf access */
1050 ir_type *get_InstOf_type (ir_node *node);
1051 void set_InstOf_type (ir_node *node, ir_type *type);
1052 ir_node *get_InstOf_store (ir_node *node);
1053 void set_InstOf_store (ir_node *node, ir_node *obj);
1054 ir_node *get_InstOf_obj (ir_node *node);
1055 void set_InstOf_obj (ir_node *node, ir_node *obj);
1058 * Projection numbers for Raise.
1061 pn_Raise_X = 0, /**< The control flow to the exception handler. */
1062 pn_Raise_M = 1, /**< The Memory result. */
1063 pn_Raise_max /**< number of projections from a Raise */
1064 } pn_Raise; /* Projection numbers for Raise. */
1066 ir_node *get_Raise_mem (ir_node *node);
1067 void set_Raise_mem (ir_node *node, ir_node *mem);
1068 ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
1069 void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
1072 * Projection numbers for result of Bound node: use for Proj nodes!
1075 pn_Bound_M = 0, /**< The memory result. */
1076 pn_Bound_X_except = 1, /**< The control flow result branching to the exception handler */
1077 pn_Bound_res = 2, /**< The checked index. */
1078 pn_Bound_max = 3 /**< number of projections from a Bound */
1081 /** Returns the memory input of a Bound operation. */
1082 ir_node *get_Bound_mem(ir_node *bound);
1083 void set_Bound_mem (ir_node *bound, ir_node *mem);
1085 /** Returns the index input of a Bound operation. */
1086 ir_node *get_Bound_index(ir_node *bound);
1087 void set_Bound_index(ir_node *bound, ir_node *idx);
1089 /** Returns the lower bound input of a Bound operation. */
1090 ir_node *get_Bound_lower(ir_node *bound);
1091 void set_Bound_lower(ir_node *bound, ir_node *lower);
1093 /** Returns the upper bound input of a Bound operation. */
1094 ir_node *get_Bound_upper(ir_node *bound);
1095 void set_Bound_upper(ir_node *bound, ir_node *upper);
1097 /** Return the operand of a Pin node. */
1098 ir_node *get_Pin_op(ir_node *pin);
1099 void set_Pin_op(ir_node *pin, ir_node *node);
1104 * NAME Auxiliary routines
1106 * Not properly documented ;-)
1110 /** returns operand of node if node is a Proj. */
1111 ir_node *skip_Proj (ir_node *node);
1112 /** returns operand of node if node is a Id */
1113 ir_node *skip_Id (ir_node *node); /* Old name is skip_nop(). */
1114 /** returns corresponding operand of Tuple if node is a Proj from
1116 ir_node *skip_Tuple (ir_node *node);
1117 /** returns operand of node if node is a Cast */
1118 ir_node *skip_Cast (ir_node *node);
1119 /** returns operand of node if node is a Confirm */
1120 ir_node *skip_Confirm (ir_node *node);
1121 /** Skip all high-level Operations. */
1122 ir_node *skip_HighLevel(ir_node *node);
1123 /** returns true if irn is a Const node. */
1124 int is_Const(const ir_node *node);
1125 /** returns true if node is a Bad node. */
1126 int is_Bad (const ir_node *node);
1127 /** returns true if the node is not a Block */
1128 int is_no_Block (const ir_node *node);
1129 /** returns true if the node is a Block */
1130 int is_Block (const ir_node *node);
1131 /** returns true if node is an Unknown node. */
1132 int is_Unknown (const ir_node *node);
1133 /** returns true if node is a Return node. */
1134 int is_Return (const ir_node *node);
1135 /** returns true if node is a Call node. */
1136 int is_Call (const ir_node *node);
1137 /** returns true if node is a Sel node. */
1138 int is_Sel (const ir_node *node);
1139 /** returns true if node is a Mux node or a Psi with only one condition. */
1140 int is_Mux (const ir_node *node);
1141 /** returns true if node is a Load node. */
1142 int is_Load (const ir_node *node);
1143 /** returns true if node is a Sync node. */
1144 int is_Sync (const ir_node *node);
1145 /** returns true if node is a Confirm node. */
1146 int is_Confirm (const ir_node *node);
1147 /** returns true if node is a SymConst node. */
1148 int is_SymConst (const ir_node *node);
1149 /** returns true if node is a Cond node. */
1150 int is_Cond (const ir_node *node);
1151 /** returns true if node is a Cmp node. */
1152 int is_Cmp (const ir_node *node);
1153 /** returns true if node is an Alloc node */
1154 int is_Alloc (const ir_node *node);
1155 /** returns true if node is a Proj node or a Filter node in
1156 * intraprocedural view */
1157 int is_Proj (const ir_node *node);
1158 /** Returns true if the operation manipulates control flow:
1159 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1160 int is_cfop(const ir_node *node);
1162 /** Returns true if the operation manipulates interprocedural control flow:
1163 CallBegin, EndReg, EndExcept */
1164 int is_ip_cfop(const ir_node *node);
1165 /** Returns true if the operation can change the control flow because
1166 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1167 Bad. Raise is not fragile, but a unconditional jump. */
1168 int is_fragile_op(const ir_node *node);
1169 /** Returns the memory operand of fragile operations. */
1170 ir_node *get_fragile_op_mem(ir_node *node);
1172 /** Returns true if the operation is a forking control flow
1173 * operation: Cond. */
1174 int is_irn_forking(const ir_node *node);
1176 /** Return the type associated with the value produced by n
1177 * if the node remarks this type as it is the case for
1178 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1179 ir_type *get_irn_type(ir_node *n);
1181 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1183 ir_type *get_irn_type_attr(ir_node *n);
1185 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1186 entity *get_irn_entity_attr(ir_node *n);
1188 /** Returns non-zero for constant-like nodes. */
1189 int is_irn_constlike(const ir_node *node);
1192 * Returns non-zero for nodes that must be always optimized
1193 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1195 int is_irn_always_opt(const ir_node *node);
1198 * Returns non-zero for nodes that are allowed to have keep-alives and
1199 * are neither Block nor PhiM.
1201 int is_irn_keep(const ir_node *node);
1204 * Returns non-zero for nodes that are machine operations.
1206 int is_irn_machine_op(const ir_node *node);
1209 * Returns non-zero for nodes that are machine operands.
1211 int is_irn_machine_operand(const ir_node *node);
1214 * Returns non-zero for nodes that have the n'th user machine flag set.
1216 int is_irn_machine_user(const ir_node *node, unsigned n);
1219 * A type to express conditional jump predictions.
1222 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1223 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1224 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1225 } cond_jmp_predicate;
1227 /** Gets the string representation of the jump prediction .*/
1228 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1230 /** Returns the conditional jump prediction of a Cond node. */
1231 cond_jmp_predicate get_Cond_jmp_pred(ir_node *cond);
1233 /** Sets a new conditional jump prediction. */
1234 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1237 * Access custom node data.
1238 * The data must have been registered with
1239 * register_additional_node_data() before.
1240 * @param node The ir node to get the data from.
1241 * @param type The type of the data you registered.
1242 * @param off The value returned by register_additional_node_data().
1243 * @return A pointer of type @p type.
1245 #define get_irn_data(node,type,off) \
1246 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1249 * Get the pointer to the node some custom data belongs to.
1250 * @param data The pointer to the custom data.
1251 * @param off The number as returned by register_additional_node_data().
1252 * @return A pointer to the ir node the custom data belongs to.
1254 #define get_irn_data_base(data,off) \
1255 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1258 * Request additional data to be allocated with an ir node.
1259 * @param size The size of the additional data required.
1260 * @return A positive number, if the operation was successful, which
1261 * must be passed to the access macro get_irn_data(), 0 if the
1262 * registration failed.
1264 unsigned register_additional_node_data(unsigned size);
1267 * Return a pointer to the node attributes.
1268 * Needed for user-defined nodes.
1270 void *get_irn_generic_attr(ir_node *node);
1273 * Returns the unique node index for the node in its graph.
1274 * This index is used to access phase information for this node.
1276 unsigned get_irn_idx(const ir_node *node);
1278 /*-----------------------------------------------------------------*/
1280 /*-----------------------------------------------------------------*/
1283 /** Debug print the node.
1285 * Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
1286 * is set. Else does nothing. */
1287 void dump_irn(ir_node *n);
1293 /* GNU C has the __FUNCTION__ extension */
1294 #define __MYFUNC__ __FUNCTION__
1296 /* use Filename instead */
1297 #define __MYFUNC__ __FILE__
1301 Don't format with "\", firmjni gets problems */
1302 /** Output location */
1303 #define DDM printf("%s(l.%i).\n", __MYFUNC__, __LINE__);
1304 /** Output the firm kind of the node */
1305 #define DDMK(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, print_firm_kind(X), (void *)(X));
1306 /** Output information about a node */
1308 /*#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))*/
1309 int dump_node_opcode(FILE *F, ir_node *n);
1310 #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)
1312 /** Output information about a node and its block */
1313 #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)))
1314 /** Output information about a type */
1315 #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))
1316 /** Output information about an entity */
1317 #define DDME(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
1318 /** Output information about an entity and its type */
1319 #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))
1320 /** Output information about an entity and its owner */
1321 #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))
1322 /** Output information about a graph */
1323 #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))))
1324 /** Output information about an ident */
1325 #define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_id_str(X), (void *)(X))
1326 /** Output information about a mode */
1327 #define DDMM(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
1328 /** Output information about a loop */
1329 #define DDML(X) printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
1330 /** Output information about a tarVal */
1331 #define DDMV(X) printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
1333 /*@}*/ /* end of ir_node group definition */
1340 #endif /* _FIRM_IR_IRNODE_H_ */