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));
64 res->kind = k_ir_prog;
65 res->graphs = NEW_ARR_F(ir_graph *, 0);
66 res->pseudo_graphs = NEW_ARR_F(ir_graph *, 0);
67 res->types = NEW_ARR_F(ir_type *, 0);
68 res->modes = NEW_ARR_F(ir_mode *, 0);
69 res->opcodes = NEW_ARR_F(ir_op *, 0);
78 /** Completes an incomplete irprog. */
79 static ir_prog *complete_ir_prog(ir_prog *irp) {
80 #define X(s) s, sizeof(s)-1
81 irp->name = new_id_from_chars(X(INITAL_PROG_NAME));
83 irp->glob_type = new_type_class(new_id_from_chars(X(GLOBAL_TYPE_NAME)));
84 irp->tls_type = new_type_struct(new_id_from_chars(X(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;
110 /* initializes ir_prog. Constructs only the basic lists */
111 void init_irprog_1(void) {
112 new_incomplete_ir_prog();
115 /* Completes ir_prog. */
116 void init_irprog_2(void) {
117 complete_ir_prog(irp);
120 /* Create a new ir prog. Automatically called by init_firm through
122 ir_prog *new_ir_prog (void) {
123 return complete_ir_prog(new_incomplete_ir_prog());
126 /* frees all memory used by irp. Types in type list, irgs in irg
127 list and entities in global type must be freed by hand before. */
128 void free_ir_prog(void) {
130 free_type(irp->glob_type);
132 free_type(irp->tls_type);
134 /* @@@ * free_ir_graph(irp->const_code_irg); * ?? End has no in?? */
135 DEL_ARR_F(irp->graphs);
136 DEL_ARR_F(irp->pseudo_graphs);
137 DEL_ARR_F(irp->types);
138 DEL_ARR_F(irp->modes);
139 DEL_ARR_F(irp->opcodes);
142 irp->const_code_irg = NULL;
146 /*- Functions to access the fields of ir_prog -*/
149 /* Access the main routine of the compiled program. */
150 ir_graph *get_irp_main_irg(void) {
152 return irp->main_irg;
155 void set_irp_main_irg(ir_graph *main_irg) {
157 irp->main_irg = main_irg;
160 ir_type *(get_glob_type)(void) {
161 return _get_glob_type();
164 ir_type *(get_tls_type)(void) {
165 return _get_tls_type();
168 /* Adds irg to the list of ir graphs in irp. */
169 void add_irp_irg(ir_graph *irg) {
170 assert (irg != NULL);
171 assert(irp && irp->graphs);
172 ARR_APP1 (ir_graph *, irp->graphs, irg);
175 /* Removes irg from the list or irgs, shrinks the list by one. */
176 void remove_irp_irg_from_list(ir_graph *irg){
179 for (i = 0; i < (ARR_LEN (irp->graphs)); i++) {
180 if (irp->graphs[i] == irg) {
182 for(; i < (ARR_LEN (irp->graphs)) - 1; i++) {
183 irp->graphs[i] = irp->graphs[i+1];
185 ARR_SETLEN(ir_graph*, irp->graphs, (ARR_LEN(irp->graphs)) - 1);
190 for (i = 0; i < (ARR_LEN (irp->pseudo_graphs)); i++) {
191 if (irp->pseudo_graphs[i] == irg) {
192 for(; i < (ARR_LEN (irp->pseudo_graphs)) - 1; i++) {
193 irp->pseudo_graphs[i] = irp->pseudo_graphs[i+1];
195 ARR_SETLEN(ir_graph*, irp->pseudo_graphs, (ARR_LEN(irp->pseudo_graphs)) - 1);
202 /* Removes irg from the list or irgs, shrinks the list by one. */
203 void remove_irp_irg(ir_graph *irg){
206 remove_irp_irg_from_list(irg);
209 int (get_irp_n_irgs)(void) {
210 return _get_irp_n_irgs();
213 ir_graph *(get_irp_irg)(int pos){
214 return _get_irp_irg(pos);
217 void set_irp_irg(int pos, ir_graph *irg) {
219 assert(pos < (ARR_LEN(irp->graphs)));
220 irp->graphs[pos] = irg;
223 /* Gets the number of graphs _and_ pseudo graphs. */
224 int get_irp_n_allirgs(void) {
225 /* We can not call get_irp_n_irgs, as we end up in a recursion ... */
226 return ARR_LEN(irp->graphs) + get_irp_n_pseudo_irgs();
229 /* Returns the ir graph at position pos of all graphs (including
230 pseudo graphs). Visits first graphs, then pseudo graphs. */
231 ir_graph *get_irp_allirg(int pos) {
232 int n_irgs = ARR_LEN(irp->graphs);
235 return irp->graphs[pos];
237 return get_irp_pseudo_irg(pos-n_irgs);
241 /* Adds type to the list of types in irp. */
242 void add_irp_type(ir_type *typ) {
245 ARR_APP1 (ir_type *, irp->types, typ);
248 /* Remove type form the list of types in irp. */
249 void remove_irp_type(ir_type *typ) {
253 for (i = ARR_LEN(irp->types) -1; i >= 0; i--) {
254 if (irp->types[i] == typ) {
255 for(; i < (ARR_LEN(irp->types)) - 1; i++) {
256 irp->types[i] = irp->types[i+1];
258 ARR_SETLEN(ir_type *, irp->types, (ARR_LEN(irp->types)) - 1);
264 int (get_irp_n_types) (void) {
265 return _get_irp_n_types();
268 ir_type *(get_irp_type) (int pos) {
269 return _get_irp_type(pos);
272 void set_irp_type(int pos, ir_type *typ) {
274 assert(pos < (ARR_LEN((irp)->types)));
275 irp->types[pos] = typ;
278 /* Returns the number of all modes in the irp. */
279 int (get_irp_n_modes)(void) {
280 return _get_irp_n_modes();
283 /* Returns the mode at position pos in the irp. */
284 ir_mode *(get_irp_mode)(int pos) {
285 return _get_irp_mode(pos);
288 /* Adds mode to the list of modes in irp. */
289 void add_irp_mode(ir_mode *mode) {
290 assert(mode != NULL);
292 ARR_APP1(ir_mode *, irp->modes, mode);
295 /* Adds opcode to the list of opcodes in irp. */
296 void add_irp_opcode(ir_op *opcode) {
297 assert(opcode != NULL);
299 assert(opcode->code == ARR_LEN(irp->opcodes) && "new_ir_op() called in wrong order");
300 ARR_APP1(ir_op *, irp->opcodes, opcode);
303 /* Removes opcode from the list of opcodes and shrinks the list by one. */
304 void remove_irp_opcode(ir_op *opcode) {
308 for (i = ARR_LEN(irp->opcodes) -1; i >= 0; i--) {
309 if (irp->opcodes[i] == opcode) {
310 for (; i < (ARR_LEN(irp->opcodes)) - 1; i++) {
311 irp->opcodes[i] = irp->opcodes[i+1];
313 ARR_SETLEN(ir_op *, irp->opcodes, (ARR_LEN(irp->opcodes)) - 1);
319 /* Returns the number of all opcodes in the irp. */
320 int (get_irp_n_opcodes)(void) {
321 return _get_irp_n_opcodes();
324 /* Returns the opcode at position pos in the irp. */
325 ir_op *(get_irp_opcode)(int pos) {
326 return _get_irp_opcode(pos);
329 /* Sets the generic function pointer of all opcodes to NULL */
330 void clear_irp_opcodes_generic_func(void) {
333 for (i = get_irp_n_opcodes() - 1; i >= 0; --i) {
334 ir_op *op = get_irp_opcode(i);
335 op->ops.generic = (op_func)NULL;
339 /*- File name / executable name or the like -*/
340 void set_irp_prog_name(ident *name) {
343 int irp_prog_name_is_set(void) {
344 return irp->name != new_id_from_str(INITAL_PROG_NAME);
346 ident *get_irp_prog_ident(void) {
349 const char *get_irp_prog_name(void) {
350 return get_id_str(irp->name);
354 ir_graph *(get_const_code_irg)(void) {
355 return _get_const_code_irg();
358 irg_phase_state get_irp_phase_state(void) {
359 return irp->phase_state;
361 void set_irp_phase_state(irg_phase_state s) {
362 irp->phase_state = s;
365 irg_outs_state get_irp_ip_outs_state(void) {
366 return irp->outs_state;
369 void set_irp_ip_outs_inconsistent(void) {
370 irp->outs_state = outs_inconsistent;
373 void set_irp_ip_outedges(ir_node ** ip_outedges) {
374 irp->ip_outedges = ip_outedges;
377 ir_node** get_irp_ip_outedges(void) {
378 return irp->ip_outedges;
382 irg_callee_info_state get_irp_callee_info_state(void) {
383 return irp->callee_info_state;
386 void set_irp_callee_info_state(irg_callee_info_state s) {
387 irp->callee_info_state = s;