1 /* aarch64-opc.h -- Header file for aarch64-opc.c and aarch64-opc-2.c.
2 Copyright (C) 2012-2016 Free Software Foundation, Inc.
3 Contributed by ARM Ltd.
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
142 /* Field description. */
149 typedef struct aarch64_field aarch64_field
;
151 extern const aarch64_field fields
[];
153 /* Operand description. */
155 struct aarch64_operand
157 enum aarch64_operand_class op_class
;
159 /* Name of the operand code; used mainly for the purpose of internal
165 /* The associated instruction bit-fields; no operand has more than 4
167 enum aarch64_field_kind fields
[4];
169 /* Brief description */
173 typedef struct aarch64_operand aarch64_operand
;
175 extern const aarch64_operand aarch64_operands
[];
179 #define OPD_F_HAS_INSERTER 0x00000001
180 #define OPD_F_HAS_EXTRACTOR 0x00000002
181 #define OPD_F_SEXT 0x00000004 /* Require sign-extension. */
182 #define OPD_F_SHIFT_BY_2 0x00000008 /* Need to left shift the field
183 value by 2 to get the value
184 of an immediate operand. */
185 #define OPD_F_MAYBE_SP 0x00000010 /* May potentially be SP. */
186 #define OPD_F_OD_MASK 0x00000060 /* Operand-dependent data. */
187 #define OPD_F_OD_LSB 5
188 #define OPD_F_NO_ZR 0x00000080 /* ZR index not allowed. */
190 static inline bfd_boolean
191 operand_has_inserter (const aarch64_operand
*operand
)
193 return (operand
->flags
& OPD_F_HAS_INSERTER
) ? TRUE
: FALSE
;
196 static inline bfd_boolean
197 operand_has_extractor (const aarch64_operand
*operand
)
199 return (operand
->flags
& OPD_F_HAS_EXTRACTOR
) ? TRUE
: FALSE
;
202 static inline bfd_boolean
203 operand_need_sign_extension (const aarch64_operand
*operand
)
205 return (operand
->flags
& OPD_F_SEXT
) ? TRUE
: FALSE
;
208 static inline bfd_boolean
209 operand_need_shift_by_two (const aarch64_operand
*operand
)
211 return (operand
->flags
& OPD_F_SHIFT_BY_2
) ? TRUE
: FALSE
;
214 static inline bfd_boolean
215 operand_maybe_stack_pointer (const aarch64_operand
*operand
)
217 return (operand
->flags
& OPD_F_MAYBE_SP
) ? TRUE
: FALSE
;
220 /* Return the value of the operand-specific data field (OPD_F_OD_MASK). */
221 static inline unsigned int
222 get_operand_specific_data (const aarch64_operand
*operand
)
224 return (operand
->flags
& OPD_F_OD_MASK
) >> OPD_F_OD_LSB
;
227 /* Return the total width of the operand *OPERAND. */
228 static inline unsigned
229 get_operand_fields_width (const aarch64_operand
*operand
)
233 while (operand
->fields
[i
] != FLD_NIL
)
234 width
+= fields
[operand
->fields
[i
++]].width
;
235 assert (width
> 0 && width
< 32);
239 static inline const aarch64_operand
*
240 get_operand_from_code (enum aarch64_opnd code
)
242 return aarch64_operands
+ code
;
245 /* Operand qualifier and operand constraint checking. */
247 int aarch64_match_operands_constraint (aarch64_inst
*,
248 aarch64_operand_error
*);
250 /* Operand qualifier related functions. */
251 const char* aarch64_get_qualifier_name (aarch64_opnd_qualifier_t
);
252 unsigned char aarch64_get_qualifier_nelem (aarch64_opnd_qualifier_t
);
253 aarch64_insn
aarch64_get_qualifier_standard_value (aarch64_opnd_qualifier_t
);
254 int aarch64_find_best_match (const aarch64_inst
*,
255 const aarch64_opnd_qualifier_seq_t
*,
256 int, aarch64_opnd_qualifier_t
*);
259 reset_operand_qualifier (aarch64_inst
*inst
, int idx
)
261 assert (idx
>=0 && idx
< aarch64_num_of_operands (inst
->opcode
));
262 inst
->operands
[idx
].qualifier
= AARCH64_OPND_QLF_NIL
;
265 /* Inline functions operating on instruction bit-field(s). */
267 /* Generate a mask that has WIDTH number of consecutive 1s. */
269 static inline aarch64_insn
272 return ((aarch64_insn
) 1 << width
) - 1;
275 /* LSB_REL is the relative location of the lsb in the sub field, starting from 0. */
277 gen_sub_field (enum aarch64_field_kind kind
, int lsb_rel
, int width
, aarch64_field
*ret
)
279 const aarch64_field
*field
= &fields
[kind
];
280 if (lsb_rel
< 0 || width
<= 0 || lsb_rel
+ width
> field
->width
)
282 ret
->lsb
= field
->lsb
+ lsb_rel
;
287 /* Insert VALUE into FIELD of CODE. MASK can be zero or the base mask
291 insert_field_2 (const aarch64_field
*field
, aarch64_insn
*code
,
292 aarch64_insn value
, aarch64_insn mask
)
294 assert (field
->width
< 32 && field
->width
>= 1 && field
->lsb
>= 0
295 && field
->lsb
+ field
->width
<= 32);
296 value
&= gen_mask (field
->width
);
297 value
<<= field
->lsb
;
298 /* In some opcodes, field can be part of the base opcode, e.g. the size
299 field in FADD. The following helps avoid corrupt the base opcode. */
304 /* Extract FIELD of CODE and return the value. MASK can be zero or the base
305 mask of the opcode. */
307 static inline aarch64_insn
308 extract_field_2 (const aarch64_field
*field
, aarch64_insn code
,
312 /* Clear any bit that is a part of the base opcode. */
314 value
= (code
>> field
->lsb
) & gen_mask (field
->width
);
318 /* Insert VALUE into field KIND of CODE. MASK can be zero or the base mask
322 insert_field (enum aarch64_field_kind kind
, aarch64_insn
*code
,
323 aarch64_insn value
, aarch64_insn mask
)
325 insert_field_2 (&fields
[kind
], code
, value
, mask
);
328 /* Extract field KIND of CODE and return the value. MASK can be zero or the
329 base mask of the opcode. */
331 static inline aarch64_insn
332 extract_field (enum aarch64_field_kind kind
, aarch64_insn code
,
335 return extract_field_2 (&fields
[kind
], code
, mask
);
339 extract_fields (aarch64_insn code
, aarch64_insn mask
, ...);
341 /* Inline functions selecting operand to do the encoding/decoding for a
342 certain instruction bit-field. */
344 /* Select the operand to do the encoding/decoding of the 'sf' field.
345 The heuristic-based rule is that the result operand is respected more. */
348 select_operand_for_sf_field_coding (const aarch64_opcode
*opcode
)
351 if (aarch64_get_operand_class (opcode
->operands
[0])
352 == AARCH64_OPND_CLASS_INT_REG
)
355 else if (aarch64_get_operand_class (opcode
->operands
[1])
356 == AARCH64_OPND_CLASS_INT_REG
)
357 /* e.g. float2fix. */
360 { assert (0); abort (); }
364 /* Select the operand to do the encoding/decoding of the 'type' field in
365 the floating-point instructions.
366 The heuristic-based rule is that the source operand is respected more. */
369 select_operand_for_fptype_field_coding (const aarch64_opcode
*opcode
)
372 if (aarch64_get_operand_class (opcode
->operands
[1])
373 == AARCH64_OPND_CLASS_FP_REG
)
376 else if (aarch64_get_operand_class (opcode
->operands
[0])
377 == AARCH64_OPND_CLASS_FP_REG
)
378 /* e.g. float2fix. */
381 { assert (0); abort (); }
385 /* Select the operand to do the encoding/decoding of the 'size' field in
386 the AdvSIMD scalar instructions.
387 The heuristic-based rule is that the destination operand is respected
391 select_operand_for_scalar_size_field_coding (const aarch64_opcode
*opcode
)
393 int src_size
= 0, dst_size
= 0;
394 if (aarch64_get_operand_class (opcode
->operands
[0])
395 == AARCH64_OPND_CLASS_SISD_REG
)
396 dst_size
= aarch64_get_qualifier_esize (opcode
->qualifiers_list
[0][0]);
397 if (aarch64_get_operand_class (opcode
->operands
[1])
398 == AARCH64_OPND_CLASS_SISD_REG
)
399 src_size
= aarch64_get_qualifier_esize (opcode
->qualifiers_list
[0][1]);
400 if (src_size
== dst_size
&& src_size
== 0)
401 { assert (0); abort (); }
402 /* When the result is not a sisd register or it is a long operantion. */
403 if (dst_size
== 0 || dst_size
== src_size
<< 1)
409 /* Select the operand to do the encoding/decoding of the 'size:Q' fields in
410 the AdvSIMD instructions. */
412 int aarch64_select_operand_for_sizeq_field_coding (const aarch64_opcode
*);
416 aarch64_insn
aarch64_get_operand_modifier_value (enum aarch64_modifier_kind
);
417 enum aarch64_modifier_kind
418 aarch64_get_operand_modifier_from_value (aarch64_insn
, bfd_boolean
);
421 bfd_boolean
aarch64_wide_constant_p (int64_t, int, unsigned int *);
422 bfd_boolean
aarch64_logical_immediate_p (uint64_t, int, aarch64_insn
*);
423 int aarch64_shrink_expanded_imm8 (uint64_t);
425 /* Copy the content of INST->OPERANDS[SRC] to INST->OPERANDS[DST]. */
427 copy_operand_info (aarch64_inst
*inst
, int dst
, int src
)
429 assert (dst
>= 0 && src
>= 0 && dst
< AARCH64_MAX_OPND_NUM
430 && src
< AARCH64_MAX_OPND_NUM
);
431 memcpy (&inst
->operands
[dst
], &inst
->operands
[src
],
432 sizeof (aarch64_opnd_info
));
433 inst
->operands
[dst
].idx
= dst
;
436 /* A primitive log caculator. */
438 static inline unsigned int
439 get_logsz (unsigned int size
)
441 const unsigned char ls
[16] =
442 {0, 1, -1, 2, -1, -1, -1, 3, -1, -1, -1, -1, -1, -1, -1, 4};
448 assert (ls
[size
- 1] != (unsigned char)-1);
452 #endif /* OPCODES_AARCH64_OPC_H */