cfbc5a49b88e831d6ee817c474b1b6ecb737fe20
[libfirm] / ir / be / ia32 / ia32_nodes_attr.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       Type definitions for ia32 node attributes.
23  * @author      Christian Wuerdig
24  */
25 #ifndef FIRM_BE_IA32_IA32_NODES_ATTR_H
26 #define FIRM_BE_IA32_IA32_NODES_ATTR_H
27
28 #include "firm_types.h"
29 #include "bearch.h"
30 #include "irnode_t.h"
31
32 /** ia32 condition codes (the numbers correspond to the real encoding order) */
33 typedef enum ia32_condition_code_t {
34         ia32_cc_negated       = 0x01, /**< negates condition */
35
36         ia32_cc_overflow      = 0x00,                                /**< OF=1 */
37         ia32_cc_below         = 0x02,                                /**< CF=1 */
38         ia32_cc_equal         = 0x04,                                /**< ZF=1 */
39         ia32_cc_below_equal   = 0x06,                                /**< ZF=1 or CF=1 */
40         ia32_cc_sign          = 0x08,                                /**< SF=1 */
41         ia32_cc_parity        = 0x0A,                                /**< PF=1 */
42         ia32_cc_less          = 0x0C,                                /**< SF!=OF */
43         ia32_cc_less_equal    = 0x0E,                                /**< ZF=1 or SF!=OF */
44         ia32_cc_not_overflow  = ia32_cc_negated|ia32_cc_overflow,    /**< OF=0 */
45         ia32_cc_above_equal   = ia32_cc_negated|ia32_cc_below,       /**< CF=0 */
46         ia32_cc_not_equal     = ia32_cc_negated|ia32_cc_equal,       /**< ZF=0 */
47         ia32_cc_above         = ia32_cc_negated|ia32_cc_below_equal, /**< ZF=0 and CF=0 */
48         ia32_cc_not_sign      = ia32_cc_negated|ia32_cc_sign,        /**< SF=0 */
49         ia32_cc_not_parity    = ia32_cc_negated|ia32_cc_parity,      /**< PF=0 */
50         ia32_cc_greater_equal = ia32_cc_negated|ia32_cc_less,        /**< SF=OF */
51         ia32_cc_greater       = ia32_cc_negated|ia32_cc_less_equal,  /**< ZF=0 and SF=OF */
52
53         /* the following codes are (unfortunately) NOT real hardware codes but
54          * simplify our backend as you need these combinations for some
55          * floatingpoint compares (the emitter will split them into multiple
56          * instructions) */
57         ia32_cc_float_parity_cases = 0x20,
58         /* we need even more cases as inversing the cc is different for float
59          * comparisons (though for the following we need no special
60          * parity+x combinations) */
61         ia32_cc_additional_float_cases = 0x10,
62
63         /* make sure that the lower 4 bit correspond to the real encoding
64          * (of the comparison not involving the parity special) */
65         ia32_cc_float_equal        = 0x34,                                /**< PF=0 and ZF=1 */
66         ia32_cc_float_below        = 0x32,                                /**< PF=0 and CF=1 */
67         ia32_cc_float_below_equal  = 0x36,                                /**< PF=0 and (ZF=1 or CF=1) */
68         ia32_cc_float_not_equal    = ia32_cc_negated|ia32_cc_float_equal, /**< PF=1 or ZF=0 */
69         ia32_cc_float_unordered_above_equal
70                 = ia32_cc_negated|ia32_cc_float_below,                        /**< PF=1 or CF=0 */
71         ia32_cc_float_unordered_above
72                 = ia32_cc_negated|ia32_cc_float_below_equal,                  /**< PF=1 or (ZF=0 and CF=0) */
73
74         ia32_cc_float_unordered_below_equal = 0x16,                       /**< ZF=1 or CF=1 */
75         ia32_cc_float_unordered_below       = 0x12,                       /**< CF=1 */
76         ia32_cc_float_above        =
77                 ia32_cc_negated|ia32_cc_float_unordered_below_equal,          /**< ZF=0 and CF=0 */
78         ia32_cc_float_above_equal
79                 = ia32_cc_negated|ia32_cc_float_unordered_below,              /**< CF=0 */
80 } ia32_condition_code_t;
81 ENUM_BITSET(ia32_condition_code_t)
82
83 static inline ia32_condition_code_t ia32_negate_condition_code(
84                 ia32_condition_code_t code)
85 {
86         return code ^ ia32_cc_negated;
87 }
88
89 static inline ia32_condition_code_t ia32_invert_condition_code(
90                 ia32_condition_code_t code)
91 {
92         /* doesn't appear to have any systematic, so use a table */
93         switch (code) {
94         case ia32_cc_below:              return ia32_cc_above;
95         case ia32_cc_below_equal:        return ia32_cc_above_equal;
96         case ia32_cc_above:              return ia32_cc_below;
97         case ia32_cc_above_equal:        return ia32_cc_below_equal;
98         case ia32_cc_less:               return ia32_cc_greater;
99         case ia32_cc_less_equal:         return ia32_cc_greater_equal;
100         case ia32_cc_greater:            return ia32_cc_less;
101         case ia32_cc_greater_equal:      return ia32_cc_less_equal;
102         case ia32_cc_float_below:        return ia32_cc_float_above;
103         case ia32_cc_float_below_equal:  return ia32_cc_float_above_equal;
104         case ia32_cc_float_above:        return ia32_cc_float_below;
105         case ia32_cc_float_above_equal:  return ia32_cc_float_below_equal;
106         case ia32_cc_float_unordered_below:       return ia32_cc_float_unordered_above;
107         case ia32_cc_float_unordered_below_equal: return ia32_cc_float_unordered_above_equal;
108         case ia32_cc_float_unordered_above:       return ia32_cc_float_unordered_below;
109         case ia32_cc_float_unordered_above_equal: return ia32_cc_float_unordered_below_equal;
110         default:                         return code;
111         }
112 }
113
114 typedef enum {
115         ia32_Normal,
116         ia32_AddrModeD,
117         ia32_AddrModeS
118 } ia32_op_type_t;
119
120 typedef enum {
121         ia32_am_none   = 0,
122         ia32_am_unary  = 1,
123         ia32_am_binary = 2
124 } ia32_am_type_t;
125
126 typedef enum {
127         match_commutative       = 1 << 0, /**< inputs are commutative */
128         match_am_and_immediates = 1 << 1, /**< node supports AM and immediate at
129                                                the same time */
130         match_am                = 1 << 2, /**< node supports (32bit) source AM */
131         match_8bit_am           = 1 << 3, /**< node supports 8bit source AM */
132         match_16bit_am          = 1 << 4, /**< node supports 16bit source AM */
133         match_immediate         = 1 << 5, /**< node supports immediates */
134         match_mode_neutral      = 1 << 6, /**< 16 and 8 bit modes can be emulated
135                                                by 32 bit operations */
136         match_try_am            = 1 << 7, /**< only try to produce AM node, don't
137                                                do anything if AM isn't possible */
138         match_two_users         = 1 << 8, /**< the instruction uses a load two times ... */
139         match_upconv_32         = 1 << 9  /**< 8/16 bit insn are processed by doing
140                                                an upconv to 32bit */
141 } match_flags_t;
142 ENUM_BITSET(match_flags_t)
143
144 typedef struct ia32_op_attr_t ia32_op_attr_t;
145 struct ia32_op_attr_t {
146         match_flags_t  flags;
147         unsigned       latency;
148 };
149
150 #ifndef NDEBUG
151 typedef enum {
152         IA32_ATTR_INVALID                = 0,
153         IA32_ATTR_ia32_attr_t            = 1 << 0,
154         IA32_ATTR_ia32_x87_attr_t        = 1 << 1,
155         IA32_ATTR_ia32_asm_attr_t        = 1 << 2,
156         IA32_ATTR_ia32_immediate_attr_t  = 1 << 3,
157         IA32_ATTR_ia32_condcode_attr_t   = 1 << 4,
158         IA32_ATTR_ia32_copyb_attr_t      = 1 << 5,
159         IA32_ATTR_ia32_call_attr_t       = 1 << 6,
160         IA32_ATTR_ia32_climbframe_attr_t = 1 << 7,
161         IA32_ATTR_ia32_switch_attr_t     = 1 << 8,
162 } ia32_attr_type_t;
163 #endif
164
165 /**
166  * The generic ia32 attributes. Every node has them.
167  */
168 typedef struct ia32_attr_t ia32_attr_t;
169 struct ia32_attr_t {
170         except_attr  exc;               /**< the exception attribute. MUST be the first one. */
171         struct ia32_attr_data_bitfield {
172                 unsigned tp:3;                  /**< ia32 node type. */
173                 unsigned am_arity:2;            /**< Indicates the address mode type supported by this node. */
174                 unsigned am_scale:2;            /**< The address mode scale for index register. */
175                 unsigned am_sc_sign:1;          /**< The sign bit of the address mode symconst. */
176
177                 unsigned am_sc_no_pic_adjust : 1;/**< AM symconst can be relative to EIP */
178                 unsigned am_tls_segment:1;       /**< addresses are relative to TLS */
179                 unsigned use_frame:1;           /**< Indicates whether the operation uses the frame pointer or not. */
180                 unsigned has_except_label:1;        /**< Set if this node needs a label because of possible exception. */
181
182                 unsigned is_commutative:1;      /**< Indicates whether op is commutative or not. */
183
184                 unsigned need_stackent:1;       /**< Set to 1 if node need space on stack. */
185                 unsigned need_64bit_stackent:1; /**< needs a 64bit stack entity (see double->unsigned int conv) */
186                 unsigned need_32bit_stackent:1; /**< needs a 32bit stack entity */
187                 unsigned ins_permuted : 1;      /**< inputs of node have been permuted
188                                                      (for commutative nodes) */
189                 unsigned is_reload : 1;         /**< node performs a reload */
190                 unsigned is_spill : 1;
191                 unsigned is_remat : 1;
192         } data;
193
194         int        am_offs;       /**< offsets for AddrMode */
195         ir_entity *am_sc;         /**< SymConst for AddrMode */
196
197         ir_mode   *ls_mode;       /**< Load/Store mode: This is the mode of the
198                                        value that is manipulated by this node. */
199
200         ir_entity *frame_ent; /**< the frame entity attached to this node */
201
202         ir_label_t        exc_label;       /**< the exception label iff this instruction can throw an exception */
203
204 #ifndef NDEBUG
205         const char       *orig_node;      /**< holds the name of the original ir node */
206         unsigned          attr_type;      /**< bitfield indicating the attribute type */
207 #endif
208 };
209
210 /**
211  * The attributes for a Call node.
212  */
213 typedef struct ia32_call_attr_t ia32_call_attr_t;
214 struct ia32_call_attr_t {
215         ia32_attr_t  attr;    /**< generic attribute */
216         unsigned     pop;     /**< number of bytes that get popped by the callee */
217         ir_type     *call_tp; /**< The call type, copied from the original Call node. */
218 };
219
220 /**
221  * The attributes for nodes with condition code.
222  */
223 typedef struct ia32_condcode_attr_t ia32_condcode_attr_t;
224 struct ia32_condcode_attr_t {
225         ia32_attr_t           attr;           /**< generic attribute */
226         ia32_condition_code_t condition_code; /**< condition code*/
227 };
228
229 /**
230  * The attributes for Switches
231  */
232 typedef struct ia32_switch_attr_t ia32_switch_attr_t;
233 struct ia32_switch_attr_t {
234         ia32_attr_t            attr;        /**< generic attribute */
235         const ir_switch_table *table;
236         ir_entity             *jump_table;
237 };
238
239 /**
240  * The attributes for CopyB code.
241  */
242 typedef struct ia32_copyb_attr_t ia32_copyb_attr_t;
243 struct ia32_copyb_attr_t {
244         ia32_attr_t  attr;      /**< generic attribute */
245         unsigned     size;      /**< size of copied block */
246 };
247
248 /**
249  * The attributes for immediates.
250  */
251 typedef struct ia32_immediate_attr_t ia32_immediate_attr_t;
252 struct ia32_immediate_attr_t {
253         ia32_attr_t  attr;              /**< generic attribute */
254         ir_entity   *symconst;          /**< An entity if any. */
255         long         offset;            /**< An offset if any. */
256         unsigned     sc_sign : 1;       /**< The sign bit of the symconst. */
257         unsigned     no_pic_adjust : 1; /**< constant can be relative to EIP */
258 };
259
260 /**
261  * The attributes for x87 nodes.
262  */
263 typedef struct ia32_x87_attr_t ia32_x87_attr_t;
264 struct ia32_x87_attr_t {
265         ia32_attr_t            attr;      /**< the generic attribute */
266         const arch_register_t *x87[3];    /**< register slots for x87 register */
267 };
268
269 typedef struct ia32_asm_reg_t ia32_asm_reg_t;
270 struct ia32_asm_reg_t {
271         unsigned                   use_input  : 1; /* use input or output pos */
272         unsigned                   valid      : 1;
273         unsigned                   memory     : 1;
274         unsigned                   dummy_fill : 13;
275         unsigned                   inout_pos  : 16; /* in/out pos where the
276                                                        register is assigned */
277         const ir_mode             *mode;
278 };
279
280 /**
281  * The attributes for ASM nodes.
282  */
283 typedef struct ia32_asm_attr_t ia32_asm_attr_t;
284 struct ia32_asm_attr_t {
285         ia32_x87_attr_t       x87_attr;
286         ident                *asm_text;
287         const ia32_asm_reg_t *register_map;
288 };
289
290 /**
291  * The attributes for the ClimbFrame node.
292  */
293 typedef struct ia32_climbframe_attr_t ia32_climbframe_attr_t;
294 struct ia32_climbframe_attr_t {
295         ia32_attr_t attr;      /**< generic attribute */
296         unsigned    count;     /**< number of frames to climb up */
297 };
298
299 /* the following union is necessary to indicate to the compiler that we might want to cast
300  * the structs (we use them to simulate OO-inheritance) */
301 union allow_casts_attr_t_ {
302         ia32_attr_t            attr;
303         ia32_call_attr_t       call_attr;
304         ia32_condcode_attr_t   cc_attr;
305         ia32_copyb_attr_t      cpy_attr;
306         ia32_x87_attr_t        x87_attr;
307         ia32_asm_attr_t        asm_attr;
308         ia32_immediate_attr_t  immediate_attr;
309         ia32_climbframe_attr_t climbframe_attr;
310         ia32_switch_attr_t     switch_attr;
311 };
312
313 #ifndef NDEBUG
314 #define CAST_IA32_ATTR(type,ptr)        (assert( ((const ia32_attr_t*)(ptr))->attr_type & IA32_ATTR_ ## type ), (type*) (ptr))
315 #define CONST_CAST_IA32_ATTR(type,ptr)  (assert( ((const ia32_attr_t*)(ptr))->attr_type & IA32_ATTR_ ## type ), (const type*) (ptr))
316 #else
317 #define CAST_IA32_ATTR(type,ptr)        ((type*) (ptr))
318 #define CONST_CAST_IA32_ATTR(type,ptr)  ((const type*) (ptr))
319 #endif
320
321 #endif