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 ir_modecode. */
184 ir_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_tls, /**< Projection on the pointer to the thread local store
314 segment containing _all_thread local variables. */
315 pn_Start_T_args, /**< Projection on all arguments. */
316 pn_Start_P_value_arg_base, /**< Pointer to region of compound value arguments as defined by
317 type of this method. */
318 pn_Start_max /**< number of projections from a Start */
319 } pn_Start; /* Projection numbers for Start. */
321 /** Test whether arbitrary node is frame pointer.
323 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
324 * from Start. If so returns frame type, else Null. */
325 ir_type *is_frame_pointer(const ir_node *n);
327 /** Test whether arbitrary node is the thread local storage (tls) pointer.
329 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
330 * from Start. If so returns tls type, else Null. */
331 ir_type *is_tls_pointer(const ir_node *n);
333 /** Test whether arbitrary node is value arg base.
335 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
336 * from Start. If so returns 1, else 0. */
337 int is_value_arg_pointer(const ir_node *n);
339 /* @@@ no more supported */
340 ir_node **get_Block_cfgpred_arr(ir_node *node);
341 int get_Block_n_cfgpreds(const ir_node *node);
342 ir_node *get_Block_cfgpred(const ir_node *node, int pos);
343 void set_Block_cfgpred(ir_node *node, int pos, ir_node *pred);
344 /** Get the predecessor block.
346 * Returns the block corresponding to the predecessor pos of block.
348 * There are several ambiguities we resolve with this function:
349 * - The direct predecessor can be a Proj, which is not pinned.
350 * We walk from the predecessor to the next pinned node
351 * (skip_Proj) and return the block that node is in.
352 * - If we encounter the Bad node, this function does not return
353 * Start, but the Bad node.
355 ir_node *get_Block_cfgpred_block(const ir_node *node, int pos);
356 int get_Block_matured(const ir_node *node);
357 void set_Block_matured(ir_node *node, int matured);
359 /** A visited flag only for block nodes.
360 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
361 unsigned long get_Block_block_visited(const ir_node *node);
362 void set_Block_block_visited(ir_node *node, unsigned long visit);
365 * Marks a block as dead but do not replace it with a Bad node.
366 * Dead blocks are removed in the con
368 ir_node *set_Block_dead(ir_node *block);
369 int is_Block_dead(const ir_node *block);
371 /* For this current_ir_graph must be set. */
372 void mark_Block_block_visited(ir_node *node);
373 int Block_not_block_visited(const ir_node *node);
374 int Block_block_visited(const ir_node *node);
376 #ifdef INTERPROCEDURAL_VIEW
377 /* Set and remove interprocedural predecessors. If the interprocedural
378 * predecessors are removed, the node has the same predecessors in
380 * @@@ Maybe better: arity is zero if no cg preds. */
381 void set_Block_cg_cfgpred_arr(ir_node *node, int arity, ir_node *in[]);
382 void set_Block_cg_cfgpred(ir_node *node, int pos, ir_node *pred);
383 /* @@@ not supported */
384 ir_node **get_Block_cg_cfgpred_arr(ir_node *node);
385 /** Returns the number of interprocedural predecessors. 0 if none. */
386 int get_Block_cg_n_cfgpreds(const ir_node *node);
387 /** Return the interprocedural predecessor at position pos. */
388 ir_node *get_Block_cg_cfgpred(const ir_node *node, int pos);
389 /** Frees the memory allocated for interprocedural predecessors. */
390 void remove_Block_cg_cfgpred_arr(ir_node *node);
393 /** Returns the extended basic block a block belongs to. */
394 ir_extblk *get_Block_extbb(const ir_node *block);
395 /** Sets the extended basic block a block belongs to. */
396 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
397 /** Get the Macro Block header of a (sub-) block. */
398 ir_node *get_Block_MacroBlock(const ir_node *block);
399 /** Set the Macro Block header of a (sub-) block. */
400 void set_Block_MacroBlock(ir_node *block, ir_node *mbh);
401 /** Get the Macro Block header of a node. */
402 ir_node *get_irn_MacroBlock(const ir_node *n);
403 /** Returns the ir_graph this Block belongs to. */
404 ir_graph *get_Block_irg(const ir_node *block);
405 /** Returns non-zero if the block has an assigned label. */
406 int has_Block_label(const ir_node *block);
407 /** Returns the label of a Block. */
408 ir_label_t get_Block_label(const ir_node *block);
409 /** Sets a label to a block. */
410 void set_Block_label(ir_node *block, ir_label_t label);
411 /** Gets the head of the Phi list for this block. */
412 ir_node *get_Block_phis(const ir_node *block);
413 /** Sets the head of the Phi list for this block. */
414 void set_Block_phis(ir_node *block, ir_node *phi);
415 /** Add a Phi node to the list of Block Phi's. */
416 void add_Block_phi(ir_node *block, ir_node *phi);
417 /** Get the Block mark (single bit). */
418 unsigned get_Block_mark(const ir_node *block);
419 /** Set the Block mark (single bit). */
420 void set_Block_mark(ir_node *block, unsigned mark);
422 /** Return the number of Keep alive node. */
423 int get_End_n_keepalives(const ir_node *end);
424 /** Return the Keep alive node a position pos. */
425 ir_node *get_End_keepalive(const ir_node *end, int pos);
426 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
427 void add_End_keepalive(ir_node *end, ir_node *ka);
428 /** Set the Keep alive node at position pos. */
429 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
432 * Set new keep-alives.
433 * Beware: This might be an expensive operation if dynamic edges are enabled,
434 * so avoid it in the backend.
436 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
438 /** Remove irn from the keep-alive set. */
439 void remove_End_keepalive(ir_node *end, ir_node *irn);
441 /** Some parts of the End node are allocated separately -- their memory
442 is not recovered by dead_node_elimination if a End node is dead.
443 free_End() frees these data structures. */
444 void free_End(ir_node *end);
446 /** Return the target address of an IJmp */
447 ir_node *get_IJmp_target(const ir_node *ijmp);
448 /** Sets the target address of an IJmp */
449 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
451 /* We distinguish three kinds of Cond nodes. These can be distinguished
452 by the mode of the selector operand and an internal flag of type cond_kind.
453 First we distinguish binary Conds and switch Conds.
454 A binary Cond has as selector a boolean value. Proj(0) projects the control
455 flow for case "False", Proj(1) the control flow for "True". A binary Cond
456 is recognized by the boolean selector.
457 The switch Cond has as selector an unsigned integer. It produces as result
458 an n+1 Tuple (cf0, ... , cfn) of control flows.
459 We differ two flavors of this Cond. The first, the dense Cond, passes
460 control along output i if the selector value is i, 0 <= i <= n. If the
461 selector value is >n it passes control along output n.
462 The second Cond flavor differences in the treatment of cases not specified in
463 the source program. It magically knows about the existence of Proj nodes.
464 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
465 exists. Else it passes control along output n (even if this Proj does not
466 exist.) This Cond we call "fragmentary". There is a special constructor
467 new_defaultProj that automatically sets the flavor.
468 The two switch flavors are distinguished by a flag of type cond_kind.
469 Default flavor is "dense"
472 dense, /**< Default. Missing Proj nodes are dead control flow. */
473 fragmentary /**< Special. No control flow optimizations allowed. Missing
474 Proj nodes mean default control flow, i.e., Proj(n). */
477 ir_node *get_Cond_selector(const ir_node *node);
478 void set_Cond_selector(ir_node *node, ir_node *selector);
479 cond_kind get_Cond_kind(const ir_node *node);
480 void set_Cond_kind(ir_node *node, cond_kind kind);
481 long get_Cond_defaultProj(const ir_node *node);
484 * Projection numbers for conditions.
487 pn_Cond_false, /**< Control flow if operand is "false". */
488 pn_Cond_true, /**< Control flow if operand is "true". */
489 pn_Cond_max /**< number of projections from a Cond */
490 } pn_Cond; /* Projection numbers for Cond. */
492 ir_node *get_Return_mem(const ir_node *node);
493 void set_Return_mem(ir_node *node, ir_node *mem);
494 ir_node **get_Return_res_arr(ir_node *node);
495 int get_Return_n_ress(const ir_node *node);
496 ir_node *get_Return_res(const ir_node *node, int pos);
497 void set_Return_res(ir_node *node, int pos, ir_node *res);
499 tarval *get_Const_tarval(const ir_node *node);
500 void set_Const_tarval(ir_node *node, tarval *con);
502 /** Return non-zero if the given Const node represents the 0 constant. */
503 int is_Const_null(const ir_node *node);
505 /** Return non-zero if the given Const node represents the 1 constant. */
506 int is_Const_one(const ir_node *node);
508 /** Return non-zero if the given Const node represents the constant with all bits set. */
509 int is_Const_all_one(const ir_node *node);
511 /** Returns the source language type of a Const node.
512 * Must be an atomic type. Mode of type must be mode of node.
514 ir_type *get_Const_type(ir_node *node);
516 /** Sets the source language type of a Const node. */
517 void set_Const_type(ir_node *node, ir_type *tp);
519 /** This enum names the three different kinds of symbolic Constants
520 represented by SymConst. The content of the attribute type_or_id
521 depends on this tag. Use the proper access routine after testing
524 symconst_type_tag, /**< The SymConst is a type tag for the given type.
525 symconst_symbol is type *. */
526 symconst_type_size, /**< The SymConst is the size of the given type.
527 symconst_symbol is type *. */
528 symconst_type_align, /**< The SymConst is the alignment of the given type.
529 symconst_symbol is type *. */
530 symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
531 by the linker. The pointer is represented by a string.
532 symconst_symbol is ident *. */
533 symconst_addr_ent, /**< The SymConst is a symbolic pointer to be filled in
534 by the linker. The pointer is represented by an entity.
535 symconst_symbol is entity *. */
536 symconst_ofs_ent, /**< The SymConst is the offset of its entity in the entities
538 symconst_enum_const, /**< The SymConst is a enumeration constant of an
540 symconst_label /**< The SymConst is a label address. */
543 /** Returns non-zero if s symconst kind has a type attribute */
544 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
546 /** Returns non-zero if s symconst kind has an ident attribute */
547 #define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)
549 /** Returns non-zero if s symconst kind has an entity attribute */
550 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
552 /** Returns non-zero if s symconst kind has an enum_const attribute */
553 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
555 /** Returns non-zero if s symconst kind has a label attribute */
556 #define SYMCONST_HAS_LABEL(kind) ((kind) == symconst_label)
558 /** SymConst attribute.
560 * This union contains the symbolic information represented by the node.
562 typedef union symconst_symbol {
563 ir_type *type_p; /**< The type of a SymConst. */
564 ident *ident_p; /**< The ident of a SymConst. */
565 ir_entity *entity_p; /**< The entity of a SymConst. */
566 ir_enum_const *enum_p; /**< The enumeration constant of a SymConst. */
567 ir_label_t label; /**< The label of a SymConst. */
570 /** Get the kind of the SymConst. */
571 symconst_kind get_SymConst_kind(const ir_node *node);
572 /** Set the kind of the SymConst. */
573 void set_SymConst_kind(ir_node *node, symconst_kind num);
575 /** Only to access SymConst of kind type_tag or size. Else assertion: */
576 ir_type *get_SymConst_type(ir_node *node);
577 void set_SymConst_type(ir_node *node, ir_type *tp);
579 /** Only to access SymConst of kind addr_name. Else assertion: */
580 ident *get_SymConst_name(const ir_node *node);
581 void set_SymConst_name(ir_node *node, ident *name);
583 /** Only to access SymConst of kind addr_ent. Else assertion: */
584 ir_entity *get_SymConst_entity(const ir_node *node);
585 void set_SymConst_entity(ir_node *node, ir_entity *ent);
587 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
588 ir_enum_const *get_SymConst_enum(const ir_node *node);
589 void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
591 /** Sets both: type and ptrinfo. Needed to treat the node independent of
592 its semantics. Does a memcpy for the memory sym points to. */
593 /* write 'union': firmjni then does not create a method... */
594 union symconst_symbol get_SymConst_symbol(const ir_node *node);
595 void set_SymConst_symbol(ir_node *node,
596 union symconst_symbol sym);
598 /** Only to access SymConst of kind symconst_label. Else assertion: */
599 ir_label_t get_SymConst_label(const ir_node *node);
600 void set_SymConst_label(ir_node *node, ir_label_t label);
603 /** Access the type of the value represented by the SymConst.
605 * Example: primitive type int for SymConst size. */
606 ir_type *get_SymConst_value_type(ir_node *node);
607 void set_SymConst_value_type(ir_node *node, ir_type *tp);
609 ir_node *get_Sel_mem(const ir_node *node);
610 void set_Sel_mem(ir_node *node, ir_node *mem);
611 ir_node *get_Sel_ptr(const ir_node *node); /* ptr to the object to select from */
612 void set_Sel_ptr(ir_node *node, ir_node *ptr);
613 ir_node **get_Sel_index_arr(ir_node *node);
614 int get_Sel_n_indexs(const ir_node *node);
615 ir_node *get_Sel_index(const ir_node *node, int pos);
616 void set_Sel_index(ir_node *node, int pos, ir_node *index);
617 ir_entity *get_Sel_entity(const ir_node *node); /* entity to select */
618 void set_Sel_entity (ir_node *node, ir_entity *ent);
621 * Projection numbers for result of Call node: use for Proj nodes!
624 pn_Call_M_regular = pn_Generic_M_regular, /**< The memory result. */
625 pn_Call_X_regular = pn_Generic_X_regular, /**< The control flow result when no exception occurs. */
626 pn_Call_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler. */
627 pn_Call_T_result = pn_Generic_other, /**< The tuple containing all (0, 1, 2, ...) results. */
628 pn_Call_M_except, /**< The memory result in case the called method terminated with
630 pn_Call_P_value_res_base, /**< A pointer to the memory region containing copied results
631 passed by value (for compound result types). */
632 pn_Call_max /**< number of projections from a Call */
633 } pn_Call; /* Projection numbers for Call. */
634 #define pn_Call_M pn_Call_M_regular
636 ir_node *get_Call_mem(const ir_node *node);
637 void set_Call_mem(ir_node *node, ir_node *mem);
638 ir_node *get_Call_ptr(const ir_node *node);
639 void set_Call_ptr(ir_node *node, ir_node *ptr);
640 ir_node **get_Call_param_arr(ir_node *node);
641 /** Gets the number of parameters of a call. */
642 int get_Call_n_params(const ir_node *node);
643 /** Gets the call parameter at position pos. */
644 ir_node *get_Call_param(const ir_node *node, int pos);
645 /** Sets the call parameter at position pos. */
646 void set_Call_param(ir_node *node, int pos, ir_node *param);
647 /** Gets the type of a call. */
648 ir_type *get_Call_type(ir_node *node);
649 /** Sets the type of a call. */
650 void set_Call_type(ir_node *node, ir_type *tp);
651 /** Gets the arity of a call. Identical to get_Call_n_params(). */
652 int get_Call_arity(const ir_node *node);
655 * Returns non-zero if a Call is surely a self-recursive Call.
656 * Beware: if this functions returns 0, the call might be self-recursive!
658 int is_self_recursive_Call(const ir_node *call);
660 /** Set, get and remove the callee information for a Call node.
662 * The callee information lists all method entities that can be called
663 * from this node. If the address expression can not be analyzed fully,
664 * e.g., as entities can be called that are not in the compilation unit,
665 * the array contains the unknown_entity. The array contains only entities
666 * with peculiarity_existent, but with all kinds of visibility. The entities
667 * not necessarily contain an irg.
669 * The array is only accessible if callee information is valid. See flag
672 * The memory allocated for the array is managed automatically, i.e., it must
673 * not be freed if the Call node is removed from the graph.
675 * @param node A Call node.
677 int Call_has_callees(const ir_node *node);
678 int get_Call_n_callees(const ir_node *node);
679 ir_entity *get_Call_callee(const ir_node *node, int pos);
681 /** Set the full callee array.
683 * The passed array is copied. Assumes current_ir_graph set properly! */
684 void set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
685 void remove_Call_callee_arr(ir_node *node);
687 ir_node *get_CallBegin_ptr(const ir_node *node);
688 void set_CallBegin_ptr(ir_node *node, ir_node *ptr);
689 ir_node *get_CallBegin_call(const ir_node *node);
690 void set_CallBegin_call(ir_node *node, ir_node *call);
692 /* For unary and binary arithmetic operations the access to the
693 operands can be factored out. Left is the first, right the
694 second arithmetic value as listed in tech report 1999-44.
695 unops are: Minus, Abs, Not, Conv, Cast
696 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
697 Shr, Shrs, Rotl, Cmp */
698 int is_unop(const ir_node *node);
699 ir_node *get_unop_op(const ir_node *node);
700 void set_unop_op(ir_node *node, ir_node *op);
701 int is_binop(const ir_node *node);
702 ir_node *get_binop_left(const ir_node *node);
703 void set_binop_left(ir_node *node, ir_node *left);
704 ir_node *get_binop_right(const ir_node *node);
705 void set_binop_right(ir_node *node, ir_node *right);
707 ir_node *get_Add_left(const ir_node *node);
708 void set_Add_left(ir_node *node, ir_node *left);
709 ir_node *get_Add_right(const ir_node *node);
710 void set_Add_right(ir_node *node, ir_node *right);
712 ir_node *get_Sub_left(const ir_node *node);
713 void set_Sub_left(ir_node *node, ir_node *left);
714 ir_node *get_Sub_right(const ir_node *node);
715 void set_Sub_right(ir_node *node, ir_node *right);
717 ir_node *get_Minus_op(const ir_node *node);
718 void set_Minus_op(ir_node *node, ir_node *op);
720 ir_node *get_Mul_left(const ir_node *node);
721 void set_Mul_left(ir_node *node, ir_node *left);
722 ir_node *get_Mul_right(const ir_node *node);
723 void set_Mul_right(ir_node *node, ir_node *right);
725 ir_node *get_Mulh_left(const ir_node *node);
726 void set_Mulh_left(ir_node *node, ir_node *left);
727 ir_node *get_Mulh_right(const ir_node *node);
728 void set_Mulh_right(ir_node *node, ir_node *right);
730 ir_node *get_Quot_left(const ir_node *node);
731 void set_Quot_left(ir_node *node, ir_node *left);
732 ir_node *get_Quot_right(const ir_node *node);
733 void set_Quot_right(ir_node *node, ir_node *right);
734 ir_node *get_Quot_mem(const ir_node *node);
735 void set_Quot_mem(ir_node *node, ir_node *mem);
736 ir_mode *get_Quot_resmode(const ir_node *node);
737 void set_Quot_resmode(ir_node *node, ir_mode *mode);
740 * Projection numbers for Quot: use for Proj nodes!
743 pn_Quot_M = pn_Generic_M_regular, /**< Memory result. */
744 pn_Quot_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
745 pn_Quot_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
746 pn_Quot_res = pn_Generic_other, /**< Result of computation. */
747 pn_Quot_max /**< number of projections from a Quot */
748 } pn_Quot; /* Projection numbers for Quot. */
750 ir_node *get_DivMod_left(const ir_node *node);
751 void set_DivMod_left(ir_node *node, ir_node *left);
752 ir_node *get_DivMod_right(const ir_node *node);
753 void set_DivMod_right(ir_node *node, ir_node *right);
754 ir_node *get_DivMod_mem(const ir_node *node);
755 void set_DivMod_mem(ir_node *node, ir_node *mem);
756 ir_mode *get_DivMod_resmode(const ir_node *node);
757 void set_DivMod_resmode(ir_node *node, ir_mode *mode);
760 * Projection numbers for DivMod: use for Proj nodes!
763 pn_DivMod_M = pn_Generic_M_regular, /**< Memory result. */
764 pn_DivMod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
765 pn_DivMod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
766 pn_DivMod_res_div = pn_Generic_other, /**< Result of computation a / b. */
767 pn_DivMod_res_mod, /**< Result of computation a % b. */
768 pn_DivMod_max /**< number of projections from a DivMod */
769 } pn_DivMod; /* Projection numbers for DivMod. */
771 ir_node *get_Div_left(const ir_node *node);
772 void set_Div_left(ir_node *node, ir_node *left);
773 ir_node *get_Div_right(const ir_node *node);
774 void set_Div_right(ir_node *node, ir_node *right);
775 ir_node *get_Div_mem(const ir_node *node);
776 void set_Div_mem(ir_node *node, ir_node *mem);
777 ir_mode *get_Div_resmode(const ir_node *node);
778 void set_Div_resmode(ir_node *node, ir_mode *mode);
779 int is_Div_remainderless(const ir_node *node);
782 * Projection numbers for Div: use for Proj nodes!
785 pn_Div_M = pn_Generic_M_regular, /**< Memory result. */
786 pn_Div_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
787 pn_Div_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
788 pn_Div_res = pn_Generic_other, /**< Result of computation. */
789 pn_Div_max /**< number of projections from a Div */
790 } pn_Div; /* Projection numbers for Div. */
792 ir_node *get_Mod_left(const ir_node *node);
793 void set_Mod_left(ir_node *node, ir_node *left);
794 ir_node *get_Mod_right(const ir_node *node);
795 void set_Mod_right(ir_node *node, ir_node *right);
796 ir_node *get_Mod_mem(const ir_node *node);
797 void set_Mod_mem(ir_node *node, ir_node *mem);
798 ir_mode *get_Mod_resmode(const ir_node *node);
799 void set_Mod_resmode(ir_node *node, ir_mode *mode);
802 * Projection numbers for Mod: use for Proj nodes!
805 pn_Mod_M = pn_Generic_M_regular, /**< Memory result. */
806 pn_Mod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
807 pn_Mod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
808 pn_Mod_res = pn_Generic_other, /**< Result of computation. */
809 pn_Mod_max /**< number of projections from a Mod */
810 } pn_Mod; /* Projection numbers for Mod. */
812 ir_node *get_Abs_op(const ir_node *node);
813 void set_Abs_op(ir_node *node, ir_node *op);
815 ir_node *get_And_left(const ir_node *node);
816 void set_And_left(ir_node *node, ir_node *left);
817 ir_node *get_And_right(const ir_node *node);
818 void set_And_right(ir_node *node, ir_node *right);
820 ir_node *get_Or_left(const ir_node *node);
821 void set_Or_left(ir_node *node, ir_node *left);
822 ir_node *get_Or_right(const ir_node *node);
823 void set_Or_right(ir_node *node, ir_node *right);
825 ir_node *get_Eor_left(const ir_node *node);
826 void set_Eor_left(ir_node *node, ir_node *left);
827 ir_node *get_Eor_right(const ir_node *node);
828 void set_Eor_right(ir_node *node, ir_node *right);
830 ir_node *get_Not_op(const ir_node *node);
831 void set_Not_op(ir_node *node, ir_node *op);
834 * Projection numbers for Cmp are defined several times.
835 * The bit patterns are used for various tests, so don't change.
836 * The "unordered" values are possible results of comparing
837 * floating point numbers.
838 * Note that the encoding is imported, so do NOT change the order.
841 pn_Cmp_False = 0, /**< false */
842 pn_Cmp_Eq = 1, /**< equal */
843 pn_Cmp_Lt = 2, /**< less */
844 pn_Cmp_Le = pn_Cmp_Eq|pn_Cmp_Lt, /**< less or equal */
845 pn_Cmp_Gt = 4, /**< greater */
846 pn_Cmp_Ge = pn_Cmp_Eq|pn_Cmp_Gt, /**< greater or equal */
847 pn_Cmp_Lg = pn_Cmp_Lt|pn_Cmp_Gt, /**< less or greater */
848 pn_Cmp_Leg = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
849 pn_Cmp_Uo = 8, /**< unordered */
850 pn_Cmp_Ue = pn_Cmp_Uo|pn_Cmp_Eq, /**< unordered or equal */
851 pn_Cmp_Ul = pn_Cmp_Uo|pn_Cmp_Lt, /**< unordered or less */
852 pn_Cmp_Ule = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
853 pn_Cmp_Ug = pn_Cmp_Uo|pn_Cmp_Gt, /**< unordered or greater */
854 pn_Cmp_Uge = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
855 pn_Cmp_Ne = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
856 pn_Cmp_True = 15 /**< true */
857 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for JNI interface */
858 } pn_Cmp; /* Projection numbers for Cmp */
859 /* #define not_mask pn_Cmp_Leg */
861 /** returns the pnc name from an pnc constant */
862 const char *get_pnc_string(int pnc);
864 /** Calculates the negated (Complement(R)) pnc condition. */
865 pn_Cmp get_negated_pnc(long pnc, ir_mode *mode);
867 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
868 pn_Cmp get_inversed_pnc(long pnc);
870 /** An alternative name for get_inversed_pnc() that can be better memorized. */
871 #define get_mirrored_pnc(pnc) get_inversed_pnc(pnc)
873 ir_node *get_Cmp_left(const ir_node *node);
874 void set_Cmp_left(ir_node *node, ir_node *left);
875 ir_node *get_Cmp_right(const ir_node *node);
876 void set_Cmp_right(ir_node *node, ir_node *right);
878 ir_node *get_Shl_left(const ir_node *node);
879 void set_Shl_left(ir_node *node, ir_node *left);
880 ir_node *get_Shl_right(const ir_node *node);
881 void set_Shl_right(ir_node *node, ir_node *right);
883 ir_node *get_Shr_left(const ir_node *node);
884 void set_Shr_left(ir_node *node, ir_node *left);
885 ir_node *get_Shr_right(const ir_node *node);
886 void set_Shr_right(ir_node *node, ir_node *right);
888 ir_node *get_Shrs_left(const ir_node *node);
889 void set_Shrs_left(ir_node *node, ir_node *left);
890 ir_node *get_Shrs_right(const ir_node *node);
891 void set_Shrs_right(ir_node *node, ir_node *right);
893 ir_node *get_Rotl_left(const ir_node *node);
894 void set_Rotl_left(ir_node *node, ir_node *left);
895 ir_node *get_Rotl_right(const ir_node *node);
896 void set_Rotl_right(ir_node *node, ir_node *right);
898 ir_node *get_Conv_op(const ir_node *node);
899 void set_Conv_op(ir_node *node, ir_node *op);
900 int get_Conv_strict(const ir_node *node);
901 void set_Conv_strict(ir_node *node, int flag);
903 /* Does Cast need a mem operator?
904 * Cast should only depend on the type, not on the state of an
905 * entity. But: we initialize various fields after Alloc, that
906 * are accessed in the cast. This required some precaution, to
907 * get the right memory into the Loads generated from the cast.
909 ir_node *get_Cast_op(const ir_node *node);
910 void set_Cast_op(ir_node *node, ir_node *op);
911 ir_type *get_Cast_type(ir_node *node);
912 void set_Cast_type(ir_node *node, ir_type *to_tp);
914 /** Checks for upcast.
916 * Returns true if the Cast node casts a class type to a super type.
917 * Works also for pointers to classes (recursively).
919 * Needs typeinfo calculated.
921 int is_Cast_upcast(ir_node *node);
923 /** Checks for downcast.
925 * Returns true if the Cast node casts a class type to a sub type.
926 * Works also for pointers to classes (recursively).
928 * Needs typeinfo calculated.
930 int is_Cast_downcast(ir_node *node);
933 /** Returns true if n is a Phi or a Filter node in INTER-procedural view.
934 Returns false if irg is in phase phase_building and the Phi has zero
935 predecessors: it's a Phi0. */
936 int is_Phi(const ir_node *n);
937 /** Returns true if irg in phase phase_building and the Phi has zero
938 predecessors. It's a Phi0 then. */
939 int is_Phi0(const ir_node *n);
940 /* These routines also work for Filter nodes in INTER-procedural view. */
941 ir_node **get_Phi_preds_arr(ir_node *node);
942 int get_Phi_n_preds(const ir_node *node);
943 ir_node *get_Phi_pred(const ir_node *node, int pos);
944 void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
945 ir_node *get_Phi_next(const ir_node *phi);
946 void set_Phi_next(ir_node *phi, ir_node *next);
948 ir_node *get_Filter_pred(ir_node *node);
949 void set_Filter_pred(ir_node *node, ir_node *pred);
950 long get_Filter_proj(ir_node *node);
951 void set_Filter_proj(ir_node *node, long proj);
952 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
953 * @@@ Maybe better: arity is zero if no cg preds. */
954 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
955 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
956 int get_Filter_n_cg_preds(ir_node *node);
957 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
959 /** Return true if parameter is a memory operation.
961 * A memory operation is an operation that changes the
962 * memory. I.e., a Load or a Store operation.
964 int is_memop(const ir_node *node);
965 ir_node *get_memop_mem(const ir_node *node);
966 void set_memop_mem(ir_node *node, ir_node *mem);
967 ir_node *get_memop_ptr(const ir_node *node);
968 void set_memop_ptr(ir_node *node, ir_node *ptr);
971 * Projection numbers for Load: use for Proj nodes!
974 pn_Load_M = pn_Generic_M_regular, /**< Memory result. */
975 pn_Load_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
976 pn_Load_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
977 pn_Load_res = pn_Generic_other, /**< Result of load operation. */
978 pn_Load_max /**< number of projections from a Load */
979 } pn_Load; /* Projection numbers for Load. */
981 ir_node *get_Load_mem(const ir_node *node);
982 void set_Load_mem(ir_node *node, ir_node *mem);
983 ir_node *get_Load_ptr(const ir_node *node);
984 void set_Load_ptr(ir_node *node, ir_node *ptr);
985 ir_mode *get_Load_mode(const ir_node *node);
986 void set_Load_mode(ir_node *node, ir_mode *mode);
987 ir_volatility get_Load_volatility(const ir_node *node);
988 void set_Load_volatility(ir_node *node, ir_volatility volatility);
989 ir_align get_Load_align(const ir_node *node);
990 void set_Load_align(ir_node *node, ir_align align);
993 * Projection numbers for Store: use for Proj nodes!
996 pn_Store_M = pn_Generic_M_regular, /**< Memory result. */
997 pn_Store_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
998 pn_Store_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
999 pn_Store_max = pn_Generic_other /**< number of projections from a Store */
1000 } pn_Store; /* Projection numbers for Store. */
1002 ir_node *get_Store_mem(const ir_node *node);
1003 void set_Store_mem(ir_node *node, ir_node *mem);
1004 ir_node *get_Store_ptr(const ir_node *node);
1005 void set_Store_ptr(ir_node *node, ir_node *ptr);
1006 ir_node *get_Store_value(const ir_node *node);
1007 void set_Store_value(ir_node *node, ir_node *value);
1008 ir_volatility get_Store_volatility(const ir_node *node);
1009 void set_Store_volatility(ir_node *node, ir_volatility volatility);
1010 ir_align get_Store_align(const ir_node *node);
1011 void set_Store_align(ir_node *node, ir_align align);
1014 * Projection numbers for Alloc: use for Proj nodes!
1017 pn_Alloc_M = pn_Generic_M_regular, /**< Memory result. */
1018 pn_Alloc_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1019 pn_Alloc_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
1020 pn_Alloc_res = pn_Generic_other, /**< Result of allocation. */
1021 pn_Alloc_max /**< number of projections from an Alloc */
1022 } pn_Alloc; /* Projection numbers for Alloc. */
1024 ir_node *get_Alloc_mem(const ir_node *node);
1025 void set_Alloc_mem(ir_node *node, ir_node *mem);
1026 ir_node *get_Alloc_size(const ir_node *node);
1027 void set_Alloc_size(ir_node *node, ir_node *size);
1028 ir_type *get_Alloc_type(ir_node *node);
1029 void set_Alloc_type(ir_node *node, ir_type *tp);
1031 /** The allocation place. */
1033 stack_alloc, /**< Alloc allocates the object on the stack. */
1034 heap_alloc /**< Alloc allocates the object on the heap. */
1037 ir_where_alloc get_Alloc_where(const ir_node *node);
1038 void set_Alloc_where(ir_node *node, ir_where_alloc where);
1040 ir_node *get_Free_mem(const ir_node *node);
1041 void set_Free_mem(ir_node *node, ir_node *mem);
1042 ir_node *get_Free_ptr(const ir_node *node);
1043 void set_Free_ptr(ir_node *node, ir_node *ptr);
1044 ir_node *get_Free_size(const ir_node *node);
1045 void set_Free_size(ir_node *node, ir_node *size);
1046 ir_type *get_Free_type(ir_node *node);
1047 void set_Free_type(ir_node *node, ir_type *tp);
1049 ir_where_alloc get_Free_where(const ir_node *node);
1050 void set_Free_where(ir_node *node, ir_where_alloc where);
1052 ir_node **get_Sync_preds_arr(ir_node *node);
1053 int get_Sync_n_preds(const ir_node *node);
1054 ir_node *get_Sync_pred(const ir_node *node, int pos);
1055 void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
1056 void add_Sync_pred(ir_node *node, ir_node *pred);
1058 /** Returns the source language type of a Proj node.
1059 * Must be an atomic type. Mode of type must be mode of node.
1061 ir_type *get_Proj_type(ir_node *node);
1063 /** Return the predecessor of a Proj node. */
1064 ir_node *get_Proj_pred(const ir_node *node);
1065 void set_Proj_pred(ir_node *node, ir_node *pred);
1066 /** Return the projection number of a Proj node. */
1067 long get_Proj_proj(const ir_node *node);
1068 void set_Proj_proj(ir_node *node, long proj);
1070 ir_node **get_Tuple_preds_arr(ir_node *node);
1071 int get_Tuple_n_preds(const ir_node *node);
1072 ir_node *get_Tuple_pred(const ir_node *node, int pos);
1073 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
1075 ir_node *get_Id_pred(const ir_node *node);
1076 void set_Id_pred(ir_node *node, ir_node *pred);
1078 /** Confirm has a single result and returns 'value' unchanged.
1079 * The node expresses a restriction on 'value':
1080 * 'value' 'cmp' 'bound' == true. */
1081 ir_node *get_Confirm_value(const ir_node *node);
1082 void set_Confirm_value(ir_node *node, ir_node *value);
1083 ir_node *get_Confirm_bound(const ir_node *node);
1084 void set_Confirm_bound(ir_node *node, ir_node *bound);
1085 pn_Cmp get_Confirm_cmp(const ir_node *node);
1086 void set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
1089 * Mux Support: Note that Psi nodes with one condition can be handled
1090 * like Mux nodes, and the access functions work as expected.
1092 ir_node *get_Mux_sel(const ir_node *node);
1093 void set_Mux_sel(ir_node *node, ir_node *sel);
1094 ir_node *get_Mux_false(const ir_node *node);
1095 void set_Mux_false(ir_node *node, ir_node *ir_false);
1096 ir_node *get_Mux_true(const ir_node *node);
1097 void set_Mux_true(ir_node *node, ir_node *ir_true);
1099 ir_node *get_Psi_cond(const ir_node *node, int pos);
1100 void set_Psi_cond(ir_node *node, int pos, ir_node *cond);
1101 ir_node *get_Psi_val(const ir_node *node, int pos);
1102 void set_Psi_val(ir_node *node, int pos, ir_node *val);
1103 ir_node *get_Psi_default(const ir_node *node);
1104 void set_Psi_default(ir_node *node, ir_node *val);
1105 int get_Psi_n_conds(const ir_node *node);
1108 * Projection numbers for result of CopyB node: use for Proj nodes!
1111 pn_CopyB_M_regular = pn_Generic_M_regular, /**< The memory result. */
1112 pn_CopyB_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1113 pn_CopyB_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1114 pn_CopyB_M_except = pn_Generic_other, /**< The memory result in case the runtime function terminated with
1116 pn_CopyB_max /**< number of projections from a CopyB */
1117 } pn_CopyB; /* Projection numbers for CopyB. */
1118 #define pn_CopyB_M pn_CopyB_M_regular
1120 ir_node *get_CopyB_mem(const ir_node *node);
1121 void set_CopyB_mem(ir_node *node, ir_node *mem);
1122 ir_node *get_CopyB_dst(const ir_node *node);
1123 void set_CopyB_dst(ir_node *node, ir_node *dst);
1124 ir_node *get_CopyB_src(const ir_node *node);
1125 void set_CopyB_src(ir_node *node, ir_node *src);
1126 ir_type *get_CopyB_type(ir_node *node);
1127 void set_CopyB_type(ir_node *node, ir_type *data_type);
1130 * Projection numbers for result of InstOf node: use for Proj nodes!
1133 pn_InstOf_M_regular = pn_Generic_M_regular, /**< The memory result. */
1134 pn_InstOf_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1135 pn_InstOf_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1136 pn_InstOf_res = pn_Generic_other, /**< The checked object pointer. */
1137 pn_InstOf_M_except, /**< The memory result in case the runtime function terminated with
1139 pn_InstOf_max /**< number of projections from an InstOf */
1141 #define pn_InstOf_M pn_InstOf_M_regular
1143 /** InstOf access. */
1144 ir_type *get_InstOf_type(ir_node *node);
1145 void set_InstOf_type(ir_node *node, ir_type *type);
1146 ir_node *get_InstOf_store(const ir_node *node);
1147 void set_InstOf_store(ir_node *node, ir_node *obj);
1148 ir_node *get_InstOf_obj(const ir_node *node);
1149 void set_InstOf_obj(ir_node *node, ir_node *obj);
1152 * Projection numbers for Raise.
1155 pn_Raise_M = pn_Generic_M_regular, /**< The Memory result. */
1156 pn_Raise_X = pn_Generic_X_regular, /**< The control flow to the exception handler. */
1157 pn_Raise_max /**< number of projections from a Raise */
1158 } pn_Raise; /* Projection numbers for Raise. */
1160 ir_node *get_Raise_mem(const ir_node *node);
1161 void set_Raise_mem(ir_node *node, ir_node *mem);
1162 ir_node *get_Raise_exo_ptr(const ir_node *node); /* PoinTeR to EXception Object */
1163 void set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
1166 * Projection numbers for result of Bound node: use for Proj nodes!
1169 pn_Bound_M = pn_Generic_M_regular, /**< The memory result. */
1170 pn_Bound_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1171 pn_Bound_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1172 pn_Bound_res = pn_Generic_other, /**< The checked index. */
1173 pn_Bound_max /**< number of projections from a Bound */
1176 /** Returns the memory input of a Bound operation. */
1177 ir_node *get_Bound_mem(const ir_node *bound);
1178 void set_Bound_mem(ir_node *bound, ir_node *mem);
1180 /** Returns the index input of a Bound operation. */
1181 ir_node *get_Bound_index(const ir_node *bound);
1182 void set_Bound_index(ir_node *bound, ir_node *idx);
1184 /** Returns the lower bound input of a Bound operation. */
1185 ir_node *get_Bound_lower(const ir_node *bound);
1186 void set_Bound_lower(ir_node *bound, ir_node *lower);
1188 /** Returns the upper bound input of a Bound operation. */
1189 ir_node *get_Bound_upper(const ir_node *bound);
1190 void set_Bound_upper(ir_node *bound, ir_node *upper);
1192 /** Return the operand of a Pin node. */
1193 ir_node *get_Pin_op(const ir_node *pin);
1194 void set_Pin_op(ir_node *pin, ir_node *node);
1196 /** A input/output constraint attribute */
1198 unsigned pos; /**< The inputs/output position for this constraint. */
1199 ident *constraint; /**< The constraint for this input/output. */
1200 ir_mode *mode; /**< The mode of the constraint. */
1201 } ir_asm_constraint;
1203 /** Return the assembler text of an ASM pseudo node. */
1204 ident *get_ASM_text(const ir_node *node);
1205 /** Return the number of input constraints for an ASM node. */
1206 int get_ASM_n_input_constraints(const ir_node *node);
1207 /** Return the input constraints for an ASM node. */
1208 const ir_asm_constraint *get_ASM_input_constraints(const ir_node *node);
1209 /** Return the number of output constraints for an ASM node. */
1210 int get_ASM_n_output_constraints(const ir_node *node);
1211 /** Return the output constraints for an ASM node. */
1212 const ir_asm_constraint *get_ASM_output_constraints(const ir_node *node);
1213 /** Return the number of clobbered registers for an ASM node. */
1214 int get_ASM_n_clobbers(const ir_node *node);
1215 /** Return the list of clobbered registers for an ASM node. */
1216 ident **get_ASM_clobbers(const ir_node *node);
1220 * NAME Auxiliary routines
1224 /** Returns operand of node if node is a Proj. */
1225 ir_node *skip_Proj(ir_node *node);
1226 /** Returns operand of node if node is a Proj. */
1227 const ir_node *skip_Proj_const(const ir_node *node);
1228 /** Returns operand of node if node is a Id. */
1229 ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
1230 /** Returns corresponding operand of Tuple if node is a Proj from
1232 ir_node *skip_Tuple(ir_node *node);
1233 /** returns operand of node if node is a Cast. */
1234 ir_node *skip_Cast(ir_node *node);
1235 /** Returns operand of node if node is a Confirm */
1236 ir_node *skip_Confirm(ir_node *node);
1237 /** Skip all high-level Operations (including Cast, Confirm). */
1238 ir_node *skip_HighLevel_ops(ir_node *node);
1239 /** Returns true if irn is a Const node. */
1240 int is_Const(const ir_node *node);
1241 /** Returns true if a node is a Conv node. */
1242 int is_Conv(const ir_node *node);
1243 /** Returns true if a node is a strictConv node. */
1244 int is_strictConv(const ir_node *node);
1245 /** Returns true if a node is a Cast node. */
1246 int is_Cast(const ir_node *node);
1247 /** Returns true if node is a Bad node. */
1248 int is_Bad(const ir_node *node);
1249 /** Returns true if node is a NoMem node. */
1250 int is_NoMem(const ir_node *node);
1251 /** Returns true if node is a Start node. */
1252 int is_Start(const ir_node *node);
1253 /** Returns true if node is a Minus node. */
1254 int is_Minus(const ir_node *node);
1255 /** Returns true if node is a Abs node. */
1256 int is_Abs(const ir_node *node);
1257 /** Returns true if node is a Mod node. */
1258 int is_Mod(const ir_node *node);
1259 /** Returns true if node is a Div node. */
1260 int is_Div(const ir_node *node);
1261 /** Returns true if node is a DivMod node. */
1262 int is_DivMod(const ir_node *node);
1263 /** Returns true if node is a Quot node. */
1264 int is_Quot(const ir_node *node);
1265 /** Returns true if node is an Add node. */
1266 int is_Add(const ir_node *node);
1267 /** Returns true if node is an And node. */
1268 int is_And(const ir_node *node);
1269 /** Returns true if node is an Or node. */
1270 int is_Or(const ir_node *node);
1271 /** Returns true if node is an Eor node. */
1272 int is_Eor(const ir_node *node);
1273 /** Returns true if node is a Sub node. */
1274 int is_Sub(const ir_node *node);
1275 /** Returns true if node is a Not node. */
1276 int is_Not(const ir_node *node);
1277 /** Returns true if node is a Shl node. */
1278 int is_Shl(const ir_node *node);
1279 /** Returns true if node is a Shr node. */
1280 int is_Shr(const ir_node *node);
1281 /** Returns true if node is a Shrs node. */
1282 int is_Shrs(const ir_node *node);
1283 /** Returns true if node is a Rotl node. */
1284 int is_Rotl(const ir_node *node);
1285 /** Returns true if node is a Psi node. */
1286 int is_Psi(const ir_node *node);
1287 /** Returns true if node is an Id node. */
1288 int is_Id(const ir_node *node);
1289 /** Returns true if node is a Tuple node. */
1290 int is_Tuple(const ir_node *node);
1291 /** Returns true if node is a Bound node. */
1292 int is_Bound(const ir_node *node);
1293 /** Returns true if the node is not a Block */
1294 int is_no_Block(const ir_node *node);
1295 /** Returns true if the node is a Block */
1296 int is_Block(const ir_node *node);
1297 /** Returns true if node is an Unknown node. */
1298 int is_Unknown(const ir_node *node);
1299 /** Returns true if node is a Return node. */
1300 int is_Return(const ir_node *node);
1301 /** Returns true if node is a Call node. */
1302 int is_Call(const ir_node *node);
1303 /** Returns true if node is a CallBegin node. */
1304 int is_CallBegin(const ir_node *node);
1305 /** Returns true if node is a Sel node. */
1306 int is_Sel(const ir_node *node);
1307 /** Returns true if node is a Mul node. */
1308 int is_Mul(const ir_node *node);
1309 /** Returns true if node is a Mulh node. */
1310 int is_Mulh(const ir_node *node);
1311 /** Returns true if node is a Mux node or a Psi with only one condition. */
1312 int is_Mux(const ir_node *node);
1313 /** Returns true if node is a Load node. */
1314 int is_Load(const ir_node *node);
1315 /** Returns true if node is a Store node. */
1316 int is_Store(const ir_node *node);
1317 /** Returns true if node is a Sync node. */
1318 int is_Sync(const ir_node *node);
1319 /** Returns true if node is a Confirm node. */
1320 int is_Confirm(const ir_node *node);
1321 /** Returns true if node is a Pin node. */
1322 int is_Pin(const ir_node *node);
1323 /** Returns true if node is a SymConst node. */
1324 int is_SymConst(const ir_node *node);
1325 /** Returns true if node is a SymConst node with kind symconst_addr_ent. */
1326 int is_SymConst_addr_ent(const ir_node *node);
1327 /** Returns true if node is a Cond node. */
1328 int is_Cond(const ir_node *node);
1329 /** Returns true of node is a CopyB node. */
1330 int is_CopyB(const ir_node *node);
1331 /** Returns true if node is a Cmp node. */
1332 int is_Cmp(const ir_node *node);
1333 /** Returns true if node is an Alloc node. */
1334 int is_Alloc(const ir_node *node);
1335 /** Returns true if node is a Free node. */
1336 int is_Free(const ir_node *node);
1337 /** Returns true if a node is a Jmp node. */
1338 int is_Jmp(const ir_node *node);
1339 /** Returns true if a node is a IJmp node. */
1340 int is_IJmp(const ir_node *node);
1341 /** Returns true if a node is a Raise node. */
1342 int is_Raise(const ir_node *node);
1343 /** Returns true if a node is an ASM node. */
1344 int is_ASM(const ir_node *node);
1345 /** Returns true if node is a Proj node or a Filter node in INTRA-procedural view. */
1346 int is_Proj(const ir_node *node);
1347 /** Returns true if node is a Filter node. */
1348 int is_Filter(const ir_node *node);
1350 /** Returns true if the operation manipulates control flow:
1351 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1352 int is_cfop(const ir_node *node);
1354 /** Returns true if the operation manipulates interprocedural control flow:
1355 CallBegin, EndReg, EndExcept */
1356 int is_ip_cfop(const ir_node *node);
1357 /** Returns true if the operation can change the control flow because
1358 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1359 Bad. Raise is not fragile, but a unconditional jump. */
1360 int is_fragile_op(const ir_node *node);
1361 /** Returns the memory operand of fragile operations. */
1362 ir_node *get_fragile_op_mem(ir_node *node);
1363 /** Returns the result mode of a Div operation. */
1364 ir_mode *get_divop_resmod(const ir_node *node);
1366 /** Returns true if the operation is a forking control flow
1367 * operation: Cond. */
1368 int is_irn_forking(const ir_node *node);
1370 /** Return the type associated with the value produced by n
1371 * if the node remarks this type as it is the case for
1372 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1373 ir_type *get_irn_type(ir_node *n);
1375 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1377 ir_type *get_irn_type_attr(ir_node *n);
1379 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1380 ir_entity *get_irn_entity_attr(ir_node *n);
1382 /** Returns non-zero for constant-like nodes. */
1383 int is_irn_constlike(const ir_node *node);
1386 * Returns non-zero for nodes that must be always optimized
1387 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1389 int is_irn_always_opt(const ir_node *node);
1392 * Returns non-zero for nodes that are allowed to have keep-alives and
1393 * are neither Block nor PhiM.
1395 int is_irn_keep(const ir_node *node);
1398 * Returns non-zero for nodes that are always placed in the start block.
1400 int is_irn_start_block_placed(const ir_node *node);
1403 * Returns non-zero for nodes that are machine operations.
1405 int is_irn_machine_op(const ir_node *node);
1408 * Returns non-zero for nodes that are machine operands.
1410 int is_irn_machine_operand(const ir_node *node);
1413 * Returns non-zero for nodes that have the n'th user machine flag set.
1415 int is_irn_machine_user(const ir_node *node, unsigned n);
1418 * A type to express conditional jump predictions.
1421 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1422 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1423 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1424 } cond_jmp_predicate;
1426 /** Gets the string representation of the jump prediction .*/
1427 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1429 /** Returns the conditional jump prediction of a Cond node. */
1430 cond_jmp_predicate get_Cond_jmp_pred(const ir_node *cond);
1432 /** Sets a new conditional jump prediction. */
1433 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1435 /** Checks whether a node represents a global address. */
1436 int is_Global(const ir_node *node);
1438 /* Returns the entity of a global address. */
1439 ir_entity *get_Global_entity(const ir_node *node);
1442 * Access custom node data.
1443 * The data must have been registered with
1444 * register_additional_node_data() before.
1445 * @param node The ir node to get the data from.
1446 * @param type The type of the data you registered.
1447 * @param off The value returned by register_additional_node_data().
1448 * @return A pointer of type @p type.
1450 #define get_irn_data(node,type,off) \
1451 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1454 * Get the pointer to the node some custom data belongs to.
1455 * @param data The pointer to the custom data.
1456 * @param off The number as returned by register_additional_node_data().
1457 * @return A pointer to the ir node the custom data belongs to.
1459 #define get_irn_data_base(data,off) \
1460 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1463 * Request additional data to be allocated with an ir node.
1464 * @param size The size of the additional data required.
1465 * @return A positive number, if the operation was successful, which
1466 * must be passed to the access macro get_irn_data(), 0 if the
1467 * registration failed.
1469 unsigned firm_register_additional_node_data(unsigned size);
1472 * Return a pointer to the node attributes.
1473 * Needed for user-defined nodes.
1475 void *get_irn_generic_attr(ir_node *node);
1476 const void *get_irn_generic_attr_const(const ir_node *node);
1479 * Returns the unique node index for the node in its graph.
1480 * This index is used to access phase information for this node.
1482 unsigned get_irn_idx(const ir_node *node);
1485 * Sets the debug information of a node.
1487 * @param n The node.
1488 * @param db The debug info.
1490 void set_irn_dbg_info(ir_node *n, dbg_info *db);
1493 * Returns the debug information of an node.
1495 * @param n The node.
1497 dbg_info *get_irn_dbg_info(const ir_node *n);
1499 /*-----------------------------------------------------------------*/
1501 /*-----------------------------------------------------------------*/
1504 /** Debug print the node.
1506 * Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
1507 * is set. Else does nothing. */
1508 void dump_irn(const ir_node *n);
1510 /*@}*/ /* end of ir_node group definition */