2 * Copyright (c) 2006,2008-2010 Joseph Koshy
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * $Id: libelf.h 3174 2015-03-27 17:13:41Z emaste $
32 #include <sys/types.h>
34 #include <elfdefinitions.h>
36 /* Library private data structures */
37 typedef struct _Elf Elf
;
38 typedef struct _Elf_Scn Elf_Scn
;
43 ELF_K_AR
, /* `ar' archives */
44 ELF_K_COFF
, /* COFF files (unsupported) */
45 ELF_K_ELF
, /* ELF files */
49 #define ELF_K_FIRST ELF_K_NONE
50 #define ELF_K_LAST ELF_K_NUM
77 ELF_T_GNUHASH
, /* GNU style hash tables. */
81 #define ELF_T_FIRST ELF_T_ADDR
82 #define ELF_T_LAST ELF_T_GNUHASH
97 #define ELF_C_FIRST ELF_C_NULL
98 #define ELF_C_LAST ELF_C_NUM
101 * An `Elf_Data' structure describes data in an
104 typedef struct _Elf_Data
{
106 * `Public' members that are part of the ELF(3) API.
113 unsigned int d_version
;
117 * An `Elf_Arhdr' structure describes an archive
122 char *ar_name
; /* archive member name */
125 char *ar_rawname
; /* 'raw' member name */
130 * Members that are not part of the public API.
132 unsigned int ar_flags
;
136 * An `Elf_Arsym' describes an entry in the archive
140 off_t as_off
; /* byte offset to member's header */
141 unsigned long as_hash
; /* elf_hash() value for name */
142 char *as_name
; /* null terminated symbol name */
150 ELF_E_NONE
, /* No error */
151 ELF_E_ARCHIVE
, /* Malformed ar(1) archive */
152 ELF_E_ARGUMENT
, /* Invalid argument */
153 ELF_E_CLASS
, /* Mismatched ELF class */
154 ELF_E_DATA
, /* Invalid data descriptor */
155 ELF_E_HEADER
, /* Missing or malformed ELF header */
156 ELF_E_IO
, /* I/O error */
157 ELF_E_LAYOUT
, /* Layout constraint violation */
158 ELF_E_MODE
, /* Wrong mode for ELF descriptor */
159 ELF_E_RANGE
, /* Value out of range */
160 ELF_E_RESOURCE
, /* Resource exhaustion */
161 ELF_E_SECTION
, /* Invalid section descriptor */
162 ELF_E_SEQUENCE
, /* API calls out of sequence */
163 ELF_E_UNIMPL
, /* Feature is unimplemented */
164 ELF_E_VERSION
, /* Unknown API version */
165 ELF_E_NUM
/* Max error number */
169 * Flags defined by the API.
172 #define ELF_F_LAYOUT 0x001U /* application will layout the file */
173 #define ELF_F_DIRTY 0x002U /* a section or ELF file is dirty */
175 /* ELF(3) API extensions. */
176 #define ELF_F_ARCHIVE 0x100U /* archive creation */
177 #define ELF_F_ARCHIVE_SYSV 0x200U /* SYSV style archive */
182 Elf
*elf_begin(int _fd
, Elf_Cmd _cmd
, Elf
*_elf
);
183 int elf_cntl(Elf
*_elf
, Elf_Cmd _cmd
);
184 int elf_end(Elf
*_elf
);
185 const char *elf_errmsg(int _error
);
187 void elf_fill(int _fill
);
188 unsigned int elf_flagarhdr(Elf_Arhdr
*_arh
, Elf_Cmd _cmd
,
189 unsigned int _flags
);
190 unsigned int elf_flagdata(Elf_Data
*_data
, Elf_Cmd _cmd
,
191 unsigned int _flags
);
192 unsigned int elf_flagehdr(Elf
*_elf
, Elf_Cmd _cmd
, unsigned int _flags
);
193 unsigned int elf_flagelf(Elf
*_elf
, Elf_Cmd _cmd
, unsigned int _flags
);
194 unsigned int elf_flagphdr(Elf
*_elf
, Elf_Cmd _cmd
, unsigned int _flags
);
195 unsigned int elf_flagscn(Elf_Scn
*_scn
, Elf_Cmd _cmd
, unsigned int _flags
);
196 unsigned int elf_flagshdr(Elf_Scn
*_scn
, Elf_Cmd _cmd
, unsigned int _flags
);
197 Elf_Arhdr
*elf_getarhdr(Elf
*_elf
);
198 Elf_Arsym
*elf_getarsym(Elf
*_elf
, size_t *_ptr
);
199 off_t
elf_getbase(Elf
*_elf
);
200 Elf_Data
*elf_getdata(Elf_Scn
*, Elf_Data
*);
201 char *elf_getident(Elf
*_elf
, size_t *_ptr
);
202 int elf_getphdrnum(Elf
*_elf
, size_t *_dst
);
203 int elf_getphnum(Elf
*_elf
, size_t *_dst
); /* Deprecated */
204 Elf_Scn
*elf_getscn(Elf
*_elf
, size_t _index
);
205 int elf_getshdrnum(Elf
*_elf
, size_t *_dst
);
206 int elf_getshnum(Elf
*_elf
, size_t *_dst
); /* Deprecated */
207 int elf_getshdrstrndx(Elf
*_elf
, size_t *_dst
);
208 int elf_getshstrndx(Elf
*_elf
, size_t *_dst
); /* Deprecated */
209 unsigned long elf_hash(const char *_name
);
210 Elf_Kind
elf_kind(Elf
*_elf
);
211 Elf
*elf_memory(char *_image
, size_t _size
);
212 size_t elf_ndxscn(Elf_Scn
*_scn
);
213 Elf_Data
*elf_newdata(Elf_Scn
*_scn
);
214 Elf_Scn
*elf_newscn(Elf
*_elf
);
215 Elf_Scn
*elf_nextscn(Elf
*_elf
, Elf_Scn
*_scn
);
216 Elf_Cmd
elf_next(Elf
*_elf
);
217 Elf
*elf_open(int _fd
);
218 Elf
*elf_openmemory(char *_image
, size_t _size
);
219 off_t
elf_rand(Elf
*_elf
, off_t _off
);
220 Elf_Data
*elf_rawdata(Elf_Scn
*_scn
, Elf_Data
*_data
);
221 char *elf_rawfile(Elf
*_elf
, size_t *_size
);
222 int elf_setshstrndx(Elf
*_elf
, size_t _shnum
);
223 char *elf_strptr(Elf
*_elf
, size_t _section
, size_t _offset
);
224 off_t
elf_update(Elf
*_elf
, Elf_Cmd _cmd
);
225 unsigned int elf_version(unsigned int _version
);
227 long elf32_checksum(Elf
*_elf
);
228 size_t elf32_fsize(Elf_Type _type
, size_t _count
,
229 unsigned int _version
);
230 Elf32_Ehdr
*elf32_getehdr(Elf
*_elf
);
231 Elf32_Phdr
*elf32_getphdr(Elf
*_elf
);
232 Elf32_Shdr
*elf32_getshdr(Elf_Scn
*_scn
);
233 Elf32_Ehdr
*elf32_newehdr(Elf
*_elf
);
234 Elf32_Phdr
*elf32_newphdr(Elf
*_elf
, size_t _count
);
235 Elf_Data
*elf32_xlatetof(Elf_Data
*_dst
, const Elf_Data
*_src
,
237 Elf_Data
*elf32_xlatetom(Elf_Data
*_dst
, const Elf_Data
*_src
,
240 long elf64_checksum(Elf
*_elf
);
241 size_t elf64_fsize(Elf_Type _type
, size_t _count
,
242 unsigned int _version
);
243 Elf64_Ehdr
*elf64_getehdr(Elf
*_elf
);
244 Elf64_Phdr
*elf64_getphdr(Elf
*_elf
);
245 Elf64_Shdr
*elf64_getshdr(Elf_Scn
*_scn
);
246 Elf64_Ehdr
*elf64_newehdr(Elf
*_elf
);
247 Elf64_Phdr
*elf64_newphdr(Elf
*_elf
, size_t _count
);
248 Elf_Data
*elf64_xlatetof(Elf_Data
*_dst
, const Elf_Data
*_src
,
250 Elf_Data
*elf64_xlatetom(Elf_Data
*_dst
, const Elf_Data
*_src
,
256 #endif /* _LIBELF_H_ */