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