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_
17 #include "firm_common.h"
26 * @author Martin Trapp, Christian Schaefer
28 * Declarations of an ir node.
32 * @defgroup ir_node Declarations of an ir node.
34 * The type definition of ir_node is also in irgraph.h to resolve
35 * recursion between irnode.h and irgraph.h
37 * ir_node - a datatype representing a Firm node
39 * The common fields are:
41 * - firm_kind - A firm_kind tag containing k_type. This is useful
42 * for dynamically checking whether a node is a ir_node.
43 * - arity - The number of predecessors in the Firm graph.
44 * - in - A list with the predecessors in the Firm graph. There are
45 * routines to access individual elements and to obtain the
46 * array. The method returning the array should not be used.
47 * - mode - The mode of the node. There are routines to get the mode
48 * but also to access the mode's fields directly.
49 * - opcode - The opcode of the node. There are routines to get the opcode
50 * but also to access the opcode's fields directly.
51 * - node_nr - A unique number for the node. Available only if debugging
56 #ifndef _IR_NODE_TYPEDEF_
57 #define _IR_NODE_TYPEDEF_
58 typedef struct ir_node ir_node;
66 * you can work on the graph without considering the different types
67 * of nodes, it's just a big graph.
71 * Checks whether a pointer points to a ir node.
73 * @param thing an arbitrary pointer
74 * @return non-zero if the thing is a ir mode, else zero
76 int is_ir_node (const void *thing);
79 * Returns the number of predecessors without the block predecessor.
81 * @param node the IR-node
83 int get_irn_arity (const ir_node *node);
84 int get_irn_intra_arity(const ir_node *node);
85 int get_irn_inter_arity(const ir_node *node);
87 /** Replaces the old in array by a new one that will contain the ins given in
88 the parameters. Conserves the block predecessor. It copies the array passed.
89 This function is necessary to adjust in arrays of blocks, calls and phis.
90 Assumes that current_ir_graph is set to the graph containing "node".
91 "in" must contain all predecessors except the block that are required for
93 void set_irn_in(ir_node *node, int arity, ir_node *in[]);
95 /* to iterate through the predecessors without touching the array. No
96 order of predecessors guaranteed.
97 To iterate over the operands iterate from 0 to i < get_irn_arity(),
98 to iterate including the Block predecessor iterate from i = -1 to
100 /* Access predecessor n */
103 * Get the n-th predecessor of a node.
104 * This function removes Id predecessors.
105 * This function automatically handles intra- and interprocedural views.
107 ir_node *get_irn_n(const ir_node *node, int n);
110 * Add a artificial dependency to the node.
111 * The dependency is only inserted if it is not there already.
112 * @param node The node.
113 * @param dep The dependency target.
114 * @return The index in the array (get_irn_dep() with that index returns @p dep).
116 int add_irn_dep(ir_node *node, ir_node *dep);
119 * Copy all dependencies from a node to another.
120 * @param tgt The node which sould be enriched.
121 * @param src The node whose dependencies shall be copied.
123 void add_irn_deps(ir_node *tgt, ir_node *src);
126 * Get the length of the dependency array.
127 * @param node The node.
128 * @return The length of the dependency array or 0 if it has not yet been allocated.
130 int get_irn_deps(const ir_node *node);
133 * Get an entry of the dependency array.
134 * @param node The node.
135 * @param pos The position.
136 * @return The node at that position.
138 ir_node *get_irn_dep(const ir_node *node, int pos);
141 * Set an entry of the dependency array.
142 * @param node The node.
143 * @param pos The position.
144 * @param dep The dependency target.
146 void set_irn_dep(ir_node *node, int pos, ir_node *dep);
150 * Get the n-th predecessor of a node in intraprocedural view.
151 * Can be used always if it's know that node is not a split one.
153 ir_node *get_irn_intra_n(const ir_node *node, int n);
156 * Get the n-th predecessor of a node in interprocedural view.
158 ir_node *get_irn_inter_n(const ir_node *node, int n);
160 /** Replace the n-th predecessor of a node with a new one. */
161 void set_irn_n(ir_node *node, int n, ir_node *in);
163 * Appends a new predecessor to a node. This only works for nodes with
165 * @returns the number of the new input
167 int add_irn_n(ir_node *node, ir_node *in);
168 /* Sets the mode struct of node. */
169 void set_irn_mode(ir_node *node, ir_mode *mode);
170 /** Gets the mode struct of a node. */
171 ir_mode *get_irn_mode(const ir_node *node);
172 /** Gets the mode-enum modecode. */
173 modecode get_irn_modecode(const ir_node *node);
174 /** Gets the ident for a string representation of the mode .*/
175 ident *get_irn_modeident(const ir_node *node);
176 /** Gets the string representation of the mode .*/
177 const char *get_irn_modename(const ir_node *node);
178 /** Gets the opcode struct of the node. */
179 ir_op *get_irn_op(const ir_node *node);
180 /** Sets the opcode struct of the node. */
181 void set_irn_op(ir_node *node, ir_op *op);
182 /** Gets the opcode-enum of the node. */
183 ir_opcode get_irn_opcode(const ir_node *node);
184 /** Get the string representation of the opcode. */
185 const char *get_irn_opname(const ir_node *node);
186 /** Get the ident for a string representation of the opcode. */
187 ident *get_irn_opident(const ir_node *node);
188 /** If arg is an argument of the node, returns it's position, -1 otherwise */
189 int get_irn_pred_pos(ir_node *node, ir_node *arg);
190 /** Gets the visited counter of a node. */
191 unsigned long get_irn_visited(const ir_node *node);
192 /** Sets the visited counter of a node. */
193 void set_irn_visited(ir_node *node, unsigned long visited);
194 /** Sets visited to get_irg_visited(current_ir_graph). */
195 void mark_irn_visited(ir_node *node);
196 /** Returns 1 if visited < get_irg_visited(current_ir_graph). */
197 int irn_not_visited(const ir_node *node);
198 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
199 int irn_visited(const ir_node *node);
202 * Sets the link of a node.
203 * Only allowed if the graph is NOT in phase_building.
205 void set_irn_link(ir_node *node, void *link);
207 /** Returns the link of a node. */
208 void *get_irn_link(const ir_node *node);
210 /** Returns the ir_graph this node belongs to. Only valid if irg
211 * is in state op_pin_state_pinned (irg is only stored in the block. */
212 ir_graph *get_irn_irg(const ir_node *node);
214 /** Outputs a unique number for this node if libFIRM is compiled for
215 debugging, (configure with --enable-debug) else returns address
216 of node cast to long. */
217 long get_irn_node_nr(const ir_node *node);
219 /** Returns the pinned state of a node.
221 * Returns whether the node _always_ must be pinned.
222 * I.e., the node is not floating after global cse.
224 * @returns Either state op_pin_state_pinned or op_pin_state_floats.
226 op_pin_state get_irn_pinned(const ir_node *node);
228 /** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
229 void set_irn_pinned(ir_node *node, op_pin_state state);
231 /** Returns whether the node is currently pinned.
233 * If get_irn_pinned returns op_pin_state_floats and the graph the
234 * node belongs to is in state op_poin_state_floats then this function
235 * returns 'floats', else 'pinned'.
237 op_pin_state is_irn_pinned_in_irg(const ir_node *node);
240 * IR node constructor.
241 * Create a new IR node in irg, with an op, mode, arity and
242 * some incoming IR nodes.
243 * This constructor is used in every specific IR node constructor.
245 * @param db Debug info.
246 * @param irg IR-graph on with this new node should be constructed.
247 * @param block The block the new node belongs to
248 * @param op The opcode of the new node.
249 * @param mode The mode of the new node.
250 * @param arity The arity of the new node, <0 if can be changed dynamically.
251 * @param in An array of arity predecessor nodes.
254 new_ir_node(dbg_info *db,
263 * Return the block the node belongs to. This is only
264 * possible for pinned nodes or if the graph is in pinned state.
265 * Otherwise the block may be incorrect. This condition is
266 * now checked by an assertion.
268 * This works for all except Block. It can return Blocks or the Bad node.
270 * To express the difference to access routines that work for all
271 * nodes we use infix "nodes" and do not name this function
272 * get_irn_block(). */
273 ir_node *get_nodes_block (const ir_node *node);
275 /** Sets the Block of a node. */
276 void set_nodes_block (ir_node *node, ir_node *block);
279 * @function get_irn_block()
280 * @see get_nodes_block()
284 * Projection numbers for result of Start node: use for Proj nodes!
287 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
288 pn_Start_M, /**< Projection on the initial memory. */
289 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
290 pn_Start_P_globals, /**< Projection on the pointer to the data segment
291 containing _all_ global entities. Use for
292 position independent data/code access. */
293 pn_Start_P_tls, /**< Projection on the pointer to the thread local store
294 segment containing _all_thread local variables. */
295 pn_Start_T_args, /**< Projection on all arguments. */
296 pn_Start_P_value_arg_base, /**< Pointer to region of compound value arguments as defined by
297 type of this method. */
298 pn_Start_max /**< number of projections from a Start */
299 } pn_Start; /* Projection numbers for Start. */
301 /** Test whether arbitrary node is frame pointer.
303 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
304 * from Start. If so returns frame type, else Null. */
305 ir_type *is_frame_pointer(ir_node *n);
307 /** Test whether arbitrary node is globals pointer.
309 * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
310 * from Start. If so returns global type, else Null. */
311 ir_type *is_globals_pointer(ir_node *n);
313 /** Test whether arbitrary node is tls pointer.
315 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
316 * from Start. If so returns tls type, else Null. */
317 ir_type *is_tls_pointer(ir_node *n);
319 /** Test whether arbitrary node is value arg base.
321 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
322 * from Start. If so returns 1, else 0. */
323 int is_value_arg_pointer(ir_node *n);
326 /* @@@ no more supported */
327 ir_node **get_Block_cfgpred_arr(ir_node *node);
328 int get_Block_n_cfgpreds(const ir_node *node);
329 ir_node *get_Block_cfgpred(ir_node *node, int pos);
330 void set_Block_cfgpred(ir_node *node, int pos, ir_node *pred);
331 /** Get the predecessor block.
333 * Returns the block corresponding to the predecessor pos of block.
335 * There are several ambiguities we resolve with this function:
336 * - The direct predecessor can be a Proj, which is not pinned.
337 * We walk from the predecessor to the next pinned node
338 * (skip_Proj) and return the block that node is in.
339 * - If we encounter the Bad node, this function does not return
340 * Start, but the Bad node.
342 ir_node *get_Block_cfgpred_block(ir_node *node, int pos);
343 int get_Block_matured(ir_node *node);
344 void set_Block_matured(ir_node *node, int matured);
346 /** A visited flag only for block nodes.
347 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
348 unsigned long get_Block_block_visited(ir_node *node);
349 void set_Block_block_visited(ir_node *node, unsigned long visit);
352 * Marks a block as dead but do not replace it with a Bad node.
353 * Dead blocks are removed in the con
355 ir_node *set_Block_dead(ir_node *block);
356 int is_Block_dead(const ir_node *block);
358 /* For this current_ir_graph must be set. */
359 void mark_Block_block_visited(ir_node *node);
360 int Block_not_block_visited(ir_node *node);
362 /* Set and remove interprocedural predecessors. If the interprocedural
363 * predecessors are removed, the node has the same predecessors in
365 * @@@ Maybe better: arity is zero if no cg preds. */
366 void set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
367 void set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
368 /* @@@ not supported */
369 ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
370 /** Returns the number of interprocedural predecessors. 0 if none. */
371 int get_Block_cg_n_cfgpreds(ir_node * node);
372 /** Return the interprocedural predecessor at position pos. */
373 ir_node *get_Block_cg_cfgpred(ir_node * node, int pos);
374 /* frees the memory. */
375 void remove_Block_cg_cfgpred_arr(ir_node * node);
377 /** returns the extended basic block a block belongs to */
378 ir_extblk *get_Block_extbb(const ir_node *block);
379 /** sets the extended basic block a block belongs to */
380 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
382 /** Return the number of Keep alive node. */
383 int get_End_n_keepalives(ir_node *end);
385 /** Return the Keep alive node a position pos. */
386 ir_node *get_End_keepalive(ir_node *end, int pos);
388 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
389 void add_End_keepalive (ir_node *end, ir_node *ka);
391 /** Set the Keep alive node at position pos. */
392 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
394 /** Set new keep-alives */
395 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
397 /* Set new keep-alives from old keep-alives, skipping irn */
398 void remove_End_keepalive(ir_node *end, ir_node *irn);
400 /** Some parts of the End node are allocated separately -- their memory
401 is not recovered by dead_node_elimination if a End node is dead.
402 free_End() frees these data structures. */
403 void free_End(ir_node *end);
405 /** Return the target address of an IJmp */
406 ir_node *get_IJmp_target(ir_node *ijmp);
408 /** Sets the target address of an IJmp */
409 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
411 /* We distinguish three kinds of Cond nodes. These can be distinguished
412 by the mode of the selector operand and an internal flag of type cond_kind.
413 First we distinguish binary Conds and switch Conds.
414 A binary Cond has as selector a boolean value. Proj(0) projects the control
415 flow for case "False", Proj(1) the control flow for "True". A binary Cond
416 is recognized by the boolean selector.
417 The switch Cond has as selector an unsigned integer. It produces as result
418 an n+1 Tuple (cf0, ... , cfn) of control flows.
419 We differ two flavors of this Cond. The first, the dense Cond, passes
420 control along output i if the selector value is i, 0 <= i <= n. If the
421 selector value is >n it passes control along output n.
422 The second Cond flavor differences in the treatment of cases not specified in
423 the source program. It magically knows about the existence of Proj nodes.
424 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
425 exists. Else it passes control along output n (even if this Proj does not
426 exist.) This Cond we call "fragmentary". There is a special constructor
427 new_defaultProj that automatically sets the flavor.
428 The two switch flavors are distinguished by a flag of type cond_kind.
429 Default flavor is "dense"
432 dense, /**< Default. Missing Proj nodes are dead control flow. */
433 fragmentary /**< Special. No control flow optimizations allowed. Missing
434 Proj nodes mean default control flow, i.e., Proj(n). */
437 ir_node *get_Cond_selector(ir_node *node);
438 void set_Cond_selector(ir_node *node, ir_node *selector);
439 cond_kind get_Cond_kind(ir_node *node);
440 void set_Cond_kind(ir_node *node, cond_kind kind);
441 long get_Cond_defaultProj(ir_node *node);
444 * Projection numbers for conditions.
447 pn_Cond_false, /**< Control flow if operand is "false". */
448 pn_Cond_true, /**< Control flow if operand is "true". */
449 pn_Cond_max /**< number of projections from a Cond */
450 } pn_Cond; /* Projection numbers for Cond. */
452 ir_node *get_Return_mem(ir_node *node);
453 void set_Return_mem(ir_node *node, ir_node *mem);
454 ir_node **get_Return_res_arr(ir_node *node);
455 int get_Return_n_ress(ir_node *node);
456 ir_node *get_Return_res(ir_node *node, int pos);
457 void set_Return_res(ir_node *node, int pos, ir_node *res);
460 CNST_NULL = 0, /**< The node is a const(0). */
461 CNST_ONE = +1, /**< The node is a const(1). */
462 CNST_ALL_ONE = -1, /**< The node is a const(11111...). */
463 CNST_OTHER = 2, /**< The tarval of the const has another value. */
464 CNST_SYMCONST = 3, /**< The node is symconst. */
465 CNST_NO_CONST = 4 /**< The node is no const at all. */
468 tarval *get_Const_tarval(ir_node *node);
469 void set_Const_tarval(ir_node *node, tarval *con);
472 * Classify a node concerning constant properties.
473 * @param irn A node to check for.
474 * @return Constant properties of that node.
476 cnst_classify_t classify_Const(ir_node *irn);
478 /** Returns the source language type of a Const node.
479 * Must be an atomic type. Mode of type must be mode of node.
481 ir_type *get_Const_type(ir_node *node);
483 /** Sets the source language type of a Const node. */
484 void set_Const_type(ir_node *node, ir_type *tp);
486 /** This enum names the three different kinds of symbolic Constants
487 represented by SymConst. The content of the attribute type_or_id
488 depends on this tag. Use the proper access routine after testing
491 symconst_type_tag, /**< The SymConst is a type tag for the given type.
492 symconst_symbol is type *. */
493 symconst_type_size, /**< The SymConst is the size of the given type.
494 symconst_symbol is type *. */
495 symconst_type_align, /**< The SymConst is the alignment of the given type.
496 symconst_symbol is type *. */
497 symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
498 by the linker. The pointer is represented by a string.
499 symconst_symbol is ident *. */
500 symconst_addr_ent, /**< The SymConst is a symbolic pointer to be filled in
501 by the linker. The pointer is represented by an entity.
502 symconst_symbol is entity *. */
503 symconst_ofs_ent, /**< The SymConst is the offset of its entity in the entities
505 symconst_enum_const /**< The SymConst is a enumeration constant of an
509 /** Returns non-zero if s symconst kind has a type attribute */
510 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
512 /** Returns non-zero if s symconst kind has an ident attribute */
513 #define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)
515 /** Returns non-zero if s symconst kind has an entity attribute */
516 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
518 /** Returns non-zero if s symconst kind has an enum_const attribute */
519 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
521 /** SymConst attribute.
523 * This union contains the symbolic information represented by the node.
525 typedef union symconst_symbol {
526 ir_type *type_p; /**< the type of a symconst */
527 ident *ident_p; /**< the ident of a symconst */
528 ir_entity *entity_p; /**< the entity of a symconst */
529 ir_enum_const *enum_p; /**< the enumeration constant of a symconst */
532 /** Get the kind of the SymConst. */
533 symconst_kind get_SymConst_kind(const ir_node *node);
534 /** Set the kind of the SymConst. */
535 void set_SymConst_kind(ir_node *node, symconst_kind num);
537 /** Only to access SymConst of kind type_tag or size. Else assertion: */
538 ir_type *get_SymConst_type(ir_node *node);
539 void set_SymConst_type(ir_node *node, ir_type *tp);
541 /** Only to access SymConst of kind addr_name. Else assertion: */
542 ident *get_SymConst_name(ir_node *node);
543 void set_SymConst_name(ir_node *node, ident *name);
545 /** Only to access SymConst of kind addr_ent. Else assertion: */
546 ir_entity *get_SymConst_entity(ir_node *node);
547 void set_SymConst_entity(ir_node *node, ir_entity *ent);
549 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
550 ir_enum_const *get_SymConst_enum(ir_node *node);
551 void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
553 /** Sets both: type and ptrinfo. Needed to treat the node independent of
554 its semantics. Does a memcpy for the memory sym points to. */
555 /* write 'union': firmjni then does not create a method... */
556 union symconst_symbol get_SymConst_symbol(ir_node *node);
557 void set_SymConst_symbol(ir_node *node,
558 union symconst_symbol sym);
560 /** Access the type of the value represented by the SymConst.
562 * Example: primitive type int for SymConst size. */
563 ir_type *get_SymConst_value_type(ir_node *node);
564 void set_SymConst_value_type(ir_node *node, ir_type *tp);
566 ir_node *get_Sel_mem(ir_node *node);
567 void set_Sel_mem(ir_node *node, ir_node *mem);
568 ir_node *get_Sel_ptr(ir_node *node); /* ptr to the object to select from */
569 void set_Sel_ptr(ir_node *node, ir_node *ptr);
570 ir_node **get_Sel_index_arr(ir_node *node);
571 int get_Sel_n_indexs(ir_node *node);
572 ir_node *get_Sel_index(ir_node *node, int pos);
573 void set_Sel_index(ir_node *node, int pos, ir_node *index);
574 ir_entity *get_Sel_entity(ir_node *node); /* entity to select */
575 void set_Sel_entity (ir_node *node, ir_entity *ent);
578 * Projection numbers for result of Call node: use for Proj nodes!
581 pn_Call_M_regular = 0, /**< The memory result. */
582 pn_Call_T_result = 2, /**< The tuple containing all (0, 1, 2, ...) results */
583 pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
584 passed by value (for compound result types). */
585 pn_Call_X_except = 1, /**< The control flow result branching to the exception handler */
586 pn_Call_M_except = 3, /**< The memory result in case the called method terminated with
588 pn_Call_max = 5 /**< number of projections from a Call */
589 } pn_Call; /* Projection numbers for Call. */
590 #define pn_Call_M pn_Call_M_regular
592 ir_node *get_Call_mem(ir_node *node);
593 void set_Call_mem(ir_node *node, ir_node *mem);
594 ir_node *get_Call_ptr(ir_node *node);
595 void set_Call_ptr(ir_node *node, ir_node *ptr);
596 ir_node **get_Call_param_arr(ir_node *node);
597 /** Gets the number of parameters of a call. */
598 int get_Call_n_params(ir_node *node);
599 /** Gets the call parameter at position pos. */
600 ir_node *get_Call_param(ir_node *node, int pos);
601 /** Sets the call parameter at position pos. */
602 void set_Call_param(ir_node *node, int pos, ir_node *param);
603 /** Gets the type of a call. */
604 ir_type *get_Call_type(ir_node *node);
605 /** Sets the type of a call. */
606 void set_Call_type(ir_node *node, ir_type *tp);
607 /** Gets the arity of a call. Identical to get_Call_n_params(). */
608 int get_Call_arity(ir_node *node);
610 /** Set, get and remove the callee information for a Call node.
612 * The callee information lists all method entities that can be called
613 * from this node. If the address expression can not be analyzed fully,
614 * e.g., as entities can be called that are not in the compilation unit,
615 * the array contains the unknown_entity. The array contains only entities
616 * with peculiarity_existent, but with all kinds of visibility. The entities
617 * not necessarily contain an irg.
619 * The array is only accessible if callee information is valid. See flag
622 * The memory allocated for the array is managed automatically, i.e., it must
623 * not be freed if the Call node is removed from the graph.
625 * @param node A Call node.
627 int Call_has_callees(ir_node *node);
628 int get_Call_n_callees(ir_node *node);
629 ir_entity *get_Call_callee(ir_node *node, int pos);
631 /** Set the full callee array.
633 * The passed array is copied. Assumes current_ir_graph set properly! */
634 void set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
635 void remove_Call_callee_arr(ir_node *node);
637 ir_node *get_CallBegin_ptr(ir_node *node);
638 void set_CallBegin_ptr(ir_node *node, ir_node *ptr);
639 ir_node *get_CallBegin_call(ir_node *node);
640 void set_CallBegin_call(ir_node *node, ir_node *call);
642 /* For unary and binary arithmetic operations the access to the
643 operands can be factored out. Left is the first, right the
644 second arithmetic value as listed in tech report 1999-44.
645 unops are: Minus, Abs, Not, Conv, Cast
646 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
647 Shr, Shrs, Rot, Cmp */
648 int is_unop(const ir_node *node);
649 ir_node *get_unop_op(ir_node *node);
650 void set_unop_op(ir_node *node, ir_node *op);
651 int is_binop(const ir_node *node);
652 ir_node *get_binop_left(ir_node *node);
653 void set_binop_left(ir_node *node, ir_node *left);
654 ir_node *get_binop_right(ir_node *node);
655 void set_binop_right(ir_node *node, ir_node *right);
657 ir_node *get_Add_left(ir_node *node);
658 void set_Add_left(ir_node *node, ir_node *left);
659 ir_node *get_Add_right(ir_node *node);
660 void set_Add_right(ir_node *node, ir_node *right);
662 ir_node *get_Sub_left(ir_node *node);
663 void set_Sub_left(ir_node *node, ir_node *left);
664 ir_node *get_Sub_right(ir_node *node);
665 void set_Sub_right(ir_node *node, ir_node *right);
667 ir_node *get_Minus_op(ir_node *node);
668 void set_Minus_op(ir_node *node, ir_node *op);
670 ir_node *get_Mul_left(ir_node *node);
671 void set_Mul_left(ir_node *node, ir_node *left);
672 ir_node *get_Mul_right(ir_node *node);
673 void set_Mul_right(ir_node *node, ir_node *right);
675 ir_node *get_Quot_left(ir_node *node);
676 void set_Quot_left(ir_node *node, ir_node *left);
677 ir_node *get_Quot_right(ir_node *node);
678 void set_Quot_right(ir_node *node, ir_node *right);
679 ir_node *get_Quot_mem(ir_node *node);
680 void set_Quot_mem(ir_node *node, ir_node *mem);
683 * Projection numbers for Quot: use for Proj nodes!
686 pn_Quot_M, /**< Memory result. */
687 pn_Quot_X_except, /**< Execution result if exception occurred. */
688 pn_Quot_res, /**< Result of computation. */
689 pn_Quot_max /**< number of projections from a Quot */
690 } pn_Quot; /* Projection numbers for Quot. */
692 ir_node *get_DivMod_left(ir_node *node);
693 void set_DivMod_left(ir_node *node, ir_node *left);
694 ir_node *get_DivMod_right(ir_node *node);
695 void set_DivMod_right(ir_node *node, ir_node *right);
696 ir_node *get_DivMod_mem(ir_node *node);
697 void set_DivMod_mem(ir_node *node, ir_node *mem);
700 * Projection numbers for DivMod: use for Proj nodes!
703 pn_DivMod_M, /**< Memory result. */
704 pn_DivMod_X_except, /**< Execution result if exception occurred. */
705 pn_DivMod_res_div, /**< Result of computation a / b. */
706 pn_DivMod_res_mod, /**< Result of computation a % b. */
707 pn_DivMod_max /**< number of projections from a DivMod */
708 } pn_DivMod; /* Projection numbers for DivMod. */
710 ir_node *get_Div_left(ir_node *node);
711 void set_Div_left(ir_node *node, ir_node *left);
712 ir_node *get_Div_right(ir_node *node);
713 void set_Div_right(ir_node *node, ir_node *right);
714 ir_node *get_Div_mem(ir_node *node);
715 void set_Div_mem(ir_node *node, ir_node *mem);
718 * Projection numbers for Div: use for Proj nodes!
721 pn_Div_M, /**< Memory result. */
722 pn_Div_X_except, /**< Execution result if exception occurred. */
723 pn_Div_res, /**< Result of computation. */
724 pn_Div_max /**< number of projections from a Div */
725 } pn_Div; /* Projection numbers for Div. */
727 ir_node *get_Mod_left(ir_node *node);
728 void set_Mod_left(ir_node *node, ir_node *left);
729 ir_node *get_Mod_right(ir_node *node);
730 void set_Mod_right(ir_node *node, ir_node *right);
731 ir_node *get_Mod_mem(ir_node *node);
732 void set_Mod_mem(ir_node *node, ir_node *mem);
735 * Projection numbers for Mod: use for Proj nodes!
738 pn_Mod_M, /**< Memory result. */
739 pn_Mod_X_except, /**< Execution result if exception occurred. */
740 pn_Mod_res, /**< Result of computation. */
741 pn_Mod_max /**< number of projections from a Mod */
742 } pn_Mod; /* Projection numbers for Mod. */
744 ir_node *get_Abs_op(ir_node *node);
745 void set_Abs_op(ir_node *node, ir_node *op);
747 ir_node *get_And_left(ir_node *node);
748 void set_And_left(ir_node *node, ir_node *left);
749 ir_node *get_And_right(ir_node *node);
750 void set_And_right(ir_node *node, ir_node *right);
752 ir_node *get_Or_left(ir_node *node);
753 void set_Or_left(ir_node *node, ir_node *left);
754 ir_node *get_Or_right(ir_node *node);
755 void set_Or_right(ir_node *node, ir_node *right);
757 ir_node *get_Eor_left(ir_node *node);
758 void set_Eor_left(ir_node *node, ir_node *left);
759 ir_node *get_Eor_right(ir_node *node);
760 void set_Eor_right(ir_node *node, ir_node *right);
762 ir_node *get_Not_op(ir_node *node);
763 void set_Not_op(ir_node *node, ir_node *op);
766 * Projection numbers for Cmp are defined several times.
767 * The bit patterns are used for various tests, so don't change.
768 * The "unordered" values are possible results of comparing
769 * floating point numbers.
770 * Note that the encoding is imported, so do NOT change the order.
773 pn_Cmp_False = 0, /**< false */
774 pn_Cmp_Eq = 1, /**< equal */
775 pn_Cmp_Lt = 2, /**< less */
776 pn_Cmp_Le = pn_Cmp_Eq|pn_Cmp_Lt, /**< less or equal */
777 pn_Cmp_Gt = 4, /**< greater */
778 pn_Cmp_Ge = pn_Cmp_Eq|pn_Cmp_Gt, /**< greater or equal */
779 pn_Cmp_Lg = pn_Cmp_Lt|pn_Cmp_Gt, /**< less or greater */
780 pn_Cmp_Leg = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
781 pn_Cmp_Uo = 8, /**< unordered */
782 pn_Cmp_Ue = pn_Cmp_Uo|pn_Cmp_Eq, /**< unordered or equal */
783 pn_Cmp_Ul = pn_Cmp_Uo|pn_Cmp_Lt, /**< unordered or less */
784 pn_Cmp_Ule = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
785 pn_Cmp_Ug = pn_Cmp_Uo|pn_Cmp_Gt, /**< unordered or greater */
786 pn_Cmp_Uge = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
787 pn_Cmp_Ne = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
788 pn_Cmp_True = 15 /**< true */
789 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for JNI interface */
790 } pn_Cmp; /* Projection numbers for Cmp */
791 /* #define not_mask pn_Cmp_Leg */
793 /** returns the pnc name from an pnc constant */
794 const char *get_pnc_string(int pnc);
796 /** Calculates the negated (Complement(R)) pnc condition. */
797 int get_negated_pnc(int pnc, ir_mode *mode);
799 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
800 int get_inversed_pnc(int pnc);
802 ir_node *get_Cmp_left(ir_node *node);
803 void set_Cmp_left(ir_node *node, ir_node *left);
804 ir_node *get_Cmp_right(ir_node *node);
805 void set_Cmp_right(ir_node *node, ir_node *right);
807 ir_node *get_Shl_left(ir_node *node);
808 void set_Shl_left(ir_node *node, ir_node *left);
809 ir_node *get_Shl_right(ir_node *node);
810 void set_Shl_right(ir_node *node, ir_node *right);
812 ir_node *get_Shr_left(ir_node *node);
813 void set_Shr_left(ir_node *node, ir_node *left);
814 ir_node *get_Shr_right(ir_node *node);
815 void set_Shr_right(ir_node *node, ir_node *right);
817 ir_node *get_Shrs_left(ir_node *node);
818 void set_Shrs_left(ir_node *node, ir_node *left);
819 ir_node *get_Shrs_right(ir_node *node);
820 void set_Shrs_right(ir_node *node, ir_node *right);
822 ir_node *get_Rot_left(ir_node *node);
823 void set_Rot_left(ir_node *node, ir_node *left);
824 ir_node *get_Rot_right(ir_node *node);
825 void set_Rot_right(ir_node *node, ir_node *right);
827 ir_node *get_Conv_op(ir_node *node);
828 void set_Conv_op(ir_node *node, ir_node *op);
829 int get_Conv_strict(ir_node *node);
830 void set_Conv_strict(ir_node *node, int flag);
832 /* Does Cast need a mem operator?
833 * Cast should only depend on the type, not on the state of an
834 * entity. But: we initialize various fields after Alloc, that
835 * are accessed in the cast. This required some precaution, to
836 * get the right memory into the Loads generated from the cast.
838 ir_node *get_Cast_op(ir_node *node);
839 void set_Cast_op(ir_node *node, ir_node *op);
840 ir_type *get_Cast_type(ir_node *node);
841 void set_Cast_type(ir_node *node, ir_type *to_tp);
843 /** Checks for upcast.
845 * Returns true if the Cast node casts a class type to a super type.
846 * Works also for pointers to classes (recursively).
848 * Needs typeinfo calculated.
850 int is_Cast_upcast(ir_node *node);
852 /** Checks for downcast.
854 * Returns true if the Cast node casts a class type to a sub type.
855 * Works also for pointers to classes (recursively).
857 * Needs typeinfo calculated.
859 int is_Cast_downcast(ir_node *node);
862 /** Returns true if n is Phi or Filter in interprocedural_view.
863 Returns false if irg in phase building and the Phi has zero
864 predecessors: it's a Phi0. */
865 int is_Phi(const ir_node *n);
866 /** Returns true if irg in phase building and the Phi has zero
867 predecessors: it's a Phi0. */
868 int is_Phi0(const ir_node *n);
869 /* These routines also work for Filter nodes in interprocedural view. */
870 ir_node **get_Phi_preds_arr(ir_node *node);
871 int get_Phi_n_preds(ir_node *node);
872 ir_node *get_Phi_pred(ir_node *node, int pos);
873 void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
875 ir_node *get_Filter_pred(ir_node *node);
876 void set_Filter_pred(ir_node *node, ir_node *pred);
877 long get_Filter_proj(ir_node *node);
878 void set_Filter_proj(ir_node *node, long proj);
879 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
880 * @@@ Maybe better: arity is zero if no cg preds. */
881 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
882 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
883 int get_Filter_n_cg_preds(ir_node *node);
884 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
886 /** Return true if parameter is a memory operation.
888 * A memory operation is an operation that changes the
889 * memory. I.e., a Load or a Store operation.
891 int is_memop(ir_node *node);
892 ir_node *get_memop_mem(ir_node *node);
893 void set_memop_mem(ir_node *node, ir_node *mem);
894 ir_node *get_memop_ptr(ir_node *node);
895 void set_memop_ptr(ir_node *node, ir_node *ptr);
898 * Projection numbers for Load: use for Proj nodes!
901 pn_Load_M, /**< Memory result. */
902 pn_Load_X_except, /**< Execution result if exception occurred. */
903 pn_Load_res, /**< Result of load operation. */
904 pn_Load_max /**< number of projections from a Load */
905 } pn_Load; /* Projection numbers for Load. */
907 ir_node *get_Load_mem(ir_node *node);
908 void set_Load_mem(ir_node *node, ir_node *mem);
909 ir_node *get_Load_ptr(ir_node *node);
910 void set_Load_ptr(ir_node *node, ir_node *ptr);
911 ir_mode *get_Load_mode(ir_node *node);
912 void set_Load_mode(ir_node *node, ir_mode *mode);
913 ir_volatility get_Load_volatility(ir_node *node);
914 void set_Load_volatility(ir_node *node, ir_volatility volatility);
917 * Projection numbers for Store: use for Proj nodes!
920 pn_Store_M, /**< Memory result. */
921 pn_Store_X_except, /**< Execution result if exception occurred. */
922 pn_Store_max /**< number of projections from a Store */
923 } pn_Store; /* Projection numbers for Store. */
925 ir_node *get_Store_mem(ir_node *node);
926 void set_Store_mem(ir_node *node, ir_node *mem);
927 ir_node *get_Store_ptr(ir_node *node);
928 void set_Store_ptr(ir_node *node, ir_node *ptr);
929 ir_node *get_Store_value(ir_node *node);
930 void set_Store_value(ir_node *node, ir_node *value);
931 ir_volatility get_Store_volatility(ir_node *node);
932 void set_Store_volatility(ir_node *node, ir_volatility volatility);
935 * Projection numbers for Alloc: use for Proj nodes!
938 pn_Alloc_M, /**< Memory result. */
939 pn_Alloc_X_except, /**< Execution result if exception occurred. */
940 pn_Alloc_res, /**< Result of allocation. */
941 pn_Alloc_max /**< number of projections from an Alloc */
942 } pn_Alloc; /* Projection numbers for Alloc. */
944 ir_node *get_Alloc_mem(ir_node *node);
945 void set_Alloc_mem(ir_node *node, ir_node *mem);
946 ir_node *get_Alloc_size(ir_node *node);
947 void set_Alloc_size(ir_node *node, ir_node *size);
948 ir_type *get_Alloc_type(ir_node *node);
949 void set_Alloc_type(ir_node *node, ir_type *tp);
951 /** The allocation place. */
953 stack_alloc, /**< Alloc allocates the object on the stack. */
954 heap_alloc /**< Alloc allocates the object on the heap. */
957 where_alloc get_Alloc_where(ir_node *node);
958 void set_Alloc_where(ir_node *node, where_alloc where);
960 ir_node *get_Free_mem(ir_node *node);
961 void set_Free_mem(ir_node *node, ir_node *mem);
962 ir_node *get_Free_ptr(ir_node *node);
963 void set_Free_ptr(ir_node *node, ir_node *ptr);
964 ir_node *get_Free_size(ir_node *node);
965 void set_Free_size(ir_node *node, ir_node *size);
966 ir_type *get_Free_type(ir_node *node);
967 void set_Free_type(ir_node *node, ir_type *tp);
969 where_alloc get_Free_where(ir_node *node);
970 void set_Free_where(ir_node *node, where_alloc where);
972 ir_node **get_Sync_preds_arr(ir_node *node);
973 int get_Sync_n_preds(ir_node *node);
974 ir_node *get_Sync_pred(ir_node *node, int pos);
975 void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
976 void add_Sync_pred(ir_node *node, ir_node *pred);
978 /** Returns the source language type of a Proj node.
979 * Must be an atomic type. Mode of type must be mode of node.
981 ir_type *get_Proj_type(ir_node *node);
983 /** Return the predecessor of a Proj node. */
984 ir_node *get_Proj_pred(const ir_node *node);
985 void set_Proj_pred(ir_node *node, ir_node *pred);
986 /** Return the projection number of a Proj node. */
987 long get_Proj_proj(const ir_node *node);
988 void set_Proj_proj(ir_node *node, long proj);
990 ir_node **get_Tuple_preds_arr(ir_node *node);
991 int get_Tuple_n_preds(ir_node *node);
992 ir_node *get_Tuple_pred(ir_node *node, int pos);
993 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
995 ir_node *get_Id_pred(ir_node *node);
996 void set_Id_pred(ir_node *node, ir_node *pred);
998 /** Confirm has a single result and returns 'value' unchanged.
999 * The node expresses a restriction on 'value':
1000 * 'value' 'cmp' 'bound' == true. */
1001 ir_node *get_Confirm_value(ir_node *node);
1002 void set_Confirm_value(ir_node *node, ir_node *value);
1003 ir_node *get_Confirm_bound(ir_node *node);
1004 void set_Confirm_bound(ir_node *node, ir_node *bound);
1005 pn_Cmp get_Confirm_cmp(ir_node *node);
1006 void set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
1009 * Mux Support: Note that Psi nodes with one condition can be handled
1010 * like Mux nodes, and the access functions work as expected.
1012 ir_node *get_Mux_sel(ir_node *node);
1013 void set_Mux_sel(ir_node *node, ir_node *sel);
1014 ir_node *get_Mux_false(ir_node *node);
1015 void set_Mux_false(ir_node *node, ir_node *ir_false);
1016 ir_node *get_Mux_true (ir_node *node);
1017 void set_Mux_true (ir_node *node, ir_node *ir_true);
1019 ir_node *get_Psi_cond(ir_node *node, int pos);
1020 void set_Psi_cond(ir_node *node, int pos, ir_node *cond);
1021 ir_node *get_Psi_val(ir_node *node, int pos);
1022 void set_Psi_val(ir_node *node, int pos, ir_node *val);
1023 ir_node *get_Psi_default(ir_node *node);
1024 void set_Psi_default(ir_node *node, ir_node *val);
1025 int get_Psi_n_conds(ir_node *node);
1028 * Projection numbers for result of CopyB node: use for Proj nodes!
1031 pn_CopyB_M_regular = 0, /**< The memory result. */
1032 pn_CopyB_X_except = 1, /**< The control flow result branching to the exception handler */
1033 pn_CopyB_M_except = 2, /**< The memory result in case the runtime function terminated with
1035 pn_CopyB_max = 3 /**< number of projections from a CopyB */
1036 } pn_CopyB; /* Projection numbers for CopyB. */
1037 #define pn_CopyB_M pn_CopyB_M_regular
1039 ir_node *get_CopyB_mem(ir_node *node);
1040 void set_CopyB_mem(ir_node *node, ir_node *mem);
1041 ir_node *get_CopyB_dst(ir_node *node);
1042 void set_CopyB_dst(ir_node *node, ir_node *dst);
1043 ir_node *get_CopyB_src(ir_node *node);
1044 void set_CopyB_src(ir_node *node, ir_node *src);
1045 ir_type *get_CopyB_type(ir_node *node);
1046 void set_CopyB_type(ir_node *node, ir_type *data_type);
1049 * Projection numbers for result of InstOf node: use for Proj nodes!
1052 pn_InstOf_M_regular = 0, /**< The memory result. */
1053 pn_InstOf_X_except = 1, /**< The control flow result branching to the exception handler */
1054 pn_InstOf_res = 2, /**< The checked object pointer. */
1055 pn_InstOf_M_except = 3, /**< The memory result in case the runtime function terminated with
1057 pn_InstOf_max = 4 /**< number of projections from an InstOf */
1059 #define pn_InstOf_M pn_InstOf_M_regular
1061 /** InstOf access */
1062 ir_type *get_InstOf_type(ir_node *node);
1063 void set_InstOf_type(ir_node *node, ir_type *type);
1064 ir_node *get_InstOf_store(ir_node *node);
1065 void set_InstOf_store(ir_node *node, ir_node *obj);
1066 ir_node *get_InstOf_obj(ir_node *node);
1067 void set_InstOf_obj(ir_node *node, ir_node *obj);
1070 * Projection numbers for Raise.
1073 pn_Raise_X = 0, /**< The control flow to the exception handler. */
1074 pn_Raise_M = 1, /**< The Memory result. */
1075 pn_Raise_max /**< number of projections from a Raise */
1076 } pn_Raise; /* Projection numbers for Raise. */
1078 ir_node *get_Raise_mem(ir_node *node);
1079 void set_Raise_mem(ir_node *node, ir_node *mem);
1080 ir_node *get_Raise_exo_ptr(ir_node *node); /* PoinTeR to EXception Object */
1081 void set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
1084 * Projection numbers for result of Bound node: use for Proj nodes!
1087 pn_Bound_M = 0, /**< The memory result. */
1088 pn_Bound_X_except = 1, /**< The control flow result branching to the exception handler */
1089 pn_Bound_res = 2, /**< The checked index. */
1090 pn_Bound_max = 3 /**< number of projections from a Bound */
1093 /** Returns the memory input of a Bound operation. */
1094 ir_node *get_Bound_mem(ir_node *bound);
1095 void set_Bound_mem(ir_node *bound, ir_node *mem);
1097 /** Returns the index input of a Bound operation. */
1098 ir_node *get_Bound_index(ir_node *bound);
1099 void set_Bound_index(ir_node *bound, ir_node *idx);
1101 /** Returns the lower bound input of a Bound operation. */
1102 ir_node *get_Bound_lower(ir_node *bound);
1103 void set_Bound_lower(ir_node *bound, ir_node *lower);
1105 /** Returns the upper bound input of a Bound operation. */
1106 ir_node *get_Bound_upper(ir_node *bound);
1107 void set_Bound_upper(ir_node *bound, ir_node *upper);
1109 /** Return the operand of a Pin node. */
1110 ir_node *get_Pin_op(ir_node *pin);
1111 void set_Pin_op(ir_node *pin, ir_node *node);
1116 * NAME Auxiliary routines
1118 * Not properly documented ;-)
1122 /** returns operand of node if node is a Proj. */
1123 ir_node *skip_Proj(ir_node *node);
1124 /** returns operand of node if node is a Proj. */
1125 const ir_node *skip_Proj_const(const ir_node *node);
1126 /** returns operand of node if node is a Id */
1127 ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
1128 /** returns corresponding operand of Tuple if node is a Proj from
1130 ir_node *skip_Tuple(ir_node *node);
1131 /** returns operand of node if node is a Cast */
1132 ir_node *skip_Cast(ir_node *node);
1133 /** returns operand of node if node is a Confirm */
1134 ir_node *skip_Confirm(ir_node *node);
1135 /** Skip all high-level Operations. */
1136 ir_node *skip_HighLevel(ir_node *node);
1137 /** returns true if irn is a Const node. */
1138 int is_Const(const ir_node *node);
1139 /** returns true if node is a Bad node. */
1140 int is_Bad(const ir_node *node);
1141 /** returns true if node is a NoMem node. */
1142 int is_NoMem(const ir_node *node);
1143 /** returns true if node is a Start node. */
1144 int is_Start(const ir_node *node);
1145 /** return true if node is a Mod node. */
1146 int is_Mod(const ir_node *node);
1147 /** return true if node is a Div node. */
1148 int is_Div(const ir_node *node);
1149 /** return true if node is a DivMod node. */
1150 int is_DivMod(const ir_node *node);
1151 /** return true if node is a Quot node. */
1152 int is_Quot(const ir_node *node);
1153 /** returns true if the node is not a Block */
1154 int is_no_Block(const ir_node *node);
1155 /** returns true if the node is a Block */
1156 int is_Block(const ir_node *node);
1157 /** returns true if node is an Unknown node. */
1158 int is_Unknown(const ir_node *node);
1159 /** returns true if node is a Return node. */
1160 int is_Return(const ir_node *node);
1161 /** returns true if node is a Call node. */
1162 int is_Call(const ir_node *node);
1163 /** returns true if node is a Sel node. */
1164 int is_Sel(const ir_node *node);
1165 /** returns true if node is a Mux node or a Psi with only one condition. */
1166 int is_Mux(const ir_node *node);
1167 /** returns true if node is a Load node. */
1168 int is_Load(const ir_node *node);
1169 /** returns true if node is a Store node. */
1170 int is_Store(const ir_node *node);
1171 /** returns true if node is a Sync node. */
1172 int is_Sync(const ir_node *node);
1173 /** returns true if node is a Confirm node. */
1174 int is_Confirm(const ir_node *node);
1175 /** returns true if node is a Pin node. */
1176 int is_Pin(const ir_node *node);
1177 /** returns true if node is a SymConst node. */
1178 int is_SymConst(const ir_node *node);
1179 /** returns true if node is a Cond node. */
1180 int is_Cond(const ir_node *node);
1181 /** returns true of node is a CopyB node */
1182 int is_CopyB(const ir_node *node);
1183 /** returns true if node is a Cmp node. */
1184 int is_Cmp(const ir_node *node);
1185 /** returns true if node is an Alloc node */
1186 int is_Alloc(const ir_node *node);
1187 /** returns true if a node is a Jmp node */
1188 int is_Jmp(const ir_node *node);
1189 /** returns true if a node is a Raise node */
1190 int is_Raise(const ir_node *node);
1191 /** returns true if node is a Proj node or a Filter node in
1192 * intraprocedural view */
1193 int is_Proj(const ir_node *node);
1194 /** Returns true if the operation manipulates control flow:
1195 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1196 int is_cfop(const ir_node *node);
1198 /** Returns true if the operation manipulates interprocedural control flow:
1199 CallBegin, EndReg, EndExcept */
1200 int is_ip_cfop(const ir_node *node);
1201 /** Returns true if the operation can change the control flow because
1202 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1203 Bad. Raise is not fragile, but a unconditional jump. */
1204 int is_fragile_op(const ir_node *node);
1205 /** Returns the memory operand of fragile operations. */
1206 ir_node *get_fragile_op_mem(ir_node *node);
1208 /** Returns true if the operation is a forking control flow
1209 * operation: Cond. */
1210 int is_irn_forking(const ir_node *node);
1212 /** Return the type associated with the value produced by n
1213 * if the node remarks this type as it is the case for
1214 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1215 ir_type *get_irn_type(ir_node *n);
1217 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1219 ir_type *get_irn_type_attr(ir_node *n);
1221 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1222 ir_entity *get_irn_entity_attr(ir_node *n);
1224 /** Returns non-zero for constant-like nodes. */
1225 int is_irn_constlike(const ir_node *node);
1228 * Returns non-zero for nodes that must be always optimized
1229 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1231 int is_irn_always_opt(const ir_node *node);
1234 * Returns non-zero for nodes that are allowed to have keep-alives and
1235 * are neither Block nor PhiM.
1237 int is_irn_keep(const ir_node *node);
1240 * Returns non-zero for nodes that are always placed in the start block.
1242 int is_irn_start_block_placed(const ir_node *node);
1245 * Returns non-zero for nodes that are machine operations.
1247 int is_irn_machine_op(const ir_node *node);
1250 * Returns non-zero for nodes that are machine operands.
1252 int is_irn_machine_operand(const ir_node *node);
1255 * Returns non-zero for nodes that have the n'th user machine flag set.
1257 int is_irn_machine_user(const ir_node *node, unsigned n);
1260 * A type to express conditional jump predictions.
1263 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1264 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1265 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1266 } cond_jmp_predicate;
1268 /** Gets the string representation of the jump prediction .*/
1269 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1271 /** Returns the conditional jump prediction of a Cond node. */
1272 cond_jmp_predicate get_Cond_jmp_pred(ir_node *cond);
1274 /** Sets a new conditional jump prediction. */
1275 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1278 * Access custom node data.
1279 * The data must have been registered with
1280 * register_additional_node_data() before.
1281 * @param node The ir node to get the data from.
1282 * @param type The type of the data you registered.
1283 * @param off The value returned by register_additional_node_data().
1284 * @return A pointer of type @p type.
1286 #define get_irn_data(node,type,off) \
1287 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1290 * Get the pointer to the node some custom data belongs to.
1291 * @param data The pointer to the custom data.
1292 * @param off The number as returned by register_additional_node_data().
1293 * @return A pointer to the ir node the custom data belongs to.
1295 #define get_irn_data_base(data,off) \
1296 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1299 * Request additional data to be allocated with an ir node.
1300 * @param size The size of the additional data required.
1301 * @return A positive number, if the operation was successful, which
1302 * must be passed to the access macro get_irn_data(), 0 if the
1303 * registration failed.
1305 unsigned register_additional_node_data(unsigned size);
1308 * Return a pointer to the node attributes.
1309 * Needed for user-defined nodes.
1311 void *get_irn_generic_attr(ir_node *node);
1314 * Returns the unique node index for the node in its graph.
1315 * This index is used to access phase information for this node.
1317 unsigned get_irn_idx(const ir_node *node);
1319 /*-----------------------------------------------------------------*/
1321 /*-----------------------------------------------------------------*/
1324 /** Debug print the node.
1326 * Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
1327 * is set. Else does nothing. */
1328 void dump_irn(ir_node *n);
1334 /* GNU C has the __FUNCTION__ extension */
1335 #define __MYFUNC__ __FUNCTION__
1337 /* use Filename instead */
1338 #define __MYFUNC__ __FILE__
1342 Don't format with "\", firmjni gets problems */
1343 /** Output location */
1344 #define DDM printf("%s(l.%i).\n", __MYFUNC__, __LINE__);
1345 /** Output the firm kind of the node */
1346 #define DDMK(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, print_firm_kind(X), (void *)(X));
1347 /** Output information about a node */
1349 /*#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))*/
1350 int dump_node_opcode(FILE *F, ir_node *n);
1351 #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)
1353 /** Output information about a node and its block */
1354 #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)))
1355 /** Output information about a type */
1356 #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))
1357 /** Output information about an entity */
1358 #define DDME(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
1359 /** Output information about an entity and its type */
1360 #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))
1361 /** Output information about an entity and its owner */
1362 #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))
1363 /** Output information about a graph */
1364 #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))))
1365 /** Output information about an ident */
1366 #define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_id_str(X), (void *)(X))
1367 /** Output information about a mode */
1368 #define DDMM(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
1369 /** Output information about a loop */
1370 #define DDML(X) printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
1371 /** Output information about a tarVal */
1372 #define DDMV(X) printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
1374 /*@}*/ /* end of ir_node group definition */
1381 #endif /* _FIRM_IR_IRNODE_H_ */