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 * - the output file name
41 #ifndef FIRM_IR_IRPROG_H
42 #define FIRM_IR_IRPROG_H
45 #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,
64 IR_SEGMENT_LAST = IR_SEGMENT_DESTRUCTORS
66 ENUM_COUNTABLE(ir_segment_t)
69 * A variable pointing to the current irp (program or module).
70 * This variable should be considered constant. Moreover, one should use get_irp()
71 * to get access the the irp.
73 * @note Think of the irp as the "handle" of a program.
75 FIRM_API ir_prog *irp;
77 typedef enum irp_resources_t {
78 IRP_RESOURCE_NONE = 0,
79 IRP_RESOURCE_IRG_LINK = 1 << 0,
80 IRP_RESOURCE_ENTITY_LINK = 1 << 1,
81 IRP_RESOURCE_TYPE_VISITED = 1 << 2,
82 IRP_RESOURCE_TYPE_LINK = 1 << 3,
84 ENUM_BITSET(irp_resources_t)
87 FIRM_API void irp_reserve_resources(ir_prog *irp, irp_resources_t resources);
88 FIRM_API void irp_free_resources(ir_prog *irp, irp_resources_t resources);
89 FIRM_API irp_resources_t irp_resources_reserved(const ir_prog *irp);
91 #define irp_reserve_resources(irp, resources) (void)0
92 #define irp_free_resources(irp, resources) (void)0
93 #define irp_resources_reserved(irp) 0
97 * Returns the current irp from where everything in the current module
102 FIRM_API ir_prog *get_irp(void);
107 FIRM_API void set_irp(ir_prog *irp);
110 * Creates a new ir_prog (a module or compilation unit).
111 * Note: This does not set irp to the newly created ir_prog
113 * @param name the name of this irp (module)
115 FIRM_API ir_prog *new_ir_prog(const char *name);
117 /** frees all memory used by irp. Types in type list and irgs in irg
118 * list must be freed by hand before. */
119 FIRM_API void free_ir_prog(void);
121 /** Sets the file name / executable name or the like. Initially the
122 ident 'no_name_set'. */
123 FIRM_API void set_irp_prog_name(ident *name);
125 /** Returns true if the user ever set a program name */
126 FIRM_API int irp_prog_name_is_set(void);
128 /** Gets the name of the current irp. */
129 FIRM_API ident *get_irp_ident(void);
131 /** Gets the name of the current irp. */
132 FIRM_API const char *get_irp_name(void);
134 /** Gets the main routine of the compiled program. */
135 FIRM_API ir_graph *get_irp_main_irg(void);
137 /** Sets the main routine of the compiled program. */
138 FIRM_API void set_irp_main_irg(ir_graph *main_irg);
140 /** Adds irg to the list of ir graphs in the current irp. */
141 FIRM_API void add_irp_irg(ir_graph *irg);
143 /** Removes irg from the list of irgs and
144 shrinks the list by one. */
145 FIRM_API void remove_irp_irg_from_list(ir_graph *irg);
146 /** Removes irg from the list of irgs, deallocates it and
147 shrinks the list by one. */
148 FIRM_API void remove_irp_irg(ir_graph *irg);
150 /** returns the biggest not used irg index number */
151 FIRM_API size_t get_irp_last_idx(void);
153 /** Returns the number of ir graphs in the irp. */
154 FIRM_API size_t get_irp_n_irgs(void);
156 /** Returns the ir graph at position pos in the irp. */
157 FIRM_API ir_graph *get_irp_irg(size_t pos);
159 /** Sets the ir graph at position pos. */
160 FIRM_API void set_irp_irg(size_t pos, ir_graph *irg);
163 * Returns the type containing the entities for a segment.
165 * @param segment the segment
167 FIRM_API ir_type *get_segment_type(ir_segment_t segment);
170 * @brief Changes a segment segment type for the program.
173 FIRM_API void set_segment_type(ir_segment_t segment, ir_type *new_type);
176 * Returns the "global" type of the irp.
177 * Upon creation this is an empty class type.
178 * This is a convenience function for get_segment_type(IR_SEGMENT_GLOBAL)
180 FIRM_API ir_type *get_glob_type(void);
183 * Returns the "thread local storage" type of the irp.
184 * Upon creation this is an empty struct type.
185 * This is a convenience function for get_segment_type(IR_SEGMENT_THREAD_LOCAL)
187 FIRM_API ir_type *get_tls_type(void);
189 /** Adds type to the list of types in irp. */
190 FIRM_API void add_irp_type(ir_type *typ);
192 /** Removes type from the list of types, deallocates it and
193 shrinks the list by one. */
194 FIRM_API void remove_irp_type(ir_type *typ);
197 * Returns the number of all types in the irp.
200 FIRM_API size_t get_irp_n_types(void);
203 * Returns the type at position pos in the irp.
206 FIRM_API ir_type *get_irp_type(size_t pos);
209 * Overwrites the type at position pos with another type.
212 FIRM_API void set_irp_type(size_t pos, ir_type *typ);
214 /** Returns the number of all modes in the irp. */
215 FIRM_API size_t get_irp_n_modes(void);
217 /** Returns the mode at position pos in the irp. */
218 FIRM_API ir_mode *get_irp_mode(size_t pos);
220 /** Adds opcode to the list of opcodes in irp. */
221 FIRM_API void add_irp_opcode(ir_op *opcode);
223 /** Removes opcode from the list of opcodes, deallocates it and
224 shrinks the list by one. */
225 FIRM_API void remove_irp_opcode(ir_op *opcode);
227 /** Returns the number of all opcodes in the irp. */
228 FIRM_API size_t get_irp_n_opcodes(void);
230 /** Returns the opcode at position pos in the irp. */
231 FIRM_API ir_op *get_irp_opcode(size_t pos);
233 /** Sets the generic function pointer of all opcodes to NULL */
234 FIRM_API void clear_irp_opcodes_generic_func(void);
237 /** Return the graph for global constants of the current irp.
239 * Returns an irgraph that only contains constant expressions for
240 * constant entities. Do not use any access function for this
241 * graph, do not generate code for this graph. This graph contains
242 * only one block. The constant expressions may not contain control
244 * Walking the graph starting from any node will not reach the block
245 * or any controlflow.
246 * See also copy_const_code() in entity.h.
248 FIRM_API ir_graph *get_const_code_irg(void);
251 /** The phase state for the program.
253 * The phase state of the whole program is
254 * building: if at least one graph is state_building
255 * or one type is incomplete.
256 * high: all graphs are in state high or low, all types are constructed.
257 * low: all graphs are in state low, all types are in state layout fixed.
259 FIRM_API irg_phase_state get_irp_phase_state(void);
260 FIRM_API void set_irp_phase_state(irg_phase_state s);
263 * Creates an ir_prog pass for set_irp_phase_state().
265 * @param name the name of this pass or NULL
266 * @param state the state to set
268 * @return the newly created ir_prog pass
270 FIRM_API ir_prog_pass_t *set_irp_phase_state_pass(const char *name,
271 irg_phase_state state);
273 FIRM_API irg_callee_info_state get_irp_callee_info_state(void);
274 FIRM_API void set_irp_callee_info_state(irg_callee_info_state s);
276 /** Returns a new, unique exception region number. */
277 FIRM_API ir_exc_region_t get_irp_next_region_nr(void);
279 /** Returns a new, unique label number. */
280 FIRM_API ir_label_t get_irp_next_label_nr(void);
282 /** Add a new global asm include. */
283 FIRM_API void add_irp_asm(ident *asm_string);
285 /** Return the number of global asm includes. */
286 FIRM_API size_t get_irp_n_asms(void);
288 /** Return the global asm include at position pos. */
289 FIRM_API ident *get_irp_asm(size_t pos);
291 /** Return whether optimization dump vcg graphs */
292 FIRM_API int get_irp_optimization_dumps(void);
294 /** Enable vcg dumping of optimization */
295 FIRM_API void enable_irp_optimization_dumps(void);