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. */
44 /** ir node attributes **/
46 /** Block attributes */
48 /* General attributes */
50 unsigned long block_visited; /**< for the walker that walks over all blocks. */
51 /* Attributes private to construction: */
52 bool matured; /**< if set, all in-nodes of the block are fixed */
53 struct ir_node **graph_arr; /**< array to store all parameters */
54 /* Attributes holding analyses information */
55 struct 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 /* exc_t exc; */ /**< role of this block for exception handling */
61 /* ir_node *handler_entry; */ /**< handler entry block iff this block is part of a region */
62 ir_node ** in_cg; /**< array with predecessors in
63 * interprocedural_view, if they differ
64 * from intraprocedural predecessors */
65 int *backedge; /**< Field n set to true if pred n is backedge.
66 @@@ @todo Ev. replace by bitfield! */
67 int *cg_backedge; /**< Field n set to true if pred n is interprocedural backedge.
68 @@@ @todo Ev. replace by bitfield! */
71 /** Start attributes */
74 /* ir_graph *irg; @@@ now in block */
77 /** Cond attributes */
79 cond_kind kind; /**< flavor of Cond */
80 long default_proj; /**< for optimization: biggest Proj number, i.e. the one
84 /** Const attributes */
86 tarval *tv; /**< the target value */
87 type *tp; /**< the source type, for analyses. default: type_unknown. */
91 symconst_symbol sym; // old tori
93 type *tp; /**< the source type, for analyses. default: type_unknown. */
98 entity *ent; /**< entity to select */
101 /** Exception attributes */
103 op_pin_state pin_state; /**< the pin state for operations that might generate a exception:
104 If it's know that no exception will be generated, could be set to
105 op_pin_state_floats. */
106 #if PRECISE_EXC_CONTEXT
107 struct ir_node **frag_arr; /**< For Phi node construction in case of exception */
112 except_attr exc; /**< the exception attribute. MUST be the first one. */
113 type *cld_tp; /**< type of called procedure */
114 entity ** callee_arr; /**< result of callee analysis */
117 /** Alloc attributes */
119 except_attr exc; /**< the exception attribute. MUST be the first one. */
120 type *type; /**< Type of the allocated object. */
121 where_alloc where; /**< stack, heap or other managed part of memory */
124 /** InstOf attributes */
131 /** Filter attributes */
133 long proj; /**< contains the result position to project (Proj) */
134 ir_node ** in_cg; /**< array with interprocedural predecessors (Phi) */
135 int *backedge; /**< Field n set to true if pred n is backedge.
136 @todo Ev. replace by bitfield! */
139 /** EndReg/EndExcept attributes */
142 /* ir_graph * irg; */ /**< ir_graph this node belongs to (for */
143 /* * navigating in interprocedural graphs) */
144 /* @@@ now in block */
147 /** CallBegin attributes */
149 /* ir_graph * irg; */ /**< ir_graph this node belongs to (for */
150 /* * navigating in interprocedural graphs) */
151 /* @@@ now in block */
152 ir_node * call; /**< associated Call-operation */
155 /** Cast attributes */
160 /** Load attributes */
162 except_attr exc; /**< the exception attribute. MUST be the first one. */
163 ir_mode *load_mode; /**< the mode of this Load operation */
164 ent_volatility volatility; /**< the volatility of a Load/Store operation */
167 /** Store attributes */
169 except_attr exc; /**< the exception attribute. MUST be the first one. */
170 ent_volatility volatility; /**< the volatility of a Store operation */
173 typedef pn_Cmp confirm_attr; /** Attribute to hold compare operation */
175 /** Some irnodes just have one attribute, these are stored here,
176 some have more. Their name is 'irnodename_attr' */
178 start_attr start; /**< For Start */
179 block_attr block; /**< For Block: Fields needed to construct it */
180 cond_attr c; /**< For Cond. */
181 const_attr con; /**< For Const: contains the value of the constant and a type */
182 symconst_attr i; /**< For SymConst. */
183 sel_attr s; /**< For Sel. */
184 call_attr call; /**< For Call: pointer to the type of the method to call */
185 callbegin_attr callbegin; /**< For CallBegin */
186 alloc_attr a; /**< For Alloc. */
187 io_attr io; /**< For InstOf */
188 type *f; /**< For Free. */
189 cast_attr cast; /**< For Cast. */
190 load_attr load; /**< For Load. */
191 store_attr store; /**< For Store. */
192 int phi0_pos; /**< For Phi. Used to remember the value defined by
193 this Phi node. Needed when the Phi is completed
194 to call get_r_internal_value to find the
195 predecessors. If this attribute is set, the Phi
196 node takes the role of the obsolete Phi0 node,
197 therefore the name. */
198 int *phi_backedge; /**< For Phi after construction.
199 Field n set to true if pred n is backedge.
200 @todo Ev. replace by bitfield! */
201 long proj; /**< For Proj: contains the result position to project */
202 confirm_attr confirm_cmp; /**< For Confirm: compare operation */
203 filter_attr filter; /**< For Filter */
204 end_attr end; /**< For EndReg, EndExcept */
205 except_attr except; /**< For Phi node construction in case of exceptions */
209 /** common structure of an irnode
210 if the node has some attributes, they are stored in attr */
212 /* ------- Basics of the representation ------- */
213 firm_kind kind; /**< distinguishes this node from others */
214 ir_op *op; /**< Opcode of this node. */
215 ir_mode *mode; /**< Mode of this node. */
216 unsigned long visited; /**< visited counter for walks of the graph */
217 struct ir_node **in; /**< array with predecessors / operands */
218 void *link; /**< to attach additional information to the node, e.g.
219 used while construction to link Phi0 nodes and
220 during optimization to link to nodes that
221 shall replace a node. */
222 /* ------- Fields for optimizations / analysis information ------- */
223 struct ir_node **out; /**< array of out edges */
224 struct dbg_info* dbi; /**< A pointer to information for debug support. */
225 /* ------- For debugging ------- */
227 int out_valid; /** < indicate that out edges are valid */
228 int node_nr; /**< a unique node number for each node to make output
231 /* ------- For analyses -------- */
232 ir_loop *loop; /**< the loop the node is in. Access routines in irloop.h */
233 #ifdef DO_HEAPANALYSIS
237 /* ------- Opcode depending fields -------- */
238 attr attr; /**< attribute of this node. Depends on opcode.
239 Must be last field of struct ir_node. */
243 /** Copies all attributes stored in the old node to the new node.
244 Assumes both have the same opcode and sufficient size. */
246 copy_attrs(const ir_node *old_node, ir_node *new_node);
249 /** Returns the array with the ins. The content of the array may not be
251 ir_node **get_irn_in (const ir_node *node);
254 /** access attributes directly */
255 INLINE const_attr get_irn_const_attr (ir_node *node);
256 INLINE long get_irn_proj_attr (ir_node *node);
257 INLINE alloc_attr get_irn_alloc_attr (ir_node *node);
258 INLINE type *get_irn_free_attr (ir_node *node);
259 INLINE symconst_attr get_irn_symconst_attr (ir_node *node);
260 type *get_irn_call_attr (ir_node *node);
261 type *get_irn_funccall_attr (ir_node *node);
262 sel_attr get_irn_sel_attr (ir_node *node);
263 int get_irn_phi_attr (ir_node *node);
264 block_attr get_irn_block_attr (ir_node *node);
265 load_attr get_irn_load_attr (ir_node *node);
266 store_attr get_irn_store_attr (ir_node *node);
267 except_attr get_irn_except_attr (ir_node *node);
270 /*-------------------------------------------------------------------*/
271 /* These function are most used in libfirm. Give them as static */
272 /* functions so they can be inlined. */
273 /*-------------------------------------------------------------------*/
276 * Checks whether a pointer points to a ir node.
277 * Intern version for libFirm.
280 __is_ir_node (const void *thing) {
281 return (get_kind(thing) == k_ir_node);
285 * Gets the op of a node.
286 * Intern version for libFirm.
288 static INLINE ir_op *
289 __get_irn_op (const ir_node *node)
296 * Gets the opcode of a node.
297 * Intern version for libFirm.
300 __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 (ir_node *node, int n) {
344 assert(node); assert(-1 <= n && n < __get_irn_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 (ir_node *node, int n) {
354 assert(node); assert(-1 <= n && n < __get_irn_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)(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;
487 /* this section MUST contain all inline functions */
488 #define is_ir_node(thing) __is_ir_node(thing)
489 #define get_irn_intra_arity(node) __get_irn_intra_arity(node)
490 #define get_irn_inter_arity(node) __get_irn_inter_arity(node)
491 #define get_irn_arity(node) __get_irn_arity(node)
492 #define get_irn_intra_n(node, n) __get_irn_intra_n(node, n)
493 #define get_irn_inter_n(node, n) __get_irn_inter_n(node, n)
494 #define get_irn_n(node, n) __get_irn_n(node, n)
495 #define get_irn_mode(node) __get_irn_mode(node)
496 #define set_irn_mode(node, mode) __set_irn_mode(node, mode)
497 #define get_irn_op(node) __get_irn_op(node)
498 #define get_irn_opcode(node) __get_irn_opcode(node)
499 #define get_irn_visited(node) __get_irn_visited(node)
500 #define set_irn_visited(node, v) __set_irn_visited(node, v)
501 #define mark_irn_visited(node) __mark_irn_visited(node)
502 #define irn_visited(node) __irn_visited(node)
503 #define irn_not_visited(node) __irn_not_visited(node)
504 #define set_irn_link(node, link) __set_irn_link(node, link)
505 #define get_irn_link(node) __get_irn_link(node)
507 # endif /* _IRNODE_T_H_ */