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