This file documents the GNU Assembler "as".

Copyright (C) 1991 Free Software Foundation, Inc.

Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies.

Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided also that the section entitled ``GNU General Public License'' is included exactly as in the original, and provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one.

Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that the section entitled ``GNU General Public License'' may be included in a translation approved by the author instead of in the original English.

Overview
********

This manual is a user guide to the GNU assembler as. This version of the manual describes as configured to generate code for Advanced Micro Devices' 29K architectures.

Invoking as
===========

Here is a brief summary of how to invoke GNU as.  For details, see Options.

       as [ -D ] [ -f ] [ -I PATH ] [ -k ] [ -L ] [ -o OBJFILE ] [ -R ] [ -v ] [ -w ]
     am29k has no machine-dependent assembler options
        [ -- | FILES ... ]

-D
     This option is accepted only for script compatibility with calls to other assemblers; it has no effect on GNU as.

-f
     ``fast''---skip preprocessing (assume source is compiler output)

-I PATH
     Add PATH to the search list for .include directives

-k
     This option is accepted but has no effect on the 29K family.

-L
     Keep (in symbol table) local symbols, starting with L

-o OBJFILE
     Name the object-file output from as

-R
     Fold data segment into text segment

-W
     Suppress warning messages

-- | FILES ...
     Source files to assemble, or standard input

Structure of this Manual
========================

This document is intended to describe what you need to know to use GNU as.  We cover the syntax expected in source files, including notation for symbols, constants, and expressions; the directives that as understands; and of course how to invoke as.

We also cover special features in the AMD 29K configuration of as, including assembler directives.

On the other hand, this manual is not intended as an introduction 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 not describe the instruction set, standard mnemonics, registers or addressing modes that are standard to a particular architecture.  You may want to consult the manufacturer's machine architecture manual for this information.

as, the GNU Assembler
=====================

as is primarily intended to assemble the output of the GNU C compiler gcc for use by the linker ld.  Nevertheless, we've tried to make as assemble correctly everything that the native assembler would. This doesn't mean 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.

GNU as is really a family of assemblers.  If you use (or have used) GNU as on another architecture, you should find a fairly similar environment.  Each version has much in common with the others, including object file formats, most assembler directives (often called pseudo-ops) and assembler syntax.

Unlike older assemblers, as is designed to assemble a source program in one pass of the source file.  This has a subtle impact on the .org directive (see Org).

Command Line
============

     as [ options ... ] [ file1 ... ]

After the program name as, the command line may contain options and file names.  Options may be in any order, and may be before, after, or between file names.  The order of file names is significant.

-- (two hyphens) by itself names the standard input file explicitly, as one of the files for as to assemble.

Except for -- any command line argument that begins with a hyphen (-) is an option.  Each option changes the behavior of as.  No option changes the way another option works.  An option is a - followed by one or more letters; the case of the letter is important.   All options are optional.

Some options expect exactly one file name to follow them.  The file name may either immediately follow the option's letter (compatible with older assemblers) or it may be the next command argument (GNU standard).  These two command lines are equivalent:

     as -o my-object-file.o mumble
     as -omy-object-file.o mumble

Input Files
===========

We use the phrase source program, abbreviated source, to describe the program input to one run of 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.

The source program is a concatenation of the text in all the files, in the order specified.

Each time you run 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 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 as is given no file names it attempts to read one input file from as's standard input, which is normally your terminal.  You may have to type ctl-D to tell as there is no more program to assemble.

Use -- if you need to explicitly name the standard input file in your command line.

If the source is empty, as will produce a small, empty object file.

Input Filenames and Line-numbers
--------------------------------

There are two ways of locating a line in the input file (or files) and both are used in reporting error messages.  One way refers to a line number in a physical file; the other refers to a line number in a ``logical'' file.

Physical files are those files named in the command line given to as.

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 as source is itself synthesized from other files.  See App-File.

Output (Object) File
====================

Every time you run as it produces an output file, which is your assembly language program translated into numbers.  This file is the object file, named a.out unless you tell as to give it another name by using the -o option.  Conventionally, object file names end with .o.  The default name of a.out is used for historical reasons:  older assemblers were capable of assembling self-contained programs directly into a runnable program.

The object file is meant for input to the linker ld.  It contains assembled program code, information to help ld integrate the assembled program into a runnable file, and (optionally) symbolic information for the debugger.

Error and Warning Messages
==========================

as may write warnings and error messages to the standard error file (usually your terminal).  This should not happen when as is run automatically by a compiler.  Warnings report an assumption made so that as could keep assembling a flawed program; errors report a grave problem that stops the assembly.

Warning messages have the format

     file_name:NNN:Warning Message Text

(where NNN is a line number).  If a logical file name has been given (see 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 (see Line) 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).

Error messages have the format

     file_name:NNN:FATAL:Error Message Text

The file name and line number are derived as for warning messages.  The actual message text may be rather less explanatory because many of them aren't supposed to happen.

Options
=======

-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 GNU as.

Work Faster: -f
---------------

-f should only be used when assembling programs written by a (trusted) compiler.  -f stops the assembler from pre-processing the input file(s) before assembling them.

     Warning: if the files actually need to be pre-processed (if they contain comments, for example), as will not work correctly if -f is used.

Add to .include search path: -I PATH
------------------------------------

Use this option to add a PATH to the list of directories GNU as will search for files specified in .include directives (see Include).  You may use -I as many times as necessary to include a variety of paths.  The current working directory is always searched first; after that, as searches any -I directories in the same order as they were specified (left to right) on the command line.

Warn if difference tables altered: -k
-------------------------------------

On the AMD 29K family, this option is allowed, but has no effect.  It is permitted for compatibility with GNU as on other platforms, where it can be used to warn when as alters the machine code generated for .word directives in difference tables.  The AMD 29K family does not have the addressing limitations that sometimes lead to this alteration on other platforms.

Include Local Labels: -L
------------------------

Labels beginning with L (upper case only) are called local labels. See 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 as and ld discard such labels, so you don't normally debug with them.

This option tells as to retain those L... symbols in the object file.  Usually if you do this you also tell the linker ld to preserve symbols whose names begin with L.

Name the Object File: -o
------------------------

There is always one object file output when you run as.  By default it has the name a.out.  You use this option (which takes exactly one filename) to give the object file a different name.

Whatever the object file is called, as will overwrite any existing file of the same name.

Fold Data Segment into Text Segment: -R
---------------------------------------

-R tells as to write the object file as if all data-segment data lives in the text segment.  This is only done at the very last moment:  your binary data are the same, but data segment parts are relocated differently.  The data segment part of your object file is zero bytes long because all it bytes are appended to the text segment.  (see Segments.)

When you specify -R it would be possible to generate shorter address displacements (because we don't have to cross between text and data segment).  We don't do this simply for compatibility with older versions of as.  In future, -R may work this way.

Suppress Warnings: -W
---------------------

as should never give a warning or error message when assembling compiler output.  But programs written by people often cause 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 as assembles your file.  Errors, which stop the assembly, are still reported.

Syntax
******

This chapter describes the machine-independent syntax allowed in a source file.  as syntax is similar to what many other assemblers use; it is inspired in BSD 4.2 assembler.

Pre-processing
==============

The pre-processor:

  * adjusts and removes extra whitespace.  It leaves one space or tab before the keywords on a line, and turns any other whitespace on the line into a single space.

  * removes all comments, replacing them with a single space, or an appropriate number of newlines.

  * converts character constants into the appropriate numeric values.

Excess whitespace, comments, and character constants cannot be used in the portions of the input text that are not pre-processed.

If the first line of an input file is #NO_APP or the -f option is given, the input file will not be pre-processed.  Within such an input file, parts of the file can be pre-processed by putting a line that says #APP before the text that should be pre-processed, and putting a line that says #NO_APP after them.  This feature is mainly intend to support asm statements in compilers whose output normally does not need to be pre-processed.

Whitespace
==========

Whitespace is one or more blanks or tabs, in any order. Whitespace is used to separate symbols, and to make programs neater for people to read.  Unless within character constants (see Characters), any whitespace means the same as exactly one space.

Comments
========

There are two ways of rendering comments to as.  In both cases the comment is equivalent to one space.

Anything from /* through the next */ is a comment. This means you may not nest these comments.

     /*
       The only way to include a newline ('\n') in a comment
       is to use this sort of comment.
     */

     /* This sort of comment does not nest. */

Anything from the line comment character to the next newline is considered a comment and is ignored.  The line comment character is ; for the AMD 29K family. See Machine Dependent.

To be compatible with past assemblers a special interpretation is given to lines that begin with #.  Following the # an absolute expression (see Expressions) is expected:  this will be the logical line number of the next line.  Then a string (see Strings.) is allowed: if present it is a new logical file name.  The rest of the line, if any, should be whitespace.

If the first non-whitespace characters on the line are not numeric, the line is ignored.  (Just like a comment.)

                               # This is an ordinary comment.
     # 42-6 "new_file_name"    # New logical file name
                               # This is logical line # 36.

This feature is deprecated, and may disappear from future versions of as.

Symbols
=======

A symbol is one or more characters chosen from the set of all letters (both upper and lower case), digits and the three characters _.$.  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 (since the source program must end with a newline, the end of a file is not a possible symbol delimiter).  See Symbols.

Statements
==========

A statement ends at a newline character (\n) or an ``at'' sign (@).  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. It is an error to end any statement with end-of-file:  the last character of any input file should be a newline.

You may write a statement on more than one line if you put a backslash (\) immediately in front of any newlines within the statement.  When 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.

An empty statement is allowed, and may include whitespace.  It is ignored.

A statement begins with zero or more labels, optionally followed by a key symbol which determines what kind of statement it is.  The key symbol determines the syntax of the rest of the statement.  If the symbol begins with a dot . 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 instruction: it will assemble into a machine language instruction.  Different versions of 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.

A label is a symbol immediately followed by a colon (:). Whitespace before a label or after a colon is permitted, but you may not have whitespace between a label's symbol and its colon. See Labels.

     label:     .directive    followed by something
     another$label:           # This is an empty statement.
                instruction   operand_1, operand_2, ...

Constants
=========

A constant is a number, written so that its value is known by inspection, without knowing any context.  Like this:

     .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.

Character Constants
-------------------

There are two kinds of character constants.  A character stands for one character in one byte and its value may be used in numeric expressions.  String constants (properly called string literals) are potentially many bytes and their values may not be used in arithmetic expressions.

Strings
.......

A string is written between double-quotes.  It may contain double-quotes or null characters.  The way to get special characters into a string is to escape these characters: precede them with a backslash \ character.  For example \\ represents one backslash:  the first \ is an escape which tells as to interpret the second character literally as a backslash (which prevents as from recognizing the second \ as an escape character).  The complete list of escapes follows.

\b
     Mnemonic for backspace; for ASCII this is octal code 010.

\f
     Mnemonic for FormFeed; for ASCII this is octal code 014.

\n
     Mnemonic for newline; for ASCII this is octal code 012.

\r
     Mnemonic for carriage-Return; for ASCII this is octal code 015.

\t
     Mnemonic for horizontal Tab; for ASCII this is octal code 011.

\ DIGIT DIGIT DIGIT
     An octal character code.  The numeric code is 3 octal digits. For compatibility with other Unix systems, 8 and 9 are accepted as digits: for example, \008 has the value 010, and \009 the value 011.

\\
     Represents one \ character.

\"
     Represents one " character.  Needed in strings to represent this character, because an unescaped " would end the string.

\ ANYTHING-ELSE
     Any other character when escaped by \ will give a warning, but assemble as if the \ 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 as has no other interpretation, so as knows it is giving you the wrong code and warns you of the fact.

Which characters are escapable, and what those escapes represent, varies widely among assemblers.  The current set is what we think BSD 4.2 as recognizes, and is a subset of what most C compilers recognize.  If you are in doubt, don't use an escape sequence.

Characters
..........

A single character may be written as a single quote immediately followed by that character.  The same escapes apply to characters as to strings.  So if you want to write the character backslash, you must write '\\ where the first \ escapes the second \.  As you can see, the quote is an acute accent, not a grave accent.  A newline (or at sign @) 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.  as assumes your character code is ASCII: 'A means 65, 'B means 66, and so on.

Number Constants
----------------

as distinguishes three kinds of numbers according to how they are stored in the target machine.  Integers are numbers that would fit into an int in the C language.  Bignums are integers, but they are stored in a more than 32 bits.  Flonums are floating point numbers, described below.

Integers
........

A binary integer is 0b or 0B followed by zero or more of the binary digits 01.

An octal integer is 0 followed by zero or more of the octal digits (01234567).

A decimal integer starts with a non-zero digit followed by zero or more digits (0123456789).

A hexadecimal integer is 0x or 0X followed by one or more hexadecimal digits chosen from 0123456789abcdefABCDEF.

Integers have the usual values.  To denote a negative integer, use the prefix operator - discussed under expressions (see Prefix Ops).

Bignums
.......

A bignum has the same syntax and semantics as an integer except that the number (or its negative) takes more than 32 bits to represent in binary.  The distinction is made because in some places integers are permitted while bignums are not.

Flonums
.......

A flonum represents a floating point number.  The translation is complex: a decimal floating point number from the text is converted by 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 as specialized to that computer.

A flonum is written by writing (in order)

  * The digit 0.

  * One of the letters DFPRSX (in upper or lower case), to tell as the rest of the number is a flonum.

  * An optional sign: either + or -.

  * An optional integer part: zero or more decimal digits.

  * An optional fraction part: . followed by zero or more decimal digits.

  * An optional exponent, consisting of:

       * An E or e.

       * Optional sign: either + or -.

       * One or more decimal digits.

At least one of INTEGER PART or FRACTION PART must be present.  The floating point number has the usual base-10 value.

as does all processing using integers.  Flonums are computed independently of any floating point hardware in the computer running as.

Segments and Relocation
***********************

Background
==========

Roughly, a segment is a range of addresses, with no gaps; all data ``in'' those addresses is treated the same for some particular purpose. For example there may be a ``read only'' segment.

The linker ld reads many object files (partial programs) and combines their contents to form a runnable program.  When as emits an object file, the partial program is assumed to start at address 0.  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 as uses segments.

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 segment.  Assigning run-time addresses to segments is called relocation.  It includes the task of adjusting mentions of object-file addresses so they refer to the proper run-time addresses.

An object file written by as has three segments, any of which may be empty.  These are named text, data and bss segments.  Within the object file, the text segment starts at address 0, the data segment follows, and the bss segment follows the data segment.

To let ld know which data will change when the segments are relocated, and how to change that data, as also writes to the object file details of the relocation needed.  To perform relocation ld must know, each time an address in the object file is mentioned:

  * Where in the object file is the beginning of this reference to an address?

  * How long (in bytes) is this reference?

  * Which segment does the address refer to?  What is the numeric value of

          (ADDRESS) - (START-ADDRESS OF SEGMENT)?

  * Is the reference to an address ``Program-Counter relative''?

In fact, every address as ever uses is expressed as (SEGMENT) + (OFFSET INTO SEGMENT).  Further, every expression as computes is of this segmented nature. Absolute expression means an expression with segment ``absolute'' (see ld Segments).  A pass1 expression means an expression with segment ``pass1'' (see as Segments).  In this manual we use the notation {SEGNAME N} to mean ``offset N into segment SEGNAME''.

Apart from text, data and bss segments you need to know about the absolute segment.  When ld mixes partial programs, addresses in the absolute segment remain unchanged.  That is, address {absolute 0} is ``relocated'' to run-time address 0 by ld. Although two partial programs' data segments will not overlap addresses after linking, by definition their absolute segments will overlap. Address {absolute 239} in one partial program will always be the same address when the program is running as address {absolute 239} in any other partial program.

The idea of segments is extended to the undefined segment.  Any address whose segment is unknown at assembly time is by definition rendered {undefined U}---where U will be filled in later. Since numbers are always defined, the only way to generate an undefined address is to mention an undefined symbol.  A reference to a named common block would be such a symbol: its value is unknown at assembly time so it has segment undefined.

By analogy the word segment is used to describe groups of segments in the linked program.  ld puts all partial programs' text segments in contiguous addresses in the linked program.  It is customary to refer to the text segment of a program, meaning all the addresses of all partial program's text segments.  Likewise for data and bss segments.

Some segments are manipulated by ld; others are invented for use of as and have no meaning except during assembly.

ld Segments
===========

ld deals with just five kinds of segments, summarized below.

text segment
data segment
     These segments hold your program.  as and ld treat them as separate but equal segments.  Anything you can say of one segment is true of the other.  When the program is running, however, it is customary for the text segment to be unalterable.  The text segment is often shared among processes: it will contain instructions, constants and the like.  The data segment of a running program is usually alterable: for example, C variables would be stored in the data segment.

bss segment
     This segment contains zeroed bytes when your program begins running.  It is used to hold unitialized variables or common storage.  The length of each partial program's bss segment is important, but because it starts out containing zeroed bytes there is no need to store explicit zero bytes in the object file.  The bss segment was invented to eliminate those explicit zeros from object files.

absolute segment
     Address 0 of this segment is always ``relocated'' to runtime address 0. This is useful if you want to refer to an address that ld must not change when relocating.  In this sense we speak of absolute addresses being ``unrelocatable'': they don't change during relocation.

undefined segment
     This ``segment'' is a catch-all for address references to objects not in the preceding segments.

An idealized example of the 3 relocatable segments follows.  Memory addresses are on the horizontal axis.

                           +-----+----+--+
     partial program # 1:  |ttttt|dddd|00|
                           +-----+----+--+

                           text   data bss
                           seg.   seg. seg.

                           +---+---+---+
     partial program # 2:  |TTT|DDD|000|
                           +---+---+---+

                           +--+---+-----+--+----+---+-----+~~
     linked program:       |  |TTT|ttttt|  |dddd|DDD|00000|
                           +--+---+-----+--+----+---+-----+~~

         addresses:        0 ...

as Internal Segments
====================

These segments are invented for the internal use of as.  They have no meaning at run-time.  You don't need to know about these segments except that they might be mentioned in as' warning messages.  These segments are invented to permit the value of every expression in your assembly language program to be a segmented address.

absent segment
     An expression was expected and none was found.

goof segment
     An internal assembler logic error has been found.  This means there is a bug in the assembler.

grand segment
     A grand number is a bignum or a flonum, but not an integer.  If a number can't be written as a C int constant, it is a grand number.  as has to remember that a flonum or a bignum does not fit into 32 bits, and cannot be an argument (see Arguments) in an expression: this is done by making a flonum or bignum be in segment grand.  This is purely for internal as convenience; grand segment behaves similarly to absolute segment.

pass1 segment
     The expression was impossible to evaluate in the first pass.  The assembler will attempt a second pass (second reading of the source) to evaluate the expression.  Your expression mentioned an undefined symbol in a way that defies the one-pass (segment + offset in segment) assembly process.  No compiler need emit such an expression.

          Warning: the second pass is currently not implemented.  as will abort with an error message if one is required.

difference segment
     As an assist to the C compiler, expressions of the forms

             (UNDEFINED SYMBOL) - (EXPRESSION
             (SOMETHING - (UNDEFINED SYMBOL)
             (UNDEFINED SYMBOL) - (UNDEFINED SYMBOL)

     are permitted, and belong to the difference segment.  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 segment.  The intention is to permit statements like .word label - base_of_table to be assembled in one pass where both label and base_of_table are undefined.  This is useful for compiling C and Algol switch statements, Pascal case statements, FORTRAN computed goto statements and the like.

Sub-Segments
============

Assembled bytes fall into two segments: text and data. Because you may have groups of text or data that you want to end up near to each other in the object file, as allows you to use subsegments.  Within each segment, there can be numbered subsegments with values from 0 to 8192.  Objects assembled into the same subsegment will be grouped with other objects in the same subsegment when they are all put into the object file.  For example, a compiler might want to store constants in the text segment, but might not want to have them interspersed with the program being assembled.  In this case, the compiler could issue a text 0 before each section of code being output, and a text 1 before each group of constants being output.

Subsegments are optional.  If you don't use subsegments, everything will be stored in subsegment number zero.

On the AMD 29K family, no particular padding is added to segment sizes; GNU as forces no alignment on this platform. Subsegments 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 subsegments; ld and other programs that manipulate object files will see no trace of them. They just see all your text subsegments as a text segment, and all your data subsegments as a data segment.

To specify which subsegment you want subsequent statements assembled into, use a .text EXPRESSION or a .data EXPRESSION statement.  EXPRESSION should be an absolute expression.  (see Expressions.)  If you just say .text then .text 0 is assumed.  Likewise .data means .data 0.  Assembly begins in text 0. For instance:

     .text 0     # The default subsegment is text 0 anyway.
     .ascii "This lives in the first text subsegment. *"
     .text 1
     .ascii "But this lives in the second text subsegment."
     .data 0
     .ascii "This lives in the data segment,"
     .ascii "in the first data subsegment."
     .text 0
     .ascii "This lives in the first text segment,"
     .ascii "immediately following the asterisk (*)."

Each segment has a location counter incremented by one for every byte assembled into that segment.  Because subsegments are merely a convenience restricted to as there is no concept of a subsegment location counter.  There is no way to directly manipulate a location counter---but the .align directive will change it, and any label definition will capture its current value.  The location counter of the segment that statements are being assembled into is said to be the active location counter.

bss Segment
===========

The bss segment is used for local common variable storage. You may allocate address space in the bss segment, but you may not dictate data to load into it before your program executes.  When your program starts running, all the contents of the bss segment are zeroed bytes.

Addresses in the bss segment are allocated with special directives; you may not assemble anything directly into the bss segment.  Hence there are no bss subsegments. See Comm; see Lcomm.

Symbols
*******

Symbols are a central concept: the programmer uses symbols to name things, the linker uses symbols to link, and the debugger uses symbols to debug.

     Warning: as does not place symbols in the object file in the same order they were declared.  This may break some debuggers.

Labels
======

A label is written as a symbol immediately followed by a colon :.  The symbol then represents the current value of the active location counter, and is, for example, a suitable instruction operand.  You are warned if you use the same symbol to represent two different locations: the first definition overrides any other definitions.

Giving Symbols Other Values
===========================

A symbol can be given an arbitrary value by writing a symbol, followed by an equals sign =, followed by an expression (see Expressions).  This is equivalent to using the .set directive.  See Set.

Symbol Names
============

Symbol names begin with a letter or with one of $._.  That character may be followed by any string of digits, letters, underscores and dollar signs.  Case of letters is significant: foo is a different symbol name than Foo.

For the AMD 29K family, ? is also allowed in the body of a symbol name, though not at its beginning.

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 number of times in a program.

Local Symbol Names
------------------

Local symbols help compilers and programmers use names temporarily. There are ten local symbol names, which are re-used throughout the program.  You may refer to them using the names 0 1 ... 9.  To define a local symbol, write a label of the form N: (where N represents any digit).  To refer to the most recent previous definition of that symbol write Nb, using the same digit as when you defined the label.  To refer to the next definition of a local label, write Nf---where N gives you a choice of 10 forward references.  The b stands for ``backwards'' and the f stands for ``forwards''.

Local symbols are not emitted by the current GNU C compiler.

There is no restriction on how you can use these labels, but remember that at any point in the assembly you can refer to at most 10 prior local labels and to at most 10 forward local labels.

Local symbol names are only a notation device.  They are immediately transformed into more conventional symbol names before the assembler uses them.  The symbol names stored in the symbol table, appearing in error messages and optionally emitted to the object file have these parts:

L
     All local labels begin with L. Normally both as and ld forget symbols that start with L. These labels are used for symbols you are never intended to see.  If you give the -L option then as will retain these symbols in the object file. If you also instruct ld to retain these symbols, you may use them in debugging.

DIGIT
     If the label is written 0: then the digit is 0. If the label is written 1: then the digit is 1. And so on up through 9:.

A
     This unusual character is included so you don't accidentally invent a symbol of the same name.  The character has ASCII value \001.

ordinal number
     This is a serial number to keep the labels distinct.  The first 0: gets the number 1; The 15th 0: gets the number 15; etc..  Likewise for the other labels 1: through 9:.

For instance, the first 1: is named L1A1, the 44th 3: is named L3A44.

The Special Dot Symbol
======================

The special symbol . refers to the current address that as is assembling into.  Thus, the expression melvin: .long . will cause melvin to contain its own address. Assigning a value to . is treated the same as a .org directive.  Thus, the expression .=.+4 is the same as saying .block 4.

Symbol Attributes
=================

Every symbol has these attributes: Value, Type, Descriptor, and ``Other''.

If you use a symbol without defining it, 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.

Value
-----

The value of a symbol is (usually) 32 bits, the size of one GNU C int.  For a symbol which labels a location in the text, data, bss or absolute segments the value is the number of addresses from the start of that segment to the label.  Naturally for text, data and bss segments the value of a symbol changes as ld changes segment 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 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 .comm common declaration.  The value is how much common storage to reserve, in bytes (addresses).  The symbol refers to the first address of the allocated storage.

Type
----

The type attribute of a symbol is 8 bits encoded in a devious way. We kept this coding standard for compatibility with older operating systems.

             7     6     5     4     3     2     1     0     bit numbers
          +-----+-----+-----+-----+-----+-----+-----+-----+
          |                 |                       |     |
          |   N_STAB bits   |      N_TYPE bits      |N_EXT|
          |                 |                       | bit |
          +-----+-----+-----+-----+-----+-----+-----+-----+

                          Type byte

N_EXT bit
.........

This bit is set if ld might need to use the symbol's type bits and value.  If this bit is off, then ld can ignore the symbol while linking.  It is set in two cases.  If the symbol is undefined, then ld is expected to find the symbol's value elsewhere in another program module.  Otherwise the symbol has the value given, but this symbol name and value are revealed to any other programs linked in the same executable program.  This second use of the N_EXT bit is most often made by a .globl statement.

N_TYPE bits
...........

These establish the symbol's ``type'', which is mainly a relocation concept.  Common values are detailed in the manual describing the executable file format.

N_STAB bits
...........

Common values for these bits are described in the manual on the executable file format.

Descriptor
----------

This is an arbitrary 16-bit value.  You may establish a symbol's descriptor value by using a .desc statement (see Desc). A descriptor value means nothing to as.

Other
-----

This is an arbitrary 8-bit value.  It means nothing to as.

Expressions
***********

An expression specifies an address or numeric value. Whitespace may precede and/or follow an expression.

Empty Expressions
=================

An empty expression has no value: it is just whitespace or null. Wherever an absolute expression is required, you may omit the expression and as will assume a value of (absolute) 0.  This is compatible with other assemblers.

Integer Expressions
===================

An integer expression is one or more arguments delimited by operators.

Arguments
---------

Arguments are symbols, numbers or subexpressions.  In other contexts arguments are sometimes called ``arithmetic operands''.  In this manual, to avoid confusing them with the ``instruction operands'' of the machine language, we use the term ``argument'' to refer to parts of expressions only, reserving the word ``operand'' to refer only to machine instruction operands.

Symbols are evaluated to yield {SEGMENT NNN} where SEGMENT is one of text, data, bss, absolute, or undefined.  NNN is a signed, 2's complement 32 bit 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 as pretends these 32 bits are an integer.  You may write integer-manipulating instructions that act on exotic constants, compatible with other assemblers.

Subexpressions are a left parenthesis ( followed by an integer expression, followed by a right parenthesis ); or a prefix operator followed by an argument.

Operators
---------

Operators are arithmetic functions, like + or %.  Prefix operators are followed by an argument.  Infix operators appear between their arguments.  Operators may be preceded and/or followed by whitespace.

Prefix Operators
----------------

as has the following prefix operators.  They each take one argument, which must be absolute.

-
     Negation.  Two's complement negation.

~
     Complementation.  Bitwise not.

Infix Operators
---------------

Infix operators take two arguments, one on either side.  Operators have precedence, but operations with equal precedence are performed left to right.  Apart from + or -, both arguments must be absolute, and the result is absolute.

 1. Highest Precedence

     *
          Multiplication.

     /
          Division.  Truncation is the same as the C operator /

     %
          Remainder.

     <
     <<
          Shift Left.  Same as the C operator <<

     >
     >>
          Shift Right.  Same as the C operator >>

 2. Intermediate precedence

     |
          Bitwise Inclusive Or.

     &
          Bitwise And.

     ^
          Bitwise Exclusive Or.

     !
          Bitwise Or Not.

 3. Lowest Precedence

     +
          Addition.  If either argument is absolute, the result has the segment of the other argument. If either argument is pass1 or undefined, the result is pass1. Otherwise + is illegal.

     -
          Subtraction.  If the right argument is absolute, the result has the segment of the left argument. If either argument is pass1 the result is pass1. If either argument is undefined the result is difference segment. If both arguments are in the same segment, the result is absolute---provided that segment is one of text, data or bss. Otherwise subtraction is illegal.

The sense of the rule for addition is that it's only meaningful to add the offsets in an address; you can only have a defined segment in one of the two arguments.

Similarly, you can't subtract quantities from two different segments.

Assembler Directives
********************

All assembler directives have names that begin with a period (.). The rest of the name is letters: their case does not matter.

This chapter discusses directives present in all versions of GNU as; see Machine Dependent for additional directives.

.abort
======

This directive stops the assembly immediately.  It is for compatibility with other assemblers.  The original idea was that the assembler program would be piped into the assembler.  If the sender of a program quit, it could use this directive tells as to quit also.  One day .abort will not be supported.

.align ABSOLUTE-EXPRESSION , ABSOLUTE-EXPRESSION
================================================

Pad the location counter (in the current subsegment) to a particular storage boundary.  The first expression is the number of low-order zero bits the location counter will have after advancement.  For example .align 3 will advance the location counter until it a multiple of 8.  If the location counter is already a multiple of 8, no change is needed.

The second expression gives the value to be stored in the padding bytes.  It (and the comma) may be omitted.  If it is omitted, the padding bytes are zero.

.app-file STRING
================

.app-file tells as that we are about to start a new logical file.  STRING is the new file name.  In general, the filename is recognized whether or not it is surrounded by quotes "; but if you wish to specify an empty file name is permitted, you must give the quotes--"".  This statement may go away in future: it is only recognized to be compatible with old as programs.

.ascii "STRING"...
==================

.ascii expects zero or more string literals (see Strings) separated by commas.  It assembles each string (with no automatic trailing zero byte) into consecutive addresses.

.asciz "STRING"...
==================

.asciz is just like .ascii, but each string is followed by a zero byte.  The ``z'' in .asciz stands for ``zero''.

.byte EXPRESSIONS
=================

.byte expects zero or more expressions, separated by commas. Each expression is assembled into the next byte.

.comm SYMBOL , LENGTH
=====================

.comm declares a named common area in the bss segment.  Normally ld reserves memory addresses for it during linking, so no partial program defines the location of the symbol.  Use .comm to tell ld that it must be at least LENGTH bytes long.  ld will allocate space for each .comm symbol that is at least as long as the longest .comm request in any of the partial programs linked.  LENGTH is an absolute expression.

.data SUBSEGMENT
================

.data tells as to assemble the following statements onto the end of the data subsegment numbered SUBSEGMENT (which is an absolute expression).  If SUBSEGMENT is omitted, it defaults to zero.

.desc SYMBOL, ABSOLUTE-EXPRESSION
=================================

This directive sets the descriptor of the symbol (see Symbol Attributes) to the low 16 bits of ABSOLUTE-EXPRESSION.

.double FLONUMS
===============

.double expects zero or more flonums, separated by commas.  It assembles floating point numbers. On the AMD 29K family the floating point format used is IEEE.

.else
=====

.else is part of the as support for conditional assembly; see If.  It marks the beginning of a section of code to be assembled if the condition for the preceding .if was false.

.endif
======

.endif is part of the as support for conditional assembly; it marks the end of a block of code that is only assembled conditionally.  See If.

.equ SYMBOL, EXPRESSION
=======================

This directive sets the value of SYMBOL to EXPRESSION. It is synonymous with .set; see Set.

.extern
=======

.extern is accepted in the source program---for compatibility with other assemblers---but it is ignored.  GNU as treats all undefined symbols as external.

.fill REPEAT , SIZE , VALUE
===========================

RESULT, SIZE and VALUE are absolute expressions. This emits REPEAT copies of SIZE bytes.  REPEAT may be zero or more.  SIZE may be zero or more, but if it is more than 8, then it is deemed to have the value 8, compatible with other people's assemblers.  The contents of each REPEAT bytes is taken from an 8-byte number.  The highest order 4 bytes are zero.  The lowest order 4 bytes are VALUE rendered in the byte-order of an integer on the computer as is assembling for. Each SIZE bytes in a repetition is taken from the lowest order SIZE bytes of this number.  Again, this bizarre behavior is compatible with other people's assemblers.

SIZE and VALUE are optional. If the second comma and VALUE are absent, VALUE is assumed zero.  If the first comma and following tokens are absent, SIZE is assumed to be 1.

.float FLONUMS
==============

This directive assembles zero or more flonums, separated by commas.  It has the same effect as .single. The floating point format used for the AMD 29K family is IEEE.

.global SYMBOL, .globl SYMBOL
=============================

.global makes the symbol visible to ld.  If you define SYMBOL in your partial program, its value is made available to other partial programs that are linked with it.  Otherwise, SYMBOL will take its attributes from a symbol of the same name from another partial program it is linked with.

This is done by setting the N_EXT bit of that symbol's type byte to 1. See Symbol Attributes.

Both spellings (.globl and .global) are accepted, for compatibility with other assemblers.

.ident
======

This directive is used by some assemblers to place tags in object files. GNU as simply accepts the directive for source-file compatibility with such assemblers, but does not actually emit anything for it.

.if ABSOLUTE EXPRESSION
=======================

.if marks the beginning of a section of code which is only considered part of the source program being assembled if the argument (which must be an ABSOLUTE EXPRESSION) is non-zero.  The end of the conditional section of code must be marked by .endif (see Endif); optionally, you may include code for the alternative condition, flagged by .else (see Else.

The following variants of .if are also supported:

ifdef SYMBOL
     Assembles the following section of code if the specified SYMBOL has been defined.

ifndef SYMBOL
ifnotdef SYMBOL
     Assembles the following section of code if the specified SYMBOL has not been defined.  Both spelling variants are equivalent.

.include "FILE"
===============

This directive provides a way to include supporting files at specified points in your source program.  The code from FILE is assembled as if it followed the point of the .include; when the end of the included file is reached, assembly of the original file continues.  You can control the search paths used with the -I command-line option (see Options).  Quotation marks are required around FILE.

.int EXPRESSIONS
================

Expect zero or more EXPRESSIONS, of any segment, separated by commas.  For each expression, emit a 32-bit 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.

.lcomm SYMBOL , LENGTH
======================

Reserve LENGTH (an absolute expression) bytes for a local common denoted by SYMBOL.  The segment and value of SYMBOL are those of the new local common.  The addresses are allocated in the bss segment, so at run-time the bytes will start off zeroed. SYMBOL is not declared global (see Global), so is normally not visible to ld.

.ln LINE-NUMBER
===============

Tell as to change the logical line number.  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 @) will be reported as on logical line number LOGICAL LINE NUMBER - 1. One day this directive will be unsupported: it is used only for compatibility with existing assembler programs.

.list, .nolist, .eject, .lflags, .title, .sbttl
===============================================

GNU as ignores these directives; however, they're accepted for compatibility with assemblers that use them.

.long EXPRESSIONS
=================

.long is the same as .int, see Int.

.lsym SYMBOL, EXPRESSION
========================

.lsym creates a new symbol named SYMBOL, but does not put it in the hash table, ensuring it cannot be referenced by name during the rest of the assembly.  This sets the attributes of the symbol to be the same as the expression value:

     OTHER = DESCRIPTOR = 0
     TYPE = (segment of EXPRESSION)
     N_EXT = 0
     VALUE = EXPRESSION

.octa BIGNUMS
=============

This directive expects zero or more bignums, separated by commas.  For each bignum, it emits a 16-byte integer.

The term ``quad'' comes from contexts in which a ``word'' was two bytes; hence quad-word for 8 bytes.

.org NEW-LC , FILL
==================

.org will advance the location counter of the current segment to NEW-LC.  NEW-LC is either an absolute expression or an expression with the same segment as the current subsegment.  That is, you can't use .org to cross segments: if NEW-LC has the wrong segment, the .org directive is ignored.  To be compatible with former assemblers, if the segment of NEW-LC is absolute, as will issue a warning, then pretend the segment of NEW-LC is the same as the current subsegment.

.org may only increase the location counter, or leave it unchanged; you cannot use .org to move the location counter backwards.

Because as tries to assemble programs in one pass NEW-LC may not be undefined.  If you really detest this restriction we eagerly await a chance to share your improved assembler.

Beware that the origin is relative to the start of the segment, not to the start of the subsegment.  This is compatible with other people's assemblers.

When the location counter (of the current subsegment) is advanced, the intervening bytes are filled with FILL which should be an absolute expression.  If the comma and FILL are omitted, FILL defaults to zero.

.quad BIGNUMS
=============

.quad expects zero or more bignums, separated by commas.  For each bignum, it emits an 8-byte integer.  If the bignum won't fit in a 8 bytes, it prints a warning message; and just takes the lowest order 8 bytes of the bignum.

The term ``quad'' comes from contexts in which a ``word'' was two bytes; hence quad-word for 8 bytes.

.set SYMBOL, EXPRESSION
=======================

This directive sets the value of SYMBOL to EXPRESSION.  This will change SYMBOL's value and type to conform to EXPRESSION.  If N_EXT is set, it remains set. (see Symbol Attributes.)

You may .set a symbol many times in the same assembly. If the expression's segment is unknowable during pass 1, a second pass over the source program will be forced.  The second pass is currently not implemented.  as will abort with an error message if one is required.

If you .set a global symbol, the value stored in the object file is the last value stored into it.

.short EXPRESSIONS
==================

This expects zero or more EXPRESSIONS, and emits a 16 bit number for each.

.single FLONUMS
===============

This directive assembles zero or more flonums, separated by commas.  It has the same effect as .float. The floating point format used for the AMD 29K family is IEEE.

.space
======

This directive is ignored; it is accepted for compatibility with other AMD 29K assemblers.

     Warning: In other versions of GNU as, the directive .space has the effect of .block  see Machine Directives.

.stabd, .stabn, .stabs
======================

There are three directives that begin .stab. All emit symbols (see Symbols), for use by symbolic debuggers. The symbols are not entered in as' hash table: they cannot be referenced elsewhere in the source file. Up to five fields are required:

string
     This is the symbol's name.  It may contain any character except \000, so is more general than ordinary symbol names.  Some debuggers used to code arbitrarily complex structures into symbol names using this field.

type
     An absolute expression.  The symbol's type is set to the low 8 bits of this expression. Any bit pattern is permitted, but ld and debuggers will choke on silly bit patterns.

other
     An absolute expression. The symbol's ``other'' attribute is set to the low 8 bits of this expression.

desc
     An absolute expression. The symbol's descriptor is set to the low 16 bits of this expression.

value
     An absolute expression which becomes the symbol's value.

If a warning is detected while reading a .stabd, .stabn, or .stabs statement, the symbol has probably already been created and you will get a half-formed symbol in your object file.  This is compatible with earlier assemblers!

.stabd TYPE , OTHER , DESC

     The ``name'' of the symbol generated is not even an empty string. It is a null pointer, for compatibility.  Older assemblers used a null pointer so they didn't waste space in object files with empty strings.

     The symbol's value is set to the location counter, relocatably.  When your program is linked, the value of this symbol will be where the location counter was when the .stabd was assembled.

.stabn TYPE , OTHER , DESC , VALUE

     The name of the symbol is set to the empty string "".

.stabs STRING ,  TYPE , OTHER , DESC , VALUE

     All five fields are specified.

.text SUBSEGMENT
================

Tells as to assemble the following statements onto the end of the text subsegment numbered SUBSEGMENT, which is an absolute expression.  If SUBSEGMENT is omitted, subsegment number zero is used.

.word EXPRESSIONS
=================

This directive expects zero or more EXPRESSIONS, of any segment, separated by commas. For each expression, as emits a 32-bit number.

Deprecated Directives
=====================

One day these directives won't work. They are included for compatibility with older assemblers.

.abort

.app-file

.line

Machine Dependent Features: AMD 29K
***********************************

Options
=======

GNU as has no additional command-line options for the AMD 29K family.

Syntax
======

Special Characters
------------------

; is the line comment character.

@ can be used instead of a newline to separate statements.

The character ? is permitted in identifiers (but may not begin an identifier).

Register Names
--------------

General-purpose registers are represented by predefined symbols of the form GRNNN (for global registers) or LRNNN (for local registers), where NNN represents a number between 0 and 127, written with no leading zeros.  The leading letters may be in either upper or lower case; for example, gr13 and LR7 are both valid register names.

You may also refer to general-purpose registers by specifying the register number as the result of an expression (prefixed with %% to flag the expression as a register number):

     %%EXPRESSION

---where EXPRESSION must be an absolute expression evaluating to a number between 0 and 255.  The range [0, 127] refers to global registers, and the range [128, 255] to local registers.

In addition, GNU as understands the following protected special-purpose register names for the AMD 29K family:

       vab    chd    pc0
       ops    chc    pc1
       cps    rbp    pc2
       cfg    tmc    mmu
       cha    tmr    lru

These unprotected special-purpose register names are also recognized:

       ipc    alu    fpe
       ipa    bp     inte
       ipb    fc     fps
       q      cr     exop

Floating Point
==============

The AMD 29K family uses IEEE floating-point numbers.

Machine Directives
==================

.block SIZE , FILL
------------------

This directive emits SIZE bytes, each of value FILL.  Both SIZE and FILL are absolute expressions.  If the comma and FILL are omitted, FILL is assumed to be zero.

In other versions of GNU as, this directive is called .space.

.cputype
--------

This directive is ignored; it is accepted for compatibility with other AMD 29K assemblers.

.file
-----

This directive is ignored; it is accepted for compatibility with other AMD 29K assemblers.

     Warning: in other versions of GNU as, .file is used for the directive called .app-file in the AMD 29K support.

.hword EXPRESSIONS
------------------

This expects zero or more EXPRESSIONS, and emits a 16 bit number for each.  (Synonym for .short.)

.line
-----

This directive is ignored; it is accepted for compatibility with other AMD 29K assemblers.

.reg SYMBOL, EXPRESSION
-----------------------

.reg has the same effect as .lsym; see Lsym.

.sect
-----

This directive is ignored; it is accepted for compatibility with other AMD 29K assemblers.

.use SEGMENT NAME
-----------------

Establishes the segment and subsegment for the following code; SEGMENT NAME may be one of .text, .data, .data1, or .lit.  With one of the first three SEGMENT NAME options, .use is equivalent to the machine directive SEGMENT NAME; the remaining case, .use .lit, is the same as .data 200.

Opcodes
=======

GNU 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 Am29000 User's Manual, Advanced Micro Devices, Inc.

GNU GENERAL PUBLIC LICENSE
**************************

Version 1, February 1989

     Copyright © 1989 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.

Preamble
========

The license agreements of most software companies try to keep users at the mercy of those companies.  By contrast, our 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.  The General Public License applies to the Free Software Foundation's software and to any other program whose authors commit to using it. You can use it for your programs, too.

When we speak of free software, we are referring to freedom, not price.  Specifically, the General Public License is designed to make sure that you have the freedom to give away or sell copies of free software, 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 a 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 tell them 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.

The precise terms and conditions for copying, distribution and modification follow.

TERMS AND CONDITIONS

 1. This License Agreement 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 work containing the Program or a portion of it, either verbatim or with modifications.  Each licensee is addressed as ``you''.

 2. 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 General Public License and to the absence of any warranty; and give any other recipients of the Program a copy of this General Public License along with the Program.  You may charge a fee for the physical act of transferring a copy.

 3. You may modify your copy or copies of the Program or any portion of it, and copy and distribute such modifications under the terms of Paragraph 1 above, provided that you also do the following:

       * cause the modified files to carry prominent notices stating that you changed the files and the date of any change; and

       * cause the whole of any work that you distribute or publish, that in whole or in part contains the Program or any part thereof, either with or without modifications, to be licensed at no charge to all third parties under the terms of this General Public License (except that you may choose to grant warranty protection to some or all third parties, at your option).

       * If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the simplest and most usual 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 General Public License.

       * 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.

     Mere aggregation of another independent work with the Program (or its derivative) on a volume of a storage or distribution medium does not bring the other work under the scope of these terms.

 4. You may copy and distribute the Program (or a portion or derivative of it, under Paragraph 2) in object code or executable form under the terms of Paragraphs 1 and 2 above provided that you also do one of the following:

       * accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Paragraphs 1 and 2 above; or,

       * accompany it with a written offer, valid for at least three years, to give any third party free (except for a nominal charge for the cost of distribution) a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Paragraphs 1 and 2 above; or,

       * accompany it with the information you received as to where the corresponding source code may be obtained.  (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form alone.)

     Source code for a work means the preferred form of the work for making modifications to it.  For an executable file, complete source code means all the source code for all modules it contains; but, as a special exception, it need not include source code for modules which are standard libraries that accompany the operating system on which the executable file runs, or for standard header files or definitions files that accompany that operating system.

 5. You may not copy, modify, sublicense, distribute or transfer the Program except as expressly provided under this General Public License. Any attempt otherwise to copy, modify, sublicense, distribute or transfer the Program is void, and will automatically terminate your rights to use the Program under this License.  However, parties who have received copies, or rights to use copies, from you under this General Public License will not have their licenses terminated so long as such parties remain in full compliance.

 6. By copying, distributing or modifying 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.

 7. 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.

 8. 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 the 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 the license, you may choose any version ever published by the Free Software Foundation.

 9. 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.

     NO WARRANTY

 10. 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.

 11. 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 OF TERMS AND CONDITIONS

Appendix: How to Apply These Terms to Your New Programs
=======================================================

If you develop a new program, and you want it to be of the greatest possible use to humanity, 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.

     ONE LINE TO GIVE THE PROGRAM'S NAME AND A BRIEF IDEA OF WHAT IT DOES.
     Copyright (C) 19YY  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 1, 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.

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:

     Gnomovision version 69, Copyright (C) 19YY 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.

The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License.  Of course, the commands you use may be called something other than `show w' and `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:

     Yoyodyne, Inc., hereby disclaims all copyright interest in the
     program `Gnomovision' (a program to direct compilers to make passes
     at assemblers) written by James Hacker.

     SIGNATURE OF TY COON, 1 April 1989
     Ty Coon, President of Vice

That's all there is to it!