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