Constify.
[libfirm] / ir / ir / irprog.c
1 /*
2  * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
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.
10  *
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.
14  *
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
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief    Entry point to the representation of a whole program.
23  * @author   Goetz Lindenmaier
24  * @date     2000
25  * @version  $Id$
26  */
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #ifdef HAVE_STRING_H
32 # include <string.h>
33 #endif
34
35 #include "irprog_t.h"
36 #include "irgraph_t.h"
37 #include "pseudo_irg.h"
38 #include "array.h"
39 #include "obst.h"
40 #include "irop_t.h"
41 #include "irmemory.h"
42
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"
49
50 /* A variable from where everything in the ir can be accessed. */
51 ir_prog *irp;
52 ir_prog *get_irp(void) { return irp; }
53
54 /**
55  *  Create a new incomplete ir_prog.
56  */
57 static ir_prog *new_incomplete_ir_prog (void) {
58   ir_prog *res;
59
60   res = xmalloc(sizeof(*res));
61   memset(res, 0, sizeof(*res));
62   irp = res;
63
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);
70
71 #ifdef DEBUG_libfirm
72   res->max_node_nr = 0;
73 #endif
74
75   return res;
76 }
77
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));
82
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
86      other types. */
87   remove_irp_type(irp->glob_type);
88   remove_irp_type(irp->tls_type);
89
90   /* Set these flags for debugging. */
91   irp->glob_type->flags |= tf_global_type;
92   irp->tls_type->flags  |= tf_tls_type;
93
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);
97
98   irp->const_code_irg   = new_const_code_irg();
99
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;
106
107   return irp;
108 }
109
110 /* initializes ir_prog. Constructs only the basic lists */
111 void init_irprog_1(void) {
112   new_incomplete_ir_prog();
113 }
114
115 /* Completes ir_prog. */
116 void init_irprog_2(void) {
117   complete_ir_prog(irp);
118 }
119
120 /* Create a new ir prog. Automatically called by init_firm through
121    init_irprog. */
122 ir_prog *new_ir_prog (void) {
123   return complete_ir_prog(new_incomplete_ir_prog());
124 }
125
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) {
129   if (irp->glob_type)
130     free_type(irp->glob_type);
131   if (irp->tls_type)
132     free_type(irp->tls_type);
133
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);
140
141   irp->name           = NULL;
142   irp->const_code_irg = NULL;
143   irp->kind           = k_BAD;
144 }
145
146 /*- Functions to access the fields of ir_prog -*/
147
148
149 /* Access the main routine of the compiled program. */
150 ir_graph *get_irp_main_irg(void) {
151   assert(irp);
152   return irp->main_irg;
153 }
154
155 void set_irp_main_irg(ir_graph *main_irg) {
156   assert (irp);
157   irp->main_irg = main_irg;
158 }
159
160 ir_type *(get_glob_type)(void) {
161   return _get_glob_type();
162 }
163
164 ir_type *(get_tls_type)(void) {
165   return _get_tls_type();
166 }
167
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);
173 }
174
175 /* Removes irg from the list or irgs, shrinks the list by one. */
176 void remove_irp_irg_from_list(ir_graph *irg){
177   int i, found = 0;
178   assert(irg);
179   for (i = 0; i < (ARR_LEN (irp->graphs)); i++) {
180     if (irp->graphs[i] == irg) {
181       found = 1;
182       for(; i < (ARR_LEN (irp->graphs)) - 1; i++) {
183         irp->graphs[i] = irp->graphs[i+1];
184       }
185       ARR_SETLEN(ir_graph*, irp->graphs, (ARR_LEN(irp->graphs)) - 1);
186       break;
187     }
188   }
189   if (!found) {
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];
194               }
195               ARR_SETLEN(ir_graph*, irp->pseudo_graphs, (ARR_LEN(irp->pseudo_graphs)) - 1);
196               break;
197       }
198     }
199   }
200 }
201
202 /* Removes irg from the list or irgs, shrinks the list by one. */
203 void remove_irp_irg(ir_graph *irg){
204   assert(irg);
205   free_ir_graph(irg);
206   remove_irp_irg_from_list(irg);
207 }
208
209 int (get_irp_n_irgs)(void) {
210   return _get_irp_n_irgs();
211 }
212
213 ir_graph *(get_irp_irg)(int pos){
214   return _get_irp_irg(pos);
215 }
216
217 void set_irp_irg(int pos, ir_graph *irg) {
218   assert(irp && irg);
219   assert(pos < (ARR_LEN(irp->graphs)));
220   irp->graphs[pos] = irg;
221 }
222
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();
227 }
228
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);
233   assert(0 <= pos);
234   if (pos < n_irgs) {
235     return irp->graphs[pos];
236   } else {
237     return get_irp_pseudo_irg(pos-n_irgs);
238   }
239 }
240
241 /* Adds type to the list of types in irp. */
242 void add_irp_type(ir_type *typ) {
243   assert(typ != NULL);
244   assert(irp);
245   ARR_APP1 (ir_type *, irp->types, typ);
246 }
247
248 /* Remove type form the list of types in irp. */
249 void remove_irp_type(ir_type *typ) {
250   int i;
251   assert(typ);
252
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];
257       }
258       ARR_SETLEN(ir_type *, irp->types, (ARR_LEN(irp->types)) - 1);
259       break;
260     }
261   }
262 }
263
264 int (get_irp_n_types) (void) {
265   return _get_irp_n_types();
266 }
267
268 ir_type *(get_irp_type) (int pos) {
269   return _get_irp_type(pos);
270 }
271
272 void set_irp_type(int pos, ir_type *typ) {
273   assert(irp && typ);
274   assert(pos < (ARR_LEN((irp)->types)));
275   irp->types[pos] = typ;
276 }
277
278 /* Returns the number of all modes in the irp. */
279 int (get_irp_n_modes)(void) {
280   return _get_irp_n_modes();
281 }
282
283 /* Returns the mode at position pos in the irp. */
284 ir_mode *(get_irp_mode)(int pos) {
285   return _get_irp_mode(pos);
286 }
287
288 /* Adds mode to the list of modes in irp. */
289 void add_irp_mode(ir_mode *mode) {
290   assert(mode != NULL);
291   assert(irp);
292   ARR_APP1(ir_mode *, irp->modes, mode);
293 }
294
295 /* Adds opcode to the list of opcodes in irp. */
296 void add_irp_opcode(ir_op *opcode) {
297   assert(opcode != NULL);
298   assert(irp);
299   assert(opcode->code == ARR_LEN(irp->opcodes) && "new_ir_op() called in wrong order");
300   ARR_APP1(ir_op *, irp->opcodes, opcode);
301 }
302
303 /* Removes opcode from the list of opcodes and shrinks the list by one. */
304 void remove_irp_opcode(ir_op *opcode) {
305   int i;
306
307   assert(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];
312       }
313       ARR_SETLEN(ir_op *, irp->opcodes, (ARR_LEN(irp->opcodes)) - 1);
314       break;
315     }
316   }
317 }
318
319 /* Returns the number of all opcodes in the irp. */
320 int (get_irp_n_opcodes)(void) {
321   return _get_irp_n_opcodes();
322 }
323
324 /* Returns the opcode at position pos in the irp. */
325 ir_op *(get_irp_opcode)(int pos) {
326   return _get_irp_opcode(pos);
327 }
328
329 /* Sets the generic function pointer of all opcodes to NULL */
330 void  clear_irp_opcodes_generic_func(void) {
331   int i;
332
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;
336   }
337 }
338
339 /*- File name / executable name or the like -*/
340 void   set_irp_prog_name(ident *name) {
341   irp->name = name;
342 }
343 int irp_prog_name_is_set(void) {
344   return irp->name != new_id_from_str(INITAL_PROG_NAME);
345 }
346 ident *get_irp_prog_ident(void) {
347   return irp->name;
348 }
349 const char  *get_irp_prog_name(void) {
350   return get_id_str(irp->name);
351 }
352
353
354 ir_graph *(get_const_code_irg)(void) {
355   return _get_const_code_irg();
356 }
357
358 irg_phase_state get_irp_phase_state(void) {
359   return irp->phase_state;
360 }
361 void set_irp_phase_state(irg_phase_state s) {
362   irp->phase_state = s;
363 }
364
365 irg_outs_state get_irp_ip_outs_state(void) {
366   return irp->outs_state;
367 }
368
369 void set_irp_ip_outs_inconsistent(void) {
370   irp->outs_state = outs_inconsistent;
371 }
372
373 void set_irp_ip_outedges(ir_node ** ip_outedges) {
374   irp->ip_outedges = ip_outedges;
375 }
376
377 ir_node** get_irp_ip_outedges(void) {
378   return irp->ip_outedges;
379 }
380
381
382 irg_callee_info_state get_irp_callee_info_state(void) {
383   return irp->callee_info_state;
384 }
385
386 void set_irp_callee_info_state(irg_callee_info_state s) {
387   irp->callee_info_state = s;
388 }