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