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_SymConst_addr_ent(node)            is_SymConst_addr_ent_(node)
  59 #define get_Block_n_cfgpreds(node)            get_Block_n_cfgpreds_(node)
  60 #define get_Block_cfgpred(node, pos)          get_Block_cfgpred_(node, pos)
  61 #define get_Block_cfgpred_block(node, pos)    get_Block_cfgpred_block_(node, pos)
  62 #define get_Block_block_visited(node)         get_Block_block_visited_(node)
  63 #define set_Block_block_visited(node, visit)  set_Block_block_visited_(node, visit)
  64 #define mark_Block_block_visited(node)        mark_Block_block_visited_(node)
  65 #define Block_block_visited(node)             Block_block_visited_(node)
  66 #define get_Block_irg(block)                  get_Block_irg_(block)
  67 #define is_Const_null(node)                   is_Const_null_(node)
  68 #define is_Const_one(node)                    is_Const_one_(node)
  69 #define is_Const_all_one(node)                is_Const_all_one_(node)
  70 #define is_irn_forking(node)                  is_irn_forking_(node)
  71 #define copy_node_attr(irg,oldn,newn)         copy_node_attr_(irg,oldn,newn)
  72 #define get_irn_type(node)                    get_irn_type_(node)
  73 #define get_irn_type_attr(node)               get_irn_type_attr_(node)
  74 #define get_irn_entity_attr(node)             get_irn_entity_attr_(node)
  75 #define is_irn_constlike(node)                is_irn_constlike_(node)
  76 #define is_irn_keep(node)                     is_irn_keep_(node)
  77 #define is_irn_start_block_placed(node)       is_irn_start_block_placed_(node)
  78 #define is_irn_cse_neutral(node)              is_irn_cse_neutral_(node)
  79 #define get_irn_generic_attr(node)            get_irn_generic_attr_(node)
  80 #define get_irn_generic_attr_const(node)      get_irn_generic_attr_const_(node)
  81 #define get_irn_idx(node)                     get_irn_idx_(node)
  82
  83 #define get_irn_deps(node)                    get_irn_deps_(node)
  84 #define get_irn_dep(node, pos)                get_irn_dep_(node, pos)
  85
  86 #define get_irn_ins_or_deps(node)             get_irn_ins_or_deps_(node)
  87 #define get_irn_in_or_dep(node, pos)          get_irn_in_or_dep_(node, pos)
  88
  89 #define get_irn_dbg_info(node)                get_irn_dbg_info_(node)
  90 #define set_irn_dbg_info(node, db)            set_irn_dbg_info_(node, db)
  91
  92 #define set_Block_phis(block, phi)            set_Block_phis_(block, phi)
  93 #define get_Block_phis(block)                 get_Block_phis_(block)
  94 #define add_Block_phi(block, phi)             add_Block_phi_(block, phi)
  95 #define get_Block_mark(block)                 get_Block_mark_(block)
  96 #define set_Block_mark(block, mark)           set_Block_mark_(block, mark)
  97
  98 #define set_Phi_next(node, phi)               set_Phi_next_(node, phi)
  99 #define get_Phi_next(node)                    get_Phi_next_(node)
 100
 101 #define is_arg_Proj(node)                     is_arg_Proj_(node)
 102 #define ir_switch_table_get_n_entries(table)  ir_switch_table_get_n_entries_(table)
 103
 104 /**
 105  * Returns the array with the ins.  The content of the array may not be
 106  * changed.
 107  * Note that this function returns the whole in array including the
 108  * block predecessor. So, it is NOT symmetric with set_irn_in().
 109  */
 110 ir_node **get_irn_in(const ir_node *node);
 111
 112 /*-------------------------------------------------------------------*/
 113 /*  These function are most used in libfirm.  Give them as static    */
 114 /*  functions so they can be inlined.                                */
 115 /*-------------------------------------------------------------------*/
 116
 117 /**
 118  * Checks whether a pointer points to a ir node.
 119  * Intern version for libFirm.
 120  */
 121 static inline int is_ir_node_(const void *thing)
 122 {
 123         return (get_kind(thing) == k_ir_node);
 124 }
 125
 126 static inline unsigned get_irn_idx_(const ir_node *node)
 127 {
 128         return node->node_idx;
 129 }
 130
 131 /**
 132  * Gets the op of a node.
 133  * Intern version for libFirm.
 134  */
 135 static inline ir_op *get_irn_op_(const ir_node *node)
 136 {
 137         return node->op;
 138 }
 139
 140 static inline void set_irn_op_(ir_node *node, ir_op *op)
 141 {
 142         node->op = op;
 143 }
 144
 145 /** Copies all attributes stored in the old node  to the new node.
 146     Assumes both have the same opcode and sufficient size. */
 147 static inline void copy_node_attr_(ir_graph *irg, const ir_node *old_node,
 148                                    ir_node *new_node)
 149 {
 150         ir_op *op = get_irn_op_(old_node);
 151
 152         /* must always exist */
 153         op->ops.copy_attr(irg, old_node, new_node);
 154 }
 155
 156 /**
 157  * Gets the opcode of a node.
 158  * Intern version for libFirm.
 159  */
 160 static inline unsigned get_irn_opcode_(const ir_node *node)
 161 {
 162         assert(k_ir_node == get_kind(node));
 163         return node->op->code;
 164 }
 165
 166 /**
 167  * Returns the number of predecessors without the block predecessor.
 168  * Intern version for libFirm.
 169  */
 170 static inline int get_irn_arity_(const ir_node *node)
 171 {
 172         return (int)(ARR_LEN(node->in) - 1);
 173 }
 174
 175 /* forward decl... */
 176 #define is_Id(node) is_Id_(node)
 177 static inline int is_Id_(const ir_node *node);
 178
 179 /**
 180  * Intern version for libFirm.
 181  */
 182 static inline ir_node *get_irn_n_(const ir_node *node, int n)
 183 {
 184         ir_node *nn;
 185
 186         assert(-1 <= n && n < get_irn_arity_(node));
 187
 188         nn = node->in[n + 1];
 189         if (!is_Id(nn)) return nn;
 190
 191         return (node->in[n + 1] = skip_Id(nn));
 192 }
 193
 194 /* include generated code */
 195 #include "gen_irnode.h"
 196
 197 /**
 198  * returns a hash value for a node
 199  */
 200 static inline unsigned hash_irn(const ir_node *node)
 201 {
 202         return (unsigned) get_irn_idx(node);
 203 }
 204
 205 static inline int get_irn_deps_(const ir_node *node)
 206 {
 207         return node->deps ? (int)ARR_LEN(node->deps) : 0;
 208 }
 209
 210 static inline ir_node *get_irn_dep_(const ir_node *node, int pos)
 211 {
 212         assert(pos >= 0 && pos < (int)ARR_LEN(node->deps) && "dependency index out of range");
 213         return node->deps[pos];
 214 }
 215
 216 /* forward declaration outside iredges_t.h to avoid circular include problems */
 217 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);
 218
 219 static inline int get_irn_ins_or_deps_(const ir_node *irn)
 220 {
 221         return get_irn_deps_(irn) + get_irn_arity_(irn);
 222 }
 223
 224 static inline ir_node *get_irn_in_or_dep_(const ir_node *irn, int pos)
 225 {
 226         int n_in = get_irn_arity(irn);
 227         return pos < n_in ? get_irn_n(irn, pos) : get_irn_dep(irn, pos - n_in);
 228 }
 229
 230 /**
 231  * Gets the mode of a node.
 232  * Intern version for libFirm.
 233  */
 234 static inline ir_mode *get_irn_mode_(const ir_node *node)
 235 {
 236         return node->mode;
 237 }
 238
 239 /**
 240  * Sets the mode of a node.
 241  * Intern version of libFirm.
 242  */
 243 static inline void set_irn_mode_(ir_node *node, ir_mode *mode)
 244 {
 245         node->mode = mode;
 246 }
 247
 248 static inline int ir_has_irg_ref(const ir_node *node)
 249 {
 250         return is_Block(node) || is_Bad(node) || is_Anchor(node);
 251 }
 252
 253 static inline ir_node *get_nodes_block_(const ir_node *node)
 254 {
 255         assert(!is_Block(node));
 256         return get_irn_n(node, -1);
 257 }
 258
 259 static inline ir_graph *get_irn_irg_(const ir_node *node)
 260 {
 261         if (! is_Block(node))
 262                 node = get_nodes_block(node);
 263         assert(ir_has_irg_ref(node));
 264         return node->attr.irg.irg;
 265 }
 266
 267 /**
 268  * Gets the visited counter of a node.
 269  * Intern version for libFirm.
 270  */
 271 static inline ir_visited_t get_irn_visited_(const ir_node *node)
 272 {
 273         return node->visited;
 274 }
 275
 276 /**
 277  * Sets the visited counter of a node.
 278  * Intern version for libFirm.
 279  */
 280 static inline void set_irn_visited_(ir_node *node, ir_visited_t visited)
 281 {
 282         node->visited = visited;
 283 }
 284
 285 /**
 286  * Mark a node as visited in a graph.
 287  * Intern version for libFirm.
 288  */
 289 static inline void mark_irn_visited_(ir_node *node)
 290 {
 291         node->visited = get_irn_irg(node)->visited;
 292 }
 293
 294 /**
 295  * Returns non-zero if a node of was visited.
 296  * Intern version for libFirm.
 297  */
 298 static inline int irn_visited_(const ir_node *node)
 299 {
 300         ir_graph *irg = get_irn_irg(node);
 301         return node->visited >= irg->visited;
 302 }
 303
 304 static inline int irn_visited_else_mark_(ir_node *node)
 305 {
 306         if (irn_visited_(node))
 307                 return 1;
 308         mark_irn_visited_(node);
 309         return 0;
 310 }
 311
 312 /**
 313  * Sets the link of a node.
 314  * Intern version of libFirm.
 315  */
 316 static inline void set_irn_link_(ir_node *node, void *link)
 317 {
 318         node->link = link;
 319 }
 320
 321 /**
 322  * Returns the link of a node.
 323  * Intern version of libFirm.
 324  */
 325 static inline void *get_irn_link_(const ir_node *node)
 326 {
 327         assert(is_ir_node_(node));
 328         return node->link;
 329 }
 330
 331 /**
 332  * Returns whether the node _always_ must be pinned.
 333  * I.e., the node is not floating after global cse.
 334  *
 335  * Intern version of libFirm.
 336  */
 337 static inline op_pin_state get_irn_pinned_(const ir_node *node)
 338 {
 339         op_pin_state state;
 340         assert(is_ir_node_(node));
 341         /* Check opcode */
 342         state = get_op_pinned_(get_irn_op_(node));
 343
 344         if (state >= op_pin_state_exc_pinned)
 345                 return (op_pin_state)node->attr.except.pin_state;
 346
 347         return state;
 348 }
 349
 350 static inline op_pin_state is_irn_pinned_in_irg_(const ir_node *node)
 351 {
 352         if (get_irg_pinned(get_irn_irg(node)) == op_pin_state_floats)
 353                 return get_irn_pinned(node);
 354         return op_pin_state_pinned;
 355 }
 356
 357 static inline int is_unop_(const ir_node *node)
 358 {
 359         assert(is_ir_node_(node));
 360         return (node->op->opar == oparity_unary);
 361 }
 362
 363 static inline int is_binop_(const ir_node *node)
 364 {
 365         assert(is_ir_node_(node));
 366         return (node->op->opar == oparity_binary);
 367 }
 368
 369 static inline int is_SymConst_addr_ent_(const ir_node *node)
 370 {
 371         return is_SymConst(node) && get_SymConst_kind(node) == symconst_addr_ent;
 372 }
 373
 374 /**
 375  * Get the predecessor block.
 376  *
 377  * Returns the block corresponding to the predecessor pos.
 378  *
 379  * If we encounter the Bad node, this function does not return the Start block,
 380  * but the Bad node.
 381  */
 382 static inline ir_node *get_Block_cfgpred_block_(const ir_node *node, int pos)
 383 {
 384         ir_node *res = get_Block_cfgpred(node, pos);
 385         if (is_Bad(res)) {
 386                 /* must return a Bad with mode_BB! */
 387                 ir_graph *irg = get_irn_irg(node);
 388                 return new_r_Bad(irg, mode_BB);
 389         } else {
 390                 return get_nodes_block(res);
 391         }
 392 }
 393
 394 static inline ir_visited_t get_Block_block_visited_(const ir_node *node)
 395 {
 396         assert(is_Block(node));
 397         return node->attr.block.block_visited;
 398 }
 399
 400 static inline void set_Block_block_visited_(ir_node *node, ir_visited_t visit)
 401 {
 402         assert(is_Block(node));
 403         node->attr.block.block_visited = visit;
 404 }
 405
 406 static inline ir_graph *get_Block_irg_(const ir_node *block)
 407 {
 408         assert(is_Block(block));
 409         return block->attr.irg.irg;
 410 }
 411
 412 static inline void mark_Block_block_visited_(ir_node *node)
 413 {
 414         ir_graph *irg = get_Block_irg(node);
 415         node->attr.block.block_visited = get_irg_block_visited(irg);
 416 }
 417
 418 static inline int Block_block_visited_(const ir_node *node)
 419 {
 420         ir_graph *irg = get_Block_irg(node);
 421         return node->attr.block.block_visited >= get_irg_block_visited(irg);
 422 }
 423
 424 static inline int is_Const_null_(const ir_node *node)
 425 {
 426         return tarval_is_null(get_Const_tarval_(node));
 427 }
 428
 429 static inline int is_Const_one_(const ir_node *node)
 430 {
 431         return tarval_is_one(get_Const_tarval_(node));
 432 }
 433
 434 static inline int is_Const_all_one_(const ir_node *node)
 435 {
 436         return tarval_is_all_one(get_Const_tarval_(node));
 437 }
 438
 439 static inline int is_irn_forking_(const ir_node *node)
 440 {
 441         return is_op_forking(get_irn_op_(node));
 442 }
 443
 444 static inline ir_type *get_irn_type_attr_(ir_node *node)
 445 {
 446         return get_irn_op_(node)->ops.get_type_attr(node);
 447 }
 448
 449 static inline ir_entity *get_irn_entity_attr_(ir_node *node)
 450 {
 451         return get_irn_op_(node)->ops.get_entity_attr(node);
 452 }
 453
 454 static inline int is_irn_constlike_(const ir_node *node)
 455 {
 456         return is_op_constlike(get_irn_op_(node));
 457 }
 458
 459 static inline int is_irn_keep_(const ir_node *node)
 460 {
 461         return is_op_keep(get_irn_op_(node));
 462 }
 463
 464 static inline int is_irn_start_block_placed_(const ir_node *node)
 465 {
 466         return is_op_start_block_placed(get_irn_op_(node));
 467 }
 468
 469 static inline int is_irn_cse_neutral_(const ir_node *node)
 470 {
 471         return is_op_cse_neutral(get_irn_op_(node));
 472 }
 473
 474 static inline void *get_irn_generic_attr_(ir_node *node)
 475 {
 476         return &node->attr;
 477 }
 478
 479 static inline const void *get_irn_generic_attr_const_(const ir_node *node)
 480 {
 481         return &node->attr;
 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 /**
 581  * because firm keepalive edges are a broken concept, we have to make sure that
 582  * nodes which are only held by a keepalive edges are never moved again.
 583  * This function returns true in this case.
 584  */
 585 bool only_used_by_keepalive(const ir_node *node);
 586
 587 #endif