/* alpha-dis.c -- Disassemble Alpha AXP instructions

   Copyright 1996, 1998, 1999, 2000, 2001 Free Software Foundation, Inc.

   Contributed by Richard Henderson <rth@tamu.edu>,

   patterned after the PPC opcode handling written by Ian Lance Taylor.

This file is part of GDB, GAS, and the GNU binutils.

GDB, GAS, and the GNU binutils are free software; you can redistribute

them and/or modify them under the terms of the GNU General Public

License as published by the Free Software Foundation; either version

2, or (at your option) any later version.

GDB, GAS, and the GNU binutils are distributed in the hope that they

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 file; see the file COPYING.  If not, write to the Free

Software Foundation, 59 Temple Place - Suite 330, Boston, MA

02111-1307, USA.  */

#include <stdio.h>

#include "dis-asm.h"

/* The opcode table is an array of struct alpha_opcode.  */

struct alpha_opcode

{

  /* The opcode name.  */

  const char *name;

  /* The opcode itself.  Those bits which will be filled in with

     operands are zeroes.  */

  unsigned opcode;

  /* The opcode mask.  This is used by the disassembler.  This is a

     mask containing ones indicating those bits which must match the

     opcode field, and zeroes indicating those bits which need not

     match (and are presumably filled in by operands).  */

  unsigned mask;

  /* One bit flags for the opcode.  These are primarily used to

     indicate specific processors and environments support the

     instructions.  The defined values are listed below. */

  unsigned flags;

  /* An array of operand codes.  Each code is an index into the

     operand table.  They appear in the order which the operands must

     appear in assembly code, and are terminated by a zero.  */

  unsigned char operands[4];

};

/* The table itself is sorted by major opcode number, and is otherwise

   in the order in which the disassembler should consider

   instructions.  */

extern const struct alpha_opcode alpha_opcodes[];

extern const unsigned alpha_num_opcodes;

/* Values defined for the flags field of a struct alpha_opcode.  */

/* CPU Availability */

#define AXP_OPCODE_BASE  0x0001  /* Base architecture -- all cpus.  */

#define AXP_OPCODE_EV4   0x0002  /* EV4 specific PALcode insns.  */

#define AXP_OPCODE_EV5   0x0004  /* EV5 specific PALcode insns.  */

#define AXP_OPCODE_EV6   0x0008  /* EV6 specific PALcode insns.  */

#define AXP_OPCODE_BWX   0x0100  /* Byte/word extension (amask bit 0).  */

#define AXP_OPCODE_CIX   0x0200  /* "Count" extension (amask bit 1).  */

#define AXP_OPCODE_MAX   0x0400  /* Multimedia extension (amask bit 8).  */

#define AXP_OPCODE_NOPAL (~(AXP_OPCODE_EV4|AXP_OPCODE_EV5|AXP_OPCODE_EV6))

/* A macro to extract the major opcode from an instruction.  */

#define AXP_OP(i)	(((i) >> 26) & 0x3F)

/* The total number of major opcodes. */

#define AXP_NOPS	0x40

/* The operands table is an array of struct alpha_operand.  */

struct alpha_operand

{

  /* The number of bits in the operand.  */

  unsigned int bits : 5;

  /* How far the operand is left shifted in the instruction.  */

  unsigned int shift : 5;

  /* The default relocation type for this operand.  */

  signed int default_reloc : 16;

  /* One bit syntax flags.  */

  unsigned int flags : 16;

  /* Insertion function.  This is used by the assembler.  To insert an

     operand value into an instruction, check this field.

     If it is NULL, execute

         i |= (op & ((1 << o->bits) - 1)) << o->shift;

     (i is the instruction which we are filling in, o is a pointer to

     this structure, and op is the opcode value; this assumes twos

     complement arithmetic).

     If this field is not NULL, then simply call it with the

     instruction and the operand value.  It will return the new value

     of the instruction.  If the ERRMSG argument is not NULL, then if

     the operand value is illegal, *ERRMSG will be set to a warning

     string (the operand will be inserted in any case).  If the

     operand value is legal, *ERRMSG will be unchanged (most operands

     can accept any value).  */

  unsigned (*insert) PARAMS ((unsigned instruction, int op,

			      const char **errmsg));

  /* Extraction function.  This is used by the disassembler.  To

     extract this operand type from an instruction, check this field.

     If it is NULL, compute

         op = ((i) >> o->shift) & ((1 << o->bits) - 1);

	 if ((o->flags & AXP_OPERAND_SIGNED) != 0

	     && (op & (1 << (o->bits - 1))) != 0)

	   op -= 1 << o->bits;

     (i is the instruction, o is a pointer to this structure, and op

     is the result; this assumes twos complement arithmetic).

     If this field is not NULL, then simply call it with the

     instruction value.  It will return the value of the operand.  If

     the INVALID argument is not NULL, *INVALID will be set to

     non-zero if this operand type can not actually be extracted from

     this operand (i.e., the instruction does not match).  If the

     operand is valid, *INVALID will not be changed.  */

  int (*extract) PARAMS ((unsigned instruction, int *invalid));

};

/* Elements in the table are retrieved by indexing with values from

   the operands field of the alpha_opcodes table.  */

extern const struct alpha_operand alpha_operands[];

extern const unsigned alpha_num_operands;

/* Values defined for the flags field of a struct alpha_operand.  */

/* Mask for selecting the type for typecheck purposes */

#define AXP_OPERAND_TYPECHECK_MASK					\

  (AXP_OPERAND_PARENS | AXP_OPERAND_COMMA | AXP_OPERAND_IR |		\

   AXP_OPERAND_FPR | AXP_OPERAND_RELATIVE | AXP_OPERAND_SIGNED | 	\

   AXP_OPERAND_UNSIGNED)

/* This operand does not actually exist in the assembler input.  This

   is used to support extended mnemonics, for which two operands fields

   are identical.  The assembler should call the insert function with

   any op value.  The disassembler should call the extract function,

   ignore the return value, and check the value placed in the invalid

   argument.  */

#define AXP_OPERAND_FAKE	01

/* The operand should be wrapped in parentheses rather than separated

   from the previous by a comma.  This is used for the load and store

   instructions which want their operands to look like "Ra,disp(Rb)".  */

#define AXP_OPERAND_PARENS	02

/* Used in combination with PARENS, this supresses the supression of

   the comma.  This is used for "jmp Ra,(Rb),hint".  */

#define AXP_OPERAND_COMMA	04

/* This operand names an integer register.  */

#define AXP_OPERAND_IR		010

/* This operand names a floating point register.  */

#define AXP_OPERAND_FPR		020

/* This operand is a relative branch displacement.  The disassembler

   prints these symbolically if possible.  */

#define AXP_OPERAND_RELATIVE	040

/* This operand takes signed values.  */

#define AXP_OPERAND_SIGNED	0100

/* This operand takes unsigned values.  This exists primarily so that

   a flags value of 0 can be treated as end-of-arguments.  */

#define AXP_OPERAND_UNSIGNED	0200

/* Supress overflow detection on this field.  This is used for hints. */

#define AXP_OPERAND_NOOVERFLOW	0400

/* Mask for optional argument default value.  */

#define AXP_OPERAND_OPTIONAL_MASK 07000

/* This operand defaults to zero.  This is used for jump hints.  */

#define AXP_OPERAND_DEFAULT_ZERO 01000

/* This operand should default to the first (real) operand and is used

   in conjunction with AXP_OPERAND_OPTIONAL.  This allows

   "and $0,3,$0" to be written as "and $0,3", etc.  I don't like

   it, but it's what DEC does.  */

#define AXP_OPERAND_DEFAULT_FIRST 02000

/* Similarly, this operand should default to the second (real) operand.

   This allows "negl $0" instead of "negl $0,$0".  */

#define AXP_OPERAND_DEFAULT_SECOND 04000

/* Register common names */

#define AXP_REG_V0	0

#define AXP_REG_T0	1

#define AXP_REG_T1	2

#define AXP_REG_T2	3

#define AXP_REG_T3	4

#define AXP_REG_T4	5

#define AXP_REG_T5	6

#define AXP_REG_T6	7

#define AXP_REG_T7	8

#define AXP_REG_S0	9

#define AXP_REG_S1	10

#define AXP_REG_S2	11

#define AXP_REG_S3	12

#define AXP_REG_S4	13

#define AXP_REG_S5	14

#define AXP_REG_FP	15

#define AXP_REG_A0	16

#define AXP_REG_A1	17

#define AXP_REG_A2	18

#define AXP_REG_A3	19

#define AXP_REG_A4	20

#define AXP_REG_A5	21

#define AXP_REG_T8	22

#define AXP_REG_T9	23

#define AXP_REG_T10	24

#define AXP_REG_T11	25

#define AXP_REG_RA	26

#define AXP_REG_PV	27

#define AXP_REG_T12	27

#define AXP_REG_AT	28

#define AXP_REG_GP	29

#define AXP_REG_SP	30

#define AXP_REG_ZERO	31

#define bfd_mach_alpha_ev4  0x10

#define bfd_mach_alpha_ev5  0x20

#define bfd_mach_alpha_ev6  0x30

enum bfd_reloc_code_real {

    BFD_RELOC_23_PCREL_S2,

    BFD_RELOC_ALPHA_HINT

};

/* This file holds the Alpha AXP opcode table.  The opcode table includes

   almost all of the extended instruction mnemonics.  This permits the

   disassembler to use them, and simplifies the assembler logic, at the

   cost of increasing the table size.  The table is strictly constant

   data, so the compiler should be able to put it in the text segment.

   This file also holds the operand table.  All knowledge about inserting

   and extracting operands from instructions is kept in this file.

   The information for the base instruction set was compiled from the

   _Alpha Architecture Handbook_, Digital Order Number EC-QD2KB-TE,

   version 2.

   The information for the post-ev5 architecture extensions BWX, CIX and

   MAX came from version 3 of this same document, which is also available

   on-line at http://ftp.digital.com/pub/Digital/info/semiconductor

   /literature/alphahb2.pdf

   The information for the EV4 PALcode instructions was compiled from

   _DECchip 21064 and DECchip 21064A Alpha AXP Microprocessors Hardware

   Reference Manual_, Digital Order Number EC-Q9ZUA-TE, preliminary

   revision dated June 1994.

   The information for the EV5 PALcode instructions was compiled from

   _Alpha 21164 Microprocessor Hardware Reference Manual_, Digital

   Order Number EC-QAEQB-TE, preliminary revision dated April 1995.  */

/* Local insertion and extraction functions */

static unsigned insert_rba PARAMS((unsigned, int, const char **));

static unsigned insert_rca PARAMS((unsigned, int, const char **));

static unsigned insert_za PARAMS((unsigned, int, const char **));

static unsigned insert_zb PARAMS((unsigned, int, const char **));

static unsigned insert_zc PARAMS((unsigned, int, const char **));

static unsigned insert_bdisp PARAMS((unsigned, int, const char **));

static unsigned insert_jhint PARAMS((unsigned, int, const char **));

static unsigned insert_ev6hwjhint PARAMS((unsigned, int, const char **));

static int extract_rba PARAMS((unsigned, int *));

static int extract_rca PARAMS((unsigned, int *));

static int extract_za PARAMS((unsigned, int *));

static int extract_zb PARAMS((unsigned, int *));

static int extract_zc PARAMS((unsigned, int *));

static int extract_bdisp PARAMS((unsigned, int *));

static int extract_jhint PARAMS((unsigned, int *));

static int extract_ev6hwjhint PARAMS((unsigned, int *));

/* The operands table  */

const struct alpha_operand alpha_operands[] =

{

  /* The fields are bits, shift, insert, extract, flags */

  /* The zero index is used to indicate end-of-list */

#define UNUSED		0

  { 0, 0, 0, 0, 0, 0 },

  /* The plain integer register fields */

#define RA		(UNUSED + 1)

  { 5, 21, 0, AXP_OPERAND_IR, 0, 0 },

#define RB		(RA + 1)

  { 5, 16, 0, AXP_OPERAND_IR, 0, 0 },

#define RC		(RB + 1)

  { 5, 0, 0, AXP_OPERAND_IR, 0, 0 },

  /* The plain fp register fields */

#define FA		(RC + 1)

  { 5, 21, 0, AXP_OPERAND_FPR, 0, 0 },

#define FB		(FA + 1)

  { 5, 16, 0, AXP_OPERAND_FPR, 0, 0 },

#define FC		(FB + 1)

  { 5, 0, 0, AXP_OPERAND_FPR, 0, 0 },

  /* The integer registers when they are ZERO */

#define ZA		(FC + 1)

  { 5, 21, 0, AXP_OPERAND_FAKE, insert_za, extract_za },

#define ZB		(ZA + 1)

  { 5, 16, 0, AXP_OPERAND_FAKE, insert_zb, extract_zb },

#define ZC		(ZB + 1)

  { 5, 0, 0, AXP_OPERAND_FAKE, insert_zc, extract_zc },

  /* The RB field when it needs parentheses */

#define PRB		(ZC + 1)

  { 5, 16, 0, AXP_OPERAND_IR|AXP_OPERAND_PARENS, 0, 0 },

  /* The RB field when it needs parentheses _and_ a preceding comma */

#define CPRB		(PRB + 1)

  { 5, 16, 0,

    AXP_OPERAND_IR|AXP_OPERAND_PARENS|AXP_OPERAND_COMMA, 0, 0 },

  /* The RB field when it must be the same as the RA field */

#define RBA		(CPRB + 1)

  { 5, 16, 0, AXP_OPERAND_FAKE, insert_rba, extract_rba },

  /* The RC field when it must be the same as the RB field */

#define RCA		(RBA + 1)

  { 5, 0, 0, AXP_OPERAND_FAKE, insert_rca, extract_rca },

  /* The RC field when it can *default* to RA */

#define DRC1		(RCA + 1)

  { 5, 0, 0,

    AXP_OPERAND_IR|AXP_OPERAND_DEFAULT_FIRST, 0, 0 },

  /* The RC field when it can *default* to RB */

#define DRC2		(DRC1 + 1)

  { 5, 0, 0,

    AXP_OPERAND_IR|AXP_OPERAND_DEFAULT_SECOND, 0, 0 },

  /* The FC field when it can *default* to RA */

#define DFC1		(DRC2 + 1)

  { 5, 0, 0,

    AXP_OPERAND_FPR|AXP_OPERAND_DEFAULT_FIRST, 0, 0 },

  /* The FC field when it can *default* to RB */

#define DFC2		(DFC1 + 1)

  { 5, 0, 0,

    AXP_OPERAND_FPR|AXP_OPERAND_DEFAULT_SECOND, 0, 0 },

  /* The unsigned 8-bit literal of Operate format insns */

#define LIT		(DFC2 + 1)

  { 8, 13, -LIT, AXP_OPERAND_UNSIGNED, 0, 0 },

  /* The signed 16-bit displacement of Memory format insns.  From here

     we can't tell what relocation should be used, so don't use a default. */

#define MDISP		(LIT + 1)

  { 16, 0, -MDISP, AXP_OPERAND_SIGNED, 0, 0 },

  /* The signed "23-bit" aligned displacement of Branch format insns */

#define BDISP		(MDISP + 1)

  { 21, 0, BFD_RELOC_23_PCREL_S2,

    AXP_OPERAND_RELATIVE, insert_bdisp, extract_bdisp },

  /* The 26-bit PALcode function */

#define PALFN		(BDISP + 1)

  { 26, 0, -PALFN, AXP_OPERAND_UNSIGNED, 0, 0 },

  /* The optional signed "16-bit" aligned displacement of the JMP/JSR hint */

#define JMPHINT		(PALFN + 1)

  { 14, 0, BFD_RELOC_ALPHA_HINT,

    AXP_OPERAND_RELATIVE|AXP_OPERAND_DEFAULT_ZERO|AXP_OPERAND_NOOVERFLOW,

    insert_jhint, extract_jhint },

  /* The optional hint to RET/JSR_COROUTINE */

#define RETHINT		(JMPHINT + 1)

  { 14, 0, -RETHINT,

    AXP_OPERAND_UNSIGNED|AXP_OPERAND_DEFAULT_ZERO, 0, 0 },

  /* The 12-bit displacement for the ev[46] hw_{ld,st} (pal1b/pal1f) insns */

#define EV4HWDISP	(RETHINT + 1)

#define EV6HWDISP	(EV4HWDISP)

  { 12, 0, -EV4HWDISP, AXP_OPERAND_SIGNED, 0, 0 },

  /* The 5-bit index for the ev4 hw_m[ft]pr (pal19/pal1d) insns */

#define EV4HWINDEX	(EV4HWDISP + 1)

  { 5, 0, -EV4HWINDEX, AXP_OPERAND_UNSIGNED, 0, 0 },

  /* The 8-bit index for the oddly unqualified hw_m[tf]pr insns

     that occur in DEC PALcode.  */

#define EV4EXTHWINDEX	(EV4HWINDEX + 1)

  { 8, 0, -EV4EXTHWINDEX, AXP_OPERAND_UNSIGNED, 0, 0 },

  /* The 10-bit displacement for the ev5 hw_{ld,st} (pal1b/pal1f) insns */

#define EV5HWDISP	(EV4EXTHWINDEX + 1)

  { 10, 0, -EV5HWDISP, AXP_OPERAND_SIGNED, 0, 0 },

  /* The 16-bit index for the ev5 hw_m[ft]pr (pal19/pal1d) insns */

#define EV5HWINDEX	(EV5HWDISP + 1)

  { 16, 0, -EV5HWINDEX, AXP_OPERAND_UNSIGNED, 0, 0 },

  /* The 16-bit combined index/scoreboard mask for the ev6

     hw_m[ft]pr (pal19/pal1d) insns */

#define EV6HWINDEX	(EV5HWINDEX + 1)

  { 16, 0, -EV6HWINDEX, AXP_OPERAND_UNSIGNED, 0, 0 },

  /* The 13-bit branch hint for the ev6 hw_jmp/jsr (pal1e) insn */

#define EV6HWJMPHINT	(EV6HWINDEX+ 1)

  { 8, 0, -EV6HWJMPHINT,

    AXP_OPERAND_RELATIVE|AXP_OPERAND_DEFAULT_ZERO|AXP_OPERAND_NOOVERFLOW,

    insert_ev6hwjhint, extract_ev6hwjhint }

};

const unsigned alpha_num_operands = sizeof(alpha_operands)/sizeof(*alpha_operands);

/* The RB field when it is the same as the RA field in the same insn.

   This operand is marked fake.  The insertion function just copies

   the RA field into the RB field, and the extraction function just

   checks that the fields are the same. */

/*ARGSUSED*/

static unsigned

insert_rba(insn, value, errmsg)

     unsigned insn;

     int value ATTRIBUTE_UNUSED;

     const char **errmsg ATTRIBUTE_UNUSED;

{

  return insn | (((insn >> 21) & 0x1f) << 16);

}

static int

extract_rba(insn, invalid)

     unsigned insn;

     int *invalid;

{

  if (invalid != (int *) NULL

      && ((insn >> 21) & 0x1f) != ((insn >> 16) & 0x1f))

    *invalid = 1;

  return 0;

}

/* The same for the RC field */

/*ARGSUSED*/

static unsigned

insert_rca(insn, value, errmsg)

     unsigned insn;

     int value ATTRIBUTE_UNUSED;

     const char **errmsg ATTRIBUTE_UNUSED;

{

  return insn | ((insn >> 21) & 0x1f);

}

static int

extract_rca(insn, invalid)

     unsigned insn;

     int *invalid;

{

  if (invalid != (int *) NULL

      && ((insn >> 21) & 0x1f) != (insn & 0x1f))

    *invalid = 1;

  return 0;

}

/* Fake arguments in which the registers must be set to ZERO */

/*ARGSUSED*/

static unsigned

insert_za(insn, value, errmsg)

     unsigned insn;

     int value ATTRIBUTE_UNUSED;

     const char **errmsg ATTRIBUTE_UNUSED;

{

  return insn | (31 << 21);

}

static int

extract_za(insn, invalid)

     unsigned insn;

     int *invalid;

{

  if (invalid != (int *) NULL && ((insn >> 21) & 0x1f) != 31)

    *invalid = 1;

  return 0;

}

/*ARGSUSED*/

static unsigned

insert_zb(insn, value, errmsg)

     unsigned insn;

     int value ATTRIBUTE_UNUSED;

     const char **errmsg ATTRIBUTE_UNUSED;

{

  return insn | (31 << 16);

}

static int

extract_zb(insn, invalid)

     unsigned insn;

     int *invalid;

{

  if (invalid != (int *) NULL && ((insn >> 16) & 0x1f) != 31)

    *invalid = 1;

  return 0;

}

/*ARGSUSED*/

static unsigned

insert_zc(insn, value, errmsg)

     unsigned insn;

     int value ATTRIBUTE_UNUSED;

     const char **errmsg ATTRIBUTE_UNUSED;