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 = 1 << 0,
181 arch_irn_class_spill = 1 << 1,
182 arch_irn_class_reload = 1 << 2,
183 arch_irn_class_copy = 1 << 3,
184 arch_irn_class_perm = 1 << 4,
185 arch_irn_class_branch = 1 << 5,
186 arch_irn_class_call = 1 << 6,
187 arch_irn_class_const = 1 << 7,
188 arch_irn_class_load = 1 << 8,
189 arch_irn_class_store = 1 << 9,
190 arch_irn_class_stackparam = 1 << 10,
194 * An inverse operation returned by the backend
196 typedef struct _arch_inverse_t {
197 int n; /**< count of nodes returned in nodes array */
198 int costs; /**< costs of this remat */
200 /**< nodes for this inverse operation. shall be in
201 * schedule order. last element is the target value
207 * Some flags describing a node in more detail.
209 typedef enum _arch_irn_flags_t {
210 arch_irn_flags_none = 0, /**< Node flags. */
211 arch_irn_flags_dont_spill = 1, /**< This must not be spilled. */
212 arch_irn_flags_rematerializable = 2, /**< This can be replicated instead of spilled/reloaded. */
213 arch_irn_flags_ignore = 4, /**< Ignore node during register allocation. */
214 arch_irn_flags_modify_sp = 8, /**< I modify the stack pointer. */
215 arch_irn_flags_last = arch_irn_flags_modify_sp
219 * Get the string representation of a flag.
220 * This functions does not handle or'ed bitmasks of flags.
221 * @param flag The flag.
222 * @return The flag as a string.
224 extern const char *arch_irn_flag_str(arch_irn_flags_t flag);
226 struct _arch_irn_ops_if_t {
229 * Get the register requirements for a given operand.
230 * @param self The self pointer.
231 * @param irn The node.
232 * @param pos The operand's position
233 * (-1 for the result of the node, 0..n for the input
235 * @return The register requirements for the selected operand.
236 * The pointer returned is never NULL.
238 const arch_register_req_t *(*get_irn_reg_req)(const void *self,
239 arch_register_req_t *req, const ir_node *irn, int pos);
242 * Set the register for an output operand.
243 * @param irn The node.
244 * @param reg The register allocated to that operand.
245 * @note If the operand is not a register operand,
246 * the call is ignored.
248 void (*set_irn_reg)(const void *self, ir_node *irn, const arch_register_t *reg);
251 * Get the register allocated for an output operand.
252 * @param irn The node.
253 * @return The register allocated at that operand. NULL, if
254 * the operand was no register operand or
255 * @c arch_register_invalid, if no register has yet been
256 * allocated for this node.
258 const arch_register_t *(*get_irn_reg)(const void *self, const ir_node *irn);
262 * @param irn The node.
263 * @return A classification.
265 arch_irn_class_t (*classify)(const void *self, const ir_node *irn);
268 * Get the flags of a node.
269 * @param self The irn ops themselves.
270 * @param irn The node.
271 * @return A set of flags.
273 arch_irn_flags_t (*get_flags)(const void *self, const ir_node *irn);
276 * Get the entity on the stack frame this node depends on.
277 * @param self The this pointer.
278 * @param irn The node in question.
279 * @return The entity on the stack frame or NULL, if the node does not has a stack frame entity.
281 entity *(*get_frame_entity)(const void *self, const ir_node *irn);
284 * Set the entity on the stack frame this node depends on.
285 * @param self The this pointer.
286 * @param irn The node in question.
287 * @param ent The entity to set
289 void (*set_frame_entity)(const void *self, ir_node *irn, entity *ent);
292 * Set the offset of a node carrying an entity on the stack frame.
293 * @param self The this pointer.
294 * @param irn The node.
295 * @param offset The offset of the node's stack frame entity.
297 void (*set_frame_offset)(const void *self, ir_node *irn, int offset);
300 * Returns the delta of the stackpointer for nodes that increment or
301 * decrement the stackpointer with a constant value. (push, pop
302 * nodes on most architectures).
303 * A positive value stands for an expanding stack area, a negative value for
306 * @param self The this pointer
307 * @param irn The node
308 * @return 0 if the stackpointer is not modified with a constant
309 * value, otherwise the increment/decrement value
311 int (*get_sp_bias)(const void *self, const ir_node *irn);
314 * Returns an inverse operation which yields the i-th argument
315 * of the given node as result.
317 * @param self The this pointer.
318 * @param irn The original operation
319 * @param i Index of the argument we want the inverse operation to yield
320 * @param inverse struct to be filled with the resulting inverse op
321 * @param obstack The obstack to use for allocation of the returned nodes array
322 * @return The inverse operation or NULL if operation invertible
324 arch_inverse_t *(*get_inverse)(const void *self, const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack);
327 * Get the estimated cycle count for @p irn.
329 * @param self The this pointer.
330 * @param irn The node.
332 * @return The estimated cycle count for this operation
334 int (*get_op_estimated_cost)(const void *self, const ir_node *irn);
337 * Asks the backend whether operand @p i of @p irn can be loaded form memory internally
339 * @param self The this pointer.
340 * @param irn The node.
341 * @param i Index of the argument we would like to know whether @p irn can load it form memory internally
343 * @return nonzero if argument can be loaded or zero otherwise
345 int (*possible_memory_operand)(const void *self, const ir_node *irn, unsigned int i);
348 * Ask the backend to assimilate @p reload of operand @p i into @p irn.
350 * @param self The this pointer.
351 * @param irn The node.
352 * @param spill The spill.
353 * @param i The position of the reload.
355 void (*perform_memory_operand)(const void *self, ir_node *irn, ir_node *spill, unsigned int i);
359 * irn_ops base class.
361 struct _arch_irn_ops_t {
362 const arch_irn_ops_if_t *impl;
365 extern const arch_irn_ops_t *arch_get_irn_ops(const arch_env_t *env, const ir_node *irn);
367 extern void arch_set_frame_offset(const arch_env_t *env, ir_node *irn, int bias);
369 extern entity *arch_get_frame_entity(const arch_env_t *env, ir_node *irn);
370 extern void arch_set_frame_entity(const arch_env_t *env, ir_node *irn, entity *ent);
371 extern int arch_get_sp_bias(const arch_env_t *env, ir_node *irn);
373 extern int arch_get_op_estimated_cost(const arch_env_t *env, const ir_node *irn);
374 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);
375 extern int arch_possible_memory_operand(const arch_env_t *env, const ir_node *irn, unsigned int i);
376 extern void arch_perform_memory_operand(const arch_env_t *env, ir_node *irn, ir_node *spill, unsigned int i);
379 * Get the register requirements for a node.
380 * @param env The architecture environment.
381 * @param req A pointer to a requirements structure, where the data can
383 * @param irn The node.
384 * @param pos The position of the operand you're interested in.
385 * @return A pointer to the register requirements which may <b>not</b>
386 * neccessarily be equal to @p req. If NULL is returned, the
387 * operand was no register operand.
389 extern const arch_register_req_t *
390 arch_get_register_req(const arch_env_t *env, arch_register_req_t *req,
391 const ir_node *irn, int pos);
394 * Check if an operand is a register operand.
395 * @param env The environment.
396 * @param irn The node.
397 * @param pos The position of the operand.
398 * @return 1, if the operand is significant for register allocation, 0
401 extern int arch_is_register_operand(const arch_env_t *env,
402 const ir_node *irn, int pos);
405 * Get the number of allocatable registers concerning
406 * a register class for an operand of a node.
407 * @param env The environment.
408 * @param irn The node.
409 * @param pos The postition of the node's operand.
410 * @param bs The bitset all allocatable registers shall be put into.
411 * Note, that you can also pass NULL here. If you don't,
412 * make sure, the bitset is as large as the register class
414 * @return The amount of registers allocatable for that operand.
416 extern int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn, int pos, bitset_t *bs);
419 * Put all registers which shall not be ignored by the register
420 * allocator in a bit set.
421 * @param env The arch env.
422 * @param cls The register class to consider.
423 * @param bs The bit set to put the registers to.
425 extern void arch_put_non_ignore_regs(const arch_env_t *env, const arch_register_class_t *cls, bitset_t *bs);
428 * Check, if a register is assignable to an operand of a node.
429 * @param env The architecture environment.
430 * @param irn The node.
431 * @param pos The position of the operand.
432 * @param reg The register.
433 * @return 1, if the register might be allocated to the operand 0 if not.
435 extern int arch_reg_is_allocatable(const arch_env_t *env,
436 const ir_node *irn, int pos, const arch_register_t *reg);
439 * Get the register class of an operand of a node.
440 * @param env The architecture environment.
441 * @param irn The node.
442 * @param pos The position of the operand, -1 for the output.
443 * @return The register class of the operand or NULL, if
444 * operand is a non-register operand.
446 extern const arch_register_class_t *
447 arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos);
450 * Get the register allocated at a certain output operand of a node.
451 * @param env The arch environment.
452 * @param irn The node.
453 * @return The register allocated for this operand
455 extern const arch_register_t *
456 arch_get_irn_register(const arch_env_t *env, const ir_node *irn);
459 * Set the register for a certain output operand.
460 * @param env The architecture environment.
461 * @param irn The node.
462 * @param idx The index of the output operand.
463 * @param reg The register.
465 extern void arch_set_irn_register(const arch_env_t *env, ir_node *irn,
466 const arch_register_t *reg);
470 * @param env The architecture environment.
471 * @param irn The node.
472 * @return A classification of the node.
474 extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn);
476 #define arch_irn_class_is(env, irn, irn_class) ((arch_irn_classify(env, irn) & arch_irn_class_ ## irn_class) != 0)
479 * Get the flags of a node.
480 * @param env The architecture environment.
481 * @param irn The node.
484 extern arch_irn_flags_t arch_irn_get_flags(const arch_env_t *env, const ir_node *irn);
486 #define arch_irn_is(env, irn, flag) ((arch_irn_get_flags(env, irn) & arch_irn_flags_ ## flag) != 0)
488 #define arch_irn_has_reg_class(env, irn, pos, cls) \
489 ((cls) == arch_get_irn_reg_class(env, irn, pos))
491 #define arch_irn_consider_in_reg_alloc(env, cls, irn) \
492 (arch_irn_has_reg_class(env, irn, -1, cls) && !arch_irn_is(env, irn, ignore))
495 * Somebody who can be asked about IR nodes.
497 struct _arch_irn_handler_t {
500 * Get the operations of an irn.
501 * @param self The handler from which the method is invoked.
502 * @param irn Some node.
503 * @return Operations for that irn.
505 const void *(*get_irn_ops)(const arch_irn_handler_t *handler,
510 * The code generator interface.
512 struct _arch_code_generator_if_t {
514 * Initialize the code generator.
515 * @param birg A backend IRG session.
516 * @return A newly created code generator.
518 void *(*init)(const be_irg_t *birg);
521 * Called before abi introduce.
523 void (*before_abi)(void *self);
526 * Called, when the graph is being normalized.
528 void (*prepare_graph)(void *self);
531 * Called before scheduling.
533 void (*before_sched)(void *self);
536 * Called before register allocation.
538 void (*before_ra)(void *self);
541 * Called after register allocation.
543 void (*after_ra)(void *self);
546 * Called directly before done is called. This should be the last place
547 * where the irg is modified.
549 void (*finish)(void *self);
552 * Called after everything happened. This call should emit the final
553 * assembly code but avoid changing the irg.
554 * The code generator must also be de-allocated here.
556 void (*done)(void *self);
560 * helper macro: call function func from the code generator
561 * if it's implemented.
563 #define _arch_cg_call(cg, func) \
565 if((cg)->impl->func) \
566 (cg)->impl->func(cg); \
569 #define arch_code_generator_before_abi(cg) _arch_cg_call(cg, before_abi)
570 #define arch_code_generator_prepare_graph(cg) _arch_cg_call(cg, prepare_graph)
571 #define arch_code_generator_before_sched(cg) _arch_cg_call(cg, before_sched)
572 #define arch_code_generator_before_ra(cg) _arch_cg_call(cg, before_ra)
573 #define arch_code_generator_after_ra(cg) _arch_cg_call(cg, after_ra)
574 #define arch_code_generator_finish(cg) _arch_cg_call(cg, finish)
575 #define arch_code_generator_done(cg) _arch_cg_call(cg, done)
578 * Code generator base class.
580 struct _arch_code_generator_t {
581 const arch_code_generator_if_t *impl;
588 const arch_isa_if_t *impl;
589 const arch_register_t *sp; /** The stack pointer register. */
590 const arch_register_t *bp; /** The base pointer register. */
591 const int stack_dir; /** -1 for decreasing, 1 for increasing. */
592 const be_main_env_t *main_env; /** the be main environment */
595 #define arch_isa_stack_dir(isa) ((isa)->stack_dir)
596 #define arch_isa_sp(isa) ((isa)->sp)
597 #define arch_isa_bp(isa) ((isa)->bp)
600 * Architecture interface.
602 struct _arch_isa_if_t {
605 * Initialize the isa interface.
606 * @param file_handle the file handle to write the output to
607 * @param main_env the be main environment
608 * @return a new isa instance
610 void *(*init)(FILE *file_handle);
613 * Free the isa instance.
615 void (*done)(void *self);
618 * Get the the number of register classes in the isa.
619 * @return The number of register classes.
621 int (*get_n_reg_class)(const void *self);
624 * Get the i-th register class.
625 * @param i The number of the register class.
626 * @return The register class.
628 const arch_register_class_t *(*get_reg_class)(const void *self, int i);
631 * Get the register class which shall be used to store a value of a given mode.
632 * @param self The this pointer.
633 * @param mode The mode in question.
634 * @return A register class which can hold values of the given mode.
636 const arch_register_class_t *(*get_reg_class_for_mode)(const void *self, const ir_mode *mode);
639 * Get the ABI restrictions for procedure calls.
640 * @param self The this pointer.
641 * @param method_type The type of the method (procedure) in question.
642 * @param p The array of parameter locations to be filled.
644 void (*get_call_abi)(const void *self, ir_type *method_type, be_abi_call_t *abi);
647 * The irn handler for this architecture.
648 * The irn handler is registered by the Firm back end
649 * when the architecture is initialized.
652 const arch_irn_handler_t *(*get_irn_handler)(const void *self);
655 * Get the code generator interface.
656 * @param self The this pointer.
657 * @return Some code generator interface.
659 const arch_code_generator_if_t *(*get_code_generator_if)(void *self);
662 * Get the list scheduler to use. There is already a selector given, the
663 * backend is free to modify and/or ignore it.
665 * @param self The isa object.
666 * @param selector The selector given by options.
667 * @return The list scheduler selector.
669 const list_sched_selector_t *(*get_list_sched_selector)(const void *self, list_sched_selector_t *selector);
672 * Get the necessary alignment for storing a register of given class.
673 * @param self The isa object.
674 * @param cls The register class.
675 * @return The alignment in bytes.
677 int (*get_reg_class_alignment)(const void *self, const arch_register_class_t *cls);
680 * A "static" function, returns the frontend settings
681 * needed for this backend.
683 const backend_params *(*get_params)(void);
687 * Register command line options for this backend.
688 * @param grp The root group.
690 void (*register_options)(lc_opt_entry_t *grp);
694 #define arch_isa_get_n_reg_class(isa) ((isa)->impl->get_n_reg_class(isa))
695 #define arch_isa_get_reg_class(isa,i) ((isa)->impl->get_reg_class(isa, i))
696 #define arch_isa_get_irn_handler(isa) ((isa)->impl->get_irn_handler(isa))
697 #define arch_isa_get_call_abi(isa,tp,abi) ((isa)->impl->get_call_abi((isa), (tp), (abi)))
698 #define arch_isa_get_reg_class_for_mode(isa,mode) ((isa)->impl->get_reg_class_for_mode((isa), (mode)))
699 #define arch_isa_make_code_generator(isa,irg) ((isa)->impl->make_code_generator((isa), (irg)))
700 #define arch_isa_get_reg_class_alignment(isa, cls) ((isa)->impl->get_reg_class_alignment((isa), (cls)))
702 #define ARCH_MAX_HANDLERS 8
705 * Environment for the architecture infrastructure.
706 * Keep this everywhere you're going.
709 const struct _be_node_factory_t *node_factory; /**< The node factory for be nodes. */
710 arch_isa_t *isa; /**< The isa about which everything is. */
712 arch_irn_handler_t const *handlers[ARCH_MAX_HANDLERS]; /**< The handlers are organized as
715 int handlers_tos; /**< The stack pointer of the handler
720 * Get the isa of an arch environment.
721 * @param env The environment.
722 * @return The isa with which the env was initialized with.
724 #define arch_env_get_isa(env) ((env)->isa)
727 * Initialize the architecture environment struct.
728 * @param isa The isa which shall be put into the environment.
729 * @param file_handle The file handle
730 * @return The environment.
732 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);
735 * Add a node handler to the environment.
736 * @param env The environment.
737 * @param handler A node handler.
738 * @return The environment itself.
740 extern arch_env_t *arch_env_push_irn_handler(arch_env_t *env, const arch_irn_handler_t *handler);
743 * Remove a node handler from the handler stack.
744 * @param env The architecture environment.
745 * @return The popped handler.
747 extern const arch_irn_handler_t *arch_env_pop_irn_handler(arch_env_t *env);
749 #endif /* _FIRM_BEARCH_H */