xref: /netbsd-src/external/bsd/elftoolchain/dist/libelf/gelf_getehdr.3 (revision 5ac3bc719ce6e70593039505b491894133237d12)

.\"	$NetBSD: gelf_getehdr.3,v 1.6 2024/03/03 17:37:34 christos Exp $
.\"
.\" Copyright (c) 2006,2008 Joseph Koshy.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 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.
.\"
.\" This software is provided by Joseph Koshy ``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 Joseph Koshy 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
.\" such damage.
.\"
.\" Id: gelf_getehdr.3 3958 2022-03-12 14:31:32Z jkoshy
.\"
.Dd December 16, 2006
.Dt GELF_GETEHDR 3
.Os
.Sh NAME
.Nm elf32_getehdr ,
.Nm elf64_getehdr ,
.Nm gelf_getehdr
.Nd retrieve the object file header
.Sh LIBRARY
.Lb libelf
.Sh SYNOPSIS
.In libelf.h
.Ft "Elf32_Ehdr *"
.Fn elf32_getehdr "Elf *elf"
.Ft "Elf64_Ehdr *"
.Fn elf64_getehdr "Elf *elf"
.In gelf.h
.Ft "GElf_Ehdr *"
.Fn gelf_getehdr "Elf *elf" "GElf_Ehdr *dst"
.Sh DESCRIPTION
These functions retrieve the ELF object file
header from the ELF descriptor
.Fa elf
and return a translated header descriptor to their callers.
.Pp
Functions
.Fn elf32_getehdr
and
.Fn elf64_getehdr
return a pointer to the appropriate class-specific header descriptor
if it exists in the file referenced by descriptor
.Fa elf .
These functions return
.Dv NULL
if an ELF header was not found in file
.Fa elf .
.Pp
Function
.Fn gelf_getehdr
stores a translated copy of the header for ELF file
.Fa elf
into the descriptor pointed to by argument
.Fa dst .
It returns argument
.Fa dst
if successful or
.Dv NULL
in case of failure.
.Sh RETURN VALUES
These functions return a pointer to a translated header descriptor
if successful, or
.Dv NULL
on failure.
.Sh ERRORS
These functions can fail with the following errors:
.Bl -tag -width "[ELF_E_RESOURCE]"
.It Bq Er ELF_E_ARGUMENT
The argument
.Fa elf
was null.
.It Bq Er ELF_E_ARGUMENT
Argument
.Fa elf
was not a descriptor for an ELF file.
.It Bq Er ELF_E_ARGUMENT
The elf class of descriptor
.Fa elf
was not recognized.
.It Bq Er ELF_E_ARGUMENT
Argument
.Fa dst
was null.
.It Bq Er ELF_E_CLASS
The ELF class of descriptor
.Fa elf
did not match that of the API function being called.
.It Bq Er ELF_E_HEADER
ELF descriptor
.Fa elf
does not have an associated header.
.It Bq Er ELF_E_RESOURCE
An out of memory condition was detected during execution.
.It Bq Er ELF_E_SECTION
The ELF descriptor in argument
.Fa elf
did not adhere to the conventions used for extended numbering.
.It Bq Er ELF_E_VERSION
The ELF descriptor
.Fa elf
had an unsupported ELF version number.
.El
.Sh SEE ALSO
.Xr elf 3 ,
.Xr elf32_newehdr 3 ,
.Xr elf64_newehdr 3 ,
.Xr elf_flagehdr 3 ,
.Xr elf_getident 3 ,
.Xr gelf 3 ,
.Xr gelf_newehdr 3 ,
.Xr elf 5