[PATCH 16/57][Arm][GAS] Add support for MVE instructions: vdup, vddup, vdwdup, vidup...
[binutils-gdb.git] / gas / doc / as.texi
blobf0d91d0f78a9bb4571e226e5dd0bfefe2558447f
1 \input texinfo @c                               -*-Texinfo-*-
2 @c  Copyright (C) 1991-2019 Free Software Foundation, Inc.
3 @c UPDATE!!  On future updates--
4 @c   (1)   check for new machine-dep cmdline options in
5 @c         md_parse_option definitions in config/tc-*.c
6 @c   (2)   for platform-specific directives, examine md_pseudo_op
7 @c         in config/tc-*.c
8 @c   (3)   for object-format specific directives, examine obj_pseudo_op
9 @c         in config/obj-*.c
10 @c   (4)   portable directives in potable[] in read.c
11 @c %**start of header
12 @setfilename as.info
13 @c ---config---
14 @macro gcctabopt{body}
15 @code{\body\}
16 @end macro
17 @c defaults, config file may override:
18 @set have-stabs
19 @c ---
20 @c man begin NAME
21 @c ---
22 @include asconfig.texi
23 @include bfdver.texi
24 @c ---
25 @c man end
26 @c ---
27 @c common OR combinations of conditions
28 @ifset COFF
29 @set COFF-ELF
30 @end ifset
31 @ifset ELF
32 @set COFF-ELF
33 @end ifset
34 @ifset AOUT
35 @set aout
36 @end ifset
37 @ifset ARM/Thumb
38 @set ARM
39 @end ifset
40 @ifset Blackfin
41 @set Blackfin
42 @end ifset
43 @ifset H8/300
44 @set H8
45 @end ifset
46 @ifset SH
47 @set H8
48 @end ifset
49 @ifset HPPA
50 @set abnormal-separator
51 @end ifset
52 @c ------------
53 @ifset GENERIC
54 @settitle Using @value{AS}
55 @end ifset
56 @ifclear GENERIC
57 @settitle Using @value{AS} (@value{TARGET})
58 @end ifclear
59 @setchapternewpage odd
60 @c %**end of header
62 @c @smallbook
63 @c @set SMALL
64 @c WARE! Some of the machine-dependent sections contain tables of machine
65 @c instructions.  Except in multi-column format, these tables look silly.
66 @c Unfortunately, Texinfo doesn't have a general-purpose multi-col format, so
67 @c the multi-col format is faked within @example sections.
69 @c Again unfortunately, the natural size that fits on a page, for these tables,
70 @c is different depending on whether or not smallbook is turned on.
71 @c This matters, because of order: text flow switches columns at each page
72 @c break.
74 @c The format faked in this source works reasonably well for smallbook,
75 @c not well for the default large-page format.  This manual expects that if you
76 @c turn on @smallbook, you will also uncomment the "@set SMALL" to enable the
77 @c tables in question.  You can turn on one without the other at your
78 @c discretion, of course.
79 @ifinfo
80 @set SMALL
81 @c the insn tables look just as silly in info files regardless of smallbook,
82 @c might as well show 'em anyways.
83 @end ifinfo
85 @ifnottex
86 @dircategory Software development
87 @direntry
88 * As: (as).                     The GNU assembler.
89 * Gas: (as).                    The GNU assembler.
90 @end direntry
91 @end ifnottex
93 @finalout
94 @syncodeindex ky cp
96 @copying
97 This file documents the GNU Assembler "@value{AS}".
99 @c man begin COPYRIGHT
100 Copyright @copyright{} 1991-2019 Free Software Foundation, Inc.
102 Permission is granted to copy, distribute and/or modify this document
103 under the terms of the GNU Free Documentation License, Version 1.3
104 or any later version published by the Free Software Foundation;
105 with no Invariant Sections, with no Front-Cover Texts, and with no
106 Back-Cover Texts.  A copy of the license is included in the
107 section entitled ``GNU Free Documentation License''.
109 @c man end
110 @end copying
112 @titlepage
113 @title Using @value{AS}
114 @subtitle The @sc{gnu} Assembler
115 @ifclear GENERIC
116 @subtitle for the @value{TARGET} family
117 @end ifclear
118 @ifset VERSION_PACKAGE
119 @sp 1
120 @subtitle @value{VERSION_PACKAGE}
121 @end ifset
122 @sp 1
123 @subtitle Version @value{VERSION}
124 @sp 1
125 @sp 13
126 The Free Software Foundation Inc.@: thanks The Nice Computer
127 Company of Australia for loaning Dean Elsner to write the
128 first (Vax) version of @command{as} for Project @sc{gnu}.
129 The proprietors, management and staff of TNCCA thank FSF for
130 distracting the boss while they got some work
131 done.
132 @sp 3
133 @author Dean Elsner, Jay Fenlason & friends
134 @page
135 @tex
136 {\parskip=0pt
137 \hfill {\it Using {\tt @value{AS}}}\par
138 \hfill Edited by Cygnus Support\par
140 %"boxit" macro for figures:
141 %Modified from Knuth's ``boxit'' macro from TeXbook (answer to exercise 21.3)
142 \gdef\boxit#1#2{\vbox{\hrule\hbox{\vrule\kern3pt
143      \vbox{\parindent=0pt\parskip=0pt\hsize=#1\kern3pt\strut\hfil
144 #2\hfil\strut\kern3pt}\kern3pt\vrule}\hrule}}%box with visible outline
145 \gdef\ibox#1#2{\hbox to #1{#2\hfil}\kern8pt}% invisible box
146 @end tex
148 @vskip 0pt plus 1filll
149 Copyright @copyright{} 1991-2019 Free Software Foundation, Inc.
151       Permission is granted to copy, distribute and/or modify this document
152       under the terms of the GNU Free Documentation License, Version 1.3
153       or any later version published by the Free Software Foundation;
154       with no Invariant Sections, with no Front-Cover Texts, and with no
155       Back-Cover Texts.  A copy of the license is included in the
156       section entitled ``GNU Free Documentation License''.
158 @end titlepage
159 @contents
161 @ifnottex
162 @node Top
163 @top Using @value{AS}
165 This file is a user guide to the @sc{gnu} assembler @command{@value{AS}}
166 @ifset VERSION_PACKAGE
167 @value{VERSION_PACKAGE}
168 @end ifset
169 version @value{VERSION}.
170 @ifclear GENERIC
171 This version of the file describes @command{@value{AS}} configured to generate
172 code for @value{TARGET} architectures.
173 @end ifclear
175 This document is distributed under the terms of the GNU Free
176 Documentation License.  A copy of the license is included in the
177 section entitled ``GNU Free Documentation License''.
179 @menu
180 * Overview::                    Overview
181 * Invoking::                    Command-Line Options
182 * Syntax::                      Syntax
183 * Sections::                    Sections and Relocation
184 * Symbols::                     Symbols
185 * Expressions::                 Expressions
186 * Pseudo Ops::                  Assembler Directives
187 @ifset ELF
188 * Object Attributes::           Object Attributes
189 @end ifset
190 * Machine Dependencies::        Machine Dependent Features
191 * Reporting Bugs::              Reporting Bugs
192 * Acknowledgements::            Who Did What
193 * GNU Free Documentation License::  GNU Free Documentation License
194 * AS Index::                    AS Index
195 @end menu
196 @end ifnottex
198 @node Overview
199 @chapter Overview
200 @iftex
201 This manual is a user guide to the @sc{gnu} assembler @command{@value{AS}}.
202 @ifclear GENERIC
203 This version of the manual describes @command{@value{AS}} configured to generate
204 code for @value{TARGET} architectures.
205 @end ifclear
206 @end iftex
208 @cindex invocation summary
209 @cindex option summary
210 @cindex summary of options
211 Here is a brief summary of how to invoke @command{@value{AS}}.  For details,
212 see @ref{Invoking,,Command-Line Options}.
214 @c man title AS the portable GNU assembler.
216 @ignore
217 @c man begin SEEALSO
218 gcc(1), ld(1), and the Info entries for @file{binutils} and @file{ld}.
219 @c man end
220 @end ignore
222 @c We don't use deffn and friends for the following because they seem
223 @c to be limited to one line for the header.
224 @smallexample
225 @c man begin SYNOPSIS
226 @value{AS} [@b{-a}[@b{cdghlns}][=@var{file}]] [@b{--alternate}] [@b{-D}]
227  [@b{--compress-debug-sections}]  [@b{--nocompress-debug-sections}]
228  [@b{--debug-prefix-map} @var{old}=@var{new}]
229  [@b{--defsym} @var{sym}=@var{val}] [@b{-f}] [@b{-g}] [@b{--gstabs}]
230  [@b{--gstabs+}] [@b{--gdwarf-2}] [@b{--gdwarf-sections}]
231  [@b{--help}] [@b{-I} @var{dir}] [@b{-J}]
232  [@b{-K}] [@b{-L}] [@b{--listing-lhs-width}=@var{NUM}]
233  [@b{--listing-lhs-width2}=@var{NUM}] [@b{--listing-rhs-width}=@var{NUM}]
234  [@b{--listing-cont-lines}=@var{NUM}] [@b{--keep-locals}]
235  [@b{--no-pad-sections}]
236  [@b{-o} @var{objfile}] [@b{-R}]
237  [@b{--hash-size}=@var{NUM}] [@b{--reduce-memory-overheads}]
238  [@b{--statistics}]
239  [@b{-v}] [@b{-version}] [@b{--version}]
240  [@b{-W}] [@b{--warn}] [@b{--fatal-warnings}] [@b{-w}] [@b{-x}]
241  [@b{-Z}] [@b{@@@var{FILE}}]
242  [@b{--sectname-subst}] [@b{--size-check=[error|warning]}]
243  [@b{--elf-stt-common=[no|yes]}]
244  [@b{--generate-missing-build-notes=[no|yes]}]
245  [@b{--target-help}] [@var{target-options}]
246  [@b{--}|@var{files} @dots{}]
248 @c man end
249 @c Target dependent options are listed below.  Keep the list sorted.
250 @c Add an empty line for separation.
251 @c man begin TARGET
252 @ifset AARCH64
254 @emph{Target AArch64 options:}
255    [@b{-EB}|@b{-EL}]
256    [@b{-mabi}=@var{ABI}]
257 @end ifset
258 @ifset ALPHA
260 @emph{Target Alpha options:}
261    [@b{-m@var{cpu}}]
262    [@b{-mdebug} | @b{-no-mdebug}]
263    [@b{-replace} | @b{-noreplace}]
264    [@b{-relax}] [@b{-g}] [@b{-G@var{size}}]
265    [@b{-F}] [@b{-32addr}]
266 @end ifset
267 @ifset ARC
269 @emph{Target ARC options:}
270    [@b{-mcpu=@var{cpu}}]
271    [@b{-mA6}|@b{-mARC600}|@b{-mARC601}|@b{-mA7}|@b{-mARC700}|@b{-mEM}|@b{-mHS}]
272    [@b{-mcode-density}]
273    [@b{-mrelax}]
274    [@b{-EB}|@b{-EL}]
275 @end ifset
276 @ifset ARM
278 @emph{Target ARM options:}
279 @c Don't document the deprecated options
280    [@b{-mcpu}=@var{processor}[+@var{extension}@dots{}]]
281    [@b{-march}=@var{architecture}[+@var{extension}@dots{}]]
282    [@b{-mfpu}=@var{floating-point-format}]
283    [@b{-mfloat-abi}=@var{abi}]
284    [@b{-meabi}=@var{ver}]
285    [@b{-mthumb}]
286    [@b{-EB}|@b{-EL}]
287    [@b{-mapcs-32}|@b{-mapcs-26}|@b{-mapcs-float}|
288     @b{-mapcs-reentrant}]
289    [@b{-mthumb-interwork}] [@b{-k}]
290 @end ifset
291 @ifset Blackfin
293 @emph{Target Blackfin options:}
294    [@b{-mcpu}=@var{processor}[-@var{sirevision}]]
295    [@b{-mfdpic}]
296    [@b{-mno-fdpic}]
297    [@b{-mnopic}]
298 @end ifset
299 @ifset CRIS
301 @emph{Target CRIS options:}
302    [@b{--underscore} | @b{--no-underscore}]
303    [@b{--pic}] [@b{-N}]
304    [@b{--emulation=criself} | @b{--emulation=crisaout}]
305    [@b{--march=v0_v10} | @b{--march=v10} | @b{--march=v32} | @b{--march=common_v10_v32}]
306 @c Deprecated -- deliberately not documented.
307 @c [@b{-h}] [@b{-H}]
308 @end ifset
309 @ifset CSKY
311 @emph{Target C-SKY options:}
312    [@b{-march=@var{arch}}] [@b{-mcpu=@var{cpu}}]
313    [@b{-EL}] [@b{-mlittle-endian}] [@b{-EB}] [@b{-mbig-endian}]
314    [@b{-fpic}] [@b{-pic}]
315    [@b{-mljump}] [@b{-mno-ljump}]
316    [@b{-force2bsr}] [@b{-mforce2bsr}] [@b{-no-force2bsr}] [@b{-mno-force2bsr}]
317    [@b{-jsri2bsr}] [@b{-mjsri2bsr}] [@b{-no-jsri2bsr }] [@b{-mno-jsri2bsr}]
318    [@b{-mnolrw }] [@b{-mno-lrw}]
319    [@b{-melrw}] [@b{-mno-elrw}]
320    [@b{-mlaf }] [@b{-mliterals-after-func}]
321    [@b{-mno-laf}] [@b{-mno-literals-after-func}]
322    [@b{-mlabr}] [@b{-mliterals-after-br}]
323    [@b{-mno-labr}] [@b{-mnoliterals-after-br}]
324    [@b{-mistack}] [@b{-mno-istack}]
325    [@b{-mhard-float}] [@b{-mmp}] [@b{-mcp}] [@b{-mcache}]
326    [@b{-msecurity}] [@b{-mtrust}]
327    [@b{-mdsp}] [@b{-medsp}] [@b{-mvdsp}]
328 @end ifset
329 @ifset D10V
331 @emph{Target D10V options:}
332    [@b{-O}]
333 @end ifset
334 @ifset D30V
336 @emph{Target D30V options:}
337    [@b{-O}|@b{-n}|@b{-N}]
338 @end ifset
339 @ifset EPIPHANY
341 @emph{Target EPIPHANY options:}
342    [@b{-mepiphany}|@b{-mepiphany16}]
343 @end ifset
344 @ifset H8
346 @emph{Target H8/300 options:}
347    [-h-tick-hex]
348 @end ifset
349 @ifset HPPA
350 @c HPPA has no machine-dependent assembler options (yet).
351 @end ifset
352 @ifset I80386
354 @emph{Target i386 options:}
355    [@b{--32}|@b{--x32}|@b{--64}] [@b{-n}]
356    [@b{-march}=@var{CPU}[+@var{EXTENSION}@dots{}]] [@b{-mtune}=@var{CPU}]
357 @end ifset
358 @ifset IA64
360 @emph{Target IA-64 options:}
361    [@b{-mconstant-gp}|@b{-mauto-pic}]
362    [@b{-milp32}|@b{-milp64}|@b{-mlp64}|@b{-mp64}]
363    [@b{-mle}|@b{mbe}]
364    [@b{-mtune=itanium1}|@b{-mtune=itanium2}]
365    [@b{-munwind-check=warning}|@b{-munwind-check=error}]
366    [@b{-mhint.b=ok}|@b{-mhint.b=warning}|@b{-mhint.b=error}]
367    [@b{-x}|@b{-xexplicit}] [@b{-xauto}] [@b{-xdebug}]
368 @end ifset
369 @ifset IP2K
371 @emph{Target IP2K options:}
372    [@b{-mip2022}|@b{-mip2022ext}]
373 @end ifset
374 @ifset M32C
376 @emph{Target M32C options:}
377    [@b{-m32c}|@b{-m16c}] [-relax] [-h-tick-hex]
378 @end ifset
379 @ifset M32R
381 @emph{Target M32R options:}
382    [@b{--m32rx}|@b{--[no-]warn-explicit-parallel-conflicts}|
383    @b{--W[n]p}]
384 @end ifset
385 @ifset M680X0
387 @emph{Target M680X0 options:}
388    [@b{-l}] [@b{-m68000}|@b{-m68010}|@b{-m68020}|@dots{}]
389 @end ifset
390 @ifset M68HC11
392 @emph{Target M68HC11 options:}
393    [@b{-m68hc11}|@b{-m68hc12}|@b{-m68hcs12}|@b{-mm9s12x}|@b{-mm9s12xg}]
394    [@b{-mshort}|@b{-mlong}]
395    [@b{-mshort-double}|@b{-mlong-double}]
396    [@b{--force-long-branches}] [@b{--short-branches}]
397    [@b{--strict-direct-mode}] [@b{--print-insn-syntax}]
398    [@b{--print-opcodes}] [@b{--generate-example}]
399 @end ifset
400 @ifset MCORE
402 @emph{Target MCORE options:}
403    [@b{-jsri2bsr}] [@b{-sifilter}] [@b{-relax}]
404    [@b{-mcpu=[210|340]}]
405 @end ifset
406 @ifset METAG
408 @emph{Target Meta options:}
409    [@b{-mcpu=@var{cpu}}] [@b{-mfpu=@var{cpu}}] [@b{-mdsp=@var{cpu}}]
410 @end ifset
411 @ifset MICROBLAZE
412 @emph{Target MICROBLAZE options:}
413 @c MicroBlaze has no machine-dependent assembler options.
414 @end ifset
415 @ifset MIPS
417 @emph{Target MIPS options:}
418    [@b{-nocpp}] [@b{-EL}] [@b{-EB}] [@b{-O}[@var{optimization level}]]
419    [@b{-g}[@var{debug level}]] [@b{-G} @var{num}] [@b{-KPIC}] [@b{-call_shared}]
420    [@b{-non_shared}] [@b{-xgot} [@b{-mvxworks-pic}]
421    [@b{-mabi}=@var{ABI}] [@b{-32}] [@b{-n32}] [@b{-64}] [@b{-mfp32}] [@b{-mgp32}]
422    [@b{-mfp64}] [@b{-mgp64}] [@b{-mfpxx}]
423    [@b{-modd-spreg}] [@b{-mno-odd-spreg}]
424    [@b{-march}=@var{CPU}] [@b{-mtune}=@var{CPU}] [@b{-mips1}] [@b{-mips2}]
425    [@b{-mips3}] [@b{-mips4}] [@b{-mips5}] [@b{-mips32}] [@b{-mips32r2}]
426    [@b{-mips32r3}] [@b{-mips32r5}] [@b{-mips32r6}] [@b{-mips64}] [@b{-mips64r2}]
427    [@b{-mips64r3}] [@b{-mips64r5}] [@b{-mips64r6}]
428    [@b{-construct-floats}] [@b{-no-construct-floats}]
429    [@b{-mignore-branch-isa}] [@b{-mno-ignore-branch-isa}]
430    [@b{-mnan=@var{encoding}}]
431    [@b{-trap}] [@b{-no-break}] [@b{-break}] [@b{-no-trap}]
432    [@b{-mips16}] [@b{-no-mips16}]
433    [@b{-mmips16e2}] [@b{-mno-mips16e2}]
434    [@b{-mmicromips}] [@b{-mno-micromips}]
435    [@b{-msmartmips}] [@b{-mno-smartmips}]
436    [@b{-mips3d}] [@b{-no-mips3d}]
437    [@b{-mdmx}] [@b{-no-mdmx}]
438    [@b{-mdsp}] [@b{-mno-dsp}]
439    [@b{-mdspr2}] [@b{-mno-dspr2}]
440    [@b{-mdspr3}] [@b{-mno-dspr3}]
441    [@b{-mmsa}] [@b{-mno-msa}]
442    [@b{-mxpa}] [@b{-mno-xpa}]
443    [@b{-mmt}] [@b{-mno-mt}]
444    [@b{-mmcu}] [@b{-mno-mcu}]
445    [@b{-mcrc}] [@b{-mno-crc}]
446    [@b{-mginv}] [@b{-mno-ginv}]
447    [@b{-mloongson-mmi}] [@b{-mno-loongson-mmi}]
448    [@b{-mloongson-cam}] [@b{-mno-loongson-cam}]
449    [@b{-mloongson-ext}] [@b{-mno-loongson-ext}]
450    [@b{-mloongson-ext2}] [@b{-mno-loongson-ext2}]
451    [@b{-minsn32}] [@b{-mno-insn32}]
452    [@b{-mfix7000}] [@b{-mno-fix7000}]
453    [@b{-mfix-rm7000}] [@b{-mno-fix-rm7000}]
454    [@b{-mfix-vr4120}] [@b{-mno-fix-vr4120}]
455    [@b{-mfix-vr4130}] [@b{-mno-fix-vr4130}]
456    [@b{-mfix-r5900}] [@b{-mno-fix-r5900}]
457    [@b{-mdebug}] [@b{-no-mdebug}]
458    [@b{-mpdr}] [@b{-mno-pdr}]
459 @end ifset
460 @ifset MMIX
462 @emph{Target MMIX options:}
463    [@b{--fixed-special-register-names}] [@b{--globalize-symbols}]
464    [@b{--gnu-syntax}] [@b{--relax}] [@b{--no-predefined-symbols}]
465    [@b{--no-expand}] [@b{--no-merge-gregs}] [@b{-x}]
466    [@b{--linker-allocated-gregs}]
467 @end ifset
468 @ifset NIOSII
470 @emph{Target Nios II options:}
471    [@b{-relax-all}] [@b{-relax-section}] [@b{-no-relax}]
472    [@b{-EB}] [@b{-EL}]
473 @end ifset
474 @ifset NDS32
476 @emph{Target NDS32 options:}
477     [@b{-EL}] [@b{-EB}] [@b{-O}] [@b{-Os}] [@b{-mcpu=@var{cpu}}]
478     [@b{-misa=@var{isa}}] [@b{-mabi=@var{abi}}] [@b{-mall-ext}]
479     [@b{-m[no-]16-bit}]  [@b{-m[no-]perf-ext}] [@b{-m[no-]perf2-ext}]
480     [@b{-m[no-]string-ext}] [@b{-m[no-]dsp-ext}] [@b{-m[no-]mac}] [@b{-m[no-]div}]
481     [@b{-m[no-]audio-isa-ext}] [@b{-m[no-]fpu-sp-ext}] [@b{-m[no-]fpu-dp-ext}]
482     [@b{-m[no-]fpu-fma}] [@b{-mfpu-freg=@var{FREG}}] [@b{-mreduced-regs}]
483     [@b{-mfull-regs}] [@b{-m[no-]dx-regs}] [@b{-mpic}] [@b{-mno-relax}]
484     [@b{-mb2bb}]
485 @end ifset
486 @ifset OPENRISC
487 @c OpenRISC has no machine-dependent assembler options.
488 @end ifset
489 @ifset PDP11
491 @emph{Target PDP11 options:}
492    [@b{-mpic}|@b{-mno-pic}] [@b{-mall}] [@b{-mno-extensions}]
493    [@b{-m}@var{extension}|@b{-mno-}@var{extension}]
494    [@b{-m}@var{cpu}] [@b{-m}@var{machine}]
495 @end ifset
496 @ifset PJ
498 @emph{Target picoJava options:}
499    [@b{-mb}|@b{-me}]
500 @end ifset
501 @ifset PPC
503 @emph{Target PowerPC options:}
504    [@b{-a32}|@b{-a64}]
505    [@b{-mpwrx}|@b{-mpwr2}|@b{-mpwr}|@b{-m601}|@b{-mppc}|@b{-mppc32}|@b{-m603}|@b{-m604}|@b{-m403}|@b{-m405}|
506     @b{-m440}|@b{-m464}|@b{-m476}|@b{-m7400}|@b{-m7410}|@b{-m7450}|@b{-m7455}|@b{-m750cl}|@b{-mgekko}|
507     @b{-mbroadway}|@b{-mppc64}|@b{-m620}|@b{-me500}|@b{-e500x2}|@b{-me500mc}|@b{-me500mc64}|@b{-me5500}|
508     @b{-me6500}|@b{-mppc64bridge}|@b{-mbooke}|@b{-mpower4}|@b{-mpwr4}|@b{-mpower5}|@b{-mpwr5}|@b{-mpwr5x}|
509     @b{-mpower6}|@b{-mpwr6}|@b{-mpower7}|@b{-mpwr7}|@b{-mpower8}|@b{-mpwr8}|@b{-mpower9}|@b{-mpwr9}@b{-ma2}|
510     @b{-mcell}|@b{-mspe}|@b{-mspe2}|@b{-mtitan}|@b{-me300}|@b{-mcom}]
511    [@b{-many}] [@b{-maltivec}|@b{-mvsx}|@b{-mhtm}|@b{-mvle}]
512    [@b{-mregnames}|@b{-mno-regnames}]
513    [@b{-mrelocatable}|@b{-mrelocatable-lib}|@b{-K PIC}] [@b{-memb}]
514    [@b{-mlittle}|@b{-mlittle-endian}|@b{-le}|@b{-mbig}|@b{-mbig-endian}|@b{-be}]
515    [@b{-msolaris}|@b{-mno-solaris}]
516    [@b{-nops=@var{count}}]
517 @end ifset
518 @ifset PRU
520 @emph{Target PRU options:}
521    [@b{-link-relax}]
522    [@b{-mnolink-relax}]
523    [@b{-mno-warn-regname-label}]
524 @end ifset
525 @ifset RISCV
527 @emph{Target RISC-V options:}
528    [@b{-fpic}|@b{-fPIC}|@b{-fno-pic}]
529    [@b{-march}=@var{ISA}]
530    [@b{-mabi}=@var{ABI}]
531 @end ifset
532 @ifset RL78
534 @emph{Target RL78 options:}
535    [@b{-mg10}]
536    [@b{-m32bit-doubles}|@b{-m64bit-doubles}]
537 @end ifset
538 @ifset RX
540 @emph{Target RX options:}
541    [@b{-mlittle-endian}|@b{-mbig-endian}]
542    [@b{-m32bit-doubles}|@b{-m64bit-doubles}]
543    [@b{-muse-conventional-section-names}]
544    [@b{-msmall-data-limit}]
545    [@b{-mpid}]
546    [@b{-mrelax}]
547    [@b{-mint-register=@var{number}}]
548    [@b{-mgcc-abi}|@b{-mrx-abi}]
549 @end ifset
550 @ifset S390
552 @emph{Target s390 options:}
553    [@b{-m31}|@b{-m64}] [@b{-mesa}|@b{-mzarch}] [@b{-march}=@var{CPU}]
554    [@b{-mregnames}|@b{-mno-regnames}]
555    [@b{-mwarn-areg-zero}]
556 @end ifset
557 @ifset SCORE
559 @emph{Target SCORE options:}
560    [@b{-EB}][@b{-EL}][@b{-FIXDD}][@b{-NWARN}]
561    [@b{-SCORE5}][@b{-SCORE5U}][@b{-SCORE7}][@b{-SCORE3}]
562    [@b{-march=score7}][@b{-march=score3}]
563    [@b{-USE_R1}][@b{-KPIC}][@b{-O0}][@b{-G} @var{num}][@b{-V}]
564 @end ifset
565 @ifset SPARC
567 @emph{Target SPARC options:}
568 @c The order here is important.  See c-sparc.texi.
569    [@b{-Av6}|@b{-Av7}|@b{-Av8}|@b{-Aleon}|@b{-Asparclet}|@b{-Asparclite}
570     @b{-Av8plus}|@b{-Av8plusa}|@b{-Av8plusb}|@b{-Av8plusc}|@b{-Av8plusd}
571     @b{-Av8plusv}|@b{-Av8plusm}|@b{-Av9}|@b{-Av9a}|@b{-Av9b}|@b{-Av9c}
572     @b{-Av9d}|@b{-Av9e}|@b{-Av9v}|@b{-Av9m}|@b{-Asparc}|@b{-Asparcvis}
573     @b{-Asparcvis2}|@b{-Asparcfmaf}|@b{-Asparcima}|@b{-Asparcvis3}
574     @b{-Asparcvisr}|@b{-Asparc5}]
575    [@b{-xarch=v8plus}|@b{-xarch=v8plusa}]|@b{-xarch=v8plusb}|@b{-xarch=v8plusc}
576     @b{-xarch=v8plusd}|@b{-xarch=v8plusv}|@b{-xarch=v8plusm}|@b{-xarch=v9}
577     @b{-xarch=v9a}|@b{-xarch=v9b}|@b{-xarch=v9c}|@b{-xarch=v9d}|@b{-xarch=v9e}
578     @b{-xarch=v9v}|@b{-xarch=v9m}|@b{-xarch=sparc}|@b{-xarch=sparcvis}
579     @b{-xarch=sparcvis2}|@b{-xarch=sparcfmaf}|@b{-xarch=sparcima}
580     @b{-xarch=sparcvis3}|@b{-xarch=sparcvisr}|@b{-xarch=sparc5}
581     @b{-bump}]
582    [@b{-32}|@b{-64}]
583    [@b{--enforce-aligned-data}][@b{--dcti-couples-detect}]
584 @end ifset
585 @ifset TIC54X
587 @emph{Target TIC54X options:}
588  [@b{-mcpu=54[123589]}|@b{-mcpu=54[56]lp}] [@b{-mfar-mode}|@b{-mf}]
589  [@b{-merrors-to-file} @var{<filename>}|@b{-me} @var{<filename>}]
590 @end ifset
591 @ifset TIC6X
593 @emph{Target TIC6X options:}
594    [@b{-march=@var{arch}}] [@b{-mbig-endian}|@b{-mlittle-endian}]
595    [@b{-mdsbt}|@b{-mno-dsbt}] [@b{-mpid=no}|@b{-mpid=near}|@b{-mpid=far}]
596    [@b{-mpic}|@b{-mno-pic}]
597 @end ifset
598 @ifset TILEGX
600 @emph{Target TILE-Gx options:}
601    [@b{-m32}|@b{-m64}][@b{-EB}][@b{-EL}]
602 @end ifset
603 @ifset TILEPRO
604 @c TILEPro has no machine-dependent assembler options
605 @end ifset
606 @ifset VISIUM
608 @emph{Target Visium options:}
609    [@b{-mtune=@var{arch}}]
610 @end ifset
611 @ifset XTENSA
613 @emph{Target Xtensa options:}
614  [@b{--[no-]text-section-literals}] [@b{--[no-]auto-litpools}]
615  [@b{--[no-]absolute-literals}]
616  [@b{--[no-]target-align}] [@b{--[no-]longcalls}]
617  [@b{--[no-]transform}]
618  [@b{--rename-section} @var{oldname}=@var{newname}]
619  [@b{--[no-]trampolines}]
620 @end ifset
621 @ifset Z80
623 @emph{Target Z80 options:}
624   [@b{-z80}] [@b{-r800}]
625   [@b{ -ignore-undocumented-instructions}] [@b{-Wnud}]
626   [@b{ -ignore-unportable-instructions}] [@b{-Wnup}]
627   [@b{ -warn-undocumented-instructions}] [@b{-Wud}]
628   [@b{ -warn-unportable-instructions}] [@b{-Wup}]
629   [@b{ -forbid-undocumented-instructions}] [@b{-Fud}]
630   [@b{ -forbid-unportable-instructions}] [@b{-Fup}]
631 @end ifset
632 @ifset Z8000
634 @c Z8000 has no machine-dependent assembler options
635 @end ifset
637 @c man end
638 @end smallexample
640 @c man begin OPTIONS
642 @table @gcctabopt
643 @include at-file.texi
645 @item -a[cdghlmns]
646 Turn on listings, in any of a variety of ways:
648 @table @gcctabopt
649 @item -ac
650 omit false conditionals
652 @item -ad
653 omit debugging directives
655 @item -ag
656 include general information, like @value{AS} version and options passed
658 @item -ah
659 include high-level source
661 @item -al
662 include assembly
664 @item -am
665 include macro expansions
667 @item -an
668 omit forms processing
670 @item -as
671 include symbols
673 @item =file
674 set the name of the listing file
675 @end table
677 You may combine these options; for example, use @samp{-aln} for assembly
678 listing without forms processing.  The @samp{=file} option, if used, must be
679 the last one.  By itself, @samp{-a} defaults to @samp{-ahls}.
681 @item --alternate
682 Begin in alternate macro mode.
683 @ifclear man
684 @xref{Altmacro,,@code{.altmacro}}.
685 @end ifclear
687 @item --compress-debug-sections
688 Compress DWARF debug sections using zlib with SHF_COMPRESSED from the
689 ELF ABI.  The resulting object file may not be compatible with older
690 linkers and object file utilities.  Note if compression would make a
691 given section @emph{larger} then it is not compressed.
693 @ifset ELF
694 @cindex @samp{--compress-debug-sections=} option
695 @item --compress-debug-sections=none
696 @itemx --compress-debug-sections=zlib
697 @itemx --compress-debug-sections=zlib-gnu
698 @itemx --compress-debug-sections=zlib-gabi
699 These options control how DWARF debug sections are compressed.
700 @option{--compress-debug-sections=none} is equivalent to
701 @option{--nocompress-debug-sections}.
702 @option{--compress-debug-sections=zlib} and
703 @option{--compress-debug-sections=zlib-gabi} are equivalent to
704 @option{--compress-debug-sections}.
705 @option{--compress-debug-sections=zlib-gnu} compresses DWARF debug
706 sections using zlib.  The debug sections are renamed to begin with
707 @samp{.zdebug}.  Note if compression would make a given section
708 @emph{larger} then it is not compressed nor renamed.
710 @end ifset
712 @item --nocompress-debug-sections
713 Do not compress DWARF debug sections.  This is usually the default for all
714 targets except the x86/x86_64, but a configure time option can be used to
715 override this.
717 @item -D
718 Ignored.  This option is accepted for script compatibility with calls to
719 other assemblers.
721 @item --debug-prefix-map @var{old}=@var{new}
722 When assembling files in directory @file{@var{old}}, record debugging
723 information describing them as in @file{@var{new}} instead.
725 @item --defsym @var{sym}=@var{value}
726 Define the symbol @var{sym} to be @var{value} before assembling the input file.
727 @var{value} must be an integer constant.  As in C, a leading @samp{0x}
728 indicates a hexadecimal value, and a leading @samp{0} indicates an octal
729 value.  The value of the symbol can be overridden inside a source file via the
730 use of a @code{.set} pseudo-op.
732 @item -f
733 ``fast''---skip whitespace and comment preprocessing (assume source is
734 compiler output).
736 @item -g
737 @itemx --gen-debug
738 Generate debugging information for each assembler source line using whichever
739 debug format is preferred by the target.  This currently means either STABS,
740 ECOFF or DWARF2.
742 @item --gstabs
743 Generate stabs debugging information for each assembler line.  This
744 may help debugging assembler code, if the debugger can handle it.
746 @item --gstabs+
747 Generate stabs debugging information for each assembler line, with GNU
748 extensions that probably only gdb can handle, and that could make other
749 debuggers crash or refuse to read your program.  This
750 may help debugging assembler code.  Currently the only GNU extension is
751 the location of the current working directory at assembling time.
753 @item --gdwarf-2
754 Generate DWARF2 debugging information for each assembler line.  This
755 may help debugging assembler code, if the debugger can handle it.  Note---this
756 option is only supported by some targets, not all of them.
758 @item --gdwarf-sections
759 Instead of creating a .debug_line section, create a series of
760 .debug_line.@var{foo} sections where @var{foo} is the name of the
761 corresponding code section.  For example a code section called @var{.text.func}
762 will have its dwarf line number information placed into a section called
763 @var{.debug_line.text.func}.  If the code section is just called @var{.text}
764 then debug line section will still be called just @var{.debug_line} without any
765 suffix.
767 @ifset ELF
768 @item --size-check=error
769 @itemx --size-check=warning
770 Issue an error or warning for invalid ELF .size directive.
772 @item --elf-stt-common=no
773 @itemx --elf-stt-common=yes
774 These options control whether the ELF assembler should generate common
775 symbols with the @code{STT_COMMON} type.  The default can be controlled
776 by a configure option @option{--enable-elf-stt-common}.
778 @item --generate-missing-build-notes=yes
779 @itemx --generate-missing-build-notes=no
780 These options control whether the ELF assembler should generate GNU Build
781 attribute notes if none are present in the input sources.
782 The default can be controlled by the @option{--enable-generate-build-notes}
783 configure option.
785 @end ifset
787 @item --help
788 Print a summary of the command-line options and exit.
790 @item --target-help
791 Print a summary of all target specific options and exit.
793 @item -I @var{dir}
794 Add directory @var{dir} to the search list for @code{.include} directives.
796 @item -J
797 Don't warn about signed overflow.
799 @item -K
800 @ifclear DIFF-TBL-KLUGE
801 This option is accepted but has no effect on the @value{TARGET} family.
802 @end ifclear
803 @ifset DIFF-TBL-KLUGE
804 Issue warnings when difference tables altered for long displacements.
805 @end ifset
807 @item -L
808 @itemx --keep-locals
809 Keep (in the symbol table) local symbols.  These symbols start with
810 system-specific local label prefixes, typically @samp{.L} for ELF systems
811 or @samp{L} for traditional a.out systems.
812 @ifclear man
813 @xref{Symbol Names}.
814 @end ifclear
816 @item --listing-lhs-width=@var{number}
817 Set the maximum width, in words, of the output data column for an assembler
818 listing to @var{number}.
820 @item --listing-lhs-width2=@var{number}
821 Set the maximum width, in words, of the output data column for continuation
822 lines in an assembler listing to @var{number}.
824 @item --listing-rhs-width=@var{number}
825 Set the maximum width of an input source line, as displayed in a listing, to
826 @var{number} bytes.
828 @item --listing-cont-lines=@var{number}
829 Set the maximum number of lines printed in a listing for a single line of input
830 to @var{number} + 1.
832 @item --no-pad-sections
833 Stop the assembler for padding the ends of output sections to the alignment
834 of that section.  The default is to pad the sections, but this can waste space
835 which might be needed on targets which have tight memory constraints.
837 @item -o @var{objfile}
838 Name the object-file output from @command{@value{AS}} @var{objfile}.
840 @item -R
841 Fold the data section into the text section.
843 @item --hash-size=@var{number}
844 Set the default size of GAS's hash tables to a prime number close to
845 @var{number}.  Increasing this value can reduce the length of time it takes the
846 assembler to perform its tasks, at the expense of increasing the assembler's
847 memory requirements.  Similarly reducing this value can reduce the memory
848 requirements at the expense of speed.
850 @item --reduce-memory-overheads
851 This option reduces GAS's memory requirements, at the expense of making the
852 assembly processes slower.  Currently this switch is a synonym for
853 @samp{--hash-size=4051}, but in the future it may have other effects as well.
855 @ifset ELF
856 @item --sectname-subst
857 Honor substitution sequences in section names.
858 @ifclear man
859 @xref{Section Name Substitutions,,@code{.section @var{name}}}.
860 @end ifclear
861 @end ifset
863 @item --statistics
864 Print the maximum space (in bytes) and total time (in seconds) used by
865 assembly.
867 @item --strip-local-absolute
868 Remove local absolute symbols from the outgoing symbol table.
870 @item -v
871 @itemx -version
872 Print the @command{as} version.
874 @item --version
875 Print the @command{as} version and exit.
877 @item -W
878 @itemx --no-warn
879 Suppress warning messages.
881 @item --fatal-warnings
882 Treat warnings as errors.
884 @item --warn
885 Don't suppress warning messages or treat them as errors.
887 @item -w
888 Ignored.
890 @item -x
891 Ignored.
893 @item -Z
894 Generate an object file even after errors.
896 @item -- | @var{files} @dots{}
897 Standard input, or source files to assemble.
899 @end table
900 @c man end
902 @ifset AARCH64
904 @ifclear man
905 @xref{AArch64 Options}, for the options available when @value{AS} is configured
906 for the 64-bit mode of the ARM Architecture (AArch64).
907 @end ifclear
909 @ifset man
910 @c man begin OPTIONS
911 The following options are available when @value{AS} is configured for the
912 64-bit mode of the ARM Architecture (AArch64).
913 @c man end
914 @c man begin INCLUDE
915 @include c-aarch64.texi
916 @c ended inside the included file
917 @end ifset
919 @end ifset
921 @ifset ALPHA
923 @ifclear man
924 @xref{Alpha Options}, for the options available when @value{AS} is configured
925 for an Alpha processor.
926 @end ifclear
928 @ifset man
929 @c man begin OPTIONS
930 The following options are available when @value{AS} is configured for an Alpha
931 processor.
932 @c man end
933 @c man begin INCLUDE
934 @include c-alpha.texi
935 @c ended inside the included file
936 @end ifset
938 @end ifset
940 @c man begin OPTIONS
941 @ifset ARC
942 The following options are available when @value{AS} is configured for an ARC
943 processor.
945 @table @gcctabopt
946 @item -mcpu=@var{cpu}
947 This option selects the core processor variant.
948 @item -EB | -EL
949 Select either big-endian (-EB) or little-endian (-EL) output.
950 @item -mcode-density
951 Enable Code Density extenssion instructions.
952 @end table
953 @end ifset
955 @ifset ARM
956 The following options are available when @value{AS} is configured for the ARM
957 processor family.
959 @table @gcctabopt
960 @item -mcpu=@var{processor}[+@var{extension}@dots{}]
961 Specify which ARM processor variant is the target.
962 @item -march=@var{architecture}[+@var{extension}@dots{}]
963 Specify which ARM architecture variant is used by the target.
964 @item -mfpu=@var{floating-point-format}
965 Select which Floating Point architecture is the target.
966 @item -mfloat-abi=@var{abi}
967 Select which floating point ABI is in use.
968 @item -mthumb
969 Enable Thumb only instruction decoding.
970 @item -mapcs-32 | -mapcs-26 | -mapcs-float | -mapcs-reentrant
971 Select which procedure calling convention is in use.
972 @item -EB | -EL
973 Select either big-endian (-EB) or little-endian (-EL) output.
974 @item -mthumb-interwork
975 Specify that the code has been generated with interworking between Thumb and
976 ARM code in mind.
977 @item -mccs
978 Turns on CodeComposer Studio assembly syntax compatibility mode.
979 @item -k
980 Specify that PIC code has been generated.
981 @end table
982 @end ifset
983 @c man end
985 @ifset Blackfin
987 @ifclear man
988 @xref{Blackfin Options}, for the options available when @value{AS} is
989 configured for the Blackfin processor family.
990 @end ifclear
992 @ifset man
993 @c man begin OPTIONS
994 The following options are available when @value{AS} is configured for
995 the Blackfin processor family.
996 @c man end
997 @c man begin INCLUDE
998 @include c-bfin.texi
999 @c ended inside the included file
1000 @end ifset
1002 @end ifset
1004 @c man begin OPTIONS
1005 @ifset CRIS
1006 See the info pages for documentation of the CRIS-specific options.
1007 @end ifset
1009 @ifset CSKY
1011 @ifclear man
1012 @xref{C-SKY Options}, for the options available when @value{AS} is
1013 configured for the C-SKY processor family.
1014 @end ifclear
1016 @ifset man
1017 @c man begin OPTIONS
1018 The following options are available when @value{AS} is configured for
1019 the C-SKY processor family.
1020 @c man end
1021 @c man begin INCLUDE
1022 @include c-csky.texi
1023 @c ended inside the included file
1024 @end ifset
1026 @end ifset
1028 @ifset D10V
1029 The following options are available when @value{AS} is configured for
1030 a D10V processor.
1031 @table @gcctabopt
1032 @cindex D10V optimization
1033 @cindex optimization, D10V
1034 @item -O
1035 Optimize output by parallelizing instructions.
1036 @end table
1037 @end ifset
1039 @ifset D30V
1040 The following options are available when @value{AS} is configured for a D30V
1041 processor.
1042 @table @gcctabopt
1043 @cindex D30V optimization
1044 @cindex optimization, D30V
1045 @item -O
1046 Optimize output by parallelizing instructions.
1048 @cindex D30V nops
1049 @item -n
1050 Warn when nops are generated.
1052 @cindex D30V nops after 32-bit multiply
1053 @item -N
1054 Warn when a nop after a 32-bit multiply instruction is generated.
1055 @end table
1056 @end ifset
1057 @c man end
1059 @ifset EPIPHANY
1060 The following options are available when @value{AS} is configured for the
1061 Adapteva EPIPHANY series.
1063 @ifclear man
1064 @xref{Epiphany Options}, for the options available when @value{AS} is
1065 configured for an Epiphany processor.
1066 @end ifclear
1068 @ifset man
1069 @c man begin OPTIONS
1070 The following options are available when @value{AS} is configured for
1071 an Epiphany processor.
1072 @c man end
1073 @c man begin INCLUDE
1074 @include c-epiphany.texi
1075 @c ended inside the included file
1076 @end ifset
1078 @end ifset
1080 @ifset H8300
1082 @ifclear man
1083 @xref{H8/300 Options}, for the options available when @value{AS} is configured
1084 for an H8/300 processor.
1085 @end ifclear
1087 @ifset man
1088 @c man begin OPTIONS
1089 The following options are available when @value{AS} is configured for an H8/300
1090 processor.
1091 @c man end
1092 @c man begin INCLUDE
1093 @include c-h8300.texi
1094 @c ended inside the included file
1095 @end ifset
1097 @end ifset
1099 @ifset I80386
1101 @ifclear man
1102 @xref{i386-Options}, for the options available when @value{AS} is
1103 configured for an i386 processor.
1104 @end ifclear
1106 @ifset man
1107 @c man begin OPTIONS
1108 The following options are available when @value{AS} is configured for
1109 an i386 processor.
1110 @c man end
1111 @c man begin INCLUDE
1112 @include c-i386.texi
1113 @c ended inside the included file
1114 @end ifset
1116 @end ifset
1118 @c man begin OPTIONS
1119 @ifset IP2K
1120 The following options are available when @value{AS} is configured for the
1121 Ubicom IP2K series.
1123 @table @gcctabopt
1125 @item -mip2022ext
1126 Specifies that the extended IP2022 instructions are allowed.
1128 @item -mip2022
1129 Restores the default behaviour, which restricts the permitted instructions to
1130 just the basic IP2022 ones.
1132 @end table
1133 @end ifset
1135 @ifset M32C
1136 The following options are available when @value{AS} is configured for the
1137 Renesas M32C and M16C processors.
1139 @table @gcctabopt
1141 @item -m32c
1142 Assemble M32C instructions.
1144 @item -m16c
1145 Assemble M16C instructions (the default).
1147 @item -relax
1148 Enable support for link-time relaxations.
1150 @item -h-tick-hex
1151 Support H'00 style hex constants in addition to 0x00 style.
1153 @end table
1154 @end ifset
1156 @ifset M32R
1157 The following options are available when @value{AS} is configured for the
1158 Renesas M32R (formerly Mitsubishi M32R) series.
1160 @table @gcctabopt
1162 @item --m32rx
1163 Specify which processor in the M32R family is the target.  The default
1164 is normally the M32R, but this option changes it to the M32RX.
1166 @item --warn-explicit-parallel-conflicts or --Wp
1167 Produce warning messages when questionable parallel constructs are
1168 encountered.
1170 @item --no-warn-explicit-parallel-conflicts or --Wnp
1171 Do not produce warning messages when questionable parallel constructs are
1172 encountered.
1174 @end table
1175 @end ifset
1177 @ifset M680X0
1178 The following options are available when @value{AS} is configured for the
1179 Motorola 68000 series.
1181 @table @gcctabopt
1183 @item -l
1184 Shorten references to undefined symbols, to one word instead of two.
1186 @item -m68000 | -m68008 | -m68010 | -m68020 | -m68030
1187 @itemx | -m68040 | -m68060 | -m68302 | -m68331 | -m68332
1188 @itemx | -m68333 | -m68340 | -mcpu32 | -m5200
1189 Specify what processor in the 68000 family is the target.  The default
1190 is normally the 68020, but this can be changed at configuration time.
1192 @item -m68881 | -m68882 | -mno-68881 | -mno-68882
1193 The target machine does (or does not) have a floating-point coprocessor.
1194 The default is to assume a coprocessor for 68020, 68030, and cpu32.  Although
1195 the basic 68000 is not compatible with the 68881, a combination of the
1196 two can be specified, since it's possible to do emulation of the
1197 coprocessor instructions with the main processor.
1199 @item -m68851 | -mno-68851
1200 The target machine does (or does not) have a memory-management
1201 unit coprocessor.  The default is to assume an MMU for 68020 and up.
1203 @end table
1204 @end ifset
1206 @ifset NIOSII
1208 @ifclear man
1209 @xref{Nios II Options}, for the options available when @value{AS} is configured
1210 for an Altera Nios II processor.
1211 @end ifclear
1213 @ifset man
1214 @c man begin OPTIONS
1215 The following options are available when @value{AS} is configured for an
1216 Altera Nios II processor.
1217 @c man end
1218 @c man begin INCLUDE
1219 @include c-nios2.texi
1220 @c ended inside the included file
1221 @end ifset
1222 @end ifset
1224 @ifset PDP11
1226 For details about the PDP-11 machine dependent features options,
1227 see @ref{PDP-11-Options}.
1229 @table @gcctabopt
1230 @item -mpic | -mno-pic
1231 Generate position-independent (or position-dependent) code.  The
1232 default is @option{-mpic}.
1234 @item -mall
1235 @itemx -mall-extensions
1236 Enable all instruction set extensions.  This is the default.
1238 @item -mno-extensions
1239 Disable all instruction set extensions.
1241 @item -m@var{extension} | -mno-@var{extension}
1242 Enable (or disable) a particular instruction set extension.
1244 @item -m@var{cpu}
1245 Enable the instruction set extensions supported by a particular CPU, and
1246 disable all other extensions.
1248 @item -m@var{machine}
1249 Enable the instruction set extensions supported by a particular machine
1250 model, and disable all other extensions.
1251 @end table
1253 @end ifset
1255 @ifset PJ
1256 The following options are available when @value{AS} is configured for
1257 a picoJava processor.
1259 @table @gcctabopt
1261 @cindex PJ endianness
1262 @cindex endianness, PJ
1263 @cindex big endian output, PJ
1264 @item -mb
1265 Generate ``big endian'' format output.
1267 @cindex little endian output, PJ
1268 @item -ml
1269 Generate ``little endian'' format output.
1271 @end table
1272 @end ifset
1274 @ifset PRU
1276 @ifclear man
1277 @xref{PRU Options}, for the options available when @value{AS} is configured
1278 for a PRU processor.
1279 @end ifclear
1281 @ifset man
1282 @c man begin OPTIONS
1283 The following options are available when @value{AS} is configured for a
1284 PRU processor.
1285 @c man end
1286 @c man begin INCLUDE
1287 @include c-pru.texi
1288 @c ended inside the included file
1289 @end ifset
1290 @end ifset
1292 @ifset M68HC11
1293 The following options are available when @value{AS} is configured for the
1294 Motorola 68HC11 or 68HC12 series.
1296 @table @gcctabopt
1298 @item -m68hc11 | -m68hc12 | -m68hcs12 | -mm9s12x | -mm9s12xg
1299 Specify what processor is the target.  The default is
1300 defined by the configuration option when building the assembler.
1302 @item --xgate-ramoffset
1303 Instruct the linker to offset RAM addresses from S12X address space into
1304 XGATE address space.
1306 @item -mshort
1307 Specify to use the 16-bit integer ABI.
1309 @item -mlong
1310 Specify to use the 32-bit integer ABI.
1312 @item -mshort-double
1313 Specify to use the 32-bit double ABI.
1315 @item -mlong-double
1316 Specify to use the 64-bit double ABI.
1318 @item --force-long-branches
1319 Relative branches are turned into absolute ones. This concerns
1320 conditional branches, unconditional branches and branches to a
1321 sub routine.
1323 @item -S | --short-branches
1324 Do not turn relative branches into absolute ones
1325 when the offset is out of range.
1327 @item --strict-direct-mode
1328 Do not turn the direct addressing mode into extended addressing mode
1329 when the instruction does not support direct addressing mode.
1331 @item --print-insn-syntax
1332 Print the syntax of instruction in case of error.
1334 @item --print-opcodes
1335 Print the list of instructions with syntax and then exit.
1337 @item --generate-example
1338 Print an example of instruction for each possible instruction and then exit.
1339 This option is only useful for testing @command{@value{AS}}.
1341 @end table
1342 @end ifset
1344 @ifset SPARC
1345 The following options are available when @command{@value{AS}} is configured
1346 for the SPARC architecture:
1348 @table @gcctabopt
1349 @item -Av6 | -Av7 | -Av8 | -Asparclet | -Asparclite
1350 @itemx -Av8plus | -Av8plusa | -Av9 | -Av9a
1351 Explicitly select a variant of the SPARC architecture.
1353 @samp{-Av8plus} and @samp{-Av8plusa} select a 32 bit environment.
1354 @samp{-Av9} and @samp{-Av9a} select a 64 bit environment.
1356 @samp{-Av8plusa} and @samp{-Av9a} enable the SPARC V9 instruction set with
1357 UltraSPARC extensions.
1359 @item -xarch=v8plus | -xarch=v8plusa
1360 For compatibility with the Solaris v9 assembler.  These options are
1361 equivalent to -Av8plus and -Av8plusa, respectively.
1363 @item -bump
1364 Warn when the assembler switches to another architecture.
1365 @end table
1366 @end ifset
1368 @ifset TIC54X
1369 The following options are available when @value{AS} is configured for the 'c54x
1370 architecture.
1372 @table @gcctabopt
1373 @item -mfar-mode
1374 Enable extended addressing mode.  All addresses and relocations will assume
1375 extended addressing (usually 23 bits).
1376 @item -mcpu=@var{CPU_VERSION}
1377 Sets the CPU version being compiled for.
1378 @item -merrors-to-file @var{FILENAME}
1379 Redirect error output to a file, for broken systems which don't support such
1380 behaviour in the shell.
1381 @end table
1382 @end ifset
1384 @ifset MIPS
1385 @c man begin OPTIONS
1386 The following options are available when @value{AS} is configured for
1387 a MIPS processor.
1389 @table @gcctabopt
1390 @item -G @var{num}
1391 This option sets the largest size of an object that can be referenced
1392 implicitly with the @code{gp} register.  It is only accepted for targets that
1393 use ECOFF format, such as a DECstation running Ultrix.  The default value is 8.
1395 @cindex MIPS endianness
1396 @cindex endianness, MIPS
1397 @cindex big endian output, MIPS
1398 @item -EB
1399 Generate ``big endian'' format output.
1401 @cindex little endian output, MIPS
1402 @item -EL
1403 Generate ``little endian'' format output.
1405 @cindex MIPS ISA
1406 @item -mips1
1407 @itemx -mips2
1408 @itemx -mips3
1409 @itemx -mips4
1410 @itemx -mips5
1411 @itemx -mips32
1412 @itemx -mips32r2
1413 @itemx -mips32r3
1414 @itemx -mips32r5
1415 @itemx -mips32r6
1416 @itemx -mips64
1417 @itemx -mips64r2
1418 @itemx -mips64r3
1419 @itemx -mips64r5
1420 @itemx -mips64r6
1421 Generate code for a particular MIPS Instruction Set Architecture level.
1422 @samp{-mips1} is an alias for @samp{-march=r3000}, @samp{-mips2} is an
1423 alias for @samp{-march=r6000}, @samp{-mips3} is an alias for
1424 @samp{-march=r4000} and @samp{-mips4} is an alias for @samp{-march=r8000}.
1425 @samp{-mips5}, @samp{-mips32}, @samp{-mips32r2}, @samp{-mips32r3},
1426 @samp{-mips32r5}, @samp{-mips32r6}, @samp{-mips64}, @samp{-mips64r2},
1427 @samp{-mips64r3}, @samp{-mips64r5}, and @samp{-mips64r6} correspond to generic
1428 MIPS V, MIPS32, MIPS32 Release 2, MIPS32 Release 3, MIPS32 Release 5, MIPS32
1429 Release 6, MIPS64, MIPS64 Release 2, MIPS64 Release 3, MIPS64 Release 5, and
1430 MIPS64 Release 6 ISA processors, respectively.
1432 @item -march=@var{cpu}
1433 Generate code for a particular MIPS CPU.
1435 @item -mtune=@var{cpu}
1436 Schedule and tune for a particular MIPS CPU.
1438 @item -mfix7000
1439 @itemx -mno-fix7000
1440 Cause nops to be inserted if the read of the destination register
1441 of an mfhi or mflo instruction occurs in the following two instructions.
1443 @item -mfix-rm7000
1444 @itemx -mno-fix-rm7000
1445 Cause nops to be inserted if a dmult or dmultu instruction is
1446 followed by a load instruction.
1448 @item -mfix-r5900
1449 @itemx -mno-fix-r5900
1450 Do not attempt to schedule the preceding instruction into the delay slot
1451 of a branch instruction placed at the end of a short loop of six
1452 instructions or fewer and always schedule a @code{nop} instruction there
1453 instead.  The short loop bug under certain conditions causes loops to
1454 execute only once or twice, due to a hardware bug in the R5900 chip.
1456 @item -mdebug
1457 @itemx -no-mdebug
1458 Cause stabs-style debugging output to go into an ECOFF-style .mdebug
1459 section instead of the standard ELF .stabs sections.
1461 @item -mpdr
1462 @itemx -mno-pdr
1463 Control generation of @code{.pdr} sections.
1465 @item -mgp32
1466 @itemx -mfp32
1467 The register sizes are normally inferred from the ISA and ABI, but these
1468 flags force a certain group of registers to be treated as 32 bits wide at
1469 all times.  @samp{-mgp32} controls the size of general-purpose registers
1470 and @samp{-mfp32} controls the size of floating-point registers.
1472 @item -mgp64
1473 @itemx -mfp64
1474 The register sizes are normally inferred from the ISA and ABI, but these
1475 flags force a certain group of registers to be treated as 64 bits wide at
1476 all times.  @samp{-mgp64} controls the size of general-purpose registers
1477 and @samp{-mfp64} controls the size of floating-point registers.
1479 @item -mfpxx
1480 The register sizes are normally inferred from the ISA and ABI, but using
1481 this flag in combination with @samp{-mabi=32} enables an ABI variant
1482 which will operate correctly with floating-point registers which are
1483 32 or 64 bits wide.
1485 @item -modd-spreg
1486 @itemx -mno-odd-spreg
1487 Enable use of floating-point operations on odd-numbered single-precision
1488 registers when supported by the ISA.  @samp{-mfpxx} implies
1489 @samp{-mno-odd-spreg}, otherwise the default is @samp{-modd-spreg}.
1491 @item -mips16
1492 @itemx -no-mips16
1493 Generate code for the MIPS 16 processor.  This is equivalent to putting
1494 @code{.module mips16} at the start of the assembly file.  @samp{-no-mips16}
1495 turns off this option.
1497 @item -mmips16e2
1498 @itemx -mno-mips16e2
1499 Enable the use of MIPS16e2 instructions in MIPS16 mode.  This is equivalent
1500 to putting @code{.module mips16e2} at the start of the assembly file.
1501 @samp{-mno-mips16e2} turns off this option.
1503 @item -mmicromips
1504 @itemx -mno-micromips
1505 Generate code for the microMIPS processor.  This is equivalent to putting
1506 @code{.module micromips} at the start of the assembly file.
1507 @samp{-mno-micromips} turns off this option.  This is equivalent to putting
1508 @code{.module nomicromips} at the start of the assembly file.
1510 @item -msmartmips
1511 @itemx -mno-smartmips
1512 Enables the SmartMIPS extension to the MIPS32 instruction set.  This is
1513 equivalent to putting @code{.module smartmips} at the start of the assembly
1514 file.  @samp{-mno-smartmips} turns off this option.
1516 @item -mips3d
1517 @itemx -no-mips3d
1518 Generate code for the MIPS-3D Application Specific Extension.
1519 This tells the assembler to accept MIPS-3D instructions.
1520 @samp{-no-mips3d} turns off this option.
1522 @item -mdmx
1523 @itemx -no-mdmx
1524 Generate code for the MDMX Application Specific Extension.
1525 This tells the assembler to accept MDMX instructions.
1526 @samp{-no-mdmx} turns off this option.
1528 @item -mdsp
1529 @itemx -mno-dsp
1530 Generate code for the DSP Release 1 Application Specific Extension.
1531 This tells the assembler to accept DSP Release 1 instructions.
1532 @samp{-mno-dsp} turns off this option.
1534 @item -mdspr2
1535 @itemx -mno-dspr2
1536 Generate code for the DSP Release 2 Application Specific Extension.
1537 This option implies @samp{-mdsp}.
1538 This tells the assembler to accept DSP Release 2 instructions.
1539 @samp{-mno-dspr2} turns off this option.
1541 @item -mdspr3
1542 @itemx -mno-dspr3
1543 Generate code for the DSP Release 3 Application Specific Extension.
1544 This option implies @samp{-mdsp} and @samp{-mdspr2}.
1545 This tells the assembler to accept DSP Release 3 instructions.
1546 @samp{-mno-dspr3} turns off this option.
1548 @item -mmsa
1549 @itemx -mno-msa
1550 Generate code for the MIPS SIMD Architecture Extension.
1551 This tells the assembler to accept MSA instructions.
1552 @samp{-mno-msa} turns off this option.
1554 @item -mxpa
1555 @itemx -mno-xpa
1556 Generate code for the MIPS eXtended Physical Address (XPA) Extension.
1557 This tells the assembler to accept XPA instructions.
1558 @samp{-mno-xpa} turns off this option.
1560 @item -mmt
1561 @itemx -mno-mt
1562 Generate code for the MT Application Specific Extension.
1563 This tells the assembler to accept MT instructions.
1564 @samp{-mno-mt} turns off this option.
1566 @item -mmcu
1567 @itemx -mno-mcu
1568 Generate code for the MCU Application Specific Extension.
1569 This tells the assembler to accept MCU instructions.
1570 @samp{-mno-mcu} turns off this option.
1572 @item -mcrc
1573 @itemx -mno-crc
1574 Generate code for the MIPS cyclic redundancy check (CRC) Application
1575 Specific Extension.  This tells the assembler to accept CRC instructions.
1576 @samp{-mno-crc} turns off this option.
1578 @item -mginv
1579 @itemx -mno-ginv
1580 Generate code for the Global INValidate (GINV) Application Specific
1581 Extension.  This tells the assembler to accept GINV instructions.
1582 @samp{-mno-ginv} turns off this option.
1584 @item -mloongson-mmi
1585 @itemx -mno-loongson-mmi
1586 Generate code for the Loongson MultiMedia extensions Instructions (MMI)
1587 Application Specific Extension.  This tells the assembler to accept MMI
1588 instructions.
1589 @samp{-mno-loongson-mmi} turns off this option.
1591 @item -mloongson-cam
1592 @itemx -mno-loongson-cam
1593 Generate code for the Loongson Content Address Memory (CAM) instructions.
1594 This tells the assembler to accept Loongson CAM instructions.
1595 @samp{-mno-loongson-cam} turns off this option.
1597 @item -mloongson-ext
1598 @itemx -mno-loongson-ext
1599 Generate code for the Loongson EXTensions (EXT) instructions.
1600 This tells the assembler to accept Loongson EXT instructions.
1601 @samp{-mno-loongson-ext} turns off this option.
1603 @item -mloongson-ext2
1604 @itemx -mno-loongson-ext2
1605 Generate code for the Loongson EXTensions R2 (EXT2) instructions.
1606 This option implies @samp{-mloongson-ext}.
1607 This tells the assembler to accept Loongson EXT2 instructions.
1608 @samp{-mno-loongson-ext2} turns off this option.
1610 @item -minsn32
1611 @itemx -mno-insn32
1612 Only use 32-bit instruction encodings when generating code for the
1613 microMIPS processor.  This option inhibits the use of any 16-bit
1614 instructions.  This is equivalent to putting @code{.set insn32} at
1615 the start of the assembly file.  @samp{-mno-insn32} turns off this
1616 option.  This is equivalent to putting @code{.set noinsn32} at the
1617 start of the assembly file.  By default @samp{-mno-insn32} is
1618 selected, allowing all instructions to be used.
1620 @item --construct-floats
1621 @itemx --no-construct-floats
1622 The @samp{--no-construct-floats} option disables the construction of
1623 double width floating point constants by loading the two halves of the
1624 value into the two single width floating point registers that make up
1625 the double width register.  By default @samp{--construct-floats} is
1626 selected, allowing construction of these floating point constants.
1628 @item --relax-branch
1629 @itemx --no-relax-branch
1630 The @samp{--relax-branch} option enables the relaxation of out-of-range
1631 branches.  By default @samp{--no-relax-branch} is selected, causing any
1632 out-of-range branches to produce an error.
1634 @item -mignore-branch-isa
1635 @itemx -mno-ignore-branch-isa
1636 Ignore branch checks for invalid transitions between ISA modes.  The
1637 semantics of branches does not provide for an ISA mode switch, so in
1638 most cases the ISA mode a branch has been encoded for has to be the
1639 same as the ISA mode of the branch's target label.  Therefore GAS has
1640 checks implemented that verify in branch assembly that the two ISA
1641 modes match.  @samp{-mignore-branch-isa} disables these checks.  By
1642 default @samp{-mno-ignore-branch-isa} is selected, causing any invalid
1643 branch requiring a transition between ISA modes to produce an error.
1645 @item -mnan=@var{encoding}
1646 Select between the IEEE 754-2008 (@option{-mnan=2008}) or the legacy
1647 (@option{-mnan=legacy}) NaN encoding format.  The latter is the default.
1649 @cindex emulation
1650 @item --emulation=@var{name}
1651 This option was formerly used to switch between ELF and ECOFF output
1652 on targets like IRIX 5 that supported both.  MIPS ECOFF support was
1653 removed in GAS 2.24, so the option now serves little purpose.
1654 It is retained for backwards compatibility.
1656 The available configuration names are: @samp{mipself}, @samp{mipslelf} and
1657 @samp{mipsbelf}.  Choosing @samp{mipself} now has no effect, since the output
1658 is always ELF.  @samp{mipslelf} and @samp{mipsbelf} select little- and
1659 big-endian output respectively, but @samp{-EL} and @samp{-EB} are now the
1660 preferred options instead.
1662 @item -nocpp
1663 @command{@value{AS}} ignores this option.  It is accepted for compatibility with
1664 the native tools.
1666 @item --trap
1667 @itemx --no-trap
1668 @itemx --break
1669 @itemx --no-break
1670 Control how to deal with multiplication overflow and division by zero.
1671 @samp{--trap} or @samp{--no-break} (which are synonyms) take a trap exception
1672 (and only work for Instruction Set Architecture level 2 and higher);
1673 @samp{--break} or @samp{--no-trap} (also synonyms, and the default) take a
1674 break exception.
1676 @item -n
1677 When this option is used, @command{@value{AS}} will issue a warning every
1678 time it generates a nop instruction from a macro.
1679 @end table
1680 @c man end
1681 @end ifset
1683 @ifset MCORE
1684 The following options are available when @value{AS} is configured for
1685 an MCore processor.
1687 @table @gcctabopt
1688 @item -jsri2bsr
1689 @itemx -nojsri2bsr
1690 Enable or disable the JSRI to BSR transformation.  By default this is enabled.
1691 The command-line option @samp{-nojsri2bsr} can be used to disable it.
1693 @item -sifilter
1694 @itemx -nosifilter
1695 Enable or disable the silicon filter behaviour.  By default this is disabled.
1696 The default can be overridden by the @samp{-sifilter} command-line option.
1698 @item -relax
1699 Alter jump instructions for long displacements.
1701 @item -mcpu=[210|340]
1702 Select the cpu type on the target hardware.  This controls which instructions
1703 can be assembled.
1705 @item -EB
1706 Assemble for a big endian target.
1708 @item -EL
1709 Assemble for a little endian target.
1711 @end table
1712 @end ifset
1713 @c man end
1715 @ifset METAG
1717 @ifclear man
1718 @xref{Meta Options}, for the options available when @value{AS} is configured
1719 for a Meta processor.
1720 @end ifclear
1722 @ifset man
1723 @c man begin OPTIONS
1724 The following options are available when @value{AS} is configured for a
1725 Meta processor.
1726 @c man end
1727 @c man begin INCLUDE
1728 @include c-metag.texi
1729 @c ended inside the included file
1730 @end ifset
1732 @end ifset
1734 @c man begin OPTIONS
1735 @ifset MMIX
1736 See the info pages for documentation of the MMIX-specific options.
1737 @end ifset
1739 @ifset NDS32
1741 @ifclear man
1742 @xref{NDS32 Options}, for the options available when @value{AS} is configured
1743 for a NDS32 processor.
1744 @end ifclear
1745 @c ended inside the included file
1746 @end ifset
1748 @ifset man
1749 @c man begin OPTIONS
1750 The following options are available when @value{AS} is configured for a
1751 NDS32 processor.
1752 @c man end
1753 @c man begin INCLUDE
1754 @include c-nds32.texi
1755 @c ended inside the included file
1756 @end ifset
1758 @c man end
1759 @ifset PPC
1761 @ifclear man
1762 @xref{PowerPC-Opts}, for the options available when @value{AS} is configured
1763 for a PowerPC processor.
1764 @end ifclear
1766 @ifset man
1767 @c man begin OPTIONS
1768 The following options are available when @value{AS} is configured for a
1769 PowerPC processor.
1770 @c man end
1771 @c man begin INCLUDE
1772 @include c-ppc.texi
1773 @c ended inside the included file
1774 @end ifset
1776 @end ifset
1778 @ifset RISCV
1780 @ifclear man
1781 @xref{RISC-V-Options}, for the options available when @value{AS} is configured
1782 for a RISC-V processor.
1783 @end ifclear
1785 @ifset man
1786 @c man begin OPTIONS
1787 The following options are available when @value{AS} is configured for a
1788 RISC-V processor.
1789 @c man end
1790 @c man begin INCLUDE
1791 @include c-riscv.texi
1792 @c ended inside the included file
1793 @end ifset
1795 @end ifset
1797 @c man begin OPTIONS
1798 @ifset RX
1799 See the info pages for documentation of the RX-specific options.
1800 @end ifset
1802 @ifset S390
1803 The following options are available when @value{AS} is configured for the s390
1804 processor family.
1806 @table @gcctabopt
1807 @item -m31
1808 @itemx -m64
1809 Select the word size, either 31/32 bits or 64 bits.
1810 @item -mesa
1811 @item -mzarch
1812 Select the architecture mode, either the Enterprise System
1813 Architecture (esa) or the z/Architecture mode (zarch).
1814 @item -march=@var{processor}
1815 Specify which s390 processor variant is the target, @samp{g5} (or
1816 @samp{arch3}), @samp{g6}, @samp{z900} (or @samp{arch5}), @samp{z990} (or
1817 @samp{arch6}), @samp{z9-109}, @samp{z9-ec} (or @samp{arch7}), @samp{z10} (or
1818 @samp{arch8}), @samp{z196} (or @samp{arch9}), @samp{zEC12} (or @samp{arch10}),
1819 @samp{z13} (or @samp{arch11}), or @samp{z14} (or @samp{arch12}).
1820 @item -mregnames
1821 @itemx -mno-regnames
1822 Allow or disallow symbolic names for registers.
1823 @item -mwarn-areg-zero
1824 Warn whenever the operand for a base or index register has been specified
1825 but evaluates to zero.
1826 @end table
1827 @end ifset
1828 @c man end
1830 @ifset TIC6X
1832 @ifclear man
1833 @xref{TIC6X Options}, for the options available when @value{AS} is configured
1834 for a TMS320C6000 processor.
1835 @end ifclear
1837 @ifset man
1838 @c man begin OPTIONS
1839 The following options are available when @value{AS} is configured for a
1840 TMS320C6000 processor.
1841 @c man end
1842 @c man begin INCLUDE
1843 @include c-tic6x.texi
1844 @c ended inside the included file
1845 @end ifset
1847 @end ifset
1849 @ifset TILEGX
1851 @ifclear man
1852 @xref{TILE-Gx Options}, for the options available when @value{AS} is configured
1853 for a TILE-Gx processor.
1854 @end ifclear
1856 @ifset man
1857 @c man begin OPTIONS
1858 The following options are available when @value{AS} is configured for a TILE-Gx
1859 processor.
1860 @c man end
1861 @c man begin INCLUDE
1862 @include c-tilegx.texi
1863 @c ended inside the included file
1864 @end ifset
1866 @end ifset
1868 @ifset VISIUM
1870 @ifclear man
1871 @xref{Visium Options}, for the options available when @value{AS} is configured
1872 for a Visium processor.
1873 @end ifclear
1875 @ifset man
1876 @c man begin OPTIONS
1877 The following option is available when @value{AS} is configured for a Visium
1878 processor.
1879 @c man end
1880 @c man begin INCLUDE
1881 @include c-visium.texi
1882 @c ended inside the included file
1883 @end ifset
1885 @end ifset
1887 @ifset XTENSA
1889 @ifclear man
1890 @xref{Xtensa Options}, for the options available when @value{AS} is configured
1891 for an Xtensa processor.
1892 @end ifclear
1894 @ifset man
1895 @c man begin OPTIONS
1896 The following options are available when @value{AS} is configured for an
1897 Xtensa processor.
1898 @c man end
1899 @c man begin INCLUDE
1900 @include c-xtensa.texi
1901 @c ended inside the included file
1902 @end ifset
1904 @end ifset
1906 @c man begin OPTIONS
1908 @ifset Z80
1909 The following options are available when @value{AS} is configured for
1910 a Z80 family processor.
1911 @table @gcctabopt
1912 @item -z80
1913 Assemble for Z80 processor.
1914 @item -r800
1915 Assemble for R800 processor.
1916 @item  -ignore-undocumented-instructions
1917 @itemx -Wnud
1918 Assemble undocumented Z80 instructions that also work on R800 without warning.
1919 @item  -ignore-unportable-instructions
1920 @itemx -Wnup
1921 Assemble all undocumented Z80 instructions without warning.
1922 @item  -warn-undocumented-instructions
1923 @itemx -Wud
1924 Issue a warning for undocumented Z80 instructions that also work on R800.
1925 @item  -warn-unportable-instructions
1926 @itemx -Wup
1927 Issue a warning for undocumented Z80 instructions that do not work on R800.
1928 @item  -forbid-undocumented-instructions
1929 @itemx -Fud
1930 Treat all undocumented instructions as errors.
1931 @item  -forbid-unportable-instructions
1932 @itemx -Fup
1933 Treat undocumented Z80 instructions that do not work on R800 as errors.
1934 @end table
1935 @end ifset
1937 @c man end
1939 @menu
1940 * Manual::                      Structure of this Manual
1941 * GNU Assembler::               The GNU Assembler
1942 * Object Formats::              Object File Formats
1943 * Command Line::                Command Line
1944 * Input Files::                 Input Files
1945 * Object::                      Output (Object) File
1946 * Errors::                      Error and Warning Messages
1947 @end menu
1949 @node Manual
1950 @section Structure of this Manual
1952 @cindex manual, structure and purpose
1953 This manual is intended to describe what you need to know to use
1954 @sc{gnu} @command{@value{AS}}.  We cover the syntax expected in source files, including
1955 notation for symbols, constants, and expressions; the directives that
1956 @command{@value{AS}} understands; and of course how to invoke @command{@value{AS}}.
1958 @ifclear GENERIC
1959 We also cover special features in the @value{TARGET}
1960 configuration of @command{@value{AS}}, including assembler directives.
1961 @end ifclear
1962 @ifset GENERIC
1963 This manual also describes some of the machine-dependent features of
1964 various flavors of the assembler.
1965 @end ifset
1967 @cindex machine instructions (not covered)
1968 On the other hand, this manual is @emph{not} intended as an introduction
1969 to programming in assembly language---let alone programming in general!
1970 In a similar vein, we make no attempt to introduce the machine
1971 architecture; we do @emph{not} describe the instruction set, standard
1972 mnemonics, registers or addressing modes that are standard to a
1973 particular architecture.
1974 @ifset GENERIC
1975 You may want to consult the manufacturer's
1976 machine architecture manual for this information.
1977 @end ifset
1978 @ifclear GENERIC
1979 @ifset H8/300
1980 For information on the H8/300 machine instruction set, see @cite{H8/300
1981 Series Programming Manual}.  For the H8/300H, see @cite{H8/300H Series
1982 Programming Manual} (Renesas).
1983 @end ifset
1984 @ifset SH
1985 For information on the Renesas (formerly Hitachi) / SuperH SH machine instruction set,
1986 see @cite{SH-Microcomputer User's Manual} (Renesas) or
1987 @cite{SH-4 32-bit CPU Core Architecture} (SuperH) and
1988 @cite{SuperH (SH) 64-Bit RISC Series} (SuperH).
1989 @end ifset
1990 @ifset Z8000
1991 For information on the Z8000 machine instruction set, see @cite{Z8000 CPU Technical Manual}
1992 @end ifset
1993 @end ifclear
1995 @c I think this is premature---doc@cygnus.com, 17jan1991
1996 @ignore
1997 Throughout this manual, we assume that you are running @dfn{GNU},
1998 the portable operating system from the @dfn{Free Software
1999 Foundation, Inc.}.  This restricts our attention to certain kinds of
2000 computer (in particular, the kinds of computers that @sc{gnu} can run on);
2001 once this assumption is granted examples and definitions need less
2002 qualification.
2004 @command{@value{AS}} is part of a team of programs that turn a high-level
2005 human-readable series of instructions into a low-level
2006 computer-readable series of instructions.  Different versions of
2007 @command{@value{AS}} are used for different kinds of computer.
2008 @end ignore
2010 @c There used to be a section "Terminology" here, which defined
2011 @c "contents", "byte", "word", and "long".  Defining "word" to any
2012 @c particular size is confusing when the .word directive may generate 16
2013 @c bits on one machine and 32 bits on another; in general, for the user
2014 @c version of this manual, none of these terms seem essential to define.
2015 @c They were used very little even in the former draft of the manual;
2016 @c this draft makes an effort to avoid them (except in names of
2017 @c directives).
2019 @node GNU Assembler
2020 @section The GNU Assembler
2022 @c man begin DESCRIPTION
2024 @sc{gnu} @command{as} is really a family of assemblers.
2025 @ifclear GENERIC
2026 This manual describes @command{@value{AS}}, a member of that family which is
2027 configured for the @value{TARGET} architectures.
2028 @end ifclear
2029 If you use (or have used) the @sc{gnu} assembler on one architecture, you
2030 should find a fairly similar environment when you use it on another
2031 architecture.  Each version has much in common with the others,
2032 including object file formats, most assembler directives (often called
2033 @dfn{pseudo-ops}) and assembler syntax.@refill
2035 @cindex purpose of @sc{gnu} assembler
2036 @command{@value{AS}} is primarily intended to assemble the output of the
2037 @sc{gnu} C compiler @code{@value{GCC}} for use by the linker
2038 @code{@value{LD}}.  Nevertheless, we've tried to make @command{@value{AS}}
2039 assemble correctly everything that other assemblers for the same
2040 machine would assemble.
2041 @ifset VAX
2042 Any exceptions are documented explicitly (@pxref{Machine Dependencies}).
2043 @end ifset
2044 @ifset M680X0
2045 @c This remark should appear in generic version of manual; assumption
2046 @c here is that generic version sets M680x0.
2047 This doesn't mean @command{@value{AS}} always uses the same syntax as another
2048 assembler for the same architecture; for example, we know of several
2049 incompatible versions of 680x0 assembly language syntax.
2050 @end ifset
2052 @c man end
2054 Unlike older assemblers, @command{@value{AS}} is designed to assemble a source
2055 program in one pass of the source file.  This has a subtle impact on the
2056 @kbd{.org} directive (@pxref{Org,,@code{.org}}).
2058 @node Object Formats
2059 @section Object File Formats
2061 @cindex object file format
2062 The @sc{gnu} assembler can be configured to produce several alternative
2063 object file formats.  For the most part, this does not affect how you
2064 write assembly language programs; but directives for debugging symbols
2065 are typically different in different file formats.  @xref{Symbol
2066 Attributes,,Symbol Attributes}.
2067 @ifclear GENERIC
2068 @ifclear MULTI-OBJ
2069 For the @value{TARGET} target, @command{@value{AS}} is configured to produce
2070 @value{OBJ-NAME} format object files.
2071 @end ifclear
2072 @c The following should exhaust all configs that set MULTI-OBJ, ideally
2073 @ifset HPPA
2074 On the @value{TARGET}, @command{@value{AS}} can be configured to produce either
2075 SOM or ELF format object files.
2076 @end ifset
2077 @end ifclear
2079 @node Command Line
2080 @section Command Line
2082 @cindex command line conventions
2084 After the program name @command{@value{AS}}, the command line may contain
2085 options and file names.  Options may appear in any order, and may be
2086 before, after, or between file names.  The order of file names is
2087 significant.
2089 @cindex standard input, as input file
2090 @kindex --
2091 @file{--} (two hyphens) by itself names the standard input file
2092 explicitly, as one of the files for @command{@value{AS}} to assemble.
2094 @cindex options, command line
2095 Except for @samp{--} any command-line argument that begins with a
2096 hyphen (@samp{-}) is an option.  Each option changes the behavior of
2097 @command{@value{AS}}.  No option changes the way another option works.  An
2098 option is a @samp{-} followed by one or more letters; the case of
2099 the letter is important.   All options are optional.
2101 Some options expect exactly one file name to follow them.  The file
2102 name may either immediately follow the option's letter (compatible
2103 with older assemblers) or it may be the next command argument (@sc{gnu}
2104 standard).  These two command lines are equivalent:
2106 @smallexample
2107 @value{AS} -o my-object-file.o mumble.s
2108 @value{AS} -omy-object-file.o mumble.s
2109 @end smallexample
2111 @node Input Files
2112 @section Input Files
2114 @cindex input
2115 @cindex source program
2116 @cindex files, input
2117 We use the phrase @dfn{source program}, abbreviated @dfn{source}, to
2118 describe the program input to one run of @command{@value{AS}}.  The program may
2119 be in one or more files; how the source is partitioned into files
2120 doesn't change the meaning of the source.
2122 @c I added "con" prefix to "catenation" just to prove I can overcome my
2123 @c APL training...   doc@cygnus.com
2124 The source program is a concatenation of the text in all the files, in the
2125 order specified.
2127 @c man begin DESCRIPTION
2128 Each time you run @command{@value{AS}} it assembles exactly one source
2129 program.  The source program is made up of one or more files.
2130 (The standard input is also a file.)
2132 You give @command{@value{AS}} a command line that has zero or more input file
2133 names.  The input files are read (from left file name to right).  A
2134 command-line argument (in any position) that has no special meaning
2135 is taken to be an input file name.
2137 If you give @command{@value{AS}} no file names it attempts to read one input file
2138 from the @command{@value{AS}} standard input, which is normally your terminal.  You
2139 may have to type @key{ctl-D} to tell @command{@value{AS}} there is no more program
2140 to assemble.
2142 Use @samp{--} if you need to explicitly name the standard input file
2143 in your command line.
2145 If the source is empty, @command{@value{AS}} produces a small, empty object
2146 file.
2148 @c man end
2150 @subheading Filenames and Line-numbers
2152 @cindex input file linenumbers
2153 @cindex line numbers, in input files
2154 There are two ways of locating a line in the input file (or files) and
2155 either may be used in reporting error messages.  One way refers to a line
2156 number in a physical file; the other refers to a line number in a
2157 ``logical'' file.  @xref{Errors, ,Error and Warning Messages}.
2159 @dfn{Physical files} are those files named in the command line given
2160 to @command{@value{AS}}.
2162 @dfn{Logical files} are simply names declared explicitly by assembler
2163 directives; they bear no relation to physical files.  Logical file names help
2164 error messages reflect the original source file, when @command{@value{AS}} source
2165 is itself synthesized from other files.  @command{@value{AS}} understands the
2166 @samp{#} directives emitted by the @code{@value{GCC}} preprocessor.  See also
2167 @ref{File,,@code{.file}}.
2169 @node Object
2170 @section Output (Object) File
2172 @cindex object file
2173 @cindex output file
2174 @kindex a.out
2175 @kindex .o
2176 Every time you run @command{@value{AS}} it produces an output file, which is
2177 your assembly language program translated into numbers.  This file
2178 is the object file.  Its default name is @code{a.out}.
2179 You can give it another name by using the @option{-o} option.  Conventionally,
2180 object file names end with @file{.o}.  The default name is used for historical
2181 reasons: older assemblers were capable of assembling self-contained programs
2182 directly into a runnable program.  (For some formats, this isn't currently
2183 possible, but it can be done for the @code{a.out} format.)
2185 @cindex linker
2186 @kindex ld
2187 The object file is meant for input to the linker @code{@value{LD}}.  It contains
2188 assembled program code, information to help @code{@value{LD}} integrate
2189 the assembled program into a runnable file, and (optionally) symbolic
2190 information for the debugger.
2192 @c link above to some info file(s) like the description of a.out.
2193 @c don't forget to describe @sc{gnu} info as well as Unix lossage.
2195 @node Errors
2196 @section Error and Warning Messages
2198 @c man begin DESCRIPTION
2200 @cindex error messages
2201 @cindex warning messages
2202 @cindex messages from assembler
2203 @command{@value{AS}} may write warnings and error messages to the standard error
2204 file (usually your terminal).  This should not happen when  a compiler
2205 runs @command{@value{AS}} automatically.  Warnings report an assumption made so
2206 that @command{@value{AS}} could keep assembling a flawed program; errors report a
2207 grave problem that stops the assembly.
2209 @c man end
2211 @cindex format of warning messages
2212 Warning messages have the format
2214 @smallexample
2215 file_name:@b{NNN}:Warning Message Text
2216 @end smallexample
2218 @noindent
2219 @cindex file names and line numbers, in warnings/errors
2220 (where @b{NNN} is a line number).  If both a logical file name
2221 (@pxref{File,,@code{.file}}) and a logical line number
2222 @ifset GENERIC
2223 (@pxref{Line,,@code{.line}})
2224 @end ifset
2225 have been given then they will be used, otherwise the file name and line number
2226 in the current assembler source file will be used.  The message text is
2227 intended to be self explanatory (in the grand Unix tradition).
2229 Note the file name must be set via the logical version of the @code{.file}
2230 directive, not the DWARF2 version of the @code{.file} directive.  For example:
2232 @smallexample
2233   .file 2 "bar.c"
2234      error_assembler_source
2235   .file "foo.c"
2236   .line 30
2237       error_c_source
2238 @end smallexample
2240 produces this output:
2242 @smallexample
2243   Assembler messages:
2244   asm.s:2: Error: no such instruction: `error_assembler_source'
2245   foo.c:31: Error: no such instruction: `error_c_source'
2246 @end smallexample
2248 @cindex format of error messages
2249 Error messages have the format
2251 @smallexample
2252 file_name:@b{NNN}:FATAL:Error Message Text
2253 @end smallexample
2255 The file name and line number are derived as for warning
2256 messages.  The actual message text may be rather less explanatory
2257 because many of them aren't supposed to happen.
2259 @node Invoking
2260 @chapter Command-Line Options
2262 @cindex options, all versions of assembler
2263 This chapter describes command-line options available in @emph{all}
2264 versions of the @sc{gnu} assembler; see @ref{Machine Dependencies},
2265 for options specific
2266 @ifclear GENERIC
2267 to the @value{TARGET} target.
2268 @end ifclear
2269 @ifset GENERIC
2270 to particular machine architectures.
2271 @end ifset
2273 @c man begin DESCRIPTION
2275 If you are invoking @command{@value{AS}} via the @sc{gnu} C compiler,
2276 you can use the @samp{-Wa} option to pass arguments through to the assembler.
2277 The assembler arguments must be separated from each other (and the @samp{-Wa})
2278 by commas.  For example:
2280 @smallexample
2281 gcc -c -g -O -Wa,-alh,-L file.c
2282 @end smallexample
2284 @noindent
2285 This passes two options to the assembler: @samp{-alh} (emit a listing to
2286 standard output with high-level and assembly source) and @samp{-L} (retain
2287 local symbols in the symbol table).
2289 Usually you do not need to use this @samp{-Wa} mechanism, since many compiler
2290 command-line options are automatically passed to the assembler by the compiler.
2291 (You can call the @sc{gnu} compiler driver with the @samp{-v} option to see
2292 precisely what options it passes to each compilation pass, including the
2293 assembler.)
2295 @c man end
2297 @menu
2298 * a::             -a[cdghlns] enable listings
2299 * alternate::     --alternate enable alternate macro syntax
2300 * D::             -D for compatibility
2301 * f::             -f to work faster
2302 * I::             -I for .include search path
2303 @ifclear DIFF-TBL-KLUGE
2304 * K::             -K for compatibility
2305 @end ifclear
2306 @ifset DIFF-TBL-KLUGE
2307 * K::             -K for difference tables
2308 @end ifset
2310 * L::             -L to retain local symbols
2311 * listing::       --listing-XXX to configure listing output
2312 * M::             -M or --mri to assemble in MRI compatibility mode
2313 * MD::            --MD for dependency tracking
2314 * no-pad-sections:: --no-pad-sections to stop section padding
2315 * o::             -o to name the object file
2316 * R::             -R to join data and text sections
2317 * statistics::    --statistics to see statistics about assembly
2318 * traditional-format:: --traditional-format for compatible output
2319 * v::             -v to announce version
2320 * W::             -W, --no-warn, --warn, --fatal-warnings to control warnings
2321 * Z::             -Z to make object file even after errors
2322 @end menu
2324 @node a
2325 @section Enable Listings: @option{-a[cdghlns]}
2327 @kindex -a
2328 @kindex -ac
2329 @kindex -ad
2330 @kindex -ag
2331 @kindex -ah
2332 @kindex -al
2333 @kindex -an
2334 @kindex -as
2335 @cindex listings, enabling
2336 @cindex assembly listings, enabling
2338 These options enable listing output from the assembler.  By itself,
2339 @samp{-a} requests high-level, assembly, and symbols listing.
2340 You can use other letters to select specific options for the list:
2341 @samp{-ah} requests a high-level language listing,
2342 @samp{-al} requests an output-program assembly listing, and
2343 @samp{-as} requests a symbol table listing.
2344 High-level listings require that a compiler debugging option like
2345 @samp{-g} be used, and that assembly listings (@samp{-al}) be requested
2346 also.
2348 Use the @samp{-ag} option to print a first section with general assembly
2349 information, like @value{AS} version, switches passed, or time stamp.
2351 Use the @samp{-ac} option to omit false conditionals from a listing.  Any lines
2352 which are not assembled because of a false @code{.if} (or @code{.ifdef}, or any
2353 other conditional), or a true @code{.if} followed by an @code{.else}, will be
2354 omitted from the listing.
2356 Use the @samp{-ad} option to omit debugging directives from the
2357 listing.
2359 Once you have specified one of these options, you can further control
2360 listing output and its appearance using the directives @code{.list},
2361 @code{.nolist}, @code{.psize}, @code{.eject}, @code{.title}, and
2362 @code{.sbttl}.
2363 The @samp{-an} option turns off all forms processing.
2364 If you do not request listing output with one of the @samp{-a} options, the
2365 listing-control directives have no effect.
2367 The letters after @samp{-a} may be combined into one option,
2368 @emph{e.g.}, @samp{-aln}.
2370 Note if the assembler source is coming from the standard input (e.g.,
2371 because it
2372 is being created by @code{@value{GCC}} and the @samp{-pipe} command-line switch
2373 is being used) then the listing will not contain any comments or preprocessor
2374 directives.  This is because the listing code buffers input source lines from
2375 stdin only after they have been preprocessed by the assembler.  This reduces
2376 memory usage and makes the code more efficient.
2378 @node alternate
2379 @section @option{--alternate}
2381 @kindex --alternate
2382 Begin in alternate macro mode, see @ref{Altmacro,,@code{.altmacro}}.
2384 @node D
2385 @section @option{-D}
2387 @kindex -D
2388 This option has no effect whatsoever, but it is accepted to make it more
2389 likely that scripts written for other assemblers also work with
2390 @command{@value{AS}}.
2392 @node f
2393 @section Work Faster: @option{-f}
2395 @kindex -f
2396 @cindex trusted compiler
2397 @cindex faster processing (@option{-f})
2398 @samp{-f} should only be used when assembling programs written by a
2399 (trusted) compiler.  @samp{-f} stops the assembler from doing whitespace
2400 and comment preprocessing on
2401 the input file(s) before assembling them.  @xref{Preprocessing,
2402 ,Preprocessing}.
2404 @quotation
2405 @emph{Warning:} if you use @samp{-f} when the files actually need to be
2406 preprocessed (if they contain comments, for example), @command{@value{AS}} does
2407 not work correctly.
2408 @end quotation
2410 @node I
2411 @section @code{.include} Search Path: @option{-I} @var{path}
2413 @kindex -I @var{path}
2414 @cindex paths for @code{.include}
2415 @cindex search path for @code{.include}
2416 @cindex @code{include} directive search path
2417 Use this option to add a @var{path} to the list of directories
2418 @command{@value{AS}} searches for files specified in @code{.include}
2419 directives (@pxref{Include,,@code{.include}}).  You may use @option{-I} as
2420 many times as necessary to include a variety of paths.  The current
2421 working directory is always searched first; after that, @command{@value{AS}}
2422 searches any @samp{-I} directories in the same order as they were
2423 specified (left to right) on the command line.
2425 @node K
2426 @section Difference Tables: @option{-K}
2428 @kindex -K
2429 @ifclear DIFF-TBL-KLUGE
2430 On the @value{TARGET} family, this option is allowed, but has no effect.  It is
2431 permitted for compatibility with the @sc{gnu} assembler on other platforms,
2432 where it can be used to warn when the assembler alters the machine code
2433 generated for @samp{.word} directives in difference tables.  The @value{TARGET}
2434 family does not have the addressing limitations that sometimes lead to this
2435 alteration on other platforms.
2436 @end ifclear
2438 @ifset DIFF-TBL-KLUGE
2439 @cindex difference tables, warning
2440 @cindex warning for altered difference tables
2441 @command{@value{AS}} sometimes alters the code emitted for directives of the
2442 form @samp{.word @var{sym1}-@var{sym2}}.  @xref{Word,,@code{.word}}.
2443 You can use the @samp{-K} option if you want a warning issued when this
2444 is done.
2445 @end ifset
2447 @node L
2448 @section Include Local Symbols: @option{-L}
2450 @kindex -L
2451 @cindex local symbols, retaining in output
2452 Symbols beginning with system-specific local label prefixes, typically
2453 @samp{.L} for ELF systems or @samp{L} for traditional a.out systems, are
2454 called @dfn{local symbols}.  @xref{Symbol Names}.  Normally you do not see
2455 such symbols when debugging, because they are intended for the use of
2456 programs (like compilers) that compose assembler programs, not for your
2457 notice.  Normally both @command{@value{AS}} and @code{@value{LD}} discard
2458 such symbols, so you do not normally debug with them.
2460 This option tells @command{@value{AS}} to retain those local symbols
2461 in the object file.  Usually if you do this you also tell the linker
2462 @code{@value{LD}} to preserve those symbols.
2464 @node listing
2465 @section Configuring listing output: @option{--listing}
2467 The listing feature of the assembler can be enabled via the command-line switch
2468 @samp{-a} (@pxref{a}).  This feature combines the input source file(s) with a
2469 hex dump of the corresponding locations in the output object file, and displays
2470 them as a listing file.  The format of this listing can be controlled by
2471 directives inside the assembler source (i.e., @code{.list} (@pxref{List}),
2472 @code{.title} (@pxref{Title}), @code{.sbttl} (@pxref{Sbttl}),
2473 @code{.psize} (@pxref{Psize}), and
2474 @code{.eject} (@pxref{Eject}) and also by the following switches:
2476 @table @gcctabopt
2477 @item --listing-lhs-width=@samp{number}
2478 @kindex --listing-lhs-width
2479 @cindex Width of first line disassembly output
2480 Sets the maximum width, in words, of the first line of the hex byte dump.  This
2481 dump appears on the left hand side of the listing output.
2483 @item --listing-lhs-width2=@samp{number}
2484 @kindex --listing-lhs-width2
2485 @cindex Width of continuation lines of disassembly output
2486 Sets the maximum width, in words, of any further lines of the hex byte dump for
2487 a given input source line.  If this value is not specified, it defaults to being
2488 the same as the value specified for @samp{--listing-lhs-width}.  If neither
2489 switch is used the default is to one.
2491 @item --listing-rhs-width=@samp{number}
2492 @kindex --listing-rhs-width
2493 @cindex Width of source line output
2494 Sets the maximum width, in characters, of the source line that is displayed
2495 alongside the hex dump.  The default value for this parameter is 100.  The
2496 source line is displayed on the right hand side of the listing output.
2498 @item --listing-cont-lines=@samp{number}
2499 @kindex --listing-cont-lines
2500 @cindex Maximum number of continuation lines
2501 Sets the maximum number of continuation lines of hex dump that will be
2502 displayed for a given single line of source input.  The default value is 4.
2503 @end table
2505 @node M
2506 @section Assemble in MRI Compatibility Mode: @option{-M}
2508 @kindex -M
2509 @cindex MRI compatibility mode
2510 The @option{-M} or @option{--mri} option selects MRI compatibility mode.  This
2511 changes the syntax and pseudo-op handling of @command{@value{AS}} to make it
2512 compatible with the @code{ASM68K} assembler from Microtec Research.
2513 The exact nature of the
2514 MRI syntax will not be documented here; see the MRI manuals for more
2515 information.  Note in particular that the handling of macros and macro
2516 arguments is somewhat different.  The purpose of this option is to permit
2517 assembling existing MRI assembler code using @command{@value{AS}}.
2519 The MRI compatibility is not complete.  Certain operations of the MRI assembler
2520 depend upon its object file format, and can not be supported using other object
2521 file formats.  Supporting these would require enhancing each object file format
2522 individually.  These are:
2524 @itemize @bullet
2525 @item global symbols in common section
2527 The m68k MRI assembler supports common sections which are merged by the linker.
2528 Other object file formats do not support this.  @command{@value{AS}} handles
2529 common sections by treating them as a single common symbol.  It permits local
2530 symbols to be defined within a common section, but it can not support global
2531 symbols, since it has no way to describe them.
2533 @item complex relocations
2535 The MRI assemblers support relocations against a negated section address, and
2536 relocations which combine the start addresses of two or more sections.  These
2537 are not support by other object file formats.
2539 @item @code{END} pseudo-op specifying start address
2541 The MRI @code{END} pseudo-op permits the specification of a start address.
2542 This is not supported by other object file formats.  The start address may
2543 instead be specified using the @option{-e} option to the linker, or in a linker
2544 script.
2546 @item @code{IDNT}, @code{.ident} and @code{NAME} pseudo-ops
2548 The MRI @code{IDNT}, @code{.ident} and @code{NAME} pseudo-ops assign a module
2549 name to the output file.  This is not supported by other object file formats.
2551 @item @code{ORG} pseudo-op
2553 The m68k MRI @code{ORG} pseudo-op begins an absolute section at a given
2554 address.  This differs from the usual @command{@value{AS}} @code{.org} pseudo-op,
2555 which changes the location within the current section.  Absolute sections are
2556 not supported by other object file formats.  The address of a section may be
2557 assigned within a linker script.
2558 @end itemize
2560 There are some other features of the MRI assembler which are not supported by
2561 @command{@value{AS}}, typically either because they are difficult or because they
2562 seem of little consequence.  Some of these may be supported in future releases.
2564 @itemize @bullet
2566 @item EBCDIC strings
2568 EBCDIC strings are not supported.
2570 @item packed binary coded decimal
2572 Packed binary coded decimal is not supported.  This means that the @code{DC.P}
2573 and @code{DCB.P} pseudo-ops are not supported.
2575 @item @code{FEQU} pseudo-op
2577 The m68k @code{FEQU} pseudo-op is not supported.
2579 @item @code{NOOBJ} pseudo-op
2581 The m68k @code{NOOBJ} pseudo-op is not supported.
2583 @item @code{OPT} branch control options
2585 The m68k @code{OPT} branch control options---@code{B}, @code{BRS}, @code{BRB},
2586 @code{BRL}, and @code{BRW}---are ignored.  @command{@value{AS}} automatically
2587 relaxes all branches, whether forward or backward, to an appropriate size, so
2588 these options serve no purpose.
2590 @item @code{OPT} list control options
2592 The following m68k @code{OPT} list control options are ignored: @code{C},
2593 @code{CEX}, @code{CL}, @code{CRE}, @code{E}, @code{G}, @code{I}, @code{M},
2594 @code{MEX}, @code{MC}, @code{MD}, @code{X}.
2596 @item other @code{OPT} options
2598 The following m68k @code{OPT} options are ignored: @code{NEST}, @code{O},
2599 @code{OLD}, @code{OP}, @code{P}, @code{PCO}, @code{PCR}, @code{PCS}, @code{R}.
2601 @item @code{OPT} @code{D} option is default
2603 The m68k @code{OPT} @code{D} option is the default, unlike the MRI assembler.
2604 @code{OPT NOD} may be used to turn it off.
2606 @item @code{XREF} pseudo-op.
2608 The m68k @code{XREF} pseudo-op is ignored.
2610 @end itemize
2612 @node MD
2613 @section Dependency Tracking: @option{--MD}
2615 @kindex --MD
2616 @cindex dependency tracking
2617 @cindex make rules
2619 @command{@value{AS}} can generate a dependency file for the file it creates.  This
2620 file consists of a single rule suitable for @code{make} describing the
2621 dependencies of the main source file.
2623 The rule is written to the file named in its argument.
2625 This feature is used in the automatic updating of makefiles.
2627 @node no-pad-sections
2628 @section Output Section Padding
2629 @kindex --no-pad-sections
2630 @cindex output section padding
2631 Normally the assembler will pad the end of each output section up to its
2632 alignment boundary.  But this can waste space, which can be significant on
2633 memory constrained targets.  So the @option{--no-pad-sections} option will
2634 disable this behaviour.
2636 @node o
2637 @section Name the Object File: @option{-o}
2639 @kindex -o
2640 @cindex naming object file
2641 @cindex object file name
2642 There is always one object file output when you run @command{@value{AS}}.  By
2643 default it has the name @file{a.out}.
2644 You use this option (which takes exactly one filename) to give the
2645 object file a different name.
2647 Whatever the object file is called, @command{@value{AS}} overwrites any
2648 existing file of the same name.
2650 @node R
2651 @section Join Data and Text Sections: @option{-R}
2653 @kindex -R
2654 @cindex data and text sections, joining
2655 @cindex text and data sections, joining
2656 @cindex joining text and data sections
2657 @cindex merging text and data sections
2658 @option{-R} tells @command{@value{AS}} to write the object file as if all
2659 data-section data lives in the text section.  This is only done at
2660 the very last moment:  your binary data are the same, but data
2661 section parts are relocated differently.  The data section part of
2662 your object file is zero bytes long because all its bytes are
2663 appended to the text section.  (@xref{Sections,,Sections and Relocation}.)
2665 When you specify @option{-R} it would be possible to generate shorter
2666 address displacements (because we do not have to cross between text and
2667 data section).  We refrain from doing this simply for compatibility with
2668 older versions of @command{@value{AS}}.  In future, @option{-R} may work this way.
2670 @ifset COFF-ELF
2671 When @command{@value{AS}} is configured for COFF or ELF output,
2672 this option is only useful if you use sections named @samp{.text} and
2673 @samp{.data}.
2674 @end ifset
2676 @ifset HPPA
2677 @option{-R} is not supported for any of the HPPA targets.  Using
2678 @option{-R} generates a warning from @command{@value{AS}}.
2679 @end ifset
2681 @node statistics
2682 @section Display Assembly Statistics: @option{--statistics}
2684 @kindex --statistics
2685 @cindex statistics, about assembly
2686 @cindex time, total for assembly
2687 @cindex space used, maximum for assembly
2688 Use @samp{--statistics} to display two statistics about the resources used by
2689 @command{@value{AS}}: the maximum amount of space allocated during the assembly
2690 (in bytes), and the total execution time taken for the assembly (in @sc{cpu}
2691 seconds).
2693 @node traditional-format
2694 @section Compatible Output: @option{--traditional-format}
2696 @kindex --traditional-format
2697 For some targets, the output of @command{@value{AS}} is different in some ways
2698 from the output of some existing assembler.  This switch requests
2699 @command{@value{AS}} to use the traditional format instead.
2701 For example, it disables the exception frame optimizations which
2702 @command{@value{AS}} normally does by default on @code{@value{GCC}} output.
2704 @node v
2705 @section Announce Version: @option{-v}
2707 @kindex -v
2708 @kindex -version
2709 @cindex assembler version
2710 @cindex version of assembler
2711 You can find out what version of as is running by including the
2712 option @samp{-v} (which you can also spell as @samp{-version}) on the
2713 command line.
2715 @node W
2716 @section Control Warnings: @option{-W}, @option{--warn}, @option{--no-warn}, @option{--fatal-warnings}
2718 @command{@value{AS}} should never give a warning or error message when
2719 assembling compiler output.  But programs written by people often
2720 cause @command{@value{AS}} to give a warning that a particular assumption was
2721 made.  All such warnings are directed to the standard error file.
2723 @kindex -W
2724 @kindex --no-warn
2725 @cindex suppressing warnings
2726 @cindex warnings, suppressing
2727 If you use the @option{-W} and @option{--no-warn} options, no warnings are issued.
2728 This only affects the warning messages: it does not change any particular of
2729 how @command{@value{AS}} assembles your file.  Errors, which stop the assembly,
2730 are still reported.
2732 @kindex --fatal-warnings
2733 @cindex errors, caused by warnings
2734 @cindex warnings, causing error
2735 If you use the @option{--fatal-warnings} option, @command{@value{AS}} considers
2736 files that generate warnings to be in error.
2738 @kindex --warn
2739 @cindex warnings, switching on
2740 You can switch these options off again by specifying @option{--warn}, which
2741 causes warnings to be output as usual.
2743 @node Z
2744 @section Generate Object File in Spite of Errors: @option{-Z}
2745 @cindex object file, after errors
2746 @cindex errors, continuing after
2747 After an error message, @command{@value{AS}} normally produces no output.  If for
2748 some reason you are interested in object file output even after
2749 @command{@value{AS}} gives an error message on your program, use the @samp{-Z}
2750 option.  If there are any errors, @command{@value{AS}} continues anyways, and
2751 writes an object file after a final warning message of the form @samp{@var{n}
2752 errors, @var{m} warnings, generating bad object file.}
2754 @node Syntax
2755 @chapter Syntax
2757 @cindex machine-independent syntax
2758 @cindex syntax, machine-independent
2759 This chapter describes the machine-independent syntax allowed in a
2760 source file.  @command{@value{AS}} syntax is similar to what many other
2761 assemblers use; it is inspired by the BSD 4.2
2762 @ifclear VAX
2763 assembler.
2764 @end ifclear
2765 @ifset VAX
2766 assembler, except that @command{@value{AS}} does not assemble Vax bit-fields.
2767 @end ifset
2769 @menu
2770 * Preprocessing::               Preprocessing
2771 * Whitespace::                  Whitespace
2772 * Comments::                    Comments
2773 * Symbol Intro::                Symbols
2774 * Statements::                  Statements
2775 * Constants::                   Constants
2776 @end menu
2778 @node Preprocessing
2779 @section Preprocessing
2781 @cindex preprocessing
2782 The @command{@value{AS}} internal preprocessor:
2783 @itemize @bullet
2784 @cindex whitespace, removed by preprocessor
2785 @item
2786 adjusts and removes extra whitespace.  It leaves one space or tab before
2787 the keywords on a line, and turns any other whitespace on the line into
2788 a single space.
2790 @cindex comments, removed by preprocessor
2791 @item
2792 removes all comments, replacing them with a single space, or an
2793 appropriate number of newlines.
2795 @cindex constants, converted by preprocessor
2796 @item
2797 converts character constants into the appropriate numeric values.
2798 @end itemize
2800 It does not do macro processing, include file handling, or
2801 anything else you may get from your C compiler's preprocessor.  You can
2802 do include file processing with the @code{.include} directive
2803 (@pxref{Include,,@code{.include}}).  You can use the @sc{gnu} C compiler driver
2804 to get other ``CPP'' style preprocessing by giving the input file a
2805 @samp{.S} suffix.  @xref{Overall Options, ,Options Controlling the Kind of
2806 Output, gcc info, Using GNU CC}.
2808 Excess whitespace, comments, and character constants
2809 cannot be used in the portions of the input text that are not
2810 preprocessed.
2812 @cindex turning preprocessing on and off
2813 @cindex preprocessing, turning on and off
2814 @kindex #NO_APP
2815 @kindex #APP
2816 If the first line of an input file is @code{#NO_APP} or if you use the
2817 @samp{-f} option, whitespace and comments are not removed from the input file.
2818 Within an input file, you can ask for whitespace and comment removal in
2819 specific portions of the by putting a line that says @code{#APP} before the
2820 text that may contain whitespace or comments, and putting a line that says
2821 @code{#NO_APP} after this text.  This feature is mainly intend to support
2822 @code{asm} statements in compilers whose output is otherwise free of comments
2823 and whitespace.
2825 @node Whitespace
2826 @section Whitespace
2828 @cindex whitespace
2829 @dfn{Whitespace} is one or more blanks or tabs, in any order.
2830 Whitespace is used to separate symbols, and to make programs neater for
2831 people to read.  Unless within character constants
2832 (@pxref{Characters,,Character Constants}), any whitespace means the same
2833 as exactly one space.
2835 @node Comments
2836 @section Comments
2838 @cindex comments
2839 There are two ways of rendering comments to @command{@value{AS}}.  In both
2840 cases the comment is equivalent to one space.
2842 Anything from @samp{/*} through the next @samp{*/} is a comment.
2843 This means you may not nest these comments.
2845 @smallexample
2847   The only way to include a newline ('\n') in a comment
2848   is to use this sort of comment.
2851 /* This sort of comment does not nest. */
2852 @end smallexample
2854 @cindex line comment character
2855 Anything from a @dfn{line comment} character up to the next newline is
2856 considered a comment and is ignored.  The line comment character is target
2857 specific, and some targets multiple comment characters.  Some targets also have
2858 line comment characters that only work if they are the first character on a
2859 line.  Some targets use a sequence of two characters to introduce a line
2860 comment.  Some targets can also change their line comment characters depending
2861 upon command-line options that have been used.  For more details see the
2862 @emph{Syntax} section in the documentation for individual targets.
2864 If the line comment character is the hash sign (@samp{#}) then it still has the
2865 special ability to enable and disable preprocessing (@pxref{Preprocessing}) and
2866 to specify logical line numbers:
2868 @kindex #
2869 @cindex lines starting with @code{#}
2870 @cindex logical line numbers
2871 To be compatible with past assemblers, lines that begin with @samp{#} have a
2872 special interpretation.  Following the @samp{#} should be an absolute
2873 expression (@pxref{Expressions}): the logical line number of the @emph{next}
2874 line.  Then a string (@pxref{Strings, ,Strings}) is allowed: if present it is a
2875 new logical file name.  The rest of the line, if any, should be whitespace.
2877 If the first non-whitespace characters on the line are not numeric,
2878 the line is ignored.  (Just like a comment.)
2880 @smallexample
2881                           # This is an ordinary comment.
2882 # 42-6 "new_file_name"    # New logical file name
2883                           # This is logical line # 36.
2884 @end smallexample
2885 This feature is deprecated, and may disappear from future versions
2886 of @command{@value{AS}}.
2888 @node Symbol Intro
2889 @section Symbols
2891 @cindex characters used in symbols
2892 @ifclear SPECIAL-SYMS
2893 A @dfn{symbol} is one or more characters chosen from the set of all
2894 letters (both upper and lower case), digits and the three characters
2895 @samp{_.$}.
2896 @end ifclear
2897 @ifset SPECIAL-SYMS
2898 @ifclear GENERIC
2899 @ifset H8
2900 A @dfn{symbol} is one or more characters chosen from the set of all
2901 letters (both upper and lower case), digits and the three characters
2902 @samp{._$}.  (Save that, on the H8/300 only, you may not use @samp{$} in
2903 symbol names.)
2904 @end ifset
2905 @end ifclear
2906 @end ifset
2907 @ifset GENERIC
2908 On most machines, you can also use @code{$} in symbol names; exceptions
2909 are noted in @ref{Machine Dependencies}.
2910 @end ifset
2911 No symbol may begin with a digit.  Case is significant.
2912 There is no length limit; all characters are significant.  Multibyte characters
2913 are supported.  Symbols are delimited by characters not in that set, or by the
2914 beginning of a file (since the source program must end with a newline, the end
2915 of a file is not a possible symbol delimiter).  @xref{Symbols}.
2917 Symbol names may also be enclosed in double quote @code{"} characters.  In such
2918 cases any characters are allowed, except for the NUL character.  If a double
2919 quote character is to be included in the symbol name it must be preceeded by a
2920 backslash @code{\} character.
2921 @cindex length of symbols
2923 @node Statements
2924 @section Statements
2926 @cindex statements, structure of
2927 @cindex line separator character
2928 @cindex statement separator character
2930 A @dfn{statement} ends at a newline character (@samp{\n}) or a
2931 @dfn{line separator character}.  The line separator character is target
2932 specific and described in the @emph{Syntax} section of each
2933 target's documentation.  Not all targets support a line separator character.
2934 The newline or line separator character is considered to be part of the
2935 preceding statement.  Newlines and separators within character constants are an
2936 exception: they do not end statements.
2938 @cindex newline, required at file end
2939 @cindex EOF, newline must precede
2940 It is an error to end any statement with end-of-file:  the last
2941 character of any input file should be a newline.@refill
2943 An empty statement is allowed, and may include whitespace.  It is ignored.
2945 @cindex instructions and directives
2946 @cindex directives and instructions
2947 @c "key symbol" is not used elsewhere in the document; seems pedantic to
2948 @c @defn{} it in that case, as was done previously...  doc@cygnus.com,
2949 @c 13feb91.
2950 A statement begins with zero or more labels, optionally followed by a
2951 key symbol which determines what kind of statement it is.  The key
2952 symbol determines the syntax of the rest of the statement.  If the
2953 symbol begins with a dot @samp{.} then the statement is an assembler
2954 directive: typically valid for any computer.  If the symbol begins with
2955 a letter the statement is an assembly language @dfn{instruction}: it
2956 assembles into a machine language instruction.
2957 @ifset GENERIC
2958 Different versions of @command{@value{AS}} for different computers
2959 recognize different instructions.  In fact, the same symbol may
2960 represent a different instruction in a different computer's assembly
2961 language.@refill
2962 @end ifset
2964 @cindex @code{:} (label)
2965 @cindex label (@code{:})
2966 A label is a symbol immediately followed by a colon (@code{:}).
2967 Whitespace before a label or after a colon is permitted, but you may not
2968 have whitespace between a label's symbol and its colon. @xref{Labels}.
2970 @ifset HPPA
2971 For HPPA targets, labels need not be immediately followed by a colon, but
2972 the definition of a label must begin in column zero.  This also implies that
2973 only one label may be defined on each line.
2974 @end ifset
2976 @smallexample
2977 label:     .directive    followed by something
2978 another_label:           # This is an empty statement.
2979            instruction   operand_1, operand_2, @dots{}
2980 @end smallexample
2982 @node Constants
2983 @section Constants
2985 @cindex constants
2986 A constant is a number, written so that its value is known by
2987 inspection, without knowing any context.  Like this:
2988 @smallexample
2989 @group
2990 .byte  74, 0112, 092, 0x4A, 0X4a, 'J, '\J # All the same value.
2991 .ascii "Ring the bell\7"                  # A string constant.
2992 .octa  0x123456789abcdef0123456789ABCDEF0 # A bignum.
2993 .float 0f-314159265358979323846264338327\
2994 95028841971.693993751E-40                 # - pi, a flonum.
2995 @end group
2996 @end smallexample
2998 @menu
2999 * Characters::                  Character Constants
3000 * Numbers::                     Number Constants
3001 @end menu
3003 @node Characters
3004 @subsection Character Constants
3006 @cindex character constants
3007 @cindex constants, character
3008 There are two kinds of character constants.  A @dfn{character} stands
3009 for one character in one byte and its value may be used in
3010 numeric expressions.  String constants (properly called string
3011 @emph{literals}) are potentially many bytes and their values may not be
3012 used in arithmetic expressions.
3014 @menu
3015 * Strings::                     Strings
3016 * Chars::                       Characters
3017 @end menu
3019 @node Strings
3020 @subsubsection Strings
3022 @cindex string constants
3023 @cindex constants, string
3024 A @dfn{string} is written between double-quotes.  It may contain
3025 double-quotes or null characters.  The way to get special characters
3026 into a string is to @dfn{escape} these characters: precede them with
3027 a backslash @samp{\} character.  For example @samp{\\} represents
3028 one backslash:  the first @code{\} is an escape which tells
3029 @command{@value{AS}} to interpret the second character literally as a backslash
3030 (which prevents @command{@value{AS}} from recognizing the second @code{\} as an
3031 escape character).  The complete list of escapes follows.
3033 @cindex escape codes, character
3034 @cindex character escape codes
3035 @c NOTE: Cindex entries must not start with a backlash character.
3036 @c NOTE: This confuses the pdf2texi script when it is creating the
3037 @c NOTE: index based upon the first character and so it generates:
3038 @c NOTE:   \initial {\\}
3039 @c NOTE: which then results in the error message:
3040 @c NOTE:   Argument of \\ has an extra }.
3041 @c NOTE: So in the index entries below a space character has been
3042 @c NOTE: prepended to avoid this problem.
3043 @table @kbd
3044 @c      @item \a
3045 @c      Mnemonic for ACKnowledge; for ASCII this is octal code 007.
3047 @cindex @code{ \b} (backspace character)
3048 @cindex backspace (@code{\b})
3049 @item \b
3050 Mnemonic for backspace; for ASCII this is octal code 010.
3052 @c      @item \e
3053 @c      Mnemonic for EOText; for ASCII this is octal code 004.
3055 @cindex @code{ \f} (formfeed character)
3056 @cindex formfeed (@code{\f})
3057 @item backslash-f
3058 Mnemonic for FormFeed; for ASCII this is octal code 014.
3060 @cindex @code{ \n} (newline character)
3061 @cindex newline (@code{\n})
3062 @item \n
3063 Mnemonic for newline; for ASCII this is octal code 012.
3065 @c      @item \p
3066 @c      Mnemonic for prefix; for ASCII this is octal code 033, usually known as @code{escape}.
3068 @cindex @code{ \r} (carriage return character)
3069 @cindex carriage return (@code{backslash-r})
3070 @item \r
3071 Mnemonic for carriage-Return; for ASCII this is octal code 015.
3073 @c      @item \s
3074 @c      Mnemonic for space; for ASCII this is octal code 040.  Included for compliance with
3075 @c      other assemblers.
3077 @cindex @code{ \t} (tab)
3078 @cindex tab (@code{\t})
3079 @item \t
3080 Mnemonic for horizontal Tab; for ASCII this is octal code 011.
3082 @c      @item \v
3083 @c      Mnemonic for Vertical tab; for ASCII this is octal code 013.
3084 @c      @item \x @var{digit} @var{digit} @var{digit}
3085 @c      A hexadecimal character code.  The numeric code is 3 hexadecimal digits.
3087 @cindex @code{ \@var{ddd}} (octal character code)
3088 @cindex octal character code (@code{\@var{ddd}})
3089 @item \ @var{digit} @var{digit} @var{digit}
3090 An octal character code.  The numeric code is 3 octal digits.
3091 For compatibility with other Unix systems, 8 and 9 are accepted as digits:
3092 for example, @code{\008} has the value 010, and @code{\009} the value 011.
3094 @cindex @code{ \@var{xd...}} (hex character code)
3095 @cindex hex character code (@code{\@var{xd...}})
3096 @item \@code{x} @var{hex-digits...}
3097 A hex character code.  All trailing hex digits are combined.  Either upper or
3098 lower case @code{x} works.
3100 @cindex @code{ \\} (@samp{\} character)
3101 @cindex backslash (@code{\\})
3102 @item \\
3103 Represents one @samp{\} character.
3105 @c      @item \'
3106 @c      Represents one @samp{'} (accent acute) character.
3107 @c      This is needed in single character literals
3108 @c      (@xref{Characters,,Character Constants}.) to represent
3109 @c      a @samp{'}.
3111 @cindex @code{ \"} (doublequote character)
3112 @cindex doublequote (@code{\"})
3113 @item \"
3114 Represents one @samp{"} character.  Needed in strings to represent
3115 this character, because an unescaped @samp{"} would end the string.
3117 @item \ @var{anything-else}
3118 Any other character when escaped by @kbd{\} gives a warning, but
3119 assembles as if the @samp{\} was not present.  The idea is that if
3120 you used an escape sequence you clearly didn't want the literal
3121 interpretation of the following character.  However @command{@value{AS}} has no
3122 other interpretation, so @command{@value{AS}} knows it is giving you the wrong
3123 code and warns you of the fact.
3124 @end table
3126 Which characters are escapable, and what those escapes represent,
3127 varies widely among assemblers.  The current set is what we think
3128 the BSD 4.2 assembler recognizes, and is a subset of what most C
3129 compilers recognize.  If you are in doubt, do not use an escape
3130 sequence.
3132 @node Chars
3133 @subsubsection Characters
3135 @cindex single character constant
3136 @cindex character, single
3137 @cindex constant, single character
3138 A single character may be written as a single quote immediately followed by
3139 that character.  Some backslash escapes apply to characters, @code{\b},
3140 @code{\f}, @code{\n}, @code{\r}, @code{\t}, and @code{\"} with the same meaning
3141 as for strings, plus @code{\'} for a single quote.  So if you want to write the
3142 character backslash, you must write @kbd{'\\} where the first @code{\} escapes
3143 the second @code{\}.  As you can see, the quote is an acute accent, not a grave
3144 accent.  A newline
3145 @ifclear GENERIC
3146 @ifclear abnormal-separator
3147 (or semicolon @samp{;})
3148 @end ifclear
3149 @ifset abnormal-separator
3150 @ifset H8
3151 (or dollar sign @samp{$}, for the H8/300; or semicolon @samp{;} for the
3152 Renesas SH)
3153 @end ifset
3154 @end ifset
3155 @end ifclear
3156 immediately following an acute accent is taken as a literal character
3157 and does not count as the end of a statement.  The value of a character
3158 constant in a numeric expression is the machine's byte-wide code for
3159 that character.  @command{@value{AS}} assumes your character code is ASCII:
3160 @kbd{'A} means 65, @kbd{'B} means 66, and so on. @refill
3162 @node Numbers
3163 @subsection Number Constants
3165 @cindex constants, number
3166 @cindex number constants
3167 @command{@value{AS}} distinguishes three kinds of numbers according to how they
3168 are stored in the target machine.  @emph{Integers} are numbers that
3169 would fit into an @code{int} in the C language.  @emph{Bignums} are
3170 integers, but they are stored in more than 32 bits.  @emph{Flonums}
3171 are floating point numbers, described below.
3173 @menu
3174 * Integers::                    Integers
3175 * Bignums::                     Bignums
3176 * Flonums::                     Flonums
3177 @ifclear GENERIC
3178 @end ifclear
3179 @end menu
3181 @node Integers
3182 @subsubsection Integers
3183 @cindex integers
3184 @cindex constants, integer
3186 @cindex binary integers
3187 @cindex integers, binary
3188 A binary integer is @samp{0b} or @samp{0B} followed by zero or more of
3189 the binary digits @samp{01}.
3191 @cindex octal integers
3192 @cindex integers, octal
3193 An octal integer is @samp{0} followed by zero or more of the octal
3194 digits (@samp{01234567}).
3196 @cindex decimal integers
3197 @cindex integers, decimal
3198 A decimal integer starts with a non-zero digit followed by zero or
3199 more digits (@samp{0123456789}).
3201 @cindex hexadecimal integers
3202 @cindex integers, hexadecimal
3203 A hexadecimal integer is @samp{0x} or @samp{0X} followed by one or
3204 more hexadecimal digits chosen from @samp{0123456789abcdefABCDEF}.
3206 Integers have the usual values.  To denote a negative integer, use
3207 the prefix operator @samp{-} discussed under expressions
3208 (@pxref{Prefix Ops,,Prefix Operators}).
3210 @node Bignums
3211 @subsubsection Bignums
3213 @cindex bignums
3214 @cindex constants, bignum
3215 A @dfn{bignum} has the same syntax and semantics as an integer
3216 except that the number (or its negative) takes more than 32 bits to
3217 represent in binary.  The distinction is made because in some places
3218 integers are permitted while bignums are not.
3220 @node Flonums
3221 @subsubsection Flonums
3222 @cindex flonums
3223 @cindex floating point numbers
3224 @cindex constants, floating point
3226 @cindex precision, floating point
3227 A @dfn{flonum} represents a floating point number.  The translation is
3228 indirect: a decimal floating point number from the text is converted by
3229 @command{@value{AS}} to a generic binary floating point number of more than
3230 sufficient precision.  This generic floating point number is converted
3231 to a particular computer's floating point format (or formats) by a
3232 portion of @command{@value{AS}} specialized to that computer.
3234 A flonum is written by writing (in order)
3235 @itemize @bullet
3236 @item
3237 The digit @samp{0}.
3238 @ifset HPPA
3239 (@samp{0} is optional on the HPPA.)
3240 @end ifset
3242 @item
3243 A letter, to tell @command{@value{AS}} the rest of the number is a flonum.
3244 @ifset GENERIC
3245 @kbd{e} is recommended.  Case is not important.
3246 @ignore
3247 @c FIXME: verify if flonum syntax really this vague for most cases
3248 (Any otherwise illegal letter works here, but that might be changed.  Vax BSD
3249 4.2 assembler seems to allow any of @samp{defghDEFGH}.)
3250 @end ignore
3252 On the H8/300 and Renesas / SuperH SH architectures, the letter must be
3253 one of the letters @samp{DFPRSX} (in upper or lower case).
3255 On the ARC, the letter must be one of the letters @samp{DFRS}
3256 (in upper or lower case).
3258 On the HPPA architecture, the letter must be @samp{E} (upper case only).
3259 @end ifset
3260 @ifclear GENERIC
3261 @ifset ARC
3262 One of the letters @samp{DFRS} (in upper or lower case).
3263 @end ifset
3264 @ifset H8
3265 One of the letters @samp{DFPRSX} (in upper or lower case).
3266 @end ifset
3267 @ifset HPPA
3268 The letter @samp{E} (upper case only).
3269 @end ifset
3270 @end ifclear
3272 @item
3273 An optional sign: either @samp{+} or @samp{-}.
3275 @item
3276 An optional @dfn{integer part}: zero or more decimal digits.
3278 @item
3279 An optional @dfn{fractional part}: @samp{.} followed by zero
3280 or more decimal digits.
3282 @item
3283 An optional exponent, consisting of:
3285 @itemize @bullet
3286 @item
3287 An @samp{E} or @samp{e}.
3288 @c I can't find a config where "EXP_CHARS" is other than 'eE', but in
3289 @c principle this can perfectly well be different on different targets.
3290 @item
3291 Optional sign: either @samp{+} or @samp{-}.
3292 @item
3293 One or more decimal digits.
3294 @end itemize
3296 @end itemize
3298 At least one of the integer part or the fractional part must be
3299 present.  The floating point number has the usual base-10 value.
3301 @command{@value{AS}} does all processing using integers.  Flonums are computed
3302 independently of any floating point hardware in the computer running
3303 @command{@value{AS}}.
3305 @node Sections
3306 @chapter Sections and Relocation
3307 @cindex sections
3308 @cindex relocation
3310 @menu
3311 * Secs Background::             Background
3312 * Ld Sections::                 Linker Sections
3313 * As Sections::                 Assembler Internal Sections
3314 * Sub-Sections::                Sub-Sections
3315 * bss::                         bss Section
3316 @end menu
3318 @node Secs Background
3319 @section Background
3321 Roughly, a section is a range of addresses, with no gaps; all data
3322 ``in'' those addresses is treated the same for some particular purpose.
3323 For example there may be a ``read only'' section.
3325 @cindex linker, and assembler
3326 @cindex assembler, and linker
3327 The linker @code{@value{LD}} reads many object files (partial programs) and
3328 combines their contents to form a runnable program.  When @command{@value{AS}}
3329 emits an object file, the partial program is assumed to start at address 0.
3330 @code{@value{LD}} assigns the final addresses for the partial program, so that
3331 different partial programs do not overlap.  This is actually an
3332 oversimplification, but it suffices to explain how @command{@value{AS}} uses
3333 sections.
3335 @code{@value{LD}} moves blocks of bytes of your program to their run-time
3336 addresses.  These blocks slide to their run-time addresses as rigid
3337 units; their length does not change and neither does the order of bytes
3338 within them.  Such a rigid unit is called a @emph{section}.  Assigning
3339 run-time addresses to sections is called @dfn{relocation}.  It includes
3340 the task of adjusting mentions of object-file addresses so they refer to
3341 the proper run-time addresses.
3342 @ifset H8
3343 For the H8/300, and for the Renesas / SuperH SH,
3344 @command{@value{AS}} pads sections if needed to
3345 ensure they end on a word (sixteen bit) boundary.
3346 @end ifset
3348 @cindex standard assembler sections
3349 An object file written by @command{@value{AS}} has at least three sections, any
3350 of which may be empty.  These are named @dfn{text}, @dfn{data} and
3351 @dfn{bss} sections.
3353 @ifset COFF-ELF
3354 @ifset GENERIC
3355 When it generates COFF or ELF output,
3356 @end ifset
3357 @command{@value{AS}} can also generate whatever other named sections you specify
3358 using the @samp{.section} directive (@pxref{Section,,@code{.section}}).
3359 If you do not use any directives that place output in the @samp{.text}
3360 or @samp{.data} sections, these sections still exist, but are empty.
3361 @end ifset
3363 @ifset HPPA
3364 @ifset GENERIC
3365 When @command{@value{AS}} generates SOM or ELF output for the HPPA,
3366 @end ifset
3367 @command{@value{AS}} can also generate whatever other named sections you
3368 specify using the @samp{.space} and @samp{.subspace} directives.  See
3369 @cite{HP9000 Series 800 Assembly Language Reference Manual}
3370 (HP 92432-90001) for details on the @samp{.space} and @samp{.subspace}
3371 assembler directives.
3373 @ifset SOM
3374 Additionally, @command{@value{AS}} uses different names for the standard
3375 text, data, and bss sections when generating SOM output.  Program text
3376 is placed into the @samp{$CODE$} section, data into @samp{$DATA$}, and
3377 BSS into @samp{$BSS$}.
3378 @end ifset
3379 @end ifset
3381 Within the object file, the text section starts at address @code{0}, the
3382 data section follows, and the bss section follows the data section.
3384 @ifset HPPA
3385 When generating either SOM or ELF output files on the HPPA, the text
3386 section starts at address @code{0}, the data section at address
3387 @code{0x4000000}, and the bss section follows the data section.
3388 @end ifset
3390 To let @code{@value{LD}} know which data changes when the sections are
3391 relocated, and how to change that data, @command{@value{AS}} also writes to the
3392 object file details of the relocation needed.  To perform relocation
3393 @code{@value{LD}} must know, each time an address in the object
3394 file is mentioned:
3395 @itemize @bullet
3396 @item
3397 Where in the object file is the beginning of this reference to
3398 an address?
3399 @item
3400 How long (in bytes) is this reference?
3401 @item
3402 Which section does the address refer to?  What is the numeric value of
3403 @display
3404 (@var{address}) @minus{} (@var{start-address of section})?
3405 @end display
3406 @item
3407 Is the reference to an address ``Program-Counter relative''?
3408 @end itemize
3410 @cindex addresses, format of
3411 @cindex section-relative addressing
3412 In fact, every address @command{@value{AS}} ever uses is expressed as
3413 @display
3414 (@var{section}) + (@var{offset into section})
3415 @end display
3416 @noindent
3417 Further, most expressions @command{@value{AS}} computes have this section-relative
3418 nature.
3419 @ifset SOM
3420 (For some object formats, such as SOM for the HPPA, some expressions are
3421 symbol-relative instead.)
3422 @end ifset
3424 In this manual we use the notation @{@var{secname} @var{N}@} to mean ``offset
3425 @var{N} into section @var{secname}.''
3427 Apart from text, data and bss sections you need to know about the
3428 @dfn{absolute} section.  When @code{@value{LD}} mixes partial programs,
3429 addresses in the absolute section remain unchanged.  For example, address
3430 @code{@{absolute 0@}} is ``relocated'' to run-time address 0 by
3431 @code{@value{LD}}.  Although the linker never arranges two partial programs'
3432 data sections with overlapping addresses after linking, @emph{by definition}
3433 their absolute sections must overlap.  Address @code{@{absolute@ 239@}} in one
3434 part of a program is always the same address when the program is running as
3435 address @code{@{absolute@ 239@}} in any other part of the program.
3437 The idea of sections is extended to the @dfn{undefined} section.  Any
3438 address whose section is unknown at assembly time is by definition
3439 rendered @{undefined @var{U}@}---where @var{U} is filled in later.
3440 Since numbers are always defined, the only way to generate an undefined
3441 address is to mention an undefined symbol.  A reference to a named
3442 common block would be such a symbol: its value is unknown at assembly
3443 time so it has section @emph{undefined}.
3445 By analogy the word @emph{section} is used to describe groups of sections in
3446 the linked program.  @code{@value{LD}} puts all partial programs' text
3447 sections in contiguous addresses in the linked program.  It is
3448 customary to refer to the @emph{text section} of a program, meaning all
3449 the addresses of all partial programs' text sections.  Likewise for
3450 data and bss sections.
3452 Some sections are manipulated by @code{@value{LD}}; others are invented for
3453 use of @command{@value{AS}} and have no meaning except during assembly.
3455 @node Ld Sections
3456 @section Linker Sections
3457 @code{@value{LD}} deals with just four kinds of sections, summarized below.
3459 @table @strong
3461 @ifset COFF-ELF
3462 @cindex named sections
3463 @cindex sections, named
3464 @item named sections
3465 @end ifset
3466 @ifset aout
3467 @cindex text section
3468 @cindex data section
3469 @itemx text section
3470 @itemx data section
3471 @end ifset
3472 These sections hold your program.  @command{@value{AS}} and @code{@value{LD}} treat them as
3473 separate but equal sections.  Anything you can say of one section is
3474 true of another.
3475 @c @ifset aout
3476 When the program is running, however, it is
3477 customary for the text section to be unalterable.  The
3478 text section is often shared among processes: it contains
3479 instructions, constants and the like.  The data section of a running
3480 program is usually alterable: for example, C variables would be stored
3481 in the data section.
3482 @c @end ifset
3484 @cindex bss section
3485 @item bss section
3486 This section contains zeroed bytes when your program begins running.  It
3487 is used to hold uninitialized variables or common storage.  The length of
3488 each partial program's bss section is important, but because it starts
3489 out containing zeroed bytes there is no need to store explicit zero
3490 bytes in the object file.  The bss section was invented to eliminate
3491 those explicit zeros from object files.
3493 @cindex absolute section
3494 @item absolute section
3495 Address 0 of this section is always ``relocated'' to runtime address 0.
3496 This is useful if you want to refer to an address that @code{@value{LD}} must
3497 not change when relocating.  In this sense we speak of absolute
3498 addresses being ``unrelocatable'': they do not change during relocation.
3500 @cindex undefined section
3501 @item undefined section
3502 This ``section'' is a catch-all for address references to objects not in
3503 the preceding sections.
3504 @c FIXME: ref to some other doc on obj-file formats could go here.
3505 @end table
3507 @cindex relocation example
3508 An idealized example of three relocatable sections follows.
3509 @ifset COFF-ELF
3510 The example uses the traditional section names @samp{.text} and @samp{.data}.
3511 @end ifset
3512 Memory addresses are on the horizontal axis.
3514 @c TEXI2ROFF-KILL
3515 @ifnottex
3516 @c END TEXI2ROFF-KILL
3517 @smallexample
3518                       +-----+----+--+
3519 partial program # 1:  |ttttt|dddd|00|
3520                       +-----+----+--+
3522                       text   data bss
3523                       seg.   seg. seg.
3525                       +---+---+---+
3526 partial program # 2:  |TTT|DDD|000|
3527                       +---+---+---+
3529                       +--+---+-----+--+----+---+-----+~~
3530 linked program:       |  |TTT|ttttt|  |dddd|DDD|00000|
3531                       +--+---+-----+--+----+---+-----+~~
3533     addresses:        0 @dots{}
3534 @end smallexample
3535 @c TEXI2ROFF-KILL
3536 @end ifnottex
3537 @need 5000
3538 @tex
3539 \bigskip
3540 \line{\it Partial program \#1: \hfil}
3541 \line{\ibox{2.5cm}{\tt text}\ibox{2cm}{\tt data}\ibox{1cm}{\tt bss}\hfil}
3542 \line{\boxit{2.5cm}{\tt ttttt}\boxit{2cm}{\tt dddd}\boxit{1cm}{\tt 00}\hfil}
3544 \line{\it Partial program \#2: \hfil}
3545 \line{\ibox{1cm}{\tt text}\ibox{1.5cm}{\tt data}\ibox{1cm}{\tt bss}\hfil}
3546 \line{\boxit{1cm}{\tt TTT}\boxit{1.5cm}{\tt DDDD}\boxit{1cm}{\tt 000}\hfil}
3548 \line{\it linked program: \hfil}
3549 \line{\ibox{.5cm}{}\ibox{1cm}{\tt text}\ibox{2.5cm}{}\ibox{.75cm}{}\ibox{2cm}{\tt data}\ibox{1.5cm}{}\ibox{2cm}{\tt bss}\hfil}
3550 \line{\boxit{.5cm}{}\boxit{1cm}{\tt TTT}\boxit{2.5cm}{\tt
3551 ttttt}\boxit{.75cm}{}\boxit{2cm}{\tt dddd}\boxit{1.5cm}{\tt
3552 DDDD}\boxit{2cm}{\tt 00000}\ \dots\hfil}
3554 \line{\it addresses: \hfil}
3555 \line{0\dots\hfil}
3557 @end tex
3558 @c END TEXI2ROFF-KILL
3560 @node As Sections
3561 @section Assembler Internal Sections
3563 @cindex internal assembler sections
3564 @cindex sections in messages, internal
3565 These sections are meant only for the internal use of @command{@value{AS}}.  They
3566 have no meaning at run-time.  You do not really need to know about these
3567 sections for most purposes; but they can be mentioned in @command{@value{AS}}
3568 warning messages, so it might be helpful to have an idea of their
3569 meanings to @command{@value{AS}}.  These sections are used to permit the
3570 value of every expression in your assembly language program to be a
3571 section-relative address.
3573 @table @b
3574 @cindex assembler internal logic error
3575 @item ASSEMBLER-INTERNAL-LOGIC-ERROR!
3576 An internal assembler logic error has been found.  This means there is a
3577 bug in the assembler.
3579 @cindex expr (internal section)
3580 @item expr section
3581 The assembler stores complex expression internally as combinations of
3582 symbols.  When it needs to represent an expression as a symbol, it puts
3583 it in the expr section.
3584 @c FIXME item debug
3585 @c FIXME item transfer[t] vector preload
3586 @c FIXME item transfer[t] vector postload
3587 @c FIXME item register
3588 @end table
3590 @node Sub-Sections
3591 @section Sub-Sections
3593 @cindex numbered subsections
3594 @cindex grouping data
3595 @ifset aout
3596 Assembled bytes
3597 @ifset COFF-ELF
3598 conventionally
3599 @end ifset
3600 fall into two sections: text and data.
3601 @end ifset
3602 You may have separate groups of
3603 @ifset GENERIC
3604 data in named sections
3605 @end ifset
3606 @ifclear GENERIC
3607 @ifclear aout
3608 data in named sections
3609 @end ifclear
3610 @ifset aout
3611 text or data
3612 @end ifset
3613 @end ifclear
3614 that you want to end up near to each other in the object file, even though they
3615 are not contiguous in the assembler source.  @command{@value{AS}} allows you to
3616 use @dfn{subsections} for this purpose.  Within each section, there can be
3617 numbered subsections with values from 0 to 8192.  Objects assembled into the
3618 same subsection go into the object file together with other objects in the same
3619 subsection.  For example, a compiler might want to store constants in the text
3620 section, but might not want to have them interspersed with the program being
3621 assembled.  In this case, the compiler could issue a @samp{.text 0} before each
3622 section of code being output, and a @samp{.text 1} before each group of
3623 constants being output.
3625 Subsections are optional.  If you do not use subsections, everything
3626 goes in subsection number zero.
3628 @ifset GENERIC
3629 Each subsection is zero-padded up to a multiple of four bytes.
3630 (Subsections may be padded a different amount on different flavors
3631 of @command{@value{AS}}.)
3632 @end ifset
3633 @ifclear GENERIC
3634 @ifset H8
3635 On the H8/300 platform, each subsection is zero-padded to a word
3636 boundary (two bytes).
3637 The same is true on the Renesas SH.
3638 @end ifset
3639 @end ifclear
3641 Subsections appear in your object file in numeric order, lowest numbered
3642 to highest.  (All this to be compatible with other people's assemblers.)
3643 The object file contains no representation of subsections; @code{@value{LD}} and
3644 other programs that manipulate object files see no trace of them.
3645 They just see all your text subsections as a text section, and all your
3646 data subsections as a data section.
3648 To specify which subsection you want subsequent statements assembled
3649 into, use a numeric argument to specify it, in a @samp{.text
3650 @var{expression}} or a @samp{.data @var{expression}} statement.
3651 @ifset COFF
3652 @ifset GENERIC
3653 When generating COFF output, you
3654 @end ifset
3655 @ifclear GENERIC
3657 @end ifclear
3658 can also use an extra subsection
3659 argument with arbitrary named sections: @samp{.section @var{name},
3660 @var{expression}}.
3661 @end ifset
3662 @ifset ELF
3663 @ifset GENERIC
3664 When generating ELF output, you
3665 @end ifset
3666 @ifclear GENERIC
3668 @end ifclear
3669 can also use the @code{.subsection} directive (@pxref{SubSection})
3670 to specify a subsection: @samp{.subsection @var{expression}}.
3671 @end ifset
3672 @var{Expression} should be an absolute expression
3673 (@pxref{Expressions}).  If you just say @samp{.text} then @samp{.text 0}
3674 is assumed.  Likewise @samp{.data} means @samp{.data 0}.  Assembly
3675 begins in @code{text 0}.  For instance:
3676 @smallexample
3677 .text 0     # The default subsection is text 0 anyway.
3678 .ascii "This lives in the first text subsection. *"
3679 .text 1
3680 .ascii "But this lives in the second text subsection."
3681 .data 0
3682 .ascii "This lives in the data section,"
3683 .ascii "in the first data subsection."
3684 .text 0
3685 .ascii "This lives in the first text section,"
3686 .ascii "immediately following the asterisk (*)."
3687 @end smallexample
3689 Each section has a @dfn{location counter} incremented by one for every byte
3690 assembled into that section.  Because subsections are merely a convenience
3691 restricted to @command{@value{AS}} there is no concept of a subsection location
3692 counter.  There is no way to directly manipulate a location counter---but the
3693 @code{.align} directive changes it, and any label definition captures its
3694 current value.  The location counter of the section where statements are being
3695 assembled is said to be the @dfn{active} location counter.
3697 @node bss
3698 @section bss Section
3700 @cindex bss section
3701 @cindex common variable storage
3702 The bss section is used for local common variable storage.
3703 You may allocate address space in the bss section, but you may
3704 not dictate data to load into it before your program executes.  When
3705 your program starts running, all the contents of the bss
3706 section are zeroed bytes.
3708 The @code{.lcomm} pseudo-op defines a symbol in the bss section; see
3709 @ref{Lcomm,,@code{.lcomm}}.
3711 The @code{.comm} pseudo-op may be used to declare a common symbol, which is
3712 another form of uninitialized symbol; see @ref{Comm,,@code{.comm}}.
3714 @ifset GENERIC
3715 When assembling for a target which supports multiple sections, such as ELF or
3716 COFF, you may switch into the @code{.bss} section and define symbols as usual;
3717 see @ref{Section,,@code{.section}}.  You may only assemble zero values into the
3718 section.  Typically the section will only contain symbol definitions and
3719 @code{.skip} directives (@pxref{Skip,,@code{.skip}}).
3720 @end ifset
3722 @node Symbols
3723 @chapter Symbols
3725 @cindex symbols
3726 Symbols are a central concept: the programmer uses symbols to name
3727 things, the linker uses symbols to link, and the debugger uses symbols
3728 to debug.
3730 @quotation
3731 @cindex debuggers, and symbol order
3732 @emph{Warning:} @command{@value{AS}} does not place symbols in the object file in
3733 the same order they were declared.  This may break some debuggers.
3734 @end quotation
3736 @menu
3737 * Labels::                      Labels
3738 * Setting Symbols::             Giving Symbols Other Values
3739 * Symbol Names::                Symbol Names
3740 * Dot::                         The Special Dot Symbol
3741 * Symbol Attributes::           Symbol Attributes
3742 @end menu
3744 @node Labels
3745 @section Labels
3747 @cindex labels
3748 A @dfn{label} is written as a symbol immediately followed by a colon
3749 @samp{:}.  The symbol then represents the current value of the
3750 active location counter, and is, for example, a suitable instruction
3751 operand.  You are warned if you use the same symbol to represent two
3752 different locations: the first definition overrides any other
3753 definitions.
3755 @ifset HPPA
3756 On the HPPA, the usual form for a label need not be immediately followed by a
3757 colon, but instead must start in column zero.  Only one label may be defined on
3758 a single line.  To work around this, the HPPA version of @command{@value{AS}} also
3759 provides a special directive @code{.label} for defining labels more flexibly.
3760 @end ifset
3762 @node Setting Symbols
3763 @section Giving Symbols Other Values
3765 @cindex assigning values to symbols
3766 @cindex symbol values, assigning
3767 A symbol can be given an arbitrary value by writing a symbol, followed
3768 by an equals sign @samp{=}, followed by an expression
3769 (@pxref{Expressions}).  This is equivalent to using the @code{.set}
3770 directive.  @xref{Set,,@code{.set}}.  In the same way, using a double
3771 equals sign @samp{=}@samp{=} here represents an equivalent of the
3772 @code{.eqv} directive.  @xref{Eqv,,@code{.eqv}}.
3774 @ifset Blackfin
3775 Blackfin does not support symbol assignment with @samp{=}.
3776 @end ifset
3778 @node Symbol Names
3779 @section Symbol Names
3781 @cindex symbol names
3782 @cindex names, symbol
3783 @ifclear SPECIAL-SYMS
3784 Symbol names begin with a letter or with one of @samp{._}.  On most
3785 machines, you can also use @code{$} in symbol names; exceptions are
3786 noted in @ref{Machine Dependencies}.  That character may be followed by any
3787 string of digits, letters, dollar signs (unless otherwise noted for a
3788 particular target machine), and underscores.
3789 @end ifclear
3790 @ifset SPECIAL-SYMS
3791 @ifset H8
3792 Symbol names begin with a letter or with one of @samp{._}.  On the
3793 Renesas SH you can also use @code{$} in symbol names.  That
3794 character may be followed by any string of digits, letters, dollar signs (save
3795 on the H8/300), and underscores.
3796 @end ifset
3797 @end ifset
3799 Case of letters is significant: @code{foo} is a different symbol name
3800 than @code{Foo}.
3802 Symbol names do not start with a digit.  An exception to this rule is made for
3803 Local Labels.  See below.
3805 Multibyte characters are supported.  To generate a symbol name containing
3806 multibyte characters enclose it within double quotes and use escape codes. cf
3807 @xref{Strings}.  Generating a multibyte symbol name from a label is not
3808 currently supported.
3810 Each symbol has exactly one name.  Each name in an assembly language program
3811 refers to exactly one symbol.  You may use that symbol name any number of times
3812 in a program.
3814 @subheading Local Symbol Names
3816 @cindex local symbol names
3817 @cindex symbol names, local
3818 A local symbol is any symbol beginning with certain local label prefixes.
3819 By default, the local label prefix is @samp{.L} for ELF systems or
3820 @samp{L} for traditional a.out systems, but each target may have its own
3821 set of local label prefixes.
3822 @ifset HPPA
3823 On the HPPA local symbols begin with @samp{L$}.
3824 @end ifset
3826 Local symbols are defined and used within the assembler, but they are
3827 normally not saved in object files.  Thus, they are not visible when debugging.
3828 You may use the @samp{-L} option (@pxref{L, ,Include Local Symbols})
3829 to retain the local symbols in the object files.
3831 @subheading Local Labels
3833 @cindex local labels
3834 @cindex temporary symbol names
3835 @cindex symbol names, temporary
3836 Local labels are different from local symbols.  Local labels help compilers and
3837 programmers use names temporarily.  They create symbols which are guaranteed to
3838 be unique over the entire scope of the input source code and which can be
3839 referred to by a simple notation.  To define a local label, write a label of
3840 the form @samp{@b{N}:} (where @b{N} represents any non-negative integer).
3841 To refer to the most recent previous definition of that label write
3842 @samp{@b{N}b}, using the same number as when you defined the label.  To refer
3843 to the next definition of a local label, write @samp{@b{N}f}.  The @samp{b}
3844 stands for ``backwards'' and the @samp{f} stands for ``forwards''.
3846 There is no restriction on how you can use these labels, and you can reuse them
3847 too.  So that it is possible to repeatedly define the same local label (using
3848 the same number @samp{@b{N}}), although you can only refer to the most recently
3849 defined local label of that number (for a backwards reference) or the next
3850 definition of a specific local label for a forward reference.  It is also worth
3851 noting that the first 10 local labels (@samp{@b{0:}}@dots{}@samp{@b{9:}}) are
3852 implemented in a slightly more efficient manner than the others.
3854 Here is an example:
3856 @smallexample
3857 1:        branch 1f
3858 2:        branch 1b
3859 1:        branch 2f
3860 2:        branch 1b
3861 @end smallexample
3863 Which is the equivalent of:
3865 @smallexample
3866 label_1:  branch label_3
3867 label_2:  branch label_1
3868 label_3:  branch label_4
3869 label_4:  branch label_3
3870 @end smallexample
3872 Local label names are only a notational device.  They are immediately
3873 transformed into more conventional symbol names before the assembler uses them.
3874 The symbol names are stored in the symbol table, appear in error messages, and
3875 are optionally emitted to the object file.  The names are constructed using
3876 these parts:
3878 @table @code
3879 @item @emph{local label prefix}
3880 All local symbols begin with the system-specific local label prefix.
3881 Normally both @command{@value{AS}} and @code{@value{LD}} forget symbols
3882 that start with the local label prefix.  These labels are
3883 used for symbols you are never intended to see.  If you use the
3884 @samp{-L} option then @command{@value{AS}} retains these symbols in the
3885 object file. If you also instruct @code{@value{LD}} to retain these symbols,
3886 you may use them in debugging.
3888 @item @var{number}
3889 This is the number that was used in the local label definition.  So if the
3890 label is written @samp{55:} then the number is @samp{55}.
3892 @item @kbd{C-B}
3893 This unusual character is included so you do not accidentally invent a symbol
3894 of the same name.  The character has ASCII value of @samp{\002} (control-B).
3896 @item @emph{ordinal number}
3897 This is a serial number to keep the labels distinct.  The first definition of
3898 @samp{0:} gets the number @samp{1}.  The 15th definition of @samp{0:} gets the
3899 number @samp{15}, and so on.  Likewise the first definition of @samp{1:} gets
3900 the number @samp{1} and its 15th definition gets @samp{15} as well.
3901 @end table
3903 So for example, the first @code{1:} may be named @code{.L1@kbd{C-B}1}, and
3904 the 44th @code{3:} may be named @code{.L3@kbd{C-B}44}.
3906 @subheading Dollar Local Labels
3907 @cindex dollar local symbols
3909 On some targets @code{@value{AS}} also supports an even more local form of
3910 local labels called dollar labels.  These labels go out of scope (i.e., they
3911 become undefined) as soon as a non-local label is defined.  Thus they remain
3912 valid for only a small region of the input source code.  Normal local labels,
3913 by contrast, remain in scope for the entire file, or until they are redefined
3914 by another occurrence of the same local label.
3916 Dollar labels are defined in exactly the same way as ordinary local labels,
3917 except that they have a dollar sign suffix to their numeric value, e.g.,
3918 @samp{@b{55$:}}.
3920 They can also be distinguished from ordinary local labels by their transformed
3921 names which use ASCII character @samp{\001} (control-A) as the magic character
3922 to distinguish them from ordinary labels.  For example, the fifth definition of
3923 @samp{6$} may be named @samp{.L6@kbd{C-A}5}.
3925 @node Dot
3926 @section The Special Dot Symbol
3928 @cindex dot (symbol)
3929 @cindex @code{.} (symbol)
3930 @cindex current address
3931 @cindex location counter
3932 The special symbol @samp{.} refers to the current address that
3933 @command{@value{AS}} is assembling into.  Thus, the expression @samp{melvin:
3934 .long .} defines @code{melvin} to contain its own address.
3935 Assigning a value to @code{.} is treated the same as a @code{.org}
3936 directive.
3937 @ifclear no-space-dir
3938 Thus, the expression @samp{.=.+4} is the same as saying
3939 @samp{.space 4}.
3940 @end ifclear
3942 @node Symbol Attributes
3943 @section Symbol Attributes
3945 @cindex symbol attributes
3946 @cindex attributes, symbol
3947 Every symbol has, as well as its name, the attributes ``Value'' and
3948 ``Type''.  Depending on output format, symbols can also have auxiliary
3949 attributes.
3950 @ifset INTERNALS
3951 The detailed definitions are in @file{a.out.h}.
3952 @end ifset
3954 If you use a symbol without defining it, @command{@value{AS}} assumes zero for
3955 all these attributes, and probably won't warn you.  This makes the
3956 symbol an externally defined symbol, which is generally what you
3957 would want.
3959 @menu
3960 * Symbol Value::                Value
3961 * Symbol Type::                 Type
3962 @ifset aout
3963 * a.out Symbols::               Symbol Attributes: @code{a.out}
3964 @end ifset
3965 @ifset COFF
3966 * COFF Symbols::                Symbol Attributes for COFF
3967 @end ifset
3968 @ifset SOM
3969 * SOM Symbols::                Symbol Attributes for SOM
3970 @end ifset
3971 @end menu
3973 @node Symbol Value
3974 @subsection Value
3976 @cindex value of a symbol
3977 @cindex symbol value
3978 The value of a symbol is (usually) 32 bits.  For a symbol which labels a
3979 location in the text, data, bss or absolute sections the value is the
3980 number of addresses from the start of that section to the label.
3981 Naturally for text, data and bss sections the value of a symbol changes
3982 as @code{@value{LD}} changes section base addresses during linking.  Absolute
3983 symbols' values do not change during linking: that is why they are
3984 called absolute.
3986 The value of an undefined symbol is treated in a special way.  If it is
3987 0 then the symbol is not defined in this assembler source file, and
3988 @code{@value{LD}} tries to determine its value from other files linked into the
3989 same program.  You make this kind of symbol simply by mentioning a symbol
3990 name without defining it.  A non-zero value represents a @code{.comm}
3991 common declaration.  The value is how much common storage to reserve, in
3992 bytes (addresses).  The symbol refers to the first address of the
3993 allocated storage.
3995 @node Symbol Type
3996 @subsection Type
3998 @cindex type of a symbol
3999 @cindex symbol type
4000 The type attribute of a symbol contains relocation (section)
4001 information, any flag settings indicating that a symbol is external, and
4002 (optionally), other information for linkers and debuggers.  The exact
4003 format depends on the object-code output format in use.
4005 @ifset aout
4006 @node a.out Symbols
4007 @subsection Symbol Attributes: @code{a.out}
4009 @cindex @code{a.out} symbol attributes
4010 @cindex symbol attributes, @code{a.out}
4012 @menu
4013 * Symbol Desc::                 Descriptor
4014 * Symbol Other::                Other
4015 @end menu
4017 @node Symbol Desc
4018 @subsubsection Descriptor
4020 @cindex descriptor, of @code{a.out} symbol
4021 This is an arbitrary 16-bit value.  You may establish a symbol's
4022 descriptor value by using a @code{.desc} statement
4023 (@pxref{Desc,,@code{.desc}}).  A descriptor value means nothing to
4024 @command{@value{AS}}.
4026 @node Symbol Other
4027 @subsubsection Other
4029 @cindex other attribute, of @code{a.out} symbol
4030 This is an arbitrary 8-bit value.  It means nothing to @command{@value{AS}}.
4031 @end ifset
4033 @ifset COFF
4034 @node COFF Symbols
4035 @subsection Symbol Attributes for COFF
4037 @cindex COFF symbol attributes
4038 @cindex symbol attributes, COFF
4040 The COFF format supports a multitude of auxiliary symbol attributes;
4041 like the primary symbol attributes, they are set between @code{.def} and
4042 @code{.endef} directives.
4044 @subsubsection Primary Attributes
4046 @cindex primary attributes, COFF symbols
4047 The symbol name is set with @code{.def}; the value and type,
4048 respectively, with @code{.val} and @code{.type}.
4050 @subsubsection Auxiliary Attributes
4052 @cindex auxiliary attributes, COFF symbols
4053 The @command{@value{AS}} directives @code{.dim}, @code{.line}, @code{.scl},
4054 @code{.size}, @code{.tag}, and @code{.weak} can generate auxiliary symbol
4055 table information for COFF.
4056 @end ifset
4058 @ifset SOM
4059 @node SOM Symbols
4060 @subsection Symbol Attributes for SOM
4062 @cindex SOM symbol attributes
4063 @cindex symbol attributes, SOM
4065 The SOM format for the HPPA supports a multitude of symbol attributes set with
4066 the @code{.EXPORT} and @code{.IMPORT} directives.
4068 The attributes are described in @cite{HP9000 Series 800 Assembly
4069 Language Reference Manual} (HP 92432-90001) under the @code{IMPORT} and
4070 @code{EXPORT} assembler directive documentation.
4071 @end ifset
4073 @node Expressions
4074 @chapter Expressions
4076 @cindex expressions
4077 @cindex addresses
4078 @cindex numeric values
4079 An @dfn{expression} specifies an address or numeric value.
4080 Whitespace may precede and/or follow an expression.
4082 The result of an expression must be an absolute number, or else an offset into
4083 a particular section.  If an expression is not absolute, and there is not
4084 enough information when @command{@value{AS}} sees the expression to know its
4085 section, a second pass over the source program might be necessary to interpret
4086 the expression---but the second pass is currently not implemented.
4087 @command{@value{AS}} aborts with an error message in this situation.
4089 @menu
4090 * Empty Exprs::                 Empty Expressions
4091 * Integer Exprs::               Integer Expressions
4092 @end menu
4094 @node Empty Exprs
4095 @section Empty Expressions
4097 @cindex empty expressions
4098 @cindex expressions, empty
4099 An empty expression has no value: it is just whitespace or null.
4100 Wherever an absolute expression is required, you may omit the
4101 expression, and @command{@value{AS}} assumes a value of (absolute) 0.  This
4102 is compatible with other assemblers.
4104 @node Integer Exprs
4105 @section Integer Expressions
4107 @cindex integer expressions
4108 @cindex expressions, integer
4109 An @dfn{integer expression} is one or more @emph{arguments} delimited
4110 by @emph{operators}.
4112 @menu
4113 * Arguments::                   Arguments
4114 * Operators::                   Operators
4115 * Prefix Ops::                  Prefix Operators
4116 * Infix Ops::                   Infix Operators
4117 @end menu
4119 @node Arguments
4120 @subsection Arguments
4122 @cindex expression arguments
4123 @cindex arguments in expressions
4124 @cindex operands in expressions
4125 @cindex arithmetic operands
4126 @dfn{Arguments} are symbols, numbers or subexpressions.  In other
4127 contexts arguments are sometimes called ``arithmetic operands''.  In
4128 this manual, to avoid confusing them with the ``instruction operands'' of
4129 the machine language, we use the term ``argument'' to refer to parts of
4130 expressions only, reserving the word ``operand'' to refer only to machine
4131 instruction operands.
4133 Symbols are evaluated to yield @{@var{section} @var{NNN}@} where
4134 @var{section} is one of text, data, bss, absolute,
4135 or undefined.  @var{NNN} is a signed, 2's complement 32 bit
4136 integer.
4138 Numbers are usually integers.
4140 A number can be a flonum or bignum.  In this case, you are warned
4141 that only the low order 32 bits are used, and @command{@value{AS}} pretends
4142 these 32 bits are an integer.  You may write integer-manipulating
4143 instructions that act on exotic constants, compatible with other
4144 assemblers.
4146 @cindex subexpressions
4147 Subexpressions are a left parenthesis @samp{(} followed by an integer
4148 expression, followed by a right parenthesis @samp{)}; or a prefix
4149 operator followed by an argument.
4151 @node Operators
4152 @subsection Operators
4154 @cindex operators, in expressions
4155 @cindex arithmetic functions
4156 @cindex functions, in expressions
4157 @dfn{Operators} are arithmetic functions, like @code{+} or @code{%}.  Prefix
4158 operators are followed by an argument.  Infix operators appear
4159 between their arguments.  Operators may be preceded and/or followed by
4160 whitespace.
4162 @node Prefix Ops
4163 @subsection Prefix Operator
4165 @cindex prefix operators
4166 @command{@value{AS}} has the following @dfn{prefix operators}.  They each take
4167 one argument, which must be absolute.
4169 @c the tex/end tex stuff surrounding this small table is meant to make
4170 @c it align, on the printed page, with the similar table in the next
4171 @c section (which is inside an enumerate).
4172 @tex
4173 \global\advance\leftskip by \itemindent
4174 @end tex
4176 @table @code
4177 @item -
4178 @dfn{Negation}.  Two's complement negation.
4179 @item ~
4180 @dfn{Complementation}.  Bitwise not.
4181 @end table
4183 @tex
4184 \global\advance\leftskip by -\itemindent
4185 @end tex
4187 @node Infix Ops
4188 @subsection Infix Operators
4190 @cindex infix operators
4191 @cindex operators, permitted arguments
4192 @dfn{Infix operators} take two arguments, one on either side.  Operators
4193 have precedence, but operations with equal precedence are performed left
4194 to right.  Apart from @code{+} or @option{-}, both arguments must be
4195 absolute, and the result is absolute.
4197 @enumerate
4198 @cindex operator precedence
4199 @cindex precedence of operators
4201 @item
4202 Highest Precedence
4204 @table @code
4205 @item *
4206 @dfn{Multiplication}.
4208 @item /
4209 @dfn{Division}.  Truncation is the same as the C operator @samp{/}
4211 @item %
4212 @dfn{Remainder}.
4214 @item <<
4215 @dfn{Shift Left}.  Same as the C operator @samp{<<}.
4217 @item >>
4218 @dfn{Shift Right}.  Same as the C operator @samp{>>}.
4219 @end table
4221 @item
4222 Intermediate precedence
4224 @table @code
4225 @item |
4227 @dfn{Bitwise Inclusive Or}.
4229 @item &
4230 @dfn{Bitwise And}.
4232 @item ^
4233 @dfn{Bitwise Exclusive Or}.
4235 @item !
4236 @dfn{Bitwise Or Not}.
4237 @end table
4239 @item
4240 Low Precedence
4242 @table @code
4243 @cindex addition, permitted arguments
4244 @cindex plus, permitted arguments
4245 @cindex arguments for addition
4246 @item +
4247 @dfn{Addition}.  If either argument is absolute, the result has the section of
4248 the other argument.  You may not add together arguments from different
4249 sections.
4251 @cindex subtraction, permitted arguments
4252 @cindex minus, permitted arguments
4253 @cindex arguments for subtraction
4254 @item -
4255 @dfn{Subtraction}.  If the right argument is absolute, the
4256 result has the section of the left argument.
4257 If both arguments are in the same section, the result is absolute.
4258 You may not subtract arguments from different sections.
4259 @c FIXME is there still something useful to say about undefined - undefined ?
4261 @cindex comparison expressions
4262 @cindex expressions, comparison
4263 @item  ==
4264 @dfn{Is Equal To}
4265 @item <>
4266 @itemx !=
4267 @dfn{Is Not Equal To}
4268 @item <
4269 @dfn{Is Less Than}
4270 @item >
4271 @dfn{Is Greater Than}
4272 @item >=
4273 @dfn{Is Greater Than Or Equal To}
4274 @item <=
4275 @dfn{Is Less Than Or Equal To}
4277 The comparison operators can be used as infix operators.  A true results has a
4278 value of -1 whereas a false result has a value of 0.   Note, these operators
4279 perform signed comparisons.
4280 @end table
4282 @item Lowest Precedence
4284 @table @code
4285 @item &&
4286 @dfn{Logical And}.
4288 @item ||
4289 @dfn{Logical Or}.
4291 These two logical operations can be used to combine the results of sub
4292 expressions.  Note, unlike the comparison operators a true result returns a
4293 value of 1 but a false results does still return 0.  Also note that the logical
4294 or operator has a slightly lower precedence than logical and.
4296 @end table
4297 @end enumerate
4299 In short, it's only meaningful to add or subtract the @emph{offsets} in an
4300 address; you can only have a defined section in one of the two arguments.
4302 @node Pseudo Ops
4303 @chapter Assembler Directives
4305 @cindex directives, machine independent
4306 @cindex pseudo-ops, machine independent
4307 @cindex machine independent directives
4308 All assembler directives have names that begin with a period (@samp{.}).
4309 The names are case insensitive for most targets, and usually written
4310 in lower case.
4312 This chapter discusses directives that are available regardless of the
4313 target machine configuration for the @sc{gnu} assembler.
4314 @ifset GENERIC
4315 Some machine configurations provide additional directives.
4316 @xref{Machine Dependencies}.
4317 @end ifset
4318 @ifclear GENERIC
4319 @ifset machine-directives
4320 @xref{Machine Dependencies}, for additional directives.
4321 @end ifset
4322 @end ifclear
4324 @menu
4325 * Abort::                       @code{.abort}
4326 @ifset COFF
4327 * ABORT (COFF)::                @code{.ABORT}
4328 @end ifset
4330 * Align::                       @code{.align @var{abs-expr} , @var{abs-expr}}
4331 * Altmacro::                    @code{.altmacro}
4332 * Ascii::                       @code{.ascii "@var{string}"}@dots{}
4333 * Asciz::                       @code{.asciz "@var{string}"}@dots{}
4334 * Balign::                      @code{.balign @var{abs-expr} , @var{abs-expr}}
4335 * Bundle directives::           @code{.bundle_align_mode @var{abs-expr}}, etc
4336 * Byte::                        @code{.byte @var{expressions}}
4337 * CFI directives::              @code{.cfi_startproc [simple]}, @code{.cfi_endproc}, etc.
4338 * Comm::                        @code{.comm @var{symbol} , @var{length} }
4339 * Data::                        @code{.data @var{subsection}}
4340 * Dc::                          @code{.dc[@var{size}] @var{expressions}}
4341 * Dcb::                         @code{.dcb[@var{size}] @var{number} [,@var{fill}]}
4342 * Ds::                          @code{.ds[@var{size}] @var{number} [,@var{fill}]}
4343 @ifset COFF
4344 * Def::                         @code{.def @var{name}}
4345 @end ifset
4346 @ifset aout
4347 * Desc::                        @code{.desc @var{symbol}, @var{abs-expression}}
4348 @end ifset
4349 @ifset COFF
4350 * Dim::                         @code{.dim}
4351 @end ifset
4353 * Double::                      @code{.double @var{flonums}}
4354 * Eject::                       @code{.eject}
4355 * Else::                        @code{.else}
4356 * Elseif::                      @code{.elseif}
4357 * End::                         @code{.end}
4358 @ifset COFF
4359 * Endef::                       @code{.endef}
4360 @end ifset
4362 * Endfunc::                     @code{.endfunc}
4363 * Endif::                       @code{.endif}
4364 * Equ::                         @code{.equ @var{symbol}, @var{expression}}
4365 * Equiv::                       @code{.equiv @var{symbol}, @var{expression}}
4366 * Eqv::                         @code{.eqv @var{symbol}, @var{expression}}
4367 * Err::                         @code{.err}
4368 * Error::                       @code{.error @var{string}}
4369 * Exitm::                       @code{.exitm}
4370 * Extern::                      @code{.extern}
4371 * Fail::                        @code{.fail}
4372 * File::                        @code{.file}
4373 * Fill::                        @code{.fill @var{repeat} , @var{size} , @var{value}}
4374 * Float::                       @code{.float @var{flonums}}
4375 * Func::                        @code{.func}
4376 * Global::                      @code{.global @var{symbol}}, @code{.globl @var{symbol}}
4377 @ifset ELF
4378 * Gnu_attribute::               @code{.gnu_attribute @var{tag},@var{value}}
4379 * Hidden::                      @code{.hidden @var{names}}
4380 @end ifset
4382 * hword::                       @code{.hword @var{expressions}}
4383 * Ident::                       @code{.ident}
4384 * If::                          @code{.if @var{absolute expression}}
4385 * Incbin::                      @code{.incbin "@var{file}"[,@var{skip}[,@var{count}]]}
4386 * Include::                     @code{.include "@var{file}"}
4387 * Int::                         @code{.int @var{expressions}}
4388 @ifset ELF
4389 * Internal::                    @code{.internal @var{names}}
4390 @end ifset
4392 * Irp::                         @code{.irp @var{symbol},@var{values}}@dots{}
4393 * Irpc::                        @code{.irpc @var{symbol},@var{values}}@dots{}
4394 * Lcomm::                       @code{.lcomm @var{symbol} , @var{length}}
4395 * Lflags::                      @code{.lflags}
4396 @ifclear no-line-dir
4397 * Line::                        @code{.line @var{line-number}}
4398 @end ifclear
4400 * Linkonce::                    @code{.linkonce [@var{type}]}
4401 * List::                        @code{.list}
4402 * Ln::                          @code{.ln @var{line-number}}
4403 * Loc::                         @code{.loc @var{fileno} @var{lineno}}
4404 * Loc_mark_labels::             @code{.loc_mark_labels @var{enable}}
4405 @ifset ELF
4406 * Local::                       @code{.local @var{names}}
4407 @end ifset
4409 * Long::                        @code{.long @var{expressions}}
4410 @ignore
4411 * Lsym::                        @code{.lsym @var{symbol}, @var{expression}}
4412 @end ignore
4414 * Macro::                       @code{.macro @var{name} @var{args}}@dots{}
4415 * MRI::                         @code{.mri @var{val}}
4416 * Noaltmacro::                  @code{.noaltmacro}
4417 * Nolist::                      @code{.nolist}
4418 * Nops::                        @code{.nops @var{size}[, @var{control}]}
4419 * Octa::                        @code{.octa @var{bignums}}
4420 * Offset::                      @code{.offset @var{loc}}
4421 * Org::                         @code{.org @var{new-lc}, @var{fill}}
4422 * P2align::                     @code{.p2align @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
4423 @ifset ELF
4424 * PopSection::                  @code{.popsection}
4425 * Previous::                    @code{.previous}
4426 @end ifset
4428 * Print::                       @code{.print @var{string}}
4429 @ifset ELF
4430 * Protected::                   @code{.protected @var{names}}
4431 @end ifset
4433 * Psize::                       @code{.psize @var{lines}, @var{columns}}
4434 * Purgem::                      @code{.purgem @var{name}}
4435 @ifset ELF
4436 * PushSection::                 @code{.pushsection @var{name}}
4437 @end ifset
4439 * Quad::                        @code{.quad @var{bignums}}
4440 * Reloc::                       @code{.reloc @var{offset}, @var{reloc_name}[, @var{expression}]}
4441 * Rept::                        @code{.rept @var{count}}
4442 * Sbttl::                       @code{.sbttl "@var{subheading}"}
4443 @ifset COFF
4444 * Scl::                         @code{.scl @var{class}}
4445 @end ifset
4446 @ifset COFF-ELF
4447 * Section::                     @code{.section @var{name}[, @var{flags}]}
4448 @end ifset
4450 * Set::                         @code{.set @var{symbol}, @var{expression}}
4451 * Short::                       @code{.short @var{expressions}}
4452 * Single::                      @code{.single @var{flonums}}
4453 @ifset COFF-ELF
4454 * Size::                        @code{.size [@var{name} , @var{expression}]}
4455 @end ifset
4456 @ifclear no-space-dir
4457 * Skip::                        @code{.skip @var{size} [,@var{fill}]}
4458 @end ifclear
4460 * Sleb128::                     @code{.sleb128 @var{expressions}}
4461 @ifclear no-space-dir
4462 * Space::                       @code{.space @var{size} [,@var{fill}]}
4463 @end ifclear
4464 @ifset have-stabs
4465 * Stab::                        @code{.stabd, .stabn, .stabs}
4466 @end ifset
4468 * String::                      @code{.string "@var{str}"}, @code{.string8 "@var{str}"}, @code{.string16 "@var{str}"}, @code{.string32 "@var{str}"}, @code{.string64 "@var{str}"}
4469 * Struct::                      @code{.struct @var{expression}}
4470 @ifset ELF
4471 * SubSection::                  @code{.subsection}
4472 * Symver::                      @code{.symver @var{name},@var{name2@@nodename}}
4473 @end ifset
4475 @ifset COFF
4476 * Tag::                         @code{.tag @var{structname}}
4477 @end ifset
4479 * Text::                        @code{.text @var{subsection}}
4480 * Title::                       @code{.title "@var{heading}"}
4481 @ifset COFF-ELF
4482 * Type::                        @code{.type <@var{int} | @var{name} , @var{type description}>}
4483 @end ifset
4485 * Uleb128::                     @code{.uleb128 @var{expressions}}
4486 @ifset COFF
4487 * Val::                         @code{.val @var{addr}}
4488 @end ifset
4490 @ifset ELF
4491 * Version::                     @code{.version "@var{string}"}
4492 * VTableEntry::                 @code{.vtable_entry @var{table}, @var{offset}}
4493 * VTableInherit::               @code{.vtable_inherit @var{child}, @var{parent}}
4494 @end ifset
4496 * Warning::                     @code{.warning @var{string}}
4497 * Weak::                        @code{.weak @var{names}}
4498 * Weakref::                     @code{.weakref @var{alias}, @var{symbol}}
4499 * Word::                        @code{.word @var{expressions}}
4500 @ifclear no-space-dir
4501 * Zero::                        @code{.zero @var{size}}
4502 @end ifclear
4503 @ifset ELF
4504 * 2byte::                       @code{.2byte @var{expressions}}
4505 * 4byte::                       @code{.4byte @var{expressions}}
4506 * 8byte::                       @code{.8byte @var{bignums}}
4507 @end ifset
4508 * Deprecated::                  Deprecated Directives
4509 @end menu
4511 @node Abort
4512 @section @code{.abort}
4514 @cindex @code{abort} directive
4515 @cindex stopping the assembly
4516 This directive stops the assembly immediately.  It is for
4517 compatibility with other assemblers.  The original idea was that the
4518 assembly language source would be piped into the assembler.  If the sender
4519 of the source quit, it could use this directive tells @command{@value{AS}} to
4520 quit also.  One day @code{.abort} will not be supported.
4522 @ifset COFF
4523 @node ABORT (COFF)
4524 @section @code{.ABORT} (COFF)
4526 @cindex @code{ABORT} directive
4527 When producing COFF output, @command{@value{AS}} accepts this directive as a
4528 synonym for @samp{.abort}.
4530 @end ifset
4532 @node Align
4533 @section @code{.align @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
4535 @cindex padding the location counter
4536 @cindex @code{align} directive
4537 Pad the location counter (in the current subsection) to a particular storage
4538 boundary.  The first expression (which must be absolute) is the alignment
4539 required, as described below.
4541 The second expression (also absolute) gives the fill value to be stored in the
4542 padding bytes.  It (and the comma) may be omitted.  If it is omitted, the
4543 padding bytes are normally zero.  However, on most systems, if the section is
4544 marked as containing code and the fill value is omitted, the space is filled
4545 with no-op instructions.
4547 The third expression is also absolute, and is also optional.  If it is present,
4548 it is the maximum number of bytes that should be skipped by this alignment
4549 directive.  If doing the alignment would require skipping more bytes than the
4550 specified maximum, then the alignment is not done at all.  You can omit the
4551 fill value (the second argument) entirely by simply using two commas after the
4552 required alignment; this can be useful if you want the alignment to be filled
4553 with no-op instructions when appropriate.
4555 The way the required alignment is specified varies from system to system.
4556 For the arc, hppa, i386 using ELF, iq2000, m68k, or1k,
4557 s390, sparc, tic4x, tic80 and xtensa, the first expression is the
4558 alignment request in bytes.  For example @samp{.align 8} advances
4559 the location counter until it is a multiple of 8.  If the location counter
4560 is already a multiple of 8, no change is needed.  For the tic54x, the
4561 first expression is the alignment request in words.
4563 For other systems, including ppc, i386 using a.out format, arm and
4564 strongarm, it is the
4565 number of low-order zero bits the location counter must have after
4566 advancement.  For example @samp{.align 3} advances the location
4567 counter until it a multiple of 8.  If the location counter is already a
4568 multiple of 8, no change is needed.
4570 This inconsistency is due to the different behaviors of the various
4571 native assemblers for these systems which GAS must emulate.
4572 GAS also provides @code{.balign} and @code{.p2align} directives,
4573 described later, which have a consistent behavior across all
4574 architectures (but are specific to GAS).
4576 @node Altmacro
4577 @section @code{.altmacro}
4578 Enable alternate macro mode, enabling:
4580 @ftable @code
4581 @item LOCAL @var{name} [ , @dots{} ]
4582 One additional directive, @code{LOCAL}, is available.  It is used to
4583 generate a string replacement for each of the @var{name} arguments, and
4584 replace any instances of @var{name} in each macro expansion.  The
4585 replacement string is unique in the assembly, and different for each
4586 separate macro expansion.  @code{LOCAL} allows you to write macros that
4587 define symbols, without fear of conflict between separate macro expansions.
4589 @item String delimiters
4590 You can write strings delimited in these other ways besides
4591 @code{"@var{string}"}:
4593 @table @code
4594 @item '@var{string}'
4595 You can delimit strings with single-quote characters.
4597 @item <@var{string}>
4598 You can delimit strings with matching angle brackets.
4599 @end table
4601 @item single-character string escape
4602 To include any single character literally in a string (even if the
4603 character would otherwise have some special meaning), you can prefix the
4604 character with @samp{!} (an exclamation mark).  For example, you can
4605 write @samp{<4.3 !> 5.4!!>} to get the literal text @samp{4.3 > 5.4!}.
4607 @item Expression results as strings
4608 You can write @samp{%@var{expr}} to evaluate the expression @var{expr}
4609 and use the result as a string.
4610 @end ftable
4612 @node Ascii
4613 @section @code{.ascii "@var{string}"}@dots{}
4615 @cindex @code{ascii} directive
4616 @cindex string literals
4617 @code{.ascii} expects zero or more string literals (@pxref{Strings})
4618 separated by commas.  It assembles each string (with no automatic
4619 trailing zero byte) into consecutive addresses.
4621 @node Asciz
4622 @section @code{.asciz "@var{string}"}@dots{}
4624 @cindex @code{asciz} directive
4625 @cindex zero-terminated strings
4626 @cindex null-terminated strings
4627 @code{.asciz} is just like @code{.ascii}, but each string is followed by
4628 a zero byte.  The ``z'' in @samp{.asciz} stands for ``zero''.
4630 @node Balign
4631 @section @code{.balign[wl] @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
4633 @cindex padding the location counter given number of bytes
4634 @cindex @code{balign} directive
4635 Pad the location counter (in the current subsection) to a particular
4636 storage boundary.  The first expression (which must be absolute) is the
4637 alignment request in bytes.  For example @samp{.balign 8} advances
4638 the location counter until it is a multiple of 8.  If the location counter
4639 is already a multiple of 8, no change is needed.
4641 The second expression (also absolute) gives the fill value to be stored in the
4642 padding bytes.  It (and the comma) may be omitted.  If it is omitted, the
4643 padding bytes are normally zero.  However, on most systems, if the section is
4644 marked as containing code and the fill value is omitted, the space is filled
4645 with no-op instructions.
4647 The third expression is also absolute, and is also optional.  If it is present,
4648 it is the maximum number of bytes that should be skipped by this alignment
4649 directive.  If doing the alignment would require skipping more bytes than the
4650 specified maximum, then the alignment is not done at all.  You can omit the
4651 fill value (the second argument) entirely by simply using two commas after the
4652 required alignment; this can be useful if you want the alignment to be filled
4653 with no-op instructions when appropriate.
4655 @cindex @code{balignw} directive
4656 @cindex @code{balignl} directive
4657 The @code{.balignw} and @code{.balignl} directives are variants of the
4658 @code{.balign} directive.  The @code{.balignw} directive treats the fill
4659 pattern as a two byte word value.  The @code{.balignl} directives treats the
4660 fill pattern as a four byte longword value.  For example, @code{.balignw
4661 4,0x368d} will align to a multiple of 4.  If it skips two bytes, they will be
4662 filled in with the value 0x368d (the exact placement of the bytes depends upon
4663 the endianness of the processor).  If it skips 1 or 3 bytes, the fill value is
4664 undefined.
4666 @node Bundle directives
4667 @section Bundle directives
4668 @subsection @code{.bundle_align_mode @var{abs-expr}}
4669 @cindex @code{bundle_align_mode} directive
4670 @cindex bundle
4671 @cindex instruction bundle
4672 @cindex aligned instruction bundle
4673 @code{.bundle_align_mode} enables or disables @dfn{aligned instruction
4674 bundle} mode.  In this mode, sequences of adjacent instructions are grouped
4675 into fixed-sized @dfn{bundles}.  If the argument is zero, this mode is
4676 disabled (which is the default state).  If the argument it not zero, it
4677 gives the size of an instruction bundle as a power of two (as for the
4678 @code{.p2align} directive, @pxref{P2align}).
4680 For some targets, it's an ABI requirement that no instruction may span a
4681 certain aligned boundary.  A @dfn{bundle} is simply a sequence of
4682 instructions that starts on an aligned boundary.  For example, if
4683 @var{abs-expr} is @code{5} then the bundle size is 32, so each aligned
4684 chunk of 32 bytes is a bundle.  When aligned instruction bundle mode is in
4685 effect, no single instruction may span a boundary between bundles.  If an
4686 instruction would start too close to the end of a bundle for the length of
4687 that particular instruction to fit within the bundle, then the space at the
4688 end of that bundle is filled with no-op instructions so the instruction
4689 starts in the next bundle.  As a corollary, it's an error if any single
4690 instruction's encoding is longer than the bundle size.
4692 @subsection @code{.bundle_lock} and @code{.bundle_unlock}
4693 @cindex @code{bundle_lock} directive
4694 @cindex @code{bundle_unlock} directive
4695 The @code{.bundle_lock} and directive @code{.bundle_unlock} directives
4696 allow explicit control over instruction bundle padding.  These directives
4697 are only valid when @code{.bundle_align_mode} has been used to enable
4698 aligned instruction bundle mode.  It's an error if they appear when
4699 @code{.bundle_align_mode} has not been used at all, or when the last
4700 directive was @w{@code{.bundle_align_mode 0}}.
4702 @cindex bundle-locked
4703 For some targets, it's an ABI requirement that certain instructions may
4704 appear only as part of specified permissible sequences of multiple
4705 instructions, all within the same bundle.  A pair of @code{.bundle_lock}
4706 and @code{.bundle_unlock} directives define a @dfn{bundle-locked}
4707 instruction sequence.  For purposes of aligned instruction bundle mode, a
4708 sequence starting with @code{.bundle_lock} and ending with
4709 @code{.bundle_unlock} is treated as a single instruction.  That is, the
4710 entire sequence must fit into a single bundle and may not span a bundle
4711 boundary.  If necessary, no-op instructions will be inserted before the
4712 first instruction of the sequence so that the whole sequence starts on an
4713 aligned bundle boundary.  It's an error if the sequence is longer than the
4714 bundle size.
4716 For convenience when using @code{.bundle_lock} and @code{.bundle_unlock}
4717 inside assembler macros (@pxref{Macro}), bundle-locked sequences may be
4718 nested.  That is, a second @code{.bundle_lock} directive before the next
4719 @code{.bundle_unlock} directive has no effect except that it must be
4720 matched by another closing @code{.bundle_unlock} so that there is the
4721 same number of @code{.bundle_lock} and @code{.bundle_unlock} directives.
4723 @node Byte
4724 @section @code{.byte @var{expressions}}
4726 @cindex @code{byte} directive
4727 @cindex integers, one byte
4728 @code{.byte} expects zero or more expressions, separated by commas.
4729 Each expression is assembled into the next byte.
4731 @node CFI directives
4732 @section CFI directives
4733 @subsection @code{.cfi_sections @var{section_list}}
4734 @cindex @code{cfi_sections} directive
4735 @code{.cfi_sections} may be used to specify whether CFI directives
4736 should emit @code{.eh_frame} section and/or @code{.debug_frame} section.
4737 If @var{section_list} is @code{.eh_frame}, @code{.eh_frame} is emitted,
4738 if @var{section_list} is @code{.debug_frame}, @code{.debug_frame} is emitted.
4739 To emit both use @code{.eh_frame, .debug_frame}.  The default if this
4740 directive is not used is @code{.cfi_sections .eh_frame}.
4742 On targets that support compact unwinding tables these can be generated
4743 by specifying @code{.eh_frame_entry} instead of @code{.eh_frame}.
4745 Some targets may support an additional name, such as @code{.c6xabi.exidx}
4746 which is used by the @value{TIC6X} target.
4748 The @code{.cfi_sections} directive can be repeated, with the same or different
4749 arguments, provided that CFI generation has not yet started.  Once CFI
4750 generation has started however the section list is fixed and any attempts to
4751 redefine it will result in an error.
4753 @subsection @code{.cfi_startproc [simple]}
4754 @cindex @code{cfi_startproc} directive
4755 @code{.cfi_startproc} is used at the beginning of each function that
4756 should have an entry in @code{.eh_frame}. It initializes some internal
4757 data structures. Don't forget to close the function by
4758 @code{.cfi_endproc}.
4760 Unless @code{.cfi_startproc} is used along with parameter @code{simple}
4761 it also emits some architecture dependent initial CFI instructions.
4763 @subsection @code{.cfi_endproc}
4764 @cindex @code{cfi_endproc} directive
4765 @code{.cfi_endproc} is used at the end of a function where it closes its
4766 unwind entry previously opened by
4767 @code{.cfi_startproc}, and emits it to @code{.eh_frame}.
4769 @subsection @code{.cfi_personality @var{encoding} [, @var{exp}]}
4770 @cindex @code{cfi_personality} directive
4771 @code{.cfi_personality} defines personality routine and its encoding.
4772 @var{encoding} must be a constant determining how the personality
4773 should be encoded.  If it is 255 (@code{DW_EH_PE_omit}), second
4774 argument is not present, otherwise second argument should be
4775 a constant or a symbol name.  When using indirect encodings,
4776 the symbol provided should be the location where personality
4777 can be loaded from, not the personality routine itself.
4778 The default after @code{.cfi_startproc} is @code{.cfi_personality 0xff},
4779 no personality routine.
4781 @subsection @code{.cfi_personality_id @var{id}}
4782 @cindex @code{cfi_personality_id} directive
4783 @code{cfi_personality_id} defines a personality routine by its index as
4784 defined in a compact unwinding format.
4785 Only valid when generating compact EH frames (i.e.
4786 with @code{.cfi_sections eh_frame_entry}.
4788 @subsection @code{.cfi_fde_data [@var{opcode1} [, @dots{}]]}
4789 @cindex @code{cfi_fde_data} directive
4790 @code{cfi_fde_data} is used to describe the compact unwind opcodes to be
4791 used for the current function.  These are emitted inline in the
4792 @code{.eh_frame_entry} section if small enough and there is no LSDA, or
4793 in the @code{.gnu.extab} section otherwise.
4794 Only valid when generating compact EH frames (i.e.
4795 with @code{.cfi_sections eh_frame_entry}.
4797 @subsection @code{.cfi_lsda @var{encoding} [, @var{exp}]}
4798 @code{.cfi_lsda} defines LSDA and its encoding.
4799 @var{encoding} must be a constant determining how the LSDA
4800 should be encoded.  If it is 255 (@code{DW_EH_PE_omit}), the second
4801 argument is not present, otherwise the second argument should be a constant
4802 or a symbol name.  The default after @code{.cfi_startproc} is @code{.cfi_lsda 0xff},
4803 meaning that no LSDA is present.
4805 @subsection @code{.cfi_inline_lsda} [@var{align}]
4806 @code{.cfi_inline_lsda} marks the start of a LSDA data section and
4807 switches to the corresponding @code{.gnu.extab} section.
4808 Must be preceded by a CFI block containing a @code{.cfi_lsda} directive.
4809 Only valid when generating compact EH frames (i.e.
4810 with @code{.cfi_sections eh_frame_entry}.
4812 The table header and unwinding opcodes will be generated at this point,
4813 so that they are immediately followed by the LSDA data.  The symbol
4814 referenced by the @code{.cfi_lsda} directive should still be defined
4815 in case a fallback FDE based encoding is used.  The LSDA data is terminated
4816 by a section directive.
4818 The optional @var{align} argument specifies the alignment required.
4819 The alignment is specified as a power of two, as with the
4820 @code{.p2align} directive.
4822 @subsection @code{.cfi_def_cfa @var{register}, @var{offset}}
4823 @code{.cfi_def_cfa} defines a rule for computing CFA as: @i{take
4824 address from @var{register} and add @var{offset} to it}.
4826 @subsection @code{.cfi_def_cfa_register @var{register}}
4827 @code{.cfi_def_cfa_register} modifies a rule for computing CFA. From
4828 now on @var{register} will be used instead of the old one. Offset
4829 remains the same.
4831 @subsection @code{.cfi_def_cfa_offset @var{offset}}
4832 @code{.cfi_def_cfa_offset} modifies a rule for computing CFA. Register
4833 remains the same, but @var{offset} is new. Note that it is the
4834 absolute offset that will be added to a defined register to compute
4835 CFA address.
4837 @subsection @code{.cfi_adjust_cfa_offset @var{offset}}
4838 Same as @code{.cfi_def_cfa_offset} but @var{offset} is a relative
4839 value that is added/subtracted from the previous offset.
4841 @subsection @code{.cfi_offset @var{register}, @var{offset}}
4842 Previous value of @var{register} is saved at offset @var{offset} from
4843 CFA.
4845 @subsection @code{.cfi_val_offset @var{register}, @var{offset}}
4846 Previous value of @var{register} is CFA + @var{offset}.
4848 @subsection @code{.cfi_rel_offset @var{register}, @var{offset}}
4849 Previous value of @var{register} is saved at offset @var{offset} from
4850 the current CFA register.  This is transformed to @code{.cfi_offset}
4851 using the known displacement of the CFA register from the CFA.
4852 This is often easier to use, because the number will match the
4853 code it's annotating.
4855 @subsection @code{.cfi_register @var{register1}, @var{register2}}
4856 Previous value of @var{register1} is saved in register @var{register2}.
4858 @subsection @code{.cfi_restore @var{register}}
4859 @code{.cfi_restore} says that the rule for @var{register} is now the
4860 same as it was at the beginning of the function, after all initial
4861 instruction added by @code{.cfi_startproc} were executed.
4863 @subsection @code{.cfi_undefined @var{register}}
4864 From now on the previous value of @var{register} can't be restored anymore.
4866 @subsection @code{.cfi_same_value @var{register}}
4867 Current value of @var{register} is the same like in the previous frame,
4868 i.e. no restoration needed.
4870 @subsection @code{.cfi_remember_state} and @code{.cfi_restore_state}
4871 @code{.cfi_remember_state} pushes the set of rules for every register onto an
4872 implicit stack, while @code{.cfi_restore_state} pops them off the stack and
4873 places them in the current row.  This is useful for situations where you have
4874 multiple @code{.cfi_*} directives that need to be undone due to the control
4875 flow of the program.  For example, we could have something like this (assuming
4876 the CFA is the value of @code{rbp}):
4878 @smallexample
4879         je label
4880         popq %rbx
4881         .cfi_restore %rbx
4882         popq %r12
4883         .cfi_restore %r12
4884         popq %rbp
4885         .cfi_restore %rbp
4886         .cfi_def_cfa %rsp, 8
4887         ret
4888 label:
4889         /* Do something else */
4890 @end smallexample
4892 Here, we want the @code{.cfi} directives to affect only the rows corresponding
4893 to the instructions before @code{label}.  This means we'd have to add multiple
4894 @code{.cfi} directives after @code{label} to recreate the original save
4895 locations of the registers, as well as setting the CFA back to the value of
4896 @code{rbp}.  This would be clumsy, and result in a larger binary size. Instead,
4897 we can write:
4899 @smallexample
4900         je label
4901         popq %rbx
4902         .cfi_remember_state
4903         .cfi_restore %rbx
4904         popq %r12
4905         .cfi_restore %r12
4906         popq %rbp
4907         .cfi_restore %rbp
4908         .cfi_def_cfa %rsp, 8
4909         ret
4910 label:
4911         .cfi_restore_state
4912         /* Do something else */
4913 @end smallexample
4915 That way, the rules for the instructions after @code{label} will be the same
4916 as before the first @code{.cfi_restore} without having to use multiple
4917 @code{.cfi} directives.
4919 @subsection @code{.cfi_return_column @var{register}}
4920 Change return column @var{register}, i.e. the return address is either
4921 directly in @var{register} or can be accessed by rules for @var{register}.
4923 @subsection @code{.cfi_signal_frame}
4924 Mark current function as signal trampoline.
4926 @subsection @code{.cfi_window_save}
4927 SPARC register window has been saved.
4929 @subsection @code{.cfi_escape} @var{expression}[, @dots{}]
4930 Allows the user to add arbitrary bytes to the unwind info.  One
4931 might use this to add OS-specific CFI opcodes, or generic CFI
4932 opcodes that GAS does not yet support.
4934 @subsection @code{.cfi_val_encoded_addr @var{register}, @var{encoding}, @var{label}}
4935 The current value of @var{register} is @var{label}.  The value of @var{label}
4936 will be encoded in the output file according to @var{encoding}; see the
4937 description of @code{.cfi_personality} for details on this encoding.
4939 The usefulness of equating a register to a fixed label is probably
4940 limited to the return address register.  Here, it can be useful to
4941 mark a code segment that has only one return address which is reached
4942 by a direct branch and no copy of the return address exists in memory
4943 or another register.
4945 @node Comm
4946 @section @code{.comm @var{symbol} , @var{length} }
4948 @cindex @code{comm} directive
4949 @cindex symbol, common
4950 @code{.comm} declares a common symbol named @var{symbol}.  When linking, a
4951 common symbol in one object file may be merged with a defined or common symbol
4952 of the same name in another object file.  If @code{@value{LD}} does not see a
4953 definition for the symbol--just one or more common symbols--then it will
4954 allocate @var{length} bytes of uninitialized memory.  @var{length} must be an
4955 absolute expression.  If @code{@value{LD}} sees multiple common symbols with
4956 the same name, and they do not all have the same size, it will allocate space
4957 using the largest size.
4959 @ifset COFF-ELF
4960 When using ELF or (as a GNU extension) PE, the @code{.comm} directive takes
4961 an optional third argument.  This is the desired alignment of the symbol,
4962 specified for ELF as a byte boundary (for example, an alignment of 16 means
4963 that the least significant 4 bits of the address should be zero), and for PE
4964 as a power of two (for example, an alignment of 5 means aligned to a 32-byte
4965 boundary).  The alignment must be an absolute expression, and it must be a
4966 power of two.  If @code{@value{LD}} allocates uninitialized memory for the
4967 common symbol, it will use the alignment when placing the symbol.  If no
4968 alignment is specified, @command{@value{AS}} will set the alignment to the
4969 largest power of two less than or equal to the size of the symbol, up to a
4970 maximum of 16 on ELF, or the default section alignment of 4 on PE@footnote{This
4971 is not the same as the executable image file alignment controlled by @code{@value{LD}}'s
4972 @samp{--section-alignment} option; image file sections in PE are aligned to
4973 multiples of 4096, which is far too large an alignment for ordinary variables.
4974 It is rather the default alignment for (non-debug) sections within object
4975 (@samp{*.o}) files, which are less strictly aligned.}.
4976 @end ifset
4978 @ifset HPPA
4979 The syntax for @code{.comm} differs slightly on the HPPA.  The syntax is
4980 @samp{@var{symbol} .comm, @var{length}}; @var{symbol} is optional.
4981 @end ifset
4983 @node Data
4984 @section @code{.data @var{subsection}}
4985 @cindex @code{data} directive
4987 @code{.data} tells @command{@value{AS}} to assemble the following statements onto the
4988 end of the data subsection numbered @var{subsection} (which is an
4989 absolute expression).  If @var{subsection} is omitted, it defaults
4990 to zero.
4992 @node Dc
4993 @section @code{.dc[@var{size}] @var{expressions}}
4994 @cindex @code{dc} directive
4996 The @code{.dc} directive expects zero or more @var{expressions} separated by
4997 commas.  These expressions are evaluated and their values inserted into the
4998 current section.  The size of the emitted value depends upon the suffix to the
4999 @code{.dc} directive:
5001 @table @code
5002 @item @samp{.a}
5003 Emits N-bit values, where N is the size of an address on the target system.
5004 @item @samp{.b}
5005 Emits 8-bit values.
5006 @item @samp{.d}
5007 Emits double precision floating-point values.
5008 @item @samp{.l}
5009 Emits 32-bit values.
5010 @item @samp{.s}
5011 Emits single precision floating-point values.
5012 @item @samp{.w}
5013 Emits 16-bit values.
5014 Note - this is true even on targets where the @code{.word} directive would emit
5015 32-bit values.
5016 @item @samp{.x}
5017 Emits long double precision floating-point values.
5018 @end table
5020 If no suffix is used then @samp{.w} is assumed.
5022 The byte ordering is target dependent, as is the size and format of floating
5023 point values.
5025 @node Dcb
5026 @section @code{.dcb[@var{size}] @var{number} [,@var{fill}]}
5027 @cindex @code{dcb} directive
5028 This directive emits @var{number} copies of @var{fill}, each of @var{size}
5029 bytes.  Both @var{number} and @var{fill} are absolute expressions.  If the
5030 comma and @var{fill} are omitted, @var{fill} is assumed to be zero.  The
5031 @var{size} suffix, if present, must be one of:
5033 @table @code
5034 @item @samp{.b}
5035 Emits single byte values.
5036 @item @samp{.d}
5037 Emits double-precision floating point values.
5038 @item @samp{.l}
5039 Emits 4-byte values.
5040 @item @samp{.s}
5041 Emits single-precision floating point values.
5042 @item @samp{.w}
5043 Emits 2-byte values.
5044 @item @samp{.x}
5045 Emits long double-precision floating point values.
5046 @end table
5048 If the @var{size} suffix is omitted then @samp{.w} is assumed.
5050 The byte ordering is target dependent, as is the size and format of floating
5051 point values.
5053 @node Ds
5054 @section @code{.ds[@var{size}] @var{number} [,@var{fill}]}
5055 @cindex @code{ds} directive
5056 This directive emits @var{number} copies of @var{fill}, each of @var{size}
5057 bytes.  Both @var{number} and @var{fill} are absolute expressions.  If the
5058 comma and @var{fill} are omitted, @var{fill} is assumed to be zero.  The
5059 @var{size} suffix, if present, must be one of:
5061 @table @code
5062 @item @samp{.b}
5063 Emits single byte values.
5064 @item @samp{.d}
5065 Emits 8-byte values.
5066 @item @samp{.l}
5067 Emits 4-byte values.
5068 @item @samp{.p}
5069 Emits 12-byte values.
5070 @item @samp{.s}
5071 Emits 4-byte values.
5072 @item @samp{.w}
5073 Emits 2-byte values.
5074 @item @samp{.x}
5075 Emits 12-byte values.
5076 @end table
5078 Note - unlike the @code{.dcb} directive the @samp{.d}, @samp{.s} and @samp{.x}
5079 suffixes do not indicate that floating-point values are to be inserted.
5081 If the @var{size} suffix is omitted then @samp{.w} is assumed.
5083 The byte ordering is target dependent.
5086 @ifset COFF
5087 @node Def
5088 @section @code{.def @var{name}}
5090 @cindex @code{def} directive
5091 @cindex COFF symbols, debugging
5092 @cindex debugging COFF symbols
5093 Begin defining debugging information for a symbol @var{name}; the
5094 definition extends until the @code{.endef} directive is encountered.
5095 @end ifset
5097 @ifset aout
5098 @node Desc
5099 @section @code{.desc @var{symbol}, @var{abs-expression}}
5101 @cindex @code{desc} directive
5102 @cindex COFF symbol descriptor
5103 @cindex symbol descriptor, COFF
5104 This directive sets the descriptor of the symbol (@pxref{Symbol Attributes})
5105 to the low 16 bits of an absolute expression.
5107 @ifset COFF
5108 The @samp{.desc} directive is not available when @command{@value{AS}} is
5109 configured for COFF output; it is only for @code{a.out} or @code{b.out}
5110 object format.  For the sake of compatibility, @command{@value{AS}} accepts
5111 it, but produces no output, when configured for COFF.
5112 @end ifset
5113 @end ifset
5115 @ifset COFF
5116 @node Dim
5117 @section @code{.dim}
5119 @cindex @code{dim} directive
5120 @cindex COFF auxiliary symbol information
5121 @cindex auxiliary symbol information, COFF
5122 This directive is generated by compilers to include auxiliary debugging
5123 information in the symbol table.  It is only permitted inside
5124 @code{.def}/@code{.endef} pairs.
5125 @end ifset
5127 @node Double
5128 @section @code{.double @var{flonums}}
5130 @cindex @code{double} directive
5131 @cindex floating point numbers (double)
5132 @code{.double} expects zero or more flonums, separated by commas.  It
5133 assembles floating point numbers.
5134 @ifset GENERIC
5135 The exact kind of floating point numbers emitted depends on how
5136 @command{@value{AS}} is configured.  @xref{Machine Dependencies}.
5137 @end ifset
5138 @ifclear GENERIC
5139 @ifset IEEEFLOAT
5140 On the @value{TARGET} family @samp{.double} emits 64-bit floating-point numbers
5141 in @sc{ieee} format.
5142 @end ifset
5143 @end ifclear
5145 @node Eject
5146 @section @code{.eject}
5148 @cindex @code{eject} directive
5149 @cindex new page, in listings
5150 @cindex page, in listings
5151 @cindex listing control: new page
5152 Force a page break at this point, when generating assembly listings.
5154 @node Else
5155 @section @code{.else}
5157 @cindex @code{else} directive
5158 @code{.else} is part of the @command{@value{AS}} support for conditional
5159 assembly; see @ref{If,,@code{.if}}.  It marks the beginning of a section
5160 of code to be assembled if the condition for the preceding @code{.if}
5161 was false.
5163 @node Elseif
5164 @section @code{.elseif}
5166 @cindex @code{elseif} directive
5167 @code{.elseif} is part of the @command{@value{AS}} support for conditional
5168 assembly; see @ref{If,,@code{.if}}.  It is shorthand for beginning a new
5169 @code{.if} block that would otherwise fill the entire @code{.else} section.
5171 @node End
5172 @section @code{.end}
5174 @cindex @code{end} directive
5175 @code{.end} marks the end of the assembly file.  @command{@value{AS}} does not
5176 process anything in the file past the @code{.end} directive.
5178 @ifset COFF
5179 @node Endef
5180 @section @code{.endef}
5182 @cindex @code{endef} directive
5183 This directive flags the end of a symbol definition begun with
5184 @code{.def}.
5185 @end ifset
5187 @node Endfunc
5188 @section @code{.endfunc}
5189 @cindex @code{endfunc} directive
5190 @code{.endfunc} marks the end of a function specified with @code{.func}.
5192 @node Endif
5193 @section @code{.endif}
5195 @cindex @code{endif} directive
5196 @code{.endif} is part of the @command{@value{AS}} support for conditional assembly;
5197 it marks the end of a block of code that is only assembled
5198 conditionally.  @xref{If,,@code{.if}}.
5200 @node Equ
5201 @section @code{.equ @var{symbol}, @var{expression}}
5203 @cindex @code{equ} directive
5204 @cindex assigning values to symbols
5205 @cindex symbols, assigning values to
5206 This directive sets the value of @var{symbol} to @var{expression}.
5207 It is synonymous with @samp{.set}; see @ref{Set,,@code{.set}}.
5209 @ifset HPPA
5210 The syntax for @code{equ} on the HPPA is
5211 @samp{@var{symbol} .equ @var{expression}}.
5212 @end ifset
5214 @ifset Z80
5215 The syntax for @code{equ} on the Z80 is
5216 @samp{@var{symbol} equ @var{expression}}.
5217 On the Z80 it is an error if @var{symbol} is already defined,
5218 but the symbol is not protected from later redefinition.
5219 Compare @ref{Equiv}.
5220 @end ifset
5222 @node Equiv
5223 @section @code{.equiv @var{symbol}, @var{expression}}
5224 @cindex @code{equiv} directive
5225 The @code{.equiv} directive is like @code{.equ} and @code{.set}, except that
5226 the assembler will signal an error if @var{symbol} is already defined.  Note a
5227 symbol which has been referenced but not actually defined is considered to be
5228 undefined.
5230 Except for the contents of the error message, this is roughly equivalent to
5231 @smallexample
5232 .ifdef SYM
5233 .err
5234 .endif
5235 .equ SYM,VAL
5236 @end smallexample
5237 plus it protects the symbol from later redefinition.
5239 @node Eqv
5240 @section @code{.eqv @var{symbol}, @var{expression}}
5241 @cindex @code{eqv} directive
5242 The @code{.eqv} directive is like @code{.equiv}, but no attempt is made to
5243 evaluate the expression or any part of it immediately.  Instead each time
5244 the resulting symbol is used in an expression, a snapshot of its current
5245 value is taken.
5247 @node Err
5248 @section @code{.err}
5249 @cindex @code{err} directive
5250 If @command{@value{AS}} assembles a @code{.err} directive, it will print an error
5251 message and, unless the @option{-Z} option was used, it will not generate an
5252 object file.  This can be used to signal an error in conditionally compiled code.
5254 @node Error
5255 @section @code{.error "@var{string}"}
5256 @cindex error directive
5258 Similarly to @code{.err}, this directive emits an error, but you can specify a
5259 string that will be emitted as the error message.  If you don't specify the
5260 message, it defaults to @code{".error directive invoked in source file"}.
5261 @xref{Errors, ,Error and Warning Messages}.
5263 @smallexample
5264  .error "This code has not been assembled and tested."
5265 @end smallexample
5267 @node Exitm
5268 @section @code{.exitm}
5269 Exit early from the current macro definition.  @xref{Macro}.
5271 @node Extern
5272 @section @code{.extern}
5274 @cindex @code{extern} directive
5275 @code{.extern} is accepted in the source program---for compatibility
5276 with other assemblers---but it is ignored.  @command{@value{AS}} treats
5277 all undefined symbols as external.
5279 @node Fail
5280 @section @code{.fail @var{expression}}
5282 @cindex @code{fail} directive
5283 Generates an error or a warning.  If the value of the @var{expression} is 500
5284 or more, @command{@value{AS}} will print a warning message.  If the value is less
5285 than 500, @command{@value{AS}} will print an error message.  The message will
5286 include the value of @var{expression}.  This can occasionally be useful inside
5287 complex nested macros or conditional assembly.
5289 @node File
5290 @section @code{.file}
5291 @cindex @code{file} directive
5293 @ifclear no-file-dir
5294 There are two different versions of the @code{.file} directive.  Targets
5295 that support DWARF2 line number information use the DWARF2 version of
5296 @code{.file}.  Other targets use the default version.
5298 @subheading Default Version
5300 @cindex logical file name
5301 @cindex file name, logical
5302 This version of the @code{.file} directive tells @command{@value{AS}} that we
5303 are about to start a new logical file.  The syntax is:
5305 @smallexample
5306 .file @var{string}
5307 @end smallexample
5309 @var{string} is the new file name.  In general, the filename is
5310 recognized whether or not it is surrounded by quotes @samp{"}; but if you wish
5311 to specify an empty file name, you must give the quotes--@code{""}.  This
5312 statement may go away in future: it is only recognized to be compatible with
5313 old @command{@value{AS}} programs.
5315 @subheading DWARF2 Version
5316 @end ifclear
5318 When emitting DWARF2 line number information, @code{.file} assigns filenames
5319 to the @code{.debug_line} file name table.  The syntax is:
5321 @smallexample
5322 .file @var{fileno} @var{filename}
5323 @end smallexample
5325 The @var{fileno} operand should be a unique positive integer to use as the
5326 index of the entry in the table.  The @var{filename} operand is a C string
5327 literal.
5329 The detail of filename indices is exposed to the user because the filename
5330 table is shared with the @code{.debug_info} section of the DWARF2 debugging
5331 information, and thus the user must know the exact indices that table
5332 entries will have.
5334 @node Fill
5335 @section @code{.fill @var{repeat} , @var{size} , @var{value}}
5337 @cindex @code{fill} directive
5338 @cindex writing patterns in memory
5339 @cindex patterns, writing in memory
5340 @var{repeat}, @var{size} and @var{value} are absolute expressions.
5341 This emits @var{repeat} copies of @var{size} bytes.  @var{Repeat}
5342 may be zero or more.  @var{Size} may be zero or more, but if it is
5343 more than 8, then it is deemed to have the value 8, compatible with
5344 other people's assemblers.  The contents of each @var{repeat} bytes
5345 is taken from an 8-byte number.  The highest order 4 bytes are
5346 zero.  The lowest order 4 bytes are @var{value} rendered in the
5347 byte-order of an integer on the computer @command{@value{AS}} is assembling for.
5348 Each @var{size} bytes in a repetition is taken from the lowest order
5349 @var{size} bytes of this number.  Again, this bizarre behavior is
5350 compatible with other people's assemblers.
5352 @var{size} and @var{value} are optional.
5353 If the second comma and @var{value} are absent, @var{value} is
5354 assumed zero.  If the first comma and following tokens are absent,
5355 @var{size} is assumed to be 1.
5357 @node Float
5358 @section @code{.float @var{flonums}}
5360 @cindex floating point numbers (single)
5361 @cindex @code{float} directive
5362 This directive assembles zero or more flonums, separated by commas.  It
5363 has the same effect as @code{.single}.
5364 @ifset GENERIC
5365 The exact kind of floating point numbers emitted depends on how
5366 @command{@value{AS}} is configured.
5367 @xref{Machine Dependencies}.
5368 @end ifset
5369 @ifclear GENERIC
5370 @ifset IEEEFLOAT
5371 On the @value{TARGET} family, @code{.float} emits 32-bit floating point numbers
5372 in @sc{ieee} format.
5373 @end ifset
5374 @end ifclear
5376 @node Func
5377 @section @code{.func @var{name}[,@var{label}]}
5378 @cindex @code{func} directive
5379 @code{.func} emits debugging information to denote function @var{name}, and
5380 is ignored unless the file is assembled with debugging enabled.
5381 Only @samp{--gstabs[+]} is currently supported.
5382 @var{label} is the entry point of the function and if omitted @var{name}
5383 prepended with the @samp{leading char} is used.
5384 @samp{leading char} is usually @code{_} or nothing, depending on the target.
5385 All functions are currently defined to have @code{void} return type.
5386 The function must be terminated with @code{.endfunc}.
5388 @node Global
5389 @section @code{.global @var{symbol}}, @code{.globl @var{symbol}}
5391 @cindex @code{global} directive
5392 @cindex symbol, making visible to linker
5393 @code{.global} makes the symbol visible to @code{@value{LD}}.  If you define
5394 @var{symbol} in your partial program, its value is made available to
5395 other partial programs that are linked with it.  Otherwise,
5396 @var{symbol} takes its attributes from a symbol of the same name
5397 from another file linked into the same program.
5399 Both spellings (@samp{.globl} and @samp{.global}) are accepted, for
5400 compatibility with other assemblers.
5402 @ifset HPPA
5403 On the HPPA, @code{.global} is not always enough to make it accessible to other
5404 partial programs.  You may need the HPPA-only @code{.EXPORT} directive as well.
5405 @xref{HPPA Directives, ,HPPA Assembler Directives}.
5406 @end ifset
5408 @ifset ELF
5409 @node Gnu_attribute
5410 @section @code{.gnu_attribute @var{tag},@var{value}}
5411 Record a @sc{gnu} object attribute for this file.  @xref{Object Attributes}.
5413 @node Hidden
5414 @section @code{.hidden @var{names}}
5416 @cindex @code{hidden} directive
5417 @cindex visibility
5418 This is one of the ELF visibility directives.  The other two are
5419 @code{.internal} (@pxref{Internal,,@code{.internal}}) and
5420 @code{.protected} (@pxref{Protected,,@code{.protected}}).
5422 This directive overrides the named symbols default visibility (which is set by
5423 their binding: local, global or weak).  The directive sets the visibility to
5424 @code{hidden} which means that the symbols are not visible to other components.
5425 Such symbols are always considered to be @code{protected} as well.
5426 @end ifset
5428 @node hword
5429 @section @code{.hword @var{expressions}}
5431 @cindex @code{hword} directive
5432 @cindex integers, 16-bit
5433 @cindex numbers, 16-bit
5434 @cindex sixteen bit integers
5435 This expects zero or more @var{expressions}, and emits
5436 a 16 bit number for each.
5438 @ifset GENERIC
5439 This directive is a synonym for @samp{.short}; depending on the target
5440 architecture, it may also be a synonym for @samp{.word}.
5441 @end ifset
5442 @ifclear GENERIC
5443 @ifset W32
5444 This directive is a synonym for @samp{.short}.
5445 @end ifset
5446 @ifset W16
5447 This directive is a synonym for both @samp{.short} and @samp{.word}.
5448 @end ifset
5449 @end ifclear
5451 @node Ident
5452 @section @code{.ident}
5454 @cindex @code{ident} directive
5456 This directive is used by some assemblers to place tags in object files.  The
5457 behavior of this directive varies depending on the target.  When using the
5458 a.out object file format, @command{@value{AS}} simply accepts the directive for
5459 source-file compatibility with existing assemblers, but does not emit anything
5460 for it.  When using COFF, comments are emitted to the @code{.comment} or
5461 @code{.rdata} section, depending on the target.  When using ELF, comments are
5462 emitted to the @code{.comment} section.
5464 @node If
5465 @section @code{.if @var{absolute expression}}
5467 @cindex conditional assembly
5468 @cindex @code{if} directive
5469 @code{.if} marks the beginning of a section of code which is only
5470 considered part of the source program being assembled if the argument
5471 (which must be an @var{absolute expression}) is non-zero.  The end of
5472 the conditional section of code must be marked by @code{.endif}
5473 (@pxref{Endif,,@code{.endif}}); optionally, you may include code for the
5474 alternative condition, flagged by @code{.else} (@pxref{Else,,@code{.else}}).
5475 If you have several conditions to check, @code{.elseif} may be used to avoid
5476 nesting blocks if/else within each subsequent @code{.else} block.
5478 The following variants of @code{.if} are also supported:
5479 @table @code
5480 @cindex @code{ifdef} directive
5481 @item .ifdef @var{symbol}
5482 Assembles the following section of code if the specified @var{symbol}
5483 has been defined.  Note a symbol which has been referenced but not yet defined
5484 is considered to be undefined.
5486 @cindex @code{ifb} directive
5487 @item .ifb @var{text}
5488 Assembles the following section of code if the operand is blank (empty).
5490 @cindex @code{ifc} directive
5491 @item .ifc @var{string1},@var{string2}
5492 Assembles the following section of code if the two strings are the same.  The
5493 strings may be optionally quoted with single quotes.  If they are not quoted,
5494 the first string stops at the first comma, and the second string stops at the
5495 end of the line.  Strings which contain whitespace should be quoted.  The
5496 string comparison is case sensitive.
5498 @cindex @code{ifeq} directive
5499 @item .ifeq @var{absolute expression}
5500 Assembles the following section of code if the argument is zero.
5502 @cindex @code{ifeqs} directive
5503 @item .ifeqs @var{string1},@var{string2}
5504 Another form of @code{.ifc}.  The strings must be quoted using double quotes.
5506 @cindex @code{ifge} directive
5507 @item .ifge @var{absolute expression}
5508 Assembles the following section of code if the argument is greater than or
5509 equal to zero.
5511 @cindex @code{ifgt} directive
5512 @item .ifgt @var{absolute expression}
5513 Assembles the following section of code if the argument is greater than zero.
5515 @cindex @code{ifle} directive
5516 @item .ifle @var{absolute expression}
5517 Assembles the following section of code if the argument is less than or equal
5518 to zero.
5520 @cindex @code{iflt} directive
5521 @item .iflt @var{absolute expression}
5522 Assembles the following section of code if the argument is less than zero.
5524 @cindex @code{ifnb} directive
5525 @item .ifnb @var{text}
5526 Like @code{.ifb}, but the sense of the test is reversed: this assembles the
5527 following section of code if the operand is non-blank (non-empty).
5529 @cindex @code{ifnc} directive
5530 @item .ifnc @var{string1},@var{string2}.
5531 Like @code{.ifc}, but the sense of the test is reversed: this assembles the
5532 following section of code if the two strings are not the same.
5534 @cindex @code{ifndef} directive
5535 @cindex @code{ifnotdef} directive
5536 @item .ifndef @var{symbol}
5537 @itemx .ifnotdef @var{symbol}
5538 Assembles the following section of code if the specified @var{symbol}
5539 has not been defined.  Both spelling variants are equivalent.  Note a symbol
5540 which has been referenced but not yet defined is considered to be undefined.
5542 @cindex @code{ifne} directive
5543 @item .ifne @var{absolute expression}
5544 Assembles the following section of code if the argument is not equal to zero
5545 (in other words, this is equivalent to @code{.if}).
5547 @cindex @code{ifnes} directive
5548 @item .ifnes @var{string1},@var{string2}
5549 Like @code{.ifeqs}, but the sense of the test is reversed: this assembles the
5550 following section of code if the two strings are not the same.
5551 @end table
5553 @node Incbin
5554 @section @code{.incbin "@var{file}"[,@var{skip}[,@var{count}]]}
5556 @cindex @code{incbin} directive
5557 @cindex binary files, including
5558 The @code{incbin} directive includes @var{file} verbatim at the current
5559 location. You can control the search paths used with the @samp{-I} command-line
5560 option (@pxref{Invoking,,Command-Line Options}).  Quotation marks are required
5561 around @var{file}.
5563 The @var{skip} argument skips a number of bytes from the start of the
5564 @var{file}.  The @var{count} argument indicates the maximum number of bytes to
5565 read.  Note that the data is not aligned in any way, so it is the user's
5566 responsibility to make sure that proper alignment is provided both before and
5567 after the @code{incbin} directive.
5569 @node Include
5570 @section @code{.include "@var{file}"}
5572 @cindex @code{include} directive
5573 @cindex supporting files, including
5574 @cindex files, including
5575 This directive provides a way to include supporting files at specified
5576 points in your source program.  The code from @var{file} is assembled as
5577 if it followed the point of the @code{.include}; when the end of the
5578 included file is reached, assembly of the original file continues.  You
5579 can control the search paths used with the @samp{-I} command-line option
5580 (@pxref{Invoking,,Command-Line Options}).  Quotation marks are required
5581 around @var{file}.
5583 @node Int
5584 @section @code{.int @var{expressions}}
5586 @cindex @code{int} directive
5587 @cindex integers, 32-bit
5588 Expect zero or more @var{expressions}, of any section, separated by commas.
5589 For each expression, emit a number that, at run time, is the value of that
5590 expression.  The byte order and bit size of the number depends on what kind
5591 of target the assembly is for.
5593 @ifclear GENERIC
5594 @ifset H8
5595 On most forms of the H8/300, @code{.int} emits 16-bit
5596 integers.  On the H8/300H and the Renesas SH, however, @code{.int} emits
5597 32-bit integers.
5598 @end ifset
5599 @end ifclear
5601 @ifset ELF
5602 @node Internal
5603 @section @code{.internal @var{names}}
5605 @cindex @code{internal} directive
5606 @cindex visibility
5607 This is one of the ELF visibility directives.  The other two are
5608 @code{.hidden} (@pxref{Hidden,,@code{.hidden}}) and
5609 @code{.protected} (@pxref{Protected,,@code{.protected}}).
5611 This directive overrides the named symbols default visibility (which is set by
5612 their binding: local, global or weak).  The directive sets the visibility to
5613 @code{internal} which means that the symbols are considered to be @code{hidden}
5614 (i.e., not visible to other components), and that some extra, processor specific
5615 processing must also be performed upon the  symbols as well.
5616 @end ifset
5618 @node Irp
5619 @section @code{.irp @var{symbol},@var{values}}@dots{}
5621 @cindex @code{irp} directive
5622 Evaluate a sequence of statements assigning different values to @var{symbol}.
5623 The sequence of statements starts at the @code{.irp} directive, and is
5624 terminated by an @code{.endr} directive.  For each @var{value}, @var{symbol} is
5625 set to @var{value}, and the sequence of statements is assembled.  If no
5626 @var{value} is listed, the sequence of statements is assembled once, with
5627 @var{symbol} set to the null string.  To refer to @var{symbol} within the
5628 sequence of statements, use @var{\symbol}.
5630 For example, assembling
5632 @example
5633         .irp    param,1,2,3
5634         move    d\param,sp@@-
5635         .endr
5636 @end example
5638 is equivalent to assembling
5640 @example
5641         move    d1,sp@@-
5642         move    d2,sp@@-
5643         move    d3,sp@@-
5644 @end example
5646 For some caveats with the spelling of @var{symbol}, see also @ref{Macro}.
5648 @node Irpc
5649 @section @code{.irpc @var{symbol},@var{values}}@dots{}
5651 @cindex @code{irpc} directive
5652 Evaluate a sequence of statements assigning different values to @var{symbol}.
5653 The sequence of statements starts at the @code{.irpc} directive, and is
5654 terminated by an @code{.endr} directive.  For each character in @var{value},
5655 @var{symbol} is set to the character, and the sequence of statements is
5656 assembled.  If no @var{value} is listed, the sequence of statements is
5657 assembled once, with @var{symbol} set to the null string.  To refer to
5658 @var{symbol} within the sequence of statements, use @var{\symbol}.
5660 For example, assembling
5662 @example
5663         .irpc    param,123
5664         move    d\param,sp@@-
5665         .endr
5666 @end example
5668 is equivalent to assembling
5670 @example
5671         move    d1,sp@@-
5672         move    d2,sp@@-
5673         move    d3,sp@@-
5674 @end example
5676 For some caveats with the spelling of @var{symbol}, see also the discussion
5677 at @xref{Macro}.
5679 @node Lcomm
5680 @section @code{.lcomm @var{symbol} , @var{length}}
5682 @cindex @code{lcomm} directive
5683 @cindex local common symbols
5684 @cindex symbols, local common
5685 Reserve @var{length} (an absolute expression) bytes for a local common
5686 denoted by @var{symbol}.  The section and value of @var{symbol} are
5687 those of the new local common.  The addresses are allocated in the bss
5688 section, so that at run-time the bytes start off zeroed.  @var{Symbol}
5689 is not declared global (@pxref{Global,,@code{.global}}), so is normally
5690 not visible to @code{@value{LD}}.
5692 @ifset GENERIC
5693 Some targets permit a third argument to be used with @code{.lcomm}.  This
5694 argument specifies the desired alignment of the symbol in the bss section.
5695 @end ifset
5697 @ifset HPPA
5698 The syntax for @code{.lcomm} differs slightly on the HPPA.  The syntax is
5699 @samp{@var{symbol} .lcomm, @var{length}}; @var{symbol} is optional.
5700 @end ifset
5702 @node Lflags
5703 @section @code{.lflags}
5705 @cindex @code{lflags} directive (ignored)
5706 @command{@value{AS}} accepts this directive, for compatibility with other
5707 assemblers, but ignores it.
5709 @ifclear no-line-dir
5710 @node Line
5711 @section @code{.line @var{line-number}}
5713 @cindex @code{line} directive
5714 @cindex logical line number
5715 @ifset aout
5716 Change the logical line number.  @var{line-number} must be an absolute
5717 expression.  The next line has that logical line number.  Therefore any other
5718 statements on the current line (after a statement separator character) are
5719 reported as on logical line number @var{line-number} @minus{} 1.  One day
5720 @command{@value{AS}} will no longer support this directive: it is recognized only
5721 for compatibility with existing assembler programs.
5722 @end ifset
5724 Even though this is a directive associated with the @code{a.out} or
5725 @code{b.out} object-code formats, @command{@value{AS}} still recognizes it
5726 when producing COFF output, and treats @samp{.line} as though it
5727 were the COFF @samp{.ln} @emph{if} it is found outside a
5728 @code{.def}/@code{.endef} pair.
5730 Inside a @code{.def}, @samp{.line} is, instead, one of the directives
5731 used by compilers to generate auxiliary symbol information for
5732 debugging.
5733 @end ifclear
5735 @node Linkonce
5736 @section @code{.linkonce [@var{type}]}
5737 @cindex COMDAT
5738 @cindex @code{linkonce} directive
5739 @cindex common sections
5740 Mark the current section so that the linker only includes a single copy of it.
5741 This may be used to include the same section in several different object files,
5742 but ensure that the linker will only include it once in the final output file.
5743 The @code{.linkonce} pseudo-op must be used for each instance of the section.
5744 Duplicate sections are detected based on the section name, so it should be
5745 unique.
5747 This directive is only supported by a few object file formats; as of this
5748 writing, the only object file format which supports it is the Portable
5749 Executable format used on Windows NT.
5751 The @var{type} argument is optional.  If specified, it must be one of the
5752 following strings.  For example:
5753 @smallexample
5754 .linkonce same_size
5755 @end smallexample
5756 Not all types may be supported on all object file formats.
5758 @table @code
5759 @item discard
5760 Silently discard duplicate sections.  This is the default.
5762 @item one_only
5763 Warn if there are duplicate sections, but still keep only one copy.
5765 @item same_size
5766 Warn if any of the duplicates have different sizes.
5768 @item same_contents
5769 Warn if any of the duplicates do not have exactly the same contents.
5770 @end table
5772 @node List
5773 @section @code{.list}
5775 @cindex @code{list} directive
5776 @cindex listing control, turning on
5777 Control (in conjunction with the @code{.nolist} directive) whether or
5778 not assembly listings are generated.  These two directives maintain an
5779 internal counter (which is zero initially).   @code{.list} increments the
5780 counter, and @code{.nolist} decrements it.  Assembly listings are
5781 generated whenever the counter is greater than zero.
5783 By default, listings are disabled.  When you enable them (with the
5784 @samp{-a} command-line option; @pxref{Invoking,,Command-Line Options}),
5785 the initial value of the listing counter is one.
5787 @node Ln
5788 @section @code{.ln @var{line-number}}
5790 @cindex @code{ln} directive
5791 @ifclear no-line-dir
5792 @samp{.ln} is a synonym for @samp{.line}.
5793 @end ifclear
5794 @ifset no-line-dir
5795 Tell @command{@value{AS}} to change the logical line number.  @var{line-number}
5796 must be an absolute expression.  The next line has that logical
5797 line number, so any other statements on the current line (after a
5798 statement separator character @code{;}) are reported as on logical
5799 line number @var{line-number} @minus{} 1.
5800 @end ifset
5802 @node Loc
5803 @section @code{.loc @var{fileno} @var{lineno} [@var{column}] [@var{options}]}
5804 @cindex @code{loc} directive
5805 When emitting DWARF2 line number information,
5806 the @code{.loc} directive will add a row to the @code{.debug_line} line
5807 number matrix corresponding to the immediately following assembly
5808 instruction.  The @var{fileno}, @var{lineno}, and optional @var{column}
5809 arguments will be applied to the @code{.debug_line} state machine before
5810 the row is added.
5812 The @var{options} are a sequence of the following tokens in any order:
5814 @table @code
5815 @item basic_block
5816 This option will set the @code{basic_block} register in the
5817 @code{.debug_line} state machine to @code{true}.
5819 @item prologue_end
5820 This option will set the @code{prologue_end} register in the
5821 @code{.debug_line} state machine to @code{true}.
5823 @item epilogue_begin
5824 This option will set the @code{epilogue_begin} register in the
5825 @code{.debug_line} state machine to @code{true}.
5827 @item is_stmt @var{value}
5828 This option will set the @code{is_stmt} register in the
5829 @code{.debug_line} state machine to @code{value}, which must be
5830 either 0 or 1.
5832 @item isa @var{value}
5833 This directive will set the @code{isa} register in the @code{.debug_line}
5834 state machine to @var{value}, which must be an unsigned integer.
5836 @item discriminator @var{value}
5837 This directive will set the @code{discriminator} register in the @code{.debug_line}
5838 state machine to @var{value}, which must be an unsigned integer.
5840 @item view @var{value}
5841 This option causes a row to be added to @code{.debug_line} in reference to the
5842 current address (which might not be the same as that of the following assembly
5843 instruction), and to associate @var{value} with the @code{view} register in the
5844 @code{.debug_line} state machine.  If @var{value} is a label, both the
5845 @code{view} register and the label are set to the number of prior @code{.loc}
5846 directives at the same program location.  If @var{value} is the literal
5847 @code{0}, the @code{view} register is set to zero, and the assembler asserts
5848 that there aren't any prior @code{.loc} directives at the same program
5849 location.  If @var{value} is the literal @code{-0}, the assembler arrange for
5850 the @code{view} register to be reset in this row, even if there are prior
5851 @code{.loc} directives at the same program location.
5853 @end table
5855 @node Loc_mark_labels
5856 @section @code{.loc_mark_labels @var{enable}}
5857 @cindex @code{loc_mark_labels} directive
5858 When emitting DWARF2 line number information,
5859 the @code{.loc_mark_labels} directive makes the assembler emit an entry
5860 to the @code{.debug_line} line number matrix with the @code{basic_block}
5861 register in the state machine set whenever a code label is seen.
5862 The @var{enable} argument should be either 1 or 0, to enable or disable
5863 this function respectively.
5865 @ifset ELF
5866 @node Local
5867 @section @code{.local @var{names}}
5869 @cindex @code{local} directive
5870 This directive, which is available for ELF targets, marks each symbol in
5871 the comma-separated list of @code{names} as a local symbol so that it
5872 will not be externally visible.  If the symbols do not already exist,
5873 they will be created.
5875 For targets where the @code{.lcomm} directive (@pxref{Lcomm}) does not
5876 accept an alignment argument, which is the case for most ELF targets,
5877 the @code{.local} directive can be used in combination with @code{.comm}
5878 (@pxref{Comm}) to define aligned local common data.
5879 @end ifset
5881 @node Long
5882 @section @code{.long @var{expressions}}
5884 @cindex @code{long} directive
5885 @code{.long} is the same as @samp{.int}.  @xref{Int,,@code{.int}}.
5887 @ignore
5888 @c no one seems to know what this is for or whether this description is
5889 @c what it really ought to do
5890 @node Lsym
5891 @section @code{.lsym @var{symbol}, @var{expression}}
5893 @cindex @code{lsym} directive
5894 @cindex symbol, not referenced in assembly
5895 @code{.lsym} creates a new symbol named @var{symbol}, but does not put it in
5896 the hash table, ensuring it cannot be referenced by name during the
5897 rest of the assembly.  This sets the attributes of the symbol to be
5898 the same as the expression value:
5899 @smallexample
5900 @var{other} = @var{descriptor} = 0
5901 @var{type} = @r{(section of @var{expression})}
5902 @var{value} = @var{expression}
5903 @end smallexample
5904 @noindent
5905 The new symbol is not flagged as external.
5906 @end ignore
5908 @node Macro
5909 @section @code{.macro}
5911 @cindex macros
5912 The commands @code{.macro} and @code{.endm} allow you to define macros that
5913 generate assembly output.  For example, this definition specifies a macro
5914 @code{sum} that puts a sequence of numbers into memory:
5916 @example
5917         .macro  sum from=0, to=5
5918         .long   \from
5919         .if     \to-\from
5920         sum     "(\from+1)",\to
5921         .endif
5922         .endm
5923 @end example
5925 @noindent
5926 With that definition, @samp{SUM 0,5} is equivalent to this assembly input:
5928 @example
5929         .long   0
5930         .long   1
5931         .long   2
5932         .long   3
5933         .long   4
5934         .long   5
5935 @end example
5937 @ftable @code
5938 @item .macro @var{macname}
5939 @itemx .macro @var{macname} @var{macargs} @dots{}
5940 @cindex @code{macro} directive
5941 Begin the definition of a macro called @var{macname}.  If your macro
5942 definition requires arguments, specify their names after the macro name,
5943 separated by commas or spaces.  You can qualify the macro argument to
5944 indicate whether all invocations must specify a non-blank value (through
5945 @samp{:@code{req}}), or whether it takes all of the remaining arguments
5946 (through @samp{:@code{vararg}}).  You can supply a default value for any
5947 macro argument by following the name with @samp{=@var{deflt}}.  You
5948 cannot define two macros with the same @var{macname} unless it has been
5949 subject to the @code{.purgem} directive (@pxref{Purgem}) between the two
5950 definitions.  For example, these are all valid @code{.macro} statements:
5952 @table @code
5953 @item .macro comm
5954 Begin the definition of a macro called @code{comm}, which takes no
5955 arguments.
5957 @item  .macro plus1 p, p1
5958 @itemx .macro plus1 p p1
5959 Either statement begins the definition of a macro called @code{plus1},
5960 which takes two arguments; within the macro definition, write
5961 @samp{\p} or @samp{\p1} to evaluate the arguments.
5963 @item .macro reserve_str p1=0 p2
5964 Begin the definition of a macro called @code{reserve_str}, with two
5965 arguments.  The first argument has a default value, but not the second.
5966 After the definition is complete, you can call the macro either as
5967 @samp{reserve_str @var{a},@var{b}} (with @samp{\p1} evaluating to
5968 @var{a} and @samp{\p2} evaluating to @var{b}), or as @samp{reserve_str
5969 ,@var{b}} (with @samp{\p1} evaluating as the default, in this case
5970 @samp{0}, and @samp{\p2} evaluating to @var{b}).
5972 @item .macro m p1:req, p2=0, p3:vararg
5973 Begin the definition of a macro called @code{m}, with at least three
5974 arguments.  The first argument must always have a value specified, but
5975 not the second, which instead has a default value. The third formal
5976 will get assigned all remaining arguments specified at invocation time.
5978 When you call a macro, you can specify the argument values either by
5979 position, or by keyword.  For example, @samp{sum 9,17} is equivalent to
5980 @samp{sum to=17, from=9}.
5982 @end table
5984 Note that since each of the @var{macargs} can be an identifier exactly
5985 as any other one permitted by the target architecture, there may be
5986 occasional problems if the target hand-crafts special meanings to certain
5987 characters when they occur in a special position.  For example, if the colon
5988 (@code{:}) is generally permitted to be part of a symbol name, but the
5989 architecture specific code special-cases it when occurring as the final
5990 character of a symbol (to denote a label), then the macro parameter
5991 replacement code will have no way of knowing that and consider the whole
5992 construct (including the colon) an identifier, and check only this
5993 identifier for being the subject to parameter substitution.  So for example
5994 this macro definition:
5996 @example
5997         .macro label l
5999         .endm
6000 @end example
6002 might not work as expected.  Invoking @samp{label foo} might not create a label
6003 called @samp{foo} but instead just insert the text @samp{\l:} into the
6004 assembler source, probably generating an error about an unrecognised
6005 identifier.
6007 Similarly problems might occur with the period character (@samp{.})
6008 which is often allowed inside opcode names (and hence identifier names).  So
6009 for example constructing a macro to build an opcode from a base name and a
6010 length specifier like this:
6012 @example
6013         .macro opcode base length
6014         \base.\length
6015         .endm
6016 @end example
6018 and invoking it as @samp{opcode store l} will not create a @samp{store.l}
6019 instruction but instead generate some kind of error as the assembler tries to
6020 interpret the text @samp{\base.\length}.
6022 There are several possible ways around this problem:
6024 @table @code
6025 @item Insert white space
6026 If it is possible to use white space characters then this is the simplest
6027 solution.  eg:
6029 @example
6030         .macro label l
6031 \l :
6032         .endm
6033 @end example
6035 @item Use @samp{\()}
6036 The string @samp{\()} can be used to separate the end of a macro argument from
6037 the following text.  eg:
6039 @example
6040         .macro opcode base length
6041         \base\().\length
6042         .endm
6043 @end example
6045 @item Use the alternate macro syntax mode
6046 In the alternative macro syntax mode the ampersand character (@samp{&}) can be
6047 used as a separator.  eg:
6049 @example
6050         .altmacro
6051         .macro label l
6053         .endm
6054 @end example
6055 @end table
6057 Note: this problem of correctly identifying string parameters to pseudo ops
6058 also applies to the identifiers used in @code{.irp} (@pxref{Irp})
6059 and @code{.irpc} (@pxref{Irpc}) as well.
6061 @item .endm
6062 @cindex @code{endm} directive
6063 Mark the end of a macro definition.
6065 @item .exitm
6066 @cindex @code{exitm} directive
6067 Exit early from the current macro definition.
6069 @cindex number of macros executed
6070 @cindex macros, count executed
6071 @item \@@
6072 @command{@value{AS}} maintains a counter of how many macros it has
6073 executed in this pseudo-variable; you can copy that number to your
6074 output with @samp{\@@}, but @emph{only within a macro definition}.
6076 @item LOCAL @var{name} [ , @dots{} ]
6077 @emph{Warning: @code{LOCAL} is only available if you select ``alternate
6078 macro syntax'' with @samp{--alternate} or @code{.altmacro}.}
6079 @xref{Altmacro,,@code{.altmacro}}.
6080 @end ftable
6082 @node MRI
6083 @section @code{.mri @var{val}}
6085 @cindex @code{mri} directive
6086 @cindex MRI mode, temporarily
6087 If @var{val} is non-zero, this tells @command{@value{AS}} to enter MRI mode.  If
6088 @var{val} is zero, this tells @command{@value{AS}} to exit MRI mode.  This change
6089 affects code assembled until the next @code{.mri} directive, or until the end
6090 of the file.  @xref{M, MRI mode, MRI mode}.
6092 @node Noaltmacro
6093 @section @code{.noaltmacro}
6094 Disable alternate macro mode.  @xref{Altmacro}.
6096 @node Nolist
6097 @section @code{.nolist}
6099 @cindex @code{nolist} directive
6100 @cindex listing control, turning off
6101 Control (in conjunction with the @code{.list} directive) whether or
6102 not assembly listings are generated.  These two directives maintain an
6103 internal counter (which is zero initially).   @code{.list} increments the
6104 counter, and @code{.nolist} decrements it.  Assembly listings are
6105 generated whenever the counter is greater than zero.
6107 @node Nops
6108 @section @code{.nops @var{size}[, @var{control}]}
6110 @cindex @code{nops} directive
6111 @cindex filling memory with no-op instructions
6112 This directive emits @var{size} bytes filled with no-op instructions.
6113 @var{size} is absolute expression, which must be a positve value.
6114 @var{control} controls how no-op instructions should be generated.  If
6115 the comma and @var{control} are omitted, @var{control} is assumed to be
6116 zero.
6118 Note: For Intel 80386 and AMD x86-64 targets, @var{control} specifies
6119 the size limit of a no-op instruction.  The valid values of @var{control}
6120 are between 0 and 4 in 16-bit mode, between 0 and 7 when tuning for
6121 older processors in 32-bit mode, between 0 and 11 in 64-bit mode or when
6122 tuning for newer processors in 32-bit mode.  When 0 is used, the no-op
6123 instruction size limit is set to the maximum supported size.
6125 @node Octa
6126 @section @code{.octa @var{bignums}}
6128 @c FIXME: double size emitted for "octa" on some?  Or warn?
6129 @cindex @code{octa} directive
6130 @cindex integer, 16-byte
6131 @cindex sixteen byte integer
6132 This directive expects zero or more bignums, separated by commas.  For each
6133 bignum, it emits a 16-byte integer.
6135 The term ``octa'' comes from contexts in which a ``word'' is two bytes;
6136 hence @emph{octa}-word for 16 bytes.
6138 @node Offset
6139 @section @code{.offset @var{loc}}
6141 @cindex @code{offset} directive
6142 Set the location counter to @var{loc} in the absolute section.  @var{loc} must
6143 be an absolute expression.  This directive may be useful for defining
6144 symbols with absolute values.  Do not confuse it with the @code{.org}
6145 directive.
6147 @node Org
6148 @section @code{.org @var{new-lc} , @var{fill}}
6150 @cindex @code{org} directive
6151 @cindex location counter, advancing
6152 @cindex advancing location counter
6153 @cindex current address, advancing
6154 Advance the location counter of the current section to
6155 @var{new-lc}.  @var{new-lc} is either an absolute expression or an
6156 expression with the same section as the current subsection.  That is,
6157 you can't use @code{.org} to cross sections: if @var{new-lc} has the
6158 wrong section, the @code{.org} directive is ignored.  To be compatible
6159 with former assemblers, if the section of @var{new-lc} is absolute,
6160 @command{@value{AS}} issues a warning, then pretends the section of @var{new-lc}
6161 is the same as the current subsection.
6163 @code{.org} may only increase the location counter, or leave it
6164 unchanged; you cannot use @code{.org} to move the location counter
6165 backwards.
6167 @c double negative used below "not undefined" because this is a specific
6168 @c reference to "undefined" (as SEG_UNKNOWN is called in this manual)
6169 @c section. doc@cygnus.com 18feb91
6170 Because @command{@value{AS}} tries to assemble programs in one pass, @var{new-lc}
6171 may not be undefined.  If you really detest this restriction we eagerly await
6172 a chance to share your improved assembler.
6174 Beware that the origin is relative to the start of the section, not
6175 to the start of the subsection.  This is compatible with other
6176 people's assemblers.
6178 When the location counter (of the current subsection) is advanced, the
6179 intervening bytes are filled with @var{fill} which should be an
6180 absolute expression.  If the comma and @var{fill} are omitted,
6181 @var{fill} defaults to zero.
6183 @node P2align
6184 @section @code{.p2align[wl] @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
6186 @cindex padding the location counter given a power of two
6187 @cindex @code{p2align} directive
6188 Pad the location counter (in the current subsection) to a particular
6189 storage boundary.  The first expression (which must be absolute) is the
6190 number of low-order zero bits the location counter must have after
6191 advancement.  For example @samp{.p2align 3} advances the location
6192 counter until it a multiple of 8.  If the location counter is already a
6193 multiple of 8, no change is needed.
6195 The second expression (also absolute) gives the fill value to be stored in the
6196 padding bytes.  It (and the comma) may be omitted.  If it is omitted, the
6197 padding bytes are normally zero.  However, on most systems, if the section is
6198 marked as containing code and the fill value is omitted, the space is filled
6199 with no-op instructions.
6201 The third expression is also absolute, and is also optional.  If it is present,
6202 it is the maximum number of bytes that should be skipped by this alignment
6203 directive.  If doing the alignment would require skipping more bytes than the
6204 specified maximum, then the alignment is not done at all.  You can omit the
6205 fill value (the second argument) entirely by simply using two commas after the
6206 required alignment; this can be useful if you want the alignment to be filled
6207 with no-op instructions when appropriate.
6209 @cindex @code{p2alignw} directive
6210 @cindex @code{p2alignl} directive
6211 The @code{.p2alignw} and @code{.p2alignl} directives are variants of the
6212 @code{.p2align} directive.  The @code{.p2alignw} directive treats the fill
6213 pattern as a two byte word value.  The @code{.p2alignl} directives treats the
6214 fill pattern as a four byte longword value.  For example, @code{.p2alignw
6215 2,0x368d} will align to a multiple of 4.  If it skips two bytes, they will be
6216 filled in with the value 0x368d (the exact placement of the bytes depends upon
6217 the endianness of the processor).  If it skips 1 or 3 bytes, the fill value is
6218 undefined.
6220 @ifset ELF
6221 @node PopSection
6222 @section @code{.popsection}
6224 @cindex @code{popsection} directive
6225 @cindex Section Stack
6226 This is one of the ELF section stack manipulation directives.  The others are
6227 @code{.section} (@pxref{Section}), @code{.subsection} (@pxref{SubSection}),
6228 @code{.pushsection} (@pxref{PushSection}), and @code{.previous}
6229 (@pxref{Previous}).
6231 This directive replaces the current section (and subsection) with the top
6232 section (and subsection) on the section stack.  This section is popped off the
6233 stack.
6234 @end ifset
6236 @ifset ELF
6237 @node Previous
6238 @section @code{.previous}
6240 @cindex @code{previous} directive
6241 @cindex Section Stack
6242 This is one of the ELF section stack manipulation directives.  The others are
6243 @code{.section} (@pxref{Section}), @code{.subsection} (@pxref{SubSection}),
6244 @code{.pushsection} (@pxref{PushSection}), and @code{.popsection}
6245 (@pxref{PopSection}).
6247 This directive swaps the current section (and subsection) with most recently
6248 referenced section/subsection pair prior to this one.  Multiple
6249 @code{.previous} directives in a row will flip between two sections (and their
6250 subsections).  For example:
6252 @smallexample
6253 .section A
6254  .subsection 1
6255   .word 0x1234
6256  .subsection 2
6257   .word 0x5678
6258 .previous
6259  .word 0x9abc
6260 @end smallexample
6262 Will place 0x1234 and 0x9abc into subsection 1 and 0x5678 into subsection 2 of
6263 section A.  Whilst:
6265 @smallexample
6266 .section A
6267 .subsection 1
6268   # Now in section A subsection 1
6269   .word 0x1234
6270 .section B
6271 .subsection 0
6272   # Now in section B subsection 0
6273   .word 0x5678
6274 .subsection 1
6275   # Now in section B subsection 1
6276   .word 0x9abc
6277 .previous
6278   # Now in section B subsection 0
6279   .word 0xdef0
6280 @end smallexample
6282 Will place 0x1234 into section A, 0x5678 and 0xdef0 into subsection 0 of
6283 section B and 0x9abc into subsection 1 of section B.
6285 In terms of the section stack, this directive swaps the current section with
6286 the top section on the section stack.
6287 @end ifset
6289 @node Print
6290 @section @code{.print @var{string}}
6292 @cindex @code{print} directive
6293 @command{@value{AS}} will print @var{string} on the standard output during
6294 assembly.  You must put @var{string} in double quotes.
6296 @ifset ELF
6297 @node Protected
6298 @section @code{.protected @var{names}}
6300 @cindex @code{protected} directive
6301 @cindex visibility
6302 This is one of the ELF visibility directives.  The other two are
6303 @code{.hidden} (@pxref{Hidden}) and @code{.internal} (@pxref{Internal}).
6305 This directive overrides the named symbols default visibility (which is set by
6306 their binding: local, global or weak).  The directive sets the visibility to
6307 @code{protected} which means that any references to the symbols from within the
6308 components that defines them must be resolved to the definition in that
6309 component, even if a definition in another component would normally preempt
6310 this.
6311 @end ifset
6313 @node Psize
6314 @section @code{.psize @var{lines} , @var{columns}}
6316 @cindex @code{psize} directive
6317 @cindex listing control: paper size
6318 @cindex paper size, for listings
6319 Use this directive to declare the number of lines---and, optionally, the
6320 number of columns---to use for each page, when generating listings.
6322 If you do not use @code{.psize}, listings use a default line-count
6323 of 60.  You may omit the comma and @var{columns} specification; the
6324 default width is 200 columns.
6326 @command{@value{AS}} generates formfeeds whenever the specified number of
6327 lines is exceeded (or whenever you explicitly request one, using
6328 @code{.eject}).
6330 If you specify @var{lines} as @code{0}, no formfeeds are generated save
6331 those explicitly specified with @code{.eject}.
6333 @node Purgem
6334 @section @code{.purgem @var{name}}
6336 @cindex @code{purgem} directive
6337 Undefine the macro @var{name}, so that later uses of the string will not be
6338 expanded.  @xref{Macro}.
6340 @ifset ELF
6341 @node PushSection
6342 @section @code{.pushsection @var{name} [, @var{subsection}] [, "@var{flags}"[, @@@var{type}[,@var{arguments}]]]}
6344 @cindex @code{pushsection} directive
6345 @cindex Section Stack
6346 This is one of the ELF section stack manipulation directives.  The others are
6347 @code{.section} (@pxref{Section}), @code{.subsection} (@pxref{SubSection}),
6348 @code{.popsection} (@pxref{PopSection}), and @code{.previous}
6349 (@pxref{Previous}).
6351 This directive pushes the current section (and subsection) onto the
6352 top of the section stack, and then replaces the current section and
6353 subsection with @code{name} and @code{subsection}. The optional
6354 @code{flags}, @code{type} and @code{arguments} are treated the same
6355 as in the @code{.section} (@pxref{Section}) directive.
6356 @end ifset
6358 @node Quad
6359 @section @code{.quad @var{bignums}}
6361 @cindex @code{quad} directive
6362 @code{.quad} expects zero or more bignums, separated by commas.  For
6363 each bignum, it emits
6364 @ifclear bignum-16
6365 an 8-byte integer.  If the bignum won't fit in 8 bytes, it prints a
6366 warning message; and just takes the lowest order 8 bytes of the bignum.
6367 @cindex eight-byte integer
6368 @cindex integer, 8-byte
6370 The term ``quad'' comes from contexts in which a ``word'' is two bytes;
6371 hence @emph{quad}-word for 8 bytes.
6372 @end ifclear
6373 @ifset bignum-16
6374 a 16-byte integer.  If the bignum won't fit in 16 bytes, it prints a
6375 warning message; and just takes the lowest order 16 bytes of the bignum.
6376 @cindex sixteen-byte integer
6377 @cindex integer, 16-byte
6378 @end ifset
6380 @node Reloc
6381 @section @code{.reloc @var{offset}, @var{reloc_name}[, @var{expression}]}
6383 @cindex @code{reloc} directive
6384 Generate a relocation at @var{offset} of type @var{reloc_name} with value
6385 @var{expression}.  If @var{offset} is a number, the relocation is generated in
6386 the current section.  If @var{offset} is an expression that resolves to a
6387 symbol plus offset, the relocation is generated in the given symbol's section.
6388 @var{expression}, if present, must resolve to a symbol plus addend or to an
6389 absolute value, but note that not all targets support an addend.  e.g. ELF REL
6390 targets such as i386 store an addend in the section contents rather than in the
6391 relocation.  This low level interface does not support addends stored in the
6392 section.
6394 @node Rept
6395 @section @code{.rept @var{count}}
6397 @cindex @code{rept} directive
6398 Repeat the sequence of lines between the @code{.rept} directive and the next
6399 @code{.endr} directive @var{count} times.
6401 For example, assembling
6403 @example
6404         .rept   3
6405         .long   0
6406         .endr
6407 @end example
6409 is equivalent to assembling
6411 @example
6412         .long   0
6413         .long   0
6414         .long   0
6415 @end example
6417 A count of zero is allowed, but nothing is generated.  Negative counts are not
6418 allowed and if encountered will be treated as if they were zero.
6420 @node Sbttl
6421 @section @code{.sbttl "@var{subheading}"}
6423 @cindex @code{sbttl} directive
6424 @cindex subtitles for listings
6425 @cindex listing control: subtitle
6426 Use @var{subheading} as the title (third line, immediately after the
6427 title line) when generating assembly listings.
6429 This directive affects subsequent pages, as well as the current page if
6430 it appears within ten lines of the top of a page.
6432 @ifset COFF
6433 @node Scl
6434 @section @code{.scl @var{class}}
6436 @cindex @code{scl} directive
6437 @cindex symbol storage class (COFF)
6438 @cindex COFF symbol storage class
6439 Set the storage-class value for a symbol.  This directive may only be
6440 used inside a @code{.def}/@code{.endef} pair.  Storage class may flag
6441 whether a symbol is static or external, or it may record further
6442 symbolic debugging information.
6443 @end ifset
6445 @ifset COFF-ELF
6446 @node Section
6447 @section @code{.section @var{name}}
6449 @cindex named section
6450 Use the @code{.section} directive to assemble the following code into a section
6451 named @var{name}.
6453 This directive is only supported for targets that actually support arbitrarily
6454 named sections; on @code{a.out} targets, for example, it is not accepted, even
6455 with a standard @code{a.out} section name.
6457 @ifset COFF
6458 @ifset ELF
6459 @c only print the extra heading if both COFF and ELF are set
6460 @subheading COFF Version
6461 @end ifset
6463 @cindex @code{section} directive (COFF version)
6464 For COFF targets, the @code{.section} directive is used in one of the following
6465 ways:
6467 @smallexample
6468 .section @var{name}[, "@var{flags}"]
6469 .section @var{name}[, @var{subsection}]
6470 @end smallexample
6472 If the optional argument is quoted, it is taken as flags to use for the
6473 section.  Each flag is a single character.  The following flags are recognized:
6475 @table @code
6476 @item b
6477 bss section (uninitialized data)
6478 @item n
6479 section is not loaded
6480 @item w
6481 writable section
6482 @item d
6483 data section
6484 @item e
6485 exclude section from linking
6486 @item r
6487 read-only section
6488 @item x
6489 executable section
6490 @item s
6491 shared section (meaningful for PE targets)
6492 @item a
6493 ignored.  (For compatibility with the ELF version)
6494 @item y
6495 section is not readable (meaningful for PE targets)
6496 @item 0-9
6497 single-digit power-of-two section alignment (GNU extension)
6498 @end table
6500 If no flags are specified, the default flags depend upon the section name.  If
6501 the section name is not recognized, the default will be for the section to be
6502 loaded and writable.  Note the @code{n} and @code{w} flags remove attributes
6503 from the section, rather than adding them, so if they are used on their own it
6504 will be as if no flags had been specified at all.
6506 If the optional argument to the @code{.section} directive is not quoted, it is
6507 taken as a subsection number (@pxref{Sub-Sections}).
6508 @end ifset
6510 @ifset ELF
6511 @ifset COFF
6512 @c only print the extra heading if both COFF and ELF are set
6513 @subheading ELF Version
6514 @end ifset
6516 @cindex Section Stack
6517 This is one of the ELF section stack manipulation directives.  The others are
6518 @code{.subsection} (@pxref{SubSection}), @code{.pushsection}
6519 (@pxref{PushSection}), @code{.popsection} (@pxref{PopSection}), and
6520 @code{.previous} (@pxref{Previous}).
6522 @cindex @code{section} directive (ELF version)
6523 For ELF targets, the @code{.section} directive is used like this:
6525 @smallexample
6526 .section @var{name} [, "@var{flags}"[, @@@var{type}[,@var{flag_specific_arguments}]]]
6527 @end smallexample
6529 @anchor{Section Name Substitutions}
6530 @kindex --sectname-subst
6531 @cindex section name substitution
6532 If the @samp{--sectname-subst} command-line option is provided, the @var{name}
6533 argument may contain a substitution sequence. Only @code{%S} is supported
6534 at the moment, and substitutes the current section name. For example:
6536 @smallexample
6537 .macro exception_code
6538 .section %S.exception
6539 [exception code here]
6540 .previous
6541 .endm
6543 .text
6544 [code]
6545 exception_code
6546 [...]
6548 .section .init
6549 [init code]
6550 exception_code
6551 [...]
6552 @end smallexample
6554 The two @code{exception_code} invocations above would create the
6555 @code{.text.exception} and @code{.init.exception} sections respectively.
6556 This is useful e.g. to discriminate between ancillary sections that are
6557 tied to setup code to be discarded after use from ancillary sections that
6558 need to stay resident without having to define multiple @code{exception_code}
6559 macros just for that purpose.
6561 The optional @var{flags} argument is a quoted string which may contain any
6562 combination of the following characters:
6564 @table @code
6565 @item a
6566 section is allocatable
6567 @item d
6568 section is a GNU_MBIND section
6569 @item e
6570 section is excluded from executable and shared library.
6571 @item w
6572 section is writable
6573 @item x
6574 section is executable
6575 @item M
6576 section is mergeable
6577 @item S
6578 section contains zero terminated strings
6579 @item G
6580 section is a member of a section group
6581 @item T
6582 section is used for thread-local-storage
6583 @item ?
6584 section is a member of the previously-current section's group, if any
6585 @item @code{<number>}
6586 a numeric value indicating the bits to be set in the ELF section header's flags
6587 field.  Note - if one or more of the alphabetic characters described above is
6588 also included in the flags field, their bit values will be ORed into the
6589 resulting value.
6590 @item @code{<target specific>}
6591 some targets extend this list with their own flag characters
6592 @end table
6594 Note - once a section's flags have been set they cannot be changed.  There are
6595 a few exceptions to this rule however.  Processor and application specific
6596 flags can be added to an already defined section.  The @code{.interp},
6597 @code{.strtab} and @code{.symtab} sections can have the allocate flag
6598 (@code{a}) set after they are initially defined, and the @code{.note-GNU-stack}
6599 section may have the executable (@code{x}) flag added.
6601 The optional @var{type} argument may contain one of the following constants:
6603 @table @code
6604 @item @@progbits
6605 section contains data
6606 @item @@nobits
6607 section does not contain data (i.e., section only occupies space)
6608 @item @@note
6609 section contains data which is used by things other than the program
6610 @item @@init_array
6611 section contains an array of pointers to init functions
6612 @item @@fini_array
6613 section contains an array of pointers to finish functions
6614 @item @@preinit_array
6615 section contains an array of pointers to pre-init functions
6616 @item @@@code{<number>}
6617 a numeric value to be set as the ELF section header's type field.
6618 @item @@@code{<target specific>}
6619 some targets extend this list with their own types
6620 @end table
6622 Many targets only support the first three section types.  The type may be
6623 enclosed in double quotes if necessary.
6625 Note on targets where the @code{@@} character is the start of a comment (eg
6626 ARM) then another character is used instead.  For example the ARM port uses the
6627 @code{%} character.
6629 Note - some sections, eg @code{.text} and @code{.data} are considered to be
6630 special and have fixed types.  Any attempt to declare them with a different
6631 type will generate an error from the assembler.
6633 If @var{flags} contains the @code{M} symbol then the @var{type} argument must
6634 be specified as well as an extra argument---@var{entsize}---like this:
6636 @smallexample
6637 .section @var{name} , "@var{flags}"M, @@@var{type}, @var{entsize}
6638 @end smallexample
6640 Sections with the @code{M} flag but not @code{S} flag must contain fixed size
6641 constants, each @var{entsize} octets long. Sections with both @code{M} and
6642 @code{S} must contain zero terminated strings where each character is
6643 @var{entsize} bytes long. The linker may remove duplicates within sections with
6644 the same name, same entity size and same flags.  @var{entsize} must be an
6645 absolute expression.  For sections with both @code{M} and @code{S}, a string
6646 which is a suffix of a larger string is considered a duplicate.  Thus
6647 @code{"def"} will be merged with @code{"abcdef"};  A reference to the first
6648 @code{"def"} will be changed to a reference to @code{"abcdef"+3}.
6650 If @var{flags} contains the @code{G} symbol then the @var{type} argument must
6651 be present along with an additional field like this:
6653 @smallexample
6654 .section @var{name} , "@var{flags}"G, @@@var{type}, @var{GroupName}[, @var{linkage}]
6655 @end smallexample
6657 The @var{GroupName} field specifies the name of the section group to which this
6658 particular section belongs.  The optional linkage field can contain:
6660 @table @code
6661 @item comdat
6662 indicates that only one copy of this section should be retained
6663 @item .gnu.linkonce
6664 an alias for comdat
6665 @end table
6667 Note: if both the @var{M} and @var{G} flags are present then the fields for
6668 the Merge flag should come first, like this:
6670 @smallexample
6671 .section @var{name} , "@var{flags}"MG, @@@var{type}, @var{entsize}, @var{GroupName}[, @var{linkage}]
6672 @end smallexample
6674 If @var{flags} contains the @code{?} symbol then it may not also contain the
6675 @code{G} symbol and the @var{GroupName} or @var{linkage} fields should not be
6676 present.  Instead, @code{?} says to consider the section that's current before
6677 this directive.  If that section used @code{G}, then the new section will use
6678 @code{G} with those same @var{GroupName} and @var{linkage} fields implicitly.
6679 If not, then the @code{?} symbol has no effect.
6681 If no flags are specified, the default flags depend upon the section name.  If
6682 the section name is not recognized, the default will be for the section to have
6683 none of the above flags: it will not be allocated in memory, nor writable, nor
6684 executable.  The section will contain data.
6686 For ELF targets, the assembler supports another type of @code{.section}
6687 directive for compatibility with the Solaris assembler:
6689 @smallexample
6690 .section "@var{name}"[, @var{flags}...]
6691 @end smallexample
6693 Note that the section name is quoted.  There may be a sequence of comma
6694 separated flags:
6696 @table @code
6697 @item #alloc
6698 section is allocatable
6699 @item #write
6700 section is writable
6701 @item #execinstr
6702 section is executable
6703 @item #exclude
6704 section is excluded from executable and shared library.
6705 @item #tls
6706 section is used for thread local storage
6707 @end table
6709 This directive replaces the current section and subsection.  See the
6710 contents of the gas testsuite directory @code{gas/testsuite/gas/elf} for
6711 some examples of how this directive and the other section stack directives
6712 work.
6713 @end ifset
6714 @end ifset
6716 @node Set
6717 @section @code{.set @var{symbol}, @var{expression}}
6719 @cindex @code{set} directive
6720 @cindex symbol value, setting
6721 Set the value of @var{symbol} to @var{expression}.  This
6722 changes @var{symbol}'s value and type to conform to
6723 @var{expression}.  If @var{symbol} was flagged as external, it remains
6724 flagged (@pxref{Symbol Attributes}).
6726 You may @code{.set} a symbol many times in the same assembly provided that the
6727 values given to the symbol are constants.  Values that are based on expressions
6728 involving other symbols are allowed, but some targets may restrict this to only
6729 being done once per assembly.  This is because those targets do not set the
6730 addresses of symbols at assembly time, but rather delay the assignment until a
6731 final link is performed.  This allows the linker a chance to change the code in
6732 the files, changing the location of, and the relative distance between, various
6733 different symbols.
6735 If you @code{.set} a global symbol, the value stored in the object
6736 file is the last value stored into it.
6738 @ifset Z80
6739 On Z80 @code{set} is a real instruction, use
6740 @samp{@var{symbol} defl @var{expression}} instead.
6741 @end ifset
6743 @node Short
6744 @section @code{.short @var{expressions}}
6746 @cindex @code{short} directive
6747 @ifset GENERIC
6748 @code{.short} is normally the same as @samp{.word}.
6749 @xref{Word,,@code{.word}}.
6751 In some configurations, however, @code{.short} and @code{.word} generate
6752 numbers of different lengths.  @xref{Machine Dependencies}.
6753 @end ifset
6754 @ifclear GENERIC
6755 @ifset W16
6756 @code{.short} is the same as @samp{.word}.  @xref{Word,,@code{.word}}.
6757 @end ifset
6758 @ifset W32
6759 This expects zero or more @var{expressions}, and emits
6760 a 16 bit number for each.
6761 @end ifset
6762 @end ifclear
6764 @node Single
6765 @section @code{.single @var{flonums}}
6767 @cindex @code{single} directive
6768 @cindex floating point numbers (single)
6769 This directive assembles zero or more flonums, separated by commas.  It
6770 has the same effect as @code{.float}.
6771 @ifset GENERIC
6772 The exact kind of floating point numbers emitted depends on how
6773 @command{@value{AS}} is configured.  @xref{Machine Dependencies}.
6774 @end ifset
6775 @ifclear GENERIC
6776 @ifset IEEEFLOAT
6777 On the @value{TARGET} family, @code{.single} emits 32-bit floating point
6778 numbers in @sc{ieee} format.
6779 @end ifset
6780 @end ifclear
6782 @ifset COFF-ELF
6783 @node Size
6784 @section @code{.size}
6786 This directive is used to set the size associated with a symbol.
6788 @ifset COFF
6789 @ifset ELF
6790 @c only print the extra heading if both COFF and ELF are set
6791 @subheading COFF Version
6792 @end ifset
6794 @cindex @code{size} directive (COFF version)
6795 For COFF targets, the @code{.size} directive is only permitted inside
6796 @code{.def}/@code{.endef} pairs.  It is used like this:
6798 @smallexample
6799 .size @var{expression}
6800 @end smallexample
6802 @end ifset
6804 @ifset ELF
6805 @ifset COFF
6806 @c only print the extra heading if both COFF and ELF are set
6807 @subheading ELF Version
6808 @end ifset
6810 @cindex @code{size} directive (ELF version)
6811 For ELF targets, the @code{.size} directive is used like this:
6813 @smallexample
6814 .size @var{name} , @var{expression}
6815 @end smallexample
6817 This directive sets the size associated with a symbol @var{name}.
6818 The size in bytes is computed from @var{expression} which can make use of label
6819 arithmetic.  This directive is typically used to set the size of function
6820 symbols.
6821 @end ifset
6822 @end ifset
6824 @ifclear no-space-dir
6825 @node Skip
6826 @section @code{.skip @var{size} [,@var{fill}]}
6828 @cindex @code{skip} directive
6829 @cindex filling memory
6830 This directive emits @var{size} bytes, each of value @var{fill}.  Both
6831 @var{size} and @var{fill} are absolute expressions.  If the comma and
6832 @var{fill} are omitted, @var{fill} is assumed to be zero.  This is the same as
6833 @samp{.space}.
6834 @end ifclear
6836 @node Sleb128
6837 @section @code{.sleb128 @var{expressions}}
6839 @cindex @code{sleb128} directive
6840 @var{sleb128} stands for ``signed little endian base 128.''  This is a
6841 compact, variable length representation of numbers used by the DWARF
6842 symbolic debugging format.  @xref{Uleb128, ,@code{.uleb128}}.
6844 @ifclear no-space-dir
6845 @node Space
6846 @section @code{.space @var{size} [,@var{fill}]}
6848 @cindex @code{space} directive
6849 @cindex filling memory
6850 This directive emits @var{size} bytes, each of value @var{fill}.  Both
6851 @var{size} and @var{fill} are absolute expressions.  If the comma
6852 and @var{fill} are omitted, @var{fill} is assumed to be zero.  This is the same
6853 as @samp{.skip}.
6855 @ifset HPPA
6856 @quotation
6857 @emph{Warning:} @code{.space} has a completely different meaning for HPPA
6858 targets; use @code{.block} as a substitute.  See @cite{HP9000 Series 800
6859 Assembly Language Reference Manual} (HP 92432-90001) for the meaning of the
6860 @code{.space} directive.  @xref{HPPA Directives,,HPPA Assembler Directives},
6861 for a summary.
6862 @end quotation
6863 @end ifset
6864 @end ifclear
6866 @ifset have-stabs
6867 @node Stab
6868 @section @code{.stabd, .stabn, .stabs}
6870 @cindex symbolic debuggers, information for
6871 @cindex @code{stab@var{x}} directives
6872 There are three directives that begin @samp{.stab}.
6873 All emit symbols (@pxref{Symbols}), for use by symbolic debuggers.
6874 The symbols are not entered in the @command{@value{AS}} hash table: they
6875 cannot be referenced elsewhere in the source file.
6876 Up to five fields are required:
6878 @table @var
6879 @item string
6880 This is the symbol's name.  It may contain any character except
6881 @samp{\000}, so is more general than ordinary symbol names.  Some
6882 debuggers used to code arbitrarily complex structures into symbol names
6883 using this field.
6885 @item type
6886 An absolute expression.  The symbol's type is set to the low 8 bits of
6887 this expression.  Any bit pattern is permitted, but @code{@value{LD}}
6888 and debuggers choke on silly bit patterns.
6890 @item other
6891 An absolute expression.  The symbol's ``other'' attribute is set to the
6892 low 8 bits of this expression.
6894 @item desc
6895 An absolute expression.  The symbol's descriptor is set to the low 16
6896 bits of this expression.
6898 @item value
6899 An absolute expression which becomes the symbol's value.
6900 @end table
6902 If a warning is detected while reading a @code{.stabd}, @code{.stabn},
6903 or @code{.stabs} statement, the symbol has probably already been created;
6904 you get a half-formed symbol in your object file.  This is
6905 compatible with earlier assemblers!
6907 @table @code
6908 @cindex @code{stabd} directive
6909 @item .stabd @var{type} , @var{other} , @var{desc}
6911 The ``name'' of the symbol generated is not even an empty string.
6912 It is a null pointer, for compatibility.  Older assemblers used a
6913 null pointer so they didn't waste space in object files with empty
6914 strings.
6916 The symbol's value is set to the location counter,
6917 relocatably.  When your program is linked, the value of this symbol
6918 is the address of the location counter when the @code{.stabd} was
6919 assembled.
6921 @cindex @code{stabn} directive
6922 @item .stabn @var{type} , @var{other} , @var{desc} , @var{value}
6923 The name of the symbol is set to the empty string @code{""}.
6925 @cindex @code{stabs} directive
6926 @item .stabs @var{string} ,  @var{type} , @var{other} , @var{desc} , @var{value}
6927 All five fields are specified.
6928 @end table
6929 @end ifset
6930 @c end     have-stabs
6932 @node String
6933 @section @code{.string} "@var{str}", @code{.string8} "@var{str}", @code{.string16}
6934 "@var{str}", @code{.string32} "@var{str}", @code{.string64} "@var{str}"
6936 @cindex string, copying to object file
6937 @cindex string8, copying to object file
6938 @cindex string16, copying to object file
6939 @cindex string32, copying to object file
6940 @cindex string64, copying to object file
6941 @cindex @code{string} directive
6942 @cindex @code{string8} directive
6943 @cindex @code{string16} directive
6944 @cindex @code{string32} directive
6945 @cindex @code{string64} directive
6947 Copy the characters in @var{str} to the object file.  You may specify more than
6948 one string to copy, separated by commas.  Unless otherwise specified for a
6949 particular machine, the assembler marks the end of each string with a 0 byte.
6950 You can use any of the escape sequences described in @ref{Strings,,Strings}.
6952 The variants @code{string16}, @code{string32} and @code{string64} differ from
6953 the @code{string} pseudo opcode in that each 8-bit character from @var{str} is
6954 copied and expanded to 16, 32 or 64 bits respectively.  The expanded characters
6955 are stored in target endianness byte order.
6957 Example:
6958 @smallexample
6959         .string32 "BYE"
6960 expands to:
6961         .string   "B\0\0\0Y\0\0\0E\0\0\0"  /* On little endian targets.  */
6962         .string   "\0\0\0B\0\0\0Y\0\0\0E"  /* On big endian targets.  */
6963 @end smallexample
6966 @node Struct
6967 @section @code{.struct @var{expression}}
6969 @cindex @code{struct} directive
6970 Switch to the absolute section, and set the section offset to @var{expression},
6971 which must be an absolute expression.  You might use this as follows:
6972 @smallexample
6973         .struct 0
6974 field1:
6975         .struct field1 + 4
6976 field2:
6977         .struct field2 + 4
6978 field3:
6979 @end smallexample
6980 This would define the symbol @code{field1} to have the value 0, the symbol
6981 @code{field2} to have the value 4, and the symbol @code{field3} to have the
6982 value 8.  Assembly would be left in the absolute section, and you would need to
6983 use a @code{.section} directive of some sort to change to some other section
6984 before further assembly.
6986 @ifset ELF
6987 @node SubSection
6988 @section @code{.subsection @var{name}}
6990 @cindex @code{subsection} directive
6991 @cindex Section Stack
6992 This is one of the ELF section stack manipulation directives.  The others are
6993 @code{.section} (@pxref{Section}), @code{.pushsection} (@pxref{PushSection}),
6994 @code{.popsection} (@pxref{PopSection}), and @code{.previous}
6995 (@pxref{Previous}).
6997 This directive replaces the current subsection with @code{name}.  The current
6998 section is not changed.  The replaced subsection is put onto the section stack
6999 in place of the then current top of stack subsection.
7000 @end ifset
7002 @ifset ELF
7003 @node Symver
7004 @section @code{.symver}
7005 @cindex @code{symver} directive
7006 @cindex symbol versioning
7007 @cindex versions of symbols
7008 Use the @code{.symver} directive to bind symbols to specific version nodes
7009 within a source file.  This is only supported on ELF platforms, and is
7010 typically used when assembling files to be linked into a shared library.
7011 There are cases where it may make sense to use this in objects to be bound
7012 into an application itself so as to override a versioned symbol from a
7013 shared library.
7015 For ELF targets, the @code{.symver} directive can be used like this:
7016 @smallexample
7017 .symver @var{name}, @var{name2@@nodename}
7018 @end smallexample
7019 If the symbol @var{name} is defined within the file
7020 being assembled, the @code{.symver} directive effectively creates a symbol
7021 alias with the name @var{name2@@nodename}, and in fact the main reason that we
7022 just don't try and create a regular alias is that the @var{@@} character isn't
7023 permitted in symbol names.  The @var{name2} part of the name is the actual name
7024 of the symbol by which it will be externally referenced.  The name @var{name}
7025 itself is merely a name of convenience that is used so that it is possible to
7026 have definitions for multiple versions of a function within a single source
7027 file, and so that the compiler can unambiguously know which version of a
7028 function is being mentioned.  The @var{nodename} portion of the alias should be
7029 the name of a node specified in the version script supplied to the linker when
7030 building a shared library.  If you are attempting to override a versioned
7031 symbol from a shared library, then @var{nodename} should correspond to the
7032 nodename of the symbol you are trying to override.
7034 If the symbol @var{name} is not defined within the file being assembled, all
7035 references to @var{name} will be changed to @var{name2@@nodename}.  If no
7036 reference to @var{name} is made, @var{name2@@nodename} will be removed from the
7037 symbol table.
7039 Another usage of the @code{.symver} directive is:
7040 @smallexample
7041 .symver @var{name}, @var{name2@@@@nodename}
7042 @end smallexample
7043 In this case, the symbol @var{name} must exist and be defined within
7044 the file being assembled. It is similar to @var{name2@@nodename}. The
7045 difference is @var{name2@@@@nodename} will also be used to resolve
7046 references to @var{name2} by the linker.
7048 The third usage of the @code{.symver} directive is:
7049 @smallexample
7050 .symver @var{name}, @var{name2@@@@@@nodename}
7051 @end smallexample
7052 When @var{name} is not defined within the
7053 file being assembled, it is treated as @var{name2@@nodename}. When
7054 @var{name} is defined within the file being assembled, the symbol
7055 name, @var{name}, will be changed to @var{name2@@@@nodename}.
7056 @end ifset
7058 @ifset COFF
7059 @node Tag
7060 @section @code{.tag @var{structname}}
7062 @cindex COFF structure debugging
7063 @cindex structure debugging, COFF
7064 @cindex @code{tag} directive
7065 This directive is generated by compilers to include auxiliary debugging
7066 information in the symbol table.  It is only permitted inside
7067 @code{.def}/@code{.endef} pairs.  Tags are used to link structure
7068 definitions in the symbol table with instances of those structures.
7069 @end ifset
7071 @node Text
7072 @section @code{.text @var{subsection}}
7074 @cindex @code{text} directive
7075 Tells @command{@value{AS}} to assemble the following statements onto the end of
7076 the text subsection numbered @var{subsection}, which is an absolute
7077 expression.  If @var{subsection} is omitted, subsection number zero
7078 is used.
7080 @node Title
7081 @section @code{.title "@var{heading}"}
7083 @cindex @code{title} directive
7084 @cindex listing control: title line
7085 Use @var{heading} as the title (second line, immediately after the
7086 source file name and pagenumber) when generating assembly listings.
7088 This directive affects subsequent pages, as well as the current page if
7089 it appears within ten lines of the top of a page.
7091 @ifset COFF-ELF
7092 @node Type
7093 @section @code{.type}
7095 This directive is used to set the type of a symbol.
7097 @ifset COFF
7098 @ifset ELF
7099 @c only print the extra heading if both COFF and ELF are set
7100 @subheading COFF Version
7101 @end ifset
7103 @cindex COFF symbol type
7104 @cindex symbol type, COFF
7105 @cindex @code{type} directive (COFF version)
7106 For COFF targets, this directive is permitted only within
7107 @code{.def}/@code{.endef} pairs.  It is used like this:
7109 @smallexample
7110 .type @var{int}
7111 @end smallexample
7113 This records the integer @var{int} as the type attribute of a symbol table
7114 entry.
7116 @end ifset
7118 @ifset ELF
7119 @ifset COFF
7120 @c only print the extra heading if both COFF and ELF are set
7121 @subheading ELF Version
7122 @end ifset
7124 @cindex ELF symbol type
7125 @cindex symbol type, ELF
7126 @cindex @code{type} directive (ELF version)
7127 For ELF targets, the @code{.type} directive is used like this:
7129 @smallexample
7130 .type @var{name} , @var{type description}
7131 @end smallexample
7133 This sets the type of symbol @var{name} to be either a
7134 function symbol or an object symbol.  There are five different syntaxes
7135 supported for the @var{type description} field, in order to provide
7136 compatibility with various other assemblers.
7138 Because some of the characters used in these syntaxes (such as @samp{@@} and
7139 @samp{#}) are comment characters for some architectures, some of the syntaxes
7140 below do not work on all architectures.  The first variant will be accepted by
7141 the GNU assembler on all architectures so that variant should be used for
7142 maximum portability, if you do not need to assemble your code with other
7143 assemblers.
7145 The syntaxes supported are:
7147 @smallexample
7148   .type <name> STT_<TYPE_IN_UPPER_CASE>
7149   .type <name>,#<type>
7150   .type <name>,@@<type>
7151   .type <name>,%<type>
7152   .type <name>,"<type>"
7153 @end smallexample
7155 The types supported are:
7157 @table @gcctabopt
7158 @item STT_FUNC
7159 @itemx function
7160 Mark the symbol as being a function name.
7162 @item STT_GNU_IFUNC
7163 @itemx gnu_indirect_function
7164 Mark the symbol as an indirect function when evaluated during reloc
7165 processing.  (This is only supported on assemblers targeting GNU systems).
7167 @item STT_OBJECT
7168 @itemx object
7169 Mark the symbol as being a data object.
7171 @item STT_TLS
7172 @itemx tls_object
7173 Mark the symbol as being a thread-local data object.
7175 @item STT_COMMON
7176 @itemx common
7177 Mark the symbol as being a common data object.
7179 @item STT_NOTYPE
7180 @itemx notype
7181 Does not mark the symbol in any way.  It is supported just for completeness.
7183 @item gnu_unique_object
7184 Marks the symbol as being a globally unique data object.  The dynamic linker
7185 will make sure that in the entire process there is just one symbol with this
7186 name and type in use.  (This is only supported on assemblers targeting GNU
7187 systems).
7189 @end table
7191 Note: Some targets support extra types in addition to those listed above.
7193 @end ifset
7194 @end ifset
7196 @node Uleb128
7197 @section @code{.uleb128 @var{expressions}}
7199 @cindex @code{uleb128} directive
7200 @var{uleb128} stands for ``unsigned little endian base 128.''  This is a
7201 compact, variable length representation of numbers used by the DWARF
7202 symbolic debugging format.  @xref{Sleb128, ,@code{.sleb128}}.
7204 @ifset COFF
7205 @node Val
7206 @section @code{.val @var{addr}}
7208 @cindex @code{val} directive
7209 @cindex COFF value attribute
7210 @cindex value attribute, COFF
7211 This directive, permitted only within @code{.def}/@code{.endef} pairs,
7212 records the address @var{addr} as the value attribute of a symbol table
7213 entry.
7214 @end ifset
7216 @ifset ELF
7217 @node Version
7218 @section @code{.version "@var{string}"}
7220 @cindex @code{version} directive
7221 This directive creates a @code{.note} section and places into it an ELF
7222 formatted note of type NT_VERSION.  The note's name is set to @code{string}.
7223 @end ifset
7225 @ifset ELF
7226 @node VTableEntry
7227 @section @code{.vtable_entry @var{table}, @var{offset}}
7229 @cindex @code{vtable_entry} directive
7230 This directive finds or creates a symbol @code{table} and creates a
7231 @code{VTABLE_ENTRY} relocation for it with an addend of @code{offset}.
7233 @node VTableInherit
7234 @section @code{.vtable_inherit @var{child}, @var{parent}}
7236 @cindex @code{vtable_inherit} directive
7237 This directive finds the symbol @code{child} and finds or creates the symbol
7238 @code{parent} and then creates a @code{VTABLE_INHERIT} relocation for the
7239 parent whose addend is the value of the child symbol.  As a special case the
7240 parent name of @code{0} is treated as referring to the @code{*ABS*} section.
7241 @end ifset
7243 @node Warning
7244 @section @code{.warning "@var{string}"}
7245 @cindex warning directive
7246 Similar to the directive @code{.error}
7247 (@pxref{Error,,@code{.error "@var{string}"}}), but just emits a warning.
7249 @node Weak
7250 @section @code{.weak @var{names}}
7252 @cindex @code{weak} directive
7253 This directive sets the weak attribute on the comma separated list of symbol
7254 @code{names}.  If the symbols do not already exist, they will be created.
7256 On COFF targets other than PE, weak symbols are a GNU extension.  This
7257 directive sets the weak attribute on the comma separated list of symbol
7258 @code{names}.  If the symbols do not already exist, they will be created.
7260 On the PE target, weak symbols are supported natively as weak aliases.
7261 When a weak symbol is created that is not an alias, GAS creates an
7262 alternate symbol to hold the default value.
7264 @node Weakref
7265 @section @code{.weakref @var{alias}, @var{target}}
7267 @cindex @code{weakref} directive
7268 This directive creates an alias to the target symbol that enables the symbol to
7269 be referenced with weak-symbol semantics, but without actually making it weak.
7270 If direct references or definitions of the symbol are present, then the symbol
7271 will not be weak, but if all references to it are through weak references, the
7272 symbol will be marked as weak in the symbol table.
7274 The effect is equivalent to moving all references to the alias to a separate
7275 assembly source file, renaming the alias to the symbol in it, declaring the
7276 symbol as weak there, and running a reloadable link to merge the object files
7277 resulting from the assembly of the new source file and the old source file that
7278 had the references to the alias removed.
7280 The alias itself never makes to the symbol table, and is entirely handled
7281 within the assembler.
7283 @node Word
7284 @section @code{.word @var{expressions}}
7286 @cindex @code{word} directive
7287 This directive expects zero or more @var{expressions}, of any section,
7288 separated by commas.
7289 @ifclear GENERIC
7290 @ifset W32
7291 For each expression, @command{@value{AS}} emits a 32-bit number.
7292 @end ifset
7293 @ifset W16
7294 For each expression, @command{@value{AS}} emits a 16-bit number.
7295 @end ifset
7296 @end ifclear
7297 @ifset GENERIC
7299 The size of the number emitted, and its byte order,
7300 depend on what target computer the assembly is for.
7301 @end ifset
7303 @c on sparc the "special treatment to support compilers" doesn't
7304 @c happen---32-bit addressability, period; no long/short jumps.
7305 @ifset DIFF-TBL-KLUGE
7306 @cindex difference tables altered
7307 @cindex altered difference tables
7308 @quotation
7309 @emph{Warning: Special Treatment to support Compilers}
7310 @end quotation
7312 @ifset GENERIC
7313 Machines with a 32-bit address space, but that do less than 32-bit
7314 addressing, require the following special treatment.  If the machine of
7315 interest to you does 32-bit addressing (or doesn't require it;
7316 @pxref{Machine Dependencies}), you can ignore this issue.
7318 @end ifset
7319 In order to assemble compiler output into something that works,
7320 @command{@value{AS}} occasionally does strange things to @samp{.word} directives.
7321 Directives of the form @samp{.word sym1-sym2} are often emitted by
7322 compilers as part of jump tables.  Therefore, when @command{@value{AS}} assembles a
7323 directive of the form @samp{.word sym1-sym2}, and the difference between
7324 @code{sym1} and @code{sym2} does not fit in 16 bits, @command{@value{AS}}
7325 creates a @dfn{secondary jump table}, immediately before the next label.
7326 This secondary jump table is preceded by a short-jump to the
7327 first byte after the secondary table.  This short-jump prevents the flow
7328 of control from accidentally falling into the new table.  Inside the
7329 table is a long-jump to @code{sym2}.  The original @samp{.word}
7330 contains @code{sym1} minus the address of the long-jump to
7331 @code{sym2}.
7333 If there were several occurrences of @samp{.word sym1-sym2} before the
7334 secondary jump table, all of them are adjusted.  If there was a
7335 @samp{.word sym3-sym4}, that also did not fit in sixteen bits, a
7336 long-jump to @code{sym4} is included in the secondary jump table,
7337 and the @code{.word} directives are adjusted to contain @code{sym3}
7338 minus the address of the long-jump to @code{sym4}; and so on, for as many
7339 entries in the original jump table as necessary.
7341 @ifset INTERNALS
7342 @emph{This feature may be disabled by compiling @command{@value{AS}} with the
7343 @samp{-DWORKING_DOT_WORD} option.} This feature is likely to confuse
7344 assembly language programmers.
7345 @end ifset
7346 @end ifset
7347 @c end     DIFF-TBL-KLUGE
7349 @ifclear no-space-dir
7350 @node Zero
7351 @section @code{.zero @var{size}}
7353 @cindex @code{zero} directive
7354 @cindex filling memory with zero bytes
7355 This directive emits @var{size} 0-valued bytes.  @var{size} must be an absolute
7356 expression.  This directive is actually an alias for the @samp{.skip} directive
7357 so in can take an optional second argument of the value to store in the bytes
7358 instead of zero.  Using @samp{.zero} in this way would be confusing however.
7359 @end ifclear
7361 @ifset ELF
7362 @node 2byte
7363 @section @code{.2byte @var{expression} [, @var{expression}]*}
7364 @cindex @code{2byte} directive
7365 @cindex two-byte integer
7366 @cindex integer, 2-byte
7368 This directive expects zero or more expressions, separated by commas.  If there
7369 are no expressions then the directive does nothing.  Otherwise each expression
7370 is evaluated in turn and placed in the next two bytes of the current output
7371 section, using the endian model of the target.  If an expression will not fit
7372 in two bytes, a warning message is displayed and the least significant two
7373 bytes of the expression's value are used.  If an expression cannot be evaluated
7374 at assembly time then relocations will be generated in order to compute the
7375 value at link time.  
7377 This directive does not apply any alignment before or after inserting the
7378 values.  As a result of this, if relocations are generated, they may be
7379 different from those used for inserting values with a guaranteed alignment.
7381 This directive is only available for ELF targets,
7383 @node 4byte
7384 @section @code{.4byte @var{expression} [, @var{expression}]*}
7385 @cindex @code{4byte} directive
7386 @cindex four-byte integer
7387 @cindex integer, 4-byte
7389 Like the @option{.2byte} directive, except that it inserts unaligned, four byte
7390 long values into the output.
7392 @node 8byte
7393 @section @code{.8byte @var{expression} [, @var{expression}]*}
7394 @cindex @code{8byte} directive
7395 @cindex eight-byte integer
7396 @cindex integer, 8-byte
7398 Like the @option{.2byte} directive, except that it inserts unaligned, eight
7399 byte long bignum values into the output.
7401 @end ifset
7403 @node Deprecated
7404 @section Deprecated Directives
7406 @cindex deprecated directives
7407 @cindex obsolescent directives
7408 One day these directives won't work.
7409 They are included for compatibility with older assemblers.
7410 @table @t
7411 @item .abort
7412 @item .line
7413 @end table
7415 @ifset ELF
7416 @node Object Attributes
7417 @chapter Object Attributes
7418 @cindex object attributes
7420 @command{@value{AS}} assembles source files written for a specific architecture
7421 into object files for that architecture.  But not all object files are alike.
7422 Many architectures support incompatible variations.  For instance, floating
7423 point arguments might be passed in floating point registers if the object file
7424 requires hardware floating point support---or floating point arguments might be
7425 passed in integer registers if the object file supports processors with no
7426 hardware floating point unit.  Or, if two objects are built for different
7427 generations of the same architecture, the combination may require the
7428 newer generation at run-time.
7430 This information is useful during and after linking.  At link time,
7431 @command{@value{LD}} can warn about incompatible object files.  After link
7432 time, tools like @command{gdb} can use it to process the linked file
7433 correctly.
7435 Compatibility information is recorded as a series of object attributes.  Each
7436 attribute has a @dfn{vendor}, @dfn{tag}, and @dfn{value}.  The vendor is a
7437 string, and indicates who sets the meaning of the tag.  The tag is an integer,
7438 and indicates what property the attribute describes.  The value may be a string
7439 or an integer, and indicates how the property affects this object.  Missing
7440 attributes are the same as attributes with a zero value or empty string value.
7442 Object attributes were developed as part of the ABI for the ARM Architecture.
7443 The file format is documented in @cite{ELF for the ARM Architecture}.
7445 @menu
7446 * GNU Object Attributes::               @sc{gnu} Object Attributes
7447 * Defining New Object Attributes::      Defining New Object Attributes
7448 @end menu
7450 @node GNU Object Attributes
7451 @section @sc{gnu} Object Attributes
7453 The @code{.gnu_attribute} directive records an object attribute
7454 with vendor @samp{gnu}.
7456 Except for @samp{Tag_compatibility}, which has both an integer and a string for
7457 its value, @sc{gnu} attributes have a string value if the tag number is odd and
7458 an integer value if the tag number is even.  The second bit (@code{@var{tag} &
7459 2} is set for architecture-independent attributes and clear for
7460 architecture-dependent ones.
7462 @subsection Common @sc{gnu} attributes
7464 These attributes are valid on all architectures.
7466 @table @r
7467 @item Tag_compatibility (32)
7468 The compatibility attribute takes an integer flag value and a vendor name.  If
7469 the flag value is 0, the file is compatible with other toolchains.  If it is 1,
7470 then the file is only compatible with the named toolchain.  If it is greater
7471 than 1, the file can only be processed by other toolchains under some private
7472 arrangement indicated by the flag value and the vendor name.
7473 @end table
7475 @subsection MIPS Attributes
7477 @table @r
7478 @item Tag_GNU_MIPS_ABI_FP (4)
7479 The floating-point ABI used by this object file.  The value will be:
7481 @itemize @bullet
7482 @item
7483 0 for files not affected by the floating-point ABI.
7484 @item
7485 1 for files using the hardware floating-point ABI with a standard
7486 double-precision FPU.
7487 @item
7488 2 for files using the hardware floating-point ABI with a single-precision FPU.
7489 @item
7490 3 for files using the software floating-point ABI.
7491 @item
7492 4 for files using the deprecated hardware floating-point ABI which used 64-bit
7493 floating-point registers, 32-bit general-purpose registers and increased the
7494 number of callee-saved floating-point registers.
7495 @item
7496 5 for files using the hardware floating-point ABI with a double-precision FPU
7497 with either 32-bit or 64-bit floating-point registers and 32-bit
7498 general-purpose registers.
7499 @item
7500 6 for files using the hardware floating-point ABI with 64-bit floating-point
7501 registers and 32-bit general-purpose registers.
7502 @item
7503 7 for files using the hardware floating-point ABI with 64-bit floating-point
7504 registers, 32-bit general-purpose registers and a rule that forbids the
7505 direct use of odd-numbered single-precision floating-point registers.
7506 @end itemize
7507 @end table
7509 @subsection PowerPC Attributes
7511 @table @r
7512 @item Tag_GNU_Power_ABI_FP (4)
7513 The floating-point ABI used by this object file.  The value will be:
7515 @itemize @bullet
7516 @item
7517 0 for files not affected by the floating-point ABI.
7518 @item
7519 1 for files using double-precision hardware floating-point ABI.
7520 @item
7521 2 for files using the software floating-point ABI.
7522 @item
7523 3 for files using single-precision hardware floating-point ABI.
7524 @end itemize
7526 @item Tag_GNU_Power_ABI_Vector (8)
7527 The vector ABI used by this object file.  The value will be:
7529 @itemize @bullet
7530 @item
7531 0 for files not affected by the vector ABI.
7532 @item
7533 1 for files using general purpose registers to pass vectors.
7534 @item
7535 2 for files using AltiVec registers to pass vectors.
7536 @item
7537 3 for files using SPE registers to pass vectors.
7538 @end itemize
7539 @end table
7541 @subsection IBM z Systems Attributes
7543 @table @r
7544 @item Tag_GNU_S390_ABI_Vector (8)
7545 The vector ABI used by this object file.  The value will be:
7547 @itemize @bullet
7548 @item
7549 0 for files not affected by the vector ABI.
7550 @item
7551 1 for files using software vector ABI.
7552 @item
7553 2 for files using hardware vector ABI.
7554 @end itemize
7555 @end table
7557 @node Defining New Object Attributes
7558 @section Defining New Object Attributes
7560 If you want to define a new @sc{gnu} object attribute, here are the places you
7561 will need to modify.  New attributes should be discussed on the @samp{binutils}
7562 mailing list.
7564 @itemize @bullet
7565 @item
7566 This manual, which is the official register of attributes.
7567 @item
7568 The header for your architecture @file{include/elf}, to define the tag.
7569 @item
7570 The @file{bfd} support file for your architecture, to merge the attribute
7571 and issue any appropriate link warnings.
7572 @item
7573 Test cases in @file{ld/testsuite} for merging and link warnings.
7574 @item
7575 @file{binutils/readelf.c} to display your attribute.
7576 @item
7577 GCC, if you want the compiler to mark the attribute automatically.
7578 @end itemize
7580 @end ifset
7582 @ifset GENERIC
7583 @node Machine Dependencies
7584 @chapter Machine Dependent Features
7586 @cindex machine dependencies
7587 The machine instruction sets are (almost by definition) different on
7588 each machine where @command{@value{AS}} runs.  Floating point representations
7589 vary as well, and @command{@value{AS}} often supports a few additional
7590 directives or command-line options for compatibility with other
7591 assemblers on a particular platform.  Finally, some versions of
7592 @command{@value{AS}} support special pseudo-instructions for branch
7593 optimization.
7595 This chapter discusses most of these differences, though it does not
7596 include details on any machine's instruction set.  For details on that
7597 subject, see the hardware manufacturer's manual.
7599 @menu
7600 @ifset AARCH64
7601 * AArch64-Dependent::           AArch64 Dependent Features
7602 @end ifset
7603 @ifset ALPHA
7604 * Alpha-Dependent::             Alpha Dependent Features
7605 @end ifset
7606 @ifset ARC
7607 * ARC-Dependent::               ARC Dependent Features
7608 @end ifset
7609 @ifset ARM
7610 * ARM-Dependent::               ARM Dependent Features
7611 @end ifset
7612 @ifset AVR
7613 * AVR-Dependent::               AVR Dependent Features
7614 @end ifset
7615 @ifset Blackfin
7616 * Blackfin-Dependent::          Blackfin Dependent Features
7617 @end ifset
7618 @ifset CR16
7619 * CR16-Dependent::              CR16 Dependent Features
7620 @end ifset
7621 @ifset CRIS
7622 * CRIS-Dependent::              CRIS Dependent Features
7623 @end ifset
7624 @ifset CSKY
7625 * C-SKY-Dependent::             C-SKY Dependent Features
7626 @end ifset
7627 @ifset D10V
7628 * D10V-Dependent::              D10V Dependent Features
7629 @end ifset
7630 @ifset D30V
7631 * D30V-Dependent::              D30V Dependent Features
7632 @end ifset
7633 @ifset EPIPHANY
7634 * Epiphany-Dependent::          EPIPHANY Dependent Features
7635 @end ifset
7636 @ifset H8/300
7637 * H8/300-Dependent::            Renesas H8/300 Dependent Features
7638 @end ifset
7639 @ifset HPPA
7640 * HPPA-Dependent::              HPPA Dependent Features
7641 @end ifset
7642 @ifset I80386
7643 * i386-Dependent::              Intel 80386 and AMD x86-64 Dependent Features
7644 @end ifset
7645 @ifset IA64
7646 * IA-64-Dependent::             Intel IA-64 Dependent Features
7647 @end ifset
7648 @ifset IP2K
7649 * IP2K-Dependent::              IP2K Dependent Features
7650 @end ifset
7651 @ifset LM32
7652 * LM32-Dependent::              LM32 Dependent Features
7653 @end ifset
7654 @ifset M32C
7655 * M32C-Dependent::              M32C Dependent Features
7656 @end ifset
7657 @ifset M32R
7658 * M32R-Dependent::              M32R Dependent Features
7659 @end ifset
7660 @ifset M680X0
7661 * M68K-Dependent::              M680x0 Dependent Features
7662 @end ifset
7663 @ifset M68HC11
7664 * M68HC11-Dependent::           M68HC11 and 68HC12 Dependent Features
7665 @end ifset
7666 @ifset S12Z
7667 * S12Z-Dependent::              S12Z Dependent Features
7668 @end ifset
7669 @ifset METAG
7670 * Meta-Dependent ::             Meta Dependent Features
7671 @end ifset
7672 @ifset MICROBLAZE
7673 * MicroBlaze-Dependent::        MICROBLAZE Dependent Features
7674 @end ifset
7675 @ifset MIPS
7676 * MIPS-Dependent::              MIPS Dependent Features
7677 @end ifset
7678 @ifset MMIX
7679 * MMIX-Dependent::              MMIX Dependent Features
7680 @end ifset
7681 @ifset MSP430
7682 * MSP430-Dependent::            MSP430 Dependent Features
7683 @end ifset
7684 @ifset NDS32
7685 * NDS32-Dependent::             Andes NDS32 Dependent Features
7686 @end ifset
7687 @ifset NIOSII
7688 * NiosII-Dependent::            Altera Nios II Dependent Features
7689 @end ifset
7690 @ifset NS32K
7691 * NS32K-Dependent::             NS32K Dependent Features
7692 @end ifset
7693 @ifset OPENRISC
7694 * OpenRISC-Dependent::          OpenRISC 1000 Features
7695 @end ifset
7696 @ifset PDP11
7697 * PDP-11-Dependent::            PDP-11 Dependent Features
7698 @end ifset
7699 @ifset PJ
7700 * PJ-Dependent::                picoJava Dependent Features
7701 @end ifset
7702 @ifset PPC
7703 * PPC-Dependent::               PowerPC Dependent Features
7704 @end ifset
7705 @ifset PRU
7706 * PRU-Dependent::               PRU Dependent Features
7707 @end ifset
7708 @ifset RISCV
7709 * RISC-V-Dependent::            RISC-V Dependent Features
7710 @end ifset
7711 @ifset RL78
7712 * RL78-Dependent::              RL78 Dependent Features
7713 @end ifset
7714 @ifset RX
7715 * RX-Dependent::                RX Dependent Features
7716 @end ifset
7717 @ifset S390
7718 * S/390-Dependent::             IBM S/390 Dependent Features
7719 @end ifset
7720 @ifset SCORE
7721 * SCORE-Dependent::             SCORE Dependent Features
7722 @end ifset
7723 @ifset SH
7724 * SH-Dependent::                Renesas / SuperH SH Dependent Features
7725 @end ifset
7726 @ifset SPARC
7727 * Sparc-Dependent::             SPARC Dependent Features
7728 @end ifset
7729 @ifset TIC54X
7730 * TIC54X-Dependent::            TI TMS320C54x Dependent Features
7731 @end ifset
7732 @ifset TIC6X
7733 * TIC6X-Dependent ::            TI TMS320C6x Dependent Features
7734 @end ifset
7735 @ifset TILEGX
7736 * TILE-Gx-Dependent ::          Tilera TILE-Gx Dependent Features
7737 @end ifset
7738 @ifset TILEPRO
7739 * TILEPro-Dependent ::          Tilera TILEPro Dependent Features
7740 @end ifset
7741 @ifset V850
7742 * V850-Dependent::              V850 Dependent Features
7743 @end ifset
7744 @ifset VAX
7745 * Vax-Dependent::               VAX Dependent Features
7746 @end ifset
7747 @ifset VISIUM
7748 * Visium-Dependent::            Visium Dependent Features
7749 @end ifset
7750 @ifset WASM32
7751 * WebAssembly-Dependent::       WebAssembly Dependent Features
7752 @end ifset
7753 @ifset XGATE
7754 * XGATE-Dependent::             XGATE Dependent Features
7755 @end ifset
7756 @ifset XSTORMY16
7757 * XSTORMY16-Dependent::         XStormy16 Dependent Features
7758 @end ifset
7759 @ifset XTENSA
7760 * Xtensa-Dependent::            Xtensa Dependent Features
7761 @end ifset
7762 @ifset Z80
7763 * Z80-Dependent::               Z80 Dependent Features
7764 @end ifset
7765 @ifset Z8000
7766 * Z8000-Dependent::             Z8000 Dependent Features
7767 @end ifset
7768 @end menu
7770 @lowersections
7771 @end ifset
7773 @c The following major nodes are *sections* in the GENERIC version, *chapters*
7774 @c in single-cpu versions.  This is mainly achieved by @lowersections.  There is a
7775 @c peculiarity: to preserve cross-references, there must be a node called
7776 @c "Machine Dependencies".  Hence the conditional nodenames in each
7777 @c major node below.  Node defaulting in makeinfo requires adjacency of
7778 @c node and sectioning commands; hence the repetition of @chapter BLAH
7779 @c in both conditional blocks.
7781 @ifset AARCH64
7782 @include c-aarch64.texi
7783 @end ifset
7785 @ifset ALPHA
7786 @include c-alpha.texi
7787 @end ifset
7789 @ifset ARC
7790 @include c-arc.texi
7791 @end ifset
7793 @ifset ARM
7794 @include c-arm.texi
7795 @end ifset
7797 @ifset AVR
7798 @include c-avr.texi
7799 @end ifset
7801 @ifset Blackfin
7802 @include c-bfin.texi
7803 @end ifset
7805 @ifset CR16
7806 @include c-cr16.texi
7807 @end ifset
7809 @ifset CRIS
7810 @include c-cris.texi
7811 @end ifset
7813 @ifset CSKY
7814 @include c-csky.texi
7815 @end ifset
7817 @ifset Renesas-all
7818 @ifclear GENERIC
7819 @node Machine Dependencies
7820 @chapter Machine Dependent Features
7822 The machine instruction sets are different on each Renesas chip family,
7823 and there are also some syntax differences among the families.  This
7824 chapter describes the specific @command{@value{AS}} features for each
7825 family.
7827 @menu
7828 * H8/300-Dependent::            Renesas H8/300 Dependent Features
7829 * SH-Dependent::                Renesas SH Dependent Features
7830 @end menu
7831 @lowersections
7832 @end ifclear
7833 @end ifset
7835 @ifset D10V
7836 @include c-d10v.texi
7837 @end ifset
7839 @ifset D30V
7840 @include c-d30v.texi
7841 @end ifset
7843 @ifset EPIPHANY
7844 @include c-epiphany.texi
7845 @end ifset
7847 @ifset H8/300
7848 @include c-h8300.texi
7849 @end ifset
7851 @ifset HPPA
7852 @include c-hppa.texi
7853 @end ifset
7855 @ifset I80386
7856 @include c-i386.texi
7857 @end ifset
7859 @ifset IA64
7860 @include c-ia64.texi
7861 @end ifset
7863 @ifset IP2K
7864 @include c-ip2k.texi
7865 @end ifset
7867 @ifset LM32
7868 @include c-lm32.texi
7869 @end ifset
7871 @ifset M32C
7872 @include c-m32c.texi
7873 @end ifset
7875 @ifset M32R
7876 @include c-m32r.texi
7877 @end ifset
7879 @ifset M680X0
7880 @include c-m68k.texi
7881 @end ifset
7883 @ifset M68HC11
7884 @include c-m68hc11.texi
7885 @end ifset
7887 @ifset S12Z
7888 @include c-s12z.texi
7889 @end ifset
7891 @ifset METAG
7892 @include c-metag.texi
7893 @end ifset
7895 @ifset MICROBLAZE
7896 @include c-microblaze.texi
7897 @end ifset
7899 @ifset MIPS
7900 @include c-mips.texi
7901 @end ifset
7903 @ifset MMIX
7904 @include c-mmix.texi
7905 @end ifset
7907 @ifset MSP430
7908 @include c-msp430.texi
7909 @end ifset
7911 @ifset NDS32
7912 @include c-nds32.texi
7913 @end ifset
7915 @ifset NIOSII
7916 @include c-nios2.texi
7917 @end ifset
7919 @ifset NS32K
7920 @include c-ns32k.texi
7921 @end ifset
7923 @ifset OPENRISC
7924 @include c-or1k.texi
7925 @end ifset
7927 @ifset PDP11
7928 @include c-pdp11.texi
7929 @end ifset
7931 @ifset PJ
7932 @include c-pj.texi
7933 @end ifset
7935 @ifset PPC
7936 @include c-ppc.texi
7937 @end ifset
7939 @ifset PRU
7940 @include c-pru.texi
7941 @end ifset
7943 @ifset RISCV
7944 @include c-riscv.texi
7945 @end ifset
7947 @ifset RL78
7948 @include c-rl78.texi
7949 @end ifset
7951 @ifset RX
7952 @include c-rx.texi
7953 @end ifset
7955 @ifset S390
7956 @include c-s390.texi
7957 @end ifset
7959 @ifset SCORE
7960 @include c-score.texi
7961 @end ifset
7963 @ifset SH
7964 @include c-sh.texi
7965 @end ifset
7967 @ifset SPARC
7968 @include c-sparc.texi
7969 @end ifset
7971 @ifset TIC54X
7972 @include c-tic54x.texi
7973 @end ifset
7975 @ifset TIC6X
7976 @include c-tic6x.texi
7977 @end ifset
7979 @ifset TILEGX
7980 @include c-tilegx.texi
7981 @end ifset
7983 @ifset TILEPRO
7984 @include c-tilepro.texi
7985 @end ifset
7987 @ifset V850
7988 @include c-v850.texi
7989 @end ifset
7991 @ifset VAX
7992 @include c-vax.texi
7993 @end ifset
7995 @ifset VISIUM
7996 @include c-visium.texi
7997 @end ifset
7999 @ifset WASM32
8000 @include c-wasm32.texi
8001 @end ifset
8003 @ifset XGATE
8004 @include c-xgate.texi
8005 @end ifset
8007 @ifset XSTORMY16
8008 @include c-xstormy16.texi
8009 @end ifset
8011 @ifset XTENSA
8012 @include c-xtensa.texi
8013 @end ifset
8015 @ifset Z80
8016 @include c-z80.texi
8017 @end ifset
8019 @ifset Z8000
8020 @include c-z8k.texi
8021 @end ifset
8023 @ifset GENERIC
8024 @c reverse effect of @down at top of generic Machine-Dep chapter
8025 @raisesections
8026 @end ifset
8028 @node Reporting Bugs
8029 @chapter Reporting Bugs
8030 @cindex bugs in assembler
8031 @cindex reporting bugs in assembler
8033 Your bug reports play an essential role in making @command{@value{AS}} reliable.
8035 Reporting a bug may help you by bringing a solution to your problem, or it may
8036 not.  But in any case the principal function of a bug report is to help the
8037 entire community by making the next version of @command{@value{AS}} work better.
8038 Bug reports are your contribution to the maintenance of @command{@value{AS}}.
8040 In order for a bug report to serve its purpose, you must include the
8041 information that enables us to fix the bug.
8043 @menu
8044 * Bug Criteria::                Have you found a bug?
8045 * Bug Reporting::               How to report bugs
8046 @end menu
8048 @node Bug Criteria
8049 @section Have You Found a Bug?
8050 @cindex bug criteria
8052 If you are not sure whether you have found a bug, here are some guidelines:
8054 @itemize @bullet
8055 @cindex fatal signal
8056 @cindex assembler crash
8057 @cindex crash of assembler
8058 @item
8059 If the assembler gets a fatal signal, for any input whatever, that is a
8060 @command{@value{AS}} bug.  Reliable assemblers never crash.
8062 @cindex error on valid input
8063 @item
8064 If @command{@value{AS}} produces an error message for valid input, that is a bug.
8066 @cindex invalid input
8067 @item
8068 If @command{@value{AS}} does not produce an error message for invalid input, that
8069 is a bug.  However, you should note that your idea of ``invalid input'' might
8070 be our idea of ``an extension'' or ``support for traditional practice''.
8072 @item
8073 If you are an experienced user of assemblers, your suggestions for improvement
8074 of @command{@value{AS}} are welcome in any case.
8075 @end itemize
8077 @node Bug Reporting
8078 @section How to Report Bugs
8079 @cindex bug reports
8080 @cindex assembler bugs, reporting
8082 A number of companies and individuals offer support for @sc{gnu} products.  If
8083 you obtained @command{@value{AS}} from a support organization, we recommend you
8084 contact that organization first.
8086 You can find contact information for many support companies and
8087 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
8088 distribution.
8090 @ifset BUGURL
8091 In any event, we also recommend that you send bug reports for @command{@value{AS}}
8092 to @value{BUGURL}.
8093 @end ifset
8095 The fundamental principle of reporting bugs usefully is this:
8096 @strong{report all the facts}.  If you are not sure whether to state a
8097 fact or leave it out, state it!
8099 Often people omit facts because they think they know what causes the problem
8100 and assume that some details do not matter.  Thus, you might assume that the
8101 name of a symbol you use in an example does not matter.  Well, probably it does
8102 not, but one cannot be sure.  Perhaps the bug is a stray memory reference which
8103 happens to fetch from the location where that name is stored in memory;
8104 perhaps, if the name were different, the contents of that location would fool
8105 the assembler into doing the right thing despite the bug.  Play it safe and
8106 give a specific, complete example.  That is the easiest thing for you to do,
8107 and the most helpful.
8109 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
8110 it is new to us.  Therefore, always write your bug reports on the assumption
8111 that the bug has not been reported previously.
8113 Sometimes people give a few sketchy facts and ask, ``Does this ring a
8114 bell?''  This cannot help us fix a bug, so it is basically useless.  We
8115 respond by asking for enough details to enable us to investigate.
8116 You might as well expedite matters by sending them to begin with.
8118 To enable us to fix the bug, you should include all these things:
8120 @itemize @bullet
8121 @item
8122 The version of @command{@value{AS}}.  @command{@value{AS}} announces it if you start
8123 it with the @samp{--version} argument.
8125 Without this, we will not know whether there is any point in looking for
8126 the bug in the current version of @command{@value{AS}}.
8128 @item
8129 Any patches you may have applied to the @command{@value{AS}} source.
8131 @item
8132 The type of machine you are using, and the operating system name and
8133 version number.
8135 @item
8136 What compiler (and its version) was used to compile @command{@value{AS}}---e.g.
8137 ``@code{gcc-2.7}''.
8139 @item
8140 The command arguments you gave the assembler to assemble your example and
8141 observe the bug.  To guarantee you will not omit something important, list them
8142 all.  A copy of the Makefile (or the output from make) is sufficient.
8144 If we were to try to guess the arguments, we would probably guess wrong
8145 and then we might not encounter the bug.
8147 @item
8148 A complete input file that will reproduce the bug.  If the bug is observed when
8149 the assembler is invoked via a compiler, send the assembler source, not the
8150 high level language source.  Most compilers will produce the assembler source
8151 when run with the @samp{-S} option.  If you are using @code{@value{GCC}}, use
8152 the options @samp{-v --save-temps}; this will save the assembler source in a
8153 file with an extension of @file{.s}, and also show you exactly how
8154 @command{@value{AS}} is being run.
8156 @item
8157 A description of what behavior you observe that you believe is
8158 incorrect.  For example, ``It gets a fatal signal.''
8160 Of course, if the bug is that @command{@value{AS}} gets a fatal signal, then we
8161 will certainly notice it.  But if the bug is incorrect output, we might not
8162 notice unless it is glaringly wrong.  You might as well not give us a chance to
8163 make a mistake.
8165 Even if the problem you experience is a fatal signal, you should still say so
8166 explicitly.  Suppose something strange is going on, such as, your copy of
8167 @command{@value{AS}} is out of sync, or you have encountered a bug in the C
8168 library on your system.  (This has happened!)  Your copy might crash and ours
8169 would not.  If you told us to expect a crash, then when ours fails to crash, we
8170 would know that the bug was not happening for us.  If you had not told us to
8171 expect a crash, then we would not be able to draw any conclusion from our
8172 observations.
8174 @item
8175 If you wish to suggest changes to the @command{@value{AS}} source, send us context
8176 diffs, as generated by @code{diff} with the @samp{-u}, @samp{-c}, or @samp{-p}
8177 option.  Always send diffs from the old file to the new file.  If you even
8178 discuss something in the @command{@value{AS}} source, refer to it by context, not
8179 by line number.
8181 The line numbers in our development sources will not match those in your
8182 sources.  Your line numbers would convey no useful information to us.
8183 @end itemize
8185 Here are some things that are not necessary:
8187 @itemize @bullet
8188 @item
8189 A description of the envelope of the bug.
8191 Often people who encounter a bug spend a lot of time investigating
8192 which changes to the input file will make the bug go away and which
8193 changes will not affect it.
8195 This is often time consuming and not very useful, because the way we
8196 will find the bug is by running a single example under the debugger
8197 with breakpoints, not by pure deduction from a series of examples.
8198 We recommend that you save your time for something else.
8200 Of course, if you can find a simpler example to report @emph{instead}
8201 of the original one, that is a convenience for us.  Errors in the
8202 output will be easier to spot, running under the debugger will take
8203 less time, and so on.
8205 However, simplification is not vital; if you do not want to do this,
8206 report the bug anyway and send us the entire test case you used.
8208 @item
8209 A patch for the bug.
8211 A patch for the bug does help us if it is a good one.  But do not omit
8212 the necessary information, such as the test case, on the assumption that
8213 a patch is all we need.  We might see problems with your patch and decide
8214 to fix the problem another way, or we might not understand it at all.
8216 Sometimes with a program as complicated as @command{@value{AS}} it is very hard to
8217 construct an example that will make the program follow a certain path through
8218 the code.  If you do not send us the example, we will not be able to construct
8219 one, so we will not be able to verify that the bug is fixed.
8221 And if we cannot understand what bug you are trying to fix, or why your
8222 patch should be an improvement, we will not install it.  A test case will
8223 help us to understand.
8225 @item
8226 A guess about what the bug is or what it depends on.
8228 Such guesses are usually wrong.  Even we cannot guess right about such
8229 things without first using the debugger to find the facts.
8230 @end itemize
8232 @node Acknowledgements
8233 @chapter Acknowledgements
8235 If you have contributed to GAS and your name isn't listed here,
8236 it is not meant as a slight.  We just don't know about it.  Send mail to the
8237 maintainer, and we'll correct the situation.  Currently
8238 @c (October 2012),
8239 the maintainer is Nick Clifton (email address @code{nickc@@redhat.com}).
8241 Dean Elsner wrote the original @sc{gnu} assembler for the VAX.@footnote{Any
8242 more details?}
8244 Jay Fenlason maintained GAS for a while, adding support for GDB-specific debug
8245 information and the 68k series machines, most of the preprocessing pass, and
8246 extensive changes in @file{messages.c}, @file{input-file.c}, @file{write.c}.
8248 K. Richard Pixley maintained GAS for a while, adding various enhancements and
8249 many bug fixes, including merging support for several processors, breaking GAS
8250 up to handle multiple object file format back ends (including heavy rewrite,
8251 testing, an integration of the coff and b.out back ends), adding configuration
8252 including heavy testing and verification of cross assemblers and file splits
8253 and renaming, converted GAS to strictly ANSI C including full prototypes, added
8254 support for m680[34]0 and cpu32, did considerable work on i960 including a COFF
8255 port (including considerable amounts of reverse engineering), a SPARC opcode
8256 file rewrite, DECstation, rs6000, and hp300hpux host ports, updated ``know''
8257 assertions and made them work, much other reorganization, cleanup, and lint.
8259 Ken Raeburn wrote the high-level BFD interface code to replace most of the code
8260 in format-specific I/O modules.
8262 The original VMS support was contributed by David L. Kashtan.  Eric Youngdale
8263 has done much work with it since.
8265 The Intel 80386 machine description was written by Eliot Dresselhaus.
8267 Minh Tran-Le at IntelliCorp contributed some AIX 386 support.
8269 The Motorola 88k machine description was contributed by Devon Bowen of Buffalo
8270 University and Torbjorn Granlund of the Swedish Institute of Computer Science.
8272 Keith Knowles at the Open Software Foundation wrote the original MIPS back end
8273 (@file{tc-mips.c}, @file{tc-mips.h}), and contributed Rose format support
8274 (which hasn't been merged in yet).  Ralph Campbell worked with the MIPS code to
8275 support a.out format.
8277 Support for the Zilog Z8k and Renesas H8/300 processors (tc-z8k,
8278 tc-h8300), and IEEE 695 object file format (obj-ieee), was written by
8279 Steve Chamberlain of Cygnus Support.  Steve also modified the COFF back end to
8280 use BFD for some low-level operations, for use with the H8/300 and AMD 29k
8281 targets.
8283 John Gilmore built the AMD 29000 support, added @code{.include} support, and
8284 simplified the configuration of which versions accept which directives.  He
8285 updated the 68k machine description so that Motorola's opcodes always produced
8286 fixed-size instructions (e.g., @code{jsr}), while synthetic instructions
8287 remained shrinkable (@code{jbsr}).  John fixed many bugs, including true tested
8288 cross-compilation support, and one bug in relaxation that took a week and
8289 required the proverbial one-bit fix.
8291 Ian Lance Taylor of Cygnus Support merged the Motorola and MIT syntax for the
8292 68k, completed support for some COFF targets (68k, i386 SVR3, and SCO Unix),
8293 added support for MIPS ECOFF and ELF targets, wrote the initial RS/6000 and
8294 PowerPC assembler, and made a few other minor patches.
8296 Steve Chamberlain made GAS able to generate listings.
8298 Hewlett-Packard contributed support for the HP9000/300.
8300 Jeff Law wrote GAS and BFD support for the native HPPA object format (SOM)
8301 along with a fairly extensive HPPA testsuite (for both SOM and ELF object
8302 formats).  This work was supported by both the Center for Software Science at
8303 the University of Utah and Cygnus Support.
8305 Support for ELF format files has been worked on by Mark Eichin of Cygnus
8306 Support (original, incomplete implementation for SPARC), Pete Hoogenboom and
8307 Jeff Law at the University of Utah (HPPA mainly), Michael Meissner of the Open
8308 Software Foundation (i386 mainly), and Ken Raeburn of Cygnus Support (sparc,
8309 and some initial 64-bit support).
8311 Linas Vepstas added GAS support for the ESA/390 ``IBM 370'' architecture.
8313 Richard Henderson rewrote the Alpha assembler. Klaus Kaempf wrote GAS and BFD
8314 support for openVMS/Alpha.
8316 Timothy Wall, Michael Hayes, and Greg Smart contributed to the various tic*
8317 flavors.
8319 David Heine, Sterling Augustine, Bob Wilson and John Ruttenberg from Tensilica,
8320 Inc.@: added support for Xtensa processors.
8322 Several engineers at Cygnus Support have also provided many small bug fixes and
8323 configuration enhancements.
8325 Jon Beniston added support for the Lattice Mico32 architecture.
8327 Many others have contributed large or small bugfixes and enhancements.  If
8328 you have contributed significant work and are not mentioned on this list, and
8329 want to be, let us know.  Some of the history has been lost; we are not
8330 intentionally leaving anyone out.
8332 @node GNU Free Documentation License
8333 @appendix GNU Free Documentation License
8334 @include fdl.texi
8336 @node AS Index
8337 @unnumbered AS Index
8339 @printindex cp
8341 @bye
8342 @c Local Variables:
8343 @c fill-column: 79
8344 @c End: