jcs.org
jcs's openbsd hax
openbsd
1.\" Copyright (c) 2006,2008,2010 Joseph Koshy. All rights reserved.
2.\"
3.\" Redistribution and use in source and binary forms, with or without
4.\" modification, are permitted provided that the following conditions
5.\" are met:
6.\" 1. Redistributions of source code must retain the above copyright
7.\" notice, this list of conditions and the following disclaimer.
8.\" 2. Redistributions in binary form must reproduce the above copyright
9.\" notice, this list of conditions and the following disclaimer in the
10.\" documentation and/or other materials provided with the distribution.
11.\"
12.\" This software is provided by Joseph Koshy ``as is'' and
13.\" any express or implied warranties, including, but not limited to, the
14.\" implied warranties of merchantability and fitness for a particular purpose
15.\" are disclaimed. in no event shall Joseph Koshy be liable
16.\" for any direct, indirect, incidental, special, exemplary, or consequential
17.\" damages (including, but not limited to, procurement of substitute goods
18.\" or services; loss of use, data, or profits; or business interruption)
19.\" however caused and on any theory of liability, whether in contract, strict
20.\" liability, or tort (including negligence or otherwise) arising in any way
21.\" out of the use of this software, even if advised of the possibility of
22.\" such damage.
23.\"
24.\" $Id: elf_getbase.3,v 1.2 2025/06/10 17:19:45 schwarze Exp $
25.\"
26.Dd June 6, 2010
27.Dt ELF_GETBASE 3
28.Os
29.Sh NAME
30.Nm elf_getbase
31.Nd get the base offset for an object file
32.Sh SYNOPSIS
33.Lb libelf
34.In libelf.h
35.Ft off_t
36.Fn elf_getbase "Elf *elf"
37.Sh DESCRIPTION
38Function
39.Fn elf_getbase
40returns the file offset to the first byte of the object referenced by ELF
41descriptor
42.Ar elf .
43.Pp
44For descriptors referencing members of archives, the returned offset is
45the file offset of the member in its containing archive.
46For descriptors to regular objects, the returned offset is (vacuously)
47zero.
48.Sh RETURN VALUES
49Function
50.Fn elf_getbase
51returns a valid file offset if successful, or
52.Pq Vt off_t
53.Li -1
54in case of an error.
55.Sh ERRORS
56Function
57.Fn elf_getbase
58may fail with the following errors:
59.Bl -tag -width "[ELF_E_RESOURCE]"
60.It Bq Er ELF_E_ARGUMENT
61Argument
62.Ar elf
63was NULL.
64.El
65.Sh SEE ALSO
66.Xr elf 3 ,
67.Xr elf_getarhdr 3 ,
68.Xr elf_getident 3 ,
69.Xr elf_rawfile 3 ,
70.Xr gelf 3