reorganize backend headers (kill some _t variants in favor of a be_types.h)
[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_flags_t;
66
67 typedef struct ia32_op_attr_t ia32_op_attr_t;
68 struct ia32_op_attr_t {
69         match_flags_t  flags;
70         unsigned       latency;
71 };
72
73 #ifndef NDEBUG
74 typedef enum {
75         IA32_ATTR_INVALID                = 0,
76         IA32_ATTR_ia32_attr_t            = 1 << 0,
77         IA32_ATTR_ia32_x87_attr_t        = 1 << 1,
78         IA32_ATTR_ia32_asm_attr_t        = 1 << 2,
79         IA32_ATTR_ia32_immediate_attr_t  = 1 << 3,
80         IA32_ATTR_ia32_condcode_attr_t   = 1 << 4,
81         IA32_ATTR_ia32_copyb_attr_t      = 1 << 5,
82         IA32_ATTR_ia32_call_attr_t       = 1 << 6,
83         IA32_ATTR_ia32_climbframe_attr_t = 1 << 7,
84 } ia32_attr_type_t;
85 #endif
86
87 /**
88  * The generic ia32 attributes. Every node has them.
89  */
90 typedef struct ia32_attr_t ia32_attr_t;
91 struct ia32_attr_t {
92         except_attr  exc;               /**< the exception attribute. MUST be the first one. */
93         struct ia32_attr_data_bitfield {
94                 unsigned tp:3;                  /**< ia32 node type. */
95                 unsigned am_arity:2;            /**< Indicates the address mode type supported by this node. */
96                 unsigned am_scale:2;            /**< The address mode scale for index register. */
97                 unsigned am_sc_sign:1;          /**< The sign bit of the address mode symconst. */
98
99                 unsigned am_sc_no_pic_adjust : 1;/**< AM symconst can be relative to EIP */
100                 unsigned use_frame:1;           /**< Indicates whether the operation uses the frame pointer or not. */
101                 unsigned has_except_label:1;        /**< Set if this node needs a label because of possible exception. */
102
103                 unsigned is_commutative:1;      /**< Indicates whether op is commutative or not. */
104
105                 unsigned need_stackent:1;       /**< Set to 1 if node need space on stack. */
106                 unsigned need_64bit_stackent:1; /**< needs a 64bit stack entity (see double->unsigned int conv) */
107                 unsigned need_32bit_stackent:1; /**< needs a 32bit stack entity */
108                 unsigned ins_permuted : 1;      /**< inputs of node have been permuted
109                                                      (for commutative nodes) */
110                 unsigned cmp_unsigned : 1;      /**< compare should be unsigned */
111                 unsigned is_reload : 1;         /**< node performs a reload */
112                 unsigned is_spill : 1;
113                 unsigned is_remat : 1;
114         } data;
115
116         int        am_offs;       /**< offsets for AddrMode */
117         ir_entity *am_sc;         /**< SymConst for AddrMode */
118
119         ir_mode   *ls_mode;       /**< Load/Store mode: This is the mode of the
120                                        value that is manipulated by this node. */
121
122         ir_entity *frame_ent; /**< the frame entity attached to this node */
123
124         const be_execution_unit_t ***exec_units; /**< list of units this operation can be executed on */
125
126         const arch_register_req_t **in_req;  /**< register requirements for arguments */
127         const arch_register_req_t **out_req; /**< register requirements for results */
128
129         ir_label_t        exc_label;       /**< the exception label iff this instruction can throw an exception */
130
131 #ifndef NDEBUG
132         const char       *orig_node;      /**< holds the name of the original ir node */
133         unsigned          attr_type;      /**< bitfield indicating the attribute type */
134 #endif
135 };
136 COMPILETIME_ASSERT(sizeof(struct ia32_attr_data_bitfield) <= 4, attr_bitfield);
137
138 /**
139  * The attributes for a Call node.
140  */
141 typedef struct ia32_call_attr_t ia32_call_attr_t;
142 struct ia32_call_attr_t {
143         ia32_attr_t  attr;    /**< generic attribute */
144         unsigned     pop;     /**< number of bytes that get popped by the callee */
145         ir_type     *call_tp; /**< The call type, copied from the original Call node. */
146 };
147
148 /**
149  * The attributes for nodes with condition code.
150  */
151 typedef struct ia32_condcode_attr_t ia32_condcode_attr_t;
152 struct ia32_condcode_attr_t {
153         ia32_attr_t  attr;      /**< generic attribute */
154         long         pn_code;   /**< projnum "types" (e.g. indicate compare operators */
155 };
156
157 /**
158  * The attributes for CopyB code.
159  */
160 typedef struct ia32_copyb_attr_t ia32_copyb_attr_t;
161 struct ia32_copyb_attr_t {
162         ia32_attr_t  attr;      /**< generic attribute */
163         unsigned     size;      /**< size of copied block */
164 };
165
166 /**
167  * The attributes for immediates.
168  */
169 typedef struct ia32_immediate_attr_t ia32_immediate_attr_t;
170 struct ia32_immediate_attr_t {
171         ia32_attr_t  attr;              /**< generic attribute */
172         ir_entity   *symconst;          /**< An entity if any. */
173         long         offset;            /**< An offset if any. */
174         unsigned     sc_sign : 1;       /**< The sign bit of the symconst. */
175         unsigned     no_pic_adjust : 1; /**< constant can be relative to EIP */
176 };
177
178 /**
179  * The attributes for x87 nodes.
180  */
181 typedef struct ia32_x87_attr_t ia32_x87_attr_t;
182 struct ia32_x87_attr_t {
183         ia32_attr_t            attr;      /**< the generic attribute */
184         const arch_register_t *x87[3];    /**< register slots for x87 register */
185 };
186
187 typedef struct ia32_asm_reg_t ia32_asm_reg_t;
188 struct ia32_asm_reg_t {
189         unsigned                   use_input  : 1; /* use input or output pos */
190         unsigned                   valid      : 1;
191         unsigned                   memory     : 1;
192         unsigned                   dummy_fill : 13;
193         unsigned                   inout_pos  : 16; /* in/out pos where the
194                                                        register is assigned */
195         const ir_mode             *mode;
196 };
197
198 /**
199  * The attributes for ASM nodes.
200  */
201 typedef struct ia32_asm_attr_t ia32_asm_attr_t;
202 struct ia32_asm_attr_t {
203         ia32_x87_attr_t       x87_attr;
204         ident                *asm_text;
205         const ia32_asm_reg_t *register_map;
206 };
207
208 /**
209  * The attributes for the ClimbFrame node.
210  */
211 typedef struct ia32_climbframe_attr_t ia32_climbframe_attr_t;
212 struct ia32_climbframe_attr_t {
213         ia32_attr_t attr;      /**< generic attribute */
214         unsigned    count;     /**< number of frames to climb up */
215 };
216
217 /* the following union is necessary to indicate to the compiler that we might want to cast
218  * the structs (we use them to simulate OO-inheritance) */
219 union allow_casts_attr_t_ {
220         ia32_attr_t            attr;
221         ia32_call_attr_t       call_attr;
222         ia32_condcode_attr_t   cc_attr;
223         ia32_copyb_attr_t      cpy_attr;
224         ia32_x87_attr_t        x87_attr;
225         ia32_asm_attr_t        asm_attr;
226         ia32_immediate_attr_t  immediate_attr;
227         ia32_climbframe_attr_t climbframe_attr;
228 };
229
230 #ifndef NDEBUG
231 #define CAST_IA32_ATTR(type,ptr)        (assert( ((const ia32_attr_t*)(ptr))->attr_type & IA32_ATTR_ ## type ), (type*) (ptr))
232 #define CONST_CAST_IA32_ATTR(type,ptr)  (assert( ((const ia32_attr_t*)(ptr))->attr_type & IA32_ATTR_ ## type ), (const type*) (ptr))
233 #else
234 #define CAST_IA32_ATTR(type,ptr)        ((type*) (ptr))
235 #define CONST_CAST_IA32_ATTR(type,ptr)  ((const type*) (ptr))
236 #endif
237
238 #endif