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
26 * Intermediate Representation (IR) of a program.
29 #ifndef FIRM_IR_IRPROG_H
30 #define FIRM_IR_IRPROG_H
33 #include "firm_types.h"
38 * @defgroup ir_prog Program
40 * ir_prog keeps information about a program:
41 * - A reference point to the method to be executed on program start.
42 * - A list of all procedures.
43 * - A list of all types.
44 * - A global type that contains all global variables and procedures that do
45 * not belong to a class. This type represents the data segment of the
46 * program. It is not the base class of
47 * all classes in a class hierarchy (as, e.g., "object" in java).
48 * - A degenerated graph that contains constant expressions.
49 * - the output file name
57 * A progrom has a number of special segments at the toplevel which modify
58 * the behaviour of the entities in them.
60 typedef enum ir_segment_t {
62 /** "normal" global data */
63 IR_SEGMENT_GLOBAL = IR_SEGMENT_FIRST,
64 /** thread local storage segment */
65 IR_SEGMENT_THREAD_LOCAL,
67 * the constructors segment. Contains pointers to functions which are
68 * executed on module initialization (program start or when a library is
71 IR_SEGMENT_CONSTRUCTORS,
72 /** like constructors, but functions are executed on module exit */
73 IR_SEGMENT_DESTRUCTORS,
75 IR_SEGMENT_LAST = IR_SEGMENT_DESTRUCTORS
77 ENUM_COUNTABLE(ir_segment_t)
80 * A variable pointing to the current irp (program or module).
81 * This variable should be considered constant. Moreover, one should use get_irp()
82 * to get access the the irp.
84 * @note Think of the irp as the "handle" of a program.
86 FIRM_API ir_prog *irp;
89 * Resources usable by algorithms modifying the program
91 typedef enum irp_resources_t {
92 IRP_RESOURCE_NONE = 0, /**< no resource */
93 /** irg link field @see set_irg_link(), get_irg_link() */
94 IRP_RESOURCE_IRG_LINK = 1 << 0,
95 /** entity link field @see set_entity_link(), get_entity_link() */
96 IRP_RESOURCE_ENTITY_LINK = 1 << 1,
97 /** type visited field @see type_visited(), mark_type_visited(),
98 * inc_master_type_visited() */
99 IRP_RESOURCE_TYPE_VISITED = 1 << 2,
100 /** type link field @see set_type_link(), get_type_link() */
101 IRP_RESOURCE_TYPE_LINK = 1 << 3,
103 ENUM_BITSET(irp_resources_t)
107 * Reserve resources available for a whole program.
109 * This is a debug tool: All code should properly allocate the resources it uses
110 * so if two interlocked algorithms use the same resources that bug will get
113 FIRM_API void irp_reserve_resources(ir_prog *irp, irp_resources_t resources);
114 /** Frees resources availabel for a whole program. */
115 FIRM_API void irp_free_resources(ir_prog *irp, irp_resources_t resources);
116 /** Returns currently reserved whole program resources. */
117 FIRM_API irp_resources_t irp_resources_reserved(const ir_prog *irp);
119 #define irp_reserve_resources(irp, resources) (void)0
120 #define irp_free_resources(irp, resources) (void)0
121 #define irp_resources_reserved(irp) 0
125 * Returns the current irp from where everything in the current module
130 FIRM_API ir_prog *get_irp(void);
132 /** Sets current irp */
133 FIRM_API void set_irp(ir_prog *irp);
136 * Creates a new ir_prog (a module or compilation unit).
137 * Note: This does not set irp to the newly created ir_prog
139 * @param name the name of this irp (module)
141 FIRM_API ir_prog *new_ir_prog(const char *name);
143 /** Frees all memory used by irp. Types in type list and irgs in irg
144 * list must be freed by hand before. */
145 FIRM_API void free_ir_prog(void);
147 /** Sets the file name / executable name or the like. Initially the
148 ident 'no_name_set'. */
149 FIRM_API void set_irp_prog_name(ident *name);
151 /** Returns true if the user ever set a program name */
152 FIRM_API int irp_prog_name_is_set(void);
154 /** Returns the name of the current irp. */
155 FIRM_API ident *get_irp_ident(void);
157 /** Returns the name of the current irp. */
158 FIRM_API const char *get_irp_name(void);
160 /** Returns the main routine of the compiled program. */
161 FIRM_API ir_graph *get_irp_main_irg(void);
163 /** Sets the main routine of the compiled program. */
164 FIRM_API void set_irp_main_irg(ir_graph *main_irg);
166 /** returns the biggest not used irg index number */
167 FIRM_API size_t get_irp_last_idx(void);
169 /** Returns the number of ir graphs in the irp. */
170 FIRM_API size_t get_irp_n_irgs(void);
172 /** Returns the ir graph at position pos in the irp. */
173 FIRM_API ir_graph *get_irp_irg(size_t pos);
175 /** Sets the ir graph at position pos. */
176 FIRM_API void set_irp_irg(size_t pos, ir_graph *irg);
179 * Returns the type containing the entities for a segment.
181 * @param segment the segment
183 FIRM_API ir_type *get_segment_type(ir_segment_t segment);
186 * @brief Changes a segment segment type for the program.
189 FIRM_API void set_segment_type(ir_segment_t segment, ir_type *new_type);
192 * Returns the "global" type of the irp.
193 * Upon creation this is an empty class type.
194 * This is a convenience function for get_segment_type(IR_SEGMENT_GLOBAL)
196 FIRM_API ir_type *get_glob_type(void);
199 * Returns the "thread local storage" type of the irp.
200 * Upon creation this is an empty struct type.
201 * This is a convenience function for get_segment_type(IR_SEGMENT_THREAD_LOCAL)
203 FIRM_API ir_type *get_tls_type(void);
206 * Returns the number of all types in the irp.
209 FIRM_API size_t get_irp_n_types(void);
212 * Returns the type at position pos in the irp.
215 FIRM_API ir_type *get_irp_type(size_t pos);
218 * Overwrites the type at position pos with another type.
221 FIRM_API void set_irp_type(size_t pos, ir_type *typ);
223 /** Returns the graph for global constants of the current irp.
225 * Returns an irgraph that only contains constant expressions for
226 * constant entities. Do not use any access function for this
227 * graph, do not generate code for this graph. This graph contains
228 * only one block. The constant expressions may not contain control
230 * Walking the graph starting from any node will not reach the block
231 * or any controlflow.
232 * See also copy_const_code() in entity.h.
234 FIRM_API ir_graph *get_const_code_irg(void);
236 /** Returns callee info state for the whole program.
237 * @see get_irg_callee_info_state() */
238 FIRM_API irg_callee_info_state get_irp_callee_info_state(void);
239 /** Sets callee info state for the whole program.
240 * @see set_irg_callee_info_state() */
241 FIRM_API void set_irp_callee_info_state(irg_callee_info_state s);
243 /** Returns a new, unique label number. */
244 FIRM_API ir_label_t get_irp_next_label_nr(void);
246 /** Add a new global asm include. */
247 FIRM_API void add_irp_asm(ident *asm_string);
249 /** Returns the number of global asm includes. */
250 FIRM_API size_t get_irp_n_asms(void);
252 /** Returns the global asm include at position pos. */
253 FIRM_API ident *get_irp_asm(size_t pos);