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,
31 * documentation no more supported since 2001
33 * IR node construction.
35 * This file documents all datatypes and constructors needed to
36 * build a FIRM representation of a procedure. The constructors are
37 * also implemented in this file.
39 * The documentation also gives a short manual how to use the library.
41 * For extensive documentation of FIRM see UKA Techreport 1999-14.
44 * Three kinds of nodes
45 * --------------------
47 * There are three kinds of nodes known to the IR: entities,
50 * + ir_nodes are the actual nodes of the FIRM intermediate representation.
51 * They represent operations on the data of the program and control flow
54 * + entity ==> implemented in entity.h
55 * Refers to a single entity of the compiled program, e.g. a field of a
56 * class or a method. If a method or variable can not be assigned to
57 * a method or class or the like, it is a global object.
59 * + types ==> implemented in type.h
60 * With types type information is represented. There are several type
63 * Implementation of the FIRM operations: ir_node
64 * ----------------------------------------------
66 * Ir_nodes represent operations on the data of the program and control flow
67 * operations. Examples of ir_nodes: Add, Jmp, Cmp
69 * FIRM is a dataflow graph. A dataflow graph is a directed graph,
70 * so that every node has incoming and outgoing edges. A node is
71 * executable if every input at its incoming edges is available.
72 * Execution of the dataflow graph is started at the Start node which
73 * has no incoming edges and ends when the End node executes, even if
74 * there are still executable or not executed nodes. (Is this true,
75 * or must all executable nodes be executed?) (There are exceptions
76 * to the dataflow paradigma that all inputs have to be available
77 * before a node can execute: Phi, Block. See UKA Techreport
80 * The implementation of FIRM differs from the view as a dataflow
81 * graph. To allow fast traversion of the graph edges are
82 * implemented as C-pointers. Inputs to nodes are not ambiguous, the
83 * results can be used by several other nodes. Each input can be
84 * implemented as a single pointer to a predecessor node, outputs
85 * need to be lists of pointers to successors. Therefore a node
86 * contains pointers to its predecessors so that the implementation is a
87 * dataflow graph with reversed edges. It has to be traversed bottom
90 * All nodes of the IR have the same basic structure. They are
91 * distinguished by a field containing the opcode.
93 * The fields of an ir_node:
95 * kind A firm_kind tag containing k_ir_node. This is useful for
96 * dynamically checking the type of a node.
98 * *op This ir_op gives the opcode as a tag and a string
99 * and the number of attributes of an ir_node. There is
100 * one statically allocated struct ir_op for each opcode.
102 * *mode The ir_mode of the operation represented by this firm
103 * node. The mode of the operation is the mode of its
104 * result. A Firm mode is a datatype as known to the
105 * target, not a type of the source language.
107 * visit A flag for traversing the IR.
109 * **in An array with pointers to the node's predecessors.
111 * *link A pointer to an ir_node. With this pointer all Phi nodes
112 * are attached to a Block, i.e. a Block points to its
113 * first Phi node, this node points to the second Phi node
114 * in the Block and so forth. Used in mature_immBlock
115 * to find all Phi nodes to be matured. It's also used to
116 * annotate a node with a better, optimized version of it.
118 * attr An attr struct containing the attributes of the nodes. The
119 * attributes depend on the opcode of the node. The number
120 * of these attributes is given in op.
124 * Not yet documented. See irop.h.
128 * Not yet documented. See irmode.h.
130 * GLOBAL VARIABLES -- now also fields of ir_graph.
133 * current_ir_graph Points to the current ir_graph. All constructors for
134 * nodes add nodes to this graph.
136 * ir_visited An int used as flag to traverse the ir_graph.
138 * block_visited An int used as a flag to traverse block nodes in the
141 * Others not yet documented.
145 * CONSTRUCTOR FOR IR_GRAPH --> see irgraph.h
146 * ========================
149 * PROCEDURE TO CONSTRUCT AN IR GRAPH --> see also Firm tutorial
150 * ==================================
152 * This library supplies several interfaces to construct a FIRM graph for
154 * - A "comfortable" interface generating SSA automatically. Automatically
155 * computed predecessors of nodes need not be specified in the constructors.
156 * (new_<Node> constructurs and a set of additional routines.)
157 * - A less comfortable interface where all predecessors except the block
158 * an operation belongs to need to be specified. SSA must be constructed
159 * by hand. (new_<Node> constructors and set_cur_block()). This interface
160 * is called "block oriented". It automatically calles the local optimizations
162 * - An even less comfortable interface where the block needs to be specified
163 * explicitly. This is called the "raw" interface. (new_r_<Node>
164 * constructors). These nodes are not optimized.
166 * To use the functionality of the comfortable interface correctly the Front
167 * End needs to follow certain protocols. This is explained in the following.
168 * To build a correct IR with the other interfaces study the semantics of
169 * the firm node (See tech-reprot UKA 1999-14). For the construction of
170 * types and entities see the documentation in those modules.
172 * First the Frontend needs to decide which variables and values used in
173 * a procedure can be represented by dataflow edges. These are variables
174 * that need not be saved to memory as they cause no side effects visible
175 * out of the procedure. Often these are all compiler generated
176 * variables and simple local variables of the procedure as integers,
177 * reals and pointers. The frontend has to count and number these variables.
179 * First an ir_graph needs to be constructed with new_ir_graph. The
180 * constructor gets the number of local variables. The graph is held in the
181 * global variable irg.
183 * Now the construction of the procedure can start. Several basic blocks can
184 * be constructed in parallel, but the code within each block needs to
185 * be constructed (almost) in program order.
187 * A global variable holds the current basic block. All (non block) nodes
188 * generated are added to this block. The current block can be set with
189 * set_cur_block(block). If several blocks are constructed in parallel block
190 * switches need to be performed constantly.
192 * To generate a Block node (with the comfortable interface), its predecessor
193 * control flow nodes need not be known. In case of cyclic control flow these
194 * can not be known when the block is constructed. With add_immBlock_pred(block,
195 * cfnode) predecessors can be added to the block. If all predecessors are
196 * added to the block mature_immBlock(b) needs to be called. Calling mature_immBlock
197 * early improves the efficiency of the Phi node construction algorithm.
198 * But if several blocks are constructed at once, mature_immBlock must only
199 * be called after performing all set_values and set_stores in the block!
200 * (See documentation of new_immBlock constructor.)
202 * The constructors of arithmetic nodes require that their predecessors
203 * are mentioned. Sometimes these are available in the Frontend as the
204 * predecessors have just been generated by the frontend. If they are local
205 * values, the predecessors can be obtained from the library with a call to
206 * get_value(local_val_nr). (local_val_nr needs to be administered by
207 * the Frontend.) A call to get_value triggers the generation of Phi nodes.
208 * If an arithmetic operation produces a local value, this value needs to be
209 * passed to the library by set_value(node, local_val_nr).
210 * In straight line code these two operations just remember and return the
211 * pointer to nodes producing the value. If the value passes block boundaries
212 * Phi nodes can be inserted.
213 * Similar routines exist to manage the Memory operands: set_store and
216 * Several nodes produce more than one result. An example is the Div node.
217 * Such nodes return tuples of values. From these individual values can be
218 * extracted by proj nodes.
220 * The following example illustrates the construction of a simple basic block
221 * with two predecessors stored in variables cf_pred1 and cf_pred2, containing
224 * and finally jumping to an other block. The variable a got the local_val_nr
225 * 42 by the frontend.
227 * ir_node *this_block, *cf_pred1, *cf_pred2, *a_val, *mem, *div, *res, *cf_op;
229 * this_block = new_immBlock();
230 * add_immBlock_pred(this_block, cf_pred1);
231 * add_immBlock_pred(this_block, cf_pred2);
232 * mature_immBlock(this_block);
233 * a_val = get_value(42, mode_Iu);
235 * div = new_Div(mem, a_val, a_val, mode_Iu);
236 * mem = new_Proj(div, mode_M, pn_Div_M); * for the numbers for Proj see docu *
237 * res = new_Proj(div, mode_Iu, pn_Div_res);
239 * set_value(res, 42);
242 * For further information look at the documentation of the nodes and
243 * constructors and at the paragraph COPING WITH DATA OBJECTS at the
244 * end of this documentation.
246 * The comfortable interface contains the following routines further explained
249 * ir_node *new_immBlock (void);
250 * ir_node *new_Start (void);
251 * ir_node *new_End (void);
252 * ir_node *new_Jmp (void);
253 * ir_node *new_IJmp (ir_node *tgt);
254 * ir_node *new_Cond (ir_node *c);
255 * ir_node *new_Return (ir_node *store, int arity, ir_node **in);
256 * ir_node *new_Const (ir_tarval *con);
257 * ir_node *new_SymConst (ir_mode *mode, symconst_symbol value, symconst_kind kind);
258 * ir_node *new_simpleSel (ir_node *store, ir_node *objptr, ir_entity *ent);
259 * ir_node *new_Sel (ir_node *store, ir_node *objptr, int arity,
260 * ir_node **in, ir_entity *ent);
261 * ir_node *new_Call (ir_node *store, ir_node *callee, int arity,
262 * ir_node **in, type_method *type);
263 * ir_node *new_Builtin(ir_node *store, ir_builtin_kind kind, int arity,
264 * ir_node **in, type_method *type);
265 * ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode);
266 * ir_node *new_Sub (ir_node *op1, ir_node *op2, ir_mode *mode);
267 * ir_node *new_Minus (ir_node *op, ir_mode *mode);
268 * ir_node *new_Mul (ir_node *op1, ir_node *op2, ir_mode *mode);
269 * ir_node *new_Mulh (ir_node *op1, ir_node *op2, ir_mode *mode);
270 * ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
271 * ir_node *new_Mod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state;
272 * ir_node *new_And (ir_node *op1, ir_node *op2, ir_mode *mode);
273 * ir_node *new_Or (ir_node *op1, ir_node *op2, ir_mode *mode);
274 * ir_node *new_Eor (ir_node *op1, ir_node *op2, ir_mode *mode);
275 * ir_node *new_Not (ir_node *op, ir_mode *mode);
276 * ir_node *new_Shl (ir_node *op, ir_node *k, ir_mode *mode);
277 * ir_node *new_Shr (ir_node *op, ir_node *k, ir_mode *mode);
278 * ir_node *new_Shrs (ir_node *op, ir_node *k, ir_mode *mode);
279 * ir_node *new_Rotl (ir_node *op, ir_node *k, ir_mode *mode);
280 * ir_node *new_Cmp (ir_node *op1, ir_node *op2);
281 * ir_node *new_Conv (ir_node *op, ir_mode *mode);
282 * ir_node *new_Cast (ir_node *op, ir_type *to_tp);
283 * ir_node *new_Carry (ir_node *op1, ir_node *op2, ir_mode *mode);
284 * ir_node *new_Borrow (ir_node *op1, ir_node *op2, ir_mode *mode);
285 * ir_node *new_Load (ir_node *store, ir_node *addr, ir_mode *mode, ir_cons_flags flags);
286 * ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val, ir_cons_flags flags);
287 * ir_node *new_Alloc (ir_node *store, ir_node *count, ir_type *alloc_type,
288 * where_alloc where);
289 * ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size,
290 * ir_type *free_type, where_alloc where);
291 * ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj);
292 * ir_node *new_NoMem (void);
293 * ir_node *new_Mux (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
294 * ir_node *new_CopyB (ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
295 * ir_node *new_InstOf (ir_node *store, ir_node obj, ir_type *ent);
296 * ir_node *new_Raise (ir_node *store, ir_node *obj);
297 * ir_node *new_Bound (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
298 * ir_node *new_Pin (ir_node *node);
300 * void add_immBlock_pred (ir_node *block, ir_node *jmp);
301 * void mature_immBlock (ir_node *block);
302 * void set_cur_block (ir_node *target);
303 * ir_node *get_value (int pos, ir_mode *mode);
304 * void set_value (int pos, ir_node *value);
305 * ir_node *get_store (void);
306 * void set_store (ir_node *store);
307 * keep_alive (ir_node ka)
309 * IR_NODES AND CONSTRUCTORS FOR IR_NODES
310 * =======================================
312 * All ir_nodes are defined by a common data structure. They are distinguished
313 * by their opcode and differ in the number of their attributes.
315 * Const nodes are always added to the start block.
316 * All other constructors add the created node to the current_block.
317 * swich_block(block) allows to set the current block to block.
319 * Watch for my inconsistent use of input and predecessor (dataflow view)
320 * and `the node points to' (implementation view).
322 * The following description of the nodes lists four properties them if these
324 * - the parameters to the constructor
325 * - the inputs of the Firm node
326 * - the outputs of the Firm node
327 * - attributes to the node
331 * ir_node *new_immBlock (void)
332 * ----------------------------
334 * Creates a new block. When a new block is created it cannot be known how
335 * many predecessors this block will have in the control flow graph.
336 * Therefore the list of inputs can not be fixed at creation. Predecessors
337 * can be added with add_immBlock_pred (block, control flow operation).
338 * With every added predecessor the number of inputs to Phi nodes also
341 * The block can be completed by mature_immBlock(block) if all predecessors are
342 * known. If several blocks are built at once, mature_immBlock can only be called
343 * after set_value has been called for all values that are life at the end
344 * of the block. This is necessary so that Phi nodes created mature_immBlock
345 * get the right predecessors in case of cyclic dependencies. If all set_values
346 * of this block are called after maturing it and before calling get_value
347 * in some block that is control flow dependent on this block, the construction
350 * Example for faulty IR construction: (draw the graph on a paper and you'll
353 * block_before_loop = new_immBlock();
354 * set_cur_block(block_before_loop);
356 * mature_immBlock(block_before_loop);
357 * before2header = new_Jmp;
359 * loop_header = new_immBlock ();
360 * set_cur_block(loop_header);
361 * header2body - new_Jmp();
363 * loop_body = new_immBlock ();
364 * set_cur_block(loop_body);
365 * body2header = new_Jmp();
367 * add_immBlock_pred(loop_header, before2header);
368 * add_immBlock_pred(loop_header, body2header);
369 * add_immBlock_pred(loop_body, header2body);
371 * mature_immBlock(loop_header);
372 * mature_immBlock(loop_body);
374 * get_value(loop_body, x); // gets the Phi in loop_header
375 * set_value(loop_header, x); // sets the value the above get_value should
376 * // have returned!!!
378 * Mature_immBlock also fixes the number of inputs to the Phi nodes. Mature_immBlock
379 * should be called as early as possible, as afterwards the generation of Phi
380 * nodes is more efficient.
383 * There is an input for each control flow predecessor of the block.
384 * The input points to an instruction producing an output of type X.
385 * Possible predecessors: Start, Jmp, Cond, Raise or Return or any node
386 * possibly causing an exception. (Often the real predecessors are Projs.)
388 * Mode BB (R), all nodes belonging to this block should consume this output.
389 * As they are strict (except Block and Phi node) it is a necessary condition
390 * that the block node executed before any other node in this block executes.
392 * block.matured Indicates whether the block is mature.
394 * This attribute contains all local values valid in this
395 * block. This is needed to build the Phi nodes and removed
396 * if the graph is complete. This field is used by the
397 * internal construction algorithm and should not be accessed
401 * ir_node *new_Block (int arity, ir_node **in)
402 * --------------------------------------------
404 * Creates a new Block with the given list of predecessors. This block
405 * is mature. As other constructors calls optimization and verify for the
406 * block. If one of the predecessors is Unknown (as it has to be filled in
407 * later) optimizations are skipped. This is necessary to
408 * construct Blocks in loops.
411 * CONTROL FLOW OPERATIONS
412 * -----------------------
414 * In each block there must be exactly one of the control flow
415 * operations Start, End, Jmp, Cond, Return or Raise. The output of a
416 * control flow operation points to the block to be executed next.
418 * ir_node *new_Start (void)
419 * -------------------------
421 * Creates a start node. Not actually needed public. There is only one such
422 * node in each procedure which is automatically created by new_ir_graph.
425 * No inputs except the block it belongs to.
427 * A tuple of 4 (5, 6) distinct values. These are labeled by the following
428 * projection numbers (pn_Start):
429 * * pn_Start_X_initial_exec mode X, points to the first block to be exe * cuted.
430 * * pn_Start_M mode M, the global store
431 * * pn_Start_P_frame_base mode P, a pointer to the base of the proce * dures stack frame.
432 * * pn_Start_P_globals mode P, a pointer to the part of the memory * containing_all_ global things.
433 * * pn_Start_T_args mode T, a tuple containing all arguments of * the procedure.
436 * ir_node *new_End (void)
437 * -----------------------
439 * Creates an end node. Not actually needed public. There is only one such
440 * node in each procedure which is automatically created by new_ir_graph.
443 * No inputs except the block it belongs to.
447 * ir_node *new_Jmp (void)
448 * -----------------------
450 * Creates a Jmp node.
453 * The block the node belongs to
455 * Control flow to the next block.
457 * ir_node *new_IJmp (ir_node *tgt)
458 * -----------------------
460 * Creates an IJmp node.
463 * The node that represents the target jump address
465 * Control flow to an unknown target, must be pinned by
468 * ir_node *new_Cond (ir_node *c)
469 * ------------------------------
471 * Creates a Cond node. There are two versions of this node.
477 * A tuple of two control flows. The first is taken if the input is
478 * false, the second if it is true.
482 * A value of mode I_u. (i)
484 * A tuple of n control flows. If the Cond's input is i, control
485 * flow will proceed along output i. If the input is >= n control
486 * flow proceeds along output n.
488 * ir_node *new_Return (ir_node *store, int arity, ir_node **in)
489 * -------------------------------------------------------------
491 * The Return node has as inputs the results of the procedure. It
492 * passes the control flow to the end_block.
498 * Control flow to the end block.
501 * ir_node *new_Const (ir_tarval *con)
502 * -----------------------------------------------
504 * Creates a constant in the constant table and adds a Const node
505 * returning this value to the start block. The mode is derived
509 * *con Points to an entry in the constant table.
510 * This pointer is added to the attributes of
511 * the node (self->attr.con)
513 * No inputs except the block it belogns to.
515 * The constant value.
517 * attr.con A tarval* pointer to the proper entry in the constant
520 * ir_node *new_SymConst (ir_mode *mode, union symconst_symbol value, symconst_addr_ent kind)
521 * -----------------------------------------------------------------------------------------
523 * There are several symbolic constants:
524 * symconst_type_size The symbolic constant represents the size of a type.
525 * symconst_type_align The symbolic constant represents the alignment of a type.
526 * symconst_addr_ent The symbolic constant represents the address of an entity.
527 * symconst_ofs_ent The symbolic constant represents the offset of an
528 * entity in its owner type.
529 * symconst_enum_const The symbolic constant is a enumeration constant of an
533 * mode P for SymConsts representing addresses, Iu otherwise.
534 * value The type, ident, entity or enum constant, depending on the
536 * kind The kind of the symbolic constant, see the list above.
539 * No inputs except the block it belongs to.
541 * A symbolic constant.
544 * attr.i.num The symconst_addr_ent, i.e. one of
545 * -symconst_type_size
546 * -symconst_type_align
549 * If the attr.i.num is symconst_type_size or symconst_type_align,
550 * the node contains an attribute:
552 * attr.i.*type, a pointer to a type_class.
553 * if it is linkage_ptr_info it contains
554 * attr.i.*ptrinfo, an ident holding information for the linker.
558 * ir_node *new_simpleSel (ir_node *store, ir_node *frame, ir_entity *sel)
559 * -----------------------------------------------------------------------
562 * Selects an entity from a compound type. This entity can be a field or
566 * *store The memory in which the object the entity should be selected
568 * *frame The pointer to the object.
569 * *sel The entity to select.
572 * The memory containing the object.
573 * A pointer to the object.
574 * An unsigned integer.
576 * A pointer to the selected entity.
578 * attr.sel Pointer to the entity
581 * ir_node *new_Sel (ir_node *store, ir_node *frame, int arity, ir_node **in,
582 * --------------------------------------------------------------------------
586 * Selects a field from an array type. The entity has as owner the array, as
587 * type the arrays element type. The indices to access an array element are
591 * *store The memory in which the object the entity should be selected from
593 * *frame The pointer to the object.
594 * *arity number of array indices.
595 * *in array with index inputs to the node.
596 * *sel The entity to select.
599 * The memory containing the object.
600 * A pointer to the object.
601 * As much unsigned integer as there are array expressions.
603 * A pointer to the selected entity.
605 * attr.sel Pointer to the entity
607 * The constructors new_Sel and new_simpleSel generate the same IR nodes.
608 * simpleSel just sets the arity of the index inputs to zero.
611 * ARITHMETIC OPERATIONS
612 * ---------------------
614 * ir_node *new_Call (ir_node *store, ir_node *callee, int arity, ir_node **in,
615 * ----------------------------------------------------------------------------
619 * Creates a procedure call.
622 * *store The actual store.
623 * *callee A pointer to the called procedure.
624 * arity The number of procedure parameters.
625 * **in An array with the pointers to the parameters.
626 * The constructor copies this array.
627 * *type Type information of the procedure called.
630 * The store, the callee and the parameters.
632 * A tuple containing the eventually changed store and the procedure
635 * attr.call Contains the attributes for the procedure.
637 * ir_node *new_Builtin(ir_node *store, ir_builtin_kind kind, int arity, ir_node **in,
638 * -----------------------------------------------------------------------------------
642 * Creates a builtin call.
645 * *store The actual store.
646 * kind Describes the called builtin.
647 * arity The number of procedure parameters.
648 * **in An array with the pointers to the parameters.
649 * The constructor copies this array.
650 * *type Type information of the procedure called.
653 * The store, the kind and the parameters.
655 * A tuple containing the eventually changed store and the procedure
658 * attr.builtin Contains the attributes for the called builtin.
660 * ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode)
661 * ------------------------------------------------------------
665 * ir_node *new_Sub (ir_node *op1, ir_node *op2, ir_mode *mode)
666 * ------------------------------------------------------------
670 * ir_node *new_Minus (ir_node *op, ir_mode *mode)
671 * -----------------------------------------------
673 * Unary Minus operations on integer and floating point values.
675 * ir_node *new_Mul (ir_node *op1, ir_node *op2, ir_mode *mode)
676 * ------------------------------------------------------------
680 * ir_node *new_Mulh (ir_node *op1, ir_node *op2, ir_mode *mode)
681 * ------------------------------------------------------------
683 * Returns the high order bits of a n*n=2n multiplication.
685 * ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state)
686 * ------------------------------------------------------------------------------------------------
690 * ir_node *new_Mod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state)
691 * ------------------------------------------------------------------------------------------------
695 * ir_node *new_And (ir_node *op1, ir_node *op2, ir_mode *mode)
696 * ------------------------------------------------------------
700 * ir_node *new_Or (ir_node *op1, ir_node *op2, ir_mode *mode)
701 * -----------------------------------------------------------
705 * ir_node *new_Eor (ir_node *op1, ir_node *op2, ir_mode *mode)
706 * ------------------------------------------------------------
710 * ir_node *new_Not (ir_node *op, ir_mode *mode)
711 * ---------------------------------------------
713 * This node constructs a constant where all bits are set to one
714 * and a Eor of this constant and the operator. This simulates a
717 * ir_node *new_Shl (ir_node *op, ir_node *k, ir_mode *mode)
718 * ---------------------------------------------------------
722 * ir_node *new_Shr (ir_node *op, ir_node *k, ir_mode *mode)
723 * ---------------------------------------------------------
725 * Logic shift right, i.e., zero extended.
728 * ir_node *new_Shrs (ir_node *op, ir_node *k, ir_mode *mode)
729 * ----------------------------------------------------------
731 * Arithmetic shift right, i.e., sign extended.
733 * ir_node *new_Rotl (ir_node *op, ir_node *k, ir_mode *mode)
734 * ---------------------------------------------------------
736 * Rotates the operand to the left by k bits.
738 * ir_node *new_Carry (ir_node *op1, ir_node *op2, ir_mode *mode)
739 * ------------------------------------------------------------
741 * Calculates the Carry value for integer addition. Used only
744 * ir_node *new_Borrow (ir_node *op1, ir_node *op2, ir_mode *mode)
745 * ------------------------------------------------------------
747 * Calculates the Borrow value for integer substraction. Used only
750 * ir_node *new_Conv (ir_node *op, ir_mode *mode)
751 * ---------------------------------------------
753 * Mode conversion. For allowed conversions see UKA Tech Report
756 * ir_node *new_Cmp (ir_node *op1, ir_node *op2)
757 * ---------------------------------------------
760 * The two values to be compared.
762 * A 16-tuple containing the results of the 16 different comparisons.
763 * The following is a list giving the comparisons and a projection
764 * number (pn_Cmp) to use in Proj nodes to extract the proper result.
768 * pn_Cmp_Le less or equal
770 * pn_Cmp_Ge greater of equal
771 * pn_Cmp_Lg less or greater
772 * pn_Cmp_Leg less, equal or greater = ordered
773 * pn_Cmp_Uo unordered
774 * pn_Cmp_Ue unordered or equal
775 * pn_Cmp_Ul unordered or less
776 * pn_Cmp_Ule unordered, less or equal
777 * pn_Cmp_Ug unordered or greater
778 * pn_Cmp_Uge unordered, greater or equal
779 * pn_Cmp_Ne unordered, less or greater = not equal
786 * In general, Phi nodes are automaitcally inserted. In some cases, if
787 * all predecessors of a block are known, an explicit Phi node constructor
788 * is needed. E.g., to construct a FIRM graph for a statement as
789 * a = (b==c) ? 2 : 5;
791 * ir_node *new_Phi (int arity, ir_node **in, ir_mode *mode)
792 * ---------------------------------------------------------
794 * Creates a Phi node. The in's order has to correspond to the order
795 * of in's of current_block. This is not checked by the library!
796 * If one of the predecessors is Unknown (as it has to be filled in
797 * later) optimizations are skipped. This is necessary to
798 * construct Phi nodes in loops.
801 * arity number of predecessors
802 * **in array with predecessors
803 * *mode The mode of its inputs and output.
805 * A Phi node has as many inputs as the block it belongs to.
806 * Each input points to a definition of the same value on a
807 * different path in the control flow.
809 * The definition valid in this block.
811 * ir_node *new_Mux (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode)
812 * -----------------------------------------------------------------------------------
814 * Creates a Mux node. This node implements the following semantic:
815 * If the sel node (which must be of mode_b) evaluates to true, its value is
816 * ir_true, else ir_false;
820 * OPERATIONS TO MANAGE MEMORY EXPLICITLY
821 * --------------------------------------
823 * ir_node *new_Load (ir_node *store, ir_node *addr, ir_mode *mode, ir_cons_flags flags)
824 * -------------------------------------------------------------------------------------
826 * The Load operation reads a value from memory.
829 * *store The current memory.
830 * *addr A pointer to the variable to be read in this memory.
831 * *mode The mode of the value to be loaded.
832 * flags Additional flags for alignment, volatility and pin state.
835 * The memory and a pointer to a variable in this memory.
837 * A tuple of the memory, a control flow to be taken in case of
838 * an exception and the loaded value.
840 * ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val, ir_cons_flags flags)
841 * -------------------------------------------------------------------------------------
843 * The Store operation writes a value to a variable in memory.
846 * The memory, a pointer to a variable in this memory and the value
847 * to write to this variable.
849 * A tuple of the changed memory and a control flow to be taken in
850 * case of an exception.
852 * ir_node *new_Alloc (ir_node *store, ir_node *count, ir_type *alloc_type,
853 * -----------------------------------------------------------------------
857 * The Alloc node allocates a new variable. It can be specified whether the
858 * variable should be allocated to the stack or to the heap.
861 * *store The memory which shall contain the new variable.
862 * *count This field is for allocating arrays, it specifies how
863 * many array elements are to be allocated.
864 * *alloc_type The type of the allocated variable. In case of allocating
865 * arrays this has to be the array type, not the type of the
867 * where Where to allocate the variable, either heap_alloc or stack_alloc.
870 * A memory and an unsigned integer.
872 * A tuple of the changed memory, a control flow to be taken in
873 * case of an exception and the pointer to the new variable.
875 * a.where Indicates where the variable is allocated.
876 * a.*type A pointer to the class the allocated data object
879 * ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size, ir_type *free_type,
880 * -----------------------------------------------------------------------------------
884 * The Free node frees memory of the given variable.
887 * *store The memory which shall contain the new variable.
888 * *ptr The pointer to the object to free.
889 * *size The number of objects of type free_type to free in a sequence.
890 * *free_type The type of the freed variable.
891 * where Where the variable was allocated, either heap_alloc or stack_alloc.
894 * A memory, a pointer and an unsigned integer.
896 * The changed memory.
898 * f.*type A pointer to the type information of the freed data object.
902 * ir_node *new_Sync (int arity, ir_node **in)
903 * -------------------------------------------
905 * The Sync operation unifies several partial memory blocks. These blocks
906 * have to be pairwise disjunct or the values in common locations have to
907 * be identical. This operation allows to specify all operations that eventually
908 * need several partial memory blocks as input with a single entrance by
909 * unifying the memories with a preceding Sync operation.
912 * arity The number of memories to synchronize.
913 * **in An array of pointers to nodes that produce an output of
918 * The unified memory.
924 * ir_node *new_NoMem (void)
925 * -----------------------------------------------------------------------------------
927 * Returns the unique NoMem node current_ir_graph->no_mem.
928 * This node is used as input for operations that need a Memory, but do not
929 * change it like Div by const != 0, analyzed calls etc.
931 * ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj)
932 * ----------------------------------------------------------
934 * Selects one entry of a tuple. This is a hidden edge with attributes.
937 * *arg A node producing a tuple.
938 * *mode The mode of the value to project.
939 * proj The position of the value in the tuple.
945 * ir_node *new_Tuple (int arity, ir_node **in)
946 * --------------------------------------------
948 * Builds a Tuple from single values. This is needed to implement
949 * optimizations that remove a node that produced a tuple. The node can be
950 * replaced by the Tuple operation so that the following Proj nodes have not to
951 * be changed. (They are hard to find due to the implementation with pointers
952 * in only one direction.) The Tuple node is smaller than any other
953 * node, so that a node can be changed into a Tuple by just changing its
954 * opcode and giving it a new in array.
957 * arity The number of tuple elements.
958 * **in An array containing pointers to the nodes producing the
961 * ir_node *new_Id (ir_node *val, ir_mode *mode)
962 * ---------------------------------------------
964 * The single output of the Id operation is its input. Also needed
968 * HIGH LEVEL OPERATIONS
969 * ---------------------
971 * ir_node *new_CopyB (ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type)
972 * -----------------------------------------------------------------------------------
974 * Describes a high level block copy of a compound type from address src to
975 * address dst. Must be lowered to a Call to a runtime memory copy function.
978 * HIGH LEVEL OPERATIONS: Exception Support
979 * ----------------------------------------
980 * See TechReport 1999-14, chapter Exceptions.
982 * ir_node *new_InstOf(ir_node *store, ir_node *ptr, ir_type *type);
983 * -----------------------------------------------------------------------------------
985 * Describes a high level type check. Must be lowered to a Call to a runtime check
988 * ir_node *new_Raise (ir_node *store, ir_node *obj)
989 * -------------------------------------------------
991 * Raises an exception. Unconditional change of control flow. Writes
992 * an explicit Except variable to memory to pass it to the exception
993 * handler. Must be lowered to a Call to a runtime check
998 * A pointer to the Except variable.
1000 * A tuple of control flow and the changed memory state. The control flow
1001 * points to the exception handler if it is definied in this procedure,
1002 * else it points to the end_block.
1004 * ir_node *new_Bound (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
1005 * -----------------------------------------------------------------------------------
1007 * Describes a high level bounds check. Must be lowered to a Call to a runtime check
1010 * ir_node *new_Pin (ir_node *node);
1011 * -----------------------------------------------------------------------------------
1013 * Pin the value of the node node in the current block No users of the Pin node can
1014 * float above the Block of the Pin. The node cannot float behind this block. Often
1015 * used to Pin the NoMem node.
1018 * COPING WITH DATA OBJECTS
1019 * ========================
1021 * Two kinds of data objects have to be distinguished for generating
1022 * FIRM. First there are local variables other than arrays that are
1023 * known to be alias free. Second there are all other data objects.
1024 * For the first a common SSA representation is built, the second
1025 * are modeled by saving them to memory. The memory is treated as
1026 * a single local variable, the alias problem is hidden in the
1027 * content of this variable.
1029 * All values known in a Block are listed in the block's attribute,
1030 * block.**graph_arr which is used to automatically insert Phi nodes.
1031 * The following two functions can be used to add a newly computed value
1032 * to the array, or to get the producer of a value, i.e., the current
1035 * inline void set_value (int pos, ir_node *value)
1036 * -----------------------------------------------
1038 * Has to be called for every assignment to a local variable. It
1039 * adds the value to the array of used values at position pos. Pos
1040 * has to be a unique identifier for an entry in the procedure's
1041 * definition table. It can be used to access the value again.
1042 * Requires current_block to be set correctly.
1044 * ir_node *get_value (int pos, ir_mode *mode)
1045 * -------------------------------------------
1047 * Returns the node defining the value referred to by pos. If the
1048 * value is not defined in this block a Phi node is generated and
1049 * all definitions reaching this Phi node are collected. It can
1050 * happen that the algorithm allocates an unnecessary Phi node,
1051 * e.g. if there is only one definition of this value, but this
1052 * definition reaches the currend block on several different
1053 * paths. This Phi node will be eliminated if optimizations are
1054 * turned on right after its creation.
1055 * Requires current_block to be set correctly.
1057 * There are two special routines for the global store:
1059 * void set_store (ir_node *store)
1060 * -------------------------------
1062 * Adds the store to the array of known values at a reserved
1064 * Requires current_block to be set correctly.
1066 * ir_node *get_store (void)
1067 * -------------------------
1069 * Returns the node defining the actual store.
1070 * Requires current_block to be set correctly.
1073 * inline void keep_alive (ir_node *ka)
1074 * ------------------------------------
1076 * Keep this node alive because it is (might be) not in the control
1077 * flow from Start to End. Adds the node to the list in the end
1081 #ifndef FIRM_IR_IRCONS_H
1082 #define FIRM_IR_IRCONS_H
1084 #include "firm_types.h"
1088 /*-------------------------------------------------------------------------*/
1089 /* The raw interface */
1090 /*-------------------------------------------------------------------------*/
1093 * Constructor for a Const node.
1095 * Adds the node to the start block.
1097 * Constructor for a Const node. The constant represents a target
1098 * value. Sets the type information to type_unknown. (No more
1099 * supported: If tv is entity derives a somehow useful type.)
1101 * @param *db A pointer for debug information.
1102 * @param *irg The IR graph the node belongs to.
1103 * @param *mode The mode of the operands and results.
1104 * @param value A value from which the tarval is made.
1106 FIRM_API ir_node *new_rd_Const_long(dbg_info *db, ir_graph *irg,
1107 ir_mode *mode, long value);
1109 /** Constructor for a SymConst node.
1111 * This is the constructor for a symbolic constant.
1112 * There are several kinds of symbolic constants:
1113 * - symconst_type_size The symbolic constant represents the size of a type.
1114 * The type of which the constant represents the size
1115 * is given explicitly.
1116 * - symconst_type_align The symbolic constant represents the alignment of a
1117 * type. The type of which the constant represents the
1118 * size is given explicitly.
1119 * - symconst_addr_ent The symbolic constant represents the address of an
1120 * entity (variable or method). The variable is given
1121 * explicitly by a firm entity.
1122 * - symconst_ofs_ent The symbolic constant represents the offset of an
1123 * entity in its owner type.
1124 * - symconst_enum_const The symbolic constant is a enumeration constant of
1125 * an enumeration type.
1127 * Inputs to the node:
1128 * No inputs except the block it belongs to.
1129 * Outputs of the node.
1130 * An unsigned integer (I_u) or a pointer (P).
1132 * Mention union in declaration so that the firmjni generator recognizes that
1133 * it can not cast the argument to an int.
1135 * @param *db A pointer for debug information.
1136 * @param *irg The IR graph the node belongs to.
1137 * @param mode The mode for the SymConst.
1138 * @param value A type, ident, entity or enum constant depending on the
1140 * @param kind The kind of the symbolic constant, see the list above
1142 FIRM_API ir_node *new_rd_SymConst(dbg_info *db, ir_graph *irg, ir_mode *mode,
1143 union symconst_symbol value,
1144 symconst_kind kind);
1146 /** Constructor for a SymConst addr_ent node.
1148 * Same as new_rd_SymConst, except that the constructor is tailored for
1149 * symconst_addr_ent.
1150 * Adds the SymConst to the start block of irg. */
1151 FIRM_API ir_node *new_rd_SymConst_addr_ent(dbg_info *db, ir_graph *irg,
1152 ir_mode *mode, ir_entity *symbol);
1154 /** Constructor for a SymConst ofs_ent node.
1156 * Same as new_rd_SymConst, except that the constructor is tailored for
1158 * Adds the SymConst to the start block of irg.
1160 FIRM_API ir_node *new_rd_SymConst_ofs_ent(dbg_info *db, ir_graph *irg,
1161 ir_mode *mode, ir_entity *symbol);
1163 /** Constructor for a SymConst size node.
1165 * Same as new_rd_SymConst, except that the constructor is tailored for
1166 * symconst_type_size.
1167 * Adds the SymConst to the start block of irg. */
1168 FIRM_API ir_node *new_rd_SymConst_size(dbg_info *db, ir_graph *irg,
1169 ir_mode *mode, ir_type *symbol);
1171 /** Constructor for a SymConst size node.
1173 * Same as new_rd_SymConst, except that the constructor is tailored for
1174 * symconst_type_align.
1175 * Adds the SymConst to the start block of irg.
1177 FIRM_API ir_node *new_rd_SymConst_align(dbg_info *db, ir_graph *irg,
1178 ir_mode *mode, ir_type *symbol);
1180 /** Constructor for a simpleSel node.
1182 * This is a shortcut for the new_rd_Sel() constructor. To be used for
1183 * Sel nodes that do not select from an array, i.e., have no index
1184 * inputs. It adds the two parameters 0, NULL.
1186 * @param *db A pointer for debug information.
1187 * @param *block The IR block the node belongs to.
1188 * @param *store The memory in which the object the entity should be
1189 * selected from is allocated.
1190 * @param *objptr The object from that the Sel operation selects a
1191 * single attribute out.
1192 * @param *ent The entity to select.
1194 FIRM_API ir_node *new_rd_simpleSel(dbg_info *db, ir_node *block, ir_node *store,
1195 ir_node *objptr, ir_entity *ent);
1197 /** Constructor for a remainderless Div node.
1199 * @param *db A pointer for debug information.
1200 * @param *block The IR block the node belongs to.
1201 * @param *memop The store needed to model exceptions
1202 * @param *op1 The first operand.
1203 * @param *op2 The second operand.
1204 * @param *mode The mode of the result.
1205 * @param state The pinned state.
1207 FIRM_API ir_node *new_rd_DivRL(dbg_info *db, ir_node *block, ir_node *memop,
1208 ir_node *op1, ir_node *op2, ir_mode *mode,
1209 op_pin_state state);
1211 /** Constructor for a strictConv node.
1213 * @param *db A pointer for debug information.
1214 * @param *block The IR block the node belongs to.
1215 * @param *op The operand.
1216 * @param *mode The mode of this the operand muss be converted .
1218 FIRM_API ir_node *new_rd_strictConv(dbg_info *db, ir_node *block,
1219 ir_node *op, ir_mode *mode);
1221 /** Constructor for a defaultProj node.
1223 * Represents the default control flow of a Switch-Cond node.
1225 * @param *db A pointer for debug information.
1226 * @param arg A node producing a tuple.
1227 * @param max_proj The end position of the value in the tuple.
1229 FIRM_API ir_node *new_rd_defaultProj(dbg_info *db, ir_node *arg, long max_proj);
1231 /** Constructor for an ASM pseudo node.
1233 * @param *db A pointer for debug information.
1234 * @param *block The block the node belong to.
1235 * @param arity The number of data inputs to the node.
1236 * @param *in The array of length arity of data inputs.
1237 * @param *inputs The array of length arity of input constraints.
1238 * @param n_outs The number of data outputs to the node.
1239 * @param *outputs The array of length n_outs of output constraints.
1240 * @param n_clobber The number of clobbered registers.
1241 * @param *clobber The array of length n_clobber of clobbered registers.
1242 * @param *asm_text The assembler text.
1244 FIRM_API ir_node *new_rd_ASM(dbg_info *db, ir_node *block,
1245 int arity, ir_node *in[], ir_asm_constraint *inputs,
1246 size_t n_outs, ir_asm_constraint *outputs,
1247 size_t n_clobber, ident *clobber[],
1250 /*-------------------------------------------------------------------------*/
1251 /* The raw interface without debug support */
1252 /*-------------------------------------------------------------------------*/
1254 /** Constructor for a Const node.
1256 * Adds the node to the start block.
1258 * Constructor for a Const node. The constant represents a target
1259 * value. Sets the type information to type_unknown. (No more
1260 * supported: If tv is entity derives a somehow useful type.)
1262 * @param *irg The IR graph the node belongs to.
1263 * @param *mode The mode of the operands and the results.
1264 * @param value A value from which the tarval is made.
1266 FIRM_API ir_node *new_r_Const_long(ir_graph *irg, ir_mode *mode, long value);
1268 /** Constructor for a SymConst node.
1270 * This is the constructor for a symbolic constant.
1271 * There are several kinds of symbolic constants:
1272 * - symconst_type_size The symbolic constant represents the size of a type.
1273 * The type of which the constant represents the size
1274 * is given explicitly.
1275 * - symconst_type_align The symbolic constant represents the alignment of a
1276 * type. The type of which the constant represents the
1277 * size is given explicitly.
1278 * - symconst_addr_ent The symbolic constant represents the address of an
1279 * entity (variable or method). The variable is given
1280 * explicitly by a firm entity.
1281 * - symconst_ofs_ent The symbolic constant represents the offset of an
1282 * entity in its owner type.
1283 * - symconst_enum_const The symbolic constant is a enumeration constant of
1284 * an enumeration type.
1286 * Inputs to the node:
1287 * No inputs except the block it belongs to.
1288 * Outputs of the node.
1289 * An unsigned integer (I_u) or a pointer (P).
1291 * Mention union in declaration so that the firmjni generator recognizes that
1292 * it can not cast the argument to an int.
1294 * @param *irg The IR graph the node belongs to.
1295 * @param mode The mode for the SymConst.
1296 * @param value A type, ident, entity or enum constant depending on the
1298 * @param kind The kind of the symbolic constant, see the list above
1300 FIRM_API ir_node *new_r_SymConst(ir_graph *irg, ir_mode *mode,
1301 union symconst_symbol value,
1302 symconst_kind kind);
1304 /** Constructor for a simpleSel node.
1306 * This is a shortcut for the new_d_Sel() constructor. To be used for
1307 * Sel nodes that do not select from an array, i.e., have no index
1308 * inputs. It adds the two parameters 0, NULL.
1310 * @param *block The IR block the node belongs to.
1311 * @param *store The memory in which the object the entity should be selected
1312 * from is allocated.
1313 * @param *objptr The object from that the Sel operation selects a
1314 * single attribute out.
1315 * @param *ent The entity to select.
1317 FIRM_API ir_node *new_r_simpleSel(ir_node *block, ir_node *store,
1318 ir_node *objptr, ir_entity *ent);
1320 /** Constructor for a remainderless Div node.
1322 * @param *block The IR block the node belongs to.
1323 * @param *memop The store needed to model exceptions
1324 * @param *op1 The first operand.
1325 * @param *op2 The second operand.
1326 * @param *mode The mode of the result.
1327 * @param state The pinned state.
1329 FIRM_API ir_node *new_r_DivRL(ir_node *block, ir_node *memop,
1330 ir_node *op1, ir_node *op2, ir_mode *mode,
1331 op_pin_state state);
1332 /** Constructor for a strict Conv node.
1334 * @param *block The IR block the node belongs to.
1335 * @param *op The operand.
1336 * @param *mode The mode of this the operand muss be converted .
1338 FIRM_API ir_node *new_r_strictConv(ir_node *block, ir_node *op, ir_mode *mode);
1340 /** Constructor for a defaultProj node.
1342 * Represents the default control flow of a Switch-Cond node.
1344 * @param arg A node producing a tuple.
1345 * @param max_proj The end position of the value in the tuple.
1347 FIRM_API ir_node *new_r_defaultProj(ir_node *arg, long max_proj);
1349 /** Constructor for an ASM pseudo node.
1351 * @param *block The block the node belong to.
1352 * @param arity The number of data inputs to the node.
1353 * @param *in The array of length arity of data inputs.
1354 * @param *inputs The array of length arity of input constraints.
1355 * @param n_outs The number of data outputs to the node.
1356 * @param *outputs The array of length n_outs of output constraints.
1357 * @param n_clobber The number of clobbered registers.
1358 * @param *clobber The array of length n_clobber of clobbered registers.
1359 * @param *asm_text The assembler text.
1361 FIRM_API ir_node *new_r_ASM(ir_node *block,
1362 int arity, ir_node *in[], ir_asm_constraint *inputs,
1363 size_t n_outs, ir_asm_constraint *outputs,
1364 size_t n_clobber, ident *clobber[],
1367 /*-----------------------------------------------------------------------*/
1368 /* The block oriented interface */
1369 /*-----------------------------------------------------------------------*/
1371 /** Sets the current block in which the following constructors place the
1372 * nodes they construct.
1374 * @param target The new current block.
1376 FIRM_API void set_cur_block(ir_node *target);
1377 FIRM_API void set_r_cur_block(ir_graph *irg, ir_node *target);
1379 /** Returns the current block of the current graph. */
1380 FIRM_API ir_node *get_cur_block(void);
1381 FIRM_API ir_node *get_r_cur_block(ir_graph *irg);
1384 * @see new_rd_Const_long()
1386 * @param *db A pointer for debug information.
1387 * @param *mode The mode of the operands and results.
1388 * @param value A value from which the tarval is made.
1390 FIRM_API ir_node *new_d_Const_long(dbg_info *db, ir_mode *mode, long value);
1392 /** Constructor for a SymConst node.
1394 * This is the constructor for a symbolic constant.
1395 * There are several kinds of symbolic constants:
1396 * - symconst_type_size The symbolic constant represents the size of a type.
1397 * The type of which the constant represents the size
1398 * is given explicitly.
1399 * - symconst_type_align The symbolic constant represents the alignment of a
1400 * type. The type of which the constant represents the
1401 * size is given explicitly.
1402 * - symconst_addr_ent The symbolic constant represents the address of an
1403 * entity (variable or method). The variable is given
1404 * explicitly by a firm entity.
1405 * - symconst_ofs_ent The symbolic constant represents the offset of an
1406 * entity in its owner type.
1407 * - symconst_enum_const The symbolic constant is a enumeration constant of
1408 * an enumeration type.
1410 * Inputs to the node:
1411 * No inputs except the block it belongs to.
1412 * Outputs of the node.
1413 * An unsigned integer (I_u) or a pointer (P).
1415 * Mention union in declaration so that the firmjni generator recognizes that
1416 * it can not cast the argument to an int.
1418 * @param *db A pointer for debug information.
1419 * @param mode The mode for the SymConst.
1420 * @param value A type, ident, entity or enum constant depending on the
1422 * @param kind The kind of the symbolic constant, see the list above
1424 FIRM_API ir_node *new_d_SymConst(dbg_info *db, ir_mode *mode,
1425 union symconst_symbol value,
1426 symconst_kind kind);
1428 /** Constructor for a simpleSel node.
1430 * This is a shortcut for the new_d_Sel() constructor. To be used for
1431 * Sel nodes that do not select from an array, i.e., have no index
1432 * inputs. It adds the two parameters 0, NULL.
1434 * @param *db A pointer for debug information.
1435 * @param *store The memory in which the object the entity should be
1436 * selected from is allocated.
1437 * @param *objptr The object from that the Sel operation selects a
1438 * single attribute out.
1439 * @param *ent The entity to select.
1441 FIRM_API ir_node *new_d_simpleSel(dbg_info *db, ir_node *store, ir_node *objptr,
1443 /** Constructor for a remainderless Div node.
1445 * Adds the node to the block in current_ir_block.
1447 * @param *db A pointer for debug information.
1448 * @param *memop The store needed to model exceptions
1449 * @param *op1 The first operand.
1450 * @param *op2 The second operand.
1451 * @param *mode The mode of the result.
1452 * @param state The pinned state.
1454 FIRM_API ir_node *new_d_DivRL(dbg_info *db, ir_node *memop,
1455 ir_node *op1, ir_node *op2, ir_mode *mode,
1456 op_pin_state state);
1457 /** Constructor for a strict Conv node.
1459 * Adds the node to the block in current_ir_block.
1461 * @param *db A pointer for debug information.
1462 * @param *op The operand.
1463 * @param *mode The mode of this the operand muss be converted .
1465 FIRM_API ir_node *new_d_strictConv(dbg_info *db, ir_node *op, ir_mode *mode);
1467 /** Constructor for a defaultProj node.
1469 * Represents the default control flow of a Switch-Cond node.
1470 * Adds the node to the block in current_ir_block.
1472 * @param *db A pointer for debug information.
1473 * @param arg A node producing a tuple.
1474 * @param max_proj The end position of the value in the tuple.
1476 FIRM_API ir_node *new_d_defaultProj(dbg_info *db, ir_node *arg, long max_proj);
1478 /** Constructor for an ASM pseudo node.
1480 * @param *db A pointer for debug information.
1481 * @param arity The number of data inputs to the node.
1482 * @param *in The array of length arity of data inputs.
1483 * @param *inputs The array of length arity of input constraints.
1484 * @param n_outs The number of data outputs to the node.
1485 * @param *outputs The array of length n_outs of output constraints.
1486 * @param n_clobber The number of clobbered registers.
1487 * @param *clobber The array of length n_clobber of clobbered registers.
1488 * @param *asm_text The assembler text.
1490 FIRM_API ir_node *new_d_ASM(dbg_info *db, int arity, ir_node *in[],
1491 ir_asm_constraint *inputs,
1492 size_t n_outs, ir_asm_constraint *outputs,
1493 size_t n_clobber, ident *clobber[],
1496 /*-----------------------------------------------------------------------*/
1497 /* The block oriented interface without debug support */
1498 /*-----------------------------------------------------------------------*/
1501 * Make a const from a long.
1502 * This is just convenience for the usual
1504 * new_Const(mode, tarval_from_long(mode, ...))
1507 * @param mode The mode for the const.
1508 * @param value The value of the constant.
1509 * @return A new const node.
1511 FIRM_API ir_node *new_Const_long(ir_mode *mode, long value);
1513 /** Constructor for a SymConst node.
1515 * This is the constructor for a symbolic constant.
1516 * There are several kinds of symbolic constants:
1517 * - symconst_type_size The symbolic constant represents the size of a type.
1518 * The type of which the constant represents the size
1519 * is given explicitly.
1520 * - symconst_type_align The symbolic constant represents the alignment of a
1521 * type. The type of which the constant represents the
1522 * size is given explicitly.
1523 * - symconst_addr_ent The symbolic constant represents the address of an
1524 * entity (variable or method). The variable is given
1525 * explicitly by a firm entity.
1526 * - symconst_ofs_ent The symbolic constant represents the offset of an
1527 * entity in its owner type.
1528 * - symconst_enum_const The symbolic constant is a enumeration constant of
1529 * an enumeration type.
1531 * Inputs to the node:
1532 * No inputs except the block it belongs to.
1533 * Outputs of the node.
1534 * An unsigned integer (I_u) or a pointer (P).
1536 * Mention union in declaration so that the firmjni generator recognizes that
1537 * it can not cast the argument to an int.
1539 * @param mode The mode for the SymConst.
1540 * @param value A type, ident, entity or enum constant depending on the
1542 * @param kind The kind of the symbolic constant, see the list above
1544 FIRM_API ir_node *new_SymConst(ir_mode *mode, union symconst_symbol value,
1545 symconst_kind kind);
1547 /** Constructor for a simpelSel node.
1549 * This is a shortcut for the new_Sel() constructor. To be used for
1550 * Sel nodes that do not select from an array, i.e., have no index
1551 * inputs. It adds the two parameters 0, NULL.
1553 * @param *store The memory in which the object the entity should be selected from is allocated.
1554 * @param *objptr The object from that the Sel operation selects a single attribute out.
1555 * @param *ent The entity to select.
1557 FIRM_API ir_node *new_simpleSel(ir_node *store, ir_node *objptr,
1560 /** Constructor for a remainderless Div node.
1562 * Adds the node to the block in current_ir_block.
1564 * @param *memop The store needed to model exceptions
1565 * @param *op1 The first operand.
1566 * @param *op2 The second operand.
1567 * @param *mode The mode of the result.
1568 * @param state The pinned state.
1570 FIRM_API ir_node *new_DivRL(ir_node *memop, ir_node *op1, ir_node *op2,
1571 ir_mode *mode, op_pin_state state);
1573 /** Constructor for a strict Conv node.
1575 * Adds the node to the block in current_ir_block.
1577 * @param *op The operand.
1578 * @param *mode The mode of this the operand muss be converted.
1580 FIRM_API ir_node *new_strictConv(ir_node *op, ir_mode *mode);
1582 /** Constructor for a defaultProj node.
1584 * Represents the default control flow of a Switch-Cond node.
1585 * Adds the node to the block in current_ir_block.
1587 * @param arg A node producing a tuple.
1588 * @param max_proj The end position of the value in the tuple.
1590 FIRM_API ir_node *new_defaultProj(ir_node *arg, long max_proj);
1592 /** Constructor for an ASM pseudo node.
1594 * @param arity The number of data inputs to the node.
1595 * @param *in The array of length arity of data inputs.
1596 * @param *inputs The array of length arity of input constraints.
1597 * @param n_outs The number of data outputs to the node.
1598 * @param *outputs The array of length n_outs of output constraints.
1599 * @param n_clobber The number of clobbered registers.
1600 * @param *clobber The array of length n_clobber of clobbered registers.
1601 * @param *asm_text The assembler text.
1603 FIRM_API ir_node *new_ASM(int arity, ir_node *in[], ir_asm_constraint *inputs,
1604 size_t n_outs, ir_asm_constraint *outputs,
1605 size_t n_clobber, ident *clobber[], ident *asm_text);
1607 /*---------------------------------------------------------------------*/
1608 /* The comfortable interface. */
1609 /* Supports automatic Phi node construction. */
1610 /* All routines of the block oriented interface except new_Block are */
1612 /*---------------------------------------------------------------------*/
1614 /** Create an immature Block.
1616 * An immature Block has an unknown number of predecessors. Predecessors
1617 * can be added with add_immBlock_pred(). Once all predecessors are
1618 * added the block must be matured.
1620 * Adds the block to the graph in current_ir_graph. Can be used with automatic
1621 * Phi node construction.
1622 * This constructor can only be used if the graph is in state_building.
1624 FIRM_API ir_node *new_d_immBlock(dbg_info *db);
1625 FIRM_API ir_node *new_immBlock(void);
1626 FIRM_API ir_node *new_r_immBlock(ir_graph *irg);
1627 FIRM_API ir_node *new_rd_immBlock(dbg_info *db, ir_graph *irg);
1629 /** Add a control flow edge to an immature block. */
1630 FIRM_API void add_immBlock_pred(ir_node *immblock, ir_node *jmp);
1632 /** Finalize a Block node, when all control flows are known. */
1633 FIRM_API void mature_immBlock(ir_node *block);
1635 /** Get the current value of a local variable.
1637 * Use this function to obtain the last definition of the local variable
1638 * associated with pos. Pos may not exceed the value passed as n_loc
1639 * to new_ir_graph. This call automatically inserts Phi nodes.
1641 * @param pos The position/id of the local variable.
1642 * @param *mode The mode of the value to get.
1644 FIRM_API ir_node *get_value(int pos, ir_mode *mode);
1645 FIRM_API ir_node *get_r_value(ir_graph *irg, int pos, ir_mode *mode);
1648 * Try to guess the mode of a local variable.
1649 * This is done by recursively going up the control flow graph until
1650 * we find a definition for the variable. The mode of the first found
1651 * definition is returned. NULL in case no definition is found.
1653 * @param pos The position/id of the local variable.
1655 FIRM_API ir_mode *ir_guess_mode(int pos);
1656 FIRM_API ir_mode *ir_r_guess_mode(ir_graph *irg, int pos);
1658 /** Remark a new definition of a variable.
1660 * Use this function to remember a new definition of the value
1661 * associated with pos. Pos may not exceed the value passed as n_loc
1662 * to new_ir_graph. This call is needed to automatically inserts Phi
1665 * @param pos The position/id of the local variable.
1666 * @param *value The new value written to the local variable.
1668 FIRM_API void set_value(int pos, ir_node *value);
1669 FIRM_API void set_r_value(ir_graph *irg, int pos, ir_node *value);
1672 * Find the value number for a node in the current block.
1674 * @param value the searched value
1676 * @return the value number of the value or -1 if this value has
1677 * no value number in the current block.
1679 FIRM_API int find_value(ir_node *value);
1680 FIRM_API int r_find_value(ir_graph *irg, ir_node *value);
1682 /** Get the current memory state.
1684 * Use this function to obtain the last definition of the memory
1685 * state. This call automatically inserts Phi nodes for the memory
1688 FIRM_API ir_node *get_store(void);
1689 FIRM_API ir_node *get_r_store(ir_graph *irg);
1691 /** Remark a new definition of the memory state.
1693 * Use this function to remember a new definition of the memory state.
1694 * This call is needed to automatically inserts Phi nodes.
1696 * @param *store The new memory state.
1698 FIRM_API void set_store(ir_node *store);
1699 FIRM_API void set_r_store(ir_graph *irg, ir_node *store);
1701 /** keep this node alive even if End is not control-reachable from it
1703 * @param ka The node to keep alive.
1705 FIRM_API void keep_alive(ir_node *ka);
1707 /* --- initialize and finalize IR construction --- */
1709 /** Puts the graph into state "phase_high" */
1710 FIRM_API void irg_finalize_cons(ir_graph *irg);
1712 /** Puts the program and all graphs into state phase_high.
1714 * This also remarks, the construction of types is finished,
1715 * e.g., that no more subtypes will be added. */
1716 FIRM_API void irp_finalize_cons(void);
1718 FIRM_API void ir_set_uninitialized_local_variable_func(
1719 uninitialized_local_variable_func_t *func);
projects / libfirm / blob