include/opcode/aarch64.h

   1 /* AArch64 assembler/disassembler support.
   2
   3    Copyright 2009, 2010, 2011, 2012, 2013  Free Software Foundation, Inc.
   4    Contributed by ARM Ltd.
   5
   6    This file is part of GNU Binutils.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the license, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; see the file COPYING3. If not,
  20    see <http://www.gnu.org/licenses/>.  */
  21
  22 #ifndef OPCODE_AARCH64_H
  23 #define OPCODE_AARCH64_H
  24
  25 #include "bfd.h"
  26 #include "bfd_stdint.h"
  27 #include <assert.h>
  28 #include <stdlib.h>
  29
  30 /* The offset for pc-relative addressing is currently defined to be 0.  */
  31 #define AARCH64_PCREL_OFFSET            0
  32
  33 typedef uint32_t aarch64_insn;
  34
  35 /* The following bitmasks control CPU features.  */
  36 #define AARCH64_FEATURE_V8      0x00000001      /* All processors.  */
  37 #define AARCH64_FEATURE_CRYPTO  0x00010000      /* Crypto instructions.  */
  38 #define AARCH64_FEATURE_FP      0x00020000      /* FP instructions.  */
  39 #define AARCH64_FEATURE_SIMD    0x00040000      /* SIMD instructions.  */
  40
  41 /* Architectures are the sum of the base and extensions.  */
  42 #define AARCH64_ARCH_V8         AARCH64_FEATURE (AARCH64_FEATURE_V8, \
  43                                                  AARCH64_FEATURE_FP  \
  44                                                  | AARCH64_FEATURE_SIMD)
  45 #define AARCH64_ARCH_NONE       AARCH64_FEATURE (0, 0)
  46 #define AARCH64_ANY             AARCH64_FEATURE (-1, 0) /* Any basic core.  */
  47
  48 /* CPU-specific features.  */
  49 typedef unsigned long aarch64_feature_set;
  50
  51 #define AARCH64_CPU_HAS_FEATURE(CPU,FEAT)       \
  52   (((CPU) & (FEAT)) != 0)
  53
  54 #define AARCH64_MERGE_FEATURE_SETS(TARG,F1,F2)  \
  55   do                                            \
  56     {                                           \
  57       (TARG) = (F1) | (F2);                     \
  58     }                                           \
  59   while (0)
  60
  61 #define AARCH64_CLEAR_FEATURE(TARG,F1,F2)       \
  62   do                                            \
  63     {                                           \
  64       (TARG) = (F1) &~ (F2);                    \
  65     }                                           \
  66   while (0)
  67
  68 #define AARCH64_FEATURE(core,coproc) ((core) | (coproc))
  69
  70 #define AARCH64_OPCODE_HAS_FEATURE(OPC,FEAT)    \
  71   (((OPC) & (FEAT)) != 0)
  72
  73 enum aarch64_operand_class
  74 {
  75   AARCH64_OPND_CLASS_NIL,
  76   AARCH64_OPND_CLASS_INT_REG,
  77   AARCH64_OPND_CLASS_MODIFIED_REG,
  78   AARCH64_OPND_CLASS_FP_REG,
  79   AARCH64_OPND_CLASS_SIMD_REG,
  80   AARCH64_OPND_CLASS_SIMD_ELEMENT,
  81   AARCH64_OPND_CLASS_SISD_REG,
  82   AARCH64_OPND_CLASS_SIMD_REGLIST,
  83   AARCH64_OPND_CLASS_CP_REG,
  84   AARCH64_OPND_CLASS_ADDRESS,
  85   AARCH64_OPND_CLASS_IMMEDIATE,
  86   AARCH64_OPND_CLASS_SYSTEM,
  87 };
  88
  89 /* Operand code that helps both parsing and coding.
  90    Keep AARCH64_OPERANDS synced.  */
  91
  92 enum aarch64_opnd
  93 {
  94   AARCH64_OPND_NIL,     /* no operand---MUST BE FIRST!*/
  95
  96   AARCH64_OPND_Rd,      /* Integer register as destination.  */
  97   AARCH64_OPND_Rn,      /* Integer register as source.  */
  98   AARCH64_OPND_Rm,      /* Integer register as source.  */
  99   AARCH64_OPND_Rt,      /* Integer register used in ld/st instructions.  */
 100   AARCH64_OPND_Rt2,     /* Integer register used in ld/st pair instructions.  */
 101   AARCH64_OPND_Rs,      /* Integer register used in ld/st exclusive.  */
 102   AARCH64_OPND_Ra,      /* Integer register used in ddp_3src instructions.  */
 103   AARCH64_OPND_Rt_SYS,  /* Integer register used in system instructions.  */
 104
 105   AARCH64_OPND_Rd_SP,   /* Integer Rd or SP.  */
 106   AARCH64_OPND_Rn_SP,   /* Integer Rn or SP.  */
 107   AARCH64_OPND_Rm_EXT,  /* Integer Rm extended.  */
 108   AARCH64_OPND_Rm_SFT,  /* Integer Rm shifted.  */
 109
 110   AARCH64_OPND_Fd,      /* Floating-point Fd.  */
 111   AARCH64_OPND_Fn,      /* Floating-point Fn.  */
 112   AARCH64_OPND_Fm,      /* Floating-point Fm.  */
 113   AARCH64_OPND_Fa,      /* Floating-point Fa.  */
 114   AARCH64_OPND_Ft,      /* Floating-point Ft.  */
 115   AARCH64_OPND_Ft2,     /* Floating-point Ft2.  */
 116
 117   AARCH64_OPND_Sd,      /* AdvSIMD Scalar Sd.  */
 118   AARCH64_OPND_Sn,      /* AdvSIMD Scalar Sn.  */
 119   AARCH64_OPND_Sm,      /* AdvSIMD Scalar Sm.  */
 120
 121   AARCH64_OPND_Vd,      /* AdvSIMD Vector Vd.  */
 122   AARCH64_OPND_Vn,      /* AdvSIMD Vector Vn.  */
 123   AARCH64_OPND_Vm,      /* AdvSIMD Vector Vm.  */
 124   AARCH64_OPND_VdD1,    /* AdvSIMD <Vd>.D[1]; for FMOV only.  */
 125   AARCH64_OPND_VnD1,    /* AdvSIMD <Vn>.D[1]; for FMOV only.  */
 126   AARCH64_OPND_Ed,      /* AdvSIMD Vector Element Vd.  */
 127   AARCH64_OPND_En,      /* AdvSIMD Vector Element Vn.  */
 128   AARCH64_OPND_Em,      /* AdvSIMD Vector Element Vm.  */
 129   AARCH64_OPND_LVn,     /* AdvSIMD Vector register list used in e.g. TBL.  */
 130   AARCH64_OPND_LVt,     /* AdvSIMD Vector register list used in ld/st.  */
 131   AARCH64_OPND_LVt_AL,  /* AdvSIMD Vector register list for loading single
 132                            structure to all lanes.  */
 133   AARCH64_OPND_LEt,     /* AdvSIMD Vector Element list.  */
 134
 135   AARCH64_OPND_Cn,      /* Co-processor register in CRn field.  */
 136   AARCH64_OPND_Cm,      /* Co-processor register in CRm field.  */
 137
 138   AARCH64_OPND_IDX,     /* AdvSIMD EXT index operand.  */
 139   AARCH64_OPND_IMM_VLSL,/* Immediate for shifting vector registers left.  */
 140   AARCH64_OPND_IMM_VLSR,/* Immediate for shifting vector registers right.  */
 141   AARCH64_OPND_SIMD_IMM,/* AdvSIMD modified immediate without shift.  */
 142   AARCH64_OPND_SIMD_IMM_SFT,    /* AdvSIMD modified immediate with shift.  */
 143   AARCH64_OPND_SIMD_FPIMM,/* AdvSIMD 8-bit fp immediate.  */
 144   AARCH64_OPND_SHLL_IMM,/* Immediate shift for AdvSIMD SHLL instruction
 145                            (no encoding).  */
 146   AARCH64_OPND_IMM0,    /* Immediate for #0.  */
 147   AARCH64_OPND_FPIMM0,  /* Immediate for #0.0.  */
 148   AARCH64_OPND_FPIMM,   /* Floating-point Immediate.  */
 149   AARCH64_OPND_IMMR,    /* Immediate #<immr> in e.g. BFM.  */
 150   AARCH64_OPND_IMMS,    /* Immediate #<imms> in e.g. BFM.  */
 151   AARCH64_OPND_WIDTH,   /* Immediate #<width> in e.g. BFI.  */
 152   AARCH64_OPND_IMM,     /* Immediate.  */
 153   AARCH64_OPND_UIMM3_OP1,/* Unsigned 3-bit immediate in the op1 field.  */
 154   AARCH64_OPND_UIMM3_OP2,/* Unsigned 3-bit immediate in the op2 field.  */
 155   AARCH64_OPND_UIMM4,   /* Unsigned 4-bit immediate in the CRm field.  */
 156   AARCH64_OPND_UIMM7,   /* Unsigned 7-bit immediate in the CRm:op2 fields.  */
 157   AARCH64_OPND_BIT_NUM, /* Immediate.  */
 158   AARCH64_OPND_EXCEPTION,/* imm16 operand in exception instructions.  */
 159   AARCH64_OPND_CCMP_IMM,/* Immediate in conditional compare instructions.  */
 160   AARCH64_OPND_NZCV,    /* Flag bit specifier giving an alternative value for
 161                            each condition flag.  */
 162
 163   AARCH64_OPND_LIMM,    /* Logical Immediate.  */
 164   AARCH64_OPND_AIMM,    /* Arithmetic immediate.  */
 165   AARCH64_OPND_HALF,    /* #<imm16>{, LSL #<shift>} operand in move wide.  */
 166   AARCH64_OPND_FBITS,   /* FP #<fbits> operand in e.g. SCVTF */
 167   AARCH64_OPND_IMM_MOV, /* Immediate operand for the MOV alias.  */
 168
 169   AARCH64_OPND_COND,    /* Standard condition as the last operand.  */
 170
 171   AARCH64_OPND_ADDR_ADRP,       /* Memory address for ADRP */
 172   AARCH64_OPND_ADDR_PCREL14,    /* 14-bit PC-relative address for e.g. TBZ.  */
 173   AARCH64_OPND_ADDR_PCREL19,    /* 19-bit PC-relative address for e.g. LDR.  */
 174   AARCH64_OPND_ADDR_PCREL21,    /* 21-bit PC-relative address for e.g. ADR.  */
 175   AARCH64_OPND_ADDR_PCREL26,    /* 26-bit PC-relative address for e.g. BL.  */
 176
 177   AARCH64_OPND_ADDR_SIMPLE,     /* Address of ld/st exclusive.  */
 178   AARCH64_OPND_ADDR_REGOFF,     /* Address of register offset.  */
 179   AARCH64_OPND_ADDR_SIMM7,      /* Address of signed 7-bit immediate.  */
 180   AARCH64_OPND_ADDR_SIMM9,      /* Address of signed 9-bit immediate.  */
 181   AARCH64_OPND_ADDR_SIMM9_2,    /* Same as the above, but the immediate is
 182                                    negative or unaligned and there is
 183                                    no writeback allowed.  This operand code
 184                                    is only used to support the programmer-
 185                                    friendly feature of using LDR/STR as the
 186                                    the mnemonic name for LDUR/STUR instructions
 187                                    wherever there is no ambiguity.  */
 188   AARCH64_OPND_ADDR_UIMM12,     /* Address of unsigned 12-bit immediate.  */
 189   AARCH64_OPND_SIMD_ADDR_SIMPLE,/* Address of ld/st multiple structures.  */
 190   AARCH64_OPND_SIMD_ADDR_POST,  /* Address of ld/st multiple post-indexed.  */
 191
 192   AARCH64_OPND_SYSREG,          /* System register operand.  */
 193   AARCH64_OPND_PSTATEFIELD,     /* PSTATE field name operand.  */
 194   AARCH64_OPND_SYSREG_AT,       /* System register <at_op> operand.  */
 195   AARCH64_OPND_SYSREG_DC,       /* System register <dc_op> operand.  */
 196   AARCH64_OPND_SYSREG_IC,       /* System register <ic_op> operand.  */
 197   AARCH64_OPND_SYSREG_TLBI,     /* System register <tlbi_op> operand.  */
 198   AARCH64_OPND_BARRIER,         /* Barrier operand.  */
 199   AARCH64_OPND_BARRIER_ISB,     /* Barrier operand for ISB.  */
 200   AARCH64_OPND_PRFOP,           /* Prefetch operation.  */
 201 };
 202
 203 /* Qualifier constrains an operand.  It either specifies a variant of an
 204    operand type or limits values available to an operand type.
 205
 206    N.B. Order is important; keep aarch64_opnd_qualifiers synced.  */
 207
 208 enum aarch64_opnd_qualifier
 209 {
 210   /* Indicating no further qualification on an operand.  */
 211   AARCH64_OPND_QLF_NIL,
 212
 213   /* Qualifying an operand which is a general purpose (integer) register;
 214      indicating the operand data size or a specific register.  */
 215   AARCH64_OPND_QLF_W,   /* Wn, WZR or WSP.  */
 216   AARCH64_OPND_QLF_X,   /* Xn, XZR or XSP.  */
 217   AARCH64_OPND_QLF_WSP, /* WSP.  */
 218   AARCH64_OPND_QLF_SP,  /* SP.  */
 219
 220   /* Qualifying an operand which is a floating-point register, a SIMD
 221      vector element or a SIMD vector element list; indicating operand data
 222      size or the size of each SIMD vector element in the case of a SIMD
 223      vector element list.
 224      These qualifiers are also used to qualify an address operand to
 225      indicate the size of data element a load/store instruction is
 226      accessing.
 227      They are also used for the immediate shift operand in e.g. SSHR.  Such
 228      a use is only for the ease of operand encoding/decoding and qualifier
 229      sequence matching; such a use should not be applied widely; use the value
 230      constraint qualifiers for immediate operands wherever possible.  */
 231   AARCH64_OPND_QLF_S_B,
 232   AARCH64_OPND_QLF_S_H,
 233   AARCH64_OPND_QLF_S_S,
 234   AARCH64_OPND_QLF_S_D,
 235   AARCH64_OPND_QLF_S_Q,
 236
 237   /* Qualifying an operand which is a SIMD vector register or a SIMD vector
 238      register list; indicating register shape.
 239      They are also used for the immediate shift operand in e.g. SSHR.  Such
 240      a use is only for the ease of operand encoding/decoding and qualifier
 241      sequence matching; such a use should not be applied widely; use the value
 242      constraint qualifiers for immediate operands wherever possible.  */
 243   AARCH64_OPND_QLF_V_8B,
 244   AARCH64_OPND_QLF_V_16B,
 245   AARCH64_OPND_QLF_V_4H,
 246   AARCH64_OPND_QLF_V_8H,
 247   AARCH64_OPND_QLF_V_2S,
 248   AARCH64_OPND_QLF_V_4S,
 249   AARCH64_OPND_QLF_V_1D,
 250   AARCH64_OPND_QLF_V_2D,
 251   AARCH64_OPND_QLF_V_1Q,
 252
 253   /* Constraint on value.  */
 254   AARCH64_OPND_QLF_imm_0_7,
 255   AARCH64_OPND_QLF_imm_0_15,
 256   AARCH64_OPND_QLF_imm_0_31,
 257   AARCH64_OPND_QLF_imm_0_63,
 258   AARCH64_OPND_QLF_imm_1_32,
 259   AARCH64_OPND_QLF_imm_1_64,
 260
 261   /* Indicate whether an AdvSIMD modified immediate operand is shift-zeros
 262      or shift-ones.  */
 263   AARCH64_OPND_QLF_LSL,
 264   AARCH64_OPND_QLF_MSL,
 265
 266   /* Special qualifier helping retrieve qualifier information during the
 267      decoding time (currently not in use).  */
 268   AARCH64_OPND_QLF_RETRIEVE,
 269 };
 270 \f
 271 /* Instruction class.  */
 272
 273 enum aarch64_insn_class
 274 {
 275   addsub_carry,
 276   addsub_ext,
 277   addsub_imm,
 278   addsub_shift,
 279   asimdall,
 280   asimddiff,
 281   asimdelem,
 282   asimdext,
 283   asimdimm,
 284   asimdins,
 285   asimdmisc,
 286   asimdperm,
 287   asimdsame,
 288   asimdshf,
 289   asimdtbl,
 290   asisddiff,
 291   asisdelem,
 292   asisdlse,
 293   asisdlsep,
 294   asisdlso,
 295   asisdlsop,
 296   asisdmisc,
 297   asisdone,
 298   asisdpair,
 299   asisdsame,
 300   asisdshf,
 301   bitfield,
 302   branch_imm,
 303   branch_reg,
 304   compbranch,
 305   condbranch,
 306   condcmp_imm,
 307   condcmp_reg,
 308   condsel,
 309   cryptoaes,
 310   cryptosha2,
 311   cryptosha3,
 312   dp_1src,
 313   dp_2src,
 314   dp_3src,
 315   exception,
 316   extract,
 317   float2fix,
 318   float2int,
 319   floatccmp,
 320   floatcmp,
 321   floatdp1,
 322   floatdp2,
 323   floatdp3,
 324   floatimm,
 325   floatsel,
 326   ldst_immpost,
 327   ldst_immpre,
 328   ldst_imm9,    /* immpost or immpre */
 329   ldst_pos,
 330   ldst_regoff,
 331   ldst_unpriv,
 332   ldst_unscaled,
 333   ldstexcl,
 334   ldstnapair_offs,
 335   ldstpair_off,
 336   ldstpair_indexed,
 337   loadlit,
 338   log_imm,
 339   log_shift,
 340   movewide,
 341   pcreladdr,
 342   ic_system,
 343   testbranch,
 344 };
 345
 346 /* Opcode enumerators.  */
 347
 348 enum aarch64_op
 349 {
 350   OP_NIL,
 351   OP_STRB_POS,
 352   OP_LDRB_POS,
 353   OP_LDRSB_POS,
 354   OP_STRH_POS,
 355   OP_LDRH_POS,
 356   OP_LDRSH_POS,
 357   OP_STR_POS,
 358   OP_LDR_POS,
 359   OP_STRF_POS,
 360   OP_LDRF_POS,
 361   OP_LDRSW_POS,
 362   OP_PRFM_POS,
 363
 364   OP_STURB,
 365   OP_LDURB,
 366   OP_LDURSB,
 367   OP_STURH,
 368   OP_LDURH,
 369   OP_LDURSH,
 370   OP_STUR,
 371   OP_LDUR,
 372   OP_STURV,
 373   OP_LDURV,
 374   OP_LDURSW,
 375   OP_PRFUM,
 376
 377   OP_LDR_LIT,
 378   OP_LDRV_LIT,
 379   OP_LDRSW_LIT,
 380   OP_PRFM_LIT,
 381
 382   OP_ADD,
 383   OP_B,
 384   OP_BL,
 385
 386   OP_MOVN,
 387   OP_MOVZ,
 388   OP_MOVK,
 389
 390   OP_MOV_IMM_LOG,       /* MOV alias for moving bitmask immediate.  */
 391   OP_MOV_IMM_WIDE,      /* MOV alias for moving wide immediate.  */
 392   OP_MOV_IMM_WIDEN,     /* MOV alias for moving wide immediate (negated).  */
 393
 394   OP_MOV_V,             /* MOV alias for moving vector register.  */
 395
 396   OP_ASR_IMM,
 397   OP_LSR_IMM,
 398   OP_LSL_IMM,
 399
 400   OP_BIC,
 401
 402   OP_UBFX,
 403   OP_BFXIL,
 404   OP_SBFX,
 405   OP_SBFIZ,
 406   OP_BFI,
 407   OP_UBFIZ,
 408   OP_UXTB,
 409   OP_UXTH,
 410   OP_UXTW,
 411
 412   OP_CINC,
 413   OP_CINV,
 414   OP_CNEG,
 415   OP_CSET,
 416   OP_CSETM,
 417
 418   OP_FCVT,
 419   OP_FCVTN,
 420   OP_FCVTN2,
 421   OP_FCVTL,
 422   OP_FCVTL2,
 423   OP_FCVTXN_S,          /* Scalar version.  */
 424
 425   OP_ROR_IMM,
 426
 427   OP_SXTL,
 428   OP_SXTL2,
 429   OP_UXTL,
 430   OP_UXTL2,
 431
 432   OP_TOTAL_NUM,         /* Pseudo.  */
 433 };
 434
 435 /* Maximum number of operands an instruction can have.  */
 436 #define AARCH64_MAX_OPND_NUM 6
 437 /* Maximum number of qualifier sequences an instruction can have.  */
 438 #define AARCH64_MAX_QLF_SEQ_NUM 10
 439 /* Operand qualifier typedef; optimized for the size.  */
 440 typedef unsigned char aarch64_opnd_qualifier_t;
 441 /* Operand qualifier sequence typedef.  */
 442 typedef aarch64_opnd_qualifier_t        \
 443           aarch64_opnd_qualifier_seq_t [AARCH64_MAX_OPND_NUM];
 444
 445 /* FIXME: improve the efficiency.  */
 446 static inline bfd_boolean
 447 empty_qualifier_sequence_p (const aarch64_opnd_qualifier_t *qualifiers)
 448 {
 449   int i;
 450   for (i = 0; i < AARCH64_MAX_OPND_NUM; ++i)
 451     if (qualifiers[i] != AARCH64_OPND_QLF_NIL)
 452       return FALSE;
 453   return TRUE;
 454 }
 455
 456 /* This structure holds information for a particular opcode.  */
 457
 458 struct aarch64_opcode
 459 {
 460   /* The name of the mnemonic.  */
 461   const char *name;
 462
 463   /* The opcode itself.  Those bits which will be filled in with
 464      operands are zeroes.  */
 465   aarch64_insn opcode;
 466
 467   /* The opcode mask.  This is used by the disassembler.  This is a
 468      mask containing ones indicating those bits which must match the
 469      opcode field, and zeroes indicating those bits which need not
 470      match (and are presumably filled in by operands).  */
 471   aarch64_insn mask;
 472
 473   /* Instruction class.  */
 474   enum aarch64_insn_class iclass;
 475
 476   /* Enumerator identifier.  */
 477   enum aarch64_op op;
 478
 479   /* Which architecture variant provides this instruction.  */
 480   const aarch64_feature_set *avariant;
 481
 482   /* An array of operand codes.  Each code is an index into the
 483      operand table.  They appear in the order which the operands must
 484      appear in assembly code, and are terminated by a zero.  */
 485   enum aarch64_opnd operands[AARCH64_MAX_OPND_NUM];
 486
 487   /* A list of operand qualifier code sequence.  Each operand qualifier
 488      code qualifies the corresponding operand code.  Each operand
 489      qualifier sequence specifies a valid opcode variant and related
 490      constraint on operands.  */
 491   aarch64_opnd_qualifier_seq_t qualifiers_list[AARCH64_MAX_QLF_SEQ_NUM];
 492
 493   /* Flags providing information about this instruction */
 494   uint32_t flags;
 495 };
 496
 497 typedef struct aarch64_opcode aarch64_opcode;
 498
 499 /* Table describing all the AArch64 opcodes.  */
 500 extern aarch64_opcode aarch64_opcode_table[];
 501
 502 /* Opcode flags.  */
 503 #define F_ALIAS (1 << 0)
 504 #define F_HAS_ALIAS (1 << 1)
 505 /* Disassembly preference priority 1-3 (the larger the higher).  If nothing
 506    is specified, it is the priority 0 by default, i.e. the lowest priority.  */
 507 #define F_P1 (1 << 2)
 508 #define F_P2 (2 << 2)
 509 #define F_P3 (3 << 2)
 510 /* Flag an instruction that is truly conditional executed, e.g. b.cond.  */
 511 #define F_COND (1 << 4)
 512 /* Instruction has the field of 'sf'.  */
 513 #define F_SF (1 << 5)
 514 /* Instruction has the field of 'size:Q'.  */
 515 #define F_SIZEQ (1 << 6)
 516 /* Floating-point instruction has the field of 'type'.  */
 517 #define F_FPTYPE (1 << 7)
 518 /* AdvSIMD scalar instruction has the field of 'size'.  */
 519 #define F_SSIZE (1 << 8)
 520 /* AdvSIMD vector register arrangement specifier encoded in "imm5<3:0>:Q".  */
 521 #define F_T (1 << 9)
 522 /* Size of GPR operand in AdvSIMD instructions encoded in Q.  */
 523 #define F_GPRSIZE_IN_Q (1 << 10)
 524 /* Size of Rt load signed instruction encoded in opc[0], i.e. bit 22.  */
 525 #define F_LDS_SIZE (1 << 11)
 526 /* Optional operand; assume maximum of 1 operand can be optional.  */
 527 #define F_OPD0_OPT (1 << 12)
 528 #define F_OPD1_OPT (2 << 12)
 529 #define F_OPD2_OPT (3 << 12)
 530 #define F_OPD3_OPT (4 << 12)
 531 #define F_OPD4_OPT (5 << 12)
 532 /* Default value for the optional operand when omitted from the assembly.  */
 533 #define F_DEFAULT(X) (((X) & 0x1f) << 15)
 534 /* Instruction that is an alias of another instruction needs to be
 535    encoded/decoded by converting it to/from the real form, followed by
 536    the encoding/decoding according to the rules of the real opcode.
 537    This compares to the direct coding using the alias's information.
 538    N.B. this flag requires F_ALIAS to be used together.  */
 539 #define F_CONV (1 << 20)
 540 /* Use together with F_ALIAS to indicate an alias opcode is a programmer
 541    friendly pseudo instruction available only in the assembly code (thus will
 542    not show up in the disassembly).  */
 543 #define F_PSEUDO (1 << 21)
 544 /* Instruction has miscellaneous encoding/decoding rules.  */
 545 #define F_MISC (1 << 22)
 546 /* Instruction has the field of 'N'; used in conjunction with F_SF.  */
 547 #define F_N (1 << 23)
 548 /* Opcode dependent field.  */
 549 #define F_OD(X) (((X) & 0x7) << 24)
 550 /* Next bit is 27.  */
 551
 552 static inline bfd_boolean
 553 alias_opcode_p (const aarch64_opcode *opcode)
 554 {
 555   return (opcode->flags & F_ALIAS) ? TRUE : FALSE;
 556 }
 557
 558 static inline bfd_boolean
 559 opcode_has_alias (const aarch64_opcode *opcode)
 560 {
 561   return (opcode->flags & F_HAS_ALIAS) ? TRUE : FALSE;
 562 }
 563
 564 /* Priority for disassembling preference.  */
 565 static inline int
 566 opcode_priority (const aarch64_opcode *opcode)
 567 {
 568   return (opcode->flags >> 2) & 0x3;
 569 }
 570
 571 static inline bfd_boolean
 572 pseudo_opcode_p (const aarch64_opcode *opcode)
 573 {
 574   return (opcode->flags & F_PSEUDO) != 0lu ? TRUE : FALSE;
 575 }
 576
 577 static inline bfd_boolean
 578 optional_operand_p (const aarch64_opcode *opcode, unsigned int idx)
 579 {
 580   return (((opcode->flags >> 12) & 0x7) == idx + 1)
 581     ? TRUE : FALSE;
 582 }
 583
 584 static inline aarch64_insn
 585 get_optional_operand_default_value (const aarch64_opcode *opcode)
 586 {
 587   return (opcode->flags >> 15) & 0x1f;
 588 }
 589
 590 static inline unsigned int
 591 get_opcode_dependent_value (const aarch64_opcode *opcode)
 592 {
 593   return (opcode->flags >> 24) & 0x7;
 594 }
 595
 596 static inline bfd_boolean
 597 opcode_has_special_coder (const aarch64_opcode *opcode)
 598 {
 599   return (opcode->flags & (F_SF | F_SIZEQ | F_FPTYPE | F_SSIZE | F_T
 600           | F_GPRSIZE_IN_Q | F_LDS_SIZE | F_MISC | F_N | F_COND)) ? TRUE
 601     : FALSE;
 602 }
 603 \f
 604 struct aarch64_name_value_pair
 605 {
 606   const char *  name;
 607   aarch64_insn  value;
 608 };
 609
 610 extern const struct aarch64_name_value_pair aarch64_operand_modifiers [];
 611 extern const struct aarch64_name_value_pair aarch64_sys_regs [];
 612 extern const struct aarch64_name_value_pair aarch64_pstatefields [];
 613 extern const struct aarch64_name_value_pair aarch64_barrier_options [16];
 614 extern const struct aarch64_name_value_pair aarch64_prfops [32];
 615
 616 typedef struct
 617 {
 618   const char *template;
 619   uint32_t value;
 620   int has_xt;
 621 } aarch64_sys_ins_reg;
 622
 623 extern const aarch64_sys_ins_reg aarch64_sys_regs_ic [];
 624 extern const aarch64_sys_ins_reg aarch64_sys_regs_dc [];
 625 extern const aarch64_sys_ins_reg aarch64_sys_regs_at [];
 626 extern const aarch64_sys_ins_reg aarch64_sys_regs_tlbi [];
 627
 628 /* Shift/extending operator kinds.
 629    N.B. order is important; keep aarch64_operand_modifiers synced.  */
 630 enum aarch64_modifier_kind
 631 {
 632   AARCH64_MOD_NONE,
 633   AARCH64_MOD_MSL,
 634   AARCH64_MOD_ROR,
 635   AARCH64_MOD_ASR,
 636   AARCH64_MOD_LSR,
 637   AARCH64_MOD_LSL,
 638   AARCH64_MOD_UXTB,
 639   AARCH64_MOD_UXTH,
 640   AARCH64_MOD_UXTW,
 641   AARCH64_MOD_UXTX,
 642   AARCH64_MOD_SXTB,
 643   AARCH64_MOD_SXTH,
 644   AARCH64_MOD_SXTW,
 645   AARCH64_MOD_SXTX,
 646 };
 647
 648 bfd_boolean
 649 aarch64_extend_operator_p (enum aarch64_modifier_kind);
 650
 651 enum aarch64_modifier_kind
 652 aarch64_get_operand_modifier (const struct aarch64_name_value_pair *);
 653 /* Condition.  */
 654
 655 typedef struct
 656 {
 657   /* A list of names with the first one as the disassembly preference;
 658      terminated by NULL if fewer than 3.  */
 659   const char *names[3];
 660   aarch64_insn value;
 661 } aarch64_cond;
 662
 663 extern const aarch64_cond aarch64_conds[16];
 664
 665 const aarch64_cond* get_cond_from_value (aarch64_insn value);
 666 const aarch64_cond* get_inverted_cond (const aarch64_cond *cond);
 667 \f
 668 /* Structure representing an operand.  */
 669
 670 struct aarch64_opnd_info
 671 {
 672   enum aarch64_opnd type;
 673   aarch64_opnd_qualifier_t qualifier;
 674   int idx;
 675
 676   union
 677     {
 678       struct
 679         {
 680           unsigned regno;
 681         } reg;
 682       struct
 683         {
 684           unsigned regno : 5;
 685           unsigned index : 4;
 686         } reglane;
 687       /* e.g. LVn.  */
 688       struct
 689         {
 690           unsigned first_regno : 5;
 691           unsigned num_regs : 3;
 692           /* 1 if it is a list of reg element.  */
 693           unsigned has_index : 1;
 694           /* Lane index; valid only when has_index is 1.  */
 695           unsigned index : 4;
 696         } reglist;
 697       /* e.g. immediate or pc relative address offset.  */
 698       struct
 699         {
 700           int64_t value;
 701           unsigned is_fp : 1;
 702         } imm;
 703       /* e.g. address in STR (register offset).  */
 704       struct
 705         {
 706           unsigned base_regno;
 707           struct
 708             {
 709               union
 710                 {
 711                   int imm;
 712                   unsigned regno;
 713                 };
 714               unsigned is_reg;
 715             } offset;
 716           unsigned pcrel : 1;           /* PC-relative.  */
 717           unsigned writeback : 1;
 718           unsigned preind : 1;          /* Pre-indexed.  */
 719           unsigned postind : 1;         /* Post-indexed.  */
 720         } addr;
 721       const aarch64_cond *cond;
 722       /* The encoding of the system register.  */
 723       aarch64_insn sysreg;
 724       /* The encoding of the PSTATE field.  */
 725       aarch64_insn pstatefield;
 726       const aarch64_sys_ins_reg *sysins_op;
 727       const struct aarch64_name_value_pair *barrier;
 728       const struct aarch64_name_value_pair *prfop;
 729     };
 730
 731   /* Operand shifter; in use when the operand is a register offset address,
 732      add/sub extended reg, etc. e.g. <R><m>{, <extend> {#<amount>}}.  */
 733   struct
 734     {
 735       enum aarch64_modifier_kind kind;
 736       int amount;
 737       unsigned operator_present: 1;     /* Only valid during encoding.  */
 738       /* Value of the 'S' field in ld/st reg offset; used only in decoding.  */
 739       unsigned amount_present: 1;
 740     } shifter;
 741
 742   unsigned skip:1;      /* Operand is not completed if there is a fixup needed
 743                            to be done on it.  In some (but not all) of these
 744                            cases, we need to tell libopcodes to skip the
 745                            constraint checking and the encoding for this
 746                            operand, so that the libopcodes can pick up the
 747                            right opcode before the operand is fixed-up.  This
 748                            flag should only be used during the
 749                            assembling/encoding.  */
 750   unsigned present:1;   /* Whether this operand is present in the assembly
 751                            line; not used during the disassembly.  */
 752 };
 753
 754 typedef struct aarch64_opnd_info aarch64_opnd_info;
 755
 756 /* Structure representing an instruction.
 757
 758    It is used during both the assembling and disassembling.  The assembler
 759    fills an aarch64_inst after a successful parsing and then passes it to the
 760    encoding routine to do the encoding.  During the disassembling, the
 761    disassembler calls the decoding routine to decode a binary instruction; on a
 762    successful return, such a structure will be filled with information of the
 763    instruction; then the disassembler uses the information to print out the
 764    instruction.  */
 765
 766 struct aarch64_inst
 767 {
 768   /* The value of the binary instruction.  */
 769   aarch64_insn value;
 770
 771   /* Corresponding opcode entry.  */
 772   const aarch64_opcode *opcode;
 773
 774   /* Condition for a truly conditional-executed instrutions, e.g. b.cond.  */
 775   const aarch64_cond *cond;
 776
 777   /* Operands information.  */
 778   aarch64_opnd_info operands[AARCH64_MAX_OPND_NUM];
 779 };
 780
 781 typedef struct aarch64_inst aarch64_inst;
 782 \f
 783 /* Diagnosis related declaration and interface.  */
 784
 785 /* Operand error kind enumerators.
 786
 787    AARCH64_OPDE_RECOVERABLE
 788      Less severe error found during the parsing, very possibly because that
 789      GAS has picked up a wrong instruction template for the parsing.
 790
 791    AARCH64_OPDE_SYNTAX_ERROR
 792      General syntax error; it can be either a user error, or simply because
 793      that GAS is trying a wrong instruction template.
 794
 795    AARCH64_OPDE_FATAL_SYNTAX_ERROR
 796      Definitely a user syntax error.
 797
 798    AARCH64_OPDE_INVALID_VARIANT
 799      No syntax error, but the operands are not a valid combination, e.g.
 800      FMOV D0,S0
 801
 802    AARCH64_OPDE_OUT_OF_RANGE
 803      Error about some immediate value out of a valid range.
 804
 805    AARCH64_OPDE_UNALIGNED
 806      Error about some immediate value not properly aligned (i.e. not being a
 807      multiple times of a certain value).
 808
 809    AARCH64_OPDE_REG_LIST
 810      Error about the register list operand having unexpected number of
 811      registers.
 812
 813    AARCH64_OPDE_OTHER_ERROR
 814      Error of the highest severity and used for any severe issue that does not
 815      fall into any of the above categories.
 816
 817    The enumerators are only interesting to GAS.  They are declared here (in
 818    libopcodes) because that some errors are detected (and then notified to GAS)
 819    by libopcodes (rather than by GAS solely).
 820
 821    The first three errors are only deteced by GAS while the
 822    AARCH64_OPDE_INVALID_VARIANT error can only be spotted by libopcodes as
 823    only libopcodes has the information about the valid variants of each
 824    instruction.
 825
 826    The enumerators have an increasing severity.  This is helpful when there are
 827    multiple instruction templates available for a given mnemonic name (e.g.
 828    FMOV); this mechanism will help choose the most suitable template from which
 829    the generated diagnostics can most closely describe the issues, if any.  */
 830
 831 enum aarch64_operand_error_kind
 832 {
 833   AARCH64_OPDE_NIL,
 834   AARCH64_OPDE_RECOVERABLE,
 835   AARCH64_OPDE_SYNTAX_ERROR,
 836   AARCH64_OPDE_FATAL_SYNTAX_ERROR,
 837   AARCH64_OPDE_INVALID_VARIANT,
 838   AARCH64_OPDE_OUT_OF_RANGE,
 839   AARCH64_OPDE_UNALIGNED,
 840   AARCH64_OPDE_REG_LIST,
 841   AARCH64_OPDE_OTHER_ERROR
 842 };
 843
 844 /* N.B. GAS assumes that this structure work well with shallow copy.  */
 845 struct aarch64_operand_error
 846 {
 847   enum aarch64_operand_error_kind kind;
 848   int index;
 849   const char *error;
 850   int data[3];  /* Some data for extra information.  */
 851 };
 852
 853 typedef struct aarch64_operand_error aarch64_operand_error;
 854
 855 /* Encoding entrypoint.  */
 856
 857 extern int
 858 aarch64_opcode_encode (const aarch64_opcode *, const aarch64_inst *,
 859                        aarch64_insn *, aarch64_opnd_qualifier_t *,
 860                        aarch64_operand_error *);
 861
 862 extern const aarch64_opcode *
 863 aarch64_replace_opcode (struct aarch64_inst *,
 864                         const aarch64_opcode *);
 865
 866 /* Given the opcode enumerator OP, return the pointer to the corresponding
 867    opcode entry.  */
 868
 869 extern const aarch64_opcode *
 870 aarch64_get_opcode (enum aarch64_op);
 871
 872 /* Generate the string representation of an operand.  */
 873 extern void
 874 aarch64_print_operand (char *, size_t, bfd_vma, const aarch64_opcode *,
 875                        const aarch64_opnd_info *, int, int *, bfd_vma *);
 876
 877 /* Miscellaneous interface.  */
 878
 879 extern int
 880 aarch64_operand_index (const enum aarch64_opnd *, enum aarch64_opnd);
 881
 882 extern aarch64_opnd_qualifier_t
 883 aarch64_get_expected_qualifier (const aarch64_opnd_qualifier_seq_t *, int,
 884                                 const aarch64_opnd_qualifier_t, int);
 885
 886 extern int
 887 aarch64_num_of_operands (const aarch64_opcode *);
 888
 889 extern int
 890 aarch64_stack_pointer_p (const aarch64_opnd_info *);
 891
 892 extern
 893 int aarch64_zero_register_p (const aarch64_opnd_info *);
 894
 895 /* Given an operand qualifier, return the expected data element size
 896    of a qualified operand.  */
 897 extern unsigned char
 898 aarch64_get_qualifier_esize (aarch64_opnd_qualifier_t);
 899
 900 extern enum aarch64_operand_class
 901 aarch64_get_operand_class (enum aarch64_opnd);
 902
 903 extern const char *
 904 aarch64_get_operand_name (enum aarch64_opnd);
 905
 906 extern const char *
 907 aarch64_get_operand_desc (enum aarch64_opnd);
 908
 909 #ifdef DEBUG_AARCH64
 910 extern int debug_dump;
 911
 912 extern void
 913 aarch64_verbose (const char *, ...) __attribute__ ((format (printf, 1, 2)));
 914
 915 #define DEBUG_TRACE(M, ...)                                     \
 916   {                                                             \
 917     if (debug_dump)                                             \
 918       aarch64_verbose ("%s: " M ".", __func__, ##__VA_ARGS__);  \
 919   }
 920
 921 #define DEBUG_TRACE_IF(C, M, ...)                               \
 922   {                                                             \
 923     if (debug_dump && (C))                                      \
 924       aarch64_verbose ("%s: " M ".", __func__, ##__VA_ARGS__);  \
 925   }
 926 #else  /* !DEBUG_AARCH64 */
 927 #define DEBUG_TRACE(M, ...) ;
 928 #define DEBUG_TRACE_IF(C, M, ...) ;
 929 #endif /* DEBUG_AARCH64 */
 930
 931 #endif /* OPCODE_AARCH64_H */