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