nsz Git - libfirm/blob - ir/ir/irnode.h

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