gas/
[binutils.git] / gas / doc / as.texinfo
blob21af111054659469ead2d24bb53f89b11da4c539
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
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
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
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
96 @finalout
97 @syncodeindex ky cp
99 @copying
100 This file documents the GNU Assembler "@value{AS}".
102 @c man begin COPYRIGHT
103 Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002,
104 2006, 2007 Free Software Foundation, Inc.
106 Permission is granted to copy, distribute and/or modify this document
107 under the terms of the GNU Free Documentation License, Version 1.1
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''.
113 @c man end
114 @end copying
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
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
152 @vskip 0pt plus 1filll
153 Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002,
154 2006, 2007 Free Software Foundation, Inc.
156       Permission is granted to copy, distribute and/or modify this document
157       under the terms of the GNU Free Documentation License, Version 1.1
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''.
163 @end titlepage
164 @contents
166 @ifnottex
167 @node Top
168 @top Using @value{AS}
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
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''.
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
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
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}.
219 @c man title AS the portable GNU assembler.
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
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{cdhlns}][=@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{}]
244 @c Target dependent options are listed below.  Keep the list sorted.
245 @c Add an empty line for separation. 
246 @ifset ALPHA
248 @emph{Target Alpha options:}
249    [@b{-m@var{cpu}}]
250    [@b{-mdebug} | @b{-no-mdebug}]
251    [@b{-relax}] [@b{-g}] [@b{-G@var{size}}]
252    [@b{-F}] [@b{-32addr}]
253 @end ifset
254 @ifset ARC
256 @emph{Target ARC options:}
257    [@b{-marc[5|6|7|8]}]
258    [@b{-EB}|@b{-EL}]
259 @end ifset
260 @ifset ARM
262 @emph{Target ARM options:}
263 @c Don't document the deprecated options
264    [@b{-mcpu}=@var{processor}[+@var{extension}@dots{}]]
265    [@b{-march}=@var{architecture}[+@var{extension}@dots{}]]
266    [@b{-mfpu}=@var{floating-point-format}]
267    [@b{-mfloat-abi}=@var{abi}]
268    [@b{-meabi}=@var{ver}]
269    [@b{-mthumb}]
270    [@b{-EB}|@b{-EL}]
271    [@b{-mapcs-32}|@b{-mapcs-26}|@b{-mapcs-float}|
272     @b{-mapcs-reentrant}]
273    [@b{-mthumb-interwork}] [@b{-k}]
274 @end ifset
275 @ifset CRIS
277 @emph{Target CRIS options:}
278    [@b{--underscore} | @b{--no-underscore}]
279    [@b{--pic}] [@b{-N}]
280    [@b{--emulation=criself} | @b{--emulation=crisaout}]
281    [@b{--march=v0_v10} | @b{--march=v10} | @b{--march=v32} | @b{--march=common_v10_v32}]
282 @c Deprecated -- deliberately not documented.
283 @c [@b{-h}] [@b{-H}]
284 @end ifset
285 @ifset D10V
287 @emph{Target D10V options:}
288    [@b{-O}]
289 @end ifset
290 @ifset D30V
292 @emph{Target D30V options:}
293    [@b{-O}|@b{-n}|@b{-N}]
294 @end ifset
295 @ifset H8
296 @c Renesas family chips have no machine-dependent assembler options
297 @end ifset
298 @ifset HPPA
299 @c HPPA has no machine-dependent assembler options (yet).
300 @end ifset
301 @ifset I80386
303 @emph{Target i386 options:}
304    [@b{--32}|@b{--64}] [@b{-n}]
305    [@b{-march}=@var{CPU}] [@b{-mtune}=@var{CPU}] 
306 @end ifset
307 @ifset I960
309 @emph{Target i960 options:}
310 @c see md_parse_option in tc-i960.c
311    [@b{-ACA}|@b{-ACA_A}|@b{-ACB}|@b{-ACC}|@b{-AKA}|@b{-AKB}|
312     @b{-AKC}|@b{-AMC}]
313    [@b{-b}] [@b{-no-relax}]
314 @end ifset
315 @ifset IA64
317 @emph{Target IA-64 options:}
318    [@b{-mconstant-gp}|@b{-mauto-pic}]
319    [@b{-milp32}|@b{-milp64}|@b{-mlp64}|@b{-mp64}]
320    [@b{-mle}|@b{mbe}]
321    [@b{-mtune=itanium1}|@b{-mtune=itanium2}]
322    [@b{-munwind-check=warning}|@b{-munwind-check=error}]
323    [@b{-mhint.b=ok}|@b{-mhint.b=warning}|@b{-mhint.b=error}]
324    [@b{-x}|@b{-xexplicit}] [@b{-xauto}] [@b{-xdebug}]
325 @end ifset
326 @ifset IP2K
328 @emph{Target IP2K options:}
329    [@b{-mip2022}|@b{-mip2022ext}]
330 @end ifset
331 @ifset M32C
333 @emph{Target M32C options:}
334    [@b{-m32c}|@b{-m16c}]
335 @end ifset
336 @ifset M32R
338 @emph{Target M32R options:}
339    [@b{--m32rx}|@b{--[no-]warn-explicit-parallel-conflicts}|
340    @b{--W[n]p}]
341 @end ifset
342 @ifset M680X0
344 @emph{Target M680X0 options:}
345    [@b{-l}] [@b{-m68000}|@b{-m68010}|@b{-m68020}|@dots{}]
346 @end ifset
347 @ifset M68HC11
349 @emph{Target M68HC11 options:}
350    [@b{-m68hc11}|@b{-m68hc12}|@b{-m68hcs12}]
351    [@b{-mshort}|@b{-mlong}]
352    [@b{-mshort-double}|@b{-mlong-double}]
353    [@b{--force-long-branches}] [@b{--short-branches}]
354    [@b{--strict-direct-mode}] [@b{--print-insn-syntax}]
355    [@b{--print-opcodes}] [@b{--generate-example}]
356 @end ifset
357 @ifset MCORE
359 @emph{Target MCORE options:}
360    [@b{-jsri2bsr}] [@b{-sifilter}] [@b{-relax}]
361    [@b{-mcpu=[210|340]}]
362 @end ifset
363 @ifset MIPS
365 @emph{Target MIPS options:}
366    [@b{-nocpp}] [@b{-EL}] [@b{-EB}] [@b{-O}[@var{optimization level}]]
367    [@b{-g}[@var{debug level}]] [@b{-G} @var{num}] [@b{-KPIC}] [@b{-call_shared}]
368    [@b{-non_shared}] [@b{-xgot} [@b{-mvxworks-pic}]
369    [@b{-mabi}=@var{ABI}] [@b{-32}] [@b{-n32}] [@b{-64}] [@b{-mfp32}] [@b{-mgp32}]
370    [@b{-march}=@var{CPU}] [@b{-mtune}=@var{CPU}] [@b{-mips1}] [@b{-mips2}]
371    [@b{-mips3}] [@b{-mips4}] [@b{-mips5}] [@b{-mips32}] [@b{-mips32r2}]
372    [@b{-mips64}] [@b{-mips64r2}]
373    [@b{-construct-floats}] [@b{-no-construct-floats}]
374    [@b{-trap}] [@b{-no-break}] [@b{-break}] [@b{-no-trap}]
375    [@b{-mfix7000}] [@b{-mno-fix7000}]
376    [@b{-mips16}] [@b{-no-mips16}]
377    [@b{-msmartmips}] [@b{-mno-smartmips}]
378    [@b{-mips3d}] [@b{-no-mips3d}]
379    [@b{-mdmx}] [@b{-no-mdmx}]
380    [@b{-mdsp}] [@b{-mno-dsp}]
381    [@b{-mdspr2}] [@b{-mno-dspr2}]
382    [@b{-mmt}] [@b{-mno-mt}]
383    [@b{-mdebug}] [@b{-no-mdebug}]
384    [@b{-mpdr}] [@b{-mno-pdr}]
385 @end ifset
386 @ifset MMIX
388 @emph{Target MMIX options:}
389    [@b{--fixed-special-register-names}] [@b{--globalize-symbols}]
390    [@b{--gnu-syntax}] [@b{--relax}] [@b{--no-predefined-symbols}]
391    [@b{--no-expand}] [@b{--no-merge-gregs}] [@b{-x}]
392    [@b{--linker-allocated-gregs}]
393 @end ifset
394 @ifset PDP11
396 @emph{Target PDP11 options:}
397    [@b{-mpic}|@b{-mno-pic}] [@b{-mall}] [@b{-mno-extensions}]
398    [@b{-m}@var{extension}|@b{-mno-}@var{extension}]
399    [@b{-m}@var{cpu}] [@b{-m}@var{machine}]  
400 @end ifset
401 @ifset PJ
403 @emph{Target picoJava options:}
404    [@b{-mb}|@b{-me}]
405 @end ifset
406 @ifset PPC
408 @emph{Target PowerPC options:}
409    [@b{-mpwrx}|@b{-mpwr2}|@b{-mpwr}|@b{-m601}|@b{-mppc}|@b{-mppc32}|@b{-m603}|@b{-m604}|
410     @b{-m403}|@b{-m405}|@b{-mppc64}|@b{-m620}|@b{-mppc64bridge}|@b{-mbooke}|
411     @b{-mbooke32}|@b{-mbooke64}]
412    [@b{-mcom}|@b{-many}|@b{-maltivec}] [@b{-memb}]
413    [@b{-mregnames}|@b{-mno-regnames}]
414    [@b{-mrelocatable}|@b{-mrelocatable-lib}]
415    [@b{-mlittle}|@b{-mlittle-endian}|@b{-mbig}|@b{-mbig-endian}]
416    [@b{-msolaris}|@b{-mno-solaris}]
417 @end ifset
418 @ifset SPARC
420 @emph{Target SPARC options:}
421 @c The order here is important.  See c-sparc.texi.
422    [@b{-Av6}|@b{-Av7}|@b{-Av8}|@b{-Asparclet}|@b{-Asparclite}
423     @b{-Av8plus}|@b{-Av8plusa}|@b{-Av9}|@b{-Av9a}]
424    [@b{-xarch=v8plus}|@b{-xarch=v8plusa}] [@b{-bump}]
425    [@b{-32}|@b{-64}]
426 @end ifset
427 @ifset TIC54X
429 @emph{Target TIC54X options:}
430  [@b{-mcpu=54[123589]}|@b{-mcpu=54[56]lp}] [@b{-mfar-mode}|@b{-mf}] 
431  [@b{-merrors-to-file} @var{<filename>}|@b{-me} @var{<filename>}]
432 @end ifset
434 @ifset Z80
436 @emph{Target Z80 options:}
437   [@b{-z80}] [@b{-r800}]
438   [@b{ -ignore-undocumented-instructions}] [@b{-Wnud}]
439   [@b{ -ignore-unportable-instructions}] [@b{-Wnup}]
440   [@b{ -warn-undocumented-instructions}] [@b{-Wud}]
441   [@b{ -warn-unportable-instructions}] [@b{-Wup}]
442   [@b{ -forbid-undocumented-instructions}] [@b{-Fud}]
443   [@b{ -forbid-unportable-instructions}] [@b{-Fup}]
444 @end ifset
446 @ifset Z8000
447 @c Z8000 has no machine-dependent assembler options
448 @end ifset
449 @ifset XTENSA
451 @emph{Target Xtensa options:}
452  [@b{--[no-]text-section-literals}] [@b{--[no-]absolute-literals}]
453  [@b{--[no-]target-align}] [@b{--[no-]longcalls}]
454  [@b{--[no-]transform}]
455  [@b{--rename-section} @var{oldname}=@var{newname}]
456 @end ifset
457 @c man end
458 @end smallexample
460 @c man begin OPTIONS
462 @table @gcctabopt
463 @include at-file.texi
465 @item -a[cdhlmns]
466 Turn on listings, in any of a variety of ways:
468 @table @gcctabopt
469 @item -ac
470 omit false conditionals
472 @item -ad
473 omit debugging directives
475 @item -ah
476 include high-level source
478 @item -al
479 include assembly
481 @item -am
482 include macro expansions
484 @item -an
485 omit forms processing
487 @item -as
488 include symbols
490 @item =file
491 set the name of the listing file
492 @end table
494 You may combine these options; for example, use @samp{-aln} for assembly
495 listing without forms processing.  The @samp{=file} option, if used, must be
496 the last one.  By itself, @samp{-a} defaults to @samp{-ahls}.
498 @item --alternate
499 Begin in alternate macro mode.
500 @ifclear man
501 @xref{Altmacro,,@code{.altmacro}}.
502 @end ifclear
504 @item -D
505 Ignored.  This option is accepted for script compatibility with calls to
506 other assemblers.
508 @item --debug-prefix-map @var{old}=@var{new}
509 When assembling files in directory @file{@var{old}}, record debugging
510 information describing them as in @file{@var{new}} instead.
512 @item --defsym @var{sym}=@var{value}
513 Define the symbol @var{sym} to be @var{value} before assembling the input file.
514 @var{value} must be an integer constant.  As in C, a leading @samp{0x}
515 indicates a hexadecimal value, and a leading @samp{0} indicates an octal
516 value.  The value of the symbol can be overridden inside a source file via the
517 use of a @code{.set} pseudo-op.
519 @item -f
520 ``fast''---skip whitespace and comment preprocessing (assume source is
521 compiler output).
523 @item -g
524 @itemx --gen-debug
525 Generate debugging information for each assembler source line using whichever
526 debug format is preferred by the target.  This currently means either STABS,
527 ECOFF or DWARF2.
529 @item --gstabs
530 Generate stabs debugging information for each assembler line.  This
531 may help debugging assembler code, if the debugger can handle it.
533 @item --gstabs+
534 Generate stabs debugging information for each assembler line, with GNU
535 extensions that probably only gdb can handle, and that could make other
536 debuggers crash or refuse to read your program.  This
537 may help debugging assembler code.  Currently the only GNU extension is
538 the location of the current working directory at assembling time.
540 @item --gdwarf-2
541 Generate DWARF2 debugging information for each assembler line.  This
542 may help debugging assembler code, if the debugger can handle it.  Note---this
543 option is only supported by some targets, not all of them.
545 @item --help
546 Print a summary of the command line options and exit.
548 @item --target-help
549 Print a summary of all target specific options and exit.
551 @item -I @var{dir}
552 Add directory @var{dir} to the search list for @code{.include} directives.
554 @item -J
555 Don't warn about signed overflow.
557 @item -K
558 @ifclear DIFF-TBL-KLUGE
559 This option is accepted but has no effect on the @value{TARGET} family.
560 @end ifclear
561 @ifset DIFF-TBL-KLUGE
562 Issue warnings when difference tables altered for long displacements.
563 @end ifset
565 @item -L
566 @itemx --keep-locals
567 Keep (in the symbol table) local symbols.  These symbols start with
568 system-specific local label prefixes, typically @samp{.L} for ELF systems
569 or @samp{L} for traditional a.out systems.
570 @ifclear man
571 @xref{Symbol Names}.
572 @end ifclear
574 @item --listing-lhs-width=@var{number}
575 Set the maximum width, in words, of the output data column for an assembler
576 listing to @var{number}.
578 @item --listing-lhs-width2=@var{number}
579 Set the maximum width, in words, of the output data column for continuation
580 lines in an assembler listing to @var{number}.
582 @item --listing-rhs-width=@var{number}
583 Set the maximum width of an input source line, as displayed in a listing, to
584 @var{number} bytes.
586 @item --listing-cont-lines=@var{number}
587 Set the maximum number of lines printed in a listing for a single line of input
588 to @var{number} + 1.
590 @item -o @var{objfile}
591 Name the object-file output from @command{@value{AS}} @var{objfile}.
593 @item -R
594 Fold the data section into the text section.
596 @kindex --hash-size=@var{number}
597 Set the default size of GAS's hash tables to a prime number close to
598 @var{number}.  Increasing this value can reduce the length of time it takes the
599 assembler to perform its tasks, at the expense of increasing the assembler's
600 memory requirements.  Similarly reducing this value can reduce the memory
601 requirements at the expense of speed.
603 @item --reduce-memory-overheads
604 This option reduces GAS's memory requirements, at the expense of making the
605 assembly processes slower.  Currently this switch is a synonym for
606 @samp{--hash-size=4051}, but in the future it may have other effects as well.
608 @item --statistics
609 Print the maximum space (in bytes) and total time (in seconds) used by
610 assembly.
612 @item --strip-local-absolute
613 Remove local absolute symbols from the outgoing symbol table.
615 @item -v
616 @itemx -version
617 Print the @command{as} version.
619 @item --version
620 Print the @command{as} version and exit.
622 @item -W
623 @itemx --no-warn
624 Suppress warning messages.
626 @item --fatal-warnings
627 Treat warnings as errors.
629 @item --warn
630 Don't suppress warning messages or treat them as errors.
632 @item -w
633 Ignored.
635 @item -x
636 Ignored.
638 @item -Z
639 Generate an object file even after errors.
641 @item -- | @var{files} @dots{}
642 Standard input, or source files to assemble.
644 @end table
646 @ifset ARC
647 The following options are available when @value{AS} is configured for
648 an ARC processor.
650 @table @gcctabopt
651 @item -marc[5|6|7|8]
652 This option selects the core processor variant.
653 @item -EB | -EL
654 Select either big-endian (-EB) or little-endian (-EL) output.
655 @end table
656 @end ifset
658 @ifset ARM
659 The following options are available when @value{AS} is configured for the ARM
660 processor family.
662 @table @gcctabopt
663 @item -mcpu=@var{processor}[+@var{extension}@dots{}]
664 Specify which ARM processor variant is the target.
665 @item -march=@var{architecture}[+@var{extension}@dots{}]
666 Specify which ARM architecture variant is used by the target.
667 @item -mfpu=@var{floating-point-format}
668 Select which Floating Point architecture is the target.
669 @item -mfloat-abi=@var{abi}
670 Select which floating point ABI is in use.
671 @item -mthumb
672 Enable Thumb only instruction decoding.
673 @item -mapcs-32 | -mapcs-26 | -mapcs-float | -mapcs-reentrant
674 Select which procedure calling convention is in use.
675 @item -EB | -EL
676 Select either big-endian (-EB) or little-endian (-EL) output.
677 @item -mthumb-interwork
678 Specify that the code has been generated with interworking between Thumb and
679 ARM code in mind.
680 @item -k
681 Specify that PIC code has been generated.
682 @end table
683 @end ifset
685 @ifset CRIS
686 See the info pages for documentation of the CRIS-specific options.
687 @end ifset
689 @ifset D10V
690 The following options are available when @value{AS} is configured for
691 a D10V processor.
692 @table @gcctabopt
693 @cindex D10V optimization
694 @cindex optimization, D10V
695 @item -O
696 Optimize output by parallelizing instructions.
697 @end table
698 @end ifset
700 @ifset D30V
701 The following options are available when @value{AS} is configured for a D30V
702 processor.
703 @table @gcctabopt
704 @cindex D30V optimization
705 @cindex optimization, D30V
706 @item -O
707 Optimize output by parallelizing instructions.
709 @cindex D30V nops
710 @item -n
711 Warn when nops are generated.
713 @cindex D30V nops after 32-bit multiply
714 @item -N
715 Warn when a nop after a 32-bit multiply instruction is generated.
716 @end table
717 @end ifset
719 @ifset I960
720 The following options are available when @value{AS} is configured for the
721 Intel 80960 processor.
723 @table @gcctabopt
724 @item -ACA | -ACA_A | -ACB | -ACC | -AKA | -AKB | -AKC | -AMC
725 Specify which variant of the 960 architecture is the target.
727 @item -b
728 Add code to collect statistics about branches taken.
730 @item -no-relax
731 Do not alter compare-and-branch instructions for long displacements;
732 error if necessary.
734 @end table
735 @end ifset
737 @ifset IP2K
738 The following options are available when @value{AS} is configured for the
739 Ubicom IP2K series.
741 @table @gcctabopt
743 @item -mip2022ext
744 Specifies that the extended IP2022 instructions are allowed.
746 @item -mip2022
747 Restores the default behaviour, which restricts the permitted instructions to
748 just the basic IP2022 ones.
750 @end table
751 @end ifset
753 @ifset M32C
754 The following options are available when @value{AS} is configured for the
755 Renesas M32C and M16C processors.
757 @table @gcctabopt
759 @item -m32c
760 Assemble M32C instructions.
762 @item -m16c
763 Assemble M16C instructions (the default).
765 @end table
766 @end ifset
768 @ifset M32R
769 The following options are available when @value{AS} is configured for the
770 Renesas M32R (formerly Mitsubishi M32R) series.
772 @table @gcctabopt
774 @item --m32rx
775 Specify which processor in the M32R family is the target.  The default
776 is normally the M32R, but this option changes it to the M32RX.
778 @item --warn-explicit-parallel-conflicts or --Wp
779 Produce warning messages when questionable parallel constructs are
780 encountered. 
782 @item --no-warn-explicit-parallel-conflicts or --Wnp
783 Do not produce warning messages when questionable parallel constructs are 
784 encountered. 
786 @end table
787 @end ifset
789 @ifset M680X0
790 The following options are available when @value{AS} is configured for the
791 Motorola 68000 series.
793 @table @gcctabopt
795 @item -l
796 Shorten references to undefined symbols, to one word instead of two.
798 @item -m68000 | -m68008 | -m68010 | -m68020 | -m68030
799 @itemx | -m68040 | -m68060 | -m68302 | -m68331 | -m68332
800 @itemx | -m68333 | -m68340 | -mcpu32 | -m5200
801 Specify what processor in the 68000 family is the target.  The default
802 is normally the 68020, but this can be changed at configuration time.
804 @item -m68881 | -m68882 | -mno-68881 | -mno-68882
805 The target machine does (or does not) have a floating-point coprocessor.
806 The default is to assume a coprocessor for 68020, 68030, and cpu32.  Although
807 the basic 68000 is not compatible with the 68881, a combination of the
808 two can be specified, since it's possible to do emulation of the
809 coprocessor instructions with the main processor.
811 @item -m68851 | -mno-68851
812 The target machine does (or does not) have a memory-management
813 unit coprocessor.  The default is to assume an MMU for 68020 and up.
815 @end table
816 @end ifset
818 @ifset PDP11
820 For details about the PDP-11 machine dependent features options,
821 see @ref{PDP-11-Options}.
823 @table @gcctabopt
824 @item -mpic | -mno-pic
825 Generate position-independent (or position-dependent) code.  The
826 default is @option{-mpic}.
828 @item -mall
829 @itemx -mall-extensions
830 Enable all instruction set extensions.  This is the default.
832 @item -mno-extensions
833 Disable all instruction set extensions.
835 @item -m@var{extension} | -mno-@var{extension}
836 Enable (or disable) a particular instruction set extension.
838 @item -m@var{cpu}
839 Enable the instruction set extensions supported by a particular CPU, and
840 disable all other extensions.
842 @item -m@var{machine}
843 Enable the instruction set extensions supported by a particular machine
844 model, and disable all other extensions.
845 @end table
847 @end ifset
849 @ifset PJ
850 The following options are available when @value{AS} is configured for
851 a picoJava processor.
853 @table @gcctabopt
855 @cindex PJ endianness
856 @cindex endianness, PJ
857 @cindex big endian output, PJ
858 @item -mb
859 Generate ``big endian'' format output.
861 @cindex little endian output, PJ
862 @item -ml
863 Generate ``little endian'' format output.
865 @end table
866 @end ifset
868 @ifset M68HC11
869 The following options are available when @value{AS} is configured for the
870 Motorola 68HC11 or 68HC12 series.
872 @table @gcctabopt
874 @item -m68hc11 | -m68hc12 | -m68hcs12
875 Specify what processor is the target.  The default is
876 defined by the configuration option when building the assembler.
878 @item -mshort
879 Specify to use the 16-bit integer ABI.
881 @item -mlong
882 Specify to use the 32-bit integer ABI.  
884 @item -mshort-double
885 Specify to use the 32-bit double ABI.  
887 @item -mlong-double
888 Specify to use the 64-bit double ABI.  
890 @item --force-long-branches
891 Relative branches are turned into absolute ones. This concerns
892 conditional branches, unconditional branches and branches to a
893 sub routine.
895 @item -S | --short-branches
896 Do not turn relative branches into absolute ones
897 when the offset is out of range.
899 @item --strict-direct-mode
900 Do not turn the direct addressing mode into extended addressing mode
901 when the instruction does not support direct addressing mode.
903 @item --print-insn-syntax
904 Print the syntax of instruction in case of error.
906 @item --print-opcodes
907 print the list of instructions with syntax and then exit.
909 @item --generate-example
910 print an example of instruction for each possible instruction and then exit.
911 This option is only useful for testing @command{@value{AS}}.
913 @end table
914 @end ifset
916 @ifset SPARC
917 The following options are available when @command{@value{AS}} is configured
918 for the SPARC architecture:
920 @table @gcctabopt
921 @item -Av6 | -Av7 | -Av8 | -Asparclet | -Asparclite
922 @itemx -Av8plus | -Av8plusa | -Av9 | -Av9a
923 Explicitly select a variant of the SPARC architecture.
925 @samp{-Av8plus} and @samp{-Av8plusa} select a 32 bit environment.
926 @samp{-Av9} and @samp{-Av9a} select a 64 bit environment.
928 @samp{-Av8plusa} and @samp{-Av9a} enable the SPARC V9 instruction set with
929 UltraSPARC extensions.
931 @item -xarch=v8plus | -xarch=v8plusa
932 For compatibility with the Solaris v9 assembler.  These options are
933 equivalent to -Av8plus and -Av8plusa, respectively.
935 @item -bump
936 Warn when the assembler switches to another architecture.
937 @end table
938 @end ifset
940 @ifset TIC54X
941 The following options are available when @value{AS} is configured for the 'c54x
942 architecture. 
944 @table @gcctabopt
945 @item -mfar-mode
946 Enable extended addressing mode.  All addresses and relocations will assume
947 extended addressing (usually 23 bits).
948 @item -mcpu=@var{CPU_VERSION}
949 Sets the CPU version being compiled for.
950 @item -merrors-to-file @var{FILENAME}
951 Redirect error output to a file, for broken systems which don't support such
952 behaviour in the shell.
953 @end table
954 @end ifset
956 @ifset MIPS
957 The following options are available when @value{AS} is configured for
958 a @sc{mips} processor.
960 @table @gcctabopt
961 @item -G @var{num}
962 This option sets the largest size of an object that can be referenced
963 implicitly with the @code{gp} register.  It is only accepted for targets that
964 use ECOFF format, such as a DECstation running Ultrix.  The default value is 8.
966 @cindex MIPS endianness
967 @cindex endianness, MIPS
968 @cindex big endian output, MIPS
969 @item -EB
970 Generate ``big endian'' format output.
972 @cindex little endian output, MIPS
973 @item -EL
974 Generate ``little endian'' format output.
976 @cindex MIPS ISA
977 @item -mips1
978 @itemx -mips2
979 @itemx -mips3
980 @itemx -mips4
981 @itemx -mips5
982 @itemx -mips32
983 @itemx -mips32r2
984 @itemx -mips64
985 @itemx -mips64r2
986 Generate code for a particular @sc{mips} Instruction Set Architecture level.
987 @samp{-mips1} is an alias for @samp{-march=r3000}, @samp{-mips2} is an
988 alias for @samp{-march=r6000}, @samp{-mips3} is an alias for
989 @samp{-march=r4000} and @samp{-mips4} is an alias for @samp{-march=r8000}.
990 @samp{-mips5}, @samp{-mips32}, @samp{-mips32r2}, @samp{-mips64}, and
991 @samp{-mips64r2}
992 correspond to generic
993 @samp{MIPS V}, @samp{MIPS32}, @samp{MIPS32 Release 2}, @samp{MIPS64},
994 and @samp{MIPS64 Release 2}
995 ISA processors, respectively.
997 @item -march=@var{CPU}
998 Generate code for a particular @sc{mips} cpu.
1000 @item -mtune=@var{cpu}
1001 Schedule and tune for a particular @sc{mips} cpu.
1003 @item -mfix7000
1004 @itemx -mno-fix7000
1005 Cause nops to be inserted if the read of the destination register
1006 of an mfhi or mflo instruction occurs in the following two instructions.
1008 @item -mdebug
1009 @itemx -no-mdebug
1010 Cause stabs-style debugging output to go into an ECOFF-style .mdebug
1011 section instead of the standard ELF .stabs sections.
1013 @item -mpdr
1014 @itemx -mno-pdr
1015 Control generation of @code{.pdr} sections.
1017 @item -mgp32
1018 @itemx -mfp32
1019 The register sizes are normally inferred from the ISA and ABI, but these
1020 flags force a certain group of registers to be treated as 32 bits wide at
1021 all times.  @samp{-mgp32} controls the size of general-purpose registers
1022 and @samp{-mfp32} controls the size of floating-point registers.
1024 @item -mips16
1025 @itemx -no-mips16
1026 Generate code for the MIPS 16 processor.  This is equivalent to putting
1027 @code{.set mips16} at the start of the assembly file.  @samp{-no-mips16}
1028 turns off this option.
1030 @item -msmartmips
1031 @itemx -mno-smartmips
1032 Enables the SmartMIPS extension to the MIPS32 instruction set. This is
1033 equivalent to putting @code{.set smartmips} at the start of the assembly file.
1034 @samp{-mno-smartmips} turns off this option.
1036 @item -mips3d
1037 @itemx -no-mips3d
1038 Generate code for the MIPS-3D Application Specific Extension.
1039 This tells the assembler to accept MIPS-3D instructions.
1040 @samp{-no-mips3d} turns off this option.
1042 @item -mdmx
1043 @itemx -no-mdmx
1044 Generate code for the MDMX Application Specific Extension.
1045 This tells the assembler to accept MDMX instructions.
1046 @samp{-no-mdmx} turns off this option.
1048 @item -mdsp
1049 @itemx -mno-dsp
1050 Generate code for the DSP Release 1 Application Specific Extension.
1051 This tells the assembler to accept DSP Release 1 instructions.
1052 @samp{-mno-dsp} turns off this option.
1054 @item -mdspr2
1055 @itemx -mno-dspr2
1056 Generate code for the DSP Release 2 Application Specific Extension.
1057 This option implies -mdsp.
1058 This tells the assembler to accept DSP Release 2 instructions.
1059 @samp{-mno-dspr2} turns off this option.
1061 @item -mmt
1062 @itemx -mno-mt
1063 Generate code for the MT Application Specific Extension.
1064 This tells the assembler to accept MT instructions.
1065 @samp{-mno-mt} turns off this option.
1067 @item --construct-floats
1068 @itemx --no-construct-floats
1069 The @samp{--no-construct-floats} option disables the construction of
1070 double width floating point constants by loading the two halves of the
1071 value into the two single width floating point registers that make up
1072 the double width register.  By default @samp{--construct-floats} is
1073 selected, allowing construction of these floating point constants.
1075 @cindex emulation
1076 @item --emulation=@var{name}
1077 This option causes @command{@value{AS}} to emulate @command{@value{AS}} configured
1078 for some other target, in all respects, including output format (choosing
1079 between ELF and ECOFF only), handling of pseudo-opcodes which may generate
1080 debugging information or store symbol table information, and default
1081 endianness.  The available configuration names are: @samp{mipsecoff},
1082 @samp{mipself}, @samp{mipslecoff}, @samp{mipsbecoff}, @samp{mipslelf},
1083 @samp{mipsbelf}.  The first two do not alter the default endianness from that
1084 of the primary target for which the assembler was configured; the others change
1085 the default to little- or big-endian as indicated by the @samp{b} or @samp{l}
1086 in the name.  Using @samp{-EB} or @samp{-EL} will override the endianness
1087 selection in any case.
1089 This option is currently supported only when the primary target
1090 @command{@value{AS}} is configured for is a @sc{mips} ELF or ECOFF target.
1091 Furthermore, the primary target or others specified with
1092 @samp{--enable-targets=@dots{}} at configuration time must include support for
1093 the other format, if both are to be available.  For example, the Irix 5
1094 configuration includes support for both.
1096 Eventually, this option will support more configurations, with more
1097 fine-grained control over the assembler's behavior, and will be supported for
1098 more processors.
1100 @item -nocpp
1101 @command{@value{AS}} ignores this option.  It is accepted for compatibility with
1102 the native tools.
1104 @item --trap
1105 @itemx --no-trap
1106 @itemx --break
1107 @itemx --no-break
1108 Control how to deal with multiplication overflow and division by zero.
1109 @samp{--trap} or @samp{--no-break} (which are synonyms) take a trap exception
1110 (and only work for Instruction Set Architecture level 2 and higher);
1111 @samp{--break} or @samp{--no-trap} (also synonyms, and the default) take a
1112 break exception.
1114 @item -n
1115 When this option is used, @command{@value{AS}} will issue a warning every
1116 time it generates a nop instruction from a macro.
1117 @end table
1118 @end ifset
1120 @ifset MCORE
1121 The following options are available when @value{AS} is configured for
1122 an MCore processor.
1124 @table @gcctabopt
1125 @item -jsri2bsr
1126 @itemx -nojsri2bsr
1127 Enable or disable the JSRI to BSR transformation.  By default this is enabled.
1128 The command line option @samp{-nojsri2bsr} can be used to disable it.
1130 @item -sifilter
1131 @itemx -nosifilter
1132 Enable or disable the silicon filter behaviour.  By default this is disabled.
1133 The default can be overridden by the @samp{-sifilter} command line option.
1135 @item -relax
1136 Alter jump instructions for long displacements.
1138 @item -mcpu=[210|340]
1139 Select the cpu type on the target hardware.  This controls which instructions
1140 can be assembled.
1142 @item -EB
1143 Assemble for a big endian target.
1145 @item -EL
1146 Assemble for a little endian target.
1148 @end table
1149 @end ifset
1151 @ifset MMIX
1152 See the info pages for documentation of the MMIX-specific options.
1153 @end ifset
1155 @ifset XTENSA
1156 The following options are available when @value{AS} is configured for
1157 an Xtensa processor.
1159 @table @gcctabopt
1160 @item --text-section-literals | --no-text-section-literals
1161 With @option{--text-@-section-@-literals}, literal pools are interspersed
1162 in the text section.  The default is
1163 @option{--no-@-text-@-section-@-literals}, which places literals in a
1164 separate section in the output file.  These options only affect literals
1165 referenced via PC-relative @code{L32R} instructions; literals for
1166 absolute mode @code{L32R} instructions are handled separately.
1168 @item --absolute-literals | --no-absolute-literals
1169 Indicate to the assembler whether @code{L32R} instructions use absolute
1170 or PC-relative addressing.  The default is to assume absolute addressing
1171 if the Xtensa processor includes the absolute @code{L32R} addressing
1172 option.  Otherwise, only the PC-relative @code{L32R} mode can be used.
1174 @item --target-align | --no-target-align
1175 Enable or disable automatic alignment to reduce branch penalties at the
1176 expense of some code density.  The default is @option{--target-@-align}.
1178 @item --longcalls | --no-longcalls
1179 Enable or disable transformation of call instructions to allow calls
1180 across a greater range of addresses.  The default is
1181 @option{--no-@-longcalls}.
1183 @item --transform | --no-transform
1184 Enable or disable all assembler transformations of Xtensa instructions.
1185 The default is @option{--transform};
1186 @option{--no-transform} should be used only in the rare cases when the
1187 instructions must be exactly as specified in the assembly source.
1189 @item --rename-section @var{oldname}=@var{newname}
1190 When generating output sections, rename the @var{oldname} section to
1191 @var{newname}.
1192 @end table
1193 @end ifset
1195 @ifset Z80
1196 The following options are available when @value{AS} is configured for
1197 a Z80 family processor.
1198 @table @gcctabopt
1199 @item -z80
1200 Assemble for Z80 processor.
1201 @item -r800
1202 Assemble for R800 processor.
1203 @item  -ignore-undocumented-instructions 
1204 @itemx -Wnud
1205 Assemble undocumented Z80 instructions that also work on R800 without warning.
1206 @item  -ignore-unportable-instructions 
1207 @itemx -Wnup
1208 Assemble all undocumented Z80 instructions without warning.
1209 @item  -warn-undocumented-instructions 
1210 @itemx -Wud
1211 Issue a warning for undocumented Z80 instructions that also work on R800.
1212 @item  -warn-unportable-instructions 
1213 @itemx -Wup
1214 Issue a warning for undocumented Z80 instructions that do not work on R800.  
1215 @item  -forbid-undocumented-instructions 
1216 @itemx -Fud
1217 Treat all undocumented instructions as errors.
1218 @item  -forbid-unportable-instructions 
1219 @itemx -Fup
1220 Treat undocumented Z80 instructions that do not work on R800 as errors.
1221 @end table
1222 @end ifset
1224 @c man end
1226 @menu
1227 * Manual::                      Structure of this Manual
1228 * GNU Assembler::               The GNU Assembler
1229 * Object Formats::              Object File Formats
1230 * Command Line::                Command Line
1231 * Input Files::                 Input Files
1232 * Object::                      Output (Object) File
1233 * Errors::                      Error and Warning Messages
1234 @end menu
1236 @node Manual
1237 @section Structure of this Manual
1239 @cindex manual, structure and purpose
1240 This manual is intended to describe what you need to know to use
1241 @sc{gnu} @command{@value{AS}}.  We cover the syntax expected in source files, including
1242 notation for symbols, constants, and expressions; the directives that
1243 @command{@value{AS}} understands; and of course how to invoke @command{@value{AS}}.
1245 @ifclear GENERIC
1246 We also cover special features in the @value{TARGET}
1247 configuration of @command{@value{AS}}, including assembler directives.
1248 @end ifclear
1249 @ifset GENERIC
1250 This manual also describes some of the machine-dependent features of
1251 various flavors of the assembler.
1252 @end ifset
1254 @cindex machine instructions (not covered)
1255 On the other hand, this manual is @emph{not} intended as an introduction
1256 to programming in assembly language---let alone programming in general!
1257 In a similar vein, we make no attempt to introduce the machine
1258 architecture; we do @emph{not} describe the instruction set, standard
1259 mnemonics, registers or addressing modes that are standard to a
1260 particular architecture.
1261 @ifset GENERIC
1262 You may want to consult the manufacturer's
1263 machine architecture manual for this information.
1264 @end ifset
1265 @ifclear GENERIC
1266 @ifset H8/300
1267 For information on the H8/300 machine instruction set, see @cite{H8/300
1268 Series Programming Manual}.  For the H8/300H, see @cite{H8/300H Series
1269 Programming Manual} (Renesas).
1270 @end ifset
1271 @ifset SH
1272 For information on the Renesas (formerly Hitachi) / SuperH SH machine instruction set,
1273 see @cite{SH-Microcomputer User's Manual} (Renesas) or
1274 @cite{SH-4 32-bit CPU Core Architecture} (SuperH) and
1275 @cite{SuperH (SH) 64-Bit RISC Series} (SuperH).
1276 @end ifset
1277 @ifset Z8000
1278 For information on the Z8000 machine instruction set, see @cite{Z8000 CPU Technical Manual}
1279 @end ifset
1280 @end ifclear
1282 @c I think this is premature---doc@cygnus.com, 17jan1991
1283 @ignore
1284 Throughout this manual, we assume that you are running @dfn{GNU},
1285 the portable operating system from the @dfn{Free Software
1286 Foundation, Inc.}.  This restricts our attention to certain kinds of
1287 computer (in particular, the kinds of computers that @sc{gnu} can run on);
1288 once this assumption is granted examples and definitions need less
1289 qualification.
1291 @command{@value{AS}} is part of a team of programs that turn a high-level
1292 human-readable series of instructions into a low-level
1293 computer-readable series of instructions.  Different versions of
1294 @command{@value{AS}} are used for different kinds of computer.
1295 @end ignore
1297 @c There used to be a section "Terminology" here, which defined
1298 @c "contents", "byte", "word", and "long".  Defining "word" to any
1299 @c particular size is confusing when the .word directive may generate 16
1300 @c bits on one machine and 32 bits on another; in general, for the user
1301 @c version of this manual, none of these terms seem essential to define.
1302 @c They were used very little even in the former draft of the manual;
1303 @c this draft makes an effort to avoid them (except in names of
1304 @c directives).
1306 @node GNU Assembler
1307 @section The GNU Assembler
1309 @c man begin DESCRIPTION
1311 @sc{gnu} @command{as} is really a family of assemblers.
1312 @ifclear GENERIC
1313 This manual describes @command{@value{AS}}, a member of that family which is
1314 configured for the @value{TARGET} architectures.
1315 @end ifclear
1316 If you use (or have used) the @sc{gnu} assembler on one architecture, you
1317 should find a fairly similar environment when you use it on another
1318 architecture.  Each version has much in common with the others,
1319 including object file formats, most assembler directives (often called
1320 @dfn{pseudo-ops}) and assembler syntax.@refill
1322 @cindex purpose of @sc{gnu} assembler
1323 @command{@value{AS}} is primarily intended to assemble the output of the
1324 @sc{gnu} C compiler @code{@value{GCC}} for use by the linker
1325 @code{@value{LD}}.  Nevertheless, we've tried to make @command{@value{AS}}
1326 assemble correctly everything that other assemblers for the same
1327 machine would assemble.
1328 @ifset VAX
1329 Any exceptions are documented explicitly (@pxref{Machine Dependencies}).
1330 @end ifset
1331 @ifset M680X0
1332 @c This remark should appear in generic version of manual; assumption
1333 @c here is that generic version sets M680x0.
1334 This doesn't mean @command{@value{AS}} always uses the same syntax as another
1335 assembler for the same architecture; for example, we know of several
1336 incompatible versions of 680x0 assembly language syntax.
1337 @end ifset
1339 @c man end
1341 Unlike older assemblers, @command{@value{AS}} is designed to assemble a source
1342 program in one pass of the source file.  This has a subtle impact on the
1343 @kbd{.org} directive (@pxref{Org,,@code{.org}}).
1345 @node Object Formats
1346 @section Object File Formats
1348 @cindex object file format
1349 The @sc{gnu} assembler can be configured to produce several alternative
1350 object file formats.  For the most part, this does not affect how you
1351 write assembly language programs; but directives for debugging symbols
1352 are typically different in different file formats.  @xref{Symbol
1353 Attributes,,Symbol Attributes}.
1354 @ifclear GENERIC
1355 @ifclear MULTI-OBJ
1356 For the @value{TARGET} target, @command{@value{AS}} is configured to produce
1357 @value{OBJ-NAME} format object files.
1358 @end ifclear
1359 @c The following should exhaust all configs that set MULTI-OBJ, ideally
1360 @ifset I960
1361 On the @value{TARGET}, @command{@value{AS}} can be configured to produce either
1362 @code{b.out} or COFF format object files.
1363 @end ifset
1364 @ifset HPPA
1365 On the @value{TARGET}, @command{@value{AS}} can be configured to produce either
1366 SOM or ELF format object files.
1367 @end ifset
1368 @end ifclear
1370 @node Command Line
1371 @section Command Line
1373 @cindex command line conventions
1375 After the program name @command{@value{AS}}, the command line may contain
1376 options and file names.  Options may appear in any order, and may be
1377 before, after, or between file names.  The order of file names is
1378 significant.
1380 @cindex standard input, as input file
1381 @kindex --
1382 @file{--} (two hyphens) by itself names the standard input file
1383 explicitly, as one of the files for @command{@value{AS}} to assemble.
1385 @cindex options, command line
1386 Except for @samp{--} any command line argument that begins with a
1387 hyphen (@samp{-}) is an option.  Each option changes the behavior of
1388 @command{@value{AS}}.  No option changes the way another option works.  An
1389 option is a @samp{-} followed by one or more letters; the case of
1390 the letter is important.   All options are optional.
1392 Some options expect exactly one file name to follow them.  The file
1393 name may either immediately follow the option's letter (compatible
1394 with older assemblers) or it may be the next command argument (@sc{gnu}
1395 standard).  These two command lines are equivalent:
1397 @smallexample
1398 @value{AS} -o my-object-file.o mumble.s
1399 @value{AS} -omy-object-file.o mumble.s
1400 @end smallexample
1402 @node Input Files
1403 @section Input Files
1405 @cindex input
1406 @cindex source program
1407 @cindex files, input
1408 We use the phrase @dfn{source program}, abbreviated @dfn{source}, to
1409 describe the program input to one run of @command{@value{AS}}.  The program may
1410 be in one or more files; how the source is partitioned into files
1411 doesn't change the meaning of the source.
1413 @c I added "con" prefix to "catenation" just to prove I can overcome my
1414 @c APL training...   doc@cygnus.com
1415 The source program is a concatenation of the text in all the files, in the
1416 order specified.
1418 @c man begin DESCRIPTION
1419 Each time you run @command{@value{AS}} it assembles exactly one source
1420 program.  The source program is made up of one or more files.
1421 (The standard input is also a file.)
1423 You give @command{@value{AS}} a command line that has zero or more input file
1424 names.  The input files are read (from left file name to right).  A
1425 command line argument (in any position) that has no special meaning
1426 is taken to be an input file name.
1428 If you give @command{@value{AS}} no file names it attempts to read one input file
1429 from the @command{@value{AS}} standard input, which is normally your terminal.  You
1430 may have to type @key{ctl-D} to tell @command{@value{AS}} there is no more program
1431 to assemble.
1433 Use @samp{--} if you need to explicitly name the standard input file
1434 in your command line.
1436 If the source is empty, @command{@value{AS}} produces a small, empty object
1437 file.
1439 @c man end
1441 @subheading Filenames and Line-numbers
1443 @cindex input file linenumbers
1444 @cindex line numbers, in input files
1445 There are two ways of locating a line in the input file (or files) and
1446 either may be used in reporting error messages.  One way refers to a line
1447 number in a physical file; the other refers to a line number in a
1448 ``logical'' file.  @xref{Errors, ,Error and Warning Messages}.
1450 @dfn{Physical files} are those files named in the command line given
1451 to @command{@value{AS}}.
1453 @dfn{Logical files} are simply names declared explicitly by assembler
1454 directives; they bear no relation to physical files.  Logical file names help
1455 error messages reflect the original source file, when @command{@value{AS}} source
1456 is itself synthesized from other files.  @command{@value{AS}} understands the
1457 @samp{#} directives emitted by the @code{@value{GCC}} preprocessor.  See also
1458 @ref{File,,@code{.file}}.
1460 @node Object
1461 @section Output (Object) File
1463 @cindex object file
1464 @cindex output file
1465 @kindex a.out
1466 @kindex .o
1467 Every time you run @command{@value{AS}} it produces an output file, which is
1468 your assembly language program translated into numbers.  This file
1469 is the object file.  Its default name is
1470 @ifclear BOUT
1471 @code{a.out}.
1472 @end ifclear
1473 @ifset BOUT
1474 @ifset GENERIC
1475 @code{a.out}, or 
1476 @end ifset
1477 @code{b.out} when @command{@value{AS}} is configured for the Intel 80960.
1478 @end ifset
1479 You can give it another name by using the @option{-o} option.  Conventionally,
1480 object file names end with @file{.o}.  The default name is used for historical
1481 reasons: older assemblers were capable of assembling self-contained programs
1482 directly into a runnable program.  (For some formats, this isn't currently
1483 possible, but it can be done for the @code{a.out} format.)
1485 @cindex linker
1486 @kindex ld
1487 The object file is meant for input to the linker @code{@value{LD}}.  It contains
1488 assembled program code, information to help @code{@value{LD}} integrate
1489 the assembled program into a runnable file, and (optionally) symbolic
1490 information for the debugger.
1492 @c link above to some info file(s) like the description of a.out.
1493 @c don't forget to describe @sc{gnu} info as well as Unix lossage.
1495 @node Errors
1496 @section Error and Warning Messages
1498 @c man begin DESCRIPTION
1500 @cindex error messages
1501 @cindex warning messages
1502 @cindex messages from assembler
1503 @command{@value{AS}} may write warnings and error messages to the standard error
1504 file (usually your terminal).  This should not happen when  a compiler
1505 runs @command{@value{AS}} automatically.  Warnings report an assumption made so
1506 that @command{@value{AS}} could keep assembling a flawed program; errors report a
1507 grave problem that stops the assembly.
1509 @c man end
1511 @cindex format of warning messages
1512 Warning messages have the format
1514 @smallexample
1515 file_name:@b{NNN}:Warning Message Text
1516 @end smallexample
1518 @noindent
1519 @cindex line numbers, in warnings/errors
1520 (where @b{NNN} is a line number).  If a logical file name has been given
1521 (@pxref{File,,@code{.file}}) it is used for the filename, otherwise the name of
1522 the current input file is used.  If a logical line number was given
1523 @ifset GENERIC
1524 (@pxref{Line,,@code{.line}})
1525 @end ifset
1526 then it is used to calculate the number printed,
1527 otherwise the actual line in the current source file is printed.  The
1528 message text is intended to be self explanatory (in the grand Unix
1529 tradition).
1531 @cindex format of error messages
1532 Error messages have the format
1533 @smallexample
1534 file_name:@b{NNN}:FATAL:Error Message Text
1535 @end smallexample
1536 The file name and line number are derived as for warning
1537 messages.  The actual message text may be rather less explanatory
1538 because many of them aren't supposed to happen.
1540 @node Invoking
1541 @chapter Command-Line Options
1543 @cindex options, all versions of assembler
1544 This chapter describes command-line options available in @emph{all}
1545 versions of the @sc{gnu} assembler; see @ref{Machine Dependencies},
1546 for options specific
1547 @ifclear GENERIC
1548 to the @value{TARGET} target.
1549 @end ifclear
1550 @ifset GENERIC
1551 to particular machine architectures.
1552 @end ifset
1554 @c man begin DESCRIPTION
1556 If you are invoking @command{@value{AS}} via the @sc{gnu} C compiler,
1557 you can use the @samp{-Wa} option to pass arguments through to the assembler.
1558 The assembler arguments must be separated from each other (and the @samp{-Wa})
1559 by commas.  For example:
1561 @smallexample
1562 gcc -c -g -O -Wa,-alh,-L file.c
1563 @end smallexample
1565 @noindent
1566 This passes two options to the assembler: @samp{-alh} (emit a listing to
1567 standard output with high-level and assembly source) and @samp{-L} (retain
1568 local symbols in the symbol table).
1570 Usually you do not need to use this @samp{-Wa} mechanism, since many compiler
1571 command-line options are automatically passed to the assembler by the compiler.
1572 (You can call the @sc{gnu} compiler driver with the @samp{-v} option to see
1573 precisely what options it passes to each compilation pass, including the
1574 assembler.)
1576 @c man end
1578 @menu
1579 * a::             -a[cdhlns] enable listings
1580 * alternate::     --alternate enable alternate macro syntax
1581 * D::             -D for compatibility
1582 * f::             -f to work faster
1583 * I::             -I for .include search path
1584 @ifclear DIFF-TBL-KLUGE
1585 * K::             -K for compatibility
1586 @end ifclear
1587 @ifset DIFF-TBL-KLUGE
1588 * K::             -K for difference tables
1589 @end ifset
1591 * L::             -L to retain local symbols
1592 * listing::       --listing-XXX to configure listing output
1593 * M::             -M or --mri to assemble in MRI compatibility mode
1594 * MD::            --MD for dependency tracking
1595 * o::             -o to name the object file
1596 * R::             -R to join data and text sections
1597 * statistics::    --statistics to see statistics about assembly
1598 * traditional-format:: --traditional-format for compatible output
1599 * v::             -v to announce version
1600 * W::             -W, --no-warn, --warn, --fatal-warnings to control warnings
1601 * Z::             -Z to make object file even after errors
1602 @end menu
1604 @node a
1605 @section Enable Listings: @option{-a[cdhlns]}
1607 @kindex -a
1608 @kindex -ac
1609 @kindex -ad
1610 @kindex -ah
1611 @kindex -al
1612 @kindex -an
1613 @kindex -as
1614 @cindex listings, enabling
1615 @cindex assembly listings, enabling
1617 These options enable listing output from the assembler.  By itself,
1618 @samp{-a} requests high-level, assembly, and symbols listing.
1619 You can use other letters to select specific options for the list:
1620 @samp{-ah} requests a high-level language listing,
1621 @samp{-al} requests an output-program assembly listing, and
1622 @samp{-as} requests a symbol table listing.
1623 High-level listings require that a compiler debugging option like
1624 @samp{-g} be used, and that assembly listings (@samp{-al}) be requested
1625 also.
1627 Use the @samp{-ac} option to omit false conditionals from a listing.  Any lines
1628 which are not assembled because of a false @code{.if} (or @code{.ifdef}, or any
1629 other conditional), or a true @code{.if} followed by an @code{.else}, will be
1630 omitted from the listing.
1632 Use the @samp{-ad} option to omit debugging directives from the
1633 listing.
1635 Once you have specified one of these options, you can further control
1636 listing output and its appearance using the directives @code{.list},
1637 @code{.nolist}, @code{.psize}, @code{.eject}, @code{.title}, and
1638 @code{.sbttl}.
1639 The @samp{-an} option turns off all forms processing.
1640 If you do not request listing output with one of the @samp{-a} options, the
1641 listing-control directives have no effect.
1643 The letters after @samp{-a} may be combined into one option,
1644 @emph{e.g.}, @samp{-aln}.
1646 Note if the assembler source is coming from the standard input (e.g.,
1647 because it
1648 is being created by @code{@value{GCC}} and the @samp{-pipe} command line switch
1649 is being used) then the listing will not contain any comments or preprocessor
1650 directives.  This is because the listing code buffers input source lines from
1651 stdin only after they have been preprocessed by the assembler.  This reduces
1652 memory usage and makes the code more efficient.
1654 @node alternate
1655 @section @option{--alternate}
1657 @kindex --alternate
1658 Begin in alternate macro mode, see @ref{Altmacro,,@code{.altmacro}}.
1660 @node D
1661 @section @option{-D}
1663 @kindex -D
1664 This option has no effect whatsoever, but it is accepted to make it more
1665 likely that scripts written for other assemblers also work with
1666 @command{@value{AS}}.
1668 @node f
1669 @section Work Faster: @option{-f}
1671 @kindex -f
1672 @cindex trusted compiler
1673 @cindex faster processing (@option{-f})
1674 @samp{-f} should only be used when assembling programs written by a
1675 (trusted) compiler.  @samp{-f} stops the assembler from doing whitespace
1676 and comment preprocessing on
1677 the input file(s) before assembling them.  @xref{Preprocessing,
1678 ,Preprocessing}.
1680 @quotation
1681 @emph{Warning:} if you use @samp{-f} when the files actually need to be
1682 preprocessed (if they contain comments, for example), @command{@value{AS}} does
1683 not work correctly.
1684 @end quotation
1686 @node I
1687 @section @code{.include} Search Path: @option{-I} @var{path}
1689 @kindex -I @var{path}
1690 @cindex paths for @code{.include}
1691 @cindex search path for @code{.include}
1692 @cindex @code{include} directive search path
1693 Use this option to add a @var{path} to the list of directories
1694 @command{@value{AS}} searches for files specified in @code{.include}
1695 directives (@pxref{Include,,@code{.include}}).  You may use @option{-I} as
1696 many times as necessary to include a variety of paths.  The current
1697 working directory is always searched first; after that, @command{@value{AS}}
1698 searches any @samp{-I} directories in the same order as they were
1699 specified (left to right) on the command line.
1701 @node K
1702 @section Difference Tables: @option{-K}
1704 @kindex -K
1705 @ifclear DIFF-TBL-KLUGE
1706 On the @value{TARGET} family, this option is allowed, but has no effect.  It is
1707 permitted for compatibility with the @sc{gnu} assembler on other platforms,
1708 where it can be used to warn when the assembler alters the machine code
1709 generated for @samp{.word} directives in difference tables.  The @value{TARGET}
1710 family does not have the addressing limitations that sometimes lead to this
1711 alteration on other platforms.
1712 @end ifclear
1714 @ifset DIFF-TBL-KLUGE
1715 @cindex difference tables, warning
1716 @cindex warning for altered difference tables
1717 @command{@value{AS}} sometimes alters the code emitted for directives of the
1718 form @samp{.word @var{sym1}-@var{sym2}}.  @xref{Word,,@code{.word}}.
1719 You can use the @samp{-K} option if you want a warning issued when this
1720 is done.
1721 @end ifset
1723 @node L
1724 @section Include Local Symbols: @option{-L}
1726 @kindex -L
1727 @cindex local symbols, retaining in output
1728 Symbols beginning with system-specific local label prefixes, typically
1729 @samp{.L} for ELF systems or @samp{L} for traditional a.out systems, are
1730 called @dfn{local symbols}.  @xref{Symbol Names}.  Normally you do not see
1731 such symbols when debugging, because they are intended for the use of
1732 programs (like compilers) that compose assembler programs, not for your
1733 notice.  Normally both @command{@value{AS}} and @code{@value{LD}} discard
1734 such symbols, so you do not normally debug with them.
1736 This option tells @command{@value{AS}} to retain those local symbols
1737 in the object file.  Usually if you do this you also tell the linker
1738 @code{@value{LD}} to preserve those symbols.
1740 @node listing
1741 @section Configuring listing output: @option{--listing}
1743 The listing feature of the assembler can be enabled via the command line switch
1744 @samp{-a} (@pxref{a}).  This feature combines the input source file(s) with a
1745 hex dump of the corresponding locations in the output object file, and displays
1746 them as a listing file.  The format of this listing can be controlled by
1747 directives inside the assembler source (i.e., @code{.list} (@pxref{List}),
1748 @code{.title} (@pxref{Title}), @code{.sbttl} (@pxref{Sbttl}),
1749 @code{.psize} (@pxref{Psize}), and
1750 @code{.eject} (@pxref{Eject}) and also by the following switches:
1752 @table @gcctabopt
1753 @item --listing-lhs-width=@samp{number}
1754 @kindex --listing-lhs-width
1755 @cindex Width of first line disassembly output
1756 Sets the maximum width, in words, of the first line of the hex byte dump.  This
1757 dump appears on the left hand side of the listing output.
1759 @item --listing-lhs-width2=@samp{number}
1760 @kindex --listing-lhs-width2
1761 @cindex Width of continuation lines of disassembly output
1762 Sets the maximum width, in words, of any further lines of the hex byte dump for
1763 a given input source line.  If this value is not specified, it defaults to being
1764 the same as the value specified for @samp{--listing-lhs-width}.  If neither
1765 switch is used the default is to one.
1767 @item --listing-rhs-width=@samp{number}
1768 @kindex --listing-rhs-width
1769 @cindex Width of source line output
1770 Sets the maximum width, in characters, of the source line that is displayed
1771 alongside the hex dump.  The default value for this parameter is 100.  The
1772 source line is displayed on the right hand side of the listing output.
1774 @item --listing-cont-lines=@samp{number}
1775 @kindex --listing-cont-lines
1776 @cindex Maximum number of continuation lines
1777 Sets the maximum number of continuation lines of hex dump that will be
1778 displayed for a given single line of source input.  The default value is 4.
1779 @end table
1781 @node M
1782 @section Assemble in MRI Compatibility Mode: @option{-M}
1784 @kindex -M
1785 @cindex MRI compatibility mode
1786 The @option{-M} or @option{--mri} option selects MRI compatibility mode.  This
1787 changes the syntax and pseudo-op handling of @command{@value{AS}} to make it
1788 compatible with the @code{ASM68K} or the @code{ASM960} (depending upon the
1789 configured target) assembler from Microtec Research.  The exact nature of the
1790 MRI syntax will not be documented here; see the MRI manuals for more
1791 information.  Note in particular that the handling of macros and macro
1792 arguments is somewhat different.  The purpose of this option is to permit
1793 assembling existing MRI assembler code using @command{@value{AS}}.
1795 The MRI compatibility is not complete.  Certain operations of the MRI assembler
1796 depend upon its object file format, and can not be supported using other object
1797 file formats.  Supporting these would require enhancing each object file format
1798 individually.  These are:
1800 @itemize @bullet
1801 @item global symbols in common section
1803 The m68k MRI assembler supports common sections which are merged by the linker.
1804 Other object file formats do not support this.  @command{@value{AS}} handles
1805 common sections by treating them as a single common symbol.  It permits local
1806 symbols to be defined within a common section, but it can not support global
1807 symbols, since it has no way to describe them.
1809 @item complex relocations
1811 The MRI assemblers support relocations against a negated section address, and
1812 relocations which combine the start addresses of two or more sections.  These
1813 are not support by other object file formats.
1815 @item @code{END} pseudo-op specifying start address
1817 The MRI @code{END} pseudo-op permits the specification of a start address.
1818 This is not supported by other object file formats.  The start address may
1819 instead be specified using the @option{-e} option to the linker, or in a linker
1820 script.
1822 @item @code{IDNT}, @code{.ident} and @code{NAME} pseudo-ops
1824 The MRI @code{IDNT}, @code{.ident} and @code{NAME} pseudo-ops assign a module
1825 name to the output file.  This is not supported by other object file formats.
1827 @item @code{ORG} pseudo-op
1829 The m68k MRI @code{ORG} pseudo-op begins an absolute section at a given
1830 address.  This differs from the usual @command{@value{AS}} @code{.org} pseudo-op,
1831 which changes the location within the current section.  Absolute sections are
1832 not supported by other object file formats.  The address of a section may be
1833 assigned within a linker script.
1834 @end itemize
1836 There are some other features of the MRI assembler which are not supported by
1837 @command{@value{AS}}, typically either because they are difficult or because they
1838 seem of little consequence.  Some of these may be supported in future releases.
1840 @itemize @bullet
1842 @item EBCDIC strings
1844 EBCDIC strings are not supported.
1846 @item packed binary coded decimal
1848 Packed binary coded decimal is not supported.  This means that the @code{DC.P}
1849 and @code{DCB.P} pseudo-ops are not supported.
1851 @item @code{FEQU} pseudo-op
1853 The m68k @code{FEQU} pseudo-op is not supported.
1855 @item @code{NOOBJ} pseudo-op
1857 The m68k @code{NOOBJ} pseudo-op is not supported.
1859 @item @code{OPT} branch control options
1861 The m68k @code{OPT} branch control options---@code{B}, @code{BRS}, @code{BRB},
1862 @code{BRL}, and @code{BRW}---are ignored.  @command{@value{AS}} automatically
1863 relaxes all branches, whether forward or backward, to an appropriate size, so
1864 these options serve no purpose.
1866 @item @code{OPT} list control options
1868 The following m68k @code{OPT} list control options are ignored: @code{C},
1869 @code{CEX}, @code{CL}, @code{CRE}, @code{E}, @code{G}, @code{I}, @code{M},
1870 @code{MEX}, @code{MC}, @code{MD}, @code{X}.
1872 @item other @code{OPT} options
1874 The following m68k @code{OPT} options are ignored: @code{NEST}, @code{O},
1875 @code{OLD}, @code{OP}, @code{P}, @code{PCO}, @code{PCR}, @code{PCS}, @code{R}.
1877 @item @code{OPT} @code{D} option is default
1879 The m68k @code{OPT} @code{D} option is the default, unlike the MRI assembler.
1880 @code{OPT NOD} may be used to turn it off.
1882 @item @code{XREF} pseudo-op.
1884 The m68k @code{XREF} pseudo-op is ignored.
1886 @item @code{.debug} pseudo-op
1888 The i960 @code{.debug} pseudo-op is not supported.
1890 @item @code{.extended} pseudo-op
1892 The i960 @code{.extended} pseudo-op is not supported.
1894 @item @code{.list} pseudo-op.
1896 The various options of the i960 @code{.list} pseudo-op are not supported.
1898 @item @code{.optimize} pseudo-op
1900 The i960 @code{.optimize} pseudo-op is not supported.
1902 @item @code{.output} pseudo-op
1904 The i960 @code{.output} pseudo-op is not supported.
1906 @item @code{.setreal} pseudo-op
1908 The i960 @code{.setreal} pseudo-op is not supported.
1910 @end itemize
1912 @node MD
1913 @section Dependency Tracking: @option{--MD}
1915 @kindex --MD
1916 @cindex dependency tracking
1917 @cindex make rules
1919 @command{@value{AS}} can generate a dependency file for the file it creates.  This
1920 file consists of a single rule suitable for @code{make} describing the
1921 dependencies of the main source file.
1923 The rule is written to the file named in its argument.
1925 This feature is used in the automatic updating of makefiles.
1927 @node o
1928 @section Name the Object File: @option{-o}
1930 @kindex -o
1931 @cindex naming object file
1932 @cindex object file name
1933 There is always one object file output when you run @command{@value{AS}}.  By
1934 default it has the name
1935 @ifset GENERIC
1936 @ifset I960
1937 @file{a.out} (or @file{b.out}, for Intel 960 targets only).
1938 @end ifset
1939 @ifclear I960
1940 @file{a.out}.
1941 @end ifclear
1942 @end ifset
1943 @ifclear GENERIC
1944 @ifset I960
1945 @file{b.out}.
1946 @end ifset
1947 @ifclear I960
1948 @file{a.out}.
1949 @end ifclear
1950 @end ifclear
1951 You use this option (which takes exactly one filename) to give the
1952 object file a different name.
1954 Whatever the object file is called, @command{@value{AS}} overwrites any
1955 existing file of the same name.
1957 @node R
1958 @section Join Data and Text Sections: @option{-R}
1960 @kindex -R
1961 @cindex data and text sections, joining
1962 @cindex text and data sections, joining
1963 @cindex joining text and data sections
1964 @cindex merging text and data sections
1965 @option{-R} tells @command{@value{AS}} to write the object file as if all
1966 data-section data lives in the text section.  This is only done at
1967 the very last moment:  your binary data are the same, but data
1968 section parts are relocated differently.  The data section part of
1969 your object file is zero bytes long because all its bytes are
1970 appended to the text section.  (@xref{Sections,,Sections and Relocation}.)
1972 When you specify @option{-R} it would be possible to generate shorter
1973 address displacements (because we do not have to cross between text and
1974 data section).  We refrain from doing this simply for compatibility with
1975 older versions of @command{@value{AS}}.  In future, @option{-R} may work this way.
1977 @ifset COFF-ELF
1978 When @command{@value{AS}} is configured for COFF or ELF output,
1979 this option is only useful if you use sections named @samp{.text} and
1980 @samp{.data}.
1981 @end ifset
1983 @ifset HPPA
1984 @option{-R} is not supported for any of the HPPA targets.  Using
1985 @option{-R} generates a warning from @command{@value{AS}}.
1986 @end ifset
1988 @node statistics
1989 @section Display Assembly Statistics: @option{--statistics}
1991 @kindex --statistics
1992 @cindex statistics, about assembly
1993 @cindex time, total for assembly
1994 @cindex space used, maximum for assembly
1995 Use @samp{--statistics} to display two statistics about the resources used by
1996 @command{@value{AS}}: the maximum amount of space allocated during the assembly
1997 (in bytes), and the total execution time taken for the assembly (in @sc{cpu}
1998 seconds).
2000 @node traditional-format
2001 @section Compatible Output: @option{--traditional-format}
2003 @kindex --traditional-format
2004 For some targets, the output of @command{@value{AS}} is different in some ways
2005 from the output of some existing assembler.  This switch requests
2006 @command{@value{AS}} to use the traditional format instead.
2008 For example, it disables the exception frame optimizations which
2009 @command{@value{AS}} normally does by default on @code{@value{GCC}} output.
2011 @node v
2012 @section Announce Version: @option{-v}
2014 @kindex -v
2015 @kindex -version
2016 @cindex assembler version
2017 @cindex version of assembler
2018 You can find out what version of as is running by including the
2019 option @samp{-v} (which you can also spell as @samp{-version}) on the
2020 command line.
2022 @node W
2023 @section Control Warnings: @option{-W}, @option{--warn}, @option{--no-warn}, @option{--fatal-warnings}
2025 @command{@value{AS}} should never give a warning or error message when
2026 assembling compiler output.  But programs written by people often
2027 cause @command{@value{AS}} to give a warning that a particular assumption was
2028 made.  All such warnings are directed to the standard error file.
2030 @kindex -W
2031 @kindex --no-warn
2032 @cindex suppressing warnings
2033 @cindex warnings, suppressing
2034 If you use the @option{-W} and @option{--no-warn} options, no warnings are issued.
2035 This only affects the warning messages: it does not change any particular of
2036 how @command{@value{AS}} assembles your file.  Errors, which stop the assembly,
2037 are still reported.
2039 @kindex --fatal-warnings
2040 @cindex errors, caused by warnings
2041 @cindex warnings, causing error
2042 If you use the @option{--fatal-warnings} option, @command{@value{AS}} considers
2043 files that generate warnings to be in error.
2045 @kindex --warn
2046 @cindex warnings, switching on
2047 You can switch these options off again by specifying @option{--warn}, which
2048 causes warnings to be output as usual.
2050 @node Z
2051 @section Generate Object File in Spite of Errors: @option{-Z}
2052 @cindex object file, after errors
2053 @cindex errors, continuing after
2054 After an error message, @command{@value{AS}} normally produces no output.  If for
2055 some reason you are interested in object file output even after
2056 @command{@value{AS}} gives an error message on your program, use the @samp{-Z}
2057 option.  If there are any errors, @command{@value{AS}} continues anyways, and
2058 writes an object file after a final warning message of the form @samp{@var{n}
2059 errors, @var{m} warnings, generating bad object file.}
2061 @node Syntax
2062 @chapter Syntax
2064 @cindex machine-independent syntax
2065 @cindex syntax, machine-independent
2066 This chapter describes the machine-independent syntax allowed in a
2067 source file.  @command{@value{AS}} syntax is similar to what many other
2068 assemblers use; it is inspired by the BSD 4.2
2069 @ifclear VAX
2070 assembler.
2071 @end ifclear
2072 @ifset VAX
2073 assembler, except that @command{@value{AS}} does not assemble Vax bit-fields.
2074 @end ifset
2076 @menu
2077 * Preprocessing::              Preprocessing
2078 * Whitespace::                  Whitespace
2079 * Comments::                    Comments
2080 * Symbol Intro::                Symbols
2081 * Statements::                  Statements
2082 * Constants::                   Constants
2083 @end menu
2085 @node Preprocessing
2086 @section Preprocessing
2088 @cindex preprocessing
2089 The @command{@value{AS}} internal preprocessor:
2090 @itemize @bullet
2091 @cindex whitespace, removed by preprocessor
2092 @item
2093 adjusts and removes extra whitespace.  It leaves one space or tab before
2094 the keywords on a line, and turns any other whitespace on the line into
2095 a single space.
2097 @cindex comments, removed by preprocessor
2098 @item
2099 removes all comments, replacing them with a single space, or an
2100 appropriate number of newlines.
2102 @cindex constants, converted by preprocessor
2103 @item
2104 converts character constants into the appropriate numeric values.
2105 @end itemize
2107 It does not do macro processing, include file handling, or
2108 anything else you may get from your C compiler's preprocessor.  You can
2109 do include file processing with the @code{.include} directive
2110 (@pxref{Include,,@code{.include}}).  You can use the @sc{gnu} C compiler driver
2111 to get other ``CPP'' style preprocessing by giving the input file a
2112 @samp{.S} suffix.  @xref{Overall Options, ,Options Controlling the Kind of
2113 Output, gcc.info, Using GNU CC}.
2115 Excess whitespace, comments, and character constants
2116 cannot be used in the portions of the input text that are not
2117 preprocessed.
2119 @cindex turning preprocessing on and off
2120 @cindex preprocessing, turning on and off
2121 @kindex #NO_APP
2122 @kindex #APP
2123 If the first line of an input file is @code{#NO_APP} or if you use the
2124 @samp{-f} option, whitespace and comments are not removed from the input file.
2125 Within an input file, you can ask for whitespace and comment removal in
2126 specific portions of the by putting a line that says @code{#APP} before the
2127 text that may contain whitespace or comments, and putting a line that says
2128 @code{#NO_APP} after this text.  This feature is mainly intend to support
2129 @code{asm} statements in compilers whose output is otherwise free of comments
2130 and whitespace.
2132 @node Whitespace
2133 @section Whitespace
2135 @cindex whitespace
2136 @dfn{Whitespace} is one or more blanks or tabs, in any order.
2137 Whitespace is used to separate symbols, and to make programs neater for
2138 people to read.  Unless within character constants
2139 (@pxref{Characters,,Character Constants}), any whitespace means the same
2140 as exactly one space.
2142 @node Comments
2143 @section Comments
2145 @cindex comments
2146 There are two ways of rendering comments to @command{@value{AS}}.  In both
2147 cases the comment is equivalent to one space.
2149 Anything from @samp{/*} through the next @samp{*/} is a comment.
2150 This means you may not nest these comments.
2152 @smallexample
2154   The only way to include a newline ('\n') in a comment
2155   is to use this sort of comment.
2158 /* This sort of comment does not nest. */
2159 @end smallexample
2161 @cindex line comment character
2162 Anything from the @dfn{line comment} character to the next newline
2163 is considered a comment and is ignored.  The line comment character is
2164 @ifset ARC
2165 @samp{;} on the ARC;
2166 @end ifset
2167 @ifset ARM
2168 @samp{@@} on the ARM;
2169 @end ifset
2170 @ifset H8/300
2171 @samp{;} for the H8/300 family;
2172 @end ifset
2173 @ifset HPPA
2174 @samp{;} for the HPPA;
2175 @end ifset
2176 @ifset I80386
2177 @samp{#} on the i386 and x86-64;
2178 @end ifset
2179 @ifset I960
2180 @samp{#} on the i960;
2181 @end ifset
2182 @ifset PDP11
2183 @samp{;} for the PDP-11;
2184 @end ifset
2185 @ifset PJ
2186 @samp{;} for picoJava;
2187 @end ifset
2188 @ifset PPC
2189 @samp{#} for Motorola PowerPC;
2190 @end ifset
2191 @ifset SH
2192 @samp{!} for the Renesas / SuperH SH;
2193 @end ifset
2194 @ifset SPARC
2195 @samp{!} on the SPARC;
2196 @end ifset
2197 @ifset IP2K
2198 @samp{#} on the ip2k;
2199 @end ifset
2200 @ifset M32C
2201 @samp{#} on the m32c;
2202 @end ifset
2203 @ifset M32R
2204 @samp{#} on the m32r;
2205 @end ifset
2206 @ifset M680X0
2207 @samp{|} on the 680x0;
2208 @end ifset
2209 @ifset M68HC11
2210 @samp{#} on the 68HC11 and 68HC12;
2211 @end ifset
2212 @ifset VAX
2213 @samp{#} on the Vax;
2214 @end ifset
2215 @ifset Z80
2216 @samp{;} for the Z80;
2217 @end ifset
2218 @ifset Z8000
2219 @samp{!} for the Z8000;
2220 @end ifset
2221 @ifset V850
2222 @samp{#} on the V850;
2223 @end ifset
2224 @ifset XTENSA
2225 @samp{#} for Xtensa systems;
2226 @end ifset
2227 see @ref{Machine Dependencies}.  @refill
2228 @c FIXME What about i860?
2230 @ifset GENERIC
2231 On some machines there are two different line comment characters.  One
2232 character only begins a comment if it is the first non-whitespace character on
2233 a line, while the other always begins a comment.
2234 @end ifset
2236 @ifset V850
2237 The V850 assembler also supports a double dash as starting a comment that
2238 extends to the end of the line.
2240 @samp{--};
2241 @end ifset
2243 @kindex #
2244 @cindex lines starting with @code{#}
2245 @cindex logical line numbers
2246 To be compatible with past assemblers, lines that begin with @samp{#} have a
2247 special interpretation.  Following the @samp{#} should be an absolute
2248 expression (@pxref{Expressions}): the logical line number of the @emph{next}
2249 line.  Then a string (@pxref{Strings, ,Strings}) is allowed: if present it is a
2250 new logical file name.  The rest of the line, if any, should be whitespace.
2252 If the first non-whitespace characters on the line are not numeric,
2253 the line is ignored.  (Just like a comment.)
2255 @smallexample
2256                           # This is an ordinary comment.
2257 # 42-6 "new_file_name"    # New logical file name
2258                           # This is logical line # 36.
2259 @end smallexample
2260 This feature is deprecated, and may disappear from future versions
2261 of @command{@value{AS}}.
2263 @node Symbol Intro
2264 @section Symbols
2266 @cindex characters used in symbols
2267 @ifclear SPECIAL-SYMS
2268 A @dfn{symbol} is one or more characters chosen from the set of all
2269 letters (both upper and lower case), digits and the three characters
2270 @samp{_.$}.
2271 @end ifclear
2272 @ifset SPECIAL-SYMS
2273 @ifclear GENERIC
2274 @ifset H8
2275 A @dfn{symbol} is one or more characters chosen from the set of all
2276 letters (both upper and lower case), digits and the three characters
2277 @samp{._$}.  (Save that, on the H8/300 only, you may not use @samp{$} in
2278 symbol names.)
2279 @end ifset
2280 @end ifclear
2281 @end ifset
2282 @ifset GENERIC
2283 On most machines, you can also use @code{$} in symbol names; exceptions
2284 are noted in @ref{Machine Dependencies}.
2285 @end ifset
2286 No symbol may begin with a digit.  Case is significant.
2287 There is no length limit: all characters are significant.  Symbols are
2288 delimited by characters not in that set, or by the beginning of a file
2289 (since the source program must end with a newline, the end of a file is
2290 not a possible symbol delimiter).  @xref{Symbols}.
2291 @cindex length of symbols
2293 @node Statements
2294 @section Statements
2296 @cindex statements, structure of
2297 @cindex line separator character
2298 @cindex statement separator character
2299 @ifclear GENERIC
2300 @ifclear abnormal-separator
2301 A @dfn{statement} ends at a newline character (@samp{\n}) or at a
2302 semicolon (@samp{;}).  The newline or semicolon is considered part of
2303 the preceding statement.  Newlines and semicolons within character
2304 constants are an exception: they do not end statements.
2305 @end ifclear
2306 @ifset abnormal-separator
2307 @ifset HPPA
2308 A @dfn{statement} ends at a newline character (@samp{\n}) or an exclamation 
2309 point (@samp{!}).  The newline or exclamation point is considered part of the
2310 preceding statement.  Newlines and exclamation points within character
2311 constants are an exception: they do not end statements.
2312 @end ifset
2313 @ifset H8
2314 A @dfn{statement} ends at a newline character (@samp{\n}); or (for the
2315 H8/300) a dollar sign (@samp{$}); or (for the Renesas-SH) a semicolon
2316 (@samp{;}).  The newline or separator character is considered part of
2317 the preceding statement.  Newlines and separators within character
2318 constants are an exception: they do not end statements.
2319 @end ifset
2320 @end ifset
2321 @end ifclear
2322 @ifset GENERIC
2323 A @dfn{statement} ends at a newline character (@samp{\n}) or line
2324 separator character.  (The line separator is usually @samp{;}, unless this
2325 conflicts with the comment character; see @ref{Machine Dependencies}.)  The
2326 newline or separator character is considered part of the preceding
2327 statement.  Newlines and separators within character constants are an
2328 exception: they do not end statements.
2329 @end ifset
2331 @cindex newline, required at file end
2332 @cindex EOF, newline must precede
2333 It is an error to end any statement with end-of-file:  the last
2334 character of any input file should be a newline.@refill
2336 An empty statement is allowed, and may include whitespace.  It is ignored.
2338 @cindex instructions and directives
2339 @cindex directives and instructions
2340 @c "key symbol" is not used elsewhere in the document; seems pedantic to
2341 @c @defn{} it in that case, as was done previously...  doc@cygnus.com,
2342 @c 13feb91.
2343 A statement begins with zero or more labels, optionally followed by a
2344 key symbol which determines what kind of statement it is.  The key
2345 symbol determines the syntax of the rest of the statement.  If the
2346 symbol begins with a dot @samp{.} then the statement is an assembler
2347 directive: typically valid for any computer.  If the symbol begins with
2348 a letter the statement is an assembly language @dfn{instruction}: it
2349 assembles into a machine language instruction.
2350 @ifset GENERIC
2351 Different versions of @command{@value{AS}} for different computers
2352 recognize different instructions.  In fact, the same symbol may
2353 represent a different instruction in a different computer's assembly
2354 language.@refill
2355 @end ifset
2357 @cindex @code{:} (label)
2358 @cindex label (@code{:})
2359 A label is a symbol immediately followed by a colon (@code{:}).
2360 Whitespace before a label or after a colon is permitted, but you may not
2361 have whitespace between a label's symbol and its colon. @xref{Labels}.
2363 @ifset HPPA
2364 For HPPA targets, labels need not be immediately followed by a colon, but 
2365 the definition of a label must begin in column zero.  This also implies that
2366 only one label may be defined on each line.
2367 @end ifset
2369 @smallexample
2370 label:     .directive    followed by something
2371 another_label:           # This is an empty statement.
2372            instruction   operand_1, operand_2, @dots{}
2373 @end smallexample
2375 @node Constants
2376 @section Constants
2378 @cindex constants
2379 A constant is a number, written so that its value is known by
2380 inspection, without knowing any context.  Like this:
2381 @smallexample
2382 @group
2383 .byte  74, 0112, 092, 0x4A, 0X4a, 'J, '\J # All the same value.
2384 .ascii "Ring the bell\7"                  # A string constant.
2385 .octa  0x123456789abcdef0123456789ABCDEF0 # A bignum.
2386 .float 0f-314159265358979323846264338327\
2387 95028841971.693993751E-40                 # - pi, a flonum.
2388 @end group
2389 @end smallexample
2391 @menu
2392 * Characters::                  Character Constants
2393 * Numbers::                     Number Constants
2394 @end menu
2396 @node Characters
2397 @subsection Character Constants
2399 @cindex character constants
2400 @cindex constants, character
2401 There are two kinds of character constants.  A @dfn{character} stands
2402 for one character in one byte and its value may be used in
2403 numeric expressions.  String constants (properly called string
2404 @emph{literals}) are potentially many bytes and their values may not be
2405 used in arithmetic expressions.
2407 @menu
2408 * Strings::                     Strings
2409 * Chars::                       Characters
2410 @end menu
2412 @node Strings
2413 @subsubsection Strings
2415 @cindex string constants
2416 @cindex constants, string
2417 A @dfn{string} is written between double-quotes.  It may contain
2418 double-quotes or null characters.  The way to get special characters
2419 into a string is to @dfn{escape} these characters: precede them with
2420 a backslash @samp{\} character.  For example @samp{\\} represents
2421 one backslash:  the first @code{\} is an escape which tells
2422 @command{@value{AS}} to interpret the second character literally as a backslash
2423 (which prevents @command{@value{AS}} from recognizing the second @code{\} as an
2424 escape character).  The complete list of escapes follows.
2426 @cindex escape codes, character
2427 @cindex character escape codes
2428 @table @kbd
2429 @c      @item \a
2430 @c      Mnemonic for ACKnowledge; for ASCII this is octal code 007.
2432 @cindex @code{\b} (backspace character)
2433 @cindex backspace (@code{\b})
2434 @item \b
2435 Mnemonic for backspace; for ASCII this is octal code 010.
2437 @c      @item \e
2438 @c      Mnemonic for EOText; for ASCII this is octal code 004.
2440 @cindex @code{\f} (formfeed character)
2441 @cindex formfeed (@code{\f})
2442 @item \f
2443 Mnemonic for FormFeed; for ASCII this is octal code 014.
2445 @cindex @code{\n} (newline character)
2446 @cindex newline (@code{\n})
2447 @item \n
2448 Mnemonic for newline; for ASCII this is octal code 012.
2450 @c      @item \p
2451 @c      Mnemonic for prefix; for ASCII this is octal code 033, usually known as @code{escape}.
2453 @cindex @code{\r} (carriage return character)
2454 @cindex carriage return (@code{\r})
2455 @item \r
2456 Mnemonic for carriage-Return; for ASCII this is octal code 015.
2458 @c      @item \s
2459 @c      Mnemonic for space; for ASCII this is octal code 040.  Included for compliance with
2460 @c      other assemblers.
2462 @cindex @code{\t} (tab)
2463 @cindex tab (@code{\t})
2464 @item \t
2465 Mnemonic for horizontal Tab; for ASCII this is octal code 011.
2467 @c      @item \v
2468 @c      Mnemonic for Vertical tab; for ASCII this is octal code 013.
2469 @c      @item \x @var{digit} @var{digit} @var{digit}
2470 @c      A hexadecimal character code.  The numeric code is 3 hexadecimal digits.
2472 @cindex @code{\@var{ddd}} (octal character code)
2473 @cindex octal character code (@code{\@var{ddd}})
2474 @item \ @var{digit} @var{digit} @var{digit}
2475 An octal character code.  The numeric code is 3 octal digits.
2476 For compatibility with other Unix systems, 8 and 9 are accepted as digits:
2477 for example, @code{\008} has the value 010, and @code{\009} the value 011.
2479 @cindex @code{\@var{xd...}} (hex character code)
2480 @cindex hex character code (@code{\@var{xd...}})
2481 @item \@code{x} @var{hex-digits...}
2482 A hex character code.  All trailing hex digits are combined.  Either upper or
2483 lower case @code{x} works.
2485 @cindex @code{\\} (@samp{\} character)
2486 @cindex backslash (@code{\\})
2487 @item \\
2488 Represents one @samp{\} character.
2490 @c      @item \'
2491 @c      Represents one @samp{'} (accent acute) character.
2492 @c      This is needed in single character literals
2493 @c      (@xref{Characters,,Character Constants}.) to represent
2494 @c      a @samp{'}.
2496 @cindex @code{\"} (doublequote character)
2497 @cindex doublequote (@code{\"})
2498 @item \"
2499 Represents one @samp{"} character.  Needed in strings to represent
2500 this character, because an unescaped @samp{"} would end the string.
2502 @item \ @var{anything-else}
2503 Any other character when escaped by @kbd{\} gives a warning, but
2504 assembles as if the @samp{\} was not present.  The idea is that if
2505 you used an escape sequence you clearly didn't want the literal
2506 interpretation of the following character.  However @command{@value{AS}} has no
2507 other interpretation, so @command{@value{AS}} knows it is giving you the wrong
2508 code and warns you of the fact.
2509 @end table
2511 Which characters are escapable, and what those escapes represent,
2512 varies widely among assemblers.  The current set is what we think
2513 the BSD 4.2 assembler recognizes, and is a subset of what most C
2514 compilers recognize.  If you are in doubt, do not use an escape
2515 sequence.
2517 @node Chars
2518 @subsubsection Characters
2520 @cindex single character constant
2521 @cindex character, single
2522 @cindex constant, single character
2523 A single character may be written as a single quote immediately
2524 followed by that character.  The same escapes apply to characters as
2525 to strings.  So if you want to write the character backslash, you
2526 must write @kbd{'\\} where the first @code{\} escapes the second
2527 @code{\}.  As you can see, the quote is an acute accent, not a
2528 grave accent.  A newline
2529 @ifclear GENERIC
2530 @ifclear abnormal-separator
2531 (or semicolon @samp{;})
2532 @end ifclear
2533 @ifset abnormal-separator
2534 @ifset H8
2535 (or dollar sign @samp{$}, for the H8/300; or semicolon @samp{;} for the
2536 Renesas SH)
2537 @end ifset
2538 @end ifset
2539 @end ifclear
2540 immediately following an acute accent is taken as a literal character
2541 and does not count as the end of a statement.  The value of a character
2542 constant in a numeric expression is the machine's byte-wide code for
2543 that character.  @command{@value{AS}} assumes your character code is ASCII:
2544 @kbd{'A} means 65, @kbd{'B} means 66, and so on. @refill
2546 @node Numbers
2547 @subsection Number Constants
2549 @cindex constants, number
2550 @cindex number constants
2551 @command{@value{AS}} distinguishes three kinds of numbers according to how they
2552 are stored in the target machine.  @emph{Integers} are numbers that
2553 would fit into an @code{int} in the C language.  @emph{Bignums} are
2554 integers, but they are stored in more than 32 bits.  @emph{Flonums}
2555 are floating point numbers, described below.
2557 @menu
2558 * Integers::                    Integers
2559 * Bignums::                     Bignums
2560 * Flonums::                     Flonums
2561 @ifclear GENERIC
2562 @ifset I960
2563 * Bit Fields::                  Bit Fields
2564 @end ifset
2565 @end ifclear
2566 @end menu
2568 @node Integers
2569 @subsubsection Integers
2570 @cindex integers
2571 @cindex constants, integer
2573 @cindex binary integers
2574 @cindex integers, binary
2575 A binary integer is @samp{0b} or @samp{0B} followed by zero or more of
2576 the binary digits @samp{01}.
2578 @cindex octal integers
2579 @cindex integers, octal
2580 An octal integer is @samp{0} followed by zero or more of the octal
2581 digits (@samp{01234567}).
2583 @cindex decimal integers
2584 @cindex integers, decimal
2585 A decimal integer starts with a non-zero digit followed by zero or
2586 more digits (@samp{0123456789}).
2588 @cindex hexadecimal integers
2589 @cindex integers, hexadecimal
2590 A hexadecimal integer is @samp{0x} or @samp{0X} followed by one or
2591 more hexadecimal digits chosen from @samp{0123456789abcdefABCDEF}.
2593 Integers have the usual values.  To denote a negative integer, use
2594 the prefix operator @samp{-} discussed under expressions
2595 (@pxref{Prefix Ops,,Prefix Operators}).
2597 @node Bignums
2598 @subsubsection Bignums
2600 @cindex bignums
2601 @cindex constants, bignum
2602 A @dfn{bignum} has the same syntax and semantics as an integer
2603 except that the number (or its negative) takes more than 32 bits to
2604 represent in binary.  The distinction is made because in some places
2605 integers are permitted while bignums are not.
2607 @node Flonums
2608 @subsubsection Flonums
2609 @cindex flonums
2610 @cindex floating point numbers
2611 @cindex constants, floating point
2613 @cindex precision, floating point
2614 A @dfn{flonum} represents a floating point number.  The translation is
2615 indirect: a decimal floating point number from the text is converted by
2616 @command{@value{AS}} to a generic binary floating point number of more than
2617 sufficient precision.  This generic floating point number is converted
2618 to a particular computer's floating point format (or formats) by a
2619 portion of @command{@value{AS}} specialized to that computer.
2621 A flonum is written by writing (in order)
2622 @itemize @bullet
2623 @item
2624 The digit @samp{0}.
2625 @ifset HPPA
2626 (@samp{0} is optional on the HPPA.)
2627 @end ifset
2629 @item
2630 A letter, to tell @command{@value{AS}} the rest of the number is a flonum.
2631 @ifset GENERIC
2632 @kbd{e} is recommended.  Case is not important.
2633 @ignore
2634 @c FIXME: verify if flonum syntax really this vague for most cases
2635 (Any otherwise illegal letter works here, but that might be changed.  Vax BSD
2636 4.2 assembler seems to allow any of @samp{defghDEFGH}.)
2637 @end ignore
2639 On the H8/300, Renesas / SuperH SH,
2640 and AMD 29K architectures, the letter must be
2641 one of the letters @samp{DFPRSX} (in upper or lower case).
2643 On the ARC, the letter must be one of the letters @samp{DFRS}
2644 (in upper or lower case).
2646 On the Intel 960 architecture, the letter must be
2647 one of the letters @samp{DFT} (in upper or lower case).
2649 On the HPPA architecture, the letter must be @samp{E} (upper case only).
2650 @end ifset
2651 @ifclear GENERIC
2652 @ifset ARC
2653 One of the letters @samp{DFRS} (in upper or lower case).
2654 @end ifset
2655 @ifset H8
2656 One of the letters @samp{DFPRSX} (in upper or lower case).
2657 @end ifset
2658 @ifset HPPA
2659 The letter @samp{E} (upper case only).
2660 @end ifset
2661 @ifset I960
2662 One of the letters @samp{DFT} (in upper or lower case).
2663 @end ifset
2664 @end ifclear
2666 @item
2667 An optional sign: either @samp{+} or @samp{-}.
2669 @item
2670 An optional @dfn{integer part}: zero or more decimal digits.
2672 @item
2673 An optional @dfn{fractional part}: @samp{.} followed by zero
2674 or more decimal digits.
2676 @item
2677 An optional exponent, consisting of:
2679 @itemize @bullet
2680 @item
2681 An @samp{E} or @samp{e}.
2682 @c I can't find a config where "EXP_CHARS" is other than 'eE', but in
2683 @c principle this can perfectly well be different on different targets.
2684 @item
2685 Optional sign: either @samp{+} or @samp{-}.
2686 @item
2687 One or more decimal digits.
2688 @end itemize
2690 @end itemize
2692 At least one of the integer part or the fractional part must be
2693 present.  The floating point number has the usual base-10 value.
2695 @command{@value{AS}} does all processing using integers.  Flonums are computed
2696 independently of any floating point hardware in the computer running
2697 @command{@value{AS}}.
2699 @ifclear GENERIC
2700 @ifset I960
2701 @c Bit fields are written as a general facility but are also controlled
2702 @c by a conditional-compilation flag---which is as of now (21mar91)
2703 @c turned on only by the i960 config of GAS.
2704 @node Bit Fields
2705 @subsubsection Bit Fields
2707 @cindex bit fields
2708 @cindex constants, bit field
2709 You can also define numeric constants as @dfn{bit fields}.
2710 Specify two numbers separated by a colon---
2711 @example
2712 @var{mask}:@var{value}
2713 @end example
2714 @noindent
2715 @command{@value{AS}} applies a bitwise @sc{and} between @var{mask} and
2716 @var{value}.
2718 The resulting number is then packed
2719 @ifset GENERIC
2720 @c this conditional paren in case bit fields turned on elsewhere than 960
2721 (in host-dependent byte order)
2722 @end ifset
2723 into a field whose width depends on which assembler directive has the
2724 bit-field as its argument.  Overflow (a result from the bitwise and
2725 requiring more binary digits to represent) is not an error; instead,
2726 more constants are generated, of the specified width, beginning with the
2727 least significant digits.@refill
2729 The directives @code{.byte}, @code{.hword}, @code{.int}, @code{.long},
2730 @code{.short}, and @code{.word} accept bit-field arguments.
2731 @end ifset
2732 @end ifclear
2734 @node Sections
2735 @chapter Sections and Relocation
2736 @cindex sections
2737 @cindex relocation
2739 @menu
2740 * Secs Background::             Background
2741 * Ld Sections::                 Linker Sections
2742 * As Sections::                 Assembler Internal Sections
2743 * Sub-Sections::                Sub-Sections
2744 * bss::                         bss Section
2745 @end menu
2747 @node Secs Background
2748 @section Background
2750 Roughly, a section is a range of addresses, with no gaps; all data
2751 ``in'' those addresses is treated the same for some particular purpose.
2752 For example there may be a ``read only'' section.
2754 @cindex linker, and assembler
2755 @cindex assembler, and linker
2756 The linker @code{@value{LD}} reads many object files (partial programs) and
2757 combines their contents to form a runnable program.  When @command{@value{AS}}
2758 emits an object file, the partial program is assumed to start at address 0.
2759 @code{@value{LD}} assigns the final addresses for the partial program, so that
2760 different partial programs do not overlap.  This is actually an
2761 oversimplification, but it suffices to explain how @command{@value{AS}} uses
2762 sections.
2764 @code{@value{LD}} moves blocks of bytes of your program to their run-time
2765 addresses.  These blocks slide to their run-time addresses as rigid
2766 units; their length does not change and neither does the order of bytes
2767 within them.  Such a rigid unit is called a @emph{section}.  Assigning
2768 run-time addresses to sections is called @dfn{relocation}.  It includes
2769 the task of adjusting mentions of object-file addresses so they refer to
2770 the proper run-time addresses.
2771 @ifset H8
2772 For the H8/300, and for the Renesas / SuperH SH,
2773 @command{@value{AS}} pads sections if needed to
2774 ensure they end on a word (sixteen bit) boundary.
2775 @end ifset
2777 @cindex standard assembler sections
2778 An object file written by @command{@value{AS}} has at least three sections, any
2779 of which may be empty.  These are named @dfn{text}, @dfn{data} and
2780 @dfn{bss} sections.
2782 @ifset COFF-ELF
2783 @ifset GENERIC
2784 When it generates COFF or ELF output,
2785 @end ifset
2786 @command{@value{AS}} can also generate whatever other named sections you specify
2787 using the @samp{.section} directive (@pxref{Section,,@code{.section}}).
2788 If you do not use any directives that place output in the @samp{.text}
2789 or @samp{.data} sections, these sections still exist, but are empty.
2790 @end ifset
2792 @ifset HPPA
2793 @ifset GENERIC
2794 When @command{@value{AS}} generates SOM or ELF output for the HPPA,
2795 @end ifset
2796 @command{@value{AS}} can also generate whatever other named sections you
2797 specify using the @samp{.space} and @samp{.subspace} directives.  See
2798 @cite{HP9000 Series 800 Assembly Language Reference Manual}
2799 (HP 92432-90001) for details on the @samp{.space} and @samp{.subspace}
2800 assembler directives.
2802 @ifset SOM
2803 Additionally, @command{@value{AS}} uses different names for the standard
2804 text, data, and bss sections when generating SOM output.  Program text
2805 is placed into the @samp{$CODE$} section, data into @samp{$DATA$}, and
2806 BSS into @samp{$BSS$}.
2807 @end ifset
2808 @end ifset
2810 Within the object file, the text section starts at address @code{0}, the
2811 data section follows, and the bss section follows the data section.
2813 @ifset HPPA
2814 When generating either SOM or ELF output files on the HPPA, the text
2815 section starts at address @code{0}, the data section at address
2816 @code{0x4000000}, and the bss section follows the data section.
2817 @end ifset
2819 To let @code{@value{LD}} know which data changes when the sections are
2820 relocated, and how to change that data, @command{@value{AS}} also writes to the
2821 object file details of the relocation needed.  To perform relocation
2822 @code{@value{LD}} must know, each time an address in the object
2823 file is mentioned:
2824 @itemize @bullet
2825 @item
2826 Where in the object file is the beginning of this reference to
2827 an address?
2828 @item
2829 How long (in bytes) is this reference?
2830 @item
2831 Which section does the address refer to?  What is the numeric value of
2832 @display
2833 (@var{address}) @minus{} (@var{start-address of section})?
2834 @end display
2835 @item
2836 Is the reference to an address ``Program-Counter relative''?
2837 @end itemize
2839 @cindex addresses, format of
2840 @cindex section-relative addressing
2841 In fact, every address @command{@value{AS}} ever uses is expressed as
2842 @display
2843 (@var{section}) + (@var{offset into section})
2844 @end display
2845 @noindent
2846 Further, most expressions @command{@value{AS}} computes have this section-relative
2847 nature.
2848 @ifset SOM
2849 (For some object formats, such as SOM for the HPPA, some expressions are
2850 symbol-relative instead.)
2851 @end ifset
2853 In this manual we use the notation @{@var{secname} @var{N}@} to mean ``offset
2854 @var{N} into section @var{secname}.''
2856 Apart from text, data and bss sections you need to know about the
2857 @dfn{absolute} section.  When @code{@value{LD}} mixes partial programs,
2858 addresses in the absolute section remain unchanged.  For example, address
2859 @code{@{absolute 0@}} is ``relocated'' to run-time address 0 by
2860 @code{@value{LD}}.  Although the linker never arranges two partial programs'
2861 data sections with overlapping addresses after linking, @emph{by definition}
2862 their absolute sections must overlap.  Address @code{@{absolute@ 239@}} in one
2863 part of a program is always the same address when the program is running as
2864 address @code{@{absolute@ 239@}} in any other part of the program.
2866 The idea of sections is extended to the @dfn{undefined} section.  Any
2867 address whose section is unknown at assembly time is by definition
2868 rendered @{undefined @var{U}@}---where @var{U} is filled in later.
2869 Since numbers are always defined, the only way to generate an undefined
2870 address is to mention an undefined symbol.  A reference to a named
2871 common block would be such a symbol: its value is unknown at assembly
2872 time so it has section @emph{undefined}.
2874 By analogy the word @emph{section} is used to describe groups of sections in
2875 the linked program.  @code{@value{LD}} puts all partial programs' text
2876 sections in contiguous addresses in the linked program.  It is
2877 customary to refer to the @emph{text section} of a program, meaning all
2878 the addresses of all partial programs' text sections.  Likewise for
2879 data and bss sections.
2881 Some sections are manipulated by @code{@value{LD}}; others are invented for
2882 use of @command{@value{AS}} and have no meaning except during assembly.
2884 @node Ld Sections
2885 @section Linker Sections
2886 @code{@value{LD}} deals with just four kinds of sections, summarized below.
2888 @table @strong
2890 @ifset COFF-ELF
2891 @cindex named sections
2892 @cindex sections, named
2893 @item named sections
2894 @end ifset
2895 @ifset aout-bout
2896 @cindex text section
2897 @cindex data section
2898 @itemx text section
2899 @itemx data section
2900 @end ifset
2901 These sections hold your program.  @command{@value{AS}} and @code{@value{LD}} treat them as
2902 separate but equal sections.  Anything you can say of one section is
2903 true of another.
2904 @c @ifset aout-bout
2905 When the program is running, however, it is
2906 customary for the text section to be unalterable.  The
2907 text section is often shared among processes: it contains
2908 instructions, constants and the like.  The data section of a running
2909 program is usually alterable: for example, C variables would be stored
2910 in the data section.
2911 @c @end ifset
2913 @cindex bss section
2914 @item bss section
2915 This section contains zeroed bytes when your program begins running.  It
2916 is used to hold uninitialized variables or common storage.  The length of
2917 each partial program's bss section is important, but because it starts
2918 out containing zeroed bytes there is no need to store explicit zero
2919 bytes in the object file.  The bss section was invented to eliminate
2920 those explicit zeros from object files.
2922 @cindex absolute section
2923 @item absolute section
2924 Address 0 of this section is always ``relocated'' to runtime address 0.
2925 This is useful if you want to refer to an address that @code{@value{LD}} must
2926 not change when relocating.  In this sense we speak of absolute
2927 addresses being ``unrelocatable'': they do not change during relocation.
2929 @cindex undefined section
2930 @item undefined section
2931 This ``section'' is a catch-all for address references to objects not in
2932 the preceding sections.
2933 @c FIXME: ref to some other doc on obj-file formats could go here.
2934 @end table
2936 @cindex relocation example
2937 An idealized example of three relocatable sections follows.
2938 @ifset COFF-ELF
2939 The example uses the traditional section names @samp{.text} and @samp{.data}.
2940 @end ifset
2941 Memory addresses are on the horizontal axis.
2943 @c TEXI2ROFF-KILL
2944 @ifnottex
2945 @c END TEXI2ROFF-KILL
2946 @smallexample
2947                       +-----+----+--+
2948 partial program # 1:  |ttttt|dddd|00|
2949                       +-----+----+--+
2951                       text   data bss
2952                       seg.   seg. seg.
2954                       +---+---+---+
2955 partial program # 2:  |TTT|DDD|000|
2956                       +---+---+---+
2958                       +--+---+-----+--+----+---+-----+~~
2959 linked program:       |  |TTT|ttttt|  |dddd|DDD|00000|
2960                       +--+---+-----+--+----+---+-----+~~
2962     addresses:        0 @dots{}
2963 @end smallexample
2964 @c TEXI2ROFF-KILL
2965 @end ifnottex
2966 @need 5000
2967 @tex
2968 \bigskip
2969 \line{\it Partial program \#1: \hfil}
2970 \line{\ibox{2.5cm}{\tt text}\ibox{2cm}{\tt data}\ibox{1cm}{\tt bss}\hfil}
2971 \line{\boxit{2.5cm}{\tt ttttt}\boxit{2cm}{\tt dddd}\boxit{1cm}{\tt 00}\hfil}
2973 \line{\it Partial program \#2: \hfil}
2974 \line{\ibox{1cm}{\tt text}\ibox{1.5cm}{\tt data}\ibox{1cm}{\tt bss}\hfil}
2975 \line{\boxit{1cm}{\tt TTT}\boxit{1.5cm}{\tt DDDD}\boxit{1cm}{\tt 000}\hfil}
2977 \line{\it linked program: \hfil}
2978 \line{\ibox{.5cm}{}\ibox{1cm}{\tt text}\ibox{2.5cm}{}\ibox{.75cm}{}\ibox{2cm}{\tt data}\ibox{1.5cm}{}\ibox{2cm}{\tt bss}\hfil}
2979 \line{\boxit{.5cm}{}\boxit{1cm}{\tt TTT}\boxit{2.5cm}{\tt
2980 ttttt}\boxit{.75cm}{}\boxit{2cm}{\tt dddd}\boxit{1.5cm}{\tt
2981 DDDD}\boxit{2cm}{\tt 00000}\ \dots\hfil}
2983 \line{\it addresses: \hfil}
2984 \line{0\dots\hfil}
2986 @end tex
2987 @c END TEXI2ROFF-KILL
2989 @node As Sections
2990 @section Assembler Internal Sections
2992 @cindex internal assembler sections
2993 @cindex sections in messages, internal
2994 These sections are meant only for the internal use of @command{@value{AS}}.  They
2995 have no meaning at run-time.  You do not really need to know about these
2996 sections for most purposes; but they can be mentioned in @command{@value{AS}}
2997 warning messages, so it might be helpful to have an idea of their
2998 meanings to @command{@value{AS}}.  These sections are used to permit the
2999 value of every expression in your assembly language program to be a
3000 section-relative address.
3002 @table @b
3003 @cindex assembler internal logic error
3004 @item ASSEMBLER-INTERNAL-LOGIC-ERROR!
3005 An internal assembler logic error has been found.  This means there is a
3006 bug in the assembler.
3008 @cindex expr (internal section)
3009 @item expr section
3010 The assembler stores complex expression internally as combinations of
3011 symbols.  When it needs to represent an expression as a symbol, it puts
3012 it in the expr section.
3013 @c FIXME item debug
3014 @c FIXME item transfer[t] vector preload
3015 @c FIXME item transfer[t] vector postload
3016 @c FIXME item register
3017 @end table
3019 @node Sub-Sections
3020 @section Sub-Sections
3022 @cindex numbered subsections
3023 @cindex grouping data
3024 @ifset aout-bout
3025 Assembled bytes
3026 @ifset COFF-ELF
3027 conventionally
3028 @end ifset
3029 fall into two sections: text and data.
3030 @end ifset
3031 You may have separate groups of
3032 @ifset GENERIC
3033 data in named sections
3034 @end ifset
3035 @ifclear GENERIC
3036 @ifclear aout-bout
3037 data in named sections
3038 @end ifclear
3039 @ifset aout-bout
3040 text or data
3041 @end ifset
3042 @end ifclear
3043 that you want to end up near to each other in the object file, even though they
3044 are not contiguous in the assembler source.  @command{@value{AS}} allows you to
3045 use @dfn{subsections} for this purpose.  Within each section, there can be
3046 numbered subsections with values from 0 to 8192.  Objects assembled into the
3047 same subsection go into the object file together with other objects in the same
3048 subsection.  For example, a compiler might want to store constants in the text
3049 section, but might not want to have them interspersed with the program being
3050 assembled.  In this case, the compiler could issue a @samp{.text 0} before each
3051 section of code being output, and a @samp{.text 1} before each group of
3052 constants being output.
3054 Subsections are optional.  If you do not use subsections, everything
3055 goes in subsection number zero.
3057 @ifset GENERIC
3058 Each subsection is zero-padded up to a multiple of four bytes.
3059 (Subsections may be padded a different amount on different flavors
3060 of @command{@value{AS}}.)
3061 @end ifset
3062 @ifclear GENERIC
3063 @ifset H8
3064 On the H8/300 platform, each subsection is zero-padded to a word
3065 boundary (two bytes).
3066 The same is true on the Renesas SH.
3067 @end ifset
3068 @ifset I960
3069 @c FIXME section padding (alignment)?
3070 @c Rich Pixley says padding here depends on target obj code format; that
3071 @c doesn't seem particularly useful to say without further elaboration,
3072 @c so for now I say nothing about it.  If this is a generic BFD issue,
3073 @c these paragraphs might need to vanish from this manual, and be
3074 @c discussed in BFD chapter of binutils (or some such).
3075 @end ifset
3076 @end ifclear
3078 Subsections appear in your object file in numeric order, lowest numbered
3079 to highest.  (All this to be compatible with other people's assemblers.)
3080 The object file contains no representation of subsections; @code{@value{LD}} and
3081 other programs that manipulate object files see no trace of them.
3082 They just see all your text subsections as a text section, and all your
3083 data subsections as a data section.
3085 To specify which subsection you want subsequent statements assembled
3086 into, use a numeric argument to specify it, in a @samp{.text
3087 @var{expression}} or a @samp{.data @var{expression}} statement.
3088 @ifset COFF
3089 @ifset GENERIC
3090 When generating COFF output, you
3091 @end ifset
3092 @ifclear GENERIC
3094 @end ifclear
3095 can also use an extra subsection
3096 argument with arbitrary named sections: @samp{.section @var{name},
3097 @var{expression}}.
3098 @end ifset
3099 @ifset ELF
3100 @ifset GENERIC
3101 When generating ELF output, you
3102 @end ifset
3103 @ifclear GENERIC
3105 @end ifclear
3106 can also use the @code{.subsection} directive (@pxref{SubSection})
3107 to specify a subsection: @samp{.subsection @var{expression}}.
3108 @end ifset
3109 @var{Expression} should be an absolute expression
3110 (@pxref{Expressions}).  If you just say @samp{.text} then @samp{.text 0}
3111 is assumed.  Likewise @samp{.data} means @samp{.data 0}.  Assembly
3112 begins in @code{text 0}.  For instance:
3113 @smallexample
3114 .text 0     # The default subsection is text 0 anyway.
3115 .ascii "This lives in the first text subsection. *"
3116 .text 1
3117 .ascii "But this lives in the second text subsection."
3118 .data 0
3119 .ascii "This lives in the data section,"
3120 .ascii "in the first data subsection."
3121 .text 0
3122 .ascii "This lives in the first text section,"
3123 .ascii "immediately following the asterisk (*)."
3124 @end smallexample
3126 Each section has a @dfn{location counter} incremented by one for every byte
3127 assembled into that section.  Because subsections are merely a convenience
3128 restricted to @command{@value{AS}} there is no concept of a subsection location
3129 counter.  There is no way to directly manipulate a location counter---but the
3130 @code{.align} directive changes it, and any label definition captures its
3131 current value.  The location counter of the section where statements are being
3132 assembled is said to be the @dfn{active} location counter.
3134 @node bss
3135 @section bss Section
3137 @cindex bss section
3138 @cindex common variable storage
3139 The bss section is used for local common variable storage.
3140 You may allocate address space in the bss section, but you may
3141 not dictate data to load into it before your program executes.  When
3142 your program starts running, all the contents of the bss
3143 section are zeroed bytes.
3145 The @code{.lcomm} pseudo-op defines a symbol in the bss section; see
3146 @ref{Lcomm,,@code{.lcomm}}.
3148 The @code{.comm} pseudo-op may be used to declare a common symbol, which is
3149 another form of uninitialized symbol; see @ref{Comm,,@code{.comm}}.
3151 @ifset GENERIC
3152 When assembling for a target which supports multiple sections, such as ELF or
3153 COFF, you may switch into the @code{.bss} section and define symbols as usual;
3154 see @ref{Section,,@code{.section}}.  You may only assemble zero values into the
3155 section.  Typically the section will only contain symbol definitions and
3156 @code{.skip} directives (@pxref{Skip,,@code{.skip}}).
3157 @end ifset
3159 @node Symbols
3160 @chapter Symbols
3162 @cindex symbols
3163 Symbols are a central concept: the programmer uses symbols to name
3164 things, the linker uses symbols to link, and the debugger uses symbols
3165 to debug.
3167 @quotation
3168 @cindex debuggers, and symbol order
3169 @emph{Warning:} @command{@value{AS}} does not place symbols in the object file in
3170 the same order they were declared.  This may break some debuggers.
3171 @end quotation
3173 @menu
3174 * Labels::                      Labels
3175 * Setting Symbols::             Giving Symbols Other Values
3176 * Symbol Names::                Symbol Names
3177 * Dot::                         The Special Dot Symbol
3178 * Symbol Attributes::           Symbol Attributes
3179 @end menu
3181 @node Labels
3182 @section Labels
3184 @cindex labels
3185 A @dfn{label} is written as a symbol immediately followed by a colon
3186 @samp{:}.  The symbol then represents the current value of the
3187 active location counter, and is, for example, a suitable instruction
3188 operand.  You are warned if you use the same symbol to represent two
3189 different locations: the first definition overrides any other
3190 definitions.
3192 @ifset HPPA
3193 On the HPPA, the usual form for a label need not be immediately followed by a
3194 colon, but instead must start in column zero.  Only one label may be defined on
3195 a single line.  To work around this, the HPPA version of @command{@value{AS}} also
3196 provides a special directive @code{.label} for defining labels more flexibly.
3197 @end ifset
3199 @node Setting Symbols
3200 @section Giving Symbols Other Values
3202 @cindex assigning values to symbols
3203 @cindex symbol values, assigning
3204 A symbol can be given an arbitrary value by writing a symbol, followed
3205 by an equals sign @samp{=}, followed by an expression
3206 (@pxref{Expressions}).  This is equivalent to using the @code{.set}
3207 directive.  @xref{Set,,@code{.set}}.  In the same way, using a double
3208 equals sign @samp{=}@samp{=} here represents an equivalent of the
3209 @code{.eqv} directive.  @xref{Eqv,,@code{.eqv}}.
3211 @node Symbol Names
3212 @section Symbol Names
3214 @cindex symbol names
3215 @cindex names, symbol
3216 @ifclear SPECIAL-SYMS
3217 Symbol names begin with a letter or with one of @samp{._}.  On most
3218 machines, you can also use @code{$} in symbol names; exceptions are
3219 noted in @ref{Machine Dependencies}.  That character may be followed by any
3220 string of digits, letters, dollar signs (unless otherwise noted for a
3221 particular target machine), and underscores.
3222 @end ifclear
3223 @ifset SPECIAL-SYMS
3224 @ifset H8
3225 Symbol names begin with a letter or with one of @samp{._}.  On the
3226 Renesas SH you can also use @code{$} in symbol names.  That
3227 character may be followed by any string of digits, letters, dollar signs (save
3228 on the H8/300), and underscores.
3229 @end ifset
3230 @end ifset
3232 Case of letters is significant: @code{foo} is a different symbol name
3233 than @code{Foo}.
3235 Each symbol has exactly one name.  Each name in an assembly language program
3236 refers to exactly one symbol.  You may use that symbol name any number of times
3237 in a program.
3239 @subheading Local Symbol Names
3241 @cindex local symbol names
3242 @cindex symbol names, local
3243 A local symbol is any symbol beginning with certain local label prefixes.
3244 By default, the local label prefix is @samp{.L} for ELF systems or
3245 @samp{L} for traditional a.out systems, but each target may have its own
3246 set of local label prefixes.
3247 @ifset HPPA
3248 On the HPPA local symbols begin with @samp{L$}.
3249 @end ifset
3251 Local symbols are defined and used within the assembler, but they are
3252 normally not saved in object files.  Thus, they are not visible when debugging.
3253 You may use the @samp{-L} option (@pxref{L, ,Include Local Symbols:
3254 @option{-L}}) to retain the local symbols in the object files.
3256 @subheading Local Labels
3258 @cindex local labels
3259 @cindex temporary symbol names
3260 @cindex symbol names, temporary
3261 Local labels help compilers and programmers use names temporarily.
3262 They create symbols which are guaranteed to be unique over the entire scope of
3263 the input source code and which can be referred to by a simple notation.
3264 To define a local label, write a label of the form @samp{@b{N}:} (where @b{N}
3265 represents any positive integer).  To refer to the most recent previous
3266 definition of that label write @samp{@b{N}b}, using the same number as when
3267 you defined the label.  To refer to the next definition of a local label, write
3268 @samp{@b{N}f}---the @samp{b} stands for ``backwards'' and the @samp{f} stands
3269 for ``forwards''.
3271 There is no restriction on how you can use these labels, and you can reuse them
3272 too.  So that it is possible to repeatedly define the same local label (using
3273 the same number @samp{@b{N}}), although you can only refer to the most recently
3274 defined local label of that number (for a backwards reference) or the next
3275 definition of a specific local label for a forward reference.  It is also worth
3276 noting that the first 10 local labels (@samp{@b{0:}}@dots{}@samp{@b{9:}}) are
3277 implemented in a slightly more efficient manner than the others.
3279 Here is an example:
3281 @smallexample
3282 1:        branch 1f
3283 2:        branch 1b
3284 1:        branch 2f
3285 2:        branch 1b
3286 @end smallexample
3288 Which is the equivalent of:
3290 @smallexample
3291 label_1:  branch label_3
3292 label_2:  branch label_1
3293 label_3:  branch label_4
3294 label_4:  branch label_3
3295 @end smallexample
3297 Local label names are only a notational device.  They are immediately
3298 transformed into more conventional symbol names before the assembler uses them.
3299 The symbol names are stored in the symbol table, appear in error messages, and
3300 are optionally emitted to the object file.  The names are constructed using
3301 these parts:
3303 @table @code
3304 @item @emph{local label prefix}
3305 All local symbols begin with the system-specific local label prefix.
3306 Normally both @command{@value{AS}} and @code{@value{LD}} forget symbols
3307 that start with the local label prefix.  These labels are
3308 used for symbols you are never intended to see.  If you use the
3309 @samp{-L} option then @command{@value{AS}} retains these symbols in the
3310 object file. If you also instruct @code{@value{LD}} to retain these symbols,
3311 you may use them in debugging.
3313 @item @var{number}
3314 This is the number that was used in the local label definition.  So if the
3315 label is written @samp{55:} then the number is @samp{55}. 
3317 @item @kbd{C-B}
3318 This unusual character is included so you do not accidentally invent a symbol
3319 of the same name.  The character has ASCII value of @samp{\002} (control-B).
3321 @item @emph{ordinal number}
3322 This is a serial number to keep the labels distinct.  The first definition of
3323 @samp{0:} gets the number @samp{1}.  The 15th definition of @samp{0:} gets the 
3324 number @samp{15}, and so on.  Likewise the first definition of @samp{1:} gets
3325 the number @samp{1} and its 15th definition gets @samp{15} as well.
3326 @end table
3328 So for example, the first @code{1:} may be named @code{.L1@kbd{C-B}1}, and
3329 the 44th @code{3:} may be named @code{.L3@kbd{C-B}44}.
3331 @subheading Dollar Local Labels
3332 @cindex dollar local symbols
3334 @code{@value{AS}} also supports an even more local form of local labels called
3335 dollar labels.  These labels go out of scope (i.e., they become undefined) as
3336 soon as a non-local label is defined.  Thus they remain valid for only a small
3337 region of the input source code.  Normal local labels, by contrast, remain in
3338 scope for the entire file, or until they are redefined by another occurrence of
3339 the same local label.
3341 Dollar labels are defined in exactly the same way as ordinary local labels,
3342 except that instead of being terminated by a colon, they are terminated by a
3343 dollar sign, e.g., @samp{@b{55$}}.
3345 They can also be distinguished from ordinary local labels by their transformed
3346 names which use ASCII character @samp{\001} (control-A) as the magic character
3347 to distinguish them from ordinary labels.  For example, the fifth definition of
3348 @samp{6$} may be named @samp{.L6@kbd{C-A}5}.
3350 @node Dot
3351 @section The Special Dot Symbol
3353 @cindex dot (symbol)
3354 @cindex @code{.} (symbol)
3355 @cindex current address
3356 @cindex location counter
3357 The special symbol @samp{.} refers to the current address that
3358 @command{@value{AS}} is assembling into.  Thus, the expression @samp{melvin:
3359 .long .} defines @code{melvin} to contain its own address.
3360 Assigning a value to @code{.} is treated the same as a @code{.org}
3361 directive.  Thus, the expression @samp{.=.+4} is the same as saying
3362 @ifclear no-space-dir
3363 @samp{.space 4}.
3364 @end ifclear
3366 @node Symbol Attributes
3367 @section Symbol Attributes
3369 @cindex symbol attributes
3370 @cindex attributes, symbol
3371 Every symbol has, as well as its name, the attributes ``Value'' and
3372 ``Type''.  Depending on output format, symbols can also have auxiliary
3373 attributes.
3374 @ifset INTERNALS
3375 The detailed definitions are in @file{a.out.h}.
3376 @end ifset
3378 If you use a symbol without defining it, @command{@value{AS}} assumes zero for
3379 all these attributes, and probably won't warn you.  This makes the
3380 symbol an externally defined symbol, which is generally what you
3381 would want.
3383 @menu
3384 * Symbol Value::                Value
3385 * Symbol Type::                 Type
3386 @ifset aout-bout
3387 @ifset GENERIC
3388 * a.out Symbols::               Symbol Attributes: @code{a.out}
3389 @end ifset
3390 @ifclear GENERIC
3391 @ifclear BOUT
3392 * a.out Symbols::               Symbol Attributes: @code{a.out}
3393 @end ifclear
3394 @ifset BOUT
3395 * a.out Symbols::               Symbol Attributes: @code{a.out}, @code{b.out}
3396 @end ifset
3397 @end ifclear
3398 @end ifset
3399 @ifset COFF
3400 * COFF Symbols::                Symbol Attributes for COFF
3401 @end ifset
3402 @ifset SOM
3403 * SOM Symbols::                Symbol Attributes for SOM
3404 @end ifset
3405 @end menu
3407 @node Symbol Value
3408 @subsection Value
3410 @cindex value of a symbol
3411 @cindex symbol value
3412 The value of a symbol is (usually) 32 bits.  For a symbol which labels a
3413 location in the text, data, bss or absolute sections the value is the
3414 number of addresses from the start of that section to the label.
3415 Naturally for text, data and bss sections the value of a symbol changes
3416 as @code{@value{LD}} changes section base addresses during linking.  Absolute
3417 symbols' values do not change during linking: that is why they are
3418 called absolute.
3420 The value of an undefined symbol is treated in a special way.  If it is
3421 0 then the symbol is not defined in this assembler source file, and
3422 @code{@value{LD}} tries to determine its value from other files linked into the
3423 same program.  You make this kind of symbol simply by mentioning a symbol
3424 name without defining it.  A non-zero value represents a @code{.comm}
3425 common declaration.  The value is how much common storage to reserve, in
3426 bytes (addresses).  The symbol refers to the first address of the
3427 allocated storage.
3429 @node Symbol Type
3430 @subsection Type
3432 @cindex type of a symbol
3433 @cindex symbol type
3434 The type attribute of a symbol contains relocation (section)
3435 information, any flag settings indicating that a symbol is external, and
3436 (optionally), other information for linkers and debuggers.  The exact
3437 format depends on the object-code output format in use.
3439 @ifset aout-bout
3440 @ifclear GENERIC
3441 @ifset BOUT
3442 @c The following avoids a "widow" subsection title.  @group would be
3443 @c better if it were available outside examples.
3444 @need 1000
3445 @node a.out Symbols
3446 @subsection Symbol Attributes: @code{a.out}, @code{b.out}
3448 @cindex @code{b.out} symbol attributes
3449 @cindex symbol attributes, @code{b.out}
3450 These symbol attributes appear only when @command{@value{AS}} is configured for
3451 one of the Berkeley-descended object output formats---@code{a.out} or
3452 @code{b.out}.
3454 @end ifset
3455 @ifclear BOUT
3456 @node a.out Symbols
3457 @subsection Symbol Attributes: @code{a.out}
3459 @cindex @code{a.out} symbol attributes
3460 @cindex symbol attributes, @code{a.out}
3462 @end ifclear
3463 @end ifclear
3464 @ifset GENERIC
3465 @node a.out Symbols
3466 @subsection Symbol Attributes: @code{a.out}
3468 @cindex @code{a.out} symbol attributes
3469 @cindex symbol attributes, @code{a.out}
3471 @end ifset
3472 @menu
3473 * Symbol Desc::                 Descriptor
3474 * Symbol Other::                Other
3475 @end menu
3477 @node Symbol Desc
3478 @subsubsection Descriptor
3480 @cindex descriptor, of @code{a.out} symbol
3481 This is an arbitrary 16-bit value.  You may establish a symbol's
3482 descriptor value by using a @code{.desc} statement
3483 (@pxref{Desc,,@code{.desc}}).  A descriptor value means nothing to
3484 @command{@value{AS}}.
3486 @node Symbol Other
3487 @subsubsection Other
3489 @cindex other attribute, of @code{a.out} symbol
3490 This is an arbitrary 8-bit value.  It means nothing to @command{@value{AS}}.
3491 @end ifset
3493 @ifset COFF
3494 @node COFF Symbols
3495 @subsection Symbol Attributes for COFF
3497 @cindex COFF symbol attributes
3498 @cindex symbol attributes, COFF
3500 The COFF format supports a multitude of auxiliary symbol attributes;
3501 like the primary symbol attributes, they are set between @code{.def} and
3502 @code{.endef} directives.
3504 @subsubsection Primary Attributes
3506 @cindex primary attributes, COFF symbols
3507 The symbol name is set with @code{.def}; the value and type,
3508 respectively, with @code{.val} and @code{.type}.
3510 @subsubsection Auxiliary Attributes
3512 @cindex auxiliary attributes, COFF symbols
3513 The @command{@value{AS}} directives @code{.dim}, @code{.line}, @code{.scl},
3514 @code{.size}, @code{.tag}, and @code{.weak} can generate auxiliary symbol
3515 table information for COFF.
3516 @end ifset
3518 @ifset SOM
3519 @node SOM Symbols
3520 @subsection Symbol Attributes for SOM
3522 @cindex SOM symbol attributes
3523 @cindex symbol attributes, SOM
3525 The SOM format for the HPPA supports a multitude of symbol attributes set with
3526 the @code{.EXPORT} and @code{.IMPORT} directives.
3528 The attributes are described in @cite{HP9000 Series 800 Assembly 
3529 Language Reference Manual} (HP 92432-90001) under the @code{IMPORT} and
3530 @code{EXPORT} assembler directive documentation.
3531 @end ifset
3533 @node Expressions
3534 @chapter Expressions
3536 @cindex expressions
3537 @cindex addresses
3538 @cindex numeric values
3539 An @dfn{expression} specifies an address or numeric value.
3540 Whitespace may precede and/or follow an expression.
3542 The result of an expression must be an absolute number, or else an offset into
3543 a particular section.  If an expression is not absolute, and there is not
3544 enough information when @command{@value{AS}} sees the expression to know its
3545 section, a second pass over the source program might be necessary to interpret
3546 the expression---but the second pass is currently not implemented.
3547 @command{@value{AS}} aborts with an error message in this situation.
3549 @menu
3550 * Empty Exprs::                 Empty Expressions
3551 * Integer Exprs::               Integer Expressions
3552 @end menu
3554 @node Empty Exprs
3555 @section Empty Expressions
3557 @cindex empty expressions
3558 @cindex expressions, empty
3559 An empty expression has no value: it is just whitespace or null.
3560 Wherever an absolute expression is required, you may omit the
3561 expression, and @command{@value{AS}} assumes a value of (absolute) 0.  This
3562 is compatible with other assemblers.
3564 @node Integer Exprs
3565 @section Integer Expressions
3567 @cindex integer expressions
3568 @cindex expressions, integer
3569 An @dfn{integer expression} is one or more @emph{arguments} delimited
3570 by @emph{operators}.
3572 @menu
3573 * Arguments::                   Arguments
3574 * Operators::                   Operators
3575 * Prefix Ops::                  Prefix Operators
3576 * Infix Ops::                   Infix Operators
3577 @end menu
3579 @node Arguments
3580 @subsection Arguments
3582 @cindex expression arguments
3583 @cindex arguments in expressions
3584 @cindex operands in expressions
3585 @cindex arithmetic operands
3586 @dfn{Arguments} are symbols, numbers or subexpressions.  In other
3587 contexts arguments are sometimes called ``arithmetic operands''.  In
3588 this manual, to avoid confusing them with the ``instruction operands'' of
3589 the machine language, we use the term ``argument'' to refer to parts of
3590 expressions only, reserving the word ``operand'' to refer only to machine
3591 instruction operands.
3593 Symbols are evaluated to yield @{@var{section} @var{NNN}@} where
3594 @var{section} is one of text, data, bss, absolute,
3595 or undefined.  @var{NNN} is a signed, 2's complement 32 bit
3596 integer.
3598 Numbers are usually integers.
3600 A number can be a flonum or bignum.  In this case, you are warned
3601 that only the low order 32 bits are used, and @command{@value{AS}} pretends
3602 these 32 bits are an integer.  You may write integer-manipulating
3603 instructions that act on exotic constants, compatible with other
3604 assemblers.
3606 @cindex subexpressions
3607 Subexpressions are a left parenthesis @samp{(} followed by an integer
3608 expression, followed by a right parenthesis @samp{)}; or a prefix
3609 operator followed by an argument.
3611 @node Operators
3612 @subsection Operators
3614 @cindex operators, in expressions
3615 @cindex arithmetic functions
3616 @cindex functions, in expressions
3617 @dfn{Operators} are arithmetic functions, like @code{+} or @code{%}.  Prefix
3618 operators are followed by an argument.  Infix operators appear
3619 between their arguments.  Operators may be preceded and/or followed by
3620 whitespace.
3622 @node Prefix Ops
3623 @subsection Prefix Operator
3625 @cindex prefix operators
3626 @command{@value{AS}} has the following @dfn{prefix operators}.  They each take
3627 one argument, which must be absolute.
3629 @c the tex/end tex stuff surrounding this small table is meant to make
3630 @c it align, on the printed page, with the similar table in the next
3631 @c section (which is inside an enumerate).
3632 @tex
3633 \global\advance\leftskip by \itemindent
3634 @end tex
3636 @table @code
3637 @item -
3638 @dfn{Negation}.  Two's complement negation.
3639 @item ~
3640 @dfn{Complementation}.  Bitwise not.
3641 @end table
3643 @tex
3644 \global\advance\leftskip by -\itemindent
3645 @end tex
3647 @node Infix Ops
3648 @subsection Infix Operators
3650 @cindex infix operators
3651 @cindex operators, permitted arguments
3652 @dfn{Infix operators} take two arguments, one on either side.  Operators
3653 have precedence, but operations with equal precedence are performed left
3654 to right.  Apart from @code{+} or @option{-}, both arguments must be
3655 absolute, and the result is absolute.
3657 @enumerate
3658 @cindex operator precedence
3659 @cindex precedence of operators
3661 @item
3662 Highest Precedence
3664 @table @code
3665 @item *
3666 @dfn{Multiplication}.
3668 @item /
3669 @dfn{Division}.  Truncation is the same as the C operator @samp{/}
3671 @item %
3672 @dfn{Remainder}.
3674 @item <<
3675 @dfn{Shift Left}.  Same as the C operator @samp{<<}.
3677 @item >>
3678 @dfn{Shift Right}.  Same as the C operator @samp{>>}.
3679 @end table
3681 @item
3682 Intermediate precedence
3684 @table @code
3685 @item |
3687 @dfn{Bitwise Inclusive Or}.
3689 @item &
3690 @dfn{Bitwise And}.
3692 @item ^
3693 @dfn{Bitwise Exclusive Or}.
3695 @item !
3696 @dfn{Bitwise Or Not}.
3697 @end table
3699 @item
3700 Low Precedence
3702 @table @code
3703 @cindex addition, permitted arguments
3704 @cindex plus, permitted arguments
3705 @cindex arguments for addition
3706 @item +
3707 @dfn{Addition}.  If either argument is absolute, the result has the section of
3708 the other argument.  You may not add together arguments from different
3709 sections.
3711 @cindex subtraction, permitted arguments
3712 @cindex minus, permitted arguments
3713 @cindex arguments for subtraction
3714 @item -
3715 @dfn{Subtraction}.  If the right argument is absolute, the
3716 result has the section of the left argument.
3717 If both arguments are in the same section, the result is absolute.
3718 You may not subtract arguments from different sections.
3719 @c FIXME is there still something useful to say about undefined - undefined ?
3721 @cindex comparison expressions
3722 @cindex expressions, comparison
3723 @item  ==
3724 @dfn{Is Equal To}
3725 @item <>
3726 @itemx !=
3727 @dfn{Is Not Equal To}
3728 @item <
3729 @dfn{Is Less Than}
3730 @item >
3731 @dfn{Is Greater Than}
3732 @item >=
3733 @dfn{Is Greater Than Or Equal To}
3734 @item <=
3735 @dfn{Is Less Than Or Equal To}
3737 The comparison operators can be used as infix operators.  A true results has a
3738 value of -1 whereas a false result has a value of 0.   Note, these operators
3739 perform signed comparisons.
3740 @end table
3742 @item Lowest Precedence
3744 @table @code
3745 @item &&
3746 @dfn{Logical And}.
3748 @item ||
3749 @dfn{Logical Or}.
3751 These two logical operations can be used to combine the results of sub
3752 expressions.  Note, unlike the comparison operators a true result returns a
3753 value of 1 but a false results does still return 0.  Also note that the logical
3754 or operator has a slightly lower precedence than logical and.
3756 @end table
3757 @end enumerate
3759 In short, it's only meaningful to add or subtract the @emph{offsets} in an
3760 address; you can only have a defined section in one of the two arguments.
3762 @node Pseudo Ops
3763 @chapter Assembler Directives
3765 @cindex directives, machine independent
3766 @cindex pseudo-ops, machine independent
3767 @cindex machine independent directives
3768 All assembler directives have names that begin with a period (@samp{.}).
3769 The rest of the name is letters, usually in lower case.
3771 This chapter discusses directives that are available regardless of the
3772 target machine configuration for the @sc{gnu} assembler.
3773 @ifset GENERIC
3774 Some machine configurations provide additional directives.
3775 @xref{Machine Dependencies}.
3776 @end ifset
3777 @ifclear GENERIC
3778 @ifset machine-directives
3779 @xref{Machine Dependencies}, for additional directives.
3780 @end ifset
3781 @end ifclear
3783 @menu
3784 * Abort::                       @code{.abort}
3785 @ifset COFF
3786 * ABORT (COFF)::                @code{.ABORT}
3787 @end ifset
3789 * Align::                       @code{.align @var{abs-expr} , @var{abs-expr}}
3790 * Altmacro::                    @code{.altmacro}
3791 * Ascii::                       @code{.ascii "@var{string}"}@dots{}
3792 * Asciz::                       @code{.asciz "@var{string}"}@dots{}
3793 * Balign::                      @code{.balign @var{abs-expr} , @var{abs-expr}}
3794 * Byte::                        @code{.byte @var{expressions}}
3795 * Comm::                        @code{.comm @var{symbol} , @var{length} }
3797 * CFI directives::              @code{.cfi_startproc [simple]}, @code{.cfi_endproc}, etc.
3799 * Data::                        @code{.data @var{subsection}}
3800 @ifset COFF
3801 * Def::                         @code{.def @var{name}}
3802 @end ifset
3803 @ifset aout-bout
3804 * Desc::                        @code{.desc @var{symbol}, @var{abs-expression}}
3805 @end ifset
3806 @ifset COFF
3807 * Dim::                         @code{.dim}
3808 @end ifset
3810 * Double::                      @code{.double @var{flonums}}
3811 * Eject::                       @code{.eject}
3812 * Else::                        @code{.else}
3813 * Elseif::                      @code{.elseif}
3814 * End::                         @code{.end}
3815 @ifset COFF
3816 * Endef::                       @code{.endef}
3817 @end ifset
3819 * Endfunc::                     @code{.endfunc}
3820 * Endif::                       @code{.endif}
3821 * Equ::                         @code{.equ @var{symbol}, @var{expression}}
3822 * Equiv::                       @code{.equiv @var{symbol}, @var{expression}}
3823 * Eqv::                         @code{.eqv @var{symbol}, @var{expression}}
3824 * Err::                         @code{.err}
3825 * Error::                       @code{.error @var{string}}
3826 * Exitm::                       @code{.exitm}
3827 * Extern::                      @code{.extern}
3828 * Fail::                        @code{.fail}
3829 @ifclear no-file-dir
3830 * File::                        @code{.file @var{string}}
3831 @end ifclear
3833 * Fill::                        @code{.fill @var{repeat} , @var{size} , @var{value}}
3834 * Float::                       @code{.float @var{flonums}}
3835 * Func::                        @code{.func}  
3836 * Global::                      @code{.global @var{symbol}}, @code{.globl @var{symbol}}
3837 @ifset ELF
3838 * Gnu_attribute::               @code{.gnu_attribute @var{tag},@var{value}}
3839 * Hidden::                      @code{.hidden @var{names}}
3840 @end ifset
3842 * hword::                       @code{.hword @var{expressions}}
3843 * Ident::                       @code{.ident}
3844 * If::                          @code{.if @var{absolute expression}}
3845 * Incbin::                      @code{.incbin "@var{file}"[,@var{skip}[,@var{count}]]}
3846 * Include::                     @code{.include "@var{file}"}
3847 * Int::                         @code{.int @var{expressions}}
3848 @ifset ELF
3849 * Internal::                    @code{.internal @var{names}}
3850 @end ifset
3852 * Irp::                         @code{.irp @var{symbol},@var{values}}@dots{}
3853 * Irpc::                        @code{.irpc @var{symbol},@var{values}}@dots{}
3854 * Lcomm::                       @code{.lcomm @var{symbol} , @var{length}}
3855 * Lflags::                      @code{.lflags}
3856 @ifclear no-line-dir
3857 * Line::                        @code{.line @var{line-number}}
3858 @end ifclear
3860 * Linkonce::                    @code{.linkonce [@var{type}]}
3861 * List::                        @code{.list}
3862 * Ln::                          @code{.ln @var{line-number}}
3864 * LNS directives::              @code{.file}, @code{.loc}, etc.
3866 * Long::                        @code{.long @var{expressions}}
3867 @ignore
3868 * Lsym::                        @code{.lsym @var{symbol}, @var{expression}}
3869 @end ignore
3871 * Macro::                       @code{.macro @var{name} @var{args}}@dots{}
3872 * MRI::                         @code{.mri @var{val}}
3873 * Noaltmacro::                  @code{.noaltmacro}
3874 * Nolist::                      @code{.nolist}
3875 * Octa::                        @code{.octa @var{bignums}}
3876 * Org::                         @code{.org @var{new-lc}, @var{fill}}
3877 * P2align::                     @code{.p2align @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
3878 @ifset ELF
3879 * PopSection::                  @code{.popsection}
3880 * Previous::                    @code{.previous}
3881 @end ifset
3883 * Print::                       @code{.print @var{string}}
3884 @ifset ELF
3885 * Protected::                   @code{.protected @var{names}}
3886 @end ifset
3888 * Psize::                       @code{.psize @var{lines}, @var{columns}}
3889 * Purgem::                      @code{.purgem @var{name}}
3890 @ifset ELF
3891 * PushSection::                 @code{.pushsection @var{name}}
3892 @end ifset
3894 * Quad::                        @code{.quad @var{bignums}}
3895 * Reloc::                       @code{.reloc @var{offset}, @var{reloc_name}[, @var{expression}]}
3896 * Rept::                        @code{.rept @var{count}}
3897 * Sbttl::                       @code{.sbttl "@var{subheading}"}
3898 @ifset COFF
3899 * Scl::                         @code{.scl @var{class}}
3900 @end ifset
3901 @ifset COFF-ELF
3902 * Section::                     @code{.section @var{name}[, @var{flags}]}
3903 @end ifset
3905 * Set::                         @code{.set @var{symbol}, @var{expression}}
3906 * Short::                       @code{.short @var{expressions}}
3907 * Single::                      @code{.single @var{flonums}}
3908 @ifset COFF-ELF
3909 * Size::                        @code{.size [@var{name} , @var{expression}]}
3910 @end ifset
3912 * Skip::                        @code{.skip @var{size} , @var{fill}}
3913 * Sleb128::                     @code{.sleb128 @var{expressions}}
3914 * Space::                       @code{.space @var{size} , @var{fill}}
3915 @ifset have-stabs
3916 * Stab::                        @code{.stabd, .stabn, .stabs}
3917 @end ifset
3919 * String::                      @code{.string "@var{str}"}, @code{.string8 "@var{str}"}, @code{.string16 "@var{str}"}, @code{.string32 "@var{str}"}, @code{.string64 "@var{str}"}
3920 * Struct::                      @code{.struct @var{expression}}
3921 @ifset ELF
3922 * SubSection::                  @code{.subsection}
3923 * Symver::                      @code{.symver @var{name},@var{name2@@nodename}}
3924 @end ifset
3926 @ifset COFF
3927 * Tag::                         @code{.tag @var{structname}}
3928 @end ifset
3930 * Text::                        @code{.text @var{subsection}}
3931 * Title::                       @code{.title "@var{heading}"}
3932 @ifset COFF-ELF
3933 * Type::                        @code{.type <@var{int} | @var{name} , @var{type description}>}
3934 @end ifset
3936 * Uleb128::                     @code{.uleb128 @var{expressions}}
3937 @ifset COFF
3938 * Val::                         @code{.val @var{addr}}
3939 @end ifset
3941 @ifset ELF
3942 * Version::                     @code{.version "@var{string}"}
3943 * VTableEntry::                 @code{.vtable_entry @var{table}, @var{offset}}
3944 * VTableInherit::               @code{.vtable_inherit @var{child}, @var{parent}}
3945 @end ifset
3947 * Warning::                     @code{.warning @var{string}}
3948 * Weak::                        @code{.weak @var{names}}
3949 * Weakref::                     @code{.weakref @var{alias}, @var{symbol}}
3950 * Word::                        @code{.word @var{expressions}}
3951 * Deprecated::                  Deprecated Directives
3952 @end menu
3954 @node Abort
3955 @section @code{.abort}
3957 @cindex @code{abort} directive
3958 @cindex stopping the assembly
3959 This directive stops the assembly immediately.  It is for
3960 compatibility with other assemblers.  The original idea was that the
3961 assembly language source would be piped into the assembler.  If the sender
3962 of the source quit, it could use this directive tells @command{@value{AS}} to
3963 quit also.  One day @code{.abort} will not be supported.
3965 @ifset COFF
3966 @node ABORT (COFF)
3967 @section @code{.ABORT} (COFF)
3969 @cindex @code{ABORT} directive
3970 When producing COFF output, @command{@value{AS}} accepts this directive as a
3971 synonym for @samp{.abort}.
3973 @ifset BOUT
3974 When producing @code{b.out} output, @command{@value{AS}} accepts this directive,
3975 but ignores it.
3976 @end ifset
3977 @end ifset
3979 @node Align
3980 @section @code{.align @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
3982 @cindex padding the location counter
3983 @cindex @code{align} directive
3984 Pad the location counter (in the current subsection) to a particular storage
3985 boundary.  The first expression (which must be absolute) is the alignment
3986 required, as described below.
3988 The second expression (also absolute) gives the fill value to be stored in the
3989 padding bytes.  It (and the comma) may be omitted.  If it is omitted, the
3990 padding bytes are normally zero.  However, on some systems, if the section is
3991 marked as containing code and the fill value is omitted, the space is filled
3992 with no-op instructions.
3994 The third expression is also absolute, and is also optional.  If it is present,
3995 it is the maximum number of bytes that should be skipped by this alignment
3996 directive.  If doing the alignment would require skipping more bytes than the
3997 specified maximum, then the alignment is not done at all.  You can omit the
3998 fill value (the second argument) entirely by simply using two commas after the
3999 required alignment; this can be useful if you want the alignment to be filled
4000 with no-op instructions when appropriate.
4002 The way the required alignment is specified varies from system to system.
4003 For the arc, hppa, i386 using ELF, i860, iq2000, m68k, or32,
4004 s390, sparc, tic4x, tic80 and xtensa, the first expression is the
4005 alignment request in bytes.  For example @samp{.align 8} advances
4006 the location counter until it is a multiple of 8.  If the location counter
4007 is already a multiple of 8, no change is needed.  For the tic54x, the
4008 first expression is the alignment request in words.
4010 For other systems, including the i386 using a.out format, and the arm and
4011 strongarm, it is the
4012 number of low-order zero bits the location counter must have after
4013 advancement.  For example @samp{.align 3} advances the location
4014 counter until it a multiple of 8.  If the location counter is already a
4015 multiple of 8, no change is needed.
4017 This inconsistency is due to the different behaviors of the various
4018 native assemblers for these systems which GAS must emulate.
4019 GAS also provides @code{.balign} and @code{.p2align} directives,
4020 described later, which have a consistent behavior across all
4021 architectures (but are specific to GAS).
4023 @node Ascii
4024 @section @code{.ascii "@var{string}"}@dots{}
4026 @cindex @code{ascii} directive
4027 @cindex string literals
4028 @code{.ascii} expects zero or more string literals (@pxref{Strings})
4029 separated by commas.  It assembles each string (with no automatic
4030 trailing zero byte) into consecutive addresses.
4032 @node Asciz
4033 @section @code{.asciz "@var{string}"}@dots{}
4035 @cindex @code{asciz} directive
4036 @cindex zero-terminated strings
4037 @cindex null-terminated strings
4038 @code{.asciz} is just like @code{.ascii}, but each string is followed by
4039 a zero byte.  The ``z'' in @samp{.asciz} stands for ``zero''.
4041 @node Balign
4042 @section @code{.balign[wl] @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
4044 @cindex padding the location counter given number of bytes
4045 @cindex @code{balign} directive
4046 Pad the location counter (in the current subsection) to a particular
4047 storage boundary.  The first expression (which must be absolute) is the
4048 alignment request in bytes.  For example @samp{.balign 8} advances
4049 the location counter until it is a multiple of 8.  If the location counter
4050 is already a multiple of 8, no change is needed.
4052 The second expression (also absolute) gives the fill value to be stored in the
4053 padding bytes.  It (and the comma) may be omitted.  If it is omitted, the
4054 padding bytes are normally zero.  However, on some systems, if the section is
4055 marked as containing code and the fill value is omitted, the space is filled
4056 with no-op instructions.
4058 The third expression is also absolute, and is also optional.  If it is present,
4059 it is the maximum number of bytes that should be skipped by this alignment
4060 directive.  If doing the alignment would require skipping more bytes than the
4061 specified maximum, then the alignment is not done at all.  You can omit the
4062 fill value (the second argument) entirely by simply using two commas after the
4063 required alignment; this can be useful if you want the alignment to be filled
4064 with no-op instructions when appropriate.
4066 @cindex @code{balignw} directive
4067 @cindex @code{balignl} directive
4068 The @code{.balignw} and @code{.balignl} directives are variants of the
4069 @code{.balign} directive.  The @code{.balignw} directive treats the fill
4070 pattern as a two byte word value.  The @code{.balignl} directives treats the
4071 fill pattern as a four byte longword value.  For example, @code{.balignw
4072 4,0x368d} will align to a multiple of 4.  If it skips two bytes, they will be
4073 filled in with the value 0x368d (the exact placement of the bytes depends upon
4074 the endianness of the processor).  If it skips 1 or 3 bytes, the fill value is
4075 undefined.
4077 @node Byte
4078 @section @code{.byte @var{expressions}}
4080 @cindex @code{byte} directive
4081 @cindex integers, one byte
4082 @code{.byte} expects zero or more expressions, separated by commas.
4083 Each expression is assembled into the next byte.
4085 @node Comm
4086 @section @code{.comm @var{symbol} , @var{length} }
4088 @cindex @code{comm} directive
4089 @cindex symbol, common
4090 @code{.comm} declares a common symbol named @var{symbol}.  When linking, a
4091 common symbol in one object file may be merged with a defined or common symbol
4092 of the same name in another object file.  If @code{@value{LD}} does not see a
4093 definition for the symbol--just one or more common symbols--then it will
4094 allocate @var{length} bytes of uninitialized memory.  @var{length} must be an
4095 absolute expression.  If @code{@value{LD}} sees multiple common symbols with
4096 the same name, and they do not all have the same size, it will allocate space
4097 using the largest size.
4099 @ifset ELF
4100 When using ELF, the @code{.comm} directive takes an optional third argument.
4101 This is the desired alignment of the symbol, specified as a byte boundary (for
4102 example, an alignment of 16 means that the least significant 4 bits of the
4103 address should be zero).  The alignment must be an absolute expression, and it
4104 must be a power of two.  If @code{@value{LD}} allocates uninitialized memory
4105 for the common symbol, it will use the alignment when placing the symbol.  If
4106 no alignment is specified, @command{@value{AS}} will set the alignment to the
4107 largest power of two less than or equal to the size of the symbol, up to a
4108 maximum of 16.
4109 @end ifset
4111 @ifset HPPA
4112 The syntax for @code{.comm} differs slightly on the HPPA.  The syntax is
4113 @samp{@var{symbol} .comm, @var{length}}; @var{symbol} is optional.
4114 @end ifset
4116 @node CFI directives
4117 @section @code{.cfi_startproc [simple]}
4118 @cindex @code{cfi_startproc} directive
4119 @code{.cfi_startproc} is used at the beginning of each function that
4120 should have an entry in @code{.eh_frame}. It initializes some internal
4121 data structures. Don't forget to close the function by
4122 @code{.cfi_endproc}.
4124 Unless @code{.cfi_startproc} is used along with parameter @code{simple} 
4125 it also emits some architecture dependent initial CFI instructions.
4127 @section @code{.cfi_endproc}
4128 @cindex @code{cfi_endproc} directive
4129 @code{.cfi_endproc} is used at the end of a function where it closes its
4130 unwind entry previously opened by
4131 @code{.cfi_startproc}, and emits it to @code{.eh_frame}.
4133 @section @code{.cfi_personality @var{encoding} [, @var{exp}]}
4134 @code{.cfi_personality} defines personality routine and its encoding.
4135 @var{encoding} must be a constant determining how the personality
4136 should be encoded.  If it is 255 (@code{DW_EH_PE_omit}), second
4137 argument is not present, otherwise second argument should be
4138 a constant or a symbol name.  When using indirect encodings,
4139 the symbol provided should be the location where personality
4140 can be loaded from, not the personality routine itself.
4141 The default after @code{.cfi_startproc} is @code{.cfi_personality 0xff},
4142 no personality routine.
4144 @section @code{.cfi_lsda @var{encoding} [, @var{exp}]}
4145 @code{.cfi_lsda} defines LSDA and its encoding.
4146 @var{encoding} must be a constant determining how the LSDA
4147 should be encoded.  If it is 255 (@code{DW_EH_PE_omit}), second
4148 argument is not present, otherwise second argument should be a constant
4149 or a symbol name.  The default after @code{.cfi_startproc} is @code{.cfi_lsda 0xff},
4150 no LSDA.
4152 @section @code{.cfi_def_cfa @var{register}, @var{offset}}
4153 @code{.cfi_def_cfa} defines a rule for computing CFA as: @i{take 
4154 address from @var{register} and add @var{offset} to it}.
4156 @section @code{.cfi_def_cfa_register @var{register}}
4157 @code{.cfi_def_cfa_register} modifies a rule for computing CFA. From
4158 now on @var{register} will be used instead of the old one. Offset
4159 remains the same.
4161 @section @code{.cfi_def_cfa_offset @var{offset}}
4162 @code{.cfi_def_cfa_offset} modifies a rule for computing CFA. Register
4163 remains the same, but @var{offset} is new. Note that it is the
4164 absolute offset that will be added to a defined register to compute
4165 CFA address.
4167 @section @code{.cfi_adjust_cfa_offset @var{offset}}
4168 Same as @code{.cfi_def_cfa_offset} but @var{offset} is a relative
4169 value that is added/substracted from the previous offset.
4171 @section @code{.cfi_offset @var{register}, @var{offset}}
4172 Previous value of @var{register} is saved at offset @var{offset} from
4173 CFA. 
4175 @section @code{.cfi_rel_offset @var{register}, @var{offset}}
4176 Previous value of @var{register} is saved at offset @var{offset} from
4177 the current CFA register.  This is transformed to @code{.cfi_offset}
4178 using the known displacement of the CFA register from the CFA.
4179 This is often easier to use, because the number will match the
4180 code it's annotating.
4182 @section @code{.cfi_register @var{register1}, @var{register2}}
4183 Previous value of @var{register1} is saved in register @var{register2}.
4185 @section @code{.cfi_restore @var{register}}
4186 @code{.cfi_restore} says that the rule for @var{register} is now the 
4187 same as it was at the beginning of the function, after all initial 
4188 instruction added by @code{.cfi_startproc} were executed.
4190 @section @code{.cfi_undefined @var{register}}
4191 From now on the previous value of @var{register} can't be restored anymore.
4193 @section @code{.cfi_same_value @var{register}}
4194 Current value of @var{register} is the same like in the previous frame, 
4195 i.e. no restoration needed.
4197 @section @code{.cfi_remember_state}, 
4198 First save all current rules for all registers by @code{.cfi_remember_state}, 
4199 then totally screw them up by subsequent @code{.cfi_*} directives and when 
4200 everything is hopelessly bad, use @code{.cfi_restore_state} to restore 
4201 the previous saved state.
4203 @section @code{.cfi_return_column @var{register}}
4204 Change return column @var{register}, i.e. the return address is either 
4205 directly in @var{register} or can be accessed by rules for @var{register}.
4207 @section @code{.cfi_signal_frame}
4208 Mark current function as signal trampoline.
4210 @section @code{.cfi_window_save}
4211 SPARC register window has been saved.
4213 @section @code{.cfi_escape} @var{expression}[, @dots{}]
4214 Allows the user to add arbitrary bytes to the unwind info.  One
4215 might use this to add OS-specific CFI opcodes, or generic CFI
4216 opcodes that GAS does not yet support.
4218 @node LNS directives
4219 @section @code{.file @var{fileno} @var{filename}}
4220 @cindex @code{file} directive
4221 When emitting dwarf2 line number information @code{.file} assigns filenames
4222 to the @code{.debug_line} file name table.  The @var{fileno} operand should
4223 be a unique positive integer to use as the index of the entry in the table.
4224 The @var{filename} operand is a C string literal.
4226 The detail of filename indices is exposed to the user because the filename
4227 table is shared with the @code{.debug_info} section of the dwarf2 debugging
4228 information, and thus the user must know the exact indices that table
4229 entries will have.
4231 @section @code{.loc @var{fileno} @var{lineno} [@var{column}] [@var{options}]}
4232 @cindex @code{loc} directive
4233 The @code{.loc} directive will add row to the @code{.debug_line} line
4234 number matrix corresponding to the immediately following assembly
4235 instruction.  The @var{fileno}, @var{lineno}, and optional @var{column}
4236 arguments will be applied to the @code{.debug_line} state machine before
4237 the row is added.
4239 The @var{options} are a sequence of the following tokens in any order:
4241 @table @code
4242 @item basic_block
4243 This option will set the @code{basic_block} register in the
4244 @code{.debug_line} state machine to @code{true}.
4246 @item prologue_end
4247 This option will set the @code{prologue_end} register in the
4248 @code{.debug_line} state machine to @code{true}.
4250 @item epilogue_begin
4251 This option will set the @code{epilogue_begin} register in the
4252 @code{.debug_line} state machine to @code{true}.
4254 @item is_stmt @var{value}
4255 This option will set the @code{is_stmt} register in the
4256 @code{.debug_line} state machine to @code{value}, which must be 
4257 either 0 or 1.
4259 @item isa @var{value}
4260 This directive will set the @code{isa} register in the @code{.debug_line}
4261 state machine to @var{value}, which must be an unsigned integer.
4263 @end table
4265 @section @code{.loc_mark_labels @var{enable}}
4266 @cindex @code{loc_mark_labels} directive
4267 The @code{.loc_mark_labels} directive makes the assembler emit an entry
4268 to the @code{.debug_line} line number matrix with the @code{basic_block}
4269 register in the state machine set whenever a code label is seen.
4270 The @var{enable} argument should be either 1 or 0, to enable or disable
4271 this function respectively.
4273 @node Data
4274 @section @code{.data @var{subsection}}
4276 @cindex @code{data} directive
4277 @code{.data} tells @command{@value{AS}} to assemble the following statements onto the
4278 end of the data subsection numbered @var{subsection} (which is an
4279 absolute expression).  If @var{subsection} is omitted, it defaults
4280 to zero.
4282 @ifset COFF
4283 @node Def
4284 @section @code{.def @var{name}}
4286 @cindex @code{def} directive
4287 @cindex COFF symbols, debugging
4288 @cindex debugging COFF symbols
4289 Begin defining debugging information for a symbol @var{name}; the
4290 definition extends until the @code{.endef} directive is encountered.
4291 @ifset BOUT
4293 This directive is only observed when @command{@value{AS}} is configured for COFF
4294 format output; when producing @code{b.out}, @samp{.def} is recognized,
4295 but ignored.
4296 @end ifset
4297 @end ifset
4299 @ifset aout-bout
4300 @node Desc
4301 @section @code{.desc @var{symbol}, @var{abs-expression}}
4303 @cindex @code{desc} directive
4304 @cindex COFF symbol descriptor
4305 @cindex symbol descriptor, COFF
4306 This directive sets the descriptor of the symbol (@pxref{Symbol Attributes})
4307 to the low 16 bits of an absolute expression.
4309 @ifset COFF
4310 The @samp{.desc} directive is not available when @command{@value{AS}} is
4311 configured for COFF output; it is only for @code{a.out} or @code{b.out}
4312 object format.  For the sake of compatibility, @command{@value{AS}} accepts
4313 it, but produces no output, when configured for COFF.
4314 @end ifset
4315 @end ifset
4317 @ifset COFF
4318 @node Dim
4319 @section @code{.dim}
4321 @cindex @code{dim} directive
4322 @cindex COFF auxiliary symbol information
4323 @cindex auxiliary symbol information, COFF
4324 This directive is generated by compilers to include auxiliary debugging
4325 information in the symbol table.  It is only permitted inside
4326 @code{.def}/@code{.endef} pairs.
4327 @ifset BOUT
4329 @samp{.dim} is only meaningful when generating COFF format output; when
4330 @command{@value{AS}} is generating @code{b.out}, it accepts this directive but
4331 ignores it.
4332 @end ifset
4333 @end ifset
4335 @node Double
4336 @section @code{.double @var{flonums}}
4338 @cindex @code{double} directive
4339 @cindex floating point numbers (double)
4340 @code{.double} expects zero or more flonums, separated by commas.  It
4341 assembles floating point numbers.
4342 @ifset GENERIC
4343 The exact kind of floating point numbers emitted depends on how
4344 @command{@value{AS}} is configured.  @xref{Machine Dependencies}.
4345 @end ifset
4346 @ifclear GENERIC
4347 @ifset IEEEFLOAT
4348 On the @value{TARGET} family @samp{.double} emits 64-bit floating-point numbers
4349 in @sc{ieee} format.
4350 @end ifset
4351 @end ifclear
4353 @node Eject
4354 @section @code{.eject}
4356 @cindex @code{eject} directive
4357 @cindex new page, in listings
4358 @cindex page, in listings
4359 @cindex listing control: new page
4360 Force a page break at this point, when generating assembly listings.
4362 @node Else
4363 @section @code{.else}
4365 @cindex @code{else} directive
4366 @code{.else} is part of the @command{@value{AS}} support for conditional
4367 assembly; see @ref{If,,@code{.if}}.  It marks the beginning of a section
4368 of code to be assembled if the condition for the preceding @code{.if}
4369 was false.
4371 @node Elseif
4372 @section @code{.elseif}
4374 @cindex @code{elseif} directive
4375 @code{.elseif} is part of the @command{@value{AS}} support for conditional
4376 assembly; see @ref{If,,@code{.if}}.  It is shorthand for beginning a new
4377 @code{.if} block that would otherwise fill the entire @code{.else} section.
4379 @node End
4380 @section @code{.end}
4382 @cindex @code{end} directive
4383 @code{.end} marks the end of the assembly file.  @command{@value{AS}} does not
4384 process anything in the file past the @code{.end} directive.
4386 @ifset COFF
4387 @node Endef
4388 @section @code{.endef}
4390 @cindex @code{endef} directive
4391 This directive flags the end of a symbol definition begun with
4392 @code{.def}.
4393 @ifset BOUT
4395 @samp{.endef} is only meaningful when generating COFF format output; if
4396 @command{@value{AS}} is configured to generate @code{b.out}, it accepts this
4397 directive but ignores it.
4398 @end ifset
4399 @end ifset
4401 @node Endfunc
4402 @section @code{.endfunc}
4403 @cindex @code{endfunc} directive
4404 @code{.endfunc} marks the end of a function specified with @code{.func}.
4406 @node Endif
4407 @section @code{.endif}
4409 @cindex @code{endif} directive
4410 @code{.endif} is part of the @command{@value{AS}} support for conditional assembly;
4411 it marks the end of a block of code that is only assembled
4412 conditionally.  @xref{If,,@code{.if}}.
4414 @node Equ
4415 @section @code{.equ @var{symbol}, @var{expression}}
4417 @cindex @code{equ} directive
4418 @cindex assigning values to symbols
4419 @cindex symbols, assigning values to
4420 This directive sets the value of @var{symbol} to @var{expression}.
4421 It is synonymous with @samp{.set}; see @ref{Set,,@code{.set}}.
4423 @ifset HPPA
4424 The syntax for @code{equ} on the HPPA is 
4425 @samp{@var{symbol} .equ @var{expression}}.
4426 @end ifset
4428 @ifset Z80
4429 The syntax for @code{equ} on the Z80 is 
4430 @samp{@var{symbol} equ @var{expression}}. 
4431 On the Z80 it is an eror if @var{symbol} is already defined,
4432 but the symbol is not protected from later redefinition. 
4433 Compare @ref{Equiv}.
4434 @end ifset
4436 @node Equiv
4437 @section @code{.equiv @var{symbol}, @var{expression}}
4438 @cindex @code{equiv} directive
4439 The @code{.equiv} directive is like @code{.equ} and @code{.set}, except that
4440 the assembler will signal an error if @var{symbol} is already defined.  Note a
4441 symbol which has been referenced but not actually defined is considered to be
4442 undefined.
4444 Except for the contents of the error message, this is roughly equivalent to 
4445 @smallexample
4446 .ifdef SYM
4447 .err
4448 .endif
4449 .equ SYM,VAL
4450 @end smallexample
4451 plus it protects the symbol from later redefinition.
4453 @node Eqv
4454 @section @code{.eqv @var{symbol}, @var{expression}}
4455 @cindex @code{eqv} directive
4456 The @code{.eqv} directive is like @code{.equiv}, but no attempt is made to
4457 evaluate the expression or any part of it immediately.  Instead each time
4458 the resulting symbol is used in an expression, a snapshot of its current
4459 value is taken.
4461 @node Err
4462 @section @code{.err}
4463 @cindex @code{err} directive
4464 If @command{@value{AS}} assembles a @code{.err} directive, it will print an error
4465 message and, unless the @option{-Z} option was used, it will not generate an
4466 object file.  This can be used to signal an error in conditionally compiled code.
4468 @node Error
4469 @section @code{.error "@var{string}"}
4470 @cindex error directive
4472 Similarly to @code{.err}, this directive emits an error, but you can specify a
4473 string that will be emitted as the error message.  If you don't specify the
4474 message, it defaults to @code{".error directive invoked in source file"}.
4475 @xref{Errors, ,Error and Warning Messages}.
4477 @smallexample
4478  .error "This code has not been assembled and tested."
4479 @end smallexample
4481 @node Exitm
4482 @section @code{.exitm}
4483 Exit early from the current macro definition.  @xref{Macro}.
4485 @node Extern
4486 @section @code{.extern}
4488 @cindex @code{extern} directive
4489 @code{.extern} is accepted in the source program---for compatibility
4490 with other assemblers---but it is ignored.  @command{@value{AS}} treats
4491 all undefined symbols as external.
4493 @node Fail
4494 @section @code{.fail @var{expression}}
4496 @cindex @code{fail} directive
4497 Generates an error or a warning.  If the value of the @var{expression} is 500
4498 or more, @command{@value{AS}} will print a warning message.  If the value is less
4499 than 500, @command{@value{AS}} will print an error message.  The message will
4500 include the value of @var{expression}.  This can occasionally be useful inside
4501 complex nested macros or conditional assembly.
4503 @ifclear no-file-dir
4504 @node File
4505 @section @code{.file @var{string}}
4507 @cindex @code{file} directive
4508 @cindex logical file name
4509 @cindex file name, logical
4510 @code{.file} tells @command{@value{AS}} that we are about to start a new logical
4511 file.  @var{string} is the new file name.  In general, the filename is
4512 recognized whether or not it is surrounded by quotes @samp{"}; but if you wish
4513 to specify an empty file name, you must give the quotes--@code{""}.  This
4514 statement may go away in future: it is only recognized to be compatible with
4515 old @command{@value{AS}} programs.
4516 @end ifclear
4518 @node Fill
4519 @section @code{.fill @var{repeat} , @var{size} , @var{value}}
4521 @cindex @code{fill} directive
4522 @cindex writing patterns in memory
4523 @cindex patterns, writing in memory
4524 @var{repeat}, @var{size} and @var{value} are absolute expressions.
4525 This emits @var{repeat} copies of @var{size} bytes.  @var{Repeat}
4526 may be zero or more.  @var{Size} may be zero or more, but if it is
4527 more than 8, then it is deemed to have the value 8, compatible with
4528 other people's assemblers.  The contents of each @var{repeat} bytes
4529 is taken from an 8-byte number.  The highest order 4 bytes are
4530 zero.  The lowest order 4 bytes are @var{value} rendered in the
4531 byte-order of an integer on the computer @command{@value{AS}} is assembling for.
4532 Each @var{size} bytes in a repetition is taken from the lowest order
4533 @var{size} bytes of this number.  Again, this bizarre behavior is
4534 compatible with other people's assemblers.
4536 @var{size} and @var{value} are optional.
4537 If the second comma and @var{value} are absent, @var{value} is
4538 assumed zero.  If the first comma and following tokens are absent,
4539 @var{size} is assumed to be 1.
4541 @node Float
4542 @section @code{.float @var{flonums}}
4544 @cindex floating point numbers (single)
4545 @cindex @code{float} directive
4546 This directive assembles zero or more flonums, separated by commas.  It
4547 has the same effect as @code{.single}.
4548 @ifset GENERIC
4549 The exact kind of floating point numbers emitted depends on how
4550 @command{@value{AS}} is configured.
4551 @xref{Machine Dependencies}.
4552 @end ifset
4553 @ifclear GENERIC
4554 @ifset IEEEFLOAT
4555 On the @value{TARGET} family, @code{.float} emits 32-bit floating point numbers
4556 in @sc{ieee} format.
4557 @end ifset
4558 @end ifclear
4560 @node Func
4561 @section @code{.func @var{name}[,@var{label}]}
4562 @cindex @code{func} directive
4563 @code{.func} emits debugging information to denote function @var{name}, and
4564 is ignored unless the file is assembled with debugging enabled.
4565 Only @samp{--gstabs[+]} is currently supported.
4566 @var{label} is the entry point of the function and if omitted @var{name}
4567 prepended with the @samp{leading char} is used.
4568 @samp{leading char} is usually @code{_} or nothing, depending on the target.
4569 All functions are currently defined to have @code{void} return type.
4570 The function must be terminated with @code{.endfunc}.
4572 @node Global
4573 @section @code{.global @var{symbol}}, @code{.globl @var{symbol}}
4575 @cindex @code{global} directive
4576 @cindex symbol, making visible to linker
4577 @code{.global} makes the symbol visible to @code{@value{LD}}.  If you define
4578 @var{symbol} in your partial program, its value is made available to
4579 other partial programs that are linked with it.  Otherwise,
4580 @var{symbol} takes its attributes from a symbol of the same name
4581 from another file linked into the same program.
4583 Both spellings (@samp{.globl} and @samp{.global}) are accepted, for
4584 compatibility with other assemblers.
4586 @ifset HPPA
4587 On the HPPA, @code{.global} is not always enough to make it accessible to other
4588 partial programs.  You may need the HPPA-only @code{.EXPORT} directive as well.
4589 @xref{HPPA Directives, ,HPPA Assembler Directives}.
4590 @end ifset
4592 @ifset ELF
4593 @node Gnu_attribute
4594 @section @code{.gnu_attribute @var{tag},@var{value}}
4595 Record a @sc{gnu} object attribute for this file.  @xref{Object Attributes}.
4597 @node Hidden
4598 @section @code{.hidden @var{names}}
4600 @cindex @code{hidden} directive
4601 @cindex visibility
4602 This is one of the ELF visibility directives.  The other two are
4603 @code{.internal} (@pxref{Internal,,@code{.internal}}) and 
4604 @code{.protected} (@pxref{Protected,,@code{.protected}}).
4606 This directive overrides the named symbols default visibility (which is set by
4607 their binding: local, global or weak).  The directive sets the visibility to
4608 @code{hidden} which means that the symbols are not visible to other components.
4609 Such symbols are always considered to be @code{protected} as well. 
4610 @end ifset
4612 @node hword
4613 @section @code{.hword @var{expressions}}
4615 @cindex @code{hword} directive
4616 @cindex integers, 16-bit
4617 @cindex numbers, 16-bit
4618 @cindex sixteen bit integers
4619 This expects zero or more @var{expressions}, and emits
4620 a 16 bit number for each.
4622 @ifset GENERIC
4623 This directive is a synonym for @samp{.short}; depending on the target
4624 architecture, it may also be a synonym for @samp{.word}.
4625 @end ifset
4626 @ifclear GENERIC
4627 @ifset W32
4628 This directive is a synonym for @samp{.short}.
4629 @end ifset
4630 @ifset W16
4631 This directive is a synonym for both @samp{.short} and @samp{.word}.
4632 @end ifset
4633 @end ifclear
4635 @node Ident
4636 @section @code{.ident}
4638 @cindex @code{ident} directive
4640 This directive is used by some assemblers to place tags in object files.  The
4641 behavior of this directive varies depending on the target.  When using the
4642 a.out object file format, @command{@value{AS}} simply accepts the directive for
4643 source-file compatibility with existing assemblers, but does not emit anything
4644 for it.  When using COFF, comments are emitted to the @code{.comment} or
4645 @code{.rdata} section, depending on the target.  When using ELF, comments are
4646 emitted to the @code{.comment} section.
4648 @node If
4649 @section @code{.if @var{absolute expression}}
4651 @cindex conditional assembly
4652 @cindex @code{if} directive
4653 @code{.if} marks the beginning of a section of code which is only
4654 considered part of the source program being assembled if the argument
4655 (which must be an @var{absolute expression}) is non-zero.  The end of
4656 the conditional section of code must be marked by @code{.endif}
4657 (@pxref{Endif,,@code{.endif}}); optionally, you may include code for the
4658 alternative condition, flagged by @code{.else} (@pxref{Else,,@code{.else}}).
4659 If you have several conditions to check, @code{.elseif} may be used to avoid
4660 nesting blocks if/else within each subsequent @code{.else} block.
4662 The following variants of @code{.if} are also supported:
4663 @table @code
4664 @cindex @code{ifdef} directive
4665 @item .ifdef @var{symbol}
4666 Assembles the following section of code if the specified @var{symbol}
4667 has been defined.  Note a symbol which has been referenced but not yet defined
4668 is considered to be undefined.
4670 @cindex @code{ifb} directive
4671 @item .ifb @var{text}
4672 Assembles the following section of code if the operand is blank (empty).
4674 @cindex @code{ifc} directive
4675 @item .ifc @var{string1},@var{string2}
4676 Assembles the following section of code if the two strings are the same.  The
4677 strings may be optionally quoted with single quotes.  If they are not quoted,
4678 the first string stops at the first comma, and the second string stops at the
4679 end of the line.  Strings which contain whitespace should be quoted.  The
4680 string comparison is case sensitive.
4682 @cindex @code{ifeq} directive
4683 @item .ifeq @var{absolute expression}
4684 Assembles the following section of code if the argument is zero.
4686 @cindex @code{ifeqs} directive
4687 @item .ifeqs @var{string1},@var{string2}
4688 Another form of @code{.ifc}.  The strings must be quoted using double quotes.
4690 @cindex @code{ifge} directive
4691 @item .ifge @var{absolute expression}
4692 Assembles the following section of code if the argument is greater than or
4693 equal to zero.
4695 @cindex @code{ifgt} directive
4696 @item .ifgt @var{absolute expression}
4697 Assembles the following section of code if the argument is greater than zero.
4699 @cindex @code{ifle} directive
4700 @item .ifle @var{absolute expression}
4701 Assembles the following section of code if the argument is less than or equal
4702 to zero.
4704 @cindex @code{iflt} directive
4705 @item .iflt @var{absolute expression}
4706 Assembles the following section of code if the argument is less than zero.
4708 @cindex @code{ifnb} directive
4709 @item .ifnb @var{text}
4710 Like @code{.ifb}, but the sense of the test is reversed: this assembles the
4711 following section of code if the operand is non-blank (non-empty).
4713 @cindex @code{ifnc} directive
4714 @item .ifnc @var{string1},@var{string2}.
4715 Like @code{.ifc}, but the sense of the test is reversed: this assembles the
4716 following section of code if the two strings are not the same.
4718 @cindex @code{ifndef} directive
4719 @cindex @code{ifnotdef} directive
4720 @item .ifndef @var{symbol}
4721 @itemx .ifnotdef @var{symbol}
4722 Assembles the following section of code if the specified @var{symbol}
4723 has not been defined.  Both spelling variants are equivalent.  Note a symbol
4724 which has been referenced but not yet defined is considered to be undefined.
4726 @cindex @code{ifne} directive
4727 @item .ifne @var{absolute expression}
4728 Assembles the following section of code if the argument is not equal to zero
4729 (in other words, this is equivalent to @code{.if}).
4731 @cindex @code{ifnes} directive
4732 @item .ifnes @var{string1},@var{string2}
4733 Like @code{.ifeqs}, but the sense of the test is reversed: this assembles the
4734 following section of code if the two strings are not the same.
4735 @end table
4737 @node Incbin
4738 @section @code{.incbin "@var{file}"[,@var{skip}[,@var{count}]]}
4740 @cindex @code{incbin} directive
4741 @cindex binary files, including
4742 The @code{incbin} directive includes @var{file} verbatim at the current
4743 location. You can control the search paths used with the @samp{-I} command-line
4744 option (@pxref{Invoking,,Command-Line Options}).  Quotation marks are required
4745 around @var{file}.
4747 The @var{skip} argument skips a number of bytes from the start of the
4748 @var{file}.  The @var{count} argument indicates the maximum number of bytes to
4749 read.  Note that the data is not aligned in any way, so it is the user's
4750 responsibility to make sure that proper alignment is provided both before and
4751 after the @code{incbin} directive.
4753 @node Include
4754 @section @code{.include "@var{file}"}
4756 @cindex @code{include} directive
4757 @cindex supporting files, including
4758 @cindex files, including
4759 This directive provides a way to include supporting files at specified
4760 points in your source program.  The code from @var{file} is assembled as
4761 if it followed the point of the @code{.include}; when the end of the
4762 included file is reached, assembly of the original file continues.  You
4763 can control the search paths used with the @samp{-I} command-line option
4764 (@pxref{Invoking,,Command-Line Options}).  Quotation marks are required
4765 around @var{file}.
4767 @node Int
4768 @section @code{.int @var{expressions}}
4770 @cindex @code{int} directive
4771 @cindex integers, 32-bit
4772 Expect zero or more @var{expressions}, of any section, separated by commas.
4773 For each expression, emit a number that, at run time, is the value of that
4774 expression.  The byte order and bit size of the number depends on what kind
4775 of target the assembly is for.
4777 @ifclear GENERIC
4778 @ifset H8
4779 On most forms of the H8/300, @code{.int} emits 16-bit
4780 integers.  On the H8/300H and the Renesas SH, however, @code{.int} emits
4781 32-bit integers.
4782 @end ifset
4783 @end ifclear
4785 @ifset ELF
4786 @node Internal
4787 @section @code{.internal @var{names}}
4789 @cindex @code{internal} directive
4790 @cindex visibility
4791 This is one of the ELF visibility directives.  The other two are
4792 @code{.hidden} (@pxref{Hidden,,@code{.hidden}}) and 
4793 @code{.protected} (@pxref{Protected,,@code{.protected}}).
4795 This directive overrides the named symbols default visibility (which is set by
4796 their binding: local, global or weak).  The directive sets the visibility to
4797 @code{internal} which means that the symbols are considered to be @code{hidden}
4798 (i.e., not visible to other components), and that some extra, processor specific
4799 processing must also be performed upon the  symbols as well.
4800 @end ifset
4802 @node Irp
4803 @section @code{.irp @var{symbol},@var{values}}@dots{}
4805 @cindex @code{irp} directive
4806 Evaluate a sequence of statements assigning different values to @var{symbol}.
4807 The sequence of statements starts at the @code{.irp} directive, and is
4808 terminated by an @code{.endr} directive.  For each @var{value}, @var{symbol} is
4809 set to @var{value}, and the sequence of statements is assembled.  If no
4810 @var{value} is listed, the sequence of statements is assembled once, with
4811 @var{symbol} set to the null string.  To refer to @var{symbol} within the
4812 sequence of statements, use @var{\symbol}.
4814 For example, assembling
4816 @example
4817         .irp    param,1,2,3
4818         move    d\param,sp@@-
4819         .endr
4820 @end example
4822 is equivalent to assembling
4824 @example
4825         move    d1,sp@@-
4826         move    d2,sp@@-
4827         move    d3,sp@@-
4828 @end example
4830 For some caveats with the spelling of @var{symbol}, see also @ref{Macro}.
4832 @node Irpc
4833 @section @code{.irpc @var{symbol},@var{values}}@dots{}
4835 @cindex @code{irpc} directive
4836 Evaluate a sequence of statements assigning different values to @var{symbol}.
4837 The sequence of statements starts at the @code{.irpc} directive, and is
4838 terminated by an @code{.endr} directive.  For each character in @var{value},
4839 @var{symbol} is set to the character, and the sequence of statements is
4840 assembled.  If no @var{value} is listed, the sequence of statements is
4841 assembled once, with @var{symbol} set to the null string.  To refer to
4842 @var{symbol} within the sequence of statements, use @var{\symbol}.
4844 For example, assembling
4846 @example
4847         .irpc    param,123
4848         move    d\param,sp@@-
4849         .endr
4850 @end example
4852 is equivalent to assembling
4854 @example
4855         move    d1,sp@@-
4856         move    d2,sp@@-
4857         move    d3,sp@@-
4858 @end example
4860 For some caveats with the spelling of @var{symbol}, see also the discussion
4861 at @xref{Macro}.
4863 @node Lcomm
4864 @section @code{.lcomm @var{symbol} , @var{length}}
4866 @cindex @code{lcomm} directive
4867 @cindex local common symbols
4868 @cindex symbols, local common
4869 Reserve @var{length} (an absolute expression) bytes for a local common
4870 denoted by @var{symbol}.  The section and value of @var{symbol} are
4871 those of the new local common.  The addresses are allocated in the bss
4872 section, so that at run-time the bytes start off zeroed.  @var{Symbol}
4873 is not declared global (@pxref{Global,,@code{.global}}), so is normally
4874 not visible to @code{@value{LD}}.
4876 @ifset GENERIC
4877 Some targets permit a third argument to be used with @code{.lcomm}.  This
4878 argument specifies the desired alignment of the symbol in the bss section.
4879 @end ifset
4881 @ifset HPPA
4882 The syntax for @code{.lcomm} differs slightly on the HPPA.  The syntax is
4883 @samp{@var{symbol} .lcomm, @var{length}}; @var{symbol} is optional.
4884 @end ifset
4886 @node Lflags
4887 @section @code{.lflags}
4889 @cindex @code{lflags} directive (ignored)
4890 @command{@value{AS}} accepts this directive, for compatibility with other
4891 assemblers, but ignores it.
4893 @ifclear no-line-dir
4894 @node Line
4895 @section @code{.line @var{line-number}}
4897 @cindex @code{line} directive
4898 @end ifclear
4899 @ifset no-line-dir
4900 @node Ln
4901 @section @code{.ln @var{line-number}}
4903 @cindex @code{ln} directive
4904 @end ifset
4905 @cindex logical line number
4906 @ifset aout-bout
4907 Change the logical line number.  @var{line-number} must be an absolute
4908 expression.  The next line has that logical line number.  Therefore any other
4909 statements on the current line (after a statement separator character) are
4910 reported as on logical line number @var{line-number} @minus{} 1.  One day
4911 @command{@value{AS}} will no longer support this directive: it is recognized only
4912 for compatibility with existing assembler programs.
4914 @end ifset
4916 @ifclear no-line-dir
4917 Even though this is a directive associated with the @code{a.out} or
4918 @code{b.out} object-code formats, @command{@value{AS}} still recognizes it
4919 when producing COFF output, and treats @samp{.line} as though it
4920 were the COFF @samp{.ln} @emph{if} it is found outside a
4921 @code{.def}/@code{.endef} pair.
4923 Inside a @code{.def}, @samp{.line} is, instead, one of the directives
4924 used by compilers to generate auxiliary symbol information for
4925 debugging.
4926 @end ifclear
4928 @node Linkonce
4929 @section @code{.linkonce [@var{type}]}
4930 @cindex COMDAT
4931 @cindex @code{linkonce} directive
4932 @cindex common sections
4933 Mark the current section so that the linker only includes a single copy of it.
4934 This may be used to include the same section in several different object files,
4935 but ensure that the linker will only include it once in the final output file.
4936 The @code{.linkonce} pseudo-op must be used for each instance of the section.
4937 Duplicate sections are detected based on the section name, so it should be
4938 unique.
4940 This directive is only supported by a few object file formats; as of this
4941 writing, the only object file format which supports it is the Portable
4942 Executable format used on Windows NT.
4944 The @var{type} argument is optional.  If specified, it must be one of the
4945 following strings.  For example:
4946 @smallexample
4947 .linkonce same_size
4948 @end smallexample
4949 Not all types may be supported on all object file formats.
4951 @table @code
4952 @item discard
4953 Silently discard duplicate sections.  This is the default.
4955 @item one_only
4956 Warn if there are duplicate sections, but still keep only one copy.
4958 @item same_size
4959 Warn if any of the duplicates have different sizes.
4961 @item same_contents
4962 Warn if any of the duplicates do not have exactly the same contents.
4963 @end table
4965 @node Ln
4966 @section @code{.ln @var{line-number}}
4968 @cindex @code{ln} directive
4969 @ifclear no-line-dir
4970 @samp{.ln} is a synonym for @samp{.line}.
4971 @end ifclear
4972 @ifset no-line-dir
4973 Tell @command{@value{AS}} to change the logical line number.  @var{line-number}
4974 must be an absolute expression.  The next line has that logical
4975 line number, so any other statements on the current line (after a
4976 statement separator character @code{;}) are reported as on logical
4977 line number @var{line-number} @minus{} 1.
4978 @ifset BOUT
4980 This directive is accepted, but ignored, when @command{@value{AS}} is
4981 configured for @code{b.out}; its effect is only associated with COFF
4982 output format.
4983 @end ifset
4984 @end ifset
4986 @node MRI
4987 @section @code{.mri @var{val}}
4989 @cindex @code{mri} directive
4990 @cindex MRI mode, temporarily
4991 If @var{val} is non-zero, this tells @command{@value{AS}} to enter MRI mode.  If
4992 @var{val} is zero, this tells @command{@value{AS}} to exit MRI mode.  This change
4993 affects code assembled until the next @code{.mri} directive, or until the end
4994 of the file.  @xref{M, MRI mode, MRI mode}.
4996 @node List
4997 @section @code{.list}
4999 @cindex @code{list} directive
5000 @cindex listing control, turning on
5001 Control (in conjunction with the @code{.nolist} directive) whether or
5002 not assembly listings are generated.  These two directives maintain an
5003 internal counter (which is zero initially).   @code{.list} increments the
5004 counter, and @code{.nolist} decrements it.  Assembly listings are
5005 generated whenever the counter is greater than zero.
5007 By default, listings are disabled.  When you enable them (with the
5008 @samp{-a} command line option; @pxref{Invoking,,Command-Line Options}),
5009 the initial value of the listing counter is one.
5011 @node Long
5012 @section @code{.long @var{expressions}}
5014 @cindex @code{long} directive
5015 @code{.long} is the same as @samp{.int}.  @xref{Int,,@code{.int}}.
5017 @ignore
5018 @c no one seems to know what this is for or whether this description is
5019 @c what it really ought to do
5020 @node Lsym
5021 @section @code{.lsym @var{symbol}, @var{expression}}
5023 @cindex @code{lsym} directive
5024 @cindex symbol, not referenced in assembly
5025 @code{.lsym} creates a new symbol named @var{symbol}, but does not put it in
5026 the hash table, ensuring it cannot be referenced by name during the
5027 rest of the assembly.  This sets the attributes of the symbol to be
5028 the same as the expression value:
5029 @smallexample
5030 @var{other} = @var{descriptor} = 0
5031 @var{type} = @r{(section of @var{expression})}
5032 @var{value} = @var{expression}
5033 @end smallexample
5034 @noindent
5035 The new symbol is not flagged as external.
5036 @end ignore
5038 @node Macro
5039 @section @code{.macro}
5041 @cindex macros
5042 The commands @code{.macro} and @code{.endm} allow you to define macros that
5043 generate assembly output.  For example, this definition specifies a macro
5044 @code{sum} that puts a sequence of numbers into memory:
5046 @example
5047         .macro  sum from=0, to=5
5048         .long   \from
5049         .if     \to-\from
5050         sum     "(\from+1)",\to
5051         .endif
5052         .endm
5053 @end example
5055 @noindent
5056 With that definition, @samp{SUM 0,5} is equivalent to this assembly input:
5058 @example
5059         .long   0
5060         .long   1
5061         .long   2
5062         .long   3
5063         .long   4
5064         .long   5
5065 @end example
5067 @ftable @code
5068 @item .macro @var{macname}
5069 @itemx .macro @var{macname} @var{macargs} @dots{}
5070 @cindex @code{macro} directive
5071 Begin the definition of a macro called @var{macname}.  If your macro
5072 definition requires arguments, specify their names after the macro name,
5073 separated by commas or spaces.  You can qualify the macro argument to
5074 indicate whether all invocations must specify a non-blank value (through
5075 @samp{:@code{req}}), or whether it takes all of the remaining arguments
5076 (through @samp{:@code{vararg}}).  You can supply a default value for any
5077 macro argument by following the name with @samp{=@var{deflt}}.  You
5078 cannot define two macros with the same @var{macname} unless it has been
5079 subject to the @code{.purgem} directive (@pxref{Purgem}) between the two
5080 definitions.  For example, these are all valid @code{.macro} statements:
5082 @table @code
5083 @item .macro comm
5084 Begin the definition of a macro called @code{comm}, which takes no
5085 arguments.
5087 @item  .macro plus1 p, p1
5088 @itemx .macro plus1 p p1
5089 Either statement begins the definition of a macro called @code{plus1},
5090 which takes two arguments; within the macro definition, write
5091 @samp{\p} or @samp{\p1} to evaluate the arguments.
5093 @item .macro reserve_str p1=0 p2
5094 Begin the definition of a macro called @code{reserve_str}, with two
5095 arguments.  The first argument has a default value, but not the second.
5096 After the definition is complete, you can call the macro either as
5097 @samp{reserve_str @var{a},@var{b}} (with @samp{\p1} evaluating to
5098 @var{a} and @samp{\p2} evaluating to @var{b}), or as @samp{reserve_str
5099 ,@var{b}} (with @samp{\p1} evaluating as the default, in this case
5100 @samp{0}, and @samp{\p2} evaluating to @var{b}).
5102 @item .macro m p1:req, p2=0, p3:vararg
5103 Begin the definition of a macro called @code{m}, with at least three
5104 arguments.  The first argument must always have a value specified, but
5105 not the second, which instead has a default value. The third formal
5106 will get assigned all remaining arguments specified at invocation time.
5108 When you call a macro, you can specify the argument values either by
5109 position, or by keyword.  For example, @samp{sum 9,17} is equivalent to
5110 @samp{sum to=17, from=9}.
5112 @end table
5114 Note that since each of the @var{macargs} can be an identifier exactly
5115 as any other one permitted by the target architecture, there may be
5116 occasional problems if the target hand-crafts special meanings to certain
5117 characters when they occur in a special position.  For example, if the colon
5118 (@code{:}) is generally permitted to be part of a symbol name, but the
5119 architecture specific code special-cases it when occurring as the final
5120 character of a symbol (to denote a label), then the macro parameter
5121 replacement code will have no way of knowing that and consider the whole
5122 construct (including the colon) an identifier, and check only this
5123 identifier for being the subject to parameter substitution.  So for example
5124 this macro definition:
5126 @example
5127         .macro label l
5129         .endm
5130 @end example
5132 might not work as expected.  Invoking @samp{label foo} might not create a label
5133 called @samp{foo} but instead just insert the text @samp{\l:} into the
5134 assembler source, probably generating an error about an unrecognised
5135 identifier.
5137 Similarly problems might occur with the period character (@samp{.})
5138 which is often allowed inside opcode names (and hence identifier names).  So
5139 for example constructing a macro to build an opcode from a base name and a
5140 length specifier like this:
5142 @example
5143         .macro opcode base length
5144         \base.\length
5145         .endm
5146 @end example
5148 and invoking it as @samp{opcode store l} will not create a @samp{store.l}
5149 instruction but instead generate some kind of error as the assembler tries to
5150 interpret the text @samp{\base.\length}.
5152 There are several possible ways around this problem:
5154 @table @code
5155 @item Insert white space
5156 If it is possible to use white space characters then this is the simplest
5157 solution.  eg:
5159 @example
5160         .macro label l
5161 \l :
5162         .endm
5163 @end example
5165 @item Use @samp{\()}
5166 The string @samp{\()} can be used to separate the end of a macro argument from
5167 the following text.  eg:
5169 @example
5170         .macro opcode base length
5171         \base\().\length
5172         .endm
5173 @end example
5175 @item Use the alternate macro syntax mode
5176 In the alternative macro syntax mode the ampersand character (@samp{&}) can be
5177 used as a separator.  eg:
5179 @example
5180         .altmacro
5181         .macro label l
5183         .endm
5184 @end example
5185 @end table
5187 Note: this problem of correctly identifying string parameters to pseudo ops
5188 also applies to the identifiers used in @code{.irp} (@pxref{Irp}) 
5189 and @code{.irpc} (@pxref{Irpc}) as well.
5191 @item .endm
5192 @cindex @code{endm} directive
5193 Mark the end of a macro definition.
5195 @item .exitm
5196 @cindex @code{exitm} directive
5197 Exit early from the current macro definition.
5199 @cindex number of macros executed
5200 @cindex macros, count executed
5201 @item \@@
5202 @command{@value{AS}} maintains a counter of how many macros it has
5203 executed in this pseudo-variable; you can copy that number to your
5204 output with @samp{\@@}, but @emph{only within a macro definition}.
5206 @item LOCAL @var{name} [ , @dots{} ]
5207 @emph{Warning: @code{LOCAL} is only available if you select ``alternate
5208 macro syntax'' with @samp{--alternate} or @code{.altmacro}.}
5209 @xref{Altmacro,,@code{.altmacro}}.
5210 @end ftable
5212 @node Altmacro
5213 @section @code{.altmacro}
5214 Enable alternate macro mode, enabling:
5216 @ftable @code
5217 @item LOCAL @var{name} [ , @dots{} ]
5218 One additional directive, @code{LOCAL}, is available.  It is used to
5219 generate a string replacement for each of the @var{name} arguments, and
5220 replace any instances of @var{name} in each macro expansion.  The
5221 replacement string is unique in the assembly, and different for each
5222 separate macro expansion.  @code{LOCAL} allows you to write macros that
5223 define symbols, without fear of conflict between separate macro expansions.
5225 @item String delimiters
5226 You can write strings delimited in these other ways besides
5227 @code{"@var{string}"}:
5229 @table @code
5230 @item '@var{string}'
5231 You can delimit strings with single-quote characters.
5233 @item <@var{string}>
5234 You can delimit strings with matching angle brackets.
5235 @end table
5237 @item single-character string escape
5238 To include any single character literally in a string (even if the
5239 character would otherwise have some special meaning), you can prefix the
5240 character with @samp{!} (an exclamation mark).  For example, you can
5241 write @samp{<4.3 !> 5.4!!>} to get the literal text @samp{4.3 > 5.4!}.
5243 @item Expression results as strings
5244 You can write @samp{%@var{expr}} to evaluate the expression @var{expr}
5245 and use the result as a string.  
5246 @end ftable
5248 @node Noaltmacro
5249 @section @code{.noaltmacro}
5250 Disable alternate macro mode.  @xref{Altmacro}.
5252 @node Nolist
5253 @section @code{.nolist}
5255 @cindex @code{nolist} directive
5256 @cindex listing control, turning off
5257 Control (in conjunction with the @code{.list} directive) whether or
5258 not assembly listings are generated.  These two directives maintain an
5259 internal counter (which is zero initially).   @code{.list} increments the
5260 counter, and @code{.nolist} decrements it.  Assembly listings are
5261 generated whenever the counter is greater than zero.
5263 @node Octa
5264 @section @code{.octa @var{bignums}}
5266 @c FIXME: double size emitted for "octa" on i960, others?  Or warn?
5267 @cindex @code{octa} directive
5268 @cindex integer, 16-byte
5269 @cindex sixteen byte integer
5270 This directive expects zero or more bignums, separated by commas.  For each
5271 bignum, it emits a 16-byte integer.
5273 The term ``octa'' comes from contexts in which a ``word'' is two bytes;
5274 hence @emph{octa}-word for 16 bytes.
5276 @node Org
5277 @section @code{.org @var{new-lc} , @var{fill}}
5279 @cindex @code{org} directive
5280 @cindex location counter, advancing
5281 @cindex advancing location counter
5282 @cindex current address, advancing
5283 Advance the location counter of the current section to
5284 @var{new-lc}.  @var{new-lc} is either an absolute expression or an
5285 expression with the same section as the current subsection.  That is,
5286 you can't use @code{.org} to cross sections: if @var{new-lc} has the
5287 wrong section, the @code{.org} directive is ignored.  To be compatible
5288 with former assemblers, if the section of @var{new-lc} is absolute,
5289 @command{@value{AS}} issues a warning, then pretends the section of @var{new-lc}
5290 is the same as the current subsection.
5292 @code{.org} may only increase the location counter, or leave it
5293 unchanged; you cannot use @code{.org} to move the location counter
5294 backwards.
5296 @c double negative used below "not undefined" because this is a specific
5297 @c reference to "undefined" (as SEG_UNKNOWN is called in this manual)
5298 @c section. doc@cygnus.com 18feb91
5299 Because @command{@value{AS}} tries to assemble programs in one pass, @var{new-lc}
5300 may not be undefined.  If you really detest this restriction we eagerly await
5301 a chance to share your improved assembler.
5303 Beware that the origin is relative to the start of the section, not
5304 to the start of the subsection.  This is compatible with other
5305 people's assemblers.
5307 When the location counter (of the current subsection) is advanced, the
5308 intervening bytes are filled with @var{fill} which should be an
5309 absolute expression.  If the comma and @var{fill} are omitted,
5310 @var{fill} defaults to zero.
5312 @node P2align
5313 @section @code{.p2align[wl] @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
5315 @cindex padding the location counter given a power of two
5316 @cindex @code{p2align} directive
5317 Pad the location counter (in the current subsection) to a particular
5318 storage boundary.  The first expression (which must be absolute) is the
5319 number of low-order zero bits the location counter must have after
5320 advancement.  For example @samp{.p2align 3} advances the location
5321 counter until it a multiple of 8.  If the location counter is already a
5322 multiple of 8, no change is needed.
5324 The second expression (also absolute) gives the fill value to be stored in the
5325 padding bytes.  It (and the comma) may be omitted.  If it is omitted, the
5326 padding bytes are normally zero.  However, on some systems, if the section is
5327 marked as containing code and the fill value is omitted, the space is filled
5328 with no-op instructions.
5330 The third expression is also absolute, and is also optional.  If it is present,
5331 it is the maximum number of bytes that should be skipped by this alignment
5332 directive.  If doing the alignment would require skipping more bytes than the
5333 specified maximum, then the alignment is not done at all.  You can omit the
5334 fill value (the second argument) entirely by simply using two commas after the
5335 required alignment; this can be useful if you want the alignment to be filled
5336 with no-op instructions when appropriate.
5338 @cindex @code{p2alignw} directive
5339 @cindex @code{p2alignl} directive
5340 The @code{.p2alignw} and @code{.p2alignl} directives are variants of the
5341 @code{.p2align} directive.  The @code{.p2alignw} directive treats the fill
5342 pattern as a two byte word value.  The @code{.p2alignl} directives treats the
5343 fill pattern as a four byte longword value.  For example, @code{.p2alignw
5344 2,0x368d} will align to a multiple of 4.  If it skips two bytes, they will be
5345 filled in with the value 0x368d (the exact placement of the bytes depends upon
5346 the endianness of the processor).  If it skips 1 or 3 bytes, the fill value is
5347 undefined.
5349 @ifset ELF
5350 @node Previous
5351 @section @code{.previous}
5353 @cindex @code{previous} directive
5354 @cindex Section Stack
5355 This is one of the ELF section stack manipulation directives.  The others are
5356 @code{.section} (@pxref{Section}), @code{.subsection} (@pxref{SubSection}),
5357 @code{.pushsection} (@pxref{PushSection}), and @code{.popsection}
5358 (@pxref{PopSection}).
5360 This directive swaps the current section (and subsection) with most recently
5361 referenced section/subsection pair prior to this one.  Multiple
5362 @code{.previous} directives in a row will flip between two sections (and their
5363 subsections).  For example:
5365 @smallexample
5366 .section A
5367  .subsection 1
5368   .word 0x1234
5369  .subsection 2
5370   .word 0x5678
5371 .previous
5372  .word 0x9abc
5373 @end smallexample
5375 Will place 0x1234 and 0x9abc into subsection 1 and 0x5678 into subsection 2 of
5376 section A.  Whilst:
5378 @smallexample
5379 .section A
5380 .subsection 1
5381   # Now in section A subsection 1
5382   .word 0x1234
5383 .section B
5384 .subsection 0
5385   # Now in section B subsection 0
5386   .word 0x5678
5387 .subsection 1
5388   # Now in section B subsection 1
5389   .word 0x9abc
5390 .previous
5391   # Now in section B subsection 0
5392   .word 0xdef0
5393 @end smallexample
5395 Will place 0x1234 into section A, 0x5678 and 0xdef0 into subsection 0 of
5396 section B and 0x9abc into subsection 1 of section B.
5398 In terms of the section stack, this directive swaps the current section with
5399 the top section on the section stack.
5400 @end ifset
5402 @ifset ELF
5403 @node PopSection
5404 @section @code{.popsection}
5406 @cindex @code{popsection} directive
5407 @cindex Section Stack
5408 This is one of the ELF section stack manipulation directives.  The others are
5409 @code{.section} (@pxref{Section}), @code{.subsection} (@pxref{SubSection}), 
5410 @code{.pushsection} (@pxref{PushSection}), and @code{.previous} 
5411 (@pxref{Previous}).
5413 This directive replaces the current section (and subsection) with the top
5414 section (and subsection) on the section stack.  This section is popped off the
5415 stack. 
5416 @end ifset
5418 @node Print
5419 @section @code{.print @var{string}}
5421 @cindex @code{print} directive
5422 @command{@value{AS}} will print @var{string} on the standard output during
5423 assembly.  You must put @var{string} in double quotes.
5425 @ifset ELF
5426 @node Protected
5427 @section @code{.protected @var{names}}
5429 @cindex @code{protected} directive
5430 @cindex visibility
5431 This is one of the ELF visibility directives.  The other two are
5432 @code{.hidden} (@pxref{Hidden}) and @code{.internal} (@pxref{Internal}).
5434 This directive overrides the named symbols default visibility (which is set by
5435 their binding: local, global or weak).  The directive sets the visibility to
5436 @code{protected} which means that any references to the symbols from within the
5437 components that defines them must be resolved to the definition in that
5438 component, even if a definition in another component would normally preempt
5439 this. 
5440 @end ifset
5442 @node Psize
5443 @section @code{.psize @var{lines} , @var{columns}}
5445 @cindex @code{psize} directive
5446 @cindex listing control: paper size
5447 @cindex paper size, for listings
5448 Use this directive to declare the number of lines---and, optionally, the
5449 number of columns---to use for each page, when generating listings.
5451 If you do not use @code{.psize}, listings use a default line-count
5452 of 60.  You may omit the comma and @var{columns} specification; the
5453 default width is 200 columns.
5455 @command{@value{AS}} generates formfeeds whenever the specified number of
5456 lines is exceeded (or whenever you explicitly request one, using
5457 @code{.eject}).
5459 If you specify @var{lines} as @code{0}, no formfeeds are generated save
5460 those explicitly specified with @code{.eject}.
5462 @node Purgem
5463 @section @code{.purgem @var{name}}
5465 @cindex @code{purgem} directive
5466 Undefine the macro @var{name}, so that later uses of the string will not be
5467 expanded.  @xref{Macro}.
5469 @ifset ELF
5470 @node PushSection
5471 @section @code{.pushsection @var{name} [, @var{subsection}] [, "@var{flags}"[, @@@var{type}[,@var{arguments}]]]}
5473 @cindex @code{pushsection} directive
5474 @cindex Section Stack
5475 This is one of the ELF section stack manipulation directives.  The others are
5476 @code{.section} (@pxref{Section}), @code{.subsection} (@pxref{SubSection}), 
5477 @code{.popsection} (@pxref{PopSection}), and @code{.previous} 
5478 (@pxref{Previous}).
5480 This directive pushes the current section (and subsection) onto the
5481 top of the section stack, and then replaces the current section and
5482 subsection with @code{name} and @code{subsection}. The optional
5483 @code{flags}, @code{type} and @code{arguments} are treated the same
5484 as in the @code{.section} (@pxref{Section}) directive.
5485 @end ifset
5487 @node Quad
5488 @section @code{.quad @var{bignums}}
5490 @cindex @code{quad} directive
5491 @code{.quad} expects zero or more bignums, separated by commas.  For
5492 each bignum, it emits
5493 @ifclear bignum-16
5494 an 8-byte integer.  If the bignum won't fit in 8 bytes, it prints a
5495 warning message; and just takes the lowest order 8 bytes of the bignum.
5496 @cindex eight-byte integer
5497 @cindex integer, 8-byte
5499 The term ``quad'' comes from contexts in which a ``word'' is two bytes;
5500 hence @emph{quad}-word for 8 bytes.
5501 @end ifclear
5502 @ifset bignum-16
5503 a 16-byte integer.  If the bignum won't fit in 16 bytes, it prints a
5504 warning message; and just takes the lowest order 16 bytes of the bignum.
5505 @cindex sixteen-byte integer
5506 @cindex integer, 16-byte
5507 @end ifset
5509 @node Reloc
5510 @section @code{.reloc @var{offset}, @var{reloc_name}[, @var{expression}]}
5512 @cindex @code{reloc} directive
5513 Generate a relocation at @var{offset} of type @var{reloc_name} with value
5514 @var{expression}.  If @var{offset} is a number, the relocation is generated in
5515 the current section.  If @var{offset} is an expression that resolves to a
5516 symbol plus offset, the relocation is generated in the given symbol's section.
5517 @var{expression}, if present, must resolve to a symbol plus addend or to an
5518 absolute value, but note that not all targets support an addend.  e.g. ELF REL
5519 targets such as i386 store an addend in the section contents rather than in the
5520 relocation.  This low level interface does not support addends stored in the
5521 section.
5523 @node Rept
5524 @section @code{.rept @var{count}}
5526 @cindex @code{rept} directive
5527 Repeat the sequence of lines between the @code{.rept} directive and the next
5528 @code{.endr} directive @var{count} times.
5530 For example, assembling
5532 @example
5533         .rept   3
5534         .long   0
5535         .endr
5536 @end example
5538 is equivalent to assembling
5540 @example
5541         .long   0
5542         .long   0
5543         .long   0
5544 @end example
5546 @node Sbttl
5547 @section @code{.sbttl "@var{subheading}"}
5549 @cindex @code{sbttl} directive
5550 @cindex subtitles for listings
5551 @cindex listing control: subtitle
5552 Use @var{subheading} as the title (third line, immediately after the
5553 title line) when generating assembly listings.
5555 This directive affects subsequent pages, as well as the current page if
5556 it appears within ten lines of the top of a page.
5558 @ifset COFF
5559 @node Scl
5560 @section @code{.scl @var{class}}
5562 @cindex @code{scl} directive
5563 @cindex symbol storage class (COFF)
5564 @cindex COFF symbol storage class
5565 Set the storage-class value for a symbol.  This directive may only be
5566 used inside a @code{.def}/@code{.endef} pair.  Storage class may flag
5567 whether a symbol is static or external, or it may record further
5568 symbolic debugging information.
5569 @ifset BOUT
5571 The @samp{.scl} directive is primarily associated with COFF output; when
5572 configured to generate @code{b.out} output format, @command{@value{AS}}
5573 accepts this directive but ignores it.
5574 @end ifset
5575 @end ifset
5577 @ifset COFF-ELF
5578 @node Section
5579 @section @code{.section @var{name}}
5581 @cindex named section
5582 Use the @code{.section} directive to assemble the following code into a section
5583 named @var{name}.
5585 This directive is only supported for targets that actually support arbitrarily
5586 named sections; on @code{a.out} targets, for example, it is not accepted, even
5587 with a standard @code{a.out} section name.
5589 @ifset COFF
5590 @ifset ELF
5591 @c only print the extra heading if both COFF and ELF are set
5592 @subheading COFF Version
5593 @end ifset
5595 @cindex @code{section} directive (COFF version)
5596 For COFF targets, the @code{.section} directive is used in one of the following
5597 ways:
5599 @smallexample
5600 .section @var{name}[, "@var{flags}"]
5601 .section @var{name}[, @var{subsegment}]
5602 @end smallexample
5604 If the optional argument is quoted, it is taken as flags to use for the
5605 section.  Each flag is a single character.  The following flags are recognized:
5606 @table @code
5607 @item b
5608 bss section (uninitialized data)
5609 @item n
5610 section is not loaded
5611 @item w
5612 writable section
5613 @item d
5614 data section
5615 @item r
5616 read-only section
5617 @item x
5618 executable section
5619 @item s
5620 shared section (meaningful for PE targets)
5621 @item a
5622 ignored.  (For compatibility with the ELF version)
5623 @end table
5625 If no flags are specified, the default flags depend upon the section name.  If
5626 the section name is not recognized, the default will be for the section to be
5627 loaded and writable.  Note the @code{n} and @code{w} flags remove attributes
5628 from the section, rather than adding them, so if they are used on their own it
5629 will be as if no flags had been specified at all.
5631 If the optional argument to the @code{.section} directive is not quoted, it is
5632 taken as a subsegment number (@pxref{Sub-Sections}).
5633 @end ifset
5635 @ifset ELF
5636 @ifset COFF
5637 @c only print the extra heading if both COFF and ELF are set
5638 @subheading ELF Version
5639 @end ifset
5641 @cindex Section Stack
5642 This is one of the ELF section stack manipulation directives.  The others are
5643 @code{.subsection} (@pxref{SubSection}), @code{.pushsection} 
5644 (@pxref{PushSection}), @code{.popsection} (@pxref{PopSection}), and
5645 @code{.previous} (@pxref{Previous}).
5647 @cindex @code{section} directive (ELF version)
5648 For ELF targets, the @code{.section} directive is used like this:
5650 @smallexample
5651 .section @var{name} [, "@var{flags}"[, @@@var{type}[,@var{flag_specific_arguments}]]]
5652 @end smallexample
5654 The optional @var{flags} argument is a quoted string which may contain any
5655 combination of the following characters:
5656 @table @code
5657 @item a
5658 section is allocatable
5659 @item w
5660 section is writable
5661 @item x
5662 section is executable
5663 @item M
5664 section is mergeable
5665 @item S
5666 section contains zero terminated strings
5667 @item G
5668 section is a member of a section group
5669 @item T
5670 section is used for thread-local-storage
5671 @end table
5673 The optional @var{type} argument may contain one of the following constants:
5674 @table @code
5675 @item @@progbits
5676 section contains data
5677 @item @@nobits
5678 section does not contain data (i.e., section only occupies space)
5679 @item @@note
5680 section contains data which is used by things other than the program
5681 @item @@init_array
5682 section contains an array of pointers to init functions
5683 @item @@fini_array
5684 section contains an array of pointers to finish functions
5685 @item @@preinit_array
5686 section contains an array of pointers to pre-init functions
5687 @end table
5689 Many targets only support the first three section types.
5691 Note on targets where the @code{@@} character is the start of a comment (eg
5692 ARM) then another character is used instead.  For example the ARM port uses the
5693 @code{%} character.
5695 If @var{flags} contains the @code{M} symbol then the @var{type} argument must
5696 be specified as well as an extra argument---@var{entsize}---like this:
5698 @smallexample
5699 .section @var{name} , "@var{flags}"M, @@@var{type}, @var{entsize}
5700 @end smallexample
5702 Sections with the @code{M} flag but not @code{S} flag must contain fixed size
5703 constants, each @var{entsize} octets long. Sections with both @code{M} and
5704 @code{S} must contain zero terminated strings where each character is
5705 @var{entsize} bytes long. The linker may remove duplicates within sections with
5706 the same name, same entity size and same flags.  @var{entsize} must be an
5707 absolute expression.
5709 If @var{flags} contains the @code{G} symbol then the @var{type} argument must
5710 be present along with an additional field like this:
5712 @smallexample
5713 .section @var{name} , "@var{flags}"G, @@@var{type}, @var{GroupName}[, @var{linkage}]
5714 @end smallexample
5716 The @var{GroupName} field specifies the name of the section group to which this
5717 particular section belongs.  The optional linkage field can contain:
5718 @table @code
5719 @item comdat
5720 indicates that only one copy of this section should be retained
5721 @item .gnu.linkonce
5722 an alias for comdat
5723 @end table
5725 Note: if both the @var{M} and @var{G} flags are present then the fields for
5726 the Merge flag should come first, like this:
5728 @smallexample
5729 .section @var{name} , "@var{flags}"MG, @@@var{type}, @var{entsize}, @var{GroupName}[, @var{linkage}]
5730 @end smallexample
5732 If no flags are specified, the default flags depend upon the section name.  If
5733 the section name is not recognized, the default will be for the section to have
5734 none of the above flags: it will not be allocated in memory, nor writable, nor
5735 executable.  The section will contain data.
5737 For ELF targets, the assembler supports another type of @code{.section}
5738 directive for compatibility with the Solaris assembler:
5740 @smallexample
5741 .section "@var{name}"[, @var{flags}...]
5742 @end smallexample
5744 Note that the section name is quoted.  There may be a sequence of comma
5745 separated flags:
5746 @table @code
5747 @item #alloc
5748 section is allocatable
5749 @item #write
5750 section is writable
5751 @item #execinstr
5752 section is executable
5753 @item #tls
5754 section is used for thread local storage
5755 @end table
5757 This directive replaces the current section and subsection.  See the
5758 contents of the gas testsuite directory @code{gas/testsuite/gas/elf} for
5759 some examples of how this directive and the other section stack directives
5760 work.
5761 @end ifset
5762 @end ifset
5764 @node Set
5765 @section @code{.set @var{symbol}, @var{expression}}
5767 @cindex @code{set} directive
5768 @cindex symbol value, setting
5769 Set the value of @var{symbol} to @var{expression}.  This
5770 changes @var{symbol}'s value and type to conform to
5771 @var{expression}.  If @var{symbol} was flagged as external, it remains
5772 flagged (@pxref{Symbol Attributes}).
5774 You may @code{.set} a symbol many times in the same assembly.
5776 If you @code{.set} a global symbol, the value stored in the object
5777 file is the last value stored into it.
5779 @ifset HPPA
5780 The syntax for @code{set} on the HPPA is
5781 @samp{@var{symbol} .set @var{expression}}.
5782 @end ifset
5784 @ifset Z80
5785 On Z80 @code{set} is a real instruction, use
5786 @samp{@var{symbol} defl @var{expression}} instead.
5787 @end ifset
5789 @node Short
5790 @section @code{.short @var{expressions}}
5792 @cindex @code{short} directive
5793 @ifset GENERIC
5794 @code{.short} is normally the same as @samp{.word}.
5795 @xref{Word,,@code{.word}}.
5797 In some configurations, however, @code{.short} and @code{.word} generate
5798 numbers of different lengths.  @xref{Machine Dependencies}.
5799 @end ifset
5800 @ifclear GENERIC
5801 @ifset W16
5802 @code{.short} is the same as @samp{.word}.  @xref{Word,,@code{.word}}.
5803 @end ifset
5804 @ifset W32
5805 This expects zero or more @var{expressions}, and emits
5806 a 16 bit number for each.
5807 @end ifset
5808 @end ifclear
5810 @node Single
5811 @section @code{.single @var{flonums}}
5813 @cindex @code{single} directive
5814 @cindex floating point numbers (single)
5815 This directive assembles zero or more flonums, separated by commas.  It
5816 has the same effect as @code{.float}.
5817 @ifset GENERIC
5818 The exact kind of floating point numbers emitted depends on how
5819 @command{@value{AS}} is configured.  @xref{Machine Dependencies}.
5820 @end ifset
5821 @ifclear GENERIC
5822 @ifset IEEEFLOAT
5823 On the @value{TARGET} family, @code{.single} emits 32-bit floating point
5824 numbers in @sc{ieee} format.
5825 @end ifset
5826 @end ifclear
5828 @ifset COFF-ELF
5829 @node Size
5830 @section @code{.size}
5832 This directive is used to set the size associated with a symbol.
5834 @ifset COFF
5835 @ifset ELF
5836 @c only print the extra heading if both COFF and ELF are set
5837 @subheading COFF Version
5838 @end ifset
5840 @cindex @code{size} directive (COFF version)
5841 For COFF targets, the @code{.size} directive is only permitted inside
5842 @code{.def}/@code{.endef} pairs.  It is used like this:
5844 @smallexample
5845 .size @var{expression}
5846 @end smallexample
5848 @ifset BOUT
5849 @samp{.size} is only meaningful when generating COFF format output; when
5850 @command{@value{AS}} is generating @code{b.out}, it accepts this directive but
5851 ignores it.
5852 @end ifset
5853 @end ifset
5855 @ifset ELF
5856 @ifset COFF
5857 @c only print the extra heading if both COFF and ELF are set
5858 @subheading ELF Version
5859 @end ifset
5861 @cindex @code{size} directive (ELF version)
5862 For ELF targets, the @code{.size} directive is used like this:
5864 @smallexample
5865 .size @var{name} , @var{expression}
5866 @end smallexample
5868 This directive sets the size associated with a symbol @var{name}.
5869 The size in bytes is computed from @var{expression} which can make use of label
5870 arithmetic.  This directive is typically used to set the size of function
5871 symbols.
5872 @end ifset
5873 @end ifset
5875 @node Sleb128
5876 @section @code{.sleb128 @var{expressions}}
5878 @cindex @code{sleb128} directive
5879 @var{sleb128} stands for ``signed little endian base 128.''  This is a 
5880 compact, variable length representation of numbers used by the DWARF
5881 symbolic debugging format.  @xref{Uleb128, ,@code{.uleb128}}.
5883 @ifclear no-space-dir
5884 @node Skip
5885 @section @code{.skip @var{size} , @var{fill}}
5887 @cindex @code{skip} directive
5888 @cindex filling memory
5889 This directive emits @var{size} bytes, each of value @var{fill}.  Both
5890 @var{size} and @var{fill} are absolute expressions.  If the comma and
5891 @var{fill} are omitted, @var{fill} is assumed to be zero.  This is the same as
5892 @samp{.space}.
5894 @node Space
5895 @section @code{.space @var{size} , @var{fill}}
5897 @cindex @code{space} directive
5898 @cindex filling memory
5899 This directive emits @var{size} bytes, each of value @var{fill}.  Both
5900 @var{size} and @var{fill} are absolute expressions.  If the comma
5901 and @var{fill} are omitted, @var{fill} is assumed to be zero.  This is the same
5902 as @samp{.skip}.
5904 @ifset HPPA
5905 @quotation
5906 @emph{Warning:} @code{.space} has a completely different meaning for HPPA
5907 targets; use @code{.block} as a substitute.  See @cite{HP9000 Series 800
5908 Assembly Language Reference Manual} (HP 92432-90001) for the meaning of the
5909 @code{.space} directive.  @xref{HPPA Directives,,HPPA Assembler Directives},
5910 for a summary.
5911 @end quotation
5912 @end ifset
5913 @end ifclear
5915 @ifset have-stabs
5916 @node Stab
5917 @section @code{.stabd, .stabn, .stabs}
5919 @cindex symbolic debuggers, information for
5920 @cindex @code{stab@var{x}} directives
5921 There are three directives that begin @samp{.stab}.
5922 All emit symbols (@pxref{Symbols}), for use by symbolic debuggers.
5923 The symbols are not entered in the @command{@value{AS}} hash table: they
5924 cannot be referenced elsewhere in the source file.
5925 Up to five fields are required:
5927 @table @var
5928 @item string
5929 This is the symbol's name.  It may contain any character except
5930 @samp{\000}, so is more general than ordinary symbol names.  Some
5931 debuggers used to code arbitrarily complex structures into symbol names
5932 using this field.
5934 @item type
5935 An absolute expression.  The symbol's type is set to the low 8 bits of
5936 this expression.  Any bit pattern is permitted, but @code{@value{LD}}
5937 and debuggers choke on silly bit patterns.
5939 @item other
5940 An absolute expression.  The symbol's ``other'' attribute is set to the
5941 low 8 bits of this expression.
5943 @item desc
5944 An absolute expression.  The symbol's descriptor is set to the low 16
5945 bits of this expression.
5947 @item value
5948 An absolute expression which becomes the symbol's value.
5949 @end table
5951 If a warning is detected while reading a @code{.stabd}, @code{.stabn},
5952 or @code{.stabs} statement, the symbol has probably already been created;
5953 you get a half-formed symbol in your object file.  This is
5954 compatible with earlier assemblers!
5956 @table @code
5957 @cindex @code{stabd} directive
5958 @item .stabd @var{type} , @var{other} , @var{desc}
5960 The ``name'' of the symbol generated is not even an empty string.
5961 It is a null pointer, for compatibility.  Older assemblers used a
5962 null pointer so they didn't waste space in object files with empty
5963 strings.
5965 The symbol's value is set to the location counter,
5966 relocatably.  When your program is linked, the value of this symbol
5967 is the address of the location counter when the @code{.stabd} was
5968 assembled.
5970 @cindex @code{stabn} directive
5971 @item .stabn @var{type} , @var{other} , @var{desc} , @var{value}
5972 The name of the symbol is set to the empty string @code{""}.
5974 @cindex @code{stabs} directive
5975 @item .stabs @var{string} ,  @var{type} , @var{other} , @var{desc} , @var{value}
5976 All five fields are specified.
5977 @end table
5978 @end ifset
5979 @c end     have-stabs
5981 @node String
5982 @section @code{.string} "@var{str}", @code{.string8} "@var{str}", @code{.string16}
5983 "@var{str}", @code{.string32} "@var{str}", @code{.string64} "@var{str}" 
5985 @cindex string, copying to object file
5986 @cindex string8, copying to object file
5987 @cindex string16, copying to object file
5988 @cindex string32, copying to object file
5989 @cindex string64, copying to object file
5990 @cindex @code{string} directive
5991 @cindex @code{string8} directive
5992 @cindex @code{string16} directive
5993 @cindex @code{string32} directive
5994 @cindex @code{string64} directive
5996 Copy the characters in @var{str} to the object file.  You may specify more than
5997 one string to copy, separated by commas.  Unless otherwise specified for a
5998 particular machine, the assembler marks the end of each string with a 0 byte.
5999 You can use any of the escape sequences described in @ref{Strings,,Strings}.
6001 The variants @code{string16}, @code{string32} and @code{string64} differ from 
6002 the @code{string} pseudo opcode in that each 8-bit character from @var{str} is
6003 copied and expanded to 16, 32 or 64 bits respectively.  The expanded characters
6004 are stored in target endianness byte order.
6006 Example:
6007 @smallexample
6008         .string32 "BYE"
6009 expands to:
6010         .string   "B\0\0\0Y\0\0\0E\0\0\0"  /* On little endian targets.  */
6011         .string   "\0\0\0B\0\0\0Y\0\0\0E"  /* On big endian targets.  */
6012 @end smallexample
6015 @node Struct
6016 @section @code{.struct @var{expression}}
6018 @cindex @code{struct} directive
6019 Switch to the absolute section, and set the section offset to @var{expression},
6020 which must be an absolute expression.  You might use this as follows:
6021 @smallexample
6022         .struct 0
6023 field1:
6024         .struct field1 + 4
6025 field2:
6026         .struct field2 + 4
6027 field3:
6028 @end smallexample
6029 This would define the symbol @code{field1} to have the value 0, the symbol
6030 @code{field2} to have the value 4, and the symbol @code{field3} to have the
6031 value 8.  Assembly would be left in the absolute section, and you would need to
6032 use a @code{.section} directive of some sort to change to some other section
6033 before further assembly.
6035 @ifset ELF
6036 @node SubSection
6037 @section @code{.subsection @var{name}}
6039 @cindex @code{subsection} directive
6040 @cindex Section Stack
6041 This is one of the ELF section stack manipulation directives.  The others are
6042 @code{.section} (@pxref{Section}), @code{.pushsection} (@pxref{PushSection}), 
6043 @code{.popsection} (@pxref{PopSection}), and @code{.previous} 
6044 (@pxref{Previous}).
6046 This directive replaces the current subsection with @code{name}.  The current
6047 section is not changed.  The replaced subsection is put onto the section stack
6048 in place of the then current top of stack subsection.
6049 @end ifset
6051 @ifset ELF
6052 @node Symver
6053 @section @code{.symver}
6054 @cindex @code{symver} directive
6055 @cindex symbol versioning
6056 @cindex versions of symbols
6057 Use the @code{.symver} directive to bind symbols to specific version nodes
6058 within a source file.  This is only supported on ELF platforms, and is
6059 typically used when assembling files to be linked into a shared library.
6060 There are cases where it may make sense to use this in objects to be bound
6061 into an application itself so as to override a versioned symbol from a
6062 shared library.
6064 For ELF targets, the @code{.symver} directive can be used like this:
6065 @smallexample
6066 .symver @var{name}, @var{name2@@nodename}
6067 @end smallexample
6068 If the symbol @var{name} is defined within the file
6069 being assembled, the @code{.symver} directive effectively creates a symbol
6070 alias with the name @var{name2@@nodename}, and in fact the main reason that we
6071 just don't try and create a regular alias is that the @var{@@} character isn't
6072 permitted in symbol names.  The @var{name2} part of the name is the actual name
6073 of the symbol by which it will be externally referenced.  The name @var{name}
6074 itself is merely a name of convenience that is used so that it is possible to
6075 have definitions for multiple versions of a function within a single source
6076 file, and so that the compiler can unambiguously know which version of a
6077 function is being mentioned.  The @var{nodename} portion of the alias should be
6078 the name of a node specified in the version script supplied to the linker when
6079 building a shared library.  If you are attempting to override a versioned
6080 symbol from a shared library, then @var{nodename} should correspond to the
6081 nodename of the symbol you are trying to override.
6083 If the symbol @var{name} is not defined within the file being assembled, all
6084 references to @var{name} will be changed to @var{name2@@nodename}.  If no
6085 reference to @var{name} is made, @var{name2@@nodename} will be removed from the
6086 symbol table.
6088 Another usage of the @code{.symver} directive is:
6089 @smallexample
6090 .symver @var{name}, @var{name2@@@@nodename}
6091 @end smallexample
6092 In this case, the symbol @var{name} must exist and be defined within
6093 the file being assembled. It is similar to @var{name2@@nodename}. The
6094 difference is @var{name2@@@@nodename} will also be used to resolve
6095 references to @var{name2} by the linker.
6097 The third usage of the @code{.symver} directive is:
6098 @smallexample
6099 .symver @var{name}, @var{name2@@@@@@nodename}
6100 @end smallexample
6101 When @var{name} is not defined within the
6102 file being assembled, it is treated as @var{name2@@nodename}. When
6103 @var{name} is defined within the file being assembled, the symbol
6104 name, @var{name}, will be changed to @var{name2@@@@nodename}.
6105 @end ifset
6107 @ifset COFF
6108 @node Tag
6109 @section @code{.tag @var{structname}}
6111 @cindex COFF structure debugging
6112 @cindex structure debugging, COFF
6113 @cindex @code{tag} directive
6114 This directive is generated by compilers to include auxiliary debugging
6115 information in the symbol table.  It is only permitted inside
6116 @code{.def}/@code{.endef} pairs.  Tags are used to link structure
6117 definitions in the symbol table with instances of those structures.
6118 @ifset BOUT
6120 @samp{.tag} is only used when generating COFF format output; when
6121 @command{@value{AS}} is generating @code{b.out}, it accepts this directive but
6122 ignores it.
6123 @end ifset
6124 @end ifset
6126 @node Text
6127 @section @code{.text @var{subsection}}
6129 @cindex @code{text} directive
6130 Tells @command{@value{AS}} to assemble the following statements onto the end of
6131 the text subsection numbered @var{subsection}, which is an absolute
6132 expression.  If @var{subsection} is omitted, subsection number zero
6133 is used.
6135 @node Title
6136 @section @code{.title "@var{heading}"}
6138 @cindex @code{title} directive
6139 @cindex listing control: title line
6140 Use @var{heading} as the title (second line, immediately after the
6141 source file name and pagenumber) when generating assembly listings.
6143 This directive affects subsequent pages, as well as the current page if
6144 it appears within ten lines of the top of a page.
6146 @ifset COFF-ELF
6147 @node Type
6148 @section @code{.type}
6150 This directive is used to set the type of a symbol.
6152 @ifset COFF
6153 @ifset ELF
6154 @c only print the extra heading if both COFF and ELF are set
6155 @subheading COFF Version
6156 @end ifset
6158 @cindex COFF symbol type
6159 @cindex symbol type, COFF
6160 @cindex @code{type} directive (COFF version)
6161 For COFF targets, this directive is permitted only within
6162 @code{.def}/@code{.endef} pairs.  It is used like this:
6164 @smallexample
6165 .type @var{int}
6166 @end smallexample
6168 This records the integer @var{int} as the type attribute of a symbol table
6169 entry.
6171 @ifset BOUT
6172 @samp{.type} is associated only with COFF format output; when
6173 @command{@value{AS}} is configured for @code{b.out} output, it accepts this
6174 directive but ignores it.
6175 @end ifset
6176 @end ifset
6178 @ifset ELF
6179 @ifset COFF
6180 @c only print the extra heading if both COFF and ELF are set
6181 @subheading ELF Version
6182 @end ifset
6184 @cindex ELF symbol type
6185 @cindex symbol type, ELF
6186 @cindex @code{type} directive (ELF version)
6187 For ELF targets, the @code{.type} directive is used like this:
6189 @smallexample
6190 .type @var{name} , @var{type description}
6191 @end smallexample
6193 This sets the type of symbol @var{name} to be either a
6194 function symbol or an object symbol.  There are five different syntaxes
6195 supported for the @var{type description} field, in order to provide
6196 compatibility with various other assemblers.
6198 Because some of the characters used in these syntaxes (such as @samp{@@} and
6199 @samp{#}) are comment characters for some architectures, some of the syntaxes
6200 below do not work on all architectures.  The first variant will be accepted by
6201 the GNU assembler on all architectures so that variant should be used for
6202 maximum portability, if you do not need to assemble your code with other
6203 assemblers.
6205 The syntaxes supported are:
6207 @smallexample
6208   .type <name> STT_<TYPE_IN_UPPER_CASE>
6209   .type <name>,#<type>
6210   .type <name>,@@<type>
6211   .type <name>,%>type>
6212   .type <name>,"<type>"
6213 @end smallexample
6215 The types supported are:
6217 @table @gcctabopt
6218 @item STT_FUNC
6219 @itemx function
6220 Mark the symbol as being a function name.
6222 @item STT_OBJECT
6223 @itemx object
6224 Mark the symbol as being a data object.
6226 @item STT_TLS
6227 @itemx tls_object
6228 Mark the symbol as being a thead-local data object.
6230 @item STT_COMMON
6231 @itemx common
6232 Mark the symbol as being a common data object.
6233 @end table
6235 Note: Some targets support extra types in addition to those listed above.
6237 @end ifset
6238 @end ifset
6240 @node Uleb128
6241 @section @code{.uleb128 @var{expressions}}
6243 @cindex @code{uleb128} directive
6244 @var{uleb128} stands for ``unsigned little endian base 128.''  This is a 
6245 compact, variable length representation of numbers used by the DWARF
6246 symbolic debugging format.  @xref{Sleb128, ,@code{.sleb128}}.
6248 @ifset COFF
6249 @node Val
6250 @section @code{.val @var{addr}}
6252 @cindex @code{val} directive
6253 @cindex COFF value attribute
6254 @cindex value attribute, COFF
6255 This directive, permitted only within @code{.def}/@code{.endef} pairs,
6256 records the address @var{addr} as the value attribute of a symbol table
6257 entry.
6258 @ifset BOUT
6260 @samp{.val} is used only for COFF output; when @command{@value{AS}} is
6261 configured for @code{b.out}, it accepts this directive but ignores it.
6262 @end ifset
6263 @end ifset
6265 @ifset ELF
6266 @node Version
6267 @section @code{.version "@var{string}"}
6269 @cindex @code{version} directive
6270 This directive creates a @code{.note} section and places into it an ELF
6271 formatted note of type NT_VERSION.  The note's name is set to @code{string}.
6272 @end ifset
6274 @ifset ELF
6275 @node VTableEntry
6276 @section @code{.vtable_entry @var{table}, @var{offset}}
6278 @cindex @code{vtable_entry} directive
6279 This directive finds or creates a symbol @code{table} and creates a
6280 @code{VTABLE_ENTRY} relocation for it with an addend of @code{offset}.
6282 @node VTableInherit
6283 @section @code{.vtable_inherit @var{child}, @var{parent}}
6285 @cindex @code{vtable_inherit} directive
6286 This directive finds the symbol @code{child} and finds or creates the symbol
6287 @code{parent} and then creates a @code{VTABLE_INHERIT} relocation for the
6288 parent whose addend is the value of the child symbol.  As a special case the
6289 parent name of @code{0} is treated as referring to the @code{*ABS*} section.
6290 @end ifset
6292 @node Warning
6293 @section @code{.warning "@var{string}"}
6294 @cindex warning directive
6295 Similar to the directive @code{.error}
6296 (@pxref{Error,,@code{.error "@var{string}"}}), but just emits a warning.
6298 @node Weak
6299 @section @code{.weak @var{names}}
6301 @cindex @code{weak} directive
6302 This directive sets the weak attribute on the comma separated list of symbol
6303 @code{names}.  If the symbols do not already exist, they will be created.
6305 On COFF targets other than PE, weak symbols are a GNU extension.  This 
6306 directive sets the weak attribute on the comma separated list of symbol
6307 @code{names}.  If the symbols do not already exist, they will be created.
6309 On the PE target, weak symbols are supported natively as weak aliases.
6310 When a weak symbol is created that is not an alias, GAS creates an 
6311 alternate symbol to hold the default value.
6313 @node Weakref
6314 @section @code{.weakref @var{alias}, @var{target}}
6316 @cindex @code{weakref} directive
6317 This directive creates an alias to the target symbol that enables the symbol to
6318 be referenced with weak-symbol semantics, but without actually making it weak.
6319 If direct references or definitions of the symbol are present, then the symbol
6320 will not be weak, but if all references to it are through weak references, the
6321 symbol will be marked as weak in the symbol table.
6323 The effect is equivalent to moving all references to the alias to a separate
6324 assembly source file, renaming the alias to the symbol in it, declaring the
6325 symbol as weak there, and running a reloadable link to merge the object files
6326 resulting from the assembly of the new source file and the old source file that
6327 had the references to the alias removed.
6329 The alias itself never makes to the symbol table, and is entirely handled
6330 within the assembler.
6332 @node Word
6333 @section @code{.word @var{expressions}}
6335 @cindex @code{word} directive
6336 This directive expects zero or more @var{expressions}, of any section,
6337 separated by commas.
6338 @ifclear GENERIC
6339 @ifset W32
6340 For each expression, @command{@value{AS}} emits a 32-bit number.
6341 @end ifset
6342 @ifset W16
6343 For each expression, @command{@value{AS}} emits a 16-bit number.
6344 @end ifset
6345 @end ifclear
6346 @ifset GENERIC
6348 The size of the number emitted, and its byte order,
6349 depend on what target computer the assembly is for.
6350 @end ifset
6352 @c on amd29k, i960, sparc the "special treatment to support compilers" doesn't
6353 @c happen---32-bit addressability, period; no long/short jumps.
6354 @ifset DIFF-TBL-KLUGE
6355 @cindex difference tables altered
6356 @cindex altered difference tables
6357 @quotation
6358 @emph{Warning: Special Treatment to support Compilers}
6359 @end quotation
6361 @ifset GENERIC
6362 Machines with a 32-bit address space, but that do less than 32-bit
6363 addressing, require the following special treatment.  If the machine of
6364 interest to you does 32-bit addressing (or doesn't require it;
6365 @pxref{Machine Dependencies}), you can ignore this issue.
6367 @end ifset
6368 In order to assemble compiler output into something that works,
6369 @command{@value{AS}} occasionally does strange things to @samp{.word} directives.
6370 Directives of the form @samp{.word sym1-sym2} are often emitted by
6371 compilers as part of jump tables.  Therefore, when @command{@value{AS}} assembles a
6372 directive of the form @samp{.word sym1-sym2}, and the difference between
6373 @code{sym1} and @code{sym2} does not fit in 16 bits, @command{@value{AS}}
6374 creates a @dfn{secondary jump table}, immediately before the next label.
6375 This secondary jump table is preceded by a short-jump to the
6376 first byte after the secondary table.  This short-jump prevents the flow
6377 of control from accidentally falling into the new table.  Inside the
6378 table is a long-jump to @code{sym2}.  The original @samp{.word}
6379 contains @code{sym1} minus the address of the long-jump to
6380 @code{sym2}.
6382 If there were several occurrences of @samp{.word sym1-sym2} before the
6383 secondary jump table, all of them are adjusted.  If there was a
6384 @samp{.word sym3-sym4}, that also did not fit in sixteen bits, a
6385 long-jump to @code{sym4} is included in the secondary jump table,
6386 and the @code{.word} directives are adjusted to contain @code{sym3}
6387 minus the address of the long-jump to @code{sym4}; and so on, for as many
6388 entries in the original jump table as necessary.
6390 @ifset INTERNALS
6391 @emph{This feature may be disabled by compiling @command{@value{AS}} with the
6392 @samp{-DWORKING_DOT_WORD} option.} This feature is likely to confuse
6393 assembly language programmers.
6394 @end ifset
6395 @end ifset
6396 @c end     DIFF-TBL-KLUGE
6398 @node Deprecated
6399 @section Deprecated Directives
6401 @cindex deprecated directives
6402 @cindex obsolescent directives
6403 One day these directives won't work.
6404 They are included for compatibility with older assemblers.
6405 @table @t
6406 @item .abort
6407 @item .line
6408 @end table
6410 @ifset ELF
6411 @node Object Attributes
6412 @chapter Object Attributes
6413 @cindex object attributes
6415 @command{@value{AS}} assembles source files written for a specific architecture
6416 into object files for that architecture.  But not all object files are alike.
6417 Many architectures support incompatible variations.  For instance, floating
6418 point arguments might be passed in floating point registers if the object file
6419 requires hardware floating point support---or floating point arguments might be
6420 passed in integer registers if the object file supports processors with no
6421 hardware floating point unit.  Or, if two objects are built for different
6422 generations of the same architecture, the combination may require the
6423 newer generation at run-time.
6425 This information is useful during and after linking.  At link time,
6426 @command{@value{LD}} can warn about incompatible object files.  After link
6427 time, tools like @command{gdb} can use it to process the linked file
6428 correctly.
6430 Compatibility information is recorded as a series of object attributes.  Each
6431 attribute has a @dfn{vendor}, @dfn{tag}, and @dfn{value}.  The vendor is a
6432 string, and indicates who sets the meaning of the tag.  The tag is an integer,
6433 and indicates what property the attribute describes.  The value may be a string
6434 or an integer, and indicates how the property affects this object.  Missing
6435 attributes are the same as attributes with a zero value or empty string value.
6437 Object attributes were developed as part of the ABI for the ARM Architecture.
6438 The file format is documented in @cite{ELF for the ARM Architecture}.
6440 @menu
6441 * GNU Object Attributes::               @sc{gnu} Object Attributes
6442 * Defining New Object Attributes::      Defining New Object Attributes
6443 @end menu
6445 @node GNU Object Attributes
6446 @section @sc{gnu} Object Attributes
6448 The @code{.gnu_attribute} directive records an object attribute
6449 with vendor @samp{gnu}.
6451 Except for @samp{Tag_compatibility}, which has both an integer and a string for
6452 its value, @sc{gnu} attributes have a string value if the tag number is odd and
6453 an integer value if the tag number is even.  The second bit (@code{@var{tag} &
6454 2} is set for architecture-independent attributes and clear for
6455 architecture-dependent ones.
6457 @subsection Common @sc{gnu} attributes
6459 These attributes are valid on all architectures.
6461 @table @r
6462 @item Tag_compatibility (32)
6463 The compatibility attribute takes an integer flag value and a vendor name.  If
6464 the flag value is 0, the file is compatible with other toolchains.  If it is 1,
6465 then the file is only compatible with the named toolchain.  If it is greater
6466 than 1, the file can only be processed by other toolchains under some private
6467 arrangement indicated by the flag value and the vendor name.
6468 @end table
6470 @subsection MIPS Attributes
6472 @table @r
6473 @item Tag_GNU_MIPS_ABI_FP (4)
6474 The floating-point ABI used by this object file.  The value will be:
6476 @itemize @bullet
6477 @item
6478 0 for files not affected by the floating-point ABI.
6479 @item
6480 1 for files using the hardware floating-point with a standard double-precision
6481 FPU.
6482 @item
6483 2 for files using the hardware floating-point ABI with a single-precision FPU.
6484 @item
6485 3 for files using the software floating-point ABI.
6486 @end itemize
6487 @end table
6489 @subsection PowerPC Attributes
6491 @table @r
6492 @item Tag_GNU_Power_ABI_FP (4)
6493 The floating-point ABI used by this object file.  The value will be:
6495 @itemize @bullet
6496 @item
6497 0 for files not affected by the floating-point ABI.
6498 @item
6499 1 for files using the hardware floating-point ABI.
6500 @item
6501 2 for files using the software floating-point ABI.
6502 @end itemize
6504 @item Tag_GNU_Power_ABI_Vector (8)
6505 The vector ABI used by this object file.  The value will be:
6507 @itemize @bullet
6508 @item
6509 0 for files not affected by the vector ABI.
6510 @item
6511 1 for files using general purpose registers to pass vectors.
6512 @item
6513 2 for files using AltiVec registers to pass vectors.
6514 @item
6515 3 for files using SPE registers to pass vectors.
6516 @end itemize
6517 @end table
6519 @node Defining New Object Attributes
6520 @section Defining New Object Attributes
6522 If you want to define a new @sc{gnu} object attribute, here are the places you
6523 will need to modify.  New attributes should be discussed on the @samp{binutils}
6524 mailing list.
6526 @itemize @bullet
6527 @item
6528 This manual, which is the official register of attributes.
6529 @item
6530 The header for your architecture @file{include/elf}, to define the tag.
6531 @item
6532 The @file{bfd} support file for your architecture, to merge the attribute
6533 and issue any appropriate link warnings.
6534 @item
6535 Test cases in @file{ld/testsuite} for merging and link warnings.
6536 @item
6537 @file{binutils/readelf.c} to display your attribute.
6538 @item
6539 GCC, if you want the compiler to mark the attribute automatically.
6540 @end itemize
6542 @end ifset
6544 @ifset GENERIC
6545 @node Machine Dependencies
6546 @chapter Machine Dependent Features
6548 @cindex machine dependencies
6549 The machine instruction sets are (almost by definition) different on
6550 each machine where @command{@value{AS}} runs.  Floating point representations
6551 vary as well, and @command{@value{AS}} often supports a few additional
6552 directives or command-line options for compatibility with other
6553 assemblers on a particular platform.  Finally, some versions of
6554 @command{@value{AS}} support special pseudo-instructions for branch
6555 optimization.
6557 This chapter discusses most of these differences, though it does not
6558 include details on any machine's instruction set.  For details on that
6559 subject, see the hardware manufacturer's manual.
6561 @menu
6562 @ifset ALPHA
6563 * Alpha-Dependent::             Alpha Dependent Features
6564 @end ifset
6565 @ifset ARC
6566 * ARC-Dependent::               ARC Dependent Features
6567 @end ifset
6568 @ifset ARM
6569 * ARM-Dependent::               ARM Dependent Features
6570 @end ifset
6571 @ifset AVR
6572 * AVR-Dependent::               AVR Dependent Features
6573 @end ifset
6574 @ifset BFIN
6575 * BFIN-Dependent::              BFIN Dependent Features
6576 @end ifset
6577 @ifset CR16
6578 * CR16-Dependent::              CR16 Dependent Features
6579 @end ifset
6580 @ifset CRIS
6581 * CRIS-Dependent::              CRIS Dependent Features
6582 @end ifset
6583 @ifset D10V
6584 * D10V-Dependent::              D10V Dependent Features
6585 @end ifset
6586 @ifset D30V
6587 * D30V-Dependent::              D30V Dependent Features
6588 @end ifset
6589 @ifset H8/300
6590 * H8/300-Dependent::            Renesas H8/300 Dependent Features
6591 @end ifset
6592 @ifset HPPA
6593 * HPPA-Dependent::              HPPA Dependent Features
6594 @end ifset
6595 @ifset I370
6596 * ESA/390-Dependent::           IBM ESA/390 Dependent Features
6597 @end ifset
6598 @ifset I80386
6599 * i386-Dependent::              Intel 80386 and AMD x86-64 Dependent Features
6600 @end ifset
6601 @ifset I860
6602 * i860-Dependent::              Intel 80860 Dependent Features
6603 @end ifset
6604 @ifset I960
6605 * i960-Dependent::              Intel 80960 Dependent Features
6606 @end ifset
6607 @ifset IA64
6608 * IA-64-Dependent::             Intel IA-64 Dependent Features
6609 @end ifset
6610 @ifset IP2K
6611 * IP2K-Dependent::              IP2K Dependent Features
6612 @end ifset
6613 @ifset M32C
6614 * M32C-Dependent::              M32C Dependent Features
6615 @end ifset
6616 @ifset M32R
6617 * M32R-Dependent::              M32R Dependent Features
6618 @end ifset
6619 @ifset M680X0
6620 * M68K-Dependent::              M680x0 Dependent Features
6621 @end ifset
6622 @ifset M68HC11
6623 * M68HC11-Dependent::           M68HC11 and 68HC12 Dependent Features
6624 @end ifset
6625 @ifset MIPS
6626 * MIPS-Dependent::              MIPS Dependent Features
6627 @end ifset
6628 @ifset MMIX
6629 * MMIX-Dependent::              MMIX Dependent Features
6630 @end ifset
6631 @ifset MSP430
6632 * MSP430-Dependent::            MSP430 Dependent Features
6633 @end ifset
6634 @ifset SH
6635 * SH-Dependent::                Renesas / SuperH SH Dependent Features
6636 * SH64-Dependent::              SuperH SH64 Dependent Features
6637 @end ifset
6638 @ifset PDP11
6639 * PDP-11-Dependent::            PDP-11 Dependent Features
6640 @end ifset
6641 @ifset PJ
6642 * PJ-Dependent::                picoJava Dependent Features
6643 @end ifset
6644 @ifset PPC
6645 * PPC-Dependent::               PowerPC Dependent Features
6646 @end ifset
6647 @ifset SPARC
6648 * Sparc-Dependent::             SPARC Dependent Features
6649 @end ifset
6650 @ifset TIC54X
6651 * TIC54X-Dependent::            TI TMS320C54x Dependent Features
6652 @end ifset
6653 @ifset V850
6654 * V850-Dependent::              V850 Dependent Features
6655 @end ifset
6656 @ifset XTENSA
6657 * Xtensa-Dependent::            Xtensa Dependent Features
6658 @end ifset
6659 @ifset Z80
6660 * Z80-Dependent::               Z80 Dependent Features
6661 @end ifset
6662 @ifset Z8000
6663 * Z8000-Dependent::             Z8000 Dependent Features
6664 @end ifset
6665 @ifset VAX
6666 * Vax-Dependent::               VAX Dependent Features
6667 @end ifset
6668 @end menu
6670 @lowersections
6671 @end ifset
6673 @c The following major nodes are *sections* in the GENERIC version, *chapters*
6674 @c in single-cpu versions.  This is mainly achieved by @lowersections.  There is a
6675 @c peculiarity: to preserve cross-references, there must be a node called
6676 @c "Machine Dependencies".  Hence the conditional nodenames in each
6677 @c major node below.  Node defaulting in makeinfo requires adjacency of
6678 @c node and sectioning commands; hence the repetition of @chapter BLAH
6679 @c in both conditional blocks.
6681 @ifset ALPHA
6682 @include c-alpha.texi
6683 @end ifset
6685 @ifset ARC
6686 @include c-arc.texi
6687 @end ifset
6689 @ifset ARM
6690 @include c-arm.texi
6691 @end ifset
6693 @ifset AVR
6694 @include c-avr.texi
6695 @end ifset
6697 @ifset BFIN
6698 @include c-bfin.texi
6699 @end ifset
6701 @ifset CR16
6702 @include c-cr16.texi
6703 @end ifset
6705 @ifset CRIS
6706 @include c-cris.texi
6707 @end ifset
6709 @ifset Renesas-all
6710 @ifclear GENERIC
6711 @node Machine Dependencies
6712 @chapter Machine Dependent Features
6714 The machine instruction sets are different on each Renesas chip family,
6715 and there are also some syntax differences among the families.  This
6716 chapter describes the specific @command{@value{AS}} features for each
6717 family.
6719 @menu
6720 * H8/300-Dependent::            Renesas H8/300 Dependent Features
6721 * SH-Dependent::                Renesas SH Dependent Features
6722 @end menu
6723 @lowersections
6724 @end ifclear
6725 @end ifset
6727 @ifset D10V
6728 @include c-d10v.texi
6729 @end ifset
6731 @ifset D30V
6732 @include c-d30v.texi
6733 @end ifset
6735 @ifset H8/300
6736 @include c-h8300.texi
6737 @end ifset
6739 @ifset HPPA
6740 @include c-hppa.texi
6741 @end ifset
6743 @ifset I370
6744 @include c-i370.texi
6745 @end ifset
6747 @ifset I80386
6748 @include c-i386.texi
6749 @end ifset
6751 @ifset I860
6752 @include c-i860.texi
6753 @end ifset
6755 @ifset I960
6756 @include c-i960.texi
6757 @end ifset
6759 @ifset IA64
6760 @include c-ia64.texi
6761 @end ifset
6763 @ifset IP2K
6764 @include c-ip2k.texi
6765 @end ifset
6767 @ifset M32C
6768 @include c-m32c.texi
6769 @end ifset
6771 @ifset M32R
6772 @include c-m32r.texi
6773 @end ifset
6775 @ifset M680X0
6776 @include c-m68k.texi
6777 @end ifset
6779 @ifset M68HC11
6780 @include c-m68hc11.texi
6781 @end ifset
6783 @ifset MIPS
6784 @include c-mips.texi
6785 @end ifset
6787 @ifset MMIX
6788 @include c-mmix.texi
6789 @end ifset
6791 @ifset MSP430
6792 @include c-msp430.texi
6793 @end ifset
6795 @ifset NS32K
6796 @include c-ns32k.texi
6797 @end ifset
6799 @ifset PDP11
6800 @include c-pdp11.texi
6801 @end ifset
6803 @ifset PJ
6804 @include c-pj.texi
6805 @end ifset
6807 @ifset PPC
6808 @include c-ppc.texi
6809 @end ifset
6811 @ifset SH
6812 @include c-sh.texi
6813 @include c-sh64.texi
6814 @end ifset
6816 @ifset SPARC
6817 @include c-sparc.texi
6818 @end ifset
6820 @ifset TIC54X
6821 @include c-tic54x.texi
6822 @end ifset
6824 @ifset Z80
6825 @include c-z80.texi
6826 @end ifset
6828 @ifset Z8000
6829 @include c-z8k.texi
6830 @end ifset
6832 @ifset VAX
6833 @include c-vax.texi
6834 @end ifset
6836 @ifset V850
6837 @include c-v850.texi
6838 @end ifset
6840 @ifset XTENSA
6841 @include c-xtensa.texi
6842 @end ifset
6844 @ifset GENERIC
6845 @c reverse effect of @down at top of generic Machine-Dep chapter
6846 @raisesections
6847 @end ifset
6849 @node Reporting Bugs
6850 @chapter Reporting Bugs
6851 @cindex bugs in assembler
6852 @cindex reporting bugs in assembler
6854 Your bug reports play an essential role in making @command{@value{AS}} reliable.
6856 Reporting a bug may help you by bringing a solution to your problem, or it may
6857 not.  But in any case the principal function of a bug report is to help the
6858 entire community by making the next version of @command{@value{AS}} work better.
6859 Bug reports are your contribution to the maintenance of @command{@value{AS}}.
6861 In order for a bug report to serve its purpose, you must include the
6862 information that enables us to fix the bug.
6864 @menu
6865 * Bug Criteria::                Have you found a bug?
6866 * Bug Reporting::               How to report bugs
6867 @end menu
6869 @node Bug Criteria
6870 @section Have You Found a Bug?
6871 @cindex bug criteria
6873 If you are not sure whether you have found a bug, here are some guidelines:
6875 @itemize @bullet
6876 @cindex fatal signal
6877 @cindex assembler crash
6878 @cindex crash of assembler
6879 @item
6880 If the assembler gets a fatal signal, for any input whatever, that is a
6881 @command{@value{AS}} bug.  Reliable assemblers never crash.
6883 @cindex error on valid input
6884 @item
6885 If @command{@value{AS}} produces an error message for valid input, that is a bug.
6887 @cindex invalid input
6888 @item
6889 If @command{@value{AS}} does not produce an error message for invalid input, that
6890 is a bug.  However, you should note that your idea of ``invalid input'' might
6891 be our idea of ``an extension'' or ``support for traditional practice''.
6893 @item
6894 If you are an experienced user of assemblers, your suggestions for improvement
6895 of @command{@value{AS}} are welcome in any case.
6896 @end itemize
6898 @node Bug Reporting
6899 @section How to Report Bugs
6900 @cindex bug reports
6901 @cindex assembler bugs, reporting
6903 A number of companies and individuals offer support for @sc{gnu} products.  If
6904 you obtained @command{@value{AS}} from a support organization, we recommend you
6905 contact that organization first.
6907 You can find contact information for many support companies and
6908 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
6909 distribution.
6911 @ifset BUGURL
6912 In any event, we also recommend that you send bug reports for @command{@value{AS}}
6913 to @value{BUGURL}.
6914 @end ifset
6916 The fundamental principle of reporting bugs usefully is this:
6917 @strong{report all the facts}.  If you are not sure whether to state a
6918 fact or leave it out, state it!
6920 Often people omit facts because they think they know what causes the problem
6921 and assume that some details do not matter.  Thus, you might assume that the
6922 name of a symbol you use in an example does not matter.  Well, probably it does
6923 not, but one cannot be sure.  Perhaps the bug is a stray memory reference which
6924 happens to fetch from the location where that name is stored in memory;
6925 perhaps, if the name were different, the contents of that location would fool
6926 the assembler into doing the right thing despite the bug.  Play it safe and
6927 give a specific, complete example.  That is the easiest thing for you to do,
6928 and the most helpful.
6930 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
6931 it is new to us.  Therefore, always write your bug reports on the assumption
6932 that the bug has not been reported previously.
6934 Sometimes people give a few sketchy facts and ask, ``Does this ring a
6935 bell?''  This cannot help us fix a bug, so it is basically useless.  We
6936 respond by asking for enough details to enable us to investigate.
6937 You might as well expedite matters by sending them to begin with.
6939 To enable us to fix the bug, you should include all these things:
6941 @itemize @bullet
6942 @item
6943 The version of @command{@value{AS}}.  @command{@value{AS}} announces it if you start
6944 it with the @samp{--version} argument.
6946 Without this, we will not know whether there is any point in looking for
6947 the bug in the current version of @command{@value{AS}}.
6949 @item
6950 Any patches you may have applied to the @command{@value{AS}} source.
6952 @item
6953 The type of machine you are using, and the operating system name and
6954 version number.
6956 @item
6957 What compiler (and its version) was used to compile @command{@value{AS}}---e.g.
6958 ``@code{gcc-2.7}''.
6960 @item
6961 The command arguments you gave the assembler to assemble your example and
6962 observe the bug.  To guarantee you will not omit something important, list them
6963 all.  A copy of the Makefile (or the output from make) is sufficient.
6965 If we were to try to guess the arguments, we would probably guess wrong
6966 and then we might not encounter the bug.
6968 @item
6969 A complete input file that will reproduce the bug.  If the bug is observed when
6970 the assembler is invoked via a compiler, send the assembler source, not the
6971 high level language source.  Most compilers will produce the assembler source
6972 when run with the @samp{-S} option.  If you are using @code{@value{GCC}}, use
6973 the options @samp{-v --save-temps}; this will save the assembler source in a
6974 file with an extension of @file{.s}, and also show you exactly how
6975 @command{@value{AS}} is being run.
6977 @item
6978 A description of what behavior you observe that you believe is
6979 incorrect.  For example, ``It gets a fatal signal.''
6981 Of course, if the bug is that @command{@value{AS}} gets a fatal signal, then we
6982 will certainly notice it.  But if the bug is incorrect output, we might not
6983 notice unless it is glaringly wrong.  You might as well not give us a chance to
6984 make a mistake.
6986 Even if the problem you experience is a fatal signal, you should still say so
6987 explicitly.  Suppose something strange is going on, such as, your copy of
6988 @command{@value{AS}} is out of sync, or you have encountered a bug in the C
6989 library on your system.  (This has happened!)  Your copy might crash and ours
6990 would not.  If you told us to expect a crash, then when ours fails to crash, we
6991 would know that the bug was not happening for us.  If you had not told us to
6992 expect a crash, then we would not be able to draw any conclusion from our
6993 observations.
6995 @item
6996 If you wish to suggest changes to the @command{@value{AS}} source, send us context
6997 diffs, as generated by @code{diff} with the @samp{-u}, @samp{-c}, or @samp{-p}
6998 option.  Always send diffs from the old file to the new file.  If you even
6999 discuss something in the @command{@value{AS}} source, refer to it by context, not
7000 by line number.
7002 The line numbers in our development sources will not match those in your
7003 sources.  Your line numbers would convey no useful information to us.
7004 @end itemize
7006 Here are some things that are not necessary:
7008 @itemize @bullet
7009 @item
7010 A description of the envelope of the bug.
7012 Often people who encounter a bug spend a lot of time investigating
7013 which changes to the input file will make the bug go away and which
7014 changes will not affect it.
7016 This is often time consuming and not very useful, because the way we
7017 will find the bug is by running a single example under the debugger
7018 with breakpoints, not by pure deduction from a series of examples.
7019 We recommend that you save your time for something else.
7021 Of course, if you can find a simpler example to report @emph{instead}
7022 of the original one, that is a convenience for us.  Errors in the
7023 output will be easier to spot, running under the debugger will take
7024 less time, and so on.
7026 However, simplification is not vital; if you do not want to do this,
7027 report the bug anyway and send us the entire test case you used.
7029 @item
7030 A patch for the bug.
7032 A patch for the bug does help us if it is a good one.  But do not omit
7033 the necessary information, such as the test case, on the assumption that
7034 a patch is all we need.  We might see problems with your patch and decide
7035 to fix the problem another way, or we might not understand it at all.
7037 Sometimes with a program as complicated as @command{@value{AS}} it is very hard to
7038 construct an example that will make the program follow a certain path through
7039 the code.  If you do not send us the example, we will not be able to construct
7040 one, so we will not be able to verify that the bug is fixed.
7042 And if we cannot understand what bug you are trying to fix, or why your
7043 patch should be an improvement, we will not install it.  A test case will
7044 help us to understand.
7046 @item
7047 A guess about what the bug is or what it depends on.
7049 Such guesses are usually wrong.  Even we cannot guess right about such
7050 things without first using the debugger to find the facts.
7051 @end itemize
7053 @node Acknowledgements
7054 @chapter Acknowledgements
7056 If you have contributed to GAS and your name isn't listed here,
7057 it is not meant as a slight.  We just don't know about it.  Send mail to the
7058 maintainer, and we'll correct the situation.  Currently 
7059 @c (January 1994), 
7060 the maintainer is Ken Raeburn (email address @code{raeburn@@cygnus.com}).
7062 Dean Elsner wrote the original @sc{gnu} assembler for the VAX.@footnote{Any
7063 more details?}
7065 Jay Fenlason maintained GAS for a while, adding support for GDB-specific debug
7066 information and the 68k series machines, most of the preprocessing pass, and
7067 extensive changes in @file{messages.c}, @file{input-file.c}, @file{write.c}.
7069 K. Richard Pixley maintained GAS for a while, adding various enhancements and
7070 many bug fixes, including merging support for several processors, breaking GAS
7071 up to handle multiple object file format back ends (including heavy rewrite,
7072 testing, an integration of the coff and b.out back ends), adding configuration
7073 including heavy testing and verification of cross assemblers and file splits
7074 and renaming, converted GAS to strictly ANSI C including full prototypes, added
7075 support for m680[34]0 and cpu32, did considerable work on i960 including a COFF
7076 port (including considerable amounts of reverse engineering), a SPARC opcode
7077 file rewrite, DECstation, rs6000, and hp300hpux host ports, updated ``know''
7078 assertions and made them work, much other reorganization, cleanup, and lint.
7080 Ken Raeburn wrote the high-level BFD interface code to replace most of the code
7081 in format-specific I/O modules.
7083 The original VMS support was contributed by David L. Kashtan.  Eric Youngdale
7084 has done much work with it since.
7086 The Intel 80386 machine description was written by Eliot Dresselhaus.
7088 Minh Tran-Le at IntelliCorp contributed some AIX 386 support.
7090 The Motorola 88k machine description was contributed by Devon Bowen of Buffalo
7091 University and Torbjorn Granlund of the Swedish Institute of Computer Science.
7093 Keith Knowles at the Open Software Foundation wrote the original MIPS back end
7094 (@file{tc-mips.c}, @file{tc-mips.h}), and contributed Rose format support
7095 (which hasn't been merged in yet).  Ralph Campbell worked with the MIPS code to
7096 support a.out format.
7098 Support for the Zilog Z8k and Renesas H8/300 processors (tc-z8k,
7099 tc-h8300), and IEEE 695 object file format (obj-ieee), was written by
7100 Steve Chamberlain of Cygnus Support.  Steve also modified the COFF back end to
7101 use BFD for some low-level operations, for use with the H8/300 and AMD 29k
7102 targets.
7104 John Gilmore built the AMD 29000 support, added @code{.include} support, and
7105 simplified the configuration of which versions accept which directives.  He
7106 updated the 68k machine description so that Motorola's opcodes always produced
7107 fixed-size instructions (e.g., @code{jsr}), while synthetic instructions
7108 remained shrinkable (@code{jbsr}).  John fixed many bugs, including true tested
7109 cross-compilation support, and one bug in relaxation that took a week and
7110 required the proverbial one-bit fix.
7112 Ian Lance Taylor of Cygnus Support merged the Motorola and MIT syntax for the
7113 68k, completed support for some COFF targets (68k, i386 SVR3, and SCO Unix),
7114 added support for MIPS ECOFF and ELF targets, wrote the initial RS/6000 and
7115 PowerPC assembler, and made a few other minor patches.
7117 Steve Chamberlain made GAS able to generate listings.
7119 Hewlett-Packard contributed support for the HP9000/300.
7121 Jeff Law wrote GAS and BFD support for the native HPPA object format (SOM)
7122 along with a fairly extensive HPPA testsuite (for both SOM and ELF object
7123 formats).  This work was supported by both the Center for Software Science at
7124 the University of Utah and Cygnus Support.
7126 Support for ELF format files has been worked on by Mark Eichin of Cygnus
7127 Support (original, incomplete implementation for SPARC), Pete Hoogenboom and
7128 Jeff Law at the University of Utah (HPPA mainly), Michael Meissner of the Open
7129 Software Foundation (i386 mainly), and Ken Raeburn of Cygnus Support (sparc,
7130 and some initial 64-bit support).
7132 Linas Vepstas added GAS support for the ESA/390 ``IBM 370'' architecture.
7134 Richard Henderson rewrote the Alpha assembler. Klaus Kaempf wrote GAS and BFD
7135 support for openVMS/Alpha.
7137 Timothy Wall, Michael Hayes, and Greg Smart contributed to the various tic*
7138 flavors.
7140 David Heine, Sterling Augustine, Bob Wilson and John Ruttenberg from Tensilica,
7141 Inc.@: added support for Xtensa processors.
7143 Several engineers at Cygnus Support have also provided many small bug fixes and
7144 configuration enhancements.
7146 Many others have contributed large or small bugfixes and enhancements.  If
7147 you have contributed significant work and are not mentioned on this list, and
7148 want to be, let us know.  Some of the history has been lost; we are not
7149 intentionally leaving anyone out.
7151 @include fdl.texi
7153 @node AS Index
7154 @unnumbered AS Index
7156 @printindex cp
7158 @bye
7159 @c Local Variables:
7160 @c fill-column: 79
7161 @c End: