Commit | Line | Data |
---|---|---|
219d1afa | 1 | @c Copyright (C) 2009-2018 Free Software Foundation, Inc. |
a06ea964 NC |
2 | @c Contributed by ARM Ltd. |
3 | @c This is part of the GAS manual. | |
4 | @c For copying conditions, see the file as.texinfo. | |
5 | @c man end | |
6 | ||
7 | @ifset GENERIC | |
8 | @page | |
9 | @node AArch64-Dependent | |
10 | @chapter AArch64 Dependent Features | |
11 | @end ifset | |
12 | ||
13 | @ifclear GENERIC | |
14 | @node Machine Dependencies | |
15 | @chapter AArch64 Dependent Features | |
16 | @end ifclear | |
17 | ||
18 | @cindex AArch64 support | |
a06ea964 NC |
19 | @menu |
20 | * AArch64 Options:: Options | |
df359aa7 | 21 | * AArch64 Extensions:: Extensions |
a06ea964 NC |
22 | * AArch64 Syntax:: Syntax |
23 | * AArch64 Floating Point:: Floating Point | |
24 | * AArch64 Directives:: AArch64 Machine Directives | |
25 | * AArch64 Opcodes:: Opcodes | |
26 | * AArch64 Mapping Symbols:: Mapping Symbols | |
27 | @end menu | |
28 | ||
29 | @node AArch64 Options | |
30 | @section Options | |
31 | @cindex AArch64 options (none) | |
32 | @cindex options for AArch64 (none) | |
33 | ||
34 | @c man begin OPTIONS | |
35 | @table @gcctabopt | |
36 | ||
a05a5b64 | 37 | @cindex @option{-EB} command-line option, AArch64 |
a06ea964 NC |
38 | @item -EB |
39 | This option specifies that the output generated by the assembler should | |
40 | be marked as being encoded for a big-endian processor. | |
41 | ||
a05a5b64 | 42 | @cindex @option{-EL} command-line option, AArch64 |
a06ea964 NC |
43 | @item -EL |
44 | This option specifies that the output generated by the assembler should | |
45 | be marked as being encoded for a little-endian processor. | |
46 | ||
a05a5b64 | 47 | @cindex @option{-mabi=} command-line option, AArch64 |
69091a2c YZ |
48 | @item -mabi=@var{abi} |
49 | Specify which ABI the source code uses. The recognized arguments | |
50 | are: @code{ilp32} and @code{lp64}, which decides the generated object | |
51 | file in ELF32 and ELF64 format respectively. The default is @code{lp64}. | |
52 | ||
a05a5b64 | 53 | @cindex @option{-mcpu=} command-line option, AArch64 |
df359aa7 RE |
54 | @item -mcpu=@var{processor}[+@var{extension}@dots{}] |
55 | This option specifies the target processor. The assembler will issue an error | |
56 | message if an attempt is made to assemble an instruction which will not execute | |
57 | on the target processor. The following processor names are recognized: | |
9c352f1c | 58 | @code{cortex-a35}, |
df359aa7 | 59 | @code{cortex-a53}, |
1e292627 | 60 | @code{cortex-a55}, |
df359aa7 | 61 | @code{cortex-a57}, |
2abdd192 | 62 | @code{cortex-a72}, |
1aa70332 | 63 | @code{cortex-a73}, |
1e292627 | 64 | @code{cortex-a75}, |
c2a0f929 | 65 | @code{cortex-a76}, |
2412d878 | 66 | @code{exynos-m1}, |
2fe9c2a0 | 67 | @code{falkor}, |
6b21c2bf | 68 | @code{qdf24xx}, |
7605d944 | 69 | @code{saphira}, |
55fbd992 | 70 | @code{thunderx}, |
0a8be2fe | 71 | @code{vulcan}, |
0a9ce86d | 72 | @code{xgene1} |
df359aa7 | 73 | and |
0a9ce86d | 74 | @code{xgene2}. |
df359aa7 RE |
75 | The special name @code{all} may be used to allow the assembler to accept |
76 | instructions valid for any supported processor, including all optional | |
77 | extensions. | |
78 | ||
79 | In addition to the basic instruction set, the assembler can be told to | |
80 | accept, or restrict, various extension mnemonics that extend the | |
81 | processor. @xref{AArch64 Extensions}. | |
82 | ||
83 | If some implementations of a particular processor can have an | |
84 | extension, then then those extensions are automatically enabled. | |
85 | Consequently, you will not normally have to specify any additional | |
86 | extensions. | |
87 | ||
a05a5b64 | 88 | @cindex @option{-march=} command-line option, AArch64 |
df359aa7 RE |
89 | @item -march=@var{architecture}[+@var{extension}@dots{}] |
90 | This option specifies the target architecture. The assembler will | |
91 | issue an error message if an attempt is made to assemble an | |
92 | instruction which will not execute on the target architecture. The | |
acb787b0 | 93 | following architecture names are recognized: @code{armv8-a}, |
68ffd936 | 94 | @code{armv8.1-a}, @code{armv8.2-a}, @code{armv8.3-a} and @code{armv8.4-a}. |
df359aa7 RE |
95 | |
96 | If both @option{-mcpu} and @option{-march} are specified, the | |
97 | assembler will use the setting for @option{-mcpu}. If neither are | |
98 | specified, the assembler will default to @option{-mcpu=all}. | |
99 | ||
100 | The architecture option can be extended with the same instruction set | |
101 | extension options as the @option{-mcpu} option. Unlike | |
102 | @option{-mcpu}, extensions are not always enabled by default, | |
103 | @xref{AArch64 Extensions}. | |
104 | ||
a05a5b64 | 105 | @cindex @code{-mverbose-error} command-line option, AArch64 |
a52e6fd3 YZ |
106 | @item -mverbose-error |
107 | This option enables verbose error messages for AArch64 gas. This option | |
108 | is enabled by default. | |
109 | ||
a05a5b64 | 110 | @cindex @code{-mno-verbose-error} command-line option, AArch64 |
a52e6fd3 YZ |
111 | @item -mno-verbose-error |
112 | This option disables verbose error messages in AArch64 gas. | |
113 | ||
a06ea964 NC |
114 | @end table |
115 | @c man end | |
116 | ||
df359aa7 RE |
117 | @node AArch64 Extensions |
118 | @section Architecture Extensions | |
119 | ||
120 | The table below lists the permitted architecture extensions that are | |
121 | supported by the assembler and the conditions under which they are | |
122 | automatically enabled. | |
123 | ||
124 | Multiple extensions may be specified, separated by a @code{+}. | |
125 | Extension mnemonics may also be removed from those the assembler | |
126 | accepts. This is done by prepending @code{no} to the option that adds | |
127 | the extension. Extensions that are removed must be listed after all | |
128 | extensions that have been added. | |
129 | ||
130 | Enabling an extension that requires other extensions will | |
131 | automatically cause those extensions to be enabled. Similarly, | |
132 | disabling an extension that is required by other extensions will | |
133 | automatically cause those extensions to be disabled. | |
134 | ||
135 | @multitable @columnfractions .12 .17 .17 .54 | |
136 | @headitem Extension @tab Minimum Architecture @tab Enabled by default | |
137 | @tab Description | |
f482d304 RS |
138 | @item @code{compnum} @tab ARMv8.2-A @tab ARMv8.3-A or later |
139 | @tab Enable the complex number SIMD extensions. This implies | |
140 | @code{fp16} and @code{simd}. | |
af117b3c | 141 | @item @code{crc} @tab ARMv8-A @tab ARMv8.1-A or later |
df359aa7 RE |
142 | @tab Enable CRC instructions. |
143 | @item @code{crypto} @tab ARMv8-A @tab No | |
68ffd936 TC |
144 | @tab Enable cryptographic extensions. This implies @code{fp}, @code{simd}, @code{aes} and @code{sha2}. |
145 | @item @code{aes} @tab ARMv8-A @tab No | |
146 | @tab Enable the AES cryptographic extensions. This implies @code{fp} and @code{simd}. | |
147 | @item @code{sha2} @tab ARMv8-A @tab No | |
148 | @tab Enable the SHA2 cryptographic extensions. This implies @code{fp} and @code{simd}. | |
149 | @item @code{sha3} @tab ARMv8.2-A @tab No | |
150 | @tab Enable the ARMv8.2-A SHA2 and SHA3 cryptographic extensions. This implies @code{fp}, @code{simd} and @code{sha2}. | |
151 | @item @code{sm4} @tab ARMv8.2-A @tab No | |
152 | @tab Enable the ARMv8.2-A SM3 and SM4 cryptographic extensions. This implies @code{fp} and @code{simd}. | |
df359aa7 RE |
153 | @item @code{fp} @tab ARMv8-A @tab ARMv8-A or later |
154 | @tab Enable floating-point extensions. | |
87018195 MW |
155 | @item @code{fp16} @tab ARMv8.2-A @tab ARMv8.2-A or later |
156 | @tab Enable ARMv8.2 16-bit floating-point support. This implies | |
157 | @code{fp}. | |
b607cde1 JG |
158 | @item @code{lor} @tab ARMv8-A @tab ARMv8.1-A or later |
159 | @tab Enable Limited Ordering Regions extensions. | |
160 | @item @code{lse} @tab ARMv8-A @tab ARMv8.1-A or later | |
161 | @tab Enable Large System extensions. | |
162 | @item @code{pan} @tab ARMv8-A @tab ARMv8.1-A or later | |
163 | @tab Enable Privileged Access Never support. | |
73af8ed6 MW |
164 | @item @code{profile} @tab ARMv8.2-A @tab No |
165 | @tab Enable statistical profiling extensions. | |
50cc854c MW |
166 | @item @code{ras} @tab ARMv8-A @tab ARMv8.2-A or later |
167 | @tab Enable the Reliability, Availability and Serviceability | |
168 | extension. | |
01cca2f9 SN |
169 | @item @code{rcpc} @tab ARMv8.2-A @tab ARMv8.3-A or later |
170 | @tab Enable the weak release consistency extension. | |
b607cde1 JG |
171 | @item @code{rdma} @tab ARMv8-A @tab ARMv8.1-A or later |
172 | @tab Enable ARMv8.1 Advanced SIMD extensions. This implies @code{simd}. | |
173 | @item @code{simd} @tab ARMv8-A @tab ARMv8-A or later | |
174 | @tab Enable Advanced SIMD extensions. This implies @code{fp}. | |
582e12bf RS |
175 | @item @code{sve} @tab ARMv8.2-A @tab No |
176 | @tab Enable the Scalable Vector Extensions. This implies @code{fp16}, | |
177 | @code{simd} and @code{compnum}. | |
68ffd936 | 178 | @item @code{dotprod} @tab ARMv8.2-A @tab ARMv8.4-A or later |
65a55fbb | 179 | @tab Enable the Dot Product extension. This implies @code{simd}. |
d0f7791c TC |
180 | @item @code{fp16fml} @tab ARMv8.2-A @tab ARMv8.4-A or later |
181 | @tab Enable ARMv8.2 16-bit floating-point multiplication variant support. | |
182 | This implies @code{fp16}. | |
df359aa7 RE |
183 | @end multitable |
184 | ||
a06ea964 NC |
185 | @node AArch64 Syntax |
186 | @section Syntax | |
187 | @menu | |
188 | * AArch64-Chars:: Special Characters | |
189 | * AArch64-Regs:: Register Names | |
190 | * AArch64-Relocations:: Relocations | |
191 | @end menu | |
192 | ||
193 | @node AArch64-Chars | |
194 | @subsection Special Characters | |
195 | ||
196 | @cindex line comment character, AArch64 | |
197 | @cindex AArch64 line comment character | |
198 | The presence of a @samp{//} on a line indicates the start of a comment | |
199 | that extends to the end of the current line. If a @samp{#} appears as | |
200 | the first character of a line, the whole line is treated as a comment. | |
201 | ||
202 | @cindex line separator, AArch64 | |
203 | @cindex statement separator, AArch64 | |
204 | @cindex AArch64 line separator | |
205 | The @samp{;} character can be used instead of a newline to separate | |
206 | statements. | |
207 | ||
208 | @cindex immediate character, AArch64 | |
209 | @cindex AArch64 immediate character | |
210 | The @samp{#} can be optionally used to indicate immediate operands. | |
211 | ||
212 | @node AArch64-Regs | |
213 | @subsection Register Names | |
214 | ||
215 | @cindex AArch64 register names | |
216 | @cindex register names, AArch64 | |
217 | Please refer to the section @samp{4.4 Register Names} of | |
218 | @samp{ARMv8 Instruction Set Overview}, which is available at | |
219 | @uref{http://infocenter.arm.com}. | |
220 | ||
221 | @node AArch64-Relocations | |
222 | @subsection Relocations | |
223 | ||
224 | @cindex relocations, AArch64 | |
225 | @cindex AArch64 relocations | |
226 | @cindex MOVN, MOVZ and MOVK group relocations, AArch64 | |
227 | Relocations for @samp{MOVZ} and @samp{MOVK} instructions can be generated | |
228 | by prefixing the label with @samp{#:abs_g2:} etc. | |
229 | For example to load the 48-bit absolute address of @var{foo} into x0: | |
230 | ||
231 | @smallexample | |
232 | movz x0, #:abs_g2:foo // bits 32-47, overflow check | |
233 | movk x0, #:abs_g1_nc:foo // bits 16-31, no overflow check | |
234 | movk x0, #:abs_g0_nc:foo // bits 0-15, no overflow check | |
235 | @end smallexample | |
236 | ||
237 | @cindex ADRP, ADD, LDR/STR group relocations, AArch64 | |
238 | Relocations for @samp{ADRP}, and @samp{ADD}, @samp{LDR} or @samp{STR} | |
239 | instructions can be generated by prefixing the label with | |
34fd659b | 240 | @samp{:pg_hi21:} and @samp{#:lo12:} respectively. |
a06ea964 | 241 | |
34bca508 | 242 | For example to use 33-bit (+/-4GB) pc-relative addressing to |
a06ea964 NC |
243 | load the address of @var{foo} into x0: |
244 | ||
245 | @smallexample | |
34fd659b | 246 | adrp x0, :pg_hi21:foo |
a06ea964 NC |
247 | add x0, x0, #:lo12:foo |
248 | @end smallexample | |
249 | ||
250 | Or to load the value of @var{foo} into x0: | |
251 | ||
252 | @smallexample | |
34fd659b | 253 | adrp x0, :pg_hi21:foo |
a06ea964 NC |
254 | ldr x0, [x0, #:lo12:foo] |
255 | @end smallexample | |
256 | ||
34fd659b | 257 | Note that @samp{:pg_hi21:} is optional. |
a06ea964 NC |
258 | |
259 | @smallexample | |
260 | adrp x0, foo | |
261 | @end smallexample | |
262 | ||
263 | is equivalent to | |
264 | ||
265 | @smallexample | |
34fd659b | 266 | adrp x0, :pg_hi21:foo |
a06ea964 NC |
267 | @end smallexample |
268 | ||
269 | @node AArch64 Floating Point | |
270 | @section Floating Point | |
271 | ||
272 | @cindex floating point, AArch64 (@sc{ieee}) | |
273 | @cindex AArch64 floating point (@sc{ieee}) | |
274 | The AArch64 architecture uses @sc{ieee} floating-point numbers. | |
275 | ||
276 | @node AArch64 Directives | |
277 | @section AArch64 Machine Directives | |
278 | ||
279 | @cindex machine directives, AArch64 | |
280 | @cindex AArch64 machine directives | |
281 | @table @code | |
282 | ||
283 | @c AAAAAAAAAAAAAAAAAAAAAAAAA | |
8e02d7f5 JW |
284 | |
285 | @cindex @code{.arch} directive, AArch64 | |
286 | @item .arch @var{name} | |
287 | Select the target architecture. Valid values for @var{name} are the same as | |
a05a5b64 | 288 | for the @option{-march} command-line option. |
8e02d7f5 JW |
289 | |
290 | Specifying @code{.arch} clears any previously selected architecture | |
291 | extensions. | |
292 | ||
293 | @cindex @code{.arch_extension} directive, AArch64 | |
294 | @item .arch_extension @var{name} | |
295 | Add or remove an architecture extension to the target architecture. Valid | |
296 | values for @var{name} are the same as those accepted as architectural | |
a05a5b64 | 297 | extensions by the @option{-mcpu} command-line option. |
8e02d7f5 JW |
298 | |
299 | @code{.arch_extension} may be used multiple times to add or remove extensions | |
300 | incrementally to the architecture being compiled for. | |
301 | ||
a06ea964 NC |
302 | @c BBBBBBBBBBBBBBBBBBBBBBBBBB |
303 | ||
304 | @cindex @code{.bss} directive, AArch64 | |
305 | @item .bss | |
306 | This directive switches to the @code{.bss} section. | |
307 | ||
308 | @c CCCCCCCCCCCCCCCCCCCCCCCCCC | |
30fab421 NC |
309 | |
310 | @cindex @code{.cpu} directive, AArch64 | |
311 | @item .cpu @var{name} | |
312 | Set the target processor. Valid values for @var{name} are the same as | |
a05a5b64 | 313 | those accepted by the @option{-mcpu=} command-line option. |
30fab421 | 314 | |
a06ea964 | 315 | @c DDDDDDDDDDDDDDDDDDDDDDDDDD |
30fab421 NC |
316 | |
317 | @cindex @code{.dword} directive, AArch64 | |
318 | @item .dword @var{expressions} | |
319 | The @code{.dword} directive produces 64 bit values. | |
320 | ||
a06ea964 | 321 | @c EEEEEEEEEEEEEEEEEEEEEEEEEE |
30fab421 NC |
322 | |
323 | @cindex @code{.even} directive, AArch64 | |
324 | @item .even | |
325 | The @code{.even} directive aligns the output on the next even byte | |
326 | boundary. | |
327 | ||
a06ea964 NC |
328 | @c FFFFFFFFFFFFFFFFFFFFFFFFFF |
329 | @c GGGGGGGGGGGGGGGGGGGGGGGGGG | |
330 | @c HHHHHHHHHHHHHHHHHHHHHHHHHH | |
331 | @c IIIIIIIIIIIIIIIIIIIIIIIIII | |
30fab421 NC |
332 | |
333 | @cindex @code{.inst} directive, AArch64 | |
334 | @item .inst @var{expressions} | |
335 | Inserts the expressions into the output as if they were instructions, | |
336 | rather than data. | |
337 | ||
a06ea964 NC |
338 | @c JJJJJJJJJJJJJJJJJJJJJJJJJJ |
339 | @c KKKKKKKKKKKKKKKKKKKKKKKKKK | |
340 | @c LLLLLLLLLLLLLLLLLLLLLLLLLL | |
341 | ||
342 | @cindex @code{.ltorg} directive, AArch64 | |
343 | @item .ltorg | |
344 | This directive causes the current contents of the literal pool to be | |
345 | dumped into the current section (which is assumed to be the .text | |
346 | section) at the current location (aligned to a word boundary). | |
df359aa7 | 347 | GAS maintains a separate literal pool for each section and each |
a06ea964 NC |
348 | sub-section. The @code{.ltorg} directive will only affect the literal |
349 | pool of the current section and sub-section. At the end of assembly | |
350 | all remaining, un-empty literal pools will automatically be dumped. | |
351 | ||
df359aa7 | 352 | Note - older versions of GAS would dump the current literal |
a06ea964 NC |
353 | pool any time a section change occurred. This is no longer done, since |
354 | it prevents accurate control of the placement of literal pools. | |
355 | ||
356 | @c MMMMMMMMMMMMMMMMMMMMMMMMMM | |
357 | ||
358 | @c NNNNNNNNNNNNNNNNNNNNNNNNNN | |
359 | @c OOOOOOOOOOOOOOOOOOOOOOOOOO | |
360 | ||
361 | @c PPPPPPPPPPPPPPPPPPPPPPPPPP | |
362 | ||
363 | @cindex @code{.pool} directive, AArch64 | |
364 | @item .pool | |
365 | This is a synonym for .ltorg. | |
366 | ||
367 | @c QQQQQQQQQQQQQQQQQQQQQQQQQQ | |
368 | @c RRRRRRRRRRRRRRRRRRRRRRRRRR | |
369 | ||
370 | @cindex @code{.req} directive, AArch64 | |
371 | @item @var{name} .req @var{register name} | |
372 | This creates an alias for @var{register name} called @var{name}. For | |
373 | example: | |
374 | ||
375 | @smallexample | |
376 | foo .req w0 | |
377 | @end smallexample | |
378 | ||
8975f864 RR |
379 | ip0, ip1, lr and fp are automatically defined to |
380 | alias to X16, X17, X30 and X29 respectively. | |
381 | ||
a06ea964 NC |
382 | @c SSSSSSSSSSSSSSSSSSSSSSSSSS |
383 | ||
384 | @c TTTTTTTTTTTTTTTTTTTTTTTTTT | |
385 | ||
30fab421 NC |
386 | @cindex @code{.tlsdescadd} directive, AArch64 |
387 | @item @code{.tlsdescadd} | |
388 | Emits a TLSDESC_ADD reloc on the next instruction. | |
389 | ||
390 | @cindex @code{.tlsdesccall} directive, AArch64 | |
391 | @item @code{.tlsdesccall} | |
392 | Emits a TLSDESC_CALL reloc on the next instruction. | |
393 | ||
394 | @cindex @code{.tlsdescldr} directive, AArch64 | |
395 | @item @code{.tlsdescldr} | |
396 | Emits a TLSDESC_LDR reloc on the next instruction. | |
397 | ||
a06ea964 NC |
398 | @c UUUUUUUUUUUUUUUUUUUUUUUUUU |
399 | ||
400 | @cindex @code{.unreq} directive, AArch64 | |
401 | @item .unreq @var{alias-name} | |
402 | This undefines a register alias which was previously defined using the | |
403 | @code{req} directive. For example: | |
404 | ||
405 | @smallexample | |
406 | foo .req w0 | |
407 | .unreq foo | |
408 | @end smallexample | |
409 | ||
410 | An error occurs if the name is undefined. Note - this pseudo op can | |
411 | be used to delete builtin in register name aliases (eg 'w0'). This | |
412 | should only be done if it is really necessary. | |
413 | ||
414 | @c VVVVVVVVVVVVVVVVVVVVVVVVVV | |
415 | ||
416 | @c WWWWWWWWWWWWWWWWWWWWWWWWWW | |
417 | @c XXXXXXXXXXXXXXXXXXXXXXXXXX | |
a06ea964 | 418 | |
edc66de9 | 419 | @cindex @code{.xword} directive, AArch64 |
30fab421 NC |
420 | @item .xword @var{expressions} |
421 | The @code{.xword} directive produces 64 bit values. This is the same | |
422 | as the @code{.dword} directive. | |
423 | ||
424 | @c YYYYYYYYYYYYYYYYYYYYYYYYYY | |
425 | @c ZZZZZZZZZZZZZZZZZZZZZZZZZZ | |
edc66de9 | 426 | |
a06ea964 NC |
427 | @end table |
428 | ||
429 | @node AArch64 Opcodes | |
430 | @section Opcodes | |
431 | ||
432 | @cindex AArch64 opcodes | |
433 | @cindex opcodes for AArch64 | |
df359aa7 | 434 | GAS implements all the standard AArch64 opcodes. It also |
a06ea964 | 435 | implements several pseudo opcodes, including several synthetic load |
34bca508 | 436 | instructions. |
a06ea964 NC |
437 | |
438 | @table @code | |
439 | ||
440 | @cindex @code{LDR reg,=<expr>} pseudo op, AArch64 | |
441 | @item LDR = | |
442 | @smallexample | |
443 | ldr <register> , =<expression> | |
444 | @end smallexample | |
445 | ||
446 | The constant expression will be placed into the nearest literal pool (if it not | |
447 | already there) and a PC-relative LDR instruction will be generated. | |
448 | ||
449 | @end table | |
450 | ||
451 | For more information on the AArch64 instruction set and assembly language | |
452 | notation, see @samp{ARMv8 Instruction Set Overview} available at | |
453 | @uref{http://infocenter.arm.com}. | |
454 | ||
455 | ||
456 | @node AArch64 Mapping Symbols | |
457 | @section Mapping Symbols | |
458 | ||
459 | The AArch64 ELF specification requires that special symbols be inserted | |
460 | into object files to mark certain features: | |
461 | ||
462 | @table @code | |
463 | ||
464 | @cindex @code{$x} | |
465 | @item $x | |
466 | At the start of a region of code containing AArch64 instructions. | |
467 | ||
468 | @cindex @code{$d} | |
469 | @item $d | |
470 | At the start of a region of data. | |
471 | ||
472 | @end table |