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 * This is only allowed in phase_backend!
123 * @param node The node.
124 * @param dep The dependency target.
126 * @return The index in the array (get_irn_dep() with that index returns @p dep).
128 int add_irn_dep(ir_node *node, ir_node *dep);
131 * Copy all dependencies from a node to another.
132 * This is only allowed in phase_backend!
134 * @param tgt The node which should be enriched.
135 * @param src The node whose dependencies shall be copied.
137 void add_irn_deps(ir_node *tgt, ir_node *src);
140 * Get the length of the dependency array.
141 * @param node The node.
142 * @return The length of the dependency array or 0 if it has not yet been allocated.
144 int get_irn_deps(const ir_node *node);
147 * Get an entry of the dependency array.
148 * @param node The node.
149 * @param pos The position.
150 * @return The node at that position.
152 ir_node *get_irn_dep(const ir_node *node, int pos);
155 * Set an entry of the dependency array.
156 * @param node The node.
157 * @param pos The position.
158 * @param dep The dependency target.
160 void set_irn_dep(ir_node *node, int pos, ir_node *dep);
164 * Get the n-th predecessor of a node in intraprocedural view.
165 * Can be used always if it's know that node is not a split one.
167 ir_node *get_irn_intra_n(const ir_node *node, int n);
170 * Get the n-th predecessor of a node in interprocedural view.
172 ir_node *get_irn_inter_n(const ir_node *node, int n);
174 /** Replace the n-th predecessor of a node with a new one. */
175 void set_irn_n(ir_node *node, int n, ir_node *in);
177 * Appends a new predecessor to a node. This only works for nodes with
179 * @returns the number of the new input
181 int add_irn_n(ir_node *node, ir_node *in);
182 /* Remove predecessor i from Sync n */
183 void del_Sync_n(ir_node *n, int i);
184 /* Sets the mode struct of node. */
185 void set_irn_mode(ir_node *node, ir_mode *mode);
186 /** Gets the mode struct of a node. */
187 ir_mode *get_irn_mode(const ir_node *node);
188 /** Gets the mode-enum ir_modecode. */
189 ir_modecode get_irn_modecode(const ir_node *node);
190 /** Gets the ident for a string representation of the mode .*/
191 ident *get_irn_modeident(const ir_node *node);
192 /** Gets the string representation of the mode .*/
193 const char *get_irn_modename(const ir_node *node);
194 /** Gets the opcode struct of the node. */
195 ir_op *get_irn_op(const ir_node *node);
196 /** Sets the opcode struct of the node. */
197 void set_irn_op(ir_node *node, ir_op *op);
198 /** Gets the opcode-enum of the node. */
199 unsigned get_irn_opcode(const ir_node *node);
200 /** Get the string representation of the opcode. */
201 const char *get_irn_opname(const ir_node *node);
202 /** Get the ident for a string representation of the opcode. */
203 ident *get_irn_opident(const ir_node *node);
204 /** If arg is an argument of the node, returns it's position, -1 otherwise */
205 int get_irn_pred_pos(ir_node *node, ir_node *arg);
206 /** Gets the visited counter of a node. */
207 ir_visited_t get_irn_visited(const ir_node *node);
208 /** Sets the visited counter of a node. */
209 void set_irn_visited(ir_node *node, ir_visited_t visited);
210 /** Sets visited to get_irg_visited(current_ir_graph). */
211 void mark_irn_visited(ir_node *node);
212 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
213 int irn_visited(const ir_node *node);
216 * Sets the link of a node.
217 * Only allowed if the graph is NOT in phase_building.
219 void set_irn_link(ir_node *node, void *link);
221 /** Returns the link of a node. */
222 void *get_irn_link(const ir_node *node);
224 /** Returns the ir_graph this node belongs to. */
225 ir_graph *get_irn_irg(const ir_node *node);
227 /** Outputs a unique number for this node if libFIRM is compiled for
228 debugging, (configure with --enable-debug) else returns address
229 of node cast to long. */
230 long get_irn_node_nr(const ir_node *node);
232 /** Returns the pinned state of a node.
234 * Returns whether the node _always_ must be pinned.
235 * I.e., the node is not floating after global cse.
237 * @returns Either state op_pin_state_pinned or op_pin_state_floats.
239 op_pin_state get_irn_pinned(const ir_node *node);
241 /** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
242 void set_irn_pinned(ir_node *node, op_pin_state state);
244 /** Returns whether the node is currently pinned.
246 * If get_irn_pinned returns op_pin_state_floats and the graph the
247 * node belongs to is in state op_poin_state_floats then this function
248 * returns 'floats', else 'pinned'.
250 op_pin_state is_irn_pinned_in_irg(const ir_node *node);
253 * IR node constructor.
254 * Create a new IR node in irg, with an op, mode, arity and
255 * some incoming IR nodes.
256 * This constructor is used in every specific IR node constructor.
258 * @param db Debug info.
259 * @param irg IR-graph on with this new node should be constructed.
260 * @param block The block the new node belongs to
261 * @param op The opcode of the new node.
262 * @param mode The mode of the new node.
263 * @param arity The arity of the new node, <0 if can be changed dynamically.
264 * @param in An array of arity predecessor nodes.
267 new_ir_node(dbg_info *db,
276 * Return the block the node belongs to. This is only
277 * possible for pinned nodes or if the graph is in pinned state.
278 * Otherwise the block may be incorrect. This condition is
279 * now checked by an assertion.
281 * This works for all except Block. It can return Blocks or the Bad node.
283 * To express the difference to access routines that work for all
284 * nodes we use infix "nodes" and do not name this function
285 * get_irn_block(). */
286 ir_node *get_nodes_block (const ir_node *node);
288 /** Sets the Block of a node. */
289 void set_nodes_block (ir_node *node, ir_node *block);
292 * Return the MacroBlock the node belongs to. This is only
293 * possible for pinned nodes or if the graph is in pinned state.
294 * Otherwise the MacroBlock may be incorrect. This condition is
295 * now checked by an assertion.
297 * This works for all except Block. It can return Blocks or the Bad node.
299 * To express the difference to access routines that work for all
300 * nodes we use infix "nodes" and do not name this function
301 * get_irn_MacroBlock(). */
302 ir_node *get_nodes_MacroBlock(const ir_node *node);
305 * @function get_irn_block()
306 * @see get_nodes_block()
310 * Projection numbers for result of Start node: use for Proj nodes!
313 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
314 pn_Start_M, /**< Projection on the initial memory. */
315 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
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 the thread local storage (tls) pointer.
332 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
333 * from Start. If so returns tls type, else Null. */
334 ir_type *is_tls_pointer(const ir_node *n);
336 /** Test whether arbitrary node is value arg base.
338 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
339 * from Start. If so returns 1, else 0. */
340 int is_value_arg_pointer(const ir_node *n);
342 /* @@@ no more supported */
343 ir_node **get_Block_cfgpred_arr(ir_node *node);
344 int get_Block_n_cfgpreds(const ir_node *node);
345 ir_node *get_Block_cfgpred(const ir_node *node, int pos);
346 void set_Block_cfgpred(ir_node *node, int pos, ir_node *pred);
347 /** Get the predecessor block.
349 * Returns the block corresponding to the predecessor pos of block.
351 * There are several ambiguities we resolve with this function:
352 * - The direct predecessor can be a Proj, which is not pinned.
353 * We walk from the predecessor to the next pinned node
354 * (skip_Proj) and return the block that node is in.
355 * - If we encounter the Bad node, this function does not return
356 * Start, but the Bad node.
358 ir_node *get_Block_cfgpred_block(const ir_node *node, int pos);
359 int get_Block_matured(const ir_node *node);
360 void set_Block_matured(ir_node *node, int matured);
362 /** A visited flag only for block nodes.
363 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
364 ir_visited_t get_Block_block_visited(const ir_node *node);
365 void set_Block_block_visited(ir_node *node, ir_visited_t visit);
368 * Marks a block as dead but do not replace it with a Bad node.
369 * Dead blocks are removed in the con
371 ir_node *set_Block_dead(ir_node *block);
372 int is_Block_dead(const ir_node *block);
374 /* For this current_ir_graph must be set. */
375 void mark_Block_block_visited(ir_node *node);
376 int Block_block_visited(const ir_node *node);
378 #ifdef INTERPROCEDURAL_VIEW
379 /* Set and remove interprocedural predecessors. If the interprocedural
380 * predecessors are removed, the node has the same predecessors in
382 * @@@ Maybe better: arity is zero if no cg preds. */
383 void set_Block_cg_cfgpred_arr(ir_node *node, int arity, ir_node *in[]);
384 void set_Block_cg_cfgpred(ir_node *node, int pos, ir_node *pred);
385 /* @@@ not supported */
386 ir_node **get_Block_cg_cfgpred_arr(ir_node *node);
387 /** Returns the number of interprocedural predecessors. 0 if none. */
388 int get_Block_cg_n_cfgpreds(const ir_node *node);
389 /** Return the interprocedural predecessor at position pos. */
390 ir_node *get_Block_cg_cfgpred(const ir_node *node, int pos);
391 /** Frees the memory allocated for interprocedural predecessors. */
392 void remove_Block_cg_cfgpred_arr(ir_node *node);
395 /** Returns the extended basic block a block belongs to. */
396 ir_extblk *get_Block_extbb(const ir_node *block);
397 /** Sets the extended basic block a block belongs to. */
398 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
399 /** Get the Macro Block header of a (sub-) block. */
400 ir_node *get_Block_MacroBlock(const ir_node *block);
401 /** Set the Macro Block header of a (sub-) block. */
402 void set_Block_MacroBlock(ir_node *block, ir_node *mbh);
403 /** Get the Macro Block header of a node. */
404 ir_node *get_irn_MacroBlock(const ir_node *n);
405 /** Returns the ir_graph this Block belongs to. */
406 ir_graph *get_Block_irg(const ir_node *block);
407 /** Returns non-zero if the block has an assigned label. */
408 int has_Block_label(const ir_node *block);
409 /** Returns the label of a Block. */
410 ir_label_t get_Block_label(const ir_node *block);
411 /** Sets a label to a block. */
412 void set_Block_label(ir_node *block, ir_label_t label);
413 /** Gets the head of the Phi list for this block. */
414 ir_node *get_Block_phis(const ir_node *block);
415 /** Sets the head of the Phi list for this block. */
416 void set_Block_phis(ir_node *block, ir_node *phi);
417 /** Add a Phi node to the list of Block Phi's. */
418 void add_Block_phi(ir_node *block, ir_node *phi);
419 /** Get the Block mark (single bit). */
420 unsigned get_Block_mark(const ir_node *block);
421 /** Set the Block mark (single bit). */
422 void set_Block_mark(ir_node *block, unsigned mark);
424 /** Return the number of Keep alive node. */
425 int get_End_n_keepalives(const ir_node *end);
426 /** Return the Keep alive node a position pos. */
427 ir_node *get_End_keepalive(const ir_node *end, int pos);
428 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
429 void add_End_keepalive(ir_node *end, ir_node *ka);
430 /** Set the Keep alive node at position pos. */
431 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
434 * Set new keep-alives.
435 * Beware: This might be an expensive operation if dynamic edges are enabled,
436 * so avoid it in the backend.
438 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
440 /** Remove irn from the keep-alive set. */
441 void remove_End_keepalive(ir_node *end, ir_node *irn);
443 /** Some parts of the End node are allocated separately -- their memory
444 is not recovered by dead_node_elimination if a End node is dead.
445 free_End() frees these data structures. */
446 void free_End(ir_node *end);
448 /** Return the target address of an IJmp */
449 ir_node *get_IJmp_target(const ir_node *ijmp);
450 /** Sets the target address of an IJmp */
451 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
453 /* We distinguish three kinds of Cond nodes. These can be distinguished
454 by the mode of the selector operand and an internal flag of type cond_kind.
455 First we distinguish binary Conds and switch Conds.
456 A binary Cond has as selector a boolean value. Proj(0) projects the control
457 flow for case "False", Proj(1) the control flow for "True". A binary Cond
458 is recognized by the boolean selector.
459 The switch Cond has as selector an unsigned integer. It produces as result
460 an n+1 Tuple (cf0, ... , cfn) of control flows.
461 We differ two flavors of this Cond. The first, the dense Cond, passes
462 control along output i if the selector value is i, 0 <= i <= n. If the
463 selector value is >n it passes control along output n.
464 The second Cond flavor differences in the treatment of cases not specified in
465 the source program. It magically knows about the existence of Proj nodes.
466 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
467 exists. Else it passes control along output n (even if this Proj does not
468 exist.) This Cond we call "fragmentary". There is a special constructor
469 new_defaultProj that automatically sets the flavor.
470 The two switch flavors are distinguished by a flag of type cond_kind.
471 Default flavor is "dense"
474 dense, /**< Default. Missing Proj nodes are dead control flow. */
475 fragmentary /**< Special. No control flow optimizations allowed. Missing
476 Proj nodes mean default control flow, i.e., Proj(n). */
479 ir_node *get_Cond_selector(const ir_node *node);
480 void set_Cond_selector(ir_node *node, ir_node *selector);
481 cond_kind get_Cond_kind(const ir_node *node);
482 void set_Cond_kind(ir_node *node, cond_kind kind);
483 long get_Cond_defaultProj(const ir_node *node);
486 * Projection numbers for conditions.
489 pn_Cond_false, /**< Control flow if operand is "false". */
490 pn_Cond_true, /**< Control flow if operand is "true". */
491 pn_Cond_max /**< number of projections from a Cond */
492 } pn_Cond; /* Projection numbers for Cond. */
494 ir_node *get_Return_mem(const ir_node *node);
495 void set_Return_mem(ir_node *node, ir_node *mem);
496 ir_node **get_Return_res_arr(ir_node *node);
497 int get_Return_n_ress(const ir_node *node);
498 ir_node *get_Return_res(const ir_node *node, int pos);
499 void set_Return_res(ir_node *node, int pos, ir_node *res);
501 tarval *get_Const_tarval(const ir_node *node);
502 void set_Const_tarval(ir_node *node, tarval *con);
504 /** Return non-zero if the given Const node represents the 0 constant. */
505 int is_Const_null(const ir_node *node);
507 /** Return non-zero if the given Const node represents the 1 constant. */
508 int is_Const_one(const ir_node *node);
510 /** Return non-zero if the given Const node represents the constant with all bits set. */
511 int is_Const_all_one(const ir_node *node);
513 /** Returns the source language type of a Const node.
514 * Must be an atomic type. Mode of type must be mode of node.
516 ir_type *get_Const_type(ir_node *node);
518 /** Sets the source language type of a Const node. */
519 void set_Const_type(ir_node *node, ir_type *tp);
521 /** This enum names the three different kinds of symbolic Constants
522 represented by SymConst. The content of the attribute type_or_id
523 depends on this tag. Use the proper access routine after testing
526 symconst_type_tag, /**< The SymConst is a type tag for the given type.
527 symconst_symbol is type *. */
528 symconst_type_size, /**< The SymConst is the size of the given type.
529 symconst_symbol is type *. */
530 symconst_type_align, /**< The SymConst is the alignment of the given type.
531 symconst_symbol is type *. */
532 symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
533 by the linker. The pointer is represented by a string.
534 symconst_symbol is ident *. */
535 symconst_addr_ent, /**< The SymConst is a symbolic pointer to be filled in
536 by the linker. The pointer is represented by an entity.
537 symconst_symbol is entity *. */
538 symconst_ofs_ent, /**< The SymConst is the offset of its entity in the entities
540 symconst_enum_const, /**< The SymConst is a enumeration constant of an
542 symconst_label /**< The SymConst is a label address. */
545 /** Returns non-zero if s symconst kind has a type attribute */
546 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
548 /** Returns non-zero if s symconst kind has an ident attribute */
549 #define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)
551 /** Returns non-zero if s symconst kind has an entity attribute */
552 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
554 /** Returns non-zero if s symconst kind has an enum_const attribute */
555 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
557 /** Returns non-zero if s symconst kind has a label attribute */
558 #define SYMCONST_HAS_LABEL(kind) ((kind) == symconst_label)
560 /** SymConst attribute.
562 * This union contains the symbolic information represented by the node.
564 typedef union symconst_symbol {
565 ir_type *type_p; /**< The type of a SymConst. */
566 ident *ident_p; /**< The ident of a SymConst. */
567 ir_entity *entity_p; /**< The entity of a SymConst. */
568 ir_enum_const *enum_p; /**< The enumeration constant of a SymConst. */
569 ir_label_t label; /**< The label of a SymConst. */
572 /** Get the kind of the SymConst. */
573 symconst_kind get_SymConst_kind(const ir_node *node);
574 /** Set the kind of the SymConst. */
575 void set_SymConst_kind(ir_node *node, symconst_kind num);
577 /** Only to access SymConst of kind type_tag or size. Else assertion: */
578 ir_type *get_SymConst_type(const ir_node *node);
579 void set_SymConst_type(ir_node *node, ir_type *tp);
581 /** Only to access SymConst of kind addr_name. Else assertion: */
582 ident *get_SymConst_name(const ir_node *node);
583 void set_SymConst_name(ir_node *node, ident *name);
585 /** Only to access SymConst of kind addr_ent. Else assertion: */
586 ir_entity *get_SymConst_entity(const ir_node *node);
587 void set_SymConst_entity(ir_node *node, ir_entity *ent);
589 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
590 ir_enum_const *get_SymConst_enum(const ir_node *node);
591 void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
593 /** Sets both: type and ptrinfo. Needed to treat the node independent of
594 its semantics. Does a memcpy for the memory sym points to. */
595 /* write 'union': firmjni then does not create a method... */
596 union symconst_symbol get_SymConst_symbol(const ir_node *node);
597 void set_SymConst_symbol(ir_node *node,
598 union symconst_symbol sym);
600 /** Only to access SymConst of kind symconst_label. Else assertion: */
601 ir_label_t get_SymConst_label(const ir_node *node);
602 void set_SymConst_label(ir_node *node, ir_label_t label);
605 /** Access the type of the value represented by the SymConst.
607 * Example: primitive type int for SymConst size. */
608 ir_type *get_SymConst_value_type(ir_node *node);
609 void set_SymConst_value_type(ir_node *node, ir_type *tp);
611 ir_node *get_Sel_mem(const ir_node *node);
612 void set_Sel_mem(ir_node *node, ir_node *mem);
613 ir_node *get_Sel_ptr(const ir_node *node); /* ptr to the object to select from */
614 void set_Sel_ptr(ir_node *node, ir_node *ptr);
615 ir_node **get_Sel_index_arr(ir_node *node);
616 int get_Sel_n_indexs(const ir_node *node);
617 ir_node *get_Sel_index(const ir_node *node, int pos);
618 void set_Sel_index(ir_node *node, int pos, ir_node *index);
619 ir_entity *get_Sel_entity(const ir_node *node); /* entity to select */
620 void set_Sel_entity (ir_node *node, ir_entity *ent);
623 * Projection numbers for result of Call node: use for Proj nodes!
626 pn_Call_M_regular = pn_Generic_M_regular, /**< The memory result. */
627 pn_Call_X_regular = pn_Generic_X_regular, /**< The control flow result when no exception occurs. */
628 pn_Call_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler. */
629 pn_Call_T_result = pn_Generic_other, /**< The tuple containing all (0, 1, 2, ...) results. */
630 pn_Call_M_except, /**< The memory result in case the called method terminated with
632 pn_Call_P_value_res_base, /**< A pointer to the memory region containing copied results
633 passed by value (for compound result types). */
634 pn_Call_max /**< number of projections from a Call */
635 } pn_Call; /* Projection numbers for Call. */
636 #define pn_Call_M pn_Call_M_regular
638 ir_node *get_Call_mem(const ir_node *node);
639 void set_Call_mem(ir_node *node, ir_node *mem);
640 ir_node *get_Call_ptr(const ir_node *node);
641 void set_Call_ptr(ir_node *node, ir_node *ptr);
642 ir_node **get_Call_param_arr(ir_node *node);
643 /** Gets the number of parameters of a call. */
644 int get_Call_n_params(const ir_node *node);
645 /** Gets the call parameter at position pos. */
646 ir_node *get_Call_param(const ir_node *node, int pos);
647 /** Sets the call parameter at position pos. */
648 void set_Call_param(ir_node *node, int pos, ir_node *param);
649 /** Gets the type of a call. */
650 ir_type *get_Call_type(ir_node *node);
651 /** Sets the type of a call. */
652 void set_Call_type(ir_node *node, ir_type *tp);
653 /** Gets the arity of a call. Identical to get_Call_n_params(). */
654 int get_Call_arity(const ir_node *node);
657 * Returns non-zero if a Call is surely a self-recursive Call.
658 * Beware: if this functions returns 0, the call might be self-recursive!
660 int is_self_recursive_Call(const ir_node *call);
662 /** Set, get and remove the callee information for a Call node.
664 * The callee information lists all method entities that can be called
665 * from this node. If the address expression can not be analyzed fully,
666 * e.g., as entities can be called that are not in the compilation unit,
667 * the array contains the unknown_entity. The array contains only entities
668 * with peculiarity_existent, but with all kinds of visibility. The entities
669 * not necessarily contain an irg.
671 * The array is only accessible if callee information is valid. See flag
674 * The memory allocated for the array is managed automatically, i.e., it must
675 * not be freed if the Call node is removed from the graph.
677 * @param node A Call node.
679 int Call_has_callees(const ir_node *node);
680 int get_Call_n_callees(const ir_node *node);
681 ir_entity *get_Call_callee(const ir_node *node, int pos);
683 /** Set the full callee array.
685 * The passed array is copied. Assumes current_ir_graph set properly! */
686 void set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
687 void remove_Call_callee_arr(ir_node *node);
689 ir_node *get_CallBegin_ptr(const ir_node *node);
690 void set_CallBegin_ptr(ir_node *node, ir_node *ptr);
691 ir_node *get_CallBegin_call(const ir_node *node);
692 void set_CallBegin_call(ir_node *node, ir_node *call);
694 /* For unary and binary arithmetic operations the access to the
695 operands can be factored out. Left is the first, right the
696 second arithmetic value as listed in tech report 1999-44.
697 unops are: Minus, Abs, Not, Conv, Cast
698 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
699 Shr, Shrs, Rotl, Cmp */
700 int is_unop(const ir_node *node);
701 ir_node *get_unop_op(const ir_node *node);
702 void set_unop_op(ir_node *node, ir_node *op);
703 int is_binop(const ir_node *node);
704 ir_node *get_binop_left(const ir_node *node);
705 void set_binop_left(ir_node *node, ir_node *left);
706 ir_node *get_binop_right(const ir_node *node);
707 void set_binop_right(ir_node *node, ir_node *right);
709 ir_node *get_Add_left(const ir_node *node);
710 void set_Add_left(ir_node *node, ir_node *left);
711 ir_node *get_Add_right(const ir_node *node);
712 void set_Add_right(ir_node *node, ir_node *right);
714 ir_node *get_Carry_left(const ir_node *node);
715 void set_Carry_left(ir_node *node, ir_node *left);
716 ir_node *get_Carry_right(const ir_node *node);
717 void set_Carry_right(ir_node *node, ir_node *right);
719 ir_node *get_Sub_left(const ir_node *node);
720 void set_Sub_left(ir_node *node, ir_node *left);
721 ir_node *get_Sub_right(const ir_node *node);
722 void set_Sub_right(ir_node *node, ir_node *right);
724 ir_node *get_Minus_op(const ir_node *node);
725 void set_Minus_op(ir_node *node, ir_node *op);
727 ir_node *get_Mul_left(const ir_node *node);
728 void set_Mul_left(ir_node *node, ir_node *left);
729 ir_node *get_Mul_right(const ir_node *node);
730 void set_Mul_right(ir_node *node, ir_node *right);
732 ir_node *get_Mulh_left(const ir_node *node);
733 void set_Mulh_left(ir_node *node, ir_node *left);
734 ir_node *get_Mulh_right(const ir_node *node);
735 void set_Mulh_right(ir_node *node, ir_node *right);
737 ir_node *get_Quot_left(const ir_node *node);
738 void set_Quot_left(ir_node *node, ir_node *left);
739 ir_node *get_Quot_right(const ir_node *node);
740 void set_Quot_right(ir_node *node, ir_node *right);
741 ir_node *get_Quot_mem(const ir_node *node);
742 void set_Quot_mem(ir_node *node, ir_node *mem);
743 ir_mode *get_Quot_resmode(const ir_node *node);
744 void set_Quot_resmode(ir_node *node, ir_mode *mode);
747 * Projection numbers for Quot: use for Proj nodes!
750 pn_Quot_M = pn_Generic_M_regular, /**< Memory result. */
751 pn_Quot_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
752 pn_Quot_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
753 pn_Quot_res = pn_Generic_other, /**< Result of computation. */
754 pn_Quot_max /**< number of projections from a Quot */
755 } pn_Quot; /* Projection numbers for Quot. */
757 ir_node *get_DivMod_left(const ir_node *node);
758 void set_DivMod_left(ir_node *node, ir_node *left);
759 ir_node *get_DivMod_right(const ir_node *node);
760 void set_DivMod_right(ir_node *node, ir_node *right);
761 ir_node *get_DivMod_mem(const ir_node *node);
762 void set_DivMod_mem(ir_node *node, ir_node *mem);
763 ir_mode *get_DivMod_resmode(const ir_node *node);
764 void set_DivMod_resmode(ir_node *node, ir_mode *mode);
767 * Projection numbers for DivMod: use for Proj nodes!
770 pn_DivMod_M = pn_Generic_M_regular, /**< Memory result. */
771 pn_DivMod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
772 pn_DivMod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
773 pn_DivMod_res_div = pn_Generic_other, /**< Result of computation a / b. */
774 pn_DivMod_res_mod, /**< Result of computation a % b. */
775 pn_DivMod_max /**< number of projections from a DivMod */
776 } pn_DivMod; /* Projection numbers for DivMod. */
778 ir_node *get_Div_left(const ir_node *node);
779 void set_Div_left(ir_node *node, ir_node *left);
780 ir_node *get_Div_right(const ir_node *node);
781 void set_Div_right(ir_node *node, ir_node *right);
782 ir_node *get_Div_mem(const ir_node *node);
783 void set_Div_mem(ir_node *node, ir_node *mem);
784 ir_mode *get_Div_resmode(const ir_node *node);
785 void set_Div_resmode(ir_node *node, ir_mode *mode);
786 int is_Div_remainderless(const ir_node *node);
789 * Projection numbers for Div: use for Proj nodes!
792 pn_Div_M = pn_Generic_M_regular, /**< Memory result. */
793 pn_Div_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
794 pn_Div_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
795 pn_Div_res = pn_Generic_other, /**< Result of computation. */
796 pn_Div_max /**< number of projections from a Div */
797 } pn_Div; /* Projection numbers for Div. */
799 ir_node *get_Mod_left(const ir_node *node);
800 void set_Mod_left(ir_node *node, ir_node *left);
801 ir_node *get_Mod_right(const ir_node *node);
802 void set_Mod_right(ir_node *node, ir_node *right);
803 ir_node *get_Mod_mem(const ir_node *node);
804 void set_Mod_mem(ir_node *node, ir_node *mem);
805 ir_mode *get_Mod_resmode(const ir_node *node);
806 void set_Mod_resmode(ir_node *node, ir_mode *mode);
809 * Projection numbers for Mod: use for Proj nodes!
812 pn_Mod_M = pn_Generic_M_regular, /**< Memory result. */
813 pn_Mod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
814 pn_Mod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
815 pn_Mod_res = pn_Generic_other, /**< Result of computation. */
816 pn_Mod_max /**< number of projections from a Mod */
817 } pn_Mod; /* Projection numbers for Mod. */
819 ir_node *get_Abs_op(const ir_node *node);
820 void set_Abs_op(ir_node *node, ir_node *op);
822 ir_node *get_And_left(const ir_node *node);
823 void set_And_left(ir_node *node, ir_node *left);
824 ir_node *get_And_right(const ir_node *node);
825 void set_And_right(ir_node *node, ir_node *right);
827 ir_node *get_Or_left(const ir_node *node);
828 void set_Or_left(ir_node *node, ir_node *left);
829 ir_node *get_Or_right(const ir_node *node);
830 void set_Or_right(ir_node *node, ir_node *right);
832 ir_node *get_Eor_left(const ir_node *node);
833 void set_Eor_left(ir_node *node, ir_node *left);
834 ir_node *get_Eor_right(const ir_node *node);
835 void set_Eor_right(ir_node *node, ir_node *right);
837 ir_node *get_Not_op(const ir_node *node);
838 void set_Not_op(ir_node *node, ir_node *op);
841 * Projection numbers for Cmp are defined several times.
842 * The bit patterns are used for various tests, so don't change.
843 * The "unordered" values are possible results of comparing
844 * floating point numbers.
845 * Note that the encoding is imported, so do NOT change the order.
848 pn_Cmp_False = 0, /**< false */
849 pn_Cmp_Eq = 1, /**< equal */
850 pn_Cmp_Lt = 2, /**< less */
851 pn_Cmp_Le = pn_Cmp_Eq|pn_Cmp_Lt, /**< less or equal */
852 pn_Cmp_Gt = 4, /**< greater */
853 pn_Cmp_Ge = pn_Cmp_Eq|pn_Cmp_Gt, /**< greater or equal */
854 pn_Cmp_Lg = pn_Cmp_Lt|pn_Cmp_Gt, /**< less or greater */
855 pn_Cmp_Leg = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
856 pn_Cmp_Uo = 8, /**< unordered */
857 pn_Cmp_Ue = pn_Cmp_Uo|pn_Cmp_Eq, /**< unordered or equal */
858 pn_Cmp_Ul = pn_Cmp_Uo|pn_Cmp_Lt, /**< unordered or less */
859 pn_Cmp_Ule = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
860 pn_Cmp_Ug = pn_Cmp_Uo|pn_Cmp_Gt, /**< unordered or greater */
861 pn_Cmp_Uge = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
862 pn_Cmp_Ne = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
863 pn_Cmp_True = 15 /**< true */
864 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for JNI interface */
865 } pn_Cmp; /* Projection numbers for Cmp */
866 /* #define not_mask pn_Cmp_Leg */
868 /** returns the pnc name from an pnc constant */
869 const char *get_pnc_string(int pnc);
871 /** Calculates the negated (Complement(R)) pnc condition. */
872 pn_Cmp get_negated_pnc(long pnc, ir_mode *mode);
874 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
875 pn_Cmp get_inversed_pnc(long pnc);
877 /** An alternative name for get_inversed_pnc() that can be better memorized. */
878 #define get_mirrored_pnc(pnc) get_inversed_pnc(pnc)
880 ir_node *get_Cmp_left(const ir_node *node);
881 void set_Cmp_left(ir_node *node, ir_node *left);
882 ir_node *get_Cmp_right(const ir_node *node);
883 void set_Cmp_right(ir_node *node, ir_node *right);
885 ir_node *get_Shl_left(const ir_node *node);
886 void set_Shl_left(ir_node *node, ir_node *left);
887 ir_node *get_Shl_right(const ir_node *node);
888 void set_Shl_right(ir_node *node, ir_node *right);
890 ir_node *get_Shr_left(const ir_node *node);
891 void set_Shr_left(ir_node *node, ir_node *left);
892 ir_node *get_Shr_right(const ir_node *node);
893 void set_Shr_right(ir_node *node, ir_node *right);
895 ir_node *get_Shrs_left(const ir_node *node);
896 void set_Shrs_left(ir_node *node, ir_node *left);
897 ir_node *get_Shrs_right(const ir_node *node);
898 void set_Shrs_right(ir_node *node, ir_node *right);
900 ir_node *get_Rotl_left(const ir_node *node);
901 void set_Rotl_left(ir_node *node, ir_node *left);
902 ir_node *get_Rotl_right(const ir_node *node);
903 void set_Rotl_right(ir_node *node, ir_node *right);
905 ir_node *get_Conv_op(const ir_node *node);
906 void set_Conv_op(ir_node *node, ir_node *op);
907 int get_Conv_strict(const ir_node *node);
908 void set_Conv_strict(ir_node *node, int flag);
910 /* Does Cast need a mem operator?
911 * Cast should only depend on the type, not on the state of an
912 * entity. But: we initialize various fields after Alloc, that
913 * are accessed in the cast. This required some precaution, to
914 * get the right memory into the Loads generated from the cast.
916 ir_node *get_Cast_op(const ir_node *node);
917 void set_Cast_op(ir_node *node, ir_node *op);
918 ir_type *get_Cast_type(ir_node *node);
919 void set_Cast_type(ir_node *node, ir_type *to_tp);
921 /** Checks for upcast.
923 * Returns true if the Cast node casts a class type to a super type.
924 * Works also for pointers to classes (recursively).
926 * Needs typeinfo calculated.
928 int is_Cast_upcast(ir_node *node);
930 /** Checks for downcast.
932 * Returns true if the Cast node casts a class type to a sub type.
933 * Works also for pointers to classes (recursively).
935 * Needs typeinfo calculated.
937 int is_Cast_downcast(ir_node *node);
940 /** Returns true if n is a Phi or a Filter node in INTER-procedural view.
941 Returns false if irg is in phase phase_building and the Phi has zero
942 predecessors: it's a Phi0. */
943 int is_Phi(const ir_node *n);
944 /** Returns true if irg in phase phase_building and the Phi has zero
945 predecessors. It's a Phi0 then. */
946 int is_Phi0(const ir_node *n);
947 /* These routines also work for Filter nodes in INTER-procedural view. */
948 ir_node **get_Phi_preds_arr(ir_node *node);
949 int get_Phi_n_preds(const ir_node *node);
950 ir_node *get_Phi_pred(const ir_node *node, int pos);
951 void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
952 ir_node *get_Phi_next(const ir_node *phi);
953 void set_Phi_next(ir_node *phi, ir_node *next);
955 ir_node *get_Filter_pred(ir_node *node);
956 void set_Filter_pred(ir_node *node, ir_node *pred);
957 long get_Filter_proj(ir_node *node);
958 void set_Filter_proj(ir_node *node, long proj);
959 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
960 * @@@ Maybe better: arity is zero if no cg preds. */
961 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
962 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
963 int get_Filter_n_cg_preds(ir_node *node);
964 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
966 /** Return true if parameter is a memory operation.
968 * A memory operation is an operation that changes the
969 * memory. I.e., a Load or a Store operation.
971 int is_memop(const ir_node *node);
972 ir_node *get_memop_mem(const ir_node *node);
973 void set_memop_mem(ir_node *node, ir_node *mem);
974 ir_node *get_memop_ptr(const ir_node *node);
975 void set_memop_ptr(ir_node *node, ir_node *ptr);
978 * Projection numbers for Load: use for Proj nodes!
981 pn_Load_M = pn_Generic_M_regular, /**< Memory result. */
982 pn_Load_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
983 pn_Load_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
984 pn_Load_res = pn_Generic_other, /**< Result of load operation. */
985 pn_Load_max /**< number of projections from a Load */
986 } pn_Load; /* Projection numbers for Load. */
988 ir_node *get_Load_mem(const ir_node *node);
989 void set_Load_mem(ir_node *node, ir_node *mem);
990 ir_node *get_Load_ptr(const ir_node *node);
991 void set_Load_ptr(ir_node *node, ir_node *ptr);
992 ir_mode *get_Load_mode(const ir_node *node);
993 void set_Load_mode(ir_node *node, ir_mode *mode);
994 ir_volatility get_Load_volatility(const ir_node *node);
995 void set_Load_volatility(ir_node *node, ir_volatility volatility);
996 ir_align get_Load_align(const ir_node *node);
997 void set_Load_align(ir_node *node, ir_align align);
1000 * Projection numbers for Store: use for Proj nodes!
1003 pn_Store_M = pn_Generic_M_regular, /**< Memory result. */
1004 pn_Store_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1005 pn_Store_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
1006 pn_Store_max = pn_Generic_other /**< number of projections from a Store */
1007 } pn_Store; /* Projection numbers for Store. */
1009 ir_node *get_Store_mem(const ir_node *node);
1010 void set_Store_mem(ir_node *node, ir_node *mem);
1011 ir_node *get_Store_ptr(const ir_node *node);
1012 void set_Store_ptr(ir_node *node, ir_node *ptr);
1013 ir_node *get_Store_value(const ir_node *node);
1014 void set_Store_value(ir_node *node, ir_node *value);
1015 ir_volatility get_Store_volatility(const ir_node *node);
1016 void set_Store_volatility(ir_node *node, ir_volatility volatility);
1017 ir_align get_Store_align(const ir_node *node);
1018 void set_Store_align(ir_node *node, ir_align align);
1021 * Projection numbers for Alloc: use for Proj nodes!
1024 pn_Alloc_M = pn_Generic_M_regular, /**< Memory result. */
1025 pn_Alloc_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1026 pn_Alloc_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
1027 pn_Alloc_res = pn_Generic_other, /**< Result of allocation. */
1028 pn_Alloc_max /**< number of projections from an Alloc */
1029 } pn_Alloc; /* Projection numbers for Alloc. */
1031 ir_node *get_Alloc_mem(const ir_node *node);
1032 void set_Alloc_mem(ir_node *node, ir_node *mem);
1033 ir_node *get_Alloc_size(const ir_node *node);
1034 void set_Alloc_size(ir_node *node, ir_node *size);
1035 ir_type *get_Alloc_type(ir_node *node);
1036 void set_Alloc_type(ir_node *node, ir_type *tp);
1038 /** The allocation place. */
1040 stack_alloc, /**< Alloc allocates the object on the stack. */
1041 heap_alloc /**< Alloc allocates the object on the heap. */
1044 ir_where_alloc get_Alloc_where(const ir_node *node);
1045 void set_Alloc_where(ir_node *node, ir_where_alloc where);
1047 ir_node *get_Free_mem(const ir_node *node);
1048 void set_Free_mem(ir_node *node, ir_node *mem);
1049 ir_node *get_Free_ptr(const ir_node *node);
1050 void set_Free_ptr(ir_node *node, ir_node *ptr);
1051 ir_node *get_Free_size(const ir_node *node);
1052 void set_Free_size(ir_node *node, ir_node *size);
1053 ir_type *get_Free_type(ir_node *node);
1054 void set_Free_type(ir_node *node, ir_type *tp);
1056 ir_where_alloc get_Free_where(const ir_node *node);
1057 void set_Free_where(ir_node *node, ir_where_alloc where);
1059 ir_node **get_Sync_preds_arr(ir_node *node);
1060 int get_Sync_n_preds(const ir_node *node);
1061 ir_node *get_Sync_pred(const ir_node *node, int pos);
1062 void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
1063 void add_Sync_pred(ir_node *node, ir_node *pred);
1065 /** Returns the source language type of a Proj node.
1066 * Must be an atomic type. Mode of type must be mode of node.
1068 ir_type *get_Proj_type(ir_node *node);
1070 /** Return the predecessor of a Proj node. */
1071 ir_node *get_Proj_pred(const ir_node *node);
1072 void set_Proj_pred(ir_node *node, ir_node *pred);
1073 /** Return the projection number of a Proj node. */
1074 long get_Proj_proj(const ir_node *node);
1075 void set_Proj_proj(ir_node *node, long proj);
1078 * Returns non-zero if a node is a routine parameter.
1080 * @param node the Proj node to test
1082 int is_arg_Proj(const ir_node *node);
1084 ir_node **get_Tuple_preds_arr(ir_node *node);
1085 int get_Tuple_n_preds(const ir_node *node);
1086 ir_node *get_Tuple_pred(const ir_node *node, int pos);
1087 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
1089 ir_node *get_Id_pred(const ir_node *node);
1090 void set_Id_pred(ir_node *node, ir_node *pred);
1092 /** Confirm has a single result and returns 'value' unchanged.
1093 * The node expresses a restriction on 'value':
1094 * 'value' 'cmp' 'bound' == true. */
1095 ir_node *get_Confirm_value(const ir_node *node);
1096 void set_Confirm_value(ir_node *node, ir_node *value);
1097 ir_node *get_Confirm_bound(const ir_node *node);
1098 void set_Confirm_bound(ir_node *node, ir_node *bound);
1099 pn_Cmp get_Confirm_cmp(const ir_node *node);
1100 void set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
1105 ir_node *get_Mux_sel(const ir_node *node);
1106 void set_Mux_sel(ir_node *node, ir_node *sel);
1107 ir_node *get_Mux_false(const ir_node *node);
1108 void set_Mux_false(ir_node *node, ir_node *ir_false);
1109 ir_node *get_Mux_true(const ir_node *node);
1110 void set_Mux_true(ir_node *node, ir_node *ir_true);
1113 * Projection numbers for result of CopyB node: use for Proj nodes!
1116 pn_CopyB_M_regular = pn_Generic_M_regular, /**< The memory result. */
1117 pn_CopyB_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1118 pn_CopyB_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1119 pn_CopyB_M_except = pn_Generic_other, /**< The memory result in case the runtime function terminated with
1121 pn_CopyB_max /**< number of projections from a CopyB */
1122 } pn_CopyB; /* Projection numbers for CopyB. */
1123 #define pn_CopyB_M pn_CopyB_M_regular
1125 ir_node *get_CopyB_mem(const ir_node *node);
1126 void set_CopyB_mem(ir_node *node, ir_node *mem);
1127 ir_node *get_CopyB_dst(const ir_node *node);
1128 void set_CopyB_dst(ir_node *node, ir_node *dst);
1129 ir_node *get_CopyB_src(const ir_node *node);
1130 void set_CopyB_src(ir_node *node, ir_node *src);
1131 ir_type *get_CopyB_type(ir_node *node);
1132 void set_CopyB_type(ir_node *node, ir_type *data_type);
1135 * Projection numbers for result of InstOf node: use for Proj nodes!
1138 pn_InstOf_M_regular = pn_Generic_M_regular, /**< The memory result. */
1139 pn_InstOf_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1140 pn_InstOf_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1141 pn_InstOf_res = pn_Generic_other, /**< The checked object pointer. */
1142 pn_InstOf_M_except, /**< The memory result in case the runtime function terminated with
1144 pn_InstOf_max /**< number of projections from an InstOf */
1146 #define pn_InstOf_M pn_InstOf_M_regular
1148 /** InstOf access. */
1149 ir_type *get_InstOf_type(ir_node *node);
1150 void set_InstOf_type(ir_node *node, ir_type *type);
1151 ir_node *get_InstOf_store(const ir_node *node);
1152 void set_InstOf_store(ir_node *node, ir_node *obj);
1153 ir_node *get_InstOf_obj(const ir_node *node);
1154 void set_InstOf_obj(ir_node *node, ir_node *obj);
1157 * Projection numbers for Raise.
1160 pn_Raise_M = pn_Generic_M_regular, /**< The Memory result. */
1161 pn_Raise_X = pn_Generic_X_regular, /**< The control flow to the exception handler. */
1162 pn_Raise_max /**< number of projections from a Raise */
1163 } pn_Raise; /* Projection numbers for Raise. */
1165 ir_node *get_Raise_mem(const ir_node *node);
1166 void set_Raise_mem(ir_node *node, ir_node *mem);
1167 ir_node *get_Raise_exo_ptr(const ir_node *node); /* PoinTeR to EXception Object */
1168 void set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
1171 * Projection numbers for result of Bound node: use for Proj nodes!
1174 pn_Bound_M = pn_Generic_M_regular, /**< The memory result. */
1175 pn_Bound_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1176 pn_Bound_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1177 pn_Bound_res = pn_Generic_other, /**< The checked index. */
1178 pn_Bound_max /**< number of projections from a Bound */
1181 /** Returns the memory input of a Bound operation. */
1182 ir_node *get_Bound_mem(const ir_node *bound);
1183 void set_Bound_mem(ir_node *bound, ir_node *mem);
1185 /** Returns the index input of a Bound operation. */
1186 ir_node *get_Bound_index(const ir_node *bound);
1187 void set_Bound_index(ir_node *bound, ir_node *idx);
1189 /** Returns the lower bound input of a Bound operation. */
1190 ir_node *get_Bound_lower(const ir_node *bound);
1191 void set_Bound_lower(ir_node *bound, ir_node *lower);
1193 /** Returns the upper bound input of a Bound operation. */
1194 ir_node *get_Bound_upper(const ir_node *bound);
1195 void set_Bound_upper(ir_node *bound, ir_node *upper);
1197 /** Return the operand of a Pin node. */
1198 ir_node *get_Pin_op(const ir_node *pin);
1199 void set_Pin_op(ir_node *pin, ir_node *node);
1201 /** A input/output constraint attribute */
1203 unsigned pos; /**< The inputs/output position for this constraint. */
1204 ident *constraint; /**< The constraint for this input/output. */
1205 ir_mode *mode; /**< The mode of the constraint. */
1206 } ir_asm_constraint;
1208 /** Return the assembler text of an ASM pseudo node. */
1209 ident *get_ASM_text(const ir_node *node);
1210 /** Return the number of input constraints for an ASM node. */
1211 int get_ASM_n_input_constraints(const ir_node *node);
1212 /** Return the input constraints for an ASM node. */
1213 const ir_asm_constraint *get_ASM_input_constraints(const ir_node *node);
1214 /** Return the number of output constraints for an ASM node. */
1215 int get_ASM_n_output_constraints(const ir_node *node);
1216 /** Return the output constraints for an ASM node. */
1217 const ir_asm_constraint *get_ASM_output_constraints(const ir_node *node);
1218 /** Return the number of clobbered registers for an ASM node. */
1219 int get_ASM_n_clobbers(const ir_node *node);
1220 /** Return the list of clobbered registers for an ASM node. */
1221 ident **get_ASM_clobbers(const ir_node *node);
1225 * NAME Auxiliary routines
1229 /** Returns operand of node if node is a Proj. */
1230 ir_node *skip_Proj(ir_node *node);
1231 /** Returns operand of node if node is a Proj. */
1232 const ir_node *skip_Proj_const(const ir_node *node);
1233 /** Returns operand of node if node is a Id. */
1234 ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
1235 /** Returns corresponding operand of Tuple if node is a Proj from
1237 ir_node *skip_Tuple(ir_node *node);
1238 /** Returns operand of node if node is a Cast. */
1239 ir_node *skip_Cast(ir_node *node);
1240 const ir_node *skip_Cast_const(const ir_node *node);
1241 /** Returns operand of node if node is a Pin. */
1242 ir_node *skip_Pin(ir_node *node);
1243 /** Returns operand of node if node is a Confirm */
1244 ir_node *skip_Confirm(ir_node *node);
1245 /** Skip all high-level Operations (including Cast, Confirm). */
1246 ir_node *skip_HighLevel_ops(ir_node *node);
1247 /** Returns true if irn is a Const node. */
1248 int is_Const(const ir_node *node);
1249 /** Returns true if a node is a Conv node. */
1250 int is_Conv(const ir_node *node);
1251 /** Returns true if a node is a strictConv node. */
1252 int is_strictConv(const ir_node *node);
1253 /** Returns true if a node is a Cast node. */
1254 int is_Cast(const ir_node *node);
1255 /** Returns true if node is a Bad node. */
1256 int is_Bad(const ir_node *node);
1257 /** Returns true if node is a NoMem node. */
1258 int is_NoMem(const ir_node *node);
1259 /** Returns true if node is a Start node. */
1260 int is_Start(const ir_node *node);
1261 /** Returns true if node is a Minus node. */
1262 int is_Minus(const ir_node *node);
1263 /** Returns true if node is a Abs node. */
1264 int is_Abs(const ir_node *node);
1265 /** Returns true if node is a Mod node. */
1266 int is_Mod(const ir_node *node);
1267 /** Returns true if node is a Div node. */
1268 int is_Div(const ir_node *node);
1269 /** Returns true if node is a DivMod node. */
1270 int is_DivMod(const ir_node *node);
1271 /** Returns true if node is a Quot node. */
1272 int is_Quot(const ir_node *node);
1273 /** Returns true if node is an Add node. */
1274 int is_Add(const ir_node *node);
1275 /** Returns true if node is a Carry node. */
1276 int is_Carry(const ir_node *node);
1277 /** Returns true if node is an And node. */
1278 int is_And(const ir_node *node);
1279 /** Returns true if node is an Or node. */
1280 int is_Or(const ir_node *node);
1281 /** Returns true if node is an Eor node. */
1282 int is_Eor(const ir_node *node);
1283 /** Returns true if node is a Sub node. */
1284 int is_Sub(const ir_node *node);
1285 /** Returns true if node is a Not node. */
1286 int is_Not(const ir_node *node);
1287 /** Returns true if node is a Shl node. */
1288 int is_Shl(const ir_node *node);
1289 /** Returns true if node is a Shr node. */
1290 int is_Shr(const ir_node *node);
1291 /** Returns true if node is a Shrs node. */
1292 int is_Shrs(const ir_node *node);
1293 /** Returns true if node is a Rotl node. */
1294 int is_Rotl(const ir_node *node);
1295 /** Returns true if node is an Id node. */
1296 int is_Id(const ir_node *node);
1297 /** Returns true if node is a Tuple node. */
1298 int is_Tuple(const ir_node *node);
1299 /** Returns true if node is a Bound node. */
1300 int is_Bound(const ir_node *node);
1301 /** Returns true if the node is not a Block */
1302 int is_no_Block(const ir_node *node);
1303 /** Returns true if the node is a Block */
1304 int is_Block(const ir_node *node);
1305 /** Returns true if node is an Unknown node. */
1306 int is_Unknown(const ir_node *node);
1307 /** Returns true if node is a Return node. */
1308 int is_Return(const ir_node *node);
1309 /** Returns true if node is a Call node. */
1310 int is_Call(const ir_node *node);
1311 /** Returns true if node is a CallBegin node. */
1312 int is_CallBegin(const ir_node *node);
1313 /** Returns true if node is a Sel node. */
1314 int is_Sel(const ir_node *node);
1315 /** Returns true if node is a Mul node. */
1316 int is_Mul(const ir_node *node);
1317 /** Returns true if node is a Mulh node. */
1318 int is_Mulh(const ir_node *node);
1319 /** Returns true if node is a Mux node. */
1320 int is_Mux(const ir_node *node);
1321 /** Returns true if node is a Load node. */
1322 int is_Load(const ir_node *node);
1323 /** Returns true if node is a Store node. */
1324 int is_Store(const ir_node *node);
1325 /** Returns true if node is a Sync node. */
1326 int is_Sync(const ir_node *node);
1327 /** Returns true if node is a Confirm node. */
1328 int is_Confirm(const ir_node *node);
1329 /** Returns true if node is a Pin node. */
1330 int is_Pin(const ir_node *node);
1331 /** Returns true if node is a SymConst node. */
1332 int is_SymConst(const ir_node *node);
1333 /** Returns true if node is a SymConst node with kind symconst_addr_ent. */
1334 int is_SymConst_addr_ent(const ir_node *node);
1335 /** Returns true if node is a Cond node. */
1336 int is_Cond(const ir_node *node);
1337 /** Returns true of node is a CopyB node. */
1338 int is_CopyB(const ir_node *node);
1339 /** Returns true if node is a Cmp node. */
1340 int is_Cmp(const ir_node *node);
1341 /** Returns true if node is an Alloc node. */
1342 int is_Alloc(const ir_node *node);
1343 /** Returns true if node is a Free node. */
1344 int is_Free(const ir_node *node);
1345 /** Returns true if a node is a Jmp node. */
1346 int is_Jmp(const ir_node *node);
1347 /** Returns true if a node is a IJmp node. */
1348 int is_IJmp(const ir_node *node);
1349 /** Returns true if a node is a Raise node. */
1350 int is_Raise(const ir_node *node);
1351 /** Returns true if a node is an ASM node. */
1352 int is_ASM(const ir_node *node);
1353 /** Returns true if node is a Proj node or a Filter node in INTRA-procedural view. */
1354 int is_Proj(const ir_node *node);
1355 /** Returns true if node is a Filter node. */
1356 int is_Filter(const ir_node *node);
1358 /** Returns true if the operation manipulates control flow:
1359 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1360 int is_cfop(const ir_node *node);
1362 /** Returns true if the operation manipulates interprocedural control flow:
1363 CallBegin, EndReg, EndExcept */
1364 int is_ip_cfop(const ir_node *node);
1365 /** Returns true if the operation can change the control flow because
1366 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1367 Bad. Raise is not fragile, but a unconditional jump. */
1368 int is_fragile_op(const ir_node *node);
1369 /** Returns the memory operand of fragile operations. */
1370 ir_node *get_fragile_op_mem(ir_node *node);
1371 /** Returns the result mode of a Div operation. */
1372 ir_mode *get_divop_resmod(const ir_node *node);
1374 /** Returns true if the operation is a forking control flow
1375 * operation: Cond. */
1376 int is_irn_forking(const ir_node *node);
1378 /** Return the type associated with the value produced by n
1379 * if the node remarks this type as it is the case for
1380 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1381 ir_type *get_irn_type(ir_node *n);
1383 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1385 ir_type *get_irn_type_attr(ir_node *n);
1387 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1388 ir_entity *get_irn_entity_attr(ir_node *n);
1390 /** Returns non-zero for constant-like nodes. */
1391 int is_irn_constlike(const ir_node *node);
1394 * Returns non-zero for nodes that must be always optimized
1395 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1397 int is_irn_always_opt(const ir_node *node);
1400 * Returns non-zero for nodes that are allowed to have keep-alives and
1401 * are neither Block nor PhiM.
1403 int is_irn_keep(const ir_node *node);
1406 * Returns non-zero for nodes that are always placed in the start block.
1408 int is_irn_start_block_placed(const ir_node *node);
1411 * Returns non-zero for nodes that are machine operations.
1413 int is_irn_machine_op(const ir_node *node);
1416 * Returns non-zero for nodes that are machine operands.
1418 int is_irn_machine_operand(const ir_node *node);
1421 * Returns non-zero for nodes that have the n'th user machine flag set.
1423 int is_irn_machine_user(const ir_node *node, unsigned n);
1426 * A type to express conditional jump predictions.
1429 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1430 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1431 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1432 } cond_jmp_predicate;
1434 /** Gets the string representation of the jump prediction .*/
1435 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1437 /** Returns the conditional jump prediction of a Cond node. */
1438 cond_jmp_predicate get_Cond_jmp_pred(const ir_node *cond);
1440 /** Sets a new conditional jump prediction. */
1441 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1443 /** Checks whether a node represents a global address. */
1444 int is_Global(const ir_node *node);
1446 /* Returns the entity of a global address. */
1447 ir_entity *get_Global_entity(const ir_node *node);
1450 * Access custom node data.
1451 * The data must have been registered with
1452 * register_additional_node_data() before.
1453 * @param node The ir node to get the data from.
1454 * @param type The type of the data you registered.
1455 * @param off The value returned by register_additional_node_data().
1456 * @return A pointer of type @p type.
1458 #define get_irn_data(node,type,off) \
1459 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1462 * Get the pointer to the node some custom data belongs to.
1463 * @param data The pointer to the custom data.
1464 * @param off The number as returned by register_additional_node_data().
1465 * @return A pointer to the ir node the custom data belongs to.
1467 #define get_irn_data_base(data,off) \
1468 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1471 * Request additional data to be allocated with an ir node.
1472 * @param size The size of the additional data required.
1473 * @return A positive number, if the operation was successful, which
1474 * must be passed to the access macro get_irn_data(), 0 if the
1475 * registration failed.
1477 unsigned firm_register_additional_node_data(unsigned size);
1480 * Return a pointer to the node attributes.
1481 * Needed for user-defined nodes.
1483 void *get_irn_generic_attr(ir_node *node);
1484 const void *get_irn_generic_attr_const(const ir_node *node);
1487 * Returns the unique node index for the node in its graph.
1488 * This index is used to access phase information for this node.
1490 unsigned get_irn_idx(const ir_node *node);
1493 * Sets the debug information of a node.
1495 * @param n The node.
1496 * @param db The debug info.
1498 void set_irn_dbg_info(ir_node *n, dbg_info *db);
1501 * Returns the debug information of an node.
1503 * @param n The node.
1505 dbg_info *get_irn_dbg_info(const ir_node *n);
1508 * Calculate a hash value of a node. Only inputs, mode and opcode are used.
1510 * @param node the node to hash
1512 unsigned firm_default_hash(const ir_node *node);
1514 /*@}*/ /* end of ir_node group definition */