spill-slot coalescing added
[libfirm] / ir / be / mips / bearch_mips.c
1 /*
2  * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
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.
10  *
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.
14  *
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
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief   The main mips backend driver file.
23  * @author  Matthias Braun, Mehdi
24  * @version $Id$
25  */
26 #ifdef HAVE_CONFIG_H
27 #include "config.h"
28 #endif
29
30 #include "pseudo_irg.h"
31 #include "irgwalk.h"
32 #include "irprog.h"
33 #include "irprintf.h"
34 #include "ircons.h"
35 #include "irgmod.h"
36 #include "irgopt.h"
37 #include "irgwalk.h"
38 #include "iredges.h"
39 #include "irdump.h"
40 #include "irextbb.h"
41 #include "error.h"
42
43 #include "bitset.h"
44 #include "debug.h"
45
46 #include "../bearch_t.h"
47 #include "../benode_t.h"
48 #include "../belower.h"
49 #include "../besched_t.h"
50 #include "../be.h"
51 #include "../beabi.h"
52 #include "../bemachine.h"
53 #include "../bemodule.h"
54 #include "../bespillslots.h"
55 #include "../beemitter.h"
56 #include "../begnuas.h"
57
58 #include "bearch_mips_t.h"
59
60 #include "mips_new_nodes.h"
61 #include "gen_mips_regalloc_if.h"
62 #include "mips_transform.h"
63 #include "mips_emitter.h"
64 #include "mips_map_regs.h"
65 #include "mips_util.h"
66 #include "mips_scheduler.h"
67
68 #define DEBUG_MODULE "firm.be.mips.isa"
69
70 /* TODO: ugly, but we need it to get access to the registers assigned to Phi nodes */
71 static set *cur_reg_set = NULL;
72
73 /**************************************************
74  *                         _ _              _  __
75  *                        | | |            (_)/ _|
76  *  _ __ ___  __ _    __ _| | | ___   ___   _| |_
77  * | '__/ _ \/ _` |  / _` | | |/ _ \ / __| | |  _|
78  * | | |  __/ (_| | | (_| | | | (_) | (__  | | |
79  * |_|  \___|\__, |  \__,_|_|_|\___/ \___| |_|_|
80  *            __/ |
81  *           |___/
82  **************************************************/
83
84 /**
85  * Return register requirements for a mips node.
86  * If the node returns a tuple (mode_T) then the proj's
87  * will be asked for this information.
88  */
89 static const
90 arch_register_req_t *mips_get_irn_reg_req(const void *self,
91                                           const ir_node *node, int pos) {
92         long               node_pos = pos == -1 ? 0 : pos;
93         ir_mode           *mode     = get_irn_mode(node);
94
95         if (is_Block(node) || mode == mode_X || mode == mode_M) {
96                 return arch_no_register_req;
97         }
98
99         if (mode == mode_T && pos < 0) {
100                 return arch_no_register_req;
101         }
102
103         if (is_Proj(node)) {
104                 /* in case of a proj, we need to get the correct OUT slot */
105                 /* of the node corresponding to the proj number */
106                 if (pos == -1) {
107                         node_pos = mips_translate_proj_pos(node);
108                 }
109                 else {
110                         node_pos = pos;
111                 }
112
113                 node = skip_Proj_const(node);
114         }
115
116         /* get requirements for our own nodes */
117         if (is_mips_irn(node)) {
118                 const arch_register_req_t *req;
119                 if (pos >= 0) {
120                         req = get_mips_in_req(node, pos);
121                 } else {
122                         req = get_mips_out_req(node, node_pos);
123                 }
124
125                 return req;
126         }
127
128         /* unknown should be translated by now */
129         assert(!is_Unknown(node));
130
131         return arch_no_register_req;
132 }
133
134 static void mips_set_irn_reg(const void *self, ir_node *irn, const arch_register_t *reg) {
135         int pos = 0;
136
137         if (is_Proj(irn)) {
138
139                 if (get_irn_mode(irn) == mode_X) {
140                         return;
141                 }
142
143                 pos = mips_translate_proj_pos(irn);
144                 irn = skip_Proj(irn);
145         }
146
147         if (is_mips_irn(irn)) {
148                 const arch_register_t **slots;
149
150                 slots      = get_mips_slots(irn);
151                 slots[pos] = reg;
152         }
153         else {
154                 /* here we set the registers for the Phi nodes */
155                 mips_set_firm_reg(irn, reg, cur_reg_set);
156         }
157 }
158
159 static const arch_register_t *mips_get_irn_reg(const void *self, const ir_node *irn) {
160         int pos = 0;
161         const arch_register_t *reg = NULL;
162
163         if (is_Proj(irn)) {
164
165                 if (get_irn_mode(irn) == mode_X) {
166                         return NULL;
167                 }
168
169                 pos = mips_translate_proj_pos(irn);
170                 irn = skip_Proj_const(irn);
171         }
172
173         if (is_mips_irn(irn)) {
174                 const arch_register_t **slots;
175                 slots = get_mips_slots(irn);
176                 reg   = slots[pos];
177         }
178         else {
179                 reg = mips_get_firm_reg(irn, cur_reg_set);
180         }
181
182         return reg;
183 }
184
185 static arch_irn_class_t mips_classify(const void *self, const ir_node *irn) {
186         irn = skip_Proj_const(irn);
187
188         if (is_cfop(irn)) {
189                 return arch_irn_class_branch;
190         } else if (is_mips_irn(irn)) {
191                 return arch_irn_class_normal;
192         }
193
194         return 0;
195 }
196
197 static arch_irn_flags_t mips_get_flags(const void *self, const ir_node *irn) {
198         irn = skip_Proj_const(irn);
199
200         if (is_mips_irn(irn)) {
201                 return get_mips_flags(irn);
202         }
203         else if (is_Unknown(irn)) {
204                 return arch_irn_flags_ignore;
205         }
206
207         return 0;
208 }
209
210 static
211 ir_entity *mips_get_frame_entity(const void *self, const ir_node *node) {
212         mips_attr_t *attr;
213
214         if(!is_mips_irn(node))
215                 return NULL;
216
217         attr = get_mips_attr(node);
218         return attr->stack_entity;
219 }
220
221 static
222 void mips_set_frame_entity(const void *self, ir_node *irn, ir_entity *ent) {
223         mips_attr_t *attr  = get_mips_attr(irn);
224         attr->stack_entity = ent;
225 }
226
227 /**
228  * This function is called by the generic backend to correct offsets for
229  * nodes accessing the stack.
230  */
231 static void mips_set_frame_offset(const void *self, ir_node *irn, int offset)
232 {
233         panic("TODO");
234 #if 0
235         mips_attr_t *attr = get_mips_attr(irn);
236         attr->stack_entity_offset = offset;
237 #endif
238 }
239
240 static int mips_get_sp_bias(const void *self, const ir_node *irn) {
241         return 0;
242 }
243
244 /* fill register allocator interface */
245
246 static const arch_irn_ops_if_t mips_irn_ops_if = {
247         mips_get_irn_reg_req,
248         mips_set_irn_reg,
249         mips_get_irn_reg,
250         mips_classify,
251         mips_get_flags,
252         mips_get_frame_entity,
253         mips_set_frame_entity,
254         mips_set_frame_offset,
255         mips_get_sp_bias,
256         NULL,    /* get_inverse             */
257         NULL,    /* get_op_estimated_cost   */
258         NULL,    /* possible_memory_operand */
259         NULL,    /* perform_memory_operand  */
260 };
261
262 mips_irn_ops_t mips_irn_ops = {
263         &mips_irn_ops_if,
264         NULL
265 };
266
267
268
269 /**************************************************
270  *                _                         _  __
271  *               | |                       (_)/ _|
272  *   ___ ___   __| | ___  __ _  ___ _ __    _| |_
273  *  / __/ _ \ / _` |/ _ \/ _` |/ _ \ '_ \  | |  _|
274  * | (_| (_) | (_| |  __/ (_| |  __/ | | | | | |
275  *  \___\___/ \__,_|\___|\__, |\___|_| |_| |_|_|
276  *                        __/ |
277  *                       |___/
278  **************************************************/
279
280
281 typedef struct {
282         ir_node *start;
283         ir_node *end;
284         unsigned cnt;
285 } anchor;
286
287 /**
288  * Ext-Block walker: create a block schedule
289  */
290 static void create_block_list(ir_extblk *blk, void *env) {
291         anchor *list = env;
292         int i, n;
293
294         for (i = 0, n = get_extbb_n_blocks(blk); i < n; ++i) {
295                 ir_node *block = get_extbb_block(blk, i);
296
297                 set_irn_link(block, NULL);
298                 if (list->start)
299                         set_irn_link(list->end, block);
300                 else
301                         list->start = block;
302
303                 list->end = block;
304                 list->cnt += 1;
305         }
306 }
307
308 /* return the scheduled block at position pos */
309 ir_node *mips_get_sched_block(const mips_code_gen_t *cg, int pos) {
310         if (0 <= pos && pos < ARR_LEN(cg->bl_list))
311                 return cg->bl_list[pos];
312         return NULL;
313 }
314
315 /* return the number of scheduled blocks */
316 int mips_get_sched_n_blocks(const mips_code_gen_t *cg) {
317         return ARR_LEN(cg->bl_list);
318 }
319
320 /* set a block schedule number */
321 void mips_set_block_sched_nr(ir_node *block, int nr) {
322         set_irn_link(block, INT_TO_PTR(nr));
323 }
324
325 /* get a block schedule number */
326 int mips_get_block_sched_nr(ir_node *block) {
327         return PTR_TO_INT(get_irn_link(block));
328 }
329
330 /**
331  * Creates a block schedule for the given graph.
332  */
333 static void mips_create_block_sched(mips_code_gen_t *cg) {
334         anchor list;
335         ir_node **bl_list, *block;
336         unsigned i;
337
338         if (cg->bl_list) {
339                 DEL_ARR_F(cg->bl_list);
340                 free_survive_dce(cg->bl_list_sdce);
341         }
342
343         /* calculate the block schedule here */
344         compute_extbb(cg->irg);
345
346         list.start = NULL;
347         list.end   = NULL;
348         list.cnt   = 0;
349         irg_extblock_walk_graph(cg->irg, NULL, create_block_list, &list);
350
351
352         bl_list = NEW_ARR_F(ir_node *, list.cnt);
353         cg->bl_list_sdce = new_survive_dce();
354         for (i = 0, block = list.start; block; block = get_irn_link(block)) {
355                 bl_list[i] = block;
356                 survive_dce_register_irn(cg->bl_list_sdce, &bl_list[i]);
357                 i++;
358         }
359
360         cg->bl_list = bl_list;
361 }
362
363 #if 0
364 typedef struct _wenv_t {
365         ir_node *list;
366 } wenv_t;
367
368 /**
369  * Walker: link all CopyB nodes
370  */
371 static void collect_copyb_nodes(ir_node *node, void *env) {
372         wenv_t *wenv = env;
373
374         if (get_irn_op(node) == op_CopyB) {
375                 set_irn_link(node, wenv->list);
376                 wenv->list = node;
377         }
378 }
379 #endif
380
381 static void replace_copyb_nodes(mips_code_gen_t *cg) {
382 #if 0
383         wenv_t env;
384         ir_node *copy, *next;
385         ir_node *old_bl, *new_bl, *jmp, *new_jmp, *mem;
386         const ir_edge_t *edge;
387
388         /* build code for all copyB */
389         env.list = NULL;
390         irg_walk_graph(cg->irg, NULL, collect_copyb_nodes, &env);
391
392         for (copy = env.list; copy; copy = next) {
393                 next = get_irn_link(copy);
394
395                 old_bl = get_nodes_block(copy);
396                 part_block(copy);
397                 jmp     = get_Block_cfgpred(old_bl, 0);
398                 new_jmp = new_r_Jmp(cg->irg, get_nodes_block(copy));
399
400                 new_bl = new_r_Block(cg->irg, 1, &new_jmp);
401                 set_nodes_block(jmp, new_bl);
402
403                 mem = gen_code_for_CopyB(new_bl, copy);
404
405                 /* fix copyB's out edges */
406                 foreach_out_edge(copy, edge) {
407                         ir_node *succ = get_edge_src_irn(edge);
408
409                         assert(is_Proj(succ));
410                         switch (get_Proj_proj(succ)) {
411                         case pn_CopyB_M_regular:
412                         case pn_CopyB_M_except:
413                                 exchange(succ, mem);
414                                 break;
415                         default:
416                                 exchange(succ, get_irg_bad(cg->irg));
417                         }
418                 }
419         }
420 #endif
421         (void) cg;
422 }
423
424 /**
425  * Transforms the standard firm graph into
426  * a mips firm graph
427  */
428 static void mips_prepare_graph(void *self) {
429         mips_code_gen_t *cg = self;
430         int bl_nr, n;
431
432         // replace all copyb nodes in the block with a loop
433         // and mips store/load nodes
434         replace_copyb_nodes(cg);
435
436         // Calculate block schedule
437         mips_create_block_sched(cg);
438
439         /* enter the block number into every blocks link field */
440         for (bl_nr = 0, n = mips_get_sched_n_blocks(cg); bl_nr < n; ++bl_nr) {
441                 ir_node *bl = mips_get_sched_block(cg, bl_nr);
442                 mips_set_block_sched_nr(bl, bl_nr);
443         }
444
445         // walk the graph and transform firm nodes into mips nodes where possible
446         irg_walk_blkwise_graph(cg->irg, mips_pre_transform_node, mips_transform_node, cg);
447
448         dump_ir_block_graph_sched(cg->irg, "-transformed");
449 }
450
451 /**
452  * Called immediately before emit phase.
453  */
454 static void mips_finish_irg(void *self) {
455         mips_code_gen_t *cg = self;
456         ir_graph        *irg = cg->irg;
457
458         dump_ir_block_graph_sched(irg, "-mips-finished");
459 }
460
461
462 /**
463  * These are some hooks which must be filled but are probably not needed.
464  */
465 static void mips_before_sched(void *self) {
466         /* Some stuff you need to do after scheduling but before register allocation */
467 }
468
469 static void mips_before_ra(void *self) {
470         /* Some stuff you need to do immediately after register allocation */
471 }
472
473 static void mips_after_ra(void* self) {
474         mips_code_gen_t *cg = self;
475         be_coalesce_spillslots(cg->birg);
476         irg_walk_blkwise_graph(cg->irg, NULL, mips_after_ra_walker, self);
477 }
478
479 /**
480  * Emits the code, closes the output file and frees
481  * the code generator interface.
482  */
483 static void mips_emit_and_done(void *self) {
484         mips_code_gen_t *cg  = self;
485         ir_graph        *irg = cg->irg;
486
487         mips_gen_routine(cg, irg);
488
489         cur_reg_set = NULL;
490
491         /* de-allocate code generator */
492         del_set(cg->reg_set);
493         if (cg->bl_list) {
494                 DEL_ARR_F(cg->bl_list);
495                 free_survive_dce(cg->bl_list_sdce);
496         }
497         free(cg);
498 }
499
500 static void *mips_cg_init(be_irg_t *birg);
501
502 static const arch_code_generator_if_t mips_code_gen_if = {
503         mips_cg_init,
504         NULL,                /* before abi introduce */
505         mips_prepare_graph,
506         NULL,                /* spill */
507         mips_before_sched,   /* before scheduling hook */
508         mips_before_ra,      /* before register allocation hook */
509         mips_after_ra,
510         mips_finish_irg,
511         mips_emit_and_done
512 };
513
514 /**
515  * Initializes the code generator.
516  */
517 static void *mips_cg_init(be_irg_t *birg) {
518         const arch_env_t *arch_env = be_get_birg_arch_env(birg);
519         mips_isa_t       *isa      = (mips_isa_t *) arch_env->isa;
520         mips_code_gen_t  *cg       = xmalloc(sizeof(*cg));
521
522         cg->impl     = &mips_code_gen_if;
523         cg->irg      = be_get_birg_irg(birg);
524         cg->reg_set  = new_set(mips_cmp_irn_reg_assoc, 1024);
525         cg->arch_env = arch_env;
526         cg->isa      = isa;
527         cg->birg     = birg;
528         cg->bl_list  = NULL;
529
530         cur_reg_set = cg->reg_set;
531
532         mips_irn_ops.cg = cg;
533
534         return (arch_code_generator_t *)cg;
535 }
536
537
538 /*****************************************************************
539  *  ____             _                  _   _____  _____
540  * |  _ \           | |                | | |_   _|/ ____|  /\
541  * | |_) | __ _  ___| | _____ _ __   __| |   | | | (___   /  \
542  * |  _ < / _` |/ __| |/ / _ \ '_ \ / _` |   | |  \___ \ / /\ \
543  * | |_) | (_| | (__|   <  __/ | | | (_| |  _| |_ ____) / ____ \
544  * |____/ \__,_|\___|_|\_\___|_| |_|\__,_| |_____|_____/_/    \_\
545  *
546  *****************************************************************/
547
548 static mips_isa_t mips_isa_template = {
549         {
550                 &mips_isa_if,
551                 &mips_gp_regs[REG_SP],
552                 &mips_gp_regs[REG_FP],
553                 -1,             /* stack direction */
554                 NULL,   /* main environment */
555         },
556         { NULL, },  /* emitter environment */
557 };
558
559 /**
560  * Initializes the backend ISA and opens the output file.
561  */
562 static void *mips_init(FILE *file_handle) {
563         static int inited = 0;
564         mips_isa_t *isa;
565
566         if(inited)
567                 return NULL;
568         inited = 1;
569
570         isa = xcalloc(1, sizeof(isa[0]));
571         memcpy(isa, &mips_isa_template, sizeof(isa[0]));
572
573         be_emit_init_env(&isa->emit, file_handle);
574
575         mips_register_init(isa);
576         mips_create_opcodes();
577         // mips_init_opcode_transforms();
578
579         /* we mark referenced global entities, so we can only emit those which
580          * are actually referenced. (Note: you mustn't use the type visited flag
581          * elsewhere in the backend)
582          */
583         inc_master_type_visited();
584
585         return isa;
586 }
587
588 /**
589  * Closes the output file and frees the ISA structure.
590  */
591 static void mips_done(void *self) {
592         mips_isa_t *isa = self;
593
594         be_gas_emit_decls(&isa->emit, isa->arch_isa.main_env, 1);
595
596         be_emit_destroy_env(&isa->emit);
597         free(isa);
598 }
599
600 static int mips_get_n_reg_class(const void *self) {
601         return N_CLASSES;
602 }
603
604 static const arch_register_class_t *mips_get_reg_class(const void *self, int i) {
605         assert(i >= 0 && i < N_CLASSES && "Invalid mips register class requested.");
606         return &mips_reg_classes[i];
607 }
608
609
610
611 /**
612  * Get the register class which shall be used to store a value of a given mode.
613  * @param self The this pointer.
614  * @param mode The mode in question.
615  * @return A register class which can hold values of the given mode.
616  */
617 const arch_register_class_t *mips_get_reg_class_for_mode(const void *self, const ir_mode *mode) {
618         ASSERT_NO_FLOAT(mode);
619         return &mips_reg_classes[CLASS_mips_gp];
620 }
621
622 typedef struct {
623         be_abi_call_flags_bits_t flags;
624         const arch_isa_t *isa;
625         const arch_env_t *arch_env;
626         ir_graph *irg;
627         // do special handling to support debuggers
628         int debug;
629 } mips_abi_env_t;
630
631 static void *mips_abi_init(const be_abi_call_t *call, const arch_env_t *arch_env, ir_graph *irg)
632 {
633         mips_abi_env_t *env    = xmalloc(sizeof(env[0]));
634         be_abi_call_flags_t fl = be_abi_call_get_flags(call);
635         env->flags             = fl.bits;
636         env->irg               = irg;
637         env->arch_env          = arch_env;
638         env->isa               = arch_env->isa;
639         env->debug             = 1;
640         return env;
641 }
642
643 static void mips_abi_dont_save_regs(void *self, pset *s)
644 {
645         mips_abi_env_t *env = self;
646
647         if(env->flags.try_omit_fp)
648                 pset_insert_ptr(s, env->isa->bp);
649 }
650
651 static const arch_register_t *mips_abi_prologue(void *self, ir_node** mem, pmap *reg_map)
652 {
653         mips_abi_env_t *env = self;
654         ir_graph *irg = env->irg;
655         dbg_info *dbg = NULL; // TODO where can I get this from?
656         ir_node *block = get_irg_start_block(env->irg);
657         mips_attr_t *attr;
658         ir_node *sp = be_abi_reg_map_get(reg_map, &mips_gp_regs[REG_SP]);
659         ir_node *fp = be_abi_reg_map_get(reg_map, &mips_gp_regs[REG_FP]);
660         int initialstackframesize;
661
662         if(env->debug) {
663                 /*
664                  * The calling conventions wants a stack frame of at least 24bytes size with
665                  *   a0-a3 saved in offset 0-12
666                  *   fp saved in offset 16
667                  *   ra saved in offset 20
668                  */
669                 ir_node *mm[6];
670                 ir_node *sync, *reg, *store;
671                 initialstackframesize = 24;
672
673                 // - setup first part of stackframe
674                 sp = new_rd_mips_addiu(dbg, irg, block, sp);
675                 attr = get_mips_attr(sp);
676                 attr->tv = new_tarval_from_long(-initialstackframesize, mode_Is);
677                 mips_set_irn_reg(NULL, sp, &mips_gp_regs[REG_SP]);
678                 //arch_set_irn_register(mips_get_arg_env(), sp, &mips_gp_regs[REG_SP]);
679
680                 /* TODO: where to get an edge with a0-a3
681                 int i;
682                 for(i = 0; i < 4; ++i) {
683                         ir_node *reg = be_abi_reg_map_get(reg_map, &mips_gp_regs[REG_A0 + i]);
684                         ir_node *store = new_rd_mips_store_r(dbg, irg, block, *mem, sp, reg, mode_T);
685                         attr = get_mips_attr(store);
686                         attr->load_store_mode = mode_Iu;
687                         attr->tv = new_tarval_from_long(i * 4, mode_Is);
688
689                         mm[i] = new_r_Proj(irg, block, store, mode_M, pn_Store_M);
690                 }
691                 */
692
693                 reg = be_abi_reg_map_get(reg_map, &mips_gp_regs[REG_FP]);
694                 store = new_rd_mips_sw(dbg, irg, block, *mem, sp, reg);
695                 attr = get_mips_attr(store);
696                 attr->tv = new_tarval_from_long(16, mode_Hs);
697
698                 mm[4] = store;
699
700                 reg = be_abi_reg_map_get(reg_map, &mips_gp_regs[REG_RA]);
701                 store = new_rd_mips_sw(dbg, irg, block, *mem, sp, reg);
702                 attr = get_mips_attr(store);
703                 attr->tv = new_tarval_from_long(20, mode_Hs);
704
705                 mm[5] = store;
706
707                 // TODO ideally we would route these mem edges directly towards the epilogue
708                 sync = new_r_Sync(irg, block, 2, mm+4);
709                 *mem = sync;
710         } else {
711                 ir_node *reg, *store;
712                 initialstackframesize = 4;
713
714                 // save old framepointer
715                 sp = new_rd_mips_addiu(dbg, irg, block, sp);
716                 attr = get_mips_attr(sp);
717                 attr->tv = new_tarval_from_long(-initialstackframesize, mode_Is);
718                 mips_set_irn_reg(NULL, sp, &mips_gp_regs[REG_SP]);
719                 //arch_set_irn_register(mips_get_arg_env(), sp, &mips_gp_regs[REG_SP]);
720
721                 reg = be_abi_reg_map_get(reg_map, &mips_gp_regs[REG_FP]);
722                 store = new_rd_mips_sw(dbg, irg, block, *mem, sp, reg);
723                 attr = get_mips_attr(store);
724                 attr->tv = new_tarval_from_long(0, mode_Hs);
725
726                 *mem = store;
727         }
728
729         // setup framepointer
730         fp = new_rd_mips_addiu(dbg, irg, block, sp);
731         attr = get_mips_attr(fp);
732         attr->tv = new_tarval_from_long(initialstackframesize, mode_Is);
733         mips_set_irn_reg(NULL, fp, &mips_gp_regs[REG_FP]);
734         //arch_set_irn_register(mips_get_arg_env(), fp, &mips_gp_regs[REG_FP]);
735
736         be_abi_reg_map_set(reg_map, &mips_gp_regs[REG_FP], fp);
737         be_abi_reg_map_set(reg_map, &mips_gp_regs[REG_SP], sp);
738
739         return &mips_gp_regs[REG_SP];
740 }
741
742 static void mips_abi_epilogue(void *self, ir_node *block, ir_node **mem, pmap *reg_map)
743 {
744         mips_abi_env_t *env = self;
745         ir_graph *irg = env->irg;
746         dbg_info *dbg = NULL; // TODO where can I get this from?
747         mips_attr_t *attr;
748         ir_node *sp = be_abi_reg_map_get(reg_map, &mips_gp_regs[REG_SP]);
749         ir_node *fp = be_abi_reg_map_get(reg_map, &mips_gp_regs[REG_FP]);
750         ir_node *load;
751         int initial_frame_size = env->debug ? 24 : 4;
752         int fp_save_offset = env->debug ? 16 : 0;
753
754         // copy fp to sp
755         sp = new_rd_mips_move(dbg, irg, block, fp);
756         mips_set_irn_reg(NULL, sp, &mips_gp_regs[REG_SP]);
757         //arch_set_irn_register(mips_get_arg_env(), fp, &mips_gp_regs[REG_SP]);
758
759         // 1. restore fp
760         load = new_rd_mips_lw(dbg, irg, block, *mem, sp);
761         attr = get_mips_attr(load);
762         // sp is at the fp address already, so we have to do fp_save_offset - initial_frame_size
763         attr->tv = new_tarval_from_long(fp_save_offset - initial_frame_size, mode_Hs);
764
765         fp = new_r_Proj(irg, block, load, mode_Iu, pn_mips_lw_res);
766         *mem = new_r_Proj(irg, block, load, mode_Iu, pn_mips_lw_M);
767         arch_set_irn_register(env->arch_env, fp, &mips_gp_regs[REG_FP]);
768
769         be_abi_reg_map_set(reg_map, &mips_gp_regs[REG_FP], fp);
770         be_abi_reg_map_set(reg_map, &mips_gp_regs[REG_SP], sp);
771 }
772
773 /**
774  * Produces the type which sits between the stack args and the locals on the stack.
775  * it will contain the return address and space to store the old frame pointer.
776  * @return The Firm type modelling the ABI between type.
777  */
778 static ir_type *mips_abi_get_between_type(void *self) {
779         mips_abi_env_t *env = self;
780
781         static ir_type *debug_between_type = NULL;
782         static ir_type *opt_between_type = NULL;
783         static ir_entity *old_fp_ent    = NULL;
784
785         if(env->debug && debug_between_type == NULL) {
786                 ir_entity *a0_ent, *a1_ent, *a2_ent, *a3_ent;
787                 ir_entity *ret_addr_ent;
788                 ir_type *ret_addr_type = new_type_primitive(new_id_from_str("return_addr"), mode_P);
789                 ir_type *old_fp_type   = new_type_primitive(new_id_from_str("fp"), mode_P);
790                 ir_type *old_param_type = new_type_primitive(new_id_from_str("param"), mode_Iu);
791
792                 debug_between_type     = new_type_class(new_id_from_str("mips_between_type"));
793                 a0_ent                             = new_entity(debug_between_type, new_id_from_str("a0_ent"), old_param_type);
794                 a1_ent                             = new_entity(debug_between_type, new_id_from_str("a1_ent"), old_param_type);
795                 a2_ent                             = new_entity(debug_between_type, new_id_from_str("a2_ent"), old_param_type);
796                 a3_ent                             = new_entity(debug_between_type, new_id_from_str("a3_ent"), old_param_type);
797                 old_fp_ent             = new_entity(debug_between_type, new_id_from_str("old_fp"), old_fp_type);
798                 ret_addr_ent           = new_entity(debug_between_type, new_id_from_str("ret_addr"), ret_addr_type);
799
800                 set_entity_offset(a0_ent, 0);
801                 set_entity_offset(a1_ent, 4);
802                 set_entity_offset(a2_ent, 8);
803                 set_entity_offset(a3_ent, 12);
804                 set_entity_offset(old_fp_ent, 16);
805                 set_entity_offset(ret_addr_ent, 20);
806
807                 set_type_size_bytes(debug_between_type, 24);
808         } else if(!env->debug && opt_between_type == NULL) {
809                 ir_type *old_fp_type   = new_type_primitive(new_id_from_str("fp"), mode_P);
810                 ir_entity *old_fp_ent;
811
812                 opt_between_type       = new_type_class(new_id_from_str("mips_between_type"));
813                 old_fp_ent             = new_entity(opt_between_type, new_id_from_str("old_fp"), old_fp_type);
814                 set_entity_offset(old_fp_ent, 0);
815                 set_type_size_bytes(opt_between_type, 4);
816         }
817
818         return env->debug ? debug_between_type : opt_between_type;
819 }
820
821 static const be_abi_callbacks_t mips_abi_callbacks = {
822         mips_abi_init,
823         free,
824         mips_abi_get_between_type,
825         mips_abi_dont_save_regs,
826         mips_abi_prologue,
827         mips_abi_epilogue,
828 };
829
830 /**
831  * Get the ABI restrictions for procedure calls.
832  * @param self        The this pointer.
833  * @param method_type The type of the method (procedure) in question.
834  * @param abi         The abi object to be modified
835  */
836 static void mips_get_call_abi(const void *self, ir_type *method_type, be_abi_call_t *abi) {
837         ir_type  *tp;
838         ir_mode  *mode;
839         int       n = get_method_n_params(method_type);
840         int result_count;
841         int       i;
842         ir_mode **modes;
843         const arch_register_t *reg;
844         be_abi_call_flags_t call_flags;
845
846         memset(&call_flags, 0, sizeof(call_flags));
847         call_flags.bits.left_to_right         = 0;
848         call_flags.bits.store_args_sequential = 0;
849         call_flags.bits.try_omit_fp           = 1;
850         call_flags.bits.fp_free               = 0;
851         call_flags.bits.call_has_imm          = 1;
852
853         /* set stack parameter passing style */
854         be_abi_call_set_flags(abi, call_flags, &mips_abi_callbacks);
855
856         /* collect the mode for each type */
857         modes = alloca(n * sizeof(modes[0]));
858         for (i = 0; i < n; i++) {
859                 tp       = get_method_param_type(method_type, i);
860                 modes[i] = get_type_mode(tp);
861         }
862
863         // assigns parameters to registers or stack
864         for (i = 0; i < n; i++) {
865                 // first 4 params in $a0-$a3, the others on the stack
866                 if(i < 4) {
867                         reg = &mips_gp_regs[REG_A0 + i];
868                         be_abi_call_param_reg(abi, i, reg);
869                 } else {
870                         /* default: all parameters on stack */
871                         be_abi_call_param_stack(abi, i, 4, 0, 0);
872                 }
873         }
874
875         /* set return register */
876         /* default: return value is in R0 (and maybe R1) */
877         result_count = get_method_n_ress(method_type);
878         assert(result_count <= 2 && "More than 2 result values not supported");
879         for(i = 0; i < result_count; ++i) {
880                 const arch_register_t* reg;
881                 tp   = get_method_res_type(method_type, i);
882                 mode = get_type_mode(tp);
883                 ASSERT_NO_FLOAT(mode);
884
885                 reg = &mips_gp_regs[REG_V0 + i];
886                 be_abi_call_res_reg(abi, i, reg);
887         }
888 }
889
890 static const void *mips_get_irn_ops(const arch_irn_handler_t *self, const ir_node *irn) {
891         return &mips_irn_ops;
892 }
893
894 const arch_irn_handler_t mips_irn_handler = {
895         mips_get_irn_ops
896 };
897
898 const arch_irn_handler_t *mips_get_irn_handler(const void *self) {
899         return &mips_irn_handler;
900 }
901
902 /**
903  * Initializes the code generator interface.
904  */
905 static const arch_code_generator_if_t *mips_get_code_generator_if(void *self) {
906         return &mips_code_gen_if;
907 }
908
909 /**
910  * Returns the necessary byte alignment for storing a register of given class.
911  */
912 static int mips_get_reg_class_alignment(const void *self, const arch_register_class_t *cls) {
913         ir_mode *mode = arch_register_class_mode(cls);
914         return get_mode_size_bytes(mode);
915 }
916
917 static const be_execution_unit_t ***mips_get_allowed_execution_units(const void *self, const ir_node *irn) {
918         /* TODO */
919         assert(0);
920         return NULL;
921 }
922
923 static const be_machine_t *mips_get_machine(const void *self) {
924         /* TODO */
925         assert(0);
926         return NULL;
927 }
928
929 /**
930  * Return irp irgs in the desired order.
931  */
932 static ir_graph **mips_get_irg_list(const void *self, ir_graph ***irg_list) {
933         return NULL;
934 }
935
936 /**
937  * Returns the libFirm configuration parameter for this backend.
938  */
939 static const backend_params *mips_get_libfirm_params(void) {
940         static arch_dep_params_t ad = {
941                 1,  /* allow subs */
942                 0,      /* Muls are fast enough on Mips */
943                 31, /* shift would be ok */
944                 0,  /* no Mulhs */
945                 0,  /* no Mulhu */
946                 32, /* Mulhs & Mulhu available for 32 bit */
947         };
948         static backend_params p = {
949                 NULL,  /* no additional opcodes */
950                 NULL,  /* will be set later */
951                 1,     /* need dword lowering */
952                 NULL,  /* but yet no creator function */
953                 NULL,  /* context for create_intrinsic_fkt */
954         };
955
956         p.dep_param = &ad;
957         return &p;
958 }
959
960 const arch_isa_if_t mips_isa_if = {
961         mips_init,
962         mips_done,
963         mips_get_n_reg_class,
964         mips_get_reg_class,
965         mips_get_reg_class_for_mode,
966         mips_get_call_abi,
967         mips_get_irn_handler,
968         mips_get_code_generator_if,
969         mips_get_list_sched_selector,
970         mips_get_ilp_sched_selector,
971         mips_get_reg_class_alignment,
972         mips_get_libfirm_params,
973         mips_get_allowed_execution_units,
974         mips_get_machine,
975         mips_get_irg_list,
976 };
977
978 void be_init_arch_mips(void)
979 {
980         be_register_isa_if("mips", &mips_isa_if);
981 }
982
983 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_mips);