2 * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Representation of an intermediate operation.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
26 #ifndef FIRM_IR_IRNODE_H
27 #define FIRM_IR_IRNODE_H
31 #include "firm_common.h"
39 * @author Martin Trapp, Christian Schaefer
41 * Declarations of an ir node.
45 * @defgroup ir_node Declarations of an ir node.
47 * The type definition of ir_node is also in irgraph.h to resolve
48 * recursion between irnode.h and irgraph.h
50 * ir_node - a datatype representing a Firm node
52 * The common fields are:
54 * - firm_kind - A firm_kind tag containing k_type. This is useful
55 * for dynamically checking whether a node is a ir_node.
56 * - arity - The number of predecessors in the Firm graph.
57 * - in - A list with the predecessors in the Firm graph. There are
58 * routines to access individual elements and to obtain the
59 * array. The method returning the array should not be used.
60 * - mode - The mode of the node. There are routines to get the mode
61 * but also to access the mode's fields directly.
62 * - opcode - The opcode of the node. There are routines to get the opcode
63 * but also to access the opcode's fields directly.
64 * - node_nr - A unique number for the node. Available only if debugging
70 * 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 /* Sets the mode struct of node. */
178 void set_irn_mode(ir_node *node, ir_mode *mode);
179 /** Gets the mode struct of a node. */
180 ir_mode *get_irn_mode(const ir_node *node);
181 /** Gets the mode-enum modecode. */
182 modecode get_irn_modecode(const ir_node *node);
183 /** Gets the ident for a string representation of the mode .*/
184 ident *get_irn_modeident(const ir_node *node);
185 /** Gets the string representation of the mode .*/
186 const char *get_irn_modename(const ir_node *node);
187 /** Gets the opcode struct of the node. */
188 ir_op *get_irn_op(const ir_node *node);
189 /** Sets the opcode struct of the node. */
190 void set_irn_op(ir_node *node, ir_op *op);
191 /** Gets the opcode-enum of the node. */
192 unsigned get_irn_opcode(const ir_node *node);
193 /** Get the string representation of the opcode. */
194 const char *get_irn_opname(const ir_node *node);
195 /** Get the ident for a string representation of the opcode. */
196 ident *get_irn_opident(const ir_node *node);
197 /** If arg is an argument of the node, returns it's position, -1 otherwise */
198 int get_irn_pred_pos(ir_node *node, ir_node *arg);
199 /** Gets the visited counter of a node. */
200 unsigned long get_irn_visited(const ir_node *node);
201 /** Sets the visited counter of a node. */
202 void set_irn_visited(ir_node *node, unsigned long visited);
203 /** Sets visited to get_irg_visited(current_ir_graph). */
204 void mark_irn_visited(ir_node *node);
205 /** Returns 1 if visited < get_irg_visited(current_ir_graph). */
206 int irn_not_visited(const ir_node *node);
207 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
208 int irn_visited(const ir_node *node);
211 * Sets the link of a node.
212 * Only allowed if the graph is NOT in phase_building.
214 void set_irn_link(ir_node *node, void *link);
216 /** Returns the link of a node. */
217 void *get_irn_link(const ir_node *node);
219 /** Returns the ir_graph this node belongs to. */
220 ir_graph *get_irn_irg(const ir_node *node);
222 /** Outputs a unique number for this node if libFIRM is compiled for
223 debugging, (configure with --enable-debug) else returns address
224 of node cast to long. */
225 long get_irn_node_nr(const ir_node *node);
227 /** Returns the pinned state of a node.
229 * Returns whether the node _always_ must be pinned.
230 * I.e., the node is not floating after global cse.
232 * @returns Either state op_pin_state_pinned or op_pin_state_floats.
234 op_pin_state get_irn_pinned(const ir_node *node);
236 /** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
237 void set_irn_pinned(ir_node *node, op_pin_state state);
239 /** Returns whether the node is currently pinned.
241 * If get_irn_pinned returns op_pin_state_floats and the graph the
242 * node belongs to is in state op_poin_state_floats then this function
243 * returns 'floats', else 'pinned'.
245 op_pin_state is_irn_pinned_in_irg(const ir_node *node);
248 * IR node constructor.
249 * Create a new IR node in irg, with an op, mode, arity and
250 * some incoming IR nodes.
251 * This constructor is used in every specific IR node constructor.
253 * @param db Debug info.
254 * @param irg IR-graph on with this new node should be constructed.
255 * @param block The block the new node belongs to
256 * @param op The opcode of the new node.
257 * @param mode The mode of the new node.
258 * @param arity The arity of the new node, <0 if can be changed dynamically.
259 * @param in An array of arity predecessor nodes.
262 new_ir_node(dbg_info *db,
271 * Return the block the node belongs to. This is only
272 * possible for pinned nodes or if the graph is in pinned state.
273 * Otherwise the block may be incorrect. This condition is
274 * now checked by an assertion.
276 * This works for all except Block. It can return Blocks or the Bad node.
278 * To express the difference to access routines that work for all
279 * nodes we use infix "nodes" and do not name this function
280 * get_irn_block(). */
281 ir_node *get_nodes_block (const ir_node *node);
283 /** Sets the Block of a node. */
284 void set_nodes_block (ir_node *node, ir_node *block);
287 * Return the MacroBlock the node belongs to. This is only
288 * possible for pinned nodes or if the graph is in pinned state.
289 * Otherwise the MacroBlock may be incorrect. This condition is
290 * now checked by an assertion.
292 * This works for all except Block. It can return Blocks or the Bad node.
294 * To express the difference to access routines that work for all
295 * nodes we use infix "nodes" and do not name this function
296 * get_irn_MacroBlock(). */
297 ir_node *get_nodes_MacroBlock(const ir_node *node);
300 * @function get_irn_block()
301 * @see get_nodes_block()
305 * Projection numbers for result of Start node: use for Proj nodes!
308 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
309 pn_Start_M, /**< Projection on the initial memory. */
310 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
311 pn_Start_P_globals, /**< Projection on the pointer to the data segment
312 containing _all_ global entities. Use for
313 position independent data/code access. */
314 pn_Start_P_tls, /**< Projection on the pointer to the thread local store
315 segment containing _all_thread local variables. */
316 pn_Start_T_args, /**< Projection on all arguments. */
317 pn_Start_P_value_arg_base, /**< Pointer to region of compound value arguments as defined by
318 type of this method. */
319 pn_Start_max /**< number of projections from a Start */
320 } pn_Start; /* Projection numbers for Start. */
322 /** Test whether arbitrary node is frame pointer.
324 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
325 * from Start. If so returns frame type, else Null. */
326 ir_type *is_frame_pointer(ir_node *n);
328 /** Test whether arbitrary node is globals pointer.
330 * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
331 * from Start. If so returns global type, else Null. */
332 ir_type *is_globals_pointer(ir_node *n);
334 /** Test whether arbitrary node is tls pointer.
336 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
337 * from Start. If so returns tls type, else Null. */
338 ir_type *is_tls_pointer(ir_node *n);
340 /** Test whether arbitrary node is value arg base.
342 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
343 * from Start. If so returns 1, else 0. */
344 int is_value_arg_pointer(ir_node *n);
347 /* @@@ no more supported */
348 ir_node **get_Block_cfgpred_arr(ir_node *node);
349 int get_Block_n_cfgpreds(const ir_node *node);
350 ir_node *get_Block_cfgpred(const ir_node *node, int pos);
351 void set_Block_cfgpred(ir_node *node, int pos, ir_node *pred);
352 /** Get the predecessor block.
354 * Returns the block corresponding to the predecessor pos of block.
356 * There are several ambiguities we resolve with this function:
357 * - The direct predecessor can be a Proj, which is not pinned.
358 * We walk from the predecessor to the next pinned node
359 * (skip_Proj) and return the block that node is in.
360 * - If we encounter the Bad node, this function does not return
361 * Start, but the Bad node.
363 ir_node *get_Block_cfgpred_block(const ir_node *node, int pos);
364 int get_Block_matured(const ir_node *node);
365 void set_Block_matured(ir_node *node, int matured);
367 /** A visited flag only for block nodes.
368 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
369 unsigned long get_Block_block_visited(const ir_node *node);
370 void set_Block_block_visited(ir_node *node, unsigned long visit);
373 * Marks a block as dead but do not replace it with a Bad node.
374 * Dead blocks are removed in the con
376 ir_node *set_Block_dead(ir_node *block);
377 int is_Block_dead(const ir_node *block);
379 /* For this current_ir_graph must be set. */
380 void mark_Block_block_visited(ir_node *node);
381 int Block_not_block_visited(const ir_node *node);
382 int Block_block_visited(const ir_node *node);
384 #ifdef INTERPROCEDURAL_VIEW
385 /* Set and remove interprocedural predecessors. If the interprocedural
386 * predecessors are removed, the node has the same predecessors in
388 * @@@ Maybe better: arity is zero if no cg preds. */
389 void set_Block_cg_cfgpred_arr(ir_node *node, int arity, ir_node *in[]);
390 void set_Block_cg_cfgpred(ir_node *node, int pos, ir_node *pred);
391 /* @@@ not supported */
392 ir_node **get_Block_cg_cfgpred_arr(ir_node *node);
393 /** Returns the number of interprocedural predecessors. 0 if none. */
394 int get_Block_cg_n_cfgpreds(ir_node *node);
395 /** Return the interprocedural predecessor at position pos. */
396 ir_node *get_Block_cg_cfgpred(ir_node *node, int pos);
397 /** Frees the memory allocated for interprocedural predecessors. */
398 void remove_Block_cg_cfgpred_arr(ir_node *node);
401 /** Returns the extended basic block a block belongs to. */
402 ir_extblk *get_Block_extbb(const ir_node *block);
403 /** Sets the extended basic block a block belongs to. */
404 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
405 /** Get the Macro Block header of a (sub-) block. */
406 ir_node *get_Block_MacroBlock(const ir_node *block);
407 /** Returns the ir_graph this Block belongs to. */
408 ir_graph *get_Block_irg(const ir_node *block);
409 /** Returns non-zero if the block has an assigned label. */
410 int has_Block_label(const ir_node *block);
411 /** Returns the label of a Block. */
412 ir_label_t get_Block_label(const ir_node *block);
413 /** Sets a label to a block. */
414 void set_Block_label(ir_node *block, ir_label_t label);
416 /** Return the number of Keep alive node. */
417 int get_End_n_keepalives(ir_node *end);
418 /** Return the Keep alive node a position pos. */
419 ir_node *get_End_keepalive(ir_node *end, int pos);
420 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
421 void add_End_keepalive(ir_node *end, ir_node *ka);
422 /** Set the Keep alive node at position pos. */
423 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
424 /** Set new keep-alives. */
425 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
426 /** Set new keep-alives from old keep-alives, skipping irn. */
427 void remove_End_keepalive(ir_node *end, ir_node *irn);
429 /** Some parts of the End node are allocated separately -- their memory
430 is not recovered by dead_node_elimination if a End node is dead.
431 free_End() frees these data structures. */
432 void free_End(ir_node *end);
434 /** Return the target address of an IJmp */
435 ir_node *get_IJmp_target(ir_node *ijmp);
436 /** Sets the target address of an IJmp */
437 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
439 /* We distinguish three kinds of Cond nodes. These can be distinguished
440 by the mode of the selector operand and an internal flag of type cond_kind.
441 First we distinguish binary Conds and switch Conds.
442 A binary Cond has as selector a boolean value. Proj(0) projects the control
443 flow for case "False", Proj(1) the control flow for "True". A binary Cond
444 is recognized by the boolean selector.
445 The switch Cond has as selector an unsigned integer. It produces as result
446 an n+1 Tuple (cf0, ... , cfn) of control flows.
447 We differ two flavors of this Cond. The first, the dense Cond, passes
448 control along output i if the selector value is i, 0 <= i <= n. If the
449 selector value is >n it passes control along output n.
450 The second Cond flavor differences in the treatment of cases not specified in
451 the source program. It magically knows about the existence of Proj nodes.
452 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
453 exists. Else it passes control along output n (even if this Proj does not
454 exist.) This Cond we call "fragmentary". There is a special constructor
455 new_defaultProj that automatically sets the flavor.
456 The two switch flavors are distinguished by a flag of type cond_kind.
457 Default flavor is "dense"
460 dense, /**< Default. Missing Proj nodes are dead control flow. */
461 fragmentary /**< Special. No control flow optimizations allowed. Missing
462 Proj nodes mean default control flow, i.e., Proj(n). */
465 ir_node *get_Cond_selector(ir_node *node);
466 void set_Cond_selector(ir_node *node, ir_node *selector);
467 cond_kind get_Cond_kind(ir_node *node);
468 void set_Cond_kind(ir_node *node, cond_kind kind);
469 long get_Cond_defaultProj(ir_node *node);
472 * Projection numbers for conditions.
475 pn_Cond_false, /**< Control flow if operand is "false". */
476 pn_Cond_true, /**< Control flow if operand is "true". */
477 pn_Cond_max /**< number of projections from a Cond */
478 } pn_Cond; /* Projection numbers for Cond. */
480 ir_node *get_Return_mem(ir_node *node);
481 void set_Return_mem(ir_node *node, ir_node *mem);
482 ir_node **get_Return_res_arr(ir_node *node);
483 int get_Return_n_ress(ir_node *node);
484 ir_node *get_Return_res(ir_node *node, int pos);
485 void set_Return_res(ir_node *node, int pos, ir_node *res);
487 tarval *get_Const_tarval(const ir_node *node);
488 void set_Const_tarval(ir_node *node, tarval *con);
490 /** Return non-zero if the given Const node represents the 0 constant. */
491 int is_Const_null(const ir_node *node);
493 /** Return non-zero if the given Const node represents the 1 constant. */
494 int is_Const_one(const ir_node *node);
496 /** Return non-zero if the given Const node represents the constant with all bits set. */
497 int is_Const_all_one(const ir_node *node);
499 /** Returns the source language type of a Const node.
500 * Must be an atomic type. Mode of type must be mode of node.
502 ir_type *get_Const_type(ir_node *node);
504 /** Sets the source language type of a Const node. */
505 void set_Const_type(ir_node *node, ir_type *tp);
507 /** This enum names the three different kinds of symbolic Constants
508 represented by SymConst. The content of the attribute type_or_id
509 depends on this tag. Use the proper access routine after testing
512 symconst_type_tag, /**< The SymConst is a type tag for the given type.
513 symconst_symbol is type *. */
514 symconst_type_size, /**< The SymConst is the size of the given type.
515 symconst_symbol is type *. */
516 symconst_type_align, /**< The SymConst is the alignment of the given type.
517 symconst_symbol is type *. */
518 symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
519 by the linker. The pointer is represented by a string.
520 symconst_symbol is ident *. */
521 symconst_addr_ent, /**< The SymConst is a symbolic pointer to be filled in
522 by the linker. The pointer is represented by an entity.
523 symconst_symbol is entity *. */
524 symconst_ofs_ent, /**< The SymConst is the offset of its entity in the entities
526 symconst_enum_const, /**< The SymConst is a enumeration constant of an
528 symconst_label /**< The SymConst is a label address. */
531 /** Returns non-zero if s symconst kind has a type attribute */
532 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
534 /** Returns non-zero if s symconst kind has an ident attribute */
535 #define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)
537 /** Returns non-zero if s symconst kind has an entity attribute */
538 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
540 /** Returns non-zero if s symconst kind has an enum_const attribute */
541 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
543 /** Returns non-zero if s symconst kind has a label attribute */
544 #define SYMCONST_HAS_LABEL(kind) ((kind) == symconst_label)
546 /** SymConst attribute.
548 * This union contains the symbolic information represented by the node.
550 typedef union symconst_symbol {
551 ir_type *type_p; /**< The type of a SymConst. */
552 ident *ident_p; /**< The ident of a SymConst. */
553 ir_entity *entity_p; /**< The entity of a SymConst. */
554 ir_enum_const *enum_p; /**< The enumeration constant of a SymConst. */
555 ir_label_t label; /**< The label of a SymConst. */
558 /** Get the kind of the SymConst. */
559 symconst_kind get_SymConst_kind(const ir_node *node);
560 /** Set the kind of the SymConst. */
561 void set_SymConst_kind(ir_node *node, symconst_kind num);
563 /** Only to access SymConst of kind type_tag or size. Else assertion: */
564 ir_type *get_SymConst_type(ir_node *node);
565 void set_SymConst_type(ir_node *node, ir_type *tp);
567 /** Only to access SymConst of kind addr_name. Else assertion: */
568 ident *get_SymConst_name(const ir_node *node);
569 void set_SymConst_name(ir_node *node, ident *name);
571 /** Only to access SymConst of kind addr_ent. Else assertion: */
572 ir_entity *get_SymConst_entity(const ir_node *node);
573 void set_SymConst_entity(ir_node *node, ir_entity *ent);
575 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
576 ir_enum_const *get_SymConst_enum(const ir_node *node);
577 void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
579 /** Sets both: type and ptrinfo. Needed to treat the node independent of
580 its semantics. Does a memcpy for the memory sym points to. */
581 /* write 'union': firmjni then does not create a method... */
582 union symconst_symbol get_SymConst_symbol(const ir_node *node);
583 void set_SymConst_symbol(ir_node *node,
584 union symconst_symbol sym);
586 /** Only to access SymConst of kind symconst_label. Else assertion: */
587 ir_label_t get_SymConst_label(const ir_node *node);
588 void set_SymConst_label(ir_node *node, ir_label_t label);
591 /** Access the type of the value represented by the SymConst.
593 * Example: primitive type int for SymConst size. */
594 ir_type *get_SymConst_value_type(ir_node *node);
595 void set_SymConst_value_type(ir_node *node, ir_type *tp);
597 ir_node *get_Sel_mem(ir_node *node);
598 void set_Sel_mem(ir_node *node, ir_node *mem);
599 ir_node *get_Sel_ptr(ir_node *node); /* ptr to the object to select from */
600 void set_Sel_ptr(ir_node *node, ir_node *ptr);
601 ir_node **get_Sel_index_arr(ir_node *node);
602 int get_Sel_n_indexs(ir_node *node);
603 ir_node *get_Sel_index(ir_node *node, int pos);
604 void set_Sel_index(ir_node *node, int pos, ir_node *index);
605 ir_entity *get_Sel_entity(ir_node *node); /* entity to select */
606 void set_Sel_entity (ir_node *node, ir_entity *ent);
609 * Projection numbers for result of Call node: use for Proj nodes!
612 pn_Call_M_regular = pn_Generic_M_regular, /**< The memory result. */
613 pn_Call_X_regular = pn_Generic_X_regular, /**< The control flow result when no exception occurs. */
614 pn_Call_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler. */
615 pn_Call_T_result = pn_Generic_other, /**< The tuple containing all (0, 1, 2, ...) results. */
616 pn_Call_M_except, /**< The memory result in case the called method terminated with
618 pn_Call_P_value_res_base, /**< A pointer to the memory region containing copied results
619 passed by value (for compound result types). */
620 pn_Call_max /**< number of projections from a Call */
621 } pn_Call; /* Projection numbers for Call. */
622 #define pn_Call_M pn_Call_M_regular
624 ir_node *get_Call_mem(ir_node *node);
625 void set_Call_mem(ir_node *node, ir_node *mem);
626 ir_node *get_Call_ptr(ir_node *node);
627 void set_Call_ptr(ir_node *node, ir_node *ptr);
628 ir_node **get_Call_param_arr(ir_node *node);
629 /** Gets the number of parameters of a call. */
630 int get_Call_n_params(ir_node *node);
631 /** Gets the call parameter at position pos. */
632 ir_node *get_Call_param(ir_node *node, int pos);
633 /** Sets the call parameter at position pos. */
634 void set_Call_param(ir_node *node, int pos, ir_node *param);
635 /** Gets the type of a call. */
636 ir_type *get_Call_type(ir_node *node);
637 /** Sets the type of a call. */
638 void set_Call_type(ir_node *node, ir_type *tp);
639 /** Gets the arity of a call. Identical to get_Call_n_params(). */
640 int get_Call_arity(ir_node *node);
642 /** Set, get and remove the callee information for a Call node.
644 * The callee information lists all method entities that can be called
645 * from this node. If the address expression can not be analyzed fully,
646 * e.g., as entities can be called that are not in the compilation unit,
647 * the array contains the unknown_entity. The array contains only entities
648 * with peculiarity_existent, but with all kinds of visibility. The entities
649 * not necessarily contain an irg.
651 * The array is only accessible if callee information is valid. See flag
654 * The memory allocated for the array is managed automatically, i.e., it must
655 * not be freed if the Call node is removed from the graph.
657 * @param node A Call node.
659 int Call_has_callees(ir_node *node);
660 int get_Call_n_callees(ir_node *node);
661 ir_entity *get_Call_callee(ir_node *node, int pos);
663 /** Set the full callee array.
665 * The passed array is copied. Assumes current_ir_graph set properly! */
666 void set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
667 void remove_Call_callee_arr(ir_node *node);
669 ir_node *get_CallBegin_ptr(ir_node *node);
670 void set_CallBegin_ptr(ir_node *node, ir_node *ptr);
671 ir_node *get_CallBegin_call(ir_node *node);
672 void set_CallBegin_call(ir_node *node, ir_node *call);
674 /* For unary and binary arithmetic operations the access to the
675 operands can be factored out. Left is the first, right the
676 second arithmetic value as listed in tech report 1999-44.
677 unops are: Minus, Abs, Not, Conv, Cast
678 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
679 Shr, Shrs, Rot, Cmp */
680 int is_unop(const ir_node *node);
681 ir_node *get_unop_op(const ir_node *node);
682 void set_unop_op(ir_node *node, ir_node *op);
683 int is_binop(const ir_node *node);
684 ir_node *get_binop_left(const ir_node *node);
685 void set_binop_left(ir_node *node, ir_node *left);
686 ir_node *get_binop_right(const ir_node *node);
687 void set_binop_right(ir_node *node, ir_node *right);
689 ir_node *get_Add_left(const ir_node *node);
690 void set_Add_left(ir_node *node, ir_node *left);
691 ir_node *get_Add_right(const ir_node *node);
692 void set_Add_right(ir_node *node, ir_node *right);
694 ir_node *get_Sub_left(const ir_node *node);
695 void set_Sub_left(ir_node *node, ir_node *left);
696 ir_node *get_Sub_right(const ir_node *node);
697 void set_Sub_right(ir_node *node, ir_node *right);
699 ir_node *get_Minus_op(const ir_node *node);
700 void set_Minus_op(ir_node *node, ir_node *op);
702 ir_node *get_Mul_left(const ir_node *node);
703 void set_Mul_left(ir_node *node, ir_node *left);
704 ir_node *get_Mul_right(const ir_node *node);
705 void set_Mul_right(ir_node *node, ir_node *right);
707 ir_node *get_Mulh_left(const ir_node *node);
708 void set_Mulh_left(ir_node *node, ir_node *left);
709 ir_node *get_Mulh_right(const ir_node *node);
710 void set_Mulh_right(ir_node *node, ir_node *right);
712 ir_node *get_Quot_left(const ir_node *node);
713 void set_Quot_left(ir_node *node, ir_node *left);
714 ir_node *get_Quot_right(const ir_node *node);
715 void set_Quot_right(ir_node *node, ir_node *right);
716 ir_node *get_Quot_mem(ir_node *node);
717 void set_Quot_mem(ir_node *node, ir_node *mem);
718 ir_mode *get_Quot_resmode(const ir_node *node);
719 void set_Quot_resmode(ir_node *node, ir_mode *mode);
722 * Projection numbers for Quot: use for Proj nodes!
725 pn_Quot_M = pn_Generic_M_regular, /**< Memory result. */
726 pn_Quot_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
727 pn_Quot_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
728 pn_Quot_res = pn_Generic_other, /**< Result of computation. */
729 pn_Quot_max /**< number of projections from a Quot */
730 } pn_Quot; /* Projection numbers for Quot. */
732 ir_node *get_DivMod_left(const ir_node *node);
733 void set_DivMod_left(ir_node *node, ir_node *left);
734 ir_node *get_DivMod_right(const ir_node *node);
735 void set_DivMod_right(ir_node *node, ir_node *right);
736 ir_node *get_DivMod_mem(ir_node *node);
737 void set_DivMod_mem(ir_node *node, ir_node *mem);
738 ir_mode *get_DivMod_resmode(const ir_node *node);
739 void set_DivMod_resmode(ir_node *node, ir_mode *mode);
742 * Projection numbers for DivMod: use for Proj nodes!
745 pn_DivMod_M = pn_Generic_M_regular, /**< Memory result. */
746 pn_DivMod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
747 pn_DivMod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
748 pn_DivMod_res_div = pn_Generic_other, /**< Result of computation a / b. */
749 pn_DivMod_res_mod, /**< Result of computation a % b. */
750 pn_DivMod_max /**< number of projections from a DivMod */
751 } pn_DivMod; /* Projection numbers for DivMod. */
753 ir_node *get_Div_left(const ir_node *node);
754 void set_Div_left(ir_node *node, ir_node *left);
755 ir_node *get_Div_right(const ir_node *node);
756 void set_Div_right(ir_node *node, ir_node *right);
757 ir_node *get_Div_mem(ir_node *node);
758 void set_Div_mem(ir_node *node, ir_node *mem);
759 ir_mode *get_Div_resmode(const ir_node *node);
760 void set_Div_resmode(ir_node *node, ir_mode *mode);
763 * Projection numbers for Div: use for Proj nodes!
766 pn_Div_M = pn_Generic_M_regular, /**< Memory result. */
767 pn_Div_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
768 pn_Div_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
769 pn_Div_res = pn_Generic_other, /**< Result of computation. */
770 pn_Div_max /**< number of projections from a Div */
771 } pn_Div; /* Projection numbers for Div. */
773 ir_node *get_Mod_left(const ir_node *node);
774 void set_Mod_left(ir_node *node, ir_node *left);
775 ir_node *get_Mod_right(const ir_node *node);
776 void set_Mod_right(ir_node *node, ir_node *right);
777 ir_node *get_Mod_mem(ir_node *node);
778 void set_Mod_mem(ir_node *node, ir_node *mem);
779 ir_mode *get_Mod_resmode(const ir_node *node);
780 void set_Mod_resmode(ir_node *node, ir_mode *mode);
783 * Projection numbers for Mod: use for Proj nodes!
786 pn_Mod_M = pn_Generic_M_regular, /**< Memory result. */
787 pn_Mod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
788 pn_Mod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
789 pn_Mod_res = pn_Generic_other, /**< Result of computation. */
790 pn_Mod_max /**< number of projections from a Mod */
791 } pn_Mod; /* Projection numbers for Mod. */
793 ir_node *get_Abs_op(const ir_node *node);
794 void set_Abs_op(ir_node *node, ir_node *op);
796 ir_node *get_And_left(const ir_node *node);
797 void set_And_left(ir_node *node, ir_node *left);
798 ir_node *get_And_right(const ir_node *node);
799 void set_And_right(ir_node *node, ir_node *right);
801 ir_node *get_Or_left(const ir_node *node);
802 void set_Or_left(ir_node *node, ir_node *left);
803 ir_node *get_Or_right(const ir_node *node);
804 void set_Or_right(ir_node *node, ir_node *right);
806 ir_node *get_Eor_left(const ir_node *node);
807 void set_Eor_left(ir_node *node, ir_node *left);
808 ir_node *get_Eor_right(const ir_node *node);
809 void set_Eor_right(ir_node *node, ir_node *right);
811 ir_node *get_Not_op(const ir_node *node);
812 void set_Not_op(ir_node *node, ir_node *op);
815 * Projection numbers for Cmp are defined several times.
816 * The bit patterns are used for various tests, so don't change.
817 * The "unordered" values are possible results of comparing
818 * floating point numbers.
819 * Note that the encoding is imported, so do NOT change the order.
822 pn_Cmp_False = 0, /**< false */
823 pn_Cmp_Eq = 1, /**< equal */
824 pn_Cmp_Lt = 2, /**< less */
825 pn_Cmp_Le = pn_Cmp_Eq|pn_Cmp_Lt, /**< less or equal */
826 pn_Cmp_Gt = 4, /**< greater */
827 pn_Cmp_Ge = pn_Cmp_Eq|pn_Cmp_Gt, /**< greater or equal */
828 pn_Cmp_Lg = pn_Cmp_Lt|pn_Cmp_Gt, /**< less or greater */
829 pn_Cmp_Leg = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
830 pn_Cmp_Uo = 8, /**< unordered */
831 pn_Cmp_Ue = pn_Cmp_Uo|pn_Cmp_Eq, /**< unordered or equal */
832 pn_Cmp_Ul = pn_Cmp_Uo|pn_Cmp_Lt, /**< unordered or less */
833 pn_Cmp_Ule = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
834 pn_Cmp_Ug = pn_Cmp_Uo|pn_Cmp_Gt, /**< unordered or greater */
835 pn_Cmp_Uge = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
836 pn_Cmp_Ne = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
837 pn_Cmp_True = 15 /**< true */
838 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for JNI interface */
839 } pn_Cmp; /* Projection numbers for Cmp */
840 /* #define not_mask pn_Cmp_Leg */
842 /** returns the pnc name from an pnc constant */
843 const char *get_pnc_string(int pnc);
845 /** Calculates the negated (Complement(R)) pnc condition. */
846 pn_Cmp get_negated_pnc(long pnc, ir_mode *mode);
848 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
849 pn_Cmp get_inversed_pnc(long pnc);
851 /** An alternative name for get_inversed_pnc() that can be better memorized. */
852 #define get_mirrored_pnc(pnc) get_inversed_pnc(pnc)
854 ir_node *get_Cmp_left(const ir_node *node);
855 void set_Cmp_left(ir_node *node, ir_node *left);
856 ir_node *get_Cmp_right(const ir_node *node);
857 void set_Cmp_right(ir_node *node, ir_node *right);
859 ir_node *get_Shl_left(const ir_node *node);
860 void set_Shl_left(ir_node *node, ir_node *left);
861 ir_node *get_Shl_right(const ir_node *node);
862 void set_Shl_right(ir_node *node, ir_node *right);
864 ir_node *get_Shr_left(const ir_node *node);
865 void set_Shr_left(ir_node *node, ir_node *left);
866 ir_node *get_Shr_right(const ir_node *node);
867 void set_Shr_right(ir_node *node, ir_node *right);
869 ir_node *get_Shrs_left(const ir_node *node);
870 void set_Shrs_left(ir_node *node, ir_node *left);
871 ir_node *get_Shrs_right(const ir_node *node);
872 void set_Shrs_right(ir_node *node, ir_node *right);
874 ir_node *get_Rot_left(const ir_node *node);
875 void set_Rot_left(ir_node *node, ir_node *left);
876 ir_node *get_Rot_right(const ir_node *node);
877 void set_Rot_right(ir_node *node, ir_node *right);
879 ir_node *get_Conv_op(const ir_node *node);
880 void set_Conv_op(ir_node *node, ir_node *op);
881 int get_Conv_strict(const ir_node *node);
882 void set_Conv_strict(ir_node *node, int flag);
884 /* Does Cast need a mem operator?
885 * Cast should only depend on the type, not on the state of an
886 * entity. But: we initialize various fields after Alloc, that
887 * are accessed in the cast. This required some precaution, to
888 * get the right memory into the Loads generated from the cast.
890 ir_node *get_Cast_op(const ir_node *node);
891 void set_Cast_op(ir_node *node, ir_node *op);
892 ir_type *get_Cast_type(ir_node *node);
893 void set_Cast_type(ir_node *node, ir_type *to_tp);
895 /** Checks for upcast.
897 * Returns true if the Cast node casts a class type to a super type.
898 * Works also for pointers to classes (recursively).
900 * Needs typeinfo calculated.
902 int is_Cast_upcast(ir_node *node);
904 /** Checks for downcast.
906 * Returns true if the Cast node casts a class type to a sub type.
907 * Works also for pointers to classes (recursively).
909 * Needs typeinfo calculated.
911 int is_Cast_downcast(ir_node *node);
914 /** Returns true if n is Phi or Filter in interprocedural_view.
915 Returns false if irg in phase building and the Phi has zero
916 predecessors: it's a Phi0. */
917 int is_Phi(const ir_node *n);
918 /** Returns true if irg in phase building and the Phi has zero
919 predecessors. It's a Phi0 then. */
920 int is_Phi0(const ir_node *n);
921 /* These routines also work for Filter nodes in interprocedural view. */
922 ir_node **get_Phi_preds_arr(ir_node *node);
923 int get_Phi_n_preds(const ir_node *node);
924 ir_node *get_Phi_pred(const ir_node *node, int pos);
925 void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
927 ir_node *get_Filter_pred(ir_node *node);
928 void set_Filter_pred(ir_node *node, ir_node *pred);
929 long get_Filter_proj(ir_node *node);
930 void set_Filter_proj(ir_node *node, long proj);
931 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
932 * @@@ Maybe better: arity is zero if no cg preds. */
933 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
934 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
935 int get_Filter_n_cg_preds(ir_node *node);
936 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
938 /** Return true if parameter is a memory operation.
940 * A memory operation is an operation that changes the
941 * memory. I.e., a Load or a Store operation.
943 int is_memop(ir_node *node);
944 ir_node *get_memop_mem(ir_node *node);
945 void set_memop_mem(ir_node *node, ir_node *mem);
946 ir_node *get_memop_ptr(ir_node *node);
947 void set_memop_ptr(ir_node *node, ir_node *ptr);
950 * Projection numbers for Load: use for Proj nodes!
953 pn_Load_M = pn_Generic_M_regular, /**< Memory result. */
954 pn_Load_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
955 pn_Load_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
956 pn_Load_res = pn_Generic_other, /**< Result of load operation. */
957 pn_Load_max /**< number of projections from a Load */
958 } pn_Load; /* Projection numbers for Load. */
960 ir_node *get_Load_mem(ir_node *node);
961 void set_Load_mem(ir_node *node, ir_node *mem);
962 ir_node *get_Load_ptr(ir_node *node);
963 void set_Load_ptr(ir_node *node, ir_node *ptr);
964 ir_mode *get_Load_mode(ir_node *node);
965 void set_Load_mode(ir_node *node, ir_mode *mode);
966 ir_volatility get_Load_volatility(ir_node *node);
967 void set_Load_volatility(ir_node *node, ir_volatility volatility);
968 ir_align get_Load_align(ir_node *node);
969 void set_Load_align(ir_node *node, ir_align align);
972 * Projection numbers for Store: use for Proj nodes!
975 pn_Store_M = pn_Generic_M_regular, /**< Memory result. */
976 pn_Store_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
977 pn_Store_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
978 pn_Store_max = pn_Generic_other /**< number of projections from a Store */
979 } pn_Store; /* Projection numbers for Store. */
981 ir_node *get_Store_mem(ir_node *node);
982 void set_Store_mem(ir_node *node, ir_node *mem);
983 ir_node *get_Store_ptr(ir_node *node);
984 void set_Store_ptr(ir_node *node, ir_node *ptr);
985 ir_node *get_Store_value(ir_node *node);
986 void set_Store_value(ir_node *node, ir_node *value);
987 ir_volatility get_Store_volatility(ir_node *node);
988 void set_Store_volatility(ir_node *node, ir_volatility volatility);
989 ir_align get_Store_align(ir_node *node);
990 void set_Store_align(ir_node *node, ir_align align);
993 * Projection numbers for Alloc: use for Proj nodes!
996 pn_Alloc_M = pn_Generic_M_regular, /**< Memory result. */
997 pn_Alloc_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
998 pn_Alloc_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
999 pn_Alloc_res = pn_Generic_other, /**< Result of allocation. */
1000 pn_Alloc_max /**< number of projections from an Alloc */
1001 } pn_Alloc; /* Projection numbers for Alloc. */
1003 ir_node *get_Alloc_mem(ir_node *node);
1004 void set_Alloc_mem(ir_node *node, ir_node *mem);
1005 ir_node *get_Alloc_size(ir_node *node);
1006 void set_Alloc_size(ir_node *node, ir_node *size);
1007 ir_type *get_Alloc_type(ir_node *node);
1008 void set_Alloc_type(ir_node *node, ir_type *tp);
1010 /** The allocation place. */
1012 stack_alloc, /**< Alloc allocates the object on the stack. */
1013 heap_alloc /**< Alloc allocates the object on the heap. */
1016 ir_where_alloc get_Alloc_where(ir_node *node);
1017 void set_Alloc_where(ir_node *node, ir_where_alloc where);
1019 ir_node *get_Free_mem(ir_node *node);
1020 void set_Free_mem(ir_node *node, ir_node *mem);
1021 ir_node *get_Free_ptr(ir_node *node);
1022 void set_Free_ptr(ir_node *node, ir_node *ptr);
1023 ir_node *get_Free_size(ir_node *node);
1024 void set_Free_size(ir_node *node, ir_node *size);
1025 ir_type *get_Free_type(ir_node *node);
1026 void set_Free_type(ir_node *node, ir_type *tp);
1028 ir_where_alloc get_Free_where(ir_node *node);
1029 void set_Free_where(ir_node *node, ir_where_alloc where);
1031 ir_node **get_Sync_preds_arr(ir_node *node);
1032 int get_Sync_n_preds(ir_node *node);
1033 ir_node *get_Sync_pred(ir_node *node, int pos);
1034 void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
1035 void add_Sync_pred(ir_node *node, ir_node *pred);
1037 /** Returns the source language type of a Proj node.
1038 * Must be an atomic type. Mode of type must be mode of node.
1040 ir_type *get_Proj_type(ir_node *node);
1042 /** Return the predecessor of a Proj node. */
1043 ir_node *get_Proj_pred(const ir_node *node);
1044 void set_Proj_pred(ir_node *node, ir_node *pred);
1045 /** Return the projection number of a Proj node. */
1046 long get_Proj_proj(const ir_node *node);
1047 void set_Proj_proj(ir_node *node, long proj);
1049 ir_node **get_Tuple_preds_arr(ir_node *node);
1050 int get_Tuple_n_preds(ir_node *node);
1051 ir_node *get_Tuple_pred(ir_node *node, int pos);
1052 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
1054 ir_node *get_Id_pred(ir_node *node);
1055 void set_Id_pred(ir_node *node, ir_node *pred);
1057 /** Confirm has a single result and returns 'value' unchanged.
1058 * The node expresses a restriction on 'value':
1059 * 'value' 'cmp' 'bound' == true. */
1060 ir_node *get_Confirm_value(ir_node *node);
1061 void set_Confirm_value(ir_node *node, ir_node *value);
1062 ir_node *get_Confirm_bound(ir_node *node);
1063 void set_Confirm_bound(ir_node *node, ir_node *bound);
1064 pn_Cmp get_Confirm_cmp(const ir_node *node);
1065 void set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
1068 * Mux Support: Note that Psi nodes with one condition can be handled
1069 * like Mux nodes, and the access functions work as expected.
1071 ir_node *get_Mux_sel(ir_node *node);
1072 void set_Mux_sel(ir_node *node, ir_node *sel);
1073 ir_node *get_Mux_false(ir_node *node);
1074 void set_Mux_false(ir_node *node, ir_node *ir_false);
1075 ir_node *get_Mux_true (ir_node *node);
1076 void set_Mux_true (ir_node *node, ir_node *ir_true);
1078 ir_node *get_Psi_cond(ir_node *node, int pos);
1079 void set_Psi_cond(ir_node *node, int pos, ir_node *cond);
1080 ir_node *get_Psi_val(ir_node *node, int pos);
1081 void set_Psi_val(ir_node *node, int pos, ir_node *val);
1082 ir_node *get_Psi_default(ir_node *node);
1083 void set_Psi_default(ir_node *node, ir_node *val);
1084 int get_Psi_n_conds(ir_node *node);
1087 * Projection numbers for result of CopyB node: use for Proj nodes!
1090 pn_CopyB_M_regular = pn_Generic_M_regular, /**< The memory result. */
1091 pn_CopyB_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1092 pn_CopyB_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1093 pn_CopyB_M_except = pn_Generic_other, /**< The memory result in case the runtime function terminated with
1095 pn_CopyB_max /**< number of projections from a CopyB */
1096 } pn_CopyB; /* Projection numbers for CopyB. */
1097 #define pn_CopyB_M pn_CopyB_M_regular
1099 ir_node *get_CopyB_mem(ir_node *node);
1100 void set_CopyB_mem(ir_node *node, ir_node *mem);
1101 ir_node *get_CopyB_dst(ir_node *node);
1102 void set_CopyB_dst(ir_node *node, ir_node *dst);
1103 ir_node *get_CopyB_src(ir_node *node);
1104 void set_CopyB_src(ir_node *node, ir_node *src);
1105 ir_type *get_CopyB_type(ir_node *node);
1106 void set_CopyB_type(ir_node *node, ir_type *data_type);
1109 * Projection numbers for result of InstOf node: use for Proj nodes!
1112 pn_InstOf_M_regular = pn_Generic_M_regular, /**< The memory result. */
1113 pn_InstOf_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1114 pn_InstOf_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1115 pn_InstOf_res = pn_Generic_other, /**< The checked object pointer. */
1116 pn_InstOf_M_except, /**< The memory result in case the runtime function terminated with
1118 pn_InstOf_max /**< number of projections from an InstOf */
1120 #define pn_InstOf_M pn_InstOf_M_regular
1122 /** InstOf access */
1123 ir_type *get_InstOf_type(ir_node *node);
1124 void set_InstOf_type(ir_node *node, ir_type *type);
1125 ir_node *get_InstOf_store(ir_node *node);
1126 void set_InstOf_store(ir_node *node, ir_node *obj);
1127 ir_node *get_InstOf_obj(ir_node *node);
1128 void set_InstOf_obj(ir_node *node, ir_node *obj);
1131 * Projection numbers for Raise.
1134 pn_Raise_X = 0, /**< The control flow to the exception handler. */
1135 pn_Raise_M = 1, /**< The Memory result. */
1136 pn_Raise_max /**< number of projections from a Raise */
1137 } pn_Raise; /* Projection numbers for Raise. */
1139 ir_node *get_Raise_mem(ir_node *node);
1140 void set_Raise_mem(ir_node *node, ir_node *mem);
1141 ir_node *get_Raise_exo_ptr(ir_node *node); /* PoinTeR to EXception Object */
1142 void set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
1145 * Projection numbers for result of Bound node: use for Proj nodes!
1148 pn_Bound_M = pn_Generic_M_regular, /**< The memory result. */
1149 pn_Bound_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1150 pn_Bound_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1151 pn_Bound_res = pn_Generic_other, /**< The checked index. */
1152 pn_Bound_max /**< number of projections from a Bound */
1155 /** Returns the memory input of a Bound operation. */
1156 ir_node *get_Bound_mem(ir_node *bound);
1157 void set_Bound_mem(ir_node *bound, ir_node *mem);
1159 /** Returns the index input of a Bound operation. */
1160 ir_node *get_Bound_index(ir_node *bound);
1161 void set_Bound_index(ir_node *bound, ir_node *idx);
1163 /** Returns the lower bound input of a Bound operation. */
1164 ir_node *get_Bound_lower(ir_node *bound);
1165 void set_Bound_lower(ir_node *bound, ir_node *lower);
1167 /** Returns the upper bound input of a Bound operation. */
1168 ir_node *get_Bound_upper(ir_node *bound);
1169 void set_Bound_upper(ir_node *bound, ir_node *upper);
1171 /** Return the operand of a Pin node. */
1172 ir_node *get_Pin_op(const ir_node *pin);
1173 void set_Pin_op(ir_node *pin, ir_node *node);
1175 /** A input/output constraint attribute */
1177 unsigned pos; /**< The inputs/output position for this constraint. */
1178 ident *constraint; /**< The constraint for this input/output. */
1179 ir_mode *mode; /**< The mode of the constraint. */
1180 } ir_asm_constraint;
1182 /** Return the assembler text of an ASM pseudo node. */
1183 ident *get_ASM_text(const ir_node *node);
1184 /** Return the number of input constraints for an ASM node. */
1185 int get_ASM_n_input_constraints(const ir_node *node);
1186 /** Return the input constraints for an ASM node. */
1187 const ir_asm_constraint *get_ASM_input_constraints(const ir_node *node);
1188 /** Return the number of output constraints for an ASM node. */
1189 int get_ASM_n_output_constraints(const ir_node *node);
1190 /** Return the output constraints for an ASM node. */
1191 const ir_asm_constraint *get_ASM_output_constraints(const ir_node *node);
1192 /** Return the number of clobbered registers for an ASM node. */
1193 int get_ASM_n_clobbers(const ir_node *node);
1194 /** Return the list of clobbered registers for an ASM node. */
1195 ident **get_ASM_clobbers(const ir_node *node);
1199 * NAME Auxiliary routines
1203 /** Returns operand of node if node is a Proj. */
1204 ir_node *skip_Proj(ir_node *node);
1205 /** Returns operand of node if node is a Proj. */
1206 const ir_node *skip_Proj_const(const ir_node *node);
1207 /** Returns operand of node if node is a Id. */
1208 ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
1209 /** Returns corresponding operand of Tuple if node is a Proj from
1211 ir_node *skip_Tuple(ir_node *node);
1212 /** returns operand of node if node is a Cast. */
1213 ir_node *skip_Cast(ir_node *node);
1214 /** Returns operand of node if node is a Confirm */
1215 ir_node *skip_Confirm(ir_node *node);
1216 /** Skip all high-level Operations. */
1217 ir_node *skip_HighLevel(ir_node *node);
1218 /** Returns true if irn is a Const node. */
1219 int is_Const(const ir_node *node);
1220 /** Returns true if a node is a Conv node. */
1221 int is_Conv(const ir_node *node);
1222 /** Returns true if a node is a strictConv node. */
1223 int is_strictConv(const ir_node *node);
1224 /** Returns true if a node is a Cast node. */
1225 int is_Cast(const ir_node *node);
1226 /** Returns true if node is a Bad node. */
1227 int is_Bad(const ir_node *node);
1228 /** Returns true if node is a NoMem node. */
1229 int is_NoMem(const ir_node *node);
1230 /** Returns true if node is a Start node. */
1231 int is_Start(const ir_node *node);
1232 /** Returns true if node is a Minus node. */
1233 int is_Minus(const ir_node *node);
1234 /** Returns true if node is a Mod node. */
1235 int is_Mod(const ir_node *node);
1236 /** Returns true if node is a Div node. */
1237 int is_Div(const ir_node *node);
1238 /** Returns true if node is a DivMod node. */
1239 int is_DivMod(const ir_node *node);
1240 /** Returns true if node is a Quot node. */
1241 int is_Quot(const ir_node *node);
1242 /** Returns true if node is an Add node. */
1243 int is_Add(const ir_node *node);
1244 /** Returns true if node is an And node. */
1245 int is_And(const ir_node *node);
1246 /** Returns true if node is an Or node. */
1247 int is_Or(const ir_node *node);
1248 /** Returns true if node is an Eor node. */
1249 int is_Eor(const ir_node *node);
1250 /** Returns true if node is a Sub node. */
1251 int is_Sub(const ir_node *node);
1252 /** Returns true if node is a Not node. */
1253 int is_Not(const ir_node *node);
1254 /** Returns true if node is a Shl node. */
1255 int is_Shl(const ir_node *node);
1256 /** Returns true if node is a Shr node. */
1257 int is_Shr(const ir_node *node);
1258 /** Returns true if node is a Shrs node. */
1259 int is_Shrs(const ir_node *node);
1260 /** Returns true if node is a Rot node. */
1261 int is_Rot(const ir_node *node);
1262 /** Returns true if node is a Psi node. */
1263 int is_Psi(const ir_node *node);
1264 /** Returns true if node is a Tuple node. */
1265 int is_Tuple(const ir_node *node);
1266 /** Returns true if the node is not a Block */
1267 int is_no_Block(const ir_node *node);
1268 /** Returns true if the node is a Block */
1269 int is_Block(const ir_node *node);
1270 /** Returns true if node is an Unknown node. */
1271 int is_Unknown(const ir_node *node);
1272 /** Returns true if node is a Return node. */
1273 int is_Return(const ir_node *node);
1274 /** Returns true if node is a Call node. */
1275 int is_Call(const ir_node *node);
1276 /** Returns true if node is a Sel node. */
1277 int is_Sel(const ir_node *node);
1278 /** Returns true if node is a Mul node. */
1279 int is_Mul(const ir_node *node);
1280 /** Returns true if node is a Mulh node. */
1281 int is_Mulh(const ir_node *node);
1282 /** Returns true if node is a Mux node or a Psi with only one condition. */
1283 int is_Mux(const ir_node *node);
1284 /** Returns true if node is a Load node. */
1285 int is_Load(const ir_node *node);
1286 /** Returns true if node is a Store node. */
1287 int is_Store(const ir_node *node);
1288 /** Returns true if node is a Sync node. */
1289 int is_Sync(const ir_node *node);
1290 /** Returns true if node is a Confirm node. */
1291 int is_Confirm(const ir_node *node);
1292 /** Returns true if node is a Pin node. */
1293 int is_Pin(const ir_node *node);
1294 /** Returns true if node is a SymConst node. */
1295 int is_SymConst(const ir_node *node);
1296 /** Returns true if node is a Cond node. */
1297 int is_Cond(const ir_node *node);
1298 /** Returns true of node is a CopyB node */
1299 int is_CopyB(const ir_node *node);
1300 /** Returns true if node is a Cmp node. */
1301 int is_Cmp(const ir_node *node);
1302 /** Returns true if node is an Alloc node */
1303 int is_Alloc(const ir_node *node);
1304 /** Returns true if a node is a Jmp node */
1305 int is_Jmp(const ir_node *node);
1306 /** Returns true if a node is a Raise node */
1307 int is_Raise(const ir_node *node);
1308 /** Returns true if a node is an ASM node */
1309 int is_ASM(const ir_node *node);
1310 /** Returns true if node is a Proj node or a Filter node in
1311 * intraprocedural view */
1312 int is_Proj(const ir_node *node);
1313 /** Returns true if the operation manipulates control flow:
1314 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1315 int is_cfop(const ir_node *node);
1317 /** Returns true if the operation manipulates interprocedural control flow:
1318 CallBegin, EndReg, EndExcept */
1319 int is_ip_cfop(const ir_node *node);
1320 /** Returns true if the operation can change the control flow because
1321 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1322 Bad. Raise is not fragile, but a unconditional jump. */
1323 int is_fragile_op(const ir_node *node);
1324 /** Returns the memory operand of fragile operations. */
1325 ir_node *get_fragile_op_mem(ir_node *node);
1326 /** Returns the result mode of a Div operation. */
1327 ir_mode *get_divop_resmod(const ir_node *node);
1329 /** Returns true if the operation is a forking control flow
1330 * operation: Cond. */
1331 int is_irn_forking(const ir_node *node);
1333 /** Return the type associated with the value produced by n
1334 * if the node remarks this type as it is the case for
1335 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1336 ir_type *get_irn_type(ir_node *n);
1338 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1340 ir_type *get_irn_type_attr(ir_node *n);
1342 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1343 ir_entity *get_irn_entity_attr(ir_node *n);
1345 /** Returns non-zero for constant-like nodes. */
1346 int is_irn_constlike(const ir_node *node);
1349 * Returns non-zero for nodes that must be always optimized
1350 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1352 int is_irn_always_opt(const ir_node *node);
1355 * Returns non-zero for nodes that are allowed to have keep-alives and
1356 * are neither Block nor PhiM.
1358 int is_irn_keep(const ir_node *node);
1361 * Returns non-zero for nodes that are always placed in the start block.
1363 int is_irn_start_block_placed(const ir_node *node);
1366 * Returns non-zero for nodes that are machine operations.
1368 int is_irn_machine_op(const ir_node *node);
1371 * Returns non-zero for nodes that are machine operands.
1373 int is_irn_machine_operand(const ir_node *node);
1376 * Returns non-zero for nodes that have the n'th user machine flag set.
1378 int is_irn_machine_user(const ir_node *node, unsigned n);
1381 * A type to express conditional jump predictions.
1384 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1385 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1386 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1387 } cond_jmp_predicate;
1389 /** Gets the string representation of the jump prediction .*/
1390 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1392 /** Returns the conditional jump prediction of a Cond node. */
1393 cond_jmp_predicate get_Cond_jmp_pred(const ir_node *cond);
1395 /** Sets a new conditional jump prediction. */
1396 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1399 * Access custom node data.
1400 * The data must have been registered with
1401 * register_additional_node_data() before.
1402 * @param node The ir node to get the data from.
1403 * @param type The type of the data you registered.
1404 * @param off The value returned by register_additional_node_data().
1405 * @return A pointer of type @p type.
1407 #define get_irn_data(node,type,off) \
1408 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1411 * Get the pointer to the node some custom data belongs to.
1412 * @param data The pointer to the custom data.
1413 * @param off The number as returned by register_additional_node_data().
1414 * @return A pointer to the ir node the custom data belongs to.
1416 #define get_irn_data_base(data,off) \
1417 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1420 * Request additional data to be allocated with an ir node.
1421 * @param size The size of the additional data required.
1422 * @return A positive number, if the operation was successful, which
1423 * must be passed to the access macro get_irn_data(), 0 if the
1424 * registration failed.
1426 unsigned firm_register_additional_node_data(unsigned size);
1429 * Return a pointer to the node attributes.
1430 * Needed for user-defined nodes.
1432 void *get_irn_generic_attr(ir_node *node);
1433 const void *get_irn_generic_attr_const(const ir_node *node);
1436 * Returns the unique node index for the node in its graph.
1437 * This index is used to access phase information for this node.
1439 unsigned get_irn_idx(const ir_node *node);
1442 * Sets the debug information of a node.
1444 * @param n The node.
1445 * @param db The debug info.
1447 void set_irn_dbg_info(ir_node *n, dbg_info *db);
1450 * Returns the debug information of an node.
1452 * @param n The node.
1454 dbg_info *get_irn_dbg_info(const ir_node *n);
1456 /*-----------------------------------------------------------------*/
1458 /*-----------------------------------------------------------------*/
1461 /** Debug print the node.
1463 * Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
1464 * is set. Else does nothing. */
1465 void dump_irn(ir_node *n);
1467 /*@}*/ /* end of ir_node group definition */