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
36 #include "irgraph_t.h"
37 #include "pseudo_irg.h"
44 /** The initial name of the irp program. */
45 #define INITAL_PROG_NAME "no_name_set"
47 /* A variable from where everything in the ir can be accessed. */
49 ir_prog *get_irp(void) { return irp; }
52 * Create a new incomplete ir_prog.
54 static ir_prog *new_incomplete_ir_prog(void) {
57 res = xmalloc(sizeof(*res));
58 memset(res, 0, sizeof(*res));
60 res->kind = k_ir_prog;
61 res->graphs = NEW_ARR_F(ir_graph *, 0);
62 res->pseudo_graphs = NEW_ARR_F(ir_graph *, 0);
63 res->types = NEW_ARR_F(ir_type *, 0);
64 res->modes = NEW_ARR_F(ir_mode *, 0);
65 res->opcodes = NEW_ARR_F(ir_op *, 0);
66 res->global_asms = NEW_ARR_F(ident *, 0);
67 res->last_region_nr = 0;
68 res->last_label_nr = 1; /* 0 is reserved as non-label */
78 /** Completes an incomplete irprog. */
79 static ir_prog *complete_ir_prog(ir_prog *irp) {
81 #define IDENT(s) new_id_from_chars(s, sizeof(s)-1)
83 irp->name = IDENT(INITAL_PROG_NAME);
85 irp->segment_types[IR_SEGMENT_GLOBAL] = 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_struct(IDENT("Constructors"));
90 irp->segment_types[IR_SEGMENT_DESTRUCTORS]
91 = new_type_struct(IDENT("Destructors"));
92 /* Remove these types from type list. Must be treated differently than
94 for (i = 0; i < IR_SEGMENT_COUNT; ++i) {
95 remove_irp_type(irp->segment_types[i]);
98 /* Set these flags for debugging. */
99 irp->segment_types[IR_SEGMENT_GLOBAL]->flags |= tf_global_type;
100 irp->segment_types[IR_SEGMENT_THREAD_LOCAL]->flags |= tf_tls_type;
102 /* The global type is a class, but we cannot derive from it, so set
103 the final property to assist optimizations that checks for it. */
104 set_class_final(irp->segment_types[IR_SEGMENT_GLOBAL], 1);
106 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_adr_taken_state = ir_address_taken_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 complete_ir_prog(irp);
129 /* Create a new ir prog. Automatically called by init_firm through
131 ir_prog *new_ir_prog(void) {
132 return complete_ir_prog(new_incomplete_ir_prog());
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 for (i = 0; i < (ARR_LEN (irp->graphs)); i++) {
197 if (irp->graphs[i] == irg) {
199 for(; i < (ARR_LEN (irp->graphs)) - 1; i++) {
200 irp->graphs[i] = irp->graphs[i+1];
202 ARR_SETLEN(ir_graph*, irp->graphs, (ARR_LEN(irp->graphs)) - 1);
207 for (i = 0; i < (ARR_LEN (irp->pseudo_graphs)); i++) {
208 if (irp->pseudo_graphs[i] == irg) {
209 for(; i < (ARR_LEN (irp->pseudo_graphs)) - 1; i++) {
210 irp->pseudo_graphs[i] = irp->pseudo_graphs[i+1];
212 ARR_SETLEN(ir_graph*, irp->pseudo_graphs, (ARR_LEN(irp->pseudo_graphs)) - 1);
219 /* Removes irg from the list or irgs, shrinks the list by one. */
220 void remove_irp_irg(ir_graph *irg){
223 remove_irp_irg_from_list(irg);
226 int (get_irp_n_irgs)(void) {
227 return _get_irp_n_irgs();
230 ir_graph *(get_irp_irg)(int pos){
231 return _get_irp_irg(pos);
234 int get_irp_last_idx(void) {
235 return irp->max_irg_idx;
238 void set_irp_irg(int pos, ir_graph *irg) {
240 assert(pos < (ARR_LEN(irp->graphs)));
241 irp->graphs[pos] = irg;
244 /* Gets the number of graphs _and_ pseudo graphs. */
245 int get_irp_n_allirgs(void) {
246 /* We can not call get_irp_n_irgs, as we end up in a recursion ... */
247 return ARR_LEN(irp->graphs) + get_irp_n_pseudo_irgs();
250 /* Returns the ir graph at position pos of all graphs (including
251 pseudo graphs). Visits first graphs, then pseudo graphs. */
252 ir_graph *get_irp_allirg(int pos) {
253 int n_irgs = ARR_LEN(irp->graphs);
256 return irp->graphs[pos];
258 return get_irp_pseudo_irg(pos-n_irgs);
262 /* Adds type to the list of types in irp. */
263 void add_irp_type(ir_type *typ) {
266 ARR_APP1 (ir_type *, irp->types, typ);
269 /* Remove type form the list of types in irp. */
270 void remove_irp_type(ir_type *typ) {
274 for (i = ARR_LEN(irp->types) -1; i >= 0; i--) {
275 if (irp->types[i] == typ) {
276 for(; i < (ARR_LEN(irp->types)) - 1; i++) {
277 irp->types[i] = irp->types[i+1];
279 ARR_SETLEN(ir_type *, irp->types, (ARR_LEN(irp->types)) - 1);
285 int (get_irp_n_types) (void) {
286 return _get_irp_n_types();
289 ir_type *(get_irp_type) (int pos) {
290 return _get_irp_type(pos);
293 void set_irp_type(int pos, ir_type *typ) {
295 assert(pos < (ARR_LEN((irp)->types)));
296 irp->types[pos] = typ;
299 /* Returns the number of all modes in the irp. */
300 int (get_irp_n_modes)(void) {
301 return _get_irp_n_modes();
304 /* Returns the mode at position pos in the irp. */
305 ir_mode *(get_irp_mode)(int pos) {
306 return _get_irp_mode(pos);
309 /* Adds mode to the list of modes in irp. */
310 void add_irp_mode(ir_mode *mode) {
311 assert(mode != NULL);
313 ARR_APP1(ir_mode *, irp->modes, mode);
316 /* Adds opcode to the list of opcodes in irp. */
317 void add_irp_opcode(ir_op *opcode) {
318 assert(opcode != NULL);
320 assert(opcode->code == (unsigned) ARR_LEN(irp->opcodes) && "new_ir_op() called in wrong order");
321 ARR_APP1(ir_op *, irp->opcodes, opcode);
324 /* Removes opcode from the list of opcodes and shrinks the list by one. */
325 void remove_irp_opcode(ir_op *opcode) {
329 for (i = ARR_LEN(irp->opcodes) -1; i >= 0; i--) {
330 if (irp->opcodes[i] != opcode)
332 for (; i < (ARR_LEN(irp->opcodes)) - 1; i++) {
333 irp->opcodes[i] = irp->opcodes[i+1];
335 ARR_SETLEN(ir_op *, irp->opcodes, (ARR_LEN(irp->opcodes)) - 1);
338 panic("Deleting unknown opcode");
341 /* Returns the number of all opcodes in the irp. */
342 int (get_irp_n_opcodes)(void) {
343 return _get_irp_n_opcodes();
346 /* Returns the opcode at position pos in the irp. */
347 ir_op *(get_irp_opcode)(int pos) {
348 return _get_irp_opcode(pos);
351 /* Sets the generic function pointer of all opcodes to NULL */
352 void clear_irp_opcodes_generic_func(void) {
355 for (i = get_irp_n_opcodes() - 1; i >= 0; --i) {
356 ir_op *op = get_irp_opcode(i);
357 op->ops.generic = (op_func)NULL;
361 /*- File name / executable name or the like -*/
362 void set_irp_prog_name(ident *name) {
365 int irp_prog_name_is_set(void) {
366 return irp->name != new_id_from_str(INITAL_PROG_NAME);
368 ident *get_irp_prog_ident(void) {
371 const char *get_irp_prog_name(void) {
372 return get_id_str(irp->name);
376 ir_graph *(get_const_code_irg)(void) {
377 return _get_const_code_irg();
380 irg_phase_state get_irp_phase_state(void) {
381 return irp->phase_state;
384 void set_irp_phase_state(irg_phase_state s) {
385 irp->phase_state = s;
388 irg_outs_state get_irp_ip_outs_state(void) {
389 return irp->outs_state;
392 void set_irp_ip_outs_inconsistent(void) {
393 irp->outs_state = outs_inconsistent;
396 void set_irp_ip_outedges(ir_node ** ip_outedges) {
397 irp->ip_outedges = ip_outedges;
400 ir_node** get_irp_ip_outedges(void) {
401 return irp->ip_outedges;
404 irg_callee_info_state get_irp_callee_info_state(void) {
405 return irp->callee_info_state;
408 void set_irp_callee_info_state(irg_callee_info_state s) {
409 irp->callee_info_state = s;
412 /* Returns a new, unique exception region number. */
413 ir_exc_region_t (get_irp_next_region_nr)(void) {
414 return _get_irp_next_region_nr();
417 /* Returns a new, unique label number. */
418 ir_label_t (get_irp_next_label_nr)(void) {
419 return _get_irp_next_label_nr();
422 /* Add a new global asm include */
423 void add_irp_asm(ident *asm_string) {
424 ARR_APP1(ident *, irp->global_asms, asm_string);
427 /* Return the number of global asm includes. */
428 int get_irp_n_asms(void) {
429 return ARR_LEN(irp->global_asms);
432 /* Return the global asm include at position pos. */
433 ident *get_irp_asm(int pos) {
434 assert(pos <= 0 && pos < get_irp_n_asms());
435 return irp->global_asms[pos];