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 /** ir node attributes **/
42 /** Block attributes */
44 /* General attributes */
46 unsigned long block_visited; /**< for the walker that walks over all blocks. */
47 /* Attributes private to construction: */
48 int matured:1; /**< if set, all in-nodes of the block are fixed */
49 int dead:1; /**< if set, the block is dead (and could be replace by a Bad */
50 struct ir_node **graph_arr; /**< array to store all parameters */
51 /* Attributes holding analyses information */
52 struct dom_info dom; /**< Datastructure that holds information about dominators.
54 Eventually overlay with graph_arr as only valid
55 in different phases. Eventually inline the whole
57 /* exc_t exc; */ /**< role of this block for exception handling */
58 /* ir_node *handler_entry; */ /**< handler entry block iff this block is part of a region */
59 ir_node ** in_cg; /**< array with predecessors in
60 * interprocedural_view, if they differ
61 * from intraprocedural predecessors */
62 int *backedge; /**< Field n set to true if pred n is backedge.
63 @@@ @todo Ev. replace by bitfield! */
64 int *cg_backedge; /**< Field n set to true if pred n is interprocedural backedge.
65 @@@ @todo Ev. replace by bitfield! */
68 /** Start attributes */
71 /* ir_graph *irg; @@@ now in block */
74 /** Cond attributes */
76 cond_kind kind; /**< flavor of Cond */
77 long default_proj; /**< for optimization: biggest Proj number, i.e. the one
81 /** Const attributes */
83 tarval *tv; /**< the target value */
84 type *tp; /**< the source type, for analyses. default: type_unknown. */
88 symconst_symbol sym; // old tori
90 type *tp; /**< the source type, for analyses. default: type_unknown. */
95 entity *ent; /**< entity to select */
98 /** Exception attributes */
100 op_pin_state pin_state; /**< the pin state for operations that might generate a exception:
101 If it's know that no exception will be generated, could be set to
102 op_pin_state_floats. */
103 #if PRECISE_EXC_CONTEXT
104 struct ir_node **frag_arr; /**< For Phi node construction in case of exception */
109 except_attr exc; /**< the exception attribute. MUST be the first one. */
110 type *cld_tp; /**< type of called procedure */
111 entity ** callee_arr; /**< result of callee analysis */
114 /** Alloc attributes */
116 except_attr exc; /**< the exception attribute. MUST be the first one. */
117 type *type; /**< Type of the allocated object. */
118 where_alloc where; /**< stack, heap or other managed part of memory */
121 /** Free attributes */
123 type *type; /**< Type of the allocated object. */
124 where_alloc where; /**< stack, heap or other managed part of memory */
127 /** InstOf attributes */
134 /** Filter attributes */
136 long proj; /**< contains the result position to project (Proj) */
137 ir_node ** in_cg; /**< array with interprocedural predecessors (Phi) */
138 int *backedge; /**< Field n set to true if pred n is backedge.
139 @todo Ev. replace by bitfield! */
142 /** EndReg/EndExcept attributes */
147 /** CallBegin attributes */
149 ir_node * call; /**< associated Call-operation */
152 /** Cast attributes */
157 /** Load attributes */
159 except_attr exc; /**< the exception attribute. MUST be the first one. */
160 ir_mode *load_mode; /**< the mode of this Load operation */
161 ent_volatility volatility; /**< the volatility of a Load/Store operation */
164 /** Store attributes */
166 except_attr exc; /**< the exception attribute. MUST be the first one. */
167 ent_volatility volatility; /**< the volatility of a Store operation */
170 typedef pn_Cmp confirm_attr; /** Attribute to hold compare operation */
172 /** Some irnodes just have one attribute, these are stored here,
173 some have more. Their name is 'irnodename_attr' */
175 start_attr start; /**< For Start */
176 block_attr block; /**< For Block: Fields needed to construct it */
177 cond_attr c; /**< For Cond. */
178 const_attr con; /**< For Const: contains the value of the constant and a type */
179 symconst_attr i; /**< For SymConst. */
180 sel_attr s; /**< For Sel. */
181 call_attr call; /**< For Call: pointer to the type of the method to call */
182 callbegin_attr callbegin; /**< For CallBegin */
183 alloc_attr a; /**< For Alloc. */
184 free_attr f; /**< For Free. */
185 io_attr io; /**< For InstOf */
186 cast_attr cast; /**< For Cast. */
187 load_attr load; /**< For Load. */
188 store_attr store; /**< For Store. */
189 int phi0_pos; /**< For Phi. Used to remember the value defined by
190 this Phi node. Needed when the Phi is completed
191 to call get_r_internal_value to find the
192 predecessors. If this attribute is set, the Phi
193 node takes the role of the obsolete Phi0 node,
194 therefore the name. */
195 int *phi_backedge; /**< For Phi after construction.
196 Field n set to true if pred n is backedge.
197 @todo Ev. replace by bitfield! */
198 long proj; /**< For Proj: contains the result position to project */
199 confirm_attr confirm_cmp; /**< For Confirm: compare operation */
200 filter_attr filter; /**< For Filter */
201 end_attr end; /**< For EndReg, EndExcept */
202 except_attr except; /**< For Phi node construction in case of exceptions */
206 /** common structure of an irnode
207 if the node has some attributes, they are stored in attr */
209 /* ------- Basics of the representation ------- */
210 firm_kind kind; /**< distinguishes this node from others */
211 ir_op *op; /**< Opcode of this node. */
212 ir_mode *mode; /**< Mode of this node. */
213 unsigned long visited; /**< visited counter for walks of the graph */
214 struct ir_node **in; /**< array with predecessors / operands */
215 void *link; /**< to attach additional information to the node, e.g.
216 used while construction to link Phi0 nodes and
217 during optimization to link to nodes that
218 shall replace a node. */
219 /* ------- Fields for optimizations / analysis information ------- */
220 struct ir_node **out; /**< array of out edges */
221 struct dbg_info* dbi; /**< A pointer to information for debug support. */
222 /* ------- For debugging ------- */
224 int out_valid; /** < indicate that out edges are valid */
225 int node_nr; /**< a unique node number for each node to make output
228 /* ------- For analyses -------- */
229 ir_loop *loop; /**< the loop the node is in. Access routines in irloop.h */
230 #ifdef DO_HEAPANALYSIS
234 /* ------- Opcode depending fields -------- */
235 attr attr; /**< attribute of this node. Depends on opcode.
236 Must be last field of struct ir_node. */
240 /** Returns the array with the ins. The content of the array may not be
242 ir_node **get_irn_in (const ir_node *node);
245 /** access attributes directly */
246 const_attr get_irn_const_attr (ir_node *node);
247 long get_irn_proj_attr (ir_node *node);
248 alloc_attr get_irn_alloc_attr (ir_node *node);
249 free_attr get_irn_free_attr (ir_node *node);
250 symconst_attr get_irn_symconst_attr (ir_node *node);
251 type *get_irn_call_attr (ir_node *node);
252 type *get_irn_funccall_attr (ir_node *node);
253 sel_attr get_irn_sel_attr (ir_node *node);
254 int get_irn_phi_attr (ir_node *node);
255 block_attr get_irn_block_attr (ir_node *node);
256 load_attr get_irn_load_attr (ir_node *node);
257 store_attr get_irn_store_attr (ir_node *node);
258 except_attr get_irn_except_attr (ir_node *node);
262 * The amount of additional space for custom data to be allocated upon creating a new node.
264 extern unsigned firm_add_node_size;
266 /*-------------------------------------------------------------------*/
267 /* These function are most used in libfirm. Give them as static */
268 /* functions so they can be inlined. */
269 /*-------------------------------------------------------------------*/
272 * Checks whether a pointer points to a ir node.
273 * Intern version for libFirm.
276 _is_ir_node (const void *thing) {
277 return (get_kind(thing) == k_ir_node);
281 * Gets the op of a node.
282 * Intern version for libFirm.
284 static INLINE ir_op *
285 _get_irn_op (const ir_node *node) {
290 /** Copies all attributes stored in the old node to the new node.
291 Assumes both have the same opcode and sufficient size. */
293 copy_node_attr(const ir_node *old_node, ir_node *new_node) {
294 ir_op *op = _get_irn_op(old_node);
296 /* must always exist */
297 op->copy_attr(old_node, new_node);
301 * Gets the opcode of a node.
302 * Intern version for libFirm.
305 _get_irn_opcode (const ir_node *node) {
306 assert (k_ir_node == get_kind(node));
308 return node->op->code;
312 * Returns the number of predecessors without the block predecessor.
313 * Intern version for libFirm.
316 _get_irn_intra_arity (const ir_node *node) {
318 return ARR_LEN(node->in) - 1;
322 * Returns the number of predecessors without the block predecessor.
323 * Intern version for libFirm.
326 _get_irn_inter_arity (const ir_node *node) {
328 if (_get_irn_opcode(node) == iro_Filter) {
329 assert(node->attr.filter.in_cg);
330 return ARR_LEN(node->attr.filter.in_cg) - 1;
331 } else if (_get_irn_opcode(node) == iro_Block && node->attr.block.in_cg) {
332 return ARR_LEN(node->attr.block.in_cg) - 1;
334 return _get_irn_intra_arity(node);
338 * Returns the number of predecessors without the block predecessor.
339 * Intern version for libFirm.
341 extern int (*_get_irn_arity)(const ir_node *node);
344 * Intern version for libFirm.
346 static INLINE ir_node *
347 _get_irn_intra_n (const ir_node *node, int n) {
348 assert(node); assert(-1 <= n && n < _get_irn_intra_arity(node));
350 return (node->in[n + 1] = skip_Id(node->in[n + 1]));
354 * Intern version for libFirm.
356 static INLINE ir_node*
357 _get_irn_inter_n (const ir_node *node, int n) {
358 assert(node); assert(-1 <= n && n < _get_irn_inter_arity(node));
360 /* handle Filter and Block specially */
361 if (_get_irn_opcode(node) == iro_Filter) {
362 assert(node->attr.filter.in_cg);
363 return (node->attr.filter.in_cg[n + 1] = skip_Id(node->attr.filter.in_cg[n + 1]));
364 } else if (_get_irn_opcode(node) == iro_Block && node->attr.block.in_cg) {
365 return (node->attr.block.in_cg[n + 1] = skip_Id(node->attr.block.in_cg[n + 1]));
368 return _get_irn_intra_n (node, n);
372 * Access to the predecessors of a node.
373 * To iterate over the operands iterate from 0 to i < get_irn_arity(),
374 * to iterate including the Block predecessor iterate from i = -1 to
376 * If it is a block, the entry -1 is NULL.
377 * Intern version for libFirm.
379 extern ir_node *(*_get_irn_n)(const ir_node *node, int n);
382 * Gets the mode of a node.
383 * Intern version for libFirm.
385 static INLINE ir_mode *
386 _get_irn_mode (const ir_node *node)
393 * Sets the mode of a node.
394 * Intern version of libFirm.
397 _set_irn_mode (ir_node *node, ir_mode *mode)
404 * Gets the visited counter of a node.
405 * Intern version for libFirm.
407 static INLINE unsigned long
408 _get_irn_visited (const ir_node *node)
411 return node->visited;
415 * Sets the visited counter of a node.
416 * Intern version for libFirm.
419 _set_irn_visited (ir_node *node, unsigned long visited)
422 node->visited = visited;
426 * Mark a node as visited in a graph.
427 * Intern version for libFirm.
430 _mark_irn_visited (ir_node *node) {
432 node->visited = current_ir_graph->visited;
436 * Returns non-zero if a node of was visited.
437 * Intern version for libFirm.
440 _irn_visited(const ir_node *node) {
442 return (node->visited >= current_ir_graph->visited);
446 * Returns non-zero if a node of was NOT visited.
447 * Intern version for libFirm.
450 _irn_not_visited(const ir_node *node) {
452 return (node->visited < current_ir_graph->visited);
456 * Sets the link of a node.
457 * Intern version of libFirm.
460 _set_irn_link(ir_node *node, void *link) {
462 /* Link field is used for Phi construction and various optimizations
464 assert(get_irg_phase_state(current_ir_graph) != phase_building);
470 * Returns the link of a node.
471 * Intern version of libFirm.
474 _get_irn_link(const ir_node *node) {
475 assert (node && _is_ir_node(node));
480 * Returns the pinned state of a node.
481 * Intern version of libFirm.
483 static INLINE op_pin_state
484 _get_irn_pinned(const ir_node *node) {
486 assert(node && _is_ir_node(node));
487 state = __get_op_pinned(_get_irn_op(node));
488 if (state >= op_pin_state_exc_pinned)
489 return get_opt_fragile_ops() ? node->attr.except.pin_state : op_pin_state_pinned;
494 _is_unop(const ir_node *node) {
495 assert(node && _is_ir_node(node));
496 return (node->op->opar == oparity_unary);
500 _is_binop(const ir_node *node) {
501 assert(node && _is_ir_node(node));
502 return (node->op->opar == oparity_binary);
506 _is_Bad(const ir_node *node) {
508 return (node && _get_irn_op(node) == op_Bad);
512 _is_no_Block(const ir_node *node) {
513 assert(node && _is_ir_node(node));
514 return (_get_irn_op(node) != op_Block);
518 _is_Block(const ir_node *node) {
519 assert(node && _is_ir_node(node));
520 return (_get_irn_op(node) == op_Block);
523 static INLINE ir_node *
524 _set_Block_dead(ir_node *block) {
525 assert(_get_irn_op(block) == op_Block);
526 block->attr.block.dead = 1;
531 _is_Block_dead(const ir_node *block) {
532 ir_op * op = _get_irn_op(block);
537 assert(op == op_Block);
538 return block->attr.block.dead;
542 /* this section MUST contain all inline functions */
543 #define is_ir_node(thing) _is_ir_node(thing)
544 #define get_irn_intra_arity(node) _get_irn_intra_arity(node)
545 #define get_irn_inter_arity(node) _get_irn_inter_arity(node)
546 #define get_irn_arity(node) _get_irn_arity(node)
547 #define get_irn_intra_n(node, n) _get_irn_intra_n(node, n)
548 #define get_irn_inter_n(node, n) _get_irn_inter_n(node, n)
549 #define get_irn_n(node, n) _get_irn_n(node, n)
550 #define get_irn_mode(node) _get_irn_mode(node)
551 #define set_irn_mode(node, mode) _set_irn_mode(node, mode)
552 #define get_irn_op(node) _get_irn_op(node)
553 #define get_irn_opcode(node) _get_irn_opcode(node)
554 #define get_irn_visited(node) _get_irn_visited(node)
555 #define set_irn_visited(node, v) _set_irn_visited(node, v)
556 #define mark_irn_visited(node) _mark_irn_visited(node)
557 #define irn_visited(node) _irn_visited(node)
558 #define irn_not_visited(node) _irn_not_visited(node)
559 #define set_irn_link(node, link) _set_irn_link(node, link)
560 #define get_irn_link(node) _get_irn_link(node)
561 #define is_unop(node) _is_unop(node)
562 #define is_binop(node) _is_binop(node)
563 #define is_Bad(node) _is_Bad(node)
564 #define is_no_Block(node) _is_no_Block(node)
565 #define is_Block(node) _is_Block(node)
566 #define set_Block_dead(block) _set_Block_dead(block)
567 #define is_Block_dead(block) _is_Block_dead(block)
569 # endif /* _IRNODE_T_H_ */