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_P_value_arg_base, /**< Pointer to region of compound value arguments as defined by
323 type of this method. */
324 pn_Start_max /**< number of projections from a Start */
325 } pn_Start; /* Projection numbers for Start. */
327 /** Test whether arbitrary node is frame pointer.
329 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
330 * from Start. If so returns frame type, else Null. */
331 ir_type *is_frame_pointer(const ir_node *n);
333 /** Test whether arbitrary node is the thread local storage (tls) pointer.
335 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
336 * from Start. If so returns tls type, else Null. */
337 ir_type *is_tls_pointer(const ir_node *n);
339 /** Test whether arbitrary node is value arg base.
341 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
342 * from Start. If so returns 1, else 0. */
343 int is_value_arg_pointer(const ir_node *n);
345 /* @@@ no more supported */
346 ir_node **get_Block_cfgpred_arr(ir_node *node);
347 int get_Block_n_cfgpreds(const ir_node *node);
348 ir_node *get_Block_cfgpred(const ir_node *node, int pos);
349 void set_Block_cfgpred(ir_node *node, int pos, 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, but the Bad node.
361 ir_node *get_Block_cfgpred_block(const ir_node *node, int pos);
362 int get_Block_matured(const ir_node *node);
363 void set_Block_matured(ir_node *node, int matured);
365 /** A visited flag only for block nodes.
366 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
367 ir_visited_t get_Block_block_visited(const ir_node *node);
368 void set_Block_block_visited(ir_node *node, ir_visited_t visit);
371 * Marks a block as dead but do not replace it with a Bad node.
372 * Dead blocks are removed in the con
374 ir_node *set_Block_dead(ir_node *block);
375 int is_Block_dead(const ir_node *block);
377 /* For this current_ir_graph must be set. */
378 void mark_Block_block_visited(ir_node *node);
379 int Block_block_visited(const ir_node *node);
381 #ifdef INTERPROCEDURAL_VIEW
382 /* Set and remove interprocedural predecessors. If the interprocedural
383 * predecessors are removed, the node has the same predecessors in
385 * @@@ Maybe better: arity is zero if no cg preds. */
386 void set_Block_cg_cfgpred_arr(ir_node *node, int arity, ir_node *in[]);
387 void set_Block_cg_cfgpred(ir_node *node, int pos, ir_node *pred);
388 /* @@@ not supported */
389 ir_node **get_Block_cg_cfgpred_arr(ir_node *node);
390 /** Returns the number of interprocedural predecessors. 0 if none. */
391 int get_Block_cg_n_cfgpreds(const ir_node *node);
392 /** Return the interprocedural predecessor at position pos. */
393 ir_node *get_Block_cg_cfgpred(const ir_node *node, int pos);
394 /** Frees the memory allocated for interprocedural predecessors. */
395 void remove_Block_cg_cfgpred_arr(ir_node *node);
398 /** Returns the extended basic block a block belongs to. */
399 ir_extblk *get_Block_extbb(const ir_node *block);
400 /** Sets the extended basic block a block belongs to. */
401 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
402 /** Get the Macro Block header of a (sub-) block. */
403 ir_node *get_Block_MacroBlock(const ir_node *block);
404 /** Set the Macro Block header of a (sub-) block. */
405 void set_Block_MacroBlock(ir_node *block, ir_node *mbh);
406 /** Get the Macro Block header of a node. */
407 ir_node *get_irn_MacroBlock(const ir_node *n);
408 /** Returns the ir_graph this Block belongs to. */
409 ir_graph *get_Block_irg(const ir_node *block);
410 /** Returns non-zero if the block has an assigned label. */
411 int has_Block_label(const ir_node *block);
412 /** Returns the label of a Block. */
413 ir_label_t get_Block_label(const ir_node *block);
414 /** Sets a label to a block. */
415 void set_Block_label(ir_node *block, ir_label_t label);
416 /** Gets the head of the Phi list for this block. */
417 ir_node *get_Block_phis(const ir_node *block);
418 /** Sets the head of the Phi list for this block. */
419 void set_Block_phis(ir_node *block, ir_node *phi);
420 /** Add a Phi node to the list of Block Phi's. */
421 void add_Block_phi(ir_node *block, ir_node *phi);
422 /** Get the Block mark (single bit). */
423 unsigned get_Block_mark(const ir_node *block);
424 /** Set the Block mark (single bit). */
425 void set_Block_mark(ir_node *block, unsigned mark);
427 /** Return the number of Keep alive node. */
428 int get_End_n_keepalives(const ir_node *end);
429 /** Return the Keep alive node a position pos. */
430 ir_node *get_End_keepalive(const ir_node *end, int pos);
431 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
432 void add_End_keepalive(ir_node *end, ir_node *ka);
433 /** Set the Keep alive node at position pos. */
434 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
437 * Set new keep-alives.
438 * Beware: This might be an expensive operation if dynamic edges are enabled,
439 * so avoid it in the backend.
441 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
443 /** Remove irn from the keep-alive set. */
444 void remove_End_keepalive(ir_node *end, ir_node *irn);
446 /* Remove Bads, NoMem and doublets from the keep-alive set. */
447 void remove_End_Bads_and_doublets(ir_node *end);
449 /** Some parts of the End node are allocated separately -- their memory
450 is not recovered by dead_node_elimination if a End node is dead.
451 free_End() frees these data structures. */
452 void free_End(ir_node *end);
454 /** Return the target address of an IJmp */
455 ir_node *get_IJmp_target(const ir_node *ijmp);
456 /** Sets the target address of an IJmp */
457 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
459 /* We distinguish three kinds of Cond nodes. These can be distinguished
460 by the mode of the selector operand and an internal flag of type cond_kind.
461 First we distinguish binary Conds and switch Conds.
462 A binary Cond has as selector a boolean value. Proj(0) projects the control
463 flow for case "False", Proj(1) the control flow for "True". A binary Cond
464 is recognized by the boolean selector.
465 The switch Cond has as selector an unsigned integer. It produces as result
466 an n+1 Tuple (cf0, ... , cfn) of control flows.
467 We differ two flavors of this Cond. The first, the dense Cond, passes
468 control along output i if the selector value is i, 0 <= i <= n. If the
469 selector value is >n it passes control along output n.
470 The second Cond flavor differences in the treatment of cases not specified in
471 the source program. It magically knows about the existence of Proj nodes.
472 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
473 exists. Else it passes control along output n (even if this Proj does not
474 exist.) This Cond we call "fragmentary". There is a special constructor
475 new_defaultProj that automatically sets the flavor.
476 The two switch flavors are distinguished by a flag of type cond_kind.
477 Default flavor is "dense"
480 dense, /**< Default. Missing Proj nodes are dead control flow. */
481 fragmentary /**< Special. No control flow optimizations allowed. Missing
482 Proj nodes mean default control flow, i.e., Proj(n). */
485 ir_node *get_Cond_selector(const ir_node *node);
486 void set_Cond_selector(ir_node *node, ir_node *selector);
487 cond_kind get_Cond_kind(const ir_node *node);
488 void set_Cond_kind(ir_node *node, cond_kind kind);
489 long get_Cond_defaultProj(const ir_node *node);
492 * Projection numbers for conditions.
495 pn_Cond_false, /**< Control flow if operand is "false". */
496 pn_Cond_true, /**< Control flow if operand is "true". */
497 pn_Cond_max /**< number of projections from a Cond */
498 } pn_Cond; /* Projection numbers for Cond. */
500 ir_node *get_Return_mem(const ir_node *node);
501 void set_Return_mem(ir_node *node, ir_node *mem);
502 ir_node **get_Return_res_arr(ir_node *node);
503 int get_Return_n_ress(const ir_node *node);
504 ir_node *get_Return_res(const ir_node *node, int pos);
505 void set_Return_res(ir_node *node, int pos, ir_node *res);
507 tarval *get_Const_tarval(const ir_node *node);
508 void set_Const_tarval(ir_node *node, tarval *con);
510 /** Return non-zero if the given Const node represents the 0 constant. */
511 int is_Const_null(const ir_node *node);
513 /** Return non-zero if the given Const node represents the 1 constant. */
514 int is_Const_one(const ir_node *node);
516 /** Return non-zero if the given Const node represents the constant with all bits set. */
517 int is_Const_all_one(const ir_node *node);
519 /** Returns the source language type of a Const node.
520 * Must be an atomic type. Mode of type must be mode of node.
522 ir_type *get_Const_type(ir_node *node);
524 /** Sets the source language type of a Const node. */
525 void set_Const_type(ir_node *node, ir_type *tp);
527 /** Returns non-zero if s symconst kind has a type attribute */
528 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
530 /** Returns non-zero if s symconst kind has an ident attribute */
531 #define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)
533 /** Returns non-zero if s symconst kind has an entity attribute */
534 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
536 /** Returns non-zero if s symconst kind has an enum_const attribute */
537 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
539 /** Returns non-zero if s symconst kind has a label attribute */
540 #define SYMCONST_HAS_LABEL(kind) ((kind) == symconst_label)
542 /** Get the kind of the SymConst. */
543 symconst_kind get_SymConst_kind(const ir_node *node);
544 /** Set the kind of the SymConst. */
545 void set_SymConst_kind(ir_node *node, symconst_kind num);
547 /** Only to access SymConst of kind type_tag or size. Else assertion: */
548 ir_type *get_SymConst_type(const ir_node *node);
549 void set_SymConst_type(ir_node *node, ir_type *tp);
551 /** Only to access SymConst of kind addr_name. Else assertion: */
552 ident *get_SymConst_name(const ir_node *node);
553 void set_SymConst_name(ir_node *node, ident *name);
555 /** Only to access SymConst of kind addr_ent. Else assertion: */
556 ir_entity *get_SymConst_entity(const ir_node *node);
557 void set_SymConst_entity(ir_node *node, ir_entity *ent);
559 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
560 ir_enum_const *get_SymConst_enum(const ir_node *node);
561 void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
563 /** Sets both: type and ptrinfo. Needed to treat the node independent of
564 its semantics. Does a memcpy for the memory sym points to. */
565 /* write 'union': firmjni then does not create a method... */
566 union symconst_symbol get_SymConst_symbol(const ir_node *node);
567 void set_SymConst_symbol(ir_node *node,
568 union symconst_symbol sym);
570 /** Only to access SymConst of kind symconst_label. Else assertion: */
571 ir_label_t get_SymConst_label(const ir_node *node);
572 void set_SymConst_label(ir_node *node, ir_label_t label);
575 /** Access the type of the value represented by the SymConst.
577 * Example: primitive type int for SymConst size. */
578 ir_type *get_SymConst_value_type(ir_node *node);
579 void set_SymConst_value_type(ir_node *node, ir_type *tp);
581 ir_node *get_Sel_mem(const ir_node *node);
582 void set_Sel_mem(ir_node *node, ir_node *mem);
583 ir_node *get_Sel_ptr(const ir_node *node); /* ptr to the object to select from */
584 void set_Sel_ptr(ir_node *node, ir_node *ptr);
585 ir_node **get_Sel_index_arr(ir_node *node);
586 int get_Sel_n_indexs(const ir_node *node);
587 ir_node *get_Sel_index(const ir_node *node, int pos);
588 void set_Sel_index(ir_node *node, int pos, ir_node *index);
589 ir_entity *get_Sel_entity(const ir_node *node); /* entity to select */
590 void set_Sel_entity (ir_node *node, ir_entity *ent);
593 * Projection numbers for result of Call node: use for Proj nodes!
596 pn_Call_M_regular = pn_Generic_M_regular, /**< The memory result. */
597 pn_Call_X_regular = pn_Generic_X_regular, /**< The control flow result when no exception occurs. */
598 pn_Call_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler. */
599 pn_Call_T_result = pn_Generic_other, /**< The tuple containing all (0, 1, 2, ...) results. */
600 pn_Call_M_except, /**< The memory result in case the called method terminated with
602 pn_Call_P_value_res_base, /**< A pointer to the memory region containing copied results
603 passed by value (for compound result types). */
604 pn_Call_max /**< number of projections from a Call */
605 } pn_Call; /* Projection numbers for Call. */
606 #define pn_Call_M pn_Call_M_regular
608 ir_node *get_Call_mem(const ir_node *node);
609 void set_Call_mem(ir_node *node, ir_node *mem);
610 ir_node *get_Call_ptr(const ir_node *node);
611 void set_Call_ptr(ir_node *node, ir_node *ptr);
612 ir_node **get_Call_param_arr(ir_node *node);
613 /** Gets the number of parameters of a call. */
614 int get_Call_n_params(const ir_node *node);
615 /** Gets the call parameter at position pos. */
616 ir_node *get_Call_param(const ir_node *node, int pos);
617 /** Sets the call parameter at position pos. */
618 void set_Call_param(ir_node *node, int pos, ir_node *param);
619 /** Gets the type of a call. */
620 ir_type *get_Call_type(ir_node *node);
621 /** Sets the type of a call. */
622 void set_Call_type(ir_node *node, ir_type *tp);
623 /** Gets the arity of a call. Identical to get_Call_n_params(). */
624 int get_Call_arity(const ir_node *node);
627 * Returns non-zero if a Call is surely a self-recursive Call.
628 * Beware: if this functions returns 0, the call might be self-recursive!
630 int is_self_recursive_Call(const ir_node *call);
632 /** Set, get and remove the callee information for a Call node.
634 * The callee information lists all method entities that can be called
635 * from this node. If the address expression can not be analyzed fully,
636 * e.g., as entities can be called that are not in the compilation unit,
637 * the array contains the unknown_entity. The array contains only entities
638 * with peculiarity_existent, but with all kinds of visibility. The entities
639 * not necessarily contain an irg.
641 * The array is only accessible if callee information is valid. See flag
644 * The memory allocated for the array is managed automatically, i.e., it must
645 * not be freed if the Call node is removed from the graph.
647 * @param node A Call node.
649 int Call_has_callees(const ir_node *node);
650 int get_Call_n_callees(const ir_node *node);
651 ir_entity *get_Call_callee(const ir_node *node, int pos);
653 /** Set the full callee array.
655 * The passed array is copied. Assumes current_ir_graph set properly! */
656 void set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
657 void remove_Call_callee_arr(ir_node *node);
659 ir_node *get_CallBegin_ptr(const ir_node *node);
660 void set_CallBegin_ptr(ir_node *node, ir_node *ptr);
661 ir_node *get_CallBegin_call(const ir_node *node);
662 void set_CallBegin_call(ir_node *node, ir_node *call);
664 /* For unary and binary arithmetic operations the access to the
665 operands can be factored out. Left is the first, right the
666 second arithmetic value as listed in tech report 1999-44.
667 unops are: Minus, Abs, Not, Conv, Cast
668 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
669 Shr, Shrs, Rotl, Cmp */
670 int is_unop(const ir_node *node);
671 ir_node *get_unop_op(const ir_node *node);
672 void set_unop_op(ir_node *node, ir_node *op);
673 int is_binop(const ir_node *node);
674 ir_node *get_binop_left(const ir_node *node);
675 void set_binop_left(ir_node *node, ir_node *left);
676 ir_node *get_binop_right(const ir_node *node);
677 void set_binop_right(ir_node *node, ir_node *right);
679 ir_node *get_Add_left(const ir_node *node);
680 void set_Add_left(ir_node *node, ir_node *left);
681 ir_node *get_Add_right(const ir_node *node);
682 void set_Add_right(ir_node *node, ir_node *right);
684 ir_node *get_Carry_left(const ir_node *node);
685 void set_Carry_left(ir_node *node, ir_node *left);
686 ir_node *get_Carry_right(const ir_node *node);
687 void set_Carry_right(ir_node *node, ir_node *right);
689 ir_node *get_Sub_left(const ir_node *node);
690 void set_Sub_left(ir_node *node, ir_node *left);
691 ir_node *get_Sub_right(const ir_node *node);
692 void set_Sub_right(ir_node *node, ir_node *right);
694 ir_node *get_Minus_op(const ir_node *node);
695 void set_Minus_op(ir_node *node, ir_node *op);
697 ir_node *get_Mul_left(const ir_node *node);
698 void set_Mul_left(ir_node *node, ir_node *left);
699 ir_node *get_Mul_right(const ir_node *node);
700 void set_Mul_right(ir_node *node, ir_node *right);
702 ir_node *get_Mulh_left(const ir_node *node);
703 void set_Mulh_left(ir_node *node, ir_node *left);
704 ir_node *get_Mulh_right(const ir_node *node);
705 void set_Mulh_right(ir_node *node, ir_node *right);
707 ir_node *get_Quot_left(const ir_node *node);
708 void set_Quot_left(ir_node *node, ir_node *left);
709 ir_node *get_Quot_right(const ir_node *node);
710 void set_Quot_right(ir_node *node, ir_node *right);
711 ir_node *get_Quot_mem(const ir_node *node);
712 void set_Quot_mem(ir_node *node, ir_node *mem);
713 ir_mode *get_Quot_resmode(const ir_node *node);
714 void set_Quot_resmode(ir_node *node, ir_mode *mode);
717 * Projection numbers for Quot: use for Proj nodes!
720 pn_Quot_M = pn_Generic_M_regular, /**< Memory result. */
721 pn_Quot_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
722 pn_Quot_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
723 pn_Quot_res = pn_Generic_other, /**< Result of computation. */
724 pn_Quot_max /**< number of projections from a Quot */
725 } pn_Quot; /* Projection numbers for Quot. */
727 ir_node *get_DivMod_left(const ir_node *node);
728 void set_DivMod_left(ir_node *node, ir_node *left);
729 ir_node *get_DivMod_right(const ir_node *node);
730 void set_DivMod_right(ir_node *node, ir_node *right);
731 ir_node *get_DivMod_mem(const ir_node *node);
732 void set_DivMod_mem(ir_node *node, ir_node *mem);
733 ir_mode *get_DivMod_resmode(const ir_node *node);
734 void set_DivMod_resmode(ir_node *node, ir_mode *mode);
737 * Projection numbers for DivMod: use for Proj nodes!
740 pn_DivMod_M = pn_Generic_M_regular, /**< Memory result. */
741 pn_DivMod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
742 pn_DivMod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
743 pn_DivMod_res_div = pn_Generic_other, /**< Result of computation a / b. */
744 pn_DivMod_res_mod, /**< Result of computation a % b. */
745 pn_DivMod_max /**< number of projections from a DivMod */
746 } pn_DivMod; /* Projection numbers for DivMod. */
748 ir_node *get_Div_left(const ir_node *node);
749 void set_Div_left(ir_node *node, ir_node *left);
750 ir_node *get_Div_right(const ir_node *node);
751 void set_Div_right(ir_node *node, ir_node *right);
752 ir_node *get_Div_mem(const ir_node *node);
753 void set_Div_mem(ir_node *node, ir_node *mem);
754 ir_mode *get_Div_resmode(const ir_node *node);
755 void set_Div_resmode(ir_node *node, ir_mode *mode);
756 int is_Div_remainderless(const ir_node *node);
759 * Projection numbers for Div: use for Proj nodes!
762 pn_Div_M = pn_Generic_M_regular, /**< Memory result. */
763 pn_Div_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
764 pn_Div_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
765 pn_Div_res = pn_Generic_other, /**< Result of computation. */
766 pn_Div_max /**< number of projections from a Div */
767 } pn_Div; /* Projection numbers for Div. */
769 ir_node *get_Mod_left(const ir_node *node);
770 void set_Mod_left(ir_node *node, ir_node *left);
771 ir_node *get_Mod_right(const ir_node *node);
772 void set_Mod_right(ir_node *node, ir_node *right);
773 ir_node *get_Mod_mem(const ir_node *node);
774 void set_Mod_mem(ir_node *node, ir_node *mem);
775 ir_mode *get_Mod_resmode(const ir_node *node);
776 void set_Mod_resmode(ir_node *node, ir_mode *mode);
779 * Projection numbers for Mod: use for Proj nodes!
782 pn_Mod_M = pn_Generic_M_regular, /**< Memory result. */
783 pn_Mod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
784 pn_Mod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
785 pn_Mod_res = pn_Generic_other, /**< Result of computation. */
786 pn_Mod_max /**< number of projections from a Mod */
787 } pn_Mod; /* Projection numbers for Mod. */
789 ir_node *get_Abs_op(const ir_node *node);
790 void set_Abs_op(ir_node *node, ir_node *op);
792 ir_node *get_And_left(const ir_node *node);
793 void set_And_left(ir_node *node, ir_node *left);
794 ir_node *get_And_right(const ir_node *node);
795 void set_And_right(ir_node *node, ir_node *right);
797 ir_node *get_Or_left(const ir_node *node);
798 void set_Or_left(ir_node *node, ir_node *left);
799 ir_node *get_Or_right(const ir_node *node);
800 void set_Or_right(ir_node *node, ir_node *right);
802 ir_node *get_Eor_left(const ir_node *node);
803 void set_Eor_left(ir_node *node, ir_node *left);
804 ir_node *get_Eor_right(const ir_node *node);
805 void set_Eor_right(ir_node *node, ir_node *right);
807 ir_node *get_Not_op(const ir_node *node);
808 void set_Not_op(ir_node *node, ir_node *op);
810 /** returns the pnc name from an pnc constant */
811 const char *get_pnc_string(int pnc);
813 /** Calculates the negated (Complement(R)) pnc condition. */
814 pn_Cmp get_negated_pnc(long pnc, ir_mode *mode);
816 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
817 pn_Cmp get_inversed_pnc(long pnc);
819 /** An alternative name for get_inversed_pnc() that can be better memorized. */
820 #define get_mirrored_pnc(pnc) get_inversed_pnc(pnc)
822 ir_node *get_Cmp_left(const ir_node *node);
823 void set_Cmp_left(ir_node *node, ir_node *left);
824 ir_node *get_Cmp_right(const ir_node *node);
825 void set_Cmp_right(ir_node *node, ir_node *right);
827 ir_node *get_Shl_left(const ir_node *node);
828 void set_Shl_left(ir_node *node, ir_node *left);
829 ir_node *get_Shl_right(const ir_node *node);
830 void set_Shl_right(ir_node *node, ir_node *right);
832 ir_node *get_Shr_left(const ir_node *node);
833 void set_Shr_left(ir_node *node, ir_node *left);
834 ir_node *get_Shr_right(const ir_node *node);
835 void set_Shr_right(ir_node *node, ir_node *right);
837 ir_node *get_Shrs_left(const ir_node *node);
838 void set_Shrs_left(ir_node *node, ir_node *left);
839 ir_node *get_Shrs_right(const ir_node *node);
840 void set_Shrs_right(ir_node *node, ir_node *right);
842 ir_node *get_Rotl_left(const ir_node *node);
843 void set_Rotl_left(ir_node *node, ir_node *left);
844 ir_node *get_Rotl_right(const ir_node *node);
845 void set_Rotl_right(ir_node *node, ir_node *right);
847 ir_node *get_Conv_op(const ir_node *node);
848 void set_Conv_op(ir_node *node, ir_node *op);
849 int get_Conv_strict(const ir_node *node);
850 void set_Conv_strict(ir_node *node, int flag);
852 /* Does Cast need a mem operator?
853 * Cast should only depend on the type, not on the state of an
854 * entity. But: we initialize various fields after Alloc, that
855 * are accessed in the cast. This required some precaution, to
856 * get the right memory into the Loads generated from the cast.
858 ir_node *get_Cast_op(const ir_node *node);
859 void set_Cast_op(ir_node *node, ir_node *op);
860 ir_type *get_Cast_type(ir_node *node);
861 void set_Cast_type(ir_node *node, ir_type *to_tp);
863 /** Checks for upcast.
865 * Returns true if the Cast node casts a class type to a super type.
866 * Works also for pointers to classes (recursively).
868 * Needs typeinfo calculated.
870 int is_Cast_upcast(ir_node *node);
872 /** Checks for downcast.
874 * Returns true if the Cast node casts a class type to a sub type.
875 * Works also for pointers to classes (recursively).
877 * Needs typeinfo calculated.
879 int is_Cast_downcast(ir_node *node);
882 /** Returns true if n is a Phi or a Filter node in INTER-procedural view.
883 Returns false if irg is in phase phase_building and the Phi has zero
884 predecessors: it's a Phi0. */
885 int is_Phi(const ir_node *n);
886 /** Returns true if irg in phase phase_building and the Phi has zero
887 predecessors. It's a Phi0 then. */
888 int is_Phi0(const ir_node *n);
889 /* These routines also work for Filter nodes in INTER-procedural view. */
890 ir_node **get_Phi_preds_arr(ir_node *node);
891 int get_Phi_n_preds(const ir_node *node);
892 ir_node *get_Phi_pred(const ir_node *node, int pos);
893 void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
894 ir_node *get_Phi_next(const ir_node *phi);
895 void set_Phi_next(ir_node *phi, ir_node *next);
897 ir_node *get_Filter_pred(ir_node *node);
898 void set_Filter_pred(ir_node *node, ir_node *pred);
899 long get_Filter_proj(ir_node *node);
900 void set_Filter_proj(ir_node *node, long proj);
901 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
902 * @@@ Maybe better: arity is zero if no cg preds. */
903 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
904 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
905 int get_Filter_n_cg_preds(ir_node *node);
906 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
908 /** Return true if parameter is a memory operation.
910 * A memory operation is an operation that changes the
911 * memory. I.e., a Load or a Store operation.
913 int is_memop(const ir_node *node);
914 ir_node *get_memop_mem(const ir_node *node);
915 void set_memop_mem(ir_node *node, ir_node *mem);
916 ir_node *get_memop_ptr(const ir_node *node);
917 void set_memop_ptr(ir_node *node, ir_node *ptr);
920 * Projection numbers for Load: use for Proj nodes!
923 pn_Load_M = pn_Generic_M_regular, /**< Memory result. */
924 pn_Load_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
925 pn_Load_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
926 pn_Load_res = pn_Generic_other, /**< Result of load operation. */
927 pn_Load_max /**< number of projections from a Load */
928 } pn_Load; /* Projection numbers for Load. */
930 ir_node *get_Load_mem(const ir_node *node);
931 void set_Load_mem(ir_node *node, ir_node *mem);
932 ir_node *get_Load_ptr(const ir_node *node);
933 void set_Load_ptr(ir_node *node, ir_node *ptr);
934 ir_mode *get_Load_mode(const ir_node *node);
935 void set_Load_mode(ir_node *node, ir_mode *mode);
936 ir_volatility get_Load_volatility(const ir_node *node);
937 void set_Load_volatility(ir_node *node, ir_volatility volatility);
938 ir_align get_Load_align(const ir_node *node);
939 void set_Load_align(ir_node *node, ir_align align);
942 * Projection numbers for Store: use for Proj nodes!
945 pn_Store_M = pn_Generic_M_regular, /**< Memory result. */
946 pn_Store_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
947 pn_Store_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
948 pn_Store_max = pn_Generic_other /**< number of projections from a Store */
949 } pn_Store; /* Projection numbers for Store. */
951 ir_node *get_Store_mem(const ir_node *node);
952 void set_Store_mem(ir_node *node, ir_node *mem);
953 ir_node *get_Store_ptr(const ir_node *node);
954 void set_Store_ptr(ir_node *node, ir_node *ptr);
955 ir_node *get_Store_value(const ir_node *node);
956 void set_Store_value(ir_node *node, ir_node *value);
957 ir_volatility get_Store_volatility(const ir_node *node);
958 void set_Store_volatility(ir_node *node, ir_volatility volatility);
959 ir_align get_Store_align(const ir_node *node);
960 void set_Store_align(ir_node *node, ir_align align);
963 * Projection numbers for Alloc: use for Proj nodes!
966 pn_Alloc_M = pn_Generic_M_regular, /**< Memory result. */
967 pn_Alloc_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
968 pn_Alloc_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
969 pn_Alloc_res = pn_Generic_other, /**< Result of allocation. */
970 pn_Alloc_max /**< number of projections from an Alloc */
971 } pn_Alloc; /* Projection numbers for Alloc. */
973 ir_node *get_Alloc_mem(const ir_node *node);
974 void set_Alloc_mem(ir_node *node, ir_node *mem);
975 ir_node *get_Alloc_size(const ir_node *node);
976 void set_Alloc_size(ir_node *node, ir_node *size);
977 ir_type *get_Alloc_type(ir_node *node);
978 void set_Alloc_type(ir_node *node, ir_type *tp);
980 ir_where_alloc get_Alloc_where(const ir_node *node);
981 void set_Alloc_where(ir_node *node, ir_where_alloc where);
983 ir_node *get_Free_mem(const ir_node *node);
984 void set_Free_mem(ir_node *node, ir_node *mem);
985 ir_node *get_Free_ptr(const ir_node *node);
986 void set_Free_ptr(ir_node *node, ir_node *ptr);
987 ir_node *get_Free_size(const ir_node *node);
988 void set_Free_size(ir_node *node, ir_node *size);
989 ir_type *get_Free_type(ir_node *node);
990 void set_Free_type(ir_node *node, ir_type *tp);
992 ir_where_alloc get_Free_where(const ir_node *node);
993 void set_Free_where(ir_node *node, ir_where_alloc where);
995 ir_node **get_Sync_preds_arr(ir_node *node);
996 int get_Sync_n_preds(const ir_node *node);
997 ir_node *get_Sync_pred(const ir_node *node, int pos);
998 void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
999 void add_Sync_pred(ir_node *node, ir_node *pred);
1001 /** Returns the source language type of a Proj node.
1002 * Must be an atomic type. Mode of type must be mode of node.
1004 ir_type *get_Proj_type(ir_node *node);
1006 /** Return the predecessor of a Proj node. */
1007 ir_node *get_Proj_pred(const ir_node *node);
1008 void set_Proj_pred(ir_node *node, ir_node *pred);
1009 /** Return the projection number of a Proj node. */
1010 long get_Proj_proj(const ir_node *node);
1011 void set_Proj_proj(ir_node *node, long proj);
1014 * Returns non-zero if a node is a routine parameter.
1016 * @param node the Proj node to test
1018 int is_arg_Proj(const ir_node *node);
1020 ir_node **get_Tuple_preds_arr(ir_node *node);
1021 int get_Tuple_n_preds(const ir_node *node);
1022 ir_node *get_Tuple_pred(const ir_node *node, int pos);
1023 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
1025 ir_node *get_Id_pred(const ir_node *node);
1026 void set_Id_pred(ir_node *node, ir_node *pred);
1028 /** Confirm has a single result and returns 'value' unchanged.
1029 * The node expresses a restriction on 'value':
1030 * 'value' 'cmp' 'bound' == true. */
1031 ir_node *get_Confirm_value(const ir_node *node);
1032 void set_Confirm_value(ir_node *node, ir_node *value);
1033 ir_node *get_Confirm_bound(const ir_node *node);
1034 void set_Confirm_bound(ir_node *node, ir_node *bound);
1035 pn_Cmp get_Confirm_cmp(const ir_node *node);
1036 void set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
1041 ir_node *get_Mux_sel(const ir_node *node);
1042 void set_Mux_sel(ir_node *node, ir_node *sel);
1043 ir_node *get_Mux_false(const ir_node *node);
1044 void set_Mux_false(ir_node *node, ir_node *ir_false);
1045 ir_node *get_Mux_true(const ir_node *node);
1046 void set_Mux_true(ir_node *node, ir_node *ir_true);
1049 * Projection numbers for result of CopyB node: use for Proj nodes!
1052 pn_CopyB_M_regular = pn_Generic_M_regular, /**< The memory result. */
1053 pn_CopyB_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1054 pn_CopyB_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1055 pn_CopyB_M_except = pn_Generic_other, /**< The memory result in case the runtime function terminated with
1057 pn_CopyB_max /**< number of projections from a CopyB */
1058 } pn_CopyB; /* Projection numbers for CopyB. */
1059 #define pn_CopyB_M pn_CopyB_M_regular
1061 ir_node *get_CopyB_mem(const ir_node *node);
1062 void set_CopyB_mem(ir_node *node, ir_node *mem);
1063 ir_node *get_CopyB_dst(const ir_node *node);
1064 void set_CopyB_dst(ir_node *node, ir_node *dst);
1065 ir_node *get_CopyB_src(const ir_node *node);
1066 void set_CopyB_src(ir_node *node, ir_node *src);
1067 ir_type *get_CopyB_type(ir_node *node);
1068 void set_CopyB_type(ir_node *node, ir_type *data_type);
1071 * Projection numbers for result of InstOf node: use for Proj nodes!
1074 pn_InstOf_M_regular = pn_Generic_M_regular, /**< The memory result. */
1075 pn_InstOf_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1076 pn_InstOf_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1077 pn_InstOf_res = pn_Generic_other, /**< The checked object pointer. */
1078 pn_InstOf_M_except, /**< The memory result in case the runtime function terminated with
1080 pn_InstOf_max /**< number of projections from an InstOf */
1082 #define pn_InstOf_M pn_InstOf_M_regular
1084 /** InstOf access. */
1085 ir_type *get_InstOf_type(ir_node *node);
1086 void set_InstOf_type(ir_node *node, ir_type *type);
1087 ir_node *get_InstOf_store(const ir_node *node);
1088 void set_InstOf_store(ir_node *node, ir_node *obj);
1089 ir_node *get_InstOf_obj(const ir_node *node);
1090 void set_InstOf_obj(ir_node *node, ir_node *obj);
1093 * Projection numbers for Raise.
1096 pn_Raise_M = pn_Generic_M_regular, /**< The Memory result. */
1097 pn_Raise_X = pn_Generic_X_regular, /**< The control flow to the exception handler. */
1098 pn_Raise_max /**< number of projections from a Raise */
1099 } pn_Raise; /* Projection numbers for Raise. */
1101 ir_node *get_Raise_mem(const ir_node *node);
1102 void set_Raise_mem(ir_node *node, ir_node *mem);
1103 ir_node *get_Raise_exo_ptr(const ir_node *node); /* PoinTeR to EXception Object */
1104 void set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
1107 * Projection numbers for result of Bound node: use for Proj nodes!
1110 pn_Bound_M = pn_Generic_M_regular, /**< The memory result. */
1111 pn_Bound_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1112 pn_Bound_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1113 pn_Bound_res = pn_Generic_other, /**< The checked index. */
1114 pn_Bound_max /**< number of projections from a Bound */
1117 /** Returns the memory input of a Bound operation. */
1118 ir_node *get_Bound_mem(const ir_node *bound);
1119 void set_Bound_mem(ir_node *bound, ir_node *mem);
1121 /** Returns the index input of a Bound operation. */
1122 ir_node *get_Bound_index(const ir_node *bound);
1123 void set_Bound_index(ir_node *bound, ir_node *idx);
1125 /** Returns the lower bound input of a Bound operation. */
1126 ir_node *get_Bound_lower(const ir_node *bound);
1127 void set_Bound_lower(ir_node *bound, ir_node *lower);
1129 /** Returns the upper bound input of a Bound operation. */
1130 ir_node *get_Bound_upper(const ir_node *bound);
1131 void set_Bound_upper(ir_node *bound, ir_node *upper);
1133 /** Return the operand of a Pin node. */
1134 ir_node *get_Pin_op(const ir_node *pin);
1135 void set_Pin_op(ir_node *pin, ir_node *node);
1137 /** Return the assembler text of an ASM pseudo node. */
1138 ident *get_ASM_text(const ir_node *node);
1139 /** Return the number of input constraints for an ASM node. */
1140 int get_ASM_n_input_constraints(const ir_node *node);
1141 /** Return the input constraints for an ASM node. */
1142 const ir_asm_constraint *get_ASM_input_constraints(const ir_node *node);
1143 /** Return the number of output constraints for an ASM node. */
1144 int get_ASM_n_output_constraints(const ir_node *node);
1145 /** Return the output constraints for an ASM node. */
1146 const ir_asm_constraint *get_ASM_output_constraints(const ir_node *node);
1147 /** Return the number of clobbered registers for an ASM node. */
1148 int get_ASM_n_clobbers(const ir_node *node);
1149 /** Return the list of clobbered registers for an ASM node. */
1150 ident **get_ASM_clobbers(const ir_node *node);
1154 * NAME Auxiliary routines
1158 /** Returns operand of node if node is a Proj. */
1159 ir_node *skip_Proj(ir_node *node);
1160 /** Returns operand of node if node is a Proj. */
1161 const ir_node *skip_Proj_const(const ir_node *node);
1162 /** Returns operand of node if node is a Id. */
1163 ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
1164 /** Returns corresponding operand of Tuple if node is a Proj from
1166 ir_node *skip_Tuple(ir_node *node);
1167 /** Returns operand of node if node is a Cast. */
1168 ir_node *skip_Cast(ir_node *node);
1169 const ir_node *skip_Cast_const(const ir_node *node);
1170 /** Returns operand of node if node is a Pin. */
1171 ir_node *skip_Pin(ir_node *node);
1172 /** Returns operand of node if node is a Confirm */
1173 ir_node *skip_Confirm(ir_node *node);
1174 /** Skip all high-level Operations (including Cast, Confirm). */
1175 ir_node *skip_HighLevel_ops(ir_node *node);
1176 /** Returns true if irn is a Const node. */
1177 int is_Const(const ir_node *node);
1178 /** Returns true if a node is a Conv node. */
1179 int is_Conv(const ir_node *node);
1180 /** Returns true if a node is a strictConv node. */
1181 int is_strictConv(const ir_node *node);
1182 /** Returns true if a node is a Cast node. */
1183 int is_Cast(const ir_node *node);
1184 /** Returns true if node is a Bad node. */
1185 int is_Bad(const ir_node *node);
1186 /** Returns true if node is a NoMem node. */
1187 int is_NoMem(const ir_node *node);
1188 /** Returns true if node is a Start node. */
1189 int is_Start(const ir_node *node);
1190 /** Returns true if node is a Minus node. */
1191 int is_Minus(const ir_node *node);
1192 /** Returns true if node is a Abs node. */
1193 int is_Abs(const ir_node *node);
1194 /** Returns true if node is a Mod node. */
1195 int is_Mod(const ir_node *node);
1196 /** Returns true if node is a Div node. */
1197 int is_Div(const ir_node *node);
1198 /** Returns true if node is a DivMod node. */
1199 int is_DivMod(const ir_node *node);
1200 /** Returns true if node is a Quot node. */
1201 int is_Quot(const ir_node *node);
1202 /** Returns true if node is an Add node. */
1203 int is_Add(const ir_node *node);
1204 /** Returns true if node is a Carry node. */
1205 int is_Carry(const ir_node *node);
1206 /** Returns true if node is an And node. */
1207 int is_And(const ir_node *node);
1208 /** Returns true if node is an Or node. */
1209 int is_Or(const ir_node *node);
1210 /** Returns true if node is an Eor node. */
1211 int is_Eor(const ir_node *node);
1212 /** Returns true if node is a Sub node. */
1213 int is_Sub(const ir_node *node);
1214 /** Returns true if node is a Not node. */
1215 int is_Not(const ir_node *node);
1216 /** Returns true if node is a Shl node. */
1217 int is_Shl(const ir_node *node);
1218 /** Returns true if node is a Shr node. */
1219 int is_Shr(const ir_node *node);
1220 /** Returns true if node is a Shrs node. */
1221 int is_Shrs(const ir_node *node);
1222 /** Returns true if node is a Rotl node. */
1223 int is_Rotl(const ir_node *node);
1224 /** Returns true if node is an Id node. */
1225 int is_Id(const ir_node *node);
1226 /** Returns true if node is a Tuple node. */
1227 int is_Tuple(const ir_node *node);
1228 /** Returns true if node is a Bound node. */
1229 int is_Bound(const ir_node *node);
1230 /** Returns true if the node is not a Block */
1231 int is_no_Block(const ir_node *node);
1232 /** Returns true if the node is a Block */
1233 int is_Block(const ir_node *node);
1234 /** Returns true if node is an Unknown node. */
1235 int is_Unknown(const ir_node *node);
1236 /** Returns true if node is a Return node. */
1237 int is_Return(const ir_node *node);
1238 /** Returns true if node is a Call node. */
1239 int is_Call(const ir_node *node);
1240 /** Returns true if node is a CallBegin node. */
1241 int is_CallBegin(const ir_node *node);
1242 /** Returns true if node is a Sel node. */
1243 int is_Sel(const ir_node *node);
1244 /** Returns true if node is a Mul node. */
1245 int is_Mul(const ir_node *node);
1246 /** Returns true if node is a Mulh node. */
1247 int is_Mulh(const ir_node *node);
1248 /** Returns true if node is a Mux node. */
1249 int is_Mux(const ir_node *node);
1250 /** Returns true if node is a Load node. */
1251 int is_Load(const ir_node *node);
1252 /** Returns true if node is a Store node. */
1253 int is_Store(const ir_node *node);
1254 /** Returns true if node is a Sync node. */
1255 int is_Sync(const ir_node *node);
1256 /** Returns true if node is a Confirm node. */
1257 int is_Confirm(const ir_node *node);
1258 /** Returns true if node is a Pin node. */
1259 int is_Pin(const ir_node *node);
1260 /** Returns true if node is a SymConst node. */
1261 int is_SymConst(const ir_node *node);
1262 /** Returns true if node is a SymConst node with kind symconst_addr_ent. */
1263 int is_SymConst_addr_ent(const ir_node *node);
1264 /** Returns true if node is a Cond node. */
1265 int is_Cond(const ir_node *node);
1266 /** Returns true of node is a CopyB node. */
1267 int is_CopyB(const ir_node *node);
1268 /** Returns true if node is a Cmp node. */
1269 int is_Cmp(const ir_node *node);
1270 /** Returns true if node is an Alloc node. */
1271 int is_Alloc(const ir_node *node);
1272 /** Returns true if node is a Free node. */
1273 int is_Free(const ir_node *node);
1274 /** Returns true if a node is a Jmp node. */
1275 int is_Jmp(const ir_node *node);
1276 /** Returns true if a node is a IJmp node. */
1277 int is_IJmp(const ir_node *node);
1278 /** Returns true if a node is a Raise node. */
1279 int is_Raise(const ir_node *node);
1280 /** Returns true if a node is an ASM node. */
1281 int is_ASM(const ir_node *node);
1282 /** Returns true if node is a Proj node or a Filter node in INTRA-procedural view. */
1283 int is_Proj(const ir_node *node);
1284 /** Returns true if node is a Filter node. */
1285 int is_Filter(const ir_node *node);
1287 /** Returns true if the operation manipulates control flow:
1288 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1289 int is_cfop(const ir_node *node);
1291 /** Returns true if the operation manipulates interprocedural control flow:
1292 CallBegin, EndReg, EndExcept */
1293 int is_ip_cfop(const ir_node *node);
1294 /** Returns true if the operation can change the control flow because
1295 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1296 Bad. Raise is not fragile, but a unconditional jump. */
1297 int is_fragile_op(const ir_node *node);
1298 /** Returns the memory operand of fragile operations. */
1299 ir_node *get_fragile_op_mem(ir_node *node);
1300 /** Returns the result mode of a Div operation. */
1301 ir_mode *get_divop_resmod(const ir_node *node);
1303 /** Returns true if the operation is a forking control flow
1304 * operation: Cond. */
1305 int is_irn_forking(const ir_node *node);
1307 /** Return the type associated with the value produced by n
1308 * if the node remarks this type as it is the case for
1309 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1310 ir_type *get_irn_type(ir_node *n);
1312 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1314 ir_type *get_irn_type_attr(ir_node *n);
1316 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1317 ir_entity *get_irn_entity_attr(ir_node *n);
1319 /** Returns non-zero for constant-like nodes. */
1320 int is_irn_constlike(const ir_node *node);
1323 * Returns non-zero for nodes that must be always optimized
1324 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1326 int is_irn_always_opt(const ir_node *node);
1329 * Returns non-zero for nodes that are allowed to have keep-alives and
1330 * are neither Block nor PhiM.
1332 int is_irn_keep(const ir_node *node);
1335 * Returns non-zero for nodes that are always placed in the start block.
1337 int is_irn_start_block_placed(const ir_node *node);
1340 * Returns non-zero for nodes that are machine operations.
1342 int is_irn_machine_op(const ir_node *node);
1345 * Returns non-zero for nodes that are machine operands.
1347 int is_irn_machine_operand(const ir_node *node);
1350 * Returns non-zero for nodes that have the n'th user machine flag set.
1352 int is_irn_machine_user(const ir_node *node, unsigned n);
1355 * A type to express conditional jump predictions.
1358 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1359 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1360 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1361 } cond_jmp_predicate;
1363 /** Gets the string representation of the jump prediction .*/
1364 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1366 /** Returns the conditional jump prediction of a Cond node. */
1367 cond_jmp_predicate get_Cond_jmp_pred(const ir_node *cond);
1369 /** Sets a new conditional jump prediction. */
1370 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1372 /** Checks whether a node represents a global address. */
1373 int is_Global(const ir_node *node);
1375 /* Returns the entity of a global address. */
1376 ir_entity *get_Global_entity(const ir_node *node);
1379 * Access custom node data.
1380 * The data must have been registered with
1381 * register_additional_node_data() before.
1382 * @param node The ir node to get the data from.
1383 * @param type The type of the data you registered.
1384 * @param off The value returned by register_additional_node_data().
1385 * @return A pointer of type @p type.
1387 #define get_irn_data(node,type,off) \
1388 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1391 * Get the pointer to the node some custom data belongs to.
1392 * @param data The pointer to the custom data.
1393 * @param off The number as returned by register_additional_node_data().
1394 * @return A pointer to the ir node the custom data belongs to.
1396 #define get_irn_data_base(data,off) \
1397 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1400 * Request additional data to be allocated with an ir node.
1401 * @param size The size of the additional data required.
1402 * @return A positive number, if the operation was successful, which
1403 * must be passed to the access macro get_irn_data(), 0 if the
1404 * registration failed.
1406 unsigned firm_register_additional_node_data(unsigned size);
1409 * Return a pointer to the node attributes.
1410 * Needed for user-defined nodes.
1412 void *get_irn_generic_attr(ir_node *node);
1413 const void *get_irn_generic_attr_const(const ir_node *node);
1416 * Returns the unique node index for the node in its graph.
1417 * This index is used to access phase information for this node.
1419 unsigned get_irn_idx(const ir_node *node);
1422 * Sets the debug information of a node.
1424 * @param n The node.
1425 * @param db The debug info.
1427 void set_irn_dbg_info(ir_node *n, dbg_info *db);
1430 * Returns the debug information of an node.
1432 * @param n The node.
1434 dbg_info *get_irn_dbg_info(const ir_node *n);
1437 * Calculate a hash value of a node. Only inputs, mode and opcode are used.
1439 * @param node the node to hash
1441 unsigned firm_default_hash(const ir_node *node);
1444 * returns a descriptive name of a node (containing type+number)
1446 const char *gdb_node_helper(void *firm_object);
1448 /*@}*/ /* end of ir_node group definition */