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
134 /* Field description. */
141 typedef struct aarch64_field aarch64_field
;
143 extern const aarch64_field fields
[];
145 /* Operand description. */
147 struct aarch64_operand
149 enum aarch64_operand_class op_class
;
151 /* Name of the operand code; used mainly for the purpose of internal
157 /* The associated instruction bit-fields; no operand has more than 4
159 enum aarch64_field_kind fields
[4];
161 /* Brief description */
165 typedef struct aarch64_operand aarch64_operand
;
167 extern const aarch64_operand aarch64_operands
[];
171 #define OPD_F_HAS_INSERTER 0x00000001
172 #define OPD_F_HAS_EXTRACTOR 0x00000002
173 #define OPD_F_SEXT 0x00000004 /* Require sign-extension. */
174 #define OPD_F_SHIFT_BY_2 0x00000008 /* Need to left shift the field
175 value by 2 to get the value
176 of an immediate operand. */
177 #define OPD_F_MAYBE_SP 0x00000010 /* May potentially be SP. */
178 #define OPD_F_OD_MASK 0x00000060 /* Operand-dependent data. */
179 #define OPD_F_OD_LSB 5
180 #define OPD_F_NO_ZR 0x00000080 /* ZR index not allowed. */
182 static inline bfd_boolean
183 operand_has_inserter (const aarch64_operand
*operand
)
185 return (operand
->flags
& OPD_F_HAS_INSERTER
) ? TRUE
: FALSE
;
188 static inline bfd_boolean
189 operand_has_extractor (const aarch64_operand
*operand
)
191 return (operand
->flags
& OPD_F_HAS_EXTRACTOR
) ? TRUE
: FALSE
;
194 static inline bfd_boolean
195 operand_need_sign_extension (const aarch64_operand
*operand
)
197 return (operand
->flags
& OPD_F_SEXT
) ? TRUE
: FALSE
;
200 static inline bfd_boolean
201 operand_need_shift_by_two (const aarch64_operand
*operand
)
203 return (operand
->flags
& OPD_F_SHIFT_BY_2
) ? TRUE
: FALSE
;
206 static inline bfd_boolean
207 operand_maybe_stack_pointer (const aarch64_operand
*operand
)
209 return (operand
->flags
& OPD_F_MAYBE_SP
) ? TRUE
: FALSE
;
212 /* Return the value of the operand-specific data field (OPD_F_OD_MASK). */
213 static inline unsigned int
214 get_operand_specific_data (const aarch64_operand
*operand
)
216 return (operand
->flags
& OPD_F_OD_MASK
) >> OPD_F_OD_LSB
;
219 /* Return the total width of the operand *OPERAND. */
220 static inline unsigned
221 get_operand_fields_width (const aarch64_operand
*operand
)
225 while (operand
->fields
[i
] != FLD_NIL
)
226 width
+= fields
[operand
->fields
[i
++]].width
;
227 assert (width
> 0 && width
< 32);
231 static inline const aarch64_operand
*
232 get_operand_from_code (enum aarch64_opnd code
)
234 return aarch64_operands
+ code
;
237 /* Operand qualifier and operand constraint checking. */
239 int aarch64_match_operands_constraint (aarch64_inst
*,
240 aarch64_operand_error
*);
242 /* Operand qualifier related functions. */
243 const char* aarch64_get_qualifier_name (aarch64_opnd_qualifier_t
);
244 unsigned char aarch64_get_qualifier_nelem (aarch64_opnd_qualifier_t
);
245 aarch64_insn
aarch64_get_qualifier_standard_value (aarch64_opnd_qualifier_t
);
246 int aarch64_find_best_match (const aarch64_inst
*,
247 const aarch64_opnd_qualifier_seq_t
*,
248 int, aarch64_opnd_qualifier_t
*);
251 reset_operand_qualifier (aarch64_inst
*inst
, int idx
)
253 assert (idx
>=0 && idx
< aarch64_num_of_operands (inst
->opcode
));
254 inst
->operands
[idx
].qualifier
= AARCH64_OPND_QLF_NIL
;
257 /* Inline functions operating on instruction bit-field(s). */
259 /* Generate a mask that has WIDTH number of consecutive 1s. */
261 static inline aarch64_insn
264 return ((aarch64_insn
) 1 << width
) - 1;
267 /* LSB_REL is the relative location of the lsb in the sub field, starting from 0. */
269 gen_sub_field (enum aarch64_field_kind kind
, int lsb_rel
, int width
, aarch64_field
*ret
)
271 const aarch64_field
*field
= &fields
[kind
];
272 if (lsb_rel
< 0 || width
<= 0 || lsb_rel
+ width
> field
->width
)
274 ret
->lsb
= field
->lsb
+ lsb_rel
;
279 /* Insert VALUE into FIELD of CODE. MASK can be zero or the base mask
283 insert_field_2 (const aarch64_field
*field
, aarch64_insn
*code
,
284 aarch64_insn value
, aarch64_insn mask
)
286 assert (field
->width
< 32 && field
->width
>= 1 && field
->lsb
>= 0
287 && field
->lsb
+ field
->width
<= 32);
288 value
&= gen_mask (field
->width
);
289 value
<<= field
->lsb
;
290 /* In some opcodes, field can be part of the base opcode, e.g. the size
291 field in FADD. The following helps avoid corrupt the base opcode. */
296 /* Extract FIELD of CODE and return the value. MASK can be zero or the base
297 mask of the opcode. */
299 static inline aarch64_insn
300 extract_field_2 (const aarch64_field
*field
, aarch64_insn code
,
304 /* Clear any bit that is a part of the base opcode. */
306 value
= (code
>> field
->lsb
) & gen_mask (field
->width
);
310 /* Insert VALUE into field KIND of CODE. MASK can be zero or the base mask
314 insert_field (enum aarch64_field_kind kind
, aarch64_insn
*code
,
315 aarch64_insn value
, aarch64_insn mask
)
317 insert_field_2 (&fields
[kind
], code
, value
, mask
);
320 /* Extract field KIND of CODE and return the value. MASK can be zero or the
321 base mask of the opcode. */
323 static inline aarch64_insn
324 extract_field (enum aarch64_field_kind kind
, aarch64_insn code
,
327 return extract_field_2 (&fields
[kind
], code
, mask
);
330 /* Inline functions selecting operand to do the encoding/decoding for a
331 certain instruction bit-field. */
333 /* Select the operand to do the encoding/decoding of the 'sf' field.
334 The heuristic-based rule is that the result operand is respected more. */
337 select_operand_for_sf_field_coding (const aarch64_opcode
*opcode
)
340 if (aarch64_get_operand_class (opcode
->operands
[0])
341 == AARCH64_OPND_CLASS_INT_REG
)
344 else if (aarch64_get_operand_class (opcode
->operands
[1])
345 == AARCH64_OPND_CLASS_INT_REG
)
346 /* e.g. float2fix. */
349 { assert (0); abort (); }
353 /* Select the operand to do the encoding/decoding of the 'type' field in
354 the floating-point instructions.
355 The heuristic-based rule is that the source operand is respected more. */
358 select_operand_for_fptype_field_coding (const aarch64_opcode
*opcode
)
361 if (aarch64_get_operand_class (opcode
->operands
[1])
362 == AARCH64_OPND_CLASS_FP_REG
)
365 else if (aarch64_get_operand_class (opcode
->operands
[0])
366 == AARCH64_OPND_CLASS_FP_REG
)
367 /* e.g. float2fix. */
370 { assert (0); abort (); }
374 /* Select the operand to do the encoding/decoding of the 'size' field in
375 the AdvSIMD scalar instructions.
376 The heuristic-based rule is that the destination operand is respected
380 select_operand_for_scalar_size_field_coding (const aarch64_opcode
*opcode
)
382 int src_size
= 0, dst_size
= 0;
383 if (aarch64_get_operand_class (opcode
->operands
[0])
384 == AARCH64_OPND_CLASS_SISD_REG
)
385 dst_size
= aarch64_get_qualifier_esize (opcode
->qualifiers_list
[0][0]);
386 if (aarch64_get_operand_class (opcode
->operands
[1])
387 == AARCH64_OPND_CLASS_SISD_REG
)
388 src_size
= aarch64_get_qualifier_esize (opcode
->qualifiers_list
[0][1]);
389 if (src_size
== dst_size
&& src_size
== 0)
390 { assert (0); abort (); }
391 /* When the result is not a sisd register or it is a long operantion. */
392 if (dst_size
== 0 || dst_size
== src_size
<< 1)
398 /* Select the operand to do the encoding/decoding of the 'size:Q' fields in
399 the AdvSIMD instructions. */
401 int aarch64_select_operand_for_sizeq_field_coding (const aarch64_opcode
*);
405 aarch64_insn
aarch64_get_operand_modifier_value (enum aarch64_modifier_kind
);
406 enum aarch64_modifier_kind
407 aarch64_get_operand_modifier_from_value (aarch64_insn
, bfd_boolean
);
410 bfd_boolean
aarch64_wide_constant_p (int64_t, int, unsigned int *);
411 bfd_boolean
aarch64_logical_immediate_p (uint64_t, int, aarch64_insn
*);
412 int aarch64_shrink_expanded_imm8 (uint64_t);
414 /* Copy the content of INST->OPERANDS[SRC] to INST->OPERANDS[DST]. */
416 copy_operand_info (aarch64_inst
*inst
, int dst
, int src
)
418 assert (dst
>= 0 && src
>= 0 && dst
< AARCH64_MAX_OPND_NUM
419 && src
< AARCH64_MAX_OPND_NUM
);
420 memcpy (&inst
->operands
[dst
], &inst
->operands
[src
],
421 sizeof (aarch64_opnd_info
));
422 inst
->operands
[dst
].idx
= dst
;
425 /* A primitive log caculator. */
427 static inline unsigned int
428 get_logsz (unsigned int size
)
430 const unsigned char ls
[16] =
431 {0, 1, -1, 2, -1, -1, -1, 3, -1, -1, -1, -1, -1, -1, -1, 4};
437 assert (ls
[size
- 1] != (unsigned char)-1);
441 #endif /* OPCODES_AARCH64_OPC_H */