2 * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Processor architecture specification.
23 * @author Sebastian Hack
26 #ifndef FIRM_BE_BEARCH_H
27 #define FIRM_BE_BEARCH_H
29 #include "firm_types.h"
33 typedef struct arch_register_class_t arch_register_class_t;
34 typedef struct arch_register_req_t arch_register_req_t;
35 typedef struct arch_register_t arch_register_t;
36 typedef struct arch_flag_t arch_flag_t;
37 typedef struct arch_inverse_t arch_inverse_t;
38 typedef struct arch_isa_if_t arch_isa_if_t;
39 typedef struct arch_isa_t arch_isa_t;
40 typedef struct arch_env_t arch_env_t;
41 typedef struct arch_irn_ops_if_t arch_irn_ops_if_t;
42 typedef struct arch_irn_ops_t arch_irn_ops_t;
43 typedef struct arch_irn_handler_t arch_irn_handler_t;
44 typedef struct arch_code_generator_t arch_code_generator_t;
45 typedef struct arch_code_generator_if_t arch_code_generator_if_t;
47 typedef enum arch_register_type_t {
48 arch_register_type_none = 0,
49 arch_register_type_caller_save = 1, /**< The register must be saved by the caller
50 upon a function call. It thus can be overwritten
51 in the called function. */
52 arch_register_type_callee_save = 2, /**< The register must be saved by the caller
53 upon a function call. It thus can be overwritten
54 in the called function. */
55 arch_register_type_ignore = 4, /**< Do not consider this register when allocating. */
56 arch_register_type_joker = 8, /**< The emitter can choose an arbitrary register */
57 arch_register_type_virtual = 16, /**< This is just a virtual register */
58 arch_register_type_state = 32,
59 } arch_register_type_t;
62 * Put all registers in a class into a bitset.
63 * @param cls The class.
64 * @param bs The bitset. May be NULL.
65 * @return The number of registers in the class.
67 extern int arch_register_class_put(const arch_register_class_t *cls, bitset_t *bs);
69 typedef enum arch_operand_type_t {
70 arch_operand_type_invalid,
71 arch_operand_type_memory,
72 arch_operand_type_register,
73 arch_operand_type_immediate,
74 arch_operand_type_symconst,
75 arch_operand_type_last
76 } arch_operand_type_t;
79 * Different types of register allocation requirements.
81 typedef enum arch_register_req_type_t {
82 arch_register_req_type_none = 0, /**< No register requirement. */
83 arch_register_req_type_normal = 1, /**< All registers in the class are allowed. */
84 arch_register_req_type_limited = 2, /**< Only a real subset of the class is allowed. */
85 arch_register_req_type_should_be_same = 4, /**< The register should be equal another one at the node. */
86 arch_register_req_type_should_be_different = 8, /**< The register must be unequal to some other at the node. */
87 arch_register_req_type_should_be_different_from_all = 16, /**< The register must be different from all in's at the node */
88 } arch_register_req_type_t;
90 extern const arch_register_req_t *arch_no_register_req;
93 * Format a register requirements information into a string.
94 * @param buf The string where to put it to.
95 * @param len The size of @p buf.
96 * @param req The requirements structure to format.
97 * @return A pointer to buf.
99 extern char *arch_register_req_format(char *buf, size_t len, const arch_register_req_t *req, const ir_node *node);
102 * Certain node classes which are relevant for the register allocator.
104 typedef enum arch_irn_class_t {
105 arch_irn_class_normal = 1 << 0,
106 arch_irn_class_spill = 1 << 1,
107 arch_irn_class_reload = 1 << 2,
108 arch_irn_class_copy = 1 << 3,
109 arch_irn_class_perm = 1 << 4,
110 arch_irn_class_branch = 1 << 5,
111 arch_irn_class_call = 1 << 6,
112 arch_irn_class_load = 1 << 7,
113 arch_irn_class_store = 1 << 8,
114 arch_irn_class_stackparam = 1 << 9,
118 * Some flags describing a node in more detail.
120 typedef enum arch_irn_flags_t {
121 arch_irn_flags_none = 0, /**< Node flags. */
122 arch_irn_flags_dont_spill = 1, /**< This must not be spilled. */
123 arch_irn_flags_rematerializable = 2, /**< This can be replicated instead of spilled/reloaded. */
124 arch_irn_flags_ignore = 4, /**< Ignore node during register allocation. */
125 arch_irn_flags_modify_sp = 8, /**< I modify the stack pointer. */
126 arch_irn_flags_last = arch_irn_flags_modify_sp
130 * Get the string representation of a flag.
131 * This functions does not handle or'ed bitmasks of flags.
132 * @param flag The flag.
133 * @return The flag as a string.
135 extern const char *arch_irn_flag_str(arch_irn_flags_t flag);
137 extern const arch_irn_ops_t *arch_get_irn_ops(const arch_env_t *env,
140 extern void arch_set_frame_offset(const arch_env_t *env, ir_node *irn, int bias);
142 extern ir_entity *arch_get_frame_entity(const arch_env_t *env, const ir_node *irn);
143 extern void arch_set_frame_entity(const arch_env_t *env, ir_node *irn, ir_entity *ent);
144 extern int arch_get_sp_bias(const arch_env_t *env, ir_node *irn);
146 extern int arch_get_op_estimated_cost(const arch_env_t *env, const ir_node *irn);
147 extern arch_inverse_t *arch_get_inverse(const arch_env_t *env, const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack);
148 extern int arch_possible_memory_operand(const arch_env_t *env, const ir_node *irn, unsigned int i);
149 extern void arch_perform_memory_operand(const arch_env_t *env, ir_node *irn, ir_node *spill, unsigned int i);
152 * Get the register requirements for a node.
153 * @param env The architecture environment.
154 * @param req A pointer to a requirements structure, where the data can
156 * @param irn The node.
157 * @param pos The position of the operand you're interested in.
158 * @return A pointer to the register requirements which may <b>not</b>
159 * neccessarily be equal to @p req. If NULL is returned, the
160 * operand was no register operand.
162 extern const arch_register_req_t *
163 arch_get_register_req(const arch_env_t *env, const ir_node *irn, int pos);
166 * Check if an operand is a register operand.
167 * @param env The environment.
168 * @param irn The node.
169 * @param pos The position of the operand.
170 * @return 1, if the operand is significant for register allocation, 0
173 extern int arch_is_register_operand(const arch_env_t *env,
174 const ir_node *irn, int pos);
177 * Get the number of allocatable registers concerning
178 * a register class for an operand of a node.
179 * @param env The environment.
180 * @param irn The node.
181 * @param pos The postition of the node's operand.
182 * @param bs The bitset all allocatable registers shall be put into.
183 * Note, that you can also pass NULL here. If you don't,
184 * make sure, the bitset is as large as the register class
186 * @return The amount of registers allocatable for that operand.
188 extern int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn, int pos, bitset_t *bs);
191 * Put all registers which shall not be ignored by the register
192 * allocator in a bit set.
193 * @param env The arch env.
194 * @param cls The register class to consider.
195 * @param bs The bit set to put the registers to.
197 extern void arch_put_non_ignore_regs(const arch_env_t *env, const arch_register_class_t *cls, bitset_t *bs);
200 * Check, if a register is assignable to an operand of a node.
201 * @param env The architecture environment.
202 * @param irn The node.
203 * @param pos The position of the operand.
204 * @param reg The register.
205 * @return 1, if the register might be allocated to the operand 0 if not.
207 extern int arch_reg_is_allocatable(const arch_env_t *env,
208 const ir_node *irn, int pos, const arch_register_t *reg);
211 * Get the register class of an operand of a node.
212 * @param env The architecture environment.
213 * @param irn The node.
214 * @param pos The position of the operand, -1 for the output.
215 * @return The register class of the operand or NULL, if
216 * operand is a non-register operand.
218 extern const arch_register_class_t *
219 arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos);
222 * Get the register allocated at a certain output operand of a node.
223 * @param env The arch environment.
224 * @param irn The node.
225 * @return The register allocated for this operand
227 extern const arch_register_t *
228 arch_get_irn_register(const arch_env_t *env, const ir_node *irn);
231 * Set the register for a certain output operand.
232 * @param env The architecture environment.
233 * @param irn The node.
234 * @param idx The index of the output operand.
235 * @param reg The register.
237 extern void arch_set_irn_register(const arch_env_t *env, ir_node *irn,
238 const arch_register_t *reg);
242 * @param env The architecture environment.
243 * @param irn The node.
244 * @return A classification of the node.
246 extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn);
248 #define arch_irn_class_is(env, irn, irn_class) ((arch_irn_classify(env, irn) & arch_irn_class_ ## irn_class) != 0)
251 * Get the flags of a node.
252 * @param env The architecture environment.
253 * @param irn The node.
256 extern arch_irn_flags_t arch_irn_get_flags(const arch_env_t *env, const ir_node *irn);
258 #define arch_irn_is(env, irn, flag) ((arch_irn_get_flags(env, irn) & arch_irn_flags_ ## flag) != 0)
260 #define arch_irn_has_reg_class(env, irn, pos, cls) \
261 ((cls) == arch_get_irn_reg_class(env, irn, pos))
263 #define arch_irn_consider_in_reg_alloc(env, cls, irn) \
264 (arch_irn_has_reg_class(env, irn, -1, cls) && !arch_irn_is(env, irn, ignore))
267 * Initialize the architecture environment struct.
268 * @param isa The isa which shall be put into the environment.
269 * @param file_handle The file handle
270 * @return The environment.
272 extern arch_env_t *arch_env_init(arch_env_t *env, const arch_isa_if_t *isa,
273 FILE *file_handle, be_main_env_t *main_env);
276 * Add a node handler to the environment.
277 * @param env The environment.
278 * @param handler A node handler.
279 * @return The environment itself.
281 extern arch_env_t *arch_env_push_irn_handler(arch_env_t *env, const arch_irn_handler_t *handler);
284 * Remove a node handler from the handler stack.
285 * @param env The architecture environment.
286 * @return The popped handler.
288 extern const arch_irn_handler_t *arch_env_pop_irn_handler(arch_env_t *env);
291 * Register an instruction set architecture
293 void be_register_isa_if(const char *name, const arch_isa_if_t *isa);
295 #endif /* FIRM_BE_BEARCH_H */