2 * Copyright (C) 1995-2008 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
27 * Intermediate Representation (IR) of a program.
29 * This file defines a construct that keeps all information about a
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
43 #ifndef FIRM_IR_IRPROG_H
44 #define FIRM_IR_IRPROG_H
46 #include "firm_types.h"
49 typedef enum ir_segment_t {
51 /** "normal" global data */
52 IR_SEGMENT_GLOBAL = IR_SEGMENT_FIRST,
53 /** thread local storage segment */
54 IR_SEGMENT_THREAD_LOCAL,
56 * the constructors segment. Contains pointers to functions which are
57 * executed on module initialization (program start or when a library is
60 IR_SEGMENT_CONSTRUCTORS,
61 /** like constructors, but functions are executed on module exit */
62 IR_SEGMENT_DESTRUCTORS,
68 * Data structure that holds central information about a program
70 * One irp is created by libFirm on construction, so irp should never be NULL.
72 * - main_irg: The ir graph that is the entry point to the program.
73 * (Anything not reachable from here may be optimized away
74 * if this irp represents a whole program.
75 * - irg: List of all ir graphs in the program or module.
76 * - type: A list containing all types known to the translated program.
77 * Some types can have several entries in this list (as a result of
78 * using exchange_types()).
79 * - glob_type: The unique global type that is owner of all global entities
82 typedef struct ir_prog ir_prog;
85 * A variable pointing to the current irp (program or module).
86 * This variable should be considered constant. Moreover, one should use get_irp()
87 * to get access the the irp.
90 * Think of the irp as the "handle" of a program.
95 void irp_reserve_resources(ir_prog *irp, ir_resources_t resources);
96 void irp_free_resources(ir_prog *irp, ir_resources_t resources);
97 ir_resources_t irp_resources_reserved(const ir_prog *irp);
99 #define irp_reserve_resources(irp, resources)
100 #define irp_free_resources(irp, resources)
101 #define irp_resources_reserved(irp) 0
105 * Returns the current irp from where everything in the current module
110 ir_prog *get_irp(void);
113 * Creates a new ir_prog (a module or compilation unit),
114 * returns it and sets irp with it.
116 * @param module_name the name of this irp (module)
118 ir_prog *new_ir_prog(const char *name);
120 /** frees all memory used by irp. Types in type list and irgs in irg
121 * list must be freed by hand before. */
122 void free_ir_prog(void);
124 /** Sets the file name / executable name or the like. Initially the
125 ident 'no_name_set'. */
126 void set_irp_prog_name(ident *name);
128 /** Returns true if the user ever set a program name */
129 int irp_prog_name_is_set(void);
131 /** Gets the name of the current irp. */
132 ident *get_irp_ident(void);
134 /** Gets the name of the current irp. */
135 const char *get_irp_name(void);
137 /** Gets the main routine of the compiled program. */
138 ir_graph *get_irp_main_irg(void);
140 /** Sets the main routine of the compiled program. */
141 void set_irp_main_irg(ir_graph *main_irg);
143 /** Adds irg to the list of ir graphs in the current irp. */
144 void add_irp_irg(ir_graph *irg);
146 /** Removes irg from the list of irgs and
147 shrinks the list by one. */
148 void remove_irp_irg_from_list(ir_graph *irg);
149 /** Removes irg from the list of irgs, deallocates it and
150 shrinks the list by one. */
151 void remove_irp_irg(ir_graph *irg);
153 /** returns the biggest not used irg index number */
154 int get_irp_last_idx(void);
156 /** Returns the number of ir graphs in the irp. */
157 int get_irp_n_irgs(void);
159 /** Returns the ir graph at position pos in the irp. */
160 ir_graph *get_irp_irg(int pos);
162 /** Sets the ir graph at position pos. */
163 void set_irp_irg(int pos, ir_graph *irg);
165 /** Gets the number of graphs _and_ pseudo graphs. */
166 int get_irp_n_allirgs(void);
168 /** Returns the ir graph at position pos of all graphs (including
169 pseudo graphs). Visits first graphs, then pseudo graphs. */
170 ir_graph *get_irp_allirg(int pos);
173 * Returns the type containing the entities for a segment.
175 * @param segment the segment
177 ir_type *get_segment_type(ir_segment_t segment);
180 * Returns the "global" type of the irp.
181 * Upon creation this is an empty class type.
182 * This is a convenience function for get_segment_type(IR_SEGMENT_GLOBAL)
184 ir_type *get_glob_type(void);
187 * Returns the "thread local storage" type of the irp.
188 * Upon creation this is an empty struct type.
190 ir_type *get_tls_type(void);
192 /** Adds type to the list of types in irp. */
193 void add_irp_type(ir_type *typ);
195 /** Removes type from the list of types, deallocates it and
196 shrinks the list by one. */
197 void remove_irp_type(ir_type *typ);
199 /** Returns the number of all types in the irp. */
200 int get_irp_n_types(void);
202 /** Returns the type at position pos in the irp. */
203 ir_type *get_irp_type(int pos);
205 /** Overwrites the type at position pos with another type. */
206 void set_irp_type(int pos, ir_type *typ);
208 /** Returns the number of all modes in the irp. */
209 int get_irp_n_modes(void);
211 /** Returns the mode at position pos in the irp. */
212 ir_mode *get_irp_mode(int pos);
214 /** Adds opcode to the list of opcodes in irp. */
215 void add_irp_opcode(ir_op *opcode);
217 /** Removes opcode from the list of opcodes, deallocates it and
218 shrinks the list by one. */
219 void remove_irp_opcode(ir_op *opcode);
221 /** Returns the number of all opcodes in the irp. */
222 int get_irp_n_opcodes(void);
224 /** Returns the opcode at position pos in the irp. */
225 ir_op *get_irp_opcode(int pos);
227 /** Sets the generic function pointer of all opcodes to NULL */
228 void clear_irp_opcodes_generic_func(void);
231 /** Return the graph for global constants of the current irp.
233 * Returns an irgraph that only contains constant expressions for
234 * constant entities. Do not use any access function for this
235 * graph, do not generate code for this graph. This graph contains
236 * only one block. The constant expressions may not contain control
238 * Walking the graph starting from any node will not reach the block
239 * or any controlflow.
240 * See also copy_const_code() in entity.h.
242 ir_graph *get_const_code_irg(void);
245 /** The phase state for the program.
247 * The phase state of the whole program is
248 * building: if at least one graph is state_building
249 * or one type is incomplete.
250 * high: all graphs are in state high or low, all types are constructed.
251 * low: all graphs are in state low, all types are in state layout fixed.
253 irg_phase_state get_irp_phase_state(void);
254 void set_irp_phase_state(irg_phase_state s);
256 irg_outs_state get_irp_ip_outs_state(void);
257 void set_irp_ip_outs_inconsistent(void);
260 irg_callee_info_state get_irp_callee_info_state(void);
261 void set_irp_callee_info_state(irg_callee_info_state s);
263 /** Returns a new, unique exception region number. */
264 ir_exc_region_t get_irp_next_region_nr(void);
266 /** Returns a new, unique label number. */
267 ir_label_t get_irp_next_label_nr(void);
269 /** Add a new global asm include. */
270 void add_irp_asm(ident *asm_string);
272 /** Return the number of global asm includes. */
273 int get_irp_n_asms(void);
275 /** Return the global asm include at position pos. */
276 ident *get_irp_asm(int pos);