avoid unnecessary passing around of arch_env_t* in backend APIs
[libfirm] / ir / be / ia32 / bearch_ia32_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       This is the main ia32 firm backend driver.
23  * @author      Christian Wuerdig
24  * @version     $Id$
25  */
26 #ifndef FIRM_BE_IA32_BEARCH_IA32_T_H
27 #define FIRM_BE_IA32_BEARCH_IA32_T_H
28
29 #include "config.h"
30 #include "pmap.h"
31 #include "debug.h"
32 #include "ia32_nodes_attr.h"
33 #include "set.h"
34 #include "pdeq.h"
35
36 #include "be.h"
37 #include "../bemachine.h"
38 #include "../beemitter.h"
39
40 #ifdef NDEBUG
41 #define SET_IA32_ORIG_NODE(n, o)
42 #else  /* ! NDEBUG */
43 #define SET_IA32_ORIG_NODE(n, o) set_ia32_orig_node(n, o)
44 #endif /* NDEBUG */
45
46 /* some typedefs */
47 typedef enum ia32_optimize_t ia32_optimize_t;
48 typedef enum cpu_support     cpu_support;
49 typedef enum fp_support      fp_support;
50
51 typedef struct ia32_isa_t            ia32_isa_t;
52 typedef struct ia32_code_gen_t       ia32_code_gen_t;
53 typedef struct ia32_irn_ops_t        ia32_irn_ops_t;
54 typedef struct ia32_intrinsic_env_t  ia32_intrinsic_env_t;
55
56 /**
57  * IA32 code generator
58  */
59 struct ia32_code_gen_t {
60         const arch_code_generator_if_t *impl;          /**< implementation */
61         ir_graph                       *irg;           /**< current irg */
62         set                            *reg_set;       /**< set to memorize registers for non-ia32 nodes (e.g. phi nodes) */
63         ia32_isa_t                     *isa;           /**< for fast access to the isa object */
64         ir_node                        **blk_sched;    /**< an array containing the scheduled blocks */
65         unsigned                       do_x87_sim:1;   /**< set to 1 if x87 simulation should be enforced */
66         unsigned                       dump:1;         /**< set to 1 if graphs should be dumped */
67         unsigned                       gprof:1;        /**< set to 1 grof profiling is in use */
68         ir_node                        *noreg_gp;       /**< unique NoReg_GP node */
69         ir_node                        *noreg_vfp;      /**< unique NoReg_VFP node */
70         ir_node                        *noreg_xmm;      /**< unique NoReg_XMM node */
71
72         ir_node                        *fpu_trunc_mode; /**< truncate fpu mode */
73         ir_node                        *get_eip;        /**< get eip node */
74
75         struct obstack                 *obst;
76 };
77
78 /**
79  * IA32 ISA object
80  */
81 struct ia32_isa_t {
82         arch_env_t             base;          /**< must be derived from arch_env_t */
83         pmap                  *regs_16bit;    /**< Contains the 16bits names of the gp registers */
84         pmap                  *regs_8bit;     /**< Contains the 8bits names of the gp registers */
85         pmap                  *regs_8bit_high; /**< contains the high part of the 8 bit names of the gp registers */
86         pmap                  *types;         /**< A map of modes to primitive types */
87         pmap                  *tv_ent;        /**< A map of entities that store const tarvals */
88         ia32_code_gen_t       *cg;            /**< the current code generator */
89         const be_machine_t    *cpu;           /**< the abstract machine */
90 #ifndef NDEBUG
91         struct obstack        *name_obst;     /**< holds the original node names (for debugging) */
92 #endif /* NDEBUG */
93 };
94
95 /**
96  * A helper type collecting needed info for IA32 intrinsic lowering.
97  */
98 struct ia32_intrinsic_env_t {
99         ia32_isa_t *isa;          /**< the isa object */
100         ir_graph   *irg;          /**< the irg, these entities belong to */
101         ir_entity  *divdi3;       /**< entity for __divdi3 library call */
102         ir_entity  *moddi3;       /**< entity for __moddi3 library call */
103         ir_entity  *udivdi3;      /**< entity for __udivdi3 library call */
104         ir_entity  *umoddi3;      /**< entity for __umoddi3 library call */
105 };
106
107 typedef enum transformer_t {
108         TRANSFORMER_DEFAULT,
109 #ifdef FIRM_GRGEN_BE
110         TRANSFORMER_PBQP,
111         TRANSFORMER_RAND
112 #endif
113 } transformer_t;
114
115 #ifdef FIRM_GRGEN_BE
116 /** The selected transformer. */
117 extern transformer_t be_transformer;
118
119 #else
120 #define be_transformer TRANSFORMER_DEFAULT
121 #endif
122
123 /** The mode for the floating point control word. */
124 extern ir_mode *mode_fpcw;
125
126 /** The current code generator. */
127 extern ia32_code_gen_t *ia32_current_cg;
128
129 /**
130  * Returns the unique per irg GP NoReg node.
131  */
132 ir_node *ia32_new_NoReg_gp(ia32_code_gen_t *cg);
133 ir_node *ia32_new_NoReg_xmm(ia32_code_gen_t *cg);
134 ir_node *ia32_new_NoReg_vfp(ia32_code_gen_t *cg);
135
136 /**
137  * Returns the unique per irg FPU truncation mode node.
138  */
139 ir_node *ia32_new_Fpu_truncate(ia32_code_gen_t *cg);
140
141 /**
142  * Split instruction with source AM into Load and separate instruction.
143  * @return result of the Load
144  */
145 ir_node *turn_back_am(ir_node *node);
146
147 /**
148  * Maps all intrinsic calls that the backend support
149  * and map all instructions the backend did not support
150  * to runtime calls.
151  */
152 void ia32_handle_intrinsics(void);
153
154 /**
155  * Ia32 implementation.
156  *
157  * @param method   the method type of the emulation function entity
158  * @param op       the emulated ir_op
159  * @param imode    the input mode of the emulated opcode
160  * @param omode    the output mode of the emulated opcode
161  * @param context  the context parameter
162  */
163 ir_entity *ia32_create_intrinsic_fkt(ir_type *method, const ir_op *op,
164                                      const ir_mode *imode, const ir_mode *omode,
165                                      void *context);
166
167 /**
168  * Return the stack entity that contains the return address.
169  */
170 ir_entity *ia32_get_return_address_entity(void);
171
172 /**
173  * Return the stack entity that contains the frame address.
174  */
175 ir_entity *ia32_get_frame_address_entity(void);
176
177 #endif