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;
55 int _arch_register_get_index(const arch_register_t *reg)
61 const char *_arch_register_get_name(const arch_register_t *reg)
66 #define arch_register_get_class(reg) _arch_register_get_class(reg)
67 #define arch_register_get_index(reg) _arch_register_get_index(reg)
68 #define arch_register_get_name(reg) _arch_register_get_name(reg)
71 * Convenience macro to check for register type.
72 * @param req A pointer to register.
73 * @param kind The kind of type to check for (see arch_register_type_t).
74 * @return 1, If register is of given kind, 0 if not.
76 #define arch_register_type_is(reg, kind) \
77 (((reg)->type & arch_register_type_ ## kind) != 0)
80 * A class of registers.
81 * Like general purpose or floating point.
83 struct arch_register_class_t {
84 const char *name; /**< The name of the register class.*/
85 int n_regs; /**< Number of registers in this
87 ir_mode *mode; /**< The mode of the register class.*/
88 const arch_register_t *regs; /**< The array of registers. */
89 arch_register_class_flags_t flags; /**< register class flags. */
92 /** return the number of registers in this register class */
93 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
95 /** return the largest mode of this register class */
96 #define arch_register_class_mode(cls) ((cls)->mode)
98 /** return the name of this register class */
99 #define arch_register_class_name(cls) ((cls)->name)
101 /** return the register class flags */
102 #define arch_register_class_flags(cls) ((cls)->flags)
104 static INLINE const arch_register_t *
105 _arch_register_for_index(const arch_register_class_t *cls, int idx)
107 assert(0 <= idx && idx < cls->n_regs);
108 return &cls->regs[idx];
111 #define arch_register_for_index(cls, idx) _arch_register_for_index(cls, idx)
114 * Convenience macro to check for set constraints.
115 * @param req A pointer to register requirements.
116 * @param kind The kind of constraint to check for (see arch_register_req_type_t).
117 * @return 1, If the kind of constraint is present, 0 if not.
119 #define arch_register_req_is(req, kind) \
120 (((req)->type & (arch_register_req_type_ ## kind)) != 0)
123 * Expresses requirements to register allocation for an operand.
125 struct arch_register_req_t {
126 arch_register_req_type_t type; /**< The type of the constraint. */
127 const arch_register_class_t *cls; /**< The register class this constraint belongs to. */
129 const unsigned *limited; /**< allowed register bitset */
131 int other_same[2]; /**< The in numbers which shall have the
132 same res (should_be_same). More than
133 two are unnecessary because there is
134 no machine with more than two
135 commutative inputs to one operation */
136 int other_different; /**< The other node from which this
137 one's register must be different
138 (case must_be_different). */
147 * An inverse operation returned by the backend
149 struct arch_inverse_t {
150 int n; /**< count of nodes returned in nodes array */
151 int costs; /**< costs of this remat */
153 /**< nodes for this inverse operation. shall be in
154 * schedule order. last element is the target value
159 struct arch_irn_ops_if_t {
162 * Get the register requirements for a given operand.
163 * @param self The self pointer.
164 * @param irn The node.
165 * @param pos The operand's position
166 * (-1 for the result of the node, 0..n for the input operands).
167 * @return The register requirements for the selected operand.
168 * The pointer returned is never NULL.
170 const arch_register_req_t *(*get_irn_reg_req)(const void *self,
171 const ir_node *irn, int pos);
174 * Set the register for an output operand.
175 * @param irn The node.
176 * @param reg The register allocated to that operand.
177 * @note If the operand is not a register operand,
178 * the call is ignored.
180 void (*set_irn_reg)(const void *self, ir_node *irn, const arch_register_t *reg);
183 * Get the register allocated for an output operand.
184 * @param irn The node.
185 * @return The register allocated at that operand. NULL, if
186 * the operand was no register operand or
187 * @c arch_register_invalid, if no register has yet been
188 * allocated for this node.
190 const arch_register_t *(*get_irn_reg)(const void *self, const ir_node *irn);
194 * @param irn The node.
195 * @return A classification.
197 arch_irn_class_t (*classify)(const void *self, const ir_node *irn);
200 * Get the flags of a node.
201 * @param self The irn ops themselves.
202 * @param irn The node.
203 * @return A set of flags.
205 arch_irn_flags_t (*get_flags)(const void *self, const ir_node *irn);
208 * Get the entity on the stack frame this node depends on.
209 * @param self The this pointer.
210 * @param irn The node in question.
211 * @return The entity on the stack frame or NULL, if the node does not have a
212 * stack frame entity.
214 ir_entity *(*get_frame_entity)(const void *self, const ir_node *irn);
217 * Set the entity on the stack frame this node depends on.
218 * @param self The this pointer.
219 * @param irn The node in question.
220 * @param ent The entity to set
222 void (*set_frame_entity)(const void *self, ir_node *irn, ir_entity *ent);
225 * Set the offset of a node carrying an entity on the stack frame.
226 * @param self The this pointer.
227 * @param irn The node.
228 * @param offset The offset of the node's stack frame entity.
230 void (*set_frame_offset)(const void *self, ir_node *irn, int offset);
233 * Returns the delta of the stackpointer for nodes that increment or
234 * decrement the stackpointer with a constant value. (push, pop
235 * nodes on most architectures).
236 * A positive value stands for an expanding stack area, a negative value for
239 * @param self The this pointer
240 * @param irn The node
241 * @return 0 if the stackpointer is not modified with a constant
242 * value, otherwise the increment/decrement value
244 int (*get_sp_bias)(const void *self, const ir_node *irn);
247 * Returns an inverse operation which yields the i-th argument
248 * of the given node as result.
250 * @param self The this pointer.
251 * @param irn The original operation
252 * @param i Index of the argument we want the inverse operation to yield
253 * @param inverse struct to be filled with the resulting inverse op
254 * @param obstack The obstack to use for allocation of the returned nodes array
255 * @return The inverse operation or NULL if operation invertible
257 arch_inverse_t *(*get_inverse)(const void *self, const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack);
260 * Get the estimated cycle count for @p irn.
262 * @param self The this pointer.
263 * @param irn The node.
265 * @return The estimated cycle count for this operation
267 int (*get_op_estimated_cost)(const void *self, const ir_node *irn);
270 * Asks the backend whether operand @p i of @p irn can be loaded form memory internally
272 * @param self The this pointer.
273 * @param irn The node.
274 * @param i Index of the argument we would like to know whether @p irn can load it form memory internally
276 * @return nonzero if argument can be loaded or zero otherwise
278 int (*possible_memory_operand)(const void *self, const ir_node *irn, unsigned int i);
281 * Ask the backend to assimilate @p reload of operand @p i into @p irn.
283 * @param self The this pointer.
284 * @param irn The node.
285 * @param spill The spill.
286 * @param i The position of the reload.
288 void (*perform_memory_operand)(const void *self, ir_node *irn, ir_node *spill, unsigned int i);
292 * irn_ops base class.
294 struct arch_irn_ops_t {
295 const arch_irn_ops_if_t *impl;
299 * Somebody who can be asked about IR nodes.
301 struct arch_irn_handler_t {
304 * Get the operations of an irn.
305 * @param self The handler from which the method is invoked.
306 * @param irn Some node.
307 * @return Operations for that irn.
309 const void *(*get_irn_ops)(const arch_irn_handler_t *handler,
314 * The code generator interface.
316 struct arch_code_generator_if_t {
318 * Initialize the code generator.
319 * @param birg A backend IRG session.
320 * @return A newly created code generator.
322 void *(*init)(be_irg_t *birg);
325 * Called before abi introduce.
327 void (*before_abi)(void *self);
330 * Called, when the graph is being normalized.
332 void (*prepare_graph)(void *self);
335 * Backend may provide an own spiller.
336 * This spiller needs to spill all register classes.
338 void (*spill)(void *self, be_irg_t *birg);
341 * Called before scheduling.
343 void (*before_sched)(void *self);
346 * Called before register allocation.
348 void (*before_ra)(void *self);
351 * Called after register allocation.
353 void (*after_ra)(void *self);
356 * Called directly before done is called. This should be the last place
357 * where the irg is modified.
359 void (*finish)(void *self);
362 * Called after everything happened. This call should emit the final
363 * assembly code but avoid changing the irg.
364 * The code generator must also be de-allocated here.
366 void (*done)(void *self);
370 * helper macro: call function func from the code generator
371 * if it's implemented.
373 #define _arch_cg_call(cg, func) \
375 if((cg)->impl->func) \
376 (cg)->impl->func(cg); \
379 #define _arch_cg_call_env(cg, env, func) \
381 if((cg)->impl->func) \
382 (cg)->impl->func(cg, env); \
385 #define arch_code_generator_before_abi(cg) _arch_cg_call(cg, before_abi)
386 #define arch_code_generator_prepare_graph(cg) _arch_cg_call(cg, prepare_graph)
387 #define arch_code_generator_before_sched(cg) _arch_cg_call(cg, before_sched)
388 #define arch_code_generator_before_ra(cg) _arch_cg_call(cg, before_ra)
389 #define arch_code_generator_after_ra(cg) _arch_cg_call(cg, after_ra)
390 #define arch_code_generator_finish(cg) _arch_cg_call(cg, finish)
391 #define arch_code_generator_done(cg) _arch_cg_call(cg, done)
392 #define arch_code_generator_spill(cg, birg) _arch_cg_call_env(cg, birg, spill)
393 #define arch_code_generator_has_spiller(cg) ((cg)->impl->spill != NULL)
396 * Code generator base class.
398 struct arch_code_generator_t {
399 const arch_code_generator_if_t *impl;
406 const arch_isa_if_t *impl;
407 const arch_register_t *sp; /** The stack pointer register. */
408 const arch_register_t *bp; /** The base pointer register. */
409 const int stack_dir; /** -1 for decreasing, 1 for increasing. */
410 const be_main_env_t *main_env; /** the be main environment */
411 const int spill_cost; /** cost for a be_Spill node */
412 const int reload_cost; /** cost for a be_Reload node */
415 #define arch_isa_stack_dir(isa) ((isa)->stack_dir)
416 #define arch_isa_sp(isa) ((isa)->sp)
417 #define arch_isa_bp(isa) ((isa)->bp)
420 * Architecture interface.
422 struct arch_isa_if_t {
424 * Initialize the isa interface.
425 * @param file_handle the file handle to write the output to
426 * @param main_env the be main environment
427 * @return a new isa instance
429 void *(*init)(FILE *file_handle);
432 * Free the isa instance.
434 void (*done)(void *self);
437 * Get the the number of register classes in the isa.
438 * @return The number of register classes.
440 int (*get_n_reg_class)(const void *self);
443 * Get the i-th register class.
444 * @param i The number of the register class.
445 * @return The register class.
447 const arch_register_class_t *(*get_reg_class)(const void *self, int i);
450 * Get the register class which shall be used to store a value of a given mode.
451 * @param self The this pointer.
452 * @param mode The mode in question.
453 * @return A register class which can hold values of the given mode.
455 const arch_register_class_t *(*get_reg_class_for_mode)(const void *self, const ir_mode *mode);
458 * Get the ABI restrictions for procedure calls.
459 * @param self The this pointer.
460 * @param method_type The type of the method (procedure) in question.
461 * @param p The array of parameter locations to be filled.
463 void (*get_call_abi)(const void *self, ir_type *method_type, be_abi_call_t *abi);
466 * The irn handler for this architecture.
467 * The irn handler is registered by the Firm back end
468 * when the architecture is initialized.
471 const arch_irn_handler_t *(*get_irn_handler)(const void *self);
474 * Get the code generator interface.
475 * @param self The this pointer.
476 * @return Some code generator interface.
478 const arch_code_generator_if_t *(*get_code_generator_if)(void *self);
481 * Get the list scheduler to use. There is already a selector given, the
482 * backend is free to modify and/or ignore it.
484 * @param self The isa object.
485 * @param selector The selector given by options.
486 * @return The list scheduler selector.
488 const list_sched_selector_t *(*get_list_sched_selector)(const void *self, list_sched_selector_t *selector);
491 * Get the ILP scheduler to use.
492 * @param self The isa object.
493 * @return The ILP scheduler selector
495 const ilp_sched_selector_t *(*get_ilp_sched_selector)(const void *self);
498 * Get the necessary alignment for storing a register of given class.
499 * @param self The isa object.
500 * @param cls The register class.
501 * @return The alignment in bytes.
503 int (*get_reg_class_alignment)(const void *self, const arch_register_class_t *cls);
506 * A "static" function, returns the frontend settings
507 * needed for this backend.
509 const backend_params *(*get_params)(void);
512 * Returns an 2-dim array of execution units, @p irn can be executed on.
513 * The first dimension is the type, the second the allowed units of this
515 * Each dimension is a NULL terminated list.
516 * @param self The isa object.
517 * @param irn The node.
518 * @return An array of allowed execution units.
520 * { unit1_of_tp1, ..., unitX1_of_tp1, NULL },
522 * { unit1_of_tpY, ..., unitXn_of_tpY, NULL },
526 const be_execution_unit_t ***(*get_allowed_execution_units)(const void *self, const ir_node *irn);
529 * Return the abstract machine for this isa.
530 * @param self The isa object.
532 const be_machine_t *(*get_machine)(const void *self);
535 * Return an ordered list of irgs where code should be generated for.
536 * If NULL is returned, all irg will be taken into account and they will be
537 * generated in an arbitrary order.
538 * @param self The isa object.
539 * @param irgs A flexible array ARR_F of length 0 where the backend can append the desired irgs.
540 * @return A flexible array ARR_F containing all desired irgs in the desired order.
542 ir_graph **(*get_backend_irg_list)(const void *self, ir_graph ***irgs);
545 #define arch_isa_get_n_reg_class(isa) ((isa)->impl->get_n_reg_class(isa))
546 #define arch_isa_get_reg_class(isa,i) ((isa)->impl->get_reg_class(isa, i))
547 #define arch_isa_get_irn_handler(isa) ((isa)->impl->get_irn_handler(isa))
548 #define arch_isa_get_call_abi(isa,tp,abi) ((isa)->impl->get_call_abi((isa), (tp), (abi)))
549 #define arch_isa_get_reg_class_for_mode(isa,mode) ((isa)->impl->get_reg_class_for_mode((isa), (mode)))
550 #define arch_isa_make_code_generator(isa,irg) ((isa)->impl->make_code_generator((isa), (irg)))
551 #define arch_isa_get_reg_class_alignment(isa, cls) ((isa)->impl->get_reg_class_alignment((isa), (cls)))
552 #define arch_isa_get_allowed_execution_units(isa, irn) ((isa)->impl->get_allowed_execution_units((isa), (irn)))
553 #define arch_isa_get_machine(isa) ((isa)->impl->get_machine((isa)))
554 #define arch_isa_get_backend_irg_list(isa, irgs) ((isa)->impl->get_backend_irg_list((isa), (irgs)))
556 #define ARCH_MAX_HANDLERS 8
559 * Environment for the architecture infrastructure.
560 * Keep this everywhere you're going.
563 arch_isa_t *isa; /**< The isa about which everything is. */
565 arch_irn_handler_t const *handlers[ARCH_MAX_HANDLERS]; /**< The handlers are organized as
568 int handlers_tos; /**< The stack pointer of the handler
573 * Get the isa of an arch environment.
574 * @param env The environment.
575 * @return The isa with which the env was initialized with.
577 #define arch_env_get_isa(env) ((env)->isa)
579 #endif /* FIRM_BE_BEARCH_T_H */