share/man/man5/a.out.5

   1 .\" Copyright (c) 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This man page is derived from documentation contributed to Berkeley by
   5 .\" Donn Seeley at UUNET Technologies, Inc.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. Neither the name of the University nor the names of its contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\"     @(#)a.out.5     8.1 (Berkeley) 6/5/93
  32 .\" $FreeBSD: src/share/man/man5/a.out.5,v 1.10.2.4 2002/04/16 14:50:18 trhodes Exp $
  33 .\" $DragonFly: src/share/man/man5/a.out.5,v 1.3 2006/05/26 19:39:40 swildner Exp $
  34 .\"
  35 .Dd June 5, 1993
  36 .Dt A.OUT 5
  37 .Os
  38 .Sh NAME
  39 .Nm a.out
  40 .Nd format of executable binary files
  41 .Sh SYNOPSIS
  42 .In a.out.h
  43 .Sh DESCRIPTION
  44 The include file
  45 .In a.out.h
  46 declares three structures and several macros.
  47 The structures describe the format of
  48 executable machine code files
  49 .Pq Sq binaries
  50 on the system.
  51 .Pp
  52 A binary file consists of up to 7 sections.
  53 In order, these sections are:
  54 .Bl -tag -width "text relocations"
  55 .It exec header
  56 Contains parameters used by the kernel
  57 to load a binary file into memory and execute it,
  58 and by the link editor
  59 .Xr ld 1
  60 to combine a binary file with other binary files.
  61 This section is the only mandatory one.
  62 .It text segment
  63 Contains machine code and related data
  64 that are loaded into memory when a program executes.
  65 May be loaded read-only.
  66 .It data segment
  67 Contains initialized data; always loaded into writable memory.
  68 .It text relocations
  69 Contains records used by the link editor
  70 to update pointers in the text segment when combining binary files.
  71 .It data relocations
  72 Like the text relocation section, but for data segment pointers.
  73 .It symbol table
  74 Contains records used by the link editor
  75 to cross reference the addresses of named variables and functions
  76 .Pq Sq symbols
  77 between binary files.
  78 .It string table
  79 Contains the character strings corresponding to the symbol names.
  80 .El
  81 .Pp
  82 Every binary file begins with an
  83 .Fa exec
  84 structure:
  85 .Bd -literal -offset indent
  86 struct exec {
  87         unsigned long   a_midmag;
  88         unsigned long   a_text;
  89         unsigned long   a_data;
  90         unsigned long   a_bss;
  91         unsigned long   a_syms;
  92         unsigned long   a_entry;
  93         unsigned long   a_trsize;
  94         unsigned long   a_drsize;
  95 };
  96 .Ed
  97 .Pp
  98 The fields have the following functions:
  99 .Bl -tag -width a_trsize
 100 .It Fa a_midmag
 101 This field is stored in host byte-order.
 102 It has a number of sub-components accessed by the macros
 103 .Fn N_GETFLAG ,
 104 .Fn N_GETMID ,
 105 and
 106 .Fn N_GETMAGIC ,
 107 and set by the macro
 108 .Fn N_SETMAGIC .
 109 .Pp
 110 The macro
 111 .Fn N_GETFLAG
 112 returns a few flags:
 113 .Bl -tag -width EX_DYNAMIC
 114 .It Dv EX_DYNAMIC
 115 indicates that the executable requires the services of the run-time link editor.
 116 .It Dv EX_PIC
 117 indicates that the object contains position independent code.
 118 This flag is
 119 set by
 120 .Xr as 1
 121 when given the
 122 .Sq -k
 123 flag and is preserved by
 124 .Xr ld 1
 125 if necessary.
 126 .El
 127 .Pp
 128 If both EX_DYNAMIC and EX_PIC are set, the object file is a position independent
 129 executable image (eg. a shared library), which is to be loaded into the
 130 process address space by the run-time link editor.
 131 .Pp
 132 The macro
 133 .Fn N_GETMID
 134 returns the machine-id.
 135 This indicates which machine(s) the binary is intended to run on.
 136 .Pp
 137 .Fn N_GETMAGIC
 138 specifies the magic number, which uniquely identifies binary files
 139 and distinguishes different loading conventions.
 140 The field must contain one of the following values:
 141 .Bl -tag -width ZMAGIC
 142 .It Dv OMAGIC
 143 The text and data segments immediately follow the header
 144 and are contiguous.
 145 The kernel loads both text and data segments into writable memory.
 146 .It Dv NMAGIC
 147 As with
 148 .Dv OMAGIC ,
 149 text and data segments immediately follow the header and are contiguous.
 150 However, the kernel loads the text into read-only memory
 151 and loads the data into writable memory at the next
 152 page boundary after the text.
 153 .It Dv ZMAGIC
 154 The kernel loads individual pages on demand from the binary.
 155 The header, text segment and data segment are all
 156 padded by the link editor to a multiple of the page size.
 157 Pages that the kernel loads from the text segment are read-only,
 158 while pages from the data segment are writable.
 159 .El
 160 .It Fa a_text
 161 Contains the size of the text segment in bytes.
 162 .It Fa a_data
 163 Contains the size of the data segment in bytes.
 164 .It Fa a_bss
 165 Contains the number of bytes in the
 166 .Sq bss segment
 167 and is used by the kernel to set the initial break
 168 .Pq Xr brk 2
 169 after the data segment.
 170 The kernel loads the program so that this amount of writable memory
 171 appears to follow the data segment and initially reads as zeroes.
 172 .Po
 173 .Em bss
 174 = block started by symbol
 175 .Pc
 176 .It Fa a_syms
 177 Contains the size in bytes of the symbol table section.
 178 .It Fa a_entry
 179 Contains the address in memory of the entry point
 180 of the program after the kernel has loaded it;
 181 the kernel starts the execution of the program
 182 from the machine instruction at this address.
 183 .It Fa a_trsize
 184 Contains the size in bytes of the text relocation table.
 185 .It Fa a_drsize
 186 Contains the size in bytes of the data relocation table.
 187 .El
 188 .Pp
 189 The
 190 .In a.out.h
 191 include file defines several macros which use an
 192 .Fa exec
 193 structure to test consistency or to locate section offsets in the binary file.
 194 .Bl -tag -width N_BADMAG(exec)
 195 .It Fn N_BADMAG exec
 196 Nonzero if the
 197 .Fa a_magic
 198 field does not contain a recognized value.
 199 .It Fn N_TXTOFF exec
 200 The byte offset in the binary file of the beginning of the text segment.
 201 .It Fn N_SYMOFF exec
 202 The byte offset of the beginning of the symbol table.
 203 .It Fn N_STROFF exec
 204 The byte offset of the beginning of the string table.
 205 .El
 206 .Pp
 207 Relocation records have a standard format which
 208 is described by the
 209 .Fa relocation_info
 210 structure:
 211 .Bd -literal -offset indent
 212 struct relocation_info {
 213         int             r_address;
 214         unsigned int    r_symbolnum : 24,
 215                         r_pcrel : 1,
 216                         r_length : 2,
 217                         r_extern : 1,
 218                         r_baserel : 1,
 219                         r_jmptable : 1,
 220                         r_relative : 1,
 221                         r_copy : 1;
 222 };
 223 .Ed
 224 .Pp
 225 The
 226 .Fa relocation_info
 227 fields are used as follows:
 228 .Bl -tag -width r_symbolnum
 229 .It Fa r_address
 230 Contains the byte offset of a pointer that needs to be link-edited.
 231 Text relocation offsets are reckoned from the start of the text segment,
 232 and data relocation offsets from the start of the data segment.
 233 The link editor adds the value that is already stored at this offset
 234 into the new value that it computes using this relocation record.
 235 .It Fa r_symbolnum
 236 Contains the ordinal number of a symbol structure
 237 in the symbol table (it is
 238 .Em not
 239 a byte offset).
 240 After the link editor resolves the absolute address for this symbol,
 241 it adds that address to the pointer that is undergoing relocation.
 242 (If the
 243 .Fa r_extern
 244 bit is clear, the situation is different; see below.)
 245 .It Fa r_pcrel
 246 If this is set,
 247 the link editor assumes that it is updating a pointer
 248 that is part of a machine code instruction using pc-relative addressing.
 249 The address of the relocated pointer is implicitly added
 250 to its value when the running program uses it.
 251 .It Fa r_length
 252 Contains the log base 2 of the length of the pointer in bytes;
 253 0 for 1-byte displacements, 1 for 2-byte displacements,
 254 2 for 4-byte displacements.
 255 .It Fa r_extern
 256 Set if this relocation requires an external reference;
 257 the link editor must use a symbol address to update the pointer.
 258 When the
 259 .Fa r_extern
 260 bit is clear, the relocation is
 261 .Sq local ;
 262 the link editor updates the pointer to reflect
 263 changes in the load addresses of the various segments,
 264 rather than changes in the value of a symbol (except when
 265 .Fa r_baserel
 266 is also set (see below).
 267 In this case, the content of the
 268 .Fa r_symbolnum
 269 field is an
 270 .Fa n_type
 271 value (see below);
 272 this type field tells the link editor
 273 what segment the relocated pointer points into.
 274 .It Fa r_baserel
 275 If set, the symbol, as identified by the
 276 .Fa r_symbolnum
 277 field, is to be relocated to an offset into the Global Offset Table.
 278 At run-time, the entry in the Global Offset Table at this offset is set to
 279 be the address of the symbol.
 280 .It Fa r_jmptable
 281 If set, the symbol, as identified by the
 282 .Fa r_symbolnum
 283 field, is to be relocated to an offset into the Procedure Linkage Table.
 284 .It Fa r_relative
 285 If set, this relocation is relative to the (run-time) load address of the
 286 image this object file is going to be a part of.
 287 This type of relocation
 288 only occurs in shared objects.
 289 .It Fa r_copy
 290 If set, this relocation record identifies a symbol whose contents should
 291 be copied to the location given in
 292 .Fa r_address .
 293 The copying is done by the run-time link-editor from a suitable data
 294 item in a shared object.
 295 .El
 296 .Pp
 297 Symbols map names to addresses (or more generally, strings to values).
 298 Since the link-editor adjusts addresses,
 299 a symbol's name must be used to stand for its address
 300 until an absolute value has been assigned.
 301 Symbols consist of a fixed-length record in the symbol table
 302 and a variable-length name in the string table.
 303 The symbol table is an array of
 304 .Fa nlist
 305 structures:
 306 .Bd -literal -offset indent
 307 struct nlist {
 308         union {
 309                 char    *n_name;
 310                 long    n_strx;
 311         } n_un;
 312         unsigned char   n_type;
 313         char            n_other;
 314         short           n_desc;
 315         unsigned long   n_value;
 316 };
 317 .Ed
 318 .Pp
 319 The fields are used as follows:
 320 .Bl -tag -width n_un.n_strx
 321 .It Fa n_un.n_strx
 322 Contains a byte offset into the string table
 323 for the name of this symbol.
 324 When a program accesses a symbol table with the
 325 .Xr nlist 3
 326 function,
 327 this field is replaced with the
 328 .Fa n_un.n_name
 329 field, which is a pointer to the string in memory.
 330 .It Fa n_type
 331 Used by the link editor to determine
 332 how to update the symbol's value.
 333 The
 334 .Fa n_type
 335 field is broken down into three sub-fields using bitmasks.
 336 The link editor treats symbols with the
 337 .Dv N_EXT
 338 type bit set as
 339 .Sq external
 340 symbols and permits references to them from other binary files.
 341 The
 342 .Dv N_TYPE
 343 mask selects bits of interest to the link editor:
 344 .Bl -tag -width N_TEXT
 345 .It Dv N_UNDF
 346 An undefined symbol.
 347 The link editor must locate an external symbol with the same name
 348 in another binary file to determine the absolute value of this symbol.
 349 As a special case, if the
 350 .Fa n_value
 351 field is nonzero and no binary file in the link-edit defines this symbol,
 352 the link-editor will resolve this symbol to an address
 353 in the bss segment,
 354 reserving an amount of bytes equal to
 355 .Fa n_value .
 356 If this symbol is undefined in more than one binary file
 357 and the binary files do not agree on the size,
 358 the link editor chooses the greatest size found across all binaries.
 359 .It Dv N_ABS
 360 An absolute symbol.
 361 The link editor does not update an absolute symbol.
 362 .It Dv N_TEXT
 363 A text symbol.
 364 This symbol's value is a text address and
 365 the link editor will update it when it merges binary files.
 366 .It Dv N_DATA
 367 A data symbol; similar to
 368 .Dv N_TEXT
 369 but for data addresses.
 370 The values for text and data symbols are not file offsets but
 371 addresses; to recover the file offsets, it is necessary
 372 to identify the loaded address of the beginning of the corresponding
 373 section and subtract it, then add the offset of the section.
 374 .It Dv N_BSS
 375 A bss symbol; like text or data symbols but
 376 has no corresponding offset in the binary file.
 377 .It Dv N_FN
 378 A filename symbol.
 379 The link editor inserts this symbol before
 380 the other symbols from a binary file when
 381 merging binary files.
 382 The name of the symbol is the filename given to the link editor,
 383 and its value is the first text address from that binary file.
 384 Filename symbols are not needed for link-editing or loading,
 385 but are useful for debuggers.
 386 .El
 387 .Pp
 388 The
 389 .Dv N_STAB
 390 mask selects bits of interest to symbolic debuggers
 391 such as
 392 .Xr gdb 1 ;
 393 the values are described in
 394 .Xr stab 5 .
 395 .It Fa n_other
 396 This field provides information on the nature of the symbol independent of
 397 the symbol's location in terms of segments as determined by the
 398 .Fa n_type
 399 field.
 400 Currently, the lower 4 bits of the
 401 .Fa n_other
 402 field hold one of two values:
 403 .Dv AUX_FUNC
 404 and
 405 .Dv AUX_OBJECT
 406 (see
 407 .In link.h
 408 for their definitions).
 409 .Dv AUX_FUNC
 410 associates the symbol with a callable function, while
 411 .Dv AUX_OBJECT
 412 associates the symbol with data, irrespective of their locations in
 413 either the text or the data segment.
 414 This field is intended to be used by
 415 .Xr ld 1
 416 for the construction of dynamic executables.
 417 .It Fa n_desc
 418 Reserved for use by debuggers; passed untouched by the link editor.
 419 Different debuggers use this field for different purposes.
 420 .It Fa n_value
 421 Contains the value of the symbol.
 422 For text, data and bss symbols, this is an address;
 423 for other symbols (such as debugger symbols),
 424 the value may be arbitrary.
 425 .El
 426 .Pp
 427 The string table consists of an
 428 .Em unsigned long
 429 length followed by null-terminated symbol strings.
 430 The length represents the size of the entire table in bytes,
 431 so its minimum value (or the offset of the first string)
 432 is always 4 on 32-bit machines.
 433 .Sh SEE ALSO
 434 .Xr as 1 ,
 435 .Xr gdb 1 ,
 436 .Xr ld 1 ,
 437 .Xr brk 2 ,
 438 .Xr execve 2 ,
 439 .Xr nlist 3 ,
 440 .Xr core 5 ,
 441 .Xr elf 5 ,
 442 .Xr link 5 ,
 443 .Xr stab 5
 444 .Sh HISTORY
 445 The
 446 .In a.out.h
 447 include file appeared in
 448 .At v7 .
 449 .Sh BUGS
 450 Since not all of the supported architectures use the
 451 .Fa a_midmag
 452 field,
 453 it can be difficult to determine what
 454 architecture a binary will execute on
 455 without examining its actual machine code.
 456 Even with a machine identifier,
 457 the byte order of the
 458 .Fa exec
 459 header is machine-dependent.