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 = 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 = pn_Generic_M, /**< 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_P_value_res_base, /**< A pointer to the memory region containing copied results
604 passed by value (for compound result types). */
605 pn_Call_max /**< number of projections from a Call */
606 } pn_Call; /* Projection numbers for Call. */
608 /** Retrieve the memory input of a Call. */
609 ir_node *get_Call_mem(const ir_node *node);
610 /** Set the memory input of a Call. */
611 void set_Call_mem(ir_node *node, ir_node *mem);
612 /** Retrieve the call address of a Call. */
613 ir_node *get_Call_ptr(const ir_node *node);
614 /** Set the call address of a Call. */
615 void set_Call_ptr(ir_node *node, ir_node *ptr);
616 ir_node **get_Call_param_arr(ir_node *node);
617 /** Gets the number of parameters of a call. */
618 int get_Call_n_params(const ir_node *node);
619 /** Gets the call parameter at position pos. */
620 ir_node *get_Call_param(const ir_node *node, int pos);
621 /** Sets the call parameter at position pos. */
622 void set_Call_param(ir_node *node, int pos, ir_node *param);
623 /** Gets the type of a call. */
624 ir_type *get_Call_type(ir_node *node);
625 /** Sets the type of a call. */
626 void set_Call_type(ir_node *node, ir_type *tp);
627 /** Returns non-zero if this call can be a tail-call. */
628 unsigned get_Call_tail_call(const ir_node *node);
629 /** Sets the tail call attribute. */
630 void set_Call_tail_call(ir_node *node, unsigned tail_call);
633 * Returns non-zero if a Call is surely a self-recursive Call.
634 * Beware: if this functions returns 0, the call might be self-recursive!
636 int is_self_recursive_Call(const ir_node *call);
638 /** Set, get and remove the callee information for a Call node.
640 * The callee information lists all method entities that can be called
641 * from this node. If the address expression can not be analyzed fully,
642 * e.g., as entities can be called that are not in the compilation unit,
643 * the array contains the unknown_entity. The array contains only entities
644 * with peculiarity_existent, but with all kinds of visibility. The entities
645 * not necessarily contain an irg.
647 * The array is only accessible if callee information is valid. See flag
650 * The memory allocated for the array is managed automatically, i.e., it must
651 * not be freed if the Call node is removed from the graph.
653 * @param node A Call node.
655 int Call_has_callees(const ir_node *node);
656 int get_Call_n_callees(const ir_node *node);
657 ir_entity *get_Call_callee(const ir_node *node, int pos);
659 /** Set the full callee array.
661 * The passed array is copied. Assumes current_ir_graph set properly! */
662 void set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
663 void remove_Call_callee_arr(ir_node *node);
666 * Projection numbers for result of Builtin node: use for Proj nodes!
669 pn_Builtin_M = pn_Generic_M, /**< The memory result. */
670 pn_Builtin_1_result = pn_Generic_other, /**< first result. */
671 pn_Builtin_max /**< number of projections from a Builtin */
672 } pn_Builtin; /* Projection numbers for Builtin. */
674 ir_node *get_Builtin_mem(const ir_node *node);
675 void set_Builtin_mem(ir_node *node, ir_node *mem);
676 ir_builtin_kind get_Builtin_kind(const ir_node *node);
677 void set_Builtin_kind(ir_node *node, ir_builtin_kind kind);
678 ir_node **get_Builtin_param_arr(ir_node *node);
679 /** Gets the number of parameters of a Builtin. */
680 int get_Builtin_n_params(const ir_node *node);
681 /** Gets the Builtin parameter at position pos. */
682 ir_node *get_Builtin_param(const ir_node *node, int pos);
683 /** Sets the Builtin parameter at position pos. */
684 void set_Builtin_param(ir_node *node, int pos, ir_node *param);
685 /** Gets the type of a builtin. */
686 ir_type *get_Builtin_type(ir_node *node);
687 /** Sets the type of a Builtin. */
688 void set_Builtin_type(ir_node *node, ir_type *tp);
689 /** Returns a human readable string for the ir_builtin_kind. */
690 const char *get_builtin_kind_name(ir_builtin_kind kind);
692 /** Retrieve the call address of a CallBegin. */
693 ir_node *get_CallBegin_ptr(const ir_node *node);
694 /** Set the call address of a CallBegin. */
695 void set_CallBegin_ptr(ir_node *node, ir_node *ptr);
696 /** Retrieve the original Call node of a CallBegin. */
697 ir_node *get_CallBegin_call(const ir_node *node);
698 /** Set the original Call node of a CallBegin. */
699 void set_CallBegin_call(ir_node *node, ir_node *call);
701 /* For unary and binary arithmetic operations the access to the
702 operands can be factored out. Left is the first, right the
703 second arithmetic value as listed in tech report 1999-44.
704 unops are: Minus, Abs, Not, Conv, Cast
705 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
706 Shr, Shrs, Rotl, Cmp */
707 int is_unop(const ir_node *node);
708 ir_node *get_unop_op(const ir_node *node);
709 void set_unop_op(ir_node *node, ir_node *op);
710 int is_binop(const ir_node *node);
711 ir_node *get_binop_left(const ir_node *node);
712 void set_binop_left(ir_node *node, ir_node *left);
713 ir_node *get_binop_right(const ir_node *node);
714 void set_binop_right(ir_node *node, ir_node *right);
716 ir_node *get_Add_left(const ir_node *node);
717 void set_Add_left(ir_node *node, ir_node *left);
718 ir_node *get_Add_right(const ir_node *node);
719 void set_Add_right(ir_node *node, ir_node *right);
721 ir_node *get_Carry_left(const ir_node *node);
722 void set_Carry_left(ir_node *node, ir_node *left);
723 ir_node *get_Carry_right(const ir_node *node);
724 void set_Carry_right(ir_node *node, ir_node *right);
726 ir_node *get_Borrow_left(const ir_node *node);
727 void set_Borrow_left(ir_node *node, ir_node *left);
728 ir_node *get_Borrow_right(const ir_node *node);
729 void set_Borrow_right(ir_node *node, ir_node *right);
731 ir_node *get_Sub_left(const ir_node *node);
732 void set_Sub_left(ir_node *node, ir_node *left);
733 ir_node *get_Sub_right(const ir_node *node);
734 void set_Sub_right(ir_node *node, ir_node *right);
736 ir_node *get_Minus_op(const ir_node *node);
737 void set_Minus_op(ir_node *node, ir_node *op);
739 ir_node *get_Mul_left(const ir_node *node);
740 void set_Mul_left(ir_node *node, ir_node *left);
741 ir_node *get_Mul_right(const ir_node *node);
742 void set_Mul_right(ir_node *node, ir_node *right);
744 ir_node *get_Mulh_left(const ir_node *node);
745 void set_Mulh_left(ir_node *node, ir_node *left);
746 ir_node *get_Mulh_right(const ir_node *node);
747 void set_Mulh_right(ir_node *node, ir_node *right);
749 ir_node *get_Quot_left(const ir_node *node);
750 void set_Quot_left(ir_node *node, ir_node *left);
751 ir_node *get_Quot_right(const ir_node *node);
752 void set_Quot_right(ir_node *node, ir_node *right);
753 ir_node *get_Quot_mem(const ir_node *node);
754 void set_Quot_mem(ir_node *node, ir_node *mem);
755 ir_mode *get_Quot_resmode(const ir_node *node);
756 void set_Quot_resmode(ir_node *node, ir_mode *mode);
759 * Projection numbers for Quot: use for Proj nodes!
762 pn_Quot_M = pn_Generic_M, /**< Memory result. */
763 pn_Quot_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
764 pn_Quot_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
765 pn_Quot_res = pn_Generic_other, /**< Result of computation. */
766 pn_Quot_max /**< number of projections from a Quot */
767 } pn_Quot; /* Projection numbers for Quot. */
769 ir_node *get_DivMod_left(const ir_node *node);
770 void set_DivMod_left(ir_node *node, ir_node *left);
771 ir_node *get_DivMod_right(const ir_node *node);
772 void set_DivMod_right(ir_node *node, ir_node *right);
773 ir_node *get_DivMod_mem(const ir_node *node);
774 void set_DivMod_mem(ir_node *node, ir_node *mem);
775 ir_mode *get_DivMod_resmode(const ir_node *node);
776 void set_DivMod_resmode(ir_node *node, ir_mode *mode);
779 * Projection numbers for DivMod: use for Proj nodes!
782 pn_DivMod_M = pn_Generic_M, /**< Memory result. */
783 pn_DivMod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
784 pn_DivMod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
785 pn_DivMod_res_div = pn_Generic_other, /**< Result of computation a / b. */
786 pn_DivMod_res_mod, /**< Result of computation a % b. */
787 pn_DivMod_max /**< number of projections from a DivMod */
788 } pn_DivMod; /* Projection numbers for DivMod. */
790 ir_node *get_Div_left(const ir_node *node);
791 void set_Div_left(ir_node *node, ir_node *left);
792 ir_node *get_Div_right(const ir_node *node);
793 void set_Div_right(ir_node *node, ir_node *right);
794 ir_node *get_Div_mem(const ir_node *node);
795 void set_Div_mem(ir_node *node, ir_node *mem);
796 ir_mode *get_Div_resmode(const ir_node *node);
797 void set_Div_resmode(ir_node *node, ir_mode *mode);
798 int get_Div_no_remainder(const ir_node *node);
799 void set_Div_no_remainder(ir_node *node, int no_remainder);
802 * Projection numbers for Div: use for Proj nodes!
805 pn_Div_M = pn_Generic_M, /**< Memory result. */
806 pn_Div_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
807 pn_Div_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
808 pn_Div_res = pn_Generic_other, /**< Result of computation. */
809 pn_Div_max /**< number of projections from a Div */
810 } pn_Div; /* Projection numbers for Div. */
812 ir_node *get_Mod_left(const ir_node *node);
813 void set_Mod_left(ir_node *node, ir_node *left);
814 ir_node *get_Mod_right(const ir_node *node);
815 void set_Mod_right(ir_node *node, ir_node *right);
816 ir_node *get_Mod_mem(const ir_node *node);
817 void set_Mod_mem(ir_node *node, ir_node *mem);
818 ir_mode *get_Mod_resmode(const ir_node *node);
819 void set_Mod_resmode(ir_node *node, ir_mode *mode);
822 * Projection numbers for Mod: use for Proj nodes!
825 pn_Mod_M = pn_Generic_M, /**< Memory result. */
826 pn_Mod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
827 pn_Mod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
828 pn_Mod_res = pn_Generic_other, /**< Result of computation. */
829 pn_Mod_max /**< number of projections from a Mod */
830 } pn_Mod; /* Projection numbers for Mod. */
832 ir_node *get_Abs_op(const ir_node *node);
833 void set_Abs_op(ir_node *node, ir_node *op);
835 ir_node *get_And_left(const ir_node *node);
836 void set_And_left(ir_node *node, ir_node *left);
837 ir_node *get_And_right(const ir_node *node);
838 void set_And_right(ir_node *node, ir_node *right);
840 ir_node *get_Or_left(const ir_node *node);
841 void set_Or_left(ir_node *node, ir_node *left);
842 ir_node *get_Or_right(const ir_node *node);
843 void set_Or_right(ir_node *node, ir_node *right);
845 ir_node *get_Eor_left(const ir_node *node);
846 void set_Eor_left(ir_node *node, ir_node *left);
847 ir_node *get_Eor_right(const ir_node *node);
848 void set_Eor_right(ir_node *node, ir_node *right);
850 ir_node *get_Not_op(const ir_node *node);
851 void set_Not_op(ir_node *node, ir_node *op);
853 /** returns the pnc name from an pnc constant */
854 const char *get_pnc_string(int pnc);
856 /** Calculates the negated (Complement(R)) pnc condition. */
857 pn_Cmp get_negated_pnc(long pnc, ir_mode *mode);
859 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
860 pn_Cmp get_inversed_pnc(long pnc);
862 /** An alternative name for get_inversed_pnc() that can be better memorized. */
863 #define get_mirrored_pnc(pnc) get_inversed_pnc(pnc)
865 ir_node *get_Cmp_left(const ir_node *node);
866 void set_Cmp_left(ir_node *node, ir_node *left);
867 ir_node *get_Cmp_right(const ir_node *node);
868 void set_Cmp_right(ir_node *node, ir_node *right);
870 ir_node *get_Shl_left(const ir_node *node);
871 void set_Shl_left(ir_node *node, ir_node *left);
872 ir_node *get_Shl_right(const ir_node *node);
873 void set_Shl_right(ir_node *node, ir_node *right);
875 ir_node *get_Shr_left(const ir_node *node);
876 void set_Shr_left(ir_node *node, ir_node *left);
877 ir_node *get_Shr_right(const ir_node *node);
878 void set_Shr_right(ir_node *node, ir_node *right);
880 ir_node *get_Shrs_left(const ir_node *node);
881 void set_Shrs_left(ir_node *node, ir_node *left);
882 ir_node *get_Shrs_right(const ir_node *node);
883 void set_Shrs_right(ir_node *node, ir_node *right);
885 ir_node *get_Rotl_left(const ir_node *node);
886 void set_Rotl_left(ir_node *node, ir_node *left);
887 ir_node *get_Rotl_right(const ir_node *node);
888 void set_Rotl_right(ir_node *node, ir_node *right);
890 ir_node *get_Conv_op(const ir_node *node);
891 void set_Conv_op(ir_node *node, ir_node *op);
892 int get_Conv_strict(const ir_node *node);
893 void set_Conv_strict(ir_node *node, int flag);
895 /* Does Cast need a mem operator?
896 * Cast should only depend on the type, not on the state of an
897 * entity. But: we initialize various fields after Alloc, that
898 * are accessed in the cast. This required some precaution, to
899 * get the right memory into the Loads generated from the cast.
901 ir_node *get_Cast_op(const ir_node *node);
902 void set_Cast_op(ir_node *node, ir_node *op);
903 ir_type *get_Cast_type(ir_node *node);
904 void set_Cast_type(ir_node *node, ir_type *to_tp);
906 /** Checks for upcast.
908 * Returns true if the Cast node casts a class type to a super type.
909 * Works also for pointers to classes (recursively).
911 * Needs typeinfo calculated.
913 int is_Cast_upcast(ir_node *node);
915 /** Checks for downcast.
917 * Returns true if the Cast node casts a class type to a sub type.
918 * Works also for pointers to classes (recursively).
920 * Needs typeinfo calculated.
922 int is_Cast_downcast(ir_node *node);
925 /** Returns true if n is a Phi or a Filter node in INTER-procedural view.
926 Returns false if irg is in phase phase_building and the Phi has zero
927 predecessors: it's a Phi0. */
928 int is_Phi(const ir_node *n);
929 /** Returns true if irg in phase phase_building and the Phi has zero
930 predecessors. It's a Phi0 then. */
931 int is_Phi0(const ir_node *n);
932 /* These routines also work for Filter nodes in INTER-procedural view. */
933 ir_node **get_Phi_preds_arr(ir_node *node);
934 int get_Phi_n_preds(const ir_node *node);
935 ir_node *get_Phi_pred(const ir_node *node, int pos);
936 void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
937 ir_node *get_Phi_next(const ir_node *phi);
938 void set_Phi_next(ir_node *phi, ir_node *next);
940 ir_node *get_Filter_pred(ir_node *node);
941 void set_Filter_pred(ir_node *node, ir_node *pred);
942 long get_Filter_proj(ir_node *node);
943 void set_Filter_proj(ir_node *node, long proj);
944 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
945 * @@@ Maybe better: arity is zero if no cg preds. */
946 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
947 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
948 int get_Filter_n_cg_preds(ir_node *node);
949 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
951 /** Return true if parameter is a memory operation.
953 * A memory operation is an operation that changes the
954 * memory. I.e., a Load or a Store operation.
956 int is_memop(const ir_node *node);
957 ir_node *get_memop_mem(const ir_node *node);
958 void set_memop_mem(ir_node *node, ir_node *mem);
959 ir_node *get_memop_ptr(const ir_node *node);
960 void set_memop_ptr(ir_node *node, ir_node *ptr);
963 * Projection numbers for Load: use for Proj nodes!
966 pn_Load_M = pn_Generic_M, /**< Memory result. */
967 pn_Load_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
968 pn_Load_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
969 pn_Load_res = pn_Generic_other, /**< Result of load operation. */
970 pn_Load_max /**< number of projections from a Load */
971 } pn_Load; /* Projection numbers for Load. */
973 ir_node *get_Load_mem(const ir_node *node);
974 void set_Load_mem(ir_node *node, ir_node *mem);
975 ir_node *get_Load_ptr(const ir_node *node);
976 void set_Load_ptr(ir_node *node, ir_node *ptr);
977 ir_mode *get_Load_mode(const ir_node *node);
978 void set_Load_mode(ir_node *node, ir_mode *mode);
979 ir_volatility get_Load_volatility(const ir_node *node);
980 void set_Load_volatility(ir_node *node, ir_volatility volatility);
981 ir_align get_Load_align(const ir_node *node);
982 void set_Load_align(ir_node *node, ir_align align);
985 * Projection numbers for Store: use for Proj nodes!
988 pn_Store_M = pn_Generic_M, /**< Memory result. */
989 pn_Store_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
990 pn_Store_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
991 pn_Store_max = pn_Generic_other /**< number of projections from a Store */
992 } pn_Store; /* Projection numbers for Store. */
994 ir_node *get_Store_mem(const ir_node *node);
995 void set_Store_mem(ir_node *node, ir_node *mem);
996 ir_node *get_Store_ptr(const ir_node *node);
997 void set_Store_ptr(ir_node *node, ir_node *ptr);
998 ir_node *get_Store_value(const ir_node *node);
999 void set_Store_value(ir_node *node, ir_node *value);
1000 ir_volatility get_Store_volatility(const ir_node *node);
1001 void set_Store_volatility(ir_node *node, ir_volatility volatility);
1002 ir_align get_Store_align(const ir_node *node);
1003 void set_Store_align(ir_node *node, ir_align align);
1006 * Projection numbers for Alloc: use for Proj nodes!
1009 pn_Alloc_M = pn_Generic_M, /**< Memory result. */
1010 pn_Alloc_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1011 pn_Alloc_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
1012 pn_Alloc_res = pn_Generic_other, /**< Result of allocation. */
1013 pn_Alloc_max /**< number of projections from an Alloc */
1014 } pn_Alloc; /* Projection numbers for Alloc. */
1016 ir_node *get_Alloc_mem(const ir_node *node);
1017 void set_Alloc_mem(ir_node *node, ir_node *mem);
1018 ir_node *get_Alloc_size(const ir_node *node);
1019 void set_Alloc_size(ir_node *node, ir_node *size);
1020 ir_type *get_Alloc_type(ir_node *node);
1021 void set_Alloc_type(ir_node *node, ir_type *tp);
1023 ir_where_alloc get_Alloc_where(const ir_node *node);
1024 void set_Alloc_where(ir_node *node, ir_where_alloc where);
1026 ir_node *get_Free_mem(const ir_node *node);
1027 void set_Free_mem(ir_node *node, ir_node *mem);
1028 ir_node *get_Free_ptr(const ir_node *node);
1029 void set_Free_ptr(ir_node *node, ir_node *ptr);
1030 ir_node *get_Free_size(const ir_node *node);
1031 void set_Free_size(ir_node *node, ir_node *size);
1032 ir_type *get_Free_type(ir_node *node);
1033 void set_Free_type(ir_node *node, ir_type *tp);
1035 ir_where_alloc get_Free_where(const ir_node *node);
1036 void set_Free_where(ir_node *node, ir_where_alloc where);
1038 ir_node **get_Sync_preds_arr(ir_node *node);
1039 int get_Sync_n_preds(const ir_node *node);
1040 ir_node *get_Sync_pred(const ir_node *node, int pos);
1041 void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
1042 void add_Sync_pred(ir_node *node, ir_node *pred);
1044 /** Returns the source language type of a Proj node.
1045 * Must be an atomic type. Mode of type must be mode of node.
1047 ir_type *get_Proj_type(ir_node *node);
1049 /** Return the predecessor of a Proj node. */
1050 ir_node *get_Proj_pred(const ir_node *node);
1051 void set_Proj_pred(ir_node *node, ir_node *pred);
1052 /** Return the projection number of a Proj node. */
1053 long get_Proj_proj(const ir_node *node);
1054 void set_Proj_proj(ir_node *node, long proj);
1057 * Returns non-zero if a node is a routine parameter.
1059 * @param node the Proj node to test
1061 int is_arg_Proj(const ir_node *node);
1063 ir_node **get_Tuple_preds_arr(ir_node *node);
1064 int get_Tuple_n_preds(const ir_node *node);
1065 ir_node *get_Tuple_pred(const ir_node *node, int pos);
1066 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
1068 ir_node *get_Id_pred(const ir_node *node);
1069 void set_Id_pred(ir_node *node, ir_node *pred);
1071 /** Confirm has a single result and returns 'value' unchanged.
1072 * The node expresses a restriction on 'value':
1073 * 'value' 'cmp' 'bound' == true. */
1074 ir_node *get_Confirm_value(const ir_node *node);
1075 void set_Confirm_value(ir_node *node, ir_node *value);
1076 ir_node *get_Confirm_bound(const ir_node *node);
1077 void set_Confirm_bound(ir_node *node, ir_node *bound);
1078 pn_Cmp get_Confirm_cmp(const ir_node *node);
1079 void set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
1084 ir_node *get_Mux_sel(const ir_node *node);
1085 void set_Mux_sel(ir_node *node, ir_node *sel);
1086 ir_node *get_Mux_false(const ir_node *node);
1087 void set_Mux_false(ir_node *node, ir_node *ir_false);
1088 ir_node *get_Mux_true(const ir_node *node);
1089 void set_Mux_true(ir_node *node, ir_node *ir_true);
1092 * Projection numbers for result of CopyB node: use for Proj nodes!
1095 pn_CopyB_M_regular = pn_Generic_M, /**< The memory result. */
1096 pn_CopyB_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1097 pn_CopyB_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1098 pn_CopyB_max = pn_Generic_other /**< number of projections from a CopyB */
1099 } pn_CopyB; /* Projection numbers for CopyB. */
1100 #define pn_CopyB_M pn_CopyB_M_regular
1102 ir_node *get_CopyB_mem(const ir_node *node);
1103 void set_CopyB_mem(ir_node *node, ir_node *mem);
1104 ir_node *get_CopyB_dst(const ir_node *node);
1105 void set_CopyB_dst(ir_node *node, ir_node *dst);
1106 ir_node *get_CopyB_src(const ir_node *node);
1107 void set_CopyB_src(ir_node *node, ir_node *src);
1108 ir_type *get_CopyB_type(ir_node *node);
1109 void set_CopyB_type(ir_node *node, ir_type *data_type);
1112 * Projection numbers for result of InstOf node: use for Proj nodes!
1115 pn_InstOf_M_regular = pn_Generic_M, /**< The memory result. */
1116 pn_InstOf_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1117 pn_InstOf_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1118 pn_InstOf_res = pn_Generic_other, /**< The checked object pointer. */
1119 pn_InstOf_max /**< number of projections from an InstOf */
1121 #define pn_InstOf_M pn_InstOf_M_regular
1123 /** InstOf access. */
1124 ir_type *get_InstOf_type(ir_node *node);
1125 void set_InstOf_type(ir_node *node, ir_type *type);
1126 ir_node *get_InstOf_store(const ir_node *node);
1127 void set_InstOf_store(ir_node *node, ir_node *obj);
1128 ir_node *get_InstOf_obj(const ir_node *node);
1129 void set_InstOf_obj(ir_node *node, ir_node *obj);
1132 * Projection numbers for Raise.
1135 pn_Raise_M = pn_Generic_M, /**< The Memory result. */
1136 pn_Raise_X = pn_Generic_X_regular, /**< The control flow to the exception handler. */
1137 pn_Raise_max /**< number of projections from a Raise */
1138 } pn_Raise; /* Projection numbers for Raise. */
1140 ir_node *get_Raise_mem(const ir_node *node);
1141 void set_Raise_mem(ir_node *node, ir_node *mem);
1142 ir_node *get_Raise_exo_ptr(const ir_node *node); /* PoinTeR to EXception Object */
1143 void set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
1146 * Projection numbers for result of Bound node: use for Proj nodes!
1149 pn_Bound_M = pn_Generic_M, /**< The memory result. */
1150 pn_Bound_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1151 pn_Bound_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1152 pn_Bound_res = pn_Generic_other, /**< The checked index. */
1153 pn_Bound_max /**< number of projections from a Bound */
1156 /** Returns the memory input of a Bound operation. */
1157 ir_node *get_Bound_mem(const ir_node *bound);
1158 void set_Bound_mem(ir_node *bound, ir_node *mem);
1160 /** Returns the index input of a Bound operation. */
1161 ir_node *get_Bound_index(const ir_node *bound);
1162 void set_Bound_index(ir_node *bound, ir_node *idx);
1164 /** Returns the lower bound input of a Bound operation. */
1165 ir_node *get_Bound_lower(const ir_node *bound);
1166 void set_Bound_lower(ir_node *bound, ir_node *lower);
1168 /** Returns the upper bound input of a Bound operation. */
1169 ir_node *get_Bound_upper(const ir_node *bound);
1170 void set_Bound_upper(ir_node *bound, ir_node *upper);
1172 /** Return the operand of a Pin node. */
1173 ir_node *get_Pin_op(const ir_node *pin);
1174 void set_Pin_op(ir_node *pin, ir_node *node);
1176 /** Return the assembler text of an ASM pseudo node. */
1177 ident *get_ASM_text(const ir_node *node);
1178 /** Return the number of input constraints for an ASM node. */
1179 int get_ASM_n_input_constraints(const ir_node *node);
1180 /** Return the input constraints for an ASM node. */
1181 const ir_asm_constraint *get_ASM_input_constraints(const ir_node *node);
1182 /** Return the number of output constraints for an ASM node. */
1183 int get_ASM_n_output_constraints(const ir_node *node);
1184 /** Return the output constraints for an ASM node. */
1185 const ir_asm_constraint *get_ASM_output_constraints(const ir_node *node);
1186 /** Return the number of clobbered registers for an ASM node. */
1187 int get_ASM_n_clobbers(const ir_node *node);
1188 /** Return the list of clobbered registers for an ASM node. */
1189 ident **get_ASM_clobbers(const ir_node *node);
1193 * NAME Auxiliary routines
1197 /** Returns operand of node if node is a Proj. */
1198 ir_node *skip_Proj(ir_node *node);
1199 /** Returns operand of node if node is a Proj. */
1200 const ir_node *skip_Proj_const(const ir_node *node);
1201 /** Returns operand of node if node is a Id. */
1202 ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
1203 /** Returns corresponding operand of Tuple if node is a Proj from
1205 ir_node *skip_Tuple(ir_node *node);
1206 /** Returns operand of node if node is a Cast. */
1207 ir_node *skip_Cast(ir_node *node);
1208 const ir_node *skip_Cast_const(const ir_node *node);
1209 /** Returns operand of node if node is a Pin. */
1210 ir_node *skip_Pin(ir_node *node);
1211 /** Returns operand of node if node is a Confirm */
1212 ir_node *skip_Confirm(ir_node *node);
1213 /** Skip all high-level Operations (including Cast, Confirm). */
1214 ir_node *skip_HighLevel_ops(ir_node *node);
1215 /** Returns true if irn is a Const node. */
1216 int is_Const(const ir_node *node);
1217 /** Returns true if a node is a Conv node. */
1218 int is_Conv(const ir_node *node);
1219 /** Returns true if a node is a strictConv node. */
1220 int is_strictConv(const ir_node *node);
1221 /** Returns true if a node is a Cast node. */
1222 int is_Cast(const ir_node *node);
1223 /** Returns true if node is a Bad node. */
1224 int is_Bad(const ir_node *node);
1225 /** Returns true if node is a NoMem node. */
1226 int is_NoMem(const ir_node *node);
1227 /** Returns true if node is a Start node. */
1228 int is_Start(const ir_node *node);
1229 /** Returns true if node is a Minus node. */
1230 int is_Minus(const ir_node *node);
1231 /** Returns true if node is a Abs node. */
1232 int is_Abs(const ir_node *node);
1233 /** Returns true if node is a Mod node. */
1234 int is_Mod(const ir_node *node);
1235 /** Returns true if node is a Div node. */
1236 int is_Div(const ir_node *node);
1237 /** Returns true if node is a DivMod node. */
1238 int is_DivMod(const ir_node *node);
1239 /** Returns true if node is a Quot node. */
1240 int is_Quot(const ir_node *node);
1241 /** Returns true if node is an Add node. */
1242 int is_Add(const ir_node *node);
1243 /** Returns true if node is a Carry node. */
1244 int is_Carry(const ir_node *node);
1245 /** Returns true if node is an And node. */
1246 int is_And(const ir_node *node);
1247 /** Returns true if node is an Or node. */
1248 int is_Or(const ir_node *node);
1249 /** Returns true if node is an Eor node. */
1250 int is_Eor(const ir_node *node);
1251 /** Returns true if node is a Sub node. */
1252 int is_Sub(const ir_node *node);
1253 /** Returns true if node is a Not node. */
1254 int is_Not(const ir_node *node);
1255 /** Returns true if node is a Shl node. */
1256 int is_Shl(const ir_node *node);
1257 /** Returns true if node is a Shr node. */
1258 int is_Shr(const ir_node *node);
1259 /** Returns true if node is a Shrs node. */
1260 int is_Shrs(const ir_node *node);
1261 /** Returns true if node is a Rotl node. */
1262 int is_Rotl(const ir_node *node);
1263 /** Returns true if node is an Id node. */
1264 int is_Id(const ir_node *node);
1265 /** Returns true if node is a Tuple node. */
1266 int is_Tuple(const ir_node *node);
1267 /** Returns true if node is a Bound node. */
1268 int is_Bound(const ir_node *node);
1269 /** Returns true if the node is not a Block */
1270 int is_no_Block(const ir_node *node);
1271 /** Returns true if the node is a Block */
1272 int is_Block(const ir_node *node);
1273 /** Returns true if node is an Unknown node. */
1274 int is_Unknown(const ir_node *node);
1275 /** Returns true if node is a Return node. */
1276 int is_Return(const ir_node *node);
1277 /** Returns true if node is a Call node. */
1278 int is_Call(const ir_node *node);
1279 /** Returns true if node is a Builtin node. */
1280 int is_Builtin(const ir_node *node);
1281 /** Returns true if node is a CallBegin node. */
1282 int is_CallBegin(const ir_node *node);
1283 /** Returns true if node is a Sel node. */
1284 int is_Sel(const ir_node *node);
1285 /** Returns true if node is a Mul node. */
1286 int is_Mul(const ir_node *node);
1287 /** Returns true if node is a Mulh node. */
1288 int is_Mulh(const ir_node *node);
1289 /** Returns true if node is a Mux node. */
1290 int is_Mux(const ir_node *node);
1291 /** Returns true if node is a Load node. */
1292 int is_Load(const ir_node *node);
1293 /** Returns true if node is a Store node. */
1294 int is_Store(const ir_node *node);
1295 /** Returns true if node is a Sync node. */
1296 int is_Sync(const ir_node *node);
1297 /** Returns true if node is a Confirm node. */
1298 int is_Confirm(const ir_node *node);
1299 /** Returns true if node is a Pin node. */
1300 int is_Pin(const ir_node *node);
1301 /** Returns true if node is a SymConst node. */
1302 int is_SymConst(const ir_node *node);
1303 /** Returns true if node is a SymConst node with kind symconst_addr_ent. */
1304 int is_SymConst_addr_ent(const ir_node *node);
1305 /** Returns true if node is a Cond node. */
1306 int is_Cond(const ir_node *node);
1307 /** Returns true of node is a CopyB node. */
1308 int is_CopyB(const ir_node *node);
1309 /** Returns true if node is a Cmp node. */
1310 int is_Cmp(const ir_node *node);
1311 /** Returns true if node is an Alloc node. */
1312 int is_Alloc(const ir_node *node);
1313 /** Returns true if node is a Free node. */
1314 int is_Free(const ir_node *node);
1315 /** Returns true if a node is a Jmp node. */
1316 int is_Jmp(const ir_node *node);
1317 /** Returns true if a node is a IJmp node. */
1318 int is_IJmp(const ir_node *node);
1319 /** Returns true if a node is a Raise node. */
1320 int is_Raise(const ir_node *node);
1321 /** Returns true if a node is an ASM node. */
1322 int is_ASM(const ir_node *node);
1323 /** Returns true if a node is an Dummy node. */
1324 int is_Dummy(const ir_node *node);
1325 /** Returns true if node is a Proj node or a Filter node in INTRA-procedural view. */
1326 int is_Proj(const ir_node *node);
1327 /** Returns true if node is a Filter node. */
1328 int is_Filter(const ir_node *node);
1330 /** Returns true if the operation manipulates control flow:
1331 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1332 int is_cfop(const ir_node *node);
1334 /** Returns true if the operation manipulates interprocedural control flow:
1335 CallBegin, EndReg, EndExcept */
1336 int is_ip_cfop(const ir_node *node);
1337 /** Returns true if the operation can change the control flow because
1338 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1339 Bad. Raise is not fragile, but a unconditional jump. */
1340 int is_fragile_op(const ir_node *node);
1341 /** Returns the memory operand of fragile operations. */
1342 ir_node *get_fragile_op_mem(ir_node *node);
1343 /** Returns the result mode of a Div operation. */
1344 ir_mode *get_divop_resmod(const ir_node *node);
1346 /** Returns true if the operation is a forking control flow
1347 * operation: Cond. */
1348 int is_irn_forking(const ir_node *node);
1351 * Copies all attributes stored in the old node to the new node.
1352 * Assumes both have the same opcode and sufficient size.
1354 void copy_node_attr(const ir_node *old_node, ir_node *new_node);
1356 /** Return the type associated with the value produced by n
1357 * if the node remarks this type as it is the case for
1358 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1359 ir_type *get_irn_type(ir_node *n);
1361 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1363 ir_type *get_irn_type_attr(ir_node *n);
1365 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1366 ir_entity *get_irn_entity_attr(ir_node *n);
1368 /** Returns non-zero for constant-like nodes. */
1369 int is_irn_constlike(const ir_node *node);
1372 * Returns non-zero for nodes that must be always optimized
1373 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1375 int is_irn_always_opt(const ir_node *node);
1378 * Returns non-zero for nodes that are allowed to have keep-alives and
1379 * are neither Block nor PhiM.
1381 int is_irn_keep(const ir_node *node);
1384 * Returns non-zero for nodes that are always placed in the start block.
1386 int is_irn_start_block_placed(const ir_node *node);
1389 * Returns non-zero for nodes that are machine operations.
1391 int is_irn_machine_op(const ir_node *node);
1394 * Returns non-zero for nodes that are machine operands.
1396 int is_irn_machine_operand(const ir_node *node);
1399 * Returns non-zero for nodes that have the n'th user machine flag set.
1401 int is_irn_machine_user(const ir_node *node, unsigned n);
1404 * A type to express conditional jump predictions.
1407 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1408 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1409 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1410 } cond_jmp_predicate;
1412 /** Gets the string representation of the jump prediction. */
1413 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1415 /** Returns the conditional jump prediction of a Cond node. */
1416 cond_jmp_predicate get_Cond_jmp_pred(const ir_node *cond);
1418 /** Sets a new conditional jump prediction. */
1419 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1421 /** Checks whether a node represents a global address. */
1422 int is_Global(const ir_node *node);
1424 /* Returns the entity of a global address. */
1425 ir_entity *get_Global_entity(const ir_node *node);
1428 * Access custom node data.
1429 * The data must have been registered with
1430 * register_additional_node_data() before.
1431 * @param node The ir node to get the data from.
1432 * @param type The type of the data you registered.
1433 * @param off The value returned by register_additional_node_data().
1434 * @return A pointer of type @p type.
1436 #define get_irn_data(node,type,off) \
1437 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1440 * Get the pointer to the node some custom data belongs to.
1441 * @param data The pointer to the custom data.
1442 * @param off The number as returned by register_additional_node_data().
1443 * @return A pointer to the ir node the custom data belongs to.
1445 #define get_irn_data_base(data,off) \
1446 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1449 * Request additional data to be allocated with an ir node.
1450 * @param size The size of the additional data required.
1451 * @return A positive number, if the operation was successful, which
1452 * must be passed to the access macro get_irn_data(), 0 if the
1453 * registration failed.
1455 unsigned firm_register_additional_node_data(unsigned size);
1458 * Return a pointer to the node attributes.
1459 * Needed for user-defined nodes.
1461 void *get_irn_generic_attr(ir_node *node);
1462 const void *get_irn_generic_attr_const(const ir_node *node);
1465 * Returns the unique node index for the node in its graph.
1466 * This index is used to access phase information for this node.
1468 unsigned get_irn_idx(const ir_node *node);
1471 * Sets the debug information of a node.
1473 * @param n The node.
1474 * @param db The debug info.
1476 void set_irn_dbg_info(ir_node *n, dbg_info *db);
1479 * Returns the debug information of an node.
1481 * @param n The node.
1483 dbg_info *get_irn_dbg_info(const ir_node *n);
1486 * Calculate a hash value of a node. Only inputs, mode and opcode are used.
1488 * @param node the node to hash
1490 unsigned firm_default_hash(const ir_node *node);
1493 * returns a descriptive name of a node (containing type+number)
1495 const char *gdb_node_helper(void *firm_object);
1497 /*@}*/ /* end of ir_node group definition */