2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Processor architecture specification.
23 * @author Sebastian Hack
26 #ifndef FIRM_BE_BEARCH_H
27 #define FIRM_BE_BEARCH_H
31 #include "firm_types.h"
34 #include "raw_bitset.h"
43 typedef enum arch_register_class_flags_t {
44 arch_register_class_flag_none = 0,
45 /** don't do automatic register allocation for this class */
46 arch_register_class_flag_manual_ra = 1U << 0,
47 /** the register models an abstract state (example: fpu rounding mode) */
48 arch_register_class_flag_state = 1U << 1
49 } arch_register_class_flags_t;
51 typedef enum arch_register_type_t {
52 arch_register_type_none = 0,
53 /** The register must be saved by the caller upon a function call. It thus
54 * can be overwritten in the called function. */
55 arch_register_type_caller_save = 1U << 0,
56 /** The register must be saved by the caller upon a function call. It thus
57 * can be overwritten in the called function. */
58 arch_register_type_callee_save = 1U << 1,
59 /** Do not consider this register when allocating. */
60 arch_register_type_ignore = 1U << 2,
61 /** The emitter can choose an arbitrary register. The register fulfills any
62 * register constraints as long as the register class matches */
63 arch_register_type_joker = 1U << 3,
64 /** This is just a virtual register. Virtual registers fulfill any register
65 * constraints as long as the register class matches. It is a allowed to
66 * have multiple definitions for the same virtual register at a point */
67 arch_register_type_virtual = 1U << 4,
68 /** The register represents a state that should be handled by bestate
70 arch_register_type_state = 1U << 5,
71 } arch_register_type_t;
74 * Different types of register allocation requirements.
76 typedef enum arch_register_req_type_t {
77 /** No register requirement. */
78 arch_register_req_type_none = 0,
79 /** All registers in the class are allowed. */
80 arch_register_req_type_normal = 1U << 0,
81 /** Only a real subset of the class is allowed. */
82 arch_register_req_type_limited = 1U << 1,
83 /** The register should be equal to another one at the node. */
84 arch_register_req_type_should_be_same = 1U << 2,
85 /** The register must be unequal from some other at the node. */
86 arch_register_req_type_must_be_different = 1U << 3,
87 /** The registernumber should be aligned (in case of multiregister values)*/
88 arch_register_req_type_aligned = 1U << 4,
89 /** ignore while allocating registers */
90 arch_register_req_type_ignore = 1U << 5,
91 /** the output produces a new value for the stack pointer
92 * (this is not really a constraint but a marker to guide the stackpointer
94 arch_register_req_type_produces_sp = 1U << 6,
95 } arch_register_req_type_t;
97 extern const arch_register_req_t *arch_no_register_req;
100 * Print information about a register requirement in human readable form
101 * @param F output stream/file
102 * @param req The requirements structure to format.
104 void arch_dump_register_req(FILE *F, const arch_register_req_t *req,
105 const ir_node *node);
107 void arch_dump_register_reqs(FILE *F, const ir_node *node);
108 void arch_dump_reqs_and_registers(FILE *F, const ir_node *node);
111 * Node classification. Used for statistics and for detecting reload nodes.
113 typedef enum arch_irn_class_t {
114 arch_irn_class_spill = 1 << 0,
115 arch_irn_class_reload = 1 << 1,
116 arch_irn_class_remat = 1 << 2,
117 arch_irn_class_copy = 1 << 3,
118 arch_irn_class_perm = 1 << 4
121 void arch_set_frame_offset(ir_node *irn, int bias);
123 ir_entity *arch_get_frame_entity(const ir_node *irn);
124 int arch_get_sp_bias(ir_node *irn);
126 int arch_get_op_estimated_cost(const ir_node *irn);
127 arch_inverse_t *arch_get_inverse(const ir_node *irn, int i,
128 arch_inverse_t *inverse,
129 struct obstack *obstack);
130 int arch_possible_memory_operand(const ir_node *irn,
132 void arch_perform_memory_operand(ir_node *irn, ir_node *spill,
136 * Get the register requirements for a node.
137 * @note Deprecated API! Preferably use
138 * arch_get_in_register_req and
139 * arch_get_out_register_req.
141 * @param irn The node.
142 * @param pos The position of the operand you're interested in.
143 * @return A pointer to the register requirements. If NULL is returned, the
144 * operand was no register operand.
146 const arch_register_req_t *arch_get_register_req(const ir_node *irn, int pos);
149 * Put all registers which shall not be ignored by the register
150 * allocator in a bit set.
151 * @param cls The register class to consider.
152 * @param bs The bit set to put the registers to.
154 extern void arch_put_non_ignore_regs(const arch_register_class_t *cls,
158 * Check, if a register is assignable to an operand of a node.
159 * @param irn The node.
160 * @param pos The position of the operand.
161 * @param reg The register.
162 * @return 1, if the register might be allocated to the operand 0 if not.
164 int arch_reg_is_allocatable(const ir_node *irn, int pos,
165 const arch_register_t *reg);
167 #define arch_reg_out_is_allocatable(irn, reg) arch_reg_is_allocatable(irn, -1, reg)
170 * Get the register class of an operand of a node.
171 * @param irn The node.
172 * @param pos The position of the operand, -1 for the output.
173 * @return The register class of the operand or NULL, if
174 * operand is a non-register operand.
176 const arch_register_class_t *arch_get_irn_reg_class(const ir_node *irn,
179 #define arch_get_irn_reg_class_out(irn) arch_get_irn_reg_class(irn, -1)
182 * Get the register allocated at a certain output operand of a node.
183 * @param irn The node.
184 * @return The register allocated for this operand
186 const arch_register_t *arch_get_irn_register(const ir_node *irn);
187 const arch_register_t *arch_irn_get_register(const ir_node *irn, int pos);
190 * Set the register for a certain output operand.
191 * @param irn The node.
192 * @param reg The register.
194 void arch_set_irn_register(ir_node *irn, const arch_register_t *reg);
195 void arch_irn_set_register(ir_node *irn, int pos, const arch_register_t *reg);
199 * @param irn The node.
200 * @return A classification of the node.
202 arch_irn_class_t arch_irn_classify(const ir_node *irn);
205 * Get the flags of a node.
206 * @param irn The node.
209 arch_irn_flags_t arch_irn_get_flags(const ir_node *irn);
211 void arch_irn_set_flags(ir_node *node, arch_irn_flags_t flags);
212 void arch_irn_add_flags(ir_node *node, arch_irn_flags_t flags);
214 #define arch_irn_is(irn, flag) ((arch_irn_get_flags(irn) & arch_irn_flags_ ## flag) != 0)
217 * Get the operations of an irn.
218 * @param self The handler from which the method is invoked.
219 * @param irn Some node.
220 * @return Operations for that irn.
222 typedef const void *(arch_get_irn_ops_t)(const ir_node *irn);
225 * Initialize the architecture environment struct.
226 * @param isa The isa which shall be put into the environment.
227 * @param file_handle The file handle
228 * @return The environment.
230 extern arch_env_t *arch_env_init(const arch_isa_if_t *isa,
231 FILE *file_handle, be_main_env_t *main_env);
234 * Register an instruction set architecture
236 void be_register_isa_if(const char *name, const arch_isa_if_t *isa);
241 struct arch_register_t {
242 const char *name; /**< The name of the register. */
243 const arch_register_class_t *reg_class; /**< The class of the register */
244 unsigned index; /**< The index of the register in
246 arch_register_type_t type; /**< The type of the register. */
247 /** register constraint allowing just this register */
248 const arch_register_req_t *single_req;
251 static inline const arch_register_class_t *arch_register_get_class(
252 const arch_register_t *reg)
254 return reg->reg_class;
257 static inline unsigned arch_register_get_index(const arch_register_t *reg)
262 static inline const char *arch_register_get_name(const arch_register_t *reg)
268 * Convenience macro to check for register type.
269 * @param req A pointer to register.
270 * @param kind The kind of type to check for (see arch_register_type_t).
271 * @return 1, If register is of given kind, 0 if not.
273 #define arch_register_type_is(reg, kind) \
274 (((reg)->type & arch_register_type_ ## kind) != 0)
277 * A class of registers.
278 * Like general purpose or floating point.
280 struct arch_register_class_t {
281 unsigned index; /**< index of this register class */
282 const char *name; /**< The name of the register class.*/
283 unsigned n_regs; /**< Number of registers in this
285 ir_mode *mode; /**< The mode of the register class.*/
286 const arch_register_t *regs; /**< The array of registers. */
287 arch_register_class_flags_t flags; /**< register class flags. */
288 const arch_register_req_t *class_req;
291 /** return the number of registers in this register class */
292 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
294 /** return the largest mode of this register class */
295 #define arch_register_class_mode(cls) ((cls)->mode)
297 /** return the name of this register class */
298 #define arch_register_class_name(cls) ((cls)->name)
300 /** return the index of this register class */
301 #define arch_register_class_index(cls) ((cls)->index)
303 /** return the register class flags */
304 #define arch_register_class_flags(cls) ((cls)->flags)
306 static inline const arch_register_t *arch_register_for_index(
307 const arch_register_class_t *cls, unsigned idx)
309 assert(idx < cls->n_regs);
310 return &cls->regs[idx];
314 * Convenience macro to check for set constraints.
315 * @param req A pointer to register requirements.
316 * @param kind The kind of constraint to check for
317 * (see arch_register_req_type_t).
318 * @return 1, If the kind of constraint is present, 0 if not.
320 #define arch_register_req_is(req, kind) \
321 (((req)->type & (arch_register_req_type_ ## kind)) != 0)
324 * Expresses requirements to register allocation for an operand.
326 struct arch_register_req_t {
327 arch_register_req_type_t type; /**< The type of the constraint. */
328 const arch_register_class_t *cls; /**< The register class this constraint
330 const unsigned *limited; /**< allowed register bitset */
331 unsigned other_same; /**< Bitmask of ins which should use the
332 same register (should_be_same). */
333 unsigned other_different; /**< Bitmask of ins which shall use a
335 (must_be_different) */
336 unsigned char width; /**< specifies how many sequential
337 registers are required */
340 static inline int reg_reqs_equal(const arch_register_req_t *req1,
341 const arch_register_req_t *req2)
346 if (req1->type != req2->type
347 || req1->cls != req2->cls
348 || req1->other_same != req2->other_same
349 || req1->other_different != req2->other_different)
352 if (req1->limited != NULL) {
355 if (req2->limited == NULL)
358 n_regs = arch_register_class_n_regs(req1->cls);
359 if (!rbitsets_equal(req1->limited, req2->limited, n_regs))
367 * An inverse operation returned by the backend
369 struct arch_inverse_t {
370 int n; /**< count of nodes returned in nodes array */
371 int costs; /**< costs of this remat */
373 /** nodes for this inverse operation. shall be in schedule order.
374 * last element is the target value */
378 struct arch_irn_ops_t {
382 * @param irn The node.
383 * @return A classification.
385 arch_irn_class_t (*classify)(const ir_node *irn);
388 * Get the entity on the stack frame this node depends on.
389 * @param irn The node in question.
390 * @return The entity on the stack frame or NULL, if the node does not have
391 * a stack frame entity.
393 ir_entity *(*get_frame_entity)(const ir_node *irn);
396 * Set the offset of a node carrying an entity on the stack frame.
397 * @param irn The node.
398 * @param offset The offset of the node's stack frame entity.
400 void (*set_frame_offset)(ir_node *irn, int offset);
403 * Returns the delta of the stackpointer for nodes that increment or
404 * decrement the stackpointer with a constant value. (push, pop
405 * nodes on most architectures).
406 * A positive value stands for an expanding stack area, a negative value for
409 * @param irn The node
410 * @return 0 if the stackpointer is not modified with a constant
411 * value, otherwise the increment/decrement value
413 int (*get_sp_bias)(const ir_node *irn);
416 * Returns an inverse operation which yields the i-th argument
417 * of the given node as result.
419 * @param irn The original operation
420 * @param i Index of the argument we want the inverse operation to
422 * @param inverse struct to be filled with the resulting inverse op
423 * @param obstack The obstack to use for allocation of the returned nodes
425 * @return The inverse operation or NULL if operation invertible
427 arch_inverse_t *(*get_inverse)(const ir_node *irn, int i,
428 arch_inverse_t *inverse,
429 struct obstack *obstack);
432 * Get the estimated cycle count for @p irn.
434 * @param irn The node.
435 * @return The estimated cycle count for this operation
437 int (*get_op_estimated_cost)(const ir_node *irn);
440 * Asks the backend whether operand @p i of @p irn can be loaded form memory
443 * @param irn The node.
444 * @param i Index of the argument we would like to know whether @p irn
445 * can load it form memory internally
446 * @return nonzero if argument can be loaded or zero otherwise
448 int (*possible_memory_operand)(const ir_node *irn, unsigned int i);
451 * Ask the backend to assimilate @p reload of operand @p i into @p irn.
453 * @param irn The node.
454 * @param spill The spill.
455 * @param i The position of the reload.
457 void (*perform_memory_operand)(ir_node *irn, ir_node *spill,
462 * Architecture interface.
464 struct arch_isa_if_t {
466 * Initialize the isa interface.
467 * @param file_handle the file handle to write the output to
468 * @return a new isa instance
470 arch_env_t *(*init)(FILE *file_handle);
473 * Free the isa instance.
475 void (*done)(void *self);
478 * Called directly after initialization. Backend should handle all
481 void (*handle_intrinsics)(void);
484 * Get the the number of register classes in the isa.
485 * @return The number of register classes.
487 unsigned (*get_n_reg_class)(void);
490 * Get the i-th register class.
491 * @param i The number of the register class.
492 * @return The register class.
494 const arch_register_class_t *(*get_reg_class)(unsigned i);
497 * Get the register class which shall be used to store a value of a given
499 * @param self The this pointer.
500 * @param mode The mode in question.
501 * @return A register class which can hold values of the given mode.
503 const arch_register_class_t *(*get_reg_class_for_mode)(const ir_mode *mode);
506 * Get the ABI restrictions for procedure calls.
507 * @param self The this pointer.
508 * @param call_type The call type of the method (procedure) in question.
509 * @param p The array of parameter locations to be filled.
511 void (*get_call_abi)(const void *self, ir_type *call_type,
515 * Get the necessary alignment for storing a register of given class.
516 * @param self The isa object.
517 * @param cls The register class.
518 * @return The alignment in bytes.
520 int (*get_reg_class_alignment)(const arch_register_class_t *cls);
523 * A "static" function, returns the frontend settings
524 * needed for this backend.
526 const backend_params *(*get_params)(void);
529 * Return an ordered list of irgs where code should be generated for.
530 * If NULL is returned, all irg will be taken into account and they will be
531 * generated in an arbitrary order.
532 * @param self The isa object.
533 * @param irgs A flexible array ARR_F of length 0 where the backend can
534 * append the desired irgs.
535 * @return A flexible array ARR_F containing all desired irgs in the
538 ir_graph **(*get_backend_irg_list)(const void *self, ir_graph ***irgs);
541 * mark node as rematerialized
543 void (*mark_remat)(ir_node *node);
546 * parse an assembler constraint part and set flags according to its nature
547 * advances the *c pointer to point to the last parsed character (so if you
548 * parse a single character don't advance c)
550 asm_constraint_flags_t (*parse_asm_constraint)(const char **c);
553 * returns true if the string is a valid clobbered (register) in this
556 int (*is_valid_clobber)(const char *clobber);
559 * Initialize the code generator.
561 * @return A newly created code generator.
563 void (*init_graph)(ir_graph *irg);
566 * return node used as base in pic code addresses
568 ir_node* (*get_pic_base)(ir_graph *irg);
571 * Called before abi introduce.
573 void (*before_abi)(ir_graph *irg);
576 * Called, when the graph is being normalized.
578 void (*prepare_graph)(ir_graph *irg);
581 * Called before register allocation.
583 void (*before_ra)(ir_graph *irg);
586 * Called after register allocation.
588 void (*after_ra)(ir_graph *irg);
591 * Called directly before done is called. This should be the last place
592 * where the irg is modified.
594 void (*finish)(ir_graph *irg);
597 * Called after everything happened. This call should emit the final
598 * assembly code but avoid changing the irg.
599 * The code generator must also be de-allocated here.
601 void (*emit)(ir_graph *irg);
604 #define arch_env_done(env) ((env)->impl->done(env))
605 #define arch_env_handle_intrinsics(env) \
606 do { if((env)->impl->handle_intrinsics != NULL) (env)->impl->handle_intrinsics(); } while(0)
607 #define arch_env_get_n_reg_class(env) ((env)->impl->get_n_reg_class())
608 #define arch_env_get_reg_class(env,i) ((env)->impl->get_reg_class(i))
609 #define arch_env_get_reg_class_for_mode(env,mode) ((env)->impl->get_reg_class_for_mode((mode)))
610 #define arch_env_get_call_abi(env,tp,abi) ((env)->impl->get_call_abi((env), (tp), (abi)))
611 #define arch_env_get_reg_class_alignment(env,cls) ((env)->impl->get_reg_class_alignment((cls)))
612 #define arch_env_get_params(env) ((env)->impl->get_params())
613 #define arch_env_get_allowed_execution_units(env,irn) ((env)->impl->get_allowed_execution_units((irn)))
614 #define arch_env_get_machine(env) ((env)->impl->get_machine(env))
615 #define arch_env_get_backend_irg_list(env,irgs) ((env)->impl->get_backend_irg_list((env), (irgs)))
616 #define arch_env_parse_asm_constraint(env,c) ((env)->impl->parse_asm_constraint((c))
617 #define arch_env_is_valid_clobber(env,clobber) ((env)->impl->is_valid_clobber((clobber))
618 #define arch_env_mark_remat(env,node) \
619 do { if ((env)->impl->mark_remat != NULL) (env)->impl->mark_remat((node)); } while(0)
625 const arch_isa_if_t *impl;
626 const arch_register_t *sp; /**< The stack pointer register. */
627 const arch_register_t *bp; /**< The base pointer register. */
628 const arch_register_class_t *link_class; /**< The static link pointer
630 int stack_dir; /**< -1 for decreasing, 1 for
632 int stack_alignment; /**< power of 2 stack alignment */
633 const be_main_env_t *main_env; /**< the be main environment */
634 int spill_cost; /**< cost for a be_Spill node */
635 int reload_cost; /**< cost for a be_Reload node */
636 bool custom_abi : 1; /**< backend does all abi handling
637 and does not need the generic stuff
641 static inline unsigned arch_irn_get_n_outs(const ir_node *node)
643 backend_info_t *info = be_get_info(node);
644 if (info->out_infos == NULL)
647 return ARR_LEN(info->out_infos);
650 static inline const arch_irn_ops_t *get_irn_ops_simple(const ir_node *node)
652 const ir_op *ops = get_irn_op(node);
653 const arch_irn_ops_t *be_ops = get_op_ops(ops)->be_ops;
654 assert(!is_Proj(node));
658 static inline const arch_register_req_t *arch_get_register_req_out(
662 backend_info_t *info;
664 /* you have to query the Proj nodes for the constraints (or use
665 * arch_get_out_register_req. Querying a mode_T node and expecting
666 * arch_no_register_req is a bug in your code! */
667 assert(get_irn_mode(irn) != mode_T);
670 pos = get_Proj_proj(irn);
671 irn = get_Proj_pred(irn);
674 info = be_get_info(irn);
675 if (info->out_infos == NULL)
676 return arch_no_register_req;
678 return info->out_infos[pos].req;
681 static inline bool arch_irn_is_ignore(const ir_node *irn)
683 const arch_register_req_t *req = arch_get_register_req_out(irn);
684 return !!(req->type & arch_register_req_type_ignore);
687 static inline bool arch_irn_consider_in_reg_alloc(
688 const arch_register_class_t *cls, const ir_node *node)
690 const arch_register_req_t *req = arch_get_register_req_out(node);
693 !(req->type & arch_register_req_type_ignore);
697 * Get register constraints for an operand at position @p
699 static inline const arch_register_req_t *arch_get_in_register_req(
700 const ir_node *node, int pos)
702 const backend_info_t *info = be_get_info(node);
703 if (info->in_reqs == NULL)
704 return arch_no_register_req;
705 return info->in_reqs[pos];
709 * Get register constraint for a produced result (the @p pos result)
711 static inline const arch_register_req_t *arch_get_out_register_req(
712 const ir_node *node, int pos)
714 const backend_info_t *info = be_get_info(node);
715 if (info->out_infos == NULL)
716 return arch_no_register_req;
717 return info->out_infos[pos].req;
720 static inline void arch_set_out_register_req(ir_node *node, int pos,
721 const arch_register_req_t *req)
723 backend_info_t *info = be_get_info(node);
724 assert(pos < (int) arch_irn_get_n_outs(node));
725 info->out_infos[pos].req = req;
728 static inline void arch_set_in_register_reqs(ir_node *node,
729 const arch_register_req_t **in_reqs)
731 backend_info_t *info = be_get_info(node);
732 info->in_reqs = in_reqs;
735 static inline const arch_register_req_t **arch_get_in_register_reqs(
738 backend_info_t *info = be_get_info(node);
739 return info->in_reqs;
743 * Iterate over all values defined by an instruction.
744 * Only looks at values in a certain register class where the requirements
745 * are not marked as ignore.
746 * Executes @p code for each definition.
748 #define be_foreach_definition_(node, cls, value, code) \
750 if (get_irn_mode(node) == mode_T) { \
751 const ir_edge_t *edge_; \
752 foreach_out_edge(node, edge_) { \
753 const arch_register_req_t *req_; \
754 value = get_edge_src_irn(edge_); \
755 req_ = arch_get_register_req_out(value); \
756 if (req_->cls != cls) \
761 const arch_register_req_t *req_ = arch_get_register_req_out(node); \
763 if (req_->cls == cls) { \
769 #define be_foreach_definition(node, cls, value, code) \
770 be_foreach_definition_(node, cls, value, \
771 if (req_->type & arch_register_req_type_ignore) \