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