- analysis part of an block merging optimization
[libfirm] / ir / ir / irprog.c
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 a whole program.
23  * @author   Goetz Lindenmaier, Michael Beck
24  * @date     2000
25  * @version  $Id$
26  */
27 #include "config.h"
28
29 #ifdef HAVE_STRING_H
30 # include <string.h>
31 #endif
32
33 #include "irprog_t.h"
34 #include "irgraph_t.h"
35 #include "pseudo_irg.h"
36 #include "array.h"
37 #include "error.h"
38 #include "obst.h"
39 #include "irop_t.h"
40 #include "irmemory.h"
41
42 /** The initial name of the irp program. */
43 #define INITAL_PROG_NAME "no_name_set"
44
45 /* A variable from where everything in the ir can be accessed. */
46 ir_prog *irp;
47 ir_prog *get_irp(void) { return irp; }
48
49 /**
50  *  Create a new incomplete ir_prog.
51  */
52 static ir_prog *new_incomplete_ir_prog(void)
53 {
54         ir_prog *res = XMALLOCZ(ir_prog);
55
56         res->kind           = k_ir_prog;
57         res->graphs         = NEW_ARR_F(ir_graph *, 0);
58         res->pseudo_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
67 #ifdef DEBUG_libfirm
68         res->max_node_nr    = 0;
69 #endif
70 #ifndef NDEBUG
71         res->reserved_resources = 0;
72 #endif
73
74         return res;
75 }
76
77 /** Completes an incomplete irprog. */
78 static ir_prog *complete_ir_prog(ir_prog *irp) {
79         int i;
80 #define IDENT(s) new_id_from_chars(s, sizeof(s)-1)
81
82         irp->name              = IDENT(INITAL_PROG_NAME);
83
84         irp->segment_types[IR_SEGMENT_GLOBAL] = new_type_class(IDENT("GlobalType"));
85         irp->segment_types[IR_SEGMENT_THREAD_LOCAL]
86                 = new_type_struct(IDENT("ThreadLocal"));
87         irp->segment_types[IR_SEGMENT_CONSTRUCTORS]
88                 = new_type_struct(IDENT("Constructors"));
89         irp->segment_types[IR_SEGMENT_DESTRUCTORS]
90                 = new_type_struct(IDENT("Destructors"));
91         /* Remove these types from type list.  Must be treated differently than
92            other types. */
93         for (i = 0; i < IR_SEGMENT_COUNT; ++i) {
94                 remove_irp_type(irp->segment_types[i]);
95         }
96
97         /* Set these flags for debugging. */
98         irp->segment_types[IR_SEGMENT_GLOBAL]->flags       |= tf_global_type;
99         irp->segment_types[IR_SEGMENT_THREAD_LOCAL]->flags |= tf_tls_type;
100
101         /* The global type is a class, but we cannot derive from it, so set
102            the final property to assist optimizations that checks for it. */
103         set_class_final(irp->segment_types[IR_SEGMENT_GLOBAL], 1);
104
105         irp->const_code_irg   = new_const_code_irg();
106
107         irp->phase_state                = phase_building;
108         irp->outs_state                 = outs_none;
109         irp->ip_outedges                = NULL;
110         irp->trouts_state               = outs_none;
111         irp->class_cast_state           = ir_class_casts_transitive;
112         irp->globals_entity_usage_state = ir_entity_usage_not_computed;
113
114         return irp;
115 #undef IDENT
116 }
117
118 /* initializes ir_prog. Constructs only the basic lists. */
119 void init_irprog_1(void) {
120         irp = new_incomplete_ir_prog();
121 }
122
123 /* Completes ir_prog. */
124 void init_irprog_2(void) {
125         complete_ir_prog(irp);
126 }
127
128 /* Create a new ir prog. Automatically called by init_firm through
129    init_irprog. */
130 ir_prog *new_ir_prog(void) {
131         return complete_ir_prog(new_incomplete_ir_prog());
132 }
133
134 /* frees all memory used by irp.  Types in type list, irgs in irg
135    list and entities in global type must be freed by hand before. */
136 void free_ir_prog(void) {
137         int i;
138         for (i = 0; i < IR_SEGMENT_COUNT; ++i) {
139                 free_type(irp->segment_types[i]);
140         }
141
142         free_ir_graph(irp->const_code_irg);
143         DEL_ARR_F(irp->graphs);
144         DEL_ARR_F(irp->pseudo_graphs);
145         DEL_ARR_F(irp->types);
146         DEL_ARR_F(irp->modes);
147
148         finish_op();
149         DEL_ARR_F(irp->opcodes);
150         DEL_ARR_F(irp->global_asms);
151
152         irp->name           = NULL;
153         irp->const_code_irg = NULL;
154         irp->kind           = k_BAD;
155 }
156
157 /*- Functions to access the fields of ir_prog -*/
158
159
160 /* Access the main routine of the compiled program. */
161 ir_graph *get_irp_main_irg(void) {
162         assert(irp);
163         return irp->main_irg;
164 }
165
166 void set_irp_main_irg(ir_graph *main_irg) {
167         assert(irp);
168         irp->main_irg = main_irg;
169 }
170
171 ir_type *(get_segment_type)(ir_segment_t segment) {
172         return _get_segment_type(segment);
173 }
174
175 ir_type *(get_glob_type)(void) {
176         return _get_glob_type();
177 }
178
179 ir_type *(get_tls_type)(void) {
180         return _get_tls_type();
181 }
182
183 /* Adds irg to the list of ir graphs in irp. */
184 void add_irp_irg(ir_graph *irg) {
185         assert(irg != NULL);
186         assert(irp && irp->graphs);
187         ARR_APP1(ir_graph *, irp->graphs, irg);
188 }
189
190 /* Removes irg from the list or irgs, shrinks the list by one. */
191 void remove_irp_irg_from_list(ir_graph *irg){
192         int i, found = 0;
193
194         assert(irg);
195         for (i = 0; i < (ARR_LEN (irp->graphs)); i++) {
196                 if (irp->graphs[i] == irg) {
197                         found = 1;
198                         for(; i < (ARR_LEN (irp->graphs)) - 1; i++) {
199                                 irp->graphs[i] = irp->graphs[i+1];
200                         }
201                         ARR_SETLEN(ir_graph*, irp->graphs, (ARR_LEN(irp->graphs)) - 1);
202                         break;
203                 }
204         }
205         if (!found) {
206                 for (i = 0; i < (ARR_LEN (irp->pseudo_graphs)); i++) {
207                         if (irp->pseudo_graphs[i] == irg) {
208                                 for(; i < (ARR_LEN (irp->pseudo_graphs)) - 1; i++) {
209                                         irp->pseudo_graphs[i] = irp->pseudo_graphs[i+1];
210                                 }
211                                 ARR_SETLEN(ir_graph*, irp->pseudo_graphs, (ARR_LEN(irp->pseudo_graphs)) - 1);
212                                 break;
213                         }
214                 }
215         }
216 }
217
218 /* Removes irg from the list or irgs, shrinks the list by one. */
219 void remove_irp_irg(ir_graph *irg){
220         assert(irg);
221         free_ir_graph(irg);
222         remove_irp_irg_from_list(irg);
223 }
224
225 int (get_irp_n_irgs)(void) {
226         return _get_irp_n_irgs();
227 }
228
229 ir_graph *(get_irp_irg)(int pos){
230         return _get_irp_irg(pos);
231 }
232
233 int get_irp_last_idx(void) {
234         return irp->max_irg_idx;
235 }
236
237 void set_irp_irg(int pos, ir_graph *irg) {
238         assert(irp && irg);
239         assert(pos < (ARR_LEN(irp->graphs)));
240         irp->graphs[pos] = irg;
241 }
242
243 /* Gets the number of graphs _and_ pseudo graphs. */
244 int get_irp_n_allirgs(void) {
245         /* We can not call get_irp_n_irgs, as we end up in a recursion ... */
246         return ARR_LEN(irp->graphs) + get_irp_n_pseudo_irgs();
247 }
248
249 /* Returns the ir graph at position pos of all graphs (including
250  pseudo graphs).  Visits first graphs, then pseudo graphs. */
251 ir_graph *get_irp_allirg(int pos) {
252         int n_irgs = ARR_LEN(irp->graphs);
253         assert(0 <= pos);
254         if (pos < n_irgs) {
255                 return irp->graphs[pos];
256         } else {
257                 return get_irp_pseudo_irg(pos-n_irgs);
258         }
259 }
260
261 /* Adds type to the list of types in irp. */
262 void add_irp_type(ir_type *typ) {
263         assert(typ != NULL);
264         assert(irp);
265         ARR_APP1 (ir_type *, irp->types, typ);
266 }
267
268 /* Remove type form the list of types in irp. */
269 void remove_irp_type(ir_type *typ) {
270         int i;
271         assert(typ);
272
273         for (i = ARR_LEN(irp->types) -1; i >= 0; i--) {
274                 if (irp->types[i] == typ) {
275                         for(; i < (ARR_LEN(irp->types)) - 1; i++) {
276                                 irp->types[i] = irp->types[i+1];
277                         }
278                         ARR_SETLEN(ir_type *, irp->types, (ARR_LEN(irp->types)) - 1);
279                         break;
280                 }
281         }
282 }
283
284 int (get_irp_n_types) (void) {
285         return _get_irp_n_types();
286 }
287
288 ir_type *(get_irp_type) (int pos) {
289         return _get_irp_type(pos);
290 }
291
292 void set_irp_type(int pos, ir_type *typ) {
293         assert(irp && typ);
294         assert(pos < (ARR_LEN((irp)->types)));
295         irp->types[pos] = typ;
296 }
297
298 /* Returns the number of all modes in the irp. */
299 int (get_irp_n_modes)(void) {
300         return _get_irp_n_modes();
301 }
302
303 /* Returns the mode at position pos in the irp. */
304 ir_mode *(get_irp_mode)(int pos) {
305         return _get_irp_mode(pos);
306 }
307
308 /* Adds mode to the list of modes in irp. */
309 void add_irp_mode(ir_mode *mode) {
310         assert(mode != NULL);
311         assert(irp);
312         ARR_APP1(ir_mode *, irp->modes, mode);
313 }
314
315 /* Adds opcode to the list of opcodes in irp. */
316 void add_irp_opcode(ir_op *opcode) {
317         assert(opcode != NULL);
318         assert(irp);
319         assert(opcode->code == (unsigned) ARR_LEN(irp->opcodes) && "new_ir_op() called in wrong order");
320         ARR_APP1(ir_op *, irp->opcodes, opcode);
321 }
322
323 /* Removes opcode from the list of opcodes and shrinks the list by one. */
324 void remove_irp_opcode(ir_op *opcode) {
325         int i;
326
327         assert(opcode);
328         for (i = ARR_LEN(irp->opcodes) -1; i >= 0; i--) {
329                 if (irp->opcodes[i] != opcode)
330                         continue;
331                 for (; i < (ARR_LEN(irp->opcodes)) - 1; i++) {
332                         irp->opcodes[i] = irp->opcodes[i+1];
333                 }
334                 ARR_SETLEN(ir_op *, irp->opcodes, (ARR_LEN(irp->opcodes)) - 1);
335                 return;
336         }
337         panic("Deleting unknown opcode");
338 }
339
340 /* Returns the number of all opcodes in the irp. */
341 int (get_irp_n_opcodes)(void) {
342         return _get_irp_n_opcodes();
343 }
344
345 /* Returns the opcode at position pos in the irp. */
346 ir_op *(get_irp_opcode)(int pos) {
347         return _get_irp_opcode(pos);
348 }
349
350 /* Sets the generic function pointer of all opcodes to NULL */
351 void  clear_irp_opcodes_generic_func(void) {
352         int i;
353
354         for (i = get_irp_n_opcodes() - 1; i >= 0; --i) {
355                 ir_op *op = get_irp_opcode(i);
356                 op->ops.generic = (op_func)NULL;
357         }
358 }
359
360 /*- File name / executable name or the like -*/
361 void   set_irp_prog_name(ident *name) {
362         irp->name = name;
363 }
364 int irp_prog_name_is_set(void) {
365         return irp->name != new_id_from_str(INITAL_PROG_NAME);
366 }
367 ident *get_irp_prog_ident(void) {
368         return irp->name;
369 }
370 const char  *get_irp_prog_name(void) {
371         return get_id_str(irp->name);
372 }
373
374
375 ir_graph *(get_const_code_irg)(void) {
376         return _get_const_code_irg();
377 }
378
379 irg_phase_state get_irp_phase_state(void) {
380         return irp->phase_state;
381 }
382
383 void set_irp_phase_state(irg_phase_state s) {
384         irp->phase_state = s;
385 }
386
387 irg_outs_state get_irp_ip_outs_state(void) {
388         return irp->outs_state;
389 }
390
391 void set_irp_ip_outs_inconsistent(void) {
392         irp->outs_state = outs_inconsistent;
393 }
394
395 void set_irp_ip_outedges(ir_node ** ip_outedges) {
396         irp->ip_outedges = ip_outedges;
397 }
398
399 ir_node** get_irp_ip_outedges(void) {
400         return irp->ip_outedges;
401 }
402
403 irg_callee_info_state get_irp_callee_info_state(void) {
404         return irp->callee_info_state;
405 }
406
407 void set_irp_callee_info_state(irg_callee_info_state s) {
408         irp->callee_info_state = s;
409 }
410
411 /* Returns a new, unique exception region number. */
412 ir_exc_region_t (get_irp_next_region_nr)(void) {
413         return _get_irp_next_region_nr();
414 }
415
416 /* Returns a new, unique label number. */
417 ir_label_t (get_irp_next_label_nr)(void) {
418         return _get_irp_next_label_nr();
419 }
420
421 /* Add a new global asm include */
422 void add_irp_asm(ident *asm_string) {
423         ARR_APP1(ident *, irp->global_asms, asm_string);
424 }
425
426 /* Return the number of global asm includes. */
427 int get_irp_n_asms(void) {
428         return ARR_LEN(irp->global_asms);
429 }
430
431 /* Return the global asm include at position pos. */
432 ident *get_irp_asm(int pos) {
433         assert(pos <= 0 && pos < get_irp_n_asms());
434         return irp->global_asms[pos];
435 }
436
437 #ifndef NDEBUG
438 void irp_reserve_resources(ir_prog *irp, ir_resources_t resources) {
439         assert((irp->reserved_resources & resources) == 0);
440         irp->reserved_resources |= resources;
441 }
442
443 void irp_free_resources(ir_prog *irp, ir_resources_t resources) {
444         assert((irp->reserved_resources & resources) == resources);
445         irp->reserved_resources &= ~resources;
446 }
447
448 ir_resources_t irp_resources_reserved(const ir_prog *irp) {
449         return irp->reserved_resources;
450 }
451 #endif