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