Unconditionally include stdlib.h.
[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_mode_neutral      = 1 << 6, /**< 16 and 8 bit modes can be emulated
60                                                by 32 bit operations */
61         match_try_am            = 1 << 7, /**< only try to produce AM node, don't
62                                                do anything if AM isn't possible */
63         match_two_users         = 1 << 8  /**< the instruction uses a load two times ... */
64 } match_flags_t;
65
66 typedef struct ia32_op_attr_t ia32_op_attr_t;
67 struct ia32_op_attr_t {
68         match_flags_t  flags;
69         unsigned       latency;
70 };
71
72 #ifndef NDEBUG
73 typedef enum {
74         IA32_ATTR_INVALID               = 0,
75         IA32_ATTR_ia32_attr_t           = 1 << 0,
76         IA32_ATTR_ia32_x87_attr_t       = 1 << 1,
77         IA32_ATTR_ia32_asm_attr_t       = 1 << 2,
78         IA32_ATTR_ia32_immediate_attr_t = 1 << 3,
79         IA32_ATTR_ia32_condcode_attr_t  = 1 << 4,
80         IA32_ATTR_ia32_copyb_attr_t     = 1 << 5,
81         IA32_ATTR_ia32_call_attr_t      = 1 << 6
82 } ia32_attr_type_t;
83 #endif
84
85 /**
86  * The generic ia32 attributes. Every node has them.
87  */
88 typedef struct ia32_attr_t ia32_attr_t;
89 struct ia32_attr_t {
90         except_attr  exc;               /**< the exception attribute. MUST be the first one. */
91         struct ia32_attr_data_bitfield {
92                 unsigned tp:3;                  /**< ia32 node type. */
93                 unsigned am_arity:2;            /**< Indicates the address mode type supported by this node. */
94                 unsigned am_scale:2;            /**< The address mode scale for index register. */
95                 unsigned am_sc_sign:1;          /**< The sign bit of the address mode symconst. */
96
97                 unsigned use_frame:1;           /**< Indicates whether the operation uses the frame pointer or not. */
98                 unsigned has_except_label:1;        /**< Set if this node needs a label because of possible exception. */
99
100                 unsigned is_commutative:1;      /**< Indicates whether op is commutative or not. */
101
102                 unsigned need_stackent:1;       /**< Set to 1 if node need space on stack. */
103                 unsigned need_64bit_stackent:1; /**< needs a 64bit stack entity (see double->unsigned int conv) */
104                 unsigned need_32bit_stackent:1; /**< needs a 32bit stack entity */
105                 unsigned ins_permuted : 1;      /**< inputs of node have been permuted
106                                                      (for commutative nodes) */
107                 unsigned cmp_unsigned : 1;      /**< compare should be unsigned */
108                 unsigned is_reload : 1;         /**< node performs a reload */
109                 unsigned is_spill : 1;
110                 unsigned is_remat : 1;
111         } data;
112
113         int        am_offs;       /**< offsets for AddrMode */
114         ir_entity *am_sc;         /**< SymConst for AddrMode */
115
116         ir_mode   *ls_mode;       /**< Load/Store mode: This is the mode of the
117                                        value that is manipulated by this node. */
118
119         ir_entity *frame_ent; /**< the frame entity attached to this node */
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         ir_label_t        exc_label;       /**< the exception label iff this instruction can throw an exception */
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 a Call node.
137  */
138 typedef struct ia32_call_attr_t ia32_call_attr_t;
139 struct ia32_call_attr_t {
140         ia32_attr_t  attr;    /**< generic attribute */
141         unsigned     pop;     /**< number of bytes that get popped by the callee */
142         ir_type     *call_tp; /**< The call type, copied from the original Call node. */
143 };
144
145 /**
146  * The attributes for nodes with condition code.
147  */
148 typedef struct ia32_condcode_attr_t ia32_condcode_attr_t;
149 struct ia32_condcode_attr_t {
150         ia32_attr_t  attr;      /**< generic attribute */
151         long         pn_code;   /**< projnum "types" (e.g. indicate compare operators */
152 };
153
154 /**
155  * The attributes for CopyB code.
156  */
157 typedef struct ia32_copyb_attr_t ia32_copyb_attr_t;
158 struct ia32_copyb_attr_t {
159         ia32_attr_t  attr;      /**< generic attribute */
160         unsigned     size;      /**< size of copied block */
161 };
162
163 /**
164  * The attributes for immediates.
165  */
166 typedef struct ia32_immediate_attr_t ia32_immediate_attr_t;
167 struct ia32_immediate_attr_t {
168         ia32_attr_t  attr;              /**< generic attribute */
169         ir_entity   *symconst;          /**< An entity if any. */
170         long         offset;            /**< An offset if any. */
171         unsigned     sc_sign:1;         /**< The sign bit of the symconst. */
172 };
173
174 /**
175  * The attributes for x87 nodes.
176  */
177 typedef struct ia32_x87_attr_t ia32_x87_attr_t;
178 struct ia32_x87_attr_t {
179         ia32_attr_t            attr;      /**< the generic attribute */
180         const arch_register_t *x87[3];    /**< register slots for x87 register */
181 };
182
183 typedef struct ia32_asm_reg_t ia32_asm_reg_t;
184 struct ia32_asm_reg_t {
185         unsigned                   use_input  : 1; /* use input or output pos */
186         unsigned                   valid      : 1;
187         unsigned                   memory     : 1;
188         unsigned                   dummy_fill : 13;
189         unsigned                   inout_pos  : 16; /* in/out pos where the
190                                                        register is assigned */
191         const ir_mode             *mode;
192 };
193
194 /**
195  * The attributes for ASM nodes.
196  */
197 typedef struct ia32_asm_attr_t ia32_asm_attr_t;
198 struct ia32_asm_attr_t {
199         ia32_x87_attr_t       x87_attr;
200         ident                *asm_text;
201         const ia32_asm_reg_t *register_map;
202 };
203
204 /* the following union is necessary to indicate to the compiler that we might want to cast
205  * the structs (we use them to simulate OO-inheritance) */
206 union allow_casts_attr_t_ {
207         ia32_attr_t            attr;
208         ia32_call_attr_t       call_attr;
209         ia32_condcode_attr_t   cc_attr;
210         ia32_copyb_attr_t      cpy_attr;
211         ia32_x87_attr_t        x87_attr;
212         ia32_asm_attr_t        asm_attr;
213         ia32_immediate_attr_t  immediate_attr;
214 };
215
216 #ifndef NDEBUG
217 #define CAST_IA32_ATTR(type,ptr)        (assert( ((const ia32_attr_t*)(ptr))->attr_type & IA32_ATTR_ ## type ), (type*) (ptr))
218 #define CONST_CAST_IA32_ATTR(type,ptr)  (assert( ((const ia32_attr_t*)(ptr))->attr_type & IA32_ATTR_ ## type ), (const type*) (ptr))
219 #else
220 #define CAST_IA32_ATTR(type,ptr)        ((type*) (ptr))
221 #define CONST_CAST_IA32_ATTR(type,ptr)  ((const type*) (ptr))
222 #endif
223
224 #endif