3 * File name: ir/ir/irgraph.c
4 * Purpose: Entry point to the representation of procedure code.
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 * ir graph construction.
18 * @author Martin Trapp, Christian Schaefer
29 /* to resolve recursion between irnode.h and irgraph.h */
30 #ifndef _IR_NODE_TYPEDEF_
31 #define _IR_NODE_TYPEDEF_
32 typedef struct ir_node ir_node;
35 /* to resolve recursion between entity.h and irgraph.h */
36 #ifndef _IR_GRAPH_TYPEDEF_
37 #define _IR_GRAPH_TYPEDEF_
38 typedef struct ir_graph ir_graph;
43 * NAME Datastructure that holds central information about a procedure
45 * ir_graph *new_ir_graph (entity *ent, int params);
46 * -------------------------------------------------
48 * This constructor generates the basic infrastructure needed to
49 * represent a procedure in FIRM.
51 * The parameters of new_ir_graph are:
53 * *ent A pointer to an entity representing the procedure.
55 * params An integer giving the number of local variables in the
58 * It allocates an ir_graph and sets current_ir_graph to point to this
59 * graph. Further it allocates the following nodes needed for every
62 * * The start block containing a start node and Proj nodes for it's
63 * five results (X, M, P, P, T).
64 * * The end block containing an end node. This block is not matured
65 * after executing new_ir_graph as predecessors need to be added to it.
66 * (Maturing a block means fixing it's number of predecessors.)
67 * * The current block, which is empty and also not matured.
69 * Further it enters the global store into the datastructure of the start
70 * block that contanis all valid values in this block (set_store()). This
71 * datastructure is used to build the Phi nodes and removed after
72 * completion of the graph. There is no path from end to start in the
73 * graph after calling ir_graph.
74 * op_pin_state_pinned set to "op_pin_state_pinned" if no global cse was performed on the graph.
75 * set to "op_pin_state_floats" if global cse was performed (and during construction:
76 * did actually change something). Code placement is necessary.
79 /** Global variable holding the current ir graph.
81 * This global variable is used by the ir construction
82 * interface in ircons and by the optimizations.
84 extern ir_graph *current_ir_graph;
86 ir_graph *get_current_ir_graph(void);
87 void set_current_ir_graph(ir_graph *graph);
89 /** This flag indicate the current view. The behaviour of some methods
90 * (get_irn_*, set_irn_*) is influenced by this flag. */
91 extern bool interprocedural_view;
92 bool get_interprocedural_view(void);
93 void set_interprocedural_view(bool state);
95 /** Create a new ir graph to built ir for a procedure.
97 * ent is the entity representing this procedure, i.e., the type of the
98 * entity must be of a method type. The constructor automatically sets the
99 * field irg of the entity as well as current_ir_graph to the new ir graph.
100 * n_loc is the number of local variables in this procedure including
101 * the procedure parameters.
102 * The constructor adds the new irgraph to the list in ir_prog.
103 * The state of the ir graph is: phase_building, op_pin_state_pinned, outs_none. */
104 ir_graph *new_ir_graph (entity *ent, int n_loc);
106 /** Frees the passed irgraph.
107 * Deallocates all nodes in this graph and the ir_graph structure.
108 * Sets the field irgraph in the corresponding entity to NULL.
109 * Does not remove the irgraph from the list in irprog (requires
110 * inefficient search, call remove_irp_irg by hand).
111 * Does not free types, entities or modes that are used only by this
112 * graph, nor the entity standing for this graph.
114 void free_ir_graph (ir_graph *irg);
116 /* --- access routines for all ir_graph attributes --- */
119 * Checks whether a pointer points to a ir graph.
121 * @param thing an arbitrary pointer
124 * true if the thing is a ir graph, else false
126 int is_ir_graph(void *thing);
128 /* #define get_irg_entity get_irg_ent */
129 /* #define set_irg_entity set_irg_ent */
130 entity *get_irg_entity (ir_graph *irg);
131 void set_irg_entity (ir_graph *irg, entity *ent);
133 type *get_irg_frame_type (ir_graph *irg);
134 void set_irg_frame_type (ir_graph *irg, type *ftp);
135 /* To test for a frame type. O(#irgs) if ftp is class type. */
136 int is_frame_type (type *ftp);
138 ir_node *get_irg_start_block (ir_graph *irg);
139 void set_irg_start_block (ir_graph *irg, ir_node *node);
141 ir_node *get_irg_start (ir_graph *irg);
142 void set_irg_start (ir_graph *irg, ir_node *node);
144 ir_node *get_irg_end_block (ir_graph *irg);
145 void set_irg_end_block (ir_graph *irg, ir_node *node);
147 ir_node *get_irg_end (ir_graph *irg);
148 void set_irg_end (ir_graph *irg, ir_node *node);
150 /* The fields end_reg and end_except contain the end nodes of the
151 interprocedural view. If the view is not constructed they contain
152 the nomal end node. */
153 ir_node *get_irg_end_reg (ir_graph *irg);
154 void set_irg_end_reg (ir_graph *irg, ir_node *node);
156 ir_node *get_irg_end_except (ir_graph *irg);
157 void set_irg_end_except (ir_graph *irg, ir_node *node);
160 /* @@@ oblivious, no more supported. */
161 ir_node *get_irg_cstore (ir_graph *irg);
162 void set_irg_cstore (ir_graph *irg, ir_node *node);
165 /** Returns the node that represents the frame pointer. */
166 ir_node *get_irg_frame (ir_graph *irg);
167 /** Sets the node that represents the frame pointer. */
168 void set_irg_frame (ir_graph *irg, ir_node *node);
170 /** Returns the node that represents the global pointer. */
171 ir_node *get_irg_globals (ir_graph *irg);
172 /** Sets the node that represents the global pointer. */
173 void set_irg_globals (ir_graph *irg, ir_node *node);
175 /** Returns the node that represents the initial memory. */
176 ir_node *get_irg_initial_mem (ir_graph *irg);
177 /** Sets the node that represents the initial memory. */
178 void set_irg_initial_mem (ir_graph *irg, ir_node *node);
180 /** Returns the node that represents the argument pointer. */
181 ir_node *get_irg_args (ir_graph *irg);
182 /** Sets the node that represents the argument pointer. */
183 void set_irg_args (ir_graph *irg, ir_node *node);
185 /** Returns the current block of a graph. */
186 ir_node *get_irg_current_block (ir_graph *irg);
187 /** Sets the current block of a graph. */
188 void set_irg_current_block (ir_graph *irg, ir_node *node);
190 /* Use new_Bad() instead!! */
191 ir_node *get_irg_bad (ir_graph *irg);
192 void set_irg_bad (ir_graph *irg, ir_node *node);
194 /** Returns the number of value numbers of a graph. */
195 int get_irg_n_locs (ir_graph *irg);
197 /** Returns the graph number. */
198 long get_irg_graph_nr(ir_graph *irg);
200 /********************************************************************************/
201 /* States of an ir_graph. */
202 /********************************************************************************/
205 information associated with the graph. Optimizations invalidate these
208 /** The states of an ir graph.
210 * state phase values: phase_building, phase_high, phase_low.
212 * The graph is in phase_building during construction of the irgraph.
213 * The construction is finished by a call to finalize_cons().
215 * Finalize_cons() sets the state to phase_high. All Firm nodes are
218 * To get the irgraph into phase_low all Sel nodes must be removed and
219 * replaced by explicit address computations. SymConst size and
220 * typetag nodes must be removed (@@@ really?). Initialization of
221 * memory allocated by Alloc must be explicit. @@@ More conditions?
230 irg_phase_state get_irg_phase_state (ir_graph *irg);
231 void set_irg_phase_low(ir_graph *irg);
233 /** state: op_pin_state_pinned
234 The graph is "op_pin_state_pinned" if all nodes are associated with a basic block.
235 It is in state "op_pin_state_floats" if nodes are in arbitrary blocks. In state
236 "op_pin_state_floats" the block predecessor is set in all nodes, but this can be an
237 invalid block, i.e., the block is not a dominator of all the uses of
239 The enum op_pin_state is defined in irop.h. */
240 op_pin_state get_irg_pinned (ir_graph *irg);
242 /** state: outs_state
243 Outs are the back edges or def-use edges.
244 Values: outs_none, outs_consistent, outs_inconsistent
245 outs_none: outs are not computed, no memory is allocated.
246 outs_consistent: outs are computed and correct,
247 outs_inconsistent: outs have been computed, memory is still allocated,
248 but the graph has been changed since. */
254 irg_outs_state get_irg_outs_state(ir_graph *irg);
255 void set_irg_outs_inconsistent(ir_graph *irg);
258 Signals the state of the dominator infomation.
259 Values: dom_none, dom_consistent, dom_inconsistent
260 dom_none: doms are not computed, no memory is allocated. The access routines
262 dom_consistent: dominator information is computed and correct,
263 dom_inconsistent: dominator information is computed, memory is still allocated,
264 but the graph has been changed since. Using the access routines is possible,
265 obtained information may be incorrect. */
271 irg_dom_state get_irg_dom_state(ir_graph *irg);
272 void set_irg_dom_inconsistent(ir_graph *irg);
274 /** state: loopinfo_state
275 Loop information describes the loops within the control and
276 data flow of the procedure. */
278 loopinfo_none = 0, /**< No loop information is constructed. Default. */
279 loopinfo_constructed = 1, /**< Some kind of loop information is constructed. */
280 loopinfo_valid = 2, /**< Loop information is valid. */
281 loopinfo_cf = 4, /**< Loop information constructed for control flow only. */
282 loopinfo_inter = 8, /**< Loop information for interprocedural view. */
284 loopinfo_for_firmjni = 16, /**< A hack for firmjni: all enums must differ as they
285 are used in a switch. */
287 /** IntRAprocedural loop information constructed and valid. */
288 loopinfo_consistent = loopinfo_constructed | loopinfo_valid,
289 /** IntRAprocedural loop information constructed and invalid. */
290 loopinfo_inconsistent = loopinfo_constructed | loopinfo_for_firmjni,
292 /** IntERprocedural loop information constructed and valid. */
293 loopinfo_ip_consistent = loopinfo_constructed | loopinfo_inter | loopinfo_valid,
294 /** IntERprocedural loop information constructed and invalid. */
295 loopinfo_ip_inconsistent = loopinfo_constructed | loopinfo_inter,
297 /** IntRAprocedural control loop information constructed and valid. */
298 loopinfo_cf_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_valid,
299 /** IntRAprocedural control loop information constructed and invalid. */
300 loopinfo_cf_inconsistent = loopinfo_constructed | loopinfo_cf,
302 /** IntERprocedural control loop information constructed and valid. */
303 loopinfo_cf_ip_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter | loopinfo_valid,
304 /** IntERprocedural control loop information constructed and invalid. */
305 loopinfo_cf_ip_inconsistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter
306 } irg_loopinfo_state;
308 irg_loopinfo_state get_irg_loopinfo_state(ir_graph *irg);
309 void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s);
310 /* Sets the loopinformation state to the appropriate inconsistent state.
311 If state is 'none' does not change. */
312 void set_irg_loopinfo_inconsistent(ir_graph *irg);
314 /** state: callee_information_state
315 * Call nodes contain a list of possible callees. This list must be
316 * computed by an anlysis.
318 * It's strange that this state is administered on irg basis, as the
319 * information must be computed for the whole program, or not?
322 irg_callee_info_none,
323 irg_callee_info_consistent,
324 irg_callee_info_inconsistent
325 } irg_callee_info_state;
326 irg_callee_info_state get_irg_callee_info_state(ir_graph *irg);
327 void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
330 * Tells how to handle an ir graph in inlineing.
333 irg_inline_any, /**< No restriction on inlineing. Default. */
334 irg_inline_forbidden, /**< The graph may not be inlined. */
335 irg_inline_recomended, /**< The graph should be inlined. */
336 irg_inline_forced /**< The graph must be inlined. */
337 } irg_inline_property;
338 irg_inline_property get_irg_inline_property(ir_graph *irg);
339 void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
341 /** A void * field to link arbritary information to the node. */
342 void set_irg_link (ir_graph *irg, void *thing);
343 void *get_irg_link (ir_graph *irg);
345 /* increments visited by one */
346 void inc_irg_visited (ir_graph *irg);
347 unsigned long get_irg_visited (ir_graph *irg);
348 void set_irg_visited (ir_graph *irg, unsigned long i);
349 unsigned long get_max_irg_visited (void);
350 void set_max_irg_visited (int val);
351 unsigned long inc_max_irg_visited (void);
353 /* increments block_visited by one */
354 void inc_irg_block_visited (ir_graph *irg);
355 unsigned long get_irg_block_visited (ir_graph *irg);
356 void set_irg_block_visited (ir_graph *irg, unsigned long i);
358 # endif /* _IRGRAPH_H_ */