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 Various irnode constructors. Automatic construction of SSA
24 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Boris Boesler,
30 Ideas for improvement:
31 -# Handle construction of exceptions more comfortable:
32 Add new constructors that pass the exception region (or better the
33 Phi for the memories, the ex. region can be found from there) as parameter,
34 constructor then adds all Proj nodes and returns the pointer
35 to the Proj node that selects the result of the arithmetic operation.
36 -# Maybe hide the exception region in a global variable, especially if
37 it is always unambiguous.
43 * documentation no more supported since 2001
45 * ir node construction.
47 * This file documents all datatypes and constructors needed to
48 * build a FIRM representation of a procedure. The constructors are
49 * also implemented in this file.
51 * The documentation also gives a short manual how to use the library.
53 * For extensive documentation of FIRM see UKA Techreport 1999-14.
56 * Three kinds of nodes
57 * --------------------
59 * There are three kinds of nodes known to the ir: entities,
62 * + ir_nodes are the actual nodes of the FIRM intermediate representation.
63 * They represent operations on the data of the program and control flow
66 * + entity ==> implemented in entity.h
67 * Refers to a single entity of the compiled program, e.g. a field of a
68 * class or a method. If a method or variable can not be assigned to
69 * a method or class or the like, it is a global object.
71 * + types ==> implemented in type.h
72 * With types type information is represented. There are several type
75 * Implementation of the FIRM operations: ir_node
76 * ----------------------------------------------
78 * Ir_nodes represent operations on the data of the program and control flow
79 * operations. Examples of ir_nodes: Add, Jmp, Cmp
81 * FIRM is a dataflow graph. A dataflow graph is a directed graph,
82 * so that every node has incoming and outgoing edges. A node is
83 * executable if every input at it's incoming edges is available.
84 * Execution of the dataflow graph is started at the Start node which
85 * has no incoming edges and ends when the End node executes, even if
86 * there are still executable or not executed nodes. (Is this true,
87 * or must all executable nodes be executed?) (There are exceptions
88 * to the dataflow paradigma that all inputs have to be available
89 * before a node can execute: Phi, Block. See UKA Techreport
92 * The implementation of FIRM differs from the view as a dataflow
93 * graph. To allow fast traversion of the graph edges are
94 * implemented as C-pointers. Inputs to nodes are not ambiguous, the
95 * results can be used by several other nodes. Each input can be
96 * implemented as a single pointer to a predecessor node, outputs
97 * need to be lists of pointers to successors. Therefore a node
98 * contains pointers to it's predecessor so that the implementation is a
99 * dataflow graph with reversed edges. It has to be traversed bottom
102 * All nodes of the ir have the same basic structure. They are
103 * distinguished by a field containing the opcode.
105 * The fields of an ir_node:
107 * kind A firm_kind tag containing k_ir_node. This is useful for
108 * dynamically checking the type of a node.
110 * *op This ir_op gives the opcode as a tag and a string
111 * and the number of attributes of an ir_node. There is
112 * one statically allocated struct ir_op for each opcode.
114 * *mode The ir_mode of the operation represented by this firm
115 * node. The mode of the operation is the mode of it's
116 * result. A Firm mode is a datatype as known to the target,
117 * not a type of the source language.
119 * visit A flag for traversing the ir.
121 * **in An array with pointers to the node's predecessors.
123 * *link A pointer to an ir_node. With this pointer all Phi nodes
124 * are attached to a Block, i.e., a Block points to it's
125 * first Phi node, this node points to the second Phi node
126 * in the Block and so fourth. Used in mature_immBlock
127 * to find all Phi nodes to be matured. It's also used to
128 * annotate a node with a better, optimized version of it.
130 * attr An attr struct containing the attributes of the nodes. The
131 * attributes depend on the opcode of the node. The number
132 * of these attributes is given in op.
136 * Not yet documented. See irop.h.
140 * Not yet documented. See irmode.h.
142 * GLOBAL VARIABLES -- now also fields of ir_graph.
145 * current_ir_graph Points to the current ir_graph. All constructors for
146 * nodes add nodes to this graph.
148 * ir_visited An int used as flag to traverse the ir_graph.
150 * block_visited An int used as a flag to traverse block nodes in the
153 * Others not yet documented.
157 * CONSTRUCTOR FOR IR_GRAPH --> see irgraph.h
158 * ========================
161 * PROCEDURE TO CONSTRUCT AN IR GRAPH --> see also Firm tutorial
162 * ==================================
164 * This library supplies several interfaces to construct a FIRM graph for
166 * - A "comfortable" interface generating SSA automatically. Automatically
167 * computed predecessors of nodes need not be specified in the constructors.
168 * (new_<Node> constructurs and a set of additional routines.)
169 * - A less comfortable interface where all predecessors except the block
170 * an operation belongs to need to be specified. SSA must be constructed
171 * by hand. (new_<Node> constructors and set_cur_block()). This interface
172 * is called "block oriented". It automatically calles the local optimizations
174 * - An even less comfortable interface where the block needs to be specified
175 * explicitly. This is called the "raw" interface. (new_r_<Node>
176 * constructors). These nodes are not optimized.
178 * To use the functionality of the comfortable interface correctly the Front
179 * End needs to follow certain protocols. This is explained in the following.
180 * To build a correct IR with the other interfaces study the semantics of
181 * the firm node (See tech-reprot UKA 1999-14). For the construction of
182 * types and entities see the documentation in those modules.
184 * First the Frontend needs to decide which variables and values used in
185 * a procedure can be represented by dataflow edges. These are variables
186 * that need not be saved to memory as they cause no side effects visible
187 * out of the procedure. Often these are all compiler generated
188 * variables and simple local variables of the procedure as integers,
189 * reals and pointers. The frontend has to count and number these variables.
191 * First an ir_graph needs to be constructed with new_ir_graph. The
192 * constructor gets the number of local variables. The graph is hold in the
193 * global variable irg.
195 * Now the construction of the procedure can start. Several basic blocks can
196 * be constructed in parallel, but the code within each block needs to
197 * be constructed (almost) in program order.
199 * A global variable holds the current basic block. All (non block) nodes
200 * generated are added to this block. The current block can be set with
201 * set_cur_block(block). If several blocks are constructed in parallel block
202 * switches need to be performed constantly.
204 * To generate a Block node (with the comfortable interface) it's predecessor
205 * control flow nodes need not be known. In case of cyclic control flow these
206 * can not be known when the block is constructed. With add_immBlock_pred(block,
207 * cfnode) predecessors can be added to the block. If all predecessors are
208 * added to the block mature_immBlock(b) needs to be called. Calling mature_immBlock
209 * early improves the efficiency of the Phi node construction algorithm.
210 * But if several blocks are constructed at once, mature_immBlock must only
211 * be called after performing all set_values and set_stores in the block!
212 * (See documentation of new_immBlock constructor.)
214 * The constructors of arithmetic nodes require that their predecessors
215 * are mentioned. Sometimes these are available in the Frontend as the
216 * predecessors have just been generated by the frontend. If they are local
217 * values the predecessors can be obtained from the library with a call to
218 * get_value(local_val_nr). (local_val_nr needs to be administered by
219 * the Frontend.) A call to get_value triggers the generation of Phi nodes.
220 * If an arithmetic operation produces a local value this value needs to be
221 * passed to the library by set_value(node, local_val_nr).
222 * In straight line code these two operations just remember and return the
223 * pointer to nodes producing the value. If the value passes block boundaries
224 * Phi nodes can be inserted.
225 * Similar routines exist to manage the Memory operands: set_store and
228 * Several nodes produce more than one result. An example is the Div node.
229 * Such nodes return tuples of values. From these individual values can be
230 * extracted by proj nodes.
232 * The following example illustrates the construction of a simple basic block
233 * with two predecessors stored in variables cf_pred1 and cf_pred2, containing
236 * and finally jumping to an other block. The variable a got the local_val_nr
237 * 42 by the frontend.
239 * ir_node *this_block, *cf_pred1, *cf_pred2, *a_val, *mem, *div, *res, *cf_op;
241 * this_block = new_immBlock();
242 * add_immBlock_pred(this_block, cf_pred1);
243 * add_immBlock_pred(this_block, cf_pred2);
244 * mature_immBlock(this_block);
245 * a_val = get_value(42, mode_Iu);
247 * div = new_Div(mem, a_val, a_val, mode_Iu);
248 * mem = new_Proj(div, mode_M, pn_Div_M); * for the numbers for Proj see docu *
249 * res = new_Proj(div, mode_Iu, pn_Div_res);
251 * set_value(res, 42);
254 * For further information look at the documentation of the nodes and
255 * constructors and at the paragraph COPING WITH DATA OBJECTS at the
256 * end of this documentation.
258 * The comfortable interface contains the following routines further explained
261 * ir_node *new_immBlock (void);
262 * ir_node *new_Start (void);
263 * ir_node *new_End (void);
264 * ir_node *new_Jmp (void);
265 * ir_node *new_IJmp (ir_node *tgt);
266 * ir_node *new_Cond (ir_node *c);
267 * ir_node *new_Return (ir_node *store, int arity, ir_node **in);
268 * ir_node *new_Const (ir_mode *mode, tarval *con);
269 * ir_node *new_SymConst (symconst_symbol value, symconst_kind kind);
270 * ir_node *new_simpleSel (ir_node *store, ir_node *objptr, ir_entity *ent);
271 * ir_node *new_Sel (ir_node *store, ir_node *objptr, int arity,
272 * ir_node **in, ir_entity *ent);
273 * ir_node *new_Call (ir_node *store, ir_node *callee, int arity,
274 * ir_node **in, type_method *type);
275 * ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode);
276 * ir_node *new_Sub (ir_node *op1, ir_node *op2, ir_mode *mode);
277 * ir_node *new_Minus (ir_node *op, ir_mode *mode);
278 * ir_node *new_Mul (ir_node *op1, ir_node *op2, ir_mode *mode);
279 * ir_node *new_Mulh (ir_node *op1, ir_node *op2, ir_mode *mode);
280 * ir_node *new_Quot (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
281 * ir_node *new_DivMod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
282 * ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
283 * ir_node *new_Mod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state;
284 * ir_node *new_Abs (ir_node *op, ir_mode *mode);
285 * ir_node *new_And (ir_node *op1, ir_node *op2, ir_mode *mode);
286 * ir_node *new_Or (ir_node *op1, ir_node *op2, ir_mode *mode);
287 * ir_node *new_Eor (ir_node *op1, ir_node *op2, ir_mode *mode);
288 * ir_node *new_Not (ir_node *op, ir_mode *mode);
289 * ir_node *new_Shl (ir_node *op, ir_node *k, ir_mode *mode);
290 * ir_node *new_Shr (ir_node *op, ir_node *k, ir_mode *mode);
291 * ir_node *new_Shrs (ir_node *op, ir_node *k, ir_mode *mode);
292 * ir_node *new_Rot (ir_node *op, ir_node *k, ir_mode *mode);
293 * ir_node *new_Cmp (ir_node *op1, ir_node *op2);
294 * ir_node *new_Conv (ir_node *op, ir_mode *mode);
295 * ir_node *new_Cast (ir_node *op, ir_type *to_tp);
296 * ir_node *new_Carry (ir_node *op1, ir_node *op2, ir_mode *mode);
297 * ir_node *new_Borrow (ir_node *op1, ir_node *op2, ir_mode *mode);
298 * ir_node *new_Load (ir_node *store, ir_node *addr, ir_mode *mode);
299 * ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val);
300 * ir_node *new_Alloc (ir_node *store, ir_node *size, ir_type *alloc_type,
301 * where_alloc where);
302 * ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size,
303 * ir_type *free_type, where_alloc where);
304 * ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj);
305 * ir_node *new_NoMem (void);
306 * ir_node *new_Mux (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
307 * ir_node *new_Psi (int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode);
308 * ir_node *new_CopyB (ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
309 * ir_node *new_InstOf (ir_node *store, ir_node obj, ir_type *ent);
310 * ir_node *new_Raise (ir_node *store, ir_node *obj);
311 * ir_node *new_Bound (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
312 * ir_node *new_Pin (ir_node *node);
314 * void add_immBlock_pred (ir_node *block, ir_node *jmp);
315 * void mature_immBlock (ir_node *block);
316 * void set_cur_block (ir_node *target);
317 * ir_node *get_value (int pos, ir_mode *mode);
318 * void set_value (int pos, ir_node *value);
319 * ir_node *get_store (void);
320 * void set_store (ir_node *store);
321 * keep_alive (ir_node ka)
323 * IR_NODES AND CONSTRUCTORS FOR IR_NODES
324 * =======================================
326 * All ir_nodes are defined by a common data structure. They are distinguished
327 * by their opcode and differ in the number of their attributes.
329 * The constructor for the block node sets current_block to itself.
330 * Const nodes are always added to the start block.
331 * All other constructors add the created node to the current_block.
332 * swich_block(block) allows to set the current block to block.
334 * Watch for my inconsistent use of input and predecessor (dataflow view)
335 * and `the node points to' (implementation view).
337 * The following description of the nodes lists four properties them if these
339 * - the parameters to the constructor
340 * - the inputs of the Firm node
341 * - the outputs of the Firm node
342 * - attributes to the node
346 * ir_node *new_immBlock (void)
347 * ----------------------------
349 * Creates a new block. Sets current_block to itself. When a new block is
350 * created it cannot be known how many predecessors this block will have in the
351 * control flow graph. Therefore the list of inputs can not be fixed at
352 * creation. Predecessors can be added with add_immBlock_pred (block, control flow
353 * operation). With every added predecessor the number of inputs to Phi nodes
356 * The block can be completed by mature_immBlock(block) if all predecessors are
357 * known. If several blocks are built at once, mature_immBlock can only be called
358 * after set_value has been called for all values that are life at the end
359 * of the block. This is necessary so that Phi nodes created mature_immBlock
360 * get the right predecessors in case of cyclic dependencies. If all set_values
361 * of this block are called after maturing it and before calling get_value
362 * in some block that is control flow dependent on this block, the construction
365 * Example for faulty ir construction: (draw the graph on a paper and you'll
368 * block_before_loop = new_block();
370 * mature_immBlock(block_before_loop);
371 * before2header = new_Jmp;
373 * loop_header = new_block ();
374 * header2body - new_Jmp();
376 * loop_body = new_block ();
377 * body2header = new_Jmp();
379 * add_immBlock_pred(loop_header, before2header);
380 * add_immBlock_pred(loop_header, body2header);
381 * add_immBlock_pred(loop_body, header2body);
383 * mature_immBlock(loop_header);
384 * mature_immBlock(loop_body);
386 * get_value(loop_body, x); // gets the Phi in loop_header
387 * set_value(loop_header, x); // sets the value the above get_value should
388 * // have returned!!!
390 * Mature_immBlock also fixes the number of inputs to the Phi nodes. Mature_immBlock
391 * should be called as early as possible, as afterwards the generation of Phi
392 * nodes is more efficient.
395 * There is an input for each control flow predecessor of the block.
396 * The input points to an instruction producing an output of type X.
397 * Possible predecessors: Start, Jmp, Cond, Raise or Return or any node
398 * possibly causing an exception. (Often the real predecessors are Projs.)
400 * Mode BB (R), all nodes belonging to this block should consume this output.
401 * As they are strict (except Block and Phi node) it is a necessary condition
402 * that the block node executed before any other node in this block executes.
404 * block.matured Indicates whether the block is mature.
406 * This attribute contains all local values valid in this
407 * block. This is needed to build the Phi nodes and removed
408 * if the graph is complete. This field is used by the
409 * internal construction algorithm and should not be accessed
413 * ir_node *new_Block (int arity, ir_node **in)
414 * --------------------------------------------
416 * Creates a new Block with the given list of predecessors. This block
417 * is mature. As other constructors calls optimization and vrfy for the
418 * block. If one of the predecessors is Unknown (as it has to be filled in
419 * later) optimizations are skipped. This is necessary to
420 * construct Blocks in loops. Leaving Unknown in the Block after finishing
421 * the construction may have strange effects, especially for interprocedural
422 * representation and analysis.
425 * CONTROL FLOW OPERATIONS
426 * -----------------------
428 * In each block there must be exactly one of the control flow
429 * operations Start, End, Jmp, Cond, Return or Raise. The output of a
430 * control flow operation points to the block to be executed next.
432 * ir_node *new_Start (void)
433 * -------------------------
435 * Creates a start node. Not actually needed public. There is only one such
436 * node in each procedure which is automatically created by new_ir_graph.
439 * No inputs except the block it belogns to.
441 * A tuple of 4 (5, 6) distinct values. These are labeled by the following
442 * projection numbers (pn_Start):
443 * * pn_Start_X_initial_exec mode X, points to the first block to be exe * cuted.
444 * * pn_Start_M mode M, the global store
445 * * pn_Start_P_frame_base mode P, a pointer to the base of the proce * dures stack frame.
446 * * pn_Start_P_globals mode P, a pointer to the part of the memory * containing_all_ global things.
447 * * pn_Start_T_args mode T, a tuple containing all arguments of * the procedure.
450 * ir_node *new_End (void)
451 * -----------------------
453 * Creates an end node. Not actually needed public. There is only one such
454 * node in each procedure which is automatically created by new_ir_graph.
457 * No inputs except the block it belongs to.
461 * ir_node *new_Jmp (void)
462 * -----------------------
464 * Creates a Jmp node.
467 * The block the node belongs to
469 * Control flow to the next block.
471 * ir_node *new_IJmp (ir_node *tgt)
472 * -----------------------
474 * Creates an IJmp node.
477 * The node that represents the target jump address
479 * Control flow to an unknown target, must be pinned by
482 * ir_node *new_Cond (ir_node *c)
483 * ------------------------------
485 * Creates a Cond node. There are two versions of this node.
491 * A tuple of two control flows. The first is taken if the input is
492 * false, the second if it is true.
496 * A value of mode I_u. (i)
498 * A tuple of n control flows. If the Cond's input is i, control
499 * flow will procede along output i. If the input is >= n control
500 * flow proceeds along output n.
502 * ir_node *new_Return (ir_node *store, int arity, ir_node **in)
503 * -------------------------------------------------------------
505 * The return node has as inputs the results of the procedure. It
506 * passes the control flow to the end_block.
512 * Control flow to the end block.
516 * ir_node *new_Const (ir_mode *mode, tarval *con)
517 * -----------------------------------------------
519 * Creates a constant in the constant table and adds a Const node
520 * returning this value to the start block.
523 * *mode The mode of the constant.
524 * *con Points to an entry in the constant table.
525 * This pointer is added to the attributes of
526 * the node (self->attr.con)
528 * No inputs except the block it belogns to.
530 * The constant value.
532 * attr.con A tarval* pointer to the proper entry in the constant
535 * ir_node *new_SymConst (union symconst_symbol value, symconst_addr_ent kind)
536 * ---------------------------------------------------------------------------
538 * There are three kinds of symbolic constants:
539 * symconst_type_tag The symbolic constant represents a type tag.
540 * symconst_type_size The symbolic constant represents the size of a type.
541 * symconst_type_align The symbolic constant represents the alignment of a type.
542 * symconst_addr_name Information for the linker, e.g. the name of a global
544 * symconst_addr_name The symbolic constant represents the address of an entity.
546 * To represent a pointer to an entity that is represented by an entity
547 * datastructure don't use
548 * new_SymConst((type_or_id*)get_entity_ld_ident(ent), symconst_addr_name);.
549 * Use a real const instead:
550 * new_SymConst(ent, symconst_addr_ent);
551 * This makes the Constant independent of name changes of the entity due to
555 * kind The kind of the symbolic constant: type_tag, size or link_info.
556 * *type_or_id Points to the type the tag stands for or to the type
557 * whose size is represented by the constant or to an ident
558 * representing the linkage info.
561 * No inputs except the block it belogns to.
563 * An unsigned integer (I_u) or a pointer (P).
566 * attr.i.num The symconst_addr_ent, i.e. one of
568 * -symconst_type_size
569 * -symconst_type_align
570 * -symconst_addr_name
572 * If the attr.i.num is symconst_type_tag, symconst_type_size or symconst_type_align,
573 * the node contains an attribute:
575 * attr.i.*type, a pointer to a type_class. The mode of the node is mode_Is.
576 * if it is linkage_ptr_info it contains
577 * attr.i.*ptrinfo, an ident holding information for the linker. The mode
578 * of the node is mode_P_mach.
582 * ir_node *new_simpleSel (ir_node *store, ir_node *frame, ir_entity *sel)
583 * -----------------------------------------------------------------------
586 * Selects an entity from a compound type. This entity can be a field or
590 * *store The memory in which the object the entity should be selected
592 * *frame The pointer to the object.
593 * *sel The entity to select.
596 * The memory containing the object.
597 * A pointer to the object.
598 * An unsigned integer.
600 * A pointer to the selected entity.
602 * attr.sel Pointer to the entity
605 * ir_node *new_Sel (ir_node *store, ir_node *frame, int arity, ir_node **in,
606 * --------------------------------------------------------------------------
610 * Selects a field from an array type. The entity has as owner the array, as
611 * type the arrays element type. The indices to access an array element are
615 * *store The memory in which the object the entity should be selected from
617 * *frame The pointer to the object.
618 * *arity number of array indices.
619 * *in array with index inputs to the node.
620 * *sel The entity to select.
623 * The memory containing the object.
624 * A pointer to the object.
625 * As much unsigned integer as there are array expressions.
627 * A pointer to the selected entity.
629 * attr.sel Pointer to the entity
631 * The constructors new_Sel and new_simpleSel generate the same ir nodes.
632 * simpleSel just sets the arity of the index inputs to zero.
635 * ARITHMETIC OPERATIONS
636 * ---------------------
638 * ir_node *new_Call (ir_node *store, ir_node *callee, int arity, ir_node **in,
639 * ----------------------------------------------------------------------------
643 * Creates a procedure call.
646 * *store The actual store.
647 * *callee A pointer to the called procedure.
648 * arity The number of procedure parameters.
649 * **in An array with the pointers to the parameters.
650 * The constructor copies this array.
651 * *type Type information of the procedure called.
654 * The store, the callee and the parameters.
656 * A tuple containing the eventually changed store and the procedure
659 * attr.call Contains the type information for the procedure.
662 * ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode)
663 * ------------------------------------------------------------
667 * ir_node *new_Sub (ir_node *op1, ir_node *op2, ir_mode *mode)
668 * ------------------------------------------------------------
672 * ir_node *new_Minus (ir_node *op, ir_mode *mode)
673 * -----------------------------------------------
675 * Unary Minus operations on integer and floating point values.
677 * ir_node *new_Mul (ir_node *op1, ir_node *op2, ir_mode *mode)
678 * ------------------------------------------------------------
682 * ir_node *new_Mulh (ir_node *op1, ir_node *op2, ir_mode *mode)
683 * ------------------------------------------------------------
685 * Returns the high order bits of a n*n=2n multiplication.
687 * ir_node *new_Quot (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state)
688 * -------------------------------------------------------------------------------------------------
690 * Quot performs exact division of floating point numbers. It's mode
691 * is Tuple, the mode of the result must match the Proj mode
692 * that extracts the result of the arithmetic operations.
695 * The store needed to model exceptions and the two operands.
697 * A tuple containing a memory and a execution for modeling exceptions
698 * and the result of the arithmetic operation.
700 * ir_node *new_DivMod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state)
701 * ---------------------------------------------------------------------------------------------------
703 * Performs Div and Mod on integer values.
706 * A tuple containing a memory and a execution for modeling exceptions
707 * and the two result of the arithmetic operations.
709 * ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state)
710 * ------------------------------------------------------------------------------------------------
714 * ir_node *new_Mod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state)
715 * ------------------------------------------------------------------------------------------------
719 * ir_node *new_Abs (ir_node *op, ir_mode *mode)
720 * ---------------------------------------------
724 * ir_node *new_And (ir_node *op1, ir_node *op2, ir_mode *mode)
725 * ------------------------------------------------------------
729 * ir_node *new_Or (ir_node *op1, ir_node *op2, ir_mode *mode)
730 * -----------------------------------------------------------
734 * ir_node *new_Eor (ir_node *op1, ir_node *op2, ir_mode *mode)
735 * ------------------------------------------------------------
739 * ir_node *new_Not (ir_node *op, ir_mode *mode)
740 * ---------------------------------------------
742 * This node constructs a constant where all bits are set to one
743 * and a Eor of this constant and the operator. This simulates a
746 * ir_node *new_Shl (ir_node *op, ir_node *k, ir_mode *mode)
747 * ---------------------------------------------------------
751 * ir_node *new_Shr (ir_node *op, ir_node *k, ir_mode *mode)
752 * ---------------------------------------------------------
754 * Logic shift right, i.e., zero extended.
757 * ir_node *new_Shrs (ir_node *op, ir_node *k, ir_mode *mode)
758 * ----------------------------------------------------------
760 * Arithmetic shift right, i.e., sign extended.
762 * ir_node *new_Rot (ir_node *op, ir_node *k, ir_mode *mode)
763 * ---------------------------------------------------------
765 * Rotates the operand to the (right?) by k bits.
767 * ir_node *new_Carry (ir_node *op1, ir_node *op2, ir_mode *mode)
768 * ------------------------------------------------------------
770 * Calculates the Carry value for integer addition. Used only
773 * ir_node *new_Borrow (ir_node *op1, ir_node *op2, ir_mode *mode)
774 * ------------------------------------------------------------
776 * Calculates the Borrow value for integer substraction. Used only
779 * ir_node *new_Conv (ir_node *op, ir_mode *mode)
780 * ---------------------------------------------
782 * Mode conversion. For allowed conversions see UKA Tech Report
785 * ir_node *new_Cmp (ir_node *op1, ir_node *op2)
786 * ---------------------------------------------
789 * The two values to be compared.
791 * A 16-tuple containing the results of the 16 different comparisons.
792 * The following is a list giving the comparisons and a projection
793 * number (pn_Cmp) to use in Proj nodes to extract the proper result.
797 * pn_Cmp_Le less or equal
799 * pn_Cmp_Ge greater of equal
800 * pn_Cmp_Lg less or greater
801 * pn_Cmp_Leg less, equal or greater = ordered
802 * pn_Cmp_Uo unordered
803 * pn_Cmp_Ue unordered or equal
804 * pn_Cmp_Ul unordered or less
805 * pn_Cmp_Ule unordered, less or equal
806 * pn_Cmp_Ug unordered or greater
807 * pn_Cmp_Uge unordered, greater or equal
808 * pn_Cmp_Ne unordered, less or greater = not equal
815 * In general, Phi nodes are automaitcally inserted. In some cases, if
816 * all predecessors of a block are known, an explicit Phi node constructor
817 * is needed. E.g., to construct a FIRM graph for a statement as
818 * a = (b==c) ? 2 : 5;
820 * ir_node *new_Phi (int arity, ir_node **in, ir_mode *mode)
821 * ---------------------------------------------------------
823 * Creates a Phi node. The in's order has to correspond to the order
824 * of in's of current_block. This is not checked by the library!
825 * If one of the predecessors is Unknown (as it has to be filled in
826 * later) optimizations are skipped. This is necessary to
827 * construct Phi nodes in loops. Leaving Unknown in the Phi after finishing
828 * the construction may have strange effects, especially for interprocedural
829 * representation and analysis.
832 * arity number of predecessors
833 * **in array with predecessors
834 * *mode The mode of it's inputs and output.
836 * A Phi node has as many inputs as the block it belongs to.
837 * Each input points to a definition of the same value on a
838 * different path in the control flow.
840 * The definition valid in this block.
842 * ir_node *new_Mux (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode)
843 * -----------------------------------------------------------------------------
845 * Creates a Mux node. This node implements the following semantic:
846 * If the sel node (which must be of mode_b) evaluates to true, its value is
847 * ir_true, else ir_false;
850 * ir_node *new_Psi (int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode)
851 * -----------------------------------------------------------------------------
853 * Creates a Psi node. This node implements the following semantic:
857 * OPERATIONS TO MANAGE MEMORY EXPLICITLY
858 * --------------------------------------
860 * ir_node *new_Load (ir_node *store, ir_node *addr, ir_mode *mode)
861 * ----------------------------------------------------------------
863 * The Load operation reads a value from memory.
866 * *store The current memory.
867 * *addr A pointer to the variable to be read in this memory.
868 * *mode The mode of the value to be loaded.
871 * The memory and a pointer to a variable in this memory.
873 * A tuple of the memory, a control flow to be taken in case of
874 * an exception and the loaded value.
876 * ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val)
877 * ----------------------------------------------------------------
879 * The Store operation writes a value to a variable in memory.
882 * The memory, a pointer to a variable in this memory and the value
883 * to write to this variable.
885 * A tuple of the changed memory and a control flow to be taken in
886 * case of an exception.
888 * ir_node *new_Alloc (ir_node *store, ir_node *size, ir_type *alloc_type,
889 * -----------------------------------------------------------------------
893 * The Alloc node allocates a new variable. It can be specified whether the
894 * variable should be allocated to the stack or to the heap.
897 * *store The memory which shall contain the new variable.
898 * ** *size The number of bytes to allocate. Old. **
899 * *size We decided that the size easily can be derived from the type.
900 * This field is for allocating arrays, i.e., it gives the multiple
901 * of the size of alloc_type to allocate memory for.
902 * *alloc_type The type of the allocated variable.
903 * where Where to allocate the variable, either heap_alloc or stack_alloc.
906 * A memory and an unsigned integer.
908 * A tuple of the changed memory, a control flow to be taken in
909 * case of an exception and the pointer to the new variable.
911 * a.where Indicates where the variable is allocated.
912 * a.*type A pointer to the class the allocated data object
915 * ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size, ir_type *free_type,
916 * -----------------------------------------------------------------------------------
920 * The Free node frees memory of the given variable.
923 * *store The memory which shall contain the new variable.
924 * *ptr The pointer to the object to free.
925 * *size The number of objects of type free_type to free in a sequence.
926 * *free_type The type of the freed variable.
927 * where Where the variable was allocated, either heap_alloc or stack_alloc.
930 * A memory, a pointer and an unsigned integer.
932 * The changed memory.
934 * f.*type A pointer to the type information of the freed data object.
938 * ir_node *new_Sync (int arity, ir_node **in)
939 * -------------------------------------------
941 * The Sync operation unifies several partial memory blocks. These blocks
942 * have to be pairwise disjunct or the values in common locations have to
943 * be identical. This operation allows to specify all operations that eventually
944 * need several partial memory blocks as input with a single entrance by
945 * unifying the memories with a preceding Sync operation.
948 * arity The number of memories to synchronize.
949 * **in An array of pointers to nodes that produce an output of
954 * The unified memory.
960 * ir_node *new_Bad (void)
961 * -----------------------
963 * Returns the unique Bad node current_ir_graph->bad.
964 * This node is used to express results of dead code elimination.
966 * ir_node *new_NoMem (void)
967 * -----------------------------------------------------------------------------------
969 * Returns the unique NoMem node current_ir_graph->no_mem.
970 * This node is used as input for operations that need a Memory, but do not
971 * change it like Div by const != 0, analyzed calls etc.
973 * ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj)
974 * ----------------------------------------------------------
976 * Selects one entry of a tuple. This is a hidden edge with attributes.
979 * *arg A node producing a tuple.
980 * *mode The mode of the value to project.
981 * proj The position of the value in the tuple.
987 * ir_node *new_Tuple (int arity, ir_node **in)
988 * --------------------------------------------
990 * Builds a Tuple from single values. This is needed to implement
991 * optimizations that remove a node that produced a tuple. The node can be
992 * replaced by the Tuple operation so that the following Proj nodes have not to
993 * be changed. (They are hard to find due to the implementation with pointers
994 * in only one direction.) The Tuple node is smaller than any other
995 * node, so that a node can be changed into a Tuple by just changing it's
996 * opcode and giving it a new in array.
999 * arity The number of tuple elements.
1000 * **in An array containing pointers to the nodes producing the
1003 * ir_node *new_Id (ir_node *val, ir_mode *mode)
1004 * ---------------------------------------------
1006 * The single output of the Id operation is it's input. Also needed
1007 * for optimizations.
1010 * HIGH LEVEL OPERATIONS
1011 * ---------------------
1013 * ir_node *new_CopyB (ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type)
1014 * -----------------------------------------------------------------------------------
1016 * Describes a high level block copy of a compound type from address src to
1017 * address dst. Must be lowered to a Call to a runtime memory copy function.
1020 * HIGH LEVEL OPERATIONS: Exception Support
1021 * ----------------------------------------
1022 * See TechReport 1999-14, chapter Exceptions.
1024 * ir_node *new_InstOf(ir_node *store, ir_node *ptr, ir_type *type);
1025 * -----------------------------------------------------------------------------------
1027 * Describes a high level type check. Must be lowered to a Call to a runtime check
1030 * ir_node *new_Raise (ir_node *store, ir_node *obj)
1031 * -------------------------------------------------
1033 * Raises an exception. Unconditional change of control flow. Writes
1034 * an explicit Except variable to memory to pass it to the exception
1035 * handler. Must be lowered to a Call to a runtime check
1040 * A pointer to the Except variable.
1042 * A tuple of control flow and the changed memory state. The control flow
1043 * points to the exception handler if it is definied in this procedure,
1044 * else it points to the end_block.
1046 * ir_node *new_Bound (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
1047 * -----------------------------------------------------------------------------------
1049 * Describes a high level bounds check. Must be lowered to a Call to a runtime check
1052 * ir_node *new_Pin (ir_node *node);
1053 * -----------------------------------------------------------------------------------
1055 * Pin the value of the node node in the current block No users of the Pin node can
1056 * float above the Block of the Pin. The node cannot float behind this block. Often
1057 * used to Pin the NoMem node.
1060 * COPING WITH DATA OBJECTS
1061 * ========================
1063 * Two kinds of data objects have to be distinguished for generating
1064 * FIRM. First there are local variables other than arrays that are
1065 * known to be alias free. Second there are all other data objects.
1066 * For the first a common SSA representation is built, the second
1067 * are modeled by saving them to memory. The memory is treated as
1068 * a single local variable, the alias problem is hidden in the
1069 * content of this variable.
1071 * All values known in a Block are listed in the block's attribute,
1072 * block.**graph_arr which is used to automatically insert Phi nodes.
1073 * The following two functions can be used to add a newly computed value
1074 * to the array, or to get the producer of a value, i.e., the current
1077 * inline void set_value (int pos, ir_node *value)
1078 * -----------------------------------------------
1080 * Has to be called for every assignment to a local variable. It
1081 * adds the value to the array of used values at position pos. Pos
1082 * has to be a unique identifier for an entry in the procedure's
1083 * definition table. It can be used to access the value again.
1084 * Requires current_block to be set correctly.
1086 * ir_node *get_value (int pos, ir_mode *mode)
1087 * -------------------------------------------
1089 * Returns the node defining the value referred to by pos. If the
1090 * value is not defined in this block a Phi node is generated and
1091 * all definitions reaching this Phi node are collected. It can
1092 * happen that the algorithm allocates an unnecessary Phi node,
1093 * e.g. if there is only one definition of this value, but this
1094 * definition reaches the currend block on several different
1095 * paths. This Phi node will be eliminated if optimizations are
1096 * turned on right after it's creation.
1097 * Requires current_block to be set correctly.
1099 * There are two special routines for the global store:
1101 * void set_store (ir_node *store)
1102 * -------------------------------
1104 * Adds the store to the array of known values at a reserved
1106 * Requires current_block to be set correctly.
1108 * ir_node *get_store (void)
1109 * -------------------------
1111 * Returns the node defining the actual store.
1112 * Requires current_block to be set correctly.
1115 * inline void keep_alive (ir_node *ka)
1116 * ------------------------------------
1118 * Keep this node alive because it is (might be) not in the control
1119 * flow from Start to End. Adds the node to the list in the end
1123 #ifndef FIRM_IR_IRCONS_H
1124 #define FIRM_IR_IRCONS_H
1126 #include "firm_common.h"
1128 #include "irgraph.h"
1130 /*-------------------------------------------------------------------------*/
1131 /* The raw interface */
1132 /*-------------------------------------------------------------------------*/
1134 /** Constructor for a Block node.
1136 * Constructs a mature block with the given predecessors. Use Unknown
1137 * nodes as predecessors to construct a block if the number of
1138 * predecessors is known, but not the predecessors themselves. This
1139 * constructor does not set current_block. It not be used with
1140 * automatic Phi node construction.
1142 * @param *db A Pointer for debug information.
1143 * @param irg The ir graph the block belongs to.
1144 * @param arity The number of control predecessors.
1145 * @param in[] An array of control predecessors. The length of
1146 * the array must be 'arity'. The constructor copies this array.
1148 ir_node *new_rd_Block (dbg_info *db, ir_graph *irg, int arity, ir_node *in[]);
1150 /** Constructor for a Start node.
1152 * @param *db A pointer for debug information.
1153 * @param *irg The ir graph the node belongs to.
1154 * @param *block The ir block the node belongs to.
1156 ir_node *new_rd_Start (dbg_info *db, ir_graph *irg, ir_node *block);
1158 /** Constructor for a End node.
1160 * @param *db A pointer for debug information.
1161 * @param *irg The ir graph the node belongs to.
1162 * @param *block The ir block the node belongs to.
1164 ir_node *new_rd_End (dbg_info *db, ir_graph *irg, ir_node *block);
1166 /** Constructor for a Jmp node.
1168 * Jmp represents control flow to a single control successor.
1170 * @param *db A pointer for debug information.
1171 * @param *irg The ir graph the node belongs to.
1172 * @param *block The ir block the node belongs to.
1174 ir_node *new_rd_Jmp (dbg_info *db, ir_graph *irg, ir_node *block);
1176 /** Constructor for an IJmp node.
1178 * IJmp represents control flow to a single control successor not
1179 * statically known i.e. an indirect Jmp.
1181 * @param *db A pointer for debug information.
1182 * @param *irg The ir graph the node belongs to.
1183 * @param *block The ir block the node belongs to.
1184 * @param *tgt The ir node representing the target address.
1186 ir_node *new_rd_IJmp (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *tgt);
1188 /** Constructor for a Break node.
1190 * Break represents control flow to a single control successor just as Jmp.
1191 * The blocks separated by a break may not be concatenated by an optimization.
1192 * It is used for the interprocedural representation where blocks are parted
1193 * behind Call nodes to represent the control flow to called procedures.
1195 * @param *db A pointer for debug information.
1196 * @param *irg The ir graph the node belong to.
1197 * @param *block The block the node belong to.
1199 ir_node *new_rd_Break (dbg_info *db, ir_graph *irg, ir_node *block);
1201 /** Constructor for a Cond node.
1203 * If c is mode_b represents a conditional branch (if/else). If c is
1204 * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond
1205 * node, default Proj is 0.)
1207 * This is not consistent: Input to Cond is Is, Proj has as proj number
1210 * @param *db A pointer for debug information.
1211 * @param *irg The ir graph the node belongs to.
1212 * @param *block The ir block the node belongs to.
1213 * @param *c The conditions parameter. Can be of mode b or I_u.
1215 ir_node *new_rd_Cond (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *c);
1217 /** Constructor for a Return node.
1219 * Returns the memory an zero or more return values. Only node that
1220 * can end regular control flow.
1222 * @param *db A pointer for debug information.
1223 * @param *irg The ir graph the node belongs to.
1224 * @param *block The ir block the node belongs to.
1225 * @param *store The state of memory.
1226 * @param arity Number of return values.
1227 * @param *in Array of length arity with return values. The constructor copies this array.
1229 ir_node *new_rd_Return (dbg_info *db, ir_graph *irg, ir_node *block,
1230 ir_node *store, int arity, ir_node *in[]);
1232 /** Constructor for a Const_type node.
1234 * The constant represents a target value. This constructor sets high
1235 * level type information for the constant value.
1237 * @param *db A pointer for debug information.
1238 * @param *irg The ir graph the node belongs to.
1239 * @param *block The ir block the node belongs to.
1240 * @param *mode The mode of the operands and results.
1241 * @param *con Points to an entry in the constant table.
1242 * @param *tp The type of the constant.
1244 ir_node *new_rd_Const_type (dbg_info *db, ir_graph *irg, ir_node *block,
1245 ir_mode *mode, tarval *con, ir_type *tp);
1247 /** Constructor for a Const node.
1249 * Constructor for a Const node. The constant represents a target
1250 * value. Sets the type information to type_unknown. (No more
1251 * supported: If tv is entity derives a somehow useful type.)
1253 * @param *db A pointer for debug information.
1254 * @param *irg The ir graph the node belongs to.
1255 * @param *block The ir block the node belongs to.
1256 * @param *mode The mode of the operands and results.
1257 * @param *con Points to an entry in the constant table.
1259 ir_node *new_rd_Const (dbg_info *db, ir_graph *irg, ir_node *block,
1260 ir_mode *mode, tarval *con);
1262 /** Constructor for a SymConst_type node.
1264 * This is the constructor for a symbolic constant.
1265 * There are four kinds of symbolic constants:
1266 * - type_tag The symbolic constant represents a type tag. The type the
1267 * tag stands for is given explicitly.
1268 * - type_size The symbolic constant represents the size of a type. The
1269 * type of which the constant represents the size is given
1271 * - type_align The symbolic constant represents the alignment of a type. The
1272 * type of which the constant represents the size is given
1274 * - addr_name The symbolic constant represents the address of an entity
1275 * (variable or method). The variable is indicated by a name
1276 * that is valid for linking.
1277 * - addr_ent The symbolic constant represents the address of an entity
1278 * (variable or method). The variable is given explicitly by
1281 * Inputs to the node:
1282 * No inputs except the block it belongs to.
1283 * Outputs of the node.
1284 * An unsigned integer (I_u) or a pointer (P).
1286 * Mention union in declaration so that the firmjni generator recognizes that
1287 * it can not cast the argument to an int.
1289 * @param *db A pointer for debug information.
1290 * @param *irg The ir graph the node belongs to.
1291 * @param *block The ir block the node belongs to.
1292 * @param symkind The kind of the symbolic constant: type_tag, size, addr_name or addr_ent.
1293 * @param value A type, entity or a ident depending on the SymConst kind.
1294 * @param tp The source type of the constant.
1296 ir_node *new_rd_SymConst_type (dbg_info *db, ir_graph *irg, ir_node *block, union symconst_symbol value,
1297 symconst_kind symkind, ir_type *tp);
1299 /** Constructor for a SymConst node.
1301 * Same as new_rd_SymConst_type, except that it sets the type to type_unknown. */
1302 ir_node *new_rd_SymConst (dbg_info *db, ir_graph *irg, ir_node *block,
1303 union symconst_symbol value, symconst_kind symkind);
1305 /** Constructor for a SymConst addr_ent node.
1307 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1308 * symconst_addr_ent.
1309 * Adds the SymConst to the start block of irg. */
1310 ir_node *new_rd_SymConst_addr_ent (dbg_info *db, ir_graph *irg, ir_entity *symbol, ir_type *tp);
1312 /** Constructor for a SymConst ofs_ent node.
1314 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1316 * Adds the SymConst to the start block of irg. */
1317 ir_node *new_rd_SymConst_ofs_ent (dbg_info *db, ir_graph *irg, ir_entity *symbol, ir_type *tp);
1319 /** Constructor for a SymConst addr_name node.
1321 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1322 * symconst_addr_ent.
1323 * Adds the SymConst to the start block of irg. */
1324 ir_node *new_rd_SymConst_addr_name (dbg_info *db, ir_graph *irg, ident *symbol, ir_type *tp);
1326 /** Constructor for a SymConst type_tag node.
1328 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1329 * symconst_addr_ent.
1330 * Adds the SymConst to the start block of irg. */
1331 ir_node *new_rd_SymConst_type_tag (dbg_info *db, ir_graph *irg, ir_type *symbol, ir_type *tp);
1333 /** Constructor for a SymConst size node.
1335 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1336 * symconst_type_size.
1337 * Adds the SymConst to the start block of irg. */
1338 ir_node *new_rd_SymConst_size (dbg_info *db, ir_graph *irg, ir_type *symbol, ir_type *tp);
1340 /** Constructor for a SymConst size node.
1342 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1343 * symconst_type_align.
1344 * Adds the SymConst to the start block of irg. */
1345 ir_node *new_rd_SymConst_align (dbg_info *db, ir_graph *irg, ir_type *symbol, ir_type *tp);
1347 /** Constructor for a simpleSel node.
1349 * This is a shortcut for the new_rd_Sel() constructor. To be used for
1350 * Sel nodes that do not select from an array, i.e., have no index
1351 * inputs. It adds the two parameters 0, NULL.
1353 * @param *db A pointer for debug information.
1354 * @param *irg The ir graph the node belongs to.
1355 * @param *block The ir block the node belongs to.
1356 * @param *store The memory in which the object the entity should be
1357 * selected from is allocated.
1358 * @param *objptr The object from that the Sel operation selects a
1359 * single attribute out.
1360 * @param *ent The entity to select.
1362 ir_node *new_rd_simpleSel (dbg_info *db, ir_graph *irg, ir_node *block,
1363 ir_node *store, ir_node *objptr, ir_entity *ent);
1365 /** Constructor for a Sel node.
1367 * The select node selects an entity (field or method) from an entity
1368 * with a compound type. It explicitly specifies the entity selected.
1369 * Dynamically the node may select entities that overwrite the given
1370 * entity. If the selected entity is an array element entity the Sel
1371 * node takes the required array indices as inputs.
1373 * @param *db A pointer for debug information.
1374 * @param *irg The ir graph the node belongs to.
1375 * @param *block The ir block the node belongs to.
1376 * @param *store The memory in which the object the entity should be selected
1377 * from is allocated.
1378 * @param *objptr A pointer to a compound entity the Sel operation selects a
1379 * single attribute from.
1380 * @param *n_index The number of array indices needed to select an array element entity.
1381 * @param *index[] If the compound entity is an array the indices of the selected
1382 * element entity. The constructor copies this array.
1383 * @param *ent The entity to select.
1385 ir_node *new_rd_Sel (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1386 ir_node *objptr, int n_index, ir_node *index[], ir_entity *ent);
1388 /** Constructor for a Call node.
1390 * Represents all kinds of method and function calls.
1392 * @param *db A pointer for debug information.
1393 * @param *irg The ir graph the node belongs to.
1394 * @param *block The ir block the node belongs to.
1395 * @param *store The current memory state.
1396 * @param *callee A pointer to the called procedure.
1397 * @param arity The number of procedure parameters.
1398 * @param *in[] An array with the procedure parameters. The constructor copies this array.
1399 * @param *tp Type information of the procedure called.
1401 ir_node *new_rd_Call (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1402 ir_node *callee, int arity, ir_node *in[], ir_type *tp);
1404 /** Constructor for a Add node.
1406 * @param *db A pointer for debug information.
1407 * @param *irg The ir graph the node belongs to.
1408 * @param *block The ir block the node belongs to.
1409 * @param *op1 The first operand.
1410 * @param *op2 The second operand.
1411 * @param *mode The mode of the operands and the result.
1413 ir_node *new_rd_Add (dbg_info *db, ir_graph *irg, ir_node *block,
1414 ir_node *op1, ir_node *op2, ir_mode *mode);
1416 /** Constructor for a Sub node.
1418 * @param *db A pointer for debug information.
1419 * @param *irg The ir graph the node belongs to.
1420 * @param *block The ir block the node belongs to.
1421 * @param *op1 The first operand.
1422 * @param *op2 The second operand.
1423 * @param *mode The mode of the operands and the result.
1425 ir_node *new_rd_Sub (dbg_info *db, ir_graph *irg, ir_node *block,
1426 ir_node *op1, ir_node *op2, ir_mode *mode);
1428 /** Constructor for a Minus node.
1430 * @param *db A pointer for debug information.
1431 * @param *irg The ir graph the node belongs to.
1432 * @param *block The ir block the node belongs to.
1433 * @param *op The operand .
1434 * @param *mode The mode of the operand and the result.
1436 ir_node *new_rd_Minus (dbg_info *db, ir_graph *irg, ir_node *block,
1437 ir_node *op, ir_mode *mode);
1439 /** Constructor for a Mul node.
1441 * @param *db A pointer for debug information.
1442 * @param *irg The ir graph the node belongs to.
1443 * @param *block The ir block the node belongs to.
1444 * @param *op1 The first operand.
1445 * @param *op2 The second operand.
1446 * @param *mode The mode of the operands and the result.
1448 ir_node *new_rd_Mul (dbg_info *db, ir_graph *irg, ir_node *block,
1449 ir_node *op1, ir_node *op2, ir_mode *mode);
1451 /** Constructor for a Mulh node.
1453 * @param *db A pointer for debug information.
1454 * @param *irg The ir graph the node belongs to.
1455 * @param *block The ir block the node belongs to.
1456 * @param *op1 The first operand.
1457 * @param *op2 The second operand.
1458 * @param *mode The mode of the operands and the result.
1460 ir_node *new_rd_Mulh (dbg_info *db, ir_graph *irg, ir_node *block,
1461 ir_node *op1, ir_node *op2, ir_mode *mode);
1463 /** Constructor for a Quot node.
1465 * @param *db A pointer for debug information.
1466 * @param *irg The ir graph the node belongs to.
1467 * @param *block The ir block the node belongs to.
1468 * @param *memop The store needed to model exceptions
1469 * @param *op1 The first operand.
1470 * @param *op2 The second operand.
1471 * @param *mode The mode of the result.
1472 * @param state The pinned state.
1474 ir_node *new_rd_Quot (dbg_info *db, ir_graph *irg, ir_node *block,
1475 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
1477 /** Constructor for a DivMod node.
1479 * @param *db A pointer for debug information.
1480 * @param *irg The ir graph the node belongs to.
1481 * @param *block The ir block the node belongs to.
1482 * @param *memop The store needed to model exceptions
1483 * @param *op1 The first operand.
1484 * @param *op2 The second operand.
1485 * @param *mode The mode of the results.
1486 * @param state The pinned state.
1488 ir_node *new_rd_DivMod (dbg_info *db, ir_graph *irg, ir_node *block,
1489 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
1491 /** Constructor for a Div node.
1493 * @param *db A pointer for debug information.
1494 * @param *irg The ir graph the node belongs to.
1495 * @param *block The ir block the node belongs to.
1496 * @param *memop The store needed to model exceptions
1497 * @param *op1 The first operand.
1498 * @param *op2 The second operand.
1499 * @param *mode The mode of the result.
1500 * @param state The pinned state.
1502 ir_node *new_rd_Div (dbg_info *db, ir_graph *irg, ir_node *block,
1503 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
1505 /** Constructor for a Mod node.
1507 * @param *db A pointer for debug information.
1508 * @param *irg The ir graph the node belongs to.
1509 * @param *block The ir block the node belongs to.
1510 * @param *memop The store needed to model exceptions
1511 * @param *op1 The first operand.
1512 * @param *op2 The second operand.
1513 * @param *mode The mode of the result.
1514 * @param state The pinned state.
1516 ir_node *new_rd_Mod (dbg_info *db, ir_graph *irg, ir_node *block,
1517 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
1519 /** Constructor for a Abs node.
1521 * @param *db A pointer for debug information.
1522 * @param *irg The ir graph the node belongs to.
1523 * @param *block The ir block the node belongs to.
1524 * @param *op The operand
1525 * @param *mode The mode of the operands and the result.
1527 ir_node *new_rd_Abs (dbg_info *db, ir_graph *irg, ir_node *block,
1528 ir_node *op, ir_mode *mode);
1530 /** Constructor for a And node.
1532 * @param *db A pointer for debug information.
1533 * @param *irg The ir graph the node belongs to.
1534 * @param *block The ir block the node belongs to.
1535 * @param *op1 The first operand.
1536 * @param *op2 The second operand.
1537 * @param *mode The mode of the operands and the result.
1539 ir_node *new_rd_And (dbg_info *db, ir_graph *irg, ir_node *block,
1540 ir_node *op1, ir_node *op2, ir_mode *mode);
1542 /** Constructor for a Or node.
1544 * @param *db A pointer for debug information.
1545 * @param *irg The ir graph the node belongs to.
1546 * @param *block The ir block the node belongs to.
1547 * @param *op1 The first operand.
1548 * @param *op2 The second operand.
1549 * @param *mode The mode of the operands and the result.
1551 ir_node *new_rd_Or (dbg_info *db, ir_graph *irg, ir_node *block,
1552 ir_node *op1, ir_node *op2, ir_mode *mode);
1554 /** Constructor for a Eor node.
1556 * @param *db A pointer for debug information.
1557 * @param *irg The ir graph the node belongs to.
1558 * @param *block The ir block the node belongs to.
1559 * @param *op1 The first operand.
1560 * @param *op2 The second operand.
1561 * @param *mode The mode of the operands and the results.
1563 ir_node *new_rd_Eor (dbg_info *db, ir_graph *irg, ir_node *block,
1564 ir_node *op1, ir_node *op2, ir_mode *mode);
1566 /** Constructor for a Not node.
1568 * @param *db A pointer for debug information.
1569 * @param *irg The ir graph the node belongs to.
1570 * @param *block The ir block the node belongs to.
1571 * @param *op The operand.
1572 * @param *mode The mode of the operand and the result.
1574 ir_node *new_rd_Not (dbg_info *db, ir_graph *irg, ir_node *block,
1575 ir_node *op, ir_mode *mode);
1577 /** Constructor for a Cmp node.
1579 * @param *db A pointer for debug information.
1580 * @param *irg The ir graph the node belongs to.
1581 * @param *block The ir block the node belongs to.
1582 * @param *op1 The first operand.
1583 * @param *op2 The second operand.
1585 ir_node *new_rd_Cmp (dbg_info *db, ir_graph *irg, ir_node *block,
1586 ir_node *op1, ir_node *op2);
1588 /** Constructor for a Shl node.
1590 * @param *db A pointer for debug information.
1591 * @param *irg The ir graph the node belongs to.
1592 * @param *block The ir block the node belongs to.
1593 * @param *op The operand.
1594 * @param *k The number of bits to shift the operand .
1595 * @param *mode The mode of the operand and the result.
1597 ir_node *new_rd_Shl (dbg_info *db, ir_graph *irg, ir_node *block,
1598 ir_node *op, ir_node *k, ir_mode *mode);
1600 /** Constructor for a Shr node.
1602 * @param *db A pointer for debug information.
1603 * @param *irg The ir graph the node belongs to.
1604 * @param *block The ir block the node belongs to.
1605 * @param *op The operand.
1606 * @param *k The number of bits to shift the operand .
1607 * @param *mode The mode of the operand and the result.
1609 ir_node *new_rd_Shr (dbg_info *db, ir_graph *irg, ir_node *block,
1610 ir_node *op, ir_node *k, ir_mode *mode);
1612 /** Constructor for a Shrs node.
1614 * @param *db A pointer for debug information.
1615 * @param *irg The ir graph the node belongs to.
1616 * @param *block The ir block the node belongs to.
1617 * @param *op The operand.
1618 * @param *k The number of bits to shift the operand.
1619 * @param *mode The mode of the operand and the result.
1621 ir_node *new_rd_Shrs (dbg_info *db, ir_graph *irg, ir_node *block,
1622 ir_node *op, ir_node *k, ir_mode *mode);
1624 /** Constructor for a Rot node.
1626 * @param *db A pointer for debug information.
1627 * @param *irg The ir graph the node belongs to.
1628 * @param *block The ir block the node belongs to.
1629 * @param *op The operand.
1630 * @param *k The number of bits to rotate the operand.
1631 * @param *mode The mode of the operand.
1633 ir_node *new_rd_Rot (dbg_info *db, ir_graph *irg, ir_node *block,
1634 ir_node *op, ir_node *k, ir_mode *mode);
1637 /** Constructor for a Conv node.
1639 * @param *db A pointer for debug information.
1640 * @param *irg The ir graph the node belongs to.
1641 * @param *block The ir block the node belongs to.
1642 * @param *op The operand.
1643 * @param *mode The mode of this the operand muss be converted .
1645 ir_node *new_rd_Conv (dbg_info *db, ir_graph *irg, ir_node *block,
1646 ir_node *op, ir_mode *mode);
1648 /** Constructor for a Cast node.
1650 * High level type cast.
1652 * @param *db A pointer for debug information.
1653 * @param *irg The ir graph the node belongs to.
1654 * @param *block The ir block the node belongs to.
1655 * @param *op The operand.
1656 * @param *to_tp The type of this the operand muss be casted .
1658 ir_node *new_rd_Cast (dbg_info *db, ir_graph *irg, ir_node *block,
1659 ir_node *op, ir_type *to_tp);
1661 /** Constructor for a Carry node.
1663 * @param *db A pointer for debug information.
1664 * @param *irg The ir graph the node belongs to.
1665 * @param *block The ir block the node belongs to.
1666 * @param *op1 The first operand.
1667 * @param *op2 The second operand.
1668 * @param *mode The mode of the operands and the result.
1670 ir_node *new_rd_Carry (dbg_info *db, ir_graph *irg, ir_node *block,
1671 ir_node *op1, ir_node *op2, ir_mode *mode);
1673 /** Constructor for a Borrow node.
1675 * @param *db A pointer for debug information.
1676 * @param *irg The ir graph the node belongs to.
1677 * @param *block The ir block the node belongs to.
1678 * @param *op1 The first operand.
1679 * @param *op2 The second operand.
1680 * @param *mode The mode of the operands and the result.
1682 ir_node *new_rd_Borrow (dbg_info *db, ir_graph *irg, ir_node *block,
1683 ir_node *op1, ir_node *op2, ir_mode *mode);
1685 /** Constructor for a Phi node.
1687 * @param *db A pointer for debug information.
1688 * @param *irg The ir graph the node belongs to.
1689 * @param *block The ir block the node belongs to.
1690 * @param arity The number of predecessors
1691 * @param *in[] Array with predecessors. The constructor copies this array.
1692 * @param *mode The mode of it's inputs and output.
1694 ir_node *new_rd_Phi (dbg_info *db, ir_graph *irg, ir_node *block, int arity,
1695 ir_node *in[], ir_mode *mode);
1697 /** Constructor for a Load node.
1699 * @param *db A pointer for debug information.
1700 * @param *irg The ir graph the node belongs to.
1701 * @param *block The ir block the node belongs to.
1702 * @param *store The current memory
1703 * @param *adr A pointer to the variable to be read in this memory.
1704 * @param *mode The mode of the value to be loaded.
1706 ir_node *new_rd_Load (dbg_info *db, ir_graph *irg, ir_node *block,
1707 ir_node *store, ir_node *adr, ir_mode *mode);
1709 /** Constructor for a Store node.
1711 * @param *db A pointer for debug information.
1712 * @param *irg The ir graph the node belongs to.
1713 * @param *block The ir block the node belongs to.
1714 * @param *store The current memory
1715 * @param *adr A pointer to the variable to be read in this memory.
1716 * @param *val The value to write to this variable.
1718 ir_node *new_rd_Store (dbg_info *db, ir_graph *irg, ir_node *block,
1719 ir_node *store, ir_node *adr, ir_node *val);
1721 /** Constructor for a Alloc node.
1723 * The Alloc node extends the memory by space for an entity of type alloc_type.
1725 * @param *db A pointer for debug information.
1726 * @param *irg The ir graph the node belongs to.
1727 * @param *block The ir block the node belongs to.
1728 * @param *store The memory which shall contain the new variable.
1729 * @param *size The number of bytes to allocate.
1730 * @param *alloc_type The type of the allocated variable.
1731 * @param where Where to allocate the variable, either heap_alloc or stack_alloc.
1733 ir_node *new_rd_Alloc (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1734 ir_node *size, ir_type *alloc_type, where_alloc where);
1736 /** Constructor for a Free node.
1738 * Frees the memory occupied by the entity pointed to by the pointer
1739 * arg. Type indicates the type of the entity the argument points to.
1741 * @param *db A pointer for debug information.
1742 * @param *irg The ir graph the node belongs to.
1743 * @param *block The ir block the node belongs to.
1744 * @param *store The memory which shall contain the new variable.
1745 * @param *ptr The pointer to the object to free.
1746 * @param *size The number of objects of type free_type to free in a sequence.
1747 * @param *free_type The type of the freed variable.
1748 * @param where Where the variable was allocated, either heap_alloc or stack_alloc.
1750 ir_node *new_rd_Free (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1751 ir_node *ptr, ir_node *size, ir_type *free_type, where_alloc where);
1753 /** Constructor for a Sync node.
1755 * Merges several memory values. The node assumes that a variable
1756 * either occurs only in one of the memories, or it contains the same
1757 * value in all memories where it occurs.
1759 * @param *db A pointer for debug information.
1760 * @param *irg The ir graph the node belongs to.
1761 * @param *block The ir block the node belongs to.
1762 * @param arity The number of memories to synchronize.
1763 * @param *in[] An array of pointers to nodes that produce an output of type
1764 * memory. The constructor copies this array.
1766 ir_node *new_rd_Sync (dbg_info *db, ir_graph *irg, ir_node *block, int arity, ir_node *in[]);
1768 /** Constructor for a Proj node.
1770 * Projects a single value out of a tuple. The parameter proj gives the
1771 * position of the value within the tuple.
1773 * @param *db A pointer for debug information.
1774 * @param *irg The ir graph the node belongs to.
1775 * @param *block The ir block the node belongs to.
1776 * @param arg A node producing a tuple. The node must have mode_T.
1777 * @param *mode The mode of the value to project.
1778 * @param proj The position of the value in the tuple.
1780 ir_node *new_rd_Proj (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *arg,
1781 ir_mode *mode, long proj);
1783 /** Constructor for a defaultProj node.
1785 * Represents the default control flow of a Switch-Cond node.
1787 * @param *db A pointer for debug information.
1788 * @param *irg The ir graph the node belongs to.
1789 * @param *block The ir block the node belongs to.
1790 * @param arg A node producing a tuple.
1791 * @param max_proj The end position of the value in the tuple.
1793 ir_node *new_rd_defaultProj (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *arg,
1796 /** Constructor for a Tuple node.
1798 * This is an auxiliary node to replace a node that returns a tuple
1799 * without changing the corresponding Proj nodes.
1801 * @param *db A pointer for debug information.
1802 * @param *irg The ir graph the node belongs to.
1803 * @param *block The ir block the node belongs to.
1804 * @param arity The number of tuple elements.
1805 * @param *in[] An array containing pointers to the nodes producing the tuple
1806 * elements. The constructor copies this array.
1808 ir_node *new_rd_Tuple (dbg_info *db, ir_graph *irg, ir_node *block,
1809 int arity, ir_node *in[]);
1811 /** Constructor for a Id node.
1813 * This is an auxiliary node to replace a node that returns a single
1816 * @param *db A pointer for debug information.
1817 * @param *irg The ir graph the node belongs to.
1818 * @param *block The ir block the node belongs to.
1819 * @param *val The value
1820 * @param *mode The mode of *val.
1822 ir_node *new_rd_Id (dbg_info *db, ir_graph *irg, ir_node *block,
1823 ir_node *val, ir_mode *mode);
1825 /** Constructor for a Bad node.
1827 * Returns the unique Bad node of the graph. The same as
1830 * @param *irg The ir graph the node belongs to.
1832 ir_node *new_rd_Bad (ir_graph *irg);
1834 /** Constructor for a Confirm node.
1836 * Specifies constraints for a value. To support dataflow analyses.
1838 * Example: If the value never exceeds '100' this is expressed by placing a
1839 * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge.
1841 * @param *irg The ir graph the node belong to.
1842 * @param *block The ir block the node belong to.
1843 * @param *db A pointer for debug information.
1844 * @param *val The value we express a constraint for
1845 * @param *bound The value to compare against. Must be a firm node, typically a constant.
1846 * @param cmp The compare operation.
1848 ir_node *new_rd_Confirm (dbg_info *db, ir_graph *irg, ir_node *block,
1849 ir_node *val, ir_node *bound, pn_Cmp cmp);
1851 /** Constructor for an Unknown node.
1853 * Represents an arbitrary value. Places the node in the start block.
1855 * @param *irg The ir graph the node belongs to.
1856 * @param *m The mode of the unknown value.
1858 ir_node *new_rd_Unknown(ir_graph *irg, ir_mode *m);
1860 /** Constructor for a CallBegin node.
1862 * CallBegin represents control flow depending of the pointer value
1863 * representing the called method to the called methods. The
1864 * constructor copies the method pointer input from the passed Call
1867 * @param *db A pointer for debug information.
1868 * @param *irg The ir graph the node belong to.
1869 * @param *block The block the node belong to.
1870 * @param *callee The call node visible in the intra procedural view.
1872 ir_node *new_rd_CallBegin(dbg_info *db, ir_graph *irg, ir_node *block, ir_node *callee);
1874 /** Constructor for a EndReg node.
1876 * Used to represent regular procedure end in interprocedual view.
1878 * @param *db A pointer for debug information.
1879 * @param *irg The ir graph the node belong to.
1880 * @param *block The block the node belong to.
1882 ir_node *new_rd_EndReg (dbg_info *db, ir_graph *irg, ir_node *block);
1884 /** Constructor for a EndExcept node.
1886 * Used to represent exceptional procedure end in interprocedural view.
1888 * @param *db A pointer for debug information.
1889 * @param *irg The ir graph the node belong to.
1890 * @param *block The block the node belong to.
1892 ir_node *new_rd_EndExcept(dbg_info *db, ir_graph *irg, ir_node *block);
1894 /** Constructor for a Filter node.
1896 * Adds the node to the block in current_ir_block. Filter is a node
1897 * with two views used to construct the interprocedural view. In
1898 * intraprocedural view its semantics are identical to the Proj node.
1899 * In interprocedural view the Filter performs the Phi operation on
1900 * method parameters or results. Other than a Phi a Filter node may
1901 * not be removed if it has only a single input.
1903 * The constructor builds the Filter in intraprocedural view.
1905 * @param *db A pointer for debug information.
1906 * @param *irg The ir graph the node belong to.
1907 * @param *block The block the node belong to.
1908 * @param *arg The tuple value to project from.
1909 * @param *mode The mode of the projected value.
1910 * @param proj The position in the tuple to project from.
1912 ir_node *new_rd_Filter (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *arg,
1913 ir_mode *mode, long proj);
1915 /** Constructor for a NoMem node.
1917 * Returns the unique NoMem node of the graph. The same as
1920 * @param *irg The ir graph the node belongs to.
1922 ir_node *new_rd_NoMem (ir_graph *irg);
1924 /** Constructor for a Mux node.
1926 * @param *db A pointer for debug information.
1927 * @param *irg The ir graph the node belong to.
1928 * @param *block The block the node belong to.
1929 * @param *sel The ir_node that calculates the boolean select.
1930 * @param *ir_true The ir_node that calculates the true result.
1931 * @param *ir_false The ir_node that calculates the false result.
1932 * @param *mode The mode of the node (and it_true and ir_false).
1934 ir_node *new_rd_Mux (dbg_info *db, ir_graph *irg, ir_node *block,
1935 ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
1937 /** Constructor for a Psi node.
1939 * @param *db A pointer for debug information.
1940 * @param *irg The ir graph the node belong to.
1941 * @param *block The block the node belong to.
1942 * @param *arity The arity of the conditions
1943 * @param *conds The array of mode_b conditions, length must be equal arity
1944 * @param *vals The array of mode values, length must be equal arity + 1
1945 * @param *mode The mode of the node (must be the mode of all vals).
1947 ir_node *new_rd_Psi (dbg_info *db, ir_graph *irg, ir_node *block,
1948 int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode);
1950 /** Constructor for a CopyB node.
1952 * @param *db A pointer for debug information.
1953 * @param *irg The ir graph the node belong to.
1954 * @param *block The block the node belong to.
1955 * @param *store The current memory
1956 * @param *dst The ir_node that represents the destination address.
1957 * @param *src The ir_node that represents the source address.
1958 * @param *data_type The type of the copied data
1960 ir_node *new_rd_CopyB(dbg_info *db, ir_graph *irg, ir_node *block,
1961 ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
1963 /** Constructor for a InstOf node.
1965 * A High-Level Type check.
1967 * @param *db A pointer for debug information.
1968 * @param *irg The ir graph the node belongs to.
1969 * @param *block The ir block the node belongs to.
1970 * @param *store The memory in which the object the entity should be selected
1971 * from is allocated.
1972 * @param *objptr A pointer to a object of a class type.
1973 * @param *type The type of which objptr must be.
1975 ir_node *new_rd_InstOf (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1976 ir_node *objptr, ir_type *type);
1978 /** Constructor for a Raise node.
1980 * A High-Level Exception throw.
1982 * @param *db A pointer for debug information.
1983 * @param *irg The ir graph the node belongs to.
1984 * @param *block The ir block the node belongs to.
1985 * @param *store The current memory.
1986 * @param *obj A pointer to the Except variable.
1988 ir_node *new_rd_Raise (dbg_info *db, ir_graph *irg, ir_node *block,
1989 ir_node *store, ir_node *obj);
1991 /** Constructor for a Bound node.
1993 * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
1995 * @param *db A pointer for debug information.
1996 * @param *irg The ir graph the node belong to.
1997 * @param *block The block the node belong to.
1998 * @param *store The current memory.
1999 * @param *idx The ir_node that represents an index.
2000 * @param *lower The ir_node that represents the lower bound for the index.
2001 * @param *upper The ir_node that represents the upper bound for the index.
2003 ir_node *new_rd_Bound(dbg_info *db, ir_graph *irg, ir_node *block,
2004 ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
2006 /** Constructor for a Pin node.
2008 * @param *db A pointer for debug information.
2009 * @param *irg The ir graph the node belong to.
2010 * @param *block The block the node belong to.
2011 * @param *node The node which value should be pinned.
2013 ir_node *new_rd_Pin(dbg_info *db, ir_graph *irg, ir_node *block, ir_node *node);
2015 /** Constructor for an ASM pseudo node.
2017 * @param *db A pointer for debug information.
2018 * @param *irg The ir graph the node belong to.
2019 * @param *block The block the node belong to.
2020 * @param arity The number of data inputs to the node.
2021 * @param *in The array of length arity of data inputs.
2022 * @param *inputs The array of length arity of input constraints.
2023 * @param n_outs The number of data outputs to the node.
2024 * @param *outputs The array of length n_outs of output constraints.
2025 * @param n_clobber The number of clobbered registers.
2026 * @param *clobber The array of length n_clobber of clobbered registers.
2027 * @param *asm_text The assembler text.
2029 ir_node *new_rd_ASM(dbg_info *db, ir_graph *irg, ir_node *block,
2030 int arity, ir_node *in[], ir_asm_constraint *inputs,
2031 int n_outs, ir_asm_constraint *outputs,
2032 int n_clobber, ident *clobber[], ident *asm_text);
2034 /*-------------------------------------------------------------------------*/
2035 /* The raw interface without debug support */
2036 /*-------------------------------------------------------------------------*/
2038 /** Constructor for a Block node.
2040 * Constructs a mature block with the given predecessors. Use Unknown
2041 * nodes as predecessors to construct a block if the number of
2042 * predecessors is known, but not the predecessors themselves. This
2043 * constructor does not set current_block. It not be used with
2044 * automatic Phi node construction.
2047 * @param irg The ir graph the block belongs to.
2048 * @param arity The number of control predecessors.
2049 * @param in[] An array of control predecessors. The length of
2050 * the array must be 'arity'. The constructor copies this array.
2052 ir_node *new_r_Block (ir_graph *irg, int arity, ir_node *in[]);
2054 /** Constructor for a Start node.
2056 * @param *irg The ir graph the node belongs to.
2057 * @param *block The ir block the node belongs to.
2059 ir_node *new_r_Start (ir_graph *irg, ir_node *block);
2061 /** Constructor for a End node.
2063 * @param *irg The ir graph the node belongs to.
2064 * @param *block The ir block the node belongs to.
2066 ir_node *new_r_End (ir_graph *irg, ir_node *block);
2068 /** Constructor for a Jmp node.
2070 * Jmp represents control flow to a single control successor.
2072 * @param *irg The ir graph the node belongs to.
2073 * @param *block The ir block the node belongs to.
2075 ir_node *new_r_Jmp (ir_graph *irg, ir_node *block);
2077 /** Constructor for an IJmp node.
2079 * IJmp represents control flow to a single control successor not
2080 * statically known i.e. an indirect Jmp.
2082 * @param *irg The ir graph the node belongs to.
2083 * @param *block The ir block the node belongs to.
2084 * @param *tgt The ir node representing the target address.
2086 ir_node *new_r_IJmp (ir_graph *irg, ir_node *block, ir_node *tgt);
2088 /** Constructor for a Cond node.
2090 * If c is mode_b represents a conditional branch (if/else). If c is
2091 * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond
2092 * node, default Proj is 0.)
2094 * This is not consistent: Input to Cond is Is, Proj has as proj number
2097 * @param *irg The ir graph the node belongs to.
2098 * @param *block The ir block the node belongs to.
2099 * @param *c The conditions parameter.Can be of mode b or I_u.
2101 ir_node *new_r_Cond (ir_graph *irg, ir_node *block, ir_node *c);
2103 /** Constructor for a Return node.
2105 * Returns the memory an zero or more return values. Only node that
2106 * can end regular control flow.
2108 * @param *irg The ir graph the node belongs to.
2109 * @param *block The ir block the node belongs to.
2110 * @param *store The state of memory.
2111 * @param arity Number of array indices.
2112 * @param *in[] Array with index inputs to the node. The constructor copies this array.
2114 ir_node *new_r_Return (ir_graph *irg, ir_node *block,
2115 ir_node *store, int arity, ir_node *in[]);
2117 /** Constructor for a Const node.
2119 * Constructor for a Const node. The constant represents a target
2120 * value. Sets the type information to type_unknown. (No more
2121 * supported: If tv is entity derives a somehow useful type.)
2123 * @param *irg The ir graph the node belongs to.
2124 * @param *block The ir block the node belongs to.
2125 * @param *mode The mode of the operands and the results.
2126 * @param *con Points to an entry in the constant table.
2128 ir_node *new_r_Const (ir_graph *irg, ir_node *block,
2129 ir_mode *mode, tarval *con);
2131 /** Constructor for a Const node.
2133 * Constructor for a Const node. The constant represents a target
2134 * value. Sets the type information to type_unknown. (No more
2135 * supported: If tv is entity derives a somehow useful type.)
2137 * @param *irg The ir graph the node belongs to.
2138 * @param *block The ir block the node belongs to.
2139 * @param *mode The mode of the operands and the results.
2140 * @param value A value from which the tarval is made.
2142 ir_node *new_r_Const_long(ir_graph *irg, ir_node *block,
2143 ir_mode *mode, long value);
2145 /** Constructor for a Const_type node.
2147 * The constant represents a target value. This constructor sets high
2148 * level type information for the constant value.
2150 * @param *irg The ir graph the node belongs to.
2151 * @param *block The ir block the node belongs to.
2152 * @param *mode The mode of the operands and results.
2153 * @param *con Points to an entry in the constant table.
2154 * @param *tp The type of the constant.
2156 ir_node *new_r_Const_type(ir_graph *irg, ir_node *block,
2157 ir_mode *mode, tarval *con, ir_type *tp);
2159 /** Constructor for a SymConst node.
2161 * This is the constructor for a symbolic constant.
2162 * There are four kinds of symbolic constants:
2163 * - type_tag The symbolic constant represents a type tag. The type the
2164 * tag stands for is given explicitly.
2165 * - size The symbolic constant represents the size of a type. The
2166 * type of which the constant represents the size is given
2168 * - addr_name The symbolic constant represents the address of an entity
2169 * (variable or method). The variable is indicated by a name
2170 * that is valid for linking.
2171 * - addr_ent The symbolic constant represents the address of an entity
2172 * (variable or method). The variable is given explicitly by
2175 * Inputs to the node:
2176 * No inputs except the block it belongs to.
2177 * Outputs of the node.
2178 * An unsigned integer (I_u) or a pointer (P).
2180 * @param *irg The ir graph the node belongs to.
2181 * @param *block The ir block the node belongs to.
2182 * @param value A type, entity or a ident depending on the SymConst kind.
2183 * @param symkind The kind of the symbolic constant: type_tag, size or link_info.
2185 ir_node *new_r_SymConst (ir_graph *irg, ir_node *block,
2186 union symconst_symbol value, symconst_kind symkind);
2188 /** Constructor for a simpleSel node.
2190 * This is a shortcut for the new_d_Sel() constructor. To be used for
2191 * Sel nodes that do not select from an array, i.e., have no index
2192 * inputs. It adds the two parameters 0, NULL.
2194 * @param *irg The ir graph the node belongs to.
2195 * @param *block The ir block the node belongs to.
2196 * @param *store The memory in which the object the entity should be selected
2197 * from is allocated.
2198 * @param *objptr The object from that the Sel operation selects a
2199 * single attribute out.
2200 * @param *ent The entity to select.
2202 ir_node *new_r_simpleSel(ir_graph *irg, ir_node *block, ir_node *store,
2203 ir_node *objptr, ir_entity *ent);
2205 /** Constructor for a Sel node.
2207 * The select node selects an entity (field or method) from an entity
2208 * with a compound type. It explicitly specifies the entity selected.
2209 * Dynamically the node may select entities that overwrite the given
2210 * entity. If the selected entity is an array element entity the Sel
2211 * node takes the required array indices as inputs.
2213 * @param *irg The ir graph the node belongs to.
2214 * @param *block The ir block the node belongs to.
2215 * @param *store The memory in which the object the entity should be selected
2216 * from is allocated.
2217 * @param *objptr A pointer to a compound entity the Sel operation selects a
2218 * single attribute from.
2219 * @param *n_index The number of array indices needed to select an array element entity.
2220 * @param *index[] If the compound entity is an array the indices of the selected
2221 * element entity. The constructor copies this array.
2222 * @param *ent The entity to select.
2224 ir_node *new_r_Sel (ir_graph *irg, ir_node *block, ir_node *store,
2225 ir_node *objptr, int n_index, ir_node *index[],
2228 /** Constructor for a Call node.
2230 * Represents all kinds of method and function calls.
2232 * @param *irg The ir graph the node belongs to.
2233 * @param *block The ir block the node belongs to.
2234 * @param *store The actual store.
2235 * @param *callee A pointer to the called procedure.
2236 * @param arity The number of procedure parameters.
2237 * @param *in[] An array with the pointers to the parameters. The constructor copies this array.
2238 * @param *tp Type information of the procedure called.
2240 ir_node *new_r_Call (ir_graph *irg, ir_node *block, ir_node *store,
2241 ir_node *callee, int arity, ir_node *in[],
2244 /** Constructor for a Add node.
2246 * @param *irg The ir graph the node belongs to.
2247 * @param *block The ir block the node belongs to.
2248 * @param *op1 The first operand.
2249 * @param *op2 The second operand.
2250 * @param *mode The mode of the operands and the result.
2252 ir_node *new_r_Add (ir_graph *irg, ir_node *block,
2253 ir_node *op1, ir_node *op2, ir_mode *mode);
2256 * Constructor for a Sub node.
2258 * @param *irg The ir graph the node belongs to.
2259 * @param *block The ir block the node belongs to.
2260 * @param *op1 The first operand.
2261 * @param *op2 The second operand.
2262 * @param *mode The mode of the operands and the results.
2264 ir_node *new_r_Sub (ir_graph *irg, ir_node *block,
2265 ir_node *op1, ir_node *op2, ir_mode *mode);
2267 /** Constructor for a Minus node.
2269 * @param *irg The ir graph the node belongs to.
2270 * @param *block The ir block the node belongs to.
2271 * @param *op The operand.
2272 * @param *mode The mode of the operand and the result.
2274 ir_node *new_r_Minus (ir_graph *irg, ir_node *block,
2275 ir_node *op, ir_mode *mode);
2277 /** Constructor for a Mul node.
2279 * @param *irg The ir graph the node belongs to.
2280 * @param *block The ir block the node belongs to.
2281 * @param *op1 The first operand.
2282 * @param *op2 The second operand.
2283 * @param *mode The mode of the operands and the result.
2285 ir_node *new_r_Mul (ir_graph *irg, ir_node *block,
2286 ir_node *op1, ir_node *op2, ir_mode *mode);
2288 /** Constructor for a Mulh node.
2290 * @param *irg The ir graph the node belongs to.
2291 * @param *block The ir block the node belongs to.
2292 * @param *op1 The first operand.
2293 * @param *op2 The second operand.
2294 * @param *mode The mode of the operands and the result.
2296 ir_node *new_r_Mulh (ir_graph *irg, ir_node *block,
2297 ir_node *op1, ir_node *op2, ir_mode *mode);
2299 /** Constructor for a Quot node.
2301 * @param *irg The ir graph the node belongs to.
2302 * @param *block The ir block the node belongs to.
2303 * @param *memop The store needed to model exceptions
2304 * @param *op1 The first operand.
2305 * @param *op2 The second operand.
2306 * @param *mode The mode of the result.
2307 * @param state The pinned state.
2309 ir_node *new_r_Quot (ir_graph *irg, ir_node *block,
2310 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
2312 /** Constructor for a DivMod node.
2314 * @param *irg The ir graph the node belongs to.
2315 * @param *block The ir block the node belongs to.
2316 * @param *memop The store needed to model exceptions
2317 * @param *op1 The first operand.
2318 * @param *op2 The second operand.
2319 * @param *mode The mode of the results.
2320 * @param state The pinned state.
2322 ir_node *new_r_DivMod (ir_graph *irg, ir_node *block,
2323 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
2325 /** Constructor for a Div node.
2327 * @param *irg The ir graph the node belongs to.
2328 * @param *block The ir block the node belongs to.
2329 * @param *memop The store needed to model exceptions
2330 * @param *op1 The first operand.
2331 * @param *op2 The second operand.
2332 * @param *mode The mode of the result.
2333 * @param state The pinned state.
2335 ir_node *new_r_Div (ir_graph *irg, ir_node *block,
2336 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
2338 /** Constructor for a Mod node.
2340 * @param *irg The ir graph the node belongs to.
2341 * @param *block The ir block the node belongs to.
2342 * @param *memop The store needed to model exceptions
2343 * @param *op1 The first operand.
2344 * @param *op2 The second operand.
2345 * @param *mode The mode of the result.
2346 * @param state The pinned state.
2348 ir_node *new_r_Mod (ir_graph *irg, ir_node *block,
2349 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
2351 /** Constructor for a Abs node.
2353 * @param *irg The ir graph the node belongs to.
2354 * @param *block The ir block the node belongs to.
2355 * @param *op The operand
2356 * @param *mode The mode of the operands and the result.
2358 ir_node *new_r_Abs (ir_graph *irg, ir_node *block,
2359 ir_node *op, ir_mode *mode);
2361 /** Constructor for a And node.
2363 * @param *irg The ir graph the node belongs to.
2364 * @param *block The ir block the node belongs to.
2365 * @param *op1 The first operand.
2366 * @param *op2 The second operand.
2367 * @param *mode The mode of the operands and the result.
2369 ir_node *new_r_And (ir_graph *irg, ir_node *block,
2370 ir_node *op1, ir_node *op2, ir_mode *mode);
2372 /** Constructor for a Or node.
2374 * @param *irg The ir graph the node belongs to.
2375 * @param *block The ir block the node belongs to.
2376 * @param *op1 The first operand.
2377 * @param *op2 The second operand.
2378 * @param *mode The mode of the operands and the result.
2380 ir_node *new_r_Or (ir_graph *irg, ir_node *block,
2381 ir_node *op1, ir_node *op2, ir_mode *mode);
2383 /** Constructor for a Eor node.
2385 * @param *irg The ir graph the node belongs to.
2386 * @param *block The ir block the node belongs to.
2387 * @param *op1 The first operand.
2388 * @param *op2 The second operand.
2389 * @param *mode The mode of the operands and the results.
2391 ir_node *new_r_Eor (ir_graph *irg, ir_node *block,
2392 ir_node *op1, ir_node *op2, ir_mode *mode);
2394 /** Constructor for a Not node.
2396 * @param *irg The ir graph the node belongs to.
2397 * @param *block The ir block the node belongs to.
2398 * @param *op The operand.
2399 * @param *mode The mode of the operand and the result.
2401 ir_node *new_r_Not (ir_graph *irg, ir_node *block,
2402 ir_node *op, ir_mode *mode);
2404 /** Constructor for a Cmp node.
2406 * @param *irg The ir graph the node belongs to.
2407 * @param *block The ir block the node belongs to.
2408 * @param *op1 The first operand.
2409 * @param *op2 The second operand.
2411 ir_node *new_r_Cmp (ir_graph *irg, ir_node *block,
2412 ir_node *op1, ir_node *op2);
2414 /** Constructor for a Shl node.
2416 * @param *irg The ir graph the node belongs to.
2417 * @param *block The ir block the node belongs to.
2418 * @param *op The operand.
2419 * @param *k The number of bits to shift the operand .
2420 * @param *mode The mode of the operand and the result.
2422 ir_node *new_r_Shl (ir_graph *irg, ir_node *block,
2423 ir_node *op, ir_node *k, ir_mode *mode);
2425 /** Constructor for a Shr node.
2427 * @param *irg The ir graph the node belongs to.
2428 * @param *block The ir block the node belongs to.
2429 * @param *op The operand.
2430 * @param *k The number of bits to shift the operand .
2431 * @param *mode The mode of the operand and the result.
2433 ir_node *new_r_Shr (ir_graph *irg, ir_node *block,
2434 ir_node *op, ir_node *k, ir_mode *mode);
2437 * Constructor for a Shrs node.
2439 * @param *irg The ir graph the node belongs to.
2440 * @param *block The ir block the node belongs to.
2441 * @param *op The operand.
2442 * @param *k The number of bits to shift the operand.
2443 * @param *mode The mode of the operand and the result.
2445 ir_node *new_r_Shrs (ir_graph *irg, ir_node *block,
2446 ir_node *op, ir_node *k, ir_mode *mode);
2448 /** Constructor for a Rot node.
2450 * @param *irg The ir graph the node belongs to.
2451 * @param *block The ir block the node belongs to.
2452 * @param *op The operand.
2453 * @param *k The number of bits to rotate the operand.
2454 * @param *mode The mode of the operand.
2456 ir_node *new_r_Rot (ir_graph *irg, ir_node *block,
2457 ir_node *op, ir_node *k, ir_mode *mode);
2459 /** Constructor for a Conv node.
2461 * @param *irg The ir graph the node belongs to.
2462 * @param *block The ir block the node belongs to.
2463 * @param *op The operand.
2464 * @param *mode The mode of this the operand muss be converted .
2466 ir_node *new_r_Conv (ir_graph *irg, ir_node *block,
2467 ir_node *op, ir_mode *mode);
2469 /** Constructor for a Cast node.
2471 * High level type cast
2473 * @param *irg The ir graph the node belongs to.
2474 * @param *block The ir block the node belongs to.
2475 * @param *op The operand.
2476 * @param *to_tp The type of this the operand muss be casted .
2478 ir_node *new_r_Cast (ir_graph *irg, ir_node *block,
2479 ir_node *op, ir_type *to_tp);
2481 /** Constructor for a Carry node.
2483 * @param *irg The ir graph the node belongs to.
2484 * @param *block The ir block the node belongs to.
2485 * @param *op1 The first operand.
2486 * @param *op2 The second operand.
2487 * @param *mode The mode of the operands and the result.
2489 ir_node *new_r_Carry (ir_graph *irg, ir_node *block,
2490 ir_node *op1, ir_node *op2, ir_mode *mode);
2493 * Constructor for a Borrow node.
2495 * @param *irg The ir graph the node belongs to.
2496 * @param *block The ir block the node belongs to.
2497 * @param *op1 The first operand.
2498 * @param *op2 The second operand.
2499 * @param *mode The mode of the operands and the results.
2501 ir_node *new_r_Borrow (ir_graph *irg, ir_node *block,
2502 ir_node *op1, ir_node *op2, ir_mode *mode);
2504 /** Constructor for a Phi node.
2506 * @param *irg The ir graph the node belongs to.
2507 * @param *block The ir block the node belongs to.
2508 * @param arity The number of predecessors
2509 * @param *in[] Array with predecessors. The constructor copies this array.
2510 * @param *mode The mode of it's inputs and output.
2512 ir_node *new_r_Phi (ir_graph *irg, ir_node *block, int arity,
2513 ir_node *in[], ir_mode *mode);
2515 /** Constructor for a Load node.
2517 * @param *irg The ir graph the node belongs to.
2518 * @param *block The ir block the node belongs to.
2519 * @param *store The current memory
2520 * @param *adr A pointer to the variable to be read in this memory.
2521 * @param *mode The mode of the value to be loaded.
2523 ir_node *new_r_Load (ir_graph *irg, ir_node *block,
2524 ir_node *store, ir_node *adr, ir_mode *mode);
2526 /** Constructor for a Store node.
2528 * @param *irg The ir graph the node belongs to.
2529 * @param *block The ir block the node belongs to.
2530 * @param *store The current memory
2531 * @param *adr A pointer to the variable to be read in this memory.
2532 * @param *val The value to write to this variable.
2534 ir_node *new_r_Store (ir_graph *irg, ir_node *block,
2535 ir_node *store, ir_node *adr, ir_node *val);
2537 /** Constructor for a Alloc node.
2539 * The Alloc node extends the memory by space for an entity of type alloc_type.
2541 * @param *irg The ir graph the node belongs to.
2542 * @param *block The ir block the node belongs to.
2543 * @param *store The memory which shall contain the new variable.
2544 * @param *size The number of bytes to allocate.
2545 * @param *alloc_type The type of the allocated variable.
2546 * @param where Where to allocate the variable, either heap_alloc or stack_alloc.
2548 ir_node *new_r_Alloc (ir_graph *irg, ir_node *block, ir_node *store,
2549 ir_node *size, ir_type *alloc_type, where_alloc where);
2551 /** Constructor for a Free node.
2553 * Frees the memory occupied by the entity pointed to by the pointer
2554 * arg. Type indicates the type of the entity the argument points to.
2556 * @param *irg The ir graph the node belongs to.
2557 * @param *block The ir block the node belongs to.
2558 * @param *store The memory which shall contain the new variable.
2559 * @param *ptr The pointer to the object to free.
2560 * @param *size The number of objects of type free_type to free in a sequence.
2561 * @param *free_type The type of the freed variable.
2562 * @param where Where the variable was allocated, either heap_alloc or stack_alloc.
2564 ir_node *new_r_Free (ir_graph *irg, ir_node *block, ir_node *store,
2565 ir_node *ptr, ir_node *size, ir_type *free_type, where_alloc where);
2567 /** Constructor for a Sync node.
2569 * Merges several memory values. The node assumes that a variable
2570 * either occurs only in one of the memories, or it contains the same
2571 * value in all memories where it occurs.
2573 * @param *irg The ir graph the node belongs to.
2574 * @param *block The ir block the node belongs to.
2575 * @param arity The number of memories to synchronize.
2576 * @param *in[] An array of pointers to nodes that produce an output of type memory.
2577 * The constructor copies this array.
2579 ir_node *new_r_Sync (ir_graph *irg, ir_node *block, int arity, ir_node *in[]);
2581 /** Constructor for a Proj node.
2583 * Projects a single value out of a tuple. The parameter proj gives the
2584 * position of the value within the tuple.
2586 * @param *irg The ir graph the node belongs to.
2587 * @param *block The ir block the node belongs to.
2588 * @param arg A node producing a tuple.
2589 * @param *mode The mode of the value to project.
2590 * @param proj The position of the value in the tuple.
2592 ir_node *new_r_Proj (ir_graph *irg, ir_node *block, ir_node *arg,
2593 ir_mode *mode, long proj);
2595 /** Constructor for a defaultProj node.
2597 * Represents the default control flow of a Switch-Cond node.
2599 * @param *irg The ir graph the node belongs to.
2600 * @param *block The ir block the node belongs to.
2601 * @param arg A node producing a tuple.
2602 * @param max_proj The end position of the value in the tuple.
2604 ir_node *new_r_defaultProj (ir_graph *irg, ir_node *block, ir_node *arg, long max_proj);
2607 /** Constructor for a Tuple node.
2609 * This is an auxiliary node to replace a node that returns a tuple
2610 * without changing the corresponding Proj nodes.
2612 * @param *irg The ir graph the node belongs to.
2613 * @param *block The ir block the node belongs to.
2614 * @param arity The number of tuple elements.
2615 * @param *in[] An array containing pointers to the nodes producing the tuple elements.
2616 * The constructor copies this array.
2618 ir_node *new_r_Tuple (ir_graph *irg, ir_node *block, int arity, ir_node *in[]);
2620 /** Constructor for a Id node.
2622 * This is an auxiliary node to replace a node that returns a single
2625 * @param *irg The ir graph the node belongs to.
2626 * @param *block The ir block the node belongs to.
2627 * @param *val The operand to Id.
2628 * @param *mode The mode of *val.
2630 ir_node *new_r_Id (ir_graph *irg, ir_node *block,
2631 ir_node *val, ir_mode *mode);
2633 /** Constructor for a Bad node.
2635 * Returns the unique Bad node of the graph. The same as
2638 * @param *irg The ir graph the node belongs to.
2641 ir_node *new_r_Bad (ir_graph *irg);
2643 /** Constructor for a Confirm node.
2645 * Specifies constraints for a value. To support dataflow analyses.
2647 * Example: If the value never exceeds '100' this is expressed by placing a
2648 * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge.
2650 * @param *irg The ir graph the node belong to.
2651 * @param *block The ir block the node belong to.
2652 * @param *val The value we express a constraint for
2653 * @param *bound The value to compare against. Must be a firm node, typically a constant.
2654 * @param cmp The compare operation.
2656 ir_node *new_r_Confirm(ir_graph *irg, ir_node *block,
2657 ir_node *val, ir_node *bound, pn_Cmp cmp);
2659 /** Constructor for a Unknown node.
2661 * Represents an arbitrary value. Places the node in
2664 * @param *irg The ir graph the node belongs to.
2665 * @param *m The mode of the unknown value.
2667 ir_node *new_r_Unknown(ir_graph *irg, ir_mode *m);
2669 /** Constructor for a CallBegin node.
2671 * CallBegin represents control flow depending of the pointer value
2672 * representing the called method to the called methods. The
2673 * constructor copies the method pointer input from the passed Call
2676 * @param *irg The ir graph the node belong to.
2677 * @param *block The block the node belong to.
2678 * @param *callee The call node visible in the intra procedural view.
2680 ir_node *new_r_CallBegin(ir_graph *irg, ir_node *block, ir_node *callee);
2682 /** Constructor for a EndReg node.
2684 * Used to represent regular procedure end in interprocedual view.
2686 * @param *irg The ir graph the node belong to.
2687 * @param *block The block the node belong to.
2689 ir_node *new_r_EndReg (ir_graph *irg, ir_node *block);
2691 /** Constructor for a EndExcept node.
2693 * Used to represent exceptional procedure end in interprocedural view.
2695 * @param *irg The ir graph the node belong to.
2696 * @param *block The block the node belong to.
2698 ir_node *new_r_EndExcept(ir_graph *irg, ir_node *block);
2700 /** Constructor for a Break node.
2702 * Break represents control flow to a single control successor just as Jmp.
2703 * The blocks separated by a break may not be concatenated by an optimization.
2704 * It is used for the interprocedural representation where blocks are parted
2705 * behind Call nodes to represent the control flow to called procedures.
2707 * @param *irg The ir graph the node belong to.
2708 * @param *block The block the node belong to.
2710 ir_node *new_r_Break (ir_graph *irg, ir_node *block);
2712 /** Constructor for a Filter node.
2714 * Constructor for a Filter node. Adds the node to the block in current_ir_block.
2715 * Filter is a node with two views used to construct the interprocedural view.
2716 * In intraprocedural view its semantics are identical to the Proj node.
2717 * In interprocedural view the Filter performs the Phi operation on method
2718 * parameters or results. Other than a Phi a Filter node may not be removed
2719 * if it has only a single input.
2721 * The constructor builds the Filter in intraprocedural view.
2723 * @param *irg The ir graph the node belong to.
2724 * @param *block The block the node belong to.
2725 * @param *arg The tuple value to project from.
2726 * @param *mode The mode of the projected value.
2727 * @param proj The position in the tuple to project from.
2729 ir_node *new_r_Filter (ir_graph *irg, ir_node *block, ir_node *arg,
2730 ir_mode *mode, long proj);
2732 /** Constructor for a NoMem node.
2734 * Returns the unique NoMem node of the graph. The same as
2737 * @param *irg The ir graph the node belongs to.
2739 ir_node *new_r_NoMem (ir_graph *irg);
2741 /** Constructor for a Mux node.
2743 * @param *irg The ir graph the node belong to.
2744 * @param *block The block the node belong to.
2745 * @param *sel The ir_node that calculates the boolean select.
2746 * @param *ir_true The ir_node that calculates the true result.
2747 * @param *ir_false The ir_node that calculates the false result.
2748 * @param *mode The mode of the node (and it_true and ir_false).
2750 ir_node *new_r_Mux (ir_graph *irg, ir_node *block,
2751 ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
2753 /** Constructor for a Psi node.
2755 * @param *irg The ir graph the node belong to.
2756 * @param *block The block the node belong to.
2757 * @param *arity The arity of the conditions
2758 * @param *conds The array of mode_b conditions, length must be equal arity
2759 * @param *vals The array of mode values, length must be equal arity + 1
2760 * @param *mode The mode of the node (must be the mode of all vals).
2762 ir_node *new_r_Psi (ir_graph *irg, ir_node *block,
2763 int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode);
2765 /** Constructor for a CopyB node.
2767 * @param *irg The ir graph the node belong to.
2768 * @param *block The block the node belong to.
2769 * @param *store The current memory
2770 * @param *dst The ir_node that represents the destination address.
2771 * @param *src The ir_node that represents the source address.
2772 * @param *data_type The type of the copied data
2774 ir_node *new_r_CopyB(ir_graph *irg, ir_node *block,
2775 ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
2777 /** Constructor for a InstOf node.
2779 * A High-Level Type check.
2781 * @param *irg The ir graph the node belongs to.
2782 * @param *block The ir block the node belongs to.
2783 * @param *store The memory in which the object the entity should be selected
2784 * from is allocated.
2785 * @param *objptr A pointer to a object of a class type.
2786 * @param *type The type of which objptr must be.
2788 ir_node *new_r_InstOf(ir_graph *irg, ir_node *block, ir_node *store,
2789 ir_node *objptr, ir_type *type);
2791 /** Constructor for a Raise node.
2793 * A High-Level Exception throw.
2795 * @param *irg The ir graph the node belongs to.
2796 * @param *block The ir block the node belongs to.
2797 * @param *store The current memory.
2798 * @param *obj A pointer to the Except variable.
2800 ir_node *new_r_Raise(ir_graph *irg, ir_node *block,
2801 ir_node *store, ir_node *obj);
2803 /** Constructor for a Bound node.
2805 * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
2807 * @param *irg The ir graph the node belong to.
2808 * @param *block The block the node belong to.
2809 * @param *store The current memory.
2810 * @param *idx The ir_node that represents an index.
2811 * @param *lower The ir_node that represents the lower bound for the index.
2812 * @param *upper The ir_node that represents the upper bound for the index.
2814 ir_node *new_r_Bound(ir_graph *irg, ir_node *block,
2815 ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
2817 /** Constructor for a Pin node.
2819 * @param *irg The ir graph the node belong to.
2820 * @param *block The block the node belong to.
2821 * @param *node The node which value should be pinned.
2823 ir_node *new_r_Pin(ir_graph *irg, ir_node *block, ir_node *node);
2825 /** Constructor for an ASM pseudo node.
2827 * @param *irg The ir graph the node belong to.
2828 * @param *block The block the node belong to.
2829 * @param arity The number of data inputs to the node.
2830 * @param *in The array of length arity of data inputs.
2831 * @param *inputs The array of length arity of input constraints.
2832 * @param n_outs The number of data outputs to the node.
2833 * @param *outputs The array of length n_outs of output constraints.
2834 * @param n_clobber The number of clobbered registers.
2835 * @param *clobber The array of length n_clobber of clobbered registers.
2836 * @param *asm_text The assembler text.
2838 ir_node *new_r_ASM(ir_graph *irg, ir_node *block,
2839 int arity, ir_node *in[], ir_asm_constraint *inputs,
2840 int n_outs, ir_asm_constraint *outputs,
2841 int n_clobber, ident *clobber[], ident *asm_text);
2843 /*-----------------------------------------------------------------------*/
2844 /* The block oriented interface */
2845 /*-----------------------------------------------------------------------*/
2847 /** Sets the current block in which the following constructors place the
2848 * nodes they construct.
2850 * @param target The new current block.
2852 void set_cur_block (ir_node *target);
2854 /** Returns the current block of the current graph. */
2855 ir_node *get_cur_block(void);
2857 /** Returns the fixed nodes of the current graph. */
2858 #define get_cur_end_block() get_irg_end_block(current_ir_graph)
2859 #define get_cur_end() get_irg_end(current_ir_graph)
2860 #define get_cur_start_block() get_irg_start_block(current_ir_graph)
2861 #define get_cur_start() get_irg_start(current_ir_graph)
2863 /** Constructor for a Block node.
2865 * Adds the block to the graph in current_ir_graph. Constructs a Block
2866 * with a fixed number of predecessors. Does set current_block. Can
2867 * be used with automatic Phi node construction.
2869 * @param *db A Pointer for debug information.
2870 * @param arity The number of control predecessors.
2871 * @param in[] An array of control predecessors. The length of
2872 * the array must be 'arity'.
2874 ir_node *new_d_Block(dbg_info *db, int arity, ir_node *in[]);
2876 /** Constructor for a Start node.
2878 * Adds the node to the block in current_ir_block.
2880 * @param *db A pointer for debug information.
2882 ir_node *new_d_Start (dbg_info *db);
2884 /** Constructor for a End node.
2886 * Adds the node to the block in current_ir_block.
2888 * @param *db A pointer for debug information.
2890 ir_node *new_d_End (dbg_info *db);
2892 /** Constructor for a Jmp node.
2894 * Adds the node to the block in current_ir_block.
2896 * Jmp represents control flow to a single control successor.
2898 * @param *db A pointer for debug information.
2900 ir_node *new_d_Jmp (dbg_info *db);
2902 /** Constructor for an IJmp node.
2904 * IJmp represents control flow to a single control successor not
2905 * statically known i.e. an indirect Jmp.
2907 * @param *db A pointer for debug information.
2908 * @param *tgt The ir node representing the target address.
2910 ir_node *new_d_IJmp (dbg_info *db, ir_node *tgt);
2912 /** Constructor for a Cond node.
2914 * Adds the node to the block in current_ir_block.
2916 * If c is mode_b represents a conditional branch (if/else). If c is
2917 * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond
2918 * node, default Proj is 0.)
2920 * This is not consistent: Input to Cond is Is, Proj has as proj number
2923 * @param *db A pointer for debug information.
2924 * @param *c The conditions parameter.Can be of mode b or I_u.
2926 ir_node *new_d_Cond (dbg_info *db, ir_node *c);
2928 /** Constructor for a Return node.
2930 * Adds the node to the block in current_ir_block.
2932 * Returns the memory an zero or more return values. Only node that
2933 * can end regular control flow.
2935 * @param *db A pointer for debug information.
2936 * @param *store The state of memory.
2937 * @param arity Number of array indices.
2938 * @param *in Array with index inputs to the node.
2940 ir_node *new_d_Return (dbg_info *db, ir_node *store, int arity, ir_node *in[]);
2942 /** Constructor for a Const_type node.
2944 * Adds the node to the block in current_ir_block.
2946 * The constant represents a target value. This constructor sets high
2947 * level type information for the constant value.
2949 * @param *db A pointer for debug information.
2950 * @param *mode The mode of the operands and results.
2951 * @param *con Points to an entry in the constant table. This pointer is
2952 added to the attributes of the node.
2953 * @param *tp The type of the constant.
2955 ir_node *new_d_Const_type (dbg_info *db, ir_mode *mode, tarval *con, ir_type *tp);
2957 /** Constructor for a Const node.
2959 * Adds the node to the block in current_ir_block.
2961 * Constructor for a Const node. The constant represents a target
2962 * value. Sets the type information to type_unknown. (No more
2963 * supported: If tv is entity derives a somehow useful type.)
2965 * @param *db A pointer for debug information.
2966 * @param *mode The mode of the operands and results.
2967 * @param *con Points to an entry in the constant table. This pointer is added
2968 * to the attributes of the node.
2970 ir_node *new_d_Const (dbg_info *db, ir_mode *mode, tarval *con);
2972 /** Constructor for a SymConst_type node.
2974 * Adds the node to the block in current_ir_block.
2975 * This is the constructor for a symbolic constant.
2976 * There are four kinds of symbolic constants:
2977 * - type_tag The symbolic constant represents a type tag. The type the
2978 * tag stands for is given explicitly.
2979 * - size The symbolic constant represents the size of a type. The
2980 * type of which the constant represents the size is given
2982 * - addr_name The symbolic constant represents the address of an entity
2983 * (variable or method). The variable is indicated by a name
2984 * that is valid for linking.
2985 * - addr_ent The symbolic constant represents the address of an entity
2986 * (variable or method). The variable is given explicitly by
2989 * Inputs to the node:
2990 * No inputs except the block it belongs to.
2991 * Outputs of the node.
2992 * An unsigned integer (I_u) or a pointer (P).
2994 * @param *db A pointer for debug information.
2995 * @param value A type, entity or ident depending on the SymConst kind.
2996 * @param kind The kind of the symbolic constant: symconst_type_tag, symconst_type_size,
2997 * symconst_type_align, symconst_addr_name or symconst_addr_ent.
2998 * @param tp The source type of the constant.
3000 ir_node *new_d_SymConst_type (dbg_info *db, union symconst_symbol value, symconst_kind kind, ir_type *tp);
3002 /** Constructor for a SymConst node.
3004 * Same as new_d_SymConst_type, except that it sets the type to type_unknown. */
3005 ir_node *new_d_SymConst (dbg_info *db, union symconst_symbol value, symconst_kind kind);
3007 /** Constructor for a simpleSel node.
3009 * This is a shortcut for the new_d_Sel() constructor. To be used for
3010 * Sel nodes that do not select from an array, i.e., have no index
3011 * inputs. It adds the two parameters 0, NULL.
3013 * @param *db A pointer for debug information.
3014 * @param *store The memory in which the object the entity should be
3015 * selected from is allocated.
3016 * @param *objptr The object from that the Sel operation selects a
3017 * single attribute out.
3018 * @param *ent The entity to select.
3020 ir_node *new_d_simpleSel(dbg_info *db, ir_node *store, ir_node *objptr, ir_entity *ent);
3022 /** Constructor for a Sel node.
3024 * The select node selects an entity (field or method) from an entity
3025 * with a compound type. It explicitly specifies the entity selected.
3026 * Dynamically the node may select entities that overwrite the given
3027 * entity. If the selected entity is an array element entity the Sel
3028 * node takes the required array indices as inputs.
3029 * Adds the node to the block in current_ir_block.
3031 * @param *db A pointer for debug information.
3032 * @param *store The memory in which the object the entity should be selected
3033 * from is allocated.
3034 * @param *objptr A pointer to a compound entity the Sel operation selects a
3035 * single attribute from.
3036 * @param arity The number of array indices needed to select an array element entity.
3037 * @param *in[] If the compound entity is an array the indices of the selected
3038 * element entity. The constructor copies this array.
3039 * @param *ent The entity to select.
3041 ir_node *new_d_Sel (dbg_info *db, ir_node *store, ir_node *objptr, int arity, ir_node *in[],
3044 /** Constructor for a Call node.
3046 * Represents all kinds of method and function calls.
3047 * Adds the node to the block in current_ir_block.
3049 * @param *db A pointer for debug information.
3050 * @param *store The actual store.
3051 * @param *callee A pointer to the called procedure.
3052 * @param arity The number of procedure parameters.
3053 * @param *in[] An array with the pointers to the parameters. The constructor copies this array.
3054 * @param *tp Type information of the procedure called.
3056 ir_node *new_d_Call (dbg_info *db, ir_node *store, ir_node *callee, int arity, ir_node *in[],
3059 /** Constructor for a Add node.
3061 * Adds the node to the block in current_ir_block.
3063 * @param *db A pointer for debug information.
3064 * @param *op1 The first operand.
3065 * @param *op2 The second operand.
3066 * @param *mode The mode of the operands and the result.
3068 ir_node *new_d_Add (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3070 /** Constructor for a Sub node.
3072 * Adds the node to the block in current_ir_block.
3074 * @param *db A pointer for debug information.
3075 * @param *op1 The first operand.
3076 * @param *op2 The second operand.
3077 * @param *mode The mode of the operands and the result.
3079 ir_node *new_d_Sub (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3081 /** Constructor for a Minus node.
3083 * Adds the node to the block in current_ir_block.
3085 * @param *db A pointer for debug information.
3086 * @param *op The operand .
3087 * @param *mode The mode of the operand and the result.
3089 ir_node *new_d_Minus (dbg_info *db, ir_node *op, ir_mode *mode);
3091 /** Constructor for a Mul node.
3093 * Adds the node to the block in current_ir_block.
3095 * @param *db A pointer for debug information.
3096 * @param *op1 The first operand.
3097 * @param *op2 The second operand.
3098 * @param *mode The mode of the operands and the result.
3100 ir_node *new_d_Mul (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3102 /** Constructor for a Mulh node.
3104 * Adds the node to the block in current_ir_block.
3106 * @param *db A pointer for debug information.
3107 * @param *op1 The first operand.
3108 * @param *op2 The second operand.
3109 * @param *mode The mode of the operands and the result.
3111 ir_node *new_d_Mulh (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3113 /** Constructor for a Quot node.
3115 * Adds the node to the block in current_ir_block.
3117 * @param *db A pointer for debug information.
3118 * @param *memop The store needed to model exceptions
3119 * @param *op1 The first operand.
3120 * @param *op2 The second operand.
3121 * @param *mode The mode of the result.
3122 * @param state The pinned state.
3124 ir_node *new_d_Quot (dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
3126 /** Constructor for a DivMod node.
3128 * Adds the node to the block in current_ir_block.
3130 * @param *db A pointer for debug information.
3131 * @param *memop The store needed to model exceptions
3132 * @param *op1 The first operand.
3133 * @param *op2 The second operand.
3134 * @param *mode The mode of the results.
3135 * @param state The pinned state.
3137 ir_node *new_d_DivMod (dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
3139 /** Constructor for a Div node.
3141 * Adds the node to the block in current_ir_block.
3143 * @param *db A pointer for debug information.
3144 * @param *memop The store needed to model exceptions
3145 * @param *op1 The first operand.
3146 * @param *op2 The second operand.
3147 * @param *mode The mode of the result.
3148 * @param state The pinned state.
3150 ir_node *new_d_Div (dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
3152 /** Constructor for a Mod node.
3154 * Adds the node to the block in current_ir_block.
3156 * @param *db A pointer for debug information.
3157 * @param *memop The store needed to model exceptions
3158 * @param *op1 The first operand.
3159 * @param *op2 The second operand.
3160 * @param *mode The mode of the result.
3161 * @param state The pinned state.
3163 ir_node *new_d_Mod (dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
3165 /** Constructor for a Abs node.
3167 * Adds the node to the block in current_ir_block.
3169 * @param *db A pointer for debug information.
3170 * @param *op The operand
3171 * @param *mode The mode of the operands and the result.
3173 ir_node *new_d_Abs (dbg_info *db, ir_node *op, ir_mode *mode);
3175 /** Constructor for a And node.
3177 * Adds the node to the block in current_ir_block.
3179 * @param *db A pointer for debug information.
3180 * @param *op1 The first operand.
3181 * @param *op2 The second operand.
3182 * @param *mode The mode of the operands and the result.
3184 ir_node *new_d_And (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3186 /** Constructor for a Or node.
3188 * Adds the node to the block in current_ir_block.
3190 * @param *db A pointer for debug information.
3191 * @param *op1 The first operand.
3192 * @param *op2 The second operand.
3193 * @param *mode The mode of the operands and the result.
3195 ir_node *new_d_Or (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3197 /** Constructor for a Eor node.
3199 * Adds the node to the block in current_ir_block.
3201 * @param *db A pointer for debug information.
3202 * @param *op1 The first operand.
3203 * @param *op2 The second operand.
3204 * @param *mode The mode of the operands and the results.
3206 ir_node *new_d_Eor (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3208 /** Constructor for a Not node.
3210 * Adds the node to the block in current_ir_block.
3212 * @param *db A pointer for debug information.
3213 * @param *op The operand.
3214 * @param *mode The mode of the operand and the result.
3216 ir_node *new_d_Not (dbg_info *db, ir_node *op, ir_mode *mode);
3218 /** Constructor for a Shl node.
3220 * Adds the node to the block in current_ir_block.
3222 * @param *db A pointer for debug information.
3223 * @param *op The operand.
3224 * @param *k The number of bits to shift the operand .
3225 * @param *mode The mode of the operand and the result.
3227 ir_node *new_d_Shl (dbg_info *db, ir_node *op, ir_node *k, ir_mode *mode);
3229 /** Constructor for a Shr node.
3231 * Adds the node to the block in current_ir_block.
3233 * @param *db A pointer for debug information.
3234 * @param *op The operand.
3235 * @param *k The number of bits to shift the operand .
3236 * @param *mode The mode of the operand and the result.
3238 ir_node *new_d_Shr (dbg_info *db, ir_node *op, ir_node *k, ir_mode *mode);
3240 /** Constructor for a Shrs node.
3242 * Adds the node to the block in current_ir_block.
3244 * @param *db A pointer for debug information.
3245 * @param *op The operand.
3246 * @param *k The number of bits to shift the operand .
3247 * @param *mode The mode of the operand and the result.
3249 ir_node *new_d_Shrs (dbg_info *db, ir_node *op, ir_node *k, ir_mode *mode);
3251 /** Constructor for a Rot node.
3253 * Adds the node to the block in current_ir_block.
3255 * @param *db A pointer for debug information.
3256 * @param *op The operand.
3257 * @param *k The number of bits to rotate the operand.
3258 * @param *mode The mode of the operand.
3260 ir_node *new_d_Rot (dbg_info *db, ir_node *op, ir_node *k, ir_mode *mode);
3262 /** Constructor for a Cmp node.
3264 * Adds the node to the block in current_ir_block.
3266 * @param *db A pointer for debug information.
3267 * @param *op1 The first operand.
3268 * @param *op2 The second operand.
3270 ir_node *new_d_Cmp (dbg_info *db, ir_node *op1, ir_node *op2);
3272 /** Constructor for a Conv node.
3274 * Adds the node to the block in current_ir_block.
3276 * @param *db A pointer for debug information.
3277 * @param *op The operand.
3278 * @param *mode The mode of this the operand muss be converted .
3280 ir_node *new_d_Conv (dbg_info *db, ir_node *op, ir_mode *mode);
3282 /** Constructor for a strict Conv node.
3284 * Adds the node to the block in current_ir_block.
3286 * @param *db A pointer for debug information.
3287 * @param *op The operand.
3288 * @param *mode The mode of this the operand muss be converted .
3290 ir_node *new_d_strictConv (dbg_info *db, ir_node *op, ir_mode *mode);
3292 /** Constructor for a Cast node.
3294 * High level type cast
3295 * Adds the node to the block in current_ir_block.
3297 * @param *db A pointer for debug information.
3298 * @param *op The operand.
3299 * @param *to_tp The type of this the operand muss be casted .
3301 ir_node *new_d_Cast (dbg_info *db, ir_node *op, ir_type *to_tp);
3303 /** Constructor for a Carry node.
3305 * Adds the node to the block in current_ir_block.
3307 * @param *db A pointer for debug information.
3308 * @param *op1 The first operand.
3309 * @param *op2 The second operand.
3310 * @param *mode The mode of the operands and the result.
3312 ir_node *new_d_Carry (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3314 /** Constructor for a Borrow node.
3316 * Adds the node to the block in current_ir_block.
3318 * @param *db A pointer for debug information.
3319 * @param *op1 The first operand.
3320 * @param *op2 The second operand.
3321 * @param *mode The mode of the operands and the result.
3323 ir_node *new_d_Borrow (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3325 /** Constructor for a Phi node.
3327 * Adds the node to the block in current_ir_block.
3329 * @param *db A pointer for debug information.
3330 * @param arity The number of predecessors
3331 * @param *in Array with predecessors
3332 * @param *mode The mode of it's inputs and output.
3334 ir_node *new_d_Phi (dbg_info *db, int arity, ir_node *in[], ir_mode *mode);
3336 /** Constructor for a Load node.
3338 * Adds the node to the block in current_ir_block.
3340 * @param *db A pointer for debug information.
3341 * @param *store The current memory
3342 * @param *addr A pointer to the variable to be read in this memory.
3343 * @param *mode The mode of the value to be loaded.
3345 ir_node *new_d_Load (dbg_info *db, ir_node *store, ir_node *addr, ir_mode *mode);
3347 /** Constructor for a Store node.
3349 * Adds the node to the block in current_ir_block.
3351 * @param *db A pointer for debug information.
3352 * @param *store The current memory
3353 * @param *addr A pointer to the variable to be read in this memory.
3354 * @param *val The value to write to this variable.
3356 ir_node *new_d_Store (dbg_info *db, ir_node *store, ir_node *addr, ir_node *val);
3358 /** Constructor for a Alloc node.
3360 * The Alloc node extends the memory by space for an entity of type alloc_type.
3361 * Adds the node to the block in current_ir_block.
3363 * @param *db A pointer for debug information.
3364 * @param *store The memory which shall contain the new variable.
3365 * @param *size The number of bytes to allocate.
3366 * @param *alloc_type The type of the allocated variable.
3367 * @param where Where to allocate the variable, either heap_alloc or stack_alloc.
3369 ir_node *new_d_Alloc (dbg_info *db, ir_node *store, ir_node *size, ir_type *alloc_type,
3372 /** Constructor for a Free node.
3374 * Frees the memory occupied by the entity pointed to by the pointer
3375 * arg. Type indicates the type of the entity the argument points to.
3376 * Adds the node to the block in current_ir_block.
3378 * @param *db A pointer for debug information.
3379 * @param *store The memory which shall contain the new variable.
3380 * @param *ptr The pointer to the object to free.
3381 * @param *size The number of objects of type free_type to free in a sequence.
3382 * @param *free_type The type of the freed variable.
3383 * @param where Where the variable was allocated, either heap_alloc or stack_alloc.
3385 ir_node *new_d_Free (dbg_info *db, ir_node *store, ir_node *ptr, ir_node *size,
3386 ir_type *free_type, where_alloc where);
3388 /** Constructor for a Sync node.
3390 * Merges several memory values. The node assumes that a variable
3391 * either occurs only in one of the memories, or it contains the same
3392 * value in all memories where it occurs.
3393 * Adds the node to the block in current_ir_block.
3395 * @param *db A pointer for debug information.
3396 * @param arity The number of memories to synchronize.
3397 * @param **in An array of pointers to nodes that produce an output of type
3398 * memory. The constructor copies this array.
3400 ir_node *new_d_Sync (dbg_info *db, int arity, ir_node *in[]);
3402 /** Constructor for a Proj node.
3404 * Projects a single value out of a tuple. The parameter proj gives the
3405 * position of the value within the tuple.
3406 * Adds the node to the block in current_ir_block.
3408 * @param *db A pointer for deubug information.
3409 * @param arg A node producing a tuple.
3410 * @param *mode The mode of the value to project.
3411 * @param proj The position of the value in the tuple.
3413 ir_node *new_d_Proj (dbg_info *db, ir_node *arg, ir_mode *mode, long proj);
3415 /** Constructor for a defaultProj node.
3417 * Represents the default control flow of a Switch-Cond node.
3418 * Adds the node to the block in current_ir_block.
3420 * @param *db A pointer for debug information.
3421 * @param arg A node producing a tuple.
3422 * @param max_proj The end position of the value in the tuple.
3424 ir_node *new_d_defaultProj (dbg_info *db, ir_node *arg, long max_proj);
3426 /** Constructor for a Tuple node.
3428 * This is an auxiliary node to replace a node that returns a tuple
3429 * without changing the corresponding Proj nodes.
3430 * Adds the node to the block in current_ir_block.
3432 * @param *db A pointer for debug information.
3433 * @param arity The number of tuple elements.
3434 * @param **in An array containing pointers to the nodes producing the tuple elements.
3436 ir_node *new_d_Tuple (dbg_info *db, int arity, ir_node *in[]);
3438 /** Constructor for a Id node.
3440 * This is an auxiliary node to replace a node that returns a single
3441 * value. Adds the node to the block in current_ir_block.
3443 * @param *db A pointer for debug information.
3444 * @param *val The operand to Id.
3445 * @param *mode The mode of *val.
3447 ir_node *new_d_Id (dbg_info *db, ir_node *val, ir_mode *mode);
3449 /** Constructor for a Bad node.
3451 * Returns the unique Bad node of the graph. The same as
3454 ir_node *new_d_Bad (void);
3456 /** Constructor for a Confirm node.
3458 * Constructor for a Confirm node. Adds the node to the block in current_ir_block.
3459 * Specifies constraints for a value. To support dataflow analyses.
3461 * Example: If the value never exceeds '100' this is expressed by placing a
3462 * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge.
3464 * @param *db A pointer for debug information.
3465 * @param *val The value we express a constraint for
3466 * @param *bound The value to compare against. Must be a firm node, typically a constant.
3467 * @param cmp The compare operation.
3469 ir_node *new_d_Confirm (dbg_info *db, ir_node *val, ir_node *bound, pn_Cmp cmp);
3471 /** Constructor for an Unknown node.
3473 * Represents an arbitrary value. Places the node in
3476 * @param *m The mode of the unknown value.
3478 ir_node *new_d_Unknown(ir_mode *m);
3480 /** Constructor for a CallBegin node.
3482 * CallBegin represents control flow depending of the pointer value
3483 * representing the called method to the called methods. The
3484 * constructor copies the method pointer input from the passed Call
3485 * node.Adds the node to the block in current_ir_block.
3487 * @param *db A pointer for debug information.
3488 * @param *callee The call node visible in the intra procedural view.
3490 ir_node *new_d_CallBegin(dbg_info *db, ir_node *callee);
3492 /** Constructor for an EndReg node.
3494 *Adds the node to the block in current_ir_block.
3496 * @param *db A pointer for debug information.
3498 ir_node *new_d_EndReg (dbg_info *db);
3500 /** Constructor for an EndExcept node.
3502 * Used to represent regular procedure end in interprocedual view.
3503 * Adds the node to the block in current_ir_block.
3505 * @param *db A pointer for debug information.
3507 ir_node *new_d_EndExcept(dbg_info *db);
3509 /** Constructor for a Break node.
3511 * Used to represent exceptional procedure end in interprocedural view.
3512 * Adds the node to the block in current_ir_block.
3514 * Break represents control flow to a single control successor just as Jmp.
3515 * The blocks separated by a break may not be concatenated by an optimization.
3516 * It is used for the interprocedural representation where blocks are parted
3517 * behind Call nodes to represent the control flow to called procedures.
3519 * @param *db A pointer for debug information.
3521 ir_node *new_d_Break (dbg_info *db);
3523 /** Constructor for a Filter node.
3525 * Constructor for a Filter node. Adds the node to the block in
3526 * current_ir_block. Filter is a node with two views used to
3527 * construct the interprocedural view. In intraprocedural view its
3528 * semantics are identical to the Proj node. In interprocedural view
3529 * the Filter performs the Phi operation on method parameters or
3530 * results. Other than a Phi a Filter node may not be removed if it
3531 * has only a single input.
3533 * The constructor builds the Filter in intraprocedural view.
3535 * @param *db A pointer for debug information.
3536 * @param *arg The tuple value to project from.
3537 * @param *mode The mode of the projected value.
3538 * @param proj The position in the tuple to project from.
3540 ir_node *new_d_Filter (dbg_info *db, ir_node *arg, ir_mode *mode, long proj);
3543 /** Constructor for a NoMem node.
3545 * Returns the unique NoMem node of the graph. The same as
3548 ir_node *new_d_NoMem (void);
3550 /** Constructor for a Mux node.
3552 * @param *db A pointer for debug information.
3553 * @param *sel The ir_node that calculates the boolean select.
3554 * @param *ir_true The ir_node that calculates the true result.
3555 * @param *ir_false The ir_node that calculates the false result.
3556 * @param *mode The mode of the node (and it_true and ir_false).
3558 ir_node *new_d_Mux (dbg_info *db, ir_node *sel,
3559 ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
3561 /** Constructor for a Psi node.
3563 * @param *db A pointer for debug information.
3564 * @param *arity The arity of the conditions
3565 * @param *conds The array of mode_b conditions, length must be equal arity
3566 * @param *vals The array of mode values, length must be equal arity + 1
3567 * @param *mode The mode of the node (must be the mode of all vals).
3569 ir_node *new_d_Psi (dbg_info *db,
3570 int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode);
3572 /** Constructor for a CopyB node.
3574 * @param *db A pointer for debug information.
3575 * @param *store The current memory
3576 * @param *dst The ir_node that represents the destination address.
3577 * @param *src The ir_node that represents the source address.
3578 * @param *data_type The type of the copied data
3580 ir_node *new_d_CopyB(dbg_info *db, ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
3582 /** Constructor for a InstOf node.
3584 * A High-Level Type check.
3586 * @param *db A pointer for debug information.
3587 * @param *store The memory in which the object the entity should be selected
3588 * from is allocated.
3589 * @param *objptr A pointer to a object of a class type.
3590 * @param *type The type of which objptr must be.
3592 ir_node *new_d_InstOf (dbg_info *db, ir_node *store, ir_node *objptr, ir_type *type);
3594 /** Constructor for a Raise node.
3596 * A High-Level Exception throw.
3598 * @param *db A pointer for debug information.
3599 * @param *store The current memory.
3600 * @param *obj A pointer to the Except variable.
3602 ir_node *new_d_Raise (dbg_info *db, ir_node *store, ir_node *obj);
3604 /** Constructor for a Bound node.
3606 * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
3608 * @param *db A pointer for debug information.
3609 * @param *store The current memory
3610 * @param *idx The ir_node that represents an index.
3611 * @param *lower The ir_node that represents the lower bound for the index.
3612 * @param *upper The ir_node that represents the upper bound for the index.
3614 ir_node *new_d_Bound(dbg_info *db, ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
3616 /** Constructor for a Pin node.
3618 * @param *db A pointer for debug information.
3619 * @param *node The node which value should be pinned.
3621 ir_node *new_d_Pin(dbg_info *db, ir_node *node);
3623 /** Constructor for an ASM pseudo node.
3625 * @param *db A pointer for debug information.
3626 * @param arity The number of data inputs to the node.
3627 * @param *in The array of length arity of data inputs.
3628 * @param *inputs The array of length arity of input constraints.
3629 * @param n_outs The number of data outputs to the node.
3630 * @param *outputs The array of length n_outs of output constraints.
3631 * @param n_clobber The number of clobbered registers.
3632 * @param *clobber The array of length n_clobber of clobbered registers.
3633 * @param *asm_text The assembler text.
3635 ir_node *new_d_ASM(dbg_info *db, int arity, ir_node *in[], ir_asm_constraint *inputs,
3636 int n_outs, ir_asm_constraint *outputs,
3637 int n_clobber, ident *clobber[], ident *asm_text);
3639 /*-----------------------------------------------------------------------*/
3640 /* The block oriented interface without debug support */
3641 /*-----------------------------------------------------------------------*/
3643 /* Needed from the interface with debug support:
3644 void set_cur_block (ir_node *target); */
3646 /** Constructor for a Block node.
3648 * Constructor for a Block node. Adds the block to the graph in
3649 * current_ir_graph. Constructs a Block with a fixed number of
3650 * predecessors. Does set current_block. Can be used with automatic
3651 * Phi node construction.
3653 * @param arity The number of control predecessors.
3654 * @param in An array of control predecessors. The length of
3655 * the array must be 'arity'.
3657 ir_node *new_Block(int arity, ir_node *in[]);
3659 /** Constructor for a Start node.
3661 * Adds the node to the block in current_ir_block.
3664 ir_node *new_Start (void);
3666 /** Constructor for an End node.
3668 * Adds the node to the block in current_ir_block.
3670 ir_node *new_End (void);
3672 /** Constructor for an EndReg node.
3674 * Used to represent regular procedure end in interprocedual view.
3675 * Adds the node to the block in current_ir_block.
3677 ir_node *new_EndReg (void);
3679 /** Constructor for an EndExpcept node.
3681 * Used to represent exceptional procedure end in interprocedural view.
3682 * Adds the node to the block in current_ir_block.
3684 ir_node *new_EndExcept(void);
3686 /** Constructor for a Jump node.
3688 * Adds the node to the block in current_ir_block.
3690 * Jmp represents control flow to a single control successor.
3692 ir_node *new_Jmp (void);
3694 /** Constructor for an IJmp node.
3696 * IJmp represents control flow to a single control successor not
3697 * statically known i.e. an indirect Jmp.
3699 * @param *tgt The ir node representing the target address.
3701 ir_node *new_IJmp (ir_node *tgt);
3703 /** Constructor for a Break node.
3704 * Break represents control flow to a single control successor just as Jmp.
3705 * The blocks separated by a break may not be concatenated by an optimization.
3706 * It is used for the interprocedural representation where blocks are parted
3707 * behind Call nodes to represent the control flow to called procedures.
3708 * Adds the node to the block in current_ir_block.
3710 ir_node *new_Break (void);
3712 /** Constructor for a Cond node.
3714 * If c is mode_b represents a conditional branch (if/else). If c is
3715 * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond
3716 * node, default Proj is 0.). Adds the node to the block in current_ir_block.
3718 * This is not consistent: Input to Cond is Is, Proj has as proj number
3722 * @param *c The conditions parameter.Can be of mode b or I_u.
3724 ir_node *new_Cond (ir_node *c);
3726 /** Constructor for a Return node.
3728 * Returns the memory an zero or more return values. Only node that
3729 * can end regular control flow. Adds the node to the block in current_ir_block.
3731 * @param *store The state of memory.
3732 * @param arity Number of array indices.
3733 * @param *in Array with index inputs to the node.
3735 ir_node *new_Return (ir_node *store, int arity, ir_node *in[]);
3737 /** Constructor for a Const node.
3739 * Constructor for a Const node. The constant represents a target
3740 * value. Sets the type information to type_unknown. (No more
3741 * supported: If tv is entity derives a somehow useful type.)
3742 * Adds the node to the block in current_ir_block.
3744 * @param *mode The mode of the operands and results.
3745 * @param *con Points to an entry in the constant table. This pointer is
3746 * added to the attributes of the node.
3748 ir_node *new_Const (ir_mode *mode, tarval *con);
3751 * Make a const from a long.
3752 * This is just convenience for the usual
3754 * new_Const(mode, tarval_from_long(mode, ...))
3757 * @param mode The mode for the const.
3758 * @param value The value of the constant.
3759 * @return A new const node.
3761 ir_node *new_Const_long(ir_mode *mode, long value);
3763 /** Constructor for a Const node.
3765 * Derives mode from passed type. */
3766 ir_node *new_Const_type(tarval *con, ir_type *tp);
3768 /** Constructor for a SymConst node.
3770 * Adds the node to the block in current_ir_block.
3771 * This is the constructor for a symbolic constant.
3772 * There are four kinds of symbolic constants:
3773 * -# type_tag The symbolic constant represents a type tag. The type the
3774 * tag stands for is given explicitly.
3775 * -# size The symbolic constant represents the size of a type. The
3776 * type of which the constant represents the size is given
3778 * -# align The symbolic constant represents the alignment of a type. The
3779 * type of which the constant represents the size is given
3781 * -# addr_name The symbolic constant represents the address of an entity
3782 * (variable or method). The variable is indicated by a name
3783 * that is valid for linking.
3784 * -# addr_ent The symbolic constant represents the address of an entity
3785 * (variable or method). The variable is given explicitly by
3788 * Inputs to the node:
3789 * No inputs except the block it belongs to.
3790 * Outputs of the node.
3791 * An unsigned integer (I_u) or a pointer (P).
3793 * @param value A type or a ident depending on the SymConst kind.
3794 * @param kind The kind of the symbolic constant: symconst_type_tag, symconst_type_size
3795 * symconst_type_align, symconst_addr_name or symconst_addr_ent.
3796 * @param tp The source type of the constant.
3798 ir_node *new_SymConst_type (union symconst_symbol value, symconst_kind kind, ir_type *tp);
3800 /** Constructor for a SymConst node.
3802 * Adds the node to the block in current_ir_block.
3803 * This is the constructor for a symbolic constant.
3804 * There are four kinds of symbolic constants:
3805 * -# type_tag The symbolic constant represents a type tag. The type the
3806 * tag stands for is given explicitly.
3807 * -# size The symbolic constant represents the size of a type. The
3808 * type of which the constant represents the size is given
3810 * -# align The symbolic constant represents the alignment of a type. The
3811 * type of which the constant represents the size is given
3813 * -# addr_name The symbolic constant represents the address of an entity
3814 * (variable or method). The variable is indicated by a name
3815 * that is valid for linking.
3816 * -# addr_ent The symbolic constant represents the address of an entity
3817 * (variable or method). The variable is given explicitly by
3820 * Inputs to the node:
3821 * No inputs except the block it belongs to.
3822 * Outputs of the node.
3823 * An unsigned integer (I_u) or a pointer (P).
3825 * @param value A type or a ident depending on the SymConst kind.
3826 * @param kind The kind of the symbolic constant: symconst_type_tag, symconst_type_size
3827 * symconst_type_align, symconst_addr_name or symconst_addr_ent.
3829 ir_node *new_SymConst (union symconst_symbol value, symconst_kind kind);
3831 /** Constructor for a simpelSel node.
3833 * This is a shortcut for the new_Sel() constructor. To be used for
3834 * Sel nodes that do not select from an array, i.e., have no index
3835 * inputs. It adds the two parameters 0, NULL.
3837 * @param *store The memory in which the object the entity should be selected from is allocated.
3838 * @param *objptr The object from that the Sel operation selects a single attribute out.
3839 * @param *ent The entity to select.
3841 ir_node *new_simpleSel(ir_node *store, ir_node *objptr, ir_entity *ent);
3843 /** Constructor for a Sel node.
3845 * The select node selects an entity (field or method) from an entity
3846 * with a compound type. It explicitly specifies the entity selected.
3847 * Dynamically the node may select entities that overwrite the given
3848 * entity. If the selected entity is an array element entity the Sel
3849 * node takes the required array indices as inputs.
3850 * Adds the node to the block in current_ir_block.
3852 * @param *store The memory in which the object the entity should be selected
3853 * from is allocated.
3854 * @param *objptr A pointer to a compound entity the Sel operation selects a
3855 * single attribute from.
3856 * @param arity The number of array indices needed to select an array element entity.
3857 * @param *in[] If the compound entity is an array the indices of the selected
3858 * element entity. The constructor copies this array.
3859 * @param *ent The entity to select.
3861 ir_node *new_Sel (ir_node *store, ir_node *objptr, int arity, ir_node *in[],
3864 /** Constructor for a Call node.
3866 * Adds the node to the block in current_ir_block.
3867 * Represents all kinds of method and function calls.
3869 * @param *store The actual store.
3870 * @param *callee A pointer to the called procedure.
3871 * @param arity The number of procedure parameters.
3872 * @param *in[] An array with the pointers to the parameters. The constructor copies this array.
3873 * @param *tp Type information of the procedure called.
3875 ir_node *new_Call (ir_node *store, ir_node *callee, int arity, ir_node *in[],
3878 /** Constructor for a CallBegin node.
3880 * CallBegin represents control flow depending of the pointer value
3881 * representing the called method to the called methods. The
3882 * constructor copies the method pointer input from the passed Call
3883 * node. Adds the node to the block in current_ir_block.
3885 * @param *callee A pointer to the called procedure.
3887 ir_node *new_CallBegin(ir_node *callee);
3889 /** Constructor for a Add node.
3891 * Adds the node to the block in current_ir_block.
3893 * @param *op1 The first operand.
3894 * @param *op2 The second operand.
3895 * @param *mode The mode of the operands and the result.
3897 ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode);
3899 /** Constructor for a Sub node.
3901 * Adds the node to the block in current_ir_block.
3903 * @param *op1 The first operand.
3904 * @param *op2 The second operand.
3905 * @param *mode The mode of the operands and the result.
3907 ir_node *new_Sub (ir_node *op1, ir_node *op2, ir_mode *mode);
3909 /** Constructor for a Minus node.
3911 * Adds the node to the block in current_ir_block.
3913 * @param *op The operand .
3914 * @param *mode The mode of the operand and the result.
3916 ir_node *new_Minus (ir_node *op, ir_mode *mode);
3919 * Constructor for a Mul node. Adds the node to the block in current_ir_block.
3921 * @param *op1 The first operand.
3922 * @param *op2 The second operand.
3923 * @param *mode The mode of the operands and the result.
3925 ir_node *new_Mul (ir_node *op1, ir_node *op2, ir_mode *mode);
3928 * Constructor for a Mulh node. Adds the node to the block in current_ir_block.
3930 * @param *op1 The first operand.
3931 * @param *op2 The second operand.
3932 * @param *mode The mode of the operands and the result.
3934 ir_node *new_Mulh (ir_node *op1, ir_node *op2, ir_mode *mode);
3936 /** Constructor for a Quot node.
3938 * Adds the node to the block in current_ir_block.
3940 * @param *memop The store needed to model exceptions
3941 * @param *op1 The first operand.
3942 * @param *op2 The second operand.
3943 * @param *mode The mode of the result.
3944 * @param state The pinned state.
3946 ir_node *new_Quot (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
3948 /** Constructor for a DivMod node.
3950 * Adds the node to the block in current_ir_block.
3952 * @param *memop The store needed to model exceptions
3953 * @param *op1 The first operand.
3954 * @param *op2 The second operand.
3955 * @param *mode The mode of the results.
3956 * @param state The pinned state.
3958 ir_node *new_DivMod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
3960 /** Constructor for a Div node.
3962 * Adds the node to the block in current_ir_block.
3964 * @param *memop The store needed to model exceptions
3965 * @param *op1 The first operand.
3966 * @param *op2 The second operand.
3967 * @param *mode The mode of the result.
3968 * @param state The pinned state.
3970 ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
3972 /** Constructor for a Mod node.
3974 * Adds the node to the block in current_ir_block.
3976 * @param *memop The store needed to model exceptions
3977 * @param *op1 The first operand.
3978 * @param *op2 The second operand.
3979 * @param *mode The mode of the result.
3980 * @param state The pinned state.
3982 ir_node *new_Mod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
3984 /** Constructor for a Abs node.
3986 * Adds the node to the block in current_ir_block.
3988 * @param *op The operand
3989 * @param *mode The mode of the operands and the result.
3991 ir_node *new_Abs (ir_node *op, ir_mode *mode);
3993 /** Constructor for a And node.
3995 * Adds the node to the block in current_ir_block.
3997 * @param *op1 The first operand.
3998 * @param *op2 The second operand.
3999 * @param *mode The mode of the operands and the result.
4001 ir_node *new_And (ir_node *op1, ir_node *op2, ir_mode *mode);
4004 * Constructor for a Or node. Adds the node to the block in current_ir_block.
4006 * @param *op1 The first operand.
4007 * @param *op2 The second operand.
4008 * @param *mode The mode of the operands and the result.
4010 ir_node *new_Or (ir_node *op1, ir_node *op2, ir_mode *mode);
4013 * Constructor for a Eor node. Adds the node to the block in current_ir_block.
4015 * @param *op1 The first operand.
4016 * @param *op2 The second operand.
4017 * @param *mode The mode of the operands and the results.
4019 ir_node *new_Eor (ir_node *op1, ir_node *op2, ir_mode *mode);
4021 /** Constructor for a Not node.
4023 * Adds the node to the block in current_ir_block.
4025 * @param *op The operand.
4026 * @param *mode The mode of the operand and the result.
4028 ir_node *new_Not (ir_node *op, ir_mode *mode);
4030 /** Constructor for a Shl node.
4032 * Adds the node to the block in current_ir_block.
4034 * @param *op The operand.
4035 * @param *k The number of bits to shift the operand .
4036 * @param *mode The mode of the operand and the result.
4038 ir_node *new_Shl (ir_node *op, ir_node *k, ir_mode *mode);
4041 * Constructor for a Shr node. Adds the node to the block in current_ir_block.
4043 * @param *op The operand.
4044 * @param *k The number of bits to shift the operand .
4045 * @param *mode The mode of the operand and the result.
4047 ir_node *new_Shr (ir_node *op, ir_node *k, ir_mode *mode);
4049 /** Constructor for a Shrs node.
4051 * Adds the node to the block in current_ir_block.
4053 * @param *op The operand.
4054 * @param *k The number of bits to shift the operand .
4055 * @param *mode The mode of the operand and the result.
4057 ir_node *new_Shrs (ir_node *op, ir_node *k, ir_mode *mode);
4059 /** Constructor for a Rot node.
4061 * Adds the node to the block in current_ir_block.
4063 * @param *op The operand.
4064 * @param *k The number of bits to rotate the operand.
4065 * @param *mode The mode of the operand.
4067 ir_node *new_Rot (ir_node *op, ir_node *k, ir_mode *mode);
4069 /** Constructor for a Cmp node.
4071 * Adds the node to the block in current_ir_block.
4073 * @param *op1 The first operand.
4074 * @param *op2 The second operand.
4076 ir_node *new_Cmp (ir_node *op1, ir_node *op2);
4078 /** Constructor for a Conv node.
4080 * Adds the node to the block in current_ir_block.
4082 * @param *op The operand.
4083 * @param *mode The mode of this the operand muss be converted.
4085 ir_node *new_Conv (ir_node *op, ir_mode *mode);
4087 /** Constructor for a strict Conv node.
4089 * Adds the node to the block in current_ir_block.
4091 * @param *op The operand.
4092 * @param *mode The mode of this the operand muss be converted.
4094 ir_node *new_strictConv (ir_node *op, ir_mode *mode);
4096 /** Constructor for a Cast node.
4098 * Adds the node to the block in current_ir_block.
4099 * High level type cast
4101 * @param *op The operand.
4102 * @param *to_tp The type of this the operand muss be casted .
4104 ir_node *new_Cast (ir_node *op, ir_type *to_tp);
4106 /** Constructor for a Carry node.
4108 * Adds the node to the block in current_ir_block.
4110 * @param *op1 The first operand.
4111 * @param *op2 The second operand.
4112 * @param *mode The mode of the operands and the result.
4114 ir_node *new_Carry (ir_node *op1, ir_node *op2, ir_mode *mode);
4116 /** Constructor for a Borrow node.
4118 * Adds the node to the block in current_ir_block.
4120 * @param *op1 The first operand.
4121 * @param *op2 The second operand.
4122 * @param *mode The mode of the operands and the result.
4124 ir_node *new_Borrow (ir_node *op1, ir_node *op2, ir_mode *mode);
4126 /** Constructor for a Phi node.
4128 * Adds the node to the block in current_ir_block.
4130 * @param arity The number of predecessors.
4131 * @param *in Array with predecessors.
4132 * @param *mode The mode of it's inputs and output.
4134 ir_node *new_Phi (int arity, ir_node *in[], ir_mode *mode);
4136 /** Constructor for a Load node.
4138 * @param *store The current memory.
4139 * @param *addr A pointer to the variable to be read in this memory.
4140 * @param *mode The mode of the value to be loaded.
4142 ir_node *new_Load (ir_node *store, ir_node *addr, ir_mode *mode);
4144 /** Constructor for a Store node.
4146 * @param *store The current memory.
4147 * @param *addr A pointer to the variable to be read in this memory.
4148 * @param *val The value to write to this variable.
4150 ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val);
4152 /** Constructor for a Alloc node.
4154 * The Alloc node extends the memory by space for an entity of type alloc_type.
4155 * Adds the node to the block in current_ir_block.
4157 * @param *store The memory which shall contain the new variable.
4158 * @param *size The number of bytes to allocate.
4159 * @param *alloc_type The type of the allocated variable.
4160 * @param where Where to allocate the variable, either heap_alloc or stack_alloc.
4162 ir_node *new_Alloc (ir_node *store, ir_node *size, ir_type *alloc_type,
4165 /** Constructor for a Free node.
4167 * Frees the memory occupied by the entity pointed to by the pointer
4168 * arg. Type indicates the type of the entity the argument points to.
4169 * Adds the node to the block in current_ir_block.
4171 * @param *store The memory which shall contain the new variable.
4172 * @param *ptr The pointer to the object to free.
4173 * @param *size The number of objects of type free_type to free in a sequence.
4174 * @param *free_type The type of the freed variable.
4175 * @param where Where the variable was allocated, either heap_alloc or stack_alloc.
4177 ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size,
4178 ir_type *free_type, where_alloc where);
4180 /** Constructor for a Sync node.
4182 * Merges several memory values. The node assumes that a variable
4183 * either occurs only in one of the memories, or it contains the same
4184 * value in all memories where it occurs.
4185 * Adds the node to the block in current_ir_block.
4187 * @param arity The number of memories to synchronize.
4188 * @param **in An array of pointers to nodes that produce an output of type
4189 * memory. The constructor copies this array.
4191 ir_node *new_Sync (int arity, ir_node *in[]);
4193 /** Constructor for a Proj node.
4195 * Projects a single value out of a tuple. The parameter proj gives the
4196 * position of the value within the tuple.
4197 * Adds the node to the block in current_ir_block.
4199 * @param arg A node producing a tuple.
4200 * @param *mode The mode of the value to project.
4201 * @param proj The position of the value in the tuple.
4203 ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj);
4205 /** Constructor for a Filter node.
4207 * Constructor for a Filter node. Adds the node to the block in current_ir_block.
4208 * Filter is a node with two views used to construct the interprocedural view.
4209 * In intraprocedural view its semantics are identical to the Proj node.
4210 * In interprocedural view the Filter performs the Phi operation on method
4211 * parameters or results. Other than a Phi a Filter node may not be removed
4212 * if it has only a single input.
4214 * The constructor builds the Filter in intraprocedural view.
4216 * @param *arg The tuple value to project from.
4217 * @param *mode The mode of the projected value.
4218 * @param proj The position in the tuple to project from.
4220 ir_node *new_Filter (ir_node *arg, ir_mode *mode, long proj);
4222 /** Constructor for a defaultProj node.
4224 * Represents the default control flow of a Switch-Cond node.
4225 * Adds the node to the block in current_ir_block.
4227 * @param arg A node producing a tuple.
4228 * @param max_proj The end position of the value in the tuple.
4230 ir_node *new_defaultProj (ir_node *arg, long max_proj);
4232 /** Constructor for a Tuple node.
4234 * This is an auxiliary node to replace a node that returns a tuple
4235 * without changing the corresponding Proj nodes.
4236 * Adds the node to the block in current_ir_block.
4238 * @param arity The number of tuple elements.
4239 * @param **in An array containing pointers to the nodes producing the tuple elements.
4241 ir_node *new_Tuple (int arity, ir_node *in[]);
4243 /** Constructor for an Id node.
4245 * This is an auxiliary node to replace a node that returns a single
4246 * value. Adds the node to the block in current_ir_block.
4248 * @param *val The operand to Id.
4249 * @param *mode The mode of *val.
4251 ir_node *new_Id (ir_node *val, ir_mode *mode);
4253 /** Constructor for a Bad node.
4255 * Returns the unique Bad node of the graph. The same as
4258 ir_node *new_Bad (void);
4260 /** Constructor for a Confirm node.
4262 * Specifies constraints for a value. To support dataflow analyses.
4263 * Adds the node to the block in current_ir_block.
4265 * Example: If the value never exceeds '100' this is expressed by placing a
4266 * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge.
4268 * @param *val The value we express a constraint for
4269 * @param *bound The value to compare against. Must be a firm node, typically a constant.
4270 * @param cmp The compare operation.
4272 ir_node *new_Confirm (ir_node *val, ir_node *bound, pn_Cmp cmp);
4274 /** Constructor for an Unknown node.
4276 * Represents an arbitrary value. Places the node in
4279 * @param *m The mode of the unknown value.
4281 ir_node *new_Unknown(ir_mode *m);
4283 /** Constructor for a NoMem node.
4285 * Returns the unique NoMem node of the graph. The same as
4288 ir_node *new_NoMem (void);
4290 /** Constructor for a Mux node.
4292 * Adds the node to the block in current_ir_block.
4294 * @param *sel The ir_node that calculates the boolean select.
4295 * @param *ir_true The ir_node that calculates the true result.
4296 * @param *ir_false The ir_node that calculates the false result.
4297 * @param *mode The mode of the node (and it_true and ir_false).
4299 ir_node *new_Mux (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
4301 /** Constructor for a Psi node.
4303 * @param *arity The arity of the conditions
4304 * @param *conds The array of mode_b conditions, length must be equal arity
4305 * @param *vals The array of mode values, length must be equal arity + 1
4306 * @param *mode The mode of the node (must be the mode of all vals).
4308 ir_node *new_Psi (int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode);
4310 /** Constructor for a CopyB node.
4312 * Adds the node to the block in current_ir_block.
4314 * @param *store The current memory
4315 * @param *dst The ir_node that represents the destination address.
4316 * @param *src The ir_node that represents the source address.
4317 * @param *data_type The type of the copied data
4319 ir_node *new_CopyB(ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
4321 /** Constructor for a InstOf node.
4323 * A High-Level Type check.
4325 * @param *store The memory in which the object the entity should be selected
4326 * from is allocated.
4327 * @param *objptr A pointer to a object of a class type.
4328 * @param *type The type of which objptr must be.
4330 ir_node *new_InstOf (ir_node *store, ir_node *objptr, ir_type *type);
4332 /**Constructor for a Raise node.
4334 * A High-Level Exception throw.
4336 * @param *store The current memory.
4337 * @param *obj A pointer to the Except variable.
4339 ir_node *new_Raise (ir_node *store, ir_node *obj);
4341 /** Constructor for a Bound node.
4343 * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
4345 * Adds the node to the block in current_ir_block.
4347 * @param *store The current memory
4348 * @param *idx The ir_node that represents an index.
4349 * @param *lower The ir_node that represents the lower bound for the index.
4350 * @param *upper The ir_node that represents the upper bound for the index.
4352 ir_node *new_Bound (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
4354 /** Constructor for a Pin node.
4356 * @param *node The node which value should be pinned.
4358 ir_node *new_Pin (ir_node *node);
4360 /** Constructor for an ASM pseudo node.
4362 * @param arity The number of data inputs to the node.
4363 * @param *in The array of length arity of data inputs.
4364 * @param *inputs The array of length arity of input constraints.
4365 * @param n_outs The number of data outputs to the node.
4366 * @param *outputs The array of length n_outs of output constraints.
4367 * @param n_clobber The number of clobbered registers.
4368 * @param *clobber The array of length n_clobber of clobbered registers.
4369 * @param *asm_text The assembler text.
4371 ir_node *new_ASM(int arity, ir_node *in[], ir_asm_constraint *inputs,
4372 int n_outs, ir_asm_constraint *outputs,
4373 int n_clobber, ident *clobber[], ident *asm_text);
4375 /*---------------------------------------------------------------------*/
4376 /* The comfortable interface. */
4377 /* Supports automatic Phi node construction. */
4378 /* All routines of the block oriented interface except new_Block are */
4380 /*---------------------------------------------------------------------*/
4382 /** Create an immature Block.
4384 * An immature Block has an unknown number of predecessors. Predecessors
4385 * can be added with add_immBlock_pred(). Once all predecessors are
4386 * added the block must be matured.
4388 * Adds the block to the graph in current_ir_graph. Does set
4389 * current_block. Can be used with automatic Phi node construction.
4390 * This constructor can only be used if the graph is in
4393 ir_node *new_d_immBlock(dbg_info *db);
4394 ir_node *new_immBlock(void);
4396 /** Create an immature PartBlock.
4398 * An immature block has only one Block or PartBlock predecessor.
4399 * A PartBlock forms together with one BLock and possibly other
4400 * PartBlocks a MacroBlock.
4402 * Adds the PartBlock to the graph in current_ir_graph. Does set
4403 * current_block. Can be used with automatic Phi node construction.
4404 * This constructor can only be used if the graph is in
4407 ir_node *new_d_immPartBlock(dbg_info *db, ir_node *pred_jmp);
4408 ir_node *new_immPartBlock(ir_node *pred_jmp);
4410 /** Add a control flow edge to an immature block. */
4411 void add_immBlock_pred(ir_node *immblock, ir_node *jmp);
4413 /** Finalize a Block node, when all control flows are known. */
4414 void mature_immBlock(ir_node *block);
4415 #define mature_cur_block() mature_immBlock(get_cur_block());
4418 /** Get the current value of a local variable.
4420 * Use this function to obtain the last definition of the local variable
4421 * associated with pos. Pos may not exceed the value passed as n_loc
4422 * to new_ir_graph. This call automatically inserts Phi nodes.
4424 * @param *db A pointer for debug information.
4425 * @param pos The position/id of the local variable.
4426 * @param *mode The mode of the value to get.
4428 ir_node *get_d_value(dbg_info *db, int pos, ir_mode *mode);
4429 ir_node *get_value(int pos, ir_mode *mode);
4431 /** Remark a new definition of a variable.
4433 * Use this function to remember a new definition of the value
4434 * associated with pos. Pos may not exceed the value passed as n_loc
4435 * to new_ir_graph. This call is needed to automatically inserts Phi
4438 * @param pos The position/id of the local variable.
4439 * @param *value The new value written to the local variable.
4441 void set_value(int pos, ir_node *value);
4443 /** Find the value number for a node in the current block.
4445 * This function searches all values in the current block for
4446 * a given value and returns its value number if it was found, else
4448 * Note that this does not mean that the value does not exists,
4449 * it's just not equal the node (for instance behind a Phi/Confirm ...)
4451 * @param *value The value to find.
4453 int find_value(ir_node *value);
4455 /** Get the current memory state.
4457 * Use this function to obtain the last definition of the memory
4458 * state. This call automatically inserts Phi nodes for the memory
4461 ir_node *get_store(void);
4463 /** Remark a new definition of the memory state.
4465 * Use this function to remember a new definition of the memory state.
4466 * This call is needed to automatically inserts Phi nodes.
4468 * @param *store The new memory state.
4470 void set_store(ir_node *store);
4472 /** keep this node alive even if End is not control-reachable from it
4474 * @param ka The node to keep alive.
4476 void keep_alive(ir_node *ka);
4478 /** Returns the frame type of the current graph */
4479 ir_type *get_cur_frame_type(void);
4482 /* --- initialize and finalize ir construction --- */
4484 /** Puts the graph into state "phase_high" */
4485 #define irg_finalize_cons(irg) set_irg_phase_state(irg, phase_high)
4487 /** Puts the program and all graphs into state phase_high.
4489 * This also remarks, the construction of types is finished,
4490 * e.g., that no more subtypes will be added. */
4491 void irp_finalize_cons(void);
4493 /* --- Initialization --- */
4496 * This function is called, whenever a local variable is used before definition
4498 * @param irg the IR graph on which this happens
4499 * @param mode the mode of the local var
4500 * @param pos position chosen be the frontend for this variable (n_loc)
4502 * @return a firm node of mode @p mode that initializes the var at position pos
4505 * Do not return NULL!
4506 * If this function is not set, FIRM will create a const node with tarval BAD.
4507 * Use set_irg_loc_description()/get_irg_loc_description() to assign additional
4508 * informations to local variables.
4510 typedef ir_node *uninitialized_local_variable_func_t(ir_graph *irg, ir_mode *mode, int pos);
projects / libfirm / blob