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 */
102 type *cld_tp; /**< type of called procedure */
103 #if PRECISE_EXC_CONTEXT
104 struct ir_node **frag_arr; /**< For Phi node construction in case of exceptions */
106 entity ** callee_arr; /**< result of callee analysis */
109 /** Alloc attributes */
111 type *type; /**< Type of the allocated object. */
112 where_alloc where; /**< stack, heap or other managed part of memory */
113 #if PRECISE_EXC_CONTEXT
114 struct ir_node **frag_arr; /**< For Phi node construction in case of exceptions */
118 /** InstOf attributes */
125 /** Filter attributes */
127 long proj; /**< contains the result position to project (Proj) */
128 ir_node ** in_cg; /**< array with interprocedural predecessors (Phi) */
129 int *backedge; /**< Field n set to true if pred n is backedge.
130 @todo Ev. replace by bitfield! */
133 /** EndReg/EndExcept attributes */
136 /* ir_graph * irg; */ /**< ir_graph this node belongs to (for */
137 /* * navigating in interprocedural graphs) */
138 /* @@@ now in block */
141 /** CallBegin attributes */
143 /* ir_graph * irg; */ /**< ir_graph this node belongs to (for */
144 /* * navigating in interprocedural graphs) */
145 /* @@@ now in block */
146 ir_node * call; /**< associated Call-operation */
149 /** Cast attributes */
154 /** Load attributes */
156 ir_mode *load_mode; /**< the mode of this Load operation */
157 ent_volatility volatility; /**< the volatility of a Load/Store operation */
158 #if PRECISE_EXC_CONTEXT
159 struct ir_node **frag_arr; /**< For Phi node construction in case of exception */
163 /** Store attributes */
165 ent_volatility volatility; /**< the volatility of a Store operation */
166 #if PRECISE_EXC_CONTEXT
167 struct ir_node **frag_arr; /**< For Phi node construction in case of exception */
171 /** Exception attributes */
173 struct ir_node **frag_arr; /**< For Phi node construction in case of exception */
176 typedef pn_Cmp confirm_attr; /** Attribute to hold compare operation */
178 /** Some irnodes just have one attribute, these are stored here,
179 some have more. Their name is 'irnodename_attr' */
181 start_attr start; /**< For Start */
182 block_attr block; /**< For Block: Fields needed to construct it */
183 cond_attr c; /**< For Cond. */
184 const_attr con; /**< For Const: contains the value of the constant and a type */
185 symconst_attr i; /**< For SymConst. */
186 sel_attr s; /**< For Sel. */
187 call_attr call; /**< For Call: pointer to the type of the method to call */
188 callbegin_attr callbegin; /**< For CallBegin */
189 alloc_attr a; /**< For Alloc. */
190 io_attr io; /**< For InstOf */
191 type *f; /**< For Free. */
192 cast_attr cast; /**< For Cast. */
193 load_attr load; /**< For Load. */
194 store_attr store; /**< For Store. */
195 int phi0_pos; /**< For Phi. Used to remember the value defined by
196 this Phi node. Needed when the Phi is completed
197 to call get_r_internal_value to find the
198 predecessors. If this attribute is set, the Phi
199 node takes the role of the obsolete Phi0 node,
200 therefore the name. */
201 int *phi_backedge; /**< For Phi after construction.
202 Field n set to true if pred n is backedge.
203 @todo Ev. replace by bitfield! */
204 long proj; /**< For Proj: contains the result position to project */
205 confirm_attr confirm_cmp; /**< For Confirm: compare operation */
206 filter_attr filter; /**< For Filter */
207 end_attr end; /**< For EndReg, EndExcept */
208 #if PRECISE_EXC_CONTEXT
209 except_attr except; /**< For Phi node construction in case of exceptions */
214 /** common structure of an irnode
215 if the node has some attributes, they are stored in attr */
217 /* ------- Basics of the representation ------- */
218 firm_kind kind; /**< distinguishes this node from others */
219 ir_op *op; /**< Opcode of this node. */
220 ir_mode *mode; /**< Mode of this node. */
221 unsigned long visited; /**< visited counter for walks of the graph */
222 struct ir_node **in; /**< array with predecessors / operands */
223 void *link; /**< to attach additional information to the node, e.g.
224 used while construction to link Phi0 nodes and
225 during optimization to link to nodes that
226 shall replace a node. */
227 /* ------- Fields for optimizations / analysis information ------- */
228 struct ir_node **out; /**< array of out edges */
229 struct dbg_info* dbi; /**< A pointer to information for debug support. */
230 /* ------- For debugging ------- */
232 int out_valid; /** < indicate that out edges are valid */
233 int node_nr; /**< a unique node number for each node to make output
236 /* ------- For analyses -------- */
237 ir_loop *loop; /**< the loop the node is in. Access routines in irloop.h */
238 #ifdef DO_HEAPANALYSIS
242 /* ------- Opcode depending fields -------- */
243 attr attr; /**< attribute of this node. Depends on opcode.
244 Must be last field of struct ir_node. */
248 /** Copies all attributes stored in the old node to the new node.
249 Assumes both have the same opcode and sufficient size. */
251 copy_attrs(const ir_node *old_node, ir_node *new_node);
254 /** Returns the array with the ins. The content of the array may not be
256 ir_node **get_irn_in (const ir_node *node);
259 /** access attributes directly */
260 INLINE const_attr get_irn_const_attr (ir_node *node);
261 INLINE long get_irn_proj_attr (ir_node *node);
262 INLINE alloc_attr get_irn_alloc_attr (ir_node *node);
263 INLINE type *get_irn_free_attr (ir_node *node);
264 INLINE symconst_attr get_irn_symconst_attr (ir_node *node);
265 type *get_irn_call_attr (ir_node *node);
266 type *get_irn_funccall_attr (ir_node *node);
267 sel_attr get_irn_sel_attr (ir_node *node);
268 int get_irn_phi_attr (ir_node *node);
269 block_attr get_irn_block_attr (ir_node *node);
270 load_attr get_irn_load_attr (ir_node *node);
271 store_attr get_irn_store_attr (ir_node *node);
272 except_attr get_irn_except_attr (ir_node *node);
275 /*-------------------------------------------------------------------*/
276 /* These function are most used in libfirm. Give them as static */
277 /* functions so they can be inlined. */
278 /*-------------------------------------------------------------------*/
281 * Checks whether a pointer points to a ir node.
282 * Intern version for libFirm.
285 __is_ir_node (const void *thing) {
286 return (get_kind(thing) == k_ir_node);
290 * Gets the op of a node.
291 * Intern version for libFirm.
293 static INLINE ir_op *
294 __get_irn_op (const ir_node *node)
301 * Gets the opcode of a node.
302 * Intern version for libFirm.
305 __get_irn_opcode (const ir_node *node)
307 assert (k_ir_node == get_kind(node));
309 return node->op->code;
313 * Returns the number of predecessors without the block predecessor.
314 * Intern version for libFirm.
317 __get_irn_intra_arity (const ir_node *node) {
319 return ARR_LEN(node->in) - 1;
323 * Returns the number of predecessors without the block predecessor.
324 * Intern version for libFirm.
327 __get_irn_inter_arity (const ir_node *node) {
329 if (__get_irn_opcode(node) == iro_Filter) {
330 assert(node->attr.filter.in_cg);
331 return ARR_LEN(node->attr.filter.in_cg) - 1;
332 } else if (__get_irn_opcode(node) == iro_Block && node->attr.block.in_cg) {
333 return ARR_LEN(node->attr.block.in_cg) - 1;
335 return __get_irn_intra_arity(node);
339 * Returns the number of predecessors without the block predecessor.
340 * Intern version for libFirm.
343 __get_irn_arity (const ir_node *node) {
344 if (interprocedural_view) return __get_irn_inter_arity(node);
345 return __get_irn_intra_arity(node);
349 * Intern version for libFirm.
351 static INLINE ir_node *
352 __get_irn_intra_n (ir_node *node, int n) {
353 return (node->in[n + 1] = skip_Id(node->in[n + 1]));
357 * Intern version for libFirm.
359 static INLINE ir_node*
360 __get_irn_inter_n (ir_node *node, int n) {
361 /* handle Filter and Block specially */
362 if (__get_irn_opcode(node) == iro_Filter) {
363 assert(node->attr.filter.in_cg);
364 return (node->attr.filter.in_cg[n + 1] = skip_Id(node->attr.filter.in_cg[n + 1]));
365 } else if (__get_irn_opcode(node) == iro_Block && node->attr.block.in_cg) {
366 return (node->attr.block.in_cg[n + 1] = skip_Id(node->attr.block.in_cg[n + 1]));
369 return __get_irn_intra_n (node, n);
373 * Access to the predecessors of a node.
374 * To iterate over the operands iterate from 0 to i < get_irn_arity(),
375 * to iterate including the Block predecessor iterate from i = -1 to
377 * If it is a block, the entry -1 is NULL.
378 * Intern version for libFirm.
380 static INLINE ir_node *
381 __get_irn_n (ir_node *node, int n) {
382 assert(node); assert(-1 <= n && n < __get_irn_arity(node));
383 if (interprocedural_view) return __get_irn_inter_n (node, n);
384 return __get_irn_intra_n (node, n);
388 * Gets the mode of a node.
389 * Intern version for libFirm.
391 static INLINE ir_mode *
392 __get_irn_mode (const ir_node *node)
399 * Sets the mode of a node.
400 * Intern version of libFirm.
403 __set_irn_mode (ir_node *node, ir_mode *mode)
410 * Gets the visited counter of a node.
411 * Intern version for libFirm.
413 static INLINE unsigned long
414 __get_irn_visited (const ir_node *node)
417 return node->visited;
421 * Sets the visited counter of a node.
422 * Intern version for libFirm.
425 __set_irn_visited (ir_node *node, unsigned long visited)
428 node->visited = visited;
432 * Mark a node as visited in a graph.
433 * Intern version for libFirm.
436 __mark_irn_visited (ir_node *node) {
438 node->visited = current_ir_graph->visited;
442 * Returns non-zero if a node of was visited.
443 * Intern version for libFirm.
446 __irn_visited(const ir_node *node) {
448 return (node->visited >= current_ir_graph->visited);
452 * Returns non-zero if a node of was NOT visited.
453 * Intern version for libFirm.
456 __irn_not_visited(const ir_node *node) {
458 return (node->visited < current_ir_graph->visited);
462 * Sets the link of a node.
463 * Intern version of libFirm.
466 __set_irn_link(ir_node *node, void *link) {
468 /* Link field is used for Phi construction and various optimizations
470 assert(get_irg_phase_state(current_ir_graph) != phase_building);
476 * Returns the link of a node.
477 * Intern version of libFirm.
480 __get_irn_link(const ir_node *node) {
485 /* this section MUST contain all inline functions */
486 #define is_ir_node(thing) __is_ir_node(thing)
487 #define get_irn_intra_arity(node) __get_irn_intra_arity(node)
488 #define get_irn_inter_arity(node) __get_irn_inter_arity(node)
489 #define get_irn_arity(node) __get_irn_arity(node)
490 #define get_irn_intra_n(node, n) __get_irn_intra_n(node, n)
491 #define get_irn_inter_n(node, n) __get_irn_inter_n(node, n)
492 #define get_irn_n(node, n) __get_irn_n(node, n)
493 #define get_irn_mode(node) __get_irn_mode(node)
494 #define set_irn_mode(node, mode) __set_irn_mode(node, mode)
495 #define get_irn_op(node) __get_irn_op(node)
496 #define get_irn_opcode(node) __get_irn_opcode(node)
497 #define get_irn_visited(node) __get_irn_visited(node)
498 #define set_irn_visited(node, v) __set_irn_visited(node, v)
499 #define mark_irn_visited(node) __mark_irn_visited(node)
500 #define irn_visited(node) __irn_visited(node)
501 #define irn_not_visited(node) __irn_not_visited(node)
502 #define set_irn_link(node, link) __set_irn_link(node, link)
503 #define get_irn_link(node) __get_irn_link(node)
505 # endif /* _IRNODE_T_H_ */