Move current_ir_graph from ir_graph to ir_cons
[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->modes          = NEW_ARR_F(ir_mode *, 0);
61         res->opcodes        = NEW_ARR_F(ir_op *, 0);
62         res->global_asms    = NEW_ARR_F(ident *, 0);
63         res->last_region_nr = 0;
64         res->last_label_nr  = 1;  /* 0 is reserved as non-label */
65         res->max_irg_idx    = 0;
66         res->max_node_nr    = 0;
67 #ifndef NDEBUG
68         res->reserved_resources = IR_RESOURCE_NONE;
69 #endif
70
71         return res;
72 }
73
74 /**
75  * Completes an incomplete irprog.
76  *
77  * @param irp          the (yet incomplete) irp
78  * @param module_name  the (module) name for this irp
79  */
80 static ir_prog *complete_ir_prog(ir_prog *irp, const char *module_name)
81 {
82 #define IDENT(x)  new_id_from_chars(x, sizeof(x) - 1)
83
84         irp->name = new_id_from_str(module_name);
85         irp->segment_types[IR_SEGMENT_GLOBAL]
86                 = new_type_class(IDENT("GlobalType"));
87         irp->segment_types[IR_SEGMENT_THREAD_LOCAL]
88                 = new_type_struct(IDENT("ThreadLocal"));
89         irp->segment_types[IR_SEGMENT_CONSTRUCTORS]
90                 = new_type_class(IDENT("Constructors"));
91         irp->segment_types[IR_SEGMENT_DESTRUCTORS]
92                 = new_type_class(IDENT("Destructors"));
93
94         /* Set these flags for debugging. */
95         irp->segment_types[IR_SEGMENT_GLOBAL]->flags       |= tf_segment|tf_global_type;
96         irp->segment_types[IR_SEGMENT_THREAD_LOCAL]->flags |= tf_segment|tf_tls_type;
97         irp->segment_types[IR_SEGMENT_CONSTRUCTORS]->flags |= tf_segment|tf_constructors;
98         irp->segment_types[IR_SEGMENT_DESTRUCTORS]->flags  |= tf_segment|tf_destructors;
99
100         /* The global type is a class, but we cannot derive from it, so set
101            the final property to assist optimizations that checks for it. */
102         set_class_final(irp->segment_types[IR_SEGMENT_GLOBAL], 1);
103
104         irp->const_code_irg             = new_const_code_irg();
105         irp->phase_state                = phase_building;
106         irp->class_cast_state           = ir_class_casts_transitive;
107         irp->globals_entity_usage_state = ir_entity_usage_not_computed;
108
109         current_ir_graph = irp->const_code_irg;
110
111         return irp;
112 #undef IDENT
113 }
114
115 void init_irprog_1(void)
116 {
117         irp = new_incomplete_ir_prog();
118 }
119
120 void init_irprog_2(void)
121 {
122         (void)complete_ir_prog(irp, INITAL_PROG_NAME);
123 }
124
125 ir_prog *new_ir_prog(const char *name)
126 {
127         return complete_ir_prog(new_incomplete_ir_prog(), name);
128 }
129
130 void free_ir_prog(void)
131 {
132         size_t i;
133         /* must iterate backwards here */
134         for (i = get_irp_n_irgs(); i > 0;)
135                 free_ir_graph(get_irp_irg(--i));
136
137         free_type_entities(get_glob_type());
138         /* must iterate backwards here */
139         for (i = get_irp_n_types(); i > 0;)
140                 free_type_entities(get_irp_type(--i));
141
142         for (i = get_irp_n_types(); i > 0;)
143                 free_type(get_irp_type(--i));
144
145         free_ir_graph(irp->const_code_irg);
146         DEL_ARR_F(irp->graphs);
147         DEL_ARR_F(irp->types);
148         DEL_ARR_F(irp->modes);
149
150         finish_op();
151         DEL_ARR_F(irp->opcodes);
152         DEL_ARR_F(irp->global_asms);
153
154         irp->name           = NULL;
155         irp->const_code_irg = NULL;
156         irp->kind           = k_BAD;
157 }
158
159 ir_graph *get_irp_main_irg(void)
160 {
161         assert(irp);
162         return irp->main_irg;
163 }
164
165 void set_irp_main_irg(ir_graph *main_irg)
166 {
167         assert(irp);
168         irp->main_irg = main_irg;
169 }
170
171 ir_type *(get_segment_type)(ir_segment_t segment)
172 {
173         return get_segment_type_(segment);
174 }
175
176 void set_segment_type(ir_segment_t segment, ir_type *new_type)
177 {
178         assert(segment <= IR_SEGMENT_LAST);
179         irp->segment_types[segment] = new_type;
180 }
181
182 ir_type *(get_glob_type)(void)
183 {
184         return get_glob_type_();
185 }
186
187 ir_type *(get_tls_type)(void)
188 {
189         return get_tls_type_();
190 }
191
192 void add_irp_irg(ir_graph *irg)
193 {
194         assert(irg != NULL);
195         assert(irp && irp->graphs);
196         ARR_APP1(ir_graph *, irp->graphs, irg);
197 }
198
199 void remove_irp_irg_from_list(ir_graph *irg)
200 {
201         size_t i, l;
202
203         assert(irg);
204         l = ARR_LEN(irp->graphs);
205         for (i = 0; i < l; ++i) {
206                 if (irp->graphs[i] == irg) {
207                         for (; i < l - 1; ++i) {
208                                 irp->graphs[i] = irp->graphs[i+1];
209                         }
210                         ARR_SETLEN(ir_graph*, irp->graphs, l - 1);
211                         break;
212                 }
213         }
214 }
215
216 void remove_irp_irg(ir_graph *irg)
217 {
218         free_ir_graph(irg);
219         remove_irp_irg_from_list(irg);
220 }
221
222 size_t (get_irp_n_irgs)(void)
223 {
224         return get_irp_n_irgs_();
225 }
226
227 ir_graph *(get_irp_irg)(size_t pos)
228 {
229         return get_irp_irg_(pos);
230 }
231
232 size_t get_irp_last_idx(void)
233 {
234         return irp->max_irg_idx;
235 }
236
237 void set_irp_irg(size_t pos, ir_graph *irg)
238 {
239         assert(irp && irg);
240         assert(pos < ARR_LEN(irp->graphs));
241         irp->graphs[pos] = irg;
242 }
243
244 void add_irp_type(ir_type *typ)
245 {
246         assert(typ != NULL);
247         assert(irp);
248         ARR_APP1(ir_type *, irp->types, typ);
249 }
250
251 void remove_irp_type(ir_type *typ)
252 {
253         size_t i, l;
254         assert(typ);
255
256         l = ARR_LEN(irp->types);
257         for (i = 0; i < l; ++i) {
258                 if (irp->types[i] == typ) {
259                         for (; i < l - 1; ++i) {
260                                 irp->types[i] = irp->types[i+1];
261                         }
262                         ARR_SETLEN(ir_type *, irp->types, l - 1);
263                         break;
264                 }
265         }
266 }
267
268 size_t (get_irp_n_types) (void)
269 {
270         return get_irp_n_types_();
271 }
272
273 ir_type *(get_irp_type) (size_t pos)
274 {
275         return get_irp_type_(pos);
276 }
277
278 void set_irp_type(size_t pos, ir_type *typ)
279 {
280         assert(irp && typ);
281         assert(pos < ARR_LEN((irp)->types));
282         irp->types[pos] = typ;
283 }
284
285 size_t (get_irp_n_modes)(void)
286 {
287         return get_irp_n_modes_();
288 }
289
290 ir_mode *(get_irp_mode)(size_t pos)
291 {
292         return get_irp_mode_(pos);
293 }
294
295 void add_irp_mode(ir_mode *mode)
296 {
297         assert(mode != NULL);
298         assert(irp);
299         ARR_APP1(ir_mode *, irp->modes, mode);
300 }
301
302 void add_irp_opcode(ir_op *opcode)
303 {
304         size_t len;
305         size_t code;
306         assert(opcode != NULL);
307         assert(irp);
308         len  = ARR_LEN(irp->opcodes);
309         code = opcode->code;
310         if (code >= len) {
311                 ARR_RESIZE(ir_op*, irp->opcodes, code+1);
312                 memset(&irp->opcodes[len], 0, (code-len+1) * sizeof(irp->opcodes[0]));
313         }
314
315         assert(irp->opcodes[code] == NULL && "opcode registered twice");
316         irp->opcodes[code] = opcode;
317 }
318
319 void remove_irp_opcode(ir_op *opcode)
320 {
321         assert(opcode->code < ARR_LEN(irp->opcodes));
322         irp->opcodes[opcode->code] = NULL;
323 }
324
325 size_t (get_irp_n_opcodes)(void)
326 {
327         return get_irp_n_opcodes_();
328 }
329
330 ir_op *(get_irp_opcode)(size_t pos)
331 {
332         return get_irp_opcode_(pos);
333 }
334
335 void clear_irp_opcodes_generic_func(void)
336 {
337         size_t i, n;
338
339         for (i = 0, n = get_irp_n_opcodes(); i < n; ++i) {
340                 ir_op *op = get_irp_opcode(i);
341                 op->ops.generic = (op_func)NULL;
342         }
343 }
344
345 void set_irp_prog_name(ident *name)
346 {
347         irp->name = name;
348 }
349 int irp_prog_name_is_set(void)
350 {
351         return irp->name != new_id_from_str(INITAL_PROG_NAME);
352 }
353 ident *get_irp_ident(void)
354 {
355         return irp->name;
356 }
357 const char  *get_irp_name(void)
358 {
359         return get_id_str(irp->name);
360 }
361
362
363 ir_graph *(get_const_code_irg)(void)
364 {
365         return get_const_code_irg_();
366 }
367
368 irg_phase_state get_irp_phase_state(void)
369 {
370         return irp->phase_state;
371 }
372
373 void set_irp_phase_state(irg_phase_state s)
374 {
375         irp->phase_state = s;
376 }
377
378 typedef struct pass_t {
379         ir_prog_pass_t  pass;
380         irg_phase_state state;
381 } pass_t;
382
383 /**
384  * Wrapper for setting the state of a whole ir_prog.
385  */
386 static int set_irp_phase_state_wrapper(ir_prog *irp, void *context)
387 {
388         pass_t         *pass  = (pass_t *)context;
389         irg_phase_state state = pass->state;
390         size_t          i, n;
391
392         (void)irp;
393
394         /* set the phase of all graphs */
395         for (i = 0, n = get_irp_n_irgs(); i < n; ++i)
396                 set_irg_phase_state(get_irp_irg(i), state);
397
398         /* set the irp phase */
399         set_irp_phase_state(state);
400
401         return 0;
402 }
403
404 ir_prog_pass_t *set_irp_phase_state_pass(const char *name, irg_phase_state state)
405 {
406         struct pass_t *pass = XMALLOCZ(struct pass_t);
407
408         def_prog_pass_constructor(
409                 &pass->pass, name ? name : "set_irp_phase", set_irp_phase_state_wrapper);
410         pass->state = state;
411
412         /* no dump/verify */
413         pass->pass.verify_irprog = ir_prog_no_verify;
414         pass->pass.dump_irprog   = ir_prog_no_dump;
415
416         return &pass->pass;
417 }
418
419 void set_irp_ip_outedges(ir_node ** ip_outedges)
420 {
421         irp->ip_outedges = ip_outedges;
422 }
423
424 ir_node** get_irp_ip_outedges(void)
425 {
426         return irp->ip_outedges;
427 }
428
429 irg_callee_info_state get_irp_callee_info_state(void)
430 {
431         return irp->callee_info_state;
432 }
433
434 void set_irp_callee_info_state(irg_callee_info_state s)
435 {
436         irp->callee_info_state = s;
437 }
438
439 ir_label_t (get_irp_next_label_nr)(void)
440 {
441         return get_irp_next_label_nr_();
442 }
443
444 void add_irp_asm(ident *asm_string)
445 {
446         ARR_APP1(ident *, irp->global_asms, asm_string);
447 }
448
449 size_t get_irp_n_asms(void)
450 {
451         return ARR_LEN(irp->global_asms);
452 }
453
454 ident *get_irp_asm(size_t pos)
455 {
456         assert(pos < get_irp_n_asms());
457         return irp->global_asms[pos];
458 }
459
460 int (get_irp_optimization_dumps)(void)
461 {
462         return get_irp_optimization_dumps_();
463 }
464
465 void (enable_irp_optimization_dumps)(void)
466 {
467         enable_irp_optimization_dumps_();
468 }
469
470 #ifndef NDEBUG
471 void irp_reserve_resources(ir_prog *irp, irp_resources_t resources)
472 {
473         assert((irp->reserved_resources & resources) == 0);
474         irp->reserved_resources |= resources;
475 }
476
477 void irp_free_resources(ir_prog *irp, irp_resources_t resources)
478 {
479         assert((irp->reserved_resources & resources) == resources);
480         irp->reserved_resources &= ~resources;
481 }
482
483 irp_resources_t irp_resources_reserved(const ir_prog *irp)
484 {
485         return irp->reserved_resources;
486 }
487 #endif