Correct comment: xvcg wants LF, not CR.
[libfirm] / ir / ir / irprog.c
1 /*
2  * Copyright (C) 1995-2011 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 a whole program.
23  * @author   Goetz Lindenmaier, Michael Beck
24  * @date     2000
25  */
26 #include "config.h"
27
28 #include <string.h>
29
30 #include "irprog_t.h"
31 #include "irgraph_t.h"
32 #include "irpass_t.h"
33 #include "array.h"
34 #include "error.h"
35 #include "obst.h"
36 #include "irop_t.h"
37 #include "irmemory.h"
38 #include "ircons.h"
39
40 /** The initial name of the irp program. */
41 #define INITAL_PROG_NAME "no_name_set"
42
43 ir_prog *irp;
44 ir_prog *get_irp(void) { return irp; }
45 void set_irp(ir_prog *new_irp)
46 {
47         irp = new_irp;
48 }
49
50 /**
51  *  Create a new incomplete ir_prog.
52  */
53 static ir_prog *new_incomplete_ir_prog(void)
54 {
55         ir_prog *res = XMALLOCZ(ir_prog);
56
57         res->kind           = k_ir_prog;
58         res->graphs         = NEW_ARR_F(ir_graph *, 0);
59         res->types          = NEW_ARR_F(ir_type *, 0);
60         res->global_asms    = NEW_ARR_F(ident *, 0);
61         res->last_label_nr  = 1;  /* 0 is reserved as non-label */
62         res->max_irg_idx    = 0;
63         res->max_node_nr    = 0;
64 #ifndef NDEBUG
65         res->reserved_resources = IRP_RESOURCE_NONE;
66 #endif
67
68         return res;
69 }
70
71 /**
72  * Completes an incomplete irprog.
73  *
74  * @param irp          the (yet incomplete) irp
75  * @param module_name  the (module) name for this irp
76  */
77 static void complete_ir_prog(ir_prog *irp, const char *module_name)
78 {
79 #define IDENT(x)  new_id_from_chars(x, sizeof(x) - 1)
80
81         irp->name = new_id_from_str(module_name);
82         irp->segment_types[IR_SEGMENT_GLOBAL]
83                 = new_type_class(IDENT("GlobalType"));
84         irp->segment_types[IR_SEGMENT_THREAD_LOCAL]
85                 = new_type_struct(IDENT("ThreadLocal"));
86         irp->segment_types[IR_SEGMENT_CONSTRUCTORS]
87                 = new_type_class(IDENT("Constructors"));
88         irp->segment_types[IR_SEGMENT_DESTRUCTORS]
89                 = new_type_class(IDENT("Destructors"));
90
91         /* Set these flags for debugging. */
92         irp->segment_types[IR_SEGMENT_GLOBAL]->flags       |= tf_segment|tf_global_type;
93         irp->segment_types[IR_SEGMENT_THREAD_LOCAL]->flags |= tf_segment|tf_tls_type;
94         irp->segment_types[IR_SEGMENT_CONSTRUCTORS]->flags |= tf_segment|tf_constructors;
95         irp->segment_types[IR_SEGMENT_DESTRUCTORS]->flags  |= tf_segment|tf_destructors;
96
97         /* The global type is a class, but we cannot derive from it, so set
98            the final property to assist optimizations that checks for it. */
99         set_class_final(irp->segment_types[IR_SEGMENT_GLOBAL], 1);
100
101         irp->const_code_irg             = new_const_code_irg();
102         irp->phase_state                = phase_building;
103         irp->class_cast_state           = ir_class_casts_transitive;
104         irp->globals_entity_usage_state = ir_entity_usage_not_computed;
105 #undef IDENT
106 }
107
108 void init_irprog_1(void)
109 {
110         irp = new_incomplete_ir_prog();
111 }
112
113 void init_irprog_2(void)
114 {
115         complete_ir_prog(irp, INITAL_PROG_NAME);
116         ir_init_type(irp);
117         ir_init_entity(irp);
118 }
119
120 ir_prog *new_ir_prog(const char *name)
121 {
122         ir_prog *irp = new_incomplete_ir_prog();
123         complete_ir_prog(irp, name);
124         return irp;
125 }
126
127 void free_ir_prog(void)
128 {
129         size_t i;
130         /* must iterate backwards here */
131         for (i = get_irp_n_irgs(); i > 0;)
132                 free_ir_graph(get_irp_irg(--i));
133
134         /* free entities first to avoid entity types being destroyed before
135          * the entities using them */
136         for (i = get_irp_n_types(); i > 0;)
137                 free_type_entities(get_irp_type(--i));
138
139         ir_finish_entity(irp);
140
141         for (i = get_irp_n_types(); i > 0;)
142                 free_type(get_irp_type(--i));
143
144         free_ir_graph(irp->const_code_irg);
145
146         ir_finish_type(irp);
147
148         DEL_ARR_F(irp->graphs);
149         DEL_ARR_F(irp->types);
150
151         DEL_ARR_F(irp->global_asms);
152
153         irp->name           = NULL;
154         irp->const_code_irg = NULL;
155         irp->kind           = k_BAD;
156         free(irp);
157         irp = NULL;
158 }
159
160 ir_graph *get_irp_main_irg(void)
161 {
162         assert(irp);
163         return irp->main_irg;
164 }
165
166 void set_irp_main_irg(ir_graph *main_irg)
167 {
168         assert(irp);
169         irp->main_irg = main_irg;
170 }
171
172 ir_type *(get_segment_type)(ir_segment_t segment)
173 {
174         return get_segment_type_(segment);
175 }
176
177 void set_segment_type(ir_segment_t segment, ir_type *new_type)
178 {
179         assert(segment <= IR_SEGMENT_LAST);
180         irp->segment_types[segment] = new_type;
181 }
182
183 ir_type *(get_glob_type)(void)
184 {
185         return get_glob_type_();
186 }
187
188 ir_type *(get_tls_type)(void)
189 {
190         return get_tls_type_();
191 }
192
193 void add_irp_irg(ir_graph *irg)
194 {
195         assert(irg != NULL);
196         assert(irp && irp->graphs);
197         ARR_APP1(ir_graph *, irp->graphs, irg);
198 }
199
200 void remove_irp_irg_from_list(ir_graph *irg)
201 {
202         size_t i, l;
203
204         assert(irg);
205         l = ARR_LEN(irp->graphs);
206         for (i = 0; i < l; ++i) {
207                 if (irp->graphs[i] == irg) {
208                         for (; i < l - 1; ++i) {
209                                 irp->graphs[i] = irp->graphs[i+1];
210                         }
211                         ARR_SETLEN(ir_graph*, irp->graphs, l - 1);
212                         break;
213                 }
214         }
215 }
216
217 void remove_irp_irg(ir_graph *irg)
218 {
219         free_ir_graph(irg);
220         remove_irp_irg_from_list(irg);
221 }
222
223 size_t (get_irp_n_irgs)(void)
224 {
225         return get_irp_n_irgs_();
226 }
227
228 ir_graph *(get_irp_irg)(size_t pos)
229 {
230         return get_irp_irg_(pos);
231 }
232
233 size_t get_irp_last_idx(void)
234 {
235         return irp->max_irg_idx;
236 }
237
238 void set_irp_irg(size_t pos, ir_graph *irg)
239 {
240         assert(irp && irg);
241         assert(pos < ARR_LEN(irp->graphs));
242         irp->graphs[pos] = irg;
243 }
244
245 void add_irp_type(ir_type *typ)
246 {
247         assert(typ != NULL);
248         assert(irp);
249         ARR_APP1(ir_type *, irp->types, typ);
250 }
251
252 void remove_irp_type(ir_type *typ)
253 {
254         size_t i, l;
255         assert(typ);
256
257         l = ARR_LEN(irp->types);
258         for (i = 0; i < l; ++i) {
259                 if (irp->types[i] == typ) {
260                         for (; i < l - 1; ++i) {
261                                 irp->types[i] = irp->types[i+1];
262                         }
263                         ARR_SETLEN(ir_type *, irp->types, l - 1);
264                         break;
265                 }
266         }
267 }
268
269 size_t (get_irp_n_types) (void)
270 {
271         return get_irp_n_types_();
272 }
273
274 ir_type *(get_irp_type) (size_t pos)
275 {
276         return get_irp_type_(pos);
277 }
278
279 void set_irp_type(size_t pos, ir_type *typ)
280 {
281         assert(irp && typ);
282         assert(pos < ARR_LEN((irp)->types));
283         irp->types[pos] = typ;
284 }
285
286 void set_irp_prog_name(ident *name)
287 {
288         irp->name = name;
289 }
290 int irp_prog_name_is_set(void)
291 {
292         return irp->name != new_id_from_str(INITAL_PROG_NAME);
293 }
294 ident *get_irp_ident(void)
295 {
296         return irp->name;
297 }
298 const char  *get_irp_name(void)
299 {
300         return get_id_str(irp->name);
301 }
302
303
304 ir_graph *(get_const_code_irg)(void)
305 {
306         return get_const_code_irg_();
307 }
308
309 irg_phase_state get_irp_phase_state(void)
310 {
311         return irp->phase_state;
312 }
313
314 void set_irp_phase_state(irg_phase_state s)
315 {
316         irp->phase_state = s;
317 }
318
319 typedef struct pass_t {
320         ir_prog_pass_t  pass;
321         irg_phase_state state;
322 } pass_t;
323
324 /**
325  * Wrapper for setting the state of a whole ir_prog.
326  */
327 static int set_irp_phase_state_wrapper(ir_prog *irp, void *context)
328 {
329         pass_t         *pass  = (pass_t *)context;
330         irg_phase_state state = pass->state;
331         size_t          i, n;
332
333         (void)irp;
334
335         /* set the phase of all graphs */
336         for (i = 0, n = get_irp_n_irgs(); i < n; ++i)
337                 set_irg_phase_state(get_irp_irg(i), state);
338
339         /* set the irp phase */
340         set_irp_phase_state(state);
341
342         return 0;
343 }
344
345 ir_prog_pass_t *set_irp_phase_state_pass(const char *name, irg_phase_state state)
346 {
347         struct pass_t *pass = XMALLOCZ(struct pass_t);
348
349         def_prog_pass_constructor(
350                 &pass->pass, name ? name : "set_irp_phase", set_irp_phase_state_wrapper);
351         pass->state = state;
352
353         /* no dump/verify */
354         pass->pass.verify_irprog = ir_prog_no_verify;
355         pass->pass.dump_irprog   = ir_prog_no_dump;
356
357         return &pass->pass;
358 }
359
360 void set_irp_ip_outedges(ir_node ** ip_outedges)
361 {
362         irp->ip_outedges = ip_outedges;
363 }
364
365 ir_node** get_irp_ip_outedges(void)
366 {
367         return irp->ip_outedges;
368 }
369
370 irg_callee_info_state get_irp_callee_info_state(void)
371 {
372         return irp->callee_info_state;
373 }
374
375 void set_irp_callee_info_state(irg_callee_info_state s)
376 {
377         irp->callee_info_state = s;
378 }
379
380 ir_label_t (get_irp_next_label_nr)(void)
381 {
382         return get_irp_next_label_nr_();
383 }
384
385 void add_irp_asm(ident *asm_string)
386 {
387         ARR_APP1(ident *, irp->global_asms, asm_string);
388 }
389
390 size_t get_irp_n_asms(void)
391 {
392         return ARR_LEN(irp->global_asms);
393 }
394
395 ident *get_irp_asm(size_t pos)
396 {
397         assert(pos < get_irp_n_asms());
398         return irp->global_asms[pos];
399 }
400
401 int (get_irp_optimization_dumps)(void)
402 {
403         return get_irp_optimization_dumps_();
404 }
405
406 void (enable_irp_optimization_dumps)(void)
407 {
408         enable_irp_optimization_dumps_();
409 }
410
411 #ifndef NDEBUG
412 void irp_reserve_resources(ir_prog *irp, irp_resources_t resources)
413 {
414         assert((irp->reserved_resources & resources) == 0);
415         irp->reserved_resources |= resources;
416 }
417
418 void irp_free_resources(ir_prog *irp, irp_resources_t resources)
419 {
420         assert((irp->reserved_resources & resources) == resources);
421         irp->reserved_resources &= ~resources;
422 }
423
424 irp_resources_t irp_resources_reserved(const ir_prog *irp)
425 {
426         return irp->reserved_resources;
427 }
428 #endif