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