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 * Datastructure that holds central information about a program
70 * Preliminary documentation ;-)
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 we want to translate libraries or the like correctly
75 * we must replace this by a list.)
76 * - irg: List of all ir graphs in the program.
77 * - type: A list containing all types known to the translated program.
78 * Some types can have several entries in this list (as a result of
79 * using exchange_types()).
80 * - glob_type: The unique global type that is owner of all global entities.
83 typedef struct ir_prog ir_prog;
86 * A variable from where everything in the ir can be accessed.
87 * This variable contains the irp, the "immediate representation program".
88 * This variable should be considered constant. Moreover, one should use get_irp()
89 * to get access the the irp.
92 * Think of the irp as the "handle" of libFirm.
97 * Returns the access points from where everything in the ir can be accessed.
101 ir_prog *get_irp(void);
103 /** Creates a new ir_prog, returns it and sets irp with it.
104 * Automatically called by init_firm() through init_irprog. */
105 ir_prog *new_ir_prog(void);
107 /** frees all memory used by irp. Types in type list and irgs in irg
108 * list must be freed by hand before. */
109 void free_ir_prog(void);
111 /** Sets the file name / executable name or the like. Initially the
112 ident 'no_name_set'. */
113 void set_irp_prog_name(ident *name);
115 /** Returns true if the user ever set a program name */
116 int irp_prog_name_is_set(void);
118 /** Gets the file name / executable name or the like.
120 ident *get_irp_prog_ident(void);
122 /** Gets the file name / executable name or the like.
124 const char *get_irp_prog_name (void);
126 /** Gets the main routine of the compiled program. */
127 ir_graph *get_irp_main_irg(void);
129 /** Sets the main routine of the compiled program. */
130 void set_irp_main_irg(ir_graph *main_irg);
132 /** Adds irg to the list of ir graphs in irp. */
133 void add_irp_irg(ir_graph *irg);
135 /** Removes irg from the list of irgs and
136 shrinks the list by one. */
137 void remove_irp_irg_from_list(ir_graph *irg);
138 /** Removes irg from the list of irgs, deallocates it and
139 shrinks the list by one. */
140 void remove_irp_irg(ir_graph *irg);
142 /** returns the biggest not used irg index number */
143 int get_irp_last_idx(void);
145 /** Returns the number of ir graphs in the irp. */
146 int get_irp_n_irgs(void);
148 /** Returns the ir graph at position pos in the irp. */
149 ir_graph *get_irp_irg(int pos);
151 /** Sets the ir graph at position pos. */
152 void set_irp_irg(int pos, ir_graph *irg);
154 /** Gets the number of graphs _and_ pseudo graphs. */
155 int get_irp_n_allirgs(void);
157 /** Returns the ir graph at position pos of all graphs (including
158 pseudo graphs). Visits first graphs, then pseudo graphs. */
159 ir_graph *get_irp_allirg(int pos);
162 * returns the type containing the entities for a segment
164 ir_type *get_segment_type(ir_segment_t segment);
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 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.
177 ir_type *get_tls_type(void);
179 /** Adds type to the list of types in irp. */
180 void add_irp_type(ir_type *typ);
182 /** Removes type from the list of types, deallocates it and
183 shrinks the list by one. */
184 void remove_irp_type(ir_type *typ);
186 /** Returns the number of all types in the irp. */
187 int get_irp_n_types(void);
189 /** Returns the type at position pos in the irp. */
190 ir_type *get_irp_type(int pos);
192 /** Overwrites the type at position pos with another type. */
193 void set_irp_type(int pos, ir_type *typ);
195 /** Returns the number of all modes in the irp. */
196 int get_irp_n_modes(void);
198 /** Returns the mode at position pos in the irp. */
199 ir_mode *get_irp_mode(int pos);
201 /** Adds opcode to the list of opcodes in irp. */
202 void add_irp_opcode(ir_op *opcode);
204 /** Removes opcode from the list of opcodes, deallocates it and
205 shrinks the list by one. */
206 void remove_irp_opcode(ir_op *opcode);
208 /** Returns the number of all opcodes in the irp. */
209 int get_irp_n_opcodes(void);
211 /** Returns the opcode at position pos in the irp. */
212 ir_op *get_irp_opcode(int pos);
214 /** Sets the generic function pointer of all opcodes to NULL */
215 void clear_irp_opcodes_generic_func(void);
218 /** Return the graph for global constants.
220 * Returns an irgraph that only contains constant expressions for
221 * constant entities. Do not use any access function for this
222 * graph, do not generate code for this graph. This graph contains
223 * only one block. The constant expressions may not contain control
225 * Walking the graph starting from any node will not reach the block
226 * or any controlflow.
227 * See also copy_const_code() in entity.h.
229 ir_graph *get_const_code_irg(void);
232 /** The phase state for the program.
234 * The phase state of the whole program is
235 * building: if at least one graph is state_building
236 * or one type is incomplete.
237 * high: all graphs are in state high or low, all types are constructed.
238 * low: all graphs are in state low, all types are in state layout fixed.
240 irg_phase_state get_irp_phase_state(void);
241 void set_irp_phase_state(irg_phase_state s);
243 irg_outs_state get_irp_ip_outs_state(void);
244 void set_irp_ip_outs_inconsistent(void);
247 irg_callee_info_state get_irp_callee_info_state(void);
248 void set_irp_callee_info_state(irg_callee_info_state s);
250 /** Returns a new, unique exception region number. */
251 ir_exc_region_t get_irp_next_region_nr(void);
253 /** Returns a new, unique label number. */
254 ir_label_t get_irp_next_label_nr(void);
256 /** Add a new global asm include. */
257 void add_irp_asm(ident *asm_string);
259 /** Return the number of global asm includes. */
260 int get_irp_n_asms(void);
262 /** Return the global asm include at position pos. */
263 ident *get_irp_asm(int pos);