4 #include "firm_config.h"
7 #include <libcore/lc_opts.h>
20 #include "belistsched.h"
22 typedef struct _arch_register_class_t arch_register_class_t;
23 typedef struct _arch_register_t arch_register_t;
24 typedef struct _arch_enum_t arch_enum_t;
25 typedef struct _arch_enum_member_t arch_enum_member_t;
26 typedef struct _arch_isa_if_t arch_isa_if_t;
27 typedef struct _arch_isa_t arch_isa_t;
28 typedef struct _arch_env_t arch_env_t;
29 typedef struct _arch_irn_ops_t arch_irn_ops_t;
30 typedef struct _arch_irn_handler_t arch_irn_handler_t;
31 typedef struct _arch_code_generator_t arch_code_generator_t;
32 typedef struct _arch_code_generator_if_t arch_code_generator_if_t;
34 struct _be_node_factory_t;
36 typedef enum _arch_register_type_t {
37 arch_register_type_none = 0,
38 arch_register_type_write_invariant,
39 arch_register_type_caller_saved, /**< The register must be saved by the caller
40 upon a function call. It thus can be overwritten
41 in the called function. */
42 arch_register_type_callee_saved, /**< The register must be saved by the called function,
43 it thus survives a function call. */
44 arch_register_type_ignore /**< Do not consider this register when allocating. */
45 } arch_register_type_t;
50 struct _arch_register_t {
51 const char *name; /**< The name of the register. */
52 const arch_register_class_t *reg_class; /**< The class the register belongs to. */
53 int index; /**< The index of the register in the class. */
54 arch_register_type_t type; /**< The type of the register. */
55 void *data; /**< Custom data. */
58 static INLINE const arch_register_class_t *
59 _arch_register_get_class(const arch_register_t *reg)
61 return reg->reg_class;
64 static INLINE int _arch_register_get_index(const arch_register_t *reg)
69 #define arch_register_get_class(reg) _arch_register_get_class(reg)
70 #define arch_register_get_index(reg) _arch_register_get_index(reg)
71 #define arch_register_get_name(reg) ((reg)->name)
74 * A class of registers.
75 * Like general purpose or floating point.
77 struct _arch_register_class_t {
78 const char *name; /**< The name of the register class. */
79 int n_regs; /**< Number of registers in this class. */
80 const arch_register_t *regs; /**< The array of registers. */
83 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
86 * Put all registers in a class into a bitset.
87 * @param cls The class.
88 * @param bs The bitset. May be NULL.
89 * @return The number of registers in the class.
91 extern int arch_register_class_put(const arch_register_class_t *cls, bitset_t *bs);
93 static INLINE const arch_register_t *
94 _arch_register_for_index(const arch_register_class_t *cls, int idx)
96 assert(0 <= idx && idx < cls->n_regs);
97 return &cls->regs[idx];
100 #define arch_register_for_index(cls, idx) \
101 _arch_register_for_index(cls, idx)
104 * Get the register set for a register class.
105 * @param cls The register class.
106 * @return The set containing all registers in the class.
108 #define arch_get_register_set_for_class(cls) ((cls)->set)
110 typedef enum _arch_operand_type_t {
111 arch_operand_type_invalid,
112 arch_operand_type_memory,
113 arch_operand_type_register,
114 arch_operand_type_immediate,
115 arch_operand_type_symconst,
116 arch_operand_type_last
117 } arch_operand_type_t;
120 * Different types of register allocation requirements.
122 typedef enum _arch_register_req_type_t {
123 arch_register_req_type_none = 0, /**< No register requirement. */
125 arch_register_req_type_normal = 1, /**< All registers in the class
128 arch_register_req_type_limited = 2, /**< Only a real subset of
129 the class is allowed. */
131 arch_register_req_type_should_be_same = 4, /**< The register should be equal
132 another one at the node. */
134 arch_register_req_type_should_be_different = 8, /**< The register must be unequal
135 to some other at the node. */
137 } arch_register_req_type_t;
140 * Convenience macro to check for set constraints.
141 * @param req A pointer to register requirements.
142 * @param kind The kind of constraint to check for (see arch_register_req_type_t).
143 * @return 1, If the kind of constraint is present, 0 if not.
145 #define arch_register_req_is(req, kind) \
146 ((req)->type & (arch_register_req_type_ ## kind) != 0)
149 * Expresses requirements to register allocation for an operand.
151 typedef struct _arch_register_req_t {
152 arch_register_req_type_t type; /**< The type of the constraint. */
153 const arch_register_class_t *cls; /**< The register class this constraint belongs to. */
155 int (*limited)(const ir_node *irn, int pos, bitset_t *bs);
156 /**< In case of the 'limited'
157 constraint, this function
158 must put all allowable
159 registers in the bitset and
160 return the number of registers
163 const ir_node *other; /**< In case of "should be equal"
164 or should be different, this gives
165 the node to whose register this
166 one's should be the same/different. */
167 } arch_register_req_t;
170 * Certain node classes which are relevant for the register allocator.
172 typedef enum _arch_irn_class_t {
173 arch_irn_class_normal,
174 arch_irn_class_spill,
175 arch_irn_class_reload,
178 arch_irn_class_branch
182 * Some flags describing a node in more detail.
184 typedef enum _arch_irn_flags_t {
185 arch_irn_flags_spillable = 1,
186 arch_irn_flags_rematerializable = 2
189 struct _arch_irn_ops_t {
192 * Get the register requirements for a given operand.
193 * @param self The self pointer.
194 * @param irn The node.
195 * @param pos The operand's position
196 * (-1 for the result of the node, 0..n for the input
198 * @return The register requirements for the selected operand.
199 * The pointer returned is never NULL.
201 const arch_register_req_t *(*get_irn_reg_req)(const arch_irn_ops_t *self,
202 arch_register_req_t *req, const ir_node *irn, int pos);
205 * Set the register for an output operand.
206 * @param irn The node.
207 * @param reg The register allocated to that operand.
208 * @note If the operand is not a register operand,
209 * the call is ignored.
211 void (*set_irn_reg)(const arch_irn_ops_t *self, ir_node *irn, const arch_register_t *reg);
214 * Get the register allocated for an output operand.
215 * @param irn The node.
216 * @return The register allocated at that operand. NULL, if
217 * the operand was no register operand or
218 * @c arch_register_invalid, if no register has yet been
219 * allocated for this node.
221 const arch_register_t *(*get_irn_reg)(const arch_irn_ops_t *self, const ir_node *irn);
225 * @param irn The node.
226 * @return A classification.
228 arch_irn_class_t (*classify)(const arch_irn_ops_t *self, const ir_node *irn);
231 * Get the flags of a node.
232 * @param self The irn ops themselves.
233 * @param irn The node.
234 * @return A set of flags.
236 arch_irn_flags_t (*get_flags)(const arch_irn_ops_t *self, const ir_node *irn);
241 * Get the register requirements for a node.
242 * @param env The architecture environment.
243 * @param req A pointer to a requirements structure, where the data can
245 * @param irn The node.
246 * @param pos The position of the operand you're interested in.
247 * @return A pointer to the register requirements which may <b>not</b>
248 * neccessarily be equal to @p req. If NULL is returned, the
249 * operand was no register operand.
251 extern const arch_register_req_t *
252 arch_get_register_req(const arch_env_t *env, arch_register_req_t *req,
253 const ir_node *irn, int pos);
256 * Check if an operand is a register operand.
257 * @param env The environment.
258 * @param irn The node.
259 * @param pos The position of the operand.
260 * @return 1, if the operand is significant for register allocation, 0
263 extern int arch_is_register_operand(const arch_env_t *env,
264 const ir_node *irn, int pos);
267 * Get the number of allocatable registers concerning
268 * a register class for an operand of a node.
269 * @param env The environment.
270 * @param irn The node.
271 * @param pos The postition of the node's operand.
272 * @param cls The register class.
273 * @param bs The bitset all allocatable registers shall be put into.
274 * Note, that you can also pass NULL here. If you don't,
275 * make sure, the bitset is as large as the register class
277 * @return The amount of registers allocatable for that operand.
279 extern int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn,
280 int pos, const arch_register_class_t *cls, bitset_t *bs);
283 * Check, if a register is assignable to an operand of a node.
284 * @param env The architecture environment.
285 * @param irn The node.
286 * @param pos The position of the operand.
287 * @param reg The register.
288 * @return 1, if the register might be allocated to the operand 0 if not.
290 extern int arch_reg_is_allocatable(const arch_env_t *env,
291 const ir_node *irn, int pos, const arch_register_t *reg);
294 * Get the register class of an operand of a node.
295 * @param env The architecture environment.
296 * @param irn The node.
297 * @param pos The position of the operand.
298 * @return The register class of the operand or NULL, if
299 * operand is a non-register operand.
301 extern const arch_register_class_t *
302 arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos);
305 * Get the register allocated at a certain output operand of a node.
306 * @param env The arch environment.
307 * @param irn The node.
308 * @return The register allocated for this operand
310 extern const arch_register_t *
311 arch_get_irn_register(const arch_env_t *env, const ir_node *irn);
314 * Set the register for a certain output operand.
315 * @param env The architecture environment.
316 * @param irn The node.
317 * @param idx The index of the output operand.
318 * @param reg The register.
320 extern void arch_set_irn_register(const arch_env_t *env, ir_node *irn,
321 const arch_register_t *reg);
325 * @param env The architecture environment.
326 * @param irn The node.
327 * @return A classification of the node.
329 extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn);
332 * Get the flags of a node.
333 * @param env The architecture environment.
334 * @param irn The node.
337 extern arch_irn_flags_t arch_irn_get_flags(const arch_env_t *env, const ir_node *irn);
339 #define arch_irn_has_reg_class(env, irn, pos, cls) \
340 ((cls) == arch_get_irn_reg_class(env, irn, pos))
343 * Somebody who can be asked about nodes.
345 struct _arch_irn_handler_t {
348 * Get the operations of an irn.
349 * @param self The handler from which the method is invoked.
350 * @param irn Some node.
351 * @return Operations for that irn.
353 const arch_irn_ops_t *(*get_irn_ops)(const arch_irn_handler_t *handler,
359 * The code generator.
361 struct _arch_code_generator_if_t {
365 * Initialize the code generator.
366 * @param file The file to dump to.
367 * @param irg The function to generate code for.
368 * @param env The architecture environment.
369 * @return A newly created code generator.
371 void *(*init)(FILE *file, ir_graph *irg, const arch_env_t *env);
374 * Called, when the graph is being normalized.
376 void (*prepare_graph)(void *self);
379 * Called before scheduling.
381 void (*before_sched)(void *self);
384 * Called before register allocation.
386 void (*before_ra)(void *self);
389 * Called after everything happened.
390 * The code generator must also be de-allocated here.
392 void (*done)(void *self);
396 #define _arch_cg_call(cg, func) \
398 if((cg)->impl->func) \
399 (cg)->impl->func(cg); \
402 #define arch_code_generator_prepare_graph(cg) _arch_cg_call(cg, prepare_graph)
403 #define arch_code_generator_before_sched(cg) _arch_cg_call(cg, before_sched)
404 #define arch_code_generator_before_ra(cg) _arch_cg_call(cg, before_ra)
405 #define arch_code_generator_done(cg) _arch_cg_call(cg, done)
408 * Code generator base class.
410 struct _arch_code_generator_t {
411 const arch_code_generator_if_t *impl;
418 const arch_isa_if_t *impl;
422 * Architecture interface.
424 struct _arch_isa_if_t {
427 void (*register_options)(lc_opt_entry_t *grp);
431 * Initialize the isa interface.
436 * Free the isa instance.
438 void (*done)(void *self);
441 * Get the the number of register classes in the isa.
442 * @return The number of register classes.
444 int (*get_n_reg_class)(const void *self);
447 * Get the i-th register class.
448 * @param i The number of the register class.
449 * @return The register class.
451 const arch_register_class_t *(*get_reg_class)(const void *self, int i);
454 * The irn handler for this architecture.
455 * The irn handler is registered by the Firm back end
456 * when the architecture is initialized.
459 const arch_irn_handler_t *(*get_irn_handler)(const void *self);
462 * Get the code generator interface.
463 * @param self The this pointer.
464 * @return Some code generator interface.
466 const arch_code_generator_if_t *(*get_code_generator)(void *self);
469 * Get the list scheduler to use.
470 * @param self The isa object.
471 * @return The list scheduler selector.
473 const list_sched_selector_t *(*get_list_sched_selector)(const void *self);
476 #define arch_isa_get_n_reg_class(isa) ((isa)->impl->get_n_reg_class(isa))
477 #define arch_isa_get_reg_class(isa,i) ((isa)->impl->get_reg_class(isa, i))
478 #define arch_isa_get_irn_handler(isa) ((isa)->impl->get_irn_handler(isa))
479 #define arch_isa_make_code_generator(isa,irg) ((isa)->impl->make_code_generator(isa, irg))
481 #define ARCH_MAX_HANDLERS 8
484 * Environment for the architecture infrastructure.
485 * Keep this everywhere you're going.
488 const struct _be_node_factory_t *node_factory; /**< The node factory for be nodes. */
489 arch_isa_t *isa; /**< The isa about which everything is. */
491 arch_irn_handler_t const *handlers[ARCH_MAX_HANDLERS]; /**< The handlers are organized as
494 int handlers_tos; /**< The stack pointer of the handler
499 * Get the isa of an arch environment.
500 * @param env The environment.
501 * @return The isa with which the env was initialized with.
503 #define arch_env_get_isa(env) ((env)->isa)
506 * Initialize the architecture environment struct.
507 * @param isa The isa which shall be put into the environment.
508 * @return The environment.
510 extern arch_env_t *arch_env_init(arch_env_t *env, const arch_isa_if_t *isa);
513 * Add a node handler to the environment.
514 * @param env The environment.
515 * @param handler A node handler.
516 * @return The environment itself.
518 extern arch_env_t *arch_env_add_irn_handler(arch_env_t *env,
519 const arch_irn_handler_t *handler);
521 #endif /* _FIRM_BEARCH_H */