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 visit;     /* 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 ir_op        *get_irn_op            (ir_node *node);
 198 /* should be private to the library: */
 199 inline void          set_irn_op            (ir_node *node, ir_op *op);
 200 inline opcode        get_irn_opcode        (ir_node *node);
 201 inline void          set_irn_link          (ir_node *node, ir_node *link);
 202 inline ir_node      *get_irn_link          (ir_node *node);
 203
 204
 205 /** access attributes directly **/
 206 inline tarval       *get_irn_const_attr    (ir_node *node);
 207 inline long          get_irn_proj_attr     (ir_node *node);
 208 inline alloc_attr    get_irn_alloc_attr    (ir_node *node);
 209 inline type         *get_irn_free_attr     (ir_node *node);
 210 inline symconst_attr get_irn_symconst_attr (ir_node *node);
 211 type_method  *get_irn_call_attr     (ir_node *node);
 212 sel_attr      get_irn_sel_attr      (ir_node *node);
 213 int           get_irn_phi_attr      (ir_node *node);
 214 block_attr    get_irn_return_attr   (ir_node *node);
 215
 216 /** manipulate fields of individual nodes **/
 217
 218 /* this works for all except Block */
 219 inline ir_node *get_nodes_Block (ir_node *node);
 220 inline void     set_nodes_Block (ir_node *node, ir_node *block);
 221
 222 int             get_Block_n_cfgpreds (ir_node *node);
 223 /* inline void    set_Block_n_cfgpreds (ir_node *node, int n_preds); */
 224 inline ir_node *get_Block_cfgpred (ir_node *node, int pos);
 225 inline void     set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
 226 inline bool     get_Block_matured (ir_node *node);
 227 inline void     set_Block_matured (ir_node *node, bool matured);
 228 inline unsigned long get_Block_block_visit (ir_node *node);
 229 inline void     set_Block_block_visit (ir_node *node, unsigned long visit);
 230 inline ir_node *get_Block_graph_arr (ir_node *node, int pos);
 231 inline void     set_Block_graph_arr (ir_node *node, int pos, ir_node *value);
 232
 233 inline ir_node *get_Cond_selector (ir_node *node);
 234 inline void     set_Cond_selector (ir_node *node, ir_node *selector);
 235
 236 inline ir_node *get_Return_mem (ir_node *node);
 237 inline void     set_Return_mem (ir_node *node, ir_node *mem);
 238 inline int      get_Return_n_res (ir_node *node);
 239 /*inline void     set_Return_n_res (ir_node *node, int results); */
 240 inline ir_node *get_Return_res (ir_node *node, int pos);
 241 inline void     set_Return_res (ir_node *node, int pos, ir_node *res);
 242
 243 inline ir_node *get_Raise_mem (ir_node *node);
 244 inline void     set_Raise_mem (ir_node *node, ir_node *mem);
 245 inline ir_node *get_Raise_exoptr (ir_node *node);  /* PoinTeR to EXception Object */
 246 inline void     set_Raise_exoptr (ir_node *node, ir_node *exoptr);
 247
 248 inline tarval  *get_Const_tarval (ir_node *node);
 249 inline void     set_Const_tarval (ir_node *node, tarval *con);
 250
 251 inline symconst_kind get_SymConst_kind (ir_node *node);
 252 inline void          set_SymConst_kind (ir_node *node, symconst_kind num);
 253 inline type    *get_SymConst_type (ir_node *node);
 254 inline void     set_SymConst_type (ir_node *node, type *type);
 255 inline ident   *get_SymConst_ptrinfo (ir_node *node);
 256 inline void     set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
 257
 258 inline ir_node *get_Sel_mem (ir_node *node);
 259 inline void     set_Sel_mem (ir_node *node, ir_node *mem);
 260 inline ir_node *get_Sel_ptr (ir_node *node);  /* ptr to the object to select from */
 261 inline void     set_Sel_ptr (ir_node *node, ir_node *ptr);
 262 inline int      get_Sel_n_index (ir_node *node);
 263 /*inline void     set_Sel_n_index (ir_node *node, int n_index); */
 264 inline ir_node *get_Sel_index (ir_node *node, int pos);
 265 inline void     set_Sel_index (ir_node *node, int pos, ir_node *index);
 266 inline entity  *get_Sel_entity (ir_node *node); /* entity to select */
 267 inline void     set_Sel_entity (ir_node *node, entity *ent);
 268 inline linkage_type get_Sel_linkage_type (ir_node *node);
 269 inline void     set_Sel_linkage_type (ir_node *node, linkage_type lt);
 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 int      get_Call_arity (ir_node *node);
 276 /* inline void     set_Call_arity (ir_node *node, ir_node *arity); */
 277 inline ir_node *get_Call_param (ir_node *node, int pos);
 278 inline void     set_Call_param (ir_node *node, int pos, ir_node *param);
 279 inline type_method *get_Call_type (ir_node *node);
 280 inline void         set_Call_type (ir_node *node, type_method *type);
 281
 282 /* For unary and binary arithmetic operations the access to the
 283    operands can be factored out.  Left is the first, right the
 284    second arithmetic value  as listed in tech report 1999-44.
 285    unops are: Minus, Abs, Not, Conv
 286    binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
 287    Shr, Shrs, Rot, Cmp */
 288 inline int      is_unop (ir_node *node);
 289 inline ir_node *get_unop_op (ir_node *node);
 290 inline void     set_unop_op (ir_node *node, ir_node *op);
 291 inline int      is_binop (ir_node *node);
 292 inline ir_node *get_binop_left (ir_node *node);
 293 inline void     set_binop_left (ir_node *node, ir_node *left);
 294 inline ir_node *get_binop_right (ir_node *node);
 295 inline void     set_binop_right (ir_node *node, ir_node *right);
 296
 297 inline ir_node *get_Add_left (ir_node *node);
 298 inline void     set_Add_left (ir_node *node, ir_node *left);
 299 inline ir_node *get_Add_right (ir_node *node);
 300 inline void     set_Add_right (ir_node *node, ir_node *right);
 301
 302 inline ir_node *get_Sub_left (ir_node *node);
 303 inline void     set_Sub_left (ir_node *node, ir_node *left);
 304 inline ir_node *get_Sub_right (ir_node *node);
 305 inline void     set_Sub_right (ir_node *node, ir_node *right);
 306
 307 inline ir_node *get_Minus_op (ir_node *node);
 308 inline void     set_Minus_op (ir_node *node, ir_node *op);
 309
 310 inline ir_node *get_Mul_left (ir_node *node);
 311 inline void     set_Mul_left (ir_node *node, ir_node *left);
 312 inline ir_node *get_Mul_right (ir_node *node);
 313 inline void     set_Mul_right (ir_node *node, ir_node *right);
 314
 315 inline ir_node *get_Quot_left (ir_node *node);
 316 inline void     set_Quot_left (ir_node *node, ir_node *left);
 317 inline ir_node *get_Quot_right (ir_node *node);
 318 inline void     set_Quot_right (ir_node *node, ir_node *right);
 319 inline ir_node *get_Quot_mem (ir_node *node);
 320 inline void     set_Quot_mem (ir_node *node, ir_node *mem);
 321
 322 inline ir_node *get_DivMod_left (ir_node *node);
 323 inline void     set_DivMod_left (ir_node *node, ir_node *left);
 324 inline ir_node *get_DivMod_right (ir_node *node);
 325 inline void     set_DivMod_right (ir_node *node, ir_node *right);
 326 inline ir_node *get_DivMod_mem (ir_node *node);
 327 inline void     set_DivMod_mem (ir_node *node, ir_node *mem);
 328
 329 inline ir_node *get_Div_left (ir_node *node);
 330 inline void     set_Div_left (ir_node *node, ir_node *left);
 331 inline ir_node *get_Div_right (ir_node *node);
 332 inline void     set_Div_right (ir_node *node, ir_node *right);
 333 inline ir_node *get_Div_mem (ir_node *node);
 334 inline void     set_Div_mem (ir_node *node, ir_node *mem);
 335
 336 inline ir_node *get_Mod_left (ir_node *node);
 337 inline void     set_Mod_left (ir_node *node, ir_node *left);
 338 inline ir_node *get_Mod_right (ir_node *node);
 339 inline void     set_Mod_right (ir_node *node, ir_node *right);
 340 inline ir_node *get_Mod_mem (ir_node *node);
 341 inline void     set_Mod_mem (ir_node *node, ir_node *mem);
 342
 343 inline ir_node *get_Abs_op (ir_node *node);
 344 inline void     set_Abs_op (ir_node *node, ir_node *op);
 345
 346 inline ir_node *get_And_left (ir_node *node);
 347 inline void     set_And_left (ir_node *node, ir_node *left);
 348 inline ir_node *get_And_right (ir_node *node);
 349 inline void     set_And_right (ir_node *node, ir_node *right);
 350
 351 inline ir_node *get_Or_left (ir_node *node);
 352 inline void     set_Or_left (ir_node *node, ir_node *left);
 353 inline ir_node *get_Or_right (ir_node *node);
 354 inline void     set_Or_right (ir_node *node, ir_node *right);
 355
 356 inline ir_node *get_Eor_left (ir_node *node);
 357 inline void     set_Eor_left (ir_node *node, ir_node *left);
 358 inline ir_node *get_Eor_right (ir_node *node);
 359 inline void     set_Eor_right (ir_node *node, ir_node *right);
 360
 361 inline ir_node *get_Not_op (ir_node *node);
 362 inline void     set_Not_op (ir_node *node, ir_node *op);
 363
 364 inline ir_node *get_Cmp_left (ir_node *node);
 365 inline void     set_Cmp_left (ir_node *node, ir_node *left);
 366 inline ir_node *get_Cmp_right (ir_node *node);
 367 inline void     set_Cmp_right (ir_node *node, ir_node *right);
 368
 369 inline ir_node *get_Shl_left (ir_node *node);
 370 inline void     set_Shl_left (ir_node *node, ir_node *left);
 371 inline ir_node *get_Shl_right (ir_node *node);
 372 inline void     set_Shl_right (ir_node *node, ir_node *right);
 373
 374 inline ir_node *get_Shr_left (ir_node *node);
 375 inline void     set_Shr_left (ir_node *node, ir_node *left);
 376 inline ir_node *get_Shr_right (ir_node *node);
 377 inline void     set_Shr_right (ir_node *node, ir_node *right);
 378
 379 inline ir_node *get_Shrs_left (ir_node *node);
 380 inline void     set_Shrs_left (ir_node *node, ir_node *left);
 381 inline ir_node *get_Shrs_right (ir_node *node);
 382 inline void     set_Shrs_right (ir_node *node, ir_node *right);
 383
 384 inline ir_node *get_Rot_left (ir_node *node);
 385 inline void     set_Rot_left (ir_node *node, ir_node *left);
 386 inline ir_node *get_Rot_right (ir_node *node);
 387 inline void     set_Rot_right (ir_node *node, ir_node *right);
 388
 389 inline ir_node *get_Conv_op (ir_node *node);
 390 inline void     set_Conv_op (ir_node *node, ir_node *op);
 391
 392 inline int      get_Phi_n_preds (ir_node *node);
 393 /* inline void     set_Phi_n_preds (ir_node *node, int n_preds); */
 394 inline ir_node *get_Phi_pred (ir_node *node, int pos);
 395 inline void     set_Phi_pred (ir_node *node, int pos, ir_node *pred);
 396
 397 inline ir_node *get_Load_mem (ir_node *node);
 398 inline void     set_Load_mem (ir_node *node, ir_node *mem);
 399 inline ir_node *get_Load_ptr (ir_node *node);
 400 inline void     set_Load_ptr (ir_node *node, ir_node *ptr);
 401
 402 inline ir_node *get_Store_mem (ir_node *node);
 403 inline void     set_Store_mem (ir_node *node, ir_node *mem);
 404 inline ir_node *get_Store_ptr (ir_node *node);
 405 inline void     set_Store_ptr (ir_node *node, ir_node *ptr);
 406 inline ir_node *get_Store_value (ir_node *node);
 407 inline void     set_Store_value (ir_node *node, ir_node *value);
 408
 409 inline ir_node *get_Alloc_mem (ir_node *node);
 410 inline void     set_Alloc_mem (ir_node *node, ir_node *mem);
 411 inline ir_node *get_Alloc_size (ir_node *node);
 412 inline void     set_Alloc_size (ir_node *node, ir_node *size);
 413 inline type    *get_Alloc_type (ir_node *node);
 414 inline void     set_Alloc_type (ir_node *node, type *type);
 415 inline where_alloc  get_Alloc_where (ir_node *node);
 416 inline void         set_Alloc_where (ir_node *node, where_alloc where);
 417
 418 inline ir_node *get_Free_mem (ir_node *node);
 419 inline void     set_Free_mem (ir_node *node, ir_node *mem);
 420 inline ir_node *get_Free_ptr (ir_node *node);
 421 inline void     set_Free_ptr (ir_node *node, ir_node *ptr);
 422 inline ir_node *get_Free_size (ir_node *node);
 423 inline void     set_Free_size (ir_node *node, ir_node *size);
 424 inline type    *get_Free_type (ir_node *node);
 425 inline void     set_Free_type (ir_node *node, type *type);
 426
 427 inline int      get_Sync_n_preds (ir_node *node);
 428 /* inline void     set_Sync_n_preds (ir_node *node, int n_preds); */
 429 inline ir_node *get_Sync_pred (ir_node *node, int pos);
 430 inline void     set_Sync_pred (ir_node *node, int pos, ir_node *pred);
 431
 432 inline ir_node *get_Proj_pred (ir_node *node);
 433 inline void     set_Proj_pred (ir_node *node, ir_node *pred);
 434 inline long     get_Proj_proj (ir_node *node);
 435 inline void     set_Proj_proj (ir_node *node, long proj);
 436
 437 inline int      get_Tuple_n_preds (ir_node *node);
 438 /* inline void     set_Tuple_n_preds (ir_node *node, int n_preds); */
 439 inline ir_node *get_Tuple_pred (ir_node *node, int pos);
 440 inline void     set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
 441
 442 inline ir_node *get_Id_pred (ir_node *node);
 443 inline void     set_Id_pred (ir_node *node, ir_node *pred);
 444
 445
 446
 447 /******************************************************************/
 448 /*  Auxiliary routines                                            */
 449 /******************************************************************/
 450
 451 /* returns operand of node if node is a Proj. */
 452 inline ir_node *skip_Proj (ir_node *node);
 453 /* returns operand of node if node is a Id */
 454 inline ir_node *skip_nop  (ir_node *node);
 455 /* returns true if node is a Bad node. */
 456 inline int      is_Bad    (ir_node *node);
 457 /* returns true if the node is not a Block */
 458 inline int      is_no_Block (ir_node *node);
 459 /* Returns true if the operation manipulates control flow:
 460    Start, End, Jmp, Cond, Return, Raise */
 461 int is_cfop(ir_node *node);
 462 /* Returns true if the operation can change the control flow because
 463    of an exception. */
 464 int is_fragile_op(ir_node *node);
 465
 466 # endif /* _IRNODE_H_ */