ircons.h 69.9 KB
Newer Older
Christian Würdig's avatar
Christian Würdig committed
1
/*
Michael Beck's avatar
Michael Beck committed
2
 * Copyright (C) 1995-2010 University of Karlsruhe.  All right reserved.
Christian Würdig's avatar
Christian Würdig committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */

Matthias Braun's avatar
Matthias Braun committed
20
21
22
23
24
25
/**
 * @file
 * @brief   Various irnode constructors. Automatic construction of SSA
 *          representation.
 * @author  Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Boris Boesler,
 *          Michael Beck
Götz Lindenmaier's avatar
Götz Lindenmaier committed
26
 */
Christian Schäfer's avatar
Christian Schäfer committed
27

Sebastian Felis's avatar
Sebastian Felis committed
28
/**
Matthias Braun's avatar
Matthias Braun committed
29
 *  @file
Michael Beck's avatar
Michael Beck committed
30
 *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
31
32
 *  documentation no more supported since 2001
 *
33
 *  IR node construction.
Boris Boesler's avatar
Boris Boesler committed
34
 *
Boris Boesler's avatar
Boris Boesler committed
35
 *    This file documents all datatypes and constructors needed to
Götz Lindenmaier's avatar
Götz Lindenmaier committed
36
 *    build a FIRM representation of a procedure.  The constructors are
Boris Boesler's avatar
Boris Boesler committed
37
38
39
40
41
42
43
44
45
46
 *    also implemented in this file.
 *
 *    The documentation also gives a short manual how to use the library.
 *
 *    For extensive documentation of FIRM see UKA Techreport 1999-14.
 *
 *
 *    Three kinds of nodes
 *    --------------------
 *
47
 *      There are three kinds of nodes known to the IR:  entities,
Boris Boesler's avatar
Boris Boesler committed
48
49
50
51
52
53
54
55
56
57
58
59
60
 *      types, and ir_nodes
 *
 *      + ir_nodes are the actual nodes of the FIRM intermediate representation.
 *        They represent operations on the data of the program and control flow
 *        operations.
 *
 *      + entity ==> implemented in entity.h
 *        Refers to a single entity of the compiled program, e.g. a field of a
 *        class or a method.  If a method or variable can not be assigned to
 *        a method or class or the like, it is a global object.
 *
 *      + types ==> implemented in type.h
 *        With types type information is represented.  There are several type
Götz Lindenmaier's avatar
Götz Lindenmaier committed
61
 *       nodes.
Boris Boesler's avatar
Boris Boesler committed
62
63
64
65
66
67
68
69
70
 *
 *    Implementation of the FIRM operations: ir_node
 *    ----------------------------------------------
 *
 *      Ir_nodes represent operations on the data of the program and control flow
 *      operations.  Examples of ir_nodes:  Add, Jmp, Cmp
 *
 *      FIRM is a dataflow graph.  A dataflow graph is a directed graph,
 *      so that every node has incoming and outgoing edges.  A node is
71
 *      executable if every input at its incoming edges is available.
Boris Boesler's avatar
Boris Boesler committed
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 *      Execution of the dataflow graph is started at the Start node which
 *      has no incoming edges and ends when the End node executes, even if
 *      there are still executable or not executed nodes.  (Is this true,
 *      or must all executable nodes be executed?)  (There are exceptions
 *      to the dataflow paradigma that all inputs have to be available
 *      before a node can execute: Phi, Block.  See UKA Techreport
 *      1999-14.)
 *
 *      The implementation of FIRM differs from the view as a dataflow
 *      graph.  To allow fast traversion of the graph edges are
 *      implemented as C-pointers.  Inputs to nodes are not ambiguous, the
 *      results can be used by several other nodes.  Each input can be
 *      implemented as a single pointer to a predecessor node, outputs
 *      need to be lists of pointers to successors.  Therefore a node
86
 *      contains pointers to its predecessors so that the implementation is a
Boris Boesler's avatar
Boris Boesler committed
87
88
89
 *      dataflow graph with reversed edges.  It has to be traversed bottom
 *      up.
 *
90
 *      All nodes of the IR have the same basic structure.  They are
Boris Boesler's avatar
Boris Boesler committed
91
92
93
94
95
96
97
98
99
100
101
102
 *      distinguished by a field containing the opcode.
 *
 *      The fields of an ir_node:
 *
 *      kind             A firm_kind tag containing k_ir_node.  This is useful for
 *                       dynamically checking the type of a node.
 *
 *      *op              This ir_op gives the opcode as a tag and a string
 *                       and the number of attributes of an ir_node.  There is
 *                       one statically allocated struct ir_op for each opcode.
 *
 *      *mode            The ir_mode of the operation represented by this firm
103
104
105
 *                       node.  The mode of the operation is the mode of its
 *                       result.  A Firm mode is a datatype as known to the
 *                       target, not a type of the source language.
Boris Boesler's avatar
Boris Boesler committed
106
 *
107
 *      visit            A flag for traversing the IR.
Boris Boesler's avatar
Boris Boesler committed
108
109
110
111
 *
 *      **in             An array with pointers to the node's predecessors.
 *
 *      *link            A pointer to an ir_node.  With this pointer all Phi nodes
112
 *                       are attached to a Block, i.e. a Block points to its
Boris Boesler's avatar
Boris Boesler committed
113
 *                       first Phi node, this node points to the second Phi node
114
 *                       in the Block and so forth.  Used in mature_immBlock
Boris Boesler's avatar
Boris Boesler committed
115
 *                       to find all Phi nodes to be matured.  It's also used to
116
 *                       annotate a node with a better, optimized version of it.
Boris Boesler's avatar
Boris Boesler committed
117
118
119
 *
 *      attr             An attr struct containing the attributes of the nodes. The
 *                       attributes depend on the opcode of the node.  The number
120
 *                       of these attributes is given in op.
Boris Boesler's avatar
Boris Boesler committed
121
122
123
124
125
126
127
128
129
 *
 *    The struct ir_op
 *    ----------------
 *                       Not yet documented. See irop.h.
 *
 *    The struct ir_mode
 *    ------------------
 *                       Not yet documented. See irmode.h.
 *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
130
 *    GLOBAL VARIABLES -- now also fields of ir_graph.
Boris Boesler's avatar
Boris Boesler committed
131
132
133
 *    ================
 *
 *    current_ir_graph   Points to the current ir_graph.  All constructors for
134
 *                       nodes add nodes to this graph.
Boris Boesler's avatar
Boris Boesler committed
135
136
137
138
139
140
141
142
143
144
 *
 *    ir_visited         An int used as flag to traverse the ir_graph.
 *
 *    block_visited      An int used as a flag to traverse block nodes in the
 *                       graph.
 *
 *                       Others not yet documented.
 *
 *
 *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
145
 *    CONSTRUCTOR FOR IR_GRAPH --> see irgraph.h
Boris Boesler's avatar
Boris Boesler committed
146
147
148
 *    ========================
 *
 *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
149
 *    PROCEDURE TO CONSTRUCT AN IR GRAPH --> see also Firm tutorial
Boris Boesler's avatar
Boris Boesler committed
150
151
152
153
 *    ==================================
 *
 *    This library supplies several interfaces to construct a FIRM graph for
 *    a program:
Michael Beck's avatar
Michael Beck committed
154
 *    - A "comfortable" interface generating SSA automatically.  Automatically
Boris Boesler's avatar
Boris Boesler committed
155
156
 *      computed predecessors of nodes need not be specified in the constructors.
 *      (new_<Node> constructurs and a set of additional routines.)
Michael Beck's avatar
Michael Beck committed
157
 *    - A less comfortable interface where all predecessors except the block
Boris Boesler's avatar
Boris Boesler committed
158
 *      an operation belongs to need to be specified.  SSA must be constructed
159
 *      by hand.  (new_<Node> constructors and set_cur_block()).  This interface
Boris Boesler's avatar
Boris Boesler committed
160
161
 *      is called "block oriented".  It automatically calles the local optimizations
 *      for each new node.
Michael Beck's avatar
Michael Beck committed
162
 *    - An even less comfortable interface where the block needs to be specified
Boris Boesler's avatar
Boris Boesler committed
163
164
165
166
167
168
 *      explicitly.  This is called the "raw" interface. (new_r_<Node>
 *      constructors).  These nodes are not optimized.
 *
 *    To use the functionality of the comfortable interface correctly the Front
 *    End needs to follow certain protocols.  This is explained in the following.
 *    To build a correct IR with the other interfaces study the semantics of
Götz Lindenmaier's avatar
Götz Lindenmaier committed
169
 *    the firm node (See tech-reprot UKA 1999-14).  For the construction of
Boris Boesler's avatar
Boris Boesler committed
170
171
172
173
174
 *    types and entities see the documentation in those modules.
 *
 *    First the Frontend needs to decide which variables and values used in
 *    a procedure can be represented by dataflow edges.  These are variables
 *    that need not be saved to memory as they cause no side effects visible
Götz Lindenmaier's avatar
Götz Lindenmaier committed
175
 *    out of the procedure.  Often these are all compiler generated
Boris Boesler's avatar
Boris Boesler committed
176
177
178
179
 *    variables and simple local variables of the procedure as integers,
 *    reals and pointers.  The frontend has to count and number these variables.
 *
 *    First an ir_graph needs to be constructed with new_ir_graph.  The
180
 *    constructor gets the number of local variables.  The graph is held in the
Boris Boesler's avatar
Boris Boesler committed
181
182
183
184
185
186
187
188
 *    global variable irg.
 *
 *    Now the construction of the procedure can start.  Several basic blocks can
 *    be constructed in parallel, but the code within each block needs to
 *    be constructed (almost) in program order.
 *
 *    A global variable holds the current basic block.  All (non block) nodes
 *    generated are added to this block.  The current block can be set with
189
 *    set_cur_block(block).  If several blocks are constructed in parallel block
Boris Boesler's avatar
Boris Boesler committed
190
191
 *    switches need to be performed constantly.
 *
Christoph Mallon's avatar
Christoph Mallon committed
192
 *    To generate a Block node (with the comfortable interface), its predecessor
Boris Boesler's avatar
Boris Boesler committed
193
 *    control flow nodes need not be known.  In case of cyclic control flow these
194
 *    can not be known when the block is constructed.  With add_immBlock_pred(block,
Boris Boesler's avatar
Boris Boesler committed
195
 *    cfnode) predecessors can be added to the block.  If all predecessors are
196
 *    added to the block mature_immBlock(b) needs to be called.  Calling mature_immBlock
Boris Boesler's avatar
Boris Boesler committed
197
 *    early improves the efficiency of the Phi node construction algorithm.
198
 *    But if several  blocks are constructed at once, mature_immBlock must only
Boris Boesler's avatar
Boris Boesler committed
199
200
201
202
203
204
 *    be called after performing all set_values and set_stores in the block!
 *    (See documentation of new_immBlock constructor.)
 *
 *    The constructors of arithmetic nodes require that their predecessors
 *    are mentioned.  Sometimes these are available in the Frontend as the
 *    predecessors have just been generated by the frontend.  If they are local
205
 *    values, the predecessors can be obtained from the library with a call to
Boris Boesler's avatar
Boris Boesler committed
206
207
 *    get_value(local_val_nr).  (local_val_nr needs to be administered by
 *    the Frontend.)  A call to get_value triggers the generation of Phi nodes.
208
 *    If an arithmetic operation produces a local value, this value needs to be
Boris Boesler's avatar
Boris Boesler committed
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 *    passed to the library by set_value(node, local_val_nr).
 *    In straight line code these two operations just remember and return the
 *    pointer to nodes producing the value.  If the value passes block boundaries
 *    Phi nodes can be inserted.
 *    Similar routines exist to manage the Memory operands: set_store and
 *    get_store.
 *
 *    Several nodes produce more than one result.  An example is the Div node.
 *    Such nodes return tuples of values.  From these individual values can be
 *    extracted by proj nodes.
 *
 *    The following example illustrates the construction of a simple basic block
 *    with two predecessors stored in variables cf_pred1 and cf_pred2, containing
 *    the code
 *      a = a div a;
 *    and finally jumping to an other block.  The variable a got the local_val_nr
 *    42 by the frontend.
 *
 *    ir_node *this_block, *cf_pred1, *cf_pred2, *a_val, *mem, *div, *res, *cf_op;
 *
 *    this_block = new_immBlock();
230
231
232
 *    add_immBlock_pred(this_block, cf_pred1);
 *    add_immBlock_pred(this_block, cf_pred2);
 *    mature_immBlock(this_block);
Matthias Heil's avatar
Matthias Heil committed
233
 *    a_val = get_value(42, mode_Iu);
Boris Boesler's avatar
Boris Boesler committed
234
 *    mem = get_store();
235
236
237
 *    div = new_Div(mem, a_val, a_val, mode_Iu);
 *    mem = new_Proj(div, mode_M, pn_Div_M);   * for the numbers for Proj see docu *
 *    res = new_Proj(div, mode_Iu, pn_Div_res);
Boris Boesler's avatar
Boris Boesler committed
238
 *    set_store(mem);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
239
 *    set_value(res, 42);
Boris Boesler's avatar
Boris Boesler committed
240
241
242
243
244
245
 *    cf_op = new_Jmp();
 *
 *    For further information look at the documentation of the nodes and
 *    constructors and at the paragraph COPING WITH DATA OBJECTS at the
 *    end of this documentation.
 *
246
 *    The comfortable interface contains the following routines further explained
Boris Boesler's avatar
Boris Boesler committed
247
248
 *    below:
 *
249
250
251
252
 *    ir_node *new_immBlock (void);
 *    ir_node *new_Start    (void);
 *    ir_node *new_End      (void);
 *    ir_node *new_Jmp      (void);
253
 *    ir_node *new_IJmp     (ir_node *tgt);
254
255
 *    ir_node *new_Cond     (ir_node *c);
 *    ir_node *new_Return   (ir_node *store, int arity, ir_node **in);
Matthias Braun's avatar
Matthias Braun committed
256
 *    ir_node *new_Const    (ir_tarval *con);
257
 *    ir_node *new_SymConst (ir_mode *mode, symconst_symbol value, symconst_kind kind);
Michael Beck's avatar
Michael Beck committed
258
 *    ir_node *new_simpleSel (ir_node *store, ir_node *objptr, ir_entity *ent);
259
 *    ir_node *new_Sel    (ir_node *store, ir_node *objptr, int arity,
Michael Beck's avatar
Michael Beck committed
260
 *                         ir_node **in, ir_entity *ent);
261
 *    ir_node *new_Call   (ir_node *store, ir_node *callee, int arity,
262
263
264
 *                         ir_node **in, type_method *type);
 *    ir_node *new_Builtin(ir_node *store, ir_builtin_kind kind, int arity,
 *                         ir_node **in, type_method *type);
265
266
267
268
 *    ir_node *new_Add    (ir_node *op1, ir_node *op2, ir_mode *mode);
 *    ir_node *new_Sub    (ir_node *op1, ir_node *op2, ir_mode *mode);
 *    ir_node *new_Minus  (ir_node *op,  ir_mode *mode);
 *    ir_node *new_Mul    (ir_node *op1, ir_node *op2, ir_mode *mode);
Michael Beck's avatar
Michael Beck committed
269
 *    ir_node *new_Mulh   (ir_node *op1, ir_node *op2, ir_mode *mode);
270
271
 *    ir_node *new_Div    (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
 *    ir_node *new_Mod    (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state;
272
273
274
275
276
277
278
 *    ir_node *new_And    (ir_node *op1, ir_node *op2, ir_mode *mode);
 *    ir_node *new_Or     (ir_node *op1, ir_node *op2, ir_mode *mode);
 *    ir_node *new_Eor    (ir_node *op1, ir_node *op2, ir_mode *mode);
 *    ir_node *new_Not    (ir_node *op,                ir_mode *mode);
 *    ir_node *new_Shl    (ir_node *op,  ir_node *k,   ir_mode *mode);
 *    ir_node *new_Shr    (ir_node *op,  ir_node *k,   ir_mode *mode);
 *    ir_node *new_Shrs   (ir_node *op,  ir_node *k,   ir_mode *mode);
279
 *    ir_node *new_Rotl   (ir_node *op,  ir_node *k,   ir_mode *mode);
280
281
 *    ir_node *new_Cmp    (ir_node *op1, ir_node *op2);
 *    ir_node *new_Conv   (ir_node *op, ir_mode *mode);
Michael Beck's avatar
Michael Beck committed
282
 *    ir_node *new_Cast   (ir_node *op, ir_type *to_tp);
283
284
 *    ir_node *new_Carry  (ir_node *op1, ir_node *op2, ir_mode *mode);
 *    ir_node *new_Borrow (ir_node *op1, ir_node *op2, ir_mode *mode);
285
286
 *    ir_node *new_Load   (ir_node *store, ir_node *addr, ir_mode *mode, ir_cons_flags flags);
 *    ir_node *new_Store  (ir_node *store, ir_node *addr, ir_node *val, ir_cons_flags flags);
287
 *    ir_node *new_Alloc  (ir_node *store, ir_node *count, ir_type *alloc_type,
288
289
 *                         where_alloc where);
 *    ir_node *new_Free   (ir_node *store, ir_node *ptr, ir_node *size,
Michael Beck's avatar
Michael Beck committed
290
 *               ir_type *free_type, where_alloc where);
291
 *    ir_node *new_Proj   (ir_node *arg, ir_mode *mode, long proj);
292
 *    ir_node *new_NoMem  (void);
293
 *    ir_node *new_Mux    (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
Michael Beck's avatar
Michael Beck committed
294
 *    ir_node *new_CopyB  (ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
295
296
 *    ir_node *new_InstOf (ir_node *store, ir_node obj, ir_type *ent);
 *    ir_node *new_Raise  (ir_node *store, ir_node *obj);
Michael Beck's avatar
Michael Beck committed
297
 *    ir_node *new_Bound  (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
Michael Beck's avatar
Michael Beck committed
298
 *    ir_node *new_Pin    (ir_node *node);
Boris Boesler's avatar
Boris Boesler committed
299
 *
300
301
302
 *    void add_immBlock_pred (ir_node *block, ir_node *jmp);
 *    void mature_immBlock (ir_node *block);
 *    void set_cur_block (ir_node *target);
Boris Boesler's avatar
Boris Boesler committed
303
304
305
306
 *    ir_node *get_value (int pos, ir_mode *mode);
 *    void set_value (int pos, ir_node *value);
 *    ir_node *get_store (void);
 *    void set_store (ir_node *store);
307
 *    keep_alive (ir_node ka)
Boris Boesler's avatar
Boris Boesler committed
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 *
 *    IR_NODES AND CONSTRUCTORS FOR IR_NODES
 *    =======================================
 *
 *    All ir_nodes are defined by a common data structure.  They are distinguished
 *    by their opcode and differ in the number of their attributes.
 *
 *    Const nodes are always added to the start block.
 *    All other constructors add the created node to the current_block.
 *    swich_block(block) allows to set the current block to block.
 *
 *    Watch for my inconsistent use of input and predecessor (dataflow view)
 *    and `the node points to' (implementation view).
 *
 *    The following description of the nodes lists four properties them if these
 *    are of interest:
 *     - the parameters to the constructor
 *     - the inputs of the Firm node
 *     - the outputs of the Firm node
 *     - attributes to the node
 *
 *    ------------
 *
 *    ir_node *new_immBlock (void)
 *    ----------------------------
 *
334
335
336
337
338
339
 *    Creates a new block. When a new block is created it cannot be known how
 *    many predecessors this block will have in the control flow graph.
 *    Therefore the list of inputs can not be fixed at creation.  Predecessors
 *    can be added with add_immBlock_pred (block, control flow operation).
 *    With every added predecessor the number of inputs to Phi nodes also
 *    changes.
Boris Boesler's avatar
Boris Boesler committed
340
 *
341
342
 *    The block can be completed by mature_immBlock(block) if all predecessors are
 *    known.  If several blocks are built at once, mature_immBlock can only be called
Boris Boesler's avatar
Boris Boesler committed
343
 *    after set_value has been called for all values that are life at the end
Michael Beck's avatar
Michael Beck committed
344
345
 *    of the block.  This is necessary so that Phi nodes created mature_immBlock
 *    get the right predecessors in case of cyclic dependencies.  If all set_values
Boris Boesler's avatar
Boris Boesler committed
346
347
348
349
 *    of this block are called after maturing it and before calling get_value
 *    in some block that is control flow dependent on this block, the construction
 *    is correct.
 *
350
 *    Example for faulty IR construction:  (draw the graph on a paper and you'll
Boris Boesler's avatar
Boris Boesler committed
351
352
 *                                          get it ;-)
 *
353
354
 *      block_before_loop = new_immBlock();
 *      set_cur_block(block_before_loop);
Boris Boesler's avatar
Boris Boesler committed
355
 *      set_value(x);
356
 *      mature_immBlock(block_before_loop);
Boris Boesler's avatar
Boris Boesler committed
357
358
 *      before2header = new_Jmp;
 *
359
360
 *      loop_header = new_immBlock ();
 *      set_cur_block(loop_header);
Boris Boesler's avatar
Boris Boesler committed
361
362
 *      header2body - new_Jmp();
 *
363
364
 *      loop_body = new_immBlock ();
 *      set_cur_block(loop_body);
Boris Boesler's avatar
Boris Boesler committed
365
366
 *      body2header = new_Jmp();
 *
367
368
369
 *      add_immBlock_pred(loop_header, before2header);
 *      add_immBlock_pred(loop_header, body2header);
 *      add_immBlock_pred(loop_body, header2body);
Boris Boesler's avatar
Boris Boesler committed
370
 *
371
372
 *      mature_immBlock(loop_header);
 *      mature_immBlock(loop_body);
Boris Boesler's avatar
Boris Boesler committed
373
 *
374
375
376
 *      get_value(loop_body, x);   //  gets the Phi in loop_header
 *      set_value(loop_header, x); //  sets the value the above get_value should
 *                                 //  have returned!!!
Boris Boesler's avatar
Boris Boesler committed
377
 *
378
 *    Mature_immBlock also fixes the number of inputs to the Phi nodes.  Mature_immBlock
Boris Boesler's avatar
Boris Boesler committed
379
 *    should be called as early as possible, as afterwards the generation of Phi
Michael Beck's avatar
Michael Beck committed
380
 *    nodes is more efficient.
Boris Boesler's avatar
Boris Boesler committed
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 *
 *    Inputs:
 *      There is an input for each control flow predecessor of the block.
 *      The input points to an instruction producing an output of type X.
 *      Possible predecessors:  Start, Jmp, Cond, Raise or Return or any node
 *      possibly causing an exception.  (Often the real predecessors are Projs.)
 *    Output:
 *      Mode BB (R), all nodes belonging to this block should consume this output.
 *      As they are strict (except Block and Phi node) it is a necessary condition
 *      that the block node executed before any other node in this block executes.
 *    Attributes:
 *      block.matured  Indicates whether the block is mature.
 *      block.**graph_arr
 *                      This attribute contains all local values valid in this
 *                      block. This is needed to build the Phi nodes and removed
 *                      if the graph is complete.  This field is used by the
397
398
 *              internal construction algorithm and should not be accessed
 *              from outside.
Boris Boesler's avatar
Boris Boesler committed
399
400
401
402
403
404
 *
 *
 *    ir_node *new_Block (int arity, ir_node **in)
 *    --------------------------------------------
 *
 *    Creates a new Block with the given list of predecessors.  This block
405
 *    is mature.  As other constructors calls optimization and verify for the
406
407
 *    block.  If one of the predecessors is Unknown (as it has to be filled in
 *    later) optimizations are skipped.  This is necessary to
408
 *    construct Blocks in loops.
Boris Boesler's avatar
Boris Boesler committed
409
410
411
412
413
414
 *
 *
 *    CONTROL FLOW OPERATIONS
 *    -----------------------
 *
 *    In each block there must be exactly one of the control flow
415
 *    operations Start, End, Jmp, Cond, Return or Raise.  The output of a
Boris Boesler's avatar
Boris Boesler committed
416
417
418
419
420
421
 *    control flow operation points to the block to be executed next.
 *
 *    ir_node *new_Start (void)
 *    -------------------------
 *
 *    Creates a start node.  Not actually needed public.  There is only one such
Götz Lindenmaier's avatar
Götz Lindenmaier committed
422
 *   node in each procedure which is automatically created by new_ir_graph.
Boris Boesler's avatar
Boris Boesler committed
423
424
 *
 *    Inputs:
Michael Beck's avatar
Michael Beck committed
425
 *      No inputs except the block it belongs to.
Boris Boesler's avatar
Boris Boesler committed
426
427
 *    Output:
 *      A tuple of 4 (5, 6) distinct values. These are labeled by the following
428
429
430
431
432
433
 *      projection numbers (pn_Start):
 *      * pn_Start_X_initial_exec    mode X, points to the first block to be exe *                                   cuted.
 *      * pn_Start_M                 mode M, the global store
 *      * pn_Start_P_frame_base      mode P, a pointer to the base of the proce  *                                   dures stack frame.
 *      * pn_Start_P_globals         mode P, a pointer to the part of the memory *                                   containing_all_ global things.
 *      * pn_Start_T_args            mode T, a tuple containing all arguments of *                                   the procedure.
Boris Boesler's avatar
Boris Boesler committed
434
435
436
437
438
439
 *
 *
 *    ir_node *new_End (void)
 *    -----------------------
 *
 *    Creates an end node.  Not actually needed public.  There is only one such
Götz Lindenmaier's avatar
Götz Lindenmaier committed
440
 *   node in each procedure which is automatically created by new_ir_graph.
Boris Boesler's avatar
Boris Boesler committed
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
 *
 *    Inputs:
 *      No inputs except the block it belongs to.
 *    Output:
 *      No output.
 *
 *    ir_node *new_Jmp (void)
 *    -----------------------
 *
 *    Creates a Jmp node.
 *
 *    Inputs:
 *      The block the node belongs to
 *    Output:
 *      Control flow to the next block.
 *
457
458
459
460
461
462
463
464
465
466
467
 *    ir_node *new_IJmp (ir_node *tgt)
 *    -----------------------
 *
 *    Creates an IJmp node.
 *
 *    Inputs:
 *      The node that represents the target jump address
 *    Output:
 *      Control flow to an unknown target, must be pinned by
 *      the End node.
 *
Boris Boesler's avatar
Boris Boesler committed
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 *    ir_node *new_Cond (ir_node *c)
 *    ------------------------------
 *
 *    Creates a Cond node.  There are two versions of this node.
 *
 *    The Boolean Cond:
 *    Input:
 *      A value of mode b.
 *    Output:
 *      A tuple of two control flows.  The first is taken if the input is
 *      false, the second if it is true.
 *
 *    The Switch Cond:
 *    Input:
 *      A value of mode I_u. (i)
 *    Output:
 *      A tuple of n control flows.  If the Cond's input is i, control
Michael Beck's avatar
Michael Beck committed
485
 *      flow will proceed along output i. If the input is >= n control
Boris Boesler's avatar
Boris Boesler committed
486
487
 *      flow proceeds along output n.
 *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
488
 *    ir_node *new_Return (ir_node *store, int arity, ir_node **in)
Boris Boesler's avatar
Boris Boesler committed
489
490
 *    -------------------------------------------------------------
 *
Michael Beck's avatar
Michael Beck committed
491
 *    The Return node has as inputs the results of the procedure.  It
Boris Boesler's avatar
Boris Boesler committed
492
493
494
495
496
497
498
499
500
 *    passes the control flow to the end_block.
 *
 *    Inputs:
 *      The memory state.
 *      All results.
 *    Output
 *      Control flow to the end block.
 *
 *
Matthias Braun's avatar
Matthias Braun committed
501
 *    ir_node *new_Const (ir_tarval *con)
Boris Boesler's avatar
Boris Boesler committed
502
503
504
 *    -----------------------------------------------
 *
 *    Creates a constant in the constant table and adds a Const node
505
506
 *    returning this value to the start block. The mode is derived
 *    from the tarval.
Boris Boesler's avatar
Boris Boesler committed
507
508
509
510
511
512
513
514
515
516
517
518
519
 *
 *    Parameters:
 *      *con             Points to an entry in the constant table.
 *                       This pointer is added to the attributes of
 *                       the node (self->attr.con)
 *    Inputs:
 *      No inputs except the block it belogns to.
 *    Output:
 *      The constant value.
 *    Attribute:
 *      attr.con   A tarval* pointer to the proper entry in the constant
 *                 table.
 *
520
 *    ir_node *new_SymConst (ir_mode *mode, union symconst_symbol value, symconst_addr_ent kind)
521
 *    -----------------------------------------------------------------------------------------
Boris Boesler's avatar
Boris Boesler committed
522
 *
523
 *    There are several symbolic constants:
524
525
 *     symconst_type_size  The symbolic constant represents the size of a type.
 *     symconst_type_align The symbolic constant represents the alignment of a type.
526
 *     symconst_addr_ent   The symbolic constant represents the address of an entity.
527
528
529
530
 *     symconst_ofs_ent    The symbolic constant represents the offset of an
 *                         entity in its owner type.
 *     symconst_enum_const The symbolic constant is a enumeration constant of an
 *                         enumeration type.
531
 *
Boris Boesler's avatar
Boris Boesler committed
532
 *    Parameters
533
534
535
536
 *      mode        P for SymConsts representing addresses, Iu otherwise.
 *      value       The type, ident, entity or enum constant, depending on the
 *                  kind
 *      kind        The kind of the symbolic constant, see the list above.
Boris Boesler's avatar
Boris Boesler committed
537
538
 *
 *    Inputs:
539
 *      No inputs except the block it belongs to.
Boris Boesler's avatar
Boris Boesler committed
540
 *    Output:
541
 *      A symbolic constant.
Boris Boesler's avatar
Boris Boesler committed
542
543
 *
 *    Attributes:
Götz Lindenmaier's avatar
Götz Lindenmaier committed
544
 *      attr.i.num       The symconst_addr_ent, i.e. one of
545
546
 *                        -symconst_type_size
 *                        -symconst_type_align
547
 *                        -symconst_addr_ent
548
 *
Matthias Braun's avatar
Matthias Braun committed
549
 *    If the attr.i.num is symconst_type_size or symconst_type_align,
550
551
 *    the node contains an attribute:
 *
552
 *      attr.i.*type,    a pointer to a type_class.
Boris Boesler's avatar
Boris Boesler committed
553
 *        if it is linkage_ptr_info it contains
554
 *      attr.i.*ptrinfo,  an ident holding information for the linker.
Boris Boesler's avatar
Boris Boesler committed
555
556
557
 *
 *    ---------------
 *
Michael Beck's avatar
Michael Beck committed
558
559
 *    ir_node *new_simpleSel (ir_node *store, ir_node *frame, ir_entity *sel)
 *    -----------------------------------------------------------------------
Boris Boesler's avatar
Boris Boesler committed
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 *
 *
 *    Selects an entity from a compound type. This entity can be a field or
 *    a method.
 *
 *    Parameters:
 *      *store     The memory in which the object the entity should be selected
 *                 from is allocated.
 *      *frame     The pointer to the object.
 *      *sel       The entity to select.
 *
 *    Inputs:
 *      The memory containing the object.
 *      A pointer to the object.
 *      An unsigned integer.
 *    Output:
 *      A pointer to the selected entity.
 *    Attributes:
 *      attr.sel   Pointer to the entity
 *
 *
 *    ir_node *new_Sel (ir_node *store, ir_node *frame, int arity, ir_node **in,
 *    --------------------------------------------------------------------------
Michael Beck's avatar
Michael Beck committed
583
584
 *                      ir_entity *sel)
 *                      ---------------
Boris Boesler's avatar
Boris Boesler committed
585
586
 *
 *    Selects a field from an array type.  The entity has as owner the array, as
Michael Beck's avatar
Michael Beck committed
587
 *    type the arrays element type.  The indices to access an array element are
Boris Boesler's avatar
Boris Boesler committed
588
589
590
591
592
593
 *    given also.
 *
 *    Parameters:
 *      *store     The memory in which the object the entity should be selected from
 *                 is allocated.
 *      *frame     The pointer to the object.
Michael Beck's avatar
Michael Beck committed
594
 *      *arity     number of array indices.
Boris Boesler's avatar
Boris Boesler committed
595
596
597
598
599
600
601
602
603
604
605
606
 *      *in        array with index inputs to the node.
 *      *sel       The entity to select.
 *
 *    Inputs:
 *      The memory containing the object.
 *      A pointer to the object.
 *      As much unsigned integer as there are array expressions.
 *    Output:
 *      A pointer to the selected entity.
 *    Attributes:
 *      attr.sel   Pointer to the entity
 *
607
 *    The constructors new_Sel and new_simpleSel generate the same IR nodes.
Boris Boesler's avatar
Boris Boesler committed
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
 *    simpleSel just sets the arity of the index inputs to zero.
 *
 *
 *    ARITHMETIC OPERATIONS
 *    ---------------------
 *
 *    ir_node *new_Call (ir_node *store, ir_node *callee, int arity, ir_node **in,
 *    ----------------------------------------------------------------------------
 *                       type_method *type)
 *                       ------------------
 *
 *    Creates a procedure call.
 *
 *    Parameters
 *      *store           The actual store.
 *      *callee          A pointer to the called procedure.
 *      arity            The number of procedure parameters.
 *      **in             An array with the pointers to the parameters.
 *                       The constructor copies this array.
 *      *type            Type information of the procedure called.
 *
 *    Inputs:
 *      The store, the callee and the parameters.
 *    Output:
 *      A tuple containing the eventually changed store and the procedure
 *      results.
 *    Attributes:
635
 *      attr.call        Contains the attributes for the procedure.
Boris Boesler's avatar
Boris Boesler committed
636
 *
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
 *    ir_node *new_Builtin(ir_node *store, ir_builtin_kind kind, int arity, ir_node **in,
 *    -----------------------------------------------------------------------------------
 *                       type_method *type)
 *                       ------------------
 *
 *    Creates a builtin call.
 *
 *    Parameters
 *      *store           The actual store.
 *      kind             Describes the called builtin.
 *      arity            The number of procedure parameters.
 *      **in             An array with the pointers to the parameters.
 *                       The constructor copies this array.
 *      *type            Type information of the procedure called.
 *
 *    Inputs:
 *      The store, the kind and the parameters.
 *    Output:
 *      A tuple containing the eventually changed store and the procedure
 *      results.
 *    Attributes:
 *      attr.builtin     Contains the attributes for the called builtin.
659
 *
Boris Boesler's avatar
Boris Boesler committed
660
661
662
663
664
665
666
667
668
669
670
671
672
 *    ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode)
 *    ------------------------------------------------------------
 *
 *    Trivial.
 *
 *    ir_node *new_Sub (ir_node *op1, ir_node *op2, ir_mode *mode)
 *    ------------------------------------------------------------
 *
 *    Trivial.
 *
 *    ir_node *new_Minus (ir_node *op, ir_mode *mode)
 *    -----------------------------------------------
 *
Michael Beck's avatar
Michael Beck committed
673
 *    Unary Minus operations on integer and floating point values.
Boris Boesler's avatar
Boris Boesler committed
674
675
676
677
678
679
 *
 *    ir_node *new_Mul (ir_node *op1, ir_node *op2, ir_mode *mode)
 *    ------------------------------------------------------------
 *
 *    Trivial.
 *
Michael Beck's avatar
Michael Beck committed
680
681
682
683
684
 *    ir_node *new_Mulh (ir_node *op1, ir_node *op2, ir_mode *mode)
 *    ------------------------------------------------------------
 *
 *    Returns the high order bits of a n*n=2n multiplication.
 *
685
686
 *    ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state)
 *    ------------------------------------------------------------------------------------------------
Boris Boesler's avatar
Boris Boesler committed
687
688
689
 *
 *    Trivial.
 *
690
691
 *    ir_node *new_Mod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state)
 *    ------------------------------------------------------------------------------------------------
Boris Boesler's avatar
Boris Boesler committed
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
 *
 *    Trivial.
 *
 *    ir_node *new_And (ir_node *op1, ir_node *op2, ir_mode *mode)
 *    ------------------------------------------------------------
 *
 *    Trivial.
 *
 *    ir_node *new_Or (ir_node *op1, ir_node *op2, ir_mode *mode)
 *    -----------------------------------------------------------
 *
 *    Trivial.
 *
 *    ir_node *new_Eor (ir_node *op1, ir_node *op2, ir_mode *mode)
 *    ------------------------------------------------------------
 *
 *    Trivial.
 *
 *    ir_node *new_Not (ir_node *op, ir_mode *mode)
 *    ---------------------------------------------
 *
 *    This node constructs a constant where all bits are set to one
 *    and a Eor of this constant and the operator.  This simulates a
 *    Not operation.
 *
 *    ir_node *new_Shl (ir_node *op, ir_node *k, ir_mode *mode)
 *    ---------------------------------------------------------
 *
 *    Trivial.
 *
 *    ir_node *new_Shr (ir_node *op, ir_node *k, ir_mode *mode)
 *    ---------------------------------------------------------
 *
 *    Logic shift right, i.e., zero extended.
 *
 *
 *    ir_node *new_Shrs (ir_node *op, ir_node *k, ir_mode *mode)
 *    ----------------------------------------------------------
 *
 *    Arithmetic shift right, i.e., sign extended.
 *
733
 *    ir_node *new_Rotl (ir_node *op, ir_node *k, ir_mode *mode)
Boris Boesler's avatar
Boris Boesler committed
734
735
 *    ---------------------------------------------------------
 *
736
 *    Rotates the operand to the left by k bits.
Boris Boesler's avatar
Boris Boesler committed
737
 *
738
739
740
741
742
743
744
745
746
747
748
749
 *    ir_node *new_Carry (ir_node *op1, ir_node *op2, ir_mode *mode)
 *    ------------------------------------------------------------
 *
 *    Calculates the Carry value for integer addition. Used only
 *    in lowering code.
 *
 *    ir_node *new_Borrow (ir_node *op1, ir_node *op2, ir_mode *mode)
 *    ------------------------------------------------------------
 *
 *    Calculates the Borrow value for integer substraction. Used only
 *    in lowering code.
 *
Boris Boesler's avatar
Boris Boesler committed
750
751
752
753
754
755
756
757
758
759
760
761
762
763
 *    ir_node *new_Conv (ir_node *op, ir_mode *mode)
 *    ---------------------------------------------
 *
 *    Mode conversion.  For allowed conversions see UKA Tech Report
 *    1999-14.
 *
 *    ir_node *new_Cmp (ir_node *op1, ir_node *op2)
 *    ---------------------------------------------
 *
 *    Input:
 *      The two values to be compared.
 *    Output:
 *      A 16-tuple containing the results of the 16 different comparisons.
 *      The following is a list giving the comparisons and a projection
Michael Beck's avatar
Michael Beck committed
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 *      number (pn_Cmp) to use in Proj nodes to extract the proper result.
 *        pn_Cmp_False false
 *        pn_Cmp_Eq    equal
 *        pn_Cmp_Lt    less
 *        pn_Cmp_Le    less or equal
 *        pn_Cmp_Gt    greater
 *        pn_Cmp_Ge    greater of equal
 *        pn_Cmp_Lg    less or greater
 *        pn_Cmp_Leg   less, equal or greater = ordered
 *        pn_Cmp_Uo    unordered
 *        pn_Cmp_Ue    unordered or equal
 *        pn_Cmp_Ul    unordered or less
 *        pn_Cmp_Ule   unordered, less or equal
 *        pn_Cmp_Ug    unordered or greater
 *        pn_Cmp_Uge   unordered, greater or equal
 *        pn_Cmp_Ne    unordered, less or greater = not equal
 *        pn_Cmp_True  true
Boris Boesler's avatar
Boris Boesler committed
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
 *
 *
 *
 *    ------------
 *
 *    In general, Phi nodes are automaitcally inserted.  In some cases, if
 *    all predecessors of a block are known, an explicit Phi node constructor
 *    is needed.  E.g., to construct a FIRM graph for a statement as
 *      a = (b==c) ? 2 : 5;
 *
 *    ir_node *new_Phi (int arity, ir_node **in, ir_mode *mode)
 *    ---------------------------------------------------------
 *
 *    Creates a Phi node. The in's order has to correspond to the order
 *    of in's of current_block.  This is not checked by the library!
796
797
 *    If one of the predecessors is Unknown (as it has to be filled in
 *    later) optimizations are skipped.  This is necessary to
798
 *    construct Phi nodes in loops.
Boris Boesler's avatar
Boris Boesler committed
799
800
801
802
 *
 *    Parameter
 *      arity            number of predecessors
 *      **in             array with predecessors
803
 *      *mode            The mode of its inputs and output.
Boris Boesler's avatar
Boris Boesler committed
804
805
806
807
808
809
810
 *    Inputs:
 *      A Phi node has as many inputs as the block it belongs to.
 *      Each input points to a definition of the same value on a
 *      different path in the control flow.
 *    Output
 *      The definition valid in this block.
 *
811
 *    ir_node *new_Mux (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode)
812
 *    -----------------------------------------------------------------------------------
813
814
815
816
817
 *
 *    Creates a Mux node. This node implements the following semantic:
 *    If the sel node (which must be of mode_b) evaluates to true, its value is
 *    ir_true, else ir_false;
 *
Boris Boesler's avatar
Boris Boesler committed
818
 *
819
 *
Boris Boesler's avatar
Boris Boesler committed
820
821
822
 *    OPERATIONS TO MANAGE MEMORY EXPLICITLY
 *    --------------------------------------
 *
823
824
 *    ir_node *new_Load (ir_node *store, ir_node *addr, ir_mode *mode, ir_cons_flags flags)
 *    -------------------------------------------------------------------------------------
Boris Boesler's avatar
Boris Boesler committed
825
826
827
828
829
830
 *
 *    The Load operation reads a value from memory.
 *
 *    Parameters:
 *    *store        The current memory.
 *    *addr         A pointer to the variable to be read in this memory.
831
 *    *mode         The mode of the value to be loaded.
832
 *     flags        Additional flags for alignment, volatility and pin state.
Boris Boesler's avatar
Boris Boesler committed
833
834
835
836
837
838
839
 *
 *    Inputs:
 *      The memory and a pointer to a variable in this memory.
 *    Output:
 *      A tuple of the memory, a control flow to be taken in case of
 *      an exception and the loaded value.
 *
840
841
 *    ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val, ir_cons_flags flags)
 *    -------------------------------------------------------------------------------------
Boris Boesler's avatar
Boris Boesler committed
842
843
844
845
846
847
848
849
850
851
 *
 *    The Store operation writes a value to a variable in memory.
 *
 *    Inputs:
 *      The memory, a pointer to a variable in this memory and the value
 *      to write to this variable.
 *    Output:
 *      A tuple of the changed memory and a control flow to be taken in
 *      case of an exception.
 *
852
 *    ir_node *new_Alloc (ir_node *store, ir_node *count, ir_type *alloc_type,
Michael Beck's avatar
Michael Beck committed
853
 *    -----------------------------------------------------------------------
Boris Boesler's avatar
Boris Boesler committed
854
855
856
857
858
859
860
861
 *                        where_alloc where)
 *                        ------------------
 *
 *    The Alloc node allocates a new variable.  It can be specified whether the
 *    variable should be allocated to the stack or to the heap.
 *
 *    Parameters:
 *      *store       The memory which shall contain the new variable.
862
863
864
865
866
 *      *count       This field is for allocating arrays, it specifies how
 *                   many array elements are to be allocated.
 *      *alloc_type  The type of the allocated variable. In case of allocating
 *                   arrays this has to be the array type, not the type of the
 *                   array elements.
Boris Boesler's avatar
Boris Boesler committed
867
868
869
870
871
872
873
874
875
876
877
878
 *      where        Where to allocate the variable, either heap_alloc or stack_alloc.
 *
 *    Inputs:
 *      A memory and an unsigned integer.
 *    Output:
 *      A tuple of the changed memory, a control flow to be taken in
 *      case of an exception and the pointer to the new variable.
 *    Attributes:
 *      a.where          Indicates where the variable is allocated.
 *      a.*type          A pointer to the class the allocated data object
 *                       belongs to.
 *
Michael Beck's avatar
Michael Beck committed
879
880
 *    ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size, ir_type *free_type,
 *    -----------------------------------------------------------------------------------
881
882
 *                        where_alloc where)
 *                        ------------------
Boris Boesler's avatar
Boris Boesler committed
883
884
885
886
887
888
889
890
 *
 *    The Free node frees memory of the given variable.
 *
 *    Parameters:
 *      *store       The memory which shall contain the new variable.
 *      *ptr         The pointer to the object to free.
 *      *size        The number of objects of type free_type to free in a sequence.
 *      *free_type   The type of the freed variable.
891
 *      where        Where the variable was allocated, either heap_alloc or stack_alloc.
Boris Boesler's avatar
Boris Boesler committed
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 *
 *    Inputs:
 *      A memory, a pointer and an unsigned integer.
 *    Output:
 *      The changed memory.
 *    Attributes:
 *      f.*type          A pointer to the type information of the freed data object.
 *
 *    Not Implemented!
 *
 *    ir_node *new_Sync (int arity, ir_node **in)
 *    -------------------------------------------
 *
 *    The Sync operation unifies several partial memory blocks.  These blocks
 *    have to be pairwise disjunct or the values in common locations have to
 *    be identical.  This operation allows to specify all operations that eventually
 *    need several partial memory blocks as input with a single entrance by
 *    unifying the memories with a preceding Sync operation.
 *
 *    Parameters
Michael Beck's avatar
Michael Beck committed
912
 *      arity    The number of memories to synchronize.
Boris Boesler's avatar
Boris Boesler committed
913
914
915
916
917
918
919
920
921
922
923
 *      **in     An array of pointers to nodes that produce an output of
 *               type memory.
 *    Inputs
 *      Several memories.
 *    Output
 *      The unified memory.
 *
 *
 *    SPECIAL OPERATIONS
 *    ------------------
 *
924
925
926
927
928
929
930
 *    ir_node *new_NoMem (void)
 *    -----------------------------------------------------------------------------------
 *
 *    Returns the unique NoMem node current_ir_graph->no_mem.
 *    This node is used as input for operations that need a Memory, but do not
 *    change it like Div by const != 0, analyzed calls etc.
 *
Boris Boesler's avatar
Boris Boesler committed
931
932
933
 *    ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj)
 *    ----------------------------------------------------------
 *
934
 *    Selects one entry of a tuple.  This is a hidden edge with attributes.
Boris Boesler's avatar
Boris Boesler committed
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
 *
 *    Parameters
 *      *arg      A node producing a tuple.
 *      *mode     The mode of the value to project.
 *      proj      The position of the value in the tuple.
 *    Input:
 *      The tuple.
 *    Output:
 *      The value.
 *
 *    ir_node *new_Tuple (int arity, ir_node **in)
 *    --------------------------------------------
 *
 *    Builds a Tuple from single values.  This is needed to implement
 *    optimizations that remove a node that produced a tuple.  The node can be
 *    replaced by the Tuple operation so that the following Proj nodes have not to
 *    be changed.  (They are hard to find due to the implementation with pointers
 *    in only one direction.)  The Tuple node is smaller than any other
953
 *    node, so that a node can be changed into a Tuple by just changing its
Boris Boesler's avatar
Boris Boesler committed
954
955
956
957
958
959
960
961
962
963
 *    opcode and giving it a new in array.
 *
 *    Parameters
 *      arity    The number of tuple elements.
 *      **in     An array containing pointers to the nodes producing the
 *               tuple elements.
 *
 *    ir_node *new_Id (ir_node *val, ir_mode *mode)
 *    ---------------------------------------------
 *
964
 *    The single output of the Id operation is its input.  Also needed
Boris Boesler's avatar
Boris Boesler committed
965
966
967
 *    for optimizations.
 *
 *
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 *    HIGH LEVEL OPERATIONS
 *    ---------------------
 *
 *    ir_node *new_CopyB (ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type)
 *    -----------------------------------------------------------------------------------
 *
 *    Describes a high level block copy of a compound type from address src to
 *    address dst. Must be lowered to a Call to a runtime memory copy function.
 *
 *
 *    HIGH LEVEL OPERATIONS: Exception Support
 *    ----------------------------------------
 *    See TechReport 1999-14, chapter Exceptions.
 *
 *    ir_node *new_InstOf(ir_node *store, ir_node *ptr, ir_type *type);
 *    -----------------------------------------------------------------------------------
 *
 *    Describes a high level type check. Must be lowered to a Call to a runtime check
 *    function.
 *
 *    ir_node *new_Raise (ir_node *store, ir_node *obj)
 *    -------------------------------------------------
 *
 *    Raises an exception.  Unconditional change of control flow.  Writes
 *    an explicit Except variable to memory to pass it to the exception
 *    handler.  Must be lowered to a Call to a runtime check
 *    function.
 *
 *    Inputs:
 *      The memory state.
 *      A pointer to the Except variable.
 *    Output:
 *      A tuple of control flow and the changed memory state.  The control flow
 *      points to the exception handler if it is definied in this procedure,
 *      else it points to the end_block.
 *
 *    ir_node *new_Bound  (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
 *    -----------------------------------------------------------------------------------
 *
 *    Describes a high level bounds check. Must be lowered to a Call to a runtime check
 *    function.
 *
Michael Beck's avatar
Michael Beck committed
1010
1011
1012
1013
1014
1015
1016
 *    ir_node *new_Pin  (ir_node *node);
 *    -----------------------------------------------------------------------------------
 *
 *    Pin the value of the node node in the current block  No users of the Pin node can
 *    float above the Block of the Pin. The node cannot float behind this block. Often
 *    used to Pin the NoMem node.
 *
1017
 *
Boris Boesler's avatar
Boris Boesler committed
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
 *    COPING WITH DATA OBJECTS
 *    ========================
 *
 *    Two kinds of data objects have to be distinguished for generating
 *    FIRM.  First there are local variables other than arrays that are
 *    known to be alias free.  Second there are all other data objects.
 *    For the first a common SSA representation is built, the second
 *    are modeled by saving them to memory.  The memory is treated as
 *    a single local variable, the alias problem is hidden in the
 *    content of this variable.
 *
 *    All values known in a Block are listed in the block's attribute,
 *    block.**graph_arr which is used to automatically insert Phi nodes.
Michael Beck's avatar
Michael Beck committed
1031
 *    The following two functions can be used to add a newly computed value
Boris Boesler's avatar
Boris Boesler committed
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
 *    to the array, or to get the producer of a value, i.e., the current
 *    live value.
 *
 *    inline void set_value (int pos, ir_node *value)
 *    -----------------------------------------------
 *
 *    Has to be called for every assignment to a local variable.  It
 *    adds the value to the array of used values at position pos.  Pos
 *    has to be a unique identifier for an entry in the procedure's
 *    definition table.  It can be used to access the value again.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1042
 *    Requires current_block to be set correctly.
Boris Boesler's avatar
Boris Boesler committed
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
 *
 *    ir_node *get_value (int pos, ir_mode *mode)
 *    -------------------------------------------
 *
 *    Returns the node defining the value referred to by pos. If the
 *    value is not defined in this block a Phi node is generated and
 *    all definitions reaching this Phi node are collected.  It can
 *    happen that the algorithm allocates an unnecessary Phi node,
 *    e.g. if there is only one definition of this value, but this
 *    definition reaches the currend block on several different
 *    paths.  This Phi node will be eliminated if optimizations are
1054
 *    turned on right after its creation.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1055
 *    Requires current_block to be set correctly.
Boris Boesler's avatar
Boris Boesler committed
1056
1057
1058
 *
 *    There are two special routines for the global store:
 *
Michael Beck's avatar
Michael Beck committed
1059
1060
 *    void set_store (ir_node *store)
 *    -------------------------------
Boris Boesler's avatar
Boris Boesler committed
1061
1062
1063
 *
 *    Adds the store to the array of known values at a reserved
 *    position.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1064
 *    Requires current_block to be set correctly.
Boris Boesler's avatar
Boris Boesler committed
1065
 *
Michael Beck's avatar
Michael Beck committed
1066
1067
 *    ir_node *get_store (void)
 *    -------------------------
Boris Boesler's avatar
Boris Boesler committed
1068
1069
 *
 *    Returns the node defining the actual store.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1070
 *    Requires current_block to be set correctly.
1071
1072
1073
1074
1075
1076
1077
 *
 *
 *    inline void keep_alive (ir_node *ka)
 *    ------------------------------------
 *
 *    Keep this node alive because it is (might be) not in the control
 *    flow from Start to End.  Adds the node to the list in the end
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1078
 *   node.
1079
 *
Boris Boesler's avatar
Boris Boesler committed
1080
 */
Matthias Braun's avatar
Matthias Braun committed
1081
1082
#ifndef FIRM_IR_IRCONS_H
#define FIRM_IR_IRCONS_H
Christian Schäfer's avatar
Christian Schäfer committed
1083

Matthias Braun's avatar
Matthias Braun committed
1084
#include "firm_types.h"
1085
#include "begin.h"
1086
#include "irnode.h"
Christian Schäfer's avatar
Christian Schäfer committed
1087

Michael Beck's avatar
Michael Beck committed
1088
/*-------------------------------------------------------------------------*/
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1089
/* The raw interface                                                       */
Michael Beck's avatar
Michael Beck committed
1090
/*-------------------------------------------------------------------------*/
Christian Schäfer's avatar
Christian Schäfer committed
1091

1092
1093
/**
 * Constructor for a Const node.
yb9976's avatar
yb9976 committed
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
 *
 * Adds the node to the start block.
 *
 * Constructor for a Const node. The constant represents a target
 * value.  Sets the type information to type_unknown.  (No more
 * supported: If tv is entity derives a somehow useful type.)
 *
 * @param *db    A pointer for debug information.
 * @param *irg   The IR graph the node  belongs to.
 * @param *mode  The mode of the operands and results.
 * @param value  A value from which the tarval is made.
 */
Michael Beck's avatar
Michael Beck committed
1106
FIRM_API ir_node *new_rd_Const_long(dbg_info *db, ir_graph *irg,
1107
                                    ir_mode *mode, long value);
yb9976's avatar
yb9976 committed
1108

1109
/** Constructor for a SymConst node.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1110
1111
 *
 *  This is the constructor for a symbolic constant.
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
 *    There are several kinds of symbolic constants:
 *    - symconst_type_size  The symbolic constant represents the size of a type.
 *                          The type of which the constant represents the size
 *                          is given explicitly.
 *    - symconst_type_align The symbolic constant represents the alignment of a
 *                          type.  The type of which the constant represents the
 *                          size is given explicitly.
 *    - symconst_addr_ent   The symbolic constant represents the address of an
 *                          entity (variable or method).  The variable is given
 *                          explicitly by a firm entity.
 *    - symconst_ofs_ent    The symbolic constant represents the offset of an
 *                          entity in its owner type.
 *    - symconst_enum_const The symbolic constant is a enumeration constant of
 *                          an enumeration type.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1126
1127
 *
 *    Inputs to the node:
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1128
 *      No inputs except the block it belongs to.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1129
1130
1131
 *    Outputs of the node.
 *      An unsigned integer (I_u) or a pointer (P).
 *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1132
1133
1134
 *    Mention union in declaration so that the firmjni generator recognizes that
 *    it can not cast the argument to an int.
 *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1135
 * @param *db     A pointer for debug information.
1136
1137
 * @param *irg    The IR graph the node  belongs to.
 * @param mode    The mode for the SymConst.
Matthias Braun's avatar
Matthias Braun committed
1138
 * @param value   A type, ident, entity or enum constant depending on the
1139
1140
 *                SymConst kind.
 * @param kind    The kind of the symbolic constant, see the list above
1141
 */
Michael Beck's avatar
Michael Beck committed
1142
FIRM_API ir_node *new_rd_SymConst(dbg_info *db, ir_graph *irg, ir_mode *mode,
1143
1144
                                  union symconst_symbol value,
                                  symconst_kind kind);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1145
1146
1147

/** Constructor for a SymConst addr_ent node.
 *
1148
 * Same as new_rd_SymConst, except that the constructor is tailored for
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1149
 * symconst_addr_ent.
Michael Beck's avatar
Michael Beck committed
1150
 * Adds the SymConst to the start block of irg. */
Michael Beck's avatar
Michael Beck committed
1151
FIRM_API ir_node *new_rd_SymConst_addr_ent(dbg_info *db, ir_graph *irg,
1152
                                           ir_mode *mode, ir_entity *symbol);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1153

1154
1155
/** Constructor for a SymConst ofs_ent node.
 *
1156
 * Same as new_rd_SymConst, except that the constructor is tailored for
1157
 * symconst_ofs_ent.
1158
1159
 * Adds the SymConst to the start block of irg.
 */
Michael Beck's avatar
Michael Beck committed
1160
FIRM_API ir_node *new_rd_SymConst_ofs_ent(dbg_info *db, ir_graph *irg,
1161
                                          ir_mode *mode, ir_entity *symbol);
1162

Götz Lindenmaier's avatar
Götz Lindenmaier committed
1163
1164
/** Constructor for a SymConst size node.
 *
1165
 * Same as new_rd_SymConst, except that the constructor is tailored for
1166
 * symconst_type_size.
Michael Beck's avatar
Michael Beck committed
1167
 * Adds the SymConst to the start block of irg. */
Michael Beck's avatar
Michael Beck committed
1168
FIRM_API ir_node *new_rd_SymConst_size(dbg_info *db, ir_graph *irg,
1169
                                       ir_mode *mode, ir_type *symbol);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1170

1171
1172
/** Constructor for a SymConst size node.
 *
1173
 * Same as new_rd_SymConst, except that the constructor is tailored for
1174
 * symconst_type_align.
1175
1176
 * Adds the SymConst to the start block of irg.
 */
Michael Beck's avatar
Michael Beck committed
1177
FIRM_API ir_node *new_rd_SymConst_align(dbg_info *db, ir_graph *irg,
1178
                                        ir_mode *mode, ir_type *symbol);
1179

1180
1181
1182
1183
1184
1185
1186
/** Constructor for a simpleSel node.
 *
 *  This is a shortcut for the new_rd_Sel() constructor.  To be used for
 *  Sel nodes that do not select from an array, i.e., have no index
 *  inputs.  It adds the two parameters 0, NULL.
 *
 * @param   *db        A pointer for debug information.
1187
 * @param   *block     The IR block the node belongs to.
1188
1189
1190
1191
1192
1193
 * @param   *store     The memory in which the object the entity should be
 *                     selected from is allocated.
 * @param   *objptr    The object from that the Sel operation selects a
 *                     single attribute out.
 * @param   *ent       The entity to select.
 */
Michael Beck's avatar
Michael Beck committed
1194
FIRM_API ir_node *new_rd_simpleSel(dbg_info *db, ir_node *block, ir_node *store,
1195
                                   ir_node *objptr, ir_entity *ent);
1196

1197
/** Constructor for a remainderless Div node.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1198
1199
 *
 * @param   *db    A pointer for debug information.
1200
 * @param   *block The IR block the node belongs to.
1201
 * @param   *memop The store needed to model exceptions
Michael Beck's avatar
Michael Beck committed
1202
1203
 * @param   *op1   The first operand.
 * @param   *op2   The second operand.
1204
1205
 * @param   *mode  The mode of the result.
 * @param   state  The pinned state.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1206
 */
1207
1208
1209
FIRM_API ir_node *new_rd_DivRL(dbg_info *db, ir_node *block, ir_node *memop,
                               ir_node *op1, ir_node *op2, ir_mode *mode,
                               op_pin_state state);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1210

1211
/** Constructor for a strictConv node.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1212
1213
 *
 * @param   *db    A pointer for debug information.
1214
 * @param   *block The IR block the node belongs to.
1215
1216
 * @param   *op    The operand.
 * @param   *mode  The mode of this the operand muss be converted .
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1217
 */
1218
1219
FIRM_API ir_node *new_rd_strictConv(dbg_info *db, ir_node *block,
                                    ir_node *op, ir_mode *mode);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1220

1221
/** Constructor for an ASM pseudo node.
Michael Beck's avatar
Michael Beck committed
1222
 *
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
 * @param *db         A pointer for debug information.
 * @param *block      The block the node belong to.
 * @param arity       The number of data inputs to the node.
 * @param *in         The array of length arity of data inputs.
 * @param *inputs     The array of length arity of input constraints.
 * @param n_outs      The number of data outputs to the node.
 * @param *outputs    The array of length n_outs of output constraints.
 * @param n_clobber   The number of clobbered registers.
 * @param *clobber    The array of length n_clobber of clobbered registers.
 * @param *asm_text   The assembler text.
Michael Beck's avatar
Michael Beck committed
1233
 */
1234
1235
FIRM_API ir_node *new_rd_ASM(dbg_info *db, ir_node *block,
                            int arity, ir_node *in[], ir_asm_constraint *inputs,
1236
1237
1238
                            size_t n_outs, ir_asm_constraint *outputs,
                            size_t n_clobber, ident *clobber[],
                            ident *asm_text);
Michael Beck's avatar
Michael Beck committed
1239

1240
1241
1242
/*-------------------------------------------------------------------------*/
/* The raw interface without debug support                                 */
/*-------------------------------------------------------------------------*/
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1243

1244
/** Constructor for a Const node.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1245
 *
1246
 * Adds the node to the start block.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1247
 *
1248
1249
1250
 * Constructor for a Const node. The constant represents a target
 * value.  Sets the type information to type_unknown.  (No more
 * supported: If tv is entity derives a somehow useful type.)
1251
 *
1252
1253
1254
 * @param *irg   The IR graph the node  belongs to.
 * @param *mode  The mode of the operands and the results.
 * @param value  A value from which the tarval is made.
1255
 */
1256
FIRM_API ir_node *new_r_Const_long(ir_graph *irg, ir_mode *mode, long value);
1257

1258
/** Constructor for a SymConst node.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1259
 *
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
 *  This is the constructor for a symbolic constant.
 *    There are several kinds of symbolic constants:
 *    - symconst_type_size  The symbolic constant represents the size of a type.
 *                          The type of which the constant represents the size
 *                          is given explicitly.
 *    - symconst_type_align The symbolic constant represents the alignment of a
 *                          type.  The type of which the constant represents the
 *                          size is given explicitly.
 *    - symconst_addr_ent   The symbolic constant represents the address of an
 *                          entity (variable or method).  The variable is given
 *                          explicitly by a firm entity.
 *    - symconst_ofs_ent    The symbolic constant represents the offset of an
 *                          entity in its owner type.
 *    - symconst_enum_const The symbolic constant is a enumeration constant of
 *                          an enumeration type.
 *
 *    Inputs to the node:
 *      No inputs except the block it belongs to.
 *    Outputs of the node.
 *      An unsigned integer (I_u) or a pointer (P).
 *
 *    Mention union in declaration so that the firmjni generator recognizes that
 *    it can not cast the argument to an int.
 *
 * @param *irg    The IR graph the node  belongs to.
 * @param mode    The mode for the SymConst.
 * @param value   A type, ident, entity or enum constant depending on the
 *                SymConst kind.
 * @param kind    The kind of the symbolic constant, see the list above
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1289
 */
1290
1291
1292
FIRM_API ir_node *new_r_SymConst(ir_graph *irg, ir_mode *mode,
                                 union symconst_symbol value,
                                 symconst_kind kind);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1293

1294
/** Constructor for a simpleSel node.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1295
 *
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
 *  This is a shortcut for the new_d_Sel() constructor.  To be used for
 *  Sel nodes that do not select from an array, i.e., have no index
 *  inputs.  It adds the two parameters 0, NULL.
 *
 * @param *block     The IR block the node belongs to.
 * @param *store     The memory in which the object the entity should be selected
 *                   from is allocated.
 * @param *objptr    The object from that the Sel operation selects a
 *                   single attribute out.
 * @param *ent       The entity to select.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1306
 */
1307
1308
FIRM_API ir_node *new_r_simpleSel(ir_node *block, ir_node *store,
                                  ir_node *objptr, ir_entity *ent);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1309

1310
/** Constructor for a remainderless Div node.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1311
 *
1312
1313
1314
1315
1316
1317
 * @param *block The IR block the node belongs to.
 * @param *memop The store needed to model exceptions
 * @param *op1   The first operand.
 * @param *op2   The second operand.
 * @param *mode  The mode of the result.
 * @param state  The pinned state.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1318
 */
1319
1320
1321
1322
FIRM_API ir_node *new_r_DivRL(ir_node *block, ir_node *memop,
                              ir_node *op1, ir_node *op2, ir_mode *mode,
                              op_pin_state state);
/** Constructor for a strict Conv node.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1323
 *
1324
1325
1326
 * @param *block The IR block the node belongs to.
 * @param *op    The operand.
 * @param *mode  The mode of this the operand muss be converted .
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1327
 */
1328
FIRM_API ir_node *new_r_strictConv(ir_node *block, ir_node *op, ir_mode *mode);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1329

1330
/** Constructor for an ASM pseudo node.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1331
 *
Michael Beck's avatar
Michael Beck committed
1332
1333
 * @param *block      The block the node belong to.
 * @param arity       The number of data inputs to the node.
Michael Beck's avatar
Michael Beck committed
1334
1335
1336
1337
 * @param *in         The array of length arity of data inputs.
 * @param *inputs     The array of length arity