2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Representation of an intermediate operation.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
26 #ifndef FIRM_IR_IRNODE_H
27 #define FIRM_IR_IRNODE_H
31 #include "firm_common.h"
39 * @author Martin Trapp, Christian Schaefer
41 * Declarations of an ir node.
45 * @defgroup ir_node Declarations of an ir node.
47 * The type definition of ir_node is also in irgraph.h to resolve
48 * recursion between irnode.h and irgraph.h
50 * ir_node - a datatype representing a Firm node
52 * The common fields are:
54 * - firm_kind - A firm_kind tag containing k_type. This is useful
55 * for dynamically checking whether a node is a ir_node.
56 * - arity - The number of predecessors in the Firm graph.
57 * - in - A list with the predecessors in the Firm graph. There are
58 * routines to access individual elements and to obtain the
59 * array. The method returning the array should not be used.
60 * - mode - The mode of the node. There are routines to get the mode
61 * but also to access the mode's fields directly.
62 * - opcode - The opcode of the node. There are routines to get the opcode
63 * but also to access the opcode's fields directly.
64 * - node_nr - A unique number for the node. Available only if debugging
70 * Some projection numbers must be always equal to support automatic phi construction
73 pn_Generic_M_regular = 0, /**< The memory result. */
74 pn_Generic_X_regular = 1, /**< Execution result if no exception occurred. */
75 pn_Generic_X_except = 2, /**< The control flow result branching to the exception handler */
76 pn_Generic_other = 3 /**< First free projection number */
80 * Checks whether a pointer points to a ir node.
82 * @param thing an arbitrary pointer
83 * @return non-zero if the thing is a ir mode, else zero
85 int is_ir_node (const void *thing);
88 * Returns the number of predecessors without the block predecessor.
90 * @param node the IR-node
92 int get_irn_arity (const ir_node *node);
93 int get_irn_intra_arity(const ir_node *node);
94 int get_irn_inter_arity(const ir_node *node);
96 /** Replaces the old in array by a new one that will contain the ins given in
97 the parameters. Conserves the block predecessor. It copies the array passed.
98 This function is necessary to adjust in arrays of blocks, calls and phis.
99 Assumes that current_ir_graph is set to the graph containing "node".
100 "in" must contain all predecessors except the block that are required for
102 void set_irn_in(ir_node *node, int arity, ir_node *in[]);
104 /* to iterate through the predecessors without touching the array. No
105 order of predecessors guaranteed.
106 To iterate over the operands iterate from 0 to i < get_irn_arity(),
107 to iterate including the Block predecessor iterate from i = -1 to
108 i < get_irn_arity. */
109 /* Access predecessor n */
112 * Get the n-th predecessor of a node.
113 * This function removes Id predecessors.
114 * This function automatically handles intra- and interprocedural views.
116 ir_node *get_irn_n(const ir_node *node, int n);
119 * Add a artificial dependency to the node.
120 * The dependency is only inserted if it is not there already.
121 * This is only allowed in phase_backend!
123 * @param node The node.
124 * @param dep The dependency target.
126 * @return The index in the array (get_irn_dep() with that index returns @p dep).
128 int add_irn_dep(ir_node *node, ir_node *dep);
131 * Copy all dependencies from a node to another.
132 * This is only allowed in phase_backend!
134 * @param tgt The node which should be enriched.
135 * @param src The node whose dependencies shall be copied.
137 void add_irn_deps(ir_node *tgt, ir_node *src);
140 * Get the length of the dependency array.
141 * @param node The node.
142 * @return The length of the dependency array or 0 if it has not yet been allocated.
144 int get_irn_deps(const ir_node *node);
147 * Get an entry of the dependency array.
148 * @param node The node.
149 * @param pos The position.
150 * @return The node at that position.
152 ir_node *get_irn_dep(const ir_node *node, int pos);
155 * Set an entry of the dependency array.
156 * @param node The node.
157 * @param pos The position.
158 * @param dep The dependency target.
160 void set_irn_dep(ir_node *node, int pos, ir_node *dep);
164 * Get the n-th predecessor of a node in intraprocedural view.
165 * Can be used always if it's know that node is not a split one.
167 ir_node *get_irn_intra_n(const ir_node *node, int n);
170 * Get the n-th predecessor of a node in interprocedural view.
172 ir_node *get_irn_inter_n(const ir_node *node, int n);
174 /** Replace the n-th predecessor of a node with a new one. */
175 void set_irn_n(ir_node *node, int n, ir_node *in);
177 * Appends a new predecessor to a node. This only works for nodes with
179 * @returns the number of the new input
181 int add_irn_n(ir_node *node, ir_node *in);
182 /* Remove predecessor i from Sync n */
183 void del_Sync_n(ir_node *n, int i);
184 /* Sets the mode struct of node. */
185 void set_irn_mode(ir_node *node, ir_mode *mode);
186 /** Gets the mode struct of a node. */
187 ir_mode *get_irn_mode(const ir_node *node);
188 /** Gets the ident for a string representation of the mode .*/
189 ident *get_irn_modeident(const ir_node *node);
190 /** Gets the string representation of the mode .*/
191 const char *get_irn_modename(const ir_node *node);
192 /** Gets the opcode struct of the node. */
193 ir_op *get_irn_op(const ir_node *node);
194 /** Sets the opcode struct of the node. */
195 void set_irn_op(ir_node *node, ir_op *op);
196 /** Gets the opcode-enum of the node. */
197 unsigned get_irn_opcode(const ir_node *node);
198 /** Get the string representation of the opcode. */
199 const char *get_irn_opname(const ir_node *node);
200 /** Get the ident for a string representation of the opcode. */
201 ident *get_irn_opident(const ir_node *node);
202 /** If arg is an argument of the node, returns it's position, -1 otherwise */
203 int get_irn_pred_pos(ir_node *node, ir_node *arg);
204 /** Gets the visited counter of a node. */
205 ir_visited_t get_irn_visited(const ir_node *node);
206 /** Sets the visited counter of a node. */
207 void set_irn_visited(ir_node *node, ir_visited_t visited);
208 /** Sets visited to get_irg_visited(current_ir_graph). */
209 void mark_irn_visited(ir_node *node);
210 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
211 int irn_visited(const ir_node *node);
212 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). Marks the node
213 * visited, if it was not. */
214 int irn_visited_else_mark(ir_node *node);
217 * Sets the link of a node.
218 * Only allowed if the graph is NOT in phase_building.
220 void set_irn_link(ir_node *node, void *link);
222 /** Returns the link of a node. */
223 void *get_irn_link(const ir_node *node);
225 /** Returns the ir_graph this node belongs to. */
226 ir_graph *get_irn_irg(const ir_node *node);
228 /** Outputs a unique number for this node if libFIRM is compiled for
229 debugging, (configure with --enable-debug) else returns address
230 of node cast to long. */
231 long get_irn_node_nr(const ir_node *node);
233 /** Returns the pinned state of a node.
235 * Returns whether the node _always_ must be pinned.
236 * I.e., the node is not floating after global cse.
238 * @returns Either state op_pin_state_pinned or op_pin_state_floats.
240 op_pin_state get_irn_pinned(const ir_node *node);
242 /** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
243 void set_irn_pinned(ir_node *node, op_pin_state state);
245 /** Returns whether the node is currently pinned.
247 * If get_irn_pinned returns op_pin_state_floats and the graph the
248 * node belongs to is in state op_poin_state_floats then this function
249 * returns 'floats', else 'pinned'.
251 op_pin_state is_irn_pinned_in_irg(const ir_node *node);
254 * IR node constructor.
255 * Create a new IR node in irg, with an op, mode, arity and
256 * some incoming IR nodes.
257 * This constructor is used in every specific IR node constructor.
259 * @param db Debug info.
260 * @param irg IR-graph on with this new node should be constructed.
261 * @param block The block the new node belongs to
262 * @param op The opcode of the new node.
263 * @param mode The mode of the new node.
264 * @param arity The arity of the new node, <0 if can be changed dynamically.
265 * @param in An array of arity predecessor nodes.
268 new_ir_node(dbg_info *db,
277 * Return the block the node belongs to. This is only
278 * possible for pinned nodes or if the graph is in pinned state.
279 * Otherwise the block may be incorrect. This condition is
280 * now checked by an assertion.
282 * This works for all except Block. It can return Blocks or the Bad node.
284 * To express the difference to access routines that work for all
285 * nodes we use infix "nodes" and do not name this function
286 * get_irn_block(). */
287 ir_node *get_nodes_block (const ir_node *node);
289 /** Sets the Block of a node. */
290 void set_nodes_block (ir_node *node, ir_node *block);
293 * Return the MacroBlock the node belongs to. This is only
294 * possible for pinned nodes or if the graph is in pinned state.
295 * Otherwise the MacroBlock may be incorrect. This condition is
296 * now checked by an assertion.
298 * This works for all except Block. It can return Blocks or the Bad node.
300 * To express the difference to access routines that work for all
301 * nodes we use infix "nodes" and do not name this function
302 * get_irn_MacroBlock(). */
303 ir_node *get_nodes_MacroBlock(const ir_node *node);
306 * Projection numbers for result of Start node: use for Proj nodes!
309 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
310 pn_Start_M, /**< Projection on the initial memory. */
311 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
312 pn_Start_P_tls, /**< Projection on the pointer to the thread local store
313 segment containing _all_thread local variables. */
314 pn_Start_T_args, /**< Projection on all arguments. */
315 pn_Start_max /**< number of projections from a Start */
316 } pn_Start; /* Projection numbers for Start. */
318 /** Test whether arbitrary node is frame pointer.
320 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
321 * from Start. If so returns frame type, else Null. */
322 ir_type *is_frame_pointer(const ir_node *n);
324 /** Test whether arbitrary node is the thread local storage (tls) pointer.
326 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
327 * from Start. If so returns tls type, else Null. */
328 ir_type *is_tls_pointer(const ir_node *n);
330 /** Return the number of control flow predecessors of a block. */
331 int get_Block_n_cfgpreds(const ir_node *block);
332 /** Return the control flow predecessor of a block at a given position. */
333 ir_node *get_Block_cfgpred(const ir_node *block, int pos);
334 /** Set the control flow predecessor of a block at a given position. */
335 void set_Block_cfgpred(ir_node *block, int pos, ir_node *pred);
338 * Return the position of the predecessor block pred in the inputs
339 * of the block block.
341 * @param block the block
342 * @param pred a predecessor block of block
344 * @return the position of pred in block or -1
346 * @note When using the old extended basic block form for blocks
347 * with exception exists, a predecessor block might have more
348 * than one position. In that case it is not specified, with is returned.
350 int get_Block_cfgpred_pos(const ir_node *block, const ir_node *pred);
352 /** Get the predecessor block.
354 * Returns the block corresponding to the predecessor pos of block.
356 * There are several ambiguities we resolve with this function:
357 * - The direct predecessor can be a Proj, which is not pinned.
358 * We walk from the predecessor to the next pinned node
359 * (skip_Proj) and return the block that node is in.
360 * - If we encounter the Bad node, this function does not return
361 * Start block, but the Bad node.
363 ir_node *get_Block_cfgpred_block(const ir_node *node, int pos);
365 /** Return the matured flag of a block */
366 int get_Block_matured(const ir_node *block);
367 /** set the matured flag of a block. */
368 void set_Block_matured(ir_node *block, int matured);
370 /** A visited flag only for block nodes.
371 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
372 ir_visited_t get_Block_block_visited(const ir_node *block);
373 void set_Block_block_visited(ir_node *block, ir_visited_t visit);
376 * Marks a block as dead but do not replace it with a Bad node.
377 * Dead blocks are removed in the con
379 ir_node *set_Block_dead(ir_node *block);
380 int is_Block_dead(const ir_node *block);
382 /* For this current_ir_graph must be set. */
383 void mark_Block_block_visited(ir_node *node);
384 int Block_block_visited(const ir_node *node);
386 #ifdef INTERPROCEDURAL_VIEW
387 /* Set and remove interprocedural predecessors. If the interprocedural
388 * predecessors are removed, the node has the same predecessors in
390 * @@@ Maybe better: arity is zero if no cg preds. */
391 void set_Block_cg_cfgpred_arr(ir_node *node, int arity, ir_node *in[]);
392 void set_Block_cg_cfgpred(ir_node *node, int pos, ir_node *pred);
393 /* @@@ not supported */
394 ir_node **get_Block_cg_cfgpred_arr(ir_node *node);
395 /** Returns the number of interprocedural predecessors. 0 if none. */
396 int get_Block_cg_n_cfgpreds(const ir_node *node);
397 /** Return the interprocedural predecessor at position pos. */
398 ir_node *get_Block_cg_cfgpred(const ir_node *node, int pos);
399 /** Frees the memory allocated for interprocedural predecessors. */
400 void remove_Block_cg_cfgpred_arr(ir_node *node);
403 /** Returns the extended basic block a block belongs to. */
404 ir_extblk *get_Block_extbb(const ir_node *block);
405 /** Sets the extended basic block a block belongs to. */
406 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
407 /** Get the Macro Block header of a (sub-) block. */
408 ir_node *get_Block_MacroBlock(const ir_node *block);
409 /** Set the Macro Block header of a (sub-) block. */
410 void set_Block_MacroBlock(ir_node *block, ir_node *mbh);
411 /** Get the Macro Block header of a node. */
412 ir_node *get_irn_MacroBlock(const ir_node *n);
413 /** Returns the ir_graph this Block belongs to. */
414 ir_graph *get_Block_irg(const ir_node *block);
415 /** Returns non-zero if the block has an entity assigned */
416 int has_Block_entity(const ir_node *block);
417 /** Returns the entity for a Block */
418 ir_entity *get_Block_entity(const ir_node *block);
419 /** Returns the entity for a Block (creating it if necessary) */
420 ir_entity *create_Block_entity(ir_node *block);
421 /** Set a new entity for a block */
422 void set_Block_entity(ir_node *block, ir_entity *entity);
423 /** Gets the head of the Phi list for this block. */
424 ir_node *get_Block_phis(const ir_node *block);
425 /** Sets the head of the Phi list for this block. */
426 void set_Block_phis(ir_node *block, ir_node *phi);
427 /** Add a Phi node to the list of Block Phi's. */
428 void add_Block_phi(ir_node *block, ir_node *phi);
429 /** Get the Block mark (single bit). */
430 unsigned get_Block_mark(const ir_node *block);
431 /** Set the Block mark (single bit). */
432 void set_Block_mark(ir_node *block, unsigned mark);
434 /** Return the number of Keep alive node. */
435 int get_End_n_keepalives(const ir_node *end);
436 /** Return the Keep alive node a position pos. */
437 ir_node *get_End_keepalive(const ir_node *end, int pos);
438 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
439 void add_End_keepalive(ir_node *end, ir_node *ka);
440 /** Set the Keep alive node at position pos. */
441 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
444 * Set new keep-alives.
445 * Beware: This might be an expensive operation if dynamic edges are enabled,
446 * so avoid it in the backend.
448 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
450 /** Remove irn from the keep-alive set. */
451 void remove_End_keepalive(ir_node *end, ir_node *irn);
453 /* Remove Bads, NoMem and doublets from the keep-alive set. */
454 void remove_End_Bads_and_doublets(ir_node *end);
456 /** Some parts of the End node are allocated separately -- their memory
457 is not recovered by dead_node_elimination if a End node is dead.
458 free_End() frees these data structures. */
459 void free_End(ir_node *end);
461 /** Return the target address of an IJmp */
462 ir_node *get_IJmp_target(const ir_node *ijmp);
463 /** Sets the target address of an IJmp */
464 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
466 /* We distinguish three kinds of Cond nodes. These can be distinguished
467 by the mode of the selector operand and an internal flag of type cond_kind.
468 First we distinguish binary Conds and switch Conds.
469 A binary Cond has as selector a boolean value. Proj(0) projects the control
470 flow for case "False", Proj(1) the control flow for "True". A binary Cond
471 is recognized by the boolean selector.
472 The switch Cond has as selector an unsigned integer. It produces as result
473 an n+1 Tuple (cf0, ... , cfn) of control flows.
474 We differ two flavors of this Cond. The first, the dense Cond, passes
475 control along output i if the selector value is i, 0 <= i <= n. If the
476 selector value is >n it passes control along output n.
477 The second Cond flavor differences in the treatment of cases not specified in
478 the source program. It magically knows about the existence of Proj nodes.
479 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
480 exists. Else it passes control along output n (even if this Proj does not
481 exist.) This Cond we call "fragmentary". There is a special constructor
482 new_defaultProj that automatically sets the flavor.
483 The two switch flavors are distinguished by a flag of type cond_kind.
484 Default flavor is "dense"
487 dense, /**< Default. Missing Proj nodes are dead control flow. */
488 fragmentary /**< Special. No control flow optimizations allowed. Missing
489 Proj nodes mean default control flow, i.e., Proj(n). */
492 /** Gets the string representation of the Cond node kind. */
493 const char *get_cond_kind_name(cond_kind kind);
495 ir_node *get_Cond_selector(const ir_node *node);
496 void set_Cond_selector(ir_node *node, ir_node *selector);
497 cond_kind get_Cond_kind(const ir_node *node);
498 void set_Cond_kind(ir_node *node, cond_kind kind);
499 long get_Cond_default_proj(const ir_node *node);
500 void set_Cond_default_proj(ir_node *node, long defproj);
503 * Projection numbers for conditions.
506 pn_Cond_false, /**< Control flow if operand is "false". */
507 pn_Cond_true, /**< Control flow if operand is "true". */
508 pn_Cond_max /**< number of projections from a Cond */
509 } pn_Cond; /* Projection numbers for Cond. */
511 ir_node *get_Return_mem(const ir_node *node);
512 void set_Return_mem(ir_node *node, ir_node *mem);
513 ir_node **get_Return_res_arr(ir_node *node);
514 int get_Return_n_ress(const ir_node *node);
515 ir_node *get_Return_res(const ir_node *node, int pos);
516 void set_Return_res(ir_node *node, int pos, ir_node *res);
518 tarval *get_Const_tarval(const ir_node *node);
519 void set_Const_tarval(ir_node *node, tarval *con);
521 /** Return non-zero if the given Const node represents the 0 constant. */
522 int is_Const_null(const ir_node *node);
524 /** Return non-zero if the given Const node represents the 1 constant. */
525 int is_Const_one(const ir_node *node);
527 /** Return non-zero if the given Const node represents the constant with all bits set. */
528 int is_Const_all_one(const ir_node *node);
530 /** Returns the source language type of a Const node.
531 * Must be an atomic type. Mode of type must be mode of node.
533 ir_type *get_Const_type(ir_node *node);
535 /** Sets the source language type of a Const node. */
536 void set_Const_type(ir_node *node, ir_type *tp);
538 /** Returns non-zero if s symconst kind has a type attribute */
539 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
541 /** Returns non-zero if s symconst kind has an ident attribute */
542 #define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)
544 /** Returns non-zero if s symconst kind has an entity attribute */
545 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
547 /** Returns non-zero if s symconst kind has an enum_const attribute */
548 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
550 /** Get the kind of the SymConst. */
551 symconst_kind get_SymConst_kind(const ir_node *node);
552 /** Set the kind of the SymConst. */
553 void set_SymConst_kind(ir_node *node, symconst_kind num);
555 /** Only to access SymConst of kind type_tag or size. Else assertion: */
556 ir_type *get_SymConst_type(const ir_node *node);
557 void set_SymConst_type(ir_node *node, ir_type *tp);
559 /** Only to access SymConst of kind addr_name. Else assertion: */
560 ident *get_SymConst_name(const ir_node *node);
561 void set_SymConst_name(ir_node *node, ident *name);
563 /** Only to access SymConst of kind addr_ent. Else assertion: */
564 ir_entity *get_SymConst_entity(const ir_node *node);
565 void set_SymConst_entity(ir_node *node, ir_entity *ent);
567 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
568 ir_enum_const *get_SymConst_enum(const ir_node *node);
569 void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
571 /** Sets both: type and ptrinfo. Needed to treat the node independent of
572 its semantics. Does a memcpy for the memory sym points to. */
573 /* write 'union': firmjni then does not create a method... */
574 union symconst_symbol get_SymConst_symbol(const ir_node *node);
575 void set_SymConst_symbol(ir_node *node,
576 union symconst_symbol sym);
578 /** Access the type of the value represented by the SymConst.
580 * Example: primitive type int for SymConst size. */
581 ir_type *get_SymConst_value_type(ir_node *node);
582 void set_SymConst_value_type(ir_node *node, ir_type *tp);
584 ir_node *get_Sel_mem(const ir_node *node);
585 void set_Sel_mem(ir_node *node, ir_node *mem);
586 ir_node *get_Sel_ptr(const ir_node *node); /* ptr to the object to select from */
587 void set_Sel_ptr(ir_node *node, ir_node *ptr);
588 ir_node **get_Sel_index_arr(ir_node *node);
589 int get_Sel_n_indexs(const ir_node *node);
590 ir_node *get_Sel_index(const ir_node *node, int pos);
591 void set_Sel_index(ir_node *node, int pos, ir_node *index);
592 ir_entity *get_Sel_entity(const ir_node *node); /* entity to select */
593 void set_Sel_entity (ir_node *node, ir_entity *ent);
596 * Projection numbers for result of Call node: use for Proj nodes!
599 pn_Call_M_regular = pn_Generic_M_regular, /**< The memory result. */
600 pn_Call_X_regular = pn_Generic_X_regular, /**< The control flow result when no exception occurs. */
601 pn_Call_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler. */
602 pn_Call_T_result = pn_Generic_other, /**< The tuple containing all (0, 1, 2, ...) results. */
603 pn_Call_M_except, /**< The memory result in case the called method terminated with
605 pn_Call_P_value_res_base, /**< A pointer to the memory region containing copied results
606 passed by value (for compound result types). */
607 pn_Call_max /**< number of projections from a Call */
608 } pn_Call; /* Projection numbers for Call. */
609 #define pn_Call_M pn_Call_M_regular
611 /** Retrieve the memory input of a Call. */
612 ir_node *get_Call_mem(const ir_node *node);
613 /** Set the memory input of a Call. */
614 void set_Call_mem(ir_node *node, ir_node *mem);
615 /** Retrieve the call address of a Call. */
616 ir_node *get_Call_ptr(const ir_node *node);
617 /** Set the call address of a Call. */
618 void set_Call_ptr(ir_node *node, ir_node *ptr);
619 ir_node **get_Call_param_arr(ir_node *node);
620 /** Gets the number of parameters of a call. */
621 int get_Call_n_params(const ir_node *node);
622 /** Gets the call parameter at position pos. */
623 ir_node *get_Call_param(const ir_node *node, int pos);
624 /** Sets the call parameter at position pos. */
625 void set_Call_param(ir_node *node, int pos, ir_node *param);
626 /** Gets the type of a call. */
627 ir_type *get_Call_type(ir_node *node);
628 /** Sets the type of a call. */
629 void set_Call_type(ir_node *node, ir_type *tp);
632 * Returns non-zero if a Call is surely a self-recursive Call.
633 * Beware: if this functions returns 0, the call might be self-recursive!
635 int is_self_recursive_Call(const ir_node *call);
637 /** Set, get and remove the callee information for a Call node.
639 * The callee information lists all method entities that can be called
640 * from this node. If the address expression can not be analyzed fully,
641 * e.g., as entities can be called that are not in the compilation unit,
642 * the array contains the unknown_entity. The array contains only entities
643 * with peculiarity_existent, but with all kinds of visibility. The entities
644 * not necessarily contain an irg.
646 * The array is only accessible if callee information is valid. See flag
649 * The memory allocated for the array is managed automatically, i.e., it must
650 * not be freed if the Call node is removed from the graph.
652 * @param node A Call node.
654 int Call_has_callees(const ir_node *node);
655 int get_Call_n_callees(const ir_node *node);
656 ir_entity *get_Call_callee(const ir_node *node, int pos);
658 /** Set the full callee array.
660 * The passed array is copied. Assumes current_ir_graph set properly! */
661 void set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
662 void remove_Call_callee_arr(ir_node *node);
665 * Projection numbers for result of Builtin node: use for Proj nodes!
668 pn_Builtin_M = pn_Generic_M_regular, /**< The memory result. */
669 pn_Builtin_1_result = pn_Generic_other, /**< first result. */
670 pn_Builtin_max /**< number of projections from a Builtin */
671 } pn_Builtin; /* Projection numbers for Builtin. */
673 ir_node *get_Builtin_mem(const ir_node *node);
674 void set_Builtin_mem(ir_node *node, ir_node *mem);
675 ir_builtin_kind get_Builtin_kind(const ir_node *node);
676 void set_Builtin_kind(ir_node *node, ir_builtin_kind kind);
677 ir_node **get_Builtin_param_arr(ir_node *node);
678 /** Gets the number of parameters of a Builtin. */
679 int get_Builtin_n_params(const ir_node *node);
680 /** Gets the Builtin parameter at position pos. */
681 ir_node *get_Builtin_param(const ir_node *node, int pos);
682 /** Sets the Builtin parameter at position pos. */
683 void set_Builtin_param(ir_node *node, int pos, ir_node *param);
684 /** Gets the type of a builtin. */
685 ir_type *get_Builtin_type(ir_node *node);
686 /** Sets the type of a Builtin. */
687 void set_Builtin_type(ir_node *node, ir_type *tp);
688 /** Returns a human readable string for the ir_builtin_kind. */
689 const char *get_builtin_kind_name(ir_builtin_kind kind);
691 /** Retrieve the call address of a CallBegin. */
692 ir_node *get_CallBegin_ptr(const ir_node *node);
693 /** Set the call address of a CallBegin. */
694 void set_CallBegin_ptr(ir_node *node, ir_node *ptr);
695 /** Retrieve the original Call node of a CallBegin. */
696 ir_node *get_CallBegin_call(const ir_node *node);
697 /** Set the original Call node of a CallBegin. */
698 void set_CallBegin_call(ir_node *node, ir_node *call);
700 /* For unary and binary arithmetic operations the access to the
701 operands can be factored out. Left is the first, right the
702 second arithmetic value as listed in tech report 1999-44.
703 unops are: Minus, Abs, Not, Conv, Cast
704 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
705 Shr, Shrs, Rotl, Cmp */
706 int is_unop(const ir_node *node);
707 ir_node *get_unop_op(const ir_node *node);
708 void set_unop_op(ir_node *node, ir_node *op);
709 int is_binop(const ir_node *node);
710 ir_node *get_binop_left(const ir_node *node);
711 void set_binop_left(ir_node *node, ir_node *left);
712 ir_node *get_binop_right(const ir_node *node);
713 void set_binop_right(ir_node *node, ir_node *right);
715 ir_node *get_Add_left(const ir_node *node);
716 void set_Add_left(ir_node *node, ir_node *left);
717 ir_node *get_Add_right(const ir_node *node);
718 void set_Add_right(ir_node *node, ir_node *right);
720 ir_node *get_Carry_left(const ir_node *node);
721 void set_Carry_left(ir_node *node, ir_node *left);
722 ir_node *get_Carry_right(const ir_node *node);
723 void set_Carry_right(ir_node *node, ir_node *right);
725 ir_node *get_Borrow_left(const ir_node *node);
726 void set_Borrow_left(ir_node *node, ir_node *left);
727 ir_node *get_Borrow_right(const ir_node *node);
728 void set_Borrow_right(ir_node *node, ir_node *right);
730 ir_node *get_Sub_left(const ir_node *node);
731 void set_Sub_left(ir_node *node, ir_node *left);
732 ir_node *get_Sub_right(const ir_node *node);
733 void set_Sub_right(ir_node *node, ir_node *right);
735 ir_node *get_Minus_op(const ir_node *node);
736 void set_Minus_op(ir_node *node, ir_node *op);
738 ir_node *get_Mul_left(const ir_node *node);
739 void set_Mul_left(ir_node *node, ir_node *left);
740 ir_node *get_Mul_right(const ir_node *node);
741 void set_Mul_right(ir_node *node, ir_node *right);
743 ir_node *get_Mulh_left(const ir_node *node);
744 void set_Mulh_left(ir_node *node, ir_node *left);
745 ir_node *get_Mulh_right(const ir_node *node);
746 void set_Mulh_right(ir_node *node, ir_node *right);
748 ir_node *get_Quot_left(const ir_node *node);
749 void set_Quot_left(ir_node *node, ir_node *left);
750 ir_node *get_Quot_right(const ir_node *node);
751 void set_Quot_right(ir_node *node, ir_node *right);
752 ir_node *get_Quot_mem(const ir_node *node);
753 void set_Quot_mem(ir_node *node, ir_node *mem);
754 ir_mode *get_Quot_resmode(const ir_node *node);
755 void set_Quot_resmode(ir_node *node, ir_mode *mode);
758 * Projection numbers for Quot: use for Proj nodes!
761 pn_Quot_M = pn_Generic_M_regular, /**< Memory result. */
762 pn_Quot_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
763 pn_Quot_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
764 pn_Quot_res = pn_Generic_other, /**< Result of computation. */
765 pn_Quot_max /**< number of projections from a Quot */
766 } pn_Quot; /* Projection numbers for Quot. */
768 ir_node *get_DivMod_left(const ir_node *node);
769 void set_DivMod_left(ir_node *node, ir_node *left);
770 ir_node *get_DivMod_right(const ir_node *node);
771 void set_DivMod_right(ir_node *node, ir_node *right);
772 ir_node *get_DivMod_mem(const ir_node *node);
773 void set_DivMod_mem(ir_node *node, ir_node *mem);
774 ir_mode *get_DivMod_resmode(const ir_node *node);
775 void set_DivMod_resmode(ir_node *node, ir_mode *mode);
778 * Projection numbers for DivMod: use for Proj nodes!
781 pn_DivMod_M = pn_Generic_M_regular, /**< Memory result. */
782 pn_DivMod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
783 pn_DivMod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
784 pn_DivMod_res_div = pn_Generic_other, /**< Result of computation a / b. */
785 pn_DivMod_res_mod, /**< Result of computation a % b. */
786 pn_DivMod_max /**< number of projections from a DivMod */
787 } pn_DivMod; /* Projection numbers for DivMod. */
789 ir_node *get_Div_left(const ir_node *node);
790 void set_Div_left(ir_node *node, ir_node *left);
791 ir_node *get_Div_right(const ir_node *node);
792 void set_Div_right(ir_node *node, ir_node *right);
793 ir_node *get_Div_mem(const ir_node *node);
794 void set_Div_mem(ir_node *node, ir_node *mem);
795 ir_mode *get_Div_resmode(const ir_node *node);
796 void set_Div_resmode(ir_node *node, ir_mode *mode);
797 int get_Div_no_remainder(const ir_node *node);
798 void set_Div_no_remainder(ir_node *node, int no_remainder);
801 * Projection numbers for Div: use for Proj nodes!
804 pn_Div_M = pn_Generic_M_regular, /**< Memory result. */
805 pn_Div_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
806 pn_Div_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
807 pn_Div_res = pn_Generic_other, /**< Result of computation. */
808 pn_Div_max /**< number of projections from a Div */
809 } pn_Div; /* Projection numbers for Div. */
811 ir_node *get_Mod_left(const ir_node *node);
812 void set_Mod_left(ir_node *node, ir_node *left);
813 ir_node *get_Mod_right(const ir_node *node);
814 void set_Mod_right(ir_node *node, ir_node *right);
815 ir_node *get_Mod_mem(const ir_node *node);
816 void set_Mod_mem(ir_node *node, ir_node *mem);
817 ir_mode *get_Mod_resmode(const ir_node *node);
818 void set_Mod_resmode(ir_node *node, ir_mode *mode);
821 * Projection numbers for Mod: use for Proj nodes!
824 pn_Mod_M = pn_Generic_M_regular, /**< Memory result. */
825 pn_Mod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
826 pn_Mod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
827 pn_Mod_res = pn_Generic_other, /**< Result of computation. */
828 pn_Mod_max /**< number of projections from a Mod */
829 } pn_Mod; /* Projection numbers for Mod. */
831 ir_node *get_Abs_op(const ir_node *node);
832 void set_Abs_op(ir_node *node, ir_node *op);
834 ir_node *get_And_left(const ir_node *node);
835 void set_And_left(ir_node *node, ir_node *left);
836 ir_node *get_And_right(const ir_node *node);
837 void set_And_right(ir_node *node, ir_node *right);
839 ir_node *get_Or_left(const ir_node *node);
840 void set_Or_left(ir_node *node, ir_node *left);
841 ir_node *get_Or_right(const ir_node *node);
842 void set_Or_right(ir_node *node, ir_node *right);
844 ir_node *get_Eor_left(const ir_node *node);
845 void set_Eor_left(ir_node *node, ir_node *left);
846 ir_node *get_Eor_right(const ir_node *node);
847 void set_Eor_right(ir_node *node, ir_node *right);
849 ir_node *get_Not_op(const ir_node *node);
850 void set_Not_op(ir_node *node, ir_node *op);
852 /** returns the pnc name from an pnc constant */
853 const char *get_pnc_string(int pnc);
855 /** Calculates the negated (Complement(R)) pnc condition. */
856 pn_Cmp get_negated_pnc(long pnc, ir_mode *mode);
858 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
859 pn_Cmp get_inversed_pnc(long pnc);
861 /** An alternative name for get_inversed_pnc() that can be better memorized. */
862 #define get_mirrored_pnc(pnc) get_inversed_pnc(pnc)
864 ir_node *get_Cmp_left(const ir_node *node);
865 void set_Cmp_left(ir_node *node, ir_node *left);
866 ir_node *get_Cmp_right(const ir_node *node);
867 void set_Cmp_right(ir_node *node, ir_node *right);
869 ir_node *get_Shl_left(const ir_node *node);
870 void set_Shl_left(ir_node *node, ir_node *left);
871 ir_node *get_Shl_right(const ir_node *node);
872 void set_Shl_right(ir_node *node, ir_node *right);
874 ir_node *get_Shr_left(const ir_node *node);
875 void set_Shr_left(ir_node *node, ir_node *left);
876 ir_node *get_Shr_right(const ir_node *node);
877 void set_Shr_right(ir_node *node, ir_node *right);
879 ir_node *get_Shrs_left(const ir_node *node);
880 void set_Shrs_left(ir_node *node, ir_node *left);
881 ir_node *get_Shrs_right(const ir_node *node);
882 void set_Shrs_right(ir_node *node, ir_node *right);
884 ir_node *get_Rotl_left(const ir_node *node);
885 void set_Rotl_left(ir_node *node, ir_node *left);
886 ir_node *get_Rotl_right(const ir_node *node);
887 void set_Rotl_right(ir_node *node, ir_node *right);
889 ir_node *get_Conv_op(const ir_node *node);
890 void set_Conv_op(ir_node *node, ir_node *op);
891 int get_Conv_strict(const ir_node *node);
892 void set_Conv_strict(ir_node *node, int flag);
894 /* Does Cast need a mem operator?
895 * Cast should only depend on the type, not on the state of an
896 * entity. But: we initialize various fields after Alloc, that
897 * are accessed in the cast. This required some precaution, to
898 * get the right memory into the Loads generated from the cast.
900 ir_node *get_Cast_op(const ir_node *node);
901 void set_Cast_op(ir_node *node, ir_node *op);
902 ir_type *get_Cast_type(ir_node *node);
903 void set_Cast_type(ir_node *node, ir_type *to_tp);
905 /** Checks for upcast.
907 * Returns true if the Cast node casts a class type to a super type.
908 * Works also for pointers to classes (recursively).
910 * Needs typeinfo calculated.
912 int is_Cast_upcast(ir_node *node);
914 /** Checks for downcast.
916 * Returns true if the Cast node casts a class type to a sub type.
917 * Works also for pointers to classes (recursively).
919 * Needs typeinfo calculated.
921 int is_Cast_downcast(ir_node *node);
924 /** Returns true if n is a Phi or a Filter node in INTER-procedural view.
925 Returns false if irg is in phase phase_building and the Phi has zero
926 predecessors: it's a Phi0. */
927 int is_Phi(const ir_node *n);
928 /** Returns true if irg in phase phase_building and the Phi has zero
929 predecessors. It's a Phi0 then. */
930 int is_Phi0(const ir_node *n);
931 /* These routines also work for Filter nodes in INTER-procedural view. */
932 ir_node **get_Phi_preds_arr(ir_node *node);
933 int get_Phi_n_preds(const ir_node *node);
934 ir_node *get_Phi_pred(const ir_node *node, int pos);
935 void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
936 ir_node *get_Phi_next(const ir_node *phi);
937 void set_Phi_next(ir_node *phi, ir_node *next);
939 ir_node *get_Filter_pred(ir_node *node);
940 void set_Filter_pred(ir_node *node, ir_node *pred);
941 long get_Filter_proj(ir_node *node);
942 void set_Filter_proj(ir_node *node, long proj);
943 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
944 * @@@ Maybe better: arity is zero if no cg preds. */
945 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
946 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
947 int get_Filter_n_cg_preds(ir_node *node);
948 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
950 /** Return true if parameter is a memory operation.
952 * A memory operation is an operation that changes the
953 * memory. I.e., a Load or a Store operation.
955 int is_memop(const ir_node *node);
956 ir_node *get_memop_mem(const ir_node *node);
957 void set_memop_mem(ir_node *node, ir_node *mem);
958 ir_node *get_memop_ptr(const ir_node *node);
959 void set_memop_ptr(ir_node *node, ir_node *ptr);
962 * Projection numbers for Load: use for Proj nodes!
965 pn_Load_M = pn_Generic_M_regular, /**< Memory result. */
966 pn_Load_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
967 pn_Load_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
968 pn_Load_res = pn_Generic_other, /**< Result of load operation. */
969 pn_Load_max /**< number of projections from a Load */
970 } pn_Load; /* Projection numbers for Load. */
972 ir_node *get_Load_mem(const ir_node *node);
973 void set_Load_mem(ir_node *node, ir_node *mem);
974 ir_node *get_Load_ptr(const ir_node *node);
975 void set_Load_ptr(ir_node *node, ir_node *ptr);
976 ir_mode *get_Load_mode(const ir_node *node);
977 void set_Load_mode(ir_node *node, ir_mode *mode);
978 ir_volatility get_Load_volatility(const ir_node *node);
979 void set_Load_volatility(ir_node *node, ir_volatility volatility);
980 ir_align get_Load_align(const ir_node *node);
981 void set_Load_align(ir_node *node, ir_align align);
984 * Projection numbers for Store: use for Proj nodes!
987 pn_Store_M = pn_Generic_M_regular, /**< Memory result. */
988 pn_Store_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
989 pn_Store_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
990 pn_Store_max = pn_Generic_other /**< number of projections from a Store */
991 } pn_Store; /* Projection numbers for Store. */
993 ir_node *get_Store_mem(const ir_node *node);
994 void set_Store_mem(ir_node *node, ir_node *mem);
995 ir_node *get_Store_ptr(const ir_node *node);
996 void set_Store_ptr(ir_node *node, ir_node *ptr);
997 ir_node *get_Store_value(const ir_node *node);
998 void set_Store_value(ir_node *node, ir_node *value);
999 ir_volatility get_Store_volatility(const ir_node *node);
1000 void set_Store_volatility(ir_node *node, ir_volatility volatility);
1001 ir_align get_Store_align(const ir_node *node);
1002 void set_Store_align(ir_node *node, ir_align align);
1005 * Projection numbers for Alloc: use for Proj nodes!
1008 pn_Alloc_M = pn_Generic_M_regular, /**< Memory result. */
1009 pn_Alloc_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1010 pn_Alloc_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
1011 pn_Alloc_res = pn_Generic_other, /**< Result of allocation. */
1012 pn_Alloc_max /**< number of projections from an Alloc */
1013 } pn_Alloc; /* Projection numbers for Alloc. */
1015 ir_node *get_Alloc_mem(const ir_node *node);
1016 void set_Alloc_mem(ir_node *node, ir_node *mem);
1017 ir_node *get_Alloc_size(const ir_node *node);
1018 void set_Alloc_size(ir_node *node, ir_node *size);
1019 ir_type *get_Alloc_type(ir_node *node);
1020 void set_Alloc_type(ir_node *node, ir_type *tp);
1022 ir_where_alloc get_Alloc_where(const ir_node *node);
1023 void set_Alloc_where(ir_node *node, ir_where_alloc where);
1025 ir_node *get_Free_mem(const ir_node *node);
1026 void set_Free_mem(ir_node *node, ir_node *mem);
1027 ir_node *get_Free_ptr(const ir_node *node);
1028 void set_Free_ptr(ir_node *node, ir_node *ptr);
1029 ir_node *get_Free_size(const ir_node *node);
1030 void set_Free_size(ir_node *node, ir_node *size);
1031 ir_type *get_Free_type(ir_node *node);
1032 void set_Free_type(ir_node *node, ir_type *tp);
1034 ir_where_alloc get_Free_where(const ir_node *node);
1035 void set_Free_where(ir_node *node, ir_where_alloc where);
1037 ir_node **get_Sync_preds_arr(ir_node *node);
1038 int get_Sync_n_preds(const ir_node *node);
1039 ir_node *get_Sync_pred(const ir_node *node, int pos);
1040 void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
1041 void add_Sync_pred(ir_node *node, ir_node *pred);
1043 /** Returns the source language type of a Proj node.
1044 * Must be an atomic type. Mode of type must be mode of node.
1046 ir_type *get_Proj_type(ir_node *node);
1048 /** Return the predecessor of a Proj node. */
1049 ir_node *get_Proj_pred(const ir_node *node);
1050 void set_Proj_pred(ir_node *node, ir_node *pred);
1051 /** Return the projection number of a Proj node. */
1052 long get_Proj_proj(const ir_node *node);
1053 void set_Proj_proj(ir_node *node, long proj);
1056 * Returns non-zero if a node is a routine parameter.
1058 * @param node the Proj node to test
1060 int is_arg_Proj(const ir_node *node);
1062 ir_node **get_Tuple_preds_arr(ir_node *node);
1063 int get_Tuple_n_preds(const ir_node *node);
1064 ir_node *get_Tuple_pred(const ir_node *node, int pos);
1065 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
1067 ir_node *get_Id_pred(const ir_node *node);
1068 void set_Id_pred(ir_node *node, ir_node *pred);
1070 /** Confirm has a single result and returns 'value' unchanged.
1071 * The node expresses a restriction on 'value':
1072 * 'value' 'cmp' 'bound' == true. */
1073 ir_node *get_Confirm_value(const ir_node *node);
1074 void set_Confirm_value(ir_node *node, ir_node *value);
1075 ir_node *get_Confirm_bound(const ir_node *node);
1076 void set_Confirm_bound(ir_node *node, ir_node *bound);
1077 pn_Cmp get_Confirm_cmp(const ir_node *node);
1078 void set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
1083 ir_node *get_Mux_sel(const ir_node *node);
1084 void set_Mux_sel(ir_node *node, ir_node *sel);
1085 ir_node *get_Mux_false(const ir_node *node);
1086 void set_Mux_false(ir_node *node, ir_node *ir_false);
1087 ir_node *get_Mux_true(const ir_node *node);
1088 void set_Mux_true(ir_node *node, ir_node *ir_true);
1091 * Projection numbers for result of CopyB node: use for Proj nodes!
1094 pn_CopyB_M_regular = pn_Generic_M_regular, /**< The memory result. */
1095 pn_CopyB_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1096 pn_CopyB_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1097 pn_CopyB_M_except = pn_Generic_other, /**< The memory result in case the runtime function terminated with
1099 pn_CopyB_max /**< number of projections from a CopyB */
1100 } pn_CopyB; /* Projection numbers for CopyB. */
1101 #define pn_CopyB_M pn_CopyB_M_regular
1103 ir_node *get_CopyB_mem(const ir_node *node);
1104 void set_CopyB_mem(ir_node *node, ir_node *mem);
1105 ir_node *get_CopyB_dst(const ir_node *node);
1106 void set_CopyB_dst(ir_node *node, ir_node *dst);
1107 ir_node *get_CopyB_src(const ir_node *node);
1108 void set_CopyB_src(ir_node *node, ir_node *src);
1109 ir_type *get_CopyB_type(ir_node *node);
1110 void set_CopyB_type(ir_node *node, ir_type *data_type);
1113 * Projection numbers for result of InstOf node: use for Proj nodes!
1116 pn_InstOf_M_regular = pn_Generic_M_regular, /**< The memory result. */
1117 pn_InstOf_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1118 pn_InstOf_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1119 pn_InstOf_res = pn_Generic_other, /**< The checked object pointer. */
1120 pn_InstOf_M_except, /**< The memory result in case the runtime function terminated with
1122 pn_InstOf_max /**< number of projections from an InstOf */
1124 #define pn_InstOf_M pn_InstOf_M_regular
1126 /** InstOf access. */
1127 ir_type *get_InstOf_type(ir_node *node);
1128 void set_InstOf_type(ir_node *node, ir_type *type);
1129 ir_node *get_InstOf_store(const ir_node *node);
1130 void set_InstOf_store(ir_node *node, ir_node *obj);
1131 ir_node *get_InstOf_obj(const ir_node *node);
1132 void set_InstOf_obj(ir_node *node, ir_node *obj);
1135 * Projection numbers for Raise.
1138 pn_Raise_M = pn_Generic_M_regular, /**< The Memory result. */
1139 pn_Raise_X = pn_Generic_X_regular, /**< The control flow to the exception handler. */
1140 pn_Raise_max /**< number of projections from a Raise */
1141 } pn_Raise; /* Projection numbers for Raise. */
1143 ir_node *get_Raise_mem(const ir_node *node);
1144 void set_Raise_mem(ir_node *node, ir_node *mem);
1145 ir_node *get_Raise_exo_ptr(const ir_node *node); /* PoinTeR to EXception Object */
1146 void set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
1149 * Projection numbers for result of Bound node: use for Proj nodes!
1152 pn_Bound_M = pn_Generic_M_regular, /**< The memory result. */
1153 pn_Bound_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1154 pn_Bound_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1155 pn_Bound_res = pn_Generic_other, /**< The checked index. */
1156 pn_Bound_max /**< number of projections from a Bound */
1159 /** Returns the memory input of a Bound operation. */
1160 ir_node *get_Bound_mem(const ir_node *bound);
1161 void set_Bound_mem(ir_node *bound, ir_node *mem);
1163 /** Returns the index input of a Bound operation. */
1164 ir_node *get_Bound_index(const ir_node *bound);
1165 void set_Bound_index(ir_node *bound, ir_node *idx);
1167 /** Returns the lower bound input of a Bound operation. */
1168 ir_node *get_Bound_lower(const ir_node *bound);
1169 void set_Bound_lower(ir_node *bound, ir_node *lower);
1171 /** Returns the upper bound input of a Bound operation. */
1172 ir_node *get_Bound_upper(const ir_node *bound);
1173 void set_Bound_upper(ir_node *bound, ir_node *upper);
1175 /** Return the operand of a Pin node. */
1176 ir_node *get_Pin_op(const ir_node *pin);
1177 void set_Pin_op(ir_node *pin, ir_node *node);
1179 /** Return the assembler text of an ASM pseudo node. */
1180 ident *get_ASM_text(const ir_node *node);
1181 /** Return the number of input constraints for an ASM node. */
1182 int get_ASM_n_input_constraints(const ir_node *node);
1183 /** Return the input constraints for an ASM node. */
1184 const ir_asm_constraint *get_ASM_input_constraints(const ir_node *node);
1185 /** Return the number of output constraints for an ASM node. */
1186 int get_ASM_n_output_constraints(const ir_node *node);
1187 /** Return the output constraints for an ASM node. */
1188 const ir_asm_constraint *get_ASM_output_constraints(const ir_node *node);
1189 /** Return the number of clobbered registers for an ASM node. */
1190 int get_ASM_n_clobbers(const ir_node *node);
1191 /** Return the list of clobbered registers for an ASM node. */
1192 ident **get_ASM_clobbers(const ir_node *node);
1196 * NAME Auxiliary routines
1200 /** Returns operand of node if node is a Proj. */
1201 ir_node *skip_Proj(ir_node *node);
1202 /** Returns operand of node if node is a Proj. */
1203 const ir_node *skip_Proj_const(const ir_node *node);
1204 /** Returns operand of node if node is a Id. */
1205 ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
1206 /** Returns corresponding operand of Tuple if node is a Proj from
1208 ir_node *skip_Tuple(ir_node *node);
1209 /** Returns operand of node if node is a Cast. */
1210 ir_node *skip_Cast(ir_node *node);
1211 const ir_node *skip_Cast_const(const ir_node *node);
1212 /** Returns operand of node if node is a Pin. */
1213 ir_node *skip_Pin(ir_node *node);
1214 /** Returns operand of node if node is a Confirm */
1215 ir_node *skip_Confirm(ir_node *node);
1216 /** Skip all high-level Operations (including Cast, Confirm). */
1217 ir_node *skip_HighLevel_ops(ir_node *node);
1218 /** Returns true if irn is a Const node. */
1219 int is_Const(const ir_node *node);
1220 /** Returns true if a node is a Conv node. */
1221 int is_Conv(const ir_node *node);
1222 /** Returns true if a node is a strictConv node. */
1223 int is_strictConv(const ir_node *node);
1224 /** Returns true if a node is a Cast node. */
1225 int is_Cast(const ir_node *node);
1226 /** Returns true if node is a Bad node. */
1227 int is_Bad(const ir_node *node);
1228 /** Returns true if node is a NoMem node. */
1229 int is_NoMem(const ir_node *node);
1230 /** Returns true if node is a Start node. */
1231 int is_Start(const ir_node *node);
1232 /** Returns true if node is a Minus node. */
1233 int is_Minus(const ir_node *node);
1234 /** Returns true if node is a Abs node. */
1235 int is_Abs(const ir_node *node);
1236 /** Returns true if node is a Mod node. */
1237 int is_Mod(const ir_node *node);
1238 /** Returns true if node is a Div node. */
1239 int is_Div(const ir_node *node);
1240 /** Returns true if node is a DivMod node. */
1241 int is_DivMod(const ir_node *node);
1242 /** Returns true if node is a Quot node. */
1243 int is_Quot(const ir_node *node);
1244 /** Returns true if node is an Add node. */
1245 int is_Add(const ir_node *node);
1246 /** Returns true if node is a Carry node. */
1247 int is_Carry(const ir_node *node);
1248 /** Returns true if node is an And node. */
1249 int is_And(const ir_node *node);
1250 /** Returns true if node is an Or node. */
1251 int is_Or(const ir_node *node);
1252 /** Returns true if node is an Eor node. */
1253 int is_Eor(const ir_node *node);
1254 /** Returns true if node is a Sub node. */
1255 int is_Sub(const ir_node *node);
1256 /** Returns true if node is a Not node. */
1257 int is_Not(const ir_node *node);
1258 /** Returns true if node is a Shl node. */
1259 int is_Shl(const ir_node *node);
1260 /** Returns true if node is a Shr node. */
1261 int is_Shr(const ir_node *node);
1262 /** Returns true if node is a Shrs node. */
1263 int is_Shrs(const ir_node *node);
1264 /** Returns true if node is a Rotl node. */
1265 int is_Rotl(const ir_node *node);
1266 /** Returns true if node is an Id node. */
1267 int is_Id(const ir_node *node);
1268 /** Returns true if node is a Tuple node. */
1269 int is_Tuple(const ir_node *node);
1270 /** Returns true if node is a Bound node. */
1271 int is_Bound(const ir_node *node);
1272 /** Returns true if the node is not a Block */
1273 int is_no_Block(const ir_node *node);
1274 /** Returns true if the node is a Block */
1275 int is_Block(const ir_node *node);
1276 /** Returns true if node is an Unknown node. */
1277 int is_Unknown(const ir_node *node);
1278 /** Returns true if node is a Return node. */
1279 int is_Return(const ir_node *node);
1280 /** Returns true if node is a Call node. */
1281 int is_Call(const ir_node *node);
1282 /** Returns true if node is a Builtin node. */
1283 int is_Builtin(const ir_node *node);
1284 /** Returns true if node is a CallBegin node. */
1285 int is_CallBegin(const ir_node *node);
1286 /** Returns true if node is a Sel node. */
1287 int is_Sel(const ir_node *node);
1288 /** Returns true if node is a Mul node. */
1289 int is_Mul(const ir_node *node);
1290 /** Returns true if node is a Mulh node. */
1291 int is_Mulh(const ir_node *node);
1292 /** Returns true if node is a Mux node. */
1293 int is_Mux(const ir_node *node);
1294 /** Returns true if node is a Load node. */
1295 int is_Load(const ir_node *node);
1296 /** Returns true if node is a Store node. */
1297 int is_Store(const ir_node *node);
1298 /** Returns true if node is a Sync node. */
1299 int is_Sync(const ir_node *node);
1300 /** Returns true if node is a Confirm node. */
1301 int is_Confirm(const ir_node *node);
1302 /** Returns true if node is a Pin node. */
1303 int is_Pin(const ir_node *node);
1304 /** Returns true if node is a SymConst node. */
1305 int is_SymConst(const ir_node *node);
1306 /** Returns true if node is a SymConst node with kind symconst_addr_ent. */
1307 int is_SymConst_addr_ent(const ir_node *node);
1308 /** Returns true if node is a Cond node. */
1309 int is_Cond(const ir_node *node);
1310 /** Returns true of node is a CopyB node. */
1311 int is_CopyB(const ir_node *node);
1312 /** Returns true if node is a Cmp node. */
1313 int is_Cmp(const ir_node *node);
1314 /** Returns true if node is an Alloc node. */
1315 int is_Alloc(const ir_node *node);
1316 /** Returns true if node is a Free node. */
1317 int is_Free(const ir_node *node);
1318 /** Returns true if a node is a Jmp node. */
1319 int is_Jmp(const ir_node *node);
1320 /** Returns true if a node is a IJmp node. */
1321 int is_IJmp(const ir_node *node);
1322 /** Returns true if a node is a Raise node. */
1323 int is_Raise(const ir_node *node);
1324 /** Returns true if a node is an ASM node. */
1325 int is_ASM(const ir_node *node);
1326 /** Returns true if a node is an Dummy node. */
1327 int is_Dummy(const ir_node *node);
1328 /** Returns true if node is a Proj node or a Filter node in INTRA-procedural view. */
1329 int is_Proj(const ir_node *node);
1330 /** Returns true if node is a Filter node. */
1331 int is_Filter(const ir_node *node);
1333 /** Returns true if the operation manipulates control flow:
1334 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1335 int is_cfop(const ir_node *node);
1337 /** Returns true if the operation manipulates interprocedural control flow:
1338 CallBegin, EndReg, EndExcept */
1339 int is_ip_cfop(const ir_node *node);
1340 /** Returns true if the operation can change the control flow because
1341 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1342 Bad. Raise is not fragile, but a unconditional jump. */
1343 int is_fragile_op(const ir_node *node);
1344 /** Returns the memory operand of fragile operations. */
1345 ir_node *get_fragile_op_mem(ir_node *node);
1346 /** Returns the result mode of a Div operation. */
1347 ir_mode *get_divop_resmod(const ir_node *node);
1349 /** Returns true if the operation is a forking control flow
1350 * operation: Cond. */
1351 int is_irn_forking(const ir_node *node);
1354 * Copies all attributes stored in the old node to the new node.
1355 * Assumes both have the same opcode and sufficient size.
1357 void copy_node_attr(const ir_node *old_node, ir_node *new_node);
1359 /** Return the type associated with the value produced by n
1360 * if the node remarks this type as it is the case for
1361 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1362 ir_type *get_irn_type(ir_node *n);
1364 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1366 ir_type *get_irn_type_attr(ir_node *n);
1368 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1369 ir_entity *get_irn_entity_attr(ir_node *n);
1371 /** Returns non-zero for constant-like nodes. */
1372 int is_irn_constlike(const ir_node *node);
1375 * Returns non-zero for nodes that must be always optimized
1376 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1378 int is_irn_always_opt(const ir_node *node);
1381 * Returns non-zero for nodes that are allowed to have keep-alives and
1382 * are neither Block nor PhiM.
1384 int is_irn_keep(const ir_node *node);
1387 * Returns non-zero for nodes that are always placed in the start block.
1389 int is_irn_start_block_placed(const ir_node *node);
1392 * Returns non-zero for nodes that are machine operations.
1394 int is_irn_machine_op(const ir_node *node);
1397 * Returns non-zero for nodes that are machine operands.
1399 int is_irn_machine_operand(const ir_node *node);
1402 * Returns non-zero for nodes that have the n'th user machine flag set.
1404 int is_irn_machine_user(const ir_node *node, unsigned n);
1407 * A type to express conditional jump predictions.
1410 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1411 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1412 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1413 } cond_jmp_predicate;
1415 /** Gets the string representation of the jump prediction. */
1416 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1418 /** Returns the conditional jump prediction of a Cond node. */
1419 cond_jmp_predicate get_Cond_jmp_pred(const ir_node *cond);
1421 /** Sets a new conditional jump prediction. */
1422 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1424 /** Checks whether a node represents a global address. */
1425 int is_Global(const ir_node *node);
1427 /* Returns the entity of a global address. */
1428 ir_entity *get_Global_entity(const ir_node *node);
1431 * Access custom node data.
1432 * The data must have been registered with
1433 * register_additional_node_data() before.
1434 * @param node The ir node to get the data from.
1435 * @param type The type of the data you registered.
1436 * @param off The value returned by register_additional_node_data().
1437 * @return A pointer of type @p type.
1439 #define get_irn_data(node,type,off) \
1440 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1443 * Get the pointer to the node some custom data belongs to.
1444 * @param data The pointer to the custom data.
1445 * @param off The number as returned by register_additional_node_data().
1446 * @return A pointer to the ir node the custom data belongs to.
1448 #define get_irn_data_base(data,off) \
1449 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1452 * Request additional data to be allocated with an ir node.
1453 * @param size The size of the additional data required.
1454 * @return A positive number, if the operation was successful, which
1455 * must be passed to the access macro get_irn_data(), 0 if the
1456 * registration failed.
1458 unsigned firm_register_additional_node_data(unsigned size);
1461 * Return a pointer to the node attributes.
1462 * Needed for user-defined nodes.
1464 void *get_irn_generic_attr(ir_node *node);
1465 const void *get_irn_generic_attr_const(const ir_node *node);
1468 * Returns the unique node index for the node in its graph.
1469 * This index is used to access phase information for this node.
1471 unsigned get_irn_idx(const ir_node *node);
1474 * Sets the debug information of a node.
1476 * @param n The node.
1477 * @param db The debug info.
1479 void set_irn_dbg_info(ir_node *n, dbg_info *db);
1482 * Returns the debug information of an node.
1484 * @param n The node.
1486 dbg_info *get_irn_dbg_info(const ir_node *n);
1489 * Calculate a hash value of a node. Only inputs, mode and opcode are used.
1491 * @param node the node to hash
1493 unsigned firm_default_hash(const ir_node *node);
1496 * returns a descriptive name of a node (containing type+number)
1498 const char *gdb_node_helper(void *firm_object);
1500 /*@}*/ /* end of ir_node group definition */