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 * you can work on the graph without considering the different types
71 * of nodes, it's just a big graph.
75 * Checks whether a pointer points to a ir node.
77 * @param thing an arbitrary pointer
78 * @return non-zero if the thing is a ir mode, else zero
80 int is_ir_node (const void *thing);
83 * Returns the number of predecessors without the block predecessor.
85 * @param node the IR-node
87 int get_irn_arity (const ir_node *node);
88 int get_irn_intra_arity(const ir_node *node);
89 int get_irn_inter_arity(const ir_node *node);
91 /** Replaces the old in array by a new one that will contain the ins given in
92 the parameters. Conserves the block predecessor. It copies the array passed.
93 This function is necessary to adjust in arrays of blocks, calls and phis.
94 Assumes that current_ir_graph is set to the graph containing "node".
95 "in" must contain all predecessors except the block that are required for
97 void set_irn_in(ir_node *node, int arity, ir_node *in[]);
99 /* to iterate through the predecessors without touching the array. No
100 order of predecessors guaranteed.
101 To iterate over the operands iterate from 0 to i < get_irn_arity(),
102 to iterate including the Block predecessor iterate from i = -1 to
103 i < get_irn_arity. */
104 /* Access predecessor n */
107 * Get the n-th predecessor of a node.
108 * This function removes Id predecessors.
109 * This function automatically handles intra- and interprocedural views.
111 ir_node *get_irn_n(const ir_node *node, int n);
114 * Add a artificial dependency to the node.
115 * The dependency is only inserted if it is not there already.
116 * @param node The node.
117 * @param dep The dependency target.
118 * @return The index in the array (get_irn_dep() with that index returns @p dep).
120 int add_irn_dep(ir_node *node, ir_node *dep);
123 * Copy all dependencies from a node to another.
124 * @param tgt The node which should be enriched.
125 * @param src The node whose dependencies shall be copied.
127 void add_irn_deps(ir_node *tgt, ir_node *src);
130 * Get the length of the dependency array.
131 * @param node The node.
132 * @return The length of the dependency array or 0 if it has not yet been allocated.
134 int get_irn_deps(const ir_node *node);
137 * Get an entry of the dependency array.
138 * @param node The node.
139 * @param pos The position.
140 * @return The node at that position.
142 ir_node *get_irn_dep(const ir_node *node, int pos);
145 * Set an entry of the dependency array.
146 * @param node The node.
147 * @param pos The position.
148 * @param dep The dependency target.
150 void set_irn_dep(ir_node *node, int pos, ir_node *dep);
154 * Get the n-th predecessor of a node in intraprocedural view.
155 * Can be used always if it's know that node is not a split one.
157 ir_node *get_irn_intra_n(const ir_node *node, int n);
160 * Get the n-th predecessor of a node in interprocedural view.
162 ir_node *get_irn_inter_n(const ir_node *node, int n);
164 /** Replace the n-th predecessor of a node with a new one. */
165 void set_irn_n(ir_node *node, int n, ir_node *in);
167 * Appends a new predecessor to a node. This only works for nodes with
169 * @returns the number of the new input
171 int add_irn_n(ir_node *node, ir_node *in);
172 /* Sets the mode struct of node. */
173 void set_irn_mode(ir_node *node, ir_mode *mode);
174 /** Gets the mode struct of a node. */
175 ir_mode *get_irn_mode(const ir_node *node);
176 /** Gets the mode-enum modecode. */
177 modecode get_irn_modecode(const ir_node *node);
178 /** Gets the ident for a string representation of the mode .*/
179 ident *get_irn_modeident(const ir_node *node);
180 /** Gets the string representation of the mode .*/
181 const char *get_irn_modename(const ir_node *node);
182 /** Gets the opcode struct of the node. */
183 ir_op *get_irn_op(const ir_node *node);
184 /** Sets the opcode struct of the node. */
185 void set_irn_op(ir_node *node, ir_op *op);
186 /** Gets the opcode-enum of the node. */
187 unsigned get_irn_opcode(const ir_node *node);
188 /** Get the string representation of the opcode. */
189 const char *get_irn_opname(const ir_node *node);
190 /** Get the ident for a string representation of the opcode. */
191 ident *get_irn_opident(const ir_node *node);
192 /** If arg is an argument of the node, returns it's position, -1 otherwise */
193 int get_irn_pred_pos(ir_node *node, ir_node *arg);
194 /** Gets the visited counter of a node. */
195 unsigned long get_irn_visited(const ir_node *node);
196 /** Sets the visited counter of a node. */
197 void set_irn_visited(ir_node *node, unsigned long visited);
198 /** Sets visited to get_irg_visited(current_ir_graph). */
199 void mark_irn_visited(ir_node *node);
200 /** Returns 1 if visited < get_irg_visited(current_ir_graph). */
201 int irn_not_visited(const ir_node *node);
202 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
203 int irn_visited(const ir_node *node);
206 * Sets the link of a node.
207 * Only allowed if the graph is NOT in phase_building.
209 void set_irn_link(ir_node *node, void *link);
211 /** Returns the link of a node. */
212 void *get_irn_link(const ir_node *node);
214 /** Returns the ir_graph this node belongs to. */
215 ir_graph *get_irn_irg(const ir_node *node);
217 /** Outputs a unique number for this node if libFIRM is compiled for
218 debugging, (configure with --enable-debug) else returns address
219 of node cast to long. */
220 long get_irn_node_nr(const ir_node *node);
222 /** Returns the pinned state of a node.
224 * Returns whether the node _always_ must be pinned.
225 * I.e., the node is not floating after global cse.
227 * @returns Either state op_pin_state_pinned or op_pin_state_floats.
229 op_pin_state get_irn_pinned(const ir_node *node);
231 /** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
232 void set_irn_pinned(ir_node *node, op_pin_state state);
234 /** Returns whether the node is currently pinned.
236 * If get_irn_pinned returns op_pin_state_floats and the graph the
237 * node belongs to is in state op_poin_state_floats then this function
238 * returns 'floats', else 'pinned'.
240 op_pin_state is_irn_pinned_in_irg(const ir_node *node);
243 * IR node constructor.
244 * Create a new IR node in irg, with an op, mode, arity and
245 * some incoming IR nodes.
246 * This constructor is used in every specific IR node constructor.
248 * @param db Debug info.
249 * @param irg IR-graph on with this new node should be constructed.
250 * @param block The block the new node belongs to
251 * @param op The opcode of the new node.
252 * @param mode The mode of the new node.
253 * @param arity The arity of the new node, <0 if can be changed dynamically.
254 * @param in An array of arity predecessor nodes.
257 new_ir_node(dbg_info *db,
266 * Return the block the node belongs to. This is only
267 * possible for pinned nodes or if the graph is in pinned state.
268 * Otherwise the block may be incorrect. This condition is
269 * now checked by an assertion.
271 * This works for all except Block. It can return Blocks or the Bad node.
273 * To express the difference to access routines that work for all
274 * nodes we use infix "nodes" and do not name this function
275 * get_irn_block(). */
276 ir_node *get_nodes_block (const ir_node *node);
278 /** Sets the Block of a node. */
279 void set_nodes_block (ir_node *node, ir_node *block);
282 * @function get_irn_block()
283 * @see get_nodes_block()
287 * Projection numbers for result of Start node: use for Proj nodes!
290 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
291 pn_Start_M, /**< Projection on the initial memory. */
292 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
293 pn_Start_P_globals, /**< Projection on the pointer to the data segment
294 containing _all_ global entities. Use for
295 position independent data/code access. */
296 pn_Start_P_tls, /**< Projection on the pointer to the thread local store
297 segment containing _all_thread local variables. */
298 pn_Start_T_args, /**< Projection on all arguments. */
299 pn_Start_P_value_arg_base, /**< Pointer to region of compound value arguments as defined by
300 type of this method. */
301 pn_Start_max /**< number of projections from a Start */
302 } pn_Start; /* Projection numbers for Start. */
304 /** Test whether arbitrary node is frame pointer.
306 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
307 * from Start. If so returns frame type, else Null. */
308 ir_type *is_frame_pointer(ir_node *n);
310 /** Test whether arbitrary node is globals pointer.
312 * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
313 * from Start. If so returns global type, else Null. */
314 ir_type *is_globals_pointer(ir_node *n);
316 /** Test whether arbitrary node is tls pointer.
318 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
319 * from Start. If so returns tls type, else Null. */
320 ir_type *is_tls_pointer(ir_node *n);
322 /** Test whether arbitrary node is value arg base.
324 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
325 * from Start. If so returns 1, else 0. */
326 int is_value_arg_pointer(ir_node *n);
329 /* @@@ no more supported */
330 ir_node **get_Block_cfgpred_arr(ir_node *node);
331 int get_Block_n_cfgpreds(const ir_node *node);
332 ir_node *get_Block_cfgpred(ir_node *node, int pos);
333 void set_Block_cfgpred(ir_node *node, int pos, ir_node *pred);
334 /** Get the predecessor block.
336 * Returns the block corresponding to the predecessor pos of block.
338 * There are several ambiguities we resolve with this function:
339 * - The direct predecessor can be a Proj, which is not pinned.
340 * We walk from the predecessor to the next pinned node
341 * (skip_Proj) and return the block that node is in.
342 * - If we encounter the Bad node, this function does not return
343 * Start, but the Bad node.
345 ir_node *get_Block_cfgpred_block(ir_node *node, int pos);
346 int get_Block_matured(ir_node *node);
347 void set_Block_matured(ir_node *node, int matured);
349 /** A visited flag only for block nodes.
350 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
351 unsigned long get_Block_block_visited(const ir_node *node);
352 void set_Block_block_visited(ir_node *node, unsigned long visit);
355 * Marks a block as dead but do not replace it with a Bad node.
356 * Dead blocks are removed in the con
358 ir_node *set_Block_dead(ir_node *block);
359 int is_Block_dead(const ir_node *block);
361 /* For this current_ir_graph must be set. */
362 void mark_Block_block_visited(ir_node *node);
363 int Block_not_block_visited(const ir_node *node);
364 int Block_block_visited(const ir_node *node);
366 /* Set and remove interprocedural predecessors. If the interprocedural
367 * predecessors are removed, the node has the same predecessors in
369 * @@@ Maybe better: arity is zero if no cg preds. */
370 void set_Block_cg_cfgpred_arr(ir_node *node, int arity, ir_node *in[]);
371 void set_Block_cg_cfgpred(ir_node *node, int pos, ir_node *pred);
372 /* @@@ not supported */
373 ir_node **get_Block_cg_cfgpred_arr(ir_node *node);
374 /** Returns the number of interprocedural predecessors. 0 if none. */
375 int get_Block_cg_n_cfgpreds(ir_node *node);
376 /** Return the interprocedural predecessor at position pos. */
377 ir_node *get_Block_cg_cfgpred(ir_node *node, int pos);
378 /** Frees the memory allocated for interprocedural predecessors. */
379 void remove_Block_cg_cfgpred_arr(ir_node *node);
380 /** Returns the extended basic block a block belongs to. */
381 ir_extblk *get_Block_extbb(const ir_node *block);
382 /** Sets the extended basic block a block belongs to. */
383 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
384 /** Get the Macro Block header of a (sub-) block. */
385 ir_node *get_Block_MacroBlock(const ir_node *block);
386 /** Returns the ir_graph this Block belongs to. */
387 ir_graph *get_Block_irg(const ir_node *block);
389 /** Return the number of Keep alive node. */
390 int get_End_n_keepalives(ir_node *end);
391 /** Return the Keep alive node a position pos. */
392 ir_node *get_End_keepalive(ir_node *end, int pos);
393 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
394 void add_End_keepalive(ir_node *end, ir_node *ka);
395 /** Set the Keep alive node at position pos. */
396 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
397 /** Set new keep-alives. */
398 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
399 /** Set new keep-alives from old keep-alives, skipping irn. */
400 void remove_End_keepalive(ir_node *end, ir_node *irn);
402 /** Some parts of the End node are allocated separately -- their memory
403 is not recovered by dead_node_elimination if a End node is dead.
404 free_End() frees these data structures. */
405 void free_End(ir_node *end);
407 /** Return the target address of an IJmp */
408 ir_node *get_IJmp_target(ir_node *ijmp);
409 /** Sets the target address of an IJmp */
410 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
412 /* We distinguish three kinds of Cond nodes. These can be distinguished
413 by the mode of the selector operand and an internal flag of type cond_kind.
414 First we distinguish binary Conds and switch Conds.
415 A binary Cond has as selector a boolean value. Proj(0) projects the control
416 flow for case "False", Proj(1) the control flow for "True". A binary Cond
417 is recognized by the boolean selector.
418 The switch Cond has as selector an unsigned integer. It produces as result
419 an n+1 Tuple (cf0, ... , cfn) of control flows.
420 We differ two flavors of this Cond. The first, the dense Cond, passes
421 control along output i if the selector value is i, 0 <= i <= n. If the
422 selector value is >n it passes control along output n.
423 The second Cond flavor differences in the treatment of cases not specified in
424 the source program. It magically knows about the existence of Proj nodes.
425 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
426 exists. Else it passes control along output n (even if this Proj does not
427 exist.) This Cond we call "fragmentary". There is a special constructor
428 new_defaultProj that automatically sets the flavor.
429 The two switch flavors are distinguished by a flag of type cond_kind.
430 Default flavor is "dense"
433 dense, /**< Default. Missing Proj nodes are dead control flow. */
434 fragmentary /**< Special. No control flow optimizations allowed. Missing
435 Proj nodes mean default control flow, i.e., Proj(n). */
438 ir_node *get_Cond_selector(ir_node *node);
439 void set_Cond_selector(ir_node *node, ir_node *selector);
440 cond_kind get_Cond_kind(ir_node *node);
441 void set_Cond_kind(ir_node *node, cond_kind kind);
442 long get_Cond_defaultProj(ir_node *node);
445 * Projection numbers for conditions.
448 pn_Cond_false, /**< Control flow if operand is "false". */
449 pn_Cond_true, /**< Control flow if operand is "true". */
450 pn_Cond_max /**< number of projections from a Cond */
451 } pn_Cond; /* Projection numbers for Cond. */
453 ir_node *get_Return_mem(ir_node *node);
454 void set_Return_mem(ir_node *node, ir_node *mem);
455 ir_node **get_Return_res_arr(ir_node *node);
456 int get_Return_n_ress(ir_node *node);
457 ir_node *get_Return_res(ir_node *node, int pos);
458 void set_Return_res(ir_node *node, int pos, ir_node *res);
461 * Possible classes for constant classification.
464 CNST_NULL = 0, /**< The node is a const(0). */
465 CNST_ONE = +1, /**< The node is a const(1). */
466 CNST_ALL_ONE = -1, /**< The node is a const(11111...). */
467 CNST_OTHER = 2, /**< The tarval of the const has another value. */
468 CNST_SYMCONST = 3, /**< The node is symconst. */
469 CNST_NO_CONST = 4 /**< The node is no const at all. */
472 tarval *get_Const_tarval(const ir_node *node);
473 void set_Const_tarval(ir_node *node, tarval *con);
476 * Classify a node concerning constant properties.
477 * @param irn A node to check for.
478 * @return Constant properties of that node.
480 cnst_classify_t classify_Const(ir_node *irn);
482 /** Returns the source language type of a Const node.
483 * Must be an atomic type. Mode of type must be mode of node.
485 ir_type *get_Const_type(ir_node *node);
487 /** Sets the source language type of a Const node. */
488 void set_Const_type(ir_node *node, ir_type *tp);
490 /** This enum names the three different kinds of symbolic Constants
491 represented by SymConst. The content of the attribute type_or_id
492 depends on this tag. Use the proper access routine after testing
495 symconst_type_tag, /**< The SymConst is a type tag for the given type.
496 symconst_symbol is type *. */
497 symconst_type_size, /**< The SymConst is the size of the given type.
498 symconst_symbol is type *. */
499 symconst_type_align, /**< The SymConst is the alignment of the given type.
500 symconst_symbol is type *. */
501 symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
502 by the linker. The pointer is represented by a string.
503 symconst_symbol is ident *. */
504 symconst_addr_ent, /**< The SymConst is a symbolic pointer to be filled in
505 by the linker. The pointer is represented by an entity.
506 symconst_symbol is entity *. */
507 symconst_ofs_ent, /**< The SymConst is the offset of its entity in the entities
509 symconst_enum_const /**< The SymConst is a enumeration constant of an
513 /** Returns non-zero if s symconst kind has a type attribute */
514 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
516 /** Returns non-zero if s symconst kind has an ident attribute */
517 #define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)
519 /** Returns non-zero if s symconst kind has an entity attribute */
520 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
522 /** Returns non-zero if s symconst kind has an enum_const attribute */
523 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
525 /** SymConst attribute.
527 * This union contains the symbolic information represented by the node.
529 typedef union symconst_symbol {
530 ir_type *type_p; /**< the type of a symconst */
531 ident *ident_p; /**< the ident of a symconst */
532 ir_entity *entity_p; /**< the entity of a symconst */
533 ir_enum_const *enum_p; /**< the enumeration constant of a symconst */
536 /** Get the kind of the SymConst. */
537 symconst_kind get_SymConst_kind(const ir_node *node);
538 /** Set the kind of the SymConst. */
539 void set_SymConst_kind(ir_node *node, symconst_kind num);
541 /** Only to access SymConst of kind type_tag or size. Else assertion: */
542 ir_type *get_SymConst_type(ir_node *node);
543 void set_SymConst_type(ir_node *node, ir_type *tp);
545 /** Only to access SymConst of kind addr_name. Else assertion: */
546 ident *get_SymConst_name(const ir_node *node);
547 void set_SymConst_name(ir_node *node, ident *name);
549 /** Only to access SymConst of kind addr_ent. Else assertion: */
550 ir_entity *get_SymConst_entity(const ir_node *node);
551 void set_SymConst_entity(ir_node *node, ir_entity *ent);
553 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
554 ir_enum_const *get_SymConst_enum(const ir_node *node);
555 void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
557 /** Sets both: type and ptrinfo. Needed to treat the node independent of
558 its semantics. Does a memcpy for the memory sym points to. */
559 /* write 'union': firmjni then does not create a method... */
560 union symconst_symbol get_SymConst_symbol(const ir_node *node);
561 void set_SymConst_symbol(ir_node *node,
562 union symconst_symbol sym);
564 /** Access the type of the value represented by the SymConst.
566 * Example: primitive type int for SymConst size. */
567 ir_type *get_SymConst_value_type(ir_node *node);
568 void set_SymConst_value_type(ir_node *node, ir_type *tp);
570 ir_node *get_Sel_mem(ir_node *node);
571 void set_Sel_mem(ir_node *node, ir_node *mem);
572 ir_node *get_Sel_ptr(ir_node *node); /* ptr to the object to select from */
573 void set_Sel_ptr(ir_node *node, ir_node *ptr);
574 ir_node **get_Sel_index_arr(ir_node *node);
575 int get_Sel_n_indexs(ir_node *node);
576 ir_node *get_Sel_index(ir_node *node, int pos);
577 void set_Sel_index(ir_node *node, int pos, ir_node *index);
578 ir_entity *get_Sel_entity(ir_node *node); /* entity to select */
579 void set_Sel_entity (ir_node *node, ir_entity *ent);
582 * Projection numbers for result of Call node: use for Proj nodes!
585 pn_Call_M_regular = 0, /**< The memory result. */
586 pn_Call_X_regular = 1, /**< The control flow result when no exception occurs. */
587 pn_Call_X_except = 2, /**< The control flow result branching to the exception handler. */
588 pn_Call_T_result = 3, /**< The tuple containing all (0, 1, 2, ...) results. */
589 pn_Call_M_except = 4, /**< The memory result in case the called method terminated with
591 pn_Call_P_value_res_base = 5,/**< A pointer to the memory region containing copied results
592 passed by value (for compound result types). */
593 pn_Call_max = 6 /**< number of projections from a Call */
594 } pn_Call; /* Projection numbers for Call. */
595 #define pn_Call_M pn_Call_M_regular
597 ir_node *get_Call_mem(ir_node *node);
598 void set_Call_mem(ir_node *node, ir_node *mem);
599 ir_node *get_Call_ptr(ir_node *node);
600 void set_Call_ptr(ir_node *node, ir_node *ptr);
601 ir_node **get_Call_param_arr(ir_node *node);
602 /** Gets the number of parameters of a call. */
603 int get_Call_n_params(ir_node *node);
604 /** Gets the call parameter at position pos. */
605 ir_node *get_Call_param(ir_node *node, int pos);
606 /** Sets the call parameter at position pos. */
607 void set_Call_param(ir_node *node, int pos, ir_node *param);
608 /** Gets the type of a call. */
609 ir_type *get_Call_type(ir_node *node);
610 /** Sets the type of a call. */
611 void set_Call_type(ir_node *node, ir_type *tp);
612 /** Gets the arity of a call. Identical to get_Call_n_params(). */
613 int get_Call_arity(ir_node *node);
615 /** Set, get and remove the callee information for a Call node.
617 * The callee information lists all method entities that can be called
618 * from this node. If the address expression can not be analyzed fully,
619 * e.g., as entities can be called that are not in the compilation unit,
620 * the array contains the unknown_entity. The array contains only entities
621 * with peculiarity_existent, but with all kinds of visibility. The entities
622 * not necessarily contain an irg.
624 * The array is only accessible if callee information is valid. See flag
627 * The memory allocated for the array is managed automatically, i.e., it must
628 * not be freed if the Call node is removed from the graph.
630 * @param node A Call node.
632 int Call_has_callees(ir_node *node);
633 int get_Call_n_callees(ir_node *node);
634 ir_entity *get_Call_callee(ir_node *node, int pos);
636 /** Set the full callee array.
638 * The passed array is copied. Assumes current_ir_graph set properly! */
639 void set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
640 void remove_Call_callee_arr(ir_node *node);
642 ir_node *get_CallBegin_ptr(ir_node *node);
643 void set_CallBegin_ptr(ir_node *node, ir_node *ptr);
644 ir_node *get_CallBegin_call(ir_node *node);
645 void set_CallBegin_call(ir_node *node, ir_node *call);
647 /* For unary and binary arithmetic operations the access to the
648 operands can be factored out. Left is the first, right the
649 second arithmetic value as listed in tech report 1999-44.
650 unops are: Minus, Abs, Not, Conv, Cast
651 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
652 Shr, Shrs, Rot, Cmp */
653 int is_unop(const ir_node *node);
654 ir_node *get_unop_op(const ir_node *node);
655 void set_unop_op(ir_node *node, ir_node *op);
656 int is_binop(const ir_node *node);
657 ir_node *get_binop_left(const ir_node *node);
658 void set_binop_left(ir_node *node, ir_node *left);
659 ir_node *get_binop_right(const ir_node *node);
660 void set_binop_right(ir_node *node, ir_node *right);
662 ir_node *get_Add_left(const ir_node *node);
663 void set_Add_left(ir_node *node, ir_node *left);
664 ir_node *get_Add_right(const ir_node *node);
665 void set_Add_right(ir_node *node, ir_node *right);
667 ir_node *get_Sub_left(const ir_node *node);
668 void set_Sub_left(ir_node *node, ir_node *left);
669 ir_node *get_Sub_right(const ir_node *node);
670 void set_Sub_right(ir_node *node, ir_node *right);
672 ir_node *get_Minus_op(const ir_node *node);
673 void set_Minus_op(ir_node *node, ir_node *op);
675 ir_node *get_Mul_left(const ir_node *node);
676 void set_Mul_left(ir_node *node, ir_node *left);
677 ir_node *get_Mul_right(const ir_node *node);
678 void set_Mul_right(ir_node *node, ir_node *right);
680 ir_node *get_Quot_left(const ir_node *node);
681 void set_Quot_left(ir_node *node, ir_node *left);
682 ir_node *get_Quot_right(const ir_node *node);
683 void set_Quot_right(ir_node *node, ir_node *right);
684 ir_node *get_Quot_mem(ir_node *node);
685 void set_Quot_mem(ir_node *node, ir_node *mem);
686 ir_mode *get_Quot_resmode(const ir_node *node);
687 void set_Quot_resmode(ir_node *node, ir_mode *mode);
690 * Projection numbers for Quot: use for Proj nodes!
693 pn_Quot_M, /**< Memory result. */
694 pn_Quot_X_regular, /**< Execution result if no exception occurred. */
695 pn_Quot_X_except, /**< Execution result if exception occurred. */
696 pn_Quot_res, /**< Result of computation. */
697 pn_Quot_max /**< number of projections from a Quot */
698 } pn_Quot; /* Projection numbers for Quot. */
700 ir_node *get_DivMod_left(const ir_node *node);
701 void set_DivMod_left(ir_node *node, ir_node *left);
702 ir_node *get_DivMod_right(const ir_node *node);
703 void set_DivMod_right(ir_node *node, ir_node *right);
704 ir_node *get_DivMod_mem(ir_node *node);
705 void set_DivMod_mem(ir_node *node, ir_node *mem);
706 ir_mode *get_DivMod_resmode(const ir_node *node);
707 void set_DivMod_resmode(ir_node *node, ir_mode *mode);
710 * Projection numbers for DivMod: use for Proj nodes!
713 pn_DivMod_M, /**< Memory result. */
714 pn_DivMod_X_regular, /**< Execution result if no exception occurred. */
715 pn_DivMod_X_except, /**< Execution result if exception occurred. */
716 pn_DivMod_res_div, /**< Result of computation a / b. */
717 pn_DivMod_res_mod, /**< Result of computation a % b. */
718 pn_DivMod_max /**< number of projections from a DivMod */
719 } pn_DivMod; /* Projection numbers for DivMod. */
721 ir_node *get_Div_left(const ir_node *node);
722 void set_Div_left(ir_node *node, ir_node *left);
723 ir_node *get_Div_right(const ir_node *node);
724 void set_Div_right(ir_node *node, ir_node *right);
725 ir_node *get_Div_mem(ir_node *node);
726 void set_Div_mem(ir_node *node, ir_node *mem);
727 ir_mode *get_Div_resmode(const ir_node *node);
728 void set_Div_resmode(ir_node *node, ir_mode *mode);
731 * Projection numbers for Div: use for Proj nodes!
734 pn_Div_M, /**< Memory result. */
735 pn_Div_X_regular, /**< Execution result if no exception occurred. */
736 pn_Div_X_except, /**< Execution result if exception occurred. */
737 pn_Div_res, /**< Result of computation. */
738 pn_Div_max /**< number of projections from a Div */
739 } pn_Div; /* Projection numbers for Div. */
741 ir_node *get_Mod_left(const ir_node *node);
742 void set_Mod_left(ir_node *node, ir_node *left);
743 ir_node *get_Mod_right(const ir_node *node);
744 void set_Mod_right(ir_node *node, ir_node *right);
745 ir_node *get_Mod_mem(ir_node *node);
746 void set_Mod_mem(ir_node *node, ir_node *mem);
747 ir_mode *get_Mod_resmode(const ir_node *node);
748 void set_Mod_resmode(ir_node *node, ir_mode *mode);
751 * Projection numbers for Mod: use for Proj nodes!
754 pn_Mod_M, /**< Memory result. */
755 pn_Mod_X_regular, /**< Execution result if no exception occurred. */
756 pn_Mod_X_except, /**< Execution result if exception occurred. */
757 pn_Mod_res, /**< Result of computation. */
758 pn_Mod_max /**< number of projections from a Mod */
759 } pn_Mod; /* Projection numbers for Mod. */
761 ir_node *get_Abs_op(const ir_node *node);
762 void set_Abs_op(ir_node *node, ir_node *op);
764 ir_node *get_And_left(const ir_node *node);
765 void set_And_left(ir_node *node, ir_node *left);
766 ir_node *get_And_right(const ir_node *node);
767 void set_And_right(ir_node *node, ir_node *right);
769 ir_node *get_Or_left(const ir_node *node);
770 void set_Or_left(ir_node *node, ir_node *left);
771 ir_node *get_Or_right(const ir_node *node);
772 void set_Or_right(ir_node *node, ir_node *right);
774 ir_node *get_Eor_left(const ir_node *node);
775 void set_Eor_left(ir_node *node, ir_node *left);
776 ir_node *get_Eor_right(const ir_node *node);
777 void set_Eor_right(ir_node *node, ir_node *right);
779 ir_node *get_Not_op(const ir_node *node);
780 void set_Not_op(ir_node *node, ir_node *op);
783 * Projection numbers for Cmp are defined several times.
784 * The bit patterns are used for various tests, so don't change.
785 * The "unordered" values are possible results of comparing
786 * floating point numbers.
787 * Note that the encoding is imported, so do NOT change the order.
790 pn_Cmp_False = 0, /**< false */
791 pn_Cmp_Eq = 1, /**< equal */
792 pn_Cmp_Lt = 2, /**< less */
793 pn_Cmp_Le = pn_Cmp_Eq|pn_Cmp_Lt, /**< less or equal */
794 pn_Cmp_Gt = 4, /**< greater */
795 pn_Cmp_Ge = pn_Cmp_Eq|pn_Cmp_Gt, /**< greater or equal */
796 pn_Cmp_Lg = pn_Cmp_Lt|pn_Cmp_Gt, /**< less or greater */
797 pn_Cmp_Leg = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
798 pn_Cmp_Uo = 8, /**< unordered */
799 pn_Cmp_Ue = pn_Cmp_Uo|pn_Cmp_Eq, /**< unordered or equal */
800 pn_Cmp_Ul = pn_Cmp_Uo|pn_Cmp_Lt, /**< unordered or less */
801 pn_Cmp_Ule = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
802 pn_Cmp_Ug = pn_Cmp_Uo|pn_Cmp_Gt, /**< unordered or greater */
803 pn_Cmp_Uge = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
804 pn_Cmp_Ne = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
805 pn_Cmp_True = 15 /**< true */
806 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for JNI interface */
807 } pn_Cmp; /* Projection numbers for Cmp */
808 /* #define not_mask pn_Cmp_Leg */
810 /** returns the pnc name from an pnc constant */
811 const char *get_pnc_string(int pnc);
813 /** Calculates the negated (Complement(R)) pnc condition. */
814 int get_negated_pnc(int pnc, ir_mode *mode);
816 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
817 int get_inversed_pnc(int pnc);
819 /** An alternative name for get_inversed_pnc() that can be better memorized. */
820 #define get_mirrored_pnc(pnc) get_inversed_pnc(pnc)
822 ir_node *get_Cmp_left(const ir_node *node);
823 void set_Cmp_left(ir_node *node, ir_node *left);
824 ir_node *get_Cmp_right(const ir_node *node);
825 void set_Cmp_right(ir_node *node, ir_node *right);
827 ir_node *get_Shl_left(const ir_node *node);
828 void set_Shl_left(ir_node *node, ir_node *left);
829 ir_node *get_Shl_right(const ir_node *node);
830 void set_Shl_right(ir_node *node, ir_node *right);
832 ir_node *get_Shr_left(const ir_node *node);
833 void set_Shr_left(ir_node *node, ir_node *left);
834 ir_node *get_Shr_right(const ir_node *node);
835 void set_Shr_right(ir_node *node, ir_node *right);
837 ir_node *get_Shrs_left(const ir_node *node);
838 void set_Shrs_left(ir_node *node, ir_node *left);
839 ir_node *get_Shrs_right(const ir_node *node);
840 void set_Shrs_right(ir_node *node, ir_node *right);
842 ir_node *get_Rot_left(const ir_node *node);
843 void set_Rot_left(ir_node *node, ir_node *left);
844 ir_node *get_Rot_right(const ir_node *node);
845 void set_Rot_right(ir_node *node, ir_node *right);
847 ir_node *get_Conv_op(const ir_node *node);
848 void set_Conv_op(ir_node *node, ir_node *op);
849 int get_Conv_strict(ir_node *node);
850 void set_Conv_strict(ir_node *node, int flag);
852 /* Does Cast need a mem operator?
853 * Cast should only depend on the type, not on the state of an
854 * entity. But: we initialize various fields after Alloc, that
855 * are accessed in the cast. This required some precaution, to
856 * get the right memory into the Loads generated from the cast.
858 ir_node *get_Cast_op(const ir_node *node);
859 void set_Cast_op(ir_node *node, ir_node *op);
860 ir_type *get_Cast_type(ir_node *node);
861 void set_Cast_type(ir_node *node, ir_type *to_tp);
863 /** Checks for upcast.
865 * Returns true if the Cast node casts a class type to a super type.
866 * Works also for pointers to classes (recursively).
868 * Needs typeinfo calculated.
870 int is_Cast_upcast(ir_node *node);
872 /** Checks for downcast.
874 * Returns true if the Cast node casts a class type to a sub type.
875 * Works also for pointers to classes (recursively).
877 * Needs typeinfo calculated.
879 int is_Cast_downcast(ir_node *node);
882 /** Returns true if n is Phi or Filter in interprocedural_view.
883 Returns false if irg in phase building and the Phi has zero
884 predecessors: it's a Phi0. */
885 int is_Phi(const ir_node *n);
886 /** Returns true if irg in phase building and the Phi has zero
887 predecessors. It's a Phi0 then. */
888 int is_Phi0(const ir_node *n);
889 /* These routines also work for Filter nodes in interprocedural view. */
890 ir_node **get_Phi_preds_arr(ir_node *node);
891 int get_Phi_n_preds(const ir_node *node);
892 ir_node *get_Phi_pred(const ir_node *node, int pos);
893 void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
895 ir_node *get_Filter_pred(ir_node *node);
896 void set_Filter_pred(ir_node *node, ir_node *pred);
897 long get_Filter_proj(ir_node *node);
898 void set_Filter_proj(ir_node *node, long proj);
899 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
900 * @@@ Maybe better: arity is zero if no cg preds. */
901 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
902 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
903 int get_Filter_n_cg_preds(ir_node *node);
904 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
906 /** Return true if parameter is a memory operation.
908 * A memory operation is an operation that changes the
909 * memory. I.e., a Load or a Store operation.
911 int is_memop(ir_node *node);
912 ir_node *get_memop_mem(ir_node *node);
913 void set_memop_mem(ir_node *node, ir_node *mem);
914 ir_node *get_memop_ptr(ir_node *node);
915 void set_memop_ptr(ir_node *node, ir_node *ptr);
918 * Projection numbers for Load: use for Proj nodes!
921 pn_Load_M, /**< Memory result. */
922 pn_Load_X_regular, /**< Execution result if no exception occurred. */
923 pn_Load_X_except, /**< Execution result if exception occurred. */
924 pn_Load_res, /**< Result of load operation. */
925 pn_Load_max /**< number of projections from a Load */
926 } pn_Load; /* Projection numbers for Load. */
928 ir_node *get_Load_mem(ir_node *node);
929 void set_Load_mem(ir_node *node, ir_node *mem);
930 ir_node *get_Load_ptr(ir_node *node);
931 void set_Load_ptr(ir_node *node, ir_node *ptr);
932 ir_mode *get_Load_mode(ir_node *node);
933 void set_Load_mode(ir_node *node, ir_mode *mode);
934 ir_volatility get_Load_volatility(ir_node *node);
935 void set_Load_volatility(ir_node *node, ir_volatility volatility);
938 * Projection numbers for Store: use for Proj nodes!
941 pn_Store_M, /**< Memory result. */
942 pn_Store_X_regular, /**< Execution result if no exception occurred. */
943 pn_Store_X_except, /**< Execution result if exception occurred. */
944 pn_Store_max /**< number of projections from a Store */
945 } pn_Store; /* Projection numbers for Store. */
947 ir_node *get_Store_mem(ir_node *node);
948 void set_Store_mem(ir_node *node, ir_node *mem);
949 ir_node *get_Store_ptr(ir_node *node);
950 void set_Store_ptr(ir_node *node, ir_node *ptr);
951 ir_node *get_Store_value(ir_node *node);
952 void set_Store_value(ir_node *node, ir_node *value);
953 ir_volatility get_Store_volatility(ir_node *node);
954 void set_Store_volatility(ir_node *node, ir_volatility volatility);
957 * Projection numbers for Alloc: use for Proj nodes!
960 pn_Alloc_M, /**< Memory result. */
961 pn_Alloc_X_regular, /**< Execution result if no exception occurred. */
962 pn_Alloc_X_except, /**< Execution result if exception occurred. */
963 pn_Alloc_res, /**< Result of allocation. */
964 pn_Alloc_max /**< number of projections from an Alloc */
965 } pn_Alloc; /* Projection numbers for Alloc. */
967 ir_node *get_Alloc_mem(ir_node *node);
968 void set_Alloc_mem(ir_node *node, ir_node *mem);
969 ir_node *get_Alloc_size(ir_node *node);
970 void set_Alloc_size(ir_node *node, ir_node *size);
971 ir_type *get_Alloc_type(ir_node *node);
972 void set_Alloc_type(ir_node *node, ir_type *tp);
974 /** The allocation place. */
976 stack_alloc, /**< Alloc allocates the object on the stack. */
977 heap_alloc /**< Alloc allocates the object on the heap. */
980 where_alloc get_Alloc_where(ir_node *node);
981 void set_Alloc_where(ir_node *node, where_alloc where);
983 ir_node *get_Free_mem(ir_node *node);
984 void set_Free_mem(ir_node *node, ir_node *mem);
985 ir_node *get_Free_ptr(ir_node *node);
986 void set_Free_ptr(ir_node *node, ir_node *ptr);
987 ir_node *get_Free_size(ir_node *node);
988 void set_Free_size(ir_node *node, ir_node *size);
989 ir_type *get_Free_type(ir_node *node);
990 void set_Free_type(ir_node *node, ir_type *tp);
992 where_alloc get_Free_where(ir_node *node);
993 void set_Free_where(ir_node *node, where_alloc where);
995 ir_node **get_Sync_preds_arr(ir_node *node);
996 int get_Sync_n_preds(ir_node *node);
997 ir_node *get_Sync_pred(ir_node *node, int pos);
998 void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
999 void add_Sync_pred(ir_node *node, ir_node *pred);
1001 /** Returns the source language type of a Proj node.
1002 * Must be an atomic type. Mode of type must be mode of node.
1004 ir_type *get_Proj_type(ir_node *node);
1006 /** Return the predecessor of a Proj node. */
1007 ir_node *get_Proj_pred(const ir_node *node);
1008 void set_Proj_pred(ir_node *node, ir_node *pred);
1009 /** Return the projection number of a Proj node. */
1010 long get_Proj_proj(const ir_node *node);
1011 void set_Proj_proj(ir_node *node, long proj);
1013 ir_node **get_Tuple_preds_arr(ir_node *node);
1014 int get_Tuple_n_preds(ir_node *node);
1015 ir_node *get_Tuple_pred(ir_node *node, int pos);
1016 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
1018 ir_node *get_Id_pred(ir_node *node);
1019 void set_Id_pred(ir_node *node, ir_node *pred);
1021 /** Confirm has a single result and returns 'value' unchanged.
1022 * The node expresses a restriction on 'value':
1023 * 'value' 'cmp' 'bound' == true. */
1024 ir_node *get_Confirm_value(ir_node *node);
1025 void set_Confirm_value(ir_node *node, ir_node *value);
1026 ir_node *get_Confirm_bound(ir_node *node);
1027 void set_Confirm_bound(ir_node *node, ir_node *bound);
1028 pn_Cmp get_Confirm_cmp(const ir_node *node);
1029 void set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
1032 * Mux Support: Note that Psi nodes with one condition can be handled
1033 * like Mux nodes, and the access functions work as expected.
1035 ir_node *get_Mux_sel(ir_node *node);
1036 void set_Mux_sel(ir_node *node, ir_node *sel);
1037 ir_node *get_Mux_false(ir_node *node);
1038 void set_Mux_false(ir_node *node, ir_node *ir_false);
1039 ir_node *get_Mux_true (ir_node *node);
1040 void set_Mux_true (ir_node *node, ir_node *ir_true);
1042 ir_node *get_Psi_cond(ir_node *node, int pos);
1043 void set_Psi_cond(ir_node *node, int pos, ir_node *cond);
1044 ir_node *get_Psi_val(ir_node *node, int pos);
1045 void set_Psi_val(ir_node *node, int pos, ir_node *val);
1046 ir_node *get_Psi_default(ir_node *node);
1047 void set_Psi_default(ir_node *node, ir_node *val);
1048 int get_Psi_n_conds(ir_node *node);
1051 * Projection numbers for result of CopyB node: use for Proj nodes!
1054 pn_CopyB_M_regular = 0, /**< The memory result. */
1055 pn_CopyB_X_regular = 1, /**< Execution result if no exception occurred. */
1056 pn_CopyB_X_except = 2, /**< The control flow result branching to the exception handler */
1057 pn_CopyB_M_except = 3, /**< The memory result in case the runtime function terminated with
1059 pn_CopyB_max = 4 /**< number of projections from a CopyB */
1060 } pn_CopyB; /* Projection numbers for CopyB. */
1061 #define pn_CopyB_M pn_CopyB_M_regular
1063 ir_node *get_CopyB_mem(ir_node *node);
1064 void set_CopyB_mem(ir_node *node, ir_node *mem);
1065 ir_node *get_CopyB_dst(ir_node *node);
1066 void set_CopyB_dst(ir_node *node, ir_node *dst);
1067 ir_node *get_CopyB_src(ir_node *node);
1068 void set_CopyB_src(ir_node *node, ir_node *src);
1069 ir_type *get_CopyB_type(ir_node *node);
1070 void set_CopyB_type(ir_node *node, ir_type *data_type);
1073 * Projection numbers for result of InstOf node: use for Proj nodes!
1076 pn_InstOf_M_regular = 0, /**< The memory result. */
1077 pn_InstOf_X_regular = 1, /**< Execution result if no exception occurred. */
1078 pn_InstOf_X_except = 2, /**< The control flow result branching to the exception handler */
1079 pn_InstOf_res = 3, /**< The checked object pointer. */
1080 pn_InstOf_M_except = 4, /**< The memory result in case the runtime function terminated with
1082 pn_InstOf_max = 5 /**< number of projections from an InstOf */
1084 #define pn_InstOf_M pn_InstOf_M_regular
1086 /** InstOf access */
1087 ir_type *get_InstOf_type(ir_node *node);
1088 void set_InstOf_type(ir_node *node, ir_type *type);
1089 ir_node *get_InstOf_store(ir_node *node);
1090 void set_InstOf_store(ir_node *node, ir_node *obj);
1091 ir_node *get_InstOf_obj(ir_node *node);
1092 void set_InstOf_obj(ir_node *node, ir_node *obj);
1095 * Projection numbers for Raise.
1098 pn_Raise_X = 0, /**< The control flow to the exception handler. */
1099 pn_Raise_M = 1, /**< The Memory result. */
1100 pn_Raise_max /**< number of projections from a Raise */
1101 } pn_Raise; /* Projection numbers for Raise. */
1103 ir_node *get_Raise_mem(ir_node *node);
1104 void set_Raise_mem(ir_node *node, ir_node *mem);
1105 ir_node *get_Raise_exo_ptr(ir_node *node); /* PoinTeR to EXception Object */
1106 void set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
1109 * Projection numbers for result of Bound node: use for Proj nodes!
1112 pn_Bound_M = 0, /**< The memory result. */
1113 pn_Bound_X_regular = 1, /**< Execution result if no exception occurred. */
1114 pn_Bound_X_except = 2, /**< The control flow result branching to the exception handler */
1115 pn_Bound_res = 3, /**< The checked index. */
1116 pn_Bound_max = 4 /**< number of projections from a Bound */
1119 /** Returns the memory input of a Bound operation. */
1120 ir_node *get_Bound_mem(ir_node *bound);
1121 void set_Bound_mem(ir_node *bound, ir_node *mem);
1123 /** Returns the index input of a Bound operation. */
1124 ir_node *get_Bound_index(ir_node *bound);
1125 void set_Bound_index(ir_node *bound, ir_node *idx);
1127 /** Returns the lower bound input of a Bound operation. */
1128 ir_node *get_Bound_lower(ir_node *bound);
1129 void set_Bound_lower(ir_node *bound, ir_node *lower);
1131 /** Returns the upper bound input of a Bound operation. */
1132 ir_node *get_Bound_upper(ir_node *bound);
1133 void set_Bound_upper(ir_node *bound, ir_node *upper);
1135 /** Return the operand of a Pin node. */
1136 ir_node *get_Pin_op(const ir_node *pin);
1137 void set_Pin_op(ir_node *pin, ir_node *node);
1139 /** A input/output constraint attribute */
1141 unsigned pos; /**< The inputs/output position for this constraint. */
1142 ident *constraint; /**< The constraint for this input/output. */
1143 } ir_asm_constraint;
1145 /** Return the assembler text of an ASM pseudo node. */
1146 ident *get_ASM_text(const ir_node *node);
1147 /** Return the number of input constraints for an ASM node. */
1148 int get_ASM_n_input_constraints(const ir_node *node);
1149 /** Return the input constraints for an ASM node. */
1150 const ir_asm_constraint *get_ASM_input_constraints(const ir_node *node);
1151 /** Return the number of output constraints for an ASM node. */
1152 int get_ASM_n_output_constraints(const ir_node *node);
1153 /** Return the output constraints for an ASM node. */
1154 const ir_asm_constraint *get_ASM_output_constraints(const ir_node *node);
1155 /** Return the number of clobbered registers for an ASM node. */
1156 int get_ASM_n_clobbers(const ir_node *node);
1157 /** Return the list of clobbered registers for an ASM node. */
1158 ident **get_ASM_clobbers(const ir_node *node);
1162 * NAME Auxiliary routines
1166 /** Returns operand of node if node is a Proj. */
1167 ir_node *skip_Proj(ir_node *node);
1168 /** Returns operand of node if node is a Proj. */
1169 const ir_node *skip_Proj_const(const ir_node *node);
1170 /** Returns operand of node if node is a Id. */
1171 ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
1172 /** Returns corresponding operand of Tuple if node is a Proj from
1174 ir_node *skip_Tuple(ir_node *node);
1175 /** returns operand of node if node is a Cast. */
1176 ir_node *skip_Cast(ir_node *node);
1177 /** Returns operand of node if node is a Confirm */
1178 ir_node *skip_Confirm(ir_node *node);
1179 /** Skip all high-level Operations. */
1180 ir_node *skip_HighLevel(ir_node *node);
1181 /** Returns true if irn is a Const node. */
1182 int is_Const(const ir_node *node);
1183 /** Returns true if a node is a Conv node. */
1184 int is_Conv(const ir_node *node);
1185 /** Returns true if node is a Bad node. */
1186 int is_Bad(const ir_node *node);
1187 /** Returns true if node is a NoMem node. */
1188 int is_NoMem(const ir_node *node);
1189 /** Returns true if node is a Start node. */
1190 int is_Start(const ir_node *node);
1191 /** Returns true if node is a Minus node. */
1192 int is_Minus(const ir_node *node);
1193 /** Returns true if node is a Mod node. */
1194 int is_Mod(const ir_node *node);
1195 /** Returns true if node is a Div node. */
1196 int is_Div(const ir_node *node);
1197 /** Returns true if node is a DivMod node. */
1198 int is_DivMod(const ir_node *node);
1199 /** Returns true if node is a Quot node. */
1200 int is_Quot(const ir_node *node);
1201 /** Returns true if node is an Add node. */
1202 int is_Add(const ir_node *node);
1203 /** Returns true if node is an And node. */
1204 int is_And(const ir_node *node);
1205 /** Returns true if node is an Or node. */
1206 int is_Or(const ir_node *node);
1207 /** Returns true if node is an Eor node. */
1208 int is_Eor(const ir_node *node);
1209 /** Returns true if node is a Sub node. */
1210 int is_Sub(const ir_node *node);
1211 /** Returns true if node is a Not node. */
1212 int is_Not(const ir_node *node);
1213 /** Returns true if node is a Psi node. */
1214 int is_Psi(const ir_node *node);
1215 /** Returns true if node is a Tuple node. */
1216 int is_Tuple(const ir_node *node);
1217 /** Returns true if the node is not a Block */
1218 int is_no_Block(const ir_node *node);
1219 /** Returns true if the node is a Block */
1220 int is_Block(const ir_node *node);
1221 /** Returns true if node is an Unknown node. */
1222 int is_Unknown(const ir_node *node);
1223 /** Returns true if node is a Return node. */
1224 int is_Return(const ir_node *node);
1225 /** Returns true if node is a Call node. */
1226 int is_Call(const ir_node *node);
1227 /** Returns true if node is a Sel node. */
1228 int is_Sel(const ir_node *node);
1229 /** Returns true if node is a Mul node. */
1230 int is_Mul(const ir_node *node);
1231 /** Returns true if node is a Mux node or a Psi with only one condition. */
1232 int is_Mux(const ir_node *node);
1233 /** Returns true if node is a Load node. */
1234 int is_Load(const ir_node *node);
1235 /** Returns true if node is a Store node. */
1236 int is_Store(const ir_node *node);
1237 /** Returns true if node is a Sync node. */
1238 int is_Sync(const ir_node *node);
1239 /** Returns true if node is a Confirm node. */
1240 int is_Confirm(const ir_node *node);
1241 /** Returns true if node is a Pin node. */
1242 int is_Pin(const ir_node *node);
1243 /** Returns true if node is a SymConst node. */
1244 int is_SymConst(const ir_node *node);
1245 /** Returns true if node is a Cond node. */
1246 int is_Cond(const ir_node *node);
1247 /** Returns true of node is a CopyB node */
1248 int is_CopyB(const ir_node *node);
1249 /** Returns true if node is a Cmp node. */
1250 int is_Cmp(const ir_node *node);
1251 /** Returns true if node is an Alloc node */
1252 int is_Alloc(const ir_node *node);
1253 /** Returns true if a node is a Jmp node */
1254 int is_Jmp(const ir_node *node);
1255 /** Returns true if a node is a Raise node */
1256 int is_Raise(const ir_node *node);
1257 /** Returns true if a node is an ASM node */
1258 int is_ASM(const ir_node *node);
1259 /** Returns true if node is a Proj node or a Filter node in
1260 * intraprocedural view */
1261 int is_Proj(const ir_node *node);
1262 /** Returns true if the operation manipulates control flow:
1263 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1264 int is_cfop(const ir_node *node);
1266 /** Returns true if the operation manipulates interprocedural control flow:
1267 CallBegin, EndReg, EndExcept */
1268 int is_ip_cfop(const ir_node *node);
1269 /** Returns true if the operation can change the control flow because
1270 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1271 Bad. Raise is not fragile, but a unconditional jump. */
1272 int is_fragile_op(const ir_node *node);
1273 /** Returns the memory operand of fragile operations. */
1274 ir_node *get_fragile_op_mem(ir_node *node);
1275 /** Returns the result mode of a Div operation. */
1276 ir_mode *get_divop_resmod(const ir_node *node);
1278 /** Returns true if the operation is a forking control flow
1279 * operation: Cond. */
1280 int is_irn_forking(const ir_node *node);
1282 /** Return the type associated with the value produced by n
1283 * if the node remarks this type as it is the case for
1284 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1285 ir_type *get_irn_type(ir_node *n);
1287 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1289 ir_type *get_irn_type_attr(ir_node *n);
1291 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1292 ir_entity *get_irn_entity_attr(ir_node *n);
1294 /** Returns non-zero for constant-like nodes. */
1295 int is_irn_constlike(const ir_node *node);
1298 * Returns non-zero for nodes that must be always optimized
1299 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1301 int is_irn_always_opt(const ir_node *node);
1304 * Returns non-zero for nodes that are allowed to have keep-alives and
1305 * are neither Block nor PhiM.
1307 int is_irn_keep(const ir_node *node);
1310 * Returns non-zero for nodes that are always placed in the start block.
1312 int is_irn_start_block_placed(const ir_node *node);
1315 * Returns non-zero for nodes that are machine operations.
1317 int is_irn_machine_op(const ir_node *node);
1320 * Returns non-zero for nodes that are machine operands.
1322 int is_irn_machine_operand(const ir_node *node);
1325 * Returns non-zero for nodes that have the n'th user machine flag set.
1327 int is_irn_machine_user(const ir_node *node, unsigned n);
1330 * A type to express conditional jump predictions.
1333 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1334 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1335 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1336 } cond_jmp_predicate;
1338 /** Gets the string representation of the jump prediction .*/
1339 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1341 /** Returns the conditional jump prediction of a Cond node. */
1342 cond_jmp_predicate get_Cond_jmp_pred(const ir_node *cond);
1344 /** Sets a new conditional jump prediction. */
1345 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1348 * Access custom node data.
1349 * The data must have been registered with
1350 * register_additional_node_data() before.
1351 * @param node The ir node to get the data from.
1352 * @param type The type of the data you registered.
1353 * @param off The value returned by register_additional_node_data().
1354 * @return A pointer of type @p type.
1356 #define get_irn_data(node,type,off) \
1357 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1360 * Get the pointer to the node some custom data belongs to.
1361 * @param data The pointer to the custom data.
1362 * @param off The number as returned by register_additional_node_data().
1363 * @return A pointer to the ir node the custom data belongs to.
1365 #define get_irn_data_base(data,off) \
1366 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1369 * Request additional data to be allocated with an ir node.
1370 * @param size The size of the additional data required.
1371 * @return A positive number, if the operation was successful, which
1372 * must be passed to the access macro get_irn_data(), 0 if the
1373 * registration failed.
1375 unsigned firm_register_additional_node_data(unsigned size);
1378 * Return a pointer to the node attributes.
1379 * Needed for user-defined nodes.
1381 void *get_irn_generic_attr(ir_node *node);
1382 const void *get_irn_generic_attr_const(const ir_node *node);
1385 * Returns the unique node index for the node in its graph.
1386 * This index is used to access phase information for this node.
1388 unsigned get_irn_idx(const ir_node *node);
1391 * Sets the debug information of a node.
1393 * @param n The node.
1394 * @param db The debug info.
1396 void set_irn_dbg_info(ir_node *n, dbg_info *db);
1399 * Returns the debug information of an node.
1401 * @param n The node.
1403 dbg_info *get_irn_dbg_info(const ir_node *n);
1405 /*-----------------------------------------------------------------*/
1407 /*-----------------------------------------------------------------*/
1410 /** Debug print the node.
1412 * Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
1413 * is set. Else does nothing. */
1414 void dump_irn(ir_node *n);
1416 /*@}*/ /* end of ir_node group definition */