[PATCH 26/57][Arm][GAS] Add support for MVE instructions: vpnot and vpsel
[binutils-gdb.git] / gas / doc / c-sparc.texi
blob1530ac6d7f9c216241da69d95e906b4d20b8acda
1 @c Copyright (C) 1991-2019 Free Software Foundation, Inc.
2 @c This is part of the GAS manual.
3 @c For copying conditions, see the file as.texinfo.
4 @ifset GENERIC
5 @page
6 @node Sparc-Dependent
7 @chapter SPARC Dependent Features
8 @end ifset
9 @ifclear GENERIC
10 @node Machine Dependencies
11 @chapter SPARC Dependent Features
12 @end ifclear
14 @cindex SPARC support
15 @menu
16 * Sparc-Opts::                  Options
17 * Sparc-Aligned-Data::          Option to enforce aligned data
18 * Sparc-Syntax::                Syntax
19 * Sparc-Float::                 Floating Point
20 * Sparc-Directives::            Sparc Machine Directives
21 @end menu
23 @node Sparc-Opts
24 @section Options
26 @cindex options for SPARC
27 @cindex SPARC options
28 @cindex architectures, SPARC
29 @cindex SPARC architectures
30 The SPARC chip family includes several successive versions, using the same
31 core instruction set, but including a few additional instructions at
32 each version.  There are exceptions to this however.  For details on what
33 instructions each variant supports, please see the chip's architecture
34 reference manual.
36 By default, @code{@value{AS}} assumes the core instruction set (SPARC
37 v6), but ``bumps'' the architecture level as needed: it switches to
38 successively higher architectures as it encounters instructions that
39 only exist in the higher levels.
41 If not configured for SPARC v9 (@code{sparc64-*-*}) GAS will not bump
42 past sparclite by default, an option must be passed to enable the
43 v9 instructions.
45 GAS treats sparclite as being compatible with v8, unless an architecture
46 is explicitly requested.  SPARC v9 is always incompatible with sparclite.
48 @c The order here is the same as the order of enum sparc_opcode_arch_val
49 @c to give the user a sense of the order of the "bumping".
51 @table @code
52 @kindex -Av6
53 @kindex -Av7
54 @kindex -Av8
55 @kindex -Aleon
56 @kindex -Asparclet
57 @kindex -Asparclite
58 @kindex -Av9
59 @kindex -Av9a
60 @kindex -Av9b
61 @kindex -Av9c
62 @kindex -Av9d
63 @kindex -Av9e
64 @kindex -Av9v
65 @kindex -Av9m
66 @kindex -Asparc
67 @kindex -Asparcvis
68 @kindex -Asparcvis2
69 @kindex -Asparcfmaf
70 @kindex -Asparcima
71 @kindex -Asparcvis3
72 @kindex -Asparcvis3r
73 @item -Av6 | -Av7 | -Av8 | -Aleon | -Asparclet | -Asparclite
74 @itemx -Av8plus | -Av8plusa | -Av8plusb | -Av8plusc | -Av8plusd |
75 @itemx -Av8plusv | -Av8plusm | -Av8plusm8
76 @itemx -Av9 | -Av9a | -Av9b | -Av9c | -Av9d | -Av9e | -Av9v | -Av9m | -Av9m8
77 @itemx -Asparc | -Asparcvis | -Asparcvis2 | -Asparcfmaf | -Asparcima
78 @itemx -Asparcvis3 | -Asparcvis3r | -Asparc5 | -Asparc6
79 Use one of the @samp{-A} options to select one of the SPARC
80 architectures explicitly.  If you select an architecture explicitly,
81 @code{@value{AS}} reports a fatal error if it encounters an instruction
82 or feature requiring an incompatible or higher level.
84 @samp{-Av8plus}, @samp{-Av8plusa}, @samp{-Av8plusb}, @samp{-Av8plusc},
85 @samp{-Av8plusd}, and @samp{-Av8plusv} select a 32 bit environment.
87 @samp{-Av9}, @samp{-Av9a}, @samp{-Av9b}, @samp{-Av9c}, @samp{-Av9d},
88 @samp{-Av9e}, @samp{-Av9v} and @samp{-Av9m} select a 64 bit
89 environment and are not available unless GAS is explicitly configured
90 with 64 bit environment support.
92 @samp{-Av8plusa} and @samp{-Av9a} enable the SPARC V9 instruction set with
93 UltraSPARC VIS 1.0 extensions.
95 @samp{-Av8plusb} and @samp{-Av9b} enable the UltraSPARC VIS 2.0 instructions,
96 as well as the instructions enabled by @samp{-Av8plusa} and @samp{-Av9a}.
98 @samp{-Av8plusc} and @samp{-Av9c} enable the UltraSPARC Niagara instructions,
99 as well as the instructions enabled by @samp{-Av8plusb} and @samp{-Av9b}.
101 @samp{-Av8plusd} and @samp{-Av9d} enable the floating point fused
102 multiply-add, VIS 3.0, and HPC extension instructions, as well as the
103 instructions enabled by @samp{-Av8plusc} and @samp{-Av9c}.
105 @samp{-Av8pluse} and @samp{-Av9e} enable the cryptographic
106 instructions, as well as the instructions enabled by @samp{-Av8plusd}
107 and @samp{-Av9d}.
109 @samp{-Av8plusv} and @samp{-Av9v} enable floating point unfused
110 multiply-add, and integer multiply-add, as well as the instructions
111 enabled by @samp{-Av8pluse} and @samp{-Av9e}.
113 @samp{-Av8plusm} and @samp{-Av9m} enable the VIS 4.0, subtract extended,
114 xmpmul, xmontmul and xmontsqr instructions, as well as the instructions
115 enabled by @samp{-Av8plusv} and @samp{-Av9v}.
117 @samp{-Av8plusm8} and @samp{-Av9m8} enable the instructions introduced
118 in the Oracle SPARC Architecture 2017 and the M8 processor, as
119 well as the instructions enabled by @samp{-Av8plusm} and @samp{-Av9m}.
121 @samp{-Asparc} specifies a v9 environment.  It is equivalent to
122 @samp{-Av9} if the word size is 64-bit, and @samp{-Av8plus} otherwise.
124 @samp{-Asparcvis} specifies a v9a environment.  It is equivalent to
125 @samp{-Av9a} if the word size is 64-bit, and @samp{-Av8plusa} otherwise.
127 @samp{-Asparcvis2} specifies a v9b environment.  It is equivalent to
128 @samp{-Av9b} if the word size is 64-bit, and @samp{-Av8plusb} otherwise.
130 @samp{-Asparcfmaf} specifies a v9b environment with the floating point
131 fused multiply-add instructions enabled.
133 @samp{-Asparcima} specifies a v9b environment with the integer
134 multiply-add instructions enabled.
136 @samp{-Asparcvis3} specifies a v9b environment with the VIS 3.0,
137 HPC , and floating point fused multiply-add instructions enabled.
139 @samp{-Asparcvis3r} specifies a v9b environment with the VIS 3.0, HPC,
140 and floating point unfused multiply-add instructions enabled.
142 @samp{-Asparc5} is equivalent to @samp{-Av9m}.
144 @samp{-Asparc6} is equivalent to @samp{-Av9m8}.
146 @item -xarch=v8plus | -xarch=v8plusa | -xarch=v8plusb | -xarch=v8plusc
147 @itemx -xarch=v8plusd | -xarch=v8plusv | -xarch=v8plusm |
148 @itemx -xarch=v8plusm8 | -xarch=v9 | -xarch=v9a | -xarch=v9b
149 @itemx -xarch=v9c | -xarch=v9d | -xarch=v9e | -xarch=v9v
150 @itemx -xarch=v9m | -xarch=v9m8
151 @itemx -xarch=sparc | -xarch=sparcvis | -xarch=sparcvis2
152 @itemx -xarch=sparcfmaf | -xarch=sparcima | -xarch=sparcvis3
153 @itemx -xarch=sparcvis3r | -xarch=sparc5 | -xarch=sparc6
154 For compatibility with the SunOS v9 assembler.  These options are
155 equivalent to -Av8plus, -Av8plusa, -Av8plusb, -Av8plusc, -Av8plusd,
156 -Av8plusv, -Av8plusm, -Av8plusm8, -Av9, -Av9a, -Av9b, -Av9c, -Av9d,
157 -Av9e, -Av9v, -Av9m, -Av9m8, -Asparc, -Asparcvis, -Asparcvis2,
158 -Asparcfmaf, -Asparcima, -Asparcvis3, -Asparcvis3r, -Asparc5 and
159 -Asparc6 respectively.
161 @item -bump
162 Warn whenever it is necessary to switch to another level.
163 If an architecture level is explicitly requested, GAS will not issue
164 warnings until that level is reached, and will then bump the level
165 as required (except between incompatible levels).
167 @item -32 | -64
168 Select the word size, either 32 bits or 64 bits.
169 These options are only available with the ELF object file format,
170 and require that the necessary BFD support has been included.
172 @item --dcti-couples-detect
173 Warn if a DCTI (delayed control transfer instruction) couple is found
174 when generating code for a variant of the SPARC architecture in which
175 the execution of the couple is unpredictable, or very slow.  This is
176 disabled by default.
177 @end table
179 @node Sparc-Aligned-Data
180 @section Enforcing aligned data
182 @cindex data alignment on SPARC
183 @cindex SPARC data alignment
184 SPARC GAS normally permits data to be misaligned.  For example, it
185 permits the @code{.long} pseudo-op to be used on a byte boundary.
186 However, the native SunOS assemblers issue an error when they see
187 misaligned data.
189 @kindex --enforce-aligned-data
190 You can use the @code{--enforce-aligned-data} option to make SPARC GAS
191 also issue an error about misaligned data, just as the SunOS
192 assemblers do.
194 The @code{--enforce-aligned-data} option is not the default because gcc
195 issues misaligned data pseudo-ops when it initializes certain packed
196 data structures (structures defined using the @code{packed} attribute).
197 You may have to assemble with GAS in order to initialize packed data
198 structures in your own code.
200 @cindex SPARC syntax
201 @cindex syntax, SPARC
202 @node Sparc-Syntax
203 @section Sparc Syntax
204 The assembler syntax closely follows The Sparc Architecture Manual,
205 versions 8 and 9, as well as most extensions defined by Sun
206 for their UltraSPARC and Niagara line of processors.
208 @menu
209 * Sparc-Chars::                Special Characters
210 * Sparc-Regs::                 Register Names
211 * Sparc-Constants::            Constant Names
212 * Sparc-Relocs::               Relocations
213 * Sparc-Size-Translations::    Size Translations
214 @end menu
216 @node Sparc-Chars
217 @subsection Special Characters
219 @cindex line comment character, Sparc
220 @cindex Sparc line comment character
221 A @samp{!} character appearing anywhere on a line indicates the start
222 of a comment that extends to the end of that line.
224 If a @samp{#} appears as the first character of a line then the whole
225 line is treated as a comment, but in this case the line could also be
226 a logical line number directive (@pxref{Comments}) or a preprocessor
227 control command (@pxref{Preprocessing}).
229 @cindex line separator, Sparc
230 @cindex statement separator, Sparc
231 @cindex Sparc line separator
232 @samp{;} can be used instead of a newline to separate statements.
234 @node Sparc-Regs
235 @subsection Register Names
236 @cindex Sparc registers
237 @cindex register names, Sparc
239 The Sparc integer register file is broken down into global,
240 outgoing, local, and incoming.
242 @itemize @bullet
243 @item
244 The 8 global registers are referred to as @samp{%g@var{n}}.
246 @item
247 The 8 outgoing registers are referred to as @samp{%o@var{n}}.
249 @item
250 The 8 local registers are referred to as @samp{%l@var{n}}.
252 @item
253 The 8 incoming registers are referred to as @samp{%i@var{n}}.
255 @item
256 The frame pointer register @samp{%i6} can be referenced using
257 the alias @samp{%fp}.
259 @item
260 The stack pointer register @samp{%o6} can be referenced using
261 the alias @samp{%sp}.
262 @end itemize
264 Floating point registers are simply referred to as @samp{%f@var{n}}.
265 When assembling for pre-V9, only 32 floating point registers
266 are available.  For V9 and later there are 64, but there are
267 restrictions when referencing the upper 32 registers.  They
268 can only be accessed as double or quad, and thus only even
269 or quad numbered accesses are allowed.  For example, @samp{%f34}
270 is a legal floating point register, but @samp{%f35} is not.
272 Floating point registers accessed as double can also be referred using
273 the @samp{%d@var{n}} notation, where @var{n} is even.  Similarly,
274 floating point registers accessed as quad can be referred using the
275 @samp{%q@var{n}} notation, where @var{n} is a multiple of 4.  For
276 example, @samp{%f4} can be denoted as both @samp{%d4} and @samp{%q4}.
277 On the other hand, @samp{%f2} can be denoted as @samp{%d2} but not as
278 @samp{%q2}.
280 Certain V9 instructions allow access to ancillary state registers.
281 Most simply they can be referred to as @samp{%asr@var{n}} where
282 @var{n} can be from 16 to 31.  However, there are some aliases
283 defined to reference ASR registers defined for various UltraSPARC
284 processors:
286 @itemize @bullet
287 @item
288 The tick compare register is referred to as @samp{%tick_cmpr}.
290 @item
291 The system tick register is referred to as @samp{%stick}.  An alias,
292 @samp{%sys_tick}, exists but is deprecated and should not be used
293 by new software.
295 @item
296 The system tick compare register is referred to as @samp{%stick_cmpr}.
297 An alias, @samp{%sys_tick_cmpr}, exists but is deprecated and should
298 not be used by new software.
300 @item
301 The software interrupt register is referred to as @samp{%softint}.
303 @item
304 The set software interrupt register is referred to as @samp{%set_softint}.
305 The mnemonic @samp{%softint_set} is provided as an alias.
307 @item
308 The clear software interrupt register is referred to as
309 @samp{%clear_softint}.  The mnemonic @samp{%softint_clear} is provided
310 as an alias.
312 @item
313 The performance instrumentation counters register is referred to as
314 @samp{%pic}.
316 @item
317 The performance control register is referred to as @samp{%pcr}.
319 @item
320 The graphics status register is referred to as @samp{%gsr}.
322 @item
323 The V9 dispatch control register is referred to as @samp{%dcr}.
324 @end itemize
326 Various V9 branch and conditional move instructions allow
327 specification of which set of integer condition codes to
328 test.  These are referred to as @samp{%xcc} and @samp{%icc}.
330 Additionally, GAS supports the so-called ``natural'' condition codes;
331 these are referred to as @samp{%ncc} and reference to @samp{%icc} if
332 the word size is 32, @samp{%xcc} if the word size is 64.
334 In V9, there are 4 sets of floating point condition codes
335 which are referred to as @samp{%fcc@var{n}}.
337 Several special privileged and non-privileged registers
338 exist:
340 @itemize @bullet
341 @item
342 The V9 address space identifier register is referred to as @samp{%asi}.
344 @item
345 The V9 restorable windows register is referred to as @samp{%canrestore}.
347 @item
348 The V9 savable windows register is referred to as @samp{%cansave}.
350 @item
351 The V9 clean windows register is referred to as @samp{%cleanwin}.
353 @item
354 The V9 current window pointer register is referred to as @samp{%cwp}.
356 @item
357 The floating-point queue register is referred to as @samp{%fq}.
359 @item
360 The V8 co-processor queue register is referred to as @samp{%cq}.
362 @item
363 The floating point status register is referred to as @samp{%fsr}.
365 @item
366 The other windows register is referred to as @samp{%otherwin}.
368 @item
369 The V9 program counter register is referred to as @samp{%pc}.
371 @item
372 The V9 next program counter register is referred to as @samp{%npc}.
374 @item
375 The V9 processor interrupt level register is referred to as @samp{%pil}.
377 @item
378 The V9 processor state register is referred to as @samp{%pstate}.
380 @item
381 The trap base address register is referred to as @samp{%tba}.
383 @item
384 The V9 tick register is referred to as @samp{%tick}.
386 @item
387 The V9 trap level is referred to as @samp{%tl}.
389 @item
390 The V9 trap program counter is referred to as @samp{%tpc}.
392 @item
393 The V9 trap next program counter is referred to as @samp{%tnpc}.
395 @item
396 The V9 trap state is referred to as @samp{%tstate}.
398 @item
399 The V9 trap type is referred to as @samp{%tt}.
401 @item
402 The V9 condition codes is referred to as @samp{%ccr}.
404 @item
405 The V9 floating-point registers state is referred to as @samp{%fprs}.
407 @item
408 The V9 version register is referred to as @samp{%ver}.
410 @item
411 The V9 window state register is referred to as @samp{%wstate}.
413 @item
414 The Y register is referred to as @samp{%y}.
416 @item
417 The V8 window invalid mask register is referred to as @samp{%wim}.
419 @item
420 The V8 processor state register is referred to as @samp{%psr}.
422 @item
423 The V9 global register level register is referred to as @samp{%gl}.
424 @end itemize
426 Several special register names exist for hypervisor mode code:
428 @itemize @bullet
429 @item
430 The hyperprivileged processor state register is referred to as
431 @samp{%hpstate}.
433 @item
434 The hyperprivileged trap state register is referred to as @samp{%htstate}.
436 @item
437 The hyperprivileged interrupt pending register is referred to as
438 @samp{%hintp}.
440 @item
441 The hyperprivileged trap base address register is referred to as
442 @samp{%htba}.
444 @item
445 The hyperprivileged implementation version register is referred
446 to as @samp{%hver}.
448 @item
449 The hyperprivileged system tick offset register is referred to as
450 @samp{%hstick_offset}.  Note that there is no @samp{%hstick} register,
451 the normal @samp{%stick} is used.
453 @item
454 The hyperprivileged system tick enable register is referred to as
455 @samp{%hstick_enable}.
457 @item
458 The hyperprivileged system tick compare register is referred
459 to as @samp{%hstick_cmpr}.
460 @end itemize
462 @node Sparc-Constants
463 @subsection Constants
464 @cindex Sparc constants
465 @cindex constants, Sparc
467 Several Sparc instructions take an immediate operand field for
468 which mnemonic names exist.  Two such examples are @samp{membar}
469 and @samp{prefetch}.  Another example are the set of V9
470 memory access instruction that allow specification of an
471 address space identifier.
473 The @samp{membar} instruction specifies a memory barrier that is
474 the defined by the operand which is a bitmask.  The supported
475 mask mnemonics are:
477 @itemize @bullet
478 @item
479 @samp{#Sync} requests that all operations (including nonmemory
480 reference operations) appearing prior to the @code{membar} must have
481 been performed and the effects of any exceptions become visible before
482 any instructions after the @code{membar} may be initiated.  This
483 corresponds to @code{membar} cmask field bit 2.
485 @item
486 @samp{#MemIssue} requests that all memory reference operations
487 appearing prior to the @code{membar} must have been performed before
488 any memory operation after the @code{membar} may be initiated.  This
489 corresponds to @code{membar} cmask field bit 1.
491 @item
492 @samp{#Lookaside} requests that a store appearing prior to the
493 @code{membar} must complete before any load following the
494 @code{membar} referencing the same address can be initiated.  This
495 corresponds to @code{membar} cmask field bit 0.
497 @item
498 @samp{#StoreStore} defines that the effects of all stores appearing
499 prior to the @code{membar} instruction must be visible to all
500 processors before the effect of any stores following the
501 @code{membar}.  Equivalent to the deprecated @code{stbar} instruction.
502 This corresponds to @code{membar} mmask field bit 3.
504 @item
505 @samp{#LoadStore} defines all loads appearing prior to the
506 @code{membar} instruction must have been performed before the effect
507 of any stores following the @code{membar} is visible to any other
508 processor.  This corresponds to @code{membar} mmask field bit 2.
510 @item
511 @samp{#StoreLoad} defines that the effects of all stores appearing
512 prior to the @code{membar} instruction must be visible to all
513 processors before loads following the @code{membar} may be performed.
514 This corresponds to @code{membar} mmask field bit 1.
516 @item
517 @samp{#LoadLoad} defines that all loads appearing prior to the
518 @code{membar} instruction must have been performed before any loads
519 following the @code{membar} may be performed.  This corresponds to
520 @code{membar} mmask field bit 0.
522 @end itemize
524 These values can be ored together, for example:
526 @example
527 membar #Sync
528 membar #StoreLoad | #LoadLoad
529 membar #StoreLoad | #StoreStore
530 @end example
532 The @code{prefetch} and @code{prefetcha} instructions take a prefetch
533 function code.  The following prefetch function code constant
534 mnemonics are available:
536 @itemize @bullet
537 @item
538 @samp{#n_reads} requests a prefetch for several reads, and corresponds
539 to a prefetch function code of 0.
541 @samp{#one_read} requests a prefetch for one read, and corresponds
542 to a prefetch function code of 1.
544 @samp{#n_writes} requests a prefetch for several writes (and possibly
545 reads), and corresponds to a prefetch function code of 2.
547 @samp{#one_write} requests a prefetch for one write, and corresponds
548 to a prefetch function code of 3.
550 @samp{#page} requests a prefetch page, and corresponds to a prefetch
551 function code of 4.
553 @samp{#invalidate} requests a prefetch invalidate, and corresponds to
554 a prefetch function code of 16.
556 @samp{#unified} requests a prefetch to the nearest unified cache, and
557 corresponds to a prefetch function code of 17.
559 @samp{#n_reads_strong} requests a strong prefetch for several reads,
560 and corresponds to a prefetch function code of 20.
562 @samp{#one_read_strong} requests a strong prefetch for one read,
563 and corresponds to a prefetch function code of 21.
565 @samp{#n_writes_strong} requests a strong prefetch for several writes,
566 and corresponds to a prefetch function code of 22.
568 @samp{#one_write_strong} requests a strong prefetch for one write,
569 and corresponds to a prefetch function code of 23.
571 Onle one prefetch code may be specified.  Here are some examples:
573 @example
574 prefetch  [%l0 + %l2], #one_read
575 prefetch  [%g2 + 8], #n_writes
576 prefetcha [%g1] 0x8, #unified
577 prefetcha [%o0 + 0x10] %asi, #n_reads
578 @end example
580 The actual behavior of a given prefetch function code is processor
581 specific.  If a processor does not implement a given prefetch
582 function code, it will treat the prefetch instruction as a nop.
584 For instructions that accept an immediate address space identifier,
585 @code{@value{AS}} provides many mnemonics corresponding to
586 V9 defined as well as UltraSPARC and Niagara extended values.
587 For example, @samp{#ASI_P} and @samp{#ASI_BLK_INIT_QUAD_LDD_AIUS}.
588 See the V9 and processor specific manuals for details.
590 @end itemize
592 @node Sparc-Relocs
593 @subsection Relocations
594 @cindex Sparc relocations
595 @cindex relocations, Sparc
597 ELF relocations are available as defined in the 32-bit and 64-bit
598 Sparc ELF specifications.
600 @code{R_SPARC_HI22} is obtained using @samp{%hi} and @code{R_SPARC_LO10}
601 is obtained using @samp{%lo}.  Likewise @code{R_SPARC_HIX22} is
602 obtained from @samp{%hix} and @code{R_SPARC_LOX10} is obtained
603 using @samp{%lox}.  For example:
605 @example
606 sethi %hi(symbol), %g1
607 or    %g1, %lo(symbol), %g1
609 sethi %hix(symbol), %g1
610 xor   %g1, %lox(symbol), %g1
611 @end example
613 These ``high'' mnemonics extract bits 31:10 of their operand,
614 and the ``low'' mnemonics extract bits 9:0 of their operand.
616 V9 code model relocations can be requested as follows:
618 @itemize @bullet
619 @item
620 @code{R_SPARC_HH22} is requested using @samp{%hh}.  It can
621 also be generated using @samp{%uhi}.
622 @item
623 @code{R_SPARC_HM10} is requested using @samp{%hm}.  It can
624 also be generated using @samp{%ulo}.
625 @item
626 @code{R_SPARC_LM22} is requested using @samp{%lm}.
628 @item
629 @code{R_SPARC_H44} is requested using @samp{%h44}.
630 @item
631 @code{R_SPARC_M44} is requested using @samp{%m44}.
632 @item
633 @code{R_SPARC_L44} is requested using @samp{%l44} or @samp{%l34}.
634 @item
635 @code{R_SPARC_H34} is requested using @samp{%h34}.
636 @end itemize
638 The @samp{%l34} generates a @code{R_SPARC_L44} relocation because it
639 calculates the necessary value, and therefore no explicit
640 @code{R_SPARC_L34} relocation needed to be created for this purpose.
642 The @samp{%h34} and @samp{%l34} relocations are used for the abs34 code
643 model.  Here is an example abs34 address generation sequence:
645 @example
646 sethi %h34(symbol), %g1
647 sllx  %g1, 2, %g1
648 or    %g1, %l34(symbol), %g1
649 @end example
651 The PC relative relocation @code{R_SPARC_PC22} can be obtained by
652 enclosing an operand inside of @samp{%pc22}.  Likewise, the
653 @code{R_SPARC_PC10} relocation can be obtained using @samp{%pc10}.
654 These are mostly used when assembling PIC code.  For example, the
655 standard PIC sequence on Sparc to get the base of the global offset
656 table, PC relative, into a register, can be performed as:
658 @example
659 sethi %pc22(_GLOBAL_OFFSET_TABLE_-4), %l7
660 add   %l7, %pc10(_GLOBAL_OFFSET_TABLE_+4), %l7
661 @end example
663 Several relocations exist to allow the link editor to potentially
664 optimize GOT data references.  The @code{R_SPARC_GOTDATA_OP_HIX22}
665 relocation can obtained by enclosing an operand inside of
666 @samp{%gdop_hix22}.  The @code{R_SPARC_GOTDATA_OP_LOX10}
667 relocation can obtained by enclosing an operand inside of
668 @samp{%gdop_lox10}.  Likewise, @code{R_SPARC_GOTDATA_OP} can be
669 obtained by enclosing an operand inside of @samp{%gdop}.
670 For example, assuming the GOT base is in register @code{%l7}:
672 @example
673 sethi %gdop_hix22(symbol), %l1
674 xor   %l1, %gdop_lox10(symbol), %l1
675 ld    [%l7 + %l1], %l2, %gdop(symbol)
676 @end example
678 There are many relocations that can be requested for access to
679 thread local storage variables.  All of the Sparc TLS mnemonics
680 are supported:
682 @itemize @bullet
683 @item
684 @code{R_SPARC_TLS_GD_HI22} is requested using @samp{%tgd_hi22}.
685 @item
686 @code{R_SPARC_TLS_GD_LO10} is requested using @samp{%tgd_lo10}.
687 @item
688 @code{R_SPARC_TLS_GD_ADD} is requested using @samp{%tgd_add}.
689 @item
690 @code{R_SPARC_TLS_GD_CALL} is requested using @samp{%tgd_call}.
692 @item
693 @code{R_SPARC_TLS_LDM_HI22} is requested using @samp{%tldm_hi22}.
694 @item
695 @code{R_SPARC_TLS_LDM_LO10} is requested using @samp{%tldm_lo10}.
696 @item
697 @code{R_SPARC_TLS_LDM_ADD} is requested using @samp{%tldm_add}.
698 @item
699 @code{R_SPARC_TLS_LDM_CALL} is requested using @samp{%tldm_call}.
701 @item
702 @code{R_SPARC_TLS_LDO_HIX22} is requested using @samp{%tldo_hix22}.
703 @item
704 @code{R_SPARC_TLS_LDO_LOX10} is requested using @samp{%tldo_lox10}.
705 @item
706 @code{R_SPARC_TLS_LDO_ADD} is requested using @samp{%tldo_add}.
708 @item
709 @code{R_SPARC_TLS_IE_HI22} is requested using @samp{%tie_hi22}.
710 @item
711 @code{R_SPARC_TLS_IE_LO10} is requested using @samp{%tie_lo10}.
712 @item
713 @code{R_SPARC_TLS_IE_LD} is requested using @samp{%tie_ld}.
714 @item
715 @code{R_SPARC_TLS_IE_LDX} is requested using @samp{%tie_ldx}.
716 @item
717 @code{R_SPARC_TLS_IE_ADD} is requested using @samp{%tie_add}.
719 @item
720 @code{R_SPARC_TLS_LE_HIX22} is requested using @samp{%tle_hix22}.
721 @item
722 @code{R_SPARC_TLS_LE_LOX10} is requested using @samp{%tle_lox10}.
723 @end itemize
725 Here are some example TLS model sequences.
727 First, General Dynamic:
729 @example
730 sethi  %tgd_hi22(symbol), %l1
731 add    %l1, %tgd_lo10(symbol), %l1
732 add    %l7, %l1, %o0, %tgd_add(symbol)
733 call   __tls_get_addr, %tgd_call(symbol)
735 @end example
737 Local Dynamic:
739 @example
740 sethi  %tldm_hi22(symbol), %l1
741 add    %l1, %tldm_lo10(symbol), %l1
742 add    %l7, %l1, %o0, %tldm_add(symbol)
743 call   __tls_get_addr, %tldm_call(symbol)
746 sethi  %tldo_hix22(symbol), %l1
747 xor    %l1, %tldo_lox10(symbol), %l1
748 add    %o0, %l1, %l1, %tldo_add(symbol)
749 @end example
751 Initial Exec:
753 @example
754 sethi  %tie_hi22(symbol), %l1
755 add    %l1, %tie_lo10(symbol), %l1
756 ld     [%l7 + %l1], %o0, %tie_ld(symbol)
757 add    %g7, %o0, %o0, %tie_add(symbol)
759 sethi  %tie_hi22(symbol), %l1
760 add    %l1, %tie_lo10(symbol), %l1
761 ldx    [%l7 + %l1], %o0, %tie_ldx(symbol)
762 add    %g7, %o0, %o0, %tie_add(symbol)
763 @end example
765 And finally, Local Exec:
767 @example
768 sethi  %tle_hix22(symbol), %l1
769 add    %l1, %tle_lox10(symbol), %l1
770 add    %g7, %l1, %l1
771 @end example
773 When assembling for 64-bit, and a secondary constant addend is
774 specified in an address expression that would normally generate
775 an @code{R_SPARC_LO10} relocation, the assembler will emit an
776 @code{R_SPARC_OLO10} instead.
778 @node Sparc-Size-Translations
779 @subsection Size Translations
780 @cindex Sparc size translations
781 @cindex size, translations, Sparc
783 Often it is desirable to write code in an operand size agnostic
784 manner.  @code{@value{AS}} provides support for this via
785 operand size opcode translations.  Translations are supported
786 for loads, stores, shifts, compare-and-swap atomics, and the
787 @samp{clr} synthetic instruction.
789 If generating 32-bit code, @code{@value{AS}} will generate the
790 32-bit opcode.  Whereas if 64-bit code is being generated,
791 the 64-bit opcode will be emitted.  For example @code{ldn}
792 will be transformed into @code{ld} for 32-bit code and
793 @code{ldx} for 64-bit code.
795 Here is an example meant to demonstrate all the supported
796 opcode translations:
798 @example
799 ldn   [%o0], %o1
800 ldna  [%o0] %asi, %o2
801 stn   %o1, [%o0]
802 stna  %o2, [%o0] %asi
803 slln  %o3, 3, %o3
804 srln  %o4, 8, %o4
805 sran  %o5, 12, %o5
806 casn  [%o0], %o1, %o2
807 casna [%o0] %asi, %o1, %o2
808 clrn  %g1
809 @end example
811 In 32-bit mode @code{@value{AS}} will emit:
813 @example
814 ld   [%o0], %o1
815 lda  [%o0] %asi, %o2
816 st   %o1, [%o0]
817 sta  %o2, [%o0] %asi
818 sll  %o3, 3, %o3
819 srl  %o4, 8, %o4
820 sra  %o5, 12, %o5
821 cas  [%o0], %o1, %o2
822 casa [%o0] %asi, %o1, %o2
823 clr  %g1
824 @end example
826 And in 64-bit mode @code{@value{AS}} will emit:
828 @example
829 ldx   [%o0], %o1
830 ldxa  [%o0] %asi, %o2
831 stx   %o1, [%o0]
832 stxa  %o2, [%o0] %asi
833 sllx  %o3, 3, %o3
834 srlx  %o4, 8, %o4
835 srax  %o5, 12, %o5
836 casx  [%o0], %o1, %o2
837 casxa [%o0] %asi, %o1, %o2
838 clrx  %g1
839 @end example
841 Finally, the @samp{.nword} translating directive is supported
842 as well.  It is documented in the section on Sparc machine
843 directives.
845 @node Sparc-Float
846 @section Floating Point
848 @cindex floating point, SPARC (@sc{ieee})
849 @cindex SPARC floating point (@sc{ieee})
850 The Sparc uses @sc{ieee} floating-point numbers.
852 @node Sparc-Directives
853 @section Sparc Machine Directives
855 @cindex SPARC machine directives
856 @cindex machine directives, SPARC
857 The Sparc version of @code{@value{AS}} supports the following additional
858 machine directives:
860 @table @code
861 @cindex @code{align} directive, SPARC
862 @item .align
863 This must be followed by the desired alignment in bytes.
865 @cindex @code{common} directive, SPARC
866 @item .common
867 This must be followed by a symbol name, a positive number, and
868 @code{"bss"}.  This behaves somewhat like @code{.comm}, but the
869 syntax is different.
871 @cindex @code{half} directive, SPARC
872 @item .half
873 This is functionally identical to @code{.short}.
875 @cindex @code{nword} directive, SPARC
876 @item .nword
877 On the Sparc, the @code{.nword} directive produces native word sized value,
878 ie. if assembling with -32 it is equivalent to @code{.word}, if assembling
879 with -64 it is equivalent to @code{.xword}.
881 @cindex @code{proc} directive, SPARC
882 @item .proc
883 This directive is ignored.  Any text following it on the same
884 line is also ignored.
886 @cindex @code{register} directive, SPARC
887 @item .register
888 This directive declares use of a global application or system register.
889 It must be followed by a register name %g2, %g3, %g6 or %g7, comma and
890 the symbol name for that register.  If symbol name is @code{#scratch},
891 it is a scratch register, if it is @code{#ignore}, it just suppresses any
892 errors about using undeclared global register, but does not emit any
893 information about it into the object file.  This can be useful e.g. if you
894 save the register before use and restore it after.
896 @cindex @code{reserve} directive, SPARC
897 @item .reserve
898 This must be followed by a symbol name, a positive number, and
899 @code{"bss"}.  This behaves somewhat like @code{.lcomm}, but the
900 syntax is different.
902 @cindex @code{seg} directive, SPARC
903 @item .seg
904 This must be followed by @code{"text"}, @code{"data"}, or
905 @code{"data1"}.  It behaves like @code{.text}, @code{.data}, or
906 @code{.data 1}.
908 @cindex @code{skip} directive, SPARC
909 @item .skip
910 This is functionally identical to the @code{.space} directive.
912 @cindex @code{word} directive, SPARC
913 @item .word
914 On the Sparc, the @code{.word} directive produces 32 bit values,
915 instead of the 16 bit values it produces on many other machines.
917 @cindex @code{xword} directive, SPARC
918 @item .xword
919 On the Sparc V9 processor, the @code{.xword} directive produces
920 64 bit values.
921 @end table