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);
81 if (mode == mode_T || mode == mode_M) {
82 return arch_no_register_req;
86 /* in case of a proj, we need to get the correct OUT slot */
87 /* of the node corresponding to the proj number */
89 node_pos = TEMPLATE_translate_proj_pos(node);
94 node = skip_Proj_const(node);
97 /* get requirements for our own nodes */
98 if (is_TEMPLATE_irn(node)) {
99 const arch_register_req_t *req;
101 req = get_TEMPLATE_in_req(node, pos);
103 req = get_TEMPLATE_out_req(node, node_pos);
111 /* unknowns should be transformed already */
112 assert(!is_Unknown(node));
114 return arch_no_register_req;
117 static void TEMPLATE_set_irn_reg(const void *self, ir_node *irn, const arch_register_t *reg) {
121 pos = TEMPLATE_translate_proj_pos(irn);
122 irn = skip_Proj(irn);
125 if (is_TEMPLATE_irn(irn)) {
126 const arch_register_t **slots;
128 slots = get_TEMPLATE_slots(irn);
132 /* here we set the registers for the Phi nodes */
133 TEMPLATE_set_firm_reg(irn, reg, cur_reg_set);
137 static const arch_register_t *TEMPLATE_get_irn_reg(const void *self, const ir_node *irn) {
139 const arch_register_t *reg = NULL;
142 pos = TEMPLATE_translate_proj_pos(irn);
143 irn = skip_Proj_const(irn);
146 if (is_TEMPLATE_irn(irn)) {
147 const arch_register_t **slots;
148 slots = get_TEMPLATE_slots(irn);
152 reg = TEMPLATE_get_firm_reg(irn, cur_reg_set);
158 static arch_irn_class_t TEMPLATE_classify(const void *self, const ir_node *irn) {
159 irn = skip_Proj_const(irn);
162 return arch_irn_class_branch;
164 else if (is_TEMPLATE_irn(irn)) {
165 return arch_irn_class_normal;
171 static arch_irn_flags_t TEMPLATE_get_flags(const void *self, const ir_node *irn) {
172 irn = skip_Proj_const(irn);
174 if (is_TEMPLATE_irn(irn)) {
175 return get_TEMPLATE_flags(irn);
177 else if (is_Unknown(irn)) {
178 return arch_irn_flags_ignore;
184 static ir_entity *TEMPLATE_get_frame_entity(const void *self, const ir_node *node) {
185 /* TODO: return the ir_entity assigned to the frame */
189 static void TEMPLATE_set_frame_entity(const void *self, ir_node *node, ir_entity *ent) {
190 /* TODO: set the ir_entity assigned to the frame */
194 * This function is called by the generic backend to correct offsets for
195 * nodes accessing the stack.
197 static void TEMPLATE_set_frame_offset(const void *self, ir_node *irn, int offset) {
198 /* TODO: correct offset if irn accesses the stack */
201 static int TEMPLATE_get_sp_bias(const void *self, const ir_node *irn) {
205 /* fill register allocator interface */
207 static const arch_irn_ops_if_t TEMPLATE_irn_ops_if = {
208 TEMPLATE_get_irn_reg_req,
209 TEMPLATE_set_irn_reg,
210 TEMPLATE_get_irn_reg,
213 TEMPLATE_get_frame_entity,
214 TEMPLATE_set_frame_entity,
215 TEMPLATE_set_frame_offset,
216 TEMPLATE_get_sp_bias,
217 NULL, /* get_inverse */
218 NULL, /* get_op_estimated_cost */
219 NULL, /* possible_memory_operand */
220 NULL, /* perform_memory_operand */
223 TEMPLATE_irn_ops_t TEMPLATE_irn_ops = {
224 &TEMPLATE_irn_ops_if,
230 /**************************************************
233 * ___ ___ __| | ___ __ _ ___ _ __ _| |_
234 * / __/ _ \ / _` |/ _ \/ _` |/ _ \ '_ \ | | _|
235 * | (_| (_) | (_| | __/ (_| | __/ | | | | | |
236 * \___\___/ \__,_|\___|\__, |\___|_| |_| |_|_|
239 **************************************************/
242 * Transforms the standard firm graph into
243 * a TEMLPATE firm graph
245 static void TEMPLATE_prepare_graph(void *self) {
246 TEMPLATE_code_gen_t *cg = self;
248 irg_walk_blkwise_graph(cg->irg, NULL, TEMPLATE_transform_node, cg);
254 * Called immediatly before emit phase.
256 static void TEMPLATE_finish_irg(void *self) {
257 TEMPLATE_code_gen_t *cg = self;
258 ir_graph *irg = cg->irg;
260 dump_ir_block_graph_sched(irg, "-TEMPLATE-finished");
265 * These are some hooks which must be filled but are probably not needed.
267 static void TEMPLATE_before_sched(void *self) {
268 /* Some stuff you need to do after scheduling but before register allocation */
271 static void TEMPLATE_before_ra(void *self) {
272 /* Some stuff you need to do after scheduling but before register allocation */
275 static void TEMPLATE_after_ra(void *self) {
276 /* Some stuff you need to do immediatly after register allocation */
282 * Emits the code, closes the output file and frees
283 * the code generator interface.
285 static void TEMPLATE_emit_and_done(void *self) {
286 TEMPLATE_code_gen_t *cg = self;
287 ir_graph *irg = cg->irg;
289 TEMPLATE_gen_routine(cg, irg);
293 /* de-allocate code generator */
294 del_set(cg->reg_set);
298 static void *TEMPLATE_cg_init(be_irg_t *birg);
300 static const arch_code_generator_if_t TEMPLATE_code_gen_if = {
302 NULL, /* before abi introduce hook */
303 TEMPLATE_prepare_graph,
304 NULL, /* spill hook */
305 TEMPLATE_before_sched, /* before scheduling hook */
306 TEMPLATE_before_ra, /* before register allocation hook */
307 TEMPLATE_after_ra, /* after register allocation hook */
309 TEMPLATE_emit_and_done
313 * Initializes the code generator.
315 static void *TEMPLATE_cg_init(be_irg_t *birg) {
316 const arch_env_t *arch_env = be_get_birg_arch_env(birg);
317 TEMPLATE_isa_t *isa = (TEMPLATE_isa_t *) arch_env->isa;
318 TEMPLATE_code_gen_t *cg = xmalloc(sizeof(*cg));
320 cg->impl = &TEMPLATE_code_gen_if;
321 cg->irg = be_get_birg_irg(birg);
322 cg->reg_set = new_set(TEMPLATE_cmp_irn_reg_assoc, 1024);
323 cg->arch_env = arch_env;
326 FIRM_DBG_REGISTER(cg->mod, "firm.be.TEMPLATE.cg");
328 cur_reg_set = cg->reg_set;
330 TEMPLATE_irn_ops.cg = cg;
332 return (arch_code_generator_t *)cg;
337 /*****************************************************************
338 * ____ _ _ _____ _____
339 * | _ \ | | | | |_ _|/ ____| /\
340 * | |_) | __ _ ___| | _____ _ __ __| | | | | (___ / \
341 * | _ < / _` |/ __| |/ / _ \ '_ \ / _` | | | \___ \ / /\ \
342 * | |_) | (_| | (__| < __/ | | | (_| | _| |_ ____) / ____ \
343 * |____/ \__,_|\___|_|\_\___|_| |_|\__,_| |_____|_____/_/ \_\
345 *****************************************************************/
347 static TEMPLATE_isa_t TEMPLATE_isa_template = {
349 &TEMPLATE_isa_if, /* isa interface implementation */
350 &TEMPLATE_general_purpose_regs[REG_SP], /* stack pointer register */
351 &TEMPLATE_general_purpose_regs[REG_BP], /* base pointer register */
352 -1, /* stack direction */
353 NULL, /* main environment */
355 { NULL, }, /* emitter environment */
359 * Initializes the backend ISA and opens the output file.
361 static void *TEMPLATE_init(FILE *outfile) {
362 static int run_once = 0;
369 isa = xcalloc(1, sizeof(*isa));
370 memcpy(isa, &TEMPLATE_isa_template, sizeof(*isa));
372 be_emit_init_env(&isa->emit, outfile);
374 TEMPLATE_register_init(isa);
375 TEMPLATE_create_opcodes();
383 * Closes the output file and frees the ISA structure.
385 static void TEMPLATE_done(void *self) {
386 TEMPLATE_isa_t *isa = self;
388 /* emit now all global declarations */
389 be_gas_emit_decls(&isa->emit, isa->arch_isa.main_env, 0);
391 be_emit_destroy_env(&isa->emit);
397 static int TEMPLATE_get_n_reg_class(const void *self) {
401 static const arch_register_class_t *TEMPLATE_get_reg_class(const void *self, int i) {
402 assert(i >= 0 && i < N_CLASSES && "Invalid TEMPLATE register class requested.");
403 return &TEMPLATE_reg_classes[i];
409 * Get the register class which shall be used to store a value of a given mode.
410 * @param self The this pointer.
411 * @param mode The mode in question.
412 * @return A register class which can hold values of the given mode.
414 const arch_register_class_t *TEMPLATE_get_reg_class_for_mode(const void *self, const ir_mode *mode) {
415 if (mode_is_float(mode))
416 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_floating_point];
418 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_general_purpose];
424 be_abi_call_flags_bits_t flags;
425 const arch_env_t *arch_env;
426 const arch_isa_t *isa;
428 } TEMPLATE_abi_env_t;
430 static void *TEMPLATE_abi_init(const be_abi_call_t *call, const arch_env_t *arch_env, ir_graph *irg)
432 TEMPLATE_abi_env_t *env = xmalloc(sizeof(env[0]));
433 be_abi_call_flags_t fl = be_abi_call_get_flags(call);
434 env->flags = fl.bits;
436 env->arch_env = arch_env;
437 env->isa = arch_env->isa;
442 * Get the between type for that call.
443 * @param self The callback object.
444 * @return The between type of for that call.
446 static ir_type *TEMPLATE_get_between_type(void *self) {
447 //TEMPLATE_abi_env_t *env = self;
448 static ir_type *between_type = NULL;
449 static ir_entity *old_bp_ent = NULL;
452 ir_entity *ret_addr_ent;
453 ir_type *ret_addr_type = new_type_primitive(new_id_from_str("return_addr"), mode_P);
454 ir_type *old_bp_type = new_type_primitive(new_id_from_str("bp"), mode_P);
456 between_type = new_type_class(new_id_from_str("TEMPLATE_between_type"));
457 old_bp_ent = new_entity(between_type, new_id_from_str("old_bp"), old_bp_type);
458 ret_addr_ent = new_entity(between_type, new_id_from_str("old_bp"), ret_addr_type);
460 set_entity_offset(old_bp_ent, 0);
461 set_entity_offset(ret_addr_ent, get_type_size_bytes(old_bp_type));
462 set_type_size_bytes(between_type, get_type_size_bytes(old_bp_type) + get_type_size_bytes(ret_addr_type));
468 static void TEMPLATE_abi_dont_save_regs(void *self, pset *s)
470 TEMPLATE_abi_env_t *env = self;
471 if (env->flags.try_omit_fp) {
472 /* insert the BP register into the ignore set */
473 pset_insert_ptr(s, env->isa->bp);
478 * Build the prolog, return the BASE POINTER register
480 static const arch_register_t *TEMPLATE_abi_prologue(void *self, ir_node **mem, pmap *reg_map) {
481 TEMPLATE_abi_env_t *env = self;
483 if(env->flags.try_omit_fp)
488 /* Build the epilog */
489 static void TEMPLATE_abi_epilogue(void *self, ir_node *bl, ir_node **mem, pmap *reg_map) {
490 //TEMPLATE_abi_env_t *env = self;
493 static const be_abi_callbacks_t TEMPLATE_abi_callbacks = {
496 TEMPLATE_get_between_type,
497 TEMPLATE_abi_dont_save_regs,
498 TEMPLATE_abi_prologue,
499 TEMPLATE_abi_epilogue,
503 * Get the ABI restrictions for procedure calls.
504 * @param self The this pointer.
505 * @param method_type The type of the method (procedure) in question.
506 * @param abi The abi object to be modified
508 void TEMPLATE_get_call_abi(const void *self, ir_type *method_type, be_abi_call_t *abi) {
511 int i, n = get_method_n_params(method_type);
512 be_abi_call_flags_t call_flags;
514 /* set abi flags for calls */
515 call_flags.bits.left_to_right = 0;
516 call_flags.bits.store_args_sequential = 1;
517 call_flags.bits.try_omit_fp = 1;
518 call_flags.bits.fp_free = 0;
519 call_flags.bits.call_has_imm = 1;
521 /* set stack parameter passing style */
522 be_abi_call_set_flags(abi, call_flags, &TEMPLATE_abi_callbacks);
524 for (i = 0; i < n; i++) {
525 /* TODO: implement register parameter: */
526 /* reg = get reg for param i; */
527 /* be_abi_call_param_reg(abi, i, reg); */
529 /* default: all parameters on stack */
530 be_abi_call_param_stack(abi, i, 4, 0, 0);
533 /* TODO: set correct return register */
534 /* default: return value is in R0 resp. F0 */
535 if (get_method_n_ress(method_type) > 0) {
536 tp = get_method_res_type(method_type, 0);
537 mode = get_type_mode(tp);
539 be_abi_call_res_reg(abi, 0,
540 mode_is_float(mode) ? &TEMPLATE_floating_point_regs[REG_F0] : &TEMPLATE_general_purpose_regs[REG_R0]);
544 static const void *TEMPLATE_get_irn_ops(const arch_irn_handler_t *self, const ir_node *irn) {
545 return &TEMPLATE_irn_ops;
548 const arch_irn_handler_t TEMPLATE_irn_handler = {
552 const arch_irn_handler_t *TEMPLATE_get_irn_handler(const void *self) {
553 return &TEMPLATE_irn_handler;
556 int TEMPLATE_to_appear_in_schedule(void *block_env, const ir_node *irn) {
557 return is_TEMPLATE_irn(irn);
561 * Initializes the code generator interface.
563 static const arch_code_generator_if_t *TEMPLATE_get_code_generator_if(void *self) {
564 return &TEMPLATE_code_gen_if;
567 list_sched_selector_t TEMPLATE_sched_selector;
570 * Returns the reg_pressure scheduler with to_appear_in_schedule() overloaded
572 static const list_sched_selector_t *TEMPLATE_get_list_sched_selector(const void *self, list_sched_selector_t *selector) {
573 memcpy(&TEMPLATE_sched_selector, trivial_selector, sizeof(list_sched_selector_t));
574 TEMPLATE_sched_selector.to_appear_in_schedule = TEMPLATE_to_appear_in_schedule;
575 return &TEMPLATE_sched_selector;
578 static const ilp_sched_selector_t *TEMPLATE_get_ilp_sched_selector(const void *self) {
583 * Returns the necessary byte alignment for storing a register of given class.
585 static int TEMPLATE_get_reg_class_alignment(const void *self, const arch_register_class_t *cls) {
586 ir_mode *mode = arch_register_class_mode(cls);
587 return get_mode_size_bytes(mode);
591 * Returns the libFirm configuration parameter for this backend.
593 static const backend_params *TEMPLATE_get_libfirm_params(void) {
594 static arch_dep_params_t ad = {
596 0, /* Muls are fast enough on Firm */
597 31, /* shift would be ok */
602 static backend_params p = {
603 NULL, /* no additional opcodes */
604 NULL, /* will be set later */
605 0, /* no dword lowering */
606 NULL, /* no creator function */
607 NULL, /* context for create_intrinsic_fkt */
614 static const be_execution_unit_t ***TEMPLATE_get_allowed_execution_units(const void *self, const ir_node *irn) {
620 static const be_machine_t *TEMPLATE_get_machine(const void *self) {
627 const arch_isa_if_t TEMPLATE_isa_if = {
630 TEMPLATE_get_n_reg_class,
631 TEMPLATE_get_reg_class,
632 TEMPLATE_get_reg_class_for_mode,
633 TEMPLATE_get_call_abi,
634 TEMPLATE_get_irn_handler,
635 TEMPLATE_get_code_generator_if,
636 TEMPLATE_get_list_sched_selector,
637 TEMPLATE_get_ilp_sched_selector,
638 TEMPLATE_get_reg_class_alignment,
639 TEMPLATE_get_libfirm_params,
640 TEMPLATE_get_allowed_execution_units,
644 void be_init_arch_TEMPLATE(void)
646 be_register_isa_if("TEMPLATE", &TEMPLATE_isa_if);
649 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_TEMPLATE);