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"
43 /** The initial name of the irp program. */
44 #define INITAL_PROG_NAME "no_name_set"
46 /* A variable from where everything in the ir can be accessed. */
48 ir_prog *get_irp(void) { return irp; }
51 * Create a new incomplete ir_prog.
53 static ir_prog *new_incomplete_ir_prog(void) {
56 res = xmalloc(sizeof(*res));
57 memset(res, 0, sizeof(*res));
59 res->kind = k_ir_prog;
60 res->graphs = NEW_ARR_F(ir_graph *, 0);
61 res->pseudo_graphs = NEW_ARR_F(ir_graph *, 0);
62 res->types = NEW_ARR_F(ir_type *, 0);
63 res->modes = NEW_ARR_F(ir_mode *, 0);
64 res->opcodes = NEW_ARR_F(ir_op *, 0);
65 res->last_region_nr = 0;
66 res->last_label_nr = 1; /* 0 is reserved as non-label */
76 /** Completes an incomplete irprog. */
77 static ir_prog *complete_ir_prog(ir_prog *irp) {
79 #define IDENT(s) new_id_from_chars(s, sizeof(s)-1)
81 irp->name = IDENT(INITAL_PROG_NAME);
83 irp->segment_types[IR_SEGMENT_GLOBAL] = new_type_class(IDENT("GlobalType"));
84 irp->segment_types[IR_SEGMENT_THREAD_LOCAL]
85 = new_type_struct(IDENT("ThreadLocal"));
86 irp->segment_types[IR_SEGMENT_CONSTRUCTORS]
87 = new_type_struct(IDENT("Constructors"));
88 irp->segment_types[IR_SEGMENT_DESTRUCTORS]
89 = new_type_struct(IDENT("Destructors"));
90 /* Remove these types from type list. Must be treated differently than
92 for (i = 0; i < IR_SEGMENT_COUNT; ++i) {
93 remove_irp_type(irp->segment_types[i]);
96 /* Set these flags for debugging. */
97 irp->segment_types[IR_SEGMENT_GLOBAL]->flags |= tf_global_type;
98 irp->segment_types[IR_SEGMENT_THREAD_LOCAL]->flags |= tf_tls_type;
100 /* The global type is a class, but we cannot derive from it, so set
101 the final property to assist optimizations that checks for it. */
102 set_class_final(irp->segment_types[IR_SEGMENT_GLOBAL], 1);
104 irp->const_code_irg = new_const_code_irg();
106 irp->phase_state = phase_building;
107 irp->outs_state = outs_none;
108 irp->ip_outedges = NULL;
109 irp->trouts_state = outs_none;
110 irp->class_cast_state = ir_class_casts_transitive;
111 irp->globals_adr_taken_state = ir_address_taken_not_computed;
117 /* initializes ir_prog. Constructs only the basic lists. */
118 void init_irprog_1(void) {
119 irp = new_incomplete_ir_prog();
122 /* Completes ir_prog. */
123 void init_irprog_2(void) {
124 complete_ir_prog(irp);
127 /* Create a new ir prog. Automatically called by init_firm through
129 ir_prog *new_ir_prog (void) {
130 return complete_ir_prog(new_incomplete_ir_prog());
133 /* frees all memory used by irp. Types in type list, irgs in irg
134 list and entities in global type must be freed by hand before. */
135 void free_ir_prog(void) {
137 for (i = 0; i < IR_SEGMENT_COUNT; ++i) {
138 free_type(irp->segment_types[i]);
141 DEL_ARR_F(irp->graphs);
142 DEL_ARR_F(irp->pseudo_graphs);
143 DEL_ARR_F(irp->types);
144 DEL_ARR_F(irp->modes);
145 DEL_ARR_F(irp->opcodes);
146 free_ir_graph(irp->const_code_irg);
149 irp->const_code_irg = NULL;
153 /*- Functions to access the fields of ir_prog -*/
156 /* Access the main routine of the compiled program. */
157 ir_graph *get_irp_main_irg(void) {
159 return irp->main_irg;
162 void set_irp_main_irg(ir_graph *main_irg) {
164 irp->main_irg = main_irg;
167 ir_type *(get_segment_type)(ir_segment_t segment) {
168 return _get_segment_type(segment);
171 ir_type *(get_glob_type)(void) {
172 return _get_glob_type();
175 ir_type *(get_tls_type)(void) {
176 return _get_tls_type();
179 /* Adds irg to the list of ir graphs in irp. */
180 void add_irp_irg(ir_graph *irg) {
182 assert(irp && irp->graphs);
183 ARR_APP1(ir_graph *, irp->graphs, irg);
186 /* Removes irg from the list or irgs, shrinks the list by one. */
187 void remove_irp_irg_from_list(ir_graph *irg){
191 for (i = 0; i < (ARR_LEN (irp->graphs)); i++) {
192 if (irp->graphs[i] == irg) {
194 for(; i < (ARR_LEN (irp->graphs)) - 1; i++) {
195 irp->graphs[i] = irp->graphs[i+1];
197 ARR_SETLEN(ir_graph*, irp->graphs, (ARR_LEN(irp->graphs)) - 1);
202 for (i = 0; i < (ARR_LEN (irp->pseudo_graphs)); i++) {
203 if (irp->pseudo_graphs[i] == irg) {
204 for(; i < (ARR_LEN (irp->pseudo_graphs)) - 1; i++) {
205 irp->pseudo_graphs[i] = irp->pseudo_graphs[i+1];
207 ARR_SETLEN(ir_graph*, irp->pseudo_graphs, (ARR_LEN(irp->pseudo_graphs)) - 1);
214 /* Removes irg from the list or irgs, shrinks the list by one. */
215 void remove_irp_irg(ir_graph *irg){
218 remove_irp_irg_from_list(irg);
221 int (get_irp_n_irgs)(void) {
222 return _get_irp_n_irgs();
225 ir_graph *(get_irp_irg)(int pos){
226 return _get_irp_irg(pos);
229 int get_irp_last_idx(void) {
230 return irp->max_irg_idx;
233 void set_irp_irg(int pos, ir_graph *irg) {
235 assert(pos < (ARR_LEN(irp->graphs)));
236 irp->graphs[pos] = irg;
239 /* Gets the number of graphs _and_ pseudo graphs. */
240 int get_irp_n_allirgs(void) {
241 /* We can not call get_irp_n_irgs, as we end up in a recursion ... */
242 return ARR_LEN(irp->graphs) + get_irp_n_pseudo_irgs();
245 /* Returns the ir graph at position pos of all graphs (including
246 pseudo graphs). Visits first graphs, then pseudo graphs. */
247 ir_graph *get_irp_allirg(int pos) {
248 int n_irgs = ARR_LEN(irp->graphs);
251 return irp->graphs[pos];
253 return get_irp_pseudo_irg(pos-n_irgs);
257 /* Adds type to the list of types in irp. */
258 void add_irp_type(ir_type *typ) {
261 ARR_APP1 (ir_type *, irp->types, typ);
264 /* Remove type form the list of types in irp. */
265 void remove_irp_type(ir_type *typ) {
269 for (i = ARR_LEN(irp->types) -1; i >= 0; i--) {
270 if (irp->types[i] == typ) {
271 for(; i < (ARR_LEN(irp->types)) - 1; i++) {
272 irp->types[i] = irp->types[i+1];
274 ARR_SETLEN(ir_type *, irp->types, (ARR_LEN(irp->types)) - 1);
280 int (get_irp_n_types) (void) {
281 return _get_irp_n_types();
284 ir_type *(get_irp_type) (int pos) {
285 return _get_irp_type(pos);
288 void set_irp_type(int pos, ir_type *typ) {
290 assert(pos < (ARR_LEN((irp)->types)));
291 irp->types[pos] = typ;
294 /* Returns the number of all modes in the irp. */
295 int (get_irp_n_modes)(void) {
296 return _get_irp_n_modes();
299 /* Returns the mode at position pos in the irp. */
300 ir_mode *(get_irp_mode)(int pos) {
301 return _get_irp_mode(pos);
304 /* Adds mode to the list of modes in irp. */
305 void add_irp_mode(ir_mode *mode) {
306 assert(mode != NULL);
308 ARR_APP1(ir_mode *, irp->modes, mode);
311 /* Adds opcode to the list of opcodes in irp. */
312 void add_irp_opcode(ir_op *opcode) {
313 assert(opcode != NULL);
315 assert(opcode->code == (unsigned) ARR_LEN(irp->opcodes) && "new_ir_op() called in wrong order");
316 ARR_APP1(ir_op *, irp->opcodes, opcode);
319 /* Removes opcode from the list of opcodes and shrinks the list by one. */
320 void remove_irp_opcode(ir_op *opcode) {
324 for (i = ARR_LEN(irp->opcodes) -1; i >= 0; i--) {
325 if (irp->opcodes[i] == opcode) {
326 for (; i < (ARR_LEN(irp->opcodes)) - 1; i++) {
327 irp->opcodes[i] = irp->opcodes[i+1];
329 ARR_SETLEN(ir_op *, irp->opcodes, (ARR_LEN(irp->opcodes)) - 1);
335 /* Returns the number of all opcodes in the irp. */
336 int (get_irp_n_opcodes)(void) {
337 return _get_irp_n_opcodes();
340 /* Returns the opcode at position pos in the irp. */
341 ir_op *(get_irp_opcode)(int pos) {
342 return _get_irp_opcode(pos);
345 /* Sets the generic function pointer of all opcodes to NULL */
346 void clear_irp_opcodes_generic_func(void) {
349 for (i = get_irp_n_opcodes() - 1; i >= 0; --i) {
350 ir_op *op = get_irp_opcode(i);
351 op->ops.generic = (op_func)NULL;
355 /*- File name / executable name or the like -*/
356 void set_irp_prog_name(ident *name) {
359 int irp_prog_name_is_set(void) {
360 return irp->name != new_id_from_str(INITAL_PROG_NAME);
362 ident *get_irp_prog_ident(void) {
365 const char *get_irp_prog_name(void) {
366 return get_id_str(irp->name);
370 ir_graph *(get_const_code_irg)(void) {
371 return _get_const_code_irg();
374 irg_phase_state get_irp_phase_state(void) {
375 return irp->phase_state;
378 void set_irp_phase_state(irg_phase_state s) {
379 irp->phase_state = s;
382 irg_outs_state get_irp_ip_outs_state(void) {
383 return irp->outs_state;
386 void set_irp_ip_outs_inconsistent(void) {
387 irp->outs_state = outs_inconsistent;
390 void set_irp_ip_outedges(ir_node ** ip_outedges) {
391 irp->ip_outedges = ip_outedges;
394 ir_node** get_irp_ip_outedges(void) {
395 return irp->ip_outedges;
399 irg_callee_info_state get_irp_callee_info_state(void) {
400 return irp->callee_info_state;
403 void set_irp_callee_info_state(irg_callee_info_state s) {
404 irp->callee_info_state = s;
407 /* Returns a new, unique exception region number. */
408 ir_exc_region_t (get_irp_next_region_nr)(void) {
409 return _get_irp_next_region_nr();
412 /* Returns a new, unique label number. */
413 ir_label_t (get_irp_next_label_nr)(void) {
414 return _get_irp_next_label_nr();