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.
27 #include "pseudo_irg.h"
37 #include "../bearch_t.h"
38 #include "../benode_t.h"
39 #include "../belower.h"
40 #include "../besched_t.h"
43 #include "../bemodule.h"
44 #include "../begnuas.h"
46 #include "bearch_TEMPLATE_t.h"
48 #include "TEMPLATE_new_nodes.h"
49 #include "gen_TEMPLATE_regalloc_if.h"
50 #include "TEMPLATE_transform.h"
51 #include "TEMPLATE_emitter.h"
52 #include "TEMPLATE_map_regs.h"
54 /* TODO: ugly, but we need it to get access to the registers assigned to Phi nodes */
55 static set *cur_reg_set = NULL;
57 /**************************************************
60 * _ __ ___ __ _ __ _| | | ___ ___ _| |_
61 * | '__/ _ \/ _` | / _` | | |/ _ \ / __| | | _|
62 * | | | __/ (_| | | (_| | | | (_) | (__ | | |
63 * |_| \___|\__, | \__,_|_|_|\___/ \___| |_|_|
66 **************************************************/
69 * Return register requirements for a TEMPLATE node.
70 * If the node returns a tuple (mode_T) then the proj's
71 * will be asked for this information.
73 static const arch_register_req_t *TEMPLATE_get_irn_reg_req(const ir_node *node,
76 long node_pos = pos == -1 ? 0 : pos;
77 ir_mode *mode = get_irn_mode(node);
79 if (mode == mode_T || mode == mode_M) {
80 return arch_no_register_req;
84 /* in case of a proj, we need to get the correct OUT slot */
85 /* of the node corresponding to the proj number */
87 node_pos = TEMPLATE_translate_proj_pos(node);
92 node = skip_Proj_const(node);
95 /* get requirements for our own nodes */
96 if (is_TEMPLATE_irn(node)) {
97 const arch_register_req_t *req;
99 req = get_TEMPLATE_in_req(node, pos);
101 req = get_TEMPLATE_out_req(node, node_pos);
109 /* unknowns should be transformed already */
110 assert(!is_Unknown(node));
112 return arch_no_register_req;
115 static void TEMPLATE_set_irn_reg(ir_node *irn, const arch_register_t *reg)
120 pos = TEMPLATE_translate_proj_pos(irn);
121 irn = skip_Proj(irn);
124 if (is_TEMPLATE_irn(irn)) {
125 const arch_register_t **slots;
127 slots = get_TEMPLATE_slots(irn);
131 /* here we set the registers for the Phi nodes */
132 TEMPLATE_set_firm_reg(irn, reg, cur_reg_set);
136 static const arch_register_t *TEMPLATE_get_irn_reg(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 * const *slots;
148 slots = get_TEMPLATE_slots_const(irn);
152 reg = TEMPLATE_get_firm_reg(irn, cur_reg_set);
158 static arch_irn_class_t TEMPLATE_classify(const ir_node *irn)
160 irn = skip_Proj_const(irn);
163 return arch_irn_class_branch;
169 static arch_irn_flags_t TEMPLATE_get_flags(const ir_node *irn)
171 irn = skip_Proj_const(irn);
173 if (is_TEMPLATE_irn(irn)) {
174 return get_TEMPLATE_flags(irn);
176 else if (is_Unknown(irn)) {
177 return arch_irn_flags_ignore;
183 static ir_entity *TEMPLATE_get_frame_entity(const ir_node *node)
186 /* TODO: return the ir_entity assigned to the frame */
190 static void TEMPLATE_set_frame_entity(ir_node *node, ir_entity *ent)
194 /* TODO: set the ir_entity assigned to the frame */
198 * This function is called by the generic backend to correct offsets for
199 * nodes accessing the stack.
201 static void TEMPLATE_set_frame_offset(ir_node *irn, int offset)
205 /* TODO: correct offset if irn accesses the stack */
208 static int TEMPLATE_get_sp_bias(const ir_node *irn)
214 /* fill register allocator interface */
216 static const arch_irn_ops_t TEMPLATE_irn_ops = {
217 TEMPLATE_get_irn_reg_req,
218 TEMPLATE_set_irn_reg,
219 TEMPLATE_get_irn_reg,
222 TEMPLATE_get_frame_entity,
223 TEMPLATE_set_frame_entity,
224 TEMPLATE_set_frame_offset,
225 TEMPLATE_get_sp_bias,
226 NULL, /* get_inverse */
227 NULL, /* get_op_estimated_cost */
228 NULL, /* possible_memory_operand */
229 NULL, /* perform_memory_operand */
232 /**************************************************
235 * ___ ___ __| | ___ __ _ ___ _ __ _| |_
236 * / __/ _ \ / _` |/ _ \/ _` |/ _ \ '_ \ | | _|
237 * | (_| (_) | (_| | __/ (_| | __/ | | | | | |
238 * \___\___/ \__,_|\___|\__, |\___|_| |_| |_|_|
241 **************************************************/
244 * Transforms the standard firm graph into
245 * a TEMLPATE firm graph
247 static void TEMPLATE_prepare_graph(void *self) {
248 TEMPLATE_code_gen_t *cg = self;
250 irg_walk_blkwise_graph(cg->irg, NULL, TEMPLATE_transform_node, cg);
256 * Called immediatly before emit phase.
258 static void TEMPLATE_finish_irg(void *self) {
259 TEMPLATE_code_gen_t *cg = self;
260 ir_graph *irg = cg->irg;
262 dump_ir_block_graph_sched(irg, "-TEMPLATE-finished");
266 static void TEMPLATE_before_ra(void *self) {
268 /* Some stuff you need to do after scheduling but before register allocation */
271 static void TEMPLATE_after_ra(void *self) {
273 /* Some stuff you need to do immediatly after register allocation */
279 * Emits the code, closes the output file and frees
280 * the code generator interface.
282 static void TEMPLATE_emit_and_done(void *self) {
283 TEMPLATE_code_gen_t *cg = self;
284 ir_graph *irg = cg->irg;
286 TEMPLATE_gen_routine(cg, irg);
290 /* de-allocate code generator */
291 del_set(cg->reg_set);
295 static void *TEMPLATE_cg_init(be_irg_t *birg);
297 static const arch_code_generator_if_t TEMPLATE_code_gen_if = {
299 NULL, /* get_pic_base hook */
300 NULL, /* before abi introduce hook */
301 TEMPLATE_prepare_graph,
302 NULL, /* spill hook */
303 TEMPLATE_before_ra, /* before register allocation hook */
304 TEMPLATE_after_ra, /* after register allocation hook */
306 TEMPLATE_emit_and_done
310 * Initializes the code generator.
312 static void *TEMPLATE_cg_init(be_irg_t *birg) {
313 const arch_env_t *arch_env = be_get_birg_arch_env(birg);
314 TEMPLATE_isa_t *isa = (TEMPLATE_isa_t *) arch_env;
315 TEMPLATE_code_gen_t *cg = XMALLOC(TEMPLATE_code_gen_t);
317 cg->impl = &TEMPLATE_code_gen_if;
318 cg->irg = be_get_birg_irg(birg);
319 cg->reg_set = new_set(TEMPLATE_cmp_irn_reg_assoc, 1024);
320 cg->arch_env = arch_env;
323 FIRM_DBG_REGISTER(cg->mod, "firm.be.TEMPLATE.cg");
325 cur_reg_set = cg->reg_set;
327 return (arch_code_generator_t *)cg;
332 /*****************************************************************
333 * ____ _ _ _____ _____
334 * | _ \ | | | | |_ _|/ ____| /\
335 * | |_) | __ _ ___| | _____ _ __ __| | | | | (___ / \
336 * | _ < / _` |/ __| |/ / _ \ '_ \ / _` | | | \___ \ / /\ \
337 * | |_) | (_| | (__| < __/ | | | (_| | _| |_ ____) / ____ \
338 * |____/ \__,_|\___|_|\_\___|_| |_|\__,_| |_____|_____/_/ \_\
340 *****************************************************************/
342 static TEMPLATE_isa_t TEMPLATE_isa_template = {
344 &TEMPLATE_isa_if, /* isa interface implementation */
345 &TEMPLATE_general_purpose_regs[REG_SP], /* stack pointer register */
346 &TEMPLATE_general_purpose_regs[REG_BP], /* base pointer register */
347 -1, /* stack direction */
348 2, /* power of two stack alignment for calls, 2^2 == 4 */
349 NULL, /* main environment */
350 7, /* costs for a spill instruction */
351 5, /* costs for a reload instruction */
356 * Initializes the backend ISA and opens the output file.
358 static arch_env_t *TEMPLATE_init(FILE *outfile) {
359 static int run_once = 0;
366 isa = XMALLOC(TEMPLATE_isa_t);
367 memcpy(isa, &TEMPLATE_isa_template, sizeof(*isa));
369 be_emit_init(outfile);
371 TEMPLATE_register_init();
372 TEMPLATE_create_opcodes(&TEMPLATE_irn_ops);
374 return &isa->arch_env;
380 * Closes the output file and frees the ISA structure.
382 static void TEMPLATE_done(void *self) {
383 TEMPLATE_isa_t *isa = self;
385 /* emit now all global declarations */
386 be_gas_emit_decls(isa->arch_env.main_env, 0);
394 static unsigned TEMPLATE_get_n_reg_class(const void *self)
400 static const arch_register_class_t *TEMPLATE_get_reg_class(const void *self,
404 assert(i < N_CLASSES);
405 return &TEMPLATE_reg_classes[i];
411 * Get the register class which shall be used to store a value of a given mode.
412 * @param self The this pointer.
413 * @param mode The mode in question.
414 * @return A register class which can hold values of the given mode.
416 const arch_register_class_t *TEMPLATE_get_reg_class_for_mode(const void *self,
420 if (mode_is_float(mode))
421 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_floating_point];
423 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_general_purpose];
429 be_abi_call_flags_bits_t flags;
430 const arch_env_t *arch_env;
432 } TEMPLATE_abi_env_t;
434 static void *TEMPLATE_abi_init(const be_abi_call_t *call, const arch_env_t *arch_env, ir_graph *irg)
436 TEMPLATE_abi_env_t *env = XMALLOC(TEMPLATE_abi_env_t);
437 be_abi_call_flags_t fl = be_abi_call_get_flags(call);
438 env->flags = fl.bits;
440 env->arch_env = arch_env;
445 * Get the between type for that call.
446 * @param self The callback object.
447 * @return The between type of for that call.
449 static ir_type *TEMPLATE_get_between_type(void *self)
451 static ir_type *between_type = NULL;
452 static ir_entity *old_bp_ent = NULL;
456 ir_entity *ret_addr_ent;
457 ir_type *ret_addr_type = new_type_primitive(new_id_from_str("return_addr"), mode_P);
458 ir_type *old_bp_type = new_type_primitive(new_id_from_str("bp"), mode_P);
460 between_type = new_type_class(new_id_from_str("TEMPLATE_between_type"));
461 old_bp_ent = new_entity(between_type, new_id_from_str("old_bp"), old_bp_type);
462 ret_addr_ent = new_entity(between_type, new_id_from_str("old_bp"), ret_addr_type);
464 set_entity_offset(old_bp_ent, 0);
465 set_entity_offset(ret_addr_ent, get_type_size_bytes(old_bp_type));
466 set_type_size_bytes(between_type, get_type_size_bytes(old_bp_type) + get_type_size_bytes(ret_addr_type));
472 static void TEMPLATE_abi_dont_save_regs(void *self, pset *s)
474 TEMPLATE_abi_env_t *env = self;
475 if (env->flags.try_omit_fp) {
476 /* insert the BP register into the ignore set */
477 pset_insert_ptr(s, env->arch_env->bp);
482 * Build the prolog, return the BASE POINTER register
484 static const arch_register_t *TEMPLATE_abi_prologue(void *self, ir_node **mem,
485 pmap *reg_map, int *stack_bias)
487 TEMPLATE_abi_env_t *env = self;
492 if(env->flags.try_omit_fp)
493 return env->arch_env->sp;
494 return env->arch_env->bp;
497 /* Build the epilog */
498 static void TEMPLATE_abi_epilogue(void *self, ir_node *bl, ir_node **mem,
507 static const be_abi_callbacks_t TEMPLATE_abi_callbacks = {
510 TEMPLATE_get_between_type,
511 TEMPLATE_abi_dont_save_regs,
512 TEMPLATE_abi_prologue,
513 TEMPLATE_abi_epilogue,
517 * Get the ABI restrictions for procedure calls.
518 * @param self The this pointer.
519 * @param method_type The type of the method (procedure) in question.
520 * @param abi The abi object to be modified
522 void TEMPLATE_get_call_abi(const void *self, ir_type *method_type,
527 int i, n = get_method_n_params(method_type);
528 be_abi_call_flags_t call_flags;
531 /* set abi flags for calls */
532 call_flags.bits.left_to_right = 0;
533 call_flags.bits.store_args_sequential = 1;
534 call_flags.bits.try_omit_fp = 1;
535 call_flags.bits.fp_free = 0;
536 call_flags.bits.call_has_imm = 1;
538 /* set stack parameter passing style */
539 be_abi_call_set_flags(abi, call_flags, &TEMPLATE_abi_callbacks);
541 for (i = 0; i < n; i++) {
542 /* TODO: implement register parameter: */
543 /* reg = get reg for param i; */
544 /* be_abi_call_param_reg(abi, i, reg); */
546 /* default: all parameters on stack */
547 tp = get_method_param_type(method_type, i);
548 mode = get_type_mode(tp);
549 be_abi_call_param_stack(abi, i, mode, 4, 0, 0);
552 /* TODO: set correct return register */
553 /* default: return value is in R0 resp. F0 */
554 if (get_method_n_ress(method_type) > 0) {
555 tp = get_method_res_type(method_type, 0);
556 mode = get_type_mode(tp);
558 be_abi_call_res_reg(abi, 0,
559 mode_is_float(mode) ? &TEMPLATE_floating_point_regs[REG_F0] : &TEMPLATE_general_purpose_regs[REG_R0]);
563 int TEMPLATE_to_appear_in_schedule(void *block_env, const ir_node *irn)
567 if(!is_TEMPLATE_irn(irn))
574 * Initializes the code generator interface.
576 static const arch_code_generator_if_t *TEMPLATE_get_code_generator_if(
580 return &TEMPLATE_code_gen_if;
583 list_sched_selector_t TEMPLATE_sched_selector;
586 * Returns the reg_pressure scheduler with to_appear_in_schedule() overloaded
588 static const list_sched_selector_t *TEMPLATE_get_list_sched_selector(
589 const void *self, list_sched_selector_t *selector)
594 TEMPLATE_sched_selector = trivial_selector;
595 TEMPLATE_sched_selector.to_appear_in_schedule = TEMPLATE_to_appear_in_schedule;
596 return &TEMPLATE_sched_selector;
599 static const ilp_sched_selector_t *TEMPLATE_get_ilp_sched_selector(
607 * Returns the necessary byte alignment for storing a register of given class.
609 static int TEMPLATE_get_reg_class_alignment(const void *self,
610 const arch_register_class_t *cls) {
611 ir_mode *mode = arch_register_class_mode(cls);
613 return get_mode_size_bytes(mode);
617 * Returns the libFirm configuration parameter for this backend.
619 static const backend_params *TEMPLATE_get_backend_params(void) {
620 static backend_params p = {
621 0, /* no dword lowering */
622 0, /* no inline assembly */
623 0, /* no immediate floating point mode. */
624 NULL, /* no additional opcodes */
625 NULL, /* will be set later */
626 NULL, /* no creator function */
627 NULL, /* context for create_intrinsic_fkt */
628 NULL, /* parameter for if conversion */
629 NULL /* no immediate fp mode */
634 static const be_execution_unit_t ***TEMPLATE_get_allowed_execution_units(
635 const void *self, const ir_node *irn)
644 static const be_machine_t *TEMPLATE_get_machine(const void *self)
652 static ir_graph **TEMPLATE_get_backend_irg_list(const void *self,
660 static asm_constraint_flags_t TEMPLATE_parse_asm_constraint(const void *self,
665 return ASM_CONSTRAINT_FLAG_INVALID;
668 static int TEMPLATE_is_valid_clobber(const void *self, const char *clobber)
675 const arch_isa_if_t TEMPLATE_isa_if = {
678 TEMPLATE_get_n_reg_class,
679 TEMPLATE_get_reg_class,
680 TEMPLATE_get_reg_class_for_mode,
681 TEMPLATE_get_call_abi,
682 TEMPLATE_get_code_generator_if,
683 TEMPLATE_get_list_sched_selector,
684 TEMPLATE_get_ilp_sched_selector,
685 TEMPLATE_get_reg_class_alignment,
686 TEMPLATE_get_backend_params,
687 TEMPLATE_get_allowed_execution_units,
688 TEMPLATE_get_machine,
689 TEMPLATE_get_backend_irg_list,
690 NULL, /* mark remat */
691 TEMPLATE_parse_asm_constraint,
692 TEMPLATE_is_valid_clobber
695 void be_init_arch_TEMPLATE(void)
697 be_register_isa_if("TEMPLATE", &TEMPLATE_isa_if);
700 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_TEMPLATE);