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