bearch.h 10.6 KB
Newer Older
Christian Würdig's avatar
Christian Würdig committed
1
/*
Michael Beck's avatar
Michael Beck committed
2
 * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
Christian Würdig's avatar
Christian Würdig committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */

Christian Würdig's avatar
Christian Würdig committed
20
21
22
23
24
25
26
27
/**
 * @file
 * @brief       Processor architecture specification.
 * @author      Sebastian Hack
 * @version     $Id$
 */
#ifndef FIRM_BE_BEARCH_H
#define FIRM_BE_BEARCH_H
28

29
#include "firm_types.h"
Sebastian Hack's avatar
Sebastian Hack committed
30
#include "bitset.h"
31
#include "be.h"
Matthias Braun's avatar
Matthias Braun committed
32
#include "obst.h"
33
34
35
36
37
38
39
40
41
42
43

typedef struct arch_register_class_t     arch_register_class_t;
typedef struct arch_register_req_t       arch_register_req_t;
typedef struct arch_register_t           arch_register_t;
typedef struct arch_flag_t               arch_flag_t;
typedef struct arch_inverse_t            arch_inverse_t;
typedef struct arch_isa_if_t             arch_isa_if_t;
typedef struct arch_env_t                arch_env_t;
typedef struct arch_code_generator_t     arch_code_generator_t;
typedef struct arch_code_generator_if_t  arch_code_generator_if_t;

Matthias Braun's avatar
Matthias Braun committed
44
45
46
47
48
49
typedef enum arch_register_class_flags_t {
	arch_register_class_flag_none      = 0,
	arch_register_class_flag_manual_ra = 1,  /**< don't do automatic register allocation for this class */
	arch_register_class_flag_state     = 2
} arch_register_class_flags_t;

50
typedef enum arch_register_type_t {
Michael Beck's avatar
Michael Beck committed
51
	arch_register_type_none         = 0,
Matthias Braun's avatar
Matthias Braun committed
52
	arch_register_type_caller_save  = 1,  /**< The register must be saved by the caller
Michael Beck's avatar
Michael Beck committed
53
54
	                                           upon a function call. It thus can be overwritten
	                                           in the called function. */
Matthias Braun's avatar
Matthias Braun committed
55
	arch_register_type_callee_save  = 2,  /**< The register must be saved by the caller
Michael Beck's avatar
Michael Beck committed
56
57
	                                           upon a function call. It thus can be overwritten
	                                           in the called function. */
Matthias Braun's avatar
Matthias Braun committed
58
59
	arch_register_type_ignore       = 4,  /**< Do not consider this register when allocating. */
	arch_register_type_joker        = 8,  /**< The emitter can choose an arbitrary register */
60
	arch_register_type_virtual      = 16, /**< This is just a virtual register.Virtual registers have
Michael Beck's avatar
Michael Beck committed
61
62
	                                           nearly no constraints, it is a allowed to have multiple
	                                           definition for the same register at a point) */
63
64
	arch_register_type_state        = 32, /**< The register represents a state that should be handled by
	                                           bestate code */
Sebastian Hack's avatar
Sebastian Hack committed
65
} arch_register_type_t;
66

67
typedef enum arch_operand_type_t {
Michael Beck's avatar
Michael Beck committed
68
	arch_operand_type_invalid,
Matthias Braun's avatar
Matthias Braun committed
69
70
71
72
73
	arch_operand_type_memory,
	arch_operand_type_register,
	arch_operand_type_immediate,
	arch_operand_type_symconst,
	arch_operand_type_last
Sebastian Hack's avatar
Sebastian Hack committed
74
} arch_operand_type_t;
Sebastian Hack's avatar
Sebastian Hack committed
75

Sebastian Hack's avatar
Sebastian Hack committed
76
77
78
/**
 * Different types of register allocation requirements.
 */
79
typedef enum arch_register_req_type_t {
80
81
82
83
84
	arch_register_req_type_none              = 0,  /**< No register requirement. */
	arch_register_req_type_normal            = 1,  /**< All registers in the class are allowed. */
	arch_register_req_type_limited           = 2,  /**< Only a real subset of the class is allowed. */
	arch_register_req_type_should_be_same    = 4,  /**< The register should be equal to another one at the node. */
	arch_register_req_type_must_be_different = 8,  /**< The register must be unequal from some other at the node. */
Sebastian Hack's avatar
Sebastian Hack committed
85
} arch_register_req_type_t;
86

Matthias Braun's avatar
Matthias Braun committed
87
88
extern const arch_register_req_t *arch_no_register_req;

Sebastian Hack's avatar
Sebastian Hack committed
89
90
91
92
93
94
95
/**
 * Format a register requirements information into a string.
 * @param buf The string where to put it to.
 * @param len The size of @p buf.
 * @param req The requirements structure to format.
 * @return    A pointer to buf.
 */
Matthias Braun's avatar
Matthias Braun committed
96
extern char *arch_register_req_format(char *buf, size_t len, const arch_register_req_t *req, const ir_node *node);
Sebastian Hack's avatar
Sebastian Hack committed
97

Sebastian Hack's avatar
Sebastian Hack committed
98
/**
99
 * Certain node classes which are relevant for the register allocator.
Sebastian Hack's avatar
Sebastian Hack committed
100
 */
101
typedef enum arch_irn_class_t {
102
103
104
	arch_irn_class_normal     = 1 << 0,
	arch_irn_class_spill      = 1 << 1,
	arch_irn_class_reload     = 1 << 2,
Matthias Braun's avatar
Matthias Braun committed
105
106
107
108
109
110
111
112
	arch_irn_class_remat      = 1 << 3,
	arch_irn_class_copy       = 1 << 4,
	arch_irn_class_perm       = 1 << 5,
	arch_irn_class_branch     = 1 << 6,
	arch_irn_class_call       = 1 << 7,
	arch_irn_class_load       = 1 << 8,
	arch_irn_class_store      = 1 << 9,
	arch_irn_class_stackparam = 1 << 10,
Sebastian Hack's avatar
Sebastian Hack committed
113
114
} arch_irn_class_t;

Sebastian Hack's avatar
Sebastian Hack committed
115
116
117
/**
 * Some flags describing a node in more detail.
 */
118
typedef enum arch_irn_flags_t {
Sebastian Hack's avatar
Sebastian Hack committed
119
120
	arch_irn_flags_none             = 0, /**< Node flags. */
	arch_irn_flags_dont_spill       = 1, /**< This must not be spilled. */
121
	arch_irn_flags_rematerializable = 2, /**< This can be replicated instead of spilled/reloaded. */
Sebastian Hack's avatar
Sebastian Hack committed
122
	arch_irn_flags_ignore           = 4, /**< Ignore node during register allocation. */
Sebastian Hack's avatar
Sebastian Hack committed
123
	arch_irn_flags_modify_sp        = 8, /**< I modify the stack pointer. */
Matthias Braun's avatar
Matthias Braun committed
124
125
	arch_irn_flags_modify_flags     = 16, /**< I modify flags. */
	arch_irn_flags_last             = arch_irn_flags_modify_flags
Sebastian Hack's avatar
Sebastian Hack committed
126
} arch_irn_flags_t;
127

Sebastian Hack's avatar
Sebastian Hack committed
128
129
130
131
132
133
134
135
/**
 * Get the string representation of a flag.
 * This functions does not handle or'ed bitmasks of flags.
 * @param flag The flag.
 * @return The flag as a string.
 */
extern const char *arch_irn_flag_str(arch_irn_flags_t flag);

136
void arch_set_frame_offset(ir_node *irn, int bias);
137

138
ir_entity *arch_get_frame_entity(const ir_node *irn);
139
void       arch_set_frame_entity(ir_node *irn, ir_entity *ent);
140
int        arch_get_sp_bias(ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
141

Adam Szalkowski's avatar
Adam Szalkowski committed
142
extern int arch_get_op_estimated_cost(const arch_env_t *env, const ir_node *irn);
143
arch_inverse_t *arch_get_inverse(const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack);
144
int             arch_possible_memory_operand(const ir_node *irn, unsigned int i);
145
void            arch_perform_memory_operand(ir_node *irn, ir_node *spill, unsigned int i);
146

Sebastian Hack's avatar
Sebastian Hack committed
147
148
149
150
/**
 * Get the register requirements for a node.
 * @param irn The node.
 * @param pos The position of the operand you're interested in.
Christoph Mallon's avatar
Christoph Mallon committed
151
 * @return    A pointer to the register requirements.  If NULL is returned, the
Sebastian Hack's avatar
Sebastian Hack committed
152
153
 *            operand was no register operand.
 */
154
const arch_register_req_t *arch_get_register_req(const ir_node *irn, int pos);
155

156
157
158
159
160
161
162
163
164
165
166
/**
 * Check if an operand is a register operand.
 * @param env The environment.
 * @param irn The node.
 * @param pos The position of the operand.
 * @return 1, if the operand is significant for register allocation, 0
 * if not.
 */
extern int arch_is_register_operand(const arch_env_t *env,
    const ir_node *irn, int pos);

167
/**
Sebastian Hack's avatar
Sebastian Hack committed
168
169
170
171
 * Get the number of allocatable registers concerning
 * a register class for an operand of a node.
 * @param env The environment.
 * @param irn The node.
Michael Beck's avatar
Michael Beck committed
172
 * @param pos The position of the node's operand.
Sebastian Hack's avatar
Sebastian Hack committed
173
174
175
176
177
 * @param bs  The bitset all allocatable registers shall be put into.
 *            Note, that you can also pass NULL here. If you don't,
 *            make sure, the bitset is as large as the register class
 *            has registers.
 * @return    The amount of registers allocatable for that operand.
178
 */
Sebastian Hack's avatar
Sebastian Hack committed
179
extern int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn, int pos, bitset_t *bs);
180

Sebastian Hack's avatar
Sebastian Hack committed
181
182
183
184
185
186
/**
 * Put all registers which shall not be ignored by the register
 * allocator in a bit set.
 * @param cls The register class to consider.
 * @param bs  The bit set to put the registers to.
 */
187
extern void arch_put_non_ignore_regs(const arch_register_class_t *cls, bitset_t *bs);
Sebastian Hack's avatar
Sebastian Hack committed
188

Sebastian Hack's avatar
Sebastian Hack committed
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
/**
 * Check, if a register is assignable to an operand of a node.
 * @param env The architecture environment.
 * @param irn The node.
 * @param pos The position of the operand.
 * @param reg The register.
 * @return    1, if the register might be allocated to the operand 0 if not.
 */
extern int arch_reg_is_allocatable(const arch_env_t *env,
    const ir_node *irn, int pos, const arch_register_t *reg);

/**
 * Get the register class of an operand of a node.
 * @param env The architecture environment.
 * @param irn The node.
Michael Beck's avatar
Michael Beck committed
204
 * @param pos The position of the operand, -1 for the output.
Sebastian Hack's avatar
Sebastian Hack committed
205
206
207
208
209
210
211
212
 * @return    The register class of the operand or NULL, if
 *            operand is a non-register operand.
 */
extern const arch_register_class_t *
arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos);

/**
 * Get the register allocated at a certain output operand of a node.
Christian Würdig's avatar
Christian Würdig committed
213
 * @param env The arch environment.
Sebastian Hack's avatar
Sebastian Hack committed
214
215
216
217
 * @param irn The node.
 * @return    The register allocated for this operand
 */
extern const arch_register_t *
Sebastian Hack's avatar
Sebastian Hack committed
218
arch_get_irn_register(const arch_env_t *env, const ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
219
220
221
222
223
224
225

/**
 * Set the register for a certain output operand.
 * @param env The architecture environment.
 * @param irn The node.
 * @param reg The register.
 */
Sebastian Hack's avatar
Sebastian Hack committed
226
extern void arch_set_irn_register(const arch_env_t *env, ir_node *irn,
Michael Beck's avatar
Michael Beck committed
227
                                  const arch_register_t *reg);
Sebastian Hack's avatar
Sebastian Hack committed
228

229
230
231
232
233
234
235
236
/**
 * Classify a node.
 * @param env The architecture environment.
 * @param irn The node.
 * @return A classification of the node.
 */
extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn);

Christian Würdig's avatar
Christian Würdig committed
237
238
#define arch_irn_class_is(env, irn, irn_class) ((arch_irn_classify(env, irn) & arch_irn_class_ ## irn_class) != 0)

Sebastian Hack's avatar
Sebastian Hack committed
239
240
241
242
243
244
245
246
/**
 * Get the flags of a node.
 * @param env The architecture environment.
 * @param irn The node.
 * @return The flags.
 */
extern arch_irn_flags_t arch_irn_get_flags(const arch_env_t *env, const ir_node *irn);

247
#define arch_irn_is(env, irn, flag) ((arch_irn_get_flags(env, irn) & arch_irn_flags_ ## flag) != 0)
Sebastian Hack's avatar
Sebastian Hack committed
248

Sebastian Hack's avatar
Sebastian Hack committed
249
#define arch_irn_has_reg_class(env, irn, pos, cls) \
250
	((cls) == arch_get_irn_reg_class(env, irn, pos))
Sebastian Hack's avatar
Sebastian Hack committed
251

Sebastian Hack's avatar
Sebastian Hack committed
252
#define arch_irn_consider_in_reg_alloc(env, cls, irn) \
253
	(arch_irn_has_reg_class(env, irn, -1, cls) && !arch_irn_is(env, irn, ignore))
Sebastian Hack's avatar
Sebastian Hack committed
254

255
256
257
258
259
260
261
262
/**
 * Get the operations of an irn.
 * @param self The handler from which the method is invoked.
 * @param irn Some node.
 * @return Operations for that irn.
 */
typedef const void *(arch_get_irn_ops_t)(const ir_node *irn);

Sebastian Hack's avatar
Sebastian Hack committed
263
/**
Sebastian Hack's avatar
Sebastian Hack committed
264
 * Initialize the architecture environment struct.
265
266
 * @param isa           The isa which shall be put into the environment.
 * @param file_handle   The file handle
Sebastian Hack's avatar
Sebastian Hack committed
267
268
 * @return The environment.
 */
269
extern arch_env_t *arch_env_init(const arch_isa_if_t *isa,
270
                                 FILE *file_handle, be_main_env_t *main_env);
Sebastian Hack's avatar
Sebastian Hack committed
271

272
273
274
275
276
/**
 * Register an instruction set architecture
 */
void be_register_isa_if(const char *name, const arch_isa_if_t *isa);

Christian Würdig's avatar
Christian Würdig committed
277
#endif /* FIRM_BE_BEARCH_H */