1 /* tc-aarch64.h -- Header file for tc-aarch64.c.
2 Copyright (C) 2009-2022 Free Software Foundation, Inc.
3 Contributed by ARM Ltd.
5 This file is part of GAS.
7 GAS 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 of the license, or
10 (at your option) any later version.
12 GAS is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public 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/>. */
24 #include "opcode/aarch64.h"
26 #ifndef TARGET_BYTES_BIG_ENDIAN
27 #define TARGET_BYTES_BIG_ENDIAN 0
30 #define WORKING_DOT_WORD
32 #define TARGET_ARCH bfd_arch_aarch64
36 /* Permit // comments. */
37 #define DOUBLESLASH_LINE_COMMENTS
47 #define LITTLE_ENDIAN 1234
48 #define BIG_ENDIAN 4321
51 ((((n) & 0xff) << 24) | (((n) & 0xff00) << 8) | (((n) >> 8) & 0xff00) \
52 | (((n) >> 24) & 0xff))
58 struct aarch64_inst
*inst
;
59 enum aarch64_opnd opnd
;
63 # define AARCH64_BI_ENDIAN
64 # define TARGET_FORMAT elf64_aarch64_target_format ()
65 #elif defined (OBJ_COFF)
66 # define TARGET_FORMAT coff_aarch64_target_format ()
69 #define TC_FORCE_RELOCATION(FIX) aarch64_force_relocation (FIX)
71 /* Currently there is no machine specific frags generated. */
72 #define md_convert_frag(b,s,f) as_fatal ("aarch64 convert_frag called\n")
74 #define md_cleanup() aarch64_cleanup ()
76 #define md_start_line_hook() aarch64_start_line_hook ()
78 #define tc_frob_label(S) aarch64_frob_label (S)
80 /* We also need to mark assembler created symbols: */
81 #define tc_frob_fake_label(S) aarch64_frob_label (S)
83 #define tc_frob_section(S) aarch64_frob_section (S)
85 /* The key used to sign a function's return address. */
86 enum pointer_auth_key
{
91 /* The extra fields required by AArch64 in fde_entry and cie_entry. Currently
92 only used to store the key used to sign the frame's return address. */
93 #define tc_fde_entry_extras enum pointer_auth_key pauth_key;
94 #define tc_cie_entry_extras enum pointer_auth_key pauth_key;
96 /* The extra initialisation steps needed by AArch64 in alloc_fde_entry.
97 Currently only used to initialise the key used to sign the return
99 #define tc_fde_entry_init_extra(fde) fde->pauth_key = AARCH64_PAUTH_KEY_A;
101 /* Extra checks required by AArch64 when outputting the current cie_entry.
102 Currently only used to output a 'B' if the return address is signed with the
104 #define tc_output_cie_extra(cie) \
107 if (cie->pauth_key == AARCH64_PAUTH_KEY_B) \
112 /* Extra equivalence checks required by AArch64 when selecting the correct cie
113 for some fde. Currently only used to check for quivalence between keys used
114 to sign ther return address. */
115 #define tc_cie_fde_equivalent_extra(cie, fde) (cie->pauth_key == fde->pauth_key)
117 /* The extra initialisation steps needed by AArch64 in select_cie_for_fde.
118 Currently only used to initialise the key used to sign the return
120 #define tc_cie_entry_init_extra(cie, fde) cie->pauth_key = fde->pauth_key;
122 #define TC_FIX_TYPE struct aarch64_fix
123 #define TC_INIT_FIX_DATA(FIX) { (FIX)->tc_fix_data.inst = NULL; \
124 (FIX)->tc_fix_data.opnd = AARCH64_OPND_NIL; }
126 #define TC_SYMFIELD_TYPE unsigned int
127 #define AARCH64_GET_FLAG(s) (*symbol_get_tc (s))
129 void aarch64_copy_symbol_attributes (symbolS
*, symbolS
*);
130 #ifndef TC_COPY_SYMBOL_ATTRIBUTES
131 #define TC_COPY_SYMBOL_ATTRIBUTES(DEST, SRC) \
132 (aarch64_copy_symbol_attributes (DEST, SRC))
136 void aarch64_elf_copy_symbol_attributes (symbolS
*, symbolS
*);
137 #define OBJ_COPY_SYMBOL_ATTRIBUTES(DEST, SRC) \
138 aarch64_elf_copy_symbol_attributes (DEST, SRC)
141 #define TC_START_LABEL(STR, NUL_CHAR, NEXT_CHAR) \
142 (NEXT_CHAR == ':' || (NEXT_CHAR == '/' && aarch64_data_in_code ()))
143 #define tc_canonicalize_symbol_name(str) aarch64_canonicalize_symbol_name (str);
144 #define obj_adjust_symtab() aarch64_adjust_symtab ()
146 #define LISTING_HEADER "AARCH64 GAS "
148 #define LOCAL_LABEL(name) (name[0] == '.' && name[1] == 'L')
149 #define LOCAL_LABELS_FB 1
151 /* This expression evaluates to true if the relocation is for a local
152 object for which we still want to do the relocation at runtime.
153 False if we are willing to perform this relocation while building
154 the .o file. GOTOFF does not need to be checked here because it is
155 not pcrel. I am not sure if some of the others are ever used with
156 pcrel, but it is easier to be safe than sorry. */
158 #define TC_FORCE_RELOCATION_LOCAL(FIX) \
159 (GENERIC_FORCE_RELOCATION_LOCAL (FIX) \
160 || (FIX)->fx_r_type == BFD_RELOC_64 \
161 || (FIX)->fx_r_type == BFD_RELOC_32)
163 #define TC_CONS_FIX_NEW(f,w,s,e,r) cons_fix_new_aarch64 ((f), (w), (s), (e))
165 /* Max space for a rs_align_code fragment is 3 unaligned bytes
166 (fr_fix) plus 4 bytes to contain the repeating NOP (fr_var). */
167 #define MAX_MEM_FOR_RS_ALIGN_CODE 7
169 /* For frags in code sections we need to record whether they contain
171 struct aarch64_frag_type
174 #if defined OBJ_ELF || defined OBJ_COFF
175 /* If there is a mapping symbol at offset 0 in this frag,
176 it will be saved in FIRST_MAP. If there are any mapping
177 symbols in this frag, the last one will be saved in
179 symbolS
*first_map
, *last_map
;
183 #define TC_FRAG_TYPE struct aarch64_frag_type
184 #define TC_FRAG_INIT(fragp, max_bytes) aarch64_init_frag (fragp, max_bytes)
185 #define HANDLE_ALIGN(fragp) aarch64_handle_align (fragp)
187 #define md_do_align(N, FILL, LEN, MAX, LABEL) \
188 if (FILL == NULL && (N) != 0 && ! need_pass_2 && subseg_text_p (now_seg)) \
190 frag_align_code (N, MAX); \
194 #define SUB_SEGMENT_ALIGN(SEG, FRCHAIN) 0
196 #define DWARF2_LINE_MIN_INSN_LENGTH 4
198 /* The lr register is r30. */
199 #define DWARF2_DEFAULT_RETURN_COLUMN 30
201 /* Registers are generally saved at negative offsets to the CFA. */
202 #define DWARF2_CIE_DATA_ALIGNMENT (-8)
204 extern int aarch64_dwarf2_addr_size (void);
205 #define DWARF2_ADDR_SIZE(bfd) aarch64_dwarf2_addr_size ()
207 #if defined OBJ_ELF || defined OBJ_COFF
209 # define obj_frob_symbol(sym, punt) aarch64elf_frob_symbol ((sym), & (punt))
212 # define GLOBAL_OFFSET_TABLE_NAME "_GLOBAL_OFFSET_TABLE_"
213 # define TC_SEGMENT_INFO_TYPE struct aarch64_segment_info_type
215 /* This is not really an alignment operation, but it's something we
216 need to do at the same time: whenever we are figuring out the
217 alignment for data, we should check whether a $d symbol is
219 # define md_cons_align(nbytes) mapping_state (MAP_DATA)
223 MAP_UNDEFINED
= 0, /* Must be zero, for seginfo in new sections. */
228 void mapping_state (enum mstate
);
230 struct aarch64_segment_info_type
232 const char *last_file
;
234 enum mstate mapstate
;
235 unsigned int marked_pr_dependency
;
236 aarch64_instr_sequence insn_sequence
;
239 /* We want .cfi_* pseudo-ops for generating unwind info. */
240 #define TARGET_USE_CFIPOP 1
242 /* Whether SFrame unwind info is supported. */
243 extern bool aarch64_support_sframe_p (void);
244 #define support_sframe_p aarch64_support_sframe_p
246 /* The stack-pointer register number for SFrame unwind info. */
247 extern unsigned int aarch64_sframe_cfa_sp_reg
;
248 #define SFRAME_CFA_SP_REG aarch64_sframe_cfa_sp_reg
250 /* The base-pointer register number for CFA unwind info. */
251 extern unsigned int aarch64_sframe_cfa_fp_reg
;
252 #define SFRAME_CFA_FP_REG aarch64_sframe_cfa_fp_reg
254 /* The return address register number for CFA unwind info. */
255 extern unsigned int aarch64_sframe_cfa_ra_reg
;
256 #define SFRAME_CFA_RA_REG aarch64_sframe_cfa_ra_reg
258 /* Specify if RA tracking is needed. */
259 extern bool aarch64_sframe_ra_tracking_p (void);
260 #define sframe_ra_tracking_p aarch64_sframe_ra_tracking_p
262 /* Specify the fixed offset to recover RA from CFA.
263 (useful only when RA tracking is not needed). */
264 extern offsetT
aarch64_sframe_cfa_ra_offset (void);
265 #define sframe_cfa_ra_offset aarch64_sframe_cfa_ra_offset
267 /* The abi/arch indentifier for SFrame. */
268 unsigned char aarch64_sframe_get_abi_arch (void);
269 #define sframe_get_abi_arch aarch64_sframe_get_abi_arch
272 #define tc_regname_to_dw2regnum tc_aarch64_regname_to_dw2regnum
273 #define tc_cfi_frame_initial_instructions tc_aarch64_frame_initial_instructions
275 extern void aarch64_after_parse_args (void);
276 #define md_after_parse_args() aarch64_after_parse_args ()
278 #else /* Not OBJ_ELF. */
279 #define GLOBAL_OFFSET_TABLE_NAME "__GLOBAL_OFFSET_TABLE_"
282 #if defined OBJ_ELF || defined OBJ_COFF
284 # define EXTERN_FORCE_RELOC 1
285 # define tc_fix_adjustable(FIX) 1
286 /* Values passed to md_apply_fix don't include the symbol value. */
287 # define MD_APPLY_SYM_VALUE(FIX) 0
291 #define MD_PCREL_FROM_SECTION(F,S) md_pcrel_from_section(F,S)
293 extern void aarch64_frag_align_code (int, int);
294 extern const char * elf64_aarch64_target_format (void);
295 extern const char * coff_aarch64_target_format (void);
296 extern int aarch64_force_relocation (struct fix
*);
297 extern void aarch64_cleanup (void);
298 extern void aarch64_start_line_hook (void);
299 extern void aarch64_frob_label (symbolS
*);
300 extern void aarch64_frob_section (asection
*sec
);
301 extern int aarch64_data_in_code (void);
302 extern char * aarch64_canonicalize_symbol_name (char *);
303 extern void aarch64_adjust_symtab (void);
304 extern void aarch64elf_frob_symbol (symbolS
*, int *);
305 extern void cons_fix_new_aarch64 (fragS
*, int, int, expressionS
*);
306 extern void aarch64_init_frag (struct frag
*, int);
307 extern void aarch64_handle_align (struct frag
*);
308 extern int tc_aarch64_regname_to_dw2regnum (char *regname
);
309 extern void tc_aarch64_frame_initial_instructions (void);
311 #endif /* TC_AARCH64 */