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"
40 * @author Martin Trapp, Christian Schaefer
42 * Declarations of an ir node.
46 * @defgroup ir_node Declarations of an ir node.
48 * The type definition of ir_node is also in irgraph.h to resolve
49 * recursion between irnode.h and irgraph.h
51 * ir_node - a datatype representing a Firm node
53 * The common fields are:
55 * - firm_kind - A firm_kind tag containing k_type. This is useful
56 * for dynamically checking whether a node is a ir_node.
57 * - arity - The number of predecessors in the Firm graph.
58 * - in - A list with the predecessors in the Firm graph. There are
59 * routines to access individual elements and to obtain the
60 * array. The method returning the array should not be used.
61 * - mode - The mode of the node. There are routines to get the mode
62 * but also to access the mode's fields directly.
63 * - opcode - The opcode of the node. There are routines to get the opcode
64 * but also to access the opcode's fields directly.
65 * - node_nr - A unique number for the node. Available only if debugging
71 * you can work on the graph without considering the different types
72 * of nodes, it's just a big graph.
76 * Checks whether a pointer points to a ir node.
78 * @param thing an arbitrary pointer
79 * @return non-zero if the thing is a ir mode, else zero
81 int is_ir_node (const void *thing);
84 * Returns the number of predecessors without the block predecessor.
86 * @param node the IR-node
88 int get_irn_arity (const ir_node *node);
89 int get_irn_intra_arity(const ir_node *node);
90 int get_irn_inter_arity(const ir_node *node);
92 /** Replaces the old in array by a new one that will contain the ins given in
93 the parameters. Conserves the block predecessor. It copies the array passed.
94 This function is necessary to adjust in arrays of blocks, calls and phis.
95 Assumes that current_ir_graph is set to the graph containing "node".
96 "in" must contain all predecessors except the block that are required for
98 void set_irn_in(ir_node *node, int arity, ir_node *in[]);
100 /* to iterate through the predecessors without touching the array. No
101 order of predecessors guaranteed.
102 To iterate over the operands iterate from 0 to i < get_irn_arity(),
103 to iterate including the Block predecessor iterate from i = -1 to
104 i < get_irn_arity. */
105 /* Access predecessor n */
108 * Get the n-th predecessor of a node.
109 * This function removes Id predecessors.
110 * This function automatically handles intra- and interprocedural views.
112 ir_node *get_irn_n(const ir_node *node, int n);
115 * Add a artificial dependency to the node.
116 * The dependency is only inserted if it is not there already.
117 * @param node The node.
118 * @param dep The dependency target.
119 * @return The index in the array (get_irn_dep() with that index returns @p dep).
121 int add_irn_dep(ir_node *node, ir_node *dep);
124 * Copy all dependencies from a node to another.
125 * @param tgt The node which should be enriched.
126 * @param src The node whose dependencies shall be copied.
128 void add_irn_deps(ir_node *tgt, ir_node *src);
131 * Get the length of the dependency array.
132 * @param node The node.
133 * @return The length of the dependency array or 0 if it has not yet been allocated.
135 int get_irn_deps(const ir_node *node);
138 * Get an entry of the dependency array.
139 * @param node The node.
140 * @param pos The position.
141 * @return The node at that position.
143 ir_node *get_irn_dep(const ir_node *node, int pos);
146 * Set an entry of the dependency array.
147 * @param node The node.
148 * @param pos The position.
149 * @param dep The dependency target.
151 void set_irn_dep(ir_node *node, int pos, ir_node *dep);
155 * Get the n-th predecessor of a node in intraprocedural view.
156 * Can be used always if it's know that node is not a split one.
158 ir_node *get_irn_intra_n(const ir_node *node, int n);
161 * Get the n-th predecessor of a node in interprocedural view.
163 ir_node *get_irn_inter_n(const ir_node *node, int n);
165 /** Replace the n-th predecessor of a node with a new one. */
166 void set_irn_n(ir_node *node, int n, ir_node *in);
168 * Appends a new predecessor to a node. This only works for nodes with
170 * @returns the number of the new input
172 int add_irn_n(ir_node *node, ir_node *in);
173 /* Sets the mode struct of node. */
174 void set_irn_mode(ir_node *node, ir_mode *mode);
175 /** Gets the mode struct of a node. */
176 ir_mode *get_irn_mode(const ir_node *node);
177 /** Gets the mode-enum modecode. */
178 modecode get_irn_modecode(const ir_node *node);
179 /** Gets the ident for a string representation of the mode .*/
180 ident *get_irn_modeident(const ir_node *node);
181 /** Gets the string representation of the mode .*/
182 const char *get_irn_modename(const ir_node *node);
183 /** Gets the opcode struct of the node. */
184 ir_op *get_irn_op(const ir_node *node);
185 /** Sets the opcode struct of the node. */
186 void set_irn_op(ir_node *node, ir_op *op);
187 /** Gets the opcode-enum of the node. */
188 ir_opcode get_irn_opcode(const ir_node *node);
189 /** Get the string representation of the opcode. */
190 const char *get_irn_opname(const ir_node *node);
191 /** Get the ident for a string representation of the opcode. */
192 ident *get_irn_opident(const ir_node *node);
193 /** If arg is an argument of the node, returns it's position, -1 otherwise */
194 int get_irn_pred_pos(ir_node *node, ir_node *arg);
195 /** Gets the visited counter of a node. */
196 unsigned long get_irn_visited(const ir_node *node);
197 /** Sets the visited counter of a node. */
198 void set_irn_visited(ir_node *node, unsigned long visited);
199 /** Sets visited to get_irg_visited(current_ir_graph). */
200 void mark_irn_visited(ir_node *node);
201 /** Returns 1 if visited < get_irg_visited(current_ir_graph). */
202 int irn_not_visited(const ir_node *node);
203 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
204 int irn_visited(const ir_node *node);
207 * Sets the link of a node.
208 * Only allowed if the graph is NOT in phase_building.
210 void set_irn_link(ir_node *node, void *link);
212 /** Returns the link of a node. */
213 void *get_irn_link(const ir_node *node);
215 /** Returns the ir_graph this node belongs to. */
216 ir_graph *get_irn_irg(const ir_node *node);
218 /** Outputs a unique number for this node if libFIRM is compiled for
219 debugging, (configure with --enable-debug) else returns address
220 of node cast to long. */
221 long get_irn_node_nr(const ir_node *node);
223 /** Returns the pinned state of a node.
225 * Returns whether the node _always_ must be pinned.
226 * I.e., the node is not floating after global cse.
228 * @returns Either state op_pin_state_pinned or op_pin_state_floats.
230 op_pin_state get_irn_pinned(const ir_node *node);
232 /** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
233 void set_irn_pinned(ir_node *node, op_pin_state state);
235 /** Returns whether the node is currently pinned.
237 * If get_irn_pinned returns op_pin_state_floats and the graph the
238 * node belongs to is in state op_poin_state_floats then this function
239 * returns 'floats', else 'pinned'.
241 op_pin_state is_irn_pinned_in_irg(const ir_node *node);
244 * IR node constructor.
245 * Create a new IR node in irg, with an op, mode, arity and
246 * some incoming IR nodes.
247 * This constructor is used in every specific IR node constructor.
249 * @param db Debug info.
250 * @param irg IR-graph on with this new node should be constructed.
251 * @param block The block the new node belongs to
252 * @param op The opcode of the new node.
253 * @param mode The mode of the new node.
254 * @param arity The arity of the new node, <0 if can be changed dynamically.
255 * @param in An array of arity predecessor nodes.
258 new_ir_node(dbg_info *db,
267 * Return the block the node belongs to. This is only
268 * possible for pinned nodes or if the graph is in pinned state.
269 * Otherwise the block may be incorrect. This condition is
270 * now checked by an assertion.
272 * This works for all except Block. It can return Blocks or the Bad node.
274 * To express the difference to access routines that work for all
275 * nodes we use infix "nodes" and do not name this function
276 * get_irn_block(). */
277 ir_node *get_nodes_block (const ir_node *node);
279 /** Sets the Block of a node. */
280 void set_nodes_block (ir_node *node, ir_node *block);
283 * @function get_irn_block()
284 * @see get_nodes_block()
288 * Projection numbers for result of Start node: use for Proj nodes!
291 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
292 pn_Start_M, /**< Projection on the initial memory. */
293 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
294 pn_Start_P_globals, /**< Projection on the pointer to the data segment
295 containing _all_ global entities. Use for
296 position independent data/code access. */
297 pn_Start_P_tls, /**< Projection on the pointer to the thread local store
298 segment containing _all_thread local variables. */
299 pn_Start_T_args, /**< Projection on all arguments. */
300 pn_Start_P_value_arg_base, /**< Pointer to region of compound value arguments as defined by
301 type of this method. */
302 pn_Start_max /**< number of projections from a Start */
303 } pn_Start; /* Projection numbers for Start. */
305 /** Test whether arbitrary node is frame pointer.
307 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
308 * from Start. If so returns frame type, else Null. */
309 ir_type *is_frame_pointer(ir_node *n);
311 /** Test whether arbitrary node is globals pointer.
313 * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
314 * from Start. If so returns global type, else Null. */
315 ir_type *is_globals_pointer(ir_node *n);
317 /** Test whether arbitrary node is tls pointer.
319 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
320 * from Start. If so returns tls type, else Null. */
321 ir_type *is_tls_pointer(ir_node *n);
323 /** Test whether arbitrary node is value arg base.
325 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
326 * from Start. If so returns 1, else 0. */
327 int is_value_arg_pointer(ir_node *n);
330 /* @@@ no more supported */
331 ir_node **get_Block_cfgpred_arr(ir_node *node);
332 int get_Block_n_cfgpreds(const ir_node *node);
333 ir_node *get_Block_cfgpred(ir_node *node, int pos);
334 void set_Block_cfgpred(ir_node *node, int pos, ir_node *pred);
335 /** Get the predecessor block.
337 * Returns the block corresponding to the predecessor pos of block.
339 * There are several ambiguities we resolve with this function:
340 * - The direct predecessor can be a Proj, which is not pinned.
341 * We walk from the predecessor to the next pinned node
342 * (skip_Proj) and return the block that node is in.
343 * - If we encounter the Bad node, this function does not return
344 * Start, but the Bad node.
346 ir_node *get_Block_cfgpred_block(ir_node *node, int pos);
347 int get_Block_matured(ir_node *node);
348 void set_Block_matured(ir_node *node, int matured);
350 /** A visited flag only for block nodes.
351 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
352 unsigned long get_Block_block_visited(const ir_node *node);
353 void set_Block_block_visited(ir_node *node, unsigned long visit);
356 * Marks a block as dead but do not replace it with a Bad node.
357 * Dead blocks are removed in the con
359 ir_node *set_Block_dead(ir_node *block);
360 int is_Block_dead(const ir_node *block);
362 /* For this current_ir_graph must be set. */
363 void mark_Block_block_visited(ir_node *node);
364 int Block_not_block_visited(const ir_node *node);
365 int Block_block_visited(const ir_node *node);
367 /* Set and remove interprocedural predecessors. If the interprocedural
368 * predecessors are removed, the node has the same predecessors in
370 * @@@ Maybe better: arity is zero if no cg preds. */
371 void set_Block_cg_cfgpred_arr(ir_node *node, int arity, ir_node *in[]);
372 void set_Block_cg_cfgpred(ir_node *node, int pos, ir_node *pred);
373 /* @@@ not supported */
374 ir_node **get_Block_cg_cfgpred_arr(ir_node *node);
375 /** Returns the number of interprocedural predecessors. 0 if none. */
376 int get_Block_cg_n_cfgpreds(ir_node *node);
377 /** Return the interprocedural predecessor at position pos. */
378 ir_node *get_Block_cg_cfgpred(ir_node *node, int pos);
379 /** Frees the memory allocated for interprocedural predecessors. */
380 void remove_Block_cg_cfgpred_arr(ir_node *node);
381 /** Returns the extended basic block a block belongs to. */
382 ir_extblk *get_Block_extbb(const ir_node *block);
383 /** Sets the extended basic block a block belongs to. */
384 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
385 /** Get the Macro Block header of a (sub-) block. */
386 ir_node *get_Block_MacroBlock(const ir_node *block);
387 /** Returns the exception region number of a Block. */
388 ir_exc_region_t get_Block_exc_region(const ir_node *block);
389 /** Returns the ir_graph this Block belongs to. */
390 ir_graph *get_Block_irg(const ir_node *block);
392 /** Return the number of Keep alive node. */
393 int get_End_n_keepalives(ir_node *end);
394 /** Return the Keep alive node a position pos. */
395 ir_node *get_End_keepalive(ir_node *end, int pos);
396 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
397 void add_End_keepalive(ir_node *end, ir_node *ka);
398 /** Set the Keep alive node at position pos. */
399 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
400 /** Set new keep-alives. */
401 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
402 /** Set new keep-alives from old keep-alives, skipping irn. */
403 void remove_End_keepalive(ir_node *end, ir_node *irn);
405 /** Some parts of the End node are allocated separately -- their memory
406 is not recovered by dead_node_elimination if a End node is dead.
407 free_End() frees these data structures. */
408 void free_End(ir_node *end);
410 /** Return the target address of an IJmp */
411 ir_node *get_IJmp_target(ir_node *ijmp);
412 /** Sets the target address of an IJmp */
413 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
415 /* We distinguish three kinds of Cond nodes. These can be distinguished
416 by the mode of the selector operand and an internal flag of type cond_kind.
417 First we distinguish binary Conds and switch Conds.
418 A binary Cond has as selector a boolean value. Proj(0) projects the control
419 flow for case "False", Proj(1) the control flow for "True". A binary Cond
420 is recognized by the boolean selector.
421 The switch Cond has as selector an unsigned integer. It produces as result
422 an n+1 Tuple (cf0, ... , cfn) of control flows.
423 We differ two flavors of this Cond. The first, the dense Cond, passes
424 control along output i if the selector value is i, 0 <= i <= n. If the
425 selector value is >n it passes control along output n.
426 The second Cond flavor differences in the treatment of cases not specified in
427 the source program. It magically knows about the existence of Proj nodes.
428 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
429 exists. Else it passes control along output n (even if this Proj does not
430 exist.) This Cond we call "fragmentary". There is a special constructor
431 new_defaultProj that automatically sets the flavor.
432 The two switch flavors are distinguished by a flag of type cond_kind.
433 Default flavor is "dense"
436 dense, /**< Default. Missing Proj nodes are dead control flow. */
437 fragmentary /**< Special. No control flow optimizations allowed. Missing
438 Proj nodes mean default control flow, i.e., Proj(n). */
441 ir_node *get_Cond_selector(ir_node *node);
442 void set_Cond_selector(ir_node *node, ir_node *selector);
443 cond_kind get_Cond_kind(ir_node *node);
444 void set_Cond_kind(ir_node *node, cond_kind kind);
445 long get_Cond_defaultProj(ir_node *node);
448 * Projection numbers for conditions.
451 pn_Cond_false, /**< Control flow if operand is "false". */
452 pn_Cond_true, /**< Control flow if operand is "true". */
453 pn_Cond_max /**< number of projections from a Cond */
454 } pn_Cond; /* Projection numbers for Cond. */
456 ir_node *get_Return_mem(ir_node *node);
457 void set_Return_mem(ir_node *node, ir_node *mem);
458 ir_node **get_Return_res_arr(ir_node *node);
459 int get_Return_n_ress(ir_node *node);
460 ir_node *get_Return_res(ir_node *node, int pos);
461 void set_Return_res(ir_node *node, int pos, ir_node *res);
464 * Possible classes for constant classification.
467 CNST_NULL = 0, /**< The node is a const(0). */
468 CNST_ONE = +1, /**< The node is a const(1). */
469 CNST_ALL_ONE = -1, /**< The node is a const(11111...). */
470 CNST_OTHER = 2, /**< The tarval of the const has another value. */
471 CNST_SYMCONST = 3, /**< The node is symconst. */
472 CNST_NO_CONST = 4 /**< The node is no const at all. */
475 tarval *get_Const_tarval(const ir_node *node);
476 void set_Const_tarval(ir_node *node, tarval *con);
479 * Classify a node concerning constant properties.
480 * @param irn A node to check for.
481 * @return Constant properties of that node.
483 cnst_classify_t classify_Const(ir_node *irn);
485 /** Returns the source language type of a Const node.
486 * Must be an atomic type. Mode of type must be mode of node.
488 ir_type *get_Const_type(ir_node *node);
490 /** Sets the source language type of a Const node. */
491 void set_Const_type(ir_node *node, ir_type *tp);
493 /** This enum names the three different kinds of symbolic Constants
494 represented by SymConst. The content of the attribute type_or_id
495 depends on this tag. Use the proper access routine after testing
498 symconst_type_tag, /**< The SymConst is a type tag for the given type.
499 symconst_symbol is type *. */
500 symconst_type_size, /**< The SymConst is the size of the given type.
501 symconst_symbol is type *. */
502 symconst_type_align, /**< The SymConst is the alignment of the given type.
503 symconst_symbol is type *. */
504 symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
505 by the linker. The pointer is represented by a string.
506 symconst_symbol is ident *. */
507 symconst_addr_ent, /**< The SymConst is a symbolic pointer to be filled in
508 by the linker. The pointer is represented by an entity.
509 symconst_symbol is entity *. */
510 symconst_ofs_ent, /**< The SymConst is the offset of its entity in the entities
512 symconst_enum_const /**< The SymConst is a enumeration constant of an
516 /** Returns non-zero if s symconst kind has a type attribute */
517 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
519 /** Returns non-zero if s symconst kind has an ident attribute */
520 #define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)
522 /** Returns non-zero if s symconst kind has an entity attribute */
523 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
525 /** Returns non-zero if s symconst kind has an enum_const attribute */
526 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
528 /** SymConst attribute.
530 * This union contains the symbolic information represented by the node.
532 typedef union symconst_symbol {
533 ir_type *type_p; /**< the type of a symconst */
534 ident *ident_p; /**< the ident of a symconst */
535 ir_entity *entity_p; /**< the entity of a symconst */
536 ir_enum_const *enum_p; /**< the enumeration constant of a symconst */
539 /** Get the kind of the SymConst. */
540 symconst_kind get_SymConst_kind(const ir_node *node);
541 /** Set the kind of the SymConst. */
542 void set_SymConst_kind(ir_node *node, symconst_kind num);
544 /** Only to access SymConst of kind type_tag or size. Else assertion: */
545 ir_type *get_SymConst_type(ir_node *node);
546 void set_SymConst_type(ir_node *node, ir_type *tp);
548 /** Only to access SymConst of kind addr_name. Else assertion: */
549 ident *get_SymConst_name(const ir_node *node);
550 void set_SymConst_name(ir_node *node, ident *name);
552 /** Only to access SymConst of kind addr_ent. Else assertion: */
553 ir_entity *get_SymConst_entity(const ir_node *node);
554 void set_SymConst_entity(ir_node *node, ir_entity *ent);
556 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
557 ir_enum_const *get_SymConst_enum(const ir_node *node);
558 void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
560 /** Sets both: type and ptrinfo. Needed to treat the node independent of
561 its semantics. Does a memcpy for the memory sym points to. */
562 /* write 'union': firmjni then does not create a method... */
563 union symconst_symbol get_SymConst_symbol(const ir_node *node);
564 void set_SymConst_symbol(ir_node *node,
565 union symconst_symbol sym);
567 /** Access the type of the value represented by the SymConst.
569 * Example: primitive type int for SymConst size. */
570 ir_type *get_SymConst_value_type(ir_node *node);
571 void set_SymConst_value_type(ir_node *node, ir_type *tp);
573 ir_node *get_Sel_mem(ir_node *node);
574 void set_Sel_mem(ir_node *node, ir_node *mem);
575 ir_node *get_Sel_ptr(ir_node *node); /* ptr to the object to select from */
576 void set_Sel_ptr(ir_node *node, ir_node *ptr);
577 ir_node **get_Sel_index_arr(ir_node *node);
578 int get_Sel_n_indexs(ir_node *node);
579 ir_node *get_Sel_index(ir_node *node, int pos);
580 void set_Sel_index(ir_node *node, int pos, ir_node *index);
581 ir_entity *get_Sel_entity(ir_node *node); /* entity to select */
582 void set_Sel_entity (ir_node *node, ir_entity *ent);
585 * Projection numbers for result of Call node: use for Proj nodes!
588 pn_Call_M_regular = 0, /**< The memory result. */
589 pn_Call_X_regular = 1, /**< The control flow result when no exception occurs. */
590 pn_Call_X_except = 2, /**< The control flow result branching to the exception handler. */
591 pn_Call_T_result = 3, /**< The tuple containing all (0, 1, 2, ...) results. */
592 pn_Call_M_except = 4, /**< The memory result in case the called method terminated with
594 pn_Call_P_value_res_base = 5,/**< A pointer to the memory region containing copied results
595 passed by value (for compound result types). */
596 pn_Call_max = 6 /**< number of projections from a Call */
597 } pn_Call; /* Projection numbers for Call. */
598 #define pn_Call_M pn_Call_M_regular
600 ir_node *get_Call_mem(ir_node *node);
601 void set_Call_mem(ir_node *node, ir_node *mem);
602 ir_node *get_Call_ptr(ir_node *node);
603 void set_Call_ptr(ir_node *node, ir_node *ptr);
604 ir_node **get_Call_param_arr(ir_node *node);
605 /** Gets the number of parameters of a call. */
606 int get_Call_n_params(ir_node *node);
607 /** Gets the call parameter at position pos. */
608 ir_node *get_Call_param(ir_node *node, int pos);
609 /** Sets the call parameter at position pos. */
610 void set_Call_param(ir_node *node, int pos, ir_node *param);
611 /** Gets the type of a call. */
612 ir_type *get_Call_type(ir_node *node);
613 /** Sets the type of a call. */
614 void set_Call_type(ir_node *node, ir_type *tp);
615 /** Gets the arity of a call. Identical to get_Call_n_params(). */
616 int get_Call_arity(ir_node *node);
618 /** Set, get and remove the callee information for a Call node.
620 * The callee information lists all method entities that can be called
621 * from this node. If the address expression can not be analyzed fully,
622 * e.g., as entities can be called that are not in the compilation unit,
623 * the array contains the unknown_entity. The array contains only entities
624 * with peculiarity_existent, but with all kinds of visibility. The entities
625 * not necessarily contain an irg.
627 * The array is only accessible if callee information is valid. See flag
630 * The memory allocated for the array is managed automatically, i.e., it must
631 * not be freed if the Call node is removed from the graph.
633 * @param node A Call node.
635 int Call_has_callees(ir_node *node);
636 int get_Call_n_callees(ir_node *node);
637 ir_entity *get_Call_callee(ir_node *node, int pos);
639 /** Set the full callee array.
641 * The passed array is copied. Assumes current_ir_graph set properly! */
642 void set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
643 void remove_Call_callee_arr(ir_node *node);
645 ir_node *get_CallBegin_ptr(ir_node *node);
646 void set_CallBegin_ptr(ir_node *node, ir_node *ptr);
647 ir_node *get_CallBegin_call(ir_node *node);
648 void set_CallBegin_call(ir_node *node, ir_node *call);
650 /* For unary and binary arithmetic operations the access to the
651 operands can be factored out. Left is the first, right the
652 second arithmetic value as listed in tech report 1999-44.
653 unops are: Minus, Abs, Not, Conv, Cast
654 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
655 Shr, Shrs, Rot, Cmp */
656 int is_unop(const ir_node *node);
657 ir_node *get_unop_op(const ir_node *node);
658 void set_unop_op(ir_node *node, ir_node *op);
659 int is_binop(const ir_node *node);
660 ir_node *get_binop_left(const ir_node *node);
661 void set_binop_left(ir_node *node, ir_node *left);
662 ir_node *get_binop_right(const ir_node *node);
663 void set_binop_right(ir_node *node, ir_node *right);
665 ir_node *get_Add_left(const ir_node *node);
666 void set_Add_left(ir_node *node, ir_node *left);
667 ir_node *get_Add_right(const ir_node *node);
668 void set_Add_right(ir_node *node, ir_node *right);
670 ir_node *get_Sub_left(const ir_node *node);
671 void set_Sub_left(ir_node *node, ir_node *left);
672 ir_node *get_Sub_right(const ir_node *node);
673 void set_Sub_right(ir_node *node, ir_node *right);
675 ir_node *get_Minus_op(const ir_node *node);
676 void set_Minus_op(ir_node *node, ir_node *op);
678 ir_node *get_Mul_left(const ir_node *node);
679 void set_Mul_left(ir_node *node, ir_node *left);
680 ir_node *get_Mul_right(const ir_node *node);
681 void set_Mul_right(ir_node *node, ir_node *right);
683 ir_node *get_Quot_left(const ir_node *node);
684 void set_Quot_left(ir_node *node, ir_node *left);
685 ir_node *get_Quot_right(const ir_node *node);
686 void set_Quot_right(ir_node *node, ir_node *right);
687 ir_node *get_Quot_mem(ir_node *node);
688 void set_Quot_mem(ir_node *node, ir_node *mem);
689 ir_mode *get_Quot_resmode(const ir_node *node);
690 void set_Quot_resmode(ir_node *node, ir_mode *mode);
693 * Projection numbers for Quot: use for Proj nodes!
696 pn_Quot_M, /**< Memory result. */
697 pn_Quot_X_regular, /**< Execution result if no exception occurred. */
698 pn_Quot_X_except, /**< Execution result if exception occurred. */
699 pn_Quot_res, /**< Result of computation. */
700 pn_Quot_max /**< number of projections from a Quot */
701 } pn_Quot; /* Projection numbers for Quot. */
703 ir_node *get_DivMod_left(const ir_node *node);
704 void set_DivMod_left(ir_node *node, ir_node *left);
705 ir_node *get_DivMod_right(const ir_node *node);
706 void set_DivMod_right(ir_node *node, ir_node *right);
707 ir_node *get_DivMod_mem(ir_node *node);
708 void set_DivMod_mem(ir_node *node, ir_node *mem);
709 ir_mode *get_DivMod_resmode(const ir_node *node);
710 void set_DivMod_resmode(ir_node *node, ir_mode *mode);
713 * Projection numbers for DivMod: use for Proj nodes!
716 pn_DivMod_M, /**< Memory result. */
717 pn_DivMod_X_regular, /**< Execution result if no exception occurred. */
718 pn_DivMod_X_except, /**< Execution result if exception occurred. */
719 pn_DivMod_res_div, /**< Result of computation a / b. */
720 pn_DivMod_res_mod, /**< Result of computation a % b. */
721 pn_DivMod_max /**< number of projections from a DivMod */
722 } pn_DivMod; /* Projection numbers for DivMod. */
724 ir_node *get_Div_left(const ir_node *node);
725 void set_Div_left(ir_node *node, ir_node *left);
726 ir_node *get_Div_right(const ir_node *node);
727 void set_Div_right(ir_node *node, ir_node *right);
728 ir_node *get_Div_mem(ir_node *node);
729 void set_Div_mem(ir_node *node, ir_node *mem);
730 ir_mode *get_Div_resmode(const ir_node *node);
731 void set_Div_resmode(ir_node *node, ir_mode *mode);
734 * Projection numbers for Div: use for Proj nodes!
737 pn_Div_M, /**< Memory result. */
738 pn_Div_X_regular, /**< Execution result if no exception occurred. */
739 pn_Div_X_except, /**< Execution result if exception occurred. */
740 pn_Div_res, /**< Result of computation. */
741 pn_Div_max /**< number of projections from a Div */
742 } pn_Div; /* Projection numbers for Div. */
744 ir_node *get_Mod_left(const ir_node *node);
745 void set_Mod_left(ir_node *node, ir_node *left);
746 ir_node *get_Mod_right(const ir_node *node);
747 void set_Mod_right(ir_node *node, ir_node *right);
748 ir_node *get_Mod_mem(ir_node *node);
749 void set_Mod_mem(ir_node *node, ir_node *mem);
750 ir_mode *get_Mod_resmode(const ir_node *node);
751 void set_Mod_resmode(ir_node *node, ir_mode *mode);
754 * Projection numbers for Mod: use for Proj nodes!
757 pn_Mod_M, /**< Memory result. */
758 pn_Mod_X_regular, /**< Execution result if no exception occurred. */
759 pn_Mod_X_except, /**< Execution result if exception occurred. */
760 pn_Mod_res, /**< Result of computation. */
761 pn_Mod_max /**< number of projections from a Mod */
762 } pn_Mod; /* Projection numbers for Mod. */
764 ir_node *get_Abs_op(const ir_node *node);
765 void set_Abs_op(ir_node *node, ir_node *op);
767 ir_node *get_And_left(const ir_node *node);
768 void set_And_left(ir_node *node, ir_node *left);
769 ir_node *get_And_right(const ir_node *node);
770 void set_And_right(ir_node *node, ir_node *right);
772 ir_node *get_Or_left(const ir_node *node);
773 void set_Or_left(ir_node *node, ir_node *left);
774 ir_node *get_Or_right(const ir_node *node);
775 void set_Or_right(ir_node *node, ir_node *right);
777 ir_node *get_Eor_left(const ir_node *node);
778 void set_Eor_left(ir_node *node, ir_node *left);
779 ir_node *get_Eor_right(const ir_node *node);
780 void set_Eor_right(ir_node *node, ir_node *right);
782 ir_node *get_Not_op(const ir_node *node);
783 void set_Not_op(ir_node *node, ir_node *op);
786 * Projection numbers for Cmp are defined several times.
787 * The bit patterns are used for various tests, so don't change.
788 * The "unordered" values are possible results of comparing
789 * floating point numbers.
790 * Note that the encoding is imported, so do NOT change the order.
793 pn_Cmp_False = 0, /**< false */
794 pn_Cmp_Eq = 1, /**< equal */
795 pn_Cmp_Lt = 2, /**< less */
796 pn_Cmp_Le = pn_Cmp_Eq|pn_Cmp_Lt, /**< less or equal */
797 pn_Cmp_Gt = 4, /**< greater */
798 pn_Cmp_Ge = pn_Cmp_Eq|pn_Cmp_Gt, /**< greater or equal */
799 pn_Cmp_Lg = pn_Cmp_Lt|pn_Cmp_Gt, /**< less or greater */
800 pn_Cmp_Leg = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
801 pn_Cmp_Uo = 8, /**< unordered */
802 pn_Cmp_Ue = pn_Cmp_Uo|pn_Cmp_Eq, /**< unordered or equal */
803 pn_Cmp_Ul = pn_Cmp_Uo|pn_Cmp_Lt, /**< unordered or less */
804 pn_Cmp_Ule = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
805 pn_Cmp_Ug = pn_Cmp_Uo|pn_Cmp_Gt, /**< unordered or greater */
806 pn_Cmp_Uge = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
807 pn_Cmp_Ne = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
808 pn_Cmp_True = 15 /**< true */
809 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for JNI interface */
810 } pn_Cmp; /* Projection numbers for Cmp */
811 /* #define not_mask pn_Cmp_Leg */
813 /** returns the pnc name from an pnc constant */
814 const char *get_pnc_string(int pnc);
816 /** Calculates the negated (Complement(R)) pnc condition. */
817 int get_negated_pnc(int pnc, ir_mode *mode);
819 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
820 int get_inversed_pnc(int 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);
1012 long get_VProj_proj(const ir_node *node);
1013 void set_VProj_proj(ir_node *node, long value);
1016 ir_node **get_Tuple_preds_arr(ir_node *node);
1017 int get_Tuple_n_preds(ir_node *node);
1018 ir_node *get_Tuple_pred(ir_node *node, int pos);
1019 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
1021 ir_node *get_Id_pred(ir_node *node);
1022 void set_Id_pred(ir_node *node, ir_node *pred);
1024 /** Confirm has a single result and returns 'value' unchanged.
1025 * The node expresses a restriction on 'value':
1026 * 'value' 'cmp' 'bound' == true. */
1027 ir_node *get_Confirm_value(ir_node *node);
1028 void set_Confirm_value(ir_node *node, ir_node *value);
1029 ir_node *get_Confirm_bound(ir_node *node);
1030 void set_Confirm_bound(ir_node *node, ir_node *bound);
1031 pn_Cmp get_Confirm_cmp(const ir_node *node);
1032 void set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
1033 unsigned long get_Confirm_region(const ir_node *node);
1034 void set_Confirm_region(ir_node *node, unsigned long region);
1037 * Mux Support: Note that Psi nodes with one condition can be handled
1038 * like Mux nodes, and the access functions work as expected.
1040 ir_node *get_Mux_sel(ir_node *node);
1041 void set_Mux_sel(ir_node *node, ir_node *sel);
1042 ir_node *get_Mux_false(ir_node *node);
1043 void set_Mux_false(ir_node *node, ir_node *ir_false);
1044 ir_node *get_Mux_true (ir_node *node);
1045 void set_Mux_true (ir_node *node, ir_node *ir_true);
1047 ir_node *get_Psi_cond(ir_node *node, int pos);
1048 void set_Psi_cond(ir_node *node, int pos, ir_node *cond);
1049 ir_node *get_Psi_val(ir_node *node, int pos);
1050 void set_Psi_val(ir_node *node, int pos, ir_node *val);
1051 ir_node *get_Psi_default(ir_node *node);
1052 void set_Psi_default(ir_node *node, ir_node *val);
1053 int get_Psi_n_conds(ir_node *node);
1056 * Projection numbers for result of CopyB node: use for Proj nodes!
1059 pn_CopyB_M_regular = 0, /**< The memory result. */
1060 pn_CopyB_X_regular = 1, /**< Execution result if no exception occurred. */
1061 pn_CopyB_X_except = 2, /**< The control flow result branching to the exception handler */
1062 pn_CopyB_M_except = 3, /**< The memory result in case the runtime function terminated with
1064 pn_CopyB_max = 4 /**< number of projections from a CopyB */
1065 } pn_CopyB; /* Projection numbers for CopyB. */
1066 #define pn_CopyB_M pn_CopyB_M_regular
1068 ir_node *get_CopyB_mem(ir_node *node);
1069 void set_CopyB_mem(ir_node *node, ir_node *mem);
1070 ir_node *get_CopyB_dst(ir_node *node);
1071 void set_CopyB_dst(ir_node *node, ir_node *dst);
1072 ir_node *get_CopyB_src(ir_node *node);
1073 void set_CopyB_src(ir_node *node, ir_node *src);
1074 ir_type *get_CopyB_type(ir_node *node);
1075 void set_CopyB_type(ir_node *node, ir_type *data_type);
1078 * Projection numbers for result of InstOf node: use for Proj nodes!
1081 pn_InstOf_M_regular = 0, /**< The memory result. */
1082 pn_InstOf_X_regular = 1, /**< Execution result if no exception occurred. */
1083 pn_InstOf_X_except = 2, /**< The control flow result branching to the exception handler */
1084 pn_InstOf_res = 3, /**< The checked object pointer. */
1085 pn_InstOf_M_except = 4, /**< The memory result in case the runtime function terminated with
1087 pn_InstOf_max = 5 /**< number of projections from an InstOf */
1089 #define pn_InstOf_M pn_InstOf_M_regular
1091 /** InstOf access */
1092 ir_type *get_InstOf_type(ir_node *node);
1093 void set_InstOf_type(ir_node *node, ir_type *type);
1094 ir_node *get_InstOf_store(ir_node *node);
1095 void set_InstOf_store(ir_node *node, ir_node *obj);
1096 ir_node *get_InstOf_obj(ir_node *node);
1097 void set_InstOf_obj(ir_node *node, ir_node *obj);
1100 * Projection numbers for Raise.
1103 pn_Raise_X = 0, /**< The control flow to the exception handler. */
1104 pn_Raise_M = 1, /**< The Memory result. */
1105 pn_Raise_max /**< number of projections from a Raise */
1106 } pn_Raise; /* Projection numbers for Raise. */
1108 ir_node *get_Raise_mem(ir_node *node);
1109 void set_Raise_mem(ir_node *node, ir_node *mem);
1110 ir_node *get_Raise_exo_ptr(ir_node *node); /* PoinTeR to EXception Object */
1111 void set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
1114 * Projection numbers for result of Bound node: use for Proj nodes!
1117 pn_Bound_M = 0, /**< The memory result. */
1118 pn_Bound_X_regular = 1, /**< Execution result if no exception occurred. */
1119 pn_Bound_X_except = 2, /**< The control flow result branching to the exception handler */
1120 pn_Bound_res = 3, /**< The checked index. */
1121 pn_Bound_max = 4 /**< number of projections from a Bound */
1124 /** Returns the memory input of a Bound operation. */
1125 ir_node *get_Bound_mem(ir_node *bound);
1126 void set_Bound_mem(ir_node *bound, ir_node *mem);
1128 /** Returns the index input of a Bound operation. */
1129 ir_node *get_Bound_index(ir_node *bound);
1130 void set_Bound_index(ir_node *bound, ir_node *idx);
1132 /** Returns the lower bound input of a Bound operation. */
1133 ir_node *get_Bound_lower(ir_node *bound);
1134 void set_Bound_lower(ir_node *bound, ir_node *lower);
1136 /** Returns the upper bound input of a Bound operation. */
1137 ir_node *get_Bound_upper(ir_node *bound);
1138 void set_Bound_upper(ir_node *bound, ir_node *upper);
1140 /** Return the operand of a Pin node. */
1141 ir_node *get_Pin_op(const ir_node *pin);
1142 void set_Pin_op(ir_node *pin, ir_node *node);
1144 /** A input/output constraint attribute */
1146 unsigned pos; /**< The inputs/output position for this constraint. */
1147 ident *constraint; /**< The constraint for this input/output. */
1148 } ir_asm_constraint;
1150 /** Return the assembler text of an ASM pseudo node. */
1151 ident *get_ASM_text(const ir_node *node);
1152 /** Return the number of input constraints for an ASM node. */
1153 int get_ASM_n_input_constraints(const ir_node *node);
1154 /** Return the input constraints for an ASM node. */
1155 const ir_asm_constraint *get_ASM_input_constraints(const ir_node *node);
1156 /** Return the number of output constraints for an ASM node. */
1157 int get_ASM_n_output_constraints(const ir_node *node);
1158 /** Return the output constraints for an ASM node. */
1159 const ir_asm_constraint *get_ASM_output_constraints(const ir_node *node);
1160 /** Return the number of clobbered registers for an ASM node. */
1161 int get_ASM_n_clobbers(const ir_node *node);
1162 /** Return the list of clobbered registers for an ASM node. */
1163 ident **get_ASM_clobbers(const ir_node *node);
1167 * NAME Auxiliary routines
1171 /** Returns operand of node if node is a Proj. */
1172 ir_node *skip_Proj(ir_node *node);
1173 /** Returns operand of node if node is a Proj. */
1174 const ir_node *skip_Proj_const(const ir_node *node);
1175 /** Returns operand of node if node is a Id. */
1176 ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
1177 /** Returns corresponding operand of Tuple if node is a Proj from
1179 ir_node *skip_Tuple(ir_node *node);
1180 /** returns operand of node if node is a Cast. */
1181 ir_node *skip_Cast(ir_node *node);
1182 /** Returns operand of node if node is a Confirm */
1183 ir_node *skip_Confirm(ir_node *node);
1184 /** Skip all high-level Operations. */
1185 ir_node *skip_HighLevel(ir_node *node);
1186 /** Returns true if irn is a Const node. */
1187 int is_Const(const ir_node *node);
1188 /** Returns true if a node is a Conv node. */
1189 int is_Conv(const ir_node *node);
1190 /** Returns true if node is a Bad node. */
1191 int is_Bad(const ir_node *node);
1192 /** Returns true if node is a NoMem node. */
1193 int is_NoMem(const ir_node *node);
1194 /** Returns true if node is a Start node. */
1195 int is_Start(const ir_node *node);
1196 /** Returns true if node is a Minus node. */
1197 int is_Minus(const ir_node *node);
1198 /** Returns true if node is a Mod node. */
1199 int is_Mod(const ir_node *node);
1200 /** Returns true if node is a Div node. */
1201 int is_Div(const ir_node *node);
1202 /** Returns true if node is a DivMod node. */
1203 int is_DivMod(const ir_node *node);
1204 /** Returns true if node is a Quot node. */
1205 int is_Quot(const ir_node *node);
1206 /** Returns true if node is an Add node. */
1207 int is_Add(const ir_node *node);
1208 /** Returns true if node is a Sub node. */
1209 int is_Sub(const ir_node *node);
1210 /** Returns true if node is a Tuple node. */
1211 int is_Tuple(const ir_node *node);
1212 /** Returns true if the node is not a Block */
1213 int is_no_Block(const ir_node *node);
1214 /** Returns true if the node is a Block */
1215 int is_Block(const ir_node *node);
1216 /** Returns true if node is an Unknown node. */
1217 int is_Unknown(const ir_node *node);
1218 /** Returns true if node is a Return node. */
1219 int is_Return(const ir_node *node);
1220 /** Returns true if node is a Call node. */
1221 int is_Call(const ir_node *node);
1222 /** Returns true if node is a Sel node. */
1223 int is_Sel(const ir_node *node);
1224 /** Returns true if node is a Mul node. */
1225 int is_Mul(const ir_node *node);
1226 /** Returns true if node is a Mux node or a Psi with only one condition. */
1227 int is_Mux(const ir_node *node);
1228 /** Returns true if node is a Load node. */
1229 int is_Load(const ir_node *node);
1230 /** Returns true if node is a Store node. */
1231 int is_Store(const ir_node *node);
1232 /** Returns true if node is a Sync node. */
1233 int is_Sync(const ir_node *node);
1234 /** Returns true if node is a Confirm node. */
1235 int is_Confirm(const ir_node *node);
1236 /** Returns true if node is a Pin node. */
1237 int is_Pin(const ir_node *node);
1238 /** Returns true if node is a SymConst node. */
1239 int is_SymConst(const ir_node *node);
1240 /** Returns true if node is a Cond node. */
1241 int is_Cond(const ir_node *node);
1242 /** Returns true of node is a CopyB node */
1243 int is_CopyB(const ir_node *node);
1244 /** Returns true if node is a Cmp node. */
1245 int is_Cmp(const ir_node *node);
1246 /** Returns true if node is an Alloc node */
1247 int is_Alloc(const ir_node *node);
1248 /** Returns true if a node is a Jmp node */
1249 int is_Jmp(const ir_node *node);
1250 /** Returns true if a node is a Raise node */
1251 int is_Raise(const ir_node *node);
1252 /** Returns true if a node is an ASM node */
1253 int is_ASM(const ir_node *node);
1254 /** Returns true if node is a Proj node or a Filter node in
1255 * intraprocedural view */
1256 int is_Proj(const ir_node *node);
1257 /** Returns true if the operation manipulates control flow:
1258 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1259 int is_cfop(const ir_node *node);
1261 /** Returns true if the operation manipulates interprocedural control flow:
1262 CallBegin, EndReg, EndExcept */
1263 int is_ip_cfop(const ir_node *node);
1264 /** Returns true if the operation can change the control flow because
1265 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1266 Bad. Raise is not fragile, but a unconditional jump. */
1267 int is_fragile_op(const ir_node *node);
1268 /** Returns the memory operand of fragile operations. */
1269 ir_node *get_fragile_op_mem(ir_node *node);
1270 /** Returns the result mode of a Div operation. */
1271 ir_mode *get_divop_resmod(const ir_node *node);
1273 /** Returns true if the operation is a forking control flow
1274 * operation: Cond. */
1275 int is_irn_forking(const ir_node *node);
1277 /** Return the type associated with the value produced by n
1278 * if the node remarks this type as it is the case for
1279 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1280 ir_type *get_irn_type(ir_node *n);
1282 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1284 ir_type *get_irn_type_attr(ir_node *n);
1286 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1287 ir_entity *get_irn_entity_attr(ir_node *n);
1289 /** Returns non-zero for constant-like nodes. */
1290 int is_irn_constlike(const ir_node *node);
1293 * Returns non-zero for nodes that must be always optimized
1294 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1296 int is_irn_always_opt(const ir_node *node);
1299 * Returns non-zero for nodes that are allowed to have keep-alives and
1300 * are neither Block nor PhiM.
1302 int is_irn_keep(const ir_node *node);
1305 * Returns non-zero for nodes that are always placed in the start block.
1307 int is_irn_start_block_placed(const ir_node *node);
1310 * Returns non-zero for nodes that are machine operations.
1312 int is_irn_machine_op(const ir_node *node);
1315 * Returns non-zero for nodes that are machine operands.
1317 int is_irn_machine_operand(const ir_node *node);
1320 * Returns non-zero for nodes that have the n'th user machine flag set.
1322 int is_irn_machine_user(const ir_node *node, unsigned n);
1325 * A type to express conditional jump predictions.
1328 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1329 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1330 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1331 } cond_jmp_predicate;
1333 /** Gets the string representation of the jump prediction .*/
1334 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1336 /** Returns the conditional jump prediction of a Cond node. */
1337 cond_jmp_predicate get_Cond_jmp_pred(const ir_node *cond);
1339 /** Sets a new conditional jump prediction. */
1340 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1343 * Access custom node data.
1344 * The data must have been registered with
1345 * register_additional_node_data() before.
1346 * @param node The ir node to get the data from.
1347 * @param type The type of the data you registered.
1348 * @param off The value returned by register_additional_node_data().
1349 * @return A pointer of type @p type.
1351 #define get_irn_data(node,type,off) \
1352 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1355 * Get the pointer to the node some custom data belongs to.
1356 * @param data The pointer to the custom data.
1357 * @param off The number as returned by register_additional_node_data().
1358 * @return A pointer to the ir node the custom data belongs to.
1360 #define get_irn_data_base(data,off) \
1361 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1364 * Request additional data to be allocated with an ir node.
1365 * @param size The size of the additional data required.
1366 * @return A positive number, if the operation was successful, which
1367 * must be passed to the access macro get_irn_data(), 0 if the
1368 * registration failed.
1370 unsigned register_additional_node_data(unsigned size);
1373 * Return a pointer to the node attributes.
1374 * Needed for user-defined nodes.
1376 void *get_irn_generic_attr(ir_node *node);
1377 const void *get_irn_generic_attr_const(const ir_node *node);
1380 * Returns the unique node index for the node in its graph.
1381 * This index is used to access phase information for this node.
1383 unsigned get_irn_idx(const ir_node *node);
1385 /*-----------------------------------------------------------------*/
1387 /*-----------------------------------------------------------------*/
1390 /** Debug print the node.
1392 * Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
1393 * is set. Else does nothing. */
1394 void dump_irn(ir_node *n);
1396 /*@}*/ /* end of ir_node group definition */