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
26 #ifndef FIRM_IR_IRNODE_T_H
27 #define FIRM_IR_IRNODE_T_H
32 #include "irgraph_t.h"
34 #include "firm_common_t.h"
38 * Returns the array with the ins. The content of the array may not be
40 * Note that this function returns the whole in array including the
41 * block predecessor. So, it is NOT symmetric with set_irn_in().
43 ir_node **get_irn_in (const ir_node *node);
46 /** access attributes directly */
47 const_attr *get_irn_const_attr (ir_node *node);
48 long get_irn_proj_attr (ir_node *node);
49 alloc_attr *get_irn_alloc_attr (ir_node *node);
50 free_attr *get_irn_free_attr (ir_node *node);
51 symconst_attr *get_irn_symconst_attr (ir_node *node);
52 ir_type *get_irn_call_attr (ir_node *node);
53 ir_type *get_irn_funccall_attr (ir_node *node);
54 sel_attr *get_irn_sel_attr (ir_node *node);
55 phi_attr *get_irn_phi_attr (ir_node *node);
56 block_attr *get_irn_block_attr (ir_node *node);
57 load_attr *get_irn_load_attr (ir_node *node);
58 store_attr *get_irn_store_attr (ir_node *node);
59 except_attr *get_irn_except_attr (ir_node *node);
60 divmod_attr *get_irn_divmod_attr (ir_node *node);
61 builtin_attr *get_irn_builtin_attr (ir_node *node);
65 * The amount of additional space for custom data to be allocated upon creating a new node.
67 extern unsigned firm_add_node_size;
70 * Sets the get_type operation for an ir_op_ops.
72 * @param code the opcode for the default operation
73 * @param ops the operations initialized
78 ir_op_ops *firm_set_default_get_type(ir_opcode code, ir_op_ops *ops);
81 * Sets the get_type_attr operation for an ir_op_ops.
83 * @param code the opcode for the default operation
84 * @param ops the operations initialized
89 ir_op_ops *firm_set_default_get_type_attr(ir_opcode code, ir_op_ops *ops);
92 * Sets the get_entity_attr operation for an ir_op_ops.
94 * @param code the opcode for the default operation
95 * @param ops the operations initialized
100 ir_op_ops *firm_set_default_get_entity_attr(ir_opcode code, ir_op_ops *ops);
103 * Returns an array with the predecessors of the Block. Depending on
104 * the implementation of the graph data structure this can be a copy of
105 * the internal representation of predecessors as well as the internal
106 * array itself. Therefore writing to this array might obstruct the IR.
108 ir_node **get_Block_cfgpred_arr(ir_node *node);
110 /*-------------------------------------------------------------------*/
111 /* These function are most used in libfirm. Give them as static */
112 /* functions so they can be inlined. */
113 /*-------------------------------------------------------------------*/
116 * Checks whether a pointer points to a ir node.
117 * Intern version for libFirm.
120 _is_ir_node(const void *thing) {
121 return (get_kind(thing) == k_ir_node);
125 * Gets the op of a node.
126 * Intern version for libFirm.
128 static inline ir_op *
129 _get_irn_op(const ir_node *node) {
135 _set_irn_op(ir_node *node, ir_op *op) {
140 /** Copies all attributes stored in the old node to the new node.
141 Assumes both have the same opcode and sufficient size. */
143 copy_node_attr(const ir_node *old_node, ir_node *new_node) {
144 ir_op *op = _get_irn_op(old_node);
146 /* must always exist */
147 op->ops.copy_attr(old_node, new_node);
151 * Gets the opcode of a node.
152 * Intern version for libFirm.
154 static inline unsigned
155 _get_irn_opcode(const ir_node *node) {
156 assert(k_ir_node == get_kind(node));
158 return node->op->code;
162 * Returns the number of predecessors without the block predecessor.
163 * Intern version for libFirm.
166 _get_irn_intra_arity(const ir_node *node) {
168 return ARR_LEN(node->in) - 1;
172 * Returns the number of predecessors without the block predecessor.
173 * Intern version for libFirm.
176 _get_irn_inter_arity(const ir_node *node) {
178 if (_get_irn_op(node) == op_Filter) {
179 assert(node->attr.filter.in_cg);
180 return ARR_LEN(node->attr.filter.in_cg) - 1;
181 } else if (_get_irn_op(node) == op_Block && node->attr.block.in_cg) {
182 return ARR_LEN(node->attr.block.in_cg) - 1;
184 return _get_irn_intra_arity(node);
187 #ifdef INTERPROCEDURAL_VIEW
189 * Returns the number of predecessors without the block predecessor.
190 * Intern version for libFirm.
192 extern int (*_get_irn_arity)(const ir_node *node);
196 #define _get_irn_arity(n) _get_irn_intra_arity(n)
200 * Intern version for libFirm.
202 static inline ir_node *
203 _get_irn_intra_n(const ir_node *node, int n) {
207 assert(-1 <= n && n < _get_irn_intra_arity(node));
209 nn = node->in[n + 1];
211 /* only block and Anchor inputs are allowed to be NULL */
212 assert((node->op == op_Anchor || n == -1) && "NULL input of a node");
215 if (nn->op != op_Id) return nn;
217 return (node->in[n + 1] = skip_Id(nn));
221 * Intern version for libFirm.
223 static inline ir_node*
224 _get_irn_inter_n(const ir_node *node, int n) {
225 assert(node); assert(-1 <= n && n < _get_irn_inter_arity(node));
227 /* handle Filter and Block specially */
228 if (_get_irn_op(node) == op_Filter) {
229 assert(node->attr.filter.in_cg);
230 return (node->attr.filter.in_cg[n + 1] = skip_Id(node->attr.filter.in_cg[n + 1]));
231 } else if (_get_irn_op(node) == op_Block && node->attr.block.in_cg) {
232 return (node->attr.block.in_cg[n + 1] = skip_Id(node->attr.block.in_cg[n + 1]));
235 return _get_irn_intra_n(node, n);
239 * returns a hash value for a node
241 static inline unsigned hash_irn(const ir_node *node)
243 return (unsigned) get_irn_idx(node);
247 * Access to the predecessors of a node.
248 * To iterate over the operands iterate from 0 to i < get_irn_arity(),
249 * to iterate including the Block predecessor iterate from i = -1 to
251 * If it is a block, the entry -1 is NULL.
252 * Intern version for libFirm.
254 #ifdef INTERPROCEDURAL_VIEW
255 extern ir_node *(*_get_irn_n)(const ir_node *node, int n);
257 #define _get_irn_n(n,i) _get_irn_intra_n(n,i)
260 static inline int _get_irn_deps(const ir_node *node) {
261 return node->deps ? ARR_LEN(node->deps) : 0;
264 static inline ir_node *_get_irn_dep(const ir_node *node, int pos) {
265 assert(node->deps && "dependency array node yet allocated. use add_irn_dep()");
266 assert(pos >= 0 && pos < ARR_LEN(node->deps) && "dependency index out of range");
267 return node->deps[pos];
271 _set_irn_dep(ir_node *node, int pos, ir_node *dep) {
274 assert(node->deps && "dependency array node yet allocated. use add_irn_dep()");
275 assert(pos >= 0 && pos < ARR_LEN(node->deps) && "dependency index out of range");
276 old = node->deps[pos];
277 node->deps[pos] = dep;
278 edges_notify_edge_kind(node, pos, dep, old, EDGE_KIND_DEP, get_irn_irg(node));
283 _get_irn_ins_or_deps(const ir_node *irn) {
284 return _get_irn_deps(irn) + _get_irn_arity(irn);
287 static inline ir_node *
288 _get_irn_in_or_dep(const ir_node *irn, int pos) {
289 int n_in = get_irn_arity(irn);
290 return pos < n_in ? get_irn_n(irn, pos) : get_irn_dep(irn, pos - n_in);
294 * Gets the mode of a node.
295 * Intern version for libFirm.
297 static inline ir_mode *
298 _get_irn_mode(const ir_node *node) {
304 * Sets the mode of a node.
305 * Intern version of libFirm.
308 _set_irn_mode(ir_node *node, ir_mode *mode) {
314 * Gets the visited counter of a node.
315 * Intern version for libFirm.
317 static inline ir_visited_t
318 _get_irn_visited(const ir_node *node) {
320 return node->visited;
324 * Sets the visited counter of a node.
325 * Intern version for libFirm.
328 _set_irn_visited(ir_node *node, ir_visited_t visited) {
330 node->visited = visited;
334 * Mark a node as visited in a graph.
335 * Intern version for libFirm.
338 _mark_irn_visited(ir_node *node) {
340 node->visited = current_ir_graph->visited;
344 * Returns non-zero if a node of was visited.
345 * Intern version for libFirm.
348 _irn_visited(const ir_node *node) {
350 return (node->visited >= current_ir_graph->visited);
354 _irn_visited_else_mark(ir_node *node) {
355 if (_irn_visited(node))
357 _mark_irn_visited(node);
362 * Sets the link of a node.
363 * Intern version of libFirm.
366 _set_irn_link(ir_node *node, void *link) {
372 * Returns the link of a node.
373 * Intern version of libFirm.
376 _get_irn_link(const ir_node *node) {
377 assert(node && _is_ir_node(node));
382 * Returns whether the node _always_ must be pinned.
383 * I.e., the node is not floating after global cse.
385 * Intern version of libFirm.
387 static inline op_pin_state
388 _get_irn_pinned(const ir_node *node) {
390 assert(node && _is_ir_node(node));
392 state = _get_op_pinned(_get_irn_op(node));
394 if (state >= op_pin_state_exc_pinned)
395 return get_opt_fragile_ops() ? node->attr.except.pin_state : op_pin_state_pinned;
399 static inline op_pin_state
400 _is_irn_pinned_in_irg(const ir_node *node) {
401 if (get_irg_pinned(get_irn_irg(node)) == op_pin_state_floats)
402 return get_irn_pinned(node);
403 return op_pin_state_pinned;
406 /* include generated code */
407 #include "gen_irnode.h"
410 _is_unop(const ir_node *node) {
411 assert(node && _is_ir_node(node));
412 return (node->op->opar == oparity_unary);
416 _is_binop(const ir_node *node) {
417 assert(node && _is_ir_node(node));
418 return (node->op->opar == oparity_binary);
422 _is_Phi(const ir_node *node) {
426 op = get_irn_op(node);
427 #ifdef INTERPROCEDURAL_VIEW
428 if (op == op_Filter) return get_interprocedural_view();
430 return (op == op_Phi);
434 _is_Proj(const ir_node *node) {
438 op = _get_irn_op(node);
439 #ifdef INTERPROCEDURAL_VIEW
440 if (op == op_Filter) return !get_interprocedural_view();
442 return (op == op_Proj);
446 _is_strictConv(const ir_node *node) {
447 return _is_Conv(node) && get_Conv_strict(node);
451 _is_SymConst_addr_ent(const ir_node *node) {
452 return is_SymConst(node) && get_SymConst_kind(node) == symconst_addr_ent;
456 _is_no_Block(const ir_node *node) {
457 assert(node && _is_ir_node(node));
458 return (_get_irn_op(node) != op_Block);
462 _get_Block_n_cfgpreds(const ir_node *node) {
463 assert(_is_Block(node));
464 return _get_irn_arity(node);
467 static inline ir_node *
468 _get_Block_cfgpred(const ir_node *node, int pos) {
469 assert(0 <= pos && pos < get_irn_arity(node));
470 assert(_is_Block(node));
471 return _get_irn_n(node, pos);
474 /* Get the predecessor block.
476 * Returns the block corresponding to the predecessor pos.
478 * There are several ambiguities we resolve with this function:
479 * - The direct predecessor can be a Proj, which is not pinned.
480 * We walk from the predecessor to the next pinned node
481 * (skip_Proj) and return the block that node is in.
482 * - If we encounter the Bad node, this function does not return
483 * the Start block, but the Bad node.
485 static inline ir_node *
486 _get_Block_cfgpred_block(const ir_node *node, int pos) {
487 ir_node *res = skip_Proj(get_Block_cfgpred(node, pos));
489 res = get_nodes_block(res);
493 static inline ir_visited_t
494 _get_Block_block_visited(const ir_node *node) {
495 assert(node->op == op_Block);
496 return node->attr.block.block_visited;
500 _set_Block_block_visited(ir_node *node, ir_visited_t visit) {
501 assert(node->op == op_Block);
502 node->attr.block.block_visited = visit;
505 /* For this current_ir_graph must be set. */
507 _mark_Block_block_visited(ir_node *node) {
508 assert(node->op == op_Block);
509 node->attr.block.block_visited = get_irg_block_visited(current_ir_graph);
513 _Block_block_visited(const ir_node *node) {
514 assert(node->op == op_Block);
515 return (node->attr.block.block_visited >= get_irg_block_visited(current_ir_graph));
518 static inline ir_node *
519 _set_Block_dead(ir_node *block) {
520 assert(_get_irn_op(block) == op_Block);
521 block->attr.block.dom.dom_depth = -1;
522 block->attr.block.is_dead = 1;
527 _is_Block_dead(const ir_node *block) {
528 ir_op *op = _get_irn_op(block);
533 assert(op == op_Block);
534 return block->attr.block.is_dead;
538 static inline tarval *_get_Const_tarval(const ir_node *node) {
539 assert(_get_irn_op(node) == op_Const);
540 return node->attr.con.tv;
543 static inline int _is_Const_null(const ir_node *node) {
544 return tarval_is_null(_get_Const_tarval(node));
547 static inline int _is_Const_one(const ir_node *node) {
548 return tarval_is_one(_get_Const_tarval(node));
551 static inline int _is_Const_all_one(const ir_node *node) {
552 return tarval_is_all_one(_get_Const_tarval(node));
555 static inline int _is_irn_forking(const ir_node *node) {
556 return is_op_forking(_get_irn_op(node));
559 static inline ir_type *_get_irn_type(ir_node *node) {
560 return _get_irn_op(node)->ops.get_type(node);
563 static inline ir_type *_get_irn_type_attr(ir_node *node) {
564 return _get_irn_op(node)->ops.get_type_attr(node);
567 static inline ir_entity *_get_irn_entity_attr(ir_node *node) {
568 return _get_irn_op(node)->ops.get_entity_attr(node);
571 static inline int _is_irn_constlike(const ir_node *node) {
572 return is_op_constlike(_get_irn_op(node));
575 static inline int _is_irn_always_opt(const ir_node *node) {
576 return is_op_always_opt(_get_irn_op(node));
579 static inline int _is_irn_keep(const ir_node *node) {
580 return is_op_keep(_get_irn_op(node));
583 static inline int _is_irn_start_block_placed(const ir_node *node) {
584 return is_op_start_block_placed(_get_irn_op(node));
587 static inline int _is_irn_machine_op(const ir_node *node) {
588 return is_op_machine(_get_irn_op(node));
591 static inline int _is_irn_machine_operand(const ir_node *node) {
592 return is_op_machine_operand(_get_irn_op(node));
595 static inline int _is_irn_machine_user(const ir_node *node, unsigned n) {
596 return is_op_machine_user(_get_irn_op(node), n);
599 static inline cond_jmp_predicate _get_Cond_jmp_pred(const ir_node *node) {
600 assert(_get_irn_op(node) == op_Cond);
601 return node->attr.cond.jmp_pred;
604 static inline void _set_Cond_jmp_pred(ir_node *node, cond_jmp_predicate pred) {
605 assert(_get_irn_op(node) == op_Cond);
606 node->attr.cond.jmp_pred = pred;
609 static inline void *_get_irn_generic_attr(ir_node *node) {
613 static inline const void *_get_irn_generic_attr_const(const ir_node *node) {
617 static inline unsigned _get_irn_idx(const ir_node *node) {
618 return node->node_idx;
621 static inline dbg_info *_get_irn_dbg_info(const ir_node *n) {
623 } /* get_irn_dbg_info */
625 static inline void _set_irn_dbg_info(ir_node *n, dbg_info *db) {
630 * Sets the Phi list of a block.
633 _set_Block_phis(ir_node *block, ir_node *phi) {
634 assert(_is_Block(block));
635 assert(phi == NULL || _is_Phi(phi));
636 block->attr.block.phis = phi;
640 * Returns the link of a node.
641 * Intern version of libFirm.
643 static inline ir_node *
644 _get_Block_phis(const ir_node *block) {
645 assert(_is_Block(block));
646 return block->attr.block.phis;
650 * Sets the next link of a Phi.
653 _set_Phi_next(ir_node *phi, ir_node *next) {
654 assert(_is_Phi(phi));
655 phi->attr.phi.next = next;
659 * Returns the link of a node.
660 * Intern version of libFirm.
662 static inline ir_node *
663 _get_Phi_next(const ir_node *phi) {
664 assert(_is_Phi(phi));
665 return phi->attr.phi.next;
668 /** Add a Phi node to the list of Block Phi's. */
670 _add_Block_phi(ir_node *block, ir_node *phi) {
671 _set_Phi_next(phi, _get_Block_phis(block));
672 _set_Block_phis(block, phi);
675 /** Get the Block mark (single bit). */
676 static inline unsigned
677 _get_Block_mark(const ir_node *block) {
678 assert(_is_Block(block));
679 return block->attr.block.marked;
682 /** Set the Block mark (single bit). */
684 _set_Block_mark(ir_node *block, unsigned mark) {
685 assert(_is_Block(block));
686 block->attr.block.marked = mark;
689 /** Returns non-zero if a node is a routine parameter. */
691 _is_arg_Proj(const ir_node *node) {
694 node = get_Proj_pred(node);
697 return pn_Start_T_args == get_Proj_proj(node) && is_Start(get_Proj_pred(node));
701 /* this section MUST contain all inline functions */
702 #define is_ir_node(thing) _is_ir_node(thing)
703 #define get_irn_intra_arity(node) _get_irn_intra_arity(node)
704 #define get_irn_inter_arity(node) _get_irn_inter_arity(node)
705 #define get_irn_arity(node) _get_irn_arity(node)
706 #define get_irn_intra_n(node, n) _get_irn_intra_n(node, n)
707 #define get_irn_inter_n(node, n) _get_irn_inter_n(node, n)
708 #define get_irn_n(node, n) _get_irn_n(node, n)
709 #define get_irn_mode(node) _get_irn_mode(node)
710 #define set_irn_mode(node, mode) _set_irn_mode(node, mode)
711 #define get_irn_op(node) _get_irn_op(node)
712 #define set_irn_op(node, op) _set_irn_op(node, op)
713 #define get_irn_opcode(node) _get_irn_opcode(node)
714 #define get_irn_visited(node) _get_irn_visited(node)
715 #define set_irn_visited(node, v) _set_irn_visited(node, v)
716 #define mark_irn_visited(node) _mark_irn_visited(node)
717 #define irn_visited(node) _irn_visited(node)
718 #define irn_visited_else_mark(node) _irn_visited_else_mark(node)
719 #define set_irn_link(node, link) _set_irn_link(node, link)
720 #define get_irn_link(node) _get_irn_link(node)
721 #define get_irn_pinned(node) _get_irn_pinned(node)
722 #define is_irn_pinned_in_irg(node) _is_irn_pinned_in_irg(node)
723 #define is_unop(node) _is_unop(node)
724 #define is_binop(node) _is_binop(node)
725 #define is_Proj(node) _is_Proj(node)
726 #define is_Phi(node) _is_Phi(node)
727 #define is_strictConv(node) _is_strictConv(node)
728 #define is_SymConst_addr_ent(node) _is_SymConst_addr_ent(node)
729 #define is_no_Block(node) _is_no_Block(node)
730 #define get_Block_n_cfgpreds(node) _get_Block_n_cfgpreds(node)
731 #define get_Block_cfgpred(node, pos) _get_Block_cfgpred(node, pos)
732 #define get_Block_cfgpred_block(node, pos) _get_Block_cfgpred_block(node, pos)
733 #define get_Block_block_visited(node) _get_Block_block_visited(node)
734 #define set_Block_block_visited(node, visit) _set_Block_block_visited(node, visit)
735 #define mark_Block_block_visited(node) _mark_Block_block_visited(node)
736 #define Block_block_visited(node) _Block_block_visited(node)
737 #define set_Block_dead(block) _set_Block_dead(block)
738 #define is_Block_dead(block) _is_Block_dead(block)
739 #define get_Const_tarval(node) _get_Const_tarval(node)
740 #define is_Const_null(node) _is_Const_null(node)
741 #define is_Const_one(node) _is_Const_one(node)
742 #define is_Const_all_one(node) _is_Const_all_one(node)
743 #define is_irn_forking(node) _is_irn_forking(node)
744 #define get_irn_type(node) _get_irn_type(node)
745 #define get_irn_type_attr(node) _get_irn_type_attr(node)
746 #define get_irn_entity_attr(node) _get_irn_entity_attr(node)
747 #define is_irn_constlike(node) _is_irn_constlike(node)
748 #define is_irn_always_opt(node) _is_irn_always_opt(node)
749 #define is_irn_keep(node) _is_irn_keep(node)
750 #define is_irn_start_block_placed(node) _is_irn_start_block_placed(node)
751 #define is_irn_machine_op(node) _is_irn_machine_op(node)
752 #define is_irn_machine_operand(node) _is_irn_machine_operand(node)
753 #define is_irn_machine_user(node, n) _is_irn_machine_user(node, n)
754 #define get_Cond_jmp_pred(node) _get_Cond_jmp_pred(node)
755 #define set_Cond_jmp_pred(node, pred) _set_Cond_jmp_pred(node, pred)
756 #define get_irn_generic_attr(node) _get_irn_generic_attr(node)
757 #define get_irn_generic_attr_const(node) _get_irn_generic_attr_const(node)
758 #define get_irn_idx(node) _get_irn_idx(node)
760 #define get_irn_deps(node) _get_irn_deps(node)
761 #define set_irn_dep(node, pos, dep) _set_irn_dep(node, pos, dep)
762 #define get_irn_dep(node, pos) _get_irn_dep(node, pos)
764 #define get_irn_ins_or_deps(node) _get_irn_ins_or_deps(node)
765 #define get_irn_in_or_dep(node, pos) _get_irn_in_or_dep(node, pos)
767 #define get_irn_dbg_info(node) _get_irn_dbg_info(node)
768 #define set_irn_dbg_info(node, db) _set_irn_dbg_info(node, db)
770 #define set_Block_phis(block, phi) _set_Block_phis(block, phi)
771 #define get_Block_phis(block) _get_Block_phis(block)
772 #define add_Block_phi(block, phi) _add_Block_phi(block, phi)
773 #define get_Block_mark(block) _get_Block_mark(block)
774 #define set_Block_mark(block, mark) _set_Block_mark(block, mark)
776 #define set_Phi_next(node, phi) _set_Phi_next(node, phi)
777 #define get_Phi_next(node) _get_Phi_next(node)
779 #define is_arg_Proj(node) _is_arg_Proj(node)