2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Representation of an intermediate operation -- private header.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
25 #ifndef FIRM_IR_IRNODE_T_H
26 #define FIRM_IR_IRNODE_T_H
31 #include "irgraph_t.h"
34 #include "iredges_t.h"
37 * Returns the array with the ins. The content of the array may not be
39 * Note that this function returns the whole in array including the
40 * block predecessor. So, it is NOT symmetric with set_irn_in().
42 ir_node **get_irn_in(const ir_node *node);
45 * The amount of additional space for custom data to be allocated upon creating a new node.
47 extern unsigned firm_add_node_size;
50 * Sets the get_type_attr operation for an ir_op_ops.
52 * @param code the opcode for the default operation
53 * @param ops the operations initialized
58 ir_op_ops *firm_set_default_get_type_attr(unsigned code, ir_op_ops *ops);
61 * Sets the get_entity_attr operation for an ir_op_ops.
63 * @param code the opcode for the default operation
64 * @param ops the operations initialized
69 ir_op_ops *firm_set_default_get_entity_attr(unsigned code, ir_op_ops *ops);
72 * Returns an array with the predecessors of the Block. Depending on
73 * the implementation of the graph data structure this can be a copy of
74 * the internal representation of predecessors as well as the internal
75 * array itself. Therefore writing to this array might obstruct the IR.
77 ir_node **get_Block_cfgpred_arr(ir_node *node);
79 /*-------------------------------------------------------------------*/
80 /* These function are most used in libfirm. Give them as static */
81 /* functions so they can be inlined. */
82 /*-------------------------------------------------------------------*/
85 * Checks whether a pointer points to a ir node.
86 * Intern version for libFirm.
88 static inline int is_ir_node_(const void *thing)
90 return (get_kind(thing) == k_ir_node);
94 * Gets the op of a node.
95 * Intern version for libFirm.
97 static inline ir_op *get_irn_op_(const ir_node *node)
103 static inline void set_irn_op_(ir_node *node, ir_op *op)
109 /** Copies all attributes stored in the old node to the new node.
110 Assumes both have the same opcode and sufficient size. */
111 static inline void copy_node_attr_(ir_graph *irg, const ir_node *old_node,
114 ir_op *op = get_irn_op_(old_node);
116 /* must always exist */
117 op->ops.copy_attr(irg, old_node, new_node);
121 * Gets the opcode of a node.
122 * Intern version for libFirm.
124 static inline unsigned get_irn_opcode_(const ir_node *node)
126 assert(k_ir_node == get_kind(node));
128 return node->op->code;
132 * Returns the number of predecessors without the block predecessor.
133 * Intern version for libFirm.
135 static inline int get_irn_arity_(const ir_node *node)
137 return (int)(ARR_LEN(node->in) - 1);
141 * Intern version for libFirm.
143 static inline ir_node *get_irn_n_(const ir_node *node, int n)
147 assert(-1 <= n && n < get_irn_arity_(node));
149 nn = node->in[n + 1];
150 if (nn->op != op_Id) return nn;
152 return (node->in[n + 1] = skip_Id(nn));
156 * returns a hash value for a node
158 static inline unsigned hash_irn(const ir_node *node)
160 return (unsigned) get_irn_idx(node);
163 static inline int get_irn_deps_(const ir_node *node)
165 return node->deps ? (int)ARR_LEN(node->deps) : 0;
168 static inline ir_node *get_irn_dep_(const ir_node *node, int pos)
170 assert(node->deps && "dependency array node yet allocated. use add_irn_dep()");
171 assert(pos >= 0 && pos < (int)ARR_LEN(node->deps) && "dependency index out of range");
172 return node->deps[pos];
175 /* forward declaration outside iredges_t.h to avoid circular include problems */
176 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);
178 static inline void set_irn_dep_(ir_node *node, int pos, ir_node *dep)
182 assert(node->deps && "dependency array node yet allocated. use add_irn_dep()");
183 assert(pos >= 0 && pos < (int)ARR_LEN(node->deps) && "dependency index out of range");
184 old = node->deps[pos];
185 node->deps[pos] = dep;
186 edges_notify_edge_kind(node, pos, dep, old, EDGE_KIND_DEP, get_irn_irg(node));
190 static inline int get_irn_ins_or_deps_(const ir_node *irn)
192 return get_irn_deps_(irn) + get_irn_arity_(irn);
195 static inline ir_node *get_irn_in_or_dep_(const ir_node *irn, int pos)
197 int n_in = get_irn_arity(irn);
198 return pos < n_in ? get_irn_n(irn, pos) : get_irn_dep(irn, pos - n_in);
202 * Gets the mode of a node.
203 * Intern version for libFirm.
205 static inline ir_mode *get_irn_mode_(const ir_node *node)
212 * Sets the mode of a node.
213 * Intern version of libFirm.
215 static inline void set_irn_mode_(ir_node *node, ir_mode *mode)
221 static inline int ir_has_irg_ref(const ir_node *node)
223 return is_Block(node) || is_Bad(node) || is_Anchor(node);
226 static inline ir_graph *get_irn_irg_(const ir_node *node)
229 * Do not use get_nodes_block() here, because this
230 * will check the pinned state.
231 * However even a 'wrong' block is always in the proper irg.
233 if (! is_Block(node))
234 node = get_irn_n(node, -1);
235 assert(ir_has_irg_ref(node));
236 return node->attr.irg.irg;
239 static inline ir_node *get_nodes_block_(const ir_node *node)
241 assert(!is_Block(node));
242 return get_irn_n(node, -1);
246 * Gets the visited counter of a node.
247 * Intern version for libFirm.
249 static inline ir_visited_t get_irn_visited_(const ir_node *node)
252 return node->visited;
256 * Sets the visited counter of a node.
257 * Intern version for libFirm.
259 static inline void set_irn_visited_(ir_node *node, ir_visited_t visited)
262 node->visited = visited;
266 * Mark a node as visited in a graph.
267 * Intern version for libFirm.
269 static inline void mark_irn_visited_(ir_node *node)
271 node->visited = get_irn_irg(node)->visited;
275 * Returns non-zero if a node of was visited.
276 * Intern version for libFirm.
278 static inline int irn_visited_(const ir_node *node)
280 ir_graph *irg = get_irn_irg(node);
281 return node->visited >= irg->visited;
284 static inline int irn_visited_else_mark_(ir_node *node)
286 if (irn_visited_(node))
288 mark_irn_visited_(node);
293 * Sets the link of a node.
294 * Intern version of libFirm.
296 static inline void set_irn_link_(ir_node *node, void *link)
303 * Returns the link of a node.
304 * Intern version of libFirm.
306 static inline void *get_irn_link_(const ir_node *node)
308 assert(node && is_ir_node_(node));
313 * Returns whether the node _always_ must be pinned.
314 * I.e., the node is not floating after global cse.
316 * Intern version of libFirm.
318 static inline op_pin_state get_irn_pinned_(const ir_node *node)
321 assert(node && is_ir_node_(node));
323 state = get_op_pinned_(get_irn_op_(node));
325 if (state >= op_pin_state_exc_pinned)
326 return (op_pin_state)node->attr.except.pin_state;
331 static inline op_pin_state is_irn_pinned_in_irg_(const ir_node *node)
333 if (get_irg_pinned(get_irn_irg(node)) == op_pin_state_floats)
334 return get_irn_pinned(node);
335 return op_pin_state_pinned;
338 /* include generated code */
339 #include "gen_irnode.h"
341 static inline int is_unop_(const ir_node *node)
343 assert(node && is_ir_node_(node));
344 return (node->op->opar == oparity_unary);
347 static inline int is_binop_(const ir_node *node)
349 assert(node && is_ir_node_(node));
350 return (node->op->opar == oparity_binary);
353 static inline int is_strictConv_(const ir_node *node)
355 return is_Conv_(node) && get_Conv_strict(node);
358 static inline int is_SymConst_addr_ent_(const ir_node *node)
360 return is_SymConst(node) && get_SymConst_kind(node) == symconst_addr_ent;
363 static inline int get_Block_n_cfgpreds_(const ir_node *node)
365 assert(is_Block_(node));
366 return get_irn_arity_(node);
369 static inline ir_node *get_Block_cfgpred_(const ir_node *node, int pos)
371 assert(is_Block_(node));
372 return get_irn_n_(node, pos);
375 /* Get the predecessor block.
377 * Returns the block corresponding to the predecessor pos.
379 * There are several ambiguities we resolve with this function:
380 * - The direct predecessor can be a Proj, which is not pinned.
381 * We walk from the predecessor to the next pinned node
382 * (skip_Proj) and return the block that node is in.
383 * - If we encounter the Bad node, this function does not return
384 * the Start block, but the Bad node.
386 static inline ir_node *get_Block_cfgpred_block_(const ir_node *node, int pos)
388 ir_node *res = get_Block_cfgpred(node, pos);
390 /* must return a Bad with mode_BB! */
391 ir_graph *irg = get_irn_irg(node);
392 return new_r_Bad(irg, mode_BB);
394 return get_nodes_block(skip_Proj(res));
398 static inline ir_visited_t get_Block_block_visited_(const ir_node *node)
400 assert(is_Block(node));
401 return node->attr.block.block_visited;
404 static inline void set_Block_block_visited_(ir_node *node, ir_visited_t visit)
406 assert(is_Block(node));
407 node->attr.block.block_visited = visit;
410 static inline void mark_Block_block_visited_(ir_node *node)
412 ir_graph *irg = get_Block_irg(node);
413 node->attr.block.block_visited = get_irg_block_visited(irg);
416 static inline int Block_block_visited_(const ir_node *node)
418 ir_graph *irg = get_Block_irg(node);
419 return node->attr.block.block_visited >= get_irg_block_visited(irg);
422 static inline ir_graph *get_Block_irg_(const ir_node *block)
424 assert(is_Block(block));
425 return block->attr.irg.irg;
428 static inline ir_tarval *get_Const_tarval_(const ir_node *node)
430 assert(get_irn_op_(node) == op_Const);
431 return node->attr.con.tarval;
434 static inline int is_Const_null_(const ir_node *node)
436 return tarval_is_null(get_Const_tarval_(node));
439 static inline int is_Const_one_(const ir_node *node)
441 return tarval_is_one(get_Const_tarval_(node));
444 static inline int is_Const_all_one_(const ir_node *node)
446 return tarval_is_all_one(get_Const_tarval_(node));
449 static inline int is_irn_forking_(const ir_node *node)
451 return is_op_forking(get_irn_op_(node));
454 static inline ir_type *get_irn_type_attr_(ir_node *node)
456 return get_irn_op_(node)->ops.get_type_attr(node);
459 static inline ir_entity *get_irn_entity_attr_(ir_node *node)
461 return get_irn_op_(node)->ops.get_entity_attr(node);
464 static inline int is_irn_constlike_(const ir_node *node)
466 return is_op_constlike(get_irn_op_(node));
469 static inline int is_irn_always_opt_(const ir_node *node)
471 return is_op_always_opt(get_irn_op_(node));
474 static inline int is_irn_keep_(const ir_node *node)
476 return is_op_keep(get_irn_op_(node));
479 static inline int is_irn_start_block_placed_(const ir_node *node)
481 return is_op_start_block_placed(get_irn_op_(node));
484 static inline int is_irn_machine_op_(const ir_node *node)
486 return is_op_machine(get_irn_op_(node));
489 static inline int is_irn_machine_operand_(const ir_node *node)
491 return is_op_machine_operand(get_irn_op_(node));
494 static inline int is_irn_machine_user_(const ir_node *node, unsigned n)
496 return is_op_machine_user(get_irn_op_(node), n);
499 static inline int is_irn_cse_neutral_(const ir_node *node)
501 return is_op_cse_neutral(get_irn_op_(node));
504 static inline cond_jmp_predicate get_Cond_jmp_pred_(const ir_node *node)
506 assert(get_irn_op_(node) == op_Cond);
507 return node->attr.cond.jmp_pred;
510 static inline void set_Cond_jmp_pred_(ir_node *node, cond_jmp_predicate pred)
512 assert(get_irn_op_(node) == op_Cond);
513 node->attr.cond.jmp_pred = pred;
516 static inline void *get_irn_generic_attr_(ir_node *node)
521 static inline const void *get_irn_generic_attr_const_(const ir_node *node)
526 static inline unsigned get_irn_idx_(const ir_node *node)
528 return node->node_idx;
531 static inline dbg_info *get_irn_dbg_info_(const ir_node *n)
536 static inline void set_irn_dbg_info_(ir_node *n, dbg_info *db)
542 * Sets the Phi list of a block.
544 static inline void set_Block_phis_(ir_node *block, ir_node *phi)
546 assert(is_Block_(block));
547 assert(phi == NULL || is_Phi_(phi));
548 block->attr.block.phis = phi;
552 * Returns the link of a node.
553 * Intern version of libFirm.
555 static inline ir_node *get_Block_phis_(const ir_node *block)
557 assert(is_Block_(block));
558 return block->attr.block.phis;
561 static inline void set_Phi_next_(ir_node *phi, ir_node *next)
563 assert(is_Phi_(phi));
564 phi->attr.phi.next = next;
567 static inline ir_node *get_Phi_next_(const ir_node *phi)
569 assert(is_Phi_(phi));
570 return phi->attr.phi.next;
573 /** Add a Phi node to the list of Block Phi's. */
574 static inline void add_Block_phi_(ir_node *block, ir_node *phi)
576 assert(is_Block_(block));
577 set_Phi_next_(phi, get_Block_phis_(block));
578 set_Block_phis_(block, phi);
581 /** Get the Block mark (single bit). */
582 static inline unsigned get_Block_mark_(const ir_node *block)
584 assert(is_Block_(block));
585 return block->attr.block.marked;
588 /** Set the Block mark (single bit). */
589 static inline void set_Block_mark_(ir_node *block, unsigned mark)
591 assert(is_Block_(block));
592 block->attr.block.marked = mark;
595 /** Returns non-zero if a node is a routine parameter. */
596 static inline int is_arg_Proj_(const ir_node *node)
600 node = get_Proj_pred(node);
603 return pn_Start_T_args == get_Proj_proj(node) && is_Start(get_Proj_pred(node));
606 static inline size_t ir_switch_table_get_n_entries_(const ir_switch_table *table)
608 return table->n_entries;
611 static inline ir_switch_table_entry *ir_switch_table_get_entry(
612 ir_switch_table *table, size_t entry)
614 assert(entry < table->n_entries);
615 return &table->entries[entry];
618 static inline const ir_switch_table_entry *ir_switch_table_get_entry_const(
619 const ir_switch_table *table, size_t entry)
621 assert(entry < table->n_entries);
622 return &table->entries[entry];
625 /** initialize ir_node module */
626 void init_irnode(void);
628 /* this section MUST contain all inline functions */
629 #define is_ir_node(thing) is_ir_node_(thing)
630 #define get_irn_arity(node) get_irn_arity_(node)
631 #define get_irn_n(node, n) get_irn_n_(node, n)
632 #define get_irn_mode(node) get_irn_mode_(node)
633 #define set_irn_mode(node, mode) set_irn_mode_(node, mode)
634 #define get_irn_irg(node) get_irn_irg_(node)
635 #define get_nodes_block(node) get_nodes_block_(node)
636 #define get_irn_op(node) get_irn_op_(node)
637 #define set_irn_op(node, op) set_irn_op_(node, op)
638 #define get_irn_opcode(node) get_irn_opcode_(node)
639 #define get_irn_visited(node) get_irn_visited_(node)
640 #define set_irn_visited(node, v) set_irn_visited_(node, v)
641 #define mark_irn_visited(node) mark_irn_visited_(node)
642 #define irn_visited(node) irn_visited_(node)
643 #define irn_visited_else_mark(node) irn_visited_else_mark_(node)
644 #define set_irn_link(node, link) set_irn_link_(node, link)
645 #define get_irn_link(node) get_irn_link_(node)
646 #define get_irn_pinned(node) get_irn_pinned_(node)
647 #define is_irn_pinned_in_irg(node) is_irn_pinned_in_irg_(node)
648 #define is_unop(node) is_unop_(node)
649 #define is_binop(node) is_binop_(node)
650 #define is_Proj(node) is_Proj_(node)
651 #define is_Phi(node) is_Phi_(node)
652 #define is_strictConv(node) is_strictConv_(node)
653 #define is_SymConst_addr_ent(node) is_SymConst_addr_ent_(node)
654 #define get_Block_n_cfgpreds(node) get_Block_n_cfgpreds_(node)
655 #define get_Block_cfgpred(node, pos) get_Block_cfgpred_(node, pos)
656 #define get_Block_cfgpred_block(node, pos) get_Block_cfgpred_block_(node, pos)
657 #define get_Block_block_visited(node) get_Block_block_visited_(node)
658 #define set_Block_block_visited(node, visit) set_Block_block_visited_(node, visit)
659 #define mark_Block_block_visited(node) mark_Block_block_visited_(node)
660 #define Block_block_visited(node) Block_block_visited_(node)
661 #define get_Block_irg(block) get_Block_irg_(block)
662 #define get_Const_tarval(node) get_Const_tarval_(node)
663 #define is_Const_null(node) is_Const_null_(node)
664 #define is_Const_one(node) is_Const_one_(node)
665 #define is_Const_all_one(node) is_Const_all_one_(node)
666 #define is_irn_forking(node) is_irn_forking_(node)
667 #define copy_node_attr(irg,oldn,newn) copy_node_attr_(irg,oldn,newn)
668 #define get_irn_type(node) get_irn_type_(node)
669 #define get_irn_type_attr(node) get_irn_type_attr_(node)
670 #define get_irn_entity_attr(node) get_irn_entity_attr_(node)
671 #define is_irn_constlike(node) is_irn_constlike_(node)
672 #define is_irn_always_opt(node) is_irn_always_opt_(node)
673 #define is_irn_keep(node) is_irn_keep_(node)
674 #define is_irn_start_block_placed(node) is_irn_start_block_placed_(node)
675 #define is_irn_machine_op(node) is_irn_machine_op_(node)
676 #define is_irn_machine_operand(node) is_irn_machine_operand_(node)
677 #define is_irn_machine_user(node, n) is_irn_machine_user_(node, n)
678 #define is_irn_cse_neutral(node) is_irn_cse_neutral_(node)
679 #define get_Cond_jmp_pred(node) get_Cond_jmp_pred_(node)
680 #define set_Cond_jmp_pred(node, pred) set_Cond_jmp_pred_(node, pred)
681 #define get_irn_generic_attr(node) get_irn_generic_attr_(node)
682 #define get_irn_generic_attr_const(node) get_irn_generic_attr_const_(node)
683 #define get_irn_idx(node) get_irn_idx_(node)
685 #define get_irn_deps(node) get_irn_deps_(node)
686 #define set_irn_dep(node, pos, dep) set_irn_dep_(node, pos, dep)
687 #define get_irn_dep(node, pos) get_irn_dep_(node, pos)
689 #define get_irn_ins_or_deps(node) get_irn_ins_or_deps_(node)
690 #define get_irn_in_or_dep(node, pos) get_irn_in_or_dep_(node, pos)
692 #define get_irn_dbg_info(node) get_irn_dbg_info_(node)
693 #define set_irn_dbg_info(node, db) set_irn_dbg_info_(node, db)
695 #define set_Block_phis(block, phi) set_Block_phis_(block, phi)
696 #define get_Block_phis(block) get_Block_phis_(block)
697 #define add_Block_phi(block, phi) add_Block_phi_(block, phi)
698 #define get_Block_mark(block) get_Block_mark_(block)
699 #define set_Block_mark(block, mark) set_Block_mark_(block, mark)
701 #define set_Phi_next(node, phi) set_Phi_next_(node, phi)
702 #define get_Phi_next(node) get_Phi_next_(node)
704 #define is_arg_Proj(node) is_arg_Proj_(node)
705 #define ir_switch_table_get_n_entries(table) ir_switch_table_get_n_entries_(table)