irnode.h 18.5 KB
Newer Older
Christian Schäfer's avatar
Christian Schäfer committed
1
2
3
4
5
6
7
8
9
10
11
12
13


/* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
** All rights reserved.
**
** Authors: Martin Trapp, Christian Schaefer
**
** declarations of an ir node
*/

# ifndef _IRNODE_H_
# define _IRNODE_H_

Christian Schäfer's avatar
Christian Schäfer committed
14
# include "irgraph.h"
Christian Schäfer's avatar
Christian Schäfer committed
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# include "entity.h"
# include "common.h"
# include "irop.h"
# include "irmode.h"
# include "tv.h"
# include "type.h"

/* projection numbers of compare. */
enum {
  False,		/* false */
  Eq,			/* equal */
  Lt,			/* less */
  Le,			/* less or equal */
  Gt,			/* greater */
  Ge,			/* greater or equal */
  Lg,			/* less or greater */
  Leg,			/* less, equal or greater = ordered */
  Uo,			/* unordered */
  Ue,			/* unordered or equal */
  Ul,			/* unordered or less */
  Ule,			/* unordered, less or equal */
  Ug,			/* unordered or greater */
  Uge,			/* unordered, greater or equal */
  Ne,			/* unordered, less or greater = not equal */
  True,		        /* true */
  not_mask = Leg	/* bits to flip to negate comparison */
} pnc_number;

inline char *
get_pnc_string(int pnc);

int
get_negated_pnc(int pnc);


/* projection numbers for result of Start node. */
enum {
  pns_initial_exec,     /* Projection on an executable, the initial control
			   flow. */
  pns_global_store,     /* Projection on the global store */
  pns_frame_base,       /* Projection on the frame base */
  pns_globals,          /* Projection on the pointer to the data segment
			   containing _all_ global entities. */
  pns_args              /* Projection on all arguments */
} pns_number;

/* ir node attributes */
typedef struct {
  unsigned long block_visit;  /* for the walker that walks over all blocks. */
  /* Attributes private to construction: */
  bool matured;               /* if set, all in-nodes of the block are fixed */
  struct ir_node **graph_arr; /* array to store all parameters */
} block_attr;

typedef enum {
Christian Schäfer's avatar
Christian Schäfer committed
70
71
72
73
  type_tag,          /* The SymConst is a type tag for the given type.
			Type_or_id is type */
  size,              /* The SymConst is the size of the given type.
			Type_or_id is type */
Christian Schäfer's avatar
Christian Schäfer committed
74
  linkage_ptr_info   /* The SymConst is a symbolic pointer to be filled in
Christian Schäfer's avatar
Christian Schäfer committed
75
			by the linker. Type_or_id is ident */
Christian Schäfer's avatar
Christian Schäfer committed
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
} symconst_kind;

typedef union {
  type *typ;
  ident *ptrinfo;
} type_or_id;

typedef struct {
  type_or_id tori;
  symconst_kind num;
} symconst_attr;

typedef enum {
  static_linkage,       /* entity is used internal and not visible out of this
			   file/class. */
  external_linkage,     /* */
  no_linkage
} linkage_type;

typedef struct {
  entity *ent;          /* entity to select */
  linkage_type *ltyp;   /* linkage type of the entity */
} sel_attr;

typedef enum {
  stack_alloc,          /* Alloc allocates the object on the stack. */
  heap_alloc            /* lloc allocates the object on the heap. */
} where_alloc;

typedef struct {
  type *type;           /* Type of the allocated object.  */
  where_alloc where;    /* stack, heap or other managed part of memory */
} alloc_attr;

/* Some irnodes just have one attribute, these are stored here,
   some have more. Their name is 'irnodename_attr' */
typedef union {
  block_attr     block; /* For Block: Fields needed to construct it */
  struct tarval *con;   /* For Const: contains the value of the constant */
  symconst_attr  i;     /* For SymConst. */
  sel_attr       s;     /* For Sel. */
  type_method   *call;  /* For Call: pointer to the type of the method to call */
  long           proj;  /* For Proj: contains the result position to project */
  alloc_attr     a;     /* For Alloc. */
  type          *f;     /* For Free. */
  int            phi0_pos;  /* For Phi. Used to remember the value defined by
			       this Phi node.  Needed when the Phi is completed
			       to call get_r_internal_value to find the
			       predecessors. If this attribute is set, the Phi
			       node takes the role of the obsolete Phi0 node,
			       therefore the name. */
} attr;


/* common structure of an irnode */
/* if the node has some attributes, they are stored in attr */

Christian Schäfer's avatar
Christian Schäfer committed
133
struct ir_node {
Christian Schäfer's avatar
Christian Schäfer committed
134
135
136
137
138
139
140
141
142
143
144
  firm_kind kind;          /* distinguishes this node from others */
  ir_op *op;               /* Opcode of this node. */
  ir_mode *mode;           /* Mode of this node. */
  unsigned long visit;     /* visited counter for walks of the graph */
  struct ir_node **in;     /* array with predecessors / operands */
  struct ir_node *link;    /* for linking nodes somehow to a list, e.g.
                              used while construction to link Phi0 nodes and
			      during optimization to link to nodes that
			      shall replace a node. */
  attr attr;               /* attribute of this node. Depends on opcode. */
                           /* Must be last attribute of struct ir_node. */
Christian Schäfer's avatar
Christian Schäfer committed
145
} ;
Christian Schäfer's avatar
Christian Schäfer committed
146
147


Christian Schäfer's avatar
Christian Schäfer committed
148
149
150
151
152
153
154
/* The typedefiniton of ir_node is also in irgraph.h to resolve
   recursion between irnode.h and irgraph.h */
#ifndef _IR_NODE_TYPEDEF_
#define _IR_NODE_TYPEDEF_
typedef struct ir_node ir_node;
#endif

Christian Schäfer's avatar
Christian Schäfer committed
155
156
157
158
/* irnode constructor                                             */
/* Create a new irnode in irg, with an op, mode, arity and        */
/* some incoming irnodes.                                         */
/* If arity is negative, a node with a dynamic array is created.  */
Christian Schäfer's avatar
Christian Schäfer committed
159
160
161
162
163
164
165
166
167
168

inline ir_node *
new_ir_node (ir_graph *irg,
	     ir_node *block,
	     ir_op *op,
	     ir_mode *mode,
	     int arity,
	     ir_node **in);


Christian Schäfer's avatar
Christian Schäfer committed
169
/* Print IR-Nodes with attributes */
Christian Schäfer's avatar
Christian Schäfer committed
170
/* @@@@ brauchen wir dienoch? dann fliegt ev. das xprint raus?*/
Christian Schäfer's avatar
Christian Schäfer committed
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
int ir_node_print (XP_PAR1, const xprintf_info *, XP_PARN);


/** manipulate the fields of ir_node **/

/* returns the number of predecessors without the block predecessor: */
int                  get_irn_arity         (ir_node *node);
/* returns the array with the ins: */
inline ir_node     **get_irn_in            (ir_node *node);
/* to iterate through the predecessors without touching the array. No
   order of predecessors guaranteed.
   To iterate over the operands iterate from 0 to i < get_irn_arity(),
   to iterate includind the Block predecessor iterate from i = -1 to
   i < get_irn_arity. */
inline ir_node      *get_irn_n             (ir_node *node, int n);
inline void          set_irn_n             (ir_node *node, int n, ir_node *in);
inline ir_mode      *get_irn_mode          (ir_node *node);
inline modecode      get_irn_modecode      (ir_node *node);
inline ir_op        *get_irn_op            (ir_node *node);
/* should be private to the library: */
inline void          set_irn_op            (ir_node *node, ir_op *op);
inline opcode        get_irn_opcode        (ir_node *node);
inline void          set_irn_link          (ir_node *node, ir_node *link);
inline ir_node      *get_irn_link          (ir_node *node);


/** access attributes directly **/
inline tarval       *get_irn_const_attr    (ir_node *node);
inline long          get_irn_proj_attr     (ir_node *node);
inline alloc_attr    get_irn_alloc_attr    (ir_node *node);
inline type         *get_irn_free_attr     (ir_node *node);
inline symconst_attr get_irn_symconst_attr (ir_node *node);
type_method  *get_irn_call_attr     (ir_node *node);
sel_attr      get_irn_sel_attr      (ir_node *node);
int           get_irn_phi_attr      (ir_node *node);
block_attr    get_irn_return_attr   (ir_node *node);

/** manipulate fields of individual nodes **/

/* this works for all except Block */
inline ir_node *get_nodes_Block (ir_node *node);
inline void     set_nodes_Block (ir_node *node, ir_node *block);

int             get_Block_n_cfgpreds (ir_node *node);
/* inline void    set_Block_n_cfgpreds (ir_node *node, int n_preds); */
inline ir_node *get_Block_cfgpred (ir_node *node, int pos);
inline void     set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
inline bool     get_Block_matured (ir_node *node);
inline void     set_Block_matured (ir_node *node, bool matured);
inline bool     get_Block_closed (ir_node *node);
inline void     set_Block_closed (ir_node *node, bool closed);
inline unsigned long get_Block_block_visit (ir_node *node);
inline void     set_Block_block_visit (ir_node *node, unsigned long visit);
inline ir_node *get_Block_graph_arr (ir_node *node, int pos);
inline void     set_Block_graph_arr (ir_node *node, int pos, ir_node *value);

inline ir_node *get_Cond_selector (ir_node *node);
inline void     set_Cond_selector (ir_node *node, ir_node *selector);

inline ir_node *get_Return_mem (ir_node *node);
inline void     set_Return_mem (ir_node *node, ir_node *mem);
inline int      get_Return_n_res (ir_node *node);
/*inline void     set_Return_n_res (ir_node *node, int results); */
inline ir_node *get_Return_res (ir_node *node, int pos);
inline void     set_Return_res (ir_node *node, int pos, ir_node *res);

inline ir_node *get_Raise_mem (ir_node *node);
inline void     set_Raise_mem (ir_node *node, ir_node *mem);
inline ir_node *get_Raise_exoptr (ir_node *node);  /* PoinTeR to EXception Object */
inline void     set_Raise_exoptr (ir_node *node, ir_node *exoptr);

inline tarval  *get_Const_tarval (ir_node *node);
inline void     set_Const_tarval (ir_node *node, tarval *con);

inline symconst_kind get_SymConst_kind (ir_node *node);
inline void          set_SymConst_kind (ir_node *node, symconst_kind num);
inline type    *get_SymConst_type (ir_node *node);
inline void     set_SymConst_type (ir_node *node, type *type);
inline ident   *get_SymConst_ptrinfo (ir_node *node);
inline void     set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);

inline ir_node *get_Sel_mem (ir_node *node);
inline void     set_Sel_mem (ir_node *node, ir_node *mem);
inline ir_node *get_Sel_ptr (ir_node *node);  /* ptr to the object to select from */
inline void     set_Sel_ptr (ir_node *node, ir_node *ptr);
inline int      get_Sel_n_index (ir_node *node);
/*inline void     set_Sel_n_index (ir_node *node, int n_index); */
inline ir_node *get_Sel_index (ir_node *node, int pos);
inline void     set_Sel_index (ir_node *node, int pos, ir_node *index);
inline entity  *get_Sel_entity (ir_node *node); /* entity to select */
inline void     set_Sel_entity (ir_node *node, entity *ent);
inline linkage_type *get_Sel_linkage_type (ir_node *node);
inline void     set_Sel_linkage_type (ir_node *node, linkage_type *lt);

inline ir_node *get_Call_mem (ir_node *node);
inline void     set_Call_mem (ir_node *node, ir_node *mem);
inline ir_node *get_Call_ptr (ir_node *node);
inline void     set_Call_ptr (ir_node *node, ir_node *ptr);
inline int      get_Call_arity (ir_node *node);
/* inline void     set_Call_arity (ir_node *node, ir_node *arity); */
inline ir_node *get_Call_param (ir_node *node, int pos);
inline void     set_Call_param (ir_node *node, int pos, ir_node *param);
inline type_method *get_Call_type (ir_node *node);
inline void         set_Call_type (ir_node *node, type_method *type);

/* For unary and binary arithmetic operations the access to the
   operands can be factored out.  Left is the first, right the
   second arithmetic value  as listed in tech report 1999-44.
   unops are: Minus, Abs, Not, Conv
   binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
   Shr, Shrs, Rot, Cmp */
inline int      is_unop (ir_node *node);
inline ir_node *get_unop_op (ir_node *node);
inline void     set_unop_op (ir_node *node, ir_node *op);
inline int      is_binop (ir_node *node);
inline ir_node *get_binop_left (ir_node *node);
inline void     set_binop_left (ir_node *node, ir_node *left);
inline ir_node *get_binop_right (ir_node *node);
inline void     set_binop_right (ir_node *node, ir_node *right);

inline ir_node *get_Add_left (ir_node *node);
inline void     set_Add_left (ir_node *node, ir_node *left);
inline ir_node *get_Add_right (ir_node *node);
inline void     set_Add_right (ir_node *node, ir_node *right);

inline ir_node *get_Sub_left (ir_node *node);
inline void     set_Sub_left (ir_node *node, ir_node *left);
inline ir_node *get_Sub_right (ir_node *node);
inline void     set_Sub_right (ir_node *node, ir_node *right);

inline ir_node *get_Minus_op (ir_node *node);
inline void     set_Minus_op (ir_node *node, ir_node *op);

inline ir_node *get_Mul_left (ir_node *node);
inline void     set_Mul_left (ir_node *node, ir_node *left);
inline ir_node *get_Mul_right (ir_node *node);
inline void     set_Mul_right (ir_node *node, ir_node *right);

inline ir_node *get_Quot_left (ir_node *node);
inline void     set_Quot_left (ir_node *node, ir_node *left);
inline ir_node *get_Quot_right (ir_node *node);
inline void     set_Quot_right (ir_node *node, ir_node *right);
inline ir_node *get_Quot_mem (ir_node *node);
inline void     set_Quot_mem (ir_node *node, ir_node *mem);

inline ir_node *get_DivMod_left (ir_node *node);
inline void     set_DivMod_left (ir_node *node, ir_node *left);
inline ir_node *get_DivMod_right (ir_node *node);
inline void     set_DivMod_right (ir_node *node, ir_node *right);
inline ir_node *get_DivMod_mem (ir_node *node);
inline void     set_DivMod_mem (ir_node *node, ir_node *mem);

inline ir_node *get_Div_left (ir_node *node);
inline void     set_Div_left (ir_node *node, ir_node *left);
inline ir_node *get_Div_right (ir_node *node);
inline void     set_Div_right (ir_node *node, ir_node *right);
inline ir_node *get_Div_mem (ir_node *node);
inline void     set_Div_mem (ir_node *node, ir_node *mem);

inline ir_node *get_Mod_left (ir_node *node);
inline void     set_Mod_left (ir_node *node, ir_node *left);
inline ir_node *get_Mod_right (ir_node *node);
inline void     set_Mod_right (ir_node *node, ir_node *right);
inline ir_node *get_Mod_mem (ir_node *node);
inline void     set_Mod_mem (ir_node *node, ir_node *mem);

inline ir_node *get_Abs_op (ir_node *node);
inline void     set_Abs_op (ir_node *node, ir_node *op);

inline ir_node *get_And_left (ir_node *node);
inline void     set_And_left (ir_node *node, ir_node *left);
inline ir_node *get_And_right (ir_node *node);
inline void     set_And_right (ir_node *node, ir_node *right);

inline ir_node *get_Or_left (ir_node *node);
inline void     set_Or_left (ir_node *node, ir_node *left);
inline ir_node *get_Or_right (ir_node *node);
inline void     set_Or_right (ir_node *node, ir_node *right);

inline ir_node *get_Eor_left (ir_node *node);
inline void     set_Eor_left (ir_node *node, ir_node *left);
inline ir_node *get_Eor_right (ir_node *node);
inline void     set_Eor_right (ir_node *node, ir_node *right);

inline ir_node *get_Not_op (ir_node *node);
inline void     set_Not_op (ir_node *node, ir_node *op);

inline ir_node *get_Cmp_left (ir_node *node);
inline void     set_Cmp_left (ir_node *node, ir_node *left);
inline ir_node *get_Cmp_right (ir_node *node);
inline void     set_Cmp_right (ir_node *node, ir_node *right);

inline ir_node *get_Shl_left (ir_node *node);
inline void     set_Shl_left (ir_node *node, ir_node *left);
inline ir_node *get_Shl_right (ir_node *node);
inline void     set_Shl_right (ir_node *node, ir_node *right);

inline ir_node *get_Shr_left (ir_node *node);
inline void     set_Shr_left (ir_node *node, ir_node *left);
inline ir_node *get_Shr_right (ir_node *node);
inline void     set_Shr_right (ir_node *node, ir_node *right);

inline ir_node *get_Shrs_left (ir_node *node);
inline void     set_Shrs_left (ir_node *node, ir_node *left);
inline ir_node *get_Shrs_right (ir_node *node);
inline void     set_Shrs_right (ir_node *node, ir_node *right);

inline ir_node *get_Rot_left (ir_node *node);
inline void     set_Rot_left (ir_node *node, ir_node *left);
inline ir_node *get_Rot_right (ir_node *node);
inline void     set_Rot_right (ir_node *node, ir_node *right);

inline ir_node *get_Conv_op (ir_node *node);
inline void     set_Conv_op (ir_node *node, ir_node *op);

inline int      get_Phi_n_preds (ir_node *node);
/* inline void     set_Phi_n_preds (ir_node *node, int n_preds); */
inline ir_node *get_Phi_pred (ir_node *node, int pos);
inline void     set_Phi_pred (ir_node *node, int pos, ir_node *pred);

inline ir_node *get_Load_mem (ir_node *node);
inline void     set_Load_mem (ir_node *node, ir_node *mem);
inline ir_node *get_Load_ptr (ir_node *node);
inline void     set_Load_ptr (ir_node *node, ir_node *ptr);

inline ir_node *get_Store_mem (ir_node *node);
inline void     set_Store_mem (ir_node *node, ir_node *mem);
inline ir_node *get_Store_ptr (ir_node *node);
inline void     set_Store_ptr (ir_node *node, ir_node *ptr);
inline ir_node *get_Store_value (ir_node *node);
inline void     set_Store_value (ir_node *node, ir_node *value);

inline ir_node *get_Alloc_mem (ir_node *node);
inline void     set_Alloc_mem (ir_node *node, ir_node *mem);
inline ir_node *get_Alloc_size (ir_node *node);
inline void     set_Alloc_size (ir_node *node, ir_node *size);
inline type    *get_Alloc_type (ir_node *node);
inline void     set_Alloc_type (ir_node *node, type *type);
inline where_alloc  get_Alloc_where (ir_node *node);
inline void         set_Alloc_where (ir_node *node, where_alloc where);

inline ir_node *get_Free_mem (ir_node *node);
inline void     set_Free_mem (ir_node *node, ir_node *mem);
inline ir_node *get_Free_ptr (ir_node *node);
inline void     set_Free_ptr (ir_node *node, ir_node *ptr);
inline ir_node *get_Free_size (ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
417
inline void     set_Free_size (ir_node *node, ir_node *size);
Christian Schäfer's avatar
Christian Schäfer committed
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
inline type    *get_Free_type (ir_node *node);
inline void     set_Free_type (ir_node *node, type *type);

inline int      get_Sync_n_preds (ir_node *node);
/* inline void     set_Sync_n_preds (ir_node *node, int n_preds); */
inline ir_node *get_Sync_pred (ir_node *node, int pos);
inline void     set_Sync_pred (ir_node *node, int pos, ir_node *pred);

inline ir_node *get_Proj_pred (ir_node *node);
inline void     set_Proj_pred (ir_node *node, ir_node *pred);
inline long     get_Proj_proj (ir_node *node);
inline void     set_Proj_proj (ir_node *node, long proj);

inline int      get_Tuple_n_preds (ir_node *node);
/* inline void     set_Tuple_n_preds (ir_node *node, int n_preds); */
inline ir_node *get_Tuple_pred (ir_node *node, int pos);
inline void     set_Tuple_pred (ir_node *node, int pos, ir_node *pred);

inline ir_node *get_Id_pred (ir_node *node);
inline void     set_Id_pred (ir_node *node, ir_node *pred);



/******************************************************************/
/*  Auxiliary routines                                            */
/******************************************************************/

/* returns operand of node if node is a Proj. */
inline ir_node *skip_Proj (ir_node *node);
/* returns operand of node if node is a Id */
inline ir_node *skip_nop  (ir_node *node);
/* returns true if node is a Bad node. */
inline int      is_Bad    (ir_node *node);
/* returns true if the node is not a Block */
inline int      is_no_Block (ir_node *node);
/* Returns true if the operation manipulates control flow:
   Start, End, Jmp, Cond, Return, Raise */
int is_cfop(ir_node *node);
/* Returns true if the operation can change the control flow because
   of a exception. */
int is_fragile_op(ir_node *node);

# endif /* _IRNODE_H_ */