* doc/as.texinfo (Statements): Remove paragraph discussing
[external/binutils.git] / gas / doc / as.texinfo
1 \input texinfo @c                               -*-Texinfo-*-
2 @c  Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 1998
3 @c  Free Software Foundation, Inc.
4 @c UPDATE!!  On future updates--
5 @c   (1)   check for new machine-dep cmdline options in
6 @c         md_parse_option definitions in config/tc-*.c
7 @c   (2)   for platform-specific directives, examine md_pseudo_op
8 @c         in config/tc-*.c
9 @c   (3)   for object-format specific directives, examine obj_pseudo_op
10 @c         in config/obj-*.c       
11 @c   (4)   portable directives in potable[] in read.c
12 @c %**start of header
13 @setfilename as.info
14 @c ---config---
15 @c defaults, config file may override:
16 @set have-stabs
17 @c ---
18 @include asconfig.texi
19 @c ---
20 @c common OR combinations of conditions
21 @ifset AOUT
22 @set aout-bout
23 @end ifset
24 @ifset ARM/Thumb
25 @set ARM
26 @end ifset
27 @ifset BOUT
28 @set aout-bout
29 @end ifset
30 @ifset H8/300
31 @set H8
32 @end ifset
33 @ifset H8/500
34 @set H8
35 @end ifset
36 @ifset SH
37 @set H8
38 @end ifset
39 @ifset HPPA
40 @set abnormal-separator
41 @end ifset
42 @c ------------
43 @ifset GENERIC
44 @settitle Using @value{AS}
45 @end ifset
46 @ifclear GENERIC
47 @settitle Using @value{AS} (@value{TARGET})
48 @end ifclear
49 @setchapternewpage odd
50 @c %**end of header
51
52 @c @smallbook
53 @c @set SMALL
54 @c WARE! Some of the machine-dependent sections contain tables of machine
55 @c instructions.  Except in multi-column format, these tables look silly.
56 @c Unfortunately, Texinfo doesn't have a general-purpose multi-col format, so
57 @c the multi-col format is faked within @example sections.
58 @c 
59 @c Again unfortunately, the natural size that fits on a page, for these tables,
60 @c is different depending on whether or not smallbook is turned on.
61 @c This matters, because of order: text flow switches columns at each page
62 @c break.
63 @c 
64 @c The format faked in this source works reasonably well for smallbook,
65 @c not well for the default large-page format.  This manual expects that if you
66 @c turn on @smallbook, you will also uncomment the "@set SMALL" to enable the
67 @c tables in question.  You can turn on one without the other at your
68 @c discretion, of course. 
69 @ifinfo
70 @set SMALL
71 @c the insn tables look just as silly in info files regardless of smallbook,
72 @c might as well show 'em anyways.
73 @end ifinfo
74
75 @ifinfo
76 @format
77 START-INFO-DIR-ENTRY
78 * As: (as).                     The GNU assembler.
79 END-INFO-DIR-ENTRY
80 @end format
81 @end ifinfo
82
83 @finalout
84 @syncodeindex ky cp
85
86 @ifinfo
87 This file documents the GNU Assembler "@value{AS}".
88
89 Copyright (C) 1991, 92, 93, 94, 95, 96, 97, 1998 Free Software Foundation, Inc.
90
91 Permission is granted to make and distribute verbatim copies of
92 this manual provided the copyright notice and this permission notice
93 are preserved on all copies.
94
95 @ignore
96 Permission is granted to process this file through Tex and print the
97 results, provided the printed document carries copying permission
98 notice identical to this one except for the removal of this paragraph
99 (this paragraph not being relevant to the printed manual).
100
101 @end ignore
102 Permission is granted to copy and distribute modified versions of this manual
103 under the conditions for verbatim copying, provided that the entire resulting
104 derived work is distributed under the terms of a permission notice identical to
105 this one.
106
107 Permission is granted to copy and distribute translations of this manual
108 into another language, under the above conditions for modified versions.
109 @end ifinfo
110
111 @titlepage
112 @title Using @value{AS}
113 @subtitle The @sc{gnu} Assembler
114 @ifclear GENERIC
115 @subtitle for the @value{TARGET} family
116 @end ifclear
117 @sp 1
118 @subtitle January 1994
119 @sp 1
120 @sp 13
121 The Free Software Foundation Inc.  thanks The Nice Computer
122 Company of Australia for loaning Dean Elsner to write the
123 first (Vax) version of @code{as} for Project @sc{gnu}.
124 The proprietors, management and staff of TNCCA thank FSF for
125 distracting the boss while they got some work
126 done.
127 @sp 3
128 @author Dean Elsner, Jay Fenlason & friends
129 @page
130 @tex
131 {\parskip=0pt
132 \hfill {\it Using {\tt @value{AS}}}\par
133 \hfill Edited by Cygnus Support\par
134 }
135 %"boxit" macro for figures:
136 %Modified from Knuth's ``boxit'' macro from TeXbook (answer to exercise 21.3)
137 \gdef\boxit#1#2{\vbox{\hrule\hbox{\vrule\kern3pt
138      \vbox{\parindent=0pt\parskip=0pt\hsize=#1\kern3pt\strut\hfil
139 #2\hfil\strut\kern3pt}\kern3pt\vrule}\hrule}}%box with visible outline
140 \gdef\ibox#1#2{\hbox to #1{#2\hfil}\kern8pt}% invisible box
141 @end tex
142
143 @vskip 0pt plus 1filll
144 Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 1998 Free Software Foundation, Inc.
145
146 Permission is granted to make and distribute verbatim copies of
147 this manual provided the copyright notice and this permission notice
148 are preserved on all copies.
149
150 Permission is granted to copy and distribute modified versions of this manual
151 under the conditions for verbatim copying, provided that the entire resulting
152 derived work is distributed under the terms of a permission notice identical to
153 this one.
154
155 Permission is granted to copy and distribute translations of this manual
156 into another language, under the above conditions for modified versions.
157 @end titlepage
158
159 @ifinfo
160 @node Top
161 @top Using @value{AS}
162
163 This file is a user guide to the @sc{gnu} assembler @code{@value{AS}}.
164 @ifclear GENERIC
165 This version of the file describes @code{@value{AS}} configured to generate
166 code for @value{TARGET} architectures.
167 @end ifclear
168 @menu
169 * Overview::                    Overview
170 * Invoking::                    Command-Line Options
171 * Syntax::                      Syntax
172 * Sections::                    Sections and Relocation
173 * Symbols::                     Symbols
174 * Expressions::                 Expressions
175 * Pseudo Ops::                  Assembler Directives
176 * Machine Dependencies::        Machine Dependent Features
177 * Reporting Bugs::              Reporting Bugs
178 * Acknowledgements::            Who Did What
179 * Index::                       Index
180 @end menu
181 @end ifinfo
182
183 @node Overview
184 @chapter Overview
185 @iftex
186 This manual is a user guide to the @sc{gnu} assembler @code{@value{AS}}.
187 @ifclear GENERIC
188 This version of the manual describes @code{@value{AS}} configured to generate
189 code for @value{TARGET} architectures.
190 @end ifclear
191 @end iftex
192
193 @cindex invocation summary
194 @cindex option summary
195 @cindex summary of options
196 Here is a brief summary of how to invoke @code{@value{AS}}.  For details,
197 @pxref{Invoking,,Comand-Line Options}.
198
199 @c We don't use deffn and friends for the following because they seem
200 @c to be limited to one line for the header.
201 @smallexample
202 @value{AS} [ -a[cdhlns][=file] ] [ -D ]  [ --defsym @var{sym}=@var{val} ]
203  [ -f ] [ --gstabs ] [ --help ] [ -I @var{dir} ] [ -J ] [ -K ] [ -L ]
204  [ --keep-locals ] [ -o @var{objfile} ] [ -R ] [ --statistics ] [ -v ]
205  [ -version ] [ --version ] [ -W ] [ -w ] [ -x ] [ -Z ]
206 @ifset A29K
207 @c am29k has no machine-dependent assembler options
208 @end ifset
209 @ifset ARC
210  [ -mbig-endian | -mlittle-endian ]
211 @end ifset
212 @ifset ARM
213  [ -m[arm]1 | -m[arm]2 | -m[arm]250 | -m[arm]3 | -m[arm]6 | -m[arm]7[t][[d]m[i]] ]
214  [ -m[arm]v2 | -m[arm]v2a | -m[arm]v3 | -m[arm]v3m | -m[arm]v4 | -m[arm]v4t ]
215  [ -mthumb | -mall ]
216  [ -mfpa10 | -mfpa11 | -mfpe-old | -mno-fpu ]
217  [ -EB | -EL ]
218  [ -mapcs-32 | -mapcs-26 ]
219 @end ifset
220 @ifset D10V
221  [ -O ]
222 @end ifset
223 @c start-sanitize-d30v
224 @ifset D30V
225  [ -O | -n | -N ]
226 @end ifset
227 @c end-sanitize-d30v
228 @ifset H8
229 @c Hitachi family chips have no machine-dependent assembler options
230 @end ifset
231 @ifset HPPA
232 @c HPPA has no machine-dependent assembler options (yet).
233 @end ifset
234 @ifset SPARC
235 @c The order here is important.  See c-sparc.texi.
236  [ -Av6 | -Av7 | -Av8 | -Asparclet | -Asparclite
237    -Av8plus | -Av8plusa | -Av9 | -Av9a ]
238  [ -xarch=v8plus | -xarch=v8plusa ] [ -bump ] [ -32 | -64 ]
239 @end ifset
240 @ifset Z8000
241 @c Z8000 has no machine-dependent assembler options
242 @end ifset
243 @ifset I960
244 @c see md_parse_option in tc-i960.c
245  [ -ACA | -ACA_A | -ACB | -ACC | -AKA | -AKB | -AKC | -AMC ]
246  [ -b ] [ -no-relax ]
247 @end ifset
248 @c start-sanitize-m32rx
249 @ifset M32R
250  [ --m32rx | --[no-]warn-explicit-parallel-conflicts | --W[n]p ]
251 @end ifset
252 @c end-sanitize-m32rx
253 @ifset M680X0
254  [ -l ] [ -m68000 | -m68010 | -m68020 | ... ]
255 @end ifset
256 @ifset MIPS
257  [ -nocpp ] [ -EL ] [ -EB ] [ -G @var{num} ] [ -mcpu=@var{CPU} ]
258  [ -mips1 ] [ -mips2 ] [ -mips3 ] [ -m4650 ] [ -no-m4650 ]
259  [ --trap ] [ --break ]
260  [ --emulation=@var{name} ]
261 @end ifset
262  [ -- | @var{files} @dots{} ]
263 @end smallexample
264
265 @table @code
266 @item -a[cdhlmns]
267 Turn on listings, in any of a variety of ways:
268
269 @table @code
270 @item -ac
271 omit false conditionals
272
273 @item -ad
274 omit debugging directives
275
276 @item -ah
277 include high-level source
278
279 @item -al
280 include assembly
281
282 @item -am
283 include macro expansions
284
285 @item -an
286 omit forms processing
287
288 @item -as
289 include symbols
290
291 @item =file
292 set the name of the listing file
293 @end table
294
295 You may combine these options; for example, use @samp{-aln} for assembly
296 listing without forms processing.  The @samp{=file} option, if used, must be
297 the last one.  By itself, @samp{-a} defaults to @samp{-ahls}.
298
299 @item -D
300 Ignored.  This option is accepted for script compatibility with calls to
301 other assemblers.
302
303 @item --defsym @var{sym}=@var{value}
304 Define the symbol @var{sym} to be @var{value} before assembling the input file.
305 @var{value} must be an integer constant.  As in C, a leading @samp{0x}
306 indicates a hexadecimal value, and a leading @samp{0} indicates an octal value.
307
308 @item -f
309 ``fast''---skip whitespace and comment preprocessing (assume source is
310 compiler output).
311
312 @item --gstabs
313 Generate stabs debugging information for each assembler line.  This
314 may help debugging assembler code, if the debugger can handle it.
315
316 @item --help
317 Print a summary of the command line options and exit.
318
319 @item -I @var{dir}
320 Add directory @var{dir} to the search list for @code{.include} directives.
321
322 @item -J
323 Don't warn about signed overflow.
324
325 @item -K
326 @ifclear DIFF-TBL-KLUGE
327 This option is accepted but has no effect on the @value{TARGET} family.
328 @end ifclear
329 @ifset DIFF-TBL-KLUGE
330 Issue warnings when difference tables altered for long displacements.
331 @end ifset
332
333 @item -L
334 @itemx --keep-locals
335 Keep (in the symbol table) local symbols.  On traditional a.out systems
336 these start with @samp{L}, but different systems have different local
337 label prefixes.
338
339 @item -o @var{objfile}
340 Name the object-file output from @code{@value{AS}} @var{objfile}.
341
342 @item -R
343 Fold the data section into the text section.
344
345 @item --statistics
346 Print the maximum space (in bytes) and total time (in seconds) used by
347 assembly.
348
349 @item --strip-local-absolute
350 Remove local absolute symbols from the outgoing symbol table.
351
352 @item -v
353 @itemx -version
354 Print the @code{as} version.
355
356 @item --version
357 Print the @code{as} version and exit.
358
359 @item -W
360 Suppress warning messages.
361
362 @item -w
363 Ignored.
364
365 @item -x
366 Ignored.
367
368 @item -Z
369 Generate an object file even after errors.
370
371 @item -- | @var{files} @dots{}
372 Standard input, or source files to assemble.
373
374 @end table
375
376 @ifset ARC
377 The following options are available when @value{AS} is configured for
378 an ARC processor.
379
380 @table @code
381
382 @cindex ARC endianness
383 @cindex endianness, ARC
384 @cindex big endian output, ARC
385 @item -mbig-endian
386 Generate ``big endian'' format output.
387
388 @cindex little endian output, ARC
389 @item -mlittle-endian
390 Generate ``little endian'' format output.
391
392 @end table
393 @end ifset
394
395 @ifset ARM
396 The following options are available when @value{AS} is configured for the ARM
397 processor family.
398
399 @table @code
400 @item -m[arm]1 | -m[arm]2 | -m[arm]250 | -m[arm]3 | -m[arm]6 | -m[arm]7[t][[d]m] | -m[arm]v2 | -m[arm]v2a | -m[arm]v3 | -m[arm]v3m | -m[arm]v4 | -m[arm]v4t 
401 Specify which variant of the ARM architecture is the target.
402 @item -mthumb | -mall
403 Enable or disable Thumb only instruction decoding.
404 @item -mfpa10 | -mfpa11 | -mfpe-old | -mno-fpu
405 Select which Floating Point architcture is the target.
406 @item -mapcs-32 | -mapcs-26
407 Select which procedure calling convention is in use.
408 @item -EB | -EL
409 Select either big-endian (-EB) or little-endian (-EL) output.
410 @end table
411 @end ifset
412
413 @ifset D10V
414 The following options are available when @value{AS} is configured for
415 a D10V processor.
416 @table @code
417 @cindex D10V optimization
418 @cindex optimization, D10V
419 @item -O
420 Optimize output by parallelizing instructions.
421 @end table
422 @end ifset
423
424 @c start-sanitize-d30v
425 @ifset D30V
426 The following options are available when @value{AS} is configured for a D30V
427 processor.
428 @table @code
429 @cindex D30V optimization
430 @cindex optimization, D30V
431 @item -O
432 Optimize output by parallelizing instructions.
433
434 @cindex D30V nops
435 @item -n
436 Warn when nops are generated.
437
438 @cindex D30V nops after 32-bit multiply
439 @item -N
440 Warn when a nop after a 32-bit multiply instruction is generated.
441 @end table
442 @end ifset
443 @c end-sanitize-d30v
444
445 @ifset I960
446 The following options are available when @value{AS} is configured for the
447 Intel 80960 processor.
448
449 @table @code
450 @item -ACA | -ACA_A | -ACB | -ACC | -AKA | -AKB | -AKC | -AMC
451 Specify which variant of the 960 architecture is the target.
452
453 @item -b
454 Add code to collect statistics about branches taken.
455
456 @item -no-relax
457 Do not alter compare-and-branch instructions for long displacements;
458 error if necessary.
459
460 @end table
461 @end ifset
462
463 @c start-sanitize-m32rx
464 @ifset M32R
465 The following options are available when @value{AS} is configured for the
466 Mitsubishi M32R series.
467
468 @table @code
469
470 @item --m32rx
471 Specify which processor in the M32R family is the target.  The default
472 is normally the M32R, but this option changes it to the M32RX.
473
474 @item --warn-explicit-parallel-conflicts or --Wp
475 Produce warning messages when questionable parallel constructs are
476 encountered. 
477
478 @item --no-warn-explicit-parallel-conflicts or --Wnp
479 Do not produce warning messages when questionable parallel constructs are 
480 encountered. 
481
482 @end table
483 @end ifset
484 @c end-sanitize-m32rx
485
486 @ifset M680X0
487 The following options are available when @value{AS} is configured for the
488 Motorola 68000 series.
489
490 @table @code
491
492 @item -l
493 Shorten references to undefined symbols, to one word instead of two.
494
495 @item -m68000 | -m68008 | -m68010 | -m68020 | -m68030 | -m68040 | -m68060
496 @itemx | -m68302 | -m68331 | -m68332 | -m68333 | -m68340 | -mcpu32 | -m5200
497 Specify what processor in the 68000 family is the target.  The default
498 is normally the 68020, but this can be changed at configuration time.
499
500 @item -m68881 | -m68882 | -mno-68881 | -mno-68882
501 The target machine does (or does not) have a floating-point coprocessor.
502 The default is to assume a coprocessor for 68020, 68030, and cpu32.  Although
503 the basic 68000 is not compatible with the 68881, a combination of the
504 two can be specified, since it's possible to do emulation of the
505 coprocessor instructions with the main processor.
506
507 @item -m68851 | -mno-68851
508 The target machine does (or does not) have a memory-management
509 unit coprocessor.  The default is to assume an MMU for 68020 and up.
510
511 @end table
512 @end ifset
513
514 @ifset SPARC
515 The following options are available when @code{@value{AS}} is configured
516 for the SPARC architecture:
517
518 @table @code
519 @item -Av6 | -Av7 | -Av8 | -Asparclet | -Asparclite
520 @itemx -Av8plus | -Av8plusa | -Av9 | -Av9a
521 Explicitly select a variant of the SPARC architecture.
522
523 @samp{-Av8plus} and @samp{-Av8plusa} select a 32 bit environment.
524 @samp{-Av9} and @samp{-Av9a} select a 64 bit environment.
525
526 @samp{-Av8plusa} and @samp{-Av9a} enable the SPARC V9 instruction set with
527 UltraSPARC extensions.
528
529 @item -xarch=v8plus | -xarch=v8plusa
530 For compatibility with the Solaris v9 assembler.  These options are
531 equivalent to -Av8plus and -Av8plusa, respectively.
532
533 @item -bump
534 Warn when the assembler switches to another architecture.
535 @end table
536 @end ifset
537
538 @ifset MIPS
539 The following options are available when @value{AS} is configured for
540 a MIPS processor.
541
542 @table @code
543 @item -G @var{num}
544 This option sets the largest size of an object that can be referenced
545 implicitly with the @code{gp} register.  It is only accepted for targets that
546 use ECOFF format, such as a DECstation running Ultrix.  The default value is 8.
547
548 @cindex MIPS endianness
549 @cindex endianness, MIPS
550 @cindex big endian output, MIPS
551 @item -EB
552 Generate ``big endian'' format output.
553
554 @cindex little endian output, MIPS
555 @item -EL
556 Generate ``little endian'' format output.
557
558 @cindex MIPS ISA
559 @item -mips1
560 @itemx -mips2
561 @itemx -mips3
562 Generate code for a particular MIPS Instruction Set Architecture level.
563 @samp{-mips1} corresponds to the @sc{r2000} and @sc{r3000} processors,
564 @samp{-mips2} to the @sc{r6000} processor, and @samp{-mips3} to the @sc{r4000}
565 processor.
566
567 @item -m4650
568 @itemx -no-m4650
569 Generate code for the MIPS @sc{r4650} chip.  This tells the assembler to accept
570 the @samp{mad} and @samp{madu} instruction, and to not schedule @samp{nop}
571 instructions around accesses to the @samp{HI} and @samp{LO} registers.
572 @samp{-no-m4650} turns off this option.
573
574 @item -mcpu=@var{CPU}
575 Generate code for a particular MIPS cpu.  This has little effect on the
576 assembler, but it is passed by @code{@value{GCC}}.
577
578 @cindex emulation
579 @item --emulation=@var{name}
580 This option causes @code{@value{AS}} to emulate @code{@value{AS}} configured
581 for some other target, in all respects, including output format (choosing
582 between ELF and ECOFF only), handling of pseudo-opcodes which may generate
583 debugging information or store symbol table information, and default
584 endianness.  The available configuration names are: @samp{mipsecoff},
585 @samp{mipself}, @samp{mipslecoff}, @samp{mipsbecoff}, @samp{mipslelf},
586 @samp{mipsbelf}.  The first two do not alter the default endianness from that
587 of the primary target for which the assembler was configured; the others change
588 the default to little- or big-endian as indicated by the @samp{b} or @samp{l}
589 in the name.  Using @samp{-EB} or @samp{-EL} will override the endianness
590 selection in any case.
591
592 This option is currently supported only when the primary target
593 @code{@value{AS}} is configured for is a MIPS ELF or ECOFF target.
594 Furthermore, the primary target or others specified with
595 @samp{--enable-targets=@dots{}} at configuration time must include support for
596 the other format, if both are to be available.  For example, the Irix 5
597 configuration includes support for both.
598
599 Eventually, this option will support more configurations, with more
600 fine-grained control over the assembler's behavior, and will be supported for
601 more processors.
602
603 @item -nocpp
604 @code{@value{AS}} ignores this option.  It is accepted for compatibility with
605 the native tools.
606
607 @need 900
608 @item --trap
609 @itemx --no-trap
610 @itemx --break
611 @itemx --no-break
612 Control how to deal with multiplication overflow and division by zero.
613 @samp{--trap} or @samp{--no-break} (which are synonyms) take a trap exception
614 (and only work for Instruction Set Architecture level 2 and higher);
615 @samp{--break} or @samp{--no-trap} (also synonyms, and the default) take a
616 break exception.
617 @end table
618 @end ifset
619
620 @menu
621 * Manual::                      Structure of this Manual
622 * GNU Assembler::               The GNU Assembler
623 * Object Formats::              Object File Formats
624 * Command Line::                Command Line
625 * Input Files::                 Input Files
626 * Object::                      Output (Object) File
627 * Errors::                      Error and Warning Messages
628 @end menu
629
630 @node Manual
631 @section Structure of this Manual
632
633 @cindex manual, structure and purpose
634 This manual is intended to describe what you need to know to use
635 @sc{gnu} @code{@value{AS}}.  We cover the syntax expected in source files, including
636 notation for symbols, constants, and expressions; the directives that
637 @code{@value{AS}} understands; and of course how to invoke @code{@value{AS}}.
638
639 @ifclear GENERIC
640 We also cover special features in the @value{TARGET}
641 configuration of @code{@value{AS}}, including assembler directives.
642 @end ifclear
643 @ifset GENERIC
644 This manual also describes some of the machine-dependent features of
645 various flavors of the assembler.
646 @end ifset
647
648 @cindex machine instructions (not covered)
649 On the other hand, this manual is @emph{not} intended as an introduction
650 to programming in assembly language---let alone programming in general!
651 In a similar vein, we make no attempt to introduce the machine
652 architecture; we do @emph{not} describe the instruction set, standard
653 mnemonics, registers or addressing modes that are standard to a
654 particular architecture.
655 @ifset GENERIC
656 You may want to consult the manufacturer's
657 machine architecture manual for this information.
658 @end ifset
659 @ifclear GENERIC
660 @ifset H8/300
661 For information on the H8/300 machine instruction set, see @cite{H8/300
662 Series Programming Manual} (Hitachi ADE--602--025).  For the H8/300H,
663 see @cite{H8/300H Series Programming Manual} (Hitachi).
664 @end ifset
665 @ifset H8/500
666 For information on the H8/500 machine instruction set, see @cite{H8/500
667 Series Programming Manual} (Hitachi M21T001).
668 @end ifset
669 @ifset SH
670 For information on the Hitachi SH machine instruction set, see
671 @cite{SH-Microcomputer User's Manual} (Hitachi Micro Systems, Inc.).
672 @end ifset
673 @ifset Z8000
674 For information on the Z8000 machine instruction set, see @cite{Z8000 CPU Technical Manual}
675 @end ifset
676 @end ifclear
677
678 @c I think this is premature---doc@cygnus.com, 17jan1991
679 @ignore
680 Throughout this manual, we assume that you are running @dfn{GNU},
681 the portable operating system from the @dfn{Free Software
682 Foundation, Inc.}.  This restricts our attention to certain kinds of
683 computer (in particular, the kinds of computers that @sc{gnu} can run on);
684 once this assumption is granted examples and definitions need less
685 qualification.
686
687 @code{@value{AS}} is part of a team of programs that turn a high-level
688 human-readable series of instructions into a low-level
689 computer-readable series of instructions.  Different versions of
690 @code{@value{AS}} are used for different kinds of computer.
691 @end ignore
692
693 @c There used to be a section "Terminology" here, which defined
694 @c "contents", "byte", "word", and "long".  Defining "word" to any
695 @c particular size is confusing when the .word directive may generate 16
696 @c bits on one machine and 32 bits on another; in general, for the user
697 @c version of this manual, none of these terms seem essential to define.
698 @c They were used very little even in the former draft of the manual;
699 @c this draft makes an effort to avoid them (except in names of
700 @c directives).
701
702 @node GNU Assembler
703 @section The GNU Assembler
704
705 @sc{gnu} @code{as} is really a family of assemblers.
706 @ifclear GENERIC
707 This manual describes @code{@value{AS}}, a member of that family which is
708 configured for the @value{TARGET} architectures.
709 @end ifclear
710 If you use (or have used) the @sc{gnu} assembler on one architecture, you
711 should find a fairly similar environment when you use it on another
712 architecture.  Each version has much in common with the others,
713 including object file formats, most assembler directives (often called
714 @dfn{pseudo-ops}) and assembler syntax.@refill
715
716 @cindex purpose of @sc{gnu} assembler
717 @code{@value{AS}} is primarily intended to assemble the output of the
718 @sc{gnu} C compiler @code{@value{GCC}} for use by the linker
719 @code{@value{LD}}.  Nevertheless, we've tried to make @code{@value{AS}}
720 assemble correctly everything that other assemblers for the same
721 machine would assemble.
722 @ifset VAX
723 Any exceptions are documented explicitly (@pxref{Machine Dependencies}).
724 @end ifset
725 @ifset M680X0
726 @c This remark should appear in generic version of manual; assumption
727 @c here is that generic version sets M680x0.
728 This doesn't mean @code{@value{AS}} always uses the same syntax as another
729 assembler for the same architecture; for example, we know of several
730 incompatible versions of 680x0 assembly language syntax.
731 @end ifset
732
733 Unlike older assemblers, @code{@value{AS}} is designed to assemble a source
734 program in one pass of the source file.  This has a subtle impact on the
735 @kbd{.org} directive (@pxref{Org,,@code{.org}}).
736
737 @node Object Formats
738 @section Object File Formats
739
740 @cindex object file format
741 The @sc{gnu} assembler can be configured to produce several alternative
742 object file formats.  For the most part, this does not affect how you
743 write assembly language programs; but directives for debugging symbols
744 are typically different in different file formats.  @xref{Symbol
745 Attributes,,Symbol Attributes}.
746 @ifclear GENERIC
747 @ifclear MULTI-OBJ
748 On the @value{TARGET}, @code{@value{AS}} is configured to produce
749 @value{OBJ-NAME} format object files.
750 @end ifclear
751 @c The following should exhaust all configs that set MULTI-OBJ, ideally
752 @ifset A29K
753 On the @value{TARGET}, @code{@value{AS}} can be configured to produce either
754 @code{a.out} or COFF format object files.
755 @end ifset
756 @ifset I960
757 On the @value{TARGET}, @code{@value{AS}} can be configured to produce either
758 @code{b.out} or COFF format object files.
759 @end ifset
760 @ifset HPPA
761 On the @value{TARGET}, @code{@value{AS}} can be configured to produce either
762 SOM or ELF format object files.
763 @end ifset
764 @end ifclear
765
766 @node Command Line
767 @section Command Line
768
769 @cindex command line conventions
770 After the program name @code{@value{AS}}, the command line may contain
771 options and file names.  Options may appear in any order, and may be
772 before, after, or between file names.  The order of file names is
773 significant.
774
775 @cindex standard input, as input file
776 @kindex --
777 @file{--} (two hyphens) by itself names the standard input file
778 explicitly, as one of the files for @code{@value{AS}} to assemble.
779
780 @cindex options, command line
781 Except for @samp{--} any command line argument that begins with a
782 hyphen (@samp{-}) is an option.  Each option changes the behavior of
783 @code{@value{AS}}.  No option changes the way another option works.  An
784 option is a @samp{-} followed by one or more letters; the case of
785 the letter is important.   All options are optional.
786
787 Some options expect exactly one file name to follow them.  The file
788 name may either immediately follow the option's letter (compatible
789 with older assemblers) or it may be the next command argument (@sc{gnu}
790 standard).  These two command lines are equivalent:
791
792 @smallexample
793 @value{AS} -o my-object-file.o mumble.s
794 @value{AS} -omy-object-file.o mumble.s
795 @end smallexample
796
797 @node Input Files
798 @section Input Files
799
800 @cindex input
801 @cindex source program
802 @cindex files, input
803 We use the phrase @dfn{source program}, abbreviated @dfn{source}, to
804 describe the program input to one run of @code{@value{AS}}.  The program may
805 be in one or more files; how the source is partitioned into files
806 doesn't change the meaning of the source.
807
808 @c I added "con" prefix to "catenation" just to prove I can overcome my
809 @c APL training...   doc@cygnus.com
810 The source program is a concatenation of the text in all the files, in the
811 order specified.
812
813 Each time you run @code{@value{AS}} it assembles exactly one source
814 program.  The source program is made up of one or more files.
815 (The standard input is also a file.)
816
817 You give @code{@value{AS}} a command line that has zero or more input file
818 names.  The input files are read (from left file name to right).  A
819 command line argument (in any position) that has no special meaning
820 is taken to be an input file name.
821
822 If you give @code{@value{AS}} no file names it attempts to read one input file
823 from the @code{@value{AS}} standard input, which is normally your terminal.  You
824 may have to type @key{ctl-D} to tell @code{@value{AS}} there is no more program
825 to assemble.
826
827 Use @samp{--} if you need to explicitly name the standard input file
828 in your command line.
829
830 If the source is empty, @code{@value{AS}} produces a small, empty object
831 file.
832
833 @subheading Filenames and Line-numbers
834
835 @cindex input file linenumbers
836 @cindex line numbers, in input files
837 There are two ways of locating a line in the input file (or files) and
838 either may be used in reporting error messages.  One way refers to a line
839 number in a physical file; the other refers to a line number in a
840 ``logical'' file.  @xref{Errors, ,Error and Warning Messages}.
841
842 @dfn{Physical files} are those files named in the command line given
843 to @code{@value{AS}}.
844
845 @dfn{Logical files} are simply names declared explicitly by assembler
846 directives; they bear no relation to physical files.  Logical file names
847 help error messages reflect the original source file, when @code{@value{AS}}
848 source is itself synthesized from other files.
849 @xref{App-File,,@code{.app-file}}.
850
851 @node Object
852 @section Output (Object) File
853
854 @cindex object file
855 @cindex output file
856 @kindex a.out
857 @kindex .o
858 Every time you run @code{@value{AS}} it produces an output file, which is
859 your assembly language program translated into numbers.  This file
860 is the object file.  Its default name is
861 @ifclear BOUT
862 @code{a.out}.
863 @end ifclear
864 @ifset BOUT
865 @ifset GENERIC
866 @code{a.out}, or 
867 @end ifset
868 @code{b.out} when @code{@value{AS}} is configured for the Intel 80960.
869 @end ifset
870 You can give it another name by using the @code{-o} option.  Conventionally,
871 object file names end with @file{.o}.  The default name is used for historical
872 reasons: older assemblers were capable of assembling self-contained programs
873 directly into a runnable program.  (For some formats, this isn't currently
874 possible, but it can be done for the @code{a.out} format.)
875
876 @cindex linker
877 @kindex ld
878 The object file is meant for input to the linker @code{@value{LD}}.  It contains
879 assembled program code, information to help @code{@value{LD}} integrate
880 the assembled program into a runnable file, and (optionally) symbolic
881 information for the debugger.
882
883 @c link above to some info file(s) like the description of a.out.
884 @c don't forget to describe @sc{gnu} info as well as Unix lossage.
885
886 @node Errors
887 @section Error and Warning Messages
888
889 @cindex error messsages
890 @cindex warning messages
891 @cindex messages from assembler
892 @code{@value{AS}} may write warnings and error messages to the standard error
893 file (usually your terminal).  This should not happen when  a compiler
894 runs @code{@value{AS}} automatically.  Warnings report an assumption made so
895 that @code{@value{AS}} could keep assembling a flawed program; errors report a
896 grave problem that stops the assembly.
897
898 @cindex format of warning messages
899 Warning messages have the format
900
901 @smallexample
902 file_name:@b{NNN}:Warning Message Text
903 @end smallexample
904
905 @noindent
906 @cindex line numbers, in warnings/errors
907 (where @b{NNN} is a line number).  If a logical file name has been given
908 (@pxref{App-File,,@code{.app-file}}) it is used for the filename,
909 otherwise the name of the current input file is used.  If a logical line
910 number was given
911 @ifset GENERIC
912 (@pxref{Line,,@code{.line}})
913 @end ifset
914 @ifclear GENERIC
915 @ifclear A29K
916 (@pxref{Line,,@code{.line}})
917 @end ifclear
918 @ifset A29K
919 (@pxref{Ln,,@code{.ln}})
920 @end ifset
921 @end ifclear
922 then it is used to calculate the number printed,
923 otherwise the actual line in the current source file is printed.  The
924 message text is intended to be self explanatory (in the grand Unix
925 tradition).
926
927 @cindex format of error messages
928 Error messages have the format
929 @smallexample
930 file_name:@b{NNN}:FATAL:Error Message Text
931 @end smallexample
932 The file name and line number are derived as for warning
933 messages.  The actual message text may be rather less explanatory
934 because many of them aren't supposed to happen.
935
936 @node Invoking
937 @chapter Command-Line Options
938
939 @cindex options, all versions of assembler
940 This chapter describes command-line options available in @emph{all}
941 versions of the @sc{gnu} assembler; @pxref{Machine Dependencies}, for options specific
942 @ifclear GENERIC
943 to the @value{TARGET}.
944 @end ifclear
945 @ifset GENERIC
946 to particular machine architectures.
947 @end ifset
948
949 If you are invoking @code{@value{AS}} via the @sc{gnu} C compiler (version 2),
950 you can use the @samp{-Wa} option to pass arguments through to the assembler.
951 The assembler arguments must be separated from each other (and the @samp{-Wa})
952 by commas.  For example:
953
954 @smallexample
955 gcc -c -g -O -Wa,-alh,-L file.c
956 @end smallexample
957
958 @noindent
959 This passes two options to the assembler: @samp{-alh} (emit a listing to
960 standard output with with high-level and assembly source) and @samp{-L} (retain
961 local symbols in the symbol table).
962
963 Usually you do not need to use this @samp{-Wa} mechanism, since many compiler
964 command-line options are automatically passed to the assembler by the compiler.
965 (You can call the @sc{gnu} compiler driver with the @samp{-v} option to see
966 precisely what options it passes to each compilation pass, including the
967 assembler.)
968
969 @menu
970 * a::             -a[cdhlns] enable listings
971 * D::             -D for compatibility
972 * f::             -f to work faster
973 * I::             -I for .include search path
974 @ifclear DIFF-TBL-KLUGE
975 * K::             -K for compatibility
976 @end ifclear
977 @ifset DIFF-TBL-KLUGE
978 * K::             -K for difference tables
979 @end ifset
980
981 * L::             -L to retain local labels
982 * M::             -M or --mri to assemble in MRI compatibility mode
983 * MD::            --MD for dependency tracking
984 * o::             -o to name the object file
985 * R::             -R to join data and text sections
986 * statistics::    --statistics to see statistics about assembly
987 * traditional-format:: --traditional-format for compatible output
988 * v::             -v to announce version
989 * W::             -W to suppress warnings
990 * Z::             -Z to make object file even after errors
991 @end menu
992
993 @node a
994 @section Enable Listings: @code{-a[cdhlns]}
995
996 @kindex -a
997 @kindex -ac
998 @kindex -ad
999 @kindex -ah
1000 @kindex -al
1001 @kindex -an
1002 @kindex -as
1003 @cindex listings, enabling
1004 @cindex assembly listings, enabling
1005
1006 These options enable listing output from the assembler.  By itself,
1007 @samp{-a} requests high-level, assembly, and symbols listing.
1008 You can use other letters to select specific options for the list:
1009 @samp{-ah} requests a high-level language listing,
1010 @samp{-al} requests an output-program assembly listing, and
1011 @samp{-as} requests a symbol table listing.
1012 High-level listings require that a compiler debugging option like
1013 @samp{-g} be used, and that assembly listings (@samp{-al}) be requested
1014 also.
1015
1016 Use the @samp{-ac} option to omit false conditionals from a listing.  Any lines
1017 which are not assembled because of a false @code{.if} (or @code{.ifdef}, or any
1018 other conditional), or a true @code{.if} followed by an @code{.else}, will be
1019 omitted from the listing.
1020
1021 Use the @samp{-ad} option to omit debugging directives from the
1022 listing.
1023
1024 Once you have specified one of these options, you can further control
1025 listing output and its appearance using the directives @code{.list},
1026 @code{.nolist}, @code{.psize}, @code{.eject}, @code{.title}, and
1027 @code{.sbttl}.
1028 The @samp{-an} option turns off all forms processing.
1029 If you do not request listing output with one of the @samp{-a} options, the
1030 listing-control directives have no effect.
1031
1032 The letters after @samp{-a} may be combined into one option,
1033 @emph{e.g.}, @samp{-aln}.
1034
1035 @node D
1036 @section @code{-D}
1037
1038 @kindex -D
1039 This option has no effect whatsoever, but it is accepted to make it more
1040 likely that scripts written for other assemblers also work with
1041 @code{@value{AS}}.
1042
1043 @node f
1044 @section Work Faster: @code{-f}
1045
1046 @kindex -f
1047 @cindex trusted compiler
1048 @cindex faster processing (@code{-f})
1049 @samp{-f} should only be used when assembling programs written by a
1050 (trusted) compiler.  @samp{-f} stops the assembler from doing whitespace
1051 and comment preprocessing on
1052 the input file(s) before assembling them.  @xref{Preprocessing,
1053 ,Preprocessing}.
1054
1055 @quotation
1056 @emph{Warning:} if you use @samp{-f} when the files actually need to be
1057 preprocessed (if they contain comments, for example), @code{@value{AS}} does
1058 not work correctly.
1059 @end quotation
1060
1061 @node I
1062 @section @code{.include} search path: @code{-I} @var{path}
1063
1064 @kindex -I @var{path}
1065 @cindex paths for @code{.include}
1066 @cindex search path for @code{.include}
1067 @cindex @code{include} directive search path
1068 Use this option to add a @var{path} to the list of directories
1069 @code{@value{AS}} searches for files specified in @code{.include}
1070 directives (@pxref{Include,,@code{.include}}).  You may use @code{-I} as
1071 many times as necessary to include a variety of paths.  The current
1072 working directory is always searched first; after that, @code{@value{AS}}
1073 searches any @samp{-I} directories in the same order as they were
1074 specified (left to right) on the command line.
1075
1076 @node K
1077 @section Difference Tables: @code{-K}
1078
1079 @kindex -K
1080 @ifclear DIFF-TBL-KLUGE
1081 On the @value{TARGET} family, this option is allowed, but has no effect.  It is
1082 permitted for compatibility with the @sc{gnu} assembler on other platforms,
1083 where it can be used to warn when the assembler alters the machine code
1084 generated for @samp{.word} directives in difference tables.  The @value{TARGET}
1085 family does not have the addressing limitations that sometimes lead to this
1086 alteration on other platforms.
1087 @end ifclear
1088
1089 @ifset DIFF-TBL-KLUGE
1090 @cindex difference tables, warning
1091 @cindex warning for altered difference tables
1092 @code{@value{AS}} sometimes alters the code emitted for directives of the form
1093 @samp{.word @var{sym1}-@var{sym2}}; @pxref{Word,,@code{.word}}.
1094 You can use the @samp{-K} option if you want a warning issued when this
1095 is done.
1096 @end ifset
1097
1098 @node L
1099 @section Include Local Labels: @code{-L}
1100
1101 @kindex -L
1102 @cindex local labels, retaining in output
1103 Labels beginning with @samp{L} (upper case only) are called @dfn{local
1104 labels}. @xref{Symbol Names}.  Normally you do not see such labels when
1105 debugging, because they are intended for the use of programs (like
1106 compilers) that compose assembler programs, not for your notice.
1107 Normally both @code{@value{AS}} and @code{@value{LD}} discard such labels, so you do not
1108 normally debug with them.
1109
1110 This option tells @code{@value{AS}} to retain those @samp{L@dots{}} symbols
1111 in the object file.  Usually if you do this you also tell the linker
1112 @code{@value{LD}} to preserve symbols whose names begin with @samp{L}.
1113
1114 By default, a local label is any label beginning with @samp{L}, but each
1115 target is allowed to redefine the local label prefix.
1116 @ifset HPPA
1117 On the HPPA local labels begin with @samp{L$}.
1118 @end ifset
1119 @ifset ARM
1120 @samp{;} for the ARM family;
1121 @end ifset
1122
1123 @node M
1124 @section Assemble in MRI Compatibility Mode: @code{-M}
1125
1126 @kindex -M
1127 @cindex MRI compatibility mode
1128 The @code{-M} or @code{--mri} option selects MRI compatibility mode.  This
1129 changes the syntax and pseudo-op handling of @code{@value{AS}} to make it
1130 compatible with the @code{ASM68K} or the @code{ASM960} (depending upon the
1131 configured target) assembler from Microtec Research.  The exact nature of the
1132 MRI syntax will not be documented here; see the MRI manuals for more
1133 information.  Note in particular that the handling of macros and macro
1134 arguments is somewhat different.  The purpose of this option is to permit
1135 assembling existing MRI assembler code using @code{@value{AS}}.
1136
1137 The MRI compatibility is not complete.  Certain operations of the MRI assembler
1138 depend upon its object file format, and can not be supported using other object
1139 file formats.  Supporting these would require enhancing each object file format
1140 individually.  These are:
1141
1142 @itemize @bullet
1143 @item global symbols in common section
1144
1145 The m68k MRI assembler supports common sections which are merged by the linker.
1146 Other object file formats do not support this.  @code{@value{AS}} handles
1147 common sections by treating them as a single common symbol.  It permits local
1148 symbols to be defined within a common section, but it can not support global
1149 symbols, since it has no way to describe them.
1150
1151 @item complex relocations
1152
1153 The MRI assemblers support relocations against a negated section address, and
1154 relocations which combine the start addresses of two or more sections.  These
1155 are not support by other object file formats.
1156
1157 @item @code{END} pseudo-op specifying start address
1158
1159 The MRI @code{END} pseudo-op permits the specification of a start address.
1160 This is not supported by other object file formats.  The start address may
1161 instead be specified using the @code{-e} option to the linker, or in a linker
1162 script.
1163
1164 @item @code{IDNT}, @code{.ident} and @code{NAME} pseudo-ops
1165
1166 The MRI @code{IDNT}, @code{.ident} and @code{NAME} pseudo-ops assign a module
1167 name to the output file.  This is not supported by other object file formats.
1168
1169 @item @code{ORG} pseudo-op
1170
1171 The m68k MRI @code{ORG} pseudo-op begins an absolute section at a given
1172 address.  This differs from the usual @code{@value{AS}} @code{.org} pseudo-op,
1173 which changes the location within the current section.  Absolute sections are
1174 not supported by other object file formats.  The address of a section may be
1175 assigned within a linker script.
1176 @end itemize
1177
1178 There are some other features of the MRI assembler which are not supported by
1179 @code{@value{AS}}, typically either because they are difficult or because they
1180 seem of little consequence.  Some of these may be supported in future releases.
1181
1182 @itemize @bullet
1183
1184 @item EBCDIC strings
1185
1186 EBCDIC strings are not supported.
1187
1188 @item packed binary coded decimal
1189
1190 Packed binary coded decimal is not supported.  This means that the @code{DC.P}
1191 and @code{DCB.P} pseudo-ops are not supported.
1192
1193 @item @code{FEQU} pseudo-op
1194
1195 The m68k @code{FEQU} pseudo-op is not supported.
1196
1197 @item @code{NOOBJ} pseudo-op
1198
1199 The m68k @code{NOOBJ} pseudo-op is not supported.
1200
1201 @item @code{OPT} branch control options
1202
1203 The m68k @code{OPT} branch control options---@code{B}, @code{BRS}, @code{BRB},
1204 @code{BRL}, and @code{BRW}---are ignored.  @code{@value{AS}} automatically
1205 relaxes all branches, whether forward or backward, to an appropriate size, so
1206 these options serve no purpose.
1207
1208 @item @code{OPT} list control options
1209
1210 The following m68k @code{OPT} list control options are ignored: @code{C},
1211 @code{CEX}, @code{CL}, @code{CRE}, @code{E}, @code{G}, @code{I}, @code{M},
1212 @code{MEX}, @code{MC}, @code{MD}, @code{X}.
1213
1214 @item other @code{OPT} options
1215
1216 The following m68k @code{OPT} options are ignored: @code{NEST}, @code{O},
1217 @code{OLD}, @code{OP}, @code{P}, @code{PCO}, @code{PCR}, @code{PCS}, @code{R}.
1218
1219 @item @code{OPT} @code{D} option is default
1220
1221 The m68k @code{OPT} @code{D} option is the default, unlike the MRI assembler.
1222 @code{OPT NOD} may be used to turn it off.
1223
1224 @item @code{XREF} pseudo-op.
1225
1226 The m68k @code{XREF} pseudo-op is ignored.
1227
1228 @item @code{.debug} pseudo-op
1229
1230 The i960 @code{.debug} pseudo-op is not supported.
1231
1232 @item @code{.extended} pseudo-op
1233
1234 The i960 @code{.extended} pseudo-op is not supported.
1235
1236 @item @code{.list} pseudo-op.
1237
1238 The various options of the i960 @code{.list} pseudo-op are not supported.
1239
1240 @item @code{.optimize} pseudo-op
1241
1242 The i960 @code{.optimize} pseudo-op is not supported.
1243
1244 @item @code{.output} pseudo-op
1245
1246 The i960 @code{.output} pseudo-op is not supported.
1247
1248 @item @code{.setreal} pseudo-op
1249
1250 The i960 @code{.setreal} pseudo-op is not supported.
1251
1252 @end itemize
1253
1254 @node MD
1255 @section Dependency tracking: @code{--MD}
1256
1257 @kindex --MD
1258 @cindex dependency tracking
1259 @cindex make rules
1260
1261 @code{@value{AS}} can generate a dependency file for the file it creates.  This
1262 file consists of a single rule suitable for @code{make} describing the
1263 dependencies of the main source file.
1264
1265 The rule is written to the file named in its argument.
1266
1267 This feature is used in the automatic updating of makefiles.
1268
1269 @node o
1270 @section Name the Object File: @code{-o}
1271
1272 @kindex -o
1273 @cindex naming object file
1274 @cindex object file name
1275 There is always one object file output when you run @code{@value{AS}}.  By
1276 default it has the name
1277 @ifset GENERIC
1278 @ifset I960
1279 @file{a.out} (or @file{b.out}, for Intel 960 targets only).
1280 @end ifset
1281 @ifclear I960
1282 @file{a.out}.
1283 @end ifclear
1284 @end ifset
1285 @ifclear GENERIC
1286 @ifset I960
1287 @file{b.out}.
1288 @end ifset
1289 @ifclear I960
1290 @file{a.out}.
1291 @end ifclear
1292 @end ifclear
1293 You use this option (which takes exactly one filename) to give the
1294 object file a different name.
1295
1296 Whatever the object file is called, @code{@value{AS}} overwrites any
1297 existing file of the same name.
1298
1299 @node R
1300 @section Join Data and Text Sections: @code{-R}
1301
1302 @kindex -R
1303 @cindex data and text sections, joining
1304 @cindex text and data sections, joining
1305 @cindex joining text and data sections
1306 @cindex merging text and data sections
1307 @code{-R} tells @code{@value{AS}} to write the object file as if all
1308 data-section data lives in the text section.  This is only done at
1309 the very last moment:  your binary data are the same, but data
1310 section parts are relocated differently.  The data section part of
1311 your object file is zero bytes long because all its bytes are
1312 appended to the text section.  (@xref{Sections,,Sections and Relocation}.)
1313
1314 When you specify @code{-R} it would be possible to generate shorter
1315 address displacements (because we do not have to cross between text and
1316 data section).  We refrain from doing this simply for compatibility with
1317 older versions of @code{@value{AS}}.  In future, @code{-R} may work this way.
1318
1319 @ifset COFF
1320 When @code{@value{AS}} is configured for COFF output,
1321 this option is only useful if you use sections named @samp{.text} and
1322 @samp{.data}.
1323 @end ifset
1324
1325 @ifset HPPA
1326 @code{-R} is not supported for any of the HPPA targets.  Using
1327 @code{-R} generates a warning from @code{@value{AS}}.
1328 @end ifset
1329
1330 @node statistics
1331 @section Display Assembly Statistics: @code{--statistics}
1332
1333 @kindex --statistics
1334 @cindex statistics, about assembly
1335 @cindex time, total for assembly
1336 @cindex space used, maximum for assembly
1337 Use @samp{--statistics} to display two statistics about the resources used by
1338 @code{@value{AS}}: the maximum amount of space allocated during the assembly
1339 (in bytes), and the total execution time taken for the assembly (in @sc{cpu}
1340 seconds).
1341
1342 @node traditional-format
1343 @section Compatible output: @code{--traditional-format}
1344
1345 @kindex --traditional-format
1346 For some targets, the output of @code{@value{AS}} is different in some ways
1347 from the output of some existing assembler.  This switch requests
1348 @code{@value{AS}} to use the traditional format instead.
1349
1350 For example, it disables the exception frame optimizations which
1351 @code{@value{AS}} normally does by default on @code{@value{GCC}} output.
1352
1353 @node v
1354 @section Announce Version: @code{-v}
1355
1356 @kindex -v
1357 @kindex -version
1358 @cindex assembler version
1359 @cindex version of assembler
1360 You can find out what version of as is running by including the
1361 option @samp{-v} (which you can also spell as @samp{-version}) on the
1362 command line.
1363
1364 @node W
1365 @section Suppress Warnings: @code{-W}
1366
1367 @kindex -W
1368 @cindex suppressing warnings
1369 @cindex warnings, suppressing
1370 @code{@value{AS}} should never give a warning or error message when
1371 assembling compiler output.  But programs written by people often
1372 cause @code{@value{AS}} to give a warning that a particular assumption was
1373 made.  All such warnings are directed to the standard error file.
1374 If you use this option, no warnings are issued.  This option only
1375 affects the warning messages: it does not change any particular of how
1376 @code{@value{AS}} assembles your file.  Errors, which stop the assembly, are
1377 still reported.
1378
1379 @node Z
1380 @section Generate Object File in Spite of Errors: @code{-Z}
1381 @cindex object file, after errors
1382 @cindex errors, continuing after
1383 After an error message, @code{@value{AS}} normally produces no output.  If for
1384 some reason you are interested in object file output even after
1385 @code{@value{AS}} gives an error message on your program, use the @samp{-Z}
1386 option.  If there are any errors, @code{@value{AS}} continues anyways, and
1387 writes an object file after a final warning message of the form @samp{@var{n}
1388 errors, @var{m} warnings, generating bad object file.}
1389
1390 @node Syntax
1391 @chapter Syntax
1392
1393 @cindex machine-independent syntax
1394 @cindex syntax, machine-independent
1395 This chapter describes the machine-independent syntax allowed in a
1396 source file.  @code{@value{AS}} syntax is similar to what many other
1397 assemblers use; it is inspired by the BSD 4.2
1398 @ifclear VAX
1399 assembler.
1400 @end ifclear
1401 @ifset VAX
1402 assembler, except that @code{@value{AS}} does not assemble Vax bit-fields.
1403 @end ifset
1404
1405 @menu
1406 * Preprocessing::              Preprocessing
1407 * Whitespace::                  Whitespace
1408 * Comments::                    Comments
1409 * Symbol Intro::                Symbols
1410 * Statements::                  Statements
1411 * Constants::                   Constants
1412 @end menu
1413
1414 @node Preprocessing
1415 @section Preprocessing
1416
1417 @cindex preprocessing
1418 The @code{@value{AS}} internal preprocessor:
1419 @itemize @bullet
1420 @cindex whitespace, removed by preprocessor
1421 @item
1422 adjusts and removes extra whitespace.  It leaves one space or tab before
1423 the keywords on a line, and turns any other whitespace on the line into
1424 a single space.
1425
1426 @cindex comments, removed by preprocessor
1427 @item
1428 removes all comments, replacing them with a single space, or an
1429 appropriate number of newlines.
1430
1431 @cindex constants, converted by preprocessor
1432 @item
1433 converts character constants into the appropriate numeric values.
1434 @end itemize
1435
1436 It does not do macro processing, include file handling, or
1437 anything else you may get from your C compiler's preprocessor.  You can
1438 do include file processing with the @code{.include} directive
1439 (@pxref{Include,,@code{.include}}).  You can use the @sc{gnu} C compiler driver
1440 to get other ``CPP'' style preprocessing, by giving the input file a
1441 @samp{.S} suffix.  @xref{Overall Options,, Options Controlling the Kind of
1442 Output, gcc.info, Using GNU CC}.
1443
1444 Excess whitespace, comments, and character constants
1445 cannot be used in the portions of the input text that are not
1446 preprocessed.
1447
1448 @cindex turning preprocessing on and off
1449 @cindex preprocessing, turning on and off
1450 @kindex #NO_APP
1451 @kindex #APP
1452 If the first line of an input file is @code{#NO_APP} or if you use the
1453 @samp{-f} option, whitespace and comments are not removed from the input file.
1454 Within an input file, you can ask for whitespace and comment removal in
1455 specific portions of the by putting a line that says @code{#APP} before the
1456 text that may contain whitespace or comments, and putting a line that says
1457 @code{#NO_APP} after this text.  This feature is mainly intend to support
1458 @code{asm} statements in compilers whose output is otherwise free of comments
1459 and whitespace.
1460
1461 @node Whitespace
1462 @section Whitespace
1463
1464 @cindex whitespace
1465 @dfn{Whitespace} is one or more blanks or tabs, in any order.
1466 Whitespace is used to separate symbols, and to make programs neater for
1467 people to read.  Unless within character constants
1468 (@pxref{Characters,,Character Constants}), any whitespace means the same
1469 as exactly one space.
1470
1471 @node Comments
1472 @section Comments
1473
1474 @cindex comments
1475 There are two ways of rendering comments to @code{@value{AS}}.  In both
1476 cases the comment is equivalent to one space.
1477
1478 Anything from @samp{/*} through the next @samp{*/} is a comment.
1479 This means you may not nest these comments.
1480
1481 @smallexample
1482 /*
1483   The only way to include a newline ('\n') in a comment
1484   is to use this sort of comment.
1485 */
1486
1487 /* This sort of comment does not nest. */
1488 @end smallexample
1489
1490 @cindex line comment character
1491 Anything from the @dfn{line comment} character to the next newline
1492 is considered a comment and is ignored.  The line comment character is
1493 @ifset A29K
1494 @samp{;} for the AMD 29K family;
1495 @end ifset
1496 @ifset ARC
1497 @samp{;} on the ARC;
1498 @end ifset
1499 @ifset H8/300
1500 @samp{;} for the H8/300 family;
1501 @end ifset
1502 @ifset H8/500
1503 @samp{!} for the H8/500 family;
1504 @end ifset
1505 @ifset HPPA
1506 @samp{;} for the HPPA;
1507 @end ifset
1508 @ifset I960
1509 @samp{#} on the i960;
1510 @end ifset
1511 @ifset SH
1512 @samp{!} for the Hitachi SH;
1513 @end ifset
1514 @ifset SPARC
1515 @samp{!} on the SPARC;
1516 @end ifset
1517 @ifset M32R
1518 @samp{#} on the m32r;
1519 @end ifset
1520 @ifset M680X0
1521 @samp{|} on the 680x0;
1522 @end ifset
1523 @ifset VAX
1524 @samp{#} on the Vax;
1525 @end ifset
1526 @ifset Z8000
1527 @samp{!} for the Z8000;
1528 @end ifset
1529 @ifset V850
1530 @samp{#} on the V850;
1531 @end ifset
1532 see @ref{Machine Dependencies}.  @refill
1533 @c FIXME What about i386, m88k, i860?
1534
1535 @ifset GENERIC
1536 On some machines there are two different line comment characters.  One
1537 character only begins a comment if it is the first non-whitespace character on
1538 a line, while the other always begins a comment.
1539 @end ifset
1540
1541 @ifset V850
1542 The V850 assembler also supports a double dash as starting a comment that
1543 extends to the end of the line.
1544
1545 @samp{--};
1546 @end ifset
1547
1548 @kindex #
1549 @cindex lines starting with @code{#}
1550 @cindex logical line numbers
1551 To be compatible with past assemblers, lines that begin with @samp{#} have a
1552 special interpretation.  Following the @samp{#} should be an absolute
1553 expression (@pxref{Expressions}): the logical line number of the @emph{next}
1554 line.  Then a string (@pxref{Strings,, Strings}) is allowed: if present it is a
1555 new logical file name.  The rest of the line, if any, should be whitespace.
1556
1557 If the first non-whitespace characters on the line are not numeric,
1558 the line is ignored.  (Just like a comment.)
1559
1560 @smallexample
1561                           # This is an ordinary comment.
1562 # 42-6 "new_file_name"    # New logical file name
1563                           # This is logical line # 36.
1564 @end smallexample
1565 This feature is deprecated, and may disappear from future versions
1566 of @code{@value{AS}}.
1567
1568 @node Symbol Intro
1569 @section Symbols
1570
1571 @cindex characters used in symbols
1572 @ifclear SPECIAL-SYMS
1573 A @dfn{symbol} is one or more characters chosen from the set of all
1574 letters (both upper and lower case), digits and the three characters
1575 @samp{_.$}.
1576 @end ifclear
1577 @ifset SPECIAL-SYMS
1578 @ifclear GENERIC
1579 @ifset H8
1580 A @dfn{symbol} is one or more characters chosen from the set of all
1581 letters (both upper and lower case), digits and the three characters
1582 @samp{._$}.  (Save that, on the H8/300 only, you may not use @samp{$} in
1583 symbol names.)
1584 @end ifset
1585 @end ifclear
1586 @end ifset
1587 @ifset GENERIC
1588 On most machines, you can also use @code{$} in symbol names; exceptions
1589 are noted in @ref{Machine Dependencies}.
1590 @end ifset
1591 No symbol may begin with a digit.  Case is significant.
1592 There is no length limit: all characters are significant.  Symbols are
1593 delimited by characters not in that set, or by the beginning of a file
1594 (since the source program must end with a newline, the end of a file is
1595 not a possible symbol delimiter).  @xref{Symbols}.
1596 @cindex length of symbols
1597
1598 @node Statements
1599 @section Statements
1600
1601 @cindex statements, structure of
1602 @cindex line separator character
1603 @cindex statement separator character
1604 @ifclear GENERIC
1605 @ifclear abnormal-separator
1606 A @dfn{statement} ends at a newline character (@samp{\n}) or at a
1607 semicolon (@samp{;}).  The newline or semicolon is considered part of
1608 the preceding statement.  Newlines and semicolons within character
1609 constants are an exception: they do not end statements.
1610 @end ifclear
1611 @ifset abnormal-separator
1612 @ifset A29K
1613 A @dfn{statement} ends at a newline character (@samp{\n}) or an ``at''
1614 sign (@samp{@@}).  The newline or at sign is considered part of the
1615 preceding statement.  Newlines and at signs within character constants
1616 are an exception: they do not end statements.
1617 @end ifset
1618 @ifset HPPA
1619 A @dfn{statement} ends at a newline character (@samp{\n}) or an exclamation 
1620 point (@samp{!}).  The newline or exclamation point is considered part of the
1621 preceding statement.  Newlines and exclamation points within character
1622 constants are an exception: they do not end statements.
1623 @end ifset
1624 @ifset H8
1625 A @dfn{statement} ends at a newline character (@samp{\n}); or (for the
1626 H8/300) a dollar sign (@samp{$}); or (for the
1627 Hitachi-SH or the
1628 H8/500) a semicolon
1629 (@samp{;}).  The newline or separator character is considered part of
1630 the preceding statement.  Newlines and separators within character
1631 constants are an exception: they do not end statements.
1632 @end ifset
1633 @end ifset
1634 @end ifclear
1635 @ifset GENERIC
1636 A @dfn{statement} ends at a newline character (@samp{\n}) or line
1637 separator character.  (The line separator is usually @samp{;}, unless
1638 this conflicts with the comment character; @pxref{Machine Dependencies}.)  The
1639 newline or separator character is considered part of the preceding
1640 statement.  Newlines and separators within character constants are an
1641 exception: they do not end statements.
1642 @end ifset
1643
1644 @cindex newline, required at file end
1645 @cindex EOF, newline must precede
1646 It is an error to end any statement with end-of-file:  the last
1647 character of any input file should be a newline.@refill
1648
1649 An empty statement is allowed, and may include whitespace.  It is ignored.
1650
1651 @cindex instructions and directives
1652 @cindex directives and instructions
1653 @c "key symbol" is not used elsewhere in the document; seems pedantic to
1654 @c @defn{} it in that case, as was done previously...  doc@cygnus.com,
1655 @c 13feb91.
1656 A statement begins with zero or more labels, optionally followed by a
1657 key symbol which determines what kind of statement it is.  The key
1658 symbol determines the syntax of the rest of the statement.  If the
1659 symbol begins with a dot @samp{.} then the statement is an assembler
1660 directive: typically valid for any computer.  If the symbol begins with
1661 a letter the statement is an assembly language @dfn{instruction}: it
1662 assembles into a machine language instruction.
1663 @ifset GENERIC
1664 Different versions of @code{@value{AS}} for different computers
1665 recognize different instructions.  In fact, the same symbol may
1666 represent a different instruction in a different computer's assembly
1667 language.@refill
1668 @end ifset
1669
1670 @cindex @code{:} (label)
1671 @cindex label (@code{:})
1672 A label is a symbol immediately followed by a colon (@code{:}).
1673 Whitespace before a label or after a colon is permitted, but you may not
1674 have whitespace between a label's symbol and its colon. @xref{Labels}.
1675
1676 @ifset HPPA
1677 For HPPA targets, labels need not be immediately followed by a colon, but 
1678 the definition of a label must begin in column zero.  This also implies that
1679 only one label may be defined on each line.
1680 @end ifset
1681
1682 @smallexample
1683 label:     .directive    followed by something
1684 another_label:           # This is an empty statement.
1685            instruction   operand_1, operand_2, @dots{}
1686 @end smallexample
1687
1688 @node Constants
1689 @section Constants
1690
1691 @cindex constants
1692 A constant is a number, written so that its value is known by
1693 inspection, without knowing any context.  Like this:
1694 @smallexample
1695 @group
1696 .byte  74, 0112, 092, 0x4A, 0X4a, 'J, '\J # All the same value.
1697 .ascii "Ring the bell\7"                  # A string constant.
1698 .octa  0x123456789abcdef0123456789ABCDEF0 # A bignum.
1699 .float 0f-314159265358979323846264338327\
1700 95028841971.693993751E-40                 # - pi, a flonum.
1701 @end group
1702 @end smallexample
1703
1704 @menu
1705 * Characters::                  Character Constants
1706 * Numbers::                     Number Constants
1707 @end menu
1708
1709 @node Characters
1710 @subsection Character Constants
1711
1712 @cindex character constants
1713 @cindex constants, character
1714 There are two kinds of character constants.  A @dfn{character} stands
1715 for one character in one byte and its value may be used in
1716 numeric expressions.  String constants (properly called string
1717 @emph{literals}) are potentially many bytes and their values may not be
1718 used in arithmetic expressions.
1719
1720 @menu
1721 * Strings::                     Strings
1722 * Chars::                       Characters
1723 @end menu
1724
1725 @node Strings
1726 @subsubsection Strings
1727
1728 @cindex string constants
1729 @cindex constants, string
1730 A @dfn{string} is written between double-quotes.  It may contain
1731 double-quotes or null characters.  The way to get special characters
1732 into a string is to @dfn{escape} these characters: precede them with
1733 a backslash @samp{\} character.  For example @samp{\\} represents
1734 one backslash:  the first @code{\} is an escape which tells
1735 @code{@value{AS}} to interpret the second character literally as a backslash
1736 (which prevents @code{@value{AS}} from recognizing the second @code{\} as an
1737 escape character).  The complete list of escapes follows.
1738
1739 @cindex escape codes, character
1740 @cindex character escape codes
1741 @table @kbd
1742 @c      @item \a
1743 @c      Mnemonic for ACKnowledge; for ASCII this is octal code 007.
1744 @c
1745 @cindex @code{\b} (backspace character)
1746 @cindex backspace (@code{\b})
1747 @item \b
1748 Mnemonic for backspace; for ASCII this is octal code 010.
1749
1750 @c      @item \e
1751 @c      Mnemonic for EOText; for ASCII this is octal code 004.
1752 @c
1753 @cindex @code{\f} (formfeed character)
1754 @cindex formfeed (@code{\f})
1755 @item \f
1756 Mnemonic for FormFeed; for ASCII this is octal code 014.
1757
1758 @cindex @code{\n} (newline character)
1759 @cindex newline (@code{\n})
1760 @item \n
1761 Mnemonic for newline; for ASCII this is octal code 012.
1762
1763 @c      @item \p
1764 @c      Mnemonic for prefix; for ASCII this is octal code 033, usually known as @code{escape}.
1765 @c
1766 @cindex @code{\r} (carriage return character)
1767 @cindex carriage return (@code{\r})
1768 @item \r
1769 Mnemonic for carriage-Return; for ASCII this is octal code 015.
1770
1771 @c      @item \s
1772 @c      Mnemonic for space; for ASCII this is octal code 040.  Included for compliance with
1773 @c      other assemblers.
1774 @c
1775 @cindex @code{\t} (tab)
1776 @cindex tab (@code{\t})
1777 @item \t
1778 Mnemonic for horizontal Tab; for ASCII this is octal code 011.
1779
1780 @c      @item \v
1781 @c      Mnemonic for Vertical tab; for ASCII this is octal code 013.
1782 @c      @item \x @var{digit} @var{digit} @var{digit}
1783 @c      A hexadecimal character code.  The numeric code is 3 hexadecimal digits.
1784 @c
1785 @cindex @code{\@var{ddd}} (octal character code)
1786 @cindex octal character code (@code{\@var{ddd}})
1787 @item \ @var{digit} @var{digit} @var{digit}
1788 An octal character code.  The numeric code is 3 octal digits.
1789 For compatibility with other Unix systems, 8 and 9 are accepted as digits:
1790 for example, @code{\008} has the value 010, and @code{\009} the value 011.
1791
1792 @cindex @code{\@var{xd...}} (hex character code)
1793 @cindex hex character code (@code{\@var{xd...}})
1794 @item \@code{x} @var{hex-digits...}
1795 A hex character code.  All trailing hex digits are combined.  Either upper or
1796 lower case @code{x} works.
1797
1798 @cindex @code{\\} (@samp{\} character)
1799 @cindex backslash (@code{\\})
1800 @item \\
1801 Represents one @samp{\} character.
1802
1803 @c      @item \'
1804 @c      Represents one @samp{'} (accent acute) character.
1805 @c      This is needed in single character literals
1806 @c      (@xref{Characters,,Character Constants}.) to represent
1807 @c      a @samp{'}.
1808 @c
1809 @cindex @code{\"} (doublequote character)
1810 @cindex doublequote (@code{\"})
1811 @item \"
1812 Represents one @samp{"} character.  Needed in strings to represent
1813 this character, because an unescaped @samp{"} would end the string.
1814
1815 @item \ @var{anything-else}
1816 Any other character when escaped by @kbd{\} gives a warning, but
1817 assembles as if the @samp{\} was not present.  The idea is that if
1818 you used an escape sequence you clearly didn't want the literal
1819 interpretation of the following character.  However @code{@value{AS}} has no
1820 other interpretation, so @code{@value{AS}} knows it is giving you the wrong
1821 code and warns you of the fact.
1822 @end table
1823
1824 Which characters are escapable, and what those escapes represent,
1825 varies widely among assemblers.  The current set is what we think
1826 the BSD 4.2 assembler recognizes, and is a subset of what most C
1827 compilers recognize.  If you are in doubt, do not use an escape
1828 sequence.
1829
1830 @node Chars
1831 @subsubsection Characters
1832
1833 @cindex single character constant
1834 @cindex character, single
1835 @cindex constant, single character
1836 A single character may be written as a single quote immediately
1837 followed by that character.  The same escapes apply to characters as
1838 to strings.  So if you want to write the character backslash, you
1839 must write @kbd{'\\} where the first @code{\} escapes the second
1840 @code{\}.  As you can see, the quote is an acute accent, not a
1841 grave accent.  A newline
1842 @ifclear GENERIC
1843 @ifclear abnormal-separator
1844 (or semicolon @samp{;})
1845 @end ifclear
1846 @ifset abnormal-separator
1847 @ifset A29K
1848 (or at sign @samp{@@})
1849 @end ifset
1850 @ifset H8
1851 (or dollar sign @samp{$}, for the H8/300; or semicolon @samp{;} for the
1852 Hitachi SH or
1853 H8/500)
1854 @end ifset
1855 @end ifset
1856 @end ifclear
1857 immediately following an acute accent is taken as a literal character
1858 and does not count as the end of a statement.  The value of a character
1859 constant in a numeric expression is the machine's byte-wide code for
1860 that character.  @code{@value{AS}} assumes your character code is ASCII:
1861 @kbd{'A} means 65, @kbd{'B} means 66, and so on. @refill
1862
1863 @node Numbers
1864 @subsection Number Constants
1865
1866 @cindex constants, number
1867 @cindex number constants
1868 @code{@value{AS}} distinguishes three kinds of numbers according to how they
1869 are stored in the target machine.  @emph{Integers} are numbers that
1870 would fit into an @code{int} in the C language.  @emph{Bignums} are
1871 integers, but they are stored in more than 32 bits.  @emph{Flonums}
1872 are floating point numbers, described below.
1873
1874 @menu
1875 * Integers::                    Integers
1876 * Bignums::                     Bignums
1877 * Flonums::                     Flonums
1878 @ifclear GENERIC
1879 @ifset I960
1880 * Bit Fields::                  Bit Fields
1881 @end ifset
1882 @end ifclear
1883 @end menu
1884
1885 @node Integers
1886 @subsubsection Integers
1887 @cindex integers
1888 @cindex constants, integer
1889
1890 @cindex binary integers
1891 @cindex integers, binary
1892 A binary integer is @samp{0b} or @samp{0B} followed by zero or more of
1893 the binary digits @samp{01}.
1894
1895 @cindex octal integers
1896 @cindex integers, octal
1897 An octal integer is @samp{0} followed by zero or more of the octal
1898 digits (@samp{01234567}).
1899
1900 @cindex decimal integers
1901 @cindex integers, decimal
1902 A decimal integer starts with a non-zero digit followed by zero or
1903 more digits (@samp{0123456789}).
1904
1905 @cindex hexadecimal integers
1906 @cindex integers, hexadecimal
1907 A hexadecimal integer is @samp{0x} or @samp{0X} followed by one or
1908 more hexadecimal digits chosen from @samp{0123456789abcdefABCDEF}.
1909
1910 Integers have the usual values.  To denote a negative integer, use
1911 the prefix operator @samp{-} discussed under expressions
1912 (@pxref{Prefix Ops,,Prefix Operators}).
1913
1914 @node Bignums
1915 @subsubsection Bignums
1916
1917 @cindex bignums
1918 @cindex constants, bignum
1919 A @dfn{bignum} has the same syntax and semantics as an integer
1920 except that the number (or its negative) takes more than 32 bits to
1921 represent in binary.  The distinction is made because in some places
1922 integers are permitted while bignums are not.
1923
1924 @node Flonums
1925 @subsubsection Flonums
1926 @cindex flonums
1927 @cindex floating point numbers
1928 @cindex constants, floating point
1929
1930 @cindex precision, floating point
1931 A @dfn{flonum} represents a floating point number.  The translation is
1932 indirect: a decimal floating point number from the text is converted by
1933 @code{@value{AS}} to a generic binary floating point number of more than
1934 sufficient precision.  This generic floating point number is converted
1935 to a particular computer's floating point format (or formats) by a
1936 portion of @code{@value{AS}} specialized to that computer.
1937
1938 A flonum is written by writing (in order)
1939 @itemize @bullet
1940 @item
1941 The digit @samp{0}.
1942 @ifset HPPA
1943 (@samp{0} is optional on the HPPA.)
1944 @end ifset
1945
1946 @item
1947 A letter, to tell @code{@value{AS}} the rest of the number is a flonum.
1948 @ifset GENERIC
1949 @kbd{e} is recommended.  Case is not important.
1950 @ignore
1951 @c FIXME: verify if flonum syntax really this vague for most cases
1952 (Any otherwise illegal letter works here, but that might be changed.  Vax BSD
1953 4.2 assembler seems to allow any of @samp{defghDEFGH}.)
1954 @end ignore
1955
1956 On the H8/300, H8/500,
1957 Hitachi SH,
1958 and AMD 29K architectures, the letter must be
1959 one of the letters @samp{DFPRSX} (in upper or lower case).
1960
1961 On the ARC, the letter must be one of the letters @samp{DFRS}
1962 (in upper or lower case).
1963
1964 On the Intel 960 architecture, the letter must be
1965 one of the letters @samp{DFT} (in upper or lower case).
1966
1967 On the HPPA architecture, the letter must be @samp{E} (upper case only).
1968 @end ifset
1969 @ifclear GENERIC
1970 @ifset A29K
1971 One of the letters @samp{DFPRSX} (in upper or lower case).
1972 @end ifset
1973 @ifset ARC
1974 One of the letters @samp{DFRS} (in upper or lower case).
1975 @end ifset
1976 @ifset H8
1977 One of the letters @samp{DFPRSX} (in upper or lower case).
1978 @end ifset
1979 @ifset HPPA
1980 The letter @samp{E} (upper case only).
1981 @end ifset
1982 @ifset I960
1983 One of the letters @samp{DFT} (in upper or lower case).
1984 @end ifset
1985 @end ifclear
1986
1987 @item
1988 An optional sign: either @samp{+} or @samp{-}.
1989
1990 @item
1991 An optional @dfn{integer part}: zero or more decimal digits.
1992
1993 @item
1994 An optional @dfn{fractional part}: @samp{.} followed by zero
1995 or more decimal digits.
1996
1997 @item
1998 An optional exponent, consisting of:
1999
2000 @itemize @bullet
2001 @item
2002 An @samp{E} or @samp{e}.
2003 @c I can't find a config where "EXP_CHARS" is other than 'eE', but in
2004 @c principle this can perfectly well be different on different targets.
2005 @item
2006 Optional sign: either @samp{+} or @samp{-}.
2007 @item
2008 One or more decimal digits.
2009 @end itemize
2010
2011 @end itemize
2012
2013 At least one of the integer part or the fractional part must be
2014 present.  The floating point number has the usual base-10 value.
2015
2016 @code{@value{AS}} does all processing using integers.  Flonums are computed
2017 independently of any floating point hardware in the computer running
2018 @code{@value{AS}}.
2019
2020 @ifclear GENERIC
2021 @ifset I960
2022 @c Bit fields are written as a general facility but are also controlled
2023 @c by a conditional-compilation flag---which is as of now (21mar91)
2024 @c turned on only by the i960 config of GAS.
2025 @node Bit Fields
2026 @subsubsection Bit Fields
2027
2028 @cindex bit fields
2029 @cindex constants, bit field
2030 You can also define numeric constants as @dfn{bit fields}.
2031 specify two numbers separated by a colon---
2032 @example
2033 @var{mask}:@var{value}
2034 @end example
2035 @noindent
2036 @code{@value{AS}} applies a bitwise @sc{and} between @var{mask} and
2037 @var{value}.
2038
2039 The resulting number is then packed
2040 @ifset GENERIC
2041 @c this conditional paren in case bit fields turned on elsewhere than 960
2042 (in host-dependent byte order)
2043 @end ifset
2044 into a field whose width depends on which assembler directive has the
2045 bit-field as its argument.  Overflow (a result from the bitwise and
2046 requiring more binary digits to represent) is not an error; instead,
2047 more constants are generated, of the specified width, beginning with the
2048 least significant digits.@refill
2049
2050 The directives @code{.byte}, @code{.hword}, @code{.int}, @code{.long},
2051 @code{.short}, and @code{.word} accept bit-field arguments.
2052 @end ifset
2053 @end ifclear
2054
2055 @node Sections
2056 @chapter Sections and Relocation
2057 @cindex sections
2058 @cindex relocation
2059
2060 @menu
2061 * Secs Background::             Background
2062 * Ld Sections::                 Linker Sections
2063 * As Sections::                 Assembler Internal Sections
2064 * Sub-Sections::                Sub-Sections
2065 * bss::                         bss Section
2066 @end menu
2067
2068 @node Secs Background
2069 @section Background
2070
2071 Roughly, a section is a range of addresses, with no gaps; all data
2072 ``in'' those addresses is treated the same for some particular purpose.
2073 For example there may be a ``read only'' section.
2074
2075 @cindex linker, and assembler
2076 @cindex assembler, and linker
2077 The linker @code{@value{LD}} reads many object files (partial programs) and
2078 combines their contents to form a runnable program.  When @code{@value{AS}}
2079 emits an object file, the partial program is assumed to start at address 0.
2080 @code{@value{LD}} assigns the final addresses for the partial program, so that
2081 different partial programs do not overlap.  This is actually an
2082 oversimplification, but it suffices to explain how @code{@value{AS}} uses
2083 sections.
2084
2085 @code{@value{LD}} moves blocks of bytes of your program to their run-time
2086 addresses.  These blocks slide to their run-time addresses as rigid
2087 units; their length does not change and neither does the order of bytes
2088 within them.  Such a rigid unit is called a @emph{section}.  Assigning
2089 run-time addresses to sections is called @dfn{relocation}.  It includes
2090 the task of adjusting mentions of object-file addresses so they refer to
2091 the proper run-time addresses.
2092 @ifset H8
2093 For the H8/300 and H8/500,
2094 and for the Hitachi SH,
2095 @code{@value{AS}} pads sections if needed to
2096 ensure they end on a word (sixteen bit) boundary.
2097 @end ifset
2098
2099 @cindex standard assembler sections
2100 An object file written by @code{@value{AS}} has at least three sections, any
2101 of which may be empty.  These are named @dfn{text}, @dfn{data} and
2102 @dfn{bss} sections.
2103
2104 @ifset COFF
2105 @ifset GENERIC
2106 When it generates COFF output,
2107 @end ifset
2108 @code{@value{AS}} can also generate whatever other named sections you specify
2109 using the @samp{.section} directive (@pxref{Section,,@code{.section}}).
2110 If you do not use any directives that place output in the @samp{.text}
2111 or @samp{.data} sections, these sections still exist, but are empty.
2112 @end ifset
2113
2114 @ifset HPPA
2115 @ifset GENERIC
2116 When @code{@value{AS}} generates SOM or ELF output for the HPPA,
2117 @end ifset
2118 @code{@value{AS}} can also generate whatever other named sections you
2119 specify using the @samp{.space} and @samp{.subspace} directives.  See
2120 @cite{HP9000 Series 800 Assembly Language Reference Manual}
2121 (HP 92432-90001) for details on the @samp{.space} and @samp{.subspace}
2122 assembler directives.
2123
2124 @ifset SOM
2125 Additionally, @code{@value{AS}} uses different names for the standard
2126 text, data, and bss sections when generating SOM output.  Program text
2127 is placed into the @samp{$CODE$} section, data into @samp{$DATA$}, and
2128 BSS into @samp{$BSS$}.
2129 @end ifset
2130 @end ifset
2131
2132 Within the object file, the text section starts at address @code{0}, the
2133 data section follows, and the bss section follows the data section.
2134
2135 @ifset HPPA
2136 When generating either SOM or ELF output files on the HPPA, the text
2137 section starts at address @code{0}, the data section at address
2138 @code{0x4000000}, and the bss section follows the data section.
2139 @end ifset
2140
2141 To let @code{@value{LD}} know which data changes when the sections are
2142 relocated, and how to change that data, @code{@value{AS}} also writes to the
2143 object file details of the relocation needed.  To perform relocation
2144 @code{@value{LD}} must know, each time an address in the object
2145 file is mentioned:
2146 @itemize @bullet
2147 @item
2148 Where in the object file is the beginning of this reference to
2149 an address?
2150 @item
2151 How long (in bytes) is this reference?
2152 @item
2153 Which section does the address refer to?  What is the numeric value of
2154 @display
2155 (@var{address}) @minus{} (@var{start-address of section})?
2156 @end display
2157 @item
2158 Is the reference to an address ``Program-Counter relative''?
2159 @end itemize
2160
2161 @cindex addresses, format of
2162 @cindex section-relative addressing
2163 In fact, every address @code{@value{AS}} ever uses is expressed as
2164 @display
2165 (@var{section}) + (@var{offset into section})
2166 @end display
2167 @noindent
2168 Further, most expressions @code{@value{AS}} computes have this section-relative
2169 nature.
2170 @ifset SOM
2171 (For some object formats, such as SOM for the HPPA, some expressions are
2172 symbol-relative instead.)
2173 @end ifset
2174
2175 In this manual we use the notation @{@var{secname} @var{N}@} to mean ``offset
2176 @var{N} into section @var{secname}.''
2177
2178 Apart from text, data and bss sections you need to know about the
2179 @dfn{absolute} section.  When @code{@value{LD}} mixes partial programs,
2180 addresses in the absolute section remain unchanged.  For example, address
2181 @code{@{absolute 0@}} is ``relocated'' to run-time address 0 by
2182 @code{@value{LD}}.  Although the linker never arranges two partial programs'
2183 data sections with overlapping addresses after linking, @emph{by definition}
2184 their absolute sections must overlap.  Address @code{@{absolute@ 239@}} in one
2185 part of a program is always the same address when the program is running as
2186 address @code{@{absolute@ 239@}} in any other part of the program.
2187
2188 The idea of sections is extended to the @dfn{undefined} section.  Any
2189 address whose section is unknown at assembly time is by definition
2190 rendered @{undefined @var{U}@}---where @var{U} is filled in later.
2191 Since numbers are always defined, the only way to generate an undefined
2192 address is to mention an undefined symbol.  A reference to a named
2193 common block would be such a symbol: its value is unknown at assembly
2194 time so it has section @emph{undefined}.
2195
2196 By analogy the word @emph{section} is used to describe groups of sections in
2197 the linked program.  @code{@value{LD}} puts all partial programs' text
2198 sections in contiguous addresses in the linked program.  It is
2199 customary to refer to the @emph{text section} of a program, meaning all
2200 the addresses of all partial programs' text sections.  Likewise for
2201 data and bss sections.
2202
2203 Some sections are manipulated by @code{@value{LD}}; others are invented for
2204 use of @code{@value{AS}} and have no meaning except during assembly.
2205
2206 @node Ld Sections
2207 @section Linker Sections
2208 @code{@value{LD}} deals with just four kinds of sections, summarized below.
2209
2210 @table @strong
2211
2212 @ifset COFF
2213 @cindex named sections
2214 @cindex sections, named
2215 @item named sections
2216 @end ifset
2217 @ifset aout-bout
2218 @cindex text section
2219 @cindex data section
2220 @itemx text section
2221 @itemx data section
2222 @end ifset
2223 These sections hold your program.  @code{@value{AS}} and @code{@value{LD}} treat them as
2224 separate but equal sections.  Anything you can say of one section is
2225 true another.
2226 @ifset aout-bout
2227 When the program is running, however, it is
2228 customary for the text section to be unalterable.  The
2229 text section is often shared among processes: it contains
2230 instructions, constants and the like.  The data section of a running
2231 program is usually alterable: for example, C variables would be stored
2232 in the data section.
2233 @end ifset
2234
2235 @cindex bss section
2236 @item bss section
2237 This section contains zeroed bytes when your program begins running.  It
2238 is used to hold unitialized variables or common storage.  The length of
2239 each partial program's bss section is important, but because it starts
2240 out containing zeroed bytes there is no need to store explicit zero
2241 bytes in the object file.  The bss section was invented to eliminate
2242 those explicit zeros from object files.
2243
2244 @cindex absolute section
2245 @item absolute section
2246 Address 0 of this section is always ``relocated'' to runtime address 0.
2247 This is useful if you want to refer to an address that @code{@value{LD}} must
2248 not change when relocating.  In this sense we speak of absolute
2249 addresses being ``unrelocatable'': they do not change during relocation.
2250
2251 @cindex undefined section
2252 @item undefined section
2253 This ``section'' is a catch-all for address references to objects not in
2254 the preceding sections.
2255 @c FIXME: ref to some other doc on obj-file formats could go here.
2256 @end table
2257
2258 @cindex relocation example
2259 An idealized example of three relocatable sections follows.
2260 @ifset COFF
2261 The example uses the traditional section names @samp{.text} and @samp{.data}.
2262 @end ifset
2263 Memory addresses are on the horizontal axis.
2264
2265 @c TEXI2ROFF-KILL
2266 @ifinfo
2267 @c END TEXI2ROFF-KILL
2268 @smallexample
2269                       +-----+----+--+
2270 partial program # 1:  |ttttt|dddd|00|
2271                       +-----+----+--+
2272
2273                       text   data bss
2274                       seg.   seg. seg.
2275
2276                       +---+---+---+
2277 partial program # 2:  |TTT|DDD|000|
2278                       +---+---+---+
2279
2280                       +--+---+-----+--+----+---+-----+~~
2281 linked program:       |  |TTT|ttttt|  |dddd|DDD|00000|
2282                       +--+---+-----+--+----+---+-----+~~
2283
2284     addresses:        0 @dots{}
2285 @end smallexample
2286 @c TEXI2ROFF-KILL
2287 @end ifinfo
2288 @need 5000
2289 @tex
2290
2291 \line{\it Partial program \#1: \hfil}
2292 \line{\ibox{2.5cm}{\tt text}\ibox{2cm}{\tt data}\ibox{1cm}{\tt bss}\hfil}
2293 \line{\boxit{2.5cm}{\tt ttttt}\boxit{2cm}{\tt dddd}\boxit{1cm}{\tt 00}\hfil}
2294
2295 \line{\it Partial program \#2: \hfil}
2296 \line{\ibox{1cm}{\tt text}\ibox{1.5cm}{\tt data}\ibox{1cm}{\tt bss}\hfil}
2297 \line{\boxit{1cm}{\tt TTT}\boxit{1.5cm}{\tt DDDD}\boxit{1cm}{\tt 000}\hfil}
2298
2299 \line{\it linked program: \hfil}
2300 \line{\ibox{.5cm}{}\ibox{1cm}{\tt text}\ibox{2.5cm}{}\ibox{.75cm}{}\ibox{2cm}{\tt data}\ibox{1.5cm}{}\ibox{2cm}{\tt bss}\hfil}
2301 \line{\boxit{.5cm}{}\boxit{1cm}{\tt TTT}\boxit{2.5cm}{\tt
2302 ttttt}\boxit{.75cm}{}\boxit{2cm}{\tt dddd}\boxit{1.5cm}{\tt
2303 DDDD}\boxit{2cm}{\tt 00000}\ \dots\hfil}
2304
2305 \line{\it addresses: \hfil}
2306 \line{0\dots\hfil}
2307
2308 @end tex
2309 @c END TEXI2ROFF-KILL
2310
2311 @node As Sections
2312 @section Assembler Internal Sections
2313
2314 @cindex internal assembler sections
2315 @cindex sections in messages, internal
2316 These sections are meant only for the internal use of @code{@value{AS}}.  They
2317 have no meaning at run-time.  You do not really need to know about these
2318 sections for most purposes; but they can be mentioned in @code{@value{AS}}
2319 warning messages, so it might be helpful to have an idea of their
2320 meanings to @code{@value{AS}}.  These sections are used to permit the
2321 value of every expression in your assembly language program to be a
2322 section-relative address.
2323
2324 @table @b
2325 @cindex assembler internal logic error
2326 @item ASSEMBLER-INTERNAL-LOGIC-ERROR!
2327 An internal assembler logic error has been found.  This means there is a
2328 bug in the assembler.
2329
2330 @cindex expr (internal section)
2331 @item expr section
2332 The assembler stores complex expression internally as combinations of
2333 symbols.  When it needs to represent an expression as a symbol, it puts
2334 it in the expr section.
2335 @c FIXME item debug
2336 @c FIXME item transfer[t] vector preload
2337 @c FIXME item transfer[t] vector postload
2338 @c FIXME item register
2339 @end table
2340
2341 @node Sub-Sections
2342 @section Sub-Sections
2343
2344 @cindex numbered subsections
2345 @cindex grouping data
2346 @ifset aout-bout
2347 Assembled bytes
2348 @ifset COFF
2349 conventionally
2350 @end ifset
2351 fall into two sections: text and data.
2352 @end ifset
2353 You may have separate groups of
2354 @ifset GENERIC
2355 data in named sections
2356 @end ifset
2357 @ifclear GENERIC
2358 @ifclear aout-bout
2359 data in named sections
2360 @end ifclear
2361 @ifset aout-bout
2362 text or data
2363 @end ifset
2364 @end ifclear
2365 that you want to end up near to each other in the object file, even though they
2366 are not contiguous in the assembler source.  @code{@value{AS}} allows you to
2367 use @dfn{subsections} for this purpose.  Within each section, there can be
2368 numbered subsections with values from 0 to 8192.  Objects assembled into the
2369 same subsection go into the object file together with other objects in the same
2370 subsection.  For example, a compiler might want to store constants in the text
2371 section, but might not want to have them interspersed with the program being
2372 assembled.  In this case, the compiler could issue a @samp{.text 0} before each
2373 section of code being output, and a @samp{.text 1} before each group of
2374 constants being output.
2375
2376 Subsections are optional.  If you do not use subsections, everything
2377 goes in subsection number zero.
2378
2379 @ifset GENERIC
2380 Each subsection is zero-padded up to a multiple of four bytes.
2381 (Subsections may be padded a different amount on different flavors
2382 of @code{@value{AS}}.)
2383 @end ifset
2384 @ifclear GENERIC
2385 @ifset H8
2386 On the H8/300 and H8/500 platforms, each subsection is zero-padded to a word
2387 boundary (two bytes).
2388 The same is true on the Hitachi SH.
2389 @end ifset
2390 @ifset I960
2391 @c FIXME section padding (alignment)?
2392 @c Rich Pixley says padding here depends on target obj code format; that
2393 @c doesn't seem particularly useful to say without further elaboration,
2394 @c so for now I say nothing about it.  If this is a generic BFD issue,
2395 @c these paragraphs might need to vanish from this manual, and be
2396 @c discussed in BFD chapter of binutils (or some such).
2397 @end ifset
2398 @ifset A29K
2399 On the AMD 29K family, no particular padding is added to section or
2400 subsection sizes; @value{AS} forces no alignment on this platform.
2401 @end ifset
2402 @end ifclear
2403
2404 Subsections appear in your object file in numeric order, lowest numbered
2405 to highest.  (All this to be compatible with other people's assemblers.)
2406 The object file contains no representation of subsections; @code{@value{LD}} and
2407 other programs that manipulate object files see no trace of them.
2408 They just see all your text subsections as a text section, and all your
2409 data subsections as a data section.
2410
2411 To specify which subsection you want subsequent statements assembled
2412 into, use a numeric argument to specify it, in a @samp{.text
2413 @var{expression}} or a @samp{.data @var{expression}} statement.
2414 @ifset COFF
2415 @ifset GENERIC
2416 When generating COFF output, you
2417 @end ifset
2418 @ifclear GENERIC
2419 You
2420 @end ifclear
2421 can also use an extra subsection
2422 argument with arbitrary named sections: @samp{.section @var{name},
2423 @var{expression}}.
2424 @end ifset
2425 @var{Expression} should be an absolute expression.
2426 (@xref{Expressions}.)  If you just say @samp{.text} then @samp{.text 0}
2427 is assumed.  Likewise @samp{.data} means @samp{.data 0}.  Assembly
2428 begins in @code{text 0}.  For instance:
2429 @smallexample
2430 .text 0     # The default subsection is text 0 anyway.
2431 .ascii "This lives in the first text subsection. *"
2432 .text 1
2433 .ascii "But this lives in the second text subsection."
2434 .data 0
2435 .ascii "This lives in the data section,"
2436 .ascii "in the first data subsection."
2437 .text 0
2438 .ascii "This lives in the first text section,"
2439 .ascii "immediately following the asterisk (*)."
2440 @end smallexample
2441
2442 Each section has a @dfn{location counter} incremented by one for every byte
2443 assembled into that section.  Because subsections are merely a convenience
2444 restricted to @code{@value{AS}} there is no concept of a subsection location
2445 counter.  There is no way to directly manipulate a location counter---but the
2446 @code{.align} directive changes it, and any label definition captures its
2447 current value.  The location counter of the section where statements are being
2448 assembled is said to be the @dfn{active} location counter.
2449
2450 @node bss
2451 @section bss Section
2452
2453 @cindex bss section
2454 @cindex common variable storage
2455 The bss section is used for local common variable storage.
2456 You may allocate address space in the bss section, but you may
2457 not dictate data to load into it before your program executes.  When
2458 your program starts running, all the contents of the bss
2459 section are zeroed bytes.
2460
2461 The @code{.lcomm} pseudo-op defines a symbol in the bss section; see
2462 @ref{Lcomm,,@code{.lcomm}}.
2463
2464 The @code{.comm} pseudo-op may be used to declare a common symbol, which is
2465 another form of uninitialized symbol; see @xref{Comm,,@code{.comm}}.
2466
2467 @ifset GENERIC
2468 When assembling for a target which supports multiple sections, such as ELF or
2469 COFF, you may switch into the @code{.bss} section and define symbols as usual;
2470 see @ref{Section,,@code{.section}}.  You may only assemble zero values into the
2471 section.  Typically the section will only contain symbol definitions and
2472 @code{.skip} directives (@pxref{Skip,,@code{.skip}}).
2473 @end ifset
2474
2475 @node Symbols
2476 @chapter Symbols
2477
2478 @cindex symbols
2479 Symbols are a central concept: the programmer uses symbols to name
2480 things, the linker uses symbols to link, and the debugger uses symbols
2481 to debug.
2482
2483 @quotation
2484 @cindex debuggers, and symbol order
2485 @emph{Warning:} @code{@value{AS}} does not place symbols in the object file in
2486 the same order they were declared.  This may break some debuggers.
2487 @end quotation
2488
2489 @menu
2490 * Labels::                      Labels
2491 * Setting Symbols::             Giving Symbols Other Values
2492 * Symbol Names::                Symbol Names
2493 * Dot::                         The Special Dot Symbol
2494 * Symbol Attributes::           Symbol Attributes
2495 @end menu
2496
2497 @node Labels
2498 @section Labels
2499
2500 @cindex labels
2501 A @dfn{label} is written as a symbol immediately followed by a colon
2502 @samp{:}.  The symbol then represents the current value of the
2503 active location counter, and is, for example, a suitable instruction
2504 operand.  You are warned if you use the same symbol to represent two
2505 different locations: the first definition overrides any other
2506 definitions.
2507
2508 @ifset HPPA
2509 On the HPPA, the usual form for a label need not be immediately followed by a
2510 colon, but instead must start in column zero.  Only one label may be defined on
2511 a single line.  To work around this, the HPPA version of @code{@value{AS}} also
2512 provides a special directive @code{.label} for defining labels more flexibly.
2513 @end ifset
2514
2515 @node Setting Symbols
2516 @section Giving Symbols Other Values
2517
2518 @cindex assigning values to symbols
2519 @cindex symbol values, assigning
2520 A symbol can be given an arbitrary value by writing a symbol, followed
2521 by an equals sign @samp{=}, followed by an expression
2522 (@pxref{Expressions}).  This is equivalent to using the @code{.set}
2523 directive.  @xref{Set,,@code{.set}}.
2524
2525 @node Symbol Names
2526 @section Symbol Names
2527
2528 @cindex symbol names
2529 @cindex names, symbol
2530 @ifclear SPECIAL-SYMS
2531 Symbol names begin with a letter or with one of @samp{._}.  On most
2532 machines, you can also use @code{$} in symbol names; exceptions are
2533 noted in @ref{Machine Dependencies}.  That character may be followed by any
2534 string of digits, letters, dollar signs (unless otherwise noted in
2535 @ref{Machine Dependencies}), and underscores.
2536 @end ifclear
2537 @ifset A29K
2538 For the AMD 29K family, @samp{?} is also allowed in the
2539 body of a symbol name, though not at its beginning.
2540 @end ifset
2541
2542 @ifset SPECIAL-SYMS
2543 @ifset H8
2544 Symbol names begin with a letter or with one of @samp{._}.  On the
2545 Hitachi SH or the
2546 H8/500, you can also use @code{$} in symbol names.  That character may
2547 be followed by any string of digits, letters, dollar signs (save on the
2548 H8/300), and underscores.
2549 @end ifset
2550 @end ifset
2551
2552 Case of letters is significant: @code{foo} is a different symbol name
2553 than @code{Foo}.
2554
2555 Each symbol has exactly one name.  Each name in an assembly language program
2556 refers to exactly one symbol.  You may use that symbol name any number of times
2557 in a program.
2558
2559 @subheading Local Symbol Names
2560
2561 @cindex local symbol names
2562 @cindex symbol names, local
2563 @cindex temporary symbol names
2564 @cindex symbol names, temporary
2565 Local symbols help compilers and programmers use names temporarily.
2566 There are ten local symbol names, which are re-used throughout the
2567 program.  You may refer to them using the names @samp{0} @samp{1}
2568 @dots{} @samp{9}.  To define a local symbol, write a label of the form
2569 @samp{@b{N}:} (where @b{N} represents any digit).  To refer to the most
2570 recent previous definition of that symbol write @samp{@b{N}b}, using the
2571 same digit as when you defined the label.  To refer to the next
2572 definition of a local label, write @samp{@b{N}f}---where @b{N} gives you
2573 a choice of 10 forward references.  The @samp{b} stands for
2574 ``backwards'' and the @samp{f} stands for ``forwards''.
2575
2576 Local symbols are not emitted by the current @sc{gnu} C compiler.
2577
2578 There is no restriction on how you can use these labels, but
2579 remember that at any point in the assembly you can refer to at most
2580 10 prior local labels and to at most 10 forward local labels.
2581
2582 Local symbol names are only a notation device.  They are immediately
2583 transformed into more conventional symbol names before the assembler
2584 uses them.  The symbol names stored in the symbol table, appearing in
2585 error messages and optionally emitted to the object file have these
2586 parts:
2587
2588 @table @code
2589 @item L
2590 All local labels begin with @samp{L}. Normally both @code{@value{AS}} and
2591 @code{@value{LD}} forget symbols that start with @samp{L}. These labels are
2592 used for symbols you are never intended to see.  If you use the
2593 @samp{-L} option then @code{@value{AS}} retains these symbols in the
2594 object file. If you also instruct @code{@value{LD}} to retain these symbols,
2595 you may use them in debugging.
2596
2597 @item @var{digit}
2598 If the label is written @samp{0:} then the digit is @samp{0}.
2599 If the label is written @samp{1:} then the digit is @samp{1}.
2600 And so on up through @samp{9:}.
2601
2602 @item @kbd{C-A}
2603 This unusual character is included so you do not accidentally invent
2604 a symbol of the same name.  The character has ASCII value
2605 @samp{\001}.
2606
2607 @item @emph{ordinal number}
2608 This is a serial number to keep the labels distinct.  The first
2609 @samp{0:} gets the number @samp{1}; The 15th @samp{0:} gets the
2610 number @samp{15}; @emph{etc.}.  Likewise for the other labels @samp{1:}
2611 through @samp{9:}.
2612 @end table
2613
2614 For instance, the first @code{1:} is named @code{L1@kbd{C-A}1}, the 44th
2615 @code{3:} is named @code{L3@kbd{C-A}44}.
2616
2617 @node Dot
2618 @section The Special Dot Symbol
2619
2620 @cindex dot (symbol)
2621 @cindex @code{.} (symbol)
2622 @cindex current address
2623 @cindex location counter
2624 The special symbol @samp{.} refers to the current address that
2625 @code{@value{AS}} is assembling into.  Thus, the expression @samp{melvin:
2626 .long .} defines @code{melvin} to contain its own address.
2627 Assigning a value to @code{.} is treated the same as a @code{.org}
2628 directive.  Thus, the expression @samp{.=.+4} is the same as saying
2629 @ifclear no-space-dir
2630 @samp{.space 4}.
2631 @end ifclear
2632 @ifset no-space-dir
2633 @ifset A29K
2634 @samp{.block 4}.
2635 @end ifset
2636 @end ifset
2637
2638 @node Symbol Attributes
2639 @section Symbol Attributes
2640
2641 @cindex symbol attributes
2642 @cindex attributes, symbol
2643 Every symbol has, as well as its name, the attributes ``Value'' and
2644 ``Type''.  Depending on output format, symbols can also have auxiliary
2645 attributes.
2646 @ifset INTERNALS
2647 The detailed definitions are in @file{a.out.h}.
2648 @end ifset
2649
2650 If you use a symbol without defining it, @code{@value{AS}} assumes zero for
2651 all these attributes, and probably won't warn you.  This makes the
2652 symbol an externally defined symbol, which is generally what you
2653 would want.
2654
2655 @menu
2656 * Symbol Value::                Value
2657 * Symbol Type::                 Type
2658 @ifset aout-bout
2659 @ifset GENERIC
2660 * a.out Symbols::               Symbol Attributes: @code{a.out}
2661 @end ifset
2662 @ifclear GENERIC
2663 @ifclear BOUT
2664 * a.out Symbols::               Symbol Attributes: @code{a.out}
2665 @end ifclear
2666 @ifset BOUT
2667 * a.out Symbols::               Symbol Attributes: @code{a.out}, @code{b.out}
2668 @end ifset
2669 @end ifclear
2670 @end ifset
2671 @ifset COFF
2672 * COFF Symbols::                Symbol Attributes for COFF
2673 @end ifset
2674 @ifset SOM
2675 * SOM Symbols::                Symbol Attributes for SOM
2676 @end ifset
2677 @end menu
2678
2679 @node Symbol Value
2680 @subsection Value
2681
2682 @cindex value of a symbol
2683 @cindex symbol value
2684 The value of a symbol is (usually) 32 bits.  For a symbol which labels a
2685 location in the text, data, bss or absolute sections the value is the
2686 number of addresses from the start of that section to the label.
2687 Naturally for text, data and bss sections the value of a symbol changes
2688 as @code{@value{LD}} changes section base addresses during linking.  Absolute
2689 symbols' values do not change during linking: that is why they are
2690 called absolute.
2691
2692 The value of an undefined symbol is treated in a special way.  If it is
2693 0 then the symbol is not defined in this assembler source file, and
2694 @code{@value{LD}} tries to determine its value from other files linked into the
2695 same program.  You make this kind of symbol simply by mentioning a symbol
2696 name without defining it.  A non-zero value represents a @code{.comm}
2697 common declaration.  The value is how much common storage to reserve, in
2698 bytes (addresses).  The symbol refers to the first address of the
2699 allocated storage.
2700
2701 @node Symbol Type
2702 @subsection Type
2703
2704 @cindex type of a symbol
2705 @cindex symbol type
2706 The type attribute of a symbol contains relocation (section)
2707 information, any flag settings indicating that a symbol is external, and
2708 (optionally), other information for linkers and debuggers.  The exact
2709 format depends on the object-code output format in use.
2710
2711 @ifset aout-bout
2712 @ifclear GENERIC
2713 @ifset BOUT
2714 @c The following avoids a "widow" subsection title.  @group would be
2715 @c better if it were available outside examples.
2716 @need 1000
2717 @node a.out Symbols
2718 @subsection Symbol Attributes: @code{a.out}, @code{b.out}
2719
2720 @cindex @code{b.out} symbol attributes
2721 @cindex symbol attributes, @code{b.out}
2722 These symbol attributes appear only when @code{@value{AS}} is configured for
2723 one of the Berkeley-descended object output formats---@code{a.out} or
2724 @code{b.out}.
2725
2726 @end ifset
2727 @ifclear BOUT
2728 @node a.out Symbols
2729 @subsection Symbol Attributes: @code{a.out}
2730
2731 @cindex @code{a.out} symbol attributes
2732 @cindex symbol attributes, @code{a.out}
2733
2734 @end ifclear
2735 @end ifclear
2736 @ifset GENERIC
2737 @node a.out Symbols
2738 @subsection Symbol Attributes: @code{a.out}
2739
2740 @cindex @code{a.out} symbol attributes
2741 @cindex symbol attributes, @code{a.out}
2742
2743 @end ifset
2744 @menu
2745 * Symbol Desc::                 Descriptor
2746 * Symbol Other::                Other
2747 @end menu
2748
2749 @node Symbol Desc
2750 @subsubsection Descriptor
2751
2752 @cindex descriptor, of @code{a.out} symbol
2753 This is an arbitrary 16-bit value.  You may establish a symbol's
2754 descriptor value by using a @code{.desc} statement
2755 (@pxref{Desc,,@code{.desc}}).  A descriptor value means nothing to
2756 @code{@value{AS}}.
2757
2758 @node Symbol Other
2759 @subsubsection Other
2760
2761 @cindex other attribute, of @code{a.out} symbol
2762 This is an arbitrary 8-bit value.  It means nothing to @code{@value{AS}}.
2763 @end ifset
2764
2765 @ifset COFF
2766 @node COFF Symbols
2767 @subsection Symbol Attributes for COFF
2768
2769 @cindex COFF symbol attributes
2770 @cindex symbol attributes, COFF
2771
2772 The COFF format supports a multitude of auxiliary symbol attributes;
2773 like the primary symbol attributes, they are set between @code{.def} and
2774 @code{.endef} directives.
2775
2776 @subsubsection Primary Attributes
2777
2778 @cindex primary attributes, COFF symbols
2779 The symbol name is set with @code{.def}; the value and type,
2780 respectively, with @code{.val} and @code{.type}.
2781
2782 @subsubsection Auxiliary Attributes
2783
2784 @cindex auxiliary attributes, COFF symbols
2785 The @code{@value{AS}} directives @code{.dim}, @code{.line}, @code{.scl},
2786 @code{.size}, and @code{.tag} can generate auxiliary symbol table
2787 information for COFF.
2788 @end ifset
2789
2790 @ifset SOM
2791 @node SOM Symbols
2792 @subsection Symbol Attributes for SOM
2793
2794 @cindex SOM symbol attributes
2795 @cindex symbol attributes, SOM
2796
2797 The SOM format for the HPPA supports a multitude of symbol attributes set with
2798 the @code{.EXPORT} and @code{.IMPORT} directives.
2799
2800 The attributes are described in @cite{HP9000 Series 800 Assembly 
2801 Language Reference Manual} (HP 92432-90001) under the @code{IMPORT} and
2802 @code{EXPORT} assembler directive documentation.
2803 @end ifset
2804
2805 @node Expressions
2806 @chapter Expressions
2807
2808 @cindex expressions
2809 @cindex addresses
2810 @cindex numeric values
2811 An @dfn{expression} specifies an address or numeric value.
2812 Whitespace may precede and/or follow an expression.
2813
2814 The result of an expression must be an absolute number, or else an offset into
2815 a particular section.  If an expression is not absolute, and there is not
2816 enough information when @code{@value{AS}} sees the expression to know its
2817 section, a second pass over the source program might be necessary to interpret
2818 the expression---but the second pass is currently not implemented.
2819 @code{@value{AS}} aborts with an error message in this situation.
2820
2821 @menu
2822 * Empty Exprs::                 Empty Expressions
2823 * Integer Exprs::               Integer Expressions
2824 @end menu
2825
2826 @node Empty Exprs
2827 @section Empty Expressions
2828
2829 @cindex empty expressions
2830 @cindex expressions, empty
2831 An empty expression has no value: it is just whitespace or null.
2832 Wherever an absolute expression is required, you may omit the
2833 expression, and @code{@value{AS}} assumes a value of (absolute) 0.  This
2834 is compatible with other assemblers.
2835
2836 @node Integer Exprs
2837 @section Integer Expressions
2838
2839 @cindex integer expressions
2840 @cindex expressions, integer
2841 An @dfn{integer expression} is one or more @emph{arguments} delimited
2842 by @emph{operators}.
2843
2844 @menu
2845 * Arguments::                   Arguments
2846 * Operators::                   Operators
2847 * Prefix Ops::                  Prefix Operators
2848 * Infix Ops::                   Infix Operators
2849 @end menu
2850
2851 @node Arguments
2852 @subsection Arguments
2853
2854 @cindex expression arguments
2855 @cindex arguments in expressions
2856 @cindex operands in expressions
2857 @cindex arithmetic operands
2858 @dfn{Arguments} are symbols, numbers or subexpressions.  In other
2859 contexts arguments are sometimes called ``arithmetic operands''.  In
2860 this manual, to avoid confusing them with the ``instruction operands'' of
2861 the machine language, we use the term ``argument'' to refer to parts of
2862 expressions only, reserving the word ``operand'' to refer only to machine
2863 instruction operands.
2864
2865 Symbols are evaluated to yield @{@var{section} @var{NNN}@} where
2866 @var{section} is one of text, data, bss, absolute,
2867 or undefined.  @var{NNN} is a signed, 2's complement 32 bit
2868 integer.
2869
2870 Numbers are usually integers.
2871
2872 A number can be a flonum or bignum.  In this case, you are warned
2873 that only the low order 32 bits are used, and @code{@value{AS}} pretends
2874 these 32 bits are an integer.  You may write integer-manipulating
2875 instructions that act on exotic constants, compatible with other
2876 assemblers.
2877
2878 @cindex subexpressions
2879 Subexpressions are a left parenthesis @samp{(} followed by an integer
2880 expression, followed by a right parenthesis @samp{)}; or a prefix
2881 operator followed by an argument.
2882
2883 @node Operators
2884 @subsection Operators
2885
2886 @cindex operators, in expressions
2887 @cindex arithmetic functions
2888 @cindex functions, in expressions
2889 @dfn{Operators} are arithmetic functions, like @code{+} or @code{%}.  Prefix
2890 operators are followed by an argument.  Infix operators appear
2891 between their arguments.  Operators may be preceded and/or followed by
2892 whitespace.
2893
2894 @node Prefix Ops
2895 @subsection Prefix Operator
2896
2897 @cindex prefix operators
2898 @code{@value{AS}} has the following @dfn{prefix operators}.  They each take
2899 one argument, which must be absolute.
2900
2901 @c the tex/end tex stuff surrounding this small table is meant to make
2902 @c it align, on the printed page, with the similar table in the next
2903 @c section (which is inside an enumerate).
2904 @tex
2905 \global\advance\leftskip by \itemindent
2906 @end tex
2907
2908 @table @code
2909 @item -
2910 @dfn{Negation}.  Two's complement negation.
2911 @item ~
2912 @dfn{Complementation}.  Bitwise not.
2913 @end table
2914
2915 @tex
2916 \global\advance\leftskip by -\itemindent
2917 @end tex
2918
2919 @node Infix Ops
2920 @subsection Infix Operators
2921
2922 @cindex infix operators
2923 @cindex operators, permitted arguments
2924 @dfn{Infix operators} take two arguments, one on either side.  Operators
2925 have precedence, but operations with equal precedence are performed left
2926 to right.  Apart from @code{+} or @code{-}, both arguments must be
2927 absolute, and the result is absolute.
2928
2929 @enumerate
2930 @cindex operator precedence
2931 @cindex precedence of operators
2932
2933 @item
2934 Highest Precedence
2935
2936 @table @code
2937 @item *
2938 @dfn{Multiplication}.
2939
2940 @item /
2941 @dfn{Division}.  Truncation is the same as the C operator @samp{/}
2942
2943 @item %
2944 @dfn{Remainder}.
2945
2946 @item <
2947 @itemx <<
2948 @dfn{Shift Left}.  Same as the C operator @samp{<<}.
2949
2950 @item >
2951 @itemx >>
2952 @dfn{Shift Right}.  Same as the C operator @samp{>>}.
2953 @end table
2954
2955 @item
2956 Intermediate precedence
2957
2958 @table @code
2959 @item |
2960
2961 @dfn{Bitwise Inclusive Or}.
2962
2963 @item &
2964 @dfn{Bitwise And}.
2965
2966 @item ^
2967 @dfn{Bitwise Exclusive Or}.
2968
2969 @item !
2970 @dfn{Bitwise Or Not}.
2971 @end table
2972
2973 @item
2974 Lowest Precedence
2975
2976 @table @code
2977 @cindex addition, permitted arguments
2978 @cindex plus, permitted arguments
2979 @cindex arguments for addition
2980 @item +
2981 @dfn{Addition}.  If either argument is absolute, the result has the section of
2982 the other argument.  You may not add together arguments from different
2983 sections.
2984
2985 @cindex subtraction, permitted arguments
2986 @cindex minus, permitted arguments
2987 @cindex arguments for subtraction
2988 @item -
2989 @dfn{Subtraction}.  If the right argument is absolute, the
2990 result has the section of the left argument.
2991 If both arguments are in the same section, the result is absolute.
2992 You may not subtract arguments from different sections.
2993 @c FIXME is there still something useful to say about undefined - undefined ?
2994 @end table
2995 @end enumerate
2996
2997 In short, it's only meaningful to add or subtract the @emph{offsets} in an
2998 address; you can only have a defined section in one of the two arguments.
2999
3000 @node Pseudo Ops
3001 @chapter Assembler Directives
3002
3003 @cindex directives, machine independent
3004 @cindex pseudo-ops, machine independent
3005 @cindex machine independent directives
3006 All assembler directives have names that begin with a period (@samp{.}).
3007 The rest of the name is letters, usually in lower case.
3008
3009 This chapter discusses directives that are available regardless of the
3010 target machine configuration for the @sc{gnu} assembler.
3011 @ifset GENERIC
3012 Some machine configurations provide additional directives.
3013 @xref{Machine Dependencies}.
3014 @end ifset
3015 @ifclear GENERIC
3016 @ifset machine-directives
3017 @xref{Machine Dependencies} for additional directives.
3018 @end ifset
3019 @end ifclear
3020
3021 @menu
3022 * Abort::                       @code{.abort}
3023 @ifset COFF
3024 * ABORT::                       @code{.ABORT}
3025 @end ifset
3026
3027 * Align::                       @code{.align @var{abs-expr} , @var{abs-expr}}
3028 * App-File::                    @code{.app-file @var{string}}
3029 * Ascii::                       @code{.ascii "@var{string}"}@dots{}
3030 * Asciz::                       @code{.asciz "@var{string}"}@dots{}
3031 * Balign::                      @code{.balign @var{abs-expr} , @var{abs-expr}}
3032 * Byte::                        @code{.byte @var{expressions}}
3033 * Comm::                        @code{.comm @var{symbol} , @var{length} }
3034 * Data::                        @code{.data @var{subsection}}
3035 @ifset COFF
3036 * Def::                         @code{.def @var{name}}
3037 @end ifset
3038 @ifset aout-bout
3039 * Desc::                        @code{.desc @var{symbol}, @var{abs-expression}}
3040 @end ifset
3041 @ifset COFF
3042 * Dim::                         @code{.dim}
3043 @end ifset
3044
3045 * Double::                      @code{.double @var{flonums}}
3046 * Eject::                       @code{.eject}
3047 * Else::                        @code{.else}
3048 @ifset COFF
3049 * Endef::                       @code{.endef}
3050 @end ifset
3051
3052 * Endfunc::                     @code{.endfunc}
3053 * Endif::                       @code{.endif}
3054 * Equ::                         @code{.equ @var{symbol}, @var{expression}}
3055 * Equiv::                       @code{.equiv @var{symbol}, @var{expression}}
3056 * Err::                         @code{.err}
3057 * Extern::                      @code{.extern}
3058 @ifclear no-file-dir
3059 * File::                        @code{.file @var{string}}
3060 @end ifclear
3061
3062 * Fill::                        @code{.fill @var{repeat} , @var{size} , @var{value}}
3063 * Float::                       @code{.float @var{flonums}}
3064 * Func::                        @code{.func}  
3065 * Global::                      @code{.global @var{symbol}}, @code{.globl @var{symbol}}
3066 * hword::                       @code{.hword @var{expressions}}
3067 * Ident::                       @code{.ident}
3068 * If::                          @code{.if @var{absolute expression}}
3069 * Include::                     @code{.include "@var{file}"}
3070 * Int::                         @code{.int @var{expressions}}
3071 * Irp::                         @code{.irp @var{symbol},@var{values}}@dots{}
3072 * Irpc::                        @code{.irpc @var{symbol},@var{values}}@dots{}
3073 * Lcomm::                       @code{.lcomm @var{symbol} , @var{length}}
3074 * Lflags::                      @code{.lflags}
3075 @ifclear no-line-dir
3076 * Line::                        @code{.line @var{line-number}}
3077 @end ifclear
3078
3079 * Ln::                          @code{.ln @var{line-number}}
3080 * Linkonce::                    @code{.linkonce [@var{type}]}
3081 * List::                        @code{.list}
3082 * Long::                        @code{.long @var{expressions}}
3083 @ignore
3084 * Lsym::                        @code{.lsym @var{symbol}, @var{expression}}
3085 @end ignore
3086
3087 * Macro::                       @code{.macro @var{name} @var{args}}@dots{}
3088 * MRI::                         @code{.mri @var{val}}
3089
3090 * Nolist::                      @code{.nolist}
3091 * Octa::                        @code{.octa @var{bignums}}
3092 * Org::                         @code{.org @var{new-lc} , @var{fill}}
3093 * P2align::                     @code{.p2align @var{abs-expr} , @var{abs-expr}}
3094 * Psize::                       @code{.psize @var{lines}, @var{columns}}
3095 * Quad::                        @code{.quad @var{bignums}}
3096 * Rept::                        @code{.rept @var{count}}
3097 * Sbttl::                       @code{.sbttl "@var{subheading}"}
3098 @ifset COFF
3099 * Scl::                         @code{.scl @var{class}}
3100 * Section::                     @code{.section @var{name}, @var{subsection}}
3101 @end ifset
3102
3103 * Set::                         @code{.set @var{symbol}, @var{expression}}
3104 * Short::                       @code{.short @var{expressions}}
3105 * Single::                      @code{.single @var{flonums}}
3106 @ifset COFF
3107 * Size::                        @code{.size}
3108 @end ifset
3109
3110 * Skip::                        @code{.skip @var{size} , @var{fill}}
3111 * Sleb128::                     @code{.sleb128 @var{expressions}}
3112 * Space::                       @code{.space @var{size} , @var{fill}}
3113 @ifset have-stabs
3114 * Stab::                        @code{.stabd, .stabn, .stabs}
3115 @end ifset
3116
3117 * String::                      @code{.string "@var{str}"}
3118 @ifset ELF
3119 * Symver::                      @code{.symver @var{name},@var{name2@@nodename}}
3120 @end ifset
3121 @ifset COFF
3122 * Tag::                         @code{.tag @var{structname}}
3123 @end ifset
3124
3125 * Text::                        @code{.text @var{subsection}}
3126 * Title::                       @code{.title "@var{heading}"}
3127 @ifset COFF
3128 * Type::                        @code{.type @var{int}}
3129 * Val::                         @code{.val @var{addr}}
3130 @end ifset
3131
3132 * Uleb128::                     @code{.uleb128 @var{expressions}}
3133 * Word::                        @code{.word @var{expressions}}
3134 * Deprecated::                  Deprecated Directives
3135 @end menu
3136
3137 @node Abort
3138 @section @code{.abort}
3139
3140 @cindex @code{abort} directive
3141 @cindex stopping the assembly
3142 This directive stops the assembly immediately.  It is for
3143 compatibility with other assemblers.  The original idea was that the
3144 assembly language source would be piped into the assembler.  If the sender
3145 of the source quit, it could use this directive tells @code{@value{AS}} to
3146 quit also.  One day @code{.abort} will not be supported.
3147
3148 @ifset COFF
3149 @node ABORT
3150 @section @code{.ABORT}
3151
3152 @cindex @code{ABORT} directive
3153 When producing COFF output, @code{@value{AS}} accepts this directive as a
3154 synonym for @samp{.abort}.
3155
3156 @ifset BOUT
3157 When producing @code{b.out} output, @code{@value{AS}} accepts this directive,
3158 but ignores it.
3159 @end ifset
3160 @end ifset
3161
3162 @node Align
3163 @section @code{.align @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
3164
3165 @cindex padding the location counter
3166 @cindex @code{align} directive
3167 Pad the location counter (in the current subsection) to a particular storage
3168 boundary.  The first expression (which must be absolute) is the alignment
3169 required, as described below.
3170
3171 The second expression (also absolute) gives the fill value to be stored in the
3172 padding bytes.  It (and the comma) may be omitted.  If it is omitted, the
3173 padding bytes are normally zero.  However, on some systems, if the section is
3174 marked as containing code and the fill value is omitted, the space is filled
3175 with no-op instructions.
3176
3177 The third expression is also absolute, and is also optional.  If it is present,
3178 it is the maximum number of bytes that should be skipped by this alignment
3179 directive.  If doing the alignment would require skipping more bytes than the
3180 specified maximum, then the alignment is not done at all.  You can omit the
3181 fill value (the second argument) entirely by simply using two commas after the
3182 required alignment; this can be useful if you want the alignment to be filled
3183 with no-op instructions when appropriate.
3184
3185 The way the required alignment is specified varies from system to system.
3186 For the a29k, hppa, m68k, m88k, w65, sparc, and Hitachi SH, and i386 using ELF
3187 format,
3188 the first expression is the
3189 alignment request in bytes.  For example @samp{.align 8} advances
3190 the location counter until it is a multiple of 8.  If the location counter
3191 is already a multiple of 8, no change is needed.
3192
3193 For other systems, including the i386 using a.out format, it is the
3194 number of low-order zero bits the location counter must have after
3195 advancement.  For example @samp{.align 3} advances the location
3196 counter until it a multiple of 8.  If the location counter is already a
3197 multiple of 8, no change is needed.
3198
3199 This inconsistency is due to the different behaviors of the various
3200 native assemblers for these systems which GAS must emulate.
3201 GAS also provides @code{.balign} and @code{.p2align} directives,
3202 described later, which have a consistent behavior across all
3203 architectures (but are specific to GAS).
3204
3205 @node App-File
3206 @section @code{.app-file @var{string}}
3207
3208 @cindex logical file name
3209 @cindex file name, logical
3210 @cindex @code{app-file} directive
3211 @code{.app-file}
3212 @ifclear no-file-dir
3213 (which may also be spelled @samp{.file})
3214 @end ifclear
3215 tells @code{@value{AS}} that we are about to start a new
3216 logical file.  @var{string} is the new file name.  In general, the
3217 filename is recognized whether or not it is surrounded by quotes @samp{"};
3218 but if you wish to specify an empty file name is permitted,
3219 you must give the quotes--@code{""}.  This statement may go away in
3220 future: it is only recognized to be compatible with old @code{@value{AS}}
3221 programs.@refill
3222
3223 @node Ascii
3224 @section @code{.ascii "@var{string}"}@dots{}
3225
3226 @cindex @code{ascii} directive
3227 @cindex string literals
3228 @code{.ascii} expects zero or more string literals (@pxref{Strings})
3229 separated by commas.  It assembles each string (with no automatic
3230 trailing zero byte) into consecutive addresses.
3231
3232 @node Asciz
3233 @section @code{.asciz "@var{string}"}@dots{}
3234
3235 @cindex @code{asciz} directive
3236 @cindex zero-terminated strings
3237 @cindex null-terminated strings
3238 @code{.asciz} is just like @code{.ascii}, but each string is followed by
3239 a zero byte.  The ``z'' in @samp{.asciz} stands for ``zero''.
3240
3241 @node Balign
3242 @section @code{.balign[wl] @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
3243
3244 @cindex padding the location counter given number of bytes
3245 @cindex @code{balign} directive
3246 Pad the location counter (in the current subsection) to a particular
3247 storage boundary.  The first expression (which must be absolute) is the
3248 alignment request in bytes.  For example @samp{.balign 8} advances
3249 the location counter until it is a multiple of 8.  If the location counter
3250 is already a multiple of 8, no change is needed.
3251
3252 The second expression (also absolute) gives the fill value to be stored in the
3253 padding bytes.  It (and the comma) may be omitted.  If it is omitted, the
3254 padding bytes are normally zero.  However, on some systems, if the section is
3255 marked as containing code and the fill value is omitted, the space is filled
3256 with no-op instructions.
3257
3258 The third expression is also absolute, and is also optional.  If it is present,
3259 it is the maximum number of bytes that should be skipped by this alignment
3260 directive.  If doing the alignment would require skipping more bytes than the
3261 specified maximum, then the alignment is not done at all.  You can omit the
3262 fill value (the second argument) entirely by simply using two commas after the
3263 required alignment; this can be useful if you want the alignment to be filled
3264 with no-op instructions when appropriate.
3265
3266 @cindex @code{balignw} directive
3267 @cindex @code{balignl} directive
3268 The @code{.balignw} and @code{.balignl} directives are variants of the
3269 @code{.balign} directive.  The @code{.balignw} directive treats the fill
3270 pattern as a two byte word value.  The @code{.balignl} directives treats the
3271 fill pattern as a four byte longword value.  For example, @code{.balignw
3272 4,0x368d} will align to a multiple of 4.  If it skips two bytes, they will be
3273 filled in with the value 0x368d (the exact placement of the bytes depends upon
3274 the endianness of the processor).  If it skips 1 or 3 bytes, the fill value is
3275 undefined.
3276
3277 @node Byte
3278 @section @code{.byte @var{expressions}}
3279
3280 @cindex @code{byte} directive
3281 @cindex integers, one byte
3282 @code{.byte} expects zero or more expressions, separated by commas.
3283 Each expression is assembled into the next byte.
3284
3285 @node Comm
3286 @section @code{.comm @var{symbol} , @var{length} }
3287
3288 @cindex @code{comm} directive
3289 @cindex symbol, common
3290 @code{.comm} declares a common symbol named @var{symbol}.  When linking, a
3291 common symbol in one object file may be merged with a defined or common symbol
3292 of the same name in another object file.  If @code{@value{LD}} does not see a
3293 definition for the symbol--just one or more common symbols--then it will
3294 allocate @var{length} bytes of uninitialized memory.  @var{length} must be an
3295 absolute expression.  If @code{@value{LD}} sees multiple common symbols with
3296 the same name, and they do not all have the same size, it will allocate space
3297 using the largest size.
3298
3299 @ifset ELF
3300 When using ELF, the @code{.comm} directive takes an optional third argument.
3301 This is the desired alignment of the symbol, specified as a byte boundary (for
3302 example, an alignment of 16 means that the least significant 4 bits of the
3303 address should be zero).  The alignment must be an absolute expression, and it
3304 must be a power of two.  If @code{@value{LD}} allocates uninitialized memory
3305 for the common symbol, it will use the alignment when placing the symbol.  If
3306 no alignment is specified, @code{@value{AS}} will set the alignment to the
3307 largest power of two less than or equal to the size of the symbol, up to a
3308 maximum of 16.
3309 @end ifset
3310
3311 @ifset HPPA
3312 The syntax for @code{.comm} differs slightly on the HPPA.  The syntax is
3313 @samp{@var{symbol} .comm, @var{length}}; @var{symbol} is optional.
3314 @end ifset
3315
3316 @node Data
3317 @section @code{.data @var{subsection}}
3318
3319 @cindex @code{data} directive
3320 @code{.data} tells @code{@value{AS}} to assemble the following statements onto the
3321 end of the data subsection numbered @var{subsection} (which is an
3322 absolute expression).  If @var{subsection} is omitted, it defaults
3323 to zero.
3324
3325 @ifset COFF
3326 @node Def
3327 @section @code{.def @var{name}}
3328
3329 @cindex @code{def} directive
3330 @cindex COFF symbols, debugging
3331 @cindex debugging COFF symbols
3332 Begin defining debugging information for a symbol @var{name}; the
3333 definition extends until the @code{.endef} directive is encountered.
3334 @ifset BOUT
3335
3336 This directive is only observed when @code{@value{AS}} is configured for COFF
3337 format output; when producing @code{b.out}, @samp{.def} is recognized,
3338 but ignored.
3339 @end ifset
3340 @end ifset
3341
3342 @ifset aout-bout
3343 @node Desc
3344 @section @code{.desc @var{symbol}, @var{abs-expression}}
3345
3346 @cindex @code{desc} directive
3347 @cindex COFF symbol descriptor
3348 @cindex symbol descriptor, COFF
3349 This directive sets the descriptor of the symbol (@pxref{Symbol Attributes})
3350 to the low 16 bits of an absolute expression.
3351
3352 @ifset COFF
3353 The @samp{.desc} directive is not available when @code{@value{AS}} is
3354 configured for COFF output; it is only for @code{a.out} or @code{b.out}
3355 object format.  For the sake of compatibility, @code{@value{AS}} accepts
3356 it, but produces no output, when configured for COFF.
3357 @end ifset
3358 @end ifset
3359
3360 @ifset COFF
3361 @node Dim
3362 @section @code{.dim}
3363
3364 @cindex @code{dim} directive
3365 @cindex COFF auxiliary symbol information
3366 @cindex auxiliary symbol information, COFF
3367 This directive is generated by compilers to include auxiliary debugging
3368 information in the symbol table.  It is only permitted inside
3369 @code{.def}/@code{.endef} pairs.
3370 @ifset BOUT
3371
3372 @samp{.dim} is only meaningful when generating COFF format output; when
3373 @code{@value{AS}} is generating @code{b.out}, it accepts this directive but
3374 ignores it.
3375 @end ifset
3376 @end ifset
3377
3378 @node Double
3379 @section @code{.double @var{flonums}}
3380
3381 @cindex @code{double} directive
3382 @cindex floating point numbers (double)
3383 @code{.double} expects zero or more flonums, separated by commas.  It
3384 assembles floating point numbers.
3385 @ifset GENERIC
3386 The exact kind of floating point numbers emitted depends on how
3387 @code{@value{AS}} is configured.  @xref{Machine Dependencies}.
3388 @end ifset
3389 @ifclear GENERIC
3390 @ifset IEEEFLOAT
3391 On the @value{TARGET} family @samp{.double} emits 64-bit floating-point numbers
3392 in @sc{ieee} format.
3393 @end ifset
3394 @end ifclear
3395
3396 @node Eject
3397 @section @code{.eject}
3398
3399 @cindex @code{eject} directive
3400 @cindex new page, in listings
3401 @cindex page, in listings
3402 @cindex listing control: new page
3403 Force a page break at this point, when generating assembly listings.
3404
3405 @node Else
3406 @section @code{.else}
3407
3408 @cindex @code{else} directive
3409 @code{.else} is part of the @code{@value{AS}} support for conditional
3410 assembly; @pxref{If,,@code{.if}}.  It marks the beginning of a section
3411 of code to be assembled if the condition for the preceding @code{.if}
3412 was false.
3413
3414 @ignore
3415 @node End, Endef, Else, Pseudo Ops
3416 @section @code{.end}
3417
3418 @cindex @code{end} directive
3419 This doesn't do anything---but isn't an s_ignore, so I suspect it's
3420 meant to do something eventually (which is why it isn't documented here
3421 as "for compatibility with blah").
3422 @end ignore
3423
3424 @ifset COFF
3425 @node Endef
3426 @section @code{.endef}
3427
3428 @cindex @code{endef} directive
3429 This directive flags the end of a symbol definition begun with
3430 @code{.def}.
3431 @ifset BOUT
3432
3433 @samp{.endef} is only meaningful when generating COFF format output; if
3434 @code{@value{AS}} is configured to generate @code{b.out}, it accepts this
3435 directive but ignores it.
3436 @end ifset
3437 @end ifset
3438
3439 @node Endfunc
3440 @section @code{.endfunc}
3441 @cindex @code{endfunc} directive
3442 @code{.endfunc} marks the end of a function specified with @code{.func}.
3443
3444 @node Endif
3445 @section @code{.endif}
3446
3447 @cindex @code{endif} directive
3448 @code{.endif} is part of the @code{@value{AS}} support for conditional assembly;
3449 it marks the end of a block of code that is only assembled
3450 conditionally.  @xref{If,,@code{.if}}.
3451
3452 @node Equ
3453 @section @code{.equ @var{symbol}, @var{expression}}
3454
3455 @cindex @code{equ} directive
3456 @cindex assigning values to symbols
3457 @cindex symbols, assigning values to
3458 This directive sets the value of @var{symbol} to @var{expression}.
3459 It is synonymous with @samp{.set}; @pxref{Set,,@code{.set}}.
3460
3461 @ifset HPPA
3462 The syntax for @code{equ} on the HPPA is 
3463 @samp{@var{symbol} .equ @var{expression}}.
3464 @end ifset
3465
3466 @node Equiv
3467 @section @code{.equiv @var{symbol}, @var{expression}}
3468 @cindex @code{equiv} directive
3469 The @code{.equiv} directive is like @code{.equ} and @code{.set}, except that
3470 the assembler will signal an error if @var{symbol} is already defined.
3471
3472 Except for the contents of the error message, this is roughly equivalent to 
3473 @smallexample
3474 .ifdef SYM
3475 .err
3476 .endif
3477 .equ SYM,VAL
3478 @end smallexample
3479
3480 @node Err
3481 @section @code{.err}
3482 @cindex @code{err} directive
3483 If @code{@value{AS}} assembles a @code{.err} directive, it will print an error
3484 message and, unless the @code{-Z} option was used, it will not generate an
3485 object file.  This can be used to signal error an conditionally compiled code.
3486
3487 @node Extern
3488 @section @code{.extern}
3489
3490 @cindex @code{extern} directive
3491 @code{.extern} is accepted in the source program---for compatibility
3492 with other assemblers---but it is ignored.  @code{@value{AS}} treats
3493 all undefined symbols as external.
3494
3495 @ifclear no-file-dir
3496 @node File
3497 @section @code{.file @var{string}}
3498
3499 @cindex @code{file} directive
3500 @cindex logical file name
3501 @cindex file name, logical
3502 @code{.file} (which may also be spelled @samp{.app-file}) tells
3503 @code{@value{AS}} that we are about to start a new logical file.
3504 @var{string} is the new file name.  In general, the filename is
3505 recognized whether or not it is surrounded by quotes @samp{"}; but if
3506 you wish to specify an empty file name, you must give the
3507 quotes--@code{""}.  This statement may go away in future: it is only
3508 recognized to be compatible with old @code{@value{AS}} programs.
3509 @ifset A29K
3510 In some configurations of @code{@value{AS}}, @code{.file} has already been
3511 removed to avoid conflicts with other assemblers.  @xref{Machine Dependencies}.
3512 @end ifset
3513 @end ifclear
3514
3515 @node Fill
3516 @section @code{.fill @var{repeat} , @var{size} , @var{value}}
3517
3518 @cindex @code{fill} directive
3519 @cindex writing patterns in memory
3520 @cindex patterns, writing in memory
3521 @var{result}, @var{size} and @var{value} are absolute expressions.
3522 This emits @var{repeat} copies of @var{size} bytes.  @var{Repeat}
3523 may be zero or more.  @var{Size} may be zero or more, but if it is
3524 more than 8, then it is deemed to have the value 8, compatible with
3525 other people's assemblers.  The contents of each @var{repeat} bytes
3526 is taken from an 8-byte number.  The highest order 4 bytes are
3527 zero.  The lowest order 4 bytes are @var{value} rendered in the
3528 byte-order of an integer on the computer @code{@value{AS}} is assembling for.
3529 Each @var{size} bytes in a repetition is taken from the lowest order
3530 @var{size} bytes of this number.  Again, this bizarre behavior is
3531 compatible with other people's assemblers.
3532
3533 @var{size} and @var{value} are optional.
3534 If the second comma and @var{value} are absent, @var{value} is
3535 assumed zero.  If the first comma and following tokens are absent,
3536 @var{size} is assumed to be 1.
3537
3538 @node Float
3539 @section @code{.float @var{flonums}}
3540
3541 @cindex floating point numbers (single)
3542 @cindex @code{float} directive
3543 This directive assembles zero or more flonums, separated by commas.  It
3544 has the same effect as @code{.single}.
3545 @ifset GENERIC
3546 The exact kind of floating point numbers emitted depends on how
3547 @code{@value{AS}} is configured.
3548 @xref{Machine Dependencies}.
3549 @end ifset
3550 @ifclear GENERIC
3551 @ifset IEEEFLOAT
3552 On the @value{TARGET} family, @code{.float} emits 32-bit floating point numbers
3553 in @sc{ieee} format.
3554 @end ifset
3555 @end ifclear
3556
3557 @node Func
3558 @section @code{.func @var{name}[,@var{label}]}
3559 @cindex @code{func} directive
3560 @code{.func} emits debugging information to denote function @var{name}, and
3561 is ignored unless the file is assembled with debugging enabled.
3562 Only @samp{--gstabs} is currently supported.
3563 @var{label} is the entry point of the function and if omitted @var{name}
3564 prepended with the @samp{leading char} is used.
3565 @samp{leading char} is usually @code{_} or nothing, depending on the target.
3566 All functions are currently defined to have @code{void} return type.
3567 The function must be terminated with @code{.endfunc}.
3568
3569 @node Global
3570 @section @code{.global @var{symbol}}, @code{.globl @var{symbol}}
3571
3572 @cindex @code{global} directive
3573 @cindex symbol, making visible to linker
3574 @code{.global} makes the symbol visible to @code{@value{LD}}.  If you define
3575 @var{symbol} in your partial program, its value is made available to
3576 other partial programs that are linked with it.  Otherwise,
3577 @var{symbol} takes its attributes from a symbol of the same name
3578 from another file linked into the same program.
3579
3580 Both spellings (@samp{.globl} and @samp{.global}) are accepted, for
3581 compatibility with other assemblers.
3582
3583 @ifset HPPA
3584 On the HPPA, @code{.global} is not always enough to make it accessible to other
3585 partial programs.  You may need the HPPA-only @code{.EXPORT} directive as well.
3586 @xref{HPPA Directives,, HPPA Assembler Directives}.
3587 @end ifset
3588
3589 @node hword
3590 @section @code{.hword @var{expressions}}
3591
3592 @cindex @code{hword} directive
3593 @cindex integers, 16-bit
3594 @cindex numbers, 16-bit
3595 @cindex sixteen bit integers
3596 This expects zero or more @var{expressions}, and emits
3597 a 16 bit number for each.
3598
3599 @ifset GENERIC
3600 This directive is a synonym for @samp{.short}; depending on the target
3601 architecture, it may also be a synonym for @samp{.word}.
3602 @end ifset
3603 @ifclear GENERIC
3604 @ifset W32
3605 This directive is a synonym for @samp{.short}.
3606 @end ifset
3607 @ifset W16
3608 This directive is a synonym for both @samp{.short} and @samp{.word}.
3609 @end ifset
3610 @end ifclear
3611
3612 @node Ident
3613 @section @code{.ident}
3614
3615 @cindex @code{ident} directive
3616 This directive is used by some assemblers to place tags in object files.
3617 @code{@value{AS}} simply accepts the directive for source-file
3618 compatibility with such assemblers, but does not actually emit anything
3619 for it.
3620
3621 @node If
3622 @section @code{.if @var{absolute expression}}
3623
3624 @cindex conditional assembly
3625 @cindex @code{if} directive
3626 @code{.if} marks the beginning of a section of code which is only
3627 considered part of the source program being assembled if the argument
3628 (which must be an @var{absolute expression}) is non-zero.  The end of
3629 the conditional section of code must be marked by @code{.endif}
3630 (@pxref{Endif,,@code{.endif}}); optionally, you may include code for the
3631 alternative condition, flagged by @code{.else} (@pxref{Else,,@code{.else}}).
3632
3633 The following variants of @code{.if} are also supported:
3634 @table @code
3635 @cindex @code{ifdef} directive
3636 @item .ifdef @var{symbol}
3637 Assembles the following section of code if the specified @var{symbol}
3638 has been defined.
3639
3640 @ignore
3641 @cindex @code{ifeqs} directive
3642 @item .ifeqs
3643 Not yet implemented.
3644 @end ignore
3645
3646 @cindex @code{ifndef} directive
3647 @cindex @code{ifnotdef} directive
3648 @item .ifndef @var{symbol}
3649 @itemx .ifnotdef @var{symbol}
3650 Assembles the following section of code if the specified @var{symbol}
3651 has not been defined.  Both spelling variants are equivalent.
3652
3653 @ignore
3654 @item ifnes
3655 Not yet implemented.
3656 @end ignore
3657 @end table
3658
3659 @node Include
3660 @section @code{.include "@var{file}"}
3661
3662 @cindex @code{include} directive
3663 @cindex supporting files, including
3664 @cindex files, including
3665 This directive provides a way to include supporting files at specified
3666 points in your source program.  The code from @var{file} is assembled as
3667 if it followed the point of the @code{.include}; when the end of the
3668 included file is reached, assembly of the original file continues.  You
3669 can control the search paths used with the @samp{-I} command-line option
3670 (@pxref{Invoking,,Command-Line Options}).  Quotation marks are required
3671 around @var{file}.
3672
3673 @node Int
3674 @section @code{.int @var{expressions}}
3675
3676 @cindex @code{int} directive
3677 @cindex integers, 32-bit
3678 Expect zero or more @var{expressions}, of any section, separated by commas.
3679 For each expression, emit a number that, at run time, is the value of that
3680 expression.  The byte order and bit size of the number depends on what kind
3681 of target the assembly is for.
3682
3683 @ifclear GENERIC
3684 @ifset H8
3685 On the H8/500 and most forms of the H8/300, @code{.int} emits 16-bit
3686 integers.  On the H8/300H and the Hitachi SH, however, @code{.int} emits
3687 32-bit integers.
3688 @end ifset
3689 @end ifclear
3690
3691 @node Irp
3692 @section @code{.irp @var{symbol},@var{values}}@dots{}
3693
3694 @cindex @code{irp} directive
3695 Evaluate a sequence of statements assigning different values to @var{symbol}.
3696 The sequence of statements starts at the @code{.irp} directive, and is
3697 terminated by an @code{.endr} directive.  For each @var{value}, @var{symbol} is
3698 set to @var{value}, and the sequence of statements is assembled.  If no
3699 @var{value} is listed, the sequence of statements is assembled once, with
3700 @var{symbol} set to the null string.  To refer to @var{symbol} within the
3701 sequence of statements, use @var{\symbol}.
3702
3703 For example, assembling
3704
3705 @example
3706         .irp    param,1,2,3
3707         move    d\param,sp@@-
3708         .endr
3709 @end example
3710
3711 is equivalent to assembling
3712
3713 @example
3714         move    d1,sp@@-
3715         move    d2,sp@@-
3716         move    d3,sp@@-
3717 @end example
3718
3719 @node Irpc
3720 @section @code{.irpc @var{symbol},@var{values}}@dots{}
3721
3722 @cindex @code{irpc} directive
3723 Evaluate a sequence of statements assigning different values to @var{symbol}.
3724 The sequence of statements starts at the @code{.irpc} directive, and is
3725 terminated by an @code{.endr} directive.  For each character in @var{value},
3726 @var{symbol} is set to the character, and the sequence of statements is
3727 assembled.  If no @var{value} is listed, the sequence of statements is
3728 assembled once, with @var{symbol} set to the null string.  To refer to
3729 @var{symbol} within the sequence of statements, use @var{\symbol}.
3730
3731 For example, assembling
3732
3733 @example
3734         .irpc    param,123
3735         move    d\param,sp@@-
3736         .endr
3737 @end example
3738
3739 is equivalent to assembling
3740
3741 @example
3742         move    d1,sp@@-
3743         move    d2,sp@@-
3744         move    d3,sp@@-
3745 @end example
3746
3747 @node Lcomm
3748 @section @code{.lcomm @var{symbol} , @var{length}}
3749
3750 @cindex @code{lcomm} directive
3751 @cindex local common symbols
3752 @cindex symbols, local common
3753 Reserve @var{length} (an absolute expression) bytes for a local common
3754 denoted by @var{symbol}.  The section and value of @var{symbol} are
3755 those of the new local common.  The addresses are allocated in the bss
3756 section, so that at run-time the bytes start off zeroed.  @var{Symbol}
3757 is not declared global (@pxref{Global,,@code{.global}}), so is normally
3758 not visible to @code{@value{LD}}.
3759
3760 @ifset GENERIC
3761 Some targets permit a third argument to be used with @code{.lcomm}.  This
3762 argument specifies the desired alignment of the symbol in the bss section.
3763 @end ifset
3764
3765 @ifset HPPA
3766 The syntax for @code{.lcomm} differs slightly on the HPPA.  The syntax is
3767 @samp{@var{symbol} .lcomm, @var{length}}; @var{symbol} is optional.
3768 @end ifset
3769
3770 @node Lflags
3771 @section @code{.lflags}
3772
3773 @cindex @code{lflags} directive (ignored)
3774 @code{@value{AS}} accepts this directive, for compatibility with other
3775 assemblers, but ignores it.
3776
3777 @ifclear no-line-dir
3778 @node Line
3779 @section @code{.line @var{line-number}}
3780
3781 @cindex @code{line} directive
3782 @end ifclear
3783 @ifset no-line-dir
3784 @node Ln
3785 @section @code{.ln @var{line-number}}
3786
3787 @cindex @code{ln} directive
3788 @end ifset
3789 @cindex logical line number
3790 @ifset aout-bout
3791 Change the logical line number.  @var{line-number} must be an absolute
3792 expression.  The next line has that logical line number.  Therefore any other
3793 statements on the current line (after a statement separator character) are
3794 reported as on logical line number @var{line-number} @minus{} 1.  One day
3795 @code{@value{AS}} will no longer support this directive: it is recognized only
3796 for compatibility with existing assembler programs.
3797
3798 @ifset GENERIC
3799 @ifset A29K
3800 @emph{Warning:} In the AMD29K configuration of @value{AS}, this command is
3801 not available; use the synonym @code{.ln} in that context.
3802 @end ifset
3803 @end ifset
3804 @end ifset
3805
3806 @ifclear no-line-dir
3807 Even though this is a directive associated with the @code{a.out} or
3808 @code{b.out} object-code formats, @code{@value{AS}} still recognizes it
3809 when producing COFF output, and treats @samp{.line} as though it
3810 were the COFF @samp{.ln} @emph{if} it is found outside a
3811 @code{.def}/@code{.endef} pair.
3812
3813 Inside a @code{.def}, @samp{.line} is, instead, one of the directives
3814 used by compilers to generate auxiliary symbol information for
3815 debugging.
3816 @end ifclear
3817
3818 @node Linkonce
3819 @section @code{.linkonce [@var{type}]}
3820 @cindex COMDAT
3821 @cindex @code{linkonce} directive
3822 @cindex common sections
3823 Mark the current section so that the linker only includes a single copy of it.
3824 This may be used to include the same section in several different object files,
3825 but ensure that the linker will only include it once in the final output file.
3826 The @code{.linkonce} pseudo-op must be used for each instance of the section.
3827 Duplicate sections are detected based on the section name, so it should be
3828 unique.
3829
3830 This directive is only supported by a few object file formats; as of this
3831 writing, the only object file format which supports it is the Portable
3832 Executable format used on Windows NT.
3833
3834 The @var{type} argument is optional.  If specified, it must be one of the
3835 following strings.  For example:
3836 @smallexample
3837 .linkonce same_size
3838 @end smallexample
3839 Not all types may be supported on all object file formats.
3840
3841 @table @code
3842 @item discard
3843 Silently discard duplicate sections.  This is the default.
3844
3845 @item one_only
3846 Warn if there are duplicate sections, but still keep only one copy.
3847
3848 @item same_size
3849 Warn if any of the duplicates have different sizes.
3850
3851 @item same_contents
3852 Warn if any of the duplicates do not have exactly the same contents.
3853 @end table
3854
3855 @node Ln
3856 @section @code{.ln @var{line-number}}
3857
3858 @cindex @code{ln} directive
3859 @ifclear no-line-dir
3860 @samp{.ln} is a synonym for @samp{.line}.
3861 @end ifclear
3862 @ifset no-line-dir
3863 Tell @code{@value{AS}} to change the logical line number.  @var{line-number}
3864 must be an absolute expression.  The next line has that logical
3865 line number, so any other statements on the current line (after a
3866 statement separator character @code{;}) are reported as on logical
3867 line number @var{line-number} @minus{} 1.
3868 @ifset BOUT
3869
3870 This directive is accepted, but ignored, when @code{@value{AS}} is
3871 configured for @code{b.out}; its effect is only associated with COFF
3872 output format.
3873 @end ifset
3874 @end ifset
3875
3876 @node MRI
3877 @section @code{.mri @var{val}}
3878
3879 @cindex @code{mri} directive
3880 @cindex MRI mode, temporarily
3881 If @var{val} is non-zero, this tells @code{@value{AS}} to enter MRI mode.  If
3882 @var{val} is zero, this tells @code{@value{AS}} to exit MRI mode.  This change
3883 affects code assembled until the next @code{.mri} directive, or until the end
3884 of the file.  @xref{M, MRI mode, MRI mode}.
3885
3886 @node List
3887 @section @code{.list}
3888
3889 @cindex @code{list} directive
3890 @cindex listing control, turning on
3891 Control (in conjunction with the @code{.nolist} directive) whether or
3892 not assembly listings are generated.  These two directives maintain an
3893 internal counter (which is zero initially).   @code{.list} increments the
3894 counter, and @code{.nolist} decrements it.  Assembly listings are
3895 generated whenever the counter is greater than zero.
3896
3897 By default, listings are disabled.  When you enable them (with the
3898 @samp{-a} command line option; @pxref{Invoking,,Command-Line Options}),
3899 the initial value of the listing counter is one.
3900
3901 @node Long
3902 @section @code{.long @var{expressions}}
3903
3904 @cindex @code{long} directive
3905 @code{.long} is the same as @samp{.int}, @pxref{Int,,@code{.int}}.
3906
3907 @ignore
3908 @c no one seems to know what this is for or whether this description is
3909 @c what it really ought to do
3910 @node Lsym
3911 @section @code{.lsym @var{symbol}, @var{expression}}
3912
3913 @cindex @code{lsym} directive
3914 @cindex symbol, not referenced in assembly
3915 @code{.lsym} creates a new symbol named @var{symbol}, but does not put it in
3916 the hash table, ensuring it cannot be referenced by name during the
3917 rest of the assembly.  This sets the attributes of the symbol to be
3918 the same as the expression value:
3919 @smallexample
3920 @var{other} = @var{descriptor} = 0
3921 @var{type} = @r{(section of @var{expression})}
3922 @var{value} = @var{expression}
3923 @end smallexample
3924 @noindent
3925 The new symbol is not flagged as external.
3926 @end ignore
3927
3928 @node Macro
3929 @section @code{.macro}
3930
3931 @cindex macros
3932 The commands @code{.macro} and @code{.endm} allow you to define macros that
3933 generate assembly output.  For example, this definition specifies a macro
3934 @code{sum} that puts a sequence of numbers into memory:
3935
3936 @example
3937         .macro  sum from=0, to=5
3938         .long   \from
3939         .if     \to-\from
3940         sum     "(\from+1)",\to
3941         .endif
3942         .endm
3943 @end example
3944
3945 @noindent
3946 With that definition, @samp{SUM 0,5} is equivalent to this assembly input:
3947
3948 @example
3949         .long   0
3950         .long   1
3951         .long   2
3952         .long   3
3953         .long   4
3954         .long   5
3955 @end example
3956
3957 @ftable @code
3958 @item .macro @var{macname}
3959 @itemx .macro @var{macname} @var{macargs} @dots{}
3960 @cindex @code{macro} directive
3961 Begin the definition of a macro called @var{macname}.  If your macro
3962 definition requires arguments, specify their names after the macro name,
3963 separated by commas or spaces.  You can supply a default value for any
3964 macro argument by following the name with @samp{=@var{deflt}}.  For
3965 example, these are all valid @code{.macro} statements:
3966
3967 @table @code
3968 @item .macro comm
3969 Begin the definition of a macro called @code{comm}, which takes no
3970 arguments.
3971
3972 @item .macro plus1 p, p1
3973 @itemx .macro plus1 p p1
3974 Either statement begins the definition of a macro called @code{plus1},
3975 which takes two arguments; within the macro definition, write
3976 @samp{\p} or @samp{\p1} to evaluate the arguments.
3977
3978 @item .macro reserve_str p1=0 p2
3979 Begin the definition of a macro called @code{reserve_str}, with two
3980 arguments.  The first argument has a default value, but not the second.
3981 After the definition is complete, you can call the macro either as
3982 @samp{reserve_str @var{a},@var{b}} (with @samp{\p1} evaluating to
3983 @var{a} and @samp{\p2} evaluating to @var{b}), or as @samp{reserve_str
3984 ,@var{b}} (with @samp{\p1} evaluating as the default, in this case
3985 @samp{0}, and @samp{\p2} evaluating to @var{b}).
3986 @end table
3987
3988 When you call a macro, you can specify the argument values either by
3989 position, or by keyword.  For example, @samp{sum 9,17} is equivalent to
3990 @samp{sum to=17, from=9}.
3991
3992 @item .endm
3993 @cindex @code{endm} directive
3994 Mark the end of a macro definition.
3995
3996 @item .exitm
3997 @cindex @code{exitm} directive
3998 Exit early from the current macro definition.
3999
4000 @cindex number of macros executed
4001 @cindex macros, count executed
4002 @item \@@
4003 @code{@value{AS}} maintains a counter of how many macros it has
4004 executed in this pseudo-variable; you can copy that number to your
4005 output with @samp{\@@}, but @emph{only within a macro definition}.
4006
4007 @ignore
4008 @item LOCAL @var{name} [ , @dots{} ]
4009 @emph{Warning: @code{LOCAL} is only available if you select ``alternate
4010 macro syntax'' with @samp{-a} or @samp{--alternate}.}  @xref{Alternate,,
4011 Alternate macro syntax}.
4012
4013 Generate a string replacement for each of the @var{name} arguments, and
4014 replace any instances of @var{name} in each macro expansion.  The
4015 replacement string is unique in the assembly, and different for each
4016 separate macro expansion.  @code{LOCAL} allows you to write macros that
4017 define symbols, without fear of conflict between separate macro expansions.
4018 @end ignore
4019 @end ftable
4020
4021 @node Nolist
4022 @section @code{.nolist}
4023
4024 @cindex @code{nolist} directive
4025 @cindex listing control, turning off
4026 Control (in conjunction with the @code{.list} directive) whether or
4027 not assembly listings are generated.  These two directives maintain an
4028 internal counter (which is zero initially).   @code{.list} increments the
4029 counter, and @code{.nolist} decrements it.  Assembly listings are
4030 generated whenever the counter is greater than zero.
4031
4032 @node Octa
4033 @section @code{.octa @var{bignums}}
4034
4035 @c FIXME: double size emitted for "octa" on i960, others?  Or warn?
4036 @cindex @code{octa} directive
4037 @cindex integer, 16-byte
4038 @cindex sixteen byte integer
4039 This directive expects zero or more bignums, separated by commas.  For each
4040 bignum, it emits a 16-byte integer.
4041
4042 The term ``octa'' comes from contexts in which a ``word'' is two bytes;
4043 hence @emph{octa}-word for 16 bytes.
4044
4045 @node Org
4046 @section @code{.org @var{new-lc} , @var{fill}}
4047
4048 @cindex @code{org} directive
4049 @cindex location counter, advancing
4050 @cindex advancing location counter
4051 @cindex current address, advancing
4052 Advance the location counter of the current section to
4053 @var{new-lc}.  @var{new-lc} is either an absolute expression or an
4054 expression with the same section as the current subsection.  That is,
4055 you can't use @code{.org} to cross sections: if @var{new-lc} has the
4056 wrong section, the @code{.org} directive is ignored.  To be compatible
4057 with former assemblers, if the section of @var{new-lc} is absolute,
4058 @code{@value{AS}} issues a warning, then pretends the section of @var{new-lc}
4059 is the same as the current subsection.
4060
4061 @code{.org} may only increase the location counter, or leave it
4062 unchanged; you cannot use @code{.org} to move the location counter
4063 backwards.
4064
4065 @c double negative used below "not undefined" because this is a specific
4066 @c reference to "undefined" (as SEG_UNKNOWN is called in this manual)
4067 @c section. doc@cygnus.com 18feb91
4068 Because @code{@value{AS}} tries to assemble programs in one pass, @var{new-lc}
4069 may not be undefined.  If you really detest this restriction we eagerly await
4070 a chance to share your improved assembler.
4071
4072 Beware that the origin is relative to the start of the section, not
4073 to the start of the subsection.  This is compatible with other
4074 people's assemblers.
4075
4076 When the location counter (of the current subsection) is advanced, the
4077 intervening bytes are filled with @var{fill} which should be an
4078 absolute expression.  If the comma and @var{fill} are omitted,
4079 @var{fill} defaults to zero.
4080
4081 @node P2align
4082 @section @code{.p2align[wl] @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
4083
4084 @cindex padding the location counter given a power of two
4085 @cindex @code{p2align} directive
4086 Pad the location counter (in the current subsection) to a particular
4087 storage boundary.  The first expression (which must be absolute) is the
4088 number of low-order zero bits the location counter must have after
4089 advancement.  For example @samp{.p2align 3} advances the location
4090 counter until it a multiple of 8.  If the location counter is already a
4091 multiple of 8, no change is needed.
4092
4093 The second expression (also absolute) gives the fill value to be stored in the
4094 padding bytes.  It (and the comma) may be omitted.  If it is omitted, the
4095 padding bytes are normally zero.  However, on some systems, if the section is
4096 marked as containing code and the fill value is omitted, the space is filled
4097 with no-op instructions.
4098
4099 The third expression is also absolute, and is also optional.  If it is present,
4100 it is the maximum number of bytes that should be skipped by this alignment
4101 directive.  If doing the alignment would require skipping more bytes than the
4102 specified maximum, then the alignment is not done at all.  You can omit the
4103 fill value (the second argument) entirely by simply using two commas after the
4104 required alignment; this can be useful if you want the alignment to be filled
4105 with no-op instructions when appropriate.
4106
4107 @cindex @code{p2alignw} directive
4108 @cindex @code{p2alignl} directive
4109 The @code{.p2alignw} and @code{.p2alignl} directives are variants of the
4110 @code{.p2align} directive.  The @code{.p2alignw} directive treats the fill
4111 pattern as a two byte word value.  The @code{.p2alignl} directives treats the
4112 fill pattern as a four byte longword value.  For example, @code{.p2alignw
4113 2,0x368d} will align to a multiple of 4.  If it skips two bytes, they will be
4114 filled in with the value 0x368d (the exact placement of the bytes depends upon
4115 the endianness of the processor).  If it skips 1 or 3 bytes, the fill value is
4116 undefined.
4117
4118 @node Psize
4119 @section @code{.psize @var{lines} , @var{columns}}
4120
4121 @cindex @code{psize} directive
4122 @cindex listing control: paper size
4123 @cindex paper size, for listings
4124 Use this directive to declare the number of lines---and, optionally, the
4125 number of columns---to use for each page, when generating listings.
4126
4127 If you do not use @code{.psize}, listings use a default line-count
4128 of 60.  You may omit the comma and @var{columns} specification; the
4129 default width is 200 columns.
4130
4131 @code{@value{AS}} generates formfeeds whenever the specified number of
4132 lines is exceeded (or whenever you explicitly request one, using
4133 @code{.eject}).
4134
4135 If you specify @var{lines} as @code{0}, no formfeeds are generated save
4136 those explicitly specified with @code{.eject}.
4137
4138 @node Quad
4139 @section @code{.quad @var{bignums}}
4140
4141 @cindex @code{quad} directive
4142 @code{.quad} expects zero or more bignums, separated by commas.  For
4143 each bignum, it emits
4144 @ifclear bignum-16
4145 an 8-byte integer.  If the bignum won't fit in 8 bytes, it prints a
4146 warning message; and just takes the lowest order 8 bytes of the bignum.
4147 @cindex eight-byte integer
4148 @cindex integer, 8-byte
4149
4150 The term ``quad'' comes from contexts in which a ``word'' is two bytes;
4151 hence @emph{quad}-word for 8 bytes.
4152 @end ifclear
4153 @ifset bignum-16
4154 a 16-byte integer.  If the bignum won't fit in 16 bytes, it prints a
4155 warning message; and just takes the lowest order 16 bytes of the bignum.
4156 @cindex sixteen-byte integer
4157 @cindex integer, 16-byte
4158 @end ifset
4159
4160 @node Rept
4161 @section @code{.rept @var{count}}
4162
4163 @cindex @code{rept} directive
4164 Repeat the sequence of lines between the @code{.rept} directive and the next
4165 @code{.endr} directive @var{count} times.
4166
4167 For example, assembling
4168
4169 @example
4170         .rept   3
4171         .long   0
4172         .endr
4173 @end example
4174
4175 is equivalent to assembling
4176
4177 @example
4178         .long   0
4179         .long   0
4180         .long   0
4181 @end example
4182
4183 @node Sbttl
4184 @section @code{.sbttl "@var{subheading}"}
4185
4186 @cindex @code{sbttl} directive
4187 @cindex subtitles for listings
4188 @cindex listing control: subtitle
4189 Use @var{subheading} as the title (third line, immediately after the
4190 title line) when generating assembly listings.
4191
4192 This directive affects subsequent pages, as well as the current page if
4193 it appears within ten lines of the top of a page.
4194
4195 @ifset COFF
4196 @node Scl
4197 @section @code{.scl @var{class}}
4198
4199 @cindex @code{scl} directive
4200 @cindex symbol storage class (COFF)
4201 @cindex COFF symbol storage class
4202 Set the storage-class value for a symbol.  This directive may only be
4203 used inside a @code{.def}/@code{.endef} pair.  Storage class may flag
4204 whether a symbol is static or external, or it may record further
4205 symbolic debugging information.
4206 @ifset BOUT
4207
4208 The @samp{.scl} directive is primarily associated with COFF output; when
4209 configured to generate @code{b.out} output format, @code{@value{AS}}
4210 accepts this directive but ignores it.
4211 @end ifset
4212 @end ifset
4213
4214 @node Section
4215 @section @code{.section @var{name}}
4216
4217 @cindex @code{section} directive
4218 @cindex named section
4219 Use the @code{.section} directive to assemble the following code into a section
4220 named @var{name}.
4221
4222 This directive is only supported for targets that actually support arbitrarily
4223 named sections; on @code{a.out} targets, for example, it is not accepted, even
4224 with a standard @code{a.out} section name.
4225
4226 @ifset COFF
4227 For COFF targets, the @code{.section} directive is used in one of the following
4228 ways:
4229 @smallexample
4230 .section @var{name}[, "@var{flags}"]
4231 .section @var{name}[, @var{subsegment}]
4232 @end smallexample
4233
4234 If the optional argument is quoted, it is taken as flags to use for the
4235 section.  Each flag is a single character.  The following flags are recognized:
4236 @table @code
4237 @item b
4238 bss section (uninitialized data)
4239 @item n
4240 section is not loaded
4241 @item w
4242 writable section
4243 @item d
4244 data section
4245 @item r
4246 read-only section
4247 @item x
4248 executable section
4249 @end table
4250
4251 If no flags are specified, the default flags depend upon the section name.  If
4252 the section name is not recognized, the default will be for the section to be
4253 loaded and writable.
4254
4255 If the optional argument to the @code{.section} directive is not quoted, it is
4256 taken as a subsegment number (@pxref{Sub-Sections}).
4257 @end ifset
4258
4259 @ifset ELF
4260 For ELF targets, the @code{.section} directive is used like this:
4261 @smallexample
4262 .section @var{name}[, "@var{flags}"[, @@@var{type}]]
4263 @end smallexample
4264 The optional @var{flags} argument is a quoted string which may contain any
4265 combintion of the following characters:
4266 @table @code
4267 @item a
4268 section is allocatable
4269 @item w
4270 section is writable
4271 @item x
4272 section is executable
4273 @end table
4274
4275 The optional @var{type} argument may contain one of the following constants:
4276 @table @code
4277 @item @@progbits
4278 section contains data
4279 @item @@nobits
4280 section does not contain data (i.e., section only occupies space)
4281 @end table
4282
4283 If no flags are specified, the default flags depend upon the section name.  If
4284 the section name is not recognized, the default will be for the section to have
4285 none of the above flags: it will not be allocated in memory, nor writable, nor
4286 executable.  The section will contain data.
4287
4288 For ELF targets, the assembler supports another type of @code{.section}
4289 directive for compatibility with the Solaris assembler:
4290 @smallexample
4291 .section "@var{name}"[, @var{flags}...]
4292 @end smallexample
4293 Note that the section name is quoted.  There may be a sequence of comma
4294 separated flags:
4295 @table @code
4296 @item #alloc
4297 section is allocatable
4298 @item #write
4299 section is writable
4300 @item #execinstr
4301 section is executable
4302 @end table
4303 @end ifset
4304
4305 @node Set
4306 @section @code{.set @var{symbol}, @var{expression}}
4307
4308 @cindex @code{set} directive
4309 @cindex symbol value, setting
4310 Set the value of @var{symbol} to @var{expression}.  This
4311 changes @var{symbol}'s value and type to conform to
4312 @var{expression}.  If @var{symbol} was flagged as external, it remains
4313 flagged (@pxref{Symbol Attributes}).
4314
4315 You may @code{.set} a symbol many times in the same assembly.
4316
4317 If you @code{.set} a global symbol, the value stored in the object
4318 file is the last value stored into it.
4319
4320 @ifset HPPA
4321 The syntax for @code{set} on the HPPA is
4322 @samp{@var{symbol} .set @var{expression}}.
4323 @end ifset
4324
4325 @node Short
4326 @section @code{.short @var{expressions}}
4327
4328 @cindex @code{short} directive
4329 @ifset GENERIC
4330 @code{.short} is normally the same as @samp{.word}.
4331 @xref{Word,,@code{.word}}.
4332
4333 In some configurations, however, @code{.short} and @code{.word} generate
4334 numbers of different lengths; @pxref{Machine Dependencies}.
4335 @end ifset
4336 @ifclear GENERIC
4337 @ifset W16
4338 @code{.short} is the same as @samp{.word}.  @xref{Word,,@code{.word}}.
4339 @end ifset
4340 @ifset W32
4341 This expects zero or more @var{expressions}, and emits
4342 a 16 bit number for each.
4343 @end ifset
4344 @end ifclear
4345
4346 @node Single
4347 @section @code{.single @var{flonums}}
4348
4349 @cindex @code{single} directive
4350 @cindex floating point numbers (single)
4351 This directive assembles zero or more flonums, separated by commas.  It
4352 has the same effect as @code{.float}.
4353 @ifset GENERIC
4354 The exact kind of floating point numbers emitted depends on how
4355 @code{@value{AS}} is configured.  @xref{Machine Dependencies}.
4356 @end ifset
4357 @ifclear GENERIC
4358 @ifset IEEEFLOAT
4359 On the @value{TARGET} family, @code{.single} emits 32-bit floating point
4360 numbers in @sc{ieee} format.
4361 @end ifset
4362 @end ifclear
4363
4364 @ifset COFF
4365 @node Size
4366 @section @code{.size}
4367
4368 @cindex @code{size} directive
4369 This directive is generated by compilers to include auxiliary debugging
4370 information in the symbol table.  It is only permitted inside
4371 @code{.def}/@code{.endef} pairs.
4372 @ifset BOUT
4373
4374 @samp{.size} is only meaningful when generating COFF format output; when
4375 @code{@value{AS}} is generating @code{b.out}, it accepts this directive but
4376 ignores it.
4377 @end ifset
4378 @end ifset
4379
4380 @node Sleb128
4381 @section @code{.sleb128 @var{expressions}}
4382
4383 @cindex @code{sleb128} directive
4384 @var{sleb128} stands for ``signed little endian base 128.''  This is a 
4385 compact, variable length representation of numbers used by the DWARF
4386 symbolic debugging format.  @xref{Uleb128,@code{.uleb128}}.
4387
4388 @ifclear no-space-dir
4389 @node Skip
4390 @section @code{.skip @var{size} , @var{fill}}
4391
4392 @cindex @code{skip} directive
4393 @cindex filling memory
4394 This directive emits @var{size} bytes, each of value @var{fill}.  Both
4395 @var{size} and @var{fill} are absolute expressions.  If the comma and
4396 @var{fill} are omitted, @var{fill} is assumed to be zero.  This is the same as
4397 @samp{.space}.
4398
4399 @node Space
4400 @section @code{.space @var{size} , @var{fill}}
4401
4402 @cindex @code{space} directive
4403 @cindex filling memory
4404 This directive emits @var{size} bytes, each of value @var{fill}.  Both
4405 @var{size} and @var{fill} are absolute expressions.  If the comma
4406 and @var{fill} are omitted, @var{fill} is assumed to be zero.  This is the same
4407 as @samp{.skip}.
4408
4409 @ifset HPPA
4410 @quotation
4411 @emph{Warning:} @code{.space} has a completely different meaning for HPPA
4412 targets; use @code{.block} as a substitute.  See @cite{HP9000 Series 800
4413 Assembly Language Reference Manual} (HP 92432-90001) for the meaning of the
4414 @code{.space} directive.  @xref{HPPA Directives,,HPPA Assembler Directives},
4415 for a summary.
4416 @end quotation
4417 @end ifset
4418 @end ifclear
4419
4420 @ifset A29K
4421 @ifclear GENERIC
4422 @node Space
4423 @section @code{.space}
4424 @cindex @code{space} directive
4425 @end ifclear
4426 On the AMD 29K, this directive is ignored; it is accepted for
4427 compatibility with other AMD 29K assemblers.
4428
4429 @quotation
4430 @emph{Warning:} In most versions of the @sc{gnu} assembler, the directive
4431 @code{.space} has the effect of @code{.block}  @xref{Machine Dependencies}.
4432 @end quotation
4433 @end ifset
4434
4435 @ifset have-stabs
4436 @node Stab
4437 @section @code{.stabd, .stabn, .stabs}
4438
4439 @cindex symbolic debuggers, information for
4440 @cindex @code{stab@var{x}} directives
4441 There are three directives that begin @samp{.stab}.
4442 All emit symbols (@pxref{Symbols}), for use by symbolic debuggers.
4443 The symbols are not entered in the @code{@value{AS}} hash table: they
4444 cannot be referenced elsewhere in the source file.
4445 Up to five fields are required:
4446
4447 @table @var
4448 @item string
4449 This is the symbol's name.  It may contain any character except
4450 @samp{\000}, so is more general than ordinary symbol names.  Some
4451 debuggers used to code arbitrarily complex structures into symbol names
4452 using this field.
4453
4454 @item type
4455 An absolute expression.  The symbol's type is set to the low 8 bits of
4456 this expression.  Any bit pattern is permitted, but @code{@value{LD}}
4457 and debuggers choke on silly bit patterns.
4458
4459 @item other
4460 An absolute expression.  The symbol's ``other'' attribute is set to the
4461 low 8 bits of this expression.
4462
4463 @item desc
4464 An absolute expression.  The symbol's descriptor is set to the low 16
4465 bits of this expression.
4466
4467 @item value
4468 An absolute expression which becomes the symbol's value.
4469 @end table
4470
4471 If a warning is detected while reading a @code{.stabd}, @code{.stabn},
4472 or @code{.stabs} statement, the symbol has probably already been created;
4473 you get a half-formed symbol in your object file.  This is
4474 compatible with earlier assemblers!
4475
4476 @table @code
4477 @cindex @code{stabd} directive
4478 @item .stabd @var{type} , @var{other} , @var{desc}
4479
4480 The ``name'' of the symbol generated is not even an empty string.
4481 It is a null pointer, for compatibility.  Older assemblers used a
4482 null pointer so they didn't waste space in object files with empty
4483 strings.
4484
4485 The symbol's value is set to the location counter,
4486 relocatably.  When your program is linked, the value of this symbol
4487 is the address of the location counter when the @code{.stabd} was
4488 assembled.
4489
4490 @cindex @code{stabn} directive
4491 @item .stabn @var{type} , @var{other} , @var{desc} , @var{value}
4492 The name of the symbol is set to the empty string @code{""}.
4493
4494 @cindex @code{stabs} directive
4495 @item .stabs @var{string} ,  @var{type} , @var{other} , @var{desc} , @var{value}
4496 All five fields are specified.
4497 @end table
4498 @end ifset
4499 @c end     have-stabs
4500
4501 @node String
4502 @section @code{.string} "@var{str}"
4503
4504 @cindex string, copying to object file
4505 @cindex @code{string} directive
4506
4507 Copy the characters in @var{str} to the object file.  You may specify more than
4508 one string to copy, separated by commas.  Unless otherwise specified for a
4509 particular machine, the assembler marks the end of each string with a 0 byte.
4510 You can use any of the escape sequences described in @ref{Strings,,Strings}.
4511
4512 @ifset ELF
4513 @node Symver
4514 @section @code{.symver}
4515 @cindex @code{symver} directive
4516 @cindex symbol versioning
4517 @cindex versions of symbols
4518 Use the @code{.symver} directive to bind symbols to specific version nodes
4519 within a source file.  This is only supported on ELF platforms, and is
4520 typically used when assembling files to be linked into a shared library.
4521 There are cases where it may make sense to use this in objects to be bound
4522 into an application itself so as to override a versioned symbol from a
4523 shared library.
4524
4525 For ELF targets, the @code{.symver} directive is used like this:
4526 @smallexample
4527 .symver @var{name}, @var{name2@@nodename}
4528 @end smallexample
4529 In this case, the symbol @var{name} must exist and be defined within the file
4530 being assembled.  The @code{.versym} directive effectively creates a symbol
4531 alias with the name @var{name2@@nodename}, and in fact the main reason that we
4532 just don't try and create a regular alias is that the @var{@@} character isn't
4533 permitted in symbol names.  The @var{name2} part of the name is the actual name
4534 of the symbol by which it will be externally referenced.  The name @var{name}
4535 itself is merely a name of convenience that is used so that it is possible to
4536 have definitions for multiple versions of a function within a single source
4537 file, and so that the compiler can unambiguously know which version of a
4538 function is being mentioned.  The @var{nodename} portion of the alias should be
4539 the name of a node specified in the version script supplied to the linker when
4540 building a shared library.  If you are attempting to override a versioned
4541 symbol from a shared library, then @var{nodename} should correspond to the
4542 nodename of the symbol you are trying to override.
4543 @end ifset
4544
4545 @ifset COFF
4546 @node Tag
4547 @section @code{.tag @var{structname}}
4548
4549 @cindex COFF structure debugging
4550 @cindex structure debugging, COFF
4551 @cindex @code{tag} directive
4552 This directive is generated by compilers to include auxiliary debugging
4553 information in the symbol table.  It is only permitted inside
4554 @code{.def}/@code{.endef} pairs.  Tags are used to link structure
4555 definitions in the symbol table with instances of those structures.
4556 @ifset BOUT
4557
4558 @samp{.tag} is only used when generating COFF format output; when
4559 @code{@value{AS}} is generating @code{b.out}, it accepts this directive but
4560 ignores it.
4561 @end ifset
4562 @end ifset
4563
4564 @node Text
4565 @section @code{.text @var{subsection}}
4566
4567 @cindex @code{text} directive
4568 Tells @code{@value{AS}} to assemble the following statements onto the end of
4569 the text subsection numbered @var{subsection}, which is an absolute
4570 expression.  If @var{subsection} is omitted, subsection number zero
4571 is used.
4572
4573 @node Title
4574 @section @code{.title "@var{heading}"}
4575
4576 @cindex @code{title} directive
4577 @cindex listing control: title line
4578 Use @var{heading} as the title (second line, immediately after the
4579 source file name and pagenumber) when generating assembly listings.
4580
4581 This directive affects subsequent pages, as well as the current page if
4582 it appears within ten lines of the top of a page.
4583
4584 @ifset COFF
4585 @node Type
4586 @section @code{.type @var{int}}
4587
4588 @cindex COFF symbol type
4589 @cindex symbol type, COFF
4590 @cindex @code{type} directive
4591 This directive, permitted only within @code{.def}/@code{.endef} pairs,
4592 records the integer @var{int} as the type attribute of a symbol table entry.
4593 @ifset BOUT
4594
4595 @samp{.type} is associated only with COFF format output; when
4596 @code{@value{AS}} is configured for @code{b.out} output, it accepts this
4597 directive but ignores it.
4598 @end ifset
4599 @end ifset
4600
4601 @ifset COFF
4602 @node Val
4603 @section @code{.val @var{addr}}
4604
4605 @cindex @code{val} directive
4606 @cindex COFF value attribute
4607 @cindex value attribute, COFF
4608 This directive, permitted only within @code{.def}/@code{.endef} pairs,
4609 records the address @var{addr} as the value attribute of a symbol table
4610 entry.
4611 @ifset BOUT
4612
4613 @samp{.val} is used only for COFF output; when @code{@value{AS}} is
4614 configured for @code{b.out}, it accepts this directive but ignores it.
4615 @end ifset
4616 @end ifset
4617
4618 @node Uleb128
4619 @section @code{.uleb128 @var{expressions}}
4620
4621 @cindex @code{uleb128} directive
4622 @var{uleb128} stands for ``unsigned little endian base 128.''  This is a 
4623 compact, variable length representation of numbers used by the DWARF
4624 symbolic debugging format.  @xref{Sleb128,@code{.sleb128}}.
4625
4626 @node Word
4627 @section @code{.word @var{expressions}}
4628
4629 @cindex @code{word} directive
4630 This directive expects zero or more @var{expressions}, of any section,
4631 separated by commas.
4632 @ifclear GENERIC
4633 @ifset W32
4634 For each expression, @code{@value{AS}} emits a 32-bit number.
4635 @end ifset
4636 @ifset W16
4637 For each expression, @code{@value{AS}} emits a 16-bit number.
4638 @end ifset
4639 @end ifclear
4640 @ifset GENERIC
4641
4642 The size of the number emitted, and its byte order,
4643 depend on what target computer the assembly is for.
4644 @end ifset
4645
4646 @c on amd29k, i960, sparc the "special treatment to support compilers" doesn't
4647 @c happen---32-bit addressability, period; no long/short jumps.
4648 @ifset DIFF-TBL-KLUGE
4649 @cindex difference tables altered
4650 @cindex altered difference tables
4651 @quotation
4652 @emph{Warning: Special Treatment to support Compilers}
4653 @end quotation
4654
4655 @ifset GENERIC
4656 Machines with a 32-bit address space, but that do less than 32-bit
4657 addressing, require the following special treatment.  If the machine of
4658 interest to you does 32-bit addressing (or doesn't require it;
4659 @pxref{Machine Dependencies}), you can ignore this issue.
4660
4661 @end ifset
4662 In order to assemble compiler output into something that works,
4663 @code{@value{AS}} occasionlly does strange things to @samp{.word} directives.
4664 Directives of the form @samp{.word sym1-sym2} are often emitted by
4665 compilers as part of jump tables.  Therefore, when @code{@value{AS}} assembles a
4666 directive of the form @samp{.word sym1-sym2}, and the difference between
4667 @code{sym1} and @code{sym2} does not fit in 16 bits, @code{@value{AS}}
4668 creates a @dfn{secondary jump table}, immediately before the next label.
4669 This secondary jump table is preceded by a short-jump to the
4670 first byte after the secondary table.  This short-jump prevents the flow
4671 of control from accidentally falling into the new table.  Inside the
4672 table is a long-jump to @code{sym2}.  The original @samp{.word}
4673 contains @code{sym1} minus the address of the long-jump to
4674 @code{sym2}.
4675
4676 If there were several occurrences of @samp{.word sym1-sym2} before the
4677 secondary jump table, all of them are adjusted.  If there was a
4678 @samp{.word sym3-sym4}, that also did not fit in sixteen bits, a
4679 long-jump to @code{sym4} is included in the secondary jump table,
4680 and the @code{.word} directives are adjusted to contain @code{sym3}
4681 minus the address of the long-jump to @code{sym4}; and so on, for as many
4682 entries in the original jump table as necessary.
4683
4684 @ifset INTERNALS
4685 @emph{This feature may be disabled by compiling @code{@value{AS}} with the
4686 @samp{-DWORKING_DOT_WORD} option.} This feature is likely to confuse
4687 assembly language programmers.
4688 @end ifset
4689 @end ifset
4690 @c end     DIFF-TBL-KLUGE
4691
4692 @node Deprecated
4693 @section Deprecated Directives
4694
4695 @cindex deprecated directives
4696 @cindex obsolescent directives
4697 One day these directives won't work.
4698 They are included for compatibility with older assemblers.
4699 @table @t
4700 @item .abort
4701 @item .app-file
4702 @item .line
4703 @end table
4704
4705 @ifset GENERIC
4706 @node Machine Dependencies
4707 @chapter Machine Dependent Features
4708
4709 @cindex machine dependencies
4710 The machine instruction sets are (almost by definition) different on
4711 each machine where @code{@value{AS}} runs.  Floating point representations
4712 vary as well, and @code{@value{AS}} often supports a few additional
4713 directives or command-line options for compatibility with other
4714 assemblers on a particular platform.  Finally, some versions of
4715 @code{@value{AS}} support special pseudo-instructions for branch
4716 optimization.
4717
4718 This chapter discusses most of these differences, though it does not
4719 include details on any machine's instruction set.  For details on that
4720 subject, see the hardware manufacturer's manual.
4721
4722 @menu
4723 @ifset A29K
4724 * AMD29K-Dependent::            AMD 29K Dependent Features
4725 @end ifset
4726 @ifset ARC
4727 * ARC-Dependent::               ARC Dependent Features
4728 @end ifset
4729 @ifset ARM
4730 * ARM-Dependent::               ARM Dependent Features
4731 @end ifset
4732 @ifset D10V
4733 * D10V-Dependent::              D10V Dependent Features
4734 @end ifset
4735 @c start-sanitize-d30v
4736 @ifset D30V
4737 * D30V-Dependent::              D30V Dependent Features
4738 @end ifset
4739 @c end-sanitize-d30v
4740 @ifset H8/300
4741 * H8/300-Dependent::            Hitachi H8/300 Dependent Features
4742 @end ifset
4743 @ifset H8/500
4744 * H8/500-Dependent::            Hitachi H8/500 Dependent Features
4745 @end ifset
4746 @ifset HPPA
4747 * HPPA-Dependent::              HPPA Dependent Features
4748 @end ifset
4749 @ifset I80386
4750 * i386-Dependent::              Intel 80386 Dependent Features
4751 @end ifset
4752 @ifset I960
4753 * i960-Dependent::              Intel 80960 Dependent Features
4754 @end ifset
4755 @c start-sanitize-m32rx
4756 @ifset M32R
4757 * M32R-Dependent::              M32R Dependent Features
4758 @end ifset
4759 @c end-sanitize-m32rx
4760 @ifset M680X0
4761 * M68K-Dependent::              M680x0 Dependent Features
4762 @end ifset
4763 @ifset MIPS
4764 * MIPS-Dependent::              MIPS Dependent Features
4765 @end ifset
4766 @ifset SH
4767 * SH-Dependent::                Hitachi SH Dependent Features
4768 @end ifset
4769 @ifset SPARC
4770 * Sparc-Dependent::             SPARC Dependent Features
4771 @end ifset
4772 @ifset V850
4773 * V850-Dependent::              V850 Dependent Features
4774 @end ifset
4775 @ifset Z8000
4776 * Z8000-Dependent::             Z8000 Dependent Features
4777 @end ifset
4778 @ifset VAX
4779 * Vax-Dependent::               VAX Dependent Features
4780 @end ifset
4781 @end menu
4782
4783 @lowersections
4784 @end ifset
4785
4786 @c The following major nodes are *sections* in the GENERIC version, *chapters*
4787 @c in single-cpu versions.  This is mainly achieved by @lowersections.  There is a
4788 @c peculiarity: to preserve cross-references, there must be a node called
4789 @c "Machine Dependencies".  Hence the conditional nodenames in each
4790 @c major node below.  Node defaulting in makeinfo requires adjacency of
4791 @c node and sectioning commands; hence the repetition of @chapter BLAH
4792 @c in both conditional blocks.
4793
4794 @ifset ARC
4795 @ifset GENERIC
4796 @page
4797 @node ARC-Dependent
4798 @chapter ARC Dependent Features
4799 @end ifset
4800 @ifclear GENERIC
4801 @node Machine Dependencies
4802 @chapter ARC Dependent Features
4803 @end ifclear
4804
4805 @cindex ARC support
4806 @menu
4807 * ARC-Opts::                    Options
4808 * ARC-Float::                   Floating Point
4809 * ARC-Directives::              Sparc Machine Directives
4810 @end menu
4811
4812 @node ARC-Opts
4813 @section Options
4814
4815 @cindex options for ARC
4816 @cindex ARC options
4817 @cindex architectures, ARC
4818 @cindex ARC architectures
4819 The ARC chip family includes several successive levels (or other
4820 variants) of chip, using the same core instruction set, but including
4821 a few additional instructions at each level.
4822
4823 By default, @code{@value{AS}} assumes the core instruction set (ARC
4824 base).  The @code{.cpu} pseudo-op is intended to be used to select
4825 the variant.
4826
4827 @table @code
4828 @cindex @code{-mbig-endian} option (ARC)
4829 @cindex @code{-mlittle-endian} option (ARC)
4830 @cindex ARC big-endian output
4831 @cindex ARC little-endian output
4832 @cindex big-endian output, ARC
4833 @cindex little-endian output, ARC
4834 @item -mbig-endian
4835 @itemx -mlittle-endian
4836 Any @sc{arc} configuration of @code{@value{AS}} can select big-endian or
4837 little-endian output at run time (unlike most other @sc{gnu} development
4838 tools, which must be configured for one or the other).  Use
4839 @samp{-mbig-endian} to select big-endian output, and @samp{-mlittle-endian}
4840 for little-endian.
4841 @end table
4842
4843 @node ARC-Float
4844 @section Floating Point
4845
4846 @cindex floating point, ARC (@sc{ieee})
4847 @cindex ARC floating point (@sc{ieee})
4848 The ARC cpu family currently does not have hardware floating point
4849 support.  Software floating point support is provided by @code{GCC}
4850 and uses @sc{ieee} floating-point numbers.
4851
4852 @node ARC-Directives
4853 @section ARC Machine Directives
4854
4855 @cindex ARC machine directives
4856 @cindex machine directives, ARC
4857 The ARC version of @code{@value{AS}} supports the following additional
4858 machine directives:
4859
4860 @table @code
4861 @item .cpu
4862 @cindex @code{cpu} directive, SPARC
4863 This must be followed by the desired cpu.
4864 The ARC is intended to be customizable, @code{.cpu} is used to
4865 select the desired variant [though currently there are none].
4866
4867 @end table
4868
4869 @end ifset
4870
4871 @ifset A29K
4872 @include c-a29k.texi
4873 @end ifset
4874
4875 @ifset ARM
4876 @include c-arm.texi
4877 @end ifset
4878
4879 @ifset Hitachi-all
4880 @ifclear GENERIC
4881 @node Machine Dependencies
4882 @chapter Machine Dependent Features
4883
4884 The machine instruction sets are different on each Hitachi chip family,
4885 and there are also some syntax differences among the families.  This
4886 chapter describes the specific @code{@value{AS}} features for each
4887 family.
4888
4889 @menu
4890 * H8/300-Dependent::            Hitachi H8/300 Dependent Features
4891 * H8/500-Dependent::            Hitachi H8/500 Dependent Features
4892 * SH-Dependent::                Hitachi SH Dependent Features
4893 @end menu
4894 @lowersections
4895 @end ifclear
4896 @end ifset
4897
4898 @ifset D10V
4899 @include c-d10v.texi
4900 @end ifset
4901
4902 @c start-sanitize-d30v
4903 @ifset D30V
4904 @include c-d30v.texi
4905 @end ifset
4906 @c end-sanitize-d30v
4907
4908 @ifset H8/300
4909 @include c-h8300.texi
4910 @end ifset
4911
4912 @ifset H8/500
4913 @include c-h8500.texi
4914 @end ifset
4915
4916 @ifset HPPA
4917 @include c-hppa.texi
4918 @end ifset
4919
4920 @ifset I80386
4921 @include c-i386.texi
4922 @end ifset
4923
4924 @ifset I960
4925 @include c-i960.texi
4926 @end ifset
4927
4928 @c start-sanitize-m32rx
4929 @ifset M32R
4930 @include c-m32r.texi
4931 @end ifset
4932 @c end-sanitize-m32rx
4933
4934 @ifset M680X0
4935 @include c-m68k.texi
4936 @end ifset
4937
4938 @ifset MIPS
4939 @include c-mips.texi
4940 @end ifset
4941
4942 @ifset NS32K
4943 @include c-ns32k.texi
4944 @end ifset
4945
4946 @ifset SH
4947 @include c-sh.texi
4948 @end ifset
4949
4950 @ifset SPARC
4951 @include c-sparc.texi
4952 @end ifset
4953
4954 @ifset Z8000
4955 @include c-z8k.texi
4956 @end ifset
4957
4958 @ifset VAX
4959 @include c-vax.texi
4960 @end ifset
4961
4962 @ifset V850
4963 @include c-v850.texi
4964 @end ifset
4965
4966 @ifset GENERIC
4967 @c reverse effect of @down at top of generic Machine-Dep chapter
4968 @raisesections
4969 @end ifset
4970
4971 @node Reporting Bugs
4972 @chapter Reporting Bugs
4973 @cindex bugs in assembler
4974 @cindex reporting bugs in assembler
4975
4976 Your bug reports play an essential role in making @code{@value{AS}} reliable.
4977
4978 Reporting a bug may help you by bringing a solution to your problem, or it may
4979 not.  But in any case the principal function of a bug report is to help the
4980 entire community by making the next version of @code{@value{AS}} work better.
4981 Bug reports are your contribution to the maintenance of @code{@value{AS}}.
4982
4983 In order for a bug report to serve its purpose, you must include the
4984 information that enables us to fix the bug.
4985
4986 @menu
4987 * Bug Criteria::                Have you found a bug?
4988 * Bug Reporting::               How to report bugs
4989 @end menu
4990
4991 @node Bug Criteria
4992 @section Have you found a bug?
4993 @cindex bug criteria
4994
4995 If you are not sure whether you have found a bug, here are some guidelines:
4996
4997 @itemize @bullet
4998 @cindex fatal signal
4999 @cindex assembler crash
5000 @cindex crash of assembler
5001 @item
5002 If the assembler gets a fatal signal, for any input whatever, that is a
5003 @code{@value{AS}} bug.  Reliable assemblers never crash.
5004
5005 @cindex error on valid input
5006 @item
5007 If @code{@value{AS}} produces an error message for valid input, that is a bug.
5008
5009 @cindex invalid input
5010 @item
5011 If @code{@value{AS}} does not produce an error message for invalid input, that
5012 is a bug.  However, you should note that your idea of ``invalid input'' might
5013 be our idea of ``an extension'' or ``support for traditional practice''.
5014
5015 @item
5016 If you are an experienced user of assemblers, your suggestions for improvement
5017 of @code{@value{AS}} are welcome in any case.
5018 @end itemize
5019
5020 @node Bug Reporting
5021 @section How to report bugs
5022 @cindex bug reports
5023 @cindex assembler bugs, reporting
5024
5025 A number of companies and individuals offer support for @sc{gnu} products.  If
5026 you obtained @code{@value{AS}} from a support organization, we recommend you
5027 contact that organization first.
5028
5029 You can find contact information for many support companies and
5030 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
5031 distribution.
5032
5033 In any event, we also recommend that you send bug reports for @code{@value{AS}}
5034 to @samp{bug-gnu-utils@@gnu.org}.
5035
5036 The fundamental principle of reporting bugs usefully is this:
5037 @strong{report all the facts}.  If you are not sure whether to state a
5038 fact or leave it out, state it!
5039
5040 Often people omit facts because they think they know what causes the problem
5041 and assume that some details do not matter.  Thus, you might assume that the
5042 name of a symbol you use in an example does not matter.  Well, probably it does
5043 not, but one cannot be sure.  Perhaps the bug is a stray memory reference which
5044 happens to fetch from the location where that name is stored in memory;
5045 perhaps, if the name were different, the contents of that location would fool
5046 the assembler into doing the right thing despite the bug.  Play it safe and
5047 give a specific, complete example.  That is the easiest thing for you to do,
5048 and the most helpful.
5049
5050 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
5051 it is new to us.  Therefore, always write your bug reports on the assumption
5052 that the bug has not been reported previously.
5053
5054 Sometimes people give a few sketchy facts and ask, ``Does this ring a
5055 bell?''  Those bug reports are useless, and we urge everyone to
5056 @emph{refuse to respond to them} except to chide the sender to report
5057 bugs properly.
5058
5059 To enable us to fix the bug, you should include all these things:
5060
5061 @itemize @bullet
5062 @item
5063 The version of @code{@value{AS}}.  @code{@value{AS}} announces it if you start
5064 it with the @samp{--version} argument.
5065
5066 Without this, we will not know whether there is any point in looking for
5067 the bug in the current version of @code{@value{AS}}.
5068
5069 @item
5070 Any patches you may have applied to the @code{@value{AS}} source.
5071
5072 @item
5073 The type of machine you are using, and the operating system name and
5074 version number.
5075
5076 @item
5077 What compiler (and its version) was used to compile @code{@value{AS}}---e.g.
5078 ``@code{gcc-2.7}''.
5079
5080 @item
5081 The command arguments you gave the assembler to assemble your example and
5082 observe the bug.  To guarantee you will not omit something important, list them
5083 all.  A copy of the Makefile (or the output from make) is sufficient.
5084
5085 If we were to try to guess the arguments, we would probably guess wrong
5086 and then we might not encounter the bug.
5087
5088 @item
5089 A complete input file that will reproduce the bug.  If the bug is observed when
5090 the assembler is invoked via a compiler, send the assembler source, not the
5091 high level language source.  Most compilers will produce the assembler source
5092 when run with the @samp{-S} option.  If you are using @code{@value{GCC}}, use
5093 the options @samp{-v --save-temps}; this will save the assembler source in a
5094 file with an extension of @file{.s}, and also show you exactly how
5095 @code{@value{AS}} is being run.
5096
5097 @item
5098 A description of what behavior you observe that you believe is
5099 incorrect.  For example, ``It gets a fatal signal.''
5100
5101 Of course, if the bug is that @code{@value{AS}} gets a fatal signal, then we
5102 will certainly notice it.  But if the bug is incorrect output, we might not
5103 notice unless it is glaringly wrong.  You might as well not give us a chance to
5104 make a mistake.
5105
5106 Even if the problem you experience is a fatal signal, you should still say so
5107 explicitly.  Suppose something strange is going on, such as, your copy of
5108 @code{@value{AS}} is out of synch, or you have encountered a bug in the C
5109 library on your system.  (This has happened!)  Your copy might crash and ours
5110 would not.  If you told us to expect a crash, then when ours fails to crash, we
5111 would know that the bug was not happening for us.  If you had not told us to
5112 expect a crash, then we would not be able to draw any conclusion from our
5113 observations.
5114
5115 @item
5116 If you wish to suggest changes to the @code{@value{AS}} source, send us context
5117 diffs, as generated by @code{diff} with the @samp{-u}, @samp{-c}, or @samp{-p}
5118 option.  Always send diffs from the old file to the new file.  If you even
5119 discuss something in the @code{@value{AS}} source, refer to it by context, not
5120 by line number.
5121
5122 The line numbers in our development sources will not match those in your
5123 sources.  Your line numbers would convey no useful information to us.
5124 @end itemize
5125
5126 Here are some things that are not necessary:
5127
5128 @itemize @bullet
5129 @item
5130 A description of the envelope of the bug.
5131
5132 Often people who encounter a bug spend a lot of time investigating
5133 which changes to the input file will make the bug go away and which
5134 changes will not affect it.
5135
5136 This is often time consuming and not very useful, because the way we
5137 will find the bug is by running a single example under the debugger
5138 with breakpoints, not by pure deduction from a series of examples.
5139 We recommend that you save your time for something else.
5140
5141 Of course, if you can find a simpler example to report @emph{instead}
5142 of the original one, that is a convenience for us.  Errors in the
5143 output will be easier to spot, running under the debugger will take
5144 less time, and so on.
5145
5146 However, simplification is not vital; if you do not want to do this,
5147 report the bug anyway and send us the entire test case you used.
5148
5149 @item
5150 A patch for the bug.
5151
5152 A patch for the bug does help us if it is a good one.  But do not omit
5153 the necessary information, such as the test case, on the assumption that
5154 a patch is all we need.  We might see problems with your patch and decide
5155 to fix the problem another way, or we might not understand it at all.
5156
5157 Sometimes with a program as complicated as @code{@value{AS}} it is very hard to
5158 construct an example that will make the program follow a certain path through
5159 the code.  If you do not send us the example, we will not be able to construct
5160 one, so we will not be able to verify that the bug is fixed.
5161
5162 And if we cannot understand what bug you are trying to fix, or why your
5163 patch should be an improvement, we will not install it.  A test case will
5164 help us to understand.
5165
5166 @item
5167 A guess about what the bug is or what it depends on.
5168
5169 Such guesses are usually wrong.  Even we cannot guess right about such
5170 things without first using the debugger to find the facts.
5171 @end itemize
5172
5173 @node Acknowledgements
5174 @chapter Acknowledgements
5175
5176 If you have contributed to @code{@value{AS}} and your name isn't listed here,
5177 it is not meant as a slight.  We just don't know about it.  Send mail to the
5178 maintainer, and we'll correct the situation.  Currently 
5179 @c (January 1994), 
5180 the maintainer is Ken Raeburn (email address @code{raeburn@@cygnus.com}).
5181
5182 Dean Elsner wrote the original @sc{gnu} assembler for the VAX.@footnote{Any
5183 more details?}
5184
5185 Jay Fenlason maintained GAS for a while, adding support for GDB-specific debug
5186 information and the 68k series machines, most of the preprocessing pass, and
5187 extensive changes in @file{messages.c}, @file{input-file.c}, @file{write.c}.
5188
5189 K. Richard Pixley maintained GAS for a while, adding various enhancements and
5190 many bug fixes, including merging support for several processors, breaking GAS
5191 up to handle multiple object file format back ends (including heavy rewrite,
5192 testing, an integration of the coff and b.out back ends), adding configuration
5193 including heavy testing and verification of cross assemblers and file splits
5194 and renaming, converted GAS to strictly ANSI C including full prototypes, added
5195 support for m680[34]0 and cpu32, did considerable work on i960 including a COFF
5196 port (including considerable amounts of reverse engineering), a SPARC opcode
5197 file rewrite, DECstation, rs6000, and hp300hpux host ports, updated ``know''
5198 assertions and made them work, much other reorganization, cleanup, and lint.
5199
5200 Ken Raeburn wrote the high-level BFD interface code to replace most of the code
5201 in format-specific I/O modules.
5202
5203 The original VMS support was contributed by David L. Kashtan.  Eric Youngdale
5204 has done much work with it since.
5205
5206 The Intel 80386 machine description was written by Eliot Dresselhaus.
5207
5208 Minh Tran-Le at IntelliCorp contributed some AIX 386 support.
5209
5210 The Motorola 88k machine description was contributed by Devon Bowen of Buffalo
5211 University and Torbjorn Granlund of the Swedish Institute of Computer Science.
5212
5213 Keith Knowles at the Open Software Foundation wrote the original MIPS back end
5214 (@file{tc-mips.c}, @file{tc-mips.h}), and contributed Rose format support
5215 (which hasn't been merged in yet).  Ralph Campbell worked with the MIPS code to
5216 support a.out format.
5217
5218 Support for the Zilog Z8k and Hitachi H8/300 and H8/500 processors (tc-z8k,
5219 tc-h8300, tc-h8500), and IEEE 695 object file format (obj-ieee), was written by
5220 Steve Chamberlain of Cygnus Support.  Steve also modified the COFF back end to
5221 use BFD for some low-level operations, for use with the H8/300 and AMD 29k
5222 targets.
5223
5224 John Gilmore built the AMD 29000 support, added @code{.include} support, and
5225 simplified the configuration of which versions accept which directives.  He
5226 updated the 68k machine description so that Motorola's opcodes always produced
5227 fixed-size instructions (e.g. @code{jsr}), while synthetic instructions
5228 remained shrinkable (@code{jbsr}).  John fixed many bugs, including true tested
5229 cross-compilation support, and one bug in relaxation that took a week and
5230 required the proverbial one-bit fix.
5231
5232 Ian Lance Taylor of Cygnus Support merged the Motorola and MIT syntax for the
5233 68k, completed support for some COFF targets (68k, i386 SVR3, and SCO Unix),
5234 added support for MIPS ECOFF and ELF targets, wrote the initial RS/6000 and
5235 PowerPC assembler, and made a few other minor patches.
5236
5237 Steve Chamberlain made @code{@value{AS}} able to generate listings.
5238
5239 Hewlett-Packard contributed support for the HP9000/300.
5240
5241 Jeff Law wrote GAS and BFD support for the native HPPA object format (SOM)
5242 along with a fairly extensive HPPA testsuite (for both SOM and ELF object
5243 formats).  This work was supported by both the Center for Software Science at
5244 the University of Utah and Cygnus Support.
5245
5246 Support for ELF format files has been worked on by Mark Eichin of Cygnus
5247 Support (original, incomplete implementation for SPARC), Pete Hoogenboom and
5248 Jeff Law at the University of Utah (HPPA mainly), Michael Meissner of the Open
5249 Software Foundation (i386 mainly), and Ken Raeburn of Cygnus Support (sparc,
5250 and some initial 64-bit support).
5251
5252 Richard Henderson rewrote the Alpha assembler. Klaus Kaempf wrote GAS and BFD
5253 support for openVMS/Alpha.
5254
5255 Several engineers at Cygnus Support have also provided many small bug fixes and
5256 configuration enhancements.
5257
5258 Many others have contributed large or small bugfixes and enhancements.  If
5259 you have contributed significant work and are not mentioned on this list, and
5260 want to be, let us know.  Some of the history has been lost; we are not
5261 intentionally leaving anyone out.
5262
5263 @node Index
5264 @unnumbered Index
5265
5266 @printindex cp
5267
5268 @contents
5269 @bye
5270 @c Local Variables:
5271 @c fill-column: 79
5272 @c End: