2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Entry point to the representation of a whole program.
23 * @author Goetz Lindenmaier, Michael Beck
32 #include "irgraph_t.h"
33 #include "pseudo_irg.h"
40 /** The initial name of the irp program. */
41 #define INITAL_PROG_NAME "no_name_set"
43 /* A variable from where everything in the ir can be accessed. */
45 ir_prog *get_irp(void) { return irp; }
48 * Create a new incomplete ir_prog.
50 static ir_prog *new_incomplete_ir_prog(void)
52 ir_prog *res = XMALLOCZ(ir_prog);
54 res->kind = k_ir_prog;
55 res->graphs = NEW_ARR_F(ir_graph *, 0);
56 res->pseudo_graphs = NEW_ARR_F(ir_graph *, 0);
57 res->types = NEW_ARR_F(ir_type *, 0);
58 res->modes = NEW_ARR_F(ir_mode *, 0);
59 res->opcodes = NEW_ARR_F(ir_op *, 0);
60 res->global_asms = NEW_ARR_F(ident *, 0);
61 res->last_region_nr = 0;
62 res->last_label_nr = 1; /* 0 is reserved as non-label */
66 res->reserved_resources = 0;
73 * Completes an incomplete irprog.
75 * @param irp the (yet incomplete) irp
76 * @param module_name the (module) name for this irp
78 static ir_prog *complete_ir_prog(ir_prog *irp, const char *module_name) {
81 #define IDENT(x) new_id_from_chars(x, sizeof(x) - 1)
83 irp->name = new_id_from_str(module_name);
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
93 for (i = 0; i < IR_SEGMENT_COUNT; ++i) {
94 remove_irp_type(irp->segment_types[i]);
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 irp->segment_types[IR_SEGMENT_CONSTRUCTORS]->flags |= tf_constructors;
101 irp->segment_types[IR_SEGMENT_DESTRUCTORS]->flags |= tf_destructors;
103 /* The global type is a class, but we cannot derive from it, so set
104 the final property to assist optimizations that checks for it. */
105 set_class_final(irp->segment_types[IR_SEGMENT_GLOBAL], 1);
107 irp->const_code_irg = new_const_code_irg();
108 irp->phase_state = phase_building;
109 irp->outs_state = outs_none;
110 irp->ip_outedges = NULL;
111 irp->trouts_state = outs_none;
112 irp->class_cast_state = ir_class_casts_transitive;
113 irp->globals_entity_usage_state = ir_entity_usage_not_computed;
119 /* initializes ir_prog. Constructs only the basic lists. */
120 void init_irprog_1(void) {
121 irp = new_incomplete_ir_prog();
124 /* Completes ir_prog. */
125 void init_irprog_2(void) {
126 (void)complete_ir_prog(irp, INITAL_PROG_NAME);
129 /* Create a new ir prog. Automatically called by init_firm through
131 ir_prog *new_ir_prog(const char *name) {
132 return complete_ir_prog(new_incomplete_ir_prog(), name);
135 /* frees all memory used by irp. Types in type list, irgs in irg
136 list and entities in global type must be freed by hand before. */
137 void free_ir_prog(void) {
139 for (i = 0; i < IR_SEGMENT_COUNT; ++i) {
140 free_type(irp->segment_types[i]);
143 free_ir_graph(irp->const_code_irg);
144 DEL_ARR_F(irp->graphs);
145 DEL_ARR_F(irp->pseudo_graphs);
146 DEL_ARR_F(irp->types);
147 DEL_ARR_F(irp->modes);
150 DEL_ARR_F(irp->opcodes);
151 DEL_ARR_F(irp->global_asms);
154 irp->const_code_irg = NULL;
158 /*- Functions to access the fields of ir_prog -*/
161 /* Access the main routine of the compiled program. */
162 ir_graph *get_irp_main_irg(void) {
164 return irp->main_irg;
167 void set_irp_main_irg(ir_graph *main_irg) {
169 irp->main_irg = main_irg;
172 ir_type *(get_segment_type)(ir_segment_t segment) {
173 return _get_segment_type(segment);
176 ir_type *(get_glob_type)(void) {
177 return _get_glob_type();
180 ir_type *(get_tls_type)(void) {
181 return _get_tls_type();
184 /* Adds irg to the list of ir graphs in irp. */
185 void add_irp_irg(ir_graph *irg) {
187 assert(irp && irp->graphs);
188 ARR_APP1(ir_graph *, irp->graphs, irg);
191 /* Removes irg from the list or irgs, shrinks the list by one. */
192 void remove_irp_irg_from_list(ir_graph *irg){
196 l = ARR_LEN(irp->graphs);
197 for (i = 0; i < l; i++) {
198 if (irp->graphs[i] == irg) {
200 for(; i < l - 1; i++) {
201 irp->graphs[i] = irp->graphs[i+1];
203 ARR_SETLEN(ir_graph*, irp->graphs, l - 1);
208 l = ARR_LEN(irp->pseudo_graphs);
209 for (i = 0; i < l; i++) {
210 if (irp->pseudo_graphs[i] == irg) {
211 for(; i < l - 1; i++) {
212 irp->pseudo_graphs[i] = irp->pseudo_graphs[i+1];
214 ARR_SETLEN(ir_graph*, irp->pseudo_graphs, l - 1);
221 /* Removes irg from the list or irgs, shrinks the list by one. */
222 void remove_irp_irg(ir_graph *irg){
224 remove_irp_irg_from_list(irg);
227 int (get_irp_n_irgs)(void) {
228 return _get_irp_n_irgs();
231 ir_graph *(get_irp_irg)(int pos){
232 return _get_irp_irg(pos);
235 int get_irp_last_idx(void) {
236 return irp->max_irg_idx;
239 void set_irp_irg(int pos, ir_graph *irg) {
241 assert(pos < (ARR_LEN(irp->graphs)));
242 irp->graphs[pos] = irg;
245 /* Gets the number of graphs _and_ pseudo graphs. */
246 int get_irp_n_allirgs(void) {
247 /* We can not call get_irp_n_irgs, as we end up in a recursion ... */
248 return ARR_LEN(irp->graphs) + get_irp_n_pseudo_irgs();
251 /* Returns the ir graph at position pos of all graphs (including
252 pseudo graphs). Visits first graphs, then pseudo graphs. */
253 ir_graph *get_irp_allirg(int pos) {
254 int n_irgs = ARR_LEN(irp->graphs);
257 return irp->graphs[pos];
259 return get_irp_pseudo_irg(pos-n_irgs);
263 /* Adds type to the list of types in irp. */
264 void add_irp_type(ir_type *typ) {
267 ARR_APP1(ir_type *, irp->types, typ);
270 /* Remove type from the list of types in irp. */
271 void remove_irp_type(ir_type *typ) {
275 for (i = ARR_LEN(irp->types) - 1; i >= 0; i--) {
276 if (irp->types[i] == typ) {
277 for(; i < (ARR_LEN(irp->types)) - 1; i++) {
278 irp->types[i] = irp->types[i+1];
280 ARR_SETLEN(ir_type *, irp->types, (ARR_LEN(irp->types)) - 1);
286 int (get_irp_n_types) (void) {
287 return _get_irp_n_types();
290 ir_type *(get_irp_type) (int pos) {
291 return _get_irp_type(pos);
294 void set_irp_type(int pos, ir_type *typ) {
296 assert(pos < (ARR_LEN((irp)->types)));
297 irp->types[pos] = typ;
300 /* Returns the number of all modes in the irp. */
301 int (get_irp_n_modes)(void) {
302 return _get_irp_n_modes();
305 /* Returns the mode at position pos in the irp. */
306 ir_mode *(get_irp_mode)(int pos) {
307 return _get_irp_mode(pos);
310 /* Adds mode to the list of modes in irp. */
311 void add_irp_mode(ir_mode *mode) {
312 assert(mode != NULL);
314 ARR_APP1(ir_mode *, irp->modes, mode);
317 /* Adds opcode to the list of opcodes in irp. */
318 void add_irp_opcode(ir_op *opcode) {
321 assert(opcode != NULL);
323 len = ARR_LEN(irp->opcodes);
325 if ((int) code >= len) {
326 ARR_RESIZE(ir_op*, irp->opcodes, code+1);
327 memset(&irp->opcodes[len], 0, (code-len+1) * sizeof(irp->opcodes[0]));
330 assert(irp->opcodes[code] == NULL && "opcode registered twice");
331 irp->opcodes[code] = opcode;
334 /* Removes opcode from the list of opcodes and shrinks the list by one. */
335 void remove_irp_opcode(ir_op *opcode) {
336 assert(opcode->code < ARR_LEN(irp->opcodes));
337 irp->opcodes[opcode->code] = NULL;
340 /* Returns the number of all opcodes in the irp. */
341 int (get_irp_n_opcodes)(void) {
342 return _get_irp_n_opcodes();
345 /* Returns the opcode at position pos in the irp. */
346 ir_op *(get_irp_opcode)(int pos) {
347 return _get_irp_opcode(pos);
350 /* Sets the generic function pointer of all opcodes to NULL */
351 void clear_irp_opcodes_generic_func(void) {
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;
360 /*- File name / executable name or the like -*/
361 void set_irp_prog_name(ident *name) {
364 int irp_prog_name_is_set(void) {
365 return irp->name != new_id_from_str(INITAL_PROG_NAME);
367 ident *get_irp_ident(void) {
370 const char *get_irp_name(void) {
371 return get_id_str(irp->name);
375 ir_graph *(get_const_code_irg)(void) {
376 return _get_const_code_irg();
379 irg_phase_state get_irp_phase_state(void) {
380 return irp->phase_state;
383 void set_irp_phase_state(irg_phase_state s) {
384 irp->phase_state = s;
387 irg_outs_state get_irp_ip_outs_state(void) {
388 return irp->outs_state;
391 void set_irp_ip_outs_inconsistent(void) {
392 irp->outs_state = outs_inconsistent;
395 void set_irp_ip_outedges(ir_node ** ip_outedges) {
396 irp->ip_outedges = ip_outedges;
399 ir_node** get_irp_ip_outedges(void) {
400 return irp->ip_outedges;
403 irg_callee_info_state get_irp_callee_info_state(void) {
404 return irp->callee_info_state;
407 void set_irp_callee_info_state(irg_callee_info_state s) {
408 irp->callee_info_state = s;
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();
416 /* Returns a new, unique label number. */
417 ir_label_t (get_irp_next_label_nr)(void) {
418 return _get_irp_next_label_nr();
421 /* Add a new global asm include */
422 void add_irp_asm(ident *asm_string) {
423 ARR_APP1(ident *, irp->global_asms, asm_string);
426 /* Return the number of global asm includes. */
427 int get_irp_n_asms(void) {
428 return ARR_LEN(irp->global_asms);
431 /* Return the global asm include at position pos. */
432 ident *get_irp_asm(int pos) {
433 assert(0 <= pos && pos < get_irp_n_asms());
434 return irp->global_asms[pos];
438 void irp_reserve_resources(ir_prog *irp, ir_resources_t resources) {
439 assert((resources & ~IR_RESOURCE_GLOBAL_MASK) == 0);
440 assert((irp->reserved_resources & resources) == 0);
441 irp->reserved_resources |= resources;
444 void irp_free_resources(ir_prog *irp, ir_resources_t resources) {
445 assert((irp->reserved_resources & resources) == resources);
446 irp->reserved_resources &= ~resources;
449 ir_resources_t irp_resources_reserved(const ir_prog *irp) {
450 return irp->reserved_resources;