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(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(ir_node *node, int pos);
364 int get_Block_matured(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 /* Set and remove interprocedural predecessors. If the interprocedural
385 * predecessors are removed, the node has the same predecessors in
387 * @@@ Maybe better: arity is zero if no cg preds. */
388 void set_Block_cg_cfgpred_arr(ir_node *node, int arity, ir_node *in[]);
389 void set_Block_cg_cfgpred(ir_node *node, int pos, ir_node *pred);
390 /* @@@ not supported */
391 ir_node **get_Block_cg_cfgpred_arr(ir_node *node);
392 /** Returns the number of interprocedural predecessors. 0 if none. */
393 int get_Block_cg_n_cfgpreds(ir_node *node);
394 /** Return the interprocedural predecessor at position pos. */
395 ir_node *get_Block_cg_cfgpred(ir_node *node, int pos);
396 /** Frees the memory allocated for interprocedural predecessors. */
397 void remove_Block_cg_cfgpred_arr(ir_node *node);
398 /** Returns the extended basic block a block belongs to. */
399 ir_extblk *get_Block_extbb(const ir_node *block);
400 /** Sets the extended basic block a block belongs to. */
401 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
402 /** Get the Macro Block header of a (sub-) block. */
403 ir_node *get_Block_MacroBlock(const ir_node *block);
404 /** Returns the ir_graph this Block belongs to. */
405 ir_graph *get_Block_irg(const ir_node *block);
406 /** Returns non-zero if the block has an assigned label. */
407 int has_Block_label(const ir_node *block);
408 /** Returns the label of a Block. */
409 ir_label_t get_Block_label(const ir_node *block);
410 /** Sets a label to a block. */
411 void set_Block_label(ir_node *block, ir_label_t label);
413 /** Return the number of Keep alive node. */
414 int get_End_n_keepalives(ir_node *end);
415 /** Return the Keep alive node a position pos. */
416 ir_node *get_End_keepalive(ir_node *end, int pos);
417 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
418 void add_End_keepalive(ir_node *end, ir_node *ka);
419 /** Set the Keep alive node at position pos. */
420 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
421 /** Set new keep-alives. */
422 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
423 /** Set new keep-alives from old keep-alives, skipping irn. */
424 void remove_End_keepalive(ir_node *end, ir_node *irn);
426 /** Some parts of the End node are allocated separately -- their memory
427 is not recovered by dead_node_elimination if a End node is dead.
428 free_End() frees these data structures. */
429 void free_End(ir_node *end);
431 /** Return the target address of an IJmp */
432 ir_node *get_IJmp_target(ir_node *ijmp);
433 /** Sets the target address of an IJmp */
434 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
436 /* We distinguish three kinds of Cond nodes. These can be distinguished
437 by the mode of the selector operand and an internal flag of type cond_kind.
438 First we distinguish binary Conds and switch Conds.
439 A binary Cond has as selector a boolean value. Proj(0) projects the control
440 flow for case "False", Proj(1) the control flow for "True". A binary Cond
441 is recognized by the boolean selector.
442 The switch Cond has as selector an unsigned integer. It produces as result
443 an n+1 Tuple (cf0, ... , cfn) of control flows.
444 We differ two flavors of this Cond. The first, the dense Cond, passes
445 control along output i if the selector value is i, 0 <= i <= n. If the
446 selector value is >n it passes control along output n.
447 The second Cond flavor differences in the treatment of cases not specified in
448 the source program. It magically knows about the existence of Proj nodes.
449 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
450 exists. Else it passes control along output n (even if this Proj does not
451 exist.) This Cond we call "fragmentary". There is a special constructor
452 new_defaultProj that automatically sets the flavor.
453 The two switch flavors are distinguished by a flag of type cond_kind.
454 Default flavor is "dense"
457 dense, /**< Default. Missing Proj nodes are dead control flow. */
458 fragmentary /**< Special. No control flow optimizations allowed. Missing
459 Proj nodes mean default control flow, i.e., Proj(n). */
462 ir_node *get_Cond_selector(ir_node *node);
463 void set_Cond_selector(ir_node *node, ir_node *selector);
464 cond_kind get_Cond_kind(ir_node *node);
465 void set_Cond_kind(ir_node *node, cond_kind kind);
466 long get_Cond_defaultProj(ir_node *node);
469 * Projection numbers for conditions.
472 pn_Cond_false, /**< Control flow if operand is "false". */
473 pn_Cond_true, /**< Control flow if operand is "true". */
474 pn_Cond_max /**< number of projections from a Cond */
475 } pn_Cond; /* Projection numbers for Cond. */
477 ir_node *get_Return_mem(ir_node *node);
478 void set_Return_mem(ir_node *node, ir_node *mem);
479 ir_node **get_Return_res_arr(ir_node *node);
480 int get_Return_n_ress(ir_node *node);
481 ir_node *get_Return_res(ir_node *node, int pos);
482 void set_Return_res(ir_node *node, int pos, ir_node *res);
484 tarval *get_Const_tarval(const ir_node *node);
485 void set_Const_tarval(ir_node *node, tarval *con);
487 int is_Const_null(const ir_node *node);
489 int is_Const_one(const ir_node *node);
491 int is_Const_all_one(const ir_node *node);
493 /** Returns the source language type of a Const node.
494 * Must be an atomic type. Mode of type must be mode of node.
496 ir_type *get_Const_type(ir_node *node);
498 /** Sets the source language type of a Const node. */
499 void set_Const_type(ir_node *node, ir_type *tp);
501 /** This enum names the three different kinds of symbolic Constants
502 represented by SymConst. The content of the attribute type_or_id
503 depends on this tag. Use the proper access routine after testing
506 symconst_type_tag, /**< The SymConst is a type tag for the given type.
507 symconst_symbol is type *. */
508 symconst_type_size, /**< The SymConst is the size of the given type.
509 symconst_symbol is type *. */
510 symconst_type_align, /**< The SymConst is the alignment of the given type.
511 symconst_symbol is type *. */
512 symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
513 by the linker. The pointer is represented by a string.
514 symconst_symbol is ident *. */
515 symconst_addr_ent, /**< The SymConst is a symbolic pointer to be filled in
516 by the linker. The pointer is represented by an entity.
517 symconst_symbol is entity *. */
518 symconst_ofs_ent, /**< The SymConst is the offset of its entity in the entities
520 symconst_enum_const, /**< The SymConst is a enumeration constant of an
522 symconst_label /**< The SymConst is a label address. */
525 /** Returns non-zero if s symconst kind has a type attribute */
526 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
528 /** Returns non-zero if s symconst kind has an ident attribute */
529 #define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)
531 /** Returns non-zero if s symconst kind has an entity attribute */
532 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
534 /** Returns non-zero if s symconst kind has an enum_const attribute */
535 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
537 /** Returns non-zero if s symconst kind has a label attribute */
538 #define SYMCONST_HAS_LABEL(kind) ((kind) == symconst_label)
540 /** SymConst attribute.
542 * This union contains the symbolic information represented by the node.
544 typedef union symconst_symbol {
545 ir_type *type_p; /**< The type of a SymConst. */
546 ident *ident_p; /**< The ident of a SymConst. */
547 ir_entity *entity_p; /**< The entity of a SymConst. */
548 ir_enum_const *enum_p; /**< The enumeration constant of a SymConst. */
549 ir_label_t label; /**< The label of a SymConst. */
552 /** Get the kind of the SymConst. */
553 symconst_kind get_SymConst_kind(const ir_node *node);
554 /** Set the kind of the SymConst. */
555 void set_SymConst_kind(ir_node *node, symconst_kind num);
557 /** Only to access SymConst of kind type_tag or size. Else assertion: */
558 ir_type *get_SymConst_type(ir_node *node);
559 void set_SymConst_type(ir_node *node, ir_type *tp);
561 /** Only to access SymConst of kind addr_name. Else assertion: */
562 ident *get_SymConst_name(const ir_node *node);
563 void set_SymConst_name(ir_node *node, ident *name);
565 /** Only to access SymConst of kind addr_ent. Else assertion: */
566 ir_entity *get_SymConst_entity(const ir_node *node);
567 void set_SymConst_entity(ir_node *node, ir_entity *ent);
569 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
570 ir_enum_const *get_SymConst_enum(const ir_node *node);
571 void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
573 /** Sets both: type and ptrinfo. Needed to treat the node independent of
574 its semantics. Does a memcpy for the memory sym points to. */
575 /* write 'union': firmjni then does not create a method... */
576 union symconst_symbol get_SymConst_symbol(const ir_node *node);
577 void set_SymConst_symbol(ir_node *node,
578 union symconst_symbol sym);
580 /** Only to access SymConst of kind symconst_label. Else assertion: */
581 ir_label_t get_SymConst_label(const ir_node *node);
582 void set_SymConst_label(ir_node *node, ir_label_t label);
585 /** Access the type of the value represented by the SymConst.
587 * Example: primitive type int for SymConst size. */
588 ir_type *get_SymConst_value_type(ir_node *node);
589 void set_SymConst_value_type(ir_node *node, ir_type *tp);
591 ir_node *get_Sel_mem(ir_node *node);
592 void set_Sel_mem(ir_node *node, ir_node *mem);
593 ir_node *get_Sel_ptr(ir_node *node); /* ptr to the object to select from */
594 void set_Sel_ptr(ir_node *node, ir_node *ptr);
595 ir_node **get_Sel_index_arr(ir_node *node);
596 int get_Sel_n_indexs(ir_node *node);
597 ir_node *get_Sel_index(ir_node *node, int pos);
598 void set_Sel_index(ir_node *node, int pos, ir_node *index);
599 ir_entity *get_Sel_entity(ir_node *node); /* entity to select */
600 void set_Sel_entity (ir_node *node, ir_entity *ent);
603 * Projection numbers for result of Call node: use for Proj nodes!
606 pn_Call_M_regular = pn_Generic_M_regular, /**< The memory result. */
607 pn_Call_X_regular = pn_Generic_X_regular, /**< The control flow result when no exception occurs. */
608 pn_Call_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler. */
609 pn_Call_T_result = pn_Generic_other, /**< The tuple containing all (0, 1, 2, ...) results. */
610 pn_Call_M_except, /**< The memory result in case the called method terminated with
612 pn_Call_P_value_res_base, /**< A pointer to the memory region containing copied results
613 passed by value (for compound result types). */
614 pn_Call_max /**< number of projections from a Call */
615 } pn_Call; /* Projection numbers for Call. */
616 #define pn_Call_M pn_Call_M_regular
618 ir_node *get_Call_mem(ir_node *node);
619 void set_Call_mem(ir_node *node, ir_node *mem);
620 ir_node *get_Call_ptr(ir_node *node);
621 void set_Call_ptr(ir_node *node, ir_node *ptr);
622 ir_node **get_Call_param_arr(ir_node *node);
623 /** Gets the number of parameters of a call. */
624 int get_Call_n_params(ir_node *node);
625 /** Gets the call parameter at position pos. */
626 ir_node *get_Call_param(ir_node *node, int pos);
627 /** Sets the call parameter at position pos. */
628 void set_Call_param(ir_node *node, int pos, ir_node *param);
629 /** Gets the type of a call. */
630 ir_type *get_Call_type(ir_node *node);
631 /** Sets the type of a call. */
632 void set_Call_type(ir_node *node, ir_type *tp);
633 /** Gets the arity of a call. Identical to get_Call_n_params(). */
634 int get_Call_arity(ir_node *node);
636 /** Set, get and remove the callee information for a Call node.
638 * The callee information lists all method entities that can be called
639 * from this node. If the address expression can not be analyzed fully,
640 * e.g., as entities can be called that are not in the compilation unit,
641 * the array contains the unknown_entity. The array contains only entities
642 * with peculiarity_existent, but with all kinds of visibility. The entities
643 * not necessarily contain an irg.
645 * The array is only accessible if callee information is valid. See flag
648 * The memory allocated for the array is managed automatically, i.e., it must
649 * not be freed if the Call node is removed from the graph.
651 * @param node A Call node.
653 int Call_has_callees(ir_node *node);
654 int get_Call_n_callees(ir_node *node);
655 ir_entity *get_Call_callee(ir_node *node, int pos);
657 /** Set the full callee array.
659 * The passed array is copied. Assumes current_ir_graph set properly! */
660 void set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
661 void remove_Call_callee_arr(ir_node *node);
663 ir_node *get_CallBegin_ptr(ir_node *node);
664 void set_CallBegin_ptr(ir_node *node, ir_node *ptr);
665 ir_node *get_CallBegin_call(ir_node *node);
666 void set_CallBegin_call(ir_node *node, ir_node *call);
668 /* For unary and binary arithmetic operations the access to the
669 operands can be factored out. Left is the first, right the
670 second arithmetic value as listed in tech report 1999-44.
671 unops are: Minus, Abs, Not, Conv, Cast
672 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
673 Shr, Shrs, Rot, Cmp */
674 int is_unop(const ir_node *node);
675 ir_node *get_unop_op(const ir_node *node);
676 void set_unop_op(ir_node *node, ir_node *op);
677 int is_binop(const ir_node *node);
678 ir_node *get_binop_left(const ir_node *node);
679 void set_binop_left(ir_node *node, ir_node *left);
680 ir_node *get_binop_right(const ir_node *node);
681 void set_binop_right(ir_node *node, ir_node *right);
683 ir_node *get_Add_left(const ir_node *node);
684 void set_Add_left(ir_node *node, ir_node *left);
685 ir_node *get_Add_right(const ir_node *node);
686 void set_Add_right(ir_node *node, ir_node *right);
688 ir_node *get_Sub_left(const ir_node *node);
689 void set_Sub_left(ir_node *node, ir_node *left);
690 ir_node *get_Sub_right(const ir_node *node);
691 void set_Sub_right(ir_node *node, ir_node *right);
693 ir_node *get_Minus_op(const ir_node *node);
694 void set_Minus_op(ir_node *node, ir_node *op);
696 ir_node *get_Mul_left(const ir_node *node);
697 void set_Mul_left(ir_node *node, ir_node *left);
698 ir_node *get_Mul_right(const ir_node *node);
699 void set_Mul_right(ir_node *node, ir_node *right);
701 ir_node *get_Mulh_left(const ir_node *node);
702 void set_Mulh_left(ir_node *node, ir_node *left);
703 ir_node *get_Mulh_right(const ir_node *node);
704 void set_Mulh_right(ir_node *node, ir_node *right);
706 ir_node *get_Quot_left(const ir_node *node);
707 void set_Quot_left(ir_node *node, ir_node *left);
708 ir_node *get_Quot_right(const ir_node *node);
709 void set_Quot_right(ir_node *node, ir_node *right);
710 ir_node *get_Quot_mem(ir_node *node);
711 void set_Quot_mem(ir_node *node, ir_node *mem);
712 ir_mode *get_Quot_resmode(const ir_node *node);
713 void set_Quot_resmode(ir_node *node, ir_mode *mode);
716 * Projection numbers for Quot: use for Proj nodes!
719 pn_Quot_M = pn_Generic_M_regular, /**< Memory result. */
720 pn_Quot_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
721 pn_Quot_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
722 pn_Quot_res = pn_Generic_other, /**< Result of computation. */
723 pn_Quot_max /**< number of projections from a Quot */
724 } pn_Quot; /* Projection numbers for Quot. */
726 ir_node *get_DivMod_left(const ir_node *node);
727 void set_DivMod_left(ir_node *node, ir_node *left);
728 ir_node *get_DivMod_right(const ir_node *node);
729 void set_DivMod_right(ir_node *node, ir_node *right);
730 ir_node *get_DivMod_mem(ir_node *node);
731 void set_DivMod_mem(ir_node *node, ir_node *mem);
732 ir_mode *get_DivMod_resmode(const ir_node *node);
733 void set_DivMod_resmode(ir_node *node, ir_mode *mode);
736 * Projection numbers for DivMod: use for Proj nodes!
739 pn_DivMod_M = pn_Generic_M_regular, /**< Memory result. */
740 pn_DivMod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
741 pn_DivMod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
742 pn_DivMod_res_div = pn_Generic_other, /**< Result of computation a / b. */
743 pn_DivMod_res_mod, /**< Result of computation a % b. */
744 pn_DivMod_max /**< number of projections from a DivMod */
745 } pn_DivMod; /* Projection numbers for DivMod. */
747 ir_node *get_Div_left(const ir_node *node);
748 void set_Div_left(ir_node *node, ir_node *left);
749 ir_node *get_Div_right(const ir_node *node);
750 void set_Div_right(ir_node *node, ir_node *right);
751 ir_node *get_Div_mem(ir_node *node);
752 void set_Div_mem(ir_node *node, ir_node *mem);
753 ir_mode *get_Div_resmode(const ir_node *node);
754 void set_Div_resmode(ir_node *node, ir_mode *mode);
757 * Projection numbers for Div: use for Proj nodes!
760 pn_Div_M = pn_Generic_M_regular, /**< Memory result. */
761 pn_Div_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
762 pn_Div_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
763 pn_Div_res = pn_Generic_other, /**< Result of computation. */
764 pn_Div_max /**< number of projections from a Div */
765 } pn_Div; /* Projection numbers for Div. */
767 ir_node *get_Mod_left(const ir_node *node);
768 void set_Mod_left(ir_node *node, ir_node *left);
769 ir_node *get_Mod_right(const ir_node *node);
770 void set_Mod_right(ir_node *node, ir_node *right);
771 ir_node *get_Mod_mem(ir_node *node);
772 void set_Mod_mem(ir_node *node, ir_node *mem);
773 ir_mode *get_Mod_resmode(const ir_node *node);
774 void set_Mod_resmode(ir_node *node, ir_mode *mode);
777 * Projection numbers for Mod: use for Proj nodes!
780 pn_Mod_M = pn_Generic_M_regular, /**< Memory result. */
781 pn_Mod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
782 pn_Mod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
783 pn_Mod_res = pn_Generic_other, /**< Result of computation. */
784 pn_Mod_max /**< number of projections from a Mod */
785 } pn_Mod; /* Projection numbers for Mod. */
787 ir_node *get_Abs_op(const ir_node *node);
788 void set_Abs_op(ir_node *node, ir_node *op);
790 ir_node *get_And_left(const ir_node *node);
791 void set_And_left(ir_node *node, ir_node *left);
792 ir_node *get_And_right(const ir_node *node);
793 void set_And_right(ir_node *node, ir_node *right);
795 ir_node *get_Or_left(const ir_node *node);
796 void set_Or_left(ir_node *node, ir_node *left);
797 ir_node *get_Or_right(const ir_node *node);
798 void set_Or_right(ir_node *node, ir_node *right);
800 ir_node *get_Eor_left(const ir_node *node);
801 void set_Eor_left(ir_node *node, ir_node *left);
802 ir_node *get_Eor_right(const ir_node *node);
803 void set_Eor_right(ir_node *node, ir_node *right);
805 ir_node *get_Not_op(const ir_node *node);
806 void set_Not_op(ir_node *node, ir_node *op);
809 * Projection numbers for Cmp are defined several times.
810 * The bit patterns are used for various tests, so don't change.
811 * The "unordered" values are possible results of comparing
812 * floating point numbers.
813 * Note that the encoding is imported, so do NOT change the order.
816 pn_Cmp_False = 0, /**< false */
817 pn_Cmp_Eq = 1, /**< equal */
818 pn_Cmp_Lt = 2, /**< less */
819 pn_Cmp_Le = pn_Cmp_Eq|pn_Cmp_Lt, /**< less or equal */
820 pn_Cmp_Gt = 4, /**< greater */
821 pn_Cmp_Ge = pn_Cmp_Eq|pn_Cmp_Gt, /**< greater or equal */
822 pn_Cmp_Lg = pn_Cmp_Lt|pn_Cmp_Gt, /**< less or greater */
823 pn_Cmp_Leg = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
824 pn_Cmp_Uo = 8, /**< unordered */
825 pn_Cmp_Ue = pn_Cmp_Uo|pn_Cmp_Eq, /**< unordered or equal */
826 pn_Cmp_Ul = pn_Cmp_Uo|pn_Cmp_Lt, /**< unordered or less */
827 pn_Cmp_Ule = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
828 pn_Cmp_Ug = pn_Cmp_Uo|pn_Cmp_Gt, /**< unordered or greater */
829 pn_Cmp_Uge = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
830 pn_Cmp_Ne = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
831 pn_Cmp_True = 15 /**< true */
832 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for JNI interface */
833 } pn_Cmp; /* Projection numbers for Cmp */
834 /* #define not_mask pn_Cmp_Leg */
836 /** returns the pnc name from an pnc constant */
837 const char *get_pnc_string(int pnc);
839 /** Calculates the negated (Complement(R)) pnc condition. */
840 int get_negated_pnc(int pnc, ir_mode *mode);
842 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
843 int get_inversed_pnc(int pnc);
845 /** An alternative name for get_inversed_pnc() that can be better memorized. */
846 #define get_mirrored_pnc(pnc) get_inversed_pnc(pnc)
848 ir_node *get_Cmp_left(const ir_node *node);
849 void set_Cmp_left(ir_node *node, ir_node *left);
850 ir_node *get_Cmp_right(const ir_node *node);
851 void set_Cmp_right(ir_node *node, ir_node *right);
853 ir_node *get_Shl_left(const ir_node *node);
854 void set_Shl_left(ir_node *node, ir_node *left);
855 ir_node *get_Shl_right(const ir_node *node);
856 void set_Shl_right(ir_node *node, ir_node *right);
858 ir_node *get_Shr_left(const ir_node *node);
859 void set_Shr_left(ir_node *node, ir_node *left);
860 ir_node *get_Shr_right(const ir_node *node);
861 void set_Shr_right(ir_node *node, ir_node *right);
863 ir_node *get_Shrs_left(const ir_node *node);
864 void set_Shrs_left(ir_node *node, ir_node *left);
865 ir_node *get_Shrs_right(const ir_node *node);
866 void set_Shrs_right(ir_node *node, ir_node *right);
868 ir_node *get_Rot_left(const ir_node *node);
869 void set_Rot_left(ir_node *node, ir_node *left);
870 ir_node *get_Rot_right(const ir_node *node);
871 void set_Rot_right(ir_node *node, ir_node *right);
873 ir_node *get_Conv_op(const ir_node *node);
874 void set_Conv_op(ir_node *node, ir_node *op);
875 int get_Conv_strict(ir_node *node);
876 void set_Conv_strict(ir_node *node, int flag);
878 /* Does Cast need a mem operator?
879 * Cast should only depend on the type, not on the state of an
880 * entity. But: we initialize various fields after Alloc, that
881 * are accessed in the cast. This required some precaution, to
882 * get the right memory into the Loads generated from the cast.
884 ir_node *get_Cast_op(const ir_node *node);
885 void set_Cast_op(ir_node *node, ir_node *op);
886 ir_type *get_Cast_type(ir_node *node);
887 void set_Cast_type(ir_node *node, ir_type *to_tp);
889 /** Checks for upcast.
891 * Returns true if the Cast node casts a class type to a super type.
892 * Works also for pointers to classes (recursively).
894 * Needs typeinfo calculated.
896 int is_Cast_upcast(ir_node *node);
898 /** Checks for downcast.
900 * Returns true if the Cast node casts a class type to a sub type.
901 * Works also for pointers to classes (recursively).
903 * Needs typeinfo calculated.
905 int is_Cast_downcast(ir_node *node);
908 /** Returns true if n is Phi or Filter in interprocedural_view.
909 Returns false if irg in phase building and the Phi has zero
910 predecessors: it's a Phi0. */
911 int is_Phi(const ir_node *n);
912 /** Returns true if irg in phase building and the Phi has zero
913 predecessors. It's a Phi0 then. */
914 int is_Phi0(const ir_node *n);
915 /* These routines also work for Filter nodes in interprocedural view. */
916 ir_node **get_Phi_preds_arr(ir_node *node);
917 int get_Phi_n_preds(const ir_node *node);
918 ir_node *get_Phi_pred(const ir_node *node, int pos);
919 void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
921 ir_node *get_Filter_pred(ir_node *node);
922 void set_Filter_pred(ir_node *node, ir_node *pred);
923 long get_Filter_proj(ir_node *node);
924 void set_Filter_proj(ir_node *node, long proj);
925 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
926 * @@@ Maybe better: arity is zero if no cg preds. */
927 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
928 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
929 int get_Filter_n_cg_preds(ir_node *node);
930 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
932 /** Return true if parameter is a memory operation.
934 * A memory operation is an operation that changes the
935 * memory. I.e., a Load or a Store operation.
937 int is_memop(ir_node *node);
938 ir_node *get_memop_mem(ir_node *node);
939 void set_memop_mem(ir_node *node, ir_node *mem);
940 ir_node *get_memop_ptr(ir_node *node);
941 void set_memop_ptr(ir_node *node, ir_node *ptr);
944 * Projection numbers for Load: use for Proj nodes!
947 pn_Load_M = pn_Generic_M_regular, /**< Memory result. */
948 pn_Load_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
949 pn_Load_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
950 pn_Load_res = pn_Generic_other, /**< Result of load operation. */
951 pn_Load_max /**< number of projections from a Load */
952 } pn_Load; /* Projection numbers for Load. */
954 ir_node *get_Load_mem(ir_node *node);
955 void set_Load_mem(ir_node *node, ir_node *mem);
956 ir_node *get_Load_ptr(ir_node *node);
957 void set_Load_ptr(ir_node *node, ir_node *ptr);
958 ir_mode *get_Load_mode(ir_node *node);
959 void set_Load_mode(ir_node *node, ir_mode *mode);
960 ir_volatility get_Load_volatility(ir_node *node);
961 void set_Load_volatility(ir_node *node, ir_volatility volatility);
962 ir_align get_Load_align(ir_node *node);
963 void set_Load_align(ir_node *node, ir_align align);
966 * Projection numbers for Store: use for Proj nodes!
969 pn_Store_M = pn_Generic_M_regular, /**< Memory result. */
970 pn_Store_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
971 pn_Store_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
972 pn_Store_max = pn_Generic_other /**< number of projections from a Store */
973 } pn_Store; /* Projection numbers for Store. */
975 ir_node *get_Store_mem(ir_node *node);
976 void set_Store_mem(ir_node *node, ir_node *mem);
977 ir_node *get_Store_ptr(ir_node *node);
978 void set_Store_ptr(ir_node *node, ir_node *ptr);
979 ir_node *get_Store_value(ir_node *node);
980 void set_Store_value(ir_node *node, ir_node *value);
981 ir_volatility get_Store_volatility(ir_node *node);
982 void set_Store_volatility(ir_node *node, ir_volatility volatility);
983 ir_align get_Store_align(ir_node *node);
984 void set_Store_align(ir_node *node, ir_align align);
987 * Projection numbers for Alloc: use for Proj nodes!
990 pn_Alloc_M = pn_Generic_M_regular, /**< Memory result. */
991 pn_Alloc_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
992 pn_Alloc_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
993 pn_Alloc_res = pn_Generic_other, /**< Result of allocation. */
994 pn_Alloc_max /**< number of projections from an Alloc */
995 } pn_Alloc; /* Projection numbers for Alloc. */
997 ir_node *get_Alloc_mem(ir_node *node);
998 void set_Alloc_mem(ir_node *node, ir_node *mem);
999 ir_node *get_Alloc_size(ir_node *node);
1000 void set_Alloc_size(ir_node *node, ir_node *size);
1001 ir_type *get_Alloc_type(ir_node *node);
1002 void set_Alloc_type(ir_node *node, ir_type *tp);
1004 /** The allocation place. */
1006 stack_alloc, /**< Alloc allocates the object on the stack. */
1007 heap_alloc /**< Alloc allocates the object on the heap. */
1010 where_alloc get_Alloc_where(ir_node *node);
1011 void set_Alloc_where(ir_node *node, where_alloc where);
1013 ir_node *get_Free_mem(ir_node *node);
1014 void set_Free_mem(ir_node *node, ir_node *mem);
1015 ir_node *get_Free_ptr(ir_node *node);
1016 void set_Free_ptr(ir_node *node, ir_node *ptr);
1017 ir_node *get_Free_size(ir_node *node);
1018 void set_Free_size(ir_node *node, ir_node *size);
1019 ir_type *get_Free_type(ir_node *node);
1020 void set_Free_type(ir_node *node, ir_type *tp);
1022 where_alloc get_Free_where(ir_node *node);
1023 void set_Free_where(ir_node *node, where_alloc where);
1025 ir_node **get_Sync_preds_arr(ir_node *node);
1026 int get_Sync_n_preds(ir_node *node);
1027 ir_node *get_Sync_pred(ir_node *node, int pos);
1028 void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
1029 void add_Sync_pred(ir_node *node, ir_node *pred);
1031 /** Returns the source language type of a Proj node.
1032 * Must be an atomic type. Mode of type must be mode of node.
1034 ir_type *get_Proj_type(ir_node *node);
1036 /** Return the predecessor of a Proj node. */
1037 ir_node *get_Proj_pred(const ir_node *node);
1038 void set_Proj_pred(ir_node *node, ir_node *pred);
1039 /** Return the projection number of a Proj node. */
1040 long get_Proj_proj(const ir_node *node);
1041 void set_Proj_proj(ir_node *node, long proj);
1043 ir_node **get_Tuple_preds_arr(ir_node *node);
1044 int get_Tuple_n_preds(ir_node *node);
1045 ir_node *get_Tuple_pred(ir_node *node, int pos);
1046 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
1048 ir_node *get_Id_pred(ir_node *node);
1049 void set_Id_pred(ir_node *node, ir_node *pred);
1051 /** Confirm has a single result and returns 'value' unchanged.
1052 * The node expresses a restriction on 'value':
1053 * 'value' 'cmp' 'bound' == true. */
1054 ir_node *get_Confirm_value(ir_node *node);
1055 void set_Confirm_value(ir_node *node, ir_node *value);
1056 ir_node *get_Confirm_bound(ir_node *node);
1057 void set_Confirm_bound(ir_node *node, ir_node *bound);
1058 pn_Cmp get_Confirm_cmp(const ir_node *node);
1059 void set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
1062 * Mux Support: Note that Psi nodes with one condition can be handled
1063 * like Mux nodes, and the access functions work as expected.
1065 ir_node *get_Mux_sel(ir_node *node);
1066 void set_Mux_sel(ir_node *node, ir_node *sel);
1067 ir_node *get_Mux_false(ir_node *node);
1068 void set_Mux_false(ir_node *node, ir_node *ir_false);
1069 ir_node *get_Mux_true (ir_node *node);
1070 void set_Mux_true (ir_node *node, ir_node *ir_true);
1072 ir_node *get_Psi_cond(ir_node *node, int pos);
1073 void set_Psi_cond(ir_node *node, int pos, ir_node *cond);
1074 ir_node *get_Psi_val(ir_node *node, int pos);
1075 void set_Psi_val(ir_node *node, int pos, ir_node *val);
1076 ir_node *get_Psi_default(ir_node *node);
1077 void set_Psi_default(ir_node *node, ir_node *val);
1078 int get_Psi_n_conds(ir_node *node);
1081 * Projection numbers for result of CopyB node: use for Proj nodes!
1084 pn_CopyB_M_regular = pn_Generic_M_regular, /**< The memory result. */
1085 pn_CopyB_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1086 pn_CopyB_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1087 pn_CopyB_M_except = pn_Generic_other, /**< The memory result in case the runtime function terminated with
1089 pn_CopyB_max /**< number of projections from a CopyB */
1090 } pn_CopyB; /* Projection numbers for CopyB. */
1091 #define pn_CopyB_M pn_CopyB_M_regular
1093 ir_node *get_CopyB_mem(ir_node *node);
1094 void set_CopyB_mem(ir_node *node, ir_node *mem);
1095 ir_node *get_CopyB_dst(ir_node *node);
1096 void set_CopyB_dst(ir_node *node, ir_node *dst);
1097 ir_node *get_CopyB_src(ir_node *node);
1098 void set_CopyB_src(ir_node *node, ir_node *src);
1099 ir_type *get_CopyB_type(ir_node *node);
1100 void set_CopyB_type(ir_node *node, ir_type *data_type);
1103 * Projection numbers for result of InstOf node: use for Proj nodes!
1106 pn_InstOf_M_regular = pn_Generic_M_regular, /**< The memory result. */
1107 pn_InstOf_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1108 pn_InstOf_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1109 pn_InstOf_res = pn_Generic_other, /**< The checked object pointer. */
1110 pn_InstOf_M_except, /**< The memory result in case the runtime function terminated with
1112 pn_InstOf_max /**< number of projections from an InstOf */
1114 #define pn_InstOf_M pn_InstOf_M_regular
1116 /** InstOf access */
1117 ir_type *get_InstOf_type(ir_node *node);
1118 void set_InstOf_type(ir_node *node, ir_type *type);
1119 ir_node *get_InstOf_store(ir_node *node);
1120 void set_InstOf_store(ir_node *node, ir_node *obj);
1121 ir_node *get_InstOf_obj(ir_node *node);
1122 void set_InstOf_obj(ir_node *node, ir_node *obj);
1125 * Projection numbers for Raise.
1128 pn_Raise_X = 0, /**< The control flow to the exception handler. */
1129 pn_Raise_M = 1, /**< The Memory result. */
1130 pn_Raise_max /**< number of projections from a Raise */
1131 } pn_Raise; /* Projection numbers for Raise. */
1133 ir_node *get_Raise_mem(ir_node *node);
1134 void set_Raise_mem(ir_node *node, ir_node *mem);
1135 ir_node *get_Raise_exo_ptr(ir_node *node); /* PoinTeR to EXception Object */
1136 void set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
1139 * Projection numbers for result of Bound node: use for Proj nodes!
1142 pn_Bound_M = pn_Generic_M_regular, /**< The memory result. */
1143 pn_Bound_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1144 pn_Bound_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1145 pn_Bound_res = pn_Generic_other, /**< The checked index. */
1146 pn_Bound_max /**< number of projections from a Bound */
1149 /** Returns the memory input of a Bound operation. */
1150 ir_node *get_Bound_mem(ir_node *bound);
1151 void set_Bound_mem(ir_node *bound, ir_node *mem);
1153 /** Returns the index input of a Bound operation. */
1154 ir_node *get_Bound_index(ir_node *bound);
1155 void set_Bound_index(ir_node *bound, ir_node *idx);
1157 /** Returns the lower bound input of a Bound operation. */
1158 ir_node *get_Bound_lower(ir_node *bound);
1159 void set_Bound_lower(ir_node *bound, ir_node *lower);
1161 /** Returns the upper bound input of a Bound operation. */
1162 ir_node *get_Bound_upper(ir_node *bound);
1163 void set_Bound_upper(ir_node *bound, ir_node *upper);
1165 /** Return the operand of a Pin node. */
1166 ir_node *get_Pin_op(const ir_node *pin);
1167 void set_Pin_op(ir_node *pin, ir_node *node);
1169 /** A input/output constraint attribute */
1171 unsigned pos; /**< The inputs/output position for this constraint. */
1172 ident *constraint; /**< The constraint for this input/output. */
1173 } ir_asm_constraint;
1175 /** Return the assembler text of an ASM pseudo node. */
1176 ident *get_ASM_text(const ir_node *node);
1177 /** Return the number of input constraints for an ASM node. */
1178 int get_ASM_n_input_constraints(const ir_node *node);
1179 /** Return the input constraints for an ASM node. */
1180 const ir_asm_constraint *get_ASM_input_constraints(const ir_node *node);
1181 /** Return the number of output constraints for an ASM node. */
1182 int get_ASM_n_output_constraints(const ir_node *node);
1183 /** Return the output constraints for an ASM node. */
1184 const ir_asm_constraint *get_ASM_output_constraints(const ir_node *node);
1185 /** Return the number of clobbered registers for an ASM node. */
1186 int get_ASM_n_clobbers(const ir_node *node);
1187 /** Return the list of clobbered registers for an ASM node. */
1188 ident **get_ASM_clobbers(const ir_node *node);
1192 * NAME Auxiliary routines
1196 /** Returns operand of node if node is a Proj. */
1197 ir_node *skip_Proj(ir_node *node);
1198 /** Returns operand of node if node is a Proj. */
1199 const ir_node *skip_Proj_const(const ir_node *node);
1200 /** Returns operand of node if node is a Id. */
1201 ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
1202 /** Returns corresponding operand of Tuple if node is a Proj from
1204 ir_node *skip_Tuple(ir_node *node);
1205 /** returns operand of node if node is a Cast. */
1206 ir_node *skip_Cast(ir_node *node);
1207 /** Returns operand of node if node is a Confirm */
1208 ir_node *skip_Confirm(ir_node *node);
1209 /** Skip all high-level Operations. */
1210 ir_node *skip_HighLevel(ir_node *node);
1211 /** Returns true if irn is a Const node. */
1212 int is_Const(const ir_node *node);
1213 /** Returns true if a node is a Conv node. */
1214 int is_Conv(const ir_node *node);
1215 /** Returns true if a node is a Cast node. */
1216 int is_Cast(const ir_node *node);
1217 /** Returns true if node is a Bad node. */
1218 int is_Bad(const ir_node *node);
1219 /** Returns true if node is a NoMem node. */
1220 int is_NoMem(const ir_node *node);
1221 /** Returns true if node is a Start node. */
1222 int is_Start(const ir_node *node);
1223 /** Returns true if node is a Minus node. */
1224 int is_Minus(const ir_node *node);
1225 /** Returns true if node is a Mod node. */
1226 int is_Mod(const ir_node *node);
1227 /** Returns true if node is a Div node. */
1228 int is_Div(const ir_node *node);
1229 /** Returns true if node is a DivMod node. */
1230 int is_DivMod(const ir_node *node);
1231 /** Returns true if node is a Quot node. */
1232 int is_Quot(const ir_node *node);
1233 /** Returns true if node is an Add node. */
1234 int is_Add(const ir_node *node);
1235 /** Returns true if node is an And node. */
1236 int is_And(const ir_node *node);
1237 /** Returns true if node is an Or node. */
1238 int is_Or(const ir_node *node);
1239 /** Returns true if node is an Eor node. */
1240 int is_Eor(const ir_node *node);
1241 /** Returns true if node is a Sub node. */
1242 int is_Sub(const ir_node *node);
1243 /** Returns true if node is a Not node. */
1244 int is_Not(const ir_node *node);
1245 /** Returns true if node is a Shl node. */
1246 int is_Shl(const ir_node *node);
1247 /** Returns true if node is a Shr node. */
1248 int is_Shr(const ir_node *node);
1249 /** Returns true if node is a Shrs node. */
1250 int is_Shrs(const ir_node *node);
1251 /** Returns true if node is a Rot node. */
1252 int is_Rot(const ir_node *node);
1253 /** Returns true if node is a Psi node. */
1254 int is_Psi(const ir_node *node);
1255 /** Returns true if node is a Tuple node. */
1256 int is_Tuple(const ir_node *node);
1257 /** Returns true if the node is not a Block */
1258 int is_no_Block(const ir_node *node);
1259 /** Returns true if the node is a Block */
1260 int is_Block(const ir_node *node);
1261 /** Returns true if node is an Unknown node. */
1262 int is_Unknown(const ir_node *node);
1263 /** Returns true if node is a Return node. */
1264 int is_Return(const ir_node *node);
1265 /** Returns true if node is a Call node. */
1266 int is_Call(const ir_node *node);
1267 /** Returns true if node is a Sel node. */
1268 int is_Sel(const ir_node *node);
1269 /** Returns true if node is a Mul node. */
1270 int is_Mul(const ir_node *node);
1271 /** Returns true if node is a Mulh node. */
1272 int is_Mulh(const ir_node *node);
1273 /** Returns true if node is a Mux node or a Psi with only one condition. */
1274 int is_Mux(const ir_node *node);
1275 /** Returns true if node is a Load node. */
1276 int is_Load(const ir_node *node);
1277 /** Returns true if node is a Store node. */
1278 int is_Store(const ir_node *node);
1279 /** Returns true if node is a Sync node. */
1280 int is_Sync(const ir_node *node);
1281 /** Returns true if node is a Confirm node. */
1282 int is_Confirm(const ir_node *node);
1283 /** Returns true if node is a Pin node. */
1284 int is_Pin(const ir_node *node);
1285 /** Returns true if node is a SymConst node. */
1286 int is_SymConst(const ir_node *node);
1287 /** Returns true if node is a Cond node. */
1288 int is_Cond(const ir_node *node);
1289 /** Returns true of node is a CopyB node */
1290 int is_CopyB(const ir_node *node);
1291 /** Returns true if node is a Cmp node. */
1292 int is_Cmp(const ir_node *node);
1293 /** Returns true if node is an Alloc node */
1294 int is_Alloc(const ir_node *node);
1295 /** Returns true if a node is a Jmp node */
1296 int is_Jmp(const ir_node *node);
1297 /** Returns true if a node is a Raise node */
1298 int is_Raise(const ir_node *node);
1299 /** Returns true if a node is an ASM node */
1300 int is_ASM(const ir_node *node);
1301 /** Returns true if node is a Proj node or a Filter node in
1302 * intraprocedural view */
1303 int is_Proj(const ir_node *node);
1304 /** Returns true if the operation manipulates control flow:
1305 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1306 int is_cfop(const ir_node *node);
1308 /** Returns true if the operation manipulates interprocedural control flow:
1309 CallBegin, EndReg, EndExcept */
1310 int is_ip_cfop(const ir_node *node);
1311 /** Returns true if the operation can change the control flow because
1312 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1313 Bad. Raise is not fragile, but a unconditional jump. */
1314 int is_fragile_op(const ir_node *node);
1315 /** Returns the memory operand of fragile operations. */
1316 ir_node *get_fragile_op_mem(ir_node *node);
1317 /** Returns the result mode of a Div operation. */
1318 ir_mode *get_divop_resmod(const ir_node *node);
1320 /** Returns true if the operation is a forking control flow
1321 * operation: Cond. */
1322 int is_irn_forking(const ir_node *node);
1324 /** Return the type associated with the value produced by n
1325 * if the node remarks this type as it is the case for
1326 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1327 ir_type *get_irn_type(ir_node *n);
1329 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1331 ir_type *get_irn_type_attr(ir_node *n);
1333 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1334 ir_entity *get_irn_entity_attr(ir_node *n);
1336 /** Returns non-zero for constant-like nodes. */
1337 int is_irn_constlike(const ir_node *node);
1340 * Returns non-zero for nodes that must be always optimized
1341 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1343 int is_irn_always_opt(const ir_node *node);
1346 * Returns non-zero for nodes that are allowed to have keep-alives and
1347 * are neither Block nor PhiM.
1349 int is_irn_keep(const ir_node *node);
1352 * Returns non-zero for nodes that are always placed in the start block.
1354 int is_irn_start_block_placed(const ir_node *node);
1357 * Returns non-zero for nodes that are machine operations.
1359 int is_irn_machine_op(const ir_node *node);
1362 * Returns non-zero for nodes that are machine operands.
1364 int is_irn_machine_operand(const ir_node *node);
1367 * Returns non-zero for nodes that have the n'th user machine flag set.
1369 int is_irn_machine_user(const ir_node *node, unsigned n);
1372 * A type to express conditional jump predictions.
1375 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1376 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1377 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1378 } cond_jmp_predicate;
1380 /** Gets the string representation of the jump prediction .*/
1381 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1383 /** Returns the conditional jump prediction of a Cond node. */
1384 cond_jmp_predicate get_Cond_jmp_pred(const ir_node *cond);
1386 /** Sets a new conditional jump prediction. */
1387 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1390 * Access custom node data.
1391 * The data must have been registered with
1392 * register_additional_node_data() before.
1393 * @param node The ir node to get the data from.
1394 * @param type The type of the data you registered.
1395 * @param off The value returned by register_additional_node_data().
1396 * @return A pointer of type @p type.
1398 #define get_irn_data(node,type,off) \
1399 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1402 * Get the pointer to the node some custom data belongs to.
1403 * @param data The pointer to the custom data.
1404 * @param off The number as returned by register_additional_node_data().
1405 * @return A pointer to the ir node the custom data belongs to.
1407 #define get_irn_data_base(data,off) \
1408 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1411 * Request additional data to be allocated with an ir node.
1412 * @param size The size of the additional data required.
1413 * @return A positive number, if the operation was successful, which
1414 * must be passed to the access macro get_irn_data(), 0 if the
1415 * registration failed.
1417 unsigned firm_register_additional_node_data(unsigned size);
1420 * Return a pointer to the node attributes.
1421 * Needed for user-defined nodes.
1423 void *get_irn_generic_attr(ir_node *node);
1424 const void *get_irn_generic_attr_const(const ir_node *node);
1427 * Returns the unique node index for the node in its graph.
1428 * This index is used to access phase information for this node.
1430 unsigned get_irn_idx(const ir_node *node);
1433 * Sets the debug information of a node.
1435 * @param n The node.
1436 * @param db The debug info.
1438 void set_irn_dbg_info(ir_node *n, dbg_info *db);
1441 * Returns the debug information of an node.
1443 * @param n The node.
1445 dbg_info *get_irn_dbg_info(const ir_node *n);
1447 /*-----------------------------------------------------------------*/
1449 /*-----------------------------------------------------------------*/
1452 /** Debug print the node.
1454 * Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
1455 * is set. Else does nothing. */
1456 void dump_irn(ir_node *n);
1458 /*@}*/ /* end of ir_node group definition */