4 #include "firm_config.h"
7 #include <libcore/lc_opts.h>
10 #include "firm_types.h"
14 #include "belistsched.h"
18 #include "bemachine.h"
20 struct _be_node_factory_t;
22 typedef enum _arch_register_type_t {
23 arch_register_type_none = 0,
24 arch_register_type_caller_save = 1, /**< The register must be saved by the caller
25 upon a function call. It thus can be overwritten
26 in the called function. */
27 arch_register_type_callee_save = 2, /**< The register must be saved by the caller
28 upon a function call. It thus can be overwritten
29 in the called function. */
30 arch_register_type_ignore = 4, /**< Do not consider this register when allocating. */
31 arch_register_type_joker = 8, /**< The emitter can choose an arbitrary register */
32 arch_register_type_virtual = 16, /**< This is just a virtual register */
33 } arch_register_type_t;
36 * Convenience macro to check for register type.
37 * @param req A pointer to register.
38 * @param kind The kind of type to check for (see arch_register_type_t).
39 * @return 1, If register is of given kind, 0 if not.
41 #define arch_register_type_is(reg, kind) \
42 (((reg)->type & arch_register_type_ ## kind) != 0)
47 struct _arch_register_t {
48 const char *name; /**< The name of the register. */
49 const arch_register_class_t *reg_class; /**< The class the register belongs to. */
50 int index; /**< The index of the register in the class. */
51 arch_register_type_t type; /**< The type of the register. */
52 void *data; /**< Custom data. */
55 static INLINE const arch_register_class_t *
56 _arch_register_get_class(const arch_register_t *reg)
58 return reg->reg_class;
61 static INLINE int _arch_register_get_index(const arch_register_t *reg)
66 static INLINE const char *_arch_register_get_name(const arch_register_t *reg)
71 #define arch_register_get_class(reg) _arch_register_get_class(reg)
72 #define arch_register_get_index(reg) _arch_register_get_index(reg)
73 #define arch_register_get_name(reg) _arch_register_get_name(reg)
76 * A class of registers.
77 * Like general purpose or floating point.
79 struct _arch_register_class_t {
80 const char *name; /**< The name of the register class. */
81 int n_regs; /**< Number of registers in this class. */
82 ir_mode *mode; /**< The mode of the register class. */
83 const arch_register_t *regs; /**< The array of registers. */
86 /** return the number of registers in this register class */
87 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
89 /** return the largest mode of this register class */
90 #define arch_register_class_mode(cls) ((cls)->mode)
92 /** return the name of this register class */
93 #define arch_register_class_name(cls) ((cls)->name)
96 * Put all registers in a class into a bitset.
97 * @param cls The class.
98 * @param bs The bitset. May be NULL.
99 * @return The number of registers in the class.
101 extern int arch_register_class_put(const arch_register_class_t *cls, bitset_t *bs);
103 static INLINE const arch_register_t *
104 _arch_register_for_index(const arch_register_class_t *cls, int idx)
106 assert(0 <= idx && idx < cls->n_regs);
107 return &cls->regs[idx];
110 #define arch_register_for_index(cls, idx) \
111 _arch_register_for_index(cls, idx)
113 typedef enum _arch_operand_type_t {
114 arch_operand_type_invalid,
115 arch_operand_type_memory,
116 arch_operand_type_register,
117 arch_operand_type_immediate,
118 arch_operand_type_symconst,
119 arch_operand_type_last
120 } arch_operand_type_t;
123 * Different types of register allocation requirements.
125 typedef enum _arch_register_req_type_t {
126 arch_register_req_type_none = 0, /**< No register requirement. */
128 arch_register_req_type_normal = 1, /**< All registers in the class
131 arch_register_req_type_limited = 2, /**< Only a real subset of
132 the class is allowed. */
134 arch_register_req_type_should_be_same = 4, /**< The register should be equal
135 another one at the node. */
137 arch_register_req_type_should_be_different = 8, /**< The register must be unequal
138 to some other at the node. */
140 arch_register_req_type_should_be_different_from_all = 16, /**< The register must be different from
141 all in's at the node */
142 } arch_register_req_type_t;
145 * Convenience macro to check for set constraints.
146 * @param req A pointer to register requirements.
147 * @param kind The kind of constraint to check for (see arch_register_req_type_t).
148 * @return 1, If the kind of constraint is present, 0 if not.
150 #define arch_register_req_is(req, kind) \
151 (((req)->type & (arch_register_req_type_ ## kind)) != 0)
154 * Expresses requirements to register allocation for an operand.
156 typedef struct _arch_register_req_t {
157 arch_register_req_type_t type; /**< The type of the constraint. */
158 const arch_register_class_t *cls; /**< The register class this constraint belongs to. */
160 void (*limited)(void *limited_env, bitset_t *bs);
161 /**< In case of the 'limited'
162 constraint, this function
163 must put all allowable
164 registers in the bitset and
165 return the number of registers
168 void *limited_env; /**< This must passed to limited. */
170 ir_node *other_same; /**< The other which shall have the same reg
171 as this one. (for case should_be_same). */
173 ir_node *other_different; /**< The other node from which this one's register
174 must be different (case must_be_different). */
175 } arch_register_req_t;
178 * Format a register requirements information into a string.
179 * @param buf The string where to put it to.
180 * @param len The size of @p buf.
181 * @param req The requirements structure to format.
182 * @return A pointer to buf.
184 extern char *arch_register_req_format(char *buf, size_t len, const arch_register_req_t *req);
188 * Certain node classes which are relevant for the register allocator.
190 typedef enum _arch_irn_class_t {
191 arch_irn_class_normal = 1 << 0,
192 arch_irn_class_spill = 1 << 1,
193 arch_irn_class_reload = 1 << 2,
194 arch_irn_class_copy = 1 << 3,
195 arch_irn_class_perm = 1 << 4,
196 arch_irn_class_branch = 1 << 5,
197 arch_irn_class_call = 1 << 6,
198 arch_irn_class_const = 1 << 7,
199 arch_irn_class_load = 1 << 8,
200 arch_irn_class_store = 1 << 9,
201 arch_irn_class_stackparam = 1 << 10,
205 * An inverse operation returned by the backend
207 typedef struct _arch_inverse_t {
208 int n; /**< count of nodes returned in nodes array */
209 int costs; /**< costs of this remat */
211 /**< nodes for this inverse operation. shall be in
212 * schedule order. last element is the target value
218 * Some flags describing a node in more detail.
220 typedef enum _arch_irn_flags_t {
221 arch_irn_flags_none = 0, /**< Node flags. */
222 arch_irn_flags_dont_spill = 1, /**< This must not be spilled. */
223 arch_irn_flags_rematerializable = 2, /**< This can be replicated instead of spilled/reloaded. */
224 arch_irn_flags_ignore = 4, /**< Ignore node during register allocation. */
225 arch_irn_flags_modify_sp = 8, /**< I modify the stack pointer. */
226 arch_irn_flags_last = arch_irn_flags_modify_sp
230 * Get the string representation of a flag.
231 * This functions does not handle or'ed bitmasks of flags.
232 * @param flag The flag.
233 * @return The flag as a string.
235 extern const char *arch_irn_flag_str(arch_irn_flags_t flag);
237 struct _arch_irn_ops_if_t {
240 * Get the register requirements for a given operand.
241 * @param self The self pointer.
242 * @param irn The node.
243 * @param pos The operand's position
244 * (-1 for the result of the node, 0..n for the input
246 * @return The register requirements for the selected operand.
247 * The pointer returned is never NULL.
249 const arch_register_req_t *(*get_irn_reg_req)(const void *self,
250 arch_register_req_t *req, const ir_node *irn, int pos);
253 * Set the register for an output operand.
254 * @param irn The node.
255 * @param reg The register allocated to that operand.
256 * @note If the operand is not a register operand,
257 * the call is ignored.
259 void (*set_irn_reg)(const void *self, ir_node *irn, const arch_register_t *reg);
262 * Get the register allocated for an output operand.
263 * @param irn The node.
264 * @return The register allocated at that operand. NULL, if
265 * the operand was no register operand or
266 * @c arch_register_invalid, if no register has yet been
267 * allocated for this node.
269 const arch_register_t *(*get_irn_reg)(const void *self, const ir_node *irn);
273 * @param irn The node.
274 * @return A classification.
276 arch_irn_class_t (*classify)(const void *self, const ir_node *irn);
279 * Get the flags of a node.
280 * @param self The irn ops themselves.
281 * @param irn The node.
282 * @return A set of flags.
284 arch_irn_flags_t (*get_flags)(const void *self, const ir_node *irn);
287 * Get the entity on the stack frame this node depends on.
288 * @param self The this pointer.
289 * @param irn The node in question.
290 * @return The entity on the stack frame or NULL, if the node does not has a stack frame entity.
292 entity *(*get_frame_entity)(const void *self, const ir_node *irn);
295 * Set the entity on the stack frame this node depends on.
296 * @param self The this pointer.
297 * @param irn The node in question.
298 * @param ent The entity to set
300 void (*set_frame_entity)(const void *self, ir_node *irn, entity *ent);
303 * Set the offset of a node carrying an entity on the stack frame.
304 * @param self The this pointer.
305 * @param irn The node.
306 * @param offset The offset of the node's stack frame entity.
308 void (*set_frame_offset)(const void *self, ir_node *irn, int offset);
311 * Returns the delta of the stackpointer for nodes that increment or
312 * decrement the stackpointer with a constant value. (push, pop
313 * nodes on most architectures).
314 * A positive value stands for an expanding stack area, a negative value for
317 * @param self The this pointer
318 * @param irn The node
319 * @return 0 if the stackpointer is not modified with a constant
320 * value, otherwise the increment/decrement value
322 int (*get_sp_bias)(const void *self, const ir_node *irn);
325 * Returns an inverse operation which yields the i-th argument
326 * of the given node as result.
328 * @param self The this pointer.
329 * @param irn The original operation
330 * @param i Index of the argument we want the inverse operation to yield
331 * @param inverse struct to be filled with the resulting inverse op
332 * @param obstack The obstack to use for allocation of the returned nodes array
333 * @return The inverse operation or NULL if operation invertible
335 arch_inverse_t *(*get_inverse)(const void *self, const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack);
338 * Get the estimated cycle count for @p irn.
340 * @param self The this pointer.
341 * @param irn The node.
343 * @return The estimated cycle count for this operation
345 int (*get_op_estimated_cost)(const void *self, const ir_node *irn);
348 * Asks the backend whether operand @p i of @p irn can be loaded form memory internally
350 * @param self The this pointer.
351 * @param irn The node.
352 * @param i Index of the argument we would like to know whether @p irn can load it form memory internally
354 * @return nonzero if argument can be loaded or zero otherwise
356 int (*possible_memory_operand)(const void *self, const ir_node *irn, unsigned int i);
359 * Ask the backend to assimilate @p reload of operand @p i into @p irn.
361 * @param self The this pointer.
362 * @param irn The node.
363 * @param spill The spill.
364 * @param i The position of the reload.
366 void (*perform_memory_operand)(const void *self, ir_node *irn, ir_node *spill, unsigned int i);
370 * irn_ops base class.
372 struct _arch_irn_ops_t {
373 const arch_irn_ops_if_t *impl;
376 extern const arch_irn_ops_t *arch_get_irn_ops(const arch_env_t *env, const ir_node *irn);
378 extern void arch_set_frame_offset(const arch_env_t *env, ir_node *irn, int bias);
380 extern entity *arch_get_frame_entity(const arch_env_t *env, ir_node *irn);
381 extern void arch_set_frame_entity(const arch_env_t *env, ir_node *irn, entity *ent);
382 extern int arch_get_sp_bias(const arch_env_t *env, ir_node *irn);
384 extern int arch_get_op_estimated_cost(const arch_env_t *env, const ir_node *irn);
385 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);
386 extern int arch_possible_memory_operand(const arch_env_t *env, const ir_node *irn, unsigned int i);
387 extern void arch_perform_memory_operand(const arch_env_t *env, ir_node *irn, ir_node *spill, unsigned int i);
390 * Get the register requirements for a node.
391 * @param env The architecture environment.
392 * @param req A pointer to a requirements structure, where the data can
394 * @param irn The node.
395 * @param pos The position of the operand you're interested in.
396 * @return A pointer to the register requirements which may <b>not</b>
397 * neccessarily be equal to @p req. If NULL is returned, the
398 * operand was no register operand.
400 extern const arch_register_req_t *
401 arch_get_register_req(const arch_env_t *env, arch_register_req_t *req,
402 const ir_node *irn, int pos);
405 * Check if an operand is a register operand.
406 * @param env The environment.
407 * @param irn The node.
408 * @param pos The position of the operand.
409 * @return 1, if the operand is significant for register allocation, 0
412 extern int arch_is_register_operand(const arch_env_t *env,
413 const ir_node *irn, int pos);
416 * Get the number of allocatable registers concerning
417 * a register class for an operand of a node.
418 * @param env The environment.
419 * @param irn The node.
420 * @param pos The postition of the node's operand.
421 * @param bs The bitset all allocatable registers shall be put into.
422 * Note, that you can also pass NULL here. If you don't,
423 * make sure, the bitset is as large as the register class
425 * @return The amount of registers allocatable for that operand.
427 extern int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn, int pos, bitset_t *bs);
430 * Put all registers which shall not be ignored by the register
431 * allocator in a bit set.
432 * @param env The arch env.
433 * @param cls The register class to consider.
434 * @param bs The bit set to put the registers to.
436 extern void arch_put_non_ignore_regs(const arch_env_t *env, const arch_register_class_t *cls, bitset_t *bs);
439 * Check, if a register is assignable to an operand of a node.
440 * @param env The architecture environment.
441 * @param irn The node.
442 * @param pos The position of the operand.
443 * @param reg The register.
444 * @return 1, if the register might be allocated to the operand 0 if not.
446 extern int arch_reg_is_allocatable(const arch_env_t *env,
447 const ir_node *irn, int pos, const arch_register_t *reg);
450 * Get the register class of an operand of a node.
451 * @param env The architecture environment.
452 * @param irn The node.
453 * @param pos The position of the operand, -1 for the output.
454 * @return The register class of the operand or NULL, if
455 * operand is a non-register operand.
457 extern const arch_register_class_t *
458 arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos);
461 * Get the register allocated at a certain output operand of a node.
462 * @param env The arch environment.
463 * @param irn The node.
464 * @return The register allocated for this operand
466 extern const arch_register_t *
467 arch_get_irn_register(const arch_env_t *env, const ir_node *irn);
470 * Set the register for a certain output operand.
471 * @param env The architecture environment.
472 * @param irn The node.
473 * @param idx The index of the output operand.
474 * @param reg The register.
476 extern void arch_set_irn_register(const arch_env_t *env, ir_node *irn,
477 const arch_register_t *reg);
481 * @param env The architecture environment.
482 * @param irn The node.
483 * @return A classification of the node.
485 extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn);
487 #define arch_irn_class_is(env, irn, irn_class) ((arch_irn_classify(env, irn) & arch_irn_class_ ## irn_class) != 0)
490 * Get the flags of a node.
491 * @param env The architecture environment.
492 * @param irn The node.
495 extern arch_irn_flags_t arch_irn_get_flags(const arch_env_t *env, const ir_node *irn);
497 #define arch_irn_is(env, irn, flag) ((arch_irn_get_flags(env, irn) & arch_irn_flags_ ## flag) != 0)
499 #define arch_irn_has_reg_class(env, irn, pos, cls) \
500 ((cls) == arch_get_irn_reg_class(env, irn, pos))
502 #define arch_irn_consider_in_reg_alloc(env, cls, irn) \
503 (arch_irn_has_reg_class(env, irn, -1, cls) && !arch_irn_is(env, irn, ignore))
506 * Somebody who can be asked about IR nodes.
508 struct _arch_irn_handler_t {
511 * Get the operations of an irn.
512 * @param self The handler from which the method is invoked.
513 * @param irn Some node.
514 * @return Operations for that irn.
516 const void *(*get_irn_ops)(const arch_irn_handler_t *handler,
521 * The code generator interface.
523 struct _arch_code_generator_if_t {
525 * Initialize the code generator.
526 * @param birg A backend IRG session.
527 * @return A newly created code generator.
529 void *(*init)(const be_irg_t *birg);
532 * Called before abi introduce.
534 void (*before_abi)(void *self);
537 * Called, when the graph is being normalized.
539 void (*prepare_graph)(void *self);
542 * Called before scheduling.
544 void (*before_sched)(void *self);
547 * Called before register allocation.
549 void (*before_ra)(void *self);
552 * Called after register allocation.
554 void (*after_ra)(void *self);
557 * Called directly before done is called. This should be the last place
558 * where the irg is modified.
560 void (*finish)(void *self);
563 * Called after everything happened. This call should emit the final
564 * assembly code but avoid changing the irg.
565 * The code generator must also be de-allocated here.
567 void (*done)(void *self);
571 * helper macro: call function func from the code generator
572 * if it's implemented.
574 #define _arch_cg_call(cg, func) \
576 if((cg)->impl->func) \
577 (cg)->impl->func(cg); \
580 #define arch_code_generator_before_abi(cg) _arch_cg_call(cg, before_abi)
581 #define arch_code_generator_prepare_graph(cg) _arch_cg_call(cg, prepare_graph)
582 #define arch_code_generator_before_sched(cg) _arch_cg_call(cg, before_sched)
583 #define arch_code_generator_before_ra(cg) _arch_cg_call(cg, before_ra)
584 #define arch_code_generator_after_ra(cg) _arch_cg_call(cg, after_ra)
585 #define arch_code_generator_finish(cg) _arch_cg_call(cg, finish)
586 #define arch_code_generator_done(cg) _arch_cg_call(cg, done)
589 * Code generator base class.
591 struct _arch_code_generator_t {
592 const arch_code_generator_if_t *impl;
599 const arch_isa_if_t *impl;
600 const arch_register_t *sp; /** The stack pointer register. */
601 const arch_register_t *bp; /** The base pointer register. */
602 const int stack_dir; /** -1 for decreasing, 1 for increasing. */
603 const be_main_env_t *main_env; /** the be main environment */
606 #define arch_isa_stack_dir(isa) ((isa)->stack_dir)
607 #define arch_isa_sp(isa) ((isa)->sp)
608 #define arch_isa_bp(isa) ((isa)->bp)
611 * Architecture interface.
613 struct _arch_isa_if_t {
616 * Initialize the isa interface.
617 * @param file_handle the file handle to write the output to
618 * @param main_env the be main environment
619 * @return a new isa instance
621 void *(*init)(FILE *file_handle);
624 * Free the isa instance.
626 void (*done)(void *self);
629 * Get the the number of register classes in the isa.
630 * @return The number of register classes.
632 int (*get_n_reg_class)(const void *self);
635 * Get the i-th register class.
636 * @param i The number of the register class.
637 * @return The register class.
639 const arch_register_class_t *(*get_reg_class)(const void *self, int i);
642 * Get the register class which shall be used to store a value of a given mode.
643 * @param self The this pointer.
644 * @param mode The mode in question.
645 * @return A register class which can hold values of the given mode.
647 const arch_register_class_t *(*get_reg_class_for_mode)(const void *self, const ir_mode *mode);
650 * Get the ABI restrictions for procedure calls.
651 * @param self The this pointer.
652 * @param method_type The type of the method (procedure) in question.
653 * @param p The array of parameter locations to be filled.
655 void (*get_call_abi)(const void *self, ir_type *method_type, be_abi_call_t *abi);
658 * The irn handler for this architecture.
659 * The irn handler is registered by the Firm back end
660 * when the architecture is initialized.
663 const arch_irn_handler_t *(*get_irn_handler)(const void *self);
666 * Get the code generator interface.
667 * @param self The this pointer.
668 * @return Some code generator interface.
670 const arch_code_generator_if_t *(*get_code_generator_if)(void *self);
673 * Get the list scheduler to use. There is already a selector given, the
674 * backend is free to modify and/or ignore it.
676 * @param self The isa object.
677 * @param selector The selector given by options.
678 * @return The list scheduler selector.
680 const list_sched_selector_t *(*get_list_sched_selector)(const void *self, list_sched_selector_t *selector);
683 * Get the necessary alignment for storing a register of given class.
684 * @param self The isa object.
685 * @param cls The register class.
686 * @return The alignment in bytes.
688 int (*get_reg_class_alignment)(const void *self, const arch_register_class_t *cls);
691 * A "static" function, returns the frontend settings
692 * needed for this backend.
694 const backend_params *(*get_params)(void);
697 * Returns an 2-dim array of execution units, this node can be executed on.
698 * The first dimension is the type, the second the allowed units of this type.
699 * Each dimension is a NULL terminated list.
700 * @param self The this pointer.
701 * @param irn The node
702 * @return An array of allowed execution units.
704 * { unit1_of_tp1, ..., unitX1_of_tp1, NULL },
706 * { unit1_of_tpY, ..., unitXn_of_tpY, NULL },
710 const be_execution_unit_t ***(*get_allowed_execution_units)(const void *self, const ir_node *irn);
713 * Return the abstract machine for this isa.
714 * @param self The this pointer.
716 const be_machine_t *(*get_machine)(const void *self);
720 * Register command line options for this backend.
721 * @param grp The root group.
723 void (*register_options)(lc_opt_entry_t *grp);
727 #define arch_isa_get_n_reg_class(isa) ((isa)->impl->get_n_reg_class(isa))
728 #define arch_isa_get_reg_class(isa,i) ((isa)->impl->get_reg_class(isa, i))
729 #define arch_isa_get_irn_handler(isa) ((isa)->impl->get_irn_handler(isa))
730 #define arch_isa_get_call_abi(isa,tp,abi) ((isa)->impl->get_call_abi((isa), (tp), (abi)))
731 #define arch_isa_get_reg_class_for_mode(isa,mode) ((isa)->impl->get_reg_class_for_mode((isa), (mode)))
732 #define arch_isa_make_code_generator(isa,irg) ((isa)->impl->make_code_generator((isa), (irg)))
733 #define arch_isa_get_reg_class_alignment(isa, cls) ((isa)->impl->get_reg_class_alignment((isa), (cls)))
734 #define arch_isa_get_allowed_execution_units(isa, irn) ((isa)->impl->get_allowed_execution_units((isa), (irn)))
735 #define arch_isa_get_machine(isa) ((isa)->impl->get_machine((isa)))
737 #define ARCH_MAX_HANDLERS 8
740 * Environment for the architecture infrastructure.
741 * Keep this everywhere you're going.
744 const struct _be_node_factory_t *node_factory; /**< The node factory for be nodes. */
745 arch_isa_t *isa; /**< The isa about which everything is. */
747 arch_irn_handler_t const *handlers[ARCH_MAX_HANDLERS]; /**< The handlers are organized as
750 int handlers_tos; /**< The stack pointer of the handler
755 * Get the isa of an arch environment.
756 * @param env The environment.
757 * @return The isa with which the env was initialized with.
759 #define arch_env_get_isa(env) ((env)->isa)
762 * Initialize the architecture environment struct.
763 * @param isa The isa which shall be put into the environment.
764 * @param file_handle The file handle
765 * @return The environment.
767 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);
770 * Add a node handler to the environment.
771 * @param env The environment.
772 * @param handler A node handler.
773 * @return The environment itself.
775 extern arch_env_t *arch_env_push_irn_handler(arch_env_t *env, const arch_irn_handler_t *handler);
778 * Remove a node handler from the handler stack.
779 * @param env The architecture environment.
780 * @return The popped handler.
782 extern const arch_irn_handler_t *arch_env_pop_irn_handler(arch_env_t *env);
784 #endif /* _FIRM_BEARCH_H */