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

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief   Representation of an intermediate operation -- private header.
  23  * @author  Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
  24  */
  25 #ifndef FIRM_IR_IRNODE_T_H
  26 #define FIRM_IR_IRNODE_T_H
  27
  28 #include "irtypes.h"
  29 #include "irnode.h"
  30 #include "irop_t.h"
  31 #include "irgraph_t.h"
  32 #include "irflag_t.h"
  33 #include "array.h"
  34 #include "iredges_t.h"
  35
  36 /* This section MUST come first, so the inline functions get used in this header. */
  37 #define is_ir_node(thing)                     is_ir_node_(thing)
  38 #define get_irn_arity(node)                   get_irn_arity_(node)
  39 #define get_irn_n(node, n)                    get_irn_n_(node, n)
  40 #define get_irn_mode(node)                    get_irn_mode_(node)
  41 #define set_irn_mode(node, mode)              set_irn_mode_(node, mode)
  42 #define get_irn_irg(node)                     get_irn_irg_(node)
  43 #define get_nodes_block(node)                 get_nodes_block_(node)
  44 #define get_irn_op(node)                      get_irn_op_(node)
  45 #define set_irn_op(node, op)                  set_irn_op_(node, op)
  46 #define get_irn_opcode(node)                  get_irn_opcode_(node)
  47 #define get_irn_visited(node)                 get_irn_visited_(node)
  48 #define set_irn_visited(node, v)              set_irn_visited_(node, v)
  49 #define mark_irn_visited(node)                mark_irn_visited_(node)
  50 #define irn_visited(node)                     irn_visited_(node)
  51 #define irn_visited_else_mark(node)           irn_visited_else_mark_(node)
  52 #define set_irn_link(node, link)              set_irn_link_(node, link)
  53 #define get_irn_link(node)                    get_irn_link_(node)
  54 #define get_irn_pinned(node)                  get_irn_pinned_(node)
  55 #define is_irn_pinned_in_irg(node)            is_irn_pinned_in_irg_(node)
  56 #define is_unop(node)                         is_unop_(node)
  57 #define is_binop(node)                        is_binop_(node)
  58 #define is_Proj(node)                         is_Proj_(node)
  59 #define is_Phi(node)                          is_Phi_(node)
  60 #define is_SymConst_addr_ent(node)            is_SymConst_addr_ent_(node)
  61 #define get_Block_n_cfgpreds(node)            get_Block_n_cfgpreds_(node)
  62 #define get_Block_cfgpred(node, pos)          get_Block_cfgpred_(node, pos)
  63 #define get_Block_cfgpred_block(node, pos)    get_Block_cfgpred_block_(node, pos)
  64 #define get_Block_block_visited(node)         get_Block_block_visited_(node)
  65 #define set_Block_block_visited(node, visit)  set_Block_block_visited_(node, visit)
  66 #define mark_Block_block_visited(node)        mark_Block_block_visited_(node)
  67 #define Block_block_visited(node)             Block_block_visited_(node)
  68 #define get_Block_irg(block)                  get_Block_irg_(block)
  69 #define get_Const_tarval(node)                get_Const_tarval_(node)
  70 #define is_Const_null(node)                   is_Const_null_(node)
  71 #define is_Const_one(node)                    is_Const_one_(node)
  72 #define is_Const_all_one(node)                is_Const_all_one_(node)
  73 #define is_irn_forking(node)                  is_irn_forking_(node)
  74 #define copy_node_attr(irg,oldn,newn)         copy_node_attr_(irg,oldn,newn)
  75 #define get_irn_type(node)                    get_irn_type_(node)
  76 #define get_irn_type_attr(node)               get_irn_type_attr_(node)
  77 #define get_irn_entity_attr(node)             get_irn_entity_attr_(node)
  78 #define is_irn_constlike(node)                is_irn_constlike_(node)
  79 #define is_irn_keep(node)                     is_irn_keep_(node)
  80 #define is_irn_start_block_placed(node)       is_irn_start_block_placed_(node)
  81 #define is_irn_cse_neutral(node)              is_irn_cse_neutral_(node)
  82 #define get_Cond_jmp_pred(node)               get_Cond_jmp_pred_(node)
  83 #define set_Cond_jmp_pred(node, pred)         set_Cond_jmp_pred_(node, pred)
  84 #define get_irn_generic_attr(node)            get_irn_generic_attr_(node)
  85 #define get_irn_generic_attr_const(node)      get_irn_generic_attr_const_(node)
  86 #define get_irn_idx(node)                     get_irn_idx_(node)
  87
  88 #define get_irn_deps(node)                    get_irn_deps_(node)
  89 #define get_irn_dep(node, pos)                get_irn_dep_(node, pos)
  90
  91 #define get_irn_ins_or_deps(node)             get_irn_ins_or_deps_(node)
  92 #define get_irn_in_or_dep(node, pos)          get_irn_in_or_dep_(node, pos)
  93
  94 #define get_irn_dbg_info(node)                get_irn_dbg_info_(node)
  95 #define set_irn_dbg_info(node, db)            set_irn_dbg_info_(node, db)
  96
  97 #define set_Block_phis(block, phi)            set_Block_phis_(block, phi)
  98 #define get_Block_phis(block)                 get_Block_phis_(block)
  99 #define add_Block_phi(block, phi)             add_Block_phi_(block, phi)
 100 #define get_Block_mark(block)                 get_Block_mark_(block)
 101 #define set_Block_mark(block, mark)           set_Block_mark_(block, mark)
 102
 103 #define set_Phi_next(node, phi)               set_Phi_next_(node, phi)
 104 #define get_Phi_next(node)                    get_Phi_next_(node)
 105
 106 #define is_arg_Proj(node)                     is_arg_Proj_(node)
 107 #define ir_switch_table_get_n_entries(table)  ir_switch_table_get_n_entries_(table)
 108
 109 /**
 110  * Returns the array with the ins.  The content of the array may not be
 111  * changed.
 112  * Note that this function returns the whole in array including the
 113  * block predecessor. So, it is NOT symmetric with set_irn_in().
 114  */
 115 ir_node **get_irn_in(const ir_node *node);
 116
 117 /**
 118  * Returns an array with the predecessors of the Block. Depending on
 119  * the implementation of the graph data structure this can be a copy of
 120  * the internal representation of predecessors as well as the internal
 121  * array itself. Therefore writing to this array might obstruct the IR.
 122  */
 123 ir_node **get_Block_cfgpred_arr(ir_node *node);
 124
 125 /*-------------------------------------------------------------------*/
 126 /*  These function are most used in libfirm.  Give them as static    */
 127 /*  functions so they can be inlined.                                */
 128 /*-------------------------------------------------------------------*/
 129
 130 /**
 131  * Checks whether a pointer points to a ir node.
 132  * Intern version for libFirm.
 133  */
 134 static inline int is_ir_node_(const void *thing)
 135 {
 136         return (get_kind(thing) == k_ir_node);
 137 }
 138
 139 static inline unsigned get_irn_idx_(const ir_node *node)
 140 {
 141         return node->node_idx;
 142 }
 143
 144 /**
 145  * Gets the op of a node.
 146  * Intern version for libFirm.
 147  */
 148 static inline ir_op *get_irn_op_(const ir_node *node)
 149 {
 150         return node->op;
 151 }
 152
 153 /* include generated code */
 154 #include "gen_irnode.h"
 155
 156 static inline void set_irn_op_(ir_node *node, ir_op *op)
 157 {
 158         node->op = op;
 159 }
 160
 161 /** Copies all attributes stored in the old node  to the new node.
 162     Assumes both have the same opcode and sufficient size. */
 163 static inline void copy_node_attr_(ir_graph *irg, const ir_node *old_node,
 164                                    ir_node *new_node)
 165 {
 166         ir_op *op = get_irn_op_(old_node);
 167
 168         /* must always exist */
 169         op->ops.copy_attr(irg, old_node, new_node);
 170 }
 171
 172 /**
 173  * Gets the opcode of a node.
 174  * Intern version for libFirm.
 175  */
 176 static inline unsigned get_irn_opcode_(const ir_node *node)
 177 {
 178         assert(k_ir_node == get_kind(node));
 179         return node->op->code;
 180 }
 181
 182 /**
 183  * Returns the number of predecessors without the block predecessor.
 184  * Intern version for libFirm.
 185  */
 186 static inline int get_irn_arity_(const ir_node *node)
 187 {
 188         return (int)(ARR_LEN(node->in) - 1);
 189 }
 190
 191 /**
 192  * Intern version for libFirm.
 193  */
 194 static inline ir_node *get_irn_n_(const ir_node *node, int n)
 195 {
 196         ir_node *nn;
 197
 198         assert(-1 <= n && n < get_irn_arity_(node));
 199
 200         nn = node->in[n + 1];
 201         if (!is_Id(nn)) return nn;
 202
 203         return (node->in[n + 1] = skip_Id(nn));
 204 }
 205
 206 /**
 207  * returns a hash value for a node
 208  */
 209 static inline unsigned hash_irn(const ir_node *node)
 210 {
 211         return (unsigned) get_irn_idx(node);
 212 }
 213
 214 static inline int get_irn_deps_(const ir_node *node)
 215 {
 216         return node->deps ? (int)ARR_LEN(node->deps) : 0;
 217 }
 218
 219 static inline ir_node *get_irn_dep_(const ir_node *node, int pos)
 220 {
 221         assert(pos >= 0 && pos < (int)ARR_LEN(node->deps) && "dependency index out of range");
 222         return node->deps[pos];
 223 }
 224
 225 /* forward declaration outside iredges_t.h to avoid circular include problems */
 226 void edges_notify_edge_kind(ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt, ir_edge_kind_t kind, ir_graph *irg);
 227
 228 static inline int get_irn_ins_or_deps_(const ir_node *irn)
 229 {
 230         return get_irn_deps_(irn) + get_irn_arity_(irn);
 231 }
 232
 233 static inline ir_node *get_irn_in_or_dep_(const ir_node *irn, int pos)
 234 {
 235         int n_in = get_irn_arity(irn);
 236         return pos < n_in ? get_irn_n(irn, pos) : get_irn_dep(irn, pos - n_in);
 237 }
 238
 239 /**
 240  * Gets the mode of a node.
 241  * Intern version for libFirm.
 242  */
 243 static inline ir_mode *get_irn_mode_(const ir_node *node)
 244 {
 245         return node->mode;
 246 }
 247
 248 /**
 249  * Sets the mode of a node.
 250  * Intern version of libFirm.
 251  */
 252 static inline void set_irn_mode_(ir_node *node, ir_mode *mode)
 253 {
 254         node->mode = mode;
 255 }
 256
 257 static inline int ir_has_irg_ref(const ir_node *node)
 258 {
 259         return is_Block(node) || is_Bad(node) || is_Anchor(node);
 260 }
 261
 262 static inline ir_node *get_nodes_block_(const ir_node *node)
 263 {
 264         assert(!is_Block(node));
 265         return get_irn_n(node, -1);
 266 }
 267
 268 static inline ir_graph *get_irn_irg_(const ir_node *node)
 269 {
 270         if (! is_Block(node))
 271                 node = get_nodes_block(node);
 272         assert(ir_has_irg_ref(node));
 273         return node->attr.irg.irg;
 274 }
 275
 276 /**
 277  * Gets the visited counter of a node.
 278  * Intern version for libFirm.
 279  */
 280 static inline ir_visited_t get_irn_visited_(const ir_node *node)
 281 {
 282         return node->visited;
 283 }
 284
 285 /**
 286  * Sets the visited counter of a node.
 287  * Intern version for libFirm.
 288  */
 289 static inline void set_irn_visited_(ir_node *node, ir_visited_t visited)
 290 {
 291         node->visited = visited;
 292 }
 293
 294 /**
 295  * Mark a node as visited in a graph.
 296  * Intern version for libFirm.
 297  */
 298 static inline void mark_irn_visited_(ir_node *node)
 299 {
 300         node->visited = get_irn_irg(node)->visited;
 301 }
 302
 303 /**
 304  * Returns non-zero if a node of was visited.
 305  * Intern version for libFirm.
 306  */
 307 static inline int irn_visited_(const ir_node *node)
 308 {
 309         ir_graph *irg = get_irn_irg(node);
 310         return node->visited >= irg->visited;
 311 }
 312
 313 static inline int irn_visited_else_mark_(ir_node *node)
 314 {
 315         if (irn_visited_(node))
 316                 return 1;
 317         mark_irn_visited_(node);
 318         return 0;
 319 }
 320
 321 /**
 322  * Sets the link of a node.
 323  * Intern version of libFirm.
 324  */
 325 static inline void set_irn_link_(ir_node *node, void *link)
 326 {
 327         node->link = link;
 328 }
 329
 330 /**
 331  * Returns the link of a node.
 332  * Intern version of libFirm.
 333  */
 334 static inline void *get_irn_link_(const ir_node *node)
 335 {
 336         assert(is_ir_node_(node));
 337         return node->link;
 338 }
 339
 340 /**
 341  * Returns whether the node _always_ must be pinned.
 342  * I.e., the node is not floating after global cse.
 343  *
 344  * Intern version of libFirm.
 345  */
 346 static inline op_pin_state get_irn_pinned_(const ir_node *node)
 347 {
 348         op_pin_state state;
 349         assert(is_ir_node_(node));
 350         /* Check opcode */
 351         state = get_op_pinned_(get_irn_op_(node));
 352
 353         if (state >= op_pin_state_exc_pinned)
 354                 return (op_pin_state)node->attr.except.pin_state;
 355
 356         return state;
 357 }
 358
 359 static inline op_pin_state is_irn_pinned_in_irg_(const ir_node *node)
 360 {
 361         if (get_irg_pinned(get_irn_irg(node)) == op_pin_state_floats)
 362                 return get_irn_pinned(node);
 363         return op_pin_state_pinned;
 364 }
 365
 366 static inline int is_unop_(const ir_node *node)
 367 {
 368         assert(is_ir_node_(node));
 369         return (node->op->opar == oparity_unary);
 370 }
 371
 372 static inline int is_binop_(const ir_node *node)
 373 {
 374         assert(is_ir_node_(node));
 375         return (node->op->opar == oparity_binary);
 376 }
 377
 378 static inline int is_SymConst_addr_ent_(const ir_node *node)
 379 {
 380         return is_SymConst(node) && get_SymConst_kind(node) == symconst_addr_ent;
 381 }
 382
 383 static inline int get_Block_n_cfgpreds_(const ir_node *node)
 384 {
 385         assert(is_Block_(node));
 386         return get_irn_arity_(node);
 387 }
 388
 389 static inline ir_node *get_Block_cfgpred_(const ir_node *node, int pos)
 390 {
 391         assert(is_Block_(node));
 392         return get_irn_n_(node, pos);
 393 }
 394
 395 /* Get the predecessor block.
 396  *
 397  *  Returns the block corresponding to the predecessor pos.
 398  *
 399  *  There are several ambiguities we resolve with this function:
 400  *  - The direct predecessor can be a Proj, which is not pinned.
 401  *    We walk from the predecessor to the next pinned node
 402  *    (skip_Proj) and return the block that node is in.
 403  *  - If we encounter the Bad node, this function does not return
 404  *    the Start block, but the Bad node.
 405  */
 406 static inline ir_node *get_Block_cfgpred_block_(const ir_node *node, int pos)
 407 {
 408         ir_node *res = get_Block_cfgpred(node, pos);
 409         if (is_Bad(res)) {
 410                 /* must return a Bad with mode_BB! */
 411                 ir_graph *irg = get_irn_irg(node);
 412                 return new_r_Bad(irg, mode_BB);
 413         } else {
 414                 return get_nodes_block(skip_Proj(res));
 415         }
 416 }
 417
 418 static inline ir_visited_t get_Block_block_visited_(const ir_node *node)
 419 {
 420         assert(is_Block(node));
 421         return node->attr.block.block_visited;
 422 }
 423
 424 static inline void set_Block_block_visited_(ir_node *node, ir_visited_t visit)
 425 {
 426         assert(is_Block(node));
 427         node->attr.block.block_visited = visit;
 428 }
 429
 430 static inline ir_graph *get_Block_irg_(const ir_node *block)
 431 {
 432         assert(is_Block(block));
 433         return block->attr.irg.irg;
 434 }
 435
 436 static inline void mark_Block_block_visited_(ir_node *node)
 437 {
 438         ir_graph *irg = get_Block_irg(node);
 439         node->attr.block.block_visited = get_irg_block_visited(irg);
 440 }
 441
 442 static inline int Block_block_visited_(const ir_node *node)
 443 {
 444         ir_graph *irg = get_Block_irg(node);
 445         return node->attr.block.block_visited >= get_irg_block_visited(irg);
 446 }
 447
 448 static inline ir_tarval *get_Const_tarval_(const ir_node *node)
 449 {
 450         assert(is_Const(node));
 451         return node->attr.con.tarval;
 452 }
 453
 454 static inline int is_Const_null_(const ir_node *node)
 455 {
 456         return tarval_is_null(get_Const_tarval_(node));
 457 }
 458
 459 static inline int is_Const_one_(const ir_node *node)
 460 {
 461         return tarval_is_one(get_Const_tarval_(node));
 462 }
 463
 464 static inline int is_Const_all_one_(const ir_node *node)
 465 {
 466         return tarval_is_all_one(get_Const_tarval_(node));
 467 }
 468
 469 static inline int is_irn_forking_(const ir_node *node)
 470 {
 471         return is_op_forking(get_irn_op_(node));
 472 }
 473
 474 static inline ir_type *get_irn_type_attr_(ir_node *node)
 475 {
 476         return get_irn_op_(node)->ops.get_type_attr(node);
 477 }
 478
 479 static inline ir_entity *get_irn_entity_attr_(ir_node *node)
 480 {
 481         return get_irn_op_(node)->ops.get_entity_attr(node);
 482 }
 483
 484 static inline int is_irn_constlike_(const ir_node *node)
 485 {
 486         return is_op_constlike(get_irn_op_(node));
 487 }
 488
 489 static inline int is_irn_keep_(const ir_node *node)
 490 {
 491         return is_op_keep(get_irn_op_(node));
 492 }
 493
 494 static inline int is_irn_start_block_placed_(const ir_node *node)
 495 {
 496         return is_op_start_block_placed(get_irn_op_(node));
 497 }
 498
 499 static inline int is_irn_cse_neutral_(const ir_node *node)
 500 {
 501         return is_op_cse_neutral(get_irn_op_(node));
 502 }
 503
 504 static inline cond_jmp_predicate get_Cond_jmp_pred_(const ir_node *node)
 505 {
 506         assert(is_Cond(node));
 507         return node->attr.cond.jmp_pred;
 508 }
 509
 510 static inline void set_Cond_jmp_pred_(ir_node *node, cond_jmp_predicate pred)
 511 {
 512         assert(is_Cond(node));
 513         node->attr.cond.jmp_pred = pred;
 514 }
 515
 516 static inline void *get_irn_generic_attr_(ir_node *node)
 517 {
 518         return &node->attr;
 519 }
 520
 521 static inline const void *get_irn_generic_attr_const_(const ir_node *node)
 522 {
 523         return &node->attr;
 524 }
 525
 526 static inline dbg_info *get_irn_dbg_info_(const ir_node *n)
 527 {
 528         return n->dbi;
 529 }
 530
 531 static inline void set_irn_dbg_info_(ir_node *n, dbg_info *db)
 532 {
 533         n->dbi = db;
 534 }
 535
 536 /**
 537  * Sets the Phi list of a block.
 538  */
 539 static inline void set_Block_phis_(ir_node *block, ir_node *phi)
 540 {
 541         assert(is_Block_(block));
 542         assert(phi == NULL || is_Phi_(phi));
 543         block->attr.block.phis = phi;
 544 }
 545
 546 /**
 547  * Returns the link of a node.
 548  * Intern version of libFirm.
 549  */
 550 static inline ir_node *get_Block_phis_(const ir_node *block)
 551 {
 552         assert(is_Block_(block));
 553         return block->attr.block.phis;
 554 }
 555
 556 static inline void set_Phi_next_(ir_node *phi, ir_node *next)
 557 {
 558         assert(is_Phi_(phi));
 559         phi->attr.phi.next = next;
 560 }
 561
 562 static inline ir_node *get_Phi_next_(const ir_node *phi)
 563 {
 564         assert(is_Phi_(phi));
 565         return phi->attr.phi.next;
 566 }
 567
 568 /** Add a Phi node to the list of Block Phi's. */
 569 static inline void add_Block_phi_(ir_node *block, ir_node *phi)
 570 {
 571         assert(is_Block_(block));
 572         set_Phi_next_(phi, get_Block_phis_(block));
 573         set_Block_phis_(block, phi);
 574 }
 575
 576 /** Get the Block mark (single bit). */
 577 static inline unsigned get_Block_mark_(const ir_node *block)
 578 {
 579         assert(is_Block_(block));
 580         return block->attr.block.marked;
 581 }
 582
 583 /** Set the Block mark (single bit). */
 584 static inline void set_Block_mark_(ir_node *block, unsigned mark)
 585 {
 586         assert(is_Block_(block));
 587         block->attr.block.marked = mark;
 588 }
 589
 590 /** Returns non-zero if a node is a routine parameter. */
 591 static inline int is_arg_Proj_(const ir_node *node)
 592 {
 593         if (! is_Proj(node))
 594                 return 0;
 595         node = get_Proj_pred(node);
 596         if (! is_Proj(node))
 597                 return 0;
 598         return pn_Start_T_args == get_Proj_proj(node) && is_Start(get_Proj_pred(node));
 599 }
 600
 601 static inline size_t ir_switch_table_get_n_entries_(const ir_switch_table *table)
 602 {
 603         return table->n_entries;
 604 }
 605
 606 static inline ir_switch_table_entry *ir_switch_table_get_entry(
 607                 ir_switch_table *table, size_t entry)
 608 {
 609         assert(entry < table->n_entries);
 610         return &table->entries[entry];
 611 }
 612
 613 static inline const ir_switch_table_entry *ir_switch_table_get_entry_const(
 614                 const ir_switch_table *table, size_t entry)
 615 {
 616         assert(entry < table->n_entries);
 617         return &table->entries[entry];
 618 }
 619
 620 void ir_register_getter_ops(void);
 621
 622 /**
 623  * because firm keepalive edges are a broken concept, we have to make sure that
 624  * nodes which are only held by a keepalive edges are never moved again.
 625  * This function returns true in this case.
 626  */
 627 bool only_used_by_keepalive(const ir_node *node);
 628
 629 #endif