660f3fc297d474a9705942c03c3f0a955abf486c
[libfirm] / ir / ir / irprog_t.h
1 /*
2  * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
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.
10  *
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.
14  *
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
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief    Entry point to the representation of a whole program 0-- private header.
23  * @author   Goetz Lindenmaier
24  * @date     2000
25  * @version  $Id$
26  */
27 #ifndef FIRM_IR_IRPROG_T_H
28 #define FIRM_IR_IRPROG_T_H
29
30 #ifdef HAVE_CONFIG_H
31 #include "firm_config.h"
32 #endif
33
34 #include "irprog.h"
35 #include "irgraph.h"
36 #include "pseudo_irg.h"
37 #include "ircgcons.h"
38 #include "firm_common_t.h"
39 #include "irtypeinfo.h"
40 #include "irmemory.h"
41
42 #include "callgraph.h"
43 #include "field_temperature.h"
44 #include "execution_frequency.h"
45
46 #include "array.h"
47
48 /** ir_prog */
49 struct ir_prog {
50         firm_kind kind;                 /**< must be k_ir_prog */
51         ident     *name;                /**< A file name or the like. */
52         ir_graph  *main_irg;            /**< The entry point to the compiled program
53                                              or NULL if no point exists. */
54         ir_graph **graphs;              /**< A list of all graphs in the ir. */
55         ir_graph **pseudo_graphs;       /**< A list of all pseudo graphs in the ir. See pseudo_irg.c */
56         ir_graph  *const_code_irg;      /**< This ir graph gives the proper environment
57                                              to allocate nodes the represent values
58                                              of constant entities. It is not meant as
59                                              a procedure.  */
60         ir_type   *glob_type;           /**< The global type.  Must be a class as it can
61                                              have fields and procedures.  */
62         ir_type   *tls_type;            /**< The thread local storage type.  Must be a struct as it can
63                                              only have fields.  */
64         ir_type  **types;               /**< A list of all types in the ir. */
65         ir_mode  **modes;               /**< A list of all modes in the ir. */
66         ir_op    **opcodes;             /**< A list of all opcodes in the ir. */
67
68         /* -- states of and access to generated information -- */
69         irg_phase_state phase_state;    /**< The state of construction. */
70
71         ip_view_state ip_view;          /**< The state of interprocedural view. */
72
73         irg_outs_state outs_state;      /**< The state of out edges of ir nodes. */
74         ir_node **ip_outedges;          /**< A huge Array that contains all out edges
75                                              in interprocedural view. */
76         irg_outs_state trouts_state;    /**< The state of out edges of type information. */
77
78         irg_callee_info_state callee_info_state; /**< Validity of callee information.
79                                                       Contains the lowest value or all irgs.  */
80         ir_typeinfo_state typeinfo_state;    /**< Validity of type information. */
81         inh_transitive_closure_state inh_trans_closure_state;  /**< State of transitive closure
82                                                                     of inheritance relations. */
83
84         irp_callgraph_state callgraph_state; /**< The state of the callgraph. */
85         ir_loop *outermost_cg_loop;          /**< For callgraph analysis: entry point
86                                                       to looptree over callgraph. */
87         int max_callgraph_loop_depth;        /**< needed in callgraph. */
88         int max_callgraph_recursion_depth;   /**< needed in callgraph. */
89         double max_method_execution_frequency;  /**< needed in callgraph. */
90         irp_temperature_state temperature_state; /**< accumulated temperatures computed? */
91         exec_freq_state execfreq_state;      /**< The state of execution frequency information */
92         loop_nesting_depth_state lnd_state;  /**< The state of loop nesting depth information. */
93         ir_class_cast_state class_cast_state;    /**< The state of cast operations in code. */
94         ir_address_taken_computed_state globals_adr_taken_state;  /**< Address taken state of the globals. */
95
96         ir_exc_region_t last_region_nr;      /**< The last exception region number that was assigned. */
97 #ifdef DEBUG_libfirm
98         long max_node_nr;                    /**< to generate unique numbers for nodes. */
99 #endif
100 };
101
102 /** Adds mode to the list of modes in irp. */
103 void  add_irp_mode(ir_mode *mode);
104
105 /* INLINE functions */
106
107 static INLINE ir_type *
108 _get_glob_type(void) {
109         assert(irp);
110         return irp->glob_type = skip_tid(irp->glob_type);
111 }
112
113 static INLINE ir_type *
114 _get_tls_type(void) {
115         assert(irp);
116         return irp->tls_type = skip_tid(irp->tls_type);
117 }
118
119 static INLINE int
120 _get_irp_n_irgs(void) {
121         assert (irp && irp->graphs);
122         if (get_visit_pseudo_irgs()) return get_irp_n_allirgs();
123         return ARR_LEN(irp->graphs);
124 }
125
126 static INLINE ir_graph *
127 _get_irp_irg(int pos){
128         if (get_visit_pseudo_irgs()) return get_irp_allirg(pos);
129         assert(0 <= pos && pos <= _get_irp_n_irgs());
130         return irp->graphs[pos];
131 }
132
133
134 static INLINE int
135 _get_irp_n_types(void) {
136         assert (irp && irp->types);
137         return ARR_LEN(irp->types);
138 }
139
140 static INLINE ir_type *
141 _get_irp_type(int pos) {
142         assert (irp && irp->types);
143         /* Don't set the skip_tid result so that no double entries are generated. */
144         return skip_tid(irp->types[pos]);
145 }
146
147 static INLINE int
148 _get_irp_n_modes(void) {
149         assert (irp && irp->modes);
150         return ARR_LEN(irp->modes);
151 }
152
153 static INLINE ir_mode *
154 _get_irp_mode(int pos) {
155         assert (irp && irp->modes);
156         return irp->modes[pos];
157 }
158
159 static INLINE int
160 _get_irp_n_opcodes(void) {
161         assert (irp && irp->opcodes);
162         return ARR_LEN(irp->opcodes);
163 }
164
165 static INLINE ir_op *
166 _get_irp_opcode(int pos) {
167         assert (irp && irp->opcodes);
168         return irp->opcodes[pos];
169 }
170
171 #ifdef DEBUG_libfirm
172 /** Returns a new, unique number to number nodes or the like. */
173 static INLINE long
174 get_irp_new_node_nr(void) {
175         assert(irp);
176         return irp->max_node_nr++;
177 }
178 #endif /* DEBUG_libfirm */
179
180 static INLINE ir_graph *
181 _get_const_code_irg(void) {
182         return irp->const_code_irg;
183 }
184
185 /** Returns a new, unique exception region number. */
186 static INLINE ir_exc_region_t
187 _get_irp_next_region_nr(void) {
188         assert(irp);
189         return ++irp->last_region_nr;
190 }
191
192 void           set_irp_ip_outedges(ir_node ** ip_outedges);
193 ir_node**      get_irp_ip_outedges(void);
194
195 /** initializes ir_prog. Constructs only the basic lists */
196 void init_irprog_1(void);
197
198 /** Completes ir_prog. */
199 void init_irprog_2(void);
200
201 /* Inline functions. */
202 #define get_irp_n_irgs()          _get_irp_n_irgs()
203 #define get_irp_irg(pos)          _get_irp_irg(pos)
204 #define get_irp_n_types()         _get_irp_n_types()
205 #define get_irp_type(pos)         _get_irp_type(pos)
206 #define get_irp_n_modes()         _get_irp_n_modes()
207 #define get_irp_mode(pos)         _get_irp_mode(pos)
208 #define get_irp_n_opcodes()       _get_irp_n_opcodes()
209 #define get_irp_opcode(pos)       _get_irp_opcode(pos)
210 #define get_const_code_irg()      _get_const_code_irg()
211 #define get_glob_type()           _get_glob_type()
212 #define get_tls_type()            _get_tls_type()
213 #define get_irp_next_region_nr()  _get_irp_next_region_nr()
214
215 #endif