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;
68 * Different types of register allocation requirements.
70 typedef enum arch_register_req_type_t {
71 arch_register_req_type_none = 0, /**< No register requirement. */
72 arch_register_req_type_normal = 1, /**< All registers in the class are allowed. */
73 arch_register_req_type_limited = 2, /**< Only a real subset of the class is allowed. */
74 arch_register_req_type_should_be_same = 4, /**< The register should be equal to another one at the node. */
75 arch_register_req_type_must_be_different = 8, /**< The register must be unequal from some other at the node. */
76 } arch_register_req_type_t;
78 extern const arch_register_req_t *arch_no_register_req;
81 * Format a register requirements information into a string.
82 * @param buf The string where to put it to.
83 * @param len The size of @p buf.
84 * @param req The requirements structure to format.
85 * @return A pointer to buf.
87 extern char *arch_register_req_format(char *buf, size_t len, const arch_register_req_t *req, const ir_node *node);
90 * Certain node classes which are relevant for the register allocator.
92 typedef enum arch_irn_class_t {
93 arch_irn_class_spill = 1 << 0,
94 arch_irn_class_reload = 1 << 1,
95 arch_irn_class_remat = 1 << 2,
96 arch_irn_class_copy = 1 << 3,
97 arch_irn_class_perm = 1 << 4,
98 arch_irn_class_branch = 1 << 5
102 * Some flags describing a node in more detail.
104 typedef enum arch_irn_flags_t {
105 arch_irn_flags_none = 0, /**< Node flags. */
106 arch_irn_flags_dont_spill = 1U << 0, /**< This must not be spilled. */
107 arch_irn_flags_rematerializable = 1U << 1, /**< This can be replicated instead of spilled/reloaded. */
108 arch_irn_flags_ignore = 1U << 2, /**< Ignore node during register allocation. */
109 arch_irn_flags_modify_sp = 1U << 3, /**< I modify the stack pointer. */
110 arch_irn_flags_modify_flags = 1U << 4 /**< I modify flags. */
113 void arch_set_frame_offset(ir_node *irn, int bias);
115 ir_entity *arch_get_frame_entity(const ir_node *irn);
116 void arch_set_frame_entity(ir_node *irn, ir_entity *ent);
117 int arch_get_sp_bias(ir_node *irn);
119 int arch_get_op_estimated_cost(const ir_node *irn);
120 arch_inverse_t *arch_get_inverse(const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack);
121 int arch_possible_memory_operand(const ir_node *irn, unsigned int i);
122 void arch_perform_memory_operand(ir_node *irn, ir_node *spill, unsigned int i);
125 * Get the register requirements for a node.
126 * @param irn The node.
127 * @param pos The position of the operand you're interested in.
128 * @return A pointer to the register requirements. If NULL is returned, the
129 * operand was no register operand.
131 const arch_register_req_t *arch_get_register_req(const ir_node *irn, int pos);
133 #define arch_get_register_req_out(irn) arch_get_register_req(irn, -1)
136 * Get the number of allocatable registers concerning
137 * a register class for an operand of a node.
138 * @param irn The node.
139 * @param pos The position of the node's operand.
140 * @param bs The bitset all allocatable registers shall be put into.
141 * @return The amount of registers allocatable for that operand.
143 int arch_get_allocatable_regs(const ir_node *irn, int pos, bitset_t *bs);
146 * Put all registers which shall not be ignored by the register
147 * allocator in a bit set.
148 * @param cls The register class to consider.
149 * @param bs The bit set to put the registers to.
151 extern void arch_put_non_ignore_regs(const arch_register_class_t *cls, bitset_t *bs);
154 * Check, if a register is assignable to an operand of a node.
155 * @param irn The node.
156 * @param pos The position of the operand.
157 * @param reg The register.
158 * @return 1, if the register might be allocated to the operand 0 if not.
160 int arch_reg_is_allocatable(const ir_node *irn, int pos, const arch_register_t *reg);
162 #define arch_reg_out_is_allocatable(irn, reg) arch_reg_is_allocatable(irn, -1, reg)
165 * Get the register class of an operand of a node.
166 * @param irn The node.
167 * @param pos The position of the operand, -1 for the output.
168 * @return The register class of the operand or NULL, if
169 * operand is a non-register operand.
171 const arch_register_class_t *arch_get_irn_reg_class(const ir_node *irn, int pos);
173 #define arch_get_irn_reg_class_out(irn) arch_get_irn_reg_class(irn, -1)
176 * Get the register allocated at a certain output operand of a node.
177 * @param irn The node.
178 * @return The register allocated for this operand
180 const arch_register_t *arch_get_irn_register(const ir_node *irn);
183 * Set the register for a certain output operand.
184 * @param irn The node.
185 * @param reg The register.
187 void arch_set_irn_register(ir_node *irn, const arch_register_t *reg);
191 * @param irn The node.
192 * @return A classification of the node.
194 arch_irn_class_t arch_irn_classify(const ir_node *irn);
196 #define arch_irn_class_is(irn, irn_class) ((arch_irn_classify(irn) & arch_irn_class_ ## irn_class) != 0)
199 * Get the flags of a node.
200 * @param irn The node.
203 arch_irn_flags_t arch_irn_get_flags(const ir_node *irn);
205 #define arch_irn_is(irn, flag) ((arch_irn_get_flags(irn) & arch_irn_flags_ ## flag) != 0)
207 #define arch_irn_consider_in_reg_alloc(cls, irn) \
208 (arch_get_irn_reg_class_out(irn) == (cls) && !arch_irn_is(irn, ignore))
211 * Get the operations of an irn.
212 * @param self The handler from which the method is invoked.
213 * @param irn Some node.
214 * @return Operations for that irn.
216 typedef const void *(arch_get_irn_ops_t)(const ir_node *irn);
219 * Initialize the architecture environment struct.
220 * @param isa The isa which shall be put into the environment.
221 * @param file_handle The file handle
222 * @return The environment.
224 extern arch_env_t *arch_env_init(const arch_isa_if_t *isa,
225 FILE *file_handle, be_main_env_t *main_env);
228 * Register an instruction set architecture
230 void be_register_isa_if(const char *name, const arch_isa_if_t *isa);
232 #endif /* FIRM_BE_BEARCH_H */