Ubuntu Manpage - Elf - Format of Executable and Linking Format (ELF) Files PDF

Download as pdf or txt
Download as pdf or txt
You are on page 1of 26

4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

Menu

name

synopsis

description

notes
see also

colophon

cosmic (5) elf.5.gz

Provided by: manpages_4.16-1_all

NAME

elf - format of Executable and Linking Format (ELF) files

SYNOPSIS

#include <elf.h>

DESCRIPTION

The header file <elf.h> defines the format of ELF executable binary fi
files are normal executable files, relocatable object files, core
objects.

An executable file using the ELF file format consists of an ELF he


program header table or a section header table, or both. The ELF hea
offset zero of the file. The program header table and the section he
in the file are defined in the ELF header. The two tables describe
particularities of the file.

This header file describes the above mentioned headers as C structure


structures for dynamic sections, relocation sections and symbol tables

Basic types
The following types are used for N-bit architectures (N=32,64, ElfN sta

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 1/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

Elf64, uintN_t stands for uint32_t or uint64_t):

ElfN_Addr Unsigned program address, uintN_t


ElfN_Off Unsigned file offset, uintN_t
ElfN_Section Unsigned section index, uint16_t
ElfN_Versym Unsigned version symbol information, uint16_t
Elf_Byte unsigned char
ElfN_Half uint16_t
ElfN_Sword int32_t
ElfN_Word uint32_t
ElfN_Sxword int64_t
ElfN_Xword uint64_t

(Note: the *BSD terminology is a bit different. There, Elf64_Half i


Elf32_Half, and Elf64Quarter is used for uint16_t. In order to avoi
types are replaced by explicit ones in the below.)

All data structures that the file format defines follow the "natural
guidelines for the relevant class. If necessary, data structures conta
to ensure 4-byte alignment for 4-byte objects, to force structure siz
4, and so on.

ELF header (Ehdr)


The ELF header is described by the type Elf32_Ehdr or Elf64_Ehdr:

#define EI_NIDENT 16

typedef struct {
unsigned char e_ident[EI_NIDENT];
uint16_t e_type;
uint16_t e_machine;
uint32_t e_version;
ElfN_Addr e_entry;
ElfN_Off e_phoff;
ElfN_Off e_shoff;
uint32_t e_flags;
uint16_t e_ehsize;
uint16_t e_phentsize;
uint16_t e_phnum;
uint16_t e_shentsize;
uint16_t e_shnum;
uint16_t e_shstrndx;
} ElfN_Ehdr;

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 2/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

The fields have the following meanings:

e_ident This array of bytes specifies how to interpret the file, i


processor or the file's remaining contents. Within this
named by macros, which start with the prefix EI_ and may con
start with the prefix ELF. The following macros are defined

EI_MAG0 The first byte of the magic number. It must be f


(0: 0x7f)

EI_MAG1 The second byte of the magic number. It must be fil


(1: 'E')

EI_MAG2 The third byte of the magic number. It must be f


(2: 'L')

EI_MAG3 The fourth byte of the magic number. It must be fil


(3: 'F')

EI_CLASS The fifth byte identifies the architecture for this

ELFCLASSNONE This class is invalid.


ELFCLASS32 This defines the 32-bit architect
machines with files and virtual addres
Gigabytes.
ELFCLASS64 This defines the 64-bit architecture.

EI_DATA The sixth byte specifies the data encoding of the


data in the file. Currently, these encodings are su

ELFDATANONE Unknown data format.


ELFDATA2LSB Two's complement, little-endian.
ELFDATA2MSB Two's complement, big-endian.

EI_VERSION
The seventh byte is the version number of the ELF sp

EV_NONE Invalid version.


EV_CURRENT Current version.

EI_OSABI The eighth byte identifies the operating system and


object is targeted. Some fields in other ELF struct

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 3/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

values that have platform-specific meanings; the


those fields is determined by the value of this byte

ELFOSABI_NONE Same as ELFOSABI_SYSV


ELFOSABI_SYSV UNIX System V ABI
ELFOSABI_HPUX HP-UX ABI
ELFOSABI_NETBSD NetBSD ABI
ELFOSABI_LINUX Linux ABI
ELFOSABI_SOLARIS Solaris ABI
ELFOSABI_IRIX IRIX ABI
ELFOSABI_FREEBSD FreeBSD ABI
ELFOSABI_TRU64 TRU64 UNIX ABI
ELFOSABI_ARM ARM architecture ABI
ELFOSABI_STANDALONE Stand-alone (embedded) ABI

EI_ABIVERSION
The ninth byte identifies the version of the ABI to
targeted. This field is used to distinguish
versions of an ABI. The interpretation of thi
dependent on the ABI identified by the EI_OSABI fi
conforming to this specification use the value 0.

EI_PAD Start of padding. These bytes are reserved and set


which read them should ignore them. The value for E
in the future if currently unused bytes are given me

EI_NIDENT
The size of the e_ident array.

e_type This member of the structure identifies the object file type

ET_NONE An unknown type.


ET_REL A relocatable file.
ET_EXEC An executable file.
ET_DYN A shared object.
ET_CORE A core file.

e_machine This member specifies the required architecture for an in


example:

EM_NONE An unknown machine


EM_M32 AT&T WE 32100
EM_SPARC Sun Microsystems SPARC

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 4/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

EM_386 Intel 80386


EM_68K Motorola 68000
EM_88K Motorola 88000
EM_860 Intel 80860
EM_MIPS MIPS RS3000 (big-endian only)
EM_PARISC HP/PA
EM_SPARC32PLUS SPARC with enhanced instruction set
EM_PPC PowerPC
EM_PPC64 PowerPC 64-bit
EM_S390 IBM S/390
EM_ARM Advanced RISC Machines
EM_SH Renesas SuperH
EM_SPARCV9 SPARC v9 64-bit
EM_IA_64 Intel Itanium
EM_X86_64 AMD x86-64
EM_VAX DEC Vax

e_version This member identifies the file version:

EV_NONE Invalid version


EV_CURRENT Current version

e_entry This member gives the virtual address to which the syste
control, thus starting the process. If the file has no asso
this member holds zero.

e_phoff This member holds the program header table's file offset in b
has no program header table, this member holds zero.

e_shoff This member holds the section header table's file offset in
has no section header table, this member holds zero.

e_flags This member holds processor-specific flags associated with th


take the form EF_`machine_flag'. Currently, no flags have be

e_ehsize This member holds the ELF header's size in bytes.

e_phentsize
This member holds the size in bytes of one entry in the fi
table; all entries are the same size.

e_phnum This member holds the number of entries in the program heade
product of e_phentsize and e_phnum gives the table's size i

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 5/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

has no program header, e_phnum holds the value zero.

If the number of entries in the program header table is large


PN_XNUM (0xffff), this member holds PN_XNUM (0xffff) and
entries in the program header table is held in the sh_info me
entry in section header table. Otherwise, the sh_info me
entry contains the value zero.

PN_XNUM This is defined as 0xffff, the largest number


specifying where the actual number of program heade

e_shentsize
This member holds a sections header's size in bytes. A se
entry in the section header table; all entries are the same s

e_shnum This member holds the number of entries in the section heade
product of e_shentsize and e_shnum gives the section hea
bytes. If a file has no section header table, e_shnum holds

If the number of entries in the section header table is large


SHN_LORESERVE (0xff00), e_shnum holds the value zero and
entries in the section header table is held in the sh_size me
entry in section header table. Otherwise, the sh_size me
entry in the section header table holds the value zero.

e_shstrndx
This member holds the section header table index of the ent
the section name string table. If the file has no section
this member holds the value SHN_UNDEF.

If the index of section name string table section is larger


SHN_LORESERVE (0xff00), this member holds SHN_XINDEX (0xffff
of the section name string table section is held in the sh_li
initial entry in section header table. Otherwise, the sh
initial entry in section header table contains the value zero

Program header (Phdr)


An executable or shared object file's program header table is an array
describing a segment or other information the system needs to prep
execution. An object file segment contains one or more sections. P
meaningful only for executable and shared object files. A file specif
header size with the ELF header's e_phentsize and e_phnum members. The
is described by the type Elf32_Phdr or Elf64_Phdr depending on the arch

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 6/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

typedef struct {
uint32_t p_type;
Elf32_Off p_offset;
Elf32_Addr p_vaddr;
Elf32_Addr p_paddr;
uint32_t p_filesz;
uint32_t p_memsz;
uint32_t p_flags;
uint32_t p_align;
} Elf32_Phdr;

typedef struct {
uint32_t p_type;
uint32_t p_flags;
Elf64_Off p_offset;
Elf64_Addr p_vaddr;
Elf64_Addr p_paddr;
uint64_t p_filesz;
uint64_t p_memsz;
uint64_t p_align;
} Elf64_Phdr;

The main difference between the 32-bit and the 64-bit program header l
of the p_flags member in the total struct.

p_type This member of the structure indicates what kind of segment t


describes or how to interpret the array element's information

PT_NULL The array element is unused and the other


undefined. This lets the program header have ign

PT_LOAD The array element specifies a loadable segm


p_filesz and p_memsz. The bytes from the fil
beginning of the memory segment. If the segm
p_memsz is larger than the file size p_filesz, th
defined to hold the value 0 and to follow the seg
area. The file size may not be larger th
Loadable segment entries in the program heade
ascending order, sorted on the p_vaddr member.

PT_DYNAMIC The array element specifies dynamic linking info

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 7/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

PT_INTERP The array element specifies the location an


terminated pathname to invoke as an interpreter.
is meaningful only for executable files (thou
shared objects). However it may not occur more t
If it is present, it must precede any loadable se

PT_NOTE The array element specifies the location of notes

PT_SHLIB This segment type is reserved but has unsp


Programs that contain an array element of this ty
to the ABI.

PT_PHDR The array element, if present, specifies the l


the program header table itself, both in the file
image of the program. This segment type may
once in a file. Moreover, it may occur only if t
table is part of the memory image of the program
it must precede any loadable segment entry.

PT_LOPROC, PT_HIPROC
Values in the inclusive range [PT_LOPROC, PT_HIP
for processor-specific semantics.

PT_GNU_STACK
GNU extension which is used by the Linux kernel t
of the stack via the flags set in the p_flags mem

p_offset This member holds the offset from the beginning of the file a
byte of the segment resides.

p_vaddr This member holds the virtual address at which the first
resides in memory.

p_paddr On systems for which physical addressing is relevant, this m


for the segment's physical address. Under BSD this member i
be zero.

p_filesz This member holds the number of bytes in the file image of th
be zero.

p_memsz This member holds the number of bytes in the memory image
may be zero.

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 8/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

p_flags This member holds a bit mask of flags relevant to the segment

PF_X An executable segment.


PF_W A writable segment.
PF_R A readable segment.

A text segment commonly has the flags PF_X and PF_R. A data
has PF_X, PF_W, and PF_R.

p_align This member holds the value to which the segments are align
the file. Loadable process segments must have congruent valu
p_offset, modulo the page size. Values of zero and one m
required. Otherwise, p_align should be a positive, integral
p_vaddr should equal p_offset, modulo p_align.

Section header (Shdr)


A file's section header table lets one locate all the file's sections.
table is an array of Elf32_Shdr or Elf64_Shdr structures. The ELF head
gives the byte offset from the beginning of the file to the section hea
holds the number of entries the section header table contains. e_shent
in bytes of each entry.

A section header table index is a subscript into this array. Some s


indices are reserved: the initial entry and the indices between
SHN_HIRESERVE. The initial entry is used in ELF extensions for e
e_strndx; in other cases, each field in the initial entry is set to ze
does not have sections for these special indices:

SHN_UNDEF
This value marks an undefined, missing, irrelevant, or ot
section reference.

SHN_LORESERVE
This value specifies the lower bound of the range of reserved in

SHN_LOPROC, SHN_HIPROC
Values greater in the inclusive range [SHN_LOPROC, SHN_HIPROC]
processor-specific semantics.

SHN_ABS
This value specifies the absolute value for the correspond
example, a symbol defined relative to section number SHN_ABS has
and is not affected by relocation.

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 9/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

SHN_COMMON
Symbols defined relative to this section are common symbols, suc
or unallocated C external variables.

SHN_HIRESERVE
This value specifies the upper bound of the range of reserved in
reserves indices between SHN_LORESERVE and SHN_HIRESERVE, incl
header table does not contain entries for the reserved indices.

The section header has the following structure:

typedef struct {
uint32_t sh_name;
uint32_t sh_type;
uint32_t sh_flags;
Elf32_Addr sh_addr;
Elf32_Off sh_offset;
uint32_t sh_size;
uint32_t sh_link;
uint32_t sh_info;
uint32_t sh_addralign;
uint32_t sh_entsize;
} Elf32_Shdr;

typedef struct {
uint32_t sh_name;
uint32_t sh_type;
uint64_t sh_flags;
Elf64_Addr sh_addr;
Elf64_Off sh_offset;
uint64_t sh_size;
uint32_t sh_link;
uint32_t sh_info;
uint64_t sh_addralign;
uint64_t sh_entsize;
} Elf64_Shdr;

No real differences exist between the 32-bit and 64-bit section headers

sh_name This member specifies the name of the section. Its value is
section header string table section, giving the location o
string.

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 10/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

sh_type This member categorizes the section's contents and semantics

SHT_NULL This value marks the section header as inacti


have an associated section. Other members of
have undefined values.

SHT_PROGBITS This section holds information defined by t


format and meaning are determined solely by th

SHT_SYMTAB This section holds a symbol table. Typ


provides symbols for link editing, though it m
dynamic linking. As a complete symbol table,
symbols unnecessary for dynamic linking. An o
contain a SHT_DYNSYM section.

SHT_STRTAB This section holds a string table. An o


multiple string table sections.

SHT_RELA This section holds relocation entries with exp


as type Elf32_Rela for the 32-bit class o
object may have multiple relocation sections.

SHT_HASH This section holds a symbol hash table. An ob


in dynamic linking must contain a symbol has
file may have only one hash table.

SHT_DYNAMIC This section holds information for dynamic li


file may have only one dynamic section.

SHT_NOTE This section holds notes (ElfN_Nhdr).

SHT_NOBITS A section of this type occupies no spac


otherwise resembles SHT_PROGBITS. Although th
no bytes, the sh_offset member contains
offset.

SHT_REL This section holds relocation offsets without


such as type Elf32_Rel for the 32-bit class o
object file may have multiple relocation secti

SHT_SHLIB This section is reserved but has unspecified s

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 11/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

SHT_DYNSYM This section holds a minimal set of dynamic li


object file can also contain a SHT_SYMTAB sect

SHT_LOPROC, SHT_HIPROC
Values in the inclusive range [SHT_LOPROC
reserved for processor-specific semantics.

SHT_LOUSER This value specifies the lower bound of the


reserved for application programs.

SHT_HIUSER This value specifies the upper bound of t


reserved for application programs. Sectio
SHT_LOUSER and SHT_HIUSER may be used by the a
conflicting with current or future system-defi

sh_flags Sections support one-bit flags that describe miscellaneous


flag bit is set in sh_flags, the attribute is "on" for the s
the attribute is "off" or does not apply. Undefined attribut

SHF_WRITE This section contains data that should be writ


execution.

SHF_ALLOC This section occupies memory during proce


control sections do not reside in the memory i
file. This attribute is off for those section

SHF_EXECINSTR This section contains executable machine inst

SHF_MASKPROC All bits included in this mask are rese


specific semantics.

sh_addr If this section appears in the memory image of a process, thi


address at which the section's first byte should reside. Ot
contains zero.

sh_offset This member's value holds the byte offset from the beginning
first byte in the section. One section type, SHT_NOBITS, o
the file, and its sh_offset member locates the conceptual pla

sh_size This member holds the section's size in bytes. Unless the
SHT_NOBITS, the section occupies sh_size bytes in the file
SHT_NOBITS may have a nonzero size, but it occupies no space

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 12/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

sh_link This member holds a section header table index link, wh


depends on the section type.

sh_info This member holds extra information, whose interpretation dep


type.

sh_addralign
Some sections have address alignment constraints. If a
doubleword, the system must ensure doubleword alignment for
That is, the value of sh_addr must be congruent to zero, mod
sh_addralign. Only zero and positive integral powers of tw
value 0 or 1 means that the section has no alignment constrai

sh_entsize
Some sections hold a table of fixed-sized entries, such as a
such a section, this member gives the size in bytes for each
contains zero if the section does not hold a table of fixed-s

Various sections hold program and control information:

.bss This section holds uninitialized data that contributes to the


image. By definition, the system initializes the data
program begins to run. This section is of type SHT_NOBITS.
are SHF_ALLOC and SHF_WRITE.

.comment This section holds version control information. This


SHT_PROGBITS. No attribute types are used.

.ctors This section holds initialized pointers to the C++ constructo


section is of type SHT_PROGBITS. The attribute types
SHF_WRITE.

.data This section holds initialized data that contribute to the


image. This section is of type SHT_PROGBITS. The attribute
and SHF_WRITE.

.data1 This section holds initialized data that contribute to the


image. This section is of type SHT_PROGBITS. The attribute
and SHF_WRITE.

.debug This section holds information for symbolic debugging.


unspecified. This section is of type SHT_PROGBITS. No
used.

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 13/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

.dtors This section holds initialized pointers to the C++ destructo


section is of type SHT_PROGBITS. The attribute types
SHF_WRITE.

.dynamic This section holds dynamic linking information. The section


include the SHF_ALLOC bit. Whether the SHF_WRITE bit i
specific. This section is of type SHT_DYNAMIC. See the att

.dynstr This section holds strings needed for dynamic linking, most c
that represent the names associated with symbol table entrie
of type SHT_STRTAB. The attribute type used is SHF_ALLOC.

.dynsym This section holds the dynamic linking symbol table. This se
SHT_DYNSYM. The attribute used is SHF_ALLOC.

.fini This section holds executable instructions that contrib


termination code. When a program exits normally the system a
the code in this section. This section is of type SHT_PROGBI
used are SHF_ALLOC and SHF_EXECINSTR.

.gnu.version
This section holds the version symbol table, an array of E
This section is of type SHT_GNU_versym. The attribute type u

.gnu.version_d
This section holds the version symbol definitions, a t
structures. This section is of type SHT_GNU_verdef. The att
SHF_ALLOC.

.gnu.version_r
This section holds the version symbol needed elements, a ta
structures. This section is of type SHT_GNU_versym. The att
SHF_ALLOC.

.got This section holds the global offset table. This se


SHT_PROGBITS. The attributes are processor-specific.

.hash This section holds a symbol hash table. This section is of t


attribute used is SHF_ALLOC.

.init This section holds executable instructions that contrib


initialization code. When a program starts to run the s

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 14/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

execute the code in this section before calling the main p


This section is of type SHT_PROGBITS. The attributes used
SHF_EXECINSTR.

.interp This section holds the pathname of a program interpreter


loadable segment that includes the section, the section
include the SHF_ALLOC bit. Otherwise, that bit will be off.
type SHT_PROGBITS.

.line This section holds line number information for symbolic


describes the correspondence between the program source an
The contents are unspecified. This section is of type
attribute types are used.

.note This section holds various notes. This section is of


attribute types are used.

.note.ABI-tag
This section is used to declare the expected run-time ABI of
may include the operating system name and its run-time vers
is of type SHT_NOTE. The only attribute used is SHF_ALLOC.

.note.gnu.build-id
This section is used to hold an ID that uniquely identifies t
ELF image. Different files with the same build ID shou
executable content. See the --build-id option to the GNU lin
more details. This section is of type SHT_NOTE. The onl
SHF_ALLOC.

.note.GNU-stack
This section is used in Linux object files for declaring stac
section is of type SHT_PROGBITS. The only attribute use
This indicates to the GNU linker that the object file requi
stack.

.note.openbsd.ident
OpenBSD native executables usually contain this section to
so the kernel can bypass any compatibility ELF binary emu
loading the file.

.plt This section holds the procedure linkage table. This


SHT_PROGBITS. The attributes are processor-specific.

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 15/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

.relNAME This section holds relocation information as described below


loadable segment that includes relocation, the section's att
the SHF_ALLOC bit. Otherwise, the bit will be off. By conv
supplied by the section to which the relocations apply
section for .text normally would have the name .rel.text. Th
type SHT_REL.

.relaNAME This section holds relocation information as described below


loadable segment that includes relocation, the section's att
the SHF_ALLOC bit. Otherwise, the bit will be off. By co
supplied by the section to which the relocations apply.
section for .text normally would have the name .rela.text.
type SHT_RELA.

.rodata This section holds read-only data that typically contributes


segment in the process image. This section is of type
attribute used is SHF_ALLOC.

.rodata1 This section holds read-only data that typically contributes


segment in the process image. This section is of type
attribute used is SHF_ALLOC.

.shstrtab This section holds section names. This section is of typ


attribute types are used.

.strtab This section holds strings, most commonly the strings that
associated with symbol table entries. If the file has a load
includes the symbol string table, the section's attribut
SHF_ALLOC bit. Otherwise, the bit will be off. This se
SHT_STRTAB.

.symtab This section holds a symbol table. If the file has a lo


includes the symbol table, the section's attributes will incl
bit. Otherwise, the bit will be off. This section is of typ

.text This section holds the "text", or executable instructions,


section is of type SHT_PROGBITS. The attributes used
SHF_EXECINSTR.

String and symbol tables


String table sections hold null-terminated character sequences, commo
The object file uses these strings to represent symbol and section name
a string as an index into the string table section. The first byte, w

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 16/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

is defined to hold a null byte ('\0'). Similarly, a string table's las


to hold a null byte, ensuring null termination for all strings.

An object file's symbol table holds information needed to locate and


symbolic definitions and references. A symbol table index is a subscri

typedef struct {
uint32_t st_name;
Elf32_Addr st_value;
uint32_t st_size;
unsigned char st_info;
unsigned char st_other;
uint16_t st_shndx;
} Elf32_Sym;

typedef struct {
uint32_t st_name;
unsigned char st_info;
unsigned char st_other;
uint16_t st_shndx;
Elf64_Addr st_value;
uint64_t st_size;
} Elf64_Sym;

The 32-bit and 64-bit versions have the same members, just in a differe

st_name This member holds an index into the object file's symbol st
holds character representations of the symbol names. If th
it represents a string table index that gives the symbol name
symbol has no name.

st_value This member gives the value of the associated symbol.

st_size Many symbols have associated sizes. This member holds zero i
size or an unknown size.

st_info This member specifies the symbol's type and binding attribute

STT_NOTYPE The symbol's type is not defined.

STT_OBJECT The symbol is associated with a data object.

STT_FUNC The symbol is associated with a function or othe

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 17/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

STT_SECTION The symbol is associated with a section. Symbol


this type exist primarily for relocation and norm
bindings.

STT_FILE By convention, the symbol's name gives the name o


associated with the object file. A file s
bindings, its section index is SHN_ABS, and it p
STB_LOCAL symbols of the file, if it is present.

STT_LOPROC, STT_HIPROC
Values in the inclusive range [STT_LOPROC, STT_H
for processor-specific semantics.

STB_LOCAL Local symbols are not visible outside the objec


their definition. Local symbols of the sam
multiple files without interfering with each othe

STB_GLOBAL Global symbols are visible to all object files be


file's definition of a global symbol will sat
undefined reference to the same symbol.

STB_WEAK Weak symbols resemble global symbols, but thei


lower precedence.

STB_LOPROC, STB_HIPROC
Values in the inclusive range [STB_LOPROC, STB_H
for processor-specific semantics.

There are macros for packing and unpacking the binding and ty

ELF32_ST_BIND(info), ELF64_ST_BIND(info)
Extract a binding from an st_info value.

ELF32_ST_TYPE(info), ELF64_ST_TYPE(info)
Extract a type from an st_info value.

ELF32_ST_INFO(bind, type), ELF64_ST_INFO(bind, type)


Convert a binding and a type into an st_info value.

st_other This member defines the symbol visibility.

STV_DEFAULT Default symbol visibility rules. Global and

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 18/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

available to other modules; references in t


be interposed by definitions in other modules
STV_INTERNAL Processor-specific hidden class.
STV_HIDDEN Symbol is unavailable to other modules; refe
module always resolve to the local symbo
can't be interposed by definitions in other m
STV_PROTECTED Symbol is available to other modules, but
local module always resolve to the local symb

There are macros for extracting the visibility type:

ELF32_ST_VISIBILITY(other) or ELF64_ST_VISIBILITY(other)

st_shndx Every symbol table entry is "defined" in relation to some se


holds the relevant section header table index.

Relocation entries (Rel & Rela)


Relocation is the process of connecting symbolic references with sym
Relocatable files must have information that describes how to m
contents, thus allowing executable and shared object files to hold the
for a process's program image. Relocation entries are these data.

Relocation structures that do not need an addend:

typedef struct {
Elf32_Addr r_offset;
uint32_t r_info;
} Elf32_Rel;

typedef struct {
Elf64_Addr r_offset;
uint64_t r_info;
} Elf64_Rel;

Relocation structures that need an addend:

typedef struct {
Elf32_Addr r_offset;
uint32_t r_info;
int32_t r_addend;
} Elf32_Rela;

typedef struct {

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 19/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

Elf64_Addr r_offset;
uint64_t r_info;
int64_t r_addend;
} Elf64_Rela;

r_offset This member gives the location at which to apply the reloca
relocatable file, the value is the byte offset from the begin
to the storage unit affected by the relocation. For an
shared object, the value is the virtual address of the storag
the relocation.

r_info This member gives both the symbol table index with
relocation must be made and the type of relocation to apply.
are processor-specific. When the text refers to a relocation
type or symbol table index, it means the result of applying E
ELF[32|64]_R_SYM, respectively, to the entry's r_info member

r_addend This member specifies a constant addend used to compute the


into the relocatable field.

Dynamic tags (Dyn)


The .dynamic section contains a series of structures that hold relevan
information. The d_tag member controls the interpretation of d_un.

typedef struct {
Elf32_Sword d_tag;
union {
Elf32_Word d_val;
Elf32_Addr d_ptr;
} d_un;
} Elf32_Dyn;
extern Elf32_Dyn _DYNAMIC[];

typedef struct {
Elf64_Sxword d_tag;
union {
Elf64_Xword d_val;
Elf64_Addr d_ptr;
} d_un;
} Elf64_Dyn;
extern Elf64_Dyn _DYNAMIC[];

d_tag This member may have any of the following values:

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 20/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

DT_NULL Marks end of dynamic section

DT_NEEDED String table offset to name of a needed library

DT_PLTRELSZ Size in bytes of PLT relocation entries

DT_PLTGOT Address of PLT and/or GOT

DT_HASH Address of symbol hash table

DT_STRTAB Address of string table

DT_SYMTAB Address of symbol table

DT_RELA Address of Rela relocation table

DT_RELASZ Size in bytes of the Rela relocation table

DT_RELAENT Size in bytes of a Rela relocation table entry

DT_STRSZ Size in bytes of string table

DT_SYMENT Size in bytes of a symbol table entry

DT_INIT Address of the initialization function

DT_FINI Address of the termination function

DT_SONAME String table offset to name of shared object

DT_RPATH String table offset to library search path (depre

DT_SYMBOLIC Alert linker to search this shared object before


symbols

DT_REL Address of Rel relocation table

DT_RELSZ Size in bytes of Rel relocation table

DT_RELENT Size in bytes of a Rel table entry

DT_PLTREL Type of relocation entry to which the PLT refers

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 21/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

DT_DEBUG Undefined use for debugging

DT_TEXTREL Absence of this entry indicates that no relocati


apply to a nonwritable segment

DT_JMPREL Address of relocation entries associated solely w

DT_BIND_NOW Instruct dynamic linker to process all


transferring control to the executable

DT_RUNPATH String table offset to library search path

DT_LOPROC, DT_HIPROC
Values in the inclusive range [DT_LOPROC, DT_HIP
for processor-specific semantics

d_val This member represents integer values with various interpreta

d_ptr This member represents program virtual addresses. When


addresses, the actual address should be computed based on
value and memory base address. Files do not contain relocati
these addresses.

_DYNAMIC Array containing all the dynamic structures in the .dynamic


automatically populated by the linker.

Notes (Nhdr)
ELF notes allow for appending arbitrary information for the syste
largely used by core files (e_type of ET_CORE), but many projects defin
extensions. For example, the GNU tool chain uses ELF notes to pass i
linker to the C library.

Note sections contain a series of notes (see the struct definitions bel
followed by the name field (whose length is defined in n_name
descriptor field (whose length is defined in n_descsz) and whose starti
byte alignment. Neither field is defined in the note struct due
lengths.

An example for parsing out two consecutive notes should clarify their l

void *memory, *name, *desc;


Elf64_Nhdr *note, *next_note;

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 22/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

/* The buffer is pointing to the start of the section/segment */


note = memory;

/* If the name is defined, it follows the note */


name = note->n_namesz == 0 ? NULL : memory + sizeof(*note);

/* If the descriptor is defined, it follows the name


(with alignment) */

desc = note->n_descsz == 0 ? NULL :


memory + sizeof(*note) + ALIGN_UP(note->n_namesz, 4);

/* The next note follows both (with alignment) */


next_note = memory + sizeof(*note) +
ALIGN_UP(note->n_namesz, 4) +
ALIGN_UP(note->n_descsz, 4);

Keep in mind that the interpretation of n_type depends on the namespac


n_namesz field. If the n_namesz field is not set (e.g., is 0), then th
notes: one for core files and one for all other ELF types. If the name
then tools will usually fallback to these sets of notes as well.

typedef struct {
Elf32_Word n_namesz;
Elf32_Word n_descsz;
Elf32_Word n_type;
} Elf32_Nhdr;

typedef struct {
Elf64_Word n_namesz;
Elf64_Word n_descsz;
Elf64_Word n_type;
} Elf64_Nhdr;

n_namesz The length of the name field in bytes. The contents will
this note in memory. The name is null terminated. For examp
"GNU", then n_namesz will be set to 4.

n_descsz The length of the descriptor field in bytes. The conten


follow the name field in memory.

n_type Depending on the value of the name field, this member may

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 23/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

following values:

Core files (e_type = ET_CORE)


Notes used by all core files. These are highly
architecture specific and often require close coordinati
libraries, and debuggers. These are used when the names
(i.e., n_namesz will be set to 0), or a fallback when
unknown.

NT_PRSTATUS prstatus struct


NT_FPREGSET fpregset struct
NT_PRPSINFO prpsinfo struct
NT_PRXREG prxregset struct
NT_TASKSTRUCT task structure
NT_PLATFORM String from sysinfo(SI_PLATFORM)
NT_AUXV auxv array
NT_GWINDOWS gwindows struct
NT_ASRS asrset struct
NT_PSTATUS pstatus struct
NT_PSINFO psinfo struct
NT_PRCRED prcred struct
NT_UTSNAME utsname struct
NT_LWPSTATUS lwpstatus struct
NT_LWPSINFO lwpinfo struct
NT_PRFPXREG fprxregset struct
NT_SIGINFO siginfo_t (size might increase ove
NT_FILE Contains information about mapped f
NT_PRXFPREG user_fxsr_struct
NT_PPC_VMX PowerPC Altivec/VMX registers
NT_PPC_SPE PowerPC SPE/EVR registers
NT_PPC_VSX PowerPC VSX registers
NT_386_TLS i386 TLS slots (struct user_desc)
NT_386_IOPERM x86 io permission bitmap (1=deny)
NT_X86_XSTATE x86 extended state using xsave
NT_S390_HIGH_GPRS s390 upper register halves
NT_S390_TIMER s390 timer register
NT_S390_TODCMP s390 time-of-day (TOD) clock compa
NT_S390_TODPREG s390 time-of-day (TOD) programmable
NT_S390_CTRS s390 control registers
NT_S390_PREFIX s390 prefix register
NT_S390_LAST_BREAK s390 breaking event address
NT_S390_SYSTEM_CALL s390 system call restart data
NT_S390_TDB s390 transaction diagnostic block

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 24/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

NT_ARM_VFP ARM VFP/NEON registers


NT_ARM_TLS ARM TLS register
NT_ARM_HW_BREAK ARM hardware breakpoint registers
NT_ARM_HW_WATCH ARM hardware watchpoint registers
NT_ARM_SYSTEM_CALL ARM system call number

n_name = GNU
Extensions used by the GNU tool chain.

NT_GNU_ABI_TAG
Operating system (OS) ABI information. The d
words:

· word 0: OS descriptor (ELF_NOTE_OS_LINUX, ELF_N


on)`
· word 1: major version of the ABI
· word 2: minor version of the ABI
· word 3: subminor version of the ABI

NT_GNU_HWCAP
Synthetic hwcap information. The desc field begi

· word 0: number of entries


· word 1: bit mask of enabled entries

Then follow variable-length entries, one byte


terminated hwcap name string. The byte gives the
if enabled, (1U << bit) & bit mask.

NT_GNU_BUILD_ID
Unique build ID as generated by the GNU ld(1
The desc consists of any nonzero number of bytes

NT_GNU_GOLD_VERSION
The desc contains the GNU Gold linker version use

Default/unknown namespace (e_type != ET_CORE)


These are used when the namespace is the default (i.e.,
set to 0), or a fallback when the namespace is unknown.

NT_VERSION A version string of some sort.


NT_ARCH Architecture information.

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 25/26
4/13/2020 Ubuntu Manpage: elf - format of Executable and Linking Format (ELF) files

NOTES

ELF first appeared in System V. The ELF format is an adopted standard

The extensions for e_phnum, e_shnum and e_strndx respectively are Linu
BSD and AMD64 also support them; for further information, look under SE

SEE ALSO

as(1), elfedit(1), gdb(1), ld(1), nm(1), objdump(1), patchelf(1), re


strings(1), strip(1), execve(2), dl_iterate_phdr(3), core(5)

Hewlett-Packard, Elf-64 Object File Format.

Santa Cruz Operation, System V Application Binary Interface.

UNIX System Laboratories, "Object Files", Executable and Linking Format

Sun Microsystems, Linker and Libraries Guide.

AMD64 ABI Draft, System V Application Binary Interface AMD64 Arc


Supplement.

COLOPHON

This page is part of release 4.16 of the Linux man-pages project. A d


project, information about reporting bugs, and the latest version o
found at https://www.kernel.org/doc/man-pages/.

Powered by the Ubuntu Manpage Repository, file bugs in Launchpad


© 2019 Canonical Ltd. Ubuntu and Canonical are registered trademarks of Canonical
Ltd.

manpages.ubuntu.com/manpages/cosmic/man5/elf.5.html 26/26

You might also like