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"
42 typedef enum arch_register_class_flags_t {
43 arch_register_class_flag_none = 0,
44 arch_register_class_flag_manual_ra = 1, /**< don't do automatic register allocation for this class */
45 arch_register_class_flag_state = 2
46 } arch_register_class_flags_t;
48 typedef enum arch_register_type_t {
49 arch_register_type_none = 0,
50 arch_register_type_caller_save = 1, /**< The register must be saved by the caller
51 upon a function call. It thus can be overwritten
52 in the called function. */
53 arch_register_type_callee_save = 2, /**< The register must be saved by the caller
54 upon a function call. It thus can be overwritten
55 in the called function. */
56 arch_register_type_ignore = 4, /**< Do not consider this register when allocating. */
57 arch_register_type_joker = 8, /**< The emitter can choose an arbitrary register */
58 arch_register_type_virtual = 16, /**< This is just a virtual register.Virtual registers have
59 nearly no constraints, it is a allowed to have multiple
60 definition for the same register at a point) */
61 arch_register_type_state = 32, /**< The register represents a state that should be handled by
63 } arch_register_type_t;
66 * Different types of register allocation requirements.
68 typedef enum arch_register_req_type_t {
69 arch_register_req_type_none = 0, /**< No register requirement. */
70 arch_register_req_type_normal = 1U << 0, /**< All registers in the class are allowed. */
71 arch_register_req_type_limited = 1U << 1, /**< Only a real subset of the class is allowed. */
72 arch_register_req_type_should_be_same = 1U << 2, /**< The register should be equal to another one at the node. */
73 arch_register_req_type_must_be_different = 1U << 3, /**< The register must be unequal from some other at the node. */
74 arch_register_req_type_ignore = 1U << 4, /**< ignore while allocating registers */
75 arch_register_req_type_produces_sp = 1U << 5, /**< the output produces a new value for the stack pointer */
76 } arch_register_req_type_t;
78 extern const arch_register_req_t *arch_no_register_req;
81 * Print information about a register requirement in human readable form
82 * @param F output stream/file
83 * @param req The requirements structure to format.
85 void arch_dump_register_req(FILE *F, const arch_register_req_t *req,
89 * Node classification. Mainly used for statistics.
91 typedef enum arch_irn_class_t {
92 arch_irn_class_spill = 1 << 0,
93 arch_irn_class_reload = 1 << 1,
94 arch_irn_class_remat = 1 << 2,
95 arch_irn_class_copy = 1 << 3,
96 arch_irn_class_perm = 1 << 4
99 void arch_set_frame_offset(ir_node *irn, int bias);
101 ir_entity *arch_get_frame_entity(const ir_node *irn);
102 void arch_set_frame_entity(ir_node *irn, ir_entity *ent);
103 int arch_get_sp_bias(ir_node *irn);
105 int arch_get_op_estimated_cost(const ir_node *irn);
106 arch_inverse_t *arch_get_inverse(const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack);
107 int arch_possible_memory_operand(const ir_node *irn, unsigned int i);
108 void arch_perform_memory_operand(ir_node *irn, ir_node *spill, unsigned int i);
111 * Get the register requirements for a node.
112 * @note Deprecated API! Preferably use
113 * arch_get_in_register_req and
114 * arch_get_out_register_req.
116 * @param irn The node.
117 * @param pos The position of the operand you're interested in.
118 * @return A pointer to the register requirements. If NULL is returned, the
119 * operand was no register operand.
121 const arch_register_req_t *arch_get_register_req(const ir_node *irn, int pos);
122 const arch_register_req_t *arch_get_register_req_out(const ir_node *irn);
125 * Put all registers which shall not be ignored by the register
126 * allocator in a bit set.
127 * @param cls The register class to consider.
128 * @param bs The bit set to put the registers to.
130 extern void arch_put_non_ignore_regs(const arch_register_class_t *cls, bitset_t *bs);
133 * Check, if a register is assignable to an operand of a node.
134 * @param irn The node.
135 * @param pos The position of the operand.
136 * @param reg The register.
137 * @return 1, if the register might be allocated to the operand 0 if not.
139 int arch_reg_is_allocatable(const ir_node *irn, int pos, const arch_register_t *reg);
141 #define arch_reg_out_is_allocatable(irn, reg) arch_reg_is_allocatable(irn, -1, reg)
144 * Get the register class of an operand of a node.
145 * @param irn The node.
146 * @param pos The position of the operand, -1 for the output.
147 * @return The register class of the operand or NULL, if
148 * operand is a non-register operand.
150 const arch_register_class_t *arch_get_irn_reg_class(const ir_node *irn, int pos);
152 #define arch_get_irn_reg_class_out(irn) arch_get_irn_reg_class(irn, -1)
155 * Get the register allocated at a certain output operand of a node.
156 * @param irn The node.
157 * @return The register allocated for this operand
159 const arch_register_t *arch_get_irn_register(const ir_node *irn);
160 const arch_register_t *arch_irn_get_register(const ir_node *irn, int pos);
163 * Set the register for a certain output operand.
164 * @param irn The node.
165 * @param reg The register.
167 void arch_set_irn_register(ir_node *irn, const arch_register_t *reg);
168 void arch_irn_set_register(ir_node *irn, int pos, const arch_register_t *reg);
172 * @param irn The node.
173 * @return A classification of the node.
175 arch_irn_class_t arch_irn_classify(const ir_node *irn);
177 #define arch_irn_class_is(irn, irn_class) ((arch_irn_classify(irn) & arch_irn_class_ ## irn_class) != 0)
180 * Get the flags of a node.
181 * @param irn The node.
184 arch_irn_flags_t arch_irn_get_flags(const ir_node *irn);
186 void arch_irn_set_flags(ir_node *node, arch_irn_flags_t flags);
187 void arch_irn_add_flags(ir_node *node, arch_irn_flags_t flags);
189 #define arch_irn_is(irn, flag) ((arch_irn_get_flags(irn) & arch_irn_flags_ ## flag) != 0)
192 * Get the operations of an irn.
193 * @param self The handler from which the method is invoked.
194 * @param irn Some node.
195 * @return Operations for that irn.
197 typedef const void *(arch_get_irn_ops_t)(const ir_node *irn);
200 * Initialize the architecture environment struct.
201 * @param isa The isa which shall be put into the environment.
202 * @param file_handle The file handle
203 * @return The environment.
205 extern arch_env_t *arch_env_init(const arch_isa_if_t *isa,
206 FILE *file_handle, be_main_env_t *main_env);
209 * Register an instruction set architecture
211 void be_register_isa_if(const char *name, const arch_isa_if_t *isa);
216 struct arch_register_t {
217 const char *name; /**< The name of the register. */
218 const arch_register_class_t *reg_class; /**< The class the register belongs to. */
219 unsigned index; /**< The index of the register in the class. */
220 arch_register_type_t type; /**< The type of the register. */
223 static inline const arch_register_class_t *
224 _arch_register_get_class(const arch_register_t *reg)
226 return reg->reg_class;
230 unsigned _arch_register_get_index(const arch_register_t *reg)
236 const char *_arch_register_get_name(const arch_register_t *reg)
241 #define arch_register_get_class(reg) _arch_register_get_class(reg)
242 #define arch_register_get_index(reg) _arch_register_get_index(reg)
243 #define arch_register_get_name(reg) _arch_register_get_name(reg)
246 * Convenience macro to check for register type.
247 * @param req A pointer to register.
248 * @param kind The kind of type to check for (see arch_register_type_t).
249 * @return 1, If register is of given kind, 0 if not.
251 #define arch_register_type_is(reg, kind) \
252 (((reg)->type & arch_register_type_ ## kind) != 0)
255 * A class of registers.
256 * Like general purpose or floating point.
258 struct arch_register_class_t {
259 unsigned index; /**< index of this register class */
260 const char *name; /**< The name of the register class.*/
261 unsigned n_regs; /**< Number of registers in this
263 ir_mode *mode; /**< The mode of the register class.*/
264 const arch_register_t *regs; /**< The array of registers. */
265 arch_register_class_flags_t flags; /**< register class flags. */
268 /** return the number of registers in this register class */
269 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
271 /** return the largest mode of this register class */
272 #define arch_register_class_mode(cls) ((cls)->mode)
274 /** return the name of this register class */
275 #define arch_register_class_name(cls) ((cls)->name)
277 /** return the index of this register class */
278 #define arch_register_class_index(cls) ((cls)->index)
280 /** return the register class flags */
281 #define arch_register_class_flags(cls) ((cls)->flags)
283 static inline const arch_register_t *
284 _arch_register_for_index(const arch_register_class_t *cls, unsigned idx)
286 assert(idx < cls->n_regs);
287 return &cls->regs[idx];
290 #define arch_register_for_index(cls, idx) _arch_register_for_index(cls, idx)
293 * Convenience macro to check for set constraints.
294 * @param req A pointer to register requirements.
295 * @param kind The kind of constraint to check for (see arch_register_req_type_t).
296 * @return 1, If the kind of constraint is present, 0 if not.
298 #define arch_register_req_is(req, kind) \
299 (((req)->type & (arch_register_req_type_ ## kind)) != 0)
302 * Expresses requirements to register allocation for an operand.
304 struct arch_register_req_t {
305 arch_register_req_type_t type; /**< The type of the constraint. */
306 const arch_register_class_t *cls; /**< The register class this constraint belongs to. */
308 const unsigned *limited; /**< allowed register bitset */
310 unsigned other_same; /**< Bitmask of ins which should use the
311 same register (should_be_same). */
312 unsigned other_different; /**< Bitmask of ins which shall use a
314 (must_be_different) */
317 static inline int reg_reqs_equal(const arch_register_req_t *req1,
318 const arch_register_req_t *req2)
323 if (req1->type != req2->type
324 || req1->cls != req2->cls
325 || req1->other_same != req2->other_same
326 || req1->other_different != req2->other_different)
329 if (req1->limited != NULL) {
332 if (req2->limited == NULL)
335 n_regs = arch_register_class_n_regs(req1->cls);
336 if (!rbitset_equal(req1->limited, req2->limited, n_regs))
344 * An inverse operation returned by the backend
346 struct arch_inverse_t {
347 int n; /**< count of nodes returned in nodes array */
348 int costs; /**< costs of this remat */
350 /**< nodes for this inverse operation. shall be in
351 * schedule order. last element is the target value
356 struct arch_irn_ops_t {
359 * Get the register requirements for a given operand.
360 * @param irn The node.
361 * @param pos The operand's position
362 * @return The register requirements for the selected operand.
363 * The pointer returned is never NULL.
365 const arch_register_req_t *(*get_irn_reg_req_in)(const ir_node *irn, int pos);
368 * Get the register requirements for values produced by a node
369 * @param irn The node.
370 * @param pos The operand's position (0 for most nodes,
371 * 0..n for mode_T nodes)
372 * @return The register requirements for the selected operand.
373 * The pointer returned is never NULL.
375 const arch_register_req_t *(*get_irn_reg_req_out)(const ir_node *irn, int pos);
379 * @param irn The node.
380 * @return A classification.
382 arch_irn_class_t (*classify)(const ir_node *irn);
385 * Get the entity on the stack frame this node depends on.
386 * @param irn The node in question.
387 * @return The entity on the stack frame or NULL, if the node does not have a
388 * stack frame entity.
390 ir_entity *(*get_frame_entity)(const ir_node *irn);
393 * Set the entity on the stack frame this node depends on.
394 * @param irn The node in question.
395 * @param ent The entity to set
397 void (*set_frame_entity)(ir_node *irn, ir_entity *ent);
400 * Set the offset of a node carrying an entity on the stack frame.
401 * @param irn The node.
402 * @param offset The offset of the node's stack frame entity.
404 void (*set_frame_offset)(ir_node *irn, int offset);
407 * Returns the delta of the stackpointer for nodes that increment or
408 * decrement the stackpointer with a constant value. (push, pop
409 * nodes on most architectures).
410 * A positive value stands for an expanding stack area, a negative value for
413 * @param irn The node
414 * @return 0 if the stackpointer is not modified with a constant
415 * value, otherwise the increment/decrement value
417 int (*get_sp_bias)(const ir_node *irn);
420 * Returns an inverse operation which yields the i-th argument
421 * of the given node as result.
423 * @param irn The original operation
424 * @param i Index of the argument we want the inverse operation to yield
425 * @param inverse struct to be filled with the resulting inverse op
426 * @param obstack The obstack to use for allocation of the returned nodes array
427 * @return The inverse operation or NULL if operation invertible
429 arch_inverse_t *(*get_inverse)(const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack);
432 * Get the estimated cycle count for @p irn.
434 * @param irn The node.
436 * @return The estimated cycle count for this operation
438 int (*get_op_estimated_cost)(const ir_node *irn);
441 * Asks the backend whether operand @p i of @p irn can be loaded form memory internally
443 * @param irn The node.
444 * @param i Index of the argument we would like to know whether @p irn 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, unsigned int i);
461 * The code generator interface.
463 struct arch_code_generator_if_t {
465 * Initialize the code generator.
466 * @param birg A backend IRG session.
467 * @return A newly created code generator.
469 void *(*init)(be_irg_t *birg);
472 * return node used as base in pic code addresses
474 ir_node* (*get_pic_base)(void *self);
477 * Called before abi introduce.
479 void (*before_abi)(void *self);
482 * Called, when the graph is being normalized.
484 void (*prepare_graph)(void *self);
487 * Backend may provide an own spiller.
488 * This spiller needs to spill all register classes.
490 void (*spill)(void *self, be_irg_t *birg);
493 * Called before register allocation.
495 void (*before_ra)(void *self);
498 * Called after register allocation.
500 void (*after_ra)(void *self);
503 * Called directly before done is called. This should be the last place
504 * where the irg is modified.
506 void (*finish)(void *self);
509 * Called after everything happened. This call should emit the final
510 * assembly code but avoid changing the irg.
511 * The code generator must also be de-allocated here.
513 void (*done)(void *self);
517 * helper macro: call function func from the code generator
518 * if it's implemented.
520 #define _arch_cg_call(cg, func) \
522 if((cg)->impl->func) \
523 (cg)->impl->func(cg); \
526 #define _arch_cg_call_env(cg, env, func) \
528 if((cg)->impl->func) \
529 (cg)->impl->func(cg, env); \
532 #define arch_code_generator_before_abi(cg) _arch_cg_call(cg, before_abi)
533 #define arch_code_generator_prepare_graph(cg) _arch_cg_call(cg, prepare_graph)
534 #define arch_code_generator_before_ra(cg) _arch_cg_call(cg, before_ra)
535 #define arch_code_generator_after_ra(cg) _arch_cg_call(cg, after_ra)
536 #define arch_code_generator_finish(cg) _arch_cg_call(cg, finish)
537 #define arch_code_generator_done(cg) _arch_cg_call(cg, done)
538 #define arch_code_generator_spill(cg, birg) _arch_cg_call_env(cg, birg, spill)
539 #define arch_code_generator_has_spiller(cg) ((cg)->impl->spill != NULL)
540 #define arch_code_generator_get_pic_base(cg) \
541 ((cg)->impl->get_pic_base != NULL ? (cg)->impl->get_pic_base(cg) : NULL)
544 * Code generator base class.
546 struct arch_code_generator_t {
547 const arch_code_generator_if_t *impl;
551 * Architecture interface.
553 struct arch_isa_if_t {
555 * Initialize the isa interface.
556 * @param file_handle the file handle to write the output to
557 * @return a new isa instance
559 arch_env_t *(*init)(FILE *file_handle);
562 * Free the isa instance.
564 void (*done)(void *self);
567 * Called directly after initialization. Backend should handle all
570 void (*handle_intrinsics)(void);
573 * Get the the number of register classes in the isa.
574 * @return The number of register classes.
576 unsigned (*get_n_reg_class)(const void *self);
579 * Get the i-th register class.
580 * @param i The number of the register class.
581 * @return The register class.
583 const arch_register_class_t *(*get_reg_class)(const void *self, unsigned i);
586 * Get the register class which shall be used to store a value of a given mode.
587 * @param self The this pointer.
588 * @param mode The mode in question.
589 * @return A register class which can hold values of the given mode.
591 const arch_register_class_t *(*get_reg_class_for_mode)(const void *self, const ir_mode *mode);
594 * Get the ABI restrictions for procedure calls.
595 * @param self The this pointer.
596 * @param call_type The call type of the method (procedure) in question.
597 * @param p The array of parameter locations to be filled.
599 void (*get_call_abi)(const void *self, ir_type *call_type, be_abi_call_t *abi);
602 * Get the code generator interface.
603 * @param self The this pointer.
604 * @return Some code generator interface.
606 const arch_code_generator_if_t *(*get_code_generator_if)(void *self);
609 * Get the list scheduler to use. There is already a selector given, the
610 * backend is free to modify and/or ignore it.
612 * @param self The isa object.
613 * @param selector The selector given by options.
614 * @return The list scheduler selector.
616 const list_sched_selector_t *(*get_list_sched_selector)(const void *self, list_sched_selector_t *selector);
619 * Get the ILP scheduler to use.
620 * @param self The isa object.
621 * @return The ILP scheduler selector
623 const ilp_sched_selector_t *(*get_ilp_sched_selector)(const void *self);
626 * Get the necessary alignment for storing a register of given class.
627 * @param self The isa object.
628 * @param cls The register class.
629 * @return The alignment in bytes.
631 int (*get_reg_class_alignment)(const void *self, const arch_register_class_t *cls);
634 * A "static" function, returns the frontend settings
635 * needed for this backend.
637 const backend_params *(*get_params)(void);
640 * Returns an 2-dim array of execution units, @p irn can be executed on.
641 * The first dimension is the type, the second the allowed units of this
643 * Each dimension is a NULL terminated list.
644 * @param self The isa object.
645 * @param irn The node.
646 * @return An array of allowed execution units.
648 * { unit1_of_tp1, ..., unitX1_of_tp1, NULL },
650 * { unit1_of_tpY, ..., unitXn_of_tpY, NULL },
654 const be_execution_unit_t ***(*get_allowed_execution_units)(const void *self, const ir_node *irn);
657 * Return the abstract machine for this isa.
658 * @param self The isa object.
660 const be_machine_t *(*get_machine)(const void *self);
663 * Return an ordered list of irgs where code should be generated for.
664 * If NULL is returned, all irg will be taken into account and they will be
665 * generated in an arbitrary order.
666 * @param self The isa object.
667 * @param irgs A flexible array ARR_F of length 0 where the backend can append the desired irgs.
668 * @return A flexible array ARR_F containing all desired irgs in the desired order.
670 ir_graph **(*get_backend_irg_list)(const void *self, ir_graph ***irgs);
673 * mark node as rematerialized
675 void (*mark_remat)(const void *self, ir_node *node);
678 * parse an assembler constraint part and set flags according to its nature
679 * advances the *c pointer to point to the last parsed character (so if you
680 * parse a single character don't advance c)
682 asm_constraint_flags_t (*parse_asm_constraint)(const void *self, const char **c);
685 * returns true if the string is a valid clobbered (register) in this
688 int (*is_valid_clobber)(const void *self, const char *clobber);
691 #define arch_env_done(env) ((env)->impl->done(env))
692 #define arch_env_handle_intrinsics(env) \
693 do { if((env)->impl->handle_intrinsics != NULL) (env)->impl->handle_intrinsics(); } while(0)
694 #define arch_env_get_n_reg_class(env) ((env)->impl->get_n_reg_class(env))
695 #define arch_env_get_reg_class(env,i) ((env)->impl->get_reg_class(env, i))
696 #define arch_env_get_reg_class_for_mode(env,mode) ((env)->impl->get_reg_class_for_mode((env), (mode)))
697 #define arch_env_get_call_abi(env,tp,abi) ((env)->impl->get_call_abi((env), (tp), (abi)))
698 #define arch_env_get_code_generator_if(env) ((env)->impl->get_code_generator_if((env)))
699 #define arch_env_get_list_sched_selector(env,selector) ((env)->impl->get_list_sched_selector((env), (selector)))
700 #define arch_env_get_ilp_sched_selector(env) ((env)->impl->get_ilp_sched_selector(env))
701 #define arch_env_get_reg_class_alignment(env,cls) ((env)->impl->get_reg_class_alignment((env), (cls)))
702 #define arch_env_get_params(env) ((env)->impl->get_params())
703 #define arch_env_get_allowed_execution_units(env,irn) ((env)->impl->get_allowed_execution_units((env), (irn)))
704 #define arch_env_get_machine(env) ((env)->impl->get_machine(env))
705 #define arch_env_get_backend_irg_list(env,irgs) ((env)->impl->get_backend_irg_list((env), (irgs)))
706 #define arch_env_parse_asm_constraint(env,c) ((env)->impl->parse_asm_constraint((env), (c))
707 #define arch_env_is_valid_clobber(env,clobber) ((env)->impl->is_valid_clobber((env), (clobber))
708 #define arch_env_mark_remat(env,node) \
709 do { if ((env)->impl->mark_remat != NULL) (env)->impl->mark_remat((env), (node)); } while(0)
715 const arch_isa_if_t *impl;
716 const arch_register_t *sp; /** The stack pointer register. */
717 const arch_register_t *bp; /** The base pointer register. */
718 const arch_register_class_t *link_class; /** The static link pointer register class. */
719 int stack_dir; /** -1 for decreasing, 1 for increasing. */
720 int stack_alignment; /** power of 2 stack alignment */
721 const be_main_env_t *main_env; /** the be main environment */
722 int spill_cost; /** cost for a be_Spill node */
723 int reload_cost; /** cost for a be_Reload node */
726 static inline unsigned arch_irn_get_n_outs(const ir_node *node)
728 backend_info_t *info = be_get_info(node);
729 return ARR_LEN(info->out_infos);
732 static inline bool arch_irn_consider_in_reg_alloc(
733 const arch_register_class_t *cls, const ir_node *node)
735 const arch_register_req_t *req = arch_get_register_req_out(node);
738 !(req->type & arch_register_req_type_ignore);
741 static inline bool arch_irn_is_ignore(const ir_node *irn)
743 const arch_register_req_t *req = arch_get_register_req_out(irn);
744 return !!(req->type & arch_register_req_type_ignore);
747 static inline const arch_irn_ops_t *get_irn_ops_simple(const ir_node *node)
749 const ir_op *ops = get_irn_op(node);
750 const arch_irn_ops_t *be_ops = get_op_ops(ops)->be_ops;
751 assert(!is_Proj(node));
756 * Get register constraints for an operand at position @p
758 static inline const arch_register_req_t *arch_get_in_register_req(
759 const ir_node *node, int pos)
761 const arch_irn_ops_t *ops = get_irn_ops_simple(node);
762 return ops->get_irn_reg_req_in(node, pos);
766 * Get register constraint for a produced result (the @p pos result)
768 static inline const arch_register_req_t *arch_get_out_register_req(
769 const ir_node *node, int pos)
771 const arch_irn_ops_t *ops = get_irn_ops_simple(node);
772 return ops->get_irn_reg_req_out(node, pos);
775 #endif /* FIRM_BE_BEARCH_H */