big refactoring of arch_XXX functions
[libfirm] / ir / be / bearch.c
index 95a18fd..3172eff 100644 (file)
-/**
- * Processor architecture specification.
- * @author Sebastian Hack
- * @date 11.2.2005
+/*
+ * Copyright (C) 1995-2008 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.
  *
- * $Id$
+ * 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.
  */
 
-#ifdef HAVE_CONFIG_H
+/**
+ * @file
+ * @brief       Processor architecture specification.
+ * @author      Sebastian Hack
+ * @version     $Id$
+ */
 #include "config.h"
-#endif
-
-#ifdef HAVE_ALLOCA_H
-#include <alloca.h>
-#endif
-
-#ifdef HAVE_MALLOC_H
-#include <malloc.h>
-#endif
 
 #include <string.h>
 
 #include "bearch.h"
+#include "benode.h"
+#include "beinfo.h"
 #include "ircons_t.h"
+#include "irnode_t.h"
+#include "irop_t.h"
 
 #include "bitset.h"
 #include "pset.h"
-#include "entity.h"
+#include "raw_bitset.h"
 
 #include "irprintf.h"
 
-arch_env_t *arch_env_init(arch_env_t *env, const arch_isa_if_t *isa_if)
-{
-  memset(env, 0, sizeof(*env));
-  env->isa = isa_if->init();
-  return env;
-}
-
-arch_env_t *arch_env_push_irn_handler(arch_env_t *env,
-    const arch_irn_handler_t *handler)
-{
-  assert(env->handlers_tos <= ARCH_MAX_HANDLERS);
-  env->handlers[env->handlers_tos++] = handler;
-  return env;
-}
-
-const arch_irn_handler_t *arch_env_pop_irn_handler(arch_env_t *env)
+static const arch_register_req_t no_requirement = {
+       arch_register_req_type_none,
+       NULL,
+       NULL,
+       0,
+       0,
+       0
+};
+const arch_register_req_t *arch_no_register_req = &no_requirement;
+
+static reg_out_info_t dummy_info = {
+       NULL,
+       &no_requirement
+};
+
+/* Initialize the architecture environment struct. */
+arch_env_t *arch_env_init(const arch_isa_if_t *isa_if, FILE *file_handle, be_main_env_t *main_env)
 {
-  assert(env->handlers_tos > 0 && env->handlers_tos <= ARCH_MAX_HANDLERS);
-  return env->handlers[--env->handlers_tos];
-}
-
-static const arch_irn_ops_t *fallback_irn_ops = NULL;
-
-int arch_register_class_put(const arch_register_class_t *cls, bitset_t *bs)
-{
-  if(bs) {
-    int i, n;
-    for(i = 0, n = cls->n_regs; i < n; ++i)
-      bitset_set(bs, i);
-  }
-
-  return cls->n_regs;
+       arch_env_t *arch_env = isa_if->init(file_handle);
+       arch_env->main_env   = main_env;
+       return arch_env;
 }
 
 /**
  * Get the isa responsible for a node.
- * @param env The arch environment with the isa stack.
  * @param irn The node to get the responsible isa for.
  * @return The irn operations given by the responsible isa.
  */
-static INLINE const arch_irn_ops_t *
-get_irn_ops(const arch_env_t *env, const ir_node *irn)
+static const arch_irn_ops_t *get_irn_ops(const ir_node *irn)
 {
-  int i;
+       const ir_op          *ops;
+       const arch_irn_ops_t *be_ops;
 
-  for(i = env->handlers_tos - 1; i >= 0; --i) {
-    const arch_irn_handler_t *handler = env->handlers[i];
-    const arch_irn_ops_t *ops = handler->get_irn_ops(handler, irn);
+       if (is_Proj(irn)) {
+               irn = get_Proj_pred(irn);
+               assert(!is_Proj(irn));
+       }
 
-    if(ops)
-      return ops;
-  }
+       ops    = get_irn_op(irn);
+       be_ops = get_op_ops(ops)->be_ops;
 
-  return fallback_irn_ops;
+       return be_ops;
 }
 
-const arch_register_req_t *arch_get_register_req(const arch_env_t *env,
-    arch_register_req_t *req, const ir_node *irn, int pos)
+void arch_set_frame_offset(ir_node *irn, int offset)
 {
-  const arch_irn_ops_t *ops = get_irn_ops(env, irn);
-  req->type = arch_register_req_type_none;
-  return ops->impl->get_irn_reg_req(ops, req, irn, pos);
+       const arch_irn_ops_t *ops = get_irn_ops(irn);
+       ops->set_frame_offset(irn, offset);
 }
 
-void arch_set_frame_offset(const arch_env_t *env, ir_node *irn, int offset)
+ir_entity *arch_get_frame_entity(const ir_node *irn)
 {
-  const arch_irn_ops_t *ops = get_irn_ops(env, irn);
-  ops->impl->set_frame_offset(ops, irn, offset);
+       const arch_irn_ops_t *ops = get_irn_ops(irn);
+       return ops->get_frame_entity(irn);
 }
 
-entity *arch_get_frame_entity(const arch_env_t *env, ir_node *irn)
+int arch_get_sp_bias(ir_node *irn)
 {
-  const arch_irn_ops_t *ops = get_irn_ops(env, irn);
-  return ops->impl->get_frame_entity(ops, irn);
+       const arch_irn_ops_t *ops = get_irn_ops(irn);
+       return ops->get_sp_bias(irn);
 }
 
+arch_inverse_t *arch_get_inverse(const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack)
+{
+       const arch_irn_ops_t *ops = get_irn_ops(irn);
 
-int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn, int pos, bitset_t *bs)
+       if (ops->get_inverse) {
+               return ops->get_inverse(irn, i, inverse, obstack);
+       } else {
+               return NULL;
+       }
+}
+
+int arch_possible_memory_operand(const ir_node *irn, unsigned int i)
 {
-  arch_register_req_t local_req;
-  const arch_irn_ops_t *ops = get_irn_ops(env, irn);
-  const arch_register_req_t *req = ops->impl->get_irn_reg_req(ops, &local_req, irn, pos);
+       const arch_irn_ops_t *ops = get_irn_ops(irn);
 
-  if(req->type == arch_register_req_type_none) {
-         bitset_clear_all(bs);
-         return 0;
-  }
+       if (ops->possible_memory_operand) {
+               return ops->possible_memory_operand(irn, i);
+       } else {
+               return 0;
+       }
+}
 
-  if(arch_register_req_is(req, limited)) {
-         req->limited(req->limited_env, bs);
-         return bitset_popcnt(bs);
-  }
+void arch_perform_memory_operand(ir_node *irn, ir_node *spill, unsigned int i)
+{
+       const arch_irn_ops_t *ops = get_irn_ops(irn);
 
-  arch_register_class_put(req->cls, bs);
-  return req->cls->n_regs;
+       if (ops->perform_memory_operand) {
+               ops->perform_memory_operand(irn, spill, i);
+       } else {
+               return;
+       }
 }
 
-void arch_put_non_ignore_regs(const arch_env_t *env, const arch_register_class_t *cls, bitset_t *bs)
+int arch_get_op_estimated_cost(const ir_node *irn)
 {
-       int i;
+       const arch_irn_ops_t *ops = get_irn_ops(irn);
 
-       for(i = 0; i < cls->n_regs; ++i) {
-               if(!arch_register_type_is(&cls->regs[i], ignore))
-                       bitset_set(bs, i);
+       if (ops->get_op_estimated_cost) {
+               return ops->get_op_estimated_cost(irn);
+       } else {
+               return 1;
        }
 }
 
-int arch_is_register_operand(const arch_env_t *env,
-    const ir_node *irn, int pos)
+static reg_out_info_t *get_out_info(const ir_node *node)
 {
-       arch_register_req_t local_req;
-       const arch_irn_ops_t *ops = get_irn_ops(env, irn);
-       const arch_register_req_t *req = ops->impl->get_irn_reg_req(ops, &local_req, irn, pos);
-       return req != NULL;
+       size_t                pos = 0;
+       const backend_info_t *info;
+       assert(get_irn_mode(node) != mode_T);
+       if (is_Proj(node)) {
+               pos  = get_Proj_proj(node);
+               node = get_Proj_pred(node);
+       }
+
+       info = be_get_info(node);
+       /* We have a problem with the switch-node where there can be arbitrary
+        * Proj-numbers, so we can't easily allocate an array big-enough to hold
+        * all of them. So until we rewrite Switch-nodes we need this special case
+        */
+       if (info->out_infos == NULL)
+               return &dummy_info;
+       assert(pos < ARR_LEN(info->out_infos));
+       return &info->out_infos[pos];
 }
 
-int arch_reg_is_allocatable(const arch_env_t *env, const ir_node *irn,
-    int pos, const arch_register_t *reg)
+static reg_out_info_t *get_out_info_n(const ir_node *node, int pos)
 {
-       arch_register_req_t req;
+       const backend_info_t *info = be_get_info(node);
+       assert(!is_Proj(node));
+       assert(pos >= 0 && pos < (int)ARR_LEN(info->out_infos));
+       return &info->out_infos[pos];
+}
 
-       arch_get_register_req(env, &req, irn, pos);
 
-       if(req.type == arch_register_req_type_none)
-               return 0;
+const arch_register_t *arch_get_irn_register(const ir_node *node)
+{
+       const reg_out_info_t *out = get_out_info(node);
+       return out->reg;
+}
 
-       if(arch_register_req_is(&req, limited)) {
-               bitset_t *bs = bitset_alloca(req.cls->n_regs);
-               req.limited(req.limited_env, bs);
-               return bitset_is_set(bs, arch_register_get_index(reg));
-       }
+const arch_register_t *arch_get_irn_register_out(const ir_node *node, int pos)
+{
+       const reg_out_info_t *out = get_out_info_n(node, pos);
+       return out->reg;
+}
+
+const arch_register_t *arch_get_irn_register_in(const ir_node *node, int pos)
+{
+       ir_node *op = get_irn_n(node, pos);
+       return arch_get_irn_register(op);
+}
+
+void arch_set_irn_register_out(ir_node *node, int pos,
+                               const arch_register_t *reg)
+{
+       reg_out_info_t *out = get_out_info_n(node, pos);
+       out->reg            = reg;
+}
 
-       return req.cls == reg->reg_class;
+void arch_set_irn_register(ir_node *node, const arch_register_t *reg)
+{
+       reg_out_info_t *out = get_out_info(node);
+       out->reg = reg;
 }
 
-const arch_register_class_t *
-arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos)
+const arch_register_req_t *arch_get_irn_register_req(const ir_node *node)
 {
-  arch_register_req_t local_req;
-  const arch_irn_ops_t *ops = get_irn_ops(env, irn);
-  const arch_register_req_t *req = ops->impl->get_irn_reg_req(ops, &local_req, irn, pos);
-  return req ? req->cls : NULL;
+       reg_out_info_t *out = get_out_info(node);
+       return out->req;
 }
 
-extern const arch_register_t *
-arch_get_irn_register(const arch_env_t *env, const ir_node *irn)
+arch_irn_class_t arch_irn_classify(const ir_node *node)
 {
-  const arch_irn_ops_t *ops = get_irn_ops(env, irn);
-  return ops->impl->get_irn_reg(ops, irn);
+       const arch_irn_ops_t *ops = get_irn_ops(node);
+       return ops->classify(node);
 }
 
-extern void arch_set_irn_register(const arch_env_t *env,
-    ir_node *irn, const arch_register_t *reg)
+arch_irn_flags_t arch_get_irn_flags(const ir_node *node)
 {
-  const arch_irn_ops_t *ops = get_irn_ops(env, irn);
-  ops->impl->set_irn_reg(ops, irn, reg);
+       backend_info_t *info;
+       if (is_Proj(node))
+               return arch_irn_flags_not_scheduled;
+
+       info = be_get_info(node);
+       return info->flags;
 }
 
-extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn)
+void arch_set_irn_flags(ir_node *node, arch_irn_flags_t flags)
 {
-  const arch_irn_ops_t *ops = get_irn_ops(env, irn);
-  return ops->impl->classify(ops, irn);
+       backend_info_t *info;
+
+       /* setting flags is only supported for instructions currently.
+        * (mainly because we found no use for it yet and saved the space for
+        * be_infos for them */
+       assert(!is_Proj(node));
+       info = be_get_info(node);
+       info->flags = flags;
 }
 
-extern arch_irn_flags_t arch_irn_get_flags(const arch_env_t *env, const ir_node *irn)
+void arch_add_irn_flags(ir_node *node, arch_irn_flags_t flags)
 {
-  const arch_irn_ops_t *ops = get_irn_ops(env, irn);
-  return ops->impl->get_flags(ops, irn);
+       backend_info_t *info;
+       assert(!is_Proj(node));
+       info = be_get_info(node);
+       info->flags |= flags;
 }
 
-extern const char *arch_irn_flag_str(arch_irn_flags_t fl)
+bool arch_reg_is_allocatable(const arch_register_req_t *req,
+                             const arch_register_t *reg)
 {
-       switch(fl) {
-#define XXX(x) case arch_irn_flags_ ## x: return #x;
-               XXX(dont_spill);
-               XXX(ignore);
-               XXX(rematerializable);
-               XXX(none);
-#undef XXX
+       if (reg->type & arch_register_type_joker)
+               return true;
+       if (req->type == arch_register_req_type_none)
+               return false;
+       if (req->type & arch_register_req_type_limited) {
+               if (arch_register_get_class(reg) != req->cls)
+                       return false;
+               return rbitset_is_set(req->limited, arch_register_get_index(reg));
        }
-       return "n/a";
+       return req->cls == arch_register_get_class(reg);
 }
 
-extern char *arch_register_req_format(char *buf, size_t len, const arch_register_req_t *req)
+void arch_dump_register_req(FILE *F, const arch_register_req_t *req,
+                            const ir_node *node)
 {
-       char tmp[128];
-       snprintf(buf, len, "class: %s", req->cls->name);
+       if (req == NULL || req->type == arch_register_req_type_none) {
+               fprintf(F, "n/a");
+               return;
+       }
+
+       fprintf(F, "%s", req->cls->name);
+
+       if (arch_register_req_is(req, limited)) {
+               unsigned n_regs = req->cls->n_regs;
+               unsigned i;
 
-       if(arch_register_req_is(req, limited)) {
-               bitset_pos_t elm;
-               bitset_t *bs = bitset_alloca(req->cls->n_regs);
-               req->limited(req->limited_env, bs);
-               strncat(buf, " limited:", len);
-               bitset_foreach(bs, elm) {
-                       strncat(buf, " ", len);
-                       strncat(buf, req->cls->regs[elm].name, len);
+               fprintf(F, " limited to");
+               for (i = 0; i < n_regs; ++i) {
+                       if (rbitset_is_set(req->limited, i)) {
+                               const arch_register_t *reg = &req->cls->regs[i];
+                               fprintf(F, " %s", reg->name);
+                       }
                }
        }
 
-       if(arch_register_req_is(req, should_be_same)) {
-               ir_snprintf(tmp, sizeof(tmp), " same to: %+F", req->other_different);
-               strncat(buf, tmp, len);
+       if (arch_register_req_is(req, should_be_same)) {
+               const unsigned other = req->other_same;
+               int i;
+
+               fprintf(F, " same as");
+               for (i = 0; 1U << i <= other; ++i) {
+                       if (other & (1U << i)) {
+                               ir_fprintf(F, " %+F", get_irn_n(skip_Proj_const(node), i));
+                       }
+               }
        }
 
-       if(arch_register_req_is(req, should_be_different)) {
-               ir_snprintf(tmp, sizeof(tmp), " different to: %+F", req->other_different);
-               strncat(buf, tmp, len);
+       if (arch_register_req_is(req, must_be_different)) {
+               const unsigned other = req->other_different;
+               int i;
+
+               fprintf(F, " different from");
+               for (i = 0; 1U << i <= other; ++i) {
+                       if (other & (1U << i)) {
+                               ir_fprintf(F, " %+F", get_irn_n(skip_Proj_const(node), i));
+                       }
+               }
        }
 
-       return buf;
+       if (req->width != 1) {
+               fprintf(F, " width:%d", req->width);
+       }
+       if (arch_register_req_is(req, aligned)) {
+               fprintf(F, " aligned");
+       }
+       if (arch_register_req_is(req, ignore)) {
+               fprintf(F, " ignore");
+       }
+       if (arch_register_req_is(req, produces_sp)) {
+               fprintf(F, " produces_sp");
+       }
+}
+
+void arch_dump_reqs_and_registers(FILE *F, const ir_node *node)
+{
+       int              n_ins  = get_irn_arity(node);
+       int              n_outs = arch_get_irn_n_outs(node);
+       arch_irn_flags_t flags  = arch_get_irn_flags(node);
+       int              i;
+
+       for (i = 0; i < n_ins; ++i) {
+               const arch_register_req_t *req = arch_get_irn_register_req_in(node, i);
+               fprintf(F, "inreq #%d = ", i);
+               arch_dump_register_req(F, req, node);
+               fputs("\n", F);
+       }
+       for (i = 0; i < n_outs; ++i) {
+               const arch_register_req_t *req = arch_get_irn_register_req_out(node, i);
+               fprintf(F, "outreq #%d = ", i);
+               arch_dump_register_req(F, req, node);
+               fputs("\n", F);
+       }
+       for (i = 0; i < n_outs; ++i) {
+               const arch_register_t     *reg = arch_get_irn_register_out(node, i);
+               const arch_register_req_t *req = arch_get_irn_register_req_out(node, i);
+               if (req->cls == NULL)
+                       continue;
+               fprintf(F, "reg #%d = %s\n", i, reg != NULL ? reg->name : "n/a");
+       }
+
+       fprintf(F, "flags =");
+       if (flags == arch_irn_flags_none) {
+               fprintf(F, " none");
+       } else {
+               if (flags & arch_irn_flags_dont_spill) {
+                       fprintf(F, " unspillable");
+               }
+               if (flags & arch_irn_flags_rematerializable) {
+                       fprintf(F, " remat");
+               }
+               if (flags & arch_irn_flags_modify_flags) {
+                       fprintf(F, " modify_flags");
+               }
+               if (flags & arch_irn_flags_simple_jump) {
+                       fprintf(F, " simple_jump");
+               }
+               if (flags & arch_irn_flags_not_scheduled) {
+                       fprintf(F, " not_scheduled");
+               }
+       }
+       fprintf(F, " (%d)\n", (int)flags);
 }