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 - 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"
36 #include "raw_bitset.h"
41 struct arch_register_t {
42 const char *name; /**< The name of the register. */
43 const arch_register_class_t *reg_class; /**< The class the register belongs to. */
44 unsigned index; /**< The index of the register in the class. */
45 arch_register_type_t type; /**< The type of the register. */
48 static inline const arch_register_class_t *
49 _arch_register_get_class(const arch_register_t *reg)
51 return reg->reg_class;
55 unsigned _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 unsigned index; /**< index of this register class */
85 const char *name; /**< The name of the register class.*/
86 unsigned n_regs; /**< Number of registers in this
88 ir_mode *mode; /**< The mode of the register class.*/
89 const arch_register_t *regs; /**< The array of registers. */
90 arch_register_class_flags_t flags; /**< register class flags. */
93 /** return the number of registers in this register class */
94 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
96 /** return the largest mode of this register class */
97 #define arch_register_class_mode(cls) ((cls)->mode)
99 /** return the name of this register class */
100 #define arch_register_class_name(cls) ((cls)->name)
102 /** return the index of this register class */
103 #define arch_register_class_index(cls) ((cls)->index)
105 /** return the register class flags */
106 #define arch_register_class_flags(cls) ((cls)->flags)
108 static inline const arch_register_t *
109 _arch_register_for_index(const arch_register_class_t *cls, unsigned idx)
111 assert(idx < cls->n_regs);
112 return &cls->regs[idx];
115 #define arch_register_for_index(cls, idx) _arch_register_for_index(cls, idx)
118 * Convenience macro to check for set constraints.
119 * @param req A pointer to register requirements.
120 * @param kind The kind of constraint to check for (see arch_register_req_type_t).
121 * @return 1, If the kind of constraint is present, 0 if not.
123 #define arch_register_req_is(req, kind) \
124 (((req)->type & (arch_register_req_type_ ## kind)) != 0)
127 * Expresses requirements to register allocation for an operand.
129 struct arch_register_req_t {
130 arch_register_req_type_t type; /**< The type of the constraint. */
131 const arch_register_class_t *cls; /**< The register class this constraint belongs to. */
133 const unsigned *limited; /**< allowed register bitset */
135 unsigned other_same; /**< Bitmask of ins which should use the
136 same register (should_be_same). */
137 unsigned other_different; /**< Bitmask of ins which shall use a
139 (must_be_different) */
142 static inline int reg_reqs_equal(const arch_register_req_t *req1,
143 const arch_register_req_t *req2)
148 if (req1->type != req2->type
149 || req1->cls != req2->cls
150 || req1->other_same != req2->other_same
151 || req1->other_different != req2->other_different)
154 if (req1->limited != NULL) {
157 if (req2->limited == NULL)
160 n_regs = arch_register_class_n_regs(req1->cls);
161 if (!rbitset_equal(req1->limited, req2->limited, n_regs))
169 * An inverse operation returned by the backend
171 struct arch_inverse_t {
172 int n; /**< count of nodes returned in nodes array */
173 int costs; /**< costs of this remat */
175 /**< nodes for this inverse operation. shall be in
176 * schedule order. last element is the target value
181 struct arch_irn_ops_t {
184 * Get the register requirements for a given operand.
185 * @param self The self pointer.
186 * @param irn The node.
187 * @param pos The operand's position
188 * (-1 for the result of the node, 0..n for the input operands).
189 * @return The register requirements for the selected operand.
190 * The pointer returned is never NULL.
192 const arch_register_req_t *(*get_irn_reg_req)(const ir_node *irn, int pos);
195 * Set the register for an output operand.
196 * @param irn The node.
197 * @param reg The register allocated to that operand.
198 * @note If the operand is not a register operand,
199 * the call is ignored.
201 void (*set_irn_reg)(ir_node *irn, const arch_register_t *reg);
204 * Get the register allocated for an output operand.
205 * @param irn The node.
206 * @return The register allocated at that operand. NULL, if
207 * the operand was no register operand or
208 * @c arch_register_invalid, if no register has yet been
209 * allocated for this node.
211 const arch_register_t *(*get_irn_reg)(const ir_node *irn);
215 * @param irn The node.
216 * @return A classification.
218 arch_irn_class_t (*classify)(const ir_node *irn);
221 * Get the flags of a node.
222 * @param self The irn ops themselves.
223 * @param irn The node.
224 * @return A set of flags.
226 arch_irn_flags_t (*get_flags)(const ir_node *irn);
229 * Get the entity on the stack frame this node depends on.
230 * @param self The this pointer.
231 * @param irn The node in question.
232 * @return The entity on the stack frame or NULL, if the node does not have a
233 * stack frame entity.
235 ir_entity *(*get_frame_entity)(const ir_node *irn);
238 * Set the entity on the stack frame this node depends on.
239 * @param self The this pointer.
240 * @param irn The node in question.
241 * @param ent The entity to set
243 void (*set_frame_entity)(ir_node *irn, ir_entity *ent);
246 * Set the offset of a node carrying an entity on the stack frame.
247 * @param self The this pointer.
248 * @param irn The node.
249 * @param offset The offset of the node's stack frame entity.
251 void (*set_frame_offset)(ir_node *irn, int offset);
254 * Returns the delta of the stackpointer for nodes that increment or
255 * decrement the stackpointer with a constant value. (push, pop
256 * nodes on most architectures).
257 * A positive value stands for an expanding stack area, a negative value for
260 * @param self The this pointer
261 * @param irn The node
262 * @return 0 if the stackpointer is not modified with a constant
263 * value, otherwise the increment/decrement value
265 int (*get_sp_bias)(const ir_node *irn);
268 * Returns an inverse operation which yields the i-th argument
269 * of the given node as result.
271 * @param self The this pointer.
272 * @param irn The original operation
273 * @param i Index of the argument we want the inverse operation to yield
274 * @param inverse struct to be filled with the resulting inverse op
275 * @param obstack The obstack to use for allocation of the returned nodes array
276 * @return The inverse operation or NULL if operation invertible
278 arch_inverse_t *(*get_inverse)(const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack);
281 * Get the estimated cycle count for @p irn.
283 * @param self The this pointer.
284 * @param irn The node.
286 * @return The estimated cycle count for this operation
288 int (*get_op_estimated_cost)(const ir_node *irn);
291 * Asks the backend whether operand @p i of @p irn can be loaded form memory internally
293 * @param self The this pointer.
294 * @param irn The node.
295 * @param i Index of the argument we would like to know whether @p irn can load it form memory internally
297 * @return nonzero if argument can be loaded or zero otherwise
299 int (*possible_memory_operand)(const ir_node *irn, unsigned int i);
302 * Ask the backend to assimilate @p reload of operand @p i into @p irn.
304 * @param self The this pointer.
305 * @param irn The node.
306 * @param spill The spill.
307 * @param i The position of the reload.
309 void (*perform_memory_operand)(ir_node *irn, ir_node *spill, unsigned int i);
313 * The code generator interface.
315 struct arch_code_generator_if_t {
317 * Initialize the code generator.
318 * @param birg A backend IRG session.
319 * @return A newly created code generator.
321 void *(*init)(be_irg_t *birg);
324 * return node used as base in pic code addresses
326 ir_node* (*get_pic_base)(void *self);
329 * Called before abi introduce.
331 void (*before_abi)(void *self);
334 * Called, when the graph is being normalized.
336 void (*prepare_graph)(void *self);
339 * Backend may provide an own spiller.
340 * This spiller needs to spill all register classes.
342 void (*spill)(void *self, be_irg_t *birg);
345 * Called before register allocation.
347 void (*before_ra)(void *self);
350 * Called after register allocation.
352 void (*after_ra)(void *self);
355 * Called directly before done is called. This should be the last place
356 * where the irg is modified.
358 void (*finish)(void *self);
361 * Called after everything happened. This call should emit the final
362 * assembly code but avoid changing the irg.
363 * The code generator must also be de-allocated here.
365 void (*done)(void *self);
369 * helper macro: call function func from the code generator
370 * if it's implemented.
372 #define _arch_cg_call(cg, func) \
374 if((cg)->impl->func) \
375 (cg)->impl->func(cg); \
378 #define _arch_cg_call_env(cg, env, func) \
380 if((cg)->impl->func) \
381 (cg)->impl->func(cg, env); \
384 #define arch_code_generator_before_abi(cg) _arch_cg_call(cg, before_abi)
385 #define arch_code_generator_prepare_graph(cg) _arch_cg_call(cg, prepare_graph)
386 #define arch_code_generator_before_ra(cg) _arch_cg_call(cg, before_ra)
387 #define arch_code_generator_after_ra(cg) _arch_cg_call(cg, after_ra)
388 #define arch_code_generator_finish(cg) _arch_cg_call(cg, finish)
389 #define arch_code_generator_done(cg) _arch_cg_call(cg, done)
390 #define arch_code_generator_spill(cg, birg) _arch_cg_call_env(cg, birg, spill)
391 #define arch_code_generator_has_spiller(cg) ((cg)->impl->spill != NULL)
392 #define arch_code_generator_get_pic_base(cg) \
393 ((cg)->impl->get_pic_base != NULL ? (cg)->impl->get_pic_base(cg) : NULL)
396 * Code generator base class.
398 struct arch_code_generator_t {
399 const arch_code_generator_if_t *impl;
403 * Architecture interface.
405 struct arch_isa_if_t {
407 * Initialize the isa interface.
408 * @param file_handle the file handle to write the output to
409 * @param main_env the be main environment
410 * @return a new isa instance
412 arch_env_t *(*init)(FILE *file_handle);
415 * Free the isa instance.
417 void (*done)(void *self);
420 * Get the the number of register classes in the isa.
421 * @return The number of register classes.
423 unsigned (*get_n_reg_class)(const void *self);
426 * Get the i-th register class.
427 * @param i The number of the register class.
428 * @return The register class.
430 const arch_register_class_t *(*get_reg_class)(const void *self, unsigned i);
433 * Get the register class which shall be used to store a value of a given mode.
434 * @param self The this pointer.
435 * @param mode The mode in question.
436 * @return A register class which can hold values of the given mode.
438 const arch_register_class_t *(*get_reg_class_for_mode)(const void *self, const ir_mode *mode);
441 * Get the ABI restrictions for procedure calls.
442 * @param self The this pointer.
443 * @param call_type The call type of the method (procedure) in question.
444 * @param p The array of parameter locations to be filled.
446 void (*get_call_abi)(const void *self, ir_type *call_type, be_abi_call_t *abi);
449 * Get the code generator interface.
450 * @param self The this pointer.
451 * @return Some code generator interface.
453 const arch_code_generator_if_t *(*get_code_generator_if)(void *self);
456 * Get the list scheduler to use. There is already a selector given, the
457 * backend is free to modify and/or ignore it.
459 * @param self The isa object.
460 * @param selector The selector given by options.
461 * @return The list scheduler selector.
463 const list_sched_selector_t *(*get_list_sched_selector)(const void *self, list_sched_selector_t *selector);
466 * Get the ILP scheduler to use.
467 * @param self The isa object.
468 * @return The ILP scheduler selector
470 const ilp_sched_selector_t *(*get_ilp_sched_selector)(const void *self);
473 * Get the necessary alignment for storing a register of given class.
474 * @param self The isa object.
475 * @param cls The register class.
476 * @return The alignment in bytes.
478 int (*get_reg_class_alignment)(const void *self, const arch_register_class_t *cls);
481 * A "static" function, returns the frontend settings
482 * needed for this backend.
484 const backend_params *(*get_params)(void);
487 * Returns an 2-dim array of execution units, @p irn can be executed on.
488 * The first dimension is the type, the second the allowed units of this
490 * Each dimension is a NULL terminated list.
491 * @param self The isa object.
492 * @param irn The node.
493 * @return An array of allowed execution units.
495 * { unit1_of_tp1, ..., unitX1_of_tp1, NULL },
497 * { unit1_of_tpY, ..., unitXn_of_tpY, NULL },
501 const be_execution_unit_t ***(*get_allowed_execution_units)(const void *self, const ir_node *irn);
504 * Return the abstract machine for this isa.
505 * @param self The isa object.
507 const be_machine_t *(*get_machine)(const void *self);
510 * Return an ordered list of irgs where code should be generated for.
511 * If NULL is returned, all irg will be taken into account and they will be
512 * generated in an arbitrary order.
513 * @param self The isa object.
514 * @param irgs A flexible array ARR_F of length 0 where the backend can append the desired irgs.
515 * @return A flexible array ARR_F containing all desired irgs in the desired order.
517 ir_graph **(*get_backend_irg_list)(const void *self, ir_graph ***irgs);
520 * mark node as rematerialized
522 void (*mark_remat)(const void *self, ir_node *node);
525 * parse an assembler constraint part and set flags according to its nature
526 * advances the *c pointer to point to the last parsed character (so if you
527 * parse a single character don't advance c)
529 asm_constraint_flags_t (*parse_asm_constraint)(const void *self, const char **c);
532 * returns true if the string is a valid clobbered (register) in this
535 int (*is_valid_clobber)(const void *self, const char *clobber);
538 #define arch_env_done(env) ((env)->impl->done(env))
539 #define arch_env_get_n_reg_class(env) ((env)->impl->get_n_reg_class(env))
540 #define arch_env_get_reg_class(env,i) ((env)->impl->get_reg_class(env, i))
541 #define arch_env_get_reg_class_for_mode(env,mode) ((env)->impl->get_reg_class_for_mode((env), (mode)))
542 #define arch_env_get_call_abi(env,tp,abi) ((env)->impl->get_call_abi((env), (tp), (abi)))
543 #define arch_env_get_code_generator_if(env) ((env)->impl->get_code_generator_if((env)))
544 #define arch_env_get_list_sched_selector(env,selector) ((env)->impl->get_list_sched_selector((env), (selector)))
545 #define arch_env_get_ilp_sched_selector(env) ((env)->impl->get_ilp_sched_selector(env))
546 #define arch_env_get_reg_class_alignment(env,cls) ((env)->impl->get_reg_class_alignment((env), (cls)))
547 #define arch_env_get_params(env) ((env)->impl->get_params())
548 #define arch_env_get_allowed_execution_units(env,irn) ((env)->impl->get_allowed_execution_units((env), (irn)))
549 #define arch_env_get_machine(env) ((env)->impl->get_machine(env))
550 #define arch_env_get_backend_irg_list(env,irgs) ((env)->impl->get_backend_irg_list((env), (irgs)))
551 #define arch_env_parse_asm_constraint(env,c) ((env)->impl->parse_asm_constraint((env), (c))
552 #define arch_env_is_valid_clobber(env,clobber) ((env)->impl->is_valid_clobber((env), (clobber))
553 #define arch_env_mark_remat(env,node) \
554 do { if ((env)->impl->mark_remat != NULL) (env)->impl->mark_remat((env), (node)); } while(0)
560 const arch_isa_if_t *impl;
561 const arch_register_t *sp; /** The stack pointer register. */
562 const arch_register_t *bp; /** The base pointer register. */
563 int stack_dir; /** -1 for decreasing, 1 for increasing. */
564 int stack_alignment; /** power of 2 stack alignment */
565 const be_main_env_t *main_env; /** the be main environment */
566 int spill_cost; /** cost for a be_Spill node */
567 int reload_cost; /** cost for a be_Reload node */
570 #define arch_env_stack_dir(env) ((env)->stack_dir)
571 #define arch_env_sp(env) ((env)->sp)
572 #define arch_env_bp(env) ((env)->bp)
574 #endif /* FIRM_BE_BEARCH_T_H */