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.
17 * Declarations of an ir node.
19 * @author Martin Trapp, Christian Schaefer
32 # include "irgraph_t.h"
33 # include "irflag_t.h"
34 # include "firm_common_t.h"
35 # include "irdom_t.h" /* For size of struct dom_info. */
45 /** ir node attributes **/
47 /** Block attributes */
49 /* General attributes */
51 unsigned long block_visited; /**< for the walker that walks over all blocks. */
52 /* Attributes private to construction: */
53 int matured:1; /**< if set, all in-nodes of the block are fixed */
54 int dead:1; /**< if set, the block is dead (and could be replace by a Bad */
55 struct ir_node **graph_arr; /**< array to store all parameters */
56 /* Attributes holding analyses information */
57 struct dom_info dom; /**< Datastructure that holds information about dominators.
59 Eventually overlay with graph_arr as only valid
60 in different phases. Eventually inline the whole
62 /* exc_t exc; */ /**< role of this block for exception handling */
63 /* ir_node *handler_entry; */ /**< handler entry block iff this block is part of a region */
64 ir_node ** in_cg; /**< array with predecessors in
65 * interprocedural_view, if they differ
66 * from intraprocedural predecessors */
67 int *backedge; /**< Field n set to true if pred n is backedge.
68 @@@ @todo Ev. replace by bitfield! */
69 int *cg_backedge; /**< Field n set to true if pred n is interprocedural backedge.
70 @@@ @todo Ev. replace by bitfield! */
73 /** Start attributes */
76 /* ir_graph *irg; @@@ now in block */
79 /** Cond attributes */
81 cond_kind kind; /**< flavor of Cond */
82 long default_proj; /**< for optimization: biggest Proj number, i.e. the one
86 /** Const attributes */
88 tarval *tv; /**< the target value */
89 type *tp; /**< the source type, for analyses. default: type_unknown. */
93 symconst_symbol sym; // old tori
95 type *tp; /**< the source type, for analyses. default: type_unknown. */
100 entity *ent; /**< entity to select */
103 /** Exception attributes */
105 op_pin_state pin_state; /**< the pin state for operations that might generate a exception:
106 If it's know that no exception will be generated, could be set to
107 op_pin_state_floats. */
108 #if PRECISE_EXC_CONTEXT
109 struct ir_node **frag_arr; /**< For Phi node construction in case of exception */
114 except_attr exc; /**< the exception attribute. MUST be the first one. */
115 type *cld_tp; /**< type of called procedure */
116 entity ** callee_arr; /**< result of callee analysis */
119 /** Alloc attributes */
121 except_attr exc; /**< the exception attribute. MUST be the first one. */
122 type *type; /**< Type of the allocated object. */
123 where_alloc where; /**< stack, heap or other managed part of memory */
126 /** InstOf attributes */
133 /** Filter attributes */
135 long proj; /**< contains the result position to project (Proj) */
136 ir_node ** in_cg; /**< array with interprocedural predecessors (Phi) */
137 int *backedge; /**< Field n set to true if pred n is backedge.
138 @todo Ev. replace by bitfield! */
141 /** EndReg/EndExcept attributes */
144 /* ir_graph * irg; */ /**< ir_graph this node belongs to (for */
145 /* * navigating in interprocedural graphs) */
146 /* @@@ now in block */
149 /** CallBegin attributes */
151 /* ir_graph * irg; */ /**< ir_graph this node belongs to (for */
152 /* * navigating in interprocedural graphs) */
153 /* @@@ now in block */
154 ir_node * call; /**< associated Call-operation */
157 /** Cast attributes */
162 /** Load attributes */
164 except_attr exc; /**< the exception attribute. MUST be the first one. */
165 ir_mode *load_mode; /**< the mode of this Load operation */
166 ent_volatility volatility; /**< the volatility of a Load/Store operation */
169 /** Store attributes */
171 except_attr exc; /**< the exception attribute. MUST be the first one. */
172 ent_volatility volatility; /**< the volatility of a Store operation */
175 typedef pn_Cmp confirm_attr; /** Attribute to hold compare operation */
177 /** Some irnodes just have one attribute, these are stored here,
178 some have more. Their name is 'irnodename_attr' */
180 start_attr start; /**< For Start */
181 block_attr block; /**< For Block: Fields needed to construct it */
182 cond_attr c; /**< For Cond. */
183 const_attr con; /**< For Const: contains the value of the constant and a type */
184 symconst_attr i; /**< For SymConst. */
185 sel_attr s; /**< For Sel. */
186 call_attr call; /**< For Call: pointer to the type of the method to call */
187 callbegin_attr callbegin; /**< For CallBegin */
188 alloc_attr a; /**< For Alloc. */
189 io_attr io; /**< For InstOf */
190 type *f; /**< For Free. */
191 cast_attr cast; /**< For Cast. */
192 load_attr load; /**< For Load. */
193 store_attr store; /**< For Store. */
194 int phi0_pos; /**< For Phi. Used to remember the value defined by
195 this Phi node. Needed when the Phi is completed
196 to call get_r_internal_value to find the
197 predecessors. If this attribute is set, the Phi
198 node takes the role of the obsolete Phi0 node,
199 therefore the name. */
200 int *phi_backedge; /**< For Phi after construction.
201 Field n set to true if pred n is backedge.
202 @todo Ev. replace by bitfield! */
203 long proj; /**< For Proj: contains the result position to project */
204 confirm_attr confirm_cmp; /**< For Confirm: compare operation */
205 filter_attr filter; /**< For Filter */
206 end_attr end; /**< For EndReg, EndExcept */
207 except_attr except; /**< For Phi node construction in case of exceptions */
211 /** common structure of an irnode
212 if the node has some attributes, they are stored in attr */
214 /* ------- Basics of the representation ------- */
215 firm_kind kind; /**< distinguishes this node from others */
216 ir_op *op; /**< Opcode of this node. */
217 ir_mode *mode; /**< Mode of this node. */
218 unsigned long visited; /**< visited counter for walks of the graph */
219 struct ir_node **in; /**< array with predecessors / operands */
220 void *link; /**< to attach additional information to the node, e.g.
221 used while construction to link Phi0 nodes and
222 during optimization to link to nodes that
223 shall replace a node. */
224 /* ------- Fields for optimizations / analysis information ------- */
225 struct ir_node **out; /**< array of out edges */
226 struct dbg_info* dbi; /**< A pointer to information for debug support. */
227 /* ------- For debugging ------- */
229 int out_valid; /** < indicate that out edges are valid */
230 int node_nr; /**< a unique node number for each node to make output
233 /* ------- For analyses -------- */
234 ir_loop *loop; /**< the loop the node is in. Access routines in irloop.h */
235 #ifdef DO_HEAPANALYSIS
239 /* ------- Opcode depending fields -------- */
240 attr attr; /**< attribute of this node. Depends on opcode.
241 Must be last field of struct ir_node. */
245 /** Copies all attributes stored in the old node to the new node.
246 Assumes both have the same opcode and sufficient size. */
248 copy_attrs(const ir_node *old_node, ir_node *new_node);
251 /** Returns the array with the ins. The content of the array may not be
253 ir_node **get_irn_in (const ir_node *node);
256 /** access attributes directly */
257 INLINE const_attr get_irn_const_attr (ir_node *node);
258 INLINE long get_irn_proj_attr (ir_node *node);
259 INLINE alloc_attr get_irn_alloc_attr (ir_node *node);
260 INLINE type *get_irn_free_attr (ir_node *node);
261 INLINE symconst_attr get_irn_symconst_attr (ir_node *node);
262 type *get_irn_call_attr (ir_node *node);
263 type *get_irn_funccall_attr (ir_node *node);
264 sel_attr get_irn_sel_attr (ir_node *node);
265 int get_irn_phi_attr (ir_node *node);
266 block_attr get_irn_block_attr (ir_node *node);
267 load_attr get_irn_load_attr (ir_node *node);
268 store_attr get_irn_store_attr (ir_node *node);
269 except_attr get_irn_except_attr (ir_node *node);
272 /*-------------------------------------------------------------------*/
273 /* These function are most used in libfirm. Give them as static */
274 /* functions so they can be inlined. */
275 /*-------------------------------------------------------------------*/
278 * Checks whether a pointer points to a ir node.
279 * Intern version for libFirm.
282 __is_ir_node (const void *thing) {
283 return (get_kind(thing) == k_ir_node);
287 * Gets the op of a node.
288 * Intern version for libFirm.
290 static INLINE ir_op *
291 __get_irn_op (const ir_node *node) {
297 * Gets the opcode of a node.
298 * Intern version for libFirm.
301 __get_irn_opcode (const ir_node *node) {
302 assert (k_ir_node == get_kind(node));
304 return node->op->code;
308 * Returns the number of predecessors without the block predecessor.
309 * Intern version for libFirm.
312 __get_irn_intra_arity (const ir_node *node) {
314 return ARR_LEN(node->in) - 1;
318 * Returns the number of predecessors without the block predecessor.
319 * Intern version for libFirm.
322 __get_irn_inter_arity (const ir_node *node) {
324 if (__get_irn_opcode(node) == iro_Filter) {
325 assert(node->attr.filter.in_cg);
326 return ARR_LEN(node->attr.filter.in_cg) - 1;
327 } else if (__get_irn_opcode(node) == iro_Block && node->attr.block.in_cg) {
328 return ARR_LEN(node->attr.block.in_cg) - 1;
330 return __get_irn_intra_arity(node);
334 * Returns the number of predecessors without the block predecessor.
335 * Intern version for libFirm.
337 extern int (*__get_irn_arity)(const ir_node *node);
340 * Intern version for libFirm.
342 static INLINE ir_node *
343 __get_irn_intra_n (const ir_node *node, int n) {
344 assert(node); assert(-1 <= n && n < __get_irn_intra_arity(node));
346 return (node->in[n + 1] = skip_Id(node->in[n + 1]));
350 * Intern version for libFirm.
352 static INLINE ir_node*
353 __get_irn_inter_n (const ir_node *node, int n) {
354 assert(node); assert(-1 <= n && n < __get_irn_inter_arity(node));
356 /* handle Filter and Block specially */
357 if (__get_irn_opcode(node) == iro_Filter) {
358 assert(node->attr.filter.in_cg);
359 return (node->attr.filter.in_cg[n + 1] = skip_Id(node->attr.filter.in_cg[n + 1]));
360 } else if (__get_irn_opcode(node) == iro_Block && node->attr.block.in_cg) {
361 return (node->attr.block.in_cg[n + 1] = skip_Id(node->attr.block.in_cg[n + 1]));
364 return __get_irn_intra_n (node, n);
368 * Access to the predecessors of a node.
369 * To iterate over the operands iterate from 0 to i < get_irn_arity(),
370 * to iterate including the Block predecessor iterate from i = -1 to
372 * If it is a block, the entry -1 is NULL.
373 * Intern version for libFirm.
375 extern ir_node *(*__get_irn_n)(const ir_node *node, int n);
378 * Gets the mode of a node.
379 * Intern version for libFirm.
381 static INLINE ir_mode *
382 __get_irn_mode (const ir_node *node)
389 * Sets the mode of a node.
390 * Intern version of libFirm.
393 __set_irn_mode (ir_node *node, ir_mode *mode)
400 * Gets the visited counter of a node.
401 * Intern version for libFirm.
403 static INLINE unsigned long
404 __get_irn_visited (const ir_node *node)
407 return node->visited;
411 * Sets the visited counter of a node.
412 * Intern version for libFirm.
415 __set_irn_visited (ir_node *node, unsigned long visited)
418 node->visited = visited;
422 * Mark a node as visited in a graph.
423 * Intern version for libFirm.
426 __mark_irn_visited (ir_node *node) {
428 node->visited = current_ir_graph->visited;
432 * Returns non-zero if a node of was visited.
433 * Intern version for libFirm.
436 __irn_visited(const ir_node *node) {
438 return (node->visited >= current_ir_graph->visited);
442 * Returns non-zero if a node of was NOT visited.
443 * Intern version for libFirm.
446 __irn_not_visited(const ir_node *node) {
448 return (node->visited < current_ir_graph->visited);
452 * Sets the link of a node.
453 * Intern version of libFirm.
456 __set_irn_link(ir_node *node, void *link) {
458 /* Link field is used for Phi construction and various optimizations
460 assert(get_irg_phase_state(current_ir_graph) != phase_building);
466 * Returns the link of a node.
467 * Intern version of libFirm.
470 __get_irn_link(const ir_node *node) {
476 * Returns the pinned state of a node.
477 * Intern version of libFirm.
479 static INLINE op_pin_state
480 __get_irn_pinned(const ir_node *node) {
481 op_pin_state state = __get_op_pinned(__get_irn_op(node));
482 if (state >= op_pin_state_exc_pinned)
483 return get_opt_fragile_ops() ? node->attr.except.pin_state : op_pin_state_pinned;
488 __is_unop(const ir_node *node) {
489 return (node->op->opar == oparity_unary);
493 __is_binop(const ir_node *node) {
494 return (node->op->opar == oparity_binary);
498 __is_Bad(const ir_node *node) {
500 return (node && __get_irn_op(node) == op_Bad);
504 __is_no_Block(const ir_node *node) {
506 return (__get_irn_op(node) != op_Block);
510 __is_Block(const ir_node *node) {
512 return (__get_irn_op(node) == op_Block);
515 static INLINE ir_node *
516 __set_Block_dead(ir_node *block) {
517 assert(__get_irn_op(block) == op_Block);
518 block->attr.block.dead = 1;
523 __is_Block_dead(const ir_node *block) {
524 ir_op * op = __get_irn_op(block);
529 assert(op == op_Block);
530 return block->attr.block.dead;
534 /* this section MUST contain all inline functions */
535 #define is_ir_node(thing) __is_ir_node(thing)
536 #define get_irn_intra_arity(node) __get_irn_intra_arity(node)
537 #define get_irn_inter_arity(node) __get_irn_inter_arity(node)
538 #define get_irn_arity(node) __get_irn_arity(node)
539 #define get_irn_intra_n(node, n) __get_irn_intra_n(node, n)
540 #define get_irn_inter_n(node, n) __get_irn_inter_n(node, n)
541 #define get_irn_n(node, n) __get_irn_n(node, n)
542 #define get_irn_mode(node) __get_irn_mode(node)
543 #define set_irn_mode(node, mode) __set_irn_mode(node, mode)
544 #define get_irn_op(node) __get_irn_op(node)
545 #define get_irn_opcode(node) __get_irn_opcode(node)
546 #define get_irn_visited(node) __get_irn_visited(node)
547 #define set_irn_visited(node, v) __set_irn_visited(node, v)
548 #define mark_irn_visited(node) __mark_irn_visited(node)
549 #define irn_visited(node) __irn_visited(node)
550 #define irn_not_visited(node) __irn_not_visited(node)
551 #define set_irn_link(node, link) __set_irn_link(node, link)
552 #define get_irn_link(node) __get_irn_link(node)
553 #define is_unop(node) __is_unop(node)
554 #define is_binop(node) __is_binop(node)
555 #define is_Bad(node) __is_Bad(node)
556 #define is_no_Block(node) __is_no_Block(node)
557 #define is_Block(node) __is_Block(node)
558 #define set_Block_dead(block) __set_Block_dead(block)
559 #define is_Block_dead(block) __is_Block_dead(block)
561 # endif /* _IRNODE_T_H_ */