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"
1123 #include "dbginfo.h"
1125 /*-------------------------------------------------------------------------*/
1126 /* The raw interface */
1127 /*-------------------------------------------------------------------------*/
1129 /** Constructor for a Block node.
1131 * Constructs a mature block with the given predecessors. Use Unknown
1132 * nodes as predecessors to construct a block if the number of
1133 * predecessors is known, but not the predecessors themselves. This
1134 * constructor does not set current_block. It not be used with
1135 * automatic Phi node construction.
1137 * @param *db A Pointer for debug information.
1138 * @param irg The ir graph the block belongs to.
1139 * @param arity The number of control predecessors.
1140 * @param in[] An array of control predecessors. The length of
1141 * the array must be 'arity'. The constructor copies this array.
1143 ir_node *new_rd_Block (dbg_info *db, ir_graph *irg, int arity, ir_node *in[]);
1145 /** Constructor for a Start node.
1147 * @param *db A pointer for debug information.
1148 * @param *irg The ir graph the node belongs to.
1149 * @param *block The ir block the node belongs to.
1151 ir_node *new_rd_Start (dbg_info *db, ir_graph *irg, ir_node *block);
1153 /** Constructor for a End node.
1155 * @param *db A pointer for debug information.
1156 * @param *irg The ir graph the node belongs to.
1157 * @param *block The ir block the node belongs to.
1159 ir_node *new_rd_End (dbg_info *db, ir_graph *irg, ir_node *block);
1161 /** Constructor for a Jmp node.
1163 * Jmp represents control flow to a single control successor.
1165 * @param *db A pointer for debug information.
1166 * @param *irg The ir graph the node belongs to.
1167 * @param *block The ir block the node belongs to.
1169 ir_node *new_rd_Jmp (dbg_info *db, ir_graph *irg, ir_node *block);
1171 /** Constructor for an IJmp node.
1173 * IJmp represents control flow to a single control successor not
1174 * statically known i.e. an indirect Jmp.
1176 * @param *db A pointer for debug information.
1177 * @param *irg The ir graph the node belongs to.
1178 * @param *block The ir block the node belongs to.
1179 * @param *tgt The ir node representing the target address.
1181 ir_node *new_rd_IJmp (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *tgt);
1183 /** Constructor for a Break node.
1185 * Break represents control flow to a single control successor just as Jmp.
1186 * The blocks separated by a break may not be concatenated by an optimization.
1187 * It is used for the interprocedural representation where blocks are parted
1188 * behind Call nodes to represent the control flow to called procedures.
1190 * @param *db A pointer for debug information.
1191 * @param *irg The ir graph the node belong to.
1192 * @param *block The block the node belong to.
1194 ir_node *new_rd_Break (dbg_info *db, ir_graph *irg, ir_node *block);
1196 /** Constructor for a Cond node.
1198 * If c is mode_b represents a conditional branch (if/else). If c is
1199 * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond
1200 * node, default Proj is 0.)
1202 * This is not consistent: Input to Cond is Is, Proj has as proj number
1205 * @param *db A pointer for debug information.
1206 * @param *irg The ir graph the node belongs to.
1207 * @param *block The ir block the node belongs to.
1208 * @param *c The conditions parameter. Can be of mode b or I_u.
1210 ir_node *new_rd_Cond (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *c);
1212 /** Constructor for a Return node.
1214 * Returns the memory an zero or more return values. Only node that
1215 * can end regular control flow.
1217 * @param *db A pointer for debug information.
1218 * @param *irg The ir graph the node belongs to.
1219 * @param *block The ir block the node belongs to.
1220 * @param *store The state of memory.
1221 * @param arity Number of return values.
1222 * @param *in Array of length arity with return values. The constructor copies this array.
1224 ir_node *new_rd_Return (dbg_info *db, ir_graph *irg, ir_node *block,
1225 ir_node *store, int arity, ir_node *in[]);
1227 /** Constructor for a Const_type node.
1229 * The constant represents a target value. This constructor sets high
1230 * level type information for the constant value.
1232 * @param *db A pointer for debug information.
1233 * @param *irg The ir graph the node belongs to.
1234 * @param *block The ir block the node belongs to.
1235 * @param *mode The mode of the operands and results.
1236 * @param *con Points to an entry in the constant table.
1237 * @param *tp The type of the constant.
1239 ir_node *new_rd_Const_type (dbg_info *db, ir_graph *irg, ir_node *block,
1240 ir_mode *mode, tarval *con, ir_type *tp);
1242 /** Constructor for a Const node.
1244 * Constructor for a Const node. The constant represents a target
1245 * value. Sets the type information to type_unknown. (No more
1246 * supported: If tv is entity derives a somehow useful type.)
1248 * @param *db A pointer for debug information.
1249 * @param *irg The ir graph the node belongs to.
1250 * @param *block The ir block the node belongs to.
1251 * @param *mode The mode of the operands and results.
1252 * @param *con Points to an entry in the constant table.
1254 ir_node *new_rd_Const (dbg_info *db, ir_graph *irg, ir_node *block,
1255 ir_mode *mode, tarval *con);
1257 /** Constructor for a SymConst_type node.
1259 * This is the constructor for a symbolic constant.
1260 * There are four kinds of symbolic constants:
1261 * - type_tag The symbolic constant represents a type tag. The type the
1262 * tag stands for is given explicitly.
1263 * - type_size The symbolic constant represents the size of a type. The
1264 * type of which the constant represents the size is given
1266 * - type_align The symbolic constant represents the alignment of a type. The
1267 * type of which the constant represents the size is given
1269 * - addr_name The symbolic constant represents the address of an entity
1270 * (variable or method). The variable is indicated by a name
1271 * that is valid for linking.
1272 * - addr_ent The symbolic constant represents the address of an entity
1273 * (variable or method). The variable is given explicitly by
1276 * Inputs to the node:
1277 * No inputs except the block it belongs to.
1278 * Outputs of the node.
1279 * An unsigned integer (I_u) or a pointer (P).
1281 * Mention union in declaration so that the firmjni generator recognizes that
1282 * it can not cast the argument to an int.
1284 * @param *db A pointer for debug information.
1285 * @param *irg The ir graph the node belongs to.
1286 * @param *block The ir block the node belongs to.
1287 * @param symkind The kind of the symbolic constant: type_tag, size, addr_name or addr_ent.
1288 * @param value A type, entity or a ident depending on the SymConst kind.
1289 * @param tp The source type of the constant.
1291 ir_node *new_rd_SymConst_type (dbg_info *db, ir_graph *irg, ir_node *block, union symconst_symbol value,
1292 symconst_kind symkind, ir_type *tp);
1294 /** Constructor for a SymConst node.
1296 * Same as new_rd_SymConst_type, except that it sets the type to type_unknown. */
1297 ir_node *new_rd_SymConst (dbg_info *db, ir_graph *irg, ir_node *block,
1298 union symconst_symbol value, symconst_kind symkind);
1300 /** Constructor for a SymConst addr_ent node.
1302 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1303 * symconst_addr_ent.
1304 * Adds the SymConst to the start block of irg. */
1305 ir_node *new_rd_SymConst_addr_ent (dbg_info *db, ir_graph *irg, ir_entity *symbol, ir_type *tp);
1307 /** Constructor for a SymConst ofs_ent node.
1309 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1311 * Adds the SymConst to the start block of irg. */
1312 ir_node *new_rd_SymConst_ofs_ent (dbg_info *db, ir_graph *irg, ir_entity *symbol, ir_type *tp);
1314 /** Constructor for a SymConst addr_name node.
1316 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1317 * symconst_addr_ent.
1318 * Adds the SymConst to the start block of irg. */
1319 ir_node *new_rd_SymConst_addr_name (dbg_info *db, ir_graph *irg, ident *symbol, ir_type *tp);
1321 /** Constructor for a SymConst type_tag node.
1323 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1324 * symconst_addr_ent.
1325 * Adds the SymConst to the start block of irg. */
1326 ir_node *new_rd_SymConst_type_tag (dbg_info *db, ir_graph *irg, ir_type *symbol, ir_type *tp);
1328 /** Constructor for a SymConst size node.
1330 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1331 * symconst_type_size.
1332 * Adds the SymConst to the start block of irg. */
1333 ir_node *new_rd_SymConst_size (dbg_info *db, ir_graph *irg, ir_type *symbol, ir_type *tp);
1335 /** Constructor for a SymConst size node.
1337 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1338 * symconst_type_align.
1339 * Adds the SymConst to the start block of irg. */
1340 ir_node *new_rd_SymConst_align (dbg_info *db, ir_graph *irg, ir_type *symbol, ir_type *tp);
1342 /** Constructor for a simpleSel node.
1344 * This is a shortcut for the new_rd_Sel() constructor. To be used for
1345 * Sel nodes that do not select from an array, i.e., have no index
1346 * inputs. It adds the two parameters 0, NULL.
1348 * @param *db A pointer for debug information.
1349 * @param *irg The ir graph the node belongs to.
1350 * @param *block The ir block the node belongs to.
1351 * @param *store The memory in which the object the entity should be
1352 * selected from is allocated.
1353 * @param *objptr The object from that the Sel operation selects a
1354 * single attribute out.
1355 * @param *ent The entity to select.
1357 ir_node *new_rd_simpleSel (dbg_info *db, ir_graph *irg, ir_node *block,
1358 ir_node *store, ir_node *objptr, ir_entity *ent);
1360 /** Constructor for a Sel node.
1362 * The select node selects an entity (field or method) from an entity
1363 * with a compound type. It explicitly specifies the entity selected.
1364 * Dynamically the node may select entities that overwrite the given
1365 * entity. If the selected entity is an array element entity the Sel
1366 * node takes the required array indices as inputs.
1368 * @param *db A pointer for debug information.
1369 * @param *irg The ir graph the node belongs to.
1370 * @param *block The ir block the node belongs to.
1371 * @param *store The memory in which the object the entity should be selected
1372 * from is allocated.
1373 * @param *objptr A pointer to a compound entity the Sel operation selects a
1374 * single attribute from.
1375 * @param *n_index The number of array indices needed to select an array element entity.
1376 * @param *index[] If the compound entity is an array the indices of the selected
1377 * element entity. The constructor copies this array.
1378 * @param *ent The entity to select.
1380 ir_node *new_rd_Sel (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1381 ir_node *objptr, int n_index, ir_node *index[], ir_entity *ent);
1383 /** Constructor for a Call node.
1385 * Represents all kinds of method and function calls.
1387 * @param *db A pointer for debug information.
1388 * @param *irg The ir graph the node belongs to.
1389 * @param *block The ir block the node belongs to.
1390 * @param *store The current memory state.
1391 * @param *callee A pointer to the called procedure.
1392 * @param arity The number of procedure parameters.
1393 * @param *in[] An array with the procedure parameters. The constructor copies this array.
1394 * @param *tp Type information of the procedure called.
1396 ir_node *new_rd_Call (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1397 ir_node *callee, int arity, ir_node *in[], ir_type *tp);
1399 /** Constructor for a Add node.
1401 * @param *db A pointer for debug information.
1402 * @param *irg The ir graph the node belongs to.
1403 * @param *block The ir block the node belongs to.
1404 * @param *op1 The first operand.
1405 * @param *op2 The second operand.
1406 * @param *mode The mode of the operands and the result.
1408 ir_node *new_rd_Add (dbg_info *db, ir_graph *irg, ir_node *block,
1409 ir_node *op1, ir_node *op2, ir_mode *mode);
1411 /** Constructor for a Sub node.
1413 * @param *db A pointer for debug information.
1414 * @param *irg The ir graph the node belongs to.
1415 * @param *block The ir block the node belongs to.
1416 * @param *op1 The first operand.
1417 * @param *op2 The second operand.
1418 * @param *mode The mode of the operands and the result.
1420 ir_node *new_rd_Sub (dbg_info *db, ir_graph *irg, ir_node *block,
1421 ir_node *op1, ir_node *op2, ir_mode *mode);
1423 /** Constructor for a Minus node.
1425 * @param *db A pointer for debug information.
1426 * @param *irg The ir graph the node belongs to.
1427 * @param *block The ir block the node belongs to.
1428 * @param *op The operand .
1429 * @param *mode The mode of the operand and the result.
1431 ir_node *new_rd_Minus (dbg_info *db, ir_graph *irg, ir_node *block,
1432 ir_node *op, ir_mode *mode);
1434 /** Constructor for a Mul node.
1436 * @param *db A pointer for debug information.
1437 * @param *irg The ir graph the node belongs to.
1438 * @param *block The ir block the node belongs to.
1439 * @param *op1 The first operand.
1440 * @param *op2 The second operand.
1441 * @param *mode The mode of the operands and the result.
1443 ir_node *new_rd_Mul (dbg_info *db, ir_graph *irg, ir_node *block,
1444 ir_node *op1, ir_node *op2, ir_mode *mode);
1446 /** Constructor for a Quot node.
1448 * @param *db A pointer for debug information.
1449 * @param *irg The ir graph the node belongs to.
1450 * @param *block The ir block the node belongs to.
1451 * @param *memop The store needed to model exceptions
1452 * @param *op1 The first operand.
1453 * @param *op2 The second operand.
1454 * @param *mode The mode of the result.
1456 ir_node *new_rd_Quot (dbg_info *db, ir_graph *irg, ir_node *block,
1457 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
1459 /** Constructor for a DivMod node.
1461 * @param *db A pointer for debug information.
1462 * @param *irg The ir graph the node belongs to.
1463 * @param *block The ir block the node belongs to.
1464 * @param *memop The store needed to model exceptions
1465 * @param *op1 The first operand.
1466 * @param *op2 The second operand.
1467 * @param *mode The mode of the results.
1469 ir_node *new_rd_DivMod (dbg_info *db, ir_graph *irg, ir_node *block,
1470 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
1472 /** Constructor for a Div node.
1474 * @param *db A pointer for debug information.
1475 * @param *irg The ir graph the node belongs to.
1476 * @param *block The ir block the node belongs to.
1477 * @param *memop The store needed to model exceptions
1478 * @param *op1 The first operand.
1479 * @param *op2 The second operand.
1480 * @param *mode The mode of the result.
1482 ir_node *new_rd_Div (dbg_info *db, ir_graph *irg, ir_node *block,
1483 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
1485 /** Constructor for a Mod node.
1487 * @param *db A pointer for debug information.
1488 * @param *irg The ir graph the node belongs to.
1489 * @param *block The ir block the node belongs to.
1490 * @param *memop The store needed to model exceptions
1491 * @param *op1 The first operand.
1492 * @param *op2 The second operand.
1493 * @param *mode The mode of the result.
1495 ir_node *new_rd_Mod (dbg_info *db, ir_graph *irg, ir_node *block,
1496 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
1498 /** Constructor for a Abs node.
1500 * @param *db A pointer for debug information.
1501 * @param *irg The ir graph the node belongs to.
1502 * @param *block The ir block the node belongs to.
1503 * @param *op The operand
1504 * @param *mode The mode of the operands and the result.
1506 ir_node *new_rd_Abs (dbg_info *db, ir_graph *irg, ir_node *block,
1507 ir_node *op, ir_mode *mode);
1509 /** Constructor for a And node.
1511 * @param *db A pointer for debug information.
1512 * @param *irg The ir graph the node belongs to.
1513 * @param *block The ir block the node belongs to.
1514 * @param *op1 The first operand.
1515 * @param *op2 The second operand.
1516 * @param *mode The mode of the operands and the result.
1518 ir_node *new_rd_And (dbg_info *db, ir_graph *irg, ir_node *block,
1519 ir_node *op1, ir_node *op2, ir_mode *mode);
1521 /** Constructor for a Or node.
1523 * @param *db A pointer for debug information.
1524 * @param *irg The ir graph the node belongs to.
1525 * @param *block The ir block the node belongs to.
1526 * @param *op1 The first operand.
1527 * @param *op2 The second operand.
1528 * @param *mode The mode of the operands and the result.
1530 ir_node *new_rd_Or (dbg_info *db, ir_graph *irg, ir_node *block,
1531 ir_node *op1, ir_node *op2, ir_mode *mode);
1533 /** Constructor for a Eor node.
1535 * @param *db A pointer for debug information.
1536 * @param *irg The ir graph the node belongs to.
1537 * @param *block The ir block the node belongs to.
1538 * @param *op1 The first operand.
1539 * @param *op2 The second operand.
1540 * @param *mode The mode of the operands and the results.
1542 ir_node *new_rd_Eor (dbg_info *db, ir_graph *irg, ir_node *block,
1543 ir_node *op1, ir_node *op2, ir_mode *mode);
1545 /** Constructor for a Not node.
1547 * @param *db A pointer for debug information.
1548 * @param *irg The ir graph the node belongs to.
1549 * @param *block The ir block the node belongs to.
1550 * @param *op The operand.
1551 * @param *mode The mode of the operand and the result.
1553 ir_node *new_rd_Not (dbg_info *db, ir_graph *irg, ir_node *block,
1554 ir_node *op, ir_mode *mode);
1556 /** Constructor for a Cmp node.
1558 * @param *db A pointer for debug information.
1559 * @param *irg The ir graph the node belongs to.
1560 * @param *block The ir block the node belongs to.
1561 * @param *op1 The first operand.
1562 * @param *op2 The second operand.
1564 ir_node *new_rd_Cmp (dbg_info *db, ir_graph *irg, ir_node *block,
1565 ir_node *op1, ir_node *op2);
1567 /** Constructor for a Shl node.
1569 * @param *db A pointer for debug information.
1570 * @param *irg The ir graph the node belongs to.
1571 * @param *block The ir block the node belongs to.
1572 * @param *op The operand.
1573 * @param *k The number of bits to shift the operand .
1574 * @param *mode The mode of the operand and the result.
1576 ir_node *new_rd_Shl (dbg_info *db, ir_graph *irg, ir_node *block,
1577 ir_node *op, ir_node *k, ir_mode *mode);
1579 /** Constructor for a Shr node.
1581 * @param *db A pointer for debug information.
1582 * @param *irg The ir graph the node belongs to.
1583 * @param *block The ir block the node belongs to.
1584 * @param *op The operand.
1585 * @param *k The number of bits to shift the operand .
1586 * @param *mode The mode of the operand and the result.
1588 ir_node *new_rd_Shr (dbg_info *db, ir_graph *irg, ir_node *block,
1589 ir_node *op, ir_node *k, ir_mode *mode);
1591 /** Constructor for a Shrs node.
1593 * @param *db A pointer for debug information.
1594 * @param *irg The ir graph the node belongs to.
1595 * @param *block The ir block the node belongs to.
1596 * @param *op The operand.
1597 * @param *k The number of bits to shift the operand.
1598 * @param *mode The mode of the operand and the result.
1600 ir_node *new_rd_Shrs (dbg_info *db, ir_graph *irg, ir_node *block,
1601 ir_node *op, ir_node *k, ir_mode *mode);
1603 /** Constructor for a Rot node.
1605 * @param *db A pointer for debug information.
1606 * @param *irg The ir graph the node belongs to.
1607 * @param *block The ir block the node belongs to.
1608 * @param *op The operand.
1609 * @param *k The number of bits to rotate the operand.
1610 * @param *mode The mode of the operand.
1612 ir_node *new_rd_Rot (dbg_info *db, ir_graph *irg, ir_node *block,
1613 ir_node *op, ir_node *k, ir_mode *mode);
1616 /** Constructor for a Conv node.
1618 * @param *db A pointer for debug information.
1619 * @param *irg The ir graph the node belongs to.
1620 * @param *block The ir block the node belongs to.
1621 * @param *op The operand.
1622 * @param *mode The mode of this the operand muss be converted .
1624 ir_node *new_rd_Conv (dbg_info *db, ir_graph *irg, ir_node *block,
1625 ir_node *op, ir_mode *mode);
1627 /** Constructor for a Cast node.
1629 * High level type cast.
1631 * @param *db A pointer for debug information.
1632 * @param *irg The ir graph the node belongs to.
1633 * @param *block The ir block the node belongs to.
1634 * @param *op The operand.
1635 * @param *to_tp The type of this the operand muss be casted .
1637 ir_node *new_rd_Cast (dbg_info *db, ir_graph *irg, ir_node *block,
1638 ir_node *op, ir_type *to_tp);
1640 /** Constructor for a Carry node.
1642 * @param *db A pointer for debug information.
1643 * @param *irg The ir graph the node belongs to.
1644 * @param *block The ir block the node belongs to.
1645 * @param *op1 The first operand.
1646 * @param *op2 The second operand.
1647 * @param *mode The mode of the operands and the result.
1649 ir_node *new_rd_Carry (dbg_info *db, ir_graph *irg, ir_node *block,
1650 ir_node *op1, ir_node *op2, ir_mode *mode);
1652 /** Constructor for a Borrow node.
1654 * @param *db A pointer for debug information.
1655 * @param *irg The ir graph the node belongs to.
1656 * @param *block The ir block the node belongs to.
1657 * @param *op1 The first operand.
1658 * @param *op2 The second operand.
1659 * @param *mode The mode of the operands and the result.
1661 ir_node *new_rd_Borrow (dbg_info *db, ir_graph *irg, ir_node *block,
1662 ir_node *op1, ir_node *op2, ir_mode *mode);
1664 /** Constructor for a Phi node.
1666 * @param *db A pointer for debug information.
1667 * @param *irg The ir graph the node belongs to.
1668 * @param *block The ir block the node belongs to.
1669 * @param arity The number of predecessors
1670 * @param *in[] Array with predecessors. The constructor copies this array.
1671 * @param *mode The mode of it's inputs and output.
1673 ir_node *new_rd_Phi (dbg_info *db, ir_graph *irg, ir_node *block, int arity,
1674 ir_node *in[], ir_mode *mode);
1676 /** Constructor for a Load node.
1678 * @param *db A pointer for debug information.
1679 * @param *irg The ir graph the node belongs to.
1680 * @param *block The ir block the node belongs to.
1681 * @param *store The current memory
1682 * @param *adr A pointer to the variable to be read in this memory.
1683 * @param *mode The mode of the value to be loaded.
1685 ir_node *new_rd_Load (dbg_info *db, ir_graph *irg, ir_node *block,
1686 ir_node *store, ir_node *adr, ir_mode *mode);
1688 /** Constructor for a Store node.
1690 * @param *db A pointer for debug information.
1691 * @param *irg The ir graph the node belongs to.
1692 * @param *block The ir block the node belongs to.
1693 * @param *store The current memory
1694 * @param *adr A pointer to the variable to be read in this memory.
1695 * @param *val The value to write to this variable.
1697 ir_node *new_rd_Store (dbg_info *db, ir_graph *irg, ir_node *block,
1698 ir_node *store, ir_node *adr, ir_node *val);
1700 /** Constructor for a Alloc node.
1702 * The Alloc node extends the memory by space for an entity of type alloc_type.
1704 * @param *db A pointer for debug information.
1705 * @param *irg The ir graph the node belongs to.
1706 * @param *block The ir block the node belongs to.
1707 * @param *store The memory which shall contain the new variable.
1708 * @param *size The number of bytes to allocate.
1709 * @param *alloc_type The type of the allocated variable.
1710 * @param where Where to allocate the variable, either heap_alloc or stack_alloc.
1712 ir_node *new_rd_Alloc (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1713 ir_node *size, ir_type *alloc_type, where_alloc where);
1715 /** Constructor for a Free node.
1717 * Frees the memory occupied by the entity pointed to by the pointer
1718 * arg. Type indicates the type of the entity the argument points to.
1720 * @param *db A pointer for debug information.
1721 * @param *irg The ir graph the node belongs to.
1722 * @param *block The ir block the node belongs to.
1723 * @param *store The memory which shall contain the new variable.
1724 * @param *ptr The pointer to the object to free.
1725 * @param *size The number of objects of type free_type to free in a sequence.
1726 * @param *free_type The type of the freed variable.
1727 * @param where Where the variable was allocated, either heap_alloc or stack_alloc.
1729 ir_node *new_rd_Free (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1730 ir_node *ptr, ir_node *size, ir_type *free_type, where_alloc where);
1732 /** Constructor for a Sync node.
1734 * Merges several memory values. The node assumes that a variable
1735 * either occurs only in one of the memories, or it contains the same
1736 * value in all memories where it occurs.
1738 * @param *db A pointer for debug information.
1739 * @param *irg The ir graph the node belongs to.
1740 * @param *block The ir block the node belongs to.
1741 * @param arity The number of memories to synchronize.
1742 * @param *in[] An array of pointers to nodes that produce an output of type
1743 * memory. The constructor copies this array.
1745 ir_node *new_rd_Sync (dbg_info *db, ir_graph *irg, ir_node *block, int arity, ir_node *in[]);
1747 /** Constructor for a Proj node.
1749 * Projects a single value out of a tuple. The parameter proj gives the
1750 * position of the value within the tuple.
1752 * @param *db A pointer for debug information.
1753 * @param *irg The ir graph the node belongs to.
1754 * @param *block The ir block the node belongs to.
1755 * @param arg A node producing a tuple. The node must have mode_T.
1756 * @param *mode The mode of the value to project.
1757 * @param proj The position of the value in the tuple.
1759 ir_node *new_rd_Proj (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *arg,
1760 ir_mode *mode, long proj);
1762 /** Constructor for a defaultProj node.
1764 * Represents the default control flow of a Switch-Cond node.
1766 * @param *db A pointer for debug information.
1767 * @param *irg The ir graph the node belongs to.
1768 * @param *block The ir block the node belongs to.
1769 * @param arg A node producing a tuple.
1770 * @param max_proj The end position of the value in the tuple.
1772 ir_node *new_rd_defaultProj (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *arg,
1775 /** Constructor for a Tuple node.
1777 * This is an auxiliary node to replace a node that returns a tuple
1778 * without changing the corresponding Proj nodes.
1780 * @param *db A pointer for debug information.
1781 * @param *irg The ir graph the node belongs to.
1782 * @param *block The ir block the node belongs to.
1783 * @param arity The number of tuple elements.
1784 * @param *in[] An array containing pointers to the nodes producing the tuple
1785 * elements. The constructor copies this array.
1787 ir_node *new_rd_Tuple (dbg_info *db, ir_graph *irg, ir_node *block,
1788 int arity, ir_node *in[]);
1790 /** Constructor for a Id node.
1792 * This is an auxiliary node to replace a node that returns a single
1795 * @param *db A pointer for debug information.
1796 * @param *irg The ir graph the node belongs to.
1797 * @param *block The ir block the node belongs to.
1798 * @param *val The value
1799 * @param *mode The mode of *val.
1801 ir_node *new_rd_Id (dbg_info *db, ir_graph *irg, ir_node *block,
1802 ir_node *val, ir_mode *mode);
1804 /** Constructor for a Bad node.
1806 * Returns the unique Bad node of the graph. The same as
1809 * @param *irg The ir graph the node belongs to.
1811 ir_node *new_rd_Bad (ir_graph *irg);
1813 /** Constructor for a Confirm node.
1815 * Specifies constraints for a value. To support dataflow analyses.
1817 * Example: If the value never exceeds '100' this is expressed by placing a
1818 * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge.
1820 * @param *irg The ir graph the node belong to.
1821 * @param *block The ir block the node belong to.
1822 * @param *db A pointer for debug information.
1823 * @param *val The value we express a constraint for
1824 * @param *bound The value to compare against. Must be a firm node, typically a constant.
1825 * @param cmp The compare operation.
1827 ir_node *new_rd_Confirm (dbg_info *db, ir_graph *irg, ir_node *block,
1828 ir_node *val, ir_node *bound, pn_Cmp cmp);
1830 /** Constructor for an Unknown node.
1832 * Represents an arbitrary value. Places the node in the start block.
1834 * @param *irg The ir graph the node belongs to.
1835 * @param *m The mode of the unknown value.
1837 ir_node *new_rd_Unknown(ir_graph *irg, ir_mode *m);
1839 /** Constructor for a CallBegin node.
1841 * CallBegin represents control flow depending of the pointer value
1842 * representing the called method to the called methods. The
1843 * constructor copies the method pointer input from the passed Call
1846 * @param *db A pointer for debug information.
1847 * @param *irg The ir graph the node belong to.
1848 * @param *block The block the node belong to.
1849 * @param *callee The call node visible in the intra procedural view.
1851 ir_node *new_rd_CallBegin(dbg_info *db, ir_graph *irg, ir_node *block, ir_node *callee);
1853 /** Constructor for a EndReg node.
1855 * Used to represent regular procedure end in interprocedual view.
1857 * @param *db A pointer for debug information.
1858 * @param *irg The ir graph the node belong to.
1859 * @param *block The block the node belong to.
1861 ir_node *new_rd_EndReg (dbg_info *db, ir_graph *irg, ir_node *block);
1863 /** Constructor for a EndExcept node.
1865 * Used to represent exceptional procedure end in interprocedural view.
1867 * @param *db A pointer for debug information.
1868 * @param *irg The ir graph the node belong to.
1869 * @param *block The block the node belong to.
1871 ir_node *new_rd_EndExcept(dbg_info *db, ir_graph *irg, ir_node *block);
1873 /** Constructor for a Filter node.
1875 * Adds the node to the block in current_ir_block. Filter is a node
1876 * with two views used to construct the interprocedural view. In
1877 * intraprocedural view its semantics are identical to the Proj node.
1878 * In interprocedural view the Filter performs the Phi operation on
1879 * method parameters or results. Other than a Phi a Filter node may
1880 * not be removed if it has only a single input.
1882 * The constructor builds the Filter in intraprocedural view.
1884 * @param *db A pointer for debug information.
1885 * @param *irg The ir graph the node belong to.
1886 * @param *block The block the node belong to.
1887 * @param *arg The tuple value to project from.
1888 * @param *mode The mode of the projected value.
1889 * @param proj The position in the tuple to project from.
1891 ir_node *new_rd_Filter (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *arg,
1892 ir_mode *mode, long proj);
1894 /** Constructor for a NoMem node.
1896 * Returns the unique NoMem node of the graph. The same as
1899 * @param *irg The ir graph the node belongs to.
1901 ir_node *new_rd_NoMem (ir_graph *irg);
1903 /** Constructor for a Mux node.
1905 * @param *db A pointer for debug information.
1906 * @param *irg The ir graph the node belong to.
1907 * @param *block The block the node belong to.
1908 * @param *sel The ir_node that calculates the boolean select.
1909 * @param *ir_true The ir_node that calculates the true result.
1910 * @param *ir_false The ir_node that calculates the false result.
1911 * @param *mode The mode of the node (and it_true and ir_false).
1913 ir_node *new_rd_Mux (dbg_info *db, ir_graph *irg, ir_node *block,
1914 ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
1916 /** Constructor for a Psi node.
1918 * @param *db A pointer for debug information.
1919 * @param *irg The ir graph the node belong to.
1920 * @param *block The block the node belong to.
1921 * @param *arity The arity of the conditions
1922 * @param *conds The array of mode_b conditions, length must be equal arity
1923 * @param *vals The array of mode values, length must be equal arity + 1
1924 * @param *mode The mode of the node (must be the mode of all vals).
1926 ir_node *new_rd_Psi (dbg_info *db, ir_graph *irg, ir_node *block,
1927 int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode);
1929 /** Constructor for a CopyB node.
1931 * @param *db A pointer for debug information.
1932 * @param *irg The ir graph the node belong to.
1933 * @param *block The block the node belong to.
1934 * @param *store The current memory
1935 * @param *dst The ir_node that represents the destination address.
1936 * @param *src The ir_node that represents the source address.
1937 * @param *data_type The type of the copied data
1939 ir_node *new_rd_CopyB(dbg_info *db, ir_graph *irg, ir_node *block,
1940 ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
1942 /** Constructor for a InstOf node.
1944 * A High-Level Type check.
1946 * @param *db A pointer for debug information.
1947 * @param *irg The ir graph the node belongs to.
1948 * @param *block The ir block the node belongs to.
1949 * @param *store The memory in which the object the entity should be selected
1950 * from is allocated.
1951 * @param *objptr A pointer to a object of a class type.
1952 * @param *type The type of which objptr must be.
1954 ir_node *new_rd_InstOf (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1955 ir_node *objptr, ir_type *type);
1957 /** Constructor for a Raise node.
1959 * A High-Level Exception throw.
1961 * @param *db A pointer for debug information.
1962 * @param *irg The ir graph the node belongs to.
1963 * @param *block The ir block the node belongs to.
1964 * @param *store The current memory.
1965 * @param *obj A pointer to the Except variable.
1967 ir_node *new_rd_Raise (dbg_info *db, ir_graph *irg, ir_node *block,
1968 ir_node *store, ir_node *obj);
1970 /** Constructor for a Bound node.
1972 * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
1974 * @param *db A pointer for debug information.
1975 * @param *irg The ir graph the node belong to.
1976 * @param *block The block the node belong to.
1977 * @param *store The current memory.
1978 * @param *idx The ir_node that represents an index.
1979 * @param *lower The ir_node that represents the lower bound for the index.
1980 * @param *upper The ir_node that represents the upper bound for the index.
1982 ir_node *new_rd_Bound(dbg_info *db, ir_graph *irg, ir_node *block,
1983 ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
1985 /** Constructor for a Pin node.
1987 * @param *db A pointer for debug information.
1988 * @param *irg The ir graph the node belong to.
1989 * @param *block The block the node belong to.
1990 * @param *node The node which value should be pinned.
1992 ir_node *new_rd_Pin(dbg_info *db, ir_graph *irg, ir_node *block, ir_node *node);
1994 /** Constructor for an ASM pseudo node.
1996 * @param *db A pointer for debug information.
1997 * @param *irg The ir graph the node belong to.
1998 * @param *block The block the node belong to.
1999 * @param arity The number of data inputs to the node.
2000 * @param *in The array of length arity of data inputs.
2001 * @param *inputs The array of length arity of input constraints.
2002 * @param n_outs The number of data outputs to the node.
2003 * @param *outputs The array of length n_outs of output constraints.
2004 * @param n_clobber The number of clobbered registers.
2005 * @param *clobber The array of length n_clobber of clobbered registers.
2006 * @param *asm_text The assembler text.
2008 ir_node *new_rd_ASM(dbg_info *db, ir_graph *irg, ir_node *block,
2009 int arity, ir_node *in[], ir_asm_constraint *inputs,
2010 int n_outs, ir_asm_constraint *outputs,
2011 int n_clobber, ident *clobber[], ident *asm_text);
2013 /*-------------------------------------------------------------------------*/
2014 /* The raw interface without debug support */
2015 /*-------------------------------------------------------------------------*/
2017 /** Constructor for a Block node.
2019 * Constructs a mature block with the given predecessors. Use Unknown
2020 * nodes as predecessors to construct a block if the number of
2021 * predecessors is known, but not the predecessors themselves. This
2022 * constructor does not set current_block. It not be used with
2023 * automatic Phi node construction.
2026 * @param irg The ir graph the block belongs to.
2027 * @param arity The number of control predecessors.
2028 * @param in[] An array of control predecessors. The length of
2029 * the array must be 'arity'. The constructor copies this array.
2031 ir_node *new_r_Block (ir_graph *irg, int arity, ir_node *in[]);
2033 /** Constructor for a Start node.
2035 * @param *irg The ir graph the node belongs to.
2036 * @param *block The ir block the node belongs to.
2038 ir_node *new_r_Start (ir_graph *irg, ir_node *block);
2040 /** Constructor for a End node.
2042 * @param *irg The ir graph the node belongs to.
2043 * @param *block The ir block the node belongs to.
2045 ir_node *new_r_End (ir_graph *irg, ir_node *block);
2047 /** Constructor for a Jmp node.
2049 * Jmp represents control flow to a single control successor.
2051 * @param *irg The ir graph the node belongs to.
2052 * @param *block The ir block the node belongs to.
2054 ir_node *new_r_Jmp (ir_graph *irg, ir_node *block);
2056 /** Constructor for an IJmp node.
2058 * IJmp represents control flow to a single control successor not
2059 * statically known i.e. an indirect Jmp.
2061 * @param *irg The ir graph the node belongs to.
2062 * @param *block The ir block the node belongs to.
2063 * @param *tgt The ir node representing the target address.
2065 ir_node *new_r_IJmp (ir_graph *irg, ir_node *block, ir_node *tgt);
2067 /** Constructor for a Cond node.
2069 * If c is mode_b represents a conditional branch (if/else). If c is
2070 * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond
2071 * node, default Proj is 0.)
2073 * This is not consistent: Input to Cond is Is, Proj has as proj number
2076 * @param *irg The ir graph the node belongs to.
2077 * @param *block The ir block the node belongs to.
2078 * @param *c The conditions parameter.Can be of mode b or I_u.
2080 ir_node *new_r_Cond (ir_graph *irg, ir_node *block, ir_node *c);
2082 /** Constructor for a Return node.
2084 * Returns the memory an zero or more return values. Only node that
2085 * can end regular control flow.
2087 * @param *irg The ir graph the node belongs to.
2088 * @param *block The ir block the node belongs to.
2089 * @param *store The state of memory.
2090 * @param arity Number of array indices.
2091 * @param *in[] Array with index inputs to the node. The constructor copies this array.
2093 ir_node *new_r_Return (ir_graph *irg, ir_node *block,
2094 ir_node *store, int arity, ir_node *in[]);
2096 /** Constructor for a Const node.
2098 * Constructor for a Const node. The constant represents a target
2099 * value. Sets the type information to type_unknown. (No more
2100 * supported: If tv is entity derives a somehow useful type.)
2102 * @param *irg The ir graph the node belongs to.
2103 * @param *block The ir block the node belongs to.
2104 * @param *mode The mode of the operands and the results.
2105 * @param *con Points to an entry in the constant table.
2107 ir_node *new_r_Const (ir_graph *irg, ir_node *block,
2108 ir_mode *mode, tarval *con);
2110 /** Constructor for a Const node.
2112 * Constructor for a Const node. The constant represents a target
2113 * value. Sets the type information to type_unknown. (No more
2114 * supported: If tv is entity derives a somehow useful type.)
2116 * @param *irg The ir graph the node belongs to.
2117 * @param *block The ir block the node belongs to.
2118 * @param *mode The mode of the operands and the results.
2119 * @param value A value from which the tarval is made.
2121 ir_node *new_r_Const_long(ir_graph *irg, ir_node *block,
2122 ir_mode *mode, long value);
2124 /** Constructor for a Const_type node.
2126 * The constant represents a target value. This constructor sets high
2127 * level type information for the constant value.
2129 * @param *irg The ir graph the node belongs to.
2130 * @param *block The ir block the node belongs to.
2131 * @param *mode The mode of the operands and results.
2132 * @param *con Points to an entry in the constant table.
2133 * @param *tp The type of the constant.
2135 ir_node *new_r_Const_type(ir_graph *irg, ir_node *block,
2136 ir_mode *mode, tarval *con, ir_type *tp);
2138 /** Constructor for a SymConst node.
2140 * This is the constructor for a symbolic constant.
2141 * There are four kinds of symbolic constants:
2142 * - type_tag The symbolic constant represents a type tag. The type the
2143 * tag stands for is given explicitly.
2144 * - size The symbolic constant represents the size of a type. The
2145 * type of which the constant represents the size is given
2147 * - addr_name The symbolic constant represents the address of an entity
2148 * (variable or method). The variable is indicated by a name
2149 * that is valid for linking.
2150 * - addr_ent The symbolic constant represents the address of an entity
2151 * (variable or method). The variable is given explicitly by
2154 * Inputs to the node:
2155 * No inputs except the block it belongs to.
2156 * Outputs of the node.
2157 * An unsigned integer (I_u) or a pointer (P).
2159 * @param *irg The ir graph the node belongs to.
2160 * @param *block The ir block the node belongs to.
2161 * @param value A type, entity or a ident depending on the SymConst kind.
2162 * @param symkind The kind of the symbolic constant: type_tag, size or link_info.
2164 ir_node *new_r_SymConst (ir_graph *irg, ir_node *block,
2165 union symconst_symbol value, symconst_kind symkind);
2167 /** Constructor for a simpleSel node.
2169 * This is a shortcut for the new_d_Sel() constructor. To be used for
2170 * Sel nodes that do not select from an array, i.e., have no index
2171 * inputs. It adds the two parameters 0, NULL.
2173 * @param *irg The ir graph the node belongs to.
2174 * @param *block The ir block the node belongs to.
2175 * @param *store The memory in which the object the entity should be selected
2176 * from is allocated.
2177 * @param *objptr The object from that the Sel operation selects a
2178 * single attribute out.
2179 * @param *ent The entity to select.
2181 ir_node *new_r_simpleSel(ir_graph *irg, ir_node *block, ir_node *store,
2182 ir_node *objptr, ir_entity *ent);
2184 /** Constructor for a Sel node.
2186 * The select node selects an entity (field or method) from an entity
2187 * with a compound type. It explicitly specifies the entity selected.
2188 * Dynamically the node may select entities that overwrite the given
2189 * entity. If the selected entity is an array element entity the Sel
2190 * node takes the required array indices as inputs.
2192 * @param *irg The ir graph the node belongs to.
2193 * @param *block The ir block the node belongs to.
2194 * @param *store The memory in which the object the entity should be selected
2195 * from is allocated.
2196 * @param *objptr A pointer to a compound entity the Sel operation selects a
2197 * single attribute from.
2198 * @param *n_index The number of array indices needed to select an array element entity.
2199 * @param *index[] If the compound entity is an array the indices of the selected
2200 * element entity. The constructor copies this array.
2201 * @param *ent The entity to select.
2203 ir_node *new_r_Sel (ir_graph *irg, ir_node *block, ir_node *store,
2204 ir_node *objptr, int n_index, ir_node *index[],
2207 /** Constructor for a Call node.
2209 * Represents all kinds of method and function calls.
2211 * @param *irg The ir graph the node belongs to.
2212 * @param *block The ir block the node belongs to.
2213 * @param *store The actual store.
2214 * @param *callee A pointer to the called procedure.
2215 * @param arity The number of procedure parameters.
2216 * @param *in[] An array with the pointers to the parameters. The constructor copies this array.
2217 * @param *tp Type information of the procedure called.
2219 ir_node *new_r_Call (ir_graph *irg, ir_node *block, ir_node *store,
2220 ir_node *callee, int arity, ir_node *in[],
2223 /** Constructor for a Add node.
2225 * @param *irg The ir graph the node belongs to.
2226 * @param *block The ir block the node belongs to.
2227 * @param *op1 The first operand.
2228 * @param *op2 The second operand.
2229 * @param *mode The mode of the operands and the result.
2231 ir_node *new_r_Add (ir_graph *irg, ir_node *block,
2232 ir_node *op1, ir_node *op2, ir_mode *mode);
2235 * Constructor for a Sub node.
2237 * @param *irg The ir graph the node belongs to.
2238 * @param *block The ir block the node belongs to.
2239 * @param *op1 The first operand.
2240 * @param *op2 The second operand.
2241 * @param *mode The mode of the operands and the results.
2243 ir_node *new_r_Sub (ir_graph *irg, ir_node *block,
2244 ir_node *op1, ir_node *op2, ir_mode *mode);
2246 /** Constructor for a Minus node.
2248 * @param *irg The ir graph the node belongs to.
2249 * @param *block The ir block the node belongs to.
2250 * @param *op The operand.
2251 * @param *mode The mode of the operand and the result.
2253 ir_node *new_r_Minus (ir_graph *irg, ir_node *block,
2254 ir_node *op, ir_mode *mode);
2255 /** Constructor for a Mul node.
2257 * @param *irg The ir graph the node belongs to.
2258 * @param *block The ir block the node belongs to.
2259 * @param *op1 The first operand.
2260 * @param *op2 The second operand.
2261 * @param *mode The mode of the operands and the result.
2263 ir_node *new_r_Mul (ir_graph *irg, ir_node *block,
2264 ir_node *op1, ir_node *op2, ir_mode *mode);
2266 /** Constructor for a Quot node.
2268 * @param *irg The ir graph the node belongs to.
2269 * @param *block The ir block the node belongs to.
2270 * @param *memop The store needed to model exceptions
2271 * @param *op1 The first operand.
2272 * @param *op2 The second operand.
2273 * @param *mode The mode of the result.
2275 ir_node *new_r_Quot (ir_graph *irg, ir_node *block,
2276 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
2278 /** Constructor for a DivMod node.
2280 * @param *irg The ir graph the node belongs to.
2281 * @param *block The ir block the node belongs to.
2282 * @param *memop The store needed to model exceptions
2283 * @param *op1 The first operand.
2284 * @param *op2 The second operand.
2285 * @param *mode The mode of the results.
2287 ir_node *new_r_DivMod (ir_graph *irg, ir_node *block,
2288 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
2290 /** Constructor for a Div node.
2292 * @param *irg The ir graph the node belongs to.
2293 * @param *block The ir block the node belongs to.
2294 * @param *memop The store needed to model exceptions
2295 * @param *op1 The first operand.
2296 * @param *op2 The second operand.
2297 * @param *mode The mode of the result.
2299 ir_node *new_r_Div (ir_graph *irg, ir_node *block,
2300 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
2302 /** Constructor for a Mod node.
2304 * @param *irg The ir graph the node belongs to.
2305 * @param *block The ir block the node belongs to.
2306 * @param *memop The store needed to model exceptions
2307 * @param *op1 The first operand.
2308 * @param *op2 The second operand.
2309 * @param *mode The mode of the result.
2311 ir_node *new_r_Mod (ir_graph *irg, ir_node *block,
2312 ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
2314 /** Constructor for a Abs node.
2316 * @param *irg The ir graph the node belongs to.
2317 * @param *block The ir block the node belongs to.
2318 * @param *op The operand
2319 * @param *mode The mode of the operands and the result.
2321 ir_node *new_r_Abs (ir_graph *irg, ir_node *block,
2322 ir_node *op, ir_mode *mode);
2324 /** Constructor for a And node.
2326 * @param *irg The ir graph the node belongs to.
2327 * @param *block The ir block the node belongs to.
2328 * @param *op1 The first operand.
2329 * @param *op2 The second operand.
2330 * @param *mode The mode of the operands and the result.
2332 ir_node *new_r_And (ir_graph *irg, ir_node *block,
2333 ir_node *op1, ir_node *op2, ir_mode *mode);
2335 /** Constructor for a Or node.
2337 * @param *irg The ir graph the node belongs to.
2338 * @param *block The ir block the node belongs to.
2339 * @param *op1 The first operand.
2340 * @param *op2 The second operand.
2341 * @param *mode The mode of the operands and the result.
2343 ir_node *new_r_Or (ir_graph *irg, ir_node *block,
2344 ir_node *op1, ir_node *op2, ir_mode *mode);
2346 /** Constructor for a Eor node.
2348 * @param *irg The ir graph the node belongs to.
2349 * @param *block The ir block the node belongs to.
2350 * @param *op1 The first operand.
2351 * @param *op2 The second operand.
2352 * @param *mode The mode of the operands and the results.
2354 ir_node *new_r_Eor (ir_graph *irg, ir_node *block,
2355 ir_node *op1, ir_node *op2, ir_mode *mode);
2357 /** Constructor for a Not node.
2359 * @param *irg The ir graph the node belongs to.
2360 * @param *block The ir block the node belongs to.
2361 * @param *op The operand.
2362 * @param *mode The mode of the operand and the result.
2364 ir_node *new_r_Not (ir_graph *irg, ir_node *block,
2365 ir_node *op, ir_mode *mode);
2367 /** Constructor for a Cmp node.
2369 * @param *irg The ir graph the node belongs to.
2370 * @param *block The ir block the node belongs to.
2371 * @param *op1 The first operand.
2372 * @param *op2 The second operand.
2374 ir_node *new_r_Cmp (ir_graph *irg, ir_node *block,
2375 ir_node *op1, ir_node *op2);
2377 /** Constructor for a Shl node.
2379 * @param *irg The ir graph the node belongs to.
2380 * @param *block The ir block the node belongs to.
2381 * @param *op The operand.
2382 * @param *k The number of bits to shift the operand .
2383 * @param *mode The mode of the operand and the result.
2385 ir_node *new_r_Shl (ir_graph *irg, ir_node *block,
2386 ir_node *op, ir_node *k, ir_mode *mode);
2388 /** Constructor for a Shr node.
2390 * @param *irg The ir graph the node belongs to.
2391 * @param *block The ir block the node belongs to.
2392 * @param *op The operand.
2393 * @param *k The number of bits to shift the operand .
2394 * @param *mode The mode of the operand and the result.
2396 ir_node *new_r_Shr (ir_graph *irg, ir_node *block,
2397 ir_node *op, ir_node *k, ir_mode *mode);
2400 * Constructor for a Shrs node.
2402 * @param *irg The ir graph the node belongs to.
2403 * @param *block The ir block the node belongs to.
2404 * @param *op The operand.
2405 * @param *k The number of bits to shift the operand.
2406 * @param *mode The mode of the operand and the result.
2408 ir_node *new_r_Shrs (ir_graph *irg, ir_node *block,
2409 ir_node *op, ir_node *k, ir_mode *mode);
2411 /** Constructor for a Rot node.
2413 * @param *irg The ir graph the node belongs to.
2414 * @param *block The ir block the node belongs to.
2415 * @param *op The operand.
2416 * @param *k The number of bits to rotate the operand.
2417 * @param *mode The mode of the operand.
2419 ir_node *new_r_Rot (ir_graph *irg, ir_node *block,
2420 ir_node *op, ir_node *k, ir_mode *mode);
2422 /** Constructor for a Conv node.
2424 * @param *irg The ir graph the node belongs to.
2425 * @param *block The ir block the node belongs to.
2426 * @param *op The operand.
2427 * @param *mode The mode of this the operand muss be converted .
2429 ir_node *new_r_Conv (ir_graph *irg, ir_node *block,
2430 ir_node *op, ir_mode *mode);
2432 /** Constructor for a Cast node.
2434 * High level type cast
2436 * @param *irg The ir graph the node belongs to.
2437 * @param *block The ir block the node belongs to.
2438 * @param *op The operand.
2439 * @param *to_tp The type of this the operand muss be casted .
2441 ir_node *new_r_Cast (ir_graph *irg, ir_node *block,
2442 ir_node *op, ir_type *to_tp);
2444 /** Constructor for a Carry node.
2446 * @param *irg The ir graph the node belongs to.
2447 * @param *block The ir block the node belongs to.
2448 * @param *op1 The first operand.
2449 * @param *op2 The second operand.
2450 * @param *mode The mode of the operands and the result.
2452 ir_node *new_r_Carry (ir_graph *irg, ir_node *block,
2453 ir_node *op1, ir_node *op2, ir_mode *mode);
2456 * Constructor for a Borrow node.
2458 * @param *irg The ir graph the node belongs to.
2459 * @param *block The ir block the node belongs to.
2460 * @param *op1 The first operand.
2461 * @param *op2 The second operand.
2462 * @param *mode The mode of the operands and the results.
2464 ir_node *new_r_Borrow (ir_graph *irg, ir_node *block,
2465 ir_node *op1, ir_node *op2, ir_mode *mode);
2467 /** Constructor for a Phi node.
2469 * @param *irg The ir graph the node belongs to.
2470 * @param *block The ir block the node belongs to.
2471 * @param arity The number of predecessors
2472 * @param *in[] Array with predecessors. The constructor copies this array.
2473 * @param *mode The mode of it's inputs and output.
2475 ir_node *new_r_Phi (ir_graph *irg, ir_node *block, int arity,
2476 ir_node *in[], ir_mode *mode);
2478 /** Constructor for a Load node.
2480 * @param *irg The ir graph the node belongs to.
2481 * @param *block The ir block the node belongs to.
2482 * @param *store The current memory
2483 * @param *adr A pointer to the variable to be read in this memory.
2484 * @param *mode The mode of the value to be loaded.
2486 ir_node *new_r_Load (ir_graph *irg, ir_node *block,
2487 ir_node *store, ir_node *adr, ir_mode *mode);
2489 /** Constructor for a Store node.
2491 * @param *irg The ir graph the node belongs to.
2492 * @param *block The ir block the node belongs to.
2493 * @param *store The current memory
2494 * @param *adr A pointer to the variable to be read in this memory.
2495 * @param *val The value to write to this variable.
2497 ir_node *new_r_Store (ir_graph *irg, ir_node *block,
2498 ir_node *store, ir_node *adr, ir_node *val);
2500 /** Constructor for a Alloc node.
2502 * The Alloc node extends the memory by space for an entity of type alloc_type.
2504 * @param *irg The ir graph the node belongs to.
2505 * @param *block The ir block the node belongs to.
2506 * @param *store The memory which shall contain the new variable.
2507 * @param *size The number of bytes to allocate.
2508 * @param *alloc_type The type of the allocated variable.
2509 * @param where Where to allocate the variable, either heap_alloc or stack_alloc.
2511 ir_node *new_r_Alloc (ir_graph *irg, ir_node *block, ir_node *store,
2512 ir_node *size, ir_type *alloc_type, where_alloc where);
2514 /** Constructor for a Free node.
2516 * Frees the memory occupied by the entity pointed to by the pointer
2517 * arg. Type indicates the type of the entity the argument points to.
2519 * @param *irg The ir graph the node belongs to.
2520 * @param *block The ir block the node belongs to.
2521 * @param *store The memory which shall contain the new variable.
2522 * @param *ptr The pointer to the object to free.
2523 * @param *size The number of objects of type free_type to free in a sequence.
2524 * @param *free_type The type of the freed variable.
2525 * @param where Where the variable was allocated, either heap_alloc or stack_alloc.
2527 ir_node *new_r_Free (ir_graph *irg, ir_node *block, ir_node *store,
2528 ir_node *ptr, ir_node *size, ir_type *free_type, where_alloc where);
2530 /** Constructor for a Sync node.
2532 * Merges several memory values. The node assumes that a variable
2533 * either occurs only in one of the memories, or it contains the same
2534 * value in all memories where it occurs.
2536 * @param *irg The ir graph the node belongs to.
2537 * @param *block The ir block the node belongs to.
2538 * @param arity The number of memories to synchronize.
2539 * @param *in[] An array of pointers to nodes that produce an output of type memory.
2540 * The constructor copies this array.
2542 ir_node *new_r_Sync (ir_graph *irg, ir_node *block, int arity, ir_node *in[]);
2544 /** Constructor for a Proj node.
2546 * Projects a single value out of a tuple. The parameter proj gives the
2547 * position of the value within the tuple.
2549 * @param *irg The ir graph the node belongs to.
2550 * @param *block The ir block the node belongs to.
2551 * @param arg A node producing a tuple.
2552 * @param *mode The mode of the value to project.
2553 * @param proj The position of the value in the tuple.
2555 ir_node *new_r_Proj (ir_graph *irg, ir_node *block, ir_node *arg,
2556 ir_mode *mode, long proj);
2558 /** Constructor for a defaultProj node.
2560 * Represents the default control flow of a Switch-Cond node.
2562 * @param *irg The ir graph the node belongs to.
2563 * @param *block The ir block the node belongs to.
2564 * @param arg A node producing a tuple.
2565 * @param max_proj The end position of the value in the tuple.
2567 ir_node *new_r_defaultProj (ir_graph *irg, ir_node *block, ir_node *arg, long max_proj);
2570 /** Constructor for a Tuple node.
2572 * This is an auxiliary node to replace a node that returns a tuple
2573 * without changing the corresponding Proj nodes.
2575 * @param *irg The ir graph the node belongs to.
2576 * @param *block The ir block the node belongs to.
2577 * @param arity The number of tuple elements.
2578 * @param *in[] An array containing pointers to the nodes producing the tuple elements.
2579 * The constructor copies this array.
2581 ir_node *new_r_Tuple (ir_graph *irg, ir_node *block, int arity, ir_node *in[]);
2583 /** Constructor for a Id node.
2585 * This is an auxiliary node to replace a node that returns a single
2588 * @param *irg The ir graph the node belongs to.
2589 * @param *block The ir block the node belongs to.
2590 * @param *val The operand to Id.
2591 * @param *mode The mode of *val.
2593 ir_node *new_r_Id (ir_graph *irg, ir_node *block,
2594 ir_node *val, ir_mode *mode);
2596 /** Constructor for a Bad node.
2598 * Returns the unique Bad node of the graph. The same as
2601 * @param *irg The ir graph the node belongs to.
2604 ir_node *new_r_Bad (ir_graph *irg);
2606 /** Constructor for a Confirm node.
2608 * Specifies constraints for a value. To support dataflow analyses.
2610 * Example: If the value never exceeds '100' this is expressed by placing a
2611 * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge.
2613 * @param *irg The ir graph the node belong to.
2614 * @param *block The ir block the node belong to.
2615 * @param *val The value we express a constraint for
2616 * @param *bound The value to compare against. Must be a firm node, typically a constant.
2617 * @param cmp The compare operation.
2619 ir_node *new_r_Confirm(ir_graph *irg, ir_node *block,
2620 ir_node *val, ir_node *bound, pn_Cmp cmp);
2622 /** Constructor for a Unknown node.
2624 * Represents an arbitrary value. Places the node in
2627 * @param *irg The ir graph the node belongs to.
2628 * @param *m The mode of the unknown value.
2630 ir_node *new_r_Unknown(ir_graph *irg, ir_mode *m);
2632 /** Constructor for a CallBegin node.
2634 * CallBegin represents control flow depending of the pointer value
2635 * representing the called method to the called methods. The
2636 * constructor copies the method pointer input from the passed Call
2639 * @param *irg The ir graph the node belong to.
2640 * @param *block The block the node belong to.
2641 * @param *callee The call node visible in the intra procedural view.
2643 ir_node *new_r_CallBegin(ir_graph *irg, ir_node *block, ir_node *callee);
2645 /** Constructor for a EndReg node.
2647 * Used to represent regular procedure end in interprocedual view.
2649 * @param *irg The ir graph the node belong to.
2650 * @param *block The block the node belong to.
2652 ir_node *new_r_EndReg (ir_graph *irg, ir_node *block);
2654 /** Constructor for a EndExcept node.
2656 * Used to represent exceptional procedure end in interprocedural view.
2658 * @param *irg The ir graph the node belong to.
2659 * @param *block The block the node belong to.
2661 ir_node *new_r_EndExcept(ir_graph *irg, ir_node *block);
2663 /** Constructor for a Break node.
2665 * Break represents control flow to a single control successor just as Jmp.
2666 * The blocks separated by a break may not be concatenated by an optimization.
2667 * It is used for the interprocedural representation where blocks are parted
2668 * behind Call nodes to represent the control flow to called procedures.
2670 * @param *irg The ir graph the node belong to.
2671 * @param *block The block the node belong to.
2673 ir_node *new_r_Break (ir_graph *irg, ir_node *block);
2675 /** Constructor for a Filter node.
2677 * Constructor for a Filter node. Adds the node to the block in current_ir_block.
2678 * Filter is a node with two views used to construct the interprocedural view.
2679 * In intraprocedural view its semantics are identical to the Proj node.
2680 * In interprocedural view the Filter performs the Phi operation on method
2681 * parameters or results. Other than a Phi a Filter node may not be removed
2682 * if it has only a single input.
2684 * The constructor builds the Filter in intraprocedural view.
2686 * @param *irg The ir graph the node belong to.
2687 * @param *block The block the node belong to.
2688 * @param *arg The tuple value to project from.
2689 * @param *mode The mode of the projected value.
2690 * @param proj The position in the tuple to project from.
2692 ir_node *new_r_Filter (ir_graph *irg, ir_node *block, ir_node *arg,
2693 ir_mode *mode, long proj);
2695 /** Constructor for a NoMem node.
2697 * Returns the unique NoMem node of the graph. The same as
2700 * @param *irg The ir graph the node belongs to.
2702 ir_node *new_r_NoMem (ir_graph *irg);
2704 /** Constructor for a Mux node.
2706 * @param *irg The ir graph the node belong to.
2707 * @param *block The block the node belong to.
2708 * @param *sel The ir_node that calculates the boolean select.
2709 * @param *ir_true The ir_node that calculates the true result.
2710 * @param *ir_false The ir_node that calculates the false result.
2711 * @param *mode The mode of the node (and it_true and ir_false).
2713 ir_node *new_r_Mux (ir_graph *irg, ir_node *block,
2714 ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
2716 /** Constructor for a Psi node.
2718 * @param *irg The ir graph the node belong to.
2719 * @param *block The block the node belong to.
2720 * @param *arity The arity of the conditions
2721 * @param *conds The array of mode_b conditions, length must be equal arity
2722 * @param *vals The array of mode values, length must be equal arity + 1
2723 * @param *mode The mode of the node (must be the mode of all vals).
2725 ir_node *new_r_Psi (ir_graph *irg, ir_node *block,
2726 int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode);
2728 /** Constructor for a CopyB node.
2730 * @param *irg The ir graph the node belong to.
2731 * @param *block The block the node belong to.
2732 * @param *store The current memory
2733 * @param *dst The ir_node that represents the destination address.
2734 * @param *src The ir_node that represents the source address.
2735 * @param *data_type The type of the copied data
2737 ir_node *new_r_CopyB(ir_graph *irg, ir_node *block,
2738 ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
2740 /** Constructor for a InstOf node.
2742 * A High-Level Type check.
2744 * @param *irg The ir graph the node belongs to.
2745 * @param *block The ir block the node belongs to.
2746 * @param *store The memory in which the object the entity should be selected
2747 * from is allocated.
2748 * @param *objptr A pointer to a object of a class type.
2749 * @param *type The type of which objptr must be.
2751 ir_node *new_r_InstOf(ir_graph *irg, ir_node *block, ir_node *store,
2752 ir_node *objptr, ir_type *type);
2754 /** Constructor for a Raise node.
2756 * A High-Level Exception throw.
2758 * @param *irg The ir graph the node belongs to.
2759 * @param *block The ir block the node belongs to.
2760 * @param *store The current memory.
2761 * @param *obj A pointer to the Except variable.
2763 ir_node *new_r_Raise(ir_graph *irg, ir_node *block,
2764 ir_node *store, ir_node *obj);
2766 /** Constructor for a Bound node.
2768 * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
2770 * @param *irg The ir graph the node belong to.
2771 * @param *block The block the node belong to.
2772 * @param *store The current memory.
2773 * @param *idx The ir_node that represents an index.
2774 * @param *lower The ir_node that represents the lower bound for the index.
2775 * @param *upper The ir_node that represents the upper bound for the index.
2777 ir_node *new_r_Bound(ir_graph *irg, ir_node *block,
2778 ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
2780 /** Constructor for a Pin node.
2782 * @param *irg The ir graph the node belong to.
2783 * @param *block The block the node belong to.
2784 * @param *node The node which value should be pinned.
2786 ir_node *new_r_Pin(ir_graph *irg, ir_node *block, ir_node *node);
2788 /** Constructor for an ASM pseudo node.
2790 * @param *irg The ir graph the node belong to.
2791 * @param *block The block the node belong to.
2792 * @param arity The number of data inputs to the node.
2793 * @param *in The array of length arity of data inputs.
2794 * @param *inputs The array of length arity of input constraints.
2795 * @param n_outs The number of data outputs to the node.
2796 * @param *outputs The array of length n_outs of output constraints.
2797 * @param n_clobber The number of clobbered registers.
2798 * @param *clobber The array of length n_clobber of clobbered registers.
2799 * @param *asm_text The assembler text.
2801 ir_node *new_r_ASM(ir_graph *irg, ir_node *block,
2802 int arity, ir_node *in[], ir_asm_constraint *inputs,
2803 int n_outs, ir_asm_constraint *outputs,
2804 int n_clobber, ident *clobber[], ident *asm_text);
2806 /*-----------------------------------------------------------------------*/
2807 /* The block oriented interface */
2808 /*-----------------------------------------------------------------------*/
2810 /** Sets the current block in which the following constructors place the
2811 * nodes they construct.
2813 * @param target The new current block.
2815 void set_cur_block (ir_node *target);
2817 /** Returns the current block of the current graph. */
2818 ir_node *get_cur_block(void);
2820 /** Returns the fixed nodes of the current graph. */
2821 #define get_cur_end_block() get_irg_end_block(current_ir_graph)
2822 #define get_cur_end() get_irg_end(current_ir_graph)
2823 #define get_cur_start_block() get_irg_start_block(current_ir_graph)
2824 #define get_cur_start() get_irg_start(current_ir_graph)
2826 /** Constructor for a Block node.
2828 * Adds the block to the graph in current_ir_graph. Constructs a Block
2829 * with a fixed number of predecessors. Does set current_block. Can
2830 * be used with automatic Phi node construction.
2832 * @param *db A Pointer for debug information.
2833 * @param arity The number of control predecessors.
2834 * @param in[] An array of control predecessors. The length of
2835 * the array must be 'arity'.
2837 ir_node *new_d_Block(dbg_info *db, int arity, ir_node *in[]);
2839 /** Constructor for a Start node.
2841 * Adds the node to the block in current_ir_block.
2843 * @param *db A pointer for debug information.
2845 ir_node *new_d_Start (dbg_info *db);
2847 /** Constructor for a End node.
2849 * Adds the node to the block in current_ir_block.
2851 * @param *db A pointer for debug information.
2853 ir_node *new_d_End (dbg_info *db);
2855 /** Constructor for a Jmp node.
2857 * Adds the node to the block in current_ir_block.
2859 * Jmp represents control flow to a single control successor.
2861 * @param *db A pointer for debug information.
2863 ir_node *new_d_Jmp (dbg_info *db);
2865 /** Constructor for an IJmp node.
2867 * IJmp represents control flow to a single control successor not
2868 * statically known i.e. an indirect Jmp.
2870 * @param *db A pointer for debug information.
2871 * @param *tgt The ir node representing the target address.
2873 ir_node *new_d_IJmp (dbg_info *db, ir_node *tgt);
2875 /** Constructor for a Cond node.
2877 * Adds the node to the block in current_ir_block.
2879 * If c is mode_b represents a conditional branch (if/else). If c is
2880 * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond
2881 * node, default Proj is 0.)
2883 * This is not consistent: Input to Cond is Is, Proj has as proj number
2886 * @param *db A pointer for debug information.
2887 * @param *c The conditions parameter.Can be of mode b or I_u.
2889 ir_node *new_d_Cond (dbg_info *db, ir_node *c);
2891 /** Constructor for a Return node.
2893 * Adds the node to the block in current_ir_block.
2895 * Returns the memory an zero or more return values. Only node that
2896 * can end regular control flow.
2898 * @param *db A pointer for debug information.
2899 * @param *store The state of memory.
2900 * @param arity Number of array indices.
2901 * @param *in Array with index inputs to the node.
2903 ir_node *new_d_Return (dbg_info *db, ir_node *store, int arity, ir_node *in[]);
2905 /** Constructor for a Const_type node.
2907 * Adds the node to the block in current_ir_block.
2909 * The constant represents a target value. This constructor sets high
2910 * level type information for the constant value.
2912 * @param *db A pointer for debug information.
2913 * @param *mode The mode of the operands and results.
2914 * @param *con Points to an entry in the constant table. This pointer is
2915 added to the attributes of the node.
2916 * @param *tp The type of the constant.
2918 ir_node *new_d_Const_type (dbg_info *db, ir_mode *mode, tarval *con, ir_type *tp);
2920 /** Constructor for a Const node.
2922 * Adds the node to the block in current_ir_block.
2924 * Constructor for a Const node. The constant represents a target
2925 * value. Sets the type information to type_unknown. (No more
2926 * supported: If tv is entity derives a somehow useful type.)
2928 * @param *db A pointer for debug information.
2929 * @param *mode The mode of the operands and results.
2930 * @param *con Points to an entry in the constant table. This pointer is added
2931 * to the attributes of the node.
2933 ir_node *new_d_Const (dbg_info *db, ir_mode *mode, tarval *con);
2935 /** Constructor for a SymConst_type node.
2937 * Adds the node to the block in current_ir_block.
2938 * This is the constructor for a symbolic constant.
2939 * There are four kinds of symbolic constants:
2940 * - type_tag The symbolic constant represents a type tag. The type the
2941 * tag stands for is given explicitly.
2942 * - size The symbolic constant represents the size of a type. The
2943 * type of which the constant represents the size is given
2945 * - addr_name The symbolic constant represents the address of an entity
2946 * (variable or method). The variable is indicated by a name
2947 * that is valid for linking.
2948 * - addr_ent The symbolic constant represents the address of an entity
2949 * (variable or method). The variable is given explicitly by
2952 * Inputs to the node:
2953 * No inputs except the block it belongs to.
2954 * Outputs of the node.
2955 * An unsigned integer (I_u) or a pointer (P).
2957 * @param *db A pointer for debug information.
2958 * @param value A type, entity or ident depending on the SymConst kind.
2959 * @param kind The kind of the symbolic constant: symconst_type_tag, symconst_type_size,
2960 * symconst_type_align, symconst_addr_name or symconst_addr_ent.
2961 * @param tp The source type of the constant.
2963 ir_node *new_d_SymConst_type (dbg_info *db, union symconst_symbol value, symconst_kind kind, ir_type *tp);
2965 /** Constructor for a SymConst node.
2967 * Same as new_d_SymConst_type, except that it sets the type to type_unknown. */
2968 ir_node *new_d_SymConst (dbg_info *db, union symconst_symbol value, symconst_kind kind);
2970 /** Constructor for a simpleSel node.
2972 * This is a shortcut for the new_d_Sel() constructor. To be used for
2973 * Sel nodes that do not select from an array, i.e., have no index
2974 * inputs. It adds the two parameters 0, NULL.
2976 * @param *db A pointer for debug information.
2977 * @param *store The memory in which the object the entity should be
2978 * selected from is allocated.
2979 * @param *objptr The object from that the Sel operation selects a
2980 * single attribute out.
2981 * @param *ent The entity to select.
2983 ir_node *new_d_simpleSel(dbg_info *db, ir_node *store, ir_node *objptr, ir_entity *ent);
2985 /** Constructor for a Sel node.
2987 * The select node selects an entity (field or method) from an entity
2988 * with a compound type. It explicitly specifies the entity selected.
2989 * Dynamically the node may select entities that overwrite the given
2990 * entity. If the selected entity is an array element entity the Sel
2991 * node takes the required array indices as inputs.
2992 * Adds the node to the block in current_ir_block.
2994 * @param *db A pointer for debug information.
2995 * @param *store The memory in which the object the entity should be selected
2996 * from is allocated.
2997 * @param *objptr A pointer to a compound entity the Sel operation selects a
2998 * single attribute from.
2999 * @param arity The number of array indices needed to select an array element entity.
3000 * @param *in[] If the compound entity is an array the indices of the selected
3001 * element entity. The constructor copies this array.
3002 * @param *ent The entity to select.
3004 ir_node *new_d_Sel (dbg_info *db, ir_node *store, ir_node *objptr, int arity, ir_node *in[],
3007 /** Constructor for a Call node.
3009 * Represents all kinds of method and function calls.
3010 * Adds the node to the block in current_ir_block.
3012 * @param *db A pointer for debug information.
3013 * @param *store The actual store.
3014 * @param *callee A pointer to the called procedure.
3015 * @param arity The number of procedure parameters.
3016 * @param *in[] An array with the pointers to the parameters. The constructor copies this array.
3017 * @param *tp Type information of the procedure called.
3019 ir_node *new_d_Call (dbg_info *db, ir_node *store, ir_node *callee, int arity, ir_node *in[],
3022 /** Constructor for a Add node.
3024 * Adds the node to the block in current_ir_block.
3026 * @param *db A pointer for debug information.
3027 * @param *op1 The first operand.
3028 * @param *op2 The second operand.
3029 * @param *mode The mode of the operands and the result.
3031 ir_node *new_d_Add (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3033 /** Constructor for a Sub node.
3035 * Adds the node to the block in current_ir_block.
3037 * @param *db A pointer for debug information.
3038 * @param *op1 The first operand.
3039 * @param *op2 The second operand.
3040 * @param *mode The mode of the operands and the result.
3042 ir_node *new_d_Sub (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3044 /** Constructor for a Minus node.
3046 * Adds the node to the block in current_ir_block.
3048 * @param *db A pointer for debug information.
3049 * @param *op The operand .
3050 * @param *mode The mode of the operand and the result.
3052 ir_node *new_d_Minus (dbg_info *db, ir_node *op, ir_mode *mode);
3054 /** Constructor for a Mul node.
3056 * Adds the node to the block in current_ir_block.
3058 * @param *db A pointer for debug information.
3059 * @param *op1 The first operand.
3060 * @param *op2 The second operand.
3061 * @param *mode The mode of the operands and the result.
3063 ir_node *new_d_Mul (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3065 /** Constructor for a Quot node.
3067 * Adds the node to the block in current_ir_block.
3069 * @param *db A pointer for debug information.
3070 * @param *memop The store needed to model exceptions
3071 * @param *op1 The first operand.
3072 * @param *op2 The second operand.
3073 * @param *mode The mode of the result.
3075 ir_node *new_d_Quot (dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
3077 /** Constructor for a DivMod node.
3079 * Adds the node to the block in current_ir_block.
3081 * @param *db A pointer for debug information.
3082 * @param *memop The store needed to model exceptions
3083 * @param *op1 The first operand.
3084 * @param *op2 The second operand.
3085 * @param *mode The mode of the results.
3087 ir_node *new_d_DivMod (dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
3089 /** Constructor for a Div node.
3091 * Adds the node to the block in current_ir_block.
3093 * @param *db A pointer for debug information.
3094 * @param *memop The store needed to model exceptions
3095 * @param *op1 The first operand.
3096 * @param *op2 The second operand.
3097 * @param *mode The mode of the result.
3099 ir_node *new_d_Div (dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
3101 /** Constructor for a Mod node.
3103 * Adds the node to the block in current_ir_block.
3105 * @param *db A pointer for debug information.
3106 * @param *memop The store needed to model exceptions
3107 * @param *op1 The first operand.
3108 * @param *op2 The second operand.
3109 * @param *mode The mode of the result.
3111 ir_node *new_d_Mod (dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
3113 /** Constructor for a Abs node.
3115 * Adds the node to the block in current_ir_block.
3117 * @param *db A pointer for debug information.
3118 * @param *op The operand
3119 * @param *mode The mode of the operands and the result.
3121 ir_node *new_d_Abs (dbg_info *db, ir_node *op, ir_mode *mode);
3123 /** Constructor for a And node.
3125 * Adds the node to the block in current_ir_block.
3127 * @param *db A pointer for debug information.
3128 * @param *op1 The first operand.
3129 * @param *op2 The second operand.
3130 * @param *mode The mode of the operands and the result.
3132 ir_node *new_d_And (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3134 /** Constructor for a Or node.
3136 * Adds the node to the block in current_ir_block.
3138 * @param *db A pointer for debug information.
3139 * @param *op1 The first operand.
3140 * @param *op2 The second operand.
3141 * @param *mode The mode of the operands and the result.
3143 ir_node *new_d_Or (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3145 /** Constructor for a Eor node.
3147 * Adds the node to the block in current_ir_block.
3149 * @param *db A pointer for debug information.
3150 * @param *op1 The first operand.
3151 * @param *op2 The second operand.
3152 * @param *mode The mode of the operands and the results.
3154 ir_node *new_d_Eor (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3156 /** Constructor for a Not node.
3158 * Adds the node to the block in current_ir_block.
3160 * @param *db A pointer for debug information.
3161 * @param *op The operand.
3162 * @param *mode The mode of the operand and the result.
3164 ir_node *new_d_Not (dbg_info *db, ir_node *op, ir_mode *mode);
3166 /** Constructor for a Shl node.
3168 * Adds the node to the block in current_ir_block.
3170 * @param *db A pointer for debug information.
3171 * @param *op The operand.
3172 * @param *k The number of bits to shift the operand .
3173 * @param *mode The mode of the operand and the result.
3175 ir_node *new_d_Shl (dbg_info *db, ir_node *op, ir_node *k, ir_mode *mode);
3177 /** Constructor for a Shr node.
3179 * Adds the node to the block in current_ir_block.
3181 * @param *db A pointer for debug information.
3182 * @param *op The operand.
3183 * @param *k The number of bits to shift the operand .
3184 * @param *mode The mode of the operand and the result.
3186 ir_node *new_d_Shr (dbg_info *db, ir_node *op, ir_node *k, ir_mode *mode);
3188 /** Constructor for a Shrs node.
3190 * Adds the node to the block in current_ir_block.
3192 * @param *db A pointer for debug information.
3193 * @param *op The operand.
3194 * @param *k The number of bits to shift the operand .
3195 * @param *mode The mode of the operand and the result.
3197 ir_node *new_d_Shrs (dbg_info *db, ir_node *op, ir_node *k, ir_mode *mode);
3199 /** Constructor for a Rot node.
3201 * Adds the node to the block in current_ir_block.
3203 * @param *db A pointer for debug information.
3204 * @param *op The operand.
3205 * @param *k The number of bits to rotate the operand.
3206 * @param *mode The mode of the operand.
3208 ir_node *new_d_Rot (dbg_info *db, ir_node *op, ir_node *k, ir_mode *mode);
3210 /** Constructor for a Cmp node.
3212 * Adds the node to the block in current_ir_block.
3214 * @param *db A pointer for debug information.
3215 * @param *op1 The first operand.
3216 * @param *op2 The second operand.
3218 ir_node *new_d_Cmp (dbg_info *db, ir_node *op1, ir_node *op2);
3220 /** Constructor for a Conv node.
3222 * Adds the node to the block in current_ir_block.
3224 * @param *db A pointer for debug information.
3225 * @param *op The operand.
3226 * @param *mode The mode of this the operand muss be converted .
3228 ir_node *new_d_Conv (dbg_info *db, ir_node *op, ir_mode *mode);
3230 /** Constructor for a strict Conv node.
3232 * Adds the node to the block in current_ir_block.
3234 * @param *db A pointer for debug information.
3235 * @param *op The operand.
3236 * @param *mode The mode of this the operand muss be converted .
3238 ir_node *new_d_strictConv (dbg_info *db, ir_node *op, ir_mode *mode);
3240 /** Constructor for a Cast node.
3242 * High level type cast
3243 * Adds the node to the block in current_ir_block.
3245 * @param *db A pointer for debug information.
3246 * @param *op The operand.
3247 * @param *to_tp The type of this the operand muss be casted .
3249 ir_node *new_d_Cast (dbg_info *db, ir_node *op, ir_type *to_tp);
3251 /** Constructor for a Carry node.
3253 * Adds the node to the block in current_ir_block.
3255 * @param *db A pointer for debug information.
3256 * @param *op1 The first operand.
3257 * @param *op2 The second operand.
3258 * @param *mode The mode of the operands and the result.
3260 ir_node *new_d_Carry (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3262 /** Constructor for a Borrow node.
3264 * Adds the node to the block in current_ir_block.
3266 * @param *db A pointer for debug information.
3267 * @param *op1 The first operand.
3268 * @param *op2 The second operand.
3269 * @param *mode The mode of the operands and the result.
3271 ir_node *new_d_Borrow (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3273 /** Constructor for a Phi node.
3275 * Adds the node to the block in current_ir_block.
3277 * @param *db A pointer for debug information.
3278 * @param arity The number of predecessors
3279 * @param *in Array with predecessors
3280 * @param *mode The mode of it's inputs and output.
3282 ir_node *new_d_Phi (dbg_info *db, int arity, ir_node *in[], ir_mode *mode);
3284 /** Constructor for a Load node.
3286 * Adds the node to the block in current_ir_block.
3288 * @param *db A pointer for debug information.
3289 * @param *store The current memory
3290 * @param *addr A pointer to the variable to be read in this memory.
3291 * @param *mode The mode of the value to be loaded.
3293 ir_node *new_d_Load (dbg_info *db, ir_node *store, ir_node *addr, ir_mode *mode);
3295 /** Constructor for a Store node.
3297 * Adds the node to the block in current_ir_block.
3299 * @param *db A pointer for debug information.
3300 * @param *store The current memory
3301 * @param *addr A pointer to the variable to be read in this memory.
3302 * @param *val The value to write to this variable.
3304 ir_node *new_d_Store (dbg_info *db, ir_node *store, ir_node *addr, ir_node *val);
3306 /** Constructor for a Alloc node.
3308 * The Alloc node extends the memory by space for an entity of type alloc_type.
3309 * Adds the node to the block in current_ir_block.
3311 * @param *db A pointer for debug information.
3312 * @param *store The memory which shall contain the new variable.
3313 * @param *size The number of bytes to allocate.
3314 * @param *alloc_type The type of the allocated variable.
3315 * @param where Where to allocate the variable, either heap_alloc or stack_alloc.
3317 ir_node *new_d_Alloc (dbg_info *db, ir_node *store, ir_node *size, ir_type *alloc_type,
3320 /** Constructor for a Free node.
3322 * Frees the memory occupied by the entity pointed to by the pointer
3323 * arg. Type indicates the type of the entity the argument points to.
3324 * Adds the node to the block in current_ir_block.
3326 * @param *db A pointer for debug information.
3327 * @param *store The memory which shall contain the new variable.
3328 * @param *ptr The pointer to the object to free.
3329 * @param *size The number of objects of type free_type to free in a sequence.
3330 * @param *free_type The type of the freed variable.
3331 * @param where Where the variable was allocated, either heap_alloc or stack_alloc.
3333 ir_node *new_d_Free (dbg_info *db, ir_node *store, ir_node *ptr, ir_node *size,
3334 ir_type *free_type, where_alloc where);
3336 /** Constructor for a Sync node.
3338 * Merges several memory values. The node assumes that a variable
3339 * either occurs only in one of the memories, or it contains the same
3340 * value in all memories where it occurs.
3341 * Adds the node to the block in current_ir_block.
3343 * @param *db A pointer for debug information.
3344 * @param arity The number of memories to synchronize.
3345 * @param **in An array of pointers to nodes that produce an output of type
3346 * memory. The constructor copies this array.
3348 ir_node *new_d_Sync (dbg_info *db, int arity, ir_node *in[]);
3350 /** Constructor for a Proj node.
3352 * Projects a single value out of a tuple. The parameter proj gives the
3353 * position of the value within the tuple.
3354 * Adds the node to the block in current_ir_block.
3356 * @param *db A pointer for deubug information.
3357 * @param arg A node producing a tuple.
3358 * @param *mode The mode of the value to project.
3359 * @param proj The position of the value in the tuple.
3361 ir_node *new_d_Proj (dbg_info *db, ir_node *arg, ir_mode *mode, long proj);
3363 /** Constructor for a defaultProj node.
3365 * Represents the default control flow of a Switch-Cond node.
3366 * Adds the node to the block in current_ir_block.
3368 * @param *db A pointer for debug information.
3369 * @param arg A node producing a tuple.
3370 * @param max_proj The end position of the value in the tuple.
3372 ir_node *new_d_defaultProj (dbg_info *db, ir_node *arg, long max_proj);
3374 /** Constructor for a Tuple node.
3376 * This is an auxiliary node to replace a node that returns a tuple
3377 * without changing the corresponding Proj nodes.
3378 * Adds the node to the block in current_ir_block.
3380 * @param *db A pointer for debug information.
3381 * @param arity The number of tuple elements.
3382 * @param **in An array containing pointers to the nodes producing the tuple elements.
3384 ir_node *new_d_Tuple (dbg_info *db, int arity, ir_node *in[]);
3386 /** Constructor for a Id node.
3388 * This is an auxiliary node to replace a node that returns a single
3389 * value. Adds the node to the block in current_ir_block.
3391 * @param *db A pointer for debug information.
3392 * @param *val The operand to Id.
3393 * @param *mode The mode of *val.
3395 ir_node *new_d_Id (dbg_info *db, ir_node *val, ir_mode *mode);
3397 /** Constructor for a Bad node.
3399 * Returns the unique Bad node of the graph. The same as
3402 ir_node *new_d_Bad (void);
3404 /** Constructor for a Confirm node.
3406 * Constructor for a Confirm node. Adds the node to the block in current_ir_block.
3407 * Specifies constraints for a value. To support dataflow analyses.
3409 * Example: If the value never exceeds '100' this is expressed by placing a
3410 * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge.
3412 * @param *db A pointer for debug information.
3413 * @param *val The value we express a constraint for
3414 * @param *bound The value to compare against. Must be a firm node, typically a constant.
3415 * @param cmp The compare operation.
3417 ir_node *new_d_Confirm (dbg_info *db, ir_node *val, ir_node *bound, pn_Cmp cmp);
3419 /** Constructor for an Unknown node.
3421 * Represents an arbitrary value. Places the node in
3424 * @param *m The mode of the unknown value.
3426 ir_node *new_d_Unknown(ir_mode *m);
3428 /** Constructor for a CallBegin node.
3430 * CallBegin represents control flow depending of the pointer value
3431 * representing the called method to the called methods. The
3432 * constructor copies the method pointer input from the passed Call
3433 * node.Adds the node to the block in current_ir_block.
3435 * @param *db A pointer for debug information.
3436 * @param *callee The call node visible in the intra procedural view.
3438 ir_node *new_d_CallBegin(dbg_info *db, ir_node *callee);
3440 /** Constructor for an EndReg node.
3442 *Adds the node to the block in current_ir_block.
3444 * @param *db A pointer for debug information.
3446 ir_node *new_d_EndReg (dbg_info *db);
3448 /** Constructor for an EndExcept node.
3450 * Used to represent regular procedure end in interprocedual view.
3451 * Adds the node to the block in current_ir_block.
3453 * @param *db A pointer for debug information.
3455 ir_node *new_d_EndExcept(dbg_info *db);
3457 /** Constructor for a Break node.
3459 * Used to represent exceptional procedure end in interprocedural view.
3460 * Adds the node to the block in current_ir_block.
3462 * Break represents control flow to a single control successor just as Jmp.
3463 * The blocks separated by a break may not be concatenated by an optimization.
3464 * It is used for the interprocedural representation where blocks are parted
3465 * behind Call nodes to represent the control flow to called procedures.
3467 * @param *db A pointer for debug information.
3469 ir_node *new_d_Break (dbg_info *db);
3471 /** Constructor for a Filter node.
3473 * Constructor for a Filter node. Adds the node to the block in
3474 * current_ir_block. Filter is a node with two views used to
3475 * construct the interprocedural view. In intraprocedural view its
3476 * semantics are identical to the Proj node. In interprocedural view
3477 * the Filter performs the Phi operation on method parameters or
3478 * results. Other than a Phi a Filter node may not be removed if it
3479 * has only a single input.
3481 * The constructor builds the Filter in intraprocedural view.
3483 * @param *db A pointer for debug information.
3484 * @param *arg The tuple value to project from.
3485 * @param *mode The mode of the projected value.
3486 * @param proj The position in the tuple to project from.
3488 ir_node *new_d_Filter (dbg_info *db, ir_node *arg, ir_mode *mode, long proj);
3491 /** Constructor for a NoMem node.
3493 * Returns the unique NoMem node of the graph. The same as
3496 ir_node *new_d_NoMem (void);
3498 /** Constructor for a Mux node.
3500 * @param *db A pointer for debug information.
3501 * @param *sel The ir_node that calculates the boolean select.
3502 * @param *ir_true The ir_node that calculates the true result.
3503 * @param *ir_false The ir_node that calculates the false result.
3504 * @param *mode The mode of the node (and it_true and ir_false).
3506 ir_node *new_d_Mux (dbg_info *db, ir_node *sel,
3507 ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
3509 /** Constructor for a Psi node.
3511 * @param *db A pointer for debug information.
3512 * @param *arity The arity of the conditions
3513 * @param *conds The array of mode_b conditions, length must be equal arity
3514 * @param *vals The array of mode values, length must be equal arity + 1
3515 * @param *mode The mode of the node (must be the mode of all vals).
3517 ir_node *new_d_Psi (dbg_info *db,
3518 int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode);
3520 /** Constructor for a CopyB node.
3522 * @param *db A pointer for debug information.
3523 * @param *store The current memory
3524 * @param *dst The ir_node that represents the destination address.
3525 * @param *src The ir_node that represents the source address.
3526 * @param *data_type The type of the copied data
3528 ir_node *new_d_CopyB(dbg_info *db, ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
3530 /** Constructor for a InstOf node.
3532 * A High-Level Type check.
3534 * @param *db A pointer for debug information.
3535 * @param *store The memory in which the object the entity should be selected
3536 * from is allocated.
3537 * @param *objptr A pointer to a object of a class type.
3538 * @param *type The type of which objptr must be.
3540 ir_node *new_d_InstOf (dbg_info *db, ir_node *store, ir_node *objptr, ir_type *type);
3542 /** Constructor for a Raise node.
3544 * A High-Level Exception throw.
3546 * @param *db A pointer for debug information.
3547 * @param *store The current memory.
3548 * @param *obj A pointer to the Except variable.
3550 ir_node *new_d_Raise (dbg_info *db, ir_node *store, ir_node *obj);
3552 /** Constructor for a Bound node.
3554 * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
3556 * @param *db A pointer for debug information.
3557 * @param *store The current memory
3558 * @param *idx The ir_node that represents an index.
3559 * @param *lower The ir_node that represents the lower bound for the index.
3560 * @param *upper The ir_node that represents the upper bound for the index.
3562 ir_node *new_d_Bound(dbg_info *db, ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
3564 /** Constructor for a Pin node.
3566 * @param *db A pointer for debug information.
3567 * @param *node The node which value should be pinned.
3569 ir_node *new_d_Pin(dbg_info *db, ir_node *node);
3571 /** Constructor for an ASM pseudo node.
3573 * @param *db A pointer for debug information.
3574 * @param arity The number of data inputs to the node.
3575 * @param *in The array of length arity of data inputs.
3576 * @param *inputs The array of length arity of input constraints.
3577 * @param n_outs The number of data outputs to the node.
3578 * @param *outputs The array of length n_outs of output constraints.
3579 * @param n_clobber The number of clobbered registers.
3580 * @param *clobber The array of length n_clobber of clobbered registers.
3581 * @param *asm_text The assembler text.
3583 ir_node *new_d_ASM(dbg_info *db, int arity, ir_node *in[], ir_asm_constraint *inputs,
3584 int n_outs, ir_asm_constraint *outputs,
3585 int n_clobber, ident *clobber[], ident *asm_text);
3587 /*-----------------------------------------------------------------------*/
3588 /* The block oriented interface without debug support */
3589 /*-----------------------------------------------------------------------*/
3591 /* Needed from the interface with debug support:
3592 void set_cur_block (ir_node *target); */
3594 /** Constructor for a Block node.
3596 * Constructor for a Block node. Adds the block to the graph in
3597 * current_ir_graph. Constructs a Block with a fixed number of
3598 * predecessors. Does set current_block. Can be used with automatic
3599 * Phi node construction.
3601 * @param arity The number of control predecessors.
3602 * @param in An array of control predecessors. The length of
3603 * the array must be 'arity'.
3605 ir_node *new_Block(int arity, ir_node *in[]);
3607 /** Constructor for a Start node.
3609 * Adds the node to the block in current_ir_block.
3612 ir_node *new_Start (void);
3614 /** Constructor for an End node.
3616 * Adds the node to the block in current_ir_block.
3618 ir_node *new_End (void);
3620 /** Constructor for an EndReg node.
3622 * Used to represent regular procedure end in interprocedual view.
3623 * Adds the node to the block in current_ir_block.
3625 ir_node *new_EndReg (void);
3627 /** Constructor for an EndExpcept node.
3629 * Used to represent exceptional procedure end in interprocedural view.
3630 * Adds the node to the block in current_ir_block.
3632 ir_node *new_EndExcept(void);
3634 /** Constructor for a Jump node.
3636 * Adds the node to the block in current_ir_block.
3638 * Jmp represents control flow to a single control successor.
3640 ir_node *new_Jmp (void);
3642 /** Constructor for an IJmp node.
3644 * IJmp represents control flow to a single control successor not
3645 * statically known i.e. an indirect Jmp.
3647 * @param *tgt The ir node representing the target address.
3649 ir_node *new_IJmp (ir_node *tgt);
3651 /** Constructor for a Break node.
3652 * Break represents control flow to a single control successor just as Jmp.
3653 * The blocks separated by a break may not be concatenated by an optimization.
3654 * It is used for the interprocedural representation where blocks are parted
3655 * behind Call nodes to represent the control flow to called procedures.
3656 * Adds the node to the block in current_ir_block.
3658 ir_node *new_Break (void);
3660 /** Constructor for a Cond node.
3662 * If c is mode_b represents a conditional branch (if/else). If c is
3663 * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond
3664 * node, default Proj is 0.). Adds the node to the block in current_ir_block.
3666 * This is not consistent: Input to Cond is Is, Proj has as proj number
3670 * @param *c The conditions parameter.Can be of mode b or I_u.
3672 ir_node *new_Cond (ir_node *c);
3674 /** Constructor for a Return node.
3676 * Returns the memory an zero or more return values. Only node that
3677 * can end regular control flow. Adds the node to the block in current_ir_block.
3679 * @param *store The state of memory.
3680 * @param arity Number of array indices.
3681 * @param *in Array with index inputs to the node.
3683 ir_node *new_Return (ir_node *store, int arity, ir_node *in[]);
3685 /** Constructor for a Const node.
3687 * Constructor for a Const node. The constant represents a target
3688 * value. Sets the type information to type_unknown. (No more
3689 * supported: If tv is entity derives a somehow useful type.)
3690 * Adds the node to the block in current_ir_block.
3692 * @param *mode The mode of the operands and results.
3693 * @param *con Points to an entry in the constant table. This pointer is
3694 * added to the attributes of the node.
3696 ir_node *new_Const (ir_mode *mode, tarval *con);
3699 * Make a const from a long.
3700 * This is just convenience for the usual
3702 * new_Const(mode, tarval_from_long(mode, ...))
3705 * @param mode The mode for the const.
3706 * @param value The value of the constant.
3707 * @return A new const node.
3709 ir_node *new_Const_long(ir_mode *mode, long value);
3711 /** Constructor for a Const node.
3713 * Derives mode from passed type. */
3714 ir_node *new_Const_type(tarval *con, ir_type *tp);
3716 /** Constructor for a SymConst node.
3718 * Adds the node to the block in current_ir_block.
3719 * This is the constructor for a symbolic constant.
3720 * There are four kinds of symbolic constants:
3721 * -# type_tag The symbolic constant represents a type tag. The type the
3722 * tag stands for is given explicitly.
3723 * -# size The symbolic constant represents the size of a type. The
3724 * type of which the constant represents the size is given
3726 * -# align The symbolic constant represents the alignment of a type. The
3727 * type of which the constant represents the size is given
3729 * -# addr_name The symbolic constant represents the address of an entity
3730 * (variable or method). The variable is indicated by a name
3731 * that is valid for linking.
3732 * -# addr_ent The symbolic constant represents the address of an entity
3733 * (variable or method). The variable is given explicitly by
3736 * Inputs to the node:
3737 * No inputs except the block it belongs to.
3738 * Outputs of the node.
3739 * An unsigned integer (I_u) or a pointer (P).
3741 * @param value A type or a ident depending on the SymConst kind.
3742 * @param kind The kind of the symbolic constant: symconst_type_tag, symconst_type_size
3743 * symconst_type_align, symconst_addr_name or symconst_addr_ent.
3744 * @param tp The source type of the constant.
3746 ir_node *new_SymConst_type (union symconst_symbol value, symconst_kind kind, ir_type *tp);
3748 /** Constructor for a SymConst node.
3750 * Adds the node to the block in current_ir_block.
3751 * This is the constructor for a symbolic constant.
3752 * There are four kinds of symbolic constants:
3753 * -# type_tag The symbolic constant represents a type tag. The type the
3754 * tag stands for is given explicitly.
3755 * -# size The symbolic constant represents the size of a type. The
3756 * type of which the constant represents the size is given
3758 * -# align The symbolic constant represents the alignment of a type. The
3759 * type of which the constant represents the size is given
3761 * -# addr_name The symbolic constant represents the address of an entity
3762 * (variable or method). The variable is indicated by a name
3763 * that is valid for linking.
3764 * -# addr_ent The symbolic constant represents the address of an entity
3765 * (variable or method). The variable is given explicitly by
3768 * Inputs to the node:
3769 * No inputs except the block it belongs to.
3770 * Outputs of the node.
3771 * An unsigned integer (I_u) or a pointer (P).
3773 * @param value A type or a ident depending on the SymConst kind.
3774 * @param kind The kind of the symbolic constant: symconst_type_tag, symconst_type_size
3775 * symconst_type_align, symconst_addr_name or symconst_addr_ent.
3777 ir_node *new_SymConst (union symconst_symbol value, symconst_kind kind);
3779 /** Constructor for a simpelSel node.
3781 * This is a shortcut for the new_Sel() constructor. To be used for
3782 * Sel nodes that do not select from an array, i.e., have no index
3783 * inputs. It adds the two parameters 0, NULL.
3785 * @param *store The memory in which the object the entity should be selected from is allocated.
3786 * @param *objptr The object from that the Sel operation selects a single attribute out.
3787 * @param *ent The entity to select.
3789 ir_node *new_simpleSel(ir_node *store, ir_node *objptr, ir_entity *ent);
3791 /** Constructor for a Sel node.
3793 * The select node selects an entity (field or method) from an entity
3794 * with a compound type. It explicitly specifies the entity selected.
3795 * Dynamically the node may select entities that overwrite the given
3796 * entity. If the selected entity is an array element entity the Sel
3797 * node takes the required array indices as inputs.
3798 * Adds the node to the block in current_ir_block.
3800 * @param *store The memory in which the object the entity should be selected
3801 * from is allocated.
3802 * @param *objptr A pointer to a compound entity the Sel operation selects a
3803 * single attribute from.
3804 * @param arity The number of array indices needed to select an array element entity.
3805 * @param *in[] If the compound entity is an array the indices of the selected
3806 * element entity. The constructor copies this array.
3807 * @param *ent The entity to select.
3809 ir_node *new_Sel (ir_node *store, ir_node *objptr, int arity, ir_node *in[],
3812 /** Constructor for a Call node.
3814 * Adds the node to the block in current_ir_block.
3815 * Represents all kinds of method and function calls.
3817 * @param *store The actual store.
3818 * @param *callee A pointer to the called procedure.
3819 * @param arity The number of procedure parameters.
3820 * @param *in[] An array with the pointers to the parameters. The constructor copies this array.
3821 * @param *tp Type information of the procedure called.
3823 ir_node *new_Call (ir_node *store, ir_node *callee, int arity, ir_node *in[],
3826 /** Constructor for a CallBegin node.
3828 * CallBegin represents control flow depending of the pointer value
3829 * representing the called method to the called methods. The
3830 * constructor copies the method pointer input from the passed Call
3831 * node. Adds the node to the block in current_ir_block.
3833 * @param *callee A pointer to the called procedure.
3835 ir_node *new_CallBegin(ir_node *callee);
3837 /** Constructor for a Add node.
3839 * Adds the node to the block in current_ir_block.
3841 * @param *op1 The first operand.
3842 * @param *op2 The second operand.
3843 * @param *mode The mode of the operands and the result.
3845 ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode);
3847 /** Constructor for a Sub node.
3849 * Adds the node to the block in current_ir_block.
3851 * @param *op1 The first operand.
3852 * @param *op2 The second operand.
3853 * @param *mode The mode of the operands and the result.
3855 ir_node *new_Sub (ir_node *op1, ir_node *op2, ir_mode *mode);
3857 /** Constructor for a Minus node.
3859 * Adds the node to the block in current_ir_block.
3861 * @param *op The operand .
3862 * @param *mode The mode of the operand and the result.
3864 ir_node *new_Minus (ir_node *op, ir_mode *mode);
3867 * Constructor for a Mul node. Adds the node to the block in current_ir_block.
3869 * @param *op1 The first operand.
3870 * @param *op2 The second operand.
3871 * @param *mode The mode of the operands and the result.
3873 ir_node *new_Mul (ir_node *op1, ir_node *op2, ir_mode *mode);
3875 /** Constructor for a Quot node.
3877 * Adds the node to the block in current_ir_block.
3879 * @param *memop The store needed to model exceptions
3880 * @param *op1 The first operand.
3881 * @param *op2 The second operand.
3882 * @param *mode The mode of the result.
3884 ir_node *new_Quot (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
3886 /** Constructor for a DivMod node.
3888 * Adds the node to the block in current_ir_block.
3890 * @param *memop The store needed to model exceptions
3891 * @param *op1 The first operand.
3892 * @param *op2 The second operand.
3893 * @param *mode The mode of the results.
3895 ir_node *new_DivMod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
3897 /** Constructor for a Div node.
3899 * Adds the node to the block in current_ir_block.
3901 * @param *memop The store needed to model exceptions
3902 * @param *op1 The first operand.
3903 * @param *op2 The second operand.
3904 * @param *mode The mode of the result.
3906 ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
3908 /** Constructor for a Mod node.
3910 * Adds the node to the block in current_ir_block.
3912 * @param *memop The store needed to model exceptions
3913 * @param *op1 The first operand.
3914 * @param *op2 The second operand.
3915 * @param *mode The mode of the result.
3917 ir_node *new_Mod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode);
3919 /** Constructor for a Abs node.
3921 * Adds the node to the block in current_ir_block.
3923 * @param *op The operand
3924 * @param *mode The mode of the operands and the result.
3926 ir_node *new_Abs (ir_node *op, ir_mode *mode);
3928 /** Constructor for a And node.
3930 * Adds the node to the block in current_ir_block.
3932 * @param *op1 The first operand.
3933 * @param *op2 The second operand.
3934 * @param *mode The mode of the operands and the result.
3936 ir_node *new_And (ir_node *op1, ir_node *op2, ir_mode *mode);
3939 * Constructor for a Or node. Adds the node to the block in current_ir_block.
3941 * @param *op1 The first operand.
3942 * @param *op2 The second operand.
3943 * @param *mode The mode of the operands and the result.
3945 ir_node *new_Or (ir_node *op1, ir_node *op2, ir_mode *mode);
3948 * Constructor for a Eor node. Adds the node to the block in current_ir_block.
3950 * @param *op1 The first operand.
3951 * @param *op2 The second operand.
3952 * @param *mode The mode of the operands and the results.
3954 ir_node *new_Eor (ir_node *op1, ir_node *op2, ir_mode *mode);
3956 /** Constructor for a Not node.
3958 * Adds the node to the block in current_ir_block.
3960 * @param *op The operand.
3961 * @param *mode The mode of the operand and the result.
3963 ir_node *new_Not (ir_node *op, ir_mode *mode);
3965 /** Constructor for a Shl node.
3967 * Adds the node to the block in current_ir_block.
3969 * @param *op The operand.
3970 * @param *k The number of bits to shift the operand .
3971 * @param *mode The mode of the operand and the result.
3973 ir_node *new_Shl (ir_node *op, ir_node *k, ir_mode *mode);
3976 * Constructor for a Shr node. Adds the node to the block in current_ir_block.
3978 * @param *op The operand.
3979 * @param *k The number of bits to shift the operand .
3980 * @param *mode The mode of the operand and the result.
3982 ir_node *new_Shr (ir_node *op, ir_node *k, ir_mode *mode);
3984 /** Constructor for a Shrs node.
3986 * Adds the node to the block in current_ir_block.
3988 * @param *op The operand.
3989 * @param *k The number of bits to shift the operand .
3990 * @param *mode The mode of the operand and the result.
3992 ir_node *new_Shrs (ir_node *op, ir_node *k, ir_mode *mode);
3994 /** Constructor for a Rot node.
3996 * Adds the node to the block in current_ir_block.
3998 * @param *op The operand.
3999 * @param *k The number of bits to rotate the operand.
4000 * @param *mode The mode of the operand.
4002 ir_node *new_Rot (ir_node *op, ir_node *k, ir_mode *mode);
4004 /** Constructor for a Cmp node.
4006 * Adds the node to the block in current_ir_block.
4008 * @param *op1 The first operand.
4009 * @param *op2 The second operand.
4011 ir_node *new_Cmp (ir_node *op1, ir_node *op2);
4013 /** Constructor for a Conv node.
4015 * Adds the node to the block in current_ir_block.
4017 * @param *op The operand.
4018 * @param *mode The mode of this the operand muss be converted.
4020 ir_node *new_Conv (ir_node *op, ir_mode *mode);
4022 /** Constructor for a strict Conv node.
4024 * Adds the node to the block in current_ir_block.
4026 * @param *op The operand.
4027 * @param *mode The mode of this the operand muss be converted.
4029 ir_node *new_strictConv (ir_node *op, ir_mode *mode);
4031 /** Constructor for a Cast node.
4033 * Adds the node to the block in current_ir_block.
4034 * High level type cast
4036 * @param *op The operand.
4037 * @param *to_tp The type of this the operand muss be casted .
4039 ir_node *new_Cast (ir_node *op, ir_type *to_tp);
4041 /** Constructor for a Carry node.
4043 * Adds the node to the block in current_ir_block.
4045 * @param *op1 The first operand.
4046 * @param *op2 The second operand.
4047 * @param *mode The mode of the operands and the result.
4049 ir_node *new_Carry (ir_node *op1, ir_node *op2, ir_mode *mode);
4051 /** Constructor for a Borrow node.
4053 * Adds the node to the block in current_ir_block.
4055 * @param *op1 The first operand.
4056 * @param *op2 The second operand.
4057 * @param *mode The mode of the operands and the result.
4059 ir_node *new_Borrow (ir_node *op1, ir_node *op2, ir_mode *mode);
4061 /** Constructor for a Phi node.
4063 * Adds the node to the block in current_ir_block.
4065 * @param arity The number of predecessors.
4066 * @param *in Array with predecessors.
4067 * @param *mode The mode of it's inputs and output.
4069 ir_node *new_Phi (int arity, ir_node *in[], ir_mode *mode);
4071 /** Constructor for a Load node.
4073 * @param *store The current memory.
4074 * @param *addr A pointer to the variable to be read in this memory.
4075 * @param *mode The mode of the value to be loaded.
4077 ir_node *new_Load (ir_node *store, ir_node *addr, ir_mode *mode);
4079 /** Constructor for a Store node.
4081 * @param *store The current memory.
4082 * @param *addr A pointer to the variable to be read in this memory.
4083 * @param *val The value to write to this variable.
4085 ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val);
4087 /** Constructor for a Alloc node.
4089 * The Alloc node extends the memory by space for an entity of type alloc_type.
4090 * Adds the node to the block in current_ir_block.
4092 * @param *store The memory which shall contain the new variable.
4093 * @param *size The number of bytes to allocate.
4094 * @param *alloc_type The type of the allocated variable.
4095 * @param where Where to allocate the variable, either heap_alloc or stack_alloc.
4097 ir_node *new_Alloc (ir_node *store, ir_node *size, ir_type *alloc_type,
4100 /** Constructor for a Free node.
4102 * Frees the memory occupied by the entity pointed to by the pointer
4103 * arg. Type indicates the type of the entity the argument points to.
4104 * Adds the node to the block in current_ir_block.
4106 * @param *store The memory which shall contain the new variable.
4107 * @param *ptr The pointer to the object to free.
4108 * @param *size The number of objects of type free_type to free in a sequence.
4109 * @param *free_type The type of the freed variable.
4110 * @param where Where the variable was allocated, either heap_alloc or stack_alloc.
4112 ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size,
4113 ir_type *free_type, where_alloc where);
4115 /** Constructor for a Sync node.
4117 * Merges several memory values. The node assumes that a variable
4118 * either occurs only in one of the memories, or it contains the same
4119 * value in all memories where it occurs.
4120 * Adds the node to the block in current_ir_block.
4122 * @param arity The number of memories to synchronize.
4123 * @param **in An array of pointers to nodes that produce an output of type
4124 * memory. The constructor copies this array.
4126 ir_node *new_Sync (int arity, ir_node *in[]);
4128 /** Constructor for a Proj node.
4130 * Projects a single value out of a tuple. The parameter proj gives the
4131 * position of the value within the tuple.
4132 * Adds the node to the block in current_ir_block.
4134 * @param arg A node producing a tuple.
4135 * @param *mode The mode of the value to project.
4136 * @param proj The position of the value in the tuple.
4138 ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj);
4140 /** Constructor for a Filter node.
4142 * Constructor for a Filter node. Adds the node to the block in current_ir_block.
4143 * Filter is a node with two views used to construct the interprocedural view.
4144 * In intraprocedural view its semantics are identical to the Proj node.
4145 * In interprocedural view the Filter performs the Phi operation on method
4146 * parameters or results. Other than a Phi a Filter node may not be removed
4147 * if it has only a single input.
4149 * The constructor builds the Filter in intraprocedural view.
4151 * @param *arg The tuple value to project from.
4152 * @param *mode The mode of the projected value.
4153 * @param proj The position in the tuple to project from.
4155 ir_node *new_Filter (ir_node *arg, ir_mode *mode, long proj);
4157 /** Constructor for a defaultProj node.
4159 * Represents the default control flow of a Switch-Cond node.
4160 * Adds the node to the block in current_ir_block.
4162 * @param arg A node producing a tuple.
4163 * @param max_proj The end position of the value in the tuple.
4165 ir_node *new_defaultProj (ir_node *arg, long max_proj);
4167 /** Constructor for a Tuple node.
4169 * This is an auxiliary node to replace a node that returns a tuple
4170 * without changing the corresponding Proj nodes.
4171 * Adds the node to the block in current_ir_block.
4173 * @param arity The number of tuple elements.
4174 * @param **in An array containing pointers to the nodes producing the tuple elements.
4176 ir_node *new_Tuple (int arity, ir_node *in[]);
4178 /** Constructor for an Id node.
4180 * This is an auxiliary node to replace a node that returns a single
4181 * value. Adds the node to the block in current_ir_block.
4183 * @param *val The operand to Id.
4184 * @param *mode The mode of *val.
4186 ir_node *new_Id (ir_node *val, ir_mode *mode);
4188 /** Constructor for a Bad node.
4190 * Returns the unique Bad node of the graph. The same as
4193 ir_node *new_Bad (void);
4195 /** Constructor for a Confirm node.
4197 * Specifies constraints for a value. To support dataflow analyses.
4198 * Adds the node to the block in current_ir_block.
4200 * Example: If the value never exceeds '100' this is expressed by placing a
4201 * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge.
4203 * @param *val The value we express a constraint for
4204 * @param *bound The value to compare against. Must be a firm node, typically a constant.
4205 * @param cmp The compare operation.
4207 ir_node *new_Confirm (ir_node *val, ir_node *bound, pn_Cmp cmp);
4209 /** Constructor for an Unknown node.
4211 * Represents an arbitrary value. Places the node in
4214 * @param *m The mode of the unknown value.
4216 ir_node *new_Unknown(ir_mode *m);
4218 /** Constructor for a NoMem node.
4220 * Returns the unique NoMem node of the graph. The same as
4223 ir_node *new_NoMem (void);
4225 /** Constructor for a Mux node.
4227 * Adds the node to the block in current_ir_block.
4229 * @param *sel The ir_node that calculates the boolean select.
4230 * @param *ir_true The ir_node that calculates the true result.
4231 * @param *ir_false The ir_node that calculates the false result.
4232 * @param *mode The mode of the node (and it_true and ir_false).
4234 ir_node *new_Mux (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
4236 /** Constructor for a Psi node.
4238 * @param *arity The arity of the conditions
4239 * @param *conds The array of mode_b conditions, length must be equal arity
4240 * @param *vals The array of mode values, length must be equal arity + 1
4241 * @param *mode The mode of the node (must be the mode of all vals).
4243 ir_node *new_Psi (int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode);
4245 /** Constructor for a CopyB node.
4247 * Adds the node to the block in current_ir_block.
4249 * @param *store The current memory
4250 * @param *dst The ir_node that represents the destination address.
4251 * @param *src The ir_node that represents the source address.
4252 * @param *data_type The type of the copied data
4254 ir_node *new_CopyB(ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
4256 /** Constructor for a InstOf node.
4258 * A High-Level Type check.
4260 * @param *store The memory in which the object the entity should be selected
4261 * from is allocated.
4262 * @param *objptr A pointer to a object of a class type.
4263 * @param *type The type of which objptr must be.
4265 ir_node *new_InstOf (ir_node *store, ir_node *objptr, ir_type *type);
4267 /**Constructor for a Raise node.
4269 * A High-Level Exception throw.
4271 * @param *store The current memory.
4272 * @param *obj A pointer to the Except variable.
4274 ir_node *new_Raise (ir_node *store, ir_node *obj);
4276 /** Constructor for a Bound node.
4278 * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
4280 * Adds the node to the block in current_ir_block.
4282 * @param *store The current memory
4283 * @param *idx The ir_node that represents an index.
4284 * @param *lower The ir_node that represents the lower bound for the index.
4285 * @param *upper The ir_node that represents the upper bound for the index.
4287 ir_node *new_Bound (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
4289 /** Constructor for a Pin node.
4291 * @param *node The node which value should be pinned.
4293 ir_node *new_Pin (ir_node *node);
4295 /** Constructor for an ASM pseudo node.
4297 * @param arity The number of data inputs to the node.
4298 * @param *in The array of length arity of data inputs.
4299 * @param *inputs The array of length arity of input constraints.
4300 * @param n_outs The number of data outputs to the node.
4301 * @param *outputs The array of length n_outs of output constraints.
4302 * @param n_clobber The number of clobbered registers.
4303 * @param *clobber The array of length n_clobber of clobbered registers.
4304 * @param *asm_text The assembler text.
4306 ir_node *new_ASM(int arity, ir_node *in[], ir_asm_constraint *inputs,
4307 int n_outs, ir_asm_constraint *outputs,
4308 int n_clobber, ident *clobber[], ident *asm_text);
4310 /*---------------------------------------------------------------------*/
4311 /* The comfortable interface. */
4312 /* Supports automatic Phi node construction. */
4313 /* All routines of the block oriented interface except new_Block are */
4315 /*---------------------------------------------------------------------*/
4317 /** Create an immature Block.
4319 * An immature Block has an unknown number of predecessors. Predecessors
4320 * can be added with add_immBlock_pred(). Once all predecessors are
4321 * added the block must be matured.
4323 * Adds the block to the graph in current_ir_graph. Does set
4324 * current_block. Can be used with automatic Phi node construction.
4325 * This constructor can only be used if the graph is in
4328 ir_node *new_d_immBlock(dbg_info *db);
4329 ir_node *new_immBlock(void);
4331 /** Create an immature PartBlock.
4333 * An immature block has only one Block or PartBlock predecessor.
4334 * A PartBlock forms together with one BLock and possibly other
4335 * PartBlocks a MacroBlock.
4337 * Adds the PartBlock to the graph in current_ir_graph. Does set
4338 * current_block. Can be used with automatic Phi node construction.
4339 * This constructor can only be used if the graph is in
4342 ir_node *new_d_immPartBlock(dbg_info *db, ir_node *pred_jmp);
4343 ir_node *new_immPartBlock(ir_node *pred_jmp);
4345 /** Add a control flow edge to an immature block. */
4346 void add_immBlock_pred(ir_node *immblock, ir_node *jmp);
4348 /** Finalize a Block node, when all control flows are known. */
4349 void mature_immBlock(ir_node *block);
4350 #define mature_cur_block() mature_immBlock(get_cur_block());
4353 /** Get the current value of a local variable.
4355 * Use this function to obtain the last definition of the local variable
4356 * associated with pos. Pos may not exceed the value passed as n_loc
4357 * to new_ir_graph. This call automatically inserts Phi nodes.
4359 * @param *db A pointer for debug information.
4360 * @param pos The position/id of the local variable.
4361 * @param *mode The mode of the value to get.
4363 ir_node *get_d_value(dbg_info *db, int pos, ir_mode *mode);
4364 ir_node *get_value(int pos, ir_mode *mode);
4366 /** Remark a new definition of a variable.
4368 * Use this function to remember a new definition of the value
4369 * associated with pos. Pos may not exceed the value passed as n_loc
4370 * to new_ir_graph. This call is needed to automatically inserts Phi
4373 * @param pos The position/id of the local variable.
4374 * @param *value The new value written to the local variable.
4376 void set_value(int pos, ir_node *value);
4378 /** Find the value number for a node in the current block.
4380 * This function searches all values in the current block for
4381 * a given value and returns its value number if it was found, else
4383 * Note that this does not mean that the value does not exists,
4384 * it's just not equal the node (for instance behind a Phi/Confirm ...)
4386 * @param *value The value to find.
4388 int find_value(ir_node *value);
4390 /** Get the current memory state.
4392 * Use this function to obtain the last definition of the memory
4393 * state. This call automatically inserts Phi nodes for the memory
4396 ir_node *get_store(void);
4398 /** Remark a new definition of the memory state.
4400 * Use this function to remember a new definition of the memory state.
4401 * This call is needed to automatically inserts Phi nodes.
4403 * @param *store The new memory state.
4405 void set_store(ir_node *store);
4407 /** keep this node alive even if End is not control-reachable from it
4409 * @param ka The node to keep alive.
4411 void keep_alive(ir_node *ka);
4413 /** Returns the frame type of the current graph */
4414 ir_type *get_cur_frame_type(void);
4417 /* --- initialize and finalize ir construction --- */
4419 /** Puts the graph into state "phase_high" */
4420 #define irg_finalize_cons(irg) set_irg_phase_state(irg, phase_high)
4422 /** Puts the program and all graphs into state phase_high.
4424 * This also remarks, the construction of types is finished,
4425 * e.g., that no more subtypes will be added. */
4426 void irp_finalize_cons(void);
4428 /* --- Initialization --- */
4431 * This function is called, whenever a local variable is used before definition
4433 * @param irg the IR graph on which this happens
4434 * @param mode the mode of the local var
4435 * @param pos position chosen be the frontend for this variable (n_loc)
4437 * @return a firm node of mode @p mode that initializes the var at position pos
4440 * Do not return NULL!
4441 * If this function is not set, FIRM will create a const node with tarval BAD.
4442 * Use set_irg_loc_description()/get_irg_loc_description() to assign additional
4443 * informations to local variables.
4445 typedef ir_node *uninitialized_local_variable_func_t(ir_graph *irg, ir_mode *mode, int pos);
projects / libfirm / blob