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