1 /* aarch64-dis.c -- AArch64 disassembler.
2 Copyright (C) 2009-2018 Free Software Foundation, Inc.
3 Contributed by ARM Ltd.
5 This file is part of the GNU opcodes library.
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)
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.
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/>. */
22 #include "bfd_stdint.h"
23 #include "disassemble.h"
24 #include "libiberty.h"
26 #include "aarch64-dis.h"
31 /* Cached mapping symbol state. */
38 static enum map_type last_type;
39 static int last_mapping_sym = -1;
40 static bfd_vma last_mapping_addr = 0;
43 static int no_aliases = 0; /* If set disassemble as most general inst. */
44 \fstatic int no_notes = 1; /* If set do not print disassemble notes in the
45 output as comments. */
47 /* Currently active instruction sequence. */
48 static aarch64_instr_sequence insn_sequence;
51 set_default_aarch64_dis_options (struct disassemble_info *info ATTRIBUTE_UNUSED)
56 parse_aarch64_dis_option (const char *option, unsigned int len ATTRIBUTE_UNUSED)
58 /* Try to match options that are simple flags */
59 if (CONST_STRNEQ (option, "no-aliases"))
65 if (CONST_STRNEQ (option, "aliases"))
71 if (CONST_STRNEQ (option, "no-notes"))
77 if (CONST_STRNEQ (option, "notes"))
84 if (CONST_STRNEQ (option, "debug_dump"))
89 #endif /* DEBUG_AARCH64 */
92 opcodes_error_handler (_("unrecognised disassembler option: %s"), option);
96 parse_aarch64_dis_options (const char *options)
98 const char *option_end;
103 while (*options != '\0')
105 /* Skip empty options. */
112 /* We know that *options is neither NUL or a comma. */
113 option_end = options + 1;
114 while (*option_end != ',' && *option_end != '\0')
117 parse_aarch64_dis_option (options, option_end - options);
119 /* Go on to the next one. If option_end points to a comma, it
120 will be skipped above. */
121 options = option_end;
125 /* Functions doing the instruction disassembling. */
127 /* The unnamed arguments consist of the number of fields and information about
128 these fields where the VALUE will be extracted from CODE and returned.
129 MASK can be zero or the base mask of the opcode.
131 N.B. the fields are required to be in such an order than the most signficant
132 field for VALUE comes the first, e.g. the <index> in
133 SQDMLAL <Va><d>, <Vb><n>, <Vm>.<Ts>[<index>]
134 is encoded in H:L:M in some cases, the fields H:L:M should be passed in
135 the order of H, L, M. */
138 extract_fields (aarch64_insn code, aarch64_insn mask, ...)
141 const aarch64_field *field;
142 enum aarch64_field_kind kind;
146 num = va_arg (va, uint32_t);
148 aarch64_insn value = 0x0;
151 kind = va_arg (va, enum aarch64_field_kind);
152 field = &fields[kind];
153 value <<= field->width;
154 value |= extract_field (kind, code, mask);
159 /* Extract the value of all fields in SELF->fields from instruction CODE.
160 The least significant bit comes from the final field. */
163 extract_all_fields (const aarch64_operand *self, aarch64_insn code)
167 enum aarch64_field_kind kind;
170 for (i = 0; i < ARRAY_SIZE (self->fields) && self->fields[i] != FLD_NIL; ++i)
172 kind = self->fields[i];
173 value <<= fields[kind].width;
174 value |= extract_field (kind, code, 0);
179 /* Sign-extend bit I of VALUE. */
180 static inline int32_t
181 sign_extend (aarch64_insn value, unsigned i)
183 uint32_t ret = value;
186 if ((value >> i) & 0x1)
188 uint32_t val = (uint32_t)(-1) << i;
191 return (int32_t) ret;
194 /* N.B. the following inline helpfer functions create a dependency on the
195 order of operand qualifier enumerators. */
197 /* Given VALUE, return qualifier for a general purpose register. */
198 static inline enum aarch64_opnd_qualifier
199 get_greg_qualifier_from_value (aarch64_insn value)
201 enum aarch64_opnd_qualifier qualifier = AARCH64_OPND_QLF_W + value;
203 && aarch64_get_qualifier_standard_value (qualifier) == value);
207 /* Given VALUE, return qualifier for a vector register. This does not support
208 decoding instructions that accept the 2H vector type. */
210 static inline enum aarch64_opnd_qualifier
211 get_vreg_qualifier_from_value (aarch64_insn value)
213 enum aarch64_opnd_qualifier qualifier = AARCH64_OPND_QLF_V_8B + value;
215 /* Instructions using vector type 2H should not call this function. Skip over
217 if (qualifier >= AARCH64_OPND_QLF_V_2H)
221 && aarch64_get_qualifier_standard_value (qualifier) == value);
225 /* Given VALUE, return qualifier for an FP or AdvSIMD scalar register. */
226 static inline enum aarch64_opnd_qualifier
227 get_sreg_qualifier_from_value (aarch64_insn value)
229 enum aarch64_opnd_qualifier qualifier = AARCH64_OPND_QLF_S_B + value;
232 && aarch64_get_qualifier_standard_value (qualifier) == value);
236 /* Given the instruction in *INST which is probably half way through the
237 decoding and our caller wants to know the expected qualifier for operand
238 I. Return such a qualifier if we can establish it; otherwise return
239 AARCH64_OPND_QLF_NIL. */
241 static aarch64_opnd_qualifier_t
242 get_expected_qualifier (const aarch64_inst *inst, int i)
244 aarch64_opnd_qualifier_seq_t qualifiers;
245 /* Should not be called if the qualifier is known. */
246 assert (inst->operands[i].qualifier == AARCH64_OPND_QLF_NIL);
247 if (aarch64_find_best_match (inst, inst->opcode->qualifiers_list,
249 return qualifiers[i];
251 return AARCH64_OPND_QLF_NIL;
254 /* Operand extractors. */
257 aarch64_ext_regno (const aarch64_operand *self, aarch64_opnd_info *info,
258 const aarch64_insn code,
259 const aarch64_inst *inst ATTRIBUTE_UNUSED,
260 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
262 info->reg.regno = extract_field (self->fields[0], code, 0);
267 aarch64_ext_regno_pair (const aarch64_operand *self ATTRIBUTE_UNUSED, aarch64_opnd_info *info,
268 const aarch64_insn code ATTRIBUTE_UNUSED,
269 const aarch64_inst *inst ATTRIBUTE_UNUSED,
270 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
272 assert (info->idx == 1
274 info->reg.regno = inst->operands[info->idx - 1].reg.regno + 1;
278 /* e.g. IC <ic_op>{, <Xt>}. */
280 aarch64_ext_regrt_sysins (const aarch64_operand *self, aarch64_opnd_info *info,
281 const aarch64_insn code,
282 const aarch64_inst *inst ATTRIBUTE_UNUSED,
283 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
285 info->reg.regno = extract_field (self->fields[0], code, 0);
286 assert (info->idx == 1
287 && (aarch64_get_operand_class (inst->operands[0].type)
288 == AARCH64_OPND_CLASS_SYSTEM));
289 /* This will make the constraint checking happy and more importantly will
290 help the disassembler determine whether this operand is optional or
292 info->present = aarch64_sys_ins_reg_has_xt (inst->operands[0].sysins_op);
297 /* e.g. SQDMLAL <Va><d>, <Vb><n>, <Vm>.<Ts>[<index>]. */
299 aarch64_ext_reglane (const aarch64_operand *self, aarch64_opnd_info *info,
300 const aarch64_insn code,
301 const aarch64_inst *inst ATTRIBUTE_UNUSED,
302 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
305 info->reglane.regno = extract_field (self->fields[0], code,
308 /* Index and/or type. */
309 if (inst->opcode->iclass == asisdone
310 || inst->opcode->iclass == asimdins)
312 if (info->type == AARCH64_OPND_En
313 && inst->opcode->operands[0] == AARCH64_OPND_Ed)
316 /* index2 for e.g. INS <Vd>.<Ts>[<index1>], <Vn>.<Ts>[<index2>]. */
317 assert (info->idx == 1); /* Vn */
318 aarch64_insn value = extract_field (FLD_imm4, code, 0);
319 /* Depend on AARCH64_OPND_Ed to determine the qualifier. */
320 info->qualifier = get_expected_qualifier (inst, info->idx);
321 shift = get_logsz (aarch64_get_qualifier_esize (info->qualifier));
322 info->reglane.index = value >> shift;
326 /* index and type for e.g. DUP <V><d>, <Vn>.<T>[<index>].
334 aarch64_insn value = extract_field (FLD_imm5, code, 0);
335 while (++pos <= 3 && (value & 0x1) == 0)
339 info->qualifier = get_sreg_qualifier_from_value (pos);
340 info->reglane.index = (unsigned) (value >> 1);
343 else if (inst->opcode->iclass == dotproduct)
345 /* Need information in other operand(s) to help decoding. */
346 info->qualifier = get_expected_qualifier (inst, info->idx);
347 switch (info->qualifier)
349 case AARCH64_OPND_QLF_S_4B:
351 info->reglane.index = extract_fields (code, 0, 2, FLD_H, FLD_L);
352 info->reglane.regno &= 0x1f;
358 else if (inst->opcode->iclass == cryptosm3)
360 /* index for e.g. SM3TT2A <Vd>.4S, <Vn>.4S, <Vm>S[<imm2>]. */
361 info->reglane.index = extract_field (FLD_SM3_imm2, code, 0);
365 /* Index only for e.g. SQDMLAL <Va><d>, <Vb><n>, <Vm>.<Ts>[<index>]
366 or SQDMLAL <Va><d>, <Vb><n>, <Vm>.<Ts>[<index>]. */
368 /* Need information in other operand(s) to help decoding. */
369 info->qualifier = get_expected_qualifier (inst, info->idx);
370 switch (info->qualifier)
372 case AARCH64_OPND_QLF_S_H:
373 if (info->type == AARCH64_OPND_Em16)
376 info->reglane.index = extract_fields (code, 0, 3, FLD_H, FLD_L,
378 info->reglane.regno &= 0xf;
383 info->reglane.index = extract_fields (code, 0, 2, FLD_H, FLD_L);
386 case AARCH64_OPND_QLF_S_S:
388 info->reglane.index = extract_fields (code, 0, 2, FLD_H, FLD_L);
390 case AARCH64_OPND_QLF_S_D:
392 info->reglane.index = extract_field (FLD_H, code, 0);
398 if (inst->opcode->op == OP_FCMLA_ELEM
399 && info->qualifier != AARCH64_OPND_QLF_S_H)
401 /* Complex operand takes two elements. */
402 if (info->reglane.index & 1)
404 info->reglane.index /= 2;
412 aarch64_ext_reglist (const aarch64_operand *self, aarch64_opnd_info *info,
413 const aarch64_insn code,
414 const aarch64_inst *inst ATTRIBUTE_UNUSED,
415 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
418 info->reglist.first_regno = extract_field (self->fields[0], code, 0);
420 info->reglist.num_regs = extract_field (FLD_len, code, 0) + 1;
424 /* Decode Rt and opcode fields of Vt in AdvSIMD load/store instructions. */
426 aarch64_ext_ldst_reglist (const aarch64_operand *self ATTRIBUTE_UNUSED,
427 aarch64_opnd_info *info, const aarch64_insn code,
428 const aarch64_inst *inst,
429 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
432 /* Number of elements in each structure to be loaded/stored. */
433 unsigned expected_num = get_opcode_dependent_value (inst->opcode);
437 unsigned is_reserved;
439 unsigned num_elements;
455 info->reglist.first_regno = extract_field (FLD_Rt, code, 0);
457 value = extract_field (FLD_opcode, code, 0);
458 /* PR 21595: Check for a bogus value. */
459 if (value >= ARRAY_SIZE (data))
461 if (expected_num != data[value].num_elements || data[value].is_reserved)
463 info->reglist.num_regs = data[value].num_regs;
468 /* Decode Rt and S fields of Vt in AdvSIMD load single structure to all
469 lanes instructions. */
471 aarch64_ext_ldst_reglist_r (const aarch64_operand *self ATTRIBUTE_UNUSED,
472 aarch64_opnd_info *info, const aarch64_insn code,
473 const aarch64_inst *inst,
474 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
479 info->reglist.first_regno = extract_field (FLD_Rt, code, 0);
481 value = extract_field (FLD_S, code, 0);
483 /* Number of registers is equal to the number of elements in
484 each structure to be loaded/stored. */
485 info->reglist.num_regs = get_opcode_dependent_value (inst->opcode);
486 assert (info->reglist.num_regs >= 1 && info->reglist.num_regs <= 4);
488 /* Except when it is LD1R. */
489 if (info->reglist.num_regs == 1 && value == (aarch64_insn) 1)
490 info->reglist.num_regs = 2;
495 /* Decode Q, opcode<2:1>, S, size and Rt fields of Vt in AdvSIMD
496 load/store single element instructions. */
498 aarch64_ext_ldst_elemlist (const aarch64_operand *self ATTRIBUTE_UNUSED,
499 aarch64_opnd_info *info, const aarch64_insn code,
500 const aarch64_inst *inst ATTRIBUTE_UNUSED,
501 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
503 aarch64_field field = {0, 0};
504 aarch64_insn QSsize; /* fields Q:S:size. */
505 aarch64_insn opcodeh2; /* opcode<2:1> */
508 info->reglist.first_regno = extract_field (FLD_Rt, code, 0);
510 /* Decode the index, opcode<2:1> and size. */
511 gen_sub_field (FLD_asisdlso_opcode, 1, 2, &field);
512 opcodeh2 = extract_field_2 (&field, code, 0);
513 QSsize = extract_fields (code, 0, 3, FLD_Q, FLD_S, FLD_vldst_size);
517 info->qualifier = AARCH64_OPND_QLF_S_B;
518 /* Index encoded in "Q:S:size". */
519 info->reglist.index = QSsize;
525 info->qualifier = AARCH64_OPND_QLF_S_H;
526 /* Index encoded in "Q:S:size<1>". */
527 info->reglist.index = QSsize >> 1;
530 if ((QSsize >> 1) & 0x1)
533 if ((QSsize & 0x1) == 0)
535 info->qualifier = AARCH64_OPND_QLF_S_S;
536 /* Index encoded in "Q:S". */
537 info->reglist.index = QSsize >> 2;
541 if (extract_field (FLD_S, code, 0))
544 info->qualifier = AARCH64_OPND_QLF_S_D;
545 /* Index encoded in "Q". */
546 info->reglist.index = QSsize >> 3;
553 info->reglist.has_index = 1;
554 info->reglist.num_regs = 0;
555 /* Number of registers is equal to the number of elements in
556 each structure to be loaded/stored. */
557 info->reglist.num_regs = get_opcode_dependent_value (inst->opcode);
558 assert (info->reglist.num_regs >= 1 && info->reglist.num_regs <= 4);
563 /* Decode fields immh:immb and/or Q for e.g.
564 SSHR <Vd>.<T>, <Vn>.<T>, #<shift>
565 or SSHR <V><d>, <V><n>, #<shift>. */
568 aarch64_ext_advsimd_imm_shift (const aarch64_operand *self ATTRIBUTE_UNUSED,
569 aarch64_opnd_info *info, const aarch64_insn code,
570 const aarch64_inst *inst,
571 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
574 aarch64_insn Q, imm, immh;
575 enum aarch64_insn_class iclass = inst->opcode->iclass;
577 immh = extract_field (FLD_immh, code, 0);
580 imm = extract_fields (code, 0, 2, FLD_immh, FLD_immb);
582 /* Get highest set bit in immh. */
583 while (--pos >= 0 && (immh & 0x8) == 0)
586 assert ((iclass == asimdshf || iclass == asisdshf)
587 && (info->type == AARCH64_OPND_IMM_VLSR
588 || info->type == AARCH64_OPND_IMM_VLSL));
590 if (iclass == asimdshf)
592 Q = extract_field (FLD_Q, code, 0);
594 0000 x SEE AdvSIMD modified immediate
604 get_vreg_qualifier_from_value ((pos << 1) | (int) Q);
607 info->qualifier = get_sreg_qualifier_from_value (pos);
609 if (info->type == AARCH64_OPND_IMM_VLSR)
611 0000 SEE AdvSIMD modified immediate
612 0001 (16-UInt(immh:immb))
613 001x (32-UInt(immh:immb))
614 01xx (64-UInt(immh:immb))
615 1xxx (128-UInt(immh:immb)) */
616 info->imm.value = (16 << pos) - imm;
620 0000 SEE AdvSIMD modified immediate
621 0001 (UInt(immh:immb)-8)
622 001x (UInt(immh:immb)-16)
623 01xx (UInt(immh:immb)-32)
624 1xxx (UInt(immh:immb)-64) */
625 info->imm.value = imm - (8 << pos);
630 /* Decode shift immediate for e.g. sshr (imm). */
632 aarch64_ext_shll_imm (const aarch64_operand *self ATTRIBUTE_UNUSED,
633 aarch64_opnd_info *info, const aarch64_insn code,
634 const aarch64_inst *inst ATTRIBUTE_UNUSED,
635 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
639 val = extract_field (FLD_size, code, 0);
642 case 0: imm = 8; break;
643 case 1: imm = 16; break;
644 case 2: imm = 32; break;
645 default: return FALSE;
647 info->imm.value = imm;
651 /* Decode imm for e.g. BFM <Wd>, <Wn>, #<immr>, #<imms>.
652 value in the field(s) will be extracted as unsigned immediate value. */
654 aarch64_ext_imm (const aarch64_operand *self, aarch64_opnd_info *info,
655 const aarch64_insn code,
656 const aarch64_inst *inst ATTRIBUTE_UNUSED,
657 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
661 imm = extract_all_fields (self, code);
663 if (operand_need_sign_extension (self))
664 imm = sign_extend (imm, get_operand_fields_width (self) - 1);
666 if (operand_need_shift_by_two (self))
668 else if (operand_need_shift_by_four (self))
671 if (info->type == AARCH64_OPND_ADDR_ADRP)
674 info->imm.value = imm;
678 /* Decode imm and its shifter for e.g. MOVZ <Wd>, #<imm16>{, LSL #<shift>}. */
680 aarch64_ext_imm_half (const aarch64_operand *self, aarch64_opnd_info *info,
681 const aarch64_insn code,
682 const aarch64_inst *inst ATTRIBUTE_UNUSED,
683 aarch64_operand_error *errors)
685 aarch64_ext_imm (self, info, code, inst, errors);
686 info->shifter.kind = AARCH64_MOD_LSL;
687 info->shifter.amount = extract_field (FLD_hw, code, 0) << 4;
691 /* Decode cmode and "a:b:c:d:e:f:g:h" for e.g.
692 MOVI <Vd>.<T>, #<imm8> {, LSL #<amount>}. */
694 aarch64_ext_advsimd_imm_modified (const aarch64_operand *self ATTRIBUTE_UNUSED,
695 aarch64_opnd_info *info,
696 const aarch64_insn code,
697 const aarch64_inst *inst ATTRIBUTE_UNUSED,
698 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
701 enum aarch64_opnd_qualifier opnd0_qualifier = inst->operands[0].qualifier;
702 aarch64_field field = {0, 0};
704 assert (info->idx == 1);
706 if (info->type == AARCH64_OPND_SIMD_FPIMM)
709 /* a:b:c:d:e:f:g:h */
710 imm = extract_fields (code, 0, 2, FLD_abc, FLD_defgh);
711 if (!info->imm.is_fp && aarch64_get_qualifier_esize (opnd0_qualifier) == 8)
713 /* Either MOVI <Dd>, #<imm>
714 or MOVI <Vd>.2D, #<imm>.
715 <imm> is a 64-bit immediate
716 'aaaaaaaabbbbbbbbccccccccddddddddeeeeeeeeffffffffgggggggghhhhhhhh',
717 encoded in "a:b:c:d:e:f:g:h". */
719 unsigned abcdefgh = imm;
720 for (imm = 0ull, i = 0; i < 8; i++)
721 if (((abcdefgh >> i) & 0x1) != 0)
722 imm |= 0xffull << (8 * i);
724 info->imm.value = imm;
727 info->qualifier = get_expected_qualifier (inst, info->idx);
728 switch (info->qualifier)
730 case AARCH64_OPND_QLF_NIL:
732 info->shifter.kind = AARCH64_MOD_NONE;
734 case AARCH64_OPND_QLF_LSL:
736 info->shifter.kind = AARCH64_MOD_LSL;
737 switch (aarch64_get_qualifier_esize (opnd0_qualifier))
739 case 4: gen_sub_field (FLD_cmode, 1, 2, &field); break; /* per word */
740 case 2: gen_sub_field (FLD_cmode, 1, 1, &field); break; /* per half */
741 case 1: gen_sub_field (FLD_cmode, 1, 0, &field); break; /* per byte */
742 default: assert (0); return FALSE;
744 /* 00: 0; 01: 8; 10:16; 11:24. */
745 info->shifter.amount = extract_field_2 (&field, code, 0) << 3;
747 case AARCH64_OPND_QLF_MSL:
749 info->shifter.kind = AARCH64_MOD_MSL;
750 gen_sub_field (FLD_cmode, 0, 1, &field); /* per word */
751 info->shifter.amount = extract_field_2 (&field, code, 0) ? 16 : 8;
761 /* Decode an 8-bit floating-point immediate. */
763 aarch64_ext_fpimm (const aarch64_operand *self, aarch64_opnd_info *info,
764 const aarch64_insn code,
765 const aarch64_inst *inst ATTRIBUTE_UNUSED,
766 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
768 info->imm.value = extract_all_fields (self, code);
773 /* Decode a 1-bit rotate immediate (#90 or #270). */
775 aarch64_ext_imm_rotate1 (const aarch64_operand *self, aarch64_opnd_info *info,
776 const aarch64_insn code,
777 const aarch64_inst *inst ATTRIBUTE_UNUSED,
778 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
780 uint64_t rot = extract_field (self->fields[0], code, 0);
782 info->imm.value = rot * 180 + 90;
786 /* Decode a 2-bit rotate immediate (#0, #90, #180 or #270). */
788 aarch64_ext_imm_rotate2 (const aarch64_operand *self, aarch64_opnd_info *info,
789 const aarch64_insn code,
790 const aarch64_inst *inst ATTRIBUTE_UNUSED,
791 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
793 uint64_t rot = extract_field (self->fields[0], code, 0);
795 info->imm.value = rot * 90;
799 /* Decode scale for e.g. SCVTF <Dd>, <Wn>, #<fbits>. */
801 aarch64_ext_fbits (const aarch64_operand *self ATTRIBUTE_UNUSED,
802 aarch64_opnd_info *info, const aarch64_insn code,
803 const aarch64_inst *inst ATTRIBUTE_UNUSED,
804 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
806 info->imm.value = 64- extract_field (FLD_scale, code, 0);
810 /* Decode arithmetic immediate for e.g.
811 SUBS <Wd>, <Wn|WSP>, #<imm> {, <shift>}. */
813 aarch64_ext_aimm (const aarch64_operand *self ATTRIBUTE_UNUSED,
814 aarch64_opnd_info *info, const aarch64_insn code,
815 const aarch64_inst *inst ATTRIBUTE_UNUSED,
816 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
820 info->shifter.kind = AARCH64_MOD_LSL;
822 value = extract_field (FLD_shift, code, 0);
825 info->shifter.amount = value ? 12 : 0;
826 /* imm12 (unsigned) */
827 info->imm.value = extract_field (FLD_imm12, code, 0);
832 /* Return true if VALUE is a valid logical immediate encoding, storing the
833 decoded value in *RESULT if so. ESIZE is the number of bytes in the
834 decoded immediate. */
836 decode_limm (uint32_t esize, aarch64_insn value, int64_t *result)
842 /* value is N:immr:imms. */
844 R = (value >> 6) & 0x3f;
845 N = (value >> 12) & 0x1;
847 /* The immediate value is S+1 bits to 1, left rotated by SIMDsize - R
848 (in other words, right rotated by R), then replicated. */
852 mask = 0xffffffffffffffffull;
858 case 0x00 ... 0x1f: /* 0xxxxx */ simd_size = 32; break;
859 case 0x20 ... 0x2f: /* 10xxxx */ simd_size = 16; S &= 0xf; break;
860 case 0x30 ... 0x37: /* 110xxx */ simd_size = 8; S &= 0x7; break;
861 case 0x38 ... 0x3b: /* 1110xx */ simd_size = 4; S &= 0x3; break;
862 case 0x3c ... 0x3d: /* 11110x */ simd_size = 2; S &= 0x1; break;
863 default: return FALSE;
865 mask = (1ull << simd_size) - 1;
866 /* Top bits are IGNORED. */
870 if (simd_size > esize * 8)
873 /* NOTE: if S = simd_size - 1 we get 0xf..f which is rejected. */
874 if (S == simd_size - 1)
876 /* S+1 consecutive bits to 1. */
877 /* NOTE: S can't be 63 due to detection above. */
878 imm = (1ull << (S + 1)) - 1;
879 /* Rotate to the left by simd_size - R. */
881 imm = ((imm << (simd_size - R)) & mask) | (imm >> R);
882 /* Replicate the value according to SIMD size. */
885 case 2: imm = (imm << 2) | imm;
887 case 4: imm = (imm << 4) | imm;
889 case 8: imm = (imm << 8) | imm;
891 case 16: imm = (imm << 16) | imm;
893 case 32: imm = (imm << 32) | imm;
896 default: assert (0); return 0;
899 *result = imm & ~((uint64_t) -1 << (esize * 4) << (esize * 4));
904 /* Decode a logical immediate for e.g. ORR <Wd|WSP>, <Wn>, #<imm>. */
906 aarch64_ext_limm (const aarch64_operand *self,
907 aarch64_opnd_info *info, const aarch64_insn code,
908 const aarch64_inst *inst,
909 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
914 value = extract_fields (code, 0, 3, self->fields[0], self->fields[1],
916 esize = aarch64_get_qualifier_esize (inst->operands[0].qualifier);
917 return decode_limm (esize, value, &info->imm.value);
920 /* Decode a logical immediate for the BIC alias of AND (etc.). */
922 aarch64_ext_inv_limm (const aarch64_operand *self,
923 aarch64_opnd_info *info, const aarch64_insn code,
924 const aarch64_inst *inst,
925 aarch64_operand_error *errors)
927 if (!aarch64_ext_limm (self, info, code, inst, errors))
929 info->imm.value = ~info->imm.value;
933 /* Decode Ft for e.g. STR <Qt>, [<Xn|SP>, <R><m>{, <extend> {<amount>}}]
934 or LDP <Qt1>, <Qt2>, [<Xn|SP>], #<imm>. */
936 aarch64_ext_ft (const aarch64_operand *self ATTRIBUTE_UNUSED,
937 aarch64_opnd_info *info,
938 const aarch64_insn code, const aarch64_inst *inst,
939 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
944 info->reg.regno = extract_field (FLD_Rt, code, 0);
947 value = extract_field (FLD_ldst_size, code, 0);
948 if (inst->opcode->iclass == ldstpair_indexed
949 || inst->opcode->iclass == ldstnapair_offs
950 || inst->opcode->iclass == ldstpair_off
951 || inst->opcode->iclass == loadlit)
953 enum aarch64_opnd_qualifier qualifier;
956 case 0: qualifier = AARCH64_OPND_QLF_S_S; break;
957 case 1: qualifier = AARCH64_OPND_QLF_S_D; break;
958 case 2: qualifier = AARCH64_OPND_QLF_S_Q; break;
959 default: return FALSE;
961 info->qualifier = qualifier;
966 value = extract_fields (code, 0, 2, FLD_opc1, FLD_ldst_size);
969 info->qualifier = get_sreg_qualifier_from_value (value);
975 /* Decode the address operand for e.g. STXRB <Ws>, <Wt>, [<Xn|SP>{,#0}]. */
977 aarch64_ext_addr_simple (const aarch64_operand *self ATTRIBUTE_UNUSED,
978 aarch64_opnd_info *info,
980 const aarch64_inst *inst ATTRIBUTE_UNUSED,
981 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
984 info->addr.base_regno = extract_field (FLD_Rn, code, 0);
990 /* Decode the address operand for e.g. STGV <Xt>, [<Xn|SP>]!. */
992 aarch64_ext_addr_simple_2 (const aarch64_operand *self ATTRIBUTE_UNUSED,
993 aarch64_opnd_info *info,
995 const aarch64_inst *inst ATTRIBUTE_UNUSED,
996 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
999 info->addr.base_regno = extract_field (FLD_Rn, code, 0);
1000 info->addr.writeback = 1;
1001 info->addr.preind = 1;
1005 /* Decode the address operand for e.g.
1006 stlur <Xt>, [<Xn|SP>{, <amount>}]. */
1008 aarch64_ext_addr_offset (const aarch64_operand *self ATTRIBUTE_UNUSED,
1009 aarch64_opnd_info *info,
1010 aarch64_insn code, const aarch64_inst *inst,
1011 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1013 info->qualifier = get_expected_qualifier (inst, info->idx);
1016 info->addr.base_regno = extract_field (self->fields[0], code, 0);
1019 aarch64_insn imm = extract_fields (code, 0, 1, self->fields[1]);
1020 info->addr.offset.imm = sign_extend (imm, 8);
1021 if (extract_field (self->fields[2], code, 0) == 1) {
1022 info->addr.writeback = 1;
1023 info->addr.preind = 1;
1028 /* Decode the address operand for e.g.
1029 STR <Qt>, [<Xn|SP>, <R><m>{, <extend> {<amount>}}]. */
1031 aarch64_ext_addr_regoff (const aarch64_operand *self ATTRIBUTE_UNUSED,
1032 aarch64_opnd_info *info,
1033 aarch64_insn code, const aarch64_inst *inst,
1034 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1036 aarch64_insn S, value;
1039 info->addr.base_regno = extract_field (FLD_Rn, code, 0);
1041 info->addr.offset.regno = extract_field (FLD_Rm, code, 0);
1043 value = extract_field (FLD_option, code, 0);
1044 info->shifter.kind =
1045 aarch64_get_operand_modifier_from_value (value, TRUE /* extend_p */);
1046 /* Fix-up the shifter kind; although the table-driven approach is
1047 efficient, it is slightly inflexible, thus needing this fix-up. */
1048 if (info->shifter.kind == AARCH64_MOD_UXTX)
1049 info->shifter.kind = AARCH64_MOD_LSL;
1051 S = extract_field (FLD_S, code, 0);
1054 info->shifter.amount = 0;
1055 info->shifter.amount_present = 0;
1060 /* Need information in other operand(s) to help achieve the decoding
1062 info->qualifier = get_expected_qualifier (inst, info->idx);
1063 /* Get the size of the data element that is accessed, which may be
1064 different from that of the source register size, e.g. in strb/ldrb. */
1065 size = aarch64_get_qualifier_esize (info->qualifier);
1066 info->shifter.amount = get_logsz (size);
1067 info->shifter.amount_present = 1;
1073 /* Decode the address operand for e.g. LDRSW <Xt>, [<Xn|SP>], #<simm>. */
1075 aarch64_ext_addr_simm (const aarch64_operand *self, aarch64_opnd_info *info,
1076 aarch64_insn code, const aarch64_inst *inst,
1077 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1080 info->qualifier = get_expected_qualifier (inst, info->idx);
1083 info->addr.base_regno = extract_field (FLD_Rn, code, 0);
1084 /* simm (imm9 or imm7) */
1085 imm = extract_field (self->fields[0], code, 0);
1086 info->addr.offset.imm = sign_extend (imm, fields[self->fields[0]].width - 1);
1087 if (self->fields[0] == FLD_imm7
1088 || info->qualifier == AARCH64_OPND_QLF_imm_tag)
1089 /* scaled immediate in ld/st pair instructions. */
1090 info->addr.offset.imm *= aarch64_get_qualifier_esize (info->qualifier);
1092 if (inst->opcode->iclass == ldst_unscaled
1093 || inst->opcode->iclass == ldstnapair_offs
1094 || inst->opcode->iclass == ldstpair_off
1095 || inst->opcode->iclass == ldst_unpriv)
1096 info->addr.writeback = 0;
1099 /* pre/post- index */
1100 info->addr.writeback = 1;
1101 if (extract_field (self->fields[1], code, 0) == 1)
1102 info->addr.preind = 1;
1104 info->addr.postind = 1;
1110 /* Decode the address operand for e.g. LDRSW <Xt>, [<Xn|SP>{, #<simm>}]. */
1112 aarch64_ext_addr_uimm12 (const aarch64_operand *self, aarch64_opnd_info *info,
1114 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1115 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1118 info->qualifier = get_expected_qualifier (inst, info->idx);
1119 shift = get_logsz (aarch64_get_qualifier_esize (info->qualifier));
1121 info->addr.base_regno = extract_field (self->fields[0], code, 0);
1123 info->addr.offset.imm = extract_field (self->fields[1], code, 0) << shift;
1127 /* Decode the address operand for e.g. LDRAA <Xt>, [<Xn|SP>{, #<simm>}]. */
1129 aarch64_ext_addr_simm10 (const aarch64_operand *self, aarch64_opnd_info *info,
1131 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1132 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1136 info->qualifier = get_expected_qualifier (inst, info->idx);
1138 info->addr.base_regno = extract_field (self->fields[0], code, 0);
1140 imm = extract_fields (code, 0, 2, self->fields[1], self->fields[2]);
1141 info->addr.offset.imm = sign_extend (imm, 9) << 3;
1142 if (extract_field (self->fields[3], code, 0) == 1) {
1143 info->addr.writeback = 1;
1144 info->addr.preind = 1;
1149 /* Decode the address operand for e.g.
1150 LD1 {<Vt>.<T>, <Vt2>.<T>, <Vt3>.<T>}, [<Xn|SP>], <Xm|#<amount>>. */
1152 aarch64_ext_simd_addr_post (const aarch64_operand *self ATTRIBUTE_UNUSED,
1153 aarch64_opnd_info *info,
1154 aarch64_insn code, const aarch64_inst *inst,
1155 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1157 /* The opcode dependent area stores the number of elements in
1158 each structure to be loaded/stored. */
1159 int is_ld1r = get_opcode_dependent_value (inst->opcode) == 1;
1162 info->addr.base_regno = extract_field (FLD_Rn, code, 0);
1163 /* Rm | #<amount> */
1164 info->addr.offset.regno = extract_field (FLD_Rm, code, 0);
1165 if (info->addr.offset.regno == 31)
1167 if (inst->opcode->operands[0] == AARCH64_OPND_LVt_AL)
1168 /* Special handling of loading single structure to all lane. */
1169 info->addr.offset.imm = (is_ld1r ? 1
1170 : inst->operands[0].reglist.num_regs)
1171 * aarch64_get_qualifier_esize (inst->operands[0].qualifier);
1173 info->addr.offset.imm = inst->operands[0].reglist.num_regs
1174 * aarch64_get_qualifier_esize (inst->operands[0].qualifier)
1175 * aarch64_get_qualifier_nelem (inst->operands[0].qualifier);
1178 info->addr.offset.is_reg = 1;
1179 info->addr.writeback = 1;
1184 /* Decode the condition operand for e.g. CSEL <Xd>, <Xn>, <Xm>, <cond>. */
1186 aarch64_ext_cond (const aarch64_operand *self ATTRIBUTE_UNUSED,
1187 aarch64_opnd_info *info,
1188 aarch64_insn code, const aarch64_inst *inst ATTRIBUTE_UNUSED,
1189 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1193 value = extract_field (FLD_cond, code, 0);
1194 info->cond = get_cond_from_value (value);
1198 /* Decode the system register operand for e.g. MRS <Xt>, <systemreg>. */
1200 aarch64_ext_sysreg (const aarch64_operand *self ATTRIBUTE_UNUSED,
1201 aarch64_opnd_info *info,
1203 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1204 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1206 /* op0:op1:CRn:CRm:op2 */
1207 info->sysreg.value = extract_fields (code, 0, 5, FLD_op0, FLD_op1, FLD_CRn,
1209 info->sysreg.flags = 0;
1211 /* If a system instruction, check which restrictions should be on the register
1212 value during decoding, these will be enforced then. */
1213 if (inst->opcode->iclass == ic_system)
1215 /* Check to see if it's read-only, else check if it's write only.
1216 if it's both or unspecified don't care. */
1217 if ((inst->opcode->flags & (F_SYS_READ | F_SYS_WRITE)) == F_SYS_READ)
1218 info->sysreg.flags = F_REG_READ;
1219 else if ((inst->opcode->flags & (F_SYS_READ | F_SYS_WRITE))
1221 info->sysreg.flags = F_REG_WRITE;
1227 /* Decode the PSTATE field operand for e.g. MSR <pstatefield>, #<imm>. */
1229 aarch64_ext_pstatefield (const aarch64_operand *self ATTRIBUTE_UNUSED,
1230 aarch64_opnd_info *info, aarch64_insn code,
1231 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1232 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1236 info->pstatefield = extract_fields (code, 0, 2, FLD_op1, FLD_op2);
1237 for (i = 0; aarch64_pstatefields[i].name != NULL; ++i)
1238 if (aarch64_pstatefields[i].value == (aarch64_insn)info->pstatefield)
1240 /* Reserved value in <pstatefield>. */
1244 /* Decode the system instruction op operand for e.g. AT <at_op>, <Xt>. */
1246 aarch64_ext_sysins_op (const aarch64_operand *self ATTRIBUTE_UNUSED,
1247 aarch64_opnd_info *info,
1249 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1250 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1254 const aarch64_sys_ins_reg *sysins_ops;
1255 /* op0:op1:CRn:CRm:op2 */
1256 value = extract_fields (code, 0, 5,
1257 FLD_op0, FLD_op1, FLD_CRn,
1262 case AARCH64_OPND_SYSREG_AT: sysins_ops = aarch64_sys_regs_at; break;
1263 case AARCH64_OPND_SYSREG_DC: sysins_ops = aarch64_sys_regs_dc; break;
1264 case AARCH64_OPND_SYSREG_IC: sysins_ops = aarch64_sys_regs_ic; break;
1265 case AARCH64_OPND_SYSREG_TLBI: sysins_ops = aarch64_sys_regs_tlbi; break;
1266 case AARCH64_OPND_SYSREG_SR:
1267 sysins_ops = aarch64_sys_regs_sr;
1268 /* Let's remove op2 for rctx. Refer to comments in the definition of
1269 aarch64_sys_regs_sr[]. */
1270 value = value & ~(0x7);
1272 default: assert (0); return FALSE;
1275 for (i = 0; sysins_ops[i].name != NULL; ++i)
1276 if (sysins_ops[i].value == value)
1278 info->sysins_op = sysins_ops + i;
1279 DEBUG_TRACE ("%s found value: %x, has_xt: %d, i: %d.",
1280 info->sysins_op->name,
1281 (unsigned)info->sysins_op->value,
1282 aarch64_sys_ins_reg_has_xt (info->sysins_op), i);
1289 /* Decode the memory barrier option operand for e.g. DMB <option>|#<imm>. */
1292 aarch64_ext_barrier (const aarch64_operand *self ATTRIBUTE_UNUSED,
1293 aarch64_opnd_info *info,
1295 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1296 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1299 info->barrier = aarch64_barrier_options + extract_field (FLD_CRm, code, 0);
1303 /* Decode the prefetch operation option operand for e.g.
1304 PRFM <prfop>, [<Xn|SP>{, #<pimm>}]. */
1307 aarch64_ext_prfop (const aarch64_operand *self ATTRIBUTE_UNUSED,
1308 aarch64_opnd_info *info,
1309 aarch64_insn code, const aarch64_inst *inst ATTRIBUTE_UNUSED,
1310 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1313 info->prfop = aarch64_prfops + extract_field (FLD_Rt, code, 0);
1317 /* Decode the hint number for an alias taking an operand. Set info->hint_option
1318 to the matching name/value pair in aarch64_hint_options. */
1321 aarch64_ext_hint (const aarch64_operand *self ATTRIBUTE_UNUSED,
1322 aarch64_opnd_info *info,
1324 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1325 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1328 unsigned hint_number;
1331 hint_number = extract_fields (code, 0, 2, FLD_CRm, FLD_op2);
1333 for (i = 0; aarch64_hint_options[i].name != NULL; i++)
1335 if (hint_number == HINT_VAL (aarch64_hint_options[i].value))
1337 info->hint_option = &(aarch64_hint_options[i]);
1345 /* Decode the extended register operand for e.g.
1346 STR <Qt>, [<Xn|SP>, <R><m>{, <extend> {<amount>}}]. */
1348 aarch64_ext_reg_extended (const aarch64_operand *self ATTRIBUTE_UNUSED,
1349 aarch64_opnd_info *info,
1351 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1352 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1357 info->reg.regno = extract_field (FLD_Rm, code, 0);
1359 value = extract_field (FLD_option, code, 0);
1360 info->shifter.kind =
1361 aarch64_get_operand_modifier_from_value (value, TRUE /* extend_p */);
1363 info->shifter.amount = extract_field (FLD_imm3, code, 0);
1365 /* This makes the constraint checking happy. */
1366 info->shifter.operator_present = 1;
1368 /* Assume inst->operands[0].qualifier has been resolved. */
1369 assert (inst->operands[0].qualifier != AARCH64_OPND_QLF_NIL);
1370 info->qualifier = AARCH64_OPND_QLF_W;
1371 if (inst->operands[0].qualifier == AARCH64_OPND_QLF_X
1372 && (info->shifter.kind == AARCH64_MOD_UXTX
1373 || info->shifter.kind == AARCH64_MOD_SXTX))
1374 info->qualifier = AARCH64_OPND_QLF_X;
1379 /* Decode the shifted register operand for e.g.
1380 SUBS <Xd>, <Xn>, <Xm> {, <shift> #<amount>}. */
1382 aarch64_ext_reg_shifted (const aarch64_operand *self ATTRIBUTE_UNUSED,
1383 aarch64_opnd_info *info,
1385 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1386 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1391 info->reg.regno = extract_field (FLD_Rm, code, 0);
1393 value = extract_field (FLD_shift, code, 0);
1394 info->shifter.kind =
1395 aarch64_get_operand_modifier_from_value (value, FALSE /* extend_p */);
1396 if (info->shifter.kind == AARCH64_MOD_ROR
1397 && inst->opcode->iclass != log_shift)
1398 /* ROR is not available for the shifted register operand in arithmetic
1402 info->shifter.amount = extract_field (FLD_imm6, code, 0);
1404 /* This makes the constraint checking happy. */
1405 info->shifter.operator_present = 1;
1410 /* Decode an SVE address [<base>, #<offset>*<factor>, MUL VL],
1411 where <offset> is given by the OFFSET parameter and where <factor> is
1412 1 plus SELF's operand-dependent value. fields[0] specifies the field
1413 that holds <base>. */
1415 aarch64_ext_sve_addr_reg_mul_vl (const aarch64_operand *self,
1416 aarch64_opnd_info *info, aarch64_insn code,
1419 info->addr.base_regno = extract_field (self->fields[0], code, 0);
1420 info->addr.offset.imm = offset * (1 + get_operand_specific_data (self));
1421 info->addr.offset.is_reg = FALSE;
1422 info->addr.writeback = FALSE;
1423 info->addr.preind = TRUE;
1425 info->shifter.kind = AARCH64_MOD_MUL_VL;
1426 info->shifter.amount = 1;
1427 info->shifter.operator_present = (info->addr.offset.imm != 0);
1428 info->shifter.amount_present = FALSE;
1432 /* Decode an SVE address [<base>, #<simm4>*<factor>, MUL VL],
1433 where <simm4> is a 4-bit signed value and where <factor> is 1 plus
1434 SELF's operand-dependent value. fields[0] specifies the field that
1435 holds <base>. <simm4> is encoded in the SVE_imm4 field. */
1437 aarch64_ext_sve_addr_ri_s4xvl (const aarch64_operand *self,
1438 aarch64_opnd_info *info, aarch64_insn code,
1439 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1440 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1444 offset = extract_field (FLD_SVE_imm4, code, 0);
1445 offset = ((offset + 8) & 15) - 8;
1446 return aarch64_ext_sve_addr_reg_mul_vl (self, info, code, offset);
1449 /* Decode an SVE address [<base>, #<simm6>*<factor>, MUL VL],
1450 where <simm6> is a 6-bit signed value and where <factor> is 1 plus
1451 SELF's operand-dependent value. fields[0] specifies the field that
1452 holds <base>. <simm6> is encoded in the SVE_imm6 field. */
1454 aarch64_ext_sve_addr_ri_s6xvl (const aarch64_operand *self,
1455 aarch64_opnd_info *info, aarch64_insn code,
1456 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1457 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1461 offset = extract_field (FLD_SVE_imm6, code, 0);
1462 offset = (((offset + 32) & 63) - 32);
1463 return aarch64_ext_sve_addr_reg_mul_vl (self, info, code, offset);
1466 /* Decode an SVE address [<base>, #<simm9>*<factor>, MUL VL],
1467 where <simm9> is a 9-bit signed value and where <factor> is 1 plus
1468 SELF's operand-dependent value. fields[0] specifies the field that
1469 holds <base>. <simm9> is encoded in the concatenation of the SVE_imm6
1470 and imm3 fields, with imm3 being the less-significant part. */
1472 aarch64_ext_sve_addr_ri_s9xvl (const aarch64_operand *self,
1473 aarch64_opnd_info *info,
1475 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1476 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1480 offset = extract_fields (code, 0, 2, FLD_SVE_imm6, FLD_imm3);
1481 offset = (((offset + 256) & 511) - 256);
1482 return aarch64_ext_sve_addr_reg_mul_vl (self, info, code, offset);
1485 /* Decode an SVE address [<base>, #<offset> << <shift>], where <offset>
1486 is given by the OFFSET parameter and where <shift> is SELF's operand-
1487 dependent value. fields[0] specifies the base register field <base>. */
1489 aarch64_ext_sve_addr_reg_imm (const aarch64_operand *self,
1490 aarch64_opnd_info *info, aarch64_insn code,
1493 info->addr.base_regno = extract_field (self->fields[0], code, 0);
1494 info->addr.offset.imm = offset * (1 << get_operand_specific_data (self));
1495 info->addr.offset.is_reg = FALSE;
1496 info->addr.writeback = FALSE;
1497 info->addr.preind = TRUE;
1498 info->shifter.operator_present = FALSE;
1499 info->shifter.amount_present = FALSE;
1503 /* Decode an SVE address [X<n>, #<SVE_imm4> << <shift>], where <SVE_imm4>
1504 is a 4-bit signed number and where <shift> is SELF's operand-dependent
1505 value. fields[0] specifies the base register field. */
1507 aarch64_ext_sve_addr_ri_s4 (const aarch64_operand *self,
1508 aarch64_opnd_info *info, aarch64_insn code,
1509 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1510 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1512 int offset = sign_extend (extract_field (FLD_SVE_imm4, code, 0), 3);
1513 return aarch64_ext_sve_addr_reg_imm (self, info, code, offset);
1516 /* Decode an SVE address [X<n>, #<SVE_imm6> << <shift>], where <SVE_imm6>
1517 is a 6-bit unsigned number and where <shift> is SELF's operand-dependent
1518 value. fields[0] specifies the base register field. */
1520 aarch64_ext_sve_addr_ri_u6 (const aarch64_operand *self,
1521 aarch64_opnd_info *info, aarch64_insn code,
1522 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1523 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1525 int offset = extract_field (FLD_SVE_imm6, code, 0);
1526 return aarch64_ext_sve_addr_reg_imm (self, info, code, offset);
1529 /* Decode an SVE address [X<n>, X<m>{, LSL #<shift>}], where <shift>
1530 is SELF's operand-dependent value. fields[0] specifies the base
1531 register field and fields[1] specifies the offset register field. */
1533 aarch64_ext_sve_addr_rr_lsl (const aarch64_operand *self,
1534 aarch64_opnd_info *info, aarch64_insn code,
1535 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1536 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1540 index_regno = extract_field (self->fields[1], code, 0);
1541 if (index_regno == 31 && (self->flags & OPD_F_NO_ZR) != 0)
1544 info->addr.base_regno = extract_field (self->fields[0], code, 0);
1545 info->addr.offset.regno = index_regno;
1546 info->addr.offset.is_reg = TRUE;
1547 info->addr.writeback = FALSE;
1548 info->addr.preind = TRUE;
1549 info->shifter.kind = AARCH64_MOD_LSL;
1550 info->shifter.amount = get_operand_specific_data (self);
1551 info->shifter.operator_present = (info->shifter.amount != 0);
1552 info->shifter.amount_present = (info->shifter.amount != 0);
1556 /* Decode an SVE address [X<n>, Z<m>.<T>, (S|U)XTW {#<shift>}], where
1557 <shift> is SELF's operand-dependent value. fields[0] specifies the
1558 base register field, fields[1] specifies the offset register field and
1559 fields[2] is a single-bit field that selects SXTW over UXTW. */
1561 aarch64_ext_sve_addr_rz_xtw (const aarch64_operand *self,
1562 aarch64_opnd_info *info, aarch64_insn code,
1563 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1564 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1566 info->addr.base_regno = extract_field (self->fields[0], code, 0);
1567 info->addr.offset.regno = extract_field (self->fields[1], code, 0);
1568 info->addr.offset.is_reg = TRUE;
1569 info->addr.writeback = FALSE;
1570 info->addr.preind = TRUE;
1571 if (extract_field (self->fields[2], code, 0))
1572 info->shifter.kind = AARCH64_MOD_SXTW;
1574 info->shifter.kind = AARCH64_MOD_UXTW;
1575 info->shifter.amount = get_operand_specific_data (self);
1576 info->shifter.operator_present = TRUE;
1577 info->shifter.amount_present = (info->shifter.amount != 0);
1581 /* Decode an SVE address [Z<n>.<T>, #<imm5> << <shift>], where <imm5> is a
1582 5-bit unsigned number and where <shift> is SELF's operand-dependent value.
1583 fields[0] specifies the base register field. */
1585 aarch64_ext_sve_addr_zi_u5 (const aarch64_operand *self,
1586 aarch64_opnd_info *info, aarch64_insn code,
1587 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1588 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1590 int offset = extract_field (FLD_imm5, code, 0);
1591 return aarch64_ext_sve_addr_reg_imm (self, info, code, offset);
1594 /* Decode an SVE address [Z<n>.<T>, Z<m>.<T>{, <modifier> {#<msz>}}],
1595 where <modifier> is given by KIND and where <msz> is a 2-bit unsigned
1596 number. fields[0] specifies the base register field and fields[1]
1597 specifies the offset register field. */
1599 aarch64_ext_sve_addr_zz (const aarch64_operand *self, aarch64_opnd_info *info,
1600 aarch64_insn code, enum aarch64_modifier_kind kind)
1602 info->addr.base_regno = extract_field (self->fields[0], code, 0);
1603 info->addr.offset.regno = extract_field (self->fields[1], code, 0);
1604 info->addr.offset.is_reg = TRUE;
1605 info->addr.writeback = FALSE;
1606 info->addr.preind = TRUE;
1607 info->shifter.kind = kind;
1608 info->shifter.amount = extract_field (FLD_SVE_msz, code, 0);
1609 info->shifter.operator_present = (kind != AARCH64_MOD_LSL
1610 || info->shifter.amount != 0);
1611 info->shifter.amount_present = (info->shifter.amount != 0);
1615 /* Decode an SVE address [Z<n>.<T>, Z<m>.<T>{, LSL #<msz>}], where
1616 <msz> is a 2-bit unsigned number. fields[0] specifies the base register
1617 field and fields[1] specifies the offset register field. */
1619 aarch64_ext_sve_addr_zz_lsl (const aarch64_operand *self,
1620 aarch64_opnd_info *info, aarch64_insn code,
1621 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1622 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1624 return aarch64_ext_sve_addr_zz (self, info, code, AARCH64_MOD_LSL);
1627 /* Decode an SVE address [Z<n>.<T>, Z<m>.<T>, SXTW {#<msz>}], where
1628 <msz> is a 2-bit unsigned number. fields[0] specifies the base register
1629 field and fields[1] specifies the offset register field. */
1631 aarch64_ext_sve_addr_zz_sxtw (const aarch64_operand *self,
1632 aarch64_opnd_info *info, aarch64_insn code,
1633 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1634 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1636 return aarch64_ext_sve_addr_zz (self, info, code, AARCH64_MOD_SXTW);
1639 /* Decode an SVE address [Z<n>.<T>, Z<m>.<T>, UXTW {#<msz>}], where
1640 <msz> is a 2-bit unsigned number. fields[0] specifies the base register
1641 field and fields[1] specifies the offset register field. */
1643 aarch64_ext_sve_addr_zz_uxtw (const aarch64_operand *self,
1644 aarch64_opnd_info *info, aarch64_insn code,
1645 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1646 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1648 return aarch64_ext_sve_addr_zz (self, info, code, AARCH64_MOD_UXTW);
1651 /* Finish decoding an SVE arithmetic immediate, given that INFO already
1652 has the raw field value and that the low 8 bits decode to VALUE. */
1654 decode_sve_aimm (aarch64_opnd_info *info, int64_t value)
1656 info->shifter.kind = AARCH64_MOD_LSL;
1657 info->shifter.amount = 0;
1658 if (info->imm.value & 0x100)
1661 /* Decode 0x100 as #0, LSL #8. */
1662 info->shifter.amount = 8;
1666 info->shifter.operator_present = (info->shifter.amount != 0);
1667 info->shifter.amount_present = (info->shifter.amount != 0);
1668 info->imm.value = value;
1672 /* Decode an SVE ADD/SUB immediate. */
1674 aarch64_ext_sve_aimm (const aarch64_operand *self,
1675 aarch64_opnd_info *info, const aarch64_insn code,
1676 const aarch64_inst *inst,
1677 aarch64_operand_error *errors)
1679 return (aarch64_ext_imm (self, info, code, inst, errors)
1680 && decode_sve_aimm (info, (uint8_t) info->imm.value));
1683 /* Decode an SVE CPY/DUP immediate. */
1685 aarch64_ext_sve_asimm (const aarch64_operand *self,
1686 aarch64_opnd_info *info, const aarch64_insn code,
1687 const aarch64_inst *inst,
1688 aarch64_operand_error *errors)
1690 return (aarch64_ext_imm (self, info, code, inst, errors)
1691 && decode_sve_aimm (info, (int8_t) info->imm.value));
1694 /* Decode a single-bit immediate that selects between #0.5 and #1.0.
1695 The fields array specifies which field to use. */
1697 aarch64_ext_sve_float_half_one (const aarch64_operand *self,
1698 aarch64_opnd_info *info, aarch64_insn code,
1699 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1700 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1702 if (extract_field (self->fields[0], code, 0))
1703 info->imm.value = 0x3f800000;
1705 info->imm.value = 0x3f000000;
1706 info->imm.is_fp = TRUE;
1710 /* Decode a single-bit immediate that selects between #0.5 and #2.0.
1711 The fields array specifies which field to use. */
1713 aarch64_ext_sve_float_half_two (const aarch64_operand *self,
1714 aarch64_opnd_info *info, aarch64_insn code,
1715 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1716 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1718 if (extract_field (self->fields[0], code, 0))
1719 info->imm.value = 0x40000000;
1721 info->imm.value = 0x3f000000;
1722 info->imm.is_fp = TRUE;
1726 /* Decode a single-bit immediate that selects between #0.0 and #1.0.
1727 The fields array specifies which field to use. */
1729 aarch64_ext_sve_float_zero_one (const aarch64_operand *self,
1730 aarch64_opnd_info *info, aarch64_insn code,
1731 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1732 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1734 if (extract_field (self->fields[0], code, 0))
1735 info->imm.value = 0x3f800000;
1737 info->imm.value = 0x0;
1738 info->imm.is_fp = TRUE;
1742 /* Decode Zn[MM], where MM has a 7-bit triangular encoding. The fields
1743 array specifies which field to use for Zn. MM is encoded in the
1744 concatenation of imm5 and SVE_tszh, with imm5 being the less
1745 significant part. */
1747 aarch64_ext_sve_index (const aarch64_operand *self,
1748 aarch64_opnd_info *info, aarch64_insn code,
1749 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1750 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1754 info->reglane.regno = extract_field (self->fields[0], code, 0);
1755 val = extract_fields (code, 0, 2, FLD_SVE_tszh, FLD_imm5);
1756 if ((val & 31) == 0)
1758 while ((val & 1) == 0)
1760 info->reglane.index = val / 2;
1764 /* Decode a logical immediate for the MOV alias of SVE DUPM. */
1766 aarch64_ext_sve_limm_mov (const aarch64_operand *self,
1767 aarch64_opnd_info *info, const aarch64_insn code,
1768 const aarch64_inst *inst,
1769 aarch64_operand_error *errors)
1771 int esize = aarch64_get_qualifier_esize (inst->operands[0].qualifier);
1772 return (aarch64_ext_limm (self, info, code, inst, errors)
1773 && aarch64_sve_dupm_mov_immediate_p (info->imm.value, esize));
1776 /* Decode Zn[MM], where Zn occupies the least-significant part of the field
1777 and where MM occupies the most-significant part. The operand-dependent
1778 value specifies the number of bits in Zn. */
1780 aarch64_ext_sve_quad_index (const aarch64_operand *self,
1781 aarch64_opnd_info *info, aarch64_insn code,
1782 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1783 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1785 unsigned int reg_bits = get_operand_specific_data (self);
1786 unsigned int val = extract_all_fields (self, code);
1787 info->reglane.regno = val & ((1 << reg_bits) - 1);
1788 info->reglane.index = val >> reg_bits;
1792 /* Decode {Zn.<T> - Zm.<T>}. The fields array specifies which field
1793 to use for Zn. The opcode-dependent value specifies the number
1794 of registers in the list. */
1796 aarch64_ext_sve_reglist (const aarch64_operand *self,
1797 aarch64_opnd_info *info, aarch64_insn code,
1798 const aarch64_inst *inst ATTRIBUTE_UNUSED,
1799 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
1801 info->reglist.first_regno = extract_field (self->fields[0], code, 0);
1802 info->reglist.num_regs = get_opcode_dependent_value (inst->opcode);
1806 /* Decode <pattern>{, MUL #<amount>}. The fields array specifies which
1807 fields to use for <pattern>. <amount> - 1 is encoded in the SVE_imm4
1810 aarch64_ext_sve_scale (const aarch64_operand *self,
1811 aarch64_opnd_info *info, aarch64_insn code,
1812 const aarch64_inst *inst, aarch64_operand_error *errors)
1816 if (!aarch64_ext_imm (self, info, code, inst, errors))
1818 val = extract_field (FLD_SVE_imm4, code, 0);
1819 info->shifter.kind = AARCH64_MOD_MUL;
1820 info->shifter.amount = val + 1;
1821 info->shifter.operator_present = (val != 0);
1822 info->shifter.amount_present = (val != 0);
1826 /* Return the top set bit in VALUE, which is expected to be relatively
1829 get_top_bit (uint64_t value)
1831 while ((value & -value) != value)
1832 value -= value & -value;
1836 /* Decode an SVE shift-left immediate. */
1838 aarch64_ext_sve_shlimm (const aarch64_operand *self,
1839 aarch64_opnd_info *info, const aarch64_insn code,
1840 const aarch64_inst *inst, aarch64_operand_error *errors)
1842 if (!aarch64_ext_imm (self, info, code, inst, errors)
1843 || info->imm.value == 0)
1846 info->imm.value -= get_top_bit (info->imm.value);
1850 /* Decode an SVE shift-right immediate. */
1852 aarch64_ext_sve_shrimm (const aarch64_operand *self,
1853 aarch64_opnd_info *info, const aarch64_insn code,
1854 const aarch64_inst *inst, aarch64_operand_error *errors)
1856 if (!aarch64_ext_imm (self, info, code, inst, errors)
1857 || info->imm.value == 0)
1860 info->imm.value = get_top_bit (info->imm.value) * 2 - info->imm.value;
1864 /* Bitfields that are commonly used to encode certain operands' information
1865 may be partially used as part of the base opcode in some instructions.
1866 For example, the bit 1 of the field 'size' in
1867 FCVTXN <Vb><d>, <Va><n>
1868 is actually part of the base opcode, while only size<0> is available
1869 for encoding the register type. Another example is the AdvSIMD
1870 instruction ORR (register), in which the field 'size' is also used for
1871 the base opcode, leaving only the field 'Q' available to encode the
1872 vector register arrangement specifier '8B' or '16B'.
1874 This function tries to deduce the qualifier from the value of partially
1875 constrained field(s). Given the VALUE of such a field or fields, the
1876 qualifiers CANDIDATES and the MASK (indicating which bits are valid for
1877 operand encoding), the function returns the matching qualifier or
1878 AARCH64_OPND_QLF_NIL if nothing matches.
1880 N.B. CANDIDATES is a group of possible qualifiers that are valid for
1881 one operand; it has a maximum of AARCH64_MAX_QLF_SEQ_NUM qualifiers and
1882 may end with AARCH64_OPND_QLF_NIL. */
1884 static enum aarch64_opnd_qualifier
1885 get_qualifier_from_partial_encoding (aarch64_insn value,
1886 const enum aarch64_opnd_qualifier* \
1891 DEBUG_TRACE ("enter with value: %d, mask: %d", (int)value, (int)mask);
1892 for (i = 0; i < AARCH64_MAX_QLF_SEQ_NUM; ++i)
1894 aarch64_insn standard_value;
1895 if (candidates[i] == AARCH64_OPND_QLF_NIL)
1897 standard_value = aarch64_get_qualifier_standard_value (candidates[i]);
1898 if ((standard_value & mask) == (value & mask))
1899 return candidates[i];
1901 return AARCH64_OPND_QLF_NIL;
1904 /* Given a list of qualifier sequences, return all possible valid qualifiers
1905 for operand IDX in QUALIFIERS.
1906 Assume QUALIFIERS is an array whose length is large enough. */
1909 get_operand_possible_qualifiers (int idx,
1910 const aarch64_opnd_qualifier_seq_t *list,
1911 enum aarch64_opnd_qualifier *qualifiers)
1914 for (i = 0; i < AARCH64_MAX_QLF_SEQ_NUM; ++i)
1915 if ((qualifiers[i] = list[i][idx]) == AARCH64_OPND_QLF_NIL)
1919 /* Decode the size Q field for e.g. SHADD.
1920 We tag one operand with the qualifer according to the code;
1921 whether the qualifier is valid for this opcode or not, it is the
1922 duty of the semantic checking. */
1925 decode_sizeq (aarch64_inst *inst)
1928 enum aarch64_opnd_qualifier qualifier;
1930 aarch64_insn value, mask;
1931 enum aarch64_field_kind fld_sz;
1932 enum aarch64_opnd_qualifier candidates[AARCH64_MAX_QLF_SEQ_NUM];
1934 if (inst->opcode->iclass == asisdlse
1935 || inst->opcode->iclass == asisdlsep
1936 || inst->opcode->iclass == asisdlso
1937 || inst->opcode->iclass == asisdlsop)
1938 fld_sz = FLD_vldst_size;
1943 value = extract_fields (code, inst->opcode->mask, 2, fld_sz, FLD_Q);
1944 /* Obtain the info that which bits of fields Q and size are actually
1945 available for operand encoding. Opcodes like FMAXNM and FMLA have
1946 size[1] unavailable. */
1947 mask = extract_fields (~inst->opcode->mask, 0, 2, fld_sz, FLD_Q);
1949 /* The index of the operand we are going to tag a qualifier and the qualifer
1950 itself are reasoned from the value of the size and Q fields and the
1951 possible valid qualifier lists. */
1952 idx = aarch64_select_operand_for_sizeq_field_coding (inst->opcode);
1953 DEBUG_TRACE ("key idx: %d", idx);
1955 /* For most related instruciton, size:Q are fully available for operand
1959 inst->operands[idx].qualifier = get_vreg_qualifier_from_value (value);
1963 get_operand_possible_qualifiers (idx, inst->opcode->qualifiers_list,
1965 #ifdef DEBUG_AARCH64
1969 for (i = 0; candidates[i] != AARCH64_OPND_QLF_NIL
1970 && i < AARCH64_MAX_QLF_SEQ_NUM; ++i)
1971 DEBUG_TRACE ("qualifier %d: %s", i,
1972 aarch64_get_qualifier_name(candidates[i]));
1973 DEBUG_TRACE ("%d, %d", (int)value, (int)mask);
1975 #endif /* DEBUG_AARCH64 */
1977 qualifier = get_qualifier_from_partial_encoding (value, candidates, mask);
1979 if (qualifier == AARCH64_OPND_QLF_NIL)
1982 inst->operands[idx].qualifier = qualifier;
1986 /* Decode size[0]:Q, i.e. bit 22 and bit 30, for
1987 e.g. FCVTN<Q> <Vd>.<Tb>, <Vn>.<Ta>. */
1990 decode_asimd_fcvt (aarch64_inst *inst)
1992 aarch64_field field = {0, 0};
1994 enum aarch64_opnd_qualifier qualifier;
1996 gen_sub_field (FLD_size, 0, 1, &field);
1997 value = extract_field_2 (&field, inst->value, 0);
1998 qualifier = value == 0 ? AARCH64_OPND_QLF_V_4S
1999 : AARCH64_OPND_QLF_V_2D;
2000 switch (inst->opcode->op)
2004 /* FCVTN<Q> <Vd>.<Tb>, <Vn>.<Ta>. */
2005 inst->operands[1].qualifier = qualifier;
2009 /* FCVTL<Q> <Vd>.<Ta>, <Vn>.<Tb>. */
2010 inst->operands[0].qualifier = qualifier;
2020 /* Decode size[0], i.e. bit 22, for
2021 e.g. FCVTXN <Vb><d>, <Va><n>. */
2024 decode_asisd_fcvtxn (aarch64_inst *inst)
2026 aarch64_field field = {0, 0};
2027 gen_sub_field (FLD_size, 0, 1, &field);
2028 if (!extract_field_2 (&field, inst->value, 0))
2030 inst->operands[0].qualifier = AARCH64_OPND_QLF_S_S;
2034 /* Decode the 'opc' field for e.g. FCVT <Dd>, <Sn>. */
2036 decode_fcvt (aarch64_inst *inst)
2038 enum aarch64_opnd_qualifier qualifier;
2040 const aarch64_field field = {15, 2};
2043 value = extract_field_2 (&field, inst->value, 0);
2046 case 0: qualifier = AARCH64_OPND_QLF_S_S; break;
2047 case 1: qualifier = AARCH64_OPND_QLF_S_D; break;
2048 case 3: qualifier = AARCH64_OPND_QLF_S_H; break;
2051 inst->operands[0].qualifier = qualifier;
2056 /* Do miscellaneous decodings that are not common enough to be driven by
2060 do_misc_decoding (aarch64_inst *inst)
2063 switch (inst->opcode->op)
2066 return decode_fcvt (inst);
2072 return decode_asimd_fcvt (inst);
2075 return decode_asisd_fcvtxn (inst);
2079 value = extract_field (FLD_SVE_Pn, inst->value, 0);
2080 return (value == extract_field (FLD_SVE_Pm, inst->value, 0)
2081 && value == extract_field (FLD_SVE_Pg4_10, inst->value, 0));
2084 return (extract_field (FLD_SVE_Zd, inst->value, 0)
2085 == extract_field (FLD_SVE_Zm_16, inst->value, 0));
2088 /* Index must be zero. */
2089 value = extract_fields (inst->value, 0, 2, FLD_SVE_tszh, FLD_imm5);
2090 return value > 0 && value <= 16 && value == (value & -value);
2093 return (extract_field (FLD_SVE_Zn, inst->value, 0)
2094 == extract_field (FLD_SVE_Zm_16, inst->value, 0));
2097 /* Index must be nonzero. */
2098 value = extract_fields (inst->value, 0, 2, FLD_SVE_tszh, FLD_imm5);
2099 return value > 0 && value != (value & -value);
2102 return (extract_field (FLD_SVE_Pd, inst->value, 0)
2103 == extract_field (FLD_SVE_Pm, inst->value, 0));
2105 case OP_MOVZS_P_P_P:
2107 return (extract_field (FLD_SVE_Pn, inst->value, 0)
2108 == extract_field (FLD_SVE_Pm, inst->value, 0));
2110 case OP_NOTS_P_P_P_Z:
2111 case OP_NOT_P_P_P_Z:
2112 return (extract_field (FLD_SVE_Pm, inst->value, 0)
2113 == extract_field (FLD_SVE_Pg4_10, inst->value, 0));
2120 /* Opcodes that have fields shared by multiple operands are usually flagged
2121 with flags. In this function, we detect such flags, decode the related
2122 field(s) and store the information in one of the related operands. The
2123 'one' operand is not any operand but one of the operands that can
2124 accommadate all the information that has been decoded. */
2127 do_special_decoding (aarch64_inst *inst)
2131 /* Condition for truly conditional executed instructions, e.g. b.cond. */
2132 if (inst->opcode->flags & F_COND)
2134 value = extract_field (FLD_cond2, inst->value, 0);
2135 inst->cond = get_cond_from_value (value);
2138 if (inst->opcode->flags & F_SF)
2140 idx = select_operand_for_sf_field_coding (inst->opcode);
2141 value = extract_field (FLD_sf, inst->value, 0);
2142 inst->operands[idx].qualifier = get_greg_qualifier_from_value (value);
2143 if ((inst->opcode->flags & F_N)
2144 && extract_field (FLD_N, inst->value, 0) != value)
2148 if (inst->opcode->flags & F_LSE_SZ)
2150 idx = select_operand_for_sf_field_coding (inst->opcode);
2151 value = extract_field (FLD_lse_sz, inst->value, 0);
2152 inst->operands[idx].qualifier = get_greg_qualifier_from_value (value);
2154 /* size:Q fields. */
2155 if (inst->opcode->flags & F_SIZEQ)
2156 return decode_sizeq (inst);
2158 if (inst->opcode->flags & F_FPTYPE)
2160 idx = select_operand_for_fptype_field_coding (inst->opcode);
2161 value = extract_field (FLD_type, inst->value, 0);
2164 case 0: inst->operands[idx].qualifier = AARCH64_OPND_QLF_S_S; break;
2165 case 1: inst->operands[idx].qualifier = AARCH64_OPND_QLF_S_D; break;
2166 case 3: inst->operands[idx].qualifier = AARCH64_OPND_QLF_S_H; break;
2171 if (inst->opcode->flags & F_SSIZE)
2173 /* N.B. some opcodes like FCMGT <V><d>, <V><n>, #0 have the size[1] as part
2174 of the base opcode. */
2176 enum aarch64_opnd_qualifier candidates[AARCH64_MAX_QLF_SEQ_NUM];
2177 idx = select_operand_for_scalar_size_field_coding (inst->opcode);
2178 value = extract_field (FLD_size, inst->value, inst->opcode->mask);
2179 mask = extract_field (FLD_size, ~inst->opcode->mask, 0);
2180 /* For most related instruciton, the 'size' field is fully available for
2181 operand encoding. */
2183 inst->operands[idx].qualifier = get_sreg_qualifier_from_value (value);
2186 get_operand_possible_qualifiers (idx, inst->opcode->qualifiers_list,
2188 inst->operands[idx].qualifier
2189 = get_qualifier_from_partial_encoding (value, candidates, mask);
2193 if (inst->opcode->flags & F_T)
2195 /* Num of consecutive '0's on the right side of imm5<3:0>. */
2198 assert (aarch64_get_operand_class (inst->opcode->operands[0])
2199 == AARCH64_OPND_CLASS_SIMD_REG);
2210 val = extract_field (FLD_imm5, inst->value, 0);
2211 while ((val & 0x1) == 0 && ++num <= 3)
2215 Q = (unsigned) extract_field (FLD_Q, inst->value, inst->opcode->mask);
2216 inst->operands[0].qualifier =
2217 get_vreg_qualifier_from_value ((num << 1) | Q);
2220 if (inst->opcode->flags & F_GPRSIZE_IN_Q)
2222 /* Use Rt to encode in the case of e.g.
2223 STXP <Ws>, <Xt1>, <Xt2>, [<Xn|SP>{,#0}]. */
2224 idx = aarch64_operand_index (inst->opcode->operands, AARCH64_OPND_Rt);
2227 /* Otherwise use the result operand, which has to be a integer
2229 assert (aarch64_get_operand_class (inst->opcode->operands[0])
2230 == AARCH64_OPND_CLASS_INT_REG);
2233 assert (idx == 0 || idx == 1);
2234 value = extract_field (FLD_Q, inst->value, 0);
2235 inst->operands[idx].qualifier = get_greg_qualifier_from_value (value);
2238 if (inst->opcode->flags & F_LDS_SIZE)
2240 aarch64_field field = {0, 0};
2241 assert (aarch64_get_operand_class (inst->opcode->operands[0])
2242 == AARCH64_OPND_CLASS_INT_REG);
2243 gen_sub_field (FLD_opc, 0, 1, &field);
2244 value = extract_field_2 (&field, inst->value, 0);
2245 inst->operands[0].qualifier
2246 = value ? AARCH64_OPND_QLF_W : AARCH64_OPND_QLF_X;
2249 /* Miscellaneous decoding; done as the last step. */
2250 if (inst->opcode->flags & F_MISC)
2251 return do_misc_decoding (inst);
2256 /* Converters converting a real opcode instruction to its alias form. */
2258 /* ROR <Wd>, <Ws>, #<shift>
2260 EXTR <Wd>, <Ws>, <Ws>, #<shift>. */
2262 convert_extr_to_ror (aarch64_inst *inst)
2264 if (inst->operands[1].reg.regno == inst->operands[2].reg.regno)
2266 copy_operand_info (inst, 2, 3);
2267 inst->operands[3].type = AARCH64_OPND_NIL;
2273 /* UXTL<Q> <Vd>.<Ta>, <Vn>.<Tb>
2275 USHLL<Q> <Vd>.<Ta>, <Vn>.<Tb>, #0. */
2277 convert_shll_to_xtl (aarch64_inst *inst)
2279 if (inst->operands[2].imm.value == 0)
2281 inst->operands[2].type = AARCH64_OPND_NIL;
2288 UBFM <Xd>, <Xn>, #<shift>, #63.
2290 LSR <Xd>, <Xn>, #<shift>. */
2292 convert_bfm_to_sr (aarch64_inst *inst)
2296 imms = inst->operands[3].imm.value;
2297 val = inst->operands[2].qualifier == AARCH64_OPND_QLF_imm_0_31 ? 31 : 63;
2300 inst->operands[3].type = AARCH64_OPND_NIL;
2307 /* Convert MOV to ORR. */
2309 convert_orr_to_mov (aarch64_inst *inst)
2311 /* MOV <Vd>.<T>, <Vn>.<T>
2313 ORR <Vd>.<T>, <Vn>.<T>, <Vn>.<T>. */
2314 if (inst->operands[1].reg.regno == inst->operands[2].reg.regno)
2316 inst->operands[2].type = AARCH64_OPND_NIL;
2322 /* When <imms> >= <immr>, the instruction written:
2323 SBFX <Xd>, <Xn>, #<lsb>, #<width>
2325 SBFM <Xd>, <Xn>, #<lsb>, #(<lsb>+<width>-1). */
2328 convert_bfm_to_bfx (aarch64_inst *inst)
2332 immr = inst->operands[2].imm.value;
2333 imms = inst->operands[3].imm.value;
2337 inst->operands[2].imm.value = lsb;
2338 inst->operands[3].imm.value = imms + 1 - lsb;
2339 /* The two opcodes have different qualifiers for
2340 the immediate operands; reset to help the checking. */
2341 reset_operand_qualifier (inst, 2);
2342 reset_operand_qualifier (inst, 3);
2349 /* When <imms> < <immr>, the instruction written:
2350 SBFIZ <Xd>, <Xn>, #<lsb>, #<width>
2352 SBFM <Xd>, <Xn>, #((64-<lsb>)&0x3f), #(<width>-1). */
2355 convert_bfm_to_bfi (aarch64_inst *inst)
2357 int64_t immr, imms, val;
2359 immr = inst->operands[2].imm.value;
2360 imms = inst->operands[3].imm.value;
2361 val = inst->operands[2].qualifier == AARCH64_OPND_QLF_imm_0_31 ? 32 : 64;
2364 inst->operands[2].imm.value = (val - immr) & (val - 1);
2365 inst->operands[3].imm.value = imms + 1;
2366 /* The two opcodes have different qualifiers for
2367 the immediate operands; reset to help the checking. */
2368 reset_operand_qualifier (inst, 2);
2369 reset_operand_qualifier (inst, 3);
2376 /* The instruction written:
2377 BFC <Xd>, #<lsb>, #<width>
2379 BFM <Xd>, XZR, #((64-<lsb>)&0x3f), #(<width>-1). */
2382 convert_bfm_to_bfc (aarch64_inst *inst)
2384 int64_t immr, imms, val;
2386 /* Should have been assured by the base opcode value. */
2387 assert (inst->operands[1].reg.regno == 0x1f);
2389 immr = inst->operands[2].imm.value;
2390 imms = inst->operands[3].imm.value;
2391 val = inst->operands[2].qualifier == AARCH64_OPND_QLF_imm_0_31 ? 32 : 64;
2394 /* Drop XZR from the second operand. */
2395 copy_operand_info (inst, 1, 2);
2396 copy_operand_info (inst, 2, 3);
2397 inst->operands[3].type = AARCH64_OPND_NIL;
2399 /* Recalculate the immediates. */
2400 inst->operands[1].imm.value = (val - immr) & (val - 1);
2401 inst->operands[2].imm.value = imms + 1;
2403 /* The two opcodes have different qualifiers for the operands; reset to
2404 help the checking. */
2405 reset_operand_qualifier (inst, 1);
2406 reset_operand_qualifier (inst, 2);
2407 reset_operand_qualifier (inst, 3);
2415 /* The instruction written:
2416 LSL <Xd>, <Xn>, #<shift>
2418 UBFM <Xd>, <Xn>, #((64-<shift>)&0x3f), #(63-<shift>). */
2421 convert_ubfm_to_lsl (aarch64_inst *inst)
2423 int64_t immr = inst->operands[2].imm.value;
2424 int64_t imms = inst->operands[3].imm.value;
2426 = inst->operands[2].qualifier == AARCH64_OPND_QLF_imm_0_31 ? 31 : 63;
2428 if ((immr == 0 && imms == val) || immr == imms + 1)
2430 inst->operands[3].type = AARCH64_OPND_NIL;
2431 inst->operands[2].imm.value = val - imms;
2438 /* CINC <Wd>, <Wn>, <cond>
2440 CSINC <Wd>, <Wn>, <Wn>, invert(<cond>)
2441 where <cond> is not AL or NV. */
2444 convert_from_csel (aarch64_inst *inst)
2446 if (inst->operands[1].reg.regno == inst->operands[2].reg.regno
2447 && (inst->operands[3].cond->value & 0xe) != 0xe)
2449 copy_operand_info (inst, 2, 3);
2450 inst->operands[2].cond = get_inverted_cond (inst->operands[3].cond);
2451 inst->operands[3].type = AARCH64_OPND_NIL;
2457 /* CSET <Wd>, <cond>
2459 CSINC <Wd>, WZR, WZR, invert(<cond>)
2460 where <cond> is not AL or NV. */
2463 convert_csinc_to_cset (aarch64_inst *inst)
2465 if (inst->operands[1].reg.regno == 0x1f
2466 && inst->operands[2].reg.regno == 0x1f
2467 && (inst->operands[3].cond->value & 0xe) != 0xe)
2469 copy_operand_info (inst, 1, 3);
2470 inst->operands[1].cond = get_inverted_cond (inst->operands[3].cond);
2471 inst->operands[3].type = AARCH64_OPND_NIL;
2472 inst->operands[2].type = AARCH64_OPND_NIL;
2480 MOVZ <Wd>, #<imm16>, LSL #<shift>.
2482 A disassembler may output ORR, MOVZ and MOVN as a MOV mnemonic, except when
2483 ORR has an immediate that could be generated by a MOVZ or MOVN instruction,
2484 or where a MOVN has an immediate that could be encoded by MOVZ, or where
2485 MOVZ/MOVN #0 have a shift amount other than LSL #0, in which case the
2486 machine-instruction mnemonic must be used. */
2489 convert_movewide_to_mov (aarch64_inst *inst)
2491 uint64_t value = inst->operands[1].imm.value;
2492 /* MOVZ/MOVN #0 have a shift amount other than LSL #0. */
2493 if (value == 0 && inst->operands[1].shifter.amount != 0)
2495 inst->operands[1].type = AARCH64_OPND_IMM_MOV;
2496 inst->operands[1].shifter.kind = AARCH64_MOD_NONE;
2497 value <<= inst->operands[1].shifter.amount;
2498 /* As an alias convertor, it has to be clear that the INST->OPCODE
2499 is the opcode of the real instruction. */
2500 if (inst->opcode->op == OP_MOVN)
2502 int is32 = inst->operands[0].qualifier == AARCH64_OPND_QLF_W;
2504 /* A MOVN has an immediate that could be encoded by MOVZ. */
2505 if (aarch64_wide_constant_p (value, is32, NULL))
2508 inst->operands[1].imm.value = value;
2509 inst->operands[1].shifter.amount = 0;
2515 ORR <Wd>, WZR, #<imm>.
2517 A disassembler may output ORR, MOVZ and MOVN as a MOV mnemonic, except when
2518 ORR has an immediate that could be generated by a MOVZ or MOVN instruction,
2519 or where a MOVN has an immediate that could be encoded by MOVZ, or where
2520 MOVZ/MOVN #0 have a shift amount other than LSL #0, in which case the
2521 machine-instruction mnemonic must be used. */
2524 convert_movebitmask_to_mov (aarch64_inst *inst)
2529 /* Should have been assured by the base opcode value. */
2530 assert (inst->operands[1].reg.regno == 0x1f);
2531 copy_operand_info (inst, 1, 2);
2532 is32 = inst->operands[0].qualifier == AARCH64_OPND_QLF_W;
2533 inst->operands[1].type = AARCH64_OPND_IMM_MOV;
2534 value = inst->operands[1].imm.value;
2535 /* ORR has an immediate that could be generated by a MOVZ or MOVN
2537 if (inst->operands[0].reg.regno != 0x1f
2538 && (aarch64_wide_constant_p (value, is32, NULL)
2539 || aarch64_wide_constant_p (~value, is32, NULL)))
2542 inst->operands[2].type = AARCH64_OPND_NIL;
2546 /* Some alias opcodes are disassembled by being converted from their real-form.
2547 N.B. INST->OPCODE is the real opcode rather than the alias. */
2550 convert_to_alias (aarch64_inst *inst, const aarch64_opcode *alias)
2556 return convert_bfm_to_sr (inst);
2558 return convert_ubfm_to_lsl (inst);
2562 return convert_from_csel (inst);
2565 return convert_csinc_to_cset (inst);
2569 return convert_bfm_to_bfx (inst);
2573 return convert_bfm_to_bfi (inst);
2575 return convert_bfm_to_bfc (inst);
2577 return convert_orr_to_mov (inst);
2578 case OP_MOV_IMM_WIDE:
2579 case OP_MOV_IMM_WIDEN:
2580 return convert_movewide_to_mov (inst);
2581 case OP_MOV_IMM_LOG:
2582 return convert_movebitmask_to_mov (inst);
2584 return convert_extr_to_ror (inst);
2589 return convert_shll_to_xtl (inst);
2596 aarch64_opcode_decode (const aarch64_opcode *, const aarch64_insn,
2597 aarch64_inst *, int, aarch64_operand_error *errors);
2599 /* Given the instruction information in *INST, check if the instruction has
2600 any alias form that can be used to represent *INST. If the answer is yes,
2601 update *INST to be in the form of the determined alias. */
2603 /* In the opcode description table, the following flags are used in opcode
2604 entries to help establish the relations between the real and alias opcodes:
2606 F_ALIAS: opcode is an alias
2607 F_HAS_ALIAS: opcode has alias(es)
2610 F_P3: Disassembly preference priority 1-3 (the larger the
2611 higher). If nothing is specified, it is the priority
2612 0 by default, i.e. the lowest priority.
2614 Although the relation between the machine and the alias instructions are not
2615 explicitly described, it can be easily determined from the base opcode
2616 values, masks and the flags F_ALIAS and F_HAS_ALIAS in their opcode
2617 description entries:
2619 The mask of an alias opcode must be equal to or a super-set (i.e. more
2620 constrained) of that of the aliased opcode; so is the base opcode value.
2622 if (opcode_has_alias (real) && alias_opcode_p (opcode)
2623 && (opcode->mask & real->mask) == real->mask
2624 && (real->mask & opcode->opcode) == (real->mask & real->opcode))
2625 then OPCODE is an alias of, and only of, the REAL instruction
2627 The alias relationship is forced flat-structured to keep related algorithm
2628 simple; an opcode entry cannot be flagged with both F_ALIAS and F_HAS_ALIAS.
2630 During the disassembling, the decoding decision tree (in
2631 opcodes/aarch64-dis-2.c) always returns an machine instruction opcode entry;
2632 if the decoding of such a machine instruction succeeds (and -Mno-aliases is
2633 not specified), the disassembler will check whether there is any alias
2634 instruction exists for this real instruction. If there is, the disassembler
2635 will try to disassemble the 32-bit binary again using the alias's rule, or
2636 try to convert the IR to the form of the alias. In the case of the multiple
2637 aliases, the aliases are tried one by one from the highest priority
2638 (currently the flag F_P3) to the lowest priority (no priority flag), and the
2639 first succeeds first adopted.
2641 You may ask why there is a need for the conversion of IR from one form to
2642 another in handling certain aliases. This is because on one hand it avoids
2643 adding more operand code to handle unusual encoding/decoding; on other
2644 hand, during the disassembling, the conversion is an effective approach to
2645 check the condition of an alias (as an alias may be adopted only if certain
2646 conditions are met).
2648 In order to speed up the alias opcode lookup, aarch64-gen has preprocessed
2649 aarch64_opcode_table and generated aarch64_find_alias_opcode and
2650 aarch64_find_next_alias_opcode (in opcodes/aarch64-dis-2.c) to help. */
2653 determine_disassembling_preference (struct aarch64_inst *inst,
2654 aarch64_operand_error *errors)
2656 const aarch64_opcode *opcode;
2657 const aarch64_opcode *alias;
2659 opcode = inst->opcode;
2661 /* This opcode does not have an alias, so use itself. */
2662 if (!opcode_has_alias (opcode))
2665 alias = aarch64_find_alias_opcode (opcode);
2668 #ifdef DEBUG_AARCH64
2671 const aarch64_opcode *tmp = alias;
2672 printf ("#### LIST orderd: ");
2675 printf ("%s, ", tmp->name);
2676 tmp = aarch64_find_next_alias_opcode (tmp);
2680 #endif /* DEBUG_AARCH64 */
2682 for (; alias; alias = aarch64_find_next_alias_opcode (alias))
2684 DEBUG_TRACE ("try %s", alias->name);
2685 assert (alias_opcode_p (alias) || opcode_has_alias (opcode));
2687 /* An alias can be a pseudo opcode which will never be used in the
2688 disassembly, e.g. BIC logical immediate is such a pseudo opcode
2690 if (pseudo_opcode_p (alias))
2692 DEBUG_TRACE ("skip pseudo %s", alias->name);
2696 if ((inst->value & alias->mask) != alias->opcode)
2698 DEBUG_TRACE ("skip %s as base opcode not match", alias->name);
2701 /* No need to do any complicated transformation on operands, if the alias
2702 opcode does not have any operand. */
2703 if (aarch64_num_of_operands (alias) == 0 && alias->opcode == inst->value)
2705 DEBUG_TRACE ("succeed with 0-operand opcode %s", alias->name);
2706 aarch64_replace_opcode (inst, alias);
2709 if (alias->flags & F_CONV)
2712 memcpy (©, inst, sizeof (aarch64_inst));
2713 /* ALIAS is the preference as long as the instruction can be
2714 successfully converted to the form of ALIAS. */
2715 if (convert_to_alias (©, alias) == 1)
2717 aarch64_replace_opcode (©, alias);
2718 assert (aarch64_match_operands_constraint (©, NULL));
2719 DEBUG_TRACE ("succeed with %s via conversion", alias->name);
2720 memcpy (inst, ©, sizeof (aarch64_inst));
2726 /* Directly decode the alias opcode. */
2728 memset (&temp, '\0', sizeof (aarch64_inst));
2729 if (aarch64_opcode_decode (alias, inst->value, &temp, 1, errors) == 1)
2731 DEBUG_TRACE ("succeed with %s via direct decoding", alias->name);
2732 memcpy (inst, &temp, sizeof (aarch64_inst));
2739 /* Some instructions (including all SVE ones) use the instruction class
2740 to describe how a qualifiers_list index is represented in the instruction
2741 encoding. If INST is such an instruction, decode the appropriate fields
2742 and fill in the operand qualifiers accordingly. Return true if no
2743 problems are found. */
2746 aarch64_decode_variant_using_iclass (aarch64_inst *inst)
2751 switch (inst->opcode->iclass)
2754 variant = extract_fields (inst->value, 0, 2, FLD_size, FLD_SVE_M_14);
2758 i = extract_fields (inst->value, 0, 2, FLD_SVE_tszh, FLD_imm5);
2761 while ((i & 1) == 0)
2769 /* Pick the smallest applicable element size. */
2770 if ((inst->value & 0x20600) == 0x600)
2772 else if ((inst->value & 0x20400) == 0x400)
2774 else if ((inst->value & 0x20000) == 0)
2781 /* sve_misc instructions have only a single variant. */
2785 variant = extract_fields (inst->value, 0, 2, FLD_size, FLD_SVE_M_16);
2789 variant = extract_field (FLD_SVE_M_4, inst->value, 0);
2792 case sve_shift_pred:
2793 i = extract_fields (inst->value, 0, 2, FLD_SVE_tszh, FLD_SVE_tszl_8);
2804 case sve_shift_unpred:
2805 i = extract_fields (inst->value, 0, 2, FLD_SVE_tszh, FLD_SVE_tszl_19);
2809 variant = extract_field (FLD_size, inst->value, 0);
2815 variant = extract_field (FLD_size, inst->value, 0);
2819 i = extract_field (FLD_size, inst->value, 0);
2826 variant = extract_field (FLD_SVE_sz, inst->value, 0);
2830 /* No mapping between instruction class and qualifiers. */
2834 for (i = 0; i < AARCH64_MAX_OPND_NUM; ++i)
2835 inst->operands[i].qualifier = inst->opcode->qualifiers_list[variant][i];
2838 /* Decode the CODE according to OPCODE; fill INST. Return 0 if the decoding
2839 fails, which meanes that CODE is not an instruction of OPCODE; otherwise
2842 If OPCODE has alias(es) and NOALIASES_P is 0, an alias opcode may be
2843 determined and used to disassemble CODE; this is done just before the
2847 aarch64_opcode_decode (const aarch64_opcode *opcode, const aarch64_insn code,
2848 aarch64_inst *inst, int noaliases_p,
2849 aarch64_operand_error *errors)
2853 DEBUG_TRACE ("enter with %s", opcode->name);
2855 assert (opcode && inst);
2858 memset (inst, '\0', sizeof (aarch64_inst));
2860 /* Check the base opcode. */
2861 if ((code & opcode->mask) != (opcode->opcode & opcode->mask))
2863 DEBUG_TRACE ("base opcode match FAIL");
2867 inst->opcode = opcode;
2870 /* Assign operand codes and indexes. */
2871 for (i = 0; i < AARCH64_MAX_OPND_NUM; ++i)
2873 if (opcode->operands[i] == AARCH64_OPND_NIL)
2875 inst->operands[i].type = opcode->operands[i];
2876 inst->operands[i].idx = i;
2879 /* Call the opcode decoder indicated by flags. */
2880 if (opcode_has_special_coder (opcode) && do_special_decoding (inst) == 0)
2882 DEBUG_TRACE ("opcode flag-based decoder FAIL");
2886 /* Possibly use the instruction class to determine the correct
2888 if (!aarch64_decode_variant_using_iclass (inst))
2890 DEBUG_TRACE ("iclass-based decoder FAIL");
2894 /* Call operand decoders. */
2895 for (i = 0; i < AARCH64_MAX_OPND_NUM; ++i)
2897 const aarch64_operand *opnd;
2898 enum aarch64_opnd type;
2900 type = opcode->operands[i];
2901 if (type == AARCH64_OPND_NIL)
2903 opnd = &aarch64_operands[type];
2904 if (operand_has_extractor (opnd)
2905 && (! aarch64_extract_operand (opnd, &inst->operands[i], code, inst,
2908 DEBUG_TRACE ("operand decoder FAIL at operand %d", i);
2913 /* If the opcode has a verifier, then check it now. */
2914 if (opcode->verifier
2915 && opcode->verifier (inst, code, 0, FALSE, errors, NULL) != ERR_OK)
2917 DEBUG_TRACE ("operand verifier FAIL");
2921 /* Match the qualifiers. */
2922 if (aarch64_match_operands_constraint (inst, NULL) == 1)
2924 /* Arriving here, the CODE has been determined as a valid instruction
2925 of OPCODE and *INST has been filled with information of this OPCODE
2926 instruction. Before the return, check if the instruction has any
2927 alias and should be disassembled in the form of its alias instead.
2928 If the answer is yes, *INST will be updated. */
2930 determine_disassembling_preference (inst, errors);
2931 DEBUG_TRACE ("SUCCESS");
2936 DEBUG_TRACE ("constraint matching FAIL");
2943 /* This does some user-friendly fix-up to *INST. It is currently focus on
2944 the adjustment of qualifiers to help the printed instruction
2945 recognized/understood more easily. */
2948 user_friendly_fixup (aarch64_inst *inst)
2950 switch (inst->opcode->iclass)
2953 /* TBNZ Xn|Wn, #uimm6, label
2954 Test and Branch Not Zero: conditionally jumps to label if bit number
2955 uimm6 in register Xn is not zero. The bit number implies the width of
2956 the register, which may be written and should be disassembled as Wn if
2957 uimm is less than 32. Limited to a branch offset range of +/- 32KiB.
2959 if (inst->operands[1].imm.value < 32)
2960 inst->operands[0].qualifier = AARCH64_OPND_QLF_W;
2966 /* Decode INSN and fill in *INST the instruction information. An alias
2967 opcode may be filled in *INSN if NOALIASES_P is FALSE. Return zero on
2971 aarch64_decode_insn (aarch64_insn insn, aarch64_inst *inst,
2972 bfd_boolean noaliases_p,
2973 aarch64_operand_error *errors)
2975 const aarch64_opcode *opcode = aarch64_opcode_lookup (insn);
2977 #ifdef DEBUG_AARCH64
2980 const aarch64_opcode *tmp = opcode;
2982 DEBUG_TRACE ("opcode lookup:");
2985 aarch64_verbose (" %s", tmp->name);
2986 tmp = aarch64_find_next_opcode (tmp);
2989 #endif /* DEBUG_AARCH64 */
2991 /* A list of opcodes may have been found, as aarch64_opcode_lookup cannot
2992 distinguish some opcodes, e.g. SSHR and MOVI, which almost share the same
2993 opcode field and value, apart from the difference that one of them has an
2994 extra field as part of the opcode, but such a field is used for operand
2995 encoding in other opcode(s) ('immh' in the case of the example). */
2996 while (opcode != NULL)
2998 /* But only one opcode can be decoded successfully for, as the
2999 decoding routine will check the constraint carefully. */
3000 if (aarch64_opcode_decode (opcode, insn, inst, noaliases_p, errors) == 1)
3002 opcode = aarch64_find_next_opcode (opcode);
3008 /* Print operands. */
3011 print_operands (bfd_vma pc, const aarch64_opcode *opcode,
3012 const aarch64_opnd_info *opnds, struct disassemble_info *info,
3013 bfd_boolean *has_notes)
3016 int i, pcrel_p, num_printed;
3017 for (i = 0, num_printed = 0; i < AARCH64_MAX_OPND_NUM; ++i)
3020 /* We regard the opcode operand info more, however we also look into
3021 the inst->operands to support the disassembling of the optional
3023 The two operand code should be the same in all cases, apart from
3024 when the operand can be optional. */
3025 if (opcode->operands[i] == AARCH64_OPND_NIL
3026 || opnds[i].type == AARCH64_OPND_NIL)
3029 /* Generate the operand string in STR. */
3030 aarch64_print_operand (str, sizeof (str), pc, opcode, opnds, i, &pcrel_p,
3031 &info->target, ¬es);
3033 /* Print the delimiter (taking account of omitted operand(s)). */
3035 (*info->fprintf_func) (info->stream, "%s",
3036 num_printed++ == 0 ? "\t" : ", ");
3038 /* Print the operand. */
3040 (*info->print_address_func) (info->target, info);
3042 (*info->fprintf_func) (info->stream, "%s", str);
3045 if (notes && !no_notes)
3048 (*info->fprintf_func) (info->stream, " // note: %s", notes);
3052 /* Set NAME to a copy of INST's mnemonic with the "." suffix removed. */
3055 remove_dot_suffix (char *name, const aarch64_inst *inst)
3060 ptr = strchr (inst->opcode->name, '.');
3061 assert (ptr && inst->cond);
3062 len = ptr - inst->opcode->name;
3064 strncpy (name, inst->opcode->name, len);
3068 /* Print the instruction mnemonic name. */
3071 print_mnemonic_name (const aarch64_inst *inst, struct disassemble_info *info)
3073 if (inst->opcode->flags & F_COND)
3075 /* For instructions that are truly conditionally executed, e.g. b.cond,
3076 prepare the full mnemonic name with the corresponding condition
3080 remove_dot_suffix (name, inst);
3081 (*info->fprintf_func) (info->stream, "%s.%s", name, inst->cond->names[0]);
3084 (*info->fprintf_func) (info->stream, "%s", inst->opcode->name);
3087 /* Decide whether we need to print a comment after the operands of
3088 instruction INST. */
3091 print_comment (const aarch64_inst *inst, struct disassemble_info *info)
3093 if (inst->opcode->flags & F_COND)
3096 unsigned int i, num_conds;
3098 remove_dot_suffix (name, inst);
3099 num_conds = ARRAY_SIZE (inst->cond->names);
3100 for (i = 1; i < num_conds && inst->cond->names[i]; ++i)
3101 (*info->fprintf_func) (info->stream, "%s %s.%s",
3102 i == 1 ? " //" : ",",
3103 name, inst->cond->names[i]);
3107 /* Build notes from verifiers into a string for printing. */
3110 print_verifier_notes (aarch64_operand_error *detail,
3111 struct disassemble_info *info)
3116 /* The output of the verifier cannot be a fatal error, otherwise the assembly
3117 would not have succeeded. We can safely ignore these. */
3118 assert (detail->non_fatal);
3119 assert (detail->error);
3121 /* If there are multiple verifier messages, concat them up to 1k. */
3122 (*info->fprintf_func) (info->stream, " // note: %s", detail->error);
3123 if (detail->index >= 0)
3124 (*info->fprintf_func) (info->stream, " at operand %d", detail->index + 1);
3127 /* Print the instruction according to *INST. */
3130 print_aarch64_insn (bfd_vma pc, const aarch64_inst *inst,
3131 const aarch64_insn code,
3132 struct disassemble_info *info,
3133 aarch64_operand_error *mismatch_details)
3135 bfd_boolean has_notes = FALSE;
3137 print_mnemonic_name (inst, info);
3138 print_operands (pc, inst->opcode, inst->operands, info, &has_notes);
3139 print_comment (inst, info);
3141 /* We've already printed a note, not enough space to print more so exit.
3142 Usually notes shouldn't overlap so it shouldn't happen that we have a note
3143 from a register and instruction at the same time. */
3147 /* Always run constraint verifiers, this is needed because constraints need to
3148 maintain a global state regardless of whether the instruction has the flag
3150 enum err_type result = verify_constraints (inst, code, pc, FALSE,
3151 mismatch_details, &insn_sequence);
3159 print_verifier_notes (mismatch_details, info);
3166 /* Entry-point of the instruction disassembler and printer. */
3169 print_insn_aarch64_word (bfd_vma pc,
3171 struct disassemble_info *info,
3172 aarch64_operand_error *errors)
3174 static const char *err_msg[ERR_NR_ENTRIES+1] =
3177 [ERR_UND] = "undefined",
3178 [ERR_UNP] = "unpredictable",
3185 info->insn_info_valid = 1;
3186 info->branch_delay_insns = 0;
3187 info->data_size = 0;
3191 if (info->flags & INSN_HAS_RELOC)
3192 /* If the instruction has a reloc associated with it, then
3193 the offset field in the instruction will actually be the
3194 addend for the reloc. (If we are using REL type relocs).
3195 In such cases, we can ignore the pc when computing
3196 addresses, since the addend is not currently pc-relative. */
3199 ret = aarch64_decode_insn (word, &inst, no_aliases, errors);
3201 if (((word >> 21) & 0x3ff) == 1)
3203 /* RESERVED for ALES. */
3204 assert (ret != ERR_OK);
3213 /* Handle undefined instructions. */
3214 info->insn_type = dis_noninsn;
3215 (*info->fprintf_func) (info->stream,".inst\t0x%08x ; %s",
3216 word, err_msg[ret]);
3219 user_friendly_fixup (&inst);
3220 print_aarch64_insn (pc, &inst, word, info, errors);
3227 /* Disallow mapping symbols ($x, $d etc) from
3228 being displayed in symbol relative addresses. */
3231 aarch64_symbol_is_valid (asymbol * sym,
3232 struct disassemble_info * info ATTRIBUTE_UNUSED)
3239 name = bfd_asymbol_name (sym);
3243 || (name[1] != 'x' && name[1] != 'd')
3244 || (name[2] != '\0' && name[2] != '.'));
3247 /* Print data bytes on INFO->STREAM. */
3250 print_insn_data (bfd_vma pc ATTRIBUTE_UNUSED,
3252 struct disassemble_info *info,
3253 aarch64_operand_error *errors ATTRIBUTE_UNUSED)
3255 switch (info->bytes_per_chunk)
3258 info->fprintf_func (info->stream, ".byte\t0x%02x", word);
3261 info->fprintf_func (info->stream, ".short\t0x%04x", word);
3264 info->fprintf_func (info->stream, ".word\t0x%08x", word);
3271 /* Try to infer the code or data type from a symbol.
3272 Returns nonzero if *MAP_TYPE was set. */
3275 get_sym_code_type (struct disassemble_info *info, int n,
3276 enum map_type *map_type)
3278 elf_symbol_type *es;
3282 /* If the symbol is in a different section, ignore it. */
3283 if (info->section != NULL && info->section != info->symtab[n]->section)
3286 es = *(elf_symbol_type **)(info->symtab + n);
3287 type = ELF_ST_TYPE (es->internal_elf_sym.st_info);
3289 /* If the symbol has function type then use that. */
3290 if (type == STT_FUNC)
3292 *map_type = MAP_INSN;
3296 /* Check for mapping symbols. */
3297 name = bfd_asymbol_name(info->symtab[n]);
3299 && (name[1] == 'x' || name[1] == 'd')
3300 && (name[2] == '\0' || name[2] == '.'))
3302 *map_type = (name[1] == 'x' ? MAP_INSN : MAP_DATA);
3309 /* Entry-point of the AArch64 disassembler. */
3312 print_insn_aarch64 (bfd_vma pc,
3313 struct disassemble_info *info)
3315 bfd_byte buffer[INSNLEN];
3317 void (*printer) (bfd_vma, uint32_t, struct disassemble_info *,
3318 aarch64_operand_error *);
3319 bfd_boolean found = FALSE;
3320 unsigned int size = 4;
3322 aarch64_operand_error errors;
3324 if (info->disassembler_options)
3326 set_default_aarch64_dis_options (info);
3328 parse_aarch64_dis_options (info->disassembler_options);
3330 /* To avoid repeated parsing of these options, we remove them here. */
3331 info->disassembler_options = NULL;
3334 /* Aarch64 instructions are always little-endian */
3335 info->endian_code = BFD_ENDIAN_LITTLE;
3337 /* First check the full symtab for a mapping symbol, even if there
3338 are no usable non-mapping symbols for this address. */
3339 if (info->symtab_size != 0
3340 && bfd_asymbol_flavour (*info->symtab) == bfd_target_elf_flavour)
3342 enum map_type type = MAP_INSN;
3347 if (pc <= last_mapping_addr)
3348 last_mapping_sym = -1;
3350 /* Start scanning at the start of the function, or wherever
3351 we finished last time. */
3352 n = info->symtab_pos + 1;
3353 if (n < last_mapping_sym)
3354 n = last_mapping_sym;
3356 /* Scan up to the location being disassembled. */
3357 for (; n < info->symtab_size; n++)
3359 addr = bfd_asymbol_value (info->symtab[n]);
3362 if (get_sym_code_type (info, n, &type))
3371 n = info->symtab_pos;
3372 if (n < last_mapping_sym)
3373 n = last_mapping_sym;
3375 /* No mapping symbol found at this address. Look backwards
3376 for a preceeding one. */
3379 if (get_sym_code_type (info, n, &type))
3388 last_mapping_sym = last_sym;
3391 /* Look a little bit ahead to see if we should print out
3392 less than four bytes of data. If there's a symbol,
3393 mapping or otherwise, after two bytes then don't
3395 if (last_type == MAP_DATA)
3397 size = 4 - (pc & 3);
3398 for (n = last_sym + 1; n < info->symtab_size; n++)
3400 addr = bfd_asymbol_value (info->symtab[n]);
3403 if (addr - pc < size)
3408 /* If the next symbol is after three bytes, we need to
3409 print only part of the data, so that we can use either
3412 size = (pc & 1) ? 1 : 2;
3416 if (last_type == MAP_DATA)
3418 /* size was set above. */
3419 info->bytes_per_chunk = size;
3420 info->display_endian = info->endian;
3421 printer = print_insn_data;
3425 info->bytes_per_chunk = size = INSNLEN;
3426 info->display_endian = info->endian_code;
3427 printer = print_insn_aarch64_word;
3430 status = (*info->read_memory_func) (pc, buffer, size, info);
3433 (*info->memory_error_func) (status, pc, info);
3437 data = bfd_get_bits (buffer, size * 8,
3438 info->display_endian == BFD_ENDIAN_BIG);
3440 (*printer) (pc, data, info, &errors);
3446 print_aarch64_disassembler_options (FILE *stream)
3448 fprintf (stream, _("\n\
3449 The following AARCH64 specific disassembler options are supported for use\n\
3450 with the -M switch (multiple options should be separated by commas):\n"));
3452 fprintf (stream, _("\n\
3453 no-aliases Don't print instruction aliases.\n"));
3455 fprintf (stream, _("\n\
3456 aliases Do print instruction aliases.\n"));
3458 fprintf (stream, _("\n\
3459 no-notes Don't print instruction notes.\n"));
3461 fprintf (stream, _("\n\
3462 notes Do print instruction notes.\n"));
3464 #ifdef DEBUG_AARCH64
3465 fprintf (stream, _("\n\
3466 debug_dump Temp switch for debug trace.\n"));
3467 #endif /* DEBUG_AARCH64 */
3469 fprintf (stream, _("\n"));