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