forbid calls of new_XXX and new_d_XXX when not in phase_building (only new_r_XXX...
[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_irn_ops_t        ia32_irn_ops_t;
53 typedef struct ia32_intrinsic_env_t  ia32_intrinsic_env_t;
54
55 typedef struct ia32_irg_data_t {
56         ir_node  **blk_sched;    /**< an array containing the scheduled blocks */
57         unsigned do_x87_sim:1;   /**< set to 1 if x87 simulation should be enforced */
58         unsigned dump:1;         /**< set to 1 if graphs should be dumped */
59         ir_node  *noreg_gp;       /**< unique NoReg_GP node */
60         ir_node  *noreg_vfp;      /**< unique NoReg_VFP node */
61         ir_node  *noreg_xmm;      /**< unique NoReg_XMM node */
62
63         ir_node  *fpu_trunc_mode; /**< truncate fpu mode */
64         ir_node  *get_eip;        /**< get eip node */
65 } ia32_irg_data_t;
66
67 /**
68  * IA32 ISA object
69  */
70 struct ia32_isa_t {
71         arch_env_t             base;          /**< must be derived from arch_env_t */
72         pmap                  *regs_16bit;    /**< Contains the 16bits names of the gp registers */
73         pmap                  *regs_8bit;     /**< Contains the 8bits names of the gp registers */
74         pmap                  *regs_8bit_high; /**< contains the high part of the 8 bit names of the gp registers */
75         pmap                  *types;         /**< A map of modes to primitive types */
76         pmap                  *tv_ent;        /**< A map of entities that store const tarvals */
77         const be_machine_t    *cpu;           /**< the abstract machine */
78 };
79
80 /**
81  * A helper type collecting needed info for IA32 intrinsic lowering.
82  */
83 struct ia32_intrinsic_env_t {
84         ia32_isa_t *isa;     /**< the isa object */
85         ir_graph   *irg;     /**< the irg, these entities belong to */
86         ir_entity  *divdi3;  /**< entity for __divdi3 library call */
87         ir_entity  *moddi3;  /**< entity for __moddi3 library call */
88         ir_entity  *udivdi3; /**< entity for __udivdi3 library call */
89         ir_entity  *umoddi3; /**< entity for __umoddi3 library call */
90 };
91
92 typedef enum transformer_t {
93         TRANSFORMER_DEFAULT,
94 #ifdef FIRM_GRGEN_BE
95         TRANSFORMER_PBQP,
96         TRANSFORMER_RAND
97 #endif
98 } transformer_t;
99
100 #ifdef FIRM_GRGEN_BE
101 /** The selected transformer. */
102 extern transformer_t be_transformer;
103
104 #else
105 #define be_transformer TRANSFORMER_DEFAULT
106 #endif
107
108 /** The mode for the floating point control word. */
109 extern ir_mode *mode_fpcw;
110
111 static inline ia32_irg_data_t *ia32_get_irg_data(const ir_graph *irg)
112 {
113         return (ia32_irg_data_t*) be_birg_from_irg(irg)->isa_link;
114 }
115
116 /**
117  * Returns the unique per irg GP NoReg node.
118  */
119 ir_node *ia32_new_NoReg_gp(ir_graph *irg);
120 ir_node *ia32_new_NoReg_xmm(ir_graph *irg);
121 ir_node *ia32_new_NoReg_vfp(ir_graph *irg);
122
123 /**
124  * Returns the unique per irg FPU truncation mode node.
125  */
126 ir_node *ia32_new_Fpu_truncate(ir_graph *irg);
127
128 /**
129  * Split instruction with source AM into Load and separate instruction.
130  * @return result of the Load
131  */
132 ir_node *turn_back_am(ir_node *node);
133
134 /**
135  * Maps all intrinsic calls that the backend support
136  * and map all instructions the backend did not support
137  * to runtime calls.
138  */
139 void ia32_handle_intrinsics(void);
140
141 /**
142  * Ia32 implementation.
143  *
144  * @param method   the method type of the emulation function entity
145  * @param op       the emulated ir_op
146  * @param imode    the input mode of the emulated opcode
147  * @param omode    the output mode of the emulated opcode
148  * @param context  the context parameter
149  */
150 ir_entity *ia32_create_intrinsic_fkt(ir_type *method, const ir_op *op,
151                                      const ir_mode *imode, const ir_mode *omode,
152                                      void *context);
153
154 /**
155  * Return the stack entity that contains the return address.
156  */
157 ir_entity *ia32_get_return_address_entity(void);
158
159 /**
160  * Return the stack entity that contains the frame address.
161  */
162 ir_entity *ia32_get_frame_address_entity(void);
163
164 #endif