Subversion Repositories openrisc_me

/* Print SPARC instructions.

   Copyright 1989, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,

   2000, 2002, 2003, 2004, 2005, 2006, 2007, 2008

   Free Software Foundation, Inc.

   This file is part of the GNU opcodes library.

   This library is free software; you can redistribute it and/or modify

   it under the terms of the GNU General Public License as published by

   the Free Software Foundation; either version 3, or (at your option)

   any later version.

   It is distributed in the hope that it will be useful, but WITHOUT

   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY

   or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public

   License for more details.

   You should have received a copy of the GNU General Public License

   along with this program; if not, write to the Free Software

   Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,

   MA 02110-1301, USA.  */

#include <stdio.h>

#include "sysdep.h"

#include "opcode/sparc.h"

#include "dis-asm.h"

#include "libiberty.h"

#include "opintl.h"

/* Bitmask of v9 architectures.  */

#define MASK_V9 ((1 << SPARC_OPCODE_ARCH_V9) \

                 | (1 << SPARC_OPCODE_ARCH_V9A) \

                 | (1 << SPARC_OPCODE_ARCH_V9B))

/* 1 if INSN is for v9 only.  */

#define V9_ONLY_P(insn) (! ((insn)->architecture & ~MASK_V9))

/* 1 if INSN is for v9.  */

#define V9_P(insn) (((insn)->architecture & MASK_V9) != 0)

/* The sorted opcode table.  */

static const sparc_opcode **sorted_opcodes;

/* For faster lookup, after insns are sorted they are hashed.  */

/* ??? I think there is room for even more improvement.  */

#define HASH_SIZE 256

/* It is important that we only look at insn code bits as that is how the

   opcode table is hashed.  OPCODE_BITS is a table of valid bits for each

   of the main types (0,1,2,3).  */

static int opcode_bits[4] = { 0x01c00000, 0x0, 0x01f80000, 0x01f80000 };

#define HASH_INSN(INSN) \

  ((((INSN) >> 24) & 0xc0) | (((INSN) & opcode_bits[((INSN) >> 30) & 3]) >> 19))

typedef struct sparc_opcode_hash

{

  struct sparc_opcode_hash *next;

  const sparc_opcode *opcode;

} sparc_opcode_hash;

static sparc_opcode_hash *opcode_hash_table[HASH_SIZE];

/* Sign-extend a value which is N bits long.  */

#define SEX(value, bits) \

        ((((int)(value)) << ((8 * sizeof (int)) - bits))        \

                         >> ((8 * sizeof (int)) - bits) )

static  char *reg_names[] =

{ "g0", "g1", "g2", "g3", "g4", "g5", "g6", "g7",

  "o0", "o1", "o2", "o3", "o4", "o5", "sp", "o7",

  "l0", "l1", "l2", "l3", "l4", "l5", "l6", "l7",

  "i0", "i1", "i2", "i3", "i4", "i5", "fp", "i7",

  "f0", "f1", "f2", "f3", "f4", "f5", "f6", "f7",

  "f8", "f9", "f10", "f11", "f12", "f13", "f14", "f15",

  "f16", "f17", "f18", "f19", "f20", "f21", "f22", "f23",

  "f24", "f25", "f26", "f27", "f28", "f29", "f30", "f31",

  "f32", "f33", "f34", "f35", "f36", "f37", "f38", "f39",

  "f40", "f41", "f42", "f43", "f44", "f45", "f46", "f47",

  "f48", "f49", "f50", "f51", "f52", "f53", "f54", "f55",

  "f56", "f57", "f58", "f59", "f60", "f61", "f62", "f63",

/* psr, wim, tbr, fpsr, cpsr are v8 only.  */

  "y", "psr", "wim", "tbr", "pc", "npc", "fpsr", "cpsr"

};

#define freg_names      (&reg_names[4 * 8])

/* These are ordered according to there register number in

   rdpr and wrpr insns.  */

static char *v9_priv_reg_names[] =

{

  "tpc", "tnpc", "tstate", "tt", "tick", "tba", "pstate", "tl",

  "pil", "cwp", "cansave", "canrestore", "cleanwin", "otherwin",

  "wstate", "fq", "gl"

  /* "ver" - special cased */

};

/* These are ordered according to there register number in

   rdhpr and wrhpr insns.  */

static char *v9_hpriv_reg_names[] =

{

  "hpstate", "htstate", "resv2", "hintp", "resv4", "htba", "hver",

  "resv7", "resv8", "resv9", "resv10", "resv11", "resv12", "resv13",

  "resv14", "resv15", "resv16", "resv17", "resv18", "resv19", "resv20",

  "resv21", "resv22", "resv23", "resv24", "resv25", "resv26", "resv27",

  "resv28", "resv29", "resv30", "hstick_cmpr"

};

/* These are ordered according to there register number in

   rd and wr insns (-16).  */

static char *v9a_asr_reg_names[] =

{

  "pcr", "pic", "dcr", "gsr", "set_softint", "clear_softint",

  "softint", "tick_cmpr", "stick", "stick_cmpr"

};

/* Macros used to extract instruction fields.  Not all fields have

   macros defined here, only those which are actually used.  */

#define X_RD(i)      (((i) >> 25) & 0x1f)

#define X_RS1(i)     (((i) >> 14) & 0x1f)

#define X_LDST_I(i)  (((i) >> 13) & 1)

#define X_ASI(i)     (((i) >> 5) & 0xff)

#define X_RS2(i)     (((i) >> 0) & 0x1f)

#define X_IMM(i,n)   (((i) >> 0) & ((1 << (n)) - 1))

#define X_SIMM(i,n)  SEX (X_IMM ((i), (n)), (n))

#define X_DISP22(i)  (((i) >> 0) & 0x3fffff)

#define X_IMM22(i)   X_DISP22 (i)

#define X_DISP30(i)  (((i) >> 0) & 0x3fffffff)

/* These are for v9.  */

#define X_DISP16(i)  (((((i) >> 20) & 3) << 14) | (((i) >> 0) & 0x3fff))

#define X_DISP19(i)  (((i) >> 0) & 0x7ffff)

#define X_MEMBAR(i)  ((i) & 0x7f)

/* Here is the union which was used to extract instruction fields

   before the shift and mask macros were written.

   union sparc_insn

     {

       unsigned long int code;

       struct

         {

           unsigned int anop:2;

           #define      op      ldst.anop

           unsigned int anrd:5;

           #define      rd      ldst.anrd

           unsigned int op3:6;

           unsigned int anrs1:5;

           #define      rs1     ldst.anrs1

           unsigned int i:1;

           unsigned int anasi:8;

           #define      asi     ldst.anasi

           unsigned int anrs2:5;

           #define      rs2     ldst.anrs2

           #define      shcnt   rs2

         } ldst;

       struct

         {

           unsigned int anop:2, anrd:5, op3:6, anrs1:5, i:1;

           unsigned int IMM13:13;

           #define      imm13   IMM13.IMM13

         } IMM13;

       struct

         {

           unsigned int anop:2;

           unsigned int a:1;

           unsigned int cond:4;

           unsigned int op2:3;

           unsigned int DISP22:22;

           #define      disp22  branch.DISP22

           #define      imm22   disp22

         } branch;

       struct

         {

           unsigned int anop:2;

           unsigned int a:1;

           unsigned int z:1;

           unsigned int rcond:3;

           unsigned int op2:3;

           unsigned int DISP16HI:2;

           unsigned int p:1;

           unsigned int _rs1:5;

           unsigned int DISP16LO:14;

         } branch16;

       struct

         {

           unsigned int anop:2;

           unsigned int adisp30:30;

           #define      disp30  call.adisp30

         } call;

     };  */

/* Nonzero if INSN is the opcode for a delayed branch.  */

static int

is_delayed_branch (unsigned long insn)

{

  sparc_opcode_hash *op;

  for (op = opcode_hash_table[HASH_INSN (insn)]; op; op = op->next)

    {

      const sparc_opcode *opcode = op->opcode;

      if ((opcode->match & insn) == opcode->match

          && (opcode->lose & insn) == 0)

        return opcode->flags & F_DELAYED;

    }

  return 0;

}

/* extern void qsort (); */

/* Records current mask of SPARC_OPCODE_ARCH_FOO values, used to pass value

   to compare_opcodes.  */

static unsigned int current_arch_mask;

/* Given BFD mach number, return a mask of SPARC_OPCODE_ARCH_FOO values.  */

static int

compute_arch_mask (unsigned long mach)

{

  switch (mach)

    {

    case 0 :

    case bfd_mach_sparc :

      return SPARC_OPCODE_ARCH_MASK (SPARC_OPCODE_ARCH_V8);

    case bfd_mach_sparc_sparclet :

      return SPARC_OPCODE_ARCH_MASK (SPARC_OPCODE_ARCH_SPARCLET);

    case bfd_mach_sparc_sparclite :

    case bfd_mach_sparc_sparclite_le :

      /* sparclites insns are recognized by default (because that's how

         they've always been treated, for better or worse).  Kludge this by

         indicating generic v8 is also selected.  */

      return (SPARC_OPCODE_ARCH_MASK (SPARC_OPCODE_ARCH_SPARCLITE)

              | SPARC_OPCODE_ARCH_MASK (SPARC_OPCODE_ARCH_V8));

    case bfd_mach_sparc_v8plus :

    case bfd_mach_sparc_v9 :

      return SPARC_OPCODE_ARCH_MASK (SPARC_OPCODE_ARCH_V9);

    case bfd_mach_sparc_v8plusa :

    case bfd_mach_sparc_v9a :

      return SPARC_OPCODE_ARCH_MASK (SPARC_OPCODE_ARCH_V9A);

    case bfd_mach_sparc_v8plusb :

    case bfd_mach_sparc_v9b :

      return SPARC_OPCODE_ARCH_MASK (SPARC_OPCODE_ARCH_V9B);

    }

  abort ();

}

/* Compare opcodes A and B.  */

static int

compare_opcodes (const void * a, const void * b)

{

  sparc_opcode *op0 = * (sparc_opcode **) a;

  sparc_opcode *op1 = * (sparc_opcode **) b;

  unsigned long int match0 = op0->match, match1 = op1->match;

  unsigned long int lose0 = op0->lose, lose1 = op1->lose;

  register unsigned int i;

  /* If one (and only one) insn isn't supported by the current architecture,

     prefer the one that is.  If neither are supported, but they're both for

     the same architecture, continue processing.  Otherwise (both unsupported

     and for different architectures), prefer lower numbered arch's (fudged

     by comparing the bitmasks).  */

  if (op0->architecture & current_arch_mask)

    {

      if (! (op1->architecture & current_arch_mask))

        return -1;

    }

  else

    {

      if (op1->architecture & current_arch_mask)

        return 1;

      else if (op0->architecture != op1->architecture)

        return op0->architecture - op1->architecture;

    }

  /* If a bit is set in both match and lose, there is something

     wrong with the opcode table.  */

  if (match0 & lose0)

    {

      fprintf

        (stderr,

         /* xgettext:c-format */

         _("Internal error:  bad sparc-opcode.h: \"%s\", %#.8lx, %#.8lx\n"),

         op0->name, match0, lose0);

      op0->lose &= ~op0->match;

      lose0 = op0->lose;

    }

  if (match1 & lose1)

    {

      fprintf

        (stderr,

         /* xgettext:c-format */

         _("Internal error: bad sparc-opcode.h: \"%s\", %#.8lx, %#.8lx\n"),

         op1->name, match1, lose1);

      op1->lose &= ~op1->match;

      lose1 = op1->lose;

    }

  /* Because the bits that are variable in one opcode are constant in

     another, it is important to order the opcodes in the right order.  */

  for (i = 0; i < 32; ++i)

    {

      unsigned long int x = 1 << i;

      int x0 = (match0 & x) != 0;

      int x1 = (match1 & x) != 0;

      if (x0 != x1)

        return x1 - x0;

    }

  for (i = 0; i < 32; ++i)

    {

      unsigned long int x = 1 << i;

      int x0 = (lose0 & x) != 0;

      int x1 = (lose1 & x) != 0;

      if (x0 != x1)

        return x1 - x0;

    }

  /* They are functionally equal.  So as long as the opcode table is

     valid, we can put whichever one first we want, on aesthetic grounds.  */

  /* Our first aesthetic ground is that aliases defer to real insns.  */

  {

    int alias_diff = (op0->flags & F_ALIAS) - (op1->flags & F_ALIAS);

    if (alias_diff != 0)

      /* Put the one that isn't an alias first.  */

      return alias_diff;

  }

  /* Except for aliases, two "identical" instructions had

     better have the same opcode.  This is a sanity check on the table.  */

  i = strcmp (op0->name, op1->name);

  if (i)

    {

      if (op0->flags & F_ALIAS) /* If they're both aliases, be arbitrary.  */

        return i;

      else

        fprintf (stderr,

                 /* xgettext:c-format */

                 _("Internal error: bad sparc-opcode.h: \"%s\" == \"%s\"\n"),

                 op0->name, op1->name);

    }

  /* Fewer arguments are preferred.  */

  {

    int length_diff = strlen (op0->args) - strlen (op1->args);

    if (length_diff != 0)

      /* Put the one with fewer arguments first.  */

      return length_diff;

  }

  /* Put 1+i before i+1.  */

  {

    char *p0 = (char *) strchr (op0->args, '+');

    char *p1 = (char *) strchr (op1->args, '+');

    if (p0 && p1)

      {

        /* There is a plus in both operands.  Note that a plus

           sign cannot be the first character in args,

           so the following [-1]'s are valid.  */

        if (p0[-1] == 'i' && p1[1] == 'i')

          /* op0 is i+1 and op1 is 1+i, so op1 goes first.  */

          return 1;

        if (p0[1] == 'i' && p1[-1] == 'i')

          /* op0 is 1+i and op1 is i+1, so op0 goes first.  */

          return -1;

      }

  }

  /* Put 1,i before i,1.  */

  {

    int i0 = strncmp (op0->args, "i,1", 3) == 0;

    int i1 = strncmp (op1->args, "i,1", 3) == 0;

    if (i0 ^ i1)

      return i0 - i1;

  }

  /* They are, as far as we can tell, identical.

     Since qsort may have rearranged the table partially, there is

     no way to tell which one was first in the opcode table as

     written, so just say there are equal.  */

  /* ??? This is no longer true now that we sort a vector of pointers,

     not the table itself.  */

  return 0;

}

/* Build a hash table from the opcode table.

   OPCODE_TABLE is a sorted list of pointers into the opcode table.  */

static void

build_hash_table (const sparc_opcode **opcode_table,

                  sparc_opcode_hash **hash_table,

                  int num_opcodes)

{

  int i;

  int hash_count[HASH_SIZE];

  static sparc_opcode_hash *hash_buf = NULL;

  /* Start at the end of the table and work backwards so that each

     chain is sorted.  */

  memset (hash_table, 0, HASH_SIZE * sizeof (hash_table[0]));

  memset (hash_count, 0, HASH_SIZE * sizeof (hash_count[0]));

  if (hash_buf != NULL)

    free (hash_buf);

  hash_buf = xmalloc (sizeof (* hash_buf) * num_opcodes);

  for (i = num_opcodes - 1; i >= 0; --i)

    {

      int hash = HASH_INSN (opcode_table[i]->match);

      sparc_opcode_hash *h = &hash_buf[i];

      h->next = hash_table[hash];

      h->opcode = opcode_table[i];

      hash_table[hash] = h;

      ++hash_count[hash];

    }

#if 0 /* for debugging */

  {

    int min_count = num_opcodes, max_count = 0;

    int total;

    for (i = 0; i < HASH_SIZE; ++i)

      {

        if (hash_count[i] < min_count)

          min_count = hash_count[i];

        if (hash_count[i] > max_count)

          max_count = hash_count[i];

        total += hash_count[i];

      }

    printf ("Opcode hash table stats: min %d, max %d, ave %f\n",

            min_count, max_count, (double) total / HASH_SIZE);

  }

#endif

}

/* Print one instruction from MEMADDR on INFO->STREAM.

   We suffix the instruction with a comment that gives the absolute

   address involved, as well as its symbolic form, if the instruction

   is preceded by a findable `sethi' and it either adds an immediate

   displacement to that register, or it is an `add' or `or' instruction

   on that register.  */

int

print_insn_sparc (bfd_vma memaddr, disassemble_info *info)

{

  FILE *stream = info->stream;

  bfd_byte buffer[4];

  unsigned long insn;

  sparc_opcode_hash *op;

  /* Nonzero of opcode table has been initialized.  */

  static int opcodes_initialized = 0;

  /* bfd mach number of last call.  */

  static unsigned long current_mach = 0;

  bfd_vma (*getword) (const void *);

  if (!opcodes_initialized

      || info->mach != current_mach)

    {

      int i;

      current_arch_mask = compute_arch_mask (info->mach);

      if (!opcodes_initialized)

        sorted_opcodes =

          xmalloc (sparc_num_opcodes * sizeof (sparc_opcode *));

      /* Reset the sorted table so we can resort it.  */

      for (i = 0; i < sparc_num_opcodes; ++i)

        sorted_opcodes[i] = &sparc_opcodes[i];

      qsort ((char *) sorted_opcodes, sparc_num_opcodes,

             sizeof (sorted_opcodes[0]), compare_opcodes);

      build_hash_table (sorted_opcodes, opcode_hash_table, sparc_num_opcodes);

      current_mach = info->mach;

      opcodes_initialized = 1;

    }

  {

    int status =

      (*info->read_memory_func) (memaddr, buffer, sizeof (buffer), info);

    if (status != 0)

      {

        (*info->memory_error_func) (status, memaddr, info);

        return -1;

      }

  }

  /* On SPARClite variants such as DANlite (sparc86x), instructions

     are always big-endian even when the machine is in little-endian mode.  */

  if (info->endian == BFD_ENDIAN_BIG || info->mach == bfd_mach_sparc_sparclite)

    getword = bfd_getb32;

  else

    getword = bfd_getl32;

  insn = getword (buffer);

  info->insn_info_valid = 1;                    /* We do return this info.  */

  info->insn_type = dis_nonbranch;              /* Assume non branch insn.  */

  info->branch_delay_insns = 0;                  /* Assume no delay.  */

  info->target = 0;                              /* Assume no target known.  */

  for (op = opcode_hash_table[HASH_INSN (insn)]; op; op = op->next)

    {

      const sparc_opcode *opcode = op->opcode;

      /* If the insn isn't supported by the current architecture, skip it.  */

      if (! (opcode->architecture & current_arch_mask))

        continue;

      if ((opcode->match & insn) == opcode->match

          && (opcode->lose & insn) == 0)

        {

          /* Nonzero means that we have found an instruction which has

             the effect of adding or or'ing the imm13 field to rs1.  */

          int imm_added_to_rs1 = 0;

          int imm_ored_to_rs1 = 0;

          /* Nonzero means that we have found a plus sign in the args

             field of the opcode table.  */

          int found_plus = 0;

          /* Nonzero means we have an annulled branch.  */

          int is_annulled = 0;

          /* Do we have an `add' or `or' instruction combining an

             immediate with rs1?  */

          if (opcode->match == 0x80102000) /* or */

            imm_ored_to_rs1 = 1;

          if (opcode->match == 0x80002000) /* add */

            imm_added_to_rs1 = 1;

          if (X_RS1 (insn) != X_RD (insn)

              && strchr (opcode->args, 'r') != 0)

              /* Can't do simple format if source and dest are different.  */

              continue;

          if (X_RS2 (insn) != X_RD (insn)

              && strchr (opcode->args, 'O') != 0)

              /* Can't do simple format if source and dest are different.  */

              continue;

          (*info->fprintf_func) (stream, opcode->name);

          {

            const char *s;

            if (opcode->args[0] != ',')

              (*info->fprintf_func) (stream, " ");

            for (s = opcode->args; *s != '\0'; ++s)

              {

                while (*s == ',')

                  {

                    (*info->fprintf_func) (stream, ",");

                    ++s;

                    switch (*s)

                      {

                      case 'a':

                        (*info->fprintf_func) (stream, "a");

                        is_annulled = 1;

                        ++s;

                        continue;

                      case 'N':

                        (*info->fprintf_func) (stream, "pn");

                        ++s;

                        continue;

                      case 'T':

                        (*info->fprintf_func) (stream, "pt");

                        ++s;

                        continue;

                      default:

                        break;

                      }

                  }

                (*info->fprintf_func) (stream, " ");

                switch (*s)

                  {

                  case '+':

                    found_plus = 1;

                    /* Fall through.  */

                  default:

                    (*info->fprintf_func) (stream, "%c", *s);

                    break;

                  case '#':

                    (*info->fprintf_func) (stream, "0");

                    break;

#define reg(n)  (*info->fprintf_func) (stream, "%%%s", reg_names[n])

                  case '1':

                  case 'r':

                    reg (X_RS1 (insn));

                    break;

                  case '2':

                  case 'O':

                    reg (X_RS2 (insn));

                    break;

                  case 'd':

                    reg (X_RD (insn));

                    break;

#undef  reg

#define freg(n)         (*info->fprintf_func) (stream, "%%%s", freg_names[n])

#define fregx(n)        (*info->fprintf_func) (stream, "%%%s", freg_names[((n) & ~1) | (((n) & 1) << 5)])

                  case 'e':

                    freg (X_RS1 (insn));

                    break;

                  case 'v':     /* Double/even.  */

                  case 'V':     /* Quad/multiple of 4.  */

                    fregx (X_RS1 (insn));

                    break;

                  case 'f':

                    freg (X_RS2 (insn));

                    break;

                  case 'B':     /* Double/even.  */

                  case 'R':     /* Quad/multiple of 4.  */

                    fregx (X_RS2 (insn));

                    break;

                  case 'g':

                    freg (X_RD (insn));

                    break;

                  case 'H':     /* Double/even.  */

                  case 'J':     /* Quad/multiple of 4.  */

                    fregx (X_RD (insn));

                    break;

#undef  freg

#undef  fregx

#define creg(n) (*info->fprintf_func) (stream, "%%c%u", (unsigned int) (n))

                  case 'b':

                    creg (X_RS1 (insn));

                    break;

                  case 'c':

                    creg (X_RS2 (insn));

                    break;

                  case 'D':

                    creg (X_RD (insn));

                    break;

#undef  creg

                  case 'h':

                    (*info->fprintf_func) (stream, "%%hi(%#x)",

                                           ((unsigned) 0xFFFFFFFF

                                            & ((int) X_IMM22 (insn) << 10)));