4 #include "firm_config.h"
7 #include <libcore/lc_opts.h>
10 #include "firm_types.h"
14 #include "belistsched.h"
15 #include "beilpsched.h"
19 #include "bemachine.h"
21 struct _be_node_factory_t;
23 typedef enum _arch_register_type_t {
24 arch_register_type_none = 0,
25 arch_register_type_caller_save = 1, /**< The register must be saved by the caller
26 upon a function call. It thus can be overwritten
27 in the called function. */
28 arch_register_type_callee_save = 2, /**< The register must be saved by the caller
29 upon a function call. It thus can be overwritten
30 in the called function. */
31 arch_register_type_ignore = 4, /**< Do not consider this register when allocating. */
32 arch_register_type_joker = 8, /**< The emitter can choose an arbitrary register */
33 arch_register_type_virtual = 16, /**< This is just a virtual register */
34 } arch_register_type_t;
37 * Convenience macro to check for register type.
38 * @param req A pointer to register.
39 * @param kind The kind of type to check for (see arch_register_type_t).
40 * @return 1, If register is of given kind, 0 if not.
42 #define arch_register_type_is(reg, kind) \
43 (((reg)->type & arch_register_type_ ## kind) != 0)
48 struct _arch_register_t {
49 const char *name; /**< The name of the register. */
50 const arch_register_class_t *reg_class; /**< The class the register belongs to. */
51 int index; /**< The index of the register in the class. */
52 arch_register_type_t type; /**< The type of the register. */
53 void *data; /**< Custom data. */
56 static INLINE const arch_register_class_t *
57 _arch_register_get_class(const arch_register_t *reg)
59 return reg->reg_class;
62 static INLINE int _arch_register_get_index(const arch_register_t *reg)
67 static INLINE const char *_arch_register_get_name(const arch_register_t *reg)
72 #define arch_register_get_class(reg) _arch_register_get_class(reg)
73 #define arch_register_get_index(reg) _arch_register_get_index(reg)
74 #define arch_register_get_name(reg) _arch_register_get_name(reg)
77 * A class of registers.
78 * Like general purpose or floating point.
80 struct _arch_register_class_t {
81 const char *name; /**< The name of the register class. */
82 int n_regs; /**< Number of registers in this class. */
83 ir_mode *mode; /**< The mode of the register class. */
84 const arch_register_t *regs; /**< The array of registers. */
87 /** return the number of registers in this register class */
88 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
90 /** return the largest mode of this register class */
91 #define arch_register_class_mode(cls) ((cls)->mode)
93 /** return the name of this register class */
94 #define arch_register_class_name(cls) ((cls)->name)
97 * Put all registers in a class into a bitset.
98 * @param cls The class.
99 * @param bs The bitset. May be NULL.
100 * @return The number of registers in the class.
102 extern int arch_register_class_put(const arch_register_class_t *cls, bitset_t *bs);
104 static INLINE const arch_register_t *
105 _arch_register_for_index(const arch_register_class_t *cls, int idx)
107 assert(0 <= idx && idx < cls->n_regs);
108 return &cls->regs[idx];
111 #define arch_register_for_index(cls, idx) \
112 _arch_register_for_index(cls, idx)
114 typedef enum _arch_operand_type_t {
115 arch_operand_type_invalid,
116 arch_operand_type_memory,
117 arch_operand_type_register,
118 arch_operand_type_immediate,
119 arch_operand_type_symconst,
120 arch_operand_type_last
121 } arch_operand_type_t;
124 * Different types of register allocation requirements.
126 typedef enum _arch_register_req_type_t {
127 arch_register_req_type_none = 0, /**< No register requirement. */
129 arch_register_req_type_normal = 1, /**< All registers in the class
132 arch_register_req_type_limited = 2, /**< Only a real subset of
133 the class is allowed. */
135 arch_register_req_type_should_be_same = 4, /**< The register should be equal
136 another one at the node. */
138 arch_register_req_type_should_be_different = 8, /**< The register must be unequal
139 to some other at the node. */
141 arch_register_req_type_should_be_different_from_all = 16, /**< The register must be different from
142 all in's at the node */
143 } arch_register_req_type_t;
146 * Convenience macro to check for set constraints.
147 * @param req A pointer to register requirements.
148 * @param kind The kind of constraint to check for (see arch_register_req_type_t).
149 * @return 1, If the kind of constraint is present, 0 if not.
151 #define arch_register_req_is(req, kind) \
152 (((req)->type & (arch_register_req_type_ ## kind)) != 0)
155 * Expresses requirements to register allocation for an operand.
157 typedef struct _arch_register_req_t {
158 arch_register_req_type_t type; /**< The type of the constraint. */
159 const arch_register_class_t *cls; /**< The register class this constraint belongs to. */
161 void (*limited)(void *limited_env, bitset_t *bs);
162 /**< In case of the 'limited'
163 constraint, this function
164 must put all allowable
165 registers in the bitset and
166 return the number of registers
169 void *limited_env; /**< This must passed to limited. */
171 ir_node *other_same; /**< The other which shall have the same reg
172 as this one. (for case should_be_same). */
174 ir_node *other_different; /**< The other node from which this one's register
175 must be different (case must_be_different). */
176 } arch_register_req_t;
179 * Format a register requirements information into a string.
180 * @param buf The string where to put it to.
181 * @param len The size of @p buf.
182 * @param req The requirements structure to format.
183 * @return A pointer to buf.
185 extern char *arch_register_req_format(char *buf, size_t len, const arch_register_req_t *req);
189 * Certain node classes which are relevant for the register allocator.
191 typedef enum _arch_irn_class_t {
192 arch_irn_class_normal = 1 << 0,
193 arch_irn_class_spill = 1 << 1,
194 arch_irn_class_reload = 1 << 2,
195 arch_irn_class_copy = 1 << 3,
196 arch_irn_class_perm = 1 << 4,
197 arch_irn_class_branch = 1 << 5,
198 arch_irn_class_call = 1 << 6,
199 arch_irn_class_const = 1 << 7,
200 arch_irn_class_load = 1 << 8,
201 arch_irn_class_store = 1 << 9,
202 arch_irn_class_stackparam = 1 << 10,
206 * An inverse operation returned by the backend
208 typedef struct _arch_inverse_t {
209 int n; /**< count of nodes returned in nodes array */
210 int costs; /**< costs of this remat */
212 /**< nodes for this inverse operation. shall be in
213 * schedule order. last element is the target value
219 * Some flags describing a node in more detail.
221 typedef enum _arch_irn_flags_t {
222 arch_irn_flags_none = 0, /**< Node flags. */
223 arch_irn_flags_dont_spill = 1, /**< This must not be spilled. */
224 arch_irn_flags_rematerializable = 2, /**< This can be replicated instead of spilled/reloaded. */
225 arch_irn_flags_ignore = 4, /**< Ignore node during register allocation. */
226 arch_irn_flags_modify_sp = 8, /**< I modify the stack pointer. */
227 arch_irn_flags_last = arch_irn_flags_modify_sp
231 * Get the string representation of a flag.
232 * This functions does not handle or'ed bitmasks of flags.
233 * @param flag The flag.
234 * @return The flag as a string.
236 extern const char *arch_irn_flag_str(arch_irn_flags_t flag);
238 struct _arch_irn_ops_if_t {
241 * Get the register requirements for a given operand.
242 * @param self The self pointer.
243 * @param irn The node.
244 * @param pos The operand's position
245 * (-1 for the result of the node, 0..n for the input
247 * @return The register requirements for the selected operand.
248 * The pointer returned is never NULL.
250 const arch_register_req_t *(*get_irn_reg_req)(const void *self,
251 arch_register_req_t *req, const ir_node *irn, int pos);
254 * Set the register for an output operand.
255 * @param irn The node.
256 * @param reg The register allocated to that operand.
257 * @note If the operand is not a register operand,
258 * the call is ignored.
260 void (*set_irn_reg)(const void *self, ir_node *irn, const arch_register_t *reg);
263 * Get the register allocated for an output operand.
264 * @param irn The node.
265 * @return The register allocated at that operand. NULL, if
266 * the operand was no register operand or
267 * @c arch_register_invalid, if no register has yet been
268 * allocated for this node.
270 const arch_register_t *(*get_irn_reg)(const void *self, const ir_node *irn);
274 * @param irn The node.
275 * @return A classification.
277 arch_irn_class_t (*classify)(const void *self, const ir_node *irn);
280 * Get the flags of a node.
281 * @param self The irn ops themselves.
282 * @param irn The node.
283 * @return A set of flags.
285 arch_irn_flags_t (*get_flags)(const void *self, const ir_node *irn);
288 * Get the entity on the stack frame this node depends on.
289 * @param self The this pointer.
290 * @param irn The node in question.
291 * @return The entity on the stack frame or NULL, if the node does not has a stack frame entity.
293 entity *(*get_frame_entity)(const void *self, const ir_node *irn);
296 * Set the entity on the stack frame this node depends on.
297 * @param self The this pointer.
298 * @param irn The node in question.
299 * @param ent The entity to set
301 void (*set_frame_entity)(const void *self, ir_node *irn, entity *ent);
304 * Set the offset of a node carrying an entity on the stack frame.
305 * @param self The this pointer.
306 * @param irn The node.
307 * @param offset The offset of the node's stack frame entity.
309 void (*set_frame_offset)(const void *self, ir_node *irn, int offset);
312 * Returns the delta of the stackpointer for nodes that increment or
313 * decrement the stackpointer with a constant value. (push, pop
314 * nodes on most architectures).
315 * A positive value stands for an expanding stack area, a negative value for
318 * @param self The this pointer
319 * @param irn The node
320 * @return 0 if the stackpointer is not modified with a constant
321 * value, otherwise the increment/decrement value
323 int (*get_sp_bias)(const void *self, const ir_node *irn);
326 * Returns an inverse operation which yields the i-th argument
327 * of the given node as result.
329 * @param self The this pointer.
330 * @param irn The original operation
331 * @param i Index of the argument we want the inverse operation to yield
332 * @param inverse struct to be filled with the resulting inverse op
333 * @param obstack The obstack to use for allocation of the returned nodes array
334 * @return The inverse operation or NULL if operation invertible
336 arch_inverse_t *(*get_inverse)(const void *self, const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack);
339 * Get the estimated cycle count for @p irn.
341 * @param self The this pointer.
342 * @param irn The node.
344 * @return The estimated cycle count for this operation
346 int (*get_op_estimated_cost)(const void *self, const ir_node *irn);
349 * Asks the backend whether operand @p i of @p irn can be loaded form memory internally
351 * @param self The this pointer.
352 * @param irn The node.
353 * @param i Index of the argument we would like to know whether @p irn can load it form memory internally
355 * @return nonzero if argument can be loaded or zero otherwise
357 int (*possible_memory_operand)(const void *self, const ir_node *irn, unsigned int i);
360 * Ask the backend to assimilate @p reload of operand @p i into @p irn.
362 * @param self The this pointer.
363 * @param irn The node.
364 * @param spill The spill.
365 * @param i The position of the reload.
367 void (*perform_memory_operand)(const void *self, ir_node *irn, ir_node *spill, unsigned int i);
371 * irn_ops base class.
373 struct _arch_irn_ops_t {
374 const arch_irn_ops_if_t *impl;
377 extern const arch_irn_ops_t *arch_get_irn_ops(const arch_env_t *env, const ir_node *irn);
379 extern void arch_set_frame_offset(const arch_env_t *env, ir_node *irn, int bias);
381 extern entity *arch_get_frame_entity(const arch_env_t *env, ir_node *irn);
382 extern void arch_set_frame_entity(const arch_env_t *env, ir_node *irn, entity *ent);
383 extern int arch_get_sp_bias(const arch_env_t *env, ir_node *irn);
385 extern int arch_get_op_estimated_cost(const arch_env_t *env, const ir_node *irn);
386 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);
387 extern int arch_possible_memory_operand(const arch_env_t *env, const ir_node *irn, unsigned int i);
388 extern void arch_perform_memory_operand(const arch_env_t *env, ir_node *irn, ir_node *spill, unsigned int i);
391 * Get the register requirements for a node.
392 * @param env The architecture environment.
393 * @param req A pointer to a requirements structure, where the data can
395 * @param irn The node.
396 * @param pos The position of the operand you're interested in.
397 * @return A pointer to the register requirements which may <b>not</b>
398 * neccessarily be equal to @p req. If NULL is returned, the
399 * operand was no register operand.
401 extern const arch_register_req_t *
402 arch_get_register_req(const arch_env_t *env, arch_register_req_t *req,
403 const ir_node *irn, int pos);
406 * Check if an operand is a register operand.
407 * @param env The environment.
408 * @param irn The node.
409 * @param pos The position of the operand.
410 * @return 1, if the operand is significant for register allocation, 0
413 extern int arch_is_register_operand(const arch_env_t *env,
414 const ir_node *irn, int pos);
417 * Get the number of allocatable registers concerning
418 * a register class for an operand of a node.
419 * @param env The environment.
420 * @param irn The node.
421 * @param pos The postition of the node's operand.
422 * @param bs The bitset all allocatable registers shall be put into.
423 * Note, that you can also pass NULL here. If you don't,
424 * make sure, the bitset is as large as the register class
426 * @return The amount of registers allocatable for that operand.
428 extern int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn, int pos, bitset_t *bs);
431 * Put all registers which shall not be ignored by the register
432 * allocator in a bit set.
433 * @param env The arch env.
434 * @param cls The register class to consider.
435 * @param bs The bit set to put the registers to.
437 extern void arch_put_non_ignore_regs(const arch_env_t *env, const arch_register_class_t *cls, bitset_t *bs);
440 * Check, if a register is assignable to an operand of a node.
441 * @param env The architecture environment.
442 * @param irn The node.
443 * @param pos The position of the operand.
444 * @param reg The register.
445 * @return 1, if the register might be allocated to the operand 0 if not.
447 extern int arch_reg_is_allocatable(const arch_env_t *env,
448 const ir_node *irn, int pos, const arch_register_t *reg);
451 * Get the register class of an operand of a node.
452 * @param env The architecture environment.
453 * @param irn The node.
454 * @param pos The position of the operand, -1 for the output.
455 * @return The register class of the operand or NULL, if
456 * operand is a non-register operand.
458 extern const arch_register_class_t *
459 arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos);
462 * Get the register allocated at a certain output operand of a node.
463 * @param env The arch environment.
464 * @param irn The node.
465 * @return The register allocated for this operand
467 extern const arch_register_t *
468 arch_get_irn_register(const arch_env_t *env, const ir_node *irn);
471 * Set the register for a certain output operand.
472 * @param env The architecture environment.
473 * @param irn The node.
474 * @param idx The index of the output operand.
475 * @param reg The register.
477 extern void arch_set_irn_register(const arch_env_t *env, ir_node *irn,
478 const arch_register_t *reg);
482 * @param env The architecture environment.
483 * @param irn The node.
484 * @return A classification of the node.
486 extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn);
488 #define arch_irn_class_is(env, irn, irn_class) ((arch_irn_classify(env, irn) & arch_irn_class_ ## irn_class) != 0)
491 * Get the flags of a node.
492 * @param env The architecture environment.
493 * @param irn The node.
496 extern arch_irn_flags_t arch_irn_get_flags(const arch_env_t *env, const ir_node *irn);
498 #define arch_irn_is(env, irn, flag) ((arch_irn_get_flags(env, irn) & arch_irn_flags_ ## flag) != 0)
500 #define arch_irn_has_reg_class(env, irn, pos, cls) \
501 ((cls) == arch_get_irn_reg_class(env, irn, pos))
503 #define arch_irn_consider_in_reg_alloc(env, cls, irn) \
504 (arch_irn_has_reg_class(env, irn, -1, cls) && !arch_irn_is(env, irn, ignore))
507 * Somebody who can be asked about IR nodes.
509 struct _arch_irn_handler_t {
512 * Get the operations of an irn.
513 * @param self The handler from which the method is invoked.
514 * @param irn Some node.
515 * @return Operations for that irn.
517 const void *(*get_irn_ops)(const arch_irn_handler_t *handler,
522 * The code generator interface.
524 struct _arch_code_generator_if_t {
526 * Initialize the code generator.
527 * @param birg A backend IRG session.
528 * @return A newly created code generator.
530 void *(*init)(const be_irg_t *birg);
533 * Called before abi introduce.
535 void (*before_abi)(void *self);
538 * Called, when the graph is being normalized.
540 void (*prepare_graph)(void *self);
543 * Called before scheduling.
545 void (*before_sched)(void *self);
548 * Called before register allocation.
550 void (*before_ra)(void *self);
553 * Called after register allocation.
555 void (*after_ra)(void *self);
558 * Called directly before done is called. This should be the last place
559 * where the irg is modified.
561 void (*finish)(void *self);
564 * Called after everything happened. This call should emit the final
565 * assembly code but avoid changing the irg.
566 * The code generator must also be de-allocated here.
568 void (*done)(void *self);
572 * helper macro: call function func from the code generator
573 * if it's implemented.
575 #define _arch_cg_call(cg, func) \
577 if((cg)->impl->func) \
578 (cg)->impl->func(cg); \
581 #define arch_code_generator_before_abi(cg) _arch_cg_call(cg, before_abi)
582 #define arch_code_generator_prepare_graph(cg) _arch_cg_call(cg, prepare_graph)
583 #define arch_code_generator_before_sched(cg) _arch_cg_call(cg, before_sched)
584 #define arch_code_generator_before_ra(cg) _arch_cg_call(cg, before_ra)
585 #define arch_code_generator_after_ra(cg) _arch_cg_call(cg, after_ra)
586 #define arch_code_generator_finish(cg) _arch_cg_call(cg, finish)
587 #define arch_code_generator_done(cg) _arch_cg_call(cg, done)
590 * Code generator base class.
592 struct _arch_code_generator_t {
593 const arch_code_generator_if_t *impl;
600 const arch_isa_if_t *impl;
601 const arch_register_t *sp; /** The stack pointer register. */
602 const arch_register_t *bp; /** The base pointer register. */
603 const int stack_dir; /** -1 for decreasing, 1 for increasing. */
604 const be_main_env_t *main_env; /** the be main environment */
607 #define arch_isa_stack_dir(isa) ((isa)->stack_dir)
608 #define arch_isa_sp(isa) ((isa)->sp)
609 #define arch_isa_bp(isa) ((isa)->bp)
612 * Architecture interface.
614 struct _arch_isa_if_t {
617 * Initialize the isa interface.
618 * @param file_handle the file handle to write the output to
619 * @param main_env the be main environment
620 * @return a new isa instance
622 void *(*init)(FILE *file_handle);
625 * Free the isa instance.
627 void (*done)(void *self);
630 * Get the the number of register classes in the isa.
631 * @return The number of register classes.
633 int (*get_n_reg_class)(const void *self);
636 * Get the i-th register class.
637 * @param i The number of the register class.
638 * @return The register class.
640 const arch_register_class_t *(*get_reg_class)(const void *self, int i);
643 * Get the register class which shall be used to store a value of a given mode.
644 * @param self The this pointer.
645 * @param mode The mode in question.
646 * @return A register class which can hold values of the given mode.
648 const arch_register_class_t *(*get_reg_class_for_mode)(const void *self, const ir_mode *mode);
651 * Get the ABI restrictions for procedure calls.
652 * @param self The this pointer.
653 * @param method_type The type of the method (procedure) in question.
654 * @param p The array of parameter locations to be filled.
656 void (*get_call_abi)(const void *self, ir_type *method_type, be_abi_call_t *abi);
659 * The irn handler for this architecture.
660 * The irn handler is registered by the Firm back end
661 * when the architecture is initialized.
664 const arch_irn_handler_t *(*get_irn_handler)(const void *self);
667 * Get the code generator interface.
668 * @param self The this pointer.
669 * @return Some code generator interface.
671 const arch_code_generator_if_t *(*get_code_generator_if)(void *self);
674 * Get the list scheduler to use. There is already a selector given, the
675 * backend is free to modify and/or ignore it.
677 * @param self The isa object.
678 * @param selector The selector given by options.
679 * @return The list scheduler selector.
681 const list_sched_selector_t *(*get_list_sched_selector)(const void *self, list_sched_selector_t *selector);
684 * Get the ILP scheduler to use.
685 * @param self The isa object.
686 * @return The ILP scheduler selector
688 const ilp_sched_selector_t *(*get_ilp_sched_selector)(const void *self);
691 * Get the necessary alignment for storing a register of given class.
692 * @param self The isa object.
693 * @param cls The register class.
694 * @return The alignment in bytes.
696 int (*get_reg_class_alignment)(const void *self, const arch_register_class_t *cls);
699 * A "static" function, returns the frontend settings
700 * needed for this backend.
702 const backend_params *(*get_params)(void);
705 * Returns an 2-dim array of execution units, @p irn can be executed on.
706 * The first dimension is the type, the second the allowed units of this type.
707 * Each dimension is a NULL terminated list.
708 * @param self The isa object.
709 * @param irn The node.
710 * @return An array of allowed execution units.
712 * { unit1_of_tp1, ..., unitX1_of_tp1, NULL },
714 * { unit1_of_tpY, ..., unitXn_of_tpY, NULL },
718 const be_execution_unit_t ***(*get_allowed_execution_units)(const void *self, const ir_node *irn);
721 * Return the abstract machine for this isa.
722 * @param self The isa object.
724 const be_machine_t *(*get_machine)(const void *self);
728 * Register command line options for this backend.
729 * @param grp The root group.
731 void (*register_options)(lc_opt_entry_t *grp);
735 #define arch_isa_get_n_reg_class(isa) ((isa)->impl->get_n_reg_class(isa))
736 #define arch_isa_get_reg_class(isa,i) ((isa)->impl->get_reg_class(isa, i))
737 #define arch_isa_get_irn_handler(isa) ((isa)->impl->get_irn_handler(isa))
738 #define arch_isa_get_call_abi(isa,tp,abi) ((isa)->impl->get_call_abi((isa), (tp), (abi)))
739 #define arch_isa_get_reg_class_for_mode(isa,mode) ((isa)->impl->get_reg_class_for_mode((isa), (mode)))
740 #define arch_isa_make_code_generator(isa,irg) ((isa)->impl->make_code_generator((isa), (irg)))
741 #define arch_isa_get_reg_class_alignment(isa, cls) ((isa)->impl->get_reg_class_alignment((isa), (cls)))
742 #define arch_isa_get_allowed_execution_units(isa, irn) ((isa)->impl->get_allowed_execution_units((isa), (irn)))
743 #define arch_isa_get_machine(isa) ((isa)->impl->get_machine((isa)))
745 #define ARCH_MAX_HANDLERS 8
748 * Environment for the architecture infrastructure.
749 * Keep this everywhere you're going.
752 const struct _be_node_factory_t *node_factory; /**< The node factory for be nodes. */
753 arch_isa_t *isa; /**< The isa about which everything is. */
755 arch_irn_handler_t const *handlers[ARCH_MAX_HANDLERS]; /**< The handlers are organized as
758 int handlers_tos; /**< The stack pointer of the handler
763 * Get the isa of an arch environment.
764 * @param env The environment.
765 * @return The isa with which the env was initialized with.
767 #define arch_env_get_isa(env) ((env)->isa)
770 * Initialize the architecture environment struct.
771 * @param isa The isa which shall be put into the environment.
772 * @param file_handle The file handle
773 * @return The environment.
775 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);
778 * Add a node handler to the environment.
779 * @param env The environment.
780 * @param handler A node handler.
781 * @return The environment itself.
783 extern arch_env_t *arch_env_push_irn_handler(arch_env_t *env, const arch_irn_handler_t *handler);
786 * Remove a node handler from the handler stack.
787 * @param env The architecture environment.
788 * @return The popped handler.
790 extern const arch_irn_handler_t *arch_env_pop_irn_handler(arch_env_t *env);
792 #endif /* _FIRM_BEARCH_H */