typo fixed
[libfirm] / ir / be / be_t.h
1 /*
2  * Copyright (C) 1995-2008 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   Internal backend global data structures.
23  * @author  Sebastian Hack
24  * @version $Id$
25  */
26 #ifndef FIRM_BE_BE_T_H
27 #define FIRM_BE_BE_T_H
28
29 #include "firm_types.h"
30 #include "obst.h"
31 #include "debug.h"
32 #include "bitset.h"
33 #include "timing.h"
34 #include "pmap.h"
35
36 #include "be.h"
37 #include "bearch_t.h"
38 #include "beirg.h"
39
40 #define DUMP_NONE       0
41 #define DUMP_INITIAL    (1 << 0)
42 #define DUMP_ABI        (1 << 1)
43 #define DUMP_SCHED      (1 << 2)
44 #define DUMP_PREPARED   (1 << 3)
45 #define DUMP_RA         (1 << 4)
46 #define DUMP_FINAL      (1 << 5)
47 #define DUMP_BE         (1 << 6)
48
49 enum {
50         BE_TIME_OFF,
51         BE_TIME_ON
52 };
53
54 enum {
55         BE_VRFY_OFF,
56         BE_VRFY_WARN,
57         BE_VRFY_ASSERT
58 };
59
60 enum {
61         BE_SCHED_LIST,
62         BE_SCHED_ILP
63 };
64
65 /** Backend options */
66 struct be_options_t {
67         unsigned dump_flags;      /**< backend dumping flags */
68         int  timing;              /**< time the backend phases */
69         int  opt_profile;         /**< instrument code for profiling */
70         int  omit_fp;             /**< try to omit the frame pointer */
71         int  omit_leaf_fp;        /**< try to omit the frame pointer in leaf routines */
72         int  pic;                 /**< create position independent code */
73         int  gprof;               /**< create gprof compatible profiling code */
74         int  vrfy_option;         /**< backend verify option */
75         int  scheduler;           /**< the scheduler */
76         char target_os[128];      /**< target operating system name */
77         char ilp_server[128];     /**< the ilp server name */
78         char ilp_solver[128];     /**< the ilp solver name */
79         int  statev;              /**< enable stat event dumping */
80         char filtev[128];         /**< filter mask for stat events (regex is supported) */
81 };
82
83 struct be_main_env_t {
84         arch_env_t            *arch_env;
85         be_options_t          *options;              /**< backend options */
86         arch_code_generator_t *cg;
87         const char            *cup_name;             /**< name of the compilation unit */
88         pmap                  *ent_trampoline_map;   /**< A map containing PIC trampolines for methods. */
89         ir_type               *pic_trampolines_type; /**< Class type containing all trampolines */
90         pmap                  *ent_pic_symbol_map;
91         ir_type               *pic_symbols_type;
92 };
93
94 extern unsigned short asm_constraint_flags[256];
95
96 void be_init_default_asm_constraint_flags(void);
97
98 /**
99  * Put the registers to be ignored in this IRG into a bitset.
100  * @param birg The backend IRG data structure.
101  * @param cls  The register class.
102  * @param bs   The bitset (may be NULL).
103  * @return The number of registers to be ignored.
104  */
105 unsigned be_put_ignore_regs(const be_irg_t *birg,
106                 const arch_register_class_t *cls, bitset_t *bs);
107
108
109 /**
110  * Initialize the backend. Must be run first in init_firm();
111  */
112 void firm_be_init(void);
113 void firm_be_finish(void);
114
115 extern int be_timing;
116
117 #define BE_TIMER_PUSH(timer)                                              \
118     if (be_timing) {                                                      \
119         int res = ir_timer_push(timer);                                   \
120         (void) res;                                                       \
121                 assert(res && "Timer already on stack, cannot be pushed twice."); \
122     }
123
124 #define BE_TIMER_POP(timer)                                               \
125     if (be_timing) {                                                      \
126         ir_timer_t *tmp = ir_timer_pop();                                 \
127         (void) tmp;                                                       \
128         assert(tmp == timer && "Attempt to pop wrong timer.");            \
129     }
130
131 extern ir_timer_t *t_abi;
132 extern ir_timer_t *t_codegen;
133 extern ir_timer_t *t_sched;
134 extern ir_timer_t *t_constr;
135 extern ir_timer_t *t_finish;
136 extern ir_timer_t *t_emit;
137 extern ir_timer_t *t_other;
138 extern ir_timer_t *t_execfreq;
139 extern ir_timer_t *t_verify;
140 extern ir_timer_t *t_heights;
141 extern ir_timer_t *t_live;         /**< timer for liveness calculation */
142 extern ir_timer_t *t_ssa_constr;   /**< timer for ssa reconstruction */
143 extern ir_timer_t *t_ra_prolog;    /**< timer for prolog */
144 extern ir_timer_t *t_ra_epilog;    /**< timer for epilog */
145 extern ir_timer_t *t_ra_constr;    /**< timer for spill constraints */
146 extern ir_timer_t *t_ra_spill;     /**< timer for spilling */
147 extern ir_timer_t *t_ra_spill_apply;
148 extern ir_timer_t *t_ra_color;     /**< timer for graph coloring */
149 extern ir_timer_t *t_ra_ifg;       /**< timer for building interference graph */
150 extern ir_timer_t *t_ra_copymin;   /**< timer for copy minimization */
151 extern ir_timer_t *t_ra_ssa;       /**< timer for ssa destruction */
152 extern ir_timer_t *t_ra_other;     /**< timer for remaining stuff */
153
154
155 #endif /* FIRM_BE_BE_T_H */