projects / deliverable / binutils-gdb.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Add support for V_4B so we can properly reject it.
[deliverable/binutils-gdb.git] / include / opcode / aarch64.h
CommitLineData
a06ea964
NC		 1/* AArch64 assembler/disassembler support.
2
2571583a 3 Copyright (C) 2009-2017 Free Software Foundation, Inc.
a06ea964
NC		 4 Contributed by ARM Ltd.
5
6 This file is part of GNU Binutils.
7
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the license, or
11 (at your option) any later version.
12
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with this program; see the file COPYING3. If not,
20 see <http://www.gnu.org/licenses/>. */
21
22#ifndef OPCODE_AARCH64_H
23#define OPCODE_AARCH64_H
24
25#include "bfd.h"
26#include "bfd_stdint.h"
27#include <assert.h>
28#include <stdlib.h>
29
d3e12b29
YQ		 30#ifdef __cplusplus
31extern "C" {
32#endif
33
a06ea964
NC		 34/* The offset for pc-relative addressing is currently defined to be 0. */
35#define AARCH64_PCREL_OFFSET 0
36
37typedef uint32_t aarch64_insn;
38
39/* The following bitmasks control CPU features. */
c0e7cef7
NC		 40#define AARCH64_FEATURE_SHA2 0x200000000ULL /* SHA2 instructions. */
41#define AARCH64_FEATURE_AES 0x800000000ULL /* AES instructions. */
b6b9ca0c
TC		 42#define AARCH64_FEATURE_V8_4 0x000000800ULL /* ARMv8.4 processors. */
43#define AARCH64_FEATURE_SM4 0x100000000ULL /* SM3 & SM4 instructions. */
44#define AARCH64_FEATURE_SHA3 0x400000000ULL /* SHA3 instructions. */
a06ea964 45#define AARCH64_FEATURE_V8 0x00000001 /* All processors. */
acb787b0 46#define AARCH64_FEATURE_V8_2 0x00000020 /* ARMv8.2 processors. */
1924ff75 47#define AARCH64_FEATURE_V8_3 0x00000040 /* ARMv8.3 processors. */
a06ea964
NC		 48#define AARCH64_FEATURE_CRYPTO 0x00010000 /* Crypto instructions. */
49#define AARCH64_FEATURE_FP 0x00020000 /* FP instructions. */
50#define AARCH64_FEATURE_SIMD 0x00040000 /* SIMD instructions. */
e60bb1dd 51#define AARCH64_FEATURE_CRC 0x00080000 /* CRC instructions. */
ee804238 52#define AARCH64_FEATURE_LSE 0x00100000 /* LSE instructions. */
f21cce2c 53#define AARCH64_FEATURE_PAN 0x00200000 /* PAN instructions. */
290806fd 54#define AARCH64_FEATURE_LOR 0x00400000 /* LOR instructions. */
9e1f0fa7 55#define AARCH64_FEATURE_RDMA 0x00800000 /* v8.1 SIMD instructions. */
250aafa4 56#define AARCH64_FEATURE_V8_1 0x01000000 /* v8.1 features. */
af117b3c 57#define AARCH64_FEATURE_F16 0x02000000 /* v8.2 FP16 instructions. */
c8a6db6f 58#define AARCH64_FEATURE_RAS 0x04000000 /* RAS Extensions. */
73af8ed6 59#define AARCH64_FEATURE_PROFILE 0x08000000 /* Statistical Profiling. */
c0890d26 60#define AARCH64_FEATURE_SVE 0x10000000 /* SVE instructions. */
d74d4880 61#define AARCH64_FEATURE_RCPC 0x20000000 /* RCPC instructions. */
f482d304 62#define AARCH64_FEATURE_COMPNUM 0x40000000 /* Complex # instructions. */
65a55fbb 63#define AARCH64_FEATURE_DOTPROD 0x080000000 /* Dot Product instructions. */
d0f7791c 64#define AARCH64_FEATURE_F16_FML 0x1000000000ULL /* v8.2 FP16FML ins. */
a06ea964
NC		 65
66/* Architectures are the sum of the base and extensions. */
67#define AARCH64_ARCH_V8 AARCH64_FEATURE (AARCH64_FEATURE_V8, \
68 AARCH64_FEATURE_FP \
69 | AARCH64_FEATURE_SIMD)
1924ff75
SN		 70#define AARCH64_ARCH_V8_1 AARCH64_FEATURE (AARCH64_ARCH_V8, \
71 AARCH64_FEATURE_CRC \
250aafa4 72 | AARCH64_FEATURE_V8_1 \
88f0ea34
MW		 73 | AARCH64_FEATURE_LSE \
74 | AARCH64_FEATURE_PAN \
75 | AARCH64_FEATURE_LOR \
76 | AARCH64_FEATURE_RDMA)
1924ff75 77#define AARCH64_ARCH_V8_2 AARCH64_FEATURE (AARCH64_ARCH_V8_1, \
acb787b0 78 AARCH64_FEATURE_V8_2 \
1924ff75
SN		 79 | AARCH64_FEATURE_RAS)
80#define AARCH64_ARCH_V8_3 AARCH64_FEATURE (AARCH64_ARCH_V8_2, \
d74d4880 81 AARCH64_FEATURE_V8_3 \
f482d304
RS		 82 | AARCH64_FEATURE_RCPC \
83 | AARCH64_FEATURE_COMPNUM)
b6b9ca0c 84#define AARCH64_ARCH_V8_4 AARCH64_FEATURE (AARCH64_ARCH_V8_3, \
981b557a 85 AARCH64_FEATURE_V8_4 \
d0f7791c
TC		 86 | AARCH64_FEATURE_DOTPROD \
87 | AARCH64_FEATURE_F16_FML)
88f0ea34 88
a06ea964
NC		 89#define AARCH64_ARCH_NONE AARCH64_FEATURE (0, 0)
90#define AARCH64_ANY AARCH64_FEATURE (-1, 0) /* Any basic core. */
91
92/* CPU-specific features. */
21b81e67 93typedef unsigned long long aarch64_feature_set;
a06ea964 94
93d8990c
SN		 95#define AARCH64_CPU_HAS_ALL_FEATURES(CPU,FEAT) \
96 ((~(CPU) & (FEAT)) == 0)
97
98#define AARCH64_CPU_HAS_ANY_FEATURES(CPU,FEAT) \
a06ea964
NC		 99 (((CPU) & (FEAT)) != 0)
100
93d8990c
SN		 101#define AARCH64_CPU_HAS_FEATURE(CPU,FEAT) \
102 AARCH64_CPU_HAS_ALL_FEATURES (CPU,FEAT)
103
a06ea964
NC		 104#define AARCH64_MERGE_FEATURE_SETS(TARG,F1,F2) \
105 do \
106 { \
107 (TARG) = (F1) | (F2); \
108 } \
109 while (0)
110
111#define AARCH64_CLEAR_FEATURE(TARG,F1,F2) \
112 do \
113 { \
114 (TARG) = (F1) &~ (F2); \
115 } \
116 while (0)
117
118#define AARCH64_FEATURE(core,coproc) ((core) | (coproc))
119
a06ea964
NC		 120enum aarch64_operand_class
121{
122 AARCH64_OPND_CLASS_NIL,
123 AARCH64_OPND_CLASS_INT_REG,
124 AARCH64_OPND_CLASS_MODIFIED_REG,
125 AARCH64_OPND_CLASS_FP_REG,
126 AARCH64_OPND_CLASS_SIMD_REG,
127 AARCH64_OPND_CLASS_SIMD_ELEMENT,
128 AARCH64_OPND_CLASS_SISD_REG,
129 AARCH64_OPND_CLASS_SIMD_REGLIST,
f11ad6bc
RS		 130 AARCH64_OPND_CLASS_SVE_REG,
131 AARCH64_OPND_CLASS_PRED_REG,
a06ea964
NC		 132 AARCH64_OPND_CLASS_ADDRESS,
133 AARCH64_OPND_CLASS_IMMEDIATE,
134 AARCH64_OPND_CLASS_SYSTEM,
68a64283 135 AARCH64_OPND_CLASS_COND,
a06ea964
NC		 136};
137
138/* Operand code that helps both parsing and coding.
139 Keep AARCH64_OPERANDS synced. */
140
141enum aarch64_opnd
142{
143 AARCH64_OPND_NIL, /* no operand---MUST BE FIRST!*/
144
145 AARCH64_OPND_Rd, /* Integer register as destination. */
146 AARCH64_OPND_Rn, /* Integer register as source. */
147 AARCH64_OPND_Rm, /* Integer register as source. */
148 AARCH64_OPND_Rt, /* Integer register used in ld/st instructions. */
149 AARCH64_OPND_Rt2, /* Integer register used in ld/st pair instructions. */
150 AARCH64_OPND_Rs, /* Integer register used in ld/st exclusive. */
151 AARCH64_OPND_Ra, /* Integer register used in ddp_3src instructions. */
152 AARCH64_OPND_Rt_SYS, /* Integer register used in system instructions. */
153
154 AARCH64_OPND_Rd_SP, /* Integer Rd or SP. */
155 AARCH64_OPND_Rn_SP, /* Integer Rn or SP. */
c84364ec 156 AARCH64_OPND_Rm_SP, /* Integer Rm or SP. */
ee804238 157 AARCH64_OPND_PAIRREG, /* Paired register operand. */
a06ea964
NC		 158 AARCH64_OPND_Rm_EXT, /* Integer Rm extended. */
159 AARCH64_OPND_Rm_SFT, /* Integer Rm shifted. */
160
161 AARCH64_OPND_Fd, /* Floating-point Fd. */
162 AARCH64_OPND_Fn, /* Floating-point Fn. */
163 AARCH64_OPND_Fm, /* Floating-point Fm. */
164 AARCH64_OPND_Fa, /* Floating-point Fa. */
165 AARCH64_OPND_Ft, /* Floating-point Ft. */
166 AARCH64_OPND_Ft2, /* Floating-point Ft2. */
167
168 AARCH64_OPND_Sd, /* AdvSIMD Scalar Sd. */
169 AARCH64_OPND_Sn, /* AdvSIMD Scalar Sn. */
170 AARCH64_OPND_Sm, /* AdvSIMD Scalar Sm. */
171
f42f1a1d 172 AARCH64_OPND_Va, /* AdvSIMD Vector Va. */
a06ea964
NC		 173 AARCH64_OPND_Vd, /* AdvSIMD Vector Vd. */
174 AARCH64_OPND_Vn, /* AdvSIMD Vector Vn. */
175 AARCH64_OPND_Vm, /* AdvSIMD Vector Vm. */
176 AARCH64_OPND_VdD1, /* AdvSIMD <Vd>.D[1]; for FMOV only. */
177 AARCH64_OPND_VnD1, /* AdvSIMD <Vn>.D[1]; for FMOV only. */
178 AARCH64_OPND_Ed, /* AdvSIMD Vector Element Vd. */
179 AARCH64_OPND_En, /* AdvSIMD Vector Element Vn. */
180 AARCH64_OPND_Em, /* AdvSIMD Vector Element Vm. */
181 AARCH64_OPND_LVn, /* AdvSIMD Vector register list used in e.g. TBL. */
182 AARCH64_OPND_LVt, /* AdvSIMD Vector register list used in ld/st. */
183 AARCH64_OPND_LVt_AL, /* AdvSIMD Vector register list for loading single
184 structure to all lanes. */
185 AARCH64_OPND_LEt, /* AdvSIMD Vector Element list. */
186
a6a51754
RL		 187 AARCH64_OPND_CRn, /* Co-processor register in CRn field. */
188 AARCH64_OPND_CRm, /* Co-processor register in CRm field. */
a06ea964
NC		 189
190 AARCH64_OPND_IDX, /* AdvSIMD EXT index operand. */
f42f1a1d 191 AARCH64_OPND_MASK, /* AdvSIMD EXT index operand. */
a06ea964
NC		 192 AARCH64_OPND_IMM_VLSL,/* Immediate for shifting vector registers left. */
193 AARCH64_OPND_IMM_VLSR,/* Immediate for shifting vector registers right. */
194 AARCH64_OPND_SIMD_IMM,/* AdvSIMD modified immediate without shift. */
195 AARCH64_OPND_SIMD_IMM_SFT, /* AdvSIMD modified immediate with shift. */
196 AARCH64_OPND_SIMD_FPIMM,/* AdvSIMD 8-bit fp immediate. */
197 AARCH64_OPND_SHLL_IMM,/* Immediate shift for AdvSIMD SHLL instruction
198 (no encoding). */
199 AARCH64_OPND_IMM0, /* Immediate for #0. */
200 AARCH64_OPND_FPIMM0, /* Immediate for #0.0. */
201 AARCH64_OPND_FPIMM, /* Floating-point Immediate. */
202 AARCH64_OPND_IMMR, /* Immediate #<immr> in e.g. BFM. */
203 AARCH64_OPND_IMMS, /* Immediate #<imms> in e.g. BFM. */
204 AARCH64_OPND_WIDTH, /* Immediate #<width> in e.g. BFI. */
205 AARCH64_OPND_IMM, /* Immediate. */
f42f1a1d 206 AARCH64_OPND_IMM_2, /* Immediate. */
a06ea964
NC		 207 AARCH64_OPND_UIMM3_OP1,/* Unsigned 3-bit immediate in the op1 field. */
208 AARCH64_OPND_UIMM3_OP2,/* Unsigned 3-bit immediate in the op2 field. */
209 AARCH64_OPND_UIMM4, /* Unsigned 4-bit immediate in the CRm field. */
210 AARCH64_OPND_UIMM7, /* Unsigned 7-bit immediate in the CRm:op2 fields. */
211 AARCH64_OPND_BIT_NUM, /* Immediate. */
212 AARCH64_OPND_EXCEPTION,/* imm16 operand in exception instructions. */
213 AARCH64_OPND_CCMP_IMM,/* Immediate in conditional compare instructions. */
e950b345 214 AARCH64_OPND_SIMM5, /* 5-bit signed immediate in the imm5 field. */
a06ea964
NC		 215 AARCH64_OPND_NZCV, /* Flag bit specifier giving an alternative value for
216 each condition flag. */
217
218 AARCH64_OPND_LIMM, /* Logical Immediate. */
219 AARCH64_OPND_AIMM, /* Arithmetic immediate. */
220 AARCH64_OPND_HALF, /* #<imm16>{, LSL #<shift>} operand in move wide. */
221 AARCH64_OPND_FBITS, /* FP #<fbits> operand in e.g. SCVTF */
222 AARCH64_OPND_IMM_MOV, /* Immediate operand for the MOV alias. */
c2c4ff8d
SN		 223 AARCH64_OPND_IMM_ROT1, /* Immediate rotate operand for FCMLA. */
224 AARCH64_OPND_IMM_ROT2, /* Immediate rotate operand for indexed FCMLA. */
225 AARCH64_OPND_IMM_ROT3, /* Immediate rotate operand for FCADD. */
a06ea964
NC		 226
227 AARCH64_OPND_COND, /* Standard condition as the last operand. */
68a64283 228 AARCH64_OPND_COND1, /* Same as the above, but excluding AL and NV. */
a06ea964
NC		 229
230 AARCH64_OPND_ADDR_ADRP, /* Memory address for ADRP */
231 AARCH64_OPND_ADDR_PCREL14, /* 14-bit PC-relative address for e.g. TBZ. */
232 AARCH64_OPND_ADDR_PCREL19, /* 19-bit PC-relative address for e.g. LDR. */
233 AARCH64_OPND_ADDR_PCREL21, /* 21-bit PC-relative address for e.g. ADR. */
234 AARCH64_OPND_ADDR_PCREL26, /* 26-bit PC-relative address for e.g. BL. */
235
236 AARCH64_OPND_ADDR_SIMPLE, /* Address of ld/st exclusive. */
237 AARCH64_OPND_ADDR_REGOFF, /* Address of register offset. */
238 AARCH64_OPND_ADDR_SIMM7, /* Address of signed 7-bit immediate. */
239 AARCH64_OPND_ADDR_SIMM9, /* Address of signed 9-bit immediate. */
240 AARCH64_OPND_ADDR_SIMM9_2, /* Same as the above, but the immediate is
241 negative or unaligned and there is
242 no writeback allowed. This operand code
243 is only used to support the programmer-
244 friendly feature of using LDR/STR as the
245 the mnemonic name for LDUR/STUR instructions
246 wherever there is no ambiguity. */
3f06e550 247 AARCH64_OPND_ADDR_SIMM10, /* Address of signed 10-bit immediate. */
a06ea964
NC		 248 AARCH64_OPND_ADDR_UIMM12, /* Address of unsigned 12-bit immediate. */
249 AARCH64_OPND_SIMD_ADDR_SIMPLE,/* Address of ld/st multiple structures. */
f42f1a1d 250 AARCH64_OPND_ADDR_OFFSET, /* Address with an optional 9-bit immediate. */
a06ea964
NC		 251 AARCH64_OPND_SIMD_ADDR_POST, /* Address of ld/st multiple post-indexed. */
252
253 AARCH64_OPND_SYSREG, /* System register operand. */
254 AARCH64_OPND_PSTATEFIELD, /* PSTATE field name operand. */
255 AARCH64_OPND_SYSREG_AT, /* System register <at_op> operand. */
256 AARCH64_OPND_SYSREG_DC, /* System register <dc_op> operand. */
257 AARCH64_OPND_SYSREG_IC, /* System register <ic_op> operand. */
258 AARCH64_OPND_SYSREG_TLBI, /* System register <tlbi_op> operand. */
259 AARCH64_OPND_BARRIER, /* Barrier operand. */
260 AARCH64_OPND_BARRIER_ISB, /* Barrier operand for ISB. */
261 AARCH64_OPND_PRFOP, /* Prefetch operation. */
1e6f4800 262 AARCH64_OPND_BARRIER_PSB, /* Barrier operand for PSB. */
f11ad6bc 263
582e12bf 264 AARCH64_OPND_SVE_ADDR_RI_S4x16, /* SVE [<Xn|SP>, #<simm4>*16]. */
98907a70
RS		 265 AARCH64_OPND_SVE_ADDR_RI_S4xVL, /* SVE [<Xn|SP>, #<simm4>, MUL VL]. */
266 AARCH64_OPND_SVE_ADDR_RI_S4x2xVL, /* SVE [<Xn|SP>, #<simm4>*2, MUL VL]. */
267 AARCH64_OPND_SVE_ADDR_RI_S4x3xVL, /* SVE [<Xn|SP>, #<simm4>*3, MUL VL]. */
268 AARCH64_OPND_SVE_ADDR_RI_S4x4xVL, /* SVE [<Xn|SP>, #<simm4>*4, MUL VL]. */
269 AARCH64_OPND_SVE_ADDR_RI_S6xVL, /* SVE [<Xn|SP>, #<simm6>, MUL VL]. */
270 AARCH64_OPND_SVE_ADDR_RI_S9xVL, /* SVE [<Xn|SP>, #<simm9>, MUL VL]. */
4df068de
RS		 271 AARCH64_OPND_SVE_ADDR_RI_U6, /* SVE [<Xn|SP>, #<uimm6>]. */
272 AARCH64_OPND_SVE_ADDR_RI_U6x2, /* SVE [<Xn|SP>, #<uimm6>*2]. */
273 AARCH64_OPND_SVE_ADDR_RI_U6x4, /* SVE [<Xn|SP>, #<uimm6>*4]. */
274 AARCH64_OPND_SVE_ADDR_RI_U6x8, /* SVE [<Xn|SP>, #<uimm6>*8]. */
275 AARCH64_OPND_SVE_ADDR_RR, /* SVE [<Xn|SP>, <Xm|XZR>]. */
276 AARCH64_OPND_SVE_ADDR_RR_LSL1, /* SVE [<Xn|SP>, <Xm|XZR>, LSL #1]. */
277 AARCH64_OPND_SVE_ADDR_RR_LSL2, /* SVE [<Xn|SP>, <Xm|XZR>, LSL #2]. */
278 AARCH64_OPND_SVE_ADDR_RR_LSL3, /* SVE [<Xn|SP>, <Xm|XZR>, LSL #3]. */
279 AARCH64_OPND_SVE_ADDR_RX, /* SVE [<Xn|SP>, <Xm>]. */
280 AARCH64_OPND_SVE_ADDR_RX_LSL1, /* SVE [<Xn|SP>, <Xm>, LSL #1]. */
281 AARCH64_OPND_SVE_ADDR_RX_LSL2, /* SVE [<Xn|SP>, <Xm>, LSL #2]. */
282 AARCH64_OPND_SVE_ADDR_RX_LSL3, /* SVE [<Xn|SP>, <Xm>, LSL #3]. */
283 AARCH64_OPND_SVE_ADDR_RZ, /* SVE [<Xn|SP>, Zm.D]. */
284 AARCH64_OPND_SVE_ADDR_RZ_LSL1, /* SVE [<Xn|SP>, Zm.D, LSL #1]. */
285 AARCH64_OPND_SVE_ADDR_RZ_LSL2, /* SVE [<Xn|SP>, Zm.D, LSL #2]. */
286 AARCH64_OPND_SVE_ADDR_RZ_LSL3, /* SVE [<Xn|SP>, Zm.D, LSL #3]. */
287 AARCH64_OPND_SVE_ADDR_RZ_XTW_14, /* SVE [<Xn|SP>, Zm.<T>, (S|U)XTW].
288 Bit 14 controls S/U choice. */
289 AARCH64_OPND_SVE_ADDR_RZ_XTW_22, /* SVE [<Xn|SP>, Zm.<T>, (S|U)XTW].
290 Bit 22 controls S/U choice. */
291 AARCH64_OPND_SVE_ADDR_RZ_XTW1_14, /* SVE [<Xn|SP>, Zm.<T>, (S|U)XTW #1].
292 Bit 14 controls S/U choice. */
293 AARCH64_OPND_SVE_ADDR_RZ_XTW1_22, /* SVE [<Xn|SP>, Zm.<T>, (S|U)XTW #1].
294 Bit 22 controls S/U choice. */
295 AARCH64_OPND_SVE_ADDR_RZ_XTW2_14, /* SVE [<Xn|SP>, Zm.<T>, (S|U)XTW #2].
296 Bit 14 controls S/U choice. */
297 AARCH64_OPND_SVE_ADDR_RZ_XTW2_22, /* SVE [<Xn|SP>, Zm.<T>, (S|U)XTW #2].
298 Bit 22 controls S/U choice. */
299 AARCH64_OPND_SVE_ADDR_RZ_XTW3_14, /* SVE [<Xn|SP>, Zm.<T>, (S|U)XTW #3].
300 Bit 14 controls S/U choice. */
301 AARCH64_OPND_SVE_ADDR_RZ_XTW3_22, /* SVE [<Xn|SP>, Zm.<T>, (S|U)XTW #3].
302 Bit 22 controls S/U choice. */
303 AARCH64_OPND_SVE_ADDR_ZI_U5, /* SVE [Zn.<T>, #<uimm5>]. */
304 AARCH64_OPND_SVE_ADDR_ZI_U5x2, /* SVE [Zn.<T>, #<uimm5>*2]. */
305 AARCH64_OPND_SVE_ADDR_ZI_U5x4, /* SVE [Zn.<T>, #<uimm5>*4]. */
306 AARCH64_OPND_SVE_ADDR_ZI_U5x8, /* SVE [Zn.<T>, #<uimm5>*8]. */
307 AARCH64_OPND_SVE_ADDR_ZZ_LSL, /* SVE [Zn.<T>, Zm,<T>, LSL #<msz>]. */
308 AARCH64_OPND_SVE_ADDR_ZZ_SXTW, /* SVE [Zn.<T>, Zm,<T>, SXTW #<msz>]. */
309 AARCH64_OPND_SVE_ADDR_ZZ_UXTW, /* SVE [Zn.<T>, Zm,<T>, UXTW #<msz>]. */
e950b345
RS		 310 AARCH64_OPND_SVE_AIMM, /* SVE unsigned arithmetic immediate. */
311 AARCH64_OPND_SVE_ASIMM, /* SVE signed arithmetic immediate. */
165d4950
RS		 312 AARCH64_OPND_SVE_FPIMM8, /* SVE 8-bit floating-point immediate. */
313 AARCH64_OPND_SVE_I1_HALF_ONE, /* SVE choice between 0.5 and 1.0. */
314 AARCH64_OPND_SVE_I1_HALF_TWO, /* SVE choice between 0.5 and 2.0. */
315 AARCH64_OPND_SVE_I1_ZERO_ONE, /* SVE choice between 0.0 and 1.0. */
582e12bf
RS		 316 AARCH64_OPND_SVE_IMM_ROT1, /* SVE 1-bit rotate operand (90 or 270). */
317 AARCH64_OPND_SVE_IMM_ROT2, /* SVE 2-bit rotate operand (N*90). */
e950b345
RS		 318 AARCH64_OPND_SVE_INV_LIMM, /* SVE inverted logical immediate. */
319 AARCH64_OPND_SVE_LIMM, /* SVE logical immediate. */
320 AARCH64_OPND_SVE_LIMM_MOV, /* SVE logical immediate for MOV. */
245d2e3f 321 AARCH64_OPND_SVE_PATTERN, /* SVE vector pattern enumeration. */
2442d846 322 AARCH64_OPND_SVE_PATTERN_SCALED, /* Likewise, with additional MUL factor. */
245d2e3f 323 AARCH64_OPND_SVE_PRFOP, /* SVE prefetch operation. */
f11ad6bc
RS		 324 AARCH64_OPND_SVE_Pd, /* SVE p0-p15 in Pd. */
325 AARCH64_OPND_SVE_Pg3, /* SVE p0-p7 in Pg. */
326 AARCH64_OPND_SVE_Pg4_5, /* SVE p0-p15 in Pg, bits [8,5]. */
327 AARCH64_OPND_SVE_Pg4_10, /* SVE p0-p15 in Pg, bits [13,10]. */
328 AARCH64_OPND_SVE_Pg4_16, /* SVE p0-p15 in Pg, bits [19,16]. */
329 AARCH64_OPND_SVE_Pm, /* SVE p0-p15 in Pm. */
330 AARCH64_OPND_SVE_Pn, /* SVE p0-p15 in Pn. */
331 AARCH64_OPND_SVE_Pt, /* SVE p0-p15 in Pt. */
047cd301
RS		 332 AARCH64_OPND_SVE_Rm, /* Integer Rm or ZR, alt. SVE position. */
333 AARCH64_OPND_SVE_Rn_SP, /* Integer Rn or SP, alt. SVE position. */
e950b345
RS		 334 AARCH64_OPND_SVE_SHLIMM_PRED, /* SVE shift left amount (predicated). */
335 AARCH64_OPND_SVE_SHLIMM_UNPRED, /* SVE shift left amount (unpredicated). */
336 AARCH64_OPND_SVE_SHRIMM_PRED, /* SVE shift right amount (predicated). */
337 AARCH64_OPND_SVE_SHRIMM_UNPRED, /* SVE shift right amount (unpredicated). */
338 AARCH64_OPND_SVE_SIMM5, /* SVE signed 5-bit immediate. */
339 AARCH64_OPND_SVE_SIMM5B, /* SVE secondary signed 5-bit immediate. */
340 AARCH64_OPND_SVE_SIMM6, /* SVE signed 6-bit immediate. */
341 AARCH64_OPND_SVE_SIMM8, /* SVE signed 8-bit immediate. */
342 AARCH64_OPND_SVE_UIMM3, /* SVE unsigned 3-bit immediate. */
343 AARCH64_OPND_SVE_UIMM7, /* SVE unsigned 7-bit immediate. */
344 AARCH64_OPND_SVE_UIMM8, /* SVE unsigned 8-bit immediate. */
345 AARCH64_OPND_SVE_UIMM8_53, /* SVE split unsigned 8-bit immediate. */
047cd301
RS		 346 AARCH64_OPND_SVE_VZn, /* Scalar SIMD&FP register in Zn field. */
347 AARCH64_OPND_SVE_Vd, /* Scalar SIMD&FP register in Vd. */
348 AARCH64_OPND_SVE_Vm, /* Scalar SIMD&FP register in Vm. */
349 AARCH64_OPND_SVE_Vn, /* Scalar SIMD&FP register in Vn. */
f11ad6bc
RS		 350 AARCH64_OPND_SVE_Za_5, /* SVE vector register in Za, bits [9,5]. */
351 AARCH64_OPND_SVE_Za_16, /* SVE vector register in Za, bits [20,16]. */
352 AARCH64_OPND_SVE_Zd, /* SVE vector register in Zd. */
353 AARCH64_OPND_SVE_Zm_5, /* SVE vector register in Zm, bits [9,5]. */
354 AARCH64_OPND_SVE_Zm_16, /* SVE vector register in Zm, bits [20,16]. */
582e12bf
RS		 355 AARCH64_OPND_SVE_Zm3_INDEX, /* z0-z7[0-3] in Zm, bits [20,16]. */
356 AARCH64_OPND_SVE_Zm3_22_INDEX, /* z0-z7[0-7] in Zm3_INDEX plus bit 22. */
357 AARCH64_OPND_SVE_Zm4_INDEX, /* z0-z15[0-1] in Zm, bits [20,16]. */
f11ad6bc
RS		 358 AARCH64_OPND_SVE_Zn, /* SVE vector register in Zn. */
359 AARCH64_OPND_SVE_Zn_INDEX, /* Indexed SVE vector register, for DUP. */
360 AARCH64_OPND_SVE_ZnxN, /* SVE vector register list in Zn. */
361 AARCH64_OPND_SVE_Zt, /* SVE vector register in Zt. */
362 AARCH64_OPND_SVE_ZtxN, /* SVE vector register list in Zt. */
f42f1a1d 363 AARCH64_OPND_SM3_IMM2, /* SM3 encodes lane in bits [13, 14]. */
a06ea964
NC		 364};
365
366/* Qualifier constrains an operand. It either specifies a variant of an
367 operand type or limits values available to an operand type.
368
369 N.B. Order is important; keep aarch64_opnd_qualifiers synced. */
370
371enum aarch64_opnd_qualifier
372{
373 /* Indicating no further qualification on an operand. */
374 AARCH64_OPND_QLF_NIL,
375
376 /* Qualifying an operand which is a general purpose (integer) register;
377 indicating the operand data size or a specific register. */
378 AARCH64_OPND_QLF_W, /* Wn, WZR or WSP. */
379 AARCH64_OPND_QLF_X, /* Xn, XZR or XSP. */
380 AARCH64_OPND_QLF_WSP, /* WSP. */
381 AARCH64_OPND_QLF_SP, /* SP. */
382
383 /* Qualifying an operand which is a floating-point register, a SIMD
384 vector element or a SIMD vector element list; indicating operand data
385 size or the size of each SIMD vector element in the case of a SIMD
386 vector element list.
387 These qualifiers are also used to qualify an address operand to
388 indicate the size of data element a load/store instruction is
389 accessing.
390 They are also used for the immediate shift operand in e.g. SSHR. Such
391 a use is only for the ease of operand encoding/decoding and qualifier
392 sequence matching; such a use should not be applied widely; use the value
393 constraint qualifiers for immediate operands wherever possible. */
394 AARCH64_OPND_QLF_S_B,
395 AARCH64_OPND_QLF_S_H,
396 AARCH64_OPND_QLF_S_S,
397 AARCH64_OPND_QLF_S_D,
398 AARCH64_OPND_QLF_S_Q,
399
400 /* Qualifying an operand which is a SIMD vector register or a SIMD vector
401 register list; indicating register shape.
402 They are also used for the immediate shift operand in e.g. SSHR. Such
403 a use is only for the ease of operand encoding/decoding and qualifier
404 sequence matching; such a use should not be applied widely; use the value
405 constraint qualifiers for immediate operands wherever possible. */
a3b3345a 406 AARCH64_OPND_QLF_V_4B,
a06ea964
NC		 407 AARCH64_OPND_QLF_V_8B,
408 AARCH64_OPND_QLF_V_16B,
3067d3b9 409 AARCH64_OPND_QLF_V_2H,
a06ea964
NC		 410 AARCH64_OPND_QLF_V_4H,
411 AARCH64_OPND_QLF_V_8H,
412 AARCH64_OPND_QLF_V_2S,
413 AARCH64_OPND_QLF_V_4S,
414 AARCH64_OPND_QLF_V_1D,
415 AARCH64_OPND_QLF_V_2D,
416 AARCH64_OPND_QLF_V_1Q,
417
d50c751e
RS		 418 AARCH64_OPND_QLF_P_Z,
419 AARCH64_OPND_QLF_P_M,
420
a06ea964 421 /* Constraint on value. */
a6a51754 422 AARCH64_OPND_QLF_CR, /* CRn, CRm. */
a06ea964
NC		 423 AARCH64_OPND_QLF_imm_0_7,
424 AARCH64_OPND_QLF_imm_0_15,
425 AARCH64_OPND_QLF_imm_0_31,
426 AARCH64_OPND_QLF_imm_0_63,
427 AARCH64_OPND_QLF_imm_1_32,
428 AARCH64_OPND_QLF_imm_1_64,
429
430 /* Indicate whether an AdvSIMD modified immediate operand is shift-zeros
431 or shift-ones. */
432 AARCH64_OPND_QLF_LSL,
433 AARCH64_OPND_QLF_MSL,
434
435 /* Special qualifier helping retrieve qualifier information during the
436 decoding time (currently not in use). */
437 AARCH64_OPND_QLF_RETRIEVE,
438};
439\f
440/* Instruction class. */
441
442enum aarch64_insn_class
443{
444 addsub_carry,
445 addsub_ext,
446 addsub_imm,
447 addsub_shift,
448 asimdall,
449 asimddiff,
450 asimdelem,
451 asimdext,
452 asimdimm,
453 asimdins,
454 asimdmisc,
455 asimdperm,
456 asimdsame,
457 asimdshf,
458 asimdtbl,
459 asisddiff,
460 asisdelem,
461 asisdlse,
462 asisdlsep,
463 asisdlso,
464 asisdlsop,
465 asisdmisc,
466 asisdone,
467 asisdpair,
468 asisdsame,
469 asisdshf,
470 bitfield,
471 branch_imm,
472 branch_reg,
473 compbranch,
474 condbranch,
475 condcmp_imm,
476 condcmp_reg,
477 condsel,
478 cryptoaes,
479 cryptosha2,
480 cryptosha3,
481 dp_1src,
482 dp_2src,
483 dp_3src,
484 exception,
485 extract,
486 float2fix,
487 float2int,
488 floatccmp,
489 floatcmp,
490 floatdp1,
491 floatdp2,
492 floatdp3,
493 floatimm,
494 floatsel,
495 ldst_immpost,
496 ldst_immpre,
497 ldst_imm9, /* immpost or immpre */
3f06e550 498 ldst_imm10, /* LDRAA/LDRAB */
a06ea964
NC		 499 ldst_pos,
500 ldst_regoff,
501 ldst_unpriv,
502 ldst_unscaled,
503 ldstexcl,
504 ldstnapair_offs,
505 ldstpair_off,
506 ldstpair_indexed,
507 loadlit,
508 log_imm,
509 log_shift,
ee804238 510 lse_atomic,
a06ea964
NC		 511 movewide,
512 pcreladdr,
513 ic_system,
116b6019
RS		 514 sve_cpy,
515 sve_index,
516 sve_limm,
517 sve_misc,
518 sve_movprfx,
519 sve_pred_zm,
520 sve_shift_pred,
521 sve_shift_unpred,
522 sve_size_bhs,
523 sve_size_bhsd,
524 sve_size_hsd,
525 sve_size_sd,
a06ea964 526 testbranch,
f42f1a1d
TC		 527 cryptosm3,
528 cryptosm4,
65a55fbb 529 dotproduct,
a06ea964
NC		 530};
531
532/* Opcode enumerators. */
533
534enum aarch64_op
535{
536 OP_NIL,
537 OP_STRB_POS,
538 OP_LDRB_POS,
539 OP_LDRSB_POS,
540 OP_STRH_POS,
541 OP_LDRH_POS,
542 OP_LDRSH_POS,
543 OP_STR_POS,
544 OP_LDR_POS,
545 OP_STRF_POS,
546 OP_LDRF_POS,
547 OP_LDRSW_POS,
548 OP_PRFM_POS,
549
550 OP_STURB,
551 OP_LDURB,
552 OP_LDURSB,
553 OP_STURH,
554 OP_LDURH,
555 OP_LDURSH,
556 OP_STUR,
557 OP_LDUR,
558 OP_STURV,
559 OP_LDURV,
560 OP_LDURSW,
561 OP_PRFUM,
562
563 OP_LDR_LIT,
564 OP_LDRV_LIT,
565 OP_LDRSW_LIT,
566 OP_PRFM_LIT,
567
568 OP_ADD,
569 OP_B,
570 OP_BL,
571
572 OP_MOVN,
573 OP_MOVZ,
574 OP_MOVK,
575
576 OP_MOV_IMM_LOG, /* MOV alias for moving bitmask immediate. */
577 OP_MOV_IMM_WIDE, /* MOV alias for moving wide immediate. */
578 OP_MOV_IMM_WIDEN, /* MOV alias for moving wide immediate (negated). */
579
580 OP_MOV_V, /* MOV alias for moving vector register. */
581
582 OP_ASR_IMM,
583 OP_LSR_IMM,
584 OP_LSL_IMM,
585
586 OP_BIC,
587
588 OP_UBFX,
589 OP_BFXIL,
590 OP_SBFX,
591 OP_SBFIZ,
592 OP_BFI,
d685192a 593 OP_BFC, /* ARMv8.2. */
a06ea964
NC		 594 OP_UBFIZ,
595 OP_UXTB,
596 OP_UXTH,
597 OP_UXTW,
598
a06ea964
NC		 599 OP_CINC,
600 OP_CINV,
601 OP_CNEG,
602 OP_CSET,
603 OP_CSETM,
604
605 OP_FCVT,
606 OP_FCVTN,
607 OP_FCVTN2,
608 OP_FCVTL,
609 OP_FCVTL2,
610 OP_FCVTXN_S, /* Scalar version. */
611
612 OP_ROR_IMM,
613
e30181a5
YZ		 614 OP_SXTL,
615 OP_SXTL2,
616 OP_UXTL,
617 OP_UXTL2,
618
c0890d26
RS		 619 OP_MOV_P_P,
620 OP_MOV_Z_P_Z,
621 OP_MOV_Z_V,
622 OP_MOV_Z_Z,
623 OP_MOV_Z_Zi,
624 OP_MOVM_P_P_P,
625 OP_MOVS_P_P,
626 OP_MOVZS_P_P_P,
627 OP_MOVZ_P_P_P,
628 OP_NOTS_P_P_P_Z,
629 OP_NOT_P_P_P_Z,
630
c2c4ff8d
SN		 631 OP_FCMLA_ELEM, /* ARMv8.3, indexed element version. */
632
a06ea964
NC		 633 OP_TOTAL_NUM, /* Pseudo. */
634};
635
636/* Maximum number of operands an instruction can have. */
637#define AARCH64_MAX_OPND_NUM 6
638/* Maximum number of qualifier sequences an instruction can have. */
639#define AARCH64_MAX_QLF_SEQ_NUM 10
640/* Operand qualifier typedef; optimized for the size. */
641typedef unsigned char aarch64_opnd_qualifier_t;
642/* Operand qualifier sequence typedef. */
643typedef aarch64_opnd_qualifier_t \
644 aarch64_opnd_qualifier_seq_t [AARCH64_MAX_OPND_NUM];
645
646/* FIXME: improve the efficiency. */
647static inline bfd_boolean
648empty_qualifier_sequence_p (const aarch64_opnd_qualifier_t *qualifiers)
649{
650 int i;
651 for (i = 0; i < AARCH64_MAX_OPND_NUM; ++i)
652 if (qualifiers[i] != AARCH64_OPND_QLF_NIL)
653 return FALSE;
654 return TRUE;
655}
656
657/* This structure holds information for a particular opcode. */
658
659struct aarch64_opcode
660{
661 /* The name of the mnemonic. */
662 const char *name;
663
664 /* The opcode itself. Those bits which will be filled in with
665 operands are zeroes. */
666 aarch64_insn opcode;
667
668 /* The opcode mask. This is used by the disassembler. This is a
669 mask containing ones indicating those bits which must match the
670 opcode field, and zeroes indicating those bits which need not
671 match (and are presumably filled in by operands). */
672 aarch64_insn mask;
673
674 /* Instruction class. */
675 enum aarch64_insn_class iclass;
676
677 /* Enumerator identifier. */
678 enum aarch64_op op;
679
680 /* Which architecture variant provides this instruction. */
681 const aarch64_feature_set *avariant;
682
683 /* An array of operand codes. Each code is an index into the
684 operand table. They appear in the order which the operands must
685 appear in assembly code, and are terminated by a zero. */
686 enum aarch64_opnd operands[AARCH64_MAX_OPND_NUM];
687
688 /* A list of operand qualifier code sequence. Each operand qualifier
689 code qualifies the corresponding operand code. Each operand
690 qualifier sequence specifies a valid opcode variant and related
691 constraint on operands. */
692 aarch64_opnd_qualifier_seq_t qualifiers_list[AARCH64_MAX_QLF_SEQ_NUM];
693
694 /* Flags providing information about this instruction */
695 uint32_t flags;
4bd13cde 696
0c608d6b
RS		 697 /* If nonzero, this operand and operand 0 are both registers and
698 are required to have the same register number. */
699 unsigned char tied_operand;
700
4bd13cde
NC		 701 /* If non-NULL, a function to verify that a given instruction is valid. */
702 bfd_boolean (* verifier) (const struct aarch64_opcode *, const aarch64_insn);
a06ea964
NC		 703};
704
705typedef struct aarch64_opcode aarch64_opcode;
706
707/* Table describing all the AArch64 opcodes. */
708extern aarch64_opcode aarch64_opcode_table[];
709
710/* Opcode flags. */
711#define F_ALIAS (1 << 0)
712#define F_HAS_ALIAS (1 << 1)
713/* Disassembly preference priority 1-3 (the larger the higher). If nothing
714 is specified, it is the priority 0 by default, i.e. the lowest priority. */
715#define F_P1 (1 << 2)
716#define F_P2 (2 << 2)
717#define F_P3 (3 << 2)
718/* Flag an instruction that is truly conditional executed, e.g. b.cond. */
719#define F_COND (1 << 4)
720/* Instruction has the field of 'sf'. */
721#define F_SF (1 << 5)
722/* Instruction has the field of 'size:Q'. */
723#define F_SIZEQ (1 << 6)
724/* Floating-point instruction has the field of 'type'. */
725#define F_FPTYPE (1 << 7)
726/* AdvSIMD scalar instruction has the field of 'size'. */
727#define F_SSIZE (1 << 8)
728/* AdvSIMD vector register arrangement specifier encoded in "imm5<3:0>:Q". */
729#define F_T (1 << 9)
730/* Size of GPR operand in AdvSIMD instructions encoded in Q. */
731#define F_GPRSIZE_IN_Q (1 << 10)
732/* Size of Rt load signed instruction encoded in opc[0], i.e. bit 22. */
733#define F_LDS_SIZE (1 << 11)
734/* Optional operand; assume maximum of 1 operand can be optional. */
735#define F_OPD0_OPT (1 << 12)
736#define F_OPD1_OPT (2 << 12)
737#define F_OPD2_OPT (3 << 12)
738#define F_OPD3_OPT (4 << 12)
739#define F_OPD4_OPT (5 << 12)
740/* Default value for the optional operand when omitted from the assembly. */
741#define F_DEFAULT(X) (((X) & 0x1f) << 15)
742/* Instruction that is an alias of another instruction needs to be
743 encoded/decoded by converting it to/from the real form, followed by
744 the encoding/decoding according to the rules of the real opcode.
745 This compares to the direct coding using the alias's information.
746 N.B. this flag requires F_ALIAS to be used together. */
747#define F_CONV (1 << 20)
748/* Use together with F_ALIAS to indicate an alias opcode is a programmer
749 friendly pseudo instruction available only in the assembly code (thus will
750 not show up in the disassembly). */
751#define F_PSEUDO (1 << 21)
752/* Instruction has miscellaneous encoding/decoding rules. */
753#define F_MISC (1 << 22)
754/* Instruction has the field of 'N'; used in conjunction with F_SF. */
755#define F_N (1 << 23)
756/* Opcode dependent field. */
757#define F_OD(X) (((X) & 0x7) << 24)
ee804238
JW		 758/* Instruction has the field of 'sz'. */
759#define F_LSE_SZ (1 << 27)
4989adac
RS		 760/* Require an exact qualifier match, even for NIL qualifiers. */
761#define F_STRICT (1ULL << 28)
762/* Next bit is 29. */
a06ea964
NC		 763
764static inline bfd_boolean
765alias_opcode_p (const aarch64_opcode *opcode)
766{
767 return (opcode->flags & F_ALIAS) ? TRUE : FALSE;
768}
769
770static inline bfd_boolean
771opcode_has_alias (const aarch64_opcode *opcode)
772{
773 return (opcode->flags & F_HAS_ALIAS) ? TRUE : FALSE;
774}
775
776/* Priority for disassembling preference. */
777static inline int
778opcode_priority (const aarch64_opcode *opcode)
779{
780 return (opcode->flags >> 2) & 0x3;
781}
782
783static inline bfd_boolean
784pseudo_opcode_p (const aarch64_opcode *opcode)
785{
786 return (opcode->flags & F_PSEUDO) != 0lu ? TRUE : FALSE;
787}
788
789static inline bfd_boolean
790optional_operand_p (const aarch64_opcode *opcode, unsigned int idx)
791{
792 return (((opcode->flags >> 12) & 0x7) == idx + 1)
793 ? TRUE : FALSE;
794}
795
796static inline aarch64_insn
797get_optional_operand_default_value (const aarch64_opcode *opcode)
798{
799 return (opcode->flags >> 15) & 0x1f;
800}
801
802static inline unsigned int
803get_opcode_dependent_value (const aarch64_opcode *opcode)
804{
805 return (opcode->flags >> 24) & 0x7;
806}
807
808static inline bfd_boolean
809opcode_has_special_coder (const aarch64_opcode *opcode)
810{
ee804238 811 return (opcode->flags & (F_SF | F_LSE_SZ | F_SIZEQ | F_FPTYPE | F_SSIZE | F_T
a06ea964
NC		 812 | F_GPRSIZE_IN_Q | F_LDS_SIZE | F_MISC | F_N | F_COND)) ? TRUE
813 : FALSE;
814}
815\f
816struct aarch64_name_value_pair
817{
818 const char * name;
819 aarch64_insn value;
820};
821
822extern const struct aarch64_name_value_pair aarch64_operand_modifiers [];
a06ea964
NC		 823extern const struct aarch64_name_value_pair aarch64_barrier_options [16];
824extern const struct aarch64_name_value_pair aarch64_prfops [32];
9ed608f9 825extern const struct aarch64_name_value_pair aarch64_hint_options [];
a06ea964 826
49eec193
YZ		 827typedef struct
828{
829 const char * name;
830 aarch64_insn value;
831 uint32_t flags;
832} aarch64_sys_reg;
833
834extern const aarch64_sys_reg aarch64_sys_regs [];
87b8eed7 835extern const aarch64_sys_reg aarch64_pstatefields [];
49eec193 836extern bfd_boolean aarch64_sys_reg_deprecated_p (const aarch64_sys_reg *);
f21cce2c
MW		 837extern bfd_boolean aarch64_sys_reg_supported_p (const aarch64_feature_set,
838 const aarch64_sys_reg *);
839extern bfd_boolean aarch64_pstatefield_supported_p (const aarch64_feature_set,
840 const aarch64_sys_reg *);
49eec193 841
a06ea964
NC		 842typedef struct
843{
875880c6 844 const char *name;
a06ea964 845 uint32_t value;
ea2deeec 846 uint32_t flags ;
a06ea964
NC		 847} aarch64_sys_ins_reg;
848
ea2deeec 849extern bfd_boolean aarch64_sys_ins_reg_has_xt (const aarch64_sys_ins_reg *);
d6bf7ce6
MW		 850extern bfd_boolean
851aarch64_sys_ins_reg_supported_p (const aarch64_feature_set,
852 const aarch64_sys_ins_reg *);
ea2deeec 853
a06ea964
NC		 854extern const aarch64_sys_ins_reg aarch64_sys_regs_ic [];
855extern const aarch64_sys_ins_reg aarch64_sys_regs_dc [];
856extern const aarch64_sys_ins_reg aarch64_sys_regs_at [];
857extern const aarch64_sys_ins_reg aarch64_sys_regs_tlbi [];
858
859/* Shift/extending operator kinds.
860 N.B. order is important; keep aarch64_operand_modifiers synced. */
861enum aarch64_modifier_kind
862{
863 AARCH64_MOD_NONE,
864 AARCH64_MOD_MSL,
865 AARCH64_MOD_ROR,
866 AARCH64_MOD_ASR,
867 AARCH64_MOD_LSR,
868 AARCH64_MOD_LSL,
869 AARCH64_MOD_UXTB,
870 AARCH64_MOD_UXTH,
871 AARCH64_MOD_UXTW,
872 AARCH64_MOD_UXTX,
873 AARCH64_MOD_SXTB,
874 AARCH64_MOD_SXTH,
875 AARCH64_MOD_SXTW,
876 AARCH64_MOD_SXTX,
2442d846 877 AARCH64_MOD_MUL,
98907a70 878 AARCH64_MOD_MUL_VL,
a06ea964
NC		 879};
880
881bfd_boolean
882aarch64_extend_operator_p (enum aarch64_modifier_kind);
883
884enum aarch64_modifier_kind
885aarch64_get_operand_modifier (const struct aarch64_name_value_pair *);
886/* Condition. */
887
888typedef struct
889{
890 /* A list of names with the first one as the disassembly preference;
891 terminated by NULL if fewer than 3. */
bb7eff52 892 const char *names[4];
a06ea964
NC		 893 aarch64_insn value;
894} aarch64_cond;
895
896extern const aarch64_cond aarch64_conds[16];
897
898const aarch64_cond* get_cond_from_value (aarch64_insn value);
899const aarch64_cond* get_inverted_cond (const aarch64_cond *cond);
900\f
901/* Structure representing an operand. */
902
903struct aarch64_opnd_info
904{
905 enum aarch64_opnd type;
906 aarch64_opnd_qualifier_t qualifier;
907 int idx;
908
909 union
910 {
911 struct
912 {
913 unsigned regno;
914 } reg;
915 struct
916 {
dab26bf4
RS		 917 unsigned int regno;
918 int64_t index;
a06ea964
NC		 919 } reglane;
920 /* e.g. LVn. */
921 struct
922 {
923 unsigned first_regno : 5;
924 unsigned num_regs : 3;
925 /* 1 if it is a list of reg element. */
926 unsigned has_index : 1;
927 /* Lane index; valid only when has_index is 1. */
dab26bf4 928 int64_t index;
a06ea964
NC		 929 } reglist;
930 /* e.g. immediate or pc relative address offset. */
931 struct
932 {
933 int64_t value;
934 unsigned is_fp : 1;
935 } imm;
936 /* e.g. address in STR (register offset). */
937 struct
938 {
939 unsigned base_regno;
940 struct
941 {
942 union
943 {
944 int imm;
945 unsigned regno;
946 };
947 unsigned is_reg;
948 } offset;
949 unsigned pcrel : 1; /* PC-relative. */
950 unsigned writeback : 1;
951 unsigned preind : 1; /* Pre-indexed. */
952 unsigned postind : 1; /* Post-indexed. */
953 } addr;
954 const aarch64_cond *cond;
955 /* The encoding of the system register. */
956 aarch64_insn sysreg;
957 /* The encoding of the PSTATE field. */
958 aarch64_insn pstatefield;
959 const aarch64_sys_ins_reg *sysins_op;
960 const struct aarch64_name_value_pair *barrier;
9ed608f9 961 const struct aarch64_name_value_pair *hint_option;
a06ea964
NC		 962 const struct aarch64_name_value_pair *prfop;
963 };
964
965 /* Operand shifter; in use when the operand is a register offset address,
966 add/sub extended reg, etc. e.g. <R><m>{, <extend> {#<amount>}}. */
967 struct
968 {
969 enum aarch64_modifier_kind kind;
a06ea964
NC		 970 unsigned operator_present: 1; /* Only valid during encoding. */
971 /* Value of the 'S' field in ld/st reg offset; used only in decoding. */
972 unsigned amount_present: 1;
2442d846 973 int64_t amount;
a06ea964
NC		 974 } shifter;
975
976 unsigned skip:1; /* Operand is not completed if there is a fixup needed
977 to be done on it. In some (but not all) of these
978 cases, we need to tell libopcodes to skip the
979 constraint checking and the encoding for this
980 operand, so that the libopcodes can pick up the
981 right opcode before the operand is fixed-up. This
982 flag should only be used during the
983 assembling/encoding. */
984 unsigned present:1; /* Whether this operand is present in the assembly
985 line; not used during the disassembly. */
986};
987
988typedef struct aarch64_opnd_info aarch64_opnd_info;
989
990/* Structure representing an instruction.
991
992 It is used during both the assembling and disassembling. The assembler
993 fills an aarch64_inst after a successful parsing and then passes it to the
994 encoding routine to do the encoding. During the disassembling, the
995 disassembler calls the decoding routine to decode a binary instruction; on a
996 successful return, such a structure will be filled with information of the
997 instruction; then the disassembler uses the information to print out the
998 instruction. */
999
1000struct aarch64_inst
1001{
1002 /* The value of the binary instruction. */
1003 aarch64_insn value;
1004
1005 /* Corresponding opcode entry. */
1006 const aarch64_opcode *opcode;
1007
1008 /* Condition for a truly conditional-executed instrutions, e.g. b.cond. */
1009 const aarch64_cond *cond;
1010
1011 /* Operands information. */
1012 aarch64_opnd_info operands[AARCH64_MAX_OPND_NUM];
1013};
1014
1015typedef struct aarch64_inst aarch64_inst;
1016\f
1017/* Diagnosis related declaration and interface. */
1018
1019/* Operand error kind enumerators.
1020
1021 AARCH64_OPDE_RECOVERABLE
1022 Less severe error found during the parsing, very possibly because that
1023 GAS has picked up a wrong instruction template for the parsing.
1024
1025 AARCH64_OPDE_SYNTAX_ERROR
1026 General syntax error; it can be either a user error, or simply because
1027 that GAS is trying a wrong instruction template.
1028
1029 AARCH64_OPDE_FATAL_SYNTAX_ERROR
1030 Definitely a user syntax error.
1031
1032 AARCH64_OPDE_INVALID_VARIANT
1033 No syntax error, but the operands are not a valid combination, e.g.
1034 FMOV D0,S0
1035
0c608d6b
RS		 1036 AARCH64_OPDE_UNTIED_OPERAND
1037 The asm failed to use the same register for a destination operand
1038 and a tied source operand.
1039
a06ea964
NC		 1040 AARCH64_OPDE_OUT_OF_RANGE
1041 Error about some immediate value out of a valid range.
1042
1043 AARCH64_OPDE_UNALIGNED
1044 Error about some immediate value not properly aligned (i.e. not being a
1045 multiple times of a certain value).
1046
1047 AARCH64_OPDE_REG_LIST
1048 Error about the register list operand having unexpected number of
1049 registers.
1050
1051 AARCH64_OPDE_OTHER_ERROR
1052 Error of the highest severity and used for any severe issue that does not
1053 fall into any of the above categories.
1054
1055 The enumerators are only interesting to GAS. They are declared here (in
1056 libopcodes) because that some errors are detected (and then notified to GAS)
1057 by libopcodes (rather than by GAS solely).
1058
1059 The first three errors are only deteced by GAS while the
1060 AARCH64_OPDE_INVALID_VARIANT error can only be spotted by libopcodes as
1061 only libopcodes has the information about the valid variants of each
1062 instruction.
1063
1064 The enumerators have an increasing severity. This is helpful when there are
1065 multiple instruction templates available for a given mnemonic name (e.g.
1066 FMOV); this mechanism will help choose the most suitable template from which
1067 the generated diagnostics can most closely describe the issues, if any. */
1068
1069enum aarch64_operand_error_kind
1070{
1071 AARCH64_OPDE_NIL,
1072 AARCH64_OPDE_RECOVERABLE,
1073 AARCH64_OPDE_SYNTAX_ERROR,
1074 AARCH64_OPDE_FATAL_SYNTAX_ERROR,
1075 AARCH64_OPDE_INVALID_VARIANT,
0c608d6b 1076 AARCH64_OPDE_UNTIED_OPERAND,
a06ea964
NC		 1077 AARCH64_OPDE_OUT_OF_RANGE,
1078 AARCH64_OPDE_UNALIGNED,
1079 AARCH64_OPDE_REG_LIST,
1080 AARCH64_OPDE_OTHER_ERROR
1081};
1082
1083/* N.B. GAS assumes that this structure work well with shallow copy. */
1084struct aarch64_operand_error
1085{
1086 enum aarch64_operand_error_kind kind;
1087 int index;
1088 const char *error;
1089 int data[3]; /* Some data for extra information. */
1090};
1091
1092typedef struct aarch64_operand_error aarch64_operand_error;
1093
1094/* Encoding entrypoint. */
1095
1096extern int
1097aarch64_opcode_encode (const aarch64_opcode *, const aarch64_inst *,
1098 aarch64_insn *, aarch64_opnd_qualifier_t *,
1099 aarch64_operand_error *);
1100
1101extern const aarch64_opcode *
1102aarch64_replace_opcode (struct aarch64_inst *,
1103 const aarch64_opcode *);
1104
1105/* Given the opcode enumerator OP, return the pointer to the corresponding
1106 opcode entry. */
1107
1108extern const aarch64_opcode *
1109aarch64_get_opcode (enum aarch64_op);
1110
1111/* Generate the string representation of an operand. */
1112extern void
1113aarch64_print_operand (char *, size_t, bfd_vma, const aarch64_opcode *,
1114 const aarch64_opnd_info *, int, int *, bfd_vma *);
1115
1116/* Miscellaneous interface. */
1117
1118extern int
1119aarch64_operand_index (const enum aarch64_opnd *, enum aarch64_opnd);
1120
1121extern aarch64_opnd_qualifier_t
1122aarch64_get_expected_qualifier (const aarch64_opnd_qualifier_seq_t *, int,
1123 const aarch64_opnd_qualifier_t, int);
1124
1125extern int
1126aarch64_num_of_operands (const aarch64_opcode *);
1127
1128extern int
1129aarch64_stack_pointer_p (const aarch64_opnd_info *);
1130
e141d84e
YQ		 1131extern int
1132aarch64_zero_register_p (const aarch64_opnd_info *);
a06ea964 1133
36f4aab1 1134extern int
43cdf5ae 1135aarch64_decode_insn (aarch64_insn, aarch64_inst *, bfd_boolean);
36f4aab1 1136
a06ea964
NC		 1137/* Given an operand qualifier, return the expected data element size
1138 of a qualified operand. */
1139extern unsigned char
1140aarch64_get_qualifier_esize (aarch64_opnd_qualifier_t);
1141
1142extern enum aarch64_operand_class
1143aarch64_get_operand_class (enum aarch64_opnd);
1144
1145extern const char *
1146aarch64_get_operand_name (enum aarch64_opnd);
1147
1148extern const char *
1149aarch64_get_operand_desc (enum aarch64_opnd);
1150
e950b345
RS		 1151extern bfd_boolean
1152aarch64_sve_dupm_mov_immediate_p (uint64_t, int);
1153
a06ea964
NC		 1154#ifdef DEBUG_AARCH64
1155extern int debug_dump;
1156
1157extern void
1158aarch64_verbose (const char *, ...) __attribute__ ((format (printf, 1, 2)));
1159
1160#define DEBUG_TRACE(M, ...) \
1161 { \
1162 if (debug_dump) \
1163 aarch64_verbose ("%s: " M ".", __func__, ##__VA_ARGS__); \
1164 }
1165
1166#define DEBUG_TRACE_IF(C, M, ...) \
1167 { \
1168 if (debug_dump && (C)) \
1169 aarch64_verbose ("%s: " M ".", __func__, ##__VA_ARGS__); \
1170 }
1171#else /* !DEBUG_AARCH64 */
1172#define DEBUG_TRACE(M, ...) ;
1173#define DEBUG_TRACE_IF(C, M, ...) ;
1174#endif /* DEBUG_AARCH64 */
1175
245d2e3f
RS		 1176extern const char *const aarch64_sve_pattern_array[32];
1177extern const char *const aarch64_sve_prfop_array[16];
1178
d3e12b29
YQ		 1179#ifdef __cplusplus
1180}
1181#endif
1182
a06ea964 1183#endif /* OPCODE_AARCH64_H */
GDB Binutils - Deliverables
This page took 0.337686 seconds and 4 git commands to generate.