1 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
4 * Authors: Martin Trapp, Christian Schaefer
6 * irgraph.h: ir graph construction
17 /* to resolve recursion between irnode.h and irgraph.h */
18 #ifndef _IR_NODE_TYPEDEF_
19 #define _IR_NODE_TYPEDEF_
20 typedef struct ir_node ir_node;
23 /* to resolve recursion between entity.h and irgraph.h */
24 #ifndef _IR_GRAPH_TYPEDEF_
25 #define _IR_GRAPH_TYPEDEF_
26 typedef struct ir_graph ir_graph;
31 * NAME Datastructure that holds central information about a procedure
33 * ir_graph *new_ir_graph (entity *ent, int params);
34 * -------------------------------------------------
36 * This constructor generates the basic infrastructure needed to
37 * represent a procedure in FIRM.
39 * The parameters of new_ir_graph are:
41 * *ent A pointer to an entity representing the procedure.
43 * params An integer giving the number of local variables in the
46 * It allocates an ir_graph and sets current_ir_graph to point to this
47 * graph. Further it allocates the following nodes needed for every
50 * * The start block containing a start node and Proj nodes for it's
51 * five results (X, M, P, P, T).
52 * * The end block containing an end node. This block is not matured
53 * after executing new_ir_graph as predecessors need to be added to it.
54 * (Maturing a block means fixing it's number of predecessors.)
55 * * The current block, which is empty and also not matured.
57 * Further it enters the global store into the datastructure of the start
58 * block that contanis all valid values in this block (set_store()). This
59 * datastructure is used to build the Phi nodes and removed after
60 * completion of the graph. There is no path from end to start in the
61 * graph after calling ir_graph.
62 * pinned set to "pinned" if no global cse was performed on the graph.
63 * set to "floats" if global cse was performed (and during construction:
64 * did actually change something). Code placement is necessary.
67 /* Global variable holding the current_ir_graph. This global variable
68 is used by the ir construction interface in ircons and by the
70 extern ir_graph *current_ir_graph;
71 ir_graph *get_current_ir_graph();
72 void set_current_ir_graph(ir_graph *graph);
74 /* This flag indicate the current view. The behaviour of some methods
75 * (get_irn_*, set_irn_*) is influenced by this flag. */
76 extern bool interprocedural_view;
77 bool get_interprocedural_view();
78 void set_interprocedural_view(bool state);
80 /* Create a new ir graph to built ir for a procedure.
81 ent is the entity representing this procedure, i.e., the type of the
82 entity must be of a method type. The constructor automatically sets the
83 field irg of the entity as well as current_ir_graph to the new ir graph.
84 n_loc is the number of local variables in this procedure including
85 the procedure parameters.
86 The state of the ir graph is: phase_building, pinned, no_outs. */
87 ir_graph *new_ir_graph (entity *ent, int n_loc);
89 /* Frees the passed irgraph.
90 Deallocates all nodes in this graph and the ir_graph structure.
91 Sets the field irgraph in the corresponding entity to NULL.
92 Does not remove the irgraph from the list in irprog (requires
93 inefficient search, call remove_irp_irg by hand).
94 Does not free types, entities or modes that are used only by this
95 graph, nor the entity standing for this graph. */
96 void free_ir_graph (ir_graph *irg);
98 /** access routines for all ir_graph attributes **/
99 entity *get_irg_ent (ir_graph *irg);
100 void set_irg_ent (ir_graph *irg, entity *ent);
102 type *get_irg_frame_type (ir_graph *irg);
103 void set_irg_frame_type (ir_graph *irg, type *ftp);
104 /* To test for a frame type */
105 int is_frame_type(type *ftp);
107 ir_node *get_irg_start_block (ir_graph *irg);
108 void set_irg_start_block (ir_graph *irg, ir_node *node);
110 ir_node *get_irg_start (ir_graph *irg);
111 void set_irg_start (ir_graph *irg, ir_node *node);
113 ir_node *get_irg_end_block (ir_graph *irg);
114 void set_irg_end_block (ir_graph *irg, ir_node *node);
116 ir_node *get_irg_end (ir_graph *irg);
117 void set_irg_end (ir_graph *irg, ir_node *node);
119 /* @@@ oblivious, no more supported. */
120 ir_node *get_irg_cstore (ir_graph *irg);
121 void set_irg_cstore (ir_graph *irg, ir_node *node);
124 ir_node *get_irg_frame (ir_graph *irg);
125 void set_irg_frame (ir_graph *irg, ir_node *node);
127 ir_node *get_irg_globals (ir_graph *irg);
128 void set_irg_globals (ir_graph *irg, ir_node *node);
130 ir_node *get_irg_args (ir_graph *irg);
131 void set_irg_args (ir_graph *irg, ir_node *node);
133 ir_node *get_irg_current_block (ir_graph *irg);
134 void set_irg_current_block (ir_graph *irg, ir_node *node);
136 /* Use new_Bad() instead!! */
137 ir_node *get_irg_bad (ir_graph *irg);
138 void set_irg_bad (ir_graph *irg, ir_node *node);
140 /* Use new_Unknown() instead!! */
141 ir_node *get_irg_unknown (ir_graph *irg);
142 void set_irg_unknown (ir_graph *irg, ir_node *node);
144 int get_irg_n_locs (ir_graph *irg);
146 /********************************************************************************/
147 /* States of an ir_graph. */
148 /********************************************************************************/
151 information associated with the graph. Optimizations invalidate these
154 /* state: phase values: phase_building, phase_high, phase_low.
155 The irg is in phase_building during construction of the irgraph. It is in
156 phase_high after construction. All nodes are allowed. To get the irgraph
157 into phase_low all Sel nodes must be removed and replaced by explicit
158 address computations. SymConst size and typetag nodes must be removed (@@@
159 really?). Initialization of memory allocated by Alloc must be explicit.
160 @@@ More conditions? */
167 irg_phase_state get_irg_phase_state (ir_graph *irg);
168 void set_irg_phase_low(ir_graph *irg);
171 The graph is "pinned" if all nodes are associated with a basic block.
172 It is in state "floats" if nodes are in arbitrary blocks. In state
173 "floats" the block predecessor is set in all nodes, but this can be an
174 invalid block, i.e., the block is not a dominator of all the uses of
176 The enum op_pinned is defined in irop.h. */
177 op_pinned get_irg_pinned (ir_graph *irg);
180 Outs are the back edges or def-use edges.
181 Values: no_outs, outs_consistent, outs_inconsistent
182 no_outs: outs are not computed, no memory is allocated.
183 outs_consistent: outs are computed and correct,
184 outs_inconsistent: outs have been computed, memory is still allocated,
185 but the graph has been changed since. */
191 irg_outs_state get_irg_outs_state(ir_graph *irg);
192 void set_irg_outs_inconsistent(ir_graph *irg);
195 Signals the state of the dominator infomation.
196 Values: no_dom, dom_consistent, dom_inconsistent
197 no_dom: doms are not computed, no memory is allocated. The access routines
199 dom_consistent: dominator information is computed and correct,
200 dom_inconsistent: dominator information is computed, memory is still allocated,
201 but the graph has been changed since. Using the access routines is possible,
202 obtained information may be incorrect. */
208 irg_dom_state get_irg_dom_state(ir_graph *irg);
209 void set_irg_dom_inconsistent(ir_graph *irg);
211 /* state: loopinfo_state
212 Loop information describes the loops within the control and
213 data flow of the procedure.
214 tpedef enum { @@@ make unrecognizable for jni script!!!
217 loopinfo_inconsistent
218 } irg_loopinfo_state;
219 irg_loopinfo_state get_irg_loopinfo_state(ir_graph *irg);
220 void set_irg_loopinfo_inconsistent(ir_graph *irg);
223 /* A void * field to link arbritary information to the node. */
224 void set_irg_link (ir_graph *irg, void *thing);
225 void *get_irg_link (ir_graph *irg);
227 /* increments visited by one */
228 void inc_irg_visited(ir_graph *irg);
229 unsigned long get_irg_visited (ir_graph *irg);
230 void set_irg_visited(ir_graph *irg, unsigned long i);
231 unsigned long get_max_irg_visited(void);
232 void set_max_irg_visited(int val);
233 unsigned long inc_max_irg_visited(void);
235 /* increments block_visited by one */
236 void inc_irg_block_visited(ir_graph *irg);
237 unsigned long get_irg_block_visited (ir_graph *irg);
238 void set_irg_block_visited(ir_graph *irg, unsigned long i);
240 # endif /* _IRGRAPH_H_ */