diff options
| author | Roland Pesch <pesch@cygnus> | 1993-04-15 23:23:21 +0000 |
|---|---|---|
| committer | Roland Pesch <pesch@cygnus> | 1993-04-15 23:23:21 +0000 |
| commit | f009d0ab7ee21414159d1557a0a0d5a50bcc494b (patch) | |
| tree | b73f0d0295c1106877f43e4f03c3a93e929478a1 /gas/doc | |
| parent | b657d1c2545bb6ef38e195e4b2c812fd6917da6f (diff) | |
| download | gdb-f009d0ab7ee21414159d1557a0a0d5a50bcc494b.zip gdb-f009d0ab7ee21414159d1557a0a0d5a50bcc494b.tar.gz gdb-f009d0ab7ee21414159d1557a0a0d5a50bcc494b.tar.bz2 | |
(1) Hitachi SH material (sanitizable)
(2) remove smallbook/cropmarks comments; switching to smallbook is now
automatic w/house style
(3) use `|' alternative convention for SPARC dependent options.
UnGNUish, but the convention is used for other machines in this book.
(4) cease eliding paragraph about purpose of assembler in Hitachi configuration
(5) use SPECIAL-SYMS switch more consistently
(6) formatting improvements from Q1 release
(7) use explicit @page instead of @group in long examples listing
instruction-set summaries (because some new texinfo bug leads to
double-spacing with @group in this context)
(8) rearrange H8/500 instruction-set summary into two cols
(9) include GPL from texinfo directory rather than duplicating here
Diffstat (limited to 'gas/doc')
| -rw-r--r-- | gas/doc/as.texinfo | 3464 |
1 files changed, 1935 insertions, 1529 deletions
diff --git a/gas/doc/as.texinfo b/gas/doc/as.texinfo index 07a9023..cdf53416 100644 --- a/gas/doc/as.texinfo +++ b/gas/doc/as.texinfo @@ -1,19 +1,39 @@ -_dnl__ -*-Texinfo-*- -_dnl__ Copyright (c) 1991 1992 Free Software Foundation, Inc. -_dnl__ $Id$ \input texinfo @c -*-Texinfo-*- -@c Copyright (c) 1991 1992 Free Software Foundation, Inc. -@c %**start of header -@setfilename _AS__.info -_if__(_GENERIC__) -@settitle Using _AS__ -_fi__(_GENERIC__) -_if__(!_GENERIC__) -@settitle Using _AS__ (_HOST__) -_fi__(!_GENERIC__) +@c Copyright (c) 1991 1992 1993 Free Software Foundation, Inc. +@c %**start of header +@setfilename as.info +@c ---config--- +@c defaults, config file may override: +@set have-stabs +@c --- +@include asdoc-config.texi +@c --- +@c common OR combinations of conditions +@ifset AOUT +@set aout-bout +@end ifset +@ifset BOUT +@set aout-bout +@end ifset +@ifset H8/300 +@set H8 +@end ifset +@ifset H8/500 +@set H8 +@end ifset +@c start Hitachi-SH +@ifset SH +@set H8 +@end ifset +@c end Hitachi-SH +@c ------------ +@ifset GENERIC +@settitle Using @value{AS} +@end ifset +@ifclear GENERIC +@settitle Using @value{AS} (@value{TARGET}) +@end ifclear @setchapternewpage odd -@c @smallbook -@c @cropmarks @c %**end of header @ifinfo @@ -27,25 +47,10 @@ END-INFO-DIR-ENTRY @finalout @syncodeindex ky cp -_if__(0) - -NOTE: this manual is marked up for preprocessing with a collection -of m4 macros called "pretex.m4". - -THIS IS THE FULL SOURCE. The full source needs to be run through m4 -before either tex- or info- formatting: for example, - m4 pretex.m4 none.m4 m680x0.m4 as.texinfo >as-680x0.texinfo -will produce (assuming your path finds either GNU or SysV m4; Berkeley -won't do) a file, configured for the M680x0 version of GAS, suitable for -formatting. See the text in "pretex.m4" for a fuller explanation (and -the macro definitions). - -_fi__(0) -@c @ifinfo -This file documents the GNU Assembler "_AS__". +This file documents the GNU Assembler "@value{AS}". -Copyright (C) 1991, 1992 Free Software Foundation, Inc. +Copyright (C) 1991, 1992, 1993 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice @@ -73,13 +78,13 @@ instead of in the original English. @end ifinfo @titlepage -@title Using _AS__ +@title Using @value{AS} @subtitle The GNU Assembler -_if__(!_GENERIC__) -@subtitle for the _HOST__ family -_fi__(!_GENERIC__) +@ifclear GENERIC +@subtitle for the @value{TARGET} family +@end ifclear @sp 1 -@subtitle November 1992 +@subtitle March 1993 @sp 1 @sp 13 The Free Software Foundation Inc. thanks The Nice Computer @@ -90,14 +95,10 @@ distracting the boss while they got some work done. @sp 3 @author Dean Elsner, Jay Fenlason & friends -@c edited by: pesch@cygnus.com @page @tex -\def\$#1${{#1}} % Kluge: collect RCS revision info without $...$ -\xdef\manvers{\$Revision$} % For use in headers, footers too {\parskip=0pt -\hfill {\it Using {\tt _AS__}} \manvers\par -\hfill \TeX{}info \texinfoversion\par +\hfill {\it Using {\tt @value{AS}}}\par \hfill Edited by Roland Pesch for Cygnus Support\par } %"boxit" macro for figures: @@ -128,16 +129,16 @@ except that the section entitled ``GNU General Public License'' may be included in a translation approved by the Free Software Foundation instead of in the original English. @end titlepage -@page + @ifinfo @node Top -@top Using _AS__ +@top Using @value{AS} -This file is a user guide to the GNU assembler @code{_AS__}. -_if__(!_GENERIC__) -This version of the file describes @code{_AS__} configured to generate -code for _HOST__ architectures. -_fi__(!_GENERIC__) +This file is a user guide to the GNU assembler @code{@value{AS}}. +@ifclear GENERIC +This version of the file describes @code{@value{AS}} configured to generate +code for @value{TARGET} architectures. +@end ifclear @menu * Overview:: Overview * Invoking:: Command-Line Options @@ -146,8 +147,11 @@ _fi__(!_GENERIC__) * Symbols:: Symbols * Expressions:: Expressions * Pseudo Ops:: Assembler Directives -* _MACH_DEP__:: Machine Dependent Features +* Machine Dependencies:: Machine Dependent Features +@ifset GENERIC * Copying:: GNU GENERAL PUBLIC LICENSE +@end ifset + * Index:: Index @end menu @end ifinfo @@ -155,42 +159,45 @@ _fi__(!_GENERIC__) @node Overview @chapter Overview @iftex -This manual is a user guide to the GNU assembler @code{_AS__}. -_if__(!_GENERIC__) -This version of the manual describes @code{_AS__} configured to generate -code for _HOST__ architectures. -_fi__(!_GENERIC__) +This manual is a user guide to the GNU assembler @code{@value{AS}}. +@ifclear GENERIC +This version of the manual describes @code{@value{AS}} configured to generate +code for @value{TARGET} architectures. +@end ifclear @end iftex @cindex invocation summary @cindex option summary @cindex summary of options -Here is a brief summary of how to invoke @code{_AS__}. For details, +Here is a brief summary of how to invoke @code{@value{AS}}. For details, @pxref{Invoking,,Comand-Line Options}. @c We don't use deffn and friends for the following because they seem @c to be limited to one line for the header. @smallexample - _AS__ [ -a | -al | -as ] [ -D ] [ -f ] + @value{AS} [ -a | -al | -as ] [ -D ] [ -f ] [ -I @var{path} ] [ -K ] [ -L ] [ -o @var{objfile} ] [ -R ] [ -v ] [ -w ] -_if__(_A29K__) +@ifset A29K @c am29k has no machine-dependent assembler options -_fi__(_A29K__) -_if__(_H8__) -@c h8/300 has no machine-dependent assembler options -_fi__(_H8__) -_if__(_Z8000__) +@end ifset +@ifset H8 +@c Hitachi family chips have no machine-dependent assembler options +@end ifset +@ifset SPARC + [ -Av6 | -Av7 | -Av8 | -Asparclite | -bump ] +@end ifset +@ifset Z8000 @c Z8000 has no machine-dependent assembler options -_fi__(_Z8000__) -_if__(_I960__) +@end ifset +@ifset I960 @c see md_parse_option in tc-i960.c [ -ACA | -ACA_A | -ACB | -ACC | -AKA | -AKB | -AKC | -AMC ] [ -b ] [ -norelax ] -_fi__(_I960__) -_if__(_M680X0__) +@end ifset +@ifset M680X0 [ -l ] [ -mc68000 | -mc68010 | -mc68020 ] -_fi__(_M680X0__) +@end ifset [ -- | @var{files} @dots{} ] @end smallexample @@ -208,7 +215,7 @@ turned on. @item -D This option is accepted only for script compatibility with calls to -other assemblers; it has no effect on @code{_AS__}. +other assemblers; it has no effect on @code{@value{AS}}. @item -f ``fast''---skip preprocessing (assume source is compiler output) @@ -217,18 +224,18 @@ other assemblers; it has no effect on @code{_AS__}. Add @var{path} to the search list for @code{.include} directives @item -K -_if__((!_GENERIC__) && !_DIFFTABKLUG__) -This option is accepted but has no effect on the _HOST__ family. -_fi__((!_GENERIC__) && !_DIFFTABKLUG__) -_if__(_GENERIC__ || _DIFFTABKLUG__) +@ifclear DIFF-TBL-KLUGE +This option is accepted but has no effect on the @value{TARGET} family. +@end ifclear +@ifset DIFF-TBL-KLUGE Issue warnings when difference tables altered for long displacements. -_fi__(_GENERIC__ || _DIFFTABKLUG__) +@end ifset @item -L Keep (in symbol table) local symbols, starting with @samp{L} @item -o @var{objfile} -Name the object-file output from @code{_AS__} +Name the object-file output from @code{@value{AS}} @item -R Fold data section into text section @@ -244,8 +251,8 @@ Standard input, or source files to assemble. @end table -_if__(_I960__) -The following options are available when _AS__ is configured for the +@ifset I960 +The following options are available when @value{AS} is configured for the Intel 80960 processor. @table @code @@ -260,10 +267,10 @@ Do not alter compare-and-branch instructions for long displacements; error if necessary. @end table -_fi__(_I960__) +@end ifset -_if__(_M680X0__) -The following options are available when _AS__ is configured for the +@ifset M680X0 +The following options are available when @value{AS} is configured for the Motorola 68000 series. @table @code @@ -287,11 +294,24 @@ The target machine does (or does not) have a memory-management unit coprocessor. The default is to assume an MMU for 68020 and up. @end table -_fi__(_M680X0__) +@end ifset + +@ifset SPARC +The following options are available when @code{@value{AS}} is configured +for the SPARC architecture: + +@table @code +@item -Av6 | -Av7 | -Av8 | -Asparclite +Explicitly select a variant of the SPARC architecture. + +@item -bump +Warn when the assembler switches to another architecture. +@end table +@end ifset @menu * Manual:: Structure of this Manual -* GNU Assembler:: _AS__, the GNU Assembler +* GNU Assembler:: @value{AS}, the GNU Assembler * Object Formats:: Object File Formats * Command Line:: Command Line * Input Files:: Input Files @@ -304,23 +324,23 @@ _fi__(_M680X0__) @cindex manual, structure and purpose This manual is intended to describe what you need to know to use -@sc{gnu} @code{_AS__}. We cover the syntax expected in source files, including +@sc{gnu} @code{@value{AS}}. We cover the syntax expected in source files, including notation for symbols, constants, and expressions; the directives that -@code{_AS__} understands; and of course how to invoke @code{_AS__}. +@code{@value{AS}} understands; and of course how to invoke @code{@value{AS}}. -_if__(!_GENERIC__) -We also cover special features in the _HOST__ -configuration of @code{_AS__}, including assembler directives. -_fi__(!_GENERIC__) -_if__(_GENERIC__) +@ifclear GENERIC +We also cover special features in the @value{TARGET} +configuration of @code{@value{AS}}, including assembler directives. +@end ifclear +@ifset GENERIC This manual also describes some of the machine-dependent features of various flavors of the assembler. -_fi__(_GENERIC__) -_if__(_INTERNALS__) +@end ifset +@ifset INTERNALS This manual also describes how the assembler works internally, and provides some information that may be useful to people attempting to port the assembler to another machine. -_fi__(_INTERNALS__) +@end ifset @refill @cindex machine instructions (not covered) @@ -329,19 +349,30 @@ to programming in assembly language---let alone programming in general! In a similar vein, we make no attempt to introduce the machine architecture; we do @emph{not} describe the instruction set, standard mnemonics, registers or addressing modes that are standard to a -particular architecture. -_if__(_GENERIC__) +particular architecture. +@ifset GENERIC You may want to consult the manufacturer's machine architecture manual for this information. -_fi__(_GENERIC__) -_if__(_H8__&&!_GENERIC__) +@end ifset +@ifclear GENERIC +@ifset H8/300 For information on the H8/300 machine instruction set, see @cite{H8/300 Series Programming Manual} (Hitachi ADE--602--025). -_fi__(_H8__&&!_GENERIC__) -_if__(_Z8000__&&!_GENERIC__) +@end ifset +@ifset H8/500 +For information on the H8/500 machine instruction set, see @cite{H8/500 +Series Programming Manual} (Hitachi M21T001). +@end ifset +@c start Hitachi-SH +@ifset SH +For information on the Hitachi SH machine instruction set, see +@cite{SH-Microcomputer User's Manual} (Hitachi Micro Systems, Inc.). +@end ifset +@c end Hitachi-SH +@ifset Z8000 For information on the Z8000 machine instruction set, see @cite{Z8000 CPU Technical Manual} -_fi__(_Z8000__&&!_GENERIC__) - +@end ifset +@end ifclear @c I think this is premature---pesch@cygnus.com, 17jan1991 @ignore @@ -352,10 +383,10 @@ computer (in particular, the kinds of computers that GNU can run on); once this assumption is granted examples and definitions need less qualification. -@code{_AS__} is part of a team of programs that turn a high-level +@code{@value{AS}} is part of a team of programs that turn a high-level human-readable series of instructions into a low-level computer-readable series of instructions. Different versions of -@code{_AS__} are used for different kinds of computer. +@code{@value{AS}} are used for different kinds of computer. @end ignore @c There used to be a section "Terminology" here, which defined @@ -368,36 +399,37 @@ computer-readable series of instructions. Different versions of @c directives). @node GNU Assembler -@section _AS__, the GNU Assembler +@section @value{AS}, the GNU Assembler -GNU @code{as} is really a family of assemblers. -_if__(!_GENERIC__) -This manual describes @code{_AS__}, a member of that family which is -configured for the _HOST__ architectures. -_fi__(!_GENERIC__) +GNU @code{as} is really a family of assemblers. +@ifclear GENERIC +This manual describes @code{@value{AS}}, a member of that family which is +configured for the @value{TARGET} architectures. +@end ifclear If you use (or have used) the GNU assembler on one architecture, you should find a fairly similar environment when you use it on another architecture. Each version has much in common with the others, including object file formats, most assembler directives (often called @dfn{pseudo-ops}) and assembler syntax.@refill -_if__(_GENERIC__||!_H8__) -@cindex purpose of @sc{gnu} @code{_AS__} -@code{_AS__} is primarily intended to assemble the output of the GNU C -compiler @code{_GCC__} for use by the linker @code{_LD__}. Nevertheless, -we've tried to make @code{_AS__} assemble correctly everything that the native -assembler would. -_fi__(_GENERIC__||!_H8__) -_if__(_VAX__) -Any exceptions are documented explicitly (@pxref{_MACH_DEP__}). -_fi__(_VAX__) -_if__(_GENERIC__||_M680X0__) -This doesn't mean @code{_AS__} always uses the same syntax as another +@cindex purpose of @sc{gnu} @code{@value{AS}} +@code{@value{AS}} is primarily intended to assemble the output of the +GNU C compiler @code{@value{GCC}} for use by the linker +@code{@value{LD}}. Nevertheless, we've tried to make @code{@value{AS}} +assemble correctly everything that other assemblers for the same +machine would assemble. +@ifset VAX +Any exceptions are documented explicitly (@pxref{Machine Dependencies}). +@end ifset +@ifset M680X0 +@c This remark should appear in generic version of manual; assumption +@c here is that generic version sets M680x0. +This doesn't mean @code{@value{AS}} always uses the same syntax as another assembler for the same architecture; for example, we know of several incompatible versions of 680x0 assembly language syntax. -_fi__(_GENERIC__||_M680X0__) +@end ifset -Unlike older assemblers, @code{_AS__} is designed to assemble a source +Unlike older assemblers, @code{@value{AS}} is designed to assemble a source program in one pass of the source file. This has a subtle impact on the @kbd{.org} directive (@pxref{Org,,@code{.org}}). @@ -410,34 +442,27 @@ object file formats. For the most part, this does not affect how you write assembly language programs; but directives for debugging symbols are typically different in different file formats. @xref{Symbol Attributes,,Symbol Attributes}. -_if__(!_GENERIC__) -_if__(!(_I960__||_A29K__)) -_if__(_AOUT__ && (!_COFF__) && (!_ELF__)) -On the _HOST__, @code{_AS__} is configured to produce @code{a.out} -format object -files.@refill -_fi__(_AOUT__ && (!_COFF__) && (!_ELF__)) -_if__((!_AOUT__) && _COFF__ && (!_ELF__)) -On the _HOST__, @code{_AS__} is configured to produce COFF format object -files.@refill -_fi__((!_AOUT__) && _COFF__ && (!_ELF__)) -_fi__(!(_I960__||_A29K__)) -_if__(_A29K__) -On the _HOST__, @code{_AS__} can be configured to produce either +@ifclear GENERIC +@ifclear MULTI-OBJ +On the @value{TARGET}, @code{@value{AS}} is configured to produce +@value{OBJ-NAME} format object files. +@end ifclear +@c The following should exhaust all configs that set MULTI-OBJ, ideally +@ifset A29K +On the @value{TARGET}, @code{@value{AS}} can be configured to produce either @code{a.out} or COFF format object files. -_fi__(_A29K__) -_if__(_I960__) -On the _HOST__, @code{_AS__} can be configured to produce either -@code{b.out} or COFF -format object files. -_fi__(_I960__) -_fi__(!_GENERIC__) +@end ifset +@ifset I960 +On the @value{TARGET}, @code{@value{AS}} can be configured to produce either +@code{b.out} or COFF format object files. +@end ifset +@end ifclear @node Command Line @section Command Line @cindex command line conventions -After the program name @code{_AS__}, the command line may contain +After the program name @code{@value{AS}}, the command line may contain options and file names. Options may appear in any order, and may be before, after, or between file names. The order of file names is significant. @@ -445,12 +470,12 @@ significant. @cindex standard input, as input file @kindex -- @file{--} (two hyphens) by itself names the standard input file -explicitly, as one of the files for @code{_AS__} to assemble. +explicitly, as one of the files for @code{@value{AS}} to assemble. @cindex options, command line Except for @samp{--} any command line argument that begins with a hyphen (@samp{-}) is an option. Each option changes the behavior of -@code{_AS__}. No option changes the way another option works. An +@code{@value{AS}}. No option changes the way another option works. An option is a @samp{-} followed by one or more letters; the case of the letter is important. All options are optional. @@ -460,8 +485,8 @@ with older assemblers) or it may be the next command argument (GNU standard). These two command lines are equivalent: @smallexample -_AS__ -o my-object-file.o mumble.s -_AS__ -omy-object-file.o mumble.s +@value{AS} -o my-object-file.o mumble.s +@value{AS} -omy-object-file.o mumble.s @end smallexample @node Input Files @@ -471,7 +496,7 @@ _AS__ -omy-object-file.o mumble.s @cindex source program @cindex files, input We use the phrase @dfn{source program}, abbreviated @dfn{source}, to -describe the program input to one run of @code{_AS__}. The program may +describe the program input to one run of @code{@value{AS}}. The program may be in one or more files; how the source is partitioned into files doesn't change the meaning of the source. @@ -480,24 +505,24 @@ doesn't change the meaning of the source. The source program is a concatenation of the text in all the files, in the order specified. -Each time you run @code{_AS__} it assembles exactly one source +Each time you run @code{@value{AS}} it assembles exactly one source program. The source program is made up of one or more files. (The standard input is also a file.) -You give @code{_AS__} a command line that has zero or more input file +You give @code{@value{AS}} a command line that has zero or more input file names. The input files are read (from left file name to right). A command line argument (in any position) that has no special meaning is taken to be an input file name. -If you give @code{_AS__} no file names it attempts to read one input file -from the @code{_AS__} standard input, which is normally your terminal. You -may have to type @key{ctl-D} to tell @code{_AS__} there is no more program +If you give @code{@value{AS}} no file names it attempts to read one input file +from the @code{@value{AS}} standard input, which is normally your terminal. You +may have to type @key{ctl-D} to tell @code{@value{AS}} there is no more program to assemble. Use @samp{--} if you need to explicitly name the standard input file in your command line. -If the source is empty, @code{_AS__} will produce a small, empty object +If the source is empty, @code{@value{AS}} will produce a small, empty object file. @subheading Filenames and Line-numbers @@ -510,13 +535,13 @@ number in a physical file; the other refers to a line number in a ``logical'' file. @xref{Errors, ,Error and Warning Messages}. @dfn{Physical files} are those files named in the command line given -to @code{_AS__}. +to @code{@value{AS}}. @dfn{Logical files} are simply names declared explicitly by assembler directives; they bear no relation to physical files. Logical file names -help error messages reflect the original source file, when @code{_AS__} +help error messages reflect the original source file, when @code{@value{AS}} source is itself synthesized from other files. -@xref{App-File,,@code{.app-file}}. +@xref{App-File,,@code{.app-file}}. @node Object @section Output (Object) File @@ -525,19 +550,19 @@ source is itself synthesized from other files. @cindex output file @kindex a.out @kindex .o -Every time you run @code{_AS__} it produces an output file, which is +Every time you run @code{@value{AS}} it produces an output file, which is your assembly language program translated into numbers. This file is the object file, named -_if__(_BOUT__) +@ifset BOUT @code{b.out}, -_if__(_GENERIC__) -if @code{_AS__} is configured for the Intel 80960, or -_fi__(_GENERIC__) -_fi__(_BOUT__) -_if__(!_BOUT__) +@ifset GENERIC +if @code{@value{AS}} is configured for the Intel 80960, or +@end ifset +@end ifset +@ifclear BOUT @code{a.out}, -_fi__(!_BOUT__) -unless you tell @code{_AS__} to +@end ifclear +unless you tell @code{@value{AS}} to give it another name by using the @code{-o} option. Conventionally, object file names end with @file{.o}. The default name of @file{a.out} is used for historical reasons: older assemblers were @@ -548,8 +573,8 @@ runnable program. @cindex linker @kindex ld -The object file is meant for input to the linker @code{_LD__}. It contains -assembled program code, information to help @code{_LD__} integrate +The object file is meant for input to the linker @code{@value{LD}}. It contains +assembled program code, information to help @code{@value{LD}} integrate the assembled program into a runnable file, and (optionally) symbolic information for the debugger. @@ -561,11 +586,11 @@ information for the debugger. @cindex error messsages @cindex warning messages -@cindex messages from @code{_AS__} -@code{_AS__} may write warnings and error messages to the standard error +@cindex messages from @code{@value{AS}} +@code{@value{AS}} may write warnings and error messages to the standard error file (usually your terminal). This should not happen when a compiler -runs @code{_AS__} automatically. Warnings report an assumption made so -that @code{_AS__} could keep assembling a flawed program; errors report a +runs @code{@value{AS}} automatically. Warnings report an assumption made so +that @code{@value{AS}} could keep assembling a flawed program; errors report a grave problem that stops the assembly. @cindex format of warning messages @@ -577,21 +602,25 @@ file_name:@b{NNN}:Warning Message Text @noindent @cindex line numbers, in warnings/errors -(where @b{NNN} is a line number). If a logical file name has -been given (@pxref{App-File,,@code{.app-file}}) it is used for the -filename, otherwise the -name of the current input file is used. If a logical line number was -given -_if__(!_A29K__) +(where @b{NNN} is a line number). If a logical file name has been given +(@pxref{App-File,,@code{.app-file}}) it is used for the filename, +otherwise the name of the current input file is used. If a logical line +number was given +@ifset GENERIC +(@pxref{Line,,@code{.line}}) +@end ifset +@ifclear GENERIC +@ifclear A29K (@pxref{Line,,@code{.line}}) -_fi__(!_A29K__) -_if__(_A29K__) +@end ifclear +@ifset A29K (@pxref{Ln,,@code{.ln}}) -_fi__(_A29K__) +@end ifset +@end ifclear then it is used to calculate the number printed, otherwise the actual line in the current source file is printed. The message text is intended to be self explanatory (in the grand Unix -tradition). @refill +tradition). @cindex format of error messages Error messages have the format @@ -605,17 +634,17 @@ because many of them aren't supposed to happen. @node Invoking @chapter Command-Line Options -@cindex options, all versions of @code{_AS__} +@cindex options, all versions of @code{@value{AS}} This chapter describes command-line options available in @emph{all} -versions of the GNU assembler; @pxref{_MACH_DEP__}, for options specific -_if__(!_GENERIC__) -to the _HOST__. -_fi__(!_GENERIC__) -_if__(_GENERIC__) +versions of the GNU assembler; @pxref{Machine Dependencies}, for options specific +@ifclear GENERIC +to the @value{TARGET}. +@end ifclear +@ifset GENERIC to particular machine architectures. -_fi__(_GENERIC__) +@end ifset -If you are invoking @code{_AS__} via the GNU C compiler (version 2), you +If you are invoking @code{@value{AS}} via the GNU C compiler (version 2), you can use the @samp{-Wa} option to pass arguments through to the assembler. The assembler arguments must be separated from each other (and the @samp{-Wa}) by commas. For example: @@ -632,6 +661,26 @@ machine-specific options, will be automatically be passed to the assembler by the compiler, so usually you do not need to use this @samp{-Wa} mechanism. +@menu +* a:: -a[dhlns] enable listings +* D:: -D for compatibility +* f:: -f to work faster +* I:: -I for .include search path +@ifclear DIFF-TBL-KLUGE +* K:: -K for compatibility +@end ifclear +@ifset DIFF-TBL-KLUGE +* K:: -K for difference tables +@end ifset + +* L:: -L to retain local labels +* o:: -o to name the object file +* R:: -R to join data and text sections +* v:: -v to announce version +* W:: -W to suppress warnings +@end menu + +@node a @section Enable Listings: @code{-a[dhlns]} @kindex -a @@ -667,13 +716,15 @@ listing-control directives have no effect. The letters after @samp{-a} may be combined into one option, @emph{e.g.}, @samp{-aln}. +@node D @section @code{-D} @kindex -D This option has no effect whatsoever, but it is accepted to make it more likely that scripts written for other assemblers will also work with -@code{_AS__}. +@code{@value{AS}}. +@node f @section Work Faster: @code{-f} @kindex -f @@ -682,14 +733,15 @@ likely that scripts written for other assemblers will also work with @samp{-f} should only be used when assembling programs written by a (trusted) compiler. @samp{-f} stops the assembler from pre-processing the input file(s) before assembling them. @xref{Pre-processing, -,Pre-processing}. +,Pre-processing}. @quotation @emph{Warning:} if the files actually need to be pre-processed (if they -contain comments, for example), @code{_AS__} will not work correctly if +contain comments, for example), @code{@value{AS}} will not work correctly if @samp{-f} is used. @end quotation +@node I @section @code{.include} search path: @code{-I} @var{path} @kindex -I @var{path} @@ -697,34 +749,36 @@ contain comments, for example), @code{_AS__} will not work correctly if @cindex search path for @code{.include} @cindex @code{include} directive search path Use this option to add a @var{path} to the list of directories -@code{_AS__} will search for files specified in @code{.include} +@code{@value{AS}} will search for files specified in @code{.include} directives (@pxref{Include,,@code{.include}}). You may use @code{-I} as many times as necessary to include a variety of paths. The current -working directory is always searched first; after that, @code{_AS__} +working directory is always searched first; after that, @code{@value{AS}} searches any @samp{-I} directories in the same order as they were specified (left to right) on the command line. +@node K @section Difference Tables: @code{-K} @kindex -K -_if__((!_GENERIC__) && (!_DIFFTABKLUG__)) -On the _HOST__ family, this option is allowed, but has no effect. It is +@ifclear DIFF-TBL-KLUGE +On the @value{TARGET} family, this option is allowed, but has no effect. It is permitted for compatibility with the GNU assembler on other platforms, where it can be used to warn when the assembler alters the machine code -generated for @samp{.word} directives in difference tables. The _HOST__ +generated for @samp{.word} directives in difference tables. The @value{TARGET} family does not have the addressing limitations that sometimes lead to this alteration on other platforms. -_fi__((!_GENERIC__) && (!_DIFFTABKLUG__)) +@end ifclear -_if__(_GENERIC__ || _DIFFTABKLUG__ ) +@ifset DIFF-TBL-KLUGE @cindex difference tables, warning @cindex warning for altered difference tables -@code{_AS__} sometimes alters the code emitted for directives of the form +@code{@value{AS}} sometimes alters the code emitted for directives of the form @samp{.word @var{sym1}-@var{sym2}}; @pxref{Word,,@code{.word}}. You can use the @samp{-K} option if you want a warning issued when this is done. -_fi__(_GENERIC__ || _DIFFTABKLUG__ ) +@end ifset +@node L @section Include Local Labels: @code{-L} @kindex -L @@ -733,43 +787,44 @@ Labels beginning with @samp{L} (upper case only) are called @dfn{local labels}. @xref{Symbol Names}. Normally you don't see such labels when debugging, because they are intended for the use of programs (like compilers) that compose assembler programs, not for your notice. -Normally both @code{_AS__} and @code{_LD__} discard such labels, so you don't +Normally both @code{@value{AS}} and @code{@value{LD}} discard such labels, so you don't normally debug with them. -This option tells @code{_AS__} to retain those @samp{L@dots{}} symbols +This option tells @code{@value{AS}} to retain those @samp{L@dots{}} symbols in the object file. Usually if you do this you also tell the linker -@code{_LD__} to preserve symbols whose names begin with @samp{L}. +@code{@value{LD}} to preserve symbols whose names begin with @samp{L}. +@node o @section Name the Object File: @code{-o} @kindex -o @cindex naming object file @cindex object file name -There is always one object file output when you run @code{_AS__}. By +There is always one object file output when you run @code{@value{AS}}. By default it has the name -_if__(_GENERIC__) -_if__(_I960__) -@file{a.out} or @file{b.out}, depending on the target for which -@code{_AS__} is configured. -_fi__(_I960__) -_if__(!_I960__) +@ifset GENERIC +@ifset I960 +@file{a.out} (or @file{b.out}, for Intel 960 targets only). +@end ifset +@ifclear I960 @file{a.out}. -_fi__(!_I960__) -_fi__(_GENERIC__) -_if__(!_GENERIC__) -_if__(_I960__) +@end ifclear +@end ifset +@ifclear GENERIC +@ifset I960 @file{b.out}. -_fi__(_I960__) -_if__(!_I960__) +@end ifset +@ifclear I960 @file{a.out}. -_fi__(!_I960__) -_fi__(!_GENERIC__) -You use this option (which -takes exactly one filename) to give the object file a different name. +@end ifclear +@end ifclear +You use this option (which takes exactly one filename) to give the +object file a different name. -Whatever the object file is called, @code{_AS__} will overwrite any +Whatever the object file is called, @code{@value{AS}} will overwrite any existing file of the same name. +@node R @section Join Data and Text Sections: @code{-R} @kindex -R @@ -777,7 +832,7 @@ existing file of the same name. @cindex text and data sections, joining @cindex joining text and data sections @cindex merging text and data sections -@code{-R} tells @code{_AS__} to write the object file as if all +@code{-R} tells @code{@value{AS}} to write the object file as if all data-section data lives in the text section. This is only done at the very last moment: your binary data are the same, but data section parts are relocated differently. The data section part of @@ -787,36 +842,38 @@ appended to the text section. (@xref{Sections,,Sections and Relocation}.) When you specify @code{-R} it would be possible to generate shorter address displacements (because we don't have to cross between text and data section). We refrain from doing this simply for compatibility with -older versions of @code{_AS__}. In future, @code{-R} may work this way. +older versions of @code{@value{AS}}. In future, @code{-R} may work this way. -_if__(_COFF__) -When @code{_AS__} is configured for COFF output, +@ifset COFF +When @code{@value{AS}} is configured for COFF output, this option is only useful if you use sections named @samp{.text} and -@samp{.data}. -_fi__(_COFF__) +@samp{.data}. +@end ifset +@node v @section Announce Version: @code{-v} @kindex -v @kindex -version -@cindex @code{_AS__} version -@cindex version of @code{_AS__} +@cindex @code{@value{AS}} version +@cindex version of @code{@value{AS}} You can find out what version of as is running by including the option @samp{-v} (which you can also spell as @samp{-version}) on the command line. +@node W @section Suppress Warnings: @code{-W} @kindex -W @cindex suppressing warnings @cindex warnings, suppressing -@code{_AS__} should never give a warning or error message when +@code{@value{AS}} should never give a warning or error message when assembling compiler output. But programs written by people often -cause @code{_AS__} to give a warning that a particular assumption was +cause @code{@value{AS}} to give a warning that a particular assumption was made. All such warnings are directed to the standard error file. If you use this option, no warnings are issued. This option only affects the warning messages: it does not change any particular of how -@code{_AS__} assembles your file. Errors, which stop the assembly, are +@code{@value{AS}} assembles your file. Errors, which stop the assembly, are still reported. @node Syntax @@ -825,14 +882,14 @@ still reported. @cindex machine-independent syntax @cindex syntax, machine-independent This chapter describes the machine-independent syntax allowed in a -source file. @code{_AS__} syntax is similar to what many other assemblers -use; it is inspired by the BSD 4.2 -_if__(!_VAX__) -assembler. @refill -_fi__(!_VAX__) -_if__(_VAX__) -assembler, except that @code{_AS__} does not assemble Vax bit-fields. -_fi__(_VAX__) +source file. @code{@value{AS}} syntax is similar to what many other +assemblers use; it is inspired by the BSD 4.2 +@ifclear VAX +assembler. +@end ifclear +@ifset VAX +assembler, except that @code{@value{AS}} does not assemble Vax bit-fields. +@end ifset @menu * Pre-processing:: Pre-processing @@ -895,7 +952,7 @@ as exactly one space. @section Comments @cindex comments -There are two ways of rendering comments to @code{_AS__}. In both +There are two ways of rendering comments to @code{@value{AS}}. In both cases the comment is equivalent to one space. Anything from @samp{/*} through the next @samp{*/} is a comment. @@ -913,35 +970,43 @@ This means you may not nest these comments. @cindex line comment character Anything from the @dfn{line comment} character to the next newline is considered a comment and is ignored. The line comment character is -_if__(_VAX__) +@ifset VAX @samp{#} on the Vax; -_fi__(_VAX__) -_if__(_I960__) +@end ifset +@ifset I960 @samp{#} on the i960; -_fi__(_I960__) -_if__(_SPARC__) +@end ifset +@ifset SPARC @samp{!} on the SPARC; -_fi__(_SPARC__) -_if__(_M680X0__) +@end ifset +@ifset M680X0 @samp{|} on the 680x0; -_fi__(_M680X0__) -_if__(_A29K__) +@end ifset +@ifset A29K @samp{;} for the AMD 29K family; -_fi__(_A29K__) -_if__(_H8__) +@end ifset +@ifset H8/300 @samp{;} for the H8/300 family; -_fi__(_H8__) -_if__(_Z8000__) +@end ifset +@ifset H8/500 +@samp{!} for the H8/500 family; +@end ifset +@c start Hitachi-SH +@ifset SH +@samp{!} for the Hitachi SH; +@end ifset +@c end Hitachi-SH +@ifset Z8000 @samp{!} for the Z8000; -_fi__(_Z8000__) -see @ref{_MACH_DEP__}. @refill +@end ifset +see @ref{Machine Dependencies}. @refill @c FIXME What about i386, m88k, i860? -_if__(_GENERIC__) +@ifset GENERIC On some machines there are two different line comment characters. One will only begin a comment if it is the first non-whitespace character on a line, while the other will always begin a comment. -_fi__(_GENERIC__) +@end ifset @kindex # @cindex lines starting with @code{#} @@ -961,24 +1026,31 @@ the line is ignored. (Just like a comment.) # This is logical line # 36. @end smallexample This feature is deprecated, and may disappear from future versions -of @code{_AS__}. +of @code{@value{AS}}. @node Symbol Intro @section Symbols @cindex characters used in symbols +@ifclear SPECIAL-SYMS +A @dfn{symbol} is one or more characters chosen from the set of all +letters (both upper and lower case), digits and the three characters +@samp{_.$}. +@end ifclear +@ifset SPECIAL-SYMS +@ifclear GENERIC +@ifset H8 A @dfn{symbol} is one or more characters chosen from the set of all -letters (both upper and lower case), digits and -_if__(!_H8__) -the three characters @samp{_.$} -_fi__(!_H8__) -_if__(_H8__) -the two characters @samp{_.} -_if__(_GENERIC__) +letters (both upper and lower case), digits and the three characters +@samp{._$}. (Save that, on the H8/300 only, you may not use @samp{$} in +symbol names.) +@end ifset +@end ifclear +@end ifset +@ifset GENERIC On most machines, you can also use @code{$} in symbol names; exceptions -are noted in @ref{_MACH_DEP__}. -_fi__(_GENERIC__) -_fi__(_H8__) +are noted in @ref{Machine Dependencies}. +@end ifset No symbol may begin with a digit. Case is significant. There is no length limit: all characters are significant. Symbols are delimited by characters not in that set, or by the beginning of a file @@ -992,34 +1064,41 @@ not a possible symbol delimiter). @xref{Symbols}. @cindex statements, structure of @cindex line separator character @cindex statement separator character -_if__(!_GENERIC__) -_if__(!(_A29K__||_H8__)) +@ifclear GENERIC +@ifclear abnormal-separator A @dfn{statement} ends at a newline character (@samp{\n}) or at a semicolon (@samp{;}). The newline or semicolon is considered part of the preceding statement. Newlines and semicolons within character constants are an exception: they don't end statements. -_fi__(!(_A29K__||_H8__)) -_if__(_A29K__) +@end ifclear +@ifset abnormal-separator +@ifset A29K A @dfn{statement} ends at a newline character (@samp{\n}) or an ``at'' sign (@samp{@@}). The newline or at sign is considered part of the preceding statement. Newlines and at signs within character constants are an exception: they don't end statements. -_fi__(_A29K__) -_if__(_H8__) -A @dfn{statement} ends at a newline character (@samp{\n}) or a dollar -sign (@samp{$}). The newline or dollar sign is considered part of the -preceding statement. Newlines and dollar signs within character constants -are an exception: they don't end statements. -_fi__(_H8__) -_fi__(!_GENERIC__) -_if__(_GENERIC__) +@end ifset +@ifset H8 +A @dfn{statement} ends at a newline character (@samp{\n}); or (for the +H8/300) a dollar sign (@samp{$}); or (for the +@c start Hitachi-SH +Hitachi-SH or the +@c end Hitachi-SH +H8/500) a semicolon +(@samp{;}). The newline or separator character is considered part of +the preceding statement. Newlines and separators within character +constants are an exception: they don't end statements. +@end ifset +@end ifset +@end ifclear +@ifset GENERIC A @dfn{statement} ends at a newline character (@samp{\n}) or line separator character. (The line separator is usually @samp{;}, unless -this conflicts with the comment character; @pxref{_MACH_DEP__}.) The +this conflicts with the comment character; @pxref{Machine Dependencies}.) The newline or separator character is considered part of the preceding statement. Newlines and separators within character constants are an exception: they don't end statements. -_fi__(_GENERIC__) +@end ifset @cindex newline, required at file end @cindex EOF, newline must precede @@ -1031,7 +1110,7 @@ character of any input file should be a newline.@refill @cindex statement on multiple lines You may write a statement on more than one line if you put a backslash (@kbd{\}) immediately in front of any newlines within the -statement. When @code{_AS__} reads a backslashed newline both +statement. When @code{@value{AS}} reads a backslashed newline both characters are ignored. You can even put backslashed newlines in the middle of symbol names without changing the meaning of your source program. @@ -1049,13 +1128,13 @@ symbol determines the syntax of the rest of the statement. If the symbol begins with a dot @samp{.} then the statement is an assembler directive: typically valid for any computer. If the symbol begins with a letter the statement is an assembly language @dfn{instruction}: it -will assemble into a machine language instruction. -_if__(_GENERIC__) -Different versions of @code{_AS__} for different computers will +will assemble into a machine language instruction. +@ifset GENERIC +Different versions of @code{@value{AS}} for different computers will recognize different instructions. In fact, the same symbol may represent a different instruction in a different computer's assembly language.@refill -_fi__(_GENERIC__) +@end ifset @cindex @code{:} (label) @cindex label (@code{:}) @@ -1076,11 +1155,13 @@ another_label: # This is an empty statement. A constant is a number, written so that its value is known by inspection, without knowing any context. Like this: @smallexample +@group .byte 74, 0112, 092, 0x4A, 0X4a, 'J, '\J # All the same value. .ascii "Ring the bell\7" # A string constant. .octa 0x123456789abcdef0123456789ABCDEF0 # A bignum. .float 0f-314159265358979323846264338327\ 95028841971.693993751E-40 # - pi, a flonum. +@end group @end smallexample @menu @@ -1114,8 +1195,8 @@ double-quotes or null characters. The way to get special characters into a string is to @dfn{escape} these characters: precede them with a backslash @samp{\} character. For example @samp{\\} represents one backslash: the first @code{\} is an escape which tells -@code{_AS__} to interpret the second character literally as a backslash -(which prevents @code{_AS__} from recognizing the second @code{\} as an +@code{@value{AS}} to interpret the second character literally as a backslash +(which prevents @code{@value{AS}} from recognizing the second @code{\} as an escape character). The complete list of escapes follows. @cindex escape codes, character @@ -1192,8 +1273,8 @@ this character, because an unescaped @samp{"} would end the string. Any other character when escaped by @kbd{\} will give a warning, but assemble as if the @samp{\} was not present. The idea is that if you used an escape sequence you clearly didn't want the literal -interpretation of the following character. However @code{_AS__} has no -other interpretation, so @code{_AS__} knows it is giving you the wrong +interpretation of the following character. However @code{@value{AS}} has no +other interpretation, so @code{@value{AS}} knows it is giving you the wrong code and warns you of the fact. @end table @@ -1215,21 +1296,27 @@ to strings. So if you want to write the character backslash, you must write @kbd{'\\} where the first @code{\} escapes the second @code{\}. As you can see, the quote is an acute accent, not a grave accent. A newline -_if__(!_GENERIC__) -_if__(!(_A29K__||_H8__)) +@ifclear GENERIC +@ifclear abnormal-separator (or semicolon @samp{;}) -_fi__(!(_A29K__||_H8__)) -_if__(_A29K__) +@end ifclear +@ifset abnormal-separator +@ifset A29K (or at sign @samp{@@}) -_fi__(_A29K__) -_if__(_H8__) -(or dollar sign @samp{$}) -_fi__(_H8__) -_fi__(!_GENERIC__) +@end ifset +@ifset H8 +(or dollar sign @samp{$}, for the H8/300; or semicolon @samp{;} for the +@c start Hitachi-SH +Hitachi SH or +@c end Hitachi-SH +H8/500) +@end ifset +@end ifset +@end ifclear immediately following an acute accent is taken as a literal character and does not count as the end of a statement. The value of a character constant in a numeric expression is the machine's byte-wide code for -that character. @code{_AS__} assumes your character code is ASCII: +that character. @code{@value{AS}} assumes your character code is ASCII: @kbd{'A} means 65, @kbd{'B} means 66, and so on. @refill @node Numbers @@ -1237,7 +1324,7 @@ that character. @code{_AS__} assumes your character code is ASCII: @cindex constants, number @cindex number constants -@code{_AS__} distinguishes three kinds of numbers according to how they +@code{@value{AS}} distinguishes three kinds of numbers according to how they are stored in the target machine. @emph{Integers} are numbers that would fit into an @code{int} in the C language. @emph{Bignums} are integers, but they are stored in more than 32 bits. @emph{Flonums} @@ -1247,9 +1334,11 @@ are floating point numbers, described below. * Integers:: Integers * Bignums:: Bignums * Flonums:: Flonums -_if__(_I960__&&!_GENERIC__) +@ifclear GENERIC +@ifset I960 * Bit Fields:: Bit Fields -_fi__(_I960__&&!_GENERIC__) +@end ifset +@end ifclear @end menu @node Integers @@ -1300,18 +1389,19 @@ integers are permitted while bignums are not. @cindex precision, floating point A @dfn{flonum} represents a floating point number. The translation is indirect: a decimal floating point number from the text is converted by -@code{_AS__} to a generic binary floating point number of more than +@code{@value{AS}} to a generic binary floating point number of more than sufficient precision. This generic floating point number is converted to a particular computer's floating point format (or formats) by a -portion of @code{_AS__} specialized to that computer. +portion of @code{@value{AS}} specialized to that computer. A flonum is written by writing (in order) @itemize @bullet @item The digit @samp{0}. + @item -A letter, to tell @code{_AS__} the rest of the number is a flonum. -_if__(_GENERIC__) +A letter, to tell @code{@value{AS}} the rest of the number is a flonum. +@ifset GENERIC @kbd{e} is recommended. Case is not important. @ignore @c FIXME: verify if flonum syntax really this vague for most cases @@ -1319,28 +1409,42 @@ _if__(_GENERIC__) will work here, but that might be changed. Vax BSD 4.2 assembler seems to allow any of @samp{defghDEFGH}.) @end ignore -_fi__(_GENERIC__) -_if__(_A29K__||_H8__) -_if__(_GENERIC__) -On the AMD 29K and H8/300 architectures, the letter must be: -_fi__(_GENERIC__) + +On the H8/300, H8/500, +@c start Hitachi-SH +Hitachi SH, +@c end Hitachi-SH +and AMD 29K architectures, the letter must be +one of the letters @samp{DFPRSX} (in upper or lower case). + +On the Intel 960 architecture, the letter must be +one of the letters @samp{DFT} (in upper or lower case). +@end ifset +@ifclear GENERIC +@ifset A29K One of the letters @samp{DFPRSX} (in upper or lower case). -_fi__(_A29K__||_H8__) -_if__(_I960__) -_if__(_GENERIC__) -On the Intel 960 architecture, the letter must be: -_fi__(_GENERIC__) +@end ifset +@ifset H8 +One of the letters @samp{DFPRSX} (in upper or lower case). +@end ifset +@ifset I960 One of the letters @samp{DFT} (in upper or lower case). -_fi__(_I960__) +@end ifset +@end ifclear + @item An optional sign: either @samp{+} or @samp{-}. + @item An optional @dfn{integer part}: zero or more decimal digits. + @item An optional @dfn{fractional part}: @samp{.} followed by zero or more decimal digits. + @item An optional exponent, consisting of: + @itemize @bullet @item An @samp{E} or @samp{e}. @@ -1351,16 +1455,18 @@ Optional sign: either @samp{+} or @samp{-}. @item One or more decimal digits. @end itemize + @end itemize At least one of the integer part or the fractional part must be present. The floating point number has the usual base-10 value. -@code{_AS__} does all processing using integers. Flonums are computed +@code{@value{AS}} does all processing using integers. Flonums are computed independently of any floating point hardware in the computer running -@code{_AS__}. +@code{@value{AS}}. -_if__(_I960__&&!_GENERIC__) +@ifclear GENERIC +@ifset I960 @c Bit fields are written as a general facility but are also controlled @c by a conditional-compilation flag---which is as of now (21mar91) @c turned on only by the i960 config of GAS. @@ -1375,14 +1481,14 @@ specify two numbers separated by a colon--- @var{mask}:@var{value} @end example @noindent -the first will act as a mask; @code{_AS__} will bitwise-and it with the +the first will act as a mask; @code{@value{AS}} will bitwise-and it with the second value. The resulting number is then packed -_if__(_GENERIC__) +@ifset GENERIC @c this conditional paren in case bit fields turned on elsewhere than 960 (in host-dependent byte order) -_fi__(_GENERIC__) +@end ifset into a field whose width depends on which assembler directive has the bit-field as its argument. Overflow (a result from the bitwise and requiring more binary digits to represent) is not an error; instead, @@ -1391,7 +1497,8 @@ least significant digits.@refill The directives @code{.byte}, @code{.hword}, @code{.int}, @code{.long}, @code{.short}, and @code{.word} accept bit-field arguments. -_fi__(_I960__&&!_GENERIC__) +@end ifset +@end ifclear @node Sections @chapter Sections and Relocation @@ -1400,8 +1507,8 @@ _fi__(_I960__&&!_GENERIC__) @menu * Secs Background:: Background -* _LD__ Sections:: _LD__ Sections -* _AS__ Sections:: _AS__ Internal Sections +* Ld Sections:: @value{LD} Sections +* As Sections:: @value{AS} Internal Sections * Sub-Sections:: Sub-Sections * bss:: bss Section @end menu @@ -1415,48 +1522,52 @@ For example there may be a ``read only'' section. @cindex linker, and assembler @cindex assembler, and linker -The linker @code{_LD__} reads many object files (partial programs) and -combines their contents to form a runnable program. When @code{_AS__} +The linker @code{@value{LD}} reads many object files (partial programs) and +combines their contents to form a runnable program. When @code{@value{AS}} emits an object file, the partial program is assumed to start at address -0. @code{_LD__} will assign the final addresses the partial program +0. @code{@value{LD}} will assign the final addresses the partial program occupies, so that different partial programs don't overlap. This is actually an over-simplification, but it will suffice to explain how -@code{_AS__} uses sections. +@code{@value{AS}} uses sections. -@code{_LD__} moves blocks of bytes of your program to their run-time +@code{@value{LD}} moves blocks of bytes of your program to their run-time addresses. These blocks slide to their run-time addresses as rigid units; their length does not change and neither does the order of bytes within them. Such a rigid unit is called a @emph{section}. Assigning run-time addresses to sections is called @dfn{relocation}. It includes the task of adjusting mentions of object-file addresses so they refer to the proper run-time addresses. -_if__(_H8__) -For the H8/300, @code{_AS__} pads sections if needed to ensure they end -on a word (sixteen bit) boundary. -_fi__(_H8__) - -@cindex standard @code{_AS__} sections -An object file written by @code{_AS__} has at least three sections, any +@ifset H8 +For the H8/300 and H8/500, +@c start Hitachi-SH +and for the Hitachi SH, +@c end Hitachi-SH +@code{@value{AS}} pads sections if needed to +ensure they end on a word (sixteen bit) boundary. +@end ifset + +@cindex standard @code{@value{AS}} sections +An object file written by @code{@value{AS}} has at least three sections, any of which may be empty. These are named @dfn{text}, @dfn{data} and -@dfn{bss} sections. +@dfn{bss} sections. -_if__(_COFF__) -_if__(_GENERIC__) -When it generates COFF output, -_fi__(_GENERIC__) -@code{_AS__} can also generate whatever other named sections you specify +@ifset COFF +@ifset GENERIC +When it generates COFF output, +@end ifset +@code{@value{AS}} can also generate whatever other named sections you specify using the @samp{.section} directive (@pxref{Section,,@code{.section}}). If you don't use any directives that place output in the @samp{.text} or @samp{.data} sections, these sections will still exist, but will be empty. -_fi__(_COFF__) +@end ifset Within the object file, the text section starts at address @code{0}, the data section follows, and the bss section follows the data section. -To let @code{_LD__} know which data will change when the sections are -relocated, and how to change that data, @code{_AS__} also writes to the +To let @code{@value{LD}} know which data will change when the sections are +relocated, and how to change that data, @code{@value{AS}} also writes to the object file details of the relocation needed. To perform relocation -@code{_LD__} must know, each time an address in the object +@code{@value{LD}} must know, each time an address in the object file is mentioned: @itemize @bullet @item @@ -1475,22 +1586,22 @@ Is the reference to an address ``Program-Counter relative''? @cindex addresses, format of @cindex section-relative addressing -In fact, every address @code{_AS__} ever uses is expressed as +In fact, every address @code{@value{AS}} ever uses is expressed as @display (@var{section}) + (@var{offset into section}) @end display @noindent -Further, every expression @code{_AS__} computes is of this section-relative +Further, every expression @code{@value{AS}} computes is of this section-relative nature. @dfn{Absolute expression} means an expression with section -``absolute'' (@pxref{_LD__ Sections}). A @dfn{pass1 expression} means -an expression with section ``pass1'' (@pxref{_AS__ Sections,,_AS__ +``absolute'' (@pxref{Ld Sections}). A @dfn{pass1 expression} means +an expression with section ``pass1'' (@pxref{As Sections,,@value{AS} Internal Sections}). In this manual we use the notation @{@var{secname} @var{N}@} to mean ``offset @var{N} into section @var{secname}''. Apart from text, data and bss sections you need to know about the -@dfn{absolute} section. When @code{_LD__} mixes partial programs, +@dfn{absolute} section. When @code{@value{LD}} mixes partial programs, addresses in the absolute section remain unchanged. For example, address -@code{@{absolute 0@}} is ``relocated'' to run-time address 0 by @code{_LD__}. +@code{@{absolute 0@}} is ``relocated'' to run-time address 0 by @code{@value{LD}}. Although two partial programs' data sections will not overlap addresses after linking, @emph{by definition} their absolute sections will overlap. Address @code{@{absolute@ 239@}} in one partial program will always be the same @@ -1506,43 +1617,43 @@ common block would be such a symbol: its value is unknown at assembly time so it has section @emph{undefined}. By analogy the word @emph{section} is used to describe groups of sections in -the linked program. @code{_LD__} puts all partial programs' text +the linked program. @code{@value{LD}} puts all partial programs' text sections in contiguous addresses in the linked program. It is customary to refer to the @emph{text section} of a program, meaning all the addresses of all partial program's text sections. Likewise for data and bss sections. -Some sections are manipulated by @code{_LD__}; others are invented for -use of @code{_AS__} and have no meaning except during assembly. +Some sections are manipulated by @code{@value{LD}}; others are invented for +use of @code{@value{AS}} and have no meaning except during assembly. -@node _LD__ Sections -@section _LD__ Sections -@code{_LD__} deals with just four kinds of sections, summarized below. +@node Ld Sections +@section @value{LD} Sections +@code{@value{LD}} deals with just four kinds of sections, summarized below. @table @strong -_if__(_GENERIC__||_COFF__) +@ifset COFF @cindex named sections @cindex sections, named @item named sections -_fi__(_GENERIC__||_COFF__) -_if__(_AOUT__||_BOUT__) +@end ifset +@ifset aout-bout @cindex text section @cindex data section @item text section @itemx data section -_fi__(_AOUT__||_BOUT__) -These sections hold your program. @code{_AS__} and @code{_LD__} treat them as +@end ifset +These sections hold your program. @code{@value{AS}} and @code{@value{LD}} treat them as separate but equal sections. Anything you can say of one section is -true another. -_if__(_AOUT__||_BOUT__) +true another. +@ifset aout-bout When the program is running, however, it is customary for the text section to be unalterable. The text section is often shared among processes: it will contain instructions, constants and the like. The data section of a running program is usually alterable: for example, C variables would be stored in the data section. -_fi__(_AOUT__||_BOUT__) +@end ifset @cindex bss section @item bss section @@ -1556,7 +1667,7 @@ those explicit zeros from object files. @cindex absolute section @item absolute section Address 0 of this section is always ``relocated'' to runtime address 0. -This is useful if you want to refer to an address that @code{_LD__} must +This is useful if you want to refer to an address that @code{@value{LD}} must not change when relocating. In this sense we speak of absolute addresses being ``unrelocatable'': they don't change during relocation. @@ -1568,10 +1679,10 @@ the preceding sections. @end table @cindex relocation example -An idealized example of three relocatable sections follows. -_if__(_COFF__) +An idealized example of three relocatable sections follows. +@ifset COFF The example uses the traditional section names @samp{.text} and @samp{.data}. -_fi__(_COFF__) +@end ifset Memory addresses are on the horizontal axis. @c TEXI2ROFF-KILL @@ -1620,16 +1731,16 @@ DDDD}\boxit{2cm}{\tt 00000}\ \dots\hfil} @end tex @c END TEXI2ROFF-KILL -@node _AS__ Sections -@section _AS__ Internal Sections +@node As Sections +@section @value{AS} Internal Sections -@cindex internal @code{_AS__} sections +@cindex internal @code{@value{AS}} sections @cindex sections in messages, internal -These sections are meant only for the internal use of @code{_AS__}. They +These sections are meant only for the internal use of @code{@value{AS}}. They have no meaning at run-time. You don't really need to know about these -sections for most purposes; but they can be mentioned in @code{_AS__} +sections for most purposes; but they can be mentioned in @code{@value{AS}} warning messages, so it might be helpful to have an idea of their -meanings to @code{_AS__}. These sections are used to permit the +meanings to @code{@value{AS}}. These sections are used to permit the value of every expression in your assembly language program to be a section-relative address. @@ -1647,10 +1758,10 @@ bug in the assembler. @cindex bignum/flonum (internal section) If a number can't be written as a C @code{int} constant (a bignum or a flonum, but not an integer), it is recorded as belonging to this -``section''. @code{_AS__} has to remember that a flonum or a bignum +``section''. @code{@value{AS}} has to remember that a flonum or a bignum does not fit into 32 bits, and cannot be an argument (@pxref{Arguments}) in an expression: this is done by making a flonum or bignum be in a -separate internal section. This is purely for internal @code{_AS__} +separate internal section. This is purely for internal @code{@value{AS}} convenience; bignum/flonum section behaves similarly to absolute section. @@ -1663,7 +1774,7 @@ in a way that defies the one-pass (section + offset in section) assembly process. No compiler need emit such an expression. @quotation -@emph{Warning:} the second pass is currently not implemented. @code{_AS__} +@emph{Warning:} the second pass is currently not implemented. @code{@value{AS}} will abort with an error message if one is required. @end quotation @@ -1676,7 +1787,7 @@ As an assist to the C compiler, expressions of the forms (@var{undefined symbol}) @minus{} (@var{undefined symbol}) @end display -are permitted, and belong to the difference section. @code{_AS__} +are permitted, and belong to the difference section. @code{@value{AS}} re-evaluates such expressions after the source file has been read and the symbol table built. If by that time there are no undefined symbols in the expression then the expression assumes a new section. The @@ -1697,62 +1808,70 @@ statements and the like. @cindex numbered subsections @cindex grouping data -_if__(_AOUT__||_BOUT__) +@ifset aout-bout Assembled bytes -_if__(_COFF__) +@ifset COFF conventionally -_fi__(_COFF__) -fall into two sections: text and data. -_fi__(_AOUT__||_BOUT__) +@end ifset +fall into two sections: text and data. +@end ifset You may have separate groups of -_if__(_COFF__||_GENERIC__) +@ifset GENERIC data in named sections -_fi__(_COFF__||_GENERIC__) -_if__((_AOUT__||_BOUT__)&&!_GENERIC__) -text or data -_fi__((_AOUT__||_BOUT__)&&!_GENERIC__) -that you want to end up near to each other in the object -file, even though they are not contiguous in the assembler source. -@code{_AS__} allows you to use @dfn{subsections} for this purpose. -Within each section, there can be numbered subsections with -values from 0 to 8192. Objects assembled into the same subsection will -be grouped with other objects in the same subsection when they are all -put into the object file. For example, a compiler might want to store -constants in the text section, but might not want to have them -interspersed with the program being assembled. In this case, the -compiler could issue a @samp{.text 0} before each section of code being -output, and a @samp{.text 1} before each group of constants being output. +@end ifset +@ifclear GENERIC +@ifclear aout-bout +data in named sections +@end ifclear +@ifset aout-bout +text or data +@end ifset +@end ifclear +that you want to end up near to each other in the object file, even +though they are not contiguous in the assembler source. +@code{@value{AS}} allows you to use @dfn{subsections} for this purpose. +Within each section, there can be numbered subsections with values from +0 to 8192. Objects assembled into the same subsection will be grouped +with other objects in the same subsection when they are all put into the +object file. For example, a compiler might want to store constants in +the text section, but might not want to have them interspersed with the +program being assembled. In this case, the compiler could issue a +@samp{.text 0} before each section of code being output, and a +@samp{.text 1} before each group of constants being output. Subsections are optional. If you don't use subsections, everything will be stored in subsection number zero. -_if__(_GENERIC__) +@ifset GENERIC Each subsection is zero-padded up to a multiple of four bytes. (Subsections may be padded a different amount on different flavors -of @code{_AS__}.) -_fi__(_GENERIC__) -_if__(!_GENERIC__) -_if__(_H8__) -On the H8/300 platform, each subsection is zero-padded to a word +of @code{@value{AS}}.) +@end ifset +@ifclear GENERIC +@ifset H8 +On the H8/300 and H8/500 platforms, each subsection is zero-padded to a word boundary (two bytes). -_fi__(_H8__) -_if__(_I960__) +@c start Hitachi-SH +The same is true on the Hitachi SH. +@c end Hitachi-SH +@end ifset +@ifset I960 @c FIXME section padding (alignment)? @c Rich Pixley says padding here depends on target obj code format; that @c doesn't seem particularly useful to say without further elaboration, @c so for now I say nothing about it. If this is a generic BFD issue, @c these paragraphs might need to vanish from this manual, and be @c discussed in BFD chapter of binutils (or some such). -_fi__(_I960__) -_if__(_A29K__) +@end ifset +@ifset A29K On the AMD 29K family, no particular padding is added to section or -subsection sizes; _AS__ forces no alignment on this platform. -_fi__(_A29K__) -_fi__(!_GENERIC__) +subsection sizes; @value{AS} forces no alignment on this platform. +@end ifset +@end ifclear Subsections appear in your object file in numeric order, lowest numbered to highest. (All this to be compatible with other people's assemblers.) -The object file contains no representation of subsections; @code{_LD__} and +The object file contains no representation of subsections; @code{@value{LD}} and other programs that manipulate object files will see no trace of them. They just see all your text subsections as a text section, and all your data subsections as a data section. @@ -1760,17 +1879,17 @@ data subsections as a data section. To specify which subsection you want subsequent statements assembled into, use a numeric argument to specify it, in a @samp{.text @var{expression}} or a @samp{.data @var{expression}} statement. -_if__(_COFF__) -_if__(_GENERIC__) -When generating COFF output, you -_fi__(_GENERIC__) -_if__(!_GENERIC__) +@ifset COFF +@ifset GENERIC +When generating COFF output, you +@end ifset +@ifclear GENERIC You -_fi__(!_GENERIC__) +@end ifclear can also use an extra subsection argument with arbitrary named sections: @samp{.section @var{name}, @var{expression}}. -_fi__(_COFF__) +@end ifset @var{Expression} should be an absolute expression. (@xref{Expressions}.) If you just say @samp{.text} then @samp{.text 0} is assumed. Likewise @samp{.data} means @samp{.data 0}. Assembly @@ -1790,7 +1909,7 @@ begins in @code{text 0}. For instance: Each section has a @dfn{location counter} incremented by one for every byte assembled into that section. Because subsections are merely a -convenience restricted to @code{_AS__} there is no concept of a subsection +convenience restricted to @code{@value{AS}} there is no concept of a subsection location counter. There is no way to directly manipulate a location counter---but the @code{.align} directive will change it, and any label definition will capture its current value. The location counter of the @@ -1823,7 +1942,7 @@ to debug. @quotation @cindex debuggers, and symbol order -@emph{Warning:} @code{_AS__} does not place symbols in the object file in +@emph{Warning:} @code{@value{AS}} does not place symbols in the object file in the same order they were declared. This may break some debuggers. @end quotation @@ -1861,34 +1980,32 @@ directive. @xref{Set,,@code{.set}}. @cindex symbol names @cindex names, symbol -Symbol names begin with a letter or with one of -_if__(!_H8__) -@samp{_.$} -_fi__(!_H8__) -_if__(_H8__) -@samp{_.} -_if__(_GENERIC__) -(On most machines, you can also use @code{$} in symbol names; exceptions -are noted in @ref{_MACH_DEP__}.) -_fi__(_GENERIC__) -_fi__(_H8__) -That character may be followed by any string of digits, letters, -_if__(!_H8__) -underscores and dollar signs. -_fi__(!_H8__) -_if__(_H8__) -_if__(_GENERIC__) -dollar signs (unless otherwise noted in @ref{_MACH_DEP__}), -_fi__(_GENERIC__) -and underscores. -_fi__(_H8__) -Case of letters is significant: -@code{foo} is a different symbol name than @code{Foo}. - -_if__(_A29K__) +@ifclear SPECIAL-SYMS +Symbol names begin with a letter or with one of @samp{._}. On most +machines, you can also use @code{$} in symbol names; exceptions are +noted in @ref{Machine Dependencies}. That character may be followed by any +string of digits, letters, dollar signs (unless otherwise noted in +@ref{Machine Dependencies}), and underscores. +@end ifclear +@ifset A29K For the AMD 29K family, @samp{?} is also allowed in the body of a symbol name, though not at its beginning. -_fi__(_A29K__) +@end ifset + +@ifset SPECIAL-SYMS +@ifset H8 +Symbol names begin with a letter or with one of @samp{._}. On the +@c start Hitachi-SH +Hitachi SH or the +@c end Hitachi-SH +H8/500, you can also use @code{$} in symbol names. That character may +be followed by any string of digits, letters, dollar signs (save on the +H8/300), and underscores. +@end ifset +@end ifset + +Case of letters is significant: @code{foo} is a different symbol name +than @code{Foo}. Each symbol has exactly one name. Each name in an assembly language program refers to exactly one symbol. You may use that symbol name any @@ -1925,11 +2042,11 @@ parts: @table @code @item L -All local labels begin with @samp{L}. Normally both @code{_AS__} and -@code{_LD__} forget symbols that start with @samp{L}. These labels are +All local labels begin with @samp{L}. Normally both @code{@value{AS}} and +@code{@value{LD}} forget symbols that start with @samp{L}. These labels are used for symbols you are never intended to see. If you give the -@samp{-L} option then @code{_AS__} will retain these symbols in the -object file. If you also instruct @code{_LD__} to retain these symbols, +@samp{-L} option then @code{@value{AS}} will retain these symbols in the +object file. If you also instruct @code{@value{LD}} to retain these symbols, you may use them in debugging. @item @var{digit} @@ -1960,16 +2077,18 @@ For instance, the first @code{1:} is named @code{L1@ctrl{A}1}, the 44th @cindex current address @cindex location counter The special symbol @samp{.} refers to the current address that -@code{_AS__} is assembling into. Thus, the expression @samp{melvin: +@code{@value{AS}} is assembling into. Thus, the expression @samp{melvin: .long .} will cause @code{melvin} to contain its own address. Assigning a value to @code{.} is treated the same as a @code{.org} directive. Thus, the expression @samp{.=.+4} is the same as saying -_if__(!_A29K__) +@ifclear no-space-dir @samp{.space 4}. -_fi__(!_A29K__) -_if__(_A29K__) +@end ifclear +@ifset no-space-dir +@ifset A29K @samp{.block 4}. -_fi__(_A29K__) +@end ifset +@end ifset @node Symbol Attributes @section Symbol Attributes @@ -1978,12 +2097,12 @@ _fi__(_A29K__) @cindex attributes, symbol Every symbol has, as well as its name, the attributes ``Value'' and ``Type''. Depending on output format, symbols can also have auxiliary -attributes. -_if__(_INTERNALS__) -The detailed definitions are in _0__<a.out.h>_1__. -_fi__(_INTERNALS__) +attributes. +@ifset INTERNALS +The detailed definitions are in @file{a.out.h}. +@end ifset -If you use a symbol without defining it, @code{_AS__} assumes zero for +If you use a symbol without defining it, @code{@value{AS}} assumes zero for all these attributes, and probably won't warn you. This makes the symbol an externally defined symbol, which is generally what you would want. @@ -1991,17 +2110,22 @@ would want. @menu * Symbol Value:: Value * Symbol Type:: Type -_if__(_AOUT__||_BOUT__) -_if__(_GENERIC__||!_BOUT__) +@ifset aout-bout +@ifset GENERIC +* a.out Symbols:: Symbol Attributes: @code{a.out} +@end ifset +@ifclear GENERIC +@ifclear BOUT * a.out Symbols:: Symbol Attributes: @code{a.out} -_fi__(_GENERIC__||!_BOUT__) -_if__(_BOUT__&&!_GENERIC__) +@end ifclear +@ifset BOUT * a.out Symbols:: Symbol Attributes: @code{a.out}, @code{b.out} -_fi__(_BOUT__&&!_GENERIC__) -_fi__(_AOUT__||_BOUT__) -_if__(_COFF__) +@end ifset +@end ifclear +@end ifset +@ifset COFF * COFF Symbols:: Symbol Attributes for COFF -_fi__(_COFF__) +@end ifset @end menu @node Symbol Value @@ -2013,13 +2137,13 @@ The value of a symbol is (usually) 32 bits. For a symbol which labels a location in the text, data, bss or absolute sections the value is the number of addresses from the start of that section to the label. Naturally for text, data and bss sections the value of a symbol changes -as @code{_LD__} changes section base addresses during linking. Absolute +as @code{@value{LD}} changes section base addresses during linking. Absolute symbols' values do not change during linking: that is why they are called absolute. The value of an undefined symbol is treated in a special way. If it is 0 then the symbol is not defined in this assembler source program, and -@code{_LD__} will try to determine its value from other programs it is +@code{@value{LD}} will try to determine its value from other programs it is linked with. You make this kind of symbol simply by mentioning a symbol name without defining it. A non-zero value represents a @code{.comm} common declaration. The value is how much common storage to reserve, in @@ -2036,23 +2160,39 @@ information, any flag settings indicating that a symbol is external, and (optionally), other information for linkers and debuggers. The exact format depends on the object-code output format in use. -_if__(_AOUT__||_BOUT__) +@ifset aout-bout +@ifclear GENERIC +@ifset BOUT +@c The following avoids a "widow" subsection title. @group would be +@c better if it were available outside examples. +@need 1000 @node a.out Symbols -_if__(_BOUT__&&!_GENERIC__) @subsection Symbol Attributes: @code{a.out}, @code{b.out} @cindex @code{b.out} symbol attributes @cindex symbol attributes, @code{b.out} -These symbol attributes appear only when @code{_AS__} is configured for -one of the Berkeley-descended object output formats. -_fi__(_BOUT__&&!_GENERIC__) -_if__(_GENERIC__||!_BOUT__) +These symbol attributes appear only when @code{@value{AS}} is configured for +one of the Berkeley-descended object output formats---@code{a.out} or +@code{b.out}. + +@end ifset +@ifclear BOUT +@node a.out Symbols +@subsection Symbol Attributes: @code{a.out} + +@cindex @code{a.out} symbol attributes +@cindex symbol attributes, @code{a.out} + +@end ifclear +@end ifclear +@ifset GENERIC +@node a.out Symbols @subsection Symbol Attributes: @code{a.out} -_fi__(_GENERIC__||!_BOUT__) @cindex @code{a.out} symbol attributes @cindex symbol attributes, @code{a.out} +@end ifset @menu * Symbol Desc:: Descriptor * Symbol Other:: Other @@ -2065,16 +2205,16 @@ _fi__(_GENERIC__||!_BOUT__) This is an arbitrary 16-bit value. You may establish a symbol's descriptor value by using a @code{.desc} statement (@pxref{Desc,,@code{.desc}}). A descriptor value means nothing to -@code{_AS__}. +@code{@value{AS}}. @node Symbol Other @subsubsection Other @cindex other attribute, of @code{a.out} symbol -This is an arbitrary 8-bit value. It means nothing to @code{_AS__}. -_fi__(_AOUT__||_BOUT__) +This is an arbitrary 8-bit value. It means nothing to @code{@value{AS}}. +@end ifset -_if__(_COFF__) +@ifset COFF @node COFF Symbols @subsection Symbol Attributes for COFF @@ -2083,7 +2223,7 @@ _if__(_COFF__) The COFF format supports a multitude of auxiliary symbol attributes; like the primary symbol attributes, they are set between @code{.def} and -@code{.endef} directives. +@code{.endef} directives. @subsubsection Primary Attributes @@ -2094,10 +2234,10 @@ respectively, with @code{.val} and @code{.type}. @subsubsection Auxiliary Attributes @cindex auxiliary attributes, COFF symbols -The @code{_AS__} directives @code{.dim}, @code{.line}, @code{.scl}, +The @code{@value{AS}} directives @code{.dim}, @code{.line}, @code{.scl}, @code{.size}, and @code{.tag} can generate auxiliary symbol table information for COFF. -_fi__(_COFF__) +@end ifset @node Expressions @chapter Expressions @@ -2120,7 +2260,7 @@ Whitespace may precede and/or follow an expression. @cindex expressions, empty An empty expression has no value: it is just whitespace or null. Wherever an absolute expression is required, you may omit the -expression and @code{_AS__} will assume a value of (absolute) 0. This +expression and @code{@value{AS}} will assume a value of (absolute) 0. This is compatible with other assemblers. @node Integer Exprs @@ -2160,7 +2300,7 @@ integer. Numbers are usually integers. A number can be a flonum or bignum. In this case, you are warned -that only the low order 32 bits are used, and @code{_AS__} pretends +that only the low order 32 bits are used, and @code{@value{AS}} pretends these 32 bits are an integer. You may write integer-manipulating instructions that act on exotic constants, compatible with other assemblers. @@ -2185,7 +2325,7 @@ whitespace. @subsection Prefix Operator @cindex prefix operators -@code{_AS__} has the following @dfn{prefix operators}. They each take +@code{@value{AS}} has the following @dfn{prefix operators}. They each take one argument, which must be absolute. @c the tex/end tex stuff surrounding this small table is meant to make @@ -2233,13 +2373,13 @@ Highest Precedence @item % @dfn{Remainder}. -@item _0__<_1__ -@itemx _0__<<_1__ -@dfn{Shift Left}. Same as the C operator @samp{_0__<<_1__} +@item < +@itemx << +@dfn{Shift Left}. Same as the C operator @samp{<<}. -@item _0__>_1__ -@itemx _0__>>_1__ -@dfn{Shift Right}. Same as the C operator @samp{_0__>>_1__} +@item > +@itemx >> +@dfn{Shift Right}. Same as the C operator @samp{>>}. @end table @item @@ -2302,20 +2442,24 @@ Similarly, you can't subtract quantities from two different sections. All assembler directives have names that begin with a period (@samp{.}). The rest of the name is letters, usually in lower case. -This chapter discusses directives present regardless of the target -machine configuration for the GNU assembler. -_if__(!_H8__) -@xref{_MACH_DEP__} for additional directives. -_fi__(!_H8__) +This chapter discusses directives that are available regardless of the +target machine configuration for the GNU assembler. +@ifset GENERIC +Some machine configurations provide additional directives. +@xref{Machine Dependencies}. +@end ifset +@ifclear GENERIC +@ifset machine-directives +@xref{Machine Dependencies} for additional directives. +@end ifset +@end ifclear @menu * Abort:: @code{.abort} -_if__(_COFF__) -* coff-ABORT:: @code{.ABORT} -_fi__(_COFF__) -_if__(_BOUT__&&!_COFF__) -* bout-ABORT:: @code{.ABORT} -_fi__(_BOUT__&&!_COFF__) +@ifset COFF +* ABORT:: @code{.ABORT} +@end ifset + * Align:: @code{.align @var{abs-expr} , @var{abs-expr}} * App-File:: @code{.app-file @var{string}} * Ascii:: @code{.ascii "@var{string}"}@dots{} @@ -2323,27 +2467,30 @@ _fi__(_BOUT__&&!_COFF__) * Byte:: @code{.byte @var{expressions}} * Comm:: @code{.comm @var{symbol} , @var{length} } * Data:: @code{.data @var{subsection}} -_if__(_COFF__||_BOUT__) +@ifset COFF * Def:: @code{.def @var{name}} -_fi__(_COFF__||_BOUT__) -_if__(_AOUT__||_BOUT__) +@end ifset +@ifset aout-bout * Desc:: @code{.desc @var{symbol}, @var{abs-expression}} -_fi__(_AOUT__||_BOUT__) -_if__(_COFF__||_BOUT__) +@end ifset +@ifset COFF * Dim:: @code{.dim} -_fi__(_COFF__||_BOUT__) +@end ifset + * Double:: @code{.double @var{flonums}} * Eject:: @code{.eject} * Else:: @code{.else} -_if__(_COFF__||_BOUT__) +@ifset COFF * Endef:: @code{.endef} -_fi__(_COFF__||_BOUT__) +@end ifset + * Endif:: @code{.endif} * Equ:: @code{.equ @var{symbol}, @var{expression}} * Extern:: @code{.extern} -_if__(_GENERIC__||!_A29K__) +@ifclear no-file-dir * File:: @code{.file @var{string}} -_fi__(_GENERIC__||!_A29K__) +@end ifclear + * Fill:: @code{.fill @var{repeat} , @var{size} , @var{value}} * Float:: @code{.float @var{flonums}} * Global:: @code{.global @var{symbol}}, @code{.globl @var{symbol}} @@ -2354,46 +2501,52 @@ _fi__(_GENERIC__||!_A29K__) * Int:: @code{.int @var{expressions}} * Lcomm:: @code{.lcomm @var{symbol} , @var{length}} * Lflags:: @code{.lflags} -_if__(_GENERIC__||!_A29K__) +@ifclear no-line-dir * Line:: @code{.line @var{line-number}} -_fi__(_GENERIC__||!_A29K__) +@end ifclear + * Ln:: @code{.ln @var{line-number}} * List:: @code{.list} * Long:: @code{.long @var{expressions}} -_if__(0) +@ignore * Lsym:: @code{.lsym @var{symbol}, @var{expression}} -_fi__(0) +@end ignore + * Nolist:: @code{.nolist} * Octa:: @code{.octa @var{bignums}} * Org:: @code{.org @var{new-lc} , @var{fill}} * Psize:: @code{.psize @var{lines}, @var{columns}} * Quad:: @code{.quad @var{bignums}} * Sbttl:: @code{.sbttl "@var{subheading}"} -_if__(_COFF__||_BOUT__) +@ifset COFF * Scl:: @code{.scl @var{class}} -_fi__(_COFF__||_BOUT__) -_if__(_COFF__) +@end ifset +@ifset COFF * Section:: @code{.section @var{name}, @var{subsection}} -_fi__(_COFF__) +@end ifset + * Set:: @code{.set @var{symbol}, @var{expression}} * Short:: @code{.short @var{expressions}} * Single:: @code{.single @var{flonums}} -_if__(_COFF__||_BOUT__) +@ifset COFF * Size:: @code{.size} -_fi__(_COFF__||_BOUT__) +@end ifset + * Space:: @code{.space @var{size} , @var{fill}} -_if__(_GENERIC__||!_H8__) +@ifset have-stabs * Stab:: @code{.stabd, .stabn, .stabs} -_fi__(_GENERIC__||!_H8__) -_if__(_COFF__||_BOUT__) +@end ifset +@ifset COFF * Tag:: @code{.tag @var{structname}} -_fi__(_COFF__||_BOUT__) +@end ifset + * Text:: @code{.text @var{subsection}} * Title:: @code{.title "@var{heading}"} -_if__(_COFF__||_BOUT__) +@ifset COFF * Type:: @code{.type @var{int}} * Val:: @code{.val @var{addr}} -_fi__(_COFF__||_BOUT__) +@end ifset + * Word:: @code{.word @var{expressions}} * Deprecated:: Deprecated Directives @end menu @@ -2406,29 +2559,22 @@ _fi__(_COFF__||_BOUT__) This directive stops the assembly immediately. It is for compatibility with other assemblers. The original idea was that the assembly language source would be piped into the assembler. If the sender -of the source quit, it could use this directive tells @code{_AS__} to +of the source quit, it could use this directive tells @code{@value{AS}} to quit also. One day @code{.abort} will not be supported. -_if__(_COFF__) -@node coff-ABORT +@ifset COFF +@node ABORT @section @code{.ABORT} @cindex @code{ABORT} directive -When producing COFF output, @code{_AS__} accepts this directive as a +When producing COFF output, @code{@value{AS}} accepts this directive as a synonym for @samp{.abort}. -_fi__(_COFF__) - -_if__(_BOUT__) -_if__(!_COFF__) -@node bout-ABORT -@section @code{.ABORT} -@cindex @code{ABORT} directive -_fi__(!_COFF__) - -When producing @code{b.out} output, @code{_AS__} accepts this directive, +@ifset BOUT +When producing @code{b.out} output, @code{@value{AS}} accepts this directive, but ignores it. -_fi__(_BOUT__) +@end ifset +@end ifset @node Align @section @code{.align @var{abs-expr} , @var{abs-expr}} @@ -2453,15 +2599,15 @@ omitted, the padding bytes are zero. @cindex file name, logical @cindex @code{app-file} directive @code{.app-file} -_if__(!_A29K__) +@ifclear no-file-dir (which may also be spelled @samp{.file}) -_fi__(!_A29K__) -tells @code{_AS__} that we are about to start a new +@end ifclear +tells @code{@value{AS}} that we are about to start a new logical file. @var{string} is the new file name. In general, the filename is recognized whether or not it is surrounded by quotes @samp{"}; but if you wish to specify an empty file name is permitted, you must give the quotes--@code{""}. This statement may go away in -future: it is only recognized to be compatible with old @code{_AS__} +future: it is only recognized to be compatible with old @code{@value{AS}} programs.@refill @node Ascii @@ -2496,9 +2642,9 @@ Each expression is assembled into the next byte. @cindex @code{comm} directive @cindex symbol, common @code{.comm} declares a named common area in the bss section. Normally -@code{_LD__} reserves memory addresses for it during linking, so no partial +@code{@value{LD}} reserves memory addresses for it during linking, so no partial program defines the location of the symbol. Use @code{.comm} to tell -@code{_LD__} that it must be at least @var{length} bytes long. @code{_LD__} +@code{@value{LD}} that it must be at least @var{length} bytes long. @code{@value{LD}} will allocate space for each @code{.comm} symbol that is at least as long as the longest @code{.comm} request in any of the partial programs linked. @var{length} is an absolute expression. @@ -2507,12 +2653,12 @@ linked. @var{length} is an absolute expression. @section @code{.data @var{subsection}} @cindex @code{data} directive -@code{.data} tells @code{_AS__} to assemble the following statements onto the +@code{.data} tells @code{@value{AS}} to assemble the following statements onto the end of the data subsection numbered @var{subsection} (which is an absolute expression). If @var{subsection} is omitted, it defaults to zero. -_if__(_COFF__ || _BOUT__) +@ifset COFF @node Def @section @code{.def @var{name}} @@ -2521,15 +2667,15 @@ _if__(_COFF__ || _BOUT__) @cindex debugging COFF symbols Begin defining debugging information for a symbol @var{name}; the definition extends until the @code{.endef} directive is encountered. -_if__(_BOUT__) +@ifset BOUT -This directive is only observed when @code{_AS__} is configured for COFF +This directive is only observed when @code{@value{AS}} is configured for COFF format output; when producing @code{b.out}, @samp{.def} is recognized, but ignored. -_fi__(_BOUT__) -_fi__(_COFF__ || _BOUT__) +@end ifset +@end ifset -_if__(_AOUT__||_BOUT__) +@ifset aout-bout @node Desc @section @code{.desc @var{symbol}, @var{abs-expression}} @@ -2539,15 +2685,15 @@ _if__(_AOUT__||_BOUT__) This directive sets the descriptor of the symbol (@pxref{Symbol Attributes}) to the low 16 bits of an absolute expression. -_if__(_COFF__) -The @samp{.desc} directive is not available when @code{_AS__} is +@ifset COFF +The @samp{.desc} directive is not available when @code{@value{AS}} is configured for COFF output; it is only for @code{a.out} or @code{b.out} -object format. For the sake of compatibility, @code{_AS__} will accept +object format. For the sake of compatibility, @code{@value{AS}} will accept it, but produce no output, when configured for COFF. -_fi__(_COFF__) -_fi__(_AOUT__||_BOUT__) +@end ifset +@end ifset -_if__(_COFF__ || _BOUT__) +@ifset COFF @node Dim @section @code{.dim} @@ -2557,13 +2703,13 @@ _if__(_COFF__ || _BOUT__) This directive is generated by compilers to include auxiliary debugging information in the symbol table. It is only permitted inside @code{.def}/@code{.endef} pairs. -_if__(_BOUT__) +@ifset BOUT @samp{.dim} is only meaningful when generating COFF format output; when -@code{_AS__} is generating @code{b.out}, it accepts this directive but +@code{@value{AS}} is generating @code{b.out}, it accepts this directive but ignores it. -_fi__(_BOUT__) -_fi__(_COFF__ || _BOUT__) +@end ifset +@end ifset @node Double @section @code{.double @var{flonums}} @@ -2572,14 +2718,16 @@ _fi__(_COFF__ || _BOUT__) @cindex floating point numbers (double) @code{.double} expects zero or more flonums, separated by commas. It assembles floating point numbers. -_if__(_GENERIC__) +@ifset GENERIC The exact kind of floating point numbers emitted depends on how -@code{_AS__} is configured. @xref{_MACH_DEP__}. -_fi__(_GENERIC__) -_if__((!_GENERIC__) && _IEEEFLOAT__) -On the _HOST__ family @samp{.double} emits 64-bit floating-point numbers +@code{@value{AS}} is configured. @xref{Machine Dependencies}. +@end ifset +@ifclear GENERIC +@ifset IEEEFLOAT +On the @value{TARGET} family @samp{.double} emits 64-bit floating-point numbers in @sc{ieee} format. -_fi__((!_GENERIC__) && _IEEEFLOAT__) +@end ifset +@end ifclear @node Eject @section @code{.eject} @@ -2594,12 +2742,12 @@ Force a page break at this point, when generating assembly listings. @section @code{.else} @cindex @code{else} directive -@code{.else} is part of the @code{_AS__} support for conditional +@code{.else} is part of the @code{@value{AS}} support for conditional assembly; @pxref{If,,@code{.if}}. It marks the beginning of a section of code to be assembled if the condition for the preceding @code{.if} was false. -_if__(0) +@ignore @node End, Endef, Else, Pseudo Ops @section @code{.end} @@ -2607,28 +2755,28 @@ _if__(0) This doesn't do anything---but isn't an s_ignore, so I suspect it's meant to do something eventually (which is why it isn't documented here as "for compatibility with blah"). -_fi__(0) +@end ignore -_if__(_COFF__||_BOUT__) +@ifset COFF @node Endef @section @code{.endef} @cindex @code{endef} directive This directive flags the end of a symbol definition begun with -@code{.def}. -_if__(_BOUT__) +@code{.def}. +@ifset BOUT @samp{.endef} is only meaningful when generating COFF format output; if -@code{_AS__} is configured to generate @code{b.out}, it accepts this +@code{@value{AS}} is configured to generate @code{b.out}, it accepts this directive but ignores it. -_fi__(_BOUT__) -_fi__(_COFF__||_BOUT__) +@end ifset +@end ifset @node Endif @section @code{.endif} @cindex @code{endif} directive -@code{.endif} is part of the @code{_AS__} support for conditional assembly; +@code{.endif} is part of the @code{@value{AS}} support for conditional assembly; it marks the end of a block of code that is only assembled conditionally. @xref{If,,@code{.if}}. @@ -2646,10 +2794,10 @@ It is synonymous with @samp{.set}; @pxref{Set,,@code{.set}}. @cindex @code{extern} directive @code{.extern} is accepted in the source program---for compatibility -with other assemblers---but it is ignored. @code{_AS__} treats +with other assemblers---but it is ignored. @code{@value{AS}} treats all undefined symbols as external. -_if__(_GENERIC__||!_A29K__) +@ifclear no-file-dir @node File @section @code{.file @var{string}} @@ -2657,17 +2805,17 @@ _if__(_GENERIC__||!_A29K__) @cindex logical file name @cindex file name, logical @code{.file} (which may also be spelled @samp{.app-file}) tells -@code{_AS__} that we are about to start a new logical file. +@code{@value{AS}} that we are about to start a new logical file. @var{string} is the new file name. In general, the filename is recognized whether or not it is surrounded by quotes @samp{"}; but if you wish to specify an empty file name, you must give the quotes--@code{""}. This statement may go away in future: it is only -recognized to be compatible with old @code{_AS__} programs. -_if__(_A29K__) -In some configurations of @code{_AS__}, @code{.file} has already been -removed to avoid conflicts with other assemblers. @xref{_MACH_DEP__}. -_fi__(_A29K__) -_fi__(_GENERIC__||!_A29K__) +recognized to be compatible with old @code{@value{AS}} programs. +@ifset A29K +In some configurations of @code{@value{AS}}, @code{.file} has already been +removed to avoid conflicts with other assemblers. @xref{Machine Dependencies}. +@end ifset +@end ifclear @node Fill @section @code{.fill @var{repeat} , @var{size} , @var{value}} @@ -2682,7 +2830,7 @@ more than 8, then it is deemed to have the value 8, compatible with other people's assemblers. The contents of each @var{repeat} bytes is taken from an 8-byte number. The highest order 4 bytes are zero. The lowest order 4 bytes are @var{value} rendered in the -byte-order of an integer on the computer @code{_AS__} is assembling for. +byte-order of an integer on the computer @code{@value{AS}} is assembling for. Each @var{size} bytes in a repetition is taken from the lowest order @var{size} bytes of this number. Again, this bizarre behavior is compatible with other people's assemblers. @@ -2699,22 +2847,24 @@ assumed zero. If the first comma and following tokens are absent, @cindex @code{float} directive This directive assembles zero or more flonums, separated by commas. It has the same effect as @code{.single}. -_if__(_GENERIC__) +@ifset GENERIC The exact kind of floating point numbers emitted depends on how -@code{_AS__} is configured. -@xref{_MACH_DEP__}. -_fi__(_GENERIC__) -_if__((!_GENERIC__) && _IEEEFLOAT__) -On the _HOST__ family, @code{.float} emits 32-bit floating point numbers +@code{@value{AS}} is configured. +@xref{Machine Dependencies}. +@end ifset +@ifclear GENERIC +@ifset IEEEFLOAT +On the @value{TARGET} family, @code{.float} emits 32-bit floating point numbers in @sc{ieee} format. -_fi__((!_GENERIC__) && _IEEEFLOAT__) +@end ifset +@end ifclear @node Global @section @code{.global @var{symbol}}, @code{.globl @var{symbol}} @cindex @code{global} directive @cindex symbol, making visible to linker -@code{.global} makes the symbol visible to @code{_LD__}. If you define +@code{.global} makes the symbol visible to @code{@value{LD}}. If you define @var{symbol} in your partial program, its value is made available to other partial programs that are linked with it. Otherwise, @var{symbol} will take its attributes from a symbol of the same name @@ -2733,27 +2883,27 @@ compatibility with other assemblers. This expects zero or more @var{expressions}, and emits a 16 bit number for each. -_if__(_GENERIC__) +@ifset GENERIC This directive is a synonym for @samp{.short}; depending on the target architecture, it may also be a synonym for @samp{.word}. -_fi__(_GENERIC__) -_if__( _W32__ && !_GENERIC__ ) +@end ifset +@ifclear GENERIC +@ifset W32 This directive is a synonym for @samp{.short}. -_fi__( _W32__ && !_GENERIC__ ) -_if__(_W16__ && !_GENERIC__ ) +@end ifset +@ifset W16 This directive is a synonym for both @samp{.short} and @samp{.word}. -_fi__(_W16__ && !_GENERIC__ ) +@end ifset +@end ifclear -_if__(_AOUT__||_BOUT__||_COFF__) @node Ident @section @code{.ident} @cindex @code{ident} directive This directive is used by some assemblers to place tags in object files. -@code{_AS__} simply accepts the directive for source-file +@code{@value{AS}} simply accepts the directive for source-file compatibility with such assemblers, but does not actually emit anything for it. -_fi__(_AOUT__||_BOUT__||_COFF__) @node If @section @code{.if @var{absolute expression}} @@ -2774,11 +2924,11 @@ The following variants of @code{.if} are also supported: Assembles the following section of code if the specified @var{symbol} has been defined. -_if__(0) +@ignore @item .ifeqs @cindex @code{ifeqs} directive Not yet implemented. -_fi__(0) +@end ignore @item .ifndef @var{symbol} @itemx ifnotdef @var{symbol} @@ -2787,10 +2937,10 @@ _fi__(0) Assembles the following section of code if the specified @var{symbol} has not been defined. Both spelling variants are equivalent. -_if__(0) +@ignore @item ifnes Not yet implemented. -_fi__(0) +@end ignore @end table @node Include @@ -2811,20 +2961,35 @@ around @var{file}. @section @code{.int @var{expressions}} @cindex @code{int} directive -_if__(_GENERIC__||!_H8__) +@ifset GENERIC @cindex integers, 32-bit -_fi__(_GENERIC__||!_H8__) +Expect zero or more @var{expressions}, of any section, separated by +commas. For each expression, emit a 32-bit +@end ifset +@ifclear GENERIC +@ifclear H8 +@cindex integers, 32-bit +Expect zero or more @var{expressions}, of any section, separated by +commas. For each expression, emit a 32-bit +@end ifclear +@ifset H8 +@cindex integers Expect zero or more @var{expressions}, of any section, separated by commas. For each expression, emit a -_if__(_GENERIC__||!_H8__) -32-bit -_fi__(_GENERIC__||!_H8__) -_if__(_H8__&&!_GENERIC__) -16-bit -_fi__(_H8__&&!_GENERIC__) -number that will, at run -time, be the value of that expression. The byte order of the -expression depends on what kind of computer will run the program. +@end ifset +@end ifclear +number that will, at run time, be the value of that expression. The +byte order of the expression depends on what kind of computer will run +the program. + +@ifclear GENERIC +@ifset H8 +On the H8/300 and H8/500, @code{.int} emits 16-bit integers. +@c start Hitachi-SH +On the Hitachi SH, however, @code{.int} emits 32-bit integers. +@c end Hitachi-SH +@end ifset +@end ifclear @node Lcomm @section @code{.lcomm @var{symbol} , @var{length}} @@ -2837,94 +3002,79 @@ denoted by @var{symbol}. The section and value of @var{symbol} are those of the new local common. The addresses are allocated in the bss section, so at run-time the bytes will start off zeroed. @var{Symbol} is not declared global (@pxref{Global,,@code{.global}}), so is normally -not visible to @code{_LD__}. +not visible to @code{@value{LD}}. @node Lflags @section @code{.lflags} @cindex @code{lflags} directive (ignored) -@code{_AS__} accepts this directive, for compatibility with other +@code{@value{AS}} accepts this directive, for compatibility with other assemblers, but ignores it. -_if__(_GENERIC__ || !_A29K__) +@ifclear no-line-dir @node Line @section @code{.line @var{line-number}} @cindex @code{line} directive -_fi__(_GENERIC__ || (!_A29K__)) -_if__(_A29K__ && (!_GENERIC__) && !_COFF__) +@end ifclear +@ifset no-line-dir @node Ln @section @code{.ln @var{line-number}} @cindex @code{ln} directive -_fi__(_A29K__ && (!_GENERIC__) && !_COFF__) +@end ifset @cindex logical line number -_if__(_AOUT__||_BOUT__) -Tell @code{_AS__} to change the logical line number. @var{line-number} must be +@ifset aout-bout +Tell @code{@value{AS}} to change the logical line number. @var{line-number} must be an absolute expression. The next line will have that logical line number. So any other statements on the current line (after a statement -separator -_if__(_GENERIC__) -character) -_fi__(_GENERIC__) -_if__(!_GENERIC__) -_if__(! (_A29K__||_H8__) ) -character @code{;}) -_fi__(! (_A29K__||_H8__) ) -_if__(_A29K__) -character @samp{@@}) -_fi__(_A29K__) -_if__(_H8__) -character @samp{$}) -_fi__(_H8__) -_fi__(!_GENERIC__) +separator character) will be reported as on logical line number @var{line-number} @minus{} 1. One day this directive will be unsupported: it is used only -for compatibility with existing assembler programs. @refill +for compatibility with existing assembler programs. -_if__(_GENERIC__ && _A29K__) -@emph{Warning:} In the AMD29K configuration of _AS__, this command is +@ifset GENERIC +@ifset A29K +@emph{Warning:} In the AMD29K configuration of @value{AS}, this command is only available with the name @code{.ln}, rather than as either -@code{.line} or @code{.ln}. -_fi__(_GENERIC__ && _A29K__) -_fi__(_AOUT__||_BOUT__) -_if__(_COFF__ && !_A29K__) +@code{.line} or @code{.ln}. +@end ifset +@end ifset +@end ifset +@ifclear no-line-dir Even though this is a directive associated with the @code{a.out} or -@code{b.out} object-code formats, @code{_AS__} will still recognize it +@code{b.out} object-code formats, @code{@value{AS}} will still recognize it when producing COFF output, and will treat @samp{.line} as though it were the COFF @samp{.ln} @emph{if} it is found outside a -@code{.def}/@code{.endef} pair. +@code{.def}/@code{.endef} pair. Inside a @code{.def}, @samp{.line} is, instead, one of the directives used by compilers to generate auxiliary symbol information for debugging. -_fi__(_COFF__ && !_A29K__) +@end ifclear -_if__(_AOUT__&&(_GENERIC__||!_A29K__)) @node Ln @section @code{.ln @var{line-number}} @cindex @code{ln} directive +@ifclear no-line-dir @samp{.ln} is a synonym for @samp{.line}. -_fi__(_AOUT__&&(_GENERIC__||!_A29K__)) -_if__(_COFF__&&!_AOUT__) -@node Ln -@section @code{.ln @var{line-number}} - -@cindex @code{ln} directive -Tell @code{_AS__} to change the logical line number. @var{line-number} +@end ifclear +@ifset no-line-dir +Tell @code{@value{AS}} to change the logical line number. @var{line-number} must be an absolute expression. The next line will have that logical line number, so any other statements on the current line (after a statement separator character @code{;}) will be reported as on logical line number @var{line-number} @minus{} 1. -_if__(_BOUT__) +@ifset BOUT -This directive is accepted, but ignored, when @code{_AS__} is configured for -@code{b.out}; its effect is only associated with COFF output format. -_fi__(_BOUT__) -_fi__(_COFF__&&!_AOUT__) +This directive is accepted, but ignored, when @code{@value{AS}} is +configured for @code{b.out}; its effect is only associated with COFF +output format. +@end ifset +@end ifset @node List @section @code{.list} @@ -3005,7 +3155,7 @@ expression with the same section as the current subsection. That is, you can't use @code{.org} to cross sections: if @var{new-lc} has the wrong section, the @code{.org} directive is ignored. To be compatible with former assemblers, if the section of @var{new-lc} is absolute, -@code{_AS__} will issue a warning, then pretend the section of @var{new-lc} +@code{@value{AS}} will issue a warning, then pretend the section of @var{new-lc} is the same as the current subsection. @code{.org} may only increase the location counter, or leave it @@ -3015,7 +3165,7 @@ backwards. @c double negative used below "not undefined" because this is a specific @c reference to "undefined" (as SEG_UNKNOWN is called in this manual) @c section. pesch@cygnus.com 18feb91 -Because @code{_AS__} tries to assemble programs in one pass @var{new-lc} +Because @code{@value{AS}} tries to assemble programs in one pass @var{new-lc} may not be undefined. If you really detest this restriction we eagerly await a chance to share your improved assembler. @@ -3035,15 +3185,15 @@ absolute expression. If the comma and @var{fill} are omitted, @cindex listing control: paper size @cindex paper size, for listings Use this directive to declare the number of lines---and, optionally, the -number of columns---to use for each page, when generating listings. +number of columns---to use for each page, when generating listings. If you don't use @code{.psize}, listings will use a default line-count of 60. You may omit the comma and @var{columns} specification; the default width is 200 columns. -@code{_AS__} will generate formfeeds whenever the specified number of +@code{@value{AS}} will generate formfeeds whenever the specified number of lines is exceeded (or whenever you explicitly request one, using -@code{.eject}). +@code{.eject}). If you specify @var{lines} as @code{0}, no formfeeds are generated save those explicitly specified with @code{.eject}. @@ -3054,23 +3204,21 @@ those explicitly specified with @code{.eject}. @cindex @code{quad} directive @code{.quad} expects zero or more bignums, separated by commas. For each bignum, it emits -_if__(_GENERIC__||(!_I960__)) -an 8-byte integer. If the bignum won't fit in 8 -bytes, it prints a warning message; and just takes the lowest order 8 -bytes of the bignum.@refill +@ifclear bignum-16 +an 8-byte integer. If the bignum won't fit in 8 bytes, it prints a +warning message; and just takes the lowest order 8 bytes of the bignum. @cindex eight-byte integer @cindex integer, 8-byte The term ``quad'' comes from contexts in which a ``word'' is two bytes; hence @emph{quad}-word for 8 bytes. -_fi__(_GENERIC__||(!_I960__)) -_if__(_I960__&&(!_GENERIC__)) +@end ifclear +@ifset bignum-16 a 16-byte integer. If the bignum won't fit in 16 bytes, it prints a -warning message; and just takes the lowest order 16 bytes of the -bignum.@refill +warning message; and just takes the lowest order 16 bytes of the bignum. @cindex sixteen-byte integer @cindex integer, 16-byte -_fi__(_I960__&&(!_GENERIC__)) +@end ifset @node Sbttl @section @code{.sbttl "@var{subheading}"} @@ -3079,12 +3227,12 @@ _fi__(_I960__&&(!_GENERIC__)) @cindex subtitles for listings @cindex listing control: subtitle Use @var{subheading} as the title (third line, immediately after the -title line) when generating assembly listings. +title line) when generating assembly listings. This directive affects subsequent pages, as well as the current page if it appears within ten lines of the top of a page. -_if__(_COFF__||_BOUT__) +@ifset COFF @node Scl @section @code{.scl @var{class}} @@ -3095,15 +3243,15 @@ Set the storage-class value for a symbol. This directive may only be used inside a @code{.def}/@code{.endef} pair. Storage class may flag whether a symbol is static or external, or it may record further symbolic debugging information. -_if__(_BOUT__) +@ifset BOUT The @samp{.scl} directive is primarily associated with COFF output; when -configured to generate @code{b.out} output format, @code{_AS__} will +configured to generate @code{b.out} output format, @code{@value{AS}} will accept this directive but ignore it. -_fi__(_BOUT__) -_fi__(_COFF__||_BOUT__) +@end ifset +@end ifset -_if__(_COFF__) +@ifset COFF @node Section @section @code{.section @var{name}, @var{subsection}} @@ -3112,10 +3260,10 @@ _if__(_COFF__) @cindex COFF named section Assemble the following code into end of subsection numbered @var{subsection} in the COFF named section @var{name}. If you omit -@var{subsection}, @code{_AS__} uses subsection number zero. +@var{subsection}, @code{@value{AS}} uses subsection number zero. @samp{.section .text} is equivalent to the @code{.text} directive; @samp{.section .data} is equivalent to the @code{.data} directive. -_fi__(_COFF__) +@end ifset @node Set @section @code{.set @var{symbol}, @var{expression}} @@ -3130,7 +3278,7 @@ flagged. (@xref{Symbol Attributes}.) You may @code{.set} a symbol many times in the same assembly. If the expression's section is unknowable during pass 1, a second pass over the source program will be forced. The second pass is -currently not implemented. @code{_AS__} will abort with an error +currently not implemented. @code{@value{AS}} will abort with an error message if one is required. If you @code{.set} a global symbol, the value stored in the object @@ -3140,17 +3288,22 @@ file is the last value stored into it. @section @code{.short @var{expressions}} @cindex @code{short} directive -_if__(_GENERIC__ || _W16__) -@code{.short} is the same as @samp{.word}. @xref{Word,,@code{.word}}. -_if__(_W32__) +@ifset GENERIC +@code{.short} is normally the same as @samp{.word}. +@xref{Word,,@code{.word}}. + In some configurations, however, @code{.short} and @code{.word} generate -numbers of different lengths; @pxref{_MACH_DEP__}. -_fi__(_W32__) -_fi__(_GENERIC__|| _W16__) -_if__((!_GENERIC__) && _W32__) +numbers of different lengths; @pxref{Machine Dependencies}. +@end ifset +@ifclear GENERIC +@ifset W16 +@code{.short} is the same as @samp{.word}. @xref{Word,,@code{.word}}. +@end ifset +@ifset W32 This expects zero or more @var{expressions}, and emits a 16 bit number for each. -_fi__((!_GENERIC__) && _W32__) +@end ifset +@end ifclear @node Single @section @code{.single @var{flonums}} @@ -3159,16 +3312,18 @@ _fi__((!_GENERIC__) && _W32__) @cindex floating point numbers (single) This directive assembles zero or more flonums, separated by commas. It has the same effect as @code{.float}. -_if__(_GENERIC__) +@ifset GENERIC The exact kind of floating point numbers emitted depends on how -@code{_AS__} is configured. @xref{_MACH_DEP__}. -_fi__(_GENERIC__) -_if__((!_GENERIC__) && _IEEEFLOAT__) -On the _HOST__ family, @code{.single} emits 32-bit floating point +@code{@value{AS}} is configured. @xref{Machine Dependencies}. +@end ifset +@ifclear GENERIC +@ifset IEEEFLOAT +On the @value{TARGET} family, @code{.single} emits 32-bit floating point numbers in @sc{ieee} format. -_fi__((!_GENERIC__) && _IEEEFLOAT__) +@end ifset +@end ifclear -_if__(_COFF__||_BOUT__) +@ifset COFF @node Size @section @code{.size} @@ -3176,16 +3331,16 @@ _if__(_COFF__||_BOUT__) This directive is generated by compilers to include auxiliary debugging information in the symbol table. It is only permitted inside @code{.def}/@code{.endef} pairs. -_if__(_BOUT__) +@ifset BOUT @samp{.size} is only meaningful when generating COFF format output; when -@code{_AS__} is generating @code{b.out}, it accepts this directive but +@code{@value{AS}} is generating @code{b.out}, it accepts this directive but ignores it. -_fi__(_BOUT__) -_fi__(_COFF__||_BOUT__) +@end ifset +@end ifset +@ifclear no-space-dir @node Space -_if__(_GENERIC__ || !_A29K__) @section @code{.space @var{size} , @var{fill}} @cindex @code{space} directive @@ -3193,24 +3348,24 @@ _if__(_GENERIC__ || !_A29K__) This directive emits @var{size} bytes, each of value @var{fill}. Both @var{size} and @var{fill} are absolute expressions. If the comma and @var{fill} are omitted, @var{fill} is assumed to be zero. -_fi__(_GENERIC__ || !_A29K__) +@end ifclear -_if__(_A29K__) -_if__(!_GENERIC__) +@ifset A29K +@ifclear GENERIC +@node Space @section @code{.space} @cindex @code{space} directive -_fi__(!_GENERIC__) +@end ifclear On the AMD 29K, this directive is ignored; it is accepted for compatibility with other AMD 29K assemblers. @quotation -@emph{Warning:} In other versions of the GNU assembler, the directive -@code{.space} has the effect of @code{.block} @xref{_MACH_DEP__}. +@emph{Warning:} In most versions of the GNU assembler, the directive +@code{.space} has the effect of @code{.block} @xref{Machine Dependencies}. @end quotation -_fi__(_A29K__) +@end ifset -_if__(_GENERIC__||!_H8__) -_if__(_AOUT__||_BOUT__||_COFF__) +@ifset have-stabs @node Stab @section @code{.stabd, .stabn, .stabs} @@ -3218,25 +3373,30 @@ _if__(_AOUT__||_BOUT__||_COFF__) @cindex @code{stab@var{x}} directives There are three directives that begin @samp{.stab}. All emit symbols (@pxref{Symbols}), for use by symbolic debuggers. -The symbols are not entered in the @code{_AS__} hash table: they +The symbols are not entered in the @code{@value{AS}} hash table: they cannot be referenced elsewhere in the source file. Up to five fields are required: + @table @var @item string -This is the symbol's name. It may contain any character except @samp{\000}, -so is more general than ordinary symbol names. Some debuggers used to -code arbitrarily complex structures into symbol names using this field. +This is the symbol's name. It may contain any character except +@samp{\000}, so is more general than ordinary symbol names. Some +debuggers used to code arbitrarily complex structures into symbol names +using this field. + @item type -An absolute expression. The symbol's type is set to the low 8 -bits of this expression. -Any bit pattern is permitted, but @code{_LD__} and debuggers will choke on -silly bit patterns. +An absolute expression. The symbol's type is set to the low 8 bits of +this expression. Any bit pattern is permitted, but @code{@value{LD}} +and debuggers will choke on silly bit patterns. + @item other -An absolute expression. -The symbol's ``other'' attribute is set to the low 8 bits of this expression. +An absolute expression. The symbol's ``other'' attribute is set to the +low 8 bits of this expression. + @item desc -An absolute expression. -The symbol's descriptor is set to the low 16 bits of this expression. +An absolute expression. The symbol's descriptor is set to the low 16 +bits of this expression. + @item value An absolute expression which becomes the symbol's value. @end table @@ -3268,10 +3428,10 @@ The name of the symbol is set to the empty string @code{""}. @cindex @code{stabs} directive All five fields are specified. @end table -_fi__(_AOUT__||_BOUT__||_COFF__) -_fi__(_GENERIC__||!_H8__) +@end ifset +@c end have-stabs -_if__(_COFF__||_BOUT__) +@ifset COFF @node Tag @section @code{.tag @var{structname}} @@ -3282,19 +3442,19 @@ This directive is generated by compilers to include auxiliary debugging information in the symbol table. It is only permitted inside @code{.def}/@code{.endef} pairs. Tags are used to link structure definitions in the symbol table with instances of those structures. -_if__(_BOUT__) +@ifset BOUT @samp{.tag} is only used when generating COFF format output; when -@code{_AS__} is generating @code{b.out}, it accepts this directive but +@code{@value{AS}} is generating @code{b.out}, it accepts this directive but ignores it. -_fi__(_BOUT__) -_fi__(_COFF__||_BOUT__) +@end ifset +@end ifset @node Text @section @code{.text @var{subsection}} @cindex @code{text} directive -Tells @code{_AS__} to assemble the following statements onto the end of +Tells @code{@value{AS}} to assemble the following statements onto the end of the text subsection numbered @var{subsection}, which is an absolute expression. If @var{subsection} is omitted, subsection number zero is used. @@ -3305,12 +3465,12 @@ is used. @cindex @code{title} directive @cindex listing control: title line Use @var{heading} as the title (second line, immediately after the -source file name and pagenumber) when generating assembly listings. +source file name and pagenumber) when generating assembly listings. This directive affects subsequent pages, as well as the current page if it appears within ten lines of the top of a page. -_if__(_COFF__||_BOUT__) +@ifset COFF @node Type @section @code{.type @var{int}} @@ -3319,15 +3479,15 @@ _if__(_COFF__||_BOUT__) @cindex @code{type} directive This directive, permitted only within @code{.def}/@code{.endef} pairs, records the integer @var{int} as the type attribute of a symbol table entry. -_if__(_BOUT__) +@ifset BOUT @samp{.type} is associated only with COFF format output; when -@code{_AS__} is configured for @code{b.out} output, it accepts this +@code{@value{AS}} is configured for @code{b.out} output, it accepts this directive but ignores it. -_fi__(_BOUT__) -_fi__(_COFF__||_BOUT__) +@end ifset +@end ifset -_if__(_COFF__||_BOUT__) +@ifset COFF @node Val @section @code{.val @var{addr}} @@ -3337,12 +3497,12 @@ _if__(_COFF__||_BOUT__) This directive, permitted only within @code{.def}/@code{.endef} pairs, records the address @var{addr} as the value attribute of a symbol table entry. -_if__(_BOUT__) +@ifset BOUT -@samp{.val} is used only for COFF output; when @code{_AS__} is +@samp{.val} is used only for COFF output; when @code{@value{AS}} is configured for @code{b.out}, it accepts this directive but ignores it. -_fi__(_BOUT__) -_fi__(_COFF__||_BOUT__) +@end ifset +@end ifset @node Word @section @code{.word @var{expressions}} @@ -3350,40 +3510,42 @@ _fi__(_COFF__||_BOUT__) @cindex @code{word} directive This directive expects zero or more @var{expressions}, of any section, separated by commas. -_if__((!_GENERIC__) && _W32__) -For each expression, @code{_AS__} emits a 32-bit number. -_fi__((!_GENERIC__) && _W32__) -_if__((!_GENERIC__) && _W16__) -For each expression, @code{_AS__} emits a 16-bit number. -_fi__((!_GENERIC__) && _W16__) - -_if__(_GENERIC__) +@ifclear GENERIC +@ifset W32 +For each expression, @code{@value{AS}} emits a 32-bit number. +@end ifset +@ifset W16 +For each expression, @code{@value{AS}} emits a 16-bit number. +@end ifset +@end ifclear +@ifset GENERIC + The size of the number emitted, and its byte order, depends on what kind of computer will run the program. -_fi__(_GENERIC__) +@end ifset @c on amd29k, i960, sparc the "special treatment to support compilers" doesn't @c happen---32-bit addressability, period; no long/short jumps. -_if__(_GENERIC__ || _DIFFTABKLUG__) +@ifset DIFF-TBL-KLUGE @cindex difference tables altered @cindex altered difference tables @quotation @emph{Warning: Special Treatment to support Compilers} @end quotation -_if__(_GENERIC__) +@ifset GENERIC Machines with a 32-bit address space, but that do less than 32-bit addressing, require the following special treatment. If the machine of interest to you does 32-bit addressing (or doesn't require it; -@pxref{_MACH_DEP__}), you can ignore this issue. +@pxref{Machine Dependencies}), you can ignore this issue. -_fi__(_GENERIC__) +@end ifset In order to assemble compiler output into something that will work, -@code{_AS__} will occasionlly do strange things to @samp{.word} directives. +@code{@value{AS}} will occasionlly do strange things to @samp{.word} directives. Directives of the form @samp{.word sym1-sym2} are often emitted by -compilers as part of jump tables. Therefore, when @code{_AS__} assembles a +compilers as part of jump tables. Therefore, when @code{@value{AS}} assembles a directive of the form @samp{.word sym1-sym2}, and the difference between -@code{sym1} and @code{sym2} does not fit in 16 bits, @code{_AS__} will +@code{sym1} and @code{sym2} does not fit in 16 bits, @code{@value{AS}} will create a @dfn{secondary jump table}, immediately before the next label. This secondary jump table will be preceded by a short-jump to the first byte after the secondary table. This short-jump prevents the flow @@ -3400,12 +3562,13 @@ and the @code{.word} directives will be adjusted to contain @code{sym3} minus the address of the long-jump to @code{sym4}; and so on, for as many entries in the original jump table as necessary. -_if__(_INTERNALS__) -@emph{This feature may be disabled by compiling @code{_AS__} with the +@ifset INTERNALS +@emph{This feature may be disabled by compiling @code{@value{AS}} with the @samp{-DWORKING_DOT_WORD} option.} This feature is likely to confuse assembly language programmers. -_fi__(_INTERNALS__) -_fi__(_GENERIC__ || _DIFFTABKLUG__) +@end ifset +@end ifset +@c end DIFF-TBL-KLUGE @node Deprecated @section Deprecated Directives @@ -3420,17 +3583,17 @@ They are included for compatibility with older assemblers. @item .line @end table -@node _MACH_DEP__ -_if__(_GENERIC__) +@ifset GENERIC +@node Machine Dependencies @chapter Machine Dependent Features @cindex machine dependencies The machine instruction sets are (almost by definition) different on -each machine where @code{_AS__} runs. Floating point representations -vary as well, and @code{_AS__} often supports a few additional +each machine where @code{@value{AS}} runs. Floating point representations +vary as well, and @code{@value{AS}} often supports a few additional directives or command-line options for compatibility with other assemblers on a particular platform. Finally, some versions of -@code{_AS__} support special pseudo-instructions for branch +@code{@value{AS}} support special pseudo-instructions for branch optimization. This chapter discusses most of these differences, though it does not @@ -3438,40 +3601,65 @@ include details on any machine's instruction set. For details on that subject, see the hardware manufacturer's manual. @menu -_if__(_VAX__) +@ifset VAX * Vax-Dependent:: VAX Dependent Features -_fi__(_VAX__) -_if__(_A29K__) +@end ifset +@ifset A29K * AMD29K-Dependent:: AMD 29K Dependent Features -_fi__(_A29K__) -_if__(_H8__) +@end ifset +@ifset H8/300 * H8/300-Dependent:: Hitachi H8/300 Dependent Features -_fi__(_H8__) -_if__(_I960__) +@end ifset +@ifset H8/500 +* H8/500-Dependent:: Hitachi H8/500 Dependent Features +@end ifset +@c start Hitachi-SH +@ifset SH +* SH-Dependent:: Hitachi SH Dependent Features +@end ifset +@c end Hitachi-SH +@ifset I960 * i960-Dependent:: Intel 80960 Dependent Features -_fi__(_I960__) -_if__(_M680X0__) +@end ifset +@ifset M680X0 * M68K-Dependent:: M680x0 Dependent Features -_fi__(_M680X0__) -_if__(_SPARC__) +@end ifset +@ifset SPARC * Sparc-Dependent:: SPARC Dependent Features -_fi__(_SPARC__) -_if__(_Z8000__) +@end ifset +@ifset Z8000 * Z8000-Dependent:: Z8000 Dependent Features -_fi__(_Z8000__) -_if__(_I80386__) +@end ifset +@ifset I80386 * i386-Dependent:: 80386 Dependent Features -_fi__(_I80386__) +@end ifset @end menu -_fi__(_GENERIC__) -_if__(_VAX__) -_if__(_GENERIC__) +@down +@end ifset + +@c The following major nodes are *sections* in the GENERIC version, *chapters* +@c in single-cpu versions. This is mainly achieved by @down. There is a +@c peculiarity: to preserve cross-references, there must be a node called +@c "Machine Dependencies". Hence the conditional nodenames in each +@c major node below. Node defaulting in makeinfo requires adjacency of +@c node and sectioning commands; hence the repetition of @chapter BLAH +@c in both conditional blocks. +@c +@ifset VAX +@ifset GENERIC @node Vax-Dependent -_fi__(_GENERIC__) -_CHAPSEC__(0+_GENERIC__) VAX Dependent Features +@chapter VAX Dependent Features +@cindex VAX support +@end ifset +@ifclear GENERIC +@node Machine Dependencies +@chapter VAX Dependent Features @cindex VAX support + +@end ifclear + @menu * Vax-Opts:: VAX Command-Line Options * VAX-float:: VAX Floating Point @@ -3482,12 +3670,13 @@ _CHAPSEC__(0+_GENERIC__) VAX Dependent Features * VAX-no:: Not Supported on VAX @end menu + @node Vax-Opts -_CHAPSEC__(1+_GENERIC__) VAX Command-Line Options +@section VAX Command-Line Options @cindex command-line options ignored, VAX @cindex VAX command-line options ignored -The Vax version of @code{_AS__} accepts any of the following options, +The Vax version of @code{@value{AS}} accepts any of the following options, gives a warning message that the option was ignored and proceeds. These options are for compatibility with scripts designed for other people's assemblers. @@ -3512,7 +3701,7 @@ argument that follows @kbd{-d} (GNU standard). @cindex @code{-V}, redundant on VAX Some other assemblers use a temporary file. This option commanded them to keep the information in active memory rather -than in a disk file. @code{_AS__} always does this, so this +than in a disk file. @code{@value{AS}} always does this, so this option is redundant. @item @kbd{-J} (JUMPify Longer Branches) @@ -3529,7 +3718,7 @@ this option to emit short and long branches. @cindex @code{-t}, ignored on VAX Some other assemblers may use a temporary file, and this option takes a filename being the directory to site the temporary -file. @code{_AS__} does not use a temporary disk file, so this +file. Since @code{@value{AS}} does not use a temporary disk file, this option makes no difference. @kbd{-t} needs exactly one filename. @end table @@ -3544,9 +3733,9 @@ filename. @c FIXME! look into "I think" below, correct if needed, delete. The Vax version of the assembler accepts two options when compiled for VMS. They are @kbd{-h}, and @kbd{-+}. The -@kbd{-h} option prevents @code{_AS__} from modifying the +@kbd{-h} option prevents @code{@value{AS}} from modifying the symbol-table entries for symbols that contain lowercase -characters (I think). The @kbd{-+} option causes @code{_AS__} to +characters (I think). The @kbd{-+} option causes @code{@value{AS}} to print warning messages if the FILENAME part of the object file, or any symbol name is larger than 31 characters. The @kbd{-+} option also insertes some code following the @samp{_main} @@ -3554,7 +3743,7 @@ symbol so that the object file will be compatible with Vax-11 "C". @node VAX-float -_CHAPSEC__(1+_GENERIC__) VAX Floating Point +@section VAX Floating Point @cindex VAX floating point @cindex floating point, VAX @@ -3575,7 +3764,7 @@ The @code{.float} directive produces @code{f} format numbers. The @code{.double} directive produces @code{d} format numbers. @node VAX-directives -_CHAPSEC__(1+_GENERIC__) Vax Machine Directives +@section Vax Machine Directives @cindex machine directives, VAX @cindex VAX machine directives @@ -3608,7 +3797,7 @@ assembles Vax @code{h} format 128-bit floating point constants. @end table @node VAX-opcodes -_CHAPSEC__(1+_GENERIC__) VAX Opcodes +@section VAX Opcodes @cindex VAX opcode mnemonics @cindex opcode mnemonics, VAX @@ -3620,7 +3809,7 @@ follows the @code{case@dots{}} instruction should be made with assemblers we know of. @node VAX-branch -_CHAPSEC__(1+_GENERIC__) VAX Branch Improvement +@section VAX Branch Improvement @cindex VAX branch improvement @cindex branch improvement, VAX @@ -3679,9 +3868,9 @@ Unconditional branch. @kbd{@var{OPCODE} @dots{}} @item (long displacement) @example -@var{OPCODE} @dots{}, foo ; -brb bar ; -foo: jmp @dots{} ; +@var{OPCODE} @dots{}, foo ; +brb bar ; +foo: jmp @dots{} ; bar: @end example @end table @@ -3694,17 +3883,17 @@ bar: @kbd{@var{OPCODE} @dots{}} @item (word displacement) @example -@var{OPCODE} @dots{}, foo ; -brb bar ; -foo: brw @var{destination} ; +@var{OPCODE} @dots{}, foo ; +brb bar ; +foo: brw @var{destination} ; bar: @end example @item (long displacement) @example -@var{OPCODE} @dots{}, foo ; -brb bar ; -foo: jmp @var{destination} ; -bar: +@var{OPCODE} @dots{}, foo ; +brb bar ; +foo: jmp @var{destination} ; +bar: @end example @end table @item aobleq @@ -3716,23 +3905,23 @@ bar: @kbd{@var{OPCODE} @dots{}} @item (word displacement) @example -@var{OPCODE} @dots{}, foo ; -brb bar ; -foo: brw @var{destination} ; +@var{OPCODE} @dots{}, foo ; +brb bar ; +foo: brw @var{destination} ; bar: @end example @item (long displacement) @example -@var{OPCODE} @dots{}, foo ; -brb bar ; -foo: jmp @var{destination} ; +@var{OPCODE} @dots{}, foo ; +brb bar ; +foo: jmp @var{destination} ; bar: @end example @end table @end table @node VAX-operands -_CHAPSEC__(1+_GENERIC__) VAX Operands +@section VAX Operands @cindex VAX operand notation @cindex operand notation, VAX @@ -3772,19 +3961,24 @@ separated. @c and to encapsulate sub-expressions. @node VAX-no -_CHAPSEC__(1+_GENERIC__) Not Supported on VAX +@section Not Supported on VAX @cindex VAX bitfields not supported @cindex bitfields, not supported on VAX -Vax bit fields can not be assembled with @code{_AS__}. Someone +Vax bit fields can not be assembled with @code{@value{AS}}. Someone can add the required code if they really need it. -_fi__(_VAX__) -_if__(_A29K__) -_if__(_GENERIC__) +@end ifset +@ifset A29K +@ifset GENERIC +@page @node AMD29K-Dependent -_fi__(_GENERIC__) -_CHAPSEC__(0+_GENERIC__) AMD 29K Dependent Features +@chapter AMD 29K Dependent Features +@end ifset +@ifclear GENERIC +@node Machine Dependencies +@chapter AMD 29K Dependent Features +@end ifclear @cindex AMD 29K support @cindex 29K support @@ -3797,28 +3991,28 @@ _CHAPSEC__(0+_GENERIC__) AMD 29K Dependent Features @end menu @node AMD29K Options -_CHAPSEC__(1+_GENERIC__) Options +@section Options @cindex AMD 29K options (none) @cindex options for AMD29K (none) -@code{_AS__} has no additional command-line options for the AMD +@code{@value{AS}} has no additional command-line options for the AMD 29K family. @node AMD29K Syntax -_CHAPSEC__(1+_GENERIC__) Syntax +@section Syntax @menu * AMD29K-Chars:: Special Characters * AMD29K-Regs:: Register Names @end menu @node AMD29K-Chars -_CHAPSEC__(2+_GENERIC__) Special Characters +@subsection Special Characters @cindex line comment character, AMD 29K @cindex AMD 29K line comment character @samp{;} is the line comment character. @cindex line separator, AMD 29K -@cindex AMD 29K line separator +@cindex AMD 29K line separator @cindex statement separator, AMD 29K @cindex AMD 29K statement separator @samp{@@} can be used instead of a newline to separate statements. @@ -3829,7 +4023,7 @@ The character @samp{?} is permitted in identifiers (but may not begin an identifier). @node AMD29K-Regs -_CHAPSEC__(2+_GENERIC__) Register Names +@subsection Register Names @cindex AMD 29K register names @cindex register names, AMD 29K @@ -3855,7 +4049,7 @@ global registers, and the range [128, 255] to local registers. @cindex AMD 29K special purpose registers @cindex protected registers, AMD 29K @cindex AMD 29K protected registers -In addition, @code{_AS__} understands the following protected +In addition, @code{@value{AS}} understands the following protected special-purpose register names for the AMD 29K family: @smallexample @@ -3875,14 +4069,14 @@ These unprotected special-purpose register names are also recognized: @end smallexample @node AMD29K Floating Point -_CHAPSEC__(1+_GENERIC__) Floating Point +@section Floating Point @cindex floating point, AMD 29K (@sc{ieee}) @cindex AMD 29K floating point (@sc{ieee}) The AMD 29K family uses @sc{ieee} floating-point numbers. @node AMD29K Directives -_CHAPSEC__(1+_GENERIC__) AMD 29K Machine Directives +@section AMD 29K Machine Directives @cindex machine directives, AMD 29K @cindex AMD 29K machine directives @@ -3941,22 +4135,45 @@ name} options, @samp{.use} is equivalent to the machine directive @end table @node AMD29K Opcodes -_CHAPSEC__(1+_GENERIC__) Opcodes +@section Opcodes @cindex AMD 29K opcodes @cindex opcodes for AMD 29K -@code{_AS__} implements all the standard AMD 29K opcodes. No +@code{@value{AS}} implements all the standard AMD 29K opcodes. No additional pseudo-instructions are needed on this family. For information on the 29K machine instruction set, see @cite{Am29000 User's Manual}, Advanced Micro Devices, Inc. -_fi__(_A29K__) -_if__(_H8__) -_if__(_GENERIC__) +@end ifset +@ifset Hitachi-all +@ifclear GENERIC +@node Machine Dependencies +@chapter Machine Dependent Features + +The machine instruction sets are different on each Hitachi chip family, +and there are also some syntax differences among the families. This +chapter describes the specific @code{@value{AS}} features for each +family. + +@menu +* H8/300-Dependent:: Hitachi H8/300 Dependent Features +* H8/500-Dependent:: Hitachi H8/500 Dependent Features +@c start Hitachi-SH + +* SH-Dependent:: Hitachi SH Dependent Features +@c end Hitachi-SH +@end menu +@down +@end ifclear +@end ifset + +@ifset H8/300 +@ifset GENERIC +@page +@end ifset @node H8/300-Dependent -_fi__(_GENERIC__) -_CHAPSEC__(0+_GENERIC__) H8/300 Dependent Features +@chapter H8/300 Dependent Features @cindex H8/300 support @menu @@ -3968,15 +4185,15 @@ _CHAPSEC__(0+_GENERIC__) H8/300 Dependent Features @end menu @node H8/300 Options -_CHAPSEC__(1+_GENERIC__) Options +@section Options @cindex H8/300 options (none) @cindex options, H8/300 (none) -@code{_AS__} has no additional command-line options for the Hitachi +@code{@value{AS}} has no additional command-line options for the Hitachi H8/300 family. @node H8/300 Syntax -_CHAPSEC__(1+_GENERIC__) Syntax +@section Syntax @menu * H8/300-Chars:: Special Characters * H8/300-Regs:: Register Names @@ -3984,7 +4201,7 @@ _CHAPSEC__(1+_GENERIC__) Syntax @end menu @node H8/300-Chars -_CHAPSEC__(2+_GENERIC__) Special Characters +@subsection Special Characters @cindex line comment character, H8/300 @cindex H8/300 line comment character @@ -3994,10 +4211,10 @@ _CHAPSEC__(2+_GENERIC__) Special Characters @cindex statement separator, H8/300 @cindex H8/300 line separator @samp{$} can be used instead of a newline to separate statements. -Therefore @emph{you may not use @samp{$} in symbol names} on the H8/300. +Therefore @emph{you may not use @samp{$} in symbol names} on the H8/300. @node H8/300-Regs -_CHAPSEC__(2+_GENERIC__) Register Names +@subsection Register Names @cindex H8/300 registers @cindex registers, H8/300 @@ -4005,11 +4222,11 @@ You can use predefined symbols of the form @samp{r@var{n}h} and @samp{r@var{n}l} to refer to the H8/300 registers as sixteen 8-bit general-purpose registers. @var{n} is a digit from @samp{0} to @samp{7}); for instance, both @samp{r0h} and @samp{r7l} are valid -register names. +register names. You can also use the eight predefined symbols @samp{r@var{n}} to refer to the H8/300 registers as 16-bit registers (you must use this form for -addressing). +addressing). The two control registers are called @code{pc} (program counter; a 16-bit register) and @code{ccr} (condition code register; an 8-bit @@ -4017,11 +4234,11 @@ register). @code{r7} is used as the stack pointer, and can also be called @code{sp}. @node H8/300-Addressing -_CHAPSEC__(2+_GENERIC__) Addressing Modes +@subsection Addressing Modes @cindex addressing modes, H8/300 @cindex H8/300 addressing modes -_AS__ understands the following addressing modes for the H8/300: +@value{AS} understands the following addressing modes for the H8/300: @table @code @item r@var{n} Register direct @@ -4045,42 +4262,42 @@ Register indirect with pre-decrement @itemx @code{@@}@var{aa}:8 @itemx @code{@@}@var{aa}:16 Absolute address @code{aa}. You may specify the @samp{:8} or @samp{:16} -for clarity, if you wish; but @code{_AS__} neither requires this nor +for clarity, if you wish; but @code{@value{AS}} neither requires this nor uses it---the address size required is taken from context. @item #@var{xx} @itemx #@var{xx}:8 @itemx #@var{xx}:16 Immediate data @var{xx}. You may specify the @samp{:8} or @samp{:16} -for clarity, if you wish; but @code{_AS__} neither requires this nor +for clarity, if you wish; but @code{@value{AS}} neither requires this nor uses it---the data size required is taken from context. @item @code{@@}@code{@@}@var{aa} @itemx @code{@@}@code{@@}@var{aa}:8 Memory indirect. You may specify the @samp{:8} for clarity, if you -wish; but @code{_AS__} neither requires this nor uses it. +wish; but @code{@value{AS}} neither requires this nor uses it. @end table @node H8/300 Floating Point -_CHAPSEC__(1+_GENERIC__) Floating Point +@section Floating Point @cindex floating point, H8/300 (@sc{ieee}) @cindex H8/300 floating point (@sc{ieee}) The H8/300 family uses @sc{ieee} floating-point numbers. @node H8/300 Directives -_CHAPSEC__(1+_GENERIC__) H8/300 Machine Directives +@section H8/300 Machine Directives @cindex H8/300 machine directives (none) @cindex machine directives, H8/300 (none) @cindex @code{word} directive, H8/300 @cindex @code{int} directive, H8/300 -@code{_AS__} has no machine-dependent directives for the H8/300. +@code{@value{AS}} has no machine-dependent directives for the H8/300. However, on this platform the @samp{.int} and @samp{.word} directives generate 16-bit numbers. @node H8/300 Opcodes -_CHAPSEC__(1+_GENERIC__) Opcodes +@section Opcodes @cindex H8/300 opcode summary @cindex opcode summary, H8/300 @@ -4089,127 +4306,659 @@ _CHAPSEC__(1+_GENERIC__) Opcodes For detailed information on the H8/300 machine instruction set, see @cite{H8/300 Series Programming Manual} (Hitachi ADE--602--025). -@code{_AS__} implements all the standard H8/300 opcodes. No additional -pseudo-instructions are needed on this family. +@code{@value{AS}} implements all the standard H8/300 opcodes. No additional +pseudo-instructions are needed on this family. The following table summarizes the opcodes and their arguments: @c kluge due to lack of group outside example @page @smallexample -@group - Rs @r{source register} +@c In texinfo 2.102, @group makes this doublepsace!! +@c @group + @i{Legend:} + Rs @r{source register} Rd @r{destination register} - imm @r{immediate data} + imm @r{immediate data} x:3 @r{a bit (as a number between 0 and 7)} d:8 @r{eight bit displacement from @code{pc}} d:16 @r{sixteen bit displacement from @code{Rs}} -add.b Rs,Rd biand #x:3,Rd -add.b #imm:8,Rd biand #x:3,@@Rd -add.w Rs,Rd biand #x:3,@@aa:8 -adds #1,Rd bild #x:3,Rd -adds #2,Rd bild #x:3,@@Rd -addx #imm:8,Rd bild #x:3,@@aa:8 -addx Rs,Rd bior #x:3,Rd -and #imm:8,Rd bior #x:3,@@Rd -and Rs,Rd bior #x:3,@@aa:8 -andc #imm:8,ccr bist #x:3,Rd -band #x:3,Rd bist #x:3,@@Rd -band #x:3,@@Rd bist #x:3,@@aa:8 -bra d:8 bixor #x:3,Rd -bt d:8 bixor #x:3,@@Rd -brn d:8 bixor #x:3,@@aa:8 -bf d:8 bld #x:3,Rd -bhi d:8 bld #x:3,@@Rd -bls d:8 bld #x:3,@@aa:8 -bcc d:8 bnot #x:3,Rd -bhs d:8 bnot #x:3,@@Rd -bcs d:8 bnot #x:3,@@aa:8 -blo d:8 bnot Rs,Rd -bne d:8 bnot Rs,@@Rd -beq d:8 bnot Rs,@@aa:8 -bvc d:8 bor #x:3,Rd -bvs d:8 bor #x:3,@@Rd -bpl d:8 bor #x:3,@@aa:8 -bmi d:8 bset #x:3,@@Rd -bge d:8 bset #x:3,@@aa:8 -blt d:8 bset Rs,Rd -bgt d:8 bset Rs,@@Rd -ble d:8 bset Rs,@@aa:8 -bclr #x:3,Rd bsr d:8 -bclr #x:3,@@Rd bst #x:3,Rd -bclr #x:3,@@aa:8 bst #x:3,@@Rd -bclr Rs,Rd bst #x:3,@@aa:8 -bclr Rs,@@Rd btst #x:3,Rd -@end group -@group -btst #x:3,@@Rd mov.w @@(d:16, Rs),Rd -btst #x:3,@@aa:8 mov.w @@Rs+,Rd -btst Rs,Rd mov.w @@aa:16,Rd -btst Rs,@@Rd mov.w Rs,@@Rd -btst Rs,@@aa:8 mov.w Rs,@@(d:16, Rd) -bxor #x:3,Rd mov.w Rs,@@-Rd -bxor #x:3,@@Rd mov.w Rs,@@aa:16 -bxor #x:3,@@aa:8 movfpe @@aa:16,Rd -cmp.b #imm:8,Rd movtpe Rs,@@aa:16 -cmp.b Rs,Rd mulxu Rs,Rd -cmp.w Rs,Rd neg Rs -daa Rs nop -das Rs not Rs -dec Rs or #imm:8,Rd -divxu Rs,Rd or Rs,Rd -eepmov orc #imm:8,ccr -inc Rs pop Rs -jmp @@Rs push Rs -jmp @@aa:16 rotl Rs -jmp @@@@aa rotr Rs -jsr @@Rs rotxl Rs -jsr @@aa:16 rotxr Rs -jsr @@@@aa:8 rte -ldc #imm:8,ccr rts -ldc Rs,ccr shal Rs -mov.b Rs,Rd shar Rs -mov.b #imm:8,Rd shll Rs -mov.b @@Rs,Rd shlr Rs -mov.b @@(d:16, Rs),Rd sleep -mov.b @@Rs+,Rd stc ccr,Rd -mov.b @@aa:16,Rd sub.b Rs,Rd -mov.b @@aa:8,Rd sub.w Rs,Rd -mov.b Rs,@@Rd subs #1,Rd -mov.b Rs,@@(d:16, Rd) subs #2,Rd -mov.b Rs,@@-Rd subx #imm:8,Rd -mov.b Rs,@@aa:16 subx Rs,Rd -mov.b Rs,@@aa:8 xor #imm:8,Rd -mov.w Rs,Rd xor Rs,Rd -mov.w #imm:16,Rd xorc #imm:8,ccr +add.b Rs,Rd biand #x:3,Rd +add.b #imm:8,Rd biand #x:3,@@Rd +add.w Rs,Rd biand #x:3,@@aa:8 +adds #1,Rd bild #x:3,Rd +adds #2,Rd bild #x:3,@@Rd +addx #imm:8,Rd bild #x:3,@@aa:8 +addx Rs,Rd bior #x:3,Rd +and #imm:8,Rd bior #x:3,@@Rd +and Rs,Rd bior #x:3,@@aa:8 +andc #imm:8,ccr bist #x:3,Rd +band #x:3,Rd bist #x:3,@@Rd +band #x:3,@@Rd bist #x:3,@@aa:8 +bra d:8 bixor #x:3,Rd +bt d:8 bixor #x:3,@@Rd +brn d:8 bixor #x:3,@@aa:8 +bf d:8 bld #x:3,Rd +bhi d:8 bld #x:3,@@Rd +bls d:8 bld #x:3,@@aa:8 +bcc d:8 bnot #x:3,Rd +bhs d:8 bnot #x:3,@@Rd +bcs d:8 bnot #x:3,@@aa:8 +blo d:8 bnot Rs,Rd +bne d:8 bnot Rs,@@Rd +beq d:8 bnot Rs,@@aa:8 +bvc d:8 bor #x:3,Rd +bvs d:8 bor #x:3,@@Rd +bpl d:8 bor #x:3,@@aa:8 +bmi d:8 bset #x:3,@@Rd +bge d:8 bset #x:3,@@aa:8 +blt d:8 bset Rs,Rd +bgt d:8 bset Rs,@@Rd +ble d:8 bset Rs,@@aa:8 +bclr #x:3,Rd bsr d:8 +bclr #x:3,@@Rd bst #x:3,Rd +bclr #x:3,@@aa:8 bst #x:3,@@Rd +bclr Rs,Rd bst #x:3,@@aa:8 +bclr Rs,@@Rd btst #x:3,Rd +@c @end group +@page +@c @group +btst #x:3,@@Rd mov.w @@(d:16, Rs),Rd +btst #x:3,@@aa:8 mov.w @@Rs+,Rd +btst Rs,Rd mov.w @@aa:16,Rd +btst Rs,@@Rd mov.w Rs,@@Rd +btst Rs,@@aa:8 mov.w Rs,@@(d:16, Rd) +bxor #x:3,Rd mov.w Rs,@@-Rd +bxor #x:3,@@Rd mov.w Rs,@@aa:16 +bxor #x:3,@@aa:8 movfpe @@aa:16,Rd +cmp.b #imm:8,Rd movtpe Rs,@@aa:16 +cmp.b Rs,Rd mulxu Rs,Rd +cmp.w Rs,Rd neg Rs +daa Rs nop +das Rs not Rs +dec Rs or #imm:8,Rd +divxu Rs,Rd or Rs,Rd +eepmov orc #imm:8,ccr +inc Rs pop Rs +jmp @@Rs push Rs +jmp @@aa:16 rotl Rs +jmp @@@@aa rotr Rs +jsr @@Rs rotxl Rs +jsr @@aa:16 rotxr Rs +jsr @@@@aa:8 rte +ldc #imm:8,ccr rts +ldc Rs,ccr shal Rs +mov.b Rs,Rd shar Rs +mov.b #imm:8,Rd shll Rs +mov.b @@Rs,Rd shlr Rs +mov.b @@(d:16, Rs),Rd sleep +mov.b @@Rs+,Rd stc ccr,Rd +mov.b @@aa:16,Rd sub.b Rs,Rd +mov.b @@aa:8,Rd sub.w Rs,Rd +mov.b Rs,@@Rd subs #1,Rd +mov.b Rs,@@(d:16, Rd) subs #2,Rd +mov.b Rs,@@-Rd subx #imm:8,Rd +mov.b Rs,@@aa:16 subx Rs,Rd +mov.b Rs,@@aa:8 xor #imm:8,Rd +mov.w Rs,Rd xor Rs,Rd +mov.w #imm:16,Rd xorc #imm:8,ccr mov.w @@Rs,Rd -@end group +@c @end group @end smallexample @cindex size suffixes, H8/300 @cindex H8/300 size suffixes Four H8/300 instructions (@code{add}, @code{cmp}, @code{mov}, @code{sub}) are defined with variants using the suffixes @samp{.b} and -@samp{.w} to specify the size of a memory operand. @code{_AS__} +@samp{.w} to specify the size of a memory operand. @code{@value{AS}} supports these suffixes, but does not require them; since one of the -operands is always a register, @code{_AS__} can deduce the correct size. +operands is always a register, @code{@value{AS}} can deduce the correct size. -For example, since @code{r0} refers to a 16-bit register, +For example, since @code{r0} refers to a 16-bit register, @example mov r0,@@foo @exdent is equivalent to mov.w r0,@@foo @end example -If you use the size suffixes, @code{_AS__} will issue a warning if +If you use the size suffixes, @code{@value{AS}} will issue a warning if there's a mismatch between the suffix and the register size. +@end ifset + +@ifset H8/500 +@page +@node H8/500-Dependent +@chapter H8/500 Dependent Features + +@cindex H8/500 support +@menu +* H8/500 Options:: Options +* H8/500 Syntax:: Syntax +* H8/500 Floating Point:: Floating Point +* H8/500 Directives:: H8/500 Machine Directives +* H8/500 Opcodes:: Opcodes +@end menu + +@node H8/500 Options +@section Options + +@cindex H8/500 options (none) +@cindex options, H8/500 (none) +@code{@value{AS}} has no additional command-line options for the Hitachi +H8/500 family. + +@node H8/500 Syntax +@section Syntax + +@menu +* H8/500-Chars:: Special Characters +* H8/500-Regs:: Register Names +* H8/500-Addressing:: Addressing Modes +@end menu + +@node H8/500-Chars +@subsection Special Characters + +@cindex line comment character, H8/500 +@cindex H8/500 line comment character +@samp{!} is the line comment character. + +@cindex line separator, H8/500 +@cindex statement separator, H8/500 +@cindex H8/500 line separator +@samp{;} can be used instead of a newline to separate statements. + +@cindex symbol names, @samp{$} in +@cindex @code{$} in symbol names +Since @samp{$} has no special meaning, you may use it in symbol names. + +@node H8/500-Regs +@subsection Register Names + +@cindex H8/500 registers +@cindex registers, H8/500 +You can use the predefined symbols @samp{r0}, @samp{r1}, @samp{r2}, +@samp{r3}, @samp{r4}, @samp{r5}, @samp{r6}, and @samp{r7} to refer to +the H8/500 registers. + +The H8/500 also has these control registers: -_fi__(_H8__) -_if__(_I960__) -_if__(_GENERIC__) +@table @code +@item cp +code pointer + +@item dp +data pointer + +@item bp +base pointer + +@item tp +stack top pointer + +@item ep +extra pointer + +@item sr +status register + +@item ccr +condition code register +@end table + +All registers are 16 bits long. To represent 32 bit numbers, use two +adjacent registers; for distant memory addresses, use one of the segment +pointers (@code{cp} for the program counter; @code{dp} for +@code{r0}--@code{r3}; @code{ep} for @code{r4} and @code{r5}; and +@code{tp} for @code{r6} and @code{r7}. + +@node H8/500-Addressing +@subsection Addressing Modes + +@cindex addressing modes, H8/500 +@cindex H8/500 addressing modes +@value{AS} understands the following addressing modes for the H8/500: +@table @code +@item R@var{n} +Register direct + +@item @@R@var{n} +Register indirect + +@item @@(d:8, R@var{n}) +Register indirect with 8 bit signed displacement + +@item @@(d:16, R@var{n}) +Register indirect with 16 bit signed displacement + +@item @@-R@var{n} +Register indirect with pre-decrement + +@item @@R@var{n}+ +Register indirect with post-increment + +@item @@@var{aa}:8 +8 bit absolute address + +@item @@@var{aa}:16 +16 bit absolute address + +@item #@var{xx}:8 +8 bit immediate + +@item #@var{xx}:16 +16 bit immediate +@end table + +@node H8/500 Floating Point +@section Floating Point + +@cindex floating point, H8/500 (@sc{ieee}) +@cindex H8/500 floating point (@sc{ieee}) +The H8/500 family uses @sc{ieee} floating-point numbers. + +@node H8/500 Directives +@section H8/500 Machine Directives + +@cindex H8/500 machine directives (none) +@cindex machine directives, H8/500 (none) +@cindex @code{word} directive, H8/500 +@cindex @code{int} directive, H8/500 +@code{@value{AS}} has no machine-dependent directives for the H8/500. +However, on this platform the @samp{.int} and @samp{.word} directives +generate 16-bit numbers. + +@node H8/500 Opcodes +@section Opcodes + +@cindex H8/500 opcode summary +@cindex opcode summary, H8/500 +@cindex mnemonics, H8/500 +@cindex instruction summary, H8/500 +For detailed information on the H8/500 machine instruction set, see +@cite{H8/500 Series Programming Manual} (Hitachi M21T001). + +@code{@value{AS}} implements all the standard H8/500 opcodes. No additional +pseudo-instructions are needed on this family. + +The following table summarizes H8/500 opcodes and their operands: + +@c Use @group if it ever works, instead of @page +@page +@smallexample +@i{Legend:} +abs8 @r{8-bit absolute address} +abs16 @r{16-bit absolute address} +abs24 @r{24-bit absolute address} +crb @r{@code{ccr}, @code{br}, @code{ep}, @code{dp}, @code{tp}, @code{dp}} +disp8 @r{8-bit displacement} +ea @r{@code{rn}, @code{@@rn}, @code{@@(d:8, rn)}, @code{@@(d:16, rn)},} + @r{@code{@@-rn}, @code{@@rn+}, @code{@@aa:8}, @code{@@aa:16},} + @r{@code{#xx:8}, @code{#xx:16}} +ea_mem @r{@code{@@rn}, @code{@@(d:8, rn)}, @code{@@(d:16, rn)},} + @r{@code{@@-rn}, @code{@@rn+}, @code{@@aa:8}, @code{@@aa:16}} +ea_noimm @r{@code{rn}, @code{@@rn}, @code{@@(d:8, rn)}, @code{@@(d:16, rn)},} + @r{@code{@@-rn}, @code{@@rn+}, @code{@@aa:8}, @code{@@aa:16}} +fp r6 +imm4 @r{4-bit immediate data} +imm8 @r{8-bit immediate data} +imm16 @r{16-bit immediate data} +pcrel8 @r{8-bit offset from program counter} +pcrel16 @r{16-bit offset from program counter} +qim @r{@code{-2}, @code{-1}, @code{1}, @code{2}} +rd @r{any register} +rs @r{a register distinct from rd} +rlist @r{comma-separated list of registers in parentheses;} + @r{register ranges @code{rd-rs} are allowed} +sp @r{stack pointer (@code{r7})} +sr @r{status register} +sz @r{size; @samp{.b} or @samp{.w}. If omitted, default @samp{.w}} + +ldc[.b] ea,crb bcc[.w] pcrel16 +ldc[.w] ea,sr bcc[.b] pcrel8 +add[:q] sz qim,ea_noimm bhs[.w] pcrel16 +add[:g] sz ea,rd bhs[.b] pcrel8 +adds sz ea,rd bcs[.w] pcrel16 +addx sz ea,rd bcs[.b] pcrel8 +and sz ea,rd blo[.w] pcrel16 +andc[.b] imm8,crb blo[.b] pcrel8 +andc[.w] imm16,sr bne[.w] pcrel16 +bpt bne[.b] pcrel8 +bra[.w] pcrel16 beq[.w] pcrel16 +bra[.b] pcrel8 beq[.b] pcrel8 +bt[.w] pcrel16 bvc[.w] pcrel16 +bt[.b] pcrel8 bvc[.b] pcrel8 +brn[.w] pcrel16 bvs[.w] pcrel16 +brn[.b] pcrel8 bvs[.b] pcrel8 +bf[.w] pcrel16 bpl[.w] pcrel16 +bf[.b] pcrel8 bpl[.b] pcrel8 +bhi[.w] pcrel16 bmi[.w] pcrel16 +bhi[.b] pcrel8 bmi[.b] pcrel8 +bls[.w] pcrel16 bge[.w] pcrel16 +bls[.b] pcrel8 bge[.b] pcrel8 +@page +blt[.w] pcrel16 mov[:g][.b] imm8,ea_mem +blt[.b] pcrel8 mov[:g][.w] imm16,ea_mem +bgt[.w] pcrel16 movfpe[.b] ea,rd +bgt[.b] pcrel8 movtpe[.b] rs,ea_noimm +ble[.w] pcrel16 mulxu sz ea,rd +ble[.b] pcrel8 neg sz ea +bclr sz imm4,ea_noimm nop +bclr sz rs,ea_noimm not sz ea +bnot sz imm4,ea_noimm or sz ea,rd +bnot sz rs,ea_noimm orc[.b] imm8,crb +bset sz imm4,ea_noimm orc[.w] imm16,sr +bset sz rs,ea_noimm pjmp abs24 +bsr[.b] pcrel8 pjmp @@rd +bsr[.w] pcrel16 pjsr abs24 +btst sz imm4,ea_noimm pjsr @@rd +btst sz rs,ea_noimm prtd imm8 +clr sz ea prtd imm16 +cmp[:e][.b] imm8,rd prts +cmp[:i][.w] imm16,rd rotl sz ea +cmp[:g].b imm8,ea_noimm rotr sz ea +cmp[:g][.w] imm16,ea_noimm rotxl sz ea +Cmp[:g] sz ea,rd rotxr sz ea +dadd rs,rd rtd imm8 +divxu sz ea,rd rtd imm16 +dsub rs,rd rts +exts[.b] rd scb/f rs,pcrel8 +extu[.b] rd scb/ne rs,pcrel8 +jmp @@rd scb/eq rs,pcrel8 +jmp @@(imm8,rd) shal sz ea +jmp @@(imm16,rd) shar sz ea +jmp abs16 shll sz ea +jsr @@rd shlr sz ea +jsr @@(imm8,rd) sleep +jsr @@(imm16,rd) stc[.b] crb,ea_noimm +jsr abs16 stc[.w] sr,ea_noimm +ldm @@sp+,(rlist) stm (rlist),@@-sp +link fp,imm8 sub sz ea,rd +link fp,imm16 subs sz ea,rd +mov[:e][.b] imm8,rd subx sz ea,rd +mov[:i][.w] imm16,rd swap[.b] rd +mov[:l][.w] abs8,rd tas[.b] ea +mov[:l].b abs8,rd trapa imm4 +mov[:s][.w] rs,abs8 trap/vs +mov[:s].b rs,abs8 tst sz ea +mov[:f][.w] @@(disp8,fp),rd unlk fp +mov[:f][.w] rs,@@(disp8,fp) xch[.w] rs,rd +mov[:f].b @@(disp8,fp),rd xor sz ea,rd +mov[:f].b rs,@@(disp8,fp) xorc.b imm8,crb +mov[:g] sz rs,ea_mem xorc.w imm16,sr +mov[:g] sz ea,rd +@end smallexample + +@end ifset +@c start Hitachi-SH +@ifset SH +@page +@node SH-Dependent +@chapter Hitachi SH Dependent Features + +@cindex SH support +@menu +* SH Options:: Options +* SH Syntax:: Syntax +* SH Floating Point:: Floating Point +* SH Directives:: SH Machine Directives +* SH Opcodes:: Opcodes +@end menu + +@node SH Options +@section Options + +@cindex SH options (none) +@cindex options, SH (none) +@code{@value{AS}} has no additional command-line options for the Hitachi +SH family. + +@node SH Syntax +@section Syntax + +@menu +* SH-Chars:: Special Characters +* SH-Regs:: Register Names +* SH-Addressing:: Addressing Modes +@end menu + +@node SH-Chars +@subsection Special Characters + +@cindex line comment character, SH +@cindex SH line comment character +@samp{!} is the line comment character. + +@cindex line separator, SH +@cindex statement separator, SH +@cindex SH line separator +You can use @samp{;} instead of a newline to separate statements. + +@cindex symbol names, @samp{$} in +@cindex @code{$} in symbol names +Since @samp{$} has no special meaning, you may use it in symbol names. + +@node SH-Regs +@subsection Register Names + +@cindex SH registers +@cindex registers, SH +You can use the predefined symbols @samp{r0}, @samp{r1}, @samp{r2}, +@samp{r3}, @samp{r4}, @samp{r5}, @samp{r6}, @samp{r7}, @samp{r8}, +@samp{r9}, @samp{r10}, @samp{r11}, @samp{r12}, @samp{r13}, @samp{r14}, +and @samp{r15} to refer to the SH registers. + +The SH also has these control registers: + +@table @code +@item pr +procedure register (holds return address) + +@item pc +program counter + +@item mach +@itemx macl +high and low multiply accumulator registers + +@item sr +status register + +@item gbr +global base register + +@item vbr +vector base register (for interrupt vectors) +@end table + +@node SH-Addressing +@subsection Addressing Modes + +@cindex addressing modes, SH +@cindex SH addressing modes +@code{@value{AS}} understands the following addressing modes for the SH. +@code{R@var{n}} in the following refers to any of the numbered +registers, but @emph{not} the control registers. + +@table @code +@item R@var{n} +Register direct + +@item @@R@var{n} +Register indirect + +@item @@-R@var{n} +Register indirect with pre-decrement + +@item @@R@var{n}+ +Register indirect with post-increment + +@item @@(@var{disp}, R@var{n}) +Register indirect with displacement + +@item @@(R0, R@var{n}) +Register indexed + +@item @@(@var{disp}, GBR) +@code{GBR} offset + +@item @@(R0, GBR) +GBR indexed + +@item @var{addr} +@itemx @@(@var{disp}, PC) +PC relative address (for branch or for addressing memory). The +@code{@value{AS}} implementation allows you to use the simpler form +@var{addr} anywhere a PC relative address is called for; the alternate +form is supported for compatibility with other assemblers. + +@item #@var{imm} +Immediate data +@end table + +@node SH Floating Point +@section Floating Point + +@cindex floating point, SH (@sc{ieee}) +@cindex SH floating point (@sc{ieee}) +The SH family uses @sc{ieee} floating-point numbers. + +@node SH Directives +@section SH Machine Directives + +@cindex SH machine directives (none) +@cindex machine directives, SH (none) +@cindex @code{word} directive, SH +@cindex @code{int} directive, SH +@code{@value{AS}} has no machine-dependent directives for the SH. + +@node SH Opcodes +@section Opcodes + +@cindex SH opcode summary +@cindex opcode summary, SH +@cindex mnemonics, SH +@cindex instruction summary, SH +For detailed information on the SH machine instruction set, see +@cite{SH-Microcomputer User's Manual} (Hitachi Micro Systems, Inc.). + +@code{@value{AS}} implements all the standard SH opcodes. No additional +pseudo-instructions are needed on this family. Note, however, that +because @code{@value{AS}} supports a simpler form of PC-relative +addressing, you may simply write (for example) + +@example +mov.l bar,r0 +@end example + +@noindent +where other assemblers might require an explicit displacement to +@code{bar} from the program counter: + +@example +mov.l @@(@var{disp}, PC) +@end example + +Here is a summary of SH opcodes: + +@page +@smallexample +@i{Legend:} +Rn @r{a numbered register} +Rm @r{another numbered register} +#imm @r{immediate data} +disp @r{displacement} +disp8 @r{8-bit displacement} +disp12 @r{12-bit displacement} + +add #imm,Rn lds.l @@Rn+,PR +add Rm,Rn mac.w @@Rm+,@@Rn+ +addc Rm,Rn mov #imm,Rn +addv Rm,Rn mov Rm,Rn +and #imm,R0 mov.b Rm,@@(R0,Rn) +and Rm,Rn mov.b Rm,@@-Rn +and.b #imm,@@(R0,GBR) mov.b Rm,@@Rn +bf disp8 mov.b @@(disp,Rm),R0 +bra disp12 mov.b @@(disp,GBR),R0 +bsr disp12 mov.b @@(R0,Rm),Rn +bt disp8 mov.b @@Rm+,Rn +clrm mov.b @@Rm,Rn +clrt mov.b R0,@@(disp,Rm) +cmp/eq #imm,R0 mov.b R0,@@(disp,GBR) +cmp/eq Rm,Rn mov.l Rm,@@(disp,Rn) +cmp/ge Rm,Rn mov.l Rm,@@(R0,Rn) +cmp/gt Rm,Rn mov.l Rm,@@-Rn +cmp/hi Rm,Rn mov.l Rm,@@Rn +cmp/hs Rm,Rn mov.l @@(disp,Rn),Rm +cmp/pl Rn mov.l @@(disp,GBR),R0 +cmp/pz Rn mov.l @@(disp,PC),Rn +cmp/str Rm,Rn mov.l @@(R0,Rm),Rn +div0s Rm,Rn mov.l @@Rm+,Rn +div0u mov.l @@Rm,Rn +div1 Rm,Rn mov.l R0,@@(disp,GBR) +exts.b Rm,Rn mov.w Rm,@@(R0,Rn) +exts.w Rm,Rn mov.w Rm,@@-Rn +extu.b Rm,Rn mov.w Rm,@@Rn +extu.w Rm,Rn mov.w @@(disp,Rm),R0 +jmp @@Rn mov.w @@(disp,GBR),R0 +jsr @@Rn mov.w @@(disp,PC),Rn +ldc Rn,GBR mov.w @@(R0,Rm),Rn +ldc Rn,SR mov.w @@Rm+,Rn +ldc Rn,VBR mov.w @@Rm,Rn +ldc.l @@Rn+,GBR mov.w R0,@@(disp,Rm) +ldc.l @@Rn+,SR mov.w R0,@@(disp,GBR) +ldc.l @@Rn+,VBR mova @@(disp,PC),R0 +lds Rn,MACH movt Rn +lds Rn,MACL muls Rm,Rn +lds Rn,PR mulu Rm,Rn +lds.l @@Rn+,MACH neg Rm,Rn +lds.l @@Rn+,MACL negc Rm,Rn +@page +nop stc VBR,Rn +not Rm,Rn stc.l GBR,@@-Rn +or #imm,R0 stc.l SR,@@-Rn +or Rm,Rn stc.l VBR,@@-Rn +or.b #imm,@@(R0,GBR) sts MACH,Rn +rotcl Rn sts MACL,Rn +rotcr Rn sts PR,Rn +rotl Rn sts.l MACH,@@-Rn +rotr Rn sts.l MACL,@@-Rn +rte sts.l PR,@@-Rn +rts sub Rm,Rn +sett subc Rm,Rn +shal Rn subv Rm,Rn +shar Rn swap.b Rm,Rn +shll Rn swap.w Rm,Rn +shll16 Rn tas.b @@Rn +shll2 Rn trapa #imm +shll8 Rn tst #imm,R0 +shlr Rn tst Rm,Rn +shlr16 Rn tst.b #imm,@@(R0,GBR) +shlr2 Rn xor #imm,R0 +shlr8 Rn xor Rm,Rn +sleep xor.b #imm,@@(R0,GBR) +stc GBR,Rn xtrct Rm,Rn +stc SR,Rn +@end smallexample + +@ifset Hitachi-all +@ifclear GENERIC +@up +@end ifclear +@end ifset + +@end ifset +@c end Hitachi-SH +@ifset I960 +@ifset GENERIC +@page @node i960-Dependent -_fi__(_GENERIC__) -_CHAPSEC__(0+_GENERIC__) Intel 80960 Dependent Features +@chapter Intel 80960 Dependent Features +@end ifset +@ifclear GENERIC +@node Machine Dependencies +@chapter Intel 80960 Dependent Features +@end ifclear @cindex i960 support @menu @@ -4224,7 +4973,7 @@ _CHAPSEC__(0+_GENERIC__) Intel 80960 Dependent Features @node Options-i960 -_CHAPSEC__(1+_GENERIC__) i960 Command-line Options +@section i960 Command-line Options @cindex i960 options @cindex options, i960 @@ -4240,13 +4989,13 @@ by the selected architecture cause fatal errors. @samp{-ACA} is equivalent to @samp{-ACA_A}; @samp{-AKC} is equivalent to @samp{-AMC}. Synonyms are provided for compatibility with other tools. -If none of these options is specified, @code{_AS__} will generate code for any +If none of these options is specified, @code{@value{AS}} will generate code for any instruction or feature that is supported by @emph{some} version of the 960 (even if this means mixing architectures!). In principle, -@code{_AS__} will attempt to deduce the minimal sufficient processor +@code{@value{AS}} will attempt to deduce the minimal sufficient processor type if none is specified; depending on the object code format, the processor type may be recorded in the object file. If it is critical -that the @code{_AS__} output match a specific architecture, specify that +that the @code{@value{AS}} output match a specific architecture, specify that architecture explicitly. @item -b @@ -4320,7 +5069,7 @@ Normally, Compare-and-Branch instructions with targets that require displacements greater than 13 bits (or that have external targets) are replaced with the corresponding compare (or @samp{chkbit}) and branch instructions. You can use the @samp{-norelax} option to specify that -@code{_AS__} should generate errors instead, if the target displacement +@code{@value{AS}} should generate errors instead, if the target displacement is larger than 13 bits. This option does not affect the Compare-and-Jump instructions; the code @@ -4329,15 +5078,15 @@ displacement size), regardless of whether you use @samp{-norelax}. @end table @node Floating Point-i960 -_CHAPSEC__(1+_GENERIC__) Floating Point +@section Floating Point @cindex floating point, i960 (@sc{ieee}) @cindex i960 floating point (@sc{ieee}) -@code{_AS__} generates @sc{ieee} floating-point numbers for the directives +@code{@value{AS}} generates @sc{ieee} floating-point numbers for the directives @samp{.float}, @samp{.double}, @samp{.extended}, and @samp{.single}. @node Directives-i960 -_CHAPSEC__(1+_GENERIC__) i960 Machine Directives +@section i960 Machine Directives @cindex machine directives, i960 @cindex i960 machine directives @@ -4391,7 +5140,7 @@ Both arguments are required; @var{index} must be between 0 and 31 @end table @node Opcodes for i960 -_CHAPSEC__(1+_GENERIC__) i960 Opcodes +@section i960 Opcodes @cindex opcodes, i960 @cindex i960 opcodes @@ -4410,7 +5159,7 @@ instructions with target displacements larger than 13 bits. @end menu @node callj-i960 -_CHAPSEC__(2+_GENERIC__) @code{callj} +@subsection @code{callj} @cindex @code{callj}, i960 pseudo-opcode @cindex i960 @code{callj} pseudo-opcode @@ -4418,12 +5167,12 @@ You can write @code{callj} to have the assembler or the linker determine the most appropriate form of subroutine call: @samp{call}, @samp{bal}, or @samp{calls}. If the assembly source contains enough information---a @samp{.leafproc} or @samp{.sysproc} directive -defining the operand---then @code{_AS__} will translate the +defining the operand---then @code{@value{AS}} will translate the @code{callj}; if not, it will simply emit the @code{callj}, leaving it for the linker to resolve. @node Compare-and-branch-i960 -_CHAPSEC__(2+_GENERIC__) Compare-and-Branch +@subsection Compare-and-Branch @cindex i960 compare/branch instructions @cindex compare/branch instructions, i960 @@ -4436,13 +5185,13 @@ into separate instructions to do the compare and the branch. @cindex compare and jump expansions, i960 @cindex i960 compare and jump expansions -Whether @code{_AS__} gives an error or expands the instruction depends +Whether @code{@value{AS}} gives an error or expands the instruction depends on two choices you can make: whether you use the @samp{-norelax} option, and whether you use a ``Compare and Branch'' instruction or a ``Compare and Jump'' instruction. The ``Jump'' instructions are @emph{always} expanded if necessary; the ``Branch'' instructions are expanded when necessary @emph{unless} you specify @code{-norelax}---in which case -@code{_AS__} gives an error instead. +@code{@value{AS}} gives an error instead. These are the Compare-and-Branch instructions, their ``Jump'' variants, and the instruction pairs they may expand into: @@ -4496,13 +5245,18 @@ and the instruction pairs they may expand into: cmpobne& cmpojne& cmpo; bne\cr} @end tex @c END TEXI2ROFF-KILL -_fi__(_I960__) +@end ifset -_if__(_M680X0__) -_if__(_GENERIC__) +@ifset M680X0 +@ifset GENERIC +@page @node M68K-Dependent -_fi__(_GENERIC__) -_CHAPSEC__(0+_GENERIC__) M680x0 Dependent Features +@chapter M680x0 Dependent Features +@end ifset +@ifclear GENERIC +@node Machine Dependencies +@chapter M680x0 Dependent Features +@end ifclear @cindex M680x0 support @menu @@ -4514,21 +5268,21 @@ _CHAPSEC__(0+_GENERIC__) M680x0 Dependent Features @end menu @node M68K-Opts -_CHAPSEC__(1+_GENERIC__) M680x0 Options +@section M680x0 Options @cindex options, M680x0 @cindex M680x0 options -The Motorola 680x0 version of @code{_AS__} has two machine dependent options. +The Motorola 680x0 version of @code{@value{AS}} has two machine dependent options. One shortens undefined references from 32 to 16 bits, while the -other is used to tell @code{_AS__} what kind of machine it is +other is used to tell @code{@value{AS}} what kind of machine it is assembling for. @cindex @code{-l} option, M680x0 You can use the @kbd{-l} option to shorten the size of references to undefined symbols. If the @kbd{-l} option is not given, references to -undefined symbols will be a full long (32 bits) wide. (Since @code{_AS__} -cannot know where these symbols will end up, @code{_AS__} can only allocate -space for the linker to fill in later. Since @code{_AS__} doesn't know how +undefined symbols will be a full long (32 bits) wide. (Since @code{@value{AS}} +cannot know where these symbols will end up, @code{@value{AS}} can only allocate +space for the linker to fill in later. Since @code{@value{AS}} doesn't know how far away these symbols will be, it allocates as much space as it can.) If this option is given, the references will only be one word wide (16 bits). This may be useful if you want the object file to be as small as @@ -4538,30 +5292,30 @@ bits away. @cindex @code{-m68000} and related options @cindex architecture options, M680x0 @cindex M680x0 architecture options -The 680x0 version of @code{_AS__} is most frequently used to assemble +The 680x0 version of @code{@value{AS}} is most frequently used to assemble programs for the Motorola MC68020 microprocessor. Occasionally it is used to assemble programs for the mostly similar, but slightly different -MC68000 or MC68010 microprocessors. You can give @code{_AS__} the options +MC68000 or MC68010 microprocessors. You can give @code{@value{AS}} the options @samp{-m68000}, @samp{-mc68000}, @samp{-m68010}, @samp{-mc68010}, @samp{-m68020}, and @samp{-mc68020} to tell it what processor is the target. @node M68K-Syntax -_CHAPSEC__(1+_GENERIC__) Syntax +@section Syntax @cindex M680x0 syntax @cindex syntax, M680x0 @cindex M680x0 size modifiers @cindex size modifiers, M680x0 -The 680x0 version of @code{_AS__} uses syntax similar to the Sun assembler. +The 680x0 version of @code{@value{AS}} uses syntax similar to the Sun assembler. Size modifiers are appended directly to the end of the opcode without an intervening period. For example, write @samp{movl} rather than @samp{move.l}. -_if__(_INTERNALS__) -If @code{_AS__} is compiled with SUN_ASM_SYNTAX defined, it will also allow +@ifset INTERNALS +If @code{@value{AS}} is compiled with SUN_ASM_SYNTAX defined, it will also allow Sun-style local labels of the form @samp{1$} through @samp{$9}. -_fi__(_INTERNALS__) +@end ifset In the following table @dfn{apc} stands for any of the address registers (@samp{a0} through @samp{a7}), nothing, (@samp{}), the @@ -4622,7 +5376,7 @@ by @samp{:b}, @samp{:w}, or @samp{:l}. @end table @node M68K-Float -_CHAPSEC__(1+_GENERIC__) Floating Point +@section Floating Point @cindex floating point, M680x0 @cindex M680x0 floating point @@ -4652,7 +5406,7 @@ directive to create extended precision numbers would not be hard, but it has not yet seemed necessary. @node M68K-Directives -_CHAPSEC__(1+_GENERIC__) 680x0 Machine Directives +@section 680x0 Machine Directives @cindex M680x0 directives @cindex directives, M680x0 @@ -4679,7 +5433,7 @@ This directive is identical to a @code{.space} directive. @end table @node M68K-opcodes -_CHAPSEC__(1+_GENERIC__) Opcodes +@section Opcodes @cindex M680x0 opcodes @cindex opcodes, M680x0 @@ -4699,7 +5453,7 @@ instructions. @end menu @node M68K-Branch -_CHAPSEC__(2+_GENERIC__) Branch Improvement +@subsection Branch Improvement @cindex pseudo-opcodes, M680x0 @cindex M680x0 pseudo-opcodes @@ -4748,7 +5502,7 @@ list of pseudo-ops in this family is: @end smallexample For the cases of non-PC relative displacements and long displacements on -the 68000 or 68010, @code{_AS__} will issue a longer code fragment in terms of +the 68000 or 68010, @code{@value{AS}} will issue a longer code fragment in terms of @var{NX}, the opposite condition to @var{XX}. For example, for the non-PC relative case: @smallexample @@ -4770,7 +5524,7 @@ The full family of pseudo-operations covered here is @end smallexample Other than for word and byte displacements, when the source reads -@samp{db@var{XX} foo}, @code{_AS__} will emit +@samp{db@var{XX} foo}, @code{@value{AS}} will emit @smallexample db@var{XX} oo1 bra oo2 @@ -4788,7 +5542,7 @@ This family includes fjugt fjule fjult fjun @end smallexample -For branch targets that are not PC relative, @code{_AS__} emits +For branch targets that are not PC relative, @code{@value{AS}} emits @smallexample fb@var{NX} oof jmp foo @@ -4799,7 +5553,7 @@ when it encounters @samp{fj@var{XX} foo}. @end table @node M68K-Chars -_CHAPSEC__(2+_GENERIC__) Special Characters +@subsection Special Characters @cindex special characters, M680x0 @cindex M680x0 immediate character @@ -4812,36 +5566,43 @@ line-comment character is @samp{|}. If a @samp{#} appears at the beginning of a line, it is treated as a comment unless it looks like @samp{# line file}, in which case it is treated normally. -_fi__(_M680X0__) -_if__(0) -@c pesch@cygnus.com: conditionalize on something other than 0 when filled in. -@section 32x32 +@end ifset +@ignore +@c FIXME! Stop ignoring when filled in. +@node 32x32 +@chapter 32x32 + @section Options -The 32x32 version of @code{_AS__} accepts a @kbd{-m32032} option to +The 32x32 version of @code{@value{AS}} accepts a @kbd{-m32032} option to specify thiat it is compiling for a 32032 processor, or a @kbd{-m32532} to specify that it is compiling for a 32532 option. The default (if neither is specified) is chosen when the assembler is compiled. -@subsection Syntax +@section Syntax I don't know anything about the 32x32 syntax assembled by -@code{_AS__}. Someone who undersands the processor (I've never seen +@code{@value{AS}}. Someone who undersands the processor (I've never seen one) and the possible syntaxes should write this section. -@subsection Floating Point -The 32x32 uses @sc{ieee} floating point numbers, but @code{_AS__} will only -create single or double precision values. I don't know if the 32x32 -understands extended precision numbers. +@section Floating Point +The 32x32 uses @sc{ieee} floating point numbers, but @code{@value{AS}} +will only create single or double precision values. I don't know if the +32x32 understands extended precision numbers. -@subsection 32x32 Machine Directives +@section 32x32 Machine Directives The 32x32 has no machine dependent directives. -_fi__(0) -_if__(_SPARC__) -_if__(_GENERIC__) +@end ignore +@ifset SPARC +@ifset GENERIC +@page @node Sparc-Dependent -_fi__(_GENERIC__) -_CHAPSEC__(0+_GENERIC__) SPARC Dependent Features +@chapter SPARC Dependent Features +@end ifset +@ifclear GENERIC +@node Machine Dependencies +@chapter SPARC Dependent Features +@end ifclear @cindex SPARC support @menu @@ -4851,11 +5612,36 @@ _CHAPSEC__(0+_GENERIC__) SPARC Dependent Features @end menu @node Sparc-Opts -_CHAPSEC__(1+_GENERIC__) Options +@section Options + +@cindex options for SPARC +@cindex SPARC options +@cindex architectures, SPARC +@cindex SPARC architectures +The SPARC chip family includes several successive levels (or other +variants) of chip, using the same core instruction set, but including +a few additional instructions at each level. -@cindex options for SPARC (none) -@cindex SPARC options (none) -The Sparc has no machine dependent options. +By default, @code{@value{AS}} assumes the core instruction set (SPARC +v6), but ``bumps'' the architecture level as needed: it switches to +successively higher architectures as it encounters instructions that +only exist in the higher levels. + +@table @code +@item -Av6 | -Av7 | -Av8 | -Asparclite +@kindex -Av6 +@kindex Av7 +@kindex -Av8 +@kindex -Asparclite +Use one of the @samp{-A} options to select one of the SPARC +architectures explicitly. If you select an architecture explicitly, +@code{@value{AS}} reports a fatal error if it encounters an instruction +or feature requiring a higher level. + +@item -bump +Permit the assembler to ``bump'' the architecture level as required, but +warn whenever it is necessary to switch to another level. +@end table @ignore @c FIXME: (sparc) Fill in "syntax" section! @@ -4865,18 +5651,18 @@ will have to write this section. @end ignore @node Sparc-Float -_CHAPSEC__(1+_GENERIC__) Floating Point +@section Floating Point @cindex floating point, SPARC (@sc{ieee}) @cindex SPARC floating point (@sc{ieee}) The Sparc uses @sc{ieee} floating-point numbers. @node Sparc-Directives -_CHAPSEC__(1+_GENERIC__) Sparc Machine Directives +@section Sparc Machine Directives @cindex SPARC machine directives @cindex machine directives, SPARC -The Sparc version of @code{_AS__} supports the following additional +The Sparc version of @code{@value{AS}} supports the following additional machine directives: @table @code @@ -4917,12 +5703,17 @@ On the Sparc, the .word directive produces 32 bit values, instead of the 16 bit values it produces on many other machines. @end table -_fi__(_SPARC__) -_if__(_I80386__) -_if__(_GENERIC__) +@end ifset +@ifset I80386 +@ifset GENERIC +@page @node i386-Dependent -_fi__(_GENERIC__) -_CHAPSEC__(0+_GENERIC__) 80386 Dependent Features +@chapter 80386 Dependent Features +@end ifset +@ifclear GENERIC +@node Machine Dependencies +@chapter 80386 Dependent Features +@end ifclear @cindex i386 support @cindex i80306 support @@ -4939,19 +5730,19 @@ _CHAPSEC__(0+_GENERIC__) 80386 Dependent Features @end menu @node i386-Options -_CHAPSEC__(1+_GENERIC__) Options +@section Options @cindex options for i386 (none) @cindex i386 options (none) The 80386 has no machine dependent options. @node i386-Syntax -_CHAPSEC__(1+_GENERIC__) AT&T Syntax versus Intel Syntax +@section AT&T Syntax versus Intel Syntax @cindex i386 syntax compatibility @cindex syntax compatibility, i386 -In order to maintain compatibility with the output of @code{_GCC__}, -@code{_AS__} supports AT&T System V/386 assembler syntax. This is quite +In order to maintain compatibility with the output of @code{@value{GCC}}, +@code{@value{AS}} supports AT&T System V/386 assembler syntax. This is quite different from Intel syntax. We mention these differences because almost all 80386 documents used only Intel syntax. Notable differences between the two syntaxes are: @@ -5010,14 +5801,14 @@ programs. Unix style systems expect all programs to be single sections. @end itemize @node i386-Opcodes -_CHAPSEC__(1+_GENERIC__) Opcode Naming +@section Opcode Naming @cindex i386 opcode naming @cindex opcode naming, i386 Opcode names are suffixed with one character modifiers which specify the size of operands. The letters @samp{b}, @samp{w}, and @samp{l} specify byte, word, and long operands. If no suffix is specified by an -instruction and it contains no memory operands then @code{_AS__} tries to +instruction and it contains no memory operands then @code{@value{AS}} tries to fill in the missing suffix based on the destination register operand (the last one by convention). Thus, @samp{mov %ax, %bx} is equivalent to @samp{movw %ax, %bx}; also, @samp{mov $1, %bx} is equivalent to @@ -5059,7 +5850,7 @@ The Intel-syntax conversion instructions @noindent are called @samp{cbtw}, @samp{cwtl}, @samp{cwtd}, and @samp{cltd} in -AT&T naming. @code{_AS__} accepts either naming for these instructions. +AT&T naming. @code{@value{AS}} accepts either naming for these instructions. @cindex jump instructions, i386 @cindex call instructions, i386 @@ -5068,7 +5859,7 @@ AT&T syntax, but are @samp{call far} and @samp{jump far} in Intel convention. @node i386-Regs -_CHAPSEC__(1+_GENERIC__) Register Naming +@section Register Naming @cindex i386 registers @cindex registers, i386 @@ -5114,7 +5905,7 @@ the 8 floating point register stack @samp{%st} or equivalently @end itemize @node i386-prefixes -_CHAPSEC__(1+_GENERIC__) Opcode Prefixes +@section Opcode Prefixes @cindex i386 opcode prefixes @cindex opcode prefixes, i386 @@ -5168,7 +5959,7 @@ to string instructions to make them repeat @samp{%ecx} times. @end itemize @node i386-Memory -_CHAPSEC__(1+_GENERIC__) Memory References +@section Memory References @cindex i386 memory references @cindex memory references, i386 @@ -5195,7 +5986,7 @@ optional section register for the memory operand, and may override the default section register (see a 80386 manual for section register defaults). Note that section overrides in AT&T syntax @emph{must} have be preceded by a @samp{%}. If you specify a section override which -coincides with the default section register, @code{_AS__} will @emph{not} +coincides with the default section register, @code{@value{AS}} will @emph{not} output any section register override prefixes to assemble the given instruction. Thus, section overrides can be specified to emphasize which section register is used for a given memory operand. @@ -5224,7 +6015,7 @@ register @var{section} being @samp{%gs}. @end table Absolute (as opposed to PC relative) call and jump operands must be -prefixed with @samp{*}. If no @samp{*} is specified, @code{_AS__} will +prefixed with @samp{*}. If no @samp{*} is specified, @code{@value{AS}} will always choose PC relative addressing for jump/call labels. Any instruction that has a memory operand @emph{must} specify its size (byte, @@ -5232,7 +6023,7 @@ word, or long) with an opcode suffix (@samp{b}, @samp{w}, or @samp{l}, respectively). @node i386-jumps -_CHAPSEC__(1+_GENERIC__) Handling of Jump Instructions +@section Handling of Jump Instructions @cindex jump optimization, i386 @cindex i386 jump optimization @@ -5247,7 +6038,7 @@ with the @samp{addr16} opcode prefix), since the 80386 insists upon masking Note that the @samp{jcxz}, @samp{jecxz}, @samp{loop}, @samp{loopz}, @samp{loope}, @samp{loopnz} and @samp{loopne} instructions only come in byte displacements, so that it is possible that use of these -instructions (@code{_GCC__} does not use them) will cause the assembler to +instructions (@code{@value{GCC}} does not use them) will cause the assembler to print an error message (and generate incorrect code). The AT&T 80386 assembler tries to get around this problem by expanding @samp{jcxz foo} to @smallexample @@ -5258,7 +6049,7 @@ cx_nonzero: @end smallexample @node i386-Float -_CHAPSEC__(1+_GENERIC__) Floating Point +@section Floating Point @cindex i386 floating point @cindex floating point, i386 @@ -5303,7 +6094,7 @@ so that @samp{fst %st, %st(1)} is equivalent to @samp{fstl %st, %st(1)}. @cindex @code{fwait instruction}, i386 Since the 80387 automatically synchronizes with the 80386 @samp{fwait} instructions are almost never needed (this is not the case for the -80286/80287 and 8086/8087 combinations). Therefore, @code{_AS__} suppresses +80286/80287 and 8086/8087 combinations). Therefore, @code{@value{AS}} suppresses the @samp{fwait} instruction whenever it is implicitly selected by one of the @samp{fn@dots{}} instructions. For example, @samp{fsave} and @samp{fnsave} are treated identically. In general, all the @samp{fn@dots{}} @@ -5311,7 +6102,7 @@ instructions are made equivalent to @samp{f@dots{}} instructions. If @samp{fwait} is desired it must be explicitly coded. @node i386-Notes -_CHAPSEC__(1+_GENERIC__) Notes +@section Notes @cindex i386 @code{mul}, @code{imul} instructions @cindex @code{mul} instruction, i386 @@ -5322,7 +6113,7 @@ multiplies (base opcode @samp{0xf6}; extension 4 for @samp{mul} and 5 for @samp{imul}) can be output only in the one operand form. Thus, @samp{imul %ebx, %eax} does @emph{not} select the expanding multiply; the expanding multiply would clobber the @samp{%edx} register, and this -would confuse @code{_GCC__} output. Use @samp{imul %ebx} to get the +would confuse @code{@value{GCC}} output. Use @samp{imul %ebx} to get the 64-bit product in @samp{%edx:%eax}. We have added a two operand form of @samp{imul} when the first operand @@ -5331,15 +6122,20 @@ This is just a shorthand, so that, multiplying @samp{%eax} by 69, for example, can be done with @samp{imul $69, %eax} rather than @samp{imul $69, %eax, %eax}. -_fi__(_I80386__) -_if__(_Z8000__) -_if__(_GENERIC__) +@end ifset +@ifset Z8000 +@ifset GENERIC +@page @node Z8000-Dependent -_fi__(_GENERIC__) -_CHAPSEC__(0+_GENERIC__) Z8000 Dependent Features +@chapter Z8000 Dependent Features +@end ifset +@ifclear GENERIC +@node Machine Dependencies +@chapter Z8000 Dependent Features +@end ifclear @cindex Z8000 support -The Z8000 _AS__ supports both members of the Z8000 family: the +The Z8000 @value{AS} supports both members of the Z8000 family: the unsegmented Z8002, with 16 bit addresses, and the segmented Z8001 with 24 bit addresses. @@ -5358,15 +6154,15 @@ for a list of other Z8000 specific assembler directives. @end menu @node Z8000 Options -_CHAPSEC__(1+_GENERIC__) Options +@section Options @cindex Z8000 options @cindex options, Z8000 -@code{_AS__} has no additional command-line options for the Zilog +@code{@value{AS}} has no additional command-line options for the Zilog Z8000 family. @node Z8000 Syntax -_CHAPSEC__(1+_GENERIC__) Syntax +@section Syntax @menu * Z8000-Chars:: Special Characters * Z8000-Regs:: Register Names @@ -5374,7 +6170,7 @@ _CHAPSEC__(1+_GENERIC__) Syntax @end menu @node Z8000-Chars -_CHAPSEC__(2+_GENERIC__) Special Characters +@subsection Special Characters @cindex line comment character, Z8000 @cindex Z8000 line comment character @@ -5386,7 +6182,7 @@ _CHAPSEC__(2+_GENERIC__) Special Characters You can use @samp{;} instead of a newline to separate statements. @node Z8000-Regs -_CHAPSEC__(2+_GENERIC__) Register Names +@subsection Register Names @cindex Z8000 registers @cindex registers, Z8000 @@ -5399,7 +6195,7 @@ named @samp{r@var{n}h} and @samp{r@var{n}l}. @smallexample @exdent @emph{byte registers} -r0l r0h r1h r1l r2h r2l r3h r3l +r0l r0h r1h r1l r2h r2l r3h r3l r4h r4l r5h r5l r6h r6l r7h r7l @exdent @emph{word registers} @@ -5413,18 +6209,18 @@ rq0 rq4 rq8 rq12 @end smallexample @node Z8000-Addressing -_CHAPSEC__(2+_GENERIC__) Addressing Modes +@subsection Addressing Modes @cindex addressing modes, Z8000 @cindex Z800 addressing modes -_AS__ understands the following addressing modes for the Z8000: +@value{AS} understands the following addressing modes for the Z8000: @table @code @item r@var{n} Register direct @item @@r@var{n} -Indirect register +Indirect register @item @var{addr} Direct: the 16 bit or 24 bit address (depending on whether the assembler @@ -5449,13 +6245,13 @@ Immediate data @var{xx}. @end table @node Z8000 Directives -_CHAPSEC__(1+_GENERIC__) Assembler Directives for the Z8000 +@section Assembler Directives for the Z8000 @cindex Z8000 directives @cindex directives, Z8000 -The Z8000 port of _AS__ includes these additional assembler directives, +The Z8000 port of @value{AS} includes these additional assembler directives, for compatibility with other Z8000 assemblers. As shown, these do not -begin with @samp{.} (unlike the ordinary _AS__ directives). +begin with @samp{.} (unlike the ordinary @value{AS} directives). @table @code @item segm @@ -5504,9 +6300,9 @@ literals as themselves. For example, the C statement @w{@samp{char *a = @end iftex @smallexample 68652073 sval 'he said %22it%27s 50%25 off%22%00' -61696420 -22697427 -73203530 +61696420 +22697427 +73203530 25206F66 662200 @end smallexample @@ -5528,7 +6324,7 @@ synonym for @code{.align 1} @end table @node Z8000 Opcodes -_CHAPSEC__(1+_GENERIC__) Opcodes +@section Opcodes @cindex Z8000 opcode summary @cindex opcode summary, Z8000 @@ -5544,16 +6340,16 @@ The following table summarizes the opcodes and their arguments: @end iftex @smallexample - rs @r{16 bit source register} + rs @r{16 bit source register} rd @r{16 bit destination register} - rbs @r{8 bit source register} + rbs @r{8 bit source register} rbd @r{8 bit destination register} - rrs @r{32 bit source register} + rrs @r{32 bit source register} rrd @r{32 bit destination register} - rqs @r{64 bit source register} + rqs @r{64 bit source register} rqd @r{64 bit destination register} addr @r{16/24 bit address} - imm @r{immediate data} + imm @r{immediate data} adc rd,rs clrb addr cpsir @@rd,@@rs,rr,cc adcb rbd,rbs clrb addr(rd) cpsirb @@rd,@@rs,rr,cc @@ -5700,8 +6496,13 @@ set addr(rd),imm4 subl rrd,addr(rs) @endgroup @end iftex -_fi__(_Z8000__) -_if__(0) +@end ifset +@ifset GENERIC +@c reverse effect of @down at top of generic Machine-Dep chapter +@up +@end ifset + +@ignore @c pesch@cygnus.com: we ignore the following chapters, since internals are @c changing rapidly. These may need to be moved to another @c book anyhow, if we adopt the model of user/modifier @@ -5714,13 +6515,13 @@ _if__(0) We had these goals, in descending priority: @table @b @item Accuracy. -For every program composed by a compiler, @code{_AS__} should emit +For every program composed by a compiler, @code{@value{AS}} should emit ``correct'' code. This leaves some latitude in choosing addressing modes, order of @code{relocation_info} structures in the object file, @emph{etc}. @item Speed, for usual case. -By far the most common use of @code{_AS__} will be assembling compiler +By far the most common use of @code{@value{AS}} will be assembling compiler emissions. @item Upward compatibility for existing assembler code. @@ -5795,14 +6596,14 @@ interpret binary gobbledygook from a compiler's tables than to ask the compiler to write out human-readable code just so the assembler can parse it back to binary. -Assuming you use @code{_AS__} for human written programs: here are +Assuming you use @code{@value{AS}} for human written programs: here are some ideas: @itemize @bullet @item Document (here) @code{APP}. @item Take advantage of knowing no spaces except after opcode -to speed up @code{_AS__}. (Modify @code{app.c} to flush useless spaces: +to speed up @code{@value{AS}}. (Modify @code{app.c} to flush useless spaces: only keep space/tabs at begin of line or between 2 symbols.) @item @@ -5810,7 +6611,7 @@ Put pointers in this documentation to @file{a.out} documentation. @item Split the assembler into parts so it can gobble direct binary from @emph{e.g.} @code{cc}. It is silly for@code{cc} to compose text -just so @code{_AS__} can parse it back to binary. +just so @code{@value{AS}} can parse it back to binary. @item Rewrite hash functions: I want a more modular, faster library. @item @@ -5839,7 +6640,7 @@ relaxable addresses, which is common). @end itemize @section Sources -@c The following files in the @file{_AS__} directory +@c The following files in the @file{@value{AS}} directory @c are symbolic links to other files, of @c the same name, in a different directory. @c @itemize @bullet @@ -5861,7 +6662,7 @@ relaxable addresses, which is common). @c @file{flonum_print.c} @c @end itemize -Here is a list of the source files in the @file{_AS__} directory. +Here is a list of the source files in the @file{@value{AS}} directory. @table @file @item app.c @@ -5875,11 +6676,11 @@ pointer just after the last @code{char} appended. (JF: All these little routines should probably all be put in one file.) @item as.c -Here you will find the main program of the assembler @code{_AS__}. +Here you will find the main program of the assembler @code{@value{AS}}. @item expr.c This is a branch office of @file{read.c}. This understands -expressions, arguments. Inside @code{_AS__}, arguments are called +expressions, arguments. Inside @code{@value{AS}}, arguments are called (expression) @emph{operands}. This is confusing, because we also talk (elsewhere) about instruction @emph{operands}. Also, expression operands are called @emph{quantities} explicitly to avoid confusion @@ -5901,7 +6702,7 @@ something similar. @item input-file.c This contains Operating system dependent source file reading routines. Since error messages often say where we are in reading -the source file, they live here too. Since @code{_AS__} is intended to +the source file, they live here too. Since @code{@value{AS}} is intended to run under GNU and Unix only, this might be worth flushing. Anyway, almost all C compilers support stdio. @@ -5915,10 +6716,10 @@ warning message reporting. See @file{append.c} above. @item output-file.c This contains operating system dependent functions that write an -object file for @code{_AS__}. See @file{input-file.c} above. +object file for @code{@value{AS}}. See @file{input-file.c} above. @item read.c -This implements all the directives of @code{_AS__}. This also deals +This implements all the directives of @code{@value{AS}}. This also deals with passing input lines to the machine dependent part of the assembler. @@ -5976,7 +6777,7 @@ be identical to the one used by GDB (which uses it for disassembly.) @item atof-ieee.c This contains code to turn a flonum into a ieee literal constant. -This is used by tye 680x0, 32x32, sparc, and i386 versions of @code{_AS__}. +This is used by tye 680x0, 32x32, sparc, and i386 versions of @code{@value{AS}}. @item i386-opcode.h This is the opcode-table for the i386 version of the assembler. @@ -6033,7 +6834,7 @@ Vax specific file for describing Vax operands and other Vax-ish things. Vax opcode table. @item vax.c -Vax specific parts of @code{_AS__}. Also includes the former files +Vax specific parts of @code{@value{AS}}. Also includes the former files @file{vax-ins-parse.c}, @file{vax-reg-parse.c} and @file{vip-op.c}. @item atof-vax.c @@ -6059,8 +6860,8 @@ inside the object file. Perhaps we should use the one in @file{/usr/include}? @item as.h -This defines all the globally useful things, and pulls in _0__<stdio.h>_1__ -and _0__<assert.h>_1__. +This defines all the globally useful things, and pulls in @file{stdio.h} +and @file{assert.h}. @item bignum.h This defines macros useful for dealing with bignums. @@ -6093,7 +6894,7 @@ Since nobody is running under real GNU yet, we include this file. Macros and function headers for reading in source files. @item struct-symbol.h -Structure definition and macros for dealing with the _AS__ +Structure definition and macros for dealing with the @value{AS} internal form of a symbol. @item subsegs.h @@ -6113,28 +6914,28 @@ Structure for doing section fixups. @c REALLY OLD dump tape~dots{}) @c @c The ~file{test/} directory is used for regression testing. -@c After you modify ~@code{_AS__}, you can get a quick go/nogo -@c confidence test by running the new ~@code{_AS__} over the source +@c After you modify ~@code{@value{AS}}, you can get a quick go/nogo +@c confidence test by running the new ~@code{@value{AS}} over the source @c files in this directory. You use a shell script ~file{test/do}. @c @c The tests in this suite are evolving. They are not comprehensive. @c They have, however, caught hundreds of bugs early in the debugging -@c cycle of ~@code{_AS__}. Most test statements in this suite were naturally -@c selected: they were used to demonstrate actual ~@code{_AS__} bugs rather +@c cycle of ~@code{@value{AS}}. Most test statements in this suite were naturally +@c selected: they were used to demonstrate actual ~@code{@value{AS}} bugs rather @c than being written ~i{a prioi}. @c @c Another testing suggestion: over 30 bugs have been found simply by -@c running examples from this manual through ~@code{_AS__}. +@c running examples from this manual through ~@code{@value{AS}}. @c Some examples in this manual are selected -@c to distinguish boundary conditions; they are good for testing ~@code{_AS__}. +@c to distinguish boundary conditions; they are good for testing ~@code{@value{AS}}. @c @c ~subsubsection Regression Testing @c Each regression test involves assembling a file and comparing the -@c actual output of ~@code{_AS__} to ``known good'' output files. Both +@c actual output of ~@code{@value{AS}} to ``known good'' output files. Both @c the object file and the error/warning message file (stderr) are -@c inspected. Optionally the ~@code{_AS__} exit status may be checked. +@c inspected. Optionally the ~@code{@value{AS}} exit status may be checked. @c Discrepencies are reported. Each discrepency means either that -@c you broke some part of ~@code{_AS__} or that the ``known good'' files +@c you broke some part of ~@code{@value{AS}} or that the ``known good'' files @c are now out of date and should be changed to reflect the new @c definition of ``good''. @c @@ -6155,7 +6956,7 @@ Structure for doing section fixups. @c deleted. Likewise ~file{stdouterr} is removed if it exactly @c matches a file ~file{stdouterr.good}. If file @c ~file{status.good} is present, containing a decimal number -@c before a newline, the exit status of ~@code{_AS__} is compared +@c before a newline, the exit status of ~@code{@value{AS}} is compared @c to this number. If the status numbers are not equal, a file @c ~file{status} is written to the directory, containing the @c actual status as a decimal number followed by newline. @@ -6189,9 +6990,9 @@ contain all the information about the names of the machine instructions, their opcodes, and what addressing modes they support. If you do this right, the assembler and GDB can share this file, and you'll only have to write it once. Note that -while you're writing @code{_AS__}, you may want to use an +while you're writing @code{@value{AS}}, you may want to use an independent program (if you have access to one), to make sure -that @code{_AS__} is emitting the correct bytes. Since @code{_AS__} +that @code{@value{AS}} is emitting the correct bytes. Since @code{@value{AS}} and @code{GDB} share the opcode table, an incorrect opcode table entry may make invalid bytes look OK when you disassemble them with @code{GDB}. @@ -6255,7 +7056,7 @@ any of your other routines. @item int md_parse_option(char **optionPTR, int *argcPTR, char ***argvPTR) This routine is called once for each option on the command line -that the machine-independent part of @code{_AS__} does not +that the machine-independent part of @code{@value{AS}} does not understand. This function should return non-zero if the option pointed to by @var{optionPTR} is a valid option. If it is not a valid option, this routine should return zero. The variables @@ -6453,12 +7254,12 @@ This function stores a relocation fixup to be acted on later. @var{frag} points to the frag the relocation belongs in; @var{where} is the location within the frag where the relocation begins; @var{size} is the size of the relocation, and is usually 1 (a single byte), - 2 (sixteen bits), or 4 (a longword). -The value @var{add_symbol} @minus{} @var{sub_symbol} + @var{offset}, is added to the byte(s) -at _0__@var{frag->literal[where]}_1__. If @var{pcrel} is non-zero, the address of the -location is subtracted from the result. A relocation entry is also added -to the @file{a.out} file. @var{add_symbol}, @var{sub_symbol}, and/or -@var{offset} may be NULL.@refill + 2 (sixteen bits), or 4 (a longword). The value @var{add_symbol} +@minus{} @var{sub_symbol} + @var{offset}, is added to the byte(s) at +@var{frag->literal[where]}. If @var{pcrel} is non-zero, the address of +the location is subtracted from the result. A relocation entry is also +added to the @file{a.out} file. @var{add_symbol}, @var{sub_symbol}, +and/or @var{offset} may be NULL.@refill @item char *frag_var(relax_stateT type, int max_chars, int var, @code{relax_substateT subtype, symbolS *symbol, char *opcode)} @@ -6498,8 +7299,8 @@ line number, then uses @code{fprintf} to print the @var{message} and any arguments it was passed. @item as_bad(char *message,@dots{}) -This function should be called when @code{_AS__} encounters -conditions that are bad enough that @code{_AS__} should not +This function should be called when @code{@value{AS}} encounters +conditions that are bad enough that @code{@value{AS}} should not produce an object file, but should continue reading input and printing warning and bad error messages. @@ -6538,7 +7339,7 @@ modes. (e.g. branch instructions) This means the size of many pieces of object code cannot be determined until after assembly is finished. (This means that the addresses of symbols cannot be determined until assembly is finished.) In order to do this, -@code{_AS__} stores the output bytes as @dfn{frags}. +@code{@value{AS}} stores the output bytes as @dfn{frags}. Here is the definition of a frag (from @file{as.h}) @smallexample @@ -6614,414 +7415,19 @@ controls how it is relaxed), @item fr_next This is the next frag in the singly-linked list. This is usually only needed by the machine-independent part of -@code{_AS__}. +@code{@value{AS}}. @end table -_fi__(0) - -@node Copying -@unnumbered GNU GENERAL PUBLIC LICENSE - -@cindex license -@cindex GPL -@cindex copying @code{_AS__} -@center Version 2, June 1991 - -@display -Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc. -675 Mass Ave, Cambridge, MA 02139, USA - -Everyone is permitted to copy and distribute verbatim copies -of this license document, but changing it is not allowed. -@end display - -@unnumberedsec Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software---to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Library General Public License instead.) You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -this service if you wish), that you receive source code or can get it -if you want it, that you can change the software or use pieces of it -in new free programs; and that you know you can do these things. - - To protect your rights, we need to make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. You must make sure that they, too, receive or can get the -source code. And you must show them these terms so they know their -rights. - - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. - - The precise terms and conditions for copying, distribution and -modification follow. - -@iftex -@unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION -@end iftex -@ifinfo -@center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION -@end ifinfo - -@enumerate -@item -This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The ``Program'', below, -refers to any such program or work, and a ``work based on the Program'' -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term ``modification''.) Each licensee is addressed as ``you''. - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. - -@item -You may copy and distribute verbatim copies of the Program's -source code as you receive it, in any medium, provided that you -conspicuously and appropriately publish on each copy an appropriate -copyright notice and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. - -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. - -@item -You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - -@enumerate a -@item -You must cause the modified files to carry prominent notices -stating that you changed the files and the date of any change. - -@item -You must cause any work that you distribute or publish, that in -whole or in part contains or is derived from the Program or any -part thereof, to be licensed as a whole at no charge to all third -parties under the terms of this License. - -@item -If the modified program normally reads commands interactively -when run, you must cause it, when started running for such -interactive use in the most ordinary way, to print or display an -announcement including an appropriate copyright notice and a -notice that there is no warranty (or else, saying that you provide -a warranty) and that users may redistribute the program under -these conditions, and telling the user how to view a copy of this -License. (Exception: if the Program itself is interactive but -does not normally print such an announcement, your work based on -the Program is not required to print an announcement.) -@end enumerate - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - -@item -You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - -@enumerate a -@item -Accompany it with the complete corresponding machine-readable -source code, which must be distributed under the terms of Sections -1 and 2 above on a medium customarily used for software interchange; or, - -@item -Accompany it with a written offer, valid for at least three -years, to give any third party, for a charge no more than your -cost of physically performing source distribution, a complete -machine-readable copy of the corresponding source code, to be -distributed under the terms of Sections 1 and 2 above on a medium -customarily used for software interchange; or, - -@item -Accompany it with the information you received as to the offer -to distribute corresponding source code. (This alternative is -allowed only for noncommercial distribution and only if you -received the program in object code or executable form with such -an offer, in accord with Subsection b above.) -@end enumerate - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. - -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. - -@item -You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. - -@item -You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - -@item -Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. - -@item -If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - -@item -If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - -@item -The Free Software Foundation may publish revised and/or new versions -of the General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - -Each version is given a distinguishing version number. If the Program -specifies a version number of this License which applies to it and ``any -later version'', you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. - -@item -If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. - -@iftex -@heading NO WARRANTY -@end iftex -@ifinfo -@center NO WARRANTY -@end ifinfo - -@item -BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY -FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN -OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES -PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED -OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS -TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE -PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, -REPAIR OR CORRECTION. - -@item -IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, -INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING -OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED -TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY -YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER -PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE -POSSIBILITY OF SUCH DAMAGES. -@end enumerate - -@iftex -@heading END OF TERMS AND CONDITIONS -@end iftex -@ifinfo -@center END OF TERMS AND CONDITIONS -@end ifinfo - -@page -@unnumberedsec Applying These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least -the ``copyright'' line and a pointer to where the full notice is found. - -@smallexample -@var{one line to give the program's name and an idea of what it does.} -Copyright (C) 19@var{yy} @var{name of author} - -This program is free software; you can redistribute it and/or -modify it under the terms of the GNU General Public License -as published by the Free Software Foundation; either version 2 -of the License, or (at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program; if not, write to the -Free Software Foundation, Inc., 675 Mass Ave, -Cambridge, MA 02139, USA. -@end smallexample - -Also add information on how to contact you by electronic and paper mail. - -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: - -@smallexample -Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author} -Gnomovision comes with ABSOLUTELY NO WARRANTY; for details -type `show w'. This is free software, and you are welcome -to redistribute it under certain conditions; type `show c' -for details. -@end smallexample - -The hypothetical commands @samp{show w} and @samp{show c} should show -the appropriate parts of the General Public License. Of course, the -commands you use may be called something other than @samp{show w} and -@samp{show c}; they could even be mouse-clicks or menu items---whatever -suits your program. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a ``copyright disclaimer'' for the program, if -necessary. Here is a sample; alter the names: - -@smallexample -Yoyodyne, Inc., hereby disclaims all copyright interest in -the program `Gnomovision' (which makes passes at compilers) -written by James Hacker. - -@var{signature of Ty Coon}, 1 April 1989 -Ty Coon, President of Vice -@end smallexample +@end ignore -This General Public License does not permit incorporating your program into -proprietary programs. If your program is a subroutine library, you may -consider it more useful to permit linking proprietary applications with the -library. If this is what you want to do, use the GNU Library General -Public License instead of this License. +@ifset GENERIC +@include gpl.texinfo +@end ifset @node Index @unnumbered Index @printindex cp -@summarycontents @contents @bye |