.\" Copyright (c) 1991 The Regents of the University of California.
.\" This man page is derived from documentation contributed to Berkeley by
.\" Donn Seeley at UUNET Technologies, Inc.
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by the University of
.\" California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" @(#)a.out.5 6.3 (Berkeley) 4/29/91
.Nd format of executable binary files
declares three structures and several macros.
The structures describe the format of
executable machine code files
A binary file consists of up to 7 sections.
In order, these sections are:
.Bl -tag -width "text relocations"
Contains parameters used by the kernel
to load a binary file into memory and execute it,
to combine a binary file with other binary files.
This section is the only mandatory one.
Contains machine code and related data
that are loaded into memory when a program executes.
Contains initialized data; always loaded into writable memory.
Contains records used by the link editor
to update pointers in the text segment when combining binary files.
Like the text relocation section, but for data segment pointers.
Contains records used by the link editor
to cross reference the addresses of named variables and functions
Contains the character strings corresponding to the symbol names.
Every binary file begins with an
.Bd -literal -offset indent
The fields have the following functions:
Contains a bit pattern that
identifies binaries that were built for
certain sub-classes of an architecture
or variants of the operating system on a given architecture.
The kernel may not support all machine IDs
field is not present on some architectures;
that uniquely identifies binary files
and distinguishes different loading conventions.
The field must contain one of the following values:
The text and data segments immediately follow the header
The kernel loads both text and data segments into writable memory.
text and data segments immediately follow the header and are contiguous.
However, the kernel loads the text into read-only memory
and loads the data into writable memory at the next
page boundary after the text.
The kernel loads individual pages on demand from the binary.
The header, text segment and data segment are all
padded by the link editor to a multiple of the page size.
Pages that the kernel loads from the text segment are read-only,
while pages from the data segment are writable.
Contains the size of the text segment in bytes.
Contains the size of the data segment in bytes.
Contains the number of bytes in the
and is used by the kernel to set the initial break
The kernel loads the program so that this amount of writable memory
appears to follow the data segment and initially reads as zeroes.
Contains the size in bytes of the symbol table section.
Contains the address in memory of the entry point
of the program after the kernel has loaded it;
the kernel starts the execution of the program
from the machine instruction at this address.
Contains the size in bytes of the text relocation table.
Contains the size in bytes of the data relocation table.
include file defines several macros which use an
structure to test consistency or to locate section offsets in the binary file.
.Bl -tag -width N_BADMAG(exec)
field does not contain a recognized value.
The byte offset in the binary file of the beginning of the text segment.
The byte offset of the beginning of the symbol table.
The byte offset of the beginning of the string table.
Relocation records have a standard format which
.Bd -literal -offset indent
unsigned int r_symbolnum : 24,
fields are used as follows:
.Bl -tag -width r_symbolnum
Contains the byte offset of a pointer that needs to be link-edited.
Text relocation offsets are reckoned from the start of the text segment,
and data relocation offsets from the start of the data segment.
The link editor adds the value that is already stored at this offset
into the new value that it computes using this relocation record.
Contains the ordinal number of a symbol structure
in the symbol table (it is
After the link editor resolves the absolute address for this symbol,
it adds that address to the pointer that is undergoing relocation.
bit is clear, the situation is different; see below.)
the link editor assumes that it is updating a pointer
that is part of a machine code instruction using pc-relative addressing.
The address of the relocated pointer is implicitly added
to its value when the running program uses it.
Contains the log base 2 of the length of the pointer in bytes;
0 for 1-byte displacements, 1 for 2-byte displacements,
2 for 4-byte displacements.
Set if this relocation requires an external reference;
the link editor must use a symbol address to update the pointer.
bit is clear, the relocation is
the link editor updates the pointer to reflect
changes in the load addresses of the various segments,
rather than changes in the value of a symbol.
In this case, the content of the
this type field tells the link editor
what segment the relocated pointer points into.
Symbols map names to addresses (or more generally, strings to values).
Since the link-editor adjusts addresses,
a symbol's name must be used to stand for its address
until an absolute value has been assigned.
Symbols consist of a fixed-length record in the symbol table
and a variable-length name in the string table.
The symbol table is an array of
.Bd -literal -offset indent
The fields are used as follows:
.Bl -tag -width n_un.n_strx
Contains a byte offset into the string table
for the name of this symbol.
When a program accesses a symbol table with the
this field is replaced with the
field, which is a pointer to the string in memory.
Used by the link editor to determine
how to update the symbol's value.
field is broken down into three sub-fields using bitmasks.
The link editor treats symbols with the
symbols and permits references to them from other binary files.
mask selects bits of interest to the link editor:
The link editor must locate an external symbol with the same name
in another binary file to determine the absolute value of this symbol.
As a special case, if the
field is nonzero and no binary file in the link-edit defines this symbol,
the link-editor will resolve this symbol to an address
reserving an amount of bytes equal to
If this symbol is undefined in more than one binary file
and the binary files do not agree on the size,
the link editor chooses the greatest size found across all binaries.
The link editor does not update an absolute symbol.
This symbol's value is a text address and
the link editor will update it when it merges binary files.
A data symbol; similar to
The values for text and data symbols are not file offsets but
addresses; to recover the file offsets, it is necessary
to identify the loaded address of the beginning of the corresponding
section and subtract it, then add the offset of the section.
A bss symbol; like text or data symbols but
has no corresponding offset in the binary file.
The link editor inserts this symbol before
the other symbols from a binary file when
The name of the symbol is the filename given to the link editor,
and its value is the first text address from that binary file.
Filename symbols are not needed for link-editing or loading,
but are useful for debuggers.
mask selects bits of interest to symbolic debuggers
the values are described in
This field is currently unused.
Reserved for use by debuggers; passed untouched by the link editor.
Different debuggers use this field for different purposes.
Contains the value of the symbol.
For text, data and bss symbols, this is an address;
for other symbols (such as debugger symbols),
the value may be arbitrary.
The string table consists of an
length followed by null-terminated symbol strings.
The length represents the size of the entire table in bytes,
so its minimum value (or the offset of the first string)
is always 4 on 32-bit machines.
Since not all of the supported architectures use the
it can be difficult to determine what
architecture a binary will execute on
without examining its actual machine code.
Even with a machine identifier,
header is machine-dependent.
Nobody seems to agree on what
New binary file formats may be supported in the future,
and they probably will not be compatible at any level
with this ancient format.