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