opcodes/aarch64-opc.h

   1 /* aarch64-opc.h -- Header file for aarch64-opc.c and aarch64-opc-2.c.
   2    Copyright (C) 2012-2016 Free Software Foundation, Inc.
   3    Contributed by ARM Ltd.
   4
   5    This file is part of the GNU opcodes library.
   6
   7    This library is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3, or (at your option)
  10    any later version.
  11
  12    It is distributed in the hope that it will be useful, but WITHOUT
  13    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  14    or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
  15    License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; see the file COPYING3. If not,
  19    see <http://www.gnu.org/licenses/>.  */
  20
  21 #ifndef OPCODES_AARCH64_OPC_H
  22 #define OPCODES_AARCH64_OPC_H
  23
  24 #include <string.h>
  25 #include "opcode/aarch64.h"
  26
  27 /* Instruction fields.
  28    Keep synced with fields.  */
  29 enum aarch64_field_kind
  30 {
  31   FLD_NIL,
  32   FLD_cond2,
  33   FLD_nzcv,
  34   FLD_defgh,
  35   FLD_abc,
  36   FLD_imm19,
  37   FLD_immhi,
  38   FLD_immlo,
  39   FLD_size,
  40   FLD_vldst_size,
  41   FLD_op,
  42   FLD_Q,
  43   FLD_Rt,
  44   FLD_Rd,
  45   FLD_Rn,
  46   FLD_Rt2,
  47   FLD_Ra,
  48   FLD_op2,
  49   FLD_CRm,
  50   FLD_CRn,
  51   FLD_op1,
  52   FLD_op0,
  53   FLD_imm3,
  54   FLD_cond,
  55   FLD_opcode,
  56   FLD_cmode,
  57   FLD_asisdlso_opcode,
  58   FLD_len,
  59   FLD_Rm,
  60   FLD_Rs,
  61   FLD_option,
  62   FLD_S,
  63   FLD_hw,
  64   FLD_opc,
  65   FLD_opc1,
  66   FLD_shift,
  67   FLD_type,
  68   FLD_ldst_size,
  69   FLD_imm6,
  70   FLD_imm4,
  71   FLD_imm5,
  72   FLD_imm7,
  73   FLD_imm8,
  74   FLD_imm9,
  75   FLD_imm12,
  76   FLD_imm14,
  77   FLD_imm16,
  78   FLD_imm26,
  79   FLD_imms,
  80   FLD_immr,
  81   FLD_immb,
  82   FLD_immh,
  83   FLD_N,
  84   FLD_index,
  85   FLD_index2,
  86   FLD_sf,
  87   FLD_lse_sz,
  88   FLD_H,
  89   FLD_L,
  90   FLD_M,
  91   FLD_b5,
  92   FLD_b40,
  93   FLD_scale,
  94   FLD_SVE_N,
  95   FLD_SVE_Pd,
  96   FLD_SVE_Pg3,
  97   FLD_SVE_Pg4_5,
  98   FLD_SVE_Pg4_10,
  99   FLD_SVE_Pg4_16,
 100   FLD_SVE_Pm,
 101   FLD_SVE_Pn,
 102   FLD_SVE_Pt,
 103   FLD_SVE_Za_5,
 104   FLD_SVE_Za_16,
 105   FLD_SVE_Zd,
 106   FLD_SVE_Zm_5,
 107   FLD_SVE_Zm_16,
 108   FLD_SVE_Zn,
 109   FLD_SVE_Zt,
 110   FLD_SVE_imm3,
 111   FLD_SVE_imm4,
 112   FLD_SVE_imm5,
 113   FLD_SVE_imm5b,
 114   FLD_SVE_imm6,
 115   FLD_SVE_imm7,
 116   FLD_SVE_imm8,
 117   FLD_SVE_imm9,
 118   FLD_SVE_immr,
 119   FLD_SVE_imms,
 120   FLD_SVE_msz,
 121   FLD_SVE_pattern,
 122   FLD_SVE_prfop,
 123   FLD_SVE_tszh,
 124   FLD_SVE_xs_14,
 125   FLD_SVE_xs_22,
 126 };
 127
 128 /* Field description.  */
 129 struct aarch64_field
 130 {
 131   int lsb;
 132   int width;
 133 };
 134
 135 typedef struct aarch64_field aarch64_field;
 136
 137 extern const aarch64_field fields[];
 138 \f
 139 /* Operand description.  */
 140
 141 struct aarch64_operand
 142 {
 143   enum aarch64_operand_class op_class;
 144
 145   /* Name of the operand code; used mainly for the purpose of internal
 146      debugging.  */
 147   const char *name;
 148
 149   unsigned int flags;
 150
 151   /* The associated instruction bit-fields; no operand has more than 4
 152      bit-fields */
 153   enum aarch64_field_kind fields[4];
 154
 155   /* Brief description */
 156   const char *desc;
 157 };
 158
 159 typedef struct aarch64_operand aarch64_operand;
 160
 161 extern const aarch64_operand aarch64_operands[];
 162
 163 /* Operand flags.  */
 164
 165 #define OPD_F_HAS_INSERTER      0x00000001
 166 #define OPD_F_HAS_EXTRACTOR     0x00000002
 167 #define OPD_F_SEXT              0x00000004      /* Require sign-extension.  */
 168 #define OPD_F_SHIFT_BY_2        0x00000008      /* Need to left shift the field
 169                                                    value by 2 to get the value
 170                                                    of an immediate operand.  */
 171 #define OPD_F_MAYBE_SP          0x00000010      /* May potentially be SP.  */
 172 #define OPD_F_OD_MASK           0x00000060      /* Operand-dependent data.  */
 173 #define OPD_F_OD_LSB            5
 174 #define OPD_F_NO_ZR             0x00000080      /* ZR index not allowed.  */
 175
 176 static inline bfd_boolean
 177 operand_has_inserter (const aarch64_operand *operand)
 178 {
 179   return (operand->flags & OPD_F_HAS_INSERTER) ? TRUE : FALSE;
 180 }
 181
 182 static inline bfd_boolean
 183 operand_has_extractor (const aarch64_operand *operand)
 184 {
 185   return (operand->flags & OPD_F_HAS_EXTRACTOR) ? TRUE : FALSE;
 186 }
 187
 188 static inline bfd_boolean
 189 operand_need_sign_extension (const aarch64_operand *operand)
 190 {
 191   return (operand->flags & OPD_F_SEXT) ? TRUE : FALSE;
 192 }
 193
 194 static inline bfd_boolean
 195 operand_need_shift_by_two (const aarch64_operand *operand)
 196 {
 197   return (operand->flags & OPD_F_SHIFT_BY_2) ? TRUE : FALSE;
 198 }
 199
 200 static inline bfd_boolean
 201 operand_maybe_stack_pointer (const aarch64_operand *operand)
 202 {
 203   return (operand->flags & OPD_F_MAYBE_SP) ? TRUE : FALSE;
 204 }
 205
 206 /* Return the value of the operand-specific data field (OPD_F_OD_MASK).  */
 207 static inline unsigned int
 208 get_operand_specific_data (const aarch64_operand *operand)
 209 {
 210   return (operand->flags & OPD_F_OD_MASK) >> OPD_F_OD_LSB;
 211 }
 212
 213 /* Return the total width of the operand *OPERAND.  */
 214 static inline unsigned
 215 get_operand_fields_width (const aarch64_operand *operand)
 216 {
 217   int i = 0;
 218   unsigned width = 0;
 219   while (operand->fields[i] != FLD_NIL)
 220     width += fields[operand->fields[i++]].width;
 221   assert (width > 0 && width < 32);
 222   return width;
 223 }
 224
 225 static inline const aarch64_operand *
 226 get_operand_from_code (enum aarch64_opnd code)
 227 {
 228   return aarch64_operands + code;
 229 }
 230 \f
 231 /* Operand qualifier and operand constraint checking.  */
 232
 233 int aarch64_match_operands_constraint (aarch64_inst *,
 234                                        aarch64_operand_error *);
 235
 236 /* Operand qualifier related functions.  */
 237 const char* aarch64_get_qualifier_name (aarch64_opnd_qualifier_t);
 238 unsigned char aarch64_get_qualifier_nelem (aarch64_opnd_qualifier_t);
 239 aarch64_insn aarch64_get_qualifier_standard_value (aarch64_opnd_qualifier_t);
 240 int aarch64_find_best_match (const aarch64_inst *,
 241                              const aarch64_opnd_qualifier_seq_t *,
 242                              int, aarch64_opnd_qualifier_t *);
 243
 244 static inline void
 245 reset_operand_qualifier (aarch64_inst *inst, int idx)
 246 {
 247   assert (idx >=0 && idx < aarch64_num_of_operands (inst->opcode));
 248   inst->operands[idx].qualifier = AARCH64_OPND_QLF_NIL;
 249 }
 250 \f
 251 /* Inline functions operating on instruction bit-field(s).  */
 252
 253 /* Generate a mask that has WIDTH number of consecutive 1s.  */
 254
 255 static inline aarch64_insn
 256 gen_mask (int width)
 257 {
 258   return ((aarch64_insn) 1 << width) - 1;
 259 }
 260
 261 /* LSB_REL is the relative location of the lsb in the sub field, starting from 0.  */
 262 static inline int
 263 gen_sub_field (enum aarch64_field_kind kind, int lsb_rel, int width, aarch64_field *ret)
 264 {
 265   const aarch64_field *field = &fields[kind];
 266   if (lsb_rel < 0 || width <= 0 || lsb_rel + width > field->width)
 267     return 0;
 268   ret->lsb = field->lsb + lsb_rel;
 269   ret->width = width;
 270   return 1;
 271 }
 272
 273 /* Insert VALUE into FIELD of CODE.  MASK can be zero or the base mask
 274    of the opcode.  */
 275
 276 static inline void
 277 insert_field_2 (const aarch64_field *field, aarch64_insn *code,
 278                 aarch64_insn value, aarch64_insn mask)
 279 {
 280   assert (field->width < 32 && field->width >= 1 && field->lsb >= 0
 281           && field->lsb + field->width <= 32);
 282   value &= gen_mask (field->width);
 283   value <<= field->lsb;
 284   /* In some opcodes, field can be part of the base opcode, e.g. the size
 285      field in FADD.  The following helps avoid corrupt the base opcode.  */
 286   value &= ~mask;
 287   *code |= value;
 288 }
 289
 290 /* Extract FIELD of CODE and return the value.  MASK can be zero or the base
 291    mask of the opcode.  */
 292
 293 static inline aarch64_insn
 294 extract_field_2 (const aarch64_field *field, aarch64_insn code,
 295                  aarch64_insn mask)
 296 {
 297   aarch64_insn value;
 298   /* Clear any bit that is a part of the base opcode.  */
 299   code &= ~mask;
 300   value = (code >> field->lsb) & gen_mask (field->width);
 301   return value;
 302 }
 303
 304 /* Insert VALUE into field KIND of CODE.  MASK can be zero or the base mask
 305    of the opcode.  */
 306
 307 static inline void
 308 insert_field (enum aarch64_field_kind kind, aarch64_insn *code,
 309               aarch64_insn value, aarch64_insn mask)
 310 {
 311   insert_field_2 (&fields[kind], code, value, mask);
 312 }
 313
 314 /* Extract field KIND of CODE and return the value.  MASK can be zero or the
 315    base mask of the opcode.  */
 316
 317 static inline aarch64_insn
 318 extract_field (enum aarch64_field_kind kind, aarch64_insn code,
 319                aarch64_insn mask)
 320 {
 321   return extract_field_2 (&fields[kind], code, mask);
 322 }
 323 \f
 324 /* Inline functions selecting operand to do the encoding/decoding for a
 325    certain instruction bit-field.  */
 326
 327 /* Select the operand to do the encoding/decoding of the 'sf' field.
 328    The heuristic-based rule is that the result operand is respected more.  */
 329
 330 static inline int
 331 select_operand_for_sf_field_coding (const aarch64_opcode *opcode)
 332 {
 333   int idx = -1;
 334   if (aarch64_get_operand_class (opcode->operands[0])
 335       == AARCH64_OPND_CLASS_INT_REG)
 336     /* normal case.  */
 337     idx = 0;
 338   else if (aarch64_get_operand_class (opcode->operands[1])
 339            == AARCH64_OPND_CLASS_INT_REG)
 340     /* e.g. float2fix.  */
 341     idx = 1;
 342   else
 343     { assert (0); abort (); }
 344   return idx;
 345 }
 346
 347 /* Select the operand to do the encoding/decoding of the 'type' field in
 348    the floating-point instructions.
 349    The heuristic-based rule is that the source operand is respected more.  */
 350
 351 static inline int
 352 select_operand_for_fptype_field_coding (const aarch64_opcode *opcode)
 353 {
 354   int idx;
 355   if (aarch64_get_operand_class (opcode->operands[1])
 356       == AARCH64_OPND_CLASS_FP_REG)
 357     /* normal case.  */
 358     idx = 1;
 359   else if (aarch64_get_operand_class (opcode->operands[0])
 360            == AARCH64_OPND_CLASS_FP_REG)
 361     /* e.g. float2fix.  */
 362     idx = 0;
 363   else
 364     { assert (0); abort (); }
 365   return idx;
 366 }
 367
 368 /* Select the operand to do the encoding/decoding of the 'size' field in
 369    the AdvSIMD scalar instructions.
 370    The heuristic-based rule is that the destination operand is respected
 371    more.  */
 372
 373 static inline int
 374 select_operand_for_scalar_size_field_coding (const aarch64_opcode *opcode)
 375 {
 376   int src_size = 0, dst_size = 0;
 377   if (aarch64_get_operand_class (opcode->operands[0])
 378       == AARCH64_OPND_CLASS_SISD_REG)
 379     dst_size = aarch64_get_qualifier_esize (opcode->qualifiers_list[0][0]);
 380   if (aarch64_get_operand_class (opcode->operands[1])
 381       == AARCH64_OPND_CLASS_SISD_REG)
 382     src_size = aarch64_get_qualifier_esize (opcode->qualifiers_list[0][1]);
 383   if (src_size == dst_size && src_size == 0)
 384     { assert (0); abort (); }
 385   /* When the result is not a sisd register or it is a long operantion.  */
 386   if (dst_size == 0 || dst_size == src_size << 1)
 387     return 1;
 388   else
 389     return 0;
 390 }
 391
 392 /* Select the operand to do the encoding/decoding of the 'size:Q' fields in
 393    the AdvSIMD instructions.  */
 394
 395 int aarch64_select_operand_for_sizeq_field_coding (const aarch64_opcode *);
 396 \f
 397 /* Miscellaneous.  */
 398
 399 aarch64_insn aarch64_get_operand_modifier_value (enum aarch64_modifier_kind);
 400 enum aarch64_modifier_kind
 401 aarch64_get_operand_modifier_from_value (aarch64_insn, bfd_boolean);
 402
 403
 404 bfd_boolean aarch64_wide_constant_p (int64_t, int, unsigned int *);
 405 bfd_boolean aarch64_logical_immediate_p (uint64_t, int, aarch64_insn *);
 406 int aarch64_shrink_expanded_imm8 (uint64_t);
 407
 408 /* Copy the content of INST->OPERANDS[SRC] to INST->OPERANDS[DST].  */
 409 static inline void
 410 copy_operand_info (aarch64_inst *inst, int dst, int src)
 411 {
 412   assert (dst >= 0 && src >= 0 && dst < AARCH64_MAX_OPND_NUM
 413           && src < AARCH64_MAX_OPND_NUM);
 414   memcpy (&inst->operands[dst], &inst->operands[src],
 415           sizeof (aarch64_opnd_info));
 416   inst->operands[dst].idx = dst;
 417 }
 418
 419 /* A primitive log caculator.  */
 420
 421 static inline unsigned int
 422 get_logsz (unsigned int size)
 423 {
 424   const unsigned char ls[16] =
 425     {0, 1, -1, 2, -1, -1, -1, 3, -1, -1, -1, -1, -1, -1, -1, 4};
 426   if (size > 16)
 427     {
 428       assert (0);
 429       return -1;
 430     }
 431   assert (ls[size - 1] != (unsigned char)-1);
 432   return ls[size - 1];
 433 }
 434
 435 #endif /* OPCODES_AARCH64_OPC_H */