2 * Copyright (C) 1995-2007 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
36 #include "irgraph_t.h"
37 #include "pseudo_irg.h"
43 /** The name of the Global type. */
44 #define GLOBAL_TYPE_NAME "GlobalType"
45 /** The name of the Thread Local Storage type. */
46 #define TLS_TYPE_NAME "TLS"
47 /** The initial name of the irp program. */
48 #define INITAL_PROG_NAME "no_name_set"
50 /* A variable from where everything in the ir can be accessed. */
52 ir_prog *get_irp(void) { return irp; }
55 * Create a new incomplete ir_prog.
57 static ir_prog *new_incomplete_ir_prog(void) {
60 res = xmalloc(sizeof(*res));
61 memset(res, 0, sizeof(*res));
63 res->kind = k_ir_prog;
64 res->graphs = NEW_ARR_F(ir_graph *, 0);
65 res->pseudo_graphs = NEW_ARR_F(ir_graph *, 0);
66 res->types = NEW_ARR_F(ir_type *, 0);
67 res->modes = NEW_ARR_F(ir_mode *, 0);
68 res->opcodes = NEW_ARR_F(ir_op *, 0);
69 res->last_region_nr = 0;
78 /** Completes an incomplete irprog. */
79 static ir_prog *complete_ir_prog(ir_prog *irp) {
80 #define IDENT(s) new_id_from_chars(s, sizeof(s)-1)
82 irp->name = IDENT(INITAL_PROG_NAME);
83 irp->glob_type = new_type_class(IDENT(GLOBAL_TYPE_NAME));
84 irp->tls_type = new_type_struct(IDENT(TLS_TYPE_NAME));
85 /* Remove these types from type list. Must be treated differently than
87 remove_irp_type(irp->glob_type);
88 remove_irp_type(irp->tls_type);
90 /* Set these flags for debugging. */
91 irp->glob_type->flags |= tf_global_type;
92 irp->tls_type->flags |= tf_tls_type;
94 /* The global type is a class, but we cannot derive from it, so set
95 the final property to assist optimizations that checks for it. */
96 set_class_final(irp->glob_type, 1);
98 irp->const_code_irg = new_const_code_irg();
100 irp->phase_state = phase_building;
101 irp->outs_state = outs_none;
102 irp->ip_outedges = NULL;
103 irp->trouts_state = outs_none;
104 irp->class_cast_state = ir_class_casts_transitive;
105 irp->globals_adr_taken_state = ir_address_taken_not_computed;
111 /* initializes ir_prog. Constructs only the basic lists. */
112 void init_irprog_1(void) {
113 irp = new_incomplete_ir_prog();
116 /* Completes ir_prog. */
117 void init_irprog_2(void) {
118 complete_ir_prog(irp);
121 /* Create a new ir prog. Automatically called by init_firm through
123 ir_prog *new_ir_prog (void) {
124 return complete_ir_prog(new_incomplete_ir_prog());
127 /* frees all memory used by irp. Types in type list, irgs in irg
128 list and entities in global type must be freed by hand before. */
129 void free_ir_prog(void) {
131 free_type(irp->glob_type);
133 free_type(irp->tls_type);
135 /* @@@ * free_ir_graph(irp->const_code_irg); * ?? End has no in?? */
136 DEL_ARR_F(irp->graphs);
137 DEL_ARR_F(irp->pseudo_graphs);
138 DEL_ARR_F(irp->types);
139 DEL_ARR_F(irp->modes);
140 DEL_ARR_F(irp->opcodes);
143 irp->const_code_irg = NULL;
147 /*- Functions to access the fields of ir_prog -*/
150 /* Access the main routine of the compiled program. */
151 ir_graph *get_irp_main_irg(void) {
153 return irp->main_irg;
156 void set_irp_main_irg(ir_graph *main_irg) {
158 irp->main_irg = main_irg;
161 ir_type *(get_glob_type)(void) {
162 return _get_glob_type();
165 ir_type *(get_tls_type)(void) {
166 return _get_tls_type();
169 /* Adds irg to the list of ir graphs in irp. */
170 void add_irp_irg(ir_graph *irg) {
172 assert(irp && irp->graphs);
173 ARR_APP1(ir_graph *, irp->graphs, irg);
176 /* Removes irg from the list or irgs, shrinks the list by one. */
177 void remove_irp_irg_from_list(ir_graph *irg){
181 for (i = 0; i < (ARR_LEN (irp->graphs)); i++) {
182 if (irp->graphs[i] == irg) {
184 for(; i < (ARR_LEN (irp->graphs)) - 1; i++) {
185 irp->graphs[i] = irp->graphs[i+1];
187 ARR_SETLEN(ir_graph*, irp->graphs, (ARR_LEN(irp->graphs)) - 1);
192 for (i = 0; i < (ARR_LEN (irp->pseudo_graphs)); i++) {
193 if (irp->pseudo_graphs[i] == irg) {
194 for(; i < (ARR_LEN (irp->pseudo_graphs)) - 1; i++) {
195 irp->pseudo_graphs[i] = irp->pseudo_graphs[i+1];
197 ARR_SETLEN(ir_graph*, irp->pseudo_graphs, (ARR_LEN(irp->pseudo_graphs)) - 1);
204 /* Removes irg from the list or irgs, shrinks the list by one. */
205 void remove_irp_irg(ir_graph *irg){
208 remove_irp_irg_from_list(irg);
211 int (get_irp_n_irgs)(void) {
212 return _get_irp_n_irgs();
215 ir_graph *(get_irp_irg)(int pos){
216 return _get_irp_irg(pos);
219 void set_irp_irg(int pos, ir_graph *irg) {
221 assert(pos < (ARR_LEN(irp->graphs)));
222 irp->graphs[pos] = irg;
225 /* Gets the number of graphs _and_ pseudo graphs. */
226 int get_irp_n_allirgs(void) {
227 /* We can not call get_irp_n_irgs, as we end up in a recursion ... */
228 return ARR_LEN(irp->graphs) + get_irp_n_pseudo_irgs();
231 /* Returns the ir graph at position pos of all graphs (including
232 pseudo graphs). Visits first graphs, then pseudo graphs. */
233 ir_graph *get_irp_allirg(int pos) {
234 int n_irgs = ARR_LEN(irp->graphs);
237 return irp->graphs[pos];
239 return get_irp_pseudo_irg(pos-n_irgs);
243 /* Adds type to the list of types in irp. */
244 void add_irp_type(ir_type *typ) {
247 ARR_APP1 (ir_type *, irp->types, typ);
250 /* Remove type form the list of types in irp. */
251 void remove_irp_type(ir_type *typ) {
255 for (i = ARR_LEN(irp->types) -1; i >= 0; i--) {
256 if (irp->types[i] == typ) {
257 for(; i < (ARR_LEN(irp->types)) - 1; i++) {
258 irp->types[i] = irp->types[i+1];
260 ARR_SETLEN(ir_type *, irp->types, (ARR_LEN(irp->types)) - 1);
266 int (get_irp_n_types) (void) {
267 return _get_irp_n_types();
270 ir_type *(get_irp_type) (int pos) {
271 return _get_irp_type(pos);
274 void set_irp_type(int pos, ir_type *typ) {
276 assert(pos < (ARR_LEN((irp)->types)));
277 irp->types[pos] = typ;
280 /* Returns the number of all modes in the irp. */
281 int (get_irp_n_modes)(void) {
282 return _get_irp_n_modes();
285 /* Returns the mode at position pos in the irp. */
286 ir_mode *(get_irp_mode)(int pos) {
287 return _get_irp_mode(pos);
290 /* Adds mode to the list of modes in irp. */
291 void add_irp_mode(ir_mode *mode) {
292 assert(mode != NULL);
294 ARR_APP1(ir_mode *, irp->modes, mode);
297 /* Adds opcode to the list of opcodes in irp. */
298 void add_irp_opcode(ir_op *opcode) {
299 assert(opcode != NULL);
301 assert(opcode->code == ARR_LEN(irp->opcodes) && "new_ir_op() called in wrong order");
302 ARR_APP1(ir_op *, irp->opcodes, opcode);
305 /* Removes opcode from the list of opcodes and shrinks the list by one. */
306 void remove_irp_opcode(ir_op *opcode) {
310 for (i = ARR_LEN(irp->opcodes) -1; i >= 0; i--) {
311 if (irp->opcodes[i] == opcode) {
312 for (; i < (ARR_LEN(irp->opcodes)) - 1; i++) {
313 irp->opcodes[i] = irp->opcodes[i+1];
315 ARR_SETLEN(ir_op *, irp->opcodes, (ARR_LEN(irp->opcodes)) - 1);
321 /* Returns the number of all opcodes in the irp. */
322 int (get_irp_n_opcodes)(void) {
323 return _get_irp_n_opcodes();
326 /* Returns the opcode at position pos in the irp. */
327 ir_op *(get_irp_opcode)(int pos) {
328 return _get_irp_opcode(pos);
331 /* Sets the generic function pointer of all opcodes to NULL */
332 void clear_irp_opcodes_generic_func(void) {
335 for (i = get_irp_n_opcodes() - 1; i >= 0; --i) {
336 ir_op *op = get_irp_opcode(i);
337 op->ops.generic = (op_func)NULL;
341 /*- File name / executable name or the like -*/
342 void set_irp_prog_name(ident *name) {
345 int irp_prog_name_is_set(void) {
346 return irp->name != new_id_from_str(INITAL_PROG_NAME);
348 ident *get_irp_prog_ident(void) {
351 const char *get_irp_prog_name(void) {
352 return get_id_str(irp->name);
356 ir_graph *(get_const_code_irg)(void) {
357 return _get_const_code_irg();
360 irg_phase_state get_irp_phase_state(void) {
361 return irp->phase_state;
364 void set_irp_phase_state(irg_phase_state s) {
365 irp->phase_state = s;
368 irg_outs_state get_irp_ip_outs_state(void) {
369 return irp->outs_state;
372 void set_irp_ip_outs_inconsistent(void) {
373 irp->outs_state = outs_inconsistent;
376 void set_irp_ip_outedges(ir_node ** ip_outedges) {
377 irp->ip_outedges = ip_outedges;
380 ir_node** get_irp_ip_outedges(void) {
381 return irp->ip_outedges;
385 irg_callee_info_state get_irp_callee_info_state(void) {
386 return irp->callee_info_state;
389 void set_irp_callee_info_state(irg_callee_info_state s) {
390 irp->callee_info_state = s;
393 /* Returns a new, unique exception region number. */
394 unsigned long (get_irp_next_region_nr)(void) {
395 return _get_irp_next_region_nr();