added doxygen comments, transform mips to new emit style, use gnuas gendecls
[libfirm] / ir / be / mips / bearch_mips.c
index b93ca39..015dbf0 100644 (file)
@@ -1,6 +1,28 @@
-/* The main mips backend driver file. */
-/* $Id$ */
+/*
+ * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
+ */
 
+/**
+ * @file
+ * @brief   The main mips backend driver file.
+ * @author  Matthias Braun, Mehdi
+ * @version $Id$
+ */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 #include "bitset.h"
 #include "debug.h"
 
-#include "../bearch.h"                /* the general register allocator interface */
+#include "../bearch_t.h"
 #include "../benode_t.h"
 #include "../belower.h"
 #include "../besched_t.h"
 #include "../be.h"
 #include "../beabi.h"
 #include "../bemachine.h"
+#include "../bemodule.h"
+#include "../beemitter.h"
+#include "../begnuas.h"
+#include "../begnuas.h"
 
 #include "bearch_mips_t.h"
 
-#include "mips_new_nodes.h"           /* mips nodes interface */
-#include "gen_mips_regalloc_if.h"     /* the generated interface (register type and class defenitions) */
-#include "mips_gen_decls.h"           /* interface declaration emitter */
+#include "mips_new_nodes.h"
+#include "gen_mips_regalloc_if.h"
 #include "mips_transform.h"
 #include "mips_emitter.h"
 #include "mips_map_regs.h"
@@ -55,101 +80,54 @@ static set *cur_reg_set = NULL;
  *           |___/
  **************************************************/
 
-static ir_node *my_skip_proj(const ir_node *n) {
-       while (is_Proj(n))
-               n = get_Proj_pred(n);
-       return (ir_node *)n;
-}
-
 /**
  * Return register requirements for a mips node.
  * If the node returns a tuple (mode_T) then the proj's
  * will be asked for this information.
  */
-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) {
-       const mips_register_req_t *irn_req;
+static const
+arch_register_req_t *mips_get_irn_reg_req(const void *self,
+                                          const ir_node *node, int pos) {
        long               node_pos = pos == -1 ? 0 : pos;
-       ir_mode           *mode     = get_irn_mode(irn);
-       FIRM_DBG_REGISTER(firm_dbg_module_t *mod, DEBUG_MODULE);
+       ir_mode           *mode     = get_irn_mode(node);
 
-       if (is_Block(irn) || mode == mode_X || mode == mode_M) {
-               DBG((mod, LEVEL_1, "ignoring mode_T, mode_M node %+F\n", irn));
-               return NULL;
+       if (is_Block(node) || mode == mode_X || mode == mode_M) {
+               return arch_no_register_req;
        }
 
        if (mode == mode_T && pos < 0) {
-               DBG((mod, LEVEL_1, "ignoring request for OUT requirements at %+F\n", irn));
-               return NULL;
+               return arch_no_register_req;
        }
 
-       DBG((mod, LEVEL_1, "get requirements at pos %d for %+F ... ", pos, irn));
-
-       if (is_Proj(irn)) {
+       if (is_Proj(node)) {
                /* in case of a proj, we need to get the correct OUT slot */
                /* of the node corresponding to the proj number */
                if (pos == -1) {
-                       node_pos = mips_translate_proj_pos(irn);
+                       node_pos = mips_translate_proj_pos(node);
                }
                else {
                        node_pos = pos;
                }
 
-               irn = my_skip_proj(irn);
-
-               DB((mod, LEVEL_1, "skipping Proj, going to %+F at pos %d ... ", irn, node_pos));
+               node = skip_Proj_const(node);
        }
 
        /* get requirements for our own nodes */
-       if (is_mips_irn(irn)) {
+       if (is_mips_irn(node)) {
+               const arch_register_req_t *req;
                if (pos >= 0) {
-                       irn_req = get_mips_in_req(irn, pos);
-               }
-               else {
-                       irn_req = get_mips_out_req(irn, node_pos);
-               }
-
-               DB((mod, LEVEL_1, "returning reqs for %+F at pos %d\n", irn, pos));
-
-               memcpy(req, &(irn_req->req), sizeof(*req));
-
-               if (arch_register_req_is(&(irn_req->req), should_be_same)) {
-                       assert(irn_req->same_pos >= 0 && "should be same constraint for in -> out NYI");
-                       req->other_same = get_irn_n(irn, irn_req->same_pos);
+                       req = get_mips_in_req(node, pos);
+               } else {
+                       req = get_mips_out_req(node, node_pos);
                }
 
-               if (arch_register_req_is(&(irn_req->req), should_be_different)) {
-                       assert(irn_req->different_pos >= 0 && "should be different constraint for in -> out NYI");
-                       req->other_different = get_irn_n(irn, irn_req->different_pos);
-               }
+               return req;
        }
-       /* get requirements for FIRM nodes */
-       else {
-               /* treat Phi like Const with default requirements */
-               if (is_Phi(irn)) {
-                       DB((mod, LEVEL_1, "returning standard reqs for %+F\n", irn));
 
-                       if (mode_is_float(mode)) {
-                               //memcpy(req, &(mips_default_req_mips_floating_point.req), sizeof(*req));
-                               assert(0 && "floating point not supported (yet)");
-                       }
-                       else if (mode_is_int(mode) || mode_is_reference(mode)) {
-                               memcpy(req, &(mips_default_req_mips_gp.req), sizeof(*req));
-                       }
-                       else if (mode == mode_T || mode == mode_M) {
-                               DBG((mod, LEVEL_1, "ignoring Phi node %+F\n", irn));
-                               return NULL;
-                       }
-                       else {
-                               assert(0 && "unsupported Phi-Mode");
-                       }
-               }
-               else {
-                       DB((mod, LEVEL_1, "returning NULL for %+F (node not supported)\n", irn));
-                       req = NULL;
-               }
-       }
+       /* unknown should be translated by now */
+       assert(!is_Unknown(node));
 
-       return req;
+       return arch_no_register_req;
 }
 
 static void mips_set_irn_reg(const void *self, ir_node *irn, const arch_register_t *reg) {
@@ -162,7 +140,7 @@ static void mips_set_irn_reg(const void *self, ir_node *irn, const arch_register
                }
 
                pos = mips_translate_proj_pos(irn);
-               irn = my_skip_proj(irn);
+               irn = skip_Proj(irn);
        }
 
        if (is_mips_irn(irn)) {
@@ -188,7 +166,7 @@ static const arch_register_t *mips_get_irn_reg(const void *self, const ir_node *
                }
 
                pos = mips_translate_proj_pos(irn);
-               irn = my_skip_proj(irn);
+               irn = skip_Proj_const(irn);
        }
 
        if (is_mips_irn(irn)) {
@@ -204,7 +182,7 @@ static const arch_register_t *mips_get_irn_reg(const void *self, const ir_node *
 }
 
 static arch_irn_class_t mips_classify(const void *self, const ir_node *irn) {
-       irn = my_skip_proj(irn);
+       irn = skip_Proj_const(irn);
 
        if (is_cfop(irn)) {
                return arch_irn_class_branch;
@@ -216,7 +194,7 @@ static arch_irn_class_t mips_classify(const void *self, const ir_node *irn) {
 }
 
 static arch_irn_flags_t mips_get_flags(const void *self, const ir_node *irn) {
-       irn = my_skip_proj(irn);
+       irn = skip_Proj_const(irn);
 
        if (is_mips_irn(irn)) {
                return get_mips_flags(irn);
@@ -228,7 +206,7 @@ static arch_irn_flags_t mips_get_flags(const void *self, const ir_node *irn) {
        return 0;
 }
 
-static entity *mips_get_frame_entity(const void *self, const ir_node *irn) {
+static ir_entity *mips_get_frame_entity(const void *self, const ir_node *irn) {
        if(is_mips_load_r(irn) || is_mips_store_r(irn)) {
                mips_attr_t *attr = get_mips_attr(irn);
 
@@ -238,7 +216,7 @@ static entity *mips_get_frame_entity(const void *self, const ir_node *irn) {
        return NULL;
 }
 
-static void mips_set_frame_entity(const void *self, ir_node *irn, entity *ent) {
+static void mips_set_frame_entity(const void *self, ir_node *irn, ir_entity *ent) {
        mips_attr_t *attr  = get_mips_attr(irn);
        assert(is_mips_load_r(irn) || is_mips_store_r(irn));
        attr->stack_entity = ent;
@@ -493,18 +471,10 @@ static void mips_after_ra(void* self) {
  * the code generator interface.
  */
 static void mips_emit_and_done(void *self) {
-       mips_code_gen_t *cg = self;
-       ir_graph           *irg = cg->irg;
-       FILE               *out = cg->isa->out;
-
-       mips_register_emitters();
-
-       if (cg->emit_decls) {
-               mips_gen_decls(out);
-               cg->emit_decls = 0;
-       }
+       mips_code_gen_t *cg  = self;
+       ir_graph        *irg = cg->irg;
 
-       mips_gen_routine(out, irg, cg);
+       mips_gen_routine(cg, irg);
 
        cur_reg_set = NULL;
 
@@ -517,7 +487,7 @@ static void mips_emit_and_done(void *self) {
        free(cg);
 }
 
-static void *mips_cg_init(const be_irg_t *birg);
+static void *mips_cg_init(be_irg_t *birg);
 
 static const arch_code_generator_if_t mips_code_gen_if = {
        mips_cg_init,
@@ -534,26 +504,20 @@ static const arch_code_generator_if_t mips_code_gen_if = {
 /**
  * Initializes the code generator.
  */
-static void *mips_cg_init(const be_irg_t *birg) {
-       mips_isa_t      *isa = (mips_isa_t *)birg->main_env->arch_env->isa;
-       mips_code_gen_t *cg  = xmalloc(sizeof(*cg));
+static void *mips_cg_init(be_irg_t *birg) {
+       const arch_env_t *arch_env = be_get_birg_arch_env(birg);
+       mips_isa_t       *isa      = (mips_isa_t *) arch_env->isa;
+       mips_code_gen_t  *cg       = xmalloc(sizeof(*cg));
 
        cg->impl     = &mips_code_gen_if;
-       cg->irg      = birg->irg;
+       cg->irg      = be_get_birg_irg(birg);
        cg->reg_set  = new_set(mips_cmp_irn_reg_assoc, 1024);
-       cg->arch_env = birg->main_env->arch_env;
+       cg->arch_env = arch_env;
        cg->isa      = isa;
        cg->birg     = birg;
        cg->bl_list  = NULL;
        FIRM_DBG_REGISTER(cg->mod, "firm.be.mips.cg");
 
-       isa->num_codegens++;
-
-       if (isa->num_codegens > 1)
-               cg->emit_decls = 0;
-       else
-               cg->emit_decls = 1;
-
        cur_reg_set = cg->reg_set;
 
        mips_irn_ops.cg = cg;
@@ -573,12 +537,14 @@ static void *mips_cg_init(const be_irg_t *birg) {
  *****************************************************************/
 
 static mips_isa_t mips_isa_template = {
-       &mips_isa_if,
-       &mips_gp_regs[REG_SP],
-       &mips_gp_regs[REG_FP],
-       -1,             // stack direction
-       0,              // num codegens?!? TODO what is this?
-       NULL
+       {
+               &mips_isa_if,
+               &mips_gp_regs[REG_SP],
+               &mips_gp_regs[REG_FP],
+               -1,             /* stack direction */
+               NULL,   /* main environment */
+       },
+       { NULL, },  /* emitter environment */
 };
 
 /**
@@ -590,17 +556,22 @@ static void *mips_init(FILE *file_handle) {
 
        if(inited)
                return NULL;
+       inited = 1;
 
-       isa = xcalloc(1, sizeof(*isa));
-       memcpy(isa, &mips_isa_template, sizeof(*isa));
+       isa = xcalloc(1, sizeof(isa[0]));
+       memcpy(isa, &mips_isa_template, sizeof(isa[0]));
 
-       isa->out = file_handle;
+       be_emit_init_env(&isa->emit, file_handle);
 
        mips_register_init(isa);
        mips_create_opcodes();
        mips_init_opcode_transforms();
 
-       inited = 1;
+       /* we mark referenced global entities, so we can only emit those which
+        * are actually referenced. (Note: you mustn't use the type visited flag
+        * elsewhere in the backend)
+        */
+       inc_master_type_visited();
 
        return isa;
 }
@@ -609,7 +580,12 @@ static void *mips_init(FILE *file_handle) {
  * Closes the output file and frees the ISA structure.
  */
 static void mips_done(void *self) {
-       free(self);
+       mips_isa_t *isa = self;
+
+       be_gas_emit_decls(&isa->emit, isa->arch_isa.main_env, 1);
+
+       be_emit_destroy_env(&isa->emit);
+       free(isa);
 }
 
 static int mips_get_n_reg_class(const void *self) {
@@ -636,7 +612,7 @@ const arch_register_class_t *mips_get_reg_class_for_mode(const void *self, const
 
 typedef struct {
        be_abi_call_flags_bits_t flags;
-       const mips_isa_t *isa;
+       const arch_isa_t *isa;
        const arch_env_t *arch_env;
        ir_graph *irg;
        // do special handling to support debuggers
@@ -647,19 +623,20 @@ static void *mips_abi_init(const be_abi_call_t *call, const arch_env_t *arch_env
 {
        mips_abi_env_t *env    = xmalloc(sizeof(env[0]));
        be_abi_call_flags_t fl = be_abi_call_get_flags(call);
-       env->flags = fl.bits;
-       env->irg   = irg;
-       env->arch_env = arch_env;
-       env->isa   = (const mips_isa_t*) arch_env->isa;
-       env->debug = 1;
+       env->flags             = fl.bits;
+       env->irg               = irg;
+       env->arch_env          = arch_env;
+       env->isa               = arch_env->isa;
+       env->debug             = 1;
        return env;
 }
 
 static void mips_abi_dont_save_regs(void *self, pset *s)
 {
        mips_abi_env_t *env = self;
+
        if(env->flags.try_omit_fp)
-               pset_insert_ptr(s, env->isa->fp);
+               pset_insert_ptr(s, env->isa->bp);
 }
 
 static const arch_register_t *mips_abi_prologue(void *self, ir_node** mem, pmap *reg_map)
@@ -685,7 +662,7 @@ static const arch_register_t *mips_abi_prologue(void *self, ir_node** mem, pmap
                initialstackframesize = 24;
 
                // - setup first part of stackframe
-               sp = new_rd_mips_addi(dbg, irg, block, sp, mode_Is);
+               sp = new_rd_mips_addiu(dbg, irg, block, sp);
                attr = get_mips_attr(sp);
                attr->tv = new_tarval_from_long(-initialstackframesize, mode_Is);
                mips_set_irn_reg(NULL, sp, &mips_gp_regs[REG_SP]);
@@ -728,7 +705,7 @@ static const arch_register_t *mips_abi_prologue(void *self, ir_node** mem, pmap
                initialstackframesize = 4;
 
                // save old framepointer
-               sp = new_rd_mips_addi(dbg, irg, block, sp, mode_Is);
+               sp = new_rd_mips_addiu(dbg, irg, block, sp);
                attr = get_mips_attr(sp);
                attr->tv = new_tarval_from_long(-initialstackframesize, mode_Is);
                mips_set_irn_reg(NULL, sp, &mips_gp_regs[REG_SP]);
@@ -744,7 +721,7 @@ static const arch_register_t *mips_abi_prologue(void *self, ir_node** mem, pmap
        }
 
        // setup framepointer
-       fp = new_rd_mips_addi(dbg, irg, block, sp, mode_Is);
+       fp = new_rd_mips_addiu(dbg, irg, block, sp);
        attr = get_mips_attr(fp);
        attr->tv = new_tarval_from_long(initialstackframesize, mode_Is);
        mips_set_irn_reg(NULL, fp, &mips_gp_regs[REG_FP]);
@@ -769,7 +746,7 @@ static void mips_abi_epilogue(void *self, ir_node *block, ir_node **mem, pmap *r
        int fp_save_offset = env->debug ? 16 : 0;
 
        // copy fp to sp
-       sp = new_rd_mips_move(dbg, irg, block, fp, mode_Iu);
+       sp = new_rd_mips_move(dbg, irg, block, fp);
        mips_set_irn_reg(NULL, sp, &mips_gp_regs[REG_SP]);
        //arch_set_irn_register(mips_get_arg_env(), fp, &mips_gp_regs[REG_SP]);
 
@@ -798,11 +775,11 @@ static ir_type *mips_abi_get_between_type(void *self) {
 
        static ir_type *debug_between_type = NULL;
        static ir_type *opt_between_type = NULL;
-       static entity *old_fp_ent    = NULL;
+       static ir_entity *old_fp_ent    = NULL;
 
        if(env->debug && debug_between_type == NULL) {
-               entity *a0_ent, *a1_ent, *a2_ent, *a3_ent;
-               entity *ret_addr_ent;
+               ir_entity *a0_ent, *a1_ent, *a2_ent, *a3_ent;
+               ir_entity *ret_addr_ent;
                ir_type *ret_addr_type = new_type_primitive(new_id_from_str("return_addr"), mode_P);
                ir_type *old_fp_type   = new_type_primitive(new_id_from_str("fp"), mode_P);
                ir_type *old_param_type = new_type_primitive(new_id_from_str("param"), mode_Iu);
@@ -815,21 +792,21 @@ static ir_type *mips_abi_get_between_type(void *self) {
                old_fp_ent             = new_entity(debug_between_type, new_id_from_str("old_fp"), old_fp_type);
                ret_addr_ent           = new_entity(debug_between_type, new_id_from_str("ret_addr"), ret_addr_type);
 
-               set_entity_offset_bytes(a0_ent, 0);
-               set_entity_offset_bytes(a1_ent, 4);
-               set_entity_offset_bytes(a2_ent, 8);
-               set_entity_offset_bytes(a3_ent, 12);
-               set_entity_offset_bytes(old_fp_ent, 16);
-               set_entity_offset_bytes(ret_addr_ent, 20);
+               set_entity_offset(a0_ent, 0);
+               set_entity_offset(a1_ent, 4);
+               set_entity_offset(a2_ent, 8);
+               set_entity_offset(a3_ent, 12);
+               set_entity_offset(old_fp_ent, 16);
+               set_entity_offset(ret_addr_ent, 20);
 
                set_type_size_bytes(debug_between_type, 24);
        } else if(!env->debug && opt_between_type == NULL) {
                ir_type *old_fp_type   = new_type_primitive(new_id_from_str("fp"), mode_P);
-               entity *old_fp_ent;
+               ir_entity *old_fp_ent;
 
                opt_between_type       = new_type_class(new_id_from_str("mips_between_type"));
                old_fp_ent             = new_entity(opt_between_type, new_id_from_str("old_fp"), old_fp_type);
-               set_entity_offset_bytes(old_fp_ent, 0);
+               set_entity_offset(old_fp_ent, 0);
                set_type_size_bytes(opt_between_type, 4);
        }
 
@@ -944,6 +921,13 @@ static const be_machine_t *mips_get_machine(const void *self) {
        return NULL;
 }
 
+/**
+ * Return irp irgs in the desired order.
+ */
+static ir_graph **mips_get_irg_list(const void *self, ir_graph ***irg_list) {
+       return NULL;
+}
+
 /**
  * Returns the libFirm configuration parameter for this backend.
  */
@@ -968,12 +952,6 @@ static const backend_params *mips_get_libfirm_params(void) {
        return &p;
 }
 
-#ifdef WITH_LIBCORE
-static void mips_register_options(lc_opt_entry_t *ent)
-{
-}
-#endif /* WITH_LIBCORE */
-
 const arch_isa_if_t mips_isa_if = {
        mips_init,
        mips_done,
@@ -989,7 +967,12 @@ const arch_isa_if_t mips_isa_if = {
        mips_get_libfirm_params,
        mips_get_allowed_execution_units,
        mips_get_machine,
-#ifdef WITH_LIBCORE
-       mips_register_options
-#endif
+       mips_get_irg_list,
 };
+
+void be_init_arch_mips(void)
+{
+       be_register_isa_if("mips", &mips_isa_if);
+}
+
+BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_mips);