add is_Minus
[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 poit exist. */
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;  /**< trans closure of inh relations. */
82
83   irp_callgraph_state callgraph_state; /**< The state of the callgraph. */
84   ir_loop *outermost_cg_loop;          /**< For callgraph analysis: entry point
85                                             to looptree over callgraph. */
86   int max_callgraph_loop_depth;        /**< needed in callgraph. */
87   int max_callgraph_recursion_depth;   /**< needed in callgraph. */
88   double max_method_execution_frequency;  /**< needed in callgraph. */
89   irp_temperature_state temperature_state; /**< accumulated temperatures computed? */
90   exec_freq_state execfreq_state;        /**< The state of execution frequency information */
91   loop_nesting_depth_state lnd_state;  /**< The state of loop nesting depth information. */
92   ir_class_cast_state class_cast_state;    /**< The state of cast operations in code. */
93   ir_address_taken_computed_state globals_adr_taken_state;  /**< Address taken state of the globals. */
94
95 #ifdef DEBUG_libfirm
96   long max_node_nr;                   /**< to generate unique numbers for nodes. */
97 #endif
98 };
99
100 /** Adds mode to the list of modes in irp. */
101 void  add_irp_mode(ir_mode *mode);
102
103 /* INLINE functions */
104
105 static INLINE ir_type *
106 _get_glob_type(void) {
107   assert(irp);
108   return irp->glob_type = skip_tid(irp->glob_type);
109 }
110
111 static INLINE ir_type *
112 _get_tls_type(void) {
113   assert(irp);
114   return irp->tls_type = skip_tid(irp->tls_type);
115 }
116
117 static INLINE int
118 _get_irp_n_irgs(void) {
119   assert (irp && irp->graphs);
120   if (get_visit_pseudo_irgs()) return get_irp_n_allirgs();
121   return ARR_LEN(irp->graphs);
122 }
123
124 static INLINE ir_graph *
125 _get_irp_irg(int pos){
126   if (get_visit_pseudo_irgs()) return get_irp_allirg(pos);
127   assert(0 <= pos && pos <= _get_irp_n_irgs());
128   return irp->graphs[pos];
129 }
130
131
132 static INLINE int
133 _get_irp_n_types (void) {
134   assert (irp && irp->types);
135   return ARR_LEN(irp->types);
136 }
137
138 static INLINE ir_type *
139 _get_irp_type(int pos) {
140   assert (irp && irp->types);
141   /* Don't set the skip_tid result so that no double entries are generated. */
142   return skip_tid(irp->types[pos]);
143 }
144
145 static INLINE int
146 _get_irp_n_modes(void) {
147   assert (irp && irp->modes);
148   return ARR_LEN(irp->modes);
149 }
150
151 static INLINE ir_mode *
152 _get_irp_mode(int pos) {
153   assert (irp && irp->modes);
154   return irp->modes[pos];
155 }
156
157 static INLINE int
158 _get_irp_n_opcodes(void) {
159   assert (irp && irp->opcodes);
160   return ARR_LEN(irp->opcodes);
161 }
162
163 static INLINE ir_op *
164 _get_irp_opcode(int pos) {
165   assert (irp && irp->opcodes);
166   return irp->opcodes[pos];
167 }
168
169 #ifdef DEBUG_libfirm
170 /** Returns a new, unique number to number nodes or the like. */
171 static INLINE long
172 get_irp_new_node_nr(void) {
173   assert(irp);
174   return irp->max_node_nr++;
175 }
176 #endif /* DEBUG_libfirm */
177
178 static INLINE ir_graph *
179 _get_const_code_irg(void) {
180   return irp->const_code_irg;
181 }
182
183 void           set_irp_ip_outedges(ir_node ** ip_outedges);
184 ir_node**      get_irp_ip_outedges(void);
185
186 /** initializes ir_prog. Constructs only the basic lists */
187 void init_irprog_1(void);
188
189 /** Completes ir_prog. */
190 void init_irprog_2(void);
191
192 #define get_irp_n_irgs()       _get_irp_n_irgs()
193 #define get_irp_irg(pos)       _get_irp_irg(pos)
194 #define get_irp_n_types()      _get_irp_n_types()
195 #define get_irp_type(pos)      _get_irp_type(pos)
196 #define get_irp_n_modes()      _get_irp_n_modes()
197 #define get_irp_mode(pos)      _get_irp_mode(pos)
198 #define get_irp_n_opcodes()    _get_irp_n_opcodes()
199 #define get_irp_opcode(pos)    _get_irp_opcode(pos)
200 #define get_const_code_irg()   _get_const_code_irg()
201 #define get_glob_type()        _get_glob_type()
202 #define get_tls_type()         _get_tls_type()
203
204 #endif