1 \input texinfo @c -*-Texinfo-*-
2 @c Copyright 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
3 @c 2001, 2002, 2003, 2004, 2005
4 @c Free Software Foundation, Inc.
5 @c UPDATE!! On future updates--
6 @c (1) check for new machine-dep cmdline options in
7 @c md_parse_option definitions in config/tc-*.c
8 @c (2) for platform-specific directives, examine md_pseudo_op
10 @c (3) for object-format specific directives, examine obj_pseudo_op
12 @c (4) portable directives in potable[] in read.c
16 @macro gcctabopt{body}
19 @c defaults, config file may override:
24 @include asconfig.texi
29 @c common OR combinations of conditions
52 @set abnormal-separator
56 @settitle Using @value{AS}
59 @settitle Using @value{AS} (@value{TARGET})
61 @setchapternewpage odd
66 @c WARE! Some of the machine-dependent sections contain tables of machine
67 @c instructions. Except in multi-column format, these tables look silly.
68 @c Unfortunately, Texinfo doesn't have a general-purpose multi-col format, so
69 @c the multi-col format is faked within @example sections.
71 @c Again unfortunately, the natural size that fits on a page, for these tables,
72 @c is different depending on whether or not smallbook is turned on.
73 @c This matters, because of order: text flow switches columns at each page
76 @c The format faked in this source works reasonably well for smallbook,
77 @c not well for the default large-page format. This manual expects that if you
78 @c turn on @smallbook, you will also uncomment the "@set SMALL" to enable the
79 @c tables in question. You can turn on one without the other at your
80 @c discretion, of course.
83 @c the insn tables look just as silly in info files regardless of smallbook,
84 @c might as well show 'em anyways.
90 * As: (as). The GNU assembler.
91 * Gas: (as). The GNU assembler.
100 This file documents the GNU Assembler "@value{AS}".
102 @c man begin COPYRIGHT
103 Copyright (C) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002 Free Software Foundation, Inc.
105 Permission is granted to copy, distribute and/or modify this document
106 under the terms of the GNU Free Documentation License, Version 1.1
107 or any later version published by the Free Software Foundation;
108 with no Invariant Sections, with no Front-Cover Texts, and with no
109 Back-Cover Texts. A copy of the license is included in the
110 section entitled ``GNU Free Documentation License''.
115 Permission is granted to process this file through Tex and print the
116 results, provided the printed document carries copying permission
117 notice identical to this one except for the removal of this paragraph
118 (this paragraph not being relevant to the printed manual).
124 @title Using @value{AS}
125 @subtitle The @sc{gnu} Assembler
127 @subtitle for the @value{TARGET} family
130 @subtitle Version @value{VERSION}
133 The Free Software Foundation Inc. thanks The Nice Computer
134 Company of Australia for loaning Dean Elsner to write the
135 first (Vax) version of @command{as} for Project @sc{gnu}.
136 The proprietors, management and staff of TNCCA thank FSF for
137 distracting the boss while they got some work
140 @author Dean Elsner, Jay Fenlason & friends
144 \hfill {\it Using {\tt @value{AS}}}\par
145 \hfill Edited by Cygnus Support\par
147 %"boxit" macro for figures:
148 %Modified from Knuth's ``boxit'' macro from TeXbook (answer to exercise 21.3)
149 \gdef\boxit#1#2{\vbox{\hrule\hbox{\vrule\kern3pt
150 \vbox{\parindent=0pt\parskip=0pt\hsize=#1\kern3pt\strut\hfil
151 #2\hfil\strut\kern3pt}\kern3pt\vrule}\hrule}}%box with visible outline
152 \gdef\ibox#1#2{\hbox to #1{#2\hfil}\kern8pt}% invisible box
155 @vskip 0pt plus 1filll
156 Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002 Free Software Foundation, Inc.
158 Permission is granted to copy, distribute and/or modify this document
159 under the terms of the GNU Free Documentation License, Version 1.1
160 or any later version published by the Free Software Foundation;
161 with no Invariant Sections, with no Front-Cover Texts, and with no
162 Back-Cover Texts. A copy of the license is included in the
163 section entitled ``GNU Free Documentation License''.
169 @top Using @value{AS}
171 This file is a user guide to the @sc{gnu} assembler @command{@value{AS}} version
174 This version of the file describes @command{@value{AS}} configured to generate
175 code for @value{TARGET} architectures.
178 This document is distributed under the terms of the GNU Free
179 Documentation License. A copy of the license is included in the
180 section entitled ``GNU Free Documentation License''.
183 * Overview:: Overview
184 * Invoking:: Command-Line Options
186 * Sections:: Sections and Relocation
188 * Expressions:: Expressions
189 * Pseudo Ops:: Assembler Directives
190 * Machine Dependencies:: Machine Dependent Features
191 * Reporting Bugs:: Reporting Bugs
192 * Acknowledgements:: Who Did What
193 * GNU Free Documentation License:: GNU Free Documentation License
201 This manual is a user guide to the @sc{gnu} assembler @command{@value{AS}}.
203 This version of the manual describes @command{@value{AS}} configured to generate
204 code for @value{TARGET} architectures.
208 @cindex invocation summary
209 @cindex option summary
210 @cindex summary of options
211 Here is a brief summary of how to invoke @command{@value{AS}}. For details,
212 @pxref{Invoking,,Command-Line Options}.
214 @c man title AS the portable GNU assembler.
218 gcc(1), ld(1), and the Info entries for @file{binutils} and @file{ld}.
222 @c We don't use deffn and friends for the following because they seem
223 @c to be limited to one line for the header.
225 @c man begin SYNOPSIS
226 @value{AS} [@b{-a}[@b{cdhlns}][=@var{file}]] [@b{--alternate}] [@b{-D}]
227 [@b{--defsym} @var{sym}=@var{val}] [@b{-f}] [@b{-g}] [@b{--gstabs}]
228 [@b{--gstabs+}] [@b{--gdwarf-2}] [@b{--help}] [@b{-I} @var{dir}] [@b{-J}]
229 [@b{-K}] [@b{-L}] [@b{--listing-lhs-width}=@var{NUM}]
230 [@b{--listing-lhs-width2}=@var{NUM}] [@b{--listing-rhs-width}=@var{NUM}]
231 [@b{--listing-cont-lines}=@var{NUM}] [@b{--keep-locals}] [@b{-o}
232 @var{objfile}] [@b{-R}] [@b{--reduce-memory-overheads}] [@b{--statistics}]
233 [@b{-v}] [@b{-version}] [@b{--version}] [@b{-W}] [@b{--warn}]
234 [@b{--fatal-warnings}] [@b{-w}] [@b{-x}] [@b{-Z}] [@b{--target-help}]
235 [@var{target-options}] [@b{--}|@var{files} @dots{}]
237 @c Target dependent options are listed below. Keep the list sorted.
238 @c Add an empty line for separation.
241 @emph{Target Alpha options:}
243 [@b{-mdebug} | @b{-no-mdebug}]
244 [@b{-relax}] [@b{-g}] [@b{-G@var{size}}]
245 [@b{-F}] [@b{-32addr}]
249 @emph{Target ARC options:}
255 @emph{Target ARM options:}
256 @c Don't document the deprecated options
257 [@b{-mcpu}=@var{processor}[+@var{extension}@dots{}]]
258 [@b{-march}=@var{architecture}[+@var{extension}@dots{}]]
259 [@b{-mfpu}=@var{floating-point-format}]
260 [@b{-mfloat-abi}=@var{abi}]
261 [@b{-meabi}=@var{ver}]
264 [@b{-mapcs-32}|@b{-mapcs-26}|@b{-mapcs-float}|
265 @b{-mapcs-reentrant}]
266 [@b{-mthumb-interwork}] [@b{-k}]
270 @emph{Target CRIS options:}
271 [@b{--underscore} | @b{--no-underscore}]
273 [@b{--emulation=criself} | @b{--emulation=crisaout}]
274 [@b{--march=v0_v10} | @b{--march=v10} | @b{--march=v32} | @b{--march=common_v10_v32}]
275 @c Deprecated -- deliberately not documented.
280 @emph{Target D10V options:}
285 @emph{Target D30V options:}
286 [@b{-O}|@b{-n}|@b{-N}]
289 @c Renesas family chips have no machine-dependent assembler options
292 @c HPPA has no machine-dependent assembler options (yet).
296 @emph{Target i386 options:}
297 [@b{--32}|@b{--64}] [@b{-n}]
301 @emph{Target i960 options:}
302 @c see md_parse_option in tc-i960.c
303 [@b{-ACA}|@b{-ACA_A}|@b{-ACB}|@b{-ACC}|@b{-AKA}|@b{-AKB}|
305 [@b{-b}] [@b{-no-relax}]
309 @emph{Target IA-64 options:}
310 [@b{-mconstant-gp}|@b{-mauto-pic}]
311 [@b{-milp32}|@b{-milp64}|@b{-mlp64}|@b{-mp64}]
313 [@b{-mtune=itanium1}|@b{-mtune=itanium2}]
314 [@b{-munwind-check=warning}|@b{-munwind-check=error}]
315 [@b{-mhint.b=ok}|@b{-mhint.b=warning}|@b{-mhint.b=error}]
316 [@b{-x}|@b{-xexplicit}] [@b{-xauto}] [@b{-xdebug}]
320 @emph{Target IP2K options:}
321 [@b{-mip2022}|@b{-mip2022ext}]
325 @emph{Target M32C options:}
326 [@b{-m32c}|@b{-m16c}]
330 @emph{Target M32R options:}
331 [@b{--m32rx}|@b{--[no-]warn-explicit-parallel-conflicts}|
336 @emph{Target M680X0 options:}
337 [@b{-l}] [@b{-m68000}|@b{-m68010}|@b{-m68020}|@dots{}]
341 @emph{Target M68HC11 options:}
342 [@b{-m68hc11}|@b{-m68hc12}|@b{-m68hcs12}]
343 [@b{-mshort}|@b{-mlong}]
344 [@b{-mshort-double}|@b{-mlong-double}]
345 [@b{--force-long-branchs}] [@b{--short-branchs}]
346 [@b{--strict-direct-mode}] [@b{--print-insn-syntax}]
347 [@b{--print-opcodes}] [@b{--generate-example}]
351 @emph{Target MCORE options:}
352 [@b{-jsri2bsr}] [@b{-sifilter}] [@b{-relax}]
353 [@b{-mcpu=[210|340]}]
357 @emph{Target MIPS options:}
358 [@b{-nocpp}] [@b{-EL}] [@b{-EB}] [@b{-O}[@var{optimization level}]]
359 [@b{-g}[@var{debug level}]] [@b{-G} @var{num}] [@b{-KPIC}] [@b{-call_shared}]
360 [@b{-non_shared}] [@b{-xgot}]
361 [@b{-mabi}=@var{ABI}] [@b{-32}] [@b{-n32}] [@b{-64}] [@b{-mfp32}] [@b{-mgp32}]
362 [@b{-march}=@var{CPU}] [@b{-mtune}=@var{CPU}] [@b{-mips1}] [@b{-mips2}]
363 [@b{-mips3}] [@b{-mips4}] [@b{-mips5}] [@b{-mips32}] [@b{-mips32r2}]
364 [@b{-mips64}] [@b{-mips64r2}]
365 [@b{-construct-floats}] [@b{-no-construct-floats}]
366 [@b{-trap}] [@b{-no-break}] [@b{-break}] [@b{-no-trap}]
367 [@b{-mfix7000}] [@b{-mno-fix7000}]
368 [@b{-mips16}] [@b{-no-mips16}]
369 [@b{-mips3d}] [@b{-no-mips3d}]
370 [@b{-mdmx}] [@b{-no-mdmx}]
371 [@b{-mdsp}] [@b{-mno-dsp}]
372 [@b{-mmt}] [@b{-mno-mt}]
373 [@b{-mdebug}] [@b{-no-mdebug}]
374 [@b{-mpdr}] [@b{-mno-pdr}]
378 @emph{Target MMIX options:}
379 [@b{--fixed-special-register-names}] [@b{--globalize-symbols}]
380 [@b{--gnu-syntax}] [@b{--relax}] [@b{--no-predefined-symbols}]
381 [@b{--no-expand}] [@b{--no-merge-gregs}] [@b{-x}]
382 [@b{--linker-allocated-gregs}]
386 @emph{Target PDP11 options:}
387 [@b{-mpic}|@b{-mno-pic}] [@b{-mall}] [@b{-mno-extensions}]
388 [@b{-m}@var{extension}|@b{-mno-}@var{extension}]
389 [@b{-m}@var{cpu}] [@b{-m}@var{machine}]
393 @emph{Target picoJava options:}
398 @emph{Target PowerPC options:}
399 [@b{-mpwrx}|@b{-mpwr2}|@b{-mpwr}|@b{-m601}|@b{-mppc}|@b{-mppc32}|@b{-m603}|@b{-m604}|
400 @b{-m403}|@b{-m405}|@b{-mppc64}|@b{-m620}|@b{-mppc64bridge}|@b{-mbooke}|
401 @b{-mbooke32}|@b{-mbooke64}]
402 [@b{-mcom}|@b{-many}|@b{-maltivec}] [@b{-memb}]
403 [@b{-mregnames}|@b{-mno-regnames}]
404 [@b{-mrelocatable}|@b{-mrelocatable-lib}]
405 [@b{-mlittle}|@b{-mlittle-endian}|@b{-mbig}|@b{-mbig-endian}]
406 [@b{-msolaris}|@b{-mno-solaris}]
410 @emph{Target SPARC options:}
411 @c The order here is important. See c-sparc.texi.
412 [@b{-Av6}|@b{-Av7}|@b{-Av8}|@b{-Asparclet}|@b{-Asparclite}
413 @b{-Av8plus}|@b{-Av8plusa}|@b{-Av9}|@b{-Av9a}]
414 [@b{-xarch=v8plus}|@b{-xarch=v8plusa}] [@b{-bump}]
419 @emph{Target TIC54X options:}
420 [@b{-mcpu=54[123589]}|@b{-mcpu=54[56]lp}] [@b{-mfar-mode}|@b{-mf}]
421 [@b{-merrors-to-file} @var{<filename>}|@b{-me} @var{<filename>}]
424 @c Z8000 has no machine-dependent assembler options
428 @emph{Target Xtensa options:}
429 [@b{--[no-]text-section-literals}] [@b{--[no-]absolute-literals}]
430 [@b{--[no-]target-align}] [@b{--[no-]longcalls}]
431 [@b{--[no-]transform}]
432 [@b{--rename-section} @var{oldname}=@var{newname}]
441 Turn on listings, in any of a variety of ways:
445 omit false conditionals
448 omit debugging directives
451 include high-level source
457 include macro expansions
460 omit forms processing
466 set the name of the listing file
469 You may combine these options; for example, use @samp{-aln} for assembly
470 listing without forms processing. The @samp{=file} option, if used, must be
471 the last one. By itself, @samp{-a} defaults to @samp{-ahls}.
474 Begin in alternate macro mode, see @ref{Altmacro,,@code{.altmacro}}.
477 Ignored. This option is accepted for script compatibility with calls to
480 @item --defsym @var{sym}=@var{value}
481 Define the symbol @var{sym} to be @var{value} before assembling the input file.
482 @var{value} must be an integer constant. As in C, a leading @samp{0x}
483 indicates a hexadecimal value, and a leading @samp{0} indicates an octal value.
486 ``fast''---skip whitespace and comment preprocessing (assume source is
491 Generate debugging information for each assembler source line using whichever
492 debug format is preferred by the target. This currently means either STABS,
496 Generate stabs debugging information for each assembler line. This
497 may help debugging assembler code, if the debugger can handle it.
500 Generate stabs debugging information for each assembler line, with GNU
501 extensions that probably only gdb can handle, and that could make other
502 debuggers crash or refuse to read your program. This
503 may help debugging assembler code. Currently the only GNU extension is
504 the location of the current working directory at assembling time.
507 Generate DWARF2 debugging information for each assembler line. This
508 may help debugging assembler code, if the debugger can handle it. Note---this
509 option is only supported by some targets, not all of them.
512 Print a summary of the command line options and exit.
515 Print a summary of all target specific options and exit.
518 Add directory @var{dir} to the search list for @code{.include} directives.
521 Don't warn about signed overflow.
524 @ifclear DIFF-TBL-KLUGE
525 This option is accepted but has no effect on the @value{TARGET} family.
527 @ifset DIFF-TBL-KLUGE
528 Issue warnings when difference tables altered for long displacements.
533 Keep (in the symbol table) local symbols. On traditional a.out systems
534 these start with @samp{L}, but different systems have different local
537 @item --listing-lhs-width=@var{number}
538 Set the maximum width, in words, of the output data column for an assembler
539 listing to @var{number}.
541 @item --listing-lhs-width2=@var{number}
542 Set the maximum width, in words, of the output data column for continuation
543 lines in an assembler listing to @var{number}.
545 @item --listing-rhs-width=@var{number}
546 Set the maximum width of an input source line, as displayed in a listing, to
549 @item --listing-cont-lines=@var{number}
550 Set the maximum number of lines printed in a listing for a single line of input
553 @item -o @var{objfile}
554 Name the object-file output from @command{@value{AS}} @var{objfile}.
557 Fold the data section into the text section.
559 @kindex --hash-size=@var{number}
560 Set the default size of GAS's hash tables to a prime number close to
561 @var{number}. Increasing this value can reduce the length of time it takes the
562 assembler to perform its tasks, at the expense of increasing the assembler's
563 memory requirements. Similarly reducing this value can reduce the memory
564 requirements at the expense of speed.
566 @item --reduce-memory-overheads
567 This option reduces GAS's memory requirements, at the expense of making the
568 assembly processes slower. Currently this switch is a synonym for
569 @samp{--hash-size=4051}, but in the future it may have other effects as well.
572 Print the maximum space (in bytes) and total time (in seconds) used by
575 @item --strip-local-absolute
576 Remove local absolute symbols from the outgoing symbol table.
580 Print the @command{as} version.
583 Print the @command{as} version and exit.
587 Suppress warning messages.
589 @item --fatal-warnings
590 Treat warnings as errors.
593 Don't suppress warning messages or treat them as errors.
602 Generate an object file even after errors.
604 @item -- | @var{files} @dots{}
605 Standard input, or source files to assemble.
610 The following options are available when @value{AS} is configured for
615 This option selects the core processor variant.
617 Select either big-endian (-EB) or little-endian (-EL) output.
622 The following options are available when @value{AS} is configured for the ARM
626 @item -mcpu=@var{processor}[+@var{extension}@dots{}]
627 Specify which ARM processor variant is the target.
628 @item -march=@var{architecture}[+@var{extension}@dots{}]
629 Specify which ARM architecture variant is used by the target.
630 @item -mfpu=@var{floating-point-format}
631 Select which Floating Point architecture is the target.
632 @item -mfloat-abi=@var{abi}
633 Select which floating point ABI is in use.
635 Enable Thumb only instruction decoding.
636 @item -mapcs-32 | -mapcs-26 | -mapcs-float | -mapcs-reentrant
637 Select which procedure calling convention is in use.
639 Select either big-endian (-EB) or little-endian (-EL) output.
640 @item -mthumb-interwork
641 Specify that the code has been generated with interworking between Thumb and
644 Specify that PIC code has been generated.
649 See the info pages for documentation of the CRIS-specific options.
653 The following options are available when @value{AS} is configured for
656 @cindex D10V optimization
657 @cindex optimization, D10V
659 Optimize output by parallelizing instructions.
664 The following options are available when @value{AS} is configured for a D30V
667 @cindex D30V optimization
668 @cindex optimization, D30V
670 Optimize output by parallelizing instructions.
674 Warn when nops are generated.
676 @cindex D30V nops after 32-bit multiply
678 Warn when a nop after a 32-bit multiply instruction is generated.
683 The following options are available when @value{AS} is configured for the
684 Intel 80960 processor.
687 @item -ACA | -ACA_A | -ACB | -ACC | -AKA | -AKB | -AKC | -AMC
688 Specify which variant of the 960 architecture is the target.
691 Add code to collect statistics about branches taken.
694 Do not alter compare-and-branch instructions for long displacements;
701 The following options are available when @value{AS} is configured for the
707 Specifies that the extended IP2022 instructions are allowed.
710 Restores the default behaviour, which restricts the permitted instructions to
711 just the basic IP2022 ones.
717 The following options are available when @value{AS} is configured for the
718 Renesas M32C and M16C processors.
723 Assemble M32C instructions.
726 Assemble M16C instructions (the default).
732 The following options are available when @value{AS} is configured for the
733 Renesas M32R (formerly Mitsubishi M32R) series.
738 Specify which processor in the M32R family is the target. The default
739 is normally the M32R, but this option changes it to the M32RX.
741 @item --warn-explicit-parallel-conflicts or --Wp
742 Produce warning messages when questionable parallel constructs are
745 @item --no-warn-explicit-parallel-conflicts or --Wnp
746 Do not produce warning messages when questionable parallel constructs are
753 The following options are available when @value{AS} is configured for the
754 Motorola 68000 series.
759 Shorten references to undefined symbols, to one word instead of two.
761 @item -m68000 | -m68008 | -m68010 | -m68020 | -m68030
762 @itemx | -m68040 | -m68060 | -m68302 | -m68331 | -m68332
763 @itemx | -m68333 | -m68340 | -mcpu32 | -m5200
764 Specify what processor in the 68000 family is the target. The default
765 is normally the 68020, but this can be changed at configuration time.
767 @item -m68881 | -m68882 | -mno-68881 | -mno-68882
768 The target machine does (or does not) have a floating-point coprocessor.
769 The default is to assume a coprocessor for 68020, 68030, and cpu32. Although
770 the basic 68000 is not compatible with the 68881, a combination of the
771 two can be specified, since it's possible to do emulation of the
772 coprocessor instructions with the main processor.
774 @item -m68851 | -mno-68851
775 The target machine does (or does not) have a memory-management
776 unit coprocessor. The default is to assume an MMU for 68020 and up.
783 For details about the PDP-11 machine dependent features options,
784 see @ref{PDP-11-Options}.
787 @item -mpic | -mno-pic
788 Generate position-independent (or position-dependent) code. The
789 default is @option{-mpic}.
792 @itemx -mall-extensions
793 Enable all instruction set extensions. This is the default.
795 @item -mno-extensions
796 Disable all instruction set extensions.
798 @item -m@var{extension} | -mno-@var{extension}
799 Enable (or disable) a particular instruction set extension.
802 Enable the instruction set extensions supported by a particular CPU, and
803 disable all other extensions.
805 @item -m@var{machine}
806 Enable the instruction set extensions supported by a particular machine
807 model, and disable all other extensions.
813 The following options are available when @value{AS} is configured for
814 a picoJava processor.
818 @cindex PJ endianness
819 @cindex endianness, PJ
820 @cindex big endian output, PJ
822 Generate ``big endian'' format output.
824 @cindex little endian output, PJ
826 Generate ``little endian'' format output.
832 The following options are available when @value{AS} is configured for the
833 Motorola 68HC11 or 68HC12 series.
837 @item -m68hc11 | -m68hc12 | -m68hcs12
838 Specify what processor is the target. The default is
839 defined by the configuration option when building the assembler.
842 Specify to use the 16-bit integer ABI.
845 Specify to use the 32-bit integer ABI.
848 Specify to use the 32-bit double ABI.
851 Specify to use the 64-bit double ABI.
853 @item --force-long-branchs
854 Relative branches are turned into absolute ones. This concerns
855 conditional branches, unconditional branches and branches to a
858 @item -S | --short-branchs
859 Do not turn relative branchs into absolute ones
860 when the offset is out of range.
862 @item --strict-direct-mode
863 Do not turn the direct addressing mode into extended addressing mode
864 when the instruction does not support direct addressing mode.
866 @item --print-insn-syntax
867 Print the syntax of instruction in case of error.
869 @item --print-opcodes
870 print the list of instructions with syntax and then exit.
872 @item --generate-example
873 print an example of instruction for each possible instruction and then exit.
874 This option is only useful for testing @command{@value{AS}}.
880 The following options are available when @command{@value{AS}} is configured
881 for the SPARC architecture:
884 @item -Av6 | -Av7 | -Av8 | -Asparclet | -Asparclite
885 @itemx -Av8plus | -Av8plusa | -Av9 | -Av9a
886 Explicitly select a variant of the SPARC architecture.
888 @samp{-Av8plus} and @samp{-Av8plusa} select a 32 bit environment.
889 @samp{-Av9} and @samp{-Av9a} select a 64 bit environment.
891 @samp{-Av8plusa} and @samp{-Av9a} enable the SPARC V9 instruction set with
892 UltraSPARC extensions.
894 @item -xarch=v8plus | -xarch=v8plusa
895 For compatibility with the Solaris v9 assembler. These options are
896 equivalent to -Av8plus and -Av8plusa, respectively.
899 Warn when the assembler switches to another architecture.
904 The following options are available when @value{AS} is configured for the 'c54x
909 Enable extended addressing mode. All addresses and relocations will assume
910 extended addressing (usually 23 bits).
911 @item -mcpu=@var{CPU_VERSION}
912 Sets the CPU version being compiled for.
913 @item -merrors-to-file @var{FILENAME}
914 Redirect error output to a file, for broken systems which don't support such
915 behaviour in the shell.
920 The following options are available when @value{AS} is configured for
921 a @sc{mips} processor.
925 This option sets the largest size of an object that can be referenced
926 implicitly with the @code{gp} register. It is only accepted for targets that
927 use ECOFF format, such as a DECstation running Ultrix. The default value is 8.
929 @cindex MIPS endianness
930 @cindex endianness, MIPS
931 @cindex big endian output, MIPS
933 Generate ``big endian'' format output.
935 @cindex little endian output, MIPS
937 Generate ``little endian'' format output.
949 Generate code for a particular @sc{mips} Instruction Set Architecture level.
950 @samp{-mips1} is an alias for @samp{-march=r3000}, @samp{-mips2} is an
951 alias for @samp{-march=r6000}, @samp{-mips3} is an alias for
952 @samp{-march=r4000} and @samp{-mips4} is an alias for @samp{-march=r8000}.
953 @samp{-mips5}, @samp{-mips32}, @samp{-mips32r2}, @samp{-mips64}, and
955 correspond to generic
956 @samp{MIPS V}, @samp{MIPS32}, @samp{MIPS32 Release 2}, @samp{MIPS64},
957 and @samp{MIPS64 Release 2}
958 ISA processors, respectively.
960 @item -march=@var{CPU}
961 Generate code for a particular @sc{mips} cpu.
963 @item -mtune=@var{cpu}
964 Schedule and tune for a particular @sc{mips} cpu.
968 Cause nops to be inserted if the read of the destination register
969 of an mfhi or mflo instruction occurs in the following two instructions.
973 Cause stabs-style debugging output to go into an ECOFF-style .mdebug
974 section instead of the standard ELF .stabs sections.
978 Control generation of @code{.pdr} sections.
982 The register sizes are normally inferred from the ISA and ABI, but these
983 flags force a certain group of registers to be treated as 32 bits wide at
984 all times. @samp{-mgp32} controls the size of general-purpose registers
985 and @samp{-mfp32} controls the size of floating-point registers.
989 Generate code for the MIPS 16 processor. This is equivalent to putting
990 @code{.set mips16} at the start of the assembly file. @samp{-no-mips16}
991 turns off this option.
995 Generate code for the MIPS-3D Application Specific Extension.
996 This tells the assembler to accept MIPS-3D instructions.
997 @samp{-no-mips3d} turns off this option.
1001 Generate code for the MDMX Application Specific Extension.
1002 This tells the assembler to accept MDMX instructions.
1003 @samp{-no-mdmx} turns off this option.
1007 Generate code for the DSP Application Specific Extension.
1008 This tells the assembler to accept DSP instructions.
1009 @samp{-mno-dsp} turns off this option.
1013 Generate code for the MT Application Specific Extension.
1014 This tells the assembler to accept MT instructions.
1015 @samp{-mno-mt} turns off this option.
1017 @item --construct-floats
1018 @itemx --no-construct-floats
1019 The @samp{--no-construct-floats} option disables the construction of
1020 double width floating point constants by loading the two halves of the
1021 value into the two single width floating point registers that make up
1022 the double width register. By default @samp{--construct-floats} is
1023 selected, allowing construction of these floating point constants.
1026 @item --emulation=@var{name}
1027 This option causes @command{@value{AS}} to emulate @command{@value{AS}} configured
1028 for some other target, in all respects, including output format (choosing
1029 between ELF and ECOFF only), handling of pseudo-opcodes which may generate
1030 debugging information or store symbol table information, and default
1031 endianness. The available configuration names are: @samp{mipsecoff},
1032 @samp{mipself}, @samp{mipslecoff}, @samp{mipsbecoff}, @samp{mipslelf},
1033 @samp{mipsbelf}. The first two do not alter the default endianness from that
1034 of the primary target for which the assembler was configured; the others change
1035 the default to little- or big-endian as indicated by the @samp{b} or @samp{l}
1036 in the name. Using @samp{-EB} or @samp{-EL} will override the endianness
1037 selection in any case.
1039 This option is currently supported only when the primary target
1040 @command{@value{AS}} is configured for is a @sc{mips} ELF or ECOFF target.
1041 Furthermore, the primary target or others specified with
1042 @samp{--enable-targets=@dots{}} at configuration time must include support for
1043 the other format, if both are to be available. For example, the Irix 5
1044 configuration includes support for both.
1046 Eventually, this option will support more configurations, with more
1047 fine-grained control over the assembler's behavior, and will be supported for
1051 @command{@value{AS}} ignores this option. It is accepted for compatibility with
1058 Control how to deal with multiplication overflow and division by zero.
1059 @samp{--trap} or @samp{--no-break} (which are synonyms) take a trap exception
1060 (and only work for Instruction Set Architecture level 2 and higher);
1061 @samp{--break} or @samp{--no-trap} (also synonyms, and the default) take a
1065 When this option is used, @command{@value{AS}} will issue a warning every
1066 time it generates a nop instruction from a macro.
1071 The following options are available when @value{AS} is configured for
1077 Enable or disable the JSRI to BSR transformation. By default this is enabled.
1078 The command line option @samp{-nojsri2bsr} can be used to disable it.
1082 Enable or disable the silicon filter behaviour. By default this is disabled.
1083 The default can be overridden by the @samp{-sifilter} command line option.
1086 Alter jump instructions for long displacements.
1088 @item -mcpu=[210|340]
1089 Select the cpu type on the target hardware. This controls which instructions
1093 Assemble for a big endian target.
1096 Assemble for a little endian target.
1102 See the info pages for documentation of the MMIX-specific options.
1106 The following options are available when @value{AS} is configured for
1107 an Xtensa processor.
1110 @item --text-section-literals | --no-text-section-literals
1111 With @option{--text-@-section-@-literals}, literal pools are interspersed
1112 in the text section. The default is
1113 @option{--no-@-text-@-section-@-literals}, which places literals in a
1114 separate section in the output file. These options only affect literals
1115 referenced via PC-relative @code{L32R} instructions; literals for
1116 absolute mode @code{L32R} instructions are handled separately.
1118 @item --absolute-literals | --no-absolute-literals
1119 Indicate to the assembler whether @code{L32R} instructions use absolute
1120 or PC-relative addressing. The default is to assume absolute addressing
1121 if the Xtensa processor includes the absolute @code{L32R} addressing
1122 option. Otherwise, only the PC-relative @code{L32R} mode can be used.
1124 @item --target-align | --no-target-align
1125 Enable or disable automatic alignment to reduce branch penalties at the
1126 expense of some code density. The default is @option{--target-@-align}.
1128 @item --longcalls | --no-longcalls
1129 Enable or disable transformation of call instructions to allow calls
1130 across a greater range of addresses. The default is
1131 @option{--no-@-longcalls}.
1133 @item --transform | --no-transform
1134 Enable or disable all assembler transformations of Xtensa instructions.
1135 The default is @option{--transform};
1136 @option{--no-transform} should be used only in the rare cases when the
1137 instructions must be exactly as specified in the assembly source.
1144 * Manual:: Structure of this Manual
1145 * GNU Assembler:: The GNU Assembler
1146 * Object Formats:: Object File Formats
1147 * Command Line:: Command Line
1148 * Input Files:: Input Files
1149 * Object:: Output (Object) File
1150 * Errors:: Error and Warning Messages
1154 @section Structure of this Manual
1156 @cindex manual, structure and purpose
1157 This manual is intended to describe what you need to know to use
1158 @sc{gnu} @command{@value{AS}}. We cover the syntax expected in source files, including
1159 notation for symbols, constants, and expressions; the directives that
1160 @command{@value{AS}} understands; and of course how to invoke @command{@value{AS}}.
1163 We also cover special features in the @value{TARGET}
1164 configuration of @command{@value{AS}}, including assembler directives.
1167 This manual also describes some of the machine-dependent features of
1168 various flavors of the assembler.
1171 @cindex machine instructions (not covered)
1172 On the other hand, this manual is @emph{not} intended as an introduction
1173 to programming in assembly language---let alone programming in general!
1174 In a similar vein, we make no attempt to introduce the machine
1175 architecture; we do @emph{not} describe the instruction set, standard
1176 mnemonics, registers or addressing modes that are standard to a
1177 particular architecture.
1179 You may want to consult the manufacturer's
1180 machine architecture manual for this information.
1184 For information on the H8/300 machine instruction set, see @cite{H8/300
1185 Series Programming Manual}. For the H8/300H, see @cite{H8/300H Series
1186 Programming Manual} (Renesas).
1189 For information on the Renesas (formerly Hitachi) / SuperH SH machine instruction set,
1190 see @cite{SH-Microcomputer User's Manual} (Renesas) or
1191 @cite{SH-4 32-bit CPU Core Architecture} (SuperH) and
1192 @cite{SuperH (SH) 64-Bit RISC Series} (SuperH).
1195 For information on the Z8000 machine instruction set, see @cite{Z8000 CPU Technical Manual}
1199 @c I think this is premature---doc@cygnus.com, 17jan1991
1201 Throughout this manual, we assume that you are running @dfn{GNU},
1202 the portable operating system from the @dfn{Free Software
1203 Foundation, Inc.}. This restricts our attention to certain kinds of
1204 computer (in particular, the kinds of computers that @sc{gnu} can run on);
1205 once this assumption is granted examples and definitions need less
1208 @command{@value{AS}} is part of a team of programs that turn a high-level
1209 human-readable series of instructions into a low-level
1210 computer-readable series of instructions. Different versions of
1211 @command{@value{AS}} are used for different kinds of computer.
1214 @c There used to be a section "Terminology" here, which defined
1215 @c "contents", "byte", "word", and "long". Defining "word" to any
1216 @c particular size is confusing when the .word directive may generate 16
1217 @c bits on one machine and 32 bits on another; in general, for the user
1218 @c version of this manual, none of these terms seem essential to define.
1219 @c They were used very little even in the former draft of the manual;
1220 @c this draft makes an effort to avoid them (except in names of
1224 @section The GNU Assembler
1226 @c man begin DESCRIPTION
1228 @sc{gnu} @command{as} is really a family of assemblers.
1230 This manual describes @command{@value{AS}}, a member of that family which is
1231 configured for the @value{TARGET} architectures.
1233 If you use (or have used) the @sc{gnu} assembler on one architecture, you
1234 should find a fairly similar environment when you use it on another
1235 architecture. Each version has much in common with the others,
1236 including object file formats, most assembler directives (often called
1237 @dfn{pseudo-ops}) and assembler syntax.@refill
1239 @cindex purpose of @sc{gnu} assembler
1240 @command{@value{AS}} is primarily intended to assemble the output of the
1241 @sc{gnu} C compiler @code{@value{GCC}} for use by the linker
1242 @code{@value{LD}}. Nevertheless, we've tried to make @command{@value{AS}}
1243 assemble correctly everything that other assemblers for the same
1244 machine would assemble.
1246 Any exceptions are documented explicitly (@pxref{Machine Dependencies}).
1249 @c This remark should appear in generic version of manual; assumption
1250 @c here is that generic version sets M680x0.
1251 This doesn't mean @command{@value{AS}} always uses the same syntax as another
1252 assembler for the same architecture; for example, we know of several
1253 incompatible versions of 680x0 assembly language syntax.
1258 Unlike older assemblers, @command{@value{AS}} is designed to assemble a source
1259 program in one pass of the source file. This has a subtle impact on the
1260 @kbd{.org} directive (@pxref{Org,,@code{.org}}).
1262 @node Object Formats
1263 @section Object File Formats
1265 @cindex object file format
1266 The @sc{gnu} assembler can be configured to produce several alternative
1267 object file formats. For the most part, this does not affect how you
1268 write assembly language programs; but directives for debugging symbols
1269 are typically different in different file formats. @xref{Symbol
1270 Attributes,,Symbol Attributes}.
1273 For the @value{TARGET} target, @command{@value{AS}} is configured to produce
1274 @value{OBJ-NAME} format object files.
1276 @c The following should exhaust all configs that set MULTI-OBJ, ideally
1278 On the @value{TARGET}, @command{@value{AS}} can be configured to produce either
1279 @code{b.out} or COFF format object files.
1282 On the @value{TARGET}, @command{@value{AS}} can be configured to produce either
1283 SOM or ELF format object files.
1288 @section Command Line
1290 @cindex command line conventions
1292 After the program name @command{@value{AS}}, the command line may contain
1293 options and file names. Options may appear in any order, and may be
1294 before, after, or between file names. The order of file names is
1297 @cindex standard input, as input file
1299 @file{--} (two hyphens) by itself names the standard input file
1300 explicitly, as one of the files for @command{@value{AS}} to assemble.
1302 @cindex options, command line
1303 Except for @samp{--} any command line argument that begins with a
1304 hyphen (@samp{-}) is an option. Each option changes the behavior of
1305 @command{@value{AS}}. No option changes the way another option works. An
1306 option is a @samp{-} followed by one or more letters; the case of
1307 the letter is important. All options are optional.
1309 Some options expect exactly one file name to follow them. The file
1310 name may either immediately follow the option's letter (compatible
1311 with older assemblers) or it may be the next command argument (@sc{gnu}
1312 standard). These two command lines are equivalent:
1315 @value{AS} -o my-object-file.o mumble.s
1316 @value{AS} -omy-object-file.o mumble.s
1320 @section Input Files
1323 @cindex source program
1324 @cindex files, input
1325 We use the phrase @dfn{source program}, abbreviated @dfn{source}, to
1326 describe the program input to one run of @command{@value{AS}}. The program may
1327 be in one or more files; how the source is partitioned into files
1328 doesn't change the meaning of the source.
1330 @c I added "con" prefix to "catenation" just to prove I can overcome my
1331 @c APL training... doc@cygnus.com
1332 The source program is a concatenation of the text in all the files, in the
1335 @c man begin DESCRIPTION
1336 Each time you run @command{@value{AS}} it assembles exactly one source
1337 program. The source program is made up of one or more files.
1338 (The standard input is also a file.)
1340 You give @command{@value{AS}} a command line that has zero or more input file
1341 names. The input files are read (from left file name to right). A
1342 command line argument (in any position) that has no special meaning
1343 is taken to be an input file name.
1345 If you give @command{@value{AS}} no file names it attempts to read one input file
1346 from the @command{@value{AS}} standard input, which is normally your terminal. You
1347 may have to type @key{ctl-D} to tell @command{@value{AS}} there is no more program
1350 Use @samp{--} if you need to explicitly name the standard input file
1351 in your command line.
1353 If the source is empty, @command{@value{AS}} produces a small, empty object
1358 @subheading Filenames and Line-numbers
1360 @cindex input file linenumbers
1361 @cindex line numbers, in input files
1362 There are two ways of locating a line in the input file (or files) and
1363 either may be used in reporting error messages. One way refers to a line
1364 number in a physical file; the other refers to a line number in a
1365 ``logical'' file. @xref{Errors, ,Error and Warning Messages}.
1367 @dfn{Physical files} are those files named in the command line given
1368 to @command{@value{AS}}.
1370 @dfn{Logical files} are simply names declared explicitly by assembler
1371 directives; they bear no relation to physical files. Logical file names help
1372 error messages reflect the original source file, when @command{@value{AS}} source
1373 is itself synthesized from other files. @command{@value{AS}} understands the
1374 @samp{#} directives emitted by the @code{@value{GCC}} preprocessor. See also
1375 @ref{File,,@code{.file}}.
1378 @section Output (Object) File
1384 Every time you run @command{@value{AS}} it produces an output file, which is
1385 your assembly language program translated into numbers. This file
1386 is the object file. Its default name is
1394 @code{b.out} when @command{@value{AS}} is configured for the Intel 80960.
1396 You can give it another name by using the @option{-o} option. Conventionally,
1397 object file names end with @file{.o}. The default name is used for historical
1398 reasons: older assemblers were capable of assembling self-contained programs
1399 directly into a runnable program. (For some formats, this isn't currently
1400 possible, but it can be done for the @code{a.out} format.)
1404 The object file is meant for input to the linker @code{@value{LD}}. It contains
1405 assembled program code, information to help @code{@value{LD}} integrate
1406 the assembled program into a runnable file, and (optionally) symbolic
1407 information for the debugger.
1409 @c link above to some info file(s) like the description of a.out.
1410 @c don't forget to describe @sc{gnu} info as well as Unix lossage.
1413 @section Error and Warning Messages
1415 @c man begin DESCRIPTION
1417 @cindex error messages
1418 @cindex warning messages
1419 @cindex messages from assembler
1420 @command{@value{AS}} may write warnings and error messages to the standard error
1421 file (usually your terminal). This should not happen when a compiler
1422 runs @command{@value{AS}} automatically. Warnings report an assumption made so
1423 that @command{@value{AS}} could keep assembling a flawed program; errors report a
1424 grave problem that stops the assembly.
1428 @cindex format of warning messages
1429 Warning messages have the format
1432 file_name:@b{NNN}:Warning Message Text
1436 @cindex line numbers, in warnings/errors
1437 (where @b{NNN} is a line number). If a logical file name has been given
1438 (@pxref{File,,@code{.file}}) it is used for the filename, otherwise the name of
1439 the current input file is used. If a logical line number was given
1441 (@pxref{Line,,@code{.line}})
1443 then it is used to calculate the number printed,
1444 otherwise the actual line in the current source file is printed. The
1445 message text is intended to be self explanatory (in the grand Unix
1448 @cindex format of error messages
1449 Error messages have the format
1451 file_name:@b{NNN}:FATAL:Error Message Text
1453 The file name and line number are derived as for warning
1454 messages. The actual message text may be rather less explanatory
1455 because many of them aren't supposed to happen.
1458 @chapter Command-Line Options
1460 @cindex options, all versions of assembler
1461 This chapter describes command-line options available in @emph{all}
1462 versions of the @sc{gnu} assembler; @pxref{Machine Dependencies}, for options specific
1464 to the @value{TARGET} target.
1467 to particular machine architectures.
1470 @c man begin DESCRIPTION
1472 If you are invoking @command{@value{AS}} via the @sc{gnu} C compiler,
1473 you can use the @samp{-Wa} option to pass arguments through to the assembler.
1474 The assembler arguments must be separated from each other (and the @samp{-Wa})
1475 by commas. For example:
1478 gcc -c -g -O -Wa,-alh,-L file.c
1482 This passes two options to the assembler: @samp{-alh} (emit a listing to
1483 standard output with high-level and assembly source) and @samp{-L} (retain
1484 local symbols in the symbol table).
1486 Usually you do not need to use this @samp{-Wa} mechanism, since many compiler
1487 command-line options are automatically passed to the assembler by the compiler.
1488 (You can call the @sc{gnu} compiler driver with the @samp{-v} option to see
1489 precisely what options it passes to each compilation pass, including the
1495 * a:: -a[cdhlns] enable listings
1496 * alternate:: --alternate enable alternate macro syntax
1497 * D:: -D for compatibility
1498 * f:: -f to work faster
1499 * I:: -I for .include search path
1500 @ifclear DIFF-TBL-KLUGE
1501 * K:: -K for compatibility
1503 @ifset DIFF-TBL-KLUGE
1504 * K:: -K for difference tables
1507 * L:: -L to retain local labels
1508 * listing:: --listing-XXX to configure listing output
1509 * M:: -M or --mri to assemble in MRI compatibility mode
1510 * MD:: --MD for dependency tracking
1511 * o:: -o to name the object file
1512 * R:: -R to join data and text sections
1513 * statistics:: --statistics to see statistics about assembly
1514 * traditional-format:: --traditional-format for compatible output
1515 * v:: -v to announce version
1516 * W:: -W, --no-warn, --warn, --fatal-warnings to control warnings
1517 * Z:: -Z to make object file even after errors
1521 @section Enable Listings: @option{-a[cdhlns]}
1530 @cindex listings, enabling
1531 @cindex assembly listings, enabling
1533 These options enable listing output from the assembler. By itself,
1534 @samp{-a} requests high-level, assembly, and symbols listing.
1535 You can use other letters to select specific options for the list:
1536 @samp{-ah} requests a high-level language listing,
1537 @samp{-al} requests an output-program assembly listing, and
1538 @samp{-as} requests a symbol table listing.
1539 High-level listings require that a compiler debugging option like
1540 @samp{-g} be used, and that assembly listings (@samp{-al}) be requested
1543 Use the @samp{-ac} option to omit false conditionals from a listing. Any lines
1544 which are not assembled because of a false @code{.if} (or @code{.ifdef}, or any
1545 other conditional), or a true @code{.if} followed by an @code{.else}, will be
1546 omitted from the listing.
1548 Use the @samp{-ad} option to omit debugging directives from the
1551 Once you have specified one of these options, you can further control
1552 listing output and its appearance using the directives @code{.list},
1553 @code{.nolist}, @code{.psize}, @code{.eject}, @code{.title}, and
1555 The @samp{-an} option turns off all forms processing.
1556 If you do not request listing output with one of the @samp{-a} options, the
1557 listing-control directives have no effect.
1559 The letters after @samp{-a} may be combined into one option,
1560 @emph{e.g.}, @samp{-aln}.
1562 Note if the assembler source is coming from the standard input (eg because it
1563 is being created by @code{@value{GCC}} and the @samp{-pipe} command line switch
1564 is being used) then the listing will not contain any comments or preprocessor
1565 directives. This is because the listing code buffers input source lines from
1566 stdin only after they have been preprocessed by the assembler. This reduces
1567 memory usage and makes the code more efficient.
1570 @section @option{--alternate}
1573 Begin in alternate macro mode, see @ref{Altmacro,,@code{.altmacro}}.
1576 @section @option{-D}
1579 This option has no effect whatsoever, but it is accepted to make it more
1580 likely that scripts written for other assemblers also work with
1581 @command{@value{AS}}.
1584 @section Work Faster: @option{-f}
1587 @cindex trusted compiler
1588 @cindex faster processing (@option{-f})
1589 @samp{-f} should only be used when assembling programs written by a
1590 (trusted) compiler. @samp{-f} stops the assembler from doing whitespace
1591 and comment preprocessing on
1592 the input file(s) before assembling them. @xref{Preprocessing,
1596 @emph{Warning:} if you use @samp{-f} when the files actually need to be
1597 preprocessed (if they contain comments, for example), @command{@value{AS}} does
1602 @section @code{.include} Search Path: @option{-I} @var{path}
1604 @kindex -I @var{path}
1605 @cindex paths for @code{.include}
1606 @cindex search path for @code{.include}
1607 @cindex @code{include} directive search path
1608 Use this option to add a @var{path} to the list of directories
1609 @command{@value{AS}} searches for files specified in @code{.include}
1610 directives (@pxref{Include,,@code{.include}}). You may use @option{-I} as
1611 many times as necessary to include a variety of paths. The current
1612 working directory is always searched first; after that, @command{@value{AS}}
1613 searches any @samp{-I} directories in the same order as they were
1614 specified (left to right) on the command line.
1617 @section Difference Tables: @option{-K}
1620 @ifclear DIFF-TBL-KLUGE
1621 On the @value{TARGET} family, this option is allowed, but has no effect. It is
1622 permitted for compatibility with the @sc{gnu} assembler on other platforms,
1623 where it can be used to warn when the assembler alters the machine code
1624 generated for @samp{.word} directives in difference tables. The @value{TARGET}
1625 family does not have the addressing limitations that sometimes lead to this
1626 alteration on other platforms.
1629 @ifset DIFF-TBL-KLUGE
1630 @cindex difference tables, warning
1631 @cindex warning for altered difference tables
1632 @command{@value{AS}} sometimes alters the code emitted for directives of the form
1633 @samp{.word @var{sym1}-@var{sym2}}; @pxref{Word,,@code{.word}}.
1634 You can use the @samp{-K} option if you want a warning issued when this
1639 @section Include Local Labels: @option{-L}
1642 @cindex local labels, retaining in output
1643 Labels beginning with @samp{L} (upper case only) are called @dfn{local
1644 labels}. @xref{Symbol Names}. Normally you do not see such labels when
1645 debugging, because they are intended for the use of programs (like
1646 compilers) that compose assembler programs, not for your notice.
1647 Normally both @command{@value{AS}} and @code{@value{LD}} discard such labels, so you do not
1648 normally debug with them.
1650 This option tells @command{@value{AS}} to retain those @samp{L@dots{}} symbols
1651 in the object file. Usually if you do this you also tell the linker
1652 @code{@value{LD}} to preserve symbols whose names begin with @samp{L}.
1654 By default, a local label is any label beginning with @samp{L}, but each
1655 target is allowed to redefine the local label prefix.
1657 On the HPPA local labels begin with @samp{L$}.
1661 @section Configuring listing output: @option{--listing}
1663 The listing feature of the assembler can be enabled via the command line switch
1664 @samp{-a} (@pxref{a}). This feature combines the input source file(s) with a
1665 hex dump of the corresponding locations in the output object file, and displays
1666 them as a listing file. The format of this listing can be controlled by pseudo
1667 ops inside the assembler source (@pxref{List} @pxref{Title} @pxref{Sbttl}
1668 @pxref{Psize} @pxref{Eject}) and also by the following switches:
1671 @item --listing-lhs-width=@samp{number}
1672 @kindex --listing-lhs-width
1673 @cindex Width of first line disassembly output
1674 Sets the maximum width, in words, of the first line of the hex byte dump. This
1675 dump appears on the left hand side of the listing output.
1677 @item --listing-lhs-width2=@samp{number}
1678 @kindex --listing-lhs-width2
1679 @cindex Width of continuation lines of disassembly output
1680 Sets the maximum width, in words, of any further lines of the hex byte dump for
1681 a given input source line. If this value is not specified, it defaults to being
1682 the same as the value specified for @samp{--listing-lhs-width}. If neither
1683 switch is used the default is to one.
1685 @item --listing-rhs-width=@samp{number}
1686 @kindex --listing-rhs-width
1687 @cindex Width of source line output
1688 Sets the maximum width, in characters, of the source line that is displayed
1689 alongside the hex dump. The default value for this parameter is 100. The
1690 source line is displayed on the right hand side of the listing output.
1692 @item --listing-cont-lines=@samp{number}
1693 @kindex --listing-cont-lines
1694 @cindex Maximum number of continuation lines
1695 Sets the maximum number of continuation lines of hex dump that will be
1696 displayed for a given single line of source input. The default value is 4.
1700 @section Assemble in MRI Compatibility Mode: @option{-M}
1703 @cindex MRI compatibility mode
1704 The @option{-M} or @option{--mri} option selects MRI compatibility mode. This
1705 changes the syntax and pseudo-op handling of @command{@value{AS}} to make it
1706 compatible with the @code{ASM68K} or the @code{ASM960} (depending upon the
1707 configured target) assembler from Microtec Research. The exact nature of the
1708 MRI syntax will not be documented here; see the MRI manuals for more
1709 information. Note in particular that the handling of macros and macro
1710 arguments is somewhat different. The purpose of this option is to permit
1711 assembling existing MRI assembler code using @command{@value{AS}}.
1713 The MRI compatibility is not complete. Certain operations of the MRI assembler
1714 depend upon its object file format, and can not be supported using other object
1715 file formats. Supporting these would require enhancing each object file format
1716 individually. These are:
1719 @item global symbols in common section
1721 The m68k MRI assembler supports common sections which are merged by the linker.
1722 Other object file formats do not support this. @command{@value{AS}} handles
1723 common sections by treating them as a single common symbol. It permits local
1724 symbols to be defined within a common section, but it can not support global
1725 symbols, since it has no way to describe them.
1727 @item complex relocations
1729 The MRI assemblers support relocations against a negated section address, and
1730 relocations which combine the start addresses of two or more sections. These
1731 are not support by other object file formats.
1733 @item @code{END} pseudo-op specifying start address
1735 The MRI @code{END} pseudo-op permits the specification of a start address.
1736 This is not supported by other object file formats. The start address may
1737 instead be specified using the @option{-e} option to the linker, or in a linker
1740 @item @code{IDNT}, @code{.ident} and @code{NAME} pseudo-ops
1742 The MRI @code{IDNT}, @code{.ident} and @code{NAME} pseudo-ops assign a module
1743 name to the output file. This is not supported by other object file formats.
1745 @item @code{ORG} pseudo-op
1747 The m68k MRI @code{ORG} pseudo-op begins an absolute section at a given
1748 address. This differs from the usual @command{@value{AS}} @code{.org} pseudo-op,
1749 which changes the location within the current section. Absolute sections are
1750 not supported by other object file formats. The address of a section may be
1751 assigned within a linker script.
1754 There are some other features of the MRI assembler which are not supported by
1755 @command{@value{AS}}, typically either because they are difficult or because they
1756 seem of little consequence. Some of these may be supported in future releases.
1760 @item EBCDIC strings
1762 EBCDIC strings are not supported.
1764 @item packed binary coded decimal
1766 Packed binary coded decimal is not supported. This means that the @code{DC.P}
1767 and @code{DCB.P} pseudo-ops are not supported.
1769 @item @code{FEQU} pseudo-op
1771 The m68k @code{FEQU} pseudo-op is not supported.
1773 @item @code{NOOBJ} pseudo-op
1775 The m68k @code{NOOBJ} pseudo-op is not supported.
1777 @item @code{OPT} branch control options
1779 The m68k @code{OPT} branch control options---@code{B}, @code{BRS}, @code{BRB},
1780 @code{BRL}, and @code{BRW}---are ignored. @command{@value{AS}} automatically
1781 relaxes all branches, whether forward or backward, to an appropriate size, so
1782 these options serve no purpose.
1784 @item @code{OPT} list control options
1786 The following m68k @code{OPT} list control options are ignored: @code{C},
1787 @code{CEX}, @code{CL}, @code{CRE}, @code{E}, @code{G}, @code{I}, @code{M},
1788 @code{MEX}, @code{MC}, @code{MD}, @code{X}.
1790 @item other @code{OPT} options
1792 The following m68k @code{OPT} options are ignored: @code{NEST}, @code{O},
1793 @code{OLD}, @code{OP}, @code{P}, @code{PCO}, @code{PCR}, @code{PCS}, @code{R}.
1795 @item @code{OPT} @code{D} option is default
1797 The m68k @code{OPT} @code{D} option is the default, unlike the MRI assembler.
1798 @code{OPT NOD} may be used to turn it off.
1800 @item @code{XREF} pseudo-op.
1802 The m68k @code{XREF} pseudo-op is ignored.
1804 @item @code{.debug} pseudo-op
1806 The i960 @code{.debug} pseudo-op is not supported.
1808 @item @code{.extended} pseudo-op
1810 The i960 @code{.extended} pseudo-op is not supported.
1812 @item @code{.list} pseudo-op.
1814 The various options of the i960 @code{.list} pseudo-op are not supported.
1816 @item @code{.optimize} pseudo-op
1818 The i960 @code{.optimize} pseudo-op is not supported.
1820 @item @code{.output} pseudo-op
1822 The i960 @code{.output} pseudo-op is not supported.
1824 @item @code{.setreal} pseudo-op
1826 The i960 @code{.setreal} pseudo-op is not supported.
1831 @section Dependency Tracking: @option{--MD}
1834 @cindex dependency tracking
1837 @command{@value{AS}} can generate a dependency file for the file it creates. This
1838 file consists of a single rule suitable for @code{make} describing the
1839 dependencies of the main source file.
1841 The rule is written to the file named in its argument.
1843 This feature is used in the automatic updating of makefiles.
1846 @section Name the Object File: @option{-o}
1849 @cindex naming object file
1850 @cindex object file name
1851 There is always one object file output when you run @command{@value{AS}}. By
1852 default it has the name
1855 @file{a.out} (or @file{b.out}, for Intel 960 targets only).
1869 You use this option (which takes exactly one filename) to give the
1870 object file a different name.
1872 Whatever the object file is called, @command{@value{AS}} overwrites any
1873 existing file of the same name.
1876 @section Join Data and Text Sections: @option{-R}
1879 @cindex data and text sections, joining
1880 @cindex text and data sections, joining
1881 @cindex joining text and data sections
1882 @cindex merging text and data sections
1883 @option{-R} tells @command{@value{AS}} to write the object file as if all
1884 data-section data lives in the text section. This is only done at
1885 the very last moment: your binary data are the same, but data
1886 section parts are relocated differently. The data section part of
1887 your object file is zero bytes long because all its bytes are
1888 appended to the text section. (@xref{Sections,,Sections and Relocation}.)
1890 When you specify @option{-R} it would be possible to generate shorter
1891 address displacements (because we do not have to cross between text and
1892 data section). We refrain from doing this simply for compatibility with
1893 older versions of @command{@value{AS}}. In future, @option{-R} may work this way.
1896 When @command{@value{AS}} is configured for COFF or ELF output,
1897 this option is only useful if you use sections named @samp{.text} and
1902 @option{-R} is not supported for any of the HPPA targets. Using
1903 @option{-R} generates a warning from @command{@value{AS}}.
1907 @section Display Assembly Statistics: @option{--statistics}
1909 @kindex --statistics
1910 @cindex statistics, about assembly
1911 @cindex time, total for assembly
1912 @cindex space used, maximum for assembly
1913 Use @samp{--statistics} to display two statistics about the resources used by
1914 @command{@value{AS}}: the maximum amount of space allocated during the assembly
1915 (in bytes), and the total execution time taken for the assembly (in @sc{cpu}
1918 @node traditional-format
1919 @section Compatible Output: @option{--traditional-format}
1921 @kindex --traditional-format
1922 For some targets, the output of @command{@value{AS}} is different in some ways
1923 from the output of some existing assembler. This switch requests
1924 @command{@value{AS}} to use the traditional format instead.
1926 For example, it disables the exception frame optimizations which
1927 @command{@value{AS}} normally does by default on @code{@value{GCC}} output.
1930 @section Announce Version: @option{-v}
1934 @cindex assembler version
1935 @cindex version of assembler
1936 You can find out what version of as is running by including the
1937 option @samp{-v} (which you can also spell as @samp{-version}) on the
1941 @section Control Warnings: @option{-W}, @option{--warn}, @option{--no-warn}, @option{--fatal-warnings}
1943 @command{@value{AS}} should never give a warning or error message when
1944 assembling compiler output. But programs written by people often
1945 cause @command{@value{AS}} to give a warning that a particular assumption was
1946 made. All such warnings are directed to the standard error file.
1950 @cindex suppressing warnings
1951 @cindex warnings, suppressing
1952 If you use the @option{-W} and @option{--no-warn} options, no warnings are issued.
1953 This only affects the warning messages: it does not change any particular of
1954 how @command{@value{AS}} assembles your file. Errors, which stop the assembly,
1957 @kindex --fatal-warnings
1958 @cindex errors, caused by warnings
1959 @cindex warnings, causing error
1960 If you use the @option{--fatal-warnings} option, @command{@value{AS}} considers
1961 files that generate warnings to be in error.
1964 @cindex warnings, switching on
1965 You can switch these options off again by specifying @option{--warn}, which
1966 causes warnings to be output as usual.
1969 @section Generate Object File in Spite of Errors: @option{-Z}
1970 @cindex object file, after errors
1971 @cindex errors, continuing after
1972 After an error message, @command{@value{AS}} normally produces no output. If for
1973 some reason you are interested in object file output even after
1974 @command{@value{AS}} gives an error message on your program, use the @samp{-Z}
1975 option. If there are any errors, @command{@value{AS}} continues anyways, and
1976 writes an object file after a final warning message of the form @samp{@var{n}
1977 errors, @var{m} warnings, generating bad object file.}
1982 @cindex machine-independent syntax
1983 @cindex syntax, machine-independent
1984 This chapter describes the machine-independent syntax allowed in a
1985 source file. @command{@value{AS}} syntax is similar to what many other
1986 assemblers use; it is inspired by the BSD 4.2
1991 assembler, except that @command{@value{AS}} does not assemble Vax bit-fields.
1995 * Preprocessing:: Preprocessing
1996 * Whitespace:: Whitespace
1997 * Comments:: Comments
1998 * Symbol Intro:: Symbols
1999 * Statements:: Statements
2000 * Constants:: Constants
2004 @section Preprocessing
2006 @cindex preprocessing
2007 The @command{@value{AS}} internal preprocessor:
2009 @cindex whitespace, removed by preprocessor
2011 adjusts and removes extra whitespace. It leaves one space or tab before
2012 the keywords on a line, and turns any other whitespace on the line into
2015 @cindex comments, removed by preprocessor
2017 removes all comments, replacing them with a single space, or an
2018 appropriate number of newlines.
2020 @cindex constants, converted by preprocessor
2022 converts character constants into the appropriate numeric values.
2025 It does not do macro processing, include file handling, or
2026 anything else you may get from your C compiler's preprocessor. You can
2027 do include file processing with the @code{.include} directive
2028 (@pxref{Include,,@code{.include}}). You can use the @sc{gnu} C compiler driver
2029 to get other ``CPP'' style preprocessing by giving the input file a
2030 @samp{.S} suffix. @xref{Overall Options,, Options Controlling the Kind of
2031 Output, gcc.info, Using GNU CC}.
2033 Excess whitespace, comments, and character constants
2034 cannot be used in the portions of the input text that are not
2037 @cindex turning preprocessing on and off
2038 @cindex preprocessing, turning on and off
2041 If the first line of an input file is @code{#NO_APP} or if you use the
2042 @samp{-f} option, whitespace and comments are not removed from the input file.
2043 Within an input file, you can ask for whitespace and comment removal in
2044 specific portions of the by putting a line that says @code{#APP} before the
2045 text that may contain whitespace or comments, and putting a line that says
2046 @code{#NO_APP} after this text. This feature is mainly intend to support
2047 @code{asm} statements in compilers whose output is otherwise free of comments
2054 @dfn{Whitespace} is one or more blanks or tabs, in any order.
2055 Whitespace is used to separate symbols, and to make programs neater for
2056 people to read. Unless within character constants
2057 (@pxref{Characters,,Character Constants}), any whitespace means the same
2058 as exactly one space.
2064 There are two ways of rendering comments to @command{@value{AS}}. In both
2065 cases the comment is equivalent to one space.
2067 Anything from @samp{/*} through the next @samp{*/} is a comment.
2068 This means you may not nest these comments.
2072 The only way to include a newline ('\n') in a comment
2073 is to use this sort of comment.
2076 /* This sort of comment does not nest. */
2079 @cindex line comment character
2080 Anything from the @dfn{line comment} character to the next newline
2081 is considered a comment and is ignored. The line comment character is
2083 @samp{;} on the ARC;
2086 @samp{@@} on the ARM;
2089 @samp{;} for the H8/300 family;
2092 @samp{;} for the HPPA;
2095 @samp{#} on the i386 and x86-64;
2098 @samp{#} on the i960;
2101 @samp{;} for the PDP-11;
2104 @samp{;} for picoJava;
2107 @samp{#} for Motorola PowerPC;
2110 @samp{!} for the Renesas / SuperH SH;
2113 @samp{!} on the SPARC;
2116 @samp{#} on the ip2k;
2119 @samp{#} on the m32c;
2122 @samp{#} on the m32r;
2125 @samp{|} on the 680x0;
2128 @samp{#} on the 68HC11 and 68HC12;
2131 @samp{#} on the Vax;
2134 @samp{!} for the Z8000;
2137 @samp{#} on the V850;
2140 @samp{#} for Xtensa systems;
2142 see @ref{Machine Dependencies}. @refill
2143 @c FIXME What about i860?
2146 On some machines there are two different line comment characters. One
2147 character only begins a comment if it is the first non-whitespace character on
2148 a line, while the other always begins a comment.
2152 The V850 assembler also supports a double dash as starting a comment that
2153 extends to the end of the line.
2159 @cindex lines starting with @code{#}
2160 @cindex logical line numbers
2161 To be compatible with past assemblers, lines that begin with @samp{#} have a
2162 special interpretation. Following the @samp{#} should be an absolute
2163 expression (@pxref{Expressions}): the logical line number of the @emph{next}
2164 line. Then a string (@pxref{Strings,, Strings}) is allowed: if present it is a
2165 new logical file name. The rest of the line, if any, should be whitespace.
2167 If the first non-whitespace characters on the line are not numeric,
2168 the line is ignored. (Just like a comment.)
2171 # This is an ordinary comment.
2172 # 42-6 "new_file_name" # New logical file name
2173 # This is logical line # 36.
2175 This feature is deprecated, and may disappear from future versions
2176 of @command{@value{AS}}.
2181 @cindex characters used in symbols
2182 @ifclear SPECIAL-SYMS
2183 A @dfn{symbol} is one or more characters chosen from the set of all
2184 letters (both upper and lower case), digits and the three characters
2190 A @dfn{symbol} is one or more characters chosen from the set of all
2191 letters (both upper and lower case), digits and the three characters
2192 @samp{._$}. (Save that, on the H8/300 only, you may not use @samp{$} in
2198 On most machines, you can also use @code{$} in symbol names; exceptions
2199 are noted in @ref{Machine Dependencies}.
2201 No symbol may begin with a digit. Case is significant.
2202 There is no length limit: all characters are significant. Symbols are
2203 delimited by characters not in that set, or by the beginning of a file
2204 (since the source program must end with a newline, the end of a file is
2205 not a possible symbol delimiter). @xref{Symbols}.
2206 @cindex length of symbols
2211 @cindex statements, structure of
2212 @cindex line separator character
2213 @cindex statement separator character
2215 @ifclear abnormal-separator
2216 A @dfn{statement} ends at a newline character (@samp{\n}) or at a
2217 semicolon (@samp{;}). The newline or semicolon is considered part of
2218 the preceding statement. Newlines and semicolons within character
2219 constants are an exception: they do not end statements.
2221 @ifset abnormal-separator
2223 A @dfn{statement} ends at a newline character (@samp{\n}) or an exclamation
2224 point (@samp{!}). The newline or exclamation point is considered part of the
2225 preceding statement. Newlines and exclamation points within character
2226 constants are an exception: they do not end statements.
2229 A @dfn{statement} ends at a newline character (@samp{\n}); or (for the
2230 H8/300) a dollar sign (@samp{$}); or (for the Renesas-SH) a semicolon
2231 (@samp{;}). The newline or separator character is considered part of
2232 the preceding statement. Newlines and separators within character
2233 constants are an exception: they do not end statements.
2238 A @dfn{statement} ends at a newline character (@samp{\n}) or line
2239 separator character. (The line separator is usually @samp{;}, unless
2240 this conflicts with the comment character; @pxref{Machine Dependencies}.) The
2241 newline or separator character is considered part of the preceding
2242 statement. Newlines and separators within character constants are an
2243 exception: they do not end statements.
2246 @cindex newline, required at file end
2247 @cindex EOF, newline must precede
2248 It is an error to end any statement with end-of-file: the last
2249 character of any input file should be a newline.@refill
2251 An empty statement is allowed, and may include whitespace. It is ignored.
2253 @cindex instructions and directives
2254 @cindex directives and instructions
2255 @c "key symbol" is not used elsewhere in the document; seems pedantic to
2256 @c @defn{} it in that case, as was done previously... doc@cygnus.com,
2258 A statement begins with zero or more labels, optionally followed by a
2259 key symbol which determines what kind of statement it is. The key
2260 symbol determines the syntax of the rest of the statement. If the
2261 symbol begins with a dot @samp{.} then the statement is an assembler
2262 directive: typically valid for any computer. If the symbol begins with
2263 a letter the statement is an assembly language @dfn{instruction}: it
2264 assembles into a machine language instruction.
2266 Different versions of @command{@value{AS}} for different computers
2267 recognize different instructions. In fact, the same symbol may
2268 represent a different instruction in a different computer's assembly
2272 @cindex @code{:} (label)
2273 @cindex label (@code{:})
2274 A label is a symbol immediately followed by a colon (@code{:}).
2275 Whitespace before a label or after a colon is permitted, but you may not
2276 have whitespace between a label's symbol and its colon. @xref{Labels}.
2279 For HPPA targets, labels need not be immediately followed by a colon, but
2280 the definition of a label must begin in column zero. This also implies that
2281 only one label may be defined on each line.
2285 label: .directive followed by something
2286 another_label: # This is an empty statement.
2287 instruction operand_1, operand_2, @dots{}
2294 A constant is a number, written so that its value is known by
2295 inspection, without knowing any context. Like this:
2298 .byte 74, 0112, 092, 0x4A, 0X4a, 'J, '\J # All the same value.
2299 .ascii "Ring the bell\7" # A string constant.
2300 .octa 0x123456789abcdef0123456789ABCDEF0 # A bignum.
2301 .float 0f-314159265358979323846264338327\
2302 95028841971.693993751E-40 # - pi, a flonum.
2307 * Characters:: Character Constants
2308 * Numbers:: Number Constants
2312 @subsection Character Constants
2314 @cindex character constants
2315 @cindex constants, character
2316 There are two kinds of character constants. A @dfn{character} stands
2317 for one character in one byte and its value may be used in
2318 numeric expressions. String constants (properly called string
2319 @emph{literals}) are potentially many bytes and their values may not be
2320 used in arithmetic expressions.
2324 * Chars:: Characters
2328 @subsubsection Strings
2330 @cindex string constants
2331 @cindex constants, string
2332 A @dfn{string} is written between double-quotes. It may contain
2333 double-quotes or null characters. The way to get special characters
2334 into a string is to @dfn{escape} these characters: precede them with
2335 a backslash @samp{\} character. For example @samp{\\} represents
2336 one backslash: the first @code{\} is an escape which tells
2337 @command{@value{AS}} to interpret the second character literally as a backslash
2338 (which prevents @command{@value{AS}} from recognizing the second @code{\} as an
2339 escape character). The complete list of escapes follows.
2341 @cindex escape codes, character
2342 @cindex character escape codes
2345 @c Mnemonic for ACKnowledge; for ASCII this is octal code 007.
2347 @cindex @code{\b} (backspace character)
2348 @cindex backspace (@code{\b})
2350 Mnemonic for backspace; for ASCII this is octal code 010.
2353 @c Mnemonic for EOText; for ASCII this is octal code 004.
2355 @cindex @code{\f} (formfeed character)
2356 @cindex formfeed (@code{\f})
2358 Mnemonic for FormFeed; for ASCII this is octal code 014.
2360 @cindex @code{\n} (newline character)
2361 @cindex newline (@code{\n})
2363 Mnemonic for newline; for ASCII this is octal code 012.
2366 @c Mnemonic for prefix; for ASCII this is octal code 033, usually known as @code{escape}.
2368 @cindex @code{\r} (carriage return character)
2369 @cindex carriage return (@code{\r})
2371 Mnemonic for carriage-Return; for ASCII this is octal code 015.
2374 @c Mnemonic for space; for ASCII this is octal code 040. Included for compliance with
2375 @c other assemblers.
2377 @cindex @code{\t} (tab)
2378 @cindex tab (@code{\t})
2380 Mnemonic for horizontal Tab; for ASCII this is octal code 011.
2383 @c Mnemonic for Vertical tab; for ASCII this is octal code 013.
2384 @c @item \x @var{digit} @var{digit} @var{digit}
2385 @c A hexadecimal character code. The numeric code is 3 hexadecimal digits.
2387 @cindex @code{\@var{ddd}} (octal character code)
2388 @cindex octal character code (@code{\@var{ddd}})
2389 @item \ @var{digit} @var{digit} @var{digit}
2390 An octal character code. The numeric code is 3 octal digits.
2391 For compatibility with other Unix systems, 8 and 9 are accepted as digits:
2392 for example, @code{\008} has the value 010, and @code{\009} the value 011.
2394 @cindex @code{\@var{xd...}} (hex character code)
2395 @cindex hex character code (@code{\@var{xd...}})
2396 @item \@code{x} @var{hex-digits...}
2397 A hex character code. All trailing hex digits are combined. Either upper or
2398 lower case @code{x} works.
2400 @cindex @code{\\} (@samp{\} character)
2401 @cindex backslash (@code{\\})
2403 Represents one @samp{\} character.
2406 @c Represents one @samp{'} (accent acute) character.
2407 @c This is needed in single character literals
2408 @c (@xref{Characters,,Character Constants}.) to represent
2411 @cindex @code{\"} (doublequote character)
2412 @cindex doublequote (@code{\"})
2414 Represents one @samp{"} character. Needed in strings to represent
2415 this character, because an unescaped @samp{"} would end the string.
2417 @item \ @var{anything-else}
2418 Any other character when escaped by @kbd{\} gives a warning, but
2419 assembles as if the @samp{\} was not present. The idea is that if
2420 you used an escape sequence you clearly didn't want the literal
2421 interpretation of the following character. However @command{@value{AS}} has no
2422 other interpretation, so @command{@value{AS}} knows it is giving you the wrong
2423 code and warns you of the fact.
2426 Which characters are escapable, and what those escapes represent,
2427 varies widely among assemblers. The current set is what we think
2428 the BSD 4.2 assembler recognizes, and is a subset of what most C
2429 compilers recognize. If you are in doubt, do not use an escape
2433 @subsubsection Characters
2435 @cindex single character constant
2436 @cindex character, single
2437 @cindex constant, single character
2438 A single character may be written as a single quote immediately
2439 followed by that character. The same escapes apply to characters as
2440 to strings. So if you want to write the character backslash, you
2441 must write @kbd{'\\} where the first @code{\} escapes the second
2442 @code{\}. As you can see, the quote is an acute accent, not a
2443 grave accent. A newline
2445 @ifclear abnormal-separator
2446 (or semicolon @samp{;})
2448 @ifset abnormal-separator
2450 (or dollar sign @samp{$}, for the H8/300; or semicolon @samp{;} for the
2455 immediately following an acute accent is taken as a literal character
2456 and does not count as the end of a statement. The value of a character
2457 constant in a numeric expression is the machine's byte-wide code for
2458 that character. @command{@value{AS}} assumes your character code is ASCII:
2459 @kbd{'A} means 65, @kbd{'B} means 66, and so on. @refill
2462 @subsection Number Constants
2464 @cindex constants, number
2465 @cindex number constants
2466 @command{@value{AS}} distinguishes three kinds of numbers according to how they
2467 are stored in the target machine. @emph{Integers} are numbers that
2468 would fit into an @code{int} in the C language. @emph{Bignums} are
2469 integers, but they are stored in more than 32 bits. @emph{Flonums}
2470 are floating point numbers, described below.
2473 * Integers:: Integers
2478 * Bit Fields:: Bit Fields
2484 @subsubsection Integers
2486 @cindex constants, integer
2488 @cindex binary integers
2489 @cindex integers, binary
2490 A binary integer is @samp{0b} or @samp{0B} followed by zero or more of
2491 the binary digits @samp{01}.
2493 @cindex octal integers
2494 @cindex integers, octal
2495 An octal integer is @samp{0} followed by zero or more of the octal
2496 digits (@samp{01234567}).
2498 @cindex decimal integers
2499 @cindex integers, decimal
2500 A decimal integer starts with a non-zero digit followed by zero or
2501 more digits (@samp{0123456789}).
2503 @cindex hexadecimal integers
2504 @cindex integers, hexadecimal
2505 A hexadecimal integer is @samp{0x} or @samp{0X} followed by one or
2506 more hexadecimal digits chosen from @samp{0123456789abcdefABCDEF}.
2508 Integers have the usual values. To denote a negative integer, use
2509 the prefix operator @samp{-} discussed under expressions
2510 (@pxref{Prefix Ops,,Prefix Operators}).
2513 @subsubsection Bignums
2516 @cindex constants, bignum
2517 A @dfn{bignum} has the same syntax and semantics as an integer
2518 except that the number (or its negative) takes more than 32 bits to
2519 represent in binary. The distinction is made because in some places
2520 integers are permitted while bignums are not.
2523 @subsubsection Flonums
2525 @cindex floating point numbers
2526 @cindex constants, floating point
2528 @cindex precision, floating point
2529 A @dfn{flonum} represents a floating point number. The translation is
2530 indirect: a decimal floating point number from the text is converted by
2531 @command{@value{AS}} to a generic binary floating point number of more than
2532 sufficient precision. This generic floating point number is converted
2533 to a particular computer's floating point format (or formats) by a
2534 portion of @command{@value{AS}} specialized to that computer.
2536 A flonum is written by writing (in order)
2541 (@samp{0} is optional on the HPPA.)
2545 A letter, to tell @command{@value{AS}} the rest of the number is a flonum.
2547 @kbd{e} is recommended. Case is not important.
2549 @c FIXME: verify if flonum syntax really this vague for most cases
2550 (Any otherwise illegal letter works here, but that might be changed. Vax BSD
2551 4.2 assembler seems to allow any of @samp{defghDEFGH}.)
2554 On the H8/300, Renesas / SuperH SH,
2555 and AMD 29K architectures, the letter must be
2556 one of the letters @samp{DFPRSX} (in upper or lower case).
2558 On the ARC, the letter must be one of the letters @samp{DFRS}
2559 (in upper or lower case).
2561 On the Intel 960 architecture, the letter must be
2562 one of the letters @samp{DFT} (in upper or lower case).
2564 On the HPPA architecture, the letter must be @samp{E} (upper case only).
2568 One of the letters @samp{DFRS} (in upper or lower case).
2571 One of the letters @samp{DFPRSX} (in upper or lower case).
2574 The letter @samp{E} (upper case only).
2577 One of the letters @samp{DFT} (in upper or lower case).
2582 An optional sign: either @samp{+} or @samp{-}.
2585 An optional @dfn{integer part}: zero or more decimal digits.
2588 An optional @dfn{fractional part}: @samp{.} followed by zero
2589 or more decimal digits.
2592 An optional exponent, consisting of:
2596 An @samp{E} or @samp{e}.
2597 @c I can't find a config where "EXP_CHARS" is other than 'eE', but in
2598 @c principle this can perfectly well be different on different targets.
2600 Optional sign: either @samp{+} or @samp{-}.
2602 One or more decimal digits.
2607 At least one of the integer part or the fractional part must be
2608 present. The floating point number has the usual base-10 value.
2610 @command{@value{AS}} does all processing using integers. Flonums are computed
2611 independently of any floating point hardware in the computer running
2612 @command{@value{AS}}.
2616 @c Bit fields are written as a general facility but are also controlled
2617 @c by a conditional-compilation flag---which is as of now (21mar91)
2618 @c turned on only by the i960 config of GAS.
2620 @subsubsection Bit Fields
2623 @cindex constants, bit field
2624 You can also define numeric constants as @dfn{bit fields}.
2625 specify two numbers separated by a colon---
2627 @var{mask}:@var{value}
2630 @command{@value{AS}} applies a bitwise @sc{and} between @var{mask} and
2633 The resulting number is then packed
2635 @c this conditional paren in case bit fields turned on elsewhere than 960
2636 (in host-dependent byte order)
2638 into a field whose width depends on which assembler directive has the
2639 bit-field as its argument. Overflow (a result from the bitwise and
2640 requiring more binary digits to represent) is not an error; instead,
2641 more constants are generated, of the specified width, beginning with the
2642 least significant digits.@refill
2644 The directives @code{.byte}, @code{.hword}, @code{.int}, @code{.long},
2645 @code{.short}, and @code{.word} accept bit-field arguments.
2650 @chapter Sections and Relocation
2655 * Secs Background:: Background
2656 * Ld Sections:: Linker Sections
2657 * As Sections:: Assembler Internal Sections
2658 * Sub-Sections:: Sub-Sections
2662 @node Secs Background
2665 Roughly, a section is a range of addresses, with no gaps; all data
2666 ``in'' those addresses is treated the same for some particular purpose.
2667 For example there may be a ``read only'' section.
2669 @cindex linker, and assembler
2670 @cindex assembler, and linker
2671 The linker @code{@value{LD}} reads many object files (partial programs) and
2672 combines their contents to form a runnable program. When @command{@value{AS}}
2673 emits an object file, the partial program is assumed to start at address 0.
2674 @code{@value{LD}} assigns the final addresses for the partial program, so that
2675 different partial programs do not overlap. This is actually an
2676 oversimplification, but it suffices to explain how @command{@value{AS}} uses
2679 @code{@value{LD}} moves blocks of bytes of your program to their run-time
2680 addresses. These blocks slide to their run-time addresses as rigid
2681 units; their length does not change and neither does the order of bytes
2682 within them. Such a rigid unit is called a @emph{section}. Assigning
2683 run-time addresses to sections is called @dfn{relocation}. It includes
2684 the task of adjusting mentions of object-file addresses so they refer to
2685 the proper run-time addresses.
2687 For the H8/300, and for the Renesas / SuperH SH,
2688 @command{@value{AS}} pads sections if needed to
2689 ensure they end on a word (sixteen bit) boundary.
2692 @cindex standard assembler sections
2693 An object file written by @command{@value{AS}} has at least three sections, any
2694 of which may be empty. These are named @dfn{text}, @dfn{data} and
2699 When it generates COFF or ELF output,
2701 @command{@value{AS}} can also generate whatever other named sections you specify
2702 using the @samp{.section} directive (@pxref{Section,,@code{.section}}).
2703 If you do not use any directives that place output in the @samp{.text}
2704 or @samp{.data} sections, these sections still exist, but are empty.
2709 When @command{@value{AS}} generates SOM or ELF output for the HPPA,
2711 @command{@value{AS}} can also generate whatever other named sections you
2712 specify using the @samp{.space} and @samp{.subspace} directives. See
2713 @cite{HP9000 Series 800 Assembly Language Reference Manual}
2714 (HP 92432-90001) for details on the @samp{.space} and @samp{.subspace}
2715 assembler directives.
2718 Additionally, @command{@value{AS}} uses different names for the standard
2719 text, data, and bss sections when generating SOM output. Program text
2720 is placed into the @samp{$CODE$} section, data into @samp{$DATA$}, and
2721 BSS into @samp{$BSS$}.
2725 Within the object file, the text section starts at address @code{0}, the
2726 data section follows, and the bss section follows the data section.
2729 When generating either SOM or ELF output files on the HPPA, the text
2730 section starts at address @code{0}, the data section at address
2731 @code{0x4000000}, and the bss section follows the data section.
2734 To let @code{@value{LD}} know which data changes when the sections are
2735 relocated, and how to change that data, @command{@value{AS}} also writes to the
2736 object file details of the relocation needed. To perform relocation
2737 @code{@value{LD}} must know, each time an address in the object
2741 Where in the object file is the beginning of this reference to
2744 How long (in bytes) is this reference?
2746 Which section does the address refer to? What is the numeric value of
2748 (@var{address}) @minus{} (@var{start-address of section})?
2751 Is the reference to an address ``Program-Counter relative''?
2754 @cindex addresses, format of
2755 @cindex section-relative addressing
2756 In fact, every address @command{@value{AS}} ever uses is expressed as
2758 (@var{section}) + (@var{offset into section})
2761 Further, most expressions @command{@value{AS}} computes have this section-relative
2764 (For some object formats, such as SOM for the HPPA, some expressions are
2765 symbol-relative instead.)
2768 In this manual we use the notation @{@var{secname} @var{N}@} to mean ``offset
2769 @var{N} into section @var{secname}.''
2771 Apart from text, data and bss sections you need to know about the
2772 @dfn{absolute} section. When @code{@value{LD}} mixes partial programs,
2773 addresses in the absolute section remain unchanged. For example, address
2774 @code{@{absolute 0@}} is ``relocated'' to run-time address 0 by
2775 @code{@value{LD}}. Although the linker never arranges two partial programs'
2776 data sections with overlapping addresses after linking, @emph{by definition}
2777 their absolute sections must overlap. Address @code{@{absolute@ 239@}} in one
2778 part of a program is always the same address when the program is running as
2779 address @code{@{absolute@ 239@}} in any other part of the program.
2781 The idea of sections is extended to the @dfn{undefined} section. Any
2782 address whose section is unknown at assembly time is by definition
2783 rendered @{undefined @var{U}@}---where @var{U} is filled in later.
2784 Since numbers are always defined, the only way to generate an undefined
2785 address is to mention an undefined symbol. A reference to a named
2786 common block would be such a symbol: its value is unknown at assembly
2787 time so it has section @emph{undefined}.
2789 By analogy the word @emph{section} is used to describe groups of sections in
2790 the linked program. @code{@value{LD}} puts all partial programs' text
2791 sections in contiguous addresses in the linked program. It is
2792 customary to refer to the @emph{text section} of a program, meaning all
2793 the addresses of all partial programs' text sections. Likewise for
2794 data and bss sections.
2796 Some sections are manipulated by @code{@value{LD}}; others are invented for
2797 use of @command{@value{AS}} and have no meaning except during assembly.
2800 @section Linker Sections
2801 @code{@value{LD}} deals with just four kinds of sections, summarized below.
2806 @cindex named sections
2807 @cindex sections, named
2808 @item named sections
2811 @cindex text section
2812 @cindex data section
2816 These sections hold your program. @command{@value{AS}} and @code{@value{LD}} treat them as
2817 separate but equal sections. Anything you can say of one section is
2820 When the program is running, however, it is
2821 customary for the text section to be unalterable. The
2822 text section is often shared among processes: it contains
2823 instructions, constants and the like. The data section of a running
2824 program is usually alterable: for example, C variables would be stored
2825 in the data section.
2830 This section contains zeroed bytes when your program begins running. It
2831 is used to hold uninitialized variables or common storage. The length of
2832 each partial program's bss section is important, but because it starts
2833 out containing zeroed bytes there is no need to store explicit zero
2834 bytes in the object file. The bss section was invented to eliminate
2835 those explicit zeros from object files.
2837 @cindex absolute section
2838 @item absolute section
2839 Address 0 of this section is always ``relocated'' to runtime address 0.
2840 This is useful if you want to refer to an address that @code{@value{LD}} must
2841 not change when relocating. In this sense we speak of absolute
2842 addresses being ``unrelocatable'': they do not change during relocation.
2844 @cindex undefined section
2845 @item undefined section
2846 This ``section'' is a catch-all for address references to objects not in
2847 the preceding sections.
2848 @c FIXME: ref to some other doc on obj-file formats could go here.
2851 @cindex relocation example
2852 An idealized example of three relocatable sections follows.
2854 The example uses the traditional section names @samp{.text} and @samp{.data}.
2856 Memory addresses are on the horizontal axis.
2860 @c END TEXI2ROFF-KILL
2863 partial program # 1: |ttttt|dddd|00|
2870 partial program # 2: |TTT|DDD|000|
2873 +--+---+-----+--+----+---+-----+~~
2874 linked program: | |TTT|ttttt| |dddd|DDD|00000|
2875 +--+---+-----+--+----+---+-----+~~
2877 addresses: 0 @dots{}
2884 \line{\it Partial program \#1: \hfil}
2885 \line{\ibox{2.5cm}{\tt text}\ibox{2cm}{\tt data}\ibox{1cm}{\tt bss}\hfil}
2886 \line{\boxit{2.5cm}{\tt ttttt}\boxit{2cm}{\tt dddd}\boxit{1cm}{\tt 00}\hfil}
2888 \line{\it Partial program \#2: \hfil}
2889 \line{\ibox{1cm}{\tt text}\ibox{1.5cm}{\tt data}\ibox{1cm}{\tt bss}\hfil}
2890 \line{\boxit{1cm}{\tt TTT}\boxit{1.5cm}{\tt DDDD}\boxit{1cm}{\tt 000}\hfil}
2892 \line{\it linked program: \hfil}
2893 \line{\ibox{.5cm}{}\ibox{1cm}{\tt text}\ibox{2.5cm}{}\ibox{.75cm}{}\ibox{2cm}{\tt data}\ibox{1.5cm}{}\ibox{2cm}{\tt bss}\hfil}
2894 \line{\boxit{.5cm}{}\boxit{1cm}{\tt TTT}\boxit{2.5cm}{\tt
2895 ttttt}\boxit{.75cm}{}\boxit{2cm}{\tt dddd}\boxit{1.5cm}{\tt
2896 DDDD}\boxit{2cm}{\tt 00000}\ \dots\hfil}
2898 \line{\it addresses: \hfil}
2902 @c END TEXI2ROFF-KILL
2905 @section Assembler Internal Sections
2907 @cindex internal assembler sections
2908 @cindex sections in messages, internal
2909 These sections are meant only for the internal use of @command{@value{AS}}. They
2910 have no meaning at run-time. You do not really need to know about these
2911 sections for most purposes; but they can be mentioned in @command{@value{AS}}
2912 warning messages, so it might be helpful to have an idea of their
2913 meanings to @command{@value{AS}}. These sections are used to permit the
2914 value of every expression in your assembly language program to be a
2915 section-relative address.
2918 @cindex assembler internal logic error
2919 @item ASSEMBLER-INTERNAL-LOGIC-ERROR!
2920 An internal assembler logic error has been found. This means there is a
2921 bug in the assembler.
2923 @cindex expr (internal section)
2925 The assembler stores complex expression internally as combinations of
2926 symbols. When it needs to represent an expression as a symbol, it puts
2927 it in the expr section.
2929 @c FIXME item transfer[t] vector preload
2930 @c FIXME item transfer[t] vector postload
2931 @c FIXME item register
2935 @section Sub-Sections
2937 @cindex numbered subsections
2938 @cindex grouping data
2944 fall into two sections: text and data.
2946 You may have separate groups of
2948 data in named sections
2952 data in named sections
2958 that you want to end up near to each other in the object file, even though they
2959 are not contiguous in the assembler source. @command{@value{AS}} allows you to
2960 use @dfn{subsections} for this purpose. Within each section, there can be
2961 numbered subsections with values from 0 to 8192. Objects assembled into the
2962 same subsection go into the object file together with other objects in the same
2963 subsection. For example, a compiler might want to store constants in the text
2964 section, but might not want to have them interspersed with the program being
2965 assembled. In this case, the compiler could issue a @samp{.text 0} before each
2966 section of code being output, and a @samp{.text 1} before each group of
2967 constants being output.
2969 Subsections are optional. If you do not use subsections, everything
2970 goes in subsection number zero.
2973 Each subsection is zero-padded up to a multiple of four bytes.
2974 (Subsections may be padded a different amount on different flavors
2975 of @command{@value{AS}}.)
2979 On the H8/300 platform, each subsection is zero-padded to a word
2980 boundary (two bytes).
2981 The same is true on the Renesas SH.
2984 @c FIXME section padding (alignment)?
2985 @c Rich Pixley says padding here depends on target obj code format; that
2986 @c doesn't seem particularly useful to say without further elaboration,
2987 @c so for now I say nothing about it. If this is a generic BFD issue,
2988 @c these paragraphs might need to vanish from this manual, and be
2989 @c discussed in BFD chapter of binutils (or some such).
2993 Subsections appear in your object file in numeric order, lowest numbered
2994 to highest. (All this to be compatible with other people's assemblers.)
2995 The object file contains no representation of subsections; @code{@value{LD}} and
2996 other programs that manipulate object files see no trace of them.
2997 They just see all your text subsections as a text section, and all your
2998 data subsections as a data section.
3000 To specify which subsection you want subsequent statements assembled
3001 into, use a numeric argument to specify it, in a @samp{.text
3002 @var{expression}} or a @samp{.data @var{expression}} statement.
3005 When generating COFF output, you
3010 can also use an extra subsection
3011 argument with arbitrary named sections: @samp{.section @var{name},
3016 When generating ELF output, you
3021 can also use the @code{.subsection} directive (@pxref{SubSection})
3022 to specify a subsection: @samp{.subsection @var{expression}}.
3024 @var{Expression} should be an absolute expression.
3025 (@xref{Expressions}.) If you just say @samp{.text} then @samp{.text 0}
3026 is assumed. Likewise @samp{.data} means @samp{.data 0}. Assembly
3027 begins in @code{text 0}. For instance:
3029 .text 0 # The default subsection is text 0 anyway.
3030 .ascii "This lives in the first text subsection. *"
3032 .ascii "But this lives in the second text subsection."
3034 .ascii "This lives in the data section,"
3035 .ascii "in the first data subsection."
3037 .ascii "This lives in the first text section,"
3038 .ascii "immediately following the asterisk (*)."
3041 Each section has a @dfn{location counter} incremented by one for every byte
3042 assembled into that section. Because subsections are merely a convenience
3043 restricted to @command{@value{AS}} there is no concept of a subsection location
3044 counter. There is no way to directly manipulate a location counter---but the
3045 @code{.align} directive changes it, and any label definition captures its
3046 current value. The location counter of the section where statements are being
3047 assembled is said to be the @dfn{active} location counter.
3050 @section bss Section
3053 @cindex common variable storage
3054 The bss section is used for local common variable storage.
3055 You may allocate address space in the bss section, but you may
3056 not dictate data to load into it before your program executes. When
3057 your program starts running, all the contents of the bss
3058 section are zeroed bytes.
3060 The @code{.lcomm} pseudo-op defines a symbol in the bss section; see
3061 @ref{Lcomm,,@code{.lcomm}}.
3063 The @code{.comm} pseudo-op may be used to declare a common symbol, which is
3064 another form of uninitialized symbol; see @xref{Comm,,@code{.comm}}.
3067 When assembling for a target which supports multiple sections, such as ELF or
3068 COFF, you may switch into the @code{.bss} section and define symbols as usual;
3069 see @ref{Section,,@code{.section}}. You may only assemble zero values into the
3070 section. Typically the section will only contain symbol definitions and
3071 @code{.skip} directives (@pxref{Skip,,@code{.skip}}).
3078 Symbols are a central concept: the programmer uses symbols to name
3079 things, the linker uses symbols to link, and the debugger uses symbols
3083 @cindex debuggers, and symbol order
3084 @emph{Warning:} @command{@value{AS}} does not place symbols in the object file in
3085 the same order they were declared. This may break some debuggers.
3090 * Setting Symbols:: Giving Symbols Other Values
3091 * Symbol Names:: Symbol Names
3092 * Dot:: The Special Dot Symbol
3093 * Symbol Attributes:: Symbol Attributes
3100 A @dfn{label} is written as a symbol immediately followed by a colon
3101 @samp{:}. The symbol then represents the current value of the
3102 active location counter, and is, for example, a suitable instruction
3103 operand. You are warned if you use the same symbol to represent two
3104 different locations: the first definition overrides any other
3108 On the HPPA, the usual form for a label need not be immediately followed by a
3109 colon, but instead must start in column zero. Only one label may be defined on
3110 a single line. To work around this, the HPPA version of @command{@value{AS}} also
3111 provides a special directive @code{.label} for defining labels more flexibly.
3114 @node Setting Symbols
3115 @section Giving Symbols Other Values
3117 @cindex assigning values to symbols
3118 @cindex symbol values, assigning
3119 A symbol can be given an arbitrary value by writing a symbol, followed
3120 by an equals sign @samp{=}, followed by an expression
3121 (@pxref{Expressions}). This is equivalent to using the @code{.set}
3122 directive. @xref{Set,,@code{.set}}. In the same way, using a double
3123 equals sign @samp{=}@samp{=} here represents an equivalent of the
3124 @code{.eqv} directive. @xref{Eqv,,@code{.eqv}}.
3127 @section Symbol Names
3129 @cindex symbol names
3130 @cindex names, symbol
3131 @ifclear SPECIAL-SYMS
3132 Symbol names begin with a letter or with one of @samp{._}. On most
3133 machines, you can also use @code{$} in symbol names; exceptions are
3134 noted in @ref{Machine Dependencies}. That character may be followed by any
3135 string of digits, letters, dollar signs (unless otherwise noted in
3136 @ref{Machine Dependencies}), and underscores.
3140 Symbol names begin with a letter or with one of @samp{._}. On the
3141 Renesas SH you can also use @code{$} in symbol names. That
3142 character may be followed by any string of digits, letters, dollar signs (save
3143 on the H8/300), and underscores.
3147 Case of letters is significant: @code{foo} is a different symbol name
3150 Each symbol has exactly one name. Each name in an assembly language program
3151 refers to exactly one symbol. You may use that symbol name any number of times
3154 @subheading Local Symbol Names
3156 @cindex local symbol names
3157 @cindex symbol names, local
3158 @cindex temporary symbol names
3159 @cindex symbol names, temporary
3160 Local symbols help compilers and programmers use names temporarily.
3161 They create symbols which are guaranteed to be unique over the entire scope of
3162 the input source code and which can be referred to by a simple notation.
3163 To define a local symbol, write a label of the form @samp{@b{N}:} (where @b{N}
3164 represents any positive integer). To refer to the most recent previous
3165 definition of that symbol write @samp{@b{N}b}, using the same number as when
3166 you defined the label. To refer to the next definition of a local label, write
3167 @samp{@b{N}f}--- The @samp{b} stands for``backwards'' and the @samp{f} stands
3170 There is no restriction on how you can use these labels, and you can reuse them
3171 too. So that it is possible to repeatedly define the same local label (using
3172 the same number @samp{@b{N}}), although you can only refer to the most recently
3173 defined local label of that number (for a backwards reference) or the next
3174 definition of a specific local label for a forward reference. It is also worth
3175 noting that the first 10 local labels (@samp{@b{0:}}@dots{}@samp{@b{9:}}) are
3176 implemented in a slightly more efficient manner than the others.
3187 Which is the equivalent of:
3190 label_1: branch label_3
3191 label_2: branch label_1
3192 label_3: branch label_4
3193 label_4: branch label_3
3196 Local symbol names are only a notational device. They are immediately
3197 transformed into more conventional symbol names before the assembler uses them.
3198 The symbol names stored in the symbol table, appearing in error messages and
3199 optionally emitted to the object file. The names are constructed using these
3204 All local labels begin with @samp{L}. Normally both @command{@value{AS}} and
3205 @code{@value{LD}} forget symbols that start with @samp{L}. These labels are
3206 used for symbols you are never intended to see. If you use the
3207 @samp{-L} option then @command{@value{AS}} retains these symbols in the
3208 object file. If you also instruct @code{@value{LD}} to retain these symbols,
3209 you may use them in debugging.
3212 This is the number that was used in the local label definition. So if the
3213 label is written @samp{55:} then the number is @samp{55}.
3216 This unusual character is included so you do not accidentally invent a symbol
3217 of the same name. The character has ASCII value of @samp{\002} (control-B).
3219 @item @emph{ordinal number}
3220 This is a serial number to keep the labels distinct. The first definition of
3221 @samp{0:} gets the number @samp{1}. The 15th definition of @samp{0:} gets the
3222 number @samp{15}, and so on. Likewise the first definition of @samp{1:} gets
3223 the number @samp{1} and its 15th defintion gets @samp{15} as well.
3226 So for example, the first @code{1:} is named @code{L1@kbd{C-B}1}, the 44th
3227 @code{3:} is named @code{L3@kbd{C-B}44}.
3229 @subheading Dollar Local Labels
3230 @cindex dollar local symbols
3232 @code{@value{AS}} also supports an even more local form of local labels called
3233 dollar labels. These labels go out of scope (ie they become undefined) as soon
3234 as a non-local label is defined. Thus they remain valid for only a small
3235 region of the input source code. Normal local labels, by contrast, remain in
3236 scope for the entire file, or until they are redefined by another occurrence of
3237 the same local label.
3239 Dollar labels are defined in exactly the same way as ordinary local labels,
3240 except that instead of being terminated by a colon, they are terminated by a
3241 dollar sign. eg @samp{@b{55$}}.
3243 They can also be distinguished from ordinary local labels by their transformed
3244 name which uses ASCII character @samp{\001} (control-A) as the magic character
3245 to distinguish them from ordinary labels. Thus the 5th defintion of @samp{6$}
3246 is named @samp{L6@kbd{C-A}5}.
3249 @section The Special Dot Symbol
3251 @cindex dot (symbol)
3252 @cindex @code{.} (symbol)
3253 @cindex current address
3254 @cindex location counter
3255 The special symbol @samp{.} refers to the current address that
3256 @command{@value{AS}} is assembling into. Thus, the expression @samp{melvin:
3257 .long .} defines @code{melvin} to contain its own address.
3258 Assigning a value to @code{.} is treated the same as a @code{.org}
3259 directive. Thus, the expression @samp{.=.+4} is the same as saying
3260 @ifclear no-space-dir
3264 @node Symbol Attributes
3265 @section Symbol Attributes
3267 @cindex symbol attributes
3268 @cindex attributes, symbol
3269 Every symbol has, as well as its name, the attributes ``Value'' and
3270 ``Type''. Depending on output format, symbols can also have auxiliary
3273 The detailed definitions are in @file{a.out.h}.
3276 If you use a symbol without defining it, @command{@value{AS}} assumes zero for
3277 all these attributes, and probably won't warn you. This makes the
3278 symbol an externally defined symbol, which is generally what you
3282 * Symbol Value:: Value
3283 * Symbol Type:: Type
3286 * a.out Symbols:: Symbol Attributes: @code{a.out}
3290 * a.out Symbols:: Symbol Attributes: @code{a.out}
3293 * a.out Symbols:: Symbol Attributes: @code{a.out}, @code{b.out}
3298 * COFF Symbols:: Symbol Attributes for COFF
3301 * SOM Symbols:: Symbol Attributes for SOM
3308 @cindex value of a symbol
3309 @cindex symbol value
3310 The value of a symbol is (usually) 32 bits. For a symbol which labels a
3311 location in the text, data, bss or absolute sections the value is the
3312 number of addresses from the start of that section to the label.
3313 Naturally for text, data and bss sections the value of a symbol changes
3314 as @code{@value{LD}} changes section base addresses during linking. Absolute
3315 symbols' values do not change during linking: that is why they are
3318 The value of an undefined symbol is treated in a special way. If it is
3319 0 then the symbol is not defined in this assembler source file, and
3320 @code{@value{LD}} tries to determine its value from other files linked into the
3321 same program. You make this kind of symbol simply by mentioning a symbol
3322 name without defining it. A non-zero value represents a @code{.comm}
3323 common declaration. The value is how much common storage to reserve, in
3324 bytes (addresses). The symbol refers to the first address of the
3330 @cindex type of a symbol
3332 The type attribute of a symbol contains relocation (section)
3333 information, any flag settings indicating that a symbol is external, and
3334 (optionally), other information for linkers and debuggers. The exact
3335 format depends on the object-code output format in use.
3340 @c The following avoids a "widow" subsection title. @group would be
3341 @c better if it were available outside examples.
3344 @subsection Symbol Attributes: @code{a.out}, @code{b.out}
3346 @cindex @code{b.out} symbol attributes
3347 @cindex symbol attributes, @code{b.out}
3348 These symbol attributes appear only when @command{@value{AS}} is configured for
3349 one of the Berkeley-descended object output formats---@code{a.out} or
3355 @subsection Symbol Attributes: @code{a.out}
3357 @cindex @code{a.out} symbol attributes
3358 @cindex symbol attributes, @code{a.out}
3364 @subsection Symbol Attributes: @code{a.out}
3366 @cindex @code{a.out} symbol attributes
3367 @cindex symbol attributes, @code{a.out}
3371 * Symbol Desc:: Descriptor
3372 * Symbol Other:: Other
3376 @subsubsection Descriptor
3378 @cindex descriptor, of @code{a.out} symbol
3379 This is an arbitrary 16-bit value. You may establish a symbol's
3380 descriptor value by using a @code{.desc} statement
3381 (@pxref{Desc,,@code{.desc}}). A descriptor value means nothing to
3382 @command{@value{AS}}.
3385 @subsubsection Other
3387 @cindex other attribute, of @code{a.out} symbol
3388 This is an arbitrary 8-bit value. It means nothing to @command{@value{AS}}.
3393 @subsection Symbol Attributes for COFF
3395 @cindex COFF symbol attributes
3396 @cindex symbol attributes, COFF
3398 The COFF format supports a multitude of auxiliary symbol attributes;
3399 like the primary symbol attributes, they are set between @code{.def} and
3400 @code{.endef} directives.
3402 @subsubsection Primary Attributes
3404 @cindex primary attributes, COFF symbols
3405 The symbol name is set with @code{.def}; the value and type,
3406 respectively, with @code{.val} and @code{.type}.
3408 @subsubsection Auxiliary Attributes
3410 @cindex auxiliary attributes, COFF symbols
3411 The @command{@value{AS}} directives @code{.dim}, @code{.line}, @code{.scl},
3412 @code{.size}, @code{.tag}, and @code{.weak} can generate auxiliary symbol
3413 table information for COFF.
3418 @subsection Symbol Attributes for SOM
3420 @cindex SOM symbol attributes
3421 @cindex symbol attributes, SOM
3423 The SOM format for the HPPA supports a multitude of symbol attributes set with
3424 the @code{.EXPORT} and @code{.IMPORT} directives.
3426 The attributes are described in @cite{HP9000 Series 800 Assembly
3427 Language Reference Manual} (HP 92432-90001) under the @code{IMPORT} and
3428 @code{EXPORT} assembler directive documentation.
3432 @chapter Expressions
3436 @cindex numeric values
3437 An @dfn{expression} specifies an address or numeric value.
3438 Whitespace may precede and/or follow an expression.
3440 The result of an expression must be an absolute number, or else an offset into
3441 a particular section. If an expression is not absolute, and there is not
3442 enough information when @command{@value{AS}} sees the expression to know its
3443 section, a second pass over the source program might be necessary to interpret
3444 the expression---but the second pass is currently not implemented.
3445 @command{@value{AS}} aborts with an error message in this situation.
3448 * Empty Exprs:: Empty Expressions
3449 * Integer Exprs:: Integer Expressions
3453 @section Empty Expressions
3455 @cindex empty expressions
3456 @cindex expressions, empty
3457 An empty expression has no value: it is just whitespace or null.
3458 Wherever an absolute expression is required, you may omit the
3459 expression, and @command{@value{AS}} assumes a value of (absolute) 0. This
3460 is compatible with other assemblers.
3463 @section Integer Expressions
3465 @cindex integer expressions
3466 @cindex expressions, integer
3467 An @dfn{integer expression} is one or more @emph{arguments} delimited
3468 by @emph{operators}.
3471 * Arguments:: Arguments
3472 * Operators:: Operators
3473 * Prefix Ops:: Prefix Operators
3474 * Infix Ops:: Infix Operators
3478 @subsection Arguments
3480 @cindex expression arguments
3481 @cindex arguments in expressions
3482 @cindex operands in expressions
3483 @cindex arithmetic operands
3484 @dfn{Arguments} are symbols, numbers or subexpressions. In other
3485 contexts arguments are sometimes called ``arithmetic operands''. In
3486 this manual, to avoid confusing them with the ``instruction operands'' of
3487 the machine language, we use the term ``argument'' to refer to parts of
3488 expressions only, reserving the word ``operand'' to refer only to machine
3489 instruction operands.
3491 Symbols are evaluated to yield @{@var{section} @var{NNN}@} where
3492 @var{section} is one of text, data, bss, absolute,
3493 or undefined. @var{NNN} is a signed, 2's complement 32 bit
3496 Numbers are usually integers.
3498 A number can be a flonum or bignum. In this case, you are warned
3499 that only the low order 32 bits are used, and @command{@value{AS}} pretends
3500 these 32 bits are an integer. You may write integer-manipulating
3501 instructions that act on exotic constants, compatible with other
3504 @cindex subexpressions
3505 Subexpressions are a left parenthesis @samp{(} followed by an integer
3506 expression, followed by a right parenthesis @samp{)}; or a prefix
3507 operator followed by an argument.
3510 @subsection Operators
3512 @cindex operators, in expressions
3513 @cindex arithmetic functions
3514 @cindex functions, in expressions
3515 @dfn{Operators} are arithmetic functions, like @code{+} or @code{%}. Prefix
3516 operators are followed by an argument. Infix operators appear
3517 between their arguments. Operators may be preceded and/or followed by
3521 @subsection Prefix Operator
3523 @cindex prefix operators
3524 @command{@value{AS}} has the following @dfn{prefix operators}. They each take
3525 one argument, which must be absolute.
3527 @c the tex/end tex stuff surrounding this small table is meant to make
3528 @c it align, on the printed page, with the similar table in the next
3529 @c section (which is inside an enumerate).
3531 \global\advance\leftskip by \itemindent
3536 @dfn{Negation}. Two's complement negation.
3538 @dfn{Complementation}. Bitwise not.
3542 \global\advance\leftskip by -\itemindent
3546 @subsection Infix Operators
3548 @cindex infix operators
3549 @cindex operators, permitted arguments
3550 @dfn{Infix operators} take two arguments, one on either side. Operators
3551 have precedence, but operations with equal precedence are performed left
3552 to right. Apart from @code{+} or @option{-}, both arguments must be
3553 absolute, and the result is absolute.
3556 @cindex operator precedence
3557 @cindex precedence of operators
3564 @dfn{Multiplication}.
3567 @dfn{Division}. Truncation is the same as the C operator @samp{/}
3573 @dfn{Shift Left}. Same as the C operator @samp{<<}.
3576 @dfn{Shift Right}. Same as the C operator @samp{>>}.
3580 Intermediate precedence
3585 @dfn{Bitwise Inclusive Or}.
3591 @dfn{Bitwise Exclusive Or}.
3594 @dfn{Bitwise Or Not}.
3601 @cindex addition, permitted arguments
3602 @cindex plus, permitted arguments
3603 @cindex arguments for addition
3605 @dfn{Addition}. If either argument is absolute, the result has the section of
3606 the other argument. You may not add together arguments from different
3609 @cindex subtraction, permitted arguments
3610 @cindex minus, permitted arguments
3611 @cindex arguments for subtraction
3613 @dfn{Subtraction}. If the right argument is absolute, the
3614 result has the section of the left argument.
3615 If both arguments are in the same section, the result is absolute.
3616 You may not subtract arguments from different sections.
3617 @c FIXME is there still something useful to say about undefined - undefined ?
3619 @cindex comparison expressions
3620 @cindex expressions, comparison
3625 @dfn{Is Not Equal To}
3629 @dfn{Is Greater Than}
3631 @dfn{Is Greater Than Or Equal To}
3633 @dfn{Is Less Than Or Equal To}
3635 The comparison operators can be used as infix operators. A true results has a
3636 value of -1 whereas a false result has a value of 0. Note, these operators
3637 perform signed comparisons.
3640 @item Lowest Precedence
3649 These two logical operations can be used to combine the results of sub
3650 expressions. Note, unlike the comparison operators a true result returns a
3651 value of 1 but a false results does still return 0. Also note that the logical
3652 or operator has a slightly lower precedence than logical and.
3657 In short, it's only meaningful to add or subtract the @emph{offsets} in an
3658 address; you can only have a defined section in one of the two arguments.
3661 @chapter Assembler Directives
3663 @cindex directives, machine independent
3664 @cindex pseudo-ops, machine independent
3665 @cindex machine independent directives
3666 All assembler directives have names that begin with a period (@samp{.}).
3667 The rest of the name is letters, usually in lower case.
3669 This chapter discusses directives that are available regardless of the
3670 target machine configuration for the @sc{gnu} assembler.
3672 Some machine configurations provide additional directives.
3673 @xref{Machine Dependencies}.
3676 @ifset machine-directives
3677 @xref{Machine Dependencies} for additional directives.
3682 * Abort:: @code{.abort}
3684 * ABORT:: @code{.ABORT}
3687 * Align:: @code{.align @var{abs-expr} , @var{abs-expr}}
3688 * Altmacro:: @code{.altmacro}
3689 * Ascii:: @code{.ascii "@var{string}"}@dots{}
3690 * Asciz:: @code{.asciz "@var{string}"}@dots{}
3691 * Balign:: @code{.balign @var{abs-expr} , @var{abs-expr}}
3692 * Byte:: @code{.byte @var{expressions}}
3693 * Comm:: @code{.comm @var{symbol} , @var{length} }
3695 * CFI directives:: @code{.cfi_startproc}, @code{.cfi_endproc}, etc.
3697 * Data:: @code{.data @var{subsection}}
3699 * Def:: @code{.def @var{name}}
3702 * Desc:: @code{.desc @var{symbol}, @var{abs-expression}}
3708 * Double:: @code{.double @var{flonums}}
3709 * Eject:: @code{.eject}
3710 * Else:: @code{.else}
3711 * Elseif:: @code{.elseif}
3714 * Endef:: @code{.endef}
3717 * Endfunc:: @code{.endfunc}
3718 * Endif:: @code{.endif}
3719 * Equ:: @code{.equ @var{symbol}, @var{expression}}
3720 * Equiv:: @code{.equiv @var{symbol}, @var{expression}}
3721 * Eqv:: @code{.eqv @var{symbol}, @var{expression}}
3723 * Error:: @code{.error @var{string}}
3724 * Exitm:: @code{.exitm}
3725 * Extern:: @code{.extern}
3726 * Fail:: @code{.fail}
3727 @ifclear no-file-dir
3728 * File:: @code{.file @var{string}}
3731 * Fill:: @code{.fill @var{repeat} , @var{size} , @var{value}}
3732 * Float:: @code{.float @var{flonums}}
3733 * Func:: @code{.func}
3734 * Global:: @code{.global @var{symbol}}, @code{.globl @var{symbol}}
3736 * Hidden:: @code{.hidden @var{names}}
3739 * hword:: @code{.hword @var{expressions}}
3740 * Ident:: @code{.ident}
3741 * If:: @code{.if @var{absolute expression}}
3742 * Incbin:: @code{.incbin "@var{file}"[,@var{skip}[,@var{count}]]}
3743 * Include:: @code{.include "@var{file}"}
3744 * Int:: @code{.int @var{expressions}}
3746 * Internal:: @code{.internal @var{names}}
3749 * Irp:: @code{.irp @var{symbol},@var{values}}@dots{}
3750 * Irpc:: @code{.irpc @var{symbol},@var{values}}@dots{}
3751 * Lcomm:: @code{.lcomm @var{symbol} , @var{length}}
3752 * Lflags:: @code{.lflags}
3753 @ifclear no-line-dir
3754 * Line:: @code{.line @var{line-number}}
3757 * Linkonce:: @code{.linkonce [@var{type}]}
3758 * List:: @code{.list}
3759 * Ln:: @code{.ln @var{line-number}}
3761 * LNS directives:: @code{.file}, @code{.loc}, etc.
3763 * Long:: @code{.long @var{expressions}}
3765 * Lsym:: @code{.lsym @var{symbol}, @var{expression}}
3768 * Macro:: @code{.macro @var{name} @var{args}}@dots{}
3769 * MRI:: @code{.mri @var{val}}
3770 * Noaltmacro:: @code{.noaltmacro}
3771 * Nolist:: @code{.nolist}
3772 * Octa:: @code{.octa @var{bignums}}
3773 * Org:: @code{.org @var{new-lc} , @var{fill}}
3774 * P2align:: @code{.p2align @var{abs-expr} , @var{abs-expr}}
3776 * PopSection:: @code{.popsection}
3777 * Previous:: @code{.previous}
3780 * Print:: @code{.print @var{string}}
3782 * Protected:: @code{.protected @var{names}}
3785 * Psize:: @code{.psize @var{lines}, @var{columns}}
3786 * Purgem:: @code{.purgem @var{name}}
3788 * PushSection:: @code{.pushsection @var{name}}
3791 * Quad:: @code{.quad @var{bignums}}
3792 * Rept:: @code{.rept @var{count}}
3793 * Sbttl:: @code{.sbttl "@var{subheading}"}
3795 * Scl:: @code{.scl @var{class}}
3798 * Section:: @code{.section @var{name}}
3801 * Set:: @code{.set @var{symbol}, @var{expression}}
3802 * Short:: @code{.short @var{expressions}}
3803 * Single:: @code{.single @var{flonums}}
3805 * Size:: @code{.size [@var{name} , @var{expression}]}
3808 * Skip:: @code{.skip @var{size} , @var{fill}}
3809 * Sleb128:: @code{.sleb128 @var{expressions}}
3810 * Space:: @code{.space @var{size} , @var{fill}}
3812 * Stab:: @code{.stabd, .stabn, .stabs}
3815 * String:: @code{.string "@var{str}"}
3816 * Struct:: @code{.struct @var{expression}}
3818 * SubSection:: @code{.subsection}
3819 * Symver:: @code{.symver @var{name},@var{name2@@nodename}}
3823 * Tag:: @code{.tag @var{structname}}
3826 * Text:: @code{.text @var{subsection}}
3827 * Title:: @code{.title "@var{heading}"}
3829 * Type:: @code{.type <@var{int} | @var{name} , @var{type description}>}
3832 * Uleb128:: @code{.uleb128 @var{expressions}}
3834 * Val:: @code{.val @var{addr}}
3838 * Version:: @code{.version "@var{string}"}
3839 * VTableEntry:: @code{.vtable_entry @var{table}, @var{offset}}
3840 * VTableInherit:: @code{.vtable_inherit @var{child}, @var{parent}}
3843 * Warning:: @code{.warning @var{string}}
3844 * Weak:: @code{.weak @var{names}}
3845 * Word:: @code{.word @var{expressions}}
3846 * Deprecated:: Deprecated Directives
3850 @section @code{.abort}
3852 @cindex @code{abort} directive
3853 @cindex stopping the assembly
3854 This directive stops the assembly immediately. It is for
3855 compatibility with other assemblers. The original idea was that the
3856 assembly language source would be piped into the assembler. If the sender
3857 of the source quit, it could use this directive tells @command{@value{AS}} to
3858 quit also. One day @code{.abort} will not be supported.
3862 @section @code{.ABORT}
3864 @cindex @code{ABORT} directive
3865 When producing COFF output, @command{@value{AS}} accepts this directive as a
3866 synonym for @samp{.abort}.
3869 When producing @code{b.out} output, @command{@value{AS}} accepts this directive,
3875 @section @code{.align @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
3877 @cindex padding the location counter
3878 @cindex @code{align} directive
3879 Pad the location counter (in the current subsection) to a particular storage
3880 boundary. The first expression (which must be absolute) is the alignment
3881 required, as described below.
3883 The second expression (also absolute) gives the fill value to be stored in the
3884 padding bytes. It (and the comma) may be omitted. If it is omitted, the
3885 padding bytes are normally zero. However, on some systems, if the section is
3886 marked as containing code and the fill value is omitted, the space is filled
3887 with no-op instructions.
3889 The third expression is also absolute, and is also optional. If it is present,
3890 it is the maximum number of bytes that should be skipped by this alignment
3891 directive. If doing the alignment would require skipping more bytes than the
3892 specified maximum, then the alignment is not done at all. You can omit the
3893 fill value (the second argument) entirely by simply using two commas after the
3894 required alignment; this can be useful if you want the alignment to be filled
3895 with no-op instructions when appropriate.
3897 The way the required alignment is specified varies from system to system.
3898 For the arc, hppa, i386 using ELF, i860, iq2000, m68k, or32,
3899 s390, sparc, tic4x, tic80 and xtensa, the first expression is the
3900 alignment request in bytes. For example @samp{.align 8} advances
3901 the location counter until it is a multiple of 8. If the location counter
3902 is already a multiple of 8, no change is needed. For the tic54x, the
3903 first expression is the alignment request in words.
3905 For other systems, including the i386 using a.out format, and the arm and
3906 strongarm, it is the
3907 number of low-order zero bits the location counter must have after
3908 advancement. For example @samp{.align 3} advances the location
3909 counter until it a multiple of 8. If the location counter is already a
3910 multiple of 8, no change is needed.
3912 This inconsistency is due to the different behaviors of the various
3913 native assemblers for these systems which GAS must emulate.
3914 GAS also provides @code{.balign} and @code{.p2align} directives,
3915 described later, which have a consistent behavior across all
3916 architectures (but are specific to GAS).
3919 @section @code{.ascii "@var{string}"}@dots{}
3921 @cindex @code{ascii} directive
3922 @cindex string literals
3923 @code{.ascii} expects zero or more string literals (@pxref{Strings})
3924 separated by commas. It assembles each string (with no automatic
3925 trailing zero byte) into consecutive addresses.
3928 @section @code{.asciz "@var{string}"}@dots{}
3930 @cindex @code{asciz} directive
3931 @cindex zero-terminated strings
3932 @cindex null-terminated strings
3933 @code{.asciz} is just like @code{.ascii}, but each string is followed by
3934 a zero byte. The ``z'' in @samp{.asciz} stands for ``zero''.
3937 @section @code{.balign[wl] @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
3939 @cindex padding the location counter given number of bytes
3940 @cindex @code{balign} directive
3941 Pad the location counter (in the current subsection) to a particular
3942 storage boundary. The first expression (which must be absolute) is the
3943 alignment request in bytes. For example @samp{.balign 8} advances
3944 the location counter until it is a multiple of 8. If the location counter
3945 is already a multiple of 8, no change is needed.
3947 The second expression (also absolute) gives the fill value to be stored in the
3948 padding bytes. It (and the comma) may be omitted. If it is omitted, the
3949 padding bytes are normally zero. However, on some systems, if the section is
3950 marked as containing code and the fill value is omitted, the space is filled
3951 with no-op instructions.
3953 The third expression is also absolute, and is also optional. If it is present,
3954 it is the maximum number of bytes that should be skipped by this alignment
3955 directive. If doing the alignment would require skipping more bytes than the
3956 specified maximum, then the alignment is not done at all. You can omit the
3957 fill value (the second argument) entirely by simply using two commas after the
3958 required alignment; this can be useful if you want the alignment to be filled
3959 with no-op instructions when appropriate.
3961 @cindex @code{balignw} directive
3962 @cindex @code{balignl} directive
3963 The @code{.balignw} and @code{.balignl} directives are variants of the
3964 @code{.balign} directive. The @code{.balignw} directive treats the fill
3965 pattern as a two byte word value. The @code{.balignl} directives treats the
3966 fill pattern as a four byte longword value. For example, @code{.balignw
3967 4,0x368d} will align to a multiple of 4. If it skips two bytes, they will be
3968 filled in with the value 0x368d (the exact placement of the bytes depends upon
3969 the endianness of the processor). If it skips 1 or 3 bytes, the fill value is
3973 @section @code{.byte @var{expressions}}
3975 @cindex @code{byte} directive
3976 @cindex integers, one byte
3977 @code{.byte} expects zero or more expressions, separated by commas.
3978 Each expression is assembled into the next byte.
3981 @section @code{.comm @var{symbol} , @var{length} }
3983 @cindex @code{comm} directive
3984 @cindex symbol, common
3985 @code{.comm} declares a common symbol named @var{symbol}. When linking, a
3986 common symbol in one object file may be merged with a defined or common symbol
3987 of the same name in another object file. If @code{@value{LD}} does not see a
3988 definition for the symbol--just one or more common symbols--then it will
3989 allocate @var{length} bytes of uninitialized memory. @var{length} must be an
3990 absolute expression. If @code{@value{LD}} sees multiple common symbols with
3991 the same name, and they do not all have the same size, it will allocate space
3992 using the largest size.
3995 When using ELF, the @code{.comm} directive takes an optional third argument.
3996 This is the desired alignment of the symbol, specified as a byte boundary (for
3997 example, an alignment of 16 means that the least significant 4 bits of the
3998 address should be zero). The alignment must be an absolute expression, and it
3999 must be a power of two. If @code{@value{LD}} allocates uninitialized memory
4000 for the common symbol, it will use the alignment when placing the symbol. If
4001 no alignment is specified, @command{@value{AS}} will set the alignment to the
4002 largest power of two less than or equal to the size of the symbol, up to a
4007 The syntax for @code{.comm} differs slightly on the HPPA. The syntax is
4008 @samp{@var{symbol} .comm, @var{length}}; @var{symbol} is optional.
4011 @node CFI directives
4012 @section @code{.cfi_startproc}
4013 @cindex @code{cfi_startproc} directive
4014 @code{.cfi_startproc} is used at the beginning of each function that
4015 should have an entry in @code{.eh_frame}. It initializes some internal
4016 data structures and emits architecture dependent initial CFI instructions.
4017 Don't forget to close the function by
4018 @code{.cfi_endproc}.
4020 @section @code{.cfi_endproc}
4021 @cindex @code{cfi_endproc} directive
4022 @code{.cfi_endproc} is used at the end of a function where it closes its
4023 unwind entry previously opened by
4024 @code{.cfi_startproc}. and emits it to @code{.eh_frame}.
4026 @section @code{.cfi_def_cfa @var{register}, @var{offset}}
4027 @code{.cfi_def_cfa} defines a rule for computing CFA as: @i{take
4028 address from @var{register} and add @var{offset} to it}.
4030 @section @code{.cfi_def_cfa_register @var{register}}
4031 @code{.cfi_def_cfa_register} modifies a rule for computing CFA. From
4032 now on @var{register} will be used instead of the old one. Offset
4035 @section @code{.cfi_def_cfa_offset @var{offset}}
4036 @code{.cfi_def_cfa_offset} modifies a rule for computing CFA. Register
4037 remains the same, but @var{offset} is new. Note that it is the
4038 absolute offset that will be added to a defined register to compute
4041 @section @code{.cfi_adjust_cfa_offset @var{offset}}
4042 Same as @code{.cfi_def_cfa_offset} but @var{offset} is a relative
4043 value that is added/substracted from the previous offset.
4045 @section @code{.cfi_offset @var{register}, @var{offset}}
4046 Previous value of @var{register} is saved at offset @var{offset} from
4049 @section @code{.cfi_rel_offset @var{register}, @var{offset}}
4050 Previous value of @var{register} is saved at offset @var{offset} from
4051 the current CFA register. This is transformed to @code{.cfi_offset}
4052 using the known displacement of the CFA register from the CFA.
4053 This is often easier to use, because the number will match the
4054 code it's annotating.
4056 @section @code{.cfi_window_save}
4057 SPARC register window has been saved.
4059 @section @code{.cfi_escape} @var{expression}[, @dots{}]
4060 Allows the user to add arbitrary bytes to the unwind info. One
4061 might use this to add OS-specific CFI opcodes, or generic CFI
4062 opcodes that GAS does not yet support.
4064 @node LNS directives
4065 @section @code{.file @var{fileno} @var{filename}}
4066 @cindex @code{file} directive
4067 When emitting dwarf2 line number information @code{.file} assigns filenames
4068 to the @code{.debug_line} file name table. The @var{fileno} operand should
4069 be a unique positive integer to use as the index of the entry in the table.
4070 The @var{filename} operand is a C string literal.
4072 The detail of filename indicies is exposed to the user because the filename
4073 table is shared with the @code{.debug_info} section of the dwarf2 debugging
4074 information, and thus the user must know the exact indicies that table
4077 @section @code{.loc @var{fileno} @var{lineno} [@var{column}] [@var{options}]}
4078 @cindex @code{loc} directive
4079 The @code{.loc} directive will add row to the @code{.debug_line} line
4080 number matrix corresponding to the immediately following assembly
4081 instruction. The @var{fileno}, @var{lineno}, and optional @var{column}
4082 arguments will be applied to the @code{.debug_line} state machine before
4085 The @var{options} are a sequence of the following tokens in any order:
4089 This option will set the @code{basic_block} register in the
4090 @code{.debug_line} state machine to @code{true}.
4093 This option will set the @code{prologue_end} register in the
4094 @code{.debug_line} state machine to @code{true}.
4096 @item epilogue_begin
4097 This option will set the @code{epilogue_begin} register in the
4098 @code{.debug_line} state machine to @code{true}.
4100 @item is_stmt @var{value}
4101 This option will set the @code{is_stmt} register in the
4102 @code{.debug_line} state machine to @code{value}, which must be
4105 @item isa @var{value}
4106 This directive will set the @code{isa} register in the @code{.debug_line}
4107 state machine to @var{value}, which must be an unsigned integer.
4109 @section @code{.loc_mark_blocks @var{enable}}
4110 @cindex @code{loc_mark_blocks} directive
4111 The @code{.loc_mark_blocks} directive makes the assembler emit an entry
4112 to the @code{.debug_line} line number matrix with the @code{basic_block}
4113 register in the state machine set whenever a code label is seen.
4114 The @var{enable} argument should be either 1 or 0, to enable or disable
4115 this function respectively.
4120 @section @code{.data @var{subsection}}
4122 @cindex @code{data} directive
4123 @code{.data} tells @command{@value{AS}} to assemble the following statements onto the
4124 end of the data subsection numbered @var{subsection} (which is an
4125 absolute expression). If @var{subsection} is omitted, it defaults
4130 @section @code{.def @var{name}}
4132 @cindex @code{def} directive
4133 @cindex COFF symbols, debugging
4134 @cindex debugging COFF symbols
4135 Begin defining debugging information for a symbol @var{name}; the
4136 definition extends until the @code{.endef} directive is encountered.
4139 This directive is only observed when @command{@value{AS}} is configured for COFF
4140 format output; when producing @code{b.out}, @samp{.def} is recognized,
4147 @section @code{.desc @var{symbol}, @var{abs-expression}}
4149 @cindex @code{desc} directive
4150 @cindex COFF symbol descriptor
4151 @cindex symbol descriptor, COFF
4152 This directive sets the descriptor of the symbol (@pxref{Symbol Attributes})
4153 to the low 16 bits of an absolute expression.
4156 The @samp{.desc} directive is not available when @command{@value{AS}} is
4157 configured for COFF output; it is only for @code{a.out} or @code{b.out}
4158 object format. For the sake of compatibility, @command{@value{AS}} accepts
4159 it, but produces no output, when configured for COFF.
4165 @section @code{.dim}
4167 @cindex @code{dim} directive
4168 @cindex COFF auxiliary symbol information
4169 @cindex auxiliary symbol information, COFF
4170 This directive is generated by compilers to include auxiliary debugging
4171 information in the symbol table. It is only permitted inside
4172 @code{.def}/@code{.endef} pairs.
4175 @samp{.dim} is only meaningful when generating COFF format output; when
4176 @command{@value{AS}} is generating @code{b.out}, it accepts this directive but
4182 @section @code{.double @var{flonums}}
4184 @cindex @code{double} directive
4185 @cindex floating point numbers (double)
4186 @code{.double} expects zero or more flonums, separated by commas. It
4187 assembles floating point numbers.
4189 The exact kind of floating point numbers emitted depends on how
4190 @command{@value{AS}} is configured. @xref{Machine Dependencies}.
4194 On the @value{TARGET} family @samp{.double} emits 64-bit floating-point numbers
4195 in @sc{ieee} format.
4200 @section @code{.eject}
4202 @cindex @code{eject} directive
4203 @cindex new page, in listings
4204 @cindex page, in listings
4205 @cindex listing control: new page
4206 Force a page break at this point, when generating assembly listings.
4209 @section @code{.else}
4211 @cindex @code{else} directive
4212 @code{.else} is part of the @command{@value{AS}} support for conditional
4213 assembly; @pxref{If,,@code{.if}}. It marks the beginning of a section
4214 of code to be assembled if the condition for the preceding @code{.if}
4218 @section @code{.elseif}
4220 @cindex @code{elseif} directive
4221 @code{.elseif} is part of the @command{@value{AS}} support for conditional
4222 assembly; @pxref{If,,@code{.if}}. It is shorthand for beginning a new
4223 @code{.if} block that would otherwise fill the entire @code{.else} section.
4226 @section @code{.end}
4228 @cindex @code{end} directive
4229 @code{.end} marks the end of the assembly file. @command{@value{AS}} does not
4230 process anything in the file past the @code{.end} directive.
4234 @section @code{.endef}
4236 @cindex @code{endef} directive
4237 This directive flags the end of a symbol definition begun with
4241 @samp{.endef} is only meaningful when generating COFF format output; if
4242 @command{@value{AS}} is configured to generate @code{b.out}, it accepts this
4243 directive but ignores it.
4248 @section @code{.endfunc}
4249 @cindex @code{endfunc} directive
4250 @code{.endfunc} marks the end of a function specified with @code{.func}.
4253 @section @code{.endif}
4255 @cindex @code{endif} directive
4256 @code{.endif} is part of the @command{@value{AS}} support for conditional assembly;
4257 it marks the end of a block of code that is only assembled
4258 conditionally. @xref{If,,@code{.if}}.
4261 @section @code{.equ @var{symbol}, @var{expression}}
4263 @cindex @code{equ} directive
4264 @cindex assigning values to symbols
4265 @cindex symbols, assigning values to
4266 This directive sets the value of @var{symbol} to @var{expression}.
4267 It is synonymous with @samp{.set}; @pxref{Set,,@code{.set}}.
4270 The syntax for @code{equ} on the HPPA is
4271 @samp{@var{symbol} .equ @var{expression}}.
4275 @section @code{.equiv @var{symbol}, @var{expression}}
4276 @cindex @code{equiv} directive
4277 The @code{.equiv} directive is like @code{.equ} and @code{.set}, except that
4278 the assembler will signal an error if @var{symbol} is already defined. Note a
4279 symbol which has been referenced but not actually defined is considered to be
4282 Except for the contents of the error message, this is roughly equivalent to
4289 plus it protects the symbol from later redefinition.
4292 @section @code{.eqv @var{symbol}, @var{expression}}
4293 @cindex @code{eqv} directive
4294 The @code{.eqv} directive is like @code{.equiv}, but no attempt is made to
4295 evaluate the expression or any part of it immediately. Instead each time
4296 the resulting symbol is used in an expression, a snapshot of its current
4300 @section @code{.err}
4301 @cindex @code{err} directive
4302 If @command{@value{AS}} assembles a @code{.err} directive, it will print an error
4303 message and, unless the @option{-Z} option was used, it will not generate an
4304 object file. This can be used to signal error an conditionally compiled code.
4307 @section @code{.error "@var{string}"}
4308 @cindex error directive
4310 Similarly to @code{.err}, this directive emits an error, but you can specify a
4311 string that will be emitted as the error message. If you don't specify the
4312 message, it defaults to @code{".error directive invoked in source file"}.
4313 @xref{Errors, ,Error and Warning Messages}.
4316 .error "This code has not been assembled and tested."
4320 @section @code{.exitm}
4321 Exit early from the current macro definition. @xref{Macro}.
4324 @section @code{.extern}
4326 @cindex @code{extern} directive
4327 @code{.extern} is accepted in the source program---for compatibility
4328 with other assemblers---but it is ignored. @command{@value{AS}} treats
4329 all undefined symbols as external.
4332 @section @code{.fail @var{expression}}
4334 @cindex @code{fail} directive
4335 Generates an error or a warning. If the value of the @var{expression} is 500
4336 or more, @command{@value{AS}} will print a warning message. If the value is less
4337 than 500, @command{@value{AS}} will print an error message. The message will
4338 include the value of @var{expression}. This can occasionally be useful inside
4339 complex nested macros or conditional assembly.
4341 @ifclear no-file-dir
4343 @section @code{.file @var{string}}
4345 @cindex @code{file} directive
4346 @cindex logical file name
4347 @cindex file name, logical
4348 @code{.file} tells @command{@value{AS}} that we are about to start a new logical
4349 file. @var{string} is the new file name. In general, the filename is
4350 recognized whether or not it is surrounded by quotes @samp{"}; but if you wish
4351 to specify an empty file name, you must give the quotes--@code{""}. This
4352 statement may go away in future: it is only recognized to be compatible with
4353 old @command{@value{AS}} programs.
4357 @section @code{.fill @var{repeat} , @var{size} , @var{value}}
4359 @cindex @code{fill} directive
4360 @cindex writing patterns in memory
4361 @cindex patterns, writing in memory
4362 @var{repeat}, @var{size} and @var{value} are absolute expressions.
4363 This emits @var{repeat} copies of @var{size} bytes. @var{Repeat}
4364 may be zero or more. @var{Size} may be zero or more, but if it is
4365 more than 8, then it is deemed to have the value 8, compatible with
4366 other people's assemblers. The contents of each @var{repeat} bytes
4367 is taken from an 8-byte number. The highest order 4 bytes are
4368 zero. The lowest order 4 bytes are @var{value} rendered in the
4369 byte-order of an integer on the computer @command{@value{AS}} is assembling for.
4370 Each @var{size} bytes in a repetition is taken from the lowest order
4371 @var{size} bytes of this number. Again, this bizarre behavior is
4372 compatible with other people's assemblers.
4374 @var{size} and @var{value} are optional.
4375 If the second comma and @var{value} are absent, @var{value} is
4376 assumed zero. If the first comma and following tokens are absent,
4377 @var{size} is assumed to be 1.
4380 @section @code{.float @var{flonums}}
4382 @cindex floating point numbers (single)
4383 @cindex @code{float} directive
4384 This directive assembles zero or more flonums, separated by commas. It
4385 has the same effect as @code{.single}.
4387 The exact kind of floating point numbers emitted depends on how
4388 @command{@value{AS}} is configured.
4389 @xref{Machine Dependencies}.
4393 On the @value{TARGET} family, @code{.float} emits 32-bit floating point numbers
4394 in @sc{ieee} format.
4399 @section @code{.func @var{name}[,@var{label}]}
4400 @cindex @code{func} directive
4401 @code{.func} emits debugging information to denote function @var{name}, and
4402 is ignored unless the file is assembled with debugging enabled.
4403 Only @samp{--gstabs[+]} is currently supported.
4404 @var{label} is the entry point of the function and if omitted @var{name}
4405 prepended with the @samp{leading char} is used.
4406 @samp{leading char} is usually @code{_} or nothing, depending on the target.
4407 All functions are currently defined to have @code{void} return type.
4408 The function must be terminated with @code{.endfunc}.
4411 @section @code{.global @var{symbol}}, @code{.globl @var{symbol}}
4413 @cindex @code{global} directive
4414 @cindex symbol, making visible to linker
4415 @code{.global} makes the symbol visible to @code{@value{LD}}. If you define
4416 @var{symbol} in your partial program, its value is made available to
4417 other partial programs that are linked with it. Otherwise,
4418 @var{symbol} takes its attributes from a symbol of the same name
4419 from another file linked into the same program.
4421 Both spellings (@samp{.globl} and @samp{.global}) are accepted, for
4422 compatibility with other assemblers.
4425 On the HPPA, @code{.global} is not always enough to make it accessible to other
4426 partial programs. You may need the HPPA-only @code{.EXPORT} directive as well.
4427 @xref{HPPA Directives,, HPPA Assembler Directives}.
4432 @section @code{.hidden @var{names}}
4434 @cindex @code{hidden} directive
4436 This is one of the ELF visibility directives. The other two are
4437 @code{.internal} (@pxref{Internal,,@code{.internal}}) and
4438 @code{.protected} (@pxref{Protected,,@code{.protected}}).
4440 This directive overrides the named symbols default visibility (which is set by
4441 their binding: local, global or weak). The directive sets the visibility to
4442 @code{hidden} which means that the symbols are not visible to other components.
4443 Such symbols are always considered to be @code{protected} as well.
4447 @section @code{.hword @var{expressions}}
4449 @cindex @code{hword} directive
4450 @cindex integers, 16-bit
4451 @cindex numbers, 16-bit
4452 @cindex sixteen bit integers
4453 This expects zero or more @var{expressions}, and emits
4454 a 16 bit number for each.
4457 This directive is a synonym for @samp{.short}; depending on the target
4458 architecture, it may also be a synonym for @samp{.word}.
4462 This directive is a synonym for @samp{.short}.
4465 This directive is a synonym for both @samp{.short} and @samp{.word}.
4470 @section @code{.ident}
4472 @cindex @code{ident} directive
4473 This directive is used by some assemblers to place tags in object files.
4474 @command{@value{AS}} simply accepts the directive for source-file
4475 compatibility with such assemblers, but does not actually emit anything
4479 @section @code{.if @var{absolute expression}}
4481 @cindex conditional assembly
4482 @cindex @code{if} directive
4483 @code{.if} marks the beginning of a section of code which is only
4484 considered part of the source program being assembled if the argument
4485 (which must be an @var{absolute expression}) is non-zero. The end of
4486 the conditional section of code must be marked by @code{.endif}
4487 (@pxref{Endif,,@code{.endif}}); optionally, you may include code for the
4488 alternative condition, flagged by @code{.else} (@pxref{Else,,@code{.else}}).
4489 If you have several conditions to check, @code{.elseif} may be used to avoid
4490 nesting blocks if/else within each subsequent @code{.else} block.
4492 The following variants of @code{.if} are also supported:
4494 @cindex @code{ifdef} directive
4495 @item .ifdef @var{symbol}
4496 Assembles the following section of code if the specified @var{symbol}
4497 has been defined. Note a symbol which has been referenced but not yet defined
4498 is considered to be undefined.
4500 @cindex @code{ifb} directive
4501 @item .ifb @var{text}
4502 Assembles the following section of code if the operand is blank (empty).
4504 @cindex @code{ifc} directive
4505 @item .ifc @var{string1},@var{string2}
4506 Assembles the following section of code if the two strings are the same. The
4507 strings may be optionally quoted with single quotes. If they are not quoted,
4508 the first string stops at the first comma, and the second string stops at the
4509 end of the line. Strings which contain whitespace should be quoted. The
4510 string comparison is case sensitive.
4512 @cindex @code{ifeq} directive
4513 @item .ifeq @var{absolute expression}
4514 Assembles the following section of code if the argument is zero.
4516 @cindex @code{ifeqs} directive
4517 @item .ifeqs @var{string1},@var{string2}
4518 Another form of @code{.ifc}. The strings must be quoted using double quotes.
4520 @cindex @code{ifge} directive
4521 @item .ifge @var{absolute expression}
4522 Assembles the following section of code if the argument is greater than or
4525 @cindex @code{ifgt} directive
4526 @item .ifgt @var{absolute expression}
4527 Assembles the following section of code if the argument is greater than zero.
4529 @cindex @code{ifle} directive
4530 @item .ifle @var{absolute expression}
4531 Assembles the following section of code if the argument is less than or equal
4534 @cindex @code{iflt} directive
4535 @item .iflt @var{absolute expression}
4536 Assembles the following section of code if the argument is less than zero.
4538 @cindex @code{ifnb} directive
4539 @item .ifnb @var{text}
4540 Like @code{.ifb}, but the sense of the test is reversed: this assembles the
4541 following section of code if the operand is non-blank (non-empty).
4543 @cindex @code{ifnc} directive
4544 @item .ifnc @var{string1},@var{string2}.
4545 Like @code{.ifc}, but the sense of the test is reversed: this assembles the
4546 following section of code if the two strings are not the same.
4548 @cindex @code{ifndef} directive
4549 @cindex @code{ifnotdef} directive
4550 @item .ifndef @var{symbol}
4551 @itemx .ifnotdef @var{symbol}
4552 Assembles the following section of code if the specified @var{symbol}
4553 has not been defined. Both spelling variants are equivalent. Note a symbol
4554 which has been referenced but not yet defined is considered to be undefined.
4556 @cindex @code{ifne} directive
4557 @item .ifne @var{absolute expression}
4558 Assembles the following section of code if the argument is not equal to zero
4559 (in other words, this is equivalent to @code{.if}).
4561 @cindex @code{ifnes} directive
4562 @item .ifnes @var{string1},@var{string2}
4563 Like @code{.ifeqs}, but the sense of the test is reversed: this assembles the
4564 following section of code if the two strings are not the same.
4568 @section @code{.incbin "@var{file}"[,@var{skip}[,@var{count}]]}
4570 @cindex @code{incbin} directive
4571 @cindex binary files, including
4572 The @code{incbin} directive includes @var{file} verbatim at the current
4573 location. You can control the search paths used with the @samp{-I} command-line
4574 option (@pxref{Invoking,,Command-Line Options}). Quotation marks are required
4577 The @var{skip} argument skips a number of bytes from the start of the
4578 @var{file}. The @var{count} argument indicates the maximum number of bytes to
4579 read. Note that the data is not aligned in any way, so it is the user's
4580 responsibility to make sure that proper alignment is provided both before and
4581 after the @code{incbin} directive.
4584 @section @code{.include "@var{file}"}
4586 @cindex @code{include} directive
4587 @cindex supporting files, including
4588 @cindex files, including
4589 This directive provides a way to include supporting files at specified
4590 points in your source program. The code from @var{file} is assembled as
4591 if it followed the point of the @code{.include}; when the end of the
4592 included file is reached, assembly of the original file continues. You
4593 can control the search paths used with the @samp{-I} command-line option
4594 (@pxref{Invoking,,Command-Line Options}). Quotation marks are required
4598 @section @code{.int @var{expressions}}
4600 @cindex @code{int} directive
4601 @cindex integers, 32-bit
4602 Expect zero or more @var{expressions}, of any section, separated by commas.
4603 For each expression, emit a number that, at run time, is the value of that
4604 expression. The byte order and bit size of the number depends on what kind
4605 of target the assembly is for.
4609 On most forms of the H8/300, @code{.int} emits 16-bit
4610 integers. On the H8/300H and the Renesas SH, however, @code{.int} emits
4617 @section @code{.internal @var{names}}
4619 @cindex @code{internal} directive
4621 This is one of the ELF visibility directives. The other two are
4622 @code{.hidden} (@pxref{Hidden,,@code{.hidden}}) and
4623 @code{.protected} (@pxref{Protected,,@code{.protected}}).
4625 This directive overrides the named symbols default visibility (which is set by
4626 their binding: local, global or weak). The directive sets the visibility to
4627 @code{internal} which means that the symbols are considered to be @code{hidden}
4628 (i.e., not visible to other components), and that some extra, processor specific
4629 processing must also be performed upon the symbols as well.
4633 @section @code{.irp @var{symbol},@var{values}}@dots{}
4635 @cindex @code{irp} directive
4636 Evaluate a sequence of statements assigning different values to @var{symbol}.
4637 The sequence of statements starts at the @code{.irp} directive, and is
4638 terminated by an @code{.endr} directive. For each @var{value}, @var{symbol} is
4639 set to @var{value}, and the sequence of statements is assembled. If no
4640 @var{value} is listed, the sequence of statements is assembled once, with
4641 @var{symbol} set to the null string. To refer to @var{symbol} within the
4642 sequence of statements, use @var{\symbol}.
4644 For example, assembling
4652 is equivalent to assembling
4660 For some caveats with the spelling of @var{symbol}, see also the discussion
4664 @section @code{.irpc @var{symbol},@var{values}}@dots{}
4666 @cindex @code{irpc} directive
4667 Evaluate a sequence of statements assigning different values to @var{symbol}.
4668 The sequence of statements starts at the @code{.irpc} directive, and is
4669 terminated by an @code{.endr} directive. For each character in @var{value},
4670 @var{symbol} is set to the character, and the sequence of statements is
4671 assembled. If no @var{value} is listed, the sequence of statements is
4672 assembled once, with @var{symbol} set to the null string. To refer to
4673 @var{symbol} within the sequence of statements, use @var{\symbol}.
4675 For example, assembling
4683 is equivalent to assembling
4691 For some caveats with the spelling of @var{symbol}, see also the discussion
4695 @section @code{.lcomm @var{symbol} , @var{length}}
4697 @cindex @code{lcomm} directive
4698 @cindex local common symbols
4699 @cindex symbols, local common
4700 Reserve @var{length} (an absolute expression) bytes for a local common
4701 denoted by @var{symbol}. The section and value of @var{symbol} are
4702 those of the new local common. The addresses are allocated in the bss
4703 section, so that at run-time the bytes start off zeroed. @var{Symbol}
4704 is not declared global (@pxref{Global,,@code{.global}}), so is normally
4705 not visible to @code{@value{LD}}.
4708 Some targets permit a third argument to be used with @code{.lcomm}. This
4709 argument specifies the desired alignment of the symbol in the bss section.
4713 The syntax for @code{.lcomm} differs slightly on the HPPA. The syntax is
4714 @samp{@var{symbol} .lcomm, @var{length}}; @var{symbol} is optional.
4718 @section @code{.lflags}
4720 @cindex @code{lflags} directive (ignored)
4721 @command{@value{AS}} accepts this directive, for compatibility with other
4722 assemblers, but ignores it.
4724 @ifclear no-line-dir
4726 @section @code{.line @var{line-number}}
4728 @cindex @code{line} directive
4732 @section @code{.ln @var{line-number}}
4734 @cindex @code{ln} directive
4736 @cindex logical line number
4738 Change the logical line number. @var{line-number} must be an absolute
4739 expression. The next line has that logical line number. Therefore any other
4740 statements on the current line (after a statement separator character) are
4741 reported as on logical line number @var{line-number} @minus{} 1. One day
4742 @command{@value{AS}} will no longer support this directive: it is recognized only
4743 for compatibility with existing assembler programs.
4747 @ifclear no-line-dir
4748 Even though this is a directive associated with the @code{a.out} or
4749 @code{b.out} object-code formats, @command{@value{AS}} still recognizes it
4750 when producing COFF output, and treats @samp{.line} as though it
4751 were the COFF @samp{.ln} @emph{if} it is found outside a
4752 @code{.def}/@code{.endef} pair.
4754 Inside a @code{.def}, @samp{.line} is, instead, one of the directives
4755 used by compilers to generate auxiliary symbol information for
4760 @section @code{.linkonce [@var{type}]}
4762 @cindex @code{linkonce} directive
4763 @cindex common sections
4764 Mark the current section so that the linker only includes a single copy of it.
4765 This may be used to include the same section in several different object files,
4766 but ensure that the linker will only include it once in the final output file.
4767 The @code{.linkonce} pseudo-op must be used for each instance of the section.
4768 Duplicate sections are detected based on the section name, so it should be
4771 This directive is only supported by a few object file formats; as of this
4772 writing, the only object file format which supports it is the Portable
4773 Executable format used on Windows NT.
4775 The @var{type} argument is optional. If specified, it must be one of the
4776 following strings. For example:
4780 Not all types may be supported on all object file formats.
4784 Silently discard duplicate sections. This is the default.
4787 Warn if there are duplicate sections, but still keep only one copy.
4790 Warn if any of the duplicates have different sizes.
4793 Warn if any of the duplicates do not have exactly the same contents.
4797 @section @code{.ln @var{line-number}}
4799 @cindex @code{ln} directive
4800 @ifclear no-line-dir
4801 @samp{.ln} is a synonym for @samp{.line}.
4804 Tell @command{@value{AS}} to change the logical line number. @var{line-number}
4805 must be an absolute expression. The next line has that logical
4806 line number, so any other statements on the current line (after a
4807 statement separator character @code{;}) are reported as on logical
4808 line number @var{line-number} @minus{} 1.
4811 This directive is accepted, but ignored, when @command{@value{AS}} is
4812 configured for @code{b.out}; its effect is only associated with COFF
4818 @section @code{.mri @var{val}}
4820 @cindex @code{mri} directive
4821 @cindex MRI mode, temporarily
4822 If @var{val} is non-zero, this tells @command{@value{AS}} to enter MRI mode. If
4823 @var{val} is zero, this tells @command{@value{AS}} to exit MRI mode. This change
4824 affects code assembled until the next @code{.mri} directive, or until the end
4825 of the file. @xref{M, MRI mode, MRI mode}.
4828 @section @code{.list}
4830 @cindex @code{list} directive
4831 @cindex listing control, turning on
4832 Control (in conjunction with the @code{.nolist} directive) whether or
4833 not assembly listings are generated. These two directives maintain an
4834 internal counter (which is zero initially). @code{.list} increments the
4835 counter, and @code{.nolist} decrements it. Assembly listings are
4836 generated whenever the counter is greater than zero.
4838 By default, listings are disabled. When you enable them (with the
4839 @samp{-a} command line option; @pxref{Invoking,,Command-Line Options}),
4840 the initial value of the listing counter is one.
4843 @section @code{.long @var{expressions}}
4845 @cindex @code{long} directive
4846 @code{.long} is the same as @samp{.int}, @pxref{Int,,@code{.int}}.
4849 @c no one seems to know what this is for or whether this description is
4850 @c what it really ought to do
4852 @section @code{.lsym @var{symbol}, @var{expression}}
4854 @cindex @code{lsym} directive
4855 @cindex symbol, not referenced in assembly
4856 @code{.lsym} creates a new symbol named @var{symbol}, but does not put it in
4857 the hash table, ensuring it cannot be referenced by name during the
4858 rest of the assembly. This sets the attributes of the symbol to be
4859 the same as the expression value:
4861 @var{other} = @var{descriptor} = 0
4862 @var{type} = @r{(section of @var{expression})}
4863 @var{value} = @var{expression}
4866 The new symbol is not flagged as external.
4870 @section @code{.macro}
4873 The commands @code{.macro} and @code{.endm} allow you to define macros that
4874 generate assembly output. For example, this definition specifies a macro
4875 @code{sum} that puts a sequence of numbers into memory:
4878 .macro sum from=0, to=5
4887 With that definition, @samp{SUM 0,5} is equivalent to this assembly input:
4899 @item .macro @var{macname}
4900 @itemx .macro @var{macname} @var{macargs} @dots{}
4901 @cindex @code{macro} directive
4902 Begin the definition of a macro called @var{macname}. If your macro
4903 definition requires arguments, specify their names after the macro name,
4904 separated by commas or spaces. You can qualify the macro argument to
4905 indicate whether all invocations must specify a non-blank value (through
4906 @samp{:@code{req}}), or whether it takes all of the remaining arguments
4907 (through @samp{:@code{vararg}}). You can supply a default value for any
4908 macro argument by following the name with @samp{=@var{deflt}}. You
4909 cannot define two macros with the same @var{macname} unless it has been
4910 subject to the @code{.purgem} directive (@xref{Purgem}.) between the two
4911 definitions. For example, these are all valid @code{.macro} statements:
4915 Begin the definition of a macro called @code{comm}, which takes no
4918 @item .macro plus1 p, p1
4919 @itemx .macro plus1 p p1
4920 Either statement begins the definition of a macro called @code{plus1},
4921 which takes two arguments; within the macro definition, write
4922 @samp{\p} or @samp{\p1} to evaluate the arguments.
4924 @item .macro reserve_str p1=0 p2
4925 Begin the definition of a macro called @code{reserve_str}, with two
4926 arguments. The first argument has a default value, but not the second.
4927 After the definition is complete, you can call the macro either as
4928 @samp{reserve_str @var{a},@var{b}} (with @samp{\p1} evaluating to
4929 @var{a} and @samp{\p2} evaluating to @var{b}), or as @samp{reserve_str
4930 ,@var{b}} (with @samp{\p1} evaluating as the default, in this case
4931 @samp{0}, and @samp{\p2} evaluating to @var{b}).
4934 @item .macro m p1:req, p2=0, p3:vararg
4935 Begin the definition of a macro called @code{m}, with at least three
4936 arguments. The first argument must always have a value specified, but
4937 not the second, which instead has a default value. The third formal
4938 will get assigned all remaining arguments specified at invocation time.
4940 When you call a macro, you can specify the argument values either by
4941 position, or by keyword. For example, @samp{sum 9,17} is equivalent to
4942 @samp{sum to=17, from=9}.
4944 Note that since each of the @var{macargs} can be an identifier exactly
4945 as any other one permitted by the target architecture, there may be
4946 occasional problems if the target hand-crafts special meanings to certain
4947 characters when they occur in a special position. For example, if colon
4948 (@code{:}) is generally permitted to be part of a symbol name, but the
4949 architecture specific code special-cases it when occuring as the final
4950 character of a symbol (to denote a label), then the macro parameter
4951 replacement code will have no way of knowing that and consider the whole
4952 construct (including the colon) an identifier, and check only this
4953 identifier for being the subject to parameter substitution. In this
4954 example, besides the potential of just separating identifier and colon
4955 by white space, using alternate macro syntax (@xref{Altmacro}.) and
4956 ampersand (@code{&}) as the character to separate literal text from macro
4957 parameters (or macro parameters from one another) would provide a way to
4958 achieve the same effect:
4967 This applies identically to the identifiers used in @code{.irp} (@xref{Irp}.)
4968 and @code{.irpc} (@xref{Irpc}.).
4971 @cindex @code{endm} directive
4972 Mark the end of a macro definition.
4975 @cindex @code{exitm} directive
4976 Exit early from the current macro definition.
4978 @cindex number of macros executed
4979 @cindex macros, count executed
4981 @command{@value{AS}} maintains a counter of how many macros it has
4982 executed in this pseudo-variable; you can copy that number to your
4983 output with @samp{\@@}, but @emph{only within a macro definition}.
4985 @item LOCAL @var{name} [ , @dots{} ]
4986 @emph{Warning: @code{LOCAL} is only available if you select ``alternate
4987 macro syntax'' with @samp{--alternate} or @code{.altmacro}.}
4988 @xref{Altmacro,,@code{.altmacro}}.
4992 @section @code{.altmacro}
4993 Enable alternate macro mode, enabling:
4996 @item LOCAL @var{name} [ , @dots{} ]
4997 One additional directive, @code{LOCAL}, is available. It is used to
4998 generate a string replacement for each of the @var{name} arguments, and
4999 replace any instances of @var{name} in each macro expansion. The
5000 replacement string is unique in the assembly, and different for each
5001 separate macro expansion. @code{LOCAL} allows you to write macros that
5002 define symbols, without fear of conflict between separate macro expansions.
5004 @item String delimiters
5005 You can write strings delimited in these other ways besides
5006 @code{"@var{string}"}:
5009 @item '@var{string}'
5010 You can delimit strings with single-quote charaters.
5012 @item <@var{string}>
5013 You can delimit strings with matching angle brackets.
5016 @item single-character string escape
5017 To include any single character literally in a string (even if the
5018 character would otherwise have some special meaning), you can prefix the
5019 character with @samp{!} (an exclamation mark). For example, you can
5020 write @samp{<4.3 !> 5.4!!>} to get the literal text @samp{4.3 > 5.4!}.
5022 @item Expression results as strings
5023 You can write @samp{%@var{expr}} to evaluate the expression @var{expr}
5024 and use the result as a string.
5028 @section @code{.noaltmacro}
5029 Disable alternate macro mode. @ref{Altmacro}
5032 @section @code{.nolist}
5034 @cindex @code{nolist} directive
5035 @cindex listing control, turning off
5036 Control (in conjunction with the @code{.list} directive) whether or
5037 not assembly listings are generated. These two directives maintain an
5038 internal counter (which is zero initially). @code{.list} increments the
5039 counter, and @code{.nolist} decrements it. Assembly listings are
5040 generated whenever the counter is greater than zero.
5043 @section @code{.octa @var{bignums}}
5045 @c FIXME: double size emitted for "octa" on i960, others? Or warn?
5046 @cindex @code{octa} directive
5047 @cindex integer, 16-byte
5048 @cindex sixteen byte integer
5049 This directive expects zero or more bignums, separated by commas. For each
5050 bignum, it emits a 16-byte integer.
5052 The term ``octa'' comes from contexts in which a ``word'' is two bytes;
5053 hence @emph{octa}-word for 16 bytes.
5056 @section @code{.org @var{new-lc} , @var{fill}}
5058 @cindex @code{org} directive
5059 @cindex location counter, advancing
5060 @cindex advancing location counter
5061 @cindex current address, advancing
5062 Advance the location counter of the current section to
5063 @var{new-lc}. @var{new-lc} is either an absolute expression or an
5064 expression with the same section as the current subsection. That is,
5065 you can't use @code{.org} to cross sections: if @var{new-lc} has the
5066 wrong section, the @code{.org} directive is ignored. To be compatible
5067 with former assemblers, if the section of @var{new-lc} is absolute,
5068 @command{@value{AS}} issues a warning, then pretends the section of @var{new-lc}
5069 is the same as the current subsection.
5071 @code{.org} may only increase the location counter, or leave it
5072 unchanged; you cannot use @code{.org} to move the location counter
5075 @c double negative used below "not undefined" because this is a specific
5076 @c reference to "undefined" (as SEG_UNKNOWN is called in this manual)
5077 @c section. doc@cygnus.com 18feb91
5078 Because @command{@value{AS}} tries to assemble programs in one pass, @var{new-lc}
5079 may not be undefined. If you really detest this restriction we eagerly await
5080 a chance to share your improved assembler.
5082 Beware that the origin is relative to the start of the section, not
5083 to the start of the subsection. This is compatible with other
5084 people's assemblers.
5086 When the location counter (of the current subsection) is advanced, the
5087 intervening bytes are filled with @var{fill} which should be an
5088 absolute expression. If the comma and @var{fill} are omitted,
5089 @var{fill} defaults to zero.
5092 @section @code{.p2align[wl] @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
5094 @cindex padding the location counter given a power of two
5095 @cindex @code{p2align} directive
5096 Pad the location counter (in the current subsection) to a particular
5097 storage boundary. The first expression (which must be absolute) is the
5098 number of low-order zero bits the location counter must have after
5099 advancement. For example @samp{.p2align 3} advances the location
5100 counter until it a multiple of 8. If the location counter is already a
5101 multiple of 8, no change is needed.
5103 The second expression (also absolute) gives the fill value to be stored in the
5104 padding bytes. It (and the comma) may be omitted. If it is omitted, the
5105 padding bytes are normally zero. However, on some systems, if the section is
5106 marked as containing code and the fill value is omitted, the space is filled
5107 with no-op instructions.
5109 The third expression is also absolute, and is also optional. If it is present,
5110 it is the maximum number of bytes that should be skipped by this alignment
5111 directive. If doing the alignment would require skipping more bytes than the
5112 specified maximum, then the alignment is not done at all. You can omit the
5113 fill value (the second argument) entirely by simply using two commas after the
5114 required alignment; this can be useful if you want the alignment to be filled
5115 with no-op instructions when appropriate.
5117 @cindex @code{p2alignw} directive
5118 @cindex @code{p2alignl} directive
5119 The @code{.p2alignw} and @code{.p2alignl} directives are variants of the
5120 @code{.p2align} directive. The @code{.p2alignw} directive treats the fill
5121 pattern as a two byte word value. The @code{.p2alignl} directives treats the
5122 fill pattern as a four byte longword value. For example, @code{.p2alignw
5123 2,0x368d} will align to a multiple of 4. If it skips two bytes, they will be
5124 filled in with the value 0x368d (the exact placement of the bytes depends upon
5125 the endianness of the processor). If it skips 1 or 3 bytes, the fill value is
5130 @section @code{.previous}
5132 @cindex @code{previous} directive
5133 @cindex Section Stack
5134 This is one of the ELF section stack manipulation directives. The others are
5135 @code{.section} (@pxref{Section}), @code{.subsection} (@pxref{SubSection}),
5136 @code{.pushsection} (@pxref{PushSection}), and @code{.popsection}
5137 (@pxref{PopSection}).
5139 This directive swaps the current section (and subsection) with most recently
5140 referenced section (and subsection) prior to this one. Multiple
5141 @code{.previous} directives in a row will flip between two sections (and their
5144 In terms of the section stack, this directive swaps the current section with
5145 the top section on the section stack.
5150 @section @code{.popsection}
5152 @cindex @code{popsection} directive
5153 @cindex Section Stack
5154 This is one of the ELF section stack manipulation directives. The others are
5155 @code{.section} (@pxref{Section}), @code{.subsection} (@pxref{SubSection}),
5156 @code{.pushsection} (@pxref{PushSection}), and @code{.previous}
5159 This directive replaces the current section (and subsection) with the top
5160 section (and subsection) on the section stack. This section is popped off the
5165 @section @code{.print @var{string}}
5167 @cindex @code{print} directive
5168 @command{@value{AS}} will print @var{string} on the standard output during
5169 assembly. You must put @var{string} in double quotes.
5173 @section @code{.protected @var{names}}
5175 @cindex @code{protected} directive
5177 This is one of the ELF visibility directives. The other two are
5178 @code{.hidden} (@pxref{Hidden}) and @code{.internal} (@pxref{Internal}).
5180 This directive overrides the named symbols default visibility (which is set by
5181 their binding: local, global or weak). The directive sets the visibility to
5182 @code{protected} which means that any references to the symbols from within the
5183 components that defines them must be resolved to the definition in that
5184 component, even if a definition in another component would normally preempt
5189 @section @code{.psize @var{lines} , @var{columns}}
5191 @cindex @code{psize} directive
5192 @cindex listing control: paper size
5193 @cindex paper size, for listings
5194 Use this directive to declare the number of lines---and, optionally, the
5195 number of columns---to use for each page, when generating listings.
5197 If you do not use @code{.psize}, listings use a default line-count
5198 of 60. You may omit the comma and @var{columns} specification; the
5199 default width is 200 columns.
5201 @command{@value{AS}} generates formfeeds whenever the specified number of
5202 lines is exceeded (or whenever you explicitly request one, using
5205 If you specify @var{lines} as @code{0}, no formfeeds are generated save
5206 those explicitly specified with @code{.eject}.
5209 @section @code{.purgem @var{name}}
5211 @cindex @code{purgem} directive
5212 Undefine the macro @var{name}, so that later uses of the string will not be
5213 expanded. @xref{Macro}.
5217 @section @code{.pushsection @var{name} , @var{subsection}}
5219 @cindex @code{pushsection} directive
5220 @cindex Section Stack
5221 This is one of the ELF section stack manipulation directives. The others are
5222 @code{.section} (@pxref{Section}), @code{.subsection} (@pxref{SubSection}),
5223 @code{.popsection} (@pxref{PopSection}), and @code{.previous}
5226 This directive pushes the current section (and subsection) onto the
5227 top of the section stack, and then replaces the current section and
5228 subsection with @code{name} and @code{subsection}.
5232 @section @code{.quad @var{bignums}}
5234 @cindex @code{quad} directive
5235 @code{.quad} expects zero or more bignums, separated by commas. For
5236 each bignum, it emits
5238 an 8-byte integer. If the bignum won't fit in 8 bytes, it prints a
5239 warning message; and just takes the lowest order 8 bytes of the bignum.
5240 @cindex eight-byte integer
5241 @cindex integer, 8-byte
5243 The term ``quad'' comes from contexts in which a ``word'' is two bytes;
5244 hence @emph{quad}-word for 8 bytes.
5247 a 16-byte integer. If the bignum won't fit in 16 bytes, it prints a
5248 warning message; and just takes the lowest order 16 bytes of the bignum.
5249 @cindex sixteen-byte integer
5250 @cindex integer, 16-byte
5254 @section @code{.rept @var{count}}
5256 @cindex @code{rept} directive
5257 Repeat the sequence of lines between the @code{.rept} directive and the next
5258 @code{.endr} directive @var{count} times.
5260 For example, assembling
5268 is equivalent to assembling
5277 @section @code{.sbttl "@var{subheading}"}
5279 @cindex @code{sbttl} directive
5280 @cindex subtitles for listings
5281 @cindex listing control: subtitle
5282 Use @var{subheading} as the title (third line, immediately after the
5283 title line) when generating assembly listings.
5285 This directive affects subsequent pages, as well as the current page if
5286 it appears within ten lines of the top of a page.
5290 @section @code{.scl @var{class}}
5292 @cindex @code{scl} directive
5293 @cindex symbol storage class (COFF)
5294 @cindex COFF symbol storage class
5295 Set the storage-class value for a symbol. This directive may only be
5296 used inside a @code{.def}/@code{.endef} pair. Storage class may flag
5297 whether a symbol is static or external, or it may record further
5298 symbolic debugging information.
5301 The @samp{.scl} directive is primarily associated with COFF output; when
5302 configured to generate @code{b.out} output format, @command{@value{AS}}
5303 accepts this directive but ignores it.
5309 @section @code{.section @var{name}}
5311 @cindex named section
5312 Use the @code{.section} directive to assemble the following code into a section
5315 This directive is only supported for targets that actually support arbitrarily
5316 named sections; on @code{a.out} targets, for example, it is not accepted, even
5317 with a standard @code{a.out} section name.
5321 @c only print the extra heading if both COFF and ELF are set
5322 @subheading COFF Version
5325 @cindex @code{section} directive (COFF version)
5326 For COFF targets, the @code{.section} directive is used in one of the following
5330 .section @var{name}[, "@var{flags}"]
5331 .section @var{name}[, @var{subsegment}]
5334 If the optional argument is quoted, it is taken as flags to use for the
5335 section. Each flag is a single character. The following flags are recognized:
5338 bss section (uninitialized data)
5340 section is not loaded
5350 shared section (meaningful for PE targets)
5352 ignored. (For compatibility with the ELF version)
5355 If no flags are specified, the default flags depend upon the section name. If
5356 the section name is not recognized, the default will be for the section to be
5357 loaded and writable. Note the @code{n} and @code{w} flags remove attributes
5358 from the section, rather than adding them, so if they are used on their own it
5359 will be as if no flags had been specified at all.
5361 If the optional argument to the @code{.section} directive is not quoted, it is
5362 taken as a subsegment number (@pxref{Sub-Sections}).
5367 @c only print the extra heading if both COFF and ELF are set
5368 @subheading ELF Version
5371 @cindex Section Stack
5372 This is one of the ELF section stack manipulation directives. The others are
5373 @code{.subsection} (@pxref{SubSection}), @code{.pushsection}
5374 (@pxref{PushSection}), @code{.popsection} (@pxref{PopSection}), and
5375 @code{.previous} (@pxref{Previous}).
5377 @cindex @code{section} directive (ELF version)
5378 For ELF targets, the @code{.section} directive is used like this:
5381 .section @var{name} [, "@var{flags}"[, @@@var{type}[,@var{flag_specific_arguments}]]
5384 The optional @var{flags} argument is a quoted string which may contain any
5385 combination of the following characters:
5388 section is allocatable
5392 section is executable
5394 section is mergeable
5396 section contains zero terminated strings
5398 section is a member of a section group
5400 section is used for thread-local-storage
5403 The optional @var{type} argument may contain one of the following constants:
5406 section contains data
5408 section does not contain data (i.e., section only occupies space)
5410 section contains data which is used by things other than the program
5412 section contains an array of pointers to init functions
5414 section contains an array of pointers to finish functions
5415 @item @@preinit_array
5416 section contains an array of pointers to pre-init functions
5419 Many targets only support the first three section types.
5421 Note on targets where the @code{@@} character is the start of a comment (eg
5422 ARM) then another character is used instead. For example the ARM port uses the
5425 If @var{flags} contains the @code{M} symbol then the @var{type} argument must
5426 be specified as well as an extra argument - @var{entsize} - like this:
5429 .section @var{name} , "@var{flags}"M, @@@var{type}, @var{entsize}
5432 Sections with the @code{M} flag but not @code{S} flag must contain fixed size
5433 constants, each @var{entsize} octets long. Sections with both @code{M} and
5434 @code{S} must contain zero terminated strings where each character is
5435 @var{entsize} bytes long. The linker may remove duplicates within sections with
5436 the same name, same entity size and same flags. @var{entsize} must be an
5437 absolute expression.
5439 If @var{flags} contains the @code{G} symbol then the @var{type} argument must
5440 be present along with an additional field like this:
5443 .section @var{name} , "@var{flags}"G, @@@var{type}, @var{GroupName}[, @var{linkage}]
5446 The @var{GroupName} field specifies the name of the section group to which this
5447 particular section belongs. The optional linkage field can contain:
5450 indicates that only one copy of this section should be retained
5455 Note - if both the @var{M} and @var{G} flags are present then the fields for
5456 the Merge flag should come first, like this:
5459 .section @var{name} , "@var{flags}"MG, @@@var{type}, @var{entsize}, @var{GroupName}[, @var{linkage}]
5462 If no flags are specified, the default flags depend upon the section name. If
5463 the section name is not recognized, the default will be for the section to have
5464 none of the above flags: it will not be allocated in memory, nor writable, nor
5465 executable. The section will contain data.
5467 For ELF targets, the assembler supports another type of @code{.section}
5468 directive for compatibility with the Solaris assembler:
5471 .section "@var{name}"[, @var{flags}...]
5474 Note that the section name is quoted. There may be a sequence of comma
5478 section is allocatable
5482 section is executable
5484 section is used for thread local storage
5487 This directive replaces the current section and subsection. See the
5488 contents of the gas testsuite directory @code{gas/testsuite/gas/elf} for
5489 some examples of how this directive and the other section stack directives
5495 @section @code{.set @var{symbol}, @var{expression}}
5497 @cindex @code{set} directive
5498 @cindex symbol value, setting
5499 Set the value of @var{symbol} to @var{expression}. This
5500 changes @var{symbol}'s value and type to conform to
5501 @var{expression}. If @var{symbol} was flagged as external, it remains
5502 flagged (@pxref{Symbol Attributes}).
5504 You may @code{.set} a symbol many times in the same assembly.
5506 If you @code{.set} a global symbol, the value stored in the object
5507 file is the last value stored into it.
5510 The syntax for @code{set} on the HPPA is
5511 @samp{@var{symbol} .set @var{expression}}.
5515 @section @code{.short @var{expressions}}
5517 @cindex @code{short} directive
5519 @code{.short} is normally the same as @samp{.word}.
5520 @xref{Word,,@code{.word}}.
5522 In some configurations, however, @code{.short} and @code{.word} generate
5523 numbers of different lengths; @pxref{Machine Dependencies}.
5527 @code{.short} is the same as @samp{.word}. @xref{Word,,@code{.word}}.
5530 This expects zero or more @var{expressions}, and emits
5531 a 16 bit number for each.
5536 @section @code{.single @var{flonums}}
5538 @cindex @code{single} directive
5539 @cindex floating point numbers (single)
5540 This directive assembles zero or more flonums, separated by commas. It
5541 has the same effect as @code{.float}.
5543 The exact kind of floating point numbers emitted depends on how
5544 @command{@value{AS}} is configured. @xref{Machine Dependencies}.
5548 On the @value{TARGET} family, @code{.single} emits 32-bit floating point
5549 numbers in @sc{ieee} format.
5555 @section @code{.size}
5557 This directive is used to set the size associated with a symbol.
5561 @c only print the extra heading if both COFF and ELF are set
5562 @subheading COFF Version
5565 @cindex @code{size} directive (COFF version)
5566 For COFF targets, the @code{.size} directive is only permitted inside
5567 @code{.def}/@code{.endef} pairs. It is used like this:
5570 .size @var{expression}
5574 @samp{.size} is only meaningful when generating COFF format output; when
5575 @command{@value{AS}} is generating @code{b.out}, it accepts this directive but
5582 @c only print the extra heading if both COFF and ELF are set
5583 @subheading ELF Version
5586 @cindex @code{size} directive (ELF version)
5587 For ELF targets, the @code{.size} directive is used like this:
5590 .size @var{name} , @var{expression}
5593 This directive sets the size associated with a symbol @var{name}.
5594 The size in bytes is computed from @var{expression} which can make use of label
5595 arithmetic. This directive is typically used to set the size of function
5601 @section @code{.sleb128 @var{expressions}}
5603 @cindex @code{sleb128} directive
5604 @var{sleb128} stands for ``signed little endian base 128.'' This is a
5605 compact, variable length representation of numbers used by the DWARF
5606 symbolic debugging format. @xref{Uleb128,@code{.uleb128}}.
5608 @ifclear no-space-dir
5610 @section @code{.skip @var{size} , @var{fill}}
5612 @cindex @code{skip} directive
5613 @cindex filling memory
5614 This directive emits @var{size} bytes, each of value @var{fill}. Both
5615 @var{size} and @var{fill} are absolute expressions. If the comma and
5616 @var{fill} are omitted, @var{fill} is assumed to be zero. This is the same as
5620 @section @code{.space @var{size} , @var{fill}}
5622 @cindex @code{space} directive
5623 @cindex filling memory
5624 This directive emits @var{size} bytes, each of value @var{fill}. Both
5625 @var{size} and @var{fill} are absolute expressions. If the comma
5626 and @var{fill} are omitted, @var{fill} is assumed to be zero. This is the same
5631 @emph{Warning:} @code{.space} has a completely different meaning for HPPA
5632 targets; use @code{.block} as a substitute. See @cite{HP9000 Series 800
5633 Assembly Language Reference Manual} (HP 92432-90001) for the meaning of the
5634 @code{.space} directive. @xref{HPPA Directives,,HPPA Assembler Directives},
5642 @section @code{.stabd, .stabn, .stabs}
5644 @cindex symbolic debuggers, information for
5645 @cindex @code{stab@var{x}} directives
5646 There are three directives that begin @samp{.stab}.
5647 All emit symbols (@pxref{Symbols}), for use by symbolic debuggers.
5648 The symbols are not entered in the @command{@value{AS}} hash table: they
5649 cannot be referenced elsewhere in the source file.
5650 Up to five fields are required:
5654 This is the symbol's name. It may contain any character except
5655 @samp{\000}, so is more general than ordinary symbol names. Some
5656 debuggers used to code arbitrarily complex structures into symbol names
5660 An absolute expression. The symbol's type is set to the low 8 bits of
5661 this expression. Any bit pattern is permitted, but @code{@value{LD}}
5662 and debuggers choke on silly bit patterns.
5665 An absolute expression. The symbol's ``other'' attribute is set to the
5666 low 8 bits of this expression.
5669 An absolute expression. The symbol's descriptor is set to the low 16
5670 bits of this expression.
5673 An absolute expression which becomes the symbol's value.
5676 If a warning is detected while reading a @code{.stabd}, @code{.stabn},
5677 or @code{.stabs} statement, the symbol has probably already been created;
5678 you get a half-formed symbol in your object file. This is
5679 compatible with earlier assemblers!
5682 @cindex @code{stabd} directive
5683 @item .stabd @var{type} , @var{other} , @var{desc}
5685 The ``name'' of the symbol generated is not even an empty string.
5686 It is a null pointer, for compatibility. Older assemblers used a
5687 null pointer so they didn't waste space in object files with empty
5690 The symbol's value is set to the location counter,
5691 relocatably. When your program is linked, the value of this symbol
5692 is the address of the location counter when the @code{.stabd} was
5695 @cindex @code{stabn} directive
5696 @item .stabn @var{type} , @var{other} , @var{desc} , @var{value}
5697 The name of the symbol is set to the empty string @code{""}.
5699 @cindex @code{stabs} directive
5700 @item .stabs @var{string} , @var{type} , @var{other} , @var{desc} , @var{value}
5701 All five fields are specified.
5707 @section @code{.string} "@var{str}"
5709 @cindex string, copying to object file
5710 @cindex @code{string} directive
5712 Copy the characters in @var{str} to the object file. You may specify more than
5713 one string to copy, separated by commas. Unless otherwise specified for a
5714 particular machine, the assembler marks the end of each string with a 0 byte.
5715 You can use any of the escape sequences described in @ref{Strings,,Strings}.
5718 @section @code{.struct @var{expression}}
5720 @cindex @code{struct} directive
5721 Switch to the absolute section, and set the section offset to @var{expression},
5722 which must be an absolute expression. You might use this as follows:
5731 This would define the symbol @code{field1} to have the value 0, the symbol
5732 @code{field2} to have the value 4, and the symbol @code{field3} to have the
5733 value 8. Assembly would be left in the absolute section, and you would need to
5734 use a @code{.section} directive of some sort to change to some other section
5735 before further assembly.
5739 @section @code{.subsection @var{name}}
5741 @cindex @code{subsection} directive
5742 @cindex Section Stack
5743 This is one of the ELF section stack manipulation directives. The others are
5744 @code{.section} (@pxref{Section}), @code{.pushsection} (@pxref{PushSection}),
5745 @code{.popsection} (@pxref{PopSection}), and @code{.previous}
5748 This directive replaces the current subsection with @code{name}. The current
5749 section is not changed. The replaced subsection is put onto the section stack
5750 in place of the then current top of stack subsection.
5755 @section @code{.symver}
5756 @cindex @code{symver} directive
5757 @cindex symbol versioning
5758 @cindex versions of symbols
5759 Use the @code{.symver} directive to bind symbols to specific version nodes
5760 within a source file. This is only supported on ELF platforms, and is
5761 typically used when assembling files to be linked into a shared library.
5762 There are cases where it may make sense to use this in objects to be bound
5763 into an application itself so as to override a versioned symbol from a
5766 For ELF targets, the @code{.symver} directive can be used like this:
5768 .symver @var{name}, @var{name2@@nodename}
5770 If the symbol @var{name} is defined within the file
5771 being assembled, the @code{.symver} directive effectively creates a symbol
5772 alias with the name @var{name2@@nodename}, and in fact the main reason that we
5773 just don't try and create a regular alias is that the @var{@@} character isn't
5774 permitted in symbol names. The @var{name2} part of the name is the actual name
5775 of the symbol by which it will be externally referenced. The name @var{name}
5776 itself is merely a name of convenience that is used so that it is possible to
5777 have definitions for multiple versions of a function within a single source
5778 file, and so that the compiler can unambiguously know which version of a
5779 function is being mentioned. The @var{nodename} portion of the alias should be
5780 the name of a node specified in the version script supplied to the linker when
5781 building a shared library. If you are attempting to override a versioned
5782 symbol from a shared library, then @var{nodename} should correspond to the
5783 nodename of the symbol you are trying to override.
5785 If the symbol @var{name} is not defined within the file being assembled, all
5786 references to @var{name} will be changed to @var{name2@@nodename}. If no
5787 reference to @var{name} is made, @var{name2@@nodename} will be removed from the
5790 Another usage of the @code{.symver} directive is:
5792 .symver @var{name}, @var{name2@@@@nodename}
5794 In this case, the symbol @var{name} must exist and be defined within
5795 the file being assembled. It is similar to @var{name2@@nodename}. The
5796 difference is @var{name2@@@@nodename} will also be used to resolve
5797 references to @var{name2} by the linker.
5799 The third usage of the @code{.symver} directive is:
5801 .symver @var{name}, @var{name2@@@@@@nodename}
5803 When @var{name} is not defined within the
5804 file being assembled, it is treated as @var{name2@@nodename}. When
5805 @var{name} is defined within the file being assembled, the symbol
5806 name, @var{name}, will be changed to @var{name2@@@@nodename}.
5811 @section @code{.tag @var{structname}}
5813 @cindex COFF structure debugging
5814 @cindex structure debugging, COFF
5815 @cindex @code{tag} directive
5816 This directive is generated by compilers to include auxiliary debugging
5817 information in the symbol table. It is only permitted inside
5818 @code{.def}/@code{.endef} pairs. Tags are used to link structure
5819 definitions in the symbol table with instances of those structures.
5822 @samp{.tag} is only used when generating COFF format output; when
5823 @command{@value{AS}} is generating @code{b.out}, it accepts this directive but
5829 @section @code{.text @var{subsection}}
5831 @cindex @code{text} directive
5832 Tells @command{@value{AS}} to assemble the following statements onto the end of
5833 the text subsection numbered @var{subsection}, which is an absolute
5834 expression. If @var{subsection} is omitted, subsection number zero
5838 @section @code{.title "@var{heading}"}
5840 @cindex @code{title} directive
5841 @cindex listing control: title line
5842 Use @var{heading} as the title (second line, immediately after the
5843 source file name and pagenumber) when generating assembly listings.
5845 This directive affects subsequent pages, as well as the current page if
5846 it appears within ten lines of the top of a page.
5850 @section @code{.type}
5852 This directive is used to set the type of a symbol.
5856 @c only print the extra heading if both COFF and ELF are set
5857 @subheading COFF Version
5860 @cindex COFF symbol type
5861 @cindex symbol type, COFF
5862 @cindex @code{type} directive (COFF version)
5863 For COFF targets, this directive is permitted only within
5864 @code{.def}/@code{.endef} pairs. It is used like this:
5870 This records the integer @var{int} as the type attribute of a symbol table
5874 @samp{.type} is associated only with COFF format output; when
5875 @command{@value{AS}} is configured for @code{b.out} output, it accepts this
5876 directive but ignores it.
5882 @c only print the extra heading if both COFF and ELF are set
5883 @subheading ELF Version
5886 @cindex ELF symbol type
5887 @cindex symbol type, ELF
5888 @cindex @code{type} directive (ELF version)
5889 For ELF targets, the @code{.type} directive is used like this:
5892 .type @var{name} , @var{type description}
5895 This sets the type of symbol @var{name} to be either a
5896 function symbol or an object symbol. There are five different syntaxes
5897 supported for the @var{type description} field, in order to provide
5898 compatibility with various other assemblers. The syntaxes supported are:
5901 .type <name>,#function
5902 .type <name>,#object
5904 .type <name>,@@function
5905 .type <name>,@@object
5907 .type <name>,%function
5908 .type <name>,%object
5910 .type <name>,"function"
5911 .type <name>,"object"
5913 .type <name> STT_FUNCTION
5914 .type <name> STT_OBJECT
5920 @section @code{.uleb128 @var{expressions}}
5922 @cindex @code{uleb128} directive
5923 @var{uleb128} stands for ``unsigned little endian base 128.'' This is a
5924 compact, variable length representation of numbers used by the DWARF
5925 symbolic debugging format. @xref{Sleb128,@code{.sleb128}}.
5929 @section @code{.val @var{addr}}
5931 @cindex @code{val} directive
5932 @cindex COFF value attribute
5933 @cindex value attribute, COFF
5934 This directive, permitted only within @code{.def}/@code{.endef} pairs,
5935 records the address @var{addr} as the value attribute of a symbol table
5939 @samp{.val} is used only for COFF output; when @command{@value{AS}} is
5940 configured for @code{b.out}, it accepts this directive but ignores it.
5946 @section @code{.version "@var{string}"}
5948 @cindex @code{version} directive
5949 This directive creates a @code{.note} section and places into it an ELF
5950 formatted note of type NT_VERSION. The note's name is set to @code{string}.
5955 @section @code{.vtable_entry @var{table}, @var{offset}}
5957 @cindex @code{vtable_entry} directive
5958 This directive finds or creates a symbol @code{table} and creates a
5959 @code{VTABLE_ENTRY} relocation for it with an addend of @code{offset}.
5962 @section @code{.vtable_inherit @var{child}, @var{parent}}
5964 @cindex @code{vtable_inherit} directive
5965 This directive finds the symbol @code{child} and finds or creates the symbol
5966 @code{parent} and then creates a @code{VTABLE_INHERIT} relocation for the
5967 parent whose addend is the value of the child symbol. As a special case the
5968 parent name of @code{0} is treated as refering the @code{*ABS*} section.
5972 @section @code{.warning "@var{string}"}
5973 @cindex warning directive
5974 Similar to the directive @code{.error}
5975 (@pxref{Error,,@code{.error "@var{string}"}}), but just emits a warning.
5978 @section @code{.weak @var{names}}
5980 @cindex @code{weak} directive
5981 This directive sets the weak attribute on the comma separated list of symbol
5982 @code{names}. If the symbols do not already exist, they will be created.
5984 On COFF targets other than PE, weak symbols are a GNU extension. This
5985 directive sets the weak attribute on the comma separated list of symbol
5986 @code{names}. If the symbols do not already exist, they will be created.
5988 On the PE target, weak symbols are supported natively as weak aliases.
5989 When a weak symbol is created that is not an alias, GAS creates an
5990 alternate symbol to hold the default value.
5993 @section @code{.word @var{expressions}}
5995 @cindex @code{word} directive
5996 This directive expects zero or more @var{expressions}, of any section,
5997 separated by commas.
6000 For each expression, @command{@value{AS}} emits a 32-bit number.
6003 For each expression, @command{@value{AS}} emits a 16-bit number.
6008 The size of the number emitted, and its byte order,
6009 depend on what target computer the assembly is for.
6012 @c on amd29k, i960, sparc the "special treatment to support compilers" doesn't
6013 @c happen---32-bit addressability, period; no long/short jumps.
6014 @ifset DIFF-TBL-KLUGE
6015 @cindex difference tables altered
6016 @cindex altered difference tables
6018 @emph{Warning: Special Treatment to support Compilers}
6022 Machines with a 32-bit address space, but that do less than 32-bit
6023 addressing, require the following special treatment. If the machine of
6024 interest to you does 32-bit addressing (or doesn't require it;
6025 @pxref{Machine Dependencies}), you can ignore this issue.
6028 In order to assemble compiler output into something that works,
6029 @command{@value{AS}} occasionally does strange things to @samp{.word} directives.
6030 Directives of the form @samp{.word sym1-sym2} are often emitted by
6031 compilers as part of jump tables. Therefore, when @command{@value{AS}} assembles a
6032 directive of the form @samp{.word sym1-sym2}, and the difference between
6033 @code{sym1} and @code{sym2} does not fit in 16 bits, @command{@value{AS}}
6034 creates a @dfn{secondary jump table}, immediately before the next label.
6035 This secondary jump table is preceded by a short-jump to the
6036 first byte after the secondary table. This short-jump prevents the flow
6037 of control from accidentally falling into the new table. Inside the
6038 table is a long-jump to @code{sym2}. The original @samp{.word}
6039 contains @code{sym1} minus the address of the long-jump to
6042 If there were several occurrences of @samp{.word sym1-sym2} before the
6043 secondary jump table, all of them are adjusted. If there was a
6044 @samp{.word sym3-sym4}, that also did not fit in sixteen bits, a
6045 long-jump to @code{sym4} is included in the secondary jump table,
6046 and the @code{.word} directives are adjusted to contain @code{sym3}
6047 minus the address of the long-jump to @code{sym4}; and so on, for as many
6048 entries in the original jump table as necessary.
6051 @emph{This feature may be disabled by compiling @command{@value{AS}} with the
6052 @samp{-DWORKING_DOT_WORD} option.} This feature is likely to confuse
6053 assembly language programmers.
6056 @c end DIFF-TBL-KLUGE
6059 @section Deprecated Directives
6061 @cindex deprecated directives
6062 @cindex obsolescent directives
6063 One day these directives won't work.
6064 They are included for compatibility with older assemblers.
6071 @node Machine Dependencies
6072 @chapter Machine Dependent Features
6074 @cindex machine dependencies
6075 The machine instruction sets are (almost by definition) different on
6076 each machine where @command{@value{AS}} runs. Floating point representations
6077 vary as well, and @command{@value{AS}} often supports a few additional
6078 directives or command-line options for compatibility with other
6079 assemblers on a particular platform. Finally, some versions of
6080 @command{@value{AS}} support special pseudo-instructions for branch
6083 This chapter discusses most of these differences, though it does not
6084 include details on any machine's instruction set. For details on that
6085 subject, see the hardware manufacturer's manual.
6089 * Alpha-Dependent:: Alpha Dependent Features
6092 * ARC-Dependent:: ARC Dependent Features
6095 * ARM-Dependent:: ARM Dependent Features
6098 * BFIN-Dependent:: BFIN Dependent Features
6101 * CRIS-Dependent:: CRIS Dependent Features
6104 * D10V-Dependent:: D10V Dependent Features
6107 * D30V-Dependent:: D30V Dependent Features
6110 * H8/300-Dependent:: Renesas H8/300 Dependent Features
6113 * HPPA-Dependent:: HPPA Dependent Features
6116 * ESA/390-Dependent:: IBM ESA/390 Dependent Features
6119 * i386-Dependent:: Intel 80386 and AMD x86-64 Dependent Features
6122 * i860-Dependent:: Intel 80860 Dependent Features
6125 * i960-Dependent:: Intel 80960 Dependent Features
6128 * IA-64-Dependent:: Intel IA-64 Dependent Features
6131 * IP2K-Dependent:: IP2K Dependent Features
6134 * M32C-Dependent:: M32C Dependent Features
6137 * M32R-Dependent:: M32R Dependent Features
6140 * M68K-Dependent:: M680x0 Dependent Features
6143 * M68HC11-Dependent:: M68HC11 and 68HC12 Dependent Features
6146 * MIPS-Dependent:: MIPS Dependent Features
6149 * MMIX-Dependent:: MMIX Dependent Features
6152 * MSP430-Dependent:: MSP430 Dependent Features
6155 * SH-Dependent:: Renesas / SuperH SH Dependent Features
6156 * SH64-Dependent:: SuperH SH64 Dependent Features
6159 * PDP-11-Dependent:: PDP-11 Dependent Features
6162 * PJ-Dependent:: picoJava Dependent Features
6165 * PPC-Dependent:: PowerPC Dependent Features
6168 * Sparc-Dependent:: SPARC Dependent Features
6171 * TIC54X-Dependent:: TI TMS320C54x Dependent Features
6174 * V850-Dependent:: V850 Dependent Features
6177 * Xtensa-Dependent:: Xtensa Dependent Features
6180 * Z8000-Dependent:: Z8000 Dependent Features
6183 * Vax-Dependent:: VAX Dependent Features
6190 @c The following major nodes are *sections* in the GENERIC version, *chapters*
6191 @c in single-cpu versions. This is mainly achieved by @lowersections. There is a
6192 @c peculiarity: to preserve cross-references, there must be a node called
6193 @c "Machine Dependencies". Hence the conditional nodenames in each
6194 @c major node below. Node defaulting in makeinfo requires adjacency of
6195 @c node and sectioning commands; hence the repetition of @chapter BLAH
6196 @c in both conditional blocks.
6199 @include c-alpha.texi
6211 @include c-bfin.texi
6215 @include c-cris.texi
6220 @node Machine Dependencies
6221 @chapter Machine Dependent Features
6223 The machine instruction sets are different on each Renesas chip family,
6224 and there are also some syntax differences among the families. This
6225 chapter describes the specific @command{@value{AS}} features for each
6229 * H8/300-Dependent:: Renesas H8/300 Dependent Features
6230 * SH-Dependent:: Renesas SH Dependent Features
6237 @include c-d10v.texi
6241 @include c-d30v.texi
6245 @include c-h8300.texi
6249 @include c-hppa.texi
6253 @include c-i370.texi
6257 @include c-i386.texi
6261 @include c-i860.texi
6265 @include c-i960.texi
6269 @include c-ia64.texi
6273 @include c-ip2k.texi
6277 @include c-m32c.texi
6281 @include c-m32r.texi
6285 @include c-m68k.texi
6289 @include c-m68hc11.texi
6293 @include c-mips.texi
6297 @include c-mmix.texi
6301 @include c-msp430.texi
6305 @include c-ns32k.texi
6309 @include c-pdp11.texi
6322 @include c-sh64.texi
6326 @include c-sparc.texi
6330 @include c-tic54x.texi
6342 @include c-v850.texi
6346 @include c-xtensa.texi
6350 @c reverse effect of @down at top of generic Machine-Dep chapter
6354 @node Reporting Bugs
6355 @chapter Reporting Bugs
6356 @cindex bugs in assembler
6357 @cindex reporting bugs in assembler
6359 Your bug reports play an essential role in making @command{@value{AS}} reliable.
6361 Reporting a bug may help you by bringing a solution to your problem, or it may
6362 not. But in any case the principal function of a bug report is to help the
6363 entire community by making the next version of @command{@value{AS}} work better.
6364 Bug reports are your contribution to the maintenance of @command{@value{AS}}.
6366 In order for a bug report to serve its purpose, you must include the
6367 information that enables us to fix the bug.
6370 * Bug Criteria:: Have you found a bug?
6371 * Bug Reporting:: How to report bugs
6375 @section Have You Found a Bug?
6376 @cindex bug criteria
6378 If you are not sure whether you have found a bug, here are some guidelines:
6381 @cindex fatal signal
6382 @cindex assembler crash
6383 @cindex crash of assembler
6385 If the assembler gets a fatal signal, for any input whatever, that is a
6386 @command{@value{AS}} bug. Reliable assemblers never crash.
6388 @cindex error on valid input
6390 If @command{@value{AS}} produces an error message for valid input, that is a bug.
6392 @cindex invalid input
6394 If @command{@value{AS}} does not produce an error message for invalid input, that
6395 is a bug. However, you should note that your idea of ``invalid input'' might
6396 be our idea of ``an extension'' or ``support for traditional practice''.
6399 If you are an experienced user of assemblers, your suggestions for improvement
6400 of @command{@value{AS}} are welcome in any case.
6404 @section How to Report Bugs
6406 @cindex assembler bugs, reporting
6408 A number of companies and individuals offer support for @sc{gnu} products. If
6409 you obtained @command{@value{AS}} from a support organization, we recommend you
6410 contact that organization first.
6412 You can find contact information for many support companies and
6413 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
6416 In any event, we also recommend that you send bug reports for @command{@value{AS}}
6417 to @samp{bug-binutils@@gnu.org}.
6419 The fundamental principle of reporting bugs usefully is this:
6420 @strong{report all the facts}. If you are not sure whether to state a
6421 fact or leave it out, state it!
6423 Often people omit facts because they think they know what causes the problem
6424 and assume that some details do not matter. Thus, you might assume that the
6425 name of a symbol you use in an example does not matter. Well, probably it does
6426 not, but one cannot be sure. Perhaps the bug is a stray memory reference which
6427 happens to fetch from the location where that name is stored in memory;
6428 perhaps, if the name were different, the contents of that location would fool
6429 the assembler into doing the right thing despite the bug. Play it safe and
6430 give a specific, complete example. That is the easiest thing for you to do,
6431 and the most helpful.
6433 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
6434 it is new to us. Therefore, always write your bug reports on the assumption
6435 that the bug has not been reported previously.
6437 Sometimes people give a few sketchy facts and ask, ``Does this ring a
6438 bell?'' This cannot help us fix a bug, so it is basically useless. We
6439 respond by asking for enough details to enable us to investigate.
6440 You might as well expedite matters by sending them to begin with.
6442 To enable us to fix the bug, you should include all these things:
6446 The version of @command{@value{AS}}. @command{@value{AS}} announces it if you start
6447 it with the @samp{--version} argument.
6449 Without this, we will not know whether there is any point in looking for
6450 the bug in the current version of @command{@value{AS}}.
6453 Any patches you may have applied to the @command{@value{AS}} source.
6456 The type of machine you are using, and the operating system name and
6460 What compiler (and its version) was used to compile @command{@value{AS}}---e.g.
6464 The command arguments you gave the assembler to assemble your example and
6465 observe the bug. To guarantee you will not omit something important, list them
6466 all. A copy of the Makefile (or the output from make) is sufficient.
6468 If we were to try to guess the arguments, we would probably guess wrong
6469 and then we might not encounter the bug.
6472 A complete input file that will reproduce the bug. If the bug is observed when
6473 the assembler is invoked via a compiler, send the assembler source, not the
6474 high level language source. Most compilers will produce the assembler source
6475 when run with the @samp{-S} option. If you are using @code{@value{GCC}}, use
6476 the options @samp{-v --save-temps}; this will save the assembler source in a
6477 file with an extension of @file{.s}, and also show you exactly how
6478 @command{@value{AS}} is being run.
6481 A description of what behavior you observe that you believe is
6482 incorrect. For example, ``It gets a fatal signal.''
6484 Of course, if the bug is that @command{@value{AS}} gets a fatal signal, then we
6485 will certainly notice it. But if the bug is incorrect output, we might not
6486 notice unless it is glaringly wrong. You might as well not give us a chance to
6489 Even if the problem you experience is a fatal signal, you should still say so
6490 explicitly. Suppose something strange is going on, such as, your copy of
6491 @command{@value{AS}} is out of synch, or you have encountered a bug in the C
6492 library on your system. (This has happened!) Your copy might crash and ours
6493 would not. If you told us to expect a crash, then when ours fails to crash, we
6494 would know that the bug was not happening for us. If you had not told us to
6495 expect a crash, then we would not be able to draw any conclusion from our
6499 If you wish to suggest changes to the @command{@value{AS}} source, send us context
6500 diffs, as generated by @code{diff} with the @samp{-u}, @samp{-c}, or @samp{-p}
6501 option. Always send diffs from the old file to the new file. If you even
6502 discuss something in the @command{@value{AS}} source, refer to it by context, not
6505 The line numbers in our development sources will not match those in your
6506 sources. Your line numbers would convey no useful information to us.
6509 Here are some things that are not necessary:
6513 A description of the envelope of the bug.
6515 Often people who encounter a bug spend a lot of time investigating
6516 which changes to the input file will make the bug go away and which
6517 changes will not affect it.
6519 This is often time consuming and not very useful, because the way we
6520 will find the bug is by running a single example under the debugger
6521 with breakpoints, not by pure deduction from a series of examples.
6522 We recommend that you save your time for something else.
6524 Of course, if you can find a simpler example to report @emph{instead}
6525 of the original one, that is a convenience for us. Errors in the
6526 output will be easier to spot, running under the debugger will take
6527 less time, and so on.
6529 However, simplification is not vital; if you do not want to do this,
6530 report the bug anyway and send us the entire test case you used.
6533 A patch for the bug.
6535 A patch for the bug does help us if it is a good one. But do not omit
6536 the necessary information, such as the test case, on the assumption that
6537 a patch is all we need. We might see problems with your patch and decide
6538 to fix the problem another way, or we might not understand it at all.
6540 Sometimes with a program as complicated as @command{@value{AS}} it is very hard to
6541 construct an example that will make the program follow a certain path through
6542 the code. If you do not send us the example, we will not be able to construct
6543 one, so we will not be able to verify that the bug is fixed.
6545 And if we cannot understand what bug you are trying to fix, or why your
6546 patch should be an improvement, we will not install it. A test case will
6547 help us to understand.
6550 A guess about what the bug is or what it depends on.
6552 Such guesses are usually wrong. Even we cannot guess right about such
6553 things without first using the debugger to find the facts.
6556 @node Acknowledgements
6557 @chapter Acknowledgements
6559 If you have contributed to GAS and your name isn't listed here,
6560 it is not meant as a slight. We just don't know about it. Send mail to the
6561 maintainer, and we'll correct the situation. Currently
6563 the maintainer is Ken Raeburn (email address @code{raeburn@@cygnus.com}).
6565 Dean Elsner wrote the original @sc{gnu} assembler for the VAX.@footnote{Any
6568 Jay Fenlason maintained GAS for a while, adding support for GDB-specific debug
6569 information and the 68k series machines, most of the preprocessing pass, and
6570 extensive changes in @file{messages.c}, @file{input-file.c}, @file{write.c}.
6572 K. Richard Pixley maintained GAS for a while, adding various enhancements and
6573 many bug fixes, including merging support for several processors, breaking GAS
6574 up to handle multiple object file format back ends (including heavy rewrite,
6575 testing, an integration of the coff and b.out back ends), adding configuration
6576 including heavy testing and verification of cross assemblers and file splits
6577 and renaming, converted GAS to strictly ANSI C including full prototypes, added
6578 support for m680[34]0 and cpu32, did considerable work on i960 including a COFF
6579 port (including considerable amounts of reverse engineering), a SPARC opcode
6580 file rewrite, DECstation, rs6000, and hp300hpux host ports, updated ``know''
6581 assertions and made them work, much other reorganization, cleanup, and lint.
6583 Ken Raeburn wrote the high-level BFD interface code to replace most of the code
6584 in format-specific I/O modules.
6586 The original VMS support was contributed by David L. Kashtan. Eric Youngdale
6587 has done much work with it since.
6589 The Intel 80386 machine description was written by Eliot Dresselhaus.
6591 Minh Tran-Le at IntelliCorp contributed some AIX 386 support.
6593 The Motorola 88k machine description was contributed by Devon Bowen of Buffalo
6594 University and Torbjorn Granlund of the Swedish Institute of Computer Science.
6596 Keith Knowles at the Open Software Foundation wrote the original MIPS back end
6597 (@file{tc-mips.c}, @file{tc-mips.h}), and contributed Rose format support
6598 (which hasn't been merged in yet). Ralph Campbell worked with the MIPS code to
6599 support a.out format.
6601 Support for the Zilog Z8k and Renesas H8/300 processors (tc-z8k,
6602 tc-h8300), and IEEE 695 object file format (obj-ieee), was written by
6603 Steve Chamberlain of Cygnus Support. Steve also modified the COFF back end to
6604 use BFD for some low-level operations, for use with the H8/300 and AMD 29k
6607 John Gilmore built the AMD 29000 support, added @code{.include} support, and
6608 simplified the configuration of which versions accept which directives. He
6609 updated the 68k machine description so that Motorola's opcodes always produced
6610 fixed-size instructions (e.g., @code{jsr}), while synthetic instructions
6611 remained shrinkable (@code{jbsr}). John fixed many bugs, including true tested
6612 cross-compilation support, and one bug in relaxation that took a week and
6613 required the proverbial one-bit fix.
6615 Ian Lance Taylor of Cygnus Support merged the Motorola and MIT syntax for the
6616 68k, completed support for some COFF targets (68k, i386 SVR3, and SCO Unix),
6617 added support for MIPS ECOFF and ELF targets, wrote the initial RS/6000 and
6618 PowerPC assembler, and made a few other minor patches.
6620 Steve Chamberlain made GAS able to generate listings.
6622 Hewlett-Packard contributed support for the HP9000/300.
6624 Jeff Law wrote GAS and BFD support for the native HPPA object format (SOM)
6625 along with a fairly extensive HPPA testsuite (for both SOM and ELF object
6626 formats). This work was supported by both the Center for Software Science at
6627 the University of Utah and Cygnus Support.
6629 Support for ELF format files has been worked on by Mark Eichin of Cygnus
6630 Support (original, incomplete implementation for SPARC), Pete Hoogenboom and
6631 Jeff Law at the University of Utah (HPPA mainly), Michael Meissner of the Open
6632 Software Foundation (i386 mainly), and Ken Raeburn of Cygnus Support (sparc,
6633 and some initial 64-bit support).
6635 Linas Vepstas added GAS support for the ESA/390 ``IBM 370'' architecture.
6637 Richard Henderson rewrote the Alpha assembler. Klaus Kaempf wrote GAS and BFD
6638 support for openVMS/Alpha.
6640 Timothy Wall, Michael Hayes, and Greg Smart contributed to the various tic*
6643 David Heine, Sterling Augustine, Bob Wilson and John Ruttenberg from Tensilica,
6644 Inc. added support for Xtensa processors.
6646 Several engineers at Cygnus Support have also provided many small bug fixes and
6647 configuration enhancements.
6649 Many others have contributed large or small bugfixes and enhancements. If
6650 you have contributed significant work and are not mentioned on this list, and
6651 want to be, let us know. Some of the history has been lost; we are not
6652 intentionally leaving anyone out.
projects / external / binutils.git / blob