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 mode-enum ir_modecode. */
189 ir_modecode get_irn_modecode(const ir_node *node);
190 /** Gets the ident for a string representation of the mode .*/
191 ident *get_irn_modeident(const ir_node *node);
192 /** Gets the string representation of the mode .*/
193 const char *get_irn_modename(const ir_node *node);
194 /** Gets the opcode struct of the node. */
195 ir_op *get_irn_op(const ir_node *node);
196 /** Sets the opcode struct of the node. */
197 void set_irn_op(ir_node *node, ir_op *op);
198 /** Gets the opcode-enum of the node. */
199 unsigned get_irn_opcode(const ir_node *node);
200 /** Get the string representation of the opcode. */
201 const char *get_irn_opname(const ir_node *node);
202 /** Get the ident for a string representation of the opcode. */
203 ident *get_irn_opident(const ir_node *node);
204 /** If arg is an argument of the node, returns it's position, -1 otherwise */
205 int get_irn_pred_pos(ir_node *node, ir_node *arg);
206 /** Gets the visited counter of a node. */
207 ir_visited_t get_irn_visited(const ir_node *node);
208 /** Sets the visited counter of a node. */
209 void set_irn_visited(ir_node *node, ir_visited_t visited);
210 /** Sets visited to get_irg_visited(current_ir_graph). */
211 void mark_irn_visited(ir_node *node);
212 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
213 int irn_visited(const ir_node *node);
214 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). Marks the node
215 * visited, if it was not. */
216 int irn_visited_else_mark(ir_node *node);
219 * Sets the link of a node.
220 * Only allowed if the graph is NOT in phase_building.
222 void set_irn_link(ir_node *node, void *link);
224 /** Returns the link of a node. */
225 void *get_irn_link(const ir_node *node);
227 /** Returns the ir_graph this node belongs to. */
228 ir_graph *get_irn_irg(const ir_node *node);
230 /** Outputs a unique number for this node if libFIRM is compiled for
231 debugging, (configure with --enable-debug) else returns address
232 of node cast to long. */
233 long get_irn_node_nr(const ir_node *node);
235 /** Returns the pinned state of a node.
237 * Returns whether the node _always_ must be pinned.
238 * I.e., the node is not floating after global cse.
240 * @returns Either state op_pin_state_pinned or op_pin_state_floats.
242 op_pin_state get_irn_pinned(const ir_node *node);
244 /** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
245 void set_irn_pinned(ir_node *node, op_pin_state state);
247 /** Returns whether the node is currently pinned.
249 * If get_irn_pinned returns op_pin_state_floats and the graph the
250 * node belongs to is in state op_poin_state_floats then this function
251 * returns 'floats', else 'pinned'.
253 op_pin_state is_irn_pinned_in_irg(const ir_node *node);
256 * IR node constructor.
257 * Create a new IR node in irg, with an op, mode, arity and
258 * some incoming IR nodes.
259 * This constructor is used in every specific IR node constructor.
261 * @param db Debug info.
262 * @param irg IR-graph on with this new node should be constructed.
263 * @param block The block the new node belongs to
264 * @param op The opcode of the new node.
265 * @param mode The mode of the new node.
266 * @param arity The arity of the new node, <0 if can be changed dynamically.
267 * @param in An array of arity predecessor nodes.
270 new_ir_node(dbg_info *db,
279 * Return the block the node belongs to. This is only
280 * possible for pinned nodes or if the graph is in pinned state.
281 * Otherwise the block may be incorrect. This condition is
282 * now checked by an assertion.
284 * This works for all except Block. It can return Blocks or the Bad node.
286 * To express the difference to access routines that work for all
287 * nodes we use infix "nodes" and do not name this function
288 * get_irn_block(). */
289 ir_node *get_nodes_block (const ir_node *node);
291 /** Sets the Block of a node. */
292 void set_nodes_block (ir_node *node, ir_node *block);
295 * Return the MacroBlock the node belongs to. This is only
296 * possible for pinned nodes or if the graph is in pinned state.
297 * Otherwise the MacroBlock may be incorrect. This condition is
298 * now checked by an assertion.
300 * This works for all except Block. It can return Blocks or the Bad node.
302 * To express the difference to access routines that work for all
303 * nodes we use infix "nodes" and do not name this function
304 * get_irn_MacroBlock(). */
305 ir_node *get_nodes_MacroBlock(const ir_node *node);
308 * @function get_irn_block()
309 * @see get_nodes_block()
313 * Projection numbers for result of Start node: use for Proj nodes!
316 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
317 pn_Start_M, /**< Projection on the initial memory. */
318 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
319 pn_Start_P_tls, /**< Projection on the pointer to the thread local store
320 segment containing _all_thread local variables. */
321 pn_Start_T_args, /**< Projection on all arguments. */
322 pn_Start_max /**< number of projections from a Start */
323 } pn_Start; /* Projection numbers for Start. */
325 /** Test whether arbitrary node is frame pointer.
327 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
328 * from Start. If so returns frame type, else Null. */
329 ir_type *is_frame_pointer(const ir_node *n);
331 /** Test whether arbitrary node is the thread local storage (tls) pointer.
333 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
334 * from Start. If so returns tls type, else Null. */
335 ir_type *is_tls_pointer(const ir_node *n);
337 /** Return the number of control flow predecessors of a block. */
338 int get_Block_n_cfgpreds(const ir_node *block);
339 /** Return the control flow predecessor of a block at a given position. */
340 ir_node *get_Block_cfgpred(const ir_node *block, int pos);
341 /** Set the control flow predecessor of a block at a given position. */
342 void set_Block_cfgpred(ir_node *block, int pos, ir_node *pred);
345 * Return the position of the predecessor block pred in the inputs
346 * of the block block.
348 * @param block the block
349 * @param pred a predecessor block of block
351 * @return the position of pred in block or -1
353 * @note When using the old extended basic block form for blocks
354 * with exception exists, a predecessor block might have more
355 * than one position. In that case it is not specified, with is returned.
357 int get_Block_cfgpred_pos(const ir_node *block, const ir_node *pred);
359 /** Get the predecessor block.
361 * Returns the block corresponding to the predecessor pos of block.
363 * There are several ambiguities we resolve with this function:
364 * - The direct predecessor can be a Proj, which is not pinned.
365 * We walk from the predecessor to the next pinned node
366 * (skip_Proj) and return the block that node is in.
367 * - If we encounter the Bad node, this function does not return
368 * Start block, but the Bad node.
370 ir_node *get_Block_cfgpred_block(const ir_node *node, int pos);
372 /** Return the matured flag of a block */
373 int get_Block_matured(const ir_node *block);
374 /** set the matured flag of a block. */
375 void set_Block_matured(ir_node *block, int matured);
377 /** A visited flag only for block nodes.
378 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
379 ir_visited_t get_Block_block_visited(const ir_node *block);
380 void set_Block_block_visited(ir_node *block, ir_visited_t visit);
383 * Marks a block as dead but do not replace it with a Bad node.
384 * Dead blocks are removed in the con
386 ir_node *set_Block_dead(ir_node *block);
387 int is_Block_dead(const ir_node *block);
389 /* For this current_ir_graph must be set. */
390 void mark_Block_block_visited(ir_node *node);
391 int Block_block_visited(const ir_node *node);
393 #ifdef INTERPROCEDURAL_VIEW
394 /* Set and remove interprocedural predecessors. If the interprocedural
395 * predecessors are removed, the node has the same predecessors in
397 * @@@ Maybe better: arity is zero if no cg preds. */
398 void set_Block_cg_cfgpred_arr(ir_node *node, int arity, ir_node *in[]);
399 void set_Block_cg_cfgpred(ir_node *node, int pos, ir_node *pred);
400 /* @@@ not supported */
401 ir_node **get_Block_cg_cfgpred_arr(ir_node *node);
402 /** Returns the number of interprocedural predecessors. 0 if none. */
403 int get_Block_cg_n_cfgpreds(const ir_node *node);
404 /** Return the interprocedural predecessor at position pos. */
405 ir_node *get_Block_cg_cfgpred(const ir_node *node, int pos);
406 /** Frees the memory allocated for interprocedural predecessors. */
407 void remove_Block_cg_cfgpred_arr(ir_node *node);
410 /** Returns the extended basic block a block belongs to. */
411 ir_extblk *get_Block_extbb(const ir_node *block);
412 /** Sets the extended basic block a block belongs to. */
413 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
414 /** Get the Macro Block header of a (sub-) block. */
415 ir_node *get_Block_MacroBlock(const ir_node *block);
416 /** Set the Macro Block header of a (sub-) block. */
417 void set_Block_MacroBlock(ir_node *block, ir_node *mbh);
418 /** Get the Macro Block header of a node. */
419 ir_node *get_irn_MacroBlock(const ir_node *n);
420 /** Returns the ir_graph this Block belongs to. */
421 ir_graph *get_Block_irg(const ir_node *block);
422 /** Returns non-zero if the block has an entity assigned */
423 int has_Block_entity(const ir_node *block);
424 /** Returns the entity for a Block */
425 ir_entity *get_Block_entity(const ir_node *block);
426 /** Returns the entity for a Block (creating it if necessary) */
427 ir_entity *create_Block_entity(ir_node *block);
428 /** Set a new entity for a block */
429 void set_Block_entity(ir_node *block, ir_entity *entity);
430 /** Gets the head of the Phi list for this block. */
431 ir_node *get_Block_phis(const ir_node *block);
432 /** Sets the head of the Phi list for this block. */
433 void set_Block_phis(ir_node *block, ir_node *phi);
434 /** Add a Phi node to the list of Block Phi's. */
435 void add_Block_phi(ir_node *block, ir_node *phi);
436 /** Get the Block mark (single bit). */
437 unsigned get_Block_mark(const ir_node *block);
438 /** Set the Block mark (single bit). */
439 void set_Block_mark(ir_node *block, unsigned mark);
441 /** Return the number of Keep alive node. */
442 int get_End_n_keepalives(const ir_node *end);
443 /** Return the Keep alive node a position pos. */
444 ir_node *get_End_keepalive(const ir_node *end, int pos);
445 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
446 void add_End_keepalive(ir_node *end, ir_node *ka);
447 /** Set the Keep alive node at position pos. */
448 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
451 * Set new keep-alives.
452 * Beware: This might be an expensive operation if dynamic edges are enabled,
453 * so avoid it in the backend.
455 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
457 /** Remove irn from the keep-alive set. */
458 void remove_End_keepalive(ir_node *end, ir_node *irn);
460 /* Remove Bads, NoMem and doublets from the keep-alive set. */
461 void remove_End_Bads_and_doublets(ir_node *end);
463 /** Some parts of the End node are allocated separately -- their memory
464 is not recovered by dead_node_elimination if a End node is dead.
465 free_End() frees these data structures. */
466 void free_End(ir_node *end);
468 /** Return the target address of an IJmp */
469 ir_node *get_IJmp_target(const ir_node *ijmp);
470 /** Sets the target address of an IJmp */
471 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
473 /* We distinguish three kinds of Cond nodes. These can be distinguished
474 by the mode of the selector operand and an internal flag of type cond_kind.
475 First we distinguish binary Conds and switch Conds.
476 A binary Cond has as selector a boolean value. Proj(0) projects the control
477 flow for case "False", Proj(1) the control flow for "True". A binary Cond
478 is recognized by the boolean selector.
479 The switch Cond has as selector an unsigned integer. It produces as result
480 an n+1 Tuple (cf0, ... , cfn) of control flows.
481 We differ two flavors of this Cond. The first, the dense Cond, passes
482 control along output i if the selector value is i, 0 <= i <= n. If the
483 selector value is >n it passes control along output n.
484 The second Cond flavor differences in the treatment of cases not specified in
485 the source program. It magically knows about the existence of Proj nodes.
486 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
487 exists. Else it passes control along output n (even if this Proj does not
488 exist.) This Cond we call "fragmentary". There is a special constructor
489 new_defaultProj that automatically sets the flavor.
490 The two switch flavors are distinguished by a flag of type cond_kind.
491 Default flavor is "dense"
494 dense, /**< Default. Missing Proj nodes are dead control flow. */
495 fragmentary /**< Special. No control flow optimizations allowed. Missing
496 Proj nodes mean default control flow, i.e., Proj(n). */
499 /** Gets the string representation of the Cond node kind. */
500 const char *get_cond_kind_name(cond_kind kind);
502 ir_node *get_Cond_selector(const ir_node *node);
503 void set_Cond_selector(ir_node *node, ir_node *selector);
504 cond_kind get_Cond_kind(const ir_node *node);
505 void set_Cond_kind(ir_node *node, cond_kind kind);
506 long get_Cond_default_proj(const ir_node *node);
507 void set_Cond_default_proj(ir_node *node, long defproj);
510 * Projection numbers for conditions.
513 pn_Cond_false, /**< Control flow if operand is "false". */
514 pn_Cond_true, /**< Control flow if operand is "true". */
515 pn_Cond_max /**< number of projections from a Cond */
516 } pn_Cond; /* Projection numbers for Cond. */
518 ir_node *get_Return_mem(const ir_node *node);
519 void set_Return_mem(ir_node *node, ir_node *mem);
520 ir_node **get_Return_res_arr(ir_node *node);
521 int get_Return_n_ress(const ir_node *node);
522 ir_node *get_Return_res(const ir_node *node, int pos);
523 void set_Return_res(ir_node *node, int pos, ir_node *res);
525 tarval *get_Const_tarval(const ir_node *node);
526 void set_Const_tarval(ir_node *node, tarval *con);
528 /** Return non-zero if the given Const node represents the 0 constant. */
529 int is_Const_null(const ir_node *node);
531 /** Return non-zero if the given Const node represents the 1 constant. */
532 int is_Const_one(const ir_node *node);
534 /** Return non-zero if the given Const node represents the constant with all bits set. */
535 int is_Const_all_one(const ir_node *node);
537 /** Returns the source language type of a Const node.
538 * Must be an atomic type. Mode of type must be mode of node.
540 ir_type *get_Const_type(ir_node *node);
542 /** Sets the source language type of a Const node. */
543 void set_Const_type(ir_node *node, ir_type *tp);
545 /** Returns non-zero if s symconst kind has a type attribute */
546 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
548 /** Returns non-zero if s symconst kind has an ident attribute */
549 #define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)
551 /** Returns non-zero if s symconst kind has an entity attribute */
552 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
554 /** Returns non-zero if s symconst kind has an enum_const attribute */
555 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
557 /** Get the kind of the SymConst. */
558 symconst_kind get_SymConst_kind(const ir_node *node);
559 /** Set the kind of the SymConst. */
560 void set_SymConst_kind(ir_node *node, symconst_kind num);
562 /** Only to access SymConst of kind type_tag or size. Else assertion: */
563 ir_type *get_SymConst_type(const ir_node *node);
564 void set_SymConst_type(ir_node *node, ir_type *tp);
566 /** Only to access SymConst of kind addr_name. Else assertion: */
567 ident *get_SymConst_name(const ir_node *node);
568 void set_SymConst_name(ir_node *node, ident *name);
570 /** Only to access SymConst of kind addr_ent. Else assertion: */
571 ir_entity *get_SymConst_entity(const ir_node *node);
572 void set_SymConst_entity(ir_node *node, ir_entity *ent);
574 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
575 ir_enum_const *get_SymConst_enum(const ir_node *node);
576 void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
578 /** Sets both: type and ptrinfo. Needed to treat the node independent of
579 its semantics. Does a memcpy for the memory sym points to. */
580 /* write 'union': firmjni then does not create a method... */
581 union symconst_symbol get_SymConst_symbol(const ir_node *node);
582 void set_SymConst_symbol(ir_node *node,
583 union symconst_symbol sym);
585 /** Access the type of the value represented by the SymConst.
587 * Example: primitive type int for SymConst size. */
588 ir_type *get_SymConst_value_type(ir_node *node);
589 void set_SymConst_value_type(ir_node *node, ir_type *tp);
591 ir_node *get_Sel_mem(const ir_node *node);
592 void set_Sel_mem(ir_node *node, ir_node *mem);
593 ir_node *get_Sel_ptr(const ir_node *node); /* ptr to the object to select from */
594 void set_Sel_ptr(ir_node *node, ir_node *ptr);
595 ir_node **get_Sel_index_arr(ir_node *node);
596 int get_Sel_n_indexs(const ir_node *node);
597 ir_node *get_Sel_index(const ir_node *node, int pos);
598 void set_Sel_index(ir_node *node, int pos, ir_node *index);
599 ir_entity *get_Sel_entity(const ir_node *node); /* entity to select */
600 void set_Sel_entity (ir_node *node, ir_entity *ent);
603 * Projection numbers for result of Call node: use for Proj nodes!
606 pn_Call_M_regular = pn_Generic_M_regular, /**< The memory result. */
607 pn_Call_X_regular = pn_Generic_X_regular, /**< The control flow result when no exception occurs. */
608 pn_Call_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler. */
609 pn_Call_T_result = pn_Generic_other, /**< The tuple containing all (0, 1, 2, ...) results. */
610 pn_Call_M_except, /**< The memory result in case the called method terminated with
612 pn_Call_P_value_res_base, /**< A pointer to the memory region containing copied results
613 passed by value (for compound result types). */
614 pn_Call_max /**< number of projections from a Call */
615 } pn_Call; /* Projection numbers for Call. */
616 #define pn_Call_M pn_Call_M_regular
618 /** Retrieve the memory input of a Call. */
619 ir_node *get_Call_mem(const ir_node *node);
620 /** Set the memory input of a Call. */
621 void set_Call_mem(ir_node *node, ir_node *mem);
622 /** Retrieve the call address of a Call. */
623 ir_node *get_Call_ptr(const ir_node *node);
624 /** Set the call address of a Call. */
625 void set_Call_ptr(ir_node *node, ir_node *ptr);
626 ir_node **get_Call_param_arr(ir_node *node);
627 /** Gets the number of parameters of a call. */
628 int get_Call_n_params(const ir_node *node);
629 /** Gets the call parameter at position pos. */
630 ir_node *get_Call_param(const ir_node *node, int pos);
631 /** Sets the call parameter at position pos. */
632 void set_Call_param(ir_node *node, int pos, ir_node *param);
633 /** Gets the type of a call. */
634 ir_type *get_Call_type(ir_node *node);
635 /** Sets the type of a call. */
636 void set_Call_type(ir_node *node, ir_type *tp);
639 * Returns non-zero if a Call is surely a self-recursive Call.
640 * Beware: if this functions returns 0, the call might be self-recursive!
642 int is_self_recursive_Call(const ir_node *call);
644 /** Set, get and remove the callee information for a Call node.
646 * The callee information lists all method entities that can be called
647 * from this node. If the address expression can not be analyzed fully,
648 * e.g., as entities can be called that are not in the compilation unit,
649 * the array contains the unknown_entity. The array contains only entities
650 * with peculiarity_existent, but with all kinds of visibility. The entities
651 * not necessarily contain an irg.
653 * The array is only accessible if callee information is valid. See flag
656 * The memory allocated for the array is managed automatically, i.e., it must
657 * not be freed if the Call node is removed from the graph.
659 * @param node A Call node.
661 int Call_has_callees(const ir_node *node);
662 int get_Call_n_callees(const ir_node *node);
663 ir_entity *get_Call_callee(const ir_node *node, int pos);
665 /** Set the full callee array.
667 * The passed array is copied. Assumes current_ir_graph set properly! */
668 void set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
669 void remove_Call_callee_arr(ir_node *node);
672 * Projection numbers for result of Builtin node: use for Proj nodes!
675 pn_Builtin_M = pn_Generic_M_regular, /**< The memory result. */
676 pn_Builtin_1_result = pn_Generic_other, /**< first result. */
677 pn_Builtin_max /**< number of projections from a Builtin */
678 } pn_Builtin; /* Projection numbers for Builtin. */
680 ir_node *get_Builtin_mem(const ir_node *node);
681 void set_Builtin_mem(ir_node *node, ir_node *mem);
682 ir_builtin_kind get_Builtin_kind(const ir_node *node);
683 void set_Builtin_kind(ir_node *node, ir_builtin_kind kind);
684 ir_node **get_Builtin_param_arr(ir_node *node);
685 /** Gets the number of parameters of a Builtin. */
686 int get_Builtin_n_params(const ir_node *node);
687 /** Gets the Builtin parameter at position pos. */
688 ir_node *get_Builtin_param(const ir_node *node, int pos);
689 /** Sets the Builtin parameter at position pos. */
690 void set_Builtin_param(ir_node *node, int pos, ir_node *param);
691 /** Gets the type of a builtin. */
692 ir_type *get_Builtin_type(ir_node *node);
693 /** Sets the type of a Builtin. */
694 void set_Builtin_type(ir_node *node, ir_type *tp);
695 /** Returns a human readable string for the ir_builtin_kind. */
696 const char *get_builtin_kind_name(ir_builtin_kind kind);
698 /** Retrieve the call address of a CallBegin. */
699 ir_node *get_CallBegin_ptr(const ir_node *node);
700 /** Set the call address of a CallBegin. */
701 void set_CallBegin_ptr(ir_node *node, ir_node *ptr);
702 /** Retrieve the original Call node of a CallBegin. */
703 ir_node *get_CallBegin_call(const ir_node *node);
704 /** Set the original Call node of a CallBegin. */
705 void set_CallBegin_call(ir_node *node, ir_node *call);
707 /* For unary and binary arithmetic operations the access to the
708 operands can be factored out. Left is the first, right the
709 second arithmetic value as listed in tech report 1999-44.
710 unops are: Minus, Abs, Not, Conv, Cast
711 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
712 Shr, Shrs, Rotl, Cmp */
713 int is_unop(const ir_node *node);
714 ir_node *get_unop_op(const ir_node *node);
715 void set_unop_op(ir_node *node, ir_node *op);
716 int is_binop(const ir_node *node);
717 ir_node *get_binop_left(const ir_node *node);
718 void set_binop_left(ir_node *node, ir_node *left);
719 ir_node *get_binop_right(const ir_node *node);
720 void set_binop_right(ir_node *node, ir_node *right);
722 ir_node *get_Add_left(const ir_node *node);
723 void set_Add_left(ir_node *node, ir_node *left);
724 ir_node *get_Add_right(const ir_node *node);
725 void set_Add_right(ir_node *node, ir_node *right);
727 ir_node *get_Carry_left(const ir_node *node);
728 void set_Carry_left(ir_node *node, ir_node *left);
729 ir_node *get_Carry_right(const ir_node *node);
730 void set_Carry_right(ir_node *node, ir_node *right);
732 ir_node *get_Borrow_left(const ir_node *node);
733 void set_Borrow_left(ir_node *node, ir_node *left);
734 ir_node *get_Borrow_right(const ir_node *node);
735 void set_Borrow_right(ir_node *node, ir_node *right);
737 ir_node *get_Sub_left(const ir_node *node);
738 void set_Sub_left(ir_node *node, ir_node *left);
739 ir_node *get_Sub_right(const ir_node *node);
740 void set_Sub_right(ir_node *node, ir_node *right);
742 ir_node *get_Minus_op(const ir_node *node);
743 void set_Minus_op(ir_node *node, ir_node *op);
745 ir_node *get_Mul_left(const ir_node *node);
746 void set_Mul_left(ir_node *node, ir_node *left);
747 ir_node *get_Mul_right(const ir_node *node);
748 void set_Mul_right(ir_node *node, ir_node *right);
750 ir_node *get_Mulh_left(const ir_node *node);
751 void set_Mulh_left(ir_node *node, ir_node *left);
752 ir_node *get_Mulh_right(const ir_node *node);
753 void set_Mulh_right(ir_node *node, ir_node *right);
755 ir_node *get_Quot_left(const ir_node *node);
756 void set_Quot_left(ir_node *node, ir_node *left);
757 ir_node *get_Quot_right(const ir_node *node);
758 void set_Quot_right(ir_node *node, ir_node *right);
759 ir_node *get_Quot_mem(const ir_node *node);
760 void set_Quot_mem(ir_node *node, ir_node *mem);
761 ir_mode *get_Quot_resmode(const ir_node *node);
762 void set_Quot_resmode(ir_node *node, ir_mode *mode);
765 * Projection numbers for Quot: use for Proj nodes!
768 pn_Quot_M = pn_Generic_M_regular, /**< Memory result. */
769 pn_Quot_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
770 pn_Quot_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
771 pn_Quot_res = pn_Generic_other, /**< Result of computation. */
772 pn_Quot_max /**< number of projections from a Quot */
773 } pn_Quot; /* Projection numbers for Quot. */
775 ir_node *get_DivMod_left(const ir_node *node);
776 void set_DivMod_left(ir_node *node, ir_node *left);
777 ir_node *get_DivMod_right(const ir_node *node);
778 void set_DivMod_right(ir_node *node, ir_node *right);
779 ir_node *get_DivMod_mem(const ir_node *node);
780 void set_DivMod_mem(ir_node *node, ir_node *mem);
781 ir_mode *get_DivMod_resmode(const ir_node *node);
782 void set_DivMod_resmode(ir_node *node, ir_mode *mode);
785 * Projection numbers for DivMod: use for Proj nodes!
788 pn_DivMod_M = pn_Generic_M_regular, /**< Memory result. */
789 pn_DivMod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
790 pn_DivMod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
791 pn_DivMod_res_div = pn_Generic_other, /**< Result of computation a / b. */
792 pn_DivMod_res_mod, /**< Result of computation a % b. */
793 pn_DivMod_max /**< number of projections from a DivMod */
794 } pn_DivMod; /* Projection numbers for DivMod. */
796 ir_node *get_Div_left(const ir_node *node);
797 void set_Div_left(ir_node *node, ir_node *left);
798 ir_node *get_Div_right(const ir_node *node);
799 void set_Div_right(ir_node *node, ir_node *right);
800 ir_node *get_Div_mem(const ir_node *node);
801 void set_Div_mem(ir_node *node, ir_node *mem);
802 ir_mode *get_Div_resmode(const ir_node *node);
803 void set_Div_resmode(ir_node *node, ir_mode *mode);
804 int get_Div_no_remainder(const ir_node *node);
805 void set_Div_no_remainder(ir_node *node, int no_remainder);
808 * Projection numbers for Div: use for Proj nodes!
811 pn_Div_M = pn_Generic_M_regular, /**< Memory result. */
812 pn_Div_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
813 pn_Div_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
814 pn_Div_res = pn_Generic_other, /**< Result of computation. */
815 pn_Div_max /**< number of projections from a Div */
816 } pn_Div; /* Projection numbers for Div. */
818 ir_node *get_Mod_left(const ir_node *node);
819 void set_Mod_left(ir_node *node, ir_node *left);
820 ir_node *get_Mod_right(const ir_node *node);
821 void set_Mod_right(ir_node *node, ir_node *right);
822 ir_node *get_Mod_mem(const ir_node *node);
823 void set_Mod_mem(ir_node *node, ir_node *mem);
824 ir_mode *get_Mod_resmode(const ir_node *node);
825 void set_Mod_resmode(ir_node *node, ir_mode *mode);
828 * Projection numbers for Mod: use for Proj nodes!
831 pn_Mod_M = pn_Generic_M_regular, /**< Memory result. */
832 pn_Mod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
833 pn_Mod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
834 pn_Mod_res = pn_Generic_other, /**< Result of computation. */
835 pn_Mod_max /**< number of projections from a Mod */
836 } pn_Mod; /* Projection numbers for Mod. */
838 ir_node *get_Abs_op(const ir_node *node);
839 void set_Abs_op(ir_node *node, ir_node *op);
841 ir_node *get_And_left(const ir_node *node);
842 void set_And_left(ir_node *node, ir_node *left);
843 ir_node *get_And_right(const ir_node *node);
844 void set_And_right(ir_node *node, ir_node *right);
846 ir_node *get_Or_left(const ir_node *node);
847 void set_Or_left(ir_node *node, ir_node *left);
848 ir_node *get_Or_right(const ir_node *node);
849 void set_Or_right(ir_node *node, ir_node *right);
851 ir_node *get_Eor_left(const ir_node *node);
852 void set_Eor_left(ir_node *node, ir_node *left);
853 ir_node *get_Eor_right(const ir_node *node);
854 void set_Eor_right(ir_node *node, ir_node *right);
856 ir_node *get_Not_op(const ir_node *node);
857 void set_Not_op(ir_node *node, ir_node *op);
859 /** returns the pnc name from an pnc constant */
860 const char *get_pnc_string(int pnc);
862 /** Calculates the negated (Complement(R)) pnc condition. */
863 pn_Cmp get_negated_pnc(long pnc, ir_mode *mode);
865 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
866 pn_Cmp get_inversed_pnc(long pnc);
868 /** An alternative name for get_inversed_pnc() that can be better memorized. */
869 #define get_mirrored_pnc(pnc) get_inversed_pnc(pnc)
871 ir_node *get_Cmp_left(const ir_node *node);
872 void set_Cmp_left(ir_node *node, ir_node *left);
873 ir_node *get_Cmp_right(const ir_node *node);
874 void set_Cmp_right(ir_node *node, ir_node *right);
876 ir_node *get_Shl_left(const ir_node *node);
877 void set_Shl_left(ir_node *node, ir_node *left);
878 ir_node *get_Shl_right(const ir_node *node);
879 void set_Shl_right(ir_node *node, ir_node *right);
881 ir_node *get_Shr_left(const ir_node *node);
882 void set_Shr_left(ir_node *node, ir_node *left);
883 ir_node *get_Shr_right(const ir_node *node);
884 void set_Shr_right(ir_node *node, ir_node *right);
886 ir_node *get_Shrs_left(const ir_node *node);
887 void set_Shrs_left(ir_node *node, ir_node *left);
888 ir_node *get_Shrs_right(const ir_node *node);
889 void set_Shrs_right(ir_node *node, ir_node *right);
891 ir_node *get_Rotl_left(const ir_node *node);
892 void set_Rotl_left(ir_node *node, ir_node *left);
893 ir_node *get_Rotl_right(const ir_node *node);
894 void set_Rotl_right(ir_node *node, ir_node *right);
896 ir_node *get_Conv_op(const ir_node *node);
897 void set_Conv_op(ir_node *node, ir_node *op);
898 int get_Conv_strict(const ir_node *node);
899 void set_Conv_strict(ir_node *node, int flag);
901 /* Does Cast need a mem operator?
902 * Cast should only depend on the type, not on the state of an
903 * entity. But: we initialize various fields after Alloc, that
904 * are accessed in the cast. This required some precaution, to
905 * get the right memory into the Loads generated from the cast.
907 ir_node *get_Cast_op(const ir_node *node);
908 void set_Cast_op(ir_node *node, ir_node *op);
909 ir_type *get_Cast_type(ir_node *node);
910 void set_Cast_type(ir_node *node, ir_type *to_tp);
912 /** Checks for upcast.
914 * Returns true if the Cast node casts a class type to a super type.
915 * Works also for pointers to classes (recursively).
917 * Needs typeinfo calculated.
919 int is_Cast_upcast(ir_node *node);
921 /** Checks for downcast.
923 * Returns true if the Cast node casts a class type to a sub type.
924 * Works also for pointers to classes (recursively).
926 * Needs typeinfo calculated.
928 int is_Cast_downcast(ir_node *node);
931 /** Returns true if n is a Phi or a Filter node in INTER-procedural view.
932 Returns false if irg is in phase phase_building and the Phi has zero
933 predecessors: it's a Phi0. */
934 int is_Phi(const ir_node *n);
935 /** Returns true if irg in phase phase_building and the Phi has zero
936 predecessors. It's a Phi0 then. */
937 int is_Phi0(const ir_node *n);
938 /* These routines also work for Filter nodes in INTER-procedural view. */
939 ir_node **get_Phi_preds_arr(ir_node *node);
940 int get_Phi_n_preds(const ir_node *node);
941 ir_node *get_Phi_pred(const ir_node *node, int pos);
942 void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
943 ir_node *get_Phi_next(const ir_node *phi);
944 void set_Phi_next(ir_node *phi, ir_node *next);
946 ir_node *get_Filter_pred(ir_node *node);
947 void set_Filter_pred(ir_node *node, ir_node *pred);
948 long get_Filter_proj(ir_node *node);
949 void set_Filter_proj(ir_node *node, long proj);
950 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
951 * @@@ Maybe better: arity is zero if no cg preds. */
952 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
953 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
954 int get_Filter_n_cg_preds(ir_node *node);
955 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
957 /** Return true if parameter is a memory operation.
959 * A memory operation is an operation that changes the
960 * memory. I.e., a Load or a Store operation.
962 int is_memop(const ir_node *node);
963 ir_node *get_memop_mem(const ir_node *node);
964 void set_memop_mem(ir_node *node, ir_node *mem);
965 ir_node *get_memop_ptr(const ir_node *node);
966 void set_memop_ptr(ir_node *node, ir_node *ptr);
969 * Projection numbers for Load: use for Proj nodes!
972 pn_Load_M = pn_Generic_M_regular, /**< Memory result. */
973 pn_Load_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
974 pn_Load_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
975 pn_Load_res = pn_Generic_other, /**< Result of load operation. */
976 pn_Load_max /**< number of projections from a Load */
977 } pn_Load; /* Projection numbers for Load. */
979 ir_node *get_Load_mem(const ir_node *node);
980 void set_Load_mem(ir_node *node, ir_node *mem);
981 ir_node *get_Load_ptr(const ir_node *node);
982 void set_Load_ptr(ir_node *node, ir_node *ptr);
983 ir_mode *get_Load_mode(const ir_node *node);
984 void set_Load_mode(ir_node *node, ir_mode *mode);
985 ir_volatility get_Load_volatility(const ir_node *node);
986 void set_Load_volatility(ir_node *node, ir_volatility volatility);
987 ir_align get_Load_align(const ir_node *node);
988 void set_Load_align(ir_node *node, ir_align align);
991 * Projection numbers for Store: use for Proj nodes!
994 pn_Store_M = pn_Generic_M_regular, /**< Memory result. */
995 pn_Store_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
996 pn_Store_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
997 pn_Store_max = pn_Generic_other /**< number of projections from a Store */
998 } pn_Store; /* Projection numbers for Store. */
1000 ir_node *get_Store_mem(const ir_node *node);
1001 void set_Store_mem(ir_node *node, ir_node *mem);
1002 ir_node *get_Store_ptr(const ir_node *node);
1003 void set_Store_ptr(ir_node *node, ir_node *ptr);
1004 ir_node *get_Store_value(const ir_node *node);
1005 void set_Store_value(ir_node *node, ir_node *value);
1006 ir_volatility get_Store_volatility(const ir_node *node);
1007 void set_Store_volatility(ir_node *node, ir_volatility volatility);
1008 ir_align get_Store_align(const ir_node *node);
1009 void set_Store_align(ir_node *node, ir_align align);
1012 * Projection numbers for Alloc: use for Proj nodes!
1015 pn_Alloc_M = pn_Generic_M_regular, /**< Memory result. */
1016 pn_Alloc_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1017 pn_Alloc_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
1018 pn_Alloc_res = pn_Generic_other, /**< Result of allocation. */
1019 pn_Alloc_max /**< number of projections from an Alloc */
1020 } pn_Alloc; /* Projection numbers for Alloc. */
1022 ir_node *get_Alloc_mem(const ir_node *node);
1023 void set_Alloc_mem(ir_node *node, ir_node *mem);
1024 ir_node *get_Alloc_size(const ir_node *node);
1025 void set_Alloc_size(ir_node *node, ir_node *size);
1026 ir_type *get_Alloc_type(ir_node *node);
1027 void set_Alloc_type(ir_node *node, ir_type *tp);
1029 ir_where_alloc get_Alloc_where(const ir_node *node);
1030 void set_Alloc_where(ir_node *node, ir_where_alloc where);
1032 ir_node *get_Free_mem(const ir_node *node);
1033 void set_Free_mem(ir_node *node, ir_node *mem);
1034 ir_node *get_Free_ptr(const ir_node *node);
1035 void set_Free_ptr(ir_node *node, ir_node *ptr);
1036 ir_node *get_Free_size(const ir_node *node);
1037 void set_Free_size(ir_node *node, ir_node *size);
1038 ir_type *get_Free_type(ir_node *node);
1039 void set_Free_type(ir_node *node, ir_type *tp);
1041 ir_where_alloc get_Free_where(const ir_node *node);
1042 void set_Free_where(ir_node *node, ir_where_alloc where);
1044 ir_node **get_Sync_preds_arr(ir_node *node);
1045 int get_Sync_n_preds(const ir_node *node);
1046 ir_node *get_Sync_pred(const ir_node *node, int pos);
1047 void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
1048 void add_Sync_pred(ir_node *node, ir_node *pred);
1050 /** Returns the source language type of a Proj node.
1051 * Must be an atomic type. Mode of type must be mode of node.
1053 ir_type *get_Proj_type(ir_node *node);
1055 /** Return the predecessor of a Proj node. */
1056 ir_node *get_Proj_pred(const ir_node *node);
1057 void set_Proj_pred(ir_node *node, ir_node *pred);
1058 /** Return the projection number of a Proj node. */
1059 long get_Proj_proj(const ir_node *node);
1060 void set_Proj_proj(ir_node *node, long proj);
1063 * Returns non-zero if a node is a routine parameter.
1065 * @param node the Proj node to test
1067 int is_arg_Proj(const ir_node *node);
1069 ir_node **get_Tuple_preds_arr(ir_node *node);
1070 int get_Tuple_n_preds(const ir_node *node);
1071 ir_node *get_Tuple_pred(const ir_node *node, int pos);
1072 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
1074 ir_node *get_Id_pred(const ir_node *node);
1075 void set_Id_pred(ir_node *node, ir_node *pred);
1077 /** Confirm has a single result and returns 'value' unchanged.
1078 * The node expresses a restriction on 'value':
1079 * 'value' 'cmp' 'bound' == true. */
1080 ir_node *get_Confirm_value(const ir_node *node);
1081 void set_Confirm_value(ir_node *node, ir_node *value);
1082 ir_node *get_Confirm_bound(const ir_node *node);
1083 void set_Confirm_bound(ir_node *node, ir_node *bound);
1084 pn_Cmp get_Confirm_cmp(const ir_node *node);
1085 void set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
1090 ir_node *get_Mux_sel(const ir_node *node);
1091 void set_Mux_sel(ir_node *node, ir_node *sel);
1092 ir_node *get_Mux_false(const ir_node *node);
1093 void set_Mux_false(ir_node *node, ir_node *ir_false);
1094 ir_node *get_Mux_true(const ir_node *node);
1095 void set_Mux_true(ir_node *node, ir_node *ir_true);
1098 * Projection numbers for result of CopyB node: use for Proj nodes!
1101 pn_CopyB_M_regular = pn_Generic_M_regular, /**< The memory result. */
1102 pn_CopyB_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1103 pn_CopyB_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1104 pn_CopyB_M_except = pn_Generic_other, /**< The memory result in case the runtime function terminated with
1106 pn_CopyB_max /**< number of projections from a CopyB */
1107 } pn_CopyB; /* Projection numbers for CopyB. */
1108 #define pn_CopyB_M pn_CopyB_M_regular
1110 ir_node *get_CopyB_mem(const ir_node *node);
1111 void set_CopyB_mem(ir_node *node, ir_node *mem);
1112 ir_node *get_CopyB_dst(const ir_node *node);
1113 void set_CopyB_dst(ir_node *node, ir_node *dst);
1114 ir_node *get_CopyB_src(const ir_node *node);
1115 void set_CopyB_src(ir_node *node, ir_node *src);
1116 ir_type *get_CopyB_type(ir_node *node);
1117 void set_CopyB_type(ir_node *node, ir_type *data_type);
1120 * Projection numbers for result of InstOf node: use for Proj nodes!
1123 pn_InstOf_M_regular = pn_Generic_M_regular, /**< The memory result. */
1124 pn_InstOf_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1125 pn_InstOf_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1126 pn_InstOf_res = pn_Generic_other, /**< The checked object pointer. */
1127 pn_InstOf_M_except, /**< The memory result in case the runtime function terminated with
1129 pn_InstOf_max /**< number of projections from an InstOf */
1131 #define pn_InstOf_M pn_InstOf_M_regular
1133 /** InstOf access. */
1134 ir_type *get_InstOf_type(ir_node *node);
1135 void set_InstOf_type(ir_node *node, ir_type *type);
1136 ir_node *get_InstOf_store(const ir_node *node);
1137 void set_InstOf_store(ir_node *node, ir_node *obj);
1138 ir_node *get_InstOf_obj(const ir_node *node);
1139 void set_InstOf_obj(ir_node *node, ir_node *obj);
1142 * Projection numbers for Raise.
1145 pn_Raise_M = pn_Generic_M_regular, /**< The Memory result. */
1146 pn_Raise_X = pn_Generic_X_regular, /**< The control flow to the exception handler. */
1147 pn_Raise_max /**< number of projections from a Raise */
1148 } pn_Raise; /* Projection numbers for Raise. */
1150 ir_node *get_Raise_mem(const ir_node *node);
1151 void set_Raise_mem(ir_node *node, ir_node *mem);
1152 ir_node *get_Raise_exo_ptr(const ir_node *node); /* PoinTeR to EXception Object */
1153 void set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
1156 * Projection numbers for result of Bound node: use for Proj nodes!
1159 pn_Bound_M = pn_Generic_M_regular, /**< The memory result. */
1160 pn_Bound_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1161 pn_Bound_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1162 pn_Bound_res = pn_Generic_other, /**< The checked index. */
1163 pn_Bound_max /**< number of projections from a Bound */
1166 /** Returns the memory input of a Bound operation. */
1167 ir_node *get_Bound_mem(const ir_node *bound);
1168 void set_Bound_mem(ir_node *bound, ir_node *mem);
1170 /** Returns the index input of a Bound operation. */
1171 ir_node *get_Bound_index(const ir_node *bound);
1172 void set_Bound_index(ir_node *bound, ir_node *idx);
1174 /** Returns the lower bound input of a Bound operation. */
1175 ir_node *get_Bound_lower(const ir_node *bound);
1176 void set_Bound_lower(ir_node *bound, ir_node *lower);
1178 /** Returns the upper bound input of a Bound operation. */
1179 ir_node *get_Bound_upper(const ir_node *bound);
1180 void set_Bound_upper(ir_node *bound, ir_node *upper);
1182 /** Return the operand of a Pin node. */
1183 ir_node *get_Pin_op(const ir_node *pin);
1184 void set_Pin_op(ir_node *pin, ir_node *node);
1186 /** Return the assembler text of an ASM pseudo node. */
1187 ident *get_ASM_text(const ir_node *node);
1188 /** Return the number of input constraints for an ASM node. */
1189 int get_ASM_n_input_constraints(const ir_node *node);
1190 /** Return the input constraints for an ASM node. */
1191 const ir_asm_constraint *get_ASM_input_constraints(const ir_node *node);
1192 /** Return the number of output constraints for an ASM node. */
1193 int get_ASM_n_output_constraints(const ir_node *node);
1194 /** Return the output constraints for an ASM node. */
1195 const ir_asm_constraint *get_ASM_output_constraints(const ir_node *node);
1196 /** Return the number of clobbered registers for an ASM node. */
1197 int get_ASM_n_clobbers(const ir_node *node);
1198 /** Return the list of clobbered registers for an ASM node. */
1199 ident **get_ASM_clobbers(const ir_node *node);
1203 * NAME Auxiliary routines
1207 /** Returns operand of node if node is a Proj. */
1208 ir_node *skip_Proj(ir_node *node);
1209 /** Returns operand of node if node is a Proj. */
1210 const ir_node *skip_Proj_const(const ir_node *node);
1211 /** Returns operand of node if node is a Id. */
1212 ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
1213 /** Returns corresponding operand of Tuple if node is a Proj from
1215 ir_node *skip_Tuple(ir_node *node);
1216 /** Returns operand of node if node is a Cast. */
1217 ir_node *skip_Cast(ir_node *node);
1218 const ir_node *skip_Cast_const(const ir_node *node);
1219 /** Returns operand of node if node is a Pin. */
1220 ir_node *skip_Pin(ir_node *node);
1221 /** Returns operand of node if node is a Confirm */
1222 ir_node *skip_Confirm(ir_node *node);
1223 /** Skip all high-level Operations (including Cast, Confirm). */
1224 ir_node *skip_HighLevel_ops(ir_node *node);
1225 /** Returns true if irn is a Const node. */
1226 int is_Const(const ir_node *node);
1227 /** Returns true if a node is a Conv node. */
1228 int is_Conv(const ir_node *node);
1229 /** Returns true if a node is a strictConv node. */
1230 int is_strictConv(const ir_node *node);
1231 /** Returns true if a node is a Cast node. */
1232 int is_Cast(const ir_node *node);
1233 /** Returns true if node is a Bad node. */
1234 int is_Bad(const ir_node *node);
1235 /** Returns true if node is a NoMem node. */
1236 int is_NoMem(const ir_node *node);
1237 /** Returns true if node is a Start node. */
1238 int is_Start(const ir_node *node);
1239 /** Returns true if node is a Minus node. */
1240 int is_Minus(const ir_node *node);
1241 /** Returns true if node is a Abs node. */
1242 int is_Abs(const ir_node *node);
1243 /** Returns true if node is a Mod node. */
1244 int is_Mod(const ir_node *node);
1245 /** Returns true if node is a Div node. */
1246 int is_Div(const ir_node *node);
1247 /** Returns true if node is a DivMod node. */
1248 int is_DivMod(const ir_node *node);
1249 /** Returns true if node is a Quot node. */
1250 int is_Quot(const ir_node *node);
1251 /** Returns true if node is an Add node. */
1252 int is_Add(const ir_node *node);
1253 /** Returns true if node is a Carry node. */
1254 int is_Carry(const ir_node *node);
1255 /** Returns true if node is an And node. */
1256 int is_And(const ir_node *node);
1257 /** Returns true if node is an Or node. */
1258 int is_Or(const ir_node *node);
1259 /** Returns true if node is an Eor node. */
1260 int is_Eor(const ir_node *node);
1261 /** Returns true if node is a Sub node. */
1262 int is_Sub(const ir_node *node);
1263 /** Returns true if node is a Not node. */
1264 int is_Not(const ir_node *node);
1265 /** Returns true if node is a Shl node. */
1266 int is_Shl(const ir_node *node);
1267 /** Returns true if node is a Shr node. */
1268 int is_Shr(const ir_node *node);
1269 /** Returns true if node is a Shrs node. */
1270 int is_Shrs(const ir_node *node);
1271 /** Returns true if node is a Rotl node. */
1272 int is_Rotl(const ir_node *node);
1273 /** Returns true if node is an Id node. */
1274 int is_Id(const ir_node *node);
1275 /** Returns true if node is a Tuple node. */
1276 int is_Tuple(const ir_node *node);
1277 /** Returns true if node is a Bound node. */
1278 int is_Bound(const ir_node *node);
1279 /** Returns true if the node is not a Block */
1280 int is_no_Block(const ir_node *node);
1281 /** Returns true if the node is a Block */
1282 int is_Block(const ir_node *node);
1283 /** Returns true if node is an Unknown node. */
1284 int is_Unknown(const ir_node *node);
1285 /** Returns true if node is a Return node. */
1286 int is_Return(const ir_node *node);
1287 /** Returns true if node is a Call node. */
1288 int is_Call(const ir_node *node);
1289 /** Returns true if node is a Builtin node. */
1290 int is_Builtin(const ir_node *node);
1291 /** Returns true if node is a CallBegin node. */
1292 int is_CallBegin(const ir_node *node);
1293 /** Returns true if node is a Sel node. */
1294 int is_Sel(const ir_node *node);
1295 /** Returns true if node is a Mul node. */
1296 int is_Mul(const ir_node *node);
1297 /** Returns true if node is a Mulh node. */
1298 int is_Mulh(const ir_node *node);
1299 /** Returns true if node is a Mux node. */
1300 int is_Mux(const ir_node *node);
1301 /** Returns true if node is a Load node. */
1302 int is_Load(const ir_node *node);
1303 /** Returns true if node is a Store node. */
1304 int is_Store(const ir_node *node);
1305 /** Returns true if node is a Sync node. */
1306 int is_Sync(const ir_node *node);
1307 /** Returns true if node is a Confirm node. */
1308 int is_Confirm(const ir_node *node);
1309 /** Returns true if node is a Pin node. */
1310 int is_Pin(const ir_node *node);
1311 /** Returns true if node is a SymConst node. */
1312 int is_SymConst(const ir_node *node);
1313 /** Returns true if node is a SymConst node with kind symconst_addr_ent. */
1314 int is_SymConst_addr_ent(const ir_node *node);
1315 /** Returns true if node is a Cond node. */
1316 int is_Cond(const ir_node *node);
1317 /** Returns true of node is a CopyB node. */
1318 int is_CopyB(const ir_node *node);
1319 /** Returns true if node is a Cmp node. */
1320 int is_Cmp(const ir_node *node);
1321 /** Returns true if node is an Alloc node. */
1322 int is_Alloc(const ir_node *node);
1323 /** Returns true if node is a Free node. */
1324 int is_Free(const ir_node *node);
1325 /** Returns true if a node is a Jmp node. */
1326 int is_Jmp(const ir_node *node);
1327 /** Returns true if a node is a IJmp node. */
1328 int is_IJmp(const ir_node *node);
1329 /** Returns true if a node is a Raise node. */
1330 int is_Raise(const ir_node *node);
1331 /** Returns true if a node is an ASM node. */
1332 int is_ASM(const ir_node *node);
1333 /** Returns true if a node is an Dummy node. */
1334 int is_Dummy(const ir_node *node);
1335 /** Returns true if node is a Proj node or a Filter node in INTRA-procedural view. */
1336 int is_Proj(const ir_node *node);
1337 /** Returns true if node is a Filter node. */
1338 int is_Filter(const ir_node *node);
1340 /** Returns true if the operation manipulates control flow:
1341 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1342 int is_cfop(const ir_node *node);
1344 /** Returns true if the operation manipulates interprocedural control flow:
1345 CallBegin, EndReg, EndExcept */
1346 int is_ip_cfop(const ir_node *node);
1347 /** Returns true if the operation can change the control flow because
1348 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1349 Bad. Raise is not fragile, but a unconditional jump. */
1350 int is_fragile_op(const ir_node *node);
1351 /** Returns the memory operand of fragile operations. */
1352 ir_node *get_fragile_op_mem(ir_node *node);
1353 /** Returns the result mode of a Div operation. */
1354 ir_mode *get_divop_resmod(const ir_node *node);
1356 /** Returns true if the operation is a forking control flow
1357 * operation: Cond. */
1358 int is_irn_forking(const ir_node *node);
1360 /** Return the type associated with the value produced by n
1361 * if the node remarks this type as it is the case for
1362 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1363 ir_type *get_irn_type(ir_node *n);
1365 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1367 ir_type *get_irn_type_attr(ir_node *n);
1369 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1370 ir_entity *get_irn_entity_attr(ir_node *n);
1372 /** Returns non-zero for constant-like nodes. */
1373 int is_irn_constlike(const ir_node *node);
1376 * Returns non-zero for nodes that must be always optimized
1377 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1379 int is_irn_always_opt(const ir_node *node);
1382 * Returns non-zero for nodes that are allowed to have keep-alives and
1383 * are neither Block nor PhiM.
1385 int is_irn_keep(const ir_node *node);
1388 * Returns non-zero for nodes that are always placed in the start block.
1390 int is_irn_start_block_placed(const ir_node *node);
1393 * Returns non-zero for nodes that are machine operations.
1395 int is_irn_machine_op(const ir_node *node);
1398 * Returns non-zero for nodes that are machine operands.
1400 int is_irn_machine_operand(const ir_node *node);
1403 * Returns non-zero for nodes that have the n'th user machine flag set.
1405 int is_irn_machine_user(const ir_node *node, unsigned n);
1408 * A type to express conditional jump predictions.
1411 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1412 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1413 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1414 } cond_jmp_predicate;
1416 /** Gets the string representation of the jump prediction. */
1417 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1419 /** Returns the conditional jump prediction of a Cond node. */
1420 cond_jmp_predicate get_Cond_jmp_pred(const ir_node *cond);
1422 /** Sets a new conditional jump prediction. */
1423 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1425 /** Checks whether a node represents a global address. */
1426 int is_Global(const ir_node *node);
1428 /* Returns the entity of a global address. */
1429 ir_entity *get_Global_entity(const ir_node *node);
1432 * Access custom node data.
1433 * The data must have been registered with
1434 * register_additional_node_data() before.
1435 * @param node The ir node to get the data from.
1436 * @param type The type of the data you registered.
1437 * @param off The value returned by register_additional_node_data().
1438 * @return A pointer of type @p type.
1440 #define get_irn_data(node,type,off) \
1441 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1444 * Get the pointer to the node some custom data belongs to.
1445 * @param data The pointer to the custom data.
1446 * @param off The number as returned by register_additional_node_data().
1447 * @return A pointer to the ir node the custom data belongs to.
1449 #define get_irn_data_base(data,off) \
1450 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1453 * Request additional data to be allocated with an ir node.
1454 * @param size The size of the additional data required.
1455 * @return A positive number, if the operation was successful, which
1456 * must be passed to the access macro get_irn_data(), 0 if the
1457 * registration failed.
1459 unsigned firm_register_additional_node_data(unsigned size);
1462 * Return a pointer to the node attributes.
1463 * Needed for user-defined nodes.
1465 void *get_irn_generic_attr(ir_node *node);
1466 const void *get_irn_generic_attr_const(const ir_node *node);
1469 * Returns the unique node index for the node in its graph.
1470 * This index is used to access phase information for this node.
1472 unsigned get_irn_idx(const ir_node *node);
1475 * Sets the debug information of a node.
1477 * @param n The node.
1478 * @param db The debug info.
1480 void set_irn_dbg_info(ir_node *n, dbg_info *db);
1483 * Returns the debug information of an node.
1485 * @param n The node.
1487 dbg_info *get_irn_dbg_info(const ir_node *n);
1490 * Calculate a hash value of a node. Only inputs, mode and opcode are used.
1492 * @param node the node to hash
1494 unsigned firm_default_hash(const ir_node *node);
1497 * returns a descriptive name of a node (containing type+number)
1499 const char *gdb_node_helper(void *firm_object);
1501 /*@}*/ /* end of ir_node group definition */