2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Representation of an intermediate operation.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
26 #ifndef FIRM_IR_IRNODE_H
27 #define FIRM_IR_IRNODE_H
31 #include "firm_common.h"
39 * @author Martin Trapp, Christian Schaefer
41 * Declarations of an ir node.
45 * @defgroup ir_node Declarations of an ir node.
47 * The type definition of ir_node is also in irgraph.h to resolve
48 * recursion between irnode.h and irgraph.h
50 * ir_node - a datatype representing a Firm node
52 * The common fields are:
54 * - firm_kind - A firm_kind tag containing k_type. This is useful
55 * for dynamically checking whether a node is a ir_node.
56 * - arity - The number of predecessors in the Firm graph.
57 * - in - A list with the predecessors in the Firm graph. There are
58 * routines to access individual elements and to obtain the
59 * array. The method returning the array should not be used.
60 * - mode - The mode of the node. There are routines to get the mode
61 * but also to access the mode's fields directly.
62 * - opcode - The opcode of the node. There are routines to get the opcode
63 * but also to access the opcode's fields directly.
64 * - node_nr - A unique number for the node. Available only if debugging
70 * Some projection numbers must be always equal to support automatic phi construction
73 pn_Generic_M_regular = 0, /**< The memory result. */
74 pn_Generic_X_regular = 1, /**< Execution result if no exception occurred. */
75 pn_Generic_X_except = 2, /**< The control flow result branching to the exception handler */
76 pn_Generic_other = 3 /**< First free projection number */
80 * Checks whether a pointer points to a ir node.
82 * @param thing an arbitrary pointer
83 * @return non-zero if the thing is a ir mode, else zero
85 int is_ir_node (const void *thing);
88 * Returns the number of predecessors without the block predecessor.
90 * @param node the IR-node
92 int get_irn_arity (const ir_node *node);
93 int get_irn_intra_arity(const ir_node *node);
94 int get_irn_inter_arity(const ir_node *node);
96 /** Replaces the old in array by a new one that will contain the ins given in
97 the parameters. Conserves the block predecessor. It copies the array passed.
98 This function is necessary to adjust in arrays of blocks, calls and phis.
99 Assumes that current_ir_graph is set to the graph containing "node".
100 "in" must contain all predecessors except the block that are required for
102 void set_irn_in(ir_node *node, int arity, ir_node *in[]);
104 /* to iterate through the predecessors without touching the array. No
105 order of predecessors guaranteed.
106 To iterate over the operands iterate from 0 to i < get_irn_arity(),
107 to iterate including the Block predecessor iterate from i = -1 to
108 i < get_irn_arity. */
109 /* Access predecessor n */
112 * Get the n-th predecessor of a node.
113 * This function removes Id predecessors.
114 * This function automatically handles intra- and interprocedural views.
116 ir_node *get_irn_n(const ir_node *node, int n);
119 * Add a artificial dependency to the node.
120 * The dependency is only inserted if it is not there already.
121 * @param node The node.
122 * @param dep The dependency target.
123 * @return The index in the array (get_irn_dep() with that index returns @p dep).
125 int add_irn_dep(ir_node *node, ir_node *dep);
128 * Copy all dependencies from a node to another.
129 * @param tgt The node which should be enriched.
130 * @param src The node whose dependencies shall be copied.
132 void add_irn_deps(ir_node *tgt, ir_node *src);
135 * Get the length of the dependency array.
136 * @param node The node.
137 * @return The length of the dependency array or 0 if it has not yet been allocated.
139 int get_irn_deps(const ir_node *node);
142 * Get an entry of the dependency array.
143 * @param node The node.
144 * @param pos The position.
145 * @return The node at that position.
147 ir_node *get_irn_dep(const ir_node *node, int pos);
150 * Set an entry of the dependency array.
151 * @param node The node.
152 * @param pos The position.
153 * @param dep The dependency target.
155 void set_irn_dep(ir_node *node, int pos, ir_node *dep);
159 * Get the n-th predecessor of a node in intraprocedural view.
160 * Can be used always if it's know that node is not a split one.
162 ir_node *get_irn_intra_n(const ir_node *node, int n);
165 * Get the n-th predecessor of a node in interprocedural view.
167 ir_node *get_irn_inter_n(const ir_node *node, int n);
169 /** Replace the n-th predecessor of a node with a new one. */
170 void set_irn_n(ir_node *node, int n, ir_node *in);
172 * Appends a new predecessor to a node. This only works for nodes with
174 * @returns the number of the new input
176 int add_irn_n(ir_node *node, ir_node *in);
177 /* Remove predecessor i from Sync n */
178 void del_Sync_n(ir_node *n, int i);
179 /* Sets the mode struct of node. */
180 void set_irn_mode(ir_node *node, ir_mode *mode);
181 /** Gets the mode struct of a node. */
182 ir_mode *get_irn_mode(const ir_node *node);
183 /** Gets the mode-enum modecode. */
184 modecode get_irn_modecode(const ir_node *node);
185 /** Gets the ident for a string representation of the mode .*/
186 ident *get_irn_modeident(const ir_node *node);
187 /** Gets the string representation of the mode .*/
188 const char *get_irn_modename(const ir_node *node);
189 /** Gets the opcode struct of the node. */
190 ir_op *get_irn_op(const ir_node *node);
191 /** Sets the opcode struct of the node. */
192 void set_irn_op(ir_node *node, ir_op *op);
193 /** Gets the opcode-enum of the node. */
194 unsigned get_irn_opcode(const ir_node *node);
195 /** Get the string representation of the opcode. */
196 const char *get_irn_opname(const ir_node *node);
197 /** Get the ident for a string representation of the opcode. */
198 ident *get_irn_opident(const ir_node *node);
199 /** If arg is an argument of the node, returns it's position, -1 otherwise */
200 int get_irn_pred_pos(ir_node *node, ir_node *arg);
201 /** Gets the visited counter of a node. */
202 unsigned long get_irn_visited(const ir_node *node);
203 /** Sets the visited counter of a node. */
204 void set_irn_visited(ir_node *node, unsigned long visited);
205 /** Sets visited to get_irg_visited(current_ir_graph). */
206 void mark_irn_visited(ir_node *node);
207 /** Returns 1 if visited < get_irg_visited(current_ir_graph). */
208 int irn_not_visited(const ir_node *node);
209 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
210 int irn_visited(const ir_node *node);
213 * Sets the link of a node.
214 * Only allowed if the graph is NOT in phase_building.
216 void set_irn_link(ir_node *node, void *link);
218 /** Returns the link of a node. */
219 void *get_irn_link(const ir_node *node);
221 /** Returns the ir_graph this node belongs to. */
222 ir_graph *get_irn_irg(const ir_node *node);
224 /** Outputs a unique number for this node if libFIRM is compiled for
225 debugging, (configure with --enable-debug) else returns address
226 of node cast to long. */
227 long get_irn_node_nr(const ir_node *node);
229 /** Returns the pinned state of a node.
231 * Returns whether the node _always_ must be pinned.
232 * I.e., the node is not floating after global cse.
234 * @returns Either state op_pin_state_pinned or op_pin_state_floats.
236 op_pin_state get_irn_pinned(const ir_node *node);
238 /** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
239 void set_irn_pinned(ir_node *node, op_pin_state state);
241 /** Returns whether the node is currently pinned.
243 * If get_irn_pinned returns op_pin_state_floats and the graph the
244 * node belongs to is in state op_poin_state_floats then this function
245 * returns 'floats', else 'pinned'.
247 op_pin_state is_irn_pinned_in_irg(const ir_node *node);
250 * IR node constructor.
251 * Create a new IR node in irg, with an op, mode, arity and
252 * some incoming IR nodes.
253 * This constructor is used in every specific IR node constructor.
255 * @param db Debug info.
256 * @param irg IR-graph on with this new node should be constructed.
257 * @param block The block the new node belongs to
258 * @param op The opcode of the new node.
259 * @param mode The mode of the new node.
260 * @param arity The arity of the new node, <0 if can be changed dynamically.
261 * @param in An array of arity predecessor nodes.
264 new_ir_node(dbg_info *db,
273 * Return the block the node belongs to. This is only
274 * possible for pinned nodes or if the graph is in pinned state.
275 * Otherwise the block may be incorrect. This condition is
276 * now checked by an assertion.
278 * This works for all except Block. It can return Blocks or the Bad node.
280 * To express the difference to access routines that work for all
281 * nodes we use infix "nodes" and do not name this function
282 * get_irn_block(). */
283 ir_node *get_nodes_block (const ir_node *node);
285 /** Sets the Block of a node. */
286 void set_nodes_block (ir_node *node, ir_node *block);
289 * Return the MacroBlock the node belongs to. This is only
290 * possible for pinned nodes or if the graph is in pinned state.
291 * Otherwise the MacroBlock may be incorrect. This condition is
292 * now checked by an assertion.
294 * This works for all except Block. It can return Blocks or the Bad node.
296 * To express the difference to access routines that work for all
297 * nodes we use infix "nodes" and do not name this function
298 * get_irn_MacroBlock(). */
299 ir_node *get_nodes_MacroBlock(const ir_node *node);
302 * @function get_irn_block()
303 * @see get_nodes_block()
307 * Projection numbers for result of Start node: use for Proj nodes!
310 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
311 pn_Start_M, /**< Projection on the initial memory. */
312 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
313 pn_Start_P_globals, /**< Projection on the pointer to the data segment
314 containing _all_ global entities. Use for
315 position independent data/code access. */
316 pn_Start_P_tls, /**< Projection on the pointer to the thread local store
317 segment containing _all_thread local variables. */
318 pn_Start_T_args, /**< Projection on all arguments. */
319 pn_Start_P_value_arg_base, /**< Pointer to region of compound value arguments as defined by
320 type of this method. */
321 pn_Start_max /**< number of projections from a Start */
322 } pn_Start; /* Projection numbers for Start. */
324 /** Test whether arbitrary node is frame pointer.
326 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
327 * from Start. If so returns frame type, else Null. */
328 ir_type *is_frame_pointer(const ir_node *n);
330 /** Test whether arbitrary node is globals pointer.
332 * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
333 * from Start. If so returns global type, else Null. */
334 ir_type *is_globals_pointer(const ir_node *n);
336 /** Test whether arbitrary node is the thread local storage (tls) pointer.
338 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
339 * from Start. If so returns tls type, else Null. */
340 ir_type *is_tls_pointer(const ir_node *n);
342 /** Test whether arbitrary node is value arg base.
344 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
345 * from Start. If so returns 1, else 0. */
346 int is_value_arg_pointer(const ir_node *n);
348 /* @@@ no more supported */
349 ir_node **get_Block_cfgpred_arr(ir_node *node);
350 int get_Block_n_cfgpreds(const ir_node *node);
351 ir_node *get_Block_cfgpred(const ir_node *node, int pos);
352 void set_Block_cfgpred(ir_node *node, int pos, ir_node *pred);
353 /** Get the predecessor block.
355 * Returns the block corresponding to the predecessor pos of block.
357 * There are several ambiguities we resolve with this function:
358 * - The direct predecessor can be a Proj, which is not pinned.
359 * We walk from the predecessor to the next pinned node
360 * (skip_Proj) and return the block that node is in.
361 * - If we encounter the Bad node, this function does not return
362 * Start, but the Bad node.
364 ir_node *get_Block_cfgpred_block(const ir_node *node, int pos);
365 int get_Block_matured(const ir_node *node);
366 void set_Block_matured(ir_node *node, int matured);
368 /** A visited flag only for block nodes.
369 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
370 unsigned long get_Block_block_visited(const ir_node *node);
371 void set_Block_block_visited(ir_node *node, unsigned long visit);
374 * Marks a block as dead but do not replace it with a Bad node.
375 * Dead blocks are removed in the con
377 ir_node *set_Block_dead(ir_node *block);
378 int is_Block_dead(const ir_node *block);
380 /* For this current_ir_graph must be set. */
381 void mark_Block_block_visited(ir_node *node);
382 int Block_not_block_visited(const ir_node *node);
383 int Block_block_visited(const ir_node *node);
385 #ifdef INTERPROCEDURAL_VIEW
386 /* Set and remove interprocedural predecessors. If the interprocedural
387 * predecessors are removed, the node has the same predecessors in
389 * @@@ Maybe better: arity is zero if no cg preds. */
390 void set_Block_cg_cfgpred_arr(ir_node *node, int arity, ir_node *in[]);
391 void set_Block_cg_cfgpred(ir_node *node, int pos, ir_node *pred);
392 /* @@@ not supported */
393 ir_node **get_Block_cg_cfgpred_arr(ir_node *node);
394 /** Returns the number of interprocedural predecessors. 0 if none. */
395 int get_Block_cg_n_cfgpreds(const ir_node *node);
396 /** Return the interprocedural predecessor at position pos. */
397 ir_node *get_Block_cg_cfgpred(const ir_node *node, int pos);
398 /** Frees the memory allocated for interprocedural predecessors. */
399 void remove_Block_cg_cfgpred_arr(ir_node *node);
402 /** Returns the extended basic block a block belongs to. */
403 ir_extblk *get_Block_extbb(const ir_node *block);
404 /** Sets the extended basic block a block belongs to. */
405 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
406 /** Get the Macro Block header of a (sub-) block. */
407 ir_node *get_Block_MacroBlock(const ir_node *block);
408 /** Set the Macro Block header of a (sub-) block. */
409 void set_Block_MacroBlock(ir_node *block, ir_node *mbh);
410 /** Get the Macro Block header of a node. */
411 ir_node *get_irn_MacroBlock(const ir_node *n);
412 /** Returns the ir_graph this Block belongs to. */
413 ir_graph *get_Block_irg(const ir_node *block);
414 /** Returns non-zero if the block has an assigned label. */
415 int has_Block_label(const ir_node *block);
416 /** Returns the label of a Block. */
417 ir_label_t get_Block_label(const ir_node *block);
418 /** Sets a label to a block. */
419 void set_Block_label(ir_node *block, ir_label_t label);
420 /** Gets the head of the Phi list for this block. */
421 ir_node *get_Block_phis(const ir_node *block);
422 /** Sets the head of the Phi list for this block. */
423 void set_Block_phis(ir_node *block, ir_node *phi);
425 /** Return the number of Keep alive node. */
426 int get_End_n_keepalives(const ir_node *end);
427 /** Return the Keep alive node a position pos. */
428 ir_node *get_End_keepalive(const ir_node *end, int pos);
429 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
430 void add_End_keepalive(ir_node *end, ir_node *ka);
431 /** Set the Keep alive node at position pos. */
432 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
433 /** Set new keep-alives. */
434 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
435 /** Set new keep-alives from old keep-alives, skipping irn. */
436 void remove_End_keepalive(ir_node *end, ir_node *irn);
438 /** Some parts of the End node are allocated separately -- their memory
439 is not recovered by dead_node_elimination if a End node is dead.
440 free_End() frees these data structures. */
441 void free_End(ir_node *end);
443 /** Return the target address of an IJmp */
444 ir_node *get_IJmp_target(const ir_node *ijmp);
445 /** Sets the target address of an IJmp */
446 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
448 /* We distinguish three kinds of Cond nodes. These can be distinguished
449 by the mode of the selector operand and an internal flag of type cond_kind.
450 First we distinguish binary Conds and switch Conds.
451 A binary Cond has as selector a boolean value. Proj(0) projects the control
452 flow for case "False", Proj(1) the control flow for "True". A binary Cond
453 is recognized by the boolean selector.
454 The switch Cond has as selector an unsigned integer. It produces as result
455 an n+1 Tuple (cf0, ... , cfn) of control flows.
456 We differ two flavors of this Cond. The first, the dense Cond, passes
457 control along output i if the selector value is i, 0 <= i <= n. If the
458 selector value is >n it passes control along output n.
459 The second Cond flavor differences in the treatment of cases not specified in
460 the source program. It magically knows about the existence of Proj nodes.
461 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
462 exists. Else it passes control along output n (even if this Proj does not
463 exist.) This Cond we call "fragmentary". There is a special constructor
464 new_defaultProj that automatically sets the flavor.
465 The two switch flavors are distinguished by a flag of type cond_kind.
466 Default flavor is "dense"
469 dense, /**< Default. Missing Proj nodes are dead control flow. */
470 fragmentary /**< Special. No control flow optimizations allowed. Missing
471 Proj nodes mean default control flow, i.e., Proj(n). */
474 ir_node *get_Cond_selector(const ir_node *node);
475 void set_Cond_selector(ir_node *node, ir_node *selector);
476 cond_kind get_Cond_kind(const ir_node *node);
477 void set_Cond_kind(ir_node *node, cond_kind kind);
478 long get_Cond_defaultProj(const ir_node *node);
481 * Projection numbers for conditions.
484 pn_Cond_false, /**< Control flow if operand is "false". */
485 pn_Cond_true, /**< Control flow if operand is "true". */
486 pn_Cond_max /**< number of projections from a Cond */
487 } pn_Cond; /* Projection numbers for Cond. */
489 ir_node *get_Return_mem(const ir_node *node);
490 void set_Return_mem(ir_node *node, ir_node *mem);
491 ir_node **get_Return_res_arr(ir_node *node);
492 int get_Return_n_ress(const ir_node *node);
493 ir_node *get_Return_res(const ir_node *node, int pos);
494 void set_Return_res(ir_node *node, int pos, ir_node *res);
496 tarval *get_Const_tarval(const ir_node *node);
497 void set_Const_tarval(ir_node *node, tarval *con);
499 /** Return non-zero if the given Const node represents the 0 constant. */
500 int is_Const_null(const ir_node *node);
502 /** Return non-zero if the given Const node represents the 1 constant. */
503 int is_Const_one(const ir_node *node);
505 /** Return non-zero if the given Const node represents the constant with all bits set. */
506 int is_Const_all_one(const ir_node *node);
508 /** Returns the source language type of a Const node.
509 * Must be an atomic type. Mode of type must be mode of node.
511 ir_type *get_Const_type(ir_node *node);
513 /** Sets the source language type of a Const node. */
514 void set_Const_type(ir_node *node, ir_type *tp);
516 /** This enum names the three different kinds of symbolic Constants
517 represented by SymConst. The content of the attribute type_or_id
518 depends on this tag. Use the proper access routine after testing
521 symconst_type_tag, /**< The SymConst is a type tag for the given type.
522 symconst_symbol is type *. */
523 symconst_type_size, /**< The SymConst is the size of the given type.
524 symconst_symbol is type *. */
525 symconst_type_align, /**< The SymConst is the alignment of the given type.
526 symconst_symbol is type *. */
527 symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
528 by the linker. The pointer is represented by a string.
529 symconst_symbol is ident *. */
530 symconst_addr_ent, /**< The SymConst is a symbolic pointer to be filled in
531 by the linker. The pointer is represented by an entity.
532 symconst_symbol is entity *. */
533 symconst_ofs_ent, /**< The SymConst is the offset of its entity in the entities
535 symconst_enum_const, /**< The SymConst is a enumeration constant of an
537 symconst_label /**< The SymConst is a label address. */
540 /** Returns non-zero if s symconst kind has a type attribute */
541 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
543 /** Returns non-zero if s symconst kind has an ident attribute */
544 #define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)
546 /** Returns non-zero if s symconst kind has an entity attribute */
547 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
549 /** Returns non-zero if s symconst kind has an enum_const attribute */
550 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
552 /** Returns non-zero if s symconst kind has a label attribute */
553 #define SYMCONST_HAS_LABEL(kind) ((kind) == symconst_label)
555 /** SymConst attribute.
557 * This union contains the symbolic information represented by the node.
559 typedef union symconst_symbol {
560 ir_type *type_p; /**< The type of a SymConst. */
561 ident *ident_p; /**< The ident of a SymConst. */
562 ir_entity *entity_p; /**< The entity of a SymConst. */
563 ir_enum_const *enum_p; /**< The enumeration constant of a SymConst. */
564 ir_label_t label; /**< The label of a SymConst. */
567 /** Get the kind of the SymConst. */
568 symconst_kind get_SymConst_kind(const ir_node *node);
569 /** Set the kind of the SymConst. */
570 void set_SymConst_kind(ir_node *node, symconst_kind num);
572 /** Only to access SymConst of kind type_tag or size. Else assertion: */
573 ir_type *get_SymConst_type(ir_node *node);
574 void set_SymConst_type(ir_node *node, ir_type *tp);
576 /** Only to access SymConst of kind addr_name. Else assertion: */
577 ident *get_SymConst_name(const ir_node *node);
578 void set_SymConst_name(ir_node *node, ident *name);
580 /** Only to access SymConst of kind addr_ent. Else assertion: */
581 ir_entity *get_SymConst_entity(const ir_node *node);
582 void set_SymConst_entity(ir_node *node, ir_entity *ent);
584 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
585 ir_enum_const *get_SymConst_enum(const ir_node *node);
586 void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
588 /** Sets both: type and ptrinfo. Needed to treat the node independent of
589 its semantics. Does a memcpy for the memory sym points to. */
590 /* write 'union': firmjni then does not create a method... */
591 union symconst_symbol get_SymConst_symbol(const ir_node *node);
592 void set_SymConst_symbol(ir_node *node,
593 union symconst_symbol sym);
595 /** Only to access SymConst of kind symconst_label. Else assertion: */
596 ir_label_t get_SymConst_label(const ir_node *node);
597 void set_SymConst_label(ir_node *node, ir_label_t label);
600 /** Access the type of the value represented by the SymConst.
602 * Example: primitive type int for SymConst size. */
603 ir_type *get_SymConst_value_type(ir_node *node);
604 void set_SymConst_value_type(ir_node *node, ir_type *tp);
606 ir_node *get_Sel_mem(const ir_node *node);
607 void set_Sel_mem(ir_node *node, ir_node *mem);
608 ir_node *get_Sel_ptr(const ir_node *node); /* ptr to the object to select from */
609 void set_Sel_ptr(ir_node *node, ir_node *ptr);
610 ir_node **get_Sel_index_arr(ir_node *node);
611 int get_Sel_n_indexs(const ir_node *node);
612 ir_node *get_Sel_index(const ir_node *node, int pos);
613 void set_Sel_index(ir_node *node, int pos, ir_node *index);
614 ir_entity *get_Sel_entity(const ir_node *node); /* entity to select */
615 void set_Sel_entity (ir_node *node, ir_entity *ent);
618 * Projection numbers for result of Call node: use for Proj nodes!
621 pn_Call_M_regular = pn_Generic_M_regular, /**< The memory result. */
622 pn_Call_X_regular = pn_Generic_X_regular, /**< The control flow result when no exception occurs. */
623 pn_Call_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler. */
624 pn_Call_T_result = pn_Generic_other, /**< The tuple containing all (0, 1, 2, ...) results. */
625 pn_Call_M_except, /**< The memory result in case the called method terminated with
627 pn_Call_P_value_res_base, /**< A pointer to the memory region containing copied results
628 passed by value (for compound result types). */
629 pn_Call_max /**< number of projections from a Call */
630 } pn_Call; /* Projection numbers for Call. */
631 #define pn_Call_M pn_Call_M_regular
633 ir_node *get_Call_mem(const ir_node *node);
634 void set_Call_mem(ir_node *node, ir_node *mem);
635 ir_node *get_Call_ptr(const ir_node *node);
636 void set_Call_ptr(ir_node *node, ir_node *ptr);
637 ir_node **get_Call_param_arr(ir_node *node);
638 /** Gets the number of parameters of a call. */
639 int get_Call_n_params(const ir_node *node);
640 /** Gets the call parameter at position pos. */
641 ir_node *get_Call_param(const ir_node *node, int pos);
642 /** Sets the call parameter at position pos. */
643 void set_Call_param(ir_node *node, int pos, ir_node *param);
644 /** Gets the type of a call. */
645 ir_type *get_Call_type(ir_node *node);
646 /** Sets the type of a call. */
647 void set_Call_type(ir_node *node, ir_type *tp);
648 /** Gets the arity of a call. Identical to get_Call_n_params(). */
649 int get_Call_arity(const ir_node *node);
651 /** Set, get and remove the callee information for a Call node.
653 * The callee information lists all method entities that can be called
654 * from this node. If the address expression can not be analyzed fully,
655 * e.g., as entities can be called that are not in the compilation unit,
656 * the array contains the unknown_entity. The array contains only entities
657 * with peculiarity_existent, but with all kinds of visibility. The entities
658 * not necessarily contain an irg.
660 * The array is only accessible if callee information is valid. See flag
663 * The memory allocated for the array is managed automatically, i.e., it must
664 * not be freed if the Call node is removed from the graph.
666 * @param node A Call node.
668 int Call_has_callees(const ir_node *node);
669 int get_Call_n_callees(const ir_node *node);
670 ir_entity *get_Call_callee(const ir_node *node, int pos);
672 /** Set the full callee array.
674 * The passed array is copied. Assumes current_ir_graph set properly! */
675 void set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
676 void remove_Call_callee_arr(ir_node *node);
678 ir_node *get_CallBegin_ptr(const ir_node *node);
679 void set_CallBegin_ptr(ir_node *node, ir_node *ptr);
680 ir_node *get_CallBegin_call(const ir_node *node);
681 void set_CallBegin_call(ir_node *node, ir_node *call);
683 /* For unary and binary arithmetic operations the access to the
684 operands can be factored out. Left is the first, right the
685 second arithmetic value as listed in tech report 1999-44.
686 unops are: Minus, Abs, Not, Conv, Cast
687 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
688 Shr, Shrs, Rot, Cmp */
689 int is_unop(const ir_node *node);
690 ir_node *get_unop_op(const ir_node *node);
691 void set_unop_op(ir_node *node, ir_node *op);
692 int is_binop(const ir_node *node);
693 ir_node *get_binop_left(const ir_node *node);
694 void set_binop_left(ir_node *node, ir_node *left);
695 ir_node *get_binop_right(const ir_node *node);
696 void set_binop_right(ir_node *node, ir_node *right);
698 ir_node *get_Add_left(const ir_node *node);
699 void set_Add_left(ir_node *node, ir_node *left);
700 ir_node *get_Add_right(const ir_node *node);
701 void set_Add_right(ir_node *node, ir_node *right);
703 ir_node *get_Sub_left(const ir_node *node);
704 void set_Sub_left(ir_node *node, ir_node *left);
705 ir_node *get_Sub_right(const ir_node *node);
706 void set_Sub_right(ir_node *node, ir_node *right);
708 ir_node *get_Minus_op(const ir_node *node);
709 void set_Minus_op(ir_node *node, ir_node *op);
711 ir_node *get_Mul_left(const ir_node *node);
712 void set_Mul_left(ir_node *node, ir_node *left);
713 ir_node *get_Mul_right(const ir_node *node);
714 void set_Mul_right(ir_node *node, ir_node *right);
716 ir_node *get_Mulh_left(const ir_node *node);
717 void set_Mulh_left(ir_node *node, ir_node *left);
718 ir_node *get_Mulh_right(const ir_node *node);
719 void set_Mulh_right(ir_node *node, ir_node *right);
721 ir_node *get_Quot_left(const ir_node *node);
722 void set_Quot_left(ir_node *node, ir_node *left);
723 ir_node *get_Quot_right(const ir_node *node);
724 void set_Quot_right(ir_node *node, ir_node *right);
725 ir_node *get_Quot_mem(const ir_node *node);
726 void set_Quot_mem(ir_node *node, ir_node *mem);
727 ir_mode *get_Quot_resmode(const ir_node *node);
728 void set_Quot_resmode(ir_node *node, ir_mode *mode);
731 * Projection numbers for Quot: use for Proj nodes!
734 pn_Quot_M = pn_Generic_M_regular, /**< Memory result. */
735 pn_Quot_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
736 pn_Quot_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
737 pn_Quot_res = pn_Generic_other, /**< Result of computation. */
738 pn_Quot_max /**< number of projections from a Quot */
739 } pn_Quot; /* Projection numbers for Quot. */
741 ir_node *get_DivMod_left(const ir_node *node);
742 void set_DivMod_left(ir_node *node, ir_node *left);
743 ir_node *get_DivMod_right(const ir_node *node);
744 void set_DivMod_right(ir_node *node, ir_node *right);
745 ir_node *get_DivMod_mem(const ir_node *node);
746 void set_DivMod_mem(ir_node *node, ir_node *mem);
747 ir_mode *get_DivMod_resmode(const ir_node *node);
748 void set_DivMod_resmode(ir_node *node, ir_mode *mode);
751 * Projection numbers for DivMod: use for Proj nodes!
754 pn_DivMod_M = pn_Generic_M_regular, /**< Memory result. */
755 pn_DivMod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
756 pn_DivMod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
757 pn_DivMod_res_div = pn_Generic_other, /**< Result of computation a / b. */
758 pn_DivMod_res_mod, /**< Result of computation a % b. */
759 pn_DivMod_max /**< number of projections from a DivMod */
760 } pn_DivMod; /* Projection numbers for DivMod. */
762 ir_node *get_Div_left(const ir_node *node);
763 void set_Div_left(ir_node *node, ir_node *left);
764 ir_node *get_Div_right(const ir_node *node);
765 void set_Div_right(ir_node *node, ir_node *right);
766 ir_node *get_Div_mem(const ir_node *node);
767 void set_Div_mem(ir_node *node, ir_node *mem);
768 ir_mode *get_Div_resmode(const ir_node *node);
769 void set_Div_resmode(ir_node *node, ir_mode *mode);
770 int is_Div_remainderless(const ir_node *node);
773 * Projection numbers for Div: use for Proj nodes!
776 pn_Div_M = pn_Generic_M_regular, /**< Memory result. */
777 pn_Div_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
778 pn_Div_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
779 pn_Div_res = pn_Generic_other, /**< Result of computation. */
780 pn_Div_max /**< number of projections from a Div */
781 } pn_Div; /* Projection numbers for Div. */
783 ir_node *get_Mod_left(const ir_node *node);
784 void set_Mod_left(ir_node *node, ir_node *left);
785 ir_node *get_Mod_right(const ir_node *node);
786 void set_Mod_right(ir_node *node, ir_node *right);
787 ir_node *get_Mod_mem(const ir_node *node);
788 void set_Mod_mem(ir_node *node, ir_node *mem);
789 ir_mode *get_Mod_resmode(const ir_node *node);
790 void set_Mod_resmode(ir_node *node, ir_mode *mode);
793 * Projection numbers for Mod: use for Proj nodes!
796 pn_Mod_M = pn_Generic_M_regular, /**< Memory result. */
797 pn_Mod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
798 pn_Mod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
799 pn_Mod_res = pn_Generic_other, /**< Result of computation. */
800 pn_Mod_max /**< number of projections from a Mod */
801 } pn_Mod; /* Projection numbers for Mod. */
803 ir_node *get_Abs_op(const ir_node *node);
804 void set_Abs_op(ir_node *node, ir_node *op);
806 ir_node *get_And_left(const ir_node *node);
807 void set_And_left(ir_node *node, ir_node *left);
808 ir_node *get_And_right(const ir_node *node);
809 void set_And_right(ir_node *node, ir_node *right);
811 ir_node *get_Or_left(const ir_node *node);
812 void set_Or_left(ir_node *node, ir_node *left);
813 ir_node *get_Or_right(const ir_node *node);
814 void set_Or_right(ir_node *node, ir_node *right);
816 ir_node *get_Eor_left(const ir_node *node);
817 void set_Eor_left(ir_node *node, ir_node *left);
818 ir_node *get_Eor_right(const ir_node *node);
819 void set_Eor_right(ir_node *node, ir_node *right);
821 ir_node *get_Not_op(const ir_node *node);
822 void set_Not_op(ir_node *node, ir_node *op);
825 * Projection numbers for Cmp are defined several times.
826 * The bit patterns are used for various tests, so don't change.
827 * The "unordered" values are possible results of comparing
828 * floating point numbers.
829 * Note that the encoding is imported, so do NOT change the order.
832 pn_Cmp_False = 0, /**< false */
833 pn_Cmp_Eq = 1, /**< equal */
834 pn_Cmp_Lt = 2, /**< less */
835 pn_Cmp_Le = pn_Cmp_Eq|pn_Cmp_Lt, /**< less or equal */
836 pn_Cmp_Gt = 4, /**< greater */
837 pn_Cmp_Ge = pn_Cmp_Eq|pn_Cmp_Gt, /**< greater or equal */
838 pn_Cmp_Lg = pn_Cmp_Lt|pn_Cmp_Gt, /**< less or greater */
839 pn_Cmp_Leg = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
840 pn_Cmp_Uo = 8, /**< unordered */
841 pn_Cmp_Ue = pn_Cmp_Uo|pn_Cmp_Eq, /**< unordered or equal */
842 pn_Cmp_Ul = pn_Cmp_Uo|pn_Cmp_Lt, /**< unordered or less */
843 pn_Cmp_Ule = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
844 pn_Cmp_Ug = pn_Cmp_Uo|pn_Cmp_Gt, /**< unordered or greater */
845 pn_Cmp_Uge = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
846 pn_Cmp_Ne = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
847 pn_Cmp_True = 15 /**< true */
848 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for JNI interface */
849 } pn_Cmp; /* Projection numbers for Cmp */
850 /* #define not_mask pn_Cmp_Leg */
852 /** returns the pnc name from an pnc constant */
853 const char *get_pnc_string(int pnc);
855 /** Calculates the negated (Complement(R)) pnc condition. */
856 pn_Cmp get_negated_pnc(long pnc, ir_mode *mode);
858 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
859 pn_Cmp get_inversed_pnc(long pnc);
861 /** An alternative name for get_inversed_pnc() that can be better memorized. */
862 #define get_mirrored_pnc(pnc) get_inversed_pnc(pnc)
864 ir_node *get_Cmp_left(const ir_node *node);
865 void set_Cmp_left(ir_node *node, ir_node *left);
866 ir_node *get_Cmp_right(const ir_node *node);
867 void set_Cmp_right(ir_node *node, ir_node *right);
869 ir_node *get_Shl_left(const ir_node *node);
870 void set_Shl_left(ir_node *node, ir_node *left);
871 ir_node *get_Shl_right(const ir_node *node);
872 void set_Shl_right(ir_node *node, ir_node *right);
874 ir_node *get_Shr_left(const ir_node *node);
875 void set_Shr_left(ir_node *node, ir_node *left);
876 ir_node *get_Shr_right(const ir_node *node);
877 void set_Shr_right(ir_node *node, ir_node *right);
879 ir_node *get_Shrs_left(const ir_node *node);
880 void set_Shrs_left(ir_node *node, ir_node *left);
881 ir_node *get_Shrs_right(const ir_node *node);
882 void set_Shrs_right(ir_node *node, ir_node *right);
884 ir_node *get_Rot_left(const ir_node *node);
885 void set_Rot_left(ir_node *node, ir_node *left);
886 ir_node *get_Rot_right(const ir_node *node);
887 void set_Rot_right(ir_node *node, ir_node *right);
889 ir_node *get_Conv_op(const ir_node *node);
890 void set_Conv_op(ir_node *node, ir_node *op);
891 int get_Conv_strict(const ir_node *node);
892 void set_Conv_strict(ir_node *node, int flag);
894 /* Does Cast need a mem operator?
895 * Cast should only depend on the type, not on the state of an
896 * entity. But: we initialize various fields after Alloc, that
897 * are accessed in the cast. This required some precaution, to
898 * get the right memory into the Loads generated from the cast.
900 ir_node *get_Cast_op(const ir_node *node);
901 void set_Cast_op(ir_node *node, ir_node *op);
902 ir_type *get_Cast_type(ir_node *node);
903 void set_Cast_type(ir_node *node, ir_type *to_tp);
905 /** Checks for upcast.
907 * Returns true if the Cast node casts a class type to a super type.
908 * Works also for pointers to classes (recursively).
910 * Needs typeinfo calculated.
912 int is_Cast_upcast(ir_node *node);
914 /** Checks for downcast.
916 * Returns true if the Cast node casts a class type to a sub type.
917 * Works also for pointers to classes (recursively).
919 * Needs typeinfo calculated.
921 int is_Cast_downcast(ir_node *node);
924 /** Returns true if n is Phi or Filter in interprocedural_view.
925 Returns false if irg in phase building and the Phi has zero
926 predecessors: it's a Phi0. */
927 int is_Phi(const ir_node *n);
928 /** Returns true if irg in phase building and the Phi has zero
929 predecessors. It's a Phi0 then. */
930 int is_Phi0(const ir_node *n);
931 /* These routines also work for Filter nodes in interprocedural view. */
932 ir_node **get_Phi_preds_arr(ir_node *node);
933 int get_Phi_n_preds(const ir_node *node);
934 ir_node *get_Phi_pred(const ir_node *node, int pos);
935 void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
936 ir_node *get_Phi_next(const ir_node *phi);
937 void set_Phi_next(ir_node *phi, ir_node *next);
939 ir_node *get_Filter_pred(ir_node *node);
940 void set_Filter_pred(ir_node *node, ir_node *pred);
941 long get_Filter_proj(ir_node *node);
942 void set_Filter_proj(ir_node *node, long proj);
943 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
944 * @@@ Maybe better: arity is zero if no cg preds. */
945 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
946 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
947 int get_Filter_n_cg_preds(ir_node *node);
948 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
950 /** Return true if parameter is a memory operation.
952 * A memory operation is an operation that changes the
953 * memory. I.e., a Load or a Store operation.
955 int is_memop(const ir_node *node);
956 ir_node *get_memop_mem(const ir_node *node);
957 void set_memop_mem(ir_node *node, ir_node *mem);
958 ir_node *get_memop_ptr(const ir_node *node);
959 void set_memop_ptr(ir_node *node, ir_node *ptr);
962 * Projection numbers for Load: use for Proj nodes!
965 pn_Load_M = pn_Generic_M_regular, /**< Memory result. */
966 pn_Load_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
967 pn_Load_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
968 pn_Load_res = pn_Generic_other, /**< Result of load operation. */
969 pn_Load_max /**< number of projections from a Load */
970 } pn_Load; /* Projection numbers for Load. */
972 ir_node *get_Load_mem(const ir_node *node);
973 void set_Load_mem(ir_node *node, ir_node *mem);
974 ir_node *get_Load_ptr(const ir_node *node);
975 void set_Load_ptr(ir_node *node, ir_node *ptr);
976 ir_mode *get_Load_mode(const ir_node *node);
977 void set_Load_mode(ir_node *node, ir_mode *mode);
978 ir_volatility get_Load_volatility(const ir_node *node);
979 void set_Load_volatility(ir_node *node, ir_volatility volatility);
980 ir_align get_Load_align(const ir_node *node);
981 void set_Load_align(ir_node *node, ir_align align);
984 * Projection numbers for Store: use for Proj nodes!
987 pn_Store_M = pn_Generic_M_regular, /**< Memory result. */
988 pn_Store_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
989 pn_Store_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
990 pn_Store_max = pn_Generic_other /**< number of projections from a Store */
991 } pn_Store; /* Projection numbers for Store. */
993 ir_node *get_Store_mem(const ir_node *node);
994 void set_Store_mem(ir_node *node, ir_node *mem);
995 ir_node *get_Store_ptr(const ir_node *node);
996 void set_Store_ptr(ir_node *node, ir_node *ptr);
997 ir_node *get_Store_value(const ir_node *node);
998 void set_Store_value(ir_node *node, ir_node *value);
999 ir_volatility get_Store_volatility(const ir_node *node);
1000 void set_Store_volatility(ir_node *node, ir_volatility volatility);
1001 ir_align get_Store_align(const ir_node *node);
1002 void set_Store_align(ir_node *node, ir_align align);
1005 * Projection numbers for Alloc: use for Proj nodes!
1008 pn_Alloc_M = pn_Generic_M_regular, /**< Memory result. */
1009 pn_Alloc_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1010 pn_Alloc_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
1011 pn_Alloc_res = pn_Generic_other, /**< Result of allocation. */
1012 pn_Alloc_max /**< number of projections from an Alloc */
1013 } pn_Alloc; /* Projection numbers for Alloc. */
1015 ir_node *get_Alloc_mem(const ir_node *node);
1016 void set_Alloc_mem(ir_node *node, ir_node *mem);
1017 ir_node *get_Alloc_size(const ir_node *node);
1018 void set_Alloc_size(ir_node *node, ir_node *size);
1019 ir_type *get_Alloc_type(ir_node *node);
1020 void set_Alloc_type(ir_node *node, ir_type *tp);
1022 /** The allocation place. */
1024 stack_alloc, /**< Alloc allocates the object on the stack. */
1025 heap_alloc /**< Alloc allocates the object on the heap. */
1028 ir_where_alloc get_Alloc_where(const ir_node *node);
1029 void set_Alloc_where(ir_node *node, ir_where_alloc where);
1031 ir_node *get_Free_mem(const ir_node *node);
1032 void set_Free_mem(ir_node *node, ir_node *mem);
1033 ir_node *get_Free_ptr(const ir_node *node);
1034 void set_Free_ptr(ir_node *node, ir_node *ptr);
1035 ir_node *get_Free_size(const ir_node *node);
1036 void set_Free_size(ir_node *node, ir_node *size);
1037 ir_type *get_Free_type(ir_node *node);
1038 void set_Free_type(ir_node *node, ir_type *tp);
1040 ir_where_alloc get_Free_where(const ir_node *node);
1041 void set_Free_where(ir_node *node, ir_where_alloc where);
1043 ir_node **get_Sync_preds_arr(ir_node *node);
1044 int get_Sync_n_preds(const ir_node *node);
1045 ir_node *get_Sync_pred(const ir_node *node, int pos);
1046 void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
1047 void add_Sync_pred(ir_node *node, ir_node *pred);
1049 /** Returns the source language type of a Proj node.
1050 * Must be an atomic type. Mode of type must be mode of node.
1052 ir_type *get_Proj_type(ir_node *node);
1054 /** Return the predecessor of a Proj node. */
1055 ir_node *get_Proj_pred(const ir_node *node);
1056 void set_Proj_pred(ir_node *node, ir_node *pred);
1057 /** Return the projection number of a Proj node. */
1058 long get_Proj_proj(const ir_node *node);
1059 void set_Proj_proj(ir_node *node, long proj);
1061 ir_node **get_Tuple_preds_arr(ir_node *node);
1062 int get_Tuple_n_preds(const ir_node *node);
1063 ir_node *get_Tuple_pred(const ir_node *node, int pos);
1064 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
1066 ir_node *get_Id_pred(const ir_node *node);
1067 void set_Id_pred(ir_node *node, ir_node *pred);
1069 /** Confirm has a single result and returns 'value' unchanged.
1070 * The node expresses a restriction on 'value':
1071 * 'value' 'cmp' 'bound' == true. */
1072 ir_node *get_Confirm_value(const ir_node *node);
1073 void set_Confirm_value(ir_node *node, ir_node *value);
1074 ir_node *get_Confirm_bound(const ir_node *node);
1075 void set_Confirm_bound(ir_node *node, ir_node *bound);
1076 pn_Cmp get_Confirm_cmp(const ir_node *node);
1077 void set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
1080 * Mux Support: Note that Psi nodes with one condition can be handled
1081 * like Mux nodes, and the access functions work as expected.
1083 ir_node *get_Mux_sel(const ir_node *node);
1084 void set_Mux_sel(ir_node *node, ir_node *sel);
1085 ir_node *get_Mux_false(const ir_node *node);
1086 void set_Mux_false(ir_node *node, ir_node *ir_false);
1087 ir_node *get_Mux_true(const ir_node *node);
1088 void set_Mux_true(ir_node *node, ir_node *ir_true);
1090 ir_node *get_Psi_cond(const ir_node *node, int pos);
1091 void set_Psi_cond(ir_node *node, int pos, ir_node *cond);
1092 ir_node *get_Psi_val(const ir_node *node, int pos);
1093 void set_Psi_val(ir_node *node, int pos, ir_node *val);
1094 ir_node *get_Psi_default(const ir_node *node);
1095 void set_Psi_default(ir_node *node, ir_node *val);
1096 int get_Psi_n_conds(const ir_node *node);
1099 * Projection numbers for result of CopyB node: use for Proj nodes!
1102 pn_CopyB_M_regular = pn_Generic_M_regular, /**< The memory result. */
1103 pn_CopyB_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1104 pn_CopyB_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1105 pn_CopyB_M_except = pn_Generic_other, /**< The memory result in case the runtime function terminated with
1107 pn_CopyB_max /**< number of projections from a CopyB */
1108 } pn_CopyB; /* Projection numbers for CopyB. */
1109 #define pn_CopyB_M pn_CopyB_M_regular
1111 ir_node *get_CopyB_mem(const ir_node *node);
1112 void set_CopyB_mem(ir_node *node, ir_node *mem);
1113 ir_node *get_CopyB_dst(const ir_node *node);
1114 void set_CopyB_dst(ir_node *node, ir_node *dst);
1115 ir_node *get_CopyB_src(const ir_node *node);
1116 void set_CopyB_src(ir_node *node, ir_node *src);
1117 ir_type *get_CopyB_type(ir_node *node);
1118 void set_CopyB_type(ir_node *node, ir_type *data_type);
1121 * Projection numbers for result of InstOf node: use for Proj nodes!
1124 pn_InstOf_M_regular = pn_Generic_M_regular, /**< The memory result. */
1125 pn_InstOf_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1126 pn_InstOf_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1127 pn_InstOf_res = pn_Generic_other, /**< The checked object pointer. */
1128 pn_InstOf_M_except, /**< The memory result in case the runtime function terminated with
1130 pn_InstOf_max /**< number of projections from an InstOf */
1132 #define pn_InstOf_M pn_InstOf_M_regular
1134 /** InstOf access */
1135 ir_type *get_InstOf_type(ir_node *node);
1136 void set_InstOf_type(ir_node *node, ir_type *type);
1137 ir_node *get_InstOf_store(const ir_node *node);
1138 void set_InstOf_store(ir_node *node, ir_node *obj);
1139 ir_node *get_InstOf_obj(const ir_node *node);
1140 void set_InstOf_obj(ir_node *node, ir_node *obj);
1143 * Projection numbers for Raise.
1146 pn_Raise_M = pn_Generic_M_regular, /**< The Memory result. */
1147 pn_Raise_X = pn_Generic_X_regular, /**< The control flow to the exception handler. */
1148 pn_Raise_max /**< number of projections from a Raise */
1149 } pn_Raise; /* Projection numbers for Raise. */
1151 ir_node *get_Raise_mem(const ir_node *node);
1152 void set_Raise_mem(ir_node *node, ir_node *mem);
1153 ir_node *get_Raise_exo_ptr(const ir_node *node); /* PoinTeR to EXception Object */
1154 void set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
1157 * Projection numbers for result of Bound node: use for Proj nodes!
1160 pn_Bound_M = pn_Generic_M_regular, /**< The memory result. */
1161 pn_Bound_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1162 pn_Bound_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1163 pn_Bound_res = pn_Generic_other, /**< The checked index. */
1164 pn_Bound_max /**< number of projections from a Bound */
1167 /** Returns the memory input of a Bound operation. */
1168 ir_node *get_Bound_mem(const ir_node *bound);
1169 void set_Bound_mem(ir_node *bound, ir_node *mem);
1171 /** Returns the index input of a Bound operation. */
1172 ir_node *get_Bound_index(const ir_node *bound);
1173 void set_Bound_index(ir_node *bound, ir_node *idx);
1175 /** Returns the lower bound input of a Bound operation. */
1176 ir_node *get_Bound_lower(const ir_node *bound);
1177 void set_Bound_lower(ir_node *bound, ir_node *lower);
1179 /** Returns the upper bound input of a Bound operation. */
1180 ir_node *get_Bound_upper(const ir_node *bound);
1181 void set_Bound_upper(ir_node *bound, ir_node *upper);
1183 /** Return the operand of a Pin node. */
1184 ir_node *get_Pin_op(const ir_node *pin);
1185 void set_Pin_op(ir_node *pin, ir_node *node);
1187 /** A input/output constraint attribute */
1189 unsigned pos; /**< The inputs/output position for this constraint. */
1190 ident *constraint; /**< The constraint for this input/output. */
1191 ir_mode *mode; /**< The mode of the constraint. */
1192 } ir_asm_constraint;
1194 /** Return the assembler text of an ASM pseudo node. */
1195 ident *get_ASM_text(const ir_node *node);
1196 /** Return the number of input constraints for an ASM node. */
1197 int get_ASM_n_input_constraints(const ir_node *node);
1198 /** Return the input constraints for an ASM node. */
1199 const ir_asm_constraint *get_ASM_input_constraints(const ir_node *node);
1200 /** Return the number of output constraints for an ASM node. */
1201 int get_ASM_n_output_constraints(const ir_node *node);
1202 /** Return the output constraints for an ASM node. */
1203 const ir_asm_constraint *get_ASM_output_constraints(const ir_node *node);
1204 /** Return the number of clobbered registers for an ASM node. */
1205 int get_ASM_n_clobbers(const ir_node *node);
1206 /** Return the list of clobbered registers for an ASM node. */
1207 ident **get_ASM_clobbers(const ir_node *node);
1211 * NAME Auxiliary routines
1215 /** Returns operand of node if node is a Proj. */
1216 ir_node *skip_Proj(ir_node *node);
1217 /** Returns operand of node if node is a Proj. */
1218 const ir_node *skip_Proj_const(const ir_node *node);
1219 /** Returns operand of node if node is a Id. */
1220 ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
1221 /** Returns corresponding operand of Tuple if node is a Proj from
1223 ir_node *skip_Tuple(ir_node *node);
1224 /** returns operand of node if node is a Cast. */
1225 ir_node *skip_Cast(ir_node *node);
1226 /** Returns operand of node if node is a Confirm */
1227 ir_node *skip_Confirm(ir_node *node);
1228 /** Skip all high-level Operations (including Cast, Confirm). */
1229 ir_node *skip_HighLevel_ops(ir_node *node);
1230 /** Returns true if irn is a Const node. */
1231 int is_Const(const ir_node *node);
1232 /** Returns true if a node is a Conv node. */
1233 int is_Conv(const ir_node *node);
1234 /** Returns true if a node is a strictConv node. */
1235 int is_strictConv(const ir_node *node);
1236 /** Returns true if a node is a Cast node. */
1237 int is_Cast(const ir_node *node);
1238 /** Returns true if node is a Bad node. */
1239 int is_Bad(const ir_node *node);
1240 /** Returns true if node is a NoMem node. */
1241 int is_NoMem(const ir_node *node);
1242 /** Returns true if node is a Start node. */
1243 int is_Start(const ir_node *node);
1244 /** Returns true if node is a Minus node. */
1245 int is_Minus(const ir_node *node);
1246 /** Returns true if node is a Abs node. */
1247 int is_Abs(const ir_node *node);
1248 /** Returns true if node is a Mod node. */
1249 int is_Mod(const ir_node *node);
1250 /** Returns true if node is a Div node. */
1251 int is_Div(const ir_node *node);
1252 /** Returns true if node is a DivMod node. */
1253 int is_DivMod(const ir_node *node);
1254 /** Returns true if node is a Quot node. */
1255 int is_Quot(const ir_node *node);
1256 /** Returns true if node is an Add node. */
1257 int is_Add(const ir_node *node);
1258 /** Returns true if node is an And node. */
1259 int is_And(const ir_node *node);
1260 /** Returns true if node is an Or node. */
1261 int is_Or(const ir_node *node);
1262 /** Returns true if node is an Eor node. */
1263 int is_Eor(const ir_node *node);
1264 /** Returns true if node is a Sub node. */
1265 int is_Sub(const ir_node *node);
1266 /** Returns true if node is a Not node. */
1267 int is_Not(const ir_node *node);
1268 /** Returns true if node is a Shl node. */
1269 int is_Shl(const ir_node *node);
1270 /** Returns true if node is a Shr node. */
1271 int is_Shr(const ir_node *node);
1272 /** Returns true if node is a Shrs node. */
1273 int is_Shrs(const ir_node *node);
1274 /** Returns true if node is a Rot node. */
1275 int is_Rot(const ir_node *node);
1276 /** Returns true if node is a Psi node. */
1277 int is_Psi(const ir_node *node);
1278 /** Returns true if node is a Tuple node. */
1279 int is_Tuple(const ir_node *node);
1280 /** Returns true if node is a Bound node. */
1281 int is_Bound(const ir_node *node);
1282 /** Returns true if the node is not a Block */
1283 int is_no_Block(const ir_node *node);
1284 /** Returns true if the node is a Block */
1285 int is_Block(const ir_node *node);
1286 /** Returns true if node is an Unknown node. */
1287 int is_Unknown(const ir_node *node);
1288 /** Returns true if node is a Return node. */
1289 int is_Return(const ir_node *node);
1290 /** Returns true if node is a Call node. */
1291 int is_Call(const ir_node *node);
1292 /** Returns true if node is a Sel node. */
1293 int is_Sel(const ir_node *node);
1294 /** Returns true if node is a Mul node. */
1295 int is_Mul(const ir_node *node);
1296 /** Returns true if node is a Mulh node. */
1297 int is_Mulh(const ir_node *node);
1298 /** Returns true if node is a Mux node or a Psi with only one condition. */
1299 int is_Mux(const ir_node *node);
1300 /** Returns true if node is a Load node. */
1301 int is_Load(const ir_node *node);
1302 /** Returns true if node is a Store node. */
1303 int is_Store(const ir_node *node);
1304 /** Returns true if node is a Sync node. */
1305 int is_Sync(const ir_node *node);
1306 /** Returns true if node is a Confirm node. */
1307 int is_Confirm(const ir_node *node);
1308 /** Returns true if node is a Pin node. */
1309 int is_Pin(const ir_node *node);
1310 /** Returns true if node is a SymConst node. */
1311 int is_SymConst(const ir_node *node);
1312 /** Returns true if node is a SymConst node with kind symconst_addr_ent. */
1313 int is_SymConst_addr_ent(const ir_node *node);
1314 /** Returns true if node is a Cond node. */
1315 int is_Cond(const ir_node *node);
1316 /** Returns true of node is a CopyB node */
1317 int is_CopyB(const ir_node *node);
1318 /** Returns true if node is a Cmp node. */
1319 int is_Cmp(const ir_node *node);
1320 /** Returns true if node is an Alloc node */
1321 int is_Alloc(const ir_node *node);
1322 /** Returns true if a node is a Jmp node */
1323 int is_Jmp(const ir_node *node);
1324 /** Returns true if a node is a Raise node */
1325 int is_Raise(const ir_node *node);
1326 /** Returns true if a node is an ASM node */
1327 int is_ASM(const ir_node *node);
1328 /** Returns true if node is a Proj node or a Filter node in
1329 * intraprocedural view */
1330 int is_Proj(const ir_node *node);
1331 /** Returns true if the operation manipulates control flow:
1332 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1333 int is_cfop(const ir_node *node);
1335 /** Returns true if the operation manipulates interprocedural control flow:
1336 CallBegin, EndReg, EndExcept */
1337 int is_ip_cfop(const ir_node *node);
1338 /** Returns true if the operation can change the control flow because
1339 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1340 Bad. Raise is not fragile, but a unconditional jump. */
1341 int is_fragile_op(const ir_node *node);
1342 /** Returns the memory operand of fragile operations. */
1343 ir_node *get_fragile_op_mem(ir_node *node);
1344 /** Returns the result mode of a Div operation. */
1345 ir_mode *get_divop_resmod(const ir_node *node);
1347 /** Returns true if the operation is a forking control flow
1348 * operation: Cond. */
1349 int is_irn_forking(const ir_node *node);
1351 /** Return the type associated with the value produced by n
1352 * if the node remarks this type as it is the case for
1353 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1354 ir_type *get_irn_type(ir_node *n);
1356 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1358 ir_type *get_irn_type_attr(ir_node *n);
1360 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1361 ir_entity *get_irn_entity_attr(ir_node *n);
1363 /** Returns non-zero for constant-like nodes. */
1364 int is_irn_constlike(const ir_node *node);
1367 * Returns non-zero for nodes that must be always optimized
1368 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1370 int is_irn_always_opt(const ir_node *node);
1373 * Returns non-zero for nodes that are allowed to have keep-alives and
1374 * are neither Block nor PhiM.
1376 int is_irn_keep(const ir_node *node);
1379 * Returns non-zero for nodes that are always placed in the start block.
1381 int is_irn_start_block_placed(const ir_node *node);
1384 * Returns non-zero for nodes that are machine operations.
1386 int is_irn_machine_op(const ir_node *node);
1389 * Returns non-zero for nodes that are machine operands.
1391 int is_irn_machine_operand(const ir_node *node);
1394 * Returns non-zero for nodes that have the n'th user machine flag set.
1396 int is_irn_machine_user(const ir_node *node, unsigned n);
1399 * A type to express conditional jump predictions.
1402 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1403 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1404 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1405 } cond_jmp_predicate;
1407 /** Gets the string representation of the jump prediction .*/
1408 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1410 /** Returns the conditional jump prediction of a Cond node. */
1411 cond_jmp_predicate get_Cond_jmp_pred(const ir_node *cond);
1413 /** Sets a new conditional jump prediction. */
1414 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1416 /** Checks whether a node represents a global address. */
1417 int is_Global(const ir_node *node);
1419 /* Returns the entity of a global address. */
1420 ir_entity *get_Global_entity(const ir_node *node);
1423 * Access custom node data.
1424 * The data must have been registered with
1425 * register_additional_node_data() before.
1426 * @param node The ir node to get the data from.
1427 * @param type The type of the data you registered.
1428 * @param off The value returned by register_additional_node_data().
1429 * @return A pointer of type @p type.
1431 #define get_irn_data(node,type,off) \
1432 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1435 * Get the pointer to the node some custom data belongs to.
1436 * @param data The pointer to the custom data.
1437 * @param off The number as returned by register_additional_node_data().
1438 * @return A pointer to the ir node the custom data belongs to.
1440 #define get_irn_data_base(data,off) \
1441 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1444 * Request additional data to be allocated with an ir node.
1445 * @param size The size of the additional data required.
1446 * @return A positive number, if the operation was successful, which
1447 * must be passed to the access macro get_irn_data(), 0 if the
1448 * registration failed.
1450 unsigned firm_register_additional_node_data(unsigned size);
1453 * Return a pointer to the node attributes.
1454 * Needed for user-defined nodes.
1456 void *get_irn_generic_attr(ir_node *node);
1457 const void *get_irn_generic_attr_const(const ir_node *node);
1460 * Returns the unique node index for the node in its graph.
1461 * This index is used to access phase information for this node.
1463 unsigned get_irn_idx(const ir_node *node);
1466 * Sets the debug information of a node.
1468 * @param n The node.
1469 * @param db The debug info.
1471 void set_irn_dbg_info(ir_node *n, dbg_info *db);
1474 * Returns the debug information of an node.
1476 * @param n The node.
1478 dbg_info *get_irn_dbg_info(const ir_node *n);
1480 /*-----------------------------------------------------------------*/
1482 /*-----------------------------------------------------------------*/
1485 /** Debug print the node.
1487 * Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
1488 * is set. Else does nothing. */
1489 void dump_irn(const ir_node *n);
1491 /*@}*/ /* end of ir_node group definition */