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_joker = 8, /**< The emitter can choose an arbitrary register */
31 } arch_register_type_t;
34 * Convenience macro to check for register type.
35 * @param req A pointer to register.
36 * @param kind The kind of type to check for (see arch_register_type_t).
37 * @return 1, If register is of given kind, 0 if not.
39 #define arch_register_type_is(reg, kind) \
40 (((reg)->type & arch_register_type_ ## kind) != 0)
45 struct _arch_register_t {
46 const char *name; /**< The name of the register. */
47 const arch_register_class_t *reg_class; /**< The class the register belongs to. */
48 int index; /**< The index of the register in the class. */
49 arch_register_type_t type; /**< The type of the register. */
50 void *data; /**< Custom data. */
53 static INLINE const arch_register_class_t *
54 _arch_register_get_class(const arch_register_t *reg)
56 return reg->reg_class;
59 static INLINE int _arch_register_get_index(const arch_register_t *reg)
64 static INLINE const char *_arch_register_get_name(const arch_register_t *reg)
69 #define arch_register_get_class(reg) _arch_register_get_class(reg)
70 #define arch_register_get_index(reg) _arch_register_get_index(reg)
71 #define arch_register_get_name(reg) _arch_register_get_name(reg)
74 * A class of registers.
75 * Like general purpose or floating point.
77 struct _arch_register_class_t {
78 const char *name; /**< The name of the register class. */
79 int n_regs; /**< Number of registers in this class. */
80 ir_mode *mode; /**< The mode of the register class. */
81 const arch_register_t *regs; /**< The array of registers. */
84 /** return the number of registers in this register class */
85 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
87 /** return the largest mode of this register class */
88 #define arch_register_class_mode(cls) ((cls)->mode)
90 /** return the name of this register class */
91 #define arch_register_class_name(cls) ((cls)->name)
94 * Put all registers in a class into a bitset.
95 * @param cls The class.
96 * @param bs The bitset. May be NULL.
97 * @return The number of registers in the class.
99 extern int arch_register_class_put(const arch_register_class_t *cls, bitset_t *bs);
101 static INLINE const arch_register_t *
102 _arch_register_for_index(const arch_register_class_t *cls, int idx)
104 assert(0 <= idx && idx < cls->n_regs);
105 return &cls->regs[idx];
108 #define arch_register_for_index(cls, idx) \
109 _arch_register_for_index(cls, idx)
111 typedef enum _arch_operand_type_t {
112 arch_operand_type_invalid,
113 arch_operand_type_memory,
114 arch_operand_type_register,
115 arch_operand_type_immediate,
116 arch_operand_type_symconst,
117 arch_operand_type_last
118 } arch_operand_type_t;
121 * Different types of register allocation requirements.
123 typedef enum _arch_register_req_type_t {
124 arch_register_req_type_none = 0, /**< No register requirement. */
126 arch_register_req_type_normal = 1, /**< All registers in the class
129 arch_register_req_type_limited = 2, /**< Only a real subset of
130 the class is allowed. */
132 arch_register_req_type_should_be_same = 4, /**< The register should be equal
133 another one at the node. */
135 arch_register_req_type_should_be_different = 8, /**< The register must be unequal
136 to some other at the node. */
138 arch_register_req_type_should_be_different_from_all = 16, /**< The register must be different from
139 all in's at the node */
140 } arch_register_req_type_t;
143 * Convenience macro to check for set constraints.
144 * @param req A pointer to register requirements.
145 * @param kind The kind of constraint to check for (see arch_register_req_type_t).
146 * @return 1, If the kind of constraint is present, 0 if not.
148 #define arch_register_req_is(req, kind) \
149 (((req)->type & (arch_register_req_type_ ## kind)) != 0)
152 * Expresses requirements to register allocation for an operand.
154 typedef struct _arch_register_req_t {
155 arch_register_req_type_t type; /**< The type of the constraint. */
156 const arch_register_class_t *cls; /**< The register class this constraint belongs to. */
158 void (*limited)(void *limited_env, bitset_t *bs);
159 /**< In case of the 'limited'
160 constraint, this function
161 must put all allowable
162 registers in the bitset and
163 return the number of registers
166 void *limited_env; /**< This must passed to limited. */
168 ir_node *other_same; /**< The other which shall have the same reg
169 as this one. (for case should_be_same). */
171 ir_node *other_different; /**< The other node from which this one's register
172 must be different (case must_be_different). */
173 } arch_register_req_t;
176 * Format a register requirements information into a string.
177 * @param buf The string where to put it to.
178 * @param len The size of @p buf.
179 * @param req The requirements structure to format.
180 * @return A pointer to buf.
182 extern char *arch_register_req_format(char *buf, size_t len, const arch_register_req_t *req);
186 * Certain node classes which are relevant for the register allocator.
188 typedef enum _arch_irn_class_t {
189 arch_irn_class_normal = 1 << 0,
190 arch_irn_class_spill = 1 << 1,
191 arch_irn_class_reload = 1 << 2,
192 arch_irn_class_copy = 1 << 3,
193 arch_irn_class_perm = 1 << 4,
194 arch_irn_class_branch = 1 << 5,
195 arch_irn_class_call = 1 << 6,
196 arch_irn_class_const = 1 << 7,
197 arch_irn_class_load = 1 << 8,
198 arch_irn_class_store = 1 << 9,
199 arch_irn_class_stackparam = 1 << 10,
203 * An inverse operation returned by the backend
205 typedef struct _arch_inverse_t {
206 int n; /**< count of nodes returned in nodes array */
207 int costs; /**< costs of this remat */
209 /**< nodes for this inverse operation. shall be in
210 * schedule order. last element is the target value
216 * Some flags describing a node in more detail.
218 typedef enum _arch_irn_flags_t {
219 arch_irn_flags_none = 0, /**< Node flags. */
220 arch_irn_flags_dont_spill = 1, /**< This must not be spilled. */
221 arch_irn_flags_rematerializable = 2, /**< This can be replicated instead of spilled/reloaded. */
222 arch_irn_flags_ignore = 4, /**< Ignore node during register allocation. */
223 arch_irn_flags_modify_sp = 8, /**< I modify the stack pointer. */
224 arch_irn_flags_last = arch_irn_flags_modify_sp
228 * Get the string representation of a flag.
229 * This functions does not handle or'ed bitmasks of flags.
230 * @param flag The flag.
231 * @return The flag as a string.
233 extern const char *arch_irn_flag_str(arch_irn_flags_t flag);
235 struct _arch_irn_ops_if_t {
238 * Get the register requirements for a given operand.
239 * @param self The self pointer.
240 * @param irn The node.
241 * @param pos The operand's position
242 * (-1 for the result of the node, 0..n for the input
244 * @return The register requirements for the selected operand.
245 * The pointer returned is never NULL.
247 const arch_register_req_t *(*get_irn_reg_req)(const void *self,
248 arch_register_req_t *req, const ir_node *irn, int pos);
251 * Set the register for an output operand.
252 * @param irn The node.
253 * @param reg The register allocated to that operand.
254 * @note If the operand is not a register operand,
255 * the call is ignored.
257 void (*set_irn_reg)(const void *self, ir_node *irn, const arch_register_t *reg);
260 * Get the register allocated for an output operand.
261 * @param irn The node.
262 * @return The register allocated at that operand. NULL, if
263 * the operand was no register operand or
264 * @c arch_register_invalid, if no register has yet been
265 * allocated for this node.
267 const arch_register_t *(*get_irn_reg)(const void *self, const ir_node *irn);
271 * @param irn The node.
272 * @return A classification.
274 arch_irn_class_t (*classify)(const void *self, const ir_node *irn);
277 * Get the flags of a node.
278 * @param self The irn ops themselves.
279 * @param irn The node.
280 * @return A set of flags.
282 arch_irn_flags_t (*get_flags)(const void *self, const ir_node *irn);
285 * Get the entity on the stack frame this node depends on.
286 * @param self The this pointer.
287 * @param irn The node in question.
288 * @return The entity on the stack frame or NULL, if the node does not has a stack frame entity.
290 entity *(*get_frame_entity)(const void *self, const ir_node *irn);
293 * Set the entity on the stack frame this node depends on.
294 * @param self The this pointer.
295 * @param irn The node in question.
296 * @param ent The entity to set
298 void (*set_frame_entity)(const void *self, ir_node *irn, entity *ent);
301 * Set the offset of a node carrying an entity on the stack frame.
302 * @param self The this pointer.
303 * @param irn The node.
304 * @param offset The offset of the node's stack frame entity.
306 void (*set_frame_offset)(const void *self, ir_node *irn, int offset);
309 * Returns the delta of the stackpointer for nodes that increment or
310 * decrement the stackpointer with a constant value. (push, pop
311 * nodes on most architectures).
312 * A positive value stands for an expanding stack area, a negative value for
315 * @param self The this pointer
316 * @param irn The node
317 * @return 0 if the stackpointer is not modified with a constant
318 * value, otherwise the increment/decrement value
320 int (*get_sp_bias)(const void *self, const ir_node *irn);
323 * Returns an inverse operation which yields the i-th argument
324 * of the given node as result.
326 * @param self The this pointer.
327 * @param irn The original operation
328 * @param i Index of the argument we want the inverse operation to yield
329 * @param inverse struct to be filled with the resulting inverse op
330 * @param obstack The obstack to use for allocation of the returned nodes array
331 * @return The inverse operation or NULL if operation invertible
333 arch_inverse_t *(*get_inverse)(const void *self, const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack);
336 * Get the estimated cycle count for @p irn.
338 * @param self The this pointer.
339 * @param irn The node.
341 * @return The estimated cycle count for this operation
343 int (*get_op_estimated_cost)(const void *self, const ir_node *irn);
346 * Asks the backend whether operand @p i of @p irn can be loaded form memory internally
348 * @param self The this pointer.
349 * @param irn The node.
350 * @param i Index of the argument we would like to know whether @p irn can load it form memory internally
352 * @return nonzero if argument can be loaded or zero otherwise
354 int (*possible_memory_operand)(const void *self, const ir_node *irn, unsigned int i);
357 * Ask the backend to assimilate @p reload of operand @p i into @p irn.
359 * @param self The this pointer.
360 * @param irn The node.
361 * @param spill The spill.
362 * @param i The position of the reload.
364 void (*perform_memory_operand)(const void *self, ir_node *irn, ir_node *spill, unsigned int i);
368 * irn_ops base class.
370 struct _arch_irn_ops_t {
371 const arch_irn_ops_if_t *impl;
374 extern const arch_irn_ops_t *arch_get_irn_ops(const arch_env_t *env, const ir_node *irn);
376 extern void arch_set_frame_offset(const arch_env_t *env, ir_node *irn, int bias);
378 extern entity *arch_get_frame_entity(const arch_env_t *env, ir_node *irn);
379 extern void arch_set_frame_entity(const arch_env_t *env, ir_node *irn, entity *ent);
380 extern int arch_get_sp_bias(const arch_env_t *env, ir_node *irn);
382 extern int arch_get_op_estimated_cost(const arch_env_t *env, const ir_node *irn);
383 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);
384 extern int arch_possible_memory_operand(const arch_env_t *env, const ir_node *irn, unsigned int i);
385 extern void arch_perform_memory_operand(const arch_env_t *env, ir_node *irn, ir_node *spill, unsigned int i);
388 * Get the register requirements for a node.
389 * @param env The architecture environment.
390 * @param req A pointer to a requirements structure, where the data can
392 * @param irn The node.
393 * @param pos The position of the operand you're interested in.
394 * @return A pointer to the register requirements which may <b>not</b>
395 * neccessarily be equal to @p req. If NULL is returned, the
396 * operand was no register operand.
398 extern const arch_register_req_t *
399 arch_get_register_req(const arch_env_t *env, arch_register_req_t *req,
400 const ir_node *irn, int pos);
403 * Check if an operand is a register operand.
404 * @param env The environment.
405 * @param irn The node.
406 * @param pos The position of the operand.
407 * @return 1, if the operand is significant for register allocation, 0
410 extern int arch_is_register_operand(const arch_env_t *env,
411 const ir_node *irn, int pos);
414 * Get the number of allocatable registers concerning
415 * a register class for an operand of a node.
416 * @param env The environment.
417 * @param irn The node.
418 * @param pos The postition of the node's operand.
419 * @param bs The bitset all allocatable registers shall be put into.
420 * Note, that you can also pass NULL here. If you don't,
421 * make sure, the bitset is as large as the register class
423 * @return The amount of registers allocatable for that operand.
425 extern int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn, int pos, bitset_t *bs);
428 * Put all registers which shall not be ignored by the register
429 * allocator in a bit set.
430 * @param env The arch env.
431 * @param cls The register class to consider.
432 * @param bs The bit set to put the registers to.
434 extern void arch_put_non_ignore_regs(const arch_env_t *env, const arch_register_class_t *cls, bitset_t *bs);
437 * Check, if a register is assignable to an operand of a node.
438 * @param env The architecture environment.
439 * @param irn The node.
440 * @param pos The position of the operand.
441 * @param reg The register.
442 * @return 1, if the register might be allocated to the operand 0 if not.
444 extern int arch_reg_is_allocatable(const arch_env_t *env,
445 const ir_node *irn, int pos, const arch_register_t *reg);
448 * Get the register class of an operand of a node.
449 * @param env The architecture environment.
450 * @param irn The node.
451 * @param pos The position of the operand, -1 for the output.
452 * @return The register class of the operand or NULL, if
453 * operand is a non-register operand.
455 extern const arch_register_class_t *
456 arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos);
459 * Get the register allocated at a certain output operand of a node.
460 * @param env The arch environment.
461 * @param irn The node.
462 * @return The register allocated for this operand
464 extern const arch_register_t *
465 arch_get_irn_register(const arch_env_t *env, const ir_node *irn);
468 * Set the register for a certain output operand.
469 * @param env The architecture environment.
470 * @param irn The node.
471 * @param idx The index of the output operand.
472 * @param reg The register.
474 extern void arch_set_irn_register(const arch_env_t *env, ir_node *irn,
475 const arch_register_t *reg);
479 * @param env The architecture environment.
480 * @param irn The node.
481 * @return A classification of the node.
483 extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn);
485 #define arch_irn_class_is(env, irn, irn_class) ((arch_irn_classify(env, irn) & arch_irn_class_ ## irn_class) != 0)
488 * Get the flags of a node.
489 * @param env The architecture environment.
490 * @param irn The node.
493 extern arch_irn_flags_t arch_irn_get_flags(const arch_env_t *env, const ir_node *irn);
495 #define arch_irn_is(env, irn, flag) ((arch_irn_get_flags(env, irn) & arch_irn_flags_ ## flag) != 0)
497 #define arch_irn_has_reg_class(env, irn, pos, cls) \
498 ((cls) == arch_get_irn_reg_class(env, irn, pos))
500 #define arch_irn_consider_in_reg_alloc(env, cls, irn) \
501 (arch_irn_has_reg_class(env, irn, -1, cls) && !arch_irn_is(env, irn, ignore))
504 * Somebody who can be asked about IR nodes.
506 struct _arch_irn_handler_t {
509 * Get the operations of an irn.
510 * @param self The handler from which the method is invoked.
511 * @param irn Some node.
512 * @return Operations for that irn.
514 const void *(*get_irn_ops)(const arch_irn_handler_t *handler,
519 * The code generator interface.
521 struct _arch_code_generator_if_t {
523 * Initialize the code generator.
524 * @param birg A backend IRG session.
525 * @return A newly created code generator.
527 void *(*init)(const be_irg_t *birg);
530 * Called before abi introduce.
532 void (*before_abi)(void *self);
535 * Called, when the graph is being normalized.
537 void (*prepare_graph)(void *self);
540 * Called before scheduling.
542 void (*before_sched)(void *self);
545 * Called before register allocation.
547 void (*before_ra)(void *self);
550 * Called after register allocation.
552 void (*after_ra)(void *self);
555 * Called directly before done is called. This should be the last place
556 * where the irg is modified.
558 void (*finish)(void *self);
561 * Called after everything happened. This call should emit the final
562 * assembly code but avoid changing the irg.
563 * The code generator must also be de-allocated here.
565 void (*done)(void *self);
569 * helper macro: call function func from the code generator
570 * if it's implemented.
572 #define _arch_cg_call(cg, func) \
574 if((cg)->impl->func) \
575 (cg)->impl->func(cg); \
578 #define arch_code_generator_before_abi(cg) _arch_cg_call(cg, before_abi)
579 #define arch_code_generator_prepare_graph(cg) _arch_cg_call(cg, prepare_graph)
580 #define arch_code_generator_before_sched(cg) _arch_cg_call(cg, before_sched)
581 #define arch_code_generator_before_ra(cg) _arch_cg_call(cg, before_ra)
582 #define arch_code_generator_after_ra(cg) _arch_cg_call(cg, after_ra)
583 #define arch_code_generator_finish(cg) _arch_cg_call(cg, finish)
584 #define arch_code_generator_done(cg) _arch_cg_call(cg, done)
587 * Code generator base class.
589 struct _arch_code_generator_t {
590 const arch_code_generator_if_t *impl;
597 const arch_isa_if_t *impl;
598 const arch_register_t *sp; /** The stack pointer register. */
599 const arch_register_t *bp; /** The base pointer register. */
600 const int stack_dir; /** -1 for decreasing, 1 for increasing. */
601 const be_main_env_t *main_env; /** the be main environment */
604 #define arch_isa_stack_dir(isa) ((isa)->stack_dir)
605 #define arch_isa_sp(isa) ((isa)->sp)
606 #define arch_isa_bp(isa) ((isa)->bp)
609 * Architecture interface.
611 struct _arch_isa_if_t {
614 * Initialize the isa interface.
615 * @param file_handle the file handle to write the output to
616 * @param main_env the be main environment
617 * @return a new isa instance
619 void *(*init)(FILE *file_handle);
622 * Free the isa instance.
624 void (*done)(void *self);
627 * Get the the number of register classes in the isa.
628 * @return The number of register classes.
630 int (*get_n_reg_class)(const void *self);
633 * Get the i-th register class.
634 * @param i The number of the register class.
635 * @return The register class.
637 const arch_register_class_t *(*get_reg_class)(const void *self, int i);
640 * Get the register class which shall be used to store a value of a given mode.
641 * @param self The this pointer.
642 * @param mode The mode in question.
643 * @return A register class which can hold values of the given mode.
645 const arch_register_class_t *(*get_reg_class_for_mode)(const void *self, const ir_mode *mode);
648 * Get the ABI restrictions for procedure calls.
649 * @param self The this pointer.
650 * @param method_type The type of the method (procedure) in question.
651 * @param p The array of parameter locations to be filled.
653 void (*get_call_abi)(const void *self, ir_type *method_type, be_abi_call_t *abi);
656 * The irn handler for this architecture.
657 * The irn handler is registered by the Firm back end
658 * when the architecture is initialized.
661 const arch_irn_handler_t *(*get_irn_handler)(const void *self);
664 * Get the code generator interface.
665 * @param self The this pointer.
666 * @return Some code generator interface.
668 const arch_code_generator_if_t *(*get_code_generator_if)(void *self);
671 * Get the list scheduler to use. There is already a selector given, the
672 * backend is free to modify and/or ignore it.
674 * @param self The isa object.
675 * @param selector The selector given by options.
676 * @return The list scheduler selector.
678 const list_sched_selector_t *(*get_list_sched_selector)(const void *self, list_sched_selector_t *selector);
681 * Get the necessary alignment for storing a register of given class.
682 * @param self The isa object.
683 * @param cls The register class.
684 * @return The alignment in bytes.
686 int (*get_reg_class_alignment)(const void *self, const arch_register_class_t *cls);
689 * A "static" function, returns the frontend settings
690 * needed for this backend.
692 const backend_params *(*get_params)(void);
696 * Register command line options for this backend.
697 * @param grp The root group.
699 void (*register_options)(lc_opt_entry_t *grp);
703 #define arch_isa_get_n_reg_class(isa) ((isa)->impl->get_n_reg_class(isa))
704 #define arch_isa_get_reg_class(isa,i) ((isa)->impl->get_reg_class(isa, i))
705 #define arch_isa_get_irn_handler(isa) ((isa)->impl->get_irn_handler(isa))
706 #define arch_isa_get_call_abi(isa,tp,abi) ((isa)->impl->get_call_abi((isa), (tp), (abi)))
707 #define arch_isa_get_reg_class_for_mode(isa,mode) ((isa)->impl->get_reg_class_for_mode((isa), (mode)))
708 #define arch_isa_make_code_generator(isa,irg) ((isa)->impl->make_code_generator((isa), (irg)))
709 #define arch_isa_get_reg_class_alignment(isa, cls) ((isa)->impl->get_reg_class_alignment((isa), (cls)))
711 #define ARCH_MAX_HANDLERS 8
714 * Environment for the architecture infrastructure.
715 * Keep this everywhere you're going.
718 const struct _be_node_factory_t *node_factory; /**< The node factory for be nodes. */
719 arch_isa_t *isa; /**< The isa about which everything is. */
721 arch_irn_handler_t const *handlers[ARCH_MAX_HANDLERS]; /**< The handlers are organized as
724 int handlers_tos; /**< The stack pointer of the handler
729 * Get the isa of an arch environment.
730 * @param env The environment.
731 * @return The isa with which the env was initialized with.
733 #define arch_env_get_isa(env) ((env)->isa)
736 * Initialize the architecture environment struct.
737 * @param isa The isa which shall be put into the environment.
738 * @param file_handle The file handle
739 * @return The environment.
741 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);
744 * Add a node handler to the environment.
745 * @param env The environment.
746 * @param handler A node handler.
747 * @return The environment itself.
749 extern arch_env_t *arch_env_push_irn_handler(arch_env_t *env, const arch_irn_handler_t *handler);
752 * Remove a node handler from the handler stack.
753 * @param env The architecture environment.
754 * @return The popped handler.
756 extern const arch_irn_handler_t *arch_env_pop_irn_handler(arch_env_t *env);
758 #endif /* _FIRM_BEARCH_H */