fixed comment
[libfirm] / ir / be / ia32 / bearch_ia32_t.h
1 #ifndef _BEARCH_IA32_T_H_
2 #define _BEARCH_IA32_T_H_
3
4 #include "firm_config.h"
5
6 #include "pmap.h"
7 #include "debug.h"
8 #include "bearch_ia32.h"
9 #include "ia32_nodes_attr.h"
10 #include "set.h"
11 #include "../be.h"
12
13 #ifdef NDEBUG
14 #define SET_IA32_ORIG_NODE(n, o)
15 #else
16 #define SET_IA32_ORIG_NODE(n, o) set_ia32_orig_node(n, o);
17 #endif /* NDEBUG */
18
19 /* some typedefs */
20
21 /**
22  * Bitmask for the backend optimization settings.
23  */
24 typedef enum _ia32_optimize_t {
25         IA32_OPT_INCDEC    = 1,   /**< optimize add/sub 1/-1 to inc/dec */
26         IA32_OPT_DOAM      = 2,   /**< do address mode optimizations */
27         IA32_OPT_LEA       = 4,   /**< optimize address caluclations into LEAs */
28         IA32_OPT_PLACECNST = 8,   /**< place constants in the blocks where they are used */
29         IA32_OPT_IMMOPS    = 16,  /**< create operations with immediate operands */
30         IA32_OPT_EXTBB     = 32,  /**< do extended basic block scheduling */
31 } ia32_optimize_t;
32
33 /**
34  * Architectures. Clustered for easier macro implementation,
35  * do not change.
36  */
37 typedef enum cpu_support {
38         arch_i386,          /**< i386 */
39         arch_i486,          /**< i486 */
40         arch_pentium,       /**< Pentium */
41         arch_pentium_pro,   /**< Pentium Pro */
42         arch_pentium_mmx,   /**< Pentium MMX */
43         arch_pentium_2,     /**< Pentium II */
44         arch_pentium_3,     /**< Pentium III */
45         arch_pentium_4,     /**< Pentium IV */
46         arch_pentium_m,     /**< Pentium M */
47         arch_core,          /**< Core */
48         arch_k6,            /**< K6 */
49         arch_athlon,        /**< Athlon */
50         arch_athlon_64,     /**< Athlon64 */
51         arch_opteron,       /**< Opteron */
52 } cpu_support;
53
54 /** checks for l <= x <= h */
55 #define _IN_RANGE(x, l, h)  ((unsigned)((x) - (l)) <= (unsigned)((h) - (l)))
56
57 /** returns true if it's Intel architecture */
58 #define ARCH_INTEL(x)       _IN_RANGE((x), arch_i386, arch_core)
59
60 /** returns true if it's AMD architecture */
61 #define ARCH_AMD(x)         _IN_RANGE((x), arch_k6, arch_opteron)
62
63 #define IS_P6_ARCH(x)       (_IN_RANGE((x), arch_pentium_pro, arch_core) || \
64                              _IN_RANGE((x), arch_athlon, arch_opteron))
65
66 /** floating point support */
67 typedef enum fp_support {
68         fp_none,  /**< no floating point instructions are used */
69         fp_x87,   /**< use x87 instructions */
70         fp_sse2   /**< use SSE2 instructions */
71 } fp_support;
72
73 /** Sets the used flag to the current floating point architecture. */
74 #define FP_USED(cg)  ((cg)->used_fp = (cg)->fp_kind)
75
76 /** Returns non-zero if the current floating point architecture is SSE2. */
77 #define USE_SSE2(cg) ((cg)->fp_kind == fp_sse2)
78
79 /** Returns non-zero if the current floating point architecture is x87. */
80 #define USE_x87(cg)  ((cg)->fp_kind == fp_x87)
81
82 typedef struct _ia32_isa_t ia32_isa_t;
83
84 /**
85  * IA32 code generator
86  */
87 typedef struct _ia32_code_gen_t {
88         const arch_code_generator_if_t *impl;          /**< implementation */
89         ir_graph                       *irg;           /**< current irg */
90         const arch_env_t               *arch_env;      /**< the arch env */
91         set                            *reg_set;       /**< set to memorize registers for non-ia32 nodes (e.g. phi nodes) */
92         ia32_isa_t                     *isa;           /**< for fast access to the isa object */
93         const be_irg_t                 *birg;          /**< The be-irg (contains additional information about the irg) */
94         ir_node                        **blk_sched;    /**< an array containing the scheduled blocks */
95         ia32_optimize_t                 opt;           /**< contains optimization information */
96         entity                         *fp_to_gp;      /**< allocated entity for fp to gp conversion */
97         entity                         *gp_to_fp;      /**< allocated entity for gp to fp conversion */
98         int                             arch;          /**< instruction architecture */
99         int                             opt_arch;      /**< optimize for architecture */
100         int                             fp_kind;       /**< floating point kind */
101         char                            used_fp;       /**< which floating point unit used in this graph */
102         DEBUG_ONLY(firm_dbg_module_t   *mod;)          /**< debugging module */
103 } ia32_code_gen_t;
104
105 /**
106  * IA32 ISA object
107  */
108 struct _ia32_isa_t {
109   arch_isa_t            arch_isa;       /**< must be derived from arch_isa_t */
110         pmap                  *regs_16bit;    /**< Contains the 16bits names of the gp registers */
111         pmap                  *regs_8bit;     /**< Contains the 8bits names of the gp registers */
112         pmap                  *types;         /**< A map of modes to primitive types */
113         pmap                  *tv_ent;        /**< A map of entities that store const tarvals */
114         ia32_optimize_t        opt;           /**< contains optimization information */
115         int                    arch;          /**< instruction architecture */
116         int                    opt_arch;      /**< optimize for architecture */
117         int                    fp_kind;       /**< floating point kind */
118         ia32_code_gen_t       *cg;            /**< the current code generator */
119         FILE                  *out;           /**< output file */
120 #ifndef NDEBUG
121         struct obstack        *name_obst;     /**< holds the original node names (for debugging) */
122         unsigned long          name_obst_size;
123 #endif /* NDEBUG */
124 };
125
126 typedef struct _ia32_irn_ops_t {
127         const arch_irn_ops_if_t *impl;
128         ia32_code_gen_t         *cg;
129 } ia32_irn_ops_t;
130
131 /* this is a struct to minimize the number of parameters
132    for transformation walker */
133 typedef struct _ia32_transform_env_t {
134         dbg_info          *dbg;        /**< The node debug info */
135         ir_graph          *irg;        /**< The irg, the node should be created in */
136         ir_node           *block;      /**< The block, the node should belong to */
137         ir_node           *irn;        /**< The irn, to be transformed */
138         ir_mode           *mode;       /**< The mode of the irn */
139         ia32_code_gen_t   *cg;         /**< The code generator */
140         DEBUG_ONLY(firm_dbg_module_t *mod;) /**< The firm debugger */
141 } ia32_transform_env_t;
142
143 /**
144  * Returns the unique per irg GP NoReg node.
145  */
146 ir_node *ia32_new_NoReg_gp(ia32_code_gen_t *cg);
147
148 /**
149  * Returns the unique per irg FP NoReg node.
150  */
151 ir_node *ia32_new_NoReg_fp(ia32_code_gen_t *cg);
152
153 /**
154  * Maps all intrinsic calls that the backend support
155  * and map all instructions the backend did not support
156  * to runtime calls.
157  */
158 void ia32_handle_intrinsics(void);
159
160 /**
161  * Ia32 implementation.
162  *
163  * @param method   the method type of the emulation function entity
164  * @param op       the emulated ir_op
165  * @param imode    the input mode of the emulated opcode
166  * @param omode    the output mode of the emulated opcode
167  * @param context  the context parameter
168  */
169 entity *ia32_create_intrinsic_fkt(ir_type *method, const ir_op *op,
170                                   const ir_mode *imode, const ir_mode *omode,
171                                   void *context);
172
173 #endif /* _BEARCH_IA32_T_H_ */