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 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
81 * Put all registers in a class into a bitset.
82 * @param cls The class.
83 * @param bs The bitset. May be NULL.
84 * @return The number of registers in the class.
86 extern int arch_register_class_put(const arch_register_class_t *cls, bitset_t *bs);
88 static INLINE const arch_register_t *
89 _arch_register_for_index(const arch_register_class_t *cls, int idx)
91 assert(0 <= idx && idx < cls->n_regs);
92 return &cls->regs[idx];
95 #define arch_register_for_index(cls, idx) \
96 _arch_register_for_index(cls, idx)
98 typedef enum _arch_operand_type_t {
99 arch_operand_type_invalid,
100 arch_operand_type_memory,
101 arch_operand_type_register,
102 arch_operand_type_immediate,
103 arch_operand_type_symconst,
104 arch_operand_type_last
105 } arch_operand_type_t;
108 * Different types of register allocation requirements.
110 typedef enum _arch_register_req_type_t {
111 arch_register_req_type_none = 0, /**< No register requirement. */
113 arch_register_req_type_normal = 1, /**< All registers in the class
116 arch_register_req_type_limited = 2, /**< Only a real subset of
117 the class is allowed. */
119 arch_register_req_type_should_be_same = 4, /**< The register should be equal
120 another one at the node. */
122 arch_register_req_type_should_be_different = 8, /**< The register must be unequal
123 to some other at the node. */
125 arch_register_req_type_should_be_different_from_all = 16, /**< The register must be different from
126 all in's at the node */
127 } arch_register_req_type_t;
130 * Convenience macro to check for set constraints.
131 * @param req A pointer to register requirements.
132 * @param kind The kind of constraint to check for (see arch_register_req_type_t).
133 * @return 1, If the kind of constraint is present, 0 if not.
135 #define arch_register_req_is(req, kind) \
136 (((req)->type & (arch_register_req_type_ ## kind)) != 0)
139 * Expresses requirements to register allocation for an operand.
141 typedef struct _arch_register_req_t {
142 arch_register_req_type_t type; /**< The type of the constraint. */
143 const arch_register_class_t *cls; /**< The register class this constraint belongs to. */
145 void (*limited)(void *limited_env, bitset_t *bs);
146 /**< In case of the 'limited'
147 constraint, this function
148 must put all allowable
149 registers in the bitset and
150 return the number of registers
153 void *limited_env; /**< This must passed to limited. */
155 ir_node *other_same; /**< The other which shall have the same reg
156 as this one. (for case should_be_same). */
158 ir_node *other_different; /**< The other node from which this one's register
159 must be different (case must_be_different). */
160 } arch_register_req_t;
163 * Format a register requirements information into a string.
164 * @param buf The string where to put it to.
165 * @param len The size of @p buf.
166 * @param req The requirements structure to format.
167 * @return A pointer to buf.
169 extern char *arch_register_req_format(char *buf, size_t len, const arch_register_req_t *req);
173 * Certain node classes which are relevant for the register allocator.
175 typedef enum _arch_irn_class_t {
176 arch_irn_class_normal,
177 arch_irn_class_spill,
178 arch_irn_class_reload,
181 arch_irn_class_branch,
186 * Some flags describing a node in more detail.
188 typedef enum _arch_irn_flags_t {
189 arch_irn_flags_none = 0, /**< Node flags. */
190 arch_irn_flags_dont_spill = 1, /**< This must not be spilled. */
191 arch_irn_flags_rematerializable = 2, /**< This should be replicated instead of spilled/reloaded. */
192 arch_irn_flags_ignore = 4, /**< Ignore node during register allocation. */
193 arch_irn_flags_last = arch_irn_flags_ignore
197 * Get the string representation of a flag.
198 * This functions does not handle or'ed bitmasks of flags.
199 * @param flag The flag.
200 * @return The flag as a string.
202 extern const char *arch_irn_flag_str(arch_irn_flags_t flag);
204 struct _arch_irn_ops_if_t {
207 * Get the register requirements for a given operand.
208 * @param self The self pointer.
209 * @param irn The node.
210 * @param pos The operand's position
211 * (-1 for the result of the node, 0..n for the input
213 * @return The register requirements for the selected operand.
214 * The pointer returned is never NULL.
216 const arch_register_req_t *(*get_irn_reg_req)(const void *self,
217 arch_register_req_t *req, const ir_node *irn, int pos);
220 * Set the register for an output operand.
221 * @param irn The node.
222 * @param reg The register allocated to that operand.
223 * @note If the operand is not a register operand,
224 * the call is ignored.
226 void (*set_irn_reg)(const void *self, ir_node *irn, const arch_register_t *reg);
229 * Get the register allocated for an output operand.
230 * @param irn The node.
231 * @return The register allocated at that operand. NULL, if
232 * the operand was no register operand or
233 * @c arch_register_invalid, if no register has yet been
234 * allocated for this node.
236 const arch_register_t *(*get_irn_reg)(const void *self, const ir_node *irn);
240 * @param irn The node.
241 * @return A classification.
243 arch_irn_class_t (*classify)(const void *self, const ir_node *irn);
246 * Get the flags of a node.
247 * @param self The irn ops themselves.
248 * @param irn The node.
249 * @return A set of flags.
251 arch_irn_flags_t (*get_flags)(const void *self, const ir_node *irn);
254 * Get the entity on the stack frame this node depends on.
255 * @param self The this pointer.
256 * @param irn The node in question.
257 * @return The entity on the stack frame or NULL, if the node does not has a stack frame entity.
259 entity *(*get_frame_entity)(const void *self, const ir_node *irn);
262 * Set the offset of a node carrying an entity on the stack frame.
263 * @param self The this pointer.
264 * @param irn The node.
265 * @param offset The offset of the node's stack frame entity.
267 void (*set_frame_offset)(const void *self, ir_node *irn, int offset);
271 * irn_ops base class.
273 struct _arch_irn_ops_t {
274 const arch_irn_ops_if_t *impl;
277 extern void arch_set_frame_offset(const arch_env_t *env, ir_node *irn, int bias);
279 extern entity *arch_get_frame_entity(const arch_env_t *env, ir_node *irn);
282 * Get the register requirements for a node.
283 * @param env The architecture environment.
284 * @param req A pointer to a requirements structure, where the data can
286 * @param irn The node.
287 * @param pos The position of the operand you're interested in.
288 * @return A pointer to the register requirements which may <b>not</b>
289 * neccessarily be equal to @p req. If NULL is returned, the
290 * operand was no register operand.
292 extern const arch_register_req_t *
293 arch_get_register_req(const arch_env_t *env, arch_register_req_t *req,
294 const ir_node *irn, int pos);
297 * Check if an operand is a register operand.
298 * @param env The environment.
299 * @param irn The node.
300 * @param pos The position of the operand.
301 * @return 1, if the operand is significant for register allocation, 0
304 extern int arch_is_register_operand(const arch_env_t *env,
305 const ir_node *irn, int pos);
308 * Get the number of allocatable registers concerning
309 * a register class for an operand of a node.
310 * @param env The environment.
311 * @param irn The node.
312 * @param pos The postition of the node's operand.
313 * @param bs The bitset all allocatable registers shall be put into.
314 * Note, that you can also pass NULL here. If you don't,
315 * make sure, the bitset is as large as the register class
317 * @return The amount of registers allocatable for that operand.
319 extern int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn, int pos, bitset_t *bs);
322 * Put all registers which shall not be ignored by the register
323 * allocator in a bit set.
324 * @param env The arch env.
325 * @param cls The register class to consider.
326 * @param bs The bit set to put the registers to.
328 extern void arch_put_non_ignore_regs(const arch_env_t *env, const arch_register_class_t *cls, bitset_t *bs);
331 * Check, if a register is assignable to an operand of a node.
332 * @param env The architecture environment.
333 * @param irn The node.
334 * @param pos The position of the operand.
335 * @param reg The register.
336 * @return 1, if the register might be allocated to the operand 0 if not.
338 extern int arch_reg_is_allocatable(const arch_env_t *env,
339 const ir_node *irn, int pos, const arch_register_t *reg);
342 * Get the register class of an operand of a node.
343 * @param env The architecture environment.
344 * @param irn The node.
345 * @param pos The position of the operand.
346 * @return The register class of the operand or NULL, if
347 * operand is a non-register operand.
349 extern const arch_register_class_t *
350 arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos);
353 * Get the register allocated at a certain output operand of a node.
354 * @param env The arch environment.
355 * @param irn The node.
356 * @return The register allocated for this operand
358 extern const arch_register_t *
359 arch_get_irn_register(const arch_env_t *env, const ir_node *irn);
362 * Set the register for a certain output operand.
363 * @param env The architecture environment.
364 * @param irn The node.
365 * @param idx The index of the output operand.
366 * @param reg The register.
368 extern void arch_set_irn_register(const arch_env_t *env, ir_node *irn,
369 const arch_register_t *reg);
373 * @param env The architecture environment.
374 * @param irn The node.
375 * @return A classification of the node.
377 extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn);
380 * Get the flags of a node.
381 * @param env The architecture environment.
382 * @param irn The node.
385 extern arch_irn_flags_t arch_irn_get_flags(const arch_env_t *env, const ir_node *irn);
387 #define arch_irn_is(env, irn, flag) ((arch_irn_get_flags(env, irn) & arch_irn_flags_ ## flag) != 0)
389 #define arch_irn_has_reg_class(env, irn, pos, cls) \
390 ((cls) == arch_get_irn_reg_class(env, irn, pos))
392 #define arch_irn_consider_in_reg_alloc(env, cls, irn) \
393 (arch_irn_has_reg_class(env, irn, -1, cls) && !arch_irn_is(env, irn, ignore))
396 * Somebody who can be asked about IR nodes.
398 struct _arch_irn_handler_t {
401 * Get the operations of an irn.
402 * @param self The handler from which the method is invoked.
403 * @param irn Some node.
404 * @return Operations for that irn.
406 const void *(*get_irn_ops)(const arch_irn_handler_t *handler,
411 * The code generator interface.
413 struct _arch_code_generator_if_t {
415 * Initialize the code generator.
416 * @param file The file to dump to.
417 * @param birg A backend IRG session.
418 * @return A newly created code generator.
420 void *(*init)(FILE *file, const be_irg_t *birg);
423 * Called before abi introduce.
425 void (*before_abi)(void *self);
428 * Called, when the graph is being normalized.
430 void (*prepare_graph)(void *self);
433 * Called before scheduling.
435 void (*before_sched)(void *self);
438 * Called before register allocation.
440 void (*before_ra)(void *self);
443 * Called after register allocation.
445 void (*after_ra)(void *self);
448 * Called after everything happened.
449 * The code generator must also be de-allocated here.
451 void (*done)(void *self);
455 * helper macro: call function func from the code generator
456 * if it's implemented.
458 #define _arch_cg_call(cg, func) \
460 if((cg)->impl->func) \
461 (cg)->impl->func(cg); \
464 #define arch_code_generator_before_abi(cg) _arch_cg_call(cg, before_abi)
465 #define arch_code_generator_prepare_graph(cg) _arch_cg_call(cg, prepare_graph)
466 #define arch_code_generator_before_sched(cg) _arch_cg_call(cg, before_sched)
467 #define arch_code_generator_before_ra(cg) _arch_cg_call(cg, before_ra)
468 #define arch_code_generator_after_ra(cg) _arch_cg_call(cg, after_ra)
469 #define arch_code_generator_done(cg) _arch_cg_call(cg, done)
472 * Code generator base class.
474 struct _arch_code_generator_t {
475 const arch_code_generator_if_t *impl;
482 const arch_isa_if_t *impl;
483 const arch_register_t *sp; /** The stack pointer register. */
484 const arch_register_t *bp; /** The base pointer register. */
485 const int stack_dir; /** -1 for decreasing, 1 for increasing. */
488 #define arch_isa_stack_dir(isa) ((isa)->stack_dir)
489 #define arch_isa_sp(isa) ((isa)->sp)
490 #define arch_isa_bp(isa) ((isa)->bp)
493 * Architecture interface.
495 struct _arch_isa_if_t {
498 void (*register_options)(lc_opt_entry_t *grp);
502 * Initialize the isa interface.
507 * Free the isa instance.
509 void (*done)(void *self);
512 * Get the the number of register classes in the isa.
513 * @return The number of register classes.
515 int (*get_n_reg_class)(const void *self);
518 * Get the i-th register class.
519 * @param i The number of the register class.
520 * @return The register class.
522 const arch_register_class_t *(*get_reg_class)(const void *self, int i);
525 * Get the register class which shall be used to store a value of a given mode.
526 * @param self The this pointer.
527 * @param mode The mode in question.
528 * @return A register class which can hold values of the given mode.
530 const arch_register_class_t *(*get_reg_class_for_mode)(const void *self, const ir_mode *mode);
533 * Get the ABI restrictions for procedure calls.
534 * @param self The this pointer.
535 * @param method_type The type of the method (procedure) in question.
536 * @param p The array of parameter locations to be filled.
538 void (*get_call_abi)(const void *self, ir_type *method_type, be_abi_call_t *abi);
541 * The irn handler for this architecture.
542 * The irn handler is registered by the Firm back end
543 * when the architecture is initialized.
546 const arch_irn_handler_t *(*get_irn_handler)(const void *self);
549 * Get the code generator interface.
550 * @param self The this pointer.
551 * @return Some code generator interface.
553 const arch_code_generator_if_t *(*get_code_generator_if)(void *self);
556 * Get the list scheduler to use.
557 * @param self The isa object.
558 * @return The list scheduler selector.
560 const list_sched_selector_t *(*get_list_sched_selector)(const void *self);
564 #define arch_isa_get_n_reg_class(isa) ((isa)->impl->get_n_reg_class(isa))
565 #define arch_isa_get_reg_class(isa,i) ((isa)->impl->get_reg_class(isa, i))
566 #define arch_isa_get_irn_handler(isa) ((isa)->impl->get_irn_handler(isa))
567 #define arch_isa_get_call_abi(isa,tp,abi) ((isa)->impl->get_call_abi((isa), (tp), (abi)))
568 #define arch_isa_get_reg_class_for_mode(isa,mode) ((isa)->impl->get_reg_class_for_mode((isa), (mode)))
569 #define arch_isa_make_code_generator(isa,irg) ((isa)->impl->make_code_generator(isa, irg))
571 #define ARCH_MAX_HANDLERS 8
574 * Environment for the architecture infrastructure.
575 * Keep this everywhere you're going.
578 const struct _be_node_factory_t *node_factory; /**< The node factory for be nodes. */
579 arch_isa_t *isa; /**< The isa about which everything is. */
581 arch_irn_handler_t const *handlers[ARCH_MAX_HANDLERS]; /**< The handlers are organized as
584 int handlers_tos; /**< The stack pointer of the handler
589 * Get the isa of an arch environment.
590 * @param env The environment.
591 * @return The isa with which the env was initialized with.
593 #define arch_env_get_isa(env) ((env)->isa)
596 * Initialize the architecture environment struct.
597 * @param isa The isa which shall be put into the environment.
598 * @return The environment.
600 extern arch_env_t *arch_env_init(arch_env_t *env, const arch_isa_if_t *isa);
603 * Add a node handler to the environment.
604 * @param env The environment.
605 * @param handler A node handler.
606 * @return The environment itself.
608 extern arch_env_t *arch_env_push_irn_handler(arch_env_t *env, const arch_irn_handler_t *handler);
611 * Remove a node handler from the handler stack.
612 * @param env The architecture environment.
613 * @return The popped handler.
615 extern const arch_irn_handler_t *arch_env_pop_irn_handler(arch_env_t *env);
617 #endif /* _FIRM_BEARCH_H */