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"
39 * @author Martin Trapp, Christian Schaefer
41 * Declarations of an ir node.
45 * @defgroup ir_node Declarations of an ir node.
47 * The type definition of ir_node is also in irgraph.h to resolve
48 * recursion between irnode.h and irgraph.h
50 * ir_node - a datatype representing a Firm node
52 * The common fields are:
54 * - firm_kind - A firm_kind tag containing k_type. This is useful
55 * for dynamically checking whether a node is a ir_node.
56 * - arity - The number of predecessors in the Firm graph.
57 * - in - A list with the predecessors in the Firm graph. There are
58 * routines to access individual elements and to obtain the
59 * array. The method returning the array should not be used.
60 * - mode - The mode of the node. There are routines to get the mode
61 * but also to access the mode's fields directly.
62 * - opcode - The opcode of the node. There are routines to get the opcode
63 * but also to access the opcode's fields directly.
64 * - node_nr - A unique number for the node. Available only if debugging
70 * you can work on the graph without considering the different types
71 * of nodes, it's just a big graph.
75 * Checks whether a pointer points to a ir node.
77 * @param thing an arbitrary pointer
78 * @return non-zero if the thing is a ir mode, else zero
80 int is_ir_node (const void *thing);
83 * Returns the number of predecessors without the block predecessor.
85 * @param node the IR-node
87 int get_irn_arity (const ir_node *node);
88 int get_irn_intra_arity(const ir_node *node);
89 int get_irn_inter_arity(const ir_node *node);
91 /** Replaces the old in array by a new one that will contain the ins given in
92 the parameters. Conserves the block predecessor. It copies the array passed.
93 This function is necessary to adjust in arrays of blocks, calls and phis.
94 Assumes that current_ir_graph is set to the graph containing "node".
95 "in" must contain all predecessors except the block that are required for
97 void set_irn_in(ir_node *node, int arity, ir_node *in[]);
99 /* to iterate through the predecessors without touching the array. No
100 order of predecessors guaranteed.
101 To iterate over the operands iterate from 0 to i < get_irn_arity(),
102 to iterate including the Block predecessor iterate from i = -1 to
103 i < get_irn_arity. */
104 /* Access predecessor n */
107 * Get the n-th predecessor of a node.
108 * This function removes Id predecessors.
109 * This function automatically handles intra- and interprocedural views.
111 ir_node *get_irn_n(const ir_node *node, int n);
114 * Add a artificial dependency to the node.
115 * The dependency is only inserted if it is not there already.
116 * @param node The node.
117 * @param dep The dependency target.
118 * @return The index in the array (get_irn_dep() with that index returns @p dep).
120 int add_irn_dep(ir_node *node, ir_node *dep);
123 * Copy all dependencies from a node to another.
124 * @param tgt The node which should be enriched.
125 * @param src The node whose dependencies shall be copied.
127 void add_irn_deps(ir_node *tgt, ir_node *src);
130 * Get the length of the dependency array.
131 * @param node The node.
132 * @return The length of the dependency array or 0 if it has not yet been allocated.
134 int get_irn_deps(const ir_node *node);
137 * Get an entry of the dependency array.
138 * @param node The node.
139 * @param pos The position.
140 * @return The node at that position.
142 ir_node *get_irn_dep(const ir_node *node, int pos);
145 * Set an entry of the dependency array.
146 * @param node The node.
147 * @param pos The position.
148 * @param dep The dependency target.
150 void set_irn_dep(ir_node *node, int pos, ir_node *dep);
154 * Get the n-th predecessor of a node in intraprocedural view.
155 * Can be used always if it's know that node is not a split one.
157 ir_node *get_irn_intra_n(const ir_node *node, int n);
160 * Get the n-th predecessor of a node in interprocedural view.
162 ir_node *get_irn_inter_n(const ir_node *node, int n);
164 /** Replace the n-th predecessor of a node with a new one. */
165 void set_irn_n(ir_node *node, int n, ir_node *in);
167 * Appends a new predecessor to a node. This only works for nodes with
169 * @returns the number of the new input
171 int add_irn_n(ir_node *node, ir_node *in);
172 /* Sets the mode struct of node. */
173 void set_irn_mode(ir_node *node, ir_mode *mode);
174 /** Gets the mode struct of a node. */
175 ir_mode *get_irn_mode(const ir_node *node);
176 /** Gets the mode-enum modecode. */
177 modecode get_irn_modecode(const ir_node *node);
178 /** Gets the ident for a string representation of the mode .*/
179 ident *get_irn_modeident(const ir_node *node);
180 /** Gets the string representation of the mode .*/
181 const char *get_irn_modename(const ir_node *node);
182 /** Gets the opcode struct of the node. */
183 ir_op *get_irn_op(const ir_node *node);
184 /** Sets the opcode struct of the node. */
185 void set_irn_op(ir_node *node, ir_op *op);
186 /** Gets the opcode-enum of the node. */
187 unsigned get_irn_opcode(const ir_node *node);
188 /** Get the string representation of the opcode. */
189 const char *get_irn_opname(const ir_node *node);
190 /** Get the ident for a string representation of the opcode. */
191 ident *get_irn_opident(const ir_node *node);
192 /** If arg is an argument of the node, returns it's position, -1 otherwise */
193 int get_irn_pred_pos(ir_node *node, ir_node *arg);
194 /** Gets the visited counter of a node. */
195 unsigned long get_irn_visited(const ir_node *node);
196 /** Sets the visited counter of a node. */
197 void set_irn_visited(ir_node *node, unsigned long visited);
198 /** Sets visited to get_irg_visited(current_ir_graph). */
199 void mark_irn_visited(ir_node *node);
200 /** Returns 1 if visited < get_irg_visited(current_ir_graph). */
201 int irn_not_visited(const ir_node *node);
202 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
203 int irn_visited(const ir_node *node);
206 * Sets the link of a node.
207 * Only allowed if the graph is NOT in phase_building.
209 void set_irn_link(ir_node *node, void *link);
211 /** Returns the link of a node. */
212 void *get_irn_link(const ir_node *node);
214 /** Returns the ir_graph this node belongs to. */
215 ir_graph *get_irn_irg(const ir_node *node);
217 /** Outputs a unique number for this node if libFIRM is compiled for
218 debugging, (configure with --enable-debug) else returns address
219 of node cast to long. */
220 long get_irn_node_nr(const ir_node *node);
222 /** Returns the pinned state of a node.
224 * Returns whether the node _always_ must be pinned.
225 * I.e., the node is not floating after global cse.
227 * @returns Either state op_pin_state_pinned or op_pin_state_floats.
229 op_pin_state get_irn_pinned(const ir_node *node);
231 /** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
232 void set_irn_pinned(ir_node *node, op_pin_state state);
234 /** Returns whether the node is currently pinned.
236 * If get_irn_pinned returns op_pin_state_floats and the graph the
237 * node belongs to is in state op_poin_state_floats then this function
238 * returns 'floats', else 'pinned'.
240 op_pin_state is_irn_pinned_in_irg(const ir_node *node);
243 * IR node constructor.
244 * Create a new IR node in irg, with an op, mode, arity and
245 * some incoming IR nodes.
246 * This constructor is used in every specific IR node constructor.
248 * @param db Debug info.
249 * @param irg IR-graph on with this new node should be constructed.
250 * @param block The block the new node belongs to
251 * @param op The opcode of the new node.
252 * @param mode The mode of the new node.
253 * @param arity The arity of the new node, <0 if can be changed dynamically.
254 * @param in An array of arity predecessor nodes.
257 new_ir_node(dbg_info *db,
266 * Return the block the node belongs to. This is only
267 * possible for pinned nodes or if the graph is in pinned state.
268 * Otherwise the block may be incorrect. This condition is
269 * now checked by an assertion.
271 * This works for all except Block. It can return Blocks or the Bad node.
273 * To express the difference to access routines that work for all
274 * nodes we use infix "nodes" and do not name this function
275 * get_irn_block(). */
276 ir_node *get_nodes_block (const ir_node *node);
278 /** Sets the Block of a node. */
279 void set_nodes_block (ir_node *node, ir_node *block);
282 * @function get_irn_block()
283 * @see get_nodes_block()
287 * Projection numbers for result of Start node: use for Proj nodes!
290 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
291 pn_Start_M, /**< Projection on the initial memory. */
292 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
293 pn_Start_P_globals, /**< Projection on the pointer to the data segment
294 containing _all_ global entities. Use for
295 position independent data/code access. */
296 pn_Start_P_tls, /**< Projection on the pointer to the thread local store
297 segment containing _all_thread local variables. */
298 pn_Start_T_args, /**< Projection on all arguments. */
299 pn_Start_P_value_arg_base, /**< Pointer to region of compound value arguments as defined by
300 type of this method. */
301 pn_Start_max /**< number of projections from a Start */
302 } pn_Start; /* Projection numbers for Start. */
304 /** Test whether arbitrary node is frame pointer.
306 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
307 * from Start. If so returns frame type, else Null. */
308 ir_type *is_frame_pointer(ir_node *n);
310 /** Test whether arbitrary node is globals pointer.
312 * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
313 * from Start. If so returns global type, else Null. */
314 ir_type *is_globals_pointer(ir_node *n);
316 /** Test whether arbitrary node is tls pointer.
318 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
319 * from Start. If so returns tls type, else Null. */
320 ir_type *is_tls_pointer(ir_node *n);
322 /** Test whether arbitrary node is value arg base.
324 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
325 * from Start. If so returns 1, else 0. */
326 int is_value_arg_pointer(ir_node *n);
329 /* @@@ no more supported */
330 ir_node **get_Block_cfgpred_arr(ir_node *node);
331 int get_Block_n_cfgpreds(const ir_node *node);
332 ir_node *get_Block_cfgpred(ir_node *node, int pos);
333 void set_Block_cfgpred(ir_node *node, int pos, ir_node *pred);
334 /** Get the predecessor block.
336 * Returns the block corresponding to the predecessor pos of block.
338 * There are several ambiguities we resolve with this function:
339 * - The direct predecessor can be a Proj, which is not pinned.
340 * We walk from the predecessor to the next pinned node
341 * (skip_Proj) and return the block that node is in.
342 * - If we encounter the Bad node, this function does not return
343 * Start, but the Bad node.
345 ir_node *get_Block_cfgpred_block(ir_node *node, int pos);
346 int get_Block_matured(ir_node *node);
347 void set_Block_matured(ir_node *node, int matured);
349 /** A visited flag only for block nodes.
350 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
351 unsigned long get_Block_block_visited(const ir_node *node);
352 void set_Block_block_visited(ir_node *node, unsigned long visit);
355 * Marks a block as dead but do not replace it with a Bad node.
356 * Dead blocks are removed in the con
358 ir_node *set_Block_dead(ir_node *block);
359 int is_Block_dead(const ir_node *block);
361 /* For this current_ir_graph must be set. */
362 void mark_Block_block_visited(ir_node *node);
363 int Block_not_block_visited(const ir_node *node);
364 int Block_block_visited(const ir_node *node);
366 /* Set and remove interprocedural predecessors. If the interprocedural
367 * predecessors are removed, the node has the same predecessors in
369 * @@@ Maybe better: arity is zero if no cg preds. */
370 void set_Block_cg_cfgpred_arr(ir_node *node, int arity, ir_node *in[]);
371 void set_Block_cg_cfgpred(ir_node *node, int pos, ir_node *pred);
372 /* @@@ not supported */
373 ir_node **get_Block_cg_cfgpred_arr(ir_node *node);
374 /** Returns the number of interprocedural predecessors. 0 if none. */
375 int get_Block_cg_n_cfgpreds(ir_node *node);
376 /** Return the interprocedural predecessor at position pos. */
377 ir_node *get_Block_cg_cfgpred(ir_node *node, int pos);
378 /** Frees the memory allocated for interprocedural predecessors. */
379 void remove_Block_cg_cfgpred_arr(ir_node *node);
380 /** Returns the extended basic block a block belongs to. */
381 ir_extblk *get_Block_extbb(const ir_node *block);
382 /** Sets the extended basic block a block belongs to. */
383 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
384 /** Get the Macro Block header of a (sub-) block. */
385 ir_node *get_Block_MacroBlock(const ir_node *block);
386 /** Returns the ir_graph this Block belongs to. */
387 ir_graph *get_Block_irg(const ir_node *block);
388 /** Returns non-zero if the block has an assigned label. */
389 int has_Block_label(const ir_node *block);
390 /** Returns the label of a Block. */
391 ir_label_t get_Block_label(const ir_node *block);
392 /** Sets a label to a block. */
393 void set_Block_label(ir_node *block, ir_label_t label);
395 /** Return the number of Keep alive node. */
396 int get_End_n_keepalives(ir_node *end);
397 /** Return the Keep alive node a position pos. */
398 ir_node *get_End_keepalive(ir_node *end, int pos);
399 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
400 void add_End_keepalive(ir_node *end, ir_node *ka);
401 /** Set the Keep alive node at position pos. */
402 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
403 /** Set new keep-alives. */
404 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
405 /** Set new keep-alives from old keep-alives, skipping irn. */
406 void remove_End_keepalive(ir_node *end, ir_node *irn);
408 /** Some parts of the End node are allocated separately -- their memory
409 is not recovered by dead_node_elimination if a End node is dead.
410 free_End() frees these data structures. */
411 void free_End(ir_node *end);
413 /** Return the target address of an IJmp */
414 ir_node *get_IJmp_target(ir_node *ijmp);
415 /** Sets the target address of an IJmp */
416 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
418 /* We distinguish three kinds of Cond nodes. These can be distinguished
419 by the mode of the selector operand and an internal flag of type cond_kind.
420 First we distinguish binary Conds and switch Conds.
421 A binary Cond has as selector a boolean value. Proj(0) projects the control
422 flow for case "False", Proj(1) the control flow for "True". A binary Cond
423 is recognized by the boolean selector.
424 The switch Cond has as selector an unsigned integer. It produces as result
425 an n+1 Tuple (cf0, ... , cfn) of control flows.
426 We differ two flavors of this Cond. The first, the dense Cond, passes
427 control along output i if the selector value is i, 0 <= i <= n. If the
428 selector value is >n it passes control along output n.
429 The second Cond flavor differences in the treatment of cases not specified in
430 the source program. It magically knows about the existence of Proj nodes.
431 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
432 exists. Else it passes control along output n (even if this Proj does not
433 exist.) This Cond we call "fragmentary". There is a special constructor
434 new_defaultProj that automatically sets the flavor.
435 The two switch flavors are distinguished by a flag of type cond_kind.
436 Default flavor is "dense"
439 dense, /**< Default. Missing Proj nodes are dead control flow. */
440 fragmentary /**< Special. No control flow optimizations allowed. Missing
441 Proj nodes mean default control flow, i.e., Proj(n). */
444 ir_node *get_Cond_selector(ir_node *node);
445 void set_Cond_selector(ir_node *node, ir_node *selector);
446 cond_kind get_Cond_kind(ir_node *node);
447 void set_Cond_kind(ir_node *node, cond_kind kind);
448 long get_Cond_defaultProj(ir_node *node);
451 * Projection numbers for conditions.
454 pn_Cond_false, /**< Control flow if operand is "false". */
455 pn_Cond_true, /**< Control flow if operand is "true". */
456 pn_Cond_max /**< number of projections from a Cond */
457 } pn_Cond; /* Projection numbers for Cond. */
459 ir_node *get_Return_mem(ir_node *node);
460 void set_Return_mem(ir_node *node, ir_node *mem);
461 ir_node **get_Return_res_arr(ir_node *node);
462 int get_Return_n_ress(ir_node *node);
463 ir_node *get_Return_res(ir_node *node, int pos);
464 void set_Return_res(ir_node *node, int pos, ir_node *res);
467 * Possible classes for constant classification.
470 CNST_NULL = 0, /**< The node is a const(0). */
471 CNST_ONE = +1, /**< The node is a const(1). */
472 CNST_ALL_ONE = -1, /**< The node is a const(11111...). */
473 CNST_OTHER = 2, /**< The tarval of the const has another value. */
474 CNST_SYMCONST = 3, /**< The node is symconst. */
475 CNST_NO_CONST = 4 /**< The node is no const at all. */
478 tarval *get_Const_tarval(const ir_node *node);
479 void set_Const_tarval(ir_node *node, tarval *con);
482 * Classify a node concerning constant properties.
483 * @param irn A node to check for.
484 * @return Constant properties of that node.
486 cnst_classify_t classify_Const(ir_node *irn);
488 /** Returns the source language type of a Const node.
489 * Must be an atomic type. Mode of type must be mode of node.
491 ir_type *get_Const_type(ir_node *node);
493 /** Sets the source language type of a Const node. */
494 void set_Const_type(ir_node *node, ir_type *tp);
496 /** This enum names the three different kinds of symbolic Constants
497 represented by SymConst. The content of the attribute type_or_id
498 depends on this tag. Use the proper access routine after testing
501 symconst_type_tag, /**< The SymConst is a type tag for the given type.
502 symconst_symbol is type *. */
503 symconst_type_size, /**< The SymConst is the size of the given type.
504 symconst_symbol is type *. */
505 symconst_type_align, /**< The SymConst is the alignment of the given type.
506 symconst_symbol is type *. */
507 symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
508 by the linker. The pointer is represented by a string.
509 symconst_symbol is ident *. */
510 symconst_addr_ent, /**< The SymConst is a symbolic pointer to be filled in
511 by the linker. The pointer is represented by an entity.
512 symconst_symbol is entity *. */
513 symconst_ofs_ent, /**< The SymConst is the offset of its entity in the entities
515 symconst_enum_const, /**< The SymConst is a enumeration constant of an
517 symconst_label /**< The SymConst is a label address. */
520 /** Returns non-zero if s symconst kind has a type attribute */
521 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
523 /** Returns non-zero if s symconst kind has an ident attribute */
524 #define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)
526 /** Returns non-zero if s symconst kind has an entity attribute */
527 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
529 /** Returns non-zero if s symconst kind has an enum_const attribute */
530 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
532 /** Returns non-zero if s symconst kind has a label attribute */
533 #define SYMCONST_HAS_LABEL(kind) ((kind) == symconst_label)
535 /** SymConst attribute.
537 * This union contains the symbolic information represented by the node.
539 typedef union symconst_symbol {
540 ir_type *type_p; /**< The type of a SymConst. */
541 ident *ident_p; /**< The ident of a SymConst. */
542 ir_entity *entity_p; /**< The entity of a SymConst. */
543 ir_enum_const *enum_p; /**< The enumeration constant of a SymConst. */
544 ir_label_t label; /**< The label of a SymConst. */
547 /** Get the kind of the SymConst. */
548 symconst_kind get_SymConst_kind(const ir_node *node);
549 /** Set the kind of the SymConst. */
550 void set_SymConst_kind(ir_node *node, symconst_kind num);
552 /** Only to access SymConst of kind type_tag or size. Else assertion: */
553 ir_type *get_SymConst_type(ir_node *node);
554 void set_SymConst_type(ir_node *node, ir_type *tp);
556 /** Only to access SymConst of kind addr_name. Else assertion: */
557 ident *get_SymConst_name(const ir_node *node);
558 void set_SymConst_name(ir_node *node, ident *name);
560 /** Only to access SymConst of kind addr_ent. Else assertion: */
561 ir_entity *get_SymConst_entity(const ir_node *node);
562 void set_SymConst_entity(ir_node *node, ir_entity *ent);
564 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
565 ir_enum_const *get_SymConst_enum(const ir_node *node);
566 void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
568 /** Sets both: type and ptrinfo. Needed to treat the node independent of
569 its semantics. Does a memcpy for the memory sym points to. */
570 /* write 'union': firmjni then does not create a method... */
571 union symconst_symbol get_SymConst_symbol(const ir_node *node);
572 void set_SymConst_symbol(ir_node *node,
573 union symconst_symbol sym);
575 /** Only to access SymConst of kind symconst_label. Else assertion: */
576 ir_label_t get_SymConst_label(const ir_node *node);
577 void set_SymConst_label(ir_node *node, ir_label_t label);
580 /** Access the type of the value represented by the SymConst.
582 * Example: primitive type int for SymConst size. */
583 ir_type *get_SymConst_value_type(ir_node *node);
584 void set_SymConst_value_type(ir_node *node, ir_type *tp);
586 ir_node *get_Sel_mem(ir_node *node);
587 void set_Sel_mem(ir_node *node, ir_node *mem);
588 ir_node *get_Sel_ptr(ir_node *node); /* ptr to the object to select from */
589 void set_Sel_ptr(ir_node *node, ir_node *ptr);
590 ir_node **get_Sel_index_arr(ir_node *node);
591 int get_Sel_n_indexs(ir_node *node);
592 ir_node *get_Sel_index(ir_node *node, int pos);
593 void set_Sel_index(ir_node *node, int pos, ir_node *index);
594 ir_entity *get_Sel_entity(ir_node *node); /* entity to select */
595 void set_Sel_entity (ir_node *node, ir_entity *ent);
598 * Projection numbers for result of Call node: use for Proj nodes!
601 pn_Call_M_regular = 0, /**< The memory result. */
602 pn_Call_X_regular = 1, /**< The control flow result when no exception occurs. */
603 pn_Call_X_except = 2, /**< The control flow result branching to the exception handler. */
604 pn_Call_T_result = 3, /**< The tuple containing all (0, 1, 2, ...) results. */
605 pn_Call_M_except = 4, /**< The memory result in case the called method terminated with
607 pn_Call_P_value_res_base = 5,/**< A pointer to the memory region containing copied results
608 passed by value (for compound result types). */
609 pn_Call_max = 6 /**< number of projections from a Call */
610 } pn_Call; /* Projection numbers for Call. */
611 #define pn_Call_M pn_Call_M_regular
613 ir_node *get_Call_mem(ir_node *node);
614 void set_Call_mem(ir_node *node, ir_node *mem);
615 ir_node *get_Call_ptr(ir_node *node);
616 void set_Call_ptr(ir_node *node, ir_node *ptr);
617 ir_node **get_Call_param_arr(ir_node *node);
618 /** Gets the number of parameters of a call. */
619 int get_Call_n_params(ir_node *node);
620 /** Gets the call parameter at position pos. */
621 ir_node *get_Call_param(ir_node *node, int pos);
622 /** Sets the call parameter at position pos. */
623 void set_Call_param(ir_node *node, int pos, ir_node *param);
624 /** Gets the type of a call. */
625 ir_type *get_Call_type(ir_node *node);
626 /** Sets the type of a call. */
627 void set_Call_type(ir_node *node, ir_type *tp);
628 /** Gets the arity of a call. Identical to get_Call_n_params(). */
629 int get_Call_arity(ir_node *node);
631 /** Set, get and remove the callee information for a Call node.
633 * The callee information lists all method entities that can be called
634 * from this node. If the address expression can not be analyzed fully,
635 * e.g., as entities can be called that are not in the compilation unit,
636 * the array contains the unknown_entity. The array contains only entities
637 * with peculiarity_existent, but with all kinds of visibility. The entities
638 * not necessarily contain an irg.
640 * The array is only accessible if callee information is valid. See flag
643 * The memory allocated for the array is managed automatically, i.e., it must
644 * not be freed if the Call node is removed from the graph.
646 * @param node A Call node.
648 int Call_has_callees(ir_node *node);
649 int get_Call_n_callees(ir_node *node);
650 ir_entity *get_Call_callee(ir_node *node, int pos);
652 /** Set the full callee array.
654 * The passed array is copied. Assumes current_ir_graph set properly! */
655 void set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
656 void remove_Call_callee_arr(ir_node *node);
658 ir_node *get_CallBegin_ptr(ir_node *node);
659 void set_CallBegin_ptr(ir_node *node, ir_node *ptr);
660 ir_node *get_CallBegin_call(ir_node *node);
661 void set_CallBegin_call(ir_node *node, ir_node *call);
663 /* For unary and binary arithmetic operations the access to the
664 operands can be factored out. Left is the first, right the
665 second arithmetic value as listed in tech report 1999-44.
666 unops are: Minus, Abs, Not, Conv, Cast
667 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
668 Shr, Shrs, Rot, Cmp */
669 int is_unop(const ir_node *node);
670 ir_node *get_unop_op(const ir_node *node);
671 void set_unop_op(ir_node *node, ir_node *op);
672 int is_binop(const ir_node *node);
673 ir_node *get_binop_left(const ir_node *node);
674 void set_binop_left(ir_node *node, ir_node *left);
675 ir_node *get_binop_right(const ir_node *node);
676 void set_binop_right(ir_node *node, ir_node *right);
678 ir_node *get_Add_left(const ir_node *node);
679 void set_Add_left(ir_node *node, ir_node *left);
680 ir_node *get_Add_right(const ir_node *node);
681 void set_Add_right(ir_node *node, ir_node *right);
683 ir_node *get_Sub_left(const ir_node *node);
684 void set_Sub_left(ir_node *node, ir_node *left);
685 ir_node *get_Sub_right(const ir_node *node);
686 void set_Sub_right(ir_node *node, ir_node *right);
688 ir_node *get_Minus_op(const ir_node *node);
689 void set_Minus_op(ir_node *node, ir_node *op);
691 ir_node *get_Mul_left(const ir_node *node);
692 void set_Mul_left(ir_node *node, ir_node *left);
693 ir_node *get_Mul_right(const ir_node *node);
694 void set_Mul_right(ir_node *node, ir_node *right);
696 ir_node *get_Mulh_left(const ir_node *node);
697 void set_Mulh_left(ir_node *node, ir_node *left);
698 ir_node *get_Mulh_right(const ir_node *node);
699 void set_Mulh_right(ir_node *node, ir_node *right);
701 ir_node *get_Quot_left(const ir_node *node);
702 void set_Quot_left(ir_node *node, ir_node *left);
703 ir_node *get_Quot_right(const ir_node *node);
704 void set_Quot_right(ir_node *node, ir_node *right);
705 ir_node *get_Quot_mem(ir_node *node);
706 void set_Quot_mem(ir_node *node, ir_node *mem);
707 ir_mode *get_Quot_resmode(const ir_node *node);
708 void set_Quot_resmode(ir_node *node, ir_mode *mode);
711 * Projection numbers for Quot: use for Proj nodes!
714 pn_Quot_M, /**< Memory result. */
715 pn_Quot_X_regular, /**< Execution result if no exception occurred. */
716 pn_Quot_X_except, /**< Execution result if exception occurred. */
717 pn_Quot_res, /**< Result of computation. */
718 pn_Quot_max /**< number of projections from a Quot */
719 } pn_Quot; /* Projection numbers for Quot. */
721 ir_node *get_DivMod_left(const ir_node *node);
722 void set_DivMod_left(ir_node *node, ir_node *left);
723 ir_node *get_DivMod_right(const ir_node *node);
724 void set_DivMod_right(ir_node *node, ir_node *right);
725 ir_node *get_DivMod_mem(ir_node *node);
726 void set_DivMod_mem(ir_node *node, ir_node *mem);
727 ir_mode *get_DivMod_resmode(const ir_node *node);
728 void set_DivMod_resmode(ir_node *node, ir_mode *mode);
731 * Projection numbers for DivMod: use for Proj nodes!
734 pn_DivMod_M, /**< Memory result. */
735 pn_DivMod_X_regular, /**< Execution result if no exception occurred. */
736 pn_DivMod_X_except, /**< Execution result if exception occurred. */
737 pn_DivMod_res_div, /**< Result of computation a / b. */
738 pn_DivMod_res_mod, /**< Result of computation a % b. */
739 pn_DivMod_max /**< number of projections from a DivMod */
740 } pn_DivMod; /* Projection numbers for DivMod. */
742 ir_node *get_Div_left(const ir_node *node);
743 void set_Div_left(ir_node *node, ir_node *left);
744 ir_node *get_Div_right(const ir_node *node);
745 void set_Div_right(ir_node *node, ir_node *right);
746 ir_node *get_Div_mem(ir_node *node);
747 void set_Div_mem(ir_node *node, ir_node *mem);
748 ir_mode *get_Div_resmode(const ir_node *node);
749 void set_Div_resmode(ir_node *node, ir_mode *mode);
752 * Projection numbers for Div: use for Proj nodes!
755 pn_Div_M, /**< Memory result. */
756 pn_Div_X_regular, /**< Execution result if no exception occurred. */
757 pn_Div_X_except, /**< Execution result if exception occurred. */
758 pn_Div_res, /**< Result of computation. */
759 pn_Div_max /**< number of projections from a Div */
760 } pn_Div; /* Projection numbers for Div. */
762 ir_node *get_Mod_left(const ir_node *node);
763 void set_Mod_left(ir_node *node, ir_node *left);
764 ir_node *get_Mod_right(const ir_node *node);
765 void set_Mod_right(ir_node *node, ir_node *right);
766 ir_node *get_Mod_mem(ir_node *node);
767 void set_Mod_mem(ir_node *node, ir_node *mem);
768 ir_mode *get_Mod_resmode(const ir_node *node);
769 void set_Mod_resmode(ir_node *node, ir_mode *mode);
772 * Projection numbers for Mod: use for Proj nodes!
775 pn_Mod_M, /**< Memory result. */
776 pn_Mod_X_regular, /**< Execution result if no exception occurred. */
777 pn_Mod_X_except, /**< Execution result if exception occurred. */
778 pn_Mod_res, /**< Result of computation. */
779 pn_Mod_max /**< number of projections from a Mod */
780 } pn_Mod; /* Projection numbers for Mod. */
782 ir_node *get_Abs_op(const ir_node *node);
783 void set_Abs_op(ir_node *node, ir_node *op);
785 ir_node *get_And_left(const ir_node *node);
786 void set_And_left(ir_node *node, ir_node *left);
787 ir_node *get_And_right(const ir_node *node);
788 void set_And_right(ir_node *node, ir_node *right);
790 ir_node *get_Or_left(const ir_node *node);
791 void set_Or_left(ir_node *node, ir_node *left);
792 ir_node *get_Or_right(const ir_node *node);
793 void set_Or_right(ir_node *node, ir_node *right);
795 ir_node *get_Eor_left(const ir_node *node);
796 void set_Eor_left(ir_node *node, ir_node *left);
797 ir_node *get_Eor_right(const ir_node *node);
798 void set_Eor_right(ir_node *node, ir_node *right);
800 ir_node *get_Not_op(const ir_node *node);
801 void set_Not_op(ir_node *node, ir_node *op);
804 * Projection numbers for Cmp are defined several times.
805 * The bit patterns are used for various tests, so don't change.
806 * The "unordered" values are possible results of comparing
807 * floating point numbers.
808 * Note that the encoding is imported, so do NOT change the order.
811 pn_Cmp_False = 0, /**< false */
812 pn_Cmp_Eq = 1, /**< equal */
813 pn_Cmp_Lt = 2, /**< less */
814 pn_Cmp_Le = pn_Cmp_Eq|pn_Cmp_Lt, /**< less or equal */
815 pn_Cmp_Gt = 4, /**< greater */
816 pn_Cmp_Ge = pn_Cmp_Eq|pn_Cmp_Gt, /**< greater or equal */
817 pn_Cmp_Lg = pn_Cmp_Lt|pn_Cmp_Gt, /**< less or greater */
818 pn_Cmp_Leg = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
819 pn_Cmp_Uo = 8, /**< unordered */
820 pn_Cmp_Ue = pn_Cmp_Uo|pn_Cmp_Eq, /**< unordered or equal */
821 pn_Cmp_Ul = pn_Cmp_Uo|pn_Cmp_Lt, /**< unordered or less */
822 pn_Cmp_Ule = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
823 pn_Cmp_Ug = pn_Cmp_Uo|pn_Cmp_Gt, /**< unordered or greater */
824 pn_Cmp_Uge = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
825 pn_Cmp_Ne = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
826 pn_Cmp_True = 15 /**< true */
827 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for JNI interface */
828 } pn_Cmp; /* Projection numbers for Cmp */
829 /* #define not_mask pn_Cmp_Leg */
831 /** returns the pnc name from an pnc constant */
832 const char *get_pnc_string(int pnc);
834 /** Calculates the negated (Complement(R)) pnc condition. */
835 int get_negated_pnc(int pnc, ir_mode *mode);
837 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
838 int get_inversed_pnc(int pnc);
840 /** An alternative name for get_inversed_pnc() that can be better memorized. */
841 #define get_mirrored_pnc(pnc) get_inversed_pnc(pnc)
843 ir_node *get_Cmp_left(const ir_node *node);
844 void set_Cmp_left(ir_node *node, ir_node *left);
845 ir_node *get_Cmp_right(const ir_node *node);
846 void set_Cmp_right(ir_node *node, ir_node *right);
848 ir_node *get_Shl_left(const ir_node *node);
849 void set_Shl_left(ir_node *node, ir_node *left);
850 ir_node *get_Shl_right(const ir_node *node);
851 void set_Shl_right(ir_node *node, ir_node *right);
853 ir_node *get_Shr_left(const ir_node *node);
854 void set_Shr_left(ir_node *node, ir_node *left);
855 ir_node *get_Shr_right(const ir_node *node);
856 void set_Shr_right(ir_node *node, ir_node *right);
858 ir_node *get_Shrs_left(const ir_node *node);
859 void set_Shrs_left(ir_node *node, ir_node *left);
860 ir_node *get_Shrs_right(const ir_node *node);
861 void set_Shrs_right(ir_node *node, ir_node *right);
863 ir_node *get_Rot_left(const ir_node *node);
864 void set_Rot_left(ir_node *node, ir_node *left);
865 ir_node *get_Rot_right(const ir_node *node);
866 void set_Rot_right(ir_node *node, ir_node *right);
868 ir_node *get_Conv_op(const ir_node *node);
869 void set_Conv_op(ir_node *node, ir_node *op);
870 int get_Conv_strict(ir_node *node);
871 void set_Conv_strict(ir_node *node, int flag);
873 /* Does Cast need a mem operator?
874 * Cast should only depend on the type, not on the state of an
875 * entity. But: we initialize various fields after Alloc, that
876 * are accessed in the cast. This required some precaution, to
877 * get the right memory into the Loads generated from the cast.
879 ir_node *get_Cast_op(const ir_node *node);
880 void set_Cast_op(ir_node *node, ir_node *op);
881 ir_type *get_Cast_type(ir_node *node);
882 void set_Cast_type(ir_node *node, ir_type *to_tp);
884 /** Checks for upcast.
886 * Returns true if the Cast node casts a class type to a super type.
887 * Works also for pointers to classes (recursively).
889 * Needs typeinfo calculated.
891 int is_Cast_upcast(ir_node *node);
893 /** Checks for downcast.
895 * Returns true if the Cast node casts a class type to a sub type.
896 * Works also for pointers to classes (recursively).
898 * Needs typeinfo calculated.
900 int is_Cast_downcast(ir_node *node);
903 /** Returns true if n is Phi or Filter in interprocedural_view.
904 Returns false if irg in phase building and the Phi has zero
905 predecessors: it's a Phi0. */
906 int is_Phi(const ir_node *n);
907 /** Returns true if irg in phase building and the Phi has zero
908 predecessors. It's a Phi0 then. */
909 int is_Phi0(const ir_node *n);
910 /* These routines also work for Filter nodes in interprocedural view. */
911 ir_node **get_Phi_preds_arr(ir_node *node);
912 int get_Phi_n_preds(const ir_node *node);
913 ir_node *get_Phi_pred(const ir_node *node, int pos);
914 void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
916 ir_node *get_Filter_pred(ir_node *node);
917 void set_Filter_pred(ir_node *node, ir_node *pred);
918 long get_Filter_proj(ir_node *node);
919 void set_Filter_proj(ir_node *node, long proj);
920 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
921 * @@@ Maybe better: arity is zero if no cg preds. */
922 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
923 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
924 int get_Filter_n_cg_preds(ir_node *node);
925 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
927 /** Return true if parameter is a memory operation.
929 * A memory operation is an operation that changes the
930 * memory. I.e., a Load or a Store operation.
932 int is_memop(ir_node *node);
933 ir_node *get_memop_mem(ir_node *node);
934 void set_memop_mem(ir_node *node, ir_node *mem);
935 ir_node *get_memop_ptr(ir_node *node);
936 void set_memop_ptr(ir_node *node, ir_node *ptr);
939 * Projection numbers for Load: use for Proj nodes!
942 pn_Load_M, /**< Memory result. */
943 pn_Load_X_regular, /**< Execution result if no exception occurred. */
944 pn_Load_X_except, /**< Execution result if exception occurred. */
945 pn_Load_res, /**< Result of load operation. */
946 pn_Load_max /**< number of projections from a Load */
947 } pn_Load; /* Projection numbers for Load. */
949 ir_node *get_Load_mem(ir_node *node);
950 void set_Load_mem(ir_node *node, ir_node *mem);
951 ir_node *get_Load_ptr(ir_node *node);
952 void set_Load_ptr(ir_node *node, ir_node *ptr);
953 ir_mode *get_Load_mode(ir_node *node);
954 void set_Load_mode(ir_node *node, ir_mode *mode);
955 ir_volatility get_Load_volatility(ir_node *node);
956 void set_Load_volatility(ir_node *node, ir_volatility volatility);
957 ir_align get_Load_align(ir_node *node);
958 void set_Load_align(ir_node *node, ir_align align);
961 * Projection numbers for Store: use for Proj nodes!
964 pn_Store_M, /**< Memory result. */
965 pn_Store_X_regular, /**< Execution result if no exception occurred. */
966 pn_Store_X_except, /**< Execution result if exception occurred. */
967 pn_Store_max /**< number of projections from a Store */
968 } pn_Store; /* Projection numbers for Store. */
970 ir_node *get_Store_mem(ir_node *node);
971 void set_Store_mem(ir_node *node, ir_node *mem);
972 ir_node *get_Store_ptr(ir_node *node);
973 void set_Store_ptr(ir_node *node, ir_node *ptr);
974 ir_node *get_Store_value(ir_node *node);
975 void set_Store_value(ir_node *node, ir_node *value);
976 ir_volatility get_Store_volatility(ir_node *node);
977 void set_Store_volatility(ir_node *node, ir_volatility volatility);
978 ir_align get_Store_align(ir_node *node);
979 void set_Store_align(ir_node *node, ir_align align);
982 * Projection numbers for Alloc: use for Proj nodes!
985 pn_Alloc_M, /**< Memory result. */
986 pn_Alloc_X_regular, /**< Execution result if no exception occurred. */
987 pn_Alloc_X_except, /**< Execution result if exception occurred. */
988 pn_Alloc_res, /**< Result of allocation. */
989 pn_Alloc_max /**< number of projections from an Alloc */
990 } pn_Alloc; /* Projection numbers for Alloc. */
992 ir_node *get_Alloc_mem(ir_node *node);
993 void set_Alloc_mem(ir_node *node, ir_node *mem);
994 ir_node *get_Alloc_size(ir_node *node);
995 void set_Alloc_size(ir_node *node, ir_node *size);
996 ir_type *get_Alloc_type(ir_node *node);
997 void set_Alloc_type(ir_node *node, ir_type *tp);
999 /** The allocation place. */
1001 stack_alloc, /**< Alloc allocates the object on the stack. */
1002 heap_alloc /**< Alloc allocates the object on the heap. */
1005 where_alloc get_Alloc_where(ir_node *node);
1006 void set_Alloc_where(ir_node *node, where_alloc where);
1008 ir_node *get_Free_mem(ir_node *node);
1009 void set_Free_mem(ir_node *node, ir_node *mem);
1010 ir_node *get_Free_ptr(ir_node *node);
1011 void set_Free_ptr(ir_node *node, ir_node *ptr);
1012 ir_node *get_Free_size(ir_node *node);
1013 void set_Free_size(ir_node *node, ir_node *size);
1014 ir_type *get_Free_type(ir_node *node);
1015 void set_Free_type(ir_node *node, ir_type *tp);
1017 where_alloc get_Free_where(ir_node *node);
1018 void set_Free_where(ir_node *node, where_alloc where);
1020 ir_node **get_Sync_preds_arr(ir_node *node);
1021 int get_Sync_n_preds(ir_node *node);
1022 ir_node *get_Sync_pred(ir_node *node, int pos);
1023 void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
1024 void add_Sync_pred(ir_node *node, ir_node *pred);
1026 /** Returns the source language type of a Proj node.
1027 * Must be an atomic type. Mode of type must be mode of node.
1029 ir_type *get_Proj_type(ir_node *node);
1031 /** Return the predecessor of a Proj node. */
1032 ir_node *get_Proj_pred(const ir_node *node);
1033 void set_Proj_pred(ir_node *node, ir_node *pred);
1034 /** Return the projection number of a Proj node. */
1035 long get_Proj_proj(const ir_node *node);
1036 void set_Proj_proj(ir_node *node, long proj);
1038 ir_node **get_Tuple_preds_arr(ir_node *node);
1039 int get_Tuple_n_preds(ir_node *node);
1040 ir_node *get_Tuple_pred(ir_node *node, int pos);
1041 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
1043 ir_node *get_Id_pred(ir_node *node);
1044 void set_Id_pred(ir_node *node, ir_node *pred);
1046 /** Confirm has a single result and returns 'value' unchanged.
1047 * The node expresses a restriction on 'value':
1048 * 'value' 'cmp' 'bound' == true. */
1049 ir_node *get_Confirm_value(ir_node *node);
1050 void set_Confirm_value(ir_node *node, ir_node *value);
1051 ir_node *get_Confirm_bound(ir_node *node);
1052 void set_Confirm_bound(ir_node *node, ir_node *bound);
1053 pn_Cmp get_Confirm_cmp(const ir_node *node);
1054 void set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
1057 * Mux Support: Note that Psi nodes with one condition can be handled
1058 * like Mux nodes, and the access functions work as expected.
1060 ir_node *get_Mux_sel(ir_node *node);
1061 void set_Mux_sel(ir_node *node, ir_node *sel);
1062 ir_node *get_Mux_false(ir_node *node);
1063 void set_Mux_false(ir_node *node, ir_node *ir_false);
1064 ir_node *get_Mux_true (ir_node *node);
1065 void set_Mux_true (ir_node *node, ir_node *ir_true);
1067 ir_node *get_Psi_cond(ir_node *node, int pos);
1068 void set_Psi_cond(ir_node *node, int pos, ir_node *cond);
1069 ir_node *get_Psi_val(ir_node *node, int pos);
1070 void set_Psi_val(ir_node *node, int pos, ir_node *val);
1071 ir_node *get_Psi_default(ir_node *node);
1072 void set_Psi_default(ir_node *node, ir_node *val);
1073 int get_Psi_n_conds(ir_node *node);
1076 * Projection numbers for result of CopyB node: use for Proj nodes!
1079 pn_CopyB_M_regular = 0, /**< The memory result. */
1080 pn_CopyB_X_regular = 1, /**< Execution result if no exception occurred. */
1081 pn_CopyB_X_except = 2, /**< The control flow result branching to the exception handler */
1082 pn_CopyB_M_except = 3, /**< The memory result in case the runtime function terminated with
1084 pn_CopyB_max = 4 /**< number of projections from a CopyB */
1085 } pn_CopyB; /* Projection numbers for CopyB. */
1086 #define pn_CopyB_M pn_CopyB_M_regular
1088 ir_node *get_CopyB_mem(ir_node *node);
1089 void set_CopyB_mem(ir_node *node, ir_node *mem);
1090 ir_node *get_CopyB_dst(ir_node *node);
1091 void set_CopyB_dst(ir_node *node, ir_node *dst);
1092 ir_node *get_CopyB_src(ir_node *node);
1093 void set_CopyB_src(ir_node *node, ir_node *src);
1094 ir_type *get_CopyB_type(ir_node *node);
1095 void set_CopyB_type(ir_node *node, ir_type *data_type);
1098 * Projection numbers for result of InstOf node: use for Proj nodes!
1101 pn_InstOf_M_regular = 0, /**< The memory result. */
1102 pn_InstOf_X_regular = 1, /**< Execution result if no exception occurred. */
1103 pn_InstOf_X_except = 2, /**< The control flow result branching to the exception handler */
1104 pn_InstOf_res = 3, /**< The checked object pointer. */
1105 pn_InstOf_M_except = 4, /**< The memory result in case the runtime function terminated with
1107 pn_InstOf_max = 5 /**< number of projections from an InstOf */
1109 #define pn_InstOf_M pn_InstOf_M_regular
1111 /** InstOf access */
1112 ir_type *get_InstOf_type(ir_node *node);
1113 void set_InstOf_type(ir_node *node, ir_type *type);
1114 ir_node *get_InstOf_store(ir_node *node);
1115 void set_InstOf_store(ir_node *node, ir_node *obj);
1116 ir_node *get_InstOf_obj(ir_node *node);
1117 void set_InstOf_obj(ir_node *node, ir_node *obj);
1120 * Projection numbers for Raise.
1123 pn_Raise_X = 0, /**< The control flow to the exception handler. */
1124 pn_Raise_M = 1, /**< The Memory result. */
1125 pn_Raise_max /**< number of projections from a Raise */
1126 } pn_Raise; /* Projection numbers for Raise. */
1128 ir_node *get_Raise_mem(ir_node *node);
1129 void set_Raise_mem(ir_node *node, ir_node *mem);
1130 ir_node *get_Raise_exo_ptr(ir_node *node); /* PoinTeR to EXception Object */
1131 void set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
1134 * Projection numbers for result of Bound node: use for Proj nodes!
1137 pn_Bound_M = 0, /**< The memory result. */
1138 pn_Bound_X_regular = 1, /**< Execution result if no exception occurred. */
1139 pn_Bound_X_except = 2, /**< The control flow result branching to the exception handler */
1140 pn_Bound_res = 3, /**< The checked index. */
1141 pn_Bound_max = 4 /**< number of projections from a Bound */
1144 /** Returns the memory input of a Bound operation. */
1145 ir_node *get_Bound_mem(ir_node *bound);
1146 void set_Bound_mem(ir_node *bound, ir_node *mem);
1148 /** Returns the index input of a Bound operation. */
1149 ir_node *get_Bound_index(ir_node *bound);
1150 void set_Bound_index(ir_node *bound, ir_node *idx);
1152 /** Returns the lower bound input of a Bound operation. */
1153 ir_node *get_Bound_lower(ir_node *bound);
1154 void set_Bound_lower(ir_node *bound, ir_node *lower);
1156 /** Returns the upper bound input of a Bound operation. */
1157 ir_node *get_Bound_upper(ir_node *bound);
1158 void set_Bound_upper(ir_node *bound, ir_node *upper);
1160 /** Return the operand of a Pin node. */
1161 ir_node *get_Pin_op(const ir_node *pin);
1162 void set_Pin_op(ir_node *pin, ir_node *node);
1164 /** A input/output constraint attribute */
1166 unsigned pos; /**< The inputs/output position for this constraint. */
1167 ident *constraint; /**< The constraint for this input/output. */
1168 } ir_asm_constraint;
1170 /** Return the assembler text of an ASM pseudo node. */
1171 ident *get_ASM_text(const ir_node *node);
1172 /** Return the number of input constraints for an ASM node. */
1173 int get_ASM_n_input_constraints(const ir_node *node);
1174 /** Return the input constraints for an ASM node. */
1175 const ir_asm_constraint *get_ASM_input_constraints(const ir_node *node);
1176 /** Return the number of output constraints for an ASM node. */
1177 int get_ASM_n_output_constraints(const ir_node *node);
1178 /** Return the output constraints for an ASM node. */
1179 const ir_asm_constraint *get_ASM_output_constraints(const ir_node *node);
1180 /** Return the number of clobbered registers for an ASM node. */
1181 int get_ASM_n_clobbers(const ir_node *node);
1182 /** Return the list of clobbered registers for an ASM node. */
1183 ident **get_ASM_clobbers(const ir_node *node);
1187 * NAME Auxiliary routines
1191 /** Returns operand of node if node is a Proj. */
1192 ir_node *skip_Proj(ir_node *node);
1193 /** Returns operand of node if node is a Proj. */
1194 const ir_node *skip_Proj_const(const ir_node *node);
1195 /** Returns operand of node if node is a Id. */
1196 ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
1197 /** Returns corresponding operand of Tuple if node is a Proj from
1199 ir_node *skip_Tuple(ir_node *node);
1200 /** returns operand of node if node is a Cast. */
1201 ir_node *skip_Cast(ir_node *node);
1202 /** Returns operand of node if node is a Confirm */
1203 ir_node *skip_Confirm(ir_node *node);
1204 /** Skip all high-level Operations. */
1205 ir_node *skip_HighLevel(ir_node *node);
1206 /** Returns true if irn is a Const node. */
1207 int is_Const(const ir_node *node);
1208 /** Returns true if a node is a Conv node. */
1209 int is_Conv(const ir_node *node);
1210 /** Returns true if a node is a Cast node. */
1211 int is_Cast(const ir_node *node);
1212 /** Returns true if node is a Bad node. */
1213 int is_Bad(const ir_node *node);
1214 /** Returns true if node is a NoMem node. */
1215 int is_NoMem(const ir_node *node);
1216 /** Returns true if node is a Start node. */
1217 int is_Start(const ir_node *node);
1218 /** Returns true if node is a Minus node. */
1219 int is_Minus(const ir_node *node);
1220 /** Returns true if node is a Mod node. */
1221 int is_Mod(const ir_node *node);
1222 /** Returns true if node is a Div node. */
1223 int is_Div(const ir_node *node);
1224 /** Returns true if node is a DivMod node. */
1225 int is_DivMod(const ir_node *node);
1226 /** Returns true if node is a Quot node. */
1227 int is_Quot(const ir_node *node);
1228 /** Returns true if node is an Add node. */
1229 int is_Add(const ir_node *node);
1230 /** Returns true if node is an And node. */
1231 int is_And(const ir_node *node);
1232 /** Returns true if node is an Or node. */
1233 int is_Or(const ir_node *node);
1234 /** Returns true if node is an Eor node. */
1235 int is_Eor(const ir_node *node);
1236 /** Returns true if node is a Sub node. */
1237 int is_Sub(const ir_node *node);
1238 /** Returns true if node is a Not node. */
1239 int is_Not(const ir_node *node);
1240 /** Returns true if node is a Shl node. */
1241 int is_Shl(const ir_node *node);
1242 /** Returns true if node is a Shr node. */
1243 int is_Shr(const ir_node *node);
1244 /** Returns true if node is a Shrs node. */
1245 int is_Shrs(const ir_node *node);
1246 /** Returns true if node is a Rot node. */
1247 int is_Rot(const ir_node *node);
1248 /** Returns true if node is a Psi node. */
1249 int is_Psi(const ir_node *node);
1250 /** Returns true if node is a Tuple node. */
1251 int is_Tuple(const ir_node *node);
1252 /** Returns true if the node is not a Block */
1253 int is_no_Block(const ir_node *node);
1254 /** Returns true if the node is a Block */
1255 int is_Block(const ir_node *node);
1256 /** Returns true if node is an Unknown node. */
1257 int is_Unknown(const ir_node *node);
1258 /** Returns true if node is a Return node. */
1259 int is_Return(const ir_node *node);
1260 /** Returns true if node is a Call node. */
1261 int is_Call(const ir_node *node);
1262 /** Returns true if node is a Sel node. */
1263 int is_Sel(const ir_node *node);
1264 /** Returns true if node is a Mul node. */
1265 int is_Mul(const ir_node *node);
1266 /** Returns true if node is a Mulh node. */
1267 int is_Mulh(const ir_node *node);
1268 /** Returns true if node is a Mux node or a Psi with only one condition. */
1269 int is_Mux(const ir_node *node);
1270 /** Returns true if node is a Load node. */
1271 int is_Load(const ir_node *node);
1272 /** Returns true if node is a Store node. */
1273 int is_Store(const ir_node *node);
1274 /** Returns true if node is a Sync node. */
1275 int is_Sync(const ir_node *node);
1276 /** Returns true if node is a Confirm node. */
1277 int is_Confirm(const ir_node *node);
1278 /** Returns true if node is a Pin node. */
1279 int is_Pin(const ir_node *node);
1280 /** Returns true if node is a SymConst node. */
1281 int is_SymConst(const ir_node *node);
1282 /** Returns true if node is a Cond node. */
1283 int is_Cond(const ir_node *node);
1284 /** Returns true of node is a CopyB node */
1285 int is_CopyB(const ir_node *node);
1286 /** Returns true if node is a Cmp node. */
1287 int is_Cmp(const ir_node *node);
1288 /** Returns true if node is an Alloc node */
1289 int is_Alloc(const ir_node *node);
1290 /** Returns true if a node is a Jmp node */
1291 int is_Jmp(const ir_node *node);
1292 /** Returns true if a node is a Raise node */
1293 int is_Raise(const ir_node *node);
1294 /** Returns true if a node is an ASM node */
1295 int is_ASM(const ir_node *node);
1296 /** Returns true if node is a Proj node or a Filter node in
1297 * intraprocedural view */
1298 int is_Proj(const ir_node *node);
1299 /** Returns true if the operation manipulates control flow:
1300 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1301 int is_cfop(const ir_node *node);
1303 /** Returns true if the operation manipulates interprocedural control flow:
1304 CallBegin, EndReg, EndExcept */
1305 int is_ip_cfop(const ir_node *node);
1306 /** Returns true if the operation can change the control flow because
1307 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1308 Bad. Raise is not fragile, but a unconditional jump. */
1309 int is_fragile_op(const ir_node *node);
1310 /** Returns the memory operand of fragile operations. */
1311 ir_node *get_fragile_op_mem(ir_node *node);
1312 /** Returns the result mode of a Div operation. */
1313 ir_mode *get_divop_resmod(const ir_node *node);
1315 /** Returns true if the operation is a forking control flow
1316 * operation: Cond. */
1317 int is_irn_forking(const ir_node *node);
1319 /** Return the type associated with the value produced by n
1320 * if the node remarks this type as it is the case for
1321 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1322 ir_type *get_irn_type(ir_node *n);
1324 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1326 ir_type *get_irn_type_attr(ir_node *n);
1328 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1329 ir_entity *get_irn_entity_attr(ir_node *n);
1331 /** Returns non-zero for constant-like nodes. */
1332 int is_irn_constlike(const ir_node *node);
1335 * Returns non-zero for nodes that must be always optimized
1336 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1338 int is_irn_always_opt(const ir_node *node);
1341 * Returns non-zero for nodes that are allowed to have keep-alives and
1342 * are neither Block nor PhiM.
1344 int is_irn_keep(const ir_node *node);
1347 * Returns non-zero for nodes that are always placed in the start block.
1349 int is_irn_start_block_placed(const ir_node *node);
1352 * Returns non-zero for nodes that are machine operations.
1354 int is_irn_machine_op(const ir_node *node);
1357 * Returns non-zero for nodes that are machine operands.
1359 int is_irn_machine_operand(const ir_node *node);
1362 * Returns non-zero for nodes that have the n'th user machine flag set.
1364 int is_irn_machine_user(const ir_node *node, unsigned n);
1367 * A type to express conditional jump predictions.
1370 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1371 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1372 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1373 } cond_jmp_predicate;
1375 /** Gets the string representation of the jump prediction .*/
1376 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1378 /** Returns the conditional jump prediction of a Cond node. */
1379 cond_jmp_predicate get_Cond_jmp_pred(const ir_node *cond);
1381 /** Sets a new conditional jump prediction. */
1382 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1385 * Access custom node data.
1386 * The data must have been registered with
1387 * register_additional_node_data() before.
1388 * @param node The ir node to get the data from.
1389 * @param type The type of the data you registered.
1390 * @param off The value returned by register_additional_node_data().
1391 * @return A pointer of type @p type.
1393 #define get_irn_data(node,type,off) \
1394 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1397 * Get the pointer to the node some custom data belongs to.
1398 * @param data The pointer to the custom data.
1399 * @param off The number as returned by register_additional_node_data().
1400 * @return A pointer to the ir node the custom data belongs to.
1402 #define get_irn_data_base(data,off) \
1403 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1406 * Request additional data to be allocated with an ir node.
1407 * @param size The size of the additional data required.
1408 * @return A positive number, if the operation was successful, which
1409 * must be passed to the access macro get_irn_data(), 0 if the
1410 * registration failed.
1412 unsigned firm_register_additional_node_data(unsigned size);
1415 * Return a pointer to the node attributes.
1416 * Needed for user-defined nodes.
1418 void *get_irn_generic_attr(ir_node *node);
1419 const void *get_irn_generic_attr_const(const ir_node *node);
1422 * Returns the unique node index for the node in its graph.
1423 * This index is used to access phase information for this node.
1425 unsigned get_irn_idx(const ir_node *node);
1428 * Sets the debug information of a node.
1430 * @param n The node.
1431 * @param db The debug info.
1433 void set_irn_dbg_info(ir_node *n, dbg_info *db);
1436 * Returns the debug information of an node.
1438 * @param n The node.
1440 dbg_info *get_irn_dbg_info(const ir_node *n);
1442 /*-----------------------------------------------------------------*/
1444 /*-----------------------------------------------------------------*/
1447 /** Debug print the node.
1449 * Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
1450 * is set. Else does nothing. */
1451 void dump_irn(ir_node *n);
1453 /*@}*/ /* end of ir_node group definition */