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

   1 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
   2 ** All rights reserved.
   3 **
   4 ** Authors: Martin Trapp, Christian Schaefer
   5 **
   6 ** declarations of an ir node
   7 */
   8
   9 # ifndef _IRNODE_H_
  10 # define _IRNODE_H_
  11
  12 # include "irgraph.h"
  13 # include "entity.h"
  14 # include "common.h"
  15 # include "irop.h"
  16 # include "irmode.h"
  17 # include "tv.h"
  18 # include "type.h"
  19
  20 /* The typedefiniton of ir_node is also in irgraph.h to resolve
  21    recursion between irnode.h and irgraph.h */
  22 #ifndef _IR_NODE_TYPEDEF_
  23 #define _IR_NODE_TYPEDEF_
  24 typedef struct ir_node ir_node;
  25 #endif
  26
  27 /* irnode constructor                                             */
  28 /* Create a new irnode in irg, with an op, mode, arity and        */
  29 /* some incoming irnodes.                                         */
  30 /* If arity is negative, a node with a dynamic array is created.  */
  31
  32 inline ir_node *
  33 new_ir_node (ir_graph *irg,
  34              ir_node *block,
  35              ir_op *op,
  36              ir_mode *mode,
  37              int arity,
  38              ir_node **in);
  39
  40 /** Manipulate the fields of ir_node.  With these access routines
  41     you can work on the graph without considering the different types
  42     of nodes, it's just a big graph. **/
  43
  44 /* returns the number of predecessors without the block predecessor: */
  45 int                  get_irn_arity         (ir_node *node);
  46 /* returns the array with the ins: */
  47 inline ir_node     **get_irn_in            (ir_node *node);
  48 /* to iterate through the predecessors without touching the array. No
  49    order of predecessors guaranteed.
  50    To iterate over the operands iterate from 0 to i < get_irn_arity(),
  51    to iterate including the Block predecessor iterate from i = -1 to
  52    i < get_irn_arity. */
  53 /* Access predecessor n */
  54 inline ir_node      *get_irn_n             (ir_node *node, int n);
  55 inline void          set_irn_n             (ir_node *node, int n, ir_node *in);
  56 /* Get the mode struct. */
  57 inline ir_mode      *get_irn_mode          (ir_node *node);
  58 /* Get the mode-enum modecode */
  59 inline modecode      get_irn_modecode      (ir_node *node);
  60 /* Get the ident for a string representation of the mode */
  61 inline ident        *get_irn_modename      (ir_node *node);
  62 /* Access the opcode struct of the node */
  63 inline ir_op        *get_irn_op            (ir_node *node);
  64 inline void          set_irn_op            (ir_node *node, ir_op *op);
  65 /* Get the opcode-enum of the node */
  66 inline opcode        get_irn_opcode        (ir_node *node);
  67 /* Get the ident for a string representation of the opcode */
  68 inline const char   *get_irn_opname        (ir_node *node);
  69 inline ident        *get_irn_opident       (ir_node *node);
  70 inline void          set_irn_visited (ir_node *node, unsigned long visited);
  71 inline unsigned long get_irn_visited (ir_node *node);
  72 inline void          set_irn_link          (ir_node *node, ir_node *link);
  73 inline ir_node      *get_irn_link          (ir_node *node);
  74 #ifdef DEBUG_libfirm
  75 /* Outputs a unique number for this node */
  76 inline long get_irn_node_nr(ir_node *node);
  77 #endif
  78
  79 /** Manipulate fields of individual nodes. **/
  80
  81 /* this works for all except Block */
  82 inline ir_node  *get_nodes_Block (ir_node *node);
  83 inline void      set_nodes_Block (ir_node *node, ir_node *block);
  84
  85 /* Projection numbers for result of Start node: use for Proj nodes! */
  86 typedef enum {
  87   pns_initial_exec,     /* Projection on an executable, the initial control
  88                            flow. */
  89   pns_global_store,     /* Projection on the global store */
  90   pns_frame_base,       /* Projection on the frame base */
  91   pns_globals,          /* Projection on the pointer to the data segment
  92                            containing _all_ global entities. */
  93   pns_args              /* Projection on all arguments */
  94 } pns_number;
  95
  96 inline ir_node **get_Block_cfgpred_arr (ir_node *node);
  97 int              get_Block_n_cfgpreds (ir_node *node);
  98 /* inline void    set_Block_n_cfgpreds (ir_node *node, int n_preds); */
  99 inline ir_node  *get_Block_cfgpred (ir_node *node, int pos);
 100 inline void      set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
 101 inline bool      get_Block_matured (ir_node *node);
 102 inline void      set_Block_matured (ir_node *node, bool matured);
 103 inline unsigned long get_Block_block_visited (ir_node *node);
 104 inline void      set_Block_block_visited (ir_node *node, unsigned long visit);
 105 inline ir_node  *get_Block_graph_arr (ir_node *node, int pos);
 106 inline void      set_Block_graph_arr (ir_node *node, int pos, ir_node *value);
 107
 108 inline ir_node  *get_Cond_selector (ir_node *node);
 109 inline void      set_Cond_selector (ir_node *node, ir_node *selector);
 110
 111 inline ir_node  *get_Return_mem (ir_node *node);
 112 inline void      set_Return_mem (ir_node *node, ir_node *mem);
 113 inline ir_node **get_Return_res_arr (ir_node *node);
 114 inline int       get_Return_n_res (ir_node *node);
 115 /*inline void     set_Return_n_res (ir_node *node, int results); */
 116 inline ir_node  *get_Return_res (ir_node *node, int pos);
 117 inline void      set_Return_res (ir_node *node, int pos, ir_node *res);
 118
 119 inline ir_node *get_Raise_mem (ir_node *node);
 120 inline void     set_Raise_mem (ir_node *node, ir_node *mem);
 121 inline ir_node *get_Raise_exo_ptr (ir_node *node);  /* PoinTeR to EXception Object */
 122 inline void     set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
 123
 124 inline tarval  *get_Const_tarval (ir_node *node);
 125 inline void     set_Const_tarval (ir_node *node, tarval *con);
 126
 127 /*   This enum names the three different kinds of symbolic Constants
 128      represented by SymConst.  The content of the attribute type_or_id
 129      depends on this tag.  Use the proper access routine after testing
 130      this flag. */
 131 typedef enum {
 132   type_tag,          /* The SymConst is a type tag for the given type.
 133                         Type_or_id_p is type * */
 134   size,              /* The SymConst is the size of the given type.
 135                         Type_or_id_p is type * */
 136   linkage_ptr_info   /* The SymConst is a symbolic pointer to be filled in
 137                         by the linker. Type_or_id_p is ident * */
 138 } symconst_kind;
 139 typedef union type_or_id * type_or_id_p;
 140 inline symconst_kind get_SymConst_kind (ir_node *node);
 141 inline void          set_SymConst_kind (ir_node *node, symconst_kind num);
 142 inline type    *get_SymConst_type (ir_node *node);
 143 inline void     set_SymConst_type (ir_node *node, type *type);
 144 inline ident   *get_SymConst_ptrinfo (ir_node *node);
 145 inline void     set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
 146
 147 inline ir_node *get_Sel_mem (ir_node *node);
 148 inline void     set_Sel_mem (ir_node *node, ir_node *mem);
 149 inline ir_node *get_Sel_ptr (ir_node *node);  /* ptr to the object to select from */
 150 inline void     set_Sel_ptr (ir_node *node, ir_node *ptr);
 151 inline ir_node **get_Sel_index_arr (ir_node *node);
 152 inline int      get_Sel_n_index (ir_node *node);
 153 /*inline void     set_Sel_n_index (ir_node *node, int n_index); */
 154 inline ir_node *get_Sel_index (ir_node *node, int pos);
 155 inline void     set_Sel_index (ir_node *node, int pos, ir_node *index);
 156 inline entity  *get_Sel_entity (ir_node *node); /* entity to select */
 157 inline void     set_Sel_entity (ir_node *node, entity *ent);
 158 typedef enum {
 159   static_linkage,       /* entity is used internal and not visible out of this
 160                            file/class. */
 161   external_linkage,     /* */
 162   no_linkage
 163 } linkage_type;
 164 inline linkage_type get_Sel_linkage_type (ir_node *node);
 165 inline void     set_Sel_linkage_type (ir_node *node, linkage_type lt);
 166
 167 inline ir_node *get_Call_mem (ir_node *node);
 168 inline void     set_Call_mem (ir_node *node, ir_node *mem);
 169 inline ir_node *get_Call_ptr (ir_node *node);
 170 inline void     set_Call_ptr (ir_node *node, ir_node *ptr);
 171 inline ir_node **get_Call_param_arr (ir_node *node);
 172 inline int      get_Call_n_params (ir_node *node);
 173 inline int      get_Call_arity (ir_node *node);
 174 /* inline void     set_Call_arity (ir_node *node, ir_node *arity); */
 175 inline ir_node *get_Call_param (ir_node *node, int pos);
 176 inline void     set_Call_param (ir_node *node, int pos, ir_node *param);
 177 inline type_method *get_Call_type (ir_node *node);
 178 inline void     set_Call_type (ir_node *node, type_method *type);
 179
 180 /* For unary and binary arithmetic operations the access to the
 181    operands can be factored out.  Left is the first, right the
 182    second arithmetic value  as listed in tech report 1999-44.
 183    unops are: Minus, Abs, Not, Conv
 184    binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
 185    Shr, Shrs, Rot, Cmp */
 186 inline int      is_unop (ir_node *node);
 187 inline ir_node *get_unop_op (ir_node *node);
 188 inline void     set_unop_op (ir_node *node, ir_node *op);
 189 inline int      is_binop (ir_node *node);
 190 inline ir_node *get_binop_left (ir_node *node);
 191 inline void     set_binop_left (ir_node *node, ir_node *left);
 192 inline ir_node *get_binop_right (ir_node *node);
 193 inline void     set_binop_right (ir_node *node, ir_node *right);
 194
 195 inline ir_node *get_Add_left (ir_node *node);
 196 inline void     set_Add_left (ir_node *node, ir_node *left);
 197 inline ir_node *get_Add_right (ir_node *node);
 198 inline void     set_Add_right (ir_node *node, ir_node *right);
 199
 200 inline ir_node *get_Sub_left (ir_node *node);
 201 inline void     set_Sub_left (ir_node *node, ir_node *left);
 202 inline ir_node *get_Sub_right (ir_node *node);
 203 inline void     set_Sub_right (ir_node *node, ir_node *right);
 204
 205 inline ir_node *get_Minus_op (ir_node *node);
 206 inline void     set_Minus_op (ir_node *node, ir_node *op);
 207
 208 inline ir_node *get_Mul_left (ir_node *node);
 209 inline void     set_Mul_left (ir_node *node, ir_node *left);
 210 inline ir_node *get_Mul_right (ir_node *node);
 211 inline void     set_Mul_right (ir_node *node, ir_node *right);
 212
 213 inline ir_node *get_Quot_left (ir_node *node);
 214 inline void     set_Quot_left (ir_node *node, ir_node *left);
 215 inline ir_node *get_Quot_right (ir_node *node);
 216 inline void     set_Quot_right (ir_node *node, ir_node *right);
 217 inline ir_node *get_Quot_mem (ir_node *node);
 218 inline void     set_Quot_mem (ir_node *node, ir_node *mem);
 219
 220 inline ir_node *get_DivMod_left (ir_node *node);
 221 inline void     set_DivMod_left (ir_node *node, ir_node *left);
 222 inline ir_node *get_DivMod_right (ir_node *node);
 223 inline void     set_DivMod_right (ir_node *node, ir_node *right);
 224 inline ir_node *get_DivMod_mem (ir_node *node);
 225 inline void     set_DivMod_mem (ir_node *node, ir_node *mem);
 226
 227 inline ir_node *get_Div_left (ir_node *node);
 228 inline void     set_Div_left (ir_node *node, ir_node *left);
 229 inline ir_node *get_Div_right (ir_node *node);
 230 inline void     set_Div_right (ir_node *node, ir_node *right);
 231 inline ir_node *get_Div_mem (ir_node *node);
 232 inline void     set_Div_mem (ir_node *node, ir_node *mem);
 233
 234 inline ir_node *get_Mod_left (ir_node *node);
 235 inline void     set_Mod_left (ir_node *node, ir_node *left);
 236 inline ir_node *get_Mod_right (ir_node *node);
 237 inline void     set_Mod_right (ir_node *node, ir_node *right);
 238 inline ir_node *get_Mod_mem (ir_node *node);
 239 inline void     set_Mod_mem (ir_node *node, ir_node *mem);
 240
 241 inline ir_node *get_Abs_op (ir_node *node);
 242 inline void     set_Abs_op (ir_node *node, ir_node *op);
 243
 244 inline ir_node *get_And_left (ir_node *node);
 245 inline void     set_And_left (ir_node *node, ir_node *left);
 246 inline ir_node *get_And_right (ir_node *node);
 247 inline void     set_And_right (ir_node *node, ir_node *right);
 248
 249 inline ir_node *get_Or_left (ir_node *node);
 250 inline void     set_Or_left (ir_node *node, ir_node *left);
 251 inline ir_node *get_Or_right (ir_node *node);
 252 inline void     set_Or_right (ir_node *node, ir_node *right);
 253
 254 inline ir_node *get_Eor_left (ir_node *node);
 255 inline void     set_Eor_left (ir_node *node, ir_node *left);
 256 inline ir_node *get_Eor_right (ir_node *node);
 257 inline void     set_Eor_right (ir_node *node, ir_node *right);
 258
 259 inline ir_node *get_Not_op (ir_node *node);
 260 inline void     set_Not_op (ir_node *node, ir_node *op);
 261
 262 /* Projection numbers of compare: use for Proj nodes! */
 263 typedef enum {
 264   False,                /* false */
 265   Eq,                   /* equal */
 266   Lt,                   /* less */
 267   Le,                   /* less or equal */
 268   Gt,                   /* greater */
 269   Ge,                   /* greater or equal */
 270   Lg,                   /* less or greater */
 271   Leg,                  /* less, equal or greater = ordered */
 272   Uo,                   /* unordered */
 273   Ue,                   /* unordered or equal */
 274   Ul,                   /* unordered or less */
 275   Ule,                  /* unordered, less or equal */
 276   Ug,                   /* unordered or greater */
 277   Uge,                  /* unordered, greater or equal */
 278   Ne,                   /* unordered, less or greater = not equal */
 279   True,                 /* true */
 280   not_mask = Leg        /* bits to flip to negate comparison */
 281 } pnc_number;
 282 inline char *get_pnc_string(int pnc);
 283 inline int   get_negated_pnc(int pnc);
 284 inline ir_node *get_Cmp_left (ir_node *node);
 285 inline void     set_Cmp_left (ir_node *node, ir_node *left);
 286 inline ir_node *get_Cmp_right (ir_node *node);
 287 inline void     set_Cmp_right (ir_node *node, ir_node *right);
 288
 289 inline ir_node *get_Shl_left (ir_node *node);
 290 inline void     set_Shl_left (ir_node *node, ir_node *left);
 291 inline ir_node *get_Shl_right (ir_node *node);
 292 inline void     set_Shl_right (ir_node *node, ir_node *right);
 293
 294 inline ir_node *get_Shr_left (ir_node *node);
 295 inline void     set_Shr_left (ir_node *node, ir_node *left);
 296 inline ir_node *get_Shr_right (ir_node *node);
 297 inline void     set_Shr_right (ir_node *node, ir_node *right);
 298
 299 inline ir_node *get_Shrs_left (ir_node *node);
 300 inline void     set_Shrs_left (ir_node *node, ir_node *left);
 301 inline ir_node *get_Shrs_right (ir_node *node);
 302 inline void     set_Shrs_right (ir_node *node, ir_node *right);
 303
 304 inline ir_node *get_Rot_left (ir_node *node);
 305 inline void     set_Rot_left (ir_node *node, ir_node *left);
 306 inline ir_node *get_Rot_right (ir_node *node);
 307 inline void     set_Rot_right (ir_node *node, ir_node *right);
 308
 309 inline ir_node *get_Conv_op (ir_node *node);
 310 inline void     set_Conv_op (ir_node *node, ir_node *op);
 311
 312 inline ir_node **get_Phi_preds_arr (ir_node *node);
 313 inline int       get_Phi_n_preds (ir_node *node);
 314 /* inline void     set_Phi_n_preds (ir_node *node, int n_preds); */
 315 inline ir_node  *get_Phi_pred (ir_node *node, int pos);
 316 inline void      set_Phi_pred (ir_node *node, int pos, ir_node *pred);
 317
 318 inline ir_node *get_Load_mem (ir_node *node);
 319 inline void     set_Load_mem (ir_node *node, ir_node *mem);
 320 inline ir_node *get_Load_ptr (ir_node *node);
 321 inline void     set_Load_ptr (ir_node *node, ir_node *ptr);
 322
 323 inline ir_node *get_Store_mem (ir_node *node);
 324 inline void     set_Store_mem (ir_node *node, ir_node *mem);
 325 inline ir_node *get_Store_ptr (ir_node *node);
 326 inline void     set_Store_ptr (ir_node *node, ir_node *ptr);
 327 inline ir_node *get_Store_value (ir_node *node);
 328 inline void     set_Store_value (ir_node *node, ir_node *value);
 329
 330 inline ir_node *get_Alloc_mem (ir_node *node);
 331 inline void     set_Alloc_mem (ir_node *node, ir_node *mem);
 332 inline ir_node *get_Alloc_size (ir_node *node);
 333 inline void     set_Alloc_size (ir_node *node, ir_node *size);
 334 inline type    *get_Alloc_type (ir_node *node);
 335 inline void     set_Alloc_type (ir_node *node, type *type);
 336 typedef enum {
 337   stack_alloc,          /* Alloc allocates the object on the stack. */
 338   heap_alloc            /* Alloc allocates the object on the heap. */
 339 } where_alloc;
 340 inline where_alloc  get_Alloc_where (ir_node *node);
 341 inline void         set_Alloc_where (ir_node *node, where_alloc where);
 342
 343 inline ir_node *get_Free_mem (ir_node *node);
 344 inline void     set_Free_mem (ir_node *node, ir_node *mem);
 345 inline ir_node *get_Free_ptr (ir_node *node);
 346 inline void     set_Free_ptr (ir_node *node, ir_node *ptr);
 347 inline ir_node *get_Free_size (ir_node *node);
 348 inline void     set_Free_size (ir_node *node, ir_node *size);
 349 inline type    *get_Free_type (ir_node *node);
 350 inline void     set_Free_type (ir_node *node, type *type);
 351
 352 inline ir_node **get_Sync_preds_arr (ir_node *node);
 353 inline int       get_Sync_n_preds (ir_node *node);
 354 /* inline void     set_Sync_n_preds (ir_node *node, int n_preds); */
 355 inline ir_node  *get_Sync_pred (ir_node *node, int pos);
 356 inline void      set_Sync_pred (ir_node *node, int pos, ir_node *pred);
 357
 358 inline ir_node  *get_Proj_pred (ir_node *node);
 359 inline void      set_Proj_pred (ir_node *node, ir_node *pred);
 360 inline long      get_Proj_proj (ir_node *node);
 361 inline void      set_Proj_proj (ir_node *node, long proj);
 362
 363 inline ir_node **get_Tuple_preds_arr (ir_node *node);
 364 inline int       get_Tuple_n_preds (ir_node *node);
 365 /* inline void     set_Tuple_n_preds (ir_node *node, int n_preds); */
 366 inline ir_node  *get_Tuple_pred (ir_node *node, int pos);
 367 inline void      set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
 368
 369 inline ir_node  *get_Id_pred (ir_node *node);
 370 inline void      set_Id_pred (ir_node *node, ir_node *pred);
 371
 372
 373
 374 /******************************************************************/
 375 /*  Auxiliary routines                                            */
 376 /******************************************************************/
 377
 378 /* returns operand of node if node is a Proj. */
 379 inline ir_node *skip_Proj (ir_node *node);
 380 /* returns operand of node if node is a Id */
 381 inline ir_node *skip_nop  (ir_node *node);
 382 /* returns true if node is a Bad node. */
 383 inline int      is_Bad    (ir_node *node);
 384 /* returns true if the node is not a Block */
 385 inline int      is_no_Block (ir_node *node);
 386 /* Returns true if the operation manipulates control flow:
 387    Start, End, Jmp, Cond, Return, Raise */
 388 int is_cfop(ir_node *node);
 389 /* Returns true if the operation can change the control flow because
 390    of an exception. */
 391 int is_fragile_op(ir_node *node);
 392
 393
 394
 395 /* Makros for debugging the libfirm */
 396 #ifdef DEBUG_libfirm
 397 #include "ident.h"
 398
 399 #define DDMSG        printf("%s(l.%i)\n", __FUNCTION__, __LINE__)
 400 #define DDMSG1(X)    printf("%s(l.%i) %s\n", __FUNCTION__, __LINE__,         \
 401                             id_to_str(get_irn_opident(X)))
 402 #define DDMSG2(X)    printf("%s(l.%i) %s: %ld\n", __FUNCTION__, __LINE__,     \
 403                      id_to_str(get_irn_opident(X)), get_irn_node_nr(X))
 404 #define DDMSG3(X)    printf("%s(l.%i) %s: %p\n", __FUNCTION__, __LINE__,     \
 405                      print_firm_kind(X), (X))
 406
 407 #endif
 408
 409 # endif /* _IRNODE_H_ */