added Id tag
[libfirm] / ir / ir / irnode.h
1 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
2 ** All rights reserved.
3 **
4 ** Authors: Martin Trapp, Christian Schaefer
5 **
6 ** declarations of an ir node
7 */
8
9 /* $Id$ */
10
11 # ifndef _IRNODE_H_
12 # define _IRNODE_H_
13
14 # include "irgraph.h"
15 # include "entity.h"
16 # include "common.h"
17 # include "irop.h"
18 # include "irmode.h"
19 # include "tv.h"
20 # include "type.h"
21
22 /* The typedefiniton of ir_node is also in irgraph.h to resolve
23    recursion between irnode.h and irgraph.h */
24 #ifndef _IR_NODE_TYPEDEF_
25 #define _IR_NODE_TYPEDEF_
26 /****s* irnode/irnode
27  *
28  * NAME ir_node - a datatype representing a Firm node
29  *
30  * NOTE Not properly documented ;-)
31  *
32  * ATTRIBUTES
33  *  The common fields are:
34  *
35  *  firm_kind    A firm_kind tag containing k_type.  This is useful
36  *               for dynamically checking whether a node is a ir_node.
37  *  arity        The number of predecessors in the Firm graph.
38  *  in           A list with the predecessors in the Firm graph.  There are
39  *               routines to access individual elements and to obtain the
40  *               array.  The method returning the array should not be used.
41  *  mode         The mode of the node.  There are routines to get the mode but
42  *               also to access the mode's fields directly.
43  *  opcode       The opcode of the node.  There are routines to get the opcode but
44  *               also to access the opcode's fields directly.
45  *  node_nr      A unique number for the node.  Available only if debugging is
46  *               turned on.
47  * SOURCE
48  */
49 typedef struct ir_node ir_node;
50 #endif
51
52 /** Manipulate the fields of ir_node.  With these access routines
53     you can work on the graph without considering the different types
54     of nodes, it's just a big graph. **/
55
56 /* returns the number of predecessors without the block predecessor: */
57 int                  get_irn_arity         (ir_node *node);
58 /* returns the array with the ins: */
59 inline ir_node     **get_irn_in            (ir_node *node);
60 /* Replaces the old in array by a new one that will contain the ins given in
61    the parameters.  It copies the array passed.
62    This function is necessary to ajust in arrays of blocks, calls and phis.
63    Assumes the current_ir_graph is set to the graph containing "node".
64    "in" must contain all predecessors except the block that are required for
65    the nodes opcode. */
66 inline void          set_irn_in            (ir_node *node, int arity,
67                                             ir_node **in);
68 /* to iterate through the predecessors without touching the array. No
69    order of predecessors guaranteed.
70    To iterate over the operands iterate from 0 to i < get_irn_arity(),
71    to iterate including the Block predecessor iterate from i = -1 to
72    i < get_irn_arity. */
73 /* Access predecessor n */
74 inline ir_node      *get_irn_n             (ir_node *node, int n);
75 inline void          set_irn_n             (ir_node *node, int n, ir_node *in);
76 /* Get the mode struct. */
77 inline ir_mode      *get_irn_mode          (ir_node *node);
78 /* Get the mode-enum modecode */
79 inline modecode      get_irn_modecode      (ir_node *node);
80 /* Get the ident for a string representation of the mode */
81 inline ident        *get_irn_modeident     (ir_node *node);
82 /* Access the opcode struct of the node */
83 inline ir_op        *get_irn_op            (ir_node *node);
84 inline void          set_irn_op            (ir_node *node, ir_op *op);
85 /* Get the opcode-enum of the node */
86 inline opcode        get_irn_opcode        (ir_node *node);
87 /* Get the ident for a string representation of the opcode */
88 inline ident        *get_irn_opident       (ir_node *node);
89 /* Get the string representation of the opcode */
90 inline const char   *get_irn_opname        (ir_node *node);
91 inline void          set_irn_visited (ir_node *node, unsigned long visited);
92 inline unsigned long get_irn_visited (ir_node *node);
93 inline void          set_irn_link          (ir_node *node, ir_node *link);
94 inline ir_node      *get_irn_link          (ir_node *node);
95 #ifdef DEBUG_libfirm
96 /* Outputs a unique number for this node */
97 inline long get_irn_node_nr(ir_node *node);
98 #endif
99 /*****/
100
101 /* irnode constructor                                             */
102 /* Create a new irnode in irg, with an op, mode, arity and        */
103 /* some incoming irnodes.                                         */
104 /* If arity is negative, a node with a dynamic array is created.  */
105
106 inline ir_node *
107 new_ir_node (ir_graph *irg,
108              ir_node *block,
109              ir_op *op,
110              ir_mode *mode,
111              int arity,
112              ir_node **in);
113
114 /****s* irnode/other
115  *
116  * NAME access functions for node fields.
117  *
118  * NOTE Not properly documented ;-)
119  *
120  * SOURCE
121  */
122
123 /* this works for all except Block */
124 inline ir_node  *get_nodes_Block (ir_node *node);
125 inline void      set_nodes_Block (ir_node *node, ir_node *block);
126
127 /* Projection numbers for result of Start node: use for Proj nodes! */
128 typedef enum {
129   pns_initial_exec,     /* Projection on an executable, the initial control
130                            flow. */
131   pns_global_store,     /* Projection on the global store */
132   pns_frame_base,       /* Projection on the frame base */
133   pns_globals,          /* Projection on the pointer to the data segment
134                            containing _all_ global entities. */
135   pns_args              /* Projection on all arguments */
136 } pns_number;
137
138 inline ir_node **get_Block_cfgpred_arr (ir_node *node);
139 int              get_Block_n_cfgpreds (ir_node *node);
140 /* inline void    set_Block_n_cfgpreds (ir_node *node, int n_preds); */
141 inline ir_node  *get_Block_cfgpred (ir_node *node, int pos);
142 inline void      set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
143 inline bool      get_Block_matured (ir_node *node);
144 inline void      set_Block_matured (ir_node *node, bool matured);
145 inline unsigned long get_Block_block_visited (ir_node *node);
146 inline void      set_Block_block_visited (ir_node *node, unsigned long visit);
147 inline ir_node  *get_Block_graph_arr (ir_node *node, int pos);
148 inline void      set_Block_graph_arr (ir_node *node, int pos, ir_node *value);
149
150
151 /* We distinguish three kinds of Cond nodes.  These can be distinguished
152    by the mode of the selector operand and an internal flag of type cond_kind.
153    First we distinguish binary Conds and switch Conds.
154    A binary Cond has as selector a boolean value.  Proj(0) projects the control
155    flow for case "False", Proj(1) the control flow for "True".  A binary Cond
156    is recognized by the boolean selector.
157    The switch Cond has as selector an unsigned integer.  It produces as result
158    an n+1 Tuple (cf0, ... , cfn) of control flows.
159    We differ two flavours of this Cond.  The first, the dense Cond, passes
160    control along output i if the selector value is i, 0 <= i <= n.  If the
161    selector value is >n it passes control along output n.
162    The second Cond flavor differes in the treatment of cases not specified in
163    the source program.  It magically knows about the existence of Proj nodes.
164    It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
165    exists.  Else it passes control along output n (even if this Proj does not
166    exist.)  This Cond we call "fragmentary".  There is a special constructor
167    new_defaultProj that automatically sets the flavor.
168    The two switch flavors are distinguished by a flag of type cond_kind.
169    Default flavor is "dense"
170 */
171 typedef enum {
172   dense,        /* Default. Missing Proj nodes are dead control flow. */
173   fragmentary   /* Special. No control flow optimizations allowed.  Missing
174                    Proj nodes mean default control flow, i.e., Proj(n). */
175 } cond_kind;
176
177 inline ir_node  *get_Cond_selector (ir_node *node);
178 inline void      set_Cond_selector (ir_node *node, ir_node *selector);
179 inline cond_kind get_Cond_kind (ir_node *node);
180 inline void      set_Cond_kind (ir_node *node, cond_kind kind);
181
182 inline ir_node  *get_Return_mem (ir_node *node);
183 inline void      set_Return_mem (ir_node *node, ir_node *mem);
184 inline ir_node **get_Return_res_arr (ir_node *node);
185 inline int       get_Return_n_res (ir_node *node);
186 /*inline void     set_Return_n_res (ir_node *node, int results); */
187 inline ir_node  *get_Return_res (ir_node *node, int pos);
188 inline void      set_Return_res (ir_node *node, int pos, ir_node *res);
189
190 inline ir_node *get_Raise_mem (ir_node *node);
191 inline void     set_Raise_mem (ir_node *node, ir_node *mem);
192 inline ir_node *get_Raise_exo_ptr (ir_node *node);  /* PoinTeR to EXception Object */
193 inline void     set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
194
195 inline tarval  *get_Const_tarval (ir_node *node);
196 inline void     set_Const_tarval (ir_node *node, tarval *con);
197
198 /*   This enum names the three different kinds of symbolic Constants
199      represented by SymConst.  The content of the attribute type_or_id
200      depends on this tag.  Use the proper access routine after testing
201      this flag. */
202 typedef enum {
203   type_tag,          /* The SymConst is a type tag for the given type.
204                         Type_or_id_p is type *. */
205   size,              /* The SymConst is the size of the given type.
206                         Type_or_id_p is type *. */
207   linkage_ptr_info   /* The SymConst is a symbolic pointer to be filled in
208                         by the linker. Type_or_id_p is ident *. */
209 } symconst_kind;
210 typedef union type_or_id * type_or_id_p;
211 inline symconst_kind get_SymConst_kind (ir_node *node);
212 inline void          set_SymConst_kind (ir_node *node, symconst_kind num);
213 /* Only to access SymConst of kind type_tag or size.  Else assertion: */
214 inline type    *get_SymConst_type (ir_node *node);
215 inline void     set_SymConst_type (ir_node *node, type *type);
216 /* Only to access SymConst of kind linkage_ptr_info.  Else assertion: */
217 inline ident   *get_SymConst_ptrinfo (ir_node *node);
218 inline void     set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
219 /* Sets both: type and ptrinfo.  Needed to treat the node independent of
220    its semantics.  Does a memcpy for the memory tori points to. */
221 inline type_or_id_p get_SymConst_type_or_id (ir_node *node);
222 inline void set_SymConst_type_or_id (ir_node *node, type_or_id_p tori);
223
224 inline ir_node *get_Sel_mem (ir_node *node);
225 inline void     set_Sel_mem (ir_node *node, ir_node *mem);
226 inline ir_node *get_Sel_ptr (ir_node *node);  /* ptr to the object to select from */
227 inline void     set_Sel_ptr (ir_node *node, ir_node *ptr);
228 inline ir_node **get_Sel_index_arr (ir_node *node);
229 inline int      get_Sel_n_index (ir_node *node);
230 /*inline void     set_Sel_n_index (ir_node *node, int n_index); */
231 inline ir_node *get_Sel_index (ir_node *node, int pos);
232 inline void     set_Sel_index (ir_node *node, int pos, ir_node *index);
233 inline entity  *get_Sel_entity (ir_node *node); /* entity to select */
234 inline void     set_Sel_entity (ir_node *node, entity *ent);
235 typedef enum {
236   static_linkage,       /* entity is used internal and not visible out of this
237                            file/class. */
238   external_linkage,     /* */
239   no_linkage
240 } linkage_type;
241 inline linkage_type get_Sel_linkage_type (ir_node *node);
242 inline void     set_Sel_linkage_type (ir_node *node, linkage_type lt);
243
244 inline ir_node *get_Call_mem (ir_node *node);
245 inline void     set_Call_mem (ir_node *node, ir_node *mem);
246 inline ir_node *get_Call_ptr (ir_node *node);
247 inline void     set_Call_ptr (ir_node *node, ir_node *ptr);
248 inline ir_node **get_Call_param_arr (ir_node *node);
249 inline int      get_Call_n_params (ir_node *node);
250 inline int      get_Call_arity (ir_node *node);
251 /* inline void     set_Call_arity (ir_node *node, ir_node *arity); */
252 inline ir_node *get_Call_param (ir_node *node, int pos);
253 inline void     set_Call_param (ir_node *node, int pos, ir_node *param);
254 inline type    *get_Call_type (ir_node *node);
255 inline void     set_Call_type (ir_node *node, type *type);
256
257 /* For unary and binary arithmetic operations the access to the
258    operands can be factored out.  Left is the first, right the
259    second arithmetic value  as listed in tech report 1999-44.
260    unops are: Minus, Abs, Not, Conv
261    binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
262    Shr, Shrs, Rot, Cmp */
263 inline int      is_unop (ir_node *node);
264 inline ir_node *get_unop_op (ir_node *node);
265 inline void     set_unop_op (ir_node *node, ir_node *op);
266 inline int      is_binop (ir_node *node);
267 inline ir_node *get_binop_left (ir_node *node);
268 inline void     set_binop_left (ir_node *node, ir_node *left);
269 inline ir_node *get_binop_right (ir_node *node);
270 inline void     set_binop_right (ir_node *node, ir_node *right);
271
272 inline ir_node *get_Add_left (ir_node *node);
273 inline void     set_Add_left (ir_node *node, ir_node *left);
274 inline ir_node *get_Add_right (ir_node *node);
275 inline void     set_Add_right (ir_node *node, ir_node *right);
276
277 inline ir_node *get_Sub_left (ir_node *node);
278 inline void     set_Sub_left (ir_node *node, ir_node *left);
279 inline ir_node *get_Sub_right (ir_node *node);
280 inline void     set_Sub_right (ir_node *node, ir_node *right);
281
282 inline ir_node *get_Minus_op (ir_node *node);
283 inline void     set_Minus_op (ir_node *node, ir_node *op);
284
285 inline ir_node *get_Mul_left (ir_node *node);
286 inline void     set_Mul_left (ir_node *node, ir_node *left);
287 inline ir_node *get_Mul_right (ir_node *node);
288 inline void     set_Mul_right (ir_node *node, ir_node *right);
289
290 inline ir_node *get_Quot_left (ir_node *node);
291 inline void     set_Quot_left (ir_node *node, ir_node *left);
292 inline ir_node *get_Quot_right (ir_node *node);
293 inline void     set_Quot_right (ir_node *node, ir_node *right);
294 inline ir_node *get_Quot_mem (ir_node *node);
295 inline void     set_Quot_mem (ir_node *node, ir_node *mem);
296
297 inline ir_node *get_DivMod_left (ir_node *node);
298 inline void     set_DivMod_left (ir_node *node, ir_node *left);
299 inline ir_node *get_DivMod_right (ir_node *node);
300 inline void     set_DivMod_right (ir_node *node, ir_node *right);
301 inline ir_node *get_DivMod_mem (ir_node *node);
302 inline void     set_DivMod_mem (ir_node *node, ir_node *mem);
303
304 inline ir_node *get_Div_left (ir_node *node);
305 inline void     set_Div_left (ir_node *node, ir_node *left);
306 inline ir_node *get_Div_right (ir_node *node);
307 inline void     set_Div_right (ir_node *node, ir_node *right);
308 inline ir_node *get_Div_mem (ir_node *node);
309 inline void     set_Div_mem (ir_node *node, ir_node *mem);
310
311 inline ir_node *get_Mod_left (ir_node *node);
312 inline void     set_Mod_left (ir_node *node, ir_node *left);
313 inline ir_node *get_Mod_right (ir_node *node);
314 inline void     set_Mod_right (ir_node *node, ir_node *right);
315 inline ir_node *get_Mod_mem (ir_node *node);
316 inline void     set_Mod_mem (ir_node *node, ir_node *mem);
317
318 inline ir_node *get_Abs_op (ir_node *node);
319 inline void     set_Abs_op (ir_node *node, ir_node *op);
320
321 inline ir_node *get_And_left (ir_node *node);
322 inline void     set_And_left (ir_node *node, ir_node *left);
323 inline ir_node *get_And_right (ir_node *node);
324 inline void     set_And_right (ir_node *node, ir_node *right);
325
326 inline ir_node *get_Or_left (ir_node *node);
327 inline void     set_Or_left (ir_node *node, ir_node *left);
328 inline ir_node *get_Or_right (ir_node *node);
329 inline void     set_Or_right (ir_node *node, ir_node *right);
330
331 inline ir_node *get_Eor_left (ir_node *node);
332 inline void     set_Eor_left (ir_node *node, ir_node *left);
333 inline ir_node *get_Eor_right (ir_node *node);
334 inline void     set_Eor_right (ir_node *node, ir_node *right);
335
336 inline ir_node *get_Not_op (ir_node *node);
337 inline void     set_Not_op (ir_node *node, ir_node *op);
338
339 /* Projection numbers of compare: use for Proj nodes! */
340 typedef enum {
341   False,                /* false */
342   Eq,                   /* equal */
343   Lt,                   /* less */
344   Le,                   /* less or equal */
345   Gt,                   /* greater */
346   Ge,                   /* greater or equal */
347   Lg,                   /* less or greater */
348   Leg,                  /* less, equal or greater = ordered */
349   Uo,                   /* unordered */
350   Ue,                   /* unordered or equal */
351   Ul,                   /* unordered or less */
352   Ule,                  /* unordered, less or equal */
353   Ug,                   /* unordered or greater */
354   Uge,                  /* unordered, greater or equal */
355   Ne,                   /* unordered, less or greater = not equal */
356   True,                 /* true */
357   not_mask = Leg        /* bits to flip to negate comparison */
358 } pnc_number;
359 inline char *get_pnc_string(int pnc);
360 inline int   get_negated_pnc(int pnc);
361 inline ir_node *get_Cmp_left (ir_node *node);
362 inline void     set_Cmp_left (ir_node *node, ir_node *left);
363 inline ir_node *get_Cmp_right (ir_node *node);
364 inline void     set_Cmp_right (ir_node *node, ir_node *right);
365
366 inline ir_node *get_Shl_left (ir_node *node);
367 inline void     set_Shl_left (ir_node *node, ir_node *left);
368 inline ir_node *get_Shl_right (ir_node *node);
369 inline void     set_Shl_right (ir_node *node, ir_node *right);
370
371 inline ir_node *get_Shr_left (ir_node *node);
372 inline void     set_Shr_left (ir_node *node, ir_node *left);
373 inline ir_node *get_Shr_right (ir_node *node);
374 inline void     set_Shr_right (ir_node *node, ir_node *right);
375
376 inline ir_node *get_Shrs_left (ir_node *node);
377 inline void     set_Shrs_left (ir_node *node, ir_node *left);
378 inline ir_node *get_Shrs_right (ir_node *node);
379 inline void     set_Shrs_right (ir_node *node, ir_node *right);
380
381 inline ir_node *get_Rot_left (ir_node *node);
382 inline void     set_Rot_left (ir_node *node, ir_node *left);
383 inline ir_node *get_Rot_right (ir_node *node);
384 inline void     set_Rot_right (ir_node *node, ir_node *right);
385
386 inline ir_node *get_Conv_op (ir_node *node);
387 inline void     set_Conv_op (ir_node *node, ir_node *op);
388
389 inline ir_node **get_Phi_preds_arr (ir_node *node);
390 inline int       get_Phi_n_preds (ir_node *node);
391 /* inline void     set_Phi_n_preds (ir_node *node, int n_preds); */
392 inline ir_node  *get_Phi_pred (ir_node *node, int pos);
393 inline void      set_Phi_pred (ir_node *node, int pos, ir_node *pred);
394
395 inline ir_node *get_Load_mem (ir_node *node);
396 inline void     set_Load_mem (ir_node *node, ir_node *mem);
397 inline ir_node *get_Load_ptr (ir_node *node);
398 inline void     set_Load_ptr (ir_node *node, ir_node *ptr);
399
400 inline ir_node *get_Store_mem (ir_node *node);
401 inline void     set_Store_mem (ir_node *node, ir_node *mem);
402 inline ir_node *get_Store_ptr (ir_node *node);
403 inline void     set_Store_ptr (ir_node *node, ir_node *ptr);
404 inline ir_node *get_Store_value (ir_node *node);
405 inline void     set_Store_value (ir_node *node, ir_node *value);
406
407 inline ir_node *get_Alloc_mem (ir_node *node);
408 inline void     set_Alloc_mem (ir_node *node, ir_node *mem);
409 inline ir_node *get_Alloc_size (ir_node *node);
410 inline void     set_Alloc_size (ir_node *node, ir_node *size);
411 inline type    *get_Alloc_type (ir_node *node);
412 inline void     set_Alloc_type (ir_node *node, type *type);
413 typedef enum {
414   stack_alloc,          /* Alloc allocates the object on the stack. */
415   heap_alloc            /* Alloc allocates the object on the heap. */
416 } where_alloc;
417 inline where_alloc  get_Alloc_where (ir_node *node);
418 inline void         set_Alloc_where (ir_node *node, where_alloc where);
419
420 inline ir_node *get_Free_mem (ir_node *node);
421 inline void     set_Free_mem (ir_node *node, ir_node *mem);
422 inline ir_node *get_Free_ptr (ir_node *node);
423 inline void     set_Free_ptr (ir_node *node, ir_node *ptr);
424 inline ir_node *get_Free_size (ir_node *node);
425 inline void     set_Free_size (ir_node *node, ir_node *size);
426 inline type    *get_Free_type (ir_node *node);
427 inline void     set_Free_type (ir_node *node, type *type);
428
429 inline ir_node **get_Sync_preds_arr (ir_node *node);
430 inline int       get_Sync_n_preds (ir_node *node);
431 /* inline void     set_Sync_n_preds (ir_node *node, int n_preds); */
432 inline ir_node  *get_Sync_pred (ir_node *node, int pos);
433 inline void      set_Sync_pred (ir_node *node, int pos, ir_node *pred);
434
435 inline ir_node  *get_Proj_pred (ir_node *node);
436 inline void      set_Proj_pred (ir_node *node, ir_node *pred);
437 inline long      get_Proj_proj (ir_node *node);
438 inline void      set_Proj_proj (ir_node *node, long proj);
439
440 inline ir_node **get_Tuple_preds_arr (ir_node *node);
441 inline int       get_Tuple_n_preds (ir_node *node);
442 /* inline void     set_Tuple_n_preds (ir_node *node, int n_preds); */
443 inline ir_node  *get_Tuple_pred (ir_node *node, int pos);
444 inline void      set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
445
446 inline ir_node  *get_Id_pred (ir_node *node);
447 inline void      set_Id_pred (ir_node *node, ir_node *pred);
448
449 /*****/
450
451 /****s* irnode/other2
452  *
453  * NAME Auxiliary routines
454  *
455  * NOTE Not properly documented ;-)
456  *
457  * SOURCE
458  */
459
460 /* returns operand of node if node is a Proj. */
461 inline ir_node *skip_Proj (ir_node *node);
462 /* returns operand of node if node is a Id */
463 inline ir_node *skip_nop  (ir_node *node);
464 /* returns corresponding operand of Tuple if node is a Proj from
465    a Tuple. */
466 inline ir_node *skip_Tuple (ir_node *node);
467 /* returns true if node is a Bad node. */
468 inline int      is_Bad    (ir_node *node);
469 /* returns true if the node is not a Block */
470 inline int      is_no_Block (ir_node *node);
471 /* Returns true if the operation manipulates control flow:
472    Start, End, Jmp, Cond, Return, Raise */
473 int is_cfop(ir_node *node);
474 /* Returns true if the operation can change the control flow because
475    of an exception. */
476 int is_fragile_op(ir_node *node);
477 /* Returns the memory operand of fragile operations. */
478 ir_node *get_fragile_op_mem(ir_node *node);
479
480 /*****/
481
482 /* Makros for debugging the libfirm */
483 #ifdef DEBUG_libfirm
484 #include "ident.h"
485
486 #define DDMSG        printf("%s(l.%i)\n", __FUNCTION__, __LINE__)
487 #define DDMSG1(X)    printf("%s(l.%i) %s\n", __FUNCTION__, __LINE__,         \
488                             id_to_str(get_irn_opident(X)))
489 #define DDMSG2(X)    printf("%s(l.%i) %s%s: %ld\n", __FUNCTION__, __LINE__,          \
490                      id_to_str(get_irn_opident(X)), id_to_str(get_irn_modeident(X)), \
491                      get_irn_node_nr(X))
492 #define DDMSG3(X)    printf("%s(l.%i) %s: %p\n", __FUNCTION__, __LINE__,     \
493                      print_firm_kind(X), (X))
494
495 #endif
496
497 # endif /* _IRNODE_H_ */