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
44 #include "firm_types.h"
48 typedef enum ir_segment_t {
50 /** "normal" global data */
51 IR_SEGMENT_GLOBAL = IR_SEGMENT_FIRST,
52 /** thread local storage segment */
53 IR_SEGMENT_THREAD_LOCAL,
55 * the constructors segment. Contains pointers to functions which are
56 * executed on module initialization (program start or when a library is
59 IR_SEGMENT_CONSTRUCTORS,
60 /** like constructors, but functions are executed on module exit */
61 IR_SEGMENT_DESTRUCTORS,
63 IR_SEGMENT_LAST = IR_SEGMENT_DESTRUCTORS
65 ENUM_COUNTABLE(ir_segment_t)
68 * A variable pointing to the current irp (program or module).
69 * This variable should be considered constant. Moreover, one should use get_irp()
70 * to get access the the irp.
73 * Think of the irp as the "handle" of a program.
75 FIRM_API ir_prog *irp;
78 FIRM_API void irp_reserve_resources(ir_prog *irp, ir_resources_t resources);
79 FIRM_API void irp_free_resources(ir_prog *irp, ir_resources_t resources);
80 FIRM_API ir_resources_t irp_resources_reserved(const ir_prog *irp);
82 #define irp_reserve_resources(irp, resources)
83 #define irp_free_resources(irp, resources)
84 #define irp_resources_reserved(irp) 0
88 * Returns the current irp from where everything in the current module
93 FIRM_API ir_prog *get_irp(void);
98 FIRM_API void set_irp(ir_prog *irp);
101 * Creates a new ir_prog (a module or compilation unit).
102 * Note: This does not set irp to the newly created ir_prog
104 * @param name the name of this irp (module)
106 FIRM_API ir_prog *new_ir_prog(const char *name);
108 /** frees all memory used by irp. Types in type list and irgs in irg
109 * list must be freed by hand before. */
110 FIRM_API void free_ir_prog(void);
112 /** Sets the file name / executable name or the like. Initially the
113 ident 'no_name_set'. */
114 FIRM_API void set_irp_prog_name(ident *name);
116 /** Returns true if the user ever set a program name */
117 FIRM_API int irp_prog_name_is_set(void);
119 /** Gets the name of the current irp. */
120 FIRM_API ident *get_irp_ident(void);
122 /** Gets the name of the current irp. */
123 FIRM_API const char *get_irp_name(void);
125 /** Gets the main routine of the compiled program. */
126 FIRM_API ir_graph *get_irp_main_irg(void);
128 /** Sets the main routine of the compiled program. */
129 FIRM_API void set_irp_main_irg(ir_graph *main_irg);
131 /** Adds irg to the list of ir graphs in the current irp. */
132 FIRM_API void add_irp_irg(ir_graph *irg);
134 /** Removes irg from the list of irgs and
135 shrinks the list by one. */
136 FIRM_API void remove_irp_irg_from_list(ir_graph *irg);
137 /** Removes irg from the list of irgs, deallocates it and
138 shrinks the list by one. */
139 FIRM_API void remove_irp_irg(ir_graph *irg);
141 /** returns the biggest not used irg index number */
142 FIRM_API int get_irp_last_idx(void);
144 /** Returns the number of ir graphs in the irp. */
145 FIRM_API int get_irp_n_irgs(void);
147 /** Returns the ir graph at position pos in the irp. */
148 FIRM_API ir_graph *get_irp_irg(int pos);
150 /** Sets the ir graph at position pos. */
151 FIRM_API void set_irp_irg(int pos, ir_graph *irg);
154 * Returns the type containing the entities for a segment.
156 * @param segment the segment
158 FIRM_API ir_type *get_segment_type(ir_segment_t segment);
161 * @brief Changes a segment segment type for the program.
164 FIRM_API void set_segment_type(ir_segment_t segment, ir_type *new_type);
167 * Returns the "global" type of the irp.
168 * Upon creation this is an empty class type.
169 * This is a convenience function for get_segment_type(IR_SEGMENT_GLOBAL)
171 FIRM_API ir_type *get_glob_type(void);
174 * Returns the "thread local storage" type of the irp.
175 * Upon creation this is an empty struct type.
176 * This is a convenience function for get_segment_type(IR_SEGMENT_THREAD_LOCAL)
178 FIRM_API ir_type *get_tls_type(void);
180 /** Adds type to the list of types in irp. */
181 FIRM_API void add_irp_type(ir_type *typ);
183 /** Removes type from the list of types, deallocates it and
184 shrinks the list by one. */
185 FIRM_API void remove_irp_type(ir_type *typ);
188 * Returns the number of all types in the irp.
191 FIRM_API int get_irp_n_types(void);
194 * Returns the type at position pos in the irp.
197 FIRM_API ir_type *get_irp_type(int pos);
200 * Overwrites the type at position pos with another type.
203 FIRM_API void set_irp_type(int pos, ir_type *typ);
205 /** Returns the number of all modes in the irp. */
206 FIRM_API int get_irp_n_modes(void);
208 /** Returns the mode at position pos in the irp. */
209 FIRM_API ir_mode *get_irp_mode(int pos);
211 /** Adds opcode to the list of opcodes in irp. */
212 FIRM_API void add_irp_opcode(ir_op *opcode);
214 /** Removes opcode from the list of opcodes, deallocates it and
215 shrinks the list by one. */
216 FIRM_API void remove_irp_opcode(ir_op *opcode);
218 /** Returns the number of all opcodes in the irp. */
219 FIRM_API int get_irp_n_opcodes(void);
221 /** Returns the opcode at position pos in the irp. */
222 FIRM_API ir_op *get_irp_opcode(int pos);
224 /** Sets the generic function pointer of all opcodes to NULL */
225 FIRM_API void clear_irp_opcodes_generic_func(void);
228 /** Return the graph for global constants of the current irp.
230 * Returns an irgraph that only contains constant expressions for
231 * constant entities. Do not use any access function for this
232 * graph, do not generate code for this graph. This graph contains
233 * only one block. The constant expressions may not contain control
235 * Walking the graph starting from any node will not reach the block
236 * or any controlflow.
237 * See also copy_const_code() in entity.h.
239 FIRM_API ir_graph *get_const_code_irg(void);
242 /** The phase state for the program.
244 * The phase state of the whole program is
245 * building: if at least one graph is state_building
246 * or one type is incomplete.
247 * high: all graphs are in state high or low, all types are constructed.
248 * low: all graphs are in state low, all types are in state layout fixed.
250 FIRM_API irg_phase_state get_irp_phase_state(void);
251 FIRM_API void set_irp_phase_state(irg_phase_state s);
253 FIRM_API irg_outs_state get_irp_ip_outs_state(void);
254 FIRM_API void set_irp_ip_outs_inconsistent(void);
257 * Creates an ir_prog pass for set_irp_phase_state().
259 * @param name the name of this pass or NULL
260 * @param state the state to set
262 * @return the newly created ir_prog pass
264 FIRM_API ir_prog_pass_t *set_irp_phase_state_pass(const char *name,
265 irg_phase_state state);
267 FIRM_API irg_callee_info_state get_irp_callee_info_state(void);
268 FIRM_API void set_irp_callee_info_state(irg_callee_info_state s);
270 /** Returns a new, unique exception region number. */
271 FIRM_API ir_exc_region_t get_irp_next_region_nr(void);
273 /** Returns a new, unique label number. */
274 FIRM_API ir_label_t get_irp_next_label_nr(void);
276 /** Add a new global asm include. */
277 FIRM_API void add_irp_asm(ident *asm_string);
279 /** Return the number of global asm includes. */
280 FIRM_API int get_irp_n_asms(void);
282 /** Return the global asm include at position pos. */
283 FIRM_API ident *get_irp_asm(int pos);