Import binutils-2.20
[dragonfly.git] / contrib / binutils-2.20 / gas / doc / as.texinfo
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
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 BOUT
43 @set aout-bout
44 @end ifset
45 @ifset H8/300
46 @set H8
47 @end ifset
48 @ifset SH
49 @set H8
50 @end ifset
51 @ifset HPPA
52 @set abnormal-separator
53 @end ifset
54 @c ------------
55 @ifset GENERIC
56 @settitle Using @value{AS}
57 @end ifset
58 @ifclear GENERIC
59 @settitle Using @value{AS} (@value{TARGET})
60 @end ifclear
61 @setchapternewpage odd
62 @c %**end of header
63
64 @c @smallbook
65 @c @set SMALL
66 @c WARE! Some of the machine-dependent sections contain tables of machine
67 @c instructions.  Except in multi-column format, these tables look silly.
68 @c Unfortunately, Texinfo doesn't have a general-purpose multi-col format, so
69 @c the multi-col format is faked within @example sections.
70 @c 
71 @c Again unfortunately, the natural size that fits on a page, for these tables,
72 @c is different depending on whether or not smallbook is turned on.
73 @c This matters, because of order: text flow switches columns at each page
74 @c break.
75 @c 
76 @c The format faked in this source works reasonably well for smallbook,
77 @c not well for the default large-page format.  This manual expects that if you
78 @c turn on @smallbook, you will also uncomment the "@set SMALL" to enable the
79 @c tables in question.  You can turn on one without the other at your
80 @c discretion, of course. 
81 @ifinfo
82 @set SMALL
83 @c the insn tables look just as silly in info files regardless of smallbook,
84 @c might as well show 'em anyways.
85 @end ifinfo
86
87 @ifinfo
88 @format
89 START-INFO-DIR-ENTRY
90 * As: (as).                     The GNU assembler.
91 * Gas: (as).                    The GNU assembler.
92 END-INFO-DIR-ENTRY
93 @end format
94 @end ifinfo
95
96 @finalout
97 @syncodeindex ky cp
98
99 @copying
100 This file documents the GNU Assembler "@value{AS}".
101
102 @c man begin COPYRIGHT
103 Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002,
104 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
105
106 Permission is granted to copy, distribute and/or modify this document
107 under the terms of the GNU Free Documentation License, Version 1.3
108 or any later version published by the Free Software Foundation;
109 with no Invariant Sections, with no Front-Cover Texts, and with no
110 Back-Cover Texts.  A copy of the license is included in the
111 section entitled ``GNU Free Documentation License''.
112
113 @c man end
114 @end copying
115
116 @titlepage
117 @title Using @value{AS}
118 @subtitle The @sc{gnu} Assembler
119 @ifclear GENERIC
120 @subtitle for the @value{TARGET} family
121 @end ifclear
122 @ifset VERSION_PACKAGE
123 @sp 1
124 @subtitle @value{VERSION_PACKAGE}
125 @end ifset
126 @sp 1
127 @subtitle Version @value{VERSION}
128 @sp 1
129 @sp 13
130 The Free Software Foundation Inc.@: thanks The Nice Computer
131 Company of Australia for loaning Dean Elsner to write the
132 first (Vax) version of @command{as} for Project @sc{gnu}.
133 The proprietors, management and staff of TNCCA thank FSF for
134 distracting the boss while they got some work
135 done.
136 @sp 3
137 @author Dean Elsner, Jay Fenlason & friends
138 @page
139 @tex
140 {\parskip=0pt
141 \hfill {\it Using {\tt @value{AS}}}\par
142 \hfill Edited by Cygnus Support\par
143 }
144 %"boxit" macro for figures:
145 %Modified from Knuth's ``boxit'' macro from TeXbook (answer to exercise 21.3)
146 \gdef\boxit#1#2{\vbox{\hrule\hbox{\vrule\kern3pt
147      \vbox{\parindent=0pt\parskip=0pt\hsize=#1\kern3pt\strut\hfil
148 #2\hfil\strut\kern3pt}\kern3pt\vrule}\hrule}}%box with visible outline
149 \gdef\ibox#1#2{\hbox to #1{#2\hfil}\kern8pt}% invisible box
150 @end tex
151
152 @vskip 0pt plus 1filll
153 Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002,
154 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
155
156       Permission is granted to copy, distribute and/or modify this document
157       under the terms of the GNU Free Documentation License, Version 1.3
158       or any later version published by the Free Software Foundation;
159       with no Invariant Sections, with no Front-Cover Texts, and with no
160       Back-Cover Texts.  A copy of the license is included in the
161       section entitled ``GNU Free Documentation License''.
162
163 @end titlepage
164 @contents
165
166 @ifnottex
167 @node Top
168 @top Using @value{AS}
169
170 This file is a user guide to the @sc{gnu} assembler @command{@value{AS}}
171 @ifset VERSION_PACKAGE
172 @value{VERSION_PACKAGE}
173 @end ifset
174 version @value{VERSION}.
175 @ifclear GENERIC
176 This version of the file describes @command{@value{AS}} configured to generate
177 code for @value{TARGET} architectures.
178 @end ifclear
179
180 This document is distributed under the terms of the GNU Free
181 Documentation License.  A copy of the license is included in the
182 section entitled ``GNU Free Documentation License''.
183
184 @menu
185 * Overview::                    Overview
186 * Invoking::                    Command-Line Options
187 * Syntax::                      Syntax
188 * Sections::                    Sections and Relocation
189 * Symbols::                     Symbols
190 * Expressions::                 Expressions
191 * Pseudo Ops::                  Assembler Directives
192 @ifset ELF
193 * Object Attributes::           Object Attributes
194 @end ifset
195 * Machine Dependencies::        Machine Dependent Features
196 * Reporting Bugs::              Reporting Bugs
197 * Acknowledgements::            Who Did What
198 * GNU Free Documentation License::  GNU Free Documentation License
199 * AS Index::                    AS Index
200 @end menu
201 @end ifnottex
202
203 @node Overview
204 @chapter Overview
205 @iftex
206 This manual is a user guide to the @sc{gnu} assembler @command{@value{AS}}.
207 @ifclear GENERIC
208 This version of the manual describes @command{@value{AS}} configured to generate
209 code for @value{TARGET} architectures.
210 @end ifclear
211 @end iftex
212
213 @cindex invocation summary
214 @cindex option summary
215 @cindex summary of options
216 Here is a brief summary of how to invoke @command{@value{AS}}.  For details,
217 see @ref{Invoking,,Command-Line Options}.
218
219 @c man title AS the portable GNU assembler.
220
221 @ignore
222 @c man begin SEEALSO
223 gcc(1), ld(1), and the Info entries for @file{binutils} and @file{ld}.
224 @c man end
225 @end ignore
226
227 @c We don't use deffn and friends for the following because they seem
228 @c to be limited to one line for the header.
229 @smallexample
230 @c man begin SYNOPSIS
231 @value{AS} [@b{-a}[@b{cdghlns}][=@var{file}]] [@b{--alternate}] [@b{-D}]
232  [@b{--debug-prefix-map} @var{old}=@var{new}]
233  [@b{--defsym} @var{sym}=@var{val}] [@b{-f}] [@b{-g}] [@b{--gstabs}]
234  [@b{--gstabs+}] [@b{--gdwarf-2}] [@b{--help}] [@b{-I} @var{dir}] [@b{-J}]
235  [@b{-K}] [@b{-L}] [@b{--listing-lhs-width}=@var{NUM}]
236  [@b{--listing-lhs-width2}=@var{NUM}] [@b{--listing-rhs-width}=@var{NUM}]
237  [@b{--listing-cont-lines}=@var{NUM}] [@b{--keep-locals}] [@b{-o}
238  @var{objfile}] [@b{-R}] [@b{--reduce-memory-overheads}] [@b{--statistics}]
239  [@b{-v}] [@b{-version}] [@b{--version}] [@b{-W}] [@b{--warn}]
240  [@b{--fatal-warnings}] [@b{-w}] [@b{-x}] [@b{-Z}] [@b{@@@var{FILE}}]
241  [@b{--target-help}] [@var{target-options}]
242  [@b{--}|@var{files} @dots{}]
243 @c
244 @c Target dependent options are listed below.  Keep the list sorted.
245 @c Add an empty line for separation. 
246 @ifset ALPHA
247
248 @emph{Target Alpha options:}
249    [@b{-m@var{cpu}}]
250    [@b{-mdebug} | @b{-no-mdebug}]
251    [@b{-replace} | @b{-noreplace}]
252    [@b{-relax}] [@b{-g}] [@b{-G@var{size}}]
253    [@b{-F}] [@b{-32addr}]
254 @end ifset
255 @ifset ARC
256
257 @emph{Target ARC options:}
258    [@b{-marc[5|6|7|8]}]
259    [@b{-EB}|@b{-EL}]
260 @end ifset
261 @ifset ARM
262
263 @emph{Target ARM options:}
264 @c Don't document the deprecated options
265    [@b{-mcpu}=@var{processor}[+@var{extension}@dots{}]]
266    [@b{-march}=@var{architecture}[+@var{extension}@dots{}]]
267    [@b{-mfpu}=@var{floating-point-format}]
268    [@b{-mfloat-abi}=@var{abi}]
269    [@b{-meabi}=@var{ver}]
270    [@b{-mthumb}]
271    [@b{-EB}|@b{-EL}]
272    [@b{-mapcs-32}|@b{-mapcs-26}|@b{-mapcs-float}|
273     @b{-mapcs-reentrant}]
274    [@b{-mthumb-interwork}] [@b{-k}]
275 @end ifset
276 @ifset CRIS
277
278 @emph{Target CRIS options:}
279    [@b{--underscore} | @b{--no-underscore}]
280    [@b{--pic}] [@b{-N}]
281    [@b{--emulation=criself} | @b{--emulation=crisaout}]
282    [@b{--march=v0_v10} | @b{--march=v10} | @b{--march=v32} | @b{--march=common_v10_v32}]
283 @c Deprecated -- deliberately not documented.
284 @c [@b{-h}] [@b{-H}]
285 @end ifset
286 @ifset D10V
287
288 @emph{Target D10V options:}
289    [@b{-O}]
290 @end ifset
291 @ifset D30V
292
293 @emph{Target D30V options:}
294    [@b{-O}|@b{-n}|@b{-N}]
295 @end ifset
296 @ifset H8
297
298 @emph{Target H8/300 options:}
299    [-h-tick-hex]
300 @end ifset
301 @ifset HPPA
302 @c HPPA has no machine-dependent assembler options (yet).
303 @end ifset
304 @ifset I80386
305
306 @emph{Target i386 options:}
307    [@b{--32}|@b{--64}] [@b{-n}]
308    [@b{-march}=@var{CPU}[+@var{EXTENSION}@dots{}]] [@b{-mtune}=@var{CPU}]
309 @end ifset
310 @ifset I960
311
312 @emph{Target i960 options:}
313 @c see md_parse_option in tc-i960.c
314    [@b{-ACA}|@b{-ACA_A}|@b{-ACB}|@b{-ACC}|@b{-AKA}|@b{-AKB}|
315     @b{-AKC}|@b{-AMC}]
316    [@b{-b}] [@b{-no-relax}]
317 @end ifset
318 @ifset IA64
319
320 @emph{Target IA-64 options:}
321    [@b{-mconstant-gp}|@b{-mauto-pic}]
322    [@b{-milp32}|@b{-milp64}|@b{-mlp64}|@b{-mp64}]
323    [@b{-mle}|@b{mbe}]
324    [@b{-mtune=itanium1}|@b{-mtune=itanium2}]
325    [@b{-munwind-check=warning}|@b{-munwind-check=error}]
326    [@b{-mhint.b=ok}|@b{-mhint.b=warning}|@b{-mhint.b=error}]
327    [@b{-x}|@b{-xexplicit}] [@b{-xauto}] [@b{-xdebug}]
328 @end ifset
329 @ifset IP2K
330
331 @emph{Target IP2K options:}
332    [@b{-mip2022}|@b{-mip2022ext}]
333 @end ifset
334 @ifset M32C
335
336 @emph{Target M32C options:}
337    [@b{-m32c}|@b{-m16c}] [-relax] [-h-tick-hex]
338 @end ifset
339 @ifset M32R
340
341 @emph{Target M32R options:}
342    [@b{--m32rx}|@b{--[no-]warn-explicit-parallel-conflicts}|
343    @b{--W[n]p}]
344 @end ifset
345 @ifset M680X0
346
347 @emph{Target M680X0 options:}
348    [@b{-l}] [@b{-m68000}|@b{-m68010}|@b{-m68020}|@dots{}]
349 @end ifset
350 @ifset M68HC11
351
352 @emph{Target M68HC11 options:}
353    [@b{-m68hc11}|@b{-m68hc12}|@b{-m68hcs12}]
354    [@b{-mshort}|@b{-mlong}]
355    [@b{-mshort-double}|@b{-mlong-double}]
356    [@b{--force-long-branches}] [@b{--short-branches}]
357    [@b{--strict-direct-mode}] [@b{--print-insn-syntax}]
358    [@b{--print-opcodes}] [@b{--generate-example}]
359 @end ifset
360 @ifset MCORE
361
362 @emph{Target MCORE options:}
363    [@b{-jsri2bsr}] [@b{-sifilter}] [@b{-relax}]
364    [@b{-mcpu=[210|340]}]
365 @end ifset
366 @ifset MICROBLAZE
367 @emph{Target MICROBLAZE options:}
368 @c MicroBlaze has no machine-dependent assembler options.
369 @end ifset
370 @ifset MIPS
371
372 @emph{Target MIPS options:}
373    [@b{-nocpp}] [@b{-EL}] [@b{-EB}] [@b{-O}[@var{optimization level}]]
374    [@b{-g}[@var{debug level}]] [@b{-G} @var{num}] [@b{-KPIC}] [@b{-call_shared}]
375    [@b{-non_shared}] [@b{-xgot} [@b{-mvxworks-pic}]
376    [@b{-mabi}=@var{ABI}] [@b{-32}] [@b{-n32}] [@b{-64}] [@b{-mfp32}] [@b{-mgp32}]
377    [@b{-march}=@var{CPU}] [@b{-mtune}=@var{CPU}] [@b{-mips1}] [@b{-mips2}]
378    [@b{-mips3}] [@b{-mips4}] [@b{-mips5}] [@b{-mips32}] [@b{-mips32r2}]
379    [@b{-mips64}] [@b{-mips64r2}]
380    [@b{-construct-floats}] [@b{-no-construct-floats}]
381    [@b{-trap}] [@b{-no-break}] [@b{-break}] [@b{-no-trap}]
382    [@b{-mfix7000}] [@b{-mno-fix7000}]
383    [@b{-mips16}] [@b{-no-mips16}]
384    [@b{-msmartmips}] [@b{-mno-smartmips}]
385    [@b{-mips3d}] [@b{-no-mips3d}]
386    [@b{-mdmx}] [@b{-no-mdmx}]
387    [@b{-mdsp}] [@b{-mno-dsp}]
388    [@b{-mdspr2}] [@b{-mno-dspr2}]
389    [@b{-mmt}] [@b{-mno-mt}]
390    [@b{-mdebug}] [@b{-no-mdebug}]
391    [@b{-mpdr}] [@b{-mno-pdr}]
392 @end ifset
393 @ifset MMIX
394
395 @emph{Target MMIX options:}
396    [@b{--fixed-special-register-names}] [@b{--globalize-symbols}]
397    [@b{--gnu-syntax}] [@b{--relax}] [@b{--no-predefined-symbols}]
398    [@b{--no-expand}] [@b{--no-merge-gregs}] [@b{-x}]
399    [@b{--linker-allocated-gregs}]
400 @end ifset
401 @ifset PDP11
402
403 @emph{Target PDP11 options:}
404    [@b{-mpic}|@b{-mno-pic}] [@b{-mall}] [@b{-mno-extensions}]
405    [@b{-m}@var{extension}|@b{-mno-}@var{extension}]
406    [@b{-m}@var{cpu}] [@b{-m}@var{machine}]  
407 @end ifset
408 @ifset PJ
409
410 @emph{Target picoJava options:}
411    [@b{-mb}|@b{-me}]
412 @end ifset
413 @ifset PPC
414
415 @emph{Target PowerPC options:}
416    [@b{-mpwrx}|@b{-mpwr2}|@b{-mpwr}|@b{-m601}|@b{-mppc}|@b{-mppc32}|@b{-m603}|@b{-m604}|
417     @b{-m403}|@b{-m405}|@b{-mppc64}|@b{-m620}|@b{-mppc64bridge}|@b{-mbooke}]
418    [@b{-mcom}|@b{-many}|@b{-maltivec}|@b{-mvsx}] [@b{-memb}]
419    [@b{-mregnames}|@b{-mno-regnames}]
420    [@b{-mrelocatable}|@b{-mrelocatable-lib}]
421    [@b{-mlittle}|@b{-mlittle-endian}|@b{-mbig}|@b{-mbig-endian}]
422    [@b{-msolaris}|@b{-mno-solaris}]
423 @end ifset
424 @ifset S390
425
426 @emph{Target s390 options:}
427    [@b{-m31}|@b{-m64}] [@b{-mesa}|@b{-mzarch}] [@b{-march}=@var{CPU}]
428    [@b{-mregnames}|@b{-mno-regnames}]
429    [@b{-mwarn-areg-zero}]
430 @end ifset
431 @ifset SCORE
432
433 @emph{Target SCORE options:}
434    [@b{-EB}][@b{-EL}][@b{-FIXDD}][@b{-NWARN}]
435    [@b{-SCORE5}][@b{-SCORE5U}][@b{-SCORE7}][@b{-SCORE3}]
436    [@b{-march=score7}][@b{-march=score3}]
437    [@b{-USE_R1}][@b{-KPIC}][@b{-O0}][@b{-G} @var{num}][@b{-V}]
438 @end ifset
439 @ifset SPARC
440
441 @emph{Target SPARC options:}
442 @c The order here is important.  See c-sparc.texi.
443    [@b{-Av6}|@b{-Av7}|@b{-Av8}|@b{-Asparclet}|@b{-Asparclite}
444     @b{-Av8plus}|@b{-Av8plusa}|@b{-Av9}|@b{-Av9a}]
445    [@b{-xarch=v8plus}|@b{-xarch=v8plusa}] [@b{-bump}]
446    [@b{-32}|@b{-64}]
447 @end ifset
448 @ifset TIC54X
449
450 @emph{Target TIC54X options:}
451  [@b{-mcpu=54[123589]}|@b{-mcpu=54[56]lp}] [@b{-mfar-mode}|@b{-mf}] 
452  [@b{-merrors-to-file} @var{<filename>}|@b{-me} @var{<filename>}]
453 @end ifset
454
455 @ifset Z80
456
457 @emph{Target Z80 options:}
458   [@b{-z80}] [@b{-r800}]
459   [@b{ -ignore-undocumented-instructions}] [@b{-Wnud}]
460   [@b{ -ignore-unportable-instructions}] [@b{-Wnup}]
461   [@b{ -warn-undocumented-instructions}] [@b{-Wud}]
462   [@b{ -warn-unportable-instructions}] [@b{-Wup}]
463   [@b{ -forbid-undocumented-instructions}] [@b{-Fud}]
464   [@b{ -forbid-unportable-instructions}] [@b{-Fup}]
465 @end ifset
466
467 @ifset Z8000
468 @c Z8000 has no machine-dependent assembler options
469 @end ifset
470 @ifset XTENSA
471
472 @emph{Target Xtensa options:}
473  [@b{--[no-]text-section-literals}] [@b{--[no-]absolute-literals}]
474  [@b{--[no-]target-align}] [@b{--[no-]longcalls}]
475  [@b{--[no-]transform}]
476  [@b{--rename-section} @var{oldname}=@var{newname}]
477 @end ifset
478 @c man end
479 @end smallexample
480
481 @c man begin OPTIONS
482
483 @table @gcctabopt
484 @include at-file.texi
485
486 @item -a[cdghlmns]
487 Turn on listings, in any of a variety of ways:
488
489 @table @gcctabopt
490 @item -ac
491 omit false conditionals
492
493 @item -ad
494 omit debugging directives
495
496 @item -ag
497 include general information, like @value{AS} version and options passed
498
499 @item -ah
500 include high-level source
501
502 @item -al
503 include assembly
504
505 @item -am
506 include macro expansions
507
508 @item -an
509 omit forms processing
510
511 @item -as
512 include symbols
513
514 @item =file
515 set the name of the listing file
516 @end table
517
518 You may combine these options; for example, use @samp{-aln} for assembly
519 listing without forms processing.  The @samp{=file} option, if used, must be
520 the last one.  By itself, @samp{-a} defaults to @samp{-ahls}.
521
522 @item --alternate
523 Begin in alternate macro mode.
524 @ifclear man
525 @xref{Altmacro,,@code{.altmacro}}.
526 @end ifclear
527
528 @item -D
529 Ignored.  This option is accepted for script compatibility with calls to
530 other assemblers.
531
532 @item --debug-prefix-map @var{old}=@var{new}
533 When assembling files in directory @file{@var{old}}, record debugging
534 information describing them as in @file{@var{new}} instead.
535
536 @item --defsym @var{sym}=@var{value}
537 Define the symbol @var{sym} to be @var{value} before assembling the input file.
538 @var{value} must be an integer constant.  As in C, a leading @samp{0x}
539 indicates a hexadecimal value, and a leading @samp{0} indicates an octal
540 value.  The value of the symbol can be overridden inside a source file via the
541 use of a @code{.set} pseudo-op.
542
543 @item -f
544 ``fast''---skip whitespace and comment preprocessing (assume source is
545 compiler output).
546
547 @item -g
548 @itemx --gen-debug
549 Generate debugging information for each assembler source line using whichever
550 debug format is preferred by the target.  This currently means either STABS,
551 ECOFF or DWARF2.
552
553 @item --gstabs
554 Generate stabs debugging information for each assembler line.  This
555 may help debugging assembler code, if the debugger can handle it.
556
557 @item --gstabs+
558 Generate stabs debugging information for each assembler line, with GNU
559 extensions that probably only gdb can handle, and that could make other
560 debuggers crash or refuse to read your program.  This
561 may help debugging assembler code.  Currently the only GNU extension is
562 the location of the current working directory at assembling time.
563
564 @item --gdwarf-2
565 Generate DWARF2 debugging information for each assembler line.  This
566 may help debugging assembler code, if the debugger can handle it.  Note---this
567 option is only supported by some targets, not all of them.
568
569 @item --help
570 Print a summary of the command line options and exit.
571
572 @item --target-help
573 Print a summary of all target specific options and exit.
574
575 @item -I @var{dir}
576 Add directory @var{dir} to the search list for @code{.include} directives.
577
578 @item -J
579 Don't warn about signed overflow.
580
581 @item -K
582 @ifclear DIFF-TBL-KLUGE
583 This option is accepted but has no effect on the @value{TARGET} family.
584 @end ifclear
585 @ifset DIFF-TBL-KLUGE
586 Issue warnings when difference tables altered for long displacements.
587 @end ifset
588
589 @item -L
590 @itemx --keep-locals
591 Keep (in the symbol table) local symbols.  These symbols start with
592 system-specific local label prefixes, typically @samp{.L} for ELF systems
593 or @samp{L} for traditional a.out systems.
594 @ifclear man
595 @xref{Symbol Names}.
596 @end ifclear
597
598 @item --listing-lhs-width=@var{number}
599 Set the maximum width, in words, of the output data column for an assembler
600 listing to @var{number}.
601
602 @item --listing-lhs-width2=@var{number}
603 Set the maximum width, in words, of the output data column for continuation
604 lines in an assembler listing to @var{number}.
605
606 @item --listing-rhs-width=@var{number}
607 Set the maximum width of an input source line, as displayed in a listing, to
608 @var{number} bytes.
609
610 @item --listing-cont-lines=@var{number}
611 Set the maximum number of lines printed in a listing for a single line of input
612 to @var{number} + 1.
613
614 @item -o @var{objfile}
615 Name the object-file output from @command{@value{AS}} @var{objfile}.
616
617 @item -R
618 Fold the data section into the text section.
619
620 @kindex --hash-size=@var{number}
621 Set the default size of GAS's hash tables to a prime number close to
622 @var{number}.  Increasing this value can reduce the length of time it takes the
623 assembler to perform its tasks, at the expense of increasing the assembler's
624 memory requirements.  Similarly reducing this value can reduce the memory
625 requirements at the expense of speed.
626
627 @item --reduce-memory-overheads
628 This option reduces GAS's memory requirements, at the expense of making the
629 assembly processes slower.  Currently this switch is a synonym for
630 @samp{--hash-size=4051}, but in the future it may have other effects as well.
631
632 @item --statistics
633 Print the maximum space (in bytes) and total time (in seconds) used by
634 assembly.
635
636 @item --strip-local-absolute
637 Remove local absolute symbols from the outgoing symbol table.
638
639 @item -v
640 @itemx -version
641 Print the @command{as} version.
642
643 @item --version
644 Print the @command{as} version and exit.
645
646 @item -W
647 @itemx --no-warn
648 Suppress warning messages.
649
650 @item --fatal-warnings
651 Treat warnings as errors.
652
653 @item --warn
654 Don't suppress warning messages or treat them as errors.
655
656 @item -w
657 Ignored.
658
659 @item -x
660 Ignored.
661
662 @item -Z
663 Generate an object file even after errors.
664
665 @item -- | @var{files} @dots{}
666 Standard input, or source files to assemble.
667
668 @end table
669
670 @ifset ARC
671 The following options are available when @value{AS} is configured for
672 an ARC processor.
673
674 @table @gcctabopt
675 @item -marc[5|6|7|8]
676 This option selects the core processor variant.
677 @item -EB | -EL
678 Select either big-endian (-EB) or little-endian (-EL) output.
679 @end table
680 @end ifset
681
682 @ifset ARM
683 The following options are available when @value{AS} is configured for the ARM
684 processor family.
685
686 @table @gcctabopt
687 @item -mcpu=@var{processor}[+@var{extension}@dots{}]
688 Specify which ARM processor variant is the target.
689 @item -march=@var{architecture}[+@var{extension}@dots{}]
690 Specify which ARM architecture variant is used by the target.
691 @item -mfpu=@var{floating-point-format}
692 Select which Floating Point architecture is the target.
693 @item -mfloat-abi=@var{abi}
694 Select which floating point ABI is in use.
695 @item -mthumb
696 Enable Thumb only instruction decoding.
697 @item -mapcs-32 | -mapcs-26 | -mapcs-float | -mapcs-reentrant
698 Select which procedure calling convention is in use.
699 @item -EB | -EL
700 Select either big-endian (-EB) or little-endian (-EL) output.
701 @item -mthumb-interwork
702 Specify that the code has been generated with interworking between Thumb and
703 ARM code in mind.
704 @item -k
705 Specify that PIC code has been generated.
706 @end table
707 @end ifset
708
709 @ifset CRIS
710 See the info pages for documentation of the CRIS-specific options.
711 @end ifset
712
713 @ifset D10V
714 The following options are available when @value{AS} is configured for
715 a D10V processor.
716 @table @gcctabopt
717 @cindex D10V optimization
718 @cindex optimization, D10V
719 @item -O
720 Optimize output by parallelizing instructions.
721 @end table
722 @end ifset
723
724 @ifset D30V
725 The following options are available when @value{AS} is configured for a D30V
726 processor.
727 @table @gcctabopt
728 @cindex D30V optimization
729 @cindex optimization, D30V
730 @item -O
731 Optimize output by parallelizing instructions.
732
733 @cindex D30V nops
734 @item -n
735 Warn when nops are generated.
736
737 @cindex D30V nops after 32-bit multiply
738 @item -N
739 Warn when a nop after a 32-bit multiply instruction is generated.
740 @end table
741 @end ifset
742
743 @ifset I960
744 The following options are available when @value{AS} is configured for the
745 Intel 80960 processor.
746
747 @table @gcctabopt
748 @item -ACA | -ACA_A | -ACB | -ACC | -AKA | -AKB | -AKC | -AMC
749 Specify which variant of the 960 architecture is the target.
750
751 @item -b
752 Add code to collect statistics about branches taken.
753
754 @item -no-relax
755 Do not alter compare-and-branch instructions for long displacements;
756 error if necessary.
757
758 @end table
759 @end ifset
760
761 @ifset IP2K
762 The following options are available when @value{AS} is configured for the
763 Ubicom IP2K series.
764
765 @table @gcctabopt
766
767 @item -mip2022ext
768 Specifies that the extended IP2022 instructions are allowed.
769
770 @item -mip2022
771 Restores the default behaviour, which restricts the permitted instructions to
772 just the basic IP2022 ones.
773
774 @end table
775 @end ifset
776
777 @ifset M32C
778 The following options are available when @value{AS} is configured for the
779 Renesas M32C and M16C processors.
780
781 @table @gcctabopt
782
783 @item -m32c
784 Assemble M32C instructions.
785
786 @item -m16c
787 Assemble M16C instructions (the default).
788
789 @item -relax
790 Enable support for link-time relaxations.
791
792 @item -h-tick-hex
793 Support H'00 style hex constants in addition to 0x00 style.
794
795 @end table
796 @end ifset
797
798 @ifset M32R
799 The following options are available when @value{AS} is configured for the
800 Renesas M32R (formerly Mitsubishi M32R) series.
801
802 @table @gcctabopt
803
804 @item --m32rx
805 Specify which processor in the M32R family is the target.  The default
806 is normally the M32R, but this option changes it to the M32RX.
807
808 @item --warn-explicit-parallel-conflicts or --Wp
809 Produce warning messages when questionable parallel constructs are
810 encountered. 
811
812 @item --no-warn-explicit-parallel-conflicts or --Wnp
813 Do not produce warning messages when questionable parallel constructs are 
814 encountered. 
815
816 @end table
817 @end ifset
818
819 @ifset M680X0
820 The following options are available when @value{AS} is configured for the
821 Motorola 68000 series.
822
823 @table @gcctabopt
824
825 @item -l
826 Shorten references to undefined symbols, to one word instead of two.
827
828 @item -m68000 | -m68008 | -m68010 | -m68020 | -m68030
829 @itemx | -m68040 | -m68060 | -m68302 | -m68331 | -m68332
830 @itemx | -m68333 | -m68340 | -mcpu32 | -m5200
831 Specify what processor in the 68000 family is the target.  The default
832 is normally the 68020, but this can be changed at configuration time.
833
834 @item -m68881 | -m68882 | -mno-68881 | -mno-68882
835 The target machine does (or does not) have a floating-point coprocessor.
836 The default is to assume a coprocessor for 68020, 68030, and cpu32.  Although
837 the basic 68000 is not compatible with the 68881, a combination of the
838 two can be specified, since it's possible to do emulation of the
839 coprocessor instructions with the main processor.
840
841 @item -m68851 | -mno-68851
842 The target machine does (or does not) have a memory-management
843 unit coprocessor.  The default is to assume an MMU for 68020 and up.
844
845 @end table
846 @end ifset
847
848 @ifset PDP11
849
850 For details about the PDP-11 machine dependent features options,
851 see @ref{PDP-11-Options}.
852
853 @table @gcctabopt
854 @item -mpic | -mno-pic
855 Generate position-independent (or position-dependent) code.  The
856 default is @option{-mpic}.
857
858 @item -mall
859 @itemx -mall-extensions
860 Enable all instruction set extensions.  This is the default.
861
862 @item -mno-extensions
863 Disable all instruction set extensions.
864
865 @item -m@var{extension} | -mno-@var{extension}
866 Enable (or disable) a particular instruction set extension.
867
868 @item -m@var{cpu}
869 Enable the instruction set extensions supported by a particular CPU, and
870 disable all other extensions.
871
872 @item -m@var{machine}
873 Enable the instruction set extensions supported by a particular machine
874 model, and disable all other extensions.
875 @end table
876
877 @end ifset
878
879 @ifset PJ
880 The following options are available when @value{AS} is configured for
881 a picoJava processor.
882
883 @table @gcctabopt
884
885 @cindex PJ endianness
886 @cindex endianness, PJ
887 @cindex big endian output, PJ
888 @item -mb
889 Generate ``big endian'' format output.
890
891 @cindex little endian output, PJ
892 @item -ml
893 Generate ``little endian'' format output.
894
895 @end table
896 @end ifset
897
898 @ifset M68HC11
899 The following options are available when @value{AS} is configured for the
900 Motorola 68HC11 or 68HC12 series.
901
902 @table @gcctabopt
903
904 @item -m68hc11 | -m68hc12 | -m68hcs12
905 Specify what processor is the target.  The default is
906 defined by the configuration option when building the assembler.
907
908 @item -mshort
909 Specify to use the 16-bit integer ABI.
910
911 @item -mlong
912 Specify to use the 32-bit integer ABI.  
913
914 @item -mshort-double
915 Specify to use the 32-bit double ABI.  
916
917 @item -mlong-double
918 Specify to use the 64-bit double ABI.  
919
920 @item --force-long-branches
921 Relative branches are turned into absolute ones. This concerns
922 conditional branches, unconditional branches and branches to a
923 sub routine.
924
925 @item -S | --short-branches
926 Do not turn relative branches into absolute ones
927 when the offset is out of range.
928
929 @item --strict-direct-mode
930 Do not turn the direct addressing mode into extended addressing mode
931 when the instruction does not support direct addressing mode.
932
933 @item --print-insn-syntax
934 Print the syntax of instruction in case of error.
935
936 @item --print-opcodes
937 print the list of instructions with syntax and then exit.
938
939 @item --generate-example
940 print an example of instruction for each possible instruction and then exit.
941 This option is only useful for testing @command{@value{AS}}.
942
943 @end table
944 @end ifset
945
946 @ifset SPARC
947 The following options are available when @command{@value{AS}} is configured
948 for the SPARC architecture:
949
950 @table @gcctabopt
951 @item -Av6 | -Av7 | -Av8 | -Asparclet | -Asparclite
952 @itemx -Av8plus | -Av8plusa | -Av9 | -Av9a
953 Explicitly select a variant of the SPARC architecture.
954
955 @samp{-Av8plus} and @samp{-Av8plusa} select a 32 bit environment.
956 @samp{-Av9} and @samp{-Av9a} select a 64 bit environment.
957
958 @samp{-Av8plusa} and @samp{-Av9a} enable the SPARC V9 instruction set with
959 UltraSPARC extensions.
960
961 @item -xarch=v8plus | -xarch=v8plusa
962 For compatibility with the Solaris v9 assembler.  These options are
963 equivalent to -Av8plus and -Av8plusa, respectively.
964
965 @item -bump
966 Warn when the assembler switches to another architecture.
967 @end table
968 @end ifset
969
970 @ifset TIC54X
971 The following options are available when @value{AS} is configured for the 'c54x
972 architecture. 
973
974 @table @gcctabopt
975 @item -mfar-mode
976 Enable extended addressing mode.  All addresses and relocations will assume
977 extended addressing (usually 23 bits).
978 @item -mcpu=@var{CPU_VERSION}
979 Sets the CPU version being compiled for.
980 @item -merrors-to-file @var{FILENAME}
981 Redirect error output to a file, for broken systems which don't support such
982 behaviour in the shell.
983 @end table
984 @end ifset
985
986 @ifset MIPS
987 The following options are available when @value{AS} is configured for
988 a @sc{mips} processor.
989
990 @table @gcctabopt
991 @item -G @var{num}
992 This option sets the largest size of an object that can be referenced
993 implicitly with the @code{gp} register.  It is only accepted for targets that
994 use ECOFF format, such as a DECstation running Ultrix.  The default value is 8.
995
996 @cindex MIPS endianness
997 @cindex endianness, MIPS
998 @cindex big endian output, MIPS
999 @item -EB
1000 Generate ``big endian'' format output.
1001
1002 @cindex little endian output, MIPS
1003 @item -EL
1004 Generate ``little endian'' format output.
1005
1006 @cindex MIPS ISA
1007 @item -mips1
1008 @itemx -mips2
1009 @itemx -mips3
1010 @itemx -mips4
1011 @itemx -mips5
1012 @itemx -mips32
1013 @itemx -mips32r2
1014 @itemx -mips64
1015 @itemx -mips64r2
1016 Generate code for a particular @sc{mips} Instruction Set Architecture level.
1017 @samp{-mips1} is an alias for @samp{-march=r3000}, @samp{-mips2} is an
1018 alias for @samp{-march=r6000}, @samp{-mips3} is an alias for
1019 @samp{-march=r4000} and @samp{-mips4} is an alias for @samp{-march=r8000}.
1020 @samp{-mips5}, @samp{-mips32}, @samp{-mips32r2}, @samp{-mips64}, and
1021 @samp{-mips64r2}
1022 correspond to generic
1023 @samp{MIPS V}, @samp{MIPS32}, @samp{MIPS32 Release 2}, @samp{MIPS64},
1024 and @samp{MIPS64 Release 2}
1025 ISA processors, respectively.
1026
1027 @item -march=@var{CPU}
1028 Generate code for a particular @sc{mips} cpu.
1029
1030 @item -mtune=@var{cpu}
1031 Schedule and tune for a particular @sc{mips} cpu.
1032
1033 @item -mfix7000
1034 @itemx -mno-fix7000
1035 Cause nops to be inserted if the read of the destination register
1036 of an mfhi or mflo instruction occurs in the following two instructions.
1037
1038 @item -mdebug
1039 @itemx -no-mdebug
1040 Cause stabs-style debugging output to go into an ECOFF-style .mdebug
1041 section instead of the standard ELF .stabs sections.
1042
1043 @item -mpdr
1044 @itemx -mno-pdr
1045 Control generation of @code{.pdr} sections.
1046
1047 @item -mgp32
1048 @itemx -mfp32
1049 The register sizes are normally inferred from the ISA and ABI, but these
1050 flags force a certain group of registers to be treated as 32 bits wide at
1051 all times.  @samp{-mgp32} controls the size of general-purpose registers
1052 and @samp{-mfp32} controls the size of floating-point registers.
1053
1054 @item -mips16
1055 @itemx -no-mips16
1056 Generate code for the MIPS 16 processor.  This is equivalent to putting
1057 @code{.set mips16} at the start of the assembly file.  @samp{-no-mips16}
1058 turns off this option.
1059
1060 @item -msmartmips
1061 @itemx -mno-smartmips
1062 Enables the SmartMIPS extension to the MIPS32 instruction set. This is
1063 equivalent to putting @code{.set smartmips} at the start of the assembly file.
1064 @samp{-mno-smartmips} turns off this option.
1065
1066 @item -mips3d
1067 @itemx -no-mips3d
1068 Generate code for the MIPS-3D Application Specific Extension.
1069 This tells the assembler to accept MIPS-3D instructions.
1070 @samp{-no-mips3d} turns off this option.
1071
1072 @item -mdmx
1073 @itemx -no-mdmx
1074 Generate code for the MDMX Application Specific Extension.
1075 This tells the assembler to accept MDMX instructions.
1076 @samp{-no-mdmx} turns off this option.
1077
1078 @item -mdsp
1079 @itemx -mno-dsp
1080 Generate code for the DSP Release 1 Application Specific Extension.
1081 This tells the assembler to accept DSP Release 1 instructions.
1082 @samp{-mno-dsp} turns off this option.
1083
1084 @item -mdspr2
1085 @itemx -mno-dspr2
1086 Generate code for the DSP Release 2 Application Specific Extension.
1087 This option implies -mdsp.
1088 This tells the assembler to accept DSP Release 2 instructions.
1089 @samp{-mno-dspr2} turns off this option.
1090
1091 @item -mmt
1092 @itemx -mno-mt
1093 Generate code for the MT Application Specific Extension.
1094 This tells the assembler to accept MT instructions.
1095 @samp{-mno-mt} turns off this option.
1096
1097 @item --construct-floats
1098 @itemx --no-construct-floats
1099 The @samp{--no-construct-floats} option disables the construction of
1100 double width floating point constants by loading the two halves of the
1101 value into the two single width floating point registers that make up
1102 the double width register.  By default @samp{--construct-floats} is
1103 selected, allowing construction of these floating point constants.
1104
1105 @cindex emulation
1106 @item --emulation=@var{name}
1107 This option causes @command{@value{AS}} to emulate @command{@value{AS}} configured
1108 for some other target, in all respects, including output format (choosing
1109 between ELF and ECOFF only), handling of pseudo-opcodes which may generate
1110 debugging information or store symbol table information, and default
1111 endianness.  The available configuration names are: @samp{mipsecoff},
1112 @samp{mipself}, @samp{mipslecoff}, @samp{mipsbecoff}, @samp{mipslelf},
1113 @samp{mipsbelf}.  The first two do not alter the default endianness from that
1114 of the primary target for which the assembler was configured; the others change
1115 the default to little- or big-endian as indicated by the @samp{b} or @samp{l}
1116 in the name.  Using @samp{-EB} or @samp{-EL} will override the endianness
1117 selection in any case.
1118
1119 This option is currently supported only when the primary target
1120 @command{@value{AS}} is configured for is a @sc{mips} ELF or ECOFF target.
1121 Furthermore, the primary target or others specified with
1122 @samp{--enable-targets=@dots{}} at configuration time must include support for
1123 the other format, if both are to be available.  For example, the Irix 5
1124 configuration includes support for both.
1125
1126 Eventually, this option will support more configurations, with more
1127 fine-grained control over the assembler's behavior, and will be supported for
1128 more processors.
1129
1130 @item -nocpp
1131 @command{@value{AS}} ignores this option.  It is accepted for compatibility with
1132 the native tools.
1133
1134 @item --trap
1135 @itemx --no-trap
1136 @itemx --break
1137 @itemx --no-break
1138 Control how to deal with multiplication overflow and division by zero.
1139 @samp{--trap} or @samp{--no-break} (which are synonyms) take a trap exception
1140 (and only work for Instruction Set Architecture level 2 and higher);
1141 @samp{--break} or @samp{--no-trap} (also synonyms, and the default) take a
1142 break exception.
1143
1144 @item -n
1145 When this option is used, @command{@value{AS}} will issue a warning every
1146 time it generates a nop instruction from a macro.
1147 @end table
1148 @end ifset
1149
1150 @ifset MCORE
1151 The following options are available when @value{AS} is configured for
1152 an MCore processor.
1153
1154 @table @gcctabopt
1155 @item -jsri2bsr
1156 @itemx -nojsri2bsr
1157 Enable or disable the JSRI to BSR transformation.  By default this is enabled.
1158 The command line option @samp{-nojsri2bsr} can be used to disable it.
1159
1160 @item -sifilter
1161 @itemx -nosifilter
1162 Enable or disable the silicon filter behaviour.  By default this is disabled.
1163 The default can be overridden by the @samp{-sifilter} command line option.
1164
1165 @item -relax
1166 Alter jump instructions for long displacements.
1167
1168 @item -mcpu=[210|340]
1169 Select the cpu type on the target hardware.  This controls which instructions
1170 can be assembled.
1171
1172 @item -EB
1173 Assemble for a big endian target.
1174
1175 @item -EL
1176 Assemble for a little endian target.
1177
1178 @end table
1179 @end ifset
1180
1181 @ifset MMIX
1182 See the info pages for documentation of the MMIX-specific options.
1183 @end ifset
1184
1185 @ifset S390
1186 The following options are available when @value{AS} is configured for the s390
1187 processor family.
1188
1189 @table @gcctabopt
1190 @item -m31
1191 @itemx -m64
1192 Select the word size, either 31/32 bits or 64 bits.
1193 @item -mesa
1194 @item -mzarch
1195 Select the architecture mode, either the Enterprise System
1196 Architecture (esa) or the z/Architecture mode (zarch).
1197 @item -march=@var{processor}
1198 Specify which s390 processor variant is the target, @samp{g6}, @samp{g6},
1199 @samp{z900}, @samp{z990}, @samp{z9-109}, @samp{z9-ec}, or @samp{z10}.
1200 @item -mregnames
1201 @itemx -mno-regnames
1202 Allow or disallow symbolic names for registers.
1203 @item -mwarn-areg-zero
1204 Warn whenever the operand for a base or index register has been specified
1205 but evaluates to zero.
1206 @end table
1207 @end ifset
1208
1209 @ifset XTENSA
1210 The following options are available when @value{AS} is configured for
1211 an Xtensa processor.
1212
1213 @table @gcctabopt
1214 @item --text-section-literals | --no-text-section-literals
1215 With @option{--text-@-section-@-literals}, literal pools are interspersed
1216 in the text section.  The default is
1217 @option{--no-@-text-@-section-@-literals}, which places literals in a
1218 separate section in the output file.  These options only affect literals
1219 referenced via PC-relative @code{L32R} instructions; literals for
1220 absolute mode @code{L32R} instructions are handled separately.
1221
1222 @item --absolute-literals | --no-absolute-literals
1223 Indicate to the assembler whether @code{L32R} instructions use absolute
1224 or PC-relative addressing.  The default is to assume absolute addressing
1225 if the Xtensa processor includes the absolute @code{L32R} addressing
1226 option.  Otherwise, only the PC-relative @code{L32R} mode can be used.
1227
1228 @item --target-align | --no-target-align
1229 Enable or disable automatic alignment to reduce branch penalties at the
1230 expense of some code density.  The default is @option{--target-@-align}.
1231
1232 @item --longcalls | --no-longcalls
1233 Enable or disable transformation of call instructions to allow calls
1234 across a greater range of addresses.  The default is
1235 @option{--no-@-longcalls}.
1236
1237 @item --transform | --no-transform
1238 Enable or disable all assembler transformations of Xtensa instructions.
1239 The default is @option{--transform};
1240 @option{--no-transform} should be used only in the rare cases when the
1241 instructions must be exactly as specified in the assembly source.
1242
1243 @item --rename-section @var{oldname}=@var{newname}
1244 When generating output sections, rename the @var{oldname} section to
1245 @var{newname}.
1246 @end table
1247 @end ifset
1248
1249 @ifset Z80
1250 The following options are available when @value{AS} is configured for
1251 a Z80 family processor.
1252 @table @gcctabopt
1253 @item -z80
1254 Assemble for Z80 processor.
1255 @item -r800
1256 Assemble for R800 processor.
1257 @item  -ignore-undocumented-instructions 
1258 @itemx -Wnud
1259 Assemble undocumented Z80 instructions that also work on R800 without warning.
1260 @item  -ignore-unportable-instructions 
1261 @itemx -Wnup
1262 Assemble all undocumented Z80 instructions without warning.
1263 @item  -warn-undocumented-instructions 
1264 @itemx -Wud
1265 Issue a warning for undocumented Z80 instructions that also work on R800.
1266 @item  -warn-unportable-instructions 
1267 @itemx -Wup
1268 Issue a warning for undocumented Z80 instructions that do not work on R800.  
1269 @item  -forbid-undocumented-instructions 
1270 @itemx -Fud
1271 Treat all undocumented instructions as errors.
1272 @item  -forbid-unportable-instructions 
1273 @itemx -Fup
1274 Treat undocumented Z80 instructions that do not work on R800 as errors.
1275 @end table
1276 @end ifset
1277
1278 @c man end
1279
1280 @menu
1281 * Manual::                      Structure of this Manual
1282 * GNU Assembler::               The GNU Assembler
1283 * Object Formats::              Object File Formats
1284 * Command Line::                Command Line
1285 * Input Files::                 Input Files
1286 * Object::                      Output (Object) File
1287 * Errors::                      Error and Warning Messages
1288 @end menu
1289
1290 @node Manual
1291 @section Structure of this Manual
1292
1293 @cindex manual, structure and purpose
1294 This manual is intended to describe what you need to know to use
1295 @sc{gnu} @command{@value{AS}}.  We cover the syntax expected in source files, including
1296 notation for symbols, constants, and expressions; the directives that
1297 @command{@value{AS}} understands; and of course how to invoke @command{@value{AS}}.
1298
1299 @ifclear GENERIC
1300 We also cover special features in the @value{TARGET}
1301 configuration of @command{@value{AS}}, including assembler directives.
1302 @end ifclear
1303 @ifset GENERIC
1304 This manual also describes some of the machine-dependent features of
1305 various flavors of the assembler.
1306 @end ifset
1307
1308 @cindex machine instructions (not covered)
1309 On the other hand, this manual is @emph{not} intended as an introduction
1310 to programming in assembly language---let alone programming in general!
1311 In a similar vein, we make no attempt to introduce the machine
1312 architecture; we do @emph{not} describe the instruction set, standard
1313 mnemonics, registers or addressing modes that are standard to a
1314 particular architecture.
1315 @ifset GENERIC
1316 You may want to consult the manufacturer's
1317 machine architecture manual for this information.
1318 @end ifset
1319 @ifclear GENERIC
1320 @ifset H8/300
1321 For information on the H8/300 machine instruction set, see @cite{H8/300
1322 Series Programming Manual}.  For the H8/300H, see @cite{H8/300H Series
1323 Programming Manual} (Renesas).
1324 @end ifset
1325 @ifset SH
1326 For information on the Renesas (formerly Hitachi) / SuperH SH machine instruction set,
1327 see @cite{SH-Microcomputer User's Manual} (Renesas) or
1328 @cite{SH-4 32-bit CPU Core Architecture} (SuperH) and
1329 @cite{SuperH (SH) 64-Bit RISC Series} (SuperH).
1330 @end ifset
1331 @ifset Z8000
1332 For information on the Z8000 machine instruction set, see @cite{Z8000 CPU Technical Manual}
1333 @end ifset
1334 @end ifclear
1335
1336 @c I think this is premature---doc@cygnus.com, 17jan1991
1337 @ignore
1338 Throughout this manual, we assume that you are running @dfn{GNU},
1339 the portable operating system from the @dfn{Free Software
1340 Foundation, Inc.}.  This restricts our attention to certain kinds of
1341 computer (in particular, the kinds of computers that @sc{gnu} can run on);
1342 once this assumption is granted examples and definitions need less
1343 qualification.
1344
1345 @command{@value{AS}} is part of a team of programs that turn a high-level
1346 human-readable series of instructions into a low-level
1347 computer-readable series of instructions.  Different versions of
1348 @command{@value{AS}} are used for different kinds of computer.
1349 @end ignore
1350
1351 @c There used to be a section "Terminology" here, which defined
1352 @c "contents", "byte", "word", and "long".  Defining "word" to any
1353 @c particular size is confusing when the .word directive may generate 16
1354 @c bits on one machine and 32 bits on another; in general, for the user
1355 @c version of this manual, none of these terms seem essential to define.
1356 @c They were used very little even in the former draft of the manual;
1357 @c this draft makes an effort to avoid them (except in names of
1358 @c directives).
1359
1360 @node GNU Assembler
1361 @section The GNU Assembler
1362
1363 @c man begin DESCRIPTION
1364
1365 @sc{gnu} @command{as} is really a family of assemblers.
1366 @ifclear GENERIC
1367 This manual describes @command{@value{AS}}, a member of that family which is
1368 configured for the @value{TARGET} architectures.
1369 @end ifclear
1370 If you use (or have used) the @sc{gnu} assembler on one architecture, you
1371 should find a fairly similar environment when you use it on another
1372 architecture.  Each version has much in common with the others,
1373 including object file formats, most assembler directives (often called
1374 @dfn{pseudo-ops}) and assembler syntax.@refill
1375
1376 @cindex purpose of @sc{gnu} assembler
1377 @command{@value{AS}} is primarily intended to assemble the output of the
1378 @sc{gnu} C compiler @code{@value{GCC}} for use by the linker
1379 @code{@value{LD}}.  Nevertheless, we've tried to make @command{@value{AS}}
1380 assemble correctly everything that other assemblers for the same
1381 machine would assemble.
1382 @ifset VAX
1383 Any exceptions are documented explicitly (@pxref{Machine Dependencies}).
1384 @end ifset
1385 @ifset M680X0
1386 @c This remark should appear in generic version of manual; assumption
1387 @c here is that generic version sets M680x0.
1388 This doesn't mean @command{@value{AS}} always uses the same syntax as another
1389 assembler for the same architecture; for example, we know of several
1390 incompatible versions of 680x0 assembly language syntax.
1391 @end ifset
1392
1393 @c man end
1394
1395 Unlike older assemblers, @command{@value{AS}} is designed to assemble a source
1396 program in one pass of the source file.  This has a subtle impact on the
1397 @kbd{.org} directive (@pxref{Org,,@code{.org}}).
1398
1399 @node Object Formats
1400 @section Object File Formats
1401
1402 @cindex object file format
1403 The @sc{gnu} assembler can be configured to produce several alternative
1404 object file formats.  For the most part, this does not affect how you
1405 write assembly language programs; but directives for debugging symbols
1406 are typically different in different file formats.  @xref{Symbol
1407 Attributes,,Symbol Attributes}.
1408 @ifclear GENERIC
1409 @ifclear MULTI-OBJ
1410 For the @value{TARGET} target, @command{@value{AS}} is configured to produce
1411 @value{OBJ-NAME} format object files.
1412 @end ifclear
1413 @c The following should exhaust all configs that set MULTI-OBJ, ideally
1414 @ifset I960
1415 On the @value{TARGET}, @command{@value{AS}} can be configured to produce either
1416 @code{b.out} or COFF format object files.
1417 @end ifset
1418 @ifset HPPA
1419 On the @value{TARGET}, @command{@value{AS}} can be configured to produce either
1420 SOM or ELF format object files.
1421 @end ifset
1422 @end ifclear
1423
1424 @node Command Line
1425 @section Command Line
1426
1427 @cindex command line conventions
1428
1429 After the program name @command{@value{AS}}, the command line may contain
1430 options and file names.  Options may appear in any order, and may be
1431 before, after, or between file names.  The order of file names is
1432 significant.
1433
1434 @cindex standard input, as input file
1435 @kindex --
1436 @file{--} (two hyphens) by itself names the standard input file
1437 explicitly, as one of the files for @command{@value{AS}} to assemble.
1438
1439 @cindex options, command line
1440 Except for @samp{--} any command line argument that begins with a
1441 hyphen (@samp{-}) is an option.  Each option changes the behavior of
1442 @command{@value{AS}}.  No option changes the way another option works.  An
1443 option is a @samp{-} followed by one or more letters; the case of
1444 the letter is important.   All options are optional.
1445
1446 Some options expect exactly one file name to follow them.  The file
1447 name may either immediately follow the option's letter (compatible
1448 with older assemblers) or it may be the next command argument (@sc{gnu}
1449 standard).  These two command lines are equivalent:
1450
1451 @smallexample
1452 @value{AS} -o my-object-file.o mumble.s
1453 @value{AS} -omy-object-file.o mumble.s
1454 @end smallexample
1455
1456 @node Input Files
1457 @section Input Files
1458
1459 @cindex input
1460 @cindex source program
1461 @cindex files, input
1462 We use the phrase @dfn{source program}, abbreviated @dfn{source}, to
1463 describe the program input to one run of @command{@value{AS}}.  The program may
1464 be in one or more files; how the source is partitioned into files
1465 doesn't change the meaning of the source.
1466
1467 @c I added "con" prefix to "catenation" just to prove I can overcome my
1468 @c APL training...   doc@cygnus.com
1469 The source program is a concatenation of the text in all the files, in the
1470 order specified.
1471
1472 @c man begin DESCRIPTION
1473 Each time you run @command{@value{AS}} it assembles exactly one source
1474 program.  The source program is made up of one or more files.
1475 (The standard input is also a file.)
1476
1477 You give @command{@value{AS}} a command line that has zero or more input file
1478 names.  The input files are read (from left file name to right).  A
1479 command line argument (in any position) that has no special meaning
1480 is taken to be an input file name.
1481
1482 If you give @command{@value{AS}} no file names it attempts to read one input file
1483 from the @command{@value{AS}} standard input, which is normally your terminal.  You
1484 may have to type @key{ctl-D} to tell @command{@value{AS}} there is no more program
1485 to assemble.
1486
1487 Use @samp{--} if you need to explicitly name the standard input file
1488 in your command line.
1489
1490 If the source is empty, @command{@value{AS}} produces a small, empty object
1491 file.
1492
1493 @c man end
1494
1495 @subheading Filenames and Line-numbers
1496
1497 @cindex input file linenumbers
1498 @cindex line numbers, in input files
1499 There are two ways of locating a line in the input file (or files) and
1500 either may be used in reporting error messages.  One way refers to a line
1501 number in a physical file; the other refers to a line number in a
1502 ``logical'' file.  @xref{Errors, ,Error and Warning Messages}.
1503
1504 @dfn{Physical files} are those files named in the command line given
1505 to @command{@value{AS}}.
1506
1507 @dfn{Logical files} are simply names declared explicitly by assembler
1508 directives; they bear no relation to physical files.  Logical file names help
1509 error messages reflect the original source file, when @command{@value{AS}} source
1510 is itself synthesized from other files.  @command{@value{AS}} understands the
1511 @samp{#} directives emitted by the @code{@value{GCC}} preprocessor.  See also
1512 @ref{File,,@code{.file}}.
1513
1514 @node Object
1515 @section Output (Object) File
1516
1517 @cindex object file
1518 @cindex output file
1519 @kindex a.out
1520 @kindex .o
1521 Every time you run @command{@value{AS}} it produces an output file, which is
1522 your assembly language program translated into numbers.  This file
1523 is the object file.  Its default name is
1524 @ifclear BOUT
1525 @code{a.out}.
1526 @end ifclear
1527 @ifset BOUT
1528 @ifset GENERIC
1529 @code{a.out}, or 
1530 @end ifset
1531 @code{b.out} when @command{@value{AS}} is configured for the Intel 80960.
1532 @end ifset
1533 You can give it another name by using the @option{-o} option.  Conventionally,
1534 object file names end with @file{.o}.  The default name is used for historical
1535 reasons: older assemblers were capable of assembling self-contained programs
1536 directly into a runnable program.  (For some formats, this isn't currently
1537 possible, but it can be done for the @code{a.out} format.)
1538
1539 @cindex linker
1540 @kindex ld
1541 The object file is meant for input to the linker @code{@value{LD}}.  It contains
1542 assembled program code, information to help @code{@value{LD}} integrate
1543 the assembled program into a runnable file, and (optionally) symbolic
1544 information for the debugger.
1545
1546 @c link above to some info file(s) like the description of a.out.
1547 @c don't forget to describe @sc{gnu} info as well as Unix lossage.
1548
1549 @node Errors
1550 @section Error and Warning Messages
1551
1552 @c man begin DESCRIPTION
1553
1554 @cindex error messages
1555 @cindex warning messages
1556 @cindex messages from assembler
1557 @command{@value{AS}} may write warnings and error messages to the standard error
1558 file (usually your terminal).  This should not happen when  a compiler
1559 runs @command{@value{AS}} automatically.  Warnings report an assumption made so
1560 that @command{@value{AS}} could keep assembling a flawed program; errors report a
1561 grave problem that stops the assembly.
1562
1563 @c man end
1564
1565 @cindex format of warning messages
1566 Warning messages have the format
1567
1568 @smallexample
1569 file_name:@b{NNN}:Warning Message Text
1570 @end smallexample
1571
1572 @noindent
1573 @cindex line numbers, in warnings/errors
1574 (where @b{NNN} is a line number).  If a logical file name has been given
1575 (@pxref{File,,@code{.file}}) it is used for the filename, otherwise the name of
1576 the current input file is used.  If a logical line number was given
1577 @ifset GENERIC
1578 (@pxref{Line,,@code{.line}})
1579 @end ifset
1580 then it is used to calculate the number printed,
1581 otherwise the actual line in the current source file is printed.  The
1582 message text is intended to be self explanatory (in the grand Unix
1583 tradition).
1584
1585 @cindex format of error messages
1586 Error messages have the format
1587 @smallexample
1588 file_name:@b{NNN}:FATAL:Error Message Text
1589 @end smallexample
1590 The file name and line number are derived as for warning
1591 messages.  The actual message text may be rather less explanatory
1592 because many of them aren't supposed to happen.
1593
1594 @node Invoking
1595 @chapter Command-Line Options
1596
1597 @cindex options, all versions of assembler
1598 This chapter describes command-line options available in @emph{all}
1599 versions of the @sc{gnu} assembler; see @ref{Machine Dependencies},
1600 for options specific
1601 @ifclear GENERIC
1602 to the @value{TARGET} target.
1603 @end ifclear
1604 @ifset GENERIC
1605 to particular machine architectures.
1606 @end ifset
1607
1608 @c man begin DESCRIPTION
1609
1610 If you are invoking @command{@value{AS}} via the @sc{gnu} C compiler,
1611 you can use the @samp{-Wa} option to pass arguments through to the assembler.
1612 The assembler arguments must be separated from each other (and the @samp{-Wa})
1613 by commas.  For example:
1614
1615 @smallexample
1616 gcc -c -g -O -Wa,-alh,-L file.c
1617 @end smallexample
1618
1619 @noindent
1620 This passes two options to the assembler: @samp{-alh} (emit a listing to
1621 standard output with high-level and assembly source) and @samp{-L} (retain
1622 local symbols in the symbol table).
1623
1624 Usually you do not need to use this @samp{-Wa} mechanism, since many compiler
1625 command-line options are automatically passed to the assembler by the compiler.
1626 (You can call the @sc{gnu} compiler driver with the @samp{-v} option to see
1627 precisely what options it passes to each compilation pass, including the
1628 assembler.)
1629
1630 @c man end
1631
1632 @menu
1633 * a::             -a[cdghlns] enable listings
1634 * alternate::     --alternate enable alternate macro syntax
1635 * D::             -D for compatibility
1636 * f::             -f to work faster
1637 * I::             -I for .include search path
1638 @ifclear DIFF-TBL-KLUGE
1639 * K::             -K for compatibility
1640 @end ifclear
1641 @ifset DIFF-TBL-KLUGE
1642 * K::             -K for difference tables
1643 @end ifset
1644
1645 * L::             -L to retain local symbols
1646 * listing::       --listing-XXX to configure listing output
1647 * M::             -M or --mri to assemble in MRI compatibility mode
1648 * MD::            --MD for dependency tracking
1649 * o::             -o to name the object file
1650 * R::             -R to join data and text sections
1651 * statistics::    --statistics to see statistics about assembly
1652 * traditional-format:: --traditional-format for compatible output
1653 * v::             -v to announce version
1654 * W::             -W, --no-warn, --warn, --fatal-warnings to control warnings
1655 * Z::             -Z to make object file even after errors
1656 @end menu
1657
1658 @node a
1659 @section Enable Listings: @option{-a[cdghlns]}
1660
1661 @kindex -a
1662 @kindex -ac
1663 @kindex -ad
1664 @kindex -ag
1665 @kindex -ah
1666 @kindex -al
1667 @kindex -an
1668 @kindex -as
1669 @cindex listings, enabling
1670 @cindex assembly listings, enabling
1671
1672 These options enable listing output from the assembler.  By itself,
1673 @samp{-a} requests high-level, assembly, and symbols listing.
1674 You can use other letters to select specific options for the list:
1675 @samp{-ah} requests a high-level language listing,
1676 @samp{-al} requests an output-program assembly listing, and
1677 @samp{-as} requests a symbol table listing.
1678 High-level listings require that a compiler debugging option like
1679 @samp{-g} be used, and that assembly listings (@samp{-al}) be requested
1680 also.
1681
1682 Use the @samp{-ag} option to print a first section with general assembly
1683 information, like @value{AS} version, switches passed, or time stamp.
1684
1685 Use the @samp{-ac} option to omit false conditionals from a listing.  Any lines
1686 which are not assembled because of a false @code{.if} (or @code{.ifdef}, or any
1687 other conditional), or a true @code{.if} followed by an @code{.else}, will be
1688 omitted from the listing.
1689
1690 Use the @samp{-ad} option to omit debugging directives from the
1691 listing.
1692
1693 Once you have specified one of these options, you can further control
1694 listing output and its appearance using the directives @code{.list},
1695 @code{.nolist}, @code{.psize}, @code{.eject}, @code{.title}, and
1696 @code{.sbttl}.
1697 The @samp{-an} option turns off all forms processing.
1698 If you do not request listing output with one of the @samp{-a} options, the
1699 listing-control directives have no effect.
1700
1701 The letters after @samp{-a} may be combined into one option,
1702 @emph{e.g.}, @samp{-aln}.
1703
1704 Note if the assembler source is coming from the standard input (e.g.,
1705 because it
1706 is being created by @code{@value{GCC}} and the @samp{-pipe} command line switch
1707 is being used) then the listing will not contain any comments or preprocessor
1708 directives.  This is because the listing code buffers input source lines from
1709 stdin only after they have been preprocessed by the assembler.  This reduces
1710 memory usage and makes the code more efficient.
1711
1712 @node alternate
1713 @section @option{--alternate}
1714
1715 @kindex --alternate
1716 Begin in alternate macro mode, see @ref{Altmacro,,@code{.altmacro}}.
1717
1718 @node D
1719 @section @option{-D}
1720
1721 @kindex -D
1722 This option has no effect whatsoever, but it is accepted to make it more
1723 likely that scripts written for other assemblers also work with
1724 @command{@value{AS}}.
1725
1726 @node f
1727 @section Work Faster: @option{-f}
1728
1729 @kindex -f
1730 @cindex trusted compiler
1731 @cindex faster processing (@option{-f})
1732 @samp{-f} should only be used when assembling programs written by a
1733 (trusted) compiler.  @samp{-f} stops the assembler from doing whitespace
1734 and comment preprocessing on
1735 the input file(s) before assembling them.  @xref{Preprocessing,
1736 ,Preprocessing}.
1737
1738 @quotation
1739 @emph{Warning:} if you use @samp{-f} when the files actually need to be
1740 preprocessed (if they contain comments, for example), @command{@value{AS}} does
1741 not work correctly.
1742 @end quotation
1743
1744 @node I
1745 @section @code{.include} Search Path: @option{-I} @var{path}
1746
1747 @kindex -I @var{path}
1748 @cindex paths for @code{.include}
1749 @cindex search path for @code{.include}
1750 @cindex @code{include} directive search path
1751 Use this option to add a @var{path} to the list of directories
1752 @command{@value{AS}} searches for files specified in @code{.include}
1753 directives (@pxref{Include,,@code{.include}}).  You may use @option{-I} as
1754 many times as necessary to include a variety of paths.  The current
1755 working directory is always searched first; after that, @command{@value{AS}}
1756 searches any @samp{-I} directories in the same order as they were
1757 specified (left to right) on the command line.
1758
1759 @node K
1760 @section Difference Tables: @option{-K}
1761
1762 @kindex -K
1763 @ifclear DIFF-TBL-KLUGE
1764 On the @value{TARGET} family, this option is allowed, but has no effect.  It is
1765 permitted for compatibility with the @sc{gnu} assembler on other platforms,
1766 where it can be used to warn when the assembler alters the machine code
1767 generated for @samp{.word} directives in difference tables.  The @value{TARGET}
1768 family does not have the addressing limitations that sometimes lead to this
1769 alteration on other platforms.
1770 @end ifclear
1771
1772 @ifset DIFF-TBL-KLUGE
1773 @cindex difference tables, warning
1774 @cindex warning for altered difference tables
1775 @command{@value{AS}} sometimes alters the code emitted for directives of the
1776 form @samp{.word @var{sym1}-@var{sym2}}.  @xref{Word,,@code{.word}}.
1777 You can use the @samp{-K} option if you want a warning issued when this
1778 is done.
1779 @end ifset
1780
1781 @node L
1782 @section Include Local Symbols: @option{-L}
1783
1784 @kindex -L
1785 @cindex local symbols, retaining in output
1786 Symbols beginning with system-specific local label prefixes, typically
1787 @samp{.L} for ELF systems or @samp{L} for traditional a.out systems, are
1788 called @dfn{local symbols}.  @xref{Symbol Names}.  Normally you do not see
1789 such symbols when debugging, because they are intended for the use of
1790 programs (like compilers) that compose assembler programs, not for your
1791 notice.  Normally both @command{@value{AS}} and @code{@value{LD}} discard
1792 such symbols, so you do not normally debug with them.
1793
1794 This option tells @command{@value{AS}} to retain those local symbols
1795 in the object file.  Usually if you do this you also tell the linker
1796 @code{@value{LD}} to preserve those symbols.
1797
1798 @node listing
1799 @section Configuring listing output: @option{--listing}
1800
1801 The listing feature of the assembler can be enabled via the command line switch
1802 @samp{-a} (@pxref{a}).  This feature combines the input source file(s) with a
1803 hex dump of the corresponding locations in the output object file, and displays
1804 them as a listing file.  The format of this listing can be controlled by
1805 directives inside the assembler source (i.e., @code{.list} (@pxref{List}),
1806 @code{.title} (@pxref{Title}), @code{.sbttl} (@pxref{Sbttl}),
1807 @code{.psize} (@pxref{Psize}), and
1808 @code{.eject} (@pxref{Eject}) and also by the following switches:
1809
1810 @table @gcctabopt
1811 @item --listing-lhs-width=@samp{number}
1812 @kindex --listing-lhs-width
1813 @cindex Width of first line disassembly output
1814 Sets the maximum width, in words, of the first line of the hex byte dump.  This
1815 dump appears on the left hand side of the listing output.
1816
1817 @item --listing-lhs-width2=@samp{number}
1818 @kindex --listing-lhs-width2
1819 @cindex Width of continuation lines of disassembly output
1820 Sets the maximum width, in words, of any further lines of the hex byte dump for
1821 a given input source line.  If this value is not specified, it defaults to being
1822 the same as the value specified for @samp{--listing-lhs-width}.  If neither
1823 switch is used the default is to one.
1824
1825 @item --listing-rhs-width=@samp{number}
1826 @kindex --listing-rhs-width
1827 @cindex Width of source line output
1828 Sets the maximum width, in characters, of the source line that is displayed
1829 alongside the hex dump.  The default value for this parameter is 100.  The
1830 source line is displayed on the right hand side of the listing output.
1831
1832 @item --listing-cont-lines=@samp{number}
1833 @kindex --listing-cont-lines
1834 @cindex Maximum number of continuation lines
1835 Sets the maximum number of continuation lines of hex dump that will be
1836 displayed for a given single line of source input.  The default value is 4.
1837 @end table
1838
1839 @node M
1840 @section Assemble in MRI Compatibility Mode: @option{-M}
1841
1842 @kindex -M
1843 @cindex MRI compatibility mode
1844 The @option{-M} or @option{--mri} option selects MRI compatibility mode.  This
1845 changes the syntax and pseudo-op handling of @command{@value{AS}} to make it
1846 compatible with the @code{ASM68K} or the @code{ASM960} (depending upon the
1847 configured target) assembler from Microtec Research.  The exact nature of the
1848 MRI syntax will not be documented here; see the MRI manuals for more
1849 information.  Note in particular that the handling of macros and macro
1850 arguments is somewhat different.  The purpose of this option is to permit
1851 assembling existing MRI assembler code using @command{@value{AS}}.
1852
1853 The MRI compatibility is not complete.  Certain operations of the MRI assembler
1854 depend upon its object file format, and can not be supported using other object
1855 file formats.  Supporting these would require enhancing each object file format
1856 individually.  These are:
1857
1858 @itemize @bullet
1859 @item global symbols in common section
1860
1861 The m68k MRI assembler supports common sections which are merged by the linker.
1862 Other object file formats do not support this.  @command{@value{AS}} handles
1863 common sections by treating them as a single common symbol.  It permits local
1864 symbols to be defined within a common section, but it can not support global
1865 symbols, since it has no way to describe them.
1866
1867 @item complex relocations
1868
1869 The MRI assemblers support relocations against a negated section address, and
1870 relocations which combine the start addresses of two or more sections.  These
1871 are not support by other object file formats.
1872
1873 @item @code{END} pseudo-op specifying start address
1874
1875 The MRI @code{END} pseudo-op permits the specification of a start address.
1876 This is not supported by other object file formats.  The start address may
1877 instead be specified using the @option{-e} option to the linker, or in a linker
1878 script.
1879
1880 @item @code{IDNT}, @code{.ident} and @code{NAME} pseudo-ops
1881
1882 The MRI @code{IDNT}, @code{.ident} and @code{NAME} pseudo-ops assign a module
1883 name to the output file.  This is not supported by other object file formats.
1884
1885 @item @code{ORG} pseudo-op
1886
1887 The m68k MRI @code{ORG} pseudo-op begins an absolute section at a given
1888 address.  This differs from the usual @command{@value{AS}} @code{.org} pseudo-op,
1889 which changes the location within the current section.  Absolute sections are
1890 not supported by other object file formats.  The address of a section may be
1891 assigned within a linker script.
1892 @end itemize
1893
1894 There are some other features of the MRI assembler which are not supported by
1895 @command{@value{AS}}, typically either because they are difficult or because they
1896 seem of little consequence.  Some of these may be supported in future releases.
1897
1898 @itemize @bullet
1899
1900 @item EBCDIC strings
1901
1902 EBCDIC strings are not supported.
1903
1904 @item packed binary coded decimal
1905
1906 Packed binary coded decimal is not supported.  This means that the @code{DC.P}
1907 and @code{DCB.P} pseudo-ops are not supported.
1908
1909 @item @code{FEQU} pseudo-op
1910
1911 The m68k @code{FEQU} pseudo-op is not supported.
1912
1913 @item @code{NOOBJ} pseudo-op
1914
1915 The m68k @code{NOOBJ} pseudo-op is not supported.
1916
1917 @item @code{OPT} branch control options
1918
1919 The m68k @code{OPT} branch control options---@code{B}, @code{BRS}, @code{BRB},
1920 @code{BRL}, and @code{BRW}---are ignored.  @command{@value{AS}} automatically
1921 relaxes all branches, whether forward or backward, to an appropriate size, so
1922 these options serve no purpose.
1923
1924 @item @code{OPT} list control options
1925
1926 The following m68k @code{OPT} list control options are ignored: @code{C},
1927 @code{CEX}, @code{CL}, @code{CRE}, @code{E}, @code{G}, @code{I}, @code{M},
1928 @code{MEX}, @code{MC}, @code{MD}, @code{X}.
1929
1930 @item other @code{OPT} options
1931
1932 The following m68k @code{OPT} options are ignored: @code{NEST}, @code{O},
1933 @code{OLD}, @code{OP}, @code{P}, @code{PCO}, @code{PCR}, @code{PCS}, @code{R}.
1934
1935 @item @code{OPT} @code{D} option is default
1936
1937 The m68k @code{OPT} @code{D} option is the default, unlike the MRI assembler.
1938 @code{OPT NOD} may be used to turn it off.
1939
1940 @item @code{XREF} pseudo-op.
1941
1942 The m68k @code{XREF} pseudo-op is ignored.
1943
1944 @item @code{.debug} pseudo-op
1945
1946 The i960 @code{.debug} pseudo-op is not supported.
1947
1948 @item @code{.extended} pseudo-op
1949
1950 The i960 @code{.extended} pseudo-op is not supported.
1951
1952 @item @code{.list} pseudo-op.
1953
1954 The various options of the i960 @code{.list} pseudo-op are not supported.
1955
1956 @item @code{.optimize} pseudo-op
1957
1958 The i960 @code{.optimize} pseudo-op is not supported.
1959
1960 @item @code{.output} pseudo-op
1961
1962 The i960 @code{.output} pseudo-op is not supported.
1963
1964 @item @code{.setreal} pseudo-op
1965
1966 The i960 @code{.setreal} pseudo-op is not supported.
1967
1968 @end itemize
1969
1970 @node MD
1971 @section Dependency Tracking: @option{--MD}
1972
1973 @kindex --MD
1974 @cindex dependency tracking
1975 @cindex make rules
1976
1977 @command{@value{AS}} can generate a dependency file for the file it creates.  This
1978 file consists of a single rule suitable for @code{make} describing the
1979 dependencies of the main source file.
1980
1981 The rule is written to the file named in its argument.
1982
1983 This feature is used in the automatic updating of makefiles.
1984
1985 @node o
1986 @section Name the Object File: @option{-o}
1987
1988 @kindex -o
1989 @cindex naming object file
1990 @cindex object file name
1991 There is always one object file output when you run @command{@value{AS}}.  By
1992 default it has the name
1993 @ifset GENERIC
1994 @ifset I960
1995 @file{a.out} (or @file{b.out}, for Intel 960 targets only).
1996 @end ifset
1997 @ifclear I960
1998 @file{a.out}.
1999 @end ifclear
2000 @end ifset
2001 @ifclear GENERIC
2002 @ifset I960
2003 @file{b.out}.
2004 @end ifset
2005 @ifclear I960
2006 @file{a.out}.
2007 @end ifclear
2008 @end ifclear
2009 You use this option (which takes exactly one filename) to give the
2010 object file a different name.
2011
2012 Whatever the object file is called, @command{@value{AS}} overwrites any
2013 existing file of the same name.
2014
2015 @node R
2016 @section Join Data and Text Sections: @option{-R}
2017
2018 @kindex -R
2019 @cindex data and text sections, joining
2020 @cindex text and data sections, joining
2021 @cindex joining text and data sections
2022 @cindex merging text and data sections
2023 @option{-R} tells @command{@value{AS}} to write the object file as if all
2024 data-section data lives in the text section.  This is only done at
2025 the very last moment:  your binary data are the same, but data
2026 section parts are relocated differently.  The data section part of
2027 your object file is zero bytes long because all its bytes are
2028 appended to the text section.  (@xref{Sections,,Sections and Relocation}.)
2029
2030 When you specify @option{-R} it would be possible to generate shorter
2031 address displacements (because we do not have to cross between text and
2032 data section).  We refrain from doing this simply for compatibility with
2033 older versions of @command{@value{AS}}.  In future, @option{-R} may work this way.
2034
2035 @ifset COFF-ELF
2036 When @command{@value{AS}} is configured for COFF or ELF output,
2037 this option is only useful if you use sections named @samp{.text} and
2038 @samp{.data}.
2039 @end ifset
2040
2041 @ifset HPPA
2042 @option{-R} is not supported for any of the HPPA targets.  Using
2043 @option{-R} generates a warning from @command{@value{AS}}.
2044 @end ifset
2045
2046 @node statistics
2047 @section Display Assembly Statistics: @option{--statistics}
2048
2049 @kindex --statistics
2050 @cindex statistics, about assembly
2051 @cindex time, total for assembly
2052 @cindex space used, maximum for assembly
2053 Use @samp{--statistics} to display two statistics about the resources used by
2054 @command{@value{AS}}: the maximum amount of space allocated during the assembly
2055 (in bytes), and the total execution time taken for the assembly (in @sc{cpu}
2056 seconds).
2057
2058 @node traditional-format
2059 @section Compatible Output: @option{--traditional-format}
2060
2061 @kindex --traditional-format
2062 For some targets, the output of @command{@value{AS}} is different in some ways
2063 from the output of some existing assembler.  This switch requests
2064 @command{@value{AS}} to use the traditional format instead.
2065
2066 For example, it disables the exception frame optimizations which
2067 @command{@value{AS}} normally does by default on @code{@value{GCC}} output.
2068
2069 @node v
2070 @section Announce Version: @option{-v}
2071
2072 @kindex -v
2073 @kindex -version
2074 @cindex assembler version
2075 @cindex version of assembler
2076 You can find out what version of as is running by including the
2077 option @samp{-v} (which you can also spell as @samp{-version}) on the
2078 command line.
2079
2080 @node W
2081 @section Control Warnings: @option{-W}, @option{--warn}, @option{--no-warn}, @option{--fatal-warnings}
2082
2083 @command{@value{AS}} should never give a warning or error message when
2084 assembling compiler output.  But programs written by people often
2085 cause @command{@value{AS}} to give a warning that a particular assumption was
2086 made.  All such warnings are directed to the standard error file.
2087
2088 @kindex -W
2089 @kindex --no-warn
2090 @cindex suppressing warnings
2091 @cindex warnings, suppressing
2092 If you use the @option{-W} and @option{--no-warn} options, no warnings are issued.
2093 This only affects the warning messages: it does not change any particular of
2094 how @command{@value{AS}} assembles your file.  Errors, which stop the assembly,
2095 are still reported.
2096
2097 @kindex --fatal-warnings
2098 @cindex errors, caused by warnings
2099 @cindex warnings, causing error
2100 If you use the @option{--fatal-warnings} option, @command{@value{AS}} considers
2101 files that generate warnings to be in error.
2102
2103 @kindex --warn
2104 @cindex warnings, switching on
2105 You can switch these options off again by specifying @option{--warn}, which
2106 causes warnings to be output as usual.
2107
2108 @node Z
2109 @section Generate Object File in Spite of Errors: @option{-Z}
2110 @cindex object file, after errors
2111 @cindex errors, continuing after
2112 After an error message, @command{@value{AS}} normally produces no output.  If for
2113 some reason you are interested in object file output even after
2114 @command{@value{AS}} gives an error message on your program, use the @samp{-Z}
2115 option.  If there are any errors, @command{@value{AS}} continues anyways, and
2116 writes an object file after a final warning message of the form @samp{@var{n}
2117 errors, @var{m} warnings, generating bad object file.}
2118
2119 @node Syntax
2120 @chapter Syntax
2121
2122 @cindex machine-independent syntax
2123 @cindex syntax, machine-independent
2124 This chapter describes the machine-independent syntax allowed in a
2125 source file.  @command{@value{AS}} syntax is similar to what many other
2126 assemblers use; it is inspired by the BSD 4.2
2127 @ifclear VAX
2128 assembler.
2129 @end ifclear
2130 @ifset VAX
2131 assembler, except that @command{@value{AS}} does not assemble Vax bit-fields.
2132 @end ifset
2133
2134 @menu
2135 * Preprocessing::              Preprocessing
2136 * Whitespace::                  Whitespace
2137 * Comments::                    Comments
2138 * Symbol Intro::                Symbols
2139 * Statements::                  Statements
2140 * Constants::                   Constants
2141 @end menu
2142
2143 @node Preprocessing
2144 @section Preprocessing
2145
2146 @cindex preprocessing
2147 The @command{@value{AS}} internal preprocessor:
2148 @itemize @bullet
2149 @cindex whitespace, removed by preprocessor
2150 @item
2151 adjusts and removes extra whitespace.  It leaves one space or tab before
2152 the keywords on a line, and turns any other whitespace on the line into
2153 a single space.
2154
2155 @cindex comments, removed by preprocessor
2156 @item
2157 removes all comments, replacing them with a single space, or an
2158 appropriate number of newlines.
2159
2160 @cindex constants, converted by preprocessor
2161 @item
2162 converts character constants into the appropriate numeric values.
2163 @end itemize
2164
2165 It does not do macro processing, include file handling, or
2166 anything else you may get from your C compiler's preprocessor.  You can
2167 do include file processing with the @code{.include} directive
2168 (@pxref{Include,,@code{.include}}).  You can use the @sc{gnu} C compiler driver
2169 to get other ``CPP'' style preprocessing by giving the input file a
2170 @samp{.S} suffix.  @xref{Overall Options, ,Options Controlling the Kind of
2171 Output, gcc.info, Using GNU CC}.
2172
2173 Excess whitespace, comments, and character constants
2174 cannot be used in the portions of the input text that are not
2175 preprocessed.
2176
2177 @cindex turning preprocessing on and off
2178 @cindex preprocessing, turning on and off
2179 @kindex #NO_APP
2180 @kindex #APP
2181 If the first line of an input file is @code{#NO_APP} or if you use the
2182 @samp{-f} option, whitespace and comments are not removed from the input file.
2183 Within an input file, you can ask for whitespace and comment removal in
2184 specific portions of the by putting a line that says @code{#APP} before the
2185 text that may contain whitespace or comments, and putting a line that says
2186 @code{#NO_APP} after this text.  This feature is mainly intend to support
2187 @code{asm} statements in compilers whose output is otherwise free of comments
2188 and whitespace.
2189
2190 @node Whitespace
2191 @section Whitespace
2192
2193 @cindex whitespace
2194 @dfn{Whitespace} is one or more blanks or tabs, in any order.
2195 Whitespace is used to separate symbols, and to make programs neater for
2196 people to read.  Unless within character constants
2197 (@pxref{Characters,,Character Constants}), any whitespace means the same
2198 as exactly one space.
2199
2200 @node Comments
2201 @section Comments
2202
2203 @cindex comments
2204 There are two ways of rendering comments to @command{@value{AS}}.  In both
2205 cases the comment is equivalent to one space.
2206
2207 Anything from @samp{/*} through the next @samp{*/} is a comment.
2208 This means you may not nest these comments.
2209
2210 @smallexample
2211 /*
2212   The only way to include a newline ('\n') in a comment
2213   is to use this sort of comment.
2214 */
2215
2216 /* This sort of comment does not nest. */
2217 @end smallexample
2218
2219 @cindex line comment character
2220 Anything from the @dfn{line comment} character to the next newline
2221 is considered a comment and is ignored.  The line comment character is
2222 @ifset ARC
2223 @samp{;} on the ARC;
2224 @end ifset
2225 @ifset ARM
2226 @samp{@@} on the ARM;
2227 @end ifset
2228 @ifset H8/300
2229 @samp{;} for the H8/300 family;
2230 @end ifset
2231 @ifset HPPA
2232 @samp{;} for the HPPA;
2233 @end ifset
2234 @ifset I80386
2235 @samp{#} on the i386 and x86-64;
2236 @end ifset
2237 @ifset I960
2238 @samp{#} on the i960;
2239 @end ifset
2240 @ifset PDP11
2241 @samp{;} for the PDP-11;
2242 @end ifset
2243 @ifset PJ
2244 @samp{;} for picoJava;
2245 @end ifset
2246 @ifset PPC
2247 @samp{#} for Motorola PowerPC;
2248 @end ifset
2249 @ifset S390
2250 @samp{#} for IBM S/390;
2251 @end ifset
2252 @ifset SCORE
2253 @samp{#} for the Sunplus SCORE;
2254 @end ifset
2255 @ifset SH
2256 @samp{!} for the Renesas / SuperH SH;
2257 @end ifset
2258 @ifset SPARC
2259 @samp{!} on the SPARC;
2260 @end ifset
2261 @ifset IP2K
2262 @samp{#} on the ip2k;
2263 @end ifset
2264 @ifset M32C
2265 @samp{#} on the m32c;
2266 @end ifset
2267 @ifset M32R
2268 @samp{#} on the m32r;
2269 @end ifset
2270 @ifset M680X0
2271 @samp{|} on the 680x0;
2272 @end ifset
2273 @ifset M68HC11
2274 @samp{#} on the 68HC11 and 68HC12;
2275 @end ifset
2276 @ifset VAX
2277 @samp{#} on the Vax;
2278 @end ifset
2279 @ifset Z80
2280 @samp{;} for the Z80;
2281 @end ifset
2282 @ifset Z8000
2283 @samp{!} for the Z8000;
2284 @end ifset
2285 @ifset V850
2286 @samp{#} on the V850;
2287 @end ifset
2288 @ifset XTENSA
2289 @samp{#} for Xtensa systems;
2290 @end ifset
2291 see @ref{Machine Dependencies}.  @refill
2292 @c FIXME What about i860?
2293
2294 @ifset GENERIC
2295 On some machines there are two different line comment characters.  One
2296 character only begins a comment if it is the first non-whitespace character on
2297 a line, while the other always begins a comment.
2298 @end ifset
2299
2300 @ifset V850
2301 The V850 assembler also supports a double dash as starting a comment that
2302 extends to the end of the line.
2303
2304 @samp{--};
2305 @end ifset
2306
2307 @kindex #
2308 @cindex lines starting with @code{#}
2309 @cindex logical line numbers
2310 To be compatible with past assemblers, lines that begin with @samp{#} have a
2311 special interpretation.  Following the @samp{#} should be an absolute
2312 expression (@pxref{Expressions}): the logical line number of the @emph{next}
2313 line.  Then a string (@pxref{Strings, ,Strings}) is allowed: if present it is a
2314 new logical file name.  The rest of the line, if any, should be whitespace.
2315
2316 If the first non-whitespace characters on the line are not numeric,
2317 the line is ignored.  (Just like a comment.)
2318
2319 @smallexample
2320                           # This is an ordinary comment.
2321 # 42-6 "new_file_name"    # New logical file name
2322                           # This is logical line # 36.
2323 @end smallexample
2324 This feature is deprecated, and may disappear from future versions
2325 of @command{@value{AS}}.
2326
2327 @node Symbol Intro
2328 @section Symbols
2329
2330 @cindex characters used in symbols
2331 @ifclear SPECIAL-SYMS
2332 A @dfn{symbol} is one or more characters chosen from the set of all
2333 letters (both upper and lower case), digits and the three characters
2334 @samp{_.$}.
2335 @end ifclear
2336 @ifset SPECIAL-SYMS
2337 @ifclear GENERIC
2338 @ifset H8
2339 A @dfn{symbol} is one or more characters chosen from the set of all
2340 letters (both upper and lower case), digits and the three characters
2341 @samp{._$}.  (Save that, on the H8/300 only, you may not use @samp{$} in
2342 symbol names.)
2343 @end ifset
2344 @end ifclear
2345 @end ifset
2346 @ifset GENERIC
2347 On most machines, you can also use @code{$} in symbol names; exceptions
2348 are noted in @ref{Machine Dependencies}.
2349 @end ifset
2350 No symbol may begin with a digit.  Case is significant.
2351 There is no length limit: all characters are significant.  Symbols are
2352 delimited by characters not in that set, or by the beginning of a file
2353 (since the source program must end with a newline, the end of a file is
2354 not a possible symbol delimiter).  @xref{Symbols}.
2355 @cindex length of symbols
2356
2357 @node Statements
2358 @section Statements
2359
2360 @cindex statements, structure of
2361 @cindex line separator character
2362 @cindex statement separator character
2363 @ifclear GENERIC
2364 @ifclear abnormal-separator
2365 A @dfn{statement} ends at a newline character (@samp{\n}) or at a
2366 semicolon (@samp{;}).  The newline or semicolon is considered part of
2367 the preceding statement.  Newlines and semicolons within character
2368 constants are an exception: they do not end statements.
2369 @end ifclear
2370 @ifset abnormal-separator
2371 @ifset HPPA
2372 A @dfn{statement} ends at a newline character (@samp{\n}) or an exclamation 
2373 point (@samp{!}).  The newline or exclamation point is considered part of the
2374 preceding statement.  Newlines and exclamation points within character
2375 constants are an exception: they do not end statements.
2376 @end ifset
2377 @ifset H8
2378 A @dfn{statement} ends at a newline character (@samp{\n}); or (for the
2379 H8/300) a dollar sign (@samp{$}); or (for the Renesas-SH) a semicolon
2380 (@samp{;}).  The newline or separator character is considered part of
2381 the preceding statement.  Newlines and separators within character
2382 constants are an exception: they do not end statements.
2383 @end ifset
2384 @end ifset
2385 @end ifclear
2386 @ifset GENERIC
2387 A @dfn{statement} ends at a newline character (@samp{\n}) or line
2388 separator character.  (The line separator is usually @samp{;}, unless this
2389 conflicts with the comment character; see @ref{Machine Dependencies}.)  The
2390 newline or separator character is considered part of the preceding
2391 statement.  Newlines and separators within character constants are an
2392 exception: they do not end statements.
2393 @end ifset
2394
2395 @cindex newline, required at file end
2396 @cindex EOF, newline must precede
2397 It is an error to end any statement with end-of-file:  the last
2398 character of any input file should be a newline.@refill
2399
2400 An empty statement is allowed, and may include whitespace.  It is ignored.
2401
2402 @cindex instructions and directives
2403 @cindex directives and instructions
2404 @c "key symbol" is not used elsewhere in the document; seems pedantic to
2405 @c @defn{} it in that case, as was done previously...  doc@cygnus.com,
2406 @c 13feb91.
2407 A statement begins with zero or more labels, optionally followed by a
2408 key symbol which determines what kind of statement it is.  The key
2409 symbol determines the syntax of the rest of the statement.  If the
2410 symbol begins with a dot @samp{.} then the statement is an assembler
2411 directive: typically valid for any computer.  If the symbol begins with
2412 a letter the statement is an assembly language @dfn{instruction}: it
2413 assembles into a machine language instruction.
2414 @ifset GENERIC
2415 Different versions of @command{@value{AS}} for different computers
2416 recognize different instructions.  In fact, the same symbol may
2417 represent a different instruction in a different computer's assembly
2418 language.@refill
2419 @end ifset
2420
2421 @cindex @code{:} (label)
2422 @cindex label (@code{:})
2423 A label is a symbol immediately followed by a colon (@code{:}).
2424 Whitespace before a label or after a colon is permitted, but you may not
2425 have whitespace between a label's symbol and its colon. @xref{Labels}.
2426
2427 @ifset HPPA
2428 For HPPA targets, labels need not be immediately followed by a colon, but 
2429 the definition of a label must begin in column zero.  This also implies that
2430 only one label may be defined on each line.
2431 @end ifset
2432
2433 @smallexample
2434 label:     .directive    followed by something
2435 another_label:           # This is an empty statement.
2436            instruction   operand_1, operand_2, @dots{}
2437 @end smallexample
2438
2439 @node Constants
2440 @section Constants
2441
2442 @cindex constants
2443 A constant is a number, written so that its value is known by
2444 inspection, without knowing any context.  Like this:
2445 @smallexample
2446 @group
2447 .byte  74, 0112, 092, 0x4A, 0X4a, 'J, '\J # All the same value.
2448 .ascii "Ring the bell\7"                  # A string constant.
2449 .octa  0x123456789abcdef0123456789ABCDEF0 # A bignum.
2450 .float 0f-314159265358979323846264338327\
2451 95028841971.693993751E-40                 # - pi, a flonum.
2452 @end group
2453 @end smallexample
2454
2455 @menu
2456 * Characters::                  Character Constants
2457 * Numbers::                     Number Constants
2458 @end menu
2459
2460 @node Characters
2461 @subsection Character Constants
2462
2463 @cindex character constants
2464 @cindex constants, character
2465 There are two kinds of character constants.  A @dfn{character} stands
2466 for one character in one byte and its value may be used in
2467 numeric expressions.  String constants (properly called string
2468 @emph{literals}) are potentially many bytes and their values may not be
2469 used in arithmetic expressions.
2470
2471 @menu
2472 * Strings::                     Strings
2473 * Chars::                       Characters
2474 @end menu
2475
2476 @node Strings
2477 @subsubsection Strings
2478
2479 @cindex string constants
2480 @cindex constants, string
2481 A @dfn{string} is written between double-quotes.  It may contain
2482 double-quotes or null characters.  The way to get special characters
2483 into a string is to @dfn{escape} these characters: precede them with
2484 a backslash @samp{\} character.  For example @samp{\\} represents
2485 one backslash:  the first @code{\} is an escape which tells
2486 @command{@value{AS}} to interpret the second character literally as a backslash
2487 (which prevents @command{@value{AS}} from recognizing the second @code{\} as an
2488 escape character).  The complete list of escapes follows.
2489
2490 @cindex escape codes, character
2491 @cindex character escape codes
2492 @table @kbd
2493 @c      @item \a
2494 @c      Mnemonic for ACKnowledge; for ASCII this is octal code 007.
2495 @c
2496 @cindex @code{\b} (backspace character)
2497 @cindex backspace (@code{\b})
2498 @item \b
2499 Mnemonic for backspace; for ASCII this is octal code 010.
2500
2501 @c      @item \e
2502 @c      Mnemonic for EOText; for ASCII this is octal code 004.
2503 @c
2504 @cindex @code{\f} (formfeed character)
2505 @cindex formfeed (@code{\f})
2506 @item \f
2507 Mnemonic for FormFeed; for ASCII this is octal code 014.
2508
2509 @cindex @code{\n} (newline character)
2510 @cindex newline (@code{\n})
2511 @item \n
2512 Mnemonic for newline; for ASCII this is octal code 012.
2513
2514 @c      @item \p
2515 @c      Mnemonic for prefix; for ASCII this is octal code 033, usually known as @code{escape}.
2516 @c
2517 @cindex @code{\r} (carriage return character)
2518 @cindex carriage return (@code{\r})
2519 @item \r
2520 Mnemonic for carriage-Return; for ASCII this is octal code 015.
2521
2522 @c      @item \s
2523 @c      Mnemonic for space; for ASCII this is octal code 040.  Included for compliance with
2524 @c      other assemblers.
2525 @c
2526 @cindex @code{\t} (tab)
2527 @cindex tab (@code{\t})
2528 @item \t
2529 Mnemonic for horizontal Tab; for ASCII this is octal code 011.
2530
2531 @c      @item \v
2532 @c      Mnemonic for Vertical tab; for ASCII this is octal code 013.
2533 @c      @item \x @var{digit} @var{digit} @var{digit}
2534 @c      A hexadecimal character code.  The numeric code is 3 hexadecimal digits.
2535 @c
2536 @cindex @code{\@var{ddd}} (octal character code)
2537 @cindex octal character code (@code{\@var{ddd}})
2538 @item \ @var{digit} @var{digit} @var{digit}
2539 An octal character code.  The numeric code is 3 octal digits.
2540 For compatibility with other Unix systems, 8 and 9 are accepted as digits:
2541 for example, @code{\008} has the value 010, and @code{\009} the value 011.
2542
2543 @cindex @code{\@var{xd...}} (hex character code)
2544 @cindex hex character code (@code{\@var{xd...}})
2545 @item \@code{x} @var{hex-digits...}
2546 A hex character code.  All trailing hex digits are combined.  Either upper or
2547 lower case @code{x} works.
2548
2549 @cindex @code{\\} (@samp{\} character)
2550 @cindex backslash (@code{\\})
2551 @item \\
2552 Represents one @samp{\} character.
2553
2554 @c      @item \'
2555 @c      Represents one @samp{'} (accent acute) character.
2556 @c      This is needed in single character literals
2557 @c      (@xref{Characters,,Character Constants}.) to represent
2558 @c      a @samp{'}.
2559 @c
2560 @cindex @code{\"} (doublequote character)
2561 @cindex doublequote (@code{\"})
2562 @item \"
2563 Represents one @samp{"} character.  Needed in strings to represent
2564 this character, because an unescaped @samp{"} would end the string.
2565
2566 @item \ @var{anything-else}
2567 Any other character when escaped by @kbd{\} gives a warning, but
2568 assembles as if the @samp{\} was not present.  The idea is that if
2569 you used an escape sequence you clearly didn't want the literal
2570 interpretation of the following character.  However @command{@value{AS}} has no
2571 other interpretation, so @command{@value{AS}} knows it is giving you the wrong
2572 code and warns you of the fact.
2573 @end table
2574
2575 Which characters are escapable, and what those escapes represent,
2576 varies widely among assemblers.  The current set is what we think
2577 the BSD 4.2 assembler recognizes, and is a subset of what most C
2578 compilers recognize.  If you are in doubt, do not use an escape
2579 sequence.
2580
2581 @node Chars
2582 @subsubsection Characters
2583
2584 @cindex single character constant
2585 @cindex character, single
2586 @cindex constant, single character
2587 A single character may be written as a single quote immediately
2588 followed by that character.  The same escapes apply to characters as
2589 to strings.  So if you want to write the character backslash, you
2590 must write @kbd{'\\} where the first @code{\} escapes the second
2591 @code{\}.  As you can see, the quote is an acute accent, not a
2592 grave accent.  A newline
2593 @ifclear GENERIC
2594 @ifclear abnormal-separator
2595 (or semicolon @samp{;})
2596 @end ifclear
2597 @ifset abnormal-separator
2598 @ifset H8
2599 (or dollar sign @samp{$}, for the H8/300; or semicolon @samp{;} for the
2600 Renesas SH)
2601 @end ifset
2602 @end ifset
2603 @end ifclear
2604 immediately following an acute accent is taken as a literal character
2605 and does not count as the end of a statement.  The value of a character
2606 constant in a numeric expression is the machine's byte-wide code for
2607 that character.  @command{@value{AS}} assumes your character code is ASCII:
2608 @kbd{'A} means 65, @kbd{'B} means 66, and so on. @refill
2609
2610 @node Numbers
2611 @subsection Number Constants
2612
2613 @cindex constants, number
2614 @cindex number constants
2615 @command{@value{AS}} distinguishes three kinds of numbers according to how they
2616 are stored in the target machine.  @emph{Integers} are numbers that
2617 would fit into an @code{int} in the C language.  @emph{Bignums} are
2618 integers, but they are stored in more than 32 bits.  @emph{Flonums}
2619 are floating point numbers, described below.
2620
2621 @menu
2622 * Integers::                    Integers
2623 * Bignums::                     Bignums
2624 * Flonums::                     Flonums
2625 @ifclear GENERIC
2626 @ifset I960
2627 * Bit Fields::                  Bit Fields
2628 @end ifset
2629 @end ifclear
2630 @end menu
2631
2632 @node Integers
2633 @subsubsection Integers
2634 @cindex integers
2635 @cindex constants, integer
2636
2637 @cindex binary integers
2638 @cindex integers, binary
2639 A binary integer is @samp{0b} or @samp{0B} followed by zero or more of
2640 the binary digits @samp{01}.
2641
2642 @cindex octal integers
2643 @cindex integers, octal
2644 An octal integer is @samp{0} followed by zero or more of the octal
2645 digits (@samp{01234567}).
2646
2647 @cindex decimal integers
2648 @cindex integers, decimal
2649 A decimal integer starts with a non-zero digit followed by zero or
2650 more digits (@samp{0123456789}).
2651
2652 @cindex hexadecimal integers
2653 @cindex integers, hexadecimal
2654 A hexadecimal integer is @samp{0x} or @samp{0X} followed by one or
2655 more hexadecimal digits chosen from @samp{0123456789abcdefABCDEF}.
2656
2657 Integers have the usual values.  To denote a negative integer, use
2658 the prefix operator @samp{-} discussed under expressions
2659 (@pxref{Prefix Ops,,Prefix Operators}).
2660
2661 @node Bignums
2662 @subsubsection Bignums
2663
2664 @cindex bignums
2665 @cindex constants, bignum
2666 A @dfn{bignum} has the same syntax and semantics as an integer
2667 except that the number (or its negative) takes more than 32 bits to
2668 represent in binary.  The distinction is made because in some places
2669 integers are permitted while bignums are not.
2670
2671 @node Flonums
2672 @subsubsection Flonums
2673 @cindex flonums
2674 @cindex floating point numbers
2675 @cindex constants, floating point
2676
2677 @cindex precision, floating point
2678 A @dfn{flonum} represents a floating point number.  The translation is
2679 indirect: a decimal floating point number from the text is converted by
2680 @command{@value{AS}} to a generic binary floating point number of more than
2681 sufficient precision.  This generic floating point number is converted
2682 to a particular computer's floating point format (or formats) by a
2683 portion of @command{@value{AS}} specialized to that computer.
2684
2685 A flonum is written by writing (in order)
2686 @itemize @bullet
2687 @item
2688 The digit @samp{0}.
2689 @ifset HPPA
2690 (@samp{0} is optional on the HPPA.)
2691 @end ifset
2692
2693 @item
2694 A letter, to tell @command{@value{AS}} the rest of the number is a flonum.
2695 @ifset GENERIC
2696 @kbd{e} is recommended.  Case is not important.
2697 @ignore
2698 @c FIXME: verify if flonum syntax really this vague for most cases
2699 (Any otherwise illegal letter works here, but that might be changed.  Vax BSD
2700 4.2 assembler seems to allow any of @samp{defghDEFGH}.)
2701 @end ignore
2702
2703 On the H8/300, Renesas / SuperH SH,
2704 and AMD 29K architectures, the letter must be
2705 one of the letters @samp{DFPRSX} (in upper or lower case).
2706
2707 On the ARC, the letter must be one of the letters @samp{DFRS}
2708 (in upper or lower case).
2709
2710 On the Intel 960 architecture, the letter must be
2711 one of the letters @samp{DFT} (in upper or lower case).
2712
2713 On the HPPA architecture, the letter must be @samp{E} (upper case only).
2714 @end ifset
2715 @ifclear GENERIC
2716 @ifset ARC
2717 One of the letters @samp{DFRS} (in upper or lower case).
2718 @end ifset
2719 @ifset H8
2720 One of the letters @samp{DFPRSX} (in upper or lower case).
2721 @end ifset
2722 @ifset HPPA
2723 The letter @samp{E} (upper case only).
2724 @end ifset
2725 @ifset I960
2726 One of the letters @samp{DFT} (in upper or lower case).
2727 @end ifset
2728 @end ifclear
2729
2730 @item
2731 An optional sign: either @samp{+} or @samp{-}.
2732
2733 @item
2734 An optional @dfn{integer part}: zero or more decimal digits.
2735
2736 @item
2737 An optional @dfn{fractional part}: @samp{.} followed by zero
2738 or more decimal digits.
2739
2740 @item
2741 An optional exponent, consisting of:
2742
2743 @itemize @bullet
2744 @item
2745 An @samp{E} or @samp{e}.
2746 @c I can't find a config where "EXP_CHARS" is other than 'eE', but in
2747 @c principle this can perfectly well be different on different targets.
2748 @item
2749 Optional sign: either @samp{+} or @samp{-}.
2750 @item
2751 One or more decimal digits.
2752 @end itemize
2753
2754 @end itemize
2755
2756 At least one of the integer part or the fractional part must be
2757 present.  The floating point number has the usual base-10 value.
2758
2759 @command{@value{AS}} does all processing using integers.  Flonums are computed
2760 independently of any floating point hardware in the computer running
2761 @command{@value{AS}}.
2762
2763 @ifclear GENERIC
2764 @ifset I960
2765 @c Bit fields are written as a general facility but are also controlled
2766 @c by a conditional-compilation flag---which is as of now (21mar91)
2767 @c turned on only by the i960 config of GAS.
2768 @node Bit Fields
2769 @subsubsection Bit Fields
2770
2771 @cindex bit fields
2772 @cindex constants, bit field
2773 You can also define numeric constants as @dfn{bit fields}.
2774 Specify two numbers separated by a colon---
2775 @example
2776 @var{mask}:@var{value}
2777 @end example
2778 @noindent
2779 @command{@value{AS}} applies a bitwise @sc{and} between @var{mask} and
2780 @var{value}.
2781
2782 The resulting number is then packed
2783 @ifset GENERIC
2784 @c this conditional paren in case bit fields turned on elsewhere than 960
2785 (in host-dependent byte order)
2786 @end ifset
2787 into a field whose width depends on which assembler directive has the
2788 bit-field as its argument.  Overflow (a result from the bitwise and
2789 requiring more binary digits to represent) is not an error; instead,
2790 more constants are generated, of the specified width, beginning with the
2791 least significant digits.@refill
2792
2793 The directives @code{.byte}, @code{.hword}, @code{.int}, @code{.long},
2794 @code{.short}, and @code{.word} accept bit-field arguments.
2795 @end ifset
2796 @end ifclear
2797
2798 @node Sections
2799 @chapter Sections and Relocation
2800 @cindex sections
2801 @cindex relocation
2802
2803 @menu
2804 * Secs Background::             Background
2805 * Ld Sections::                 Linker Sections
2806 * As Sections::                 Assembler Internal Sections
2807 * Sub-Sections::                Sub-Sections
2808 * bss::                         bss Section
2809 @end menu
2810
2811 @node Secs Background
2812 @section Background
2813
2814 Roughly, a section is a range of addresses, with no gaps; all data
2815 ``in'' those addresses is treated the same for some particular purpose.
2816 For example there may be a ``read only'' section.
2817
2818 @cindex linker, and assembler
2819 @cindex assembler, and linker
2820 The linker @code{@value{LD}} reads many object files (partial programs) and
2821 combines their contents to form a runnable program.  When @command{@value{AS}}
2822 emits an object file, the partial program is assumed to start at address 0.
2823 @code{@value{LD}} assigns the final addresses for the partial program, so that
2824 different partial programs do not overlap.  This is actually an
2825 oversimplification, but it suffices to explain how @command{@value{AS}} uses
2826 sections.
2827
2828 @code{@value{LD}} moves blocks of bytes of your program to their run-time
2829 addresses.  These blocks slide to their run-time addresses as rigid
2830 units; their length does not change and neither does the order of bytes
2831 within them.  Such a rigid unit is called a @emph{section}.  Assigning
2832 run-time addresses to sections is called @dfn{relocation}.  It includes
2833 the task of adjusting mentions of object-file addresses so they refer to
2834 the proper run-time addresses.
2835 @ifset H8
2836 For the H8/300, and for the Renesas / SuperH SH,
2837 @command{@value{AS}} pads sections if needed to
2838 ensure they end on a word (sixteen bit) boundary.
2839 @end ifset
2840
2841 @cindex standard assembler sections
2842 An object file written by @command{@value{AS}} has at least three sections, any
2843 of which may be empty.  These are named @dfn{text}, @dfn{data} and
2844 @dfn{bss} sections.
2845
2846 @ifset COFF-ELF
2847 @ifset GENERIC
2848 When it generates COFF or ELF output,
2849 @end ifset
2850 @command{@value{AS}} can also generate whatever other named sections you specify
2851 using the @samp{.section} directive (@pxref{Section,,@code{.section}}).
2852 If you do not use any directives that place output in the @samp{.text}
2853 or @samp{.data} sections, these sections still exist, but are empty.
2854 @end ifset
2855
2856 @ifset HPPA
2857 @ifset GENERIC
2858 When @command{@value{AS}} generates SOM or ELF output for the HPPA,
2859 @end ifset
2860 @command{@value{AS}} can also generate whatever other named sections you
2861 specify using the @samp{.space} and @samp{.subspace} directives.  See
2862 @cite{HP9000 Series 800 Assembly Language Reference Manual}
2863 (HP 92432-90001) for details on the @samp{.space} and @samp{.subspace}
2864 assembler directives.
2865
2866 @ifset SOM
2867 Additionally, @command{@value{AS}} uses different names for the standard
2868 text, data, and bss sections when generating SOM output.  Program text
2869 is placed into the @samp{$CODE$} section, data into @samp{$DATA$}, and
2870 BSS into @samp{$BSS$}.
2871 @end ifset
2872 @end ifset
2873
2874 Within the object file, the text section starts at address @code{0}, the
2875 data section follows, and the bss section follows the data section.
2876
2877 @ifset HPPA
2878 When generating either SOM or ELF output files on the HPPA, the text
2879 section starts at address @code{0}, the data section at address
2880 @code{0x4000000}, and the bss section follows the data section.
2881 @end ifset
2882
2883 To let @code{@value{LD}} know which data changes when the sections are
2884 relocated, and how to change that data, @command{@value{AS}} also writes to the
2885 object file details of the relocation needed.  To perform relocation
2886 @code{@value{LD}} must know, each time an address in the object
2887 file is mentioned:
2888 @itemize @bullet
2889 @item
2890 Where in the object file is the beginning of this reference to
2891 an address?
2892 @item
2893 How long (in bytes) is this reference?
2894 @item
2895 Which section does the address refer to?  What is the numeric value of
2896 @display
2897 (@var{address}) @minus{} (@var{start-address of section})?
2898 @end display
2899 @item
2900 Is the reference to an address ``Program-Counter relative''?
2901 @end itemize
2902
2903 @cindex addresses, format of
2904 @cindex section-relative addressing
2905 In fact, every address @command{@value{AS}} ever uses is expressed as
2906 @display
2907 (@var{section}) + (@var{offset into section})
2908 @end display
2909 @noindent
2910 Further, most expressions @command{@value{AS}} computes have this section-relative
2911 nature.
2912 @ifset SOM
2913 (For some object formats, such as SOM for the HPPA, some expressions are
2914 symbol-relative instead.)
2915 @end ifset
2916
2917 In this manual we use the notation @{@var{secname} @var{N}@} to mean ``offset
2918 @var{N} into section @var{secname}.''
2919
2920 Apart from text, data and bss sections you need to know about the
2921 @dfn{absolute} section.  When @code{@value{LD}} mixes partial programs,
2922 addresses in the absolute section remain unchanged.  For example, address
2923 @code{@{absolute 0@}} is ``relocated'' to run-time address 0 by
2924 @code{@value{LD}}.  Although the linker never arranges two partial programs'
2925 data sections with overlapping addresses after linking, @emph{by definition}
2926 their absolute sections must overlap.  Address @code{@{absolute@ 239@}} in one
2927 part of a program is always the same address when the program is running as
2928 address @code{@{absolute@ 239@}} in any other part of the program.
2929
2930 The idea of sections is extended to the @dfn{undefined} section.  Any
2931 address whose section is unknown at assembly time is by definition
2932 rendered @{undefined @var{U}@}---where @var{U} is filled in later.
2933 Since numbers are always defined, the only way to generate an undefined
2934 address is to mention an undefined symbol.  A reference to a named
2935 common block would be such a symbol: its value is unknown at assembly
2936 time so it has section @emph{undefined}.
2937
2938 By analogy the word @emph{section} is used to describe groups of sections in
2939 the linked program.  @code{@value{LD}} puts all partial programs' text
2940 sections in contiguous addresses in the linked program.  It is
2941 customary to refer to the @emph{text section} of a program, meaning all
2942 the addresses of all partial programs' text sections.  Likewise for
2943 data and bss sections.
2944
2945 Some sections are manipulated by @code{@value{LD}}; others are invented for
2946 use of @command{@value{AS}} and have no meaning except during assembly.
2947
2948 @node Ld Sections
2949 @section Linker Sections
2950 @code{@value{LD}} deals with just four kinds of sections, summarized below.
2951
2952 @table @strong
2953
2954 @ifset COFF-ELF
2955 @cindex named sections
2956 @cindex sections, named
2957 @item named sections
2958 @end ifset
2959 @ifset aout-bout
2960 @cindex text section
2961 @cindex data section
2962 @itemx text section
2963 @itemx data section
2964 @end ifset
2965 These sections hold your program.  @command{@value{AS}} and @code{@value{LD}} treat them as
2966 separate but equal sections.  Anything you can say of one section is
2967 true of another.
2968 @c @ifset aout-bout
2969 When the program is running, however, it is
2970 customary for the text section to be unalterable.  The
2971 text section is often shared among processes: it contains
2972 instructions, constants and the like.  The data section of a running
2973 program is usually alterable: for example, C variables would be stored
2974 in the data section.
2975 @c @end ifset
2976
2977 @cindex bss section
2978 @item bss section
2979 This section contains zeroed bytes when your program begins running.  It
2980 is used to hold uninitialized variables or common storage.  The length of
2981 each partial program's bss section is important, but because it starts
2982 out containing zeroed bytes there is no need to store explicit zero
2983 bytes in the object file.  The bss section was invented to eliminate
2984 those explicit zeros from object files.
2985
2986 @cindex absolute section
2987 @item absolute section
2988 Address 0 of this section is always ``relocated'' to runtime address 0.
2989 This is useful if you want to refer to an address that @code{@value{LD}} must
2990 not change when relocating.  In this sense we speak of absolute
2991 addresses being ``unrelocatable'': they do not change during relocation.
2992
2993 @cindex undefined section
2994 @item undefined section
2995 This ``section'' is a catch-all for address references to objects not in
2996 the preceding sections.
2997 @c FIXME: ref to some other doc on obj-file formats could go here.
2998 @end table
2999
3000 @cindex relocation example
3001 An idealized example of three relocatable sections follows.
3002 @ifset COFF-ELF
3003 The example uses the traditional section names @samp{.text} and @samp{.data}.
3004 @end ifset
3005 Memory addresses are on the horizontal axis.
3006
3007 @c TEXI2ROFF-KILL
3008 @ifnottex
3009 @c END TEXI2ROFF-KILL
3010 @smallexample
3011                       +-----+----+--+
3012 partial program # 1:  |ttttt|dddd|00|
3013                       +-----+----+--+
3014
3015                       text   data bss
3016                       seg.   seg. seg.
3017
3018                       +---+---+---+
3019 partial program # 2:  |TTT|DDD|000|
3020                       +---+---+---+
3021
3022                       +--+---+-----+--+----+---+-----+~~
3023 linked program:       |  |TTT|ttttt|  |dddd|DDD|00000|
3024                       +--+---+-----+--+----+---+-----+~~
3025
3026     addresses:        0 @dots{}
3027 @end smallexample
3028 @c TEXI2ROFF-KILL
3029 @end ifnottex
3030 @need 5000
3031 @tex
3032 \bigskip
3033 \line{\it Partial program \#1: \hfil}
3034 \line{\ibox{2.5cm}{\tt text}\ibox{2cm}{\tt data}\ibox{1cm}{\tt bss}\hfil}
3035 \line{\boxit{2.5cm}{\tt ttttt}\boxit{2cm}{\tt dddd}\boxit{1cm}{\tt 00}\hfil}
3036
3037 \line{\it Partial program \#2: \hfil}
3038 \line{\ibox{1cm}{\tt text}\ibox{1.5cm}{\tt data}\ibox{1cm}{\tt bss}\hfil}
3039 \line{\boxit{1cm}{\tt TTT}\boxit{1.5cm}{\tt DDDD}\boxit{1cm}{\tt 000}\hfil}
3040
3041 \line{\it linked program: \hfil}
3042 \line{\ibox{.5cm}{}\ibox{1cm}{\tt text}\ibox{2.5cm}{}\ibox{.75cm}{}\ibox{2cm}{\tt data}\ibox{1.5cm}{}\ibox{2cm}{\tt bss}\hfil}
3043 \line{\boxit{.5cm}{}\boxit{1cm}{\tt TTT}\boxit{2.5cm}{\tt
3044 ttttt}\boxit{.75cm}{}\boxit{2cm}{\tt dddd}\boxit{1.5cm}{\tt
3045 DDDD}\boxit{2cm}{\tt 00000}\ \dots\hfil}
3046
3047 \line{\it addresses: \hfil}
3048 \line{0\dots\hfil}
3049
3050 @end tex
3051 @c END TEXI2ROFF-KILL
3052
3053 @node As Sections
3054 @section Assembler Internal Sections
3055
3056 @cindex internal assembler sections
3057 @cindex sections in messages, internal
3058 These sections are meant only for the internal use of @command{@value{AS}}.  They
3059 have no meaning at run-time.  You do not really need to know about these
3060 sections for most purposes; but they can be mentioned in @command{@value{AS}}
3061 warning messages, so it might be helpful to have an idea of their
3062 meanings to @command{@value{AS}}.  These sections are used to permit the
3063 value of every expression in your assembly language program to be a
3064 section-relative address.
3065
3066 @table @b
3067 @cindex assembler internal logic error
3068 @item ASSEMBLER-INTERNAL-LOGIC-ERROR!
3069 An internal assembler logic error has been found.  This means there is a
3070 bug in the assembler.
3071
3072 @cindex expr (internal section)
3073 @item expr section
3074 The assembler stores complex expression internally as combinations of
3075 symbols.  When it needs to represent an expression as a symbol, it puts
3076 it in the expr section.
3077 @c FIXME item debug
3078 @c FIXME item transfer[t] vector preload
3079 @c FIXME item transfer[t] vector postload
3080 @c FIXME item register
3081 @end table
3082
3083 @node Sub-Sections
3084 @section Sub-Sections
3085
3086 @cindex numbered subsections
3087 @cindex grouping data
3088 @ifset aout-bout
3089 Assembled bytes
3090 @ifset COFF-ELF
3091 conventionally
3092 @end ifset
3093 fall into two sections: text and data.
3094 @end ifset
3095 You may have separate groups of
3096 @ifset GENERIC
3097 data in named sections
3098 @end ifset
3099 @ifclear GENERIC
3100 @ifclear aout-bout
3101 data in named sections
3102 @end ifclear
3103 @ifset aout-bout
3104 text or data
3105 @end ifset
3106 @end ifclear
3107 that you want to end up near to each other in the object file, even though they
3108 are not contiguous in the assembler source.  @command{@value{AS}} allows you to
3109 use @dfn{subsections} for this purpose.  Within each section, there can be
3110 numbered subsections with values from 0 to 8192.  Objects assembled into the
3111 same subsection go into the object file together with other objects in the same
3112 subsection.  For example, a compiler might want to store constants in the text
3113 section, but might not want to have them interspersed with the program being
3114 assembled.  In this case, the compiler could issue a @samp{.text 0} before each
3115 section of code being output, and a @samp{.text 1} before each group of
3116 constants being output.
3117
3118 Subsections are optional.  If you do not use subsections, everything
3119 goes in subsection number zero.
3120
3121 @ifset GENERIC
3122 Each subsection is zero-padded up to a multiple of four bytes.
3123 (Subsections may be padded a different amount on different flavors
3124 of @command{@value{AS}}.)
3125 @end ifset
3126 @ifclear GENERIC
3127 @ifset H8
3128 On the H8/300 platform, each subsection is zero-padded to a word
3129 boundary (two bytes).
3130 The same is true on the Renesas SH.
3131 @end ifset
3132 @ifset I960
3133 @c FIXME section padding (alignment)?
3134 @c Rich Pixley says padding here depends on target obj code format; that
3135 @c doesn't seem particularly useful to say without further elaboration,
3136 @c so for now I say nothing about it.  If this is a generic BFD issue,
3137 @c these paragraphs might need to vanish from this manual, and be
3138 @c discussed in BFD chapter of binutils (or some such).
3139 @end ifset
3140 @end ifclear
3141
3142 Subsections appear in your object file in numeric order, lowest numbered
3143 to highest.  (All this to be compatible with other people's assemblers.)
3144 The object file contains no representation of subsections; @code{@value{LD}} and
3145 other programs that manipulate object files see no trace of them.
3146 They just see all your text subsections as a text section, and all your
3147 data subsections as a data section.
3148
3149 To specify which subsection you want subsequent statements assembled
3150 into, use a numeric argument to specify it, in a @samp{.text
3151 @var{expression}} or a @samp{.data @var{expression}} statement.
3152 @ifset COFF
3153 @ifset GENERIC
3154 When generating COFF output, you
3155 @end ifset
3156 @ifclear GENERIC
3157 You
3158 @end ifclear
3159 can also use an extra subsection
3160 argument with arbitrary named sections: @samp{.section @var{name},
3161 @var{expression}}.
3162 @end ifset
3163 @ifset ELF
3164 @ifset GENERIC
3165 When generating ELF output, you
3166 @end ifset
3167 @ifclear GENERIC
3168 You
3169 @end ifclear
3170 can also use the @code{.subsection} directive (@pxref{SubSection})
3171 to specify a subsection: @samp{.subsection @var{expression}}.
3172 @end ifset
3173 @var{Expression} should be an absolute expression
3174 (@pxref{Expressions}).  If you just say @samp{.text} then @samp{.text 0}
3175 is assumed.  Likewise @samp{.data} means @samp{.data 0}.  Assembly
3176 begins in @code{text 0}.  For instance:
3177 @smallexample
3178 .text 0     # The default subsection is text 0 anyway.
3179 .ascii "This lives in the first text subsection. *"
3180 .text 1
3181 .ascii "But this lives in the second text subsection."
3182 .data 0
3183 .ascii "This lives in the data section,"
3184 .ascii "in the first data subsection."
3185 .text 0
3186 .ascii "This lives in the first text section,"
3187 .ascii "immediately following the asterisk (*)."
3188 @end smallexample
3189
3190 Each section has a @dfn{location counter} incremented by one for every byte
3191 assembled into that section.  Because subsections are merely a convenience
3192 restricted to @command{@value{AS}} there is no concept of a subsection location
3193 counter.  There is no way to directly manipulate a location counter---but the
3194 @code{.align} directive changes it, and any label definition captures its
3195 current value.  The location counter of the section where statements are being
3196 assembled is said to be the @dfn{active} location counter.
3197
3198 @node bss
3199 @section bss Section
3200
3201 @cindex bss section
3202 @cindex common variable storage
3203 The bss section is used for local common variable storage.
3204 You may allocate address space in the bss section, but you may
3205 not dictate data to load into it before your program executes.  When
3206 your program starts running, all the contents of the bss
3207 section are zeroed bytes.
3208
3209 The @code{.lcomm} pseudo-op defines a symbol in the bss section; see
3210 @ref{Lcomm,,@code{.lcomm}}.
3211
3212 The @code{.comm} pseudo-op may be used to declare a common symbol, which is
3213 another form of uninitialized symbol; see @ref{Comm,,@code{.comm}}.
3214
3215 @ifset GENERIC
3216 When assembling for a target which supports multiple sections, such as ELF or
3217 COFF, you may switch into the @code{.bss} section and define symbols as usual;
3218 see @ref{Section,,@code{.section}}.  You may only assemble zero values into the
3219 section.  Typically the section will only contain symbol definitions and
3220 @code{.skip} directives (@pxref{Skip,,@code{.skip}}).
3221 @end ifset
3222
3223 @node Symbols
3224 @chapter Symbols
3225
3226 @cindex symbols
3227 Symbols are a central concept: the programmer uses symbols to name
3228 things, the linker uses symbols to link, and the debugger uses symbols
3229 to debug.
3230
3231 @quotation
3232 @cindex debuggers, and symbol order
3233 @emph{Warning:} @command{@value{AS}} does not place symbols in the object file in
3234 the same order they were declared.  This may break some debuggers.
3235 @end quotation
3236
3237 @menu
3238 * Labels::                      Labels
3239 * Setting Symbols::             Giving Symbols Other Values
3240 * Symbol Names::                Symbol Names
3241 * Dot::                         The Special Dot Symbol
3242 * Symbol Attributes::           Symbol Attributes
3243 @end menu
3244
3245 @node Labels
3246 @section Labels
3247
3248 @cindex labels
3249 A @dfn{label} is written as a symbol immediately followed by a colon
3250 @samp{:}.  The symbol then represents the current value of the
3251 active location counter, and is, for example, a suitable instruction
3252 operand.  You are warned if you use the same symbol to represent two
3253 different locations: the first definition overrides any other
3254 definitions.
3255
3256 @ifset HPPA
3257 On the HPPA, the usual form for a label need not be immediately followed by a
3258 colon, but instead must start in column zero.  Only one label may be defined on
3259 a single line.  To work around this, the HPPA version of @command{@value{AS}} also
3260 provides a special directive @code{.label} for defining labels more flexibly.
3261 @end ifset
3262
3263 @node Setting Symbols
3264 @section Giving Symbols Other Values
3265
3266 @cindex assigning values to symbols
3267 @cindex symbol values, assigning
3268 A symbol can be given an arbitrary value by writing a symbol, followed
3269 by an equals sign @samp{=}, followed by an expression
3270 (@pxref{Expressions}).  This is equivalent to using the @code{.set}
3271 directive.  @xref{Set,,@code{.set}}.  In the same way, using a double
3272 equals sign @samp{=}@samp{=} here represents an equivalent of the
3273 @code{.eqv} directive.  @xref{Eqv,,@code{.eqv}}.
3274
3275 @ifset Blackfin
3276 Blackfin does not support symbol assignment with @samp{=}.
3277 @end ifset
3278
3279 @node Symbol Names
3280 @section Symbol Names
3281
3282 @cindex symbol names
3283 @cindex names, symbol
3284 @ifclear SPECIAL-SYMS
3285 Symbol names begin with a letter or with one of @samp{._}.  On most
3286 machines, you can also use @code{$} in symbol names; exceptions are
3287 noted in @ref{Machine Dependencies}.  That character may be followed by any
3288 string of digits, letters, dollar signs (unless otherwise noted for a
3289 particular target machine), and underscores.
3290 @end ifclear
3291 @ifset SPECIAL-SYMS
3292 @ifset H8
3293 Symbol names begin with a letter or with one of @samp{._}.  On the
3294 Renesas SH you can also use @code{$} in symbol names.  That
3295 character may be followed by any string of digits, letters, dollar signs (save
3296 on the H8/300), and underscores.
3297 @end ifset
3298 @end ifset
3299
3300 Case of letters is significant: @code{foo} is a different symbol name
3301 than @code{Foo}.
3302
3303 Each symbol has exactly one name.  Each name in an assembly language program
3304 refers to exactly one symbol.  You may use that symbol name any number of times
3305 in a program.
3306
3307 @subheading Local Symbol Names
3308
3309 @cindex local symbol names
3310 @cindex symbol names, local
3311 A local symbol is any symbol beginning with certain local label prefixes.
3312 By default, the local label prefix is @samp{.L} for ELF systems or
3313 @samp{L} for traditional a.out systems, but each target may have its own
3314 set of local label prefixes.
3315 @ifset HPPA
3316 On the HPPA local symbols begin with @samp{L$}.
3317 @end ifset
3318
3319 Local symbols are defined and used within the assembler, but they are
3320 normally not saved in object files.  Thus, they are not visible when debugging.
3321 You may use the @samp{-L} option (@pxref{L, ,Include Local Symbols:
3322 @option{-L}}) to retain the local symbols in the object files.
3323
3324 @subheading Local Labels
3325
3326 @cindex local labels
3327 @cindex temporary symbol names
3328 @cindex symbol names, temporary
3329 Local labels help compilers and programmers use names temporarily.
3330 They create symbols which are guaranteed to be unique over the entire scope of
3331 the input source code and which can be referred to by a simple notation.
3332 To define a local label, write a label of the form @samp{@b{N}:} (where @b{N}
3333 represents any positive integer).  To refer to the most recent previous
3334 definition of that label write @samp{@b{N}b}, using the same number as when
3335 you defined the label.  To refer to the next definition of a local label, write
3336 @samp{@b{N}f}---the @samp{b} stands for ``backwards'' and the @samp{f} stands
3337 for ``forwards''.
3338
3339 There is no restriction on how you can use these labels, and you can reuse them
3340 too.  So that it is possible to repeatedly define the same local label (using
3341 the same number @samp{@b{N}}), although you can only refer to the most recently
3342 defined local label of that number (for a backwards reference) or the next
3343 definition of a specific local label for a forward reference.  It is also worth
3344 noting that the first 10 local labels (@samp{@b{0:}}@dots{}@samp{@b{9:}}) are
3345 implemented in a slightly more efficient manner than the others.
3346
3347 Here is an example:
3348
3349 @smallexample
3350 1:        branch 1f
3351 2:        branch 1b
3352 1:        branch 2f
3353 2:        branch 1b
3354 @end smallexample
3355
3356 Which is the equivalent of:
3357
3358 @smallexample
3359 label_1:  branch label_3
3360 label_2:  branch label_1
3361 label_3:  branch label_4
3362 label_4:  branch label_3
3363 @end smallexample
3364
3365 Local label names are only a notational device.  They are immediately
3366 transformed into more conventional symbol names before the assembler uses them.
3367 The symbol names are stored in the symbol table, appear in error messages, and
3368 are optionally emitted to the object file.  The names are constructed using
3369 these parts:
3370
3371 @table @code
3372 @item @emph{local label prefix}
3373 All local symbols begin with the system-specific local label prefix.
3374 Normally both @command{@value{AS}} and @code{@value{LD}} forget symbols
3375 that start with the local label prefix.  These labels are
3376 used for symbols you are never intended to see.  If you use the
3377 @samp{-L} option then @command{@value{AS}} retains these symbols in the
3378 object file. If you also instruct @code{@value{LD}} to retain these symbols,
3379 you may use them in debugging.
3380
3381 @item @var{number}
3382 This is the number that was used in the local label definition.  So if the
3383 label is written @samp{55:} then the number is @samp{55}. 
3384
3385 @item @kbd{C-B}
3386 This unusual character is included so you do not accidentally invent a symbol
3387 of the same name.  The character has ASCII value of @samp{\002} (control-B).
3388
3389 @item @emph{ordinal number}
3390 This is a serial number to keep the labels distinct.  The first definition of
3391 @samp{0:} gets the number @samp{1}.  The 15th definition of @samp{0:} gets the 
3392 number @samp{15}, and so on.  Likewise the first definition of @samp{1:} gets
3393 the number @samp{1} and its 15th definition gets @samp{15} as well.
3394 @end table
3395
3396 So for example, the first @code{1:} may be named @code{.L1@kbd{C-B}1}, and
3397 the 44th @code{3:} may be named @code{.L3@kbd{C-B}44}.
3398
3399 @subheading Dollar Local Labels
3400 @cindex dollar local symbols
3401
3402 @code{@value{AS}} also supports an even more local form of local labels called
3403 dollar labels.  These labels go out of scope (i.e., they become undefined) as
3404 soon as a non-local label is defined.  Thus they remain valid for only a small
3405 region of the input source code.  Normal local labels, by contrast, remain in
3406 scope for the entire file, or until they are redefined by another occurrence of
3407 the same local label.
3408
3409 Dollar labels are defined in exactly the same way as ordinary local labels,
3410 except that they have a dollar sign suffix to their numeric value, e.g.,
3411 @samp{@b{55$:}}.
3412
3413 They can also be distinguished from ordinary local labels by their transformed
3414 names which use ASCII character @samp{\001} (control-A) as the magic character
3415 to distinguish them from ordinary labels.  For example, the fifth definition of
3416 @samp{6$} may be named @samp{.L6@kbd{C-A}5}.
3417
3418 @node Dot
3419 @section The Special Dot Symbol
3420
3421 @cindex dot (symbol)
3422 @cindex @code{.} (symbol)
3423 @cindex current address
3424 @cindex location counter
3425 The special symbol @samp{.} refers to the current address that
3426 @command{@value{AS}} is assembling into.  Thus, the expression @samp{melvin:
3427 .long .} defines @code{melvin} to contain its own address.
3428 Assigning a value to @code{.} is treated the same as a @code{.org}
3429 directive.
3430 @ifclear no-space-dir
3431 Thus, the expression @samp{.=.+4} is the same as saying
3432 @samp{.space 4}.
3433 @end ifclear
3434
3435 @node Symbol Attributes
3436 @section Symbol Attributes
3437
3438 @cindex symbol attributes
3439 @cindex attributes, symbol
3440 Every symbol has, as well as its name, the attributes ``Value'' and
3441 ``Type''.  Depending on output format, symbols can also have auxiliary
3442 attributes.
3443 @ifset INTERNALS
3444 The detailed definitions are in @file{a.out.h}.
3445 @end ifset
3446
3447 If you use a symbol without defining it, @command{@value{AS}} assumes zero for
3448 all these attributes, and probably won't warn you.  This makes the
3449 symbol an externally defined symbol, which is generally what you
3450 would want.
3451
3452 @menu
3453 * Symbol Value::                Value
3454 * Symbol Type::                 Type
3455 @ifset aout-bout
3456 @ifset GENERIC
3457 * a.out Symbols::               Symbol Attributes: @code{a.out}
3458 @end ifset
3459 @ifclear GENERIC
3460 @ifclear BOUT
3461 * a.out Symbols::               Symbol Attributes: @code{a.out}
3462 @end ifclear
3463 @ifset BOUT
3464 * a.out Symbols::               Symbol Attributes: @code{a.out}, @code{b.out}
3465 @end ifset
3466 @end ifclear
3467 @end ifset
3468 @ifset COFF
3469 * COFF Symbols::                Symbol Attributes for COFF
3470 @end ifset
3471 @ifset SOM
3472 * SOM Symbols::                Symbol Attributes for SOM
3473 @end ifset
3474 @end menu
3475
3476 @node Symbol Value
3477 @subsection Value
3478
3479 @cindex value of a symbol
3480 @cindex symbol value
3481 The value of a symbol is (usually) 32 bits.  For a symbol which labels a
3482 location in the text, data, bss or absolute sections the value is the
3483 number of addresses from the start of that section to the label.
3484 Naturally for text, data and bss sections the value of a symbol changes
3485 as @code{@value{LD}} changes section base addresses during linking.  Absolute
3486 symbols' values do not change during linking: that is why they are
3487 called absolute.
3488
3489 The value of an undefined symbol is treated in a special way.  If it is
3490 0 then the symbol is not defined in this assembler source file, and
3491 @code{@value{LD}} tries to determine its value from other files linked into the
3492 same program.  You make this kind of symbol simply by mentioning a symbol
3493 name without defining it.  A non-zero value represents a @code{.comm}
3494 common declaration.  The value is how much common storage to reserve, in
3495 bytes (addresses).  The symbol refers to the first address of the
3496 allocated storage.
3497
3498 @node Symbol Type
3499 @subsection Type
3500
3501 @cindex type of a symbol
3502 @cindex symbol type
3503 The type attribute of a symbol contains relocation (section)
3504 information, any flag settings indicating that a symbol is external, and
3505 (optionally), other information for linkers and debuggers.  The exact
3506 format depends on the object-code output format in use.
3507
3508 @ifset aout-bout
3509 @ifclear GENERIC
3510 @ifset BOUT
3511 @c The following avoids a "widow" subsection title.  @group would be
3512 @c better if it were available outside examples.
3513 @need 1000
3514 @node a.out Symbols
3515 @subsection Symbol Attributes: @code{a.out}, @code{b.out}
3516
3517 @cindex @code{b.out} symbol attributes
3518 @cindex symbol attributes, @code{b.out}
3519 These symbol attributes appear only when @command{@value{AS}} is configured for
3520 one of the Berkeley-descended object output formats---@code{a.out} or
3521 @code{b.out}.
3522
3523 @end ifset
3524 @ifclear BOUT
3525 @node a.out Symbols
3526 @subsection Symbol Attributes: @code{a.out}
3527
3528 @cindex @code{a.out} symbol attributes
3529 @cindex symbol attributes, @code{a.out}
3530
3531 @end ifclear
3532 @end ifclear
3533 @ifset GENERIC
3534 @node a.out Symbols
3535 @subsection Symbol Attributes: @code{a.out}
3536
3537 @cindex @code{a.out} symbol attributes
3538 @cindex symbol attributes, @code{a.out}
3539
3540 @end ifset
3541 @menu
3542 * Symbol Desc::                 Descriptor
3543 * Symbol Other::                Other
3544 @end menu
3545
3546 @node Symbol Desc
3547 @subsubsection Descriptor
3548
3549 @cindex descriptor, of @code{a.out} symbol
3550 This is an arbitrary 16-bit value.  You may establish a symbol's
3551 descriptor value by using a @code{.desc} statement
3552 (@pxref{Desc,,@code{.desc}}).  A descriptor value means nothing to
3553 @command{@value{AS}}.
3554
3555 @node Symbol Other
3556 @subsubsection Other
3557
3558 @cindex other attribute, of @code{a.out} symbol
3559 This is an arbitrary 8-bit value.  It means nothing to @command{@value{AS}}.
3560 @end ifset
3561
3562 @ifset COFF
3563 @node COFF Symbols
3564 @subsection Symbol Attributes for COFF
3565
3566 @cindex COFF symbol attributes
3567 @cindex symbol attributes, COFF
3568
3569 The COFF format supports a multitude of auxiliary symbol attributes;
3570 like the primary symbol attributes, they are set between @code{.def} and
3571 @code{.endef} directives.
3572
3573 @subsubsection Primary Attributes
3574
3575 @cindex primary attributes, COFF symbols
3576 The symbol name is set with @code{.def}; the value and type,
3577 respectively, with @code{.val} and @code{.type}.
3578
3579 @subsubsection Auxiliary Attributes
3580
3581 @cindex auxiliary attributes, COFF symbols
3582 The @command{@value{AS}} directives @code{.dim}, @code{.line}, @code{.scl},
3583 @code{.size}, @code{.tag}, and @code{.weak} can generate auxiliary symbol
3584 table information for COFF.
3585 @end ifset
3586
3587 @ifset SOM
3588 @node SOM Symbols
3589 @subsection Symbol Attributes for SOM
3590
3591 @cindex SOM symbol attributes
3592 @cindex symbol attributes, SOM
3593
3594 The SOM format for the HPPA supports a multitude of symbol attributes set with
3595 the @code{.EXPORT} and @code{.IMPORT} directives.
3596
3597 The attributes are described in @cite{HP9000 Series 800 Assembly 
3598 Language Reference Manual} (HP 92432-90001) under the @code{IMPORT} and
3599 @code{EXPORT} assembler directive documentation.
3600 @end ifset
3601
3602 @node Expressions
3603 @chapter Expressions
3604
3605 @cindex expressions
3606 @cindex addresses
3607 @cindex numeric values
3608 An @dfn{expression} specifies an address or numeric value.
3609 Whitespace may precede and/or follow an expression.
3610
3611 The result of an expression must be an absolute number, or else an offset into
3612 a particular section.  If an expression is not absolute, and there is not
3613 enough information when @command{@value{AS}} sees the expression to know its
3614 section, a second pass over the source program might be necessary to interpret
3615 the expression---but the second pass is currently not implemented.
3616 @command{@value{AS}} aborts with an error message in this situation.
3617
3618 @menu
3619 * Empty Exprs::                 Empty Expressions
3620 * Integer Exprs::               Integer Expressions
3621 @end menu
3622
3623 @node Empty Exprs
3624 @section Empty Expressions
3625
3626 @cindex empty expressions
3627 @cindex expressions, empty
3628 An empty expression has no value: it is just whitespace or null.
3629 Wherever an absolute expression is required, you may omit the
3630 expression, and @command{@value{AS}} assumes a value of (absolute) 0.  This
3631 is compatible with other assemblers.
3632
3633 @node Integer Exprs
3634 @section Integer Expressions
3635
3636 @cindex integer expressions
3637 @cindex expressions, integer
3638 An @dfn{integer expression} is one or more @emph{arguments} delimited
3639 by @emph{operators}.
3640
3641 @menu
3642 * Arguments::                   Arguments
3643 * Operators::                   Operators
3644 * Prefix Ops::                  Prefix Operators
3645 * Infix Ops::                   Infix Operators
3646 @end menu
3647
3648 @node Arguments
3649 @subsection Arguments
3650
3651 @cindex expression arguments
3652 @cindex arguments in expressions
3653 @cindex operands in expressions
3654 @cindex arithmetic operands
3655 @dfn{Arguments} are symbols, numbers or subexpressions.  In other
3656 contexts arguments are sometimes called ``arithmetic operands''.  In
3657 this manual, to avoid confusing them with the ``instruction operands'' of
3658 the machine language, we use the term ``argument'' to refer to parts of
3659 expressions only, reserving the word ``operand'' to refer only to machine
3660 instruction operands.
3661
3662 Symbols are evaluated to yield @{@var{section} @var{NNN}@} where
3663 @var{section} is one of text, data, bss, absolute,
3664 or undefined.  @var{NNN} is a signed, 2's complement 32 bit
3665 integer.
3666
3667 Numbers are usually integers.
3668
3669 A number can be a flonum or bignum.  In this case, you are warned
3670 that only the low order 32 bits are used, and @command{@value{AS}} pretends
3671 these 32 bits are an integer.  You may write integer-manipulating
3672 instructions that act on exotic constants, compatible with other
3673 assemblers.
3674
3675 @cindex subexpressions
3676 Subexpressions are a left parenthesis @samp{(} followed by an integer
3677 expression, followed by a right parenthesis @samp{)}; or a prefix
3678 operator followed by an argument.
3679
3680 @node Operators
3681 @subsection Operators
3682
3683 @cindex operators, in expressions
3684 @cindex arithmetic functions
3685 @cindex functions, in expressions
3686 @dfn{Operators} are arithmetic functions, like @code{+} or @code{%}.  Prefix
3687 operators are followed by an argument.  Infix operators appear
3688 between their arguments.  Operators may be preceded and/or followed by
3689 whitespace.
3690
3691 @node Prefix Ops
3692 @subsection Prefix Operator
3693
3694 @cindex prefix operators
3695 @command{@value{AS}} has the following @dfn{prefix operators}.  They each take
3696 one argument, which must be absolute.
3697
3698 @c the tex/end tex stuff surrounding this small table is meant to make
3699 @c it align, on the printed page, with the similar table in the next
3700 @c section (which is inside an enumerate).
3701 @tex
3702 \global\advance\leftskip by \itemindent
3703 @end tex
3704
3705 @table @code
3706 @item -
3707 @dfn{Negation}.  Two's complement negation.
3708 @item ~
3709 @dfn{Complementation}.  Bitwise not.
3710 @end table
3711
3712 @tex
3713 \global\advance\leftskip by -\itemindent
3714 @end tex
3715
3716 @node Infix Ops
3717 @subsection Infix Operators
3718
3719 @cindex infix operators
3720 @cindex operators, permitted arguments
3721 @dfn{Infix operators} take two arguments, one on either side.  Operators
3722 have precedence, but operations with equal precedence are performed left
3723 to right.  Apart from @code{+} or @option{-}, both arguments must be
3724 absolute, and the result is absolute.
3725
3726 @enumerate
3727 @cindex operator precedence
3728 @cindex precedence of operators
3729
3730 @item
3731 Highest Precedence
3732
3733 @table @code
3734 @item *
3735 @dfn{Multiplication}.
3736
3737 @item /
3738 @dfn{Division}.  Truncation is the same as the C operator @samp{/}
3739
3740 @item %
3741 @dfn{Remainder}.
3742
3743 @item <<
3744 @dfn{Shift Left}.  Same as the C operator @samp{<<}.
3745
3746 @item >>
3747 @dfn{Shift Right}.  Same as the C operator @samp{>>}.
3748 @end table
3749
3750 @item
3751 Intermediate precedence
3752
3753 @table @code
3754 @item |
3755
3756 @dfn{Bitwise Inclusive Or}.
3757
3758 @item &
3759 @dfn{Bitwise And}.
3760
3761 @item ^
3762 @dfn{Bitwise Exclusive Or}.
3763
3764 @item !
3765 @dfn{Bitwise Or Not}.
3766 @end table
3767
3768 @item
3769 Low Precedence
3770
3771 @table @code
3772 @cindex addition, permitted arguments
3773 @cindex plus, permitted arguments
3774 @cindex arguments for addition
3775 @item +
3776 @dfn{Addition}.  If either argument is absolute, the result has the section of
3777 the other argument.  You may not add together arguments from different
3778 sections.
3779
3780 @cindex subtraction, permitted arguments
3781 @cindex minus, permitted arguments
3782 @cindex arguments for subtraction
3783 @item -
3784 @dfn{Subtraction}.  If the right argument is absolute, the
3785 result has the section of the left argument.
3786 If both arguments are in the same section, the result is absolute.
3787 You may not subtract arguments from different sections.
3788 @c FIXME is there still something useful to say about undefined - undefined ?
3789
3790 @cindex comparison expressions
3791 @cindex expressions, comparison
3792 @item  ==
3793 @dfn{Is Equal To}
3794 @item <>
3795 @itemx !=
3796 @dfn{Is Not Equal To}
3797 @item <
3798 @dfn{Is Less Than}
3799 @item >
3800 @dfn{Is Greater Than}
3801 @item >=
3802 @dfn{Is Greater Than Or Equal To}
3803 @item <=
3804 @dfn{Is Less Than Or Equal To}
3805
3806 The comparison operators can be used as infix operators.  A true results has a
3807 value of -1 whereas a false result has a value of 0.   Note, these operators
3808 perform signed comparisons.
3809 @end table
3810
3811 @item Lowest Precedence
3812
3813 @table @code
3814 @item &&
3815 @dfn{Logical And}.
3816
3817 @item ||
3818 @dfn{Logical Or}.
3819
3820 These two logical operations can be used to combine the results of sub
3821 expressions.  Note, unlike the comparison operators a true result returns a
3822 value of 1 but a false results does still return 0.  Also note that the logical
3823 or operator has a slightly lower precedence than logical and.
3824
3825 @end table
3826 @end enumerate
3827
3828 In short, it's only meaningful to add or subtract the @emph{offsets} in an
3829 address; you can only have a defined section in one of the two arguments.
3830
3831 @node Pseudo Ops
3832 @chapter Assembler Directives
3833
3834 @cindex directives, machine independent
3835 @cindex pseudo-ops, machine independent
3836 @cindex machine independent directives
3837 All assembler directives have names that begin with a period (@samp{.}).
3838 The rest of the name is letters, usually in lower case.
3839
3840 This chapter discusses directives that are available regardless of the
3841 target machine configuration for the @sc{gnu} assembler.
3842 @ifset GENERIC
3843 Some machine configurations provide additional directives.
3844 @xref{Machine Dependencies}.
3845 @end ifset
3846 @ifclear GENERIC
3847 @ifset machine-directives
3848 @xref{Machine Dependencies}, for additional directives.
3849 @end ifset
3850 @end ifclear
3851
3852 @menu
3853 * Abort::                       @code{.abort}
3854 @ifset COFF
3855 * ABORT (COFF)::                @code{.ABORT}
3856 @end ifset
3857
3858 * Align::                       @code{.align @var{abs-expr} , @var{abs-expr}}
3859 * Altmacro::                    @code{.altmacro}
3860 * Ascii::                       @code{.ascii "@var{string}"}@dots{}
3861 * Asciz::                       @code{.asciz "@var{string}"}@dots{}
3862 * Balign::                      @code{.balign @var{abs-expr} , @var{abs-expr}}
3863 * Byte::                        @code{.byte @var{expressions}}
3864 * CFI directives::              @code{.cfi_startproc [simple]}, @code{.cfi_endproc}, etc.
3865 * Comm::                        @code{.comm @var{symbol} , @var{length} }
3866 * Data::                        @code{.data @var{subsection}}
3867 @ifset COFF
3868 * Def::                         @code{.def @var{name}}
3869 @end ifset
3870 @ifset aout-bout
3871 * Desc::                        @code{.desc @var{symbol}, @var{abs-expression}}
3872 @end ifset
3873 @ifset COFF
3874 * Dim::                         @code{.dim}
3875 @end ifset
3876
3877 * Double::                      @code{.double @var{flonums}}
3878 * Eject::                       @code{.eject}
3879 * Else::                        @code{.else}
3880 * Elseif::                      @code{.elseif}
3881 * End::                         @code{.end}
3882 @ifset COFF
3883 * Endef::                       @code{.endef}
3884 @end ifset
3885
3886 * Endfunc::                     @code{.endfunc}
3887 * Endif::                       @code{.endif}
3888 * Equ::                         @code{.equ @var{symbol}, @var{expression}}
3889 * Equiv::                       @code{.equiv @var{symbol}, @var{expression}}
3890 * Eqv::                         @code{.eqv @var{symbol}, @var{expression}}
3891 * Err::                         @code{.err}
3892 * Error::                       @code{.error @var{string}}
3893 * Exitm::                       @code{.exitm}
3894 * Extern::                      @code{.extern}
3895 * Fail::                        @code{.fail}
3896 * File::                        @code{.file}
3897 * Fill::                        @code{.fill @var{repeat} , @var{size} , @var{value}}
3898 * Float::                       @code{.float @var{flonums}}
3899 * Func::                        @code{.func}  
3900 * Global::                      @code{.global @var{symbol}}, @code{.globl @var{symbol}}
3901 @ifset ELF
3902 * Gnu_attribute::               @code{.gnu_attribute @var{tag},@var{value}}
3903 * Hidden::                      @code{.hidden @var{names}}
3904 @end ifset
3905
3906 * hword::                       @code{.hword @var{expressions}}
3907 * Ident::                       @code{.ident}
3908 * If::                          @code{.if @var{absolute expression}}
3909 * Incbin::                      @code{.incbin "@var{file}"[,@var{skip}[,@var{count}]]}
3910 * Include::                     @code{.include "@var{file}"}
3911 * Int::                         @code{.int @var{expressions}}
3912 @ifset ELF
3913 * Internal::                    @code{.internal @var{names}}
3914 @end ifset
3915
3916 * Irp::                         @code{.irp @var{symbol},@var{values}}@dots{}
3917 * Irpc::                        @code{.irpc @var{symbol},@var{values}}@dots{}
3918 * Lcomm::                       @code{.lcomm @var{symbol} , @var{length}}
3919 * Lflags::                      @code{.lflags}
3920 @ifclear no-line-dir
3921 * Line::                        @code{.line @var{line-number}}
3922 @end ifclear
3923
3924 * Linkonce::                    @code{.linkonce [@var{type}]}
3925 * List::                        @code{.list}
3926 * Ln::                          @code{.ln @var{line-number}}
3927 * Loc::                         @code{.loc @var{fileno} @var{lineno}}
3928 * Loc_mark_labels::             @code{.loc_mark_labels @var{enable}}
3929 @ifset ELF
3930 * Local::                       @code{.local @var{names}}
3931 @end ifset
3932
3933 * Long::                        @code{.long @var{expressions}}
3934 @ignore
3935 * Lsym::                        @code{.lsym @var{symbol}, @var{expression}}
3936 @end ignore
3937
3938 * Macro::                       @code{.macro @var{name} @var{args}}@dots{}
3939 * MRI::                         @code{.mri @var{val}}
3940 * Noaltmacro::                  @code{.noaltmacro}
3941 * Nolist::                      @code{.nolist}
3942 * Octa::                        @code{.octa @var{bignums}}
3943 * Org::                         @code{.org @var{new-lc}, @var{fill}}
3944 * P2align::                     @code{.p2align @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
3945 @ifset ELF
3946 * PopSection::                  @code{.popsection}
3947 * Previous::                    @code{.previous}
3948 @end ifset
3949
3950 * Print::                       @code{.print @var{string}}
3951 @ifset ELF
3952 * Protected::                   @code{.protected @var{names}}
3953 @end ifset
3954
3955 * Psize::                       @code{.psize @var{lines}, @var{columns}}
3956 * Purgem::                      @code{.purgem @var{name}}
3957 @ifset ELF
3958 * PushSection::                 @code{.pushsection @var{name}}
3959 @end ifset
3960
3961 * Quad::                        @code{.quad @var{bignums}}
3962 * Reloc::                       @code{.reloc @var{offset}, @var{reloc_name}[, @var{expression}]}
3963 * Rept::                        @code{.rept @var{count}}
3964 * Sbttl::                       @code{.sbttl "@var{subheading}"}
3965 @ifset COFF
3966 * Scl::                         @code{.scl @var{class}}
3967 @end ifset
3968 @ifset COFF-ELF
3969 * Section::                     @code{.section @var{name}[, @var{flags}]}
3970 @end ifset
3971
3972 * Set::                         @code{.set @var{symbol}, @var{expression}}
3973 * Short::                       @code{.short @var{expressions}}
3974 * Single::                      @code{.single @var{flonums}}
3975 @ifset COFF-ELF
3976 * Size::                        @code{.size [@var{name} , @var{expression}]}
3977 @end ifset
3978 @ifclear no-space-dir
3979 * Skip::                        @code{.skip @var{size} , @var{fill}}
3980 @end ifclear
3981
3982 * Sleb128::                     @code{.sleb128 @var{expressions}}
3983 @ifclear no-space-dir
3984 * Space::                       @code{.space @var{size} , @var{fill}}
3985 @end ifclear
3986 @ifset have-stabs
3987 * Stab::                        @code{.stabd, .stabn, .stabs}
3988 @end ifset
3989
3990 * String::                      @code{.string "@var{str}"}, @code{.string8 "@var{str}"}, @code{.string16 "@var{str}"}, @code{.string32 "@var{str}"}, @code{.string64 "@var{str}"}
3991 * Struct::                      @code{.struct @var{expression}}
3992 @ifset ELF
3993 * SubSection::                  @code{.subsection}
3994 * Symver::                      @code{.symver @var{name},@var{name2@@nodename}}
3995 @end ifset
3996
3997 @ifset COFF
3998 * Tag::                         @code{.tag @var{structname}}
3999 @end ifset
4000
4001 * Text::                        @code{.text @var{subsection}}
4002 * Title::                       @code{.title "@var{heading}"}
4003 @ifset COFF-ELF
4004 * Type::                        @code{.type <@var{int} | @var{name} , @var{type description}>}
4005 @end ifset
4006
4007 * Uleb128::                     @code{.uleb128 @var{expressions}}
4008 @ifset COFF
4009 * Val::                         @code{.val @var{addr}}
4010 @end ifset
4011
4012 @ifset ELF
4013 * Version::                     @code{.version "@var{string}"}
4014 * VTableEntry::                 @code{.vtable_entry @var{table}, @var{offset}}
4015 * VTableInherit::               @code{.vtable_inherit @var{child}, @var{parent}}
4016 @end ifset
4017
4018 * Warning::                     @code{.warning @var{string}}
4019 * Weak::                        @code{.weak @var{names}}
4020 * Weakref::                     @code{.weakref @var{alias}, @var{symbol}}
4021 * Word::                        @code{.word @var{expressions}}
4022 * Deprecated::                  Deprecated Directives
4023 @end menu
4024
4025 @node Abort
4026 @section @code{.abort}
4027
4028 @cindex @code{abort} directive
4029 @cindex stopping the assembly
4030 This directive stops the assembly immediately.  It is for
4031 compatibility with other assemblers.  The original idea was that the
4032 assembly language source would be piped into the assembler.  If the sender
4033 of the source quit, it could use this directive tells @command{@value{AS}} to
4034 quit also.  One day @code{.abort} will not be supported.
4035
4036 @ifset COFF
4037 @node ABORT (COFF)
4038 @section @code{.ABORT} (COFF)
4039
4040 @cindex @code{ABORT} directive
4041 When producing COFF output, @command{@value{AS}} accepts this directive as a
4042 synonym for @samp{.abort}.
4043
4044 @ifset BOUT
4045 When producing @code{b.out} output, @command{@value{AS}} accepts this directive,
4046 but ignores it.
4047 @end ifset
4048 @end ifset
4049
4050 @node Align
4051 @section @code{.align @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
4052
4053 @cindex padding the location counter
4054 @cindex @code{align} directive
4055 Pad the location counter (in the current subsection) to a particular storage
4056 boundary.  The first expression (which must be absolute) is the alignment
4057 required, as described below.
4058
4059 The second expression (also absolute) gives the fill value to be stored in the
4060 padding bytes.  It (and the comma) may be omitted.  If it is omitted, the
4061 padding bytes are normally zero.  However, on some systems, if the section is
4062 marked as containing code and the fill value is omitted, the space is filled
4063 with no-op instructions.
4064
4065 The third expression is also absolute, and is also optional.  If it is present,
4066 it is the maximum number of bytes that should be skipped by this alignment
4067 directive.  If doing the alignment would require skipping more bytes than the
4068 specified maximum, then the alignment is not done at all.  You can omit the
4069 fill value (the second argument) entirely by simply using two commas after the
4070 required alignment; this can be useful if you want the alignment to be filled
4071 with no-op instructions when appropriate.
4072
4073 The way the required alignment is specified varies from system to system.
4074 For the arc, hppa, i386 using ELF, i860, iq2000, m68k, or32,
4075 s390, sparc, tic4x, tic80 and xtensa, the first expression is the
4076 alignment request in bytes.  For example @samp{.align 8} advances
4077 the location counter until it is a multiple of 8.  If the location counter
4078 is already a multiple of 8, no change is needed.  For the tic54x, the
4079 first expression is the alignment request in words.
4080
4081 For other systems, including ppc, i386 using a.out format, arm and
4082 strongarm, it is the
4083 number of low-order zero bits the location counter must have after
4084 advancement.  For example @samp{.align 3} advances the location
4085 counter until it a multiple of 8.  If the location counter is already a
4086 multiple of 8, no change is needed.
4087
4088 This inconsistency is due to the different behaviors of the various
4089 native assemblers for these systems which GAS must emulate.
4090 GAS also provides @code{.balign} and @code{.p2align} directives,
4091 described later, which have a consistent behavior across all
4092 architectures (but are specific to GAS).
4093
4094 @node Altmacro
4095 @section @code{.altmacro}
4096 Enable alternate macro mode, enabling:
4097
4098 @ftable @code
4099 @item LOCAL @var{name} [ , @dots{} ]
4100 One additional directive, @code{LOCAL}, is available.  It is used to
4101 generate a string replacement for each of the @var{name} arguments, and
4102 replace any instances of @var{name} in each macro expansion.  The
4103 replacement string is unique in the assembly, and different for each
4104 separate macro expansion.  @code{LOCAL} allows you to write macros that
4105 define symbols, without fear of conflict between separate macro expansions.
4106
4107 @item String delimiters
4108 You can write strings delimited in these other ways besides
4109 @code{"@var{string}"}:
4110
4111 @table @code
4112 @item '@var{string}'
4113 You can delimit strings with single-quote characters.
4114
4115 @item <@var{string}>
4116 You can delimit strings with matching angle brackets.
4117 @end table
4118
4119 @item single-character string escape
4120 To include any single character literally in a string (even if the
4121 character would otherwise have some special meaning), you can prefix the
4122 character with @samp{!} (an exclamation mark).  For example, you can
4123 write @samp{<4.3 !> 5.4!!>} to get the literal text @samp{4.3 > 5.4!}.
4124
4125 @item Expression results as strings
4126 You can write @samp{%@var{expr}} to evaluate the expression @var{expr}
4127 and use the result as a string.  
4128 @end ftable
4129
4130 @node Ascii
4131 @section @code{.ascii "@var{string}"}@dots{}
4132
4133 @cindex @code{ascii} directive
4134 @cindex string literals
4135 @code{.ascii} expects zero or more string literals (@pxref{Strings})
4136 separated by commas.  It assembles each string (with no automatic
4137 trailing zero byte) into consecutive addresses.
4138
4139 @node Asciz
4140 @section @code{.asciz "@var{string}"}@dots{}
4141
4142 @cindex @code{asciz} directive
4143 @cindex zero-terminated strings
4144 @cindex null-terminated strings
4145 @code{.asciz} is just like @code{.ascii}, but each string is followed by
4146 a zero byte.  The ``z'' in @samp{.asciz} stands for ``zero''.
4147
4148 @node Balign
4149 @section @code{.balign[wl] @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
4150
4151 @cindex padding the location counter given number of bytes
4152 @cindex @code{balign} directive
4153 Pad the location counter (in the current subsection) to a particular
4154 storage boundary.  The first expression (which must be absolute) is the
4155 alignment request in bytes.  For example @samp{.balign 8} advances
4156 the location counter until it is a multiple of 8.  If the location counter
4157 is already a multiple of 8, no change is needed.
4158
4159 The second expression (also absolute) gives the fill value to be stored in the
4160 padding bytes.  It (and the comma) may be omitted.  If it is omitted, the
4161 padding bytes are normally zero.  However, on some systems, if the section is
4162 marked as containing code and the fill value is omitted, the space is filled
4163 with no-op instructions.
4164
4165 The third expression is also absolute, and is also optional.  If it is present,
4166 it is the maximum number of bytes that should be skipped by this alignment
4167 directive.  If doing the alignment would require skipping more bytes than the
4168 specified maximum, then the alignment is not done at all.  You can omit the
4169 fill value (the second argument) entirely by simply using two commas after the
4170 required alignment; this can be useful if you want the alignment to be filled
4171 with no-op instructions when appropriate.
4172
4173 @cindex @code{balignw} directive
4174 @cindex @code{balignl} directive
4175 The @code{.balignw} and @code{.balignl} directives are variants of the
4176 @code{.balign} directive.  The @code{.balignw} directive treats the fill
4177 pattern as a two byte word value.  The @code{.balignl} directives treats the
4178 fill pattern as a four byte longword value.  For example, @code{.balignw
4179 4,0x368d} will align to a multiple of 4.  If it skips two bytes, they will be
4180 filled in with the value 0x368d (the exact placement of the bytes depends upon
4181 the endianness of the processor).  If it skips 1 or 3 bytes, the fill value is
4182 undefined.
4183
4184 @node Byte
4185 @section @code{.byte @var{expressions}}
4186
4187 @cindex @code{byte} directive
4188 @cindex integers, one byte
4189 @code{.byte} expects zero or more expressions, separated by commas.
4190 Each expression is assembled into the next byte.
4191
4192 @node CFI directives
4193 @section @code{.cfi_startproc [simple]}
4194 @cindex @code{cfi_startproc} directive
4195 @code{.cfi_startproc} is used at the beginning of each function that
4196 should have an entry in @code{.eh_frame}. It initializes some internal
4197 data structures. Don't forget to close the function by
4198 @code{.cfi_endproc}.
4199
4200 @section @code{.cfi_sections @var{section_list}}
4201 @cindex @code{cfi_sections} directive
4202 @code{.cfi_sections} may be used to specify whether CFI directives
4203 should emit @code{.eh_frame} section and/or @code{.debug_frame} section.
4204 If @var{section_list} is @code{.eh_frame}, @code{.eh_frame} is emitted,
4205 if @var{section_list} is @code{.debug_frame}, @code{.debug_frame} is emitted.
4206 To emit both use @code{.eh_frame, .debug_frame}.  The default if this
4207 directive is not used is @code{.cfi_sections .eh_frame}.
4208
4209 Unless @code{.cfi_startproc} is used along with parameter @code{simple} 
4210 it also emits some architecture dependent initial CFI instructions.
4211  
4212 @section @code{.cfi_endproc}
4213 @cindex @code{cfi_endproc} directive
4214 @code{.cfi_endproc} is used at the end of a function where it closes its
4215 unwind entry previously opened by
4216 @code{.cfi_startproc}, and emits it to @code{.eh_frame}.
4217
4218 @section @code{.cfi_personality @var{encoding} [, @var{exp}]}
4219 @code{.cfi_personality} defines personality routine and its encoding.
4220 @var{encoding} must be a constant determining how the personality
4221 should be encoded.  If it is 255 (@code{DW_EH_PE_omit}), second
4222 argument is not present, otherwise second argument should be
4223 a constant or a symbol name.  When using indirect encodings,
4224 the symbol provided should be the location where personality
4225 can be loaded from, not the personality routine itself.
4226 The default after @code{.cfi_startproc} is @code{.cfi_personality 0xff},
4227 no personality routine.
4228
4229 @section @code{.cfi_lsda @var{encoding} [, @var{exp}]}
4230 @code{.cfi_lsda} defines LSDA and its encoding.
4231 @var{encoding} must be a constant determining how the LSDA
4232 should be encoded.  If it is 255 (@code{DW_EH_PE_omit}), second
4233 argument is not present, otherwise second argument should be a constant
4234 or a symbol name.  The default after @code{.cfi_startproc} is @code{.cfi_lsda 0xff},
4235 no LSDA.
4236
4237 @section @code{.cfi_def_cfa @var{register}, @var{offset}}
4238 @code{.cfi_def_cfa} defines a rule for computing CFA as: @i{take 
4239 address from @var{register} and add @var{offset} to it}.
4240
4241 @section @code{.cfi_def_cfa_register @var{register}}
4242 @code{.cfi_def_cfa_register} modifies a rule for computing CFA. From
4243 now on @var{register} will be used instead of the old one. Offset
4244 remains the same.
4245
4246 @section @code{.cfi_def_cfa_offset @var{offset}}
4247 @code{.cfi_def_cfa_offset} modifies a rule for computing CFA. Register
4248 remains the same, but @var{offset} is new. Note that it is the
4249 absolute offset that will be added to a defined register to compute
4250 CFA address.
4251
4252 @section @code{.cfi_adjust_cfa_offset @var{offset}}
4253 Same as @code{.cfi_def_cfa_offset} but @var{offset} is a relative
4254 value that is added/substracted from the previous offset.
4255
4256 @section @code{.cfi_offset @var{register}, @var{offset}}
4257 Previous value of @var{register} is saved at offset @var{offset} from
4258 CFA. 
4259
4260 @section @code{.cfi_rel_offset @var{register}, @var{offset}}
4261 Previous value of @var{register} is saved at offset @var{offset} from
4262 the current CFA register.  This is transformed to @code{.cfi_offset}
4263 using the known displacement of the CFA register from the CFA.
4264 This is often easier to use, because the number will match the
4265 code it's annotating.
4266
4267 @section @code{.cfi_register @var{register1}, @var{register2}}
4268 Previous value of @var{register1} is saved in register @var{register2}.
4269
4270 @section @code{.cfi_restore @var{register}}
4271 @code{.cfi_restore} says that the rule for @var{register} is now the 
4272 same as it was at the beginning of the function, after all initial 
4273 instruction added by @code{.cfi_startproc} were executed.
4274
4275 @section @code{.cfi_undefined @var{register}}
4276 From now on the previous value of @var{register} can't be restored anymore.
4277
4278 @section @code{.cfi_same_value @var{register}}
4279 Current value of @var{register} is the same like in the previous frame, 
4280 i.e. no restoration needed.
4281
4282 @section @code{.cfi_remember_state}, 
4283 First save all current rules for all registers by @code{.cfi_remember_state}, 
4284 then totally screw them up by subsequent @code{.cfi_*} directives and when 
4285 everything is hopelessly bad, use @code{.cfi_restore_state} to restore 
4286 the previous saved state.
4287
4288 @section @code{.cfi_return_column @var{register}}
4289 Change return column @var{register}, i.e. the return address is either 
4290 directly in @var{register} or can be accessed by rules for @var{register}.
4291
4292 @section @code{.cfi_signal_frame}
4293 Mark current function as signal trampoline.
4294
4295 @section @code{.cfi_window_save}
4296 SPARC register window has been saved.
4297
4298 @section @code{.cfi_escape} @var{expression}[, @dots{}]
4299 Allows the user to add arbitrary bytes to the unwind info.  One
4300 might use this to add OS-specific CFI opcodes, or generic CFI
4301 opcodes that GAS does not yet support.
4302
4303 @section @code{.cfi_val_encoded_addr @var{register}, @var{encoding}, @var{label}}
4304 The current value of @var{register} is @var{label}.  The value of @var{label}
4305 will be encoded in the output file according to @var{encoding}; see the
4306 description of @code{.cfi_personality} for details on this encoding.
4307
4308 The usefulness of equating a register to a fixed label is probably
4309 limited to the return address register.  Here, it can be useful to
4310 mark a code segment that has only one return address which is reached
4311 by a direct branch and no copy of the return address exists in memory
4312 or another register.
4313
4314 @node Comm
4315 @section @code{.comm @var{symbol} , @var{length} }
4316
4317 @cindex @code{comm} directive
4318 @cindex symbol, common
4319 @code{.comm} declares a common symbol named @var{symbol}.  When linking, a
4320 common symbol in one object file may be merged with a defined or common symbol
4321 of the same name in another object file.  If @code{@value{LD}} does not see a
4322 definition for the symbol--just one or more common symbols--then it will
4323 allocate @var{length} bytes of uninitialized memory.  @var{length} must be an
4324 absolute expression.  If @code{@value{LD}} sees multiple common symbols with
4325 the same name, and they do not all have the same size, it will allocate space
4326 using the largest size.
4327
4328 @ifset COFF-ELF
4329 When using ELF or (as a GNU extension) PE, the @code{.comm} directive takes
4330 an optional third argument.  This is the desired alignment of the symbol, 
4331 specified for ELF as a byte boundary (for example, an alignment of 16 means
4332 that the least significant 4 bits of the address should be zero), and for PE
4333 as a power of two (for example, an alignment of 5 means aligned to a 32-byte
4334 boundary).  The alignment must be an absolute expression, and it must be a 
4335 power of two.  If @code{@value{LD}} allocates uninitialized memory for the
4336 common symbol, it will use the alignment when placing the symbol.  If no 
4337 alignment is specified, @command{@value{AS}} will set the alignment to the
4338 largest power of two less than or equal to the size of the symbol, up to a
4339 maximum of 16 on ELF, or the default section alignment of 4 on PE@footnote{This
4340 is not the same as the executable image file alignment controlled by @code{@value{LD}}'s
4341 @samp{--section-alignment} option; image file sections in PE are aligned to
4342 multiples of 4096, which is far too large an alignment for ordinary variables.
4343 It is rather the default alignment for (non-debug) sections within object
4344 (@samp{*.o}) files, which are less strictly aligned.}.
4345 @end ifset
4346
4347 @ifset HPPA
4348 The syntax for @code{.comm} differs slightly on the HPPA.  The syntax is
4349 @samp{@var{symbol} .comm, @var{length}}; @var{symbol} is optional.
4350 @end ifset
4351
4352 @node Data
4353 @section @code{.data @var{subsection}}
4354
4355 @cindex @code{data} directive
4356 @code{.data} tells @command{@value{AS}} to assemble the following statements onto the
4357 end of the data subsection numbered @var{subsection} (which is an
4358 absolute expression).  If @var{subsection} is omitted, it defaults
4359 to zero.
4360
4361 @ifset COFF
4362 @node Def
4363 @section @code{.def @var{name}}
4364
4365 @cindex @code{def} directive
4366 @cindex COFF symbols, debugging
4367 @cindex debugging COFF symbols
4368 Begin defining debugging information for a symbol @var{name}; the
4369 definition extends until the @code{.endef} directive is encountered.
4370 @ifset BOUT
4371
4372 This directive is only observed when @command{@value{AS}} is configured for COFF
4373 format output; when producing @code{b.out}, @samp{.def} is recognized,
4374 but ignored.
4375 @end ifset
4376 @end ifset
4377
4378 @ifset aout-bout
4379 @node Desc
4380 @section @code{.desc @var{symbol}, @var{abs-expression}}
4381
4382 @cindex @code{desc} directive
4383 @cindex COFF symbol descriptor
4384 @cindex symbol descriptor, COFF
4385 This directive sets the descriptor of the symbol (@pxref{Symbol Attributes})
4386 to the low 16 bits of an absolute expression.
4387
4388 @ifset COFF
4389 The @samp{.desc} directive is not available when @command{@value{AS}} is
4390 configured for COFF output; it is only for @code{a.out} or @code{b.out}
4391 object format.  For the sake of compatibility, @command{@value{AS}} accepts
4392 it, but produces no output, when configured for COFF.
4393 @end ifset
4394 @end ifset
4395
4396 @ifset COFF
4397 @node Dim
4398 @section @code{.dim}
4399
4400 @cindex @code{dim} directive
4401 @cindex COFF auxiliary symbol information
4402 @cindex auxiliary symbol information, COFF
4403 This directive is generated by compilers to include auxiliary debugging
4404 information in the symbol table.  It is only permitted inside
4405 @code{.def}/@code{.endef} pairs.
4406 @ifset BOUT
4407
4408 @samp{.dim} is only meaningful when generating COFF format output; when
4409 @command{@value{AS}} is generating @code{b.out}, it accepts this directive but
4410 ignores it.
4411 @end ifset
4412 @end ifset
4413
4414 @node Double
4415 @section @code{.double @var{flonums}}
4416
4417 @cindex @code{double} directive
4418 @cindex floating point numbers (double)
4419 @code{.double} expects zero or more flonums, separated by commas.  It