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 * @function get_irn_block()
288 * @see get_nodes_block()
292 * Projection numbers for result of Start node: use for Proj nodes!
295 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
296 pn_Start_M, /**< Projection on the initial memory. */
297 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
298 pn_Start_P_globals, /**< Projection on the pointer to the data segment
299 containing _all_ global entities. Use for
300 position independent data/code access. */
301 pn_Start_P_tls, /**< Projection on the pointer to the thread local store
302 segment containing _all_thread local variables. */
303 pn_Start_T_args, /**< Projection on all arguments. */
304 pn_Start_P_value_arg_base, /**< Pointer to region of compound value arguments as defined by
305 type of this method. */
306 pn_Start_max /**< number of projections from a Start */
307 } pn_Start; /* Projection numbers for Start. */
309 /** Test whether arbitrary node is frame pointer.
311 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
312 * from Start. If so returns frame type, else Null. */
313 ir_type *is_frame_pointer(ir_node *n);
315 /** Test whether arbitrary node is globals pointer.
317 * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
318 * from Start. If so returns global type, else Null. */
319 ir_type *is_globals_pointer(ir_node *n);
321 /** Test whether arbitrary node is tls pointer.
323 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
324 * from Start. If so returns tls type, else Null. */
325 ir_type *is_tls_pointer(ir_node *n);
327 /** Test whether arbitrary node is value arg base.
329 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
330 * from Start. If so returns 1, else 0. */
331 int is_value_arg_pointer(ir_node *n);
334 /* @@@ no more supported */
335 ir_node **get_Block_cfgpred_arr(ir_node *node);
336 int get_Block_n_cfgpreds(const ir_node *node);
337 ir_node *get_Block_cfgpred(ir_node *node, int pos);
338 void set_Block_cfgpred(ir_node *node, int pos, ir_node *pred);
339 /** Get the predecessor block.
341 * Returns the block corresponding to the predecessor pos of block.
343 * There are several ambiguities we resolve with this function:
344 * - The direct predecessor can be a Proj, which is not pinned.
345 * We walk from the predecessor to the next pinned node
346 * (skip_Proj) and return the block that node is in.
347 * - If we encounter the Bad node, this function does not return
348 * Start, but the Bad node.
350 ir_node *get_Block_cfgpred_block(ir_node *node, int pos);
351 int get_Block_matured(ir_node *node);
352 void set_Block_matured(ir_node *node, int matured);
354 /** A visited flag only for block nodes.
355 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
356 unsigned long get_Block_block_visited(const ir_node *node);
357 void set_Block_block_visited(ir_node *node, unsigned long visit);
360 * Marks a block as dead but do not replace it with a Bad node.
361 * Dead blocks are removed in the con
363 ir_node *set_Block_dead(ir_node *block);
364 int is_Block_dead(const ir_node *block);
366 /* For this current_ir_graph must be set. */
367 void mark_Block_block_visited(ir_node *node);
368 int Block_not_block_visited(const ir_node *node);
369 int Block_block_visited(const ir_node *node);
371 /* Set and remove interprocedural predecessors. If the interprocedural
372 * predecessors are removed, the node has the same predecessors in
374 * @@@ Maybe better: arity is zero if no cg preds. */
375 void set_Block_cg_cfgpred_arr(ir_node *node, int arity, ir_node *in[]);
376 void set_Block_cg_cfgpred(ir_node *node, int pos, ir_node *pred);
377 /* @@@ not supported */
378 ir_node **get_Block_cg_cfgpred_arr(ir_node *node);
379 /** Returns the number of interprocedural predecessors. 0 if none. */
380 int get_Block_cg_n_cfgpreds(ir_node *node);
381 /** Return the interprocedural predecessor at position pos. */
382 ir_node *get_Block_cg_cfgpred(ir_node *node, int pos);
383 /** Frees the memory allocated for interprocedural predecessors. */
384 void remove_Block_cg_cfgpred_arr(ir_node *node);
385 /** Returns the extended basic block a block belongs to. */
386 ir_extblk *get_Block_extbb(const ir_node *block);
387 /** Sets the extended basic block a block belongs to. */
388 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
389 /** Get the Macro Block header of a (sub-) block. */
390 ir_node *get_Block_MacroBlock(const ir_node *block);
391 /** Returns the ir_graph this Block belongs to. */
392 ir_graph *get_Block_irg(const ir_node *block);
393 /** Returns non-zero if the block has an assigned label. */
394 int has_Block_label(const ir_node *block);
395 /** Returns the label of a Block. */
396 ir_label_t get_Block_label(const ir_node *block);
397 /** Sets a label to a block. */
398 void set_Block_label(ir_node *block, ir_label_t label);
400 /** Return the number of Keep alive node. */
401 int get_End_n_keepalives(ir_node *end);
402 /** Return the Keep alive node a position pos. */
403 ir_node *get_End_keepalive(ir_node *end, int pos);
404 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
405 void add_End_keepalive(ir_node *end, ir_node *ka);
406 /** Set the Keep alive node at position pos. */
407 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
408 /** Set new keep-alives. */
409 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
410 /** Set new keep-alives from old keep-alives, skipping irn. */
411 void remove_End_keepalive(ir_node *end, ir_node *irn);
413 /** Some parts of the End node are allocated separately -- their memory
414 is not recovered by dead_node_elimination if a End node is dead.
415 free_End() frees these data structures. */
416 void free_End(ir_node *end);
418 /** Return the target address of an IJmp */
419 ir_node *get_IJmp_target(ir_node *ijmp);
420 /** Sets the target address of an IJmp */
421 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
423 /* We distinguish three kinds of Cond nodes. These can be distinguished
424 by the mode of the selector operand and an internal flag of type cond_kind.
425 First we distinguish binary Conds and switch Conds.
426 A binary Cond has as selector a boolean value. Proj(0) projects the control
427 flow for case "False", Proj(1) the control flow for "True". A binary Cond
428 is recognized by the boolean selector.
429 The switch Cond has as selector an unsigned integer. It produces as result
430 an n+1 Tuple (cf0, ... , cfn) of control flows.
431 We differ two flavors of this Cond. The first, the dense Cond, passes
432 control along output i if the selector value is i, 0 <= i <= n. If the
433 selector value is >n it passes control along output n.
434 The second Cond flavor differences in the treatment of cases not specified in
435 the source program. It magically knows about the existence of Proj nodes.
436 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
437 exists. Else it passes control along output n (even if this Proj does not
438 exist.) This Cond we call "fragmentary". There is a special constructor
439 new_defaultProj that automatically sets the flavor.
440 The two switch flavors are distinguished by a flag of type cond_kind.
441 Default flavor is "dense"
444 dense, /**< Default. Missing Proj nodes are dead control flow. */
445 fragmentary /**< Special. No control flow optimizations allowed. Missing
446 Proj nodes mean default control flow, i.e., Proj(n). */
449 ir_node *get_Cond_selector(ir_node *node);
450 void set_Cond_selector(ir_node *node, ir_node *selector);
451 cond_kind get_Cond_kind(ir_node *node);
452 void set_Cond_kind(ir_node *node, cond_kind kind);
453 long get_Cond_defaultProj(ir_node *node);
456 * Projection numbers for conditions.
459 pn_Cond_false, /**< Control flow if operand is "false". */
460 pn_Cond_true, /**< Control flow if operand is "true". */
461 pn_Cond_max /**< number of projections from a Cond */
462 } pn_Cond; /* Projection numbers for Cond. */
464 ir_node *get_Return_mem(ir_node *node);
465 void set_Return_mem(ir_node *node, ir_node *mem);
466 ir_node **get_Return_res_arr(ir_node *node);
467 int get_Return_n_ress(ir_node *node);
468 ir_node *get_Return_res(ir_node *node, int pos);
469 void set_Return_res(ir_node *node, int pos, ir_node *res);
471 tarval *get_Const_tarval(const ir_node *node);
472 void set_Const_tarval(ir_node *node, tarval *con);
474 int is_Const_null(const ir_node *node);
476 int is_Const_one(const ir_node *node);
478 int is_Const_all_one(const ir_node *node);
480 /** Returns the source language type of a Const node.
481 * Must be an atomic type. Mode of type must be mode of node.
483 ir_type *get_Const_type(ir_node *node);
485 /** Sets the source language type of a Const node. */
486 void set_Const_type(ir_node *node, ir_type *tp);
488 /** This enum names the three different kinds of symbolic Constants
489 represented by SymConst. The content of the attribute type_or_id
490 depends on this tag. Use the proper access routine after testing
493 symconst_type_tag, /**< The SymConst is a type tag for the given type.
494 symconst_symbol is type *. */
495 symconst_type_size, /**< The SymConst is the size of the given type.
496 symconst_symbol is type *. */
497 symconst_type_align, /**< The SymConst is the alignment of the given type.
498 symconst_symbol is type *. */
499 symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
500 by the linker. The pointer is represented by a string.
501 symconst_symbol is ident *. */
502 symconst_addr_ent, /**< The SymConst is a symbolic pointer to be filled in
503 by the linker. The pointer is represented by an entity.
504 symconst_symbol is entity *. */
505 symconst_ofs_ent, /**< The SymConst is the offset of its entity in the entities
507 symconst_enum_const, /**< The SymConst is a enumeration constant of an
509 symconst_label /**< The SymConst is a label address. */
512 /** Returns non-zero if s symconst kind has a type attribute */
513 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
515 /** Returns non-zero if s symconst kind has an ident attribute */
516 #define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)
518 /** Returns non-zero if s symconst kind has an entity attribute */
519 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
521 /** Returns non-zero if s symconst kind has an enum_const attribute */
522 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
524 /** Returns non-zero if s symconst kind has a label attribute */
525 #define SYMCONST_HAS_LABEL(kind) ((kind) == symconst_label)
527 /** SymConst attribute.
529 * This union contains the symbolic information represented by the node.
531 typedef union symconst_symbol {
532 ir_type *type_p; /**< The type of a SymConst. */
533 ident *ident_p; /**< The ident of a SymConst. */
534 ir_entity *entity_p; /**< The entity of a SymConst. */
535 ir_enum_const *enum_p; /**< The enumeration constant of a SymConst. */
536 ir_label_t label; /**< The label of a SymConst. */
539 /** Get the kind of the SymConst. */
540 symconst_kind get_SymConst_kind(const ir_node *node);
541 /** Set the kind of the SymConst. */
542 void set_SymConst_kind(ir_node *node, symconst_kind num);
544 /** Only to access SymConst of kind type_tag or size. Else assertion: */
545 ir_type *get_SymConst_type(ir_node *node);
546 void set_SymConst_type(ir_node *node, ir_type *tp);
548 /** Only to access SymConst of kind addr_name. Else assertion: */
549 ident *get_SymConst_name(const ir_node *node);
550 void set_SymConst_name(ir_node *node, ident *name);
552 /** Only to access SymConst of kind addr_ent. Else assertion: */
553 ir_entity *get_SymConst_entity(const ir_node *node);
554 void set_SymConst_entity(ir_node *node, ir_entity *ent);
556 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
557 ir_enum_const *get_SymConst_enum(const ir_node *node);
558 void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
560 /** Sets both: type and ptrinfo. Needed to treat the node independent of
561 its semantics. Does a memcpy for the memory sym points to. */
562 /* write 'union': firmjni then does not create a method... */
563 union symconst_symbol get_SymConst_symbol(const ir_node *node);
564 void set_SymConst_symbol(ir_node *node,
565 union symconst_symbol sym);
567 /** Only to access SymConst of kind symconst_label. Else assertion: */
568 ir_label_t get_SymConst_label(const ir_node *node);
569 void set_SymConst_label(ir_node *node, ir_label_t label);
572 /** Access the type of the value represented by the SymConst.
574 * Example: primitive type int for SymConst size. */
575 ir_type *get_SymConst_value_type(ir_node *node);
576 void set_SymConst_value_type(ir_node *node, ir_type *tp);
578 ir_node *get_Sel_mem(ir_node *node);
579 void set_Sel_mem(ir_node *node, ir_node *mem);
580 ir_node *get_Sel_ptr(ir_node *node); /* ptr to the object to select from */
581 void set_Sel_ptr(ir_node *node, ir_node *ptr);
582 ir_node **get_Sel_index_arr(ir_node *node);
583 int get_Sel_n_indexs(ir_node *node);
584 ir_node *get_Sel_index(ir_node *node, int pos);
585 void set_Sel_index(ir_node *node, int pos, ir_node *index);
586 ir_entity *get_Sel_entity(ir_node *node); /* entity to select */
587 void set_Sel_entity (ir_node *node, ir_entity *ent);
590 * Projection numbers for result of Call node: use for Proj nodes!
593 pn_Call_M_regular = pn_Generic_M_regular, /**< The memory result. */
594 pn_Call_X_regular = pn_Generic_X_regular, /**< The control flow result when no exception occurs. */
595 pn_Call_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler. */
596 pn_Call_T_result = pn_Generic_other, /**< The tuple containing all (0, 1, 2, ...) results. */
597 pn_Call_M_except, /**< The memory result in case the called method terminated with
599 pn_Call_P_value_res_base, /**< A pointer to the memory region containing copied results
600 passed by value (for compound result types). */
601 pn_Call_max /**< number of projections from a Call */
602 } pn_Call; /* Projection numbers for Call. */
603 #define pn_Call_M pn_Call_M_regular
605 ir_node *get_Call_mem(ir_node *node);
606 void set_Call_mem(ir_node *node, ir_node *mem);
607 ir_node *get_Call_ptr(ir_node *node);
608 void set_Call_ptr(ir_node *node, ir_node *ptr);
609 ir_node **get_Call_param_arr(ir_node *node);
610 /** Gets the number of parameters of a call. */
611 int get_Call_n_params(ir_node *node);
612 /** Gets the call parameter at position pos. */
613 ir_node *get_Call_param(ir_node *node, int pos);
614 /** Sets the call parameter at position pos. */
615 void set_Call_param(ir_node *node, int pos, ir_node *param);
616 /** Gets the type of a call. */
617 ir_type *get_Call_type(ir_node *node);
618 /** Sets the type of a call. */
619 void set_Call_type(ir_node *node, ir_type *tp);
620 /** Gets the arity of a call. Identical to get_Call_n_params(). */
621 int get_Call_arity(ir_node *node);
623 /** Set, get and remove the callee information for a Call node.
625 * The callee information lists all method entities that can be called
626 * from this node. If the address expression can not be analyzed fully,
627 * e.g., as entities can be called that are not in the compilation unit,
628 * the array contains the unknown_entity. The array contains only entities
629 * with peculiarity_existent, but with all kinds of visibility. The entities
630 * not necessarily contain an irg.
632 * The array is only accessible if callee information is valid. See flag
635 * The memory allocated for the array is managed automatically, i.e., it must
636 * not be freed if the Call node is removed from the graph.
638 * @param node A Call node.
640 int Call_has_callees(ir_node *node);
641 int get_Call_n_callees(ir_node *node);
642 ir_entity *get_Call_callee(ir_node *node, int pos);
644 /** Set the full callee array.
646 * The passed array is copied. Assumes current_ir_graph set properly! */
647 void set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
648 void remove_Call_callee_arr(ir_node *node);
650 ir_node *get_CallBegin_ptr(ir_node *node);
651 void set_CallBegin_ptr(ir_node *node, ir_node *ptr);
652 ir_node *get_CallBegin_call(ir_node *node);
653 void set_CallBegin_call(ir_node *node, ir_node *call);
655 /* For unary and binary arithmetic operations the access to the
656 operands can be factored out. Left is the first, right the
657 second arithmetic value as listed in tech report 1999-44.
658 unops are: Minus, Abs, Not, Conv, Cast
659 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
660 Shr, Shrs, Rot, Cmp */
661 int is_unop(const ir_node *node);
662 ir_node *get_unop_op(const ir_node *node);
663 void set_unop_op(ir_node *node, ir_node *op);
664 int is_binop(const ir_node *node);
665 ir_node *get_binop_left(const ir_node *node);
666 void set_binop_left(ir_node *node, ir_node *left);
667 ir_node *get_binop_right(const ir_node *node);
668 void set_binop_right(ir_node *node, ir_node *right);
670 ir_node *get_Add_left(const ir_node *node);
671 void set_Add_left(ir_node *node, ir_node *left);
672 ir_node *get_Add_right(const ir_node *node);
673 void set_Add_right(ir_node *node, ir_node *right);
675 ir_node *get_Sub_left(const ir_node *node);
676 void set_Sub_left(ir_node *node, ir_node *left);
677 ir_node *get_Sub_right(const ir_node *node);
678 void set_Sub_right(ir_node *node, ir_node *right);
680 ir_node *get_Minus_op(const ir_node *node);
681 void set_Minus_op(ir_node *node, ir_node *op);
683 ir_node *get_Mul_left(const ir_node *node);
684 void set_Mul_left(ir_node *node, ir_node *left);
685 ir_node *get_Mul_right(const ir_node *node);
686 void set_Mul_right(ir_node *node, ir_node *right);
688 ir_node *get_Mulh_left(const ir_node *node);
689 void set_Mulh_left(ir_node *node, ir_node *left);
690 ir_node *get_Mulh_right(const ir_node *node);
691 void set_Mulh_right(ir_node *node, ir_node *right);
693 ir_node *get_Quot_left(const ir_node *node);
694 void set_Quot_left(ir_node *node, ir_node *left);
695 ir_node *get_Quot_right(const ir_node *node);
696 void set_Quot_right(ir_node *node, ir_node *right);
697 ir_node *get_Quot_mem(ir_node *node);
698 void set_Quot_mem(ir_node *node, ir_node *mem);
699 ir_mode *get_Quot_resmode(const ir_node *node);
700 void set_Quot_resmode(ir_node *node, ir_mode *mode);
703 * Projection numbers for Quot: use for Proj nodes!
706 pn_Quot_M = pn_Generic_M_regular, /**< Memory result. */
707 pn_Quot_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
708 pn_Quot_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
709 pn_Quot_res = pn_Generic_other, /**< Result of computation. */
710 pn_Quot_max /**< number of projections from a Quot */
711 } pn_Quot; /* Projection numbers for Quot. */
713 ir_node *get_DivMod_left(const ir_node *node);
714 void set_DivMod_left(ir_node *node, ir_node *left);
715 ir_node *get_DivMod_right(const ir_node *node);
716 void set_DivMod_right(ir_node *node, ir_node *right);
717 ir_node *get_DivMod_mem(ir_node *node);
718 void set_DivMod_mem(ir_node *node, ir_node *mem);
719 ir_mode *get_DivMod_resmode(const ir_node *node);
720 void set_DivMod_resmode(ir_node *node, ir_mode *mode);
723 * Projection numbers for DivMod: use for Proj nodes!
726 pn_DivMod_M = pn_Generic_M_regular, /**< Memory result. */
727 pn_DivMod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
728 pn_DivMod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
729 pn_DivMod_res_div = pn_Generic_other, /**< Result of computation a / b. */
730 pn_DivMod_res_mod, /**< Result of computation a % b. */
731 pn_DivMod_max /**< number of projections from a DivMod */
732 } pn_DivMod; /* Projection numbers for DivMod. */
734 ir_node *get_Div_left(const ir_node *node);
735 void set_Div_left(ir_node *node, ir_node *left);
736 ir_node *get_Div_right(const ir_node *node);
737 void set_Div_right(ir_node *node, ir_node *right);
738 ir_node *get_Div_mem(ir_node *node);
739 void set_Div_mem(ir_node *node, ir_node *mem);
740 ir_mode *get_Div_resmode(const ir_node *node);
741 void set_Div_resmode(ir_node *node, ir_mode *mode);
744 * Projection numbers for Div: use for Proj nodes!
747 pn_Div_M = pn_Generic_M_regular, /**< Memory result. */
748 pn_Div_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
749 pn_Div_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
750 pn_Div_res = pn_Generic_other, /**< Result of computation. */
751 pn_Div_max /**< number of projections from a Div */
752 } pn_Div; /* Projection numbers for Div. */
754 ir_node *get_Mod_left(const ir_node *node);
755 void set_Mod_left(ir_node *node, ir_node *left);
756 ir_node *get_Mod_right(const ir_node *node);
757 void set_Mod_right(ir_node *node, ir_node *right);
758 ir_node *get_Mod_mem(ir_node *node);
759 void set_Mod_mem(ir_node *node, ir_node *mem);
760 ir_mode *get_Mod_resmode(const ir_node *node);
761 void set_Mod_resmode(ir_node *node, ir_mode *mode);
764 * Projection numbers for Mod: use for Proj nodes!
767 pn_Mod_M = pn_Generic_M_regular, /**< Memory result. */
768 pn_Mod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
769 pn_Mod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
770 pn_Mod_res = pn_Generic_other, /**< Result of computation. */
771 pn_Mod_max /**< number of projections from a Mod */
772 } pn_Mod; /* Projection numbers for Mod. */
774 ir_node *get_Abs_op(const ir_node *node);
775 void set_Abs_op(ir_node *node, ir_node *op);
777 ir_node *get_And_left(const ir_node *node);
778 void set_And_left(ir_node *node, ir_node *left);
779 ir_node *get_And_right(const ir_node *node);
780 void set_And_right(ir_node *node, ir_node *right);
782 ir_node *get_Or_left(const ir_node *node);
783 void set_Or_left(ir_node *node, ir_node *left);
784 ir_node *get_Or_right(const ir_node *node);
785 void set_Or_right(ir_node *node, ir_node *right);
787 ir_node *get_Eor_left(const ir_node *node);
788 void set_Eor_left(ir_node *node, ir_node *left);
789 ir_node *get_Eor_right(const ir_node *node);
790 void set_Eor_right(ir_node *node, ir_node *right);
792 ir_node *get_Not_op(const ir_node *node);
793 void set_Not_op(ir_node *node, ir_node *op);
796 * Projection numbers for Cmp are defined several times.
797 * The bit patterns are used for various tests, so don't change.
798 * The "unordered" values are possible results of comparing
799 * floating point numbers.
800 * Note that the encoding is imported, so do NOT change the order.
803 pn_Cmp_False = 0, /**< false */
804 pn_Cmp_Eq = 1, /**< equal */
805 pn_Cmp_Lt = 2, /**< less */
806 pn_Cmp_Le = pn_Cmp_Eq|pn_Cmp_Lt, /**< less or equal */
807 pn_Cmp_Gt = 4, /**< greater */
808 pn_Cmp_Ge = pn_Cmp_Eq|pn_Cmp_Gt, /**< greater or equal */
809 pn_Cmp_Lg = pn_Cmp_Lt|pn_Cmp_Gt, /**< less or greater */
810 pn_Cmp_Leg = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
811 pn_Cmp_Uo = 8, /**< unordered */
812 pn_Cmp_Ue = pn_Cmp_Uo|pn_Cmp_Eq, /**< unordered or equal */
813 pn_Cmp_Ul = pn_Cmp_Uo|pn_Cmp_Lt, /**< unordered or less */
814 pn_Cmp_Ule = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
815 pn_Cmp_Ug = pn_Cmp_Uo|pn_Cmp_Gt, /**< unordered or greater */
816 pn_Cmp_Uge = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
817 pn_Cmp_Ne = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
818 pn_Cmp_True = 15 /**< true */
819 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for JNI interface */
820 } pn_Cmp; /* Projection numbers for Cmp */
821 /* #define not_mask pn_Cmp_Leg */
823 /** returns the pnc name from an pnc constant */
824 const char *get_pnc_string(int pnc);
826 /** Calculates the negated (Complement(R)) pnc condition. */
827 int get_negated_pnc(int pnc, ir_mode *mode);
829 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
830 int get_inversed_pnc(int pnc);
832 /** An alternative name for get_inversed_pnc() that can be better memorized. */
833 #define get_mirrored_pnc(pnc) get_inversed_pnc(pnc)
835 ir_node *get_Cmp_left(const ir_node *node);
836 void set_Cmp_left(ir_node *node, ir_node *left);
837 ir_node *get_Cmp_right(const ir_node *node);
838 void set_Cmp_right(ir_node *node, ir_node *right);
840 ir_node *get_Shl_left(const ir_node *node);
841 void set_Shl_left(ir_node *node, ir_node *left);
842 ir_node *get_Shl_right(const ir_node *node);
843 void set_Shl_right(ir_node *node, ir_node *right);
845 ir_node *get_Shr_left(const ir_node *node);
846 void set_Shr_left(ir_node *node, ir_node *left);
847 ir_node *get_Shr_right(const ir_node *node);
848 void set_Shr_right(ir_node *node, ir_node *right);
850 ir_node *get_Shrs_left(const ir_node *node);
851 void set_Shrs_left(ir_node *node, ir_node *left);
852 ir_node *get_Shrs_right(const ir_node *node);
853 void set_Shrs_right(ir_node *node, ir_node *right);
855 ir_node *get_Rot_left(const ir_node *node);
856 void set_Rot_left(ir_node *node, ir_node *left);
857 ir_node *get_Rot_right(const ir_node *node);
858 void set_Rot_right(ir_node *node, ir_node *right);
860 ir_node *get_Conv_op(const ir_node *node);
861 void set_Conv_op(ir_node *node, ir_node *op);
862 int get_Conv_strict(ir_node *node);
863 void set_Conv_strict(ir_node *node, int flag);
865 /* Does Cast need a mem operator?
866 * Cast should only depend on the type, not on the state of an
867 * entity. But: we initialize various fields after Alloc, that
868 * are accessed in the cast. This required some precaution, to
869 * get the right memory into the Loads generated from the cast.
871 ir_node *get_Cast_op(const ir_node *node);
872 void set_Cast_op(ir_node *node, ir_node *op);
873 ir_type *get_Cast_type(ir_node *node);
874 void set_Cast_type(ir_node *node, ir_type *to_tp);
876 /** Checks for upcast.
878 * Returns true if the Cast node casts a class type to a super type.
879 * Works also for pointers to classes (recursively).
881 * Needs typeinfo calculated.
883 int is_Cast_upcast(ir_node *node);
885 /** Checks for downcast.
887 * Returns true if the Cast node casts a class type to a sub type.
888 * Works also for pointers to classes (recursively).
890 * Needs typeinfo calculated.
892 int is_Cast_downcast(ir_node *node);
895 /** Returns true if n is Phi or Filter in interprocedural_view.
896 Returns false if irg in phase building and the Phi has zero
897 predecessors: it's a Phi0. */
898 int is_Phi(const ir_node *n);
899 /** Returns true if irg in phase building and the Phi has zero
900 predecessors. It's a Phi0 then. */
901 int is_Phi0(const ir_node *n);
902 /* These routines also work for Filter nodes in interprocedural view. */
903 ir_node **get_Phi_preds_arr(ir_node *node);
904 int get_Phi_n_preds(const ir_node *node);
905 ir_node *get_Phi_pred(const ir_node *node, int pos);
906 void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
908 ir_node *get_Filter_pred(ir_node *node);
909 void set_Filter_pred(ir_node *node, ir_node *pred);
910 long get_Filter_proj(ir_node *node);
911 void set_Filter_proj(ir_node *node, long proj);
912 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
913 * @@@ Maybe better: arity is zero if no cg preds. */
914 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
915 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
916 int get_Filter_n_cg_preds(ir_node *node);
917 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
919 /** Return true if parameter is a memory operation.
921 * A memory operation is an operation that changes the
922 * memory. I.e., a Load or a Store operation.
924 int is_memop(ir_node *node);
925 ir_node *get_memop_mem(ir_node *node);
926 void set_memop_mem(ir_node *node, ir_node *mem);
927 ir_node *get_memop_ptr(ir_node *node);
928 void set_memop_ptr(ir_node *node, ir_node *ptr);
931 * Projection numbers for Load: use for Proj nodes!
934 pn_Load_M = pn_Generic_M_regular, /**< Memory result. */
935 pn_Load_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
936 pn_Load_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
937 pn_Load_res = pn_Generic_other, /**< Result of load operation. */
938 pn_Load_max /**< number of projections from a Load */
939 } pn_Load; /* Projection numbers for Load. */
941 ir_node *get_Load_mem(ir_node *node);
942 void set_Load_mem(ir_node *node, ir_node *mem);
943 ir_node *get_Load_ptr(ir_node *node);
944 void set_Load_ptr(ir_node *node, ir_node *ptr);
945 ir_mode *get_Load_mode(ir_node *node);
946 void set_Load_mode(ir_node *node, ir_mode *mode);
947 ir_volatility get_Load_volatility(ir_node *node);
948 void set_Load_volatility(ir_node *node, ir_volatility volatility);
949 ir_align get_Load_align(ir_node *node);
950 void set_Load_align(ir_node *node, ir_align align);
953 * Projection numbers for Store: use for Proj nodes!
956 pn_Store_M = pn_Generic_M_regular, /**< Memory result. */
957 pn_Store_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
958 pn_Store_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
959 pn_Store_max = pn_Generic_other /**< number of projections from a Store */
960 } pn_Store; /* Projection numbers for Store. */
962 ir_node *get_Store_mem(ir_node *node);
963 void set_Store_mem(ir_node *node, ir_node *mem);
964 ir_node *get_Store_ptr(ir_node *node);
965 void set_Store_ptr(ir_node *node, ir_node *ptr);
966 ir_node *get_Store_value(ir_node *node);
967 void set_Store_value(ir_node *node, ir_node *value);
968 ir_volatility get_Store_volatility(ir_node *node);
969 void set_Store_volatility(ir_node *node, ir_volatility volatility);
970 ir_align get_Store_align(ir_node *node);
971 void set_Store_align(ir_node *node, ir_align align);
974 * Projection numbers for Alloc: use for Proj nodes!
977 pn_Alloc_M = pn_Generic_M_regular, /**< Memory result. */
978 pn_Alloc_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
979 pn_Alloc_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
980 pn_Alloc_res = pn_Generic_other, /**< Result of allocation. */
981 pn_Alloc_max /**< number of projections from an Alloc */
982 } pn_Alloc; /* Projection numbers for Alloc. */
984 ir_node *get_Alloc_mem(ir_node *node);
985 void set_Alloc_mem(ir_node *node, ir_node *mem);
986 ir_node *get_Alloc_size(ir_node *node);
987 void set_Alloc_size(ir_node *node, ir_node *size);
988 ir_type *get_Alloc_type(ir_node *node);
989 void set_Alloc_type(ir_node *node, ir_type *tp);
991 /** The allocation place. */
993 stack_alloc, /**< Alloc allocates the object on the stack. */
994 heap_alloc /**< Alloc allocates the object on the heap. */
997 where_alloc get_Alloc_where(ir_node *node);
998 void set_Alloc_where(ir_node *node, where_alloc where);
1000 ir_node *get_Free_mem(ir_node *node);
1001 void set_Free_mem(ir_node *node, ir_node *mem);
1002 ir_node *get_Free_ptr(ir_node *node);
1003 void set_Free_ptr(ir_node *node, ir_node *ptr);
1004 ir_node *get_Free_size(ir_node *node);
1005 void set_Free_size(ir_node *node, ir_node *size);
1006 ir_type *get_Free_type(ir_node *node);
1007 void set_Free_type(ir_node *node, ir_type *tp);
1009 where_alloc get_Free_where(ir_node *node);
1010 void set_Free_where(ir_node *node, where_alloc where);
1012 ir_node **get_Sync_preds_arr(ir_node *node);
1013 int get_Sync_n_preds(ir_node *node);
1014 ir_node *get_Sync_pred(ir_node *node, int pos);
1015 void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
1016 void add_Sync_pred(ir_node *node, ir_node *pred);
1018 /** Returns the source language type of a Proj node.
1019 * Must be an atomic type. Mode of type must be mode of node.
1021 ir_type *get_Proj_type(ir_node *node);
1023 /** Return the predecessor of a Proj node. */
1024 ir_node *get_Proj_pred(const ir_node *node);
1025 void set_Proj_pred(ir_node *node, ir_node *pred);
1026 /** Return the projection number of a Proj node. */
1027 long get_Proj_proj(const ir_node *node);
1028 void set_Proj_proj(ir_node *node, long proj);
1030 ir_node **get_Tuple_preds_arr(ir_node *node);
1031 int get_Tuple_n_preds(ir_node *node);
1032 ir_node *get_Tuple_pred(ir_node *node, int pos);
1033 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
1035 ir_node *get_Id_pred(ir_node *node);
1036 void set_Id_pred(ir_node *node, ir_node *pred);
1038 /** Confirm has a single result and returns 'value' unchanged.
1039 * The node expresses a restriction on 'value':
1040 * 'value' 'cmp' 'bound' == true. */
1041 ir_node *get_Confirm_value(ir_node *node);
1042 void set_Confirm_value(ir_node *node, ir_node *value);
1043 ir_node *get_Confirm_bound(ir_node *node);
1044 void set_Confirm_bound(ir_node *node, ir_node *bound);
1045 pn_Cmp get_Confirm_cmp(const ir_node *node);
1046 void set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
1049 * Mux Support: Note that Psi nodes with one condition can be handled
1050 * like Mux nodes, and the access functions work as expected.
1052 ir_node *get_Mux_sel(ir_node *node);
1053 void set_Mux_sel(ir_node *node, ir_node *sel);
1054 ir_node *get_Mux_false(ir_node *node);
1055 void set_Mux_false(ir_node *node, ir_node *ir_false);
1056 ir_node *get_Mux_true (ir_node *node);
1057 void set_Mux_true (ir_node *node, ir_node *ir_true);
1059 ir_node *get_Psi_cond(ir_node *node, int pos);
1060 void set_Psi_cond(ir_node *node, int pos, ir_node *cond);
1061 ir_node *get_Psi_val(ir_node *node, int pos);
1062 void set_Psi_val(ir_node *node, int pos, ir_node *val);
1063 ir_node *get_Psi_default(ir_node *node);
1064 void set_Psi_default(ir_node *node, ir_node *val);
1065 int get_Psi_n_conds(ir_node *node);
1068 * Projection numbers for result of CopyB node: use for Proj nodes!
1071 pn_CopyB_M_regular = pn_Generic_M_regular, /**< The memory result. */
1072 pn_CopyB_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1073 pn_CopyB_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1074 pn_CopyB_M_except = pn_Generic_other, /**< The memory result in case the runtime function terminated with
1076 pn_CopyB_max /**< number of projections from a CopyB */
1077 } pn_CopyB; /* Projection numbers for CopyB. */
1078 #define pn_CopyB_M pn_CopyB_M_regular
1080 ir_node *get_CopyB_mem(ir_node *node);
1081 void set_CopyB_mem(ir_node *node, ir_node *mem);
1082 ir_node *get_CopyB_dst(ir_node *node);
1083 void set_CopyB_dst(ir_node *node, ir_node *dst);
1084 ir_node *get_CopyB_src(ir_node *node);
1085 void set_CopyB_src(ir_node *node, ir_node *src);
1086 ir_type *get_CopyB_type(ir_node *node);
1087 void set_CopyB_type(ir_node *node, ir_type *data_type);
1090 * Projection numbers for result of InstOf node: use for Proj nodes!
1093 pn_InstOf_M_regular = pn_Generic_M_regular, /**< The memory result. */
1094 pn_InstOf_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1095 pn_InstOf_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1096 pn_InstOf_res = pn_Generic_other, /**< The checked object pointer. */
1097 pn_InstOf_M_except, /**< The memory result in case the runtime function terminated with
1099 pn_InstOf_max /**< number of projections from an InstOf */
1101 #define pn_InstOf_M pn_InstOf_M_regular
1103 /** InstOf access */
1104 ir_type *get_InstOf_type(ir_node *node);
1105 void set_InstOf_type(ir_node *node, ir_type *type);
1106 ir_node *get_InstOf_store(ir_node *node);
1107 void set_InstOf_store(ir_node *node, ir_node *obj);
1108 ir_node *get_InstOf_obj(ir_node *node);
1109 void set_InstOf_obj(ir_node *node, ir_node *obj);
1112 * Projection numbers for Raise.
1115 pn_Raise_X = 0, /**< The control flow to the exception handler. */
1116 pn_Raise_M = 1, /**< The Memory result. */
1117 pn_Raise_max /**< number of projections from a Raise */
1118 } pn_Raise; /* Projection numbers for Raise. */
1120 ir_node *get_Raise_mem(ir_node *node);
1121 void set_Raise_mem(ir_node *node, ir_node *mem);
1122 ir_node *get_Raise_exo_ptr(ir_node *node); /* PoinTeR to EXception Object */
1123 void set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
1126 * Projection numbers for result of Bound node: use for Proj nodes!
1129 pn_Bound_M = pn_Generic_M_regular, /**< The memory result. */
1130 pn_Bound_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1131 pn_Bound_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1132 pn_Bound_res = pn_Generic_other, /**< The checked index. */
1133 pn_Bound_max /**< number of projections from a Bound */
1136 /** Returns the memory input of a Bound operation. */
1137 ir_node *get_Bound_mem(ir_node *bound);
1138 void set_Bound_mem(ir_node *bound, ir_node *mem);
1140 /** Returns the index input of a Bound operation. */
1141 ir_node *get_Bound_index(ir_node *bound);
1142 void set_Bound_index(ir_node *bound, ir_node *idx);
1144 /** Returns the lower bound input of a Bound operation. */
1145 ir_node *get_Bound_lower(ir_node *bound);
1146 void set_Bound_lower(ir_node *bound, ir_node *lower);
1148 /** Returns the upper bound input of a Bound operation. */
1149 ir_node *get_Bound_upper(ir_node *bound);
1150 void set_Bound_upper(ir_node *bound, ir_node *upper);
1152 /** Return the operand of a Pin node. */
1153 ir_node *get_Pin_op(const ir_node *pin);
1154 void set_Pin_op(ir_node *pin, ir_node *node);
1156 /** A input/output constraint attribute */
1158 unsigned pos; /**< The inputs/output position for this constraint. */
1159 ident *constraint; /**< The constraint for this input/output. */
1160 } ir_asm_constraint;
1162 /** Return the assembler text of an ASM pseudo node. */
1163 ident *get_ASM_text(const ir_node *node);
1164 /** Return the number of input constraints for an ASM node. */
1165 int get_ASM_n_input_constraints(const ir_node *node);
1166 /** Return the input constraints for an ASM node. */
1167 const ir_asm_constraint *get_ASM_input_constraints(const ir_node *node);
1168 /** Return the number of output constraints for an ASM node. */
1169 int get_ASM_n_output_constraints(const ir_node *node);
1170 /** Return the output constraints for an ASM node. */
1171 const ir_asm_constraint *get_ASM_output_constraints(const ir_node *node);
1172 /** Return the number of clobbered registers for an ASM node. */
1173 int get_ASM_n_clobbers(const ir_node *node);
1174 /** Return the list of clobbered registers for an ASM node. */
1175 ident **get_ASM_clobbers(const ir_node *node);
1179 * NAME Auxiliary routines
1183 /** Returns operand of node if node is a Proj. */
1184 ir_node *skip_Proj(ir_node *node);
1185 /** Returns operand of node if node is a Proj. */
1186 const ir_node *skip_Proj_const(const ir_node *node);
1187 /** Returns operand of node if node is a Id. */
1188 ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
1189 /** Returns corresponding operand of Tuple if node is a Proj from
1191 ir_node *skip_Tuple(ir_node *node);
1192 /** returns operand of node if node is a Cast. */
1193 ir_node *skip_Cast(ir_node *node);
1194 /** Returns operand of node if node is a Confirm */
1195 ir_node *skip_Confirm(ir_node *node);
1196 /** Skip all high-level Operations. */
1197 ir_node *skip_HighLevel(ir_node *node);
1198 /** Returns true if irn is a Const node. */
1199 int is_Const(const ir_node *node);
1200 /** Returns true if a node is a Conv node. */
1201 int is_Conv(const ir_node *node);
1202 /** Returns true if a node is a Cast node. */
1203 int is_Cast(const ir_node *node);
1204 /** Returns true if node is a Bad node. */
1205 int is_Bad(const ir_node *node);
1206 /** Returns true if node is a NoMem node. */
1207 int is_NoMem(const ir_node *node);
1208 /** Returns true if node is a Start node. */
1209 int is_Start(const ir_node *node);
1210 /** Returns true if node is a Minus node. */
1211 int is_Minus(const ir_node *node);
1212 /** Returns true if node is a Mod node. */
1213 int is_Mod(const ir_node *node);
1214 /** Returns true if node is a Div node. */
1215 int is_Div(const ir_node *node);
1216 /** Returns true if node is a DivMod node. */
1217 int is_DivMod(const ir_node *node);
1218 /** Returns true if node is a Quot node. */
1219 int is_Quot(const ir_node *node);
1220 /** Returns true if node is an Add node. */
1221 int is_Add(const ir_node *node);
1222 /** Returns true if node is an And node. */
1223 int is_And(const ir_node *node);
1224 /** Returns true if node is an Or node. */
1225 int is_Or(const ir_node *node);
1226 /** Returns true if node is an Eor node. */
1227 int is_Eor(const ir_node *node);
1228 /** Returns true if node is a Sub node. */
1229 int is_Sub(const ir_node *node);
1230 /** Returns true if node is a Not node. */
1231 int is_Not(const ir_node *node);
1232 /** Returns true if node is a Shl node. */
1233 int is_Shl(const ir_node *node);
1234 /** Returns true if node is a Shr node. */
1235 int is_Shr(const ir_node *node);
1236 /** Returns true if node is a Shrs node. */
1237 int is_Shrs(const ir_node *node);
1238 /** Returns true if node is a Rot node. */
1239 int is_Rot(const ir_node *node);
1240 /** Returns true if node is a Psi node. */
1241 int is_Psi(const ir_node *node);
1242 /** Returns true if node is a Tuple node. */
1243 int is_Tuple(const ir_node *node);
1244 /** Returns true if the node is not a Block */
1245 int is_no_Block(const ir_node *node);
1246 /** Returns true if the node is a Block */
1247 int is_Block(const ir_node *node);
1248 /** Returns true if node is an Unknown node. */
1249 int is_Unknown(const ir_node *node);
1250 /** Returns true if node is a Return node. */
1251 int is_Return(const ir_node *node);
1252 /** Returns true if node is a Call node. */
1253 int is_Call(const ir_node *node);
1254 /** Returns true if node is a Sel node. */
1255 int is_Sel(const ir_node *node);
1256 /** Returns true if node is a Mul node. */
1257 int is_Mul(const ir_node *node);
1258 /** Returns true if node is a Mulh node. */
1259 int is_Mulh(const ir_node *node);
1260 /** Returns true if node is a Mux node or a Psi with only one condition. */
1261 int is_Mux(const ir_node *node);
1262 /** Returns true if node is a Load node. */
1263 int is_Load(const ir_node *node);
1264 /** Returns true if node is a Store node. */
1265 int is_Store(const ir_node *node);
1266 /** Returns true if node is a Sync node. */
1267 int is_Sync(const ir_node *node);
1268 /** Returns true if node is a Confirm node. */
1269 int is_Confirm(const ir_node *node);
1270 /** Returns true if node is a Pin node. */
1271 int is_Pin(const ir_node *node);
1272 /** Returns true if node is a SymConst node. */
1273 int is_SymConst(const ir_node *node);
1274 /** Returns true if node is a Cond node. */
1275 int is_Cond(const ir_node *node);
1276 /** Returns true of node is a CopyB node */
1277 int is_CopyB(const ir_node *node);
1278 /** Returns true if node is a Cmp node. */
1279 int is_Cmp(const ir_node *node);
1280 /** Returns true if node is an Alloc node */
1281 int is_Alloc(const ir_node *node);
1282 /** Returns true if a node is a Jmp node */
1283 int is_Jmp(const ir_node *node);
1284 /** Returns true if a node is a Raise node */
1285 int is_Raise(const ir_node *node);
1286 /** Returns true if a node is an ASM node */
1287 int is_ASM(const ir_node *node);
1288 /** Returns true if node is a Proj node or a Filter node in
1289 * intraprocedural view */
1290 int is_Proj(const ir_node *node);
1291 /** Returns true if the operation manipulates control flow:
1292 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1293 int is_cfop(const ir_node *node);
1295 /** Returns true if the operation manipulates interprocedural control flow:
1296 CallBegin, EndReg, EndExcept */
1297 int is_ip_cfop(const ir_node *node);
1298 /** Returns true if the operation can change the control flow because
1299 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1300 Bad. Raise is not fragile, but a unconditional jump. */
1301 int is_fragile_op(const ir_node *node);
1302 /** Returns the memory operand of fragile operations. */
1303 ir_node *get_fragile_op_mem(ir_node *node);
1304 /** Returns the result mode of a Div operation. */
1305 ir_mode *get_divop_resmod(const ir_node *node);
1307 /** Returns true if the operation is a forking control flow
1308 * operation: Cond. */
1309 int is_irn_forking(const ir_node *node);
1311 /** Return the type associated with the value produced by n
1312 * if the node remarks this type as it is the case for
1313 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1314 ir_type *get_irn_type(ir_node *n);
1316 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1318 ir_type *get_irn_type_attr(ir_node *n);
1320 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1321 ir_entity *get_irn_entity_attr(ir_node *n);
1323 /** Returns non-zero for constant-like nodes. */
1324 int is_irn_constlike(const ir_node *node);
1327 * Returns non-zero for nodes that must be always optimized
1328 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1330 int is_irn_always_opt(const ir_node *node);
1333 * Returns non-zero for nodes that are allowed to have keep-alives and
1334 * are neither Block nor PhiM.
1336 int is_irn_keep(const ir_node *node);
1339 * Returns non-zero for nodes that are always placed in the start block.
1341 int is_irn_start_block_placed(const ir_node *node);
1344 * Returns non-zero for nodes that are machine operations.
1346 int is_irn_machine_op(const ir_node *node);
1349 * Returns non-zero for nodes that are machine operands.
1351 int is_irn_machine_operand(const ir_node *node);
1354 * Returns non-zero for nodes that have the n'th user machine flag set.
1356 int is_irn_machine_user(const ir_node *node, unsigned n);
1359 * A type to express conditional jump predictions.
1362 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1363 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1364 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1365 } cond_jmp_predicate;
1367 /** Gets the string representation of the jump prediction .*/
1368 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1370 /** Returns the conditional jump prediction of a Cond node. */
1371 cond_jmp_predicate get_Cond_jmp_pred(const ir_node *cond);
1373 /** Sets a new conditional jump prediction. */
1374 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1377 * Access custom node data.
1378 * The data must have been registered with
1379 * register_additional_node_data() before.
1380 * @param node The ir node to get the data from.
1381 * @param type The type of the data you registered.
1382 * @param off The value returned by register_additional_node_data().
1383 * @return A pointer of type @p type.
1385 #define get_irn_data(node,type,off) \
1386 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1389 * Get the pointer to the node some custom data belongs to.
1390 * @param data The pointer to the custom data.
1391 * @param off The number as returned by register_additional_node_data().
1392 * @return A pointer to the ir node the custom data belongs to.
1394 #define get_irn_data_base(data,off) \
1395 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1398 * Request additional data to be allocated with an ir node.
1399 * @param size The size of the additional data required.
1400 * @return A positive number, if the operation was successful, which
1401 * must be passed to the access macro get_irn_data(), 0 if the
1402 * registration failed.
1404 unsigned firm_register_additional_node_data(unsigned size);
1407 * Return a pointer to the node attributes.
1408 * Needed for user-defined nodes.
1410 void *get_irn_generic_attr(ir_node *node);
1411 const void *get_irn_generic_attr_const(const ir_node *node);
1414 * Returns the unique node index for the node in its graph.
1415 * This index is used to access phase information for this node.
1417 unsigned get_irn_idx(const ir_node *node);
1420 * Sets the debug information of a node.
1422 * @param n The node.
1423 * @param db The debug info.
1425 void set_irn_dbg_info(ir_node *n, dbg_info *db);
1428 * Returns the debug information of an node.
1430 * @param n The node.
1432 dbg_info *get_irn_dbg_info(const ir_node *n);
1434 /*-----------------------------------------------------------------*/
1436 /*-----------------------------------------------------------------*/
1439 /** Debug print the node.
1441 * Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
1442 * is set. Else does nothing. */
1443 void dump_irn(ir_node *n);
1445 /*@}*/ /* end of ir_node group definition */