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