996a3cbe32a8effd4aaa60d75d8c50b2f86ba5e8
[libfirm] / ir / be / ia32 / ia32_nodes_attr.h
1 /*
2  * Copyright (C) 1995-2007 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 typedef enum { flavour_Div = 1, flavour_Mod, flavour_DivMod } ia32_op_flavour_t;
37 typedef enum { pn_EAX, pn_EDX } pn_ia32_Register;
38
39 typedef enum {
40         ia32_Normal,
41         ia32_AddrModeD,
42         ia32_AddrModeS
43 } ia32_op_type_t;
44
45 typedef enum {
46         ia32_ImmNone     = 0,
47         ia32_ImmConst    = 1,
48         ia32_ImmSymConst = 2
49 } ia32_immop_type_t;
50
51 typedef enum {
52         ia32_am_None   = 0,   /**<< no addrmode support */
53         ia32_am_Dest   = 1,   /**<< addrmode for destination only */
54         ia32_am_Source = 2,   /**<< addrmode for source only */
55         ia32_am_Full   = 3    /**<< full addmode support */
56 } ia32_am_type_t;
57
58 /**
59  * Different Address Mode properties:
60  * O - Offset is set
61  * B - Base is set
62  * I - Index is set
63  * S - Scale is set
64  */
65 enum {
66         ia32_O = (1 << 0),  /**< O - Offset is set */
67         ia32_B = (1 << 1),  /**< B - Base is set */
68         ia32_I = (1 << 2),  /**< I - Index is set */
69         ia32_S = (1 << 3)   /**< S - Scale is set */
70 };
71
72 /** Possible Address mode types */
73 typedef enum {
74         ia32_am_N    = 0,
75         ia32_am_O    = ia32_O,
76         ia32_am_B    = ia32_B,
77         ia32_am_I    = ia32_I,
78         ia32_am_IS   = ia32_I | ia32_S,
79         ia32_am_BI   = ia32_B | ia32_I,
80         ia32_am_OB   = ia32_O | ia32_B,
81         ia32_am_OIS  = ia32_O | ia32_I | ia32_S,
82         ia32_am_OBIS = ia32_O | ia32_B | ia32_I | ia32_S
83 } ia32_am_flavour_t;
84
85 enum {
86         ia32_pn_Cmp_Unsigned = 0x100 /**< set this flag in a pnc to indicate an unsigned compare operation */
87 };
88
89 #ifndef NDEBUG
90 typedef enum {
91         IA32_ATTR_INVALID               = 0,
92         IA32_ATTR_ia32_attr_t           = 1 << 0,
93         IA32_ATTR_ia32_x87_attr_t       = 1 << 1,
94         IA32_ATTR_ia32_asm_attr_t       = 1 << 2,
95         IA32_ATTR_ia32_immediate_attr_t = 1 << 3,
96 } ia32_attr_type_t;
97 #endif
98
99 typedef struct ia32_attr_t ia32_attr_t;
100 struct ia32_attr_t {
101         except_attr  exc;               /**< the exception attribute. MUST be the first one. */
102         struct {
103                 unsigned tp:3;              /**< ia32 node type. */
104                 unsigned imm_tp:2;          /**< ia32 immop type. */
105                 unsigned am_support:2;      /**< Indicates the address mode type supported by this node. */
106                 unsigned am_flavour:4;      /**< The concrete address mode characteristics. */
107                 unsigned am_scale:2;        /**< The address mode scale for index register. */
108                 unsigned am_sc_sign:1;      /**< The sign bit of the address mode symconst. */
109
110                 unsigned use_frame:1;       /**< Indicates whether the operation uses the frame pointer or not. */
111                 unsigned except_label:1;    /**< Set if this node needs a label because of posiible exception. */
112
113                 ia32_op_flavour_t op_flav:2;/**< Flavour of an op (flavour_Div/Mod/DivMod). */
114
115                 unsigned flags:4;           /**< Indicating if spillable, rematerializeable, stack modifying and/or ignore. */
116
117                 unsigned is_commutative:1;  /**< Indicates whether op is commutative or not. */
118
119                 unsigned emit_cl:1;         /**< Indicates whether we must emit cl instead of ecx (needed for shifts). */
120
121                 unsigned got_lea:1;         /**< Indicates whether or not this node already consumed a LEA. */
122
123                 unsigned need_stackent:1;   /**< Set to 1 if node need space on stack. */
124         } data;
125
126         int       *out_flags;     /**< flags for each produced value */
127
128         int        am_offs;       /**< offsets for AddrMode */
129         ir_entity *am_sc;         /**< SymConst for AddrMode */
130
131         union {
132                 tarval    *tv;        /**< tarval for immediate operations */
133                 ir_entity *sc;        /**< the symconst ident */
134         } cnst_val;
135
136         ir_mode *ls_mode;     /**< Load/Store mode: This is the mode of the value
137                                    that is manipulated by this node. */
138
139         ir_entity *frame_ent; /**< the frame entity attached to this node */
140
141         long pn_code;       /**< projnum "types" (e.g. indicate compare operators and argument numbers for switches) */
142
143         unsigned latency;   /**< the latency of the instruction in clock cycles */
144
145 #ifndef NDEBUG
146         const char       *orig_node;      /**< holds the name of the original ir node */
147         unsigned          attr_type;      /**< bitfield indicating the attribute type */
148 #endif
149
150         const be_execution_unit_t ***exec_units; /**< list of units this operation can be executed on */
151
152         const arch_register_req_t **in_req;  /**< register requirements for arguments */
153         const arch_register_req_t **out_req; /**< register requirements for results */
154
155         const arch_register_t **slots;     /**< register slots for assigned registers */
156 };
157
158 typedef struct ia32_immediate_attr_t ia32_immediate_attr_t;
159 struct ia32_immediate_attr_t {
160         ia32_attr_t  attr;
161         ir_entity   *symconst;
162         tarval      *offset;
163 };
164
165 typedef struct ia32_x87_attr_t ia32_x87_attr_t;
166 struct ia32_x87_attr_t {
167         ia32_attr_t            attr;
168         const arch_register_t *x87[3];    /**< register slots for x87 register */
169 };
170
171 typedef struct ia32_asm_attr_t ia32_asm_attr_t;
172 struct ia32_asm_attr_t {
173         ia32_x87_attr_t  x87_attr;
174         ident           *asm_text;
175 };
176
177 /* the following union is necessary to indicate to the compiler that we might want to cast
178  * the structs (we use them to simulate OO-inheritance) */
179 union allow_casts_attr_t_ {
180         ia32_attr_t            attr;
181         ia32_x87_attr_t        x87_attr;
182         ia32_asm_attr_t        asm_attr;
183         ia32_immediate_attr_t  immediate_attr;
184 };
185
186 #ifndef NDEBUG
187 #define CAST_IA32_ATTR(type,ptr)        (assert( ((const ia32_attr_t*)(ptr))->attr_type & IA32_ATTR_ ## type ), (type*) (ptr))
188 #define CONST_CAST_IA32_ATTR(type,ptr)  (assert( ((const ia32_attr_t*)(ptr))->attr_type & IA32_ATTR_ ## type ), (const type*) (ptr))
189 #else
190 #define CAST_IA32_ATTR(type,ptr)        ((type*) (ptr))
191 #define CONST_CAST_IA32_ATTR(type,ptr)  ((const type*) (ptr))
192 #endif
193
194 #endif