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 * File name: ir/ir/irprog.c
23 * Purpose: Entry point to the representation of a whole program.
24 * Author: Goetz Lindenmaier
28 * Copyright: (c) 2000-2007 Universität Karlsruhe
40 #include "irgraph_t.h"
41 #include "pseudo_irg.h"
48 /** The name of the Global Type. */
49 #define GLOBAL_TYPE_NAME "GlobalType"
50 /** The name of the Thread Local STorage Type. */
51 #define TLS_TYPE_NAME "TLS"
52 /** The initial name of the irp program. */
53 #define INITAL_PROG_NAME "no_name_set"
55 /* A variable from where everything in the ir can be accessed. */
57 ir_prog *get_irp(void) { return irp; }
60 * Create a new incomplete ir_prog.
62 static ir_prog *new_incomplete_ir_prog (void) {
65 res = xmalloc(sizeof(*res));
66 memset(res, 0, sizeof(*res));
69 res->kind = k_ir_prog;
70 res->graphs = NEW_ARR_F(ir_graph *, 0);
71 res->pseudo_graphs = NEW_ARR_F(ir_graph *, 0);
72 res->types = NEW_ARR_F(ir_type *, 0);
73 res->modes = NEW_ARR_F(ir_mode *, 0);
74 res->opcodes = NEW_ARR_F(ir_op *, 0);
83 /** Completes an incomplete irprog. */
84 static ir_prog *complete_ir_prog(ir_prog *irp) {
85 #define X(s) s, sizeof(s)-1
86 irp->name = new_id_from_chars(X(INITAL_PROG_NAME));
88 irp->glob_type = new_type_class(new_id_from_chars(X(GLOBAL_TYPE_NAME)));
89 irp->tls_type = new_type_struct(new_id_from_chars(X(TLS_TYPE_NAME)));
90 /* Remove these types from type list. Must be treated differently than
92 remove_irp_type(irp->glob_type);
93 remove_irp_type(irp->tls_type);
95 /* Set these flags for debugging. */
96 irp->glob_type->flags |= tf_global_type;
97 irp->tls_type->flags |= tf_tls_type;
99 /* The global type is a class, but we cannot derive from it, so set
100 the final property to assist optimizations that checks for it. */
101 set_class_final(irp->glob_type, 1);
103 irp->const_code_irg = new_const_code_irg();
105 irp->phase_state = phase_building;
106 irp->outs_state = outs_none;
107 irp->ip_outedges = NULL;
108 irp->trouts_state = outs_none;
109 irp->class_cast_state = ir_class_casts_transitive;
110 irp->globals_adr_taken_state = ir_address_taken_not_computed;
115 /* initializes ir_prog. Constructs only the basic lists */
116 void init_irprog_1(void) {
117 new_incomplete_ir_prog();
120 /* Completes ir_prog. */
121 void init_irprog_2(void) {
122 complete_ir_prog(irp);
125 /* Create a new ir prog. Automatically called by init_firm through
127 ir_prog *new_ir_prog (void) {
128 return complete_ir_prog(new_incomplete_ir_prog());
131 /* frees all memory used by irp. Types in type list, irgs in irg
132 list and entities in global type must be freed by hand before. */
133 void free_ir_prog(void) {
135 free_type(irp->glob_type);
137 free_type(irp->tls_type);
139 /* @@@ * free_ir_graph(irp->const_code_irg); * ?? End has no in?? */
140 DEL_ARR_F(irp->graphs);
141 DEL_ARR_F(irp->pseudo_graphs);
142 DEL_ARR_F(irp->types);
143 DEL_ARR_F(irp->modes);
144 DEL_ARR_F(irp->opcodes);
147 irp->const_code_irg = NULL;
151 /*- Functions to access the fields of ir_prog -*/
154 /* Access the main routine of the compiled program. */
155 ir_graph *get_irp_main_irg(void) {
157 return irp->main_irg;
160 void set_irp_main_irg(ir_graph *main_irg) {
162 irp->main_irg = main_irg;
165 ir_type *(get_glob_type)(void) {
166 return _get_glob_type();
169 ir_type *(get_tls_type)(void) {
170 return _get_tls_type();
173 /* Adds irg to the list of ir graphs in irp. */
174 void add_irp_irg(ir_graph *irg) {
175 assert (irg != NULL);
176 assert(irp && irp->graphs);
177 ARR_APP1 (ir_graph *, irp->graphs, irg);
180 /* Removes irg from the list or irgs, shrinks the list by one. */
181 void remove_irp_irg_from_list(ir_graph *irg){
184 for (i = 0; i < (ARR_LEN (irp->graphs)); i++) {
185 if (irp->graphs[i] == irg) {
187 for(; i < (ARR_LEN (irp->graphs)) - 1; i++) {
188 irp->graphs[i] = irp->graphs[i+1];
190 ARR_SETLEN(ir_graph*, irp->graphs, (ARR_LEN(irp->graphs)) - 1);
195 for (i = 0; i < (ARR_LEN (irp->pseudo_graphs)); i++) {
196 if (irp->pseudo_graphs[i] == irg) {
197 for(; i < (ARR_LEN (irp->pseudo_graphs)) - 1; i++) {
198 irp->pseudo_graphs[i] = irp->pseudo_graphs[i+1];
200 ARR_SETLEN(ir_graph*, irp->pseudo_graphs, (ARR_LEN(irp->pseudo_graphs)) - 1);
207 /* Removes irg from the list or irgs, shrinks the list by one. */
208 void remove_irp_irg(ir_graph *irg){
211 remove_irp_irg_from_list(irg);
214 int (get_irp_n_irgs)(void) {
215 return _get_irp_n_irgs();
218 ir_graph *(get_irp_irg)(int pos){
219 return _get_irp_irg(pos);
222 void set_irp_irg(int pos, ir_graph *irg) {
224 assert(pos < (ARR_LEN(irp->graphs)));
225 irp->graphs[pos] = irg;
228 /* Gets the number of graphs _and_ pseudo graphs. */
229 int get_irp_n_allirgs(void) {
230 /* We can not call get_irp_n_irgs, as we end up in a recursion ... */
231 return ARR_LEN(irp->graphs) + get_irp_n_pseudo_irgs();
234 /* Returns the ir graph at position pos of all graphs (including
235 pseudo graphs). Visits first graphs, then pseudo graphs. */
236 ir_graph *get_irp_allirg(int pos) {
237 int n_irgs = ARR_LEN(irp->graphs);
240 return irp->graphs[pos];
242 return get_irp_pseudo_irg(pos-n_irgs);
246 /* Adds type to the list of types in irp. */
247 void add_irp_type(ir_type *typ) {
250 ARR_APP1 (ir_type *, irp->types, typ);
253 /* Remove type form the list of types in irp. */
254 void remove_irp_type(ir_type *typ) {
258 for (i = ARR_LEN(irp->types) -1; i >= 0; i--) {
259 if (irp->types[i] == typ) {
260 for(; i < (ARR_LEN(irp->types)) - 1; i++) {
261 irp->types[i] = irp->types[i+1];
263 ARR_SETLEN(ir_type *, irp->types, (ARR_LEN(irp->types)) - 1);
269 int (get_irp_n_types) (void) {
270 return _get_irp_n_types();
273 ir_type *(get_irp_type) (int pos) {
274 return _get_irp_type(pos);
277 void set_irp_type(int pos, ir_type *typ) {
279 assert(pos < (ARR_LEN((irp)->types)));
280 irp->types[pos] = typ;
283 /* Returns the number of all modes in the irp. */
284 int (get_irp_n_modes)(void) {
285 return _get_irp_n_modes();
288 /* Returns the mode at position pos in the irp. */
289 ir_mode *(get_irp_mode)(int pos) {
290 return _get_irp_mode(pos);
293 /* Adds mode to the list of modes in irp. */
294 void add_irp_mode(ir_mode *mode) {
295 assert(mode != NULL);
297 ARR_APP1(ir_mode *, irp->modes, mode);
300 /* Adds opcode to the list of opcodes in irp. */
301 void add_irp_opcode(ir_op *opcode) {
302 assert(opcode != NULL);
304 ARR_APP1(ir_op *, irp->opcodes, opcode);
307 /* Removes opcode from the list of opcodes and shrinks the list by one. */
308 void remove_irp_opcode(ir_op *opcode) {
312 for (i = ARR_LEN(irp->opcodes) -1; i >= 0; i--) {
313 if (irp->opcodes[i] == opcode) {
314 for (; i < (ARR_LEN(irp->opcodes)) - 1; i++) {
315 irp->opcodes[i] = irp->opcodes[i+1];
317 ARR_SETLEN(ir_op *, irp->opcodes, (ARR_LEN(irp->opcodes)) - 1);
323 /* Returns the number of all opcodes in the irp. */
324 int (get_irp_n_opcodes)(void) {
325 return _get_irp_n_opcodes();
328 /* Returns the opcode at position pos in the irp. */
329 ir_op *(get_irp_opcode)(int pos) {
330 return _get_irp_opcode(pos);
333 /* Sets the generic function pointer of all opcodes to NULL */
334 void clear_irp_opcodes_generic_func(void) {
337 for (i = get_irp_n_opcodes() - 1; i >= 0; --i) {
338 ir_op *op = get_irp_opcode(i);
339 op->ops.generic = (op_func)NULL;
343 /*- File name / executable name or the like -*/
344 void set_irp_prog_name(ident *name) {
347 int irp_prog_name_is_set(void) {
348 return irp->name != new_id_from_str(INITAL_PROG_NAME);
350 ident *get_irp_prog_ident(void) {
353 const char *get_irp_prog_name(void) {
354 return get_id_str(irp->name);
358 ir_graph *(get_const_code_irg)(void) {
359 return _get_const_code_irg();
362 irg_phase_state get_irp_phase_state(void) {
363 return irp->phase_state;
365 void set_irp_phase_state(irg_phase_state s) {
366 irp->phase_state = s;
369 irg_outs_state get_irp_ip_outs_state(void) {
370 return irp->outs_state;
373 void set_irp_ip_outs_inconsistent(void) {
374 irp->outs_state = outs_inconsistent;
377 void set_irp_ip_outedges(ir_node ** ip_outedges) {
378 irp->ip_outedges = ip_outedges;
381 ir_node** get_irp_ip_outedges(void) {
382 return irp->ip_outedges;
386 irg_callee_info_state get_irp_callee_info_state(void) {
387 return irp->callee_info_state;
390 void set_irp_callee_info_state(irg_callee_info_state s) {
391 irp->callee_info_state = s;