@c Copyright (C) 2009-2024 Free Software Foundation, Inc. @c Contributed by ARM Ltd. @c This is part of the GAS manual. @c For copying conditions, see the file as.texinfo. @c man end @ifset GENERIC @page @node AArch64-Dependent @chapter AArch64 Dependent Features @end ifset @ifclear GENERIC @node Machine Dependencies @chapter AArch64 Dependent Features @end ifclear @cindex AArch64 support @menu * AArch64 Options:: Options * AArch64 Extensions:: Extensions * AArch64 Syntax:: Syntax * AArch64 Floating Point:: Floating Point * AArch64 Directives:: AArch64 Machine Directives * AArch64 Opcodes:: Opcodes * AArch64 Mapping Symbols:: Mapping Symbols @end menu @node AArch64 Options @section Options @cindex AArch64 options (none) @cindex options for AArch64 (none) @c man begin OPTIONS @table @gcctabopt @cindex @option{-EB} command-line option, AArch64 @item -EB This option specifies that the output generated by the assembler should be marked as being encoded for a big-endian processor. @cindex @option{-EL} command-line option, AArch64 @item -EL This option specifies that the output generated by the assembler should be marked as being encoded for a little-endian processor. @cindex @option{-mabi=} command-line option, AArch64 @item -mabi=@var{abi} Specify which ABI the source code uses. The recognized arguments are: @code{ilp32} and @code{lp64}, which decides the generated object file in ELF32 and ELF64 format respectively. The default is @code{lp64}. @cindex @option{-mcpu=} command-line option, AArch64 @item -mcpu=@var{processor}[+@var{extension}@dots{}] This option specifies the target processor. The assembler will issue an error message if an attempt is made to assemble an instruction which will not execute on the target processor. The following processor names are recognized: @code{cortex-a34}, @code{cortex-a35}, @code{cortex-a53}, @code{cortex-a55}, @code{cortex-a57}, @code{cortex-a65}, @code{cortex-a65ae}, @code{cortex-a72}, @code{cortex-a73}, @code{cortex-a75}, @code{cortex-a76}, @code{cortex-a76ae}, @code{cortex-a77}, @code{cortex-a78}, @code{cortex-a78ae}, @code{cortex-a78c}, @code{cortex-a510}, @code{cortex-a520}, @code{cortex-a710}, @code{cortex-a720}, @code{ares}, @code{exynos-m1}, @code{falkor}, @code{neoverse-n1}, @code{neoverse-n2}, @code{neoverse-e1}, @code{neoverse-v1}, @code{qdf24xx}, @code{saphira}, @code{thunderx}, @code{vulcan}, @code{xgene1} @code{xgene2}, @code{cortex-r82}, @code{cortex-x1}, @code{cortex-x2}, @code{cortex-x3}, and @code{cortex-x4}. The special name @code{all} may be used to allow the assembler to accept instructions valid for any supported processor, including all optional extensions. In addition to the basic instruction set, the assembler can be told to accept, or restrict, various extension mnemonics that extend the processor. @xref{AArch64 Extensions}. If some implementations of a particular processor can have an extension, then then those extensions are automatically enabled. Consequently, you will not normally have to specify any additional extensions. @cindex @option{-march=} command-line option, AArch64 @item -march=@var{architecture}[+@var{extension}@dots{}] This option specifies the target architecture. The assembler will issue an error message if an attempt is made to assemble an instruction which will not execute on the target architecture. The following architecture names are recognized: @code{armv8-a}, @code{armv8.1-a}, @code{armv8.2-a}, @code{armv8.3-a}, @code{armv8.4-a} @code{armv8.5-a}, @code{armv8.6-a}, @code{armv8.7-a}, @code{armv8.8-a}, @code{armv8.9-a}, @code{armv8-r}, @code{armv9-a}, @code{armv9.1-a}, @code{armv9.2-a}, @code{armv9.3-a}, @code{armv9.4-a} and @code{armv9.5-a}. If both @option{-mcpu} and @option{-march} are specified, the assembler will use the setting for @option{-mcpu}. If neither are specified, the assembler will default to @option{-mcpu=all}. The architecture option can be extended with the same instruction set extension options as the @option{-mcpu} option. Unlike @option{-mcpu}, extensions are not always enabled by default. @xref{AArch64 Extensions}. @cindex @code{-mverbose-error} command-line option, AArch64 @item -mverbose-error This option enables verbose error messages for AArch64 gas. This option is enabled by default. @cindex @code{-mno-verbose-error} command-line option, AArch64 @item -mno-verbose-error This option disables verbose error messages in AArch64 gas. @end table @c man end @node AArch64 Extensions @section Architecture Extensions The tables below lists the permitted architecture extensions and architecture versions that are supported by the assembler, including a brief description and a list of other extensions that they depend upon. Multiple extensions may be specified, separated by a @code{+}. Extension mnemonics may also be removed from those the assembler accepts. This is done by prepending @code{no} to the option that adds the extension. Extensions that are removed must be listed after all extensions that have been added. Enabling an extension that depends upon other extensions (either directly or recursively) will automatically cause those extensions to be enabled. Similarly, disabling an extension that is required by other extensions will automatically cause those extensions to be disabled. @multitable @columnfractions .16 .22 .62 @headitem Extension @tab Depends upon @tab Description @item @code{aes} @tab @code{simd} @tab Enable the AES and PMULL cryptographic extensions. @c @item @code{b16b16} @tab @code{sve2} @c @tab Enable BFloat16 to BFloat16 arithmetic for SVE2 and SME2. @item @code{bf16} @tab @code{fp} @tab Enable BFloat16 extension. @item @code{brbe} @tab @tab Enable the Branch Record Buffer extension. @item @code{chk} @tab @tab Enable the Check Feature Status Extension. @item @code{compnum} @tab @code{simd} @tab Enable the complex number SIMD extensions. An alias of @code{fcma}. @item @code{cpa} @tab @tab Enable the Checked Pointer Arithmetic extension. @item @code{crc} @tab @tab Enable CRC instructions. @item @code{crypto} @tab @code{simd} @tab Enable cryptographic extensions. This is equivalent to @code{aes+sha2}. @item @code{cssc} @tab @tab Enable the Armv8.9-A Common Short Sequence Compression instructions. @item @code{d128} @tab @code{lse128} @tab Enable the 128-bit Page Descriptor Extension. This implies @code{lse128}. @item @code{dotprod} @tab @code{simd} @tab Enable the Dot Product extension. @item @code{f32mm} @tab @code{sve} @tab Enable the F32 Matrix Multiply extension @item @code{f64mm} @tab @code{sve} @tab Enable the F64 Matrix Multiply extension. @item @code{fcma} @tab @code{fp16}, @code{simd} @tab Enable the complex number SIMD extensions. @item @code{flagm} @tab @tab Enable Flag Manipulation instructions. @item @code{flagm2} @tab @code{flagm} @tab Enable FlagM2 flag conversion instructions. @item @code{fp} @tab @tab Enable floating-point extensions. @item @code{fp8} @tab @tab Enable the Floating Point 8 (FP8) extension. @item @code{fp8dot2} @tab @code{fp8dot4} @tab Enable the FP8 2-way dot product instructions. @item @code{fp8dot4} @tab @code{fp8fma} @tab Enable the FP8 4-way dot product instructions. @item @code{fp8fma} @tab @code{fp8} @tab Enable the FP8 FMA instructions. @item @code{fp16fml} @tab @code{fp16} @tab Enable Armv8.2 16-bit floating-point multiplication variant support. @item @code{fp16} @tab @code{fp} @tab Enable Armv8.2 16-bit floating-point support. @item @code{frintts} @tab @code{simd} @tab Enable floating-point round to integral value instructions. @item @code{gcs} @tab @tab Enable the Guarded Control Stack Extension. @item @code{hbc} @tab @tab Enable Armv8.8-A hinted conditional branch instructions @item @code{i8mm} @tab @code{simd} @tab Enable the Int8 Matrix Multiply extension. @item @code{ite} @tab @tab Enable the TRCIT instruction. @item @code{jscvt} @tab @code{fp} @tab Enable the @code{fjcvtzs} JavaScript conversion instruction. @item @code{lor} @tab @tab Enable Limited Ordering Regions extensions. @item @code{ls64} @tab @tab Enable the 64 Byte Loads/Stores extensions. @item @code{lse} @tab @tab Enable Large System extensions. @item @code{lse128} @tab @code{lse} @tab Enable the 128-bit Atomic Instructions extension. @item @code{lut} @tab @tab Enable the Lookup Table (LUT) extension. @item @code{memtag} @tab @tab Enable Armv8.5-A Memory Tagging Extensions. @item @code{mops} @tab @tab Enable Armv8.8-A memcpy and memset acceleration instructions @item @code{pan} @tab @tab Enable Privileged Access Never support. @item @code{pauth} @tab @tab Enable Pointer Authentication. @item @code{predres} @tab @tab Enable the Execution and Data and Prediction instructions. @item @code{predres2} @tab @code{predres} @tab Enable Prediction instructions. @item @code{profile} @tab @tab Enable statistical profiling extensions. @item @code{ras} @tab @tab Enable the Reliability, Availability and Serviceability extension. @item @code{rasv2} @tab @code{ras} @tab Enable the Reliability, Availability and Serviceability extension v2. @item @code{rcpc} @tab @tab Enable the Load-Acquire RCpc instructions extension. @item @code{rcpc2} @tab @code{rcpc} @tab Enable the Load-Acquire RCpc instructions extension v2. @item @code{rcpc3} @tab @code{rcpc2} @tab Enable the Load-Acquire RCpc instructions extension v3. @item @code{rdma} @tab @code{simd} @tab Enable rounding doubling multiply accumulate instructions. @item @code{rdm} @tab @code{simd} @tab An alias of @code{rdma}. @item @code{rng} @tab @tab Enable Armv8.5-A random number instructions. @item @code{sb} @tab @tab Enable the speculation barrier instruction sb. @item @code{sha2} @tab @code{simd} @tab Enable the SHA1 and SHA256 cryptographic extensions. @item @code{sha3} @tab @code{sha2} @tab Enable the SHA512 and SHA3 cryptographic extensions. @item @code{simd} @tab @code{fp} @tab Enable Advanced SIMD extensions. @item @code{sm4} @tab @code{simd} @tab Enable the SM3 and SM4 cryptographic extensions. @item @code{sme} @tab @code{sve2}, @code{bf16} @tab Enable the Scalable Matrix Extension. @item @code{sme-f8f16} @tab @code{sme-f8f32} @tab Enable the SME F8F16 Extension. @item @code{sme-f8f32} @tab @code{sme2}, @code{fp8} @tab Enable the SME F8F32 Extension. @item @code{sme-f64f64} @tab @code{sme} @tab Enable SME F64F64 Extension. @item @code{sme-i16i64} @tab @code{sme} @tab Enable SME I16I64 Extension. @item @code{sme-lutv2} @tab @tab Enable SME Lookup Table v2 (LUTv2) extension. @item @code{sme2} @tab @code{sme} @tab Enable SME2. @item @code{sme2p1} @tab @code{sme2} @tab Enable SME2.1. @item @code{ssbs} @tab @tab Enable Speculative Store Bypassing Safe state read and write. @item @code{ssve-fp8dot2} @tab @code{ssve-fp8dot4} @tab Enable the Streaming SVE FP8 2-way dot product instructions. These can also be enabled using @code{+fp8dot2+sme2}. @item @code{ssve-fp8dot4} @tab @code{ssve-fp8fma} @tab Enable the Streaming SVE FP8 4-way dot product instructions. These can also be enabled using @code{+fp8dot4+sme2}. @item @code{ssve-fp8fma} @tab @code{sme2}, @code{fp8} @tab Enable the Streaming SVE FP8 FMA instructions. These can also be enabled using @code{+fp8fma+sme2}. @item @code{sve} @tab @code{fcma} @tab Enable the Scalable Vector Extension. @item @code{sve2} @tab @code{sve} @tab Enable SVE2. @item @code{sve2-aes} @tab @code{sve2}, @code{aes} @tab Enable the SVE2 AES and PMULL Extensions. @item @code{sve2-bitperm} @tab @code{sve2} @tab Enable the SVE2 BITPERM Extension. @item @code{sve2-sha3} @tab @code{sve2}, @code{sha3} @tab Enable the SVE2 SHA3 Extension. @item @code{sve2-sm4} @tab @code{sve2}, @code{sm4} @tab Enable the SVE2 SM4 Extension. @item @code{sve2p1} @tab @code{sve2} @tab Enable SVE2.1. @item @code{the} @tab @tab Enable the Translation Hardening Extension. @item @code{tme} @tab @tab Enable the Transactional Memory Extension. @item @code{wfxt} @tab @tab Enable @code{wfet} and @code{wfit} instructions. @item @code{xs} @tab @tab Enable the XS memory attribute extension. @end multitable @multitable @columnfractions .20 .80 @headitem Architecture Version @tab Includes @item @code{armv8-a} @tab @code{simd}, @code{chk}, @code{ras} @item @code{armv8.1-a} @tab @code{armv8-a}, @code{crc}, @code{lse}, @code{rdma}, @code{pan}, @code{lor} @item @code{armv8.2-a} @tab @code{armv8.1-a} @item @code{armv8.3-a} @tab @code{armv8.2-a}, @code{fcma}, @code{jscvt}, @code{pauth}, @code{rcpc} @item @code{armv8.4-a} @tab @code{armv8.3-a}, @code{fp16fml}, @code{dotprod}, @code{flagm}, @code{rcpc2} @item @code{armv8.5-a} @tab @code{armv8.4-a}, @code{frintts}, @code{flagm2}, @code{predres}, @code{sb}, @code{ssbs} @item @code{armv8.6-a} @tab @code{armv8.5-a}, @code{bf16}, @code{i8mm} @item @code{armv8.7-a} @tab @code{armv8.6-a}, @code{ls64}, @code{xs}, @code{wfxt} @item @code{armv8.8-a} @tab @code{armv8.7-a}, @code{hbc}, @code{mops} @item @code{armv8.9-a} @tab @code{armv8.8-a}, @code{rasv2}, @code{predres2} @item @code{armv9-a} @tab @code{armv8.5-a}, @code{sve2} @item @code{armv9.1-a} @tab @code{armv9-a}, @code{armv8.6-a} @item @code{armv9.2-a} @tab @code{armv9.1-a}, @code{armv8.7-a} @item @code{armv9.3-a} @tab @code{armv9.2-a}, @code{armv8.8-a} @item @code{armv9.4-a} @tab @code{armv9.3-a}, @code{armv8.9-a} @item @code{armv9.5-a} @tab @code{armv9.4-a}, @code{cpa}, @code{lut}, @code{faminmax} @item @code{armv8-r} @tab @code{armv8.4-a+nolor} @end multitable @node AArch64 Syntax @section Syntax @menu * AArch64-Chars:: Special Characters * AArch64-Regs:: Register Names * AArch64-Relocations:: Relocations @end menu @node AArch64-Chars @subsection Special Characters @cindex line comment character, AArch64 @cindex AArch64 line comment character The presence of a @samp{//} on a line indicates the start of a comment that extends to the end of the current line. If a @samp{#} appears as the first character of a line, the whole line is treated as a comment. @cindex line separator, AArch64 @cindex statement separator, AArch64 @cindex AArch64 line separator The @samp{;} character can be used instead of a newline to separate statements. @cindex immediate character, AArch64 @cindex AArch64 immediate character The @samp{#} can be optionally used to indicate immediate operands. @node AArch64-Regs @subsection Register Names @cindex AArch64 register names @cindex register names, AArch64 Please refer to the section @samp{4.4 Register Names} of @samp{ARMv8 Instruction Set Overview}, which is available at @uref{http://infocenter.arm.com}. @node AArch64-Relocations @subsection Relocations @cindex relocations, AArch64 @cindex AArch64 relocations @cindex MOVN, MOVZ and MOVK group relocations, AArch64 Relocations for @samp{MOVZ} and @samp{MOVK} instructions can be generated by prefixing the label with @samp{#:abs_g2:} etc. For example to load the 48-bit absolute address of @var{foo} into x0: @smallexample movz x0, #:abs_g2:foo // bits 32-47, overflow check movk x0, #:abs_g1_nc:foo // bits 16-31, no overflow check movk x0, #:abs_g0_nc:foo // bits 0-15, no overflow check @end smallexample @cindex ADRP, ADD, LDR/STR group relocations, AArch64 Relocations for @samp{ADRP}, and @samp{ADD}, @samp{LDR} or @samp{STR} instructions can be generated by prefixing the label with @samp{:pg_hi21:} and @samp{#:lo12:} respectively. For example to use 33-bit (+/-4GB) pc-relative addressing to load the address of @var{foo} into x0: @smallexample adrp x0, :pg_hi21:foo add x0, x0, #:lo12:foo @end smallexample Or to load the value of @var{foo} into x0: @smallexample adrp x0, :pg_hi21:foo ldr x0, [x0, #:lo12:foo] @end smallexample Note that @samp{:pg_hi21:} is optional. @smallexample adrp x0, foo @end smallexample is equivalent to @smallexample adrp x0, :pg_hi21:foo @end smallexample @node AArch64 Floating Point @section Floating Point @cindex floating point, AArch64 (@sc{ieee}) @cindex AArch64 floating point (@sc{ieee}) The AArch64 architecture uses @sc{ieee} floating-point numbers. @node AArch64 Directives @section AArch64 Machine Directives @cindex machine directives, AArch64 @cindex AArch64 machine directives @table @code @c AAAAAAAAAAAAAAAAAAAAAAAAA @cindex @code{.arch} directive, AArch64 @item .arch @var{name} Select the target architecture. Valid values for @var{name} are the same as for the @option{-march} command-line option. Specifying @code{.arch} clears any previously selected architecture extensions. @cindex @code{.arch_extension} directive, AArch64 @item .arch_extension @var{name} Add or remove an architecture extension to the target architecture. Valid values for @var{name} are the same as those accepted as architectural extensions by the @option{-mcpu} command-line option. @code{.arch_extension} may be used multiple times to add or remove extensions incrementally to the architecture being compiled for. @c BBBBBBBBBBBBBBBBBBBBBBBBBB @c CCCCCCCCCCCCCCCCCCCCCCCCCC @cindex @code{.cpu} directive, AArch64 @item .cpu @var{name} Set the target processor. Valid values for @var{name} are the same as those accepted by the @option{-mcpu=} command-line option. @c DDDDDDDDDDDDDDDDDDDDDDDDDD @cindex @code{.dword} directive, AArch64 @item .dword @var{expressions} The @code{.dword} directive produces 64 bit values. @c EEEEEEEEEEEEEEEEEEEEEEEEEE @cindex @code{.even} directive, AArch64 @item .even The @code{.even} directive aligns the output on the next even byte boundary. @c FFFFFFFFFFFFFFFFFFFFFFFFFF @cindex @code{.float16} directive, AArch64 @item .float16 @var{value [,...,value_n]} Place the half precision floating point representation of one or more floating-point values into the current section. The format used to encode the floating point values is always the IEEE 754-2008 half precision floating point format. @c GGGGGGGGGGGGGGGGGGGGGGGGGG @c HHHHHHHHHHHHHHHHHHHHHHHHHH @c IIIIIIIIIIIIIIIIIIIIIIIIII @cindex @code{.inst} directive, AArch64 @item .inst @var{expressions} Inserts the expressions into the output as if they were instructions, rather than data. @c JJJJJJJJJJJJJJJJJJJJJJJJJJ @c KKKKKKKKKKKKKKKKKKKKKKKKKK @c LLLLLLLLLLLLLLLLLLLLLLLLLL @cindex @code{.ltorg} directive, AArch64 @item .ltorg This directive causes the current contents of the literal pool to be dumped into the current section (which is assumed to be the .text section) at the current location (aligned to a word boundary). GAS maintains a separate literal pool for each section and each sub-section. The @code{.ltorg} directive will only affect the literal pool of the current section and sub-section. At the end of assembly all remaining, un-empty literal pools will automatically be dumped. Note - older versions of GAS would dump the current literal pool any time a section change occurred. This is no longer done, since it prevents accurate control of the placement of literal pools. @c MMMMMMMMMMMMMMMMMMMMMMMMMM @c NNNNNNNNNNNNNNNNNNNNNNNNNN @c OOOOOOOOOOOOOOOOOOOOOOOOOO @c PPPPPPPPPPPPPPPPPPPPPPPPPP @cindex @code{.pool} directive, AArch64 @item .pool This is a synonym for .ltorg. @c QQQQQQQQQQQQQQQQQQQQQQQQQQ @c RRRRRRRRRRRRRRRRRRRRRRRRRR @cindex @code{.req} directive, AArch64 @item @var{name} .req @var{register name} This creates an alias for @var{register name} called @var{name}. For example: @smallexample foo .req w0 @end smallexample ip0, ip1, lr and fp are automatically defined to alias to X16, X17, X30 and X29 respectively. @c SSSSSSSSSSSSSSSSSSSSSSSSSS @c TTTTTTTTTTTTTTTTTTTTTTTTTT @cindex @code{.tlsdescadd} directive, AArch64 @item @code{.tlsdescadd} Emits a TLSDESC_ADD reloc on the next instruction. @cindex @code{.tlsdesccall} directive, AArch64 @item @code{.tlsdesccall} Emits a TLSDESC_CALL reloc on the next instruction. @cindex @code{.tlsdescldr} directive, AArch64 @item @code{.tlsdescldr} Emits a TLSDESC_LDR reloc on the next instruction. @c UUUUUUUUUUUUUUUUUUUUUUUUUU @cindex @code{.unreq} directive, AArch64 @item .unreq @var{alias-name} This undefines a register alias which was previously defined using the @code{req} directive. For example: @smallexample foo .req w0 .unreq foo @end smallexample An error occurs if the name is undefined. Note - this pseudo op can be used to delete builtin in register name aliases (eg 'w0'). This should only be done if it is really necessary. @c VVVVVVVVVVVVVVVVVVVVVVVVVV @cindex @code{.variant_pcs} directive, AArch64 @item .variant_pcs @var{symbol} This directive marks @var{symbol} referencing a function that may follow a variant procedure call standard with different register usage convention from the base procedure call standard. @c WWWWWWWWWWWWWWWWWWWWWWWWWW @c XXXXXXXXXXXXXXXXXXXXXXXXXX @cindex @code{.xword} directive, AArch64 @item .xword @var{expressions} The @code{.xword} directive produces 64 bit values. This is the same as the @code{.dword} directive. @c YYYYYYYYYYYYYYYYYYYYYYYYYY @c ZZZZZZZZZZZZZZZZZZZZZZZZZZ @cindex @code{.cfi_b_key_frame} directive, AArch64 @item @code{.cfi_b_key_frame} The @code{.cfi_b_key_frame} directive inserts a 'B' character into the CIE corresponding to the current frame's FDE, meaning that its return address has been signed with the B-key. If two frames are signed with differing keys then they will not share the same CIE. This information is intended to be used by the stack unwinder in order to properly authenticate return addresses. @end table @node AArch64 Opcodes @section Opcodes @cindex AArch64 opcodes @cindex opcodes for AArch64 GAS implements all the standard AArch64 opcodes. It also implements several pseudo opcodes, including several synthetic load instructions. @table @code @cindex @code{LDR reg,=} pseudo op, AArch64 @item LDR = @smallexample ldr , = @end smallexample The constant expression will be placed into the nearest literal pool (if it not already there) and a PC-relative LDR instruction will be generated. @end table For more information on the AArch64 instruction set and assembly language notation, see @samp{ARMv8 Instruction Set Overview} available at @uref{http://infocenter.arm.com}. @node AArch64 Mapping Symbols @section Mapping Symbols The AArch64 ELF specification requires that special symbols be inserted into object files to mark certain features: @table @code @cindex @code{$x} @item $x At the start of a region of code containing AArch64 instructions. @cindex @code{$d} @item $d At the start of a region of data. @end table