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_t;
128 * Convenience macro to check for set constraints.
129 * @param req A pointer to register requirements.
130 * @param kind The kind of constraint to check for (see arch_register_req_type_t).
131 * @return 1, If the kind of constraint is present, 0 if not.
133 #define arch_register_req_is(req, kind) \
134 (((req)->type & (arch_register_req_type_ ## kind)) != 0)
137 * Expresses requirements to register allocation for an operand.
139 typedef struct _arch_register_req_t {
140 arch_register_req_type_t type; /**< The type of the constraint. */
141 const arch_register_class_t *cls; /**< The register class this constraint belongs to. */
143 void (*limited)(void *limited_env, bitset_t *bs);
144 /**< In case of the 'limited'
145 constraint, this function
146 must put all allowable
147 registers in the bitset and
148 return the number of registers
151 void *limited_env; /**< This must passed to limited. */
153 ir_node *other_same; /**< The other which shall have the same reg
154 as this one. (for case should_be_same). */
156 ir_node *other_different; /**< The other node from which this one's register
157 must be different (case must_be_different). */
158 } arch_register_req_t;
161 * Format a register requirements information into a string.
162 * @param buf The string where to put it to.
163 * @param len The size of @p buf.
164 * @param req The requirements structure to format.
165 * @return A pointer to buf.
167 extern char *arch_register_req_format(char *buf, size_t len, const arch_register_req_t *req);
171 * Certain node classes which are relevant for the register allocator.
173 typedef enum _arch_irn_class_t {
174 arch_irn_class_normal,
175 arch_irn_class_spill,
176 arch_irn_class_reload,
179 arch_irn_class_branch,
184 * Some flags describing a node in more detail.
186 typedef enum _arch_irn_flags_t {
187 arch_irn_flags_none = 0, /**< Node flags. */
188 arch_irn_flags_dont_spill = 1, /**< This must not be spilled. */
189 arch_irn_flags_rematerializable = 2, /**< This should be replicated instead of spilled/reloaded. */
190 arch_irn_flags_ignore = 4, /**< Ignore node during register allocation. */
191 arch_irn_flags_last = arch_irn_flags_ignore
195 * Get the string representation of a flag.
196 * This functions does not handle or'ed bitmasks of flags.
197 * @param flag The flag.
198 * @return The flag as a string.
200 extern const char *arch_irn_flag_str(arch_irn_flags_t flag);
202 struct _arch_irn_ops_if_t {
205 * Get the register requirements for a given operand.
206 * @param self The self pointer.
207 * @param irn The node.
208 * @param pos The operand's position
209 * (-1 for the result of the node, 0..n for the input
211 * @return The register requirements for the selected operand.
212 * The pointer returned is never NULL.
214 const arch_register_req_t *(*get_irn_reg_req)(const void *self,
215 arch_register_req_t *req, const ir_node *irn, int pos);
218 * Set the register for an output operand.
219 * @param irn The node.
220 * @param reg The register allocated to that operand.
221 * @note If the operand is not a register operand,
222 * the call is ignored.
224 void (*set_irn_reg)(const void *self, ir_node *irn, const arch_register_t *reg);
227 * Get the register allocated for an output operand.
228 * @param irn The node.
229 * @return The register allocated at that operand. NULL, if
230 * the operand was no register operand or
231 * @c arch_register_invalid, if no register has yet been
232 * allocated for this node.
234 const arch_register_t *(*get_irn_reg)(const void *self, const ir_node *irn);
238 * @param irn The node.
239 * @return A classification.
241 arch_irn_class_t (*classify)(const void *self, const ir_node *irn);
244 * Get the flags of a node.
245 * @param self The irn ops themselves.
246 * @param irn The node.
247 * @return A set of flags.
249 arch_irn_flags_t (*get_flags)(const void *self, const ir_node *irn);
252 * Get the entity on the stack frame this node depends on.
253 * @param self The this pointer.
254 * @param irn The node in question.
255 * @return The entity on the stack frame or NULL, if the node does not has a stack frame entity.
257 entity *(*get_frame_entity)(const void *self, const ir_node *irn);
260 * Set the offset of a node carrying an entity on the stack frame.
261 * @param self The this pointer.
262 * @param irn The node.
263 * @param offset The offset of the node's stack frame entity.
265 void (*set_frame_offset)(const void *self, ir_node *irn, int offset);
269 * irn_ops base class.
271 struct _arch_irn_ops_t {
272 const arch_irn_ops_if_t *impl;
275 extern void arch_set_frame_offset(const arch_env_t *env, ir_node *irn, int bias);
277 extern entity *arch_get_frame_entity(const arch_env_t *env, ir_node *irn);
280 * Get the register requirements for a node.
281 * @param env The architecture environment.
282 * @param req A pointer to a requirements structure, where the data can
284 * @param irn The node.
285 * @param pos The position of the operand you're interested in.
286 * @return A pointer to the register requirements which may <b>not</b>
287 * neccessarily be equal to @p req. If NULL is returned, the
288 * operand was no register operand.
290 extern const arch_register_req_t *
291 arch_get_register_req(const arch_env_t *env, arch_register_req_t *req,
292 const ir_node *irn, int pos);
295 * Check if an operand is a register operand.
296 * @param env The environment.
297 * @param irn The node.
298 * @param pos The position of the operand.
299 * @return 1, if the operand is significant for register allocation, 0
302 extern int arch_is_register_operand(const arch_env_t *env,
303 const ir_node *irn, int pos);
306 * Get the number of allocatable registers concerning
307 * a register class for an operand of a node.
308 * @param env The environment.
309 * @param irn The node.
310 * @param pos The postition of the node's operand.
311 * @param bs The bitset all allocatable registers shall be put into.
312 * Note, that you can also pass NULL here. If you don't,
313 * make sure, the bitset is as large as the register class
315 * @return The amount of registers allocatable for that operand.
317 extern int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn, int pos, bitset_t *bs);
320 * Put all registers which shall not be ignored by the register
321 * allocator in a bit set.
322 * @param env The arch env.
323 * @param cls The register class to consider.
324 * @param bs The bit set to put the registers to.
326 extern void arch_put_non_ignore_regs(const arch_env_t *env, const arch_register_class_t *cls, bitset_t *bs);
329 * Check, if a register is assignable to an operand of a node.
330 * @param env The architecture environment.
331 * @param irn The node.
332 * @param pos The position of the operand.
333 * @param reg The register.
334 * @return 1, if the register might be allocated to the operand 0 if not.
336 extern int arch_reg_is_allocatable(const arch_env_t *env,
337 const ir_node *irn, int pos, const arch_register_t *reg);
340 * Get the register class of an operand of a node.
341 * @param env The architecture environment.
342 * @param irn The node.
343 * @param pos The position of the operand.
344 * @return The register class of the operand or NULL, if
345 * operand is a non-register operand.
347 extern const arch_register_class_t *
348 arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos);
351 * Get the register allocated at a certain output operand of a node.
352 * @param env The arch environment.
353 * @param irn The node.
354 * @return The register allocated for this operand
356 extern const arch_register_t *
357 arch_get_irn_register(const arch_env_t *env, const ir_node *irn);
360 * Set the register for a certain output operand.
361 * @param env The architecture environment.
362 * @param irn The node.
363 * @param idx The index of the output operand.
364 * @param reg The register.
366 extern void arch_set_irn_register(const arch_env_t *env, ir_node *irn,
367 const arch_register_t *reg);
371 * @param env The architecture environment.
372 * @param irn The node.
373 * @return A classification of the node.
375 extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn);
378 * Get the flags of a node.
379 * @param env The architecture environment.
380 * @param irn The node.
383 extern arch_irn_flags_t arch_irn_get_flags(const arch_env_t *env, const ir_node *irn);
385 #define arch_irn_is_ignore(env, irn) ((arch_irn_get_flags(env, irn) & arch_irn_flags_ignore) != 0)
387 #define arch_irn_has_reg_class(env, irn, pos, cls) \
388 ((cls) == arch_get_irn_reg_class(env, irn, pos))
390 #define arch_irn_consider_in_reg_alloc(env, cls, irn) \
391 (arch_irn_has_reg_class(env, irn, -1, cls) && !arch_irn_is_ignore(env, irn))
394 * Somebody who can be asked about nodes.
396 struct _arch_irn_handler_t {
399 * Get the operations of an irn.
400 * @param self The handler from which the method is invoked.
401 * @param irn Some node.
402 * @return Operations for that irn.
404 const void *(*get_irn_ops)(const arch_irn_handler_t *handler,
410 * The code generator.
412 struct _arch_code_generator_if_t {
416 * Initialize the code generator.
417 * @param file The file to dump to.
418 * @param birg A backend IRG session.
419 * @return A newly created code generator.
421 void *(*init)(FILE *file, const be_irg_t *birg);
424 * Called before abi introduce.
426 void (*before_abi)(void *self);
429 * Called, when the graph is being normalized.
431 void (*prepare_graph)(void *self);
434 * Called before scheduling.
436 void (*before_sched)(void *self);
439 * Called before register allocation.
441 void (*before_ra)(void *self);
444 * Called after register allocation.
446 void (*after_ra)(void *self);
449 * Called after everything happened.
450 * The code generator must also be de-allocated here.
452 void (*done)(void *self);
456 #define _arch_cg_call(cg, func) \
458 if((cg)->impl->func) \
459 (cg)->impl->func(cg); \
462 #define arch_code_generator_before_abi(cg) _arch_cg_call(cg, before_abi)
463 #define arch_code_generator_prepare_graph(cg) _arch_cg_call(cg, prepare_graph)
464 #define arch_code_generator_before_sched(cg) _arch_cg_call(cg, before_sched)
465 #define arch_code_generator_before_ra(cg) _arch_cg_call(cg, before_ra)
466 #define arch_code_generator_after_ra(cg) _arch_cg_call(cg, after_ra)
467 #define arch_code_generator_done(cg) _arch_cg_call(cg, done)
470 * Code generator base class.
472 struct _arch_code_generator_t {
473 const arch_code_generator_if_t *impl;
480 const arch_isa_if_t *impl;
481 const arch_register_t *sp; /** The stack pointer register. */
482 const arch_register_t *bp; /** The base pointer register. */
483 const int stack_dir; /** -1 for decreasing, 1 for increasing. */
486 #define arch_isa_stack_dir(isa) ((isa)->stack_dir)
487 #define arch_isa_sp(isa) ((isa)->sp)
488 #define arch_isa_bp(isa) ((isa)->bp)
491 * Architecture interface.
493 struct _arch_isa_if_t {
496 void (*register_options)(lc_opt_entry_t *grp);
500 * Initialize the isa interface.
505 * Free the isa instance.
507 void (*done)(void *self);
510 * Get the the number of register classes in the isa.
511 * @return The number of register classes.
513 int (*get_n_reg_class)(const void *self);
516 * Get the i-th register class.
517 * @param i The number of the register class.
518 * @return The register class.
520 const arch_register_class_t *(*get_reg_class)(const void *self, int i);
523 * Get the register class which shall be used to store a value of a given mode.
524 * @param self The this pointer.
525 * @param mode The mode in question.
526 * @return A register class which can hold values of the given mode.
528 const arch_register_class_t *(*get_reg_class_for_mode)(const void *self, const ir_mode *mode);
531 * Get the ABI restrictions for procedure calls.
532 * @param self The this pointer.
533 * @param method_type The type of the method (procedure) in question.
534 * @param p The array of parameter locations to be filled.
536 void (*get_call_abi)(const void *self, ir_type *method_type, be_abi_call_t *abi);
539 * The irn handler for this architecture.
540 * The irn handler is registered by the Firm back end
541 * when the architecture is initialized.
544 const arch_irn_handler_t *(*get_irn_handler)(const void *self);
547 * Get the code generator interface.
548 * @param self The this pointer.
549 * @return Some code generator interface.
551 const arch_code_generator_if_t *(*get_code_generator_if)(void *self);
554 * Get the list scheduler to use.
555 * @param self The isa object.
556 * @return The list scheduler selector.
558 const list_sched_selector_t *(*get_list_sched_selector)(const void *self);
562 #define arch_isa_get_n_reg_class(isa) ((isa)->impl->get_n_reg_class(isa))
563 #define arch_isa_get_reg_class(isa,i) ((isa)->impl->get_reg_class(isa, i))
564 #define arch_isa_get_irn_handler(isa) ((isa)->impl->get_irn_handler(isa))
565 #define arch_isa_get_call_abi(isa,tp,abi) ((isa)->impl->get_call_abi((isa), (tp), (abi)))
566 #define arch_isa_get_reg_class_for_mode(isa,mode) ((isa)->impl->get_reg_class_for_mode((isa), (mode)))
567 #define arch_isa_make_code_generator(isa,irg) ((isa)->impl->make_code_generator(isa, irg))
569 #define ARCH_MAX_HANDLERS 8
572 * Environment for the architecture infrastructure.
573 * Keep this everywhere you're going.
576 const struct _be_node_factory_t *node_factory; /**< The node factory for be nodes. */
577 arch_isa_t *isa; /**< The isa about which everything is. */
579 arch_irn_handler_t const *handlers[ARCH_MAX_HANDLERS]; /**< The handlers are organized as
582 int handlers_tos; /**< The stack pointer of the handler
587 * Get the isa of an arch environment.
588 * @param env The environment.
589 * @return The isa with which the env was initialized with.
591 #define arch_env_get_isa(env) ((env)->isa)
594 * Initialize the architecture environment struct.
595 * @param isa The isa which shall be put into the environment.
596 * @return The environment.
598 extern arch_env_t *arch_env_init(arch_env_t *env, const arch_isa_if_t *isa);
601 * Add a node handler to the environment.
602 * @param env The environment.
603 * @param handler A node handler.
604 * @return The environment itself.
606 extern arch_env_t *arch_env_push_irn_handler(arch_env_t *env, const arch_irn_handler_t *handler);
609 * Remove a node handler from the handler stack.
610 * @param env The architecture environment.
611 * @return The popped handler.
613 extern const arch_irn_handler_t *arch_env_pop_irn_handler(arch_env_t *env);
615 #endif /* _FIRM_BEARCH_H */