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_Quot (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
280 * ir_node *new_DivMod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
281 * ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
282 * ir_node *new_Mod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
283 * ir_node *new_Abs (ir_node *op, ir_mode *mode);
284 * ir_node *new_And (ir_node *op1, ir_node *op2, ir_mode *mode);
285 * ir_node *new_Or (ir_node *op1, ir_node *op2, ir_mode *mode);
286 * ir_node *new_Eor (ir_node *op1, ir_node *op2, ir_mode *mode);
287 * ir_node *new_Not (ir_node *op, ir_mode *mode);
288 * ir_node *new_Shl (ir_node *op, ir_node *k, ir_mode *mode);
289 * ir_node *new_Shr (ir_node *op, ir_node *k, ir_mode *mode);
290 * ir_node *new_Shrs (ir_node *op, ir_node *k, ir_mode *mode);
291 * ir_node *new_Rot (ir_node *op, ir_node *k, ir_mode *mode);
292 * ir_node *new_Cmp (ir_node *op1, ir_node *op2);
293 * ir_node *new_Conv (ir_node *op, ir_mode *mode);
294 * ir_node *new_Cast (ir_node *op, ir_type *to_tp);
295 * ir_node *new_Carry (ir_node *op1, ir_node *op2, ir_mode *mode);
296 * ir_node *new_Borrow (ir_node *op1, ir_node *op2, ir_mode *mode);
297 * ir_node *new_Load (ir_node *store, ir_node *addr, ir_mode *mode);
298 * ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val);
299 * ir_node *new_Alloc (ir_node *store, ir_node *size, ir_type *alloc_type,
300 * where_alloc where);
301 * ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size,
302 * ir_type *free_type, where_alloc where);
303 * ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj);
304 * ir_node *new_NoMem (void);
305 * ir_node *new_Mux (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
306 * ir_node *new_Psi (int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode);
307 * ir_node *new_CopyB (ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
308 * ir_node *new_InstOf (ir_node *store, ir_node obj, ir_type *ent);
309 * ir_node *new_Raise (ir_node *store, ir_node *obj);
310 * ir_node *new_Bound (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
311 * ir_node *new_Pin (ir_node *node);
313 * void add_immBlock_pred (ir_node *block, ir_node *jmp);
314 * void mature_immBlock (ir_node *block);
315 * void set_cur_block (ir_node *target);
316 * ir_node *get_value (int pos, ir_mode *mode);
317 * void set_value (int pos, ir_node *value);
318 * ir_node *get_store (void);
319 * void set_store (ir_node *store);
320 * keep_alive (ir_node ka)
322 * IR_NODES AND CONSTRUCTORS FOR IR_NODES
323 * =======================================
325 * All ir_nodes are defined by a common data structure. They are distinguished
326 * by their opcode and differ in the number of their attributes.
328 * The constructor for the block node sets current_block to itself.
329 * Const nodes are always added to the start block.
330 * All other constructors add the created node to the current_block.
331 * swich_block(block) allows to set the current block to block.
333 * Watch for my inconsistent use of input and predecessor (dataflow view)
334 * and `the node points to' (implementation view).
336 * The following description of the nodes lists four properties them if these
338 * - the parameters to the constructor
339 * - the inputs of the Firm node
340 * - the outputs of the Firm node
341 * - attributes to the node
345 * ir_node *new_immBlock (void)
346 * ----------------------------
348 * Creates a new block. Sets current_block to itself. When a new block is
349 * created it cannot be known how many predecessors this block will have in the
350 * control flow graph. Therefore the list of inputs can not be fixed at
351 * creation. Predecessors can be added with add_immBlock_pred (block, control flow
352 * operation). With every added predecessor the number of inputs to Phi nodes
355 * The block can be completed by mature_immBlock(block) if all predecessors are
356 * known. If several blocks are built at once, mature_immBlock can only be called
357 * after set_value has been called for all values that are life at the end
358 * of the block. This is necessary so that Phi nodes created mature_immBlock
359 * get the right predecessors in case of cyclic dependencies. If all set_values
360 * of this block are called after maturing it and before calling get_value
361 * in some block that is control flow dependent on this block, the construction
364 * Example for faulty ir construction: (draw the graph on a paper and you'll
367 * block_before_loop = new_block();
369 * mature_immBlock(block_before_loop);
370 * before2header = new_Jmp;
372 * loop_header = new_block ();
373 * header2body - new_Jmp();
375 * loop_body = new_block ();
376 * body2header = new_Jmp();
378 * add_immBlock_pred(loop_header, before2header);
379 * add_immBlock_pred(loop_header, body2header);
380 * add_immBlock_pred(loop_body, header2body);
382 * mature_immBlock(loop_header);
383 * mature_immBlock(loop_body);
385 * get_value(loop_body, x); // gets the Phi in loop_header
386 * set_value(loop_header, x); // sets the value the above get_value should
387 * // have returned!!!
389 * Mature_immBlock also fixes the number of inputs to the Phi nodes. Mature_immBlock
390 * should be called as early as possible, as afterwards the generation of Phi
391 * nodes is more efficient.
394 * There is an input for each control flow predecessor of the block.
395 * The input points to an instruction producing an output of type X.
396 * Possible predecessors: Start, Jmp, Cond, Raise or Return or any node
397 * possibly causing an exception. (Often the real predecessors are Projs.)
399 * Mode BB (R), all nodes belonging to this block should consume this output.
400 * As they are strict (except Block and Phi node) it is a necessary condition
401 * that the block node executed before any other node in this block executes.
403 * block.matured Indicates whether the block is mature.
405 * This attribute contains all local values valid in this
406 * block. This is needed to build the Phi nodes and removed
407 * if the graph is complete. This field is used by the
408 * internal construction algorithm and should not be accessed
412 * ir_node *new_Block (int arity, ir_node **in)
413 * --------------------------------------------
415 * Creates a new Block with the given list of predecessors. This block
416 * is mature. As other constructors calls optimization and vrfy for the
417 * block. If one of the predecessors is Unknown (as it has to be filled in
418 * later) optimizations are skipped. This is necessary to
419 * construct Blocks in loops. Leaving Unknown in the Block after finishing
420 * the construction may have strange effects, especially for interprocedural
421 * representation and analysis.
424 * CONTROL FLOW OPERATIONS
425 * -----------------------
427 * In each block there must be exactly one of the control flow
428 * operations Start, End, Jmp, Cond, Return or Raise. The output of a
429 * control flow operation points to the block to be executed next.
431 * ir_node *new_Start (void)
432 * -------------------------
434 * Creates a start node. Not actually needed public. There is only one such
435 * node in each procedure which is automatically created by new_ir_graph.
438 * No inputs except the block it belogns to.
440 * A tuple of 4 (5, 6) distinct values. These are labeled by the following
441 * projection numbers (pn_Start):
442 * * pn_Start_X_initial_exec mode X, points to the first block to be exe * cuted.
443 * * pn_Start_M mode M, the global store
444 * * pn_Start_P_frame_base mode P, a pointer to the base of the proce * dures stack frame.
445 * * pn_Start_P_globals mode P, a pointer to the part of the memory * containing_all_ global things.
446 * * pn_Start_T_args mode T, a tuple containing all arguments of * the procedure.
449 * ir_node *new_End (void)
450 * -----------------------
452 * Creates an end node. Not actually needed public. There is only one such
453 * node in each procedure which is automatically created by new_ir_graph.
456 * No inputs except the block it belongs to.
460 * ir_node *new_Jmp (void)
461 * -----------------------
463 * Creates a Jmp node.
466 * The block the node belongs to
468 * Control flow to the next block.
470 * ir_node *new_IJmp (ir_node *tgt)
471 * -----------------------
473 * Creates an IJmp node.
476 * The node that represents the target jump address
478 * Control flow to an unknown target, must be pinned by
481 * ir_node *new_Cond (ir_node *c)
482 * ------------------------------
484 * Creates a Cond node. There are two versions of this node.
490 * A tuple of two control flows. The first is taken if the input is
491 * false, the second if it is true.
495 * A value of mode I_u. (i)
497 * A tuple of n control flows. If the Cond's input is i, control
498 * flow will procede along output i. If the input is >= n control
499 * flow proceeds along output n.
501 * ir_node *new_Return (ir_node *store, int arity, ir_node **in)
502 * -------------------------------------------------------------
504 * The return node has as inputs the results of the procedure. It
505 * passes the control flow to the end_block.
511 * Control flow to the end block.
515 * ir_node *new_Const (ir_mode *mode, tarval *con)
516 * -----------------------------------------------
518 * Creates a constant in the constant table and adds a Const node
519 * returning this value to the start block.
522 * *mode The mode of the constant.
523 * *con Points to an entry in the constant table.
524 * This pointer is added to the attributes of
525 * the node (self->attr.con)
527 * No inputs except the block it belogns to.
529 * The constant value.
531 * attr.con A tarval* pointer to the proper entry in the constant
534 * ir_node *new_SymConst (union symconst_symbol value, symconst_addr_ent kind)
535 * ---------------------------------------------------------------------------
537 * There are three kinds of symbolic constants:
538 * symconst_type_tag The symbolic constant represents a type tag.
539 * symconst_type_size The symbolic constant represents the size of a type.
540 * symconst_type_align The symbolic constant represents the alignment of a type.
541 * symconst_addr_name Information for the linker, e.g. the name of a global
543 * symconst_addr_name The symbolic constant represents the address of an entity.
545 * To represent a pointer to an entity that is represented by an entity
546 * datastructure don't use
547 * new_SymConst((type_or_id*)get_entity_ld_ident(ent), symconst_addr_name);.
548 * Use a real const instead:
549 * new_SymConst(ent, symconst_addr_ent);
550 * This makes the Constant independent of name changes of the entity due to
554 * kind The kind of the symbolic constant: type_tag, size or link_info.
555 * *type_or_id Points to the type the tag stands for or to the type
556 * whose size is represented by the constant or to an ident
557 * representing the linkage info.
560 * No inputs except the block it belogns to.
562 * An unsigned integer (I_u) or a pointer (P).
565 * attr.i.num The symconst_addr_ent, i.e. one of
567 * -symconst_type_size
568 * -symconst_type_align
569 * -symconst_addr_name
571 * If the attr.i.num is symconst_type_tag, symconst_type_size or symconst_type_align,
572 * the node contains an attribute:
574 * attr.i.*type, a pointer to a type_class. The mode of the node is mode_Is.
575 * if it is linkage_ptr_info it contains
576 * attr.i.*ptrinfo, an ident holding information for the linker. The mode
577 * of the node is mode_P_mach.
581 * ir_node *new_simpleSel (ir_node *store, ir_node *frame, ir_entity *sel)
582 * -----------------------------------------------------------------------
585 * Selects an entity from a compound type. This entity can be a field or
589 * *store The memory in which the object the entity should be selected
591 * *frame The pointer to the object.
592 * *sel The entity to select.
595 * The memory containing the object.
596 * A pointer to the object.
597 * An unsigned integer.
599 * A pointer to the selected entity.
601 * attr.sel Pointer to the entity
604 * ir_node *new_Sel (ir_node *store, ir_node *frame, int arity, ir_node **in,
605 * --------------------------------------------------------------------------
609 * Selects a field from an array type. The entity has as owner the array, as
610 * type the arrays element type. The indices to access an array element are
614 * *store The memory in which the object the entity should be selected from
616 * *frame The pointer to the object.
617 * *arity number of array indices.
618 * *in array with index inputs to the node.
619 * *sel The entity to select.
622 * The memory containing the object.
623 * A pointer to the object.
624 * As much unsigned integer as there are array expressions.
626 * A pointer to the selected entity.
628 * attr.sel Pointer to the entity
630 * The constructors new_Sel and new_simpleSel generate the same ir nodes.
631 * simpleSel just sets the arity of the index inputs to zero.
634 * ARITHMETIC OPERATIONS
635 * ---------------------
637 * ir_node *new_Call (ir_node *store, ir_node *callee, int arity, ir_node **in,
638 * ----------------------------------------------------------------------------
642 * Creates a procedure call.
645 * *store The actual store.
646 * *callee A pointer to the called procedure.
647 * arity The number of procedure parameters.
648 * **in An array with the pointers to the parameters.
649 * The constructor copies this array.
650 * *type Type information of the procedure called.
653 * The store, the callee and the parameters.
655 * A tuple containing the eventually changed store and the procedure
658 * attr.call Contains the type information for the procedure.
661 * ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode)
662 * ------------------------------------------------------------
666 * ir_node *new_Sub (ir_node *op1, ir_node *op2, ir_mode *mode)
667 * ------------------------------------------------------------
671 * ir_node *new_Minus (ir_node *op, ir_mode *mode)
672 * -----------------------------------------------
674 * Unary Minus operations on integer and floating point values.
676 * ir_node *new_Mul (ir_node *op1, ir_node *op2, ir_mode *mode)
677 * ------------------------------------------------------------
681 * ir_node *new_Quot (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode)
682 * -----------------------------------------------------------------------------
684 * Quot performs exact division of floating point numbers. It's mode
685 * is Tuple, the mode of the result must match the Proj mode
686 * that extracts the result of the arithmetic operations.
689 * The store needed to model exceptions and the two operands.
691 * A tuple containing a memory and a execution for modeling exceptions
692 * and the result of the arithmetic operation.
694 * ir_node *new_DivMod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode)
695 * -------------------------------------------------------------------------------
697 * Performs Div and Mod on integer values.
700 * A tuple containing a memory and a execution for modeling exceptions
701 * and the two result of the arithmetic operations.
703 * ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode)
704 * ----------------------------------------------------------------------------
708 * ir_node *new_Mod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode)
709 * ----------------------------------------------------------------------------
713 * ir_node *new_Abs (ir_node *op, ir_mode *mode)
714 * ---------------------------------------------
718 * ir_node *new_And (ir_node *op1, ir_node *op2, ir_mode *mode)
719 * ------------------------------------------------------------
723 * ir_node *new_Or (ir_node *op1, ir_node *op2, ir_mode *mode)
724 * -----------------------------------------------------------
728 * ir_node *new_Eor (ir_node *op1, ir_node *op2, ir_mode *mode)
729 * ------------------------------------------------------------
733 * ir_node *new_Not (ir_node *op, ir_mode *mode)
734 * ---------------------------------------------
736 * This node constructs a constant where all bits are set to one
737 * and a Eor of this constant and the operator. This simulates a
740 * ir_node *new_Shl (ir_node *op, ir_node *k, ir_mode *mode)
741 * ---------------------------------------------------------
745 * ir_node *new_Shr (ir_node *op, ir_node *k, ir_mode *mode)
746 * ---------------------------------------------------------
748 * Logic shift right, i.e., zero extended.
751 * ir_node *new_Shrs (ir_node *op, ir_node *k, ir_mode *mode)
752 * ----------------------------------------------------------
754 * Arithmetic shift right, i.e., sign extended.
756 * ir_node *new_Rot (ir_node *op, ir_node *k, ir_mode *mode)
757 * ---------------------------------------------------------
759 * Rotates the operand to the (right?) by k bits.
761 * ir_node *new_Carry (ir_node *op1, ir_node *op2, ir_mode *mode)
762 * ------------------------------------------------------------
764 * Calculates the Carry value for integer addition. Used only
767 * ir_node *new_Borrow (ir_node *op1, ir_node *op2, ir_mode *mode)
768 * ------------------------------------------------------------
770 * Calculates the Borrow value for integer substraction. Used only
773 * ir_node *new_Conv (ir_node *op, ir_mode *mode)
774 * ---------------------------------------------
776 * Mode conversion. For allowed conversions see UKA Tech Report
779 * ir_node *new_Cmp (ir_node *op1, ir_node *op2)
780 * ---------------------------------------------
783 * The two values to be compared.
785 * A 16-tuple containing the results of the 16 different comparisons.
786 * The following is a list giving the comparisons and a projection
787 * number (pn_Cmp) to use in Proj nodes to extract the proper result.
791 * pn_Cmp_Le less or equal
793 * pn_Cmp_Ge greater of equal
794 * pn_Cmp_Lg less or greater
795 * pn_Cmp_Leg less, equal or greater = ordered
796 * pn_Cmp_Uo unordered
797 * pn_Cmp_Ue unordered or equal
798 * pn_Cmp_Ul unordered or less
799 * pn_Cmp_Ule unordered, less or equal
800 * pn_Cmp_Ug unordered or greater
801 * pn_Cmp_Uge unordered, greater or equal
802 * pn_Cmp_Ne unordered, less or greater = not equal
809 * In general, Phi nodes are automaitcally inserted. In some cases, if
810 * all predecessors of a block are known, an explicit Phi node constructor
811 * is needed. E.g., to construct a FIRM graph for a statement as
812 * a = (b==c) ? 2 : 5;
814 * ir_node *new_Phi (int arity, ir_node **in, ir_mode *mode)
815 * ---------------------------------------------------------
817 * Creates a Phi node. The in's order has to correspond to the order
818 * of in's of current_block. This is not checked by the library!
819 * If one of the predecessors is Unknown (as it has to be filled in
820 * later) optimizations are skipped. This is necessary to
821 * construct Phi nodes in loops. Leaving Unknown in the Phi after finishing
822 * the construction may have strange effects, especially for interprocedural
823 * representation and analysis.
826 * arity number of predecessors
827 * **in array with predecessors
828 * *mode The mode of it's inputs and output.
830 * A Phi node has as many inputs as the block it belongs to.
831 * Each input points to a definition of the same value on a
832 * different path in the control flow.
834 * The definition valid in this block.
836 * ir_node *new_Mux (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode)
837 * -----------------------------------------------------------------------------
839 * Creates a Mux node. This node implements the following semantic:
840 * If the sel node (which must be of mode_b) evaluates to true, its value is
841 * ir_true, else ir_false;
844 * ir_node *new_Psi (int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode)
845 * -----------------------------------------------------------------------------
847 * Creates a Psi node. This node implements the following semantic:
851 * OPERATIONS TO MANAGE MEMORY EXPLICITLY
852 * --------------------------------------
854 * ir_node *new_Load (ir_node *store, ir_node *addr, ir_mode *mode)
855 * ----------------------------------------------------------------
857 * The Load operation reads a value from memory.
860 * *store The current memory.
861 * *addr A pointer to the variable to be read in this memory.
862 * *mode The mode of the value to be loaded.
865 * The memory and a pointer to a variable in this memory.
867 * A tuple of the memory, a control flow to be taken in case of
868 * an exception and the loaded value.
870 * ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val)
871 * ----------------------------------------------------------------
873 * The Store operation writes a value to a variable in memory.
876 * The memory, a pointer to a variable in this memory and the value
877 * to write to this variable.
879 * A tuple of the changed memory and a control flow to be taken in
880 * case of an exception.
882 * ir_node *new_Alloc (ir_node *store, ir_node *size, ir_type *alloc_type,
883 * -----------------------------------------------------------------------
887 * The Alloc node allocates a new variable. It can be specified whether the
888 * variable should be allocated to the stack or to the heap.
891 * *store The memory which shall contain the new variable.
892 * ** *size The number of bytes to allocate. Old. **
893 * *size We decided that the size easily can be derived from the type.
894 * This field is for allocating arrays, i.e., it gives the multiple
895 * of the size of alloc_type to allocate memory for.
896 * *alloc_type The type of the allocated variable.
897 * where Where to allocate the variable, either heap_alloc or stack_alloc.
900 * A memory and an unsigned integer.
902 * A tuple of the changed memory, a control flow to be taken in
903 * case of an exception and the pointer to the new variable.
905 * a.where Indicates where the variable is allocated.
906 * a.*type A pointer to the class the allocated data object
909 * ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size, ir_type *free_type,
910 * -----------------------------------------------------------------------------------
914 * The Free node frees memory of the given variable.
917 * *store The memory which shall contain the new variable.
918 * *ptr The pointer to the object to free.
919 * *size The number of objects of type free_type to free in a sequence.
920 * *free_type The type of the freed variable.
921 * where Where the variable was allocated, either heap_alloc or stack_alloc.
924 * A memory, a pointer and an unsigned integer.
926 * The changed memory.
928 * f.*type A pointer to the type information of the freed data object.
932 * ir_node *new_Sync (int arity, ir_node **in)
933 * -------------------------------------------
935 * The Sync operation unifies several partial memory blocks. These blocks
936 * have to be pairwise disjunct or the values in common locations have to
937 * be identical. This operation allows to specify all operations that eventually
938 * need several partial memory blocks as input with a single entrance by
939 * unifying the memories with a preceding Sync operation.
942 * arity The number of memories to synchronize.
943 * **in An array of pointers to nodes that produce an output of
948 * The unified memory.
954 * ir_node *new_Bad (void)
955 * -----------------------
957 * Returns the unique Bad node current_ir_graph->bad.
958 * This node is used to express results of dead code elimination.
960 * ir_node *new_NoMem (void)
961 * -----------------------------------------------------------------------------------
963 * Returns the unique NoMem node current_ir_graph->no_mem.
964 * This node is used as input for operations that need a Memory, but do not
965 * change it like Div by const != 0, analyzed calls etc.
967 * ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj)
968 * ----------------------------------------------------------
970 * Selects one entry of a tuple. This is a hidden edge with attributes.
973 * *arg A node producing a tuple.
974 * *mode The mode of the value to project.
975 * proj The position of the value in the tuple.
981 * ir_node *new_Tuple (int arity, ir_node **in)
982 * --------------------------------------------
984 * Builds a Tuple from single values. This is needed to implement
985 * optimizations that remove a node that produced a tuple. The node can be
986 * replaced by the Tuple operation so that the following Proj nodes have not to
987 * be changed. (They are hard to find due to the implementation with pointers
988 * in only one direction.) The Tuple node is smaller than any other
989 * node, so that a node can be changed into a Tuple by just changing it's
990 * opcode and giving it a new in array.
993 * arity The number of tuple elements.
994 * **in An array containing pointers to the nodes producing the
997 * ir_node *new_Id (ir_node *val, ir_mode *mode)
998 * ---------------------------------------------
1000 * The single output of the Id operation is it's input. Also needed
1001 * for optimizations.
1004 * HIGH LEVEL OPERATIONS
1005 * ---------------------
1007 * ir_node *new_CopyB (ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type)
1008 * -----------------------------------------------------------------------------------
1010 * Describes a high level block copy of a compound type from address src to
1011 * address dst. Must be lowered to a Call to a runtime memory copy function.
1014 * HIGH LEVEL OPERATIONS: Exception Support
1015 * ----------------------------------------
1016 * See TechReport 1999-14, chapter Exceptions.
1018 * ir_node *new_InstOf(ir_node *store, ir_node *ptr, ir_type *type);
1019 * -----------------------------------------------------------------------------------
1021 * Describes a high level type check. Must be lowered to a Call to a runtime check
1024 * ir_node *new_Raise (ir_node *store, ir_node *obj)
1025 * -------------------------------------------------
1027 * Raises an exception. Unconditional change of control flow. Writes
1028 * an explicit Except variable to memory to pass it to the exception
1029 * handler. Must be lowered to a Call to a runtime check
1034 * A pointer to the Except variable.
1036 * A tuple of control flow and the changed memory state. The control flow
1037 * points to the exception handler if it is definied in this procedure,
1038 * else it points to the end_block.
1040 * ir_node *new_Bound (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
1041 * -----------------------------------------------------------------------------------
1043 * Describes a high level bounds check. Must be lowered to a Call to a runtime check
1046 * ir_node *new_Pin (ir_node *node);
1047 * -----------------------------------------------------------------------------------
1049 * Pin the value of the node node in the current block No users of the Pin node can
1050 * float above the Block of the Pin. The node cannot float behind this block. Often
1051 * used to Pin the NoMem node.
1054 * COPING WITH DATA OBJECTS
1055 * ========================
1057 * Two kinds of data objects have to be distinguished for generating
1058 * FIRM. First there are local variables other than arrays that are
1059 * known to be alias free. Second there are all other data objects.
1060 * For the first a common SSA representation is built, the second
1061 * are modeled by saving them to memory. The memory is treated as
1062 * a single local variable, the alias problem is hidden in the
1063 * content of this variable.
1065 * All values known in a Block are listed in the block's attribute,
1066 * block.**graph_arr which is used to automatically insert Phi nodes.
1067 * The following two functions can be used to add a newly computed value
1068 * to the array, or to get the producer of a value, i.e., the current
1071 * inline void set_value (int pos, ir_node *value)
1072 * -----------------------------------------------
1074 * Has to be called for every assignment to a local variable. It
1075 * adds the value to the array of used values at position pos. Pos
1076 * has to be a unique identifier for an entry in the procedure's
1077 * definition table. It can be used to access the value again.
1078 * Requires current_block to be set correctly.
1080 * ir_node *get_value (int pos, ir_mode *mode)
1081 * -------------------------------------------
1083 * Returns the node defining the value referred to by pos. If the
1084 * value is not defined in this block a Phi node is generated and
1085 * all definitions reaching this Phi node are collected. It can
1086 * happen that the algorithm allocates an unnecessary Phi node,
1087 * e.g. if there is only one definition of this value, but this
1088 * definition reaches the currend block on several different
1089 * paths. This Phi node will be eliminated if optimizations are
1090 * turned on right after it's creation.
1091 * Requires current_block to be set correctly.
1093 * There are two special routines for the global store:
1095 * void set_store (ir_node *store)
1096 * -------------------------------
1098 * Adds the store to the array of known values at a reserved
1100 * Requires current_block to be set correctly.
1102 * ir_node *get_store (void)
1103 * -------------------------
1105 * Returns the node defining the actual store.
1106 * Requires current_block to be set correctly.
1109 * inline void keep_alive (ir_node *ka)
1110 * ------------------------------------
1112 * Keep this node alive because it is (might be) not in the control
1113 * flow from Start to End. Adds the node to the list in the end
1117 #ifndef FIRM_IR_IRCONS_H
1118 #define FIRM_IR_IRCONS_H
1120 #include "firm_common.h"
1122 #include "irgraph.h"
1124 /*-------------------------------------------------------------------------*/
1125 /* The raw interface */
1126 /*-------------------------------------------------------------------------*/
1128 /** Constructor for a Block node.
1130 * Constructs a mature block with the given predecessors. Use Unknown
1131 * nodes as predecessors to construct a block if the number of
1132 * predecessors is known, but not the predecessors themselves. This
1133 * constructor does not set current_block. It not be used with
1134 * automatic Phi node construction.
1136 * @param *db A Pointer for debug information.
1137 * @param irg The ir graph the block belongs to.
1138 * @param arity The number of control predecessors.
1139 * @param in[] An array of control predecessors. The length of
1140 * the array must be 'arity'. The constructor copies this array.
1142 ir_node *new_rd_Block (dbg_info *db, ir_graph *irg, int arity, ir_node *in[]);
1144 /** Constructor for a Start node.
1146 * @param *db A pointer for debug information.
1147 * @param *irg The ir graph the node belongs to.
1148 * @param *block The ir block the node belongs to.
1150 ir_node *new_rd_Start (dbg_info *db, ir_graph *irg, ir_node *block);
1152 /** Constructor for a End node.
1154 * @param *db A pointer for debug information.
1155 * @param *irg The ir graph the node belongs to.
1156 * @param *block The ir block the node belongs to.
1158 ir_node *new_rd_End (dbg_info *db, ir_graph *irg, ir_node *block);
1160 /** Constructor for a Jmp node.
1162 * Jmp represents control flow to a single control successor.
1164 * @param *db A pointer for debug information.
1165 * @param *irg The ir graph the node belongs to.
1166 * @param *block The ir block the node belongs to.
1168 ir_node *new_rd_Jmp (dbg_info *db, ir_graph *irg, ir_node *block);
1170 /** Constructor for an IJmp node.
1172 * IJmp represents control flow to a single control successor not
1173 * statically known i.e. an indirect Jmp.
1175 * @param *db A pointer for debug information.
1176 * @param *irg The ir graph the node belongs to.
1177 * @param *block The ir block the node belongs to.
1178 * @param *tgt The ir node representing the target address.
1180 ir_node *new_rd_IJmp (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *tgt);
1182 /** Constructor for a Break node.
1184 * Break represents control flow to a single control successor just as Jmp.
1185 * The blocks separated by a break may not be concatenated by an optimization.
1186 * It is used for the interprocedural representation where blocks are parted
1187 * behind Call nodes to represent the control flow to called procedures.
1189 * @param *db A pointer for debug information.
1190 * @param *irg The ir graph the node belong to.
1191 * @param *block The block the node belong to.
1193 ir_node *new_rd_Break (dbg_info *db, ir_graph *irg, ir_node *block);
1195 /** Constructor for a Cond node.
1197 * If c is mode_b represents a conditional branch (if/else). If c is
1198 * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond
1199 * node, default Proj is 0.)
1201 * This is not consistent: Input to Cond is Is, Proj has as proj number
1204 * @param *db A pointer for debug information.
1205 * @param *irg The ir graph the node belongs to.
1206 * @param *block The ir block the node belongs to.
1207 * @param *c The conditions parameter. Can be of mode b or I_u.
1209 ir_node *new_rd_Cond (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *c);
1211 /** Constructor for a Return node.
1213 * Returns the memory an zero or more return values. Only node that
1214 * can end regular control flow.
1216 * @param *db A pointer for debug information.
1217 * @param *irg The ir graph the node belongs to.
1218 * @param *block The ir block the node belongs to.
1219 * @param *store The state of memory.
1220 * @param arity Number of return values.
1221 * @param *in Array of length arity with return values. The constructor copies this array.
1223 ir_node *new_rd_Return (dbg_info *db, ir_graph *irg, ir_node *block,
1224 ir_node *store, int arity, ir_node *in[]);
1226 /** Constructor for a Const_type node.
1228 * The constant represents a target value. This constructor sets high
1229 * level type information for the constant value.
1231 * @param *db A pointer for debug information.
1232 * @param *irg The ir graph the node belongs to.
1233 * @param *block The ir block the node belongs to.
1234 * @param *mode The mode of the operands and results.
1235 * @param *con Points to an entry in the constant table.
1236 * @param *tp The type of the constant.
1238 ir_node *new_rd_Const_type (dbg_info *db, ir_graph *irg, ir_node *block,
1239 ir_mode *mode, tarval *con, ir_type *tp);
1241 /** Constructor for a Const node.
1243 * Constructor for a Const node. The constant represents a target
1244 * value. Sets the type information to type_unknown. (No more
1245 * supported: If tv is entity derives a somehow useful type.)
1247 * @param *db A pointer for debug information.
1248 * @param *irg The ir graph the node belongs to.
1249 * @param *block The ir block the node belongs to.
1250 * @param *mode The mode of the operands and results.
1251 * @param *con Points to an entry in the constant table.
1253 ir_node *new_rd_Const (dbg_info *db, ir_graph *irg, ir_node *block,
1254 ir_mode *mode, tarval *con);
1256 /** Constructor for a SymConst_type node.
1258 * This is the constructor for a symbolic constant.
1259 * There are four kinds of symbolic constants:
1260 * - type_tag The symbolic constant represents a type tag. The type the
1261 * tag stands for is given explicitly.
1262 * - type_size The symbolic constant represents the size of a type. The
1263 * type of which the constant represents the size is given
1265 * - type_align The symbolic constant represents the alignment of a type. The
1266 * type of which the constant represents the size is given
1268 * - addr_name The symbolic constant represents the address of an entity
1269 * (variable or method). The variable is indicated by a name
1270 * that is valid for linking.
1271 * - addr_ent The symbolic constant represents the address of an entity
1272 * (variable or method). The variable is given explicitly by
1275 * Inputs to the node:
1276 * No inputs except the block it belongs to.
1277 * Outputs of the node.
1278 * An unsigned integer (I_u) or a pointer (P).
1280 * Mention union in declaration so that the firmjni generator recognizes that
1281 * it can not cast the argument to an int.
1283 * @param *db A pointer for debug information.
1284 * @param *irg The ir graph the node belongs to.
1285 * @param *block The ir block the node belongs to.
1286 * @param symkind The kind of the symbolic constant: type_tag, size, addr_name or addr_ent.
1287 * @param value A type, entity or a ident depending on the SymConst kind.
1288 * @param tp The source type of the constant.
1290 ir_node *new_rd_SymConst_type (dbg_info *db, ir_graph *irg, ir_node *block, union symconst_symbol value,
1291 symconst_kind symkind, ir_type *tp);
1293 /** Constructor for a SymConst node.
1295 * Same as new_rd_SymConst_type, except that it sets the type to type_unknown. */
1296 ir_node *new_rd_SymConst (dbg_info *db, ir_graph *irg, ir_node *block,
1297 union symconst_symbol value, symconst_kind symkind);
1299 /** Constructor for a SymConst addr_ent node.
1301 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1302 * symconst_addr_ent.
1303 * Adds the SymConst to the start block of irg. */
1304 ir_node *new_rd_SymConst_addr_ent (dbg_info *db, ir_graph *irg, ir_entity *symbol, ir_type *tp);
1306 /** Constructor for a SymConst ofs_ent node.
1308 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1310 * Adds the SymConst to the start block of irg. */
1311 ir_node *new_rd_SymConst_ofs_ent (dbg_info *db, ir_graph *irg, ir_entity *symbol, ir_type *tp);
1313 /** Constructor for a SymConst addr_name node.
1315 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1316 * symconst_addr_ent.
1317 * Adds the SymConst to the start block of irg. */
1318 ir_node *new_rd_SymConst_addr_name (dbg_info *db, ir_graph *irg, ident *symbol, ir_type *tp);
1320 /** Constructor for a SymConst type_tag node.
1322 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1323 * symconst_addr_ent.
1324 * Adds the SymConst to the start block of irg. */
1325 ir_node *new_rd_SymConst_type_tag (dbg_info *db, ir_graph *irg, ir_type *symbol, ir_type *tp);
1327 /** Constructor for a SymConst size node.
1329 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1330 * symconst_type_size.
1331 * Adds the SymConst to the start block of irg. */
1332 ir_node *new_rd_SymConst_size (dbg_info *db, ir_graph *irg, ir_type *symbol, ir_type *tp);
1334 /** Constructor for a SymConst size node.
1336 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1337 * symconst_type_align.
1338 * Adds the SymConst to the start block of irg. */
1339 ir_node *new_rd_SymConst_align (dbg_info *db, ir_graph *irg, ir_type *symbol, ir_type *tp);
1341 /** Constructor for a simpleSel node.
1343 * This is a shortcut for the new_rd_Sel() constructor. To be used for
1344 * Sel nodes that do not select from an array, i.e., have no index
1345 * inputs. It adds the two parameters 0, NULL.
1347 * @param *db A pointer for debug information.
1348 * @param *irg The ir graph the node belongs to.
1349 * @param *block The ir block the node belongs to.
1350 * @param *store The memory in which the object the entity should be
1351 * selected from is allocated.
1352 * @param *objptr The object from that the Sel operation selects a
1353 * single attribute out.
1354 * @param *ent The entity to select.
1356 ir_node *new_rd_simpleSel (dbg_info *db, ir_graph *irg, ir_node *block,
1357 ir_node *store, ir_node *objptr, ir_entity *ent);
1359 /** Constructor for a Sel node.
1361 * The select node selects an entity (field or method) from an entity
1362 * with a compound type. It explicitly specifies the entity selected.
1363 * Dynamically the node may select entities that overwrite the given
1364 * entity. If the selected entity is an array element entity the Sel
1365 * node takes the required array indices as inputs.
1367 * @param *db A pointer for debug information.
1368 * @param *irg The ir graph the node belongs to.
1369 * @param *block The ir block the node belongs to.
1370 * @param *store The memory in which the object the entity should be selected
1371 * from is allocated.
1372 * @param *objptr A pointer to a compound entity the Sel operation selects a
1373 * single attribute from.
1374 * @param *n_index The number of array indices needed to select an array element entity.
1375 * @param *index[] If the compound entity is an array the indices of the selected
1376 * element entity. The constructor copies this array.
1377 * @param *ent The entity to select.
1379 ir_node *new_rd_Sel (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1380 ir_node *objptr, int n_index, ir_node *index[], ir_entity *ent);
1382 /** Constructor for a Call node.
1384 * Represents all kinds of method and function calls.
1386 * @param *db A pointer for debug information.
1387 * @param *irg The ir graph the node belongs to.
1388 * @param *block The ir block the node belongs to.
1389 * @param *store The current memory state.
1390 * @param *callee A pointer to the called procedure.
1391 * @param arity The number of procedure parameters.
1392 * @param *in[] An array with the procedure parameters. The constructor copies this array.
1393 * @param *tp Type information of the procedure called.
1395 ir_node *new_rd_Call (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1396 ir_node *callee, int arity, ir_node *in[], ir_type *tp);
1398 /** Constructor for a Add node.
1400 * @param *db A pointer for debug information.
1401 * @param *irg The ir graph the node belongs to.
1402 * @param *block The ir block the node belongs to.
1403 * @param *op1 The first operand.
1404 * @param *op2 The second operand.
1405 * @param *mode The mode of the operands and the result.
1407 ir_node *new_rd_Add (dbg_info *db, ir_graph *irg, ir_node *block,
1408 ir_node *op1, ir_node *op2, ir_mode *mode);
1410 /** Constructor for a Sub node.
1412 * @param *db A pointer for debug information.
1413 * @param *irg The ir graph the node belongs to.
1414 * @param *block The ir block the node belongs to.
1415 * @param *op1 The first operand.
1416 * @param *op2 The second operand.
1417 * @param *mode The mode of the operands and the result.
1419 ir_node *new_rd_Sub (dbg_info *db, ir_graph *irg, ir_node *block,
1420 ir_node *op1, ir_node *op2, ir_mode *mode);
1422 /** Constructor for a Minus node.
1424 * @param *db A pointer for debug information.
1425 * @param *irg The ir graph the node belongs to.
1426 * @param *block The ir block the node belongs to.
1427 * @param *op The operand .
1428 * @param *mode The mode of the operand and the result.
1430 ir_node *new_rd_Minus (dbg_info *db, ir_graph *irg, ir_node *block,
1431 ir_node *op, ir_mode *mode);
1433 /** Constructor for a Mul node.
1435 * @param *db A pointer for debug information.
1436 * @param *irg The ir graph the node belongs to.
1437 * @param *block The ir block the node belongs to.
1438 * @param *op1 The first operand.
1439 * @param *op2 The second operand.
1440 * @param *mode The mode of the operands and the result.
1442 ir_node *new_rd_Mul (dbg_info *db, ir_graph *irg, ir_node *block,
1443 ir_node *op1, ir_node *op2, ir_mode *mode);
1445 /** Constructor for a Quot node.
1447 * @param *db A pointer for debug information.
1448 * @param *irg The ir graph the node belongs to.
1449 * @param *block The ir block the node belongs to.
1450 * @param *memop The store needed to model exceptions
1451 * @param *op1 The first operand.
1452 * @param *op2 The second operand.
1453 * @param *mode The mode of the result.
1455 ir_node *new_rd_Quot (dbg_info *db, ir_graph *irg, ir_node *block,
1456 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
1458 /** Constructor for a DivMod node.
1460 * @param *db A pointer for debug information.
1461 * @param *irg The ir graph the node belongs to.
1462 * @param *block The ir block the node belongs to.
1463 * @param *memop The store needed to model exceptions
1464 * @param *op1 The first operand.
1465 * @param *op2 The second operand.
1466 * @param *mode The mode of the results.
1468 ir_node *new_rd_DivMod (dbg_info *db, ir_graph *irg, ir_node *block,
1469 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
1471 /** Constructor for a Div node.
1473 * @param *db A pointer for debug information.
1474 * @param *irg The ir graph the node belongs to.
1475 * @param *block The ir block the node belongs to.
1476 * @param *memop The store needed to model exceptions
1477 * @param *op1 The first operand.
1478 * @param *op2 The second operand.
1479 * @param *mode The mode of the result.
1481 ir_node *new_rd_Div (dbg_info *db, ir_graph *irg, ir_node *block,
1482 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
1484 /** Constructor for a Mod node.
1486 * @param *db A pointer for debug information.
1487 * @param *irg The ir graph the node belongs to.
1488 * @param *block The ir block the node belongs to.
1489 * @param *memop The store needed to model exceptions
1490 * @param *op1 The first operand.
1491 * @param *op2 The second operand.
1492 * @param *mode The mode of the result.
1494 ir_node *new_rd_Mod (dbg_info *db, ir_graph *irg, ir_node *block,
1495 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
1497 /** Constructor for a Abs node.
1499 * @param *db A pointer for debug information.
1500 * @param *irg The ir graph the node belongs to.
1501 * @param *block The ir block the node belongs to.
1502 * @param *op The operand
1503 * @param *mode The mode of the operands and the result.
1505 ir_node *new_rd_Abs (dbg_info *db, ir_graph *irg, ir_node *block,
1506 ir_node *op, ir_mode *mode);
1508 /** Constructor for a And node.
1510 * @param *db A pointer for debug information.
1511 * @param *irg The ir graph the node belongs to.
1512 * @param *block The ir block the node belongs to.
1513 * @param *op1 The first operand.
1514 * @param *op2 The second operand.
1515 * @param *mode The mode of the operands and the result.
1517 ir_node *new_rd_And (dbg_info *db, ir_graph *irg, ir_node *block,
1518 ir_node *op1, ir_node *op2, ir_mode *mode);
1520 /** Constructor for a Or node.
1522 * @param *db A pointer for debug information.
1523 * @param *irg The ir graph the node belongs to.
1524 * @param *block The ir block the node belongs to.
1525 * @param *op1 The first operand.
1526 * @param *op2 The second operand.
1527 * @param *mode The mode of the operands and the result.
1529 ir_node *new_rd_Or (dbg_info *db, ir_graph *irg, ir_node *block,
1530 ir_node *op1, ir_node *op2, ir_mode *mode);
1532 /** Constructor for a Eor node.
1534 * @param *db A pointer for debug information.
1535 * @param *irg The ir graph the node belongs to.
1536 * @param *block The ir block the node belongs to.
1537 * @param *op1 The first operand.
1538 * @param *op2 The second operand.
1539 * @param *mode The mode of the operands and the results.
1541 ir_node *new_rd_Eor (dbg_info *db, ir_graph *irg, ir_node *block,
1542 ir_node *op1, ir_node *op2, ir_mode *mode);
1544 /** Constructor for a Not node.
1546 * @param *db A pointer for debug information.
1547 * @param *irg The ir graph the node belongs to.
1548 * @param *block The ir block the node belongs to.
1549 * @param *op The operand.
1550 * @param *mode The mode of the operand and the result.
1552 ir_node *new_rd_Not (dbg_info *db, ir_graph *irg, ir_node *block,
1553 ir_node *op, ir_mode *mode);
1555 /** Constructor for a Cmp node.
1557 * @param *db A pointer for debug information.
1558 * @param *irg The ir graph the node belongs to.
1559 * @param *block The ir block the node belongs to.
1560 * @param *op1 The first operand.
1561 * @param *op2 The second operand.
1563 ir_node *new_rd_Cmp (dbg_info *db, ir_graph *irg, ir_node *block,
1564 ir_node *op1, ir_node *op2);
1566 /** Constructor for a Shl 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 *k The number of bits to shift the operand .
1573 * @param *mode The mode of the operand and the result.
1575 ir_node *new_rd_Shl (dbg_info *db, ir_graph *irg, ir_node *block,
1576 ir_node *op, ir_node *k, ir_mode *mode);
1578 /** Constructor for a Shr node.
1580 * @param *db A pointer for debug information.
1581 * @param *irg The ir graph the node belongs to.
1582 * @param *block The ir block the node belongs to.
1583 * @param *op The operand.
1584 * @param *k The number of bits to shift the operand .
1585 * @param *mode The mode of the operand and the result.
1587 ir_node *new_rd_Shr (dbg_info *db, ir_graph *irg, ir_node *block,
1588 ir_node *op, ir_node *k, ir_mode *mode);
1590 /** Constructor for a Shrs node.
1592 * @param *db A pointer for debug information.
1593 * @param *irg The ir graph the node belongs to.
1594 * @param *block The ir block the node belongs to.
1595 * @param *op The operand.
1596 * @param *k The number of bits to shift the operand.
1597 * @param *mode The mode of the operand and the result.
1599 ir_node *new_rd_Shrs (dbg_info *db, ir_graph *irg, ir_node *block,
1600 ir_node *op, ir_node *k, ir_mode *mode);
1602 /** Constructor for a Rot node.
1604 * @param *db A pointer for debug information.
1605 * @param *irg The ir graph the node belongs to.
1606 * @param *block The ir block the node belongs to.
1607 * @param *op The operand.
1608 * @param *k The number of bits to rotate the operand.
1609 * @param *mode The mode of the operand.
1611 ir_node *new_rd_Rot (dbg_info *db, ir_graph *irg, ir_node *block,
1612 ir_node *op, ir_node *k, ir_mode *mode);
1615 /** Constructor for a Conv node.
1617 * @param *db A pointer for debug information.
1618 * @param *irg The ir graph the node belongs to.
1619 * @param *block The ir block the node belongs to.
1620 * @param *op The operand.
1621 * @param *mode The mode of this the operand muss be converted .
1623 ir_node *new_rd_Conv (dbg_info *db, ir_graph *irg, ir_node *block,
1624 ir_node *op, ir_mode *mode);
1626 /** Constructor for a Cast node.
1628 * High level type cast.
1630 * @param *db A pointer for debug information.
1631 * @param *irg The ir graph the node belongs to.
1632 * @param *block The ir block the node belongs to.
1633 * @param *op The operand.
1634 * @param *to_tp The type of this the operand muss be casted .
1636 ir_node *new_rd_Cast (dbg_info *db, ir_graph *irg, ir_node *block,
1637 ir_node *op, ir_type *to_tp);
1639 /** Constructor for a Carry node.
1641 * @param *db A pointer for debug information.
1642 * @param *irg The ir graph the node belongs to.
1643 * @param *block The ir block the node belongs to.
1644 * @param *op1 The first operand.
1645 * @param *op2 The second operand.
1646 * @param *mode The mode of the operands and the result.
1648 ir_node *new_rd_Carry (dbg_info *db, ir_graph *irg, ir_node *block,
1649 ir_node *op1, ir_node *op2, ir_mode *mode);
1651 /** Constructor for a Borrow node.
1653 * @param *db A pointer for debug information.
1654 * @param *irg The ir graph the node belongs to.
1655 * @param *block The ir block the node belongs to.
1656 * @param *op1 The first operand.
1657 * @param *op2 The second operand.
1658 * @param *mode The mode of the operands and the result.
1660 ir_node *new_rd_Borrow (dbg_info *db, ir_graph *irg, ir_node *block,
1661 ir_node *op1, ir_node *op2, ir_mode *mode);
1663 /** Constructor for a Phi node.
1665 * @param *db A pointer for debug information.
1666 * @param *irg The ir graph the node belongs to.
1667 * @param *block The ir block the node belongs to.
1668 * @param arity The number of predecessors
1669 * @param *in[] Array with predecessors. The constructor copies this array.
1670 * @param *mode The mode of it's inputs and output.
1672 ir_node *new_rd_Phi (dbg_info *db, ir_graph *irg, ir_node *block, int arity,
1673 ir_node *in[], ir_mode *mode);
1675 /** Constructor for a Load node.
1677 * @param *db A pointer for debug information.
1678 * @param *irg The ir graph the node belongs to.
1679 * @param *block The ir block the node belongs to.
1680 * @param *store The current memory
1681 * @param *adr A pointer to the variable to be read in this memory.
1682 * @param *mode The mode of the value to be loaded.
1684 ir_node *new_rd_Load (dbg_info *db, ir_graph *irg, ir_node *block,
1685 ir_node *store, ir_node *adr, ir_mode *mode);
1687 /** Constructor for a Store node.
1689 * @param *db A pointer for debug information.
1690 * @param *irg The ir graph the node belongs to.
1691 * @param *block The ir block the node belongs to.
1692 * @param *store The current memory
1693 * @param *adr A pointer to the variable to be read in this memory.
1694 * @param *val The value to write to this variable.
1696 ir_node *new_rd_Store (dbg_info *db, ir_graph *irg, ir_node *block,
1697 ir_node *store, ir_node *adr, ir_node *val);
1699 /** Constructor for a Alloc node.
1701 * The Alloc node extends the memory by space for an entity of type alloc_type.
1703 * @param *db A pointer for debug information.
1704 * @param *irg The ir graph the node belongs to.
1705 * @param *block The ir block the node belongs to.
1706 * @param *store The memory which shall contain the new variable.
1707 * @param *size The number of bytes to allocate.
1708 * @param *alloc_type The type of the allocated variable.
1709 * @param where Where to allocate the variable, either heap_alloc or stack_alloc.
1711 ir_node *new_rd_Alloc (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1712 ir_node *size, ir_type *alloc_type, where_alloc where);
1714 /** Constructor for a Free node.
1716 * Frees the memory occupied by the entity pointed to by the pointer
1717 * arg. Type indicates the type of the entity the argument points to.
1719 * @param *db A pointer for debug information.
1720 * @param *irg The ir graph the node belongs to.
1721 * @param *block The ir block the node belongs to.
1722 * @param *store The memory which shall contain the new variable.
1723 * @param *ptr The pointer to the object to free.
1724 * @param *size The number of objects of type free_type to free in a sequence.
1725 * @param *free_type The type of the freed variable.
1726 * @param where Where the variable was allocated, either heap_alloc or stack_alloc.
1728 ir_node *new_rd_Free (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1729 ir_node *ptr, ir_node *size, ir_type *free_type, where_alloc where);
1731 /** Constructor for a Sync node.
1733 * Merges several memory values. The node assumes that a variable
1734 * either occurs only in one of the memories, or it contains the same
1735 * value in all memories where it occurs.
1737 * @param *db A pointer for debug information.
1738 * @param *irg The ir graph the node belongs to.
1739 * @param *block The ir block the node belongs to.
1740 * @param arity The number of memories to synchronize.
1741 * @param *in[] An array of pointers to nodes that produce an output of type
1742 * memory. The constructor copies this array.
1744 ir_node *new_rd_Sync (dbg_info *db, ir_graph *irg, ir_node *block, int arity, ir_node *in[]);
1746 /** Constructor for a Proj node.
1748 * Projects a single value out of a tuple. The parameter proj gives the
1749 * position of the value within the tuple.
1751 * @param *db A pointer for debug information.
1752 * @param *irg The ir graph the node belongs to.
1753 * @param *block The ir block the node belongs to.
1754 * @param arg A node producing a tuple. The node must have mode_T.
1755 * @param *mode The mode of the value to project.
1756 * @param proj The position of the value in the tuple.
1758 ir_node *new_rd_Proj (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *arg,
1759 ir_mode *mode, long proj);
1761 /** Constructor for a defaultProj node.
1763 * Represents the default control flow of a Switch-Cond node.
1765 * @param *db A pointer for debug information.
1766 * @param *irg The ir graph the node belongs to.
1767 * @param *block The ir block the node belongs to.
1768 * @param arg A node producing a tuple.
1769 * @param max_proj The end position of the value in the tuple.
1771 ir_node *new_rd_defaultProj (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *arg,
1774 /** Constructor for a Tuple node.
1776 * This is an auxiliary node to replace a node that returns a tuple
1777 * without changing the corresponding Proj nodes.
1779 * @param *db A pointer for debug information.
1780 * @param *irg The ir graph the node belongs to.
1781 * @param *block The ir block the node belongs to.
1782 * @param arity The number of tuple elements.
1783 * @param *in[] An array containing pointers to the nodes producing the tuple
1784 * elements. The constructor copies this array.
1786 ir_node *new_rd_Tuple (dbg_info *db, ir_graph *irg, ir_node *block,
1787 int arity, ir_node *in[]);
1789 /** Constructor for a Id node.
1791 * This is an auxiliary node to replace a node that returns a single
1794 * @param *db A pointer for debug information.
1795 * @param *irg The ir graph the node belongs to.
1796 * @param *block The ir block the node belongs to.
1797 * @param *val The value
1798 * @param *mode The mode of *val.
1800 ir_node *new_rd_Id (dbg_info *db, ir_graph *irg, ir_node *block,
1801 ir_node *val, ir_mode *mode);
1803 /** Constructor for a Bad node.
1805 * Returns the unique Bad node of the graph. The same as
1808 * @param *irg The ir graph the node belongs to.
1810 ir_node *new_rd_Bad (ir_graph *irg);
1812 /** Constructor for a Confirm node.
1814 * Specifies constraints for a value. To support dataflow analyses.
1816 * Example: If the value never exceeds '100' this is expressed by placing a
1817 * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge.
1819 * @param *irg The ir graph the node belong to.
1820 * @param *block The ir block the node belong to.
1821 * @param *db A pointer for debug information.
1822 * @param *val The value we express a constraint for
1823 * @param *bound The value to compare against. Must be a firm node, typically a constant.
1824 * @param cmp The compare operation.
1826 ir_node *new_rd_Confirm (dbg_info *db, ir_graph *irg, ir_node *block,
1827 ir_node *val, ir_node *bound, pn_Cmp cmp);
1829 /** Constructor for an Unknown node.
1831 * Represents an arbitrary value. Places the node in the start block.
1833 * @param *irg The ir graph the node belongs to.
1834 * @param *m The mode of the unknown value.
1836 ir_node *new_rd_Unknown(ir_graph *irg, ir_mode *m);
1838 /** Constructor for a CallBegin node.
1840 * CallBegin represents control flow depending of the pointer value
1841 * representing the called method to the called methods. The
1842 * constructor copies the method pointer input from the passed Call
1845 * @param *db A pointer for debug information.
1846 * @param *irg The ir graph the node belong to.
1847 * @param *block The block the node belong to.
1848 * @param *callee The call node visible in the intra procedural view.
1850 ir_node *new_rd_CallBegin(dbg_info *db, ir_graph *irg, ir_node *block, ir_node *callee);
1852 /** Constructor for a EndReg node.
1854 * Used to represent regular procedure end in interprocedual view.
1856 * @param *db A pointer for debug information.
1857 * @param *irg The ir graph the node belong to.
1858 * @param *block The block the node belong to.
1860 ir_node *new_rd_EndReg (dbg_info *db, ir_graph *irg, ir_node *block);
1862 /** Constructor for a EndExcept node.
1864 * Used to represent exceptional procedure end in interprocedural view.
1866 * @param *db A pointer for debug information.
1867 * @param *irg The ir graph the node belong to.
1868 * @param *block The block the node belong to.
1870 ir_node *new_rd_EndExcept(dbg_info *db, ir_graph *irg, ir_node *block);
1872 /** Constructor for a Filter node.
1874 * Adds the node to the block in current_ir_block. Filter is a node
1875 * with two views used to construct the interprocedural view. In
1876 * intraprocedural view its semantics are identical to the Proj node.
1877 * In interprocedural view the Filter performs the Phi operation on
1878 * method parameters or results. Other than a Phi a Filter node may
1879 * not be removed if it has only a single input.
1881 * The constructor builds the Filter in intraprocedural view.
1883 * @param *db A pointer for debug information.
1884 * @param *irg The ir graph the node belong to.
1885 * @param *block The block the node belong to.
1886 * @param *arg The tuple value to project from.
1887 * @param *mode The mode of the projected value.
1888 * @param proj The position in the tuple to project from.
1890 ir_node *new_rd_Filter (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *arg,
1891 ir_mode *mode, long proj);
1893 /** Constructor for a NoMem node.
1895 * Returns the unique NoMem node of the graph. The same as
1898 * @param *irg The ir graph the node belongs to.
1900 ir_node *new_rd_NoMem (ir_graph *irg);
1902 /** Constructor for a Mux node.
1904 * @param *db A pointer for debug information.
1905 * @param *irg The ir graph the node belong to.
1906 * @param *block The block the node belong to.
1907 * @param *sel The ir_node that calculates the boolean select.
1908 * @param *ir_true The ir_node that calculates the true result.
1909 * @param *ir_false The ir_node that calculates the false result.
1910 * @param *mode The mode of the node (and it_true and ir_false).
1912 ir_node *new_rd_Mux (dbg_info *db, ir_graph *irg, ir_node *block,
1913 ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
1915 /** Constructor for a Psi node.
1917 * @param *db A pointer for debug information.
1918 * @param *irg The ir graph the node belong to.
1919 * @param *block The block the node belong to.
1920 * @param *arity The arity of the conditions
1921 * @param *conds The array of mode_b conditions, length must be equal arity
1922 * @param *vals The array of mode values, length must be equal arity + 1
1923 * @param *mode The mode of the node (must be the mode of all vals).
1925 ir_node *new_rd_Psi (dbg_info *db, ir_graph *irg, ir_node *block,
1926 int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode);
1928 /** Constructor for a CopyB node.
1930 * @param *db A pointer for debug information.
1931 * @param *irg The ir graph the node belong to.
1932 * @param *block The block the node belong to.
1933 * @param *store The current memory
1934 * @param *dst The ir_node that represents the destination address.
1935 * @param *src The ir_node that represents the source address.
1936 * @param *data_type The type of the copied data
1938 ir_node *new_rd_CopyB(dbg_info *db, ir_graph *irg, ir_node *block,
1939 ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
1941 /** Constructor for a InstOf node.
1943 * A High-Level Type check.
1945 * @param *db A pointer for debug information.
1946 * @param *irg The ir graph the node belongs to.
1947 * @param *block The ir block the node belongs to.
1948 * @param *store The memory in which the object the entity should be selected
1949 * from is allocated.
1950 * @param *objptr A pointer to a object of a class type.
1951 * @param *type The type of which objptr must be.
1953 ir_node *new_rd_InstOf (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1954 ir_node *objptr, ir_type *type);
1956 /** Constructor for a Raise node.
1958 * A High-Level Exception throw.
1960 * @param *db A pointer for debug information.
1961 * @param *irg The ir graph the node belongs to.
1962 * @param *block The ir block the node belongs to.
1963 * @param *store The current memory.
1964 * @param *obj A pointer to the Except variable.
1966 ir_node *new_rd_Raise (dbg_info *db, ir_graph *irg, ir_node *block,
1967 ir_node *store, ir_node *obj);
1969 /** Constructor for a Bound node.
1971 * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
1973 * @param *db A pointer for debug information.
1974 * @param *irg The ir graph the node belong to.
1975 * @param *block The block the node belong to.
1976 * @param *store The current memory.
1977 * @param *idx The ir_node that represents an index.
1978 * @param *lower The ir_node that represents the lower bound for the index.
1979 * @param *upper The ir_node that represents the upper bound for the index.
1981 ir_node *new_rd_Bound(dbg_info *db, ir_graph *irg, ir_node *block,
1982 ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
1984 /** Constructor for a Pin node.
1986 * @param *db A pointer for debug information.
1987 * @param *irg The ir graph the node belong to.
1988 * @param *block The block the node belong to.
1989 * @param *node The node which value should be pinned.
1991 ir_node *new_rd_Pin(dbg_info *db, ir_graph *irg, ir_node *block, ir_node *node);
1993 /** Constructor for an ASM pseudo node.
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 arity The number of data inputs to the node.
1999 * @param *in The array of length arity of data inputs.
2000 * @param *inputs The array of length arity of input constraints.
2001 * @param n_outs The number of data outputs to the node.
2002 * @param *outputs The array of length n_outs of output constraints.
2003 * @param n_clobber The number of clobbered registers.
2004 * @param *clobber The array of length n_clobber of clobbered registers.
2005 * @param *asm_text The assembler text.
2007 ir_node *new_rd_ASM(dbg_info *db, ir_graph *irg, ir_node *block,
2008 int arity, ir_node *in[], ir_asm_constraint *inputs,
2009 int n_outs, ir_asm_constraint *outputs,
2010 int n_clobber, ident *clobber[], ident *asm_text);
2012 /*-------------------------------------------------------------------------*/
2013 /* The raw interface without debug support */
2014 /*-------------------------------------------------------------------------*/
2016 /** Constructor for a Block node.
2018 * Constructs a mature block with the given predecessors. Use Unknown
2019 * nodes as predecessors to construct a block if the number of
2020 * predecessors is known, but not the predecessors themselves. This
2021 * constructor does not set current_block. It not be used with
2022 * automatic Phi node construction.
2025 * @param irg The ir graph the block belongs to.
2026 * @param arity The number of control predecessors.
2027 * @param in[] An array of control predecessors. The length of
2028 * the array must be 'arity'. The constructor copies this array.
2030 ir_node *new_r_Block (ir_graph *irg, int arity, ir_node *in[]);
2032 /** Constructor for a Start node.
2034 * @param *irg The ir graph the node belongs to.
2035 * @param *block The ir block the node belongs to.
2037 ir_node *new_r_Start (ir_graph *irg, ir_node *block);
2039 /** Constructor for a End node.
2041 * @param *irg The ir graph the node belongs to.
2042 * @param *block The ir block the node belongs to.
2044 ir_node *new_r_End (ir_graph *irg, ir_node *block);
2046 /** Constructor for a Jmp node.
2048 * Jmp represents control flow to a single control successor.
2050 * @param *irg The ir graph the node belongs to.
2051 * @param *block The ir block the node belongs to.
2053 ir_node *new_r_Jmp (ir_graph *irg, ir_node *block);
2055 /** Constructor for an IJmp node.
2057 * IJmp represents control flow to a single control successor not
2058 * statically known i.e. an indirect Jmp.
2060 * @param *irg The ir graph the node belongs to.
2061 * @param *block The ir block the node belongs to.
2062 * @param *tgt The ir node representing the target address.
2064 ir_node *new_r_IJmp (ir_graph *irg, ir_node *block, ir_node *tgt);
2066 /** Constructor for a Cond node.
2068 * If c is mode_b represents a conditional branch (if/else). If c is
2069 * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond
2070 * node, default Proj is 0.)
2072 * This is not consistent: Input to Cond is Is, Proj has as proj number
2075 * @param *irg The ir graph the node belongs to.
2076 * @param *block The ir block the node belongs to.
2077 * @param *c The conditions parameter.Can be of mode b or I_u.
2079 ir_node *new_r_Cond (ir_graph *irg, ir_node *block, ir_node *c);
2081 /** Constructor for a Return node.
2083 * Returns the memory an zero or more return values. Only node that
2084 * can end regular control flow.
2086 * @param *irg The ir graph the node belongs to.
2087 * @param *block The ir block the node belongs to.
2088 * @param *store The state of memory.
2089 * @param arity Number of array indices.
2090 * @param *in[] Array with index inputs to the node. The constructor copies this array.
2092 ir_node *new_r_Return (ir_graph *irg, ir_node *block,
2093 ir_node *store, int arity, ir_node *in[]);
2095 /** Constructor for a Const node.
2097 * Constructor for a Const node. The constant represents a target
2098 * value. Sets the type information to type_unknown. (No more
2099 * supported: If tv is entity derives a somehow useful type.)
2101 * @param *irg The ir graph the node belongs to.
2102 * @param *block The ir block the node belongs to.
2103 * @param *mode The mode of the operands and the results.
2104 * @param *con Points to an entry in the constant table.
2106 ir_node *new_r_Const (ir_graph *irg, ir_node *block,
2107 ir_mode *mode, tarval *con);
2109 /** Constructor for a Const node.
2111 * Constructor for a Const node. The constant represents a target
2112 * value. Sets the type information to type_unknown. (No more
2113 * supported: If tv is entity derives a somehow useful type.)
2115 * @param *irg The ir graph the node belongs to.
2116 * @param *block The ir block the node belongs to.
2117 * @param *mode The mode of the operands and the results.
2118 * @param value A value from which the tarval is made.
2120 ir_node *new_r_Const_long(ir_graph *irg, ir_node *block,
2121 ir_mode *mode, long value);
2123 /** Constructor for a Const_type node.
2125 * The constant represents a target value. This constructor sets high
2126 * level type information for the constant value.
2128 * @param *irg The ir graph the node belongs to.
2129 * @param *block The ir block the node belongs to.
2130 * @param *mode The mode of the operands and results.
2131 * @param *con Points to an entry in the constant table.
2132 * @param *tp The type of the constant.
2134 ir_node *new_r_Const_type(ir_graph *irg, ir_node *block,
2135 ir_mode *mode, tarval *con, ir_type *tp);
2137 /** Constructor for a SymConst node.
2139 * This is the constructor for a symbolic constant.
2140 * There are four kinds of symbolic constants:
2141 * - type_tag The symbolic constant represents a type tag. The type the
2142 * tag stands for is given explicitly.
2143 * - size The symbolic constant represents the size of a type. The
2144 * type of which the constant represents the size is given
2146 * - addr_name The symbolic constant represents the address of an entity
2147 * (variable or method). The variable is indicated by a name
2148 * that is valid for linking.
2149 * - addr_ent The symbolic constant represents the address of an entity
2150 * (variable or method). The variable is given explicitly by
2153 * Inputs to the node:
2154 * No inputs except the block it belongs to.
2155 * Outputs of the node.
2156 * An unsigned integer (I_u) or a pointer (P).
2158 * @param *irg The ir graph the node belongs to.
2159 * @param *block The ir block the node belongs to.
2160 * @param value A type, entity or a ident depending on the SymConst kind.
2161 * @param symkind The kind of the symbolic constant: type_tag, size or link_info.
2163 ir_node *new_r_SymConst (ir_graph *irg, ir_node *block,
2164 union symconst_symbol value, symconst_kind symkind);
2166 /** Constructor for a simpleSel node.
2168 * This is a shortcut for the new_d_Sel() constructor. To be used for
2169 * Sel nodes that do not select from an array, i.e., have no index
2170 * inputs. It adds the two parameters 0, NULL.
2172 * @param *irg The ir graph the node belongs to.
2173 * @param *block The ir block the node belongs to.
2174 * @param *store The memory in which the object the entity should be selected
2175 * from is allocated.
2176 * @param *objptr The object from that the Sel operation selects a
2177 * single attribute out.
2178 * @param *ent The entity to select.
2180 ir_node *new_r_simpleSel(ir_graph *irg, ir_node *block, ir_node *store,
2181 ir_node *objptr, ir_entity *ent);
2183 /** Constructor for a Sel node.
2185 * The select node selects an entity (field or method) from an entity
2186 * with a compound type. It explicitly specifies the entity selected.
2187 * Dynamically the node may select entities that overwrite the given
2188 * entity. If the selected entity is an array element entity the Sel
2189 * node takes the required array indices as inputs.
2191 * @param *irg The ir graph the node belongs to.
2192 * @param *block The ir block the node belongs to.
2193 * @param *store The memory in which the object the entity should be selected
2194 * from is allocated.
2195 * @param *objptr A pointer to a compound entity the Sel operation selects a
2196 * single attribute from.
2197 * @param *n_index The number of array indices needed to select an array element entity.
2198 * @param *index[] If the compound entity is an array the indices of the selected
2199 * element entity. The constructor copies this array.
2200 * @param *ent The entity to select.
2202 ir_node *new_r_Sel (ir_graph *irg, ir_node *block, ir_node *store,
2203 ir_node *objptr, int n_index, ir_node *index[],
2206 /** Constructor for a Call node.
2208 * Represents all kinds of method and function calls.
2210 * @param *irg The ir graph the node belongs to.
2211 * @param *block The ir block the node belongs to.
2212 * @param *store The actual store.
2213 * @param *callee A pointer to the called procedure.
2214 * @param arity The number of procedure parameters.
2215 * @param *in[] An array with the pointers to the parameters. The constructor copies this array.
2216 * @param *tp Type information of the procedure called.
2218 ir_node *new_r_Call (ir_graph *irg, ir_node *block, ir_node *store,
2219 ir_node *callee, int arity, ir_node *in[],
2222 /** Constructor for a Add node.
2224 * @param *irg The ir graph the node belongs to.
2225 * @param *block The ir block the node belongs to.
2226 * @param *op1 The first operand.
2227 * @param *op2 The second operand.
2228 * @param *mode The mode of the operands and the result.
2230 ir_node *new_r_Add (ir_graph *irg, ir_node *block,
2231 ir_node *op1, ir_node *op2, ir_mode *mode);
2234 * Constructor for a Sub node.
2236 * @param *irg The ir graph the node belongs to.
2237 * @param *block The ir block the node belongs to.
2238 * @param *op1 The first operand.
2239 * @param *op2 The second operand.
2240 * @param *mode The mode of the operands and the results.
2242 ir_node *new_r_Sub (ir_graph *irg, ir_node *block,
2243 ir_node *op1, ir_node *op2, ir_mode *mode);
2245 /** Constructor for a Minus node.
2247 * @param *irg The ir graph the node belongs to.
2248 * @param *block The ir block the node belongs to.
2249 * @param *op The operand.
2250 * @param *mode The mode of the operand and the result.
2252 ir_node *new_r_Minus (ir_graph *irg, ir_node *block,
2253 ir_node *op, ir_mode *mode);
2254 /** Constructor for a Mul node.
2256 * @param *irg The ir graph the node belongs to.
2257 * @param *block The ir block the node belongs to.
2258 * @param *op1 The first operand.
2259 * @param *op2 The second operand.
2260 * @param *mode The mode of the operands and the result.
2262 ir_node *new_r_Mul (ir_graph *irg, ir_node *block,
2263 ir_node *op1, ir_node *op2, ir_mode *mode);
2265 /** Constructor for a Quot node.
2267 * @param *irg The ir graph the node belongs to.
2268 * @param *block The ir block the node belongs to.
2269 * @param *memop The store needed to model exceptions
2270 * @param *op1 The first operand.
2271 * @param *op2 The second operand.
2272 * @param *mode The mode of the result.
2274 ir_node *new_r_Quot (ir_graph *irg, ir_node *block,
2275 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
2277 /** Constructor for a DivMod node.
2279 * @param *irg The ir graph the node belongs to.
2280 * @param *block The ir block the node belongs to.
2281 * @param *memop The store needed to model exceptions
2282 * @param *op1 The first operand.
2283 * @param *op2 The second operand.
2284 * @param *mode The mode of the results.
2286 ir_node *new_r_DivMod (ir_graph *irg, ir_node *block,
2287 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
2289 /** Constructor for a Div node.
2291 * @param *irg The ir graph the node belongs to.
2292 * @param *block The ir block the node belongs to.
2293 * @param *memop The store needed to model exceptions
2294 * @param *op1 The first operand.
2295 * @param *op2 The second operand.
2296 * @param *mode The mode of the result.
2298 ir_node *new_r_Div (ir_graph *irg, ir_node *block,
2299 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
2301 /** Constructor for a Mod node.
2303 * @param *irg The ir graph the node belongs to.
2304 * @param *block The ir block the node belongs to.
2305 * @param *memop The store needed to model exceptions
2306 * @param *op1 The first operand.
2307 * @param *op2 The second operand.
2308 * @param *mode The mode of the result.
2310 ir_node *new_r_Mod (ir_graph *irg, ir_node *block,
2311 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
2313 /** Constructor for a Abs node.
2315 * @param *irg The ir graph the node belongs to.
2316 * @param *block The ir block the node belongs to.
2317 * @param *op The operand
2318 * @param *mode The mode of the operands and the result.
2320 ir_node *new_r_Abs (ir_graph *irg, ir_node *block,
2321 ir_node *op, ir_mode *mode);
2323 /** Constructor for a And node.
2325 * @param *irg The ir graph the node belongs to.
2326 * @param *block The ir block the node belongs to.
2327 * @param *op1 The first operand.
2328 * @param *op2 The second operand.
2329 * @param *mode The mode of the operands and the result.
2331 ir_node *new_r_And (ir_graph *irg, ir_node *block,
2332 ir_node *op1, ir_node *op2, ir_mode *mode);
2334 /** Constructor for a Or node.
2336 * @param *irg The ir graph the node belongs to.
2337 * @param *block The ir block the node belongs to.
2338 * @param *op1 The first operand.
2339 * @param *op2 The second operand.
2340 * @param *mode The mode of the operands and the result.
2342 ir_node *new_r_Or (ir_graph *irg, ir_node *block,
2343 ir_node *op1, ir_node *op2, ir_mode *mode);
2345 /** Constructor for a Eor node.
2347 * @param *irg The ir graph the node belongs to.
2348 * @param *block The ir block the node belongs to.
2349 * @param *op1 The first operand.
2350 * @param *op2 The second operand.
2351 * @param *mode The mode of the operands and the results.
2353 ir_node *new_r_Eor (ir_graph *irg, ir_node *block,
2354 ir_node *op1, ir_node *op2, ir_mode *mode);
2356 /** Constructor for a Not node.
2358 * @param *irg The ir graph the node belongs to.
2359 * @param *block The ir block the node belongs to.
2360 * @param *op The operand.
2361 * @param *mode The mode of the operand and the result.
2363 ir_node *new_r_Not (ir_graph *irg, ir_node *block,
2364 ir_node *op, ir_mode *mode);
2366 /** Constructor for a Cmp node.
2368 * @param *irg The ir graph the node belongs to.
2369 * @param *block The ir block the node belongs to.
2370 * @param *op1 The first operand.
2371 * @param *op2 The second operand.
2373 ir_node *new_r_Cmp (ir_graph *irg, ir_node *block,
2374 ir_node *op1, ir_node *op2);
2376 /** Constructor for a Shl node.
2378 * @param *irg The ir graph the node belongs to.
2379 * @param *block The ir block the node belongs to.
2380 * @param *op The operand.
2381 * @param *k The number of bits to shift the operand .
2382 * @param *mode The mode of the operand and the result.
2384 ir_node *new_r_Shl (ir_graph *irg, ir_node *block,
2385 ir_node *op, ir_node *k, ir_mode *mode);
2387 /** Constructor for a Shr node.
2389 * @param *irg The ir graph the node belongs to.
2390 * @param *block The ir block the node belongs to.
2391 * @param *op The operand.
2392 * @param *k The number of bits to shift the operand .
2393 * @param *mode The mode of the operand and the result.
2395 ir_node *new_r_Shr (ir_graph *irg, ir_node *block,
2396 ir_node *op, ir_node *k, ir_mode *mode);
2399 * Constructor for a Shrs node.
2401 * @param *irg The ir graph the node belongs to.
2402 * @param *block The ir block the node belongs to.
2403 * @param *op The operand.
2404 * @param *k The number of bits to shift the operand.
2405 * @param *mode The mode of the operand and the result.
2407 ir_node *new_r_Shrs (ir_graph *irg, ir_node *block,
2408 ir_node *op, ir_node *k, ir_mode *mode);
2410 /** Constructor for a Rot node.
2412 * @param *irg The ir graph the node belongs to.
2413 * @param *block The ir block the node belongs to.
2414 * @param *op The operand.
2415 * @param *k The number of bits to rotate the operand.
2416 * @param *mode The mode of the operand.
2418 ir_node *new_r_Rot (ir_graph *irg, ir_node *block,
2419 ir_node *op, ir_node *k, ir_mode *mode);
2421 /** Constructor for a Conv node.
2423 * @param *irg The ir graph the node belongs to.
2424 * @param *block The ir block the node belongs to.
2425 * @param *op The operand.
2426 * @param *mode The mode of this the operand muss be converted .
2428 ir_node *new_r_Conv (ir_graph *irg, ir_node *block,
2429 ir_node *op, ir_mode *mode);
2431 /** Constructor for a Cast node.
2433 * High level type cast
2435 * @param *irg The ir graph the node belongs to.
2436 * @param *block The ir block the node belongs to.
2437 * @param *op The operand.
2438 * @param *to_tp The type of this the operand muss be casted .
2440 ir_node *new_r_Cast (ir_graph *irg, ir_node *block,
2441 ir_node *op, ir_type *to_tp);
2443 /** Constructor for a Carry node.
2445 * @param *irg The ir graph the node belongs to.
2446 * @param *block The ir block the node belongs to.
2447 * @param *op1 The first operand.
2448 * @param *op2 The second operand.
2449 * @param *mode The mode of the operands and the result.
2451 ir_node *new_r_Carry (ir_graph *irg, ir_node *block,
2452 ir_node *op1, ir_node *op2, ir_mode *mode);
2455 * Constructor for a Borrow node.
2457 * @param *irg The ir graph the node belongs to.
2458 * @param *block The ir block the node belongs to.
2459 * @param *op1 The first operand.
2460 * @param *op2 The second operand.
2461 * @param *mode The mode of the operands and the results.
2463 ir_node *new_r_Borrow (ir_graph *irg, ir_node *block,
2464 ir_node *op1, ir_node *op2, ir_mode *mode);
2466 /** Constructor for a Phi node.
2468 * @param *irg The ir graph the node belongs to.
2469 * @param *block The ir block the node belongs to.
2470 * @param arity The number of predecessors
2471 * @param *in[] Array with predecessors. The constructor copies this array.
2472 * @param *mode The mode of it's inputs and output.
2474 ir_node *new_r_Phi (ir_graph *irg, ir_node *block, int arity,
2475 ir_node *in[], ir_mode *mode);
2477 /** Constructor for a Load node.
2479 * @param *irg The ir graph the node belongs to.
2480 * @param *block The ir block the node belongs to.
2481 * @param *store The current memory
2482 * @param *adr A pointer to the variable to be read in this memory.
2483 * @param *mode The mode of the value to be loaded.
2485 ir_node *new_r_Load (ir_graph *irg, ir_node *block,
2486 ir_node *store, ir_node *adr, ir_mode *mode);
2488 /** Constructor for a Store node.
2490 * @param *irg The ir graph the node belongs to.
2491 * @param *block The ir block the node belongs to.
2492 * @param *store The current memory
2493 * @param *adr A pointer to the variable to be read in this memory.
2494 * @param *val The value to write to this variable.
2496 ir_node *new_r_Store (ir_graph *irg, ir_node *block,
2497 ir_node *store, ir_node *adr, ir_node *val);
2499 /** Constructor for a Alloc node.
2501 * The Alloc node extends the memory by space for an entity of type alloc_type.
2503 * @param *irg The ir graph the node belongs to.
2504 * @param *block The ir block the node belongs to.
2505 * @param *store The memory which shall contain the new variable.
2506 * @param *size The number of bytes to allocate.
2507 * @param *alloc_type The type of the allocated variable.
2508 * @param where Where to allocate the variable, either heap_alloc or stack_alloc.
2510 ir_node *new_r_Alloc (ir_graph *irg, ir_node *block, ir_node *store,
2511 ir_node *size, ir_type *alloc_type, where_alloc where);
2513 /** Constructor for a Free node.
2515 * Frees the memory occupied by the entity pointed to by the pointer
2516 * arg. Type indicates the type of the entity the argument points to.
2518 * @param *irg The ir graph the node belongs to.
2519 * @param *block The ir block the node belongs to.
2520 * @param *store The memory which shall contain the new variable.
2521 * @param *ptr The pointer to the object to free.
2522 * @param *size The number of objects of type free_type to free in a sequence.
2523 * @param *free_type The type of the freed variable.
2524 * @param where Where the variable was allocated, either heap_alloc or stack_alloc.
2526 ir_node *new_r_Free (ir_graph *irg, ir_node *block, ir_node *store,
2527 ir_node *ptr, ir_node *size, ir_type *free_type, where_alloc where);
2529 /** Constructor for a Sync node.
2531 * Merges several memory values. The node assumes that a variable
2532 * either occurs only in one of the memories, or it contains the same
2533 * value in all memories where it occurs.
2535 * @param *irg The ir graph the node belongs to.
2536 * @param *block The ir block the node belongs to.
2537 * @param arity The number of memories to synchronize.
2538 * @param *in[] An array of pointers to nodes that produce an output of type memory.
2539 * The constructor copies this array.
2541 ir_node *new_r_Sync (ir_graph *irg, ir_node *block, int arity, ir_node *in[]);
2543 /** Constructor for a Proj node.
2545 * Projects a single value out of a tuple. The parameter proj gives the
2546 * position of the value within the tuple.
2548 * @param *irg The ir graph the node belongs to.
2549 * @param *block The ir block the node belongs to.
2550 * @param arg A node producing a tuple.
2551 * @param *mode The mode of the value to project.
2552 * @param proj The position of the value in the tuple.
2554 ir_node *new_r_Proj (ir_graph *irg, ir_node *block, ir_node *arg,
2555 ir_mode *mode, long proj);
2557 /** Constructor for a defaultProj node.
2559 * Represents the default control flow of a Switch-Cond node.
2561 * @param *irg The ir graph the node belongs to.
2562 * @param *block The ir block the node belongs to.
2563 * @param arg A node producing a tuple.
2564 * @param max_proj The end position of the value in the tuple.
2566 ir_node *new_r_defaultProj (ir_graph *irg, ir_node *block, ir_node *arg, long max_proj);
2569 /** Constructor for a Tuple node.
2571 * This is an auxiliary node to replace a node that returns a tuple
2572 * without changing the corresponding Proj nodes.
2574 * @param *irg The ir graph the node belongs to.
2575 * @param *block The ir block the node belongs to.
2576 * @param arity The number of tuple elements.
2577 * @param *in[] An array containing pointers to the nodes producing the tuple elements.
2578 * The constructor copies this array.
2580 ir_node *new_r_Tuple (ir_graph *irg, ir_node *block, int arity, ir_node *in[]);
2582 /** Constructor for a Id node.
2584 * This is an auxiliary node to replace a node that returns a single
2587 * @param *irg The ir graph the node belongs to.
2588 * @param *block The ir block the node belongs to.
2589 * @param *val The operand to Id.
2590 * @param *mode The mode of *val.
2592 ir_node *new_r_Id (ir_graph *irg, ir_node *block,
2593 ir_node *val, ir_mode *mode);
2595 /** Constructor for a Bad node.
2597 * Returns the unique Bad node of the graph. The same as
2600 * @param *irg The ir graph the node belongs to.
2603 ir_node *new_r_Bad (ir_graph *irg);
2605 /** Constructor for a Confirm node.
2607 * Specifies constraints for a value. To support dataflow analyses.
2609 * Example: If the value never exceeds '100' this is expressed by placing a
2610 * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge.
2612 * @param *irg The ir graph the node belong to.
2613 * @param *block The ir block the node belong to.
2614 * @param *val The value we express a constraint for
2615 * @param *bound The value to compare against. Must be a firm node, typically a constant.
2616 * @param cmp The compare operation.
2618 ir_node *new_r_Confirm(ir_graph *irg, ir_node *block,
2619 ir_node *val, ir_node *bound, pn_Cmp cmp);
2621 /** Constructor for a Unknown node.
2623 * Represents an arbitrary value. Places the node in
2626 * @param *irg The ir graph the node belongs to.
2627 * @param *m The mode of the unknown value.
2629 ir_node *new_r_Unknown(ir_graph *irg, ir_mode *m);
2631 /** Constructor for a CallBegin node.
2633 * CallBegin represents control flow depending of the pointer value
2634 * representing the called method to the called methods. The
2635 * constructor copies the method pointer input from the passed Call
2638 * @param *irg The ir graph the node belong to.
2639 * @param *block The block the node belong to.
2640 * @param *callee The call node visible in the intra procedural view.
2642 ir_node *new_r_CallBegin(ir_graph *irg, ir_node *block, ir_node *callee);
2644 /** Constructor for a EndReg node.
2646 * Used to represent regular procedure end in interprocedual view.
2648 * @param *irg The ir graph the node belong to.
2649 * @param *block The block the node belong to.
2651 ir_node *new_r_EndReg (ir_graph *irg, ir_node *block);
2653 /** Constructor for a EndExcept node.
2655 * Used to represent exceptional procedure end in interprocedural view.
2657 * @param *irg The ir graph the node belong to.
2658 * @param *block The block the node belong to.
2660 ir_node *new_r_EndExcept(ir_graph *irg, ir_node *block);
2662 /** Constructor for a Break node.
2664 * Break represents control flow to a single control successor just as Jmp.
2665 * The blocks separated by a break may not be concatenated by an optimization.
2666 * It is used for the interprocedural representation where blocks are parted
2667 * behind Call nodes to represent the control flow to called procedures.
2669 * @param *irg The ir graph the node belong to.
2670 * @param *block The block the node belong to.
2672 ir_node *new_r_Break (ir_graph *irg, ir_node *block);
2674 /** Constructor for a Filter node.
2676 * Constructor for a Filter node. Adds the node to the block in current_ir_block.
2677 * Filter is a node with two views used to construct the interprocedural view.
2678 * In intraprocedural view its semantics are identical to the Proj node.
2679 * In interprocedural view the Filter performs the Phi operation on method
2680 * parameters or results. Other than a Phi a Filter node may not be removed
2681 * if it has only a single input.
2683 * The constructor builds the Filter in intraprocedural view.
2685 * @param *irg The ir graph the node belong to.
2686 * @param *block The block the node belong to.
2687 * @param *arg The tuple value to project from.
2688 * @param *mode The mode of the projected value.
2689 * @param proj The position in the tuple to project from.
2691 ir_node *new_r_Filter (ir_graph *irg, ir_node *block, ir_node *arg,
2692 ir_mode *mode, long proj);
2694 /** Constructor for a NoMem node.
2696 * Returns the unique NoMem node of the graph. The same as
2699 * @param *irg The ir graph the node belongs to.
2701 ir_node *new_r_NoMem (ir_graph *irg);
2703 /** Constructor for a Mux node.
2705 * @param *irg The ir graph the node belong to.
2706 * @param *block The block the node belong to.
2707 * @param *sel The ir_node that calculates the boolean select.
2708 * @param *ir_true The ir_node that calculates the true result.
2709 * @param *ir_false The ir_node that calculates the false result.
2710 * @param *mode The mode of the node (and it_true and ir_false).
2712 ir_node *new_r_Mux (ir_graph *irg, ir_node *block,
2713 ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
2715 /** Constructor for a Psi node.
2717 * @param *irg The ir graph the node belong to.
2718 * @param *block The block the node belong to.
2719 * @param *arity The arity of the conditions
2720 * @param *conds The array of mode_b conditions, length must be equal arity
2721 * @param *vals The array of mode values, length must be equal arity + 1
2722 * @param *mode The mode of the node (must be the mode of all vals).
2724 ir_node *new_r_Psi (ir_graph *irg, ir_node *block,
2725 int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode);
2727 /** Constructor for a CopyB node.
2729 * @param *irg The ir graph the node belong to.
2730 * @param *block The block the node belong to.
2731 * @param *store The current memory
2732 * @param *dst The ir_node that represents the destination address.
2733 * @param *src The ir_node that represents the source address.
2734 * @param *data_type The type of the copied data
2736 ir_node *new_r_CopyB(ir_graph *irg, ir_node *block,
2737 ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
2739 /** Constructor for a InstOf node.
2741 * A High-Level Type check.
2743 * @param *irg The ir graph the node belongs to.
2744 * @param *block The ir block the node belongs to.
2745 * @param *store The memory in which the object the entity should be selected
2746 * from is allocated.
2747 * @param *objptr A pointer to a object of a class type.
2748 * @param *type The type of which objptr must be.
2750 ir_node *new_r_InstOf(ir_graph *irg, ir_node *block, ir_node *store,
2751 ir_node *objptr, ir_type *type);
2753 /** Constructor for a Raise node.
2755 * A High-Level Exception throw.
2757 * @param *irg The ir graph the node belongs to.
2758 * @param *block The ir block the node belongs to.
2759 * @param *store The current memory.
2760 * @param *obj A pointer to the Except variable.
2762 ir_node *new_r_Raise(ir_graph *irg, ir_node *block,
2763 ir_node *store, ir_node *obj);
2765 /** Constructor for a Bound node.
2767 * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
2769 * @param *irg The ir graph the node belong to.
2770 * @param *block The block the node belong to.
2771 * @param *store The current memory.
2772 * @param *idx The ir_node that represents an index.
2773 * @param *lower The ir_node that represents the lower bound for the index.
2774 * @param *upper The ir_node that represents the upper bound for the index.
2776 ir_node *new_r_Bound(ir_graph *irg, ir_node *block,
2777 ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
2779 /** Constructor for a Pin node.
2781 * @param *irg The ir graph the node belong to.
2782 * @param *block The block the node belong to.
2783 * @param *node The node which value should be pinned.
2785 ir_node *new_r_Pin(ir_graph *irg, ir_node *block, ir_node *node);
2787 /** Constructor for an ASM pseudo node.
2789 * @param *irg The ir graph the node belong to.
2790 * @param *block The block the node belong to.
2791 * @param arity The number of data inputs to the node.
2792 * @param *in The array of length arity of data inputs.
2793 * @param *inputs The array of length arity of input constraints.
2794 * @param n_outs The number of data outputs to the node.
2795 * @param *outputs The array of length n_outs of output constraints.
2796 * @param n_clobber The number of clobbered registers.
2797 * @param *clobber The array of length n_clobber of clobbered registers.
2798 * @param *asm_text The assembler text.
2800 ir_node *new_r_ASM(ir_graph *irg, ir_node *block,
2801 int arity, ir_node *in[], ir_asm_constraint *inputs,
2802 int n_outs, ir_asm_constraint *outputs,
2803 int n_clobber, ident *clobber[], ident *asm_text);
2805 /*-----------------------------------------------------------------------*/
2806 /* The block oriented interface */
2807 /*-----------------------------------------------------------------------*/
2809 /** Sets the current block in which the following constructors place the
2810 * nodes they construct.
2812 * @param target The new current block.
2814 void set_cur_block (ir_node *target);
2816 /** Returns the current block of the current graph. */
2817 ir_node *get_cur_block(void);
2819 /** Returns the fixed nodes of the current graph. */
2820 #define get_cur_end_block() get_irg_end_block(current_ir_graph)
2821 #define get_cur_end() get_irg_end(current_ir_graph)
2822 #define get_cur_start_block() get_irg_start_block(current_ir_graph)
2823 #define get_cur_start() get_irg_start(current_ir_graph)
2825 /** Constructor for a Block node.
2827 * Adds the block to the graph in current_ir_graph. Constructs a Block
2828 * with a fixed number of predecessors. Does set current_block. Can
2829 * be used with automatic Phi node construction.
2831 * @param *db A Pointer for debug information.
2832 * @param arity The number of control predecessors.
2833 * @param in[] An array of control predecessors. The length of
2834 * the array must be 'arity'.
2836 ir_node *new_d_Block(dbg_info *db, int arity, ir_node *in[]);
2838 /** Constructor for a Start node.
2840 * Adds the node to the block in current_ir_block.
2842 * @param *db A pointer for debug information.
2844 ir_node *new_d_Start (dbg_info *db);
2846 /** Constructor for a End node.
2848 * Adds the node to the block in current_ir_block.
2850 * @param *db A pointer for debug information.
2852 ir_node *new_d_End (dbg_info *db);
2854 /** Constructor for a Jmp node.
2856 * Adds the node to the block in current_ir_block.
2858 * Jmp represents control flow to a single control successor.
2860 * @param *db A pointer for debug information.
2862 ir_node *new_d_Jmp (dbg_info *db);
2864 /** Constructor for an IJmp node.
2866 * IJmp represents control flow to a single control successor not
2867 * statically known i.e. an indirect Jmp.
2869 * @param *db A pointer for debug information.
2870 * @param *tgt The ir node representing the target address.
2872 ir_node *new_d_IJmp (dbg_info *db, ir_node *tgt);
2874 /** Constructor for a Cond node.
2876 * Adds the node to the block in current_ir_block.
2878 * If c is mode_b represents a conditional branch (if/else). If c is
2879 * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond
2880 * node, default Proj is 0.)
2882 * This is not consistent: Input to Cond is Is, Proj has as proj number
2885 * @param *db A pointer for debug information.
2886 * @param *c The conditions parameter.Can be of mode b or I_u.
2888 ir_node *new_d_Cond (dbg_info *db, ir_node *c);
2890 /** Constructor for a Return node.
2892 * Adds the node to the block in current_ir_block.
2894 * Returns the memory an zero or more return values. Only node that
2895 * can end regular control flow.
2897 * @param *db A pointer for debug information.
2898 * @param *store The state of memory.
2899 * @param arity Number of array indices.
2900 * @param *in Array with index inputs to the node.
2902 ir_node *new_d_Return (dbg_info *db, ir_node *store, int arity, ir_node *in[]);
2904 /** Constructor for a Const_type node.
2906 * Adds the node to the block in current_ir_block.
2908 * The constant represents a target value. This constructor sets high
2909 * level type information for the constant value.
2911 * @param *db A pointer for debug information.
2912 * @param *mode The mode of the operands and results.
2913 * @param *con Points to an entry in the constant table. This pointer is
2914 added to the attributes of the node.
2915 * @param *tp The type of the constant.
2917 ir_node *new_d_Const_type (dbg_info *db, ir_mode *mode, tarval *con, ir_type *tp);
2919 /** Constructor for a Const node.
2921 * Adds the node to the block in current_ir_block.
2923 * Constructor for a Const node. The constant represents a target
2924 * value. Sets the type information to type_unknown. (No more
2925 * supported: If tv is entity derives a somehow useful type.)
2927 * @param *db A pointer for debug information.
2928 * @param *mode The mode of the operands and results.
2929 * @param *con Points to an entry in the constant table. This pointer is added
2930 * to the attributes of the node.
2932 ir_node *new_d_Const (dbg_info *db, ir_mode *mode, tarval *con);
2934 /** Constructor for a SymConst_type node.
2936 * Adds the node to the block in current_ir_block.
2937 * This is the constructor for a symbolic constant.
2938 * There are four kinds of symbolic constants:
2939 * - type_tag The symbolic constant represents a type tag. The type the
2940 * tag stands for is given explicitly.
2941 * - size The symbolic constant represents the size of a type. The
2942 * type of which the constant represents the size is given
2944 * - addr_name The symbolic constant represents the address of an entity
2945 * (variable or method). The variable is indicated by a name
2946 * that is valid for linking.
2947 * - addr_ent The symbolic constant represents the address of an entity
2948 * (variable or method). The variable is given explicitly by
2951 * Inputs to the node:
2952 * No inputs except the block it belongs to.
2953 * Outputs of the node.
2954 * An unsigned integer (I_u) or a pointer (P).
2956 * @param *db A pointer for debug information.
2957 * @param value A type, entity or ident depending on the SymConst kind.
2958 * @param kind The kind of the symbolic constant: symconst_type_tag, symconst_type_size,
2959 * symconst_type_align, symconst_addr_name or symconst_addr_ent.
2960 * @param tp The source type of the constant.
2962 ir_node *new_d_SymConst_type (dbg_info *db, union symconst_symbol value, symconst_kind kind, ir_type *tp);
2964 /** Constructor for a SymConst node.
2966 * Same as new_d_SymConst_type, except that it sets the type to type_unknown. */
2967 ir_node *new_d_SymConst (dbg_info *db, union symconst_symbol value, symconst_kind kind);
2969 /** Constructor for a simpleSel node.
2971 * This is a shortcut for the new_d_Sel() constructor. To be used for
2972 * Sel nodes that do not select from an array, i.e., have no index
2973 * inputs. It adds the two parameters 0, NULL.
2975 * @param *db A pointer for debug information.
2976 * @param *store The memory in which the object the entity should be
2977 * selected from is allocated.
2978 * @param *objptr The object from that the Sel operation selects a
2979 * single attribute out.
2980 * @param *ent The entity to select.
2982 ir_node *new_d_simpleSel(dbg_info *db, ir_node *store, ir_node *objptr, ir_entity *ent);
2984 /** Constructor for a Sel node.
2986 * The select node selects an entity (field or method) from an entity
2987 * with a compound type. It explicitly specifies the entity selected.
2988 * Dynamically the node may select entities that overwrite the given
2989 * entity. If the selected entity is an array element entity the Sel
2990 * node takes the required array indices as inputs.
2991 * Adds the node to the block in current_ir_block.
2993 * @param *db A pointer for debug information.
2994 * @param *store The memory in which the object the entity should be selected
2995 * from is allocated.
2996 * @param *objptr A pointer to a compound entity the Sel operation selects a
2997 * single attribute from.
2998 * @param arity The number of array indices needed to select an array element entity.
2999 * @param *in[] If the compound entity is an array the indices of the selected
3000 * element entity. The constructor copies this array.
3001 * @param *ent The entity to select.
3003 ir_node *new_d_Sel (dbg_info *db, ir_node *store, ir_node *objptr, int arity, ir_node *in[],
3006 /** Constructor for a Call node.
3008 * Represents all kinds of method and function calls.
3009 * Adds the node to the block in current_ir_block.
3011 * @param *db A pointer for debug information.
3012 * @param *store The actual store.
3013 * @param *callee A pointer to the called procedure.
3014 * @param arity The number of procedure parameters.
3015 * @param *in[] An array with the pointers to the parameters. The constructor copies this array.
3016 * @param *tp Type information of the procedure called.
3018 ir_node *new_d_Call (dbg_info *db, ir_node *store, ir_node *callee, int arity, ir_node *in[],
3021 /** Constructor for a Add node.
3023 * Adds the node to the block in current_ir_block.
3025 * @param *db A pointer for debug information.
3026 * @param *op1 The first operand.
3027 * @param *op2 The second operand.
3028 * @param *mode The mode of the operands and the result.
3030 ir_node *new_d_Add (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3032 /** Constructor for a Sub node.
3034 * Adds the node to the block in current_ir_block.
3036 * @param *db A pointer for debug information.
3037 * @param *op1 The first operand.
3038 * @param *op2 The second operand.
3039 * @param *mode The mode of the operands and the result.
3041 ir_node *new_d_Sub (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3043 /** Constructor for a Minus node.
3045 * Adds the node to the block in current_ir_block.
3047 * @param *db A pointer for debug information.
3048 * @param *op The operand .
3049 * @param *mode The mode of the operand and the result.
3051 ir_node *new_d_Minus (dbg_info *db, ir_node *op, ir_mode *mode);
3053 /** Constructor for a Mul node.
3055 * Adds the node to the block in current_ir_block.
3057 * @param *db A pointer for debug information.
3058 * @param *op1 The first operand.
3059 * @param *op2 The second operand.
3060 * @param *mode The mode of the operands and the result.
3062 ir_node *new_d_Mul (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3064 /** Constructor for a Quot node.
3066 * Adds the node to the block in current_ir_block.
3068 * @param *db A pointer for debug information.
3069 * @param *memop The store needed to model exceptions
3070 * @param *op1 The first operand.
3071 * @param *op2 The second operand.
3072 * @param *mode The mode of the result.
3074 ir_node *new_d_Quot (dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
3076 /** Constructor for a DivMod node.
3078 * Adds the node to the block in current_ir_block.
3080 * @param *db A pointer for debug information.
3081 * @param *memop The store needed to model exceptions
3082 * @param *op1 The first operand.
3083 * @param *op2 The second operand.
3084 * @param *mode The mode of the results.
3086 ir_node *new_d_DivMod (dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
3088 /** Constructor for a Div node.
3090 * Adds the node to the block in current_ir_block.
3092 * @param *db A pointer for debug information.
3093 * @param *memop The store needed to model exceptions
3094 * @param *op1 The first operand.
3095 * @param *op2 The second operand.
3096 * @param *mode The mode of the result.
3098 ir_node *new_d_Div (dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
3100 /** Constructor for a Mod node.
3102 * Adds the node to the block in current_ir_block.
3104 * @param *db A pointer for debug information.
3105 * @param *memop The store needed to model exceptions
3106 * @param *op1 The first operand.
3107 * @param *op2 The second operand.
3108 * @param *mode The mode of the result.
3110 ir_node *new_d_Mod (dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
3112 /** Constructor for a Abs node.
3114 * Adds the node to the block in current_ir_block.
3116 * @param *db A pointer for debug information.
3117 * @param *op The operand
3118 * @param *mode The mode of the operands and the result.
3120 ir_node *new_d_Abs (dbg_info *db, ir_node *op, ir_mode *mode);
3122 /** Constructor for a And node.
3124 * Adds the node to the block in current_ir_block.
3126 * @param *db A pointer for debug information.
3127 * @param *op1 The first operand.
3128 * @param *op2 The second operand.
3129 * @param *mode The mode of the operands and the result.
3131 ir_node *new_d_And (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3133 /** Constructor for a Or node.
3135 * Adds the node to the block in current_ir_block.
3137 * @param *db A pointer for debug information.
3138 * @param *op1 The first operand.
3139 * @param *op2 The second operand.
3140 * @param *mode The mode of the operands and the result.
3142 ir_node *new_d_Or (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3144 /** Constructor for a Eor node.
3146 * Adds the node to the block in current_ir_block.
3148 * @param *db A pointer for debug information.
3149 * @param *op1 The first operand.
3150 * @param *op2 The second operand.
3151 * @param *mode The mode of the operands and the results.
3153 ir_node *new_d_Eor (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3155 /** Constructor for a Not node.
3157 * Adds the node to the block in current_ir_block.
3159 * @param *db A pointer for debug information.
3160 * @param *op The operand.
3161 * @param *mode The mode of the operand and the result.
3163 ir_node *new_d_Not (dbg_info *db, ir_node *op, ir_mode *mode);
3165 /** Constructor for a Shl 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 *k The number of bits to shift the operand .
3172 * @param *mode The mode of the operand and the result.
3174 ir_node *new_d_Shl (dbg_info *db, ir_node *op, ir_node *k, ir_mode *mode);
3176 /** Constructor for a Shr node.
3178 * Adds the node to the block in current_ir_block.
3180 * @param *db A pointer for debug information.
3181 * @param *op The operand.
3182 * @param *k The number of bits to shift the operand .
3183 * @param *mode The mode of the operand and the result.
3185 ir_node *new_d_Shr (dbg_info *db, ir_node *op, ir_node *k, ir_mode *mode);
3187 /** Constructor for a Shrs node.
3189 * Adds the node to the block in current_ir_block.
3191 * @param *db A pointer for debug information.
3192 * @param *op The operand.
3193 * @param *k The number of bits to shift the operand .
3194 * @param *mode The mode of the operand and the result.
3196 ir_node *new_d_Shrs (dbg_info *db, ir_node *op, ir_node *k, ir_mode *mode);
3198 /** Constructor for a Rot node.
3200 * Adds the node to the block in current_ir_block.
3202 * @param *db A pointer for debug information.
3203 * @param *op The operand.
3204 * @param *k The number of bits to rotate the operand.
3205 * @param *mode The mode of the operand.
3207 ir_node *new_d_Rot (dbg_info *db, ir_node *op, ir_node *k, ir_mode *mode);
3209 /** Constructor for a Cmp node.
3211 * Adds the node to the block in current_ir_block.
3213 * @param *db A pointer for debug information.
3214 * @param *op1 The first operand.
3215 * @param *op2 The second operand.
3217 ir_node *new_d_Cmp (dbg_info *db, ir_node *op1, ir_node *op2);
3219 /** Constructor for a Conv node.
3221 * Adds the node to the block in current_ir_block.
3223 * @param *db A pointer for debug information.
3224 * @param *op The operand.
3225 * @param *mode The mode of this the operand muss be converted .
3227 ir_node *new_d_Conv (dbg_info *db, ir_node *op, ir_mode *mode);
3229 /** Constructor for a strict Conv 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 *mode The mode of this the operand muss be converted .
3237 ir_node *new_d_strictConv (dbg_info *db, ir_node *op, ir_mode *mode);
3239 /** Constructor for a Cast node.
3241 * High level type cast
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 *to_tp The type of this the operand muss be casted .
3248 ir_node *new_d_Cast (dbg_info *db, ir_node *op, ir_type *to_tp);
3250 /** Constructor for a Carry node.
3252 * Adds the node to the block in current_ir_block.
3254 * @param *db A pointer for debug information.
3255 * @param *op1 The first operand.
3256 * @param *op2 The second operand.
3257 * @param *mode The mode of the operands and the result.
3259 ir_node *new_d_Carry (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3261 /** Constructor for a Borrow node.
3263 * Adds the node to the block in current_ir_block.
3265 * @param *db A pointer for debug information.
3266 * @param *op1 The first operand.
3267 * @param *op2 The second operand.
3268 * @param *mode The mode of the operands and the result.
3270 ir_node *new_d_Borrow (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3272 /** Constructor for a Phi node.
3274 * Adds the node to the block in current_ir_block.
3276 * @param *db A pointer for debug information.
3277 * @param arity The number of predecessors
3278 * @param *in Array with predecessors
3279 * @param *mode The mode of it's inputs and output.
3281 ir_node *new_d_Phi (dbg_info *db, int arity, ir_node *in[], ir_mode *mode);
3283 /** Constructor for a Load node.
3285 * Adds the node to the block in current_ir_block.
3287 * @param *db A pointer for debug information.
3288 * @param *store The current memory
3289 * @param *addr A pointer to the variable to be read in this memory.
3290 * @param *mode The mode of the value to be loaded.
3292 ir_node *new_d_Load (dbg_info *db, ir_node *store, ir_node *addr, ir_mode *mode);
3294 /** Constructor for a Store node.
3296 * Adds the node to the block in current_ir_block.
3298 * @param *db A pointer for debug information.
3299 * @param *store The current memory
3300 * @param *addr A pointer to the variable to be read in this memory.
3301 * @param *val The value to write to this variable.
3303 ir_node *new_d_Store (dbg_info *db, ir_node *store, ir_node *addr, ir_node *val);
3305 /** Constructor for a Alloc node.
3307 * The Alloc node extends the memory by space for an entity of type alloc_type.
3308 * Adds the node to the block in current_ir_block.
3310 * @param *db A pointer for debug information.
3311 * @param *store The memory which shall contain the new variable.
3312 * @param *size The number of bytes to allocate.
3313 * @param *alloc_type The type of the allocated variable.
3314 * @param where Where to allocate the variable, either heap_alloc or stack_alloc.
3316 ir_node *new_d_Alloc (dbg_info *db, ir_node *store, ir_node *size, ir_type *alloc_type,
3319 /** Constructor for a Free node.
3321 * Frees the memory occupied by the entity pointed to by the pointer
3322 * arg. Type indicates the type of the entity the argument points to.
3323 * Adds the node to the block in current_ir_block.
3325 * @param *db A pointer for debug information.
3326 * @param *store The memory which shall contain the new variable.
3327 * @param *ptr The pointer to the object to free.
3328 * @param *size The number of objects of type free_type to free in a sequence.
3329 * @param *free_type The type of the freed variable.
3330 * @param where Where the variable was allocated, either heap_alloc or stack_alloc.
3332 ir_node *new_d_Free (dbg_info *db, ir_node *store, ir_node *ptr, ir_node *size,
3333 ir_type *free_type, where_alloc where);
3335 /** Constructor for a Sync node.
3337 * Merges several memory values. The node assumes that a variable
3338 * either occurs only in one of the memories, or it contains the same
3339 * value in all memories where it occurs.
3340 * Adds the node to the block in current_ir_block.
3342 * @param *db A pointer for debug information.
3343 * @param arity The number of memories to synchronize.
3344 * @param **in An array of pointers to nodes that produce an output of type
3345 * memory. The constructor copies this array.
3347 ir_node *new_d_Sync (dbg_info *db, int arity, ir_node *in[]);
3349 /** Constructor for a Proj node.
3351 * Projects a single value out of a tuple. The parameter proj gives the
3352 * position of the value within the tuple.
3353 * Adds the node to the block in current_ir_block.
3355 * @param *db A pointer for deubug information.
3356 * @param arg A node producing a tuple.
3357 * @param *mode The mode of the value to project.
3358 * @param proj The position of the value in the tuple.
3360 ir_node *new_d_Proj (dbg_info *db, ir_node *arg, ir_mode *mode, long proj);
3362 /** Constructor for a defaultProj node.
3364 * Represents the default control flow of a Switch-Cond node.
3365 * Adds the node to the block in current_ir_block.
3367 * @param *db A pointer for debug information.
3368 * @param arg A node producing a tuple.
3369 * @param max_proj The end position of the value in the tuple.
3371 ir_node *new_d_defaultProj (dbg_info *db, ir_node *arg, long max_proj);
3373 /** Constructor for a Tuple node.
3375 * This is an auxiliary node to replace a node that returns a tuple
3376 * without changing the corresponding Proj nodes.
3377 * Adds the node to the block in current_ir_block.
3379 * @param *db A pointer for debug information.
3380 * @param arity The number of tuple elements.
3381 * @param **in An array containing pointers to the nodes producing the tuple elements.
3383 ir_node *new_d_Tuple (dbg_info *db, int arity, ir_node *in[]);
3385 /** Constructor for a Id node.
3387 * This is an auxiliary node to replace a node that returns a single
3388 * value. Adds the node to the block in current_ir_block.
3390 * @param *db A pointer for debug information.
3391 * @param *val The operand to Id.
3392 * @param *mode The mode of *val.
3394 ir_node *new_d_Id (dbg_info *db, ir_node *val, ir_mode *mode);
3396 /** Constructor for a Bad node.
3398 * Returns the unique Bad node of the graph. The same as
3401 ir_node *new_d_Bad (void);
3403 /** Constructor for a Confirm node.
3405 * Constructor for a Confirm node. Adds the node to the block in current_ir_block.
3406 * Specifies constraints for a value. To support dataflow analyses.
3408 * Example: If the value never exceeds '100' this is expressed by placing a
3409 * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge.
3411 * @param *db A pointer for debug information.
3412 * @param *val The value we express a constraint for
3413 * @param *bound The value to compare against. Must be a firm node, typically a constant.
3414 * @param cmp The compare operation.
3416 ir_node *new_d_Confirm (dbg_info *db, ir_node *val, ir_node *bound, pn_Cmp cmp);
3418 /** Constructor for an Unknown node.
3420 * Represents an arbitrary value. Places the node in
3423 * @param *m The mode of the unknown value.
3425 ir_node *new_d_Unknown(ir_mode *m);
3427 /** Constructor for a CallBegin node.
3429 * CallBegin represents control flow depending of the pointer value
3430 * representing the called method to the called methods. The
3431 * constructor copies the method pointer input from the passed Call
3432 * node.Adds the node to the block in current_ir_block.
3434 * @param *db A pointer for debug information.
3435 * @param *callee The call node visible in the intra procedural view.
3437 ir_node *new_d_CallBegin(dbg_info *db, ir_node *callee);
3439 /** Constructor for an EndReg node.
3441 *Adds the node to the block in current_ir_block.
3443 * @param *db A pointer for debug information.
3445 ir_node *new_d_EndReg (dbg_info *db);
3447 /** Constructor for an EndExcept node.
3449 * Used to represent regular procedure end in interprocedual view.
3450 * Adds the node to the block in current_ir_block.
3452 * @param *db A pointer for debug information.
3454 ir_node *new_d_EndExcept(dbg_info *db);
3456 /** Constructor for a Break node.
3458 * Used to represent exceptional procedure end in interprocedural view.
3459 * Adds the node to the block in current_ir_block.
3461 * Break represents control flow to a single control successor just as Jmp.
3462 * The blocks separated by a break may not be concatenated by an optimization.
3463 * It is used for the interprocedural representation where blocks are parted
3464 * behind Call nodes to represent the control flow to called procedures.
3466 * @param *db A pointer for debug information.
3468 ir_node *new_d_Break (dbg_info *db);
3470 /** Constructor for a Filter node.
3472 * Constructor for a Filter node. Adds the node to the block in
3473 * current_ir_block. Filter is a node with two views used to
3474 * construct the interprocedural view. In intraprocedural view its
3475 * semantics are identical to the Proj node. In interprocedural view
3476 * the Filter performs the Phi operation on method parameters or
3477 * results. Other than a Phi a Filter node may not be removed if it
3478 * has only a single input.
3480 * The constructor builds the Filter in intraprocedural view.
3482 * @param *db A pointer for debug information.
3483 * @param *arg The tuple value to project from.
3484 * @param *mode The mode of the projected value.
3485 * @param proj The position in the tuple to project from.
3487 ir_node *new_d_Filter (dbg_info *db, ir_node *arg, ir_mode *mode, long proj);
3490 /** Constructor for a NoMem node.
3492 * Returns the unique NoMem node of the graph. The same as
3495 ir_node *new_d_NoMem (void);
3497 /** Constructor for a Mux node.
3499 * @param *db A pointer for debug information.
3500 * @param *sel The ir_node that calculates the boolean select.
3501 * @param *ir_true The ir_node that calculates the true result.
3502 * @param *ir_false The ir_node that calculates the false result.
3503 * @param *mode The mode of the node (and it_true and ir_false).
3505 ir_node *new_d_Mux (dbg_info *db, ir_node *sel,
3506 ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
3508 /** Constructor for a Psi node.
3510 * @param *db A pointer for debug information.
3511 * @param *arity The arity of the conditions
3512 * @param *conds The array of mode_b conditions, length must be equal arity
3513 * @param *vals The array of mode values, length must be equal arity + 1
3514 * @param *mode The mode of the node (must be the mode of all vals).
3516 ir_node *new_d_Psi (dbg_info *db,
3517 int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode);
3519 /** Constructor for a CopyB node.
3521 * @param *db A pointer for debug information.
3522 * @param *store The current memory
3523 * @param *dst The ir_node that represents the destination address.
3524 * @param *src The ir_node that represents the source address.
3525 * @param *data_type The type of the copied data
3527 ir_node *new_d_CopyB(dbg_info *db, ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
3529 /** Constructor for a InstOf node.
3531 * A High-Level Type check.
3533 * @param *db A pointer for debug information.
3534 * @param *store The memory in which the object the entity should be selected
3535 * from is allocated.
3536 * @param *objptr A pointer to a object of a class type.
3537 * @param *type The type of which objptr must be.
3539 ir_node *new_d_InstOf (dbg_info *db, ir_node *store, ir_node *objptr, ir_type *type);
3541 /** Constructor for a Raise node.
3543 * A High-Level Exception throw.
3545 * @param *db A pointer for debug information.
3546 * @param *store The current memory.
3547 * @param *obj A pointer to the Except variable.
3549 ir_node *new_d_Raise (dbg_info *db, ir_node *store, ir_node *obj);
3551 /** Constructor for a Bound node.
3553 * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
3555 * @param *db A pointer for debug information.
3556 * @param *store The current memory
3557 * @param *idx The ir_node that represents an index.
3558 * @param *lower The ir_node that represents the lower bound for the index.
3559 * @param *upper The ir_node that represents the upper bound for the index.
3561 ir_node *new_d_Bound(dbg_info *db, ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
3563 /** Constructor for a Pin node.
3565 * @param *db A pointer for debug information.
3566 * @param *node The node which value should be pinned.
3568 ir_node *new_d_Pin(dbg_info *db, ir_node *node);
3570 /** Constructor for an ASM pseudo node.
3572 * @param *db A pointer for debug information.
3573 * @param arity The number of data inputs to the node.
3574 * @param *in The array of length arity of data inputs.
3575 * @param *inputs The array of length arity of input constraints.
3576 * @param n_outs The number of data outputs to the node.
3577 * @param *outputs The array of length n_outs of output constraints.
3578 * @param n_clobber The number of clobbered registers.
3579 * @param *clobber The array of length n_clobber of clobbered registers.
3580 * @param *asm_text The assembler text.
3582 ir_node *new_d_ASM(dbg_info *db, int arity, ir_node *in[], ir_asm_constraint *inputs,
3583 int n_outs, ir_asm_constraint *outputs,
3584 int n_clobber, ident *clobber[], ident *asm_text);
3586 /*-----------------------------------------------------------------------*/
3587 /* The block oriented interface without debug support */
3588 /*-----------------------------------------------------------------------*/
3590 /* Needed from the interface with debug support:
3591 void set_cur_block (ir_node *target); */
3593 /** Constructor for a Block node.
3595 * Constructor for a Block node. Adds the block to the graph in
3596 * current_ir_graph. Constructs a Block with a fixed number of
3597 * predecessors. Does set current_block. Can be used with automatic
3598 * Phi node construction.
3600 * @param arity The number of control predecessors.
3601 * @param in An array of control predecessors. The length of
3602 * the array must be 'arity'.
3604 ir_node *new_Block(int arity, ir_node *in[]);
3606 /** Constructor for a Start node.
3608 * Adds the node to the block in current_ir_block.
3611 ir_node *new_Start (void);
3613 /** Constructor for an End node.
3615 * Adds the node to the block in current_ir_block.
3617 ir_node *new_End (void);
3619 /** Constructor for an EndReg node.
3621 * Used to represent regular procedure end in interprocedual view.
3622 * Adds the node to the block in current_ir_block.
3624 ir_node *new_EndReg (void);
3626 /** Constructor for an EndExpcept node.
3628 * Used to represent exceptional procedure end in interprocedural view.
3629 * Adds the node to the block in current_ir_block.
3631 ir_node *new_EndExcept(void);
3633 /** Constructor for a Jump node.
3635 * Adds the node to the block in current_ir_block.
3637 * Jmp represents control flow to a single control successor.
3639 ir_node *new_Jmp (void);
3641 /** Constructor for an IJmp node.
3643 * IJmp represents control flow to a single control successor not
3644 * statically known i.e. an indirect Jmp.
3646 * @param *tgt The ir node representing the target address.
3648 ir_node *new_IJmp (ir_node *tgt);
3650 /** Constructor for a Break node.
3651 * Break represents control flow to a single control successor just as Jmp.
3652 * The blocks separated by a break may not be concatenated by an optimization.
3653 * It is used for the interprocedural representation where blocks are parted
3654 * behind Call nodes to represent the control flow to called procedures.
3655 * Adds the node to the block in current_ir_block.
3657 ir_node *new_Break (void);
3659 /** Constructor for a Cond node.
3661 * If c is mode_b represents a conditional branch (if/else). If c is
3662 * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond
3663 * node, default Proj is 0.). Adds the node to the block in current_ir_block.
3665 * This is not consistent: Input to Cond is Is, Proj has as proj number
3669 * @param *c The conditions parameter.Can be of mode b or I_u.
3671 ir_node *new_Cond (ir_node *c);
3673 /** Constructor for a Return node.
3675 * Returns the memory an zero or more return values. Only node that
3676 * can end regular control flow. Adds the node to the block in current_ir_block.
3678 * @param *store The state of memory.
3679 * @param arity Number of array indices.
3680 * @param *in Array with index inputs to the node.
3682 ir_node *new_Return (ir_node *store, int arity, ir_node *in[]);
3684 /** Constructor for a Const node.
3686 * Constructor for a Const node. The constant represents a target
3687 * value. Sets the type information to type_unknown. (No more
3688 * supported: If tv is entity derives a somehow useful type.)
3689 * Adds the node to the block in current_ir_block.
3691 * @param *mode The mode of the operands and results.
3692 * @param *con Points to an entry in the constant table. This pointer is
3693 * added to the attributes of the node.
3695 ir_node *new_Const (ir_mode *mode, tarval *con);
3698 * Make a const from a long.
3699 * This is just convenience for the usual
3701 * new_Const(mode, tarval_from_long(mode, ...))
3704 * @param mode The mode for the const.
3705 * @param value The value of the constant.
3706 * @return A new const node.
3708 ir_node *new_Const_long(ir_mode *mode, long value);
3710 /** Constructor for a Const node.
3712 * Derives mode from passed type. */
3713 ir_node *new_Const_type(tarval *con, ir_type *tp);
3715 /** Constructor for a SymConst node.
3717 * Adds the node to the block in current_ir_block.
3718 * This is the constructor for a symbolic constant.
3719 * There are four kinds of symbolic constants:
3720 * -# type_tag The symbolic constant represents a type tag. The type the
3721 * tag stands for is given explicitly.
3722 * -# size The symbolic constant represents the size of a type. The
3723 * type of which the constant represents the size is given
3725 * -# align The symbolic constant represents the alignment of a type. The
3726 * type of which the constant represents the size is given
3728 * -# addr_name The symbolic constant represents the address of an entity
3729 * (variable or method). The variable is indicated by a name
3730 * that is valid for linking.
3731 * -# addr_ent The symbolic constant represents the address of an entity
3732 * (variable or method). The variable is given explicitly by
3735 * Inputs to the node:
3736 * No inputs except the block it belongs to.
3737 * Outputs of the node.
3738 * An unsigned integer (I_u) or a pointer (P).
3740 * @param value A type or a ident depending on the SymConst kind.
3741 * @param kind The kind of the symbolic constant: symconst_type_tag, symconst_type_size
3742 * symconst_type_align, symconst_addr_name or symconst_addr_ent.
3743 * @param tp The source type of the constant.
3745 ir_node *new_SymConst_type (union symconst_symbol value, symconst_kind kind, ir_type *tp);
3747 /** Constructor for a SymConst node.
3749 * Adds the node to the block in current_ir_block.
3750 * This is the constructor for a symbolic constant.
3751 * There are four kinds of symbolic constants:
3752 * -# type_tag The symbolic constant represents a type tag. The type the
3753 * tag stands for is given explicitly.
3754 * -# size The symbolic constant represents the size of a type. The
3755 * type of which the constant represents the size is given
3757 * -# align The symbolic constant represents the alignment of a type. The
3758 * type of which the constant represents the size is given
3760 * -# addr_name The symbolic constant represents the address of an entity
3761 * (variable or method). The variable is indicated by a name
3762 * that is valid for linking.
3763 * -# addr_ent The symbolic constant represents the address of an entity
3764 * (variable or method). The variable is given explicitly by
3767 * Inputs to the node:
3768 * No inputs except the block it belongs to.
3769 * Outputs of the node.
3770 * An unsigned integer (I_u) or a pointer (P).
3772 * @param value A type or a ident depending on the SymConst kind.
3773 * @param kind The kind of the symbolic constant: symconst_type_tag, symconst_type_size
3774 * symconst_type_align, symconst_addr_name or symconst_addr_ent.
3776 ir_node *new_SymConst (union symconst_symbol value, symconst_kind kind);
3778 /** Constructor for a simpelSel node.
3780 * This is a shortcut for the new_Sel() constructor. To be used for
3781 * Sel nodes that do not select from an array, i.e., have no index
3782 * inputs. It adds the two parameters 0, NULL.
3784 * @param *store The memory in which the object the entity should be selected from is allocated.
3785 * @param *objptr The object from that the Sel operation selects a single attribute out.
3786 * @param *ent The entity to select.
3788 ir_node *new_simpleSel(ir_node *store, ir_node *objptr, ir_entity *ent);
3790 /** Constructor for a Sel node.
3792 * The select node selects an entity (field or method) from an entity
3793 * with a compound type. It explicitly specifies the entity selected.
3794 * Dynamically the node may select entities that overwrite the given
3795 * entity. If the selected entity is an array element entity the Sel
3796 * node takes the required array indices as inputs.
3797 * Adds the node to the block in current_ir_block.
3799 * @param *store The memory in which the object the entity should be selected
3800 * from is allocated.
3801 * @param *objptr A pointer to a compound entity the Sel operation selects a
3802 * single attribute from.
3803 * @param arity The number of array indices needed to select an array element entity.
3804 * @param *in[] If the compound entity is an array the indices of the selected
3805 * element entity. The constructor copies this array.
3806 * @param *ent The entity to select.
3808 ir_node *new_Sel (ir_node *store, ir_node *objptr, int arity, ir_node *in[],
3811 /** Constructor for a Call node.
3813 * Adds the node to the block in current_ir_block.
3814 * Represents all kinds of method and function calls.
3816 * @param *store The actual store.
3817 * @param *callee A pointer to the called procedure.
3818 * @param arity The number of procedure parameters.
3819 * @param *in[] An array with the pointers to the parameters. The constructor copies this array.
3820 * @param *tp Type information of the procedure called.
3822 ir_node *new_Call (ir_node *store, ir_node *callee, int arity, ir_node *in[],
3825 /** Constructor for a CallBegin node.
3827 * CallBegin represents control flow depending of the pointer value
3828 * representing the called method to the called methods. The
3829 * constructor copies the method pointer input from the passed Call
3830 * node. Adds the node to the block in current_ir_block.
3832 * @param *callee A pointer to the called procedure.
3834 ir_node *new_CallBegin(ir_node *callee);
3836 /** Constructor for a Add node.
3838 * Adds the node to the block in current_ir_block.
3840 * @param *op1 The first operand.
3841 * @param *op2 The second operand.
3842 * @param *mode The mode of the operands and the result.
3844 ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode);
3846 /** Constructor for a Sub node.
3848 * Adds the node to the block in current_ir_block.
3850 * @param *op1 The first operand.
3851 * @param *op2 The second operand.
3852 * @param *mode The mode of the operands and the result.
3854 ir_node *new_Sub (ir_node *op1, ir_node *op2, ir_mode *mode);
3856 /** Constructor for a Minus node.
3858 * Adds the node to the block in current_ir_block.
3860 * @param *op The operand .
3861 * @param *mode The mode of the operand and the result.
3863 ir_node *new_Minus (ir_node *op, ir_mode *mode);
3866 * Constructor for a Mul node. Adds the node to the block in current_ir_block.
3868 * @param *op1 The first operand.
3869 * @param *op2 The second operand.
3870 * @param *mode The mode of the operands and the result.
3872 ir_node *new_Mul (ir_node *op1, ir_node *op2, ir_mode *mode);
3874 /** Constructor for a Quot node.
3876 * Adds the node to the block in current_ir_block.
3878 * @param *memop The store needed to model exceptions
3879 * @param *op1 The first operand.
3880 * @param *op2 The second operand.
3881 * @param *mode The mode of the result.
3883 ir_node *new_Quot (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
3885 /** Constructor for a DivMod node.
3887 * Adds the node to the block in current_ir_block.
3889 * @param *memop The store needed to model exceptions
3890 * @param *op1 The first operand.
3891 * @param *op2 The second operand.
3892 * @param *mode The mode of the results.
3894 ir_node *new_DivMod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
3896 /** Constructor for a Div node.
3898 * Adds the node to the block in current_ir_block.
3900 * @param *memop The store needed to model exceptions
3901 * @param *op1 The first operand.
3902 * @param *op2 The second operand.
3903 * @param *mode The mode of the result.
3905 ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
3907 /** Constructor for a Mod node.
3909 * Adds the node to the block in current_ir_block.
3911 * @param *memop The store needed to model exceptions
3912 * @param *op1 The first operand.
3913 * @param *op2 The second operand.
3914 * @param *mode The mode of the result.
3916 ir_node *new_Mod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
3918 /** Constructor for a Abs node.
3920 * Adds the node to the block in current_ir_block.
3922 * @param *op The operand
3923 * @param *mode The mode of the operands and the result.
3925 ir_node *new_Abs (ir_node *op, ir_mode *mode);
3927 /** Constructor for a And node.
3929 * Adds the node to the block in current_ir_block.
3931 * @param *op1 The first operand.
3932 * @param *op2 The second operand.
3933 * @param *mode The mode of the operands and the result.
3935 ir_node *new_And (ir_node *op1, ir_node *op2, ir_mode *mode);
3938 * Constructor for a Or node. Adds the node to the block in current_ir_block.
3940 * @param *op1 The first operand.
3941 * @param *op2 The second operand.
3942 * @param *mode The mode of the operands and the result.
3944 ir_node *new_Or (ir_node *op1, ir_node *op2, ir_mode *mode);
3947 * Constructor for a Eor node. Adds the node to the block in current_ir_block.
3949 * @param *op1 The first operand.
3950 * @param *op2 The second operand.
3951 * @param *mode The mode of the operands and the results.
3953 ir_node *new_Eor (ir_node *op1, ir_node *op2, ir_mode *mode);
3955 /** Constructor for a Not node.
3957 * Adds the node to the block in current_ir_block.
3959 * @param *op The operand.
3960 * @param *mode The mode of the operand and the result.
3962 ir_node *new_Not (ir_node *op, ir_mode *mode);
3964 /** Constructor for a Shl node.
3966 * Adds the node to the block in current_ir_block.
3968 * @param *op The operand.
3969 * @param *k The number of bits to shift the operand .
3970 * @param *mode The mode of the operand and the result.
3972 ir_node *new_Shl (ir_node *op, ir_node *k, ir_mode *mode);
3975 * Constructor for a Shr node. Adds the node to the block in current_ir_block.
3977 * @param *op The operand.
3978 * @param *k The number of bits to shift the operand .
3979 * @param *mode The mode of the operand and the result.
3981 ir_node *new_Shr (ir_node *op, ir_node *k, ir_mode *mode);
3983 /** Constructor for a Shrs node.
3985 * Adds the node to the block in current_ir_block.
3987 * @param *op The operand.
3988 * @param *k The number of bits to shift the operand .
3989 * @param *mode The mode of the operand and the result.
3991 ir_node *new_Shrs (ir_node *op, ir_node *k, ir_mode *mode);
3993 /** Constructor for a Rot node.
3995 * Adds the node to the block in current_ir_block.
3997 * @param *op The operand.
3998 * @param *k The number of bits to rotate the operand.
3999 * @param *mode The mode of the operand.
4001 ir_node *new_Rot (ir_node *op, ir_node *k, ir_mode *mode);
4003 /** Constructor for a Cmp node.
4005 * Adds the node to the block in current_ir_block.
4007 * @param *op1 The first operand.
4008 * @param *op2 The second operand.
4010 ir_node *new_Cmp (ir_node *op1, ir_node *op2);
4012 /** Constructor for a Conv node.
4014 * Adds the node to the block in current_ir_block.
4016 * @param *op The operand.
4017 * @param *mode The mode of this the operand muss be converted.
4019 ir_node *new_Conv (ir_node *op, ir_mode *mode);
4021 /** Constructor for a strict Conv node.
4023 * Adds the node to the block in current_ir_block.
4025 * @param *op The operand.
4026 * @param *mode The mode of this the operand muss be converted.
4028 ir_node *new_strictConv (ir_node *op, ir_mode *mode);
4030 /** Constructor for a Cast node.
4032 * Adds the node to the block in current_ir_block.
4033 * High level type cast
4035 * @param *op The operand.
4036 * @param *to_tp The type of this the operand muss be casted .
4038 ir_node *new_Cast (ir_node *op, ir_type *to_tp);
4040 /** Constructor for a Carry node.
4042 * Adds the node to the block in current_ir_block.
4044 * @param *op1 The first operand.
4045 * @param *op2 The second operand.
4046 * @param *mode The mode of the operands and the result.
4048 ir_node *new_Carry (ir_node *op1, ir_node *op2, ir_mode *mode);
4050 /** Constructor for a Borrow node.
4052 * Adds the node to the block in current_ir_block.
4054 * @param *op1 The first operand.
4055 * @param *op2 The second operand.
4056 * @param *mode The mode of the operands and the result.
4058 ir_node *new_Borrow (ir_node *op1, ir_node *op2, ir_mode *mode);
4060 /** Constructor for a Phi node.
4062 * Adds the node to the block in current_ir_block.
4064 * @param arity The number of predecessors.
4065 * @param *in Array with predecessors.
4066 * @param *mode The mode of it's inputs and output.
4068 ir_node *new_Phi (int arity, ir_node *in[], ir_mode *mode);
4070 /** Constructor for a Load node.
4072 * @param *store The current memory.
4073 * @param *addr A pointer to the variable to be read in this memory.
4074 * @param *mode The mode of the value to be loaded.
4076 ir_node *new_Load (ir_node *store, ir_node *addr, ir_mode *mode);
4078 /** Constructor for a Store node.
4080 * @param *store The current memory.
4081 * @param *addr A pointer to the variable to be read in this memory.
4082 * @param *val The value to write to this variable.
4084 ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val);
4086 /** Constructor for a Alloc node.
4088 * The Alloc node extends the memory by space for an entity of type alloc_type.
4089 * Adds the node to the block in current_ir_block.
4091 * @param *store The memory which shall contain the new variable.
4092 * @param *size The number of bytes to allocate.
4093 * @param *alloc_type The type of the allocated variable.
4094 * @param where Where to allocate the variable, either heap_alloc or stack_alloc.
4096 ir_node *new_Alloc (ir_node *store, ir_node *size, ir_type *alloc_type,
4099 /** Constructor for a Free node.
4101 * Frees the memory occupied by the entity pointed to by the pointer
4102 * arg. Type indicates the type of the entity the argument points to.
4103 * Adds the node to the block in current_ir_block.
4105 * @param *store The memory which shall contain the new variable.
4106 * @param *ptr The pointer to the object to free.
4107 * @param *size The number of objects of type free_type to free in a sequence.
4108 * @param *free_type The type of the freed variable.
4109 * @param where Where the variable was allocated, either heap_alloc or stack_alloc.
4111 ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size,
4112 ir_type *free_type, where_alloc where);
4114 /** Constructor for a Sync node.
4116 * Merges several memory values. The node assumes that a variable
4117 * either occurs only in one of the memories, or it contains the same
4118 * value in all memories where it occurs.
4119 * Adds the node to the block in current_ir_block.
4121 * @param arity The number of memories to synchronize.
4122 * @param **in An array of pointers to nodes that produce an output of type
4123 * memory. The constructor copies this array.
4125 ir_node *new_Sync (int arity, ir_node *in[]);
4127 /** Constructor for a Proj node.
4129 * Projects a single value out of a tuple. The parameter proj gives the
4130 * position of the value within the tuple.
4131 * Adds the node to the block in current_ir_block.
4133 * @param arg A node producing a tuple.
4134 * @param *mode The mode of the value to project.
4135 * @param proj The position of the value in the tuple.
4137 ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj);
4139 /** Constructor for a Filter node.
4141 * Constructor for a Filter node. Adds the node to the block in current_ir_block.
4142 * Filter is a node with two views used to construct the interprocedural view.
4143 * In intraprocedural view its semantics are identical to the Proj node.
4144 * In interprocedural view the Filter performs the Phi operation on method
4145 * parameters or results. Other than a Phi a Filter node may not be removed
4146 * if it has only a single input.
4148 * The constructor builds the Filter in intraprocedural view.
4150 * @param *arg The tuple value to project from.
4151 * @param *mode The mode of the projected value.
4152 * @param proj The position in the tuple to project from.
4154 ir_node *new_Filter (ir_node *arg, ir_mode *mode, long proj);
4156 /** Constructor for a defaultProj node.
4158 * Represents the default control flow of a Switch-Cond node.
4159 * Adds the node to the block in current_ir_block.
4161 * @param arg A node producing a tuple.
4162 * @param max_proj The end position of the value in the tuple.
4164 ir_node *new_defaultProj (ir_node *arg, long max_proj);
4166 /** Constructor for a Tuple node.
4168 * This is an auxiliary node to replace a node that returns a tuple
4169 * without changing the corresponding Proj nodes.
4170 * Adds the node to the block in current_ir_block.
4172 * @param arity The number of tuple elements.
4173 * @param **in An array containing pointers to the nodes producing the tuple elements.
4175 ir_node *new_Tuple (int arity, ir_node *in[]);
4177 /** Constructor for an Id node.
4179 * This is an auxiliary node to replace a node that returns a single
4180 * value. Adds the node to the block in current_ir_block.
4182 * @param *val The operand to Id.
4183 * @param *mode The mode of *val.
4185 ir_node *new_Id (ir_node *val, ir_mode *mode);
4187 /** Constructor for a Bad node.
4189 * Returns the unique Bad node of the graph. The same as
4192 ir_node *new_Bad (void);
4194 /** Constructor for a Confirm node.
4196 * Specifies constraints for a value. To support dataflow analyses.
4197 * Adds the node to the block in current_ir_block.
4199 * Example: If the value never exceeds '100' this is expressed by placing a
4200 * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge.
4202 * @param *val The value we express a constraint for
4203 * @param *bound The value to compare against. Must be a firm node, typically a constant.
4204 * @param cmp The compare operation.
4206 ir_node *new_Confirm (ir_node *val, ir_node *bound, pn_Cmp cmp);
4208 /** Constructor for an Unknown node.
4210 * Represents an arbitrary value. Places the node in
4213 * @param *m The mode of the unknown value.
4215 ir_node *new_Unknown(ir_mode *m);
4217 /** Constructor for a NoMem node.
4219 * Returns the unique NoMem node of the graph. The same as
4222 ir_node *new_NoMem (void);
4224 /** Constructor for a Mux node.
4226 * Adds the node to the block in current_ir_block.
4228 * @param *sel The ir_node that calculates the boolean select.
4229 * @param *ir_true The ir_node that calculates the true result.
4230 * @param *ir_false The ir_node that calculates the false result.
4231 * @param *mode The mode of the node (and it_true and ir_false).
4233 ir_node *new_Mux (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
4235 /** Constructor for a Psi node.
4237 * @param *arity The arity of the conditions
4238 * @param *conds The array of mode_b conditions, length must be equal arity
4239 * @param *vals The array of mode values, length must be equal arity + 1
4240 * @param *mode The mode of the node (must be the mode of all vals).
4242 ir_node *new_Psi (int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode);
4244 /** Constructor for a CopyB node.
4246 * Adds the node to the block in current_ir_block.
4248 * @param *store The current memory
4249 * @param *dst The ir_node that represents the destination address.
4250 * @param *src The ir_node that represents the source address.
4251 * @param *data_type The type of the copied data
4253 ir_node *new_CopyB(ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
4255 /** Constructor for a InstOf node.
4257 * A High-Level Type check.
4259 * @param *store The memory in which the object the entity should be selected
4260 * from is allocated.
4261 * @param *objptr A pointer to a object of a class type.
4262 * @param *type The type of which objptr must be.
4264 ir_node *new_InstOf (ir_node *store, ir_node *objptr, ir_type *type);
4266 /**Constructor for a Raise node.
4268 * A High-Level Exception throw.
4270 * @param *store The current memory.
4271 * @param *obj A pointer to the Except variable.
4273 ir_node *new_Raise (ir_node *store, ir_node *obj);
4275 /** Constructor for a Bound node.
4277 * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
4279 * Adds the node to the block in current_ir_block.
4281 * @param *store The current memory
4282 * @param *idx The ir_node that represents an index.
4283 * @param *lower The ir_node that represents the lower bound for the index.
4284 * @param *upper The ir_node that represents the upper bound for the index.
4286 ir_node *new_Bound (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
4288 /** Constructor for a Pin node.
4290 * @param *node The node which value should be pinned.
4292 ir_node *new_Pin (ir_node *node);
4294 /** Constructor for an ASM pseudo node.
4296 * @param arity The number of data inputs to the node.
4297 * @param *in The array of length arity of data inputs.
4298 * @param *inputs The array of length arity of input constraints.
4299 * @param n_outs The number of data outputs to the node.
4300 * @param *outputs The array of length n_outs of output constraints.
4301 * @param n_clobber The number of clobbered registers.
4302 * @param *clobber The array of length n_clobber of clobbered registers.
4303 * @param *asm_text The assembler text.
4305 ir_node *new_ASM(int arity, ir_node *in[], ir_asm_constraint *inputs,
4306 int n_outs, ir_asm_constraint *outputs,
4307 int n_clobber, ident *clobber[], ident *asm_text);
4309 /*---------------------------------------------------------------------*/
4310 /* The comfortable interface. */
4311 /* Supports automatic Phi node construction. */
4312 /* All routines of the block oriented interface except new_Block are */
4314 /*---------------------------------------------------------------------*/
4316 /** Create an immature Block.
4318 * An immature Block has an unknown number of predecessors. Predecessors
4319 * can be added with add_immBlock_pred(). Once all predecessors are
4320 * added the block must be matured.
4322 * Adds the block to the graph in current_ir_graph. Does set
4323 * current_block. Can be used with automatic Phi node construction.
4324 * This constructor can only be used if the graph is in
4327 ir_node *new_d_immBlock(dbg_info *db);
4328 ir_node *new_immBlock(void);
4330 /** Create an immature PartBlock.
4332 * An immature block has only one Block or PartBlock predecessor.
4333 * A PartBlock forms together with one BLock and possibly other
4334 * PartBlocks a MacroBlock.
4336 * Adds the PartBlock to the graph in current_ir_graph. Does set
4337 * current_block. Can be used with automatic Phi node construction.
4338 * This constructor can only be used if the graph is in
4341 ir_node *new_d_immPartBlock(dbg_info *db, ir_node *pred_jmp);
4342 ir_node *new_immPartBlock(ir_node *pred_jmp);
4344 /** Add a control flow edge to an immature block. */
4345 void add_immBlock_pred(ir_node *immblock, ir_node *jmp);
4347 /** Finalize a Block node, when all control flows are known. */
4348 void mature_immBlock(ir_node *block);
4349 #define mature_cur_block() mature_immBlock(get_cur_block());
4352 /** Get the current value of a local variable.
4354 * Use this function to obtain the last definition of the local variable
4355 * associated with pos. Pos may not exceed the value passed as n_loc
4356 * to new_ir_graph. This call automatically inserts Phi nodes.
4358 * @param *db A pointer for debug information.
4359 * @param pos The position/id of the local variable.
4360 * @param *mode The mode of the value to get.
4362 ir_node *get_d_value(dbg_info *db, int pos, ir_mode *mode);
4363 ir_node *get_value(int pos, ir_mode *mode);
4365 /** Remark a new definition of a variable.
4367 * Use this function to remember a new definition of the value
4368 * associated with pos. Pos may not exceed the value passed as n_loc
4369 * to new_ir_graph. This call is needed to automatically inserts Phi
4372 * @param pos The position/id of the local variable.
4373 * @param *value The new value written to the local variable.
4375 void set_value(int pos, ir_node *value);
4377 /** Find the value number for a node in the current block.
4379 * This function searches all values in the current block for
4380 * a given value and returns its value number if it was found, else
4382 * Note that this does not mean that the value does not exists,
4383 * it's just not equal the node (for instance behind a Phi/Confirm ...)
4385 * @param *value The value to find.
4387 int find_value(ir_node *value);
4389 /** Get the current memory state.
4391 * Use this function to obtain the last definition of the memory
4392 * state. This call automatically inserts Phi nodes for the memory
4395 ir_node *get_store(void);
4397 /** Remark a new definition of the memory state.
4399 * Use this function to remember a new definition of the memory state.
4400 * This call is needed to automatically inserts Phi nodes.
4402 * @param *store The new memory state.
4404 void set_store(ir_node *store);
4406 /** keep this node alive even if End is not control-reachable from it
4408 * @param ka The node to keep alive.
4410 void keep_alive(ir_node *ka);
4412 /** Returns the frame type of the current graph */
4413 ir_type *get_cur_frame_type(void);
4416 /* --- initialize and finalize ir construction --- */
4418 /** Puts the graph into state "phase_high" */
4419 #define irg_finalize_cons(irg) set_irg_phase_state(irg, phase_high)
4421 /** Puts the program and all graphs into state phase_high.
4423 * This also remarks, the construction of types is finished,
4424 * e.g., that no more subtypes will be added. */
4425 void irp_finalize_cons(void);
4427 /* --- Initialization --- */
4430 * This function is called, whenever a local variable is used before definition
4432 * @param irg the IR graph on which this happens
4433 * @param mode the mode of the local var
4434 * @param pos position chosen be the frontend for this variable (n_loc)
4436 * @return a firm node of mode @p mode that initializes the var at position pos
4439 * Do not return NULL!
4440 * If this function is not set, FIRM will create a const node with tarval BAD.
4441 * Use set_irg_loc_description()/get_irg_loc_description() to assign additional
4442 * informations to local variables.
4444 typedef ir_node *uninitialized_local_variable_func_t(ir_graph *irg, ir_mode *mode, int pos);
projects / libfirm / blob