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