2 * Copyright (C) 1995-2010 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,
32 * documentation no more supported since 2001
34 * IR node construction.
36 * This file documents all datatypes and constructors needed to
37 * build a FIRM representation of a procedure. The constructors are
38 * also implemented in this file.
40 * The documentation also gives a short manual how to use the library.
42 * For extensive documentation of FIRM see UKA Techreport 1999-14.
45 * Three kinds of nodes
46 * --------------------
48 * There are three kinds of nodes known to the IR: entities,
51 * + ir_nodes are the actual nodes of the FIRM intermediate representation.
52 * They represent operations on the data of the program and control flow
55 * + entity ==> implemented in entity.h
56 * Refers to a single entity of the compiled program, e.g. a field of a
57 * class or a method. If a method or variable can not be assigned to
58 * a method or class or the like, it is a global object.
60 * + types ==> implemented in type.h
61 * With types type information is represented. There are several type
64 * Implementation of the FIRM operations: ir_node
65 * ----------------------------------------------
67 * Ir_nodes represent operations on the data of the program and control flow
68 * operations. Examples of ir_nodes: Add, Jmp, Cmp
70 * FIRM is a dataflow graph. A dataflow graph is a directed graph,
71 * so that every node has incoming and outgoing edges. A node is
72 * executable if every input at its incoming edges is available.
73 * Execution of the dataflow graph is started at the Start node which
74 * has no incoming edges and ends when the End node executes, even if
75 * there are still executable or not executed nodes. (Is this true,
76 * or must all executable nodes be executed?) (There are exceptions
77 * to the dataflow paradigma that all inputs have to be available
78 * before a node can execute: Phi, Block. See UKA Techreport
81 * The implementation of FIRM differs from the view as a dataflow
82 * graph. To allow fast traversion of the graph edges are
83 * implemented as C-pointers. Inputs to nodes are not ambiguous, the
84 * results can be used by several other nodes. Each input can be
85 * implemented as a single pointer to a predecessor node, outputs
86 * need to be lists of pointers to successors. Therefore a node
87 * contains pointers to its predecessors so that the implementation is a
88 * dataflow graph with reversed edges. It has to be traversed bottom
91 * All nodes of the IR have the same basic structure. They are
92 * distinguished by a field containing the opcode.
94 * The fields of an ir_node:
96 * kind A firm_kind tag containing k_ir_node. This is useful for
97 * dynamically checking the type of a node.
99 * *op This ir_op gives the opcode as a tag and a string
100 * and the number of attributes of an ir_node. There is
101 * one statically allocated struct ir_op for each opcode.
103 * *mode The ir_mode of the operation represented by this firm
104 * node. The mode of the operation is the mode of its
105 * result. A Firm mode is a datatype as known to the
106 * target, not a type of the source language.
108 * visit A flag for traversing the IR.
110 * **in An array with pointers to the node's predecessors.
112 * *link A pointer to an ir_node. With this pointer all Phi nodes
113 * are attached to a Block, i.e. a Block points to its
114 * first Phi node, this node points to the second Phi node
115 * in the Block and so forth. Used in mature_immBlock
116 * to find all Phi nodes to be matured. It's also used to
117 * annotate a node with a better, optimized version of it.
119 * attr An attr struct containing the attributes of the nodes. The
120 * attributes depend on the opcode of the node. The number
121 * of these attributes is given in op.
125 * Not yet documented. See irop.h.
129 * Not yet documented. See irmode.h.
131 * GLOBAL VARIABLES -- now also fields of ir_graph.
134 * current_ir_graph Points to the current ir_graph. All constructors for
135 * nodes add nodes to this graph.
137 * ir_visited An int used as flag to traverse the ir_graph.
139 * block_visited An int used as a flag to traverse block nodes in the
142 * Others not yet documented.
146 * CONSTRUCTOR FOR IR_GRAPH --> see irgraph.h
147 * ========================
150 * PROCEDURE TO CONSTRUCT AN IR GRAPH --> see also Firm tutorial
151 * ==================================
153 * This library supplies several interfaces to construct a FIRM graph for
155 * - A "comfortable" interface generating SSA automatically. Automatically
156 * computed predecessors of nodes need not be specified in the constructors.
157 * (new_<Node> constructurs and a set of additional routines.)
158 * - A less comfortable interface where all predecessors except the block
159 * an operation belongs to need to be specified. SSA must be constructed
160 * by hand. (new_<Node> constructors and set_cur_block()). This interface
161 * is called "block oriented". It automatically calles the local optimizations
163 * - An even less comfortable interface where the block needs to be specified
164 * explicitly. This is called the "raw" interface. (new_r_<Node>
165 * constructors). These nodes are not optimized.
167 * To use the functionality of the comfortable interface correctly the Front
168 * End needs to follow certain protocols. This is explained in the following.
169 * To build a correct IR with the other interfaces study the semantics of
170 * the firm node (See tech-reprot UKA 1999-14). For the construction of
171 * types and entities see the documentation in those modules.
173 * First the Frontend needs to decide which variables and values used in
174 * a procedure can be represented by dataflow edges. These are variables
175 * that need not be saved to memory as they cause no side effects visible
176 * out of the procedure. Often these are all compiler generated
177 * variables and simple local variables of the procedure as integers,
178 * reals and pointers. The frontend has to count and number these variables.
180 * First an ir_graph needs to be constructed with new_ir_graph. The
181 * constructor gets the number of local variables. The graph is held in the
182 * global variable irg.
184 * Now the construction of the procedure can start. Several basic blocks can
185 * be constructed in parallel, but the code within each block needs to
186 * be constructed (almost) in program order.
188 * A global variable holds the current basic block. All (non block) nodes
189 * generated are added to this block. The current block can be set with
190 * set_cur_block(block). If several blocks are constructed in parallel block
191 * switches need to be performed constantly.
193 * To generate a Block node (with the comfortable interface), its predecessor
194 * control flow nodes need not be known. In case of cyclic control flow these
195 * can not be known when the block is constructed. With add_immBlock_pred(block,
196 * cfnode) predecessors can be added to the block. If all predecessors are
197 * added to the block mature_immBlock(b) needs to be called. Calling mature_immBlock
198 * early improves the efficiency of the Phi node construction algorithm.
199 * But if several blocks are constructed at once, mature_immBlock must only
200 * be called after performing all set_values and set_stores in the block!
201 * (See documentation of new_immBlock constructor.)
203 * The constructors of arithmetic nodes require that their predecessors
204 * are mentioned. Sometimes these are available in the Frontend as the
205 * predecessors have just been generated by the frontend. If they are local
206 * values, the predecessors can be obtained from the library with a call to
207 * get_value(local_val_nr). (local_val_nr needs to be administered by
208 * the Frontend.) A call to get_value triggers the generation of Phi nodes.
209 * If an arithmetic operation produces a local value, this value needs to be
210 * passed to the library by set_value(node, local_val_nr).
211 * In straight line code these two operations just remember and return the
212 * pointer to nodes producing the value. If the value passes block boundaries
213 * Phi nodes can be inserted.
214 * Similar routines exist to manage the Memory operands: set_store and
217 * Several nodes produce more than one result. An example is the Div node.
218 * Such nodes return tuples of values. From these individual values can be
219 * extracted by proj nodes.
221 * The following example illustrates the construction of a simple basic block
222 * with two predecessors stored in variables cf_pred1 and cf_pred2, containing
225 * and finally jumping to an other block. The variable a got the local_val_nr
226 * 42 by the frontend.
228 * ir_node *this_block, *cf_pred1, *cf_pred2, *a_val, *mem, *div, *res, *cf_op;
230 * this_block = new_immBlock();
231 * add_immBlock_pred(this_block, cf_pred1);
232 * add_immBlock_pred(this_block, cf_pred2);
233 * mature_immBlock(this_block);
234 * a_val = get_value(42, mode_Iu);
236 * div = new_Div(mem, a_val, a_val, mode_Iu);
237 * mem = new_Proj(div, mode_M, pn_Div_M); * for the numbers for Proj see docu *
238 * res = new_Proj(div, mode_Iu, pn_Div_res);
240 * set_value(res, 42);
243 * For further information look at the documentation of the nodes and
244 * constructors and at the paragraph COPING WITH DATA OBJECTS at the
245 * end of this documentation.
247 * The comfortable interface contains the following routines further explained
250 * ir_node *new_immBlock (void);
251 * ir_node *new_Start (void);
252 * ir_node *new_End (void);
253 * ir_node *new_Jmp (void);
254 * ir_node *new_IJmp (ir_node *tgt);
255 * ir_node *new_Cond (ir_node *c);
256 * ir_node *new_Return (ir_node *store, int arity, ir_node **in);
257 * ir_node *new_Const (tarval *con);
258 * ir_node *new_SymConst (ir_mode *mode, symconst_symbol value, symconst_kind kind);
259 * ir_node *new_simpleSel (ir_node *store, ir_node *objptr, ir_entity *ent);
260 * ir_node *new_Sel (ir_node *store, ir_node *objptr, int arity,
261 * ir_node **in, ir_entity *ent);
262 * ir_node *new_Call (ir_node *store, ir_node *callee, int arity,
263 * ir_node **in, type_method *type);
264 * ir_node *new_Builtin(ir_node *store, ir_builtin_kind kind, int arity,
265 * ir_node **in, type_method *type);
266 * ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode);
267 * ir_node *new_Sub (ir_node *op1, ir_node *op2, ir_mode *mode);
268 * ir_node *new_Minus (ir_node *op, ir_mode *mode);
269 * ir_node *new_Mul (ir_node *op1, ir_node *op2, ir_mode *mode);
270 * ir_node *new_Mulh (ir_node *op1, ir_node *op2, ir_mode *mode);
271 * ir_node *new_Quot (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
272 * ir_node *new_DivMod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
273 * ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
274 * ir_node *new_Mod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state;
275 * ir_node *new_And (ir_node *op1, ir_node *op2, ir_mode *mode);
276 * ir_node *new_Or (ir_node *op1, ir_node *op2, ir_mode *mode);
277 * ir_node *new_Eor (ir_node *op1, ir_node *op2, ir_mode *mode);
278 * ir_node *new_Not (ir_node *op, ir_mode *mode);
279 * ir_node *new_Shl (ir_node *op, ir_node *k, ir_mode *mode);
280 * ir_node *new_Shr (ir_node *op, ir_node *k, ir_mode *mode);
281 * ir_node *new_Shrs (ir_node *op, ir_node *k, ir_mode *mode);
282 * ir_node *new_Rotl (ir_node *op, ir_node *k, ir_mode *mode);
283 * ir_node *new_Cmp (ir_node *op1, ir_node *op2);
284 * ir_node *new_Conv (ir_node *op, ir_mode *mode);
285 * ir_node *new_Cast (ir_node *op, ir_type *to_tp);
286 * ir_node *new_Carry (ir_node *op1, ir_node *op2, ir_mode *mode);
287 * ir_node *new_Borrow (ir_node *op1, ir_node *op2, ir_mode *mode);
288 * ir_node *new_Load (ir_node *store, ir_node *addr, ir_mode *mode, ir_cons_flags flags);
289 * ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val, ir_cons_flags flags);
290 * ir_node *new_Alloc (ir_node *store, ir_node *count, ir_type *alloc_type,
291 * where_alloc where);
292 * ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size,
293 * ir_type *free_type, where_alloc where);
294 * ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj);
295 * ir_node *new_NoMem (void);
296 * ir_node *new_Mux (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
297 * ir_node *new_CopyB (ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
298 * ir_node *new_InstOf (ir_node *store, ir_node obj, ir_type *ent);
299 * ir_node *new_Raise (ir_node *store, ir_node *obj);
300 * ir_node *new_Bound (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
301 * ir_node *new_Pin (ir_node *node);
303 * void add_immBlock_pred (ir_node *block, ir_node *jmp);
304 * void mature_immBlock (ir_node *block);
305 * void set_cur_block (ir_node *target);
306 * ir_node *get_value (int pos, ir_mode *mode);
307 * void set_value (int pos, ir_node *value);
308 * ir_node *get_store (void);
309 * void set_store (ir_node *store);
310 * keep_alive (ir_node ka)
312 * IR_NODES AND CONSTRUCTORS FOR IR_NODES
313 * =======================================
315 * All ir_nodes are defined by a common data structure. They are distinguished
316 * by their opcode and differ in the number of their attributes.
318 * Const nodes are always added to the start block.
319 * All other constructors add the created node to the current_block.
320 * swich_block(block) allows to set the current block to block.
322 * Watch for my inconsistent use of input and predecessor (dataflow view)
323 * and `the node points to' (implementation view).
325 * The following description of the nodes lists four properties them if these
327 * - the parameters to the constructor
328 * - the inputs of the Firm node
329 * - the outputs of the Firm node
330 * - attributes to the node
334 * ir_node *new_immBlock (void)
335 * ----------------------------
337 * Creates a new block. When a new block is created it cannot be known how
338 * many predecessors this block will have in the control flow graph.
339 * Therefore the list of inputs can not be fixed at creation. Predecessors
340 * can be added with add_immBlock_pred (block, control flow operation).
341 * With every added predecessor the number of inputs to Phi nodes also
344 * The block can be completed by mature_immBlock(block) if all predecessors are
345 * known. If several blocks are built at once, mature_immBlock can only be called
346 * after set_value has been called for all values that are life at the end
347 * of the block. This is necessary so that Phi nodes created mature_immBlock
348 * get the right predecessors in case of cyclic dependencies. If all set_values
349 * of this block are called after maturing it and before calling get_value
350 * in some block that is control flow dependent on this block, the construction
353 * Example for faulty IR construction: (draw the graph on a paper and you'll
356 * block_before_loop = new_immBlock();
357 * set_cur_block(block_before_loop);
359 * mature_immBlock(block_before_loop);
360 * before2header = new_Jmp;
362 * loop_header = new_immBlock ();
363 * set_cur_block(loop_header);
364 * header2body - new_Jmp();
366 * loop_body = new_immBlock ();
367 * set_cur_block(loop_body);
368 * body2header = new_Jmp();
370 * add_immBlock_pred(loop_header, before2header);
371 * add_immBlock_pred(loop_header, body2header);
372 * add_immBlock_pred(loop_body, header2body);
374 * mature_immBlock(loop_header);
375 * mature_immBlock(loop_body);
377 * get_value(loop_body, x); // gets the Phi in loop_header
378 * set_value(loop_header, x); // sets the value the above get_value should
379 * // have returned!!!
381 * Mature_immBlock also fixes the number of inputs to the Phi nodes. Mature_immBlock
382 * should be called as early as possible, as afterwards the generation of Phi
383 * nodes is more efficient.
386 * There is an input for each control flow predecessor of the block.
387 * The input points to an instruction producing an output of type X.
388 * Possible predecessors: Start, Jmp, Cond, Raise or Return or any node
389 * possibly causing an exception. (Often the real predecessors are Projs.)
391 * Mode BB (R), all nodes belonging to this block should consume this output.
392 * As they are strict (except Block and Phi node) it is a necessary condition
393 * that the block node executed before any other node in this block executes.
395 * block.matured Indicates whether the block is mature.
397 * This attribute contains all local values valid in this
398 * block. This is needed to build the Phi nodes and removed
399 * if the graph is complete. This field is used by the
400 * internal construction algorithm and should not be accessed
404 * ir_node *new_Block (int arity, ir_node **in)
405 * --------------------------------------------
407 * Creates a new Block with the given list of predecessors. This block
408 * is mature. As other constructors calls optimization and verify for the
409 * block. If one of the predecessors is Unknown (as it has to be filled in
410 * later) optimizations are skipped. This is necessary to
411 * construct Blocks in loops.
414 * CONTROL FLOW OPERATIONS
415 * -----------------------
417 * In each block there must be exactly one of the control flow
418 * operations Start, End, Jmp, Cond, Return or Raise. The output of a
419 * control flow operation points to the block to be executed next.
421 * ir_node *new_Start (void)
422 * -------------------------
424 * Creates a start node. Not actually needed public. There is only one such
425 * node in each procedure which is automatically created by new_ir_graph.
428 * No inputs except the block it belongs to.
430 * A tuple of 4 (5, 6) distinct values. These are labeled by the following
431 * projection numbers (pn_Start):
432 * * pn_Start_X_initial_exec mode X, points to the first block to be exe * cuted.
433 * * pn_Start_M mode M, the global store
434 * * pn_Start_P_frame_base mode P, a pointer to the base of the proce * dures stack frame.
435 * * pn_Start_P_globals mode P, a pointer to the part of the memory * containing_all_ global things.
436 * * pn_Start_T_args mode T, a tuple containing all arguments of * the procedure.
439 * ir_node *new_End (void)
440 * -----------------------
442 * Creates an end node. Not actually needed public. There is only one such
443 * node in each procedure which is automatically created by new_ir_graph.
446 * No inputs except the block it belongs to.
450 * ir_node *new_Jmp (void)
451 * -----------------------
453 * Creates a Jmp node.
456 * The block the node belongs to
458 * Control flow to the next block.
460 * ir_node *new_IJmp (ir_node *tgt)
461 * -----------------------
463 * Creates an IJmp node.
466 * The node that represents the target jump address
468 * Control flow to an unknown target, must be pinned by
471 * ir_node *new_Cond (ir_node *c)
472 * ------------------------------
474 * Creates a Cond node. There are two versions of this node.
480 * A tuple of two control flows. The first is taken if the input is
481 * false, the second if it is true.
485 * A value of mode I_u. (i)
487 * A tuple of n control flows. If the Cond's input is i, control
488 * flow will proceed along output i. If the input is >= n control
489 * flow proceeds along output n.
491 * ir_node *new_Return (ir_node *store, int arity, ir_node **in)
492 * -------------------------------------------------------------
494 * The Return node has as inputs the results of the procedure. It
495 * passes the control flow to the end_block.
501 * Control flow to the end block.
504 * ir_node *new_Const (tarval *con)
505 * -----------------------------------------------
507 * Creates a constant in the constant table and adds a Const node
508 * returning this value to the start block. The mode is derived
512 * *con Points to an entry in the constant table.
513 * This pointer is added to the attributes of
514 * the node (self->attr.con)
516 * No inputs except the block it belogns to.
518 * The constant value.
520 * attr.con A tarval* pointer to the proper entry in the constant
523 * ir_node *new_SymConst (ir_mode *mode, union symconst_symbol value, symconst_addr_ent kind)
524 * -----------------------------------------------------------------------------------------
526 * There are several symbolic constants:
527 * symconst_type_tag The symbolic constant represents a type tag.
528 * symconst_type_size The symbolic constant represents the size of a type.
529 * symconst_type_align The symbolic constant represents the alignment of a type.
530 * symconst_addr_ent The symbolic constant represents the address of an entity.
531 * symconst_ofs_ent The symbolic constant represents the offset of an
532 * entity in its owner type.
533 * symconst_enum_const The symbolic constant is a enumeration constant of an
537 * mode P for SymConsts representing addresses, Iu otherwise.
538 * value The type, ident, entity or enum constant, depending on the
540 * kind The kind of the symbolic constant, see the list above.
543 * No inputs except the block it belongs to.
545 * A symbolic constant.
548 * attr.i.num The symconst_addr_ent, i.e. one of
550 * -symconst_type_size
551 * -symconst_type_align
554 * If the attr.i.num is symconst_type_tag, symconst_type_size or symconst_type_align,
555 * the node contains an attribute:
557 * attr.i.*type, a pointer to a type_class.
558 * if it is linkage_ptr_info it contains
559 * attr.i.*ptrinfo, an ident holding information for the linker.
563 * ir_node *new_simpleSel (ir_node *store, ir_node *frame, ir_entity *sel)
564 * -----------------------------------------------------------------------
567 * Selects an entity from a compound type. This entity can be a field or
571 * *store The memory in which the object the entity should be selected
573 * *frame The pointer to the object.
574 * *sel The entity to select.
577 * The memory containing the object.
578 * A pointer to the object.
579 * An unsigned integer.
581 * A pointer to the selected entity.
583 * attr.sel Pointer to the entity
586 * ir_node *new_Sel (ir_node *store, ir_node *frame, int arity, ir_node **in,
587 * --------------------------------------------------------------------------
591 * Selects a field from an array type. The entity has as owner the array, as
592 * type the arrays element type. The indices to access an array element are
596 * *store The memory in which the object the entity should be selected from
598 * *frame The pointer to the object.
599 * *arity number of array indices.
600 * *in array with index inputs to the node.
601 * *sel The entity to select.
604 * The memory containing the object.
605 * A pointer to the object.
606 * As much unsigned integer as there are array expressions.
608 * A pointer to the selected entity.
610 * attr.sel Pointer to the entity
612 * The constructors new_Sel and new_simpleSel generate the same IR nodes.
613 * simpleSel just sets the arity of the index inputs to zero.
616 * ARITHMETIC OPERATIONS
617 * ---------------------
619 * ir_node *new_Call (ir_node *store, ir_node *callee, int arity, ir_node **in,
620 * ----------------------------------------------------------------------------
624 * Creates a procedure call.
627 * *store The actual store.
628 * *callee A pointer to the called procedure.
629 * arity The number of procedure parameters.
630 * **in An array with the pointers to the parameters.
631 * The constructor copies this array.
632 * *type Type information of the procedure called.
635 * The store, the callee and the parameters.
637 * A tuple containing the eventually changed store and the procedure
640 * attr.call Contains the attributes for the procedure.
642 * ir_node *new_Builtin(ir_node *store, ir_builtin_kind kind, int arity, ir_node **in,
643 * -----------------------------------------------------------------------------------
647 * Creates a builtin call.
650 * *store The actual store.
651 * kind Describes the called builtin.
652 * arity The number of procedure parameters.
653 * **in An array with the pointers to the parameters.
654 * The constructor copies this array.
655 * *type Type information of the procedure called.
658 * The store, the kind and the parameters.
660 * A tuple containing the eventually changed store and the procedure
663 * attr.builtin Contains the attributes for the called builtin.
665 * ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode)
666 * ------------------------------------------------------------
670 * ir_node *new_Sub (ir_node *op1, ir_node *op2, ir_mode *mode)
671 * ------------------------------------------------------------
675 * ir_node *new_Minus (ir_node *op, ir_mode *mode)
676 * -----------------------------------------------
678 * Unary Minus operations on integer and floating point values.
680 * ir_node *new_Mul (ir_node *op1, ir_node *op2, ir_mode *mode)
681 * ------------------------------------------------------------
685 * ir_node *new_Mulh (ir_node *op1, ir_node *op2, ir_mode *mode)
686 * ------------------------------------------------------------
688 * Returns the high order bits of a n*n=2n multiplication.
690 * ir_node *new_Quot (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state)
691 * -------------------------------------------------------------------------------------------------
693 * Quot performs exact division of floating point numbers. It's mode
694 * is Tuple, the mode of the result must match the Proj mode
695 * that extracts the result of the arithmetic operations.
698 * The store needed to model exceptions and the two operands.
700 * A tuple containing a memory and a execution for modeling exceptions
701 * and the result of the arithmetic operation.
703 * ir_node *new_DivMod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state)
704 * ---------------------------------------------------------------------------------------------------
706 * Performs Div and Mod on integer values.
709 * A tuple containing a memory and a execution for modeling exceptions
710 * and the two result of the arithmetic operations.
712 * ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state)
713 * ------------------------------------------------------------------------------------------------
717 * ir_node *new_Mod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state)
718 * ------------------------------------------------------------------------------------------------
722 * ir_node *new_And (ir_node *op1, ir_node *op2, ir_mode *mode)
723 * ------------------------------------------------------------
727 * ir_node *new_Or (ir_node *op1, ir_node *op2, ir_mode *mode)
728 * -----------------------------------------------------------
732 * ir_node *new_Eor (ir_node *op1, ir_node *op2, ir_mode *mode)
733 * ------------------------------------------------------------
737 * ir_node *new_Not (ir_node *op, ir_mode *mode)
738 * ---------------------------------------------
740 * This node constructs a constant where all bits are set to one
741 * and a Eor of this constant and the operator. This simulates a
744 * ir_node *new_Shl (ir_node *op, ir_node *k, ir_mode *mode)
745 * ---------------------------------------------------------
749 * ir_node *new_Shr (ir_node *op, ir_node *k, ir_mode *mode)
750 * ---------------------------------------------------------
752 * Logic shift right, i.e., zero extended.
755 * ir_node *new_Shrs (ir_node *op, ir_node *k, ir_mode *mode)
756 * ----------------------------------------------------------
758 * Arithmetic shift right, i.e., sign extended.
760 * ir_node *new_Rotl (ir_node *op, ir_node *k, ir_mode *mode)
761 * ---------------------------------------------------------
763 * Rotates the operand to the left by k bits.
765 * ir_node *new_Carry (ir_node *op1, ir_node *op2, ir_mode *mode)
766 * ------------------------------------------------------------
768 * Calculates the Carry value for integer addition. Used only
771 * ir_node *new_Borrow (ir_node *op1, ir_node *op2, ir_mode *mode)
772 * ------------------------------------------------------------
774 * Calculates the Borrow value for integer substraction. Used only
777 * ir_node *new_Conv (ir_node *op, ir_mode *mode)
778 * ---------------------------------------------
780 * Mode conversion. For allowed conversions see UKA Tech Report
783 * ir_node *new_Cmp (ir_node *op1, ir_node *op2)
784 * ---------------------------------------------
787 * The two values to be compared.
789 * A 16-tuple containing the results of the 16 different comparisons.
790 * The following is a list giving the comparisons and a projection
791 * number (pn_Cmp) to use in Proj nodes to extract the proper result.
795 * pn_Cmp_Le less or equal
797 * pn_Cmp_Ge greater of equal
798 * pn_Cmp_Lg less or greater
799 * pn_Cmp_Leg less, equal or greater = ordered
800 * pn_Cmp_Uo unordered
801 * pn_Cmp_Ue unordered or equal
802 * pn_Cmp_Ul unordered or less
803 * pn_Cmp_Ule unordered, less or equal
804 * pn_Cmp_Ug unordered or greater
805 * pn_Cmp_Uge unordered, greater or equal
806 * pn_Cmp_Ne unordered, less or greater = not equal
813 * In general, Phi nodes are automaitcally inserted. In some cases, if
814 * all predecessors of a block are known, an explicit Phi node constructor
815 * is needed. E.g., to construct a FIRM graph for a statement as
816 * a = (b==c) ? 2 : 5;
818 * ir_node *new_Phi (int arity, ir_node **in, ir_mode *mode)
819 * ---------------------------------------------------------
821 * Creates a Phi node. The in's order has to correspond to the order
822 * of in's of current_block. This is not checked by the library!
823 * If one of the predecessors is Unknown (as it has to be filled in
824 * later) optimizations are skipped. This is necessary to
825 * construct Phi nodes in loops.
828 * arity number of predecessors
829 * **in array with predecessors
830 * *mode The mode of it's inputs and output.
832 * A Phi node has as many inputs as the block it belongs to.
833 * Each input points to a definition of the same value on a
834 * different path in the control flow.
836 * The definition valid in this block.
838 * ir_node *new_Mux (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode)
839 * -----------------------------------------------------------------------------------
841 * Creates a Mux node. This node implements the following semantic:
842 * If the sel node (which must be of mode_b) evaluates to true, its value is
843 * ir_true, else ir_false;
847 * OPERATIONS TO MANAGE MEMORY EXPLICITLY
848 * --------------------------------------
850 * ir_node *new_Load (ir_node *store, ir_node *addr, ir_mode *mode, ir_cons_flags flags)
851 * -------------------------------------------------------------------------------------
853 * The Load operation reads a value from memory.
856 * *store The current memory.
857 * *addr A pointer to the variable to be read in this memory.
858 * *mode The mode of the value to be loaded.
859 * flags Additional flags for alignment, volatility and pin state.
862 * The memory and a pointer to a variable in this memory.
864 * A tuple of the memory, a control flow to be taken in case of
865 * an exception and the loaded value.
867 * ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val, ir_cons_flags flags)
868 * -------------------------------------------------------------------------------------
870 * The Store operation writes a value to a variable in memory.
873 * The memory, a pointer to a variable in this memory and the value
874 * to write to this variable.
876 * A tuple of the changed memory and a control flow to be taken in
877 * case of an exception.
879 * ir_node *new_Alloc (ir_node *store, ir_node *count, ir_type *alloc_type,
880 * -----------------------------------------------------------------------
884 * The Alloc node allocates a new variable. It can be specified whether the
885 * variable should be allocated to the stack or to the heap.
888 * *store The memory which shall contain the new variable.
889 * *count This field is for allocating arrays, it specifies how
890 * many array elements are to be allocated.
891 * *alloc_type The type of the allocated variable. In case of allocating
892 * arrays this has to be the array type, not the type of the
894 * where Where to allocate the variable, either heap_alloc or stack_alloc.
897 * A memory and an unsigned integer.
899 * A tuple of the changed memory, a control flow to be taken in
900 * case of an exception and the pointer to the new variable.
902 * a.where Indicates where the variable is allocated.
903 * a.*type A pointer to the class the allocated data object
906 * ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size, ir_type *free_type,
907 * -----------------------------------------------------------------------------------
911 * The Free node frees memory of the given variable.
914 * *store The memory which shall contain the new variable.
915 * *ptr The pointer to the object to free.
916 * *size The number of objects of type free_type to free in a sequence.
917 * *free_type The type of the freed variable.
918 * where Where the variable was allocated, either heap_alloc or stack_alloc.
921 * A memory, a pointer and an unsigned integer.
923 * The changed memory.
925 * f.*type A pointer to the type information of the freed data object.
929 * ir_node *new_Sync (int arity, ir_node **in)
930 * -------------------------------------------
932 * The Sync operation unifies several partial memory blocks. These blocks
933 * have to be pairwise disjunct or the values in common locations have to
934 * be identical. This operation allows to specify all operations that eventually
935 * need several partial memory blocks as input with a single entrance by
936 * unifying the memories with a preceding Sync operation.
939 * arity The number of memories to synchronize.
940 * **in An array of pointers to nodes that produce an output of
945 * The unified memory.
951 * ir_node *new_Bad (void)
952 * -----------------------
954 * Returns the unique Bad node current_ir_graph->bad.
955 * This node is used to express results of dead code elimination.
957 * ir_node *new_NoMem (void)
958 * -----------------------------------------------------------------------------------
960 * Returns the unique NoMem node current_ir_graph->no_mem.
961 * This node is used as input for operations that need a Memory, but do not
962 * change it like Div by const != 0, analyzed calls etc.
964 * ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj)
965 * ----------------------------------------------------------
967 * Selects one entry of a tuple. This is a hidden edge with attributes.
970 * *arg A node producing a tuple.
971 * *mode The mode of the value to project.
972 * proj The position of the value in the tuple.
978 * ir_node *new_Tuple (int arity, ir_node **in)
979 * --------------------------------------------
981 * Builds a Tuple from single values. This is needed to implement
982 * optimizations that remove a node that produced a tuple. The node can be
983 * replaced by the Tuple operation so that the following Proj nodes have not to
984 * be changed. (They are hard to find due to the implementation with pointers
985 * in only one direction.) The Tuple node is smaller than any other
986 * node, so that a node can be changed into a Tuple by just changing it's
987 * opcode and giving it a new in array.
990 * arity The number of tuple elements.
991 * **in An array containing pointers to the nodes producing the
994 * ir_node *new_Id (ir_node *val, ir_mode *mode)
995 * ---------------------------------------------
997 * The single output of the Id operation is it's input. Also needed
1001 * HIGH LEVEL OPERATIONS
1002 * ---------------------
1004 * ir_node *new_CopyB (ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type)
1005 * -----------------------------------------------------------------------------------
1007 * Describes a high level block copy of a compound type from address src to
1008 * address dst. Must be lowered to a Call to a runtime memory copy function.
1011 * HIGH LEVEL OPERATIONS: Exception Support
1012 * ----------------------------------------
1013 * See TechReport 1999-14, chapter Exceptions.
1015 * ir_node *new_InstOf(ir_node *store, ir_node *ptr, ir_type *type);
1016 * -----------------------------------------------------------------------------------
1018 * Describes a high level type check. Must be lowered to a Call to a runtime check
1021 * ir_node *new_Raise (ir_node *store, ir_node *obj)
1022 * -------------------------------------------------
1024 * Raises an exception. Unconditional change of control flow. Writes
1025 * an explicit Except variable to memory to pass it to the exception
1026 * handler. Must be lowered to a Call to a runtime check
1031 * A pointer to the Except variable.
1033 * A tuple of control flow and the changed memory state. The control flow
1034 * points to the exception handler if it is definied in this procedure,
1035 * else it points to the end_block.
1037 * ir_node *new_Bound (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
1038 * -----------------------------------------------------------------------------------
1040 * Describes a high level bounds check. Must be lowered to a Call to a runtime check
1043 * ir_node *new_Pin (ir_node *node);
1044 * -----------------------------------------------------------------------------------
1046 * Pin the value of the node node in the current block No users of the Pin node can
1047 * float above the Block of the Pin. The node cannot float behind this block. Often
1048 * used to Pin the NoMem node.
1051 * COPING WITH DATA OBJECTS
1052 * ========================
1054 * Two kinds of data objects have to be distinguished for generating
1055 * FIRM. First there are local variables other than arrays that are
1056 * known to be alias free. Second there are all other data objects.
1057 * For the first a common SSA representation is built, the second
1058 * are modeled by saving them to memory. The memory is treated as
1059 * a single local variable, the alias problem is hidden in the
1060 * content of this variable.
1062 * All values known in a Block are listed in the block's attribute,
1063 * block.**graph_arr which is used to automatically insert Phi nodes.
1064 * The following two functions can be used to add a newly computed value
1065 * to the array, or to get the producer of a value, i.e., the current
1068 * inline void set_value (int pos, ir_node *value)
1069 * -----------------------------------------------
1071 * Has to be called for every assignment to a local variable. It
1072 * adds the value to the array of used values at position pos. Pos
1073 * has to be a unique identifier for an entry in the procedure's
1074 * definition table. It can be used to access the value again.
1075 * Requires current_block to be set correctly.
1077 * ir_node *get_value (int pos, ir_mode *mode)
1078 * -------------------------------------------
1080 * Returns the node defining the value referred to by pos. If the
1081 * value is not defined in this block a Phi node is generated and
1082 * all definitions reaching this Phi node are collected. It can
1083 * happen that the algorithm allocates an unnecessary Phi node,
1084 * e.g. if there is only one definition of this value, but this
1085 * definition reaches the currend block on several different
1086 * paths. This Phi node will be eliminated if optimizations are
1087 * turned on right after it's creation.
1088 * Requires current_block to be set correctly.
1090 * There are two special routines for the global store:
1092 * void set_store (ir_node *store)
1093 * -------------------------------
1095 * Adds the store to the array of known values at a reserved
1097 * Requires current_block to be set correctly.
1099 * ir_node *get_store (void)
1100 * -------------------------
1102 * Returns the node defining the actual store.
1103 * Requires current_block to be set correctly.
1106 * inline void keep_alive (ir_node *ka)
1107 * ------------------------------------
1109 * Keep this node alive because it is (might be) not in the control
1110 * flow from Start to End. Adds the node to the list in the end
1114 #ifndef FIRM_IR_IRCONS_H
1115 #define FIRM_IR_IRCONS_H
1117 #include "firm_types.h"
1122 * constrained flags for memory operations.
1124 typedef enum ir_cons_flags {
1125 cons_none = 0, /**< No constrains. */
1126 cons_volatile = 1U << 0, /**< Memory operation is volatile. */
1127 cons_unaligned = 1U << 1, /**< Memory operation is unaligned. */
1128 cons_floats = 1U << 2 /**< Memory operation can float. */
1131 /*-------------------------------------------------------------------------*/
1132 /* The raw interface */
1133 /*-------------------------------------------------------------------------*/
1135 /** Constructor for a Block node.
1137 * Constructs a mature block with the given predecessors.
1139 * @param *db A Pointer for debug information.
1140 * @param irg The IR graph the block belongs to.
1141 * @param arity The number of control predecessors.
1142 * @param in[] An array of control predecessors. The length of
1143 * the array must be 'arity'. The constructor copies this array.
1145 FIRM_API ir_node *new_rd_Block(dbg_info *db, ir_graph *irg, int arity, ir_node *in[]);
1147 /** Constructor for a Start node.
1149 * @param *db A pointer for debug information.
1150 * @param *irg The IR graph the node belongs to.
1152 FIRM_API ir_node *new_rd_Start(dbg_info *db, ir_graph *irg);
1154 /** Constructor for a End node.
1156 * @param *db A pointer for debug information.
1157 * @param *irg The IR graph the node belongs to.
1159 FIRM_API ir_node *new_rd_End(dbg_info *db, ir_graph *irg);
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 *block The IR block the node belongs to.
1168 FIRM_API ir_node *new_rd_Jmp(dbg_info *db, ir_node *block);
1170 /** Constructor for an IJmp node.
1172 * IJmp represents control flow to a single control successor not
1173 * statically known i.e. an indirect Jmp.
1175 * @param *db A pointer for debug information.
1176 * @param *block The IR block the node belongs to.
1177 * @param *tgt The IR node representing the target address.
1179 FIRM_API ir_node *new_rd_IJmp(dbg_info *db, ir_node *block, ir_node *tgt);
1181 /** Constructor for a Cond node.
1183 * If c is mode_b represents a conditional branch (if/else). If c is
1184 * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond
1185 * node, default Proj is 0.)
1187 * This is not consistent: Input to Cond is Is, Proj has as proj number
1190 * @param *db A pointer for debug information.
1191 * @param *block The IR block the node belongs to.
1192 * @param *c The conditions parameter. Can be of mode b or I_u.
1194 FIRM_API ir_node *new_rd_Cond(dbg_info *db, ir_node *block, ir_node *c);
1196 /** Constructor for a Return node.
1198 * Returns the memory and zero or more return values. Only node that
1199 * can end regular control flow.
1201 * @param *db A pointer for debug information.
1202 * @param *block The IR block the node belongs to.
1203 * @param *store The state of memory.
1204 * @param arity Number of return values.
1205 * @param *in Array of length arity with return values. The constructor copies this array.
1207 FIRM_API ir_node *new_rd_Return(dbg_info *db, ir_node *block,
1208 ir_node *store, int arity, ir_node *in[]);
1210 /** Constructor for a Const_type node.
1212 * Adds the node to the start block.
1214 * The constant represents a target value. This constructor sets high
1215 * level type information for the constant value.
1216 * Derives mode from passed tarval.
1218 * @param *db A pointer for debug information.
1219 * @param *irg The IR graph the node belongs to.
1220 * @param *con Points to an entry in the constant table.
1221 * @param *tp The type of the constant.
1223 FIRM_API ir_node *new_rd_Const_type(dbg_info *db, ir_graph *irg,
1224 tarval *con, ir_type *tp);
1226 /** Constructor for a Const node.
1228 * Adds the node to the start block.
1230 * Constructor for a Const node. The constant represents a target
1231 * value. Sets the type information to type_unknown. (No more
1232 * supported: If tv is entity derives a somehow useful type.)
1233 * Derives mode from passed tarval.
1235 * @param *db A pointer for debug information.
1236 * @param *irg The IR graph the node belongs to.
1237 * @param *con Points to an entry in the constant table.
1239 FIRM_API ir_node *new_rd_Const(dbg_info *db, ir_graph *irg, tarval *con);
1242 * Constructor for a Const node.
1244 * Adds the node to the start block.
1246 * Constructor for a Const node. The constant represents a target
1247 * value. Sets the type information to type_unknown. (No more
1248 * supported: If tv is entity derives a somehow useful type.)
1250 * @param *db A pointer for debug information.
1251 * @param *irg The IR graph the node belongs to.
1252 * @param *mode The mode of the operands and results.
1253 * @param value A value from which the tarval is made.
1255 FIRM_API ir_node *new_rd_Const_long(dbg_info *db, ir_graph *irg,
1256 ir_mode *mode, long value);
1258 /** Constructor for a SymConst_type node.
1260 * This is the constructor for a symbolic constant.
1261 * There are several kinds of symbolic constants:
1262 * - symconst_type_tag The symbolic constant represents a type tag. The
1263 * type the tag stands for is given explicitly.
1264 * - symconst_type_size The symbolic constant represents the size of a type.
1265 * The type of which the constant represents the size
1266 * is given explicitly.
1267 * - symconst_type_align The symbolic constant represents the alignment of a
1268 * type. The type of which the constant represents the
1269 * size is given explicitly.
1270 * - symconst_addr_ent The symbolic constant represents the address of an
1271 * entity (variable or method). The variable is given
1272 * explicitly by a firm entity.
1273 * - symconst_ofs_ent The symbolic constant represents the offset of an
1274 * entity in its owner type.
1275 * - symconst_enum_const The symbolic constant is a enumeration constant of
1276 * an enumeration type.
1278 * Inputs to the node:
1279 * No inputs except the block it belongs to.
1280 * Outputs of the node.
1281 * An unsigned integer (I_u) or a pointer (P).
1283 * Mention union in declaration so that the firmjni generator recognizes that
1284 * it can not cast the argument to an int.
1286 * @param *db A pointer for debug information.
1287 * @param *irg The IR graph the node belongs to.
1288 * @param mode The mode for the SymConst.
1289 * @param val A type, ident, entity or enum constant depending on the
1291 * @param kind The kind of the symbolic constant, see the list above
1292 * @param tp The source type of the constant.
1294 FIRM_API ir_node *new_rd_SymConst_type(dbg_info *db, ir_graph *irg,
1295 ir_mode *mode, union symconst_symbol val,
1296 symconst_kind kind, ir_type *tp);
1298 /** Constructor for a SymConst node.
1300 * Same as new_rd_SymConst_type, except that it sets the type to type_unknown.
1302 FIRM_API ir_node *new_rd_SymConst(dbg_info *db, ir_graph *irg, ir_mode *mode,
1303 union symconst_symbol value,
1304 symconst_kind kind);
1306 /** Constructor for a SymConst addr_ent node.
1308 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1309 * symconst_addr_ent.
1310 * Adds the SymConst to the start block of irg. */
1311 FIRM_API ir_node *new_rd_SymConst_addr_ent(dbg_info *db, ir_graph *irg,
1312 ir_mode *mode, ir_entity *symbol,
1315 /** Constructor for a SymConst ofs_ent node.
1317 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1319 * Adds the SymConst to the start block of irg.
1321 FIRM_API ir_node *new_rd_SymConst_ofs_ent(dbg_info *db, ir_graph *irg,
1322 ir_mode *mode, ir_entity *symbol,
1325 /** Constructor for a SymConst type_tag node.
1327 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1328 * symconst_type_tag.
1329 * Adds the SymConst to the start block of irg.
1331 FIRM_API ir_node *new_rd_SymConst_type_tag(dbg_info *db, ir_graph *irg,
1332 ir_mode *mode, ir_type *symbol,
1335 /** Constructor for a SymConst size node.
1337 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1338 * symconst_type_size.
1339 * Adds the SymConst to the start block of irg. */
1340 FIRM_API ir_node *new_rd_SymConst_size(dbg_info *db, ir_graph *irg,
1341 ir_mode *mode, ir_type *symbol,
1344 /** Constructor for a SymConst size node.
1346 * Same as new_rd_SymConst_type, except that the constructor is tailored for
1347 * symconst_type_align.
1348 * Adds the SymConst to the start block of irg.
1350 FIRM_API ir_node *new_rd_SymConst_align(dbg_info *db, ir_graph *irg,
1351 ir_mode *mode, ir_type *symbol,
1354 /** Constructor for a simpleSel node.
1356 * This is a shortcut for the new_rd_Sel() constructor. To be used for
1357 * Sel nodes that do not select from an array, i.e., have no index
1358 * inputs. It adds the two parameters 0, NULL.
1360 * @param *db A pointer for debug information.
1361 * @param *block The IR block the node belongs to.
1362 * @param *store The memory in which the object the entity should be
1363 * selected from is allocated.
1364 * @param *objptr The object from that the Sel operation selects a
1365 * single attribute out.
1366 * @param *ent The entity to select.
1368 FIRM_API ir_node *new_rd_simpleSel(dbg_info *db, ir_node *block, ir_node *store,
1369 ir_node *objptr, ir_entity *ent);
1371 /** Constructor for a Sel node.
1373 * The select node selects an entity (field or method) from an entity
1374 * with a compound type. It explicitly specifies the entity selected.
1375 * Dynamically the node may select entities that overwrite the given
1376 * entity. If the selected entity is an array element entity the Sel
1377 * node takes the required array indices as inputs.
1379 * @param *db A pointer for debug information.
1380 * @param *block The IR block the node belongs to.
1381 * @param *store The memory in which the object the entity should be selected
1382 * from is allocated.
1383 * @param *objptr A pointer to a compound entity the Sel operation selects a
1384 * single attribute from.
1385 * @param *n_index The number of array indices needed to select an array element entity.
1386 * @param *index[] If the compound entity is an array the indices of the selected
1387 * element entity. The constructor copies this array.
1388 * @param *ent The entity to select.
1390 FIRM_API ir_node *new_rd_Sel(dbg_info *db, ir_node *block, ir_node *store,
1391 ir_node *objptr, int n_index, ir_node *index[],
1394 /** Constructor for a Call node.
1396 * Represents all kinds of method and function calls.
1398 * @param *db A pointer for debug information.
1399 * @param *block The IR block the node belongs to.
1400 * @param *store The current memory state.
1401 * @param *callee A pointer to the called procedure.
1402 * @param arity The number of procedure parameters.
1403 * @param *in[] An array with the procedure parameters. The constructor copies this array.
1404 * @param *tp Type information of the procedure called.
1406 FIRM_API ir_node *new_rd_Call(dbg_info *db, ir_node *block, ir_node *store,
1407 ir_node *callee, int arity, ir_node *in[],
1410 /** Constructor for a Builtin node.
1412 * Represents a call of a backend-specific builtin..
1414 * @param *db A pointer for debug information.
1415 * @param *block The IR block the node belongs to.
1416 * @param *store The current memory state.
1417 * @param arity The number of procedure parameters.
1418 * @param *in[] An array with the procedure parameters. The constructor copies this array.
1419 * @param kind The kind of the called builtin.
1420 * @param *tp Type information of the procedure called.
1422 FIRM_API ir_node *new_rd_Builtin(dbg_info *db, ir_node *block, ir_node *store,
1423 int arity, ir_node *in[], ir_builtin_kind kind,
1426 /** Constructor for a Add node.
1428 * @param *db A pointer for debug information.
1429 * @param *block The IR block the node belongs to.
1430 * @param *op1 The first operand.
1431 * @param *op2 The second operand.
1432 * @param *mode The mode of the operands and the result.
1434 FIRM_API ir_node *new_rd_Add(dbg_info *db, ir_node *block, ir_node *op1,
1435 ir_node *op2, ir_mode *mode);
1437 /** Constructor for a Sub node.
1439 * @param *db A pointer for debug information.
1440 * @param *block The IR block the node belongs to.
1441 * @param *op1 The first operand.
1442 * @param *op2 The second operand.
1443 * @param *mode The mode of the operands and the result.
1445 FIRM_API ir_node *new_rd_Sub(dbg_info *db, ir_node *block,
1446 ir_node *op1, ir_node *op2, ir_mode *mode);
1448 /** Constructor for a Minus node.
1450 * @param *db A pointer for debug information.
1451 * @param *block The IR block the node belongs to.
1452 * @param *op The operand .
1453 * @param *mode The mode of the operand and the result.
1455 FIRM_API ir_node *new_rd_Minus(dbg_info *db, ir_node *block,
1456 ir_node *op, ir_mode *mode);
1458 /** Constructor for a Mul node.
1460 * @param *db A pointer for debug information.
1461 * @param *block The IR block the node belongs to.
1462 * @param *op1 The first operand.
1463 * @param *op2 The second operand.
1464 * @param *mode The mode of the operands and the result.
1466 FIRM_API ir_node *new_rd_Mul(dbg_info *db, ir_node *block,
1467 ir_node *op1, ir_node *op2, ir_mode *mode);
1469 /** Constructor for a Mulh node.
1471 * @param *db A pointer for debug information.
1472 * @param *block The IR block the node belongs to.
1473 * @param *op1 The first operand.
1474 * @param *op2 The second operand.
1475 * @param *mode The mode of the operands and the result.
1477 FIRM_API ir_node *new_rd_Mulh(dbg_info *db, ir_node *block,
1478 ir_node *op1, ir_node *op2, ir_mode *mode);
1480 /** Constructor for a Quot node.
1482 * @param *db A pointer for debug information.
1483 * @param *block The IR block the node belongs to.
1484 * @param *memop The store needed to model exceptions
1485 * @param *op1 The first operand.
1486 * @param *op2 The second operand.
1487 * @param *mode The mode of the result.
1488 * @param state The pinned state.
1490 FIRM_API ir_node *new_rd_Quot(dbg_info *db, ir_node *block, ir_node *memop,
1491 ir_node *op1, ir_node *op2, ir_mode *mode,
1492 op_pin_state state);
1494 /** Constructor for a DivMod node.
1496 * @param *db A pointer for debug information.
1497 * @param *block The IR block the node belongs to.
1498 * @param *memop The store needed to model exceptions
1499 * @param *op1 The first operand.
1500 * @param *op2 The second operand.
1501 * @param *mode The mode of the results.
1502 * @param state The pinned state.
1504 FIRM_API ir_node *new_rd_DivMod(dbg_info *db, ir_node *block, ir_node *memop,
1505 ir_node *op1, ir_node *op2, ir_mode *mode,
1506 op_pin_state state);
1508 /** Constructor for a Div node.
1510 * @param *db A pointer for debug information.
1511 * @param *block The IR block the node belongs to.
1512 * @param *memop The store needed to model exceptions
1513 * @param *op1 The first operand.
1514 * @param *op2 The second operand.
1515 * @param *mode The mode of the result.
1516 * @param state The pinned state.
1518 FIRM_API ir_node *new_rd_Div(dbg_info *db, ir_node *block, ir_node *memop,
1519 ir_node *op1, ir_node *op2, ir_mode *mode,
1520 op_pin_state state);
1522 /** Constructor for a remainderless Div node.
1524 * @param *db A pointer for debug information.
1525 * @param *block The IR block the node belongs to.
1526 * @param *memop The store needed to model exceptions
1527 * @param *op1 The first operand.
1528 * @param *op2 The second operand.
1529 * @param *mode The mode of the result.
1530 * @param state The pinned state.
1532 FIRM_API ir_node *new_rd_DivRL(dbg_info *db, ir_node *block, ir_node *memop,
1533 ir_node *op1, ir_node *op2, ir_mode *mode,
1534 op_pin_state state);
1536 /** Constructor for a Mod node.
1538 * @param *db A pointer for debug information.
1539 * @param *block The IR block the node belongs to.
1540 * @param *memop The store needed to model exceptions
1541 * @param *op1 The first operand.
1542 * @param *op2 The second operand.
1543 * @param *mode The mode of the result.
1544 * @param state The pinned state.
1546 FIRM_API ir_node *new_rd_Mod(dbg_info *db, ir_node *block, ir_node *memop,
1547 ir_node *op1, ir_node *op2, ir_mode *mode,
1548 op_pin_state state);
1550 /** Constructor for a And node.
1552 * @param *db A pointer for debug information.
1553 * @param *block The IR block the node belongs to.
1554 * @param *op1 The first operand.
1555 * @param *op2 The second operand.
1556 * @param *mode The mode of the operands and the result.
1558 FIRM_API ir_node *new_rd_And(dbg_info *db, ir_node *block,
1559 ir_node *op1, ir_node *op2, ir_mode *mode);
1561 /** Constructor for a Or node.
1563 * @param *db A pointer for debug information.
1564 * @param *block The IR block the node belongs to.
1565 * @param *op1 The first operand.
1566 * @param *op2 The second operand.
1567 * @param *mode The mode of the operands and the result.
1569 FIRM_API ir_node *new_rd_Or(dbg_info *db, ir_node *block,
1570 ir_node *op1, ir_node *op2, ir_mode *mode);
1572 /** Constructor for a Eor node.
1574 * @param *db A pointer for debug information.
1575 * @param *block The IR block the node belongs to.
1576 * @param *op1 The first operand.
1577 * @param *op2 The second operand.
1578 * @param *mode The mode of the operands and the results.
1580 FIRM_API ir_node *new_rd_Eor(dbg_info *db, ir_node *block,
1581 ir_node *op1, ir_node *op2, ir_mode *mode);
1583 /** Constructor for a Not node.
1585 * @param *db A pointer for debug information.
1586 * @param *block The IR block the node belongs to.
1587 * @param *op The operand.
1588 * @param *mode The mode of the operand and the result.
1590 FIRM_API ir_node *new_rd_Not(dbg_info *db, ir_node *block, ir_node *op,
1593 /** Constructor for a Cmp node.
1595 * @param *db A pointer for debug information.
1596 * @param *block The IR block the node belongs to.
1597 * @param *op1 The first operand.
1598 * @param *op2 The second operand.
1600 FIRM_API ir_node *new_rd_Cmp(dbg_info *db, ir_node *block,
1601 ir_node *op1, ir_node *op2);
1603 /** Constructor for a Shl node.
1605 * @param *db A pointer for debug information.
1606 * @param *block The IR block the node belongs to.
1607 * @param *op The operand.
1608 * @param *k The number of bits to shift the operand .
1609 * @param *mode The mode of the operand and the result.
1611 FIRM_API ir_node *new_rd_Shl(dbg_info *db, ir_node *block,
1612 ir_node *op, ir_node *k, ir_mode *mode);
1614 /** Constructor for a Shr node.
1616 * @param *db A pointer for debug information.
1617 * @param *block The IR block the node belongs to.
1618 * @param *op The operand.
1619 * @param *k The number of bits to shift the operand .
1620 * @param *mode The mode of the operand and the result.
1622 FIRM_API ir_node *new_rd_Shr(dbg_info *db, ir_node *block,
1623 ir_node *op, ir_node *k, ir_mode *mode);
1625 /** Constructor for a Shrs node.
1627 * @param *db A pointer for debug information.
1628 * @param *block The IR block the node belongs to.
1629 * @param *op The operand.
1630 * @param *k The number of bits to shift the operand.
1631 * @param *mode The mode of the operand and the result.
1633 FIRM_API ir_node *new_rd_Shrs(dbg_info *db, ir_node *block,
1634 ir_node *op, ir_node *k, ir_mode *mode);
1636 /** Constructor for a Rotl node.
1638 * @param *db A pointer for debug information.
1639 * @param *block The IR block the node belongs to.
1640 * @param *op The operand.
1641 * @param *k The number of bits to rotate the operand.
1642 * @param *mode The mode of the operand.
1644 FIRM_API ir_node *new_rd_Rotl(dbg_info *db, ir_node *block,
1645 ir_node *op, ir_node *k, ir_mode *mode);
1648 /** Constructor for a Conv node.
1650 * @param *db A pointer for debug information.
1651 * @param *block The IR block the node belongs to.
1652 * @param *op The operand.
1653 * @param *mode The mode of this the operand muss be converted .
1655 FIRM_API ir_node *new_rd_Conv(dbg_info *db, ir_node *block, ir_node *op,
1658 /** Constructor for a strictConv node.
1660 * @param *db A pointer for debug information.
1661 * @param *block The IR block the node belongs to.
1662 * @param *op The operand.
1663 * @param *mode The mode of this the operand muss be converted .
1665 FIRM_API ir_node *new_rd_strictConv(dbg_info *db, ir_node *block,
1666 ir_node *op, ir_mode *mode);
1668 /** Constructor for a Cast node.
1670 * High level type cast.
1672 * @param *db A pointer for debug information.
1673 * @param *block The IR block the node belongs to.
1674 * @param *op The operand.
1675 * @param *to_tp The type of this the operand muss be casted .
1677 FIRM_API ir_node *new_rd_Cast(dbg_info *db, ir_node *block,
1678 ir_node *op, ir_type *to_tp);
1680 /** Constructor for a Carry node.
1681 * Note: This node is not supported by the backends! Only use for program
1684 * @param *db A pointer for debug information.
1685 * @param *block The IR block the node belongs to.
1686 * @param *op1 The first operand.
1687 * @param *op2 The second operand.
1688 * @param *mode The mode of the operands and the result.
1690 FIRM_API ir_node *new_rd_Carry(dbg_info *db, ir_node *block,
1691 ir_node *op1, ir_node *op2, ir_mode *mode);
1693 /** Constructor for a Borrow node.
1694 * Note: This node is not supported by the backends! Only use for program
1697 * @param *db A pointer for debug information.
1698 * @param *block The IR block the node belongs to.
1699 * @param *op1 The first operand.
1700 * @param *op2 The second operand.
1701 * @param *mode The mode of the operands and the result.
1703 FIRM_API ir_node *new_rd_Borrow(dbg_info *db, ir_node *block,
1704 ir_node *op1, ir_node *op2, ir_mode *mode);
1706 /** Constructor for a Phi node.
1708 * @param *db A pointer for debug information.
1709 * @param *block The IR block the node belongs to.
1710 * @param arity The number of predecessors
1711 * @param *in[] Array with predecessors. The constructor copies this array.
1712 * @param *mode The mode of it's inputs and output.
1714 FIRM_API ir_node *new_rd_Phi(dbg_info *db, ir_node *block, int arity,
1715 ir_node *in[], ir_mode *mode);
1717 /** Constructor for a Load node.
1719 * @param *db A pointer for debug information.
1720 * @param *block The IR block the node belongs to.
1721 * @param *store The current memory
1722 * @param *adr A pointer to the variable to be read in this memory.
1723 * @param *mode The mode of the value to be loaded.
1724 * @param flags Additional flags for alignment, volatility and pin state.
1726 FIRM_API ir_node *new_rd_Load(dbg_info *db, ir_node *block, ir_node *store,
1727 ir_node *adr, ir_mode *mode, ir_cons_flags flags);
1729 /** Constructor for a Store node.
1731 * @param *db A pointer for debug information.
1732 * @param *block The IR block the node belongs to.
1733 * @param *store The current memory
1734 * @param *adr A pointer to the variable to be read in this memory.
1735 * @param *val The value to write to this variable.
1736 * @param flags Additional flags for alignment, volatility and pin state.
1738 FIRM_API ir_node *new_rd_Store(dbg_info *db, ir_node *block, ir_node *store,
1739 ir_node *adr, ir_node *val, ir_cons_flags flags);
1741 /** Constructor for a Alloc node.
1743 * The Alloc node extends the memory by space for an entity of type alloc_type.
1745 * @param *db A pointer for debug information.
1746 * @param *block The IR block the node belongs to.
1747 * @param *store The memory which shall contain the new variable.
1748 * @param *count The number of objects to allocate.
1749 * @param *alloc_type The type of the allocated variable.
1750 * @param where Where to allocate the variable, either heap_alloc or stack_alloc.
1752 FIRM_API ir_node *new_rd_Alloc(dbg_info *db, ir_node *block, ir_node *store,
1753 ir_node *count, ir_type *alloc_type,
1754 ir_where_alloc where);
1756 /** Constructor for a Free node.
1758 * Frees the memory occupied by the entity pointed to by the pointer
1759 * arg. Type indicates the type of the entity the argument points to.
1761 * @param *db A pointer for debug information.
1762 * @param *block The IR block the node belongs to.
1763 * @param *store The memory which shall contain the new variable.
1764 * @param *ptr The pointer to the object to free.
1765 * @param *size The number of objects of type free_type to free in a sequence.
1766 * @param *free_type The type of the freed variable.
1767 * @param where Where the variable was allocated, either heap_alloc or stack_alloc.
1769 FIRM_API ir_node *new_rd_Free(dbg_info *db, ir_node *block, ir_node *store,
1770 ir_node *ptr, ir_node *size, ir_type *free_type,
1771 ir_where_alloc where);
1773 /** Constructor for a Sync node.
1775 * Merges several memory values. The node assumes that a variable
1776 * either occurs only in one of the memories, or it contains the same
1777 * value in all memories where it occurs.
1779 * @param *db A pointer for debug information.
1780 * @param *block The IR block the node belongs to.
1781 * @param arity The number of memories to synchronize.
1782 * @param *in[] An array of pointers to nodes that produce an output of type
1783 * memory. The constructor copies this array.
1785 FIRM_API ir_node *new_rd_Sync(dbg_info *db, ir_node *block, int arity,
1788 /** Constructor for a Proj node.
1790 * Projects a single value out of a tuple. The parameter proj gives the
1791 * position of the value within the tuple.
1793 * @param *db A pointer for debug information.
1794 * @param arg A node producing a tuple. The node must have mode_T.
1795 * @param *mode The mode of the value to project.
1796 * @param proj The position of the value in the tuple.
1798 FIRM_API ir_node *new_rd_Proj(dbg_info *db, ir_node *arg, ir_mode *mode,
1801 /** Constructor for a defaultProj node.
1803 * Represents the default control flow of a Switch-Cond node.
1805 * @param *db A pointer for debug information.
1806 * @param arg A node producing a tuple.
1807 * @param max_proj The end position of the value in the tuple.
1809 FIRM_API ir_node *new_rd_defaultProj(dbg_info *db, ir_node *arg, long max_proj);
1811 /** Constructor for a Tuple node.
1813 * This is an auxiliary node to replace a node that returns a tuple
1814 * without changing the corresponding Proj nodes.
1816 * @param *db A pointer for debug information.
1817 * @param *block The IR block the node belongs to.
1818 * @param arity The number of tuple elements.
1819 * @param *in[] An array containing pointers to the nodes producing the tuple
1820 * elements. The constructor copies this array.
1822 FIRM_API ir_node *new_rd_Tuple(dbg_info *db, ir_node *block,
1823 int arity, ir_node *in[]);
1825 /** Constructor for a Id node.
1827 * This is an auxiliary node to replace a node that returns a single
1830 * @param *db A pointer for debug information.
1831 * @param *block The IR block the node belongs to.
1832 * @param *val The value
1833 * @param *mode The mode of *val.
1835 FIRM_API ir_node *new_rd_Id(dbg_info *db, ir_node *block,
1836 ir_node *val, ir_mode *mode);
1838 /** Constructor for a Confirm node.
1840 * Specifies constraints for a value. To support dataflow analyses.
1842 * Example: If the value never exceeds '100' this is expressed by placing a
1843 * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge.
1845 * @param *db A pointer for debug information.
1846 * @param *block The IR block the node belong to.
1847 * @param *val The value we express a constraint for
1848 * @param *bound The value to compare against. Must be a firm node, typically a constant.
1849 * @param cmp The compare operation.
1851 FIRM_API ir_node *new_rd_Confirm(dbg_info *db, ir_node *block,
1852 ir_node *val, ir_node *bound, pn_Cmp cmp);
1854 /** Constructor for an Unknown node.
1856 * Represents an arbitrary value. Places the node in the start block.
1858 * @param *db A pointer for debug information.
1859 * @param *irg The IR graph the node belongs to.
1860 * @param *m The mode of the unknown value.
1862 FIRM_API ir_node *new_rd_Unknown(dbg_info *db, ir_graph *irg, ir_mode *m);
1864 /** Constructor for a Mux node.
1866 * @param *db A pointer for debug information.
1867 * @param *block The block the node belong to.
1868 * @param *sel The ir_node that calculates the boolean select.
1869 * @param *ir_true The ir_node that calculates the true result.
1870 * @param *ir_false The ir_node that calculates the false result.
1871 * @param *mode The mode of the node (and it_true and ir_false).
1873 FIRM_API ir_node *new_rd_Mux(dbg_info *db, ir_node *block, ir_node *sel,
1874 ir_node *ir_false, ir_node *ir_true,
1877 /** Constructor for a CopyB node.
1879 * @param *db A pointer for debug information.
1880 * @param *block The block the node belong to.
1881 * @param *store The current memory
1882 * @param *dst The ir_node that represents the destination address.
1883 * @param *src The ir_node that represents the source address.
1884 * @param *data_type The type of the copied data
1886 FIRM_API ir_node *new_rd_CopyB(dbg_info *db, ir_node *block, ir_node *store,
1887 ir_node *dst, ir_node *src, ir_type *data_type);
1889 /** Constructor for a InstOf node.
1891 * A High-Level Type check.
1893 * @param *db A pointer for debug information.
1894 * @param *block The IR block the node belongs to.
1895 * @param *store The memory in which the object the entity should be selected
1896 * from is allocated.
1897 * @param *objptr A pointer to a object of a class type.
1898 * @param *type The type of which objptr must be.
1900 FIRM_API ir_node *new_rd_InstOf(dbg_info *db, ir_node *block, ir_node *store,
1901 ir_node *objptr, ir_type *type);
1903 /** Constructor for a Raise node.
1905 * A High-Level Exception throw.
1907 * @param *db A pointer for debug information.
1908 * @param *block The IR block the node belongs to.
1909 * @param *store The current memory.
1910 * @param *obj A pointer to the Except variable.
1912 FIRM_API ir_node *new_rd_Raise(dbg_info *db, ir_node *block, ir_node *store,
1915 /** Constructor for a Bound node.
1917 * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
1919 * @param *db A pointer for debug information.
1920 * @param *block The block the node belong to.
1921 * @param *store The current memory.
1922 * @param *idx The ir_node that represents an index.
1923 * @param *lower The ir_node that represents the lower bound for the index.
1924 * @param *upper The ir_node that represents the upper bound for the index.
1926 FIRM_API ir_node *new_rd_Bound(dbg_info *db, ir_node *block,
1927 ir_node *store, ir_node *idx, ir_node *lower,
1930 /** Constructor for a Pin node.
1932 * @param *db A pointer for debug information.
1933 * @param *block The block the node belong to.
1934 * @param *node The node which value should be pinned.
1936 FIRM_API ir_node *new_rd_Pin(dbg_info *db, ir_node *block, ir_node *node);
1938 /** Constructor for an ASM pseudo node.
1940 * @param *db A pointer for debug information.
1941 * @param *block The block the node belong to.
1942 * @param arity The number of data inputs to the node.
1943 * @param *in The array of length arity of data inputs.
1944 * @param *inputs The array of length arity of input constraints.
1945 * @param n_outs The number of data outputs to the node.
1946 * @param *outputs The array of length n_outs of output constraints.
1947 * @param n_clobber The number of clobbered registers.
1948 * @param *clobber The array of length n_clobber of clobbered registers.
1949 * @param *asm_text The assembler text.
1951 FIRM_API ir_node *new_rd_ASM(dbg_info *db, ir_node *block,
1952 int arity, ir_node *in[], ir_asm_constraint *inputs,
1953 int n_outs, ir_asm_constraint *outputs,
1954 int n_clobber, ident *clobber[], ident *asm_text);
1956 /*-------------------------------------------------------------------------*/
1957 /* The raw interface without debug support */
1958 /*-------------------------------------------------------------------------*/
1960 /** Constructor for a Block node.
1962 * Constructs a mature block with the given predecessors. Use Unknown
1963 * nodes as predecessors to construct a block if the number of
1964 * predecessors is known, but not the predecessors themselves. This
1965 * constructor does not set current_block. It not be used with
1966 * automatic Phi node construction.
1969 * @param irg The IR graph the block belongs to.
1970 * @param arity The number of control predecessors.
1971 * @param in[] An array of control predecessors. The length of
1972 * the array must be 'arity'. The constructor copies this array.
1974 FIRM_API ir_node *new_r_Block(ir_graph *irg, int arity, ir_node *in[]);
1976 /** Constructor for a Start node. */
1977 FIRM_API ir_node *new_r_Start(ir_graph *irg);
1979 /** Constructor for a End node. */
1980 FIRM_API ir_node *new_r_End(ir_graph *irg);
1982 /** Constructor for a Jmp node.
1984 * Jmp represents control flow to a single control successor.
1986 * @param *block The IR block the node belongs to.
1988 FIRM_API ir_node *new_r_Jmp(ir_node *block);
1990 /** Constructor for an IJmp node.
1992 * IJmp represents control flow to a single control successor not
1993 * statically known i.e. an indirect Jmp.
1995 * @param *block The IR block the node belongs to.
1996 * @param *tgt The IR node representing the target address.
1998 FIRM_API ir_node *new_r_IJmp(ir_node *block, ir_node *tgt);
2000 /** Constructor for a Cond node.
2002 * If c is mode_b represents a conditional branch (if/else). If c is
2003 * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond
2004 * node, default Proj is 0.)
2006 * This is not consistent: Input to Cond is Is, Proj has as proj number
2009 * @param *block The IR block the node belongs to.
2010 * @param *c The conditions parameter.Can be of mode b or I_u.
2012 FIRM_API ir_node *new_r_Cond(ir_node *block, ir_node *c);
2014 /** Constructor for a Return node.
2016 * Returns the memory and zero or more return values. Only node that
2017 * can end regular control flow.
2019 * @param *block The IR block the node belongs to.
2020 * @param *store The state of memory.
2021 * @param arity Number of array indices.
2022 * @param *in[] Array with index inputs to the node. The constructor copies this array.
2024 FIRM_API ir_node *new_r_Return(ir_node *block, ir_node *store,
2025 int arity, ir_node *in[]);
2027 /** Constructor for a Const node.
2029 * Adds the node to the start block.
2031 * Constructor for a Const node. The constant represents a target
2032 * value. Sets the type information to type_unknown. (No more
2033 * supported: If tv is entity derives a somehow useful type.)
2034 * Derives mode from passed tarval.
2036 * @param *irg The IR graph the node belongs to.
2037 * @param *con Points to an entry in the constant table.
2039 FIRM_API ir_node *new_r_Const(ir_graph *irg, tarval *con);
2041 /** Constructor for a Const node.
2043 * Adds the node to the start block.
2045 * Constructor for a Const node. The constant represents a target
2046 * value. Sets the type information to type_unknown. (No more
2047 * supported: If tv is entity derives a somehow useful type.)
2049 * @param *irg The IR graph the node belongs to.
2050 * @param *mode The mode of the operands and the results.
2051 * @param value A value from which the tarval is made.
2053 FIRM_API ir_node *new_r_Const_long(ir_graph *irg, ir_mode *mode, long value);
2055 /** Constructor for a Const_type node.
2057 * Adds the node to the start block.
2059 * The constant represents a target value. This constructor sets high
2060 * level type information for the constant value.
2061 * Derives mode from passed tarval.
2063 * @param *irg The IR graph the node belongs to.
2064 * @param *con Points to an entry in the constant table.
2065 * @param *tp The type of the constant.
2067 FIRM_API ir_node *new_r_Const_type(ir_graph *irg, tarval *con, ir_type *tp);
2069 /** Constructor for a SymConst node.
2071 * This is the constructor for a symbolic constant.
2072 * There are several kinds of symbolic constants:
2073 * - symconst_type_tag The symbolic constant represents a type tag. The
2074 * type the tag stands for is given explicitly.
2075 * - symconst_type_size The symbolic constant represents the size of a type.
2076 * The type of which the constant represents the size
2077 * is given explicitly.
2078 * - symconst_type_align The symbolic constant represents the alignment of a
2079 * type. The type of which the constant represents the
2080 * size is given explicitly.
2081 * - symconst_addr_ent The symbolic constant represents the address of an
2082 * entity (variable or method). The variable is given
2083 * explicitly by a firm entity.
2084 * - symconst_ofs_ent The symbolic constant represents the offset of an
2085 * entity in its owner type.
2086 * - symconst_enum_const The symbolic constant is a enumeration constant of
2087 * an enumeration type.
2089 * Inputs to the node:
2090 * No inputs except the block it belongs to.
2091 * Outputs of the node.
2092 * An unsigned integer (I_u) or a pointer (P).
2094 * Mention union in declaration so that the firmjni generator recognizes that
2095 * it can not cast the argument to an int.
2097 * @param *irg The IR graph the node belongs to.
2098 * @param mode The mode for the SymConst.
2099 * @param value A type, ident, entity or enum constant depending on the
2101 * @param kind The kind of the symbolic constant, see the list above
2103 FIRM_API ir_node *new_r_SymConst(ir_graph *irg, ir_mode *mode,
2104 union symconst_symbol value,
2105 symconst_kind kind);
2107 /** Constructor for a simpleSel node.
2109 * This is a shortcut for the new_d_Sel() constructor. To be used for
2110 * Sel nodes that do not select from an array, i.e., have no index
2111 * inputs. It adds the two parameters 0, NULL.
2113 * @param *block The IR block the node belongs to.
2114 * @param *store The memory in which the object the entity should be selected
2115 * from is allocated.
2116 * @param *objptr The object from that the Sel operation selects a
2117 * single attribute out.
2118 * @param *ent The entity to select.
2120 FIRM_API ir_node *new_r_simpleSel(ir_node *block, ir_node *store,
2121 ir_node *objptr, ir_entity *ent);
2123 /** Constructor for a Sel node.
2125 * The select node selects an entity (field or method) from an entity
2126 * with a compound type. It explicitly specifies the entity selected.
2127 * Dynamically the node may select entities that overwrite the given
2128 * entity. If the selected entity is an array element entity the Sel
2129 * node takes the required array indices as inputs.
2131 * @param *block The IR block the node belongs to.
2132 * @param *store The memory in which the object the entity should be selected
2133 * from is allocated.
2134 * @param *objptr A pointer to a compound entity the Sel operation selects a
2135 * single attribute from.
2136 * @param *n_index The number of array indices needed to select an array element entity.
2137 * @param *index[] If the compound entity is an array the indices of the selected
2138 * element entity. The constructor copies this array.
2139 * @param *ent The entity to select.
2141 FIRM_API ir_node *new_r_Sel(ir_node *block, ir_node *store,
2142 ir_node *objptr, int n_index, ir_node *index[],
2145 /** Constructor for a Call node.
2147 * Represents all kinds of method and function calls.
2149 * @param *block The IR block the node belongs to.
2150 * @param *store The actual store.
2151 * @param *callee A pointer to the called procedure.
2152 * @param arity The number of procedure parameters.
2153 * @param *in[] An array with the pointers to the parameters. The constructor copies this array.
2154 * @param *tp Type information of the procedure called.
2156 FIRM_API ir_node *new_r_Call(ir_node *block, ir_node *store,
2157 ir_node *callee, int arity, ir_node *in[],
2160 /** Constructor for a Builtin node.
2162 * Represents a call of a backend-specific builtin..
2164 * @param *block The IR block the node belongs to.
2165 * @param *store The actual store.
2166 * @param arity The number of procedure parameters.
2167 * @param *in[] An array with the pointers to the parameters. The constructor copies this array.
2168 * @param kind The kind of the called builtin.
2169 * @param *tp Type information of the procedure called.
2171 FIRM_API ir_node *new_r_Builtin(ir_node *block, ir_node *store,
2172 int arity, ir_node *in[], ir_builtin_kind kind,
2175 /** Constructor for a Add node.
2177 * @param *block The IR block the node belongs to.
2178 * @param *op1 The first operand.
2179 * @param *op2 The second operand.
2180 * @param *mode The mode of the operands and the result.
2182 FIRM_API ir_node *new_r_Add(ir_node *block, ir_node *op1, ir_node *op2,
2186 * Constructor for a Sub node.
2188 * @param *block The IR block the node belongs to.
2189 * @param *op1 The first operand.
2190 * @param *op2 The second operand.
2191 * @param *mode The mode of the operands and the results.
2193 FIRM_API ir_node *new_r_Sub(ir_node *block, ir_node *op1, ir_node *op2,
2196 /** Constructor for a Minus node.
2198 * @param *block The IR block the node belongs to.
2199 * @param *op The operand.
2200 * @param *mode The mode of the operand and the result.
2202 FIRM_API ir_node *new_r_Minus(ir_node *block, ir_node *op, ir_mode *mode);
2204 /** Constructor for a Mul node.
2206 * @param *block The IR block the node belongs to.
2207 * @param *op1 The first operand.
2208 * @param *op2 The second operand.
2209 * @param *mode The mode of the operands and the result.
2211 FIRM_API ir_node *new_r_Mul(ir_node *block, ir_node *op1, ir_node *op2,
2214 /** Constructor for a Mulh node.
2216 * @param *block The IR block the node belongs to.
2217 * @param *op1 The first operand.
2218 * @param *op2 The second operand.
2219 * @param *mode The mode of the operands and the result.
2221 FIRM_API ir_node *new_r_Mulh(ir_node *block, ir_node *op1, ir_node *op2,
2224 /** Constructor for a Quot node.
2226 * @param *block The IR block the node belongs to.
2227 * @param *memop The store needed to model exceptions
2228 * @param *op1 The first operand.
2229 * @param *op2 The second operand.
2230 * @param *mode The mode of the result.
2231 * @param state The pinned state.
2233 FIRM_API ir_node *new_r_Quot(ir_node *block, ir_node *memop,
2234 ir_node *op1, ir_node *op2, ir_mode *mode,
2235 op_pin_state state);
2237 /** Constructor for a DivMod node.
2239 * @param *block The IR block the node belongs to.
2240 * @param *memop The store needed to model exceptions
2241 * @param *op1 The first operand.
2242 * @param *op2 The second operand.
2243 * @param *mode The mode of the results.
2244 * @param state The pinned state.
2246 FIRM_API ir_node *new_r_DivMod(ir_node *block, ir_node *memop,
2247 ir_node *op1, ir_node *op2, ir_mode *mode,
2248 op_pin_state state);
2250 /** Constructor for a Div node.
2252 * @param *block The IR block the node belongs to.
2253 * @param *memop The store needed to model exceptions
2254 * @param *op1 The first operand.
2255 * @param *op2 The second operand.
2256 * @param *mode The mode of the result.
2257 * @param state The pinned state.
2259 FIRM_API ir_node *new_r_Div(ir_node *block, ir_node *memop,
2260 ir_node *op1, ir_node *op2, ir_mode *mode,
2261 op_pin_state state);
2263 /** Constructor for a remainderless Div node.
2265 * @param *block The IR block the node belongs to.
2266 * @param *memop The store needed to model exceptions
2267 * @param *op1 The first operand.
2268 * @param *op2 The second operand.
2269 * @param *mode The mode of the result.
2270 * @param state The pinned state.
2272 FIRM_API ir_node *new_r_DivRL(ir_node *block, ir_node *memop,
2273 ir_node *op1, ir_node *op2, ir_mode *mode,
2274 op_pin_state state);
2276 /** Constructor for a Mod node.
2278 * @param *block The IR block the node belongs to.
2279 * @param *memop The store needed to model exceptions
2280 * @param *op1 The first operand.
2281 * @param *op2 The second operand.
2282 * @param *mode The mode of the result.
2283 * @param state The pinned state.
2285 FIRM_API ir_node *new_r_Mod(ir_node *block, ir_node *memop,
2286 ir_node *op1, ir_node *op2, ir_mode *mode,
2287 op_pin_state state);
2289 /** Constructor for a And node.
2291 * @param *block The IR block the node belongs to.
2292 * @param *op1 The first operand.
2293 * @param *op2 The second operand.
2294 * @param *mode The mode of the operands and the result.
2296 FIRM_API ir_node *new_r_And(ir_node *block, ir_node *op1, ir_node *op2,
2299 /** Constructor for a Or node.
2301 * @param *block The IR block the node belongs to.
2302 * @param *op1 The first operand.
2303 * @param *op2 The second operand.
2304 * @param *mode The mode of the operands and the result.
2306 FIRM_API ir_node *new_r_Or(ir_node *block, ir_node *op1, ir_node *op2,
2309 /** Constructor for a Eor node.
2311 * @param *block The IR block the node belongs to.
2312 * @param *op1 The first operand.
2313 * @param *op2 The second operand.
2314 * @param *mode The mode of the operands and the results.
2316 FIRM_API ir_node *new_r_Eor(ir_node *block, ir_node *op1, ir_node *op2,
2319 /** Constructor for a Not node.
2321 * @param *block The IR block the node belongs to.
2322 * @param *op The operand.
2323 * @param *mode The mode of the operand and the result.
2325 FIRM_API ir_node *new_r_Not(ir_node *block, ir_node *op, ir_mode *mode);
2327 /** Constructor for a Cmp node.
2329 * @param *block The IR block the node belongs to.
2330 * @param *op1 The first operand.
2331 * @param *op2 The second operand.
2333 FIRM_API ir_node *new_r_Cmp(ir_node *block, ir_node *op1, ir_node *op2);
2335 /** Constructor for a Shl node.
2337 * @param *block The IR block the node belongs to.
2338 * @param *op The operand.
2339 * @param *k The number of bits to shift the operand .
2340 * @param *mode The mode of the operand and the result.
2342 FIRM_API ir_node *new_r_Shl(ir_node *block, ir_node *op, ir_node *k,
2345 /** Constructor for a Shr node.
2347 * @param *block The IR block the node belongs to.
2348 * @param *op The operand.
2349 * @param *k The number of bits to shift the operand .
2350 * @param *mode The mode of the operand and the result.
2352 FIRM_API ir_node *new_r_Shr(ir_node *block, ir_node *op, ir_node *k,
2356 * Constructor for a Shrs node.
2358 * @param *block The IR block the node belongs to.
2359 * @param *op The operand.
2360 * @param *k The number of bits to shift the operand.
2361 * @param *mode The mode of the operand and the result.
2363 FIRM_API ir_node *new_r_Shrs(ir_node *block, ir_node *op, ir_node *k,
2366 /** Constructor for a Rotl node.
2368 * @param *block The IR block the node belongs to.
2369 * @param *op The operand.
2370 * @param *k The number of bits to rotate the operand.
2371 * @param *mode The mode of the operand.
2373 FIRM_API ir_node *new_r_Rotl(ir_node *block, ir_node *op, ir_node *k,
2376 /** Constructor for a Conv node.
2378 * @param *block The IR block the node belongs to.
2379 * @param *op The operand.
2380 * @param *mode The mode of this the operand muss be converted .
2382 FIRM_API ir_node *new_r_Conv(ir_node *block, ir_node *op, ir_mode *mode);
2384 /** Constructor for a strict Conv node.
2386 * @param *block The IR block the node belongs to.
2387 * @param *op The operand.
2388 * @param *mode The mode of this the operand muss be converted .
2390 FIRM_API ir_node *new_r_strictConv(ir_node *block, ir_node *op, ir_mode *mode);
2392 /** Constructor for a Cast node.
2394 * High level type cast
2396 * @param *block The IR block the node belongs to.
2397 * @param *op The operand.
2398 * @param *to_tp The type of this the operand muss be casted .
2400 FIRM_API ir_node *new_r_Cast(ir_node *block, ir_node *op, ir_type *to_tp);
2402 /** Constructor for a Carry node.
2404 * @param *block The IR block the node belongs to.
2405 * @param *op1 The first operand.
2406 * @param *op2 The second operand.
2407 * @param *mode The mode of the operands and the result.
2409 FIRM_API ir_node *new_r_Carry(ir_node *block, ir_node *op1, ir_node *op2,
2413 * Constructor for a Borrow node.
2415 * @param *block The IR block the node belongs to.
2416 * @param *op1 The first operand.
2417 * @param *op2 The second operand.
2418 * @param *mode The mode of the operands and the results.
2420 FIRM_API ir_node *new_r_Borrow(ir_node *block, ir_node *op1, ir_node *op2,
2423 /** Constructor for a Phi node.
2425 * @param *block The IR block the node belongs to.
2426 * @param arity The number of predecessors
2427 * @param *in[] Array with predecessors. The constructor copies this array.
2428 * @param *mode The mode of it's inputs and output.
2430 FIRM_API ir_node *new_r_Phi(ir_node *block, int arity, ir_node *in[],
2433 /** Constructor for a Load node.
2435 * @param *block The IR block the node belongs to.
2436 * @param *store The current memory
2437 * @param *adr A pointer to the variable to be read in this memory.
2438 * @param *mode The mode of the value to be loaded.
2439 * @param flags Additional flags for alignment, volatility and pin state.
2441 FIRM_API ir_node *new_r_Load(ir_node *block, ir_node *store,
2442 ir_node *adr, ir_mode *mode, ir_cons_flags flags);
2444 /** Constructor for a Store node.
2446 * @param *block The IR block the node belongs to.
2447 * @param *store The current memory
2448 * @param *adr A pointer to the variable to be read in this memory.
2449 * @param *val The value to write to this variable.
2450 * @param flags Additional flags for alignment, volatility and pin state.
2452 FIRM_API ir_node *new_r_Store(ir_node *block, ir_node *store,
2453 ir_node *adr, ir_node *val, ir_cons_flags flags);
2455 /** Constructor for a Alloc node.
2457 * The Alloc node extends the memory by space for an entity of type alloc_type.
2459 * @param *block The IR block the node belongs to.
2460 * @param *store The memory which shall contain the new variable.
2461 * @param *count The number of objects to allocate.
2462 * @param *alloc_type The type of the allocated variable.
2463 * @param where Where to allocate the variable, either heap_alloc or stack_alloc.
2465 FIRM_API ir_node *new_r_Alloc(ir_node *block, ir_node *store,
2466 ir_node *count, ir_type *alloc_type,
2467 ir_where_alloc where);
2469 /** Constructor for a Free node.
2471 * Frees the memory occupied by the entity pointed to by the pointer
2472 * arg. Type indicates the type of the entity the argument points to.
2474 * @param *block The IR block the node belongs to.
2475 * @param *store The memory which shall contain the new variable.
2476 * @param *ptr The pointer to the object to free.
2477 * @param *size The number of objects of type free_type to free in a sequence.
2478 * @param *free_type The type of the freed variable.
2479 * @param where Where the variable was allocated, either heap_alloc or stack_alloc.
2481 FIRM_API ir_node *new_r_Free(ir_node *block, ir_node *store, ir_node *ptr,
2482 ir_node *size, ir_type *free_type,
2483 ir_where_alloc where);
2485 /** Constructor for a Sync node.
2487 * Merges several memory values. The node assumes that a variable
2488 * either occurs only in one of the memories, or it contains the same
2489 * value in all memories where it occurs.
2491 * @param *block The IR block the node belongs to.
2492 * @param arity The number of memories to synchronize.
2493 * @param *in[] An array of pointers to nodes that produce an output of type memory.
2494 * The constructor copies this array.
2496 FIRM_API ir_node *new_r_Sync(ir_node *block, int arity, ir_node *in[]);
2498 /** Constructor for a Proj node.
2500 * Projects a single value out of a tuple. The parameter proj gives the
2501 * position of the value within the tuple.
2503 * @param arg A node producing a tuple.
2504 * @param mode The mode of the value to project.
2505 * @param proj The position of the value in the tuple.
2507 FIRM_API ir_node *new_r_Proj(ir_node *arg, ir_mode *mode, long proj);
2509 /** Constructor for a defaultProj node.
2511 * Represents the default control flow of a Switch-Cond node.
2513 * @param arg A node producing a tuple.
2514 * @param max_proj The end position of the value in the tuple.
2516 FIRM_API ir_node *new_r_defaultProj(ir_node *arg, long max_proj);
2519 /** Constructor for a Tuple node.
2521 * This is an auxiliary node to replace a node that returns a tuple
2522 * without changing the corresponding Proj nodes.
2524 * @param *block The IR block the node belongs to.
2525 * @param arity The number of tuple elements.
2526 * @param *in[] An array containing pointers to the nodes producing the tuple elements.
2527 * The constructor copies this array.
2529 FIRM_API ir_node *new_r_Tuple(ir_node *block, int arity, ir_node *in[]);
2531 /** Constructor for a Id node.
2533 * This is an auxiliary node to replace a node that returns a single
2536 * @param *block The IR block the node belongs to.
2537 * @param *val The operand to Id.
2538 * @param *mode The mode of *val.
2540 FIRM_API ir_node *new_r_Id(ir_node *block, ir_node *val, ir_mode *mode);
2542 /** Constructor for a Bad node.
2544 * Returns the unique Bad node of the graph. The same as
2547 * @param *irg The IR graph the node belongs to.
2549 FIRM_API ir_node *new_r_Bad(ir_graph *irg);
2551 /** Constructor for a Confirm node.
2553 * Specifies constraints for a value. To support dataflow analyses.
2555 * Example: If the value never exceeds '100' this is expressed by placing a
2556 * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge.
2558 * @param *block The IR block the node belong to.
2559 * @param *val The value we express a constraint for
2560 * @param *bound The value to compare against. Must be a firm node, typically a constant.
2561 * @param cmp The compare operation.
2563 FIRM_API ir_node *new_r_Confirm(ir_node *block, ir_node *val, ir_node *bound,
2566 /** Constructor for a Unknown node.
2568 * Represents an arbitrary value. Places the node in
2571 * @param *irg The IR graph the node belongs to.
2572 * @param *m The mode of the unknown value.
2574 FIRM_API ir_node *new_r_Unknown(ir_graph *irg, ir_mode *m);
2576 /** Constructor for a NoMem node.
2578 * Returns the unique NoMem node of the graph. The same as
2581 * @param *irg The IR graph the node belongs to.
2583 FIRM_API ir_node *new_r_NoMem(ir_graph *irg);
2585 /** Constructor for a Mux node.
2587 * @param *block The block the node belong to.
2588 * @param *sel The ir_node that calculates the boolean select.
2589 * @param *ir_true The ir_node that calculates the true result.
2590 * @param *ir_false The ir_node that calculates the false result.
2591 * @param *mode The mode of the node (and it_true and ir_false).
2593 FIRM_API ir_node *new_r_Mux(ir_node *block, ir_node *sel,
2594 ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
2596 /** Constructor for a CopyB node.
2598 * @param *block The block the node belong to.
2599 * @param *store The current memory
2600 * @param *dst The ir_node that represents the destination address.
2601 * @param *src The ir_node that represents the source address.
2602 * @param *data_type The type of the copied data
2604 FIRM_API ir_node *new_r_CopyB(ir_node *block, ir_node *store,
2605 ir_node *dst, ir_node *src, ir_type *data_type);
2607 /** Constructor for a InstOf node.
2609 * A High-Level Type check.
2611 * @param *block The block the node belong to.
2612 * @param *store The memory in which the object the entity should be selected
2613 * from is allocated.
2614 * @param *objptr A pointer to a object of a class type.
2615 * @param *type The type of which objptr must be.
2617 FIRM_API ir_node *new_r_InstOf(ir_node *block, ir_node *store,
2618 ir_node *objptr, ir_type *type);
2620 /** Constructor for a Raise node.
2622 * A High-Level Exception throw.
2624 * @param *block The IR block the node belongs to.
2625 * @param *store The current memory.
2626 * @param *obj A pointer to the Except variable.
2628 FIRM_API ir_node *new_r_Raise(ir_node *block, ir_node *store, ir_node *obj);
2630 /** Constructor for a Bound node.
2632 * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
2634 * @param *block The block the node belong to.
2635 * @param *store The current memory.
2636 * @param *idx The ir_node that represents an index.
2637 * @param *lower The ir_node that represents the lower bound for the index.
2638 * @param *upper The ir_node that represents the upper bound for the index.
2640 FIRM_API ir_node *new_r_Bound(ir_node *block, ir_node *store,
2641 ir_node *idx, ir_node *lower, ir_node *upper);
2643 /** Constructor for a Pin node.
2645 * @param *block The block the node belong to.
2646 * @param *node The node which value should be pinned.
2648 FIRM_API ir_node *new_r_Pin(ir_node *block, ir_node *node);
2650 /** Constructor for an ASM pseudo node.
2652 * @param *block The block the node belong to.
2653 * @param arity The number of data inputs to the node.
2654 * @param *in The array of length arity of data inputs.
2655 * @param *inputs The array of length arity of input constraints.
2656 * @param n_outs The number of data outputs to the node.
2657 * @param *outputs The array of length n_outs of output constraints.
2658 * @param n_clobber The number of clobbered registers.
2659 * @param *clobber The array of length n_clobber of clobbered registers.
2660 * @param *asm_text The assembler text.
2662 FIRM_API ir_node *new_r_ASM(ir_node *block,
2663 int arity, ir_node *in[], ir_asm_constraint *inputs,
2664 int n_outs, ir_asm_constraint *outputs,
2665 int n_clobber, ident *clobber[], ident *asm_text);
2667 /*-----------------------------------------------------------------------*/
2668 /* The block oriented interface */
2669 /*-----------------------------------------------------------------------*/
2671 /** Sets the current block in which the following constructors place the
2672 * nodes they construct.
2674 * @param target The new current block.
2676 FIRM_API void set_cur_block(ir_node *target);
2677 FIRM_API void set_r_cur_block(ir_graph *irg, ir_node *target);
2679 /** Returns the current block of the current graph. */
2680 FIRM_API ir_node *get_cur_block(void);
2681 FIRM_API ir_node *get_r_cur_block(ir_graph *irg);
2683 /** Constructor for a Block node.
2685 * Adds the block to the graph in current_ir_graph. Constructs a Block
2686 * with a fixed number of predecessors.
2688 * @param *db A Pointer for debug information.
2689 * @param arity The number of control predecessors.
2690 * @param in[] An array of control predecessors. The length of
2691 * the array must be 'arity'.
2693 FIRM_API ir_node *new_d_Block(dbg_info *db, int arity, ir_node *in[]);
2695 /** Constructor for a Start node.
2697 * Adds the node to the block in current_ir_block.
2699 * @param *db A pointer for debug information.
2701 FIRM_API ir_node *new_d_Start(dbg_info *db);
2703 /** Constructor for a End node.
2705 * Adds the node to the block in current_ir_block.
2707 * @param *db A pointer for debug information.
2709 FIRM_API ir_node *new_d_End(dbg_info *db);
2711 /** Constructor for a Jmp node.
2713 * Adds the node to the block in current_ir_block.
2715 * Jmp represents control flow to a single control successor.
2717 * @param *db A pointer for debug information.
2719 FIRM_API ir_node *new_d_Jmp(dbg_info *db);
2721 /** Constructor for an IJmp node.
2723 * IJmp represents control flow to a single control successor not
2724 * statically known i.e. an indirect Jmp.
2726 * @param *db A pointer for debug information.
2727 * @param *tgt The IR node representing the target address.
2729 FIRM_API ir_node *new_d_IJmp(dbg_info *db, ir_node *tgt);
2731 /** Constructor for a Cond node.
2733 * Adds the node to the block in current_ir_block.
2735 * If c is mode_b represents a conditional branch (if/else). If c is
2736 * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond
2737 * node, default Proj is 0.)
2739 * This is not consistent: Input to Cond is Is, Proj has as proj number
2742 * @param *db A pointer for debug information.
2743 * @param *c The conditions parameter.Can be of mode b or I_u.
2745 FIRM_API ir_node *new_d_Cond(dbg_info *db, ir_node *c);
2747 /** Constructor for a Return node.
2749 * Adds the node to the block in current_ir_block.
2751 * Returns the memory and zero or more return values. Only node that
2752 * can end regular control flow.
2754 * @param *db A pointer for debug information.
2755 * @param *store The state of memory.
2756 * @param arity Number of array indices.
2757 * @param *in Array with index inputs to the node.
2759 FIRM_API ir_node *new_d_Return(dbg_info *db, ir_node *store,
2760 int arity, ir_node *in[]);
2762 /** Constructor for a Const_type node.
2764 * Adds the node to the start block.
2766 * The constant represents a target value. This constructor sets high
2767 * level type information for the constant value.
2768 * Derives mode from passed tarval.
2770 * @param *db A pointer for debug information.
2771 * @param *con Points to an entry in the constant table. This pointer is
2772 added to the attributes of the node.
2773 * @param *tp The type of the constant.
2775 FIRM_API ir_node *new_d_Const_type(dbg_info *db, tarval *con, ir_type *tp);
2777 /** Constructor for a Const node.
2779 * Adds the node to the block in current_ir_block.
2781 * Constructor for a Const node. The constant represents a target
2782 * value. Sets the type information to type_unknown. (No more
2783 * supported: If tv is entity derives a somehow useful type.)
2784 * Derives mode from passed tarval.
2786 * @param *db A pointer for debug information.
2787 * @param *con Points to an entry in the constant table. This pointer is added
2788 * to the attributes of the node.
2790 FIRM_API ir_node *new_d_Const(dbg_info *db, tarval *con);
2793 * @see new_rd_Const_long()
2795 * @param *db A pointer for debug information.
2796 * @param *mode The mode of the operands and results.
2797 * @param value A value from which the tarval is made.
2799 FIRM_API ir_node *new_d_Const_long(dbg_info *db, ir_mode *mode, long value);
2801 /** Constructor for a SymConst_type node.
2803 * This is the constructor for a symbolic constant.
2804 * There are several kinds of symbolic constants:
2805 * - symconst_type_tag The symbolic constant represents a type tag. The
2806 * type the tag stands for is given explicitly.
2807 * - symconst_type_size The symbolic constant represents the size of a type.
2808 * The type of which the constant represents the size
2809 * is given explicitly.
2810 * - symconst_type_align The symbolic constant represents the alignment of a
2811 * type. The type of which the constant represents the
2812 * size is given explicitly.
2813 * - symconst_addr_ent The symbolic constant represents the address of an
2814 * entity (variable or method). The variable is given
2815 * explicitly by a firm entity.
2816 * - symconst_ofs_ent The symbolic constant represents the offset of an
2817 * entity in its owner type.
2818 * - symconst_enum_const The symbolic constant is a enumeration constant of
2819 * an enumeration type.
2821 * Inputs to the node:
2822 * No inputs except the block it belongs to.
2823 * Outputs of the node.
2824 * An unsigned integer (I_u) or a pointer (P).
2826 * Mention union in declaration so that the firmjni generator recognizes that
2827 * it can not cast the argument to an int.
2829 * @param *db A pointer for debug information.
2830 * @param mode The mode for the SymConst.
2831 * @param value A type, ident, entity or enum constant depending on the
2833 * @param kind The kind of the symbolic constant, see the list above
2834 * @param tp The source type of the constant.
2836 FIRM_API ir_node *new_d_SymConst_type(dbg_info *db, ir_mode *mode,
2837 union symconst_symbol value,
2838 symconst_kind kind, ir_type *tp);
2840 /** Constructor for a SymConst node.
2842 * Same as new_d_SymConst_type, except that it sets the type to type_unknown.
2844 FIRM_API ir_node *new_d_SymConst(dbg_info *db, ir_mode *mode,
2845 union symconst_symbol value,
2846 symconst_kind kind);
2848 /** Constructor for a simpleSel node.
2850 * This is a shortcut for the new_d_Sel() constructor. To be used for
2851 * Sel nodes that do not select from an array, i.e., have no index
2852 * inputs. It adds the two parameters 0, NULL.
2854 * @param *db A pointer for debug information.
2855 * @param *store The memory in which the object the entity should be
2856 * selected from is allocated.
2857 * @param *objptr The object from that the Sel operation selects a
2858 * single attribute out.
2859 * @param *ent The entity to select.
2861 FIRM_API ir_node *new_d_simpleSel(dbg_info *db, ir_node *store, ir_node *objptr,
2864 /** Constructor for a Sel node.
2866 * The select node selects an entity (field or method) from an entity
2867 * with a compound type. It explicitly specifies the entity selected.
2868 * Dynamically the node may select entities that overwrite the given
2869 * entity. If the selected entity is an array element entity the Sel
2870 * node takes the required array indices as inputs.
2871 * Adds the node to the block in current_ir_block.
2873 * @param *db A pointer for debug information.
2874 * @param *store The memory in which the object the entity should be selected
2875 * from is allocated.
2876 * @param *objptr A pointer to a compound entity the Sel operation selects a
2877 * single attribute from.
2878 * @param arity The number of array indices needed to select an array element entity.
2879 * @param *in[] If the compound entity is an array the indices of the selected
2880 * element entity. The constructor copies this array.
2881 * @param *ent The entity to select.
2883 FIRM_API ir_node *new_d_Sel(dbg_info *db, ir_node *store, ir_node *objptr,
2884 int arity, ir_node *in[], ir_entity *ent);
2886 /** Constructor for a Call node.
2888 * Represents all kinds of method and function calls.
2889 * Adds the node to the block in current_ir_block.
2891 * @param *db A pointer for debug information.
2892 * @param *store The actual store.
2893 * @param *callee A pointer to the called procedure.
2894 * @param arity The number of procedure parameters.
2895 * @param *in[] An array with the pointers to the parameters. The constructor copies this array.
2896 * @param *tp Type information of the procedure called.
2898 FIRM_API ir_node *new_d_Call(dbg_info *db, ir_node *store, ir_node *callee,
2899 int arity, ir_node *in[], ir_type *tp);
2901 /** Constructor for a Builtin node.
2903 * Represents a call of a backend-specific builtin..
2904 * Adds the node to the block in current_ir_block.
2906 * @param *db A pointer for debug information.
2907 * @param *store The actual store.
2908 * @param arity The number of procedure parameters.
2909 * @param *in[] An array with the pointers to the parameters. The constructor copies this array.
2910 * @param kind The kind of the called builtin.
2911 * @param *tp Type information of the procedure called.
2913 FIRM_API ir_node *new_d_Builtin(dbg_info *db, ir_node *store,
2914 int arity, ir_node *in[],
2915 ir_builtin_kind kind, ir_type *tp);
2917 /** Constructor for a Add node.
2919 * Adds the node to the block in current_ir_block.
2921 * @param *db A pointer for debug information.
2922 * @param *op1 The first operand.
2923 * @param *op2 The second operand.
2924 * @param *mode The mode of the operands and the result.
2926 FIRM_API ir_node *new_d_Add(dbg_info *db, ir_node *op1, ir_node *op2,
2929 /** Constructor for a Sub node.
2931 * Adds the node to the block in current_ir_block.
2933 * @param *db A pointer for debug information.
2934 * @param *op1 The first operand.
2935 * @param *op2 The second operand.
2936 * @param *mode The mode of the operands and the result.
2938 FIRM_API ir_node *new_d_Sub(dbg_info *db, ir_node *op1, ir_node *op2,
2941 /** Constructor for a Minus node.
2943 * Adds the node to the block in current_ir_block.
2945 * @param *db A pointer for debug information.
2946 * @param *op The operand .
2947 * @param *mode The mode of the operand and the result.
2949 FIRM_API ir_node *new_d_Minus(dbg_info *db, ir_node *op, ir_mode *mode);
2951 /** Constructor for a Mul node.
2953 * Adds the node to the block in current_ir_block.
2955 * @param *db A pointer for debug information.
2956 * @param *op1 The first operand.
2957 * @param *op2 The second operand.
2958 * @param *mode The mode of the operands and the result.
2960 FIRM_API ir_node *new_d_Mul(dbg_info *db, ir_node *op1, ir_node *op2,
2963 /** Constructor for a Mulh node.
2965 * Adds the node to the block in current_ir_block.
2967 * @param *db A pointer for debug information.
2968 * @param *op1 The first operand.
2969 * @param *op2 The second operand.
2970 * @param *mode The mode of the operands and the result.
2972 FIRM_API ir_node *new_d_Mulh(dbg_info *db, ir_node *op1, ir_node *op2,
2975 /** Constructor for a Quot node.
2977 * Adds the node to the block in current_ir_block.
2979 * @param *db A pointer for debug information.
2980 * @param *memop The store needed to model exceptions
2981 * @param *op1 The first operand.
2982 * @param *op2 The second operand.
2983 * @param *mode The mode of the result.
2984 * @param state The pinned state.
2986 FIRM_API ir_node *new_d_Quot(dbg_info *db, ir_node *memop,
2987 ir_node *op1, ir_node *op2, ir_mode *mode,
2988 op_pin_state state);
2990 /** Constructor for a DivMod node.
2992 * Adds the node to the block in current_ir_block.
2994 * @param *db A pointer for debug information.
2995 * @param *memop The store needed to model exceptions
2996 * @param *op1 The first operand.
2997 * @param *op2 The second operand.
2998 * @param *mode The mode of the results.
2999 * @param state The pinned state.
3001 FIRM_API ir_node *new_d_DivMod(dbg_info *db, ir_node *memop, ir_node *op1,
3002 ir_node *op2, ir_mode *mode, op_pin_state state);
3004 /** Constructor for a Div node.
3006 * Adds the node to the block in current_ir_block.
3008 * @param *db A pointer for debug information.
3009 * @param *memop The store needed to model exceptions
3010 * @param *op1 The first operand.
3011 * @param *op2 The second operand.
3012 * @param *mode The mode of the result.
3013 * @param state The pinned state.
3015 FIRM_API ir_node *new_d_Div(dbg_info *db, ir_node *memop, ir_node *op1,
3016 ir_node *op2, ir_mode *mode, op_pin_state state);
3018 /** Constructor for a remainderless Div node.
3020 * Adds the node to the block in current_ir_block.
3022 * @param *db A pointer for debug information.
3023 * @param *memop The store needed to model exceptions
3024 * @param *op1 The first operand.
3025 * @param *op2 The second operand.
3026 * @param *mode The mode of the result.
3027 * @param state The pinned state.
3029 FIRM_API ir_node *new_d_DivRL(dbg_info *db, ir_node *memop,
3030 ir_node *op1, ir_node *op2, ir_mode *mode,
3031 op_pin_state state);
3033 /** Constructor for a Mod node.
3035 * Adds the node to the block in current_ir_block.
3037 * @param *db A pointer for debug information.
3038 * @param *memop The store needed to model exceptions
3039 * @param *op1 The first operand.
3040 * @param *op2 The second operand.
3041 * @param *mode The mode of the result.
3042 * @param state The pinned state.
3044 FIRM_API ir_node *new_d_Mod(dbg_info *db, ir_node *memop,
3045 ir_node *op1, ir_node *op2, ir_mode *mode,
3046 op_pin_state state);
3048 /** Constructor for a And node.
3050 * Adds the node to the block in current_ir_block.
3052 * @param *db A pointer for debug information.
3053 * @param *op1 The first operand.
3054 * @param *op2 The second operand.
3055 * @param *mode The mode of the operands and the result.
3057 FIRM_API ir_node *new_d_And(dbg_info *db, ir_node *op1, ir_node *op2,
3060 /** Constructor for a Or node.
3062 * Adds the node to the block in current_ir_block.
3064 * @param *db A pointer for debug information.
3065 * @param *op1 The first operand.
3066 * @param *op2 The second operand.
3067 * @param *mode The mode of the operands and the result.
3069 FIRM_API ir_node *new_d_Or(dbg_info *db, ir_node *op1, ir_node *op2,
3072 /** Constructor for a Eor node.
3074 * Adds the node to the block in current_ir_block.
3076 * @param *db A pointer for debug information.
3077 * @param *op1 The first operand.
3078 * @param *op2 The second operand.
3079 * @param *mode The mode of the operands and the results.
3081 FIRM_API ir_node *new_d_Eor(dbg_info *db, ir_node *op1, ir_node *op2,
3084 /** Constructor for a Not node.
3086 * Adds the node to the block in current_ir_block.
3088 * @param *db A pointer for debug information.
3089 * @param *op The operand.
3090 * @param *mode The mode of the operand and the result.
3092 FIRM_API ir_node *new_d_Not(dbg_info *db, ir_node *op, ir_mode *mode);
3094 /** Constructor for a Shl node.
3096 * Adds the node to the block in current_ir_block.
3098 * @param *db A pointer for debug information.
3099 * @param *op The operand.
3100 * @param *k The number of bits to shift the operand .
3101 * @param *mode The mode of the operand and the result.
3103 FIRM_API ir_node *new_d_Shl(dbg_info *db, ir_node *op, ir_node *k,
3106 /** Constructor for a Shr node.
3108 * Adds the node to the block in current_ir_block.
3110 * @param *db A pointer for debug information.
3111 * @param *op The operand.
3112 * @param *k The number of bits to shift the operand .
3113 * @param *mode The mode of the operand and the result.
3115 FIRM_API ir_node *new_d_Shr(dbg_info *db, ir_node *op, ir_node *k,
3118 /** Constructor for a Shrs node.
3120 * Adds the node to the block in current_ir_block.
3122 * @param *db A pointer for debug information.
3123 * @param *op The operand.
3124 * @param *k The number of bits to shift the operand .
3125 * @param *mode The mode of the operand and the result.
3127 FIRM_API ir_node *new_d_Shrs(dbg_info *db, ir_node *op, ir_node *k,
3130 /** Constructor for a Rotl node.
3132 * Adds the node to the block in current_ir_block.
3134 * @param *db A pointer for debug information.
3135 * @param *op The operand.
3136 * @param *k The number of bits to rotate the operand.
3137 * @param *mode The mode of the operand.
3139 FIRM_API ir_node *new_d_Rotl(dbg_info *db, ir_node *op, ir_node *k,
3142 /** Constructor for a Cmp node.
3144 * Adds the node to the block in current_ir_block.
3146 * @param *db A pointer for debug information.
3147 * @param *op1 The first operand.
3148 * @param *op2 The second operand.
3150 FIRM_API ir_node *new_d_Cmp(dbg_info *db, ir_node *op1, ir_node *op2);
3152 /** Constructor for a Conv node.
3154 * Adds the node to the block in current_ir_block.
3156 * @param *db A pointer for debug information.
3157 * @param *op The operand.
3158 * @param *mode The mode of this the operand muss be converted .
3160 FIRM_API ir_node *new_d_Conv(dbg_info *db, ir_node *op, ir_mode *mode);
3162 /** Constructor for a strict Conv node.
3164 * Adds the node to the block in current_ir_block.
3166 * @param *db A pointer for debug information.
3167 * @param *op The operand.
3168 * @param *mode The mode of this the operand muss be converted .
3170 FIRM_API ir_node *new_d_strictConv(dbg_info *db, ir_node *op, ir_mode *mode);
3172 /** Constructor for a Cast node.
3174 * High level type cast
3175 * Adds the node to the block in current_ir_block.
3177 * @param *db A pointer for debug information.
3178 * @param *op The operand.
3179 * @param *to_tp The type of this the operand muss be casted .
3181 FIRM_API ir_node *new_d_Cast(dbg_info *db, ir_node *op, ir_type *to_tp);
3183 /** Constructor for a Carry node.
3185 * Adds the node to the block in current_ir_block.
3187 * @param *db A pointer for debug information.
3188 * @param *op1 The first operand.
3189 * @param *op2 The second operand.
3190 * @param *mode The mode of the operands and the result.
3192 FIRM_API ir_node *new_d_Carry(dbg_info *db, ir_node *op1, ir_node *op2,
3195 /** Constructor for a Borrow node.
3197 * Adds the node to the block in current_ir_block.
3199 * @param *db A pointer for debug information.
3200 * @param *op1 The first operand.
3201 * @param *op2 The second operand.
3202 * @param *mode The mode of the operands and the result.
3204 FIRM_API ir_node *new_d_Borrow(dbg_info *db, ir_node *op1, ir_node *op2,
3207 /** Constructor for a Phi node.
3209 * Adds the node to the block in current_ir_block.
3211 * @param *db A pointer for debug information.
3212 * @param arity The number of predecessors
3213 * @param *in Array with predecessors
3214 * @param *mode The mode of it's inputs and output.
3216 FIRM_API ir_node *new_d_Phi(dbg_info *db, int arity, ir_node *in[],
3219 /** Constructor for a Load node.
3221 * Adds the node to the block in current_ir_block.
3223 * @param *db A pointer for debug information.
3224 * @param *store The current memory
3225 * @param *addr A pointer to the variable to be read in this memory.
3226 * @param *mode The mode of the value to be loaded.
3227 * @param flags Additional flags for alignment, volatility and pin state.
3229 FIRM_API ir_node *new_d_Load(dbg_info *db, ir_node *store, ir_node *addr,
3230 ir_mode *mode, ir_cons_flags flags);
3232 /** Constructor for a Store node.
3234 * Adds the node to the block in current_ir_block.
3236 * @param *db A pointer for debug information.
3237 * @param *store The current memory
3238 * @param *addr A pointer to the variable to be read in this memory.
3239 * @param *val The value to write to this variable.
3240 * @param flags Additional flags for alignment, volatility and pin state.
3242 FIRM_API ir_node *new_d_Store(dbg_info *db, ir_node *store, ir_node *addr,
3243 ir_node *val, ir_cons_flags flags);
3245 /** Constructor for a Alloc node.
3247 * The Alloc node extends the memory by space for an entity of type alloc_type.
3248 * Adds the node to the block in current_ir_block.
3250 * @param *db A pointer for debug information.
3251 * @param *store The memory which shall contain the new variable.
3252 * @param *count The number of objects to allocate.
3253 * @param *alloc_type The type of the allocated variable.
3254 * @param where Where to allocate the variable, either heap_alloc or stack_alloc.
3256 FIRM_API ir_node *new_d_Alloc(dbg_info *db, ir_node *store, ir_node *count,
3257 ir_type *alloc_type, ir_where_alloc where);
3259 /** Constructor for a Free node.
3261 * Frees the memory occupied by the entity pointed to by the pointer
3262 * arg. Type indicates the type of the entity the argument points to.
3263 * Adds the node to the block in current_ir_block.
3265 * @param *db A pointer for debug information.
3266 * @param *store The memory which shall contain the new variable.
3267 * @param *ptr The pointer to the object to free.
3268 * @param *size The number of objects of type free_type to free in a sequence.
3269 * @param *free_type The type of the freed variable.
3270 * @param where Where the variable was allocated, either heap_alloc or stack_alloc.
3272 FIRM_API ir_node *new_d_Free(dbg_info *db, ir_node *store, ir_node *ptr,
3273 ir_node *size, ir_type *free_type,
3274 ir_where_alloc where);
3276 /** Constructor for a Sync node.
3278 * Merges several memory values. The node assumes that a variable
3279 * either occurs only in one of the memories, or it contains the same
3280 * value in all memories where it occurs.
3281 * Adds the node to the block in current_ir_block.
3283 * @param *db A pointer for debug information.
3284 * @param arity The number of memories to synchronize.
3285 * @param **in An array of pointers to nodes that produce an output of type
3286 * memory. The constructor copies this array.
3288 FIRM_API ir_node *new_d_Sync(dbg_info *db, int arity, ir_node *in[]);
3290 /** Constructor for a Proj node.
3292 * Projects a single value out of a tuple. The parameter proj gives the
3293 * position of the value within the tuple.
3294 * Adds the node to the block in current_ir_block.
3296 * @param *db A pointer for deubug information.
3297 * @param arg A node producing a tuple.
3298 * @param *mode The mode of the value to project.
3299 * @param proj The position of the value in the tuple.
3301 FIRM_API ir_node *new_d_Proj(dbg_info *db, ir_node *arg, ir_mode *mode,
3304 /** Constructor for a defaultProj node.
3306 * Represents the default control flow of a Switch-Cond node.
3307 * Adds the node to the block in current_ir_block.
3309 * @param *db A pointer for debug information.
3310 * @param arg A node producing a tuple.
3311 * @param max_proj The end position of the value in the tuple.
3313 FIRM_API ir_node *new_d_defaultProj(dbg_info *db, ir_node *arg, long max_proj);
3315 /** Constructor for a Tuple node.
3317 * This is an auxiliary node to replace a node that returns a tuple
3318 * without changing the corresponding Proj nodes.
3319 * Adds the node to the block in current_ir_block.
3321 * @param *db A pointer for debug information.
3322 * @param arity The number of tuple elements.
3323 * @param **in An array containing pointers to the nodes producing the tuple elements.
3325 FIRM_API ir_node *new_d_Tuple(dbg_info *db, int arity, ir_node *in[]);
3327 /** Constructor for a Id node.
3329 * This is an auxiliary node to replace a node that returns a single
3330 * value. Adds the node to the block in current_ir_block.
3332 * @param *db A pointer for debug information.
3333 * @param *val The operand to Id.
3334 * @param *mode The mode of *val.
3336 FIRM_API ir_node *new_d_Id(dbg_info *db, ir_node *val, ir_mode *mode);
3338 /** Constructor for a Confirm node.
3340 * Constructor for a Confirm node. Adds the node to the block in current_ir_block.
3341 * Specifies constraints for a value. To support dataflow analyses.
3343 * Example: If the value never exceeds '100' this is expressed by placing a
3344 * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge.
3346 * @param *db A pointer for debug information.
3347 * @param *val The value we express a constraint for
3348 * @param *bound The value to compare against. Must be a firm node, typically a constant.
3349 * @param cmp The compare operation.
3351 FIRM_API ir_node *new_d_Confirm(dbg_info *db, ir_node *val, ir_node *bound,
3354 /** Constructor for an Unknown node.
3356 * Represents an arbitrary value. Places the node in
3359 * @param *db A pointer for debug information.
3360 * @param *m The mode of the unknown value.
3362 FIRM_API ir_node *new_d_Unknown(dbg_info *db, ir_mode *m);
3364 /** Constructor for a Mux node.
3366 * @param *db A pointer for debug information.
3367 * @param *sel The ir_node that calculates the boolean select.
3368 * @param *ir_true The ir_node that calculates the true result.
3369 * @param *ir_false The ir_node that calculates the false result.
3370 * @param *mode The mode of the node (and it_true and ir_false).
3372 FIRM_API ir_node *new_d_Mux(dbg_info *db, ir_node *sel,
3373 ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
3375 /** Constructor for a CopyB node.
3377 * @param *db A pointer for debug information.
3378 * @param *store The current memory
3379 * @param *dst The ir_node that represents the destination address.
3380 * @param *src The ir_node that represents the source address.
3381 * @param *data_type The type of the copied data
3383 FIRM_API ir_node *new_d_CopyB(dbg_info *db, ir_node *store, ir_node *dst,
3384 ir_node *src, ir_type *data_type);
3386 /** Constructor for a InstOf node.
3388 * A High-Level Type check.
3390 * @param *db A pointer for debug information.
3391 * @param *store The memory in which the object the entity should be selected
3392 * from is allocated.
3393 * @param *objptr A pointer to a object of a class type.
3394 * @param *type The type of which objptr must be.
3396 FIRM_API ir_node *new_d_InstOf(dbg_info *db, ir_node *store, ir_node *objptr,
3399 /** Constructor for a Raise node.
3401 * A High-Level Exception throw.
3403 * @param *db A pointer for debug information.
3404 * @param *store The current memory.
3405 * @param *obj A pointer to the Except variable.
3407 FIRM_API ir_node *new_d_Raise(dbg_info *db, ir_node *store, ir_node *obj);
3409 /** Constructor for a Bound node.
3411 * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
3413 * @param *db A pointer for debug information.
3414 * @param *store The current memory
3415 * @param *idx The ir_node that represents an index.
3416 * @param *lower The ir_node that represents the lower bound for the index.
3417 * @param *upper The ir_node that represents the upper bound for the index.
3419 FIRM_API ir_node *new_d_Bound(dbg_info *db, ir_node *store, ir_node *idx,
3420 ir_node *lower, ir_node *upper);
3422 /** Constructor for a Pin node.
3424 * @param *db A pointer for debug information.
3425 * @param *node The node which value should be pinned.
3427 FIRM_API ir_node *new_d_Pin(dbg_info *db, ir_node *node);
3429 /** Constructor for an ASM pseudo node.
3431 * @param *db A pointer for debug information.
3432 * @param arity The number of data inputs to the node.
3433 * @param *in The array of length arity of data inputs.
3434 * @param *inputs The array of length arity of input constraints.
3435 * @param n_outs The number of data outputs to the node.
3436 * @param *outputs The array of length n_outs of output constraints.
3437 * @param n_clobber The number of clobbered registers.
3438 * @param *clobber The array of length n_clobber of clobbered registers.
3439 * @param *asm_text The assembler text.
3441 FIRM_API ir_node *new_d_ASM(dbg_info *db, int arity, ir_node *in[],
3442 ir_asm_constraint *inputs,
3443 int n_outs, ir_asm_constraint *outputs,
3444 int n_clobber, ident *clobber[], ident *asm_text);
3446 /*-----------------------------------------------------------------------*/
3447 /* The block oriented interface without debug support */
3448 /*-----------------------------------------------------------------------*/
3450 /** Constructor for a Block node.
3452 * Constructor for a Block node. Adds the block to the graph in
3453 * current_ir_graph. Constructs a Block with a fixed number of predecessors.
3455 * @param arity The number of control predecessors.
3456 * @param in An array of control predecessors. The length of
3457 * the array must be 'arity'.
3459 FIRM_API ir_node *new_Block(int arity, ir_node *in[]);
3461 /** Constructor for a Start node.
3463 * Adds the node to the block in current_ir_block.
3466 FIRM_API ir_node *new_Start(void);
3468 /** Constructor for an End node.
3470 * Adds the node to the block in current_ir_block.
3472 FIRM_API ir_node *new_End(void);
3474 /** Constructor for a Jump node.
3476 * Adds the node to the block in current_ir_block.
3478 * Jmp represents control flow to a single control successor.
3480 FIRM_API ir_node *new_Jmp(void);
3482 /** Constructor for an IJmp node.
3484 * IJmp represents control flow to a single control successor not
3485 * statically known i.e. an indirect Jmp.
3487 * @param *tgt The IR node representing the target address.
3489 FIRM_API ir_node *new_IJmp(ir_node *tgt);
3491 /** Constructor for a Cond node.
3493 * If c is mode_b represents a conditional branch (if/else). If c is
3494 * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond
3495 * node, default Proj is 0.). Adds the node to the block in current_ir_block.
3497 * This is not consistent: Input to Cond is Is, Proj has as proj number
3501 * @param *c The conditions parameter.Can be of mode b or I_u.
3503 FIRM_API ir_node *new_Cond(ir_node *c);
3505 /** Constructor for a Return node.
3507 * Returns the memory and zero or more return values. Only node that
3508 * can end regular control flow. Adds the node to the block in current_ir_block.
3510 * @param *store The state of memory.
3511 * @param arity Number of array indices.
3512 * @param *in Array with index inputs to the node.
3514 FIRM_API ir_node *new_Return(ir_node *store, int arity, ir_node *in[]);
3516 /** Constructor for a Const node.
3518 * Constructor for a Const node. The constant represents a target
3519 * value. Sets the type information to type_unknown. (No more
3520 * supported: If tv is entity derives a somehow useful type.)
3521 * Adds the node to the block in current_ir_block.
3522 * Derives mode from passed tarval.
3524 * @param *con Points to an entry in the constant table. This pointer is
3525 * added to the attributes of the node.
3527 FIRM_API ir_node *new_Const(tarval *con);
3530 * Make a const from a long.
3531 * This is just convenience for the usual
3533 * new_Const(mode, tarval_from_long(mode, ...))
3536 * @param mode The mode for the const.
3537 * @param value The value of the constant.
3538 * @return A new const node.
3540 FIRM_API ir_node *new_Const_long(ir_mode *mode, long value);
3542 /** Constructor for a Const node.
3544 * Derives mode from passed tarval. */
3545 FIRM_API ir_node *new_Const_type(tarval *con, ir_type *tp);
3547 /** Constructor for a SymConst_type node.
3549 * This is the constructor for a symbolic constant.
3550 * There are several kinds of symbolic constants:
3551 * - symconst_type_tag The symbolic constant represents a type tag. The
3552 * type the tag stands for is given explicitly.
3553 * - symconst_type_size The symbolic constant represents the size of a type.
3554 * The type of which the constant represents the size
3555 * is given explicitly.
3556 * - symconst_type_align The symbolic constant represents the alignment of a
3557 * type. The type of which the constant represents the
3558 * size is given explicitly.
3559 * - symconst_addr_ent The symbolic constant represents the address of an
3560 * entity (variable or method). The variable is given
3561 * explicitly by a firm entity.
3562 * - symconst_ofs_ent The symbolic constant represents the offset of an
3563 * entity in its owner type.
3564 * - symconst_enum_const The symbolic constant is a enumeration constant of
3565 * an enumeration type.
3567 * Inputs to the node:
3568 * No inputs except the block it belongs to.
3569 * Outputs of the node.
3570 * An unsigned integer (I_u) or a pointer (P).
3572 * Mention union in declaration so that the firmjni generator recognizes that
3573 * it can not cast the argument to an int.
3575 * @param mode The mode for the SymConst.
3576 * @param value A type, ident, entity or enum constant depending on the
3578 * @param kind The kind of the symbolic constant, see the list above
3579 * @param tp The source type of the constant.
3581 FIRM_API ir_node *new_SymConst_type(ir_mode *mode, union symconst_symbol value,
3582 symconst_kind kind, ir_type *tp);
3584 /** Constructor for a SymConst node.
3586 * This is the constructor for a symbolic constant.
3587 * There are several kinds of symbolic constants:
3588 * - symconst_type_tag The symbolic constant represents a type tag. The
3589 * type the tag stands for is given explicitly.
3590 * - symconst_type_size The symbolic constant represents the size of a type.
3591 * The type of which the constant represents the size
3592 * is given explicitly.
3593 * - symconst_type_align The symbolic constant represents the alignment of a
3594 * type. The type of which the constant represents the
3595 * size is given explicitly.
3596 * - symconst_addr_ent The symbolic constant represents the address of an
3597 * entity (variable or method). The variable is given
3598 * explicitly by a firm entity.
3599 * - symconst_ofs_ent The symbolic constant represents the offset of an
3600 * entity in its owner type.
3601 * - symconst_enum_const The symbolic constant is a enumeration constant of
3602 * an enumeration type.
3604 * Inputs to the node:
3605 * No inputs except the block it belongs to.
3606 * Outputs of the node.
3607 * An unsigned integer (I_u) or a pointer (P).
3609 * Mention union in declaration so that the firmjni generator recognizes that
3610 * it can not cast the argument to an int.
3612 * @param mode The mode for the SymConst.
3613 * @param value A type, ident, entity or enum constant depending on the
3615 * @param kind The kind of the symbolic constant, see the list above
3617 FIRM_API ir_node *new_SymConst(ir_mode *mode, union symconst_symbol value,
3618 symconst_kind kind);
3620 /** Constructor for a simpelSel node.
3622 * This is a shortcut for the new_Sel() constructor. To be used for
3623 * Sel nodes that do not select from an array, i.e., have no index
3624 * inputs. It adds the two parameters 0, NULL.
3626 * @param *store The memory in which the object the entity should be selected from is allocated.
3627 * @param *objptr The object from that the Sel operation selects a single attribute out.
3628 * @param *ent The entity to select.
3630 FIRM_API ir_node *new_simpleSel(ir_node *store, ir_node *objptr,
3633 /** Constructor for a Sel node.
3635 * The select node selects an entity (field or method) from an entity
3636 * with a compound type. It explicitly specifies the entity selected.
3637 * Dynamically the node may select entities that overwrite the given
3638 * entity. If the selected entity is an array element entity the Sel
3639 * node takes the required array indices as inputs.
3640 * Adds the node to the block in current_ir_block.
3642 * @param *store The memory in which the object the entity should be selected
3643 * from is allocated.
3644 * @param *objptr A pointer to a compound entity the Sel operation selects a
3645 * single attribute from.
3646 * @param arity The number of array indices needed to select an array element entity.
3647 * @param *in[] If the compound entity is an array the indices of the selected
3648 * element entity. The constructor copies this array.
3649 * @param *ent The entity to select.
3651 FIRM_API ir_node *new_Sel(ir_node *store, ir_node *objptr,
3652 int arity, ir_node *in[], ir_entity *ent);
3654 /** Constructor for a Call node.
3656 * Adds the node to the block in current_ir_block.
3657 * Represents all kinds of method and function calls.
3659 * @param *store The actual store.
3660 * @param *callee A pointer to the called procedure.
3661 * @param arity The number of procedure parameters.
3662 * @param *in[] An array with the pointers to the parameters. The constructor copies this array.
3663 * @param *tp Type information of the procedure called.
3665 FIRM_API ir_node *new_Call(ir_node *store, ir_node *callee,
3666 int arity, ir_node *in[], ir_type *tp);
3668 /** Constructor for a Builtin node.
3670 * Represents a call of a backend-specific builtin..
3671 * Represents all kinds of method and function calls.
3673 * @param *store The actual store.
3674 * @param kind The kind of the called builtin.
3675 * @param arity The number of procedure parameters.
3676 * @param *in[] An array with the pointers to the parameters. The constructor copies this array.
3677 * @param *tp Type information of the procedure called.
3679 FIRM_API ir_node *new_Builtin(ir_node *store, int arity, ir_node *in[],
3680 ir_builtin_kind kind, ir_type *tp);
3682 /** Constructor for a Add node.
3684 * Adds the node to the block in current_ir_block.
3686 * @param *op1 The first operand.
3687 * @param *op2 The second operand.
3688 * @param *mode The mode of the operands and the result.
3690 FIRM_API ir_node *new_Add(ir_node *op1, ir_node *op2, ir_mode *mode);
3692 /** Constructor for a Sub node.
3694 * Adds the node to the block in current_ir_block.
3696 * @param *op1 The first operand.
3697 * @param *op2 The second operand.
3698 * @param *mode The mode of the operands and the result.
3700 FIRM_API ir_node *new_Sub(ir_node *op1, ir_node *op2, ir_mode *mode);
3702 /** Constructor for a Minus node.
3704 * Adds the node to the block in current_ir_block.
3706 * @param *op The operand .
3707 * @param *mode The mode of the operand and the result.
3709 FIRM_API ir_node *new_Minus(ir_node *op, ir_mode *mode);
3712 * Constructor for a Mul node. Adds the node to the block in current_ir_block.
3714 * @param *op1 The first operand.
3715 * @param *op2 The second operand.
3716 * @param *mode The mode of the operands and the result.
3718 FIRM_API ir_node *new_Mul(ir_node *op1, ir_node *op2, ir_mode *mode);
3721 * Constructor for a Mulh node. Adds the node to the block in current_ir_block.
3723 * @param *op1 The first operand.
3724 * @param *op2 The second operand.
3725 * @param *mode The mode of the operands and the result.
3727 FIRM_API ir_node *new_Mulh(ir_node *op1, ir_node *op2, ir_mode *mode);
3729 /** Constructor for a Quot node.
3731 * Adds the node to the block in current_ir_block.
3733 * @param *memop The store needed to model exceptions
3734 * @param *op1 The first operand.
3735 * @param *op2 The second operand.
3736 * @param *mode The mode of the result.
3737 * @param state The pinned state.
3739 FIRM_API ir_node *new_Quot(ir_node *memop, ir_node *op1, ir_node *op2,
3740 ir_mode *mode, op_pin_state state);
3742 /** Constructor for a DivMod node.
3744 * Adds the node to the block in current_ir_block.
3746 * @param *memop The store needed to model exceptions
3747 * @param *op1 The first operand.
3748 * @param *op2 The second operand.
3749 * @param *mode The mode of the results.
3750 * @param state The pinned state.
3752 FIRM_API ir_node *new_DivMod(ir_node *memop, ir_node *op1, ir_node *op2,
3753 ir_mode *mode, op_pin_state state);
3755 /** Constructor for a Div node.
3757 * Adds the node to the block in current_ir_block.
3759 * @param *memop The store needed to model exceptions
3760 * @param *op1 The first operand.
3761 * @param *op2 The second operand.
3762 * @param *mode The mode of the result.
3763 * @param state The pinned state.
3765 FIRM_API ir_node *new_Div(ir_node *memop, ir_node *op1, ir_node *op2,
3766 ir_mode *mode, op_pin_state state);
3768 /** Constructor for a remainderless Div node.
3770 * Adds the node to the block in current_ir_block.
3772 * @param *memop The store needed to model exceptions
3773 * @param *op1 The first operand.
3774 * @param *op2 The second operand.
3775 * @param *mode The mode of the result.
3776 * @param state The pinned state.
3778 FIRM_API ir_node *new_DivRL(ir_node *memop, ir_node *op1, ir_node *op2,
3779 ir_mode *mode, op_pin_state state);
3781 /** Constructor for a Mod node.
3783 * Adds the node to the block in current_ir_block.
3785 * @param *memop The store needed to model exceptions
3786 * @param *op1 The first operand.
3787 * @param *op2 The second operand.
3788 * @param *mode The mode of the result.
3789 * @param state The pinned state.
3791 FIRM_API ir_node *new_Mod(ir_node *memop, ir_node *op1, ir_node *op2,
3792 ir_mode *mode, op_pin_state state);
3794 /** Constructor for a And node.
3796 * Adds the node to the block in current_ir_block.
3798 * @param *op1 The first operand.
3799 * @param *op2 The second operand.
3800 * @param *mode The mode of the operands and the result.
3802 FIRM_API ir_node *new_And(ir_node *op1, ir_node *op2, ir_mode *mode);
3805 * Constructor for a Or node. Adds the node to the block in current_ir_block.
3807 * @param *op1 The first operand.
3808 * @param *op2 The second operand.
3809 * @param *mode The mode of the operands and the result.
3811 FIRM_API ir_node *new_Or(ir_node *op1, ir_node *op2, ir_mode *mode);
3814 * Constructor for a Eor node. Adds the node to the block in current_ir_block.
3816 * @param *op1 The first operand.
3817 * @param *op2 The second operand.
3818 * @param *mode The mode of the operands and the results.
3820 FIRM_API ir_node *new_Eor(ir_node *op1, ir_node *op2, ir_mode *mode);
3822 /** Constructor for a Not node.
3824 * Adds the node to the block in current_ir_block.
3826 * @param *op The operand.
3827 * @param *mode The mode of the operand and the result.
3829 FIRM_API ir_node *new_Not(ir_node *op, ir_mode *mode);
3831 /** Constructor for a Shl node.
3833 * Adds the node to the block in current_ir_block.
3835 * @param *op The operand.
3836 * @param *k The number of bits to shift the operand .
3837 * @param *mode The mode of the operand and the result.
3839 FIRM_API ir_node *new_Shl(ir_node *op, ir_node *k, ir_mode *mode);
3842 * Constructor for a Shr node. Adds the node to the block in current_ir_block.
3844 * @param *op The operand.
3845 * @param *k The number of bits to shift the operand .
3846 * @param *mode The mode of the operand and the result.
3848 FIRM_API ir_node *new_Shr(ir_node *op, ir_node *k, ir_mode *mode);
3850 /** Constructor for a Shrs node.
3852 * Adds the node to the block in current_ir_block.
3854 * @param *op The operand.
3855 * @param *k The number of bits to shift the operand .
3856 * @param *mode The mode of the operand and the result.
3858 FIRM_API ir_node *new_Shrs(ir_node *op, ir_node *k, ir_mode *mode);
3860 /** Constructor for a Rotl node.
3862 * Adds the node to the block in current_ir_block.
3864 * @param *op The operand.
3865 * @param *k The number of bits to rotate the operand.
3866 * @param *mode The mode of the operand.
3868 FIRM_API ir_node *new_Rotl(ir_node *op, ir_node *k, ir_mode *mode);
3870 /** Constructor for a Cmp node.
3872 * Adds the node to the block in current_ir_block.
3874 * @param *op1 The first operand.
3875 * @param *op2 The second operand.
3877 FIRM_API ir_node *new_Cmp(ir_node *op1, ir_node *op2);
3879 /** Constructor for a Conv node.
3881 * Adds the node to the block in current_ir_block.
3883 * @param *op The operand.
3884 * @param *mode The mode of this the operand muss be converted.
3886 FIRM_API ir_node *new_Conv(ir_node *op, ir_mode *mode);
3888 /** Constructor for a strict Conv node.
3890 * Adds the node to the block in current_ir_block.
3892 * @param *op The operand.
3893 * @param *mode The mode of this the operand muss be converted.
3895 FIRM_API ir_node *new_strictConv(ir_node *op, ir_mode *mode);
3897 /** Constructor for a Cast node.
3899 * Adds the node to the block in current_ir_block.
3900 * High level type cast
3902 * @param *op The operand.
3903 * @param *to_tp The type of this the operand muss be casted .
3905 FIRM_API ir_node *new_Cast(ir_node *op, ir_type *to_tp);
3907 /** Constructor for a Carry node.
3909 * Adds the node to the block in current_ir_block.
3911 * @param *op1 The first operand.
3912 * @param *op2 The second operand.
3913 * @param *mode The mode of the operands and the result.
3915 FIRM_API ir_node *new_Carry(ir_node *op1, ir_node *op2, ir_mode *mode);
3917 /** Constructor for a Borrow node.
3919 * Adds the node to the block in current_ir_block.
3921 * @param *op1 The first operand.
3922 * @param *op2 The second operand.
3923 * @param *mode The mode of the operands and the result.
3925 FIRM_API ir_node *new_Borrow(ir_node *op1, ir_node *op2, ir_mode *mode);
3927 /** Constructor for a Phi node.
3929 * Adds the node to the block in current_ir_block.
3931 * @param arity The number of predecessors.
3932 * @param *in Array with predecessors.
3933 * @param *mode The mode of it's inputs and output.
3935 FIRM_API ir_node *new_Phi(int arity, ir_node *in[], ir_mode *mode);
3937 /** Constructor for a Load node.
3939 * @param *store The current memory.
3940 * @param *addr A pointer to the variable to be read in this memory.
3941 * @param *mode The mode of the value to be loaded.
3942 * @param flags Additional flags for alignment, volatility and pin state.
3944 FIRM_API ir_node *new_Load(ir_node *store, ir_node *addr, ir_mode *mode,
3945 ir_cons_flags flags);
3947 /** Constructor for a Store node.
3949 * @param *store The current memory.
3950 * @param *addr A pointer to the variable to be read in this memory.
3951 * @param *val The value to write to this variable.
3952 * @param flags Additional flags for alignment, volatility and pin state.
3954 FIRM_API ir_node *new_Store(ir_node *store, ir_node *addr, ir_node *val,
3955 ir_cons_flags flags);
3957 /** Constructor for a Alloc node.
3959 * The Alloc node extends the memory by space for an entity of type alloc_type.
3960 * Adds the node to the block in current_ir_block.
3962 * @param *store The memory which shall contain the new variable.
3963 * @param *count The number of objects to allocate.
3964 * @param *alloc_type The type of the allocated variable.
3965 * @param where Where to allocate the variable, either heap_alloc or stack_alloc.
3967 FIRM_API ir_node *new_Alloc(ir_node *store, ir_node *count, ir_type *alloc_type,
3968 ir_where_alloc where);
3970 /** Constructor for a Free node.
3972 * Frees the memory occupied by the entity pointed to by the pointer
3973 * arg. Type indicates the type of the entity the argument points to.
3974 * Adds the node to the block in current_ir_block.
3976 * @param *store The memory which shall contain the new variable.
3977 * @param *ptr The pointer to the object to free.
3978 * @param *size The number of objects of type free_type to free in a sequence.
3979 * @param *free_type The type of the freed variable.
3980 * @param where Where the variable was allocated, either heap_alloc or stack_alloc.
3982 FIRM_API ir_node *new_Free(ir_node *store, ir_node *ptr, ir_node *size,
3983 ir_type *free_type, ir_where_alloc where);
3985 /** Constructor for a Sync node.
3987 * Merges several memory values. The node assumes that a variable
3988 * either occurs only in one of the memories, or it contains the same
3989 * value in all memories where it occurs.
3990 * Adds the node to the block in current_ir_block.
3992 * @param arity The number of memories to synchronize.
3993 * @param **in An array of pointers to nodes that produce an output of type
3994 * memory. The constructor copies this array.
3996 FIRM_API ir_node *new_Sync(int arity, ir_node *in[]);
3998 /** Constructor for a Proj node.
4000 * Projects a single value out of a tuple. The parameter proj gives the
4001 * position of the value within the tuple.
4002 * Adds the node to the block in current_ir_block.
4004 * @param arg A node producing a tuple.
4005 * @param *mode The mode of the value to project.
4006 * @param proj The position of the value in the tuple.
4008 FIRM_API ir_node *new_Proj(ir_node *arg, ir_mode *mode, long proj);
4010 /** Constructor for a defaultProj node.
4012 * Represents the default control flow of a Switch-Cond node.
4013 * Adds the node to the block in current_ir_block.
4015 * @param arg A node producing a tuple.
4016 * @param max_proj The end position of the value in the tuple.
4018 FIRM_API ir_node *new_defaultProj(ir_node *arg, long max_proj);
4020 /** Constructor for a Tuple node.
4022 * This is an auxiliary node to replace a node that returns a tuple
4023 * without changing the corresponding Proj nodes.
4024 * Adds the node to the block in current_ir_block.
4026 * @param arity The number of tuple elements.
4027 * @param **in An array containing pointers to the nodes producing the tuple elements.
4029 FIRM_API ir_node *new_Tuple(int arity, ir_node *in[]);
4031 /** Constructor for an Id node.
4033 * This is an auxiliary node to replace a node that returns a single
4034 * value. Adds the node to the block in current_ir_block.
4036 * @param *val The operand to Id.
4037 * @param *mode The mode of *val.
4039 FIRM_API ir_node *new_Id(ir_node *val, ir_mode *mode);
4041 /** Constructor for a Bad node.
4043 * Returns the unique Bad node of the graph. The same as
4046 FIRM_API ir_node *new_Bad(void);
4048 /** Constructor for a Confirm node.
4050 * Specifies constraints for a value. To support dataflow analyses.
4051 * Adds the node to the block in current_ir_block.
4053 * Example: If the value never exceeds '100' this is expressed by placing a
4054 * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge.
4056 * @param *val The value we express a constraint for
4057 * @param *bound The value to compare against. Must be a firm node, typically a constant.
4058 * @param cmp The compare operation.
4060 FIRM_API ir_node *new_Confirm(ir_node *val, ir_node *bound, pn_Cmp cmp);
4062 /** Constructor for an Unknown node.
4064 * Represents an arbitrary value. Places the node in
4067 * @param *m The mode of the unknown value.
4069 FIRM_API ir_node *new_Unknown(ir_mode *m);
4071 /** Constructor for a NoMem node.
4073 * Returns the unique NoMem node of the graph. The same as
4076 FIRM_API ir_node *new_NoMem(void);
4078 /** Constructor for a Mux node.
4080 * Adds the node to the block in current_ir_block.
4082 * @param *sel The ir_node that calculates the boolean select.
4083 * @param *ir_true The ir_node that calculates the true result.
4084 * @param *ir_false The ir_node that calculates the false result.
4085 * @param *mode The mode of the node (and it_true and ir_false).
4087 FIRM_API ir_node *new_Mux(ir_node *sel, ir_node *ir_false, ir_node *ir_true,
4090 /** Constructor for a CopyB node.
4092 * Adds the node to the block in current_ir_block.
4094 * @param *store The current memory
4095 * @param *dst The ir_node that represents the destination address.
4096 * @param *src The ir_node that represents the source address.
4097 * @param *data_type The type of the copied data
4099 FIRM_API ir_node *new_CopyB(ir_node *store, ir_node *dst, ir_node *src,
4100 ir_type *data_type);
4102 /** Constructor for a InstOf node.
4104 * A High-Level Type check.
4106 * @param *store The memory in which the object the entity should be selected
4107 * from is allocated.
4108 * @param *objptr A pointer to a object of a class type.
4109 * @param *type The type of which objptr must be.
4111 FIRM_API ir_node *new_InstOf(ir_node *store, ir_node *objptr, ir_type *type);
4113 /**Constructor for a Raise node.
4115 * A High-Level Exception throw.
4117 * @param *store The current memory.
4118 * @param *obj A pointer to the Except variable.
4120 FIRM_API ir_node *new_Raise(ir_node *store, ir_node *obj);
4122 /** Constructor for a Bound node.
4124 * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
4126 * Adds the node to the block in current_ir_block.
4128 * @param *store The current memory
4129 * @param *idx The ir_node that represents an index.
4130 * @param *lower The ir_node that represents the lower bound for the index.
4131 * @param *upper The ir_node that represents the upper bound for the index.
4133 FIRM_API ir_node *new_Bound(ir_node *store, ir_node *idx, ir_node *lower,
4136 /** Constructor for a Pin node.
4138 * @param *node The node which value should be pinned.
4140 FIRM_API ir_node *new_Pin(ir_node *node);
4142 /** Constructor for an ASM pseudo node.
4144 * @param arity The number of data inputs to the node.
4145 * @param *in The array of length arity of data inputs.
4146 * @param *inputs The array of length arity of input constraints.
4147 * @param n_outs The number of data outputs to the node.
4148 * @param *outputs The array of length n_outs of output constraints.
4149 * @param n_clobber The number of clobbered registers.
4150 * @param *clobber The array of length n_clobber of clobbered registers.
4151 * @param *asm_text The assembler text.
4153 FIRM_API ir_node *new_ASM(int arity, ir_node *in[], ir_asm_constraint *inputs,
4154 int n_outs, ir_asm_constraint *outputs,
4155 int n_clobber, ident *clobber[], ident *asm_text);
4158 * @brief Constructor for a Dummy node.
4160 * @param *db debug info for the node
4161 * @param *mode The mode of the node.
4162 * @param *irg the graph to put the node into
4163 * @returns the newly created note
4165 FIRM_API ir_node *new_rd_Dummy(dbg_info *db, ir_graph *irg, ir_mode *mode);
4168 * @copybrief new_rd_Dummy()
4170 * @param *mode The mode of the node.
4171 * @param *irg the graph to put the node into
4172 * @returns the newly created note
4174 FIRM_API ir_node *new_r_Dummy(ir_graph *irg, ir_mode *mode);
4177 * @copybrief new_rd_Dummy()
4179 * @param *db debug info for the node
4180 * @param *mode The mode of the node.
4181 * @returns the newly created note
4183 FIRM_API ir_node *new_d_Dummy(dbg_info *db, ir_mode *mode);
4186 * @copybrief new_rd_Dummy()
4188 * @param *mode The mode of the node.
4189 * @returns the newly created note
4191 FIRM_API ir_node *new_Dummy(ir_mode *mode);
4193 /*---------------------------------------------------------------------*/
4194 /* The comfortable interface. */
4195 /* Supports automatic Phi node construction. */
4196 /* All routines of the block oriented interface except new_Block are */
4198 /*---------------------------------------------------------------------*/
4200 /** Create an immature Block.
4202 * An immature Block has an unknown number of predecessors. Predecessors
4203 * can be added with add_immBlock_pred(). Once all predecessors are
4204 * added the block must be matured.
4206 * Adds the block to the graph in current_ir_graph. Can be used with automatic
4207 * Phi node construction.
4208 * This constructor can only be used if the graph is in state_building.
4210 FIRM_API ir_node *new_d_immBlock(dbg_info *db);
4211 FIRM_API ir_node *new_immBlock(void);
4212 FIRM_API ir_node *new_r_immBlock(ir_graph *irg);
4213 FIRM_API ir_node *new_rd_immBlock(dbg_info *db, ir_graph *irg);
4215 /** Add a control flow edge to an immature block. */
4216 FIRM_API void add_immBlock_pred(ir_node *immblock, ir_node *jmp);
4218 /** Finalize a Block node, when all control flows are known. */
4219 FIRM_API void mature_immBlock(ir_node *block);
4221 /** Get the current value of a local variable.
4223 * Use this function to obtain the last definition of the local variable
4224 * associated with pos. Pos may not exceed the value passed as n_loc
4225 * to new_ir_graph. This call automatically inserts Phi nodes.
4227 * @param *db A pointer for debug information.
4228 * @param pos The position/id of the local variable.
4229 * @param *mode The mode of the value to get.
4231 FIRM_API ir_node *get_value(int pos, ir_mode *mode);
4232 FIRM_API ir_node *get_r_value(ir_graph *irg, int pos, ir_mode *mode);
4235 * Try to guess the mode of a local variable.
4236 * This is done by recursively going up the control flow graph until
4237 * we find a definition for the variable. The mode of the first found
4238 * definition is returned. NULL in case no definition is found.
4240 * @param pos The position/id of the local variable.
4242 FIRM_API ir_mode *ir_guess_mode(int pos);
4244 /** Remark a new definition of a variable.
4246 * Use this function to remember a new definition of the value
4247 * associated with pos. Pos may not exceed the value passed as n_loc
4248 * to new_ir_graph. This call is needed to automatically inserts Phi
4251 * @param pos The position/id of the local variable.
4252 * @param *value The new value written to the local variable.
4254 FIRM_API void set_value(int pos, ir_node *value);
4255 FIRM_API void set_r_value(ir_graph *irg, int pos, ir_node *value);
4258 * Find the value number for a node in the current block.
4260 * @param value the searched value
4262 * @return the value number of the value or -1 if this value has
4263 * no value number in the current block.
4265 FIRM_API int find_value(ir_node *value);
4267 /** Get the current memory state.
4269 * Use this function to obtain the last definition of the memory
4270 * state. This call automatically inserts Phi nodes for the memory
4273 FIRM_API ir_node *get_store(void);
4274 FIRM_API ir_node *get_r_store(ir_graph *irg);
4276 /** Remark a new definition of the memory state.
4278 * Use this function to remember a new definition of the memory state.
4279 * This call is needed to automatically inserts Phi nodes.
4281 * @param *store The new memory state.
4283 FIRM_API void set_store(ir_node *store);
4284 FIRM_API void set_r_store(ir_graph *irg, ir_node *store);
4286 /** keep this node alive even if End is not control-reachable from it
4288 * @param ka The node to keep alive.
4290 FIRM_API void keep_alive(ir_node *ka);
4292 /* --- initialize and finalize IR construction --- */
4294 /** Puts the graph into state "phase_high" */
4295 FIRM_API void irg_finalize_cons(ir_graph *irg);
4297 /** Puts the program and all graphs into state phase_high.
4299 * This also remarks, the construction of types is finished,
4300 * e.g., that no more subtypes will be added. */
4301 FIRM_API void irp_finalize_cons(void);
4303 FIRM_API void ir_set_uninitialized_local_variable_func(
4304 uninitialized_local_variable_func_t *func);