2 * Copyright (C) 1995-2007 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 - internal data structures.
23 * @author Sebastian Hack
26 #ifndef FIRM_BE_BEARCH_T_H
27 #define FIRM_BE_BEARCH_T_H
31 #include "belistsched.h"
32 #include "beilpsched.h"
33 #include "bemachine.h"
40 struct arch_register_t {
41 const char *name; /**< The name of the register. */
42 const arch_register_class_t *reg_class; /**< The class the register belongs to. */
43 int index; /**< The index of the register in the class. */
44 arch_register_type_t type; /**< The type of the register. */
45 void *data; /**< Custom data. */
48 static INLINE const arch_register_class_t *
49 _arch_register_get_class(const arch_register_t *reg)
51 return reg->reg_class;
54 static INLINE int _arch_register_get_index(const arch_register_t *reg)
59 static INLINE const char *_arch_register_get_name(const arch_register_t *reg)
64 #define arch_register_get_class(reg) _arch_register_get_class(reg)
65 #define arch_register_get_index(reg) _arch_register_get_index(reg)
66 #define arch_register_get_name(reg) _arch_register_get_name(reg)
69 * Convenience macro to check for register type.
70 * @param req A pointer to register.
71 * @param kind The kind of type to check for (see arch_register_type_t).
72 * @return 1, If register is of given kind, 0 if not.
74 #define arch_register_type_is(reg, kind) \
75 (((reg)->type & arch_register_type_ ## kind) != 0)
78 * A class of registers.
79 * Like general purpose or floating point.
81 struct arch_register_class_t {
82 const char *name; /**< The name of the register class. */
83 int n_regs; /**< Number of registers in this class. */
84 ir_mode *mode; /**< The mode of the register class. */
85 const arch_register_t *regs; /**< The array of registers. */
88 /** return the number of registers in this register class */
89 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
91 /** return the largest mode of this register class */
92 #define arch_register_class_mode(cls) ((cls)->mode)
94 /** return the name of this register class */
95 #define arch_register_class_name(cls) ((cls)->name)
97 static INLINE const arch_register_t *
98 _arch_register_for_index(const arch_register_class_t *cls, int idx)
100 assert(0 <= idx && idx < cls->n_regs);
101 return &cls->regs[idx];
104 #define arch_register_for_index(cls, idx) _arch_register_for_index(cls, idx)
107 * Convenience macro to check for set constraints.
108 * @param req A pointer to register requirements.
109 * @param kind The kind of constraint to check for (see arch_register_req_type_t).
110 * @return 1, If the kind of constraint is present, 0 if not.
112 #define arch_register_req_is(req, kind) \
113 (((req)->type & (arch_register_req_type_ ## kind)) != 0)
116 * Expresses requirements to register allocation for an operand.
118 struct arch_register_req_t {
119 arch_register_req_type_t type; /**< The type of the constraint. */
120 const arch_register_class_t *cls; /**< The register class this constraint belongs to. */
122 const unsigned *limited; /**< allowed register bitset */
124 int other_same; /**< The in number which shall have
125 the same res (should_be_same)*/
126 int other_different; /**< The other node from which this
127 one's register must be different
128 (case must_be_different). */
137 * An inverse operation returned by the backend
139 struct arch_inverse_t {
140 int n; /**< count of nodes returned in nodes array */
141 int costs; /**< costs of this remat */
143 /**< nodes for this inverse operation. shall be in
144 * schedule order. last element is the target value
149 struct arch_irn_ops_if_t {
152 * Get the register requirements for a given operand.
153 * @param self The self pointer.
154 * @param irn The node.
155 * @param pos The operand's position
156 * (-1 for the result of the node, 0..n for the input operands).
157 * @return The register requirements for the selected operand.
158 * The pointer returned is never NULL.
160 const arch_register_req_t *(*get_irn_reg_req)(const void *self,
161 const ir_node *irn, int pos);
164 * Set the register for an output operand.
165 * @param irn The node.
166 * @param reg The register allocated to that operand.
167 * @note If the operand is not a register operand,
168 * the call is ignored.
170 void (*set_irn_reg)(const void *self, ir_node *irn, const arch_register_t *reg);
173 * Get the register allocated for an output operand.
174 * @param irn The node.
175 * @return The register allocated at that operand. NULL, if
176 * the operand was no register operand or
177 * @c arch_register_invalid, if no register has yet been
178 * allocated for this node.
180 const arch_register_t *(*get_irn_reg)(const void *self, const ir_node *irn);
184 * @param irn The node.
185 * @return A classification.
187 arch_irn_class_t (*classify)(const void *self, const ir_node *irn);
190 * Get the flags of a node.
191 * @param self The irn ops themselves.
192 * @param irn The node.
193 * @return A set of flags.
195 arch_irn_flags_t (*get_flags)(const void *self, const ir_node *irn);
198 * Get the entity on the stack frame this node depends on.
199 * @param self The this pointer.
200 * @param irn The node in question.
201 * @return The entity on the stack frame or NULL, if the node does not have a
202 * stack frame entity.
204 ir_entity *(*get_frame_entity)(const void *self, const ir_node *irn);
207 * Set the entity on the stack frame this node depends on.
208 * @param self The this pointer.
209 * @param irn The node in question.
210 * @param ent The entity to set
212 void (*set_frame_entity)(const void *self, ir_node *irn, ir_entity *ent);
215 * Set the offset of a node carrying an entity on the stack frame.
216 * @param self The this pointer.
217 * @param irn The node.
218 * @param offset The offset of the node's stack frame entity.
220 void (*set_frame_offset)(const void *self, ir_node *irn, int offset);
223 * Returns the delta of the stackpointer for nodes that increment or
224 * decrement the stackpointer with a constant value. (push, pop
225 * nodes on most architectures).
226 * A positive value stands for an expanding stack area, a negative value for
229 * @param self The this pointer
230 * @param irn The node
231 * @return 0 if the stackpointer is not modified with a constant
232 * value, otherwise the increment/decrement value
234 int (*get_sp_bias)(const void *self, const ir_node *irn);
237 * Returns an inverse operation which yields the i-th argument
238 * of the given node as result.
240 * @param self The this pointer.
241 * @param irn The original operation
242 * @param i Index of the argument we want the inverse operation to yield
243 * @param inverse struct to be filled with the resulting inverse op
244 * @param obstack The obstack to use for allocation of the returned nodes array
245 * @return The inverse operation or NULL if operation invertible
247 arch_inverse_t *(*get_inverse)(const void *self, const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack);
250 * Get the estimated cycle count for @p irn.
252 * @param self The this pointer.
253 * @param irn The node.
255 * @return The estimated cycle count for this operation
257 int (*get_op_estimated_cost)(const void *self, const ir_node *irn);
260 * Asks the backend whether operand @p i of @p irn can be loaded form memory internally
262 * @param self The this pointer.
263 * @param irn The node.
264 * @param i Index of the argument we would like to know whether @p irn can load it form memory internally
266 * @return nonzero if argument can be loaded or zero otherwise
268 int (*possible_memory_operand)(const void *self, const ir_node *irn, unsigned int i);
271 * Ask the backend to assimilate @p reload of operand @p i into @p irn.
273 * @param self The this pointer.
274 * @param irn The node.
275 * @param spill The spill.
276 * @param i The position of the reload.
278 void (*perform_memory_operand)(const void *self, ir_node *irn, ir_node *spill, unsigned int i);
282 * irn_ops base class.
284 struct arch_irn_ops_t {
285 const arch_irn_ops_if_t *impl;
289 * Somebody who can be asked about IR nodes.
291 struct arch_irn_handler_t {
294 * Get the operations of an irn.
295 * @param self The handler from which the method is invoked.
296 * @param irn Some node.
297 * @return Operations for that irn.
299 const void *(*get_irn_ops)(const arch_irn_handler_t *handler,
304 * The code generator interface.
306 struct arch_code_generator_if_t {
308 * Initialize the code generator.
309 * @param birg A backend IRG session.
310 * @return A newly created code generator.
312 void *(*init)(be_irg_t *birg);
315 * Called before abi introduce.
317 void (*before_abi)(void *self);
320 * Called, when the graph is being normalized.
322 void (*prepare_graph)(void *self);
325 * Backend may provide an own spiller.
326 * This spiller needs to spill all register classes.
328 void (*spill)(void *self, be_irg_t *birg);
331 * Called before scheduling.
333 void (*before_sched)(void *self);
336 * Called before register allocation.
338 void (*before_ra)(void *self);
341 * Called after register allocation.
343 void (*after_ra)(void *self);
346 * Called directly before done is called. This should be the last place
347 * where the irg is modified.
349 void (*finish)(void *self);
352 * Called after everything happened. This call should emit the final
353 * assembly code but avoid changing the irg.
354 * The code generator must also be de-allocated here.
356 void (*done)(void *self);
360 * helper macro: call function func from the code generator
361 * if it's implemented.
363 #define _arch_cg_call(cg, func) \
365 if((cg)->impl->func) \
366 (cg)->impl->func(cg); \
369 #define _arch_cg_call_env(cg, env, func) \
371 if((cg)->impl->func) \
372 (cg)->impl->func(cg, env); \
375 #define arch_code_generator_before_abi(cg) _arch_cg_call(cg, before_abi)
376 #define arch_code_generator_prepare_graph(cg) _arch_cg_call(cg, prepare_graph)
377 #define arch_code_generator_before_sched(cg) _arch_cg_call(cg, before_sched)
378 #define arch_code_generator_before_ra(cg) _arch_cg_call(cg, before_ra)
379 #define arch_code_generator_after_ra(cg) _arch_cg_call(cg, after_ra)
380 #define arch_code_generator_finish(cg) _arch_cg_call(cg, finish)
381 #define arch_code_generator_done(cg) _arch_cg_call(cg, done)
382 #define arch_code_generator_spill(cg, birg) _arch_cg_call_env(cg, birg, spill)
383 #define arch_code_generator_has_spiller(cg) ((cg)->impl->spill != NULL)
386 * Code generator base class.
388 struct arch_code_generator_t {
389 const arch_code_generator_if_t *impl;
396 const arch_isa_if_t *impl;
397 const arch_register_t *sp; /** The stack pointer register. */
398 const arch_register_t *bp; /** The base pointer register. */
399 const int stack_dir; /** -1 for decreasing, 1 for increasing. */
400 const be_main_env_t *main_env; /** the be main environment */
403 #define arch_isa_stack_dir(isa) ((isa)->stack_dir)
404 #define arch_isa_sp(isa) ((isa)->sp)
405 #define arch_isa_bp(isa) ((isa)->bp)
408 * Architecture interface.
410 struct arch_isa_if_t {
412 * Initialize the isa interface.
413 * @param file_handle the file handle to write the output to
414 * @param main_env the be main environment
415 * @return a new isa instance
417 void *(*init)(FILE *file_handle);
420 * Free the isa instance.
422 void (*done)(void *self);
425 * Get the the number of register classes in the isa.
426 * @return The number of register classes.
428 int (*get_n_reg_class)(const void *self);
431 * Get the i-th register class.
432 * @param i The number of the register class.
433 * @return The register class.
435 const arch_register_class_t *(*get_reg_class)(const void *self, int i);
438 * Get the register class which shall be used to store a value of a given mode.
439 * @param self The this pointer.
440 * @param mode The mode in question.
441 * @return A register class which can hold values of the given mode.
443 const arch_register_class_t *(*get_reg_class_for_mode)(const void *self, const ir_mode *mode);
446 * Get the ABI restrictions for procedure calls.
447 * @param self The this pointer.
448 * @param method_type The type of the method (procedure) in question.
449 * @param p The array of parameter locations to be filled.
451 void (*get_call_abi)(const void *self, ir_type *method_type, be_abi_call_t *abi);
454 * The irn handler for this architecture.
455 * The irn handler is registered by the Firm back end
456 * when the architecture is initialized.
459 const arch_irn_handler_t *(*get_irn_handler)(const void *self);
462 * Get the code generator interface.
463 * @param self The this pointer.
464 * @return Some code generator interface.
466 const arch_code_generator_if_t *(*get_code_generator_if)(void *self);
469 * Get the list scheduler to use. There is already a selector given, the
470 * backend is free to modify and/or ignore it.
472 * @param self The isa object.
473 * @param selector The selector given by options.
474 * @return The list scheduler selector.
476 const list_sched_selector_t *(*get_list_sched_selector)(const void *self, list_sched_selector_t *selector);
479 * Get the ILP scheduler to use.
480 * @param self The isa object.
481 * @return The ILP scheduler selector
483 const ilp_sched_selector_t *(*get_ilp_sched_selector)(const void *self);
486 * Get the necessary alignment for storing a register of given class.
487 * @param self The isa object.
488 * @param cls The register class.
489 * @return The alignment in bytes.
491 int (*get_reg_class_alignment)(const void *self, const arch_register_class_t *cls);
494 * A "static" function, returns the frontend settings
495 * needed for this backend.
497 const backend_params *(*get_params)(void);
500 * Returns an 2-dim array of execution units, @p irn can be executed on.
501 * The first dimension is the type, the second the allowed units of this type.
502 * Each dimension is a NULL terminated list.
503 * @param self The isa object.
504 * @param irn The node.
505 * @return An array of allowed execution units.
507 * { unit1_of_tp1, ..., unitX1_of_tp1, NULL },
509 * { unit1_of_tpY, ..., unitXn_of_tpY, NULL },
513 const be_execution_unit_t ***(*get_allowed_execution_units)(const void *self, const ir_node *irn);
516 * Return the abstract machine for this isa.
517 * @param self The isa object.
519 const be_machine_t *(*get_machine)(const void *self);
522 * Return an ordered list of irgs where code should be generated for.
523 * If NULL is returned, all irg will be taken into account and they will be
524 * generated in an arbitrary order.
525 * @param self The isa object.
526 * @param irgs A flexible array ARR_F of length 0 where the backend can append the desired irgs.
527 * @return A flexible array ARR_F containing all desired irgs in the desired order.
529 ir_graph **(*get_backend_irg_list)(const void *self, ir_graph ***irgs);
532 #define arch_isa_get_n_reg_class(isa) ((isa)->impl->get_n_reg_class(isa))
533 #define arch_isa_get_reg_class(isa,i) ((isa)->impl->get_reg_class(isa, i))
534 #define arch_isa_get_irn_handler(isa) ((isa)->impl->get_irn_handler(isa))
535 #define arch_isa_get_call_abi(isa,tp,abi) ((isa)->impl->get_call_abi((isa), (tp), (abi)))
536 #define arch_isa_get_reg_class_for_mode(isa,mode) ((isa)->impl->get_reg_class_for_mode((isa), (mode)))
537 #define arch_isa_make_code_generator(isa,irg) ((isa)->impl->make_code_generator((isa), (irg)))
538 #define arch_isa_get_reg_class_alignment(isa, cls) ((isa)->impl->get_reg_class_alignment((isa), (cls)))
539 #define arch_isa_get_allowed_execution_units(isa, irn) ((isa)->impl->get_allowed_execution_units((isa), (irn)))
540 #define arch_isa_get_machine(isa) ((isa)->impl->get_machine((isa)))
541 #define arch_isa_get_backend_irg_list(isa, irgs) ((isa)->impl->get_backend_irg_list((isa), (irgs)))
543 #define ARCH_MAX_HANDLERS 8
546 * Environment for the architecture infrastructure.
547 * Keep this everywhere you're going.
550 arch_isa_t *isa; /**< The isa about which everything is. */
552 arch_irn_handler_t const *handlers[ARCH_MAX_HANDLERS]; /**< The handlers are organized as
555 int handlers_tos; /**< The stack pointer of the handler
560 * Get the isa of an arch environment.
561 * @param env The environment.
562 * @return The isa with which the env was initialized with.
564 #define arch_env_get_isa(env) ((env)->isa)
566 #endif /* FIRM_BE_BEARCH_T_H */