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