MIPS: Fix XPA base and Virtualization ASE instruction handling
[external/binutils.git] / opcodes / arc-dis.c
index 53ba5f5..addd75c 100644 (file)
@@ -51,6 +51,33 @@ struct arc_operand_iterator
   const unsigned char *opidx;
 };
 
+/* A private data used by ARC decoder.  */
+struct arc_disassemble_info
+{
+  /* The current disassembled arc opcode.  */
+  const struct arc_opcode *opcode;
+
+  /* Instruction length w/o limm field.  */
+  unsigned insn_len;
+
+  /* TRUE if we have limm.  */
+  bfd_boolean limm_p;
+
+  /* LIMM value, if exists.  */
+  unsigned limm;
+
+  /* Condition code, if exists.  */
+  unsigned condition_code;
+
+  /* Writeback mode.  */
+  unsigned writeback_mode;
+
+  /* Number of operands.  */
+  unsigned operands_count;
+
+  struct arc_insn_operand operands[MAX_INSN_ARGS];
+};
+
 /* Globals variables.  */
 
 static const char * const regnames[64] =
@@ -90,6 +117,11 @@ typedef struct skipclass
    disassembling.  */
 static linkclass decodelist = NULL;
 
+/* ISA mask value enforced via disassembler info options.  ARC_OPCODE_NONE
+   value means that no CPU is enforced.  */
+
+static unsigned enforced_isa_mask = ARC_OPCODE_NONE;
+
 /* Macros section.  */
 
 #ifdef DEBUG
@@ -108,6 +140,20 @@ static linkclass decodelist = NULL;
 
 /* Functions implementation.  */
 
+/* Initialize private data.  */
+static bfd_boolean
+init_arc_disasm_info (struct disassemble_info *info)
+{
+  struct arc_disassemble_info *arc_infop
+    = calloc (sizeof (*arc_infop), 1);
+
+  if (arc_infop == NULL)
+    return FALSE;
+
+  info->private_data = arc_infop;
+  return TRUE;
+}
+
 /* Add a new element to the decode list.  */
 
 static void
@@ -280,6 +326,10 @@ find_format_from_table (struct disassemble_info *info,
                continue;
            }
 
+         /* Check for the implicit flags.  */
+         if (cl_flags->flag_class & F_CLASS_IMPLICIT)
+           continue;
+
          for (flgopridx = cl_flags->flags; *flgopridx; ++flgopridx)
            {
              const struct arc_flag_operand *flg_operand =
@@ -367,6 +417,7 @@ find_format (bfd_vma                       memaddr,
   bfd_boolean needs_limm;
   const extInstruction_t *einsn, *i;
   unsigned limm = 0;
+  struct arc_disassemble_info *arc_infop = info->private_data;
 
   /* First, try the extension instructions.  */
   if (*insn_len == 4)
@@ -422,6 +473,12 @@ An error occured while generating the extension instruction operations");
     }
 
   *opcode_result = opcode;
+
+  /* Update private data.  */
+  arc_infop->opcode = opcode;
+  arc_infop->limm = (needs_limm) ? limm : 0;
+  arc_infop->limm_p = needs_limm;
+
   return TRUE;
 }
 
@@ -432,6 +489,7 @@ print_flags (const struct arc_opcode *opcode,
 {
   const unsigned char *flgidx;
   unsigned int value;
+  struct arc_disassemble_info *arc_infop = info->private_data;
 
   /* Now extract and print the flags.  */
   for (flgidx = opcode->flags; *flgidx; flgidx++)
@@ -459,6 +517,18 @@ print_flags (const struct arc_opcode *opcode,
          const struct arc_flag_operand *flg_operand =
            &arc_flag_operands[*flgopridx];
 
+         /* Implicit flags are only used for the insn decoder.  */
+         if (cl_flags->flag_class & F_CLASS_IMPLICIT)
+           {
+             if (cl_flags->flag_class & F_CLASS_COND)
+               arc_infop->condition_code = flg_operand->code;
+             else if (cl_flags->flag_class & F_CLASS_WB)
+               arc_infop->writeback_mode = flg_operand->code;
+             else if (cl_flags->flag_class & F_CLASS_ZZ)
+               info->data_size = flg_operand->code;
+             continue;
+           }
+
          if (!flg_operand->favail)
            continue;
 
@@ -496,8 +566,13 @@ print_flags (const struct arc_opcode *opcode,
                    info->insn_type = dis_condjsr;
                  else if (info->insn_type == dis_branch)
                    info->insn_type = dis_condbranch;
+                 arc_infop->condition_code = flg_operand->code;
                }
 
+             /* Check for the write back modes.  */
+             if (cl_flags->flag_class & F_CLASS_WB)
+               arc_infop->writeback_mode = flg_operand->code;
+
              (*info->fprintf_func) (info->stream, "%s", flg_operand->name);
            }
        }
@@ -663,34 +738,35 @@ operand_iterator_next (struct arc_operand_iterator *iter,
 /* Helper for parsing the options.  */
 
 static void
-parse_option (char *option)
+parse_option (const char *option)
 {
-  if (CONST_STRNEQ (option, "dsp"))
+  if (disassembler_options_cmp (option, "dsp") == 0)
     add_to_decodelist (DSP, NONE);
 
-  else if (CONST_STRNEQ (option, "spfp"))
+  else if (disassembler_options_cmp (option, "spfp") == 0)
     add_to_decodelist (FLOAT, SPX);
 
-  else if (CONST_STRNEQ (option, "dpfp"))
+  else if (disassembler_options_cmp (option, "dpfp") == 0)
     add_to_decodelist (FLOAT, DPX);
 
-  else if (CONST_STRNEQ (option, "quarkse_em"))
+  else if (disassembler_options_cmp (option, "quarkse_em") == 0)
     {
       add_to_decodelist (FLOAT, DPX);
       add_to_decodelist (FLOAT, SPX);
-      add_to_decodelist (FLOAT, QUARKSE);
+      add_to_decodelist (FLOAT, QUARKSE1);
+      add_to_decodelist (FLOAT, QUARKSE2);
     }
 
-  else if (CONST_STRNEQ (option, "fpuda"))
+  else if (disassembler_options_cmp (option, "fpuda") == 0)
     add_to_decodelist (FLOAT, DPA);
 
-  else if (CONST_STRNEQ (option, "fpus"))
+  else if (disassembler_options_cmp (option, "fpus") == 0)
     {
       add_to_decodelist (FLOAT, SP);
       add_to_decodelist (FLOAT, CVT);
     }
 
-  else if (CONST_STRNEQ (option, "fpud"))
+  else if (disassembler_options_cmp (option, "fpud") == 0)
     {
       add_to_decodelist (FLOAT, DP);
       add_to_decodelist (FLOAT, CVT);
@@ -699,27 +775,74 @@ parse_option (char *option)
     fprintf (stderr, _("Unrecognised disassembler option: %s\n"), option);
 }
 
-/* Go over the options list and parse it.  */
+#define ARC_CPU_TYPE_A6xx(NAME,EXTRA)                  \
+  { #NAME, ARC_OPCODE_ARC600, "ARC600" }
+#define ARC_CPU_TYPE_A7xx(NAME,EXTRA)                  \
+  { #NAME, ARC_OPCODE_ARC700, "ARC700" }
+#define ARC_CPU_TYPE_AV2EM(NAME,EXTRA)                 \
+  { #NAME,  ARC_OPCODE_ARCv2EM, "ARC EM" }
+#define ARC_CPU_TYPE_AV2HS(NAME,EXTRA)                 \
+  { #NAME,  ARC_OPCODE_ARCv2HS, "ARC HS" }
+#define ARC_CPU_TYPE_NONE                              \
+  { 0, 0, 0 }
+
+/* A table of CPU names and opcode sets.  */
+static const struct cpu_type
+{
+  const char *name;
+  unsigned flags;
+  const char *isa;
+}
+  cpu_types[] =
+{
+  #include "elf/arc-cpu.def"
+};
 
-static void
-parse_disassembler_options (char *options)
+/* Helper for parsing the CPU options.  Accept any of the ARC architectures
+   values.  OPTION should be a value passed to cpu=.  */
+
+static unsigned
+parse_cpu_option (const char *option)
 {
-  if (options == NULL)
-    return;
+  int i;
 
-  while (*options)
+  for (i = 0; cpu_types[i].name; ++i)
     {
-      /* Skip empty options.  */
-      if (*options == ',')
+      if (!disassembler_options_cmp (cpu_types[i].name, option))
        {
-         ++ options;
-         continue;
+         return cpu_types[i].flags;
        }
+    }
+
+  fprintf (stderr, _("Unrecognised disassembler CPU option: %s\n"), option);
+  return ARC_OPCODE_NONE;
+}
+
+/* Go over the options list and parse it.  */
 
-      parse_option (options);
+static void
+parse_disassembler_options (const char *options)
+{
+  const char *option;
+
+  if (options == NULL)
+    return;
+
+  /* Disassembler might be reused for difference CPU's, and cpu option set for
+     the first one shouldn't be applied to second (which might not have
+     explicit cpu in its options.  Therefore it is required to reset enforced
+     CPU when new options are being parsed.  */
+  enforced_isa_mask = ARC_OPCODE_NONE;
 
-      while (*options != ',' && *options != '\0')
-       ++ options;
+  FOR_EACH_DISASSEMBLER_OPTION (option, options)
+    {
+      /* A CPU option?  Cannot use STRING_COMMA_LEN because strncmp is also a
+        preprocessor macro.  */
+      if (strncmp (option, "cpu=", 4) == 0)
+       /* Strip leading `cpu=`.  */
+       enforced_isa_mask = parse_cpu_option (option + 4);
+      else
+       parse_option (option);
     }
 }
 
@@ -733,7 +856,15 @@ arc_opcode_to_insn_type (const struct arc_opcode *opcode)
   switch (opcode->insn_class)
     {
     case BRANCH:
+    case BBIT0:
+    case BBIT1:
+    case BI:
+    case BIH:
+    case BRCC:
+    case EI:
+    case JLI:
     case JUMP:
+    case LOOP:
       if (!strncmp (opcode->name, "bl", 2)
          || !strncmp (opcode->name, "jl", 2))
        {
@@ -753,8 +884,14 @@ arc_opcode_to_insn_type (const struct arc_opcode *opcode)
     case LOAD:
     case STORE:
     case MEMORY:
+    case ENTER:
+    case PUSH:
+    case POP:
       insn_type = dis_dref;
       break;
+    case LEAVE:
+      insn_type = dis_branch;
+      break;
     default:
       insn_type = dis_nonbranch;
       break;
@@ -774,7 +911,7 @@ print_insn_arc (bfd_vma memaddr,
   int status;
   unsigned int insn_len;
   unsigned long long insn = 0;
-  unsigned isa_mask;
+  unsigned isa_mask = ARC_OPCODE_NONE;
   const struct arc_opcode *opcode;
   bfd_boolean need_comma;
   bfd_boolean open_braket;
@@ -782,7 +919,7 @@ print_insn_arc (bfd_vma memaddr,
   const struct arc_operand *operand;
   int value;
   struct arc_operand_iterator iter;
-  Elf_Internal_Ehdr *header = NULL;
+  struct arc_disassemble_info *arc_infop;
 
   if (info->disassembler_options)
     {
@@ -792,38 +929,51 @@ print_insn_arc (bfd_vma memaddr,
       info->disassembler_options = NULL;
     }
 
+  if (info->private_data == NULL && !init_arc_disasm_info (info))
+    return -1;
+
   memset (&iter, 0, sizeof (iter));
   highbyte  = ((info->endian == BFD_ENDIAN_LITTLE) ? 1 : 0);
   lowbyte = ((info->endian == BFD_ENDIAN_LITTLE) ? 0 : 1);
 
-  if (info->section && info->section->owner)
-    header = elf_elfheader (info->section->owner);
-
-  switch (info->mach)
+  /* Figure out CPU type, unless it was enforced via disassembler options.  */
+  if (enforced_isa_mask == ARC_OPCODE_NONE)
     {
-    case bfd_mach_arc_arc700:
-      isa_mask = ARC_OPCODE_ARC700;
-      break;
+      Elf_Internal_Ehdr *header = NULL;
 
-    case bfd_mach_arc_arc600:
-      isa_mask = ARC_OPCODE_ARC600;
-      break;
+      if (info->section && info->section->owner)
+       header = elf_elfheader (info->section->owner);
 
-    case bfd_mach_arc_arcv2:
-    default:
-      isa_mask = ARC_OPCODE_ARCv2EM;
-      /* TODO: Perhaps remove defitinion of header since it is only used at
-         this location.  */
-      if (header != NULL
-         && (header->e_flags & EF_ARC_MACH_MSK) == EF_ARC_CPU_ARCV2HS)
+      switch (info->mach)
        {
-         isa_mask = ARC_OPCODE_ARCv2HS;
-         /* FPU instructions are not extensions for HS.  */
-         add_to_decodelist (FLOAT, SP);
-         add_to_decodelist (FLOAT, DP);
-         add_to_decodelist (FLOAT, CVT);
+       case bfd_mach_arc_arc700:
+         isa_mask = ARC_OPCODE_ARC700;
+         break;
+
+       case bfd_mach_arc_arc600:
+         isa_mask = ARC_OPCODE_ARC600;
+         break;
+
+       case bfd_mach_arc_arcv2:
+       default:
+         isa_mask = ARC_OPCODE_ARCv2EM;
+         /* TODO: Perhaps remove definition of header since it is only used at
+            this location.  */
+         if (header != NULL
+             && (header->e_flags & EF_ARC_MACH_MSK) == EF_ARC_CPU_ARCV2HS)
+           isa_mask = ARC_OPCODE_ARCv2HS;
+         break;
        }
-      break;
+    }
+  else
+    isa_mask = enforced_isa_mask;
+
+  if (isa_mask == ARC_OPCODE_ARCv2HS)
+    {
+      /* FPU instructions are not extensions for HS.  */
+      add_to_decodelist (FLOAT, SP);
+      add_to_decodelist (FLOAT, DP);
+      add_to_decodelist (FLOAT, CVT);
     }
 
   /* This variable may be set by the instruction decoder.  It suggests
@@ -899,6 +1049,8 @@ print_insn_arc (bfd_vma memaddr,
 
   insn_len = arc_insn_length (buffer[highbyte], buffer[lowbyte], info);
   pr_debug ("instruction length = %d bytes\n", insn_len);
+  arc_infop = info->private_data;
+  arc_infop->insn_len = insn_len;
 
   switch (insn_len)
     {
@@ -957,7 +1109,7 @@ print_insn_arc (bfd_vma memaddr,
   /* Set some defaults for the insn info.  */
   info->insn_info_valid    = 1;
   info->branch_delay_insns = 0;
-  info->data_size         = 0;
+  info->data_size         = 4;
   info->insn_type         = dis_nonbranch;
   info->target            = 0;
   info->target2                   = 0;
@@ -1016,6 +1168,7 @@ print_insn_arc (bfd_vma memaddr,
 
   need_comma = FALSE;
   open_braket = FALSE;
+  arc_infop->operands_count = 0;
 
   /* Now extract and print the operands.  */
   operand = NULL;
@@ -1034,14 +1187,14 @@ print_insn_arc (bfd_vma memaddr,
 
       if ((operand->flags & ARC_OPERAND_IGNORE)
          && (operand->flags & ARC_OPERAND_IR)
-          && value == -1)
+         && value == -1)
        continue;
 
       if (operand->flags & ARC_OPERAND_COLON)
-        {
-          (*info->fprintf_func) (info->stream, ":");
-          continue;
-        }
+       {
+         (*info->fprintf_func) (info->stream, ":");
+         continue;
+       }
 
       if (need_comma)
        (*info->fprintf_func) (info->stream, ",");
@@ -1106,20 +1259,33 @@ print_insn_arc (bfd_vma memaddr,
            (*info->fprintf_func) (info->stream, "%d", value);
        }
       else if (operand->flags & ARC_OPERAND_ADDRTYPE)
-        {
-          const char *addrtype = get_addrtype (value);
-          (*info->fprintf_func) (info->stream, "%s", addrtype);
-          /* A colon follow an address type.  */
-          need_comma = FALSE;
-        }
+       {
+         const char *addrtype = get_addrtype (value);
+         (*info->fprintf_func) (info->stream, "%s", addrtype);
+         /* A colon follow an address type.  */
+         need_comma = FALSE;
+       }
       else
        {
          if (operand->flags & ARC_OPERAND_TRUNCATE
              && !(operand->flags & ARC_OPERAND_ALIGNED32)
              && !(operand->flags & ARC_OPERAND_ALIGNED16)
-             && value > 0 && value <= 14)
-           (*info->fprintf_func) (info->stream, "r13-%s",
-                                  regnames[13 + value - 1]);
+             && value >= 0 && value <= 14)
+           {
+             switch (value)
+               {
+               case 0:
+                 need_comma = FALSE;
+                 break;
+               case 1:
+                 (*info->fprintf_func) (info->stream, "r13");
+                 break;
+               default:
+                 (*info->fprintf_func) (info->stream, "r13-%s",
+                                        regnames[13 + value - 1]);
+                 break;
+               }
+           }
          else
            {
              const char *rname = get_auxreg (opcode, value, isa_mask);
@@ -1129,6 +1295,24 @@ print_insn_arc (bfd_vma memaddr,
                (*info->fprintf_func) (info->stream, "%#x", value);
            }
        }
+
+      if (operand->flags & ARC_OPERAND_LIMM)
+       {
+         arc_infop->operands[arc_infop->operands_count].kind
+           = ARC_OPERAND_KIND_LIMM;
+         /* It is not important to have exactly the LIMM indicator
+            here.  */
+         arc_infop->operands[arc_infop->operands_count].value = 63;
+       }
+      else
+       {
+         arc_infop->operands[arc_infop->operands_count].value = value;
+         arc_infop->operands[arc_infop->operands_count].kind
+           = (operand->flags & ARC_OPERAND_IR
+              ? ARC_OPERAND_KIND_REG
+              : ARC_OPERAND_KIND_SHIMM);
+       }
+      arc_infop->operands_count ++;
     }
 
   return insn_len;
@@ -1152,37 +1336,23 @@ arc_get_disassembler (bfd *abfd)
   return print_insn_arc;
 }
 
-/* Disassemble ARC instructions.  Used by debugger.  */
-
-struct arcDisState
-arcAnalyzeInstr (bfd_vma memaddr,
-                struct disassemble_info *info)
-{
-  struct arcDisState ret;
-  memset (&ret, 0, sizeof (struct arcDisState));
-
-  ret.instructionLen = print_insn_arc (memaddr, info);
-
-#if 0
-  ret.words[0] = insn[0];
-  ret.words[1] = insn[1];
-  ret._this = &ret;
-  ret.coreRegName = _coreRegName;
-  ret.auxRegName = _auxRegName;
-  ret.condCodeName = _condCodeName;
-  ret.instName = _instName;
-#endif
-
-  return ret;
-}
-
 void
 print_arc_disassembler_options (FILE *stream)
 {
+  int i;
+
   fprintf (stream, _("\n\
 The following ARC specific disassembler options are supported for use \n\
 with -M switch (multiple options should be separated by commas):\n"));
 
+  /* cpu=... options.  */
+  for (i = 0; cpu_types[i].name; ++i)
+    {
+      /* As of now all value CPU values are less than 16 characters.  */
+      fprintf (stream, "  cpu=%-16s\tEnforce %s ISA.\n",
+              cpu_types[i].name, cpu_types[i].isa);
+    }
+
   fprintf (stream, _("\
   dsp             Recognize DSP instructions.\n"));
   fprintf (stream, _("\
@@ -1199,6 +1369,58 @@ with -M switch (multiple options should be separated by commas):\n"));
   fpud            Recognize double precision FPU instructions.\n"));
 }
 
+void arc_insn_decode (bfd_vma addr,
+                     struct disassemble_info *info,
+                     disassembler_ftype disasm_func,
+                     struct arc_instruction *insn)
+{
+  const struct arc_opcode *opcode;
+  struct arc_disassemble_info *arc_infop;
+
+  /* Ensure that insn would be in the reset state.  */
+  memset (insn, 0, sizeof (struct arc_instruction));
+
+  /* There was an error when disassembling, for example memory read error.  */
+  if (disasm_func (addr, info) < 0)
+    {
+      insn->valid = FALSE;
+      return;
+    }
+
+  assert (info->private_data != NULL);
+  arc_infop = info->private_data;
+
+  insn->length  = arc_infop->insn_len;;
+  insn->address = addr;
+
+  /* Quick exit if memory at this address is not an instruction.  */
+  if (info->insn_type == dis_noninsn)
+    {
+      insn->valid = FALSE;
+      return;
+    }
+
+  insn->valid = TRUE;
+
+  opcode = (const struct arc_opcode *) arc_infop->opcode;
+  insn->insn_class = opcode->insn_class;
+  insn->limm_value = arc_infop->limm;
+  insn->limm_p     = arc_infop->limm_p;
+
+  insn->is_control_flow = (info->insn_type == dis_branch
+                          || info->insn_type == dis_condbranch
+                          || info->insn_type == dis_jsr
+                          || info->insn_type == dis_condjsr);
+
+  insn->has_delay_slot = info->branch_delay_insns;
+  insn->writeback_mode
+    = (enum arc_ldst_writeback_mode) arc_infop->writeback_mode;
+  insn->data_size_mode = info->data_size;
+  insn->condition_code = arc_infop->condition_code;
+  memcpy (insn->operands, arc_infop->operands,
+         sizeof (struct arc_insn_operand) * MAX_INSN_ARGS);
+  insn->operands_count = arc_infop->operands_count;
+}
 
 /* Local variables:
    eval: (c-set-style "gnu")