remove $Id$, it doesn't work with git anyway
[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  */
25 #ifndef FIRM_BE_IA32_BEARCH_IA32_T_H
26 #define FIRM_BE_IA32_BEARCH_IA32_T_H
27
28 #include "config.h"
29 #include "pmap.h"
30 #include "debug.h"
31 #include "ia32_nodes_attr.h"
32 #include "set.h"
33 #include "pdeq.h"
34
35 #include "be.h"
36 #include "bemachine.h"
37 #include "beemitter.h"
38 #include "gen_ia32_regalloc_if.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 typedef struct ia32_isa_t            ia32_isa_t;
47 typedef struct ia32_irn_ops_t        ia32_irn_ops_t;
48 typedef struct ia32_intrinsic_env_t  ia32_intrinsic_env_t;
49
50 typedef struct ia32_irg_data_t {
51         ir_node  **blk_sched;    /**< an array containing the scheduled blocks */
52         unsigned do_x87_sim:1;   /**< set to 1 if x87 simulation should be enforced */
53         unsigned dump:1;         /**< set to 1 if graphs should be dumped */
54         ir_node  *noreg_gp;       /**< unique NoReg_GP node */
55         ir_node  *noreg_vfp;      /**< unique NoReg_VFP node */
56         ir_node  *noreg_xmm;      /**< unique NoReg_XMM node */
57
58         ir_node  *fpu_trunc_mode; /**< truncate fpu mode */
59         ir_node  *get_eip;        /**< get eip node */
60 } ia32_irg_data_t;
61
62 /**
63  * IA32 ISA object
64  */
65 struct ia32_isa_t {
66         arch_env_t             base;     /**< must be derived from arch_env_t */
67         pmap                  *tv_ent;   /**< A map of entities that store const tarvals */
68         const be_machine_t    *cpu;      /**< the abstract machine */
69         int                    fpu_arch; /**< FPU architecture */
70 };
71
72 /**
73  * A helper type collecting needed info for IA32 intrinsic lowering.
74  */
75 struct ia32_intrinsic_env_t {
76         ia32_isa_t *isa;     /**< the isa object */
77         ir_graph   *irg;     /**< the irg, these entities belong to */
78         ir_entity  *divdi3;  /**< entity for __divdi3 library call */
79         ir_entity  *moddi3;  /**< entity for __moddi3 library call */
80         ir_entity  *udivdi3; /**< entity for __udivdi3 library call */
81         ir_entity  *umoddi3; /**< entity for __umoddi3 library call */
82 };
83
84 typedef enum transformer_t {
85         TRANSFORMER_DEFAULT,
86 #ifdef FIRM_GRGEN_BE
87         TRANSFORMER_PBQP,
88         TRANSFORMER_RAND
89 #endif
90 } transformer_t;
91
92 #ifdef FIRM_GRGEN_BE
93 /** The selected transformer. */
94 extern transformer_t be_transformer;
95
96 #else
97 #define be_transformer TRANSFORMER_DEFAULT
98 #endif
99
100 /** The mode for the floating point control word. */
101 extern ir_mode *ia32_mode_fpcw;
102 /** extended floatingpoint mode */
103 extern ir_mode *ia32_mode_E;
104 extern ir_type *ia32_type_E;
105
106 static inline ia32_irg_data_t *ia32_get_irg_data(const ir_graph *irg)
107 {
108         return (ia32_irg_data_t*) be_birg_from_irg(irg)->isa_link;
109 }
110
111 /**
112  * Returns the unique per irg GP NoReg node.
113  */
114 ir_node *ia32_new_NoReg_gp(ir_graph *irg);
115 ir_node *ia32_new_NoReg_xmm(ir_graph *irg);
116 ir_node *ia32_new_NoReg_vfp(ir_graph *irg);
117
118 /**
119  * Returns the unique per irg FPU truncation mode node.
120  */
121 ir_node *ia32_new_Fpu_truncate(ir_graph *irg);
122
123 /**
124  * Split instruction with source AM into Load and separate instruction.
125  * @return result of the Load
126  */
127 ir_node *ia32_turn_back_am(ir_node *node);
128
129 /**
130  * Maps all intrinsic calls that the backend support
131  * and map all instructions the backend did not support
132  * to runtime calls.
133  */
134 void ia32_handle_intrinsics(void);
135
136 /**
137  * Ia32 implementation.
138  *
139  * @param method   the method type of the emulation function entity
140  * @param op       the emulated ir_op
141  * @param imode    the input mode of the emulated opcode
142  * @param omode    the output mode of the emulated opcode
143  * @param context  the context parameter
144  */
145 ir_entity *ia32_create_intrinsic_fkt(ir_type *method, const ir_op *op,
146                                      const ir_mode *imode, const ir_mode *omode,
147                                      void *context);
148
149 /**
150  * Return the stack entity that contains the return address.
151  */
152 ir_entity *ia32_get_return_address_entity(ir_graph *irg);
153
154 /**
155  * Return the stack entity that contains the frame address.
156  */
157 ir_entity *ia32_get_frame_address_entity(ir_graph *irg);
158
159 #endif