Remove ia32_am_Full.
[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 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_type_t;
47
48 typedef enum {
49         ia32_am_arity_none = 0,
50         ia32_am_unary      = 1,
51         ia32_am_binary     = 2,
52         ia32_am_ternary    = 3,
53 } ia32_am_arity_t;
54
55 typedef enum {
56         match_commutative       = 1 << 0,   /**< inputs are commutative */
57         match_am_and_immediates = 1 << 1,   /**< mode support AM and immediate at
58                                                  the same time */
59         match_am                = 1 << 2,   /**< node supports (32bit) source AM */
60         match_8bit_am           = 1 << 3,   /**< node supports 8bit source AM */
61         match_16bit_am          = 1 << 4,   /**< node supports 16bit source AM */
62         match_immediate         = 1 << 5,   /**< node supports immediates */
63         match_8bit              = 1 << 6,   /**< supports 8 bit modes natively */
64         match_16bit             = 1 << 7,   /**< supports 16bit modes natively */
65         match_mode_neutral      = 1 << 8,   /**< 16 and 8 bit modes can be emulated
66                                                  by 32 bit operations */
67         match_dest_am           = 1 << 9,
68         match_try_am            = 1 << 10,  /**< only try to produce AM node, don't
69                                                  do anything if AM isn't possible */
70 } match_flags_t;
71
72 typedef struct ia32_op_attr_t ia32_op_attr_t;
73 struct ia32_op_attr_t {
74         match_flags_t  flags;
75         unsigned       latency;
76 };
77
78 #ifndef NDEBUG
79 typedef enum {
80         IA32_ATTR_INVALID               = 0,
81         IA32_ATTR_ia32_attr_t           = 1 << 0,
82         IA32_ATTR_ia32_x87_attr_t       = 1 << 1,
83         IA32_ATTR_ia32_asm_attr_t       = 1 << 2,
84         IA32_ATTR_ia32_immediate_attr_t = 1 << 3,
85         IA32_ATTR_ia32_condcode_attr_t  = 1 << 4,
86         IA32_ATTR_ia32_copyb_attr_t     = 1 << 5
87 } ia32_attr_type_t;
88 #endif
89
90 /**
91  * The generic ia32 attributes. Every node has them.
92  */
93 typedef struct ia32_attr_t ia32_attr_t;
94 struct ia32_attr_t {
95         except_attr  exc;               /**< the exception attribute. MUST be the first one. */
96         struct ia32_attr_data_bitfield {
97                 unsigned flags:5;           /**< Indicating if spillable, rematerializeable, stack modifying and/or ignore. */
98                 unsigned tp:3;              /**< ia32 node type. */
99                 unsigned am_support:2;      /**< Indicates the address mode type supported by this node. */
100                 unsigned am_arity  : 2;
101                 unsigned am_scale:2;        /**< The address mode scale for index register. */
102                 unsigned am_sc_sign:1;      /**< The sign bit of the address mode symconst. */
103
104                 unsigned use_frame:1;       /**< Indicates whether the operation uses the frame pointer or not. */
105                 unsigned except_label:1;    /**< Set if this node needs a label because of possible exception. */
106
107                 unsigned is_commutative:1;  /**< Indicates whether op is commutative or not. */
108
109                 unsigned need_stackent:1;   /**< Set to 1 if node need space on stack. */
110                 unsigned need_64bit_stackent:1; /**< needs a 64bit stack entity (see double->unsigned int conv) */
111                 unsigned need_32bit_stackent:1; /**< needs a 32bit stack entity */
112                 unsigned ins_permuted : 1;      /**< inputs of node have been permuted
113                                                      (for commutative nodes) */
114                 unsigned cmp_unsigned : 1;      /**< compare should be unsigned */
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 #ifndef NDEBUG
135         const char       *orig_node;      /**< holds the name of the original ir node */
136         unsigned          attr_type;      /**< bitfield indicating the attribute type */
137 #endif
138 };
139 COMPILETIME_ASSERT(sizeof(struct ia32_attr_data_bitfield) <= 4, attr_bitfield);
140
141 /**
142  * The attributes for nodes with condition code.
143  */
144 typedef struct ia32_condcode_attr_t ia32_condcode_attr_t;
145 struct ia32_condcode_attr_t {
146         ia32_attr_t  attr;      /**< generic attribute */
147         long         pn_code;   /**< projnum "types" (e.g. indicate compare operators */
148 };
149
150 /**
151  * The attributes for CopyB code.
152  */
153 typedef struct ia32_copyb_attr_t ia32_copyb_attr_t;
154 struct ia32_copyb_attr_t {
155         ia32_attr_t  attr;      /**< generic attribute */
156         unsigned     size;      /**< size of copied block */
157 };
158
159 /**
160  * The attributes for immediates.
161  */
162 typedef struct ia32_immediate_attr_t ia32_immediate_attr_t;
163 struct ia32_immediate_attr_t {
164         ia32_attr_t  attr;              /**< generic attribute */
165         ir_entity   *symconst;          /**< An entity if any. */
166         long         offset;            /**< An offset if any. */
167         unsigned     sc_sign:1;         /**< The sign bit of the symconst. */
168 };
169
170 /**
171  * The attributes for x87 nodes.
172  */
173 typedef struct ia32_x87_attr_t ia32_x87_attr_t;
174 struct ia32_x87_attr_t {
175         ia32_attr_t            attr;      /**< the generic attribute */
176         const arch_register_t *x87[3];    /**< register slots for x87 register */
177 };
178
179 typedef struct ia32_asm_reg_t ia32_asm_reg_t;
180 struct ia32_asm_reg_t {
181         unsigned                   use_input  : 1; /* use input or output pos */
182         unsigned                   valid      : 1;
183         unsigned                   memory     : 1;
184         unsigned                   dummy_fill : 13;
185         unsigned                   inout_pos  : 16; /* in/out pos where the
186                                                        register is assigned */
187         const ir_mode             *mode;
188 };
189
190 /**
191  * The attributes for ASM nodes.
192  */
193 typedef struct ia32_asm_attr_t ia32_asm_attr_t;
194 struct ia32_asm_attr_t {
195         ia32_x87_attr_t       x87_attr;
196         ident                *asm_text;
197         const ia32_asm_reg_t *register_map;
198 };
199
200 /* the following union is necessary to indicate to the compiler that we might want to cast
201  * the structs (we use them to simulate OO-inheritance) */
202 union allow_casts_attr_t_ {
203         ia32_attr_t            attr;
204         ia32_condcode_attr_t   cc_attr;
205         ia32_copyb_attr_t      cpy_attr;
206         ia32_x87_attr_t        x87_attr;
207         ia32_asm_attr_t        asm_attr;
208         ia32_immediate_attr_t  immediate_attr;
209 };
210
211 #ifndef NDEBUG
212 #define CAST_IA32_ATTR(type,ptr)        (assert( ((const ia32_attr_t*)(ptr))->attr_type & IA32_ATTR_ ## type ), (type*) (ptr))
213 #define CONST_CAST_IA32_ATTR(type,ptr)  (assert( ((const ia32_attr_t*)(ptr))->attr_type & IA32_ATTR_ ## type ), (const type*) (ptr))
214 #else
215 #define CAST_IA32_ATTR(type,ptr)        ((type*) (ptr))
216 #define CONST_CAST_IA32_ATTR(type,ptr)  ((const type*) (ptr))
217 #endif
218
219 #endif