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 mips backend driver file.
23 * @author Matthias Braun, Mehdi
28 #include "pseudo_irg.h"
45 #include "../bearch.h"
46 #include "../benode.h"
47 #include "../belower.h"
48 #include "../besched.h"
49 #include "../beblocksched.h"
53 #include "../bemachine.h"
54 #include "../bemodule.h"
55 #include "../bespillslots.h"
56 #include "../beemitter.h"
57 #include "../begnuas.h"
59 #include "bearch_mips_t.h"
61 #include "mips_new_nodes.h"
62 #include "gen_mips_regalloc_if.h"
63 #include "mips_transform.h"
64 #include "mips_emitter.h"
65 #include "mips_map_regs.h"
66 #include "mips_util.h"
67 #include "mips_scheduler.h"
69 #define DEBUG_MODULE "firm.be.mips.isa"
71 /* TODO: ugly, but we need it to get access to the registers assigned to Phi nodes */
72 static set *cur_reg_set = NULL;
74 /**************************************************
77 * _ __ ___ __ _ __ _| | | ___ ___ _| |_
78 * | '__/ _ \/ _` | / _` | | |/ _ \ / __| | | _|
79 * | | | __/ (_| | | (_| | | | (_) | (__ | | |
80 * |_| \___|\__, | \__,_|_|_|\___/ \___| |_|_|
83 **************************************************/
85 static arch_irn_class_t mips_classify(const ir_node *irn)
91 int mips_is_Load(const ir_node *node)
93 return is_mips_lw(node) || is_mips_lh(node) || is_mips_lhu(node) ||
94 is_mips_lb(node) || is_mips_lbu(node);
97 int mips_is_Store(const ir_node *node)
99 return is_mips_sw(node) || is_mips_sh(node) || is_mips_sb(node);
102 static ir_entity *mips_get_frame_entity(const ir_node *node)
104 const mips_load_store_attr_t *attr;
106 if(!is_mips_irn(node))
108 if(!mips_is_Load(node) && !mips_is_Store(node))
111 attr = get_mips_load_store_attr_const(node);
112 return attr->stack_entity;
115 static void mips_set_frame_entity(ir_node *node, ir_entity *entity)
117 mips_load_store_attr_t *attr;
119 if(!is_mips_irn(node)) {
120 panic("trying to set frame entity on non load/store node %+F", node);
122 if(!mips_is_Load(node) && !mips_is_Store(node)) {
123 panic("trying to set frame entity on non load/store node %+F", node);
126 attr = get_irn_generic_attr(node);
127 attr->stack_entity = entity;
131 * This function is called by the generic backend to correct offsets for
132 * nodes accessing the stack.
134 static void mips_set_frame_offset(ir_node *node, int offset)
136 mips_load_store_attr_t *attr;
138 if(!is_mips_irn(node)) {
139 panic("trying to set frame offset on non load/store node %+F", node);
141 if(!mips_is_Load(node) && !mips_is_Store(node)) {
142 panic("trying to set frame offset on non load/store node %+F", node);
145 attr = get_irn_generic_attr(node);
146 attr->offset += offset;
148 if(attr->offset < -32768 || attr->offset > 32767) {
149 panic("Out of stack space! (mips supports only 16bit offsets)");
153 static int mips_get_sp_bias(const ir_node *irn)
159 /* fill register allocator interface */
161 static const arch_irn_ops_t mips_irn_ops = {
165 mips_get_frame_entity,
166 mips_set_frame_entity,
167 mips_set_frame_offset,
169 NULL, /* get_inverse */
170 NULL, /* get_op_estimated_cost */
171 NULL, /* possible_memory_operand */
172 NULL, /* perform_memory_operand */
175 /**************************************************
178 * ___ ___ __| | ___ __ _ ___ _ __ _| |_
179 * / __/ _ \ / _` |/ _ \/ _` |/ _ \ '_ \ | | _|
180 * | (_| (_) | (_| | __/ (_| | __/ | | | | | |
181 * \___\___/ \__,_|\___|\__, |\___|_| |_| |_|_|
184 **************************************************/
187 * Transforms the standard firm graph into
190 static void mips_prepare_graph(void *self) {
191 mips_code_gen_t *cg = self;
193 /* do local optimizations */
194 optimize_graph_df(cg->irg);
196 /* TODO: we often have dead code reachable through out-edges here. So for
197 * now we rebuild edges (as we need correct user count for code selection)
200 edges_deactivate(cg->irg);
201 edges_activate(cg->irg);
204 // walk the graph and transform firm nodes into mips nodes where possible
205 mips_transform_graph(cg);
206 dump_ir_block_graph_sched(cg->irg, "-transformed");
208 /* do local optimizations (mainly CSE) */
209 optimize_graph_df(cg->irg);
211 /* do code placement, to optimize the position of constants */
214 be_dump(cg->irg, "-place", dump_ir_block_graph_sched);
218 * Called immediately before emit phase.
220 static void mips_finish_irg(void *self) {
221 mips_code_gen_t *cg = self;
222 ir_graph *irg = cg->irg;
224 /* create block schedule, this also removes empty blocks which might
225 * produce critical edges */
226 cg->block_schedule = be_create_block_schedule(irg, cg->birg->exec_freq);
228 dump_ir_block_graph_sched(irg, "-mips-finished");
232 static void mips_before_ra(void *self)
237 static void mips_after_ra(void* self)
239 mips_code_gen_t *cg = self;
240 be_coalesce_spillslots(cg->birg);
241 irg_walk_blkwise_graph(cg->irg, NULL, mips_after_ra_walker, self);
245 * Emits the code, closes the output file and frees
246 * the code generator interface.
248 static void mips_emit_and_done(void *self)
250 mips_code_gen_t *cg = self;
251 ir_graph *irg = cg->irg;
254 mips_gen_routine(cg, irg);
258 /* de-allocate code generator */
259 del_set(cg->reg_set);
263 static void *mips_cg_init(be_irg_t *birg);
265 static const arch_code_generator_if_t mips_code_gen_if = {
267 NULL, /* get_pic_base */
268 NULL, /* before abi introduce */
271 mips_before_ra, /* before register allocation hook */
278 * Initializes the code generator.
280 static void *mips_cg_init(be_irg_t *birg)
282 const arch_env_t *arch_env = be_get_birg_arch_env(birg);
283 mips_isa_t *isa = (mips_isa_t *) arch_env;
284 mips_code_gen_t *cg = XMALLOCZ(mips_code_gen_t);
286 cg->impl = &mips_code_gen_if;
287 cg->irg = be_get_birg_irg(birg);
288 cg->reg_set = new_set(mips_cmp_irn_reg_assoc, 1024);
292 cur_reg_set = cg->reg_set;
296 return (arch_code_generator_t *)cg;
300 /*****************************************************************
301 * ____ _ _ _____ _____
302 * | _ \ | | | | |_ _|/ ____| /\
303 * | |_) | __ _ ___| | _____ _ __ __| | | | | (___ / \
304 * | _ < / _` |/ __| |/ / _ \ '_ \ / _` | | | \___ \ / /\ \
305 * | |_) | (_| | (__| < __/ | | | (_| | _| |_ ____) / ____ \
306 * |____/ \__,_|\___|_|\_\___|_| |_|\__,_| |_____|_____/_/ \_\
308 *****************************************************************/
310 static mips_isa_t mips_isa_template = {
313 &mips_gp_regs[REG_SP],
314 &mips_gp_regs[REG_FP],
315 &mips_reg_classes[CLASS_mips_gp],
316 -1, /* stack direction */
317 2, /* power of two stack alignment for calls, 2^2 == 4 */
318 NULL, /* main environment */
320 5, /* reload costs */
326 * Initializes the backend ISA and opens the output file.
328 static arch_env_t *mips_init(FILE *file_handle) {
329 static int inited = 0;
336 isa = XMALLOC(mips_isa_t);
337 memcpy(isa, &mips_isa_template, sizeof(isa[0]));
339 be_emit_init(file_handle);
341 mips_register_init();
342 mips_create_opcodes(&mips_irn_ops);
343 // mips_init_opcode_transforms();
345 /* we mark referenced global entities, so we can only emit those which
346 * are actually referenced. (Note: you mustn't use the type visited flag
347 * elsewhere in the backend)
349 inc_master_type_visited();
351 return &isa->arch_env;
355 * Closes the output file and frees the ISA structure.
357 static void mips_done(void *self)
359 mips_isa_t *isa = self;
361 be_gas_emit_decls(isa->arch_env.main_env, 1);
367 static unsigned mips_get_n_reg_class(void)
372 static const arch_register_class_t *mips_get_reg_class(unsigned i)
374 assert(i < N_CLASSES);
375 return &mips_reg_classes[i];
381 * Get the register class which shall be used to store a value of a given mode.
382 * @param self The this pointer.
383 * @param mode The mode in question.
384 * @return A register class which can hold values of the given mode.
386 const arch_register_class_t *mips_get_reg_class_for_mode(const ir_mode *mode)
389 ASSERT_NO_FLOAT(mode);
390 return &mips_reg_classes[CLASS_mips_gp];
394 be_abi_call_flags_bits_t flags;
395 const arch_env_t *arch_env;
397 // do special handling to support debuggers
401 static void *mips_abi_init(const be_abi_call_t *call, const arch_env_t *arch_env, ir_graph *irg)
403 mips_abi_env_t *env = XMALLOC(mips_abi_env_t);
404 be_abi_call_flags_t fl = be_abi_call_get_flags(call);
405 env->flags = fl.bits;
407 env->arch_env = arch_env;
412 static const arch_register_t *mips_abi_prologue(void *self, ir_node** mem, pmap *reg_map, int *stack_bias)
414 mips_abi_env_t *env = self;
415 ir_graph *irg = env->irg;
416 ir_node *block = get_irg_start_block(irg);
417 ir_node *sp = be_abi_reg_map_get(reg_map, &mips_gp_regs[REG_SP]);
418 ir_node *fp = be_abi_reg_map_get(reg_map, &mips_gp_regs[REG_FP]);
419 int initialstackframesize;
425 * The calling conventions wants a stack frame of at least 24bytes size with
426 * a0-a3 saved in offset 0-12
427 * fp saved in offset 16
428 * ra saved in offset 20
431 ir_node *sync, *reg, *store;
432 initialstackframesize = 24;
434 // - setup first part of stackframe
435 sp = new_bd_mips_addu(NULL, block, sp,
436 mips_create_Immediate(initialstackframesize));
437 arch_set_irn_register(sp, &mips_gp_regs[REG_SP]);
438 panic("FIXME Use IncSP or set register requirement with ignore");
440 /* TODO: where to get an edge with a0-a3
442 for(i = 0; i < 4; ++i) {
443 ir_node *reg = be_abi_reg_map_get(reg_map, &mips_gp_regs[REG_A0 + i]);
444 ir_node *store = new_bd_mips_store_r(dbg, block, *mem, sp, reg, mode_T);
445 attr = get_mips_attr(store);
446 attr->load_store_mode = mode_Iu;
447 attr->tv = new_tarval_from_long(i * 4, mode_Is);
449 mm[i] = new_r_Proj(irg, block, store, mode_M, pn_Store_M);
453 reg = be_abi_reg_map_get(reg_map, &mips_gp_regs[REG_FP]);
454 store = new_bd_mips_sw(NULL, block, sp, reg, *mem, NULL, 16);
458 reg = be_abi_reg_map_get(reg_map, &mips_gp_regs[REG_RA]);
459 store = new_bd_mips_sw(NULL, block, sp, reg, *mem, NULL, 20);
463 /* Note: ideally we would route these mem edges directly towards the
464 * epilogue, but this is currently not supported so we sync all mems
466 sync = new_r_Sync(block, 2, mm+4);
469 ir_node *reg, *store;
470 initialstackframesize = 4;
472 // save old framepointer
473 sp = new_bd_mips_addu(NULL, block, sp,
474 mips_create_Immediate(-initialstackframesize));
475 arch_set_irn_register(sp, &mips_gp_regs[REG_SP]);
476 panic("FIXME Use IncSP or set register requirement with ignore");
478 reg = be_abi_reg_map_get(reg_map, &mips_gp_regs[REG_FP]);
479 store = new_bd_mips_sw(NULL, block, sp, reg, *mem, NULL, 0);
484 // setup framepointer
485 fp = new_bd_mips_addu(NULL, block, sp,
486 mips_create_Immediate(-initialstackframesize));
487 arch_set_irn_register(fp, &mips_gp_regs[REG_FP]);
488 panic("FIXME Use IncSP or set register requirement with ignore");
490 be_abi_reg_map_set(reg_map, &mips_gp_regs[REG_FP], fp);
491 be_abi_reg_map_set(reg_map, &mips_gp_regs[REG_SP], sp);
493 return &mips_gp_regs[REG_SP];
496 static void mips_abi_epilogue(void *self, ir_node *block, ir_node **mem, pmap *reg_map)
498 mips_abi_env_t *env = self;
500 ir_node *sp = be_abi_reg_map_get(reg_map, &mips_gp_regs[REG_SP]);
501 ir_node *fp = be_abi_reg_map_get(reg_map, &mips_gp_regs[REG_FP]);
503 int initial_frame_size = env->debug ? 24 : 4;
504 int fp_save_offset = env->debug ? 16 : 0;
507 sp = new_bd_mips_or(NULL, block, fp, mips_create_zero());
508 arch_set_irn_register(sp, &mips_gp_regs[REG_SP]);
509 panic("FIXME Use be_Copy or set register requirement with ignore");
512 load = new_bd_mips_lw(NULL, block, sp, *mem, NULL,
513 fp_save_offset - initial_frame_size);
514 panic("FIXME register requirement with ignore");
516 fp = new_r_Proj(block, load, mode_Iu, pn_mips_lw_res);
517 *mem = new_r_Proj(block, load, mode_Iu, pn_mips_lw_M);
518 arch_set_irn_register(fp, &mips_gp_regs[REG_FP]);
520 be_abi_reg_map_set(reg_map, &mips_gp_regs[REG_FP], fp);
521 be_abi_reg_map_set(reg_map, &mips_gp_regs[REG_SP], sp);
525 * Produces the type which sits between the stack args and the locals on the stack.
526 * it will contain the return address and space to store the old frame pointer.
527 * @return The Firm type modelling the ABI between type.
529 static ir_type *mips_abi_get_between_type(void *self) {
530 mips_abi_env_t *env = self;
532 static ir_type *debug_between_type = NULL;
533 static ir_type *opt_between_type = NULL;
534 static ir_entity *old_fp_ent = NULL;
536 if(env->debug && debug_between_type == NULL) {
537 ir_entity *a0_ent, *a1_ent, *a2_ent, *a3_ent;
538 ir_entity *ret_addr_ent;
539 ir_type *ret_addr_type = new_type_primitive(new_id_from_str("return_addr"), mode_P);
540 ir_type *old_fp_type = new_type_primitive(new_id_from_str("fp"), mode_P);
541 ir_type *old_param_type = new_type_primitive(new_id_from_str("param"), mode_Iu);
543 debug_between_type = new_type_class(new_id_from_str("mips_between_type"));
544 a0_ent = new_entity(debug_between_type, new_id_from_str("a0_ent"), old_param_type);
545 a1_ent = new_entity(debug_between_type, new_id_from_str("a1_ent"), old_param_type);
546 a2_ent = new_entity(debug_between_type, new_id_from_str("a2_ent"), old_param_type);
547 a3_ent = new_entity(debug_between_type, new_id_from_str("a3_ent"), old_param_type);
548 old_fp_ent = new_entity(debug_between_type, new_id_from_str("old_fp"), old_fp_type);
549 ret_addr_ent = new_entity(debug_between_type, new_id_from_str("ret_addr"), ret_addr_type);
551 set_entity_offset(a0_ent, 0);
552 set_entity_offset(a1_ent, 4);
553 set_entity_offset(a2_ent, 8);
554 set_entity_offset(a3_ent, 12);
555 set_entity_offset(old_fp_ent, 16);
556 set_entity_offset(ret_addr_ent, 20);
558 set_type_size_bytes(debug_between_type, 24);
559 } else if(!env->debug && opt_between_type == NULL) {
560 ir_type *old_fp_type = new_type_primitive(new_id_from_str("fp"), mode_P);
561 ir_entity *old_fp_ent;
563 opt_between_type = new_type_class(new_id_from_str("mips_between_type"));
564 old_fp_ent = new_entity(opt_between_type, new_id_from_str("old_fp"), old_fp_type);
565 set_entity_offset(old_fp_ent, 0);
566 set_type_size_bytes(opt_between_type, 4);
569 return env->debug ? debug_between_type : opt_between_type;
572 static const be_abi_callbacks_t mips_abi_callbacks = {
575 mips_abi_get_between_type,
581 * Get the ABI restrictions for procedure calls.
582 * @param self The this pointer.
583 * @param method_type The type of the method (procedure) in question.
584 * @param abi The abi object to be modified
586 static void mips_get_call_abi(const void *self, ir_type *method_type,
591 int n = get_method_n_params(method_type);
595 const arch_register_t *reg;
596 be_abi_call_flags_t call_flags;
599 memset(&call_flags, 0, sizeof(call_flags));
600 call_flags.bits.left_to_right = 0;
601 call_flags.bits.store_args_sequential = 0;
602 call_flags.bits.try_omit_fp = 1;
603 call_flags.bits.fp_free = 0;
604 call_flags.bits.call_has_imm = 1;
606 /* set stack parameter passing style */
607 be_abi_call_set_flags(abi, call_flags, &mips_abi_callbacks);
609 /* collect the mode for each type */
610 modes = ALLOCAN(ir_mode*, n);
611 for (i = 0; i < n; i++) {
612 tp = get_method_param_type(method_type, i);
613 modes[i] = get_type_mode(tp);
616 // assigns parameters to registers or stack
617 for (i = 0; i < n; i++) {
618 // first 4 params in $a0-$a3, the others on the stack
620 reg = &mips_gp_regs[REG_A0 + i];
621 be_abi_call_param_reg(abi, i, reg);
623 /* default: all parameters on stack */
624 be_abi_call_param_stack(abi, i, modes[i], 4, 0, 0);
628 /* set return register */
629 /* default: return value is in R0 (and maybe R1) */
630 result_count = get_method_n_ress(method_type);
631 assert(result_count <= 2 && "More than 2 result values not supported");
632 for(i = 0; i < result_count; ++i) {
633 const arch_register_t* reg;
634 tp = get_method_res_type(method_type, i);
635 mode = get_type_mode(tp);
636 ASSERT_NO_FLOAT(mode);
638 reg = &mips_gp_regs[REG_V0 + i];
639 be_abi_call_res_reg(abi, i, reg);
644 * Initializes the code generator interface.
646 static const arch_code_generator_if_t *mips_get_code_generator_if(void *self)
649 return &mips_code_gen_if;
653 * Returns the necessary byte alignment for storing a register of given class.
655 static int mips_get_reg_class_alignment(const arch_register_class_t *cls)
657 ir_mode *mode = arch_register_class_mode(cls);
658 return get_mode_size_bytes(mode);
661 static const be_execution_unit_t ***mips_get_allowed_execution_units(
666 panic("Unimplemented mips_get_allowed_execution_units()");
669 static const be_machine_t *mips_get_machine(const void *self)
673 panic("Unimplemented mips_get_machine()");
677 * Return irp irgs in the desired order.
679 static ir_graph **mips_get_irg_list(const void *self, ir_graph ***irg_list)
687 * Returns the libFirm configuration parameter for this backend.
689 static const backend_params *mips_get_libfirm_params(void) {
690 static backend_params p = {
691 1, /* need dword lowering */
692 0, /* don't support inline assembler yet */
693 NULL, /* will be set later */
694 NULL, /* but yet no creator function */
695 NULL, /* context for create_intrinsic_fkt */
696 NULL, /* no if conversion settings */
697 NULL, /* float arithmetic mode (TODO) */
698 0, /* no trampoline support: size 0 */
699 0, /* no trampoline support: align 0 */
700 NULL, /* no trampoline support: no trampoline builder */
701 4 /* alignment of stack parameter */
707 static asm_constraint_flags_t mips_parse_asm_constraint(const char **c)
710 return ASM_CONSTRAINT_FLAG_INVALID;
713 static int mips_is_valid_clobber(const char *clobber)
719 const arch_isa_if_t mips_isa_if = {
722 NULL, /* handle intrinsics */
723 mips_get_n_reg_class,
725 mips_get_reg_class_for_mode,
727 mips_get_code_generator_if,
728 mips_get_list_sched_selector,
729 mips_get_ilp_sched_selector,
730 mips_get_reg_class_alignment,
731 mips_get_libfirm_params,
732 mips_get_allowed_execution_units,
735 NULL, /* mark remat */
736 mips_parse_asm_constraint,
737 mips_is_valid_clobber
740 void be_init_arch_mips(void)
742 be_register_isa_if("mips", &mips_isa_if);
745 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_mips);