6e41e8b022a6226dce60b551238955b2465bfc7f
[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_am_None   = 0,   /**<< no addrmode support */
47         ia32_am_Dest   = 1,
48         ia32_am_Source = 2,   /**<< addrmode for source only */
49         ia32_am_Full   = 3
50 } ia32_am_type_t;
51
52 typedef enum {
53         ia32_am_arity_none = 0,
54         ia32_am_unary      = 1,
55         ia32_am_binary     = 2,
56         ia32_am_ternary    = 3,
57 } ia32_am_arity_t;
58
59 /**
60  * Different Address Mode properties:
61  * O - Offset is set
62  * B - Base is set
63  * I - Index is set
64  * S - Scale is set
65  */
66 enum {
67         ia32_O = (1 << 0),  /**< O - Offset is set */
68         ia32_B = (1 << 1),  /**< B - Base is set */
69         ia32_I = (1 << 2),  /**< I - Index is set */
70         ia32_S = (1 << 3)   /**< S - Scale is set */
71 };
72
73 enum {
74         ia32_pn_Cmp_Unsigned = 0x100 /**< set this flag in a pnc to indicate an unsigned compare operation */
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_type_t;
85 #endif
86
87 typedef struct ia32_attr_t ia32_attr_t;
88 struct ia32_attr_t {
89         except_attr  exc;               /**< the exception attribute. MUST be the first one. */
90         struct ia32_attr_data_bitfield {
91                 unsigned flags:5;           /**< Indicating if spillable, rematerializeable, stack modifying and/or ignore. */
92                 unsigned tp:3;              /**< ia32 node type. */
93                 unsigned am_support:2;      /**< Indicates the address mode type supported by this node. */
94                 unsigned am_arity  : 2;
95                 unsigned am_scale:2;        /**< The address mode scale for index register. */
96                 unsigned am_sc_sign:1;      /**< The sign bit of the address mode symconst. */
97
98                 unsigned use_frame:1;       /**< Indicates whether the operation uses the frame pointer or not. */
99                 unsigned except_label:1;    /**< Set if this node needs a label because of possible exception. */
100
101                 ia32_op_flavour_t op_flav:2;/**< Flavour of an op (flavour_Div/Mod/DivMod). */
102
103                 unsigned is_commutative:1;  /**< Indicates whether op is commutative or not. */
104
105                 unsigned got_lea:1;         /**< Indicates whether or not this node already consumed a LEA. */
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         } data;
111
112         int       *out_flags;     /**< flags for each produced value */
113
114         int        am_offs;       /**< offsets for AddrMode */
115         ir_entity *am_sc;         /**< SymConst for AddrMode */
116
117         ir_mode   *ls_mode;       /**< Load/Store mode: This is the mode of the
118                                        value that is manipulated by this node. */
119
120         ir_entity *frame_ent; /**< the frame entity attached to this node */
121
122         long pn_code;       /**< projnum "types" (e.g. indicate compare operators and argument numbers for switches) */
123
124         unsigned latency;   /**< the latency of the instruction in clock cycles */
125
126 #ifndef NDEBUG
127         const char       *orig_node;      /**< holds the name of the original ir node */
128         unsigned          attr_type;      /**< bitfield indicating the attribute type */
129 #endif
130
131         const be_execution_unit_t ***exec_units; /**< list of units this operation can be executed on */
132
133         const arch_register_req_t **in_req;  /**< register requirements for arguments */
134         const arch_register_req_t **out_req; /**< register requirements for results */
135
136         const arch_register_t **slots;     /**< register slots for assigned registers */
137 };
138 COMPILETIME_ASSERT(sizeof(struct ia32_attr_data_bitfield) <= 4, attr_bitfield);
139
140 typedef struct ia32_immediate_attr_t ia32_immediate_attr_t;
141 struct ia32_immediate_attr_t {
142         ia32_attr_t  attr;
143         ir_entity   *symconst;
144         long         offset;
145 };
146
147 typedef struct ia32_x87_attr_t ia32_x87_attr_t;
148 struct ia32_x87_attr_t {
149         ia32_attr_t            attr;
150         const arch_register_t *x87[3];    /**< register slots for x87 register */
151 };
152
153 typedef struct ia32_asm_attr_t ia32_asm_attr_t;
154 struct ia32_asm_attr_t {
155         ia32_x87_attr_t  x87_attr;
156         ident           *asm_text;
157 };
158
159 /* the following union is necessary to indicate to the compiler that we might want to cast
160  * the structs (we use them to simulate OO-inheritance) */
161 union allow_casts_attr_t_ {
162         ia32_attr_t            attr;
163         ia32_x87_attr_t        x87_attr;
164         ia32_asm_attr_t        asm_attr;
165         ia32_immediate_attr_t  immediate_attr;
166 };
167
168 #ifndef NDEBUG
169 #define CAST_IA32_ATTR(type,ptr)        (assert( ((const ia32_attr_t*)(ptr))->attr_type & IA32_ATTR_ ## type ), (type*) (ptr))
170 #define CONST_CAST_IA32_ATTR(type,ptr)  (assert( ((const ia32_attr_t*)(ptr))->attr_type & IA32_ATTR_ ## type ), (const type*) (ptr))
171 #else
172 #define CAST_IA32_ATTR(type,ptr)        ((type*) (ptr))
173 #define CONST_CAST_IA32_ATTR(type,ptr)  ((const type*) (ptr))
174 #endif
175
176 #endif