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