2 * Copyright (C) 1995-2007 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"
40 * @author Martin Trapp, Christian Schaefer
42 * Declarations of an ir node.
46 * @defgroup ir_node Declarations of an ir node.
48 * The type definition of ir_node is also in irgraph.h to resolve
49 * recursion between irnode.h and irgraph.h
51 * ir_node - a datatype representing a Firm node
53 * The common fields are:
55 * - firm_kind - A firm_kind tag containing k_type. This is useful
56 * for dynamically checking whether a node is a ir_node.
57 * - arity - The number of predecessors in the Firm graph.
58 * - in - A list with the predecessors in the Firm graph. There are
59 * routines to access individual elements and to obtain the
60 * array. The method returning the array should not be used.
61 * - mode - The mode of the node. There are routines to get the mode
62 * but also to access the mode's fields directly.
63 * - opcode - The opcode of the node. There are routines to get the opcode
64 * but also to access the opcode's fields directly.
65 * - node_nr - A unique number for the node. Available only if debugging
70 #ifndef _IR_NODE_TYPEDEF_
71 #define _IR_NODE_TYPEDEF_
72 typedef struct ir_node ir_node;
80 * you can work on the graph without considering the different types
81 * of nodes, it's just a big graph.
85 * Checks whether a pointer points to a ir node.
87 * @param thing an arbitrary pointer
88 * @return non-zero if the thing is a ir mode, else zero
90 int is_ir_node (const void *thing);
93 * Returns the number of predecessors without the block predecessor.
95 * @param node the IR-node
97 int get_irn_arity (const ir_node *node);
98 int get_irn_intra_arity(const ir_node *node);
99 int get_irn_inter_arity(const ir_node *node);
101 /** Replaces the old in array by a new one that will contain the ins given in
102 the parameters. Conserves the block predecessor. It copies the array passed.
103 This function is necessary to adjust in arrays of blocks, calls and phis.
104 Assumes that current_ir_graph is set to the graph containing "node".
105 "in" must contain all predecessors except the block that are required for
107 void set_irn_in(ir_node *node, int arity, ir_node *in[]);
109 /* to iterate through the predecessors without touching the array. No
110 order of predecessors guaranteed.
111 To iterate over the operands iterate from 0 to i < get_irn_arity(),
112 to iterate including the Block predecessor iterate from i = -1 to
113 i < get_irn_arity. */
114 /* Access predecessor n */
117 * Get the n-th predecessor of a node.
118 * This function removes Id predecessors.
119 * This function automatically handles intra- and interprocedural views.
121 ir_node *get_irn_n(const ir_node *node, int n);
124 * Add a artificial dependency to the node.
125 * The dependency is only inserted if it is not there already.
126 * @param node The node.
127 * @param dep The dependency target.
128 * @return The index in the array (get_irn_dep() with that index returns @p dep).
130 int add_irn_dep(ir_node *node, ir_node *dep);
133 * Copy all dependencies from a node to another.
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 /* Sets the mode struct of node. */
183 void set_irn_mode(ir_node *node, ir_mode *mode);
184 /** Gets the mode struct of a node. */
185 ir_mode *get_irn_mode(const ir_node *node);
186 /** Gets the mode-enum modecode. */
187 modecode get_irn_modecode(const ir_node *node);
188 /** Gets the ident for a string representation of the mode .*/
189 ident *get_irn_modeident(const ir_node *node);
190 /** Gets the string representation of the mode .*/
191 const char *get_irn_modename(const ir_node *node);
192 /** Gets the opcode struct of the node. */
193 ir_op *get_irn_op(const ir_node *node);
194 /** Sets the opcode struct of the node. */
195 void set_irn_op(ir_node *node, ir_op *op);
196 /** Gets the opcode-enum of the node. */
197 ir_opcode get_irn_opcode(const ir_node *node);
198 /** Get the string representation of the opcode. */
199 const char *get_irn_opname(const ir_node *node);
200 /** Get the ident for a string representation of the opcode. */
201 ident *get_irn_opident(const ir_node *node);
202 /** If arg is an argument of the node, returns it's position, -1 otherwise */
203 int get_irn_pred_pos(ir_node *node, ir_node *arg);
204 /** Gets the visited counter of a node. */
205 unsigned long get_irn_visited(const ir_node *node);
206 /** Sets the visited counter of a node. */
207 void set_irn_visited(ir_node *node, unsigned long visited);
208 /** Sets visited to get_irg_visited(current_ir_graph). */
209 void mark_irn_visited(ir_node *node);
210 /** Returns 1 if visited < get_irg_visited(current_ir_graph). */
211 int irn_not_visited(const ir_node *node);
212 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
213 int irn_visited(const ir_node *node);
216 * Sets the link of a node.
217 * Only allowed if the graph is NOT in phase_building.
219 void set_irn_link(ir_node *node, void *link);
221 /** Returns the link of a node. */
222 void *get_irn_link(const ir_node *node);
224 /** Returns the ir_graph this node belongs to. Only valid if irg
225 * is in state op_pin_state_pinned (irg is only stored in the block. */
226 ir_graph *get_irn_irg(const ir_node *node);
228 /** Outputs a unique number for this node if libFIRM is compiled for
229 debugging, (configure with --enable-debug) else returns address
230 of node cast to long. */
231 long get_irn_node_nr(const ir_node *node);
233 /** Returns the pinned state of a node.
235 * Returns whether the node _always_ must be pinned.
236 * I.e., the node is not floating after global cse.
238 * @returns Either state op_pin_state_pinned or op_pin_state_floats.
240 op_pin_state get_irn_pinned(const ir_node *node);
242 /** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
243 void set_irn_pinned(ir_node *node, op_pin_state state);
245 /** Returns whether the node is currently pinned.
247 * If get_irn_pinned returns op_pin_state_floats and the graph the
248 * node belongs to is in state op_poin_state_floats then this function
249 * returns 'floats', else 'pinned'.
251 op_pin_state is_irn_pinned_in_irg(const ir_node *node);
254 * IR node constructor.
255 * Create a new IR node in irg, with an op, mode, arity and
256 * some incoming IR nodes.
257 * This constructor is used in every specific IR node constructor.
259 * @param db Debug info.
260 * @param irg IR-graph on with this new node should be constructed.
261 * @param block The block the new node belongs to
262 * @param op The opcode of the new node.
263 * @param mode The mode of the new node.
264 * @param arity The arity of the new node, <0 if can be changed dynamically.
265 * @param in An array of arity predecessor nodes.
268 new_ir_node(dbg_info *db,
277 * Return the block the node belongs to. This is only
278 * possible for pinned nodes or if the graph is in pinned state.
279 * Otherwise the block may be incorrect. This condition is
280 * now checked by an assertion.
282 * This works for all except Block. It can return Blocks or the Bad node.
284 * To express the difference to access routines that work for all
285 * nodes we use infix "nodes" and do not name this function
286 * get_irn_block(). */
287 ir_node *get_nodes_block (const ir_node *node);
289 /** Sets the Block of a node. */
290 void set_nodes_block (ir_node *node, ir_node *block);
293 * @function get_irn_block()
294 * @see get_nodes_block()
298 * Projection numbers for result of Start node: use for Proj nodes!
301 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
302 pn_Start_M, /**< Projection on the initial memory. */
303 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
304 pn_Start_P_globals, /**< Projection on the pointer to the data segment
305 containing _all_ global entities. Use for
306 position independent data/code access. */
307 pn_Start_P_tls, /**< Projection on the pointer to the thread local store
308 segment containing _all_thread local variables. */
309 pn_Start_T_args, /**< Projection on all arguments. */
310 pn_Start_P_value_arg_base, /**< Pointer to region of compound value arguments as defined by
311 type of this method. */
312 pn_Start_max /**< number of projections from a Start */
313 } pn_Start; /* Projection numbers for Start. */
315 /** Test whether arbitrary node is frame pointer.
317 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
318 * from Start. If so returns frame type, else Null. */
319 ir_type *is_frame_pointer(ir_node *n);
321 /** Test whether arbitrary node is globals pointer.
323 * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
324 * from Start. If so returns global type, else Null. */
325 ir_type *is_globals_pointer(ir_node *n);
327 /** Test whether arbitrary node is tls pointer.
329 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
330 * from Start. If so returns tls type, else Null. */
331 ir_type *is_tls_pointer(ir_node *n);
333 /** Test whether arbitrary node is value arg base.
335 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
336 * from Start. If so returns 1, else 0. */
337 int is_value_arg_pointer(ir_node *n);
340 /* @@@ no more supported */
341 ir_node **get_Block_cfgpred_arr(ir_node *node);
342 int get_Block_n_cfgpreds(const ir_node *node);
343 ir_node *get_Block_cfgpred(ir_node *node, int pos);
344 void set_Block_cfgpred(ir_node *node, int pos, ir_node *pred);
345 /** Get the predecessor block.
347 * Returns the block corresponding to the predecessor pos of block.
349 * There are several ambiguities we resolve with this function:
350 * - The direct predecessor can be a Proj, which is not pinned.
351 * We walk from the predecessor to the next pinned node
352 * (skip_Proj) and return the block that node is in.
353 * - If we encounter the Bad node, this function does not return
354 * Start, but the Bad node.
356 ir_node *get_Block_cfgpred_block(ir_node *node, int pos);
357 int get_Block_matured(ir_node *node);
358 void set_Block_matured(ir_node *node, int matured);
360 /** A visited flag only for block nodes.
361 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
362 unsigned long get_Block_block_visited(const ir_node *node);
363 void set_Block_block_visited(ir_node *node, unsigned long visit);
366 * Marks a block as dead but do not replace it with a Bad node.
367 * Dead blocks are removed in the con
369 ir_node *set_Block_dead(ir_node *block);
370 int is_Block_dead(const ir_node *block);
372 /* For this current_ir_graph must be set. */
373 void mark_Block_block_visited(ir_node *node);
374 int Block_not_block_visited(const ir_node *node);
375 int Block_block_visited(const ir_node *node);
377 /* Set and remove interprocedural predecessors. If the interprocedural
378 * predecessors are removed, the node has the same predecessors in
380 * @@@ Maybe better: arity is zero if no cg preds. */
381 void set_Block_cg_cfgpred_arr(ir_node *node, int arity, ir_node **in);
382 void set_Block_cg_cfgpred(ir_node *node, int pos, ir_node *pred);
383 /* @@@ not supported */
384 ir_node **get_Block_cg_cfgpred_arr(ir_node *node);
385 /** Returns the number of interprocedural predecessors. 0 if none. */
386 int get_Block_cg_n_cfgpreds(ir_node *node);
387 /** Return the interprocedural predecessor at position pos. */
388 ir_node *get_Block_cg_cfgpred(ir_node *node, int pos);
389 /** Frees the memory allocated for interprocedural predecessors. */
390 void remove_Block_cg_cfgpred_arr(ir_node *node);
392 /** Returns the extended basic block a block belongs to. */
393 ir_extblk *get_Block_extbb(const ir_node *block);
394 /** Sets the extended basic block a block belongs to. */
395 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
397 /** Return the number of Keep alive node. */
398 int get_End_n_keepalives(ir_node *end);
400 /** Return the Keep alive node a position pos. */
401 ir_node *get_End_keepalive(ir_node *end, int pos);
403 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
404 void add_End_keepalive (ir_node *end, ir_node *ka);
406 /** Set the Keep alive node at position pos. */
407 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
409 /** Set new keep-alives */
410 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
412 /* Set new keep-alives from old keep-alives, skipping irn */
413 void remove_End_keepalive(ir_node *end, ir_node *irn);
415 /** Some parts of the End node are allocated separately -- their memory
416 is not recovered by dead_node_elimination if a End node is dead.
417 free_End() frees these data structures. */
418 void free_End(ir_node *end);
420 /** Return the target address of an IJmp */
421 ir_node *get_IJmp_target(ir_node *ijmp);
423 /** Sets the target address of an IJmp */
424 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
426 /* We distinguish three kinds of Cond nodes. These can be distinguished
427 by the mode of the selector operand and an internal flag of type cond_kind.
428 First we distinguish binary Conds and switch Conds.
429 A binary Cond has as selector a boolean value. Proj(0) projects the control
430 flow for case "False", Proj(1) the control flow for "True". A binary Cond
431 is recognized by the boolean selector.
432 The switch Cond has as selector an unsigned integer. It produces as result
433 an n+1 Tuple (cf0, ... , cfn) of control flows.
434 We differ two flavors of this Cond. The first, the dense Cond, passes
435 control along output i if the selector value is i, 0 <= i <= n. If the
436 selector value is >n it passes control along output n.
437 The second Cond flavor differences in the treatment of cases not specified in
438 the source program. It magically knows about the existence of Proj nodes.
439 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
440 exists. Else it passes control along output n (even if this Proj does not
441 exist.) This Cond we call "fragmentary". There is a special constructor
442 new_defaultProj that automatically sets the flavor.
443 The two switch flavors are distinguished by a flag of type cond_kind.
444 Default flavor is "dense"
447 dense, /**< Default. Missing Proj nodes are dead control flow. */
448 fragmentary /**< Special. No control flow optimizations allowed. Missing
449 Proj nodes mean default control flow, i.e., Proj(n). */
452 ir_node *get_Cond_selector(ir_node *node);
453 void set_Cond_selector(ir_node *node, ir_node *selector);
454 cond_kind get_Cond_kind(ir_node *node);
455 void set_Cond_kind(ir_node *node, cond_kind kind);
456 long get_Cond_defaultProj(ir_node *node);
459 * Projection numbers for conditions.
462 pn_Cond_false, /**< Control flow if operand is "false". */
463 pn_Cond_true, /**< Control flow if operand is "true". */
464 pn_Cond_max /**< number of projections from a Cond */
465 } pn_Cond; /* Projection numbers for Cond. */
467 ir_node *get_Return_mem(ir_node *node);
468 void set_Return_mem(ir_node *node, ir_node *mem);
469 ir_node **get_Return_res_arr(ir_node *node);
470 int get_Return_n_ress(ir_node *node);
471 ir_node *get_Return_res(ir_node *node, int pos);
472 void set_Return_res(ir_node *node, int pos, ir_node *res);
475 * Possible classes for constant classification.
478 CNST_NULL = 0, /**< The node is a const(0). */
479 CNST_ONE = +1, /**< The node is a const(1). */
480 CNST_ALL_ONE = -1, /**< The node is a const(11111...). */
481 CNST_OTHER = 2, /**< The tarval of the const has another value. */
482 CNST_SYMCONST = 3, /**< The node is symconst. */
483 CNST_NO_CONST = 4 /**< The node is no const at all. */
486 tarval *get_Const_tarval(ir_node *node);
487 void set_Const_tarval(ir_node *node, tarval *con);
490 * Classify a node concerning constant properties.
491 * @param irn A node to check for.
492 * @return Constant properties of that node.
494 cnst_classify_t classify_Const(ir_node *irn);
496 /** Returns the source language type of a Const node.
497 * Must be an atomic type. Mode of type must be mode of node.
499 ir_type *get_Const_type(ir_node *node);
501 /** Sets the source language type of a Const node. */
502 void set_Const_type(ir_node *node, ir_type *tp);
504 /** This enum names the three different kinds of symbolic Constants
505 represented by SymConst. The content of the attribute type_or_id
506 depends on this tag. Use the proper access routine after testing
509 symconst_type_tag, /**< The SymConst is a type tag for the given type.
510 symconst_symbol is type *. */
511 symconst_type_size, /**< The SymConst is the size of the given type.
512 symconst_symbol is type *. */
513 symconst_type_align, /**< The SymConst is the alignment of the given type.
514 symconst_symbol is type *. */
515 symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
516 by the linker. The pointer is represented by a string.
517 symconst_symbol is ident *. */
518 symconst_addr_ent, /**< The SymConst is a symbolic pointer to be filled in
519 by the linker. The pointer is represented by an entity.
520 symconst_symbol is entity *. */
521 symconst_ofs_ent, /**< The SymConst is the offset of its entity in the entities
523 symconst_enum_const /**< The SymConst is a enumeration constant of an
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 /** SymConst attribute.
541 * This union contains the symbolic information represented by the node.
543 typedef union symconst_symbol {
544 ir_type *type_p; /**< the type of a symconst */
545 ident *ident_p; /**< the ident of a symconst */
546 ir_entity *entity_p; /**< the entity of a symconst */
547 ir_enum_const *enum_p; /**< the enumeration constant of a symconst */
550 /** Get the kind of the SymConst. */
551 symconst_kind get_SymConst_kind(const ir_node *node);
552 /** Set the kind of the SymConst. */
553 void set_SymConst_kind(ir_node *node, symconst_kind num);
555 /** Only to access SymConst of kind type_tag or size. Else assertion: */
556 ir_type *get_SymConst_type(ir_node *node);
557 void set_SymConst_type(ir_node *node, ir_type *tp);
559 /** Only to access SymConst of kind addr_name. Else assertion: */
560 ident *get_SymConst_name(const ir_node *node);
561 void set_SymConst_name(ir_node *node, ident *name);
563 /** Only to access SymConst of kind addr_ent. Else assertion: */
564 ir_entity *get_SymConst_entity(const ir_node *node);
565 void set_SymConst_entity(ir_node *node, ir_entity *ent);
567 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
568 ir_enum_const *get_SymConst_enum(const ir_node *node);
569 void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
571 /** Sets both: type and ptrinfo. Needed to treat the node independent of
572 its semantics. Does a memcpy for the memory sym points to. */
573 /* write 'union': firmjni then does not create a method... */
574 union symconst_symbol get_SymConst_symbol(const ir_node *node);
575 void set_SymConst_symbol(ir_node *node,
576 union symconst_symbol sym);
578 /** Access the type of the value represented by the SymConst.
580 * Example: primitive type int for SymConst size. */
581 ir_type *get_SymConst_value_type(ir_node *node);
582 void set_SymConst_value_type(ir_node *node, ir_type *tp);
584 ir_node *get_Sel_mem(ir_node *node);
585 void set_Sel_mem(ir_node *node, ir_node *mem);
586 ir_node *get_Sel_ptr(ir_node *node); /* ptr to the object to select from */
587 void set_Sel_ptr(ir_node *node, ir_node *ptr);
588 ir_node **get_Sel_index_arr(ir_node *node);
589 int get_Sel_n_indexs(ir_node *node);
590 ir_node *get_Sel_index(ir_node *node, int pos);
591 void set_Sel_index(ir_node *node, int pos, ir_node *index);
592 ir_entity *get_Sel_entity(ir_node *node); /* entity to select */
593 void set_Sel_entity (ir_node *node, ir_entity *ent);
596 * Projection numbers for result of Call node: use for Proj nodes!
599 pn_Call_M_regular = 0, /**< The memory result. */
600 pn_Call_X_regular = 1, /**< The control flow result when no exception occurs. */
601 pn_Call_X_except = 2, /**< The control flow result branching to the exception handler. */
602 pn_Call_T_result = 3, /**< The tuple containing all (0, 1, 2, ...) results. */
603 pn_Call_M_except = 4, /**< The memory result in case the called method terminated with
605 pn_Call_P_value_res_base = 5,/**< A pointer to the memory region containing copied results
606 passed by value (for compound result types). */
607 pn_Call_max = 6 /**< number of projections from a Call */
608 } pn_Call; /* Projection numbers for Call. */
609 #define pn_Call_M pn_Call_M_regular
611 ir_node *get_Call_mem(ir_node *node);
612 void set_Call_mem(ir_node *node, ir_node *mem);
613 ir_node *get_Call_ptr(ir_node *node);
614 void set_Call_ptr(ir_node *node, ir_node *ptr);
615 ir_node **get_Call_param_arr(ir_node *node);
616 /** Gets the number of parameters of a call. */
617 int get_Call_n_params(ir_node *node);
618 /** Gets the call parameter at position pos. */
619 ir_node *get_Call_param(ir_node *node, int pos);
620 /** Sets the call parameter at position pos. */
621 void set_Call_param(ir_node *node, int pos, ir_node *param);
622 /** Gets the type of a call. */
623 ir_type *get_Call_type(ir_node *node);
624 /** Sets the type of a call. */
625 void set_Call_type(ir_node *node, ir_type *tp);
626 /** Gets the arity of a call. Identical to get_Call_n_params(). */
627 int get_Call_arity(ir_node *node);
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(ir_node *node);
647 int get_Call_n_callees(ir_node *node);
648 ir_entity *get_Call_callee(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(ir_node *node);
657 void set_CallBegin_ptr(ir_node *node, ir_node *ptr);
658 ir_node *get_CallBegin_call(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, Rot, 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_Sub_left(const ir_node *node);
682 void set_Sub_left(ir_node *node, ir_node *left);
683 ir_node *get_Sub_right(const ir_node *node);
684 void set_Sub_right(ir_node *node, ir_node *right);
686 ir_node *get_Minus_op(const ir_node *node);
687 void set_Minus_op(ir_node *node, ir_node *op);
689 ir_node *get_Mul_left(const ir_node *node);
690 void set_Mul_left(ir_node *node, ir_node *left);
691 ir_node *get_Mul_right(const ir_node *node);
692 void set_Mul_right(ir_node *node, ir_node *right);
694 ir_node *get_Quot_left(const ir_node *node);
695 void set_Quot_left(ir_node *node, ir_node *left);
696 ir_node *get_Quot_right(const ir_node *node);
697 void set_Quot_right(ir_node *node, ir_node *right);
698 ir_node *get_Quot_mem(ir_node *node);
699 void set_Quot_mem(ir_node *node, ir_node *mem);
700 ir_mode *get_Quot_resmode(const ir_node *node);
701 void set_Quot_resmode(ir_node *node, ir_mode *mode);
704 * Projection numbers for Quot: use for Proj nodes!
707 pn_Quot_M, /**< Memory result. */
708 pn_Quot_X_regular, /**< Execution result if no exception occurred. */
709 pn_Quot_X_except, /**< Execution result if exception occurred. */
710 pn_Quot_res, /**< Result of computation. */
711 pn_Quot_max /**< number of projections from a Quot */
712 } pn_Quot; /* Projection numbers for Quot. */
714 ir_node *get_DivMod_left(const ir_node *node);
715 void set_DivMod_left(ir_node *node, ir_node *left);
716 ir_node *get_DivMod_right(const ir_node *node);
717 void set_DivMod_right(ir_node *node, ir_node *right);
718 ir_node *get_DivMod_mem(ir_node *node);
719 void set_DivMod_mem(ir_node *node, ir_node *mem);
720 ir_mode *get_DivMod_resmode(const ir_node *node);
721 void set_DivMod_resmode(ir_node *node, ir_mode *mode);
724 * Projection numbers for DivMod: use for Proj nodes!
727 pn_DivMod_M, /**< Memory result. */
728 pn_DivMod_X_regular, /**< Execution result if no exception occurred. */
729 pn_DivMod_X_except, /**< Execution result if exception occurred. */
730 pn_DivMod_res_div, /**< Result of computation a / b. */
731 pn_DivMod_res_mod, /**< Result of computation a % b. */
732 pn_DivMod_max /**< number of projections from a DivMod */
733 } pn_DivMod; /* Projection numbers for DivMod. */
735 ir_node *get_Div_left(const ir_node *node);
736 void set_Div_left(ir_node *node, ir_node *left);
737 ir_node *get_Div_right(const ir_node *node);
738 void set_Div_right(ir_node *node, ir_node *right);
739 ir_node *get_Div_mem(ir_node *node);
740 void set_Div_mem(ir_node *node, ir_node *mem);
741 ir_mode *get_Div_resmode(const ir_node *node);
742 void set_Div_resmode(ir_node *node, ir_mode *mode);
745 * Projection numbers for Div: use for Proj nodes!
748 pn_Div_M, /**< Memory result. */
749 pn_Div_X_regular, /**< Execution result if no exception occurred. */
750 pn_Div_X_except, /**< Execution result if exception occurred. */
751 pn_Div_res, /**< Result of computation. */
752 pn_Div_max /**< number of projections from a Div */
753 } pn_Div; /* Projection numbers for Div. */
755 ir_node *get_Mod_left(const ir_node *node);
756 void set_Mod_left(ir_node *node, ir_node *left);
757 ir_node *get_Mod_right(const ir_node *node);
758 void set_Mod_right(ir_node *node, ir_node *right);
759 ir_node *get_Mod_mem(ir_node *node);
760 void set_Mod_mem(ir_node *node, ir_node *mem);
761 ir_mode *get_Mod_resmode(const ir_node *node);
762 void set_Mod_resmode(ir_node *node, ir_mode *mode);
765 * Projection numbers for Mod: use for Proj nodes!
768 pn_Mod_M, /**< Memory result. */
769 pn_Mod_X_regular, /**< Execution result if no exception occurred. */
770 pn_Mod_X_except, /**< Execution result if exception occurred. */
771 pn_Mod_res, /**< Result of computation. */
772 pn_Mod_max /**< number of projections from a Mod */
773 } pn_Mod; /* Projection numbers for Mod. */
775 ir_node *get_Abs_op(const ir_node *node);
776 void set_Abs_op(ir_node *node, ir_node *op);
778 ir_node *get_And_left(const ir_node *node);
779 void set_And_left(ir_node *node, ir_node *left);
780 ir_node *get_And_right(const ir_node *node);
781 void set_And_right(ir_node *node, ir_node *right);
783 ir_node *get_Or_left(const ir_node *node);
784 void set_Or_left(ir_node *node, ir_node *left);
785 ir_node *get_Or_right(const ir_node *node);
786 void set_Or_right(ir_node *node, ir_node *right);
788 ir_node *get_Eor_left(const ir_node *node);
789 void set_Eor_left(ir_node *node, ir_node *left);
790 ir_node *get_Eor_right(const ir_node *node);
791 void set_Eor_right(ir_node *node, ir_node *right);
793 ir_node *get_Not_op(const ir_node *node);
794 void set_Not_op(ir_node *node, ir_node *op);
797 * Projection numbers for Cmp are defined several times.
798 * The bit patterns are used for various tests, so don't change.
799 * The "unordered" values are possible results of comparing
800 * floating point numbers.
801 * Note that the encoding is imported, so do NOT change the order.
804 pn_Cmp_False = 0, /**< false */
805 pn_Cmp_Eq = 1, /**< equal */
806 pn_Cmp_Lt = 2, /**< less */
807 pn_Cmp_Le = pn_Cmp_Eq|pn_Cmp_Lt, /**< less or equal */
808 pn_Cmp_Gt = 4, /**< greater */
809 pn_Cmp_Ge = pn_Cmp_Eq|pn_Cmp_Gt, /**< greater or equal */
810 pn_Cmp_Lg = pn_Cmp_Lt|pn_Cmp_Gt, /**< less or greater */
811 pn_Cmp_Leg = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
812 pn_Cmp_Uo = 8, /**< unordered */
813 pn_Cmp_Ue = pn_Cmp_Uo|pn_Cmp_Eq, /**< unordered or equal */
814 pn_Cmp_Ul = pn_Cmp_Uo|pn_Cmp_Lt, /**< unordered or less */
815 pn_Cmp_Ule = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
816 pn_Cmp_Ug = pn_Cmp_Uo|pn_Cmp_Gt, /**< unordered or greater */
817 pn_Cmp_Uge = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
818 pn_Cmp_Ne = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
819 pn_Cmp_True = 15 /**< true */
820 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for JNI interface */
821 } pn_Cmp; /* Projection numbers for Cmp */
822 /* #define not_mask pn_Cmp_Leg */
824 /** returns the pnc name from an pnc constant */
825 const char *get_pnc_string(int pnc);
827 /** Calculates the negated (Complement(R)) pnc condition. */
828 int get_negated_pnc(int pnc, ir_mode *mode);
830 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
831 int get_inversed_pnc(int pnc);
833 ir_node *get_Cmp_left(const ir_node *node);
834 void set_Cmp_left(ir_node *node, ir_node *left);
835 ir_node *get_Cmp_right(const ir_node *node);
836 void set_Cmp_right(ir_node *node, ir_node *right);
838 ir_node *get_Shl_left(const ir_node *node);
839 void set_Shl_left(ir_node *node, ir_node *left);
840 ir_node *get_Shl_right(const ir_node *node);
841 void set_Shl_right(ir_node *node, ir_node *right);
843 ir_node *get_Shr_left(const ir_node *node);
844 void set_Shr_left(ir_node *node, ir_node *left);
845 ir_node *get_Shr_right(const ir_node *node);
846 void set_Shr_right(ir_node *node, ir_node *right);
848 ir_node *get_Shrs_left(const ir_node *node);
849 void set_Shrs_left(ir_node *node, ir_node *left);
850 ir_node *get_Shrs_right(const ir_node *node);
851 void set_Shrs_right(ir_node *node, ir_node *right);
853 ir_node *get_Rot_left(const ir_node *node);
854 void set_Rot_left(ir_node *node, ir_node *left);
855 ir_node *get_Rot_right(const ir_node *node);
856 void set_Rot_right(ir_node *node, ir_node *right);
858 ir_node *get_Conv_op(const ir_node *node);
859 void set_Conv_op(ir_node *node, ir_node *op);
860 int get_Conv_strict(ir_node *node);
861 void set_Conv_strict(ir_node *node, int flag);
863 /* Does Cast need a mem operator?
864 * Cast should only depend on the type, not on the state of an
865 * entity. But: we initialize various fields after Alloc, that
866 * are accessed in the cast. This required some precaution, to
867 * get the right memory into the Loads generated from the cast.
869 ir_node *get_Cast_op(const ir_node *node);
870 void set_Cast_op(ir_node *node, ir_node *op);
871 ir_type *get_Cast_type(ir_node *node);
872 void set_Cast_type(ir_node *node, ir_type *to_tp);
874 /** Checks for upcast.
876 * Returns true if the Cast node casts a class type to a super type.
877 * Works also for pointers to classes (recursively).
879 * Needs typeinfo calculated.
881 int is_Cast_upcast(ir_node *node);
883 /** Checks for downcast.
885 * Returns true if the Cast node casts a class type to a sub type.
886 * Works also for pointers to classes (recursively).
888 * Needs typeinfo calculated.
890 int is_Cast_downcast(ir_node *node);
893 /** Returns true if n is Phi or Filter in interprocedural_view.
894 Returns false if irg in phase building and the Phi has zero
895 predecessors: it's a Phi0. */
896 int is_Phi(const ir_node *n);
897 /** Returns true if irg in phase building and the Phi has zero
898 predecessors: it's a Phi0. */
899 int is_Phi0(const ir_node *n);
900 /* These routines also work for Filter nodes in interprocedural view. */
901 ir_node **get_Phi_preds_arr(ir_node *node);
902 int get_Phi_n_preds(ir_node *node);
903 ir_node *get_Phi_pred(ir_node *node, int pos);
904 void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
906 ir_node *get_Filter_pred(ir_node *node);
907 void set_Filter_pred(ir_node *node, ir_node *pred);
908 long get_Filter_proj(ir_node *node);
909 void set_Filter_proj(ir_node *node, long proj);
910 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
911 * @@@ Maybe better: arity is zero if no cg preds. */
912 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
913 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
914 int get_Filter_n_cg_preds(ir_node *node);
915 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
917 /** Return true if parameter is a memory operation.
919 * A memory operation is an operation that changes the
920 * memory. I.e., a Load or a Store operation.
922 int is_memop(ir_node *node);
923 ir_node *get_memop_mem(ir_node *node);
924 void set_memop_mem(ir_node *node, ir_node *mem);
925 ir_node *get_memop_ptr(ir_node *node);
926 void set_memop_ptr(ir_node *node, ir_node *ptr);
929 * Projection numbers for Load: use for Proj nodes!
932 pn_Load_M, /**< Memory result. */
933 pn_Load_X_regular, /**< Execution result if no exception occurred. */
934 pn_Load_X_except, /**< Execution result if exception occurred. */
935 pn_Load_res, /**< Result of load operation. */
936 pn_Load_max /**< number of projections from a Load */
937 } pn_Load; /* Projection numbers for Load. */
939 ir_node *get_Load_mem(ir_node *node);
940 void set_Load_mem(ir_node *node, ir_node *mem);
941 ir_node *get_Load_ptr(ir_node *node);
942 void set_Load_ptr(ir_node *node, ir_node *ptr);
943 ir_mode *get_Load_mode(ir_node *node);
944 void set_Load_mode(ir_node *node, ir_mode *mode);
945 ir_volatility get_Load_volatility(ir_node *node);
946 void set_Load_volatility(ir_node *node, ir_volatility volatility);
949 * Projection numbers for Store: use for Proj nodes!
952 pn_Store_M, /**< Memory result. */
953 pn_Store_X_regular, /**< Execution result if no exception occurred. */
954 pn_Store_X_except, /**< Execution result if exception occurred. */
955 pn_Store_max /**< number of projections from a Store */
956 } pn_Store; /* Projection numbers for Store. */
958 ir_node *get_Store_mem(ir_node *node);
959 void set_Store_mem(ir_node *node, ir_node *mem);
960 ir_node *get_Store_ptr(ir_node *node);
961 void set_Store_ptr(ir_node *node, ir_node *ptr);
962 ir_node *get_Store_value(ir_node *node);
963 void set_Store_value(ir_node *node, ir_node *value);
964 ir_volatility get_Store_volatility(ir_node *node);
965 void set_Store_volatility(ir_node *node, ir_volatility volatility);
968 * Projection numbers for Alloc: use for Proj nodes!
971 pn_Alloc_M, /**< Memory result. */
972 pn_Alloc_X_regular, /**< Execution result if no exception occurred. */
973 pn_Alloc_X_except, /**< Execution result if exception occurred. */
974 pn_Alloc_res, /**< Result of allocation. */
975 pn_Alloc_max /**< number of projections from an Alloc */
976 } pn_Alloc; /* Projection numbers for Alloc. */
978 ir_node *get_Alloc_mem(ir_node *node);
979 void set_Alloc_mem(ir_node *node, ir_node *mem);
980 ir_node *get_Alloc_size(ir_node *node);
981 void set_Alloc_size(ir_node *node, ir_node *size);
982 ir_type *get_Alloc_type(ir_node *node);
983 void set_Alloc_type(ir_node *node, ir_type *tp);
985 /** The allocation place. */
987 stack_alloc, /**< Alloc allocates the object on the stack. */
988 heap_alloc /**< Alloc allocates the object on the heap. */
991 where_alloc get_Alloc_where(ir_node *node);
992 void set_Alloc_where(ir_node *node, where_alloc where);
994 ir_node *get_Free_mem(ir_node *node);
995 void set_Free_mem(ir_node *node, ir_node *mem);
996 ir_node *get_Free_ptr(ir_node *node);
997 void set_Free_ptr(ir_node *node, ir_node *ptr);
998 ir_node *get_Free_size(ir_node *node);
999 void set_Free_size(ir_node *node, ir_node *size);
1000 ir_type *get_Free_type(ir_node *node);
1001 void set_Free_type(ir_node *node, ir_type *tp);
1003 where_alloc get_Free_where(ir_node *node);
1004 void set_Free_where(ir_node *node, where_alloc where);
1006 ir_node **get_Sync_preds_arr(ir_node *node);
1007 int get_Sync_n_preds(ir_node *node);
1008 ir_node *get_Sync_pred(ir_node *node, int pos);
1009 void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
1010 void add_Sync_pred(ir_node *node, ir_node *pred);
1012 /** Returns the source language type of a Proj node.
1013 * Must be an atomic type. Mode of type must be mode of node.
1015 ir_type *get_Proj_type(ir_node *node);
1017 /** Return the predecessor of a Proj node. */
1018 ir_node *get_Proj_pred(const ir_node *node);
1019 void set_Proj_pred(ir_node *node, ir_node *pred);
1020 /** Return the projection number of a Proj node. */
1021 long get_Proj_proj(const ir_node *node);
1022 void set_Proj_proj(ir_node *node, long proj);
1023 long get_VProj_proj(const ir_node *node);
1024 void set_VProj_proj(ir_node *node, long value);
1027 ir_node **get_Tuple_preds_arr(ir_node *node);
1028 int get_Tuple_n_preds(ir_node *node);
1029 ir_node *get_Tuple_pred(ir_node *node, int pos);
1030 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
1032 ir_node *get_Id_pred(ir_node *node);
1033 void set_Id_pred(ir_node *node, ir_node *pred);
1035 /** Confirm has a single result and returns 'value' unchanged.
1036 * The node expresses a restriction on 'value':
1037 * 'value' 'cmp' 'bound' == true. */
1038 ir_node *get_Confirm_value(ir_node *node);
1039 void set_Confirm_value(ir_node *node, ir_node *value);
1040 ir_node *get_Confirm_bound(ir_node *node);
1041 void set_Confirm_bound(ir_node *node, ir_node *bound);
1042 pn_Cmp get_Confirm_cmp(ir_node *node);
1043 void set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
1046 * Mux Support: Note that Psi nodes with one condition can be handled
1047 * like Mux nodes, and the access functions work as expected.
1049 ir_node *get_Mux_sel(ir_node *node);
1050 void set_Mux_sel(ir_node *node, ir_node *sel);
1051 ir_node *get_Mux_false(ir_node *node);
1052 void set_Mux_false(ir_node *node, ir_node *ir_false);
1053 ir_node *get_Mux_true (ir_node *node);
1054 void set_Mux_true (ir_node *node, ir_node *ir_true);
1056 ir_node *get_Psi_cond(ir_node *node, int pos);
1057 void set_Psi_cond(ir_node *node, int pos, ir_node *cond);
1058 ir_node *get_Psi_val(ir_node *node, int pos);
1059 void set_Psi_val(ir_node *node, int pos, ir_node *val);
1060 ir_node *get_Psi_default(ir_node *node);
1061 void set_Psi_default(ir_node *node, ir_node *val);
1062 int get_Psi_n_conds(ir_node *node);
1065 * Projection numbers for result of CopyB node: use for Proj nodes!
1068 pn_CopyB_M_regular = 0, /**< The memory result. */
1069 pn_CopyB_X_regular = 1, /**< Execution result if no exception occurred. */
1070 pn_CopyB_X_except = 2, /**< The control flow result branching to the exception handler */
1071 pn_CopyB_M_except = 3, /**< The memory result in case the runtime function terminated with
1073 pn_CopyB_max = 4 /**< number of projections from a CopyB */
1074 } pn_CopyB; /* Projection numbers for CopyB. */
1075 #define pn_CopyB_M pn_CopyB_M_regular
1077 ir_node *get_CopyB_mem(ir_node *node);
1078 void set_CopyB_mem(ir_node *node, ir_node *mem);
1079 ir_node *get_CopyB_dst(ir_node *node);
1080 void set_CopyB_dst(ir_node *node, ir_node *dst);
1081 ir_node *get_CopyB_src(ir_node *node);
1082 void set_CopyB_src(ir_node *node, ir_node *src);
1083 ir_type *get_CopyB_type(ir_node *node);
1084 void set_CopyB_type(ir_node *node, ir_type *data_type);
1087 * Projection numbers for result of InstOf node: use for Proj nodes!
1090 pn_InstOf_M_regular = 0, /**< The memory result. */
1091 pn_InstOf_X_regular = 1, /**< Execution result if no exception occurred. */
1092 pn_InstOf_X_except = 2, /**< The control flow result branching to the exception handler */
1093 pn_InstOf_res = 3, /**< The checked object pointer. */
1094 pn_InstOf_M_except = 4, /**< The memory result in case the runtime function terminated with
1096 pn_InstOf_max = 5 /**< number of projections from an InstOf */
1098 #define pn_InstOf_M pn_InstOf_M_regular
1100 /** InstOf access */
1101 ir_type *get_InstOf_type(ir_node *node);
1102 void set_InstOf_type(ir_node *node, ir_type *type);
1103 ir_node *get_InstOf_store(ir_node *node);
1104 void set_InstOf_store(ir_node *node, ir_node *obj);
1105 ir_node *get_InstOf_obj(ir_node *node);
1106 void set_InstOf_obj(ir_node *node, ir_node *obj);
1109 * Projection numbers for Raise.
1112 pn_Raise_X = 0, /**< The control flow to the exception handler. */
1113 pn_Raise_M = 1, /**< The Memory result. */
1114 pn_Raise_max /**< number of projections from a Raise */
1115 } pn_Raise; /* Projection numbers for Raise. */
1117 ir_node *get_Raise_mem(ir_node *node);
1118 void set_Raise_mem(ir_node *node, ir_node *mem);
1119 ir_node *get_Raise_exo_ptr(ir_node *node); /* PoinTeR to EXception Object */
1120 void set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
1123 * Projection numbers for result of Bound node: use for Proj nodes!
1126 pn_Bound_M = 0, /**< The memory result. */
1127 pn_Bound_X_regular = 1, /**< Execution result if no exception occurred. */
1128 pn_Bound_X_except = 2, /**< The control flow result branching to the exception handler */
1129 pn_Bound_res = 3, /**< The checked index. */
1130 pn_Bound_max = 4 /**< number of projections from a Bound */
1133 /** Returns the memory input of a Bound operation. */
1134 ir_node *get_Bound_mem(ir_node *bound);
1135 void set_Bound_mem(ir_node *bound, ir_node *mem);
1137 /** Returns the index input of a Bound operation. */
1138 ir_node *get_Bound_index(ir_node *bound);
1139 void set_Bound_index(ir_node *bound, ir_node *idx);
1141 /** Returns the lower bound input of a Bound operation. */
1142 ir_node *get_Bound_lower(ir_node *bound);
1143 void set_Bound_lower(ir_node *bound, ir_node *lower);
1145 /** Returns the upper bound input of a Bound operation. */
1146 ir_node *get_Bound_upper(ir_node *bound);
1147 void set_Bound_upper(ir_node *bound, ir_node *upper);
1149 /** Return the operand of a Pin node. */
1150 ir_node *get_Pin_op(const ir_node *pin);
1151 void set_Pin_op(ir_node *pin, ir_node *node);
1156 * NAME Auxiliary routines
1158 * Not properly documented ;-)
1162 /** returns operand of node if node is a Proj. */
1163 ir_node *skip_Proj(ir_node *node);
1164 /** returns operand of node if node is a Proj. */
1165 const ir_node *skip_Proj_const(const ir_node *node);
1166 /** returns operand of node if node is a Id */
1167 ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
1168 /** returns corresponding operand of Tuple if node is a Proj from
1170 ir_node *skip_Tuple(ir_node *node);
1171 /** returns operand of node if node is a Cast */
1172 ir_node *skip_Cast(ir_node *node);
1173 /** returns operand of node if node is a Confirm */
1174 ir_node *skip_Confirm(ir_node *node);
1175 /** Skip all high-level Operations. */
1176 ir_node *skip_HighLevel(ir_node *node);
1177 /** returns true if irn is a Const node. */
1178 int is_Const(const ir_node *node);
1179 /** returns true if a node is a Conv node */
1180 int is_Conv(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 /** return true if node is a Mod node. */
1188 int is_Mod(const ir_node *node);
1189 /** return true if node is a Div node. */
1190 int is_Div(const ir_node *node);
1191 /** return true if node is a DivMod node. */
1192 int is_DivMod(const ir_node *node);
1193 /** return true if node is a Quot node. */
1194 int is_Quot(const ir_node *node);
1195 /** return true if node is an Add node. */
1196 int is_Add(const ir_node *node);
1197 /** return true if node is a Sub node. */
1198 int is_Sub(const ir_node *node);
1199 /** returns true if the node is not a Block */
1200 int is_no_Block(const ir_node *node);
1201 /** returns true if the node is a Block */
1202 int is_Block(const ir_node *node);
1203 /** returns true if node is an Unknown node. */
1204 int is_Unknown(const ir_node *node);
1205 /** returns true if node is a Return node. */
1206 int is_Return(const ir_node *node);
1207 /** returns true if node is a Call node. */
1208 int is_Call(const ir_node *node);
1209 /** returns true if node is a Sel node. */
1210 int is_Sel(const ir_node *node);
1211 /** returns true if node is a Mul node. */
1212 int is_Mul(const ir_node *node);
1213 /** returns true if node is a Mux node or a Psi with only one condition. */
1214 int is_Mux(const ir_node *node);
1215 /** returns true if node is a Load node. */
1216 int is_Load(const ir_node *node);
1217 /** returns true if node is a Store node. */
1218 int is_Store(const ir_node *node);
1219 /** returns true if node is a Sync node. */
1220 int is_Sync(const ir_node *node);
1221 /** returns true if node is a Confirm node. */
1222 int is_Confirm(const ir_node *node);
1223 /** returns true if node is a Pin node. */
1224 int is_Pin(const ir_node *node);
1225 /** returns true if node is a SymConst node. */
1226 int is_SymConst(const ir_node *node);
1227 /** returns true if node is a Cond node. */
1228 int is_Cond(const ir_node *node);
1229 /** returns true of node is a CopyB node */
1230 int is_CopyB(const ir_node *node);
1231 /** returns true if node is a Cmp node. */
1232 int is_Cmp(const ir_node *node);
1233 /** returns true if node is an Alloc node */
1234 int is_Alloc(const ir_node *node);
1235 /** returns true if a node is a Jmp node */
1236 int is_Jmp(const ir_node *node);
1237 /** returns true if a node is a Raise node */
1238 int is_Raise(const ir_node *node);
1239 /** returns true if node is a Proj node or a Filter node in
1240 * intraprocedural view */
1241 int is_Proj(const ir_node *node);
1242 /** Returns true if the operation manipulates control flow:
1243 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1244 int is_cfop(const ir_node *node);
1246 /** Returns true if the operation manipulates interprocedural control flow:
1247 CallBegin, EndReg, EndExcept */
1248 int is_ip_cfop(const ir_node *node);
1249 /** Returns true if the operation can change the control flow because
1250 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1251 Bad. Raise is not fragile, but a unconditional jump. */
1252 int is_fragile_op(const ir_node *node);
1253 /** Returns the memory operand of fragile operations. */
1254 ir_node *get_fragile_op_mem(ir_node *node);
1256 /** Returns true if the operation is a forking control flow
1257 * operation: Cond. */
1258 int is_irn_forking(const ir_node *node);
1260 /** Return the type associated with the value produced by n
1261 * if the node remarks this type as it is the case for
1262 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1263 ir_type *get_irn_type(ir_node *n);
1265 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1267 ir_type *get_irn_type_attr(ir_node *n);
1269 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1270 ir_entity *get_irn_entity_attr(ir_node *n);
1272 /** Returns non-zero for constant-like nodes. */
1273 int is_irn_constlike(const ir_node *node);
1276 * Returns non-zero for nodes that must be always optimized
1277 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1279 int is_irn_always_opt(const ir_node *node);
1282 * Returns non-zero for nodes that are allowed to have keep-alives and
1283 * are neither Block nor PhiM.
1285 int is_irn_keep(const ir_node *node);
1288 * Returns non-zero for nodes that are always placed in the start block.
1290 int is_irn_start_block_placed(const ir_node *node);
1293 * Returns non-zero for nodes that are machine operations.
1295 int is_irn_machine_op(const ir_node *node);
1298 * Returns non-zero for nodes that are machine operands.
1300 int is_irn_machine_operand(const ir_node *node);
1303 * Returns non-zero for nodes that have the n'th user machine flag set.
1305 int is_irn_machine_user(const ir_node *node, unsigned n);
1308 * A type to express conditional jump predictions.
1311 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1312 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1313 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1314 } cond_jmp_predicate;
1316 /** Gets the string representation of the jump prediction .*/
1317 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1319 /** Returns the conditional jump prediction of a Cond node. */
1320 cond_jmp_predicate get_Cond_jmp_pred(ir_node *cond);
1322 /** Sets a new conditional jump prediction. */
1323 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1326 * Access custom node data.
1327 * The data must have been registered with
1328 * register_additional_node_data() before.
1329 * @param node The ir node to get the data from.
1330 * @param type The type of the data you registered.
1331 * @param off The value returned by register_additional_node_data().
1332 * @return A pointer of type @p type.
1334 #define get_irn_data(node,type,off) \
1335 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1338 * Get the pointer to the node some custom data belongs to.
1339 * @param data The pointer to the custom data.
1340 * @param off The number as returned by register_additional_node_data().
1341 * @return A pointer to the ir node the custom data belongs to.
1343 #define get_irn_data_base(data,off) \
1344 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1347 * Request additional data to be allocated with an ir node.
1348 * @param size The size of the additional data required.
1349 * @return A positive number, if the operation was successful, which
1350 * must be passed to the access macro get_irn_data(), 0 if the
1351 * registration failed.
1353 unsigned register_additional_node_data(unsigned size);
1356 * Return a pointer to the node attributes.
1357 * Needed for user-defined nodes.
1359 void *get_irn_generic_attr(ir_node *node);
1360 const void *get_irn_generic_attr_const(const ir_node *node);
1363 * Returns the unique node index for the node in its graph.
1364 * This index is used to access phase information for this node.
1366 unsigned get_irn_idx(const ir_node *node);
1368 /*-----------------------------------------------------------------*/
1370 /*-----------------------------------------------------------------*/
1373 /** Debug print the node.
1375 * Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
1376 * is set. Else does nothing. */
1377 void dump_irn(ir_node *n);
1383 /* GNU C has the __FUNCTION__ extension */
1384 #define __MYFUNC__ __FUNCTION__
1386 /* use Filename instead */
1387 #define __MYFUNC__ __FILE__
1391 Don't format with "\", firmjni gets problems */
1392 /** Output location */
1393 #define DDM printf("%s(l.%i).\n", __MYFUNC__, __LINE__);
1394 /** Output the firm kind of the node */
1395 #define DDMK(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, print_firm_kind(X), (void *)(X));
1396 /** Output information about a node */
1398 /*#define DDMN(X) printf("%s(l.%i) %s%s: %ld (%p)\n", __MYFUNC__, __LINE__, get_irn_opname(X), get_mode_name(get_irn_mode(X)), get_irn_node_nr(X), (void *)(X))*/
1399 int dump_node_opcode(FILE *F, ir_node *n);
1400 #define DDMN(X) do { printf("%s(l.%i) ", __MYFUNC__, __LINE__); dump_node_opcode(stdout, X); printf(": %ld (%p)\n", get_irn_node_nr(X), (void *)(X)); } while (0)
1402 /** Output information about a node and its block */
1403 #define DDMNB(X) printf("%s%s: %ld (in block %ld)\n", get_irn_opname(X), get_mode_name(get_irn_mode(X)), get_irn_node_nr(X), get_irn_node_nr(get_nodes_block(X)))
1404 /** Output information about a type */
1405 #define DDMT(X) printf("%s(l.%i) %s %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_type_tpop_name(X), get_type_name(X), get_type_nr(X), (void *)(X))
1406 /** Output information about an entity */
1407 #define DDME(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
1408 /** Output information about an entity and its type */
1409 #define DDMET(X) printf("%s(l.%i) %s (typ: %s): %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_type_name(get_entity_type(X)), get_entity_nr(X), (void *)(X))
1410 /** Output information about an entity and its owner */
1411 #define DDMEO(X) printf("%s(l.%i) %s (own: %s): %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_type_name(get_entity_owner(X)), get_entity_nr(X), (void *)(X))
1412 /** Output information about a graph */
1413 #define DDMG(X) printf("%s(l.%i) graph %s: %ld (%p) in %s %s.\n", __MYFUNC__, __LINE__, get_entity_name(get_irg_entity(X)), get_irg_graph_nr(X), (void *)(X), get_type_tpop_name(get_entity_owner(get_irg_entity(X))), get_type_name(get_entity_owner(get_irg_entity(X))))
1414 /** Output information about an ident */
1415 #define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_id_str(X), (void *)(X))
1416 /** Output information about a mode */
1417 #define DDMM(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
1418 /** Output information about a loop */
1419 #define DDML(X) printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
1420 /** Output information about a tarVal */
1421 #define DDMV(X) printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
1423 /*@}*/ /* end of ir_node group definition */