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_modeident     (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 /* Only to access SymConst of kind type_tag or size.  Else assertion: */
 143 inline type    *get_SymConst_type (ir_node *node);
 144 inline void     set_SymConst_type (ir_node *node, type *type);
 145 /* Only to access SymConst of kind linkage_ptr_info.  Else assertion: */
 146 inline ident   *get_SymConst_ptrinfo (ir_node *node);
 147 inline void     set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
 148 /* Sets both: type and ptrinfo.  Needed to treat the node independent of
 149    its semantics.  Does a memcpy for the memory tori points to. */
 150 inline type_or_id_p get_SymConst_type_or_id (ir_node *node);
 151 inline void set_SymConst_type_or_id (ir_node *node, type_or_id_p tori);
 152
 153 inline ir_node *get_Sel_mem (ir_node *node);
 154 inline void     set_Sel_mem (ir_node *node, ir_node *mem);
 155 inline ir_node *get_Sel_ptr (ir_node *node);  /* ptr to the object to select from */
 156 inline void     set_Sel_ptr (ir_node *node, ir_node *ptr);
 157 inline ir_node **get_Sel_index_arr (ir_node *node);
 158 inline int      get_Sel_n_index (ir_node *node);
 159 /*inline void     set_Sel_n_index (ir_node *node, int n_index); */
 160 inline ir_node *get_Sel_index (ir_node *node, int pos);
 161 inline void     set_Sel_index (ir_node *node, int pos, ir_node *index);
 162 inline entity  *get_Sel_entity (ir_node *node); /* entity to select */
 163 inline void     set_Sel_entity (ir_node *node, entity *ent);
 164 typedef enum {
 165   static_linkage,       /* entity is used internal and not visible out of this
 166                            file/class. */
 167   external_linkage,     /* */
 168   no_linkage
 169 } linkage_type;
 170 inline linkage_type get_Sel_linkage_type (ir_node *node);
 171 inline void     set_Sel_linkage_type (ir_node *node, linkage_type lt);
 172
 173 inline ir_node *get_Call_mem (ir_node *node);
 174 inline void     set_Call_mem (ir_node *node, ir_node *mem);
 175 inline ir_node *get_Call_ptr (ir_node *node);
 176 inline void     set_Call_ptr (ir_node *node, ir_node *ptr);
 177 inline ir_node **get_Call_param_arr (ir_node *node);
 178 inline int      get_Call_n_params (ir_node *node);
 179 inline int      get_Call_arity (ir_node *node);
 180 /* inline void     set_Call_arity (ir_node *node, ir_node *arity); */
 181 inline ir_node *get_Call_param (ir_node *node, int pos);
 182 inline void     set_Call_param (ir_node *node, int pos, ir_node *param);
 183 inline type_method *get_Call_type (ir_node *node);
 184 inline void     set_Call_type (ir_node *node, type_method *type);
 185
 186 /* For unary and binary arithmetic operations the access to the
 187    operands can be factored out.  Left is the first, right the
 188    second arithmetic value  as listed in tech report 1999-44.
 189    unops are: Minus, Abs, Not, Conv
 190    binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
 191    Shr, Shrs, Rot, Cmp */
 192 inline int      is_unop (ir_node *node);
 193 inline ir_node *get_unop_op (ir_node *node);
 194 inline void     set_unop_op (ir_node *node, ir_node *op);
 195 inline int      is_binop (ir_node *node);
 196 inline ir_node *get_binop_left (ir_node *node);
 197 inline void     set_binop_left (ir_node *node, ir_node *left);
 198 inline ir_node *get_binop_right (ir_node *node);
 199 inline void     set_binop_right (ir_node *node, ir_node *right);
 200
 201 inline ir_node *get_Add_left (ir_node *node);
 202 inline void     set_Add_left (ir_node *node, ir_node *left);
 203 inline ir_node *get_Add_right (ir_node *node);
 204 inline void     set_Add_right (ir_node *node, ir_node *right);
 205
 206 inline ir_node *get_Sub_left (ir_node *node);
 207 inline void     set_Sub_left (ir_node *node, ir_node *left);
 208 inline ir_node *get_Sub_right (ir_node *node);
 209 inline void     set_Sub_right (ir_node *node, ir_node *right);
 210
 211 inline ir_node *get_Minus_op (ir_node *node);
 212 inline void     set_Minus_op (ir_node *node, ir_node *op);
 213
 214 inline ir_node *get_Mul_left (ir_node *node);
 215 inline void     set_Mul_left (ir_node *node, ir_node *left);
 216 inline ir_node *get_Mul_right (ir_node *node);
 217 inline void     set_Mul_right (ir_node *node, ir_node *right);
 218
 219 inline ir_node *get_Quot_left (ir_node *node);
 220 inline void     set_Quot_left (ir_node *node, ir_node *left);
 221 inline ir_node *get_Quot_right (ir_node *node);
 222 inline void     set_Quot_right (ir_node *node, ir_node *right);
 223 inline ir_node *get_Quot_mem (ir_node *node);
 224 inline void     set_Quot_mem (ir_node *node, ir_node *mem);
 225
 226 inline ir_node *get_DivMod_left (ir_node *node);
 227 inline void     set_DivMod_left (ir_node *node, ir_node *left);
 228 inline ir_node *get_DivMod_right (ir_node *node);
 229 inline void     set_DivMod_right (ir_node *node, ir_node *right);
 230 inline ir_node *get_DivMod_mem (ir_node *node);
 231 inline void     set_DivMod_mem (ir_node *node, ir_node *mem);
 232
 233 inline ir_node *get_Div_left (ir_node *node);
 234 inline void     set_Div_left (ir_node *node, ir_node *left);
 235 inline ir_node *get_Div_right (ir_node *node);
 236 inline void     set_Div_right (ir_node *node, ir_node *right);
 237 inline ir_node *get_Div_mem (ir_node *node);
 238 inline void     set_Div_mem (ir_node *node, ir_node *mem);
 239
 240 inline ir_node *get_Mod_left (ir_node *node);
 241 inline void     set_Mod_left (ir_node *node, ir_node *left);
 242 inline ir_node *get_Mod_right (ir_node *node);
 243 inline void     set_Mod_right (ir_node *node, ir_node *right);
 244 inline ir_node *get_Mod_mem (ir_node *node);
 245 inline void     set_Mod_mem (ir_node *node, ir_node *mem);
 246
 247 inline ir_node *get_Abs_op (ir_node *node);
 248 inline void     set_Abs_op (ir_node *node, ir_node *op);
 249
 250 inline ir_node *get_And_left (ir_node *node);
 251 inline void     set_And_left (ir_node *node, ir_node *left);
 252 inline ir_node *get_And_right (ir_node *node);
 253 inline void     set_And_right (ir_node *node, ir_node *right);
 254
 255 inline ir_node *get_Or_left (ir_node *node);
 256 inline void     set_Or_left (ir_node *node, ir_node *left);
 257 inline ir_node *get_Or_right (ir_node *node);
 258 inline void     set_Or_right (ir_node *node, ir_node *right);
 259
 260 inline ir_node *get_Eor_left (ir_node *node);
 261 inline void     set_Eor_left (ir_node *node, ir_node *left);
 262 inline ir_node *get_Eor_right (ir_node *node);
 263 inline void     set_Eor_right (ir_node *node, ir_node *right);
 264
 265 inline ir_node *get_Not_op (ir_node *node);
 266 inline void     set_Not_op (ir_node *node, ir_node *op);
 267
 268 /* Projection numbers of compare: use for Proj nodes! */
 269 typedef enum {
 270   False,                /* false */
 271   Eq,                   /* equal */
 272   Lt,                   /* less */
 273   Le,                   /* less or equal */
 274   Gt,                   /* greater */
 275   Ge,                   /* greater or equal */
 276   Lg,                   /* less or greater */
 277   Leg,                  /* less, equal or greater = ordered */
 278   Uo,                   /* unordered */
 279   Ue,                   /* unordered or equal */
 280   Ul,                   /* unordered or less */
 281   Ule,                  /* unordered, less or equal */
 282   Ug,                   /* unordered or greater */
 283   Uge,                  /* unordered, greater or equal */
 284   Ne,                   /* unordered, less or greater = not equal */
 285   True,                 /* true */
 286   not_mask = Leg        /* bits to flip to negate comparison */
 287 } pnc_number;
 288 inline char *get_pnc_string(int pnc);
 289 inline int   get_negated_pnc(int pnc);
 290 inline ir_node *get_Cmp_left (ir_node *node);
 291 inline void     set_Cmp_left (ir_node *node, ir_node *left);
 292 inline ir_node *get_Cmp_right (ir_node *node);
 293 inline void     set_Cmp_right (ir_node *node, ir_node *right);
 294
 295 inline ir_node *get_Shl_left (ir_node *node);
 296 inline void     set_Shl_left (ir_node *node, ir_node *left);
 297 inline ir_node *get_Shl_right (ir_node *node);
 298 inline void     set_Shl_right (ir_node *node, ir_node *right);
 299
 300 inline ir_node *get_Shr_left (ir_node *node);
 301 inline void     set_Shr_left (ir_node *node, ir_node *left);
 302 inline ir_node *get_Shr_right (ir_node *node);
 303 inline void     set_Shr_right (ir_node *node, ir_node *right);
 304
 305 inline ir_node *get_Shrs_left (ir_node *node);
 306 inline void     set_Shrs_left (ir_node *node, ir_node *left);
 307 inline ir_node *get_Shrs_right (ir_node *node);
 308 inline void     set_Shrs_right (ir_node *node, ir_node *right);
 309
 310 inline ir_node *get_Rot_left (ir_node *node);
 311 inline void     set_Rot_left (ir_node *node, ir_node *left);
 312 inline ir_node *get_Rot_right (ir_node *node);
 313 inline void     set_Rot_right (ir_node *node, ir_node *right);
 314
 315 inline ir_node *get_Conv_op (ir_node *node);
 316 inline void     set_Conv_op (ir_node *node, ir_node *op);
 317
 318 inline ir_node **get_Phi_preds_arr (ir_node *node);
 319 inline int       get_Phi_n_preds (ir_node *node);
 320 /* inline void     set_Phi_n_preds (ir_node *node, int n_preds); */
 321 inline ir_node  *get_Phi_pred (ir_node *node, int pos);
 322 inline void      set_Phi_pred (ir_node *node, int pos, ir_node *pred);
 323
 324 inline ir_node *get_Load_mem (ir_node *node);
 325 inline void     set_Load_mem (ir_node *node, ir_node *mem);
 326 inline ir_node *get_Load_ptr (ir_node *node);
 327 inline void     set_Load_ptr (ir_node *node, ir_node *ptr);
 328
 329 inline ir_node *get_Store_mem (ir_node *node);
 330 inline void     set_Store_mem (ir_node *node, ir_node *mem);
 331 inline ir_node *get_Store_ptr (ir_node *node);
 332 inline void     set_Store_ptr (ir_node *node, ir_node *ptr);
 333 inline ir_node *get_Store_value (ir_node *node);
 334 inline void     set_Store_value (ir_node *node, ir_node *value);
 335
 336 inline ir_node *get_Alloc_mem (ir_node *node);
 337 inline void     set_Alloc_mem (ir_node *node, ir_node *mem);
 338 inline ir_node *get_Alloc_size (ir_node *node);
 339 inline void     set_Alloc_size (ir_node *node, ir_node *size);
 340 inline type    *get_Alloc_type (ir_node *node);
 341 inline void     set_Alloc_type (ir_node *node, type *type);
 342 typedef enum {
 343   stack_alloc,          /* Alloc allocates the object on the stack. */
 344   heap_alloc            /* Alloc allocates the object on the heap. */
 345 } where_alloc;
 346 inline where_alloc  get_Alloc_where (ir_node *node);
 347 inline void         set_Alloc_where (ir_node *node, where_alloc where);
 348
 349 inline ir_node *get_Free_mem (ir_node *node);
 350 inline void     set_Free_mem (ir_node *node, ir_node *mem);
 351 inline ir_node *get_Free_ptr (ir_node *node);
 352 inline void     set_Free_ptr (ir_node *node, ir_node *ptr);
 353 inline ir_node *get_Free_size (ir_node *node);
 354 inline void     set_Free_size (ir_node *node, ir_node *size);
 355 inline type    *get_Free_type (ir_node *node);
 356 inline void     set_Free_type (ir_node *node, type *type);
 357
 358 inline ir_node **get_Sync_preds_arr (ir_node *node);
 359 inline int       get_Sync_n_preds (ir_node *node);
 360 /* inline void     set_Sync_n_preds (ir_node *node, int n_preds); */
 361 inline ir_node  *get_Sync_pred (ir_node *node, int pos);
 362 inline void      set_Sync_pred (ir_node *node, int pos, ir_node *pred);
 363
 364 inline ir_node  *get_Proj_pred (ir_node *node);
 365 inline void      set_Proj_pred (ir_node *node, ir_node *pred);
 366 inline long      get_Proj_proj (ir_node *node);
 367 inline void      set_Proj_proj (ir_node *node, long proj);
 368
 369 inline ir_node **get_Tuple_preds_arr (ir_node *node);
 370 inline int       get_Tuple_n_preds (ir_node *node);
 371 /* inline void     set_Tuple_n_preds (ir_node *node, int n_preds); */
 372 inline ir_node  *get_Tuple_pred (ir_node *node, int pos);
 373 inline void      set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
 374
 375 inline ir_node  *get_Id_pred (ir_node *node);
 376 inline void      set_Id_pred (ir_node *node, ir_node *pred);
 377
 378
 379
 380 /******************************************************************/
 381 /*  Auxiliary routines                                            */
 382 /******************************************************************/
 383
 384 /* returns operand of node if node is a Proj. */
 385 inline ir_node *skip_Proj (ir_node *node);
 386 /* returns operand of node if node is a Id */
 387 inline ir_node *skip_nop  (ir_node *node);
 388 /* returns true if node is a Bad node. */
 389 inline int      is_Bad    (ir_node *node);
 390 /* returns true if the node is not a Block */
 391 inline int      is_no_Block (ir_node *node);
 392 /* Returns true if the operation manipulates control flow:
 393    Start, End, Jmp, Cond, Return, Raise */
 394 int is_cfop(ir_node *node);
 395 /* Returns true if the operation can change the control flow because
 396    of an exception. */
 397 int is_fragile_op(ir_node *node);
 398
 399
 400
 401 /* Makros for debugging the libfirm */
 402 #ifdef DEBUG_libfirm
 403 #include "ident.h"
 404
 405 #define DDMSG        printf("%s(l.%i)\n", __FUNCTION__, __LINE__)
 406 #define DDMSG1(X)    printf("%s(l.%i) %s\n", __FUNCTION__, __LINE__,         \
 407                             id_to_str(get_irn_opident(X)))
 408 #define DDMSG2(X)    printf("%s(l.%i) %s: %ld\n", __FUNCTION__, __LINE__,     \
 409                      id_to_str(get_irn_opident(X)), get_irn_node_nr(X))
 410 #define DDMSG3(X)    printf("%s(l.%i) %s: %p\n", __FUNCTION__, __LINE__,     \
 411                      print_firm_kind(X), (X))
 412
 413 #endif
 414
 415 # endif /* _IRNODE_H_ */