3 * File name: ir/ir/ircons.h
4 * Purpose: Various irnode constructors. Automatic construction
5 * of SSA representation.
6 * Author: Martin Trapp, Christian Schaefer
7 * Modified by: Goetz Lindenmaier, Boris Boesler
10 * Copyright: (c) 1998-2003 Universität Karlsruhe
11 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
17 -# Handle construction of exceptions more comfortable:
18 Add new constructors that pass the exception region (or better the
19 Phi for the memories, the ex. region can be found from there) as parameter,
20 constructor then adds all Proj nodes and returns the pointer
21 to the Proj node that selects the result of the arithmetic operation.
22 -# Maybe hide the exception region in a global variable, especially if
23 it is always unambiguous.
29 * documentation no more supported since 2001
31 * ir node construction.
33 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier
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.
48 * This struct contains all information about a procedure.
49 * It's allocated directly to memory.
51 * The fields of ir_graph:
53 * *ent The entity describing this procedure.
55 * The beginning and end of a graph:
57 * *start_block This ir_node is the block that contains the unique
58 * start node of the procedure. With it it contains
59 * the Proj's on starts results.
60 * Further all Const nodes are placed in the start block.
61 * *start This ir_node is the unique start node of the procedure.
63 * *end_block This ir_node is the block that contains the unique
64 * end node of the procedure. This block contains no
66 * *end This ir_node is the unique end node of the procedure.
68 * The following nodes are Projs from the start node, held in ir_graph for
71 * *frame The ir_node producing the pointer to the stack frame of
72 * the procedure as output. This is the Proj node on the
73 * third output of the start node. This output of the start
74 * node is tagged as pns_frame_base. In FIRM most lokal
75 * variables are modeled as data flow edges. Static
76 * allocated arrays can not be represented as dataflow
77 * edges. Therefore FIRM has to represent them in the stack
80 * *globals This models a pointer to a space in the memory where
81 * _all_ global things are held. Select from this pointer
82 * with a Sel node the pointer to a global variable /
83 * procedure / compiler known function... .
85 * *args The ir_node that produces the arguments of the method as
86 * it's result. This is a Proj node on the fourth output of
87 * the start node. This output is tagged as pns_args.
89 * *bad The bad node is an auxiliary node. It is needed only once,
90 * so there is this globally reachable node.
92 * Datastructures that are private to a graph:
94 * *obst An obstack that contains all nodes.
96 * *current_block A pointer to the current block. Any node created with
97 * one of the node constructors (new_<opcode>) are assigned
98 * to this block. It can be set with switch_block(block).
99 * Only needed for ir construction.
101 * params/n_loc An int giving the number of local variables in this
102 * procedure. This is neede for ir construction. Name will
105 * *value_table This hash table (pset) is used for global value numbering
106 * for optimizing use in iropt.c.
108 * *Phi_in_stack; a stack needed for automatic Phi construction, needed only
109 * during ir construction.
111 * visited A int used as flag to traverse the ir_graph.
113 * block_visited A int used as a flag to traverse block nodes in the graph.
115 * Three kinds of nodes
116 * --------------------
118 * There are three kinds of nodes known to the ir: entities,
119 * types, and ir_nodes
121 * + ir_nodes are the actual nodes of the FIRM intermediate representation.
122 * They represent operations on the data of the program and control flow
125 * + entity ==> implemented in entity.h
126 * Refers to a single entity of the compiled program, e.g. a field of a
127 * class or a method. If a method or variable can not be assigned to
128 * a method or class or the like, it is a global object.
130 * + types ==> implemented in type.h
131 * With types type information is represented. There are several type
134 * Implementation of the FIRM operations: ir_node
135 * ----------------------------------------------
137 * Ir_nodes represent operations on the data of the program and control flow
138 * operations. Examples of ir_nodes: Add, Jmp, Cmp
140 * FIRM is a dataflow graph. A dataflow graph is a directed graph,
141 * so that every node has incoming and outgoing edges. A node is
142 * executable if every input at it's incoming edges is available.
143 * Execution of the dataflow graph is started at the Start node which
144 * has no incoming edges and ends when the End node executes, even if
145 * there are still executable or not executed nodes. (Is this true,
146 * or must all executable nodes be executed?) (There are exceptions
147 * to the dataflow paradigma that all inputs have to be available
148 * before a node can execute: Phi, Block. See UKA Techreport
151 * The implementation of FIRM differs from the view as a dataflow
152 * graph. To allow fast traversion of the graph edges are
153 * implemented as C-pointers. Inputs to nodes are not ambiguous, the
154 * results can be used by several other nodes. Each input can be
155 * implemented as a single pointer to a predecessor node, outputs
156 * need to be lists of pointers to successors. Therefore a node
157 * contains pointers to it's predecessor so that the implementation is a
158 * dataflow graph with reversed edges. It has to be traversed bottom
161 * All nodes of the ir have the same basic structure. They are
162 * distinguished by a field containing the opcode.
164 * The fields of an ir_node:
166 * kind A firm_kind tag containing k_ir_node. This is useful for
167 * dynamically checking the type of a node.
169 * *op This ir_op gives the opcode as a tag and a string
170 * and the number of attributes of an ir_node. There is
171 * one statically allocated struct ir_op for each opcode.
173 * *mode The ir_mode of the operation represented by this firm
174 * node. The mode of the operation is the mode of it's
175 * result. A Firm mode is a datatype as known to the target,
176 * not a type of the source language.
178 * visit A flag for traversing the ir.
180 * **in An array with pointers to the node's predecessors.
182 * *link A pointer to an ir_node. With this pointer all Phi nodes
183 * are attached to a Block, i.e., a Block points to it's
184 * first Phi node, this node points to the second Phi node
185 * in the Block and so fourth. Used in mature_block
186 * to find all Phi nodes to be matured. It's also used to
187 * annotate a node with a better, optimized version of it.
189 * attr An attr struct containing the attributes of the nodes. The
190 * attributes depend on the opcode of the node. The number
191 * of these attributes is given in op.
195 * Not yet documented. See irop.h.
199 * Not yet documented. See irmode.h.
201 * GLOBAL VARIABLES -- now also fields of ir_graph.
204 * current_ir_graph Points to the current ir_graph. All constructors for
205 * nodes add nodes to this graph.
207 * ir_visited An int used as flag to traverse the ir_graph.
209 * block_visited An int used as a flag to traverse block nodes in the
212 * Others not yet documented.
216 * CONSTRUCTOR FOR IR_GRAPH --> see irgraph.h
217 * ========================
220 * PROCEDURE TO CONSTRUCT AN IR GRAPH --> see also Firm tutorial
221 * ==================================
223 * This library supplies several interfaces to construct a FIRM graph for
225 * * A "comfortable" interface generating SSA automatically. Automatically
226 * computed predecessors of nodes need not be specified in the constructors.
227 * (new_<Node> constructurs and a set of additional routines.)
228 * * A less comfortable interface where all predecessors except the block
229 * an operation belongs to need to be specified. SSA must be constructed
230 * by hand. (new_<Node> constructors and switch_block()). This interface
231 * is called "block oriented". It automatically calles the local optimizations
233 * * An even less comfortable interface where the block needs to be specified
234 * explicitly. This is called the "raw" interface. (new_r_<Node>
235 * constructors). These nodes are not optimized.
237 * To use the functionality of the comfortable interface correctly the Front
238 * End needs to follow certain protocols. This is explained in the following.
239 * To build a correct IR with the other interfaces study the semantics of
240 * the firm node (See tech-reprot UKA 1999-14). For the construction of
241 * types and entities see the documentation in those modules.
243 * First the Frontend needs to decide which variables and values used in
244 * a procedure can be represented by dataflow edges. These are variables
245 * that need not be saved to memory as they cause no side effects visible
246 * out of the procedure. Often these are all compiler generated
247 * variables and simple local variables of the procedure as integers,
248 * reals and pointers. The frontend has to count and number these variables.
250 * First an ir_graph needs to be constructed with new_ir_graph. The
251 * constructor gets the number of local variables. The graph is hold in the
252 * global variable irg.
254 * Now the construction of the procedure can start. Several basic blocks can
255 * be constructed in parallel, but the code within each block needs to
256 * be constructed (almost) in program order.
258 * A global variable holds the current basic block. All (non block) nodes
259 * generated are added to this block. The current block can be set with
260 * switch_block(block). If several blocks are constructed in parallel block
261 * switches need to be performed constantly.
263 * To generate a Block node (with the comfortable interface) it's predecessor
264 * control flow nodes need not be known. In case of cyclic control flow these
265 * can not be known when the block is constructed. With add_in_edge(block,
266 * cfnode) predecessors can be added to the block. If all predecessors are
267 * added to the block mature_block(b) needs to be called. Calling mature_block
268 * early improves the efficiency of the Phi node construction algorithm.
269 * But if several blocks are constructed at once, mature_block must only
270 * be called after performing all set_values and set_stores in the block!
271 * (See documentation of new_immBlock constructor.)
273 * The constructors of arithmetic nodes require that their predecessors
274 * are mentioned. Sometimes these are available in the Frontend as the
275 * predecessors have just been generated by the frontend. If they are local
276 * values the predecessors can be obtained from the library with a call to
277 * get_value(local_val_nr). (local_val_nr needs to be administered by
278 * the Frontend.) A call to get_value triggers the generation of Phi nodes.
279 * If an arithmetic operation produces a local value this value needs to be
280 * passed to the library by set_value(node, local_val_nr).
281 * In straight line code these two operations just remember and return the
282 * pointer to nodes producing the value. If the value passes block boundaries
283 * Phi nodes can be inserted.
284 * Similar routines exist to manage the Memory operands: set_store and
287 * Several nodes produce more than one result. An example is the Div node.
288 * Such nodes return tuples of values. From these individual values can be
289 * extracted by proj nodes.
291 * The following example illustrates the construction of a simple basic block
292 * with two predecessors stored in variables cf_pred1 and cf_pred2, containing
295 * and finally jumping to an other block. The variable a got the local_val_nr
296 * 42 by the frontend.
298 * ir_node *this_block, *cf_pred1, *cf_pred2, *a_val, *mem, *div, *res, *cf_op;
300 * this_block = new_immBlock();
301 * add_in_edge(this_block, cf_pred1);
302 * add_in_edge(this_block, cf_pred2);
303 * mature_block(this_block);
304 * a_val = get_value(42, mode_Iu);
306 * div = new_Div(mem, a_val, a_val);
307 * mem = new_Proj(div, mode_M, 0); * for the numbers for Proj see docu *
308 * res = new_Proj(div, mode_Iu, 2);
310 * set_value(res, 42);
313 * For further information look at the documentation of the nodes and
314 * constructors and at the paragraph COPING WITH DATA OBJECTS at the
315 * end of this documentation.
317 * The comfortable interface contains the following routines further explained
320 * ir_node *new_immBlock (void);
321 * ir_node *new_Start (void);
322 * ir_node *new_End (void);
323 * ir_node *new_Jmp (void);
324 * ir_node *new_Cond (ir_node *c);
325 * ir_node *new_Return (ir_node *store, int arity, ir_node **in);
326 * ir_node *new_Raise (ir_node *store, ir_node *obj);
327 * ir_node *new_Const (ir_mode *mode, tarval *con);
328 * ir_node *new_SymConst (type_or_id_p value, symconst_kind kind);
329 * ir_node *new_simpleSel (ir_node *store, ir_node *objptr, entity *ent);
330 * ir_node *new_Sel (ir_node *store, ir_node *objptr, int arity,
331 * ir_node **in, entity *ent);
332 * ir_node *new_InstOf (ir_node *store, ir_node obj, type *ent);
333 * ir_node *new_Call (ir_node *store, ir_node *callee, int arity,
334 * ir_node **in, type_method *type);
335 * ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode);
336 * ir_node *new_Sub (ir_node *op1, ir_node *op2, ir_mode *mode);
337 * ir_node *new_Minus (ir_node *op, ir_mode *mode);
338 * ir_node *new_Mul (ir_node *op1, ir_node *op2, ir_mode *mode);
339 * ir_node *new_Quot (ir_node *memop, ir_node *op1, ir_node *op2);
340 * ir_node *new_DivMod (ir_node *memop, ir_node *op1, ir_node *op2);
341 * ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2);
342 * ir_node *new_Mod (ir_node *memop, ir_node *op1, ir_node *op2);
343 * ir_node *new_Abs (ir_node *op, ir_mode *mode);
344 * ir_node *new_And (ir_node *op1, ir_node *op2, ir_mode *mode);
345 * ir_node *new_Or (ir_node *op1, ir_node *op2, ir_mode *mode);
346 * ir_node *new_Eor (ir_node *op1, ir_node *op2, ir_mode *mode);
347 * ir_node *new_Not (ir_node *op, ir_mode *mode);
348 * ir_node *new_Shl (ir_node *op, ir_node *k, ir_mode *mode);
349 * ir_node *new_Shr (ir_node *op, ir_node *k, ir_mode *mode);
350 * ir_node *new_Shrs (ir_node *op, ir_node *k, ir_mode *mode);
351 * ir_node *new_Rot (ir_node *op, ir_node *k, ir_mode *mode);
352 * ir_node *new_Cmp (ir_node *op1, ir_node *op2);
353 * ir_node *new_Conv (ir_node *op, ir_mode *mode);
354 * ir_node *new_Cast (ir_node *op, type *to_tp);
355 * ir_node *new_Load (ir_node *store, ir_node *addr);
356 * ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val);
357 * ir_node *new_Alloc (ir_node *store, ir_node *size, type *alloc_type,
358 * where_alloc where);
359 * ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size,
361 * ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj);
363 * ir_node *new_simpleSel(ir_node *store, ir_node *objptr, entity *ent);
364 * ir_node *new_Sel (ir_node *store, ir_node *objptr, int arity,
365 * ir_node **in, entity *ent);
366 * ir_node *new_Call (ir_node *store, ir_node *callee, int arity,
367 * ir_node **in, type_method *type);
368 * ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode);
369 * ir_node *new_Sub (ir_node *op1, ir_node *op2, ir_mode *mode);
370 * ir_node *new_Minus (ir_node *op, ir_mode *mode);
371 * ir_node *new_Mul (ir_node *op1, ir_node *op2, ir_mode *mode);
372 * ir_node *new_Quot (ir_node *memop, ir_node *op1, ir_node *op2);
373 * ir_node *new_DivMod (ir_node *memop, ir_node *op1, ir_node *op2);
374 * ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2);
375 * ir_node *new_Mod (ir_node *memop, ir_node *op1, ir_node *op2);
376 * ir_node *new_Abs (ir_node *op, ir_mode *mode);
377 * ir_node *new_And (ir_node *op1, ir_node *op2, ir_mode *mode);
378 * ir_node *new_Or (ir_node *op1, ir_node *op2, ir_mode *mode);
379 * ir_node *new_Eor (ir_node *op1, ir_node *op2, ir_mode *mode);
380 * ir_node *new_Not (ir_node *op, ir_mode *mode);
381 * ir_node *new_Shl (ir_node *op, ir_node *k, ir_mode *mode);
382 * ir_node *new_Shr (ir_node *op, ir_node *k, ir_mode *mode);
383 * ir_node *new_Shrs (ir_node *op, ir_node *k, ir_mode *mode);
384 * ir_node *new_Rot (ir_node *op, ir_node *k, ir_mode *mode);
385 * ir_node *new_Cmp (ir_node *op1, ir_node *op2);
386 * ir_node *new_Conv (ir_node *op, ir_mode *mode);
387 * ir_node *new_Cast (ir_node *op, type *to_tp);
388 * ir_node *new_Load (ir_node *store, ir_node *addr);
389 * ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val);
390 * ir_node *new_Alloc (ir_node *store, ir_node *size, type *alloc_type,
391 * where_alloc where);
392 * ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size,
394 * ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj);
395 * ir_node *new_FuncCall (ir_node *store, ir_node *callee, int arity,
396 * ir_node **in, type_method *type);
398 * void add_in_edge (ir_node *block, ir_node *jmp);
399 * void mature_block (ir_node *block);
400 * void switch_block (ir_node *target);
401 * ir_node *get_value (int pos, ir_mode *mode);
402 * void set_value (int pos, ir_node *value);
403 * ir_node *get_store (void);
404 * void set_store (ir_node *store);
405 * keep_alive (ir_node ka)
407 * IR_NODES AND CONSTRUCTORS FOR IR_NODES
408 * =======================================
410 * All ir_nodes are defined by a common data structure. They are distinguished
411 * by their opcode and differ in the number of their attributes.
413 * The constructor for the block node sets current_block to itself.
414 * Const nodes are always added to the start block.
415 * All other constructors add the created node to the current_block.
416 * swich_block(block) allows to set the current block to block.
418 * Watch for my inconsistent use of input and predecessor (dataflow view)
419 * and `the node points to' (implementation view).
421 * The following description of the nodes lists four properties them if these
423 * - the parameters to the constructor
424 * - the inputs of the Firm node
425 * - the outputs of the Firm node
426 * - attributes to the node
430 * ir_node *new_immBlock (void)
431 * ----------------------------
433 * Creates a new block. Sets current_block to itself. When a new block is
434 * created it cannot be known how many predecessors this block will have in the
435 * control flow graph. Therefore the list of inputs can not be fixed at
436 * creation. Predecessors can be added with add_in_edge (block, control flow
437 * operation). With every added predecessor the number of inputs to Phi nodes
440 * The block can be completed by mature_block(block) if all predecessors are
441 * known. If several blocks are built at once, mature_block can only be called
442 * after set_value has been called for all values that are life at the end
443 * of the block. This is necessary so that Phi nodes created by mature_block
444 * get the right predecessors in case of cyclic dependencies. If all set_values
445 * of this block are called after maturing it and before calling get_value
446 * in some block that is control flow dependent on this block, the construction
449 * Example for faulty ir construction: (draw the graph on a paper and you'll
452 * block_before_loop = new_block();
454 * mature_block(block_before_loop);
455 * before2header = new_Jmp;
457 * loop_header = new_block ();
458 * header2body - new_Jmp();
460 * loop_body = new_block ();
461 * body2header = new_Jmp();
463 * add_in_edge(loop_header, before2header);
464 * add_in_edge(loop_header, body2header);
465 * add_in_edge(loop_body, header2body);
467 * mature_block(loop_header);
468 * mature_block(loop_body);
470 * get_value(loop_body, x); // gets the Phi in loop_header
471 * set_value(loop_header, x); // sets the value the above get_value should
472 * // have returned!!!
474 * Mature_block also fixes the number of inputs to the Phi nodes. Mature_block
475 * should be called as early as possible, as afterwards the generation of Phi
476 * nodes is more efficient.
479 * There is an input for each control flow predecessor of the block.
480 * The input points to an instruction producing an output of type X.
481 * Possible predecessors: Start, Jmp, Cond, Raise or Return or any node
482 * possibly causing an exception. (Often the real predecessors are Projs.)
484 * Mode BB (R), all nodes belonging to this block should consume this output.
485 * As they are strict (except Block and Phi node) it is a necessary condition
486 * that the block node executed before any other node in this block executes.
488 * block.matured Indicates whether the block is mature.
490 * This attribute contains all local values valid in this
491 * block. This is needed to build the Phi nodes and removed
492 * if the graph is complete. This field is used by the
493 * internal construction algorithm and should not be accessed
497 * ir_node *new_Block (int arity, ir_node **in)
498 * --------------------------------------------
500 * Creates a new Block with the given list of predecessors. This block
501 * is mature. As other constructors calls optimization and vrfy for the
502 * block. If one of the predecessors is Unknown (as it has to be filled in
503 * later) optimizations are skipped. This is necessary to
504 * construct Blocks in loops. Leaving Unknown in the Block after finishing
505 * the construction may have strange effects, especially for interprocedural
506 * representation and analyses.
509 * CONTROL FLOW OPERATIONS
510 * -----------------------
512 * In each block there must be exactly one of the control flow
513 * operations Start, End, Jmp, Cond, Return or Raise. The output of a
514 * control flow operation points to the block to be executed next.
516 * ir_node *new_Start (void)
517 * -------------------------
519 * Creates a start node. Not actually needed public. There is only one such
520 * node in each procedure which is automatically created by new_ir_graph.
523 * No inputs except the block it belogns to.
525 * A tuple of 4 (5, 6) distinct values. These are labeled by the following
526 * projection numbers (pns_number):
528 * mode X, points to the first block to be executed.
530 * mode M, the global store
531 * * pns_frame_base mode P, a pointer to the base of the procedures
533 * * pns_globals mode P, a pointer to the part of the memory containing
534 * _all_ global things.
535 * * pns_args mode T, a tuple containing all arguments of the procedure.
538 * ir_node *new_End (void)
539 * -----------------------
541 * Creates an end node. Not actually needed public. There is only one such
542 * node in each procedure which is automatically created by new_ir_graph.
545 * No inputs except the block it belongs to.
549 * ir_node *new_Jmp (void)
550 * -----------------------
552 * Creates a Jmp node.
555 * The block the node belongs to
557 * Control flow to the next block.
559 * ir_node *new_Cond (ir_node *c)
560 * ------------------------------
562 * Creates a Cond node. There are two versions of this node.
568 * A tuple of two control flows. The first is taken if the input is
569 * false, the second if it is true.
573 * A value of mode I_u. (i)
575 * A tuple of n control flows. If the Cond's input is i, control
576 * flow will procede along output i. If the input is >= n control
577 * flow proceeds along output n.
579 * ir_node *new_Return (ir_node *store, int arity, ir_node **in)
580 * -------------------------------------------------------------
582 * The return node has as inputs the results of the procedure. It
583 * passes the control flow to the end_block.
589 * Control flow to the end block.
591 * ir_node *new_Raise (ir_node *store, ir_node *obj)
592 * -------------------------------------------------
594 * Raises an exception. Unconditional change of control flow. Writes
595 * an explicit Except variable to memory to pass it to the exception
596 * handler. See TechReport 1999-14, chapter Exceptions.
600 * A pointer to the Except variable.
602 * A tuple of control flow and the changed memory state. The control flow
603 * points to the exception handler if it is definied in this procedure,
604 * else it points to the end_block.
609 * ir_node *new_Const (ir_mode *mode, tarval *con)
610 * -----------------------------------------------
612 * Creates a constant in the constant table and adds a Const node
613 * returning this value to the start block.
616 * *mode The mode of the constant.
617 * *con Points to an entry in the constant table.
618 * This pointer is added to the attributes of
619 * the node (self->attr.con)
621 * No inputs except the block it belogns to.
623 * The constant value.
625 * attr.con A tarval* pointer to the proper entry in the constant
628 * ir_node *new_SymConst (type *tp, symconst_addr_ent kind)
629 * ------------------------------------------------------------
631 * There are three kinds of symbolic constants:
632 * symconst_type_tag The symbolic constant represents a type tag.
633 * symconst_size The symbolic constant represents the size of a class.
634 * symconst_addr_name Information for the linker, e.g. the name of a global
636 * To represent a pointer to an entity that is represented by an entity
637 * datastructure don't use
638 * new_SymConst((type_or_id*)get_entity_ld_ident(ent), linkage_ptr_info);.
639 * Use a real const instead:
640 * new_Const(mode_P_mach, tarval_p_from_entity(ent));
641 * This makes the Constant independent of name changes of the entity due to
645 * kind The kind of the symbolic constant: type_tag, size or link_info.
646 * *type_or_id Points to the type the tag stands for or to the type
647 * whose size is represented by the constant or to an ident
648 * representing the linkage info.
651 * No inputs except the block it belogns to.
653 * An unsigned integer (I_u) or a pointer (P).
656 * attr.i.num The symconst_addr_ent, i.e. one of
659 * - symconst_addr_name
660 * If the attr.i.num is symconst_type_tag or symconst_size, the node contains an attribute
661 * attr.i.*type, a pointer to a type_class. The mode of the node is mode_Is.
662 * if it is linkage_ptr_info it contains
663 * attr.i.*ptrinfo, an ident holding information for the linker. The mode
664 * of the node is mode_P_mach.
668 * ir_node *new_simpleSel (ir_node *store, ir_node *frame, entity *sel)
669 * --------------------------------------------------------------------
672 * Selects an entity from a compound type. This entity can be a field or
676 * *store The memory in which the object the entity should be selected
678 * *frame The pointer to the object.
679 * *sel The entity to select.
682 * The memory containing the object.
683 * A pointer to the object.
684 * An unsigned integer.
686 * A pointer to the selected entity.
688 * attr.sel Pointer to the entity
691 * ir_node *new_Sel (ir_node *store, ir_node *frame, int arity, ir_node **in,
692 * --------------------------------------------------------------------------
696 * Selects a field from an array type. The entity has as owner the array, as
697 * type the arrays element type. The indexes to access an array element are
701 * *store The memory in which the object the entity should be selected from
703 * *frame The pointer to the object.
704 * *arity number of array indexes.
705 * *in array with index inputs to the node.
706 * *sel The entity to select.
709 * The memory containing the object.
710 * A pointer to the object.
711 * As much unsigned integer as there are array expressions.
713 * A pointer to the selected entity.
715 * attr.sel Pointer to the entity
717 * The constructors new_Sel and new_simpleSel generate the same ir nodes.
718 * simpleSel just sets the arity of the index inputs to zero.
721 * ARITHMETIC OPERATIONS
722 * ---------------------
724 * ir_node *new_Call (ir_node *store, ir_node *callee, int arity, ir_node **in,
725 * ----------------------------------------------------------------------------
729 * Creates a procedure call.
732 * *store The actual store.
733 * *callee A pointer to the called procedure.
734 * arity The number of procedure parameters.
735 * **in An array with the pointers to the parameters.
736 * The constructor copies this array.
737 * *type Type information of the procedure called.
740 * The store, the callee and the parameters.
742 * A tuple containing the eventually changed store and the procedure
745 * attr.call Contains the type information for the procedure.
747 * ir_node *new_FuncCall (ir_node *callee, int arity, ir_node **in, type_method *type)
748 * -----------------------------------------------------------------------------------
750 * Creates a procedure call to a function WITHOUT memory side effects.
751 * nodes of this kind are floating in contrast to Call nodes.
752 * Further, a procedure call with FuncCall cannot raise an exception!
755 * *callee A pointer to the called procedure.
756 * arity The number of procedure parameters.
757 * **in An array with the pointers to the parameters.
758 * The constructor copies this array.
759 * *type Type information of the procedure called.
762 * The callee and the parameters.
764 * A tuple containing the procedure results.
766 * attr.call Contains the type information for the procedure.
768 * ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode)
769 * ------------------------------------------------------------
773 * ir_node *new_Sub (ir_node *op1, ir_node *op2, ir_mode *mode)
774 * ------------------------------------------------------------
778 * ir_node *new_Minus (ir_node *op, ir_mode *mode)
779 * -----------------------------------------------
781 * Unary Minus operations on floating point values.
783 * ir_node *new_Mul (ir_node *op1, ir_node *op2, ir_mode *mode)
784 * ------------------------------------------------------------
788 * ir_node *new_Quot (ir_node *memop, ir_node *op1, ir_node *op2)
789 * --------------------------------------------------------------
791 * Quot performs exact division of floating point numbers. It's mode
792 * is Tuple, the mode of the result must be annotated to the Proj
793 * that extracts the result of the arithmetic operations.
796 * The store needed to model exceptions and the two operands.
798 * A tuple contaning a memory and a execution for modeling exceptions
799 * and the result of the arithmetic operation.
801 * ir_node *new_DivMod (ir_node *memop, ir_node *op1, ir_node *op2)
802 * ----------------------------------------------------------------
804 * Performs Div and Mod on interger values.
807 * A tuple contaning a memory and a execution for modeling exceptions
808 * and the two result of the arithmetic operations.
810 * ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2)
811 * -------------------------------------------------------------
815 * ir_node *new_Mod (ir_node *memop, ir_node *op1, ir_node *op2)
816 * -------------------------------------------------------------
820 * ir_node *new_Abs (ir_node *op, ir_mode *mode)
821 * ---------------------------------------------
825 * ir_node *new_And (ir_node *op1, ir_node *op2, ir_mode *mode)
826 * ------------------------------------------------------------
830 * ir_node *new_Or (ir_node *op1, ir_node *op2, ir_mode *mode)
831 * -----------------------------------------------------------
835 * ir_node *new_Eor (ir_node *op1, ir_node *op2, ir_mode *mode)
836 * ------------------------------------------------------------
840 * ir_node *new_Not (ir_node *op, ir_mode *mode)
841 * ---------------------------------------------
843 * This node constructs a constant where all bits are set to one
844 * and a Eor of this constant and the operator. This simulates a
847 * ir_node *new_Shl (ir_node *op, ir_node *k, ir_mode *mode)
848 * ---------------------------------------------------------
852 * ir_node *new_Shr (ir_node *op, ir_node *k, ir_mode *mode)
853 * ---------------------------------------------------------
855 * Logic shift right, i.e., zero extended.
858 * ir_node *new_Shrs (ir_node *op, ir_node *k, ir_mode *mode)
859 * ----------------------------------------------------------
861 * Arithmetic shift right, i.e., sign extended.
863 * ir_node *new_Rot (ir_node *op, ir_node *k, ir_mode *mode)
864 * ---------------------------------------------------------
866 * Rotates the operand to the (right??) by k bits.
868 * ir_node *new_Conv (ir_node *op, ir_mode *mode)
869 * ---------------------------------------------
871 * Mode conversion. For allowed conversions see UKA Tech Report
874 * ir_node *new_Cmp (ir_node *op1, ir_node *op2)
875 * ---------------------------------------------
878 * The two values to be compared.
880 * A 16-tuple containing the results of the 16 different comparisons.
881 * The following is a list giving the comparisons and a projection
882 * number (pnc_number) to use in Proj nodes to extract the proper result.
888 * Ge greater of equal
890 * Leg less, equal or greater = ordered
892 * Ue unordered or equal
893 * Ul unordered or less
894 * Ule unordered, less or equal
895 * Ug unordered or greater
896 * Uge unordered, greater or equal
897 * Ne unordered, less or greater = not equal
904 * In general, Phi nodes are automaitcally inserted. In some cases, if
905 * all predecessors of a block are known, an explicit Phi node constructor
906 * is needed. E.g., to construct a FIRM graph for a statement as
907 * a = (b==c) ? 2 : 5;
909 * ir_node *new_Phi (int arity, ir_node **in, ir_mode *mode)
910 * ---------------------------------------------------------
912 * Creates a Phi node. The in's order has to correspond to the order
913 * of in's of current_block. This is not checked by the library!
914 * If one of the predecessors is Unknown (as it has to be filled in
915 * later) optimizations are skipped. This is necessary to
916 * construct Phi nodes in loops. Leaving Unknown in the Phi after finishing
917 * the construction may have strange effects, especially for interprocedural
918 * representation and analyses.
921 * arity number of predecessors
922 * **in array with predecessors
923 * *mode The mode of it's inputs and output.
925 * A Phi node has as many inputs as the block it belongs to.
926 * Each input points to a definition of the same value on a
927 * different path in the control flow.
929 * The definition valid in this block.
932 * OPERATIONS TO MANAGE MEMORY EXPLICITLY
933 * --------------------------------------
935 * ir_node *new_Load (ir_node *store, ir_node *addr)
936 * ----------------------------------------------------------------
938 * The Load operation reads a value from memory.
941 * *store The current memory.
942 * *addr A pointer to the variable to be read in this memory.
945 * The memory and a pointer to a variable in this memory.
947 * A tuple of the memory, a control flow to be taken in case of
948 * an exception and the loaded value.
950 * ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val)
951 * ----------------------------------------------------------------
953 * The Store operation writes a value to a variable in memory.
956 * The memory, a pointer to a variable in this memory and the value
957 * to write to this variable.
959 * A tuple of the changed memory and a control flow to be taken in
960 * case of an exception.
962 * ir_node *new_Alloc (ir_node *store, ir_node *size, type *alloc_type,
963 * --------------------------------------------------------------------
967 * The Alloc node allocates a new variable. It can be specified whether the
968 * variable should be allocated to the stack or to the heap.
971 * *store The memory which shall contain the new variable.
972 * ** *size The number of bytes to allocate. Old. **
973 * *size We decided that the size easily can be derived from the type.
974 * This field is for allocating arrays, i.e., it gives the multiple
975 * of the size of alloc_type to allocate memory for.
976 * *alloc_type The type of the allocated variable.
977 * where Where to allocate the variable, either heap_alloc or stack_alloc.
980 * A memory and an unsigned integer.
982 * A tuple of the changed memory, a control flow to be taken in
983 * case of an exception and the pointer to the new variable.
985 * a.where Indicates where the variable is allocated.
986 * a.*type A pointer to the class the allocated data object
989 * ir_node *new_Free (ir_node *store, ir_node *ptr, type *free_type)
990 * ------------------------------------------------------------------
992 * The Free node frees memory of the given variable.
995 * *store The memory which shall contain the new variable.
996 * *ptr The pointer to the object to free.
997 * *size The number of objects of type free_type to free in a sequence.
998 * *free_type The type of the freed variable.
1001 * A memory, a pointer and an unsigned integer.
1003 * The changed memory.
1005 * f.*type A pointer to the type information of the freed data object.
1009 * ir_node *new_Sync (int arity, ir_node **in)
1010 * -------------------------------------------
1012 * The Sync operation unifies several partial memory blocks. These blocks
1013 * have to be pairwise disjunct or the values in common locations have to
1014 * be identical. This operation allows to specify all operations that eventually
1015 * need several partial memory blocks as input with a single entrance by
1016 * unifying the memories with a preceding Sync operation.
1019 * arity The number of memories to syncronize.
1020 * **in An array of pointers to nodes that produce an output of
1025 * The unified memory.
1028 * SPECIAL OPERATIONS
1029 * ------------------
1031 * ir_node *new_Bad (void)
1032 * -----------------------
1034 * Returns the unique Bad node current_ir_graph->bad.
1035 * This node is used to express results of dead code elimination.
1037 * ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj)
1038 * ----------------------------------------------------------
1040 * Selects one entry of a tuple. This is a hidden `fat edge'.
1043 * *arg A node producing a tuple.
1044 * *mode The mode of the value to project.
1045 * proj The position of the value in the tuple.
1051 * ir_node *new_Tuple (int arity, ir_node **in)
1052 * --------------------------------------------
1054 * Builds a Tuple from single values. This is needed to implement
1055 * optimizations that remove a node that produced a tuple. The node can be
1056 * replaced by the Tuple operation so that the following Proj nodes have not to
1057 * be changed. (They are hard to find due to the implementation with pointers
1058 * in only one direction.) The Tuple node is smaller than any other
1059 * node, so that a node can be changed into a Tuple by just changing it's
1060 * opcode and giving it a new in array.
1063 * arity The number of tuple elements.
1064 * **in An array containing pointers to the nodes producing the
1067 * ir_node *new_Id (ir_node *val, ir_mode *mode)
1068 * ---------------------------------------------
1070 * The single output of the Id operation is it's input. Also needed
1071 * for optimizations.
1074 * COPING WITH DATA OBJECTS
1075 * ========================
1077 * Two kinds of data objects have to be distinguished for generating
1078 * FIRM. First there are local variables other than arrays that are
1079 * known to be alias free. Second there are all other data objects.
1080 * For the first a common SSA representation is built, the second
1081 * are modeled by saving them to memory. The memory is treated as
1082 * a single local variable, the alias problem is hidden in the
1083 * content of this variable.
1085 * All values known in a Block are listed in the block's attribute,
1086 * block.**graph_arr which is used to automatically insert Phi nodes.
1087 * The following two funcions can be used to add a newly computed value
1088 * to the array, or to get the producer of a value, i.e., the current
1091 * inline void set_value (int pos, ir_node *value)
1092 * -----------------------------------------------
1094 * Has to be called for every assignment to a local variable. It
1095 * adds the value to the array of used values at position pos. Pos
1096 * has to be a unique identifier for an entry in the procedure's
1097 * definition table. It can be used to access the value again.
1098 * Requires current_block to be set correctly.
1100 * ir_node *get_value (int pos, ir_mode *mode)
1101 * -------------------------------------------
1103 * Returns the node defining the value referred to by pos. If the
1104 * value is not defined in this block a Phi node is generated and
1105 * all definitions reaching this Phi node are collected. It can
1106 * happen that the algorithm allocates an unnecessary Phi node,
1107 * e.g. if there is only one definition of this value, but this
1108 * definition reaches the currend block on several different
1109 * paths. This Phi node will be eliminated if optimizations are
1110 * turned on right after it's creation.
1111 * Requires current_block to be set correctly.
1113 * There are two special routines for the global store:
1115 * inline void set_store (ir_node *store)
1116 * --------------------------------------
1118 * Adds the store to the array of known values at a reserved
1120 * Requires current_block to be set correctly.
1122 * inline ir_node *get_store (void)
1123 * --------------------------------
1125 * Returns the node defining the actual store.
1126 * Requires current_block to be set correctly.
1129 * inline void keep_alive (ir_node *ka)
1130 * ------------------------------------
1132 * Keep this node alive because it is (might be) not in the control
1133 * flow from Start to End. Adds the node to the list in the end
1142 # include "firm_common.h"
1143 # include "irgraph.h"
1144 # include "irnode.h"
1145 # include "irmode.h"
1146 # include "entity.h"
1149 # include "dbginfo.h"
1151 /*-------------------------------------------------------------------------*/
1152 /* The raw interface */
1153 /*-------------------------------------------------------------------------*/
1155 /** Constructor for a Block node.
1157 * Constructs a mature block with the given predecessors. Use Unknown
1158 * nodes as predecessors to constuct a block if the number of
1159 * predecessors is known, but not the predecessors themselves. This
1160 * constructor does not set current_block. It not be used with
1161 * automatic Phi node construction.
1163 * @param *db A Pointer for debug information.
1164 * @param irg The ir graph the block belongs to.
1165 * @param arity The number of control predecessors.
1166 * @param in[] An array of control predecessors. The length of
1167 * the array must be 'arity'. The constructor copies this array.
1169 ir_node *new_rd_Block (dbg_info *db, ir_graph *irg, int arity, ir_node *in[]);
1171 /** Constructor for a Start node.
1173 * @param *db A pointer for debug information.
1174 * @param *irg The ir graph the node belongs to.
1175 * @param *block The ir block the node belongs to.
1177 ir_node *new_rd_Start (dbg_info *db, ir_graph *irg, ir_node *block);
1179 /** Constructor for a End node.
1181 * @param *db A pointer for debug information.
1182 * @param *irg The ir graph the node belongs to.
1183 * @param *block The ir block the node belongs to.
1185 ir_node *new_rd_End (dbg_info *db, ir_graph *irg, ir_node *block);
1187 /** Constructor for a Jmp node.
1189 * Jmp represents control flow to a single control successor.
1191 * @param *db A pointer for debug information.
1192 * @param *irg The ir graph the node belongs to.
1193 * @param *block The ir block the node belongs to.
1195 ir_node *new_rd_Jmp (dbg_info *db, ir_graph *irg, ir_node *block);
1197 /** Constructor for a Break node.
1199 * Break represents control flow to a single control successor just as Jmp.
1200 * The blocks separated by a break may not be concatenated by an optimization.
1201 * It is used for the interprocedural representation where blocks are parted
1202 * behind Call nodes to represent the control flow to called procedures.
1204 * @param *db A pointer for debug information.
1205 * @param *irg The ir graph the node belong to.
1206 * @param *block The block the node belong to.
1208 ir_node *new_rd_Break (dbg_info *db, ir_graph *irg, ir_node *block);
1210 /** Constructor for a Cond node.
1212 * If c is mode_b represents a conditional branch (if/else). If c is
1213 * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond
1214 * node, default Proj is 0.)
1216 * This is not consistent: Input to Cond is Is, Proj has as proj number
1219 * @param *db A pointer for debug information.
1220 * @param *irg The ir graph the node belongs to.
1221 * @param *block The ir block the node belongs to.
1222 * @param *c The conditions parameter. Can be of mode b or I_u.
1224 ir_node *new_rd_Cond (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *c);
1226 /** Constructor for a Return node.
1228 * Returns the memory an zero or more return values. Only node that
1229 * can end regular control flow.
1231 * @param *db A pointer for debug information.
1232 * @param *irg The ir graph the node belongs to.
1233 * @param *block The ir block the node belongs to.
1234 * @param *store The state of memory.
1235 * @param arity Number of return values.
1236 * @param *in Array of length arity with return values. The constructor copies this array.
1238 ir_node *new_rd_Return (dbg_info *db, ir_graph *irg, ir_node *block,
1239 ir_node *store, int arity, ir_node *in[]);
1241 /** Constructor for a Raise node.
1243 * @param *db A pointer for debug information.
1244 * @param *irg The ir graph the node belongs to.
1245 * @param *block The ir block the node belongs to.
1246 * @param *store The current memory.
1247 * @param *obj A pointer to the Except variable.
1249 ir_node *new_rd_Raise (dbg_info *db, ir_graph *irg, ir_node *block,
1250 ir_node *store, ir_node *obj);
1252 /** Constructor for a Const node.
1254 * The constant represents a target value. This constructor sets high
1255 * level type information for the constant value.
1257 * @param *db A pointer for debug information.
1258 * @param *irg The ir graph the node belongs to.
1259 * @param *block The ir block the node belongs to.
1260 * @param *mode The mode of the operands and redults.
1261 * @param *con Points to an entry in the constant table.
1262 * @param *tp The type of the constant.
1264 ir_node *new_rd_Const_type (dbg_info* db, ir_graph *irg, ir_node *block,
1265 ir_mode *mode, tarval *con, type *tp);
1267 /** Constructor for a Const node.
1269 * Constructor for a Const node. The constant represents a target
1270 * value. Sets the type information to type_unknown. (No more
1271 * supported: If tv is entity derives a somehow useful type.)
1273 * @param *db A pointer for debug information.
1274 * @param *irg The ir graph the node belongs to.
1275 * @param *block The ir block the node belongs to.
1276 * @param *mode The mode of the operands and redults.
1277 * @param *con Points to an entry in the constant table.
1279 ir_node *new_rd_Const (dbg_info *db, ir_graph *irg, ir_node *block,
1280 ir_mode *mode, tarval *con);
1282 /** Constructor for a SymConst node.
1284 * This is the constructor for a symbolic constant.
1285 * There are four kinds of symbolic constants:
1286 * - type_tag The symbolic constant represents a type tag. The type the
1287 * tag stands for is given explicitly.
1288 * - size The symbolic constant represents the size of a type. The
1289 * type of which the constant represents the size is given
1291 * - addr_name The symbolic constant represents the address of an entity
1292 * (variable or method). The variable is indicated by a name
1293 * that is valid for linking.
1294 * - addr_ent The symbolic constant represents the address of an entity
1295 * (variable or method). The variable is given explicitly by
1298 * Inputs to the node:
1299 * No inputs except the block it belongs to.
1300 * Outputs of the node.
1301 * An unsigned integer (I_u) or a pointer (P).
1303 * @param *db A pointer for debug information.
1304 * @param *irg The ir graph the node belongs to.
1305 * @param *block The ir block the node belongs to.
1306 * @param symkind The kind of the symbolic constant: type_tag, size, addr_name or addr_ent.
1307 * @param value A type, entity or a ident depending on the SymConst kind.
1309 ir_node *new_rd_SymConst (dbg_info *db, ir_graph *irg, ir_node *block,
1310 type_or_id_p value, symconst_kind symkind);
1312 /** Constructor for a Sel node.
1314 * The select node selects an entity (field or method) from an entity
1315 * with a compound type. It explicitly specifies the entity selected.
1316 * Dynamically the node may select entities that overwrite the given
1317 * entity. If the selected entity is an array element entity the Sel
1318 * node takes the required array indicees as inputs.
1320 * @param *db A pointer for debug information.
1321 * @param *irg The ir graph the node belongs to.
1322 * @param *block The ir block the node belongs to.
1323 * @param *store The memory in which the object the entity should be selected
1324 * from is allocated.
1325 * @param *objptr A pointer to a compound entity the Sel operation selects a
1326 * single attribute from.
1327 * @param *n_index The number of array indicees needed to select an array element entity.
1328 * @param *index[] If the compound entity is an array the indicees of the selected
1329 * element entity. The constructor copies this array.
1330 * @param *ent The entity to select.
1332 ir_node *new_rd_Sel (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1333 ir_node *objptr, int n_index, ir_node *index[], entity *ent);
1335 /** Constructor for a InstOf node.
1337 * For translating Java. Not supported as standard firm node.
1339 * @param *db A pointer for debug information.
1340 * @param *irg The ir graph the node belongs to.
1341 * @param *block The ir block the node belongs to.
1346 ir_node *new_rd_InstOf (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store, ir_node *objptr, type *ent);
1348 /** Constructor for a Call node.
1350 * Represents all kinds of method and function calls.
1352 * @param *db A pointer for debug information.
1353 * @param *irg The ir graph the node belongs to.
1354 * @param *block The ir block the node belongs to.
1355 * @param *store The current memory state.
1356 * @param *callee A pointer to the called procedure.
1357 * @param arity The number of procedure parameters.
1358 * @param *in[] An array with the procedure parameters. The constructor copies this array.
1359 * @param *tp Type information of the procedure called.
1361 ir_node *new_rd_Call (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1362 ir_node *callee, int arity, ir_node *in[], type *tp);
1364 /** Constructor for a FuncCall node.
1366 * FuncCall is a function Call that has no side effects. Therefore there
1367 * is not memory operand or result.
1369 * @param *db A pointer for debug information.
1370 * @param *irg The ir graph the node belong to.
1371 * @param *block The block the node belong to.
1372 * @param *callee A pointer to the called procedure.
1373 * @param arity The number of procedure parameters.
1374 * @param *in[] An array with the pointers to the parameters. The constructor
1375 * copies this array. The constructor copies this array.
1376 * @param *tp Type information of the procedure called.
1378 ir_node *new_rd_FuncCall (dbg_info *db, ir_graph *irg, ir_node *block,
1379 ir_node *callee, int arity, ir_node *in[],
1382 /** Constructor for a Add node.
1384 * @param *db A pointer for debug information.
1385 * @param *irg The ir graph the node belongs to.
1386 * @param *block The ir block the node belongs to.
1387 * @param *op1 The operand 1.
1388 * @param *op2 The operand 2.
1389 * @param *mode The mode of the operands and the result.
1391 ir_node *new_rd_Add (dbg_info *db, ir_graph *irg, ir_node *block,
1392 ir_node *op1, ir_node *op2, ir_mode *mode);
1394 /** Constructor for a Sub node.
1396 * @param *db A pointer for debug information.
1397 * @param *irg The ir graph the node belongs to.
1398 * @param *block The ir block the node belongs to.
1399 * @param *op1 The operand 1.
1400 * @param *op2 The operand 2.
1401 * @param *mode The mode of the operands and the result.
1403 ir_node *new_rd_Sub (dbg_info *db, ir_graph *irg, ir_node *block,
1404 ir_node *op1, ir_node *op2, ir_mode *mode);
1406 /** Constructor for a Minus node.
1408 * @param *db A pointer for debug information.
1409 * @param *irg The ir graph the node belongs to.
1410 * @param *block The ir block the node belongs to.
1411 * @param *op The operand .
1412 * @param *mode The mode of the operand and the result.
1414 ir_node *new_rd_Minus (dbg_info *db, ir_graph *irg, ir_node *block,
1415 ir_node *op, ir_mode *mode);
1417 /** Constructor for a Mul node.
1419 * @param *db A pointer for debug information.
1420 * @param *irg The ir graph the node belongs to.
1421 * @param *block The ir block the node belongs to.
1422 * @param *op1 The operand 1.
1423 * @param *op2 The operand 2.
1424 * @param *mode The mode of the operands and the result.
1426 ir_node *new_rd_Mul (dbg_info *db, ir_graph *irg, ir_node *block,
1427 ir_node *op1, ir_node *op2, ir_mode *mode);
1429 /** Constructor for a Quot node.
1431 * @param *db A pointer for debug information.
1432 * @param *irg The ir graph the node belongs to.
1433 * @param *block The ir block the node belongs to.
1434 * @param *memop The store needed to model exceptions
1435 * @param *op1 The operand 1.
1436 * @param *op2 The operand 2.
1438 ir_node *new_rd_Quot (dbg_info *db, ir_graph *irg, ir_node *block,
1439 ir_node *memop, ir_node *op1, ir_node *op2);
1441 /** Constructor for a DivMod node.
1443 * @param *db A pointer for debug information.
1444 * @param *irg The ir graph the node belongs to.
1445 * @param *block The ir block the node belongs to.
1446 * @param *memop The store needed to model exceptions
1447 * @param *op1 The operand 1.
1448 * @param *op2 The operand 2.
1450 ir_node *new_rd_DivMod (dbg_info *db, ir_graph *irg, ir_node *block,
1451 ir_node *memop, ir_node *op1, ir_node *op2);
1453 /** Constructor for a Div node.
1455 * @param *db A pointer for debug information.
1456 * @param *irg The ir graph the node belongs to.
1457 * @param *block The ir block the node belongs to.
1458 * @param *memop The store needed to model exceptions
1459 * @param *op1 The operand 1.
1460 * @param *op2 The operand 2.
1462 ir_node *new_rd_Div (dbg_info *db, ir_graph *irg, ir_node *block,
1463 ir_node *memop, ir_node *op1, ir_node *op2);
1465 /** Constructor for a Mod node.
1467 * @param *db A pointer for debug information.
1468 * @param *irg The ir graph the node belongs to.
1469 * @param *block The ir block the node belongs to.
1470 * @param *memop The store needed to model exceptions
1471 * @param *op1 The operand 1.
1472 * @param *op2 The operand 2.
1474 ir_node *new_rd_Mod (dbg_info *db, ir_graph *irg, ir_node *block,
1475 ir_node *memop, ir_node *op1, ir_node *op2);
1477 /** Constructor for a Abs node.
1479 * @param *db A pointer for debug information.
1480 * @param *irg The ir graph the node belongs to.
1481 * @param *block The ir block the node belongs to.
1482 * @param *op The operand
1483 * @param *mode The mode of the operands and the result.
1485 ir_node *new_rd_Abs (dbg_info *db, ir_graph *irg, ir_node *block,
1486 ir_node *op, ir_mode *mode);
1488 /** Constructor for a And node.
1490 * @param *db A pointer for debug information.
1491 * @param *irg The ir graph the node belongs to.
1492 * @param *block The ir block the node belongs to.
1493 * @param *op1 The operand 1.
1494 * @param *op2 The operand 2.
1495 * @param *mode The mode of the operands and the result.
1497 ir_node *new_rd_And (dbg_info *db, ir_graph *irg, ir_node *block,
1498 ir_node *op1, ir_node *op2, ir_mode *mode);
1500 /** Constructor for a Or node.
1502 * @param *db A pointer for debug information.
1503 * @param *irg The ir graph the node belongs to.
1504 * @param *block The ir block the node belongs to.
1505 * @param *op1 The operand 1.
1506 * @param *op2 The operand 2.
1507 * @param *mode The mode of the operands and the result.
1509 ir_node *new_rd_Or (dbg_info *db, ir_graph *irg, ir_node *block,
1510 ir_node *op1, ir_node *op2, ir_mode *mode);
1512 /** Constructor for a Eor node.
1514 * @param *db A pointer for debug information.
1515 * @param *irg The ir graph the node belongs to.
1516 * @param *block The ir block the node belongs to.
1517 * @param *op1 The operand 1.
1518 * @param *op2 The operand 2.
1519 * @param *mode The mode of the operands and the results.
1521 ir_node *new_rd_Eor (dbg_info *db, ir_graph *irg, ir_node *block,
1522 ir_node *op1, ir_node *op2, ir_mode *mode);
1524 /** Constructor for a Not node.
1526 * @param *db A pointer for debug information.
1527 * @param *irg The ir graph the node belongs to.
1528 * @param *block The ir block the node belongs to.
1529 * @param *op The operand.
1530 * @param *mode The mode of the operand and the result.
1532 ir_node *new_rd_Not (dbg_info *db, ir_graph *irg, ir_node *block,
1533 ir_node *op, ir_mode *mode);
1535 /** Constructor for a Cmp node.
1537 * @param *db A pointer for debug information.
1538 * @param *irg The ir graph the node belongs to.
1539 * @param *block The ir block the node belongs to.
1540 * @param *op1 The operand 1.
1541 * @param *op2 The operand 2.
1543 ir_node *new_rd_Cmp (dbg_info *db, ir_graph *irg, ir_node *block,
1544 ir_node *op1, ir_node *op2);
1546 /** Constructor for a Shl node.
1548 * @param *db A pointer for debug information.
1549 * @param *irg The ir graph the node belongs to.
1550 * @param *block The ir block the node belongs to.
1551 * @param *op The operand.
1552 * @param *k The number of bits to shift the operand .
1553 * @param *mode The mode of the operand and the result.
1555 ir_node *new_rd_Shl (dbg_info *db, ir_graph *irg, ir_node *block,
1556 ir_node *op, ir_node *k, ir_mode *mode);
1558 /** Constructor for a Shr node.
1560 * @param *db A pointer for debug information.
1561 * @param *irg The ir graph the node belongs to.
1562 * @param *block The ir block the node belongs to.
1563 * @param *op The operand.
1564 * @param *k The number of bits to shift the operand .
1565 * @param *mode The mode of the operand and the result.
1567 ir_node *new_rd_Shr (dbg_info *db, ir_graph *irg, ir_node *block,
1568 ir_node *op, ir_node *k, ir_mode *mode);
1570 /** Constructor for a Shrs node.
1572 * @param *db A pointer for debug information.
1573 * @param *irg The ir graph the node belongs to.
1574 * @param *block The ir block the node belongs to.
1575 * @param *op The operand.
1576 * @param *k The number of bits to shift the operand.
1577 * @param *mode The mode of the operand and the result.
1579 ir_node *new_rd_Shrs (dbg_info *db, ir_graph *irg, ir_node *block,
1580 ir_node *op, ir_node *k, ir_mode *mode);
1582 /** Constructor for a Rot node.
1584 * @param *db A pointer for debug information.
1585 * @param *irg The ir graph the node belongs to.
1586 * @param *block The ir block the node belongs to.
1587 * @param *op The operand.
1588 * @param *k The number of bits to rotate the operand.
1589 * @param *mode The mode of the operand.
1591 ir_node *new_rd_Rot (dbg_info *db, ir_graph *irg, ir_node *block,
1592 ir_node *op, ir_node *k, ir_mode *mode);
1595 /** Constructor for a Conv node.
1597 * @param *db A pointer for debug information.
1598 * @param *irg The ir graph the node belongs to.
1599 * @param *block The ir block the node belongs to.
1600 * @param *op The operand.
1601 * @param *mode The mode of this the operand muss be converted .
1603 ir_node *new_rd_Conv (dbg_info *db, ir_graph *irg, ir_node *block,
1604 ir_node *op, ir_mode *mode);
1606 /** Constructor for a Cast node.
1608 * High level type cast.
1610 * @param *db A pointer for debug information.
1611 * @param *irg The ir graph the node belongs to.
1612 * @param *block The ir block the node belongs to.
1613 * @param *op The operand.
1614 * @param *to_tp The type of this the operand muss be casted .
1616 ir_node *new_rd_Cast (dbg_info* db, ir_graph *irg, ir_node *block,
1617 ir_node *op, type *to_tp);
1619 /** Constructor for a Phi node.
1621 * @param *db A pointer for debug information.
1622 * @param *irg The ir graph the node belongs to.
1623 * @param *block The ir block the node belongs to.
1624 * @param arity The number of predecessors
1625 * @param *in[] Array with predecessors. The constructor copies this array.
1626 * @param *mode The mode of it's inputs and output.
1628 ir_node *new_rd_Phi (dbg_info *db, ir_graph *irg, ir_node *block, int arity,
1629 ir_node *in[], ir_mode *mode);
1631 /** Constructor for a Load node.
1633 * @param *db A pointer for debug information.
1634 * @param *irg The ir graph the node belongs to.
1635 * @param *block The ir block the node belongs to.
1636 * @param *store The current memory
1637 * @param *adr A pointer to the variable to be read in this memory.
1639 ir_node *new_rd_Load (dbg_info *db, ir_graph *irg, ir_node *block,
1640 ir_node *store, ir_node *adr);
1642 /** Constructor for a Store node.
1644 * @param *db A pointer for debug information.
1645 * @param *irg The ir graph the node belongs to.
1646 * @param *block The ir block the node belongs to.
1647 * @param *store The current memory
1648 * @param *adr A pointer to the variable to be read in this memory.
1649 * @param *val The value to write to this variable.
1651 ir_node *new_rd_Store (dbg_info *db, ir_graph *irg, ir_node *block,
1652 ir_node *store, ir_node *adr, ir_node *val);
1654 /** Constructor for a Alloc node.
1656 * The Alloc node extends the memory by space for an entity of type alloc_type.
1658 * @param *db A pointer for debug information.
1659 * @param *irg The ir graph the node belongs to.
1660 * @param *block The ir block the node belongs to.
1661 * @param *store The memory which shall contain the new variable.
1662 * @param *size The number of bytes to allocate.
1663 * @param *alloc_type The type of the allocated variable.
1664 * @param where Where to allocate the variable, either heap_alloc or stack_alloc.
1666 ir_node *new_rd_Alloc (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1667 ir_node *size, type *alloc_type, where_alloc where);
1669 /** Constructor for a Free node.
1671 * Frees the memory occupied by the entity pointed to by the pointer
1672 * arg. Type indicates the type of the entity the argument points to.
1674 * @param *db A pointer for debug information.
1675 * @param *irg The ir graph the node belongs to.
1676 * @param *block The ir block the node belongs to.
1677 * @param *store The memory which shall contain the new variable.
1678 * @param *ptr The pointer to the object to free.
1679 * @param *size The number of objects of type free_type to free in a sequence.
1680 * @param *free_type The type of the freed variable.
1682 ir_node *new_rd_Free (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1683 ir_node *ptr, ir_node *size, type *free_type);
1685 /** Constructor for a Sync node.
1687 * Merges several memory values. The node assumes that a variable
1688 * either occurs only in one of the memories, or it contains the same
1689 * value in all memories where it occurs.
1691 * @param *db A pointer for debug information.
1692 * @param *irg The ir graph the node belongs to.
1693 * @param *block The ir block the node belongs to.
1694 * @param arity The number of memories to syncronize.
1695 * @param *in[] An array of pointers to nodes that produce an output of type
1696 * memory. The constructor copies this array.
1698 ir_node *new_rd_Sync (dbg_info *db, ir_graph *irg, ir_node *block, int arity, ir_node *in[]);
1700 /** Constructor for a Proj node.
1702 * Projects a single value out of a tuple. The parameter proj gives the
1703 * position of the value within the tuple.
1705 * @param *db A pointer for deubugginformation.
1706 * @param *irg The ir graph the node belongs to.
1707 * @param *block The ir block the node belongs to.
1708 * @param arg A node producing a tuple. The node must have mode_T.
1709 * @param *mode The mode of the value to project.
1710 * @param proj The position of the value in the tuple.
1712 ir_node *new_rd_Proj (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *arg,
1713 ir_mode *mode, long proj);
1715 /** Constructor for a defaultProj node.
1717 * Represents the default control flow of a Switch-Cond node.
1719 * @param *db A pointer for debug information.
1720 * @param *irg The ir graph the node belongs to.
1721 * @param *block The ir block the node belongs to.
1722 * @param arg A node producing a tuple.
1723 * @param max_proj The end position of the value in the tuple.
1725 ir_node *new_rd_defaultProj (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *arg,
1728 /** Constructor for a Tuple node.
1730 * This is an auxiliary node to replace a node that returns a tuple
1731 * without changing the corresponding Proj nodes.
1733 * @param *db A pointer for debug information.
1734 * @param *irg The ir graph the node belongs to.
1735 * @param *block The ir block the node belongs to.
1736 * @param arity The number of tuple elements.
1737 * @param *in[] An array containing pointers to the nodes producing the tuple
1738 * elements. The constructor copies this array.
1740 ir_node *new_rd_Tuple (dbg_info *db, ir_graph *irg, ir_node *block,
1741 int arity, ir_node *in[]);
1743 /** Constructor for a Id node.
1745 * This is an auxiliary node to replace a node that returns a single
1748 * @param *db A pointer for debug information.
1749 * @param *irg The ir graph the node belongs to.
1750 * @param *block The ir block the node belongs to.
1751 * @param *val The value
1752 * @param *mode The mode of *val.
1754 ir_node *new_rd_Id (dbg_info *db, ir_graph *irg, ir_node *block,
1755 ir_node *val, ir_mode *mode);
1757 /** Constructor for a Bad node.
1759 * Returns the unique Bad node of the graph. The same as
1762 * @param *irg The ir graph the node belongs to.
1764 ir_node *new_rd_Bad (ir_graph *irg);
1766 /** Constructor for a Confirm node.
1768 * Specifies constraints for a value. To support dataflow analyses.
1770 * Example: If the value never exceeds '100' this is expressed by placing a
1771 * Confirm node val = new_d_Confirm(db, val, 100, '<') on the dataflow edge.
1773 * @param *irg The ir graph the node belong to.
1774 * @param *block The ir block the node belong to.
1775 * @param *db A pointer for debug information.
1776 * @param *val The value we express a constraint for
1777 * @param *bound The value to compare against. Must be a firm node, typically a constant.
1778 * @param cmp The compare operation.
1780 ir_node *new_rd_Confirm (dbg_info *db, ir_graph *irg, ir_node *block,
1781 ir_node *val, ir_node *bound, pn_Cmp cmp);
1783 /** Constructor for an Unknown node.
1785 * Represents an arbitrary value. Places the node in the start block.
1787 * @param *irg The ir graph the node belongs to.
1788 * @param *m The mode of the unknown value.
1790 ir_node *new_rd_Unknown(ir_graph *irg, ir_mode *m);
1792 /** Constructor for a CallBegin node.
1794 * CallBegin represents control flow depending of the pointer value
1795 * representing the called method to the called methods. The
1796 * constructor copies the method pointer input from the passed Call
1799 * @param *db A pointer for debug information.
1800 * @param *irg The ir graph the node belong to.
1801 * @param *block The block the node belong to.
1802 * @param *callee The call node visible in the intra procedural view.
1804 ir_node *new_rd_CallBegin(dbg_info *db, ir_graph *irg, ir_node *block, ir_node *callee);
1806 /** Constructor for a EndReg node.
1808 * Used to represent regular procedure end in interprocedual view.
1810 * @param *db A pointer for debug information.
1811 * @param *irg The ir graph the node belong to.
1812 * @param *block The block the node belong to.
1814 ir_node *new_rd_EndReg (dbg_info *db, ir_graph *irg, ir_node *block);
1816 /** Constructor for a EndExcept node.
1818 * Used to represent exceptional procedure end in interprocedural view.
1820 * @param *db A pointer for debug information.
1821 * @param *irg The ir graph the node belong to.
1822 * @param *block The block the node belong to.
1824 ir_node *new_rd_EndExcept(dbg_info *db, ir_graph *irg, ir_node *block);
1826 /** Constructor for a Filter node.
1828 * Adds the node to the block in current_ir_block. Filter is a node
1829 * with two views used to construct the interprocedural view. In
1830 * intraprocedural view its semantics are identical to the Proj node.
1831 * In interprocedural view the Filter performs the Phi operation on
1832 * method parameters or results. Other than a Phi a Filter node may
1833 * not be removed if it has only a single input.
1835 * The constructor builds the Filter in intraprocedural view.
1837 * @param *irg The ir graph the node belong to.
1838 * @param *block The block the node belong to.
1839 * @param *arg The tuple value to project from.
1840 * @param *mode The mode of the projected value.
1841 * @param proj The position in the tuple to project from.
1843 ir_node *new_rd_Filter (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *arg,
1844 ir_mode *mode, long proj);
1847 /*-------------------------------------------------------------------------*/
1848 /* The raw interface without debug support */
1849 /*-------------------------------------------------------------------------*/
1851 /** Constructor for a Block node.
1853 * @param irg The ir graph the block belongs to.
1854 * @param arity The number of control predecessors.
1855 * @param in[] An array of control predecessors. The length of
1856 * the array must be 'arity'. The constructor copies this array.
1858 ir_node *new_r_Block (ir_graph *irg, int arity, ir_node *in[]);
1860 /** Constructor for a Start node.
1862 * @param *irg The ir graph the node belongs to.
1863 * @param *block The ir block the node belongs to.
1865 ir_node *new_r_Start (ir_graph *irg, ir_node *block);
1867 /** Constructor for a End node.
1869 * @param *irg The ir graph the node belongs to.
1870 * @param *block The ir block the node belongs to.
1872 ir_node *new_r_End (ir_graph *irg, ir_node *block);
1874 /** Constructor for a Jmp node.
1876 * @param *irg The ir graph the node belongs to.
1877 * @param *block The ir block the node belongs to.
1879 ir_node *new_r_Jmp (ir_graph *irg, ir_node *block);
1881 /** Constructor for a Cond node.
1883 * @param *irg The ir graph the node belongs to.
1884 * @param *block The ir block the node belongs to.
1885 * @param *c The conditions parameter.Can be of mode b or I_u.
1887 ir_node *new_r_Cond (ir_graph *irg, ir_node *block, ir_node *c);
1889 /** Constructor for a Return node.
1891 * @param *irg The ir graph the node belongs to.
1892 * @param *block The ir block the node belongs to.
1893 * @param *store The state of memory.
1894 * @param arity Number of array indexes.
1895 * @param *in[] Array with index inputs to the node. The constructor copies this array.
1897 ir_node *new_r_Return (ir_graph *irg, ir_node *block,
1898 ir_node *store, int arity, ir_node *in[]);
1900 /** Constructor for a Raise node.
1902 * @param *irg The ir graph the node belongs to.
1903 * @param *block The ir block the node belongs to.
1904 * @param *store The current memory.
1905 * @param *obj A pointer to the Except variable.
1907 ir_node *new_r_Raise (ir_graph *irg, ir_node *block,
1908 ir_node *store, ir_node *obj);
1910 /** Constructor for a Const node.
1912 * @param *irg The ir graph the node belongs to.
1913 * @param *block The ir block the node belongs to.
1914 * @param *mode The mode of the operands and the results.
1915 * @param *con Points to an entry in the constant table.
1917 ir_node *new_r_Const (ir_graph *irg, ir_node *block,
1918 ir_mode *mode, tarval *con);
1920 /** Constructor for a SymConst node.
1922 * @param *irg The ir graph the node belongs to.
1923 * @param *block The ir block the node belongs to.
1925 * @param symkind The kind of the symbolic constant: type_tag, size or link_info.
1927 ir_node *new_r_SymConst (ir_graph *irg, ir_node *block,
1928 type_or_id_p value, symconst_kind symkind);
1930 /** Constructor for a Sel node.
1932 * @param *irg The ir graph the node belongs to.
1933 * @param *block The ir block the node belongs to.
1934 * @param *store The memory in which the object the entity should be selected from is allocated.
1935 * @param *objptr The object from that the Sel operation selects a single attribute out.
1936 * @param *n_index The index of the selected object from the array.
1937 * @param *index[] Array with index inputs to the node. The constructor copies this array.
1938 * @param *ent The entity to select.
1940 ir_node *new_r_Sel (ir_graph *irg, ir_node *block, ir_node *store,
1941 ir_node *objptr, int n_index, ir_node *index[],
1944 /** Constructor for a InstOf node.
1946 * @param *irg The ir graph the node belongs to.
1947 * @param *block The ir block the node belongs to.
1953 ir_node *new_r_InstOf (ir_graph *irg, ir_node *block, ir_node *x, ir_node *y, type *z);
1956 * Constructor for a Call node.
1958 * @param *irg The ir graph the node belongs to.
1959 * @param *block The ir block the node belongs to.
1960 * @param * store The actual store.
1961 * @param *callee A pointer to the called procedure.
1962 * @param arity The number of procedure parameters.
1963 * @param *in[] An array with the pointers to the parameters. The constructor copies this array.
1964 * @param *tp Type information of the procedure called.
1967 ir_node *new_r_Call (ir_graph *irg, ir_node *block, ir_node *store,
1968 ir_node *callee, int arity, ir_node *in[],
1972 * Constructor for a Add node.
1974 * @param *irg The ir graph the node belongs to.
1975 * @param *block The ir block the node belongs to.
1976 * @param *op1 The operand 1.
1977 * @param *op2 The operand 2.
1978 * @param *mode The mode of the operands and the result.
1981 ir_node *new_r_Add (ir_graph *irg, ir_node *block,
1982 ir_node *op1, ir_node *op2, ir_mode *mode);
1985 * Constructor for a Sub node.
1987 * @param *irg The ir graph the node belongs to.
1988 * @param *block The ir block the node belongs to.
1989 * @param *op1 The operand 1.
1990 * @param *op2 The operand 2.
1991 * @param *mode The mode of the operands and the results.
1994 ir_node *new_r_Sub (ir_graph *irg, ir_node *block,
1995 ir_node *op1, ir_node *op2, ir_mode *mode);
1998 * Constructor for a Minus node.
2000 * @param *irg The ir graph the node belongs to.
2001 * @param *block The ir block the node belongs to.
2002 * @param *op The operand.
2003 * @param *mode The mode of the operand and the result.
2006 ir_node *new_r_Minus (ir_graph *irg, ir_node *block,
2007 ir_node *op, ir_mode *mode);
2009 * Constructor for a Mul node.
2011 * @param *irg The ir graph the node belongs to.
2012 * @param *block The ir block the node belongs to.
2013 * @param *op1 The operand 1.
2014 * @param *op2 The operand 2.
2015 * @param *mode The mode of the operands and the result.
2018 ir_node *new_r_Mul (ir_graph *irg, ir_node *block,
2019 ir_node *op1, ir_node *op2, ir_mode *mode);
2022 * Constructor for a Quot node.
2024 * @param *irg The ir graph the node belongs to.
2025 * @param *block The ir block the node belongs to.
2026 * @param *memop The store needed to model exceptions
2027 * @param *op1 The operand 1.
2028 * @param *op2 The operand 2.
2031 ir_node *new_r_Quot (ir_graph *irg, ir_node *block,
2032 ir_node *memop, ir_node *op1, ir_node *op2);
2035 * Constructor for a DivMod node.
2037 * @param *irg The ir graph the node belongs to.
2038 * @param *block The ir block the node belongs to.
2039 * @param *memop The store needed to model exceptions
2040 * @param *op1 The operand 1.
2041 * @param *op2 The operand 2.
2044 ir_node *new_r_DivMod (ir_graph *irg, ir_node *block,
2045 ir_node *memop, ir_node *op1, ir_node *op2);
2048 * Constructor for a Div node.
2050 * @param *irg The ir graph the node belongs to.
2051 * @param *block The ir block the node belongs to.
2052 * @param *memop The store needed to model exceptions
2053 * @param *op1 The operand 1.
2054 * @param *op2 The operand 2.
2057 ir_node *new_r_Div (ir_graph *irg, ir_node *block,
2058 ir_node *memop, ir_node *op1, ir_node *op2);
2061 * Constructor for a Mod node.
2063 * @param *irg The ir graph the node belongs to.
2064 * @param *block The ir block the node belongs to.
2065 * @param *memop The store needed to model exceptions
2066 * @param *op1 The operand 1.
2067 * @param *op2 The operand 2.
2070 ir_node *new_r_Mod (ir_graph *irg, ir_node *block,
2071 ir_node *memop, ir_node *op1, ir_node *op2);
2074 * Constructor for a Abs node.
2076 * @param *irg The ir graph the node belongs to.
2077 * @param *block The ir block the node belongs to.
2078 * @param *op The operand
2079 * @param *mode The mode of the operands and the result.
2082 ir_node *new_r_Abs (ir_graph *irg, ir_node *block,
2083 ir_node *op, ir_mode *mode);
2086 * Constructor for a And node.
2088 * @param *irg The ir graph the node belongs to.
2089 * @param *block The ir block the node belongs to.
2090 * @param *op1 The operand 1.
2091 * @param *op2 The operand 2.
2092 * @param *mode The mode of the operands and the result.
2095 ir_node *new_r_And (ir_graph *irg, ir_node *block,
2096 ir_node *op1, ir_node *op2, ir_mode *mode);
2099 * Constructor for a Or node.
2101 * @param *irg The ir graph the node belongs to.
2102 * @param *block The ir block the node belongs to.
2103 * @param *op1 The operand 1.
2104 * @param *op2 The operand 2.
2105 * @param *mode The mode of the operands and the result.
2108 ir_node *new_r_Or (ir_graph *irg, ir_node *block,
2109 ir_node *op1, ir_node *op2, ir_mode *mode);
2112 * Constructor for a Eor node.
2114 * @param *irg The ir graph the node belongs to.
2115 * @param *block The ir block the node belongs to.
2116 * @param *op1 The operand 1.
2117 * @param *op2 The operand 2.
2118 * @param *mode The mode of the operands and the results.
2121 ir_node *new_r_Eor (ir_graph *irg, ir_node *block,
2122 ir_node *op1, ir_node *op2, ir_mode *mode);
2125 * Constructor for a Not node.
2127 * @param *irg The ir graph the node belongs to.
2128 * @param *block The ir block the node belongs to.
2129 * @param *op The operand.
2130 * @param *mode The mode of the operand and the result.
2133 ir_node *new_r_Not (ir_graph *irg, ir_node *block,
2134 ir_node *op, ir_mode *mode);
2137 * Constructor for a Cmp node.
2139 * @param *irg The ir graph the node belongs to.
2140 * @param *block The ir block the node belongs to.
2141 * @param *op1 The operand 1.
2142 * @param *op2 The operand 2.
2145 ir_node *new_r_Cmp (ir_graph *irg, ir_node *block,
2146 ir_node *op1, ir_node *op2);
2149 * Constructor for a Shl node.
2151 * @param *irg The ir graph the node belongs to.
2152 * @param *block The ir block the node belongs to.
2153 * @param *op The operand.
2154 * @param *k The number of bits to shift the operand .
2155 * @param *mode The mode of the operand and the result.
2158 ir_node *new_r_Shl (ir_graph *irg, ir_node *block,
2159 ir_node *op, ir_node *k, ir_mode *mode);
2162 * Constructor for a Shr node.
2164 * @param *irg The ir graph the node belongs to.
2165 * @param *block The ir block the node belongs to.
2166 * @param *op The operand.
2167 * @param *k The number of bits to shift the operand .
2168 * @param *mode The mode of the operand and the result.
2171 ir_node *new_r_Shr (ir_graph *irg, ir_node *block,
2172 ir_node *op, ir_node *k, ir_mode *mode);
2175 * Constructor for a Shrs node.
2177 * @param *irg The ir graph the node belongs to.
2178 * @param *block The ir block the node belongs to.
2179 * @param *op The operand.
2180 * @param *k The number of bits to shift the operand.
2181 * @param *mode The mode of the operand and the result.
2184 ir_node *new_r_Shrs (ir_graph *irg, ir_node *block,
2185 ir_node *op, ir_node *k, ir_mode *mode);
2188 * Constructor for a Rot node.
2190 * @param *irg The ir graph the node belongs to.
2191 * @param *block The ir block the node belongs to.
2192 * @param *op The operand.
2193 * @param *k The number of bits to rotate the operand.
2194 * @param *mode The mode of the operand.
2197 ir_node *new_r_Rot (ir_graph *irg, ir_node *block,
2198 ir_node *op, ir_node *k, ir_mode *mode);
2201 * Constructor for a Conv node.
2203 * @param *irg The ir graph the node belongs to.
2204 * @param *block The ir block the node belongs to.
2205 * @param *op The operand.
2206 * @param *mode The mode of this the operand muss be converted .
2209 ir_node *new_r_Conv (ir_graph *irg, ir_node *block,
2210 ir_node *op, ir_mode *mode);
2213 * Constructor for a Cast node.
2215 * @param *irg The ir graph the node belongs to.
2216 * @param *block The ir block the node belongs to.
2217 * @param *op The operand.
2218 * @param *to_tp The type of this the operand muss be casted .
2222 ir_node *new_r_Cast (ir_graph *irg, ir_node *block,
2223 ir_node *op, type *to_tp);
2226 * Constructor for a Phi node.
2228 * @param *irg The ir graph the node belongs to.
2229 * @param *block The ir block the node belongs to.
2230 * @param arity The number of predecessors
2231 * @param *in[] Array with predecessors. The constructor copies this array.
2232 * @param *mode The mode of it's inputs and output.
2235 ir_node *new_r_Phi (ir_graph *irg, ir_node *block, int arity,
2236 ir_node *in[], ir_mode *mode);
2239 * Constructor for a Load node.
2241 * @param *irg The ir graph the node belongs to.
2242 * @param *block The ir block the node belongs to.
2243 * @param *store The current memory
2244 * @param *adr A pointer to the variable to be read in this memory.
2247 ir_node *new_r_Load (ir_graph *irg, ir_node *block,
2248 ir_node *store, ir_node *adr);
2250 * Constructor for a Store node.
2252 * @param *irg The ir graph the node belongs to.
2253 * @param *block The ir block the node belongs to.
2254 * @param *store The current memory
2255 * @param *adr A pointer to the variable to be read in this memory.
2256 * @param *val The value to write to this variable.
2259 ir_node *new_r_Store (ir_graph *irg, ir_node *block,
2260 ir_node *store, ir_node *adr, ir_node *val);
2262 * Constructor for a Alloc node.
2264 * @param *irg The ir graph the node belongs to.
2265 * @param *block The ir block the node belongs to.
2266 * @param *store The memory which shall contain the new variable.
2267 * @param *size The number of bytes to allocate.
2268 * @param *alloc_type The type of the allocated variable.
2269 * @param where Where to allocate the variable, either heap_alloc or stack_alloc.
2273 ir_node *new_r_Alloc (ir_graph *irg, ir_node *block, ir_node *store,
2274 ir_node *size, type *alloc_type, where_alloc where);
2276 * Constructor for a Free node.
2278 * @param *irg The ir graph the node belongs to.
2279 * @param *block The ir block the node belongs to.
2280 * @param *store The memory which shall contain the new variable.
2281 * @param *ptr The pointer to the object to free.
2282 * @param *size The number of objects of type free_type to free in a sequence.
2283 * @param *free_type The type of the freed variable.
2287 ir_node *new_r_Free (ir_graph *irg, ir_node *block, ir_node *store,
2288 ir_node *ptr, ir_node *size, type *free_type);
2291 * Constructor for a Sync node.
2293 * @param *irg The ir graph the node belongs to.
2294 * @param *block The ir block the node belongs to.
2295 * @param arity The number of memories to syncronize.
2296 * @param *in[] An array of pointers to nodes that produce an output of type memory. The constructor copies this array.
2299 ir_node *new_r_Sync (ir_graph *irg, ir_node *block, int arity, ir_node *in[]);
2302 * Constructor for a Proj node.
2304 * @param *irg The ir graph the node belongs to.
2305 * @param *block The ir block the node belongs to.
2306 * @param arg A node producing a tuple.
2307 * @param *mode The mode of the value to project.
2308 * @param proj The position of the value in the tuple.
2312 ir_node *new_r_Proj (ir_graph *irg, ir_node *block, ir_node *arg,
2313 ir_mode *mode, long proj);
2316 * Constructor for a defaultProj node.
2318 * @param *irg The ir graph the node belongs to.
2319 * @param *block The ir block the node belongs to.
2320 * @param arg A node producing a tuple.
2321 * @param max_ proj The end position of the value in the tuple.
2324 ir_node *new_r_defaultProj (ir_graph *irg, ir_node *block, ir_node *arg, long max_proj);
2328 * Constructor for a Tuple node.
2330 * @param *irg The ir graph the node belongs to.
2331 * @param *block The ir block the node belongs to.
2332 * @param arity The number of tuple elements.
2333 * @param *in[] An array containing pointers to the nodes producing the tuple elements.
2334 * The constructor copies this array.
2336 ir_node *new_r_Tuple (ir_graph *irg, ir_node *block, int arity, ir_node *in[]);
2339 * Constructor for a Id node.
2341 * @param *irg The ir graph the node belongs to.
2342 * @param *block The ir block the node belongs to.
2343 * @param *val The operand to Id.
2344 * @param *mode The mode of *val.
2347 ir_node *new_r_Id (ir_graph *irg, ir_node *block,
2348 ir_node *val, ir_mode *mode);
2351 * Constructor for a Bad node.
2353 * @param *irg The ir graph the node belongs to.
2357 ir_node *new_r_Bad (ir_graph *irg);
2361 * Constructor for a Confirm node.
2362 * Specifies constraints for a value. To support dataflow analyses.
2364 * Example: If the value never exceeds '100' this is expressed by placing a
2365 * Confirm node val = new_d_Confirm(db, val, 100, '<') on the dataflow edge.
2367 * @param *irg The ir graph the node belong to.
2368 * @param *block The ir block the node belong to.
2369 * @param *db A pointer for debug information.
2370 * @param *val The value we express a constraint for
2371 * @param *bound The value to compare against. Must be a firm node, typically a constant.
2372 * @param cmp The compare operation.
2375 ir_node *new_r_Confirm (ir_graph *irg, ir_node *block,
2376 ir_node *val, ir_node *bound, pn_Cmp cmp);
2380 * Constructor for a Unknown node. Represents an arbtrary valus. Places the node in
2383 * @param *irg The ir graph the node belongs to.
2384 * @param *m The mode of the unknown value.
2386 ir_node *new_r_Unknown(ir_graph *irg, ir_mode *m);
2389 * Constructor for a CallBegin node.
2391 * @param *irg The ir graph the node belong to.
2392 * @param *block The block the node belong to.
2393 * @param *callee The call node bisible in the intra procedural view.
2397 ir_node *new_r_CallBegin(ir_graph *irg, ir_node *block, ir_node *callee);
2400 * Constructor for a EndReg node.
2402 * @param *irg The ir graph the node belong to.
2403 * @param *block The block the node belong to.
2407 ir_node *new_r_EndReg (ir_graph *irg, ir_node *block);
2410 * Constructor for a EndExcept node.
2412 * @param *irg The ir graph the node belong to.
2413 * @param *block The block the node belong to.
2417 ir_node *new_r_EndExcept(ir_graph *irg, ir_node *block);
2420 * Constructor for a Break node.
2422 * @param *irg The ir graph the node belong to.
2423 * @param *block The block the node belong to.
2427 ir_node *new_r_Break (ir_graph *irg, ir_node *block);
2431 * Constructor for a Filter node. Adds the node to the block in current_ir_block.
2432 * Filter is a node with two views used to construct the interprocedural view.
2433 * In intraprocedural view its semantics are identical to the Proj node.
2434 * In interprocedural view the Filter performs the Phi operation on method
2435 * parameters or results. Other than a Phi a Filter node may not be removed
2436 * if it has only a single input.
2438 * The constructor builds the Filter in intraprocedural view.
2440 * @param *irg The ir graph the node belong to.
2441 * @param *block The block the node belong to.
2442 * @param *arg The tuple value to project from.
2443 * @param *mode The mode of the projected value.
2444 * @param proj The position in the tuple to project from.
2447 ir_node *new_r_Filter (ir_graph *irg, ir_node *block, ir_node *arg,
2448 ir_mode *mode, long proj);
2451 * Constructor for a FuncCall node.
2453 * @param *irg The ir graph the node belong to.
2454 * @param *block The block the node belong to.
2455 * @param *callee A pointer to the called procedure.
2456 * @param arity The number of procedure parameters.
2457 * @param *in[] An array with the pointers to the parameters. The constructor copies this array.
2458 * @param *type Type information of the procedure called.
2461 ir_node *new_r_FuncCall (ir_graph *irg, ir_node *block,
2462 ir_node *callee, int arity, ir_node *in[],
2465 /*-----------------------------------------------------------------------*/
2466 /* The block oriented interface */
2467 /*-----------------------------------------------------------------------*/
2469 /** Sets the current block in which the following constructors place the
2470 nodes they construct. */
2471 void switch_block (ir_node *target);
2474 * Constructor for a Block node. Adds the block to the graph in current_ir_graph.
2476 * @param *db A Pointer for debugginfomation.
2477 * @param arity The number of control predecessors.
2478 * @param in[] An array of control predecessors. The length of
2479 * the array must be 'arity'.
2481 ir_node *new_d_Block(dbg_info* db, int arity, ir_node *in[]);
2484 * Constructor for a Start node. Adds the node to the block in current_ir_block.
2486 * @param *db A pointer for debug information.
2489 ir_node *new_d_Start (dbg_info* db);
2492 * Constructor for a End node. Adds the node to the block in current_ir_block.
2494 * @param *db A pointer for debug information.
2497 ir_node *new_d_End (dbg_info* db);
2500 * Constructor for a Jmp node. Adds the node to the block in current_ir_block.
2502 * @param *db A pointer for debug information.
2506 ir_node *new_d_Jmp (dbg_info* db);
2509 * Constructor for a Cond node. Adds the node to the block in current_ir_block.
2511 * @param *db A pointer for debug information.
2512 * @param *c The conditions parameter.Can be of mode b or I_u.
2516 ir_node *new_d_Cond (dbg_info* db, ir_node *c);
2519 * Constructor for a Return node. Adds the node to the block in current_ir_block.
2521 * @param *db A pointer for debug information.
2522 * @param *store The state of memory.
2523 * @param arity Number of array indexes.
2524 * @param *in Array with index inputs to the node.
2528 ir_node *new_d_Return (dbg_info* db, ir_node *store, int arity, ir_node *in[]);
2531 * Constructor for a Raise node. Adds the node to the block in current_ir_block.
2533 * @param *db A pointer for debug information.
2534 * @param *store The current memory.
2535 * @param *obj A pointer to the Except variable.
2539 ir_node *new_d_Raise (dbg_info* db, ir_node *store, ir_node *obj);
2542 * Constructor for a Const_type node. Adds the node to the block in current_ir_block.
2544 * @param *db A pointer for debug information.
2545 * @param *mode The mode of the operands and redults.
2546 * @param *con Points to an entry in the constant table. This pointer is added to the attributes of the node (self->attr.con).
2547 * @param *tp The type of the constante.
2551 ir_node *new_d_Const_type (dbg_info* db, ir_mode *mode, tarval *con, type *tp);
2554 * Constructor for a Const node. Adds the node to the block in current_ir_block.
2556 * @param *db A pointer for debug information.
2557 * @param *mode The mode of the operands and redults.
2558 * @param *con Points to an entry in the constant table. This pointer is added to the attributes of the node (self->attr.con).
2562 ir_node *new_d_Const (dbg_info* db, ir_mode *mode, tarval *con);
2565 * Constructor for a SymConst node. Adds the node to the block in current_ir_block.
2567 * @param *db A pointer for debug information.
2568 * @param value A type, entity or ident depending on the SymConst kind.
2569 * @param symkind The kind of the symbolic constant: symconst_type_tag, symconst_size or symconst_addr_name.
2572 ir_node *new_d_SymConst (dbg_info* db, type_or_id_p value, symconst_kind kind);
2575 * Constructor for a simpleSel node. Adds the node to the block in current_ir_block.
2577 * @param *db A pointer for debug information.
2578 * @param *store The memory in which the object the entity should be selected from is allocated.
2579 * @param *objptr The object from that the Sel operation selects a single attribute out.
2580 * @param *ent The entity to select.
2584 ir_node *new_d_simpleSel(dbg_info* db, ir_node *store, ir_node *objptr, entity *ent);
2587 * Constructor for a Sel node. Adds the node to the block in current_ir_block.
2589 * @param *db A pointer for debug information.
2590 * @param *store The memory in which the object the entity should be selected from is allocated.
2591 * @param *objptr The object from that the Sel operation selects a single attribute out.
2592 * @param arity The index of the selected object from the array.
2593 * @param *in Array with index inputs to the node.
2594 * @param *ent The entity to select.
2598 ir_node *new_d_Sel (dbg_info* db, ir_node *store, ir_node *objptr, int arity, ir_node *in[],
2602 * Constructor for a InstOf node. Adds the node to the block in current_ir_block.
2604 * @param *db A pointer for debug information.
2611 ir_node *new_d_InstOf (dbg_info* db, ir_node *store, ir_node *objptr, type *ent);
2614 * Constructor for a Call node. Adds the node to the block in current_ir_block.
2616 * @param *db A pointer for debug information.
2617 * @param *store The actual store.
2618 * @param *callee A pointer to the called procedure.
2619 * @param arity The number of procedure parameters.
2620 * @param *in[] An array with the pointers to the parameters. The constructor copies this array.
2621 * @param *tp Type information of the procedure called.
2625 ir_node *new_d_Call (dbg_info* db, ir_node *store, ir_node *callee, int arity, ir_node *in[],
2629 * Constructor for a Add node. Adds the node to the block in current_ir_block.
2631 * @param *db A pointer for debug information.
2632 * @param *op1 The operand 1.
2633 * @param *op2 The operand 2.
2634 * @param *mode The mode of the operands and the result.
2638 ir_node *new_d_Add (dbg_info* db, ir_node *op1, ir_node *op2, ir_mode *mode);
2641 * Constructor for a Sub node. Adds the node to the block in current_ir_block.
2643 * @param *db A pointer for debug information.
2644 * @param *op1 The operand 1.
2645 * @param *op2 The operand 2.
2646 * @param *mode The mode of the operands and the result.
2650 ir_node *new_d_Sub (dbg_info* db, ir_node *op1, ir_node *op2, ir_mode *mode);
2653 * Constructor for a Minus node. Adds the node to the block in current_ir_block.
2655 * @param *db A pointer for debug information.
2656 * @param *op The operand .
2657 * @param *mode The mode of the operand and the result.
2661 ir_node *new_d_Minus (dbg_info* db, ir_node *op, ir_mode *mode);
2664 * Constructor for a Mul node. Adds the node to the block in current_ir_block.
2666 * @param *db A pointer for debug information.
2667 * @param *op1 The operand 1.
2668 * @param *op2 The operand 2.
2669 * @param *mode The mode of the operands and the result.
2673 ir_node *new_d_Mul (dbg_info* db, ir_node *op1, ir_node *op2, ir_mode *mode);
2676 * Constructor for a Quot node. Adds the node to the block in current_ir_block.
2678 * @param *db A pointer for debug information.
2679 * @param *memop The store needed to model exceptions
2680 * @param *op1 The operand 1.
2681 * @param *op2 The operand 2.
2685 ir_node *new_d_Quot (dbg_info* db, ir_node *memop, ir_node *op1, ir_node *op2);
2688 * Constructor for a DivMod node. Adds the node to the block in current_ir_block.
2690 * @param *db A pointer for debug information.
2691 * @param *memop The store needed to model exceptions
2692 * @param *op1 The operand 1.
2693 * @param *op2 The operand 2.
2697 ir_node *new_d_DivMod (dbg_info* db, ir_node *memop, ir_node *op1, ir_node *op2);
2700 * Constructor for a Div node. Adds the node to the block in current_ir_block.
2702 * @param *db A pointer for debug information.
2703 * @param *memop The store needed to model exceptions
2704 * @param *op1 The operand 1.
2705 * @param *op2 The operand 2.
2709 ir_node *new_d_Div (dbg_info* db, ir_node *memop, ir_node *op1, ir_node *op2);
2712 * Constructor for a Mod node. Adds the node to the block in current_ir_block.
2714 * @param *db A pointer for debug information.
2715 * @param *memop The store needed to model exceptions
2716 * @param *op1 The operand 1.
2717 * @param *op2 The operand 2.
2721 ir_node *new_d_Mod (dbg_info* db, ir_node *memop, ir_node *op1, ir_node *op2);
2724 * Constructor for a Abs node. Adds the node to the block in current_ir_block.
2726 * @param *db A pointer for debug information.
2727 * @param *op The operand
2728 * @param *mode The mode of the operands and the result.
2732 ir_node *new_d_Abs (dbg_info* db, ir_node *op, ir_mode *mode);
2735 * Constructor for a And node. Adds the node to the block in current_ir_block.
2737 * @param *db A pointer for debug information.
2738 * @param *irg The ir graph the node belongs to.
2739 * @param *block The ir block the node belongs to.
2740 * @param *op1 The operand 1.
2741 * @param *op2 The operand 2.
2742 * @param *mode The mode of the operands and the result.
2746 ir_node *new_d_And (dbg_info* db, ir_node *op1, ir_node *op2, ir_mode *mode);
2749 * Constructor for a Or node. Adds the node to the block in current_ir_block.
2751 * @param *db A pointer for debug information.
2752 * @param *op1 The operand 1.
2753 * @param *op2 The operand 2.
2754 * @param *mode The mode of the operands and the result.
2758 ir_node *new_d_Or (dbg_info* db, ir_node *op1, ir_node *op2, ir_mode *mode);
2761 * Constructor for a Eor node. Adds the node to the block in current_ir_block.
2763 * @param *db A pointer for debug information.
2764 * @param *op1 The operand 1.
2765 * @param *op2 The operand 2.
2766 * @param *mode The mode of the operands and the results.
2770 ir_node *new_d_Eor (dbg_info* db, ir_node *op1, ir_node *op2, ir_mode *mode);
2773 * Constructor for a Not node. Adds the node to the block in current_ir_block.
2775 * @param *db A pointer for debug information.
2776 * @param *op The operand.
2777 * @param *mode The mode of the operand and the result.
2781 ir_node *new_d_Not (dbg_info* db, ir_node *op, ir_mode *mode);
2784 * Constructor for a Shl node. Adds the node to the block in current_ir_block.
2786 * @param *db A pointer for debug information.
2787 * @param *op The operand.
2788 * @param *k The number of bits to shift the operand .
2789 * @param *mode The mode of the operand and the result.
2793 ir_node *new_d_Shl (dbg_info* db, ir_node *op, ir_node *k, ir_mode *mode);
2796 * Constructor for a Shr node. Adds the node to the block in current_ir_block.
2798 * @param *db A pointer for debug information.
2799 * @param *op The operand.
2800 * @param *k The number of bits to shift the operand .
2801 * @param *mode The mode of the operand and the result.
2805 ir_node *new_d_Shr (dbg_info* db, ir_node *op, ir_node *k, ir_mode *mode);
2808 * Constructor for a Shrs node. Adds the node to the block in current_ir_block.
2810 * @param *db A pointer for debug information.
2811 * @param *op The operand.
2812 * @param *k The number of bits to shift the operand .
2813 * @param *mode The mode of the operand and the result.
2817 ir_node *new_d_Shrs (dbg_info* db, ir_node *op, ir_node *k, ir_mode *mode);
2820 * Constructor for a Rot node. Adds the node to the block in current_ir_block.
2822 * @param *db A pointer for debug information.
2823 * @param *op The operand.
2824 * @param *k The number of bits to rotate the operand.
2825 * @param *mode The mode of the operand.
2829 ir_node *new_d_Rot (dbg_info* db, ir_node *op, ir_node *k, ir_mode *mode);
2832 * Constructor for a Cmp node. Adds the node to the block in current_ir_block.
2834 * @param *db A pointer for debug information.
2835 * @param *op1 The operand 1.
2836 * @param *op2 The operand 2.
2840 ir_node *new_d_Cmp (dbg_info* db, ir_node *op1, ir_node *op2);
2843 * Constructor for a Conv node. Adds the node to the block in current_ir_block.
2845 * @param *db A pointer for debug information.
2846 * @param *op The operand.
2847 * @param *mode The mode of this the operand muss be converted .
2851 ir_node *new_d_Conv (dbg_info* db, ir_node *op, ir_mode *mode);
2854 * Constructor for a Cast node. Adds the node to the block in current_ir_block.
2856 * @param *db A pointer for debug information.
2857 * @param *op The operand.
2858 * @param *to_tp The type of this the operand muss be casted .
2862 ir_node *new_d_Cast (dbg_info* db, ir_node *op, type *to_tp);
2865 * Constructor for a Phi node. Adds the node to the block in current_ir_block.
2867 * @param *db A pointer for debugginaromation.
2868 * @param arity The number of predecessors
2869 * @param *in Array with predecessors
2870 * @param *mode The mode of it's inputs and output.
2874 ir_node *new_d_Phi (dbg_info* db, int arity, ir_node *in[], ir_mode *mode);
2877 * Constructor for a Load node. Adds the node to the block in current_ir_block.
2879 * @param *db A pointer for debug information.
2880 * @param *store The current memory
2881 * @param *adr A pointer to the variable to be read in this memory.
2885 ir_node *new_d_Load (dbg_info* db, ir_node *store, ir_node *addr);
2888 * Constructor for a Store node. Adds the node to the block in current_ir_block.
2890 * @param *db A pointer for debug information.
2891 * @param *store The current memory
2892 * @param *adr A pointer to the variable to be read in this memory.
2893 * @param *val The value to write to this variable.
2896 ir_node *new_d_Store (dbg_info* db, ir_node *store, ir_node *addr, ir_node *val);
2899 * Constructor for a Alloc node. Adds the node to the block in current_ir_block.
2901 * @param *db A pointer for debug information.
2902 * @param *store The memory which shall contain the new variable.
2903 * @param *size The number of bytes to allocate.
2904 * @param *alloc_type The type of the allocated variable.
2905 * @param where Where to allocate the variable, either heap_alloc or stack_alloc.
2909 ir_node *new_d_Alloc (dbg_info* db, ir_node *store, ir_node *size, type *alloc_type,
2913 * Constructor for a Free node. Adds the node to the block in current_ir_block.
2915 * @param *db A pointer for debug information.
2916 * @param *store The memory which shall contain the new variable.
2917 * @param *ptr The pointer to the object to free.
2918 * @param *size The number of objects of type free_type to free in a sequence.
2919 * @param *free_type The type of the freed variable.
2923 ir_node *new_d_Free (dbg_info* db, ir_node *store, ir_node *ptr, ir_node *size,
2927 * Constructor for a Sync node. Adds the node to the block in current_ir_block.
2929 * @param *db A pointer for debug information.
2930 * @param arity The number of memories to syncronize.
2931 * @param **in An array of pointers to nodes that produce an output of type memory.
2935 ir_node *new_d_Sync (dbg_info* db, int arity, ir_node *in[]);
2939 * Constructor for a Proj node. Adds the node to the block in current_ir_block.
2941 * @param *db A pointer for deubugginformation.
2942 * @param arg A node producing a tuple.
2943 * @param *mode The mode of the value to project.
2944 * @param proj The position of the value in the tuple.
2948 ir_node *new_d_Proj (dbg_info* db, ir_node *arg, ir_mode *mode, long proj);
2952 * Constructor for a defaultProj node. Adds the node to the block in current_ir_block.
2954 * @param *db A pointer for debug information.
2955 * @param arg A node producing a tuple.
2956 * @param max_ proj The end position of the value in the tuple.
2960 ir_node *new_d_defaultProj (dbg_info* db, ir_node *arg, long max_proj);
2963 * Constructor for a Tuple node. Adds the node to the block in current_ir_block.
2965 * @param *db A pointer for debug information.
2966 * @param arity The number of tuple elements.
2967 * @param **in An array containing pointers to the nodes producing the tuple elements.
2971 ir_node *new_d_Tuple (dbg_info* db, int arity, ir_node *in[]);
2975 * Constructor for a Id node. Adds the node to the block in current_ir_block.
2976 * Performs the Id operation, i.e., does nothing.
2978 * @param *db A pointer for debug information.
2979 * @param *val The operand to Id.
2980 * @param *mode The mode of *val.
2984 ir_node *new_d_Id (dbg_info* db, ir_node *val, ir_mode *mode);
2987 * Returns the unique Bad node. Same as get_irn_bad(..);
2990 ir_node *new_d_Bad (void);
2993 * Constructor for a Confirm node. Adds the node to the block in current_ir_block.
2994 * Specifies constraints for a value. To support dataflow analyses.
2996 * Example: If the value never exceeds '100' this is expressed by placing a
2997 * Confirm node val = new_d_Confirm(db, val, 100, '<') on the dataflow edge.
2999 * @param *db A pointer for debug information.
3000 * @param *val The value we express a constraint for
3001 * @param *bound The value to compare against. Must be a firm node, typically a constant.
3002 * @param cmp The compare operation.
3006 ir_node *new_d_Confirm (dbg_info* db, ir_node *val, ir_node *bound, pn_Cmp cmp);
3010 * Constructor for a Unknown node. Represents an arbtrary valus. Places the node in
3013 * @param *m The mode of the unknown value.
3017 ir_node *new_d_Unknown(ir_mode *m);
3020 * Constructor for a CallBegin node. Adds the node to the block in current_ir_block.
3022 * @param *db A pointer for debug information.
3023 * @param *callee The call node bisible in the intra procedural view.
3027 ir_node *new_d_CallBegin(dbg_info *db, ir_node *callee);
3030 * Constructor for a EndReg node. Adds the node to the block in current_ir_block.
3032 * @param *db A pointer for debug information.
3036 ir_node *new_d_EndReg (dbg_info *db);
3039 * Constructor for a Endexcept node. Adds the node to the block in current_ir_block.
3041 * @param *db A pointer for debug information.
3045 ir_node *new_d_EndExcept(dbg_info *db);
3048 * Constructor for a Breake node. Adds the node to the block in current_ir_block.
3050 * @param *db A pointer for debug information.
3055 ir_node *new_d_Break (dbg_info *db);
3057 /** Constructor for a Filter node.
3059 * Constructor for a Filter node. Adds the node to the block in
3060 * current_ir_block. Filter is a node with two views used to
3061 * construct the interprocedural view. In intraprocedural view its
3062 * semantics are identical to the Proj node. In interprocedural view
3063 * the Filter performs the Phi operation on method parameters or
3064 * results. Other than a Phi a Filter node may not be removed if it
3065 * has only a single input.
3067 * The constructor builds the Filter in intraprocedural view.
3069 * @param *db A pointer for debug information.
3070 * @param *arg The tuple value to project from.
3071 * @param *mode The mode of the projected value.
3072 * @param proj The position in the tuple to project from.
3075 ir_node *new_d_Filter (dbg_info *db, ir_node *arg, ir_mode *mode, long proj);
3079 * Constructor for a FuncCall node. Adds the node to the block in current_ir_block.
3081 * @param *db A pointer for debug information.
3082 * @param *callee A pointer to the called procedure.
3083 * @param arity The number of procedure parameters.
3084 * @param **in An array with the pointers to the parameters. The constructor copies this array.
3085 * @param *tp Type information of the procedure called.
3090 ir_node *new_d_FuncCall (dbg_info* db, ir_node *callee, int arity, ir_node *in[],
3093 /*-----------------------------------------------------------------------*/
3094 /* The block oriented interface without debug support */
3095 /*-----------------------------------------------------------------------*/
3097 /* Needed from the interfase with debug support:
3098 void switch_block (ir_node *target); */
3100 /* Constructs a Block with a fixed number of predecessors.
3101 Does set current_block. Can be used with automatic Phi
3102 node construction. */
3104 /** Constructor for a Block node.
3106 * Constructor for a Block node. Adds the block to the graph in
3107 * current_ir_graph .
3109 * @param arity The number of control predecessors.
3110 * @param in An array of control predecessors. The length of
3111 * the array must be 'arity'.
3113 ir_node *new_Block(int arity, ir_node *in[]);
3117 * Constructor for a Start node. Adds the node to the block in current_ir_block.
3121 ir_node *new_Start (void);
3125 * Constructor for a End node. Adds the node to the block in current_ir_block.
3129 ir_node *new_End (void);
3133 * Constructor for a EndReg node. Adds the node to the block in current_ir_block.
3137 ir_node *new_EndReg (void);
3139 /** Constructor for an EndExpcept node.
3141 * Constructor for an EndExpcept node. Adds the node to the block in current_ir_block.
3146 ir_node *new_EndExcept(void);
3150 * Constructor for a Jump node. Adds the node to the block in current_ir_block.
3154 ir_node *new_Jmp (void);
3158 * Constructor for a Break node. Adds the node to the block in current_ir_block.
3162 ir_node *new_Break (void);
3165 * Constructor for a Cond node. Adds the node to the block in current_ir_block.
3167 * @param *c The conditions parameter.Can be of mode b or I_u.
3171 ir_node *new_Cond (ir_node *c);
3174 * Constructor for a Return node. Adds the node to the block in current_ir_block.
3176 * @param *store The state of memory.
3177 * @param arity Number of array indexes.
3178 * @param *in Array with index inputs to the node.
3182 ir_node *new_Return (ir_node *store, int arity, ir_node *in[]);
3185 * Constructor for a Raise node. Adds the node to the block in current_ir_block.
3187 * @param *store The current memory.
3188 * @param *obj A pointer to the Except variable.
3192 ir_node *new_Raise (ir_node *store, ir_node *obj);
3195 * Constructor for a Const node. Adds the node to the block in current_ir_block.
3197 * @param *mode The mode of the operands and redults.
3198 * @param *con Points to an entry in the constant table. This pointer is added to the attributes of the node (self->attr.con).
3202 ir_node *new_Const (ir_mode *mode, tarval *con);
3205 * Constructor for a SymConst node. Adds the node to the block in current_ir_block.
3207 * @param value A type or a ident depending on the SymConst kind.
3208 * @param symkind The kind of the symbolic constant: symconst_type_tag, symconst_size or symconst_addr_name.
3211 ir_node *new_SymConst (type_or_id_p value, symconst_kind kind);
3214 * Constructor for a simpelSel node.
3216 * @param *store The memory in which the object the entity should be selected from is allocated.
3217 * @param *objptr The object from that the Sel operation selects a single attribute out.
3218 * @param *ent The entity to select.
3222 ir_node *new_simpleSel(ir_node *store, ir_node *objptr, entity *ent);
3225 * Constructor for a Sel node.
3227 * @param *store The memory in which the object the entity should be selected from is allocated.
3228 * @param *objptr The object from that the Sel operation selects a single attribute out.
3229 * @param *n_index The index of the selected object from the array.
3230 * @param *index Array with index inputs to the node.
3231 * @param *ent The entity to select.
3235 ir_node *new_Sel (ir_node *store, ir_node *objptr, int arity, ir_node *in[],
3239 * Constructor for a InstOf node. Adds the node to the block in current_ir_block.
3247 ir_node *new_InstOf (ir_node *store, ir_node *obj, type *ent);
3250 * Constructor for a Call node. Adds the node to the block in current_ir_block.
3252 * @param *store The actual store.
3253 * @param *callee A pointer to the called procedure.
3254 * @param arity The number of procedure parameters.
3255 * @param *in[] An array with the pointers to the parameters. The constructor copies this array.
3256 * @param *tp Type information of the procedure called.
3260 ir_node *new_Call (ir_node *store, ir_node *callee, int arity, ir_node *in[],
3264 * Constructor for a CallBegin node. Adds the node to the block in current_ir_block.
3266 * @param *callee A pointer to the called procedure.
3270 ir_node *new_CallBegin(ir_node *callee);
3273 * Constructor for a Add node. Adds the node to the block in current_ir_block.
3275 * @param *op1 The operand 1.
3276 * @param *op2 The operand 2.
3277 * @param *mode The mode of the operands and the result.
3281 ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode);
3284 * Constructor for a Sub node. Adds the node to the block in current_ir_block.
3286 * @param *op1 The operand 1.
3287 * @param *op2 The operand 2.
3288 * @param *mode The mode of the operands and the result.
3292 ir_node *new_Sub (ir_node *op1, ir_node *op2, ir_mode *mode);
3295 * Constructor for a Minus node. Adds the node to the block in current_ir_block.
3297 * @param *op The operand .
3298 * @param *mode The mode of the operand and the result.
3302 ir_node *new_Minus (ir_node *op, ir_mode *mode);
3305 * Constructor for a Mul node. Adds the node to the block in current_ir_block.
3307 * @param *op1 The operand 1.
3308 * @param *op2 The operand 2.
3309 * @param *mode The mode of the operands and the result.
3313 ir_node *new_Mul (ir_node *op1, ir_node *op2, ir_mode *mode);
3316 * Constructor for a Quot node. Adds the node to the block in current_ir_block.
3318 * @param *memop The store needed to model exceptions
3319 * @param *op1 The operand 1.
3320 * @param *op2 The operand 2.
3324 ir_node *new_Quot (ir_node *memop, ir_node *op1, ir_node *op2);
3327 * Constructor for a DivMod node. Adds the node to the block in current_ir_block.
3329 * @param *memop The store needed to model exceptions
3330 * @param *op1 The operand 1.
3331 * @param *op2 The operand 2.
3335 ir_node *new_DivMod (ir_node *memop, ir_node *op1, ir_node *op2);
3338 * Constructor for a Div node. Adds the node to the block in current_ir_block.
3340 * @param *memop The store needed to model exceptions
3341 * @param *op1 The operand 1.
3342 * @param *op2 The operand 2.
3346 ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2);
3349 * Constructor for a Mod node. Adds the node to the block in current_ir_block.
3351 * @param *memop The store needed to model exceptions
3352 * @param *op1 The operand 1.
3353 * @param *op2 The operand 2.
3357 ir_node *new_Mod (ir_node *memop, ir_node *op1, ir_node *op2);
3360 * Constructor for a Abs node. Adds the node to the block in current_ir_block.
3362 * @param *op The operand
3363 * @param *mode The mode of the operands and the result.
3367 ir_node *new_Abs (ir_node *op, ir_mode *mode);
3370 * Constructor for a And node. Adds the node to the block in current_ir_block.
3372 * @param *op1 The operand 1.
3373 * @param *op2 The operand 2.
3374 * @param *mode The mode of the operands and the result.
3377 ir_node *new_And (ir_node *op1, ir_node *op2, ir_mode *mode);
3380 * Constructor for a Or node. Adds the node to the block in current_ir_block.
3382 * @param *op1 The operand 1.
3383 * @param *op2 The operand 2.
3384 * @param *mode The mode of the operands and the result.
3388 ir_node *new_Or (ir_node *op1, ir_node *op2, ir_mode *mode);
3391 * Constructor for a Eor node. Adds the node to the block in current_ir_block.
3393 * @param *op1 The operand 1.
3394 * @param *op2 The operand 2.
3395 * @param *mode The mode of the operands and the results.
3399 ir_node *new_Eor (ir_node *op1, ir_node *op2, ir_mode *mode);
3402 * Constructor for a Not node. Adds the node to the block in current_ir_block.
3404 * @param *op The operand.
3405 * @param *mode The mode of the operand and the result.
3409 ir_node *new_Not (ir_node *op, ir_mode *mode);
3412 * Constructor for a Shl node. Adds the node to the block in current_ir_block.
3414 * @param *op The operand.
3415 * @param *k The number of bits to shift the operand .
3416 * @param *mode The mode of the operand and the result.
3420 ir_node *new_Shl (ir_node *op, ir_node *k, ir_mode *mode);
3423 * Constructor for a Shr node. Adds the node to the block in current_ir_block.
3425 * @param *op The operand.
3426 * @param *k The number of bits to shift the operand .
3427 * @param *mode The mode of the operand and the result.
3431 ir_node *new_Shr (ir_node *op, ir_node *k, ir_mode *mode);
3434 * Constructor for a Shrs node. Adds the node to the block in current_ir_block.
3436 * @param *op The operand.
3437 * @param *k The number of bits to shift the operand .
3438 * @param *mode The mode of the operand and the result.
3442 ir_node *new_Shrs (ir_node *op, ir_node *k, ir_mode *mode);
3445 * Constructor for a Rot node. Adds the node to the block in current_ir_block.
3447 * @param *op The operand.
3448 * @param *k The number of bits to rotate the operand.
3449 * @param *mode The mode of the operand.
3453 ir_node *new_Rot (ir_node *op, ir_node *k, ir_mode *mode);
3456 * Constructor for a Cmp node. Adds the node to the block in current_ir_block.
3458 * @param *op1 The operand 1.
3459 * @param *op2 The operand 2.
3463 ir_node *new_Cmp (ir_node *op1, ir_node *op2);
3466 * Constructor for a Conv node. Adds the node to the block in current_ir_block.
3468 * @param *op The operand.
3469 * @param *mode The mode of this the operand muss be converted .
3473 ir_node *new_Conv (ir_node *op, ir_mode *mode);
3476 * Constructor for a Cast node. Adds the node to the block in current_ir_block.
3478 * @param *op The operand.
3479 * @param *to_tp The type of this the operand muss be casted .
3483 ir_node *new_Cast (ir_node *op, type *to_tp);
3486 * Constructor for a Phi node. Adds the node to the block in current_ir_block.
3488 * @param arity The number of predecessors
3489 * @param *in Array with predecessors
3490 * @param *mode The mode of it's inputs and output.
3494 ir_node *new_Phi (int arity, ir_node *in[], ir_mode *mode);
3497 * Constructor for a Load node.
3499 * @param *store The current memory
3500 * @param *addr A pointer to the variable to be read in this memory.
3504 ir_node *new_Load (ir_node *store, ir_node *addr);
3507 * Constructor for a Store node.
3509 * @param *store The current memory
3510 * @param *addr A pointer to the variable to be read in this memory.
3511 * @param *val The value to write to this variable.
3514 ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val);
3517 * Constructor for a Alloc node. Adds the node to the block in current_ir_block.
3519 * @param *store The memory which shall contain the new variable.
3520 * @param *size The number of bytes to allocate.
3521 * @param *alloc_type The type of the allocated variable.
3522 * @param where Where to allocate the variable, either heap_alloc or stack_alloc.
3526 ir_node *new_Alloc (ir_node *store, ir_node *size, type *alloc_type,
3531 * Constructor for a Free node. Adds the node to the block in current_ir_block.
3533 * @param *store The memory which shall contain the new variable.
3534 * @param *ptr The pointer to the object to free.
3535 * @param *size The number of objects of type free_type to free in a sequence.
3536 * @param *free_type The type of the freed variable.
3540 ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size,
3544 * Constructor for a Sync node. Adds the node to the block in current_ir_block.
3546 * @param arity The number of memories to syncronize.
3547 * @param **in An array of pointers to nodes that produce an output of type memory.
3550 ir_node *new_Sync (int arity, ir_node *in[]);
3553 * Constructor for a Proj node. Adds the node to the block in current_ir_block.
3555 * @param arg A node producing a tuple.
3556 * @param *mode The mode of the value to project.
3557 * @param proj The position of the value in the tuple.
3560 ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj);
3564 * Constructor for a Filter node. Adds the node to the block in current_ir_block.
3565 * Filter is a node with two views used to construct the interprocedural view.
3566 * In intraprocedural view its semantics are identical to the Proj node.
3567 * In interprocedural view the Filter performs the Phi operation on method
3568 * parameters or results. Other than a Phi a Filter node may not be removed
3569 * if it has only a single input.
3571 * The constructor builds the Filter in intraprocedural view.
3573 * @param *arg The tuple value to project from.
3574 * @param *mode The mode of the projected value.
3575 * @param proj The position in the tuple to project from.
3578 ir_node *new_Filter (ir_node *arg, ir_mode *mode, long proj);
3581 * Constructor for a defaultProj node.Adds the node to the block in current_ir_block.
3583 * @param arg A node producing a tuple.
3584 * @param max_ proj The end position of the value in the tuple.
3587 ir_node *new_defaultProj (ir_node *arg, long max_proj);
3590 * Constructor for a Tuple node. Adds the node to the block in current_ir_block.
3592 * @param arity The number of tuple elements.
3593 * @param **in An array containing pointers to the nodes producing the tuple elements.
3597 ir_node *new_Tuple (int arity, ir_node *in[]);
3600 * Constructor for a Id node. Adds the node to the block in current_ir_block.
3602 * @param *val The operand to Id.
3603 * @param *mode The mode of *val.
3606 ir_node *new_Id (ir_node *val, ir_mode *mode);
3610 * Constructor for a Bad node.
3611 * Adds the node to the block in current_ir_block.
3615 ir_node *new_Bad (void);
3618 * Constructor for a Confirm node. Adds the node to the block in current_ir_block.
3619 * Specifies constraints for a value. To support dataflow analyses.
3621 * Example: If the value never exceeds '100' this is expressed by placing a
3622 * Confirm node val = new_d_Confirm(db, val, 100, '<') on the dataflow edge.
3624 * @param *val The value we express a constraint for
3625 * @param *bound The value to compare against. Must be a firm node, typically a constant.
3626 * @param cmp The compare operation.
3629 ir_node *new_Confirm (ir_node *val, ir_node *bound, pn_Cmp cmp);
3632 * Constructor for a Unknown node. Represents an arbitrary value. Places the node in
3635 * @param *m The mode of the unknown value.
3638 ir_node *new_Unknown(ir_mode *m);
3641 * Constructor for a FuncCall node. Adds the node to the block in current_ir_block.
3643 * @param *callee A pointer to the called procedure.
3644 * @param arity The number of procedure parameters.
3645 * @param **in An array with the pointers to the parameters. The constructor copies this array.
3646 * @param *tp Type information of the procedure called.
3650 ir_node *new_FuncCall (ir_node *callee, int arity, ir_node *in[],
3653 /*---------------------------------------------------------------------*/
3654 /* The comfortable interface. */
3655 /* Supports automatic Phi node construction. */
3656 /* All routines of the block oriented interface except new_Block are */
3658 /*---------------------------------------------------------------------*/
3660 /* --- Block construction --- */
3661 /* immature Block without predecessors */
3662 ir_node *new_d_immBlock (dbg_info* db);
3663 ir_node *new_immBlock (void);
3665 /** Add a control flow edge to an immature block. */
3666 void add_in_edge (ir_node *immblock, ir_node *jmp);
3668 /** fixes the number of predecessors of a block. */
3669 void mature_block (ir_node *block);
3671 /* --- Parameter administration --- */
3672 /* Read a value from the array with the local variables. Use this
3673 function to obtain the last definition of the value associated with
3674 pos. Pos may not exceed the value passed as n_loc to new_ir_graph. */
3675 ir_node *get_d_value (dbg_info* db, int pos, ir_mode *mode);
3676 ir_node *get_value (int pos, ir_mode *mode);
3678 /** Write a value in the array with the local variables. Use this function
3679 to remember a new definition of the value associated with pos. Pos may
3680 not exceed the value passed as n_loc to new_ir_graph. */
3681 void set_value (int pos, ir_node *value);
3684 Use this function to get the most recent version of the store (type M).
3685 Internally it does the same as get_value. */
3686 ir_node *get_store (void);
3688 /** Write a store. */
3689 void set_store (ir_node *store);
3691 /** keep this node alive even if End is not control-reachable from it */
3692 void keep_alive (ir_node *ka);
3694 /* --- Useful access routines --- */
3695 /** Returns the current block of the current graph. To set the current
3696 block use switch_block(). */
3697 ir_node *get_cur_block(void);
3699 /** Returns the frame type of the current graph */
3700 type *get_cur_frame_type(void);
3703 /* --- initialize and finalize ir construction --- */
3705 /** Puts the graph into state "phase_high" */
3706 void finalize_cons (ir_graph *irg);
3708 /* --- Initialization --- */
3711 * This function is called, whenever a local variable is used before definition
3713 * @parameter mode the mode of the local var
3714 * @pos position choosen be the frontend for this var
3716 * @return a firm node of mode @p mode that initialises the var at position pos
3719 * Do not return NULL
3720 * If this function is not set, FIRM will create a const node with tarval BAD
3722 typedef ir_node *default_initialize_local_variable_func_t(ir_mode *mode, int pos);
3725 * Initializes the graph construction.
3727 * @param func @see default_initialize_local_variable_func_t
3729 void init_cons (default_initialize_local_variable_func_t *func);
3731 # endif /* _IRCONS_H_ */