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