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 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.
75 static const arch_register_req_t *TEMPLATE_get_irn_reg_req(const ir_node *node,
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(ir_node *irn, const arch_register_t *reg)
122 pos = TEMPLATE_translate_proj_pos(irn);
123 irn = skip_Proj(irn);
126 if (is_TEMPLATE_irn(irn)) {
127 const arch_register_t **slots;
129 slots = get_TEMPLATE_slots(irn);
133 /* here we set the registers for the Phi nodes */
134 TEMPLATE_set_firm_reg(irn, reg, cur_reg_set);
138 static const arch_register_t *TEMPLATE_get_irn_reg(const ir_node *irn)
141 const arch_register_t *reg = NULL;
144 pos = TEMPLATE_translate_proj_pos(irn);
145 irn = skip_Proj_const(irn);
148 if (is_TEMPLATE_irn(irn)) {
149 const arch_register_t * const *slots;
150 slots = get_TEMPLATE_slots_const(irn);
154 reg = TEMPLATE_get_firm_reg(irn, cur_reg_set);
160 static arch_irn_class_t TEMPLATE_classify(const ir_node *irn)
162 irn = skip_Proj_const(irn);
165 return arch_irn_class_branch;
167 else if (is_TEMPLATE_irn(irn)) {
168 return arch_irn_class_normal;
174 static arch_irn_flags_t TEMPLATE_get_flags(const ir_node *irn)
176 irn = skip_Proj_const(irn);
178 if (is_TEMPLATE_irn(irn)) {
179 return get_TEMPLATE_flags(irn);
181 else if (is_Unknown(irn)) {
182 return arch_irn_flags_ignore;
188 static ir_entity *TEMPLATE_get_frame_entity(const ir_node *node)
191 /* TODO: return the ir_entity assigned to the frame */
195 static void TEMPLATE_set_frame_entity(ir_node *node, ir_entity *ent)
199 /* TODO: set the ir_entity assigned to the frame */
203 * This function is called by the generic backend to correct offsets for
204 * nodes accessing the stack.
206 static void TEMPLATE_set_frame_offset(ir_node *irn, int offset)
210 /* TODO: correct offset if irn accesses the stack */
213 static int TEMPLATE_get_sp_bias(const ir_node *irn)
219 /* fill register allocator interface */
221 static const arch_irn_ops_t TEMPLATE_irn_ops = {
222 TEMPLATE_get_irn_reg_req,
223 TEMPLATE_set_irn_reg,
224 TEMPLATE_get_irn_reg,
227 TEMPLATE_get_frame_entity,
228 TEMPLATE_set_frame_entity,
229 TEMPLATE_set_frame_offset,
230 TEMPLATE_get_sp_bias,
231 NULL, /* get_inverse */
232 NULL, /* get_op_estimated_cost */
233 NULL, /* possible_memory_operand */
234 NULL, /* perform_memory_operand */
237 /**************************************************
240 * ___ ___ __| | ___ __ _ ___ _ __ _| |_
241 * / __/ _ \ / _` |/ _ \/ _` |/ _ \ '_ \ | | _|
242 * | (_| (_) | (_| | __/ (_| | __/ | | | | | |
243 * \___\___/ \__,_|\___|\__, |\___|_| |_| |_|_|
246 **************************************************/
249 * Transforms the standard firm graph into
250 * a TEMLPATE firm graph
252 static void TEMPLATE_prepare_graph(void *self) {
253 TEMPLATE_code_gen_t *cg = self;
255 irg_walk_blkwise_graph(cg->irg, NULL, TEMPLATE_transform_node, cg);
261 * Called immediatly before emit phase.
263 static void TEMPLATE_finish_irg(void *self) {
264 TEMPLATE_code_gen_t *cg = self;
265 ir_graph *irg = cg->irg;
267 dump_ir_block_graph_sched(irg, "-TEMPLATE-finished");
272 * These are some hooks which must be filled but are probably not needed.
274 static void TEMPLATE_before_sched(void *self) {
276 /* Some stuff you need to do after scheduling but before register allocation */
279 static void TEMPLATE_before_ra(void *self) {
281 /* Some stuff you need to do after scheduling but before register allocation */
284 static void TEMPLATE_after_ra(void *self) {
286 /* Some stuff you need to do immediatly after register allocation */
292 * Emits the code, closes the output file and frees
293 * the code generator interface.
295 static void TEMPLATE_emit_and_done(void *self) {
296 TEMPLATE_code_gen_t *cg = self;
297 ir_graph *irg = cg->irg;
299 TEMPLATE_gen_routine(cg, irg);
303 /* de-allocate code generator */
304 del_set(cg->reg_set);
308 static void *TEMPLATE_cg_init(be_irg_t *birg);
310 static const arch_code_generator_if_t TEMPLATE_code_gen_if = {
312 NULL, /* get_pic_base hook */
313 NULL, /* before abi introduce hook */
314 TEMPLATE_prepare_graph,
315 NULL, /* spill hook */
316 TEMPLATE_before_sched, /* before scheduling hook */
317 TEMPLATE_before_ra, /* before register allocation hook */
318 TEMPLATE_after_ra, /* after register allocation hook */
320 TEMPLATE_emit_and_done
324 * Initializes the code generator.
326 static void *TEMPLATE_cg_init(be_irg_t *birg) {
327 const arch_env_t *arch_env = be_get_birg_arch_env(birg);
328 TEMPLATE_isa_t *isa = (TEMPLATE_isa_t *) arch_env;
329 TEMPLATE_code_gen_t *cg = xmalloc(sizeof(*cg));
331 cg->impl = &TEMPLATE_code_gen_if;
332 cg->irg = be_get_birg_irg(birg);
333 cg->reg_set = new_set(TEMPLATE_cmp_irn_reg_assoc, 1024);
334 cg->arch_env = arch_env;
337 FIRM_DBG_REGISTER(cg->mod, "firm.be.TEMPLATE.cg");
339 cur_reg_set = cg->reg_set;
341 return (arch_code_generator_t *)cg;
346 /*****************************************************************
347 * ____ _ _ _____ _____
348 * | _ \ | | | | |_ _|/ ____| /\
349 * | |_) | __ _ ___| | _____ _ __ __| | | | | (___ / \
350 * | _ < / _` |/ __| |/ / _ \ '_ \ / _` | | | \___ \ / /\ \
351 * | |_) | (_| | (__| < __/ | | | (_| | _| |_ ____) / ____ \
352 * |____/ \__,_|\___|_|\_\___|_| |_|\__,_| |_____|_____/_/ \_\
354 *****************************************************************/
356 static TEMPLATE_isa_t TEMPLATE_isa_template = {
358 &TEMPLATE_isa_if, /* isa interface implementation */
359 &TEMPLATE_general_purpose_regs[REG_SP], /* stack pointer register */
360 &TEMPLATE_general_purpose_regs[REG_BP], /* base pointer register */
361 -1, /* stack direction */
362 2, /* power of two stack alignment for calls, 2^2 == 4 */
363 NULL, /* main environment */
364 7, /* costs for a spill instruction */
365 5, /* costs for a reload instruction */
370 * Initializes the backend ISA and opens the output file.
372 static arch_env_t *TEMPLATE_init(FILE *outfile) {
373 static int run_once = 0;
380 isa = xcalloc(1, sizeof(*isa));
381 memcpy(isa, &TEMPLATE_isa_template, sizeof(*isa));
383 be_emit_init(outfile);
385 TEMPLATE_register_init();
386 TEMPLATE_create_opcodes(&TEMPLATE_irn_ops);
388 return &isa->arch_env;
394 * Closes the output file and frees the ISA structure.
396 static void TEMPLATE_done(void *self) {
397 TEMPLATE_isa_t *isa = self;
399 /* emit now all global declarations */
400 be_gas_emit_decls(isa->arch_env.main_env, 0);
408 static unsigned TEMPLATE_get_n_reg_class(const void *self)
414 static const arch_register_class_t *TEMPLATE_get_reg_class(const void *self,
418 assert(i < N_CLASSES);
419 return &TEMPLATE_reg_classes[i];
425 * Get the register class which shall be used to store a value of a given mode.
426 * @param self The this pointer.
427 * @param mode The mode in question.
428 * @return A register class which can hold values of the given mode.
430 const arch_register_class_t *TEMPLATE_get_reg_class_for_mode(const void *self,
434 if (mode_is_float(mode))
435 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_floating_point];
437 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_general_purpose];
443 be_abi_call_flags_bits_t flags;
444 const arch_env_t *arch_env;
446 } TEMPLATE_abi_env_t;
448 static void *TEMPLATE_abi_init(const be_abi_call_t *call, const arch_env_t *arch_env, ir_graph *irg)
450 TEMPLATE_abi_env_t *env = xmalloc(sizeof(env[0]));
451 be_abi_call_flags_t fl = be_abi_call_get_flags(call);
452 env->flags = fl.bits;
454 env->arch_env = arch_env;
459 * Get the between type for that call.
460 * @param self The callback object.
461 * @return The between type of for that call.
463 static ir_type *TEMPLATE_get_between_type(void *self)
465 static ir_type *between_type = NULL;
466 static ir_entity *old_bp_ent = NULL;
470 ir_entity *ret_addr_ent;
471 ir_type *ret_addr_type = new_type_primitive(new_id_from_str("return_addr"), mode_P);
472 ir_type *old_bp_type = new_type_primitive(new_id_from_str("bp"), mode_P);
474 between_type = new_type_class(new_id_from_str("TEMPLATE_between_type"));
475 old_bp_ent = new_entity(between_type, new_id_from_str("old_bp"), old_bp_type);
476 ret_addr_ent = new_entity(between_type, new_id_from_str("old_bp"), ret_addr_type);
478 set_entity_offset(old_bp_ent, 0);
479 set_entity_offset(ret_addr_ent, get_type_size_bytes(old_bp_type));
480 set_type_size_bytes(between_type, get_type_size_bytes(old_bp_type) + get_type_size_bytes(ret_addr_type));
486 static void TEMPLATE_abi_dont_save_regs(void *self, pset *s)
488 TEMPLATE_abi_env_t *env = self;
489 if (env->flags.try_omit_fp) {
490 /* insert the BP register into the ignore set */
491 pset_insert_ptr(s, env->arch_env->bp);
496 * Build the prolog, return the BASE POINTER register
498 static const arch_register_t *TEMPLATE_abi_prologue(void *self, ir_node **mem,
501 TEMPLATE_abi_env_t *env = self;
505 if(env->flags.try_omit_fp)
506 return env->arch_env->sp;
507 return env->arch_env->bp;
510 /* Build the epilog */
511 static void TEMPLATE_abi_epilogue(void *self, ir_node *bl, ir_node **mem,
520 static const be_abi_callbacks_t TEMPLATE_abi_callbacks = {
523 TEMPLATE_get_between_type,
524 TEMPLATE_abi_dont_save_regs,
525 TEMPLATE_abi_prologue,
526 TEMPLATE_abi_epilogue,
530 * Get the ABI restrictions for procedure calls.
531 * @param self The this pointer.
532 * @param method_type The type of the method (procedure) in question.
533 * @param abi The abi object to be modified
535 void TEMPLATE_get_call_abi(const void *self, ir_type *method_type,
540 int i, n = get_method_n_params(method_type);
541 be_abi_call_flags_t call_flags;
544 /* set abi flags for calls */
545 call_flags.bits.left_to_right = 0;
546 call_flags.bits.store_args_sequential = 1;
547 call_flags.bits.try_omit_fp = 1;
548 call_flags.bits.fp_free = 0;
549 call_flags.bits.call_has_imm = 1;
551 /* set stack parameter passing style */
552 be_abi_call_set_flags(abi, call_flags, &TEMPLATE_abi_callbacks);
554 for (i = 0; i < n; i++) {
555 /* TODO: implement register parameter: */
556 /* reg = get reg for param i; */
557 /* be_abi_call_param_reg(abi, i, reg); */
559 /* default: all parameters on stack */
560 tp = get_method_param_type(method_type, i);
561 mode = get_type_mode(tp);
562 be_abi_call_param_stack(abi, i, mode, 4, 0, 0);
565 /* TODO: set correct return register */
566 /* default: return value is in R0 resp. F0 */
567 if (get_method_n_ress(method_type) > 0) {
568 tp = get_method_res_type(method_type, 0);
569 mode = get_type_mode(tp);
571 be_abi_call_res_reg(abi, 0,
572 mode_is_float(mode) ? &TEMPLATE_floating_point_regs[REG_F0] : &TEMPLATE_general_purpose_regs[REG_R0]);
576 int TEMPLATE_to_appear_in_schedule(void *block_env, const ir_node *irn)
580 if(!is_TEMPLATE_irn(irn))
587 * Initializes the code generator interface.
589 static const arch_code_generator_if_t *TEMPLATE_get_code_generator_if(
593 return &TEMPLATE_code_gen_if;
596 list_sched_selector_t TEMPLATE_sched_selector;
599 * Returns the reg_pressure scheduler with to_appear_in_schedule() overloaded
601 static const list_sched_selector_t *TEMPLATE_get_list_sched_selector(
602 const void *self, list_sched_selector_t *selector)
607 TEMPLATE_sched_selector = trivial_selector;
608 TEMPLATE_sched_selector.to_appear_in_schedule = TEMPLATE_to_appear_in_schedule;
609 return &TEMPLATE_sched_selector;
612 static const ilp_sched_selector_t *TEMPLATE_get_ilp_sched_selector(
620 * Returns the necessary byte alignment for storing a register of given class.
622 static int TEMPLATE_get_reg_class_alignment(const void *self,
623 const arch_register_class_t *cls) {
624 ir_mode *mode = arch_register_class_mode(cls);
626 return get_mode_size_bytes(mode);
630 * Returns the libFirm configuration parameter for this backend.
632 static const backend_params *TEMPLATE_get_backend_params(void) {
633 static backend_params p = {
634 0, /* no dword lowering */
635 0, /* no inline assembly */
636 0, /* no immediate floating point mode. */
637 NULL, /* no additional opcodes */
638 NULL, /* will be set later */
639 NULL, /* no creator function */
640 NULL, /* context for create_intrinsic_fkt */
641 NULL, /* parameter for if conversion */
642 NULL /* no immediate fp mode */
647 static const be_execution_unit_t ***TEMPLATE_get_allowed_execution_units(
648 const void *self, const ir_node *irn)
657 static const be_machine_t *TEMPLATE_get_machine(const void *self)
665 static ir_graph **TEMPLATE_get_backend_irg_list(const void *self,
673 static asm_constraint_flags_t TEMPLATE_parse_asm_constraint(const void *self,
678 return ASM_CONSTRAINT_FLAG_INVALID;
681 static bool TEMPLATE_is_valid_clobber(const void *self, const char *clobber)
688 const arch_isa_if_t TEMPLATE_isa_if = {
691 TEMPLATE_get_n_reg_class,
692 TEMPLATE_get_reg_class,
693 TEMPLATE_get_reg_class_for_mode,
694 TEMPLATE_get_call_abi,
695 TEMPLATE_get_code_generator_if,
696 TEMPLATE_get_list_sched_selector,
697 TEMPLATE_get_ilp_sched_selector,
698 TEMPLATE_get_reg_class_alignment,
699 TEMPLATE_get_backend_params,
700 TEMPLATE_get_allowed_execution_units,
701 TEMPLATE_get_machine,
702 TEMPLATE_get_backend_irg_list,
703 TEMPLATE_parse_asm_constraint,
704 TEMPLATE_is_valid_clobber
707 void be_init_arch_TEMPLATE(void)
709 be_register_isa_if("TEMPLATE", &TEMPLATE_isa_if);
712 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_TEMPLATE);