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 /** Some parts of the End node are allocated separately -- their memory
447 is not recovered by dead_node_elimination if a End node is dead.
448 free_End() frees these data structures. */
449 void free_End(ir_node *end);
451 /** Return the target address of an IJmp */
452 ir_node *get_IJmp_target(const ir_node *ijmp);
453 /** Sets the target address of an IJmp */
454 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
456 /* We distinguish three kinds of Cond nodes. These can be distinguished
457 by the mode of the selector operand and an internal flag of type cond_kind.
458 First we distinguish binary Conds and switch Conds.
459 A binary Cond has as selector a boolean value. Proj(0) projects the control
460 flow for case "False", Proj(1) the control flow for "True". A binary Cond
461 is recognized by the boolean selector.
462 The switch Cond has as selector an unsigned integer. It produces as result
463 an n+1 Tuple (cf0, ... , cfn) of control flows.
464 We differ two flavors of this Cond. The first, the dense Cond, passes
465 control along output i if the selector value is i, 0 <= i <= n. If the
466 selector value is >n it passes control along output n.
467 The second Cond flavor differences in the treatment of cases not specified in
468 the source program. It magically knows about the existence of Proj nodes.
469 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
470 exists. Else it passes control along output n (even if this Proj does not
471 exist.) This Cond we call "fragmentary". There is a special constructor
472 new_defaultProj that automatically sets the flavor.
473 The two switch flavors are distinguished by a flag of type cond_kind.
474 Default flavor is "dense"
477 dense, /**< Default. Missing Proj nodes are dead control flow. */
478 fragmentary /**< Special. No control flow optimizations allowed. Missing
479 Proj nodes mean default control flow, i.e., Proj(n). */
482 ir_node *get_Cond_selector(const ir_node *node);
483 void set_Cond_selector(ir_node *node, ir_node *selector);
484 cond_kind get_Cond_kind(const ir_node *node);
485 void set_Cond_kind(ir_node *node, cond_kind kind);
486 long get_Cond_defaultProj(const ir_node *node);
489 * Projection numbers for conditions.
492 pn_Cond_false, /**< Control flow if operand is "false". */
493 pn_Cond_true, /**< Control flow if operand is "true". */
494 pn_Cond_max /**< number of projections from a Cond */
495 } pn_Cond; /* Projection numbers for Cond. */
497 ir_node *get_Return_mem(const ir_node *node);
498 void set_Return_mem(ir_node *node, ir_node *mem);
499 ir_node **get_Return_res_arr(ir_node *node);
500 int get_Return_n_ress(const ir_node *node);
501 ir_node *get_Return_res(const ir_node *node, int pos);
502 void set_Return_res(ir_node *node, int pos, ir_node *res);
504 tarval *get_Const_tarval(const ir_node *node);
505 void set_Const_tarval(ir_node *node, tarval *con);
507 /** Return non-zero if the given Const node represents the 0 constant. */
508 int is_Const_null(const ir_node *node);
510 /** Return non-zero if the given Const node represents the 1 constant. */
511 int is_Const_one(const ir_node *node);
513 /** Return non-zero if the given Const node represents the constant with all bits set. */
514 int is_Const_all_one(const ir_node *node);
516 /** Returns the source language type of a Const node.
517 * Must be an atomic type. Mode of type must be mode of node.
519 ir_type *get_Const_type(ir_node *node);
521 /** Sets the source language type of a Const node. */
522 void set_Const_type(ir_node *node, ir_type *tp);
524 /** Returns non-zero if s symconst kind has a type attribute */
525 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
527 /** Returns non-zero if s symconst kind has an ident attribute */
528 #define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)
530 /** Returns non-zero if s symconst kind has an entity attribute */
531 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
533 /** Returns non-zero if s symconst kind has an enum_const attribute */
534 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
536 /** Returns non-zero if s symconst kind has a label attribute */
537 #define SYMCONST_HAS_LABEL(kind) ((kind) == symconst_label)
539 /** Get the kind of the SymConst. */
540 symconst_kind get_SymConst_kind(const ir_node *node);
541 /** Set the kind of the SymConst. */
542 void set_SymConst_kind(ir_node *node, symconst_kind num);
544 /** Only to access SymConst of kind type_tag or size. Else assertion: */
545 ir_type *get_SymConst_type(const ir_node *node);
546 void set_SymConst_type(ir_node *node, ir_type *tp);
548 /** Only to access SymConst of kind addr_name. Else assertion: */
549 ident *get_SymConst_name(const ir_node *node);
550 void set_SymConst_name(ir_node *node, ident *name);
552 /** Only to access SymConst of kind addr_ent. Else assertion: */
553 ir_entity *get_SymConst_entity(const ir_node *node);
554 void set_SymConst_entity(ir_node *node, ir_entity *ent);
556 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
557 ir_enum_const *get_SymConst_enum(const ir_node *node);
558 void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
560 /** Sets both: type and ptrinfo. Needed to treat the node independent of
561 its semantics. Does a memcpy for the memory sym points to. */
562 /* write 'union': firmjni then does not create a method... */
563 union symconst_symbol get_SymConst_symbol(const ir_node *node);
564 void set_SymConst_symbol(ir_node *node,
565 union symconst_symbol sym);
567 /** Only to access SymConst of kind symconst_label. Else assertion: */
568 ir_label_t get_SymConst_label(const ir_node *node);
569 void set_SymConst_label(ir_node *node, ir_label_t label);
572 /** Access the type of the value represented by the SymConst.
574 * Example: primitive type int for SymConst size. */
575 ir_type *get_SymConst_value_type(ir_node *node);
576 void set_SymConst_value_type(ir_node *node, ir_type *tp);
578 ir_node *get_Sel_mem(const ir_node *node);
579 void set_Sel_mem(ir_node *node, ir_node *mem);
580 ir_node *get_Sel_ptr(const ir_node *node); /* ptr to the object to select from */
581 void set_Sel_ptr(ir_node *node, ir_node *ptr);
582 ir_node **get_Sel_index_arr(ir_node *node);
583 int get_Sel_n_indexs(const ir_node *node);
584 ir_node *get_Sel_index(const ir_node *node, int pos);
585 void set_Sel_index(ir_node *node, int pos, ir_node *index);
586 ir_entity *get_Sel_entity(const ir_node *node); /* entity to select */
587 void set_Sel_entity (ir_node *node, ir_entity *ent);
590 * Projection numbers for result of Call node: use for Proj nodes!
593 pn_Call_M_regular = pn_Generic_M_regular, /**< The memory result. */
594 pn_Call_X_regular = pn_Generic_X_regular, /**< The control flow result when no exception occurs. */
595 pn_Call_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler. */
596 pn_Call_T_result = pn_Generic_other, /**< The tuple containing all (0, 1, 2, ...) results. */
597 pn_Call_M_except, /**< The memory result in case the called method terminated with
599 pn_Call_P_value_res_base, /**< A pointer to the memory region containing copied results
600 passed by value (for compound result types). */
601 pn_Call_max /**< number of projections from a Call */
602 } pn_Call; /* Projection numbers for Call. */
603 #define pn_Call_M pn_Call_M_regular
605 ir_node *get_Call_mem(const ir_node *node);
606 void set_Call_mem(ir_node *node, ir_node *mem);
607 ir_node *get_Call_ptr(const ir_node *node);
608 void set_Call_ptr(ir_node *node, ir_node *ptr);
609 ir_node **get_Call_param_arr(ir_node *node);
610 /** Gets the number of parameters of a call. */
611 int get_Call_n_params(const ir_node *node);
612 /** Gets the call parameter at position pos. */
613 ir_node *get_Call_param(const ir_node *node, int pos);
614 /** Sets the call parameter at position pos. */
615 void set_Call_param(ir_node *node, int pos, ir_node *param);
616 /** Gets the type of a call. */
617 ir_type *get_Call_type(ir_node *node);
618 /** Sets the type of a call. */
619 void set_Call_type(ir_node *node, ir_type *tp);
620 /** Gets the arity of a call. Identical to get_Call_n_params(). */
621 int get_Call_arity(const ir_node *node);
624 * Returns non-zero if a Call is surely a self-recursive Call.
625 * Beware: if this functions returns 0, the call might be self-recursive!
627 int is_self_recursive_Call(const ir_node *call);
629 /** Set, get and remove the callee information for a Call node.
631 * The callee information lists all method entities that can be called
632 * from this node. If the address expression can not be analyzed fully,
633 * e.g., as entities can be called that are not in the compilation unit,
634 * the array contains the unknown_entity. The array contains only entities
635 * with peculiarity_existent, but with all kinds of visibility. The entities
636 * not necessarily contain an irg.
638 * The array is only accessible if callee information is valid. See flag
641 * The memory allocated for the array is managed automatically, i.e., it must
642 * not be freed if the Call node is removed from the graph.
644 * @param node A Call node.
646 int Call_has_callees(const ir_node *node);
647 int get_Call_n_callees(const ir_node *node);
648 ir_entity *get_Call_callee(const ir_node *node, int pos);
650 /** Set the full callee array.
652 * The passed array is copied. Assumes current_ir_graph set properly! */
653 void set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
654 void remove_Call_callee_arr(ir_node *node);
656 ir_node *get_CallBegin_ptr(const ir_node *node);
657 void set_CallBegin_ptr(ir_node *node, ir_node *ptr);
658 ir_node *get_CallBegin_call(const ir_node *node);
659 void set_CallBegin_call(ir_node *node, ir_node *call);
661 /* For unary and binary arithmetic operations the access to the
662 operands can be factored out. Left is the first, right the
663 second arithmetic value as listed in tech report 1999-44.
664 unops are: Minus, Abs, Not, Conv, Cast
665 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
666 Shr, Shrs, Rotl, Cmp */
667 int is_unop(const ir_node *node);
668 ir_node *get_unop_op(const ir_node *node);
669 void set_unop_op(ir_node *node, ir_node *op);
670 int is_binop(const ir_node *node);
671 ir_node *get_binop_left(const ir_node *node);
672 void set_binop_left(ir_node *node, ir_node *left);
673 ir_node *get_binop_right(const ir_node *node);
674 void set_binop_right(ir_node *node, ir_node *right);
676 ir_node *get_Add_left(const ir_node *node);
677 void set_Add_left(ir_node *node, ir_node *left);
678 ir_node *get_Add_right(const ir_node *node);
679 void set_Add_right(ir_node *node, ir_node *right);
681 ir_node *get_Carry_left(const ir_node *node);
682 void set_Carry_left(ir_node *node, ir_node *left);
683 ir_node *get_Carry_right(const ir_node *node);
684 void set_Carry_right(ir_node *node, ir_node *right);
686 ir_node *get_Sub_left(const ir_node *node);
687 void set_Sub_left(ir_node *node, ir_node *left);
688 ir_node *get_Sub_right(const ir_node *node);
689 void set_Sub_right(ir_node *node, ir_node *right);
691 ir_node *get_Minus_op(const ir_node *node);
692 void set_Minus_op(ir_node *node, ir_node *op);
694 ir_node *get_Mul_left(const ir_node *node);
695 void set_Mul_left(ir_node *node, ir_node *left);
696 ir_node *get_Mul_right(const ir_node *node);
697 void set_Mul_right(ir_node *node, ir_node *right);
699 ir_node *get_Mulh_left(const ir_node *node);
700 void set_Mulh_left(ir_node *node, ir_node *left);
701 ir_node *get_Mulh_right(const ir_node *node);
702 void set_Mulh_right(ir_node *node, ir_node *right);
704 ir_node *get_Quot_left(const ir_node *node);
705 void set_Quot_left(ir_node *node, ir_node *left);
706 ir_node *get_Quot_right(const ir_node *node);
707 void set_Quot_right(ir_node *node, ir_node *right);
708 ir_node *get_Quot_mem(const ir_node *node);
709 void set_Quot_mem(ir_node *node, ir_node *mem);
710 ir_mode *get_Quot_resmode(const ir_node *node);
711 void set_Quot_resmode(ir_node *node, ir_mode *mode);
714 * Projection numbers for Quot: use for Proj nodes!
717 pn_Quot_M = pn_Generic_M_regular, /**< Memory result. */
718 pn_Quot_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
719 pn_Quot_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
720 pn_Quot_res = pn_Generic_other, /**< Result of computation. */
721 pn_Quot_max /**< number of projections from a Quot */
722 } pn_Quot; /* Projection numbers for Quot. */
724 ir_node *get_DivMod_left(const ir_node *node);
725 void set_DivMod_left(ir_node *node, ir_node *left);
726 ir_node *get_DivMod_right(const ir_node *node);
727 void set_DivMod_right(ir_node *node, ir_node *right);
728 ir_node *get_DivMod_mem(const ir_node *node);
729 void set_DivMod_mem(ir_node *node, ir_node *mem);
730 ir_mode *get_DivMod_resmode(const ir_node *node);
731 void set_DivMod_resmode(ir_node *node, ir_mode *mode);
734 * Projection numbers for DivMod: use for Proj nodes!
737 pn_DivMod_M = pn_Generic_M_regular, /**< Memory result. */
738 pn_DivMod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
739 pn_DivMod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
740 pn_DivMod_res_div = pn_Generic_other, /**< Result of computation a / b. */
741 pn_DivMod_res_mod, /**< Result of computation a % b. */
742 pn_DivMod_max /**< number of projections from a DivMod */
743 } pn_DivMod; /* Projection numbers for DivMod. */
745 ir_node *get_Div_left(const ir_node *node);
746 void set_Div_left(ir_node *node, ir_node *left);
747 ir_node *get_Div_right(const ir_node *node);
748 void set_Div_right(ir_node *node, ir_node *right);
749 ir_node *get_Div_mem(const ir_node *node);
750 void set_Div_mem(ir_node *node, ir_node *mem);
751 ir_mode *get_Div_resmode(const ir_node *node);
752 void set_Div_resmode(ir_node *node, ir_mode *mode);
753 int is_Div_remainderless(const ir_node *node);
756 * Projection numbers for Div: use for Proj nodes!
759 pn_Div_M = pn_Generic_M_regular, /**< Memory result. */
760 pn_Div_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
761 pn_Div_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
762 pn_Div_res = pn_Generic_other, /**< Result of computation. */
763 pn_Div_max /**< number of projections from a Div */
764 } pn_Div; /* Projection numbers for Div. */
766 ir_node *get_Mod_left(const ir_node *node);
767 void set_Mod_left(ir_node *node, ir_node *left);
768 ir_node *get_Mod_right(const ir_node *node);
769 void set_Mod_right(ir_node *node, ir_node *right);
770 ir_node *get_Mod_mem(const ir_node *node);
771 void set_Mod_mem(ir_node *node, ir_node *mem);
772 ir_mode *get_Mod_resmode(const ir_node *node);
773 void set_Mod_resmode(ir_node *node, ir_mode *mode);
776 * Projection numbers for Mod: use for Proj nodes!
779 pn_Mod_M = pn_Generic_M_regular, /**< Memory result. */
780 pn_Mod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
781 pn_Mod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
782 pn_Mod_res = pn_Generic_other, /**< Result of computation. */
783 pn_Mod_max /**< number of projections from a Mod */
784 } pn_Mod; /* Projection numbers for Mod. */
786 ir_node *get_Abs_op(const ir_node *node);
787 void set_Abs_op(ir_node *node, ir_node *op);
789 ir_node *get_And_left(const ir_node *node);
790 void set_And_left(ir_node *node, ir_node *left);
791 ir_node *get_And_right(const ir_node *node);
792 void set_And_right(ir_node *node, ir_node *right);
794 ir_node *get_Or_left(const ir_node *node);
795 void set_Or_left(ir_node *node, ir_node *left);
796 ir_node *get_Or_right(const ir_node *node);
797 void set_Or_right(ir_node *node, ir_node *right);
799 ir_node *get_Eor_left(const ir_node *node);
800 void set_Eor_left(ir_node *node, ir_node *left);
801 ir_node *get_Eor_right(const ir_node *node);
802 void set_Eor_right(ir_node *node, ir_node *right);
804 ir_node *get_Not_op(const ir_node *node);
805 void set_Not_op(ir_node *node, ir_node *op);
807 /** returns the pnc name from an pnc constant */
808 const char *get_pnc_string(int pnc);
810 /** Calculates the negated (Complement(R)) pnc condition. */
811 pn_Cmp get_negated_pnc(long pnc, ir_mode *mode);
813 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
814 pn_Cmp get_inversed_pnc(long pnc);
816 /** An alternative name for get_inversed_pnc() that can be better memorized. */
817 #define get_mirrored_pnc(pnc) get_inversed_pnc(pnc)
819 ir_node *get_Cmp_left(const ir_node *node);
820 void set_Cmp_left(ir_node *node, ir_node *left);
821 ir_node *get_Cmp_right(const ir_node *node);
822 void set_Cmp_right(ir_node *node, ir_node *right);
824 ir_node *get_Shl_left(const ir_node *node);
825 void set_Shl_left(ir_node *node, ir_node *left);
826 ir_node *get_Shl_right(const ir_node *node);
827 void set_Shl_right(ir_node *node, ir_node *right);
829 ir_node *get_Shr_left(const ir_node *node);
830 void set_Shr_left(ir_node *node, ir_node *left);
831 ir_node *get_Shr_right(const ir_node *node);
832 void set_Shr_right(ir_node *node, ir_node *right);
834 ir_node *get_Shrs_left(const ir_node *node);
835 void set_Shrs_left(ir_node *node, ir_node *left);
836 ir_node *get_Shrs_right(const ir_node *node);
837 void set_Shrs_right(ir_node *node, ir_node *right);
839 ir_node *get_Rotl_left(const ir_node *node);
840 void set_Rotl_left(ir_node *node, ir_node *left);
841 ir_node *get_Rotl_right(const ir_node *node);
842 void set_Rotl_right(ir_node *node, ir_node *right);
844 ir_node *get_Conv_op(const ir_node *node);
845 void set_Conv_op(ir_node *node, ir_node *op);
846 int get_Conv_strict(const ir_node *node);
847 void set_Conv_strict(ir_node *node, int flag);
849 /* Does Cast need a mem operator?
850 * Cast should only depend on the type, not on the state of an
851 * entity. But: we initialize various fields after Alloc, that
852 * are accessed in the cast. This required some precaution, to
853 * get the right memory into the Loads generated from the cast.
855 ir_node *get_Cast_op(const ir_node *node);
856 void set_Cast_op(ir_node *node, ir_node *op);
857 ir_type *get_Cast_type(ir_node *node);
858 void set_Cast_type(ir_node *node, ir_type *to_tp);
860 /** Checks for upcast.
862 * Returns true if the Cast node casts a class type to a super type.
863 * Works also for pointers to classes (recursively).
865 * Needs typeinfo calculated.
867 int is_Cast_upcast(ir_node *node);
869 /** Checks for downcast.
871 * Returns true if the Cast node casts a class type to a sub type.
872 * Works also for pointers to classes (recursively).
874 * Needs typeinfo calculated.
876 int is_Cast_downcast(ir_node *node);
879 /** Returns true if n is a Phi or a Filter node in INTER-procedural view.
880 Returns false if irg is in phase phase_building and the Phi has zero
881 predecessors: it's a Phi0. */
882 int is_Phi(const ir_node *n);
883 /** Returns true if irg in phase phase_building and the Phi has zero
884 predecessors. It's a Phi0 then. */
885 int is_Phi0(const ir_node *n);
886 /* These routines also work for Filter nodes in INTER-procedural view. */
887 ir_node **get_Phi_preds_arr(ir_node *node);
888 int get_Phi_n_preds(const ir_node *node);
889 ir_node *get_Phi_pred(const ir_node *node, int pos);
890 void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
891 ir_node *get_Phi_next(const ir_node *phi);
892 void set_Phi_next(ir_node *phi, ir_node *next);
894 ir_node *get_Filter_pred(ir_node *node);
895 void set_Filter_pred(ir_node *node, ir_node *pred);
896 long get_Filter_proj(ir_node *node);
897 void set_Filter_proj(ir_node *node, long proj);
898 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
899 * @@@ Maybe better: arity is zero if no cg preds. */
900 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
901 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
902 int get_Filter_n_cg_preds(ir_node *node);
903 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
905 /** Return true if parameter is a memory operation.
907 * A memory operation is an operation that changes the
908 * memory. I.e., a Load or a Store operation.
910 int is_memop(const ir_node *node);
911 ir_node *get_memop_mem(const ir_node *node);
912 void set_memop_mem(ir_node *node, ir_node *mem);
913 ir_node *get_memop_ptr(const ir_node *node);
914 void set_memop_ptr(ir_node *node, ir_node *ptr);
917 * Projection numbers for Load: use for Proj nodes!
920 pn_Load_M = pn_Generic_M_regular, /**< Memory result. */
921 pn_Load_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
922 pn_Load_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
923 pn_Load_res = pn_Generic_other, /**< Result of load operation. */
924 pn_Load_max /**< number of projections from a Load */
925 } pn_Load; /* Projection numbers for Load. */
927 ir_node *get_Load_mem(const ir_node *node);
928 void set_Load_mem(ir_node *node, ir_node *mem);
929 ir_node *get_Load_ptr(const ir_node *node);
930 void set_Load_ptr(ir_node *node, ir_node *ptr);
931 ir_mode *get_Load_mode(const ir_node *node);
932 void set_Load_mode(ir_node *node, ir_mode *mode);
933 ir_volatility get_Load_volatility(const ir_node *node);
934 void set_Load_volatility(ir_node *node, ir_volatility volatility);
935 ir_align get_Load_align(const ir_node *node);
936 void set_Load_align(ir_node *node, ir_align align);
939 * Projection numbers for Store: use for Proj nodes!
942 pn_Store_M = pn_Generic_M_regular, /**< Memory result. */
943 pn_Store_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
944 pn_Store_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
945 pn_Store_max = pn_Generic_other /**< number of projections from a Store */
946 } pn_Store; /* Projection numbers for Store. */
948 ir_node *get_Store_mem(const ir_node *node);
949 void set_Store_mem(ir_node *node, ir_node *mem);
950 ir_node *get_Store_ptr(const ir_node *node);
951 void set_Store_ptr(ir_node *node, ir_node *ptr);
952 ir_node *get_Store_value(const ir_node *node);
953 void set_Store_value(ir_node *node, ir_node *value);
954 ir_volatility get_Store_volatility(const ir_node *node);
955 void set_Store_volatility(ir_node *node, ir_volatility volatility);
956 ir_align get_Store_align(const ir_node *node);
957 void set_Store_align(ir_node *node, ir_align align);
960 * Projection numbers for Alloc: use for Proj nodes!
963 pn_Alloc_M = pn_Generic_M_regular, /**< Memory result. */
964 pn_Alloc_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
965 pn_Alloc_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
966 pn_Alloc_res = pn_Generic_other, /**< Result of allocation. */
967 pn_Alloc_max /**< number of projections from an Alloc */
968 } pn_Alloc; /* Projection numbers for Alloc. */
970 ir_node *get_Alloc_mem(const ir_node *node);
971 void set_Alloc_mem(ir_node *node, ir_node *mem);
972 ir_node *get_Alloc_size(const ir_node *node);
973 void set_Alloc_size(ir_node *node, ir_node *size);
974 ir_type *get_Alloc_type(ir_node *node);
975 void set_Alloc_type(ir_node *node, ir_type *tp);
977 ir_where_alloc get_Alloc_where(const ir_node *node);
978 void set_Alloc_where(ir_node *node, ir_where_alloc where);
980 ir_node *get_Free_mem(const ir_node *node);
981 void set_Free_mem(ir_node *node, ir_node *mem);
982 ir_node *get_Free_ptr(const ir_node *node);
983 void set_Free_ptr(ir_node *node, ir_node *ptr);
984 ir_node *get_Free_size(const ir_node *node);
985 void set_Free_size(ir_node *node, ir_node *size);
986 ir_type *get_Free_type(ir_node *node);
987 void set_Free_type(ir_node *node, ir_type *tp);
989 ir_where_alloc get_Free_where(const ir_node *node);
990 void set_Free_where(ir_node *node, ir_where_alloc where);
992 ir_node **get_Sync_preds_arr(ir_node *node);
993 int get_Sync_n_preds(const ir_node *node);
994 ir_node *get_Sync_pred(const ir_node *node, int pos);
995 void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
996 void add_Sync_pred(ir_node *node, ir_node *pred);
998 /** Returns the source language type of a Proj node.
999 * Must be an atomic type. Mode of type must be mode of node.
1001 ir_type *get_Proj_type(ir_node *node);
1003 /** Return the predecessor of a Proj node. */
1004 ir_node *get_Proj_pred(const ir_node *node);
1005 void set_Proj_pred(ir_node *node, ir_node *pred);
1006 /** Return the projection number of a Proj node. */
1007 long get_Proj_proj(const ir_node *node);
1008 void set_Proj_proj(ir_node *node, long proj);
1011 * Returns non-zero if a node is a routine parameter.
1013 * @param node the Proj node to test
1015 int is_arg_Proj(const ir_node *node);
1017 ir_node **get_Tuple_preds_arr(ir_node *node);
1018 int get_Tuple_n_preds(const ir_node *node);
1019 ir_node *get_Tuple_pred(const ir_node *node, int pos);
1020 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
1022 ir_node *get_Id_pred(const ir_node *node);
1023 void set_Id_pred(ir_node *node, ir_node *pred);
1025 /** Confirm has a single result and returns 'value' unchanged.
1026 * The node expresses a restriction on 'value':
1027 * 'value' 'cmp' 'bound' == true. */
1028 ir_node *get_Confirm_value(const ir_node *node);
1029 void set_Confirm_value(ir_node *node, ir_node *value);
1030 ir_node *get_Confirm_bound(const ir_node *node);
1031 void set_Confirm_bound(ir_node *node, ir_node *bound);
1032 pn_Cmp get_Confirm_cmp(const ir_node *node);
1033 void set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
1038 ir_node *get_Mux_sel(const ir_node *node);
1039 void set_Mux_sel(ir_node *node, ir_node *sel);
1040 ir_node *get_Mux_false(const ir_node *node);
1041 void set_Mux_false(ir_node *node, ir_node *ir_false);
1042 ir_node *get_Mux_true(const ir_node *node);
1043 void set_Mux_true(ir_node *node, ir_node *ir_true);
1046 * Projection numbers for result of CopyB node: use for Proj nodes!
1049 pn_CopyB_M_regular = pn_Generic_M_regular, /**< The memory result. */
1050 pn_CopyB_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1051 pn_CopyB_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1052 pn_CopyB_M_except = pn_Generic_other, /**< The memory result in case the runtime function terminated with
1054 pn_CopyB_max /**< number of projections from a CopyB */
1055 } pn_CopyB; /* Projection numbers for CopyB. */
1056 #define pn_CopyB_M pn_CopyB_M_regular
1058 ir_node *get_CopyB_mem(const ir_node *node);
1059 void set_CopyB_mem(ir_node *node, ir_node *mem);
1060 ir_node *get_CopyB_dst(const ir_node *node);
1061 void set_CopyB_dst(ir_node *node, ir_node *dst);
1062 ir_node *get_CopyB_src(const ir_node *node);
1063 void set_CopyB_src(ir_node *node, ir_node *src);
1064 ir_type *get_CopyB_type(ir_node *node);
1065 void set_CopyB_type(ir_node *node, ir_type *data_type);
1068 * Projection numbers for result of InstOf node: use for Proj nodes!
1071 pn_InstOf_M_regular = pn_Generic_M_regular, /**< The memory result. */
1072 pn_InstOf_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1073 pn_InstOf_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1074 pn_InstOf_res = pn_Generic_other, /**< The checked object pointer. */
1075 pn_InstOf_M_except, /**< The memory result in case the runtime function terminated with
1077 pn_InstOf_max /**< number of projections from an InstOf */
1079 #define pn_InstOf_M pn_InstOf_M_regular
1081 /** InstOf access. */
1082 ir_type *get_InstOf_type(ir_node *node);
1083 void set_InstOf_type(ir_node *node, ir_type *type);
1084 ir_node *get_InstOf_store(const ir_node *node);
1085 void set_InstOf_store(ir_node *node, ir_node *obj);
1086 ir_node *get_InstOf_obj(const ir_node *node);
1087 void set_InstOf_obj(ir_node *node, ir_node *obj);
1090 * Projection numbers for Raise.
1093 pn_Raise_M = pn_Generic_M_regular, /**< The Memory result. */
1094 pn_Raise_X = pn_Generic_X_regular, /**< The control flow to the exception handler. */
1095 pn_Raise_max /**< number of projections from a Raise */
1096 } pn_Raise; /* Projection numbers for Raise. */
1098 ir_node *get_Raise_mem(const ir_node *node);
1099 void set_Raise_mem(ir_node *node, ir_node *mem);
1100 ir_node *get_Raise_exo_ptr(const ir_node *node); /* PoinTeR to EXception Object */
1101 void set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
1104 * Projection numbers for result of Bound node: use for Proj nodes!
1107 pn_Bound_M = pn_Generic_M_regular, /**< The memory result. */
1108 pn_Bound_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1109 pn_Bound_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1110 pn_Bound_res = pn_Generic_other, /**< The checked index. */
1111 pn_Bound_max /**< number of projections from a Bound */
1114 /** Returns the memory input of a Bound operation. */
1115 ir_node *get_Bound_mem(const ir_node *bound);
1116 void set_Bound_mem(ir_node *bound, ir_node *mem);
1118 /** Returns the index input of a Bound operation. */
1119 ir_node *get_Bound_index(const ir_node *bound);
1120 void set_Bound_index(ir_node *bound, ir_node *idx);
1122 /** Returns the lower bound input of a Bound operation. */
1123 ir_node *get_Bound_lower(const ir_node *bound);
1124 void set_Bound_lower(ir_node *bound, ir_node *lower);
1126 /** Returns the upper bound input of a Bound operation. */
1127 ir_node *get_Bound_upper(const ir_node *bound);
1128 void set_Bound_upper(ir_node *bound, ir_node *upper);
1130 /** Return the operand of a Pin node. */
1131 ir_node *get_Pin_op(const ir_node *pin);
1132 void set_Pin_op(ir_node *pin, ir_node *node);
1134 /** Return the assembler text of an ASM pseudo node. */
1135 ident *get_ASM_text(const ir_node *node);
1136 /** Return the number of input constraints for an ASM node. */
1137 int get_ASM_n_input_constraints(const ir_node *node);
1138 /** Return the input constraints for an ASM node. */
1139 const ir_asm_constraint *get_ASM_input_constraints(const ir_node *node);
1140 /** Return the number of output constraints for an ASM node. */
1141 int get_ASM_n_output_constraints(const ir_node *node);
1142 /** Return the output constraints for an ASM node. */
1143 const ir_asm_constraint *get_ASM_output_constraints(const ir_node *node);
1144 /** Return the number of clobbered registers for an ASM node. */
1145 int get_ASM_n_clobbers(const ir_node *node);
1146 /** Return the list of clobbered registers for an ASM node. */
1147 ident **get_ASM_clobbers(const ir_node *node);
1151 * NAME Auxiliary routines
1155 /** Returns operand of node if node is a Proj. */
1156 ir_node *skip_Proj(ir_node *node);
1157 /** Returns operand of node if node is a Proj. */
1158 const ir_node *skip_Proj_const(const ir_node *node);
1159 /** Returns operand of node if node is a Id. */
1160 ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
1161 /** Returns corresponding operand of Tuple if node is a Proj from
1163 ir_node *skip_Tuple(ir_node *node);
1164 /** Returns operand of node if node is a Cast. */
1165 ir_node *skip_Cast(ir_node *node);
1166 const ir_node *skip_Cast_const(const ir_node *node);
1167 /** Returns operand of node if node is a Pin. */
1168 ir_node *skip_Pin(ir_node *node);
1169 /** Returns operand of node if node is a Confirm */
1170 ir_node *skip_Confirm(ir_node *node);
1171 /** Skip all high-level Operations (including Cast, Confirm). */
1172 ir_node *skip_HighLevel_ops(ir_node *node);
1173 /** Returns true if irn is a Const node. */
1174 int is_Const(const ir_node *node);
1175 /** Returns true if a node is a Conv node. */
1176 int is_Conv(const ir_node *node);
1177 /** Returns true if a node is a strictConv node. */
1178 int is_strictConv(const ir_node *node);
1179 /** Returns true if a node is a Cast node. */
1180 int is_Cast(const ir_node *node);
1181 /** Returns true if node is a Bad node. */
1182 int is_Bad(const ir_node *node);
1183 /** Returns true if node is a NoMem node. */
1184 int is_NoMem(const ir_node *node);
1185 /** Returns true if node is a Start node. */
1186 int is_Start(const ir_node *node);
1187 /** Returns true if node is a Minus node. */
1188 int is_Minus(const ir_node *node);
1189 /** Returns true if node is a Abs node. */
1190 int is_Abs(const ir_node *node);
1191 /** Returns true if node is a Mod node. */
1192 int is_Mod(const ir_node *node);
1193 /** Returns true if node is a Div node. */
1194 int is_Div(const ir_node *node);
1195 /** Returns true if node is a DivMod node. */
1196 int is_DivMod(const ir_node *node);
1197 /** Returns true if node is a Quot node. */
1198 int is_Quot(const ir_node *node);
1199 /** Returns true if node is an Add node. */
1200 int is_Add(const ir_node *node);
1201 /** Returns true if node is a Carry node. */
1202 int is_Carry(const ir_node *node);
1203 /** Returns true if node is an And node. */
1204 int is_And(const ir_node *node);
1205 /** Returns true if node is an Or node. */
1206 int is_Or(const ir_node *node);
1207 /** Returns true if node is an Eor node. */
1208 int is_Eor(const ir_node *node);
1209 /** Returns true if node is a Sub node. */
1210 int is_Sub(const ir_node *node);
1211 /** Returns true if node is a Not node. */
1212 int is_Not(const ir_node *node);
1213 /** Returns true if node is a Shl node. */
1214 int is_Shl(const ir_node *node);
1215 /** Returns true if node is a Shr node. */
1216 int is_Shr(const ir_node *node);
1217 /** Returns true if node is a Shrs node. */
1218 int is_Shrs(const ir_node *node);
1219 /** Returns true if node is a Rotl node. */
1220 int is_Rotl(const ir_node *node);
1221 /** Returns true if node is an Id node. */
1222 int is_Id(const ir_node *node);
1223 /** Returns true if node is a Tuple node. */
1224 int is_Tuple(const ir_node *node);
1225 /** Returns true if node is a Bound node. */
1226 int is_Bound(const ir_node *node);
1227 /** Returns true if the node is not a Block */
1228 int is_no_Block(const ir_node *node);
1229 /** Returns true if the node is a Block */
1230 int is_Block(const ir_node *node);
1231 /** Returns true if node is an Unknown node. */
1232 int is_Unknown(const ir_node *node);
1233 /** Returns true if node is a Return node. */
1234 int is_Return(const ir_node *node);
1235 /** Returns true if node is a Call node. */
1236 int is_Call(const ir_node *node);
1237 /** Returns true if node is a CallBegin node. */
1238 int is_CallBegin(const ir_node *node);
1239 /** Returns true if node is a Sel node. */
1240 int is_Sel(const ir_node *node);
1241 /** Returns true if node is a Mul node. */
1242 int is_Mul(const ir_node *node);
1243 /** Returns true if node is a Mulh node. */
1244 int is_Mulh(const ir_node *node);
1245 /** Returns true if node is a Mux node. */
1246 int is_Mux(const ir_node *node);
1247 /** Returns true if node is a Load node. */
1248 int is_Load(const ir_node *node);
1249 /** Returns true if node is a Store node. */
1250 int is_Store(const ir_node *node);
1251 /** Returns true if node is a Sync node. */
1252 int is_Sync(const ir_node *node);
1253 /** Returns true if node is a Confirm node. */
1254 int is_Confirm(const ir_node *node);
1255 /** Returns true if node is a Pin node. */
1256 int is_Pin(const ir_node *node);
1257 /** Returns true if node is a SymConst node. */
1258 int is_SymConst(const ir_node *node);
1259 /** Returns true if node is a SymConst node with kind symconst_addr_ent. */
1260 int is_SymConst_addr_ent(const ir_node *node);
1261 /** Returns true if node is a Cond node. */
1262 int is_Cond(const ir_node *node);
1263 /** Returns true of node is a CopyB node. */
1264 int is_CopyB(const ir_node *node);
1265 /** Returns true if node is a Cmp node. */
1266 int is_Cmp(const ir_node *node);
1267 /** Returns true if node is an Alloc node. */
1268 int is_Alloc(const ir_node *node);
1269 /** Returns true if node is a Free node. */
1270 int is_Free(const ir_node *node);
1271 /** Returns true if a node is a Jmp node. */
1272 int is_Jmp(const ir_node *node);
1273 /** Returns true if a node is a IJmp node. */
1274 int is_IJmp(const ir_node *node);
1275 /** Returns true if a node is a Raise node. */
1276 int is_Raise(const ir_node *node);
1277 /** Returns true if a node is an ASM node. */
1278 int is_ASM(const ir_node *node);
1279 /** Returns true if node is a Proj node or a Filter node in INTRA-procedural view. */
1280 int is_Proj(const ir_node *node);
1281 /** Returns true if node is a Filter node. */
1282 int is_Filter(const ir_node *node);
1284 /** Returns true if the operation manipulates control flow:
1285 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1286 int is_cfop(const ir_node *node);
1288 /** Returns true if the operation manipulates interprocedural control flow:
1289 CallBegin, EndReg, EndExcept */
1290 int is_ip_cfop(const ir_node *node);
1291 /** Returns true if the operation can change the control flow because
1292 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1293 Bad. Raise is not fragile, but a unconditional jump. */
1294 int is_fragile_op(const ir_node *node);
1295 /** Returns the memory operand of fragile operations. */
1296 ir_node *get_fragile_op_mem(ir_node *node);
1297 /** Returns the result mode of a Div operation. */
1298 ir_mode *get_divop_resmod(const ir_node *node);
1300 /** Returns true if the operation is a forking control flow
1301 * operation: Cond. */
1302 int is_irn_forking(const ir_node *node);
1304 /** Return the type associated with the value produced by n
1305 * if the node remarks this type as it is the case for
1306 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1307 ir_type *get_irn_type(ir_node *n);
1309 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1311 ir_type *get_irn_type_attr(ir_node *n);
1313 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1314 ir_entity *get_irn_entity_attr(ir_node *n);
1316 /** Returns non-zero for constant-like nodes. */
1317 int is_irn_constlike(const ir_node *node);
1320 * Returns non-zero for nodes that must be always optimized
1321 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1323 int is_irn_always_opt(const ir_node *node);
1326 * Returns non-zero for nodes that are allowed to have keep-alives and
1327 * are neither Block nor PhiM.
1329 int is_irn_keep(const ir_node *node);
1332 * Returns non-zero for nodes that are always placed in the start block.
1334 int is_irn_start_block_placed(const ir_node *node);
1337 * Returns non-zero for nodes that are machine operations.
1339 int is_irn_machine_op(const ir_node *node);
1342 * Returns non-zero for nodes that are machine operands.
1344 int is_irn_machine_operand(const ir_node *node);
1347 * Returns non-zero for nodes that have the n'th user machine flag set.
1349 int is_irn_machine_user(const ir_node *node, unsigned n);
1352 * A type to express conditional jump predictions.
1355 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1356 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1357 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1358 } cond_jmp_predicate;
1360 /** Gets the string representation of the jump prediction .*/
1361 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1363 /** Returns the conditional jump prediction of a Cond node. */
1364 cond_jmp_predicate get_Cond_jmp_pred(const ir_node *cond);
1366 /** Sets a new conditional jump prediction. */
1367 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1369 /** Checks whether a node represents a global address. */
1370 int is_Global(const ir_node *node);
1372 /* Returns the entity of a global address. */
1373 ir_entity *get_Global_entity(const ir_node *node);
1376 * Access custom node data.
1377 * The data must have been registered with
1378 * register_additional_node_data() before.
1379 * @param node The ir node to get the data from.
1380 * @param type The type of the data you registered.
1381 * @param off The value returned by register_additional_node_data().
1382 * @return A pointer of type @p type.
1384 #define get_irn_data(node,type,off) \
1385 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1388 * Get the pointer to the node some custom data belongs to.
1389 * @param data The pointer to the custom data.
1390 * @param off The number as returned by register_additional_node_data().
1391 * @return A pointer to the ir node the custom data belongs to.
1393 #define get_irn_data_base(data,off) \
1394 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1397 * Request additional data to be allocated with an ir node.
1398 * @param size The size of the additional data required.
1399 * @return A positive number, if the operation was successful, which
1400 * must be passed to the access macro get_irn_data(), 0 if the
1401 * registration failed.
1403 unsigned firm_register_additional_node_data(unsigned size);
1406 * Return a pointer to the node attributes.
1407 * Needed for user-defined nodes.
1409 void *get_irn_generic_attr(ir_node *node);
1410 const void *get_irn_generic_attr_const(const ir_node *node);
1413 * Returns the unique node index for the node in its graph.
1414 * This index is used to access phase information for this node.
1416 unsigned get_irn_idx(const ir_node *node);
1419 * Sets the debug information of a node.
1421 * @param n The node.
1422 * @param db The debug info.
1424 void set_irn_dbg_info(ir_node *n, dbg_info *db);
1427 * Returns the debug information of an node.
1429 * @param n The node.
1431 dbg_info *get_irn_dbg_info(const ir_node *n);
1434 * Calculate a hash value of a node. Only inputs, mode and opcode are used.
1436 * @param node the node to hash
1438 unsigned firm_default_hash(const ir_node *node);
1441 * returns a descriptive name of a node (containing type+number)
1443 const char *gdb_node_helper(void *firm_object);
1445 /*@}*/ /* end of ir_node group definition */