10 #include <libcore/lc_opts.h>
25 #include "belistsched.h"
28 typedef struct _arch_register_class_t arch_register_class_t;
29 typedef struct _arch_register_t arch_register_t;
30 typedef struct _arch_isa_if_t arch_isa_if_t;
31 typedef struct _arch_isa_t arch_isa_t;
32 typedef struct _arch_env_t arch_env_t;
33 typedef struct _arch_irn_ops_if_t arch_irn_ops_if_t;
34 typedef struct _arch_irn_ops_t arch_irn_ops_t;
35 typedef struct _arch_irn_handler_t arch_irn_handler_t;
36 typedef struct _arch_code_generator_t arch_code_generator_t;
37 typedef struct _arch_code_generator_if_t arch_code_generator_if_t;
39 struct _be_node_factory_t;
41 typedef enum _arch_register_type_t {
42 arch_register_type_none = 0,
43 arch_register_type_caller_save = 1, /**< The register must be saved by the caller
44 upon a function call. It thus can be overwritten
45 in the called function. */
46 arch_register_type_callee_save = 2, /**< The register must be saved by the caller
47 upon a function call. It thus can be overwritten
48 in the called function. */
49 arch_register_type_ignore = 4, /**< Do not consider this register when allocating. */
50 arch_register_type_sp = 8, /**< This register is the stack pointer of the architecture. */
51 arch_register_type_bp = 16, /**< The register is the base pointer of the architecture. */
52 } arch_register_type_t;
55 * Convenience macro to check for register type.
56 * @param req A pointer to register.
57 * @param kind The kind of type to check for (see arch_register_type_t).
58 * @return 1, If register is of given kind, 0 if not.
60 #define arch_register_type_is(reg, kind) \
61 ((reg)->type == arch_register_type_ ## kind)
66 struct _arch_register_t {
67 const char *name; /**< The name of the register. */
68 const arch_register_class_t *reg_class; /**< The class the register belongs to. */
69 int index; /**< The index of the register in the class. */
70 arch_register_type_t type; /**< The type of the register. */
71 void *data; /**< Custom data. */
74 static INLINE const arch_register_class_t *
75 _arch_register_get_class(const arch_register_t *reg)
77 return reg->reg_class;
80 static INLINE int _arch_register_get_index(const arch_register_t *reg)
85 #define arch_register_get_class(reg) _arch_register_get_class(reg)
86 #define arch_register_get_index(reg) _arch_register_get_index(reg)
87 #define arch_register_get_name(reg) ((reg)->name)
90 * A class of registers.
91 * Like general purpose or floating point.
93 struct _arch_register_class_t {
94 const char *name; /**< The name of the register class. */
95 int n_regs; /**< Number of registers in this class. */
96 ir_mode *mode; /**< The mode of the register class. */
97 const arch_register_t *regs; /**< The array of registers. */
100 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
103 * Put all registers in a class into a bitset.
104 * @param cls The class.
105 * @param bs The bitset. May be NULL.
106 * @return The number of registers in the class.
108 extern int arch_register_class_put(const arch_register_class_t *cls, bitset_t *bs);
110 static INLINE const arch_register_t *
111 _arch_register_for_index(const arch_register_class_t *cls, int idx)
113 assert(0 <= idx && idx < cls->n_regs);
114 return &cls->regs[idx];
117 #define arch_register_for_index(cls, idx) \
118 _arch_register_for_index(cls, idx)
120 typedef enum _arch_operand_type_t {
121 arch_operand_type_invalid,
122 arch_operand_type_memory,
123 arch_operand_type_register,
124 arch_operand_type_immediate,
125 arch_operand_type_symconst,
126 arch_operand_type_last
127 } arch_operand_type_t;
130 * Different types of register allocation requirements.
132 typedef enum _arch_register_req_type_t {
133 arch_register_req_type_none = 0, /**< No register requirement. */
135 arch_register_req_type_normal = 1, /**< All registers in the class
138 arch_register_req_type_limited = 2, /**< Only a real subset of
139 the class is allowed. */
141 arch_register_req_type_should_be_same = 4, /**< The register should be equal
142 another one at the node. */
144 arch_register_req_type_should_be_different = 8, /**< The register must be unequal
145 to some other at the node. */
147 } arch_register_req_type_t;
150 * Convenience macro to check for set constraints.
151 * @param req A pointer to register requirements.
152 * @param kind The kind of constraint to check for (see arch_register_req_type_t).
153 * @return 1, If the kind of constraint is present, 0 if not.
155 #define arch_register_req_is(req, kind) \
156 (((req)->type & (arch_register_req_type_ ## kind)) != 0)
159 * Expresses requirements to register allocation for an operand.
161 typedef struct _arch_register_req_t {
162 arch_register_req_type_t type; /**< The type of the constraint. */
163 const arch_register_class_t *cls; /**< The register class this constraint belongs to. */
165 void (*limited)(void *limited_env, bitset_t *bs);
166 /**< In case of the 'limited'
167 constraint, this function
168 must put all allowable
169 registers in the bitset and
170 return the number of registers
173 void *limited_env; /**< This must passed to limited. */
175 ir_node *other_same; /**< The other which shall have the same reg
176 as this one. (for case should_be_same). */
178 ir_node *other_different; /**< The other node from which this one's register
179 must be different (case must_be_different). */
180 } arch_register_req_t;
183 * Certain node classes which are relevant for the register allocator.
185 typedef enum _arch_irn_class_t {
186 arch_irn_class_normal,
187 arch_irn_class_spill,
188 arch_irn_class_reload,
191 arch_irn_class_branch,
196 * Some flags describing a node in more detail.
198 typedef enum _arch_irn_flags_t {
199 arch_irn_flags_dont_spill = 1, /**< This must not be spilled. */
200 arch_irn_flags_rematerializable = 2, /**< This should be replicated instead of spilled/reloaded. */
201 arch_irn_flags_ignore = 4, /**< Do not consider the node during register allocation. */
204 struct _arch_irn_ops_if_t {
207 * Get the register requirements for a given operand.
208 * @param self The self pointer.
209 * @param irn The node.
210 * @param pos The operand's position
211 * (-1 for the result of the node, 0..n for the input
213 * @return The register requirements for the selected operand.
214 * The pointer returned is never NULL.
216 const arch_register_req_t *(*get_irn_reg_req)(const void *self,
217 arch_register_req_t *req, const ir_node *irn, int pos);
220 * Set the register for an output operand.
221 * @param irn The node.
222 * @param reg The register allocated to that operand.
223 * @note If the operand is not a register operand,
224 * the call is ignored.
226 void (*set_irn_reg)(const void *self, ir_node *irn, const arch_register_t *reg);
229 * Get the register allocated for an output operand.
230 * @param irn The node.
231 * @return The register allocated at that operand. NULL, if
232 * the operand was no register operand or
233 * @c arch_register_invalid, if no register has yet been
234 * allocated for this node.
236 const arch_register_t *(*get_irn_reg)(const void *self, const ir_node *irn);
240 * @param irn The node.
241 * @return A classification.
243 arch_irn_class_t (*classify)(const void *self, const ir_node *irn);
246 * Get the flags of a node.
247 * @param self The irn ops themselves.
248 * @param irn The node.
249 * @return A set of flags.
251 arch_irn_flags_t (*get_flags)(const void *self, const ir_node *irn);
256 * irn_ops base class.
258 struct _arch_irn_ops_t {
259 const arch_irn_ops_if_t *impl;
263 * Get the register requirements for a node.
264 * @param env The architecture environment.
265 * @param req A pointer to a requirements structure, where the data can
267 * @param irn The node.
268 * @param pos The position of the operand you're interested in.
269 * @return A pointer to the register requirements which may <b>not</b>
270 * neccessarily be equal to @p req. If NULL is returned, the
271 * operand was no register operand.
273 extern const arch_register_req_t *
274 arch_get_register_req(const arch_env_t *env, arch_register_req_t *req,
275 const ir_node *irn, int pos);
278 * Check if an operand is a register operand.
279 * @param env The environment.
280 * @param irn The node.
281 * @param pos The position of the operand.
282 * @return 1, if the operand is significant for register allocation, 0
285 extern int arch_is_register_operand(const arch_env_t *env,
286 const ir_node *irn, int pos);
289 * Get the number of allocatable registers concerning
290 * a register class for an operand of a node.
291 * @param env The environment.
292 * @param irn The node.
293 * @param pos The postition of the node's operand.
294 * @param bs The bitset all allocatable registers shall be put into.
295 * Note, that you can also pass NULL here. If you don't,
296 * make sure, the bitset is as large as the register class
298 * @return The amount of registers allocatable for that operand.
300 extern int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn, int pos, bitset_t *bs);
303 * Put all registers which shall not be ignored by the register
304 * allocator in a bit set.
305 * @param env The arch env.
306 * @param cls The register class to consider.
307 * @param bs The bit set to put the registers to.
309 extern void arch_put_non_ignore_regs(const arch_env_t *env, const arch_register_class_t *cls, bitset_t *bs);
312 * Check, if a register is assignable to an operand of a node.
313 * @param env The architecture environment.
314 * @param irn The node.
315 * @param pos The position of the operand.
316 * @param reg The register.
317 * @return 1, if the register might be allocated to the operand 0 if not.
319 extern int arch_reg_is_allocatable(const arch_env_t *env,
320 const ir_node *irn, int pos, const arch_register_t *reg);
323 * Get the register class of an operand of a node.
324 * @param env The architecture environment.
325 * @param irn The node.
326 * @param pos The position of the operand.
327 * @return The register class of the operand or NULL, if
328 * operand is a non-register operand.
330 extern const arch_register_class_t *
331 arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos);
334 * Get the register allocated at a certain output operand of a node.
335 * @param env The arch environment.
336 * @param irn The node.
337 * @return The register allocated for this operand
339 extern const arch_register_t *
340 arch_get_irn_register(const arch_env_t *env, const ir_node *irn);
343 * Set the register for a certain output operand.
344 * @param env The architecture environment.
345 * @param irn The node.
346 * @param idx The index of the output operand.
347 * @param reg The register.
349 extern void arch_set_irn_register(const arch_env_t *env, ir_node *irn,
350 const arch_register_t *reg);
354 * @param env The architecture environment.
355 * @param irn The node.
356 * @return A classification of the node.
358 extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn);
361 * Get the flags of a node.
362 * @param env The architecture environment.
363 * @param irn The node.
366 extern arch_irn_flags_t arch_irn_get_flags(const arch_env_t *env, const ir_node *irn);
368 #define arch_irn_is_ignore(env, irn) ((arch_irn_get_flags(env, irn) & arch_irn_flags_ignore) != 0)
370 #define arch_irn_has_reg_class(env, irn, pos, cls) \
371 ((cls) == arch_get_irn_reg_class(env, irn, pos))
373 #define arch_irn_consider_in_reg_alloc(env, cls, irn) \
374 (arch_irn_has_reg_class(env, irn, -1, cls) && !arch_irn_is_ignore(env, irn))
377 * Somebody who can be asked about nodes.
379 struct _arch_irn_handler_t {
382 * Get the operations of an irn.
383 * @param self The handler from which the method is invoked.
384 * @param irn Some node.
385 * @return Operations for that irn.
387 const void *(*get_irn_ops)(const arch_irn_handler_t *handler,
393 * The code generator.
395 struct _arch_code_generator_if_t {
399 * Initialize the code generator.
400 * @param file The file to dump to.
401 * @param irg The function to generate code for.
402 * @param env The architecture environment.
403 * @return A newly created code generator.
405 void *(*init)(FILE *file, ir_graph *irg, const arch_env_t *env);
408 * Called, when the graph is being normalized.
410 void (*prepare_graph)(void *self);
413 * Called before scheduling.
415 void (*before_sched)(void *self);
418 * Called before register allocation.
420 void (*before_ra)(void *self);
423 * Called after register allocation to lower Spills to Stores
424 * @param self The code generator
425 * @param spill The spill node to lower
426 * @return The new backend node which substitutes the spill
428 ir_node *(*lower_spill)(void *self, ir_node *spill);
431 * Called after register allocation to lower Reloads to Loads
432 * @param self The code generator
433 * @param reload The reload node to lower
434 * @return The new backend node which substitutes the reload
436 ir_node *(*lower_reload)(void *self, ir_node *reload);
439 * Called in lowering (e.g. alloca lowering) to set the
440 * correct stack register.
441 * @param self The code generator
442 * @return The stack register for the current irg
444 const arch_register_t *(*get_stack_register)(void *self);
447 * Called after everything happened.
448 * The code generator must also be de-allocated here.
450 void (*done)(void *self);
454 #define _arch_cg_call(cg, func) \
456 if((cg)->impl->func) \
457 (cg)->impl->func(cg); \
460 #define arch_code_generator_prepare_graph(cg) _arch_cg_call(cg, prepare_graph)
461 #define arch_code_generator_before_sched(cg) _arch_cg_call(cg, before_sched)
462 #define arch_code_generator_before_ra(cg) _arch_cg_call(cg, before_ra)
463 #define arch_code_generator_done(cg) _arch_cg_call(cg, done)
466 * Code generator base class.
468 struct _arch_code_generator_t {
469 const arch_code_generator_if_t *impl;
476 const arch_isa_if_t *impl;
477 const arch_register_t *sp; /** The stack pointer register. */
478 const arch_register_t *bp; /** The base pointer register. */
479 const int stack_dir; /** -1 for decreasing, 1 for increasing. */
482 #define arch_isa_stack_dir(isa) ((isa)->stack_dir)
483 #define arch_isa_sp(isa) ((isa)->sp)
484 #define arch_isa_bp(isa) ((isa)->bp)
487 * Architecture interface.
489 struct _arch_isa_if_t {
492 void (*register_options)(lc_opt_entry_t *grp);
496 * Initialize the isa interface.
501 * Free the isa instance.
503 void (*done)(void *self);
506 * Get the the number of register classes in the isa.
507 * @return The number of register classes.
509 int (*get_n_reg_class)(const void *self);
512 * Get the i-th register class.
513 * @param i The number of the register class.
514 * @return The register class.
516 const arch_register_class_t *(*get_reg_class)(const void *self, int i);
519 * Get the register class which shall be used to store a value of a given mode.
520 * @param self The this pointer.
521 * @param mode The mode in question.
522 * @return A register class which can hold values of the given mode.
524 const arch_register_class_t *(*get_reg_class_for_mode)(const void *self, const ir_mode *mode);
527 * Get the ABI restrictions for procedure calls.
528 * @param self The this pointer.
529 * @param method_type The type of the method (procedure) in question.
530 * @param p The array of parameter locations to be filled.
532 void (*get_call_abi)(const void *self, ir_type *method_type, be_abi_call_t *abi);
535 * The irn handler for this architecture.
536 * The irn handler is registered by the Firm back end
537 * when the architecture is initialized.
540 const arch_irn_handler_t *(*get_irn_handler)(const void *self);
543 * Get the code generator interface.
544 * @param self The this pointer.
545 * @return Some code generator interface.
547 const arch_code_generator_if_t *(*get_code_generator_if)(void *self);
550 * Get the list scheduler to use.
551 * @param self The isa object.
552 * @return The list scheduler selector.
554 const list_sched_selector_t *(*get_list_sched_selector)(const void *self);
557 * Take a proj from a call, set the correct register and projnum for this proj
558 * @param self The isa object.
559 * @param proj The proj
560 * @param is_keep Non-zero if proj is a Keep argument
561 * @return The backend proj number assigned to this proj
563 long (*handle_call_proj)(const void *self, ir_node *proj, int is_keep);
566 #define arch_isa_get_n_reg_class(isa) ((isa)->impl->get_n_reg_class(isa))
567 #define arch_isa_get_reg_class(isa,i) ((isa)->impl->get_reg_class(isa, i))
568 #define arch_isa_get_irn_handler(isa) ((isa)->impl->get_irn_handler(isa))
569 #define arch_isa_get_call_abi(isa,tp,abi) ((isa)->impl->get_call_abi((isa), (tp), (abi)))
570 #define arch_isa_get_reg_class_for_mode(isa,mode) ((isa)->impl->get_reg_class_for_mode((isa), (mode)))
571 #define arch_isa_make_code_generator(isa,irg) ((isa)->impl->make_code_generator(isa, irg))
573 #define ARCH_MAX_HANDLERS 8
576 * Environment for the architecture infrastructure.
577 * Keep this everywhere you're going.
580 const struct _be_node_factory_t *node_factory; /**< The node factory for be nodes. */
581 arch_isa_t *isa; /**< The isa about which everything is. */
583 arch_irn_handler_t const *handlers[ARCH_MAX_HANDLERS]; /**< The handlers are organized as
586 int handlers_tos; /**< The stack pointer of the handler
591 * Get the isa of an arch environment.
592 * @param env The environment.
593 * @return The isa with which the env was initialized with.
595 #define arch_env_get_isa(env) ((env)->isa)
598 * Initialize the architecture environment struct.
599 * @param isa The isa which shall be put into the environment.
600 * @return The environment.
602 extern arch_env_t *arch_env_init(arch_env_t *env, const arch_isa_if_t *isa);
605 * Add a node handler to the environment.
606 * @param env The environment.
607 * @param handler A node handler.
608 * @return The environment itself.
610 extern arch_env_t *arch_env_add_irn_handler(arch_env_t *env, const arch_irn_handler_t *handler);
612 #endif /* _FIRM_BEARCH_H */