Changeset View
Changeset View
Standalone View
Standalone View
head/contrib/elftoolchain/libelf/gelf.3
Show All 17 Lines | |||||
.\" or services; loss of use, data, or profits; or business interruption) | .\" or services; loss of use, data, or profits; or business interruption) | ||||
.\" however caused and on any theory of liability, whether in contract, strict | .\" however caused and on any theory of liability, whether in contract, strict | ||||
.\" liability, or tort (including negligence or otherwise) arising in any way | .\" 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 | .\" out of the use of this software, even if advised of the possibility of | ||||
.\" such damage. | .\" such damage. | ||||
.\" | .\" | ||||
.\" $Id: gelf.3 3743 2019-06-12 19:36:30Z jkoshy $ | .\" $Id: gelf.3 3743 2019-06-12 19:36:30Z jkoshy $ | ||||
.\" | .\" | ||||
.Dd June 12, 2019 | .Dd October 23, 2020 | ||||
.Dt GELF 3 | .Dt GELF 3 | ||||
.Os | .Os | ||||
.Sh NAME | .Sh NAME | ||||
.Nm gelf | .Nm gelf | ||||
.Nd class-independent API for ELF manipulation | .Nd class-independent API for ELF manipulation | ||||
.Sh LIBRARY | .Sh LIBRARY | ||||
.Lb libelf | .Lb libelf | ||||
.Sh SYNOPSIS | .Sh SYNOPSIS | ||||
.In gelf.h | .In gelf.h | ||||
.Sh DESCRIPTION | .Sh DESCRIPTION | ||||
This manual page describes a class independent API for manipulating | This manual page describes a class independent API for manipulating | ||||
ELF objects. | ELF objects. | ||||
This API allows an application to operate on ELF descriptors without | This API allows an application to operate on ELF descriptors without | ||||
needing to the know the ELF class of the descriptor. | needing to the know the ELF class of the descriptor. | ||||
.Pp | .Pp | ||||
The GElf API may be used alongside the ELF API without restriction. | The GElf API may be used alongside the ELF API without restriction. | ||||
.Ss GElf Data Structures | .Ss GElf Data Structures | ||||
The GElf API defines the following class-independent data structures: | The GElf API defines the following class-independent data structures: | ||||
.Bl -tag -width GElf_Sxword | .Bl -tag -width GElf_Sxword | ||||
.It Vt GElf_Addr | .It Vt GElf_Addr | ||||
A representation of ELF addresses. | A representation of ELF addresses. | ||||
.It Vt GElf_Chdr | |||||
A class-independent representation of an ELF Compression Header. | |||||
.It Vt GElf_Dyn | .It Vt GElf_Dyn | ||||
A class-independent representation of ELF | A class-independent representation of ELF | ||||
.Sy .dynamic | .Sy .dynamic | ||||
section entries. | section entries. | ||||
.It Vt GElf_Ehdr | .It Vt GElf_Ehdr | ||||
A class-independent representation of an ELF Executable Header. | A class-independent representation of an ELF Executable Header. | ||||
.It Vt GElf_Half | .It Vt GElf_Half | ||||
An unsigned 16 bit quantity. | An unsigned 16 bit quantity. | ||||
▲ Show 20 Lines • Show All 83 Lines • ▼ Show 20 Lines | |||||
Translate the native representation of an ELF data structure to its | Translate the native representation of an ELF data structure to its | ||||
file representation. | file representation. | ||||
.It Fn gelf_xlatetom | .It Fn gelf_xlatetom | ||||
Translate from the file representation of an ELF data structure to a | Translate from the file representation of an ELF data structure to a | ||||
native representation. | native representation. | ||||
.El | .El | ||||
.It "Retrieving ELF Data" | .It "Retrieving ELF Data" | ||||
.Bl -tag -compact -width indent | .Bl -tag -compact -width indent | ||||
.It Fn gelf_getchdr | |||||
Retrieve an ELF Compression Header from the underlying ELF descriptor. | |||||
.It Fn gelf_getdyn | .It Fn gelf_getdyn | ||||
Retrieve an ELF | Retrieve an ELF | ||||
.Sy .dynamic | .Sy .dynamic | ||||
table entry. | table entry. | ||||
.It Fn gelf_getehdr | .It Fn gelf_getehdr | ||||
Retrieve an ELF Executable Header from the underlying ELF descriptor. | Retrieve an ELF Executable Header from the underlying ELF descriptor. | ||||
.It Fn gelf_getphdr | .It Fn gelf_getphdr | ||||
Retrieve an ELF Program Header Table entry from the underlying ELF descriptor. | Retrieve an ELF Program Header Table entry from the underlying ELF descriptor. | ||||
▲ Show 20 Lines • Show All 49 Lines • Show Last 20 Lines |