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)
84 /** return the name of this register class */
85 #define arch_register_class_name(cls) ((cls)->name)
88 * Put all registers in a class into a bitset.
89 * @param cls The class.
90 * @param bs The bitset. May be NULL.
91 * @return The number of registers in the class.
93 extern int arch_register_class_put(const arch_register_class_t *cls, bitset_t *bs);
95 static INLINE const arch_register_t *
96 _arch_register_for_index(const arch_register_class_t *cls, int idx)
98 assert(0 <= idx && idx < cls->n_regs);
99 return &cls->regs[idx];
102 #define arch_register_for_index(cls, idx) \
103 _arch_register_for_index(cls, idx)
105 typedef enum _arch_operand_type_t {
106 arch_operand_type_invalid,
107 arch_operand_type_memory,
108 arch_operand_type_register,
109 arch_operand_type_immediate,
110 arch_operand_type_symconst,
111 arch_operand_type_last
112 } arch_operand_type_t;
115 * Different types of register allocation requirements.
117 typedef enum _arch_register_req_type_t {
118 arch_register_req_type_none = 0, /**< No register requirement. */
120 arch_register_req_type_normal = 1, /**< All registers in the class
123 arch_register_req_type_limited = 2, /**< Only a real subset of
124 the class is allowed. */
126 arch_register_req_type_should_be_same = 4, /**< The register should be equal
127 another one at the node. */
129 arch_register_req_type_should_be_different = 8, /**< The register must be unequal
130 to some other at the node. */
132 arch_register_req_type_should_be_different_from_all = 16, /**< The register must be different from
133 all in's at the node */
134 } arch_register_req_type_t;
137 * Convenience macro to check for set constraints.
138 * @param req A pointer to register requirements.
139 * @param kind The kind of constraint to check for (see arch_register_req_type_t).
140 * @return 1, If the kind of constraint is present, 0 if not.
142 #define arch_register_req_is(req, kind) \
143 (((req)->type & (arch_register_req_type_ ## kind)) != 0)
146 * Expresses requirements to register allocation for an operand.
148 typedef struct _arch_register_req_t {
149 arch_register_req_type_t type; /**< The type of the constraint. */
150 const arch_register_class_t *cls; /**< The register class this constraint belongs to. */
152 void (*limited)(void *limited_env, bitset_t *bs);
153 /**< In case of the 'limited'
154 constraint, this function
155 must put all allowable
156 registers in the bitset and
157 return the number of registers
160 void *limited_env; /**< This must passed to limited. */
162 ir_node *other_same; /**< The other which shall have the same reg
163 as this one. (for case should_be_same). */
165 ir_node *other_different; /**< The other node from which this one's register
166 must be different (case must_be_different). */
167 } arch_register_req_t;
170 * Format a register requirements information into a string.
171 * @param buf The string where to put it to.
172 * @param len The size of @p buf.
173 * @param req The requirements structure to format.
174 * @return A pointer to buf.
176 extern char *arch_register_req_format(char *buf, size_t len, const arch_register_req_t *req);
180 * Certain node classes which are relevant for the register allocator.
182 typedef enum _arch_irn_class_t {
183 arch_irn_class_normal = 1 << 0,
184 arch_irn_class_spill = 1 << 1,
185 arch_irn_class_reload = 1 << 2,
186 arch_irn_class_copy = 1 << 3,
187 arch_irn_class_perm = 1 << 4,
188 arch_irn_class_branch = 1 << 5,
189 arch_irn_class_call = 1 << 6,
190 arch_irn_class_const = 1 << 7,
191 arch_irn_class_load = 1 << 8,
192 arch_irn_class_store = 1 << 9,
193 arch_irn_class_stackparam = 1 << 10,
197 * An inverse operation returned by the backend
199 typedef struct _arch_inverse_t {
200 int n; /**< count of nodes returned in nodes array */
201 int costs; /**< costs of this remat */
203 /**< nodes for this inverse operation. shall be in
204 * schedule order. last element is the target value
210 * Some flags describing a node in more detail.
212 typedef enum _arch_irn_flags_t {
213 arch_irn_flags_none = 0, /**< Node flags. */
214 arch_irn_flags_dont_spill = 1, /**< This must not be spilled. */
215 arch_irn_flags_rematerializable = 2, /**< This can be replicated instead of spilled/reloaded. */
216 arch_irn_flags_ignore = 4, /**< Ignore node during register allocation. */
217 arch_irn_flags_modify_sp = 8, /**< I modify the stack pointer. */
218 arch_irn_flags_last = arch_irn_flags_modify_sp
222 * Get the string representation of a flag.
223 * This functions does not handle or'ed bitmasks of flags.
224 * @param flag The flag.
225 * @return The flag as a string.
227 extern const char *arch_irn_flag_str(arch_irn_flags_t flag);
229 struct _arch_irn_ops_if_t {
232 * Get the register requirements for a given operand.
233 * @param self The self pointer.
234 * @param irn The node.
235 * @param pos The operand's position
236 * (-1 for the result of the node, 0..n for the input
238 * @return The register requirements for the selected operand.
239 * The pointer returned is never NULL.
241 const arch_register_req_t *(*get_irn_reg_req)(const void *self,
242 arch_register_req_t *req, const ir_node *irn, int pos);
245 * Set the register for an output operand.
246 * @param irn The node.
247 * @param reg The register allocated to that operand.
248 * @note If the operand is not a register operand,
249 * the call is ignored.
251 void (*set_irn_reg)(const void *self, ir_node *irn, const arch_register_t *reg);
254 * Get the register allocated for an output operand.
255 * @param irn The node.
256 * @return The register allocated at that operand. NULL, if
257 * the operand was no register operand or
258 * @c arch_register_invalid, if no register has yet been
259 * allocated for this node.
261 const arch_register_t *(*get_irn_reg)(const void *self, const ir_node *irn);
265 * @param irn The node.
266 * @return A classification.
268 arch_irn_class_t (*classify)(const void *self, const ir_node *irn);
271 * Get the flags of a node.
272 * @param self The irn ops themselves.
273 * @param irn The node.
274 * @return A set of flags.
276 arch_irn_flags_t (*get_flags)(const void *self, const ir_node *irn);
279 * Get the entity on the stack frame this node depends on.
280 * @param self The this pointer.
281 * @param irn The node in question.
282 * @return The entity on the stack frame or NULL, if the node does not has a stack frame entity.
284 entity *(*get_frame_entity)(const void *self, const ir_node *irn);
287 * Set the entity on the stack frame this node depends on.
288 * @param self The this pointer.
289 * @param irn The node in question.
290 * @param ent The entity to set
292 void (*set_frame_entity)(const void *self, ir_node *irn, entity *ent);
295 * Set the offset of a node carrying an entity on the stack frame.
296 * @param self The this pointer.
297 * @param irn The node.
298 * @param offset The offset of the node's stack frame entity.
300 void (*set_frame_offset)(const void *self, ir_node *irn, int offset);
303 * Returns the delta of the stackpointer for nodes that increment or
304 * decrement the stackpointer with a constant value. (push, pop
305 * nodes on most architectures).
306 * A positive value stands for an expanding stack area, a negative value for
309 * @param self The this pointer
310 * @param irn The node
311 * @return 0 if the stackpointer is not modified with a constant
312 * value, otherwise the increment/decrement value
314 int (*get_sp_bias)(const void *self, const ir_node *irn);
317 * Returns an inverse operation which yields the i-th argument
318 * of the given node as result.
320 * @param self The this pointer.
321 * @param irn The original operation
322 * @param i Index of the argument we want the inverse operation to yield
323 * @param inverse struct to be filled with the resulting inverse op
324 * @param obstack The obstack to use for allocation of the returned nodes array
325 * @return The inverse operation or NULL if operation invertible
327 arch_inverse_t *(*get_inverse)(const void *self, const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack);
330 * Get the estimated cycle count for @p irn.
332 * @param self The this pointer.
333 * @param irn The node.
335 * @return The estimated cycle count for this operation
337 int (*get_op_estimated_cost)(const void *self, const ir_node *irn);
340 * Asks the backend whether operand @p i of @p irn can be loaded form memory internally
342 * @param self The this pointer.
343 * @param irn The node.
344 * @param i Index of the argument we would like to know whether @p irn can load it form memory internally
346 * @return nonzero if argument can be loaded or zero otherwise
348 int (*possible_memory_operand)(const void *self, const ir_node *irn, unsigned int i);
351 * Ask the backend to assimilate @p reload of operand @p i into @p irn.
353 * @param self The this pointer.
354 * @param irn The node.
355 * @param spill The spill.
356 * @param i The position of the reload.
358 void (*perform_memory_operand)(const void *self, ir_node *irn, ir_node *spill, unsigned int i);
362 * irn_ops base class.
364 struct _arch_irn_ops_t {
365 const arch_irn_ops_if_t *impl;
368 extern const arch_irn_ops_t *arch_get_irn_ops(const arch_env_t *env, const ir_node *irn);
370 extern void arch_set_frame_offset(const arch_env_t *env, ir_node *irn, int bias);
372 extern entity *arch_get_frame_entity(const arch_env_t *env, ir_node *irn);
373 extern void arch_set_frame_entity(const arch_env_t *env, ir_node *irn, entity *ent);
374 extern int arch_get_sp_bias(const arch_env_t *env, ir_node *irn);
376 extern int arch_get_op_estimated_cost(const arch_env_t *env, const ir_node *irn);
377 extern arch_inverse_t *arch_get_inverse(const arch_env_t *env, const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack);
378 extern int arch_possible_memory_operand(const arch_env_t *env, const ir_node *irn, unsigned int i);
379 extern void arch_perform_memory_operand(const arch_env_t *env, ir_node *irn, ir_node *spill, unsigned int i);
382 * Get the register requirements for a node.
383 * @param env The architecture environment.
384 * @param req A pointer to a requirements structure, where the data can
386 * @param irn The node.
387 * @param pos The position of the operand you're interested in.
388 * @return A pointer to the register requirements which may <b>not</b>
389 * neccessarily be equal to @p req. If NULL is returned, the
390 * operand was no register operand.
392 extern const arch_register_req_t *
393 arch_get_register_req(const arch_env_t *env, arch_register_req_t *req,
394 const ir_node *irn, int pos);
397 * Check if an operand is a register operand.
398 * @param env The environment.
399 * @param irn The node.
400 * @param pos The position of the operand.
401 * @return 1, if the operand is significant for register allocation, 0
404 extern int arch_is_register_operand(const arch_env_t *env,
405 const ir_node *irn, int pos);
408 * Get the number of allocatable registers concerning
409 * a register class for an operand of a node.
410 * @param env The environment.
411 * @param irn The node.
412 * @param pos The postition of the node's operand.
413 * @param bs The bitset all allocatable registers shall be put into.
414 * Note, that you can also pass NULL here. If you don't,
415 * make sure, the bitset is as large as the register class
417 * @return The amount of registers allocatable for that operand.
419 extern int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn, int pos, bitset_t *bs);
422 * Put all registers which shall not be ignored by the register
423 * allocator in a bit set.
424 * @param env The arch env.
425 * @param cls The register class to consider.
426 * @param bs The bit set to put the registers to.
428 extern void arch_put_non_ignore_regs(const arch_env_t *env, const arch_register_class_t *cls, bitset_t *bs);
431 * Check, if a register is assignable to an operand of a node.
432 * @param env The architecture environment.
433 * @param irn The node.
434 * @param pos The position of the operand.
435 * @param reg The register.
436 * @return 1, if the register might be allocated to the operand 0 if not.
438 extern int arch_reg_is_allocatable(const arch_env_t *env,
439 const ir_node *irn, int pos, const arch_register_t *reg);
442 * Get the register class of an operand of a node.
443 * @param env The architecture environment.
444 * @param irn The node.
445 * @param pos The position of the operand, -1 for the output.
446 * @return The register class of the operand or NULL, if
447 * operand is a non-register operand.
449 extern const arch_register_class_t *
450 arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos);
453 * Get the register allocated at a certain output operand of a node.
454 * @param env The arch environment.
455 * @param irn The node.
456 * @return The register allocated for this operand
458 extern const arch_register_t *
459 arch_get_irn_register(const arch_env_t *env, const ir_node *irn);
462 * Set the register for a certain output operand.
463 * @param env The architecture environment.
464 * @param irn The node.
465 * @param idx The index of the output operand.
466 * @param reg The register.
468 extern void arch_set_irn_register(const arch_env_t *env, ir_node *irn,
469 const arch_register_t *reg);
473 * @param env The architecture environment.
474 * @param irn The node.
475 * @return A classification of the node.
477 extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn);
479 #define arch_irn_class_is(env, irn, irn_class) ((arch_irn_classify(env, irn) & arch_irn_class_ ## irn_class) != 0)
482 * Get the flags of a node.
483 * @param env The architecture environment.
484 * @param irn The node.
487 extern arch_irn_flags_t arch_irn_get_flags(const arch_env_t *env, const ir_node *irn);
489 #define arch_irn_is(env, irn, flag) ((arch_irn_get_flags(env, irn) & arch_irn_flags_ ## flag) != 0)
491 #define arch_irn_has_reg_class(env, irn, pos, cls) \
492 ((cls) == arch_get_irn_reg_class(env, irn, pos))
494 #define arch_irn_consider_in_reg_alloc(env, cls, irn) \
495 (arch_irn_has_reg_class(env, irn, -1, cls) && !arch_irn_is(env, irn, ignore))
498 * Somebody who can be asked about IR nodes.
500 struct _arch_irn_handler_t {
503 * Get the operations of an irn.
504 * @param self The handler from which the method is invoked.
505 * @param irn Some node.
506 * @return Operations for that irn.
508 const void *(*get_irn_ops)(const arch_irn_handler_t *handler,
513 * The code generator interface.
515 struct _arch_code_generator_if_t {
517 * Initialize the code generator.
518 * @param birg A backend IRG session.
519 * @return A newly created code generator.
521 void *(*init)(const be_irg_t *birg);
524 * Called before abi introduce.
526 void (*before_abi)(void *self);
529 * Called, when the graph is being normalized.
531 void (*prepare_graph)(void *self);
534 * Called before scheduling.
536 void (*before_sched)(void *self);
539 * Called before register allocation.
541 void (*before_ra)(void *self);
544 * Called after register allocation.
546 void (*after_ra)(void *self);
549 * Called directly before done is called. This should be the last place
550 * where the irg is modified.
552 void (*finish)(void *self);
555 * Called after everything happened. This call should emit the final
556 * assembly code but avoid changing the irg.
557 * The code generator must also be de-allocated here.
559 void (*done)(void *self);
563 * helper macro: call function func from the code generator
564 * if it's implemented.
566 #define _arch_cg_call(cg, func) \
568 if((cg)->impl->func) \
569 (cg)->impl->func(cg); \
572 #define arch_code_generator_before_abi(cg) _arch_cg_call(cg, before_abi)
573 #define arch_code_generator_prepare_graph(cg) _arch_cg_call(cg, prepare_graph)
574 #define arch_code_generator_before_sched(cg) _arch_cg_call(cg, before_sched)
575 #define arch_code_generator_before_ra(cg) _arch_cg_call(cg, before_ra)
576 #define arch_code_generator_after_ra(cg) _arch_cg_call(cg, after_ra)
577 #define arch_code_generator_finish(cg) _arch_cg_call(cg, finish)
578 #define arch_code_generator_done(cg) _arch_cg_call(cg, done)
581 * Code generator base class.
583 struct _arch_code_generator_t {
584 const arch_code_generator_if_t *impl;
591 const arch_isa_if_t *impl;
592 const arch_register_t *sp; /** The stack pointer register. */
593 const arch_register_t *bp; /** The base pointer register. */
594 const int stack_dir; /** -1 for decreasing, 1 for increasing. */
595 const be_main_env_t *main_env; /** the be main environment */
598 #define arch_isa_stack_dir(isa) ((isa)->stack_dir)
599 #define arch_isa_sp(isa) ((isa)->sp)
600 #define arch_isa_bp(isa) ((isa)->bp)
603 * Architecture interface.
605 struct _arch_isa_if_t {
608 * Initialize the isa interface.
609 * @param file_handle the file handle to write the output to
610 * @param main_env the be main environment
611 * @return a new isa instance
613 void *(*init)(FILE *file_handle);
616 * Free the isa instance.
618 void (*done)(void *self);
621 * Get the the number of register classes in the isa.
622 * @return The number of register classes.
624 int (*get_n_reg_class)(const void *self);
627 * Get the i-th register class.
628 * @param i The number of the register class.
629 * @return The register class.
631 const arch_register_class_t *(*get_reg_class)(const void *self, int i);
634 * Get the register class which shall be used to store a value of a given mode.
635 * @param self The this pointer.
636 * @param mode The mode in question.
637 * @return A register class which can hold values of the given mode.
639 const arch_register_class_t *(*get_reg_class_for_mode)(const void *self, const ir_mode *mode);
642 * Get the ABI restrictions for procedure calls.
643 * @param self The this pointer.
644 * @param method_type The type of the method (procedure) in question.
645 * @param p The array of parameter locations to be filled.
647 void (*get_call_abi)(const void *self, ir_type *method_type, be_abi_call_t *abi);
650 * The irn handler for this architecture.
651 * The irn handler is registered by the Firm back end
652 * when the architecture is initialized.
655 const arch_irn_handler_t *(*get_irn_handler)(const void *self);
658 * Get the code generator interface.
659 * @param self The this pointer.
660 * @return Some code generator interface.
662 const arch_code_generator_if_t *(*get_code_generator_if)(void *self);
665 * Get the list scheduler to use. There is already a selector given, the
666 * backend is free to modify and/or ignore it.
668 * @param self The isa object.
669 * @param selector The selector given by options.
670 * @return The list scheduler selector.
672 const list_sched_selector_t *(*get_list_sched_selector)(const void *self, list_sched_selector_t *selector);
675 * Get the necessary alignment for storing a register of given class.
676 * @param self The isa object.
677 * @param cls The register class.
678 * @return The alignment in bytes.
680 int (*get_reg_class_alignment)(const void *self, const arch_register_class_t *cls);
683 * A "static" function, returns the frontend settings
684 * needed for this backend.
686 const backend_params *(*get_params)(void);
690 * Register command line options for this backend.
691 * @param grp The root group.
693 void (*register_options)(lc_opt_entry_t *grp);
697 #define arch_isa_get_n_reg_class(isa) ((isa)->impl->get_n_reg_class(isa))
698 #define arch_isa_get_reg_class(isa,i) ((isa)->impl->get_reg_class(isa, i))
699 #define arch_isa_get_irn_handler(isa) ((isa)->impl->get_irn_handler(isa))
700 #define arch_isa_get_call_abi(isa,tp,abi) ((isa)->impl->get_call_abi((isa), (tp), (abi)))
701 #define arch_isa_get_reg_class_for_mode(isa,mode) ((isa)->impl->get_reg_class_for_mode((isa), (mode)))
702 #define arch_isa_make_code_generator(isa,irg) ((isa)->impl->make_code_generator((isa), (irg)))
703 #define arch_isa_get_reg_class_alignment(isa, cls) ((isa)->impl->get_reg_class_alignment((isa), (cls)))
705 #define ARCH_MAX_HANDLERS 8
708 * Environment for the architecture infrastructure.
709 * Keep this everywhere you're going.
712 const struct _be_node_factory_t *node_factory; /**< The node factory for be nodes. */
713 arch_isa_t *isa; /**< The isa about which everything is. */
715 arch_irn_handler_t const *handlers[ARCH_MAX_HANDLERS]; /**< The handlers are organized as
718 int handlers_tos; /**< The stack pointer of the handler
723 * Get the isa of an arch environment.
724 * @param env The environment.
725 * @return The isa with which the env was initialized with.
727 #define arch_env_get_isa(env) ((env)->isa)
730 * Initialize the architecture environment struct.
731 * @param isa The isa which shall be put into the environment.
732 * @param file_handle The file handle
733 * @return The environment.
735 extern arch_env_t *arch_env_init(arch_env_t *env, const arch_isa_if_t *isa, FILE *file_handle, be_main_env_t *main_env);
738 * Add a node handler to the environment.
739 * @param env The environment.
740 * @param handler A node handler.
741 * @return The environment itself.
743 extern arch_env_t *arch_env_push_irn_handler(arch_env_t *env, const arch_irn_handler_t *handler);
746 * Remove a node handler from the handler stack.
747 * @param env The architecture environment.
748 * @return The popped handler.
750 extern const arch_irn_handler_t *arch_env_pop_irn_handler(arch_env_t *env);
752 #endif /* _FIRM_BEARCH_H */