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 * - arity - The number of predecessors in the Firm graph.
55 * - in - A list with the predecessors in the Firm graph. There are
56 * routines to access individual elements and to obtain the
57 * array. The method returning the array should not be used.
58 * - mode - The mode of the node. There are routines to get the mode
59 * but also to access the mode's fields directly.
60 * - opcode - The opcode of the node. There are routines to get the opcode
61 * but also to access the opcode's fields directly.
62 * - node_nr - A unique number for the node. Available only if debugging
68 * Some projection numbers must be always equal to support automatic phi construction
71 pn_Generic_M = 0, /**< The memory result. */
72 pn_Generic_X_regular = 1, /**< Execution result if no exception occurred. */
73 pn_Generic_X_except = 2, /**< The control flow result branching to the exception handler */
74 pn_Generic_other = 3 /**< First free projection number */
78 * Checks whether a pointer points to a ir node.
80 * @param thing an arbitrary pointer
81 * @return non-zero if the thing is a ir mode, else zero
83 int is_ir_node (const void *thing);
86 * Returns the number of predecessors without the block predecessor.
88 * @param node the IR-node
90 int get_irn_arity (const ir_node *node);
91 int get_irn_intra_arity(const ir_node *node);
92 int get_irn_inter_arity(const ir_node *node);
94 /** Replaces the old in array by a new one that will contain the ins given in
95 the parameters. Conserves the block predecessor. It copies the array passed.
96 This function is necessary to adjust in arrays of blocks, calls and phis.
97 Assumes that current_ir_graph is set to the graph containing "node".
98 "in" must contain all predecessors except the block that are required for
100 void set_irn_in(ir_node *node, int arity, ir_node *in[]);
102 /* to iterate through the predecessors without touching the array. No
103 order of predecessors guaranteed.
104 To iterate over the operands iterate from 0 to i < get_irn_arity(),
105 to iterate including the Block predecessor iterate from i = -1 to
106 i < get_irn_arity. */
107 /* Access predecessor n */
110 * Get the n-th predecessor of a node.
111 * This function removes Id predecessors.
112 * This function automatically handles intra- and interprocedural views.
114 ir_node *get_irn_n(const ir_node *node, int n);
117 * Add a artificial dependency to the node.
118 * The dependency is only inserted if it is not there already.
119 * This is only allowed in phase_backend!
121 * @param node The node.
122 * @param dep The dependency target.
124 * @return The index in the array (get_irn_dep() with that index returns @p dep).
126 int add_irn_dep(ir_node *node, ir_node *dep);
129 * Copy all dependencies from a node to another.
130 * This is only allowed in phase_backend!
132 * @param tgt The node which should be enriched.
133 * @param src The node whose dependencies shall be copied.
135 void add_irn_deps(ir_node *tgt, ir_node *src);
138 * Get the length of the dependency array.
139 * @param node The node.
140 * @return The length of the dependency array or 0 if it has not yet been allocated.
142 int get_irn_deps(const ir_node *node);
145 * Get an entry of the dependency array.
146 * @param node The node.
147 * @param pos The position.
148 * @return The node at that position.
150 ir_node *get_irn_dep(const ir_node *node, int pos);
153 * Set an entry of the dependency array.
154 * @param node The node.
155 * @param pos The position.
156 * @param dep The dependency target.
158 void set_irn_dep(ir_node *node, int pos, ir_node *dep);
162 * Get the n-th predecessor of a node in intraprocedural view.
163 * Can be used always if it's know that node is not a split one.
165 ir_node *get_irn_intra_n(const ir_node *node, int n);
168 * Get the n-th predecessor of a node in interprocedural view.
170 ir_node *get_irn_inter_n(const ir_node *node, int n);
172 /** Replace the n-th predecessor of a node with a new one. */
173 void set_irn_n(ir_node *node, int n, ir_node *in);
175 * Appends a new predecessor to a node. This only works for nodes with
177 * @returns the number of the new input
179 int add_irn_n(ir_node *node, ir_node *in);
180 /* Remove predecessor i from Sync n */
181 void del_Sync_n(ir_node *n, int i);
182 /* Sets the mode struct of node. */
183 void set_irn_mode(ir_node *node, ir_mode *mode);
184 /** Gets the mode struct of a node. */
185 ir_mode *get_irn_mode(const ir_node *node);
186 /** Gets the ident for a string representation of the mode .*/
187 ident *get_irn_modeident(const ir_node *node);
188 /** Gets the string representation of the mode .*/
189 const char *get_irn_modename(const ir_node *node);
190 /** Gets the opcode struct of the node. */
191 ir_op *get_irn_op(const ir_node *node);
192 /** Sets the opcode struct of the node. */
193 void set_irn_op(ir_node *node, ir_op *op);
194 /** Gets the opcode-enum of the node. */
195 unsigned get_irn_opcode(const ir_node *node);
196 /** Get the string representation of the opcode. */
197 const char *get_irn_opname(const ir_node *node);
198 /** Get the ident for a string representation of the opcode. */
199 ident *get_irn_opident(const ir_node *node);
200 /** If arg is an argument of the node, returns it's position, -1 otherwise */
201 int get_irn_pred_pos(ir_node *node, ir_node *arg);
202 /** Gets the visited counter of a node. */
203 ir_visited_t get_irn_visited(const ir_node *node);
204 /** Sets the visited counter of a node. */
205 void set_irn_visited(ir_node *node, ir_visited_t visited);
206 /** Sets visited to get_irg_visited(current_ir_graph). */
207 void mark_irn_visited(ir_node *node);
208 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
209 int irn_visited(const ir_node *node);
210 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). Marks the node
211 * visited, if it was not. */
212 int irn_visited_else_mark(ir_node *node);
215 * Sets the link of a node.
216 * Only allowed if the graph is NOT in phase_building.
218 void set_irn_link(ir_node *node, void *link);
220 /** Returns the link of a node. */
221 void *get_irn_link(const ir_node *node);
223 /** Returns the ir_graph this node belongs to. */
224 ir_graph *get_irn_irg(const ir_node *node);
226 /** Outputs a unique number for this node if libFIRM is compiled for
227 debugging, (configure with --enable-debug) else returns address
228 of node cast to long. */
229 long get_irn_node_nr(const ir_node *node);
231 /** Returns the pinned state of a node.
233 * Returns whether the node _always_ must be pinned.
234 * I.e., the node is not floating after global cse.
236 * @returns Either state op_pin_state_pinned or op_pin_state_floats.
238 op_pin_state get_irn_pinned(const ir_node *node);
240 /** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
241 void set_irn_pinned(ir_node *node, op_pin_state state);
243 /** Returns whether the node is currently pinned.
245 * If get_irn_pinned returns op_pin_state_floats and the graph the
246 * node belongs to is in state op_poin_state_floats then this function
247 * returns 'floats', else 'pinned'.
249 op_pin_state is_irn_pinned_in_irg(const ir_node *node);
252 * IR node constructor.
253 * Create a new IR node in irg, with an op, mode, arity and
254 * some incoming IR nodes.
255 * This constructor is used in every specific IR node constructor.
257 * @param db Debug info.
258 * @param irg IR-graph on with this new node should be constructed.
259 * @param block The block the new node belongs to
260 * @param op The opcode of the new node.
261 * @param mode The mode of the new node.
262 * @param arity The arity of the new node, <0 if can be changed dynamically.
263 * @param in An array of arity predecessor nodes.
266 new_ir_node(dbg_info *db,
275 * Return the block the node belongs to. This is only
276 * possible for pinned nodes or if the graph is in pinned state.
277 * Otherwise the block may be incorrect. This condition is
278 * now checked by an assertion.
280 * This works for all except Block. It can return Blocks or the Bad node.
282 * To express the difference to access routines that work for all
283 * nodes we use infix "nodes" and do not name this function
284 * get_irn_block(). */
285 ir_node *get_nodes_block (const ir_node *node);
287 /** Sets the Block of a node. */
288 void set_nodes_block (ir_node *node, ir_node *block);
291 * Return the MacroBlock the node belongs to. This is only
292 * possible for pinned nodes or if the graph is in pinned state.
293 * Otherwise the MacroBlock may be incorrect. This condition is
294 * now checked by an assertion.
296 * This works for all except Block. It can return Blocks or the Bad node.
298 * To express the difference to access routines that work for all
299 * nodes we use infix "nodes" and do not name this function
300 * get_irn_MacroBlock(). */
301 ir_node *get_nodes_MacroBlock(const ir_node *node);
304 * Projection numbers for result of Start node: use for Proj nodes!
307 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
308 pn_Start_M, /**< Projection on the initial memory. */
309 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
310 pn_Start_P_tls, /**< Projection on the pointer to the thread local store
311 segment containing _all_thread local variables. */
312 pn_Start_T_args, /**< Projection on all arguments. */
313 pn_Start_max /**< number of projections from a Start */
314 } pn_Start; /* Projection numbers for Start. */
316 /** Test whether arbitrary node is frame pointer.
318 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
319 * from Start. If so returns frame type, else Null. */
320 ir_type *is_frame_pointer(const ir_node *n);
322 /** Test whether arbitrary node is the thread local storage (tls) pointer.
324 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
325 * from Start. If so returns tls type, else Null. */
326 ir_type *is_tls_pointer(const ir_node *n);
328 /** Return the number of control flow predecessors of a block. */
329 int get_Block_n_cfgpreds(const ir_node *block);
330 /** Return the control flow predecessor of a block at a given position. */
331 ir_node *get_Block_cfgpred(const ir_node *block, int pos);
332 /** Set the control flow predecessor of a block at a given position. */
333 void set_Block_cfgpred(ir_node *block, int pos, ir_node *pred);
336 * Return the position of the predecessor block pred in the inputs
337 * of the block block.
339 * @param block the block
340 * @param pred a predecessor block of block
342 * @return the position of pred in block or -1
344 * @note When using the old extended basic block form for blocks
345 * with exception exists, a predecessor block might have more
346 * than one position. In that case it is not specified, with is returned.
348 int get_Block_cfgpred_pos(const ir_node *block, const ir_node *pred);
350 /** Get the predecessor block.
352 * Returns the block corresponding to the predecessor pos of block.
354 * There are several ambiguities we resolve with this function:
355 * - The direct predecessor can be a Proj, which is not pinned.
356 * We walk from the predecessor to the next pinned node
357 * (skip_Proj) and return the block that node is in.
358 * - If we encounter the Bad node, this function does not return
359 * Start block, but the Bad node.
361 ir_node *get_Block_cfgpred_block(const ir_node *node, int pos);
363 /** Return the matured flag of a block */
364 int get_Block_matured(const ir_node *block);
365 /** set the matured flag of a block. */
366 void set_Block_matured(ir_node *block, int matured);
368 /** A visited flag only for block nodes.
369 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
370 ir_visited_t get_Block_block_visited(const ir_node *block);
371 void set_Block_block_visited(ir_node *block, ir_visited_t visit);
374 * Marks a block as dead but do not replace it with a Bad node.
375 * Dead blocks are removed in the con
377 ir_node *set_Block_dead(ir_node *block);
378 int is_Block_dead(const ir_node *block);
380 /* For this current_ir_graph must be set. */
381 void mark_Block_block_visited(ir_node *node);
382 int Block_block_visited(const ir_node *node);
384 #ifdef INTERPROCEDURAL_VIEW
385 /* Set and remove interprocedural predecessors. If the interprocedural
386 * predecessors are removed, the node has the same predecessors in
388 * @@@ Maybe better: arity is zero if no cg preds. */
389 void set_Block_cg_cfgpred_arr(ir_node *node, int arity, ir_node *in[]);
390 void set_Block_cg_cfgpred(ir_node *node, int pos, ir_node *pred);
391 /* @@@ not supported */
392 ir_node **get_Block_cg_cfgpred_arr(ir_node *node);
393 /** Returns the number of interprocedural predecessors. 0 if none. */
394 int get_Block_cg_n_cfgpreds(const ir_node *node);
395 /** Return the interprocedural predecessor at position pos. */
396 ir_node *get_Block_cg_cfgpred(const ir_node *node, int pos);
397 /** Frees the memory allocated for interprocedural predecessors. */
398 void remove_Block_cg_cfgpred_arr(ir_node *node);
401 /** Returns the extended basic block a block belongs to. */
402 ir_extblk *get_Block_extbb(const ir_node *block);
403 /** Sets the extended basic block a block belongs to. */
404 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
405 /** Get the Macro Block header of a (sub-) block. */
406 ir_node *get_Block_MacroBlock(const ir_node *block);
407 /** Set the Macro Block header of a (sub-) block. */
408 void set_Block_MacroBlock(ir_node *block, ir_node *mbh);
409 /** Get the Macro Block header of a node. */
410 ir_node *get_irn_MacroBlock(const ir_node *n);
411 /** Returns the ir_graph this Block belongs to. */
412 ir_graph *get_Block_irg(const ir_node *block);
413 /** Returns non-zero if the block has an entity assigned */
414 int has_Block_entity(const ir_node *block);
415 /** Returns the entity for a Block */
416 ir_entity *get_Block_entity(const ir_node *block);
417 /** Returns the entity for a Block (creating it if necessary) */
418 ir_entity *create_Block_entity(ir_node *block);
419 /** Set a new entity for a block */
420 void set_Block_entity(ir_node *block, ir_entity *entity);
421 /** Gets the head of the Phi list for this block. */
422 ir_node *get_Block_phis(const ir_node *block);
423 /** Sets the head of the Phi list for this block. */
424 void set_Block_phis(ir_node *block, ir_node *phi);
425 /** Add a Phi node to the list of Block Phi's. */
426 void add_Block_phi(ir_node *block, ir_node *phi);
427 /** Get the Block mark (single bit). */
428 unsigned get_Block_mark(const ir_node *block);
429 /** Set the Block mark (single bit). */
430 void set_Block_mark(ir_node *block, unsigned mark);
432 /** Return the number of Keep alive node. */
433 int get_End_n_keepalives(const ir_node *end);
434 /** Return the Keep alive node a position pos. */
435 ir_node *get_End_keepalive(const ir_node *end, int pos);
436 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
437 void add_End_keepalive(ir_node *end, ir_node *ka);
438 /** Set the Keep alive node at position pos. */
439 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
442 * Set new keep-alives.
443 * Beware: This might be an expensive operation if dynamic edges are enabled,
444 * so avoid it in the backend.
446 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
448 /** Remove irn from the keep-alive set. */
449 void remove_End_keepalive(ir_node *end, ir_node *irn);
451 /* Remove Bads, NoMem and doublets from the keep-alive set. */
452 void remove_End_Bads_and_doublets(ir_node *end);
454 /** Some parts of the End node are allocated separately -- their memory
455 is not recovered by dead_node_elimination if a End node is dead.
456 free_End() frees these data structures. */
457 void free_End(ir_node *end);
459 /** Return the target address of an IJmp */
460 ir_node *get_IJmp_target(const ir_node *ijmp);
461 /** Sets the target address of an IJmp */
462 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
464 ir_node *get_Cond_selector(const ir_node *node);
465 void set_Cond_selector(ir_node *node, ir_node *selector);
466 long get_Cond_default_proj(const ir_node *node);
467 void set_Cond_default_proj(ir_node *node, long defproj);
470 * Projection numbers for conditions.
473 pn_Cond_false, /**< Control flow if operand is "false". */
474 pn_Cond_true, /**< Control flow if operand is "true". */
475 pn_Cond_max /**< number of projections from a Cond */
476 } pn_Cond; /* Projection numbers for Cond. */
478 ir_node *get_Return_mem(const ir_node *node);
479 void set_Return_mem(ir_node *node, ir_node *mem);
480 ir_node **get_Return_res_arr(ir_node *node);
481 int get_Return_n_ress(const ir_node *node);
482 ir_node *get_Return_res(const ir_node *node, int pos);
483 void set_Return_res(ir_node *node, int pos, ir_node *res);
485 tarval *get_Const_tarval(const ir_node *node);
486 void set_Const_tarval(ir_node *node, tarval *con);
488 /** Return non-zero if the given Const node represents the 0 constant. */
489 int is_Const_null(const ir_node *node);
491 /** Return non-zero if the given Const node represents the 1 constant. */
492 int is_Const_one(const ir_node *node);
494 /** Return non-zero if the given Const node represents the constant with all bits set. */
495 int is_Const_all_one(const ir_node *node);
497 /** Returns the source language type of a Const node.
498 * Must be an atomic type. Mode of type must be mode of node.
500 ir_type *get_Const_type(ir_node *node);
502 /** Sets the source language type of a Const node. */
503 void set_Const_type(ir_node *node, ir_type *tp);
505 /** Returns non-zero if s symconst kind has a type attribute */
506 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
508 /** Returns non-zero if s symconst kind has an ident attribute */
509 #define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)
511 /** Returns non-zero if s symconst kind has an entity attribute */
512 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
514 /** Returns non-zero if s symconst kind has an enum_const attribute */
515 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
517 /** Get the kind of the SymConst. */
518 symconst_kind get_SymConst_kind(const ir_node *node);
519 /** Set the kind of the SymConst. */
520 void set_SymConst_kind(ir_node *node, symconst_kind num);
522 /** Only to access SymConst of kind type_tag or size. Else assertion: */
523 ir_type *get_SymConst_type(const ir_node *node);
524 void set_SymConst_type(ir_node *node, ir_type *tp);
526 /** Only to access SymConst of kind addr_name. Else assertion: */
527 ident *get_SymConst_name(const ir_node *node);
528 void set_SymConst_name(ir_node *node, ident *name);
530 /** Only to access SymConst of kind addr_ent. Else assertion: */
531 ir_entity *get_SymConst_entity(const ir_node *node);
532 void set_SymConst_entity(ir_node *node, ir_entity *ent);
534 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
535 ir_enum_const *get_SymConst_enum(const ir_node *node);
536 void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
538 /** Sets both: type and ptrinfo. Needed to treat the node independent of
539 its semantics. Does a memcpy for the memory sym points to. */
540 /* write 'union': firmjni then does not create a method... */
541 union symconst_symbol get_SymConst_symbol(const ir_node *node);
542 void set_SymConst_symbol(ir_node *node,
543 union symconst_symbol sym);
545 /** Access the type of the value represented by the SymConst.
547 * Example: primitive type int for SymConst size. */
548 ir_type *get_SymConst_value_type(ir_node *node);
549 void set_SymConst_value_type(ir_node *node, ir_type *tp);
551 ir_node *get_Sel_mem(const ir_node *node);
552 void set_Sel_mem(ir_node *node, ir_node *mem);
553 ir_node *get_Sel_ptr(const ir_node *node); /* ptr to the object to select from */
554 void set_Sel_ptr(ir_node *node, ir_node *ptr);
555 ir_node **get_Sel_index_arr(ir_node *node);
556 int get_Sel_n_indexs(const ir_node *node);
557 ir_node *get_Sel_index(const ir_node *node, int pos);
558 void set_Sel_index(ir_node *node, int pos, ir_node *index);
559 ir_entity *get_Sel_entity(const ir_node *node); /* entity to select */
560 void set_Sel_entity (ir_node *node, ir_entity *ent);
563 * Projection numbers for result of Call node: use for Proj nodes!
566 pn_Call_M = pn_Generic_M, /**< The memory result. */
567 pn_Call_X_regular = pn_Generic_X_regular, /**< The control flow result when no exception occurs. */
568 pn_Call_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler. */
569 pn_Call_T_result = pn_Generic_other, /**< The tuple containing all (0, 1, 2, ...) results. */
570 pn_Call_P_value_res_base, /**< A pointer to the memory region containing copied results
571 passed by value (for compound result types). */
572 pn_Call_max /**< number of projections from a Call */
573 } pn_Call; /* Projection numbers for Call. */
575 /** Retrieve the memory input of a Call. */
576 ir_node *get_Call_mem(const ir_node *node);
577 /** Set the memory input of a Call. */
578 void set_Call_mem(ir_node *node, ir_node *mem);
579 /** Retrieve the call address of a Call. */
580 ir_node *get_Call_ptr(const ir_node *node);
581 /** Set the call address of a Call. */
582 void set_Call_ptr(ir_node *node, ir_node *ptr);
583 ir_node **get_Call_param_arr(ir_node *node);
584 /** Gets the number of parameters of a call. */
585 int get_Call_n_params(const ir_node *node);
586 /** Gets the call parameter at position pos. */
587 ir_node *get_Call_param(const ir_node *node, int pos);
588 /** Sets the call parameter at position pos. */
589 void set_Call_param(ir_node *node, int pos, ir_node *param);
590 /** Gets the type of a call. */
591 ir_type *get_Call_type(ir_node *node);
592 /** Sets the type of a call. */
593 void set_Call_type(ir_node *node, ir_type *tp);
594 /** Returns non-zero if this call can be a tail-call. */
595 unsigned get_Call_tail_call(const ir_node *node);
596 /** Sets the tail call attribute. */
597 void set_Call_tail_call(ir_node *node, unsigned tail_call);
600 * Returns non-zero if a Call is surely a self-recursive Call.
601 * Beware: if this functions returns 0, the call might be self-recursive!
603 int is_self_recursive_Call(const ir_node *call);
605 /** Set, get and remove the callee information for a Call node.
607 * The callee information lists all method entities that can be called
608 * from this node. If the address expression can not be analyzed fully,
609 * e.g., as entities can be called that are not in the compilation unit,
610 * the array contains the unknown_entity. The array contains only entities
611 * with peculiarity_existent, but with all kinds of visibility. The entities
612 * not necessarily contain an irg.
614 * The array is only accessible if callee information is valid. See flag
617 * The memory allocated for the array is managed automatically, i.e., it must
618 * not be freed if the Call node is removed from the graph.
620 * @param node A Call node.
622 int Call_has_callees(const ir_node *node);
623 int get_Call_n_callees(const ir_node *node);
624 ir_entity *get_Call_callee(const ir_node *node, int pos);
626 /** Set the full callee array.
628 * The passed array is copied. Assumes current_ir_graph set properly! */
629 void set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
630 void remove_Call_callee_arr(ir_node *node);
633 * Projection numbers for result of Builtin node: use for Proj nodes!
636 pn_Builtin_M = pn_Generic_M, /**< The memory result. */
637 pn_Builtin_1_result = pn_Generic_other, /**< first result. */
638 pn_Builtin_max /**< number of projections from a Builtin */
639 } pn_Builtin; /* Projection numbers for Builtin. */
641 ir_node *get_Builtin_mem(const ir_node *node);
642 void set_Builtin_mem(ir_node *node, ir_node *mem);
643 ir_builtin_kind get_Builtin_kind(const ir_node *node);
644 void set_Builtin_kind(ir_node *node, ir_builtin_kind kind);
645 ir_node **get_Builtin_param_arr(ir_node *node);
646 /** Gets the number of parameters of a Builtin. */
647 int get_Builtin_n_params(const ir_node *node);
648 /** Gets the Builtin parameter at position pos. */
649 ir_node *get_Builtin_param(const ir_node *node, int pos);
650 /** Sets the Builtin parameter at position pos. */
651 void set_Builtin_param(ir_node *node, int pos, ir_node *param);
652 /** Gets the type of a builtin. */
653 ir_type *get_Builtin_type(ir_node *node);
654 /** Sets the type of a Builtin. */
655 void set_Builtin_type(ir_node *node, ir_type *tp);
656 /** Returns a human readable string for the ir_builtin_kind. */
657 const char *get_builtin_kind_name(ir_builtin_kind kind);
659 /** Retrieve the call address of a CallBegin. */
660 ir_node *get_CallBegin_ptr(const ir_node *node);
661 /** Set the call address of a CallBegin. */
662 void set_CallBegin_ptr(ir_node *node, ir_node *ptr);
663 /** Retrieve the original Call node of a CallBegin. */
664 ir_node *get_CallBegin_call(const ir_node *node);
665 /** Set the original Call node of a CallBegin. */
666 void set_CallBegin_call(ir_node *node, ir_node *call);
668 /* For unary and binary arithmetic operations the access to the
669 operands can be factored out. Left is the first, right the
670 second arithmetic value as listed in tech report 1999-44.
671 unops are: Minus, Abs, Not, Conv, Cast
672 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
673 Shr, Shrs, Rotl, Cmp */
674 int is_unop(const ir_node *node);
675 ir_node *get_unop_op(const ir_node *node);
676 void set_unop_op(ir_node *node, ir_node *op);
677 int is_binop(const ir_node *node);
678 ir_node *get_binop_left(const ir_node *node);
679 void set_binop_left(ir_node *node, ir_node *left);
680 ir_node *get_binop_right(const ir_node *node);
681 void set_binop_right(ir_node *node, ir_node *right);
683 ir_node *get_Add_left(const ir_node *node);
684 void set_Add_left(ir_node *node, ir_node *left);
685 ir_node *get_Add_right(const ir_node *node);
686 void set_Add_right(ir_node *node, ir_node *right);
688 ir_node *get_Carry_left(const ir_node *node);
689 void set_Carry_left(ir_node *node, ir_node *left);
690 ir_node *get_Carry_right(const ir_node *node);
691 void set_Carry_right(ir_node *node, ir_node *right);
693 ir_node *get_Borrow_left(const ir_node *node);
694 void set_Borrow_left(ir_node *node, ir_node *left);
695 ir_node *get_Borrow_right(const ir_node *node);
696 void set_Borrow_right(ir_node *node, ir_node *right);
698 ir_node *get_Sub_left(const ir_node *node);
699 void set_Sub_left(ir_node *node, ir_node *left);
700 ir_node *get_Sub_right(const ir_node *node);
701 void set_Sub_right(ir_node *node, ir_node *right);
703 ir_node *get_Minus_op(const ir_node *node);
704 void set_Minus_op(ir_node *node, ir_node *op);
706 ir_node *get_Mul_left(const ir_node *node);
707 void set_Mul_left(ir_node *node, ir_node *left);
708 ir_node *get_Mul_right(const ir_node *node);
709 void set_Mul_right(ir_node *node, ir_node *right);
711 ir_node *get_Mulh_left(const ir_node *node);
712 void set_Mulh_left(ir_node *node, ir_node *left);
713 ir_node *get_Mulh_right(const ir_node *node);
714 void set_Mulh_right(ir_node *node, ir_node *right);
716 ir_node *get_Quot_left(const ir_node *node);
717 void set_Quot_left(ir_node *node, ir_node *left);
718 ir_node *get_Quot_right(const ir_node *node);
719 void set_Quot_right(ir_node *node, ir_node *right);
720 ir_node *get_Quot_mem(const ir_node *node);
721 void set_Quot_mem(ir_node *node, ir_node *mem);
722 ir_mode *get_Quot_resmode(const ir_node *node);
723 void set_Quot_resmode(ir_node *node, ir_mode *mode);
726 * Projection numbers for Quot: use for Proj nodes!
729 pn_Quot_M = pn_Generic_M, /**< Memory result. */
730 pn_Quot_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
731 pn_Quot_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
732 pn_Quot_res = pn_Generic_other, /**< Result of computation. */
733 pn_Quot_max /**< number of projections from a Quot */
734 } pn_Quot; /* Projection numbers for Quot. */
736 ir_node *get_DivMod_left(const ir_node *node);
737 void set_DivMod_left(ir_node *node, ir_node *left);
738 ir_node *get_DivMod_right(const ir_node *node);
739 void set_DivMod_right(ir_node *node, ir_node *right);
740 ir_node *get_DivMod_mem(const ir_node *node);
741 void set_DivMod_mem(ir_node *node, ir_node *mem);
742 ir_mode *get_DivMod_resmode(const ir_node *node);
743 void set_DivMod_resmode(ir_node *node, ir_mode *mode);
746 * Projection numbers for DivMod: use for Proj nodes!
749 pn_DivMod_M = pn_Generic_M, /**< Memory result. */
750 pn_DivMod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
751 pn_DivMod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
752 pn_DivMod_res_div = pn_Generic_other, /**< Result of computation a / b. */
753 pn_DivMod_res_mod, /**< Result of computation a % b. */
754 pn_DivMod_max /**< number of projections from a DivMod */
755 } pn_DivMod; /* Projection numbers for DivMod. */
757 ir_node *get_Div_left(const ir_node *node);
758 void set_Div_left(ir_node *node, ir_node *left);
759 ir_node *get_Div_right(const ir_node *node);
760 void set_Div_right(ir_node *node, ir_node *right);
761 ir_node *get_Div_mem(const ir_node *node);
762 void set_Div_mem(ir_node *node, ir_node *mem);
763 ir_mode *get_Div_resmode(const ir_node *node);
764 void set_Div_resmode(ir_node *node, ir_mode *mode);
765 int get_Div_no_remainder(const ir_node *node);
766 void set_Div_no_remainder(ir_node *node, int no_remainder);
769 * Projection numbers for Div: use for Proj nodes!
772 pn_Div_M = pn_Generic_M, /**< Memory result. */
773 pn_Div_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
774 pn_Div_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
775 pn_Div_res = pn_Generic_other, /**< Result of computation. */
776 pn_Div_max /**< number of projections from a Div */
777 } pn_Div; /* Projection numbers for Div. */
779 ir_node *get_Mod_left(const ir_node *node);
780 void set_Mod_left(ir_node *node, ir_node *left);
781 ir_node *get_Mod_right(const ir_node *node);
782 void set_Mod_right(ir_node *node, ir_node *right);
783 ir_node *get_Mod_mem(const ir_node *node);
784 void set_Mod_mem(ir_node *node, ir_node *mem);
785 ir_mode *get_Mod_resmode(const ir_node *node);
786 void set_Mod_resmode(ir_node *node, ir_mode *mode);
789 * Projection numbers for Mod: use for Proj nodes!
792 pn_Mod_M = pn_Generic_M, /**< Memory result. */
793 pn_Mod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
794 pn_Mod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
795 pn_Mod_res = pn_Generic_other, /**< Result of computation. */
796 pn_Mod_max /**< number of projections from a Mod */
797 } pn_Mod; /* Projection numbers for Mod. */
799 ir_node *get_Abs_op(const ir_node *node);
800 void set_Abs_op(ir_node *node, ir_node *op);
802 ir_node *get_And_left(const ir_node *node);
803 void set_And_left(ir_node *node, ir_node *left);
804 ir_node *get_And_right(const ir_node *node);
805 void set_And_right(ir_node *node, ir_node *right);
807 ir_node *get_Or_left(const ir_node *node);
808 void set_Or_left(ir_node *node, ir_node *left);
809 ir_node *get_Or_right(const ir_node *node);
810 void set_Or_right(ir_node *node, ir_node *right);
812 ir_node *get_Eor_left(const ir_node *node);
813 void set_Eor_left(ir_node *node, ir_node *left);
814 ir_node *get_Eor_right(const ir_node *node);
815 void set_Eor_right(ir_node *node, ir_node *right);
817 ir_node *get_Not_op(const ir_node *node);
818 void set_Not_op(ir_node *node, ir_node *op);
820 /** returns the pnc name from an pnc constant */
821 const char *get_pnc_string(int pnc);
823 /** Calculates the negated (Complement(R)) pnc condition. */
824 pn_Cmp get_negated_pnc(long pnc, ir_mode *mode);
826 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
827 pn_Cmp get_inversed_pnc(long pnc);
829 /** An alternative name for get_inversed_pnc() that can be better memorized. */
830 #define get_mirrored_pnc(pnc) get_inversed_pnc(pnc)
832 ir_node *get_Cmp_left(const ir_node *node);
833 void set_Cmp_left(ir_node *node, ir_node *left);
834 ir_node *get_Cmp_right(const ir_node *node);
835 void set_Cmp_right(ir_node *node, ir_node *right);
837 ir_node *get_Shl_left(const ir_node *node);
838 void set_Shl_left(ir_node *node, ir_node *left);
839 ir_node *get_Shl_right(const ir_node *node);
840 void set_Shl_right(ir_node *node, ir_node *right);
842 ir_node *get_Shr_left(const ir_node *node);
843 void set_Shr_left(ir_node *node, ir_node *left);
844 ir_node *get_Shr_right(const ir_node *node);
845 void set_Shr_right(ir_node *node, ir_node *right);
847 ir_node *get_Shrs_left(const ir_node *node);
848 void set_Shrs_left(ir_node *node, ir_node *left);
849 ir_node *get_Shrs_right(const ir_node *node);
850 void set_Shrs_right(ir_node *node, ir_node *right);
852 ir_node *get_Rotl_left(const ir_node *node);
853 void set_Rotl_left(ir_node *node, ir_node *left);
854 ir_node *get_Rotl_right(const ir_node *node);
855 void set_Rotl_right(ir_node *node, ir_node *right);
857 ir_node *get_Conv_op(const ir_node *node);
858 void set_Conv_op(ir_node *node, ir_node *op);
859 int get_Conv_strict(const ir_node *node);
860 void set_Conv_strict(ir_node *node, int flag);
862 /* Does Cast need a mem operator?
863 * Cast should only depend on the type, not on the state of an
864 * entity. But: we initialize various fields after Alloc, that
865 * are accessed in the cast. This required some precaution, to
866 * get the right memory into the Loads generated from the cast.
868 ir_node *get_Cast_op(const ir_node *node);
869 void set_Cast_op(ir_node *node, ir_node *op);
870 ir_type *get_Cast_type(ir_node *node);
871 void set_Cast_type(ir_node *node, ir_type *to_tp);
873 /** Checks for upcast.
875 * Returns true if the Cast node casts a class type to a super type.
876 * Works also for pointers to classes (recursively).
878 * Needs typeinfo calculated.
880 int is_Cast_upcast(ir_node *node);
882 /** Checks for downcast.
884 * Returns true if the Cast node casts a class type to a sub type.
885 * Works also for pointers to classes (recursively).
887 * Needs typeinfo calculated.
889 int is_Cast_downcast(ir_node *node);
892 /** Returns true if n is a Phi or a Filter node in INTER-procedural view.
893 Returns false if irg is in phase phase_building and the Phi has zero
894 predecessors: it's a Phi0. */
895 int is_Phi(const ir_node *n);
896 /** Returns true if irg in phase phase_building and the Phi has zero
897 predecessors. It's a Phi0 then. */
898 int is_Phi0(const ir_node *n);
899 /* These routines also work for Filter nodes in INTER-procedural view. */
900 ir_node **get_Phi_preds_arr(ir_node *node);
901 int get_Phi_n_preds(const ir_node *node);
902 ir_node *get_Phi_pred(const ir_node *node, int pos);
903 void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
904 ir_node *get_Phi_next(const ir_node *phi);
905 void set_Phi_next(ir_node *phi, ir_node *next);
907 ir_node *get_Filter_pred(ir_node *node);
908 void set_Filter_pred(ir_node *node, ir_node *pred);
909 long get_Filter_proj(ir_node *node);
910 void set_Filter_proj(ir_node *node, long proj);
911 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
912 * @@@ Maybe better: arity is zero if no cg preds. */
913 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
914 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
915 int get_Filter_n_cg_preds(ir_node *node);
916 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
918 /** Return true if parameter is a memory operation.
920 * A memory operation is an operation that changes the
921 * memory. I.e., a Load or a Store operation.
923 int is_memop(const ir_node *node);
924 ir_node *get_memop_mem(const ir_node *node);
925 void set_memop_mem(ir_node *node, ir_node *mem);
926 ir_node *get_memop_ptr(const ir_node *node);
927 void set_memop_ptr(ir_node *node, ir_node *ptr);
930 * Projection numbers for Load: use for Proj nodes!
933 pn_Load_M = pn_Generic_M, /**< Memory result. */
934 pn_Load_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
935 pn_Load_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
936 pn_Load_res = pn_Generic_other, /**< Result of load operation. */
937 pn_Load_max /**< number of projections from a Load */
938 } pn_Load; /* Projection numbers for Load. */
940 ir_node *get_Load_mem(const ir_node *node);
941 void set_Load_mem(ir_node *node, ir_node *mem);
942 ir_node *get_Load_ptr(const ir_node *node);
943 void set_Load_ptr(ir_node *node, ir_node *ptr);
944 ir_mode *get_Load_mode(const ir_node *node);
945 void set_Load_mode(ir_node *node, ir_mode *mode);
946 ir_volatility get_Load_volatility(const ir_node *node);
947 void set_Load_volatility(ir_node *node, ir_volatility volatility);
948 ir_align get_Load_align(const ir_node *node);
949 void set_Load_align(ir_node *node, ir_align align);
952 * Projection numbers for Store: use for Proj nodes!
955 pn_Store_M = pn_Generic_M, /**< Memory result. */
956 pn_Store_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
957 pn_Store_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
958 pn_Store_max = pn_Generic_other /**< number of projections from a Store */
959 } pn_Store; /* Projection numbers for Store. */
961 ir_node *get_Store_mem(const ir_node *node);
962 void set_Store_mem(ir_node *node, ir_node *mem);
963 ir_node *get_Store_ptr(const ir_node *node);
964 void set_Store_ptr(ir_node *node, ir_node *ptr);
965 ir_node *get_Store_value(const ir_node *node);
966 void set_Store_value(ir_node *node, ir_node *value);
967 ir_volatility get_Store_volatility(const ir_node *node);
968 void set_Store_volatility(ir_node *node, ir_volatility volatility);
969 ir_align get_Store_align(const ir_node *node);
970 void set_Store_align(ir_node *node, ir_align align);
973 * Projection numbers for Alloc: use for Proj nodes!
976 pn_Alloc_M = pn_Generic_M, /**< Memory result. */
977 pn_Alloc_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
978 pn_Alloc_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
979 pn_Alloc_res = pn_Generic_other, /**< Result of allocation. */
980 pn_Alloc_max /**< number of projections from an Alloc */
981 } pn_Alloc; /* Projection numbers for Alloc. */
983 ir_node *get_Alloc_mem(const ir_node *node);
984 void set_Alloc_mem(ir_node *node, ir_node *mem);
985 ir_node *get_Alloc_size(const ir_node *node);
986 void set_Alloc_size(ir_node *node, ir_node *size);
987 ir_type *get_Alloc_type(ir_node *node);
988 void set_Alloc_type(ir_node *node, ir_type *tp);
990 ir_where_alloc get_Alloc_where(const ir_node *node);
991 void set_Alloc_where(ir_node *node, ir_where_alloc where);
993 ir_node *get_Free_mem(const ir_node *node);
994 void set_Free_mem(ir_node *node, ir_node *mem);
995 ir_node *get_Free_ptr(const ir_node *node);
996 void set_Free_ptr(ir_node *node, ir_node *ptr);
997 ir_node *get_Free_size(const ir_node *node);
998 void set_Free_size(ir_node *node, ir_node *size);
999 ir_type *get_Free_type(ir_node *node);
1000 void set_Free_type(ir_node *node, ir_type *tp);
1002 ir_where_alloc get_Free_where(const ir_node *node);
1003 void set_Free_where(ir_node *node, ir_where_alloc where);
1005 ir_node **get_Sync_preds_arr(ir_node *node);
1006 int get_Sync_n_preds(const ir_node *node);
1007 ir_node *get_Sync_pred(const ir_node *node, int pos);
1008 void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
1009 void add_Sync_pred(ir_node *node, ir_node *pred);
1011 /** Returns the source language type of a Proj node.
1012 * Must be an atomic type. Mode of type must be mode of node.
1014 ir_type *get_Proj_type(ir_node *node);
1016 /** Return the predecessor of a Proj node. */
1017 ir_node *get_Proj_pred(const ir_node *node);
1018 void set_Proj_pred(ir_node *node, ir_node *pred);
1019 /** Return the projection number of a Proj node. */
1020 long get_Proj_proj(const ir_node *node);
1021 void set_Proj_proj(ir_node *node, long proj);
1024 * Returns non-zero if a node is a routine parameter.
1026 * @param node the Proj node to test
1028 int is_arg_Proj(const ir_node *node);
1030 ir_node **get_Tuple_preds_arr(ir_node *node);
1031 int get_Tuple_n_preds(const ir_node *node);
1032 ir_node *get_Tuple_pred(const ir_node *node, int pos);
1033 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
1035 ir_node *get_Id_pred(const ir_node *node);
1036 void set_Id_pred(ir_node *node, ir_node *pred);
1038 /** Confirm has a single result and returns 'value' unchanged.
1039 * The node expresses a restriction on 'value':
1040 * 'value' 'cmp' 'bound' == true. */
1041 ir_node *get_Confirm_value(const ir_node *node);
1042 void set_Confirm_value(ir_node *node, ir_node *value);
1043 ir_node *get_Confirm_bound(const ir_node *node);
1044 void set_Confirm_bound(ir_node *node, ir_node *bound);
1045 pn_Cmp get_Confirm_cmp(const ir_node *node);
1046 void set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
1051 ir_node *get_Mux_sel(const ir_node *node);
1052 void set_Mux_sel(ir_node *node, ir_node *sel);
1053 ir_node *get_Mux_false(const ir_node *node);
1054 void set_Mux_false(ir_node *node, ir_node *ir_false);
1055 ir_node *get_Mux_true(const ir_node *node);
1056 void set_Mux_true(ir_node *node, ir_node *ir_true);
1059 * Projection numbers for result of CopyB node: use for Proj nodes!
1062 pn_CopyB_M_regular = pn_Generic_M, /**< The memory result. */
1063 pn_CopyB_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1064 pn_CopyB_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1065 pn_CopyB_max = pn_Generic_other /**< number of projections from a CopyB */
1066 } pn_CopyB; /* Projection numbers for CopyB. */
1067 #define pn_CopyB_M pn_CopyB_M_regular
1069 ir_node *get_CopyB_mem(const ir_node *node);
1070 void set_CopyB_mem(ir_node *node, ir_node *mem);
1071 ir_node *get_CopyB_dst(const ir_node *node);
1072 void set_CopyB_dst(ir_node *node, ir_node *dst);
1073 ir_node *get_CopyB_src(const ir_node *node);
1074 void set_CopyB_src(ir_node *node, ir_node *src);
1075 ir_type *get_CopyB_type(ir_node *node);
1076 void set_CopyB_type(ir_node *node, ir_type *data_type);
1079 * Projection numbers for result of InstOf node: use for Proj nodes!
1082 pn_InstOf_M_regular = pn_Generic_M, /**< The memory result. */
1083 pn_InstOf_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1084 pn_InstOf_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1085 pn_InstOf_res = pn_Generic_other, /**< The checked object pointer. */
1086 pn_InstOf_max /**< number of projections from an InstOf */
1088 #define pn_InstOf_M pn_InstOf_M_regular
1090 /** InstOf access. */
1091 ir_type *get_InstOf_type(ir_node *node);
1092 void set_InstOf_type(ir_node *node, ir_type *type);
1093 ir_node *get_InstOf_store(const ir_node *node);
1094 void set_InstOf_store(ir_node *node, ir_node *obj);
1095 ir_node *get_InstOf_obj(const ir_node *node);
1096 void set_InstOf_obj(ir_node *node, ir_node *obj);
1099 * Projection numbers for Raise.
1102 pn_Raise_M = pn_Generic_M, /**< The Memory result. */
1103 pn_Raise_X = pn_Generic_X_regular, /**< The control flow to the exception handler. */
1104 pn_Raise_max /**< number of projections from a Raise */
1105 } pn_Raise; /* Projection numbers for Raise. */
1107 ir_node *get_Raise_mem(const ir_node *node);
1108 void set_Raise_mem(ir_node *node, ir_node *mem);
1109 ir_node *get_Raise_exo_ptr(const ir_node *node); /* PoinTeR to EXception Object */
1110 void set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
1113 * Projection numbers for result of Bound node: use for Proj nodes!
1116 pn_Bound_M = pn_Generic_M, /**< The memory result. */
1117 pn_Bound_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1118 pn_Bound_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1119 pn_Bound_res = pn_Generic_other, /**< The checked index. */
1120 pn_Bound_max /**< number of projections from a Bound */
1123 /** Returns the memory input of a Bound operation. */
1124 ir_node *get_Bound_mem(const ir_node *bound);
1125 void set_Bound_mem(ir_node *bound, ir_node *mem);
1127 /** Returns the index input of a Bound operation. */
1128 ir_node *get_Bound_index(const ir_node *bound);
1129 void set_Bound_index(ir_node *bound, ir_node *idx);
1131 /** Returns the lower bound input of a Bound operation. */
1132 ir_node *get_Bound_lower(const ir_node *bound);
1133 void set_Bound_lower(ir_node *bound, ir_node *lower);
1135 /** Returns the upper bound input of a Bound operation. */
1136 ir_node *get_Bound_upper(const ir_node *bound);
1137 void set_Bound_upper(ir_node *bound, ir_node *upper);
1139 /** Return the operand of a Pin node. */
1140 ir_node *get_Pin_op(const ir_node *pin);
1141 void set_Pin_op(ir_node *pin, ir_node *node);
1143 /** Return the assembler text of an ASM pseudo node. */
1144 ident *get_ASM_text(const ir_node *node);
1145 /** Return the number of input constraints for an ASM node. */
1146 int get_ASM_n_input_constraints(const ir_node *node);
1147 /** Return the input constraints for an ASM node. */
1148 const ir_asm_constraint *get_ASM_input_constraints(const ir_node *node);
1149 /** Return the number of output constraints for an ASM node. */
1150 int get_ASM_n_output_constraints(const ir_node *node);
1151 /** Return the output constraints for an ASM node. */
1152 const ir_asm_constraint *get_ASM_output_constraints(const ir_node *node);
1153 /** Return the number of clobbered registers for an ASM node. */
1154 int get_ASM_n_clobbers(const ir_node *node);
1155 /** Return the list of clobbered registers for an ASM node. */
1156 ident **get_ASM_clobbers(const ir_node *node);
1160 * NAME Auxiliary routines
1164 /** Returns operand of node if node is a Proj. */
1165 ir_node *skip_Proj(ir_node *node);
1166 /** Returns operand of node if node is a Proj. */
1167 const ir_node *skip_Proj_const(const ir_node *node);
1168 /** Returns operand of node if node is a Id. */
1169 ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
1170 /** Returns corresponding operand of Tuple if node is a Proj from
1172 ir_node *skip_Tuple(ir_node *node);
1173 /** Returns operand of node if node is a Cast. */
1174 ir_node *skip_Cast(ir_node *node);
1175 const ir_node *skip_Cast_const(const ir_node *node);
1176 /** Returns operand of node if node is a Pin. */
1177 ir_node *skip_Pin(ir_node *node);
1178 /** Returns operand of node if node is a Confirm */
1179 ir_node *skip_Confirm(ir_node *node);
1180 /** Skip all high-level Operations (including Cast, Confirm). */
1181 ir_node *skip_HighLevel_ops(ir_node *node);
1182 /** Returns true if irn is a Const node. */
1183 int is_Const(const ir_node *node);
1184 /** Returns true if a node is a Conv node. */
1185 int is_Conv(const ir_node *node);
1186 /** Returns true if a node is a strictConv node. */
1187 int is_strictConv(const ir_node *node);
1188 /** Returns true if a node is a Cast node. */
1189 int is_Cast(const ir_node *node);
1190 /** Returns true if node is a Bad node. */
1191 int is_Bad(const ir_node *node);
1192 /** Returns true if node is a NoMem node. */
1193 int is_NoMem(const ir_node *node);
1194 /** Returns true if node is a Start node. */
1195 int is_Start(const ir_node *node);
1196 /** Returns true if node is a Minus node. */
1197 int is_Minus(const ir_node *node);
1198 /** Returns true if node is a Abs node. */
1199 int is_Abs(const ir_node *node);
1200 /** Returns true if node is a Mod node. */
1201 int is_Mod(const ir_node *node);
1202 /** Returns true if node is a Div node. */
1203 int is_Div(const ir_node *node);
1204 /** Returns true if node is a DivMod node. */
1205 int is_DivMod(const ir_node *node);
1206 /** Returns true if node is a Quot node. */
1207 int is_Quot(const ir_node *node);
1208 /** Returns true if node is an Add node. */
1209 int is_Add(const ir_node *node);
1210 /** Returns true if node is a Carry node. */
1211 int is_Carry(const ir_node *node);
1212 /** Returns true if node is an And node. */
1213 int is_And(const ir_node *node);
1214 /** Returns true if node is an Or node. */
1215 int is_Or(const ir_node *node);
1216 /** Returns true if node is an Eor node. */
1217 int is_Eor(const ir_node *node);
1218 /** Returns true if node is a Sub node. */
1219 int is_Sub(const ir_node *node);
1220 /** Returns true if node is a Not node. */
1221 int is_Not(const ir_node *node);
1222 /** Returns true if node is a Shl node. */
1223 int is_Shl(const ir_node *node);
1224 /** Returns true if node is a Shr node. */
1225 int is_Shr(const ir_node *node);
1226 /** Returns true if node is a Shrs node. */
1227 int is_Shrs(const ir_node *node);
1228 /** Returns true if node is a Rotl node. */
1229 int is_Rotl(const ir_node *node);
1230 /** Returns true if node is an Id node. */
1231 int is_Id(const ir_node *node);
1232 /** Returns true if node is a Tuple node. */
1233 int is_Tuple(const ir_node *node);
1234 /** Returns true if node is a Bound node. */
1235 int is_Bound(const ir_node *node);
1236 /** Returns true if the node is not a Block */
1237 int is_no_Block(const ir_node *node);
1238 /** Returns true if the node is a Block */
1239 int is_Block(const ir_node *node);
1240 /** Returns true if node is an Unknown node. */
1241 int is_Unknown(const ir_node *node);
1242 /** Returns true if node is a Return node. */
1243 int is_Return(const ir_node *node);
1244 /** Returns true if node is a Call node. */
1245 int is_Call(const ir_node *node);
1246 /** Returns true if node is a Builtin node. */
1247 int is_Builtin(const ir_node *node);
1248 /** Returns true if node is a CallBegin node. */
1249 int is_CallBegin(const ir_node *node);
1250 /** Returns true if node is a Sel node. */
1251 int is_Sel(const ir_node *node);
1252 /** Returns true if node is a Mul node. */
1253 int is_Mul(const ir_node *node);
1254 /** Returns true if node is a Mulh node. */
1255 int is_Mulh(const ir_node *node);
1256 /** Returns true if node is a Mux node. */
1257 int is_Mux(const ir_node *node);
1258 /** Returns true if node is a Load node. */
1259 int is_Load(const ir_node *node);
1260 /** Returns true if node is a Store node. */
1261 int is_Store(const ir_node *node);
1262 /** Returns true if node is a Sync node. */
1263 int is_Sync(const ir_node *node);
1264 /** Returns true if node is a Confirm node. */
1265 int is_Confirm(const ir_node *node);
1266 /** Returns true if node is a Pin node. */
1267 int is_Pin(const ir_node *node);
1268 /** Returns true if node is a SymConst node. */
1269 int is_SymConst(const ir_node *node);
1270 /** Returns true if node is a SymConst node with kind symconst_addr_ent. */
1271 int is_SymConst_addr_ent(const ir_node *node);
1272 /** Returns true if node is a Cond node. */
1273 int is_Cond(const ir_node *node);
1274 /** Returns true of node is a CopyB node. */
1275 int is_CopyB(const ir_node *node);
1276 /** Returns true if node is a Cmp node. */
1277 int is_Cmp(const ir_node *node);
1278 /** Returns true if node is an Alloc node. */
1279 int is_Alloc(const ir_node *node);
1280 /** Returns true if node is a Free node. */
1281 int is_Free(const ir_node *node);
1282 /** Returns true if a node is a Jmp node. */
1283 int is_Jmp(const ir_node *node);
1284 /** Returns true if a node is a IJmp node. */
1285 int is_IJmp(const ir_node *node);
1286 /** Returns true if a node is a Raise node. */
1287 int is_Raise(const ir_node *node);
1288 /** Returns true if a node is an ASM node. */
1289 int is_ASM(const ir_node *node);
1290 /** Returns true if a node is an Dummy node. */
1291 int is_Dummy(const ir_node *node);
1292 /** Returns true if node is a Proj node or a Filter node in INTRA-procedural view. */
1293 int is_Proj(const ir_node *node);
1294 /** Returns true if node is a Filter node. */
1295 int is_Filter(const ir_node *node);
1297 /** Returns true if the operation manipulates control flow:
1298 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1299 int is_cfop(const ir_node *node);
1301 /** Returns true if the operation manipulates interprocedural control flow:
1302 CallBegin, EndReg, EndExcept */
1303 int is_ip_cfop(const ir_node *node);
1304 /** Returns true if the operation can change the control flow because
1305 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1306 Bad. Raise is not fragile, but a unconditional jump. */
1307 int is_fragile_op(const ir_node *node);
1308 /** Returns the memory operand of fragile operations. */
1309 ir_node *get_fragile_op_mem(ir_node *node);
1310 /** Returns the result mode of a Div operation. */
1311 ir_mode *get_divop_resmod(const ir_node *node);
1313 /** Returns true if the operation is a forking control flow
1314 * operation: Cond. */
1315 int is_irn_forking(const ir_node *node);
1318 * Copies all attributes stored in the old node to the new node.
1319 * Assumes both have the same opcode and sufficient size.
1321 void copy_node_attr(const ir_node *old_node, ir_node *new_node);
1323 /** Return the type associated with the value produced by n
1324 * if the node remarks this type as it is the case for
1325 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1326 ir_type *get_irn_type(ir_node *n);
1328 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1330 ir_type *get_irn_type_attr(ir_node *n);
1332 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1333 ir_entity *get_irn_entity_attr(ir_node *n);
1335 /** Returns non-zero for constant-like nodes. */
1336 int is_irn_constlike(const ir_node *node);
1339 * Returns non-zero for nodes that must be always optimized
1340 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1342 int is_irn_always_opt(const ir_node *node);
1345 * Returns non-zero for nodes that are allowed to have keep-alives and
1346 * are neither Block nor PhiM.
1348 int is_irn_keep(const ir_node *node);
1351 * Returns non-zero for nodes that are always placed in the start block.
1353 int is_irn_start_block_placed(const ir_node *node);
1356 * Returns non-zero for nodes that are machine operations.
1358 int is_irn_machine_op(const ir_node *node);
1361 * Returns non-zero for nodes that are machine operands.
1363 int is_irn_machine_operand(const ir_node *node);
1366 * Returns non-zero for nodes that have the n'th user machine flag set.
1368 int is_irn_machine_user(const ir_node *node, unsigned n);
1371 * Returns non-zero for nodes that are CSE neutral to its users.
1373 int is_irn_cse_neutral(const ir_node *node);
1376 * A type to express conditional jump predictions.
1379 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1380 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1381 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1382 } cond_jmp_predicate;
1384 /** Gets the string representation of the jump prediction. */
1385 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1387 /** Returns the conditional jump prediction of a Cond node. */
1388 cond_jmp_predicate get_Cond_jmp_pred(const ir_node *cond);
1390 /** Sets a new conditional jump prediction. */
1391 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1393 /** Checks whether a node represents a global address. */
1394 int is_Global(const ir_node *node);
1396 /* Returns the entity of a global address. */
1397 ir_entity *get_Global_entity(const ir_node *node);
1400 * Access custom node data.
1401 * The data must have been registered with
1402 * register_additional_node_data() before.
1403 * @param node The ir node to get the data from.
1404 * @param type The type of the data you registered.
1405 * @param off The value returned by register_additional_node_data().
1406 * @return A pointer of type @p type.
1408 #define get_irn_data(node,type,off) \
1409 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1412 * Get the pointer to the node some custom data belongs to.
1413 * @param data The pointer to the custom data.
1414 * @param off The number as returned by register_additional_node_data().
1415 * @return A pointer to the ir node the custom data belongs to.
1417 #define get_irn_data_base(data,off) \
1418 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1421 * Request additional data to be allocated with an ir node.
1422 * @param size The size of the additional data required.
1423 * @return A positive number, if the operation was successful, which
1424 * must be passed to the access macro get_irn_data(), 0 if the
1425 * registration failed.
1427 unsigned firm_register_additional_node_data(unsigned size);
1430 * Return a pointer to the node attributes.
1431 * Needed for user-defined nodes.
1433 void *get_irn_generic_attr(ir_node *node);
1434 const void *get_irn_generic_attr_const(const ir_node *node);
1437 * Returns the unique node index for the node in its graph.
1438 * This index is used to access phase information for this node.
1440 unsigned get_irn_idx(const ir_node *node);
1443 * Sets the debug information of a node.
1445 * @param n The node.
1446 * @param db The debug info.
1448 void set_irn_dbg_info(ir_node *n, dbg_info *db);
1451 * Returns the debug information of an node.
1453 * @param n The node.
1455 dbg_info *get_irn_dbg_info(const ir_node *n);
1458 * Calculate a hash value of a node. Only inputs, mode and opcode are used.
1460 * @param node the node to hash
1462 unsigned firm_default_hash(const ir_node *node);
1465 * returns a descriptive name of a node (containing type+number)
1467 const char *gdb_node_helper(void *firm_object);
1469 /*@}*/ /* end of ir_node group definition */