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