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);
430 /** Set new keep-alives. */
431 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
432 /** Set new keep-alives from old keep-alives, skipping irn. */
433 void remove_End_keepalive(ir_node *end, ir_node *irn);
435 /** Some parts of the End node are allocated separately -- their memory
436 is not recovered by dead_node_elimination if a End node is dead.
437 free_End() frees these data structures. */
438 void free_End(ir_node *end);
440 /** Return the target address of an IJmp */
441 ir_node *get_IJmp_target(const ir_node *ijmp);
442 /** Sets the target address of an IJmp */
443 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
445 /* We distinguish three kinds of Cond nodes. These can be distinguished
446 by the mode of the selector operand and an internal flag of type cond_kind.
447 First we distinguish binary Conds and switch Conds.
448 A binary Cond has as selector a boolean value. Proj(0) projects the control
449 flow for case "False", Proj(1) the control flow for "True". A binary Cond
450 is recognized by the boolean selector.
451 The switch Cond has as selector an unsigned integer. It produces as result
452 an n+1 Tuple (cf0, ... , cfn) of control flows.
453 We differ two flavors of this Cond. The first, the dense Cond, passes
454 control along output i if the selector value is i, 0 <= i <= n. If the
455 selector value is >n it passes control along output n.
456 The second Cond flavor differences in the treatment of cases not specified in
457 the source program. It magically knows about the existence of Proj nodes.
458 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
459 exists. Else it passes control along output n (even if this Proj does not
460 exist.) This Cond we call "fragmentary". There is a special constructor
461 new_defaultProj that automatically sets the flavor.
462 The two switch flavors are distinguished by a flag of type cond_kind.
463 Default flavor is "dense"
466 dense, /**< Default. Missing Proj nodes are dead control flow. */
467 fragmentary /**< Special. No control flow optimizations allowed. Missing
468 Proj nodes mean default control flow, i.e., Proj(n). */
471 ir_node *get_Cond_selector(const ir_node *node);
472 void set_Cond_selector(ir_node *node, ir_node *selector);
473 cond_kind get_Cond_kind(const ir_node *node);
474 void set_Cond_kind(ir_node *node, cond_kind kind);
475 long get_Cond_defaultProj(const ir_node *node);
478 * Projection numbers for conditions.
481 pn_Cond_false, /**< Control flow if operand is "false". */
482 pn_Cond_true, /**< Control flow if operand is "true". */
483 pn_Cond_max /**< number of projections from a Cond */
484 } pn_Cond; /* Projection numbers for Cond. */
486 ir_node *get_Return_mem(const ir_node *node);
487 void set_Return_mem(ir_node *node, ir_node *mem);
488 ir_node **get_Return_res_arr(ir_node *node);
489 int get_Return_n_ress(const ir_node *node);
490 ir_node *get_Return_res(const ir_node *node, int pos);
491 void set_Return_res(ir_node *node, int pos, ir_node *res);
493 tarval *get_Const_tarval(const ir_node *node);
494 void set_Const_tarval(ir_node *node, tarval *con);
496 /** Return non-zero if the given Const node represents the 0 constant. */
497 int is_Const_null(const ir_node *node);
499 /** Return non-zero if the given Const node represents the 1 constant. */
500 int is_Const_one(const ir_node *node);
502 /** Return non-zero if the given Const node represents the constant with all bits set. */
503 int is_Const_all_one(const ir_node *node);
505 /** Returns the source language type of a Const node.
506 * Must be an atomic type. Mode of type must be mode of node.
508 ir_type *get_Const_type(ir_node *node);
510 /** Sets the source language type of a Const node. */
511 void set_Const_type(ir_node *node, ir_type *tp);
513 /** This enum names the three different kinds of symbolic Constants
514 represented by SymConst. The content of the attribute type_or_id
515 depends on this tag. Use the proper access routine after testing
518 symconst_type_tag, /**< The SymConst is a type tag for the given type.
519 symconst_symbol is type *. */
520 symconst_type_size, /**< The SymConst is the size of the given type.
521 symconst_symbol is type *. */
522 symconst_type_align, /**< The SymConst is the alignment of the given type.
523 symconst_symbol is type *. */
524 symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
525 by the linker. The pointer is represented by a string.
526 symconst_symbol is ident *. */
527 symconst_addr_ent, /**< The SymConst is a symbolic pointer to be filled in
528 by the linker. The pointer is represented by an entity.
529 symconst_symbol is entity *. */
530 symconst_ofs_ent, /**< The SymConst is the offset of its entity in the entities
532 symconst_enum_const, /**< The SymConst is a enumeration constant of an
534 symconst_label /**< The SymConst is a label address. */
537 /** Returns non-zero if s symconst kind has a type attribute */
538 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
540 /** Returns non-zero if s symconst kind has an ident attribute */
541 #define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)
543 /** Returns non-zero if s symconst kind has an entity attribute */
544 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
546 /** Returns non-zero if s symconst kind has an enum_const attribute */
547 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
549 /** Returns non-zero if s symconst kind has a label attribute */
550 #define SYMCONST_HAS_LABEL(kind) ((kind) == symconst_label)
552 /** SymConst attribute.
554 * This union contains the symbolic information represented by the node.
556 typedef union symconst_symbol {
557 ir_type *type_p; /**< The type of a SymConst. */
558 ident *ident_p; /**< The ident of a SymConst. */
559 ir_entity *entity_p; /**< The entity of a SymConst. */
560 ir_enum_const *enum_p; /**< The enumeration constant of a SymConst. */
561 ir_label_t label; /**< The label of a SymConst. */
564 /** Get the kind of the SymConst. */
565 symconst_kind get_SymConst_kind(const ir_node *node);
566 /** Set the kind of the SymConst. */
567 void set_SymConst_kind(ir_node *node, symconst_kind num);
569 /** Only to access SymConst of kind type_tag or size. Else assertion: */
570 ir_type *get_SymConst_type(ir_node *node);
571 void set_SymConst_type(ir_node *node, ir_type *tp);
573 /** Only to access SymConst of kind addr_name. Else assertion: */
574 ident *get_SymConst_name(const ir_node *node);
575 void set_SymConst_name(ir_node *node, ident *name);
577 /** Only to access SymConst of kind addr_ent. Else assertion: */
578 ir_entity *get_SymConst_entity(const ir_node *node);
579 void set_SymConst_entity(ir_node *node, ir_entity *ent);
581 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
582 ir_enum_const *get_SymConst_enum(const ir_node *node);
583 void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
585 /** Sets both: type and ptrinfo. Needed to treat the node independent of
586 its semantics. Does a memcpy for the memory sym points to. */
587 /* write 'union': firmjni then does not create a method... */
588 union symconst_symbol get_SymConst_symbol(const ir_node *node);
589 void set_SymConst_symbol(ir_node *node,
590 union symconst_symbol sym);
592 /** Only to access SymConst of kind symconst_label. Else assertion: */
593 ir_label_t get_SymConst_label(const ir_node *node);
594 void set_SymConst_label(ir_node *node, ir_label_t label);
597 /** Access the type of the value represented by the SymConst.
599 * Example: primitive type int for SymConst size. */
600 ir_type *get_SymConst_value_type(ir_node *node);
601 void set_SymConst_value_type(ir_node *node, ir_type *tp);
603 ir_node *get_Sel_mem(const ir_node *node);
604 void set_Sel_mem(ir_node *node, ir_node *mem);
605 ir_node *get_Sel_ptr(const ir_node *node); /* ptr to the object to select from */
606 void set_Sel_ptr(ir_node *node, ir_node *ptr);
607 ir_node **get_Sel_index_arr(ir_node *node);
608 int get_Sel_n_indexs(const ir_node *node);
609 ir_node *get_Sel_index(const ir_node *node, int pos);
610 void set_Sel_index(ir_node *node, int pos, ir_node *index);
611 ir_entity *get_Sel_entity(const ir_node *node); /* entity to select */
612 void set_Sel_entity (ir_node *node, ir_entity *ent);
615 * Projection numbers for result of Call node: use for Proj nodes!
618 pn_Call_M_regular = pn_Generic_M_regular, /**< The memory result. */
619 pn_Call_X_regular = pn_Generic_X_regular, /**< The control flow result when no exception occurs. */
620 pn_Call_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler. */
621 pn_Call_T_result = pn_Generic_other, /**< The tuple containing all (0, 1, 2, ...) results. */
622 pn_Call_M_except, /**< The memory result in case the called method terminated with
624 pn_Call_P_value_res_base, /**< A pointer to the memory region containing copied results
625 passed by value (for compound result types). */
626 pn_Call_max /**< number of projections from a Call */
627 } pn_Call; /* Projection numbers for Call. */
628 #define pn_Call_M pn_Call_M_regular
630 ir_node *get_Call_mem(const ir_node *node);
631 void set_Call_mem(ir_node *node, ir_node *mem);
632 ir_node *get_Call_ptr(const ir_node *node);
633 void set_Call_ptr(ir_node *node, ir_node *ptr);
634 ir_node **get_Call_param_arr(ir_node *node);
635 /** Gets the number of parameters of a call. */
636 int get_Call_n_params(const ir_node *node);
637 /** Gets the call parameter at position pos. */
638 ir_node *get_Call_param(const ir_node *node, int pos);
639 /** Sets the call parameter at position pos. */
640 void set_Call_param(ir_node *node, int pos, ir_node *param);
641 /** Gets the type of a call. */
642 ir_type *get_Call_type(ir_node *node);
643 /** Sets the type of a call. */
644 void set_Call_type(ir_node *node, ir_type *tp);
645 /** Gets the arity of a call. Identical to get_Call_n_params(). */
646 int get_Call_arity(const ir_node *node);
649 * Returns non-zero if a Call is surely a self-recursive Call.
650 * Beware: if this functions returns 0, the call might be self-recursive!
652 int is_self_recursive_Call(const ir_node *call);
654 /** Set, get and remove the callee information for a Call node.
656 * The callee information lists all method entities that can be called
657 * from this node. If the address expression can not be analyzed fully,
658 * e.g., as entities can be called that are not in the compilation unit,
659 * the array contains the unknown_entity. The array contains only entities
660 * with peculiarity_existent, but with all kinds of visibility. The entities
661 * not necessarily contain an irg.
663 * The array is only accessible if callee information is valid. See flag
666 * The memory allocated for the array is managed automatically, i.e., it must
667 * not be freed if the Call node is removed from the graph.
669 * @param node A Call node.
671 int Call_has_callees(const ir_node *node);
672 int get_Call_n_callees(const ir_node *node);
673 ir_entity *get_Call_callee(const ir_node *node, int pos);
675 /** Set the full callee array.
677 * The passed array is copied. Assumes current_ir_graph set properly! */
678 void set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
679 void remove_Call_callee_arr(ir_node *node);
681 ir_node *get_CallBegin_ptr(const ir_node *node);
682 void set_CallBegin_ptr(ir_node *node, ir_node *ptr);
683 ir_node *get_CallBegin_call(const ir_node *node);
684 void set_CallBegin_call(ir_node *node, ir_node *call);
686 /* For unary and binary arithmetic operations the access to the
687 operands can be factored out. Left is the first, right the
688 second arithmetic value as listed in tech report 1999-44.
689 unops are: Minus, Abs, Not, Conv, Cast
690 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
691 Shr, Shrs, Rotl, Cmp */
692 int is_unop(const ir_node *node);
693 ir_node *get_unop_op(const ir_node *node);
694 void set_unop_op(ir_node *node, ir_node *op);
695 int is_binop(const ir_node *node);
696 ir_node *get_binop_left(const ir_node *node);
697 void set_binop_left(ir_node *node, ir_node *left);
698 ir_node *get_binop_right(const ir_node *node);
699 void set_binop_right(ir_node *node, ir_node *right);
701 ir_node *get_Add_left(const ir_node *node);
702 void set_Add_left(ir_node *node, ir_node *left);
703 ir_node *get_Add_right(const ir_node *node);
704 void set_Add_right(ir_node *node, ir_node *right);
706 ir_node *get_Sub_left(const ir_node *node);
707 void set_Sub_left(ir_node *node, ir_node *left);
708 ir_node *get_Sub_right(const ir_node *node);
709 void set_Sub_right(ir_node *node, ir_node *right);
711 ir_node *get_Minus_op(const ir_node *node);
712 void set_Minus_op(ir_node *node, ir_node *op);
714 ir_node *get_Mul_left(const ir_node *node);
715 void set_Mul_left(ir_node *node, ir_node *left);
716 ir_node *get_Mul_right(const ir_node *node);
717 void set_Mul_right(ir_node *node, ir_node *right);
719 ir_node *get_Mulh_left(const ir_node *node);
720 void set_Mulh_left(ir_node *node, ir_node *left);
721 ir_node *get_Mulh_right(const ir_node *node);
722 void set_Mulh_right(ir_node *node, ir_node *right);
724 ir_node *get_Quot_left(const ir_node *node);
725 void set_Quot_left(ir_node *node, ir_node *left);
726 ir_node *get_Quot_right(const ir_node *node);
727 void set_Quot_right(ir_node *node, ir_node *right);
728 ir_node *get_Quot_mem(const ir_node *node);
729 void set_Quot_mem(ir_node *node, ir_node *mem);
730 ir_mode *get_Quot_resmode(const ir_node *node);
731 void set_Quot_resmode(ir_node *node, ir_mode *mode);
734 * Projection numbers for Quot: use for Proj nodes!
737 pn_Quot_M = pn_Generic_M_regular, /**< Memory result. */
738 pn_Quot_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
739 pn_Quot_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
740 pn_Quot_res = pn_Generic_other, /**< Result of computation. */
741 pn_Quot_max /**< number of projections from a Quot */
742 } pn_Quot; /* Projection numbers for Quot. */
744 ir_node *get_DivMod_left(const ir_node *node);
745 void set_DivMod_left(ir_node *node, ir_node *left);
746 ir_node *get_DivMod_right(const ir_node *node);
747 void set_DivMod_right(ir_node *node, ir_node *right);
748 ir_node *get_DivMod_mem(const ir_node *node);
749 void set_DivMod_mem(ir_node *node, ir_node *mem);
750 ir_mode *get_DivMod_resmode(const ir_node *node);
751 void set_DivMod_resmode(ir_node *node, ir_mode *mode);
754 * Projection numbers for DivMod: use for Proj nodes!
757 pn_DivMod_M = pn_Generic_M_regular, /**< Memory result. */
758 pn_DivMod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
759 pn_DivMod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
760 pn_DivMod_res_div = pn_Generic_other, /**< Result of computation a / b. */
761 pn_DivMod_res_mod, /**< Result of computation a % b. */
762 pn_DivMod_max /**< number of projections from a DivMod */
763 } pn_DivMod; /* Projection numbers for DivMod. */
765 ir_node *get_Div_left(const ir_node *node);
766 void set_Div_left(ir_node *node, ir_node *left);
767 ir_node *get_Div_right(const ir_node *node);
768 void set_Div_right(ir_node *node, ir_node *right);
769 ir_node *get_Div_mem(const ir_node *node);
770 void set_Div_mem(ir_node *node, ir_node *mem);
771 ir_mode *get_Div_resmode(const ir_node *node);
772 void set_Div_resmode(ir_node *node, ir_mode *mode);
773 int is_Div_remainderless(const ir_node *node);
776 * Projection numbers for Div: use for Proj nodes!
779 pn_Div_M = pn_Generic_M_regular, /**< Memory result. */
780 pn_Div_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
781 pn_Div_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
782 pn_Div_res = pn_Generic_other, /**< Result of computation. */
783 pn_Div_max /**< number of projections from a Div */
784 } pn_Div; /* Projection numbers for Div. */
786 ir_node *get_Mod_left(const ir_node *node);
787 void set_Mod_left(ir_node *node, ir_node *left);
788 ir_node *get_Mod_right(const ir_node *node);
789 void set_Mod_right(ir_node *node, ir_node *right);
790 ir_node *get_Mod_mem(const ir_node *node);
791 void set_Mod_mem(ir_node *node, ir_node *mem);
792 ir_mode *get_Mod_resmode(const ir_node *node);
793 void set_Mod_resmode(ir_node *node, ir_mode *mode);
796 * Projection numbers for Mod: use for Proj nodes!
799 pn_Mod_M = pn_Generic_M_regular, /**< Memory result. */
800 pn_Mod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
801 pn_Mod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
802 pn_Mod_res = pn_Generic_other, /**< Result of computation. */
803 pn_Mod_max /**< number of projections from a Mod */
804 } pn_Mod; /* Projection numbers for Mod. */
806 ir_node *get_Abs_op(const ir_node *node);
807 void set_Abs_op(ir_node *node, ir_node *op);
809 ir_node *get_And_left(const ir_node *node);
810 void set_And_left(ir_node *node, ir_node *left);
811 ir_node *get_And_right(const ir_node *node);
812 void set_And_right(ir_node *node, ir_node *right);
814 ir_node *get_Or_left(const ir_node *node);
815 void set_Or_left(ir_node *node, ir_node *left);
816 ir_node *get_Or_right(const ir_node *node);
817 void set_Or_right(ir_node *node, ir_node *right);
819 ir_node *get_Eor_left(const ir_node *node);
820 void set_Eor_left(ir_node *node, ir_node *left);
821 ir_node *get_Eor_right(const ir_node *node);
822 void set_Eor_right(ir_node *node, ir_node *right);
824 ir_node *get_Not_op(const ir_node *node);
825 void set_Not_op(ir_node *node, ir_node *op);
828 * Projection numbers for Cmp are defined several times.
829 * The bit patterns are used for various tests, so don't change.
830 * The "unordered" values are possible results of comparing
831 * floating point numbers.
832 * Note that the encoding is imported, so do NOT change the order.
835 pn_Cmp_False = 0, /**< false */
836 pn_Cmp_Eq = 1, /**< equal */
837 pn_Cmp_Lt = 2, /**< less */
838 pn_Cmp_Le = pn_Cmp_Eq|pn_Cmp_Lt, /**< less or equal */
839 pn_Cmp_Gt = 4, /**< greater */
840 pn_Cmp_Ge = pn_Cmp_Eq|pn_Cmp_Gt, /**< greater or equal */
841 pn_Cmp_Lg = pn_Cmp_Lt|pn_Cmp_Gt, /**< less or greater */
842 pn_Cmp_Leg = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
843 pn_Cmp_Uo = 8, /**< unordered */
844 pn_Cmp_Ue = pn_Cmp_Uo|pn_Cmp_Eq, /**< unordered or equal */
845 pn_Cmp_Ul = pn_Cmp_Uo|pn_Cmp_Lt, /**< unordered or less */
846 pn_Cmp_Ule = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
847 pn_Cmp_Ug = pn_Cmp_Uo|pn_Cmp_Gt, /**< unordered or greater */
848 pn_Cmp_Uge = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
849 pn_Cmp_Ne = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
850 pn_Cmp_True = 15 /**< true */
851 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for JNI interface */
852 } pn_Cmp; /* Projection numbers for Cmp */
853 /* #define not_mask pn_Cmp_Leg */
855 /** returns the pnc name from an pnc constant */
856 const char *get_pnc_string(int pnc);
858 /** Calculates the negated (Complement(R)) pnc condition. */
859 pn_Cmp get_negated_pnc(long pnc, ir_mode *mode);
861 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
862 pn_Cmp get_inversed_pnc(long pnc);
864 /** An alternative name for get_inversed_pnc() that can be better memorized. */
865 #define get_mirrored_pnc(pnc) get_inversed_pnc(pnc)
867 ir_node *get_Cmp_left(const ir_node *node);
868 void set_Cmp_left(ir_node *node, ir_node *left);
869 ir_node *get_Cmp_right(const ir_node *node);
870 void set_Cmp_right(ir_node *node, ir_node *right);
872 ir_node *get_Shl_left(const ir_node *node);
873 void set_Shl_left(ir_node *node, ir_node *left);
874 ir_node *get_Shl_right(const ir_node *node);
875 void set_Shl_right(ir_node *node, ir_node *right);
877 ir_node *get_Shr_left(const ir_node *node);
878 void set_Shr_left(ir_node *node, ir_node *left);
879 ir_node *get_Shr_right(const ir_node *node);
880 void set_Shr_right(ir_node *node, ir_node *right);
882 ir_node *get_Shrs_left(const ir_node *node);
883 void set_Shrs_left(ir_node *node, ir_node *left);
884 ir_node *get_Shrs_right(const ir_node *node);
885 void set_Shrs_right(ir_node *node, ir_node *right);
887 ir_node *get_Rotl_left(const ir_node *node);
888 void set_Rotl_left(ir_node *node, ir_node *left);
889 ir_node *get_Rotl_right(const ir_node *node);
890 void set_Rotl_right(ir_node *node, ir_node *right);
892 ir_node *get_Conv_op(const ir_node *node);
893 void set_Conv_op(ir_node *node, ir_node *op);
894 int get_Conv_strict(const ir_node *node);
895 void set_Conv_strict(ir_node *node, int flag);
897 /* Does Cast need a mem operator?
898 * Cast should only depend on the type, not on the state of an
899 * entity. But: we initialize various fields after Alloc, that
900 * are accessed in the cast. This required some precaution, to
901 * get the right memory into the Loads generated from the cast.
903 ir_node *get_Cast_op(const ir_node *node);
904 void set_Cast_op(ir_node *node, ir_node *op);
905 ir_type *get_Cast_type(ir_node *node);
906 void set_Cast_type(ir_node *node, ir_type *to_tp);
908 /** Checks for upcast.
910 * Returns true if the Cast node casts a class type to a super type.
911 * Works also for pointers to classes (recursively).
913 * Needs typeinfo calculated.
915 int is_Cast_upcast(ir_node *node);
917 /** Checks for downcast.
919 * Returns true if the Cast node casts a class type to a sub type.
920 * Works also for pointers to classes (recursively).
922 * Needs typeinfo calculated.
924 int is_Cast_downcast(ir_node *node);
927 /** Returns true if n is a Phi or a Filter node in INTER-procedural view.
928 Returns false if irg is in phase phase_building and the Phi has zero
929 predecessors: it's a Phi0. */
930 int is_Phi(const ir_node *n);
931 /** Returns true if irg in phase phase_building and the Phi has zero
932 predecessors. It's a Phi0 then. */
933 int is_Phi0(const ir_node *n);
934 /* These routines also work for Filter nodes in INTER-procedural view. */
935 ir_node **get_Phi_preds_arr(ir_node *node);
936 int get_Phi_n_preds(const ir_node *node);
937 ir_node *get_Phi_pred(const ir_node *node, int pos);
938 void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
939 ir_node *get_Phi_next(const ir_node *phi);
940 void set_Phi_next(ir_node *phi, ir_node *next);
942 ir_node *get_Filter_pred(ir_node *node);
943 void set_Filter_pred(ir_node *node, ir_node *pred);
944 long get_Filter_proj(ir_node *node);
945 void set_Filter_proj(ir_node *node, long proj);
946 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
947 * @@@ Maybe better: arity is zero if no cg preds. */
948 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
949 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
950 int get_Filter_n_cg_preds(ir_node *node);
951 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
953 /** Return true if parameter is a memory operation.
955 * A memory operation is an operation that changes the
956 * memory. I.e., a Load or a Store operation.
958 int is_memop(const ir_node *node);
959 ir_node *get_memop_mem(const ir_node *node);
960 void set_memop_mem(ir_node *node, ir_node *mem);
961 ir_node *get_memop_ptr(const ir_node *node);
962 void set_memop_ptr(ir_node *node, ir_node *ptr);
965 * Projection numbers for Load: use for Proj nodes!
968 pn_Load_M = pn_Generic_M_regular, /**< Memory result. */
969 pn_Load_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
970 pn_Load_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
971 pn_Load_res = pn_Generic_other, /**< Result of load operation. */
972 pn_Load_max /**< number of projections from a Load */
973 } pn_Load; /* Projection numbers for Load. */
975 ir_node *get_Load_mem(const ir_node *node);
976 void set_Load_mem(ir_node *node, ir_node *mem);
977 ir_node *get_Load_ptr(const ir_node *node);
978 void set_Load_ptr(ir_node *node, ir_node *ptr);
979 ir_mode *get_Load_mode(const ir_node *node);
980 void set_Load_mode(ir_node *node, ir_mode *mode);
981 ir_volatility get_Load_volatility(const ir_node *node);
982 void set_Load_volatility(ir_node *node, ir_volatility volatility);
983 ir_align get_Load_align(const ir_node *node);
984 void set_Load_align(ir_node *node, ir_align align);
987 * Projection numbers for Store: use for Proj nodes!
990 pn_Store_M = pn_Generic_M_regular, /**< Memory result. */
991 pn_Store_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
992 pn_Store_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
993 pn_Store_max = pn_Generic_other /**< number of projections from a Store */
994 } pn_Store; /* Projection numbers for Store. */
996 ir_node *get_Store_mem(const ir_node *node);
997 void set_Store_mem(ir_node *node, ir_node *mem);
998 ir_node *get_Store_ptr(const ir_node *node);
999 void set_Store_ptr(ir_node *node, ir_node *ptr);
1000 ir_node *get_Store_value(const ir_node *node);
1001 void set_Store_value(ir_node *node, ir_node *value);
1002 ir_volatility get_Store_volatility(const ir_node *node);
1003 void set_Store_volatility(ir_node *node, ir_volatility volatility);
1004 ir_align get_Store_align(const ir_node *node);
1005 void set_Store_align(ir_node *node, ir_align align);
1008 * Projection numbers for Alloc: use for Proj nodes!
1011 pn_Alloc_M = pn_Generic_M_regular, /**< Memory result. */
1012 pn_Alloc_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1013 pn_Alloc_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
1014 pn_Alloc_res = pn_Generic_other, /**< Result of allocation. */
1015 pn_Alloc_max /**< number of projections from an Alloc */
1016 } pn_Alloc; /* Projection numbers for Alloc. */
1018 ir_node *get_Alloc_mem(const ir_node *node);
1019 void set_Alloc_mem(ir_node *node, ir_node *mem);
1020 ir_node *get_Alloc_size(const ir_node *node);
1021 void set_Alloc_size(ir_node *node, ir_node *size);
1022 ir_type *get_Alloc_type(ir_node *node);
1023 void set_Alloc_type(ir_node *node, ir_type *tp);
1025 /** The allocation place. */
1027 stack_alloc, /**< Alloc allocates the object on the stack. */
1028 heap_alloc /**< Alloc allocates the object on the heap. */
1031 ir_where_alloc get_Alloc_where(const ir_node *node);
1032 void set_Alloc_where(ir_node *node, ir_where_alloc where);
1034 ir_node *get_Free_mem(const ir_node *node);
1035 void set_Free_mem(ir_node *node, ir_node *mem);
1036 ir_node *get_Free_ptr(const ir_node *node);
1037 void set_Free_ptr(ir_node *node, ir_node *ptr);
1038 ir_node *get_Free_size(const ir_node *node);
1039 void set_Free_size(ir_node *node, ir_node *size);
1040 ir_type *get_Free_type(ir_node *node);
1041 void set_Free_type(ir_node *node, ir_type *tp);
1043 ir_where_alloc get_Free_where(const ir_node *node);
1044 void set_Free_where(ir_node *node, ir_where_alloc where);
1046 ir_node **get_Sync_preds_arr(ir_node *node);
1047 int get_Sync_n_preds(const ir_node *node);
1048 ir_node *get_Sync_pred(const ir_node *node, int pos);
1049 void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
1050 void add_Sync_pred(ir_node *node, ir_node *pred);
1052 /** Returns the source language type of a Proj node.
1053 * Must be an atomic type. Mode of type must be mode of node.
1055 ir_type *get_Proj_type(ir_node *node);
1057 /** Return the predecessor of a Proj node. */
1058 ir_node *get_Proj_pred(const ir_node *node);
1059 void set_Proj_pred(ir_node *node, ir_node *pred);
1060 /** Return the projection number of a Proj node. */
1061 long get_Proj_proj(const ir_node *node);
1062 void set_Proj_proj(ir_node *node, long proj);
1064 ir_node **get_Tuple_preds_arr(ir_node *node);
1065 int get_Tuple_n_preds(const ir_node *node);
1066 ir_node *get_Tuple_pred(const ir_node *node, int pos);
1067 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
1069 ir_node *get_Id_pred(const ir_node *node);
1070 void set_Id_pred(ir_node *node, ir_node *pred);
1072 /** Confirm has a single result and returns 'value' unchanged.
1073 * The node expresses a restriction on 'value':
1074 * 'value' 'cmp' 'bound' == true. */
1075 ir_node *get_Confirm_value(const ir_node *node);
1076 void set_Confirm_value(ir_node *node, ir_node *value);
1077 ir_node *get_Confirm_bound(const ir_node *node);
1078 void set_Confirm_bound(ir_node *node, ir_node *bound);
1079 pn_Cmp get_Confirm_cmp(const ir_node *node);
1080 void set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
1083 * Mux Support: Note that Psi nodes with one condition can be handled
1084 * like Mux nodes, and the access functions work as expected.
1086 ir_node *get_Mux_sel(const ir_node *node);
1087 void set_Mux_sel(ir_node *node, ir_node *sel);
1088 ir_node *get_Mux_false(const ir_node *node);
1089 void set_Mux_false(ir_node *node, ir_node *ir_false);
1090 ir_node *get_Mux_true(const ir_node *node);
1091 void set_Mux_true(ir_node *node, ir_node *ir_true);
1093 ir_node *get_Psi_cond(const ir_node *node, int pos);
1094 void set_Psi_cond(ir_node *node, int pos, ir_node *cond);
1095 ir_node *get_Psi_val(const ir_node *node, int pos);
1096 void set_Psi_val(ir_node *node, int pos, ir_node *val);
1097 ir_node *get_Psi_default(const ir_node *node);
1098 void set_Psi_default(ir_node *node, ir_node *val);
1099 int get_Psi_n_conds(const ir_node *node);
1102 * Projection numbers for result of CopyB node: use for Proj nodes!
1105 pn_CopyB_M_regular = pn_Generic_M_regular, /**< The memory result. */
1106 pn_CopyB_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1107 pn_CopyB_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1108 pn_CopyB_M_except = pn_Generic_other, /**< The memory result in case the runtime function terminated with
1110 pn_CopyB_max /**< number of projections from a CopyB */
1111 } pn_CopyB; /* Projection numbers for CopyB. */
1112 #define pn_CopyB_M pn_CopyB_M_regular
1114 ir_node *get_CopyB_mem(const ir_node *node);
1115 void set_CopyB_mem(ir_node *node, ir_node *mem);
1116 ir_node *get_CopyB_dst(const ir_node *node);
1117 void set_CopyB_dst(ir_node *node, ir_node *dst);
1118 ir_node *get_CopyB_src(const ir_node *node);
1119 void set_CopyB_src(ir_node *node, ir_node *src);
1120 ir_type *get_CopyB_type(ir_node *node);
1121 void set_CopyB_type(ir_node *node, ir_type *data_type);
1124 * Projection numbers for result of InstOf node: use for Proj nodes!
1127 pn_InstOf_M_regular = pn_Generic_M_regular, /**< The memory result. */
1128 pn_InstOf_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1129 pn_InstOf_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1130 pn_InstOf_res = pn_Generic_other, /**< The checked object pointer. */
1131 pn_InstOf_M_except, /**< The memory result in case the runtime function terminated with
1133 pn_InstOf_max /**< number of projections from an InstOf */
1135 #define pn_InstOf_M pn_InstOf_M_regular
1137 /** InstOf access. */
1138 ir_type *get_InstOf_type(ir_node *node);
1139 void set_InstOf_type(ir_node *node, ir_type *type);
1140 ir_node *get_InstOf_store(const ir_node *node);
1141 void set_InstOf_store(ir_node *node, ir_node *obj);
1142 ir_node *get_InstOf_obj(const ir_node *node);
1143 void set_InstOf_obj(ir_node *node, ir_node *obj);
1146 * Projection numbers for Raise.
1149 pn_Raise_M = pn_Generic_M_regular, /**< The Memory result. */
1150 pn_Raise_X = pn_Generic_X_regular, /**< The control flow to the exception handler. */
1151 pn_Raise_max /**< number of projections from a Raise */
1152 } pn_Raise; /* Projection numbers for Raise. */
1154 ir_node *get_Raise_mem(const ir_node *node);
1155 void set_Raise_mem(ir_node *node, ir_node *mem);
1156 ir_node *get_Raise_exo_ptr(const ir_node *node); /* PoinTeR to EXception Object */
1157 void set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
1160 * Projection numbers for result of Bound node: use for Proj nodes!
1163 pn_Bound_M = pn_Generic_M_regular, /**< The memory result. */
1164 pn_Bound_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1165 pn_Bound_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1166 pn_Bound_res = pn_Generic_other, /**< The checked index. */
1167 pn_Bound_max /**< number of projections from a Bound */
1170 /** Returns the memory input of a Bound operation. */
1171 ir_node *get_Bound_mem(const ir_node *bound);
1172 void set_Bound_mem(ir_node *bound, ir_node *mem);
1174 /** Returns the index input of a Bound operation. */
1175 ir_node *get_Bound_index(const ir_node *bound);
1176 void set_Bound_index(ir_node *bound, ir_node *idx);
1178 /** Returns the lower bound input of a Bound operation. */
1179 ir_node *get_Bound_lower(const ir_node *bound);
1180 void set_Bound_lower(ir_node *bound, ir_node *lower);
1182 /** Returns the upper bound input of a Bound operation. */
1183 ir_node *get_Bound_upper(const ir_node *bound);
1184 void set_Bound_upper(ir_node *bound, ir_node *upper);
1186 /** Return the operand of a Pin node. */
1187 ir_node *get_Pin_op(const ir_node *pin);
1188 void set_Pin_op(ir_node *pin, ir_node *node);
1190 /** A input/output constraint attribute */
1192 unsigned pos; /**< The inputs/output position for this constraint. */
1193 ident *constraint; /**< The constraint for this input/output. */
1194 ir_mode *mode; /**< The mode of the constraint. */
1195 } ir_asm_constraint;
1197 /** Return the assembler text of an ASM pseudo node. */
1198 ident *get_ASM_text(const ir_node *node);
1199 /** Return the number of input constraints for an ASM node. */
1200 int get_ASM_n_input_constraints(const ir_node *node);
1201 /** Return the input constraints for an ASM node. */
1202 const ir_asm_constraint *get_ASM_input_constraints(const ir_node *node);
1203 /** Return the number of output constraints for an ASM node. */
1204 int get_ASM_n_output_constraints(const ir_node *node);
1205 /** Return the output constraints for an ASM node. */
1206 const ir_asm_constraint *get_ASM_output_constraints(const ir_node *node);
1207 /** Return the number of clobbered registers for an ASM node. */
1208 int get_ASM_n_clobbers(const ir_node *node);
1209 /** Return the list of clobbered registers for an ASM node. */
1210 ident **get_ASM_clobbers(const ir_node *node);
1214 * NAME Auxiliary routines
1218 /** Returns operand of node if node is a Proj. */
1219 ir_node *skip_Proj(ir_node *node);
1220 /** Returns operand of node if node is a Proj. */
1221 const ir_node *skip_Proj_const(const ir_node *node);
1222 /** Returns operand of node if node is a Id. */
1223 ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
1224 /** Returns corresponding operand of Tuple if node is a Proj from
1226 ir_node *skip_Tuple(ir_node *node);
1227 /** returns operand of node if node is a Cast. */
1228 ir_node *skip_Cast(ir_node *node);
1229 /** Returns operand of node if node is a Confirm */
1230 ir_node *skip_Confirm(ir_node *node);
1231 /** Skip all high-level Operations (including Cast, Confirm). */
1232 ir_node *skip_HighLevel_ops(ir_node *node);
1233 /** Returns true if irn is a Const node. */
1234 int is_Const(const ir_node *node);
1235 /** Returns true if a node is a Conv node. */
1236 int is_Conv(const ir_node *node);
1237 /** Returns true if a node is a strictConv node. */
1238 int is_strictConv(const ir_node *node);
1239 /** Returns true if a node is a Cast node. */
1240 int is_Cast(const ir_node *node);
1241 /** Returns true if node is a Bad node. */
1242 int is_Bad(const ir_node *node);
1243 /** Returns true if node is a NoMem node. */
1244 int is_NoMem(const ir_node *node);
1245 /** Returns true if node is a Start node. */
1246 int is_Start(const ir_node *node);
1247 /** Returns true if node is a Minus node. */
1248 int is_Minus(const ir_node *node);
1249 /** Returns true if node is a Abs node. */
1250 int is_Abs(const ir_node *node);
1251 /** Returns true if node is a Mod node. */
1252 int is_Mod(const ir_node *node);
1253 /** Returns true if node is a Div node. */
1254 int is_Div(const ir_node *node);
1255 /** Returns true if node is a DivMod node. */
1256 int is_DivMod(const ir_node *node);
1257 /** Returns true if node is a Quot node. */
1258 int is_Quot(const ir_node *node);
1259 /** Returns true if node is an Add node. */
1260 int is_Add(const ir_node *node);
1261 /** Returns true if node is an And node. */
1262 int is_And(const ir_node *node);
1263 /** Returns true if node is an Or node. */
1264 int is_Or(const ir_node *node);
1265 /** Returns true if node is an Eor node. */
1266 int is_Eor(const ir_node *node);
1267 /** Returns true if node is a Sub node. */
1268 int is_Sub(const ir_node *node);
1269 /** Returns true if node is a Not node. */
1270 int is_Not(const ir_node *node);
1271 /** Returns true if node is a Shl node. */
1272 int is_Shl(const ir_node *node);
1273 /** Returns true if node is a Shr node. */
1274 int is_Shr(const ir_node *node);
1275 /** Returns true if node is a Shrs node. */
1276 int is_Shrs(const ir_node *node);
1277 /** Returns true if node is a Rotl node. */
1278 int is_Rotl(const ir_node *node);
1279 /** Returns true if node is a Psi node. */
1280 int is_Psi(const ir_node *node);
1281 /** Returns true if node is an Id node. */
1282 int is_Id(const ir_node *node);
1283 /** Returns true if node is a Tuple node. */
1284 int is_Tuple(const ir_node *node);
1285 /** Returns true if node is a Bound node. */
1286 int is_Bound(const ir_node *node);
1287 /** Returns true if the node is not a Block */
1288 int is_no_Block(const ir_node *node);
1289 /** Returns true if the node is a Block */
1290 int is_Block(const ir_node *node);
1291 /** Returns true if node is an Unknown node. */
1292 int is_Unknown(const ir_node *node);
1293 /** Returns true if node is a Return node. */
1294 int is_Return(const ir_node *node);
1295 /** Returns true if node is a Call node. */
1296 int is_Call(const ir_node *node);
1297 /** Returns true if node is a CallBegin node. */
1298 int is_CallBegin(const ir_node *node);
1299 /** Returns true if node is a Sel node. */
1300 int is_Sel(const ir_node *node);
1301 /** Returns true if node is a Mul node. */
1302 int is_Mul(const ir_node *node);
1303 /** Returns true if node is a Mulh node. */
1304 int is_Mulh(const ir_node *node);
1305 /** Returns true if node is a Mux node or a Psi with only one condition. */
1306 int is_Mux(const ir_node *node);
1307 /** Returns true if node is a Load node. */
1308 int is_Load(const ir_node *node);
1309 /** Returns true if node is a Store node. */
1310 int is_Store(const ir_node *node);
1311 /** Returns true if node is a Sync node. */
1312 int is_Sync(const ir_node *node);
1313 /** Returns true if node is a Confirm node. */
1314 int is_Confirm(const ir_node *node);
1315 /** Returns true if node is a Pin node. */
1316 int is_Pin(const ir_node *node);
1317 /** Returns true if node is a SymConst node. */
1318 int is_SymConst(const ir_node *node);
1319 /** Returns true if node is a SymConst node with kind symconst_addr_ent. */
1320 int is_SymConst_addr_ent(const ir_node *node);
1321 /** Returns true if node is a Cond node. */
1322 int is_Cond(const ir_node *node);
1323 /** Returns true of node is a CopyB node. */
1324 int is_CopyB(const ir_node *node);
1325 /** Returns true if node is a Cmp node. */
1326 int is_Cmp(const ir_node *node);
1327 /** Returns true if node is an Alloc node. */
1328 int is_Alloc(const ir_node *node);
1329 /** Returns true if node is a Free node. */
1330 int is_Free(const ir_node *node);
1331 /** Returns true if a node is a Jmp node. */
1332 int is_Jmp(const ir_node *node);
1333 /** Returns true if a node is a IJmp node. */
1334 int is_IJmp(const ir_node *node);
1335 /** Returns true if a node is a Raise node. */
1336 int is_Raise(const ir_node *node);
1337 /** Returns true if a node is an ASM node. */
1338 int is_ASM(const ir_node *node);
1339 /** Returns true if node is a Proj node or a Filter node in INTRA-procedural view. */
1340 int is_Proj(const ir_node *node);
1341 /** Returns true if node is a Filter node. */
1342 int is_Filter(const ir_node *node);
1344 /** Returns true if the operation manipulates control flow:
1345 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1346 int is_cfop(const ir_node *node);
1348 /** Returns true if the operation manipulates interprocedural control flow:
1349 CallBegin, EndReg, EndExcept */
1350 int is_ip_cfop(const ir_node *node);
1351 /** Returns true if the operation can change the control flow because
1352 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1353 Bad. Raise is not fragile, but a unconditional jump. */
1354 int is_fragile_op(const ir_node *node);
1355 /** Returns the memory operand of fragile operations. */
1356 ir_node *get_fragile_op_mem(ir_node *node);
1357 /** Returns the result mode of a Div operation. */
1358 ir_mode *get_divop_resmod(const ir_node *node);
1360 /** Returns true if the operation is a forking control flow
1361 * operation: Cond. */
1362 int is_irn_forking(const ir_node *node);
1364 /** Return the type associated with the value produced by n
1365 * if the node remarks this type as it is the case for
1366 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1367 ir_type *get_irn_type(ir_node *n);
1369 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1371 ir_type *get_irn_type_attr(ir_node *n);
1373 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1374 ir_entity *get_irn_entity_attr(ir_node *n);
1376 /** Returns non-zero for constant-like nodes. */
1377 int is_irn_constlike(const ir_node *node);
1380 * Returns non-zero for nodes that must be always optimized
1381 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1383 int is_irn_always_opt(const ir_node *node);
1386 * Returns non-zero for nodes that are allowed to have keep-alives and
1387 * are neither Block nor PhiM.
1389 int is_irn_keep(const ir_node *node);
1392 * Returns non-zero for nodes that are always placed in the start block.
1394 int is_irn_start_block_placed(const ir_node *node);
1397 * Returns non-zero for nodes that are machine operations.
1399 int is_irn_machine_op(const ir_node *node);
1402 * Returns non-zero for nodes that are machine operands.
1404 int is_irn_machine_operand(const ir_node *node);
1407 * Returns non-zero for nodes that have the n'th user machine flag set.
1409 int is_irn_machine_user(const ir_node *node, unsigned n);
1412 * A type to express conditional jump predictions.
1415 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1416 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1417 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1418 } cond_jmp_predicate;
1420 /** Gets the string representation of the jump prediction .*/
1421 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1423 /** Returns the conditional jump prediction of a Cond node. */
1424 cond_jmp_predicate get_Cond_jmp_pred(const ir_node *cond);
1426 /** Sets a new conditional jump prediction. */
1427 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1429 /** Checks whether a node represents a global address. */
1430 int is_Global(const ir_node *node);
1432 /* Returns the entity of a global address. */
1433 ir_entity *get_Global_entity(const ir_node *node);
1436 * Access custom node data.
1437 * The data must have been registered with
1438 * register_additional_node_data() before.
1439 * @param node The ir node to get the data from.
1440 * @param type The type of the data you registered.
1441 * @param off The value returned by register_additional_node_data().
1442 * @return A pointer of type @p type.
1444 #define get_irn_data(node,type,off) \
1445 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1448 * Get the pointer to the node some custom data belongs to.
1449 * @param data The pointer to the custom data.
1450 * @param off The number as returned by register_additional_node_data().
1451 * @return A pointer to the ir node the custom data belongs to.
1453 #define get_irn_data_base(data,off) \
1454 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1457 * Request additional data to be allocated with an ir node.
1458 * @param size The size of the additional data required.
1459 * @return A positive number, if the operation was successful, which
1460 * must be passed to the access macro get_irn_data(), 0 if the
1461 * registration failed.
1463 unsigned firm_register_additional_node_data(unsigned size);
1466 * Return a pointer to the node attributes.
1467 * Needed for user-defined nodes.
1469 void *get_irn_generic_attr(ir_node *node);
1470 const void *get_irn_generic_attr_const(const ir_node *node);
1473 * Returns the unique node index for the node in its graph.
1474 * This index is used to access phase information for this node.
1476 unsigned get_irn_idx(const ir_node *node);
1479 * Sets the debug information of a node.
1481 * @param n The node.
1482 * @param db The debug info.
1484 void set_irn_dbg_info(ir_node *n, dbg_info *db);
1487 * Returns the debug information of an node.
1489 * @param n The node.
1491 dbg_info *get_irn_dbg_info(const ir_node *n);
1493 /*-----------------------------------------------------------------*/
1495 /*-----------------------------------------------------------------*/
1498 /** Debug print the node.
1500 * Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
1501 * is set. Else does nothing. */
1502 void dump_irn(const ir_node *n);
1504 /*@}*/ /* end of ir_node group definition */