ccd90f5879959802a21ea97ffdf322a7203b5eee
[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 # ifndef _IRNODE_H_
10 # define _IRNODE_H_
11
12 # include "irgraph.h"
13 # include "entity.h"
14 # include "common.h"
15 # include "irop.h"
16 # include "irmode.h"
17 # include "tv.h"
18 # include "type.h"
19
20
21 /** Global flags.  Set these by autoconf?? **/
22 /* If this is defined debuging aids are created, e.g. a field in
23    ir_node uniquely numbering the nodes. */
24 /* @@@???? this is also set in firm.h */
25 #define DEBUG_libfirm
26 #ifdef DEBUG_libfirm
27 #include "irprog.h"
28 #endif
29
30 /* projection numbers of compare. */
31 enum {
32   False,                /* false */
33   Eq,                   /* equal */
34   Lt,                   /* less */
35   Le,                   /* less or equal */
36   Gt,                   /* greater */
37   Ge,                   /* greater or equal */
38   Lg,                   /* less or greater */
39   Leg,                  /* less, equal or greater = ordered */
40   Uo,                   /* unordered */
41   Ue,                   /* unordered or equal */
42   Ul,                   /* unordered or less */
43   Ule,                  /* unordered, less or equal */
44   Ug,                   /* unordered or greater */
45   Uge,                  /* unordered, greater or equal */
46   Ne,                   /* unordered, less or greater = not equal */
47   True,                 /* true */
48   not_mask = Leg        /* bits to flip to negate comparison */
49 } pnc_number;
50
51 inline char *
52 get_pnc_string(int pnc);
53
54 int
55 get_negated_pnc(int pnc);
56
57
58 /* projection numbers for result of Start node. */
59 enum {
60   pns_initial_exec,     /* Projection on an executable, the initial control
61                            flow. */
62   pns_global_store,     /* Projection on the global store */
63   pns_frame_base,       /* Projection on the frame base */
64   pns_globals,          /* Projection on the pointer to the data segment
65                            containing _all_ global entities. */
66   pns_args              /* Projection on all arguments */
67 } pns_number;
68
69 /** ir node attributes **/
70 /* Block attributes */
71 typedef struct {
72   unsigned long block_visited;  /* for the walker that walks over all blocks. */
73   /* Attributes private to construction: */
74   bool matured;               /* if set, all in-nodes of the block are fixed */
75   struct ir_node **graph_arr; /* array to store all parameters */
76 } block_attr;
77
78 /* SymConst attributes */
79 /*   This enum names the three different kinds of symbolic Constants
80      represented by SymConst.  The content of the attribute type_or_id
81      depends on this tag. */
82 typedef enum {
83   type_tag,          /* The SymConst is a type tag for the given type.
84                         Type_or_id is type */
85   size,              /* The SymConst is the size of the given type.
86                         Type_or_id is type */
87   linkage_ptr_info   /* The SymConst is a symbolic pointer to be filled in
88                         by the linker. Type_or_id is ident */
89 } symconst_kind;
90
91 /*   This union contains the symbolic information represented by the node */
92 typedef union {
93   type *typ;
94   ident *ptrinfo;
95 } type_or_id;
96
97 typedef struct {
98   type_or_id tori;
99   symconst_kind num;
100 } symconst_attr;
101
102 /* Sel attributes */
103 typedef enum {
104   static_linkage,       /* entity is used internal and not visible out of this
105                            file/class. */
106   external_linkage,     /* */
107   no_linkage
108 } linkage_type;
109
110 typedef struct {
111   entity *ent;          /* entity to select */
112   linkage_type ltyp;    /* linkage type of the entity */
113 } sel_attr;
114
115 /* Alloc attributes */
116 typedef enum {
117   stack_alloc,          /* Alloc allocates the object on the stack. */
118   heap_alloc            /* Alloc allocates the object on the heap. */
119 } where_alloc;
120
121 typedef struct {
122   type *type;           /* Type of the allocated object.  */
123   where_alloc where;    /* stack, heap or other managed part of memory */
124 } alloc_attr;
125
126 /* Some irnodes just have one attribute, these are stored here,
127    some have more. Their name is 'irnodename_attr' */
128 typedef union {
129   block_attr     block; /* For Block: Fields needed to construct it */
130   struct tarval *con;   /* For Const: contains the value of the constant */
131   symconst_attr  i;     /* For SymConst. */
132   sel_attr       s;     /* For Sel. */
133   type_method   *call;  /* For Call: pointer to the type of the method to call */
134   long           proj;  /* For Proj: contains the result position to project */
135   alloc_attr     a;     /* For Alloc. */
136   type          *f;     /* For Free. */
137   int            phi0_pos;  /* For Phi. Used to remember the value defined by
138                                this Phi node.  Needed when the Phi is completed
139                                to call get_r_internal_value to find the
140                                predecessors. If this attribute is set, the Phi
141                                node takes the role of the obsolete Phi0 node,
142                                therefore the name. */
143 } attr;
144
145
146 /* common structure of an irnode */
147 /* if the node has some attributes, they are stored in attr */
148
149 struct ir_node {
150   firm_kind kind;          /* distinguishes this node from others */
151   ir_op *op;               /* Opcode of this node. */
152   ir_mode *mode;           /* Mode of this node. */
153   unsigned long visited;   /* visited counter for walks of the graph */
154   struct ir_node **in;     /* array with predecessors / operands */
155   struct ir_node *link;    /* for linking nodes somehow to a list, e.g.
156                               used while construction to link Phi0 nodes and
157                               during optimization to link to nodes that
158                               shall replace a node. */
159 #ifdef DEBUG_libfirm
160   int node_nr;             /* a unique node number for each node to make output
161                               readable. */
162 #endif
163   attr attr;               /* attribute of this node. Depends on opcode. */
164                            /* Must be last field of struct ir_node. */
165 };
166
167
168 /* The typedefiniton of ir_node is also in irgraph.h to resolve
169    recursion between irnode.h and irgraph.h */
170 #ifndef _IR_NODE_TYPEDEF_
171 #define _IR_NODE_TYPEDEF_
172 typedef struct ir_node ir_node;
173 #endif
174
175 /* irnode constructor                                             */
176 /* Create a new irnode in irg, with an op, mode, arity and        */
177 /* some incoming irnodes.                                         */
178 /* If arity is negative, a node with a dynamic array is created.  */
179
180 inline ir_node *
181 new_ir_node (ir_graph *irg,
182              ir_node *block,
183              ir_op *op,
184              ir_mode *mode,
185              int arity,
186              ir_node **in);
187
188 /* Copies all attributes stored in the old node  to the new node.
189    Assumes both have the same opcode and sufficient size. */
190 void
191 copy_attrs (ir_node *old, ir_node *new);
192
193
194 /* Print IR-Nodes with attributes */
195 /* @@@@ brauchen wir dienoch? dann fliegt ev. das xprint raus?*/
196 int ir_node_print (XP_PAR1, const xprintf_info *, XP_PARN);
197
198
199 /** manipulate the fields of ir_node **/
200
201 /* returns the number of predecessors without the block predecessor: */
202 int                  get_irn_arity         (ir_node *node);
203 /* returns the array with the ins: */
204 inline ir_node     **get_irn_in            (ir_node *node);
205 /* to iterate through the predecessors without touching the array. No
206    order of predecessors guaranteed.
207    To iterate over the operands iterate from 0 to i < get_irn_arity(),
208    to iterate includind the Block predecessor iterate from i = -1 to
209    i < get_irn_arity. */
210 /* Access predecessor n */
211 inline ir_node      *get_irn_n             (ir_node *node, int n);
212 inline void          set_irn_n             (ir_node *node, int n, ir_node *in);
213 /* Get the mode struct. */
214 inline ir_mode      *get_irn_mode          (ir_node *node);
215 /* Get the mode-enum modecode */
216 inline modecode      get_irn_modecode      (ir_node *node);
217 /* Get the ident for a string representation of the mode */
218 inline ident        *get_irn_modename      (ir_node *node);
219 /* Access the opcode struct of the node */
220 inline ir_op        *get_irn_op            (ir_node *node);
221 inline void          set_irn_op            (ir_node *node, ir_op *op);
222 /* Get the opcode-enum of the node */
223 inline opcode        get_irn_opcode        (ir_node *node);
224 /* Get the ident for a string representation of the opcode */
225 inline ident        *get_irn_opname        (ir_node *node);
226 inline void          set_irn_visited (ir_node *node, unsigned long visited);
227 inline unsigned long get_irn_visited (ir_node *node);
228 inline void          set_irn_link          (ir_node *node, ir_node *link);
229 inline ir_node      *get_irn_link          (ir_node *node);
230
231 #ifdef DEBUG_libfirm
232 /* Outputs a unique number for this node */
233 inline long get_irn_node_nr(ir_node *node);
234 #endif
235
236 /** access attributes directly **/
237 inline tarval       *get_irn_const_attr    (ir_node *node);
238 inline long          get_irn_proj_attr     (ir_node *node);
239 inline alloc_attr    get_irn_alloc_attr    (ir_node *node);
240 inline type         *get_irn_free_attr     (ir_node *node);
241 inline symconst_attr get_irn_symconst_attr (ir_node *node);
242 type_method  *get_irn_call_attr     (ir_node *node);
243 sel_attr      get_irn_sel_attr      (ir_node *node);
244 int           get_irn_phi_attr      (ir_node *node);
245 block_attr    get_irn_return_attr   (ir_node *node);
246
247 /** manipulate fields of individual nodes **/
248
249 /* this works for all except Block */
250 inline ir_node  *get_nodes_Block (ir_node *node);
251 inline void      set_nodes_Block (ir_node *node, ir_node *block);
252 inline ir_node **get_Block_cfgpred_arr (ir_node *node);
253 int              get_Block_n_cfgpreds (ir_node *node);
254 /* inline void    set_Block_n_cfgpreds (ir_node *node, int n_preds); */
255
256 inline ir_node  *get_Block_cfgpred (ir_node *node, int pos);
257 inline void      set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
258 inline bool      get_Block_matured (ir_node *node);
259 inline void      set_Block_matured (ir_node *node, bool matured);
260 inline unsigned long get_Block_block_visited (ir_node *node);
261 inline void      set_Block_block_visited (ir_node *node, unsigned long visit);
262 inline ir_node  *get_Block_graph_arr (ir_node *node, int pos);
263 inline void      set_Block_graph_arr (ir_node *node, int pos, ir_node *value);
264
265 inline ir_node  *get_Cond_selector (ir_node *node);
266 inline void      set_Cond_selector (ir_node *node, ir_node *selector);
267
268 inline ir_node  *get_Return_mem (ir_node *node);
269 inline void      set_Return_mem (ir_node *node, ir_node *mem);
270 inline ir_node **get_Return_res_arr (ir_node *node);
271 inline int       get_Return_n_res (ir_node *node);
272 /*inline void     set_Return_n_res (ir_node *node, int results); */
273 inline ir_node  *get_Return_res (ir_node *node, int pos);
274 inline void      set_Return_res (ir_node *node, int pos, ir_node *res);
275
276 inline ir_node *get_Raise_mem (ir_node *node);
277 inline void     set_Raise_mem (ir_node *node, ir_node *mem);
278 inline ir_node *get_Raise_exo_ptr (ir_node *node);  /* PoinTeR to EXception Object */
279 inline void     set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
280
281 inline tarval  *get_Const_tarval (ir_node *node);
282 inline void     set_Const_tarval (ir_node *node, tarval *con);
283
284 inline symconst_kind get_SymConst_kind (ir_node *node);
285 inline void          set_SymConst_kind (ir_node *node, symconst_kind num);
286 inline type    *get_SymConst_type (ir_node *node);
287 inline void     set_SymConst_type (ir_node *node, type *type);
288 inline ident   *get_SymConst_ptrinfo (ir_node *node);
289 inline void     set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
290
291 inline ir_node *get_Sel_mem (ir_node *node);
292 inline void     set_Sel_mem (ir_node *node, ir_node *mem);
293 inline ir_node *get_Sel_ptr (ir_node *node);  /* ptr to the object to select from */
294 inline void     set_Sel_ptr (ir_node *node, ir_node *ptr);
295 inline ir_node **get_Sel_index_arr (ir_node *node);
296 inline int      get_Sel_n_index (ir_node *node);
297 /*inline void     set_Sel_n_index (ir_node *node, int n_index); */
298 inline ir_node *get_Sel_index (ir_node *node, int pos);
299 inline void     set_Sel_index (ir_node *node, int pos, ir_node *index);
300 inline entity  *get_Sel_entity (ir_node *node); /* entity to select */
301 inline void     set_Sel_entity (ir_node *node, entity *ent);
302 inline linkage_type get_Sel_linkage_type (ir_node *node);
303 inline void     set_Sel_linkage_type (ir_node *node, linkage_type lt);
304
305 inline ir_node *get_Call_mem (ir_node *node);
306 inline void     set_Call_mem (ir_node *node, ir_node *mem);
307 inline ir_node *get_Call_ptr (ir_node *node);
308 inline void     set_Call_ptr (ir_node *node, ir_node *ptr);
309 inline ir_node **get_Call_param_arr (ir_node *node);
310 inline int      get_Call_arity (ir_node *node);
311 /* inline void     set_Call_arity (ir_node *node, ir_node *arity); */
312 inline ir_node *get_Call_param (ir_node *node, int pos);
313 inline void     set_Call_param (ir_node *node, int pos, ir_node *param);
314 inline type_method *get_Call_type (ir_node *node);
315 inline void     set_Call_type (ir_node *node, type_method *type);
316
317 /* For unary and binary arithmetic operations the access to the
318    operands can be factored out.  Left is the first, right the
319    second arithmetic value  as listed in tech report 1999-44.
320    unops are: Minus, Abs, Not, Conv
321    binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
322    Shr, Shrs, Rot, Cmp */
323 inline int      is_unop (ir_node *node);
324 inline ir_node *get_unop_op (ir_node *node);
325 inline void     set_unop_op (ir_node *node, ir_node *op);
326 inline int      is_binop (ir_node *node);
327 inline ir_node *get_binop_left (ir_node *node);
328 inline void     set_binop_left (ir_node *node, ir_node *left);
329 inline ir_node *get_binop_right (ir_node *node);
330 inline void     set_binop_right (ir_node *node, ir_node *right);
331
332 inline ir_node *get_Add_left (ir_node *node);
333 inline void     set_Add_left (ir_node *node, ir_node *left);
334 inline ir_node *get_Add_right (ir_node *node);
335 inline void     set_Add_right (ir_node *node, ir_node *right);
336
337 inline ir_node *get_Sub_left (ir_node *node);
338 inline void     set_Sub_left (ir_node *node, ir_node *left);
339 inline ir_node *get_Sub_right (ir_node *node);
340 inline void     set_Sub_right (ir_node *node, ir_node *right);
341
342 inline ir_node *get_Minus_op (ir_node *node);
343 inline void     set_Minus_op (ir_node *node, ir_node *op);
344
345 inline ir_node *get_Mul_left (ir_node *node);
346 inline void     set_Mul_left (ir_node *node, ir_node *left);
347 inline ir_node *get_Mul_right (ir_node *node);
348 inline void     set_Mul_right (ir_node *node, ir_node *right);
349
350 inline ir_node *get_Quot_left (ir_node *node);
351 inline void     set_Quot_left (ir_node *node, ir_node *left);
352 inline ir_node *get_Quot_right (ir_node *node);
353 inline void     set_Quot_right (ir_node *node, ir_node *right);
354 inline ir_node *get_Quot_mem (ir_node *node);
355 inline void     set_Quot_mem (ir_node *node, ir_node *mem);
356
357 inline ir_node *get_DivMod_left (ir_node *node);
358 inline void     set_DivMod_left (ir_node *node, ir_node *left);
359 inline ir_node *get_DivMod_right (ir_node *node);
360 inline void     set_DivMod_right (ir_node *node, ir_node *right);
361 inline ir_node *get_DivMod_mem (ir_node *node);
362 inline void     set_DivMod_mem (ir_node *node, ir_node *mem);
363
364 inline ir_node *get_Div_left (ir_node *node);
365 inline void     set_Div_left (ir_node *node, ir_node *left);
366 inline ir_node *get_Div_right (ir_node *node);
367 inline void     set_Div_right (ir_node *node, ir_node *right);
368 inline ir_node *get_Div_mem (ir_node *node);
369 inline void     set_Div_mem (ir_node *node, ir_node *mem);
370
371 inline ir_node *get_Mod_left (ir_node *node);
372 inline void     set_Mod_left (ir_node *node, ir_node *left);
373 inline ir_node *get_Mod_right (ir_node *node);
374 inline void     set_Mod_right (ir_node *node, ir_node *right);
375 inline ir_node *get_Mod_mem (ir_node *node);
376 inline void     set_Mod_mem (ir_node *node, ir_node *mem);
377
378 inline ir_node *get_Abs_op (ir_node *node);
379 inline void     set_Abs_op (ir_node *node, ir_node *op);
380
381 inline ir_node *get_And_left (ir_node *node);
382 inline void     set_And_left (ir_node *node, ir_node *left);
383 inline ir_node *get_And_right (ir_node *node);
384 inline void     set_And_right (ir_node *node, ir_node *right);
385
386 inline ir_node *get_Or_left (ir_node *node);
387 inline void     set_Or_left (ir_node *node, ir_node *left);
388 inline ir_node *get_Or_right (ir_node *node);
389 inline void     set_Or_right (ir_node *node, ir_node *right);
390
391 inline ir_node *get_Eor_left (ir_node *node);
392 inline void     set_Eor_left (ir_node *node, ir_node *left);
393 inline ir_node *get_Eor_right (ir_node *node);
394 inline void     set_Eor_right (ir_node *node, ir_node *right);
395
396 inline ir_node *get_Not_op (ir_node *node);
397 inline void     set_Not_op (ir_node *node, ir_node *op);
398
399 inline ir_node *get_Cmp_left (ir_node *node);
400 inline void     set_Cmp_left (ir_node *node, ir_node *left);
401 inline ir_node *get_Cmp_right (ir_node *node);
402 inline void     set_Cmp_right (ir_node *node, ir_node *right);
403
404 inline ir_node *get_Shl_left (ir_node *node);
405 inline void     set_Shl_left (ir_node *node, ir_node *left);
406 inline ir_node *get_Shl_right (ir_node *node);
407 inline void     set_Shl_right (ir_node *node, ir_node *right);
408
409 inline ir_node *get_Shr_left (ir_node *node);
410 inline void     set_Shr_left (ir_node *node, ir_node *left);
411 inline ir_node *get_Shr_right (ir_node *node);
412 inline void     set_Shr_right (ir_node *node, ir_node *right);
413
414 inline ir_node *get_Shrs_left (ir_node *node);
415 inline void     set_Shrs_left (ir_node *node, ir_node *left);
416 inline ir_node *get_Shrs_right (ir_node *node);
417 inline void     set_Shrs_right (ir_node *node, ir_node *right);
418
419 inline ir_node *get_Rot_left (ir_node *node);
420 inline void     set_Rot_left (ir_node *node, ir_node *left);
421 inline ir_node *get_Rot_right (ir_node *node);
422 inline void     set_Rot_right (ir_node *node, ir_node *right);
423
424 inline ir_node *get_Conv_op (ir_node *node);
425 inline void     set_Conv_op (ir_node *node, ir_node *op);
426
427 inline ir_node **get_Phi_preds_arr (ir_node *node);
428 inline int       get_Phi_n_preds (ir_node *node);
429 /* inline void     set_Phi_n_preds (ir_node *node, int n_preds); */
430 inline ir_node  *get_Phi_pred (ir_node *node, int pos);
431 inline void      set_Phi_pred (ir_node *node, int pos, ir_node *pred);
432
433 inline ir_node *get_Load_mem (ir_node *node);
434 inline void     set_Load_mem (ir_node *node, ir_node *mem);
435 inline ir_node *get_Load_ptr (ir_node *node);
436 inline void     set_Load_ptr (ir_node *node, ir_node *ptr);
437
438 inline ir_node *get_Store_mem (ir_node *node);
439 inline void     set_Store_mem (ir_node *node, ir_node *mem);
440 inline ir_node *get_Store_ptr (ir_node *node);
441 inline void     set_Store_ptr (ir_node *node, ir_node *ptr);
442 inline ir_node *get_Store_value (ir_node *node);
443 inline void     set_Store_value (ir_node *node, ir_node *value);
444
445 inline ir_node *get_Alloc_mem (ir_node *node);
446 inline void     set_Alloc_mem (ir_node *node, ir_node *mem);
447 inline ir_node *get_Alloc_size (ir_node *node);
448 inline void     set_Alloc_size (ir_node *node, ir_node *size);
449 inline type    *get_Alloc_type (ir_node *node);
450 inline void     set_Alloc_type (ir_node *node, type *type);
451 inline where_alloc  get_Alloc_where (ir_node *node);
452 inline void         set_Alloc_where (ir_node *node, where_alloc where);
453
454 inline ir_node *get_Free_mem (ir_node *node);
455 inline void     set_Free_mem (ir_node *node, ir_node *mem);
456 inline ir_node *get_Free_ptr (ir_node *node);
457 inline void     set_Free_ptr (ir_node *node, ir_node *ptr);
458 inline ir_node *get_Free_size (ir_node *node);
459 inline void     set_Free_size (ir_node *node, ir_node *size);
460 inline type    *get_Free_type (ir_node *node);
461 inline void     set_Free_type (ir_node *node, type *type);
462
463 inline ir_node **get_Sync_preds_arr (ir_node *node);
464 inline int       get_Sync_n_preds (ir_node *node);
465 /* inline void     set_Sync_n_preds (ir_node *node, int n_preds); */
466 inline ir_node  *get_Sync_pred (ir_node *node, int pos);
467 inline void      set_Sync_pred (ir_node *node, int pos, ir_node *pred);
468
469 inline ir_node  *get_Proj_pred (ir_node *node);
470 inline void      set_Proj_pred (ir_node *node, ir_node *pred);
471 inline long      get_Proj_proj (ir_node *node);
472 inline void      set_Proj_proj (ir_node *node, long proj);
473
474 inline ir_node **get_Tuple_preds_arr (ir_node *node);
475 inline int       get_Tuple_n_preds (ir_node *node);
476 /* inline void     set_Tuple_n_preds (ir_node *node, int n_preds); */
477 inline ir_node  *get_Tuple_pred (ir_node *node, int pos);
478 inline void      set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
479
480 inline ir_node  *get_Id_pred (ir_node *node);
481 inline void      set_Id_pred (ir_node *node, ir_node *pred);
482
483
484
485 /******************************************************************/
486 /*  Auxiliary routines                                            */
487 /******************************************************************/
488
489 /* returns operand of node if node is a Proj. */
490 inline ir_node *skip_Proj (ir_node *node);
491 /* returns operand of node if node is a Id */
492 inline ir_node *skip_nop  (ir_node *node);
493 /* returns true if node is a Bad node. */
494 inline int      is_Bad    (ir_node *node);
495 /* returns true if the node is not a Block */
496 inline int      is_no_Block (ir_node *node);
497 /* Returns true if the operation manipulates control flow:
498    Start, End, Jmp, Cond, Return, Raise */
499 int is_cfop(ir_node *node);
500 /* Returns true if the operation can change the control flow because
501    of an exception. */
502 int is_fragile_op(ir_node *node);
503
504
505
506 /* Makros for debugging the libfirm */
507 #ifdef DEBUG_libfirm
508 #include "ident.h"
509
510 #define DDMSG        printf("%s(l.%i)\n", __FUNCTION__, __LINE__)
511 #define DDMSG1(X)    printf("%s(l.%i) %s\n", __FUNCTION__, __LINE__,         \
512                             ID_TO_STR(get_irn_opname(X)))
513 #define DDMSG2(X)    printf("%s(l.%i) %s: %ld\n", __FUNCTION__, __LINE__,     \
514                      ID_TO_STR(get_irn_opname(X)), get_irn_node_nr(X))
515
516 #endif
517
518 # endif /* _IRNODE_H_ */