bfd:
[binutils.git] / gas / doc / as.texinfo
blob0c4662bd2ddad9fe9d2b373cfbb3a2b4b1d3cb13
1 \input texinfo @c                               -*-Texinfo-*-
2 @c  Copyright 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
3 @c  2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 @c  Free Software Foundation, Inc.
5 @c UPDATE!!  On future updates--
6 @c   (1)   check for new machine-dep cmdline options in
7 @c         md_parse_option definitions in config/tc-*.c
8 @c   (2)   for platform-specific directives, examine md_pseudo_op
9 @c         in config/tc-*.c
10 @c   (3)   for object-format specific directives, examine obj_pseudo_op
11 @c         in config/obj-*.c
12 @c   (4)   portable directives in potable[] in read.c
13 @c %**start of header
14 @setfilename as.info
15 @c ---config---
16 @macro gcctabopt{body}
17 @code{\body\}
18 @end macro
19 @c defaults, config file may override:
20 @set have-stabs
21 @c ---
22 @c man begin NAME
23 @c ---
24 @include asconfig.texi
25 @include bfdver.texi
26 @c ---
27 @c man end
28 @c ---
29 @c common OR combinations of conditions
30 @ifset COFF
31 @set COFF-ELF
32 @end ifset
33 @ifset ELF
34 @set COFF-ELF
35 @end ifset
36 @ifset AOUT
37 @set aout-bout
38 @end ifset
39 @ifset ARM/Thumb
40 @set ARM
41 @end ifset
42 @ifset Blackfin
43 @set Blackfin
44 @end ifset
45 @ifset BOUT
46 @set aout-bout
47 @end ifset
48 @ifset H8/300
49 @set H8
50 @end ifset
51 @ifset SH
52 @set H8
53 @end ifset
54 @ifset HPPA
55 @set abnormal-separator
56 @end ifset
57 @c ------------
58 @ifset GENERIC
59 @settitle Using @value{AS}
60 @end ifset
61 @ifclear GENERIC
62 @settitle Using @value{AS} (@value{TARGET})
63 @end ifclear
64 @setchapternewpage odd
65 @c %**end of header
67 @c @smallbook
68 @c @set SMALL
69 @c WARE! Some of the machine-dependent sections contain tables of machine
70 @c instructions.  Except in multi-column format, these tables look silly.
71 @c Unfortunately, Texinfo doesn't have a general-purpose multi-col format, so
72 @c the multi-col format is faked within @example sections.
74 @c Again unfortunately, the natural size that fits on a page, for these tables,
75 @c is different depending on whether or not smallbook is turned on.
76 @c This matters, because of order: text flow switches columns at each page
77 @c break.
79 @c The format faked in this source works reasonably well for smallbook,
80 @c not well for the default large-page format.  This manual expects that if you
81 @c turn on @smallbook, you will also uncomment the "@set SMALL" to enable the
82 @c tables in question.  You can turn on one without the other at your
83 @c discretion, of course.
84 @ifinfo
85 @set SMALL
86 @c the insn tables look just as silly in info files regardless of smallbook,
87 @c might as well show 'em anyways.
88 @end ifinfo
90 @ifnottex
91 @dircategory Software development
92 @direntry
93 * As: (as).                     The GNU assembler.
94 * Gas: (as).                    The GNU assembler.
95 @end direntry
96 @end ifnottex
98 @finalout
99 @syncodeindex ky cp
101 @copying
102 This file documents the GNU Assembler "@value{AS}".
104 @c man begin COPYRIGHT
105 Copyright @copyright{} 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
106 2000, 2001, 2002, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
108 Permission is granted to copy, distribute and/or modify this document
109 under the terms of the GNU Free Documentation License, Version 1.3
110 or any later version published by the Free Software Foundation;
111 with no Invariant Sections, with no Front-Cover Texts, and with no
112 Back-Cover Texts.  A copy of the license is included in the
113 section entitled ``GNU Free Documentation License''.
115 @c man end
116 @end copying
118 @titlepage
119 @title Using @value{AS}
120 @subtitle The @sc{gnu} Assembler
121 @ifclear GENERIC
122 @subtitle for the @value{TARGET} family
123 @end ifclear
124 @ifset VERSION_PACKAGE
125 @sp 1
126 @subtitle @value{VERSION_PACKAGE}
127 @end ifset
128 @sp 1
129 @subtitle Version @value{VERSION}
130 @sp 1
131 @sp 13
132 The Free Software Foundation Inc.@: thanks The Nice Computer
133 Company of Australia for loaning Dean Elsner to write the
134 first (Vax) version of @command{as} for Project @sc{gnu}.
135 The proprietors, management and staff of TNCCA thank FSF for
136 distracting the boss while they got some work
137 done.
138 @sp 3
139 @author Dean Elsner, Jay Fenlason & friends
140 @page
141 @tex
142 {\parskip=0pt
143 \hfill {\it Using {\tt @value{AS}}}\par
144 \hfill Edited by Cygnus Support\par
146 %"boxit" macro for figures:
147 %Modified from Knuth's ``boxit'' macro from TeXbook (answer to exercise 21.3)
148 \gdef\boxit#1#2{\vbox{\hrule\hbox{\vrule\kern3pt
149      \vbox{\parindent=0pt\parskip=0pt\hsize=#1\kern3pt\strut\hfil
150 #2\hfil\strut\kern3pt}\kern3pt\vrule}\hrule}}%box with visible outline
151 \gdef\ibox#1#2{\hbox to #1{#2\hfil}\kern8pt}% invisible box
152 @end tex
154 @vskip 0pt plus 1filll
155 Copyright @copyright{} 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
156 2000, 2001, 2002, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
158       Permission is granted to copy, distribute and/or modify this document
159       under the terms of the GNU Free Documentation License, Version 1.3
160       or any later version published by the Free Software Foundation;
161       with no Invariant Sections, with no Front-Cover Texts, and with no
162       Back-Cover Texts.  A copy of the license is included in the
163       section entitled ``GNU Free Documentation License''.
165 @end titlepage
166 @contents
168 @ifnottex
169 @node Top
170 @top Using @value{AS}
172 This file is a user guide to the @sc{gnu} assembler @command{@value{AS}}
173 @ifset VERSION_PACKAGE
174 @value{VERSION_PACKAGE}
175 @end ifset
176 version @value{VERSION}.
177 @ifclear GENERIC
178 This version of the file describes @command{@value{AS}} configured to generate
179 code for @value{TARGET} architectures.
180 @end ifclear
182 This document is distributed under the terms of the GNU Free
183 Documentation License.  A copy of the license is included in the
184 section entitled ``GNU Free Documentation License''.
186 @menu
187 * Overview::                    Overview
188 * Invoking::                    Command-Line Options
189 * Syntax::                      Syntax
190 * Sections::                    Sections and Relocation
191 * Symbols::                     Symbols
192 * Expressions::                 Expressions
193 * Pseudo Ops::                  Assembler Directives
194 @ifset ELF
195 * Object Attributes::           Object Attributes
196 @end ifset
197 * Machine Dependencies::        Machine Dependent Features
198 * Reporting Bugs::              Reporting Bugs
199 * Acknowledgements::            Who Did What
200 * GNU Free Documentation License::  GNU Free Documentation License
201 * AS Index::                    AS Index
202 @end menu
203 @end ifnottex
205 @node Overview
206 @chapter Overview
207 @iftex
208 This manual is a user guide to the @sc{gnu} assembler @command{@value{AS}}.
209 @ifclear GENERIC
210 This version of the manual describes @command{@value{AS}} configured to generate
211 code for @value{TARGET} architectures.
212 @end ifclear
213 @end iftex
215 @cindex invocation summary
216 @cindex option summary
217 @cindex summary of options
218 Here is a brief summary of how to invoke @command{@value{AS}}.  For details,
219 see @ref{Invoking,,Command-Line Options}.
221 @c man title AS the portable GNU assembler.
223 @ignore
224 @c man begin SEEALSO
225 gcc(1), ld(1), and the Info entries for @file{binutils} and @file{ld}.
226 @c man end
227 @end ignore
229 @c We don't use deffn and friends for the following because they seem
230 @c to be limited to one line for the header.
231 @smallexample
232 @c man begin SYNOPSIS
233 @value{AS} [@b{-a}[@b{cdghlns}][=@var{file}]] [@b{--alternate}] [@b{-D}]
234  [@b{--compress-debug-sections}]  [@b{--nocompress-debug-sections}]
235  [@b{--debug-prefix-map} @var{old}=@var{new}]
236  [@b{--defsym} @var{sym}=@var{val}] [@b{-f}] [@b{-g}] [@b{--gstabs}]
237  [@b{--gstabs+}] [@b{--gdwarf-2}] [@b{--help}] [@b{-I} @var{dir}] [@b{-J}]
238  [@b{-K}] [@b{-L}] [@b{--listing-lhs-width}=@var{NUM}]
239  [@b{--listing-lhs-width2}=@var{NUM}] [@b{--listing-rhs-width}=@var{NUM}]
240  [@b{--listing-cont-lines}=@var{NUM}] [@b{--keep-locals}] [@b{-o}
241  @var{objfile}] [@b{-R}] [@b{--reduce-memory-overheads}] [@b{--statistics}]
242  [@b{-v}] [@b{-version}] [@b{--version}] [@b{-W}] [@b{--warn}]
243  [@b{--fatal-warnings}] [@b{-w}] [@b{-x}] [@b{-Z}] [@b{@@@var{FILE}}]
244  [@b{--target-help}] [@var{target-options}]
245  [@b{--}|@var{files} @dots{}]
247 @c Target dependent options are listed below.  Keep the list sorted.
248 @c Add an empty line for separation.
249 @ifset ALPHA
251 @emph{Target Alpha options:}
252    [@b{-m@var{cpu}}]
253    [@b{-mdebug} | @b{-no-mdebug}]
254    [@b{-replace} | @b{-noreplace}]
255    [@b{-relax}] [@b{-g}] [@b{-G@var{size}}]
256    [@b{-F}] [@b{-32addr}]
257 @end ifset
258 @ifset ARC
260 @emph{Target ARC options:}
261    [@b{-marc[5|6|7|8]}]
262    [@b{-EB}|@b{-EL}]
263 @end ifset
264 @ifset ARM
266 @emph{Target ARM options:}
267 @c Don't document the deprecated options
268    [@b{-mcpu}=@var{processor}[+@var{extension}@dots{}]]
269    [@b{-march}=@var{architecture}[+@var{extension}@dots{}]]
270    [@b{-mfpu}=@var{floating-point-format}]
271    [@b{-mfloat-abi}=@var{abi}]
272    [@b{-meabi}=@var{ver}]
273    [@b{-mthumb}]
274    [@b{-EB}|@b{-EL}]
275    [@b{-mapcs-32}|@b{-mapcs-26}|@b{-mapcs-float}|
276     @b{-mapcs-reentrant}]
277    [@b{-mthumb-interwork}] [@b{-k}]
278 @end ifset
279 @ifset Blackfin
281 @emph{Target Blackfin options:}
282    [@b{-mcpu}=@var{processor}[-@var{sirevision}]]
283    [@b{-mfdpic}]
284    [@b{-mno-fdpic}]
285    [@b{-mnopic}]
286 @end ifset
287 @ifset CRIS
289 @emph{Target CRIS options:}
290    [@b{--underscore} | @b{--no-underscore}]
291    [@b{--pic}] [@b{-N}]
292    [@b{--emulation=criself} | @b{--emulation=crisaout}]
293    [@b{--march=v0_v10} | @b{--march=v10} | @b{--march=v32} | @b{--march=common_v10_v32}]
294 @c Deprecated -- deliberately not documented.
295 @c [@b{-h}] [@b{-H}]
296 @end ifset
297 @ifset D10V
299 @emph{Target D10V options:}
300    [@b{-O}]
301 @end ifset
302 @ifset D30V
304 @emph{Target D30V options:}
305    [@b{-O}|@b{-n}|@b{-N}]
306 @end ifset
307 @ifset H8
309 @emph{Target H8/300 options:}
310    [-h-tick-hex]
311 @end ifset
312 @ifset HPPA
313 @c HPPA has no machine-dependent assembler options (yet).
314 @end ifset
315 @ifset I80386
317 @emph{Target i386 options:}
318    [@b{--32}|@b{--64}] [@b{-n}]
319    [@b{-march}=@var{CPU}[+@var{EXTENSION}@dots{}]] [@b{-mtune}=@var{CPU}]
320 @end ifset
321 @ifset I960
323 @emph{Target i960 options:}
324 @c see md_parse_option in tc-i960.c
325    [@b{-ACA}|@b{-ACA_A}|@b{-ACB}|@b{-ACC}|@b{-AKA}|@b{-AKB}|
326     @b{-AKC}|@b{-AMC}]
327    [@b{-b}] [@b{-no-relax}]
328 @end ifset
329 @ifset IA64
331 @emph{Target IA-64 options:}
332    [@b{-mconstant-gp}|@b{-mauto-pic}]
333    [@b{-milp32}|@b{-milp64}|@b{-mlp64}|@b{-mp64}]
334    [@b{-mle}|@b{mbe}]
335    [@b{-mtune=itanium1}|@b{-mtune=itanium2}]
336    [@b{-munwind-check=warning}|@b{-munwind-check=error}]
337    [@b{-mhint.b=ok}|@b{-mhint.b=warning}|@b{-mhint.b=error}]
338    [@b{-x}|@b{-xexplicit}] [@b{-xauto}] [@b{-xdebug}]
339 @end ifset
340 @ifset IP2K
342 @emph{Target IP2K options:}
343    [@b{-mip2022}|@b{-mip2022ext}]
344 @end ifset
345 @ifset M32C
347 @emph{Target M32C options:}
348    [@b{-m32c}|@b{-m16c}] [-relax] [-h-tick-hex]
349 @end ifset
350 @ifset M32R
352 @emph{Target M32R options:}
353    [@b{--m32rx}|@b{--[no-]warn-explicit-parallel-conflicts}|
354    @b{--W[n]p}]
355 @end ifset
356 @ifset M680X0
358 @emph{Target M680X0 options:}
359    [@b{-l}] [@b{-m68000}|@b{-m68010}|@b{-m68020}|@dots{}]
360 @end ifset
361 @ifset M68HC11
363 @emph{Target M68HC11 options:}
364    [@b{-m68hc11}|@b{-m68hc12}|@b{-m68hcs12}]
365    [@b{-mshort}|@b{-mlong}]
366    [@b{-mshort-double}|@b{-mlong-double}]
367    [@b{--force-long-branches}] [@b{--short-branches}]
368    [@b{--strict-direct-mode}] [@b{--print-insn-syntax}]
369    [@b{--print-opcodes}] [@b{--generate-example}]
370 @end ifset
371 @ifset MCORE
373 @emph{Target MCORE options:}
374    [@b{-jsri2bsr}] [@b{-sifilter}] [@b{-relax}]
375    [@b{-mcpu=[210|340]}]
376 @end ifset
377 @ifset MICROBLAZE
378 @emph{Target MICROBLAZE options:}
379 @c MicroBlaze has no machine-dependent assembler options.
380 @end ifset
381 @ifset MIPS
383 @emph{Target MIPS options:}
384    [@b{-nocpp}] [@b{-EL}] [@b{-EB}] [@b{-O}[@var{optimization level}]]
385    [@b{-g}[@var{debug level}]] [@b{-G} @var{num}] [@b{-KPIC}] [@b{-call_shared}]
386    [@b{-non_shared}] [@b{-xgot} [@b{-mvxworks-pic}]
387    [@b{-mabi}=@var{ABI}] [@b{-32}] [@b{-n32}] [@b{-64}] [@b{-mfp32}] [@b{-mgp32}]
388    [@b{-march}=@var{CPU}] [@b{-mtune}=@var{CPU}] [@b{-mips1}] [@b{-mips2}]
389    [@b{-mips3}] [@b{-mips4}] [@b{-mips5}] [@b{-mips32}] [@b{-mips32r2}]
390    [@b{-mips64}] [@b{-mips64r2}]
391    [@b{-construct-floats}] [@b{-no-construct-floats}]
392    [@b{-trap}] [@b{-no-break}] [@b{-break}] [@b{-no-trap}]
393    [@b{-mips16}] [@b{-no-mips16}]
394    [@b{-msmartmips}] [@b{-mno-smartmips}]
395    [@b{-mips3d}] [@b{-no-mips3d}]
396    [@b{-mdmx}] [@b{-no-mdmx}]
397    [@b{-mdsp}] [@b{-mno-dsp}]
398    [@b{-mdspr2}] [@b{-mno-dspr2}]
399    [@b{-mmt}] [@b{-mno-mt}]
400    [@b{-mfix7000}] [@b{-mno-fix7000}]
401    [@b{-mfix-vr4120}] [@b{-mno-fix-vr4120}]
402    [@b{-mfix-vr4130}] [@b{-mno-fix-vr4130}]
403    [@b{-mdebug}] [@b{-no-mdebug}]
404    [@b{-mpdr}] [@b{-mno-pdr}]
405 @end ifset
406 @ifset MMIX
408 @emph{Target MMIX options:}
409    [@b{--fixed-special-register-names}] [@b{--globalize-symbols}]
410    [@b{--gnu-syntax}] [@b{--relax}] [@b{--no-predefined-symbols}]
411    [@b{--no-expand}] [@b{--no-merge-gregs}] [@b{-x}]
412    [@b{--linker-allocated-gregs}]
413 @end ifset
414 @ifset PDP11
416 @emph{Target PDP11 options:}
417    [@b{-mpic}|@b{-mno-pic}] [@b{-mall}] [@b{-mno-extensions}]
418    [@b{-m}@var{extension}|@b{-mno-}@var{extension}]
419    [@b{-m}@var{cpu}] [@b{-m}@var{machine}]
420 @end ifset
421 @ifset PJ
423 @emph{Target picoJava options:}
424    [@b{-mb}|@b{-me}]
425 @end ifset
426 @ifset PPC
428 @emph{Target PowerPC options:}
429    [@b{-mpwrx}|@b{-mpwr2}|@b{-mpwr}|@b{-m601}|@b{-mppc}|@b{-mppc32}|@b{-m603}|@b{-m604}|
430     @b{-m403}|@b{-m405}|@b{-mppc64}|@b{-m620}|@b{-mppc64bridge}|@b{-mbooke}]
431    [@b{-mcom}|@b{-many}|@b{-maltivec}|@b{-mvsx}] [@b{-memb}]
432    [@b{-mregnames}|@b{-mno-regnames}]
433    [@b{-mrelocatable}|@b{-mrelocatable-lib}]
434    [@b{-mlittle}|@b{-mlittle-endian}|@b{-mbig}|@b{-mbig-endian}]
435    [@b{-msolaris}|@b{-mno-solaris}]
436 @end ifset
437 @ifset RX
439 @emph{Target RX options:}
440    [@b{-mlittle-endian}|@b{-mbig-endian}]
441    [@b{-m32bit-ints}|@b{-m16bit-ints}]
442    [@b{-m32bit-doubles}|@b{-m64bit-doubles}]
443 @end ifset
444 @ifset S390
446 @emph{Target s390 options:}
447    [@b{-m31}|@b{-m64}] [@b{-mesa}|@b{-mzarch}] [@b{-march}=@var{CPU}]
448    [@b{-mregnames}|@b{-mno-regnames}]
449    [@b{-mwarn-areg-zero}]
450 @end ifset
451 @ifset SCORE
453 @emph{Target SCORE options:}
454    [@b{-EB}][@b{-EL}][@b{-FIXDD}][@b{-NWARN}]
455    [@b{-SCORE5}][@b{-SCORE5U}][@b{-SCORE7}][@b{-SCORE3}]
456    [@b{-march=score7}][@b{-march=score3}]
457    [@b{-USE_R1}][@b{-KPIC}][@b{-O0}][@b{-G} @var{num}][@b{-V}]
458 @end ifset
459 @ifset SPARC
461 @emph{Target SPARC options:}
462 @c The order here is important.  See c-sparc.texi.
463    [@b{-Av6}|@b{-Av7}|@b{-Av8}|@b{-Asparclet}|@b{-Asparclite}
464     @b{-Av8plus}|@b{-Av8plusa}|@b{-Av9}|@b{-Av9a}]
465    [@b{-xarch=v8plus}|@b{-xarch=v8plusa}] [@b{-bump}]
466    [@b{-32}|@b{-64}]
467 @end ifset
468 @ifset TIC54X
470 @emph{Target TIC54X options:}
471  [@b{-mcpu=54[123589]}|@b{-mcpu=54[56]lp}] [@b{-mfar-mode}|@b{-mf}]
472  [@b{-merrors-to-file} @var{<filename>}|@b{-me} @var{<filename>}]
473 @end ifset
475 @ifset TIC6X
477 @emph{Target TIC6X options:}
478    [@b{-march=@var{arch}}] [@b{-matomic}|@b{-mno-atomic}]
479    [@b{-mbig-endian}|@b{-mlittle-endian}] [@b{-mdsbt}|@b{-mno-dsbt}]
480 @end ifset
482 @ifset Z80
484 @emph{Target Z80 options:}
485   [@b{-z80}] [@b{-r800}]
486   [@b{ -ignore-undocumented-instructions}] [@b{-Wnud}]
487   [@b{ -ignore-unportable-instructions}] [@b{-Wnup}]
488   [@b{ -warn-undocumented-instructions}] [@b{-Wud}]
489   [@b{ -warn-unportable-instructions}] [@b{-Wup}]
490   [@b{ -forbid-undocumented-instructions}] [@b{-Fud}]
491   [@b{ -forbid-unportable-instructions}] [@b{-Fup}]
492 @end ifset
494 @ifset Z8000
495 @c Z8000 has no machine-dependent assembler options
496 @end ifset
497 @ifset XTENSA
499 @emph{Target Xtensa options:}
500  [@b{--[no-]text-section-literals}] [@b{--[no-]absolute-literals}]
501  [@b{--[no-]target-align}] [@b{--[no-]longcalls}]
502  [@b{--[no-]transform}]
503  [@b{--rename-section} @var{oldname}=@var{newname}]
504 @end ifset
505 @c man end
506 @end smallexample
508 @c man begin OPTIONS
510 @table @gcctabopt
511 @include at-file.texi
513 @item -a[cdghlmns]
514 Turn on listings, in any of a variety of ways:
516 @table @gcctabopt
517 @item -ac
518 omit false conditionals
520 @item -ad
521 omit debugging directives
523 @item -ag
524 include general information, like @value{AS} version and options passed
526 @item -ah
527 include high-level source
529 @item -al
530 include assembly
532 @item -am
533 include macro expansions
535 @item -an
536 omit forms processing
538 @item -as
539 include symbols
541 @item =file
542 set the name of the listing file
543 @end table
545 You may combine these options; for example, use @samp{-aln} for assembly
546 listing without forms processing.  The @samp{=file} option, if used, must be
547 the last one.  By itself, @samp{-a} defaults to @samp{-ahls}.
549 @item --alternate
550 Begin in alternate macro mode.
551 @ifclear man
552 @xref{Altmacro,,@code{.altmacro}}.
553 @end ifclear
555 @item --compress-debug-sections
556 Compress DWARF debug sections using zlib.  The debug sections are renamed
557 to begin with @samp{.zdebug}, and the resulting object file may not be
558 compatible with older linkers and object file utilities.
560 @item --nocompress-debug-sections
561 Do not compress DWARF debug sections.  This is the default.
563 @item -D
564 Ignored.  This option is accepted for script compatibility with calls to
565 other assemblers.
567 @item --debug-prefix-map @var{old}=@var{new}
568 When assembling files in directory @file{@var{old}}, record debugging
569 information describing them as in @file{@var{new}} instead.
571 @item --defsym @var{sym}=@var{value}
572 Define the symbol @var{sym} to be @var{value} before assembling the input file.
573 @var{value} must be an integer constant.  As in C, a leading @samp{0x}
574 indicates a hexadecimal value, and a leading @samp{0} indicates an octal
575 value.  The value of the symbol can be overridden inside a source file via the
576 use of a @code{.set} pseudo-op.
578 @item -f
579 ``fast''---skip whitespace and comment preprocessing (assume source is
580 compiler output).
582 @item -g
583 @itemx --gen-debug
584 Generate debugging information for each assembler source line using whichever
585 debug format is preferred by the target.  This currently means either STABS,
586 ECOFF or DWARF2.
588 @item --gstabs
589 Generate stabs debugging information for each assembler line.  This
590 may help debugging assembler code, if the debugger can handle it.
592 @item --gstabs+
593 Generate stabs debugging information for each assembler line, with GNU
594 extensions that probably only gdb can handle, and that could make other
595 debuggers crash or refuse to read your program.  This
596 may help debugging assembler code.  Currently the only GNU extension is
597 the location of the current working directory at assembling time.
599 @item --gdwarf-2
600 Generate DWARF2 debugging information for each assembler line.  This
601 may help debugging assembler code, if the debugger can handle it.  Note---this
602 option is only supported by some targets, not all of them.
604 @item --help
605 Print a summary of the command line options and exit.
607 @item --target-help
608 Print a summary of all target specific options and exit.
610 @item -I @var{dir}
611 Add directory @var{dir} to the search list for @code{.include} directives.
613 @item -J
614 Don't warn about signed overflow.
616 @item -K
617 @ifclear DIFF-TBL-KLUGE
618 This option is accepted but has no effect on the @value{TARGET} family.
619 @end ifclear
620 @ifset DIFF-TBL-KLUGE
621 Issue warnings when difference tables altered for long displacements.
622 @end ifset
624 @item -L
625 @itemx --keep-locals
626 Keep (in the symbol table) local symbols.  These symbols start with
627 system-specific local label prefixes, typically @samp{.L} for ELF systems
628 or @samp{L} for traditional a.out systems.
629 @ifclear man
630 @xref{Symbol Names}.
631 @end ifclear
633 @item --listing-lhs-width=@var{number}
634 Set the maximum width, in words, of the output data column for an assembler
635 listing to @var{number}.
637 @item --listing-lhs-width2=@var{number}
638 Set the maximum width, in words, of the output data column for continuation
639 lines in an assembler listing to @var{number}.
641 @item --listing-rhs-width=@var{number}
642 Set the maximum width of an input source line, as displayed in a listing, to
643 @var{number} bytes.
645 @item --listing-cont-lines=@var{number}
646 Set the maximum number of lines printed in a listing for a single line of input
647 to @var{number} + 1.
649 @item -o @var{objfile}
650 Name the object-file output from @command{@value{AS}} @var{objfile}.
652 @item -R
653 Fold the data section into the text section.
655 @kindex --hash-size=@var{number}
656 Set the default size of GAS's hash tables to a prime number close to
657 @var{number}.  Increasing this value can reduce the length of time it takes the
658 assembler to perform its tasks, at the expense of increasing the assembler's
659 memory requirements.  Similarly reducing this value can reduce the memory
660 requirements at the expense of speed.
662 @item --reduce-memory-overheads
663 This option reduces GAS's memory requirements, at the expense of making the
664 assembly processes slower.  Currently this switch is a synonym for
665 @samp{--hash-size=4051}, but in the future it may have other effects as well.
667 @item --statistics
668 Print the maximum space (in bytes) and total time (in seconds) used by
669 assembly.
671 @item --strip-local-absolute
672 Remove local absolute symbols from the outgoing symbol table.
674 @item -v
675 @itemx -version
676 Print the @command{as} version.
678 @item --version
679 Print the @command{as} version and exit.
681 @item -W
682 @itemx --no-warn
683 Suppress warning messages.
685 @item --fatal-warnings
686 Treat warnings as errors.
688 @item --warn
689 Don't suppress warning messages or treat them as errors.
691 @item -w
692 Ignored.
694 @item -x
695 Ignored.
697 @item -Z
698 Generate an object file even after errors.
700 @item -- | @var{files} @dots{}
701 Standard input, or source files to assemble.
703 @end table
705 @ifset ARC
706 The following options are available when @value{AS} is configured for
707 an ARC processor.
709 @table @gcctabopt
710 @item -marc[5|6|7|8]
711 This option selects the core processor variant.
712 @item -EB | -EL
713 Select either big-endian (-EB) or little-endian (-EL) output.
714 @end table
715 @end ifset
717 @ifset ARM
718 The following options are available when @value{AS} is configured for the ARM
719 processor family.
721 @table @gcctabopt
722 @item -mcpu=@var{processor}[+@var{extension}@dots{}]
723 Specify which ARM processor variant is the target.
724 @item -march=@var{architecture}[+@var{extension}@dots{}]
725 Specify which ARM architecture variant is used by the target.
726 @item -mfpu=@var{floating-point-format}
727 Select which Floating Point architecture is the target.
728 @item -mfloat-abi=@var{abi}
729 Select which floating point ABI is in use.
730 @item -mthumb
731 Enable Thumb only instruction decoding.
732 @item -mapcs-32 | -mapcs-26 | -mapcs-float | -mapcs-reentrant
733 Select which procedure calling convention is in use.
734 @item -EB | -EL
735 Select either big-endian (-EB) or little-endian (-EL) output.
736 @item -mthumb-interwork
737 Specify that the code has been generated with interworking between Thumb and
738 ARM code in mind.
739 @item -k
740 Specify that PIC code has been generated.
741 @end table
742 @end ifset
744 @ifset Blackfin
745 The following options are available when @value{AS} is configured for
746 the Blackfin processor family.
748 @table @gcctabopt
749 @item -mcpu=@var{processor}@r{[}-@var{sirevision}@r{]}
750 This option specifies the target processor.  The optional @var{sirevision}
751 is not used in assembler.
752 @item -mfdpic
753 Assemble for the FDPIC ABI.
754 @item -mno-fdpic
755 @itemx -mnopic
756 Disable -mfdpic.
757 @end table
758 @end ifset
760 @ifset CRIS
761 See the info pages for documentation of the CRIS-specific options.
762 @end ifset
764 @ifset D10V
765 The following options are available when @value{AS} is configured for
766 a D10V processor.
767 @table @gcctabopt
768 @cindex D10V optimization
769 @cindex optimization, D10V
770 @item -O
771 Optimize output by parallelizing instructions.
772 @end table
773 @end ifset
775 @ifset D30V
776 The following options are available when @value{AS} is configured for a D30V
777 processor.
778 @table @gcctabopt
779 @cindex D30V optimization
780 @cindex optimization, D30V
781 @item -O
782 Optimize output by parallelizing instructions.
784 @cindex D30V nops
785 @item -n
786 Warn when nops are generated.
788 @cindex D30V nops after 32-bit multiply
789 @item -N
790 Warn when a nop after a 32-bit multiply instruction is generated.
791 @end table
792 @end ifset
794 @ifset I960
795 The following options are available when @value{AS} is configured for the
796 Intel 80960 processor.
798 @table @gcctabopt
799 @item -ACA | -ACA_A | -ACB | -ACC | -AKA | -AKB | -AKC | -AMC
800 Specify which variant of the 960 architecture is the target.
802 @item -b
803 Add code to collect statistics about branches taken.
805 @item -no-relax
806 Do not alter compare-and-branch instructions for long displacements;
807 error if necessary.
809 @end table
810 @end ifset
812 @ifset IP2K
813 The following options are available when @value{AS} is configured for the
814 Ubicom IP2K series.
816 @table @gcctabopt
818 @item -mip2022ext
819 Specifies that the extended IP2022 instructions are allowed.
821 @item -mip2022
822 Restores the default behaviour, which restricts the permitted instructions to
823 just the basic IP2022 ones.
825 @end table
826 @end ifset
828 @ifset M32C
829 The following options are available when @value{AS} is configured for the
830 Renesas M32C and M16C processors.
832 @table @gcctabopt
834 @item -m32c
835 Assemble M32C instructions.
837 @item -m16c
838 Assemble M16C instructions (the default).
840 @item -relax
841 Enable support for link-time relaxations.
843 @item -h-tick-hex
844 Support H'00 style hex constants in addition to 0x00 style.
846 @end table
847 @end ifset
849 @ifset M32R
850 The following options are available when @value{AS} is configured for the
851 Renesas M32R (formerly Mitsubishi M32R) series.
853 @table @gcctabopt
855 @item --m32rx
856 Specify which processor in the M32R family is the target.  The default
857 is normally the M32R, but this option changes it to the M32RX.
859 @item --warn-explicit-parallel-conflicts or --Wp
860 Produce warning messages when questionable parallel constructs are
861 encountered.
863 @item --no-warn-explicit-parallel-conflicts or --Wnp
864 Do not produce warning messages when questionable parallel constructs are
865 encountered.
867 @end table
868 @end ifset
870 @ifset M680X0
871 The following options are available when @value{AS} is configured for the
872 Motorola 68000 series.
874 @table @gcctabopt
876 @item -l
877 Shorten references to undefined symbols, to one word instead of two.
879 @item -m68000 | -m68008 | -m68010 | -m68020 | -m68030
880 @itemx | -m68040 | -m68060 | -m68302 | -m68331 | -m68332
881 @itemx | -m68333 | -m68340 | -mcpu32 | -m5200
882 Specify what processor in the 68000 family is the target.  The default
883 is normally the 68020, but this can be changed at configuration time.
885 @item -m68881 | -m68882 | -mno-68881 | -mno-68882
886 The target machine does (or does not) have a floating-point coprocessor.
887 The default is to assume a coprocessor for 68020, 68030, and cpu32.  Although
888 the basic 68000 is not compatible with the 68881, a combination of the
889 two can be specified, since it's possible to do emulation of the
890 coprocessor instructions with the main processor.
892 @item -m68851 | -mno-68851
893 The target machine does (or does not) have a memory-management
894 unit coprocessor.  The default is to assume an MMU for 68020 and up.
896 @end table
897 @end ifset
899 @ifset PDP11
901 For details about the PDP-11 machine dependent features options,
902 see @ref{PDP-11-Options}.
904 @table @gcctabopt
905 @item -mpic | -mno-pic
906 Generate position-independent (or position-dependent) code.  The
907 default is @option{-mpic}.
909 @item -mall
910 @itemx -mall-extensions
911 Enable all instruction set extensions.  This is the default.
913 @item -mno-extensions
914 Disable all instruction set extensions.
916 @item -m@var{extension} | -mno-@var{extension}
917 Enable (or disable) a particular instruction set extension.
919 @item -m@var{cpu}
920 Enable the instruction set extensions supported by a particular CPU, and
921 disable all other extensions.
923 @item -m@var{machine}
924 Enable the instruction set extensions supported by a particular machine
925 model, and disable all other extensions.
926 @end table
928 @end ifset
930 @ifset PJ
931 The following options are available when @value{AS} is configured for
932 a picoJava processor.
934 @table @gcctabopt
936 @cindex PJ endianness
937 @cindex endianness, PJ
938 @cindex big endian output, PJ
939 @item -mb
940 Generate ``big endian'' format output.
942 @cindex little endian output, PJ
943 @item -ml
944 Generate ``little endian'' format output.
946 @end table
947 @end ifset
949 @ifset M68HC11
950 The following options are available when @value{AS} is configured for the
951 Motorola 68HC11 or 68HC12 series.
953 @table @gcctabopt
955 @item -m68hc11 | -m68hc12 | -m68hcs12
956 Specify what processor is the target.  The default is
957 defined by the configuration option when building the assembler.
959 @item -mshort
960 Specify to use the 16-bit integer ABI.
962 @item -mlong
963 Specify to use the 32-bit integer ABI.
965 @item -mshort-double
966 Specify to use the 32-bit double ABI.
968 @item -mlong-double
969 Specify to use the 64-bit double ABI.
971 @item --force-long-branches
972 Relative branches are turned into absolute ones. This concerns
973 conditional branches, unconditional branches and branches to a
974 sub routine.
976 @item -S | --short-branches
977 Do not turn relative branches into absolute ones
978 when the offset is out of range.
980 @item --strict-direct-mode
981 Do not turn the direct addressing mode into extended addressing mode
982 when the instruction does not support direct addressing mode.
984 @item --print-insn-syntax
985 Print the syntax of instruction in case of error.
987 @item --print-opcodes
988 print the list of instructions with syntax and then exit.
990 @item --generate-example
991 print an example of instruction for each possible instruction and then exit.
992 This option is only useful for testing @command{@value{AS}}.
994 @end table
995 @end ifset
997 @ifset SPARC
998 The following options are available when @command{@value{AS}} is configured
999 for the SPARC architecture:
1001 @table @gcctabopt
1002 @item -Av6 | -Av7 | -Av8 | -Asparclet | -Asparclite
1003 @itemx -Av8plus | -Av8plusa | -Av9 | -Av9a
1004 Explicitly select a variant of the SPARC architecture.
1006 @samp{-Av8plus} and @samp{-Av8plusa} select a 32 bit environment.
1007 @samp{-Av9} and @samp{-Av9a} select a 64 bit environment.
1009 @samp{-Av8plusa} and @samp{-Av9a} enable the SPARC V9 instruction set with
1010 UltraSPARC extensions.
1012 @item -xarch=v8plus | -xarch=v8plusa
1013 For compatibility with the Solaris v9 assembler.  These options are
1014 equivalent to -Av8plus and -Av8plusa, respectively.
1016 @item -bump
1017 Warn when the assembler switches to another architecture.
1018 @end table
1019 @end ifset
1021 @ifset TIC54X
1022 The following options are available when @value{AS} is configured for the 'c54x
1023 architecture.
1025 @table @gcctabopt
1026 @item -mfar-mode
1027 Enable extended addressing mode.  All addresses and relocations will assume
1028 extended addressing (usually 23 bits).
1029 @item -mcpu=@var{CPU_VERSION}
1030 Sets the CPU version being compiled for.
1031 @item -merrors-to-file @var{FILENAME}
1032 Redirect error output to a file, for broken systems which don't support such
1033 behaviour in the shell.
1034 @end table
1035 @end ifset
1037 @ifset MIPS
1038 The following options are available when @value{AS} is configured for
1039 a @sc{mips} processor.
1041 @table @gcctabopt
1042 @item -G @var{num}
1043 This option sets the largest size of an object that can be referenced
1044 implicitly with the @code{gp} register.  It is only accepted for targets that
1045 use ECOFF format, such as a DECstation running Ultrix.  The default value is 8.
1047 @cindex MIPS endianness
1048 @cindex endianness, MIPS
1049 @cindex big endian output, MIPS
1050 @item -EB
1051 Generate ``big endian'' format output.
1053 @cindex little endian output, MIPS
1054 @item -EL
1055 Generate ``little endian'' format output.
1057 @cindex MIPS ISA
1058 @item -mips1
1059 @itemx -mips2
1060 @itemx -mips3
1061 @itemx -mips4
1062 @itemx -mips5
1063 @itemx -mips32
1064 @itemx -mips32r2
1065 @itemx -mips64
1066 @itemx -mips64r2
1067 Generate code for a particular @sc{mips} Instruction Set Architecture level.
1068 @samp{-mips1} is an alias for @samp{-march=r3000}, @samp{-mips2} is an
1069 alias for @samp{-march=r6000}, @samp{-mips3} is an alias for
1070 @samp{-march=r4000} and @samp{-mips4} is an alias for @samp{-march=r8000}.
1071 @samp{-mips5}, @samp{-mips32}, @samp{-mips32r2}, @samp{-mips64}, and
1072 @samp{-mips64r2}
1073 correspond to generic
1074 @samp{MIPS V}, @samp{MIPS32}, @samp{MIPS32 Release 2}, @samp{MIPS64},
1075 and @samp{MIPS64 Release 2}
1076 ISA processors, respectively.
1078 @item -march=@var{CPU}
1079 Generate code for a particular @sc{mips} cpu.
1081 @item -mtune=@var{cpu}
1082 Schedule and tune for a particular @sc{mips} cpu.
1084 @item -mfix7000
1085 @itemx -mno-fix7000
1086 Cause nops to be inserted if the read of the destination register
1087 of an mfhi or mflo instruction occurs in the following two instructions.
1089 @item -mdebug
1090 @itemx -no-mdebug
1091 Cause stabs-style debugging output to go into an ECOFF-style .mdebug
1092 section instead of the standard ELF .stabs sections.
1094 @item -mpdr
1095 @itemx -mno-pdr
1096 Control generation of @code{.pdr} sections.
1098 @item -mgp32
1099 @itemx -mfp32
1100 The register sizes are normally inferred from the ISA and ABI, but these
1101 flags force a certain group of registers to be treated as 32 bits wide at
1102 all times.  @samp{-mgp32} controls the size of general-purpose registers
1103 and @samp{-mfp32} controls the size of floating-point registers.
1105 @item -mips16
1106 @itemx -no-mips16
1107 Generate code for the MIPS 16 processor.  This is equivalent to putting
1108 @code{.set mips16} at the start of the assembly file.  @samp{-no-mips16}
1109 turns off this option.
1111 @item -msmartmips
1112 @itemx -mno-smartmips
1113 Enables the SmartMIPS extension to the MIPS32 instruction set. This is
1114 equivalent to putting @code{.set smartmips} at the start of the assembly file.
1115 @samp{-mno-smartmips} turns off this option.
1117 @item -mips3d
1118 @itemx -no-mips3d
1119 Generate code for the MIPS-3D Application Specific Extension.
1120 This tells the assembler to accept MIPS-3D instructions.
1121 @samp{-no-mips3d} turns off this option.
1123 @item -mdmx
1124 @itemx -no-mdmx
1125 Generate code for the MDMX Application Specific Extension.
1126 This tells the assembler to accept MDMX instructions.
1127 @samp{-no-mdmx} turns off this option.
1129 @item -mdsp
1130 @itemx -mno-dsp
1131 Generate code for the DSP Release 1 Application Specific Extension.
1132 This tells the assembler to accept DSP Release 1 instructions.
1133 @samp{-mno-dsp} turns off this option.
1135 @item -mdspr2
1136 @itemx -mno-dspr2
1137 Generate code for the DSP Release 2 Application Specific Extension.
1138 This option implies -mdsp.
1139 This tells the assembler to accept DSP Release 2 instructions.
1140 @samp{-mno-dspr2} turns off this option.
1142 @item -mmt
1143 @itemx -mno-mt
1144 Generate code for the MT Application Specific Extension.
1145 This tells the assembler to accept MT instructions.
1146 @samp{-mno-mt} turns off this option.
1148 @item --construct-floats
1149 @itemx --no-construct-floats
1150 The @samp{--no-construct-floats} option disables the construction of
1151 double width floating point constants by loading the two halves of the
1152 value into the two single width floating point registers that make up
1153 the double width register.  By default @samp{--construct-floats} is
1154 selected, allowing construction of these floating point constants.
1156 @cindex emulation
1157 @item --emulation=@var{name}
1158 This option causes @command{@value{AS}} to emulate @command{@value{AS}} configured
1159 for some other target, in all respects, including output format (choosing
1160 between ELF and ECOFF only), handling of pseudo-opcodes which may generate
1161 debugging information or store symbol table information, and default
1162 endianness.  The available configuration names are: @samp{mipsecoff},
1163 @samp{mipself}, @samp{mipslecoff}, @samp{mipsbecoff}, @samp{mipslelf},
1164 @samp{mipsbelf}.  The first two do not alter the default endianness from that
1165 of the primary target for which the assembler was configured; the others change
1166 the default to little- or big-endian as indicated by the @samp{b} or @samp{l}
1167 in the name.  Using @samp{-EB} or @samp{-EL} will override the endianness
1168 selection in any case.
1170 This option is currently supported only when the primary target
1171 @command{@value{AS}} is configured for is a @sc{mips} ELF or ECOFF target.
1172 Furthermore, the primary target or others specified with
1173 @samp{--enable-targets=@dots{}} at configuration time must include support for
1174 the other format, if both are to be available.  For example, the Irix 5
1175 configuration includes support for both.
1177 Eventually, this option will support more configurations, with more
1178 fine-grained control over the assembler's behavior, and will be supported for
1179 more processors.
1181 @item -nocpp
1182 @command{@value{AS}} ignores this option.  It is accepted for compatibility with
1183 the native tools.
1185 @item --trap
1186 @itemx --no-trap
1187 @itemx --break
1188 @itemx --no-break
1189 Control how to deal with multiplication overflow and division by zero.
1190 @samp{--trap} or @samp{--no-break} (which are synonyms) take a trap exception
1191 (and only work for Instruction Set Architecture level 2 and higher);
1192 @samp{--break} or @samp{--no-trap} (also synonyms, and the default) take a
1193 break exception.
1195 @item -n
1196 When this option is used, @command{@value{AS}} will issue a warning every
1197 time it generates a nop instruction from a macro.
1198 @end table
1199 @end ifset
1201 @ifset MCORE
1202 The following options are available when @value{AS} is configured for
1203 an MCore processor.
1205 @table @gcctabopt
1206 @item -jsri2bsr
1207 @itemx -nojsri2bsr
1208 Enable or disable the JSRI to BSR transformation.  By default this is enabled.
1209 The command line option @samp{-nojsri2bsr} can be used to disable it.
1211 @item -sifilter
1212 @itemx -nosifilter
1213 Enable or disable the silicon filter behaviour.  By default this is disabled.
1214 The default can be overridden by the @samp{-sifilter} command line option.
1216 @item -relax
1217 Alter jump instructions for long displacements.
1219 @item -mcpu=[210|340]
1220 Select the cpu type on the target hardware.  This controls which instructions
1221 can be assembled.
1223 @item -EB
1224 Assemble for a big endian target.
1226 @item -EL
1227 Assemble for a little endian target.
1229 @end table
1230 @end ifset
1232 @ifset MMIX
1233 See the info pages for documentation of the MMIX-specific options.
1234 @end ifset
1236 @ifset RX
1237 See the info pages for documentation of the RX-specific options.
1238 @end ifset
1240 @ifset S390
1241 The following options are available when @value{AS} is configured for the s390
1242 processor family.
1244 @table @gcctabopt
1245 @item -m31
1246 @itemx -m64
1247 Select the word size, either 31/32 bits or 64 bits.
1248 @item -mesa
1249 @item -mzarch
1250 Select the architecture mode, either the Enterprise System
1251 Architecture (esa) or the z/Architecture mode (zarch).
1252 @item -march=@var{processor}
1253 Specify which s390 processor variant is the target, @samp{g6}, @samp{g6},
1254 @samp{z900}, @samp{z990}, @samp{z9-109}, @samp{z9-ec}, or @samp{z10}.
1255 @item -mregnames
1256 @itemx -mno-regnames
1257 Allow or disallow symbolic names for registers.
1258 @item -mwarn-areg-zero
1259 Warn whenever the operand for a base or index register has been specified
1260 but evaluates to zero.
1261 @end table
1262 @end ifset
1264 @ifset TIC6X
1265 The following options are available when @value{AS} is configured for a
1266 TMS320C6000 processor.
1268 @table @gcctabopt
1269 @item -march=@var{arch}
1270 Enable (only) instructions from architecture @var{arch}.  By default,
1271 all instructions are permitted.
1273 The following values of @var{arch} are accepted: @code{c62x},
1274 @code{c64x}, @code{c64x+}, @code{c67x}, @code{c67x+}, @code{c674x}.
1276 @item -matomic
1277 @itemx -mno-atomic
1278 Enable or disable the optional C64x+ atomic operation instructions.
1279 By default, they are enabled if no @option{-march} option is given, or
1280 if an architecture is specified with @option{-march} that implies
1281 these instructions are present (currently, there are no such
1282 architectures); they are disabled if an architecture is specified with
1283 @option{-march} on which the instructions are optional or not
1284 present.  This option overrides such a default from the architecture,
1285 independent of the order in which the @option{-march} or
1286 @option{-matomic} or @option{-mno-atomic} options are passed.
1288 @item -mdsbt
1289 @itemx -mno-dsbt
1290 The @option{-mdsbt} option causes the assembler to generate the
1291 @code{Tag_ABI_DSBT} attribute with a value of 1, indicating that the
1292 code is using DSBT addressing.  The @option{-mno-dsbt} option, the
1293 default, causes the tag to have a value of 0, indicating that the code
1294 does not use DSBT addressing.  The linker will emit a warning if
1295 objects of different type (DSBT and non-DSBT) are linked together.
1297 @item -mbig-endian
1298 @itemx -mlittle-endian
1299 Generate code for the specified endianness.  The default is
1300 little-endian.
1301 @end table
1303 @end ifset
1305 @ifset XTENSA
1306 The following options are available when @value{AS} is configured for
1307 an Xtensa processor.
1309 @table @gcctabopt
1310 @item --text-section-literals | --no-text-section-literals
1311 With @option{--text-@-section-@-literals}, literal pools are interspersed
1312 in the text section.  The default is
1313 @option{--no-@-text-@-section-@-literals}, which places literals in a
1314 separate section in the output file.  These options only affect literals
1315 referenced via PC-relative @code{L32R} instructions; literals for
1316 absolute mode @code{L32R} instructions are handled separately.
1318 @item --absolute-literals | --no-absolute-literals
1319 Indicate to the assembler whether @code{L32R} instructions use absolute
1320 or PC-relative addressing.  The default is to assume absolute addressing
1321 if the Xtensa processor includes the absolute @code{L32R} addressing
1322 option.  Otherwise, only the PC-relative @code{L32R} mode can be used.
1324 @item --target-align | --no-target-align
1325 Enable or disable automatic alignment to reduce branch penalties at the
1326 expense of some code density.  The default is @option{--target-@-align}.
1328 @item --longcalls | --no-longcalls
1329 Enable or disable transformation of call instructions to allow calls
1330 across a greater range of addresses.  The default is
1331 @option{--no-@-longcalls}.
1333 @item --transform | --no-transform
1334 Enable or disable all assembler transformations of Xtensa instructions.
1335 The default is @option{--transform};
1336 @option{--no-transform} should be used only in the rare cases when the
1337 instructions must be exactly as specified in the assembly source.
1339 @item --rename-section @var{oldname}=@var{newname}
1340 When generating output sections, rename the @var{oldname} section to
1341 @var{newname}.
1342 @end table
1343 @end ifset
1345 @ifset Z80
1346 The following options are available when @value{AS} is configured for
1347 a Z80 family processor.
1348 @table @gcctabopt
1349 @item -z80
1350 Assemble for Z80 processor.
1351 @item -r800
1352 Assemble for R800 processor.
1353 @item  -ignore-undocumented-instructions
1354 @itemx -Wnud
1355 Assemble undocumented Z80 instructions that also work on R800 without warning.
1356 @item  -ignore-unportable-instructions
1357 @itemx -Wnup
1358 Assemble all undocumented Z80 instructions without warning.
1359 @item  -warn-undocumented-instructions
1360 @itemx -Wud
1361 Issue a warning for undocumented Z80 instructions that also work on R800.
1362 @item  -warn-unportable-instructions
1363 @itemx -Wup
1364 Issue a warning for undocumented Z80 instructions that do not work on R800.
1365 @item  -forbid-undocumented-instructions
1366 @itemx -Fud
1367 Treat all undocumented instructions as errors.
1368 @item  -forbid-unportable-instructions
1369 @itemx -Fup
1370 Treat undocumented Z80 instructions that do not work on R800 as errors.
1371 @end table
1372 @end ifset
1374 @c man end
1376 @menu
1377 * Manual::                      Structure of this Manual
1378 * GNU Assembler::               The GNU Assembler
1379 * Object Formats::              Object File Formats
1380 * Command Line::                Command Line
1381 * Input Files::                 Input Files
1382 * Object::                      Output (Object) File
1383 * Errors::                      Error and Warning Messages
1384 @end menu
1386 @node Manual
1387 @section Structure of this Manual
1389 @cindex manual, structure and purpose
1390 This manual is intended to describe what you need to know to use
1391 @sc{gnu} @command{@value{AS}}.  We cover the syntax expected in source files, including
1392 notation for symbols, constants, and expressions; the directives that
1393 @command{@value{AS}} understands; and of course how to invoke @command{@value{AS}}.
1395 @ifclear GENERIC
1396 We also cover special features in the @value{TARGET}
1397 configuration of @command{@value{AS}}, including assembler directives.
1398 @end ifclear
1399 @ifset GENERIC
1400 This manual also describes some of the machine-dependent features of
1401 various flavors of the assembler.
1402 @end ifset
1404 @cindex machine instructions (not covered)
1405 On the other hand, this manual is @emph{not} intended as an introduction
1406 to programming in assembly language---let alone programming in general!
1407 In a similar vein, we make no attempt to introduce the machine
1408 architecture; we do @emph{not} describe the instruction set, standard
1409 mnemonics, registers or addressing modes that are standard to a
1410 particular architecture.
1411 @ifset GENERIC
1412 You may want to consult the manufacturer's
1413 machine architecture manual for this information.
1414 @end ifset
1415 @ifclear GENERIC
1416 @ifset H8/300
1417 For information on the H8/300 machine instruction set, see @cite{H8/300
1418 Series Programming Manual}.  For the H8/300H, see @cite{H8/300H Series
1419 Programming Manual} (Renesas).
1420 @end ifset
1421 @ifset SH
1422 For information on the Renesas (formerly Hitachi) / SuperH SH machine instruction set,
1423 see @cite{SH-Microcomputer User's Manual} (Renesas) or
1424 @cite{SH-4 32-bit CPU Core Architecture} (SuperH) and
1425 @cite{SuperH (SH) 64-Bit RISC Series} (SuperH).
1426 @end ifset
1427 @ifset Z8000
1428 For information on the Z8000 machine instruction set, see @cite{Z8000 CPU Technical Manual}
1429 @end ifset
1430 @end ifclear
1432 @c I think this is premature---doc@cygnus.com, 17jan1991
1433 @ignore
1434 Throughout this manual, we assume that you are running @dfn{GNU},
1435 the portable operating system from the @dfn{Free Software
1436 Foundation, Inc.}.  This restricts our attention to certain kinds of
1437 computer (in particular, the kinds of computers that @sc{gnu} can run on);
1438 once this assumption is granted examples and definitions need less
1439 qualification.
1441 @command{@value{AS}} is part of a team of programs that turn a high-level
1442 human-readable series of instructions into a low-level
1443 computer-readable series of instructions.  Different versions of
1444 @command{@value{AS}} are used for different kinds of computer.
1445 @end ignore
1447 @c There used to be a section "Terminology" here, which defined
1448 @c "contents", "byte", "word", and "long".  Defining "word" to any
1449 @c particular size is confusing when the .word directive may generate 16
1450 @c bits on one machine and 32 bits on another; in general, for the user
1451 @c version of this manual, none of these terms seem essential to define.
1452 @c They were used very little even in the former draft of the manual;
1453 @c this draft makes an effort to avoid them (except in names of
1454 @c directives).
1456 @node GNU Assembler
1457 @section The GNU Assembler
1459 @c man begin DESCRIPTION
1461 @sc{gnu} @command{as} is really a family of assemblers.
1462 @ifclear GENERIC
1463 This manual describes @command{@value{AS}}, a member of that family which is
1464 configured for the @value{TARGET} architectures.
1465 @end ifclear
1466 If you use (or have used) the @sc{gnu} assembler on one architecture, you
1467 should find a fairly similar environment when you use it on another
1468 architecture.  Each version has much in common with the others,
1469 including object file formats, most assembler directives (often called
1470 @dfn{pseudo-ops}) and assembler syntax.@refill
1472 @cindex purpose of @sc{gnu} assembler
1473 @command{@value{AS}} is primarily intended to assemble the output of the
1474 @sc{gnu} C compiler @code{@value{GCC}} for use by the linker
1475 @code{@value{LD}}.  Nevertheless, we've tried to make @command{@value{AS}}
1476 assemble correctly everything that other assemblers for the same
1477 machine would assemble.
1478 @ifset VAX
1479 Any exceptions are documented explicitly (@pxref{Machine Dependencies}).
1480 @end ifset
1481 @ifset M680X0
1482 @c This remark should appear in generic version of manual; assumption
1483 @c here is that generic version sets M680x0.
1484 This doesn't mean @command{@value{AS}} always uses the same syntax as another
1485 assembler for the same architecture; for example, we know of several
1486 incompatible versions of 680x0 assembly language syntax.
1487 @end ifset
1489 @c man end
1491 Unlike older assemblers, @command{@value{AS}} is designed to assemble a source
1492 program in one pass of the source file.  This has a subtle impact on the
1493 @kbd{.org} directive (@pxref{Org,,@code{.org}}).
1495 @node Object Formats
1496 @section Object File Formats
1498 @cindex object file format
1499 The @sc{gnu} assembler can be configured to produce several alternative
1500 object file formats.  For the most part, this does not affect how you
1501 write assembly language programs; but directives for debugging symbols
1502 are typically different in different file formats.  @xref{Symbol
1503 Attributes,,Symbol Attributes}.
1504 @ifclear GENERIC
1505 @ifclear MULTI-OBJ
1506 For the @value{TARGET} target, @command{@value{AS}} is configured to produce
1507 @value{OBJ-NAME} format object files.
1508 @end ifclear
1509 @c The following should exhaust all configs that set MULTI-OBJ, ideally
1510 @ifset I960
1511 On the @value{TARGET}, @command{@value{AS}} can be configured to produce either
1512 @code{b.out} or COFF format object files.
1513 @end ifset
1514 @ifset HPPA
1515 On the @value{TARGET}, @command{@value{AS}} can be configured to produce either
1516 SOM or ELF format object files.
1517 @end ifset
1518 @end ifclear
1520 @node Command Line
1521 @section Command Line
1523 @cindex command line conventions
1525 After the program name @command{@value{AS}}, the command line may contain
1526 options and file names.  Options may appear in any order, and may be
1527 before, after, or between file names.  The order of file names is
1528 significant.
1530 @cindex standard input, as input file
1531 @kindex --
1532 @file{--} (two hyphens) by itself names the standard input file
1533 explicitly, as one of the files for @command{@value{AS}} to assemble.
1535 @cindex options, command line
1536 Except for @samp{--} any command line argument that begins with a
1537 hyphen (@samp{-}) is an option.  Each option changes the behavior of
1538 @command{@value{AS}}.  No option changes the way another option works.  An
1539 option is a @samp{-} followed by one or more letters; the case of
1540 the letter is important.   All options are optional.
1542 Some options expect exactly one file name to follow them.  The file
1543 name may either immediately follow the option's letter (compatible
1544 with older assemblers) or it may be the next command argument (@sc{gnu}
1545 standard).  These two command lines are equivalent:
1547 @smallexample
1548 @value{AS} -o my-object-file.o mumble.s
1549 @value{AS} -omy-object-file.o mumble.s
1550 @end smallexample
1552 @node Input Files
1553 @section Input Files
1555 @cindex input
1556 @cindex source program
1557 @cindex files, input
1558 We use the phrase @dfn{source program}, abbreviated @dfn{source}, to
1559 describe the program input to one run of @command{@value{AS}}.  The program may
1560 be in one or more files; how the source is partitioned into files
1561 doesn't change the meaning of the source.
1563 @c I added "con" prefix to "catenation" just to prove I can overcome my
1564 @c APL training...   doc@cygnus.com
1565 The source program is a concatenation of the text in all the files, in the
1566 order specified.
1568 @c man begin DESCRIPTION
1569 Each time you run @command{@value{AS}} it assembles exactly one source
1570 program.  The source program is made up of one or more files.
1571 (The standard input is also a file.)
1573 You give @command{@value{AS}} a command line that has zero or more input file
1574 names.  The input files are read (from left file name to right).  A
1575 command line argument (in any position) that has no special meaning
1576 is taken to be an input file name.
1578 If you give @command{@value{AS}} no file names it attempts to read one input file
1579 from the @command{@value{AS}} standard input, which is normally your terminal.  You
1580 may have to type @key{ctl-D} to tell @command{@value{AS}} there is no more program
1581 to assemble.
1583 Use @samp{--} if you need to explicitly name the standard input file
1584 in your command line.
1586 If the source is empty, @command{@value{AS}} produces a small, empty object
1587 file.
1589 @c man end
1591 @subheading Filenames and Line-numbers
1593 @cindex input file linenumbers
1594 @cindex line numbers, in input files
1595 There are two ways of locating a line in the input file (or files) and
1596 either may be used in reporting error messages.  One way refers to a line
1597 number in a physical file; the other refers to a line number in a
1598 ``logical'' file.  @xref{Errors, ,Error and Warning Messages}.
1600 @dfn{Physical files} are those files named in the command line given
1601 to @command{@value{AS}}.
1603 @dfn{Logical files} are simply names declared explicitly by assembler
1604 directives; they bear no relation to physical files.  Logical file names help
1605 error messages reflect the original source file, when @command{@value{AS}} source
1606 is itself synthesized from other files.  @command{@value{AS}} understands the
1607 @samp{#} directives emitted by the @code{@value{GCC}} preprocessor.  See also
1608 @ref{File,,@code{.file}}.
1610 @node Object
1611 @section Output (Object) File
1613 @cindex object file
1614 @cindex output file
1615 @kindex a.out
1616 @kindex .o
1617 Every time you run @command{@value{AS}} it produces an output file, which is
1618 your assembly language program translated into numbers.  This file
1619 is the object file.  Its default name is
1620 @ifclear BOUT
1621 @code{a.out}.
1622 @end ifclear
1623 @ifset BOUT
1624 @ifset GENERIC
1625 @code{a.out}, or
1626 @end ifset
1627 @code{b.out} when @command{@value{AS}} is configured for the Intel 80960.
1628 @end ifset
1629 You can give it another name by using the @option{-o} option.  Conventionally,
1630 object file names end with @file{.o}.  The default name is used for historical
1631 reasons: older assemblers were capable of assembling self-contained programs
1632 directly into a runnable program.  (For some formats, this isn't currently
1633 possible, but it can be done for the @code{a.out} format.)
1635 @cindex linker
1636 @kindex ld
1637 The object file is meant for input to the linker @code{@value{LD}}.  It contains
1638 assembled program code, information to help @code{@value{LD}} integrate
1639 the assembled program into a runnable file, and (optionally) symbolic
1640 information for the debugger.
1642 @c link above to some info file(s) like the description of a.out.
1643 @c don't forget to describe @sc{gnu} info as well as Unix lossage.
1645 @node Errors
1646 @section Error and Warning Messages
1648 @c man begin DESCRIPTION
1650 @cindex error messages
1651 @cindex warning messages
1652 @cindex messages from assembler
1653 @command{@value{AS}} may write warnings and error messages to the standard error
1654 file (usually your terminal).  This should not happen when  a compiler
1655 runs @command{@value{AS}} automatically.  Warnings report an assumption made so
1656 that @command{@value{AS}} could keep assembling a flawed program; errors report a
1657 grave problem that stops the assembly.
1659 @c man end
1661 @cindex format of warning messages
1662 Warning messages have the format
1664 @smallexample
1665 file_name:@b{NNN}:Warning Message Text
1666 @end smallexample
1668 @noindent
1669 @cindex line numbers, in warnings/errors
1670 (where @b{NNN} is a line number).  If a logical file name has been given
1671 (@pxref{File,,@code{.file}}) it is used for the filename, otherwise the name of
1672 the current input file is used.  If a logical line number was given
1673 @ifset GENERIC
1674 (@pxref{Line,,@code{.line}})
1675 @end ifset
1676 then it is used to calculate the number printed,
1677 otherwise the actual line in the current source file is printed.  The
1678 message text is intended to be self explanatory (in the grand Unix
1679 tradition).
1681 @cindex format of error messages
1682 Error messages have the format
1683 @smallexample
1684 file_name:@b{NNN}:FATAL:Error Message Text
1685 @end smallexample
1686 The file name and line number are derived as for warning
1687 messages.  The actual message text may be rather less explanatory
1688 because many of them aren't supposed to happen.
1690 @node Invoking
1691 @chapter Command-Line Options
1693 @cindex options, all versions of assembler
1694 This chapter describes command-line options available in @emph{all}
1695 versions of the @sc{gnu} assembler; see @ref{Machine Dependencies},
1696 for options specific
1697 @ifclear GENERIC
1698 to the @value{TARGET} target.
1699 @end ifclear
1700 @ifset GENERIC
1701 to particular machine architectures.
1702 @end ifset
1704 @c man begin DESCRIPTION
1706 If you are invoking @command{@value{AS}} via the @sc{gnu} C compiler,
1707 you can use the @samp{-Wa} option to pass arguments through to the assembler.
1708 The assembler arguments must be separated from each other (and the @samp{-Wa})
1709 by commas.  For example:
1711 @smallexample
1712 gcc -c -g -O -Wa,-alh,-L file.c
1713 @end smallexample
1715 @noindent
1716 This passes two options to the assembler: @samp{-alh} (emit a listing to
1717 standard output with high-level and assembly source) and @samp{-L} (retain
1718 local symbols in the symbol table).
1720 Usually you do not need to use this @samp{-Wa} mechanism, since many compiler
1721 command-line options are automatically passed to the assembler by the compiler.
1722 (You can call the @sc{gnu} compiler driver with the @samp{-v} option to see
1723 precisely what options it passes to each compilation pass, including the
1724 assembler.)
1726 @c man end
1728 @menu
1729 * a::             -a[cdghlns] enable listings
1730 * alternate::     --alternate enable alternate macro syntax
1731 * D::             -D for compatibility
1732 * f::             -f to work faster
1733 * I::             -I for .include search path
1734 @ifclear DIFF-TBL-KLUGE
1735 * K::             -K for compatibility
1736 @end ifclear
1737 @ifset DIFF-TBL-KLUGE
1738 * K::             -K for difference tables
1739 @end ifset
1741 * L::             -L to retain local symbols
1742 * listing::       --listing-XXX to configure listing output
1743 * M::             -M or --mri to assemble in MRI compatibility mode
1744 * MD::            --MD for dependency tracking
1745 * o::             -o to name the object file
1746 * R::             -R to join data and text sections
1747 * statistics::    --statistics to see statistics about assembly
1748 * traditional-format:: --traditional-format for compatible output
1749 * v::             -v to announce version
1750 * W::             -W, --no-warn, --warn, --fatal-warnings to control warnings
1751 * Z::             -Z to make object file even after errors
1752 @end menu
1754 @node a
1755 @section Enable Listings: @option{-a[cdghlns]}
1757 @kindex -a
1758 @kindex -ac
1759 @kindex -ad
1760 @kindex -ag
1761 @kindex -ah
1762 @kindex -al
1763 @kindex -an
1764 @kindex -as
1765 @cindex listings, enabling
1766 @cindex assembly listings, enabling
1768 These options enable listing output from the assembler.  By itself,
1769 @samp{-a} requests high-level, assembly, and symbols listing.
1770 You can use other letters to select specific options for the list:
1771 @samp{-ah} requests a high-level language listing,
1772 @samp{-al} requests an output-program assembly listing, and
1773 @samp{-as} requests a symbol table listing.
1774 High-level listings require that a compiler debugging option like
1775 @samp{-g} be used, and that assembly listings (@samp{-al}) be requested
1776 also.
1778 Use the @samp{-ag} option to print a first section with general assembly
1779 information, like @value{AS} version, switches passed, or time stamp.
1781 Use the @samp{-ac} option to omit false conditionals from a listing.  Any lines
1782 which are not assembled because of a false @code{.if} (or @code{.ifdef}, or any
1783 other conditional), or a true @code{.if} followed by an @code{.else}, will be
1784 omitted from the listing.
1786 Use the @samp{-ad} option to omit debugging directives from the
1787 listing.
1789 Once you have specified one of these options, you can further control
1790 listing output and its appearance using the directives @code{.list},
1791 @code{.nolist}, @code{.psize}, @code{.eject}, @code{.title}, and
1792 @code{.sbttl}.
1793 The @samp{-an} option turns off all forms processing.
1794 If you do not request listing output with one of the @samp{-a} options, the
1795 listing-control directives have no effect.
1797 The letters after @samp{-a} may be combined into one option,
1798 @emph{e.g.}, @samp{-aln}.
1800 Note if the assembler source is coming from the standard input (e.g.,
1801 because it
1802 is being created by @code{@value{GCC}} and the @samp{-pipe} command line switch
1803 is being used) then the listing will not contain any comments or preprocessor
1804 directives.  This is because the listing code buffers input source lines from
1805 stdin only after they have been preprocessed by the assembler.  This reduces
1806 memory usage and makes the code more efficient.
1808 @node alternate
1809 @section @option{--alternate}
1811 @kindex --alternate
1812 Begin in alternate macro mode, see @ref{Altmacro,,@code{.altmacro}}.
1814 @node D
1815 @section @option{-D}
1817 @kindex -D
1818 This option has no effect whatsoever, but it is accepted to make it more
1819 likely that scripts written for other assemblers also work with
1820 @command{@value{AS}}.
1822 @node f
1823 @section Work Faster: @option{-f}
1825 @kindex -f
1826 @cindex trusted compiler
1827 @cindex faster processing (@option{-f})
1828 @samp{-f} should only be used when assembling programs written by a
1829 (trusted) compiler.  @samp{-f} stops the assembler from doing whitespace
1830 and comment preprocessing on
1831 the input file(s) before assembling them.  @xref{Preprocessing,
1832 ,Preprocessing}.
1834 @quotation
1835 @emph{Warning:} if you use @samp{-f} when the files actually need to be
1836 preprocessed (if they contain comments, for example), @command{@value{AS}} does
1837 not work correctly.
1838 @end quotation
1840 @node I
1841 @section @code{.include} Search Path: @option{-I} @var{path}
1843 @kindex -I @var{path}
1844 @cindex paths for @code{.include}
1845 @cindex search path for @code{.include}
1846 @cindex @code{include} directive search path
1847 Use this option to add a @var{path} to the list of directories
1848 @command{@value{AS}} searches for files specified in @code{.include}
1849 directives (@pxref{Include,,@code{.include}}).  You may use @option{-I} as
1850 many times as necessary to include a variety of paths.  The current
1851 working directory is always searched first; after that, @command{@value{AS}}
1852 searches any @samp{-I} directories in the same order as they were
1853 specified (left to right) on the command line.
1855 @node K
1856 @section Difference Tables: @option{-K}
1858 @kindex -K
1859 @ifclear DIFF-TBL-KLUGE
1860 On the @value{TARGET} family, this option is allowed, but has no effect.  It is
1861 permitted for compatibility with the @sc{gnu} assembler on other platforms,
1862 where it can be used to warn when the assembler alters the machine code
1863 generated for @samp{.word} directives in difference tables.  The @value{TARGET}
1864 family does not have the addressing limitations that sometimes lead to this
1865 alteration on other platforms.
1866 @end ifclear
1868 @ifset DIFF-TBL-KLUGE
1869 @cindex difference tables, warning
1870 @cindex warning for altered difference tables
1871 @command{@value{AS}} sometimes alters the code emitted for directives of the
1872 form @samp{.word @var{sym1}-@var{sym2}}.  @xref{Word,,@code{.word}}.
1873 You can use the @samp{-K} option if you want a warning issued when this
1874 is done.
1875 @end ifset
1877 @node L
1878 @section Include Local Symbols: @option{-L}
1880 @kindex -L
1881 @cindex local symbols, retaining in output
1882 Symbols beginning with system-specific local label prefixes, typically
1883 @samp{.L} for ELF systems or @samp{L} for traditional a.out systems, are
1884 called @dfn{local symbols}.  @xref{Symbol Names}.  Normally you do not see
1885 such symbols when debugging, because they are intended for the use of
1886 programs (like compilers) that compose assembler programs, not for your
1887 notice.  Normally both @command{@value{AS}} and @code{@value{LD}} discard
1888 such symbols, so you do not normally debug with them.
1890 This option tells @command{@value{AS}} to retain those local symbols
1891 in the object file.  Usually if you do this you also tell the linker
1892 @code{@value{LD}} to preserve those symbols.
1894 @node listing
1895 @section Configuring listing output: @option{--listing}
1897 The listing feature of the assembler can be enabled via the command line switch
1898 @samp{-a} (@pxref{a}).  This feature combines the input source file(s) with a
1899 hex dump of the corresponding locations in the output object file, and displays
1900 them as a listing file.  The format of this listing can be controlled by
1901 directives inside the assembler source (i.e., @code{.list} (@pxref{List}),
1902 @code{.title} (@pxref{Title}), @code{.sbttl} (@pxref{Sbttl}),
1903 @code{.psize} (@pxref{Psize}), and
1904 @code{.eject} (@pxref{Eject}) and also by the following switches:
1906 @table @gcctabopt
1907 @item --listing-lhs-width=@samp{number}
1908 @kindex --listing-lhs-width
1909 @cindex Width of first line disassembly output
1910 Sets the maximum width, in words, of the first line of the hex byte dump.  This
1911 dump appears on the left hand side of the listing output.
1913 @item --listing-lhs-width2=@samp{number}
1914 @kindex --listing-lhs-width2
1915 @cindex Width of continuation lines of disassembly output
1916 Sets the maximum width, in words, of any further lines of the hex byte dump for
1917 a given input source line.  If this value is not specified, it defaults to being
1918 the same as the value specified for @samp{--listing-lhs-width}.  If neither
1919 switch is used the default is to one.
1921 @item --listing-rhs-width=@samp{number}
1922 @kindex --listing-rhs-width
1923 @cindex Width of source line output
1924 Sets the maximum width, in characters, of the source line that is displayed
1925 alongside the hex dump.  The default value for this parameter is 100.  The
1926 source line is displayed on the right hand side of the listing output.
1928 @item --listing-cont-lines=@samp{number}
1929 @kindex --listing-cont-lines
1930 @cindex Maximum number of continuation lines
1931 Sets the maximum number of continuation lines of hex dump that will be
1932 displayed for a given single line of source input.  The default value is 4.
1933 @end table
1935 @node M
1936 @section Assemble in MRI Compatibility Mode: @option{-M}
1938 @kindex -M
1939 @cindex MRI compatibility mode
1940 The @option{-M} or @option{--mri} option selects MRI compatibility mode.  This
1941 changes the syntax and pseudo-op handling of @command{@value{AS}} to make it
1942 compatible with the @code{ASM68K} or the @code{ASM960} (depending upon the
1943 configured target) assembler from Microtec Research.  The exact nature of the
1944 MRI syntax will not be documented here; see the MRI manuals for more
1945 information.  Note in particular that the handling of macros and macro
1946 arguments is somewhat different.  The purpose of this option is to permit
1947 assembling existing MRI assembler code using @command{@value{AS}}.
1949 The MRI compatibility is not complete.  Certain operations of the MRI assembler
1950 depend upon its object file format, and can not be supported using other object
1951 file formats.  Supporting these would require enhancing each object file format
1952 individually.  These are:
1954 @itemize @bullet
1955 @item global symbols in common section
1957 The m68k MRI assembler supports common sections which are merged by the linker.
1958 Other object file formats do not support this.  @command{@value{AS}} handles
1959 common sections by treating them as a single common symbol.  It permits local
1960 symbols to be defined within a common section, but it can not support global
1961 symbols, since it has no way to describe them.
1963 @item complex relocations
1965 The MRI assemblers support relocations against a negated section address, and
1966 relocations which combine the start addresses of two or more sections.  These
1967 are not support by other object file formats.
1969 @item @code{END} pseudo-op specifying start address
1971 The MRI @code{END} pseudo-op permits the specification of a start address.
1972 This is not supported by other object file formats.  The start address may
1973 instead be specified using the @option{-e} option to the linker, or in a linker
1974 script.
1976 @item @code{IDNT}, @code{.ident} and @code{NAME} pseudo-ops
1978 The MRI @code{IDNT}, @code{.ident} and @code{NAME} pseudo-ops assign a module
1979 name to the output file.  This is not supported by other object file formats.
1981 @item @code{ORG} pseudo-op
1983 The m68k MRI @code{ORG} pseudo-op begins an absolute section at a given
1984 address.  This differs from the usual @command{@value{AS}} @code{.org} pseudo-op,
1985 which changes the location within the current section.  Absolute sections are
1986 not supported by other object file formats.  The address of a section may be
1987 assigned within a linker script.
1988 @end itemize
1990 There are some other features of the MRI assembler which are not supported by
1991 @command{@value{AS}}, typically either because they are difficult or because they
1992 seem of little consequence.  Some of these may be supported in future releases.
1994 @itemize @bullet
1996 @item EBCDIC strings
1998 EBCDIC strings are not supported.
2000 @item packed binary coded decimal
2002 Packed binary coded decimal is not supported.  This means that the @code{DC.P}
2003 and @code{DCB.P} pseudo-ops are not supported.
2005 @item @code{FEQU} pseudo-op
2007 The m68k @code{FEQU} pseudo-op is not supported.
2009 @item @code{NOOBJ} pseudo-op
2011 The m68k @code{NOOBJ} pseudo-op is not supported.
2013 @item @code{OPT} branch control options
2015 The m68k @code{OPT} branch control options---@code{B}, @code{BRS}, @code{BRB},
2016 @code{BRL}, and @code{BRW}---are ignored.  @command{@value{AS}} automatically
2017 relaxes all branches, whether forward or backward, to an appropriate size, so
2018 these options serve no purpose.
2020 @item @code{OPT} list control options
2022 The following m68k @code{OPT} list control options are ignored: @code{C},
2023 @code{CEX}, @code{CL}, @code{CRE}, @code{E}, @code{G}, @code{I}, @code{M},
2024 @code{MEX}, @code{MC}, @code{MD}, @code{X}.
2026 @item other @code{OPT} options
2028 The following m68k @code{OPT} options are ignored: @code{NEST}, @code{O},
2029 @code{OLD}, @code{OP}, @code{P}, @code{PCO}, @code{PCR}, @code{PCS}, @code{R}.
2031 @item @code{OPT} @code{D} option is default
2033 The m68k @code{OPT} @code{D} option is the default, unlike the MRI assembler.
2034 @code{OPT NOD} may be used to turn it off.
2036 @item @code{XREF} pseudo-op.
2038 The m68k @code{XREF} pseudo-op is ignored.
2040 @item @code{.debug} pseudo-op
2042 The i960 @code{.debug} pseudo-op is not supported.
2044 @item @code{.extended} pseudo-op
2046 The i960 @code{.extended} pseudo-op is not supported.
2048 @item @code{.list} pseudo-op.
2050 The various options of the i960 @code{.list} pseudo-op are not supported.
2052 @item @code{.optimize} pseudo-op
2054 The i960 @code{.optimize} pseudo-op is not supported.
2056 @item @code{.output} pseudo-op
2058 The i960 @code{.output} pseudo-op is not supported.
2060 @item @code{.setreal} pseudo-op
2062 The i960 @code{.setreal} pseudo-op is not supported.
2064 @end itemize
2066 @node MD
2067 @section Dependency Tracking: @option{--MD}
2069 @kindex --MD
2070 @cindex dependency tracking
2071 @cindex make rules
2073 @command{@value{AS}} can generate a dependency file for the file it creates.  This
2074 file consists of a single rule suitable for @code{make} describing the
2075 dependencies of the main source file.
2077 The rule is written to the file named in its argument.
2079 This feature is used in the automatic updating of makefiles.
2081 @node o
2082 @section Name the Object File: @option{-o}
2084 @kindex -o
2085 @cindex naming object file
2086 @cindex object file name
2087 There is always one object file output when you run @command{@value{AS}}.  By
2088 default it has the name
2089 @ifset GENERIC
2090 @ifset I960
2091 @file{a.out} (or @file{b.out}, for Intel 960 targets only).
2092 @end ifset
2093 @ifclear I960
2094 @file{a.out}.
2095 @end ifclear
2096 @end ifset
2097 @ifclear GENERIC
2098 @ifset I960
2099 @file{b.out}.
2100 @end ifset
2101 @ifclear I960
2102 @file{a.out}.
2103 @end ifclear
2104 @end ifclear
2105 You use this option (which takes exactly one filename) to give the
2106 object file a different name.
2108 Whatever the object file is called, @command{@value{AS}} overwrites any
2109 existing file of the same name.
2111 @node R
2112 @section Join Data and Text Sections: @option{-R}
2114 @kindex -R
2115 @cindex data and text sections, joining
2116 @cindex text and data sections, joining
2117 @cindex joining text and data sections
2118 @cindex merging text and data sections
2119 @option{-R} tells @command{@value{AS}} to write the object file as if all
2120 data-section data lives in the text section.  This is only done at
2121 the very last moment:  your binary data are the same, but data
2122 section parts are relocated differently.  The data section part of
2123 your object file is zero bytes long because all its bytes are
2124 appended to the text section.  (@xref{Sections,,Sections and Relocation}.)
2126 When you specify @option{-R} it would be possible to generate shorter
2127 address displacements (because we do not have to cross between text and
2128 data section).  We refrain from doing this simply for compatibility with
2129 older versions of @command{@value{AS}}.  In future, @option{-R} may work this way.
2131 @ifset COFF-ELF
2132 When @command{@value{AS}} is configured for COFF or ELF output,
2133 this option is only useful if you use sections named @samp{.text} and
2134 @samp{.data}.
2135 @end ifset
2137 @ifset HPPA
2138 @option{-R} is not supported for any of the HPPA targets.  Using
2139 @option{-R} generates a warning from @command{@value{AS}}.
2140 @end ifset
2142 @node statistics
2143 @section Display Assembly Statistics: @option{--statistics}
2145 @kindex --statistics
2146 @cindex statistics, about assembly
2147 @cindex time, total for assembly
2148 @cindex space used, maximum for assembly
2149 Use @samp{--statistics} to display two statistics about the resources used by
2150 @command{@value{AS}}: the maximum amount of space allocated during the assembly
2151 (in bytes), and the total execution time taken for the assembly (in @sc{cpu}
2152 seconds).
2154 @node traditional-format
2155 @section Compatible Output: @option{--traditional-format}
2157 @kindex --traditional-format
2158 For some targets, the output of @command{@value{AS}} is different in some ways
2159 from the output of some existing assembler.  This switch requests
2160 @command{@value{AS}} to use the traditional format instead.
2162 For example, it disables the exception frame optimizations which
2163 @command{@value{AS}} normally does by default on @code{@value{GCC}} output.
2165 @node v
2166 @section Announce Version: @option{-v}
2168 @kindex -v
2169 @kindex -version
2170 @cindex assembler version
2171 @cindex version of assembler
2172 You can find out what version of as is running by including the
2173 option @samp{-v} (which you can also spell as @samp{-version}) on the
2174 command line.
2176 @node W
2177 @section Control Warnings: @option{-W}, @option{--warn}, @option{--no-warn}, @option{--fatal-warnings}
2179 @command{@value{AS}} should never give a warning or error message when
2180 assembling compiler output.  But programs written by people often
2181 cause @command{@value{AS}} to give a warning that a particular assumption was
2182 made.  All such warnings are directed to the standard error file.
2184 @kindex -W
2185 @kindex --no-warn
2186 @cindex suppressing warnings
2187 @cindex warnings, suppressing
2188 If you use the @option{-W} and @option{--no-warn} options, no warnings are issued.
2189 This only affects the warning messages: it does not change any particular of
2190 how @command{@value{AS}} assembles your file.  Errors, which stop the assembly,
2191 are still reported.
2193 @kindex --fatal-warnings
2194 @cindex errors, caused by warnings
2195 @cindex warnings, causing error
2196 If you use the @option{--fatal-warnings} option, @command{@value{AS}} considers
2197 files that generate warnings to be in error.
2199 @kindex --warn
2200 @cindex warnings, switching on
2201 You can switch these options off again by specifying @option{--warn}, which
2202 causes warnings to be output as usual.
2204 @node Z
2205 @section Generate Object File in Spite of Errors: @option{-Z}
2206 @cindex object file, after errors
2207 @cindex errors, continuing after
2208 After an error message, @command{@value{AS}} normally produces no output.  If for
2209 some reason you are interested in object file output even after
2210 @command{@value{AS}} gives an error message on your program, use the @samp{-Z}
2211 option.  If there are any errors, @command{@value{AS}} continues anyways, and
2212 writes an object file after a final warning message of the form @samp{@var{n}
2213 errors, @var{m} warnings, generating bad object file.}
2215 @node Syntax
2216 @chapter Syntax
2218 @cindex machine-independent syntax
2219 @cindex syntax, machine-independent
2220 This chapter describes the machine-independent syntax allowed in a
2221 source file.  @command{@value{AS}} syntax is similar to what many other
2222 assemblers use; it is inspired by the BSD 4.2
2223 @ifclear VAX
2224 assembler.
2225 @end ifclear
2226 @ifset VAX
2227 assembler, except that @command{@value{AS}} does not assemble Vax bit-fields.
2228 @end ifset
2230 @menu
2231 * Preprocessing::              Preprocessing
2232 * Whitespace::                  Whitespace
2233 * Comments::                    Comments
2234 * Symbol Intro::                Symbols
2235 * Statements::                  Statements
2236 * Constants::                   Constants
2237 @end menu
2239 @node Preprocessing
2240 @section Preprocessing
2242 @cindex preprocessing
2243 The @command{@value{AS}} internal preprocessor:
2244 @itemize @bullet
2245 @cindex whitespace, removed by preprocessor
2246 @item
2247 adjusts and removes extra whitespace.  It leaves one space or tab before
2248 the keywords on a line, and turns any other whitespace on the line into
2249 a single space.
2251 @cindex comments, removed by preprocessor
2252 @item
2253 removes all comments, replacing them with a single space, or an
2254 appropriate number of newlines.
2256 @cindex constants, converted by preprocessor
2257 @item
2258 converts character constants into the appropriate numeric values.
2259 @end itemize
2261 It does not do macro processing, include file handling, or
2262 anything else you may get from your C compiler's preprocessor.  You can
2263 do include file processing with the @code{.include} directive
2264 (@pxref{Include,,@code{.include}}).  You can use the @sc{gnu} C compiler driver
2265 to get other ``CPP'' style preprocessing by giving the input file a
2266 @samp{.S} suffix.  @xref{Overall Options, ,Options Controlling the Kind of
2267 Output, gcc.info, Using GNU CC}.
2269 Excess whitespace, comments, and character constants
2270 cannot be used in the portions of the input text that are not
2271 preprocessed.
2273 @cindex turning preprocessing on and off
2274 @cindex preprocessing, turning on and off
2275 @kindex #NO_APP
2276 @kindex #APP
2277 If the first line of an input file is @code{#NO_APP} or if you use the
2278 @samp{-f} option, whitespace and comments are not removed from the input file.
2279 Within an input file, you can ask for whitespace and comment removal in
2280 specific portions of the by putting a line that says @code{#APP} before the
2281 text that may contain whitespace or comments, and putting a line that says
2282 @code{#NO_APP} after this text.  This feature is mainly intend to support
2283 @code{asm} statements in compilers whose output is otherwise free of comments
2284 and whitespace.
2286 @node Whitespace
2287 @section Whitespace
2289 @cindex whitespace
2290 @dfn{Whitespace} is one or more blanks or tabs, in any order.
2291 Whitespace is used to separate symbols, and to make programs neater for
2292 people to read.  Unless within character constants
2293 (@pxref{Characters,,Character Constants}), any whitespace means the same
2294 as exactly one space.
2296 @node Comments
2297 @section Comments
2299 @cindex comments
2300 There are two ways of rendering comments to @command{@value{AS}}.  In both
2301 cases the comment is equivalent to one space.
2303 Anything from @samp{/*} through the next @samp{*/} is a comment.
2304 This means you may not nest these comments.
2306 @smallexample
2308   The only way to include a newline ('\n') in a comment
2309   is to use this sort of comment.
2312 /* This sort of comment does not nest. */
2313 @end smallexample
2315 @cindex line comment character
2316 Anything from the @dfn{line comment} character to the next newline
2317 is considered a comment and is ignored.  The line comment character is
2318 @ifset ARC
2319 @samp{;} on the ARC;
2320 @end ifset
2321 @ifset ARM
2322 @samp{@@} on the ARM;
2323 @end ifset
2324 @ifset H8/300
2325 @samp{;} for the H8/300 family;
2326 @end ifset
2327 @ifset HPPA
2328 @samp{;} for the HPPA;
2329 @end ifset
2330 @ifset I80386
2331 @samp{#} on the i386 and x86-64;
2332 @end ifset
2333 @ifset I960
2334 @samp{#} on the i960;
2335 @end ifset
2336 @ifset PDP11
2337 @samp{;} for the PDP-11;
2338 @end ifset
2339 @ifset PJ
2340 @samp{;} for picoJava;
2341 @end ifset
2342 @ifset PPC
2343 @samp{#} for Motorola PowerPC;
2344 @end ifset
2345 @ifset S390
2346 @samp{#} for IBM S/390;
2347 @end ifset
2348 @ifset SCORE
2349 @samp{#} for the Sunplus SCORE;
2350 @end ifset
2351 @ifset SH
2352 @samp{!} for the Renesas / SuperH SH;
2353 @end ifset
2354 @ifset SPARC
2355 @samp{!} on the SPARC;
2356 @end ifset
2357 @ifset IP2K
2358 @samp{#} on the ip2k;
2359 @end ifset
2360 @ifset M32C
2361 @samp{#} on the m32c;
2362 @end ifset
2363 @ifset M32R
2364 @samp{#} on the m32r;
2365 @end ifset
2366 @ifset M680X0
2367 @samp{|} on the 680x0;
2368 @end ifset
2369 @ifset M68HC11
2370 @samp{#} on the 68HC11 and 68HC12;
2371 @end ifset
2372 @ifset RX
2373 @samp{#} on the RX;
2374 @end ifset
2375 @ifset TIC6X
2376 @samp{;} on the TMS320C6X;
2377 @end ifset
2378 @ifset VAX
2379 @samp{#} on the Vax;
2380 @end ifset
2381 @ifset Z80
2382 @samp{;} for the Z80;
2383 @end ifset
2384 @ifset Z8000
2385 @samp{!} for the Z8000;
2386 @end ifset
2387 @ifset V850
2388 @samp{#} on the V850;
2389 @end ifset
2390 @ifset XTENSA
2391 @samp{#} for Xtensa systems;
2392 @end ifset
2393 see @ref{Machine Dependencies}.  @refill
2394 @c FIXME What about i860?
2396 @ifset GENERIC
2397 On some machines there are two different line comment characters.  One
2398 character only begins a comment if it is the first non-whitespace character on
2399 a line, while the other always begins a comment.
2400 @end ifset
2402 @ifset V850
2403 The V850 assembler also supports a double dash as starting a comment that
2404 extends to the end of the line.
2406 @samp{--};
2407 @end ifset
2409 @kindex #
2410 @cindex lines starting with @code{#}
2411 @cindex logical line numbers
2412 To be compatible with past assemblers, lines that begin with @samp{#} have a
2413 special interpretation.  Following the @samp{#} should be an absolute
2414 expression (@pxref{Expressions}): the logical line number of the @emph{next}
2415 line.  Then a string (@pxref{Strings, ,Strings}) is allowed: if present it is a
2416 new logical file name.  The rest of the line, if any, should be whitespace.
2418 If the first non-whitespace characters on the line are not numeric,
2419 the line is ignored.  (Just like a comment.)
2421 @smallexample
2422                           # This is an ordinary comment.
2423 # 42-6 "new_file_name"    # New logical file name
2424                           # This is logical line # 36.
2425 @end smallexample
2426 This feature is deprecated, and may disappear from future versions
2427 of @command{@value{AS}}.
2429 @node Symbol Intro
2430 @section Symbols
2432 @cindex characters used in symbols
2433 @ifclear SPECIAL-SYMS
2434 A @dfn{symbol} is one or more characters chosen from the set of all
2435 letters (both upper and lower case), digits and the three characters
2436 @samp{_.$}.
2437 @end ifclear
2438 @ifset SPECIAL-SYMS
2439 @ifclear GENERIC
2440 @ifset H8
2441 A @dfn{symbol} is one or more characters chosen from the set of all
2442 letters (both upper and lower case), digits and the three characters
2443 @samp{._$}.  (Save that, on the H8/300 only, you may not use @samp{$} in
2444 symbol names.)
2445 @end ifset
2446 @end ifclear
2447 @end ifset
2448 @ifset GENERIC
2449 On most machines, you can also use @code{$} in symbol names; exceptions
2450 are noted in @ref{Machine Dependencies}.
2451 @end ifset
2452 No symbol may begin with a digit.  Case is significant.
2453 There is no length limit: all characters are significant.  Symbols are
2454 delimited by characters not in that set, or by the beginning of a file
2455 (since the source program must end with a newline, the end of a file is
2456 not a possible symbol delimiter).  @xref{Symbols}.
2457 @cindex length of symbols
2459 @node Statements
2460 @section Statements
2462 @cindex statements, structure of
2463 @cindex line separator character
2464 @cindex statement separator character
2465 @ifclear GENERIC
2466 @ifclear abnormal-separator
2467 A @dfn{statement} ends at a newline character (@samp{\n}) or at a
2468 semicolon (@samp{;}).  The newline or semicolon is considered part of
2469 the preceding statement.  Newlines and semicolons within character
2470 constants are an exception: they do not end statements.
2471 @end ifclear
2472 @ifset abnormal-separator
2473 @ifset HPPA
2474 A @dfn{statement} ends at a newline character (@samp{\n}) or an exclamation
2475 point (@samp{!}).  The newline or exclamation point is considered part of the
2476 preceding statement.  Newlines and exclamation points within character
2477 constants are an exception: they do not end statements.
2478 @end ifset
2479 @ifset H8
2480 A @dfn{statement} ends at a newline character (@samp{\n}); or (for the
2481 H8/300) a dollar sign (@samp{$}); or (for the Renesas-SH) a semicolon
2482 (@samp{;}).  The newline or separator character is considered part of
2483 the preceding statement.  Newlines and separators within character
2484 constants are an exception: they do not end statements.
2485 @end ifset
2486 @end ifset
2487 @end ifclear
2488 @ifset GENERIC
2489 A @dfn{statement} ends at a newline character (@samp{\n}) or line
2490 separator character.  (The line separator is usually @samp{;}, unless this
2491 conflicts with the comment character; see @ref{Machine Dependencies}.)  The
2492 newline or separator character is considered part of the preceding
2493 statement.  Newlines and separators within character constants are an
2494 exception: they do not end statements.
2495 @end ifset
2497 @cindex newline, required at file end
2498 @cindex EOF, newline must precede
2499 It is an error to end any statement with end-of-file:  the last
2500 character of any input file should be a newline.@refill
2502 An empty statement is allowed, and may include whitespace.  It is ignored.
2504 @cindex instructions and directives
2505 @cindex directives and instructions
2506 @c "key symbol" is not used elsewhere in the document; seems pedantic to
2507 @c @defn{} it in that case, as was done previously...  doc@cygnus.com,
2508 @c 13feb91.
2509 A statement begins with zero or more labels, optionally followed by a
2510 key symbol which determines what kind of statement it is.  The key
2511 symbol determines the syntax of the rest of the statement.  If the
2512 symbol begins with a dot @samp{.} then the statement is an assembler
2513 directive: typically valid for any computer.  If the symbol begins with
2514 a letter the statement is an assembly language @dfn{instruction}: it
2515 assembles into a machine language instruction.
2516 @ifset GENERIC
2517 Different versions of @command{@value{AS}} for different computers
2518 recognize different instructions.  In fact, the same symbol may
2519 represent a different instruction in a different computer's assembly
2520 language.@refill
2521 @end ifset
2523 @cindex @code{:} (label)
2524 @cindex label (@code{:})
2525 A label is a symbol immediately followed by a colon (@code{:}).
2526 Whitespace before a label or after a colon is permitted, but you may not
2527 have whitespace between a label's symbol and its colon. @xref{Labels}.
2529 @ifset HPPA
2530 For HPPA targets, labels need not be immediately followed by a colon, but
2531 the definition of a label must begin in column zero.  This also implies that
2532 only one label may be defined on each line.
2533 @end ifset
2535 @smallexample
2536 label:     .directive    followed by something
2537 another_label:           # This is an empty statement.
2538            instruction   operand_1, operand_2, @dots{}
2539 @end smallexample
2541 @node Constants
2542 @section Constants
2544 @cindex constants
2545 A constant is a number, written so that its value is known by
2546 inspection, without knowing any context.  Like this:
2547 @smallexample
2548 @group
2549 .byte  74, 0112, 092, 0x4A, 0X4a, 'J, '\J # All the same value.
2550 .ascii "Ring the bell\7"                  # A string constant.
2551 .octa  0x123456789abcdef0123456789ABCDEF0 # A bignum.
2552 .float 0f-314159265358979323846264338327\
2553 95028841971.693993751E-40                 # - pi, a flonum.
2554 @end group
2555 @end smallexample
2557 @menu
2558 * Characters::                  Character Constants
2559 * Numbers::                     Number Constants
2560 @end menu
2562 @node Characters
2563 @subsection Character Constants
2565 @cindex character constants
2566 @cindex constants, character
2567 There are two kinds of character constants.  A @dfn{character} stands
2568 for one character in one byte and its value may be used in
2569 numeric expressions.  String constants (properly called string
2570 @emph{literals}) are potentially many bytes and their values may not be
2571 used in arithmetic expressions.
2573 @menu
2574 * Strings::                     Strings
2575 * Chars::                       Characters
2576 @end menu
2578 @node Strings
2579 @subsubsection Strings
2581 @cindex string constants
2582 @cindex constants, string
2583 A @dfn{string} is written between double-quotes.  It may contain
2584 double-quotes or null characters.  The way to get special characters
2585 into a string is to @dfn{escape} these characters: precede them with
2586 a backslash @samp{\} character.  For example @samp{\\} represents
2587 one backslash:  the first @code{\} is an escape which tells
2588 @command{@value{AS}} to interpret the second character literally as a backslash
2589 (which prevents @command{@value{AS}} from recognizing the second @code{\} as an
2590 escape character).  The complete list of escapes follows.
2592 @cindex escape codes, character
2593 @cindex character escape codes
2594 @table @kbd
2595 @c      @item \a
2596 @c      Mnemonic for ACKnowledge; for ASCII this is octal code 007.
2598 @cindex @code{\b} (backspace character)
2599 @cindex backspace (@code{\b})
2600 @item \b
2601 Mnemonic for backspace; for ASCII this is octal code 010.
2603 @c      @item \e
2604 @c      Mnemonic for EOText; for ASCII this is octal code 004.
2606 @cindex @code{\f} (formfeed character)
2607 @cindex formfeed (@code{\f})
2608 @item \f
2609 Mnemonic for FormFeed; for ASCII this is octal code 014.
2611 @cindex @code{\n} (newline character)
2612 @cindex newline (@code{\n})
2613 @item \n
2614 Mnemonic for newline; for ASCII this is octal code 012.
2616 @c      @item \p
2617 @c      Mnemonic for prefix; for ASCII this is octal code 033, usually known as @code{escape}.
2619 @cindex @code{\r} (carriage return character)
2620 @cindex carriage return (@code{\r})
2621 @item \r
2622 Mnemonic for carriage-Return; for ASCII this is octal code 015.
2624 @c      @item \s
2625 @c      Mnemonic for space; for ASCII this is octal code 040.  Included for compliance with
2626 @c      other assemblers.
2628 @cindex @code{\t} (tab)
2629 @cindex tab (@code{\t})
2630 @item \t
2631 Mnemonic for horizontal Tab; for ASCII this is octal code 011.
2633 @c      @item \v
2634 @c      Mnemonic for Vertical tab; for ASCII this is octal code 013.
2635 @c      @item \x @var{digit} @var{digit} @var{digit}
2636 @c      A hexadecimal character code.  The numeric code is 3 hexadecimal digits.
2638 @cindex @code{\@var{ddd}} (octal character code)
2639 @cindex octal character code (@code{\@var{ddd}})
2640 @item \ @var{digit} @var{digit} @var{digit}
2641 An octal character code.  The numeric code is 3 octal digits.
2642 For compatibility with other Unix systems, 8 and 9 are accepted as digits:
2643 for example, @code{\008} has the value 010, and @code{\009} the value 011.
2645 @cindex @code{\@var{xd...}} (hex character code)
2646 @cindex hex character code (@code{\@var{xd...}})
2647 @item \@code{x} @var{hex-digits...}
2648 A hex character code.  All trailing hex digits are combined.  Either upper or
2649 lower case @code{x} works.
2651 @cindex @code{\\} (@samp{\} character)
2652 @cindex backslash (@code{\\})
2653 @item \\
2654 Represents one @samp{\} character.
2656 @c      @item \'
2657 @c      Represents one @samp{'} (accent acute) character.
2658 @c      This is needed in single character literals
2659 @c      (@xref{Characters,,Character Constants}.) to represent
2660 @c      a @samp{'}.
2662 @cindex @code{\"} (doublequote character)
2663 @cindex doublequote (@code{\"})
2664 @item \"
2665 Represents one @samp{"} character.  Needed in strings to represent
2666 this character, because an unescaped @samp{"} would end the string.
2668 @item \ @var{anything-else}
2669 Any other character when escaped by @kbd{\} gives a warning, but
2670 assembles as if the @samp{\} was not present.  The idea is that if
2671 you used an escape sequence you clearly didn't want the literal
2672 interpretation of the following character.  However @command{@value{AS}} has no
2673 other interpretation, so @command{@value{AS}} knows it is giving you the wrong
2674 code and warns you of the fact.
2675 @end table
2677 Which characters are escapable, and what those escapes represent,
2678 varies widely among assemblers.  The current set is what we think
2679 the BSD 4.2 assembler recognizes, and is a subset of what most C
2680 compilers recognize.  If you are in doubt, do not use an escape
2681 sequence.
2683 @node Chars
2684 @subsubsection Characters
2686 @cindex single character constant
2687 @cindex character, single
2688 @cindex constant, single character
2689 A single character may be written as a single quote immediately
2690 followed by that character.  The same escapes apply to characters as
2691 to strings.  So if you want to write the character backslash, you
2692 must write @kbd{'\\} where the first @code{\} escapes the second
2693 @code{\}.  As you can see, the quote is an acute accent, not a
2694 grave accent.  A newline
2695 @ifclear GENERIC
2696 @ifclear abnormal-separator
2697 (or semicolon @samp{;})
2698 @end ifclear
2699 @ifset abnormal-separator
2700 @ifset H8
2701 (or dollar sign @samp{$}, for the H8/300; or semicolon @samp{;} for the
2702 Renesas SH)
2703 @end ifset
2704 @end ifset
2705 @end ifclear
2706 immediately following an acute accent is taken as a literal character
2707 and does not count as the end of a statement.  The value of a character
2708 constant in a numeric expression is the machine's byte-wide code for
2709 that character.  @command{@value{AS}} assumes your character code is ASCII:
2710 @kbd{'A} means 65, @kbd{'B} means 66, and so on. @refill
2712 @node Numbers
2713 @subsection Number Constants
2715 @cindex constants, number
2716 @cindex number constants
2717 @command{@value{AS}} distinguishes three kinds of numbers according to how they
2718 are stored in the target machine.  @emph{Integers} are numbers that
2719 would fit into an @code{int} in the C language.  @emph{Bignums} are
2720 integers, but they are stored in more than 32 bits.  @emph{Flonums}
2721 are floating point numbers, described below.
2723 @menu
2724 * Integers::                    Integers
2725 * Bignums::                     Bignums
2726 * Flonums::                     Flonums
2727 @ifclear GENERIC
2728 @ifset I960
2729 * Bit Fields::                  Bit Fields
2730 @end ifset
2731 @end ifclear
2732 @end menu
2734 @node Integers
2735 @subsubsection Integers
2736 @cindex integers
2737 @cindex constants, integer
2739 @cindex binary integers
2740 @cindex integers, binary
2741 A binary integer is @samp{0b} or @samp{0B} followed by zero or more of
2742 the binary digits @samp{01}.
2744 @cindex octal integers
2745 @cindex integers, octal
2746 An octal integer is @samp{0} followed by zero or more of the octal
2747 digits (@samp{01234567}).
2749 @cindex decimal integers
2750 @cindex integers, decimal
2751 A decimal integer starts with a non-zero digit followed by zero or
2752 more digits (@samp{0123456789}).
2754 @cindex hexadecimal integers
2755 @cindex integers, hexadecimal
2756 A hexadecimal integer is @samp{0x} or @samp{0X} followed by one or
2757 more hexadecimal digits chosen from @samp{0123456789abcdefABCDEF}.
2759 Integers have the usual values.  To denote a negative integer, use
2760 the prefix operator @samp{-} discussed under expressions
2761 (@pxref{Prefix Ops,,Prefix Operators}).
2763 @node Bignums
2764 @subsubsection Bignums
2766 @cindex bignums
2767 @cindex constants, bignum
2768 A @dfn{bignum} has the same syntax and semantics as an integer
2769 except that the number (or its negative) takes more than 32 bits to
2770 represent in binary.  The distinction is made because in some places
2771 integers are permitted while bignums are not.
2773 @node Flonums
2774 @subsubsection Flonums
2775 @cindex flonums
2776 @cindex floating point numbers
2777 @cindex constants, floating point
2779 @cindex precision, floating point
2780 A @dfn{flonum} represents a floating point number.  The translation is
2781 indirect: a decimal floating point number from the text is converted by
2782 @command{@value{AS}} to a generic binary floating point number of more than
2783 sufficient precision.  This generic floating point number is converted
2784 to a particular computer's floating point format (or formats) by a
2785 portion of @command{@value{AS}} specialized to that computer.
2787 A flonum is written by writing (in order)
2788 @itemize @bullet
2789 @item
2790 The digit @samp{0}.
2791 @ifset HPPA
2792 (@samp{0} is optional on the HPPA.)
2793 @end ifset
2795 @item
2796 A letter, to tell @command{@value{AS}} the rest of the number is a flonum.
2797 @ifset GENERIC
2798 @kbd{e} is recommended.  Case is not important.
2799 @ignore
2800 @c FIXME: verify if flonum syntax really this vague for most cases
2801 (Any otherwise illegal letter works here, but that might be changed.  Vax BSD
2802 4.2 assembler seems to allow any of @samp{defghDEFGH}.)
2803 @end ignore
2805 On the H8/300, Renesas / SuperH SH,
2806 and AMD 29K architectures, the letter must be
2807 one of the letters @samp{DFPRSX} (in upper or lower case).
2809 On the ARC, the letter must be one of the letters @samp{DFRS}
2810 (in upper or lower case).
2812 On the Intel 960 architecture, the letter must be
2813 one of the letters @samp{DFT} (in upper or lower case).
2815 On the HPPA architecture, the letter must be @samp{E} (upper case only).
2816 @end ifset
2817 @ifclear GENERIC
2818 @ifset ARC
2819 One of the letters @samp{DFRS} (in upper or lower case).
2820 @end ifset
2821 @ifset H8
2822 One of the letters @samp{DFPRSX} (in upper or lower case).
2823 @end ifset
2824 @ifset HPPA
2825 The letter @samp{E} (upper case only).
2826 @end ifset
2827 @ifset I960
2828 One of the letters @samp{DFT} (in upper or lower case).
2829 @end ifset
2830 @end ifclear
2832 @item
2833 An optional sign: either @samp{+} or @samp{-}.
2835 @item
2836 An optional @dfn{integer part}: zero or more decimal digits.
2838 @item
2839 An optional @dfn{fractional part}: @samp{.} followed by zero
2840 or more decimal digits.
2842 @item
2843 An optional exponent, consisting of:
2845 @itemize @bullet
2846 @item
2847 An @samp{E} or @samp{e}.
2848 @c I can't find a config where "EXP_CHARS" is other than 'eE', but in
2849 @c principle this can perfectly well be different on different targets.
2850 @item
2851 Optional sign: either @samp{+} or @samp{-}.
2852 @item
2853 One or more decimal digits.
2854 @end itemize
2856 @end itemize
2858 At least one of the integer part or the fractional part must be
2859 present.  The floating point number has the usual base-10 value.
2861 @command{@value{AS}} does all processing using integers.  Flonums are computed
2862 independently of any floating point hardware in the computer running
2863 @command{@value{AS}}.
2865 @ifclear GENERIC
2866 @ifset I960
2867 @c Bit fields are written as a general facility but are also controlled
2868 @c by a conditional-compilation flag---which is as of now (21mar91)
2869 @c turned on only by the i960 config of GAS.
2870 @node Bit Fields
2871 @subsubsection Bit Fields
2873 @cindex bit fields
2874 @cindex constants, bit field
2875 You can also define numeric constants as @dfn{bit fields}.
2876 Specify two numbers separated by a colon---
2877 @example
2878 @var{mask}:@var{value}
2879 @end example
2880 @noindent
2881 @command{@value{AS}} applies a bitwise @sc{and} between @var{mask} and
2882 @var{value}.
2884 The resulting number is then packed
2885 @ifset GENERIC
2886 @c this conditional paren in case bit fields turned on elsewhere than 960
2887 (in host-dependent byte order)
2888 @end ifset
2889 into a field whose width depends on which assembler directive has the
2890 bit-field as its argument.  Overflow (a result from the bitwise and
2891 requiring more binary digits to represent) is not an error; instead,
2892 more constants are generated, of the specified width, beginning with the
2893 least significant digits.@refill
2895 The directives @code{.byte}, @code{.hword}, @code{.int}, @code{.long},
2896 @code{.short}, and @code{.word} accept bit-field arguments.
2897 @end ifset
2898 @end ifclear
2900 @node Sections
2901 @chapter Sections and Relocation
2902 @cindex sections
2903 @cindex relocation
2905 @menu
2906 * Secs Background::             Background
2907 * Ld Sections::                 Linker Sections
2908 * As Sections::                 Assembler Internal Sections
2909 * Sub-Sections::                Sub-Sections
2910 * bss::                         bss Section
2911 @end menu
2913 @node Secs Background
2914 @section Background
2916 Roughly, a section is a range of addresses, with no gaps; all data
2917 ``in'' those addresses is treated the same for some particular purpose.
2918 For example there may be a ``read only'' section.
2920 @cindex linker, and assembler
2921 @cindex assembler, and linker
2922 The linker @code{@value{LD}} reads many object files (partial programs) and
2923 combines their contents to form a runnable program.  When @command{@value{AS}}
2924 emits an object file, the partial program is assumed to start at address 0.
2925 @code{@value{LD}} assigns the final addresses for the partial program, so that
2926 different partial programs do not overlap.  This is actually an
2927 oversimplification, but it suffices to explain how @command{@value{AS}} uses
2928 sections.
2930 @code{@value{LD}} moves blocks of bytes of your program to their run-time
2931 addresses.  These blocks slide to their run-time addresses as rigid
2932 units; their length does not change and neither does the order of bytes
2933 within them.  Such a rigid unit is called a @emph{section}.  Assigning
2934 run-time addresses to sections is called @dfn{relocation}.  It includes
2935 the task of adjusting mentions of object-file addresses so they refer to
2936 the proper run-time addresses.
2937 @ifset H8
2938 For the H8/300, and for the Renesas / SuperH SH,
2939 @command{@value{AS}} pads sections if needed to
2940 ensure they end on a word (sixteen bit) boundary.
2941 @end ifset
2943 @cindex standard assembler sections
2944 An object file written by @command{@value{AS}} has at least three sections, any
2945 of which may be empty.  These are named @dfn{text}, @dfn{data} and
2946 @dfn{bss} sections.
2948 @ifset COFF-ELF
2949 @ifset GENERIC
2950 When it generates COFF or ELF output,
2951 @end ifset
2952 @command{@value{AS}} can also generate whatever other named sections you specify
2953 using the @samp{.section} directive (@pxref{Section,,@code{.section}}).
2954 If you do not use any directives that place output in the @samp{.text}
2955 or @samp{.data} sections, these sections still exist, but are empty.
2956 @end ifset
2958 @ifset HPPA
2959 @ifset GENERIC
2960 When @command{@value{AS}} generates SOM or ELF output for the HPPA,
2961 @end ifset
2962 @command{@value{AS}} can also generate whatever other named sections you
2963 specify using the @samp{.space} and @samp{.subspace} directives.  See
2964 @cite{HP9000 Series 800 Assembly Language Reference Manual}
2965 (HP 92432-90001) for details on the @samp{.space} and @samp{.subspace}
2966 assembler directives.
2968 @ifset SOM
2969 Additionally, @command{@value{AS}} uses different names for the standard
2970 text, data, and bss sections when generating SOM output.  Program text
2971 is placed into the @samp{$CODE$} section, data into @samp{$DATA$}, and
2972 BSS into @samp{$BSS$}.
2973 @end ifset
2974 @end ifset
2976 Within the object file, the text section starts at address @code{0}, the
2977 data section follows, and the bss section follows the data section.
2979 @ifset HPPA
2980 When generating either SOM or ELF output files on the HPPA, the text
2981 section starts at address @code{0}, the data section at address
2982 @code{0x4000000}, and the bss section follows the data section.
2983 @end ifset
2985 To let @code{@value{LD}} know which data changes when the sections are
2986 relocated, and how to change that data, @command{@value{AS}} also writes to the
2987 object file details of the relocation needed.  To perform relocation
2988 @code{@value{LD}} must know, each time an address in the object
2989 file is mentioned:
2990 @itemize @bullet
2991 @item
2992 Where in the object file is the beginning of this reference to
2993 an address?
2994 @item
2995 How long (in bytes) is this reference?
2996 @item
2997 Which section does the address refer to?  What is the numeric value of
2998 @display
2999 (@var{address}) @minus{} (@var{start-address of section})?
3000 @end display
3001 @item
3002 Is the reference to an address ``Program-Counter relative''?
3003 @end itemize
3005 @cindex addresses, format of
3006 @cindex section-relative addressing
3007 In fact, every address @command{@value{AS}} ever uses is expressed as
3008 @display
3009 (@var{section}) + (@var{offset into section})
3010 @end display
3011 @noindent
3012 Further, most expressions @command{@value{AS}} computes have this section-relative
3013 nature.
3014 @ifset SOM
3015 (For some object formats, such as SOM for the HPPA, some expressions are
3016 symbol-relative instead.)
3017 @end ifset
3019 In this manual we use the notation @{@var{secname} @var{N}@} to mean ``offset
3020 @var{N} into section @var{secname}.''
3022 Apart from text, data and bss sections you need to know about the
3023 @dfn{absolute} section.  When @code{@value{LD}} mixes partial programs,
3024 addresses in the absolute section remain unchanged.  For example, address
3025 @code{@{absolute 0@}} is ``relocated'' to run-time address 0 by
3026 @code{@value{LD}}.  Although the linker never arranges two partial programs'
3027 data sections with overlapping addresses after linking, @emph{by definition}
3028 their absolute sections must overlap.  Address @code{@{absolute@ 239@}} in one
3029 part of a program is always the same address when the program is running as
3030 address @code{@{absolute@ 239@}} in any other part of the program.
3032 The idea of sections is extended to the @dfn{undefined} section.  Any
3033 address whose section is unknown at assembly time is by definition
3034 rendered @{undefined @var{U}@}---where @var{U} is filled in later.
3035 Since numbers are always defined, the only way to generate an undefined
3036 address is to mention an undefined symbol.  A reference to a named
3037 common block would be such a symbol: its value is unknown at assembly
3038 time so it has section @emph{undefined}.
3040 By analogy the word @emph{section} is used to describe groups of sections in
3041 the linked program.  @code{@value{LD}} puts all partial programs' text
3042 sections in contiguous addresses in the linked program.  It is
3043 customary to refer to the @emph{text section} of a program, meaning all
3044 the addresses of all partial programs' text sections.  Likewise for
3045 data and bss sections.
3047 Some sections are manipulated by @code{@value{LD}}; others are invented for
3048 use of @command{@value{AS}} and have no meaning except during assembly.
3050 @node Ld Sections
3051 @section Linker Sections
3052 @code{@value{LD}} deals with just four kinds of sections, summarized below.
3054 @table @strong
3056 @ifset COFF-ELF
3057 @cindex named sections
3058 @cindex sections, named
3059 @item named sections
3060 @end ifset
3061 @ifset aout-bout
3062 @cindex text section
3063 @cindex data section
3064 @itemx text section
3065 @itemx data section
3066 @end ifset
3067 These sections hold your program.  @command{@value{AS}} and @code{@value{LD}} treat them as
3068 separate but equal sections.  Anything you can say of one section is
3069 true of another.
3070 @c @ifset aout-bout
3071 When the program is running, however, it is
3072 customary for the text section to be unalterable.  The
3073 text section is often shared among processes: it contains
3074 instructions, constants and the like.  The data section of a running
3075 program is usually alterable: for example, C variables would be stored
3076 in the data section.
3077 @c @end ifset
3079 @cindex bss section
3080 @item bss section
3081 This section contains zeroed bytes when your program begins running.  It
3082 is used to hold uninitialized variables or common storage.  The length of
3083 each partial program's bss section is important, but because it starts
3084 out containing zeroed bytes there is no need to store explicit zero
3085 bytes in the object file.  The bss section was invented to eliminate
3086 those explicit zeros from object files.
3088 @cindex absolute section
3089 @item absolute section
3090 Address 0 of this section is always ``relocated'' to runtime address 0.
3091 This is useful if you want to refer to an address that @code{@value{LD}} must
3092 not change when relocating.  In this sense we speak of absolute
3093 addresses being ``unrelocatable'': they do not change during relocation.
3095 @cindex undefined section
3096 @item undefined section
3097 This ``section'' is a catch-all for address references to objects not in
3098 the preceding sections.
3099 @c FIXME: ref to some other doc on obj-file formats could go here.
3100 @end table
3102 @cindex relocation example
3103 An idealized example of three relocatable sections follows.
3104 @ifset COFF-ELF
3105 The example uses the traditional section names @samp{.text} and @samp{.data}.
3106 @end ifset
3107 Memory addresses are on the horizontal axis.
3109 @c TEXI2ROFF-KILL
3110 @ifnottex
3111 @c END TEXI2ROFF-KILL
3112 @smallexample
3113                       +-----+----+--+
3114 partial program # 1:  |ttttt|dddd|00|
3115                       +-----+----+--+
3117                       text   data bss
3118                       seg.   seg. seg.
3120                       +---+---+---+
3121 partial program # 2:  |TTT|DDD|000|
3122                       +---+---+---+
3124                       +--+---+-----+--+----+---+-----+~~
3125 linked program:       |  |TTT|ttttt|  |dddd|DDD|00000|
3126                       +--+---+-----+--+----+---+-----+~~
3128     addresses:        0 @dots{}
3129 @end smallexample
3130 @c TEXI2ROFF-KILL
3131 @end ifnottex
3132 @need 5000
3133 @tex
3134 \bigskip
3135 \line{\it Partial program \#1: \hfil}
3136 \line{\ibox{2.5cm}{\tt text}\ibox{2cm}{\tt data}\ibox{1cm}{\tt bss}\hfil}
3137 \line{\boxit{2.5cm}{\tt ttttt}\boxit{2cm}{\tt dddd}\boxit{1cm}{\tt 00}\hfil}
3139 \line{\it Partial program \#2: \hfil}
3140 \line{\ibox{1cm}{\tt text}\ibox{1.5cm}{\tt data}\ibox{1cm}{\tt bss}\hfil}
3141 \line{\boxit{1cm}{\tt TTT}\boxit{1.5cm}{\tt DDDD}\boxit{1cm}{\tt 000}\hfil}
3143 \line{\it linked program: \hfil}
3144 \line{\ibox{.5cm}{}\ibox{1cm}{\tt text}\ibox{2.5cm}{}\ibox{.75cm}{}\ibox{2cm}{\tt data}\ibox{1.5cm}{}\ibox{2cm}{\tt bss}\hfil}
3145 \line{\boxit{.5cm}{}\boxit{1cm}{\tt TTT}\boxit{2.5cm}{\tt
3146 ttttt}\boxit{.75cm}{}\boxit{2cm}{\tt dddd}\boxit{1.5cm}{\tt
3147 DDDD}\boxit{2cm}{\tt 00000}\ \dots\hfil}
3149 \line{\it addresses: \hfil}
3150 \line{0\dots\hfil}
3152 @end tex
3153 @c END TEXI2ROFF-KILL
3155 @node As Sections
3156 @section Assembler Internal Sections
3158 @cindex internal assembler sections
3159 @cindex sections in messages, internal
3160 These sections are meant only for the internal use of @command{@value{AS}}.  They
3161 have no meaning at run-time.  You do not really need to know about these
3162 sections for most purposes; but they can be mentioned in @command{@value{AS}}
3163 warning messages, so it might be helpful to have an idea of their
3164 meanings to @command{@value{AS}}.  These sections are used to permit the
3165 value of every expression in your assembly language program to be a
3166 section-relative address.
3168 @table @b
3169 @cindex assembler internal logic error
3170 @item ASSEMBLER-INTERNAL-LOGIC-ERROR!
3171 An internal assembler logic error has been found.  This means there is a
3172 bug in the assembler.
3174 @cindex expr (internal section)
3175 @item expr section
3176 The assembler stores complex expression internally as combinations of
3177 symbols.  When it needs to represent an expression as a symbol, it puts
3178 it in the expr section.
3179 @c FIXME item debug
3180 @c FIXME item transfer[t] vector preload
3181 @c FIXME item transfer[t] vector postload
3182 @c FIXME item register
3183 @end table
3185 @node Sub-Sections
3186 @section Sub-Sections
3188 @cindex numbered subsections
3189 @cindex grouping data
3190 @ifset aout-bout
3191 Assembled bytes
3192 @ifset COFF-ELF
3193 conventionally
3194 @end ifset
3195 fall into two sections: text and data.
3196 @end ifset
3197 You may have separate groups of
3198 @ifset GENERIC
3199 data in named sections
3200 @end ifset
3201 @ifclear GENERIC
3202 @ifclear aout-bout
3203 data in named sections
3204 @end ifclear
3205 @ifset aout-bout
3206 text or data
3207 @end ifset
3208 @end ifclear
3209 that you want to end up near to each other in the object file, even though they
3210 are not contiguous in the assembler source.  @command{@value{AS}} allows you to
3211 use @dfn{subsections} for this purpose.  Within each section, there can be
3212 numbered subsections with values from 0 to 8192.  Objects assembled into the
3213 same subsection go into the object file together with other objects in the same
3214 subsection.  For example, a compiler might want to store constants in the text
3215 section, but might not want to have them interspersed with the program being
3216 assembled.  In this case, the compiler could issue a @samp{.text 0} before each
3217 section of code being output, and a @samp{.text 1} before each group of
3218 constants being output.
3220 Subsections are optional.  If you do not use subsections, everything
3221 goes in subsection number zero.
3223 @ifset GENERIC
3224 Each subsection is zero-padded up to a multiple of four bytes.
3225 (Subsections may be padded a different amount on different flavors
3226 of @command{@value{AS}}.)
3227 @end ifset
3228 @ifclear GENERIC
3229 @ifset H8
3230 On the H8/300 platform, each subsection is zero-padded to a word
3231 boundary (two bytes).
3232 The same is true on the Renesas SH.
3233 @end ifset
3234 @ifset I960
3235 @c FIXME section padding (alignment)?
3236 @c Rich Pixley says padding here depends on target obj code format; that
3237 @c doesn't seem particularly useful to say without further elaboration,
3238 @c so for now I say nothing about it.  If this is a generic BFD issue,
3239 @c these paragraphs might need to vanish from this manual, and be
3240 @c discussed in BFD chapter of binutils (or some such).
3241 @end ifset
3242 @end ifclear
3244 Subsections appear in your object file in numeric order, lowest numbered
3245 to highest.  (All this to be compatible with other people's assemblers.)
3246 The object file contains no representation of subsections; @code{@value{LD}} and
3247 other programs that manipulate object files see no trace of them.
3248 They just see all your text subsections as a text section, and all your
3249 data subsections as a data section.
3251 To specify which subsection you want subsequent statements assembled
3252 into, use a numeric argument to specify it, in a @samp{.text
3253 @var{expression}} or a @samp{.data @var{expression}} statement.
3254 @ifset COFF
3255 @ifset GENERIC
3256 When generating COFF output, you
3257 @end ifset
3258 @ifclear GENERIC
3260 @end ifclear
3261 can also use an extra subsection
3262 argument with arbitrary named sections: @samp{.section @var{name},
3263 @var{expression}}.
3264 @end ifset
3265 @ifset ELF
3266 @ifset GENERIC
3267 When generating ELF output, you
3268 @end ifset
3269 @ifclear GENERIC
3271 @end ifclear
3272 can also use the @code{.subsection} directive (@pxref{SubSection})
3273 to specify a subsection: @samp{.subsection @var{expression}}.
3274 @end ifset
3275 @var{Expression} should be an absolute expression
3276 (@pxref{Expressions}).  If you just say @samp{.text} then @samp{.text 0}
3277 is assumed.  Likewise @samp{.data} means @samp{.data 0}.  Assembly
3278 begins in @code{text 0}.  For instance:
3279 @smallexample
3280 .text 0     # The default subsection is text 0 anyway.
3281 .ascii "This lives in the first text subsection. *"
3282 .text 1
3283 .ascii "But this lives in the second text subsection."
3284 .data 0
3285 .ascii "This lives in the data section,"
3286 .ascii "in the first data subsection."
3287 .text 0
3288 .ascii "This lives in the first text section,"
3289 .ascii "immediately following the asterisk (*)."
3290 @end smallexample
3292 Each section has a @dfn{location counter} incremented by one for every byte
3293 assembled into that section.  Because subsections are merely a convenience
3294 restricted to @command{@value{AS}} there is no concept of a subsection location
3295 counter.  There is no way to directly manipulate a location counter---but the
3296 @code{.align} directive changes it, and any label definition captures its
3297 current value.  The location counter of the section where statements are being
3298 assembled is said to be the @dfn{active} location counter.
3300 @node bss
3301 @section bss Section
3303 @cindex bss section
3304 @cindex common variable storage
3305 The bss section is used for local common variable storage.
3306 You may allocate address space in the bss section, but you may
3307 not dictate data to load into it before your program executes.  When
3308 your program starts running, all the contents of the bss
3309 section are zeroed bytes.
3311 The @code{.lcomm} pseudo-op defines a symbol in the bss section; see
3312 @ref{Lcomm,,@code{.lcomm}}.
3314 The @code{.comm} pseudo-op may be used to declare a common symbol, which is
3315 another form of uninitialized symbol; see @ref{Comm,,@code{.comm}}.
3317 @ifset GENERIC
3318 When assembling for a target which supports multiple sections, such as ELF or
3319 COFF, you may switch into the @code{.bss} section and define symbols as usual;
3320 see @ref{Section,,@code{.section}}.  You may only assemble zero values into the
3321 section.  Typically the section will only contain symbol definitions and
3322 @code{.skip} directives (@pxref{Skip,,@code{.skip}}).
3323 @end ifset
3325 @node Symbols
3326 @chapter Symbols
3328 @cindex symbols
3329 Symbols are a central concept: the programmer uses symbols to name
3330 things, the linker uses symbols to link, and the debugger uses symbols
3331 to debug.
3333 @quotation
3334 @cindex debuggers, and symbol order
3335 @emph{Warning:} @command{@value{AS}} does not place symbols in the object file in
3336 the same order they were declared.  This may break some debuggers.
3337 @end quotation
3339 @menu
3340 * Labels::                      Labels
3341 * Setting Symbols::             Giving Symbols Other Values
3342 * Symbol Names::                Symbol Names
3343 * Dot::                         The Special Dot Symbol
3344 * Symbol Attributes::           Symbol Attributes
3345 @end menu
3347 @node Labels
3348 @section Labels
3350 @cindex labels
3351 A @dfn{label} is written as a symbol immediately followed by a colon
3352 @samp{:}.  The symbol then represents the current value of the
3353 active location counter, and is, for example, a suitable instruction
3354 operand.  You are warned if you use the same symbol to represent two
3355 different locations: the first definition overrides any other
3356 definitions.
3358 @ifset HPPA
3359 On the HPPA, the usual form for a label need not be immediately followed by a
3360 colon, but instead must start in column zero.  Only one label may be defined on
3361 a single line.  To work around this, the HPPA version of @command{@value{AS}} also
3362 provides a special directive @code{.label} for defining labels more flexibly.
3363 @end ifset
3365 @node Setting Symbols
3366 @section Giving Symbols Other Values
3368 @cindex assigning values to symbols
3369 @cindex symbol values, assigning
3370 A symbol can be given an arbitrary value by writing a symbol, followed
3371 by an equals sign @samp{=}, followed by an expression
3372 (@pxref{Expressions}).  This is equivalent to using the @code{.set}
3373 directive.  @xref{Set,,@code{.set}}.  In the same way, using a double
3374 equals sign @samp{=}@samp{=} here represents an equivalent of the
3375 @code{.eqv} directive.  @xref{Eqv,,@code{.eqv}}.
3377 @ifset Blackfin
3378 Blackfin does not support symbol assignment with @samp{=}.
3379 @end ifset
3381 @node Symbol Names
3382 @section Symbol Names
3384 @cindex symbol names
3385 @cindex names, symbol
3386 @ifclear SPECIAL-SYMS
3387 Symbol names begin with a letter or with one of @samp{._}.  On most
3388 machines, you can also use @code{$} in symbol names; exceptions are
3389 noted in @ref{Machine Dependencies}.  That character may be followed by any
3390 string of digits, letters, dollar signs (unless otherwise noted for a
3391 particular target machine), and underscores.
3392 @end ifclear
3393 @ifset SPECIAL-SYMS
3394 @ifset H8
3395 Symbol names begin with a letter or with one of @samp{._}.  On the
3396 Renesas SH you can also use @code{$} in symbol names.  That
3397 character may be followed by any string of digits, letters, dollar signs (save
3398 on the H8/300), and underscores.
3399 @end ifset
3400 @end ifset
3402 Case of letters is significant: @code{foo} is a different symbol name
3403 than @code{Foo}.
3405 Each symbol has exactly one name.  Each name in an assembly language program
3406 refers to exactly one symbol.  You may use that symbol name any number of times
3407 in a program.
3409 @subheading Local Symbol Names
3411 @cindex local symbol names
3412 @cindex symbol names, local
3413 A local symbol is any symbol beginning with certain local label prefixes.
3414 By default, the local label prefix is @samp{.L} for ELF systems or
3415 @samp{L} for traditional a.out systems, but each target may have its own
3416 set of local label prefixes.
3417 @ifset HPPA
3418 On the HPPA local symbols begin with @samp{L$}.
3419 @end ifset
3421 Local symbols are defined and used within the assembler, but they are
3422 normally not saved in object files.  Thus, they are not visible when debugging.
3423 You may use the @samp{-L} option (@pxref{L, ,Include Local Symbols:
3424 @option{-L}}) to retain the local symbols in the object files.
3426 @subheading Local Labels
3428 @cindex local labels
3429 @cindex temporary symbol names
3430 @cindex symbol names, temporary
3431 Local labels help compilers and programmers use names temporarily.
3432 They create symbols which are guaranteed to be unique over the entire scope of
3433 the input source code and which can be referred to by a simple notation.
3434 To define a local label, write a label of the form @samp{@b{N}:} (where @b{N}
3435 represents any positive integer).  To refer to the most recent previous
3436 definition of that label write @samp{@b{N}b}, using the same number as when
3437 you defined the label.  To refer to the next definition of a local label, write
3438 @samp{@b{N}f}---the @samp{b} stands for ``backwards'' and the @samp{f} stands
3439 for ``forwards''.
3441 There is no restriction on how you can use these labels, and you can reuse them
3442 too.  So that it is possible to repeatedly define the same local label (using
3443 the same number @samp{@b{N}}), although you can only refer to the most recently
3444 defined local label of that number (for a backwards reference) or the next
3445 definition of a specific local label for a forward reference.  It is also worth
3446 noting that the first 10 local labels (@samp{@b{0:}}@dots{}@samp{@b{9:}}) are
3447 implemented in a slightly more efficient manner than the others.
3449 Here is an example:
3451 @smallexample
3452 1:        branch 1f
3453 2:        branch 1b
3454 1:        branch 2f
3455 2:        branch 1b
3456 @end smallexample
3458 Which is the equivalent of:
3460 @smallexample
3461 label_1:  branch label_3
3462 label_2:  branch label_1
3463 label_3:  branch label_4
3464 label_4:  branch label_3
3465 @end smallexample
3467 Local label names are only a notational device.  They are immediately
3468 transformed into more conventional symbol names before the assembler uses them.
3469 The symbol names are stored in the symbol table, appear in error messages, and
3470 are optionally emitted to the object file.  The names are constructed using
3471 these parts:
3473 @table @code
3474 @item @emph{local label prefix}
3475 All local symbols begin with the system-specific local label prefix.
3476 Normally both @command{@value{AS}} and @code{@value{LD}} forget symbols
3477 that start with the local label prefix.  These labels are
3478 used for symbols you are never intended to see.  If you use the
3479 @samp{-L} option then @command{@value{AS}} retains these symbols in the
3480 object file. If you also instruct @code{@value{LD}} to retain these symbols,
3481 you may use them in debugging.
3483 @item @var{number}
3484 This is the number that was used in the local label definition.  So if the
3485 label is written @samp{55:} then the number is @samp{55}.
3487 @item @kbd{C-B}
3488 This unusual character is included so you do not accidentally invent a symbol
3489 of the same name.  The character has ASCII value of @samp{\002} (control-B).
3491 @item @emph{ordinal number}
3492 This is a serial number to keep the labels distinct.  The first definition of
3493 @samp{0:} gets the number @samp{1}.  The 15th definition of @samp{0:} gets the
3494 number @samp{15}, and so on.  Likewise the first definition of @samp{1:} gets
3495 the number @samp{1} and its 15th definition gets @samp{15} as well.
3496 @end table
3498 So for example, the first @code{1:} may be named @code{.L1@kbd{C-B}1}, and
3499 the 44th @code{3:} may be named @code{.L3@kbd{C-B}44}.
3501 @subheading Dollar Local Labels
3502 @cindex dollar local symbols
3504 @code{@value{AS}} also supports an even more local form of local labels called
3505 dollar labels.  These labels go out of scope (i.e., they become undefined) as
3506 soon as a non-local label is defined.  Thus they remain valid for only a small
3507 region of the input source code.  Normal local labels, by contrast, remain in
3508 scope for the entire file, or until they are redefined by another occurrence of
3509 the same local label.
3511 Dollar labels are defined in exactly the same way as ordinary local labels,
3512 except that they have a dollar sign suffix to their numeric value, e.g.,
3513 @samp{@b{55$:}}.
3515 They can also be distinguished from ordinary local labels by their transformed
3516 names which use ASCII character @samp{\001} (control-A) as the magic character
3517 to distinguish them from ordinary labels.  For example, the fifth definition of
3518 @samp{6$} may be named @samp{.L6@kbd{C-A}5}.
3520 @node Dot
3521 @section The Special Dot Symbol
3523 @cindex dot (symbol)
3524 @cindex @code{.} (symbol)
3525 @cindex current address
3526 @cindex location counter
3527 The special symbol @samp{.} refers to the current address that
3528 @command{@value{AS}} is assembling into.  Thus, the expression @samp{melvin:
3529 .long .} defines @code{melvin} to contain its own address.
3530 Assigning a value to @code{.} is treated the same as a @code{.org}
3531 directive.
3532 @ifclear no-space-dir
3533 Thus, the expression @samp{.=.+4} is the same as saying
3534 @samp{.space 4}.
3535 @end ifclear
3537 @node Symbol Attributes
3538 @section Symbol Attributes
3540 @cindex symbol attributes
3541 @cindex attributes, symbol
3542 Every symbol has, as well as its name, the attributes ``Value'' and
3543 ``Type''.  Depending on output format, symbols can also have auxiliary
3544 attributes.
3545 @ifset INTERNALS
3546 The detailed definitions are in @file{a.out.h}.
3547 @end ifset
3549 If you use a symbol without defining it, @command{@value{AS}} assumes zero for
3550 all these attributes, and probably won't warn you.  This makes the
3551 symbol an externally defined symbol, which is generally what you
3552 would want.
3554 @menu
3555 * Symbol Value::                Value
3556 * Symbol Type::                 Type
3557 @ifset aout-bout
3558 @ifset GENERIC
3559 * a.out Symbols::               Symbol Attributes: @code{a.out}
3560 @end ifset
3561 @ifclear GENERIC
3562 @ifclear BOUT
3563 * a.out Symbols::               Symbol Attributes: @code{a.out}
3564 @end ifclear
3565 @ifset BOUT
3566 * a.out Symbols::               Symbol Attributes: @code{a.out}, @code{b.out}
3567 @end ifset
3568 @end ifclear
3569 @end ifset
3570 @ifset COFF
3571 * COFF Symbols::                Symbol Attributes for COFF
3572 @end ifset
3573 @ifset SOM
3574 * SOM Symbols::                Symbol Attributes for SOM
3575 @end ifset
3576 @end menu
3578 @node Symbol Value
3579 @subsection Value
3581 @cindex value of a symbol
3582 @cindex symbol value
3583 The value of a symbol is (usually) 32 bits.  For a symbol which labels a
3584 location in the text, data, bss or absolute sections the value is the
3585 number of addresses from the start of that section to the label.
3586 Naturally for text, data and bss sections the value of a symbol changes
3587 as @code{@value{LD}} changes section base addresses during linking.  Absolute
3588 symbols' values do not change during linking: that is why they are
3589 called absolute.
3591 The value of an undefined symbol is treated in a special way.  If it is
3592 0 then the symbol is not defined in this assembler source file, and
3593 @code{@value{LD}} tries to determine its value from other files linked into the
3594 same program.  You make this kind of symbol simply by mentioning a symbol
3595 name without defining it.  A non-zero value represents a @code{.comm}
3596 common declaration.  The value is how much common storage to reserve, in
3597 bytes (addresses).  The symbol refers to the first address of the
3598 allocated storage.
3600 @node Symbol Type
3601 @subsection Type
3603 @cindex type of a symbol
3604 @cindex symbol type
3605 The type attribute of a symbol contains relocation (section)
3606 information, any flag settings indicating that a symbol is external, and
3607 (optionally), other information for linkers and debuggers.  The exact
3608 format depends on the object-code output format in use.
3610 @ifset aout-bout
3611 @ifclear GENERIC
3612 @ifset BOUT
3613 @c The following avoids a "widow" subsection title.  @group would be
3614 @c better if it were available outside examples.
3615 @need 1000
3616 @node a.out Symbols
3617 @subsection Symbol Attributes: @code{a.out}, @code{b.out}
3619 @cindex @code{b.out} symbol attributes
3620 @cindex symbol attributes, @code{b.out}
3621 These symbol attributes appear only when @command{@value{AS}} is configured for
3622 one of the Berkeley-descended object output formats---@code{a.out} or
3623 @code{b.out}.
3625 @end ifset
3626 @ifclear BOUT
3627 @node a.out Symbols
3628 @subsection Symbol Attributes: @code{a.out}
3630 @cindex @code{a.out} symbol attributes
3631 @cindex symbol attributes, @code{a.out}
3633 @end ifclear
3634 @end ifclear
3635 @ifset GENERIC
3636 @node a.out Symbols
3637 @subsection Symbol Attributes: @code{a.out}
3639 @cindex @code{a.out} symbol attributes
3640 @cindex symbol attributes, @code{a.out}
3642 @end ifset
3643 @menu
3644 * Symbol Desc::                 Descriptor
3645 * Symbol Other::                Other
3646 @end menu
3648 @node Symbol Desc
3649 @subsubsection Descriptor
3651 @cindex descriptor, of @code{a.out} symbol
3652 This is an arbitrary 16-bit value.  You may establish a symbol's
3653 descriptor value by using a @code{.desc} statement
3654 (@pxref{Desc,,@code{.desc}}).  A descriptor value means nothing to
3655 @command{@value{AS}}.
3657 @node Symbol Other
3658 @subsubsection Other
3660 @cindex other attribute, of @code{a.out} symbol
3661 This is an arbitrary 8-bit value.  It means nothing to @command{@value{AS}}.
3662 @end ifset
3664 @ifset COFF
3665 @node COFF Symbols
3666 @subsection Symbol Attributes for COFF
3668 @cindex COFF symbol attributes
3669 @cindex symbol attributes, COFF
3671 The COFF format supports a multitude of auxiliary symbol attributes;
3672 like the primary symbol attributes, they are set between @code{.def} and
3673 @code{.endef} directives.
3675 @subsubsection Primary Attributes
3677 @cindex primary attributes, COFF symbols
3678 The symbol name is set with @code{.def}; the value and type,
3679 respectively, with @code{.val} and @code{.type}.
3681 @subsubsection Auxiliary Attributes
3683 @cindex auxiliary attributes, COFF symbols
3684 The @command{@value{AS}} directives @code{.dim}, @code{.line}, @code{.scl},
3685 @code{.size}, @code{.tag}, and @code{.weak} can generate auxiliary symbol
3686 table information for COFF.
3687 @end ifset
3689 @ifset SOM
3690 @node SOM Symbols
3691 @subsection Symbol Attributes for SOM
3693 @cindex SOM symbol attributes
3694 @cindex symbol attributes, SOM
3696 The SOM format for the HPPA supports a multitude of symbol attributes set with
3697 the @code{.EXPORT} and @code{.IMPORT} directives.
3699 The attributes are described in @cite{HP9000 Series 800 Assembly
3700 Language Reference Manual} (HP 92432-90001) under the @code{IMPORT} and
3701 @code{EXPORT} assembler directive documentation.
3702 @end ifset
3704 @node Expressions
3705 @chapter Expressions
3707 @cindex expressions
3708 @cindex addresses
3709 @cindex numeric values
3710 An @dfn{expression} specifies an address or numeric value.
3711 Whitespace may precede and/or follow an expression.
3713 The result of an expression must be an absolute number, or else an offset into
3714 a particular section.  If an expression is not absolute, and there is not
3715 enough information when @command{@value{AS}} sees the expression to know its
3716 section, a second pass over the source program might be necessary to interpret
3717 the expression---but the second pass is currently not implemented.
3718 @command{@value{AS}} aborts with an error message in this situation.
3720 @menu
3721 * Empty Exprs::                 Empty Expressions
3722 * Integer Exprs::               Integer Expressions
3723 @end menu
3725 @node Empty Exprs
3726 @section Empty Expressions
3728 @cindex empty expressions
3729 @cindex expressions, empty
3730 An empty expression has no value: it is just whitespace or null.
3731 Wherever an absolute expression is required, you may omit the
3732 expression, and @command{@value{AS}} assumes a value of (absolute) 0.  This
3733 is compatible with other assemblers.
3735 @node Integer Exprs
3736 @section Integer Expressions
3738 @cindex integer expressions
3739 @cindex expressions, integer
3740 An @dfn{integer expression} is one or more @emph{arguments} delimited
3741 by @emph{operators}.
3743 @menu
3744 * Arguments::                   Arguments
3745 * Operators::                   Operators
3746 * Prefix Ops::                  Prefix Operators
3747 * Infix Ops::                   Infix Operators
3748 @end menu
3750 @node Arguments
3751 @subsection Arguments
3753 @cindex expression arguments
3754 @cindex arguments in expressions
3755 @cindex operands in expressions
3756 @cindex arithmetic operands
3757 @dfn{Arguments} are symbols, numbers or subexpressions.  In other
3758 contexts arguments are sometimes called ``arithmetic operands''.  In
3759 this manual, to avoid confusing them with the ``instruction operands'' of
3760 the machine language, we use the term ``argument'' to refer to parts of
3761 expressions only, reserving the word ``operand'' to refer only to machine
3762 instruction operands.
3764 Symbols are evaluated to yield @{@var{section} @var{NNN}@} where
3765 @var{section} is one of text, data, bss, absolute,
3766 or undefined.  @var{NNN} is a signed, 2's complement 32 bit
3767 integer.
3769 Numbers are usually integers.
3771 A number can be a flonum or bignum.  In this case, you are warned
3772 that only the low order 32 bits are used, and @command{@value{AS}} pretends
3773 these 32 bits are an integer.  You may write integer-manipulating
3774 instructions that act on exotic constants, compatible with other
3775 assemblers.
3777 @cindex subexpressions
3778 Subexpressions are a left parenthesis @samp{(} followed by an integer
3779 expression, followed by a right parenthesis @samp{)}; or a prefix
3780 operator followed by an argument.
3782 @node Operators
3783 @subsection Operators
3785 @cindex operators, in expressions
3786 @cindex arithmetic functions
3787 @cindex functions, in expressions
3788 @dfn{Operators} are arithmetic functions, like @code{+} or @code{%}.  Prefix
3789 operators are followed by an argument.  Infix operators appear
3790 between their arguments.  Operators may be preceded and/or followed by
3791 whitespace.
3793 @node Prefix Ops
3794 @subsection Prefix Operator
3796 @cindex prefix operators
3797 @command{@value{AS}} has the following @dfn{prefix operators}.  They each take
3798 one argument, which must be absolute.
3800 @c the tex/end tex stuff surrounding this small table is meant to make
3801 @c it align, on the printed page, with the similar table in the next
3802 @c section (which is inside an enumerate).
3803 @tex
3804 \global\advance\leftskip by \itemindent
3805 @end tex
3807 @table @code
3808 @item -
3809 @dfn{Negation}.  Two's complement negation.
3810 @item ~
3811 @dfn{Complementation}.  Bitwise not.
3812 @end table
3814 @tex
3815 \global\advance\leftskip by -\itemindent
3816 @end tex
3818 @node Infix Ops
3819 @subsection Infix Operators
3821 @cindex infix operators
3822 @cindex operators, permitted arguments
3823 @dfn{Infix operators} take two arguments, one on either side.  Operators
3824 have precedence, but operations with equal precedence are performed left
3825 to right.  Apart from @code{+} or @option{-}, both arguments must be
3826 absolute, and the result is absolute.
3828 @enumerate
3829 @cindex operator precedence
3830 @cindex precedence of operators
3832 @item
3833 Highest Precedence
3835 @table @code
3836 @item *
3837 @dfn{Multiplication}.
3839 @item /
3840 @dfn{Division}.  Truncation is the same as the C operator @samp{/}
3842 @item %
3843 @dfn{Remainder}.
3845 @item <<
3846 @dfn{Shift Left}.  Same as the C operator @samp{<<}.
3848 @item >>
3849 @dfn{Shift Right}.  Same as the C operator @samp{>>}.
3850 @end table
3852 @item
3853 Intermediate precedence
3855 @table @code
3856 @item |
3858 @dfn{Bitwise Inclusive Or}.
3860 @item &
3861 @dfn{Bitwise And}.
3863 @item ^
3864 @dfn{Bitwise Exclusive Or}.
3866 @item !
3867 @dfn{Bitwise Or Not}.
3868 @end table
3870 @item
3871 Low Precedence
3873 @table @code
3874 @cindex addition, permitted arguments
3875 @cindex plus, permitted arguments
3876 @cindex arguments for addition
3877 @item +
3878 @dfn{Addition}.  If either argument is absolute, the result has the section of
3879 the other argument.  You may not add together arguments from different
3880 sections.
3882 @cindex subtraction, permitted arguments
3883 @cindex minus, permitted arguments
3884 @cindex arguments for subtraction
3885 @item -
3886 @dfn{Subtraction}.  If the right argument is absolute, the
3887 result has the section of the left argument.
3888 If both arguments are in the same section, the result is absolute.
3889 You may not subtract arguments from different sections.
3890 @c FIXME is there still something useful to say about undefined - undefined ?
3892 @cindex comparison expressions
3893 @cindex expressions, comparison
3894 @item  ==
3895 @dfn{Is Equal To}
3896 @item <>
3897 @itemx !=
3898 @dfn{Is Not Equal To}
3899 @item <
3900 @dfn{Is Less Than}
3901 @item >
3902 @dfn{Is Greater Than}
3903 @item >=
3904 @dfn{Is Greater Than Or Equal To}
3905 @item <=
3906 @dfn{Is Less Than Or Equal To}
3908 The comparison operators can be used as infix operators.  A true results has a
3909 value of -1 whereas a false result has a value of 0.   Note, these operators
3910 perform signed comparisons.
3911 @end table
3913 @item Lowest Precedence
3915 @table @code
3916 @item &&
3917 @dfn{Logical And}.
3919 @item ||
3920 @dfn{Logical Or}.
3922 These two logical operations can be used to combine the results of sub
3923 expressions.  Note, unlike the comparison operators a true result returns a
3924 value of 1 but a false results does still return 0.  Also note that the logical
3925 or operator has a slightly lower precedence than logical and.
3927 @end table
3928 @end enumerate
3930 In short, it's only meaningful to add or subtract the @emph{offsets} in an
3931 address; you can only have a defined section in one of the two arguments.
3933 @node Pseudo Ops
3934 @chapter Assembler Directives
3936 @cindex directives, machine independent
3937 @cindex pseudo-ops, machine independent
3938 @cindex machine independent directives
3939 All assembler directives have names that begin with a period (@samp{.}).
3940 The rest of the name is letters, usually in lower case.
3942 This chapter discusses directives that are available regardless of the
3943 target machine configuration for the @sc{gnu} assembler.
3944 @ifset GENERIC
3945 Some machine configurations provide additional directives.
3946 @xref{Machine Dependencies}.
3947 @end ifset
3948 @ifclear GENERIC
3949 @ifset machine-directives
3950 @xref{Machine Dependencies}, for additional directives.
3951 @end ifset
3952 @end ifclear
3954 @menu
3955 * Abort::                       @code{.abort}
3956 @ifset COFF
3957 * ABORT (COFF)::                @code{.ABORT}
3958 @end ifset
3960 * Align::                       @code{.align @var{abs-expr} , @var{abs-expr}}
3961 * Altmacro::                    @code{.altmacro}
3962 * Ascii::                       @code{.ascii "@var{string}"}@dots{}
3963 * Asciz::                       @code{.asciz "@var{string}"}@dots{}
3964 * Balign::                      @code{.balign @var{abs-expr} , @var{abs-expr}}
3965 * Byte::                        @code{.byte @var{expressions}}
3966 * CFI directives::              @code{.cfi_startproc [simple]}, @code{.cfi_endproc}, etc.
3967 * Comm::                        @code{.comm @var{symbol} , @var{length} }
3968 * Data::                        @code{.data @var{subsection}}
3969 @ifset COFF
3970 * Def::                         @code{.def @var{name}}
3971 @end ifset
3972 @ifset aout-bout
3973 * Desc::                        @code{.desc @var{symbol}, @var{abs-expression}}
3974 @end ifset
3975 @ifset COFF
3976 * Dim::                         @code{.dim}
3977 @end ifset
3979 * Double::                      @code{.double @var{flonums}}
3980 * Eject::                       @code{.eject}
3981 * Else::                        @code{.else}
3982 * Elseif::                      @code{.elseif}
3983 * End::                         @code{.end}
3984 @ifset COFF
3985 * Endef::                       @code{.endef}
3986 @end ifset
3988 * Endfunc::                     @code{.endfunc}
3989 * Endif::                       @code{.endif}
3990 * Equ::                         @code{.equ @var{symbol}, @var{expression}}
3991 * Equiv::                       @code{.equiv @var{symbol}, @var{expression}}
3992 * Eqv::                         @code{.eqv @var{symbol}, @var{expression}}
3993 * Err::                         @code{.err}
3994 * Error::                       @code{.error @var{string}}
3995 * Exitm::                       @code{.exitm}
3996 * Extern::                      @code{.extern}
3997 * Fail::                        @code{.fail}
3998 * File::                        @code{.file}
3999 * Fill::                        @code{.fill @var{repeat} , @var{size} , @var{value}}
4000 * Float::                       @code{.float @var{flonums}}
4001 * Func::                        @code{.func}
4002 * Global::                      @code{.global @var{symbol}}, @code{.globl @var{symbol}}
4003 @ifset ELF
4004 * Gnu_attribute::               @code{.gnu_attribute @var{tag},@var{value}}
4005 * Hidden::                      @code{.hidden @var{names}}
4006 @end ifset
4008 * hword::                       @code{.hword @var{expressions}}
4009 * Ident::                       @code{.ident}
4010 * If::                          @code{.if @var{absolute expression}}
4011 * Incbin::                      @code{.incbin "@var{file}"[,@var{skip}[,@var{count}]]}
4012 * Include::                     @code{.include "@var{file}"}
4013 * Int::                         @code{.int @var{expressions}}
4014 @ifset ELF
4015 * Internal::                    @code{.internal @var{names}}
4016 @end ifset
4018 * Irp::                         @code{.irp @var{symbol},@var{values}}@dots{}
4019 * Irpc::                        @code{.irpc @var{symbol},@var{values}}@dots{}
4020 * Lcomm::                       @code{.lcomm @var{symbol} , @var{length}}
4021 * Lflags::                      @code{.lflags}
4022 @ifclear no-line-dir
4023 * Line::                        @code{.line @var{line-number}}
4024 @end ifclear
4026 * Linkonce::                    @code{.linkonce [@var{type}]}
4027 * List::                        @code{.list}
4028 * Ln::                          @code{.ln @var{line-number}}
4029 * Loc::                         @code{.loc @var{fileno} @var{lineno}}
4030 * Loc_mark_labels::             @code{.loc_mark_labels @var{enable}}
4031 @ifset ELF
4032 * Local::                       @code{.local @var{names}}
4033 @end ifset
4035 * Long::                        @code{.long @var{expressions}}
4036 @ignore
4037 * Lsym::                        @code{.lsym @var{symbol}, @var{expression}}
4038 @end ignore
4040 * Macro::                       @code{.macro @var{name} @var{args}}@dots{}
4041 * MRI::                         @code{.mri @var{val}}
4042 * Noaltmacro::                  @code{.noaltmacro}
4043 * Nolist::                      @code{.nolist}
4044 * Octa::                        @code{.octa @var{bignums}}
4045 * Org::                         @code{.org @var{new-lc}, @var{fill}}
4046 * P2align::                     @code{.p2align @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
4047 @ifset ELF
4048 * PopSection::                  @code{.popsection}
4049 * Previous::                    @code{.previous}
4050 @end ifset
4052 * Print::                       @code{.print @var{string}}
4053 @ifset ELF
4054 * Protected::                   @code{.protected @var{names}}
4055 @end ifset
4057 * Psize::                       @code{.psize @var{lines}, @var{columns}}
4058 * Purgem::                      @code{.purgem @var{name}}
4059 @ifset ELF
4060 * PushSection::                 @code{.pushsection @var{name}}
4061 @end ifset
4063 * Quad::                        @code{.quad @var{bignums}}
4064 * Reloc::                       @code{.reloc @var{offset}, @var{reloc_name}[, @var{expression}]}
4065 * Rept::                        @code{.rept @var{count}}
4066 * Sbttl::                       @code{.sbttl "@var{subheading}"}
4067 @ifset COFF
4068 * Scl::                         @code{.scl @var{class}}
4069 @end ifset
4070 @ifset COFF-ELF
4071 * Section::                     @code{.section @var{name}[, @var{flags}]}
4072 @end ifset
4074 * Set::                         @code{.set @var{symbol}, @var{expression}}
4075 * Short::                       @code{.short @var{expressions}}
4076 * Single::                      @code{.single @var{flonums}}
4077 @ifset COFF-ELF
4078 * Size::                        @code{.size [@var{name} , @var{expression}]}
4079 @end ifset
4080 @ifclear no-space-dir
4081 * Skip::                        @code{.skip @var{size} , @var{fill}}
4082 @end ifclear
4084 * Sleb128::                     @code{.sleb128 @var{expressions}}
4085 @ifclear no-space-dir
4086 * Space::                       @code{.space @var{size} , @var{fill}}
4087 @end ifclear
4088 @ifset have-stabs
4089 * Stab::                        @code{.stabd, .stabn, .stabs}
4090 @end ifset
4092 * String::                      @code{.string "@var{str}"}, @code{.string8 "@var{str}"}, @code{.string16 "@var{str}"}, @code{.string32 "@var{str}"}, @code{.string64 "@var{str}"}
4093 * Struct::                      @code{.struct @var{expression}}
4094 @ifset ELF
4095 * SubSection::                  @code{.subsection}
4096 * Symver::                      @code{.symver @var{name},@var{name2@@nodename}}
4097 @end ifset
4099 @ifset COFF
4100 * Tag::                         @code{.tag @var{structname}}
4101 @end ifset
4103 * Text::                        @code{.text @var{subsection}}
4104 * Title::                       @code{.title "@var{heading}"}
4105 @ifset COFF-ELF
4106 * Type::                        @code{.type <@var{int} | @var{name} , @var{type description}>}
4107 @end ifset
4109 * Uleb128::                     @code{.uleb128 @var{expressions}}
4110 @ifset COFF
4111 * Val::                         @code{.val @var{addr}}
4112 @end ifset
4114 @ifset ELF
4115 * Version::                     @code{.version "@var{string}"}
4116 * VTableEntry::                 @code{.vtable_entry @var{table}, @var{offset}}
4117 * VTableInherit::               @code{.vtable_inherit @var{child}, @var{parent}}
4118 @end ifset
4120 * Warning::                     @code{.warning @var{string}}
4121 * Weak::                        @code{.weak @var{names}}
4122 * Weakref::                     @code{.weakref @var{alias}, @var{symbol}}
4123 * Word::                        @code{.word @var{expressions}}
4124 * Deprecated::                  Deprecated Directives
4125 @end menu
4127 @node Abort
4128 @section @code{.abort}
4130 @cindex @code{abort} directive
4131 @cindex stopping the assembly
4132 This directive stops the assembly immediately.  It is for
4133 compatibility with other assemblers.  The original idea was that the
4134 assembly language source would be piped into the assembler.  If the sender
4135 of the source quit, it could use this directive tells @command{@value{AS}} to
4136 quit also.  One day @code{.abort} will not be supported.
4138 @ifset COFF
4139 @node ABORT (COFF)
4140 @section @code{.ABORT} (COFF)
4142 @cindex @code{ABORT} directive
4143 When producing COFF output, @command{@value{AS}} accepts this directive as a
4144 synonym for @samp{.abort}.
4146 @ifset BOUT
4147 When producing @code{b.out} output, @command{@value{AS}} accepts this directive,
4148 but ignores it.
4149 @end ifset
4150 @end ifset
4152 @node Align
4153 @section @code{.align @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
4155 @cindex padding the location counter
4156 @cindex @code{align} directive
4157 Pad the location counter (in the current subsection) to a particular storage
4158 boundary.  The first expression (which must be absolute) is the alignment
4159 required, as described below.
4161 The second expression (also absolute) gives the fill value to be stored in the
4162 padding bytes.  It (and the comma) may be omitted.  If it is omitted, the
4163 padding bytes are normally zero.  However, on some systems, if the section is
4164 marked as containing code and the fill value is omitted, the space is filled
4165 with no-op instructions.
4167 The third expression is also absolute, and is also optional.  If it is present,
4168 it is the maximum number of bytes that should be skipped by this alignment
4169 directive.  If doing the alignment would require skipping more bytes than the
4170 specified maximum, then the alignment is not done at all.  You can omit the
4171 fill value (the second argument) entirely by simply using two commas after the
4172 required alignment; this can be useful if you want the alignment to be filled
4173 with no-op instructions when appropriate.
4175 The way the required alignment is specified varies from system to system.
4176 For the arc, hppa, i386 using ELF, i860, iq2000, m68k, or32,
4177 s390, sparc, tic4x, tic80 and xtensa, the first expression is the
4178 alignment request in bytes.  For example @samp{.align 8} advances
4179 the location counter until it is a multiple of 8.  If the location counter
4180 is already a multiple of 8, no change is needed.  For the tic54x, the
4181 first expression is the alignment request in words.
4183 For other systems, including ppc, i386 using a.out format, arm and
4184 strongarm, it is the
4185 number of low-order zero bits the location counter must have after
4186 advancement.  For example @samp{.align 3} advances the location
4187 counter until it a multiple of 8.  If the location counter is already a
4188 multiple of 8, no change is needed.
4190 This inconsistency is due to the different behaviors of the various
4191 native assemblers for these systems which GAS must emulate.
4192 GAS also provides @code{.balign} and @code{.p2align} directives,
4193 described later, which have a consistent behavior across all
4194 architectures (but are specific to GAS).
4196 @node Altmacro
4197 @section @code{.altmacro}
4198 Enable alternate macro mode, enabling:
4200 @ftable @code
4201 @item LOCAL @var{name} [ , @dots{} ]
4202 One additional directive, @code{LOCAL}, is available.  It is used to
4203 generate a string replacement for each of the @var{name} arguments, and
4204 replace any instances of @var{name} in each macro expansion.  The
4205 replacement string is unique in the assembly, and different for each
4206 separate macro expansion.  @code{LOCAL} allows you to write macros that
4207 define symbols, without fear of conflict between separate macro expansions.
4209 @item String delimiters
4210 You can write strings delimited in these other ways besides
4211 @code{"@var{string}"}:
4213 @table @code
4214 @item '@var{string}'
4215 You can delimit strings with single-quote characters.
4217 @item <@var{string}>
4218 You can delimit strings with matching angle brackets.
4219 @end table
4221 @item single-character string escape
4222 To include any single character literally in a string (even if the
4223 character would otherwise have some special meaning), you can prefix the
4224 character with @samp{!} (an exclamation mark).  For example, you can
4225 write @samp{<4.3 !> 5.4!!>} to get the literal text @samp{4.3 > 5.4!}.
4227 @item Expression results as strings
4228 You can write @samp{%@var{expr}} to evaluate the expression @var{expr}
4229 and use the result as a string.
4230 @end ftable
4232 @node Ascii
4233 @section @code{.ascii "@var{string}"}@dots{}
4235 @cindex @code{ascii} directive
4236 @cindex string literals
4237 @code{.ascii} expects zero or more string literals (@pxref{Strings})
4238 separated by commas.  It assembles each string (with no automatic
4239 trailing zero byte) into consecutive addresses.
4241 @node Asciz
4242 @section @code{.asciz "@var{string}"}@dots{}
4244 @cindex @code{asciz} directive
4245 @cindex zero-terminated strings
4246 @cindex null-terminated strings
4247 @code{.asciz} is just like @code{.ascii}, but each string is followed by
4248 a zero byte.  The ``z'' in @samp{.asciz} stands for ``zero''.
4250 @node Balign
4251 @section @code{.balign[wl] @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
4253 @cindex padding the location counter given number of bytes
4254 @cindex @code{balign} directive
4255 Pad the location counter (in the current subsection) to a particular
4256 storage boundary.  The first expression (which must be absolute) is the
4257 alignment request in bytes.  For example @samp{.balign 8} advances
4258 the location counter until it is a multiple of 8.  If the location counter
4259 is already a multiple of 8, no change is needed.
4261 The second expression (also absolute) gives the fill value to be stored in the
4262 padding bytes.  It (and the comma) may be omitted.  If it is omitted, the
4263 padding bytes are normally zero.  However, on some systems, if the section is
4264 marked as containing code and the fill value is omitted, the space is filled
4265 with no-op instructions.
4267 The third expression is also absolute, and is also optional.  If it is present,
4268 it is the maximum number of bytes that should be skipped by this alignment
4269 directive.  If doing the alignment would require skipping more bytes than the
4270 specified maximum, then the alignment is not done at all.  You can omit the
4271 fill value (the second argument) entirely by simply using two commas after the
4272 required alignment; this can be useful if you want the alignment to be filled
4273 with no-op instructions when appropriate.
4275 @cindex @code{balignw} directive
4276 @cindex @code{balignl} directive
4277 The @code{.balignw} and @code{.balignl} directives are variants of the
4278 @code{.balign} directive.  The @code{.balignw} directive treats the fill
4279 pattern as a two byte word value.  The @code{.balignl} directives treats the
4280 fill pattern as a four byte longword value.  For example, @code{.balignw
4281 4,0x368d} will align to a multiple of 4.  If it skips two bytes, they will be
4282 filled in with the value 0x368d (the exact placement of the bytes depends upon
4283 the endianness of the processor).  If it skips 1 or 3 bytes, the fill value is
4284 undefined.
4286 @node Byte
4287 @section @code{.byte @var{expressions}}
4289 @cindex @code{byte} directive
4290 @cindex integers, one byte
4291 @code{.byte} expects zero or more expressions, separated by commas.
4292 Each expression is assembled into the next byte.
4294 @node CFI directives
4295 @section @code{.cfi_sections @var{section_list}}
4296 @cindex @code{cfi_sections} directive
4297 @code{.cfi_sections} may be used to specify whether CFI directives
4298 should emit @code{.eh_frame} section and/or @code{.debug_frame} section.
4299 If @var{section_list} is @code{.eh_frame}, @code{.eh_frame} is emitted,
4300 if @var{section_list} is @code{.debug_frame}, @code{.debug_frame} is emitted.
4301 To emit both use @code{.eh_frame, .debug_frame}.  The default if this
4302 directive is not used is @code{.cfi_sections .eh_frame}.
4304 @section @code{.cfi_startproc [simple]}
4305 @cindex @code{cfi_startproc} directive
4306 @code{.cfi_startproc} is used at the beginning of each function that
4307 should have an entry in @code{.eh_frame}. It initializes some internal
4308 data structures. Don't forget to close the function by
4309 @code{.cfi_endproc}.
4311 Unless @code{.cfi_startproc} is used along with parameter @code{simple}
4312 it also emits some architecture dependent initial CFI instructions.
4314 @section @code{.cfi_endproc}
4315 @cindex @code{cfi_endproc} directive
4316 @code{.cfi_endproc} is used at the end of a function where it closes its
4317 unwind entry previously opened by
4318 @code{.cfi_startproc}, and emits it to @code{.eh_frame}.
4320 @section @code{.cfi_personality @var{encoding} [, @var{exp}]}
4321 @code{.cfi_personality} defines personality routine and its encoding.
4322 @var{encoding} must be a constant determining how the personality
4323 should be encoded.  If it is 255 (@code{DW_EH_PE_omit}), second
4324 argument is not present, otherwise second argument should be
4325 a constant or a symbol name.  When using indirect encodings,
4326 the symbol provided should be the location where personality
4327 can be loaded from, not the personality routine itself.
4328 The default after @code{.cfi_startproc} is @code{.cfi_personality 0xff},
4329 no personality routine.
4331 @section @code{.cfi_lsda @var{encoding} [, @var{exp}]}
4332 @code{.cfi_lsda} defines LSDA and its encoding.
4333 @var{encoding} must be a constant determining how the LSDA
4334 should be encoded.  If it is 255 (@code{DW_EH_PE_omit}), second
4335 argument is not present, otherwise second argument should be a constant
4336 or a symbol name.  The default after @code{.cfi_startproc} is @code{.cfi_lsda 0xff},
4337 no LSDA.
4339 @section @code{.cfi_def_cfa @var{register}, @var{offset}}
4340 @code{.cfi_def_cfa} defines a rule for computing CFA as: @i{take
4341 address from @var{register} and add @var{offset} to it}.
4343 @section @code{.cfi_def_cfa_register @var{register}}
4344 @code{.cfi_def_cfa_register} modifies a rule for computing CFA. From
4345 now on @var{register} will be used instead of the old one. Offset
4346 remains the same.
4348 @section @code{.cfi_def_cfa_offset @var{offset}}
4349 @code{.cfi_def_cfa_offset} modifies a rule for computing CFA. Register
4350 remains the same, but @var{offset} is new. Note that it is the
4351 absolute offset that will be added to a defined register to compute
4352 CFA address.
4354 @section @code{.cfi_adjust_cfa_offset @var{offset}}
4355 Same as @code{.cfi_def_cfa_offset} but @var{offset} is a relative
4356 value that is added/substracted from the previous offset.
4358 @section @code{.cfi_offset @var{register}, @var{offset}}
4359 Previous value of @var{register} is saved at offset @var{offset} from
4360 CFA.
4362 @section @code{.cfi_rel_offset @var{register}, @var{offset}}
4363 Previous value of @var{register} is saved at offset @var{offset} from
4364 the current CFA register.  This is transformed to @code{.cfi_offset}
4365 using the known displacement of the CFA register from the CFA.
4366 This is often easier to use, because the number will match the
4367 code it's annotating.
4369 @section @code{.cfi_register @var{register1}, @var{register2}}
4370 Previous value of @var{register1} is saved in register @var{register2}.
4372 @section @code{.cfi_restore @var{register}}
4373 @code{.cfi_restore} says that the rule for @var{register} is now the
4374 same as it was at the beginning of the function, after all initial
4375 instruction added by @code{.cfi_startproc} were executed.
4377 @section @code{.cfi_undefined @var{register}}
4378 From now on the previous value of @var{register} can't be restored anymore.
4380 @section @code{.cfi_same_value @var{register}}
4381 Current value of @var{register} is the same like in the previous frame,
4382 i.e. no restoration needed.
4384 @section @code{.cfi_remember_state},
4385 First save all current rules for all registers by @code{.cfi_remember_state},
4386 then totally screw them up by subsequent @code{.cfi_*} directives and when
4387 everything is hopelessly bad, use @code{.cfi_restore_state} to restore
4388 the previous saved state.
4390 @section @code{.cfi_return_column @var{register}}
4391 Change return column @var{register}, i.e. the return address is either
4392 directly in @var{register} or can be accessed by rules for @var{register}.
4394 @section @code{.cfi_signal_frame}
4395 Mark current function as signal trampoline.
4397 @section @code{.cfi_window_save}
4398 SPARC register window has been saved.
4400 @section @code{.cfi_escape} @var{expression}[, @dots{}]
4401 Allows the user to add arbitrary bytes to the unwind info.  One
4402 might use this to add OS-specific CFI opcodes, or generic CFI
4403 opcodes that GAS does not yet support.
4405 @section @code{.cfi_val_encoded_addr @var{register}, @var{encoding}, @var{label}}
4406 The current value of @var{register} is @var{label}.  The value of @var{label}
4407 will be encoded in the output file according to @var{encoding}; see the
4408 description of @code{.cfi_personality} for details on this encoding.
4410 The usefulness of equating a register to a fixed label is probably
4411 limited to the return address register.  Here, it can be useful to
4412 mark a code segment that has only one return address which is reached
4413 by a direct branch and no copy of the return address exists in memory
4414 or another register.
4416 @node Comm
4417 @section @code{.comm @var{symbol} , @var{length} }
4419 @cindex @code{comm} directive
4420 @cindex symbol, common
4421 @code{.comm} declares a common symbol named @var{symbol}.  When linking, a
4422 common symbol in one object file may be merged with a defined or common symbol
4423 of the same name in another object file.  If @code{@value{LD}} does not see a
4424 definition for the symbol--just one or more common symbols--then it will
4425 allocate @var{length} bytes of uninitialized memory.  @var{length} must be an
4426 absolute expression.  If @code{@value{LD}} sees multiple common symbols with
4427 the same name, and they do not all have the same size, it will allocate space
4428 using the largest size.
4430 @ifset COFF-ELF
4431 When using ELF or (as a GNU extension) PE, the @code{.comm} directive takes
4432 an optional third argument.  This is the desired alignment of the symbol,
4433 specified for ELF as a byte boundary (for example, an alignment of 16 means
4434 that the least significant 4 bits of the address should be zero), and for PE
4435 as a power of two (for example, an alignment of 5 means aligned to a 32-byte
4436 boundary).  The alignment must be an absolute expression, and it must be a
4437 power of two.  If @code{@value{LD}} allocates uninitialized memory for the
4438 common symbol, it will use the alignment when placing the symbol.  If no
4439 alignment is specified, @command{@value{AS}} will set the alignment to the
4440 largest power of two less than or equal to the size of the symbol, up to a
4441 maximum of 16 on ELF, or the default section alignment of 4 on PE@footnote{This
4442 is not the same as the executable image file alignment controlled by @code{@value{LD}}'s
4443 @samp{--section-alignment} option; image file sections in PE are aligned to
4444 multiples of 4096, which is far too large an alignment for ordinary variables.
4445 It is rather the default alignment for (non-debug) sections within object
4446 (@samp{*.o}) files, which are less strictly aligned.}.
4447 @end ifset
4449 @ifset HPPA
4450 The syntax for @code{.comm} differs slightly on the HPPA.  The syntax is
4451 @samp{@var{symbol} .comm, @var{length}}; @var{symbol} is optional.
4452 @end ifset
4454 @node Data
4455 @section @code{.data @var{subsection}}
4457 @cindex @code{data} directive
4458 @code{.data} tells @command{@value{AS}} to assemble the following statements onto the
4459 end of the data subsection numbered @var{subsection} (which is an
4460 absolute expression).  If @var{subsection} is omitted, it defaults
4461 to zero.
4463 @ifset COFF
4464 @node Def
4465 @section @code{.def @var{name}}
4467 @cindex @code{def} directive
4468 @cindex COFF symbols, debugging
4469 @cindex debugging COFF symbols
4470 Begin defining debugging information for a symbol @var{name}; the
4471 definition extends until the @code{.endef} directive is encountered.
4472 @ifset BOUT
4474 This directive is only observed when @command{@value{AS}} is configured for COFF
4475 format output; when producing @code{b.out}, @samp{.def} is recognized,
4476 but ignored.
4477 @end ifset
4478 @end ifset
4480 @ifset aout-bout
4481 @node Desc
4482 @section @code{.desc @var{symbol}, @var{abs-expression}}
4484 @cindex @code{desc} directive
4485 @cindex COFF symbol descriptor
4486 @cindex symbol descriptor, COFF
4487 This directive sets the descriptor of the symbol (@pxref{Symbol Attributes})
4488 to the low 16 bits of an absolute expression.
4490 @ifset COFF
4491 The @samp{.desc} directive is not available when @command{@value{AS}} is
4492 configured for COFF output; it is only for @code{a.out} or @code{b.out}
4493 object format.  For the sake of compatibility, @command{@value{AS}} accepts
4494 it, but produces no output, when configured for COFF.
4495 @end ifset
4496 @end ifset
4498 @ifset COFF
4499 @node Dim
4500 @section @code{.dim}
4502 @cindex @code{dim} directive
4503 @cindex COFF auxiliary symbol information
4504 @cindex auxiliary symbol information, COFF
4505 This directive is generated by compilers to include auxiliary debugging
4506 information in the symbol table.  It is only permitted inside
4507 @code{.def}/@code{.endef} pairs.
4508 @ifset BOUT
4510 @samp{.dim} is only meaningful when generating COFF format output; when
4511 @command{@value{AS}} is generating @code{b.out}, it accepts this directive but
4512 ignores it.
4513 @end ifset
4514 @end ifset
4516 @node Double
4517 @section @code{.double @var{flonums}}
4519 @cindex @code{double} directive
4520 @cindex floating point numbers (double)
4521 @code{.double} expects zero or more flonums, separated by commas.  It
4522 assembles floating point numbers.
4523 @ifset GENERIC
4524 The exact kind of floating point numbers emitted depends on how
4525 @command{@value{AS}} is configured.  @xref{Machine Dependencies}.
4526 @end ifset
4527 @ifclear GENERIC
4528 @ifset IEEEFLOAT
4529 On the @value{TARGET} family @samp{.double} emits 64-bit floating-point numbers
4530 in @sc{ieee} format.
4531 @end ifset
4532 @end ifclear
4534 @node Eject
4535 @section @code{.eject}
4537 @cindex @code{eject} directive
4538 @cindex new page, in listings
4539 @cindex page, in listings
4540 @cindex listing control: new page
4541 Force a page break at this point, when generating assembly listings.
4543 @node Else
4544 @section @code{.else}
4546 @cindex @code{else} directive
4547 @code{.else} is part of the @command{@value{AS}} support for conditional
4548 assembly; see @ref{If,,@code{.if}}.  It marks the beginning of a section
4549 of code to be assembled if the condition for the preceding @code{.if}
4550 was false.
4552 @node Elseif
4553 @section @code{.elseif}
4555 @cindex @code{elseif} directive
4556 @code{.elseif} is part of the @command{@value{AS}} support for conditional
4557 assembly; see @ref{If,,@code{.if}}.  It is shorthand for beginning a new
4558 @code{.if} block that would otherwise fill the entire @code{.else} section.
4560 @node End
4561 @section @code{.end}
4563 @cindex @code{end} directive
4564 @code{.end} marks the end of the assembly file.  @command{@value{AS}} does not
4565 process anything in the file past the @code{.end} directive.
4567 @ifset COFF
4568 @node Endef
4569 @section @code{.endef}
4571 @cindex @code{endef} directive
4572 This directive flags the end of a symbol definition begun with
4573 @code{.def}.
4574 @ifset BOUT
4576 @samp{.endef} is only meaningful when generating COFF format output; if
4577 @command{@value{AS}} is configured to generate @code{b.out}, it accepts this
4578 directive but ignores it.
4579 @end ifset
4580 @end ifset
4582 @node Endfunc
4583 @section @code{.endfunc}
4584 @cindex @code{endfunc} directive
4585 @code{.endfunc} marks the end of a function specified with @code{.func}.
4587 @node Endif
4588 @section @code{.endif}
4590 @cindex @code{endif} directive
4591 @code{.endif} is part of the @command{@value{AS}} support for conditional assembly;
4592 it marks the end of a block of code that is only assembled
4593 conditionally.  @xref{If,,@code{.if}}.
4595 @node Equ
4596 @section @code{.equ @var{symbol}, @var{expression}}
4598 @cindex @code{equ} directive
4599 @cindex assigning values to symbols
4600 @cindex symbols, assigning values to
4601 This directive sets the value of @var{symbol} to @var{expression}.
4602 It is synonymous with @samp{.set}; see @ref{Set,,@code{.set}}.
4604 @ifset HPPA
4605 The syntax for @code{equ} on the HPPA is
4606 @samp{@var{symbol} .equ @var{expression}}.
4607 @end ifset
4609 @ifset Z80
4610 The syntax for @code{equ} on the Z80 is
4611 @samp{@var{symbol} equ @var{expression}}.
4612 On the Z80 it is an eror if @var{symbol} is already defined,
4613 but the symbol is not protected from later redefinition.
4614 Compare @ref{Equiv}.
4615 @end ifset
4617 @node Equiv
4618 @section @code{.equiv @var{symbol}, @var{expression}}
4619 @cindex @code{equiv} directive
4620 The @code{.equiv} directive is like @code{.equ} and @code{.set}, except that
4621 the assembler will signal an error if @var{symbol} is already defined.  Note a
4622 symbol which has been referenced but not actually defined is considered to be
4623 undefined.
4625 Except for the contents of the error message, this is roughly equivalent to
4626 @smallexample
4627 .ifdef SYM
4628 .err
4629 .endif
4630 .equ SYM,VAL
4631 @end smallexample
4632 plus it protects the symbol from later redefinition.
4634 @node Eqv
4635 @section @code{.eqv @var{symbol}, @var{expression}}
4636 @cindex @code{eqv} directive
4637 The @code{.eqv} directive is like @code{.equiv}, but no attempt is made to
4638 evaluate the expression or any part of it immediately.  Instead each time
4639 the resulting symbol is used in an expression, a snapshot of its current
4640 value is taken.
4642 @node Err
4643 @section @code{.err}
4644 @cindex @code{err} directive
4645 If @command{@value{AS}} assembles a @code{.err} directive, it will print an error
4646 message and, unless the @option{-Z} option was used, it will not generate an
4647 object file.  This can be used to signal an error in conditionally compiled code.
4649 @node Error
4650 @section @code{.error "@var{string}"}
4651 @cindex error directive
4653 Similarly to @code{.err}, this directive emits an error, but you can specify a
4654 string that will be emitted as the error message.  If you don't specify the
4655 message, it defaults to @code{".error directive invoked in source file"}.
4656 @xref{Errors, ,Error and Warning Messages}.
4658 @smallexample
4659  .error "This code has not been assembled and tested."
4660 @end smallexample
4662 @node Exitm
4663 @section @code{.exitm}
4664 Exit early from the current macro definition.  @xref{Macro}.
4666 @node Extern
4667 @section @code{.extern}
4669 @cindex @code{extern} directive
4670 @code{.extern} is accepted in the source program---for compatibility
4671 with other assemblers---but it is ignored.  @command{@value{AS}} treats
4672 all undefined symbols as external.
4674 @node Fail
4675 @section @code{.fail @var{expression}}
4677 @cindex @code{fail} directive
4678 Generates an error or a warning.  If the value of the @var{expression} is 500
4679 or more, @command{@value{AS}} will print a warning message.  If the value is less
4680 than 500, @command{@value{AS}} will print an error message.  The message will
4681 include the value of @var{expression}.  This can occasionally be useful inside
4682 complex nested macros or conditional assembly.
4684 @node File
4685 @section @code{.file}
4686 @cindex @code{file} directive
4688 @ifclear no-file-dir
4689 There are two different versions of the @code{.file} directive.  Targets
4690 that support DWARF2 line number information use the DWARF2 version of
4691 @code{.file}.  Other targets use the default version.
4693 @subheading Default Version
4695 @cindex logical file name
4696 @cindex file name, logical
4697 This version of the @code{.file} directive tells @command{@value{AS}} that we
4698 are about to start a new logical file.  The syntax is:
4700 @smallexample
4701 .file @var{string}
4702 @end smallexample
4704 @var{string} is the new file name.  In general, the filename is
4705 recognized whether or not it is surrounded by quotes @samp{"}; but if you wish
4706 to specify an empty file name, you must give the quotes--@code{""}.  This
4707 statement may go away in future: it is only recognized to be compatible with
4708 old @command{@value{AS}} programs.
4710 @subheading DWARF2 Version
4711 @end ifclear
4713 When emitting DWARF2 line number information, @code{.file} assigns filenames
4714 to the @code{.debug_line} file name table.  The syntax is:
4716 @smallexample
4717 .file @var{fileno} @var{filename}
4718 @end smallexample
4720 The @var{fileno} operand should be a unique positive integer to use as the
4721 index of the entry in the table.  The @var{filename} operand is a C string
4722 literal.
4724 The detail of filename indices is exposed to the user because the filename
4725 table is shared with the @code{.debug_info} section of the DWARF2 debugging
4726 information, and thus the user must know the exact indices that table
4727 entries will have.
4729 @node Fill
4730 @section @code{.fill @var{repeat} , @var{size} , @var{value}}
4732 @cindex @code{fill} directive
4733 @cindex writing patterns in memory
4734 @cindex patterns, writing in memory
4735 @var{repeat}, @var{size} and @var{value} are absolute expressions.
4736 This emits @var{repeat} copies of @var{size} bytes.  @var{Repeat}
4737 may be zero or more.  @var{Size} may be zero or more, but if it is
4738 more than 8, then it is deemed to have the value 8, compatible with
4739 other people's assemblers.  The contents of each @var{repeat} bytes
4740 is taken from an 8-byte number.  The highest order 4 bytes are
4741 zero.  The lowest order 4 bytes are @var{value} rendered in the
4742 byte-order of an integer on the computer @command{@value{AS}} is assembling for.
4743 Each @var{size} bytes in a repetition is taken from the lowest order
4744 @var{size} bytes of this number.  Again, this bizarre behavior is
4745 compatible with other people's assemblers.
4747 @var{size} and @var{value} are optional.
4748 If the second comma and @var{value} are absent, @var{value} is
4749 assumed zero.  If the first comma and following tokens are absent,
4750 @var{size} is assumed to be 1.
4752 @node Float
4753 @section @code{.float @var{flonums}}
4755 @cindex floating point numbers (single)
4756 @cindex @code{float} directive
4757 This directive assembles zero or more flonums, separated by commas.  It
4758 has the same effect as @code{.single}.
4759 @ifset GENERIC
4760 The exact kind of floating point numbers emitted depends on how
4761 @command{@value{AS}} is configured.
4762 @xref{Machine Dependencies}.
4763 @end ifset
4764 @ifclear GENERIC
4765 @ifset IEEEFLOAT
4766 On the @value{TARGET} family, @code{.float} emits 32-bit floating point numbers
4767 in @sc{ieee} format.
4768 @end ifset
4769 @end ifclear
4771 @node Func
4772 @section @code{.func @var{name}[,@var{label}]}
4773 @cindex @code{func} directive
4774 @code{.func} emits debugging information to denote function @var{name}, and
4775 is ignored unless the file is assembled with debugging enabled.
4776 Only @samp{--gstabs[+]} is currently supported.
4777 @var{label} is the entry point of the function and if omitted @var{name}
4778 prepended with the @samp{leading char} is used.
4779 @samp{leading char} is usually @code{_} or nothing, depending on the target.
4780 All functions are currently defined to have @code{void} return type.
4781 The function must be terminated with @code{.endfunc}.
4783 @node Global
4784 @section @code{.global @var{symbol}}, @code{.globl @var{symbol}}
4786 @cindex @code{global} directive
4787 @cindex symbol, making visible to linker
4788 @code{.global} makes the symbol visible to @code{@value{LD}}.  If you define
4789 @var{symbol} in your partial program, its value is made available to
4790 other partial programs that are linked with it.  Otherwise,
4791 @var{symbol} takes its attributes from a symbol of the same name
4792 from another file linked into the same program.
4794 Both spellings (@samp{.globl} and @samp{.global}) are accepted, for
4795 compatibility with other assemblers.
4797 @ifset HPPA
4798 On the HPPA, @code{.global} is not always enough to make it accessible to other
4799 partial programs.  You may need the HPPA-only @code{.EXPORT} directive as well.
4800 @xref{HPPA Directives, ,HPPA Assembler Directives}.
4801 @end ifset
4803 @ifset ELF
4804 @node Gnu_attribute
4805 @section @code{.gnu_attribute @var{tag},@var{value}}
4806 Record a @sc{gnu} object attribute for this file.  @xref{Object Attributes}.
4808 @node Hidden
4809 @section @code{.hidden @var{names}}
4811 @cindex @code{hidden} directive
4812 @cindex visibility
4813 This is one of the ELF visibility directives.  The other two are
4814 @code{.internal} (@pxref{Internal,,@code{.internal}}) and
4815 @code{.protected} (@pxref{Protected,,@code{.protected}}).
4817 This directive overrides the named symbols default visibility (which is set by
4818 their binding: local, global or weak).  The directive sets the visibility to
4819 @code{hidden} which means that the symbols are not visible to other components.
4820 Such symbols are always considered to be @code{protected} as well.
4821 @end ifset
4823 @node hword
4824 @section @code{.hword @var{expressions}}
4826 @cindex @code{hword} directive
4827 @cindex integers, 16-bit
4828 @cindex numbers, 16-bit
4829 @cindex sixteen bit integers
4830 This expects zero or more @var{expressions}, and emits
4831 a 16 bit number for each.
4833 @ifset GENERIC
4834 This directive is a synonym for @samp{.short}; depending on the target
4835 architecture, it may also be a synonym for @samp{.word}.
4836 @end ifset
4837 @ifclear GENERIC
4838 @ifset W32
4839 This directive is a synonym for @samp{.short}.
4840 @end ifset
4841 @ifset W16
4842 This directive is a synonym for both @samp{.short} and @samp{.word}.
4843 @end ifset
4844 @end ifclear
4846 @node Ident
4847 @section @code{.ident}
4849 @cindex @code{ident} directive
4851 This directive is used by some assemblers to place tags in object files.  The
4852 behavior of this directive varies depending on the target.  When using the
4853 a.out object file format, @command{@value{AS}} simply accepts the directive for
4854 source-file compatibility with existing assemblers, but does not emit anything
4855 for it.  When using COFF, comments are emitted to the @code{.comment} or
4856 @code{.rdata} section, depending on the target.  When using ELF, comments are
4857 emitted to the @code{.comment} section.
4859 @node If
4860 @section @code{.if @var{absolute expression}}
4862 @cindex conditional assembly
4863 @cindex @code{if} directive
4864 @code{.if} marks the beginning of a section of code which is only
4865 considered part of the source program being assembled if the argument
4866 (which must be an @var{absolute expression}) is non-zero.  The end of
4867 the conditional section of code must be marked by @code{.endif}
4868 (@pxref{Endif,,@code{.endif}}); optionally, you may include code for the
4869 alternative condition, flagged by @code{.else} (@pxref{Else,,@code{.else}}).
4870 If you have several conditions to check, @code{.elseif} may be used to avoid
4871 nesting blocks if/else within each subsequent @code{.else} block.
4873 The following variants of @code{.if} are also supported:
4874 @table @code
4875 @cindex @code{ifdef} directive
4876 @item .ifdef @var{symbol}
4877 Assembles the following section of code if the specified @var{symbol}
4878 has been defined.  Note a symbol which has been referenced but not yet defined
4879 is considered to be undefined.
4881 @cindex @code{ifb} directive
4882 @item .ifb @var{text}
4883 Assembles the following section of code if the operand is blank (empty).
4885 @cindex @code{ifc} directive
4886 @item .ifc @var{string1},@var{string2}
4887 Assembles the following section of code if the two strings are the same.  The
4888 strings may be optionally quoted with single quotes.  If they are not quoted,
4889 the first string stops at the first comma, and the second string stops at the
4890 end of the line.  Strings which contain whitespace should be quoted.  The
4891 string comparison is case sensitive.
4893 @cindex @code{ifeq} directive
4894 @item .ifeq @var{absolute expression}
4895 Assembles the following section of code if the argument is zero.
4897 @cindex @code{ifeqs} directive
4898 @item .ifeqs @var{string1},@var{string2}
4899 Another form of @code{.ifc}.  The strings must be quoted using double quotes.
4901 @cindex @code{ifge} directive
4902 @item .ifge @var{absolute expression}
4903 Assembles the following section of code if the argument is greater than or
4904 equal to zero.
4906 @cindex @code{ifgt} directive
4907 @item .ifgt @var{absolute expression}
4908 Assembles the following section of code if the argument is greater than zero.
4910 @cindex @code{ifle} directive
4911 @item .ifle @var{absolute expression}
4912 Assembles the following section of code if the argument is less than or equal
4913 to zero.
4915 @cindex @code{iflt} directive
4916 @item .iflt @var{absolute expression}
4917 Assembles the following section of code if the argument is less than zero.
4919 @cindex @code{ifnb} directive
4920 @item .ifnb @var{text}
4921 Like @code{.ifb}, but the sense of the test is reversed: this assembles the
4922 following section of code if the operand is non-blank (non-empty).
4924 @cindex @code{ifnc} directive
4925 @item .ifnc @var{string1},@var{string2}.
4926 Like @code{.ifc}, but the sense of the test is reversed: this assembles the
4927 following section of code if the two strings are not the same.
4929 @cindex @code{ifndef} directive
4930 @cindex @code{ifnotdef} directive
4931 @item .ifndef @var{symbol}
4932 @itemx .ifnotdef @var{symbol}
4933 Assembles the following section of code if the specified @var{symbol}
4934 has not been defined.  Both spelling variants are equivalent.  Note a symbol
4935 which has been referenced but not yet defined is considered to be undefined.
4937 @cindex @code{ifne} directive
4938 @item .ifne @var{absolute expression}
4939 Assembles the following section of code if the argument is not equal to zero
4940 (in other words, this is equivalent to @code{.if}).
4942 @cindex @code{ifnes} directive
4943 @item .ifnes @var{string1},@var{string2}
4944 Like @code{.ifeqs}, but the sense of the test is reversed: this assembles the
4945 following section of code if the two strings are not the same.
4946 @end table
4948 @node Incbin
4949 @section @code{.incbin "@var{file}"[,@var{skip}[,@var{count}]]}
4951 @cindex @code{incbin} directive
4952 @cindex binary files, including
4953 The @code{incbin} directive includes @var{file} verbatim at the current
4954 location. You can control the search paths used with the @samp{-I} command-line
4955 option (@pxref{Invoking,,Command-Line Options}).  Quotation marks are required
4956 around @var{file}.
4958 The @var{skip} argument skips a number of bytes from the start of the
4959 @var{file}.  The @var{count} argument indicates the maximum number of bytes to
4960 read.  Note that the data is not aligned in any way, so it is the user's
4961 responsibility to make sure that proper alignment is provided both before and
4962 after the @code{incbin} directive.
4964 @node Include
4965 @section @code{.include "@var{file}"}
4967 @cindex @code{include} directive
4968 @cindex supporting files, including
4969 @cindex files, including
4970 This directive provides a way to include supporting files at specified
4971 points in your source program.  The code from @var{file} is assembled as
4972 if it followed the point of the @code{.include}; when the end of the
4973 included file is reached, assembly of the original file continues.  You
4974 can control the search paths used with the @samp{-I} command-line option
4975 (@pxref{Invoking,,Command-Line Options}).  Quotation marks are required
4976 around @var{file}.
4978 @node Int
4979 @section @code{.int @var{expressions}}
4981 @cindex @code{int} directive
4982 @cindex integers, 32-bit
4983 Expect zero or more @var{expressions}, of any section, separated by commas.
4984 For each expression, emit a number that, at run time, is the value of that
4985 expression.  The byte order and bit size of the number depends on what kind
4986 of target the assembly is for.
4988 @ifclear GENERIC
4989 @ifset H8
4990 On most forms of the H8/300, @code{.int} emits 16-bit
4991 integers.  On the H8/300H and the Renesas SH, however, @code{.int} emits
4992 32-bit integers.
4993 @end ifset
4994 @end ifclear
4996 @ifset ELF
4997 @node Internal
4998 @section @code{.internal @var{names}}
5000 @cindex @code{internal} directive
5001 @cindex visibility
5002 This is one of the ELF visibility directives.  The other two are
5003 @code{.hidden} (@pxref{Hidden,,@code{.hidden}}) and
5004 @code{.protected} (@pxref{Protected,,@code{.protected}}).
5006 This directive overrides the named symbols default visibility (which is set by
5007 their binding: local, global or weak).  The directive sets the visibility to
5008 @code{internal} which means that the symbols are considered to be @code{hidden}
5009 (i.e., not visible to other components), and that some extra, processor specific
5010 processing must also be performed upon the  symbols as well.
5011 @end ifset
5013 @node Irp
5014 @section @code{.irp @var{symbol},@var{values}}@dots{}
5016 @cindex @code{irp} directive
5017 Evaluate a sequence of statements assigning different values to @var{symbol}.
5018 The sequence of statements starts at the @code{.irp} directive, and is
5019 terminated by an @code{.endr} directive.  For each @var{value}, @var{symbol} is
5020 set to @var{value}, and the sequence of statements is assembled.  If no
5021 @var{value} is listed, the sequence of statements is assembled once, with
5022 @var{symbol} set to the null string.  To refer to @var{symbol} within the
5023 sequence of statements, use @var{\symbol}.
5025 For example, assembling
5027 @example
5028         .irp    param,1,2,3
5029         move    d\param,sp@@-
5030         .endr
5031 @end example
5033 is equivalent to assembling
5035 @example
5036         move    d1,sp@@-
5037         move    d2,sp@@-
5038         move    d3,sp@@-
5039 @end example
5041 For some caveats with the spelling of @var{symbol}, see also @ref{Macro}.
5043 @node Irpc
5044 @section @code{.irpc @var{symbol},@var{values}}@dots{}
5046 @cindex @code{irpc} directive
5047 Evaluate a sequence of statements assigning different values to @var{symbol}.
5048 The sequence of statements starts at the @code{.irpc} directive, and is
5049 terminated by an @code{.endr} directive.  For each character in @var{value},
5050 @var{symbol} is set to the character, and the sequence of statements is
5051 assembled.  If no @var{value} is listed, the sequence of statements is
5052 assembled once, with @var{symbol} set to the null string.  To refer to
5053 @var{symbol} within the sequence of statements, use @var{\symbol}.
5055 For example, assembling
5057 @example
5058         .irpc    param,123
5059         move    d\param,sp@@-
5060         .endr
5061 @end example
5063 is equivalent to assembling
5065 @example
5066         move    d1,sp@@-
5067         move    d2,sp@@-
5068         move    d3,sp@@-
5069 @end example
5071 For some caveats with the spelling of @var{symbol}, see also the discussion
5072 at @xref{Macro}.
5074 @node Lcomm
5075 @section @code{.lcomm @var{symbol} , @var{length}}
5077 @cindex @code{lcomm} directive
5078 @cindex local common symbols
5079 @cindex symbols, local common
5080 Reserve @var{length} (an absolute expression) bytes for a local common
5081 denoted by @var{symbol}.  The section and value of @var{symbol} are
5082 those of the new local common.  The addresses are allocated in the bss
5083 section, so that at run-time the bytes start off zeroed.  @var{Symbol}
5084 is not declared global (@pxref{Global,,@code{.global}}), so is normally
5085 not visible to @code{@value{LD}}.
5087 @ifset GENERIC
5088 Some targets permit a third argument to be used with @code{.lcomm}.  This
5089 argument specifies the desired alignment of the symbol in the bss section.
5090 @end ifset
5092 @ifset HPPA
5093 The syntax for @code{.lcomm} differs slightly on the HPPA.  The syntax is
5094 @samp{@var{symbol} .lcomm, @var{length}}; @var{symbol} is optional.
5095 @end ifset
5097 @node Lflags
5098 @section @code{.lflags}
5100 @cindex @code{lflags} directive (ignored)
5101 @command{@value{AS}} accepts this directive, for compatibility with other
5102 assemblers, but ignores it.
5104 @ifclear no-line-dir
5105 @node Line
5106 @section @code{.line @var{line-number}}
5108 @cindex @code{line} directive
5109 @cindex logical line number
5110 @ifset aout-bout
5111 Change the logical line number.  @var{line-number} must be an absolute
5112 expression.  The next line has that logical line number.  Therefore any other
5113 statements on the current line (after a statement separator character) are
5114 reported as on logical line number @var{line-number} @minus{} 1.  One day
5115 @command{@value{AS}} will no longer support this directive: it is recognized only
5116 for compatibility with existing assembler programs.
5117 @end ifset
5119 Even though this is a directive associated with the @code{a.out} or
5120 @code{b.out} object-code formats, @command{@value{AS}} still recognizes it
5121 when producing COFF output, and treats @samp{.line} as though it
5122 were the COFF @samp{.ln} @emph{if} it is found outside a
5123 @code{.def}/@code{.endef} pair.
5125 Inside a @code{.def}, @samp{.line} is, instead, one of the directives
5126 used by compilers to generate auxiliary symbol information for
5127 debugging.
5128 @end ifclear
5130 @node Linkonce
5131 @section @code{.linkonce [@var{type}]}
5132 @cindex COMDAT
5133 @cindex @code{linkonce} directive
5134 @cindex common sections
5135 Mark the current section so that the linker only includes a single copy of it.
5136 This may be used to include the same section in several different object files,
5137 but ensure that the linker will only include it once in the final output file.
5138 The @code{.linkonce} pseudo-op must be used for each instance of the section.
5139 Duplicate sections are detected based on the section name, so it should be
5140 unique.
5142 This directive is only supported by a few object file formats; as of this
5143 writing, the only object file format which supports it is the Portable
5144 Executable format used on Windows NT.
5146 The @var{type} argument is optional.  If specified, it must be one of the
5147 following strings.  For example:
5148 @smallexample
5149 .linkonce same_size
5150 @end smallexample
5151 Not all types may be supported on all object file formats.
5153 @table @code
5154 @item discard
5155 Silently discard duplicate sections.  This is the default.
5157 @item one_only
5158 Warn if there are duplicate sections, but still keep only one copy.
5160 @item same_size
5161 Warn if any of the duplicates have different sizes.
5163 @item same_contents
5164 Warn if any of the duplicates do not have exactly the same contents.
5165 @end table
5167 @node List
5168 @section @code{.list}
5170 @cindex @code{list} directive
5171 @cindex listing control, turning on
5172 Control (in conjunction with the @code{.nolist} directive) whether or
5173 not assembly listings are generated.  These two directives maintain an
5174 internal counter (which is zero initially).   @code{.list} increments the
5175 counter, and @code{.nolist} decrements it.  Assembly listings are
5176 generated whenever the counter is greater than zero.
5178 By default, listings are disabled.  When you enable them (with the
5179 @samp{-a} command line option; @pxref{Invoking,,Command-Line Options}),
5180 the initial value of the listing counter is one.
5182 @node Ln
5183 @section @code{.ln @var{line-number}}
5185 @cindex @code{ln} directive
5186 @ifclear no-line-dir
5187 @samp{.ln} is a synonym for @samp{.line}.
5188 @end ifclear
5189 @ifset no-line-dir
5190 Tell @command{@value{AS}} to change the logical line number.  @var{line-number}
5191 must be an absolute expression.  The next line has that logical
5192 line number, so any other statements on the current line (after a
5193 statement separator character @code{;}) are reported as on logical
5194 line number @var{line-number} @minus{} 1.
5195 @ifset BOUT
5197 This directive is accepted, but ignored, when @command{@value{AS}} is
5198 configured for @code{b.out}; its effect is only associated with COFF
5199 output format.
5200 @end ifset
5201 @end ifset
5203 @node Loc
5204 @section @code{.loc @var{fileno} @var{lineno} [@var{column}] [@var{options}]}
5205 @cindex @code{loc} directive
5206 When emitting DWARF2 line number information,
5207 the @code{.loc} directive will add a row to the @code{.debug_line} line
5208 number matrix corresponding to the immediately following assembly
5209 instruction.  The @var{fileno}, @var{lineno}, and optional @var{column}
5210 arguments will be applied to the @code{.debug_line} state machine before
5211 the row is added.
5213 The @var{options} are a sequence of the following tokens in any order:
5215 @table @code
5216 @item basic_block
5217 This option will set the @code{basic_block} register in the
5218 @code{.debug_line} state machine to @code{true}.
5220 @item prologue_end
5221 This option will set the @code{prologue_end} register in the
5222 @code{.debug_line} state machine to @code{true}.
5224 @item epilogue_begin
5225 This option will set the @code{epilogue_begin} register in the
5226 @code{.debug_line} state machine to @code{true}.
5228 @item is_stmt @var{value}
5229 This option will set the @code{is_stmt} register in the
5230 @code{.debug_line} state machine to @code{value}, which must be
5231 either 0 or 1.
5233 @item isa @var{value}
5234 This directive will set the @code{isa} register in the @code{.debug_line}
5235 state machine to @var{value}, which must be an unsigned integer.
5237 @item discriminator @var{value}
5238 This directive will set the @code{discriminator} register in the @code{.debug_line}
5239 state machine to @var{value}, which must be an unsigned integer.
5241 @end table
5243 @node Loc_mark_labels
5244 @section @code{.loc_mark_labels @var{enable}}
5245 @cindex @code{loc_mark_labels} directive
5246 When emitting DWARF2 line number information,
5247 the @code{.loc_mark_labels} directive makes the assembler emit an entry
5248 to the @code{.debug_line} line number matrix with the @code{basic_block}
5249 register in the state machine set whenever a code label is seen.
5250 The @var{enable} argument should be either 1 or 0, to enable or disable
5251 this function respectively.
5253 @ifset ELF
5254 @node Local
5255 @section @code{.local @var{names}}
5257 @cindex @code{local} directive
5258 This directive, which is available for ELF targets, marks each symbol in
5259 the comma-separated list of @code{names} as a local symbol so that it
5260 will not be externally visible.  If the symbols do not already exist,
5261 they will be created.
5263 For targets where the @code{.lcomm} directive (@pxref{Lcomm}) does not
5264 accept an alignment argument, which is the case for most ELF targets,
5265 the @code{.local} directive can be used in combination with @code{.comm}
5266 (@pxref{Comm}) to define aligned local common data.
5267 @end ifset
5269 @node Long
5270 @section @code{.long @var{expressions}}
5272 @cindex @code{long} directive
5273 @code{.long} is the same as @samp{.int}.  @xref{Int,,@code{.int}}.
5275 @ignore
5276 @c no one seems to know what this is for or whether this description is
5277 @c what it really ought to do
5278 @node Lsym
5279 @section @code{.lsym @var{symbol}, @var{expression}}
5281 @cindex @code{lsym} directive
5282 @cindex symbol, not referenced in assembly
5283 @code{.lsym} creates a new symbol named @var{symbol}, but does not put it in
5284 the hash table, ensuring it cannot be referenced by name during the
5285 rest of the assembly.  This sets the attributes of the symbol to be
5286 the same as the expression value:
5287 @smallexample
5288 @var{other} = @var{descriptor} = 0
5289 @var{type} = @r{(section of @var{expression})}
5290 @var{value} = @var{expression}
5291 @end smallexample
5292 @noindent
5293 The new symbol is not flagged as external.
5294 @end ignore
5296 @node Macro
5297 @section @code{.macro}
5299 @cindex macros
5300 The commands @code{.macro} and @code{.endm} allow you to define macros that
5301 generate assembly output.  For example, this definition specifies a macro
5302 @code{sum} that puts a sequence of numbers into memory:
5304 @example
5305         .macro  sum from=0, to=5
5306         .long   \from
5307         .if     \to-\from
5308         sum     "(\from+1)",\to
5309         .endif
5310         .endm
5311 @end example
5313 @noindent
5314 With that definition, @samp{SUM 0,5} is equivalent to this assembly input:
5316 @example
5317         .long   0
5318         .long   1
5319         .long   2
5320         .long   3
5321         .long   4
5322         .long   5
5323 @end example
5325 @ftable @code
5326 @item .macro @var{macname}
5327 @itemx .macro @var{macname} @var{macargs} @dots{}
5328 @cindex @code{macro} directive
5329 Begin the definition of a macro called @var{macname}.  If your macro
5330 definition requires arguments, specify their names after the macro name,
5331 separated by commas or spaces.  You can qualify the macro argument to
5332 indicate whether all invocations must specify a non-blank value (through
5333 @samp{:@code{req}}), or whether it takes all of the remaining arguments
5334 (through @samp{:@code{vararg}}).  You can supply a default value for any
5335 macro argument by following the name with @samp{=@var{deflt}}.  You
5336 cannot define two macros with the same @var{macname} unless it has been
5337 subject to the @code{.purgem} directive (@pxref{Purgem}) between the two
5338 definitions.  For example, these are all valid @code{.macro} statements:
5340 @table @code
5341 @item .macro comm
5342 Begin the definition of a macro called @code{comm}, which takes no
5343 arguments.
5345 @item  .macro plus1 p, p1
5346 @itemx .macro plus1 p p1
5347 Either statement begins the definition of a macro called @code{plus1},
5348 which takes two arguments; within the macro definition, write
5349 @samp{\p} or @samp{\p1} to evaluate the arguments.
5351 @item .macro reserve_str p1=0 p2
5352 Begin the definition of a macro called @code{reserve_str}, with two
5353 arguments.  The first argument has a default value, but not the second.
5354 After the definition is complete, you can call the macro either as
5355 @samp{reserve_str @var{a},@var{b}} (with @samp{\p1} evaluating to
5356 @var{a} and @samp{\p2} evaluating to @var{b}), or as @samp{reserve_str
5357 ,@var{b}} (with @samp{\p1} evaluating as the default, in this case
5358 @samp{0}, and @samp{\p2} evaluating to @var{b}).
5360 @item .macro m p1:req, p2=0, p3:vararg
5361 Begin the definition of a macro called @code{m}, with at least three
5362 arguments.  The first argument must always have a value specified, but
5363 not the second, which instead has a default value. The third formal
5364 will get assigned all remaining arguments specified at invocation time.
5366 When you call a macro, you can specify the argument values either by
5367 position, or by keyword.  For example, @samp{sum 9,17} is equivalent to
5368 @samp{sum to=17, from=9}.
5370 @end table
5372 Note that since each of the @var{macargs} can be an identifier exactly
5373 as any other one permitted by the target architecture, there may be
5374 occasional problems if the target hand-crafts special meanings to certain
5375 characters when they occur in a special position.  For example, if the colon
5376 (@code{:}) is generally permitted to be part of a symbol name, but the
5377 architecture specific code special-cases it when occurring as the final
5378 character of a symbol (to denote a label), then the macro parameter
5379 replacement code will have no way of knowing that and consider the whole
5380 construct (including the colon) an identifier, and check only this
5381 identifier for being the subject to parameter substitution.  So for example
5382 this macro definition:
5384 @example
5385         .macro label l
5387         .endm
5388 @end example
5390 might not work as expected.  Invoking @samp{label foo} might not create a label
5391 called @samp{foo} but instead just insert the text @samp{\l:} into the
5392 assembler source, probably generating an error about an unrecognised
5393 identifier.
5395 Similarly problems might occur with the period character (@samp{.})
5396 which is often allowed inside opcode names (and hence identifier names).  So
5397 for example constructing a macro to build an opcode from a base name and a
5398 length specifier like this:
5400 @example
5401         .macro opcode base length
5402         \base.\length
5403         .endm
5404 @end example
5406 and invoking it as @samp{opcode store l} will not create a @samp{store.l}
5407 instruction but instead generate some kind of error as the assembler tries to
5408 interpret the text @samp{\base.\length}.
5410 There are several possible ways around this problem:
5412 @table @code
5413 @item Insert white space
5414 If it is possible to use white space characters then this is the simplest
5415 solution.  eg:
5417 @example
5418         .macro label l
5419 \l :
5420         .endm
5421 @end example
5423 @item Use @samp{\()}
5424 The string @samp{\()} can be used to separate the end of a macro argument from
5425 the following text.  eg:
5427 @example
5428         .macro opcode base length
5429         \base\().\length
5430         .endm
5431 @end example
5433 @item Use the alternate macro syntax mode
5434 In the alternative macro syntax mode the ampersand character (@samp{&}) can be
5435 used as a separator.  eg:
5437 @example
5438         .altmacro
5439         .macro label l
5441         .endm
5442 @end example
5443 @end table
5445 Note: this problem of correctly identifying string parameters to pseudo ops
5446 also applies to the identifiers used in @code{.irp} (@pxref{Irp})
5447 and @code{.irpc} (@pxref{Irpc}) as well.
5449 @item .endm
5450 @cindex @code{endm} directive
5451 Mark the end of a macro definition.
5453 @item .exitm
5454 @cindex @code{exitm} directive
5455 Exit early from the current macro definition.
5457 @cindex number of macros executed
5458 @cindex macros, count executed
5459 @item \@@
5460 @command{@value{AS}} maintains a counter of how many macros it has
5461 executed in this pseudo-variable; you can copy that number to your
5462 output with @samp{\@@}, but @emph{only within a macro definition}.
5464 @item LOCAL @var{name} [ , @dots{} ]
5465 @emph{Warning: @code{LOCAL} is only available if you select ``alternate
5466 macro syntax'' with @samp{--alternate} or @code{.altmacro}.}
5467 @xref{Altmacro,,@code{.altmacro}}.
5468 @end ftable
5470 @node MRI
5471 @section @code{.mri @var{val}}
5473 @cindex @code{mri} directive
5474 @cindex MRI mode, temporarily
5475 If @var{val} is non-zero, this tells @command{@value{AS}} to enter MRI mode.  If
5476 @var{val} is zero, this tells @command{@value{AS}} to exit MRI mode.  This change
5477 affects code assembled until the next @code{.mri} directive, or until the end
5478 of the file.  @xref{M, MRI mode, MRI mode}.
5480 @node Noaltmacro
5481 @section @code{.noaltmacro}
5482 Disable alternate macro mode.  @xref{Altmacro}.
5484 @node Nolist
5485 @section @code{.nolist}
5487 @cindex @code{nolist} directive
5488 @cindex listing control, turning off
5489 Control (in conjunction with the @code{.list} directive) whether or
5490 not assembly listings are generated.  These two directives maintain an
5491 internal counter (which is zero initially).   @code{.list} increments the
5492 counter, and @code{.nolist} decrements it.  Assembly listings are
5493 generated whenever the counter is greater than zero.
5495 @node Octa
5496 @section @code{.octa @var{bignums}}
5498 @c FIXME: double size emitted for "octa" on i960, others?  Or warn?
5499 @cindex @code{octa} directive
5500 @cindex integer, 16-byte
5501 @cindex sixteen byte integer
5502 This directive expects zero or more bignums, separated by commas.  For each
5503 bignum, it emits a 16-byte integer.
5505 The term ``octa'' comes from contexts in which a ``word'' is two bytes;
5506 hence @emph{octa}-word for 16 bytes.
5508 @node Org
5509 @section @code{.org @var{new-lc} , @var{fill}}
5511 @cindex @code{org} directive
5512 @cindex location counter, advancing
5513 @cindex advancing location counter
5514 @cindex current address, advancing
5515 Advance the location counter of the current section to
5516 @var{new-lc}.  @var{new-lc} is either an absolute expression or an
5517 expression with the same section as the current subsection.  That is,
5518 you can't use @code{.org} to cross sections: if @var{new-lc} has the
5519 wrong section, the @code{.org} directive is ignored.  To be compatible
5520 with former assemblers, if the section of @var{new-lc} is absolute,
5521 @command{@value{AS}} issues a warning, then pretends the section of @var{new-lc}
5522 is the same as the current subsection.
5524 @code{.org} may only increase the location counter, or leave it
5525 unchanged; you cannot use @code{.org} to move the location counter
5526 backwards.
5528 @c double negative used below "not undefined" because this is a specific
5529 @c reference to "undefined" (as SEG_UNKNOWN is called in this manual)
5530 @c section. doc@cygnus.com 18feb91
5531 Because @command{@value{AS}} tries to assemble programs in one pass, @var{new-lc}
5532 may not be undefined.  If you really detest this restriction we eagerly await
5533 a chance to share your improved assembler.
5535 Beware that the origin is relative to the start of the section, not
5536 to the start of the subsection.  This is compatible with other
5537 people's assemblers.
5539 When the location counter (of the current subsection) is advanced, the
5540 intervening bytes are filled with @var{fill} which should be an
5541 absolute expression.  If the comma and @var{fill} are omitted,
5542 @var{fill} defaults to zero.
5544 @node P2align
5545 @section @code{.p2align[wl] @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
5547 @cindex padding the location counter given a power of two
5548 @cindex @code{p2align} directive
5549 Pad the location counter (in the current subsection) to a particular
5550 storage boundary.  The first expression (which must be absolute) is the
5551 number of low-order zero bits the location counter must have after
5552 advancement.  For example @samp{.p2align 3} advances the location
5553 counter until it a multiple of 8.  If the location counter is already a
5554 multiple of 8, no change is needed.
5556 The second expression (also absolute) gives the fill value to be stored in the
5557 padding bytes.  It (and the comma) may be omitted.  If it is omitted, the
5558 padding bytes are normally zero.  However, on some systems, if the section is
5559 marked as containing code and the fill value is omitted, the space is filled
5560 with no-op instructions.
5562 The third expression is also absolute, and is also optional.  If it is present,
5563 it is the maximum number of bytes that should be skipped by this alignment
5564 directive.  If doing the alignment would require skipping more bytes than the
5565 specified maximum, then the alignment is not done at all.  You can omit the
5566 fill value (the second argument) entirely by simply using two commas after the
5567 required alignment; this can be useful if you want the alignment to be filled
5568 with no-op instructions when appropriate.
5570 @cindex @code{p2alignw} directive
5571 @cindex @code{p2alignl} directive
5572 The @code{.p2alignw} and @code{.p2alignl} directives are variants of the
5573 @code{.p2align} directive.  The @code{.p2alignw} directive treats the fill
5574 pattern as a two byte word value.  The @code{.p2alignl} directives treats the
5575 fill pattern as a four byte longword value.  For example, @code{.p2alignw
5576 2,0x368d} will align to a multiple of 4.  If it skips two bytes, they will be
5577 filled in with the value 0x368d (the exact placement of the bytes depends upon
5578 the endianness of the processor).  If it skips 1 or 3 bytes, the fill value is
5579 undefined.
5581 @ifset ELF
5582 @node PopSection
5583 @section @code{.popsection}
5585 @cindex @code{popsection} directive
5586 @cindex Section Stack
5587 This is one of the ELF section stack manipulation directives.  The others are
5588 @code{.section} (@pxref{Section}), @code{.subsection} (@pxref{SubSection}),
5589 @code{.pushsection} (@pxref{PushSection}), and @code{.previous}
5590 (@pxref{Previous}).
5592 This directive replaces the current section (and subsection) with the top
5593 section (and subsection) on the section stack.  This section is popped off the
5594 stack.
5595 @end ifset
5597 @ifset ELF
5598 @node Previous
5599 @section @code{.previous}
5601 @cindex @code{previous} directive
5602 @cindex Section Stack
5603 This is one of the ELF section stack manipulation directives.  The others are
5604 @code{.section} (@pxref{Section}), @code{.subsection} (@pxref{SubSection}),
5605 @code{.pushsection} (@pxref{PushSection}), and @code{.popsection}
5606 (@pxref{PopSection}).
5608 This directive swaps the current section (and subsection) with most recently
5609 referenced section/subsection pair prior to this one.  Multiple
5610 @code{.previous} directives in a row will flip between two sections (and their
5611 subsections).  For example:
5613 @smallexample
5614 .section A
5615  .subsection 1
5616   .word 0x1234
5617  .subsection 2
5618   .word 0x5678
5619 .previous
5620  .word 0x9abc
5621 @end smallexample
5623 Will place 0x1234 and 0x9abc into subsection 1 and 0x5678 into subsection 2 of
5624 section A.  Whilst:
5626 @smallexample
5627 .section A
5628 .subsection 1
5629   # Now in section A subsection 1
5630   .word 0x1234
5631 .section B
5632 .subsection 0
5633   # Now in section B subsection 0
5634   .word 0x5678
5635 .subsection 1
5636   # Now in section B subsection 1
5637   .word 0x9abc
5638 .previous
5639   # Now in section B subsection 0
5640   .word 0xdef0
5641 @end smallexample
5643 Will place 0x1234 into section A, 0x5678 and 0xdef0 into subsection 0 of
5644 section B and 0x9abc into subsection 1 of section B.
5646 In terms of the section stack, this directive swaps the current section with
5647 the top section on the section stack.
5648 @end ifset
5650 @node Print
5651 @section @code{.print @var{string}}
5653 @cindex @code{print} directive
5654 @command{@value{AS}} will print @var{string} on the standard output during
5655 assembly.  You must put @var{string} in double quotes.
5657 @ifset ELF
5658 @node Protected
5659 @section @code{.protected @var{names}}
5661 @cindex @code{protected} directive
5662 @cindex visibility
5663 This is one of the ELF visibility directives.  The other two are
5664 @code{.hidden} (@pxref{Hidden}) and @code{.internal} (@pxref{Internal}).
5666 This directive overrides the named symbols default visibility (which is set by
5667 their binding: local, global or weak).  The directive sets the visibility to
5668 @code{protected} which means that any references to the symbols from within the
5669 components that defines them must be resolved to the definition in that
5670 component, even if a definition in another component would normally preempt
5671 this.
5672 @end ifset
5674 @node Psize
5675 @section @code{.psize @var{lines} , @var{columns}}
5677 @cindex @code{psize} directive
5678 @cindex listing control: paper size
5679 @cindex paper size, for listings
5680 Use this directive to declare the number of lines---and, optionally, the
5681 number of columns---to use for each page, when generating listings.
5683 If you do not use @code{.psize}, listings use a default line-count
5684 of 60.  You may omit the comma and @var{columns} specification; the
5685 default width is 200 columns.
5687 @command{@value{AS}} generates formfeeds whenever the specified number of
5688 lines is exceeded (or whenever you explicitly request one, using
5689 @code{.eject}).
5691 If you specify @var{lines} as @code{0}, no formfeeds are generated save
5692 those explicitly specified with @code{.eject}.
5694 @node Purgem
5695 @section @code{.purgem @var{name}}
5697 @cindex @code{purgem} directive
5698 Undefine the macro @var{name}, so that later uses of the string will not be
5699 expanded.  @xref{Macro}.
5701 @ifset ELF
5702 @node PushSection
5703 @section @code{.pushsection @var{name} [, @var{subsection}] [, "@var{flags}"[, @@@var{type}[,@var{arguments}]]]}
5705 @cindex @code{pushsection} directive
5706 @cindex Section Stack
5707 This is one of the ELF section stack manipulation directives.  The others are
5708 @code{.section} (@pxref{Section}), @code{.subsection} (@pxref{SubSection}),
5709 @code{.popsection} (@pxref{PopSection}), and @code{.previous}
5710 (@pxref{Previous}).
5712 This directive pushes the current section (and subsection) onto the
5713 top of the section stack, and then replaces the current section and
5714 subsection with @code{name} and @code{subsection}. The optional
5715 @code{flags}, @code{type} and @code{arguments} are treated the same
5716 as in the @code{.section} (@pxref{Section}) directive.
5717 @end ifset
5719 @node Quad
5720 @section @code{.quad @var{bignums}}
5722 @cindex @code{quad} directive
5723 @code{.quad} expects zero or more bignums, separated by commas.  For
5724 each bignum, it emits
5725 @ifclear bignum-16
5726 an 8-byte integer.  If the bignum won't fit in 8 bytes, it prints a
5727 warning message; and just takes the lowest order 8 bytes of the bignum.
5728 @cindex eight-byte integer
5729 @cindex integer, 8-byte
5731 The term ``quad'' comes from contexts in which a ``word'' is two bytes;
5732 hence @emph{quad}-word for 8 bytes.
5733 @end ifclear
5734 @ifset bignum-16
5735 a 16-byte integer.  If the bignum won't fit in 16 bytes, it prints a
5736 warning message; and just takes the lowest order 16 bytes of the bignum.
5737 @cindex sixteen-byte integer
5738 @cindex integer, 16-byte
5739 @end ifset
5741 @node Reloc
5742 @section @code{.reloc @var{offset}, @var{reloc_name}[, @var{expression}]}
5744 @cindex @code{reloc} directive
5745 Generate a relocation at @var{offset} of type @var{reloc_name} with value
5746 @var{expression}.  If @var{offset} is a number, the relocation is generated in
5747 the current section.  If @var{offset} is an expression that resolves to a
5748 symbol plus offset, the relocation is generated in the given symbol's section.
5749 @var{expression}, if present, must resolve to a symbol plus addend or to an
5750 absolute value, but note that not all targets support an addend.  e.g. ELF REL
5751 targets such as i386 store an addend in the section contents rather than in the
5752 relocation.  This low level interface does not support addends stored in the
5753 section.
5755 @node Rept
5756 @section @code{.rept @var{count}}
5758 @cindex @code{rept} directive
5759 Repeat the sequence of lines between the @code{.rept} directive and the next
5760 @code{.endr} directive @var{count} times.
5762 For example, assembling
5764 @example
5765         .rept   3
5766         .long   0
5767         .endr
5768 @end example
5770 is equivalent to assembling
5772 @example
5773         .long   0
5774         .long   0
5775         .long   0
5776 @end example
5778 @node Sbttl
5779 @section @code{.sbttl "@var{subheading}"}
5781 @cindex @code{sbttl} directive
5782 @cindex subtitles for listings
5783 @cindex listing control: subtitle
5784 Use @var{subheading} as the title (third line, immediately after the
5785 title line) when generating assembly listings.
5787 This directive affects subsequent pages, as well as the current page if
5788 it appears within ten lines of the top of a page.
5790 @ifset COFF
5791 @node Scl
5792 @section @code{.scl @var{class}}
5794 @cindex @code{scl} directive
5795 @cindex symbol storage class (COFF)
5796 @cindex COFF symbol storage class
5797 Set the storage-class value for a symbol.  This directive may only be
5798 used inside a @code{.def}/@code{.endef} pair.  Storage class may flag
5799 whether a symbol is static or external, or it may record further
5800 symbolic debugging information.
5801 @ifset BOUT
5803 The @samp{.scl} directive is primarily associated with COFF output; when
5804 configured to generate @code{b.out} output format, @command{@value{AS}}
5805 accepts this directive but ignores it.
5806 @end ifset
5807 @end ifset
5809 @ifset COFF-ELF
5810 @node Section
5811 @section @code{.section @var{name}}
5813 @cindex named section
5814 Use the @code{.section} directive to assemble the following code into a section
5815 named @var{name}.
5817 This directive is only supported for targets that actually support arbitrarily
5818 named sections; on @code{a.out} targets, for example, it is not accepted, even
5819 with a standard @code{a.out} section name.
5821 @ifset COFF
5822 @ifset ELF
5823 @c only print the extra heading if both COFF and ELF are set
5824 @subheading COFF Version
5825 @end ifset
5827 @cindex @code{section} directive (COFF version)
5828 For COFF targets, the @code{.section} directive is used in one of the following
5829 ways:
5831 @smallexample
5832 .section @var{name}[, "@var{flags}"]
5833 .section @var{name}[, @var{subsection}]
5834 @end smallexample
5836 If the optional argument is quoted, it is taken as flags to use for the
5837 section.  Each flag is a single character.  The following flags are recognized:
5838 @table @code
5839 @item b
5840 bss section (uninitialized data)
5841 @item n
5842 section is not loaded
5843 @item w
5844 writable section
5845 @item d
5846 data section
5847 @item r
5848 read-only section
5849 @item x
5850 executable section
5851 @item s
5852 shared section (meaningful for PE targets)
5853 @item a
5854 ignored.  (For compatibility with the ELF version)
5855 @item y
5856 section is not readable (meaningful for PE targets)
5857 @item 0-9
5858 single-digit power-of-two section alignment (GNU extension)
5859 @end table
5861 If no flags are specified, the default flags depend upon the section name.  If
5862 the section name is not recognized, the default will be for the section to be
5863 loaded and writable.  Note the @code{n} and @code{w} flags remove attributes
5864 from the section, rather than adding them, so if they are used on their own it
5865 will be as if no flags had been specified at all.
5867 If the optional argument to the @code{.section} directive is not quoted, it is
5868 taken as a subsection number (@pxref{Sub-Sections}).
5869 @end ifset
5871 @ifset ELF
5872 @ifset COFF
5873 @c only print the extra heading if both COFF and ELF are set
5874 @subheading ELF Version
5875 @end ifset
5877 @cindex Section Stack
5878 This is one of the ELF section stack manipulation directives.  The others are
5879 @code{.subsection} (@pxref{SubSection}), @code{.pushsection}
5880 (@pxref{PushSection}), @code{.popsection} (@pxref{PopSection}), and
5881 @code{.previous} (@pxref{Previous}).
5883 @cindex @code{section} directive (ELF version)
5884 For ELF targets, the @code{.section} directive is used like this:
5886 @smallexample
5887 .section @var{name} [, "@var{flags}"[, @@@var{type}[,@var{flag_specific_arguments}]]]
5888 @end smallexample
5890 The optional @var{flags} argument is a quoted string which may contain any
5891 combination of the following characters:
5892 @table @code
5893 @item a
5894 section is allocatable
5895 @item e
5896 section is excluded from executable and shared library.
5897 @item w
5898 section is writable
5899 @item x
5900 section is executable
5901 @item M
5902 section is mergeable
5903 @item S
5904 section contains zero terminated strings
5905 @item G
5906 section is a member of a section group
5907 @item T
5908 section is used for thread-local-storage
5909 @item ?
5910 section is a member of the previously-current section's group, if any
5911 @end table
5913 The optional @var{type} argument may contain one of the following constants:
5914 @table @code
5915 @item @@progbits
5916 section contains data
5917 @item @@nobits
5918 section does not contain data (i.e., section only occupies space)
5919 @item @@note
5920 section contains data which is used by things other than the program
5921 @item @@init_array
5922 section contains an array of pointers to init functions
5923 @item @@fini_array
5924 section contains an array of pointers to finish functions
5925 @item @@preinit_array
5926 section contains an array of pointers to pre-init functions
5927 @end table
5929 Many targets only support the first three section types.
5931 Note on targets where the @code{@@} character is the start of a comment (eg
5932 ARM) then another character is used instead.  For example the ARM port uses the
5933 @code{%} character.
5935 If @var{flags} contains the @code{M} symbol then the @var{type} argument must
5936 be specified as well as an extra argument---@var{entsize}---like this:
5938 @smallexample
5939 .section @var{name} , "@var{flags}"M, @@@var{type}, @var{entsize}
5940 @end smallexample
5942 Sections with the @code{M} flag but not @code{S} flag must contain fixed size
5943 constants, each @var{entsize} octets long. Sections with both @code{M} and
5944 @code{S} must contain zero terminated strings where each character is
5945 @var{entsize} bytes long. The linker may remove duplicates within sections with
5946 the same name, same entity size and same flags.  @var{entsize} must be an
5947 absolute expression.  For sections with both @code{M} and @code{S}, a string
5948 which is a suffix of a larger string is considered a duplicate.  Thus
5949 @code{"def"} will be merged with @code{"abcdef"};  A reference to the first
5950 @code{"def"} will be changed to a reference to @code{"abcdef"+3}.
5952 If @var{flags} contains the @code{G} symbol then the @var{type} argument must
5953 be present along with an additional field like this:
5955 @smallexample
5956 .section @var{name} , "@var{flags}"G, @@@var{type}, @var{GroupName}[, @var{linkage}]
5957 @end smallexample
5959 The @var{GroupName} field specifies the name of the section group to which this
5960 particular section belongs.  The optional linkage field can contain:
5961 @table @code
5962 @item comdat
5963 indicates that only one copy of this section should be retained
5964 @item .gnu.linkonce
5965 an alias for comdat
5966 @end table
5968 Note: if both the @var{M} and @var{G} flags are present then the fields for
5969 the Merge flag should come first, like this:
5971 @smallexample
5972 .section @var{name} , "@var{flags}"MG, @@@var{type}, @var{entsize}, @var{GroupName}[, @var{linkage}]
5973 @end smallexample
5975 If @var{flags} contains the @code{?} symbol then it may not also contain the
5976 @code{G} symbol and the @var{GroupName} or @var{linkage} fields should not be
5977 present.  Instead, @code{?} says to consider the section that's current before
5978 this directive.  If that section used @code{G}, then the new section will use
5979 @code{G} with those same @var{GroupName} and @var{linkage} fields implicitly.
5980 If not, then the @code{?} symbol has no effect.
5982 If no flags are specified, the default flags depend upon the section name.  If
5983 the section name is not recognized, the default will be for the section to have
5984 none of the above flags: it will not be allocated in memory, nor writable, nor
5985 executable.  The section will contain data.
5987 For ELF targets, the assembler supports another type of @code{.section}
5988 directive for compatibility with the Solaris assembler:
5990 @smallexample
5991 .section "@var{name}"[, @var{flags}...]
5992 @end smallexample
5994 Note that the section name is quoted.  There may be a sequence of comma
5995 separated flags:
5996 @table @code
5997 @item #alloc
5998 section is allocatable
5999 @item #write
6000 section is writable
6001 @item #execinstr
6002 section is executable
6003 @item #exclude
6004 section is excluded from executable and shared library.
6005 @item #tls
6006 section is used for thread local storage
6007 @end table
6009 This directive replaces the current section and subsection.  See the
6010 contents of the gas testsuite directory @code{gas/testsuite/gas/elf} for
6011 some examples of how this directive and the other section stack directives
6012 work.
6013 @end ifset
6014 @end ifset
6016 @node Set
6017 @section @code{.set @var{symbol}, @var{expression}}
6019 @cindex @code{set} directive
6020 @cindex symbol value, setting
6021 Set the value of @var{symbol} to @var{expression}.  This
6022 changes @var{symbol}'s value and type to conform to
6023 @var{expression}.  If @var{symbol} was flagged as external, it remains
6024 flagged (@pxref{Symbol Attributes}).
6026 You may @code{.set} a symbol many times in the same assembly.
6028 If you @code{.set} a global symbol, the value stored in the object
6029 file is the last value stored into it.
6031 @ifset Z80
6032 On Z80 @code{set} is a real instruction, use
6033 @samp{@var{symbol} defl @var{expression}} instead.
6034 @end ifset
6036 @node Short
6037 @section @code{.short @var{expressions}}
6039 @cindex @code{short} directive
6040 @ifset GENERIC
6041 @code{.short} is normally the same as @samp{.word}.
6042 @xref{Word,,@code{.word}}.
6044 In some configurations, however, @code{.short} and @code{.word} generate
6045 numbers of different lengths.  @xref{Machine Dependencies}.
6046 @end ifset
6047 @ifclear GENERIC
6048 @ifset W16
6049 @code{.short} is the same as @samp{.word}.  @xref{Word,,@code{.word}}.
6050 @end ifset
6051 @ifset W32
6052 This expects zero or more @var{expressions}, and emits
6053 a 16 bit number for each.
6054 @end ifset
6055 @end ifclear
6057 @node Single
6058 @section @code{.single @var{flonums}}
6060 @cindex @code{single} directive
6061 @cindex floating point numbers (single)
6062 This directive assembles zero or more flonums, separated by commas.  It
6063 has the same effect as @code{.float}.
6064 @ifset GENERIC
6065 The exact kind of floating point numbers emitted depends on how
6066 @command{@value{AS}} is configured.  @xref{Machine Dependencies}.
6067 @end ifset
6068 @ifclear GENERIC
6069 @ifset IEEEFLOAT
6070 On the @value{TARGET} family, @code{.single} emits 32-bit floating point
6071 numbers in @sc{ieee} format.
6072 @end ifset
6073 @end ifclear
6075 @ifset COFF-ELF
6076 @node Size
6077 @section @code{.size}
6079 This directive is used to set the size associated with a symbol.
6081 @ifset COFF
6082 @ifset ELF
6083 @c only print the extra heading if both COFF and ELF are set
6084 @subheading COFF Version
6085 @end ifset
6087 @cindex @code{size} directive (COFF version)
6088 For COFF targets, the @code{.size} directive is only permitted inside
6089 @code{.def}/@code{.endef} pairs.  It is used like this:
6091 @smallexample
6092 .size @var{expression}
6093 @end smallexample
6095 @ifset BOUT
6096 @samp{.size} is only meaningful when generating COFF format output; when
6097 @command{@value{AS}} is generating @code{b.out}, it accepts this directive but
6098 ignores it.
6099 @end ifset
6100 @end ifset
6102 @ifset ELF
6103 @ifset COFF
6104 @c only print the extra heading if both COFF and ELF are set
6105 @subheading ELF Version
6106 @end ifset
6108 @cindex @code{size} directive (ELF version)
6109 For ELF targets, the @code{.size} directive is used like this:
6111 @smallexample
6112 .size @var{name} , @var{expression}
6113 @end smallexample
6115 This directive sets the size associated with a symbol @var{name}.
6116 The size in bytes is computed from @var{expression} which can make use of label
6117 arithmetic.  This directive is typically used to set the size of function
6118 symbols.
6119 @end ifset
6120 @end ifset
6122 @ifclear no-space-dir
6123 @node Skip
6124 @section @code{.skip @var{size} , @var{fill}}
6126 @cindex @code{skip} directive
6127 @cindex filling memory
6128 This directive emits @var{size} bytes, each of value @var{fill}.  Both
6129 @var{size} and @var{fill} are absolute expressions.  If the comma and
6130 @var{fill} are omitted, @var{fill} is assumed to be zero.  This is the same as
6131 @samp{.space}.
6132 @end ifclear
6134 @node Sleb128
6135 @section @code{.sleb128 @var{expressions}}
6137 @cindex @code{sleb128} directive
6138 @var{sleb128} stands for ``signed little endian base 128.''  This is a
6139 compact, variable length representation of numbers used by the DWARF
6140 symbolic debugging format.  @xref{Uleb128, ,@code{.uleb128}}.
6142 @ifclear no-space-dir
6143 @node Space
6144 @section @code{.space @var{size} , @var{fill}}
6146 @cindex @code{space} directive
6147 @cindex filling memory
6148 This directive emits @var{size} bytes, each of value @var{fill}.  Both
6149 @var{size} and @var{fill} are absolute expressions.  If the comma
6150 and @var{fill} are omitted, @var{fill} is assumed to be zero.  This is the same
6151 as @samp{.skip}.
6153 @ifset HPPA
6154 @quotation
6155 @emph{Warning:} @code{.space} has a completely different meaning for HPPA
6156 targets; use @code{.block} as a substitute.  See @cite{HP9000 Series 800
6157 Assembly Language Reference Manual} (HP 92432-90001) for the meaning of the
6158 @code{.space} directive.  @xref{HPPA Directives,,HPPA Assembler Directives},
6159 for a summary.
6160 @end quotation
6161 @end ifset
6162 @end ifclear
6164 @ifset have-stabs
6165 @node Stab
6166 @section @code{.stabd, .stabn, .stabs}
6168 @cindex symbolic debuggers, information for
6169 @cindex @code{stab@var{x}} directives
6170 There are three directives that begin @samp{.stab}.
6171 All emit symbols (@pxref{Symbols}), for use by symbolic debuggers.
6172 The symbols are not entered in the @command{@value{AS}} hash table: they
6173 cannot be referenced elsewhere in the source file.
6174 Up to five fields are required:
6176 @table @var
6177 @item string
6178 This is the symbol's name.  It may contain any character except
6179 @samp{\000}, so is more general than ordinary symbol names.  Some
6180 debuggers used to code arbitrarily complex structures into symbol names
6181 using this field.
6183 @item type
6184 An absolute expression.  The symbol's type is set to the low 8 bits of
6185 this expression.  Any bit pattern is permitted, but @code{@value{LD}}
6186 and debuggers choke on silly bit patterns.
6188 @item other
6189 An absolute expression.  The symbol's ``other'' attribute is set to the
6190 low 8 bits of this expression.
6192 @item desc
6193 An absolute expression.  The symbol's descriptor is set to the low 16
6194 bits of this expression.
6196 @item value
6197 An absolute expression which becomes the symbol's value.
6198 @end table
6200 If a warning is detected while reading a @code{.stabd}, @code{.stabn},
6201 or @code{.stabs} statement, the symbol has probably already been created;
6202 you get a half-formed symbol in your object file.  This is
6203 compatible with earlier assemblers!
6205 @table @code
6206 @cindex @code{stabd} directive
6207 @item .stabd @var{type} , @var{other} , @var{desc}
6209 The ``name'' of the symbol generated is not even an empty string.
6210 It is a null pointer, for compatibility.  Older assemblers used a
6211 null pointer so they didn't waste space in object files with empty
6212 strings.
6214 The symbol's value is set to the location counter,
6215 relocatably.  When your program is linked, the value of this symbol
6216 is the address of the location counter when the @code{.stabd} was
6217 assembled.
6219 @cindex @code{stabn} directive
6220 @item .stabn @var{type} , @var{other} , @var{desc} , @var{value}
6221 The name of the symbol is set to the empty string @code{""}.
6223 @cindex @code{stabs} directive
6224 @item .stabs @var{string} ,  @var{type} , @var{other} , @var{desc} , @var{value}
6225 All five fields are specified.
6226 @end table
6227 @end ifset
6228 @c end     have-stabs
6230 @node String
6231 @section @code{.string} "@var{str}", @code{.string8} "@var{str}", @code{.string16}
6232 "@var{str}", @code{.string32} "@var{str}", @code{.string64} "@var{str}"
6234 @cindex string, copying to object file
6235 @cindex string8, copying to object file
6236 @cindex string16, copying to object file
6237 @cindex string32, copying to object file
6238 @cindex string64, copying to object file
6239 @cindex @code{string} directive
6240 @cindex @code{string8} directive
6241 @cindex @code{string16} directive
6242 @cindex @code{string32} directive
6243 @cindex @code{string64} directive
6245 Copy the characters in @var{str} to the object file.  You may specify more than
6246 one string to copy, separated by commas.  Unless otherwise specified for a
6247 particular machine, the assembler marks the end of each string with a 0 byte.
6248 You can use any of the escape sequences described in @ref{Strings,,Strings}.
6250 The variants @code{string16}, @code{string32} and @code{string64} differ from
6251 the @code{string} pseudo opcode in that each 8-bit character from @var{str} is
6252 copied and expanded to 16, 32 or 64 bits respectively.  The expanded characters
6253 are stored in target endianness byte order.
6255 Example:
6256 @smallexample
6257         .string32 "BYE"
6258 expands to:
6259         .string   "B\0\0\0Y\0\0\0E\0\0\0"  /* On little endian targets.  */
6260         .string   "\0\0\0B\0\0\0Y\0\0\0E"  /* On big endian targets.  */
6261 @end smallexample
6264 @node Struct
6265 @section @code{.struct @var{expression}}
6267 @cindex @code{struct} directive
6268 Switch to the absolute section, and set the section offset to @var{expression},
6269 which must be an absolute expression.  You might use this as follows:
6270 @smallexample
6271         .struct 0
6272 field1:
6273         .struct field1 + 4
6274 field2:
6275         .struct field2 + 4
6276 field3:
6277 @end smallexample
6278 This would define the symbol @code{field1} to have the value 0, the symbol
6279 @code{field2} to have the value 4, and the symbol @code{field3} to have the
6280 value 8.  Assembly would be left in the absolute section, and you would need to
6281 use a @code{.section} directive of some sort to change to some other section
6282 before further assembly.
6284 @ifset ELF
6285 @node SubSection
6286 @section @code{.subsection @var{name}}
6288 @cindex @code{subsection} directive
6289 @cindex Section Stack
6290 This is one of the ELF section stack manipulation directives.  The others are
6291 @code{.section} (@pxref{Section}), @code{.pushsection} (@pxref{PushSection}),
6292 @code{.popsection} (@pxref{PopSection}), and @code{.previous}
6293 (@pxref{Previous}).
6295 This directive replaces the current subsection with @code{name}.  The current
6296 section is not changed.  The replaced subsection is put onto the section stack
6297 in place of the then current top of stack subsection.
6298 @end ifset
6300 @ifset ELF
6301 @node Symver
6302 @section @code{.symver}
6303 @cindex @code{symver} directive
6304 @cindex symbol versioning
6305 @cindex versions of symbols
6306 Use the @code{.symver} directive to bind symbols to specific version nodes
6307 within a source file.  This is only supported on ELF platforms, and is
6308 typically used when assembling files to be linked into a shared library.
6309 There are cases where it may make sense to use this in objects to be bound
6310 into an application itself so as to override a versioned symbol from a
6311 shared library.
6313 For ELF targets, the @code{.symver} directive can be used like this:
6314 @smallexample
6315 .symver @var{name}, @var{name2@@nodename}
6316 @end smallexample
6317 If the symbol @var{name} is defined within the file
6318 being assembled, the @code{.symver} directive effectively creates a symbol
6319 alias with the name @var{name2@@nodename}, and in fact the main reason that we
6320 just don't try and create a regular alias is that the @var{@@} character isn't
6321 permitted in symbol names.  The @var{name2} part of the name is the actual name
6322 of the symbol by which it will be externally referenced.  The name @var{name}
6323 itself is merely a name of convenience that is used so that it is possible to
6324 have definitions for multiple versions of a function within a single source
6325 file, and so that the compiler can unambiguously know which version of a
6326 function is being mentioned.  The @var{nodename} portion of the alias should be
6327 the name of a node specified in the version script supplied to the linker when
6328 building a shared library.  If you are attempting to override a versioned
6329 symbol from a shared library, then @var{nodename} should correspond to the
6330 nodename of the symbol you are trying to override.
6332 If the symbol @var{name} is not defined within the file being assembled, all
6333 references to @var{name} will be changed to @var{name2@@nodename}.  If no
6334 reference to @var{name} is made, @var{name2@@nodename} will be removed from the
6335 symbol table.
6337 Another usage of the @code{.symver} directive is:
6338 @smallexample
6339 .symver @var{name}, @var{name2@@@@nodename}
6340 @end smallexample
6341 In this case, the symbol @var{name} must exist and be defined within
6342 the file being assembled. It is similar to @var{name2@@nodename}. The
6343 difference is @var{name2@@@@nodename} will also be used to resolve
6344 references to @var{name2} by the linker.
6346 The third usage of the @code{.symver} directive is:
6347 @smallexample
6348 .symver @var{name}, @var{name2@@@@@@nodename}
6349 @end smallexample
6350 When @var{name} is not defined within the
6351 file being assembled, it is treated as @var{name2@@nodename}. When
6352 @var{name} is defined within the file being assembled, the symbol
6353 name, @var{name}, will be changed to @var{name2@@@@nodename}.
6354 @end ifset
6356 @ifset COFF
6357 @node Tag
6358 @section @code{.tag @var{structname}}
6360 @cindex COFF structure debugging
6361 @cindex structure debugging, COFF
6362 @cindex @code{tag} directive
6363 This directive is generated by compilers to include auxiliary debugging
6364 information in the symbol table.  It is only permitted inside
6365 @code{.def}/@code{.endef} pairs.  Tags are used to link structure
6366 definitions in the symbol table with instances of those structures.
6367 @ifset BOUT
6369 @samp{.tag} is only used when generating COFF format output; when
6370 @command{@value{AS}} is generating @code{b.out}, it accepts this directive but
6371 ignores it.
6372 @end ifset
6373 @end ifset
6375 @node Text
6376 @section @code{.text @var{subsection}}
6378 @cindex @code{text} directive
6379 Tells @command{@value{AS}} to assemble the following statements onto the end of
6380 the text subsection numbered @var{subsection}, which is an absolute
6381 expression.  If @var{subsection} is omitted, subsection number zero
6382 is used.
6384 @node Title
6385 @section @code{.title "@var{heading}"}
6387 @cindex @code{title} directive
6388 @cindex listing control: title line
6389 Use @var{heading} as the title (second line, immediately after the
6390 source file name and pagenumber) when generating assembly listings.
6392 This directive affects subsequent pages, as well as the current page if
6393 it appears within ten lines of the top of a page.
6395 @ifset COFF-ELF
6396 @node Type
6397 @section @code{.type}
6399 This directive is used to set the type of a symbol.
6401 @ifset COFF
6402 @ifset ELF
6403 @c only print the extra heading if both COFF and ELF are set
6404 @subheading COFF Version
6405 @end ifset
6407 @cindex COFF symbol type
6408 @cindex symbol type, COFF
6409 @cindex @code{type} directive (COFF version)
6410 For COFF targets, this directive is permitted only within
6411 @code{.def}/@code{.endef} pairs.  It is used like this:
6413 @smallexample
6414 .type @var{int}
6415 @end smallexample
6417 This records the integer @var{int} as the type attribute of a symbol table
6418 entry.
6420 @ifset BOUT
6421 @samp{.type} is associated only with COFF format output; when
6422 @command{@value{AS}} is configured for @code{b.out} output, it accepts this
6423 directive but ignores it.
6424 @end ifset
6425 @end ifset
6427 @ifset ELF
6428 @ifset COFF
6429 @c only print the extra heading if both COFF and ELF are set
6430 @subheading ELF Version
6431 @end ifset
6433 @cindex ELF symbol type
6434 @cindex symbol type, ELF
6435 @cindex @code{type} directive (ELF version)
6436 For ELF targets, the @code{.type} directive is used like this:
6438 @smallexample
6439 .type @var{name} , @var{type description}
6440 @end smallexample
6442 This sets the type of symbol @var{name} to be either a
6443 function symbol or an object symbol.  There are five different syntaxes
6444 supported for the @var{type description} field, in order to provide
6445 compatibility with various other assemblers.
6447 Because some of the characters used in these syntaxes (such as @samp{@@} and
6448 @samp{#}) are comment characters for some architectures, some of the syntaxes
6449 below do not work on all architectures.  The first variant will be accepted by
6450 the GNU assembler on all architectures so that variant should be used for
6451 maximum portability, if you do not need to assemble your code with other
6452 assemblers.
6454 The syntaxes supported are:
6456 @smallexample
6457   .type <name> STT_<TYPE_IN_UPPER_CASE>
6458   .type <name>,#<type>
6459   .type <name>,@@<type>
6460   .type <name>,%<type>
6461   .type <name>,"<type>"
6462 @end smallexample
6464 The types supported are:
6466 @table @gcctabopt
6467 @item STT_FUNC
6468 @itemx function
6469 Mark the symbol as being a function name.
6471 @item STT_GNU_IFUNC
6472 @itemx gnu_indirect_function
6473 Mark the symbol as an indirect function when evaluated during reloc
6474 processing.  (This is only supported on Linux targeted assemblers).
6476 @item STT_OBJECT
6477 @itemx object
6478 Mark the symbol as being a data object.
6480 @item STT_TLS
6481 @itemx tls_object
6482 Mark the symbol as being a thead-local data object.
6484 @item STT_COMMON
6485 @itemx common
6486 Mark the symbol as being a common data object.
6488 @item STT_NOTYPE
6489 @itemx notype
6490 Does not mark the symbol in any way.  It is supported just for completeness.
6492 @item gnu_unique_object
6493 Marks the symbol as being a globally unique data object.  The dynamic linker
6494 will make sure that in the entire process there is just one symbol with this
6495 name and type in use.  (This is only supported on Linux targeted assemblers).
6497 @end table
6499 Note: Some targets support extra types in addition to those listed above.
6501 @end ifset
6502 @end ifset
6504 @node Uleb128
6505 @section @code{.uleb128 @var{expressions}}
6507 @cindex @code{uleb128} directive
6508 @var{uleb128} stands for ``unsigned little endian base 128.''  This is a
6509 compact, variable length representation of numbers used by the DWARF
6510 symbolic debugging format.  @xref{Sleb128, ,@code{.sleb128}}.
6512 @ifset COFF
6513 @node Val
6514 @section @code{.val @var{addr}}
6516 @cindex @code{val} directive
6517 @cindex COFF value attribute
6518 @cindex value attribute, COFF
6519 This directive, permitted only within @code{.def}/@code{.endef} pairs,
6520 records the address @var{addr} as the value attribute of a symbol table
6521 entry.
6522 @ifset BOUT
6524 @samp{.val} is used only for COFF output; when @command{@value{AS}} is
6525 configured for @code{b.out}, it accepts this directive but ignores it.
6526 @end ifset
6527 @end ifset
6529 @ifset ELF
6530 @node Version
6531 @section @code{.version "@var{string}"}
6533 @cindex @code{version} directive
6534 This directive creates a @code{.note} section and places into it an ELF
6535 formatted note of type NT_VERSION.  The note's name is set to @code{string}.
6536 @end ifset
6538 @ifset ELF
6539 @node VTableEntry
6540 @section @code{.vtable_entry @var{table}, @var{offset}}
6542 @cindex @code{vtable_entry} directive
6543 This directive finds or creates a symbol @code{table} and creates a
6544 @code{VTABLE_ENTRY} relocation for it with an addend of @code{offset}.
6546 @node VTableInherit
6547 @section @code{.vtable_inherit @var{child}, @var{parent}}
6549 @cindex @code{vtable_inherit} directive
6550 This directive finds the symbol @code{child} and finds or creates the symbol
6551 @code{parent} and then creates a @code{VTABLE_INHERIT} relocation for the
6552 parent whose addend is the value of the child symbol.  As a special case the
6553 parent name of @code{0} is treated as referring to the @code{*ABS*} section.
6554 @end ifset
6556 @node Warning
6557 @section @code{.warning "@var{string}"}
6558 @cindex warning directive
6559 Similar to the directive @code{.error}
6560 (@pxref{Error,,@code{.error "@var{string}"}}), but just emits a warning.
6562 @node Weak
6563 @section @code{.weak @var{names}}
6565 @cindex @code{weak} directive
6566 This directive sets the weak attribute on the comma separated list of symbol
6567 @code{names}.  If the symbols do not already exist, they will be created.
6569 On COFF targets other than PE, weak symbols are a GNU extension.  This
6570 directive sets the weak attribute on the comma separated list of symbol
6571 @code{names}.  If the symbols do not already exist, they will be created.
6573 On the PE target, weak symbols are supported natively as weak aliases.
6574 When a weak symbol is created that is not an alias, GAS creates an
6575 alternate symbol to hold the default value.
6577 @node Weakref
6578 @section @code{.weakref @var{alias}, @var{target}}
6580 @cindex @code{weakref} directive
6581 This directive creates an alias to the target symbol that enables the symbol to
6582 be referenced with weak-symbol semantics, but without actually making it weak.
6583 If direct references or definitions of the symbol are present, then the symbol
6584 will not be weak, but if all references to it are through weak references, the
6585 symbol will be marked as weak in the symbol table.
6587 The effect is equivalent to moving all references to the alias to a separate
6588 assembly source file, renaming the alias to the symbol in it, declaring the
6589 symbol as weak there, and running a reloadable link to merge the object files
6590 resulting from the assembly of the new source file and the old source file that
6591 had the references to the alias removed.
6593 The alias itself never makes to the symbol table, and is entirely handled
6594 within the assembler.
6596 @node Word
6597 @section @code{.word @var{expressions}}
6599 @cindex @code{word} directive
6600 This directive expects zero or more @var{expressions}, of any section,
6601 separated by commas.
6602 @ifclear GENERIC
6603 @ifset W32
6604 For each expression, @command{@value{AS}} emits a 32-bit number.
6605 @end ifset
6606 @ifset W16
6607 For each expression, @command{@value{AS}} emits a 16-bit number.
6608 @end ifset
6609 @end ifclear
6610 @ifset GENERIC
6612 The size of the number emitted, and its byte order,
6613 depend on what target computer the assembly is for.
6614 @end ifset
6616 @c on amd29k, i960, sparc the "special treatment to support compilers" doesn't
6617 @c happen---32-bit addressability, period; no long/short jumps.
6618 @ifset DIFF-TBL-KLUGE
6619 @cindex difference tables altered
6620 @cindex altered difference tables
6621 @quotation
6622 @emph{Warning: Special Treatment to support Compilers}
6623 @end quotation
6625 @ifset GENERIC
6626 Machines with a 32-bit address space, but that do less than 32-bit
6627 addressing, require the following special treatment.  If the machine of
6628 interest to you does 32-bit addressing (or doesn't require it;
6629 @pxref{Machine Dependencies}), you can ignore this issue.
6631 @end ifset
6632 In order to assemble compiler output into something that works,
6633 @command{@value{AS}} occasionally does strange things to @samp{.word} directives.
6634 Directives of the form @samp{.word sym1-sym2} are often emitted by
6635 compilers as part of jump tables.  Therefore, when @command{@value{AS}} assembles a
6636 directive of the form @samp{.word sym1-sym2}, and the difference between
6637 @code{sym1} and @code{sym2} does not fit in 16 bits, @command{@value{AS}}
6638 creates a @dfn{secondary jump table}, immediately before the next label.
6639 This secondary jump table is preceded by a short-jump to the
6640 first byte after the secondary table.  This short-jump prevents the flow
6641 of control from accidentally falling into the new table.  Inside the
6642 table is a long-jump to @code{sym2}.  The original @samp{.word}
6643 contains @code{sym1} minus the address of the long-jump to
6644 @code{sym2}.
6646 If there were several occurrences of @samp{.word sym1-sym2} before the
6647 secondary jump table, all of them are adjusted.  If there was a
6648 @samp{.word sym3-sym4}, that also did not fit in sixteen bits, a
6649 long-jump to @code{sym4} is included in the secondary jump table,
6650 and the @code{.word} directives are adjusted to contain @code{sym3}
6651 minus the address of the long-jump to @code{sym4}; and so on, for as many
6652 entries in the original jump table as necessary.
6654 @ifset INTERNALS
6655 @emph{This feature may be disabled by compiling @command{@value{AS}} with the
6656 @samp{-DWORKING_DOT_WORD} option.} This feature is likely to confuse
6657 assembly language programmers.
6658 @end ifset
6659 @end ifset
6660 @c end     DIFF-TBL-KLUGE
6662 @node Deprecated
6663 @section Deprecated Directives
6665 @cindex deprecated directives
6666 @cindex obsolescent directives
6667 One day these directives won't work.
6668 They are included for compatibility with older assemblers.
6669 @table @t
6670 @item .abort
6671 @item .line
6672 @end table
6674 @ifset ELF
6675 @node Object Attributes
6676 @chapter Object Attributes
6677 @cindex object attributes
6679 @command{@value{AS}} assembles source files written for a specific architecture
6680 into object files for that architecture.  But not all object files are alike.
6681 Many architectures support incompatible variations.  For instance, floating
6682 point arguments might be passed in floating point registers if the object file
6683 requires hardware floating point support---or floating point arguments might be
6684 passed in integer registers if the object file supports processors with no
6685 hardware floating point unit.  Or, if two objects are built for different
6686 generations of the same architecture, the combination may require the
6687 newer generation at run-time.
6689 This information is useful during and after linking.  At link time,
6690 @command{@value{LD}} can warn about incompatible object files.  After link
6691 time, tools like @command{gdb} can use it to process the linked file
6692 correctly.
6694 Compatibility information is recorded as a series of object attributes.  Each
6695 attribute has a @dfn{vendor}, @dfn{tag}, and @dfn{value}.  The vendor is a
6696 string, and indicates who sets the meaning of the tag.  The tag is an integer,
6697 and indicates what property the attribute describes.  The value may be a string
6698 or an integer, and indicates how the property affects this object.  Missing
6699 attributes are the same as attributes with a zero value or empty string value.
6701 Object attributes were developed as part of the ABI for the ARM Architecture.
6702 The file format is documented in @cite{ELF for the ARM Architecture}.
6704 @menu
6705 * GNU Object Attributes::               @sc{gnu} Object Attributes
6706 * Defining New Object Attributes::      Defining New Object Attributes
6707 @end menu
6709 @node GNU Object Attributes
6710 @section @sc{gnu} Object Attributes
6712 The @code{.gnu_attribute} directive records an object attribute
6713 with vendor @samp{gnu}.
6715 Except for @samp{Tag_compatibility}, which has both an integer and a string for
6716 its value, @sc{gnu} attributes have a string value if the tag number is odd and
6717 an integer value if the tag number is even.  The second bit (@code{@var{tag} &
6718 2} is set for architecture-independent attributes and clear for
6719 architecture-dependent ones.
6721 @subsection Common @sc{gnu} attributes
6723 These attributes are valid on all architectures.
6725 @table @r
6726 @item Tag_compatibility (32)
6727 The compatibility attribute takes an integer flag value and a vendor name.  If
6728 the flag value is 0, the file is compatible with other toolchains.  If it is 1,
6729 then the file is only compatible with the named toolchain.  If it is greater
6730 than 1, the file can only be processed by other toolchains under some private
6731 arrangement indicated by the flag value and the vendor name.
6732 @end table
6734 @subsection MIPS Attributes
6736 @table @r
6737 @item Tag_GNU_MIPS_ABI_FP (4)
6738 The floating-point ABI used by this object file.  The value will be:
6740 @itemize @bullet
6741 @item
6742 0 for files not affected by the floating-point ABI.
6743 @item
6744 1 for files using the hardware floating-point with a standard double-precision
6745 FPU.
6746 @item
6747 2 for files using the hardware floating-point ABI with a single-precision FPU.
6748 @item
6749 3 for files using the software floating-point ABI.
6750 @item
6751 4 for files using the hardware floating-point ABI with 64-bit wide
6752 double-precision floating-point registers and 32-bit wide general
6753 purpose registers.
6754 @end itemize
6755 @end table
6757 @subsection PowerPC Attributes
6759 @table @r
6760 @item Tag_GNU_Power_ABI_FP (4)
6761 The floating-point ABI used by this object file.  The value will be:
6763 @itemize @bullet
6764 @item
6765 0 for files not affected by the floating-point ABI.
6766 @item
6767 1 for files using double-precision hardware floating-point ABI.
6768 @item
6769 2 for files using the software floating-point ABI.
6770 @item
6771 3 for files using single-precision hardware floating-point ABI.
6772 @end itemize
6774 @item Tag_GNU_Power_ABI_Vector (8)
6775 The vector ABI used by this object file.  The value will be:
6777 @itemize @bullet
6778 @item
6779 0 for files not affected by the vector ABI.
6780 @item
6781 1 for files using general purpose registers to pass vectors.
6782 @item
6783 2 for files using AltiVec registers to pass vectors.
6784 @item
6785 3 for files using SPE registers to pass vectors.
6786 @end itemize
6787 @end table
6789 @node Defining New Object Attributes
6790 @section Defining New Object Attributes
6792 If you want to define a new @sc{gnu} object attribute, here are the places you
6793 will need to modify.  New attributes should be discussed on the @samp{binutils}
6794 mailing list.
6796 @itemize @bullet
6797 @item
6798 This manual, which is the official register of attributes.
6799 @item
6800 The header for your architecture @file{include/elf}, to define the tag.
6801 @item
6802 The @file{bfd} support file for your architecture, to merge the attribute
6803 and issue any appropriate link warnings.
6804 @item
6805 Test cases in @file{ld/testsuite} for merging and link warnings.
6806 @item
6807 @file{binutils/readelf.c} to display your attribute.
6808 @item
6809 GCC, if you want the compiler to mark the attribute automatically.
6810 @end itemize
6812 @end ifset
6814 @ifset GENERIC
6815 @node Machine Dependencies
6816 @chapter Machine Dependent Features
6818 @cindex machine dependencies
6819 The machine instruction sets are (almost by definition) different on
6820 each machine where @command{@value{AS}} runs.  Floating point representations
6821 vary as well, and @command{@value{AS}} often supports a few additional
6822 directives or command-line options for compatibility with other
6823 assemblers on a particular platform.  Finally, some versions of
6824 @command{@value{AS}} support special pseudo-instructions for branch
6825 optimization.
6827 This chapter discusses most of these differences, though it does not
6828 include details on any machine's instruction set.  For details on that
6829 subject, see the hardware manufacturer's manual.
6831 @menu
6832 @ifset ALPHA
6833 * Alpha-Dependent::             Alpha Dependent Features
6834 @end ifset
6835 @ifset ARC
6836 * ARC-Dependent::               ARC Dependent Features
6837 @end ifset
6838 @ifset ARM
6839 * ARM-Dependent::               ARM Dependent Features
6840 @end ifset
6841 @ifset AVR
6842 * AVR-Dependent::               AVR Dependent Features
6843 @end ifset
6844 @ifset Blackfin
6845 * Blackfin-Dependent::          Blackfin Dependent Features
6846 @end ifset
6847 @ifset CR16
6848 * CR16-Dependent::              CR16 Dependent Features
6849 @end ifset
6850 @ifset CRIS
6851 * CRIS-Dependent::              CRIS Dependent Features
6852 @end ifset
6853 @ifset D10V
6854 * D10V-Dependent::              D10V Dependent Features
6855 @end ifset
6856 @ifset D30V
6857 * D30V-Dependent::              D30V Dependent Features
6858 @end ifset
6859 @ifset H8/300
6860 * H8/300-Dependent::            Renesas H8/300 Dependent Features
6861 @end ifset
6862 @ifset HPPA
6863 * HPPA-Dependent::              HPPA Dependent Features
6864 @end ifset
6865 @ifset I370
6866 * ESA/390-Dependent::           IBM ESA/390 Dependent Features
6867 @end ifset
6868 @ifset I80386
6869 * i386-Dependent::              Intel 80386 and AMD x86-64 Dependent Features
6870 @end ifset
6871 @ifset I860
6872 * i860-Dependent::              Intel 80860 Dependent Features
6873 @end ifset
6874 @ifset I960
6875 * i960-Dependent::              Intel 80960 Dependent Features
6876 @end ifset
6877 @ifset IA64
6878 * IA-64-Dependent::             Intel IA-64 Dependent Features
6879 @end ifset
6880 @ifset IP2K
6881 * IP2K-Dependent::              IP2K Dependent Features
6882 @end ifset
6883 @ifset LM32
6884 * LM32-Dependent::              LM32 Dependent Features
6885 @end ifset
6886 @ifset M32C
6887 * M32C-Dependent::              M32C Dependent Features
6888 @end ifset
6889 @ifset M32R
6890 * M32R-Dependent::              M32R Dependent Features
6891 @end ifset
6892 @ifset M680X0
6893 * M68K-Dependent::              M680x0 Dependent Features
6894 @end ifset
6895 @ifset M68HC11
6896 * M68HC11-Dependent::           M68HC11 and 68HC12 Dependent Features
6897 @end ifset
6898 @ifset MICROBLAZE
6899 * MicroBlaze-Dependent::        MICROBLAZE Dependent Features
6900 @end ifset
6901 @ifset MIPS
6902 * MIPS-Dependent::              MIPS Dependent Features
6903 @end ifset
6904 @ifset MMIX
6905 * MMIX-Dependent::              MMIX Dependent Features
6906 @end ifset
6907 @ifset MSP430
6908 * MSP430-Dependent::            MSP430 Dependent Features
6909 @end ifset
6910 @ifset SH
6911 * SH-Dependent::                Renesas / SuperH SH Dependent Features
6912 * SH64-Dependent::              SuperH SH64 Dependent Features
6913 @end ifset
6914 @ifset PDP11
6915 * PDP-11-Dependent::            PDP-11 Dependent Features
6916 @end ifset
6917 @ifset PJ
6918 * PJ-Dependent::                picoJava Dependent Features
6919 @end ifset
6920 @ifset PPC
6921 * PPC-Dependent::               PowerPC Dependent Features
6922 @end ifset
6923 @ifset RX
6924 * RX-Dependent::                RX Dependent Features
6925 @end ifset
6926 @ifset S390
6927 * S/390-Dependent::             IBM S/390 Dependent Features
6928 @end ifset
6929 @ifset SCORE
6930 * SCORE-Dependent::             SCORE Dependent Features
6931 @end ifset
6932 @ifset SPARC
6933 * Sparc-Dependent::             SPARC Dependent Features
6934 @end ifset
6935 @ifset TIC54X
6936 * TIC54X-Dependent::            TI TMS320C54x Dependent Features
6937 @end ifset
6938 @ifset TIC6X
6939 * TIC6X-Dependent ::            TI TMS320C6x Dependent Features
6940 @end ifset
6941 @ifset V850
6942 * V850-Dependent::              V850 Dependent Features
6943 @end ifset
6944 @ifset XTENSA
6945 * Xtensa-Dependent::            Xtensa Dependent Features
6946 @end ifset
6947 @ifset Z80
6948 * Z80-Dependent::               Z80 Dependent Features
6949 @end ifset
6950 @ifset Z8000
6951 * Z8000-Dependent::             Z8000 Dependent Features
6952 @end ifset
6953 @ifset VAX
6954 * Vax-Dependent::               VAX Dependent Features
6955 @end ifset
6956 @end menu
6958 @lowersections
6959 @end ifset
6961 @c The following major nodes are *sections* in the GENERIC version, *chapters*
6962 @c in single-cpu versions.  This is mainly achieved by @lowersections.  There is a
6963 @c peculiarity: to preserve cross-references, there must be a node called
6964 @c "Machine Dependencies".  Hence the conditional nodenames in each
6965 @c major node below.  Node defaulting in makeinfo requires adjacency of
6966 @c node and sectioning commands; hence the repetition of @chapter BLAH
6967 @c in both conditional blocks.
6969 @ifset ALPHA
6970 @include c-alpha.texi
6971 @end ifset
6973 @ifset ARC
6974 @include c-arc.texi
6975 @end ifset
6977 @ifset ARM
6978 @include c-arm.texi
6979 @end ifset
6981 @ifset AVR
6982 @include c-avr.texi
6983 @end ifset
6985 @ifset Blackfin
6986 @include c-bfin.texi
6987 @end ifset
6989 @ifset CR16
6990 @include c-cr16.texi
6991 @end ifset
6993 @ifset CRIS
6994 @include c-cris.texi
6995 @end ifset
6997 @ifset Renesas-all
6998 @ifclear GENERIC
6999 @node Machine Dependencies
7000 @chapter Machine Dependent Features
7002 The machine instruction sets are different on each Renesas chip family,
7003 and there are also some syntax differences among the families.  This
7004 chapter describes the specific @command{@value{AS}} features for each
7005 family.
7007 @menu
7008 * H8/300-Dependent::            Renesas H8/300 Dependent Features
7009 * SH-Dependent::                Renesas SH Dependent Features
7010 @end menu
7011 @lowersections
7012 @end ifclear
7013 @end ifset
7015 @ifset D10V
7016 @include c-d10v.texi
7017 @end ifset
7019 @ifset D30V
7020 @include c-d30v.texi
7021 @end ifset
7023 @ifset H8/300
7024 @include c-h8300.texi
7025 @end ifset
7027 @ifset HPPA
7028 @include c-hppa.texi
7029 @end ifset
7031 @ifset I370
7032 @include c-i370.texi
7033 @end ifset
7035 @ifset I80386
7036 @include c-i386.texi
7037 @end ifset
7039 @ifset I860
7040 @include c-i860.texi
7041 @end ifset
7043 @ifset I960
7044 @include c-i960.texi
7045 @end ifset
7047 @ifset IA64
7048 @include c-ia64.texi
7049 @end ifset
7051 @ifset IP2K
7052 @include c-ip2k.texi
7053 @end ifset
7055 @ifset LM32
7056 @include c-lm32.texi
7057 @end ifset
7059 @ifset M32C
7060 @include c-m32c.texi
7061 @end ifset
7063 @ifset M32R
7064 @include c-m32r.texi
7065 @end ifset
7067 @ifset M680X0
7068 @include c-m68k.texi
7069 @end ifset
7071 @ifset M68HC11
7072 @include c-m68hc11.texi
7073 @end ifset
7075 @ifset MICROBLAZE
7076 @include c-microblaze.texi
7077 @end ifset
7079 @ifset MIPS
7080 @include c-mips.texi
7081 @end ifset
7083 @ifset MMIX
7084 @include c-mmix.texi
7085 @end ifset
7087 @ifset MSP430
7088 @include c-msp430.texi
7089 @end ifset
7091 @ifset NS32K
7092 @include c-ns32k.texi
7093 @end ifset
7095 @ifset PDP11
7096 @include c-pdp11.texi
7097 @end ifset
7099 @ifset PJ
7100 @include c-pj.texi
7101 @end ifset
7103 @ifset PPC
7104 @include c-ppc.texi
7105 @end ifset
7107 @ifset RX
7108 @include c-rx.texi
7109 @end ifset
7111 @ifset S390
7112 @include c-s390.texi
7113 @end ifset
7115 @ifset SCORE
7116 @include c-score.texi
7117 @end ifset
7119 @ifset SH
7120 @include c-sh.texi
7121 @include c-sh64.texi
7122 @end ifset
7124 @ifset SPARC
7125 @include c-sparc.texi
7126 @end ifset
7128 @ifset TIC54X
7129 @include c-tic54x.texi
7130 @end ifset
7132 @ifset TIC6X
7133 @include c-tic6x.texi
7134 @end ifset
7136 @ifset Z80
7137 @include c-z80.texi
7138 @end ifset
7140 @ifset Z8000
7141 @include c-z8k.texi
7142 @end ifset
7144 @ifset VAX
7145 @include c-vax.texi
7146 @end ifset
7148 @ifset V850
7149 @include c-v850.texi
7150 @end ifset
7152 @ifset XTENSA
7153 @include c-xtensa.texi
7154 @end ifset
7156 @ifset GENERIC
7157 @c reverse effect of @down at top of generic Machine-Dep chapter
7158 @raisesections
7159 @end ifset
7161 @node Reporting Bugs
7162 @chapter Reporting Bugs
7163 @cindex bugs in assembler
7164 @cindex reporting bugs in assembler
7166 Your bug reports play an essential role in making @command{@value{AS}} reliable.
7168 Reporting a bug may help you by bringing a solution to your problem, or it may
7169 not.  But in any case the principal function of a bug report is to help the
7170 entire community by making the next version of @command{@value{AS}} work better.
7171 Bug reports are your contribution to the maintenance of @command{@value{AS}}.
7173 In order for a bug report to serve its purpose, you must include the
7174 information that enables us to fix the bug.
7176 @menu
7177 * Bug Criteria::                Have you found a bug?
7178 * Bug Reporting::               How to report bugs
7179 @end menu
7181 @node Bug Criteria
7182 @section Have You Found a Bug?
7183 @cindex bug criteria
7185 If you are not sure whether you have found a bug, here are some guidelines:
7187 @itemize @bullet
7188 @cindex fatal signal
7189 @cindex assembler crash
7190 @cindex crash of assembler
7191 @item
7192 If the assembler gets a fatal signal, for any input whatever, that is a
7193 @command{@value{AS}} bug.  Reliable assemblers never crash.
7195 @cindex error on valid input
7196 @item
7197 If @command{@value{AS}} produces an error message for valid input, that is a bug.
7199 @cindex invalid input
7200 @item
7201 If @command{@value{AS}} does not produce an error message for invalid input, that
7202 is a bug.  However, you should note that your idea of ``invalid input'' might
7203 be our idea of ``an extension'' or ``support for traditional practice''.
7205 @item
7206 If you are an experienced user of assemblers, your suggestions for improvement
7207 of @command{@value{AS}} are welcome in any case.
7208 @end itemize
7210 @node Bug Reporting
7211 @section How to Report Bugs
7212 @cindex bug reports
7213 @cindex assembler bugs, reporting
7215 A number of companies and individuals offer support for @sc{gnu} products.  If
7216 you obtained @command{@value{AS}} from a support organization, we recommend you
7217 contact that organization first.
7219 You can find contact information for many support companies and
7220 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
7221 distribution.
7223 @ifset BUGURL
7224 In any event, we also recommend that you send bug reports for @command{@value{AS}}
7225 to @value{BUGURL}.
7226 @end ifset
7228 The fundamental principle of reporting bugs usefully is this:
7229 @strong{report all the facts}.  If you are not sure whether to state a
7230 fact or leave it out, state it!
7232 Often people omit facts because they think they know what causes the problem
7233 and assume that some details do not matter.  Thus, you might assume that the
7234 name of a symbol you use in an example does not matter.  Well, probably it does
7235 not, but one cannot be sure.  Perhaps the bug is a stray memory reference which
7236 happens to fetch from the location where that name is stored in memory;
7237 perhaps, if the name were different, the contents of that location would fool
7238 the assembler into doing the right thing despite the bug.  Play it safe and
7239 give a specific, complete example.  That is the easiest thing for you to do,
7240 and the most helpful.
7242 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
7243 it is new to us.  Therefore, always write your bug reports on the assumption
7244 that the bug has not been reported previously.
7246 Sometimes people give a few sketchy facts and ask, ``Does this ring a
7247 bell?''  This cannot help us fix a bug, so it is basically useless.  We
7248 respond by asking for enough details to enable us to investigate.
7249 You might as well expedite matters by sending them to begin with.
7251 To enable us to fix the bug, you should include all these things:
7253 @itemize @bullet
7254 @item
7255 The version of @command{@value{AS}}.  @command{@value{AS}} announces it if you start
7256 it with the @samp{--version} argument.
7258 Without this, we will not know whether there is any point in looking for
7259 the bug in the current version of @command{@value{AS}}.
7261 @item
7262 Any patches you may have applied to the @command{@value{AS}} source.
7264 @item
7265 The type of machine you are using, and the operating system name and
7266 version number.
7268 @item
7269 What compiler (and its version) was used to compile @command{@value{AS}}---e.g.
7270 ``@code{gcc-2.7}''.
7272 @item
7273 The command arguments you gave the assembler to assemble your example and
7274 observe the bug.  To guarantee you will not omit something important, list them
7275 all.  A copy of the Makefile (or the output from make) is sufficient.
7277 If we were to try to guess the arguments, we would probably guess wrong
7278 and then we might not encounter the bug.
7280 @item
7281 A complete input file that will reproduce the bug.  If the bug is observed when
7282 the assembler is invoked via a compiler, send the assembler source, not the
7283 high level language source.  Most compilers will produce the assembler source
7284 when run with the @samp{-S} option.  If you are using @code{@value{GCC}}, use
7285 the options @samp{-v --save-temps}; this will save the assembler source in a
7286 file with an extension of @file{.s}, and also show you exactly how
7287 @command{@value{AS}} is being run.
7289 @item
7290 A description of what behavior you observe that you believe is
7291 incorrect.  For example, ``It gets a fatal signal.''
7293 Of course, if the bug is that @command{@value{AS}} gets a fatal signal, then we
7294 will certainly notice it.  But if the bug is incorrect output, we might not
7295 notice unless it is glaringly wrong.  You might as well not give us a chance to
7296 make a mistake.
7298 Even if the problem you experience is a fatal signal, you should still say so
7299 explicitly.  Suppose something strange is going on, such as, your copy of
7300 @command{@value{AS}} is out of sync, or you have encountered a bug in the C
7301 library on your system.  (This has happened!)  Your copy might crash and ours
7302 would not.  If you told us to expect a crash, then when ours fails to crash, we
7303 would know that the bug was not happening for us.  If you had not told us to
7304 expect a crash, then we would not be able to draw any conclusion from our
7305 observations.
7307 @item
7308 If you wish to suggest changes to the @command{@value{AS}} source, send us context
7309 diffs, as generated by @code{diff} with the @samp{-u}, @samp{-c}, or @samp{-p}
7310 option.  Always send diffs from the old file to the new file.  If you even
7311 discuss something in the @command{@value{AS}} source, refer to it by context, not
7312 by line number.
7314 The line numbers in our development sources will not match those in your
7315 sources.  Your line numbers would convey no useful information to us.
7316 @end itemize
7318 Here are some things that are not necessary:
7320 @itemize @bullet
7321 @item
7322 A description of the envelope of the bug.
7324 Often people who encounter a bug spend a lot of time investigating
7325 which changes to the input file will make the bug go away and which
7326 changes will not affect it.
7328 This is often time consuming and not very useful, because the way we
7329 will find the bug is by running a single example under the debugger
7330 with breakpoints, not by pure deduction from a series of examples.
7331 We recommend that you save your time for something else.
7333 Of course, if you can find a simpler example to report @emph{instead}
7334 of the original one, that is a convenience for us.  Errors in the
7335 output will be easier to spot, running under the debugger will take
7336 less time, and so on.
7338 However, simplification is not vital; if you do not want to do this,
7339 report the bug anyway and send us the entire test case you used.
7341 @item
7342 A patch for the bug.
7344 A patch for the bug does help us if it is a good one.  But do not omit
7345 the necessary information, such as the test case, on the assumption that
7346 a patch is all we need.  We might see problems with your patch and decide
7347 to fix the problem another way, or we might not understand it at all.
7349 Sometimes with a program as complicated as @command{@value{AS}} it is very hard to
7350 construct an example that will make the program follow a certain path through
7351 the code.  If you do not send us the example, we will not be able to construct
7352 one, so we will not be able to verify that the bug is fixed.
7354 And if we cannot understand what bug you are trying to fix, or why your
7355 patch should be an improvement, we will not install it.  A test case will
7356 help us to understand.
7358 @item
7359 A guess about what the bug is or what it depends on.
7361 Such guesses are usually wrong.  Even we cannot guess right about such
7362 things without first using the debugger to find the facts.
7363 @end itemize
7365 @node Acknowledgements
7366 @chapter Acknowledgements
7368 If you have contributed to GAS and your name isn't listed here,
7369 it is not meant as a slight.  We just don't know about it.  Send mail to the
7370 maintainer, and we'll correct the situation.  Currently
7371 @c (January 1994),
7372 the maintainer is Ken Raeburn (email address @code{raeburn@@cygnus.com}).
7374 Dean Elsner wrote the original @sc{gnu} assembler for the VAX.@footnote{Any
7375 more details?}
7377 Jay Fenlason maintained GAS for a while, adding support for GDB-specific debug
7378 information and the 68k series machines, most of the preprocessing pass, and
7379 extensive changes in @file{messages.c}, @file{input-file.c}, @file{write.c}.
7381 K. Richard Pixley maintained GAS for a while, adding various enhancements and
7382 many bug fixes, including merging support for several processors, breaking GAS
7383 up to handle multiple object file format back ends (including heavy rewrite,
7384 testing, an integration of the coff and b.out back ends), adding configuration
7385 including heavy testing and verification of cross assemblers and file splits
7386 and renaming, converted GAS to strictly ANSI C including full prototypes, added
7387 support for m680[34]0 and cpu32, did considerable work on i960 including a COFF
7388 port (including considerable amounts of reverse engineering), a SPARC opcode
7389 file rewrite, DECstation, rs6000, and hp300hpux host ports, updated ``know''
7390 assertions and made them work, much other reorganization, cleanup, and lint.
7392 Ken Raeburn wrote the high-level BFD interface code to replace most of the code
7393 in format-specific I/O modules.
7395 The original VMS support was contributed by David L. Kashtan.  Eric Youngdale
7396 has done much work with it since.
7398 The Intel 80386 machine description was written by Eliot Dresselhaus.
7400 Minh Tran-Le at IntelliCorp contributed some AIX 386 support.
7402 The Motorola 88k machine description was contributed by Devon Bowen of Buffalo
7403 University and Torbjorn Granlund of the Swedish Institute of Computer Science.
7405 Keith Knowles at the Open Software Foundation wrote the original MIPS back end
7406 (@file{tc-mips.c}, @file{tc-mips.h}), and contributed Rose format support
7407 (which hasn't been merged in yet).  Ralph Campbell worked with the MIPS code to
7408 support a.out format.
7410 Support for the Zilog Z8k and Renesas H8/300 processors (tc-z8k,
7411 tc-h8300), and IEEE 695 object file format (obj-ieee), was written by
7412 Steve Chamberlain of Cygnus Support.  Steve also modified the COFF back end to
7413 use BFD for some low-level operations, for use with the H8/300 and AMD 29k
7414 targets.
7416 John Gilmore built the AMD 29000 support, added @code{.include} support, and
7417 simplified the configuration of which versions accept which directives.  He
7418 updated the 68k machine description so that Motorola's opcodes always produced
7419 fixed-size instructions (e.g., @code{jsr}), while synthetic instructions
7420 remained shrinkable (@code{jbsr}).  John fixed many bugs, including true tested
7421 cross-compilation support, and one bug in relaxation that took a week and
7422 required the proverbial one-bit fix.
7424 Ian Lance Taylor of Cygnus Support merged the Motorola and MIT syntax for the
7425 68k, completed support for some COFF targets (68k, i386 SVR3, and SCO Unix),
7426 added support for MIPS ECOFF and ELF targets, wrote the initial RS/6000 and
7427 PowerPC assembler, and made a few other minor patches.
7429 Steve Chamberlain made GAS able to generate listings.
7431 Hewlett-Packard contributed support for the HP9000/300.
7433 Jeff Law wrote GAS and BFD support for the native HPPA object format (SOM)
7434 along with a fairly extensive HPPA testsuite (for both SOM and ELF object
7435 formats).  This work was supported by both the Center for Software Science at
7436 the University of Utah and Cygnus Support.
7438 Support for ELF format files has been worked on by Mark Eichin of Cygnus
7439 Support (original, incomplete implementation for SPARC), Pete Hoogenboom and
7440 Jeff Law at the University of Utah (HPPA mainly), Michael Meissner of the Open
7441 Software Foundation (i386 mainly), and Ken Raeburn of Cygnus Support (sparc,
7442 and some initial 64-bit support).
7444 Linas Vepstas added GAS support for the ESA/390 ``IBM 370'' architecture.
7446 Richard Henderson rewrote the Alpha assembler. Klaus Kaempf wrote GAS and BFD
7447 support for openVMS/Alpha.
7449 Timothy Wall, Michael Hayes, and Greg Smart contributed to the various tic*
7450 flavors.
7452 David Heine, Sterling Augustine, Bob Wilson and John Ruttenberg from Tensilica,
7453 Inc.@: added support for Xtensa processors.
7455 Several engineers at Cygnus Support have also provided many small bug fixes and
7456 configuration enhancements.
7458 Jon Beniston added support for the Lattice Mico32 architecture.
7460 Many others have contributed large or small bugfixes and enhancements.  If
7461 you have contributed significant work and are not mentioned on this list, and
7462 want to be, let us know.  Some of the history has been lost; we are not
7463 intentionally leaving anyone out.
7465 @node GNU Free Documentation License
7466 @appendix GNU Free Documentation License
7467 @include fdl.texi
7469 @node AS Index
7470 @unnumbered AS Index
7472 @printindex cp
7474 @bye
7475 @c Local Variables:
7476 @c fill-column: 79
7477 @c End: