3 * File name: ir/ir/irprog.h
4 * Purpose: Entry point to the representation of a whole program.
5 * Author: Goetz Lindenmaier
9 * Copyright: (c) 2000-2003 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
16 * ir representation of a program.
18 * @author Goetz Lindenmaier
20 * This file defines a construct that keeps all information about a
22 * - A reference point to the method to be executed on program start.
23 * - A list of all procedures.
24 * - A list of all types.
25 * - A global type that contais all global variables and procedures that do
26 * not belong to a class. This type represents the data segment of the
27 * program. It is not the base class of
28 * all classes in a class hierarchy (as, e.g., "object" in java).
29 * - A degenerated graph that contains constant expressions.
30 * - interprocedural outs state.
31 * - a flag indicating validity of the interprocedural representation.
32 * - the output file name
35 #ifndef _FIRM_IR_IRPROG_H_
36 #define _FIRM_IR_IRPROG_H_
38 #include "firm_types.h"
43 * Datastructure that holds central information about a program
45 * Preliminary documentation ;-)
47 * - main_irg: The ir graph that is the entry point to the program.
48 * (Anything not reachable from here may be optimized away.
49 * If we want to translate libraries or the like correctly
50 * we must replace this by a list.)
51 * - irg: List of all ir graphs in the program.
52 * - type: A list containing all types known to the translated program.
53 * Some types can have several entries in this list (as a result of
54 * using exchange_types()).
55 * - glob_type: The unique global type that is owner of all global entities.
58 typedef struct ir_prog ir_prog;
61 * A variable from where everything in the ir can be accessed.
62 * This variable contains the irp, the "immediate representation program".
63 * This variable should be considered constant. Moreover, one should use get_irp()
64 * to get access the the irp.
67 * Think of the irp as the "handle" of libFirm.
72 * Returns the access points from where everything in the ir can be accessed.
76 ir_prog *get_irp(void);
78 /** Creates a new ir_prog, returns it and sets irp with it.
79 * Automatically called by init_firm() through init_irprog. */
80 ir_prog *new_ir_prog (void);
82 /** frees all memory used by irp. Types in type list and irgs in irg
83 * list must be freed by hand before. */
84 void free_ir_prog(void);
86 /** Sets the file name / executable name or the like. Initially the
87 ident 'no_name_set'. */
88 void set_irp_prog_name (ident *name);
90 /** Returns true if the user ever set a program name */
91 int irp_prog_name_is_set(void);
93 /** Gets the file name / executable name or the like.
95 ident *get_irp_prog_ident(void);
97 /** Gets the file name / executable name or the like.
99 const char *get_irp_prog_name (void);
101 /** Gets the main routine of the compiled program. */
102 ir_graph *get_irp_main_irg(void);
104 /** Sets the main routine of the compiled program. */
105 void set_irp_main_irg(ir_graph *main_irg);
107 /** Adds irg to the list of ir graphs in irp. */
108 void add_irp_irg(ir_graph *irg);
110 /** Removes irg from the list of irgs and
111 shrinks the list by one. */
112 void remove_irp_irg_from_list(ir_graph *irg);
113 /** Removes irg from the list of irgs, deallocates it and
114 shrinks the list by one. */
115 void remove_irp_irg(ir_graph *irg);
117 /** Returns the number of ir graphs in the irp. */
118 int get_irp_n_irgs(void);
120 /** Returns the ir graph at position pos in the irp. */
121 ir_graph *get_irp_irg(int pos);
123 /** Sets the ir graph at position pos. */
124 void set_irp_irg(int pos, ir_graph *irg);
126 /** Gets the number of graphs _and_ pseudo graphs. */
127 int get_irp_n_allirgs(void);
129 /** Returns the ir graph at position pos of all graphs (including
130 pseudo graphs). Visits first graphs, then pseudo graphs. */
131 ir_graph *get_irp_allirg(int pos);
134 * Returns the "global" type of the irp.
135 * Upon creation this is an empty class type.
137 ir_type *get_glob_type(void);
140 * Returns the "thread local storage" type of the irp.
141 * Upon creation this is an empty struct type.
143 ir_type *get_tls_type(void);
145 /** Adds type to the list of types in irp. */
146 void add_irp_type(ir_type *typ);
148 /** Removes type from the list of types, deallocates it and
149 shrinks the list by one. */
150 void remove_irp_type(ir_type *typ);
152 /** Returns the number of all types in the irp. */
153 int get_irp_n_types(void);
155 /** Returns the type at position pos in the irp. */
156 ir_type *get_irp_type(int pos);
158 /** Overwrites the type at position pos with another type. */
159 void set_irp_type(int pos, ir_type *typ);
161 /** Returns the number of all modes in the irp. */
162 int get_irp_n_modes(void);
164 /** Returns the mode at position pos in the irp. */
165 ir_mode *get_irp_mode(int pos);
167 /** Adds opcode to the list of opcodes in irp. */
168 void add_irp_opcode(ir_op *opcode);
170 /** Removes opcode from the list of opcodes, deallocates it and
171 shrinks the list by one. */
172 void remove_irp_opcode(ir_op *opcode);
174 /** Returns the number of all opcodes in the irp. */
175 int get_irp_n_opcodes(void);
177 /** Returns the opcode at position pos in the irp. */
178 ir_op *get_irp_opcode(int pos);
180 /** Sets the generic function pointer of all opcodes to NULL */
181 void clear_irp_opcodes_generic_func(void);
184 /** Return the graph for global constants.
186 * Returns an irgraph that only contains constant expressions for
187 * constant entities. Do not use any access function for this
188 * graph, do not generate code for this graph. This graph contains
189 * only one block. The constant expressions may not contain control
191 * Walking the graph starting from any node will not reach the block
192 * or any controlflow.
193 * See also copy_const_code() in entity.h.
195 ir_graph *get_const_code_irg(void);
198 /** The phase state for the program.
200 * The phase state of the whole program is
201 * building: if at least one graph is state_building
202 * or one type is incomplete.
203 * high: all graphs are in state high or low, all types are constructed.
204 * low: all graphs are in state low, all types are in state layout fixed.
206 irg_phase_state get_irp_phase_state(void);
207 void set_irp_phase_state(irg_phase_state s);
209 irg_outs_state get_irp_ip_outs_state(void);
210 void set_irp_ip_outs_inconsistent(void);
213 irg_callee_info_state get_irp_callee_info_state(void);
214 void set_irp_callee_info_state(irg_callee_info_state s);
216 #endif /* ifndef _FIRM_IR_IRPROG_H_ */