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 /** Get the Macro Block header of a (sub-) block. */
398 ir_node *get_Block_MacroBlock(const ir_node *block);
400 /** Return the number of Keep alive node. */
401 int get_End_n_keepalives(ir_node *end);
403 /** Return the Keep alive node a position pos. */
404 ir_node *get_End_keepalive(ir_node *end, int pos);
406 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
407 void add_End_keepalive (ir_node *end, ir_node *ka);
409 /** Set the Keep alive node at position pos. */
410 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
412 /** Set new keep-alives */
413 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
415 /* Set new keep-alives from old keep-alives, skipping irn */
416 void remove_End_keepalive(ir_node *end, ir_node *irn);
418 /** Some parts of the End node are allocated separately -- their memory
419 is not recovered by dead_node_elimination if a End node is dead.
420 free_End() frees these data structures. */
421 void free_End(ir_node *end);
423 /** Return the target address of an IJmp */
424 ir_node *get_IJmp_target(ir_node *ijmp);
426 /** Sets the target address of an IJmp */
427 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
429 /* We distinguish three kinds of Cond nodes. These can be distinguished
430 by the mode of the selector operand and an internal flag of type cond_kind.
431 First we distinguish binary Conds and switch Conds.
432 A binary Cond has as selector a boolean value. Proj(0) projects the control
433 flow for case "False", Proj(1) the control flow for "True". A binary Cond
434 is recognized by the boolean selector.
435 The switch Cond has as selector an unsigned integer. It produces as result
436 an n+1 Tuple (cf0, ... , cfn) of control flows.
437 We differ two flavors of this Cond. The first, the dense Cond, passes
438 control along output i if the selector value is i, 0 <= i <= n. If the
439 selector value is >n it passes control along output n.
440 The second Cond flavor differences in the treatment of cases not specified in
441 the source program. It magically knows about the existence of Proj nodes.
442 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
443 exists. Else it passes control along output n (even if this Proj does not
444 exist.) This Cond we call "fragmentary". There is a special constructor
445 new_defaultProj that automatically sets the flavor.
446 The two switch flavors are distinguished by a flag of type cond_kind.
447 Default flavor is "dense"
450 dense, /**< Default. Missing Proj nodes are dead control flow. */
451 fragmentary /**< Special. No control flow optimizations allowed. Missing
452 Proj nodes mean default control flow, i.e., Proj(n). */
455 ir_node *get_Cond_selector(ir_node *node);
456 void set_Cond_selector(ir_node *node, ir_node *selector);
457 cond_kind get_Cond_kind(ir_node *node);
458 void set_Cond_kind(ir_node *node, cond_kind kind);
459 long get_Cond_defaultProj(ir_node *node);
462 * Projection numbers for conditions.
465 pn_Cond_false, /**< Control flow if operand is "false". */
466 pn_Cond_true, /**< Control flow if operand is "true". */
467 pn_Cond_max /**< number of projections from a Cond */
468 } pn_Cond; /* Projection numbers for Cond. */
470 ir_node *get_Return_mem(ir_node *node);
471 void set_Return_mem(ir_node *node, ir_node *mem);
472 ir_node **get_Return_res_arr(ir_node *node);
473 int get_Return_n_ress(ir_node *node);
474 ir_node *get_Return_res(ir_node *node, int pos);
475 void set_Return_res(ir_node *node, int pos, ir_node *res);
478 * Possible classes for constant classification.
481 CNST_NULL = 0, /**< The node is a const(0). */
482 CNST_ONE = +1, /**< The node is a const(1). */
483 CNST_ALL_ONE = -1, /**< The node is a const(11111...). */
484 CNST_OTHER = 2, /**< The tarval of the const has another value. */
485 CNST_SYMCONST = 3, /**< The node is symconst. */
486 CNST_NO_CONST = 4 /**< The node is no const at all. */
489 tarval *get_Const_tarval(const ir_node *node);
490 void set_Const_tarval(ir_node *node, tarval *con);
493 * Classify a node concerning constant properties.
494 * @param irn A node to check for.
495 * @return Constant properties of that node.
497 cnst_classify_t classify_Const(ir_node *irn);
499 /** Returns the source language type of a Const node.
500 * Must be an atomic type. Mode of type must be mode of node.
502 ir_type *get_Const_type(ir_node *node);
504 /** Sets the source language type of a Const node. */
505 void set_Const_type(ir_node *node, ir_type *tp);
507 /** This enum names the three different kinds of symbolic Constants
508 represented by SymConst. The content of the attribute type_or_id
509 depends on this tag. Use the proper access routine after testing
512 symconst_type_tag, /**< The SymConst is a type tag for the given type.
513 symconst_symbol is type *. */
514 symconst_type_size, /**< The SymConst is the size of the given type.
515 symconst_symbol is type *. */
516 symconst_type_align, /**< The SymConst is the alignment of the given type.
517 symconst_symbol is type *. */
518 symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
519 by the linker. The pointer is represented by a string.
520 symconst_symbol is ident *. */
521 symconst_addr_ent, /**< The SymConst is a symbolic pointer to be filled in
522 by the linker. The pointer is represented by an entity.
523 symconst_symbol is entity *. */
524 symconst_ofs_ent, /**< The SymConst is the offset of its entity in the entities
526 symconst_enum_const /**< The SymConst is a enumeration constant of an
530 /** Returns non-zero if s symconst kind has a type attribute */
531 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
533 /** Returns non-zero if s symconst kind has an ident attribute */
534 #define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)
536 /** Returns non-zero if s symconst kind has an entity attribute */
537 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
539 /** Returns non-zero if s symconst kind has an enum_const attribute */
540 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
542 /** SymConst attribute.
544 * This union contains the symbolic information represented by the node.
546 typedef union symconst_symbol {
547 ir_type *type_p; /**< the type of a symconst */
548 ident *ident_p; /**< the ident of a symconst */
549 ir_entity *entity_p; /**< the entity of a symconst */
550 ir_enum_const *enum_p; /**< the enumeration constant of a symconst */
553 /** Get the kind of the SymConst. */
554 symconst_kind get_SymConst_kind(const ir_node *node);
555 /** Set the kind of the SymConst. */
556 void set_SymConst_kind(ir_node *node, symconst_kind num);
558 /** Only to access SymConst of kind type_tag or size. Else assertion: */
559 ir_type *get_SymConst_type(ir_node *node);
560 void set_SymConst_type(ir_node *node, ir_type *tp);
562 /** Only to access SymConst of kind addr_name. Else assertion: */
563 ident *get_SymConst_name(const ir_node *node);
564 void set_SymConst_name(ir_node *node, ident *name);
566 /** Only to access SymConst of kind addr_ent. Else assertion: */
567 ir_entity *get_SymConst_entity(const ir_node *node);
568 void set_SymConst_entity(ir_node *node, ir_entity *ent);
570 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
571 ir_enum_const *get_SymConst_enum(const ir_node *node);
572 void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
574 /** Sets both: type and ptrinfo. Needed to treat the node independent of
575 its semantics. Does a memcpy for the memory sym points to. */
576 /* write 'union': firmjni then does not create a method... */
577 union symconst_symbol get_SymConst_symbol(const ir_node *node);
578 void set_SymConst_symbol(ir_node *node,
579 union symconst_symbol sym);
581 /** Access the type of the value represented by the SymConst.
583 * Example: primitive type int for SymConst size. */
584 ir_type *get_SymConst_value_type(ir_node *node);
585 void set_SymConst_value_type(ir_node *node, ir_type *tp);
587 ir_node *get_Sel_mem(ir_node *node);
588 void set_Sel_mem(ir_node *node, ir_node *mem);
589 ir_node *get_Sel_ptr(ir_node *node); /* ptr to the object to select from */
590 void set_Sel_ptr(ir_node *node, ir_node *ptr);
591 ir_node **get_Sel_index_arr(ir_node *node);
592 int get_Sel_n_indexs(ir_node *node);
593 ir_node *get_Sel_index(ir_node *node, int pos);
594 void set_Sel_index(ir_node *node, int pos, ir_node *index);
595 ir_entity *get_Sel_entity(ir_node *node); /* entity to select */
596 void set_Sel_entity (ir_node *node, ir_entity *ent);
599 * Projection numbers for result of Call node: use for Proj nodes!
602 pn_Call_M_regular = 0, /**< The memory result. */
603 pn_Call_X_regular = 1, /**< The control flow result when no exception occurs. */
604 pn_Call_X_except = 2, /**< The control flow result branching to the exception handler. */
605 pn_Call_T_result = 3, /**< The tuple containing all (0, 1, 2, ...) results. */
606 pn_Call_M_except = 4, /**< The memory result in case the called method terminated with
608 pn_Call_P_value_res_base = 5,/**< A pointer to the memory region containing copied results
609 passed by value (for compound result types). */
610 pn_Call_max = 6 /**< number of projections from a Call */
611 } pn_Call; /* Projection numbers for Call. */
612 #define pn_Call_M pn_Call_M_regular
614 ir_node *get_Call_mem(ir_node *node);
615 void set_Call_mem(ir_node *node, ir_node *mem);
616 ir_node *get_Call_ptr(ir_node *node);
617 void set_Call_ptr(ir_node *node, ir_node *ptr);
618 ir_node **get_Call_param_arr(ir_node *node);
619 /** Gets the number of parameters of a call. */
620 int get_Call_n_params(ir_node *node);
621 /** Gets the call parameter at position pos. */
622 ir_node *get_Call_param(ir_node *node, int pos);
623 /** Sets the call parameter at position pos. */
624 void set_Call_param(ir_node *node, int pos, ir_node *param);
625 /** Gets the type of a call. */
626 ir_type *get_Call_type(ir_node *node);
627 /** Sets the type of a call. */
628 void set_Call_type(ir_node *node, ir_type *tp);
629 /** Gets the arity of a call. Identical to get_Call_n_params(). */
630 int get_Call_arity(ir_node *node);
632 /** Set, get and remove the callee information for a Call node.
634 * The callee information lists all method entities that can be called
635 * from this node. If the address expression can not be analyzed fully,
636 * e.g., as entities can be called that are not in the compilation unit,
637 * the array contains the unknown_entity. The array contains only entities
638 * with peculiarity_existent, but with all kinds of visibility. The entities
639 * not necessarily contain an irg.
641 * The array is only accessible if callee information is valid. See flag
644 * The memory allocated for the array is managed automatically, i.e., it must
645 * not be freed if the Call node is removed from the graph.
647 * @param node A Call node.
649 int Call_has_callees(ir_node *node);
650 int get_Call_n_callees(ir_node *node);
651 ir_entity *get_Call_callee(ir_node *node, int pos);
653 /** Set the full callee array.
655 * The passed array is copied. Assumes current_ir_graph set properly! */
656 void set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
657 void remove_Call_callee_arr(ir_node *node);
659 ir_node *get_CallBegin_ptr(ir_node *node);
660 void set_CallBegin_ptr(ir_node *node, ir_node *ptr);
661 ir_node *get_CallBegin_call(ir_node *node);
662 void set_CallBegin_call(ir_node *node, ir_node *call);
664 /* For unary and binary arithmetic operations the access to the
665 operands can be factored out. Left is the first, right the
666 second arithmetic value as listed in tech report 1999-44.
667 unops are: Minus, Abs, Not, Conv, Cast
668 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
669 Shr, Shrs, Rot, Cmp */
670 int is_unop(const ir_node *node);
671 ir_node *get_unop_op(const ir_node *node);
672 void set_unop_op(ir_node *node, ir_node *op);
673 int is_binop(const ir_node *node);
674 ir_node *get_binop_left(const ir_node *node);
675 void set_binop_left(ir_node *node, ir_node *left);
676 ir_node *get_binop_right(const ir_node *node);
677 void set_binop_right(ir_node *node, ir_node *right);
679 ir_node *get_Add_left(const ir_node *node);
680 void set_Add_left(ir_node *node, ir_node *left);
681 ir_node *get_Add_right(const ir_node *node);
682 void set_Add_right(ir_node *node, ir_node *right);
684 ir_node *get_Sub_left(const ir_node *node);
685 void set_Sub_left(ir_node *node, ir_node *left);
686 ir_node *get_Sub_right(const ir_node *node);
687 void set_Sub_right(ir_node *node, ir_node *right);
689 ir_node *get_Minus_op(const ir_node *node);
690 void set_Minus_op(ir_node *node, ir_node *op);
692 ir_node *get_Mul_left(const ir_node *node);
693 void set_Mul_left(ir_node *node, ir_node *left);
694 ir_node *get_Mul_right(const ir_node *node);
695 void set_Mul_right(ir_node *node, ir_node *right);
697 ir_node *get_Quot_left(const ir_node *node);
698 void set_Quot_left(ir_node *node, ir_node *left);
699 ir_node *get_Quot_right(const ir_node *node);
700 void set_Quot_right(ir_node *node, ir_node *right);
701 ir_node *get_Quot_mem(ir_node *node);
702 void set_Quot_mem(ir_node *node, ir_node *mem);
703 ir_mode *get_Quot_resmode(const ir_node *node);
704 void set_Quot_resmode(ir_node *node, ir_mode *mode);
707 * Projection numbers for Quot: use for Proj nodes!
710 pn_Quot_M, /**< Memory result. */
711 pn_Quot_X_regular, /**< Execution result if no exception occurred. */
712 pn_Quot_X_except, /**< Execution result if exception occurred. */
713 pn_Quot_res, /**< Result of computation. */
714 pn_Quot_max /**< number of projections from a Quot */
715 } pn_Quot; /* Projection numbers for Quot. */
717 ir_node *get_DivMod_left(const ir_node *node);
718 void set_DivMod_left(ir_node *node, ir_node *left);
719 ir_node *get_DivMod_right(const ir_node *node);
720 void set_DivMod_right(ir_node *node, ir_node *right);
721 ir_node *get_DivMod_mem(ir_node *node);
722 void set_DivMod_mem(ir_node *node, ir_node *mem);
723 ir_mode *get_DivMod_resmode(const ir_node *node);
724 void set_DivMod_resmode(ir_node *node, ir_mode *mode);
727 * Projection numbers for DivMod: use for Proj nodes!
730 pn_DivMod_M, /**< Memory result. */
731 pn_DivMod_X_regular, /**< Execution result if no exception occurred. */
732 pn_DivMod_X_except, /**< Execution result if exception occurred. */
733 pn_DivMod_res_div, /**< Result of computation a / b. */
734 pn_DivMod_res_mod, /**< Result of computation a % b. */
735 pn_DivMod_max /**< number of projections from a DivMod */
736 } pn_DivMod; /* Projection numbers for DivMod. */
738 ir_node *get_Div_left(const ir_node *node);
739 void set_Div_left(ir_node *node, ir_node *left);
740 ir_node *get_Div_right(const ir_node *node);
741 void set_Div_right(ir_node *node, ir_node *right);
742 ir_node *get_Div_mem(ir_node *node);
743 void set_Div_mem(ir_node *node, ir_node *mem);
744 ir_mode *get_Div_resmode(const ir_node *node);
745 void set_Div_resmode(ir_node *node, ir_mode *mode);
748 * Projection numbers for Div: use for Proj nodes!
751 pn_Div_M, /**< Memory result. */
752 pn_Div_X_regular, /**< Execution result if no exception occurred. */
753 pn_Div_X_except, /**< Execution result if exception occurred. */
754 pn_Div_res, /**< Result of computation. */
755 pn_Div_max /**< number of projections from a Div */
756 } pn_Div; /* Projection numbers for Div. */
758 ir_node *get_Mod_left(const ir_node *node);
759 void set_Mod_left(ir_node *node, ir_node *left);
760 ir_node *get_Mod_right(const ir_node *node);
761 void set_Mod_right(ir_node *node, ir_node *right);
762 ir_node *get_Mod_mem(ir_node *node);
763 void set_Mod_mem(ir_node *node, ir_node *mem);
764 ir_mode *get_Mod_resmode(const ir_node *node);
765 void set_Mod_resmode(ir_node *node, ir_mode *mode);
768 * Projection numbers for Mod: use for Proj nodes!
771 pn_Mod_M, /**< Memory result. */
772 pn_Mod_X_regular, /**< Execution result if no exception occurred. */
773 pn_Mod_X_except, /**< Execution result if exception occurred. */
774 pn_Mod_res, /**< Result of computation. */
775 pn_Mod_max /**< number of projections from a Mod */
776 } pn_Mod; /* Projection numbers for Mod. */
778 ir_node *get_Abs_op(const ir_node *node);
779 void set_Abs_op(ir_node *node, ir_node *op);
781 ir_node *get_And_left(const ir_node *node);
782 void set_And_left(ir_node *node, ir_node *left);
783 ir_node *get_And_right(const ir_node *node);
784 void set_And_right(ir_node *node, ir_node *right);
786 ir_node *get_Or_left(const ir_node *node);
787 void set_Or_left(ir_node *node, ir_node *left);
788 ir_node *get_Or_right(const ir_node *node);
789 void set_Or_right(ir_node *node, ir_node *right);
791 ir_node *get_Eor_left(const ir_node *node);
792 void set_Eor_left(ir_node *node, ir_node *left);
793 ir_node *get_Eor_right(const ir_node *node);
794 void set_Eor_right(ir_node *node, ir_node *right);
796 ir_node *get_Not_op(const ir_node *node);
797 void set_Not_op(ir_node *node, ir_node *op);
800 * Projection numbers for Cmp are defined several times.
801 * The bit patterns are used for various tests, so don't change.
802 * The "unordered" values are possible results of comparing
803 * floating point numbers.
804 * Note that the encoding is imported, so do NOT change the order.
807 pn_Cmp_False = 0, /**< false */
808 pn_Cmp_Eq = 1, /**< equal */
809 pn_Cmp_Lt = 2, /**< less */
810 pn_Cmp_Le = pn_Cmp_Eq|pn_Cmp_Lt, /**< less or equal */
811 pn_Cmp_Gt = 4, /**< greater */
812 pn_Cmp_Ge = pn_Cmp_Eq|pn_Cmp_Gt, /**< greater or equal */
813 pn_Cmp_Lg = pn_Cmp_Lt|pn_Cmp_Gt, /**< less or greater */
814 pn_Cmp_Leg = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
815 pn_Cmp_Uo = 8, /**< unordered */
816 pn_Cmp_Ue = pn_Cmp_Uo|pn_Cmp_Eq, /**< unordered or equal */
817 pn_Cmp_Ul = pn_Cmp_Uo|pn_Cmp_Lt, /**< unordered or less */
818 pn_Cmp_Ule = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
819 pn_Cmp_Ug = pn_Cmp_Uo|pn_Cmp_Gt, /**< unordered or greater */
820 pn_Cmp_Uge = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
821 pn_Cmp_Ne = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
822 pn_Cmp_True = 15 /**< true */
823 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for JNI interface */
824 } pn_Cmp; /* Projection numbers for Cmp */
825 /* #define not_mask pn_Cmp_Leg */
827 /** returns the pnc name from an pnc constant */
828 const char *get_pnc_string(int pnc);
830 /** Calculates the negated (Complement(R)) pnc condition. */
831 int get_negated_pnc(int pnc, ir_mode *mode);
833 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
834 int get_inversed_pnc(int pnc);
836 ir_node *get_Cmp_left(const ir_node *node);
837 void set_Cmp_left(ir_node *node, ir_node *left);
838 ir_node *get_Cmp_right(const ir_node *node);
839 void set_Cmp_right(ir_node *node, ir_node *right);
841 ir_node *get_Shl_left(const ir_node *node);
842 void set_Shl_left(ir_node *node, ir_node *left);
843 ir_node *get_Shl_right(const ir_node *node);
844 void set_Shl_right(ir_node *node, ir_node *right);
846 ir_node *get_Shr_left(const ir_node *node);
847 void set_Shr_left(ir_node *node, ir_node *left);
848 ir_node *get_Shr_right(const ir_node *node);
849 void set_Shr_right(ir_node *node, ir_node *right);
851 ir_node *get_Shrs_left(const ir_node *node);
852 void set_Shrs_left(ir_node *node, ir_node *left);
853 ir_node *get_Shrs_right(const ir_node *node);
854 void set_Shrs_right(ir_node *node, ir_node *right);
856 ir_node *get_Rot_left(const ir_node *node);
857 void set_Rot_left(ir_node *node, ir_node *left);
858 ir_node *get_Rot_right(const ir_node *node);
859 void set_Rot_right(ir_node *node, ir_node *right);
861 ir_node *get_Conv_op(const ir_node *node);
862 void set_Conv_op(ir_node *node, ir_node *op);
863 int get_Conv_strict(ir_node *node);
864 void set_Conv_strict(ir_node *node, int flag);
866 /* Does Cast need a mem operator?
867 * Cast should only depend on the type, not on the state of an
868 * entity. But: we initialize various fields after Alloc, that
869 * are accessed in the cast. This required some precaution, to
870 * get the right memory into the Loads generated from the cast.
872 ir_node *get_Cast_op(const ir_node *node);
873 void set_Cast_op(ir_node *node, ir_node *op);
874 ir_type *get_Cast_type(ir_node *node);
875 void set_Cast_type(ir_node *node, ir_type *to_tp);
877 /** Checks for upcast.
879 * Returns true if the Cast node casts a class type to a super type.
880 * Works also for pointers to classes (recursively).
882 * Needs typeinfo calculated.
884 int is_Cast_upcast(ir_node *node);
886 /** Checks for downcast.
888 * Returns true if the Cast node casts a class type to a sub type.
889 * Works also for pointers to classes (recursively).
891 * Needs typeinfo calculated.
893 int is_Cast_downcast(ir_node *node);
896 /** Returns true if n is Phi or Filter in interprocedural_view.
897 Returns false if irg in phase building and the Phi has zero
898 predecessors: it's a Phi0. */
899 int is_Phi(const ir_node *n);
900 /** Returns true if irg in phase building and the Phi has zero
901 predecessors: it's a Phi0. */
902 int is_Phi0(const ir_node *n);
903 /* These routines also work for Filter nodes in interprocedural view. */
904 ir_node **get_Phi_preds_arr(ir_node *node);
905 int get_Phi_n_preds(const ir_node *node);
906 ir_node *get_Phi_pred(const ir_node *node, int pos);
907 void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
909 ir_node *get_Filter_pred(ir_node *node);
910 void set_Filter_pred(ir_node *node, ir_node *pred);
911 long get_Filter_proj(ir_node *node);
912 void set_Filter_proj(ir_node *node, long proj);
913 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
914 * @@@ Maybe better: arity is zero if no cg preds. */
915 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
916 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
917 int get_Filter_n_cg_preds(ir_node *node);
918 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
920 /** Return true if parameter is a memory operation.
922 * A memory operation is an operation that changes the
923 * memory. I.e., a Load or a Store operation.
925 int is_memop(ir_node *node);
926 ir_node *get_memop_mem(ir_node *node);
927 void set_memop_mem(ir_node *node, ir_node *mem);
928 ir_node *get_memop_ptr(ir_node *node);
929 void set_memop_ptr(ir_node *node, ir_node *ptr);
932 * Projection numbers for Load: use for Proj nodes!
935 pn_Load_M, /**< Memory result. */
936 pn_Load_X_regular, /**< Execution result if no exception occurred. */
937 pn_Load_X_except, /**< Execution result if exception occurred. */
938 pn_Load_res, /**< Result of load operation. */
939 pn_Load_max /**< number of projections from a Load */
940 } pn_Load; /* Projection numbers for Load. */
942 ir_node *get_Load_mem(ir_node *node);
943 void set_Load_mem(ir_node *node, ir_node *mem);
944 ir_node *get_Load_ptr(ir_node *node);
945 void set_Load_ptr(ir_node *node, ir_node *ptr);
946 ir_mode *get_Load_mode(ir_node *node);
947 void set_Load_mode(ir_node *node, ir_mode *mode);
948 ir_volatility get_Load_volatility(ir_node *node);
949 void set_Load_volatility(ir_node *node, ir_volatility volatility);
952 * Projection numbers for Store: use for Proj nodes!
955 pn_Store_M, /**< Memory result. */
956 pn_Store_X_regular, /**< Execution result if no exception occurred. */
957 pn_Store_X_except, /**< Execution result if exception occurred. */
958 pn_Store_max /**< number of projections from a Store */
959 } pn_Store; /* Projection numbers for Store. */
961 ir_node *get_Store_mem(ir_node *node);
962 void set_Store_mem(ir_node *node, ir_node *mem);
963 ir_node *get_Store_ptr(ir_node *node);
964 void set_Store_ptr(ir_node *node, ir_node *ptr);
965 ir_node *get_Store_value(ir_node *node);
966 void set_Store_value(ir_node *node, ir_node *value);
967 ir_volatility get_Store_volatility(ir_node *node);
968 void set_Store_volatility(ir_node *node, ir_volatility volatility);
971 * Projection numbers for Alloc: use for Proj nodes!
974 pn_Alloc_M, /**< Memory result. */
975 pn_Alloc_X_regular, /**< Execution result if no exception occurred. */
976 pn_Alloc_X_except, /**< Execution result if exception occurred. */
977 pn_Alloc_res, /**< Result of allocation. */
978 pn_Alloc_max /**< number of projections from an Alloc */
979 } pn_Alloc; /* Projection numbers for Alloc. */
981 ir_node *get_Alloc_mem(ir_node *node);
982 void set_Alloc_mem(ir_node *node, ir_node *mem);
983 ir_node *get_Alloc_size(ir_node *node);
984 void set_Alloc_size(ir_node *node, ir_node *size);
985 ir_type *get_Alloc_type(ir_node *node);
986 void set_Alloc_type(ir_node *node, ir_type *tp);
988 /** The allocation place. */
990 stack_alloc, /**< Alloc allocates the object on the stack. */
991 heap_alloc /**< Alloc allocates the object on the heap. */
994 where_alloc get_Alloc_where(ir_node *node);
995 void set_Alloc_where(ir_node *node, where_alloc where);
997 ir_node *get_Free_mem(ir_node *node);
998 void set_Free_mem(ir_node *node, ir_node *mem);
999 ir_node *get_Free_ptr(ir_node *node);
1000 void set_Free_ptr(ir_node *node, ir_node *ptr);
1001 ir_node *get_Free_size(ir_node *node);
1002 void set_Free_size(ir_node *node, ir_node *size);
1003 ir_type *get_Free_type(ir_node *node);
1004 void set_Free_type(ir_node *node, ir_type *tp);
1006 where_alloc get_Free_where(ir_node *node);
1007 void set_Free_where(ir_node *node, where_alloc where);
1009 ir_node **get_Sync_preds_arr(ir_node *node);
1010 int get_Sync_n_preds(ir_node *node);
1011 ir_node *get_Sync_pred(ir_node *node, int pos);
1012 void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
1013 void add_Sync_pred(ir_node *node, ir_node *pred);
1015 /** Returns the source language type of a Proj node.
1016 * Must be an atomic type. Mode of type must be mode of node.
1018 ir_type *get_Proj_type(ir_node *node);
1020 /** Return the predecessor of a Proj node. */
1021 ir_node *get_Proj_pred(const ir_node *node);
1022 void set_Proj_pred(ir_node *node, ir_node *pred);
1023 /** Return the projection number of a Proj node. */
1024 long get_Proj_proj(const ir_node *node);
1025 void set_Proj_proj(ir_node *node, long proj);
1026 long get_VProj_proj(const ir_node *node);
1027 void set_VProj_proj(ir_node *node, long value);
1030 ir_node **get_Tuple_preds_arr(ir_node *node);
1031 int get_Tuple_n_preds(ir_node *node);
1032 ir_node *get_Tuple_pred(ir_node *node, int pos);
1033 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
1035 ir_node *get_Id_pred(ir_node *node);
1036 void set_Id_pred(ir_node *node, ir_node *pred);
1038 /** Confirm has a single result and returns 'value' unchanged.
1039 * The node expresses a restriction on 'value':
1040 * 'value' 'cmp' 'bound' == true. */
1041 ir_node *get_Confirm_value(ir_node *node);
1042 void set_Confirm_value(ir_node *node, ir_node *value);
1043 ir_node *get_Confirm_bound(ir_node *node);
1044 void set_Confirm_bound(ir_node *node, ir_node *bound);
1045 pn_Cmp get_Confirm_cmp(ir_node *node);
1046 void set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
1049 * Mux Support: Note that Psi nodes with one condition can be handled
1050 * like Mux nodes, and the access functions work as expected.
1052 ir_node *get_Mux_sel(ir_node *node);
1053 void set_Mux_sel(ir_node *node, ir_node *sel);
1054 ir_node *get_Mux_false(ir_node *node);
1055 void set_Mux_false(ir_node *node, ir_node *ir_false);
1056 ir_node *get_Mux_true (ir_node *node);
1057 void set_Mux_true (ir_node *node, ir_node *ir_true);
1059 ir_node *get_Psi_cond(ir_node *node, int pos);
1060 void set_Psi_cond(ir_node *node, int pos, ir_node *cond);
1061 ir_node *get_Psi_val(ir_node *node, int pos);
1062 void set_Psi_val(ir_node *node, int pos, ir_node *val);
1063 ir_node *get_Psi_default(ir_node *node);
1064 void set_Psi_default(ir_node *node, ir_node *val);
1065 int get_Psi_n_conds(ir_node *node);
1068 * Projection numbers for result of CopyB node: use for Proj nodes!
1071 pn_CopyB_M_regular = 0, /**< The memory result. */
1072 pn_CopyB_X_regular = 1, /**< Execution result if no exception occurred. */
1073 pn_CopyB_X_except = 2, /**< The control flow result branching to the exception handler */
1074 pn_CopyB_M_except = 3, /**< The memory result in case the runtime function terminated with
1076 pn_CopyB_max = 4 /**< number of projections from a CopyB */
1077 } pn_CopyB; /* Projection numbers for CopyB. */
1078 #define pn_CopyB_M pn_CopyB_M_regular
1080 ir_node *get_CopyB_mem(ir_node *node);
1081 void set_CopyB_mem(ir_node *node, ir_node *mem);
1082 ir_node *get_CopyB_dst(ir_node *node);
1083 void set_CopyB_dst(ir_node *node, ir_node *dst);
1084 ir_node *get_CopyB_src(ir_node *node);
1085 void set_CopyB_src(ir_node *node, ir_node *src);
1086 ir_type *get_CopyB_type(ir_node *node);
1087 void set_CopyB_type(ir_node *node, ir_type *data_type);
1090 * Projection numbers for result of InstOf node: use for Proj nodes!
1093 pn_InstOf_M_regular = 0, /**< The memory result. */
1094 pn_InstOf_X_regular = 1, /**< Execution result if no exception occurred. */
1095 pn_InstOf_X_except = 2, /**< The control flow result branching to the exception handler */
1096 pn_InstOf_res = 3, /**< The checked object pointer. */
1097 pn_InstOf_M_except = 4, /**< The memory result in case the runtime function terminated with
1099 pn_InstOf_max = 5 /**< number of projections from an InstOf */
1101 #define pn_InstOf_M pn_InstOf_M_regular
1103 /** InstOf access */
1104 ir_type *get_InstOf_type(ir_node *node);
1105 void set_InstOf_type(ir_node *node, ir_type *type);
1106 ir_node *get_InstOf_store(ir_node *node);
1107 void set_InstOf_store(ir_node *node, ir_node *obj);
1108 ir_node *get_InstOf_obj(ir_node *node);
1109 void set_InstOf_obj(ir_node *node, ir_node *obj);
1112 * Projection numbers for Raise.
1115 pn_Raise_X = 0, /**< The control flow to the exception handler. */
1116 pn_Raise_M = 1, /**< The Memory result. */
1117 pn_Raise_max /**< number of projections from a Raise */
1118 } pn_Raise; /* Projection numbers for Raise. */
1120 ir_node *get_Raise_mem(ir_node *node);
1121 void set_Raise_mem(ir_node *node, ir_node *mem);
1122 ir_node *get_Raise_exo_ptr(ir_node *node); /* PoinTeR to EXception Object */
1123 void set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
1126 * Projection numbers for result of Bound node: use for Proj nodes!
1129 pn_Bound_M = 0, /**< The memory result. */
1130 pn_Bound_X_regular = 1, /**< Execution result if no exception occurred. */
1131 pn_Bound_X_except = 2, /**< The control flow result branching to the exception handler */
1132 pn_Bound_res = 3, /**< The checked index. */
1133 pn_Bound_max = 4 /**< number of projections from a Bound */
1136 /** Returns the memory input of a Bound operation. */
1137 ir_node *get_Bound_mem(ir_node *bound);
1138 void set_Bound_mem(ir_node *bound, ir_node *mem);
1140 /** Returns the index input of a Bound operation. */
1141 ir_node *get_Bound_index(ir_node *bound);
1142 void set_Bound_index(ir_node *bound, ir_node *idx);
1144 /** Returns the lower bound input of a Bound operation. */
1145 ir_node *get_Bound_lower(ir_node *bound);
1146 void set_Bound_lower(ir_node *bound, ir_node *lower);
1148 /** Returns the upper bound input of a Bound operation. */
1149 ir_node *get_Bound_upper(ir_node *bound);
1150 void set_Bound_upper(ir_node *bound, ir_node *upper);
1152 /** Return the operand of a Pin node. */
1153 ir_node *get_Pin_op(const ir_node *pin);
1154 void set_Pin_op(ir_node *pin, ir_node *node);
1159 * NAME Auxiliary routines
1161 * Not properly documented ;-)
1165 /** returns operand of node if node is a Proj. */
1166 ir_node *skip_Proj(ir_node *node);
1167 /** returns operand of node if node is a Proj. */
1168 const ir_node *skip_Proj_const(const ir_node *node);
1169 /** returns operand of node if node is a Id */
1170 ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
1171 /** returns corresponding operand of Tuple if node is a Proj from
1173 ir_node *skip_Tuple(ir_node *node);
1174 /** returns operand of node if node is a Cast */
1175 ir_node *skip_Cast(ir_node *node);
1176 /** returns operand of node if node is a Confirm */
1177 ir_node *skip_Confirm(ir_node *node);
1178 /** Skip all high-level Operations. */
1179 ir_node *skip_HighLevel(ir_node *node);
1180 /** returns true if irn is a Const node. */
1181 int is_Const(const ir_node *node);
1182 /** returns true if a node is a Conv node */
1183 int is_Conv(const ir_node *node);
1184 /** returns true if node is a Bad node. */
1185 int is_Bad(const ir_node *node);
1186 /** returns true if node is a NoMem node. */
1187 int is_NoMem(const ir_node *node);
1188 /** returns true if node is a Start node. */
1189 int is_Start(const ir_node *node);
1190 /** return true if node is a Mod node. */
1191 int is_Mod(const ir_node *node);
1192 /** return true if node is a Div node. */
1193 int is_Div(const ir_node *node);
1194 /** return true if node is a DivMod node. */
1195 int is_DivMod(const ir_node *node);
1196 /** return true if node is a Quot node. */
1197 int is_Quot(const ir_node *node);
1198 /** return true if node is an Add node. */
1199 int is_Add(const ir_node *node);
1200 /** return true if node is a Sub node. */
1201 int is_Sub(const ir_node *node);
1202 /** returns true if the node is not a Block */
1203 int is_no_Block(const ir_node *node);
1204 /** returns true if the node is a Block */
1205 int is_Block(const ir_node *node);
1206 /** returns true if node is an Unknown node. */
1207 int is_Unknown(const ir_node *node);
1208 /** returns true if node is a Return node. */
1209 int is_Return(const ir_node *node);
1210 /** returns true if node is a Call node. */
1211 int is_Call(const ir_node *node);
1212 /** returns true if node is a Sel node. */
1213 int is_Sel(const ir_node *node);
1214 /** returns true if node is a Mul node. */
1215 int is_Mul(const ir_node *node);
1216 /** returns true if node is a Mux node or a Psi with only one condition. */
1217 int is_Mux(const ir_node *node);
1218 /** returns true if node is a Load node. */
1219 int is_Load(const ir_node *node);
1220 /** returns true if node is a Store node. */
1221 int is_Store(const ir_node *node);
1222 /** returns true if node is a Sync node. */
1223 int is_Sync(const ir_node *node);
1224 /** returns true if node is a Confirm node. */
1225 int is_Confirm(const ir_node *node);
1226 /** returns true if node is a Pin node. */
1227 int is_Pin(const ir_node *node);
1228 /** returns true if node is a SymConst node. */
1229 int is_SymConst(const ir_node *node);
1230 /** returns true if node is a Cond node. */
1231 int is_Cond(const ir_node *node);
1232 /** returns true of node is a CopyB node */
1233 int is_CopyB(const ir_node *node);
1234 /** returns true if node is a Cmp node. */
1235 int is_Cmp(const ir_node *node);
1236 /** returns true if node is an Alloc node */
1237 int is_Alloc(const ir_node *node);
1238 /** returns true if a node is a Jmp node */
1239 int is_Jmp(const ir_node *node);
1240 /** returns true if a node is a Raise node */
1241 int is_Raise(const ir_node *node);
1242 /** returns true if node is a Proj node or a Filter node in
1243 * intraprocedural view */
1244 int is_Proj(const ir_node *node);
1245 /** Returns true if the operation manipulates control flow:
1246 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1247 int is_cfop(const ir_node *node);
1249 /** Returns true if the operation manipulates interprocedural control flow:
1250 CallBegin, EndReg, EndExcept */
1251 int is_ip_cfop(const ir_node *node);
1252 /** Returns true if the operation can change the control flow because
1253 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1254 Bad. Raise is not fragile, but a unconditional jump. */
1255 int is_fragile_op(const ir_node *node);
1256 /** Returns the memory operand of fragile operations. */
1257 ir_node *get_fragile_op_mem(ir_node *node);
1258 /** Returns the result mode of a Div operation. */
1259 ir_mode *get_divop_resmod(const ir_node *node);
1261 /** Returns true if the operation is a forking control flow
1262 * operation: Cond. */
1263 int is_irn_forking(const ir_node *node);
1265 /** Return the type associated with the value produced by n
1266 * if the node remarks this type as it is the case for
1267 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1268 ir_type *get_irn_type(ir_node *n);
1270 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1272 ir_type *get_irn_type_attr(ir_node *n);
1274 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1275 ir_entity *get_irn_entity_attr(ir_node *n);
1277 /** Returns non-zero for constant-like nodes. */
1278 int is_irn_constlike(const ir_node *node);
1281 * Returns non-zero for nodes that must be always optimized
1282 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1284 int is_irn_always_opt(const ir_node *node);
1287 * Returns non-zero for nodes that are allowed to have keep-alives and
1288 * are neither Block nor PhiM.
1290 int is_irn_keep(const ir_node *node);
1293 * Returns non-zero for nodes that are always placed in the start block.
1295 int is_irn_start_block_placed(const ir_node *node);
1298 * Returns non-zero for nodes that are machine operations.
1300 int is_irn_machine_op(const ir_node *node);
1303 * Returns non-zero for nodes that are machine operands.
1305 int is_irn_machine_operand(const ir_node *node);
1308 * Returns non-zero for nodes that have the n'th user machine flag set.
1310 int is_irn_machine_user(const ir_node *node, unsigned n);
1313 * A type to express conditional jump predictions.
1316 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1317 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1318 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1319 } cond_jmp_predicate;
1321 /** Gets the string representation of the jump prediction .*/
1322 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1324 /** Returns the conditional jump prediction of a Cond node. */
1325 cond_jmp_predicate get_Cond_jmp_pred(const ir_node *cond);
1327 /** Sets a new conditional jump prediction. */
1328 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1331 * Access custom node data.
1332 * The data must have been registered with
1333 * register_additional_node_data() before.
1334 * @param node The ir node to get the data from.
1335 * @param type The type of the data you registered.
1336 * @param off The value returned by register_additional_node_data().
1337 * @return A pointer of type @p type.
1339 #define get_irn_data(node,type,off) \
1340 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1343 * Get the pointer to the node some custom data belongs to.
1344 * @param data The pointer to the custom data.
1345 * @param off The number as returned by register_additional_node_data().
1346 * @return A pointer to the ir node the custom data belongs to.
1348 #define get_irn_data_base(data,off) \
1349 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1352 * Request additional data to be allocated with an ir node.
1353 * @param size The size of the additional data required.
1354 * @return A positive number, if the operation was successful, which
1355 * must be passed to the access macro get_irn_data(), 0 if the
1356 * registration failed.
1358 unsigned register_additional_node_data(unsigned size);
1361 * Return a pointer to the node attributes.
1362 * Needed for user-defined nodes.
1364 void *get_irn_generic_attr(ir_node *node);
1365 const void *get_irn_generic_attr_const(const ir_node *node);
1368 * Returns the unique node index for the node in its graph.
1369 * This index is used to access phase information for this node.
1371 unsigned get_irn_idx(const ir_node *node);
1373 /*-----------------------------------------------------------------*/
1375 /*-----------------------------------------------------------------*/
1378 /** Debug print the node.
1380 * Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
1381 * is set. Else does nothing. */
1382 void dump_irn(ir_node *n);
1388 /* GNU C has the __FUNCTION__ extension */
1389 #define __MYFUNC__ __FUNCTION__
1391 /* use Filename instead */
1392 #define __MYFUNC__ __FILE__
1396 Don't format with "\", firmjni gets problems */
1397 /** Output location */
1398 #define DDM printf("%s(l.%i).\n", __MYFUNC__, __LINE__);
1399 /** Output the firm kind of the node */
1400 #define DDMK(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, print_firm_kind(X), (void *)(X));
1401 /** Output information about a node */
1403 /*#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))*/
1404 int dump_node_opcode(FILE *F, ir_node *n);
1405 #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)
1407 /** Output information about a node and its block */
1408 #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)))
1409 /** Output information about a type */
1410 #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))
1411 /** Output information about an entity */
1412 #define DDME(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
1413 /** Output information about an entity and its type */
1414 #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))
1415 /** Output information about an entity and its owner */
1416 #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))
1417 /** Output information about a graph */
1418 #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))))
1419 /** Output information about an ident */
1420 #define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_id_str(X), (void *)(X))
1421 /** Output information about a mode */
1422 #define DDMM(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
1423 /** Output information about a loop */
1424 #define DDML(X) printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
1425 /** Output information about a tarVal */
1426 #define DDMV(X) printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
1428 /*@}*/ /* end of ir_node group definition */