1 /* AArch64 assembler/disassembler support.
3 Copyright (C) 2009-2015 Free Software Foundation, Inc.
4 Contributed by ARM Ltd.
6 This file is part of GNU Binutils.
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.
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.
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/>. */
22 #ifndef OPCODE_AARCH64_H
23 #define OPCODE_AARCH64_H
26 #include "bfd_stdint.h"
30 /* The offset for pc-relative addressing is currently defined to be 0. */
31 #define AARCH64_PCREL_OFFSET 0
33 typedef uint32_t aarch64_insn
;
35 /* The following bitmasks control CPU features. */
36 #define AARCH64_FEATURE_V8 0x00000001 /* All processors. */
37 #define AARCH64_FEATURE_CRYPTO 0x00010000 /* Crypto instructions. */
38 #define AARCH64_FEATURE_FP 0x00020000 /* FP instructions. */
39 #define AARCH64_FEATURE_SIMD 0x00040000 /* SIMD instructions. */
40 #define AARCH64_FEATURE_CRC 0x00080000 /* CRC instructions. */
41 #define AARCH64_FEATURE_LSE 0x00100000 /* LSE instructions. */
42 #define AARCH64_FEATURE_PAN 0x00200000 /* PAN instructions. */
43 #define AARCH64_FEATURE_LOR 0x00400000 /* LOR instructions. */
44 #define AARCH64_FEATURE_RDMA 0x00800000 /* v8.1 SIMD instructions. */
46 /* Architectures are the sum of the base and extensions. */
47 #define AARCH64_ARCH_V8 AARCH64_FEATURE (AARCH64_FEATURE_V8, \
49 | AARCH64_FEATURE_SIMD)
50 #define AARCH64_ARCH_NONE AARCH64_FEATURE (0, 0)
51 #define AARCH64_ANY AARCH64_FEATURE (-1, 0) /* Any basic core. */
53 /* CPU-specific features. */
54 typedef unsigned long aarch64_feature_set
;
56 #define AARCH64_CPU_HAS_FEATURE(CPU,FEAT) \
57 (((CPU) & (FEAT)) != 0)
59 #define AARCH64_MERGE_FEATURE_SETS(TARG,F1,F2) \
62 (TARG) = (F1) | (F2); \
66 #define AARCH64_CLEAR_FEATURE(TARG,F1,F2) \
69 (TARG) = (F1) &~ (F2); \
73 #define AARCH64_FEATURE(core,coproc) ((core) | (coproc))
75 #define AARCH64_OPCODE_HAS_FEATURE(OPC,FEAT) \
76 (((OPC) & (FEAT)) != 0)
78 enum aarch64_operand_class
80 AARCH64_OPND_CLASS_NIL
,
81 AARCH64_OPND_CLASS_INT_REG
,
82 AARCH64_OPND_CLASS_MODIFIED_REG
,
83 AARCH64_OPND_CLASS_FP_REG
,
84 AARCH64_OPND_CLASS_SIMD_REG
,
85 AARCH64_OPND_CLASS_SIMD_ELEMENT
,
86 AARCH64_OPND_CLASS_SISD_REG
,
87 AARCH64_OPND_CLASS_SIMD_REGLIST
,
88 AARCH64_OPND_CLASS_CP_REG
,
89 AARCH64_OPND_CLASS_ADDRESS
,
90 AARCH64_OPND_CLASS_IMMEDIATE
,
91 AARCH64_OPND_CLASS_SYSTEM
,
92 AARCH64_OPND_CLASS_COND
,
95 /* Operand code that helps both parsing and coding.
96 Keep AARCH64_OPERANDS synced. */
100 AARCH64_OPND_NIL
, /* no operand---MUST BE FIRST!*/
102 AARCH64_OPND_Rd
, /* Integer register as destination. */
103 AARCH64_OPND_Rn
, /* Integer register as source. */
104 AARCH64_OPND_Rm
, /* Integer register as source. */
105 AARCH64_OPND_Rt
, /* Integer register used in ld/st instructions. */
106 AARCH64_OPND_Rt2
, /* Integer register used in ld/st pair instructions. */
107 AARCH64_OPND_Rs
, /* Integer register used in ld/st exclusive. */
108 AARCH64_OPND_Ra
, /* Integer register used in ddp_3src instructions. */
109 AARCH64_OPND_Rt_SYS
, /* Integer register used in system instructions. */
111 AARCH64_OPND_Rd_SP
, /* Integer Rd or SP. */
112 AARCH64_OPND_Rn_SP
, /* Integer Rn or SP. */
113 AARCH64_OPND_PAIRREG
, /* Paired register operand. */
114 AARCH64_OPND_Rm_EXT
, /* Integer Rm extended. */
115 AARCH64_OPND_Rm_SFT
, /* Integer Rm shifted. */
117 AARCH64_OPND_Fd
, /* Floating-point Fd. */
118 AARCH64_OPND_Fn
, /* Floating-point Fn. */
119 AARCH64_OPND_Fm
, /* Floating-point Fm. */
120 AARCH64_OPND_Fa
, /* Floating-point Fa. */
121 AARCH64_OPND_Ft
, /* Floating-point Ft. */
122 AARCH64_OPND_Ft2
, /* Floating-point Ft2. */
124 AARCH64_OPND_Sd
, /* AdvSIMD Scalar Sd. */
125 AARCH64_OPND_Sn
, /* AdvSIMD Scalar Sn. */
126 AARCH64_OPND_Sm
, /* AdvSIMD Scalar Sm. */
128 AARCH64_OPND_Vd
, /* AdvSIMD Vector Vd. */
129 AARCH64_OPND_Vn
, /* AdvSIMD Vector Vn. */
130 AARCH64_OPND_Vm
, /* AdvSIMD Vector Vm. */
131 AARCH64_OPND_VdD1
, /* AdvSIMD <Vd>.D[1]; for FMOV only. */
132 AARCH64_OPND_VnD1
, /* AdvSIMD <Vn>.D[1]; for FMOV only. */
133 AARCH64_OPND_Ed
, /* AdvSIMD Vector Element Vd. */
134 AARCH64_OPND_En
, /* AdvSIMD Vector Element Vn. */
135 AARCH64_OPND_Em
, /* AdvSIMD Vector Element Vm. */
136 AARCH64_OPND_LVn
, /* AdvSIMD Vector register list used in e.g. TBL. */
137 AARCH64_OPND_LVt
, /* AdvSIMD Vector register list used in ld/st. */
138 AARCH64_OPND_LVt_AL
, /* AdvSIMD Vector register list for loading single
139 structure to all lanes. */
140 AARCH64_OPND_LEt
, /* AdvSIMD Vector Element list. */
142 AARCH64_OPND_Cn
, /* Co-processor register in CRn field. */
143 AARCH64_OPND_Cm
, /* Co-processor register in CRm field. */
145 AARCH64_OPND_IDX
, /* AdvSIMD EXT index operand. */
146 AARCH64_OPND_IMM_VLSL
,/* Immediate for shifting vector registers left. */
147 AARCH64_OPND_IMM_VLSR
,/* Immediate for shifting vector registers right. */
148 AARCH64_OPND_SIMD_IMM
,/* AdvSIMD modified immediate without shift. */
149 AARCH64_OPND_SIMD_IMM_SFT
, /* AdvSIMD modified immediate with shift. */
150 AARCH64_OPND_SIMD_FPIMM
,/* AdvSIMD 8-bit fp immediate. */
151 AARCH64_OPND_SHLL_IMM
,/* Immediate shift for AdvSIMD SHLL instruction
153 AARCH64_OPND_IMM0
, /* Immediate for #0. */
154 AARCH64_OPND_FPIMM0
, /* Immediate for #0.0. */
155 AARCH64_OPND_FPIMM
, /* Floating-point Immediate. */
156 AARCH64_OPND_IMMR
, /* Immediate #<immr> in e.g. BFM. */
157 AARCH64_OPND_IMMS
, /* Immediate #<imms> in e.g. BFM. */
158 AARCH64_OPND_WIDTH
, /* Immediate #<width> in e.g. BFI. */
159 AARCH64_OPND_IMM
, /* Immediate. */
160 AARCH64_OPND_UIMM3_OP1
,/* Unsigned 3-bit immediate in the op1 field. */
161 AARCH64_OPND_UIMM3_OP2
,/* Unsigned 3-bit immediate in the op2 field. */
162 AARCH64_OPND_UIMM4
, /* Unsigned 4-bit immediate in the CRm field. */
163 AARCH64_OPND_UIMM7
, /* Unsigned 7-bit immediate in the CRm:op2 fields. */
164 AARCH64_OPND_BIT_NUM
, /* Immediate. */
165 AARCH64_OPND_EXCEPTION
,/* imm16 operand in exception instructions. */
166 AARCH64_OPND_CCMP_IMM
,/* Immediate in conditional compare instructions. */
167 AARCH64_OPND_NZCV
, /* Flag bit specifier giving an alternative value for
168 each condition flag. */
170 AARCH64_OPND_LIMM
, /* Logical Immediate. */
171 AARCH64_OPND_AIMM
, /* Arithmetic immediate. */
172 AARCH64_OPND_HALF
, /* #<imm16>{, LSL #<shift>} operand in move wide. */
173 AARCH64_OPND_FBITS
, /* FP #<fbits> operand in e.g. SCVTF */
174 AARCH64_OPND_IMM_MOV
, /* Immediate operand for the MOV alias. */
176 AARCH64_OPND_COND
, /* Standard condition as the last operand. */
177 AARCH64_OPND_COND1
, /* Same as the above, but excluding AL and NV. */
179 AARCH64_OPND_ADDR_ADRP
, /* Memory address for ADRP */
180 AARCH64_OPND_ADDR_PCREL14
, /* 14-bit PC-relative address for e.g. TBZ. */
181 AARCH64_OPND_ADDR_PCREL19
, /* 19-bit PC-relative address for e.g. LDR. */
182 AARCH64_OPND_ADDR_PCREL21
, /* 21-bit PC-relative address for e.g. ADR. */
183 AARCH64_OPND_ADDR_PCREL26
, /* 26-bit PC-relative address for e.g. BL. */
185 AARCH64_OPND_ADDR_SIMPLE
, /* Address of ld/st exclusive. */
186 AARCH64_OPND_ADDR_REGOFF
, /* Address of register offset. */
187 AARCH64_OPND_ADDR_SIMM7
, /* Address of signed 7-bit immediate. */
188 AARCH64_OPND_ADDR_SIMM9
, /* Address of signed 9-bit immediate. */
189 AARCH64_OPND_ADDR_SIMM9_2
, /* Same as the above, but the immediate is
190 negative or unaligned and there is
191 no writeback allowed. This operand code
192 is only used to support the programmer-
193 friendly feature of using LDR/STR as the
194 the mnemonic name for LDUR/STUR instructions
195 wherever there is no ambiguity. */
196 AARCH64_OPND_ADDR_UIMM12
, /* Address of unsigned 12-bit immediate. */
197 AARCH64_OPND_SIMD_ADDR_SIMPLE
,/* Address of ld/st multiple structures. */
198 AARCH64_OPND_SIMD_ADDR_POST
, /* Address of ld/st multiple post-indexed. */
200 AARCH64_OPND_SYSREG
, /* System register operand. */
201 AARCH64_OPND_PSTATEFIELD
, /* PSTATE field name operand. */
202 AARCH64_OPND_SYSREG_AT
, /* System register <at_op> operand. */
203 AARCH64_OPND_SYSREG_DC
, /* System register <dc_op> operand. */
204 AARCH64_OPND_SYSREG_IC
, /* System register <ic_op> operand. */
205 AARCH64_OPND_SYSREG_TLBI
, /* System register <tlbi_op> operand. */
206 AARCH64_OPND_BARRIER
, /* Barrier operand. */
207 AARCH64_OPND_BARRIER_ISB
, /* Barrier operand for ISB. */
208 AARCH64_OPND_PRFOP
, /* Prefetch operation. */
211 /* Qualifier constrains an operand. It either specifies a variant of an
212 operand type or limits values available to an operand type.
214 N.B. Order is important; keep aarch64_opnd_qualifiers synced. */
216 enum aarch64_opnd_qualifier
218 /* Indicating no further qualification on an operand. */
219 AARCH64_OPND_QLF_NIL
,
221 /* Qualifying an operand which is a general purpose (integer) register;
222 indicating the operand data size or a specific register. */
223 AARCH64_OPND_QLF_W
, /* Wn, WZR or WSP. */
224 AARCH64_OPND_QLF_X
, /* Xn, XZR or XSP. */
225 AARCH64_OPND_QLF_WSP
, /* WSP. */
226 AARCH64_OPND_QLF_SP
, /* SP. */
228 /* Qualifying an operand which is a floating-point register, a SIMD
229 vector element or a SIMD vector element list; indicating operand data
230 size or the size of each SIMD vector element in the case of a SIMD
232 These qualifiers are also used to qualify an address operand to
233 indicate the size of data element a load/store instruction is
235 They are also used for the immediate shift operand in e.g. SSHR. Such
236 a use is only for the ease of operand encoding/decoding and qualifier
237 sequence matching; such a use should not be applied widely; use the value
238 constraint qualifiers for immediate operands wherever possible. */
239 AARCH64_OPND_QLF_S_B
,
240 AARCH64_OPND_QLF_S_H
,
241 AARCH64_OPND_QLF_S_S
,
242 AARCH64_OPND_QLF_S_D
,
243 AARCH64_OPND_QLF_S_Q
,
245 /* Qualifying an operand which is a SIMD vector register or a SIMD vector
246 register list; indicating register shape.
247 They are also used for the immediate shift operand in e.g. SSHR. Such
248 a use is only for the ease of operand encoding/decoding and qualifier
249 sequence matching; such a use should not be applied widely; use the value
250 constraint qualifiers for immediate operands wherever possible. */
251 AARCH64_OPND_QLF_V_8B
,
252 AARCH64_OPND_QLF_V_16B
,
253 AARCH64_OPND_QLF_V_4H
,
254 AARCH64_OPND_QLF_V_8H
,
255 AARCH64_OPND_QLF_V_2S
,
256 AARCH64_OPND_QLF_V_4S
,
257 AARCH64_OPND_QLF_V_1D
,
258 AARCH64_OPND_QLF_V_2D
,
259 AARCH64_OPND_QLF_V_1Q
,
261 /* Constraint on value. */
262 AARCH64_OPND_QLF_imm_0_7
,
263 AARCH64_OPND_QLF_imm_0_15
,
264 AARCH64_OPND_QLF_imm_0_31
,
265 AARCH64_OPND_QLF_imm_0_63
,
266 AARCH64_OPND_QLF_imm_1_32
,
267 AARCH64_OPND_QLF_imm_1_64
,
269 /* Indicate whether an AdvSIMD modified immediate operand is shift-zeros
271 AARCH64_OPND_QLF_LSL
,
272 AARCH64_OPND_QLF_MSL
,
274 /* Special qualifier helping retrieve qualifier information during the
275 decoding time (currently not in use). */
276 AARCH64_OPND_QLF_RETRIEVE
,
279 /* Instruction class. */
281 enum aarch64_insn_class
336 ldst_imm9
, /* immpost or immpre */
355 /* Opcode enumerators. */
399 OP_MOV_IMM_LOG
, /* MOV alias for moving bitmask immediate. */
400 OP_MOV_IMM_WIDE
, /* MOV alias for moving wide immediate. */
401 OP_MOV_IMM_WIDEN
, /* MOV alias for moving wide immediate (negated). */
403 OP_MOV_V
, /* MOV alias for moving vector register. */
432 OP_FCVTXN_S
, /* Scalar version. */
441 OP_TOTAL_NUM
, /* Pseudo. */
444 /* Maximum number of operands an instruction can have. */
445 #define AARCH64_MAX_OPND_NUM 6
446 /* Maximum number of qualifier sequences an instruction can have. */
447 #define AARCH64_MAX_QLF_SEQ_NUM 10
448 /* Operand qualifier typedef; optimized for the size. */
449 typedef unsigned char aarch64_opnd_qualifier_t
;
450 /* Operand qualifier sequence typedef. */
451 typedef aarch64_opnd_qualifier_t \
452 aarch64_opnd_qualifier_seq_t
[AARCH64_MAX_OPND_NUM
];
454 /* FIXME: improve the efficiency. */
455 static inline bfd_boolean
456 empty_qualifier_sequence_p (const aarch64_opnd_qualifier_t
*qualifiers
)
459 for (i
= 0; i
< AARCH64_MAX_OPND_NUM
; ++i
)
460 if (qualifiers
[i
] != AARCH64_OPND_QLF_NIL
)
465 /* This structure holds information for a particular opcode. */
467 struct aarch64_opcode
469 /* The name of the mnemonic. */
472 /* The opcode itself. Those bits which will be filled in with
473 operands are zeroes. */
476 /* The opcode mask. This is used by the disassembler. This is a
477 mask containing ones indicating those bits which must match the
478 opcode field, and zeroes indicating those bits which need not
479 match (and are presumably filled in by operands). */
482 /* Instruction class. */
483 enum aarch64_insn_class iclass
;
485 /* Enumerator identifier. */
488 /* Which architecture variant provides this instruction. */
489 const aarch64_feature_set
*avariant
;
491 /* An array of operand codes. Each code is an index into the
492 operand table. They appear in the order which the operands must
493 appear in assembly code, and are terminated by a zero. */
494 enum aarch64_opnd operands
[AARCH64_MAX_OPND_NUM
];
496 /* A list of operand qualifier code sequence. Each operand qualifier
497 code qualifies the corresponding operand code. Each operand
498 qualifier sequence specifies a valid opcode variant and related
499 constraint on operands. */
500 aarch64_opnd_qualifier_seq_t qualifiers_list
[AARCH64_MAX_QLF_SEQ_NUM
];
502 /* Flags providing information about this instruction */
506 typedef struct aarch64_opcode aarch64_opcode
;
508 /* Table describing all the AArch64 opcodes. */
509 extern aarch64_opcode aarch64_opcode_table
[];
512 #define F_ALIAS (1 << 0)
513 #define F_HAS_ALIAS (1 << 1)
514 /* Disassembly preference priority 1-3 (the larger the higher). If nothing
515 is specified, it is the priority 0 by default, i.e. the lowest priority. */
516 #define F_P1 (1 << 2)
517 #define F_P2 (2 << 2)
518 #define F_P3 (3 << 2)
519 /* Flag an instruction that is truly conditional executed, e.g. b.cond. */
520 #define F_COND (1 << 4)
521 /* Instruction has the field of 'sf'. */
522 #define F_SF (1 << 5)
523 /* Instruction has the field of 'size:Q'. */
524 #define F_SIZEQ (1 << 6)
525 /* Floating-point instruction has the field of 'type'. */
526 #define F_FPTYPE (1 << 7)
527 /* AdvSIMD scalar instruction has the field of 'size'. */
528 #define F_SSIZE (1 << 8)
529 /* AdvSIMD vector register arrangement specifier encoded in "imm5<3:0>:Q". */
531 /* Size of GPR operand in AdvSIMD instructions encoded in Q. */
532 #define F_GPRSIZE_IN_Q (1 << 10)
533 /* Size of Rt load signed instruction encoded in opc[0], i.e. bit 22. */
534 #define F_LDS_SIZE (1 << 11)
535 /* Optional operand; assume maximum of 1 operand can be optional. */
536 #define F_OPD0_OPT (1 << 12)
537 #define F_OPD1_OPT (2 << 12)
538 #define F_OPD2_OPT (3 << 12)
539 #define F_OPD3_OPT (4 << 12)
540 #define F_OPD4_OPT (5 << 12)
541 /* Default value for the optional operand when omitted from the assembly. */
542 #define F_DEFAULT(X) (((X) & 0x1f) << 15)
543 /* Instruction that is an alias of another instruction needs to be
544 encoded/decoded by converting it to/from the real form, followed by
545 the encoding/decoding according to the rules of the real opcode.
546 This compares to the direct coding using the alias's information.
547 N.B. this flag requires F_ALIAS to be used together. */
548 #define F_CONV (1 << 20)
549 /* Use together with F_ALIAS to indicate an alias opcode is a programmer
550 friendly pseudo instruction available only in the assembly code (thus will
551 not show up in the disassembly). */
552 #define F_PSEUDO (1 << 21)
553 /* Instruction has miscellaneous encoding/decoding rules. */
554 #define F_MISC (1 << 22)
555 /* Instruction has the field of 'N'; used in conjunction with F_SF. */
556 #define F_N (1 << 23)
557 /* Opcode dependent field. */
558 #define F_OD(X) (((X) & 0x7) << 24)
559 /* Instruction has the field of 'sz'. */
560 #define F_LSE_SZ (1 << 27)
561 /* Next bit is 28. */
563 static inline bfd_boolean
564 alias_opcode_p (const aarch64_opcode
*opcode
)
566 return (opcode
->flags
& F_ALIAS
) ? TRUE
: FALSE
;
569 static inline bfd_boolean
570 opcode_has_alias (const aarch64_opcode
*opcode
)
572 return (opcode
->flags
& F_HAS_ALIAS
) ? TRUE
: FALSE
;
575 /* Priority for disassembling preference. */
577 opcode_priority (const aarch64_opcode
*opcode
)
579 return (opcode
->flags
>> 2) & 0x3;
582 static inline bfd_boolean
583 pseudo_opcode_p (const aarch64_opcode
*opcode
)
585 return (opcode
->flags
& F_PSEUDO
) != 0lu ? TRUE
: FALSE
;
588 static inline bfd_boolean
589 optional_operand_p (const aarch64_opcode
*opcode
, unsigned int idx
)
591 return (((opcode
->flags
>> 12) & 0x7) == idx
+ 1)
595 static inline aarch64_insn
596 get_optional_operand_default_value (const aarch64_opcode
*opcode
)
598 return (opcode
->flags
>> 15) & 0x1f;
601 static inline unsigned int
602 get_opcode_dependent_value (const aarch64_opcode
*opcode
)
604 return (opcode
->flags
>> 24) & 0x7;
607 static inline bfd_boolean
608 opcode_has_special_coder (const aarch64_opcode
*opcode
)
610 return (opcode
->flags
& (F_SF
| F_LSE_SZ
| F_SIZEQ
| F_FPTYPE
| F_SSIZE
| F_T
611 | F_GPRSIZE_IN_Q
| F_LDS_SIZE
| F_MISC
| F_N
| F_COND
)) ? TRUE
615 struct aarch64_name_value_pair
621 extern const struct aarch64_name_value_pair aarch64_operand_modifiers
[];
622 extern const struct aarch64_name_value_pair aarch64_barrier_options
[16];
623 extern const struct aarch64_name_value_pair aarch64_prfops
[32];
632 extern const aarch64_sys_reg aarch64_sys_regs
[];
633 extern const aarch64_sys_reg aarch64_pstatefields
[];
634 extern bfd_boolean
aarch64_sys_reg_deprecated_p (const aarch64_sys_reg
*);
635 extern bfd_boolean
aarch64_sys_reg_supported_p (const aarch64_feature_set
,
636 const aarch64_sys_reg
*);
637 extern bfd_boolean
aarch64_pstatefield_supported_p (const aarch64_feature_set
,
638 const aarch64_sys_reg
*);
642 const char *template;
645 } aarch64_sys_ins_reg
;
647 extern const aarch64_sys_ins_reg aarch64_sys_regs_ic
[];
648 extern const aarch64_sys_ins_reg aarch64_sys_regs_dc
[];
649 extern const aarch64_sys_ins_reg aarch64_sys_regs_at
[];
650 extern const aarch64_sys_ins_reg aarch64_sys_regs_tlbi
[];
652 /* Shift/extending operator kinds.
653 N.B. order is important; keep aarch64_operand_modifiers synced. */
654 enum aarch64_modifier_kind
673 aarch64_extend_operator_p (enum aarch64_modifier_kind
);
675 enum aarch64_modifier_kind
676 aarch64_get_operand_modifier (const struct aarch64_name_value_pair
*);
681 /* A list of names with the first one as the disassembly preference;
682 terminated by NULL if fewer than 3. */
683 const char *names
[3];
687 extern const aarch64_cond aarch64_conds
[16];
689 const aarch64_cond
* get_cond_from_value (aarch64_insn value
);
690 const aarch64_cond
* get_inverted_cond (const aarch64_cond
*cond
);
692 /* Structure representing an operand. */
694 struct aarch64_opnd_info
696 enum aarch64_opnd type
;
697 aarch64_opnd_qualifier_t qualifier
;
714 unsigned first_regno
: 5;
715 unsigned num_regs
: 3;
716 /* 1 if it is a list of reg element. */
717 unsigned has_index
: 1;
718 /* Lane index; valid only when has_index is 1. */
721 /* e.g. immediate or pc relative address offset. */
727 /* e.g. address in STR (register offset). */
740 unsigned pcrel
: 1; /* PC-relative. */
741 unsigned writeback
: 1;
742 unsigned preind
: 1; /* Pre-indexed. */
743 unsigned postind
: 1; /* Post-indexed. */
745 const aarch64_cond
*cond
;
746 /* The encoding of the system register. */
748 /* The encoding of the PSTATE field. */
749 aarch64_insn pstatefield
;
750 const aarch64_sys_ins_reg
*sysins_op
;
751 const struct aarch64_name_value_pair
*barrier
;
752 const struct aarch64_name_value_pair
*prfop
;
755 /* Operand shifter; in use when the operand is a register offset address,
756 add/sub extended reg, etc. e.g. <R><m>{, <extend> {#<amount>}}. */
759 enum aarch64_modifier_kind kind
;
761 unsigned operator_present
: 1; /* Only valid during encoding. */
762 /* Value of the 'S' field in ld/st reg offset; used only in decoding. */
763 unsigned amount_present
: 1;
766 unsigned skip
:1; /* Operand is not completed if there is a fixup needed
767 to be done on it. In some (but not all) of these
768 cases, we need to tell libopcodes to skip the
769 constraint checking and the encoding for this
770 operand, so that the libopcodes can pick up the
771 right opcode before the operand is fixed-up. This
772 flag should only be used during the
773 assembling/encoding. */
774 unsigned present
:1; /* Whether this operand is present in the assembly
775 line; not used during the disassembly. */
778 typedef struct aarch64_opnd_info aarch64_opnd_info
;
780 /* Structure representing an instruction.
782 It is used during both the assembling and disassembling. The assembler
783 fills an aarch64_inst after a successful parsing and then passes it to the
784 encoding routine to do the encoding. During the disassembling, the
785 disassembler calls the decoding routine to decode a binary instruction; on a
786 successful return, such a structure will be filled with information of the
787 instruction; then the disassembler uses the information to print out the
792 /* The value of the binary instruction. */
795 /* Corresponding opcode entry. */
796 const aarch64_opcode
*opcode
;
798 /* Condition for a truly conditional-executed instrutions, e.g. b.cond. */
799 const aarch64_cond
*cond
;
801 /* Operands information. */
802 aarch64_opnd_info operands
[AARCH64_MAX_OPND_NUM
];
805 typedef struct aarch64_inst aarch64_inst
;
807 /* Diagnosis related declaration and interface. */
809 /* Operand error kind enumerators.
811 AARCH64_OPDE_RECOVERABLE
812 Less severe error found during the parsing, very possibly because that
813 GAS has picked up a wrong instruction template for the parsing.
815 AARCH64_OPDE_SYNTAX_ERROR
816 General syntax error; it can be either a user error, or simply because
817 that GAS is trying a wrong instruction template.
819 AARCH64_OPDE_FATAL_SYNTAX_ERROR
820 Definitely a user syntax error.
822 AARCH64_OPDE_INVALID_VARIANT
823 No syntax error, but the operands are not a valid combination, e.g.
826 AARCH64_OPDE_OUT_OF_RANGE
827 Error about some immediate value out of a valid range.
829 AARCH64_OPDE_UNALIGNED
830 Error about some immediate value not properly aligned (i.e. not being a
831 multiple times of a certain value).
833 AARCH64_OPDE_REG_LIST
834 Error about the register list operand having unexpected number of
837 AARCH64_OPDE_OTHER_ERROR
838 Error of the highest severity and used for any severe issue that does not
839 fall into any of the above categories.
841 The enumerators are only interesting to GAS. They are declared here (in
842 libopcodes) because that some errors are detected (and then notified to GAS)
843 by libopcodes (rather than by GAS solely).
845 The first three errors are only deteced by GAS while the
846 AARCH64_OPDE_INVALID_VARIANT error can only be spotted by libopcodes as
847 only libopcodes has the information about the valid variants of each
850 The enumerators have an increasing severity. This is helpful when there are
851 multiple instruction templates available for a given mnemonic name (e.g.
852 FMOV); this mechanism will help choose the most suitable template from which
853 the generated diagnostics can most closely describe the issues, if any. */
855 enum aarch64_operand_error_kind
858 AARCH64_OPDE_RECOVERABLE
,
859 AARCH64_OPDE_SYNTAX_ERROR
,
860 AARCH64_OPDE_FATAL_SYNTAX_ERROR
,
861 AARCH64_OPDE_INVALID_VARIANT
,
862 AARCH64_OPDE_OUT_OF_RANGE
,
863 AARCH64_OPDE_UNALIGNED
,
864 AARCH64_OPDE_REG_LIST
,
865 AARCH64_OPDE_OTHER_ERROR
868 /* N.B. GAS assumes that this structure work well with shallow copy. */
869 struct aarch64_operand_error
871 enum aarch64_operand_error_kind kind
;
874 int data
[3]; /* Some data for extra information. */
877 typedef struct aarch64_operand_error aarch64_operand_error
;
879 /* Encoding entrypoint. */
882 aarch64_opcode_encode (const aarch64_opcode
*, const aarch64_inst
*,
883 aarch64_insn
*, aarch64_opnd_qualifier_t
*,
884 aarch64_operand_error
*);
886 extern const aarch64_opcode
*
887 aarch64_replace_opcode (struct aarch64_inst
*,
888 const aarch64_opcode
*);
890 /* Given the opcode enumerator OP, return the pointer to the corresponding
893 extern const aarch64_opcode
*
894 aarch64_get_opcode (enum aarch64_op
);
896 /* Generate the string representation of an operand. */
898 aarch64_print_operand (char *, size_t, bfd_vma
, const aarch64_opcode
*,
899 const aarch64_opnd_info
*, int, int *, bfd_vma
*);
901 /* Miscellaneous interface. */
904 aarch64_operand_index (const enum aarch64_opnd
*, enum aarch64_opnd
);
906 extern aarch64_opnd_qualifier_t
907 aarch64_get_expected_qualifier (const aarch64_opnd_qualifier_seq_t
*, int,
908 const aarch64_opnd_qualifier_t
, int);
911 aarch64_num_of_operands (const aarch64_opcode
*);
914 aarch64_stack_pointer_p (const aarch64_opnd_info
*);
917 int aarch64_zero_register_p (const aarch64_opnd_info
*);
919 /* Given an operand qualifier, return the expected data element size
920 of a qualified operand. */
922 aarch64_get_qualifier_esize (aarch64_opnd_qualifier_t
);
924 extern enum aarch64_operand_class
925 aarch64_get_operand_class (enum aarch64_opnd
);
928 aarch64_get_operand_name (enum aarch64_opnd
);
931 aarch64_get_operand_desc (enum aarch64_opnd
);
934 extern int debug_dump
;
937 aarch64_verbose (const char *, ...) __attribute__ ((format (printf
, 1, 2)));
939 #define DEBUG_TRACE(M, ...) \
942 aarch64_verbose ("%s: " M ".", __func__, ##__VA_ARGS__); \
945 #define DEBUG_TRACE_IF(C, M, ...) \
947 if (debug_dump && (C)) \
948 aarch64_verbose ("%s: " M ".", __func__, ##__VA_ARGS__); \
950 #else /* !DEBUG_AARCH64 */
951 #define DEBUG_TRACE(M, ...) ;
952 #define DEBUG_TRACE_IF(C, M, ...) ;
953 #endif /* DEBUG_AARCH64 */
955 #endif /* OPCODE_AARCH64_H */