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 The main TEMPLATE backend driver file.
29 #include "pseudo_irg.h"
39 #include "../bearch_t.h"
40 #include "../benode_t.h"
41 #include "../belower.h"
42 #include "../besched_t.h"
45 #include "../bemodule.h"
46 #include "../begnuas.h"
48 #include "bearch_TEMPLATE_t.h"
50 #include "TEMPLATE_new_nodes.h"
51 #include "gen_TEMPLATE_regalloc_if.h"
52 #include "TEMPLATE_transform.h"
53 #include "TEMPLATE_emitter.h"
54 #include "TEMPLATE_map_regs.h"
56 /* TODO: ugly, but we need it to get access to the registers assigned to Phi nodes */
57 static set *cur_reg_set = NULL;
59 /**************************************************
62 * _ __ ___ __ _ __ _| | | ___ ___ _| |_
63 * | '__/ _ \/ _` | / _` | | |/ _ \ / __| | | _|
64 * | | | __/ (_| | | (_| | | | (_) | (__ | | |
65 * |_| \___|\__, | \__,_|_|_|\___/ \___| |_|_|
68 **************************************************/
71 * Return register requirements for a TEMPLATE node.
72 * If the node returns a tuple (mode_T) then the proj's
73 * will be asked for this information.
76 arch_register_req_t *TEMPLATE_get_irn_reg_req(const void *self,
77 const ir_node *node, int pos) {
78 long node_pos = pos == -1 ? 0 : pos;
79 ir_mode *mode = get_irn_mode(node);
82 if (mode == mode_T || mode == mode_M) {
83 return arch_no_register_req;
87 /* in case of a proj, we need to get the correct OUT slot */
88 /* of the node corresponding to the proj number */
90 node_pos = TEMPLATE_translate_proj_pos(node);
95 node = skip_Proj_const(node);
98 /* get requirements for our own nodes */
99 if (is_TEMPLATE_irn(node)) {
100 const arch_register_req_t *req;
102 req = get_TEMPLATE_in_req(node, pos);
104 req = get_TEMPLATE_out_req(node, node_pos);
112 /* unknowns should be transformed already */
113 assert(!is_Unknown(node));
115 return arch_no_register_req;
118 static void TEMPLATE_set_irn_reg(const void *self, ir_node *irn, const arch_register_t *reg)
124 pos = TEMPLATE_translate_proj_pos(irn);
125 irn = skip_Proj(irn);
128 if (is_TEMPLATE_irn(irn)) {
129 const arch_register_t **slots;
131 slots = get_TEMPLATE_slots(irn);
135 /* here we set the registers for the Phi nodes */
136 TEMPLATE_set_firm_reg(irn, reg, cur_reg_set);
141 const arch_register_t *TEMPLATE_get_irn_reg(const void *self,
145 const arch_register_t *reg = NULL;
149 pos = TEMPLATE_translate_proj_pos(irn);
150 irn = skip_Proj_const(irn);
153 if (is_TEMPLATE_irn(irn)) {
154 const arch_register_t * const *slots;
155 slots = get_TEMPLATE_slots_const(irn);
159 reg = TEMPLATE_get_firm_reg(irn, cur_reg_set);
165 static arch_irn_class_t TEMPLATE_classify(const void *self, const ir_node *irn) {
166 irn = skip_Proj_const(irn);
170 return arch_irn_class_branch;
172 else if (is_TEMPLATE_irn(irn)) {
173 return arch_irn_class_normal;
179 static arch_irn_flags_t TEMPLATE_get_flags(const void *self, const ir_node *irn) {
180 irn = skip_Proj_const(irn);
183 if (is_TEMPLATE_irn(irn)) {
184 return get_TEMPLATE_flags(irn);
186 else if (is_Unknown(irn)) {
187 return arch_irn_flags_ignore;
193 static ir_entity *TEMPLATE_get_frame_entity(const void *self, const ir_node *node) {
196 /* TODO: return the ir_entity assigned to the frame */
200 static void TEMPLATE_set_frame_entity(const void *self, ir_node *node, ir_entity *ent) {
204 /* TODO: set the ir_entity assigned to the frame */
208 * This function is called by the generic backend to correct offsets for
209 * nodes accessing the stack.
211 static void TEMPLATE_set_frame_offset(const void *self, ir_node *irn, int offset) {
215 /* TODO: correct offset if irn accesses the stack */
218 static int TEMPLATE_get_sp_bias(const void *self, const ir_node *irn) {
224 /* fill register allocator interface */
226 static const arch_irn_ops_if_t TEMPLATE_irn_ops_if = {
227 TEMPLATE_get_irn_reg_req,
228 TEMPLATE_set_irn_reg,
229 TEMPLATE_get_irn_reg,
232 TEMPLATE_get_frame_entity,
233 TEMPLATE_set_frame_entity,
234 TEMPLATE_set_frame_offset,
235 TEMPLATE_get_sp_bias,
236 NULL, /* get_inverse */
237 NULL, /* get_op_estimated_cost */
238 NULL, /* possible_memory_operand */
239 NULL, /* perform_memory_operand */
242 TEMPLATE_irn_ops_t TEMPLATE_irn_ops = {
243 &TEMPLATE_irn_ops_if,
249 /**************************************************
252 * ___ ___ __| | ___ __ _ ___ _ __ _| |_
253 * / __/ _ \ / _` |/ _ \/ _` |/ _ \ '_ \ | | _|
254 * | (_| (_) | (_| | __/ (_| | __/ | | | | | |
255 * \___\___/ \__,_|\___|\__, |\___|_| |_| |_|_|
258 **************************************************/
261 * Transforms the standard firm graph into
262 * a TEMLPATE firm graph
264 static void TEMPLATE_prepare_graph(void *self) {
265 TEMPLATE_code_gen_t *cg = self;
267 irg_walk_blkwise_graph(cg->irg, NULL, TEMPLATE_transform_node, cg);
273 * Called immediatly before emit phase.
275 static void TEMPLATE_finish_irg(void *self) {
276 TEMPLATE_code_gen_t *cg = self;
277 ir_graph *irg = cg->irg;
279 dump_ir_block_graph_sched(irg, "-TEMPLATE-finished");
284 * These are some hooks which must be filled but are probably not needed.
286 static void TEMPLATE_before_sched(void *self) {
288 /* Some stuff you need to do after scheduling but before register allocation */
291 static void TEMPLATE_before_ra(void *self) {
293 /* Some stuff you need to do after scheduling but before register allocation */
296 static void TEMPLATE_after_ra(void *self) {
298 /* Some stuff you need to do immediatly after register allocation */
304 * Emits the code, closes the output file and frees
305 * the code generator interface.
307 static void TEMPLATE_emit_and_done(void *self) {
308 TEMPLATE_code_gen_t *cg = self;
309 ir_graph *irg = cg->irg;
311 TEMPLATE_gen_routine(cg, irg);
315 /* de-allocate code generator */
316 del_set(cg->reg_set);
320 static void *TEMPLATE_cg_init(be_irg_t *birg);
322 static const arch_code_generator_if_t TEMPLATE_code_gen_if = {
324 NULL, /* before abi introduce hook */
325 TEMPLATE_prepare_graph,
326 NULL, /* spill hook */
327 TEMPLATE_before_sched, /* before scheduling hook */
328 TEMPLATE_before_ra, /* before register allocation hook */
329 TEMPLATE_after_ra, /* after register allocation hook */
331 TEMPLATE_emit_and_done
335 * Initializes the code generator.
337 static void *TEMPLATE_cg_init(be_irg_t *birg) {
338 const arch_env_t *arch_env = be_get_birg_arch_env(birg);
339 TEMPLATE_isa_t *isa = (TEMPLATE_isa_t *) arch_env->isa;
340 TEMPLATE_code_gen_t *cg = xmalloc(sizeof(*cg));
342 cg->impl = &TEMPLATE_code_gen_if;
343 cg->irg = be_get_birg_irg(birg);
344 cg->reg_set = new_set(TEMPLATE_cmp_irn_reg_assoc, 1024);
345 cg->arch_env = arch_env;
348 FIRM_DBG_REGISTER(cg->mod, "firm.be.TEMPLATE.cg");
350 cur_reg_set = cg->reg_set;
352 TEMPLATE_irn_ops.cg = cg;
354 return (arch_code_generator_t *)cg;
359 /*****************************************************************
360 * ____ _ _ _____ _____
361 * | _ \ | | | | |_ _|/ ____| /\
362 * | |_) | __ _ ___| | _____ _ __ __| | | | | (___ / \
363 * | _ < / _` |/ __| |/ / _ \ '_ \ / _` | | | \___ \ / /\ \
364 * | |_) | (_| | (__| < __/ | | | (_| | _| |_ ____) / ____ \
365 * |____/ \__,_|\___|_|\_\___|_| |_|\__,_| |_____|_____/_/ \_\
367 *****************************************************************/
369 static TEMPLATE_isa_t TEMPLATE_isa_template = {
371 &TEMPLATE_isa_if, /* isa interface implementation */
372 &TEMPLATE_general_purpose_regs[REG_SP], /* stack pointer register */
373 &TEMPLATE_general_purpose_regs[REG_BP], /* base pointer register */
374 -1, /* stack direction */
375 NULL, /* main environment */
376 7, /* costs for a spill instruction */
377 5, /* costs for a reload instruction */
379 { NULL, }, /* emitter environment */
383 * Initializes the backend ISA and opens the output file.
385 static void *TEMPLATE_init(FILE *outfile) {
386 static int run_once = 0;
393 isa = xcalloc(1, sizeof(*isa));
394 memcpy(isa, &TEMPLATE_isa_template, sizeof(*isa));
396 be_emit_init_env(&isa->emit, outfile);
398 TEMPLATE_register_init(isa);
399 TEMPLATE_create_opcodes();
407 * Closes the output file and frees the ISA structure.
409 static void TEMPLATE_done(void *self) {
410 TEMPLATE_isa_t *isa = self;
412 /* emit now all global declarations */
413 be_gas_emit_decls(&isa->emit, isa->arch_isa.main_env, 0);
415 be_emit_destroy_env(&isa->emit);
421 static int TEMPLATE_get_n_reg_class(const void *self) {
425 static const arch_register_class_t *TEMPLATE_get_reg_class(const void *self, int i) {
426 assert(i >= 0 && i < N_CLASSES && "Invalid TEMPLATE register class requested.");
427 return &TEMPLATE_reg_classes[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 *TEMPLATE_get_reg_class_for_mode(const void *self, const ir_mode *mode) {
439 if (mode_is_float(mode))
440 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_floating_point];
442 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_general_purpose];
448 be_abi_call_flags_bits_t flags;
449 const arch_env_t *arch_env;
450 const arch_isa_t *isa;
452 } TEMPLATE_abi_env_t;
454 static void *TEMPLATE_abi_init(const be_abi_call_t *call, const arch_env_t *arch_env, ir_graph *irg)
456 TEMPLATE_abi_env_t *env = xmalloc(sizeof(env[0]));
457 be_abi_call_flags_t fl = be_abi_call_get_flags(call);
458 env->flags = fl.bits;
460 env->arch_env = arch_env;
461 env->isa = arch_env->isa;
466 * Get the between type for that call.
467 * @param self The callback object.
468 * @return The between type of for that call.
470 static ir_type *TEMPLATE_get_between_type(void *self) {
471 //TEMPLATE_abi_env_t *env = self;
472 static ir_type *between_type = NULL;
473 static ir_entity *old_bp_ent = NULL;
476 ir_entity *ret_addr_ent;
477 ir_type *ret_addr_type = new_type_primitive(new_id_from_str("return_addr"), mode_P);
478 ir_type *old_bp_type = new_type_primitive(new_id_from_str("bp"), mode_P);
480 between_type = new_type_class(new_id_from_str("TEMPLATE_between_type"));
481 old_bp_ent = new_entity(between_type, new_id_from_str("old_bp"), old_bp_type);
482 ret_addr_ent = new_entity(between_type, new_id_from_str("old_bp"), ret_addr_type);
484 set_entity_offset(old_bp_ent, 0);
485 set_entity_offset(ret_addr_ent, get_type_size_bytes(old_bp_type));
486 set_type_size_bytes(between_type, get_type_size_bytes(old_bp_type) + get_type_size_bytes(ret_addr_type));
492 static void TEMPLATE_abi_dont_save_regs(void *self, pset *s)
494 TEMPLATE_abi_env_t *env = self;
495 if (env->flags.try_omit_fp) {
496 /* insert the BP register into the ignore set */
497 pset_insert_ptr(s, env->isa->bp);
502 * Build the prolog, return the BASE POINTER register
504 static const arch_register_t *TEMPLATE_abi_prologue(void *self, ir_node **mem, pmap *reg_map) {
505 TEMPLATE_abi_env_t *env = self;
507 if(env->flags.try_omit_fp)
512 /* Build the epilog */
513 static void TEMPLATE_abi_epilogue(void *self, ir_node *bl, ir_node **mem, pmap *reg_map) {
514 //TEMPLATE_abi_env_t *env = self;
517 static const be_abi_callbacks_t TEMPLATE_abi_callbacks = {
520 TEMPLATE_get_between_type,
521 TEMPLATE_abi_dont_save_regs,
522 TEMPLATE_abi_prologue,
523 TEMPLATE_abi_epilogue,
527 * Get the ABI restrictions for procedure calls.
528 * @param self The this pointer.
529 * @param method_type The type of the method (procedure) in question.
530 * @param abi The abi object to be modified
532 void TEMPLATE_get_call_abi(const void *self, ir_type *method_type, be_abi_call_t *abi) {
535 int i, n = get_method_n_params(method_type);
536 be_abi_call_flags_t call_flags;
538 /* set abi flags for calls */
539 call_flags.bits.left_to_right = 0;
540 call_flags.bits.store_args_sequential = 1;
541 call_flags.bits.try_omit_fp = 1;
542 call_flags.bits.fp_free = 0;
543 call_flags.bits.call_has_imm = 1;
545 /* set stack parameter passing style */
546 be_abi_call_set_flags(abi, call_flags, &TEMPLATE_abi_callbacks);
548 for (i = 0; i < n; i++) {
549 /* TODO: implement register parameter: */
550 /* reg = get reg for param i; */
551 /* be_abi_call_param_reg(abi, i, reg); */
553 /* default: all parameters on stack */
554 be_abi_call_param_stack(abi, i, 4, 0, 0);
557 /* TODO: set correct return register */
558 /* default: return value is in R0 resp. F0 */
559 if (get_method_n_ress(method_type) > 0) {
560 tp = get_method_res_type(method_type, 0);
561 mode = get_type_mode(tp);
563 be_abi_call_res_reg(abi, 0,
564 mode_is_float(mode) ? &TEMPLATE_floating_point_regs[REG_F0] : &TEMPLATE_general_purpose_regs[REG_R0]);
568 static const void *TEMPLATE_get_irn_ops(const arch_irn_handler_t *self, const ir_node *irn) {
569 return &TEMPLATE_irn_ops;
572 const arch_irn_handler_t TEMPLATE_irn_handler = {
576 const arch_irn_handler_t *TEMPLATE_get_irn_handler(const void *self) {
577 return &TEMPLATE_irn_handler;
580 int TEMPLATE_to_appear_in_schedule(void *block_env, const ir_node *irn) {
581 if(!is_TEMPLATE_irn(irn))
588 * Initializes the code generator interface.
590 static const arch_code_generator_if_t *TEMPLATE_get_code_generator_if(void *self) {
591 return &TEMPLATE_code_gen_if;
594 list_sched_selector_t TEMPLATE_sched_selector;
597 * Returns the reg_pressure scheduler with to_appear_in_schedule() overloaded
599 static const list_sched_selector_t *TEMPLATE_get_list_sched_selector(const void *self, list_sched_selector_t *selector) {
600 memcpy(&TEMPLATE_sched_selector, trivial_selector, sizeof(list_sched_selector_t));
601 TEMPLATE_sched_selector.to_appear_in_schedule = TEMPLATE_to_appear_in_schedule;
602 return &TEMPLATE_sched_selector;
605 static const ilp_sched_selector_t *TEMPLATE_get_ilp_sched_selector(const void *self) {
610 * Returns the necessary byte alignment for storing a register of given class.
612 static int TEMPLATE_get_reg_class_alignment(const void *self, const arch_register_class_t *cls) {
613 ir_mode *mode = arch_register_class_mode(cls);
614 return get_mode_size_bytes(mode);
618 * Returns the libFirm configuration parameter for this backend.
620 static const backend_params *TEMPLATE_get_backend_params(void) {
621 static arch_dep_params_t ad = {
623 0, /* Muls are fast enough on Firm */
624 31, /* shift would be ok */
629 static backend_params p = {
630 0, /* no dword lowering */
631 0, /* no inline assembly */
632 0, /* no different calling conventions */
633 NULL, /* no additional opcodes */
634 NULL, /* will be set later */
635 NULL, /* no creator function */
636 NULL, /* context for create_intrinsic_fkt */
637 NULL, /* parameter for if conversion */
644 static const be_execution_unit_t ***TEMPLATE_get_allowed_execution_units(const void *self, const ir_node *irn) {
650 static const be_machine_t *TEMPLATE_get_machine(const void *self) {
656 static ir_graph **TEMPLATE_get_backend_irg_list(const void *self, ir_graph ***irgs) {
661 const arch_isa_if_t TEMPLATE_isa_if = {
664 TEMPLATE_get_n_reg_class,
665 TEMPLATE_get_reg_class,
666 TEMPLATE_get_reg_class_for_mode,
667 TEMPLATE_get_call_abi,
668 TEMPLATE_get_irn_handler,
669 TEMPLATE_get_code_generator_if,
670 TEMPLATE_get_list_sched_selector,
671 TEMPLATE_get_ilp_sched_selector,
672 TEMPLATE_get_reg_class_alignment,
673 TEMPLATE_get_backend_params,
674 TEMPLATE_get_allowed_execution_units,
675 TEMPLATE_get_machine,
676 TEMPLATE_get_backend_irg_list
679 void be_init_arch_TEMPLATE(void)
681 be_register_isa_if("TEMPLATE", &TEMPLATE_isa_if);
684 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_TEMPLATE);