4 #include "firm_config.h"
7 #include <libcore/lc_opts.h>
10 #include "firm_types.h"
14 #include "belistsched.h"
19 struct _be_node_factory_t;
21 typedef enum _arch_register_type_t {
22 arch_register_type_none = 0,
23 arch_register_type_caller_save = 1, /**< The register must be saved by the caller
24 upon a function call. It thus can be overwritten
25 in the called function. */
26 arch_register_type_callee_save = 2, /**< The register must be saved by the caller
27 upon a function call. It thus can be overwritten
28 in the called function. */
29 arch_register_type_ignore = 4, /**< Do not consider this register when allocating. */
30 } arch_register_type_t;
33 * Convenience macro to check for register type.
34 * @param req A pointer to register.
35 * @param kind The kind of type to check for (see arch_register_type_t).
36 * @return 1, If register is of given kind, 0 if not.
38 #define arch_register_type_is(reg, kind) \
39 (((reg)->type & arch_register_type_ ## kind) != 0)
44 struct _arch_register_t {
45 const char *name; /**< The name of the register. */
46 const arch_register_class_t *reg_class; /**< The class the register belongs to. */
47 int index; /**< The index of the register in the class. */
48 arch_register_type_t type; /**< The type of the register. */
49 void *data; /**< Custom data. */
52 static INLINE const arch_register_class_t *
53 _arch_register_get_class(const arch_register_t *reg)
55 return reg->reg_class;
58 static INLINE int _arch_register_get_index(const arch_register_t *reg)
63 #define arch_register_get_class(reg) _arch_register_get_class(reg)
64 #define arch_register_get_index(reg) _arch_register_get_index(reg)
65 #define arch_register_get_name(reg) ((reg)->name)
68 * A class of registers.
69 * Like general purpose or floating point.
71 struct _arch_register_class_t {
72 const char *name; /**< The name of the register class. */
73 int n_regs; /**< Number of registers in this class. */
74 ir_mode *mode; /**< The mode of the register class. */
75 const arch_register_t *regs; /**< The array of registers. */
78 /** return the number of registers in this register class */
79 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
81 /** return the largest mode of this register class */
82 #define arch_register_class_mode(cls) ((cls)->mode)
85 * Put all registers in a class into a bitset.
86 * @param cls The class.
87 * @param bs The bitset. May be NULL.
88 * @return The number of registers in the class.
90 extern int arch_register_class_put(const arch_register_class_t *cls, bitset_t *bs);
92 static INLINE const arch_register_t *
93 _arch_register_for_index(const arch_register_class_t *cls, int idx)
95 assert(0 <= idx && idx < cls->n_regs);
96 return &cls->regs[idx];
99 #define arch_register_for_index(cls, idx) \
100 _arch_register_for_index(cls, idx)
102 typedef enum _arch_operand_type_t {
103 arch_operand_type_invalid,
104 arch_operand_type_memory,
105 arch_operand_type_register,
106 arch_operand_type_immediate,
107 arch_operand_type_symconst,
108 arch_operand_type_last
109 } arch_operand_type_t;
112 * Different types of register allocation requirements.
114 typedef enum _arch_register_req_type_t {
115 arch_register_req_type_none = 0, /**< No register requirement. */
117 arch_register_req_type_normal = 1, /**< All registers in the class
120 arch_register_req_type_limited = 2, /**< Only a real subset of
121 the class is allowed. */
123 arch_register_req_type_should_be_same = 4, /**< The register should be equal
124 another one at the node. */
126 arch_register_req_type_should_be_different = 8, /**< The register must be unequal
127 to some other at the node. */
129 arch_register_req_type_should_be_different_from_all = 16, /**< The register must be different from
130 all in's at the node */
131 } arch_register_req_type_t;
134 * Convenience macro to check for set constraints.
135 * @param req A pointer to register requirements.
136 * @param kind The kind of constraint to check for (see arch_register_req_type_t).
137 * @return 1, If the kind of constraint is present, 0 if not.
139 #define arch_register_req_is(req, kind) \
140 (((req)->type & (arch_register_req_type_ ## kind)) != 0)
143 * Expresses requirements to register allocation for an operand.
145 typedef struct _arch_register_req_t {
146 arch_register_req_type_t type; /**< The type of the constraint. */
147 const arch_register_class_t *cls; /**< The register class this constraint belongs to. */
149 void (*limited)(void *limited_env, bitset_t *bs);
150 /**< In case of the 'limited'
151 constraint, this function
152 must put all allowable
153 registers in the bitset and
154 return the number of registers
157 void *limited_env; /**< This must passed to limited. */
159 ir_node *other_same; /**< The other which shall have the same reg
160 as this one. (for case should_be_same). */
162 ir_node *other_different; /**< The other node from which this one's register
163 must be different (case must_be_different). */
164 } arch_register_req_t;
167 * Format a register requirements information into a string.
168 * @param buf The string where to put it to.
169 * @param len The size of @p buf.
170 * @param req The requirements structure to format.
171 * @return A pointer to buf.
173 extern char *arch_register_req_format(char *buf, size_t len, const arch_register_req_t *req);
177 * Certain node classes which are relevant for the register allocator.
179 typedef enum _arch_irn_class_t {
180 arch_irn_class_normal,
181 arch_irn_class_spill,
182 arch_irn_class_reload,
185 arch_irn_class_branch,
190 * Some flags describing a node in more detail.
192 typedef enum _arch_irn_flags_t {
193 arch_irn_flags_none = 0, /**< Node flags. */
194 arch_irn_flags_dont_spill = 1, /**< This must not be spilled. */
195 arch_irn_flags_rematerializable = 2, /**< This should be replicated instead of spilled/reloaded. */
196 arch_irn_flags_ignore = 4, /**< Ignore node during register allocation. */
197 arch_irn_flags_last = arch_irn_flags_ignore
201 * Get the string representation of a flag.
202 * This functions does not handle or'ed bitmasks of flags.
203 * @param flag The flag.
204 * @return The flag as a string.
206 extern const char *arch_irn_flag_str(arch_irn_flags_t flag);
208 struct _arch_irn_ops_if_t {
211 * Get the register requirements for a given operand.
212 * @param self The self pointer.
213 * @param irn The node.
214 * @param pos The operand's position
215 * (-1 for the result of the node, 0..n for the input
217 * @return The register requirements for the selected operand.
218 * The pointer returned is never NULL.
220 const arch_register_req_t *(*get_irn_reg_req)(const void *self,
221 arch_register_req_t *req, const ir_node *irn, int pos);
224 * Set the register for an output operand.
225 * @param irn The node.
226 * @param reg The register allocated to that operand.
227 * @note If the operand is not a register operand,
228 * the call is ignored.
230 void (*set_irn_reg)(const void *self, ir_node *irn, const arch_register_t *reg);
233 * Get the register allocated for an output operand.
234 * @param irn The node.
235 * @return The register allocated at that operand. NULL, if
236 * the operand was no register operand or
237 * @c arch_register_invalid, if no register has yet been
238 * allocated for this node.
240 const arch_register_t *(*get_irn_reg)(const void *self, const ir_node *irn);
244 * @param irn The node.
245 * @return A classification.
247 arch_irn_class_t (*classify)(const void *self, const ir_node *irn);
250 * Get the flags of a node.
251 * @param self The irn ops themselves.
252 * @param irn The node.
253 * @return A set of flags.
255 arch_irn_flags_t (*get_flags)(const void *self, const ir_node *irn);
258 * Get the entity on the stack frame this node depends on.
259 * @param self The this pointer.
260 * @param irn The node in question.
261 * @return The entity on the stack frame or NULL, if the node does not has a stack frame entity.
263 entity *(*get_frame_entity)(const void *self, const ir_node *irn);
266 * Set the offset of a node carrying an entity on the stack frame.
267 * @param self The this pointer.
268 * @param irn The node.
269 * @param offset The offset of the node's stack frame entity.
271 void (*set_frame_offset)(const void *self, ir_node *irn, int offset);
275 * irn_ops base class.
277 struct _arch_irn_ops_t {
278 const arch_irn_ops_if_t *impl;
281 extern void arch_set_frame_offset(const arch_env_t *env, ir_node *irn, int bias);
283 extern entity *arch_get_frame_entity(const arch_env_t *env, ir_node *irn);
286 * Get the register requirements for a node.
287 * @param env The architecture environment.
288 * @param req A pointer to a requirements structure, where the data can
290 * @param irn The node.
291 * @param pos The position of the operand you're interested in.
292 * @return A pointer to the register requirements which may <b>not</b>
293 * neccessarily be equal to @p req. If NULL is returned, the
294 * operand was no register operand.
296 extern const arch_register_req_t *
297 arch_get_register_req(const arch_env_t *env, arch_register_req_t *req,
298 const ir_node *irn, int pos);
301 * Check if an operand is a register operand.
302 * @param env The environment.
303 * @param irn The node.
304 * @param pos The position of the operand.
305 * @return 1, if the operand is significant for register allocation, 0
308 extern int arch_is_register_operand(const arch_env_t *env,
309 const ir_node *irn, int pos);
312 * Get the number of allocatable registers concerning
313 * a register class for an operand of a node.
314 * @param env The environment.
315 * @param irn The node.
316 * @param pos The postition of the node's operand.
317 * @param bs The bitset all allocatable registers shall be put into.
318 * Note, that you can also pass NULL here. If you don't,
319 * make sure, the bitset is as large as the register class
321 * @return The amount of registers allocatable for that operand.
323 extern int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn, int pos, bitset_t *bs);
326 * Put all registers which shall not be ignored by the register
327 * allocator in a bit set.
328 * @param env The arch env.
329 * @param cls The register class to consider.
330 * @param bs The bit set to put the registers to.
332 extern void arch_put_non_ignore_regs(const arch_env_t *env, const arch_register_class_t *cls, bitset_t *bs);
335 * Check, if a register is assignable to an operand of a node.
336 * @param env The architecture environment.
337 * @param irn The node.
338 * @param pos The position of the operand.
339 * @param reg The register.
340 * @return 1, if the register might be allocated to the operand 0 if not.
342 extern int arch_reg_is_allocatable(const arch_env_t *env,
343 const ir_node *irn, int pos, const arch_register_t *reg);
346 * Get the register class of an operand of a node.
347 * @param env The architecture environment.
348 * @param irn The node.
349 * @param pos The position of the operand, -1 for the output.
350 * @return The register class of the operand or NULL, if
351 * operand is a non-register operand.
353 extern const arch_register_class_t *
354 arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos);
357 * Get the register allocated at a certain output operand of a node.
358 * @param env The arch environment.
359 * @param irn The node.
360 * @return The register allocated for this operand
362 extern const arch_register_t *
363 arch_get_irn_register(const arch_env_t *env, const ir_node *irn);
366 * Set the register for a certain output operand.
367 * @param env The architecture environment.
368 * @param irn The node.
369 * @param idx The index of the output operand.
370 * @param reg The register.
372 extern void arch_set_irn_register(const arch_env_t *env, ir_node *irn,
373 const arch_register_t *reg);
377 * @param env The architecture environment.
378 * @param irn The node.
379 * @return A classification of the node.
381 extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn);
384 * Get the flags of a node.
385 * @param env The architecture environment.
386 * @param irn The node.
389 extern arch_irn_flags_t arch_irn_get_flags(const arch_env_t *env, const ir_node *irn);
391 #define arch_irn_is(env, irn, flag) ((arch_irn_get_flags(env, irn) & arch_irn_flags_ ## flag) != 0)
393 #define arch_irn_has_reg_class(env, irn, pos, cls) \
394 ((cls) == arch_get_irn_reg_class(env, irn, pos))
396 #define arch_irn_consider_in_reg_alloc(env, cls, irn) \
397 (arch_irn_has_reg_class(env, irn, -1, cls) && !arch_irn_is(env, irn, ignore))
400 * Somebody who can be asked about IR nodes.
402 struct _arch_irn_handler_t {
405 * Get the operations of an irn.
406 * @param self The handler from which the method is invoked.
407 * @param irn Some node.
408 * @return Operations for that irn.
410 const void *(*get_irn_ops)(const arch_irn_handler_t *handler,
415 * The code generator interface.
417 struct _arch_code_generator_if_t {
419 * Initialize the code generator.
420 * @param birg A backend IRG session.
421 * @return A newly created code generator.
423 void *(*init)(const be_irg_t *birg);
426 * Called before abi introduce.
428 void (*before_abi)(void *self);
431 * Called, when the graph is being normalized.
433 void (*prepare_graph)(void *self);
436 * Called before scheduling.
438 void (*before_sched)(void *self);
441 * Called before register allocation.
443 void (*before_ra)(void *self);
446 * Called after register allocation.
448 void (*after_ra)(void *self);
451 * Called after everything happened.
452 * The code generator must also be de-allocated here.
454 void (*done)(void *self);
458 * helper macro: call function func from the code generator
459 * if it's implemented.
461 #define _arch_cg_call(cg, func) \
463 if((cg)->impl->func) \
464 (cg)->impl->func(cg); \
467 #define arch_code_generator_before_abi(cg) _arch_cg_call(cg, before_abi)
468 #define arch_code_generator_prepare_graph(cg) _arch_cg_call(cg, prepare_graph)
469 #define arch_code_generator_before_sched(cg) _arch_cg_call(cg, before_sched)
470 #define arch_code_generator_before_ra(cg) _arch_cg_call(cg, before_ra)
471 #define arch_code_generator_after_ra(cg) _arch_cg_call(cg, after_ra)
472 #define arch_code_generator_done(cg) _arch_cg_call(cg, done)
475 * Code generator base class.
477 struct _arch_code_generator_t {
478 const arch_code_generator_if_t *impl;
485 const arch_isa_if_t *impl;
486 const arch_register_t *sp; /** The stack pointer register. */
487 const arch_register_t *bp; /** The base pointer register. */
488 const int stack_dir; /** -1 for decreasing, 1 for increasing. */
491 #define arch_isa_stack_dir(isa) ((isa)->stack_dir)
492 #define arch_isa_sp(isa) ((isa)->sp)
493 #define arch_isa_bp(isa) ((isa)->bp)
496 * Architecture interface.
498 struct _arch_isa_if_t {
501 * Initialize the isa interface.
502 * @param file_handle the file handle to write the output to
503 * @return a new isa instance
505 void *(*init)(FILE *file_handle);
508 * Free the isa instance.
510 void (*done)(void *self);
513 * Get the the number of register classes in the isa.
514 * @return The number of register classes.
516 int (*get_n_reg_class)(const void *self);
519 * Get the i-th register class.
520 * @param i The number of the register class.
521 * @return The register class.
523 const arch_register_class_t *(*get_reg_class)(const void *self, int i);
526 * Get the register class which shall be used to store a value of a given mode.
527 * @param self The this pointer.
528 * @param mode The mode in question.
529 * @return A register class which can hold values of the given mode.
531 const arch_register_class_t *(*get_reg_class_for_mode)(const void *self, const ir_mode *mode);
534 * Get the ABI restrictions for procedure calls.
535 * @param self The this pointer.
536 * @param method_type The type of the method (procedure) in question.
537 * @param p The array of parameter locations to be filled.
539 void (*get_call_abi)(const void *self, ir_type *method_type, be_abi_call_t *abi);
542 * The irn handler for this architecture.
543 * The irn handler is registered by the Firm back end
544 * when the architecture is initialized.
547 const arch_irn_handler_t *(*get_irn_handler)(const void *self);
550 * Get the code generator interface.
551 * @param self The this pointer.
552 * @return Some code generator interface.
554 const arch_code_generator_if_t *(*get_code_generator_if)(void *self);
557 * Get the list scheduler to use.
558 * @param self The isa object.
559 * @return The list scheduler selector.
561 const list_sched_selector_t *(*get_list_sched_selector)(const void *self);
564 * Get the necessary alignment for storing a register of given class.
565 * @param self The isa object.
566 * @param cls The register class.
567 * @return The alignment in bytes.
569 int (*get_reg_class_alignment)(const void *self, const arch_register_class_t *cls);
573 * Register command line options for this backend.
574 * @param grp The root group.
576 void (*register_options)(lc_opt_entry_t *grp);
580 #define arch_isa_get_n_reg_class(isa) ((isa)->impl->get_n_reg_class(isa))
581 #define arch_isa_get_reg_class(isa,i) ((isa)->impl->get_reg_class(isa, i))
582 #define arch_isa_get_irn_handler(isa) ((isa)->impl->get_irn_handler(isa))
583 #define arch_isa_get_call_abi(isa,tp,abi) ((isa)->impl->get_call_abi((isa), (tp), (abi)))
584 #define arch_isa_get_reg_class_for_mode(isa,mode) ((isa)->impl->get_reg_class_for_mode((isa), (mode)))
585 #define arch_isa_make_code_generator(isa,irg) ((isa)->impl->make_code_generator((isa), (irg)))
586 #define arch_isa_get_reg_class_alignment(isa, cls) ((isa)->impl->get_reg_class_alignment((isa), (cls)))
588 #define ARCH_MAX_HANDLERS 8
591 * Environment for the architecture infrastructure.
592 * Keep this everywhere you're going.
595 const struct _be_node_factory_t *node_factory; /**< The node factory for be nodes. */
596 arch_isa_t *isa; /**< The isa about which everything is. */
598 arch_irn_handler_t const *handlers[ARCH_MAX_HANDLERS]; /**< The handlers are organized as
601 int handlers_tos; /**< The stack pointer of the handler
606 * Get the isa of an arch environment.
607 * @param env The environment.
608 * @return The isa with which the env was initialized with.
610 #define arch_env_get_isa(env) ((env)->isa)
613 * Initialize the architecture environment struct.
614 * @param isa The isa which shall be put into the environment.
615 * @param file_handle The file handle
616 * @return The environment.
618 extern arch_env_t *arch_env_init(arch_env_t *env, const arch_isa_if_t *isa, FILE *file_handle);
621 * Add a node handler to the environment.
622 * @param env The environment.
623 * @param handler A node handler.
624 * @return The environment itself.
626 extern arch_env_t *arch_env_push_irn_handler(arch_env_t *env, const arch_irn_handler_t *handler);
629 * Remove a node handler from the handler stack.
630 * @param env The architecture environment.
631 * @return The popped handler.
633 extern const arch_irn_handler_t *arch_env_pop_irn_handler(arch_env_t *env);
635 #endif /* _FIRM_BEARCH_H */