3 * File name: ir/ir/irnode_t.h
4 * Purpose: Representation of an intermediate operation -- private header.
5 * Author: Martin Trapp, Christian Schaefer
6 * Modified by: Goetz Lindenmaier
9 * Copyright: (c) 1998-2003 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
16 * Declarations of an ir node.
18 * @author Martin Trapp, Christian Schaefer
24 #include "firm_config.h"
27 #include "irgraph_t.h"
29 #include "firm_common_t.h"
30 #include "irdom_t.h" /* For size of struct dom_info. */
40 #include "irextbb_t.h"
43 /** ir node attributes **/
45 /** Block attributes */
47 /* General attributes */
49 unsigned long block_visited; /**< for the walker that walks over all blocks. */
50 /* Attributes private to construction: */
51 unsigned matured:1; /**< if set, all in-nodes of the block are fixed */
52 unsigned dead:1; /**< if set, the block is dead (and could be replace by a Bad */
53 ir_node **graph_arr; /**< array to store all parameters */
54 /* Attributes holding analyses information */
55 dom_info dom; /**< Datastructure that holds information about dominators.
57 Eventually overlay with graph_arr as only valid
58 in different phases. Eventually inline the whole
60 dom_info pdom; /**< Datastructure that holds information about post-dominators. */
61 ir_node ** in_cg; /**< array with predecessors in
62 * interprocedural_view, if they differ
63 * from intraprocedural predecessors */
64 int *backedge; /**< Field n set to true if pred n is backedge.
65 @@@ @todo Ev. replace by bit field! */
66 int *cg_backedge; /**< Field n set to true if pred n is interprocedural backedge.
67 @@@ @todo Ev. replace by bit field! */
68 ir_extblk *extblk; /**< the extended basic block this block belongs to */
70 struct list_head succ_head; /**< A list head for all successor edges of a block. */
74 /** Start attributes */
77 /* ir_graph *irg; @@@ now in block */
80 /** Cond attributes */
82 cond_kind kind; /**< flavor of Cond */
83 long default_proj; /**< only for non-binary Conds: biggest Proj number, i.e. the one used for default. */
84 cond_jmp_predicate pred; /**< only for binary Conds: The jump predication. */
87 /** Const attributes */
89 tarval *tv; /**< the target value */
90 ir_type *tp; /**< the source type, for analyses. default: type_unknown. */
94 symconst_symbol sym; // old tori
96 ir_type *tp; /**< the source type, for analyses. default: type_unknown. */
101 entity *ent; /**< entity to select */
104 /** Exception attributes */
106 op_pin_state pin_state; /**< the pin state for operations that might generate a exception:
107 If it's know that no exception will be generated, could be set to
108 op_pin_state_floats. */
109 #if PRECISE_EXC_CONTEXT
110 struct ir_node **frag_arr; /**< For Phi node construction in case of exception */
114 /** Call attributes */
116 except_attr exc; /**< the exception attribute. MUST be the first one. */
117 ir_type *cld_tp; /**< type of called procedure */
118 entity ** callee_arr; /**< result of callee analysis */
121 /** Alloc attributes */
123 except_attr exc; /**< the exception attribute. MUST be the first one. */
124 ir_type *type; /**< Type of the allocated object. */
125 where_alloc where; /**< stack, heap or other managed part of memory */
128 /** Free attributes */
130 ir_type *type; /**< Type of the allocated object. */
131 where_alloc where; /**< stack, heap or other managed part of memory */
134 /** InstOf attributes */
136 except_attr exc; /**< the exception attribute. MUST be the first one. */
137 ir_type *type; /**< the type of which the object pointer must be */
140 /** Filter attributes */
142 long proj; /**< contains the result position to project (Proj) */
143 ir_node ** in_cg; /**< array with interprocedural predecessors (Phi) */
144 int *backedge; /**< Field n set to true if pred n is backedge.
145 @todo Ev. replace by bitfield! */
148 /** EndReg/EndExcept attributes */
153 /** CallBegin attributes */
155 ir_node * call; /**< Associated Call-operation. */
158 /** Cast attributes */
160 ir_type *totype; /**< Type of the casted node. */
163 /** Load attributes */
165 except_attr exc; /**< The exception attribute. MUST be the first one. */
166 ir_mode *load_mode; /**< The mode of this Load operation. */
167 ent_volatility volatility; /**< The volatility of a Load/Store operation. */
170 /** Store attributes */
172 except_attr exc; /**< the exception attribute. MUST be the first one. */
173 ent_volatility volatility; /**< the volatility of a Store operation */
176 typedef pn_Cmp confirm_attr; /**< Attribute to hold compare operation */
178 /** CopyB attribute */
180 except_attr exc; /**< The exception attribute. MUST be the first one. */
181 ir_type *data_type; /**< Type of the copied entity. */
184 /** Bound attribute */
186 except_attr exc; /**< The exception attribute. MUST be the first one. */
190 * Edge info to put into an irn.
192 typedef struct _irn_edge_info_t {
193 struct list_head outs_head; /**< The list of all outs. */
194 int out_count; /**< Number of outs in the list. */
198 /** Some IR-nodes just have one attribute, these are stored here,
199 some have more. Their name is 'irnodename_attr' */
201 start_attr start; /**< For Start */
202 block_attr block; /**< For Block: Fields needed to construct it */
203 cond_attr c; /**< For Cond. */
204 const_attr con; /**< For Const: contains the value of the constant and a type */
205 symconst_attr i; /**< For SymConst. */
206 sel_attr s; /**< For Sel. */
207 call_attr call; /**< For Call: pointer to the type of the method to call */
208 callbegin_attr callbegin; /**< For CallBegin */
209 alloc_attr a; /**< For Alloc. */
210 free_attr f; /**< For Free. */
211 io_attr io; /**< For InstOf */
212 cast_attr cast; /**< For Cast. */
213 load_attr load; /**< For Load. */
214 store_attr store; /**< For Store. */
215 int phi0_pos; /**< For Phi. Used to remember the value defined by
216 this Phi node. Needed when the Phi is completed
217 to call get_r_internal_value to find the
218 predecessors. If this attribute is set, the Phi
219 node takes the role of the obsolete Phi0 node,
220 therefore the name. */
221 int *phi_backedge; /**< For Phi after construction.
222 Field n set to true if pred n is backedge.
223 @todo Ev. replace by bitfield! */
224 long proj; /**< For Proj: contains the result position to project */
225 confirm_attr confirm_cmp; /**< For Confirm: compare operation */
226 filter_attr filter; /**< For Filter */
227 end_attr end; /**< For EndReg, EndExcept */
228 except_attr except; /**< For Phi node construction in case of exceptions */
229 copyb_attr copyb; /**< For CopyB operation */
230 bound_attr bound; /**< For Bound operation */
234 /** common structure of an irnode
235 if the node has some attributes, they are stored in attr */
237 /* ------- Basics of the representation ------- */
238 firm_kind kind; /**< distinguishes this node from others */
239 ir_op *op; /**< Opcode of this node. */
240 ir_mode *mode; /**< Mode of this node. */
241 struct ir_node **in; /**< array with predecessors / operands */
242 unsigned long visited; /**< visited counter for walks of the graph */
243 void *link; /**< to attach additional information to the node, e.g.
244 used while construction to link Phi0 nodes and
245 during optimization to link to nodes that
246 shall replace a node. */
247 /* ------- Fields for optimizations / analysis information ------- */
248 struct ir_node **out; /**< @deprecated array of out edges. */
249 struct dbg_info* dbi; /**< A pointer to information for debug support. */
250 /* ------- For debugging ------- */
253 long node_nr; /**< a unique node number for each node to make output
256 /* ------- For analyses -------- */
257 ir_loop *loop; /**< the loop the node is in. Access routines in irloop.h */
258 #ifdef DO_HEAPANALYSIS
259 struct abstval *av; /**< the abstract value of this node */
262 #if FIRM_EDGES_INPLACE
263 irn_edge_info_t edge_info; /**< everlasting out edges */
265 /* ------- Opcode depending fields -------- */
266 attr attr; /**< attribute of this node. Depends on opcode.
267 Must be last field of struct ir_node. */
272 * Returns the array with the ins. The content of the array may not be
274 * Note that this function returns the whole in array including the
275 * block predecessor. So, it is NOT symmetric with set_irn_in().
277 ir_node **get_irn_in (const ir_node *node);
280 /** access attributes directly */
281 const_attr get_irn_const_attr (ir_node *node);
282 long get_irn_proj_attr (ir_node *node);
283 alloc_attr get_irn_alloc_attr (ir_node *node);
284 free_attr get_irn_free_attr (ir_node *node);
285 symconst_attr get_irn_symconst_attr (ir_node *node);
286 ir_type *get_irn_call_attr (ir_node *node);
287 ir_type *get_irn_funccall_attr (ir_node *node);
288 sel_attr get_irn_sel_attr (ir_node *node);
289 int get_irn_phi_attr (ir_node *node);
290 block_attr get_irn_block_attr (ir_node *node);
291 load_attr get_irn_load_attr (ir_node *node);
292 store_attr get_irn_store_attr (ir_node *node);
293 except_attr get_irn_except_attr (ir_node *node);
297 * The amount of additional space for custom data to be allocated upon creating a new node.
299 extern unsigned firm_add_node_size;
302 * Sets the get_type operation for an ir_op_ops.
304 * @param code the opcode for the default operation
305 * @param ops the operations initialized
310 ir_op_ops *firm_set_default_get_type(opcode code, ir_op_ops *ops);
313 * Sets the get_type_attr operation for an ir_op_ops.
315 * @param code the opcode for the default operation
316 * @param ops the operations initialized
321 ir_op_ops *firm_set_default_get_type_attr(opcode code, ir_op_ops *ops);
324 * Sets the get_entity_attr operation for an ir_op_ops.
326 * @param code the opcode for the default operation
327 * @param ops the operations initialized
332 ir_op_ops *firm_set_default_get_entity_attr(opcode code, ir_op_ops *ops);
334 /*-------------------------------------------------------------------*/
335 /* These function are most used in libfirm. Give them as static */
336 /* functions so they can be inlined. */
337 /*-------------------------------------------------------------------*/
340 * Checks whether a pointer points to a ir node.
341 * Intern version for libFirm.
344 _is_ir_node (const void *thing) {
345 return (get_kind(thing) == k_ir_node);
349 * Gets the op of a node.
350 * Intern version for libFirm.
352 static INLINE ir_op *
353 _get_irn_op (const ir_node *node) {
358 /** Copies all attributes stored in the old node to the new node.
359 Assumes both have the same opcode and sufficient size. */
361 copy_node_attr(const ir_node *old_node, ir_node *new_node) {
362 ir_op *op = _get_irn_op(old_node);
364 /* must always exist */
365 op->ops.copy_attr(old_node, new_node);
369 * Gets the opcode of a node.
370 * Intern version for libFirm.
373 _get_irn_opcode (const ir_node *node) {
374 assert (k_ir_node == get_kind(node));
376 return node->op->code;
380 * Returns the number of predecessors without the block predecessor.
381 * Intern version for libFirm.
384 _get_irn_intra_arity (const ir_node *node) {
386 return ARR_LEN(node->in) - 1;
390 * Returns the number of predecessors without the block predecessor.
391 * Intern version for libFirm.
394 _get_irn_inter_arity (const ir_node *node) {
396 if (_get_irn_op(node) == op_Filter) {
397 assert(node->attr.filter.in_cg);
398 return ARR_LEN(node->attr.filter.in_cg) - 1;
399 } else if (_get_irn_op(node) == op_Block && node->attr.block.in_cg) {
400 return ARR_LEN(node->attr.block.in_cg) - 1;
402 return _get_irn_intra_arity(node);
406 * Returns the number of predecessors without the block predecessor.
407 * Intern version for libFirm.
409 extern int (*_get_irn_arity)(const ir_node *node);
412 * Intern version for libFirm.
414 static INLINE ir_node *
415 _get_irn_intra_n (const ir_node *node, int n) {
418 assert(node); assert(-1 <= n && n < _get_irn_intra_arity(node));
420 nn = node->in[n + 1];
421 if (!nn || (nn->op != op_Id)) return nn;
423 return (node->in[n + 1] = skip_Id(nn));
427 * Intern version for libFirm.
429 static INLINE ir_node*
430 _get_irn_inter_n (const ir_node *node, int n) {
431 assert(node); assert(-1 <= n && n < _get_irn_inter_arity(node));
433 /* handle Filter and Block specially */
434 if (_get_irn_op(node) == op_Filter) {
435 assert(node->attr.filter.in_cg);
436 return (node->attr.filter.in_cg[n + 1] = skip_Id(node->attr.filter.in_cg[n + 1]));
437 } else if (_get_irn_op(node) == op_Block && node->attr.block.in_cg) {
438 return (node->attr.block.in_cg[n + 1] = skip_Id(node->attr.block.in_cg[n + 1]));
441 return _get_irn_intra_n (node, n);
445 * Access to the predecessors of a node.
446 * To iterate over the operands iterate from 0 to i < get_irn_arity(),
447 * to iterate including the Block predecessor iterate from i = -1 to
449 * If it is a block, the entry -1 is NULL.
450 * Intern version for libFirm.
452 extern ir_node *(*_get_irn_n)(const ir_node *node, int n);
455 * Gets the mode of a node.
456 * Intern version for libFirm.
458 static INLINE ir_mode *
459 _get_irn_mode (const ir_node *node)
466 * Sets the mode of a node.
467 * Intern version of libFirm.
470 _set_irn_mode (ir_node *node, ir_mode *mode)
477 * Gets the visited counter of a node.
478 * Intern version for libFirm.
480 static INLINE unsigned long
481 _get_irn_visited (const ir_node *node)
484 return node->visited;
488 * Sets the visited counter of a node.
489 * Intern version for libFirm.
492 _set_irn_visited (ir_node *node, unsigned long visited)
495 node->visited = visited;
499 * Mark a node as visited in a graph.
500 * Intern version for libFirm.
503 _mark_irn_visited (ir_node *node) {
505 node->visited = current_ir_graph->visited;
509 * Returns non-zero if a node of was visited.
510 * Intern version for libFirm.
513 _irn_visited(const ir_node *node) {
515 return (node->visited >= current_ir_graph->visited);
519 * Returns non-zero if a node of was NOT visited.
520 * Intern version for libFirm.
523 _irn_not_visited(const ir_node *node) {
525 return (node->visited < current_ir_graph->visited);
529 * Sets the link of a node.
530 * Intern version of libFirm.
533 _set_irn_link(ir_node *node, void *link) {
535 /* Link field is used for Phi construction and various optimizations
537 assert(get_irg_phase_state(get_irn_irg(node)) != phase_building);
543 * Returns the link of a node.
544 * Intern version of libFirm.
547 _get_irn_link(const ir_node *node) {
548 assert (node && _is_ir_node(node));
553 * Returns whether the node _always_ must be pinned.
554 * I.e., the node is not floating after global cse.
556 * Intern version of libFirm.
558 static INLINE op_pin_state
559 _get_irn_pinned(const ir_node *node) {
561 assert(node && _is_ir_node(node));
563 state = _get_op_pinned(_get_irn_op(node));
565 if (state >= op_pin_state_exc_pinned)
566 return get_opt_fragile_ops() ? node->attr.except.pin_state : op_pin_state_pinned;
570 static INLINE op_pin_state
571 _is_irn_pinned_in_irg(const ir_node *node) {
572 if (get_irg_pinned(get_irn_irg(node)) == op_pin_state_floats)
573 return get_irn_pinned(node);
574 return op_pin_state_pinned;
578 _is_unop(const ir_node *node) {
579 assert(node && _is_ir_node(node));
580 return (node->op->opar == oparity_unary);
584 _is_binop(const ir_node *node) {
585 assert(node && _is_ir_node(node));
586 return (node->op->opar == oparity_binary);
590 _is_Bad(const ir_node *node) {
592 return (node && _get_irn_op(node) == op_Bad);
596 _is_Const(const ir_node *node) {
598 return (node && _get_irn_op(node) == op_Const);
602 _is_Unknown (const ir_node *node) {
604 return (node && _get_irn_op(node) == op_Unknown);
608 _is_Return (const ir_node *node) {
610 return (node && _get_irn_op(node) == op_Return);
614 _is_Call (const ir_node *node) {
616 return (node && _get_irn_op(node) == op_Call);
620 _is_Sel (const ir_node *node) {
622 return (node && _get_irn_op(node) == op_Sel);
626 _is_Mux (const ir_node *node) {
629 ir_op *op = _get_irn_op(node);
630 return (op == op_Mux || ((op == op_Psi) && _get_irn_arity(node) == 3));
636 _is_no_Block(const ir_node *node) {
637 assert(node && _is_ir_node(node));
638 return (_get_irn_op(node) != op_Block);
642 _is_Block(const ir_node *node) {
643 assert(node && _is_ir_node(node));
644 return (_get_irn_op(node) == op_Block);
648 _get_Block_n_cfgpreds (ir_node *node) {
649 assert(_is_Block(node));
650 return _get_irn_arity(node);
653 static INLINE ir_node *
654 _get_Block_cfgpred (ir_node *node, int pos) {
655 assert(0 <= pos && pos < get_irn_arity(node));
656 assert(_is_Block(node));
657 return _get_irn_n(node, pos);
660 /* Get the predecessor block.
662 * Returns the block corresponding to the predecessor pos.
664 * There are several ambiguities we resolve with this function:
665 * - The direct predecessor can be a Proj, which is not pinned.
666 * We walk from the predecessor to the next pinned node
667 * (skip_Proj) and return the block that node is in.
668 * - If we encounter the Bad node, this function does not return
669 * Start, but the Bad node.
671 static INLINE ir_node *
672 _get_Block_cfgpred_block(ir_node *node, int pos) {
673 ir_node *res = skip_Proj(get_Block_cfgpred(node, pos));
675 res = get_nodes_block(res);
679 static INLINE unsigned long
680 _get_Block_block_visited (ir_node *node) {
681 assert (node->op == op_Block);
682 return node->attr.block.block_visited;
686 _set_Block_block_visited (ir_node *node, unsigned long visit) {
687 assert (node->op == op_Block);
688 node->attr.block.block_visited = visit;
691 /* For this current_ir_graph must be set. */
693 _mark_Block_block_visited (ir_node *node) {
694 assert (node->op == op_Block);
695 node->attr.block.block_visited = get_irg_block_visited(current_ir_graph);
699 _Block_not_block_visited(ir_node *node) {
700 assert (node->op == op_Block);
701 return (node->attr.block.block_visited < get_irg_block_visited(current_ir_graph));
704 static INLINE ir_node *
705 _set_Block_dead(ir_node *block) {
706 assert(_get_irn_op(block) == op_Block);
707 block->attr.block.dead = 1;
712 _is_Block_dead(const ir_node *block) {
713 ir_op * op = _get_irn_op(block);
718 assert(op == op_Block);
719 return block->attr.block.dead;
723 static INLINE tarval *_get_Const_tarval (ir_node *node) {
724 assert (_get_irn_op(node) == op_Const);
725 return node->attr.con.tv;
728 static INLINE cnst_classify_t _classify_Const(ir_node *node) {
730 assert(_is_ir_node(node));
732 op = _get_irn_op(node);
735 return classify_tarval(_get_Const_tarval(node));
736 else if(op == op_SymConst)
737 return CNST_SYMCONST;
739 return CNST_NO_CONST;
742 static INLINE int _is_irn_forking(const ir_node *node) {
743 return is_op_forking(_get_irn_op(node));
746 static INLINE ir_type *_get_irn_type(ir_node *node) {
747 return _get_irn_op(node)->ops.get_type(node);
750 static INLINE ir_type *_get_irn_type_attr(ir_node *node) {
751 return _get_irn_op(node)->ops.get_type_attr(node);
754 static INLINE entity *_get_irn_entity_attr(ir_node *node) {
755 return _get_irn_op(node)->ops.get_entity_attr(node);
758 static INLINE int _is_irn_constlike(const ir_node *node) {
759 return is_op_constlike(_get_irn_op(node));
762 static INLINE int _is_irn_keep(const ir_node *node) {
763 return is_op_keep(_get_irn_op(node));
766 static INLINE cond_jmp_predicate _get_Cond_jmp_pred(ir_node *node) {
767 assert (_get_irn_op(node) == op_Cond);
768 return node->attr.c.pred;
771 static INLINE void _set_Cond_jmp_pred(ir_node *node, cond_jmp_predicate pred) {
772 assert (_get_irn_op(node) == op_Cond);
773 node->attr.c.pred = pred;
776 /* this section MUST contain all inline functions */
777 #define is_ir_node(thing) _is_ir_node(thing)
778 #define get_irn_intra_arity(node) _get_irn_intra_arity(node)
779 #define get_irn_inter_arity(node) _get_irn_inter_arity(node)
780 #define get_irn_arity(node) _get_irn_arity(node)
781 #define get_irn_intra_n(node, n) _get_irn_intra_n(node, n)
782 #define get_irn_inter_n(node, n) _get_irn_inter_n(node, n)
783 #define get_irn_n(node, n) _get_irn_n(node, n)
784 #define get_irn_mode(node) _get_irn_mode(node)
785 #define set_irn_mode(node, mode) _set_irn_mode(node, mode)
786 #define get_irn_op(node) _get_irn_op(node)
787 #define get_irn_opcode(node) _get_irn_opcode(node)
788 #define get_irn_visited(node) _get_irn_visited(node)
789 #define set_irn_visited(node, v) _set_irn_visited(node, v)
790 #define mark_irn_visited(node) _mark_irn_visited(node)
791 #define irn_visited(node) _irn_visited(node)
792 #define irn_not_visited(node) _irn_not_visited(node)
793 #define set_irn_link(node, link) _set_irn_link(node, link)
794 #define get_irn_link(node) _get_irn_link(node)
795 #define get_irn_pinned(node) _get_irn_pinned(node)
796 #define is_irn_pinned_in_irg(node) _is_irn_pinned_in_irg(node)
797 #define is_unop(node) _is_unop(node)
798 #define is_binop(node) _is_binop(node)
799 #define is_Const(node) _is_Const(node)
800 #define is_Unknown(node) _is_Unknown(node)
801 #define is_Return(node) _is_Return(node)
802 #define is_Call(node) _is_Call(node)
803 #define is_Sel(node) _is_Sel(node)
804 #define is_Mux(node) _is_Mux(node)
805 #define is_Bad(node) _is_Bad(node)
806 #define is_no_Block(node) _is_no_Block(node)
807 #define is_Block(node) _is_Block(node)
808 #define get_Block_n_cfgpreds(node) _get_Block_n_cfgpreds(node)
809 #define get_Block_cfgpred(node, pos) _get_Block_cfgpred(node, pos)
810 #define get_Block_cfgpred_block(node, pos) _get_Block_cfgpred_block(node, pos)
811 #define get_Block_block_visited(node) _get_Block_block_visited(node)
812 #define set_Block_block_visited(node, visit) _set_Block_block_visited(node, visit)
813 #define mark_Block_block_visited(node) _mark_Block_block_visited(node)
814 #define Block_not_block_visited(node) _Block_not_block_visited(node)
815 #define set_Block_dead(block) _set_Block_dead(block)
816 #define is_Block_dead(block) _is_Block_dead(block)
817 #define get_Const_tarval(node) _get_Const_tarval(node)
818 #define classify_Const(node) _classify_Const(node)
819 #define is_irn_forking(node) _is_irn_forking(node)
820 #define get_irn_type(node) _get_irn_type(node)
821 #define get_irn_type_attr(node) _get_irn_type_attr(node)
822 #define get_irn_entity_attr(node) _get_irn_entity_attr(node)
823 #define is_irn_constlike(node) _is_irn_constlike(node)
824 #define is_irn_keep(node) _is_irn_keep(node)
825 #define get_Cond_jmp_pred(node) _get_Cond_jmp_pred(node)
826 #define set_Cond_jmp_pred(node, pred) _set_Cond_jmp_pred(node, pred)
828 # endif /* _IRNODE_T_H_ */