1 /*
2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
3 *
4 * This file is part of libFirm.
5 *
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
10 *
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
14 *
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 * PURPOSE.
18 */
19
20 /**
21 * @file
22 * @brief Entry point to the representation of procedure code -- internal header.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
24 */
25 #ifndef FIRM_IR_IRGRAPH_T_H
26 #define FIRM_IR_IRGRAPH_T_H
27
28 #include "firm_types.h"
29 #include "irgraph.h"
30
31 #include "irtypes.h"
32 #include "irprog.h"
33 #include "type_t.h"
34 #include "entity_t.h"
35 #include "iredgekinds.h"
36
37 #include "irloop.h"
38
39 #include "obst.h"
40 #include "pset.h"
41 #include "set.h"
42
43 /** Suffix that is added to every frame type. */
44 #define FRAME_TP_SUFFIX "frame_tp"
45
46 /**
47 * Initializes the graph construction module.
48 */
49 void firm_init_irgraph(void);
50
51 /**
52 * Set the number of locals for a given graph.
53 *
54 * @param irg the graph
55 * @param n_loc number of locals
56 */
57 void irg_set_nloc(ir_graph *res, int n_loc);
58
59 /**
60 * Internal constructor that does not add to irp_irgs or the like.
61 */
62 ir_graph *new_r_ir_graph(ir_entity *ent, int n_loc);
63
64 /**
65 * Make a rudimentary ir graph for the constant code.
66 * Must look like a correct irg, spare everything else.
67 */
68 ir_graph *new_const_code_irg(void);
69
70 /**
71 * Create a new graph that is a copy of a given one.
72 * Uses the link fields of the original graphs.
73 *
74 * @param irg The graph that must be copied.
75 */
76 ir_graph *create_irg_copy(ir_graph *irg);
77
78 /**
79 * Set the op_pin_state_pinned state of a graph.
80 *
81 * @param irg the IR graph
82 * @param p new pin state
83 */
84 void set_irg_pinned(ir_graph *irg, op_pin_state p);
85
86 /** Returns the obstack associated with the graph. */
87 struct obstack *get_irg_obstack(const ir_graph *irg);
88
89 /**
90 * Returns true if the node n is allocated on the storage of graph irg.
91 *
92 * @param irg the IR graph
93 * @param n the IR node
94 */
95 int node_is_in_irgs_storage(const ir_graph *irg, const ir_node *n);
96
97 /*-------------------------------------------------------------------*/
98 /* inline functions for graphs */
99 /*-------------------------------------------------------------------*/
100
is_ir_graph_(const void * thing)101 static inline int is_ir_graph_(const void *thing)
102 {
103 return (get_kind(thing) == k_ir_graph);
104 }
105
106 /** Returns the start block of a graph. */
get_irg_start_block_(const ir_graph * irg)107 static inline ir_node *get_irg_start_block_(const ir_graph *irg)
108 {
109 return get_irn_n(irg->anchor, anchor_start_block);
110 }
111
set_irg_start_block_(ir_graph * irg,ir_node * node)112 static inline void set_irg_start_block_(ir_graph *irg, ir_node *node)
113 {
114 set_irn_n(irg->anchor, anchor_start_block, node);
115 }
116
get_irg_start_(const ir_graph * irg)117 static inline ir_node *get_irg_start_(const ir_graph *irg)
118 {
119 return get_irn_n(irg->anchor, anchor_start);
120 }
121
set_irg_start_(ir_graph * irg,ir_node * node)122 static inline void set_irg_start_(ir_graph *irg, ir_node *node)
123 {
124 set_irn_n(irg->anchor, anchor_start, node);
125 }
126
get_irg_end_block_(const ir_graph * irg)127 static inline ir_node *get_irg_end_block_(const ir_graph *irg)
128 {
129 return get_irn_n(irg->anchor, anchor_end_block);
130 }
131
set_irg_end_block_(ir_graph * irg,ir_node * node)132 static inline void set_irg_end_block_(ir_graph *irg, ir_node *node)
133 {
134 set_irn_n(irg->anchor, anchor_end_block, node);
135 }
136
get_irg_end_(const ir_graph * irg)137 static inline ir_node *get_irg_end_(const ir_graph *irg)
138 {
139 return get_irn_n(irg->anchor, anchor_end);
140 }
141
set_irg_end_(ir_graph * irg,ir_node * node)142 static inline void set_irg_end_(ir_graph *irg, ir_node *node)
143 {
144 set_irn_n(irg->anchor, anchor_end, node);
145 }
146
get_irg_initial_exec_(const ir_graph * irg)147 static inline ir_node *get_irg_initial_exec_(const ir_graph *irg)
148 {
149 return get_irn_n(irg->anchor, anchor_initial_exec);
150 }
151
set_irg_initial_exec_(ir_graph * irg,ir_node * node)152 static inline void set_irg_initial_exec_(ir_graph *irg, ir_node *node)
153 {
154 set_irn_n(irg->anchor, anchor_initial_exec, node);
155 }
156
get_irg_frame_(const ir_graph * irg)157 static inline ir_node *get_irg_frame_(const ir_graph *irg)
158 {
159 return get_irn_n(irg->anchor, anchor_frame);
160 }
161
set_irg_frame_(ir_graph * irg,ir_node * node)162 static inline void set_irg_frame_(ir_graph *irg, ir_node *node)
163 {
164 set_irn_n(irg->anchor, anchor_frame, node);
165 }
166
get_irg_initial_mem_(const ir_graph * irg)167 static inline ir_node *get_irg_initial_mem_(const ir_graph *irg)
168 {
169 return get_irn_n(irg->anchor, anchor_initial_mem);
170 }
171
set_irg_initial_mem_(ir_graph * irg,ir_node * node)172 static inline void set_irg_initial_mem_(ir_graph *irg, ir_node *node)
173 {
174 set_irn_n(irg->anchor, anchor_initial_mem, node);
175 }
176
get_irg_args_(const ir_graph * irg)177 static inline ir_node *get_irg_args_(const ir_graph *irg)
178 {
179 return get_irn_n(irg->anchor, anchor_args);
180 }
181
set_irg_args_(ir_graph * irg,ir_node * node)182 static inline void set_irg_args_(ir_graph *irg, ir_node *node)
183 {
184 set_irn_n(irg->anchor, anchor_args, node);
185 }
186
get_irg_no_mem_(const ir_graph * irg)187 static inline ir_node *get_irg_no_mem_(const ir_graph *irg)
188 {
189 return get_irn_n(irg->anchor, anchor_no_mem);
190 }
191
set_irg_no_mem_(ir_graph * irg,ir_node * node)192 static inline void set_irg_no_mem_(ir_graph *irg, ir_node *node)
193 {
194 set_irn_n(irg->anchor, anchor_no_mem, node);
195 }
196
get_irg_entity_(const ir_graph * irg)197 static inline ir_entity *get_irg_entity_(const ir_graph *irg)
198 {
199 return irg->ent;
200 }
201
set_irg_entity_(ir_graph * irg,ir_entity * ent)202 static inline void set_irg_entity_(ir_graph *irg, ir_entity *ent)
203 {
204 irg->ent = ent;
205 }
206
get_irg_frame_type_(ir_graph * irg)207 static inline ir_type *get_irg_frame_type_(ir_graph *irg)
208 {
209 assert(irg->frame_type);
210 return irg->frame_type;
211 }
212
set_irg_frame_type_(ir_graph * irg,ir_type * ftp)213 static inline void set_irg_frame_type_(ir_graph *irg, ir_type *ftp)
214 {
215 assert(is_frame_type(ftp));
216 irg->frame_type = ftp;
217 }
218
get_irg_obstack_(const ir_graph * irg)219 static inline struct obstack *get_irg_obstack_(const ir_graph *irg)
220 {
221 return irg->obst;
222 }
223
get_irg_pinned_(const ir_graph * irg)224 static inline op_pin_state get_irg_pinned_(const ir_graph *irg)
225 {
226 return irg->irg_pinned_state;
227 }
228
set_irg_pinned_(ir_graph * irg,op_pin_state p)229 static inline void set_irg_pinned_(ir_graph *irg, op_pin_state p)
230 {
231 irg->irg_pinned_state = p;
232 }
233
get_irg_callee_info_state_(const ir_graph * irg)234 static inline irg_callee_info_state get_irg_callee_info_state_(const ir_graph *irg)
235 {
236 return irg->callee_info_state;
237 }
238
set_irg_callee_info_state_(ir_graph * irg,irg_callee_info_state s)239 static inline void set_irg_callee_info_state_(ir_graph *irg, irg_callee_info_state s)
240 {
241 irg_callee_info_state irp_state = get_irp_callee_info_state();
242
243 irg->callee_info_state = s;
244
245 /* I could compare ... but who knows? */
246 if ((irp_state == irg_callee_info_consistent) ||
247 ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
248 set_irp_callee_info_state(s);
249 }
250
set_irg_link_(ir_graph * irg,void * thing)251 static inline void set_irg_link_(ir_graph *irg, void *thing)
252 {
253 irg->link = thing;
254 }
255
get_irg_link_(const ir_graph * irg)256 static inline void *get_irg_link_(const ir_graph *irg)
257 {
258 return irg->link;
259 }
260
get_irg_visited_(const ir_graph * irg)261 static inline ir_visited_t get_irg_visited_(const ir_graph *irg)
262 {
263 return irg->visited;
264 }
265
get_irg_block_visited_(const ir_graph * irg)266 static inline ir_visited_t get_irg_block_visited_(const ir_graph *irg)
267 {
268 return irg->block_visited;
269 }
270
set_irg_block_visited_(ir_graph * irg,ir_visited_t visited)271 static inline void set_irg_block_visited_(ir_graph *irg, ir_visited_t visited)
272 {
273 irg->block_visited = visited;
274 }
275
inc_irg_block_visited_(ir_graph * irg)276 static inline void inc_irg_block_visited_(ir_graph *irg)
277 {
278 ++irg->block_visited;
279 }
280
dec_irg_block_visited_(ir_graph * irg)281 static inline void dec_irg_block_visited_(ir_graph *irg)
282 {
283 --irg->block_visited;
284 }
285
get_irg_estimated_node_cnt_(const ir_graph * irg)286 static inline unsigned get_irg_estimated_node_cnt_(const ir_graph *irg)
287 {
288 return irg->estimated_node_count;
289 }
290
291 /* Return the floating point model of this graph. */
get_irg_fp_model_(const ir_graph * irg)292 static inline unsigned get_irg_fp_model_(const ir_graph *irg)
293 {
294 return irg->fp_model;
295 }
296
irg_is_constrained_(const ir_graph * irg,ir_graph_constraints_t constraints)297 static inline int irg_is_constrained_(const ir_graph *irg,
298 ir_graph_constraints_t constraints)
299 {
300 return (irg->constraints & constraints) == constraints;
301 }
302
add_irg_properties_(ir_graph * irg,ir_graph_properties_t props)303 static inline void add_irg_properties_(ir_graph *irg,
304 ir_graph_properties_t props)
305 {
306 irg->properties |= props;
307 }
308
clear_irg_properties_(ir_graph * irg,ir_graph_properties_t props)309 static inline void clear_irg_properties_(ir_graph *irg,
310 ir_graph_properties_t props)
311 {
312 irg->properties &= ~props;
313 }
314
irg_has_properties_(const ir_graph * irg,ir_graph_properties_t props)315 static inline int irg_has_properties_(const ir_graph *irg,
316 ir_graph_properties_t props)
317 {
318 return (irg->properties & props) == props;
319 }
320
321 /**
322 * Allocates a new idx in the irg for the node and adds the irn to the idx -> irn map.
323 * @param irg The graph.
324 * @param irn The node.
325 * @return The index allocated for the node.
326 */
irg_register_node_idx(ir_graph * irg,ir_node * irn)327 static inline unsigned irg_register_node_idx(ir_graph *irg, ir_node *irn)
328 {
329 unsigned idx = irg->last_node_idx++;
330 if (idx >= (unsigned)ARR_LEN(irg->idx_irn_map))
331 ARR_RESIZE(ir_node *, irg->idx_irn_map, idx + 1);
332
333 irg->idx_irn_map[idx] = irn;
334 return idx;
335 }
336
337 /**
338 * Kill a node from the irg. BEWARE: this kills
339 * all later created nodes.
340 */
irg_kill_node(ir_graph * irg,ir_node * n)341 static inline void irg_kill_node(ir_graph *irg, ir_node *n)
342 {
343 unsigned idx = get_irn_idx(n);
344 assert(idx + 1 == irg->last_node_idx);
345
346 if (idx + 1 == irg->last_node_idx)
347 --irg->last_node_idx;
348 irg->idx_irn_map[idx] = NULL;
349 obstack_free(irg->obst, n);
350 }
351
352 /**
353 * Get the node for an index.
354 * @param irg The graph.
355 * @param idx The index you want the node for.
356 * @return The node with that index or NULL, if there is no node with that index.
357 * @note The node you got might be dead.
358 */
get_idx_irn_(const ir_graph * irg,unsigned idx)359 static inline ir_node *get_idx_irn_(const ir_graph *irg, unsigned idx)
360 {
361 assert(idx < (unsigned) ARR_LEN(irg->idx_irn_map));
362 return irg->idx_irn_map[idx];
363 }
364
365 /**
366 * Return the number of anchors in this graph.
367 */
get_irg_n_anchors(const ir_graph * irg)368 static inline int get_irg_n_anchors(const ir_graph *irg)
369 {
370 return get_irn_arity(irg->anchor);
371 }
372
373 /**
374 * Return anchor for given index
375 */
get_irg_anchor(const ir_graph * irg,int idx)376 static inline ir_node *get_irg_anchor(const ir_graph *irg, int idx)
377 {
378 return get_irn_n(irg->anchor, idx);
379 }
380
381 /**
382 * Set anchor for given index
383 */
set_irg_anchor(ir_graph * irg,int idx,ir_node * irn)384 static inline void set_irg_anchor(ir_graph *irg, int idx, ir_node *irn)
385 {
386 set_irn_n(irg->anchor, idx, irn);
387 }
388
389
390 #define is_ir_graph(thing) is_ir_graph_(thing)
391 #define get_irg_start_block(irg) get_irg_start_block_(irg)
392 #define set_irg_start_block(irg, node) set_irg_start_block_(irg, node)
393 #define get_irg_start(irg) get_irg_start_(irg)
394 #define set_irg_start(irg, node) set_irg_start_(irg, node)
395 #define get_irg_end_block(irg) get_irg_end_block_(irg)
396 #define set_irg_end_block(irg, node) set_irg_end_block_(irg, node)
397 #define get_irg_end(irg) get_irg_end_(irg)
398 #define set_irg_end(irg, node) set_irg_end_(irg, node)
399 #define get_irg_initial_exec(irg) get_irg_initial_exec_(irg)
400 #define set_irg_initial_exec(irg, node) set_irg_initial_exec_(irg, node)
401 #define get_irg_frame(irg) get_irg_frame_(irg)
402 #define set_irg_frame(irg, node) set_irg_frame_(irg, node)
403 #define get_irg_initial_mem(irg) get_irg_initial_mem_(irg)
404 #define set_irg_initial_mem(irg, node) set_irg_initial_mem_(irg, node)
405 #define get_irg_args(irg) get_irg_args_(irg)
406 #define set_irg_args(irg, node) set_irg_args_(irg, node)
407 #define get_irg_no_mem(irg) get_irg_no_mem_(irg)
408 #define set_irn_no_mem(irg, node) set_irn_no_mem_(irg, node)
409 #define get_irg_entity(irg) get_irg_entity_(irg)
410 #define set_irg_entity(irg, ent) set_irg_entity_(irg, ent)
411 #define get_irg_frame_type(irg) get_irg_frame_type_(irg)
412 #define set_irg_frame_type(irg, ftp) set_irg_frame_type_(irg, ftp)
413 #define get_irg_obstack(irg) get_irg_obstack_(irg)
414 #define get_irg_pinned(irg) get_irg_pinned_(irg)
415 #define set_irg_pinned(irg, p) set_irg_pinned_(irg, p)
416 #define get_irg_callee_info_state(irg) get_irg_callee_info_state_(irg)
417 #define set_irg_callee_info_state(irg, s) set_irg_callee_info_state_(irg, s)
418 #define get_irg_additional_properties(irg) get_irg_additional_properties_(irg)
419 #define set_irg_additional_properties(irg, m) set_irg_additional_properties_(irg, m)
420 #define set_irg_additional_property(irg, f) set_irg_additional_property_(irg, f)
421 #define set_irg_link(irg, thing) set_irg_link_(irg, thing)
422 #define get_irg_link(irg) get_irg_link_(irg)
423 #define get_irg_visited(irg) get_irg_visited_(irg)
424 #define get_irg_block_visited(irg) get_irg_block_visited_(irg)
425 #define set_irg_block_visited(irg, v) set_irg_block_visited_(irg, v)
426 #define inc_irg_block_visited(irg) inc_irg_block_visited_(irg)
427 #define dec_irg_block_visited(irg) dec_irg_block_visited_(irg)
428 #define get_irg_estimated_node_cnt(irg) get_irg_estimated_node_cnt_(irg)
429 #define get_irg_fp_model(irg) get_irg_fp_model_(irg)
430 #define get_idx_irn(irg, idx) get_idx_irn_(irg, idx)
431 #define irg_is_constrained(irg, constraints) irg_is_constrained_(irg, constraints)
432 #define add_irg_properties(irg, props) add_irg_properties_(irg, props)
433 #define clear_irg_properties(irg, props) clear_irg_properties_(irg, props)
434 #define irg_has_properties(irg, props) irg_has_properties_(irg, props)
435
436 #endif
437