mark methods with lowered struct params, correctly handle x86 abi for this case
[libfirm] / include / libfirm / irprog.h
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  * @summary
27  *  Intermediate Representation (IR) of a program.
28  *
29  *  This file defines a construct that keeps all information about a
30  *  program:
31  *   - A reference point to the method to be executed on program start.
32  *   - A list of all procedures.
33  *   - A list of all types.
34  *   - A global type that contains all global variables and procedures that do
35  *     not belong to a class.  This type represents the data segment of the
36  *     program.  It is not the base class of
37  *     all classes in a class hierarchy (as, e.g., "object" in java).
38  *   - A degenerated graph that contains constant expressions.
39  *   - interprocedural outs state.
40  *   - a flag indicating validity of the interprocedural representation.
41  *   - the output file name
42  */
43 #ifndef FIRM_IR_IRPROG_H
44 #define FIRM_IR_IRPROG_H
45
46 #include "firm_types.h"
47 #include "irgraph.h"
48
49 /**
50  * Datastructure that holds central information about a program
51  *
52  * Preliminary documentation ;-)
53  *
54  * - main_irg:  The ir graph that is the entry point to the program.
55  *              (Anything not reachable from here may be optimized away.
56  *              If we want to translate libraries or the like correctly
57  *              we must replace this by a list.)
58  * - irg:       List of all ir graphs in the program.
59  * - type:      A list containing all types known to the translated program.
60  *              Some types can have several entries in this list (as a result of
61  *              using exchange_types()).
62  * - glob_type: The unique global type that is owner of all global entities.
63  *
64  */
65 typedef struct ir_prog ir_prog;
66
67 /**
68  * A variable from where everything in the ir can be accessed.
69  * This variable contains the irp, the "immediate representation program".
70  * This variable should be considered constant. Moreover, one should use get_irp()
71  * to get access the the irp.
72  *
73  * @note
74  *      Think of the irp as the "handle" of libFirm.
75  */
76 extern ir_prog *irp;
77
78 /**
79  * Returns the access points from where everything in the ir can be accessed.
80  *
81  * @see irp
82  */
83 ir_prog *get_irp(void);
84
85 /** Creates a new ir_prog, returns it and sets irp with it.
86  *  Automatically called by init_firm() through init_irprog. */
87 ir_prog *new_ir_prog (void);
88
89 /** frees all memory used by irp.  Types in type list and irgs in irg
90  *  list must be freed by hand before. */
91 void     free_ir_prog(void);
92
93 /** Sets the file name / executable name or the like. Initially the
94     ident 'no_name_set'. */
95 void   set_irp_prog_name (ident *name);
96
97 /** Returns true if the user ever set a program name */
98 int    irp_prog_name_is_set(void);
99
100 /** Gets the file name / executable name or the like.
101  */
102 ident *get_irp_prog_ident(void);
103
104 /** Gets the file name / executable name or the like.
105  */
106 const char *get_irp_prog_name (void);
107
108 /** Gets the main routine of the compiled program. */
109 ir_graph *get_irp_main_irg(void);
110
111 /** Sets the main routine of the compiled program. */
112 void      set_irp_main_irg(ir_graph *main_irg);
113
114 /** Adds irg to the list of ir graphs in irp. */
115 void      add_irp_irg(ir_graph *irg);
116
117 /** Removes irg from the list of irgs and
118     shrinks the list by one. */
119 void      remove_irp_irg_from_list(ir_graph *irg);
120 /** Removes irg from the list of irgs, deallocates it and
121     shrinks the list by one. */
122 void      remove_irp_irg(ir_graph *irg);
123
124 /** Returns the number of ir graphs in the irp. */
125 int       get_irp_n_irgs(void);
126
127 /** Returns the ir graph at position pos in the irp. */
128 ir_graph *get_irp_irg(int pos);
129
130 /** Sets the ir graph at position pos. */
131 void      set_irp_irg(int pos, ir_graph *irg);
132
133 /** Gets the number of graphs _and_ pseudo graphs. */
134 int       get_irp_n_allirgs(void);
135
136 /** Returns the ir graph at position pos of all graphs (including
137  pseudo graphs).  Visits first graphs, then pseudo graphs. */
138 ir_graph *get_irp_allirg(int pos);
139
140 /**
141  * Returns the "global" type of the irp.
142  * Upon creation this is an empty class type.
143  */
144 ir_type *get_glob_type(void);
145
146 /**
147  * Returns the "thread local storage" type of the irp.
148  * Upon creation this is an empty struct type.
149  */
150 ir_type *get_tls_type(void);
151
152 /** Adds type to the list of types in irp. */
153 void  add_irp_type(ir_type *typ);
154
155 /** Removes type from the list of types, deallocates it and
156     shrinks the list by one. */
157 void  remove_irp_type(ir_type *typ);
158
159 /** Returns the number of all types in the irp. */
160 int   get_irp_n_types(void);
161
162 /** Returns the type at position pos in the irp. */
163 ir_type *get_irp_type(int pos);
164
165 /** Overwrites the type at position pos with another type. */
166 void  set_irp_type(int pos, ir_type *typ);
167
168 /** Returns the number of all modes in the irp. */
169 int   get_irp_n_modes(void);
170
171 /** Returns the mode at position pos in the irp. */
172 ir_mode *get_irp_mode(int pos);
173
174 /** Adds opcode to the list of opcodes in irp. */
175 void  add_irp_opcode(ir_op *opcode);
176
177 /** Removes opcode from the list of opcodes, deallocates it and
178     shrinks the list by one. */
179 void  remove_irp_opcode(ir_op *opcode);
180
181 /** Returns the number of all opcodes in the irp. */
182 int   get_irp_n_opcodes(void);
183
184 /** Returns the opcode at position pos in the irp. */
185 ir_op *get_irp_opcode(int pos);
186
187 /** Sets the generic function pointer of all opcodes to NULL */
188 void  clear_irp_opcodes_generic_func(void);
189
190
191 /**  Return the graph for global constants.
192  *
193  *   Returns an irgraph that only contains constant expressions for
194  *   constant entities.  Do not use any access function for this
195  *   graph, do not generate code for this graph.  This graph contains
196  *   only one block.  The constant expressions may not contain control
197  *   flow.
198  *   Walking the graph starting from any node will not reach the block
199  *   or any controlflow.
200  *   See also copy_const_code() in entity.h.
201  */
202 ir_graph *get_const_code_irg(void);
203
204
205 /** The phase state for the program.
206  *
207  *  The phase state of the whole program is
208  *   building:  if at least one graph is state_building
209  *              or one type is incomplete.
210  *   high:      all graphs are in state high or low, all types are constructed.
211  *   low:       all graphs are in state low, all types are in state layout fixed.
212  */
213 irg_phase_state get_irp_phase_state(void);
214 void            set_irp_phase_state(irg_phase_state s);
215
216 irg_outs_state get_irp_ip_outs_state(void);
217 void           set_irp_ip_outs_inconsistent(void);
218
219
220 irg_callee_info_state get_irp_callee_info_state(void);
221 void                  set_irp_callee_info_state(irg_callee_info_state s);
222
223 /** Returns a new, unique exception region number. */
224 ir_exc_region_t get_irp_next_region_nr(void);
225
226 /** Returns a new, unique label number. */
227 ir_label_t get_irp_next_label_nr(void);
228
229 #endif