1 /* aarch64-opc.h -- Header file for aarch64-opc.c and aarch64-opc-2.c.
2 Copyright (C) 2012-2019 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/>. */
21 #ifndef OPCODES_AARCH64_OPC_H
22 #define OPCODES_AARCH64_OPC_H
25 #include "opcode/aarch64.h"
27 /* Instruction fields.
28 Keep synced with fields. */
29 enum aarch64_field_kind
157 /* Field description. */
164 typedef struct aarch64_field aarch64_field
;
166 extern const aarch64_field fields
[];
168 /* Operand description. */
170 struct aarch64_operand
172 enum aarch64_operand_class op_class
;
174 /* Name of the operand code; used mainly for the purpose of internal
180 /* The associated instruction bit-fields; no operand has more than 4
182 enum aarch64_field_kind fields
[4];
184 /* Brief description */
188 typedef struct aarch64_operand aarch64_operand
;
190 extern const aarch64_operand aarch64_operands
[];
193 verify_constraints (const struct aarch64_inst
*, const aarch64_insn
, bfd_vma
,
194 bfd_boolean
, aarch64_operand_error
*, aarch64_instr_sequence
*);
198 #define OPD_F_HAS_INSERTER 0x00000001
199 #define OPD_F_HAS_EXTRACTOR 0x00000002
200 #define OPD_F_SEXT 0x00000004 /* Require sign-extension. */
201 #define OPD_F_SHIFT_BY_2 0x00000008 /* Need to left shift the field
202 value by 2 to get the value
203 of an immediate operand. */
204 #define OPD_F_MAYBE_SP 0x00000010 /* May potentially be SP. */
205 #define OPD_F_OD_MASK 0x000000e0 /* Operand-dependent data. */
206 #define OPD_F_OD_LSB 5
207 #define OPD_F_NO_ZR 0x00000100 /* ZR index not allowed. */
208 #define OPD_F_SHIFT_BY_4 0x00000200 /* Need to left shift the field
209 value by 4 to get the value
210 of an immediate operand. */
213 /* Register flags. */
216 #define F_DEPRECATED (1 << 0) /* Deprecated system register. */
219 #define F_ARCHEXT (1 << 1) /* Architecture dependent system register. */
222 #define F_HASXT (1 << 2) /* System instruction register <Xt>
226 #define F_REG_READ (1 << 3) /* Register can only be used to read values
230 #define F_REG_WRITE (1 << 4) /* Register can only be written to but not
233 /* HINT operand flags. */
234 #define HINT_OPD_F_NOPRINT (1 << 0) /* Should not be printed. */
236 /* Encode 7-bit HINT #imm in the lower 8 bits. Use higher bits for flags. */
237 #define HINT_ENCODE(flag, val) ((flag << 8) | val)
238 #define HINT_FLAG(val) (val >> 8)
239 #define HINT_VAL(val) (val & 0xff)
241 static inline bfd_boolean
242 operand_has_inserter (const aarch64_operand
*operand
)
244 return (operand
->flags
& OPD_F_HAS_INSERTER
) ? TRUE
: FALSE
;
247 static inline bfd_boolean
248 operand_has_extractor (const aarch64_operand
*operand
)
250 return (operand
->flags
& OPD_F_HAS_EXTRACTOR
) ? TRUE
: FALSE
;
253 static inline bfd_boolean
254 operand_need_sign_extension (const aarch64_operand
*operand
)
256 return (operand
->flags
& OPD_F_SEXT
) ? TRUE
: FALSE
;
259 static inline bfd_boolean
260 operand_need_shift_by_two (const aarch64_operand
*operand
)
262 return (operand
->flags
& OPD_F_SHIFT_BY_2
) ? TRUE
: FALSE
;
265 static inline bfd_boolean
266 operand_need_shift_by_four (const aarch64_operand
*operand
)
268 return (operand
->flags
& OPD_F_SHIFT_BY_4
) ? TRUE
: FALSE
;
271 static inline bfd_boolean
272 operand_maybe_stack_pointer (const aarch64_operand
*operand
)
274 return (operand
->flags
& OPD_F_MAYBE_SP
) ? TRUE
: FALSE
;
277 /* Return the value of the operand-specific data field (OPD_F_OD_MASK). */
278 static inline unsigned int
279 get_operand_specific_data (const aarch64_operand
*operand
)
281 return (operand
->flags
& OPD_F_OD_MASK
) >> OPD_F_OD_LSB
;
284 /* Return the width of field number N of operand *OPERAND. */
285 static inline unsigned
286 get_operand_field_width (const aarch64_operand
*operand
, unsigned n
)
288 assert (operand
->fields
[n
] != FLD_NIL
);
289 return fields
[operand
->fields
[n
]].width
;
292 /* Return the total width of the operand *OPERAND. */
293 static inline unsigned
294 get_operand_fields_width (const aarch64_operand
*operand
)
298 while (operand
->fields
[i
] != FLD_NIL
)
299 width
+= fields
[operand
->fields
[i
++]].width
;
300 assert (width
> 0 && width
< 32);
304 static inline const aarch64_operand
*
305 get_operand_from_code (enum aarch64_opnd code
)
307 return aarch64_operands
+ code
;
310 /* Operand qualifier and operand constraint checking. */
312 int aarch64_match_operands_constraint (aarch64_inst
*,
313 aarch64_operand_error
*);
315 /* Operand qualifier related functions. */
316 const char* aarch64_get_qualifier_name (aarch64_opnd_qualifier_t
);
317 unsigned char aarch64_get_qualifier_nelem (aarch64_opnd_qualifier_t
);
318 aarch64_insn
aarch64_get_qualifier_standard_value (aarch64_opnd_qualifier_t
);
319 int aarch64_find_best_match (const aarch64_inst
*,
320 const aarch64_opnd_qualifier_seq_t
*,
321 int, aarch64_opnd_qualifier_t
*);
324 reset_operand_qualifier (aarch64_inst
*inst
, int idx
)
326 assert (idx
>=0 && idx
< aarch64_num_of_operands (inst
->opcode
));
327 inst
->operands
[idx
].qualifier
= AARCH64_OPND_QLF_NIL
;
330 /* Inline functions operating on instruction bit-field(s). */
332 /* Generate a mask that has WIDTH number of consecutive 1s. */
334 static inline aarch64_insn
337 return ((aarch64_insn
) 1 << width
) - 1;
340 /* LSB_REL is the relative location of the lsb in the sub field, starting from 0. */
342 gen_sub_field (enum aarch64_field_kind kind
, int lsb_rel
, int width
, aarch64_field
*ret
)
344 const aarch64_field
*field
= &fields
[kind
];
345 if (lsb_rel
< 0 || width
<= 0 || lsb_rel
+ width
> field
->width
)
347 ret
->lsb
= field
->lsb
+ lsb_rel
;
352 /* Insert VALUE into FIELD of CODE. MASK can be zero or the base mask
356 insert_field_2 (const aarch64_field
*field
, aarch64_insn
*code
,
357 aarch64_insn value
, aarch64_insn mask
)
359 assert (field
->width
< 32 && field
->width
>= 1 && field
->lsb
>= 0
360 && field
->lsb
+ field
->width
<= 32);
361 value
&= gen_mask (field
->width
);
362 value
<<= field
->lsb
;
363 /* In some opcodes, field can be part of the base opcode, e.g. the size
364 field in FADD. The following helps avoid corrupt the base opcode. */
369 /* Extract FIELD of CODE and return the value. MASK can be zero or the base
370 mask of the opcode. */
372 static inline aarch64_insn
373 extract_field_2 (const aarch64_field
*field
, aarch64_insn code
,
377 /* Clear any bit that is a part of the base opcode. */
379 value
= (code
>> field
->lsb
) & gen_mask (field
->width
);
383 /* Insert VALUE into field KIND of CODE. MASK can be zero or the base mask
387 insert_field (enum aarch64_field_kind kind
, aarch64_insn
*code
,
388 aarch64_insn value
, aarch64_insn mask
)
390 insert_field_2 (&fields
[kind
], code
, value
, mask
);
393 /* Extract field KIND of CODE and return the value. MASK can be zero or the
394 base mask of the opcode. */
396 static inline aarch64_insn
397 extract_field (enum aarch64_field_kind kind
, aarch64_insn code
,
400 return extract_field_2 (&fields
[kind
], code
, mask
);
404 extract_fields (aarch64_insn code
, aarch64_insn mask
, ...);
406 /* Inline functions selecting operand to do the encoding/decoding for a
407 certain instruction bit-field. */
409 /* Select the operand to do the encoding/decoding of the 'sf' field.
410 The heuristic-based rule is that the result operand is respected more. */
413 select_operand_for_sf_field_coding (const aarch64_opcode
*opcode
)
416 if (aarch64_get_operand_class (opcode
->operands
[0])
417 == AARCH64_OPND_CLASS_INT_REG
)
420 else if (aarch64_get_operand_class (opcode
->operands
[1])
421 == AARCH64_OPND_CLASS_INT_REG
)
422 /* e.g. float2fix. */
425 { assert (0); abort (); }
429 /* Select the operand to do the encoding/decoding of the 'type' field in
430 the floating-point instructions.
431 The heuristic-based rule is that the source operand is respected more. */
434 select_operand_for_fptype_field_coding (const aarch64_opcode
*opcode
)
437 if (aarch64_get_operand_class (opcode
->operands
[1])
438 == AARCH64_OPND_CLASS_FP_REG
)
441 else if (aarch64_get_operand_class (opcode
->operands
[0])
442 == AARCH64_OPND_CLASS_FP_REG
)
443 /* e.g. float2fix. */
446 { assert (0); abort (); }
450 /* Select the operand to do the encoding/decoding of the 'size' field in
451 the AdvSIMD scalar instructions.
452 The heuristic-based rule is that the destination operand is respected
456 select_operand_for_scalar_size_field_coding (const aarch64_opcode
*opcode
)
458 int src_size
= 0, dst_size
= 0;
459 if (aarch64_get_operand_class (opcode
->operands
[0])
460 == AARCH64_OPND_CLASS_SISD_REG
)
461 dst_size
= aarch64_get_qualifier_esize (opcode
->qualifiers_list
[0][0]);
462 if (aarch64_get_operand_class (opcode
->operands
[1])
463 == AARCH64_OPND_CLASS_SISD_REG
)
464 src_size
= aarch64_get_qualifier_esize (opcode
->qualifiers_list
[0][1]);
465 if (src_size
== dst_size
&& src_size
== 0)
466 { assert (0); abort (); }
467 /* When the result is not a sisd register or it is a long operantion. */
468 if (dst_size
== 0 || dst_size
== src_size
<< 1)
474 /* Select the operand to do the encoding/decoding of the 'size:Q' fields in
475 the AdvSIMD instructions. */
477 int aarch64_select_operand_for_sizeq_field_coding (const aarch64_opcode
*);
481 aarch64_insn
aarch64_get_operand_modifier_value (enum aarch64_modifier_kind
);
482 enum aarch64_modifier_kind
483 aarch64_get_operand_modifier_from_value (aarch64_insn
, bfd_boolean
);
486 bfd_boolean
aarch64_wide_constant_p (int64_t, int, unsigned int *);
487 bfd_boolean
aarch64_logical_immediate_p (uint64_t, int, aarch64_insn
*);
488 int aarch64_shrink_expanded_imm8 (uint64_t);
490 /* Copy the content of INST->OPERANDS[SRC] to INST->OPERANDS[DST]. */
492 copy_operand_info (aarch64_inst
*inst
, int dst
, int src
)
494 assert (dst
>= 0 && src
>= 0 && dst
< AARCH64_MAX_OPND_NUM
495 && src
< AARCH64_MAX_OPND_NUM
);
496 memcpy (&inst
->operands
[dst
], &inst
->operands
[src
],
497 sizeof (aarch64_opnd_info
));
498 inst
->operands
[dst
].idx
= dst
;
501 /* A primitive log caculator. */
503 static inline unsigned int
504 get_logsz (unsigned int size
)
506 const unsigned char ls
[16] =
507 {0, 1, -1, 2, -1, -1, -1, 3, -1, -1, -1, -1, -1, -1, -1, 4};
513 assert (ls
[size
- 1] != (unsigned char)-1);
517 #endif /* OPCODES_AARCH64_OPC_H */