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 void set_irn_dep_(ir_node *node, int pos, ir_node *dep)
 157 {
 158         ir_node *old;
 159
 160         assert(node->deps && "dependency array node yet allocated. use add_irn_dep()");
 161         assert(pos >= 0 && pos < (int)ARR_LEN(node->deps) && "dependency index out of range");
 162         old = node->deps[pos];
 163         node->deps[pos] = dep;
 164         edges_notify_edge_kind(node, pos, dep, old, EDGE_KIND_DEP, get_irn_irg(node));
 165 }
 166
 167
 168 static inline int get_irn_ins_or_deps_(const ir_node *irn)
 169 {
 170         return get_irn_deps_(irn) + get_irn_arity_(irn);
 171 }
 172
 173 static inline ir_node *get_irn_in_or_dep_(const ir_node *irn, int pos)
 174 {
 175         int n_in = get_irn_arity(irn);
 176         return pos < n_in ? get_irn_n(irn, pos) : get_irn_dep(irn, pos - n_in);
 177 }
 178
 179 /**
 180  * Gets the mode of a node.
 181  * Intern version for libFirm.
 182  */
 183 static inline ir_mode *get_irn_mode_(const ir_node *node)
 184 {
 185         assert(node);
 186         return node->mode;
 187 }
 188
 189 /**
 190  * Sets the mode of a node.
 191  * Intern version of libFirm.
 192  */
 193 static inline void set_irn_mode_(ir_node *node, ir_mode *mode)
 194 {
 195         assert(node);
 196         node->mode = mode;
 197 }
 198
 199 static inline int ir_has_irg_ref(const ir_node *node)
 200 {
 201         return is_Block(node) || is_Bad(node) || is_Anchor(node);
 202 }
 203
 204 static inline ir_graph *get_irn_irg_(const ir_node *node)
 205 {
 206         if (! is_Block(node))
 207                 node = get_nodes_block(node);
 208         assert(ir_has_irg_ref(node));
 209         return node->attr.irg.irg;
 210 }
 211
 212 static inline ir_node *get_nodes_block_(const ir_node *node)
 213 {
 214         assert(!is_Block(node));
 215         return get_irn_n(node, -1);
 216 }
 217
 218 /**
 219  * Gets the visited counter of a node.
 220  * Intern version for libFirm.
 221  */
 222 static inline ir_visited_t get_irn_visited_(const ir_node *node)
 223 {
 224         assert(node);
 225         return node->visited;
 226 }
 227
 228 /**
 229  * Sets the visited counter of a node.
 230  * Intern version for libFirm.
 231  */
 232 static inline void set_irn_visited_(ir_node *node, ir_visited_t visited)
 233 {
 234         assert(node);
 235         node->visited = visited;
 236 }
 237
 238 /**
 239  * Mark a node as visited in a graph.
 240  * Intern version for libFirm.
 241  */
 242 static inline void mark_irn_visited_(ir_node *node)
 243 {
 244         node->visited = get_irn_irg(node)->visited;
 245 }
 246
 247 /**
 248  * Returns non-zero if a node of was visited.
 249  * Intern version for libFirm.
 250  */
 251 static inline int irn_visited_(const ir_node *node)
 252 {
 253         ir_graph *irg = get_irn_irg(node);
 254         return node->visited >= irg->visited;
 255 }
 256
 257 static inline int irn_visited_else_mark_(ir_node *node)
 258 {
 259         if (irn_visited_(node))
 260                 return 1;
 261         mark_irn_visited_(node);
 262         return 0;
 263 }
 264
 265 /**
 266  * Sets the link of a node.
 267  * Intern version of libFirm.
 268  */
 269 static inline void set_irn_link_(ir_node *node, void *link)
 270 {
 271         assert(node);
 272         node->link = link;
 273 }
 274
 275 /**
 276  * Returns the link of a node.
 277  * Intern version of libFirm.
 278  */
 279 static inline void *get_irn_link_(const ir_node *node)
 280 {
 281         assert(node && is_ir_node_(node));
 282         return node->link;
 283 }
 284
 285 /**
 286  * Returns whether the node _always_ must be pinned.
 287  * I.e., the node is not floating after global cse.
 288  *
 289  * Intern version of libFirm.
 290  */
 291 static inline op_pin_state get_irn_pinned_(const ir_node *node)
 292 {
 293         op_pin_state state;
 294         assert(node && is_ir_node_(node));
 295         /* Check opcode */
 296         state = get_op_pinned_(get_irn_op_(node));
 297
 298         if (state >= op_pin_state_exc_pinned)
 299                 return (op_pin_state)node->attr.except.pin_state;
 300
 301         return state;
 302 }
 303
 304 static inline op_pin_state is_irn_pinned_in_irg_(const ir_node *node)
 305 {
 306         if (get_irg_pinned(get_irn_irg(node)) == op_pin_state_floats)
 307                 return get_irn_pinned(node);
 308         return op_pin_state_pinned;
 309 }
 310
 311 /* include generated code */
 312 #include "gen_irnode.h"
 313
 314 static inline int is_unop_(const ir_node *node)
 315 {
 316         assert(node && is_ir_node_(node));
 317         return (node->op->opar == oparity_unary);
 318 }
 319
 320 static inline int is_binop_(const ir_node *node)
 321 {
 322         assert(node && is_ir_node_(node));
 323         return (node->op->opar == oparity_binary);
 324 }
 325
 326 static inline int is_strictConv_(const ir_node *node)
 327 {
 328         return is_Conv_(node) && get_Conv_strict(node);
 329 }
 330
 331 static inline int is_SymConst_addr_ent_(const ir_node *node)
 332 {
 333         return is_SymConst(node) && get_SymConst_kind(node) == symconst_addr_ent;
 334 }
 335
 336 static inline int get_Block_n_cfgpreds_(const ir_node *node)
 337 {
 338         assert(is_Block_(node));
 339         return get_irn_arity_(node);
 340 }
 341
 342 static inline ir_node *get_Block_cfgpred_(const ir_node *node, int pos)
 343 {
 344         assert(is_Block_(node));
 345         return get_irn_n_(node, pos);
 346 }
 347
 348 /* Get the predecessor block.
 349  *
 350  *  Returns the block corresponding to the predecessor pos.
 351  *
 352  *  There are several ambiguities we resolve with this function:
 353  *  - The direct predecessor can be a Proj, which is not pinned.
 354  *    We walk from the predecessor to the next pinned node
 355  *    (skip_Proj) and return the block that node is in.
 356  *  - If we encounter the Bad node, this function does not return
 357  *    the Start block, but the Bad node.
 358  */
 359 static inline ir_node *get_Block_cfgpred_block_(const ir_node *node, int pos)
 360 {
 361         ir_node *res = get_Block_cfgpred(node, pos);
 362         if (is_Bad(res)) {
 363                 /* must return a Bad with mode_BB! */
 364                 ir_graph *irg = get_irn_irg(node);
 365                 return new_r_Bad(irg, mode_BB);
 366         } else {
 367                 return get_nodes_block(skip_Proj(res));
 368         }
 369 }
 370
 371 static inline ir_visited_t get_Block_block_visited_(const ir_node *node)
 372 {
 373         assert(is_Block(node));
 374         return node->attr.block.block_visited;
 375 }
 376
 377 static inline void set_Block_block_visited_(ir_node *node, ir_visited_t visit)
 378 {
 379         assert(is_Block(node));
 380         node->attr.block.block_visited = visit;
 381 }
 382
 383 static inline void mark_Block_block_visited_(ir_node *node)
 384 {
 385         ir_graph *irg = get_Block_irg(node);
 386         node->attr.block.block_visited = get_irg_block_visited(irg);
 387 }
 388
 389 static inline int Block_block_visited_(const ir_node *node)
 390 {
 391         ir_graph *irg = get_Block_irg(node);
 392         return node->attr.block.block_visited >= get_irg_block_visited(irg);
 393 }
 394
 395 static inline ir_graph *get_Block_irg_(const ir_node *block)
 396 {
 397         assert(is_Block(block));
 398         return block->attr.irg.irg;
 399 }
 400
 401 static inline ir_tarval *get_Const_tarval_(const ir_node *node)
 402 {
 403         assert(get_irn_op_(node) == op_Const);
 404         return node->attr.con.tarval;
 405 }
 406
 407 static inline int is_Const_null_(const ir_node *node)
 408 {
 409         return tarval_is_null(get_Const_tarval_(node));
 410 }
 411
 412 static inline int is_Const_one_(const ir_node *node)
 413 {
 414         return tarval_is_one(get_Const_tarval_(node));
 415 }
 416
 417 static inline int is_Const_all_one_(const ir_node *node)
 418 {
 419         return tarval_is_all_one(get_Const_tarval_(node));
 420 }
 421
 422 static inline int is_irn_forking_(const ir_node *node)
 423 {
 424         return is_op_forking(get_irn_op_(node));
 425 }
 426
 427 static inline ir_type *get_irn_type_attr_(ir_node *node)
 428 {
 429         return get_irn_op_(node)->ops.get_type_attr(node);
 430 }
 431
 432 static inline ir_entity *get_irn_entity_attr_(ir_node *node)
 433 {
 434         return get_irn_op_(node)->ops.get_entity_attr(node);
 435 }
 436
 437 static inline int is_irn_constlike_(const ir_node *node)
 438 {
 439         return is_op_constlike(get_irn_op_(node));
 440 }
 441
 442 static inline int is_irn_keep_(const ir_node *node)
 443 {
 444         return is_op_keep(get_irn_op_(node));
 445 }
 446
 447 static inline int is_irn_start_block_placed_(const ir_node *node)
 448 {
 449         return is_op_start_block_placed(get_irn_op_(node));
 450 }
 451
 452 static inline int is_irn_cse_neutral_(const ir_node *node)
 453 {
 454         return is_op_cse_neutral(get_irn_op_(node));
 455 }
 456
 457 static inline cond_jmp_predicate get_Cond_jmp_pred_(const ir_node *node)
 458 {
 459         assert(get_irn_op_(node) == op_Cond);
 460         return node->attr.cond.jmp_pred;
 461 }
 462
 463 static inline void set_Cond_jmp_pred_(ir_node *node, cond_jmp_predicate pred)
 464 {
 465         assert(get_irn_op_(node) == op_Cond);
 466         node->attr.cond.jmp_pred = pred;
 467 }
 468
 469 static inline void *get_irn_generic_attr_(ir_node *node)
 470 {
 471         return &node->attr;
 472 }
 473
 474 static inline const void *get_irn_generic_attr_const_(const ir_node *node)
 475 {
 476         return &node->attr;
 477 }
 478
 479 static inline unsigned get_irn_idx_(const ir_node *node)
 480 {
 481         return node->node_idx;
 482 }
 483
 484 static inline dbg_info *get_irn_dbg_info_(const ir_node *n)
 485 {
 486         return n->dbi;
 487 }
 488
 489 static inline void set_irn_dbg_info_(ir_node *n, dbg_info *db)
 490 {
 491         n->dbi = db;
 492 }
 493
 494 /**
 495  * Sets the Phi list of a block.
 496  */
 497 static inline void set_Block_phis_(ir_node *block, ir_node *phi)
 498 {
 499         assert(is_Block_(block));
 500         assert(phi == NULL || is_Phi_(phi));
 501         block->attr.block.phis = phi;
 502 }
 503
 504 /**
 505  * Returns the link of a node.
 506  * Intern version of libFirm.
 507  */
 508 static inline ir_node *get_Block_phis_(const ir_node *block)
 509 {
 510         assert(is_Block_(block));
 511         return block->attr.block.phis;
 512 }
 513
 514 static inline void set_Phi_next_(ir_node *phi, ir_node *next)
 515 {
 516         assert(is_Phi_(phi));
 517         phi->attr.phi.next = next;
 518 }
 519
 520 static inline ir_node *get_Phi_next_(const ir_node *phi)
 521 {
 522         assert(is_Phi_(phi));
 523         return phi->attr.phi.next;
 524 }
 525
 526 /** Add a Phi node to the list of Block Phi's. */
 527 static inline void add_Block_phi_(ir_node *block, ir_node *phi)
 528 {
 529         assert(is_Block_(block));
 530         set_Phi_next_(phi, get_Block_phis_(block));
 531         set_Block_phis_(block, phi);
 532 }
 533
 534 /** Get the Block mark (single bit). */
 535 static inline unsigned get_Block_mark_(const ir_node *block)
 536 {
 537         assert(is_Block_(block));
 538         return block->attr.block.marked;
 539 }
 540
 541 /** Set the Block mark (single bit). */
 542 static inline void set_Block_mark_(ir_node *block, unsigned mark)
 543 {
 544         assert(is_Block_(block));
 545         block->attr.block.marked = mark;
 546 }
 547
 548 /** Returns non-zero if a node is a routine parameter. */
 549 static inline int is_arg_Proj_(const ir_node *node)
 550 {
 551         if (! is_Proj(node))
 552                 return 0;
 553         node = get_Proj_pred(node);
 554         if (! is_Proj(node))
 555                 return 0;
 556         return pn_Start_T_args == get_Proj_proj(node) && is_Start(get_Proj_pred(node));
 557 }
 558
 559 static inline size_t ir_switch_table_get_n_entries_(const ir_switch_table *table)
 560 {
 561         return table->n_entries;
 562 }
 563
 564 static inline ir_switch_table_entry *ir_switch_table_get_entry(
 565                 ir_switch_table *table, size_t entry)
 566 {
 567         assert(entry < table->n_entries);
 568         return &table->entries[entry];
 569 }
 570
 571 static inline const ir_switch_table_entry *ir_switch_table_get_entry_const(
 572                 const ir_switch_table *table, size_t entry)
 573 {
 574         assert(entry < table->n_entries);
 575         return &table->entries[entry];
 576 }
 577
 578 void ir_register_getter_ops(void);
 579
 580 /** initialize ir_node module */
 581 void init_irnode(void);
 582
 583 /* this section MUST contain all inline functions */
 584 #define is_ir_node(thing)                     is_ir_node_(thing)
 585 #define get_irn_arity(node)                   get_irn_arity_(node)
 586 #define get_irn_n(node, n)                    get_irn_n_(node, n)
 587 #define get_irn_mode(node)                    get_irn_mode_(node)
 588 #define set_irn_mode(node, mode)              set_irn_mode_(node, mode)
 589 #define get_irn_irg(node)                     get_irn_irg_(node)
 590 #define get_nodes_block(node)                 get_nodes_block_(node)
 591 #define get_irn_op(node)                      get_irn_op_(node)
 592 #define set_irn_op(node, op)                  set_irn_op_(node, op)
 593 #define get_irn_opcode(node)                  get_irn_opcode_(node)
 594 #define get_irn_visited(node)                 get_irn_visited_(node)
 595 #define set_irn_visited(node, v)              set_irn_visited_(node, v)
 596 #define mark_irn_visited(node)                mark_irn_visited_(node)
 597 #define irn_visited(node)                     irn_visited_(node)
 598 #define irn_visited_else_mark(node)           irn_visited_else_mark_(node)
 599 #define set_irn_link(node, link)              set_irn_link_(node, link)
 600 #define get_irn_link(node)                    get_irn_link_(node)
 601 #define get_irn_pinned(node)                  get_irn_pinned_(node)
 602 #define is_irn_pinned_in_irg(node)            is_irn_pinned_in_irg_(node)
 603 #define is_unop(node)                         is_unop_(node)
 604 #define is_binop(node)                        is_binop_(node)
 605 #define is_Proj(node)                         is_Proj_(node)
 606 #define is_Phi(node)                          is_Phi_(node)
 607 #define is_strictConv(node)                   is_strictConv_(node)
 608 #define is_SymConst_addr_ent(node)            is_SymConst_addr_ent_(node)
 609 #define get_Block_n_cfgpreds(node)            get_Block_n_cfgpreds_(node)
 610 #define get_Block_cfgpred(node, pos)          get_Block_cfgpred_(node, pos)
 611 #define get_Block_cfgpred_block(node, pos)    get_Block_cfgpred_block_(node, pos)
 612 #define get_Block_block_visited(node)         get_Block_block_visited_(node)
 613 #define set_Block_block_visited(node, visit)  set_Block_block_visited_(node, visit)
 614 #define mark_Block_block_visited(node)        mark_Block_block_visited_(node)
 615 #define Block_block_visited(node)             Block_block_visited_(node)
 616 #define get_Block_irg(block)                  get_Block_irg_(block)
 617 #define get_Const_tarval(node)                get_Const_tarval_(node)
 618 #define is_Const_null(node)                   is_Const_null_(node)
 619 #define is_Const_one(node)                    is_Const_one_(node)
 620 #define is_Const_all_one(node)                is_Const_all_one_(node)
 621 #define is_irn_forking(node)                  is_irn_forking_(node)
 622 #define copy_node_attr(irg,oldn,newn)         copy_node_attr_(irg,oldn,newn)
 623 #define get_irn_type(node)                    get_irn_type_(node)
 624 #define get_irn_type_attr(node)               get_irn_type_attr_(node)
 625 #define get_irn_entity_attr(node)             get_irn_entity_attr_(node)
 626 #define is_irn_constlike(node)                is_irn_constlike_(node)
 627 #define is_irn_keep(node)                     is_irn_keep_(node)
 628 #define is_irn_start_block_placed(node)       is_irn_start_block_placed_(node)
 629 #define is_irn_cse_neutral(node)              is_irn_cse_neutral_(node)
 630 #define get_Cond_jmp_pred(node)               get_Cond_jmp_pred_(node)
 631 #define set_Cond_jmp_pred(node, pred)         set_Cond_jmp_pred_(node, pred)
 632 #define get_irn_generic_attr(node)            get_irn_generic_attr_(node)
 633 #define get_irn_generic_attr_const(node)      get_irn_generic_attr_const_(node)
 634 #define get_irn_idx(node)                     get_irn_idx_(node)
 635
 636 #define get_irn_deps(node)                    get_irn_deps_(node)
 637 #define set_irn_dep(node, pos, dep)           set_irn_dep_(node, pos, dep)
 638 #define get_irn_dep(node, pos)                get_irn_dep_(node, pos)
 639
 640 #define get_irn_ins_or_deps(node)             get_irn_ins_or_deps_(node)
 641 #define get_irn_in_or_dep(node, pos)          get_irn_in_or_dep_(node, pos)
 642
 643 #define get_irn_dbg_info(node)                get_irn_dbg_info_(node)
 644 #define set_irn_dbg_info(node, db)            set_irn_dbg_info_(node, db)
 645
 646 #define set_Block_phis(block, phi)            set_Block_phis_(block, phi)
 647 #define get_Block_phis(block)                 get_Block_phis_(block)
 648 #define add_Block_phi(block, phi)             add_Block_phi_(block, phi)
 649 #define get_Block_mark(block)                 get_Block_mark_(block)
 650 #define set_Block_mark(block, mark)           set_Block_mark_(block, mark)
 651
 652 #define set_Phi_next(node, phi)               set_Phi_next_(node, phi)
 653 #define get_Phi_next(node)                    get_Phi_next_(node)
 654
 655 #define is_arg_Proj(node)                     is_arg_Proj_(node)
 656 #define ir_switch_table_get_n_entries(table)  ir_switch_table_get_n_entries_(table)
 657
 658 #endif