BugFix: ins_permuted means inversed flags, not negated ...
[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  * @version     $Id$
25  */
26 #ifndef FIRM_BE_IA32_IA32_NODES_ATTR_H
27 #define FIRM_BE_IA32_IA32_NODES_ATTR_H
28
29 #include "firm_types.h"
30 #include "../bearch.h"
31 #include "../bemachine.h"
32 #include "irnode_t.h"
33
34 enum {
35         ia32_pn_Cmp_unsigned = 0x1000,
36         ia32_pn_Cmp_float    = 0x2000,
37         ia32_pn_Cmp_parity   = 0x4000
38 };
39
40 typedef enum {
41         ia32_Normal,
42         ia32_AddrModeD,
43         ia32_AddrModeS
44 } ia32_op_type_t;
45
46 typedef enum {
47         ia32_am_none   = 0,
48         ia32_am_unary  = 1,
49         ia32_am_binary = 2
50 } ia32_am_type_t;
51
52 typedef enum {
53         match_commutative       = 1 << 0, /**< inputs are commutative */
54         match_am_and_immediates = 1 << 1, /**< node supports AM and immediate at
55                                                the same time */
56         match_am                = 1 << 2, /**< node supports (32bit) source AM */
57         match_8bit_am           = 1 << 3, /**< node supports 8bit source AM */
58         match_16bit_am          = 1 << 4, /**< node supports 16bit source AM */
59         match_immediate         = 1 << 5, /**< node supports immediates */
60         match_mode_neutral      = 1 << 6, /**< 16 and 8 bit modes can be emulated
61                                                by 32 bit operations */
62         match_try_am            = 1 << 7, /**< only try to produce AM node, don't
63                                                do anything if AM isn't possible */
64         match_two_users         = 1 << 8, /**< the instruction uses a load two times ... */
65         match_upconv_32         = 1 << 9  /**< 8/16 bit insn are processed by doing
66                                                an upconv to 32bit */
67 } match_flags_t;
68
69 typedef struct ia32_op_attr_t ia32_op_attr_t;
70 struct ia32_op_attr_t {
71         match_flags_t  flags;
72         unsigned       latency;
73 };
74
75 #ifndef NDEBUG
76 typedef enum {
77         IA32_ATTR_INVALID                = 0,
78         IA32_ATTR_ia32_attr_t            = 1 << 0,
79         IA32_ATTR_ia32_x87_attr_t        = 1 << 1,
80         IA32_ATTR_ia32_asm_attr_t        = 1 << 2,
81         IA32_ATTR_ia32_immediate_attr_t  = 1 << 3,
82         IA32_ATTR_ia32_condcode_attr_t   = 1 << 4,
83         IA32_ATTR_ia32_copyb_attr_t      = 1 << 5,
84         IA32_ATTR_ia32_call_attr_t       = 1 << 6,
85         IA32_ATTR_ia32_climbframe_attr_t = 1 << 7,
86 } ia32_attr_type_t;
87 #endif
88
89 /**
90  * The generic ia32 attributes. Every node has them.
91  */
92 typedef struct ia32_attr_t ia32_attr_t;
93 struct ia32_attr_t {
94         except_attr  exc;               /**< the exception attribute. MUST be the first one. */
95         struct ia32_attr_data_bitfield {
96                 unsigned tp:3;                  /**< ia32 node type. */
97                 unsigned am_arity:2;            /**< Indicates the address mode type supported by this node. */
98                 unsigned am_scale:2;            /**< The address mode scale for index register. */
99                 unsigned am_sc_sign:1;          /**< The sign bit of the address mode symconst. */
100
101                 unsigned am_sc_no_pic_adjust : 1;/**< AM symconst can be relative to EIP */
102                 unsigned use_frame:1;           /**< Indicates whether the operation uses the frame pointer or not. */
103                 unsigned has_except_label:1;        /**< Set if this node needs a label because of possible exception. */
104
105                 unsigned is_commutative:1;      /**< Indicates whether op is commutative or not. */
106
107                 unsigned need_stackent:1;       /**< Set to 1 if node need space on stack. */
108                 unsigned need_64bit_stackent:1; /**< needs a 64bit stack entity (see double->unsigned int conv) */
109                 unsigned need_32bit_stackent:1; /**< needs a 32bit stack entity */
110                 unsigned ins_permuted : 1;      /**< inputs of node have been permuted
111                                                      (for commutative nodes) */
112                 unsigned cmp_unsigned : 1;      /**< compare should be unsigned */
113                 unsigned is_reload : 1;         /**< node performs a reload */
114                 unsigned is_spill : 1;
115                 unsigned is_remat : 1;
116         } data;
117
118         int        am_offs;       /**< offsets for AddrMode */
119         ir_entity *am_sc;         /**< SymConst for AddrMode */
120
121         ir_mode   *ls_mode;       /**< Load/Store mode: This is the mode of the
122                                        value that is manipulated by this node. */
123
124         ir_entity *frame_ent; /**< the frame entity attached to this node */
125
126         const be_execution_unit_t ***exec_units; /**< list of units this operation can be executed on */
127
128         const arch_register_req_t **in_req;  /**< register requirements for arguments */
129
130         ir_label_t        exc_label;       /**< the exception label iff this instruction can throw an exception */
131
132 #ifndef NDEBUG
133         const char       *orig_node;      /**< holds the name of the original ir node */
134         unsigned          attr_type;      /**< bitfield indicating the attribute type */
135 #endif
136 };
137 COMPILETIME_ASSERT(sizeof(struct ia32_attr_data_bitfield) <= 4, attr_bitfield);
138
139 /**
140  * The attributes for a Call node.
141  */
142 typedef struct ia32_call_attr_t ia32_call_attr_t;
143 struct ia32_call_attr_t {
144         ia32_attr_t  attr;    /**< generic attribute */
145         unsigned     pop;     /**< number of bytes that get popped by the callee */
146         ir_type     *call_tp; /**< The call type, copied from the original Call node. */
147 };
148
149 /**
150  * The attributes for nodes with condition code.
151  */
152 typedef struct ia32_condcode_attr_t ia32_condcode_attr_t;
153 struct ia32_condcode_attr_t {
154         ia32_attr_t  attr;      /**< generic attribute */
155         long         pn_code;   /**< projnum "types" (e.g. indicate compare operators */
156 };
157
158 /**
159  * The attributes for CopyB code.
160  */
161 typedef struct ia32_copyb_attr_t ia32_copyb_attr_t;
162 struct ia32_copyb_attr_t {
163         ia32_attr_t  attr;      /**< generic attribute */
164         unsigned     size;      /**< size of copied block */
165 };
166
167 /**
168  * The attributes for immediates.
169  */
170 typedef struct ia32_immediate_attr_t ia32_immediate_attr_t;
171 struct ia32_immediate_attr_t {
172         ia32_attr_t  attr;              /**< generic attribute */
173         ir_entity   *symconst;          /**< An entity if any. */
174         long         offset;            /**< An offset if any. */
175         unsigned     sc_sign : 1;       /**< The sign bit of the symconst. */
176         unsigned     no_pic_adjust : 1; /**< constant can be relative to EIP */
177 };
178
179 /**
180  * The attributes for x87 nodes.
181  */
182 typedef struct ia32_x87_attr_t ia32_x87_attr_t;
183 struct ia32_x87_attr_t {
184         ia32_attr_t            attr;      /**< the generic attribute */
185         const arch_register_t *x87[3];    /**< register slots for x87 register */
186 };
187
188 typedef struct ia32_asm_reg_t ia32_asm_reg_t;
189 struct ia32_asm_reg_t {
190         unsigned                   use_input  : 1; /* use input or output pos */
191         unsigned                   valid      : 1;
192         unsigned                   memory     : 1;
193         unsigned                   dummy_fill : 13;
194         unsigned                   inout_pos  : 16; /* in/out pos where the
195                                                        register is assigned */
196         const ir_mode             *mode;
197 };
198
199 /**
200  * The attributes for ASM nodes.
201  */
202 typedef struct ia32_asm_attr_t ia32_asm_attr_t;
203 struct ia32_asm_attr_t {
204         ia32_x87_attr_t       x87_attr;
205         ident                *asm_text;
206         const ia32_asm_reg_t *register_map;
207 };
208
209 /**
210  * The attributes for the ClimbFrame node.
211  */
212 typedef struct ia32_climbframe_attr_t ia32_climbframe_attr_t;
213 struct ia32_climbframe_attr_t {
214         ia32_attr_t attr;      /**< generic attribute */
215         unsigned    count;     /**< number of frames to climb up */
216 };
217
218 /* the following union is necessary to indicate to the compiler that we might want to cast
219  * the structs (we use them to simulate OO-inheritance) */
220 union allow_casts_attr_t_ {
221         ia32_attr_t            attr;
222         ia32_call_attr_t       call_attr;
223         ia32_condcode_attr_t   cc_attr;
224         ia32_copyb_attr_t      cpy_attr;
225         ia32_x87_attr_t        x87_attr;
226         ia32_asm_attr_t        asm_attr;
227         ia32_immediate_attr_t  immediate_attr;
228         ia32_climbframe_attr_t climbframe_attr;
229 };
230
231 #ifndef NDEBUG
232 #define CAST_IA32_ATTR(type,ptr)        (assert( ((const ia32_attr_t*)(ptr))->attr_type & IA32_ATTR_ ## type ), (type*) (ptr))
233 #define CONST_CAST_IA32_ATTR(type,ptr)  (assert( ((const ia32_attr_t*)(ptr))->attr_type & IA32_ATTR_ ## type ), (const type*) (ptr))
234 #else
235 #define CAST_IA32_ATTR(type,ptr)        ((type*) (ptr))
236 #define CONST_CAST_IA32_ATTR(type,ptr)  ((const type*) (ptr))
237 #endif
238
239 #endif