2 * Copyright (C) 1995-2008 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"
34 typedef struct arch_register_class_t arch_register_class_t;
35 typedef struct arch_register_req_t arch_register_req_t;
36 typedef struct arch_register_t arch_register_t;
37 typedef struct arch_flag_t arch_flag_t;
38 typedef struct arch_inverse_t arch_inverse_t;
39 typedef struct arch_isa_if_t arch_isa_if_t;
40 typedef struct arch_env_t arch_env_t;
41 typedef struct arch_code_generator_t arch_code_generator_t;
42 typedef struct arch_code_generator_if_t arch_code_generator_if_t;
44 typedef enum arch_register_class_flags_t {
45 arch_register_class_flag_none = 0,
46 arch_register_class_flag_manual_ra = 1, /**< don't do automatic register allocation for this class */
47 arch_register_class_flag_state = 2
48 } arch_register_class_flags_t;
50 typedef enum arch_register_type_t {
51 arch_register_type_none = 0,
52 arch_register_type_caller_save = 1, /**< 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_callee_save = 2, /**< The register must be saved by the caller
56 upon a function call. It thus can be overwritten
57 in the called function. */
58 arch_register_type_ignore = 4, /**< Do not consider this register when allocating. */
59 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
61 nearly no constraints, it is a allowed to have multiple
62 definition for the same register at a point) */
63 arch_register_type_state = 32, /**< The register represents a state that should be handled by
65 } arch_register_type_t;
67 typedef enum arch_operand_type_t {
68 arch_operand_type_invalid,
69 arch_operand_type_memory,
70 arch_operand_type_register,
71 arch_operand_type_immediate,
72 arch_operand_type_symconst
73 } arch_operand_type_t;
76 * Different types of register allocation requirements.
78 typedef enum arch_register_req_type_t {
79 arch_register_req_type_none = 0, /**< No register requirement. */
80 arch_register_req_type_normal = 1, /**< All registers in the class are allowed. */
81 arch_register_req_type_limited = 2, /**< Only a real subset of the class is allowed. */
82 arch_register_req_type_should_be_same = 4, /**< The register should be equal to another one at the node. */
83 arch_register_req_type_must_be_different = 8, /**< The register must be unequal from some other at the node. */
84 } arch_register_req_type_t;
86 extern const arch_register_req_t *arch_no_register_req;
89 * Format a register requirements information into a string.
90 * @param buf The string where to put it to.
91 * @param len The size of @p buf.
92 * @param req The requirements structure to format.
93 * @return A pointer to buf.
95 extern char *arch_register_req_format(char *buf, size_t len, const arch_register_req_t *req, const ir_node *node);
98 * Certain node classes which are relevant for the register allocator.
100 typedef enum arch_irn_class_t {
101 arch_irn_class_normal = 1 << 0,
102 arch_irn_class_spill = 1 << 1,
103 arch_irn_class_reload = 1 << 2,
104 arch_irn_class_remat = 1 << 3,
105 arch_irn_class_copy = 1 << 4,
106 arch_irn_class_perm = 1 << 5,
107 arch_irn_class_branch = 1 << 6,
108 arch_irn_class_call = 1 << 7,
109 arch_irn_class_load = 1 << 8,
110 arch_irn_class_store = 1 << 9,
111 arch_irn_class_stackparam = 1 << 10,
115 * Some flags describing a node in more detail.
117 typedef enum arch_irn_flags_t {
118 arch_irn_flags_none = 0, /**< Node flags. */
119 arch_irn_flags_dont_spill = 1U << 0, /**< This must not be spilled. */
120 arch_irn_flags_rematerializable = 1U << 1, /**< This can be replicated instead of spilled/reloaded. */
121 arch_irn_flags_ignore = 1U << 2, /**< Ignore node during register allocation. */
122 arch_irn_flags_modify_sp = 1U << 3, /**< I modify the stack pointer. */
123 arch_irn_flags_modify_flags = 1U << 4 /**< I modify flags. */
126 void arch_set_frame_offset(ir_node *irn, int bias);
128 ir_entity *arch_get_frame_entity(const ir_node *irn);
129 void arch_set_frame_entity(ir_node *irn, ir_entity *ent);
130 int arch_get_sp_bias(ir_node *irn);
132 int arch_get_op_estimated_cost(const ir_node *irn);
133 arch_inverse_t *arch_get_inverse(const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack);
134 int arch_possible_memory_operand(const ir_node *irn, unsigned int i);
135 void arch_perform_memory_operand(ir_node *irn, ir_node *spill, unsigned int i);
138 * Get the register requirements for a node.
139 * @param irn The node.
140 * @param pos The position of the operand you're interested in.
141 * @return A pointer to the register requirements. If NULL is returned, the
142 * operand was no register operand.
144 const arch_register_req_t *arch_get_register_req(const ir_node *irn, int pos);
147 * Check if an operand is a register operand.
148 * @param irn The node.
149 * @param pos The position of the operand.
150 * @return 1, if the operand is significant for register allocation, 0
153 int arch_is_register_operand(const ir_node *irn, int pos);
156 * Get the number of allocatable registers concerning
157 * a register class for an operand of a node.
158 * @param irn The node.
159 * @param pos The position of the node's operand.
160 * @param bs The bitset all allocatable registers shall be put into.
161 * Note, that you can also pass NULL here. If you don't,
162 * make sure, the bitset is as large as the register class
164 * @return The amount of registers allocatable for that operand.
166 int arch_get_allocatable_regs(const ir_node *irn, int pos, bitset_t *bs);
169 * Put all registers which shall not be ignored by the register
170 * allocator in a bit set.
171 * @param cls The register class to consider.
172 * @param bs The bit set to put the registers to.
174 extern void arch_put_non_ignore_regs(const arch_register_class_t *cls, bitset_t *bs);
177 * Check, if a register is assignable to an operand of a node.
178 * @param irn The node.
179 * @param pos The position of the operand.
180 * @param reg The register.
181 * @return 1, if the register might be allocated to the operand 0 if not.
183 int arch_reg_is_allocatable(const ir_node *irn, int pos, const arch_register_t *reg);
186 * Get the register class of an operand of a node.
187 * @param irn The node.
188 * @param pos The position of the operand, -1 for the output.
189 * @return The register class of the operand or NULL, if
190 * operand is a non-register operand.
192 const arch_register_class_t *arch_get_irn_reg_class(const ir_node *irn, int pos);
195 * Get the register allocated at a certain output operand of a node.
196 * @param irn The node.
197 * @return The register allocated for this operand
199 const arch_register_t *arch_get_irn_register(const ir_node *irn);
202 * Set the register for a certain output operand.
203 * @param irn The node.
204 * @param reg The register.
206 void arch_set_irn_register(ir_node *irn, const arch_register_t *reg);
210 * @param irn The node.
211 * @return A classification of the node.
213 arch_irn_class_t arch_irn_classify(const ir_node *irn);
215 #define arch_irn_class_is(irn, irn_class) ((arch_irn_classify(irn) & arch_irn_class_ ## irn_class) != 0)
218 * Get the flags of a node.
219 * @param irn The node.
222 arch_irn_flags_t arch_irn_get_flags(const ir_node *irn);
224 #define arch_irn_is(irn, flag) ((arch_irn_get_flags(irn) & arch_irn_flags_ ## flag) != 0)
226 #define arch_irn_has_reg_class(irn, pos, cls) \
227 ((cls) == arch_get_irn_reg_class(irn, pos))
229 #define arch_irn_consider_in_reg_alloc(cls, irn) \
230 (arch_irn_has_reg_class(irn, -1, cls) && !arch_irn_is(irn, ignore))
233 * Get the operations of an irn.
234 * @param self The handler from which the method is invoked.
235 * @param irn Some node.
236 * @return Operations for that irn.
238 typedef const void *(arch_get_irn_ops_t)(const ir_node *irn);
241 * Initialize the architecture environment struct.
242 * @param isa The isa which shall be put into the environment.
243 * @param file_handle The file handle
244 * @return The environment.
246 extern arch_env_t *arch_env_init(const arch_isa_if_t *isa,
247 FILE *file_handle, be_main_env_t *main_env);
250 * Register an instruction set architecture
252 void be_register_isa_if(const char *name, const arch_isa_if_t *isa);
254 #endif /* FIRM_BE_BEARCH_H */