2 * Copyright (c) 2006 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
32 #include <sys/types.h>
33 #include <sys/elf32.h>
34 #include <sys/elf64.h>
35 #include <sys/queue.h>
37 /* Library private data structures */
38 typedef struct _Elf Elf;
39 typedef struct _Elf_Scn Elf_Scn;
44 ELF_K_AR, /* `ar' archives */
45 ELF_K_COFF, /* COFF files (unsupported) */
46 ELF_K_ELF, /* ELF files */
50 #define ELF_K_FIRST ELF_K_NONE
51 #define ELF_K_LAST ELF_K_NUM
81 #define ELF_T_FIRST ELF_T_ADDR
82 #define ELF_T_LAST ELF_T_XWORD
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;
116 * Members that are not part of the public API.
118 Elf_Scn *d_scn; /* containing section */
119 unsigned int d_flags;
120 STAILQ_ENTRY(_Elf_Data) d_next;
124 * An `Elf_Arhdr' structure describes an archive
129 char *ar_name; /* archive member name */
132 char *ar_rawname; /* 'raw' member name */
138 * An `Elf_Arsym' describes an entry in the archive
142 off_t as_off; /* byte offset to member's header */
143 unsigned long as_hash; /* elf_hash() value for name */
144 char *as_name; /* null terminated symbol name */
152 ELF_E_NONE, /* No error */
153 ELF_E_ARCHIVE, /* Malformed ar(1) archive */
154 ELF_E_ARGUMENT, /* Invalid argument */
155 ELF_E_CLASS, /* Mismatched ELF class */
156 ELF_E_DATA, /* Invalid data descriptor */
157 ELF_E_HEADER, /* Missing or malformed ELF header */
158 ELF_E_IO, /* I/O error */
159 ELF_E_LAYOUT, /* Layout constraint violation */
160 ELF_E_MODE, /* Wrong mode for ELF descriptor */
161 ELF_E_RANGE, /* Value out of range */
162 ELF_E_RESOURCE, /* Resource exhaustion */
163 ELF_E_SECTION, /* Invalid section descriptor */
164 ELF_E_SEQUENCE, /* API calls out of sequence */
165 ELF_E_UNIMPL, /* Feature is unimplemented */
166 ELF_E_VERSION, /* Unknown API version */
167 ELF_E_NUM /* Max error number */
171 * Flags defined by the API.
174 #define ELF_F_LAYOUT 0x001U /* application will layout the file */
175 #define ELF_F_DIRTY 0x002U /* a section or ELF file is dirty */
178 Elf *elf_begin(int _fd, Elf_Cmd _cmd, Elf *_elf);
179 int elf_cntl(Elf *_elf, Elf_Cmd _cmd);
180 int elf_end(Elf *_elf);
181 const char *elf_errmsg(int _error);
183 void elf_fill(int _fill);
184 unsigned int elf_flagdata(Elf_Data *_data, Elf_Cmd _cmd, unsigned int _flags);
185 unsigned int elf_flagehdr(Elf *_elf, Elf_Cmd _cmd, unsigned int _flags);
186 unsigned int elf_flagelf(Elf *_elf, Elf_Cmd _cmd, unsigned int _flags);
187 unsigned int elf_flagphdr(Elf *_elf, Elf_Cmd _cmd, unsigned int _flags);
188 unsigned int elf_flagscn(Elf_Scn *_scn, Elf_Cmd _cmd, unsigned int _flags);
189 unsigned int elf_flagshdr(Elf_Scn *_scn, Elf_Cmd _cmd, unsigned int _flags);
190 Elf_Arhdr *elf_getarhdr(Elf *_elf);
191 Elf_Arsym *elf_getarsym(Elf *_elf, size_t *_ptr);
192 off_t elf_getbase(Elf *_elf);
193 Elf_Data *elf_getdata(Elf_Scn *, Elf_Data *);
194 char *elf_getident(Elf *_elf, size_t *_ptr);
195 int elf_getphnum(Elf *_elf, size_t *_dst);
196 Elf_Scn *elf_getscn(Elf *_elf, size_t _index);
197 int elf_getshnum(Elf *_elf, size_t *_dst);
198 int elf_getshstrndx(Elf *_elf, size_t *_dst);
199 unsigned long elf_hash(const char *_name);
200 Elf_Kind elf_kind(Elf *_elf);
201 Elf *elf_memory(char *_image, size_t _size);
202 size_t elf_ndxscn(Elf_Scn *_scn);
203 Elf_Data *elf_newdata(Elf_Scn *_scn);
204 Elf_Scn *elf_newscn(Elf *_elf);
205 Elf_Scn *elf_nextscn(Elf *_elf, Elf_Scn *_scn);
206 Elf_Cmd elf_next(Elf *_elf);
207 off_t elf_rand(Elf *_elf, off_t _off);
208 Elf_Data *elf_rawdata(Elf_Scn *_scn, Elf_Data *_data);
209 char *elf_rawfile(Elf *_elf, size_t *_size);
210 int elf_setshstrndx(Elf *_elf, size_t _shnum);
211 char *elf_strptr(Elf *_elf, size_t _section, size_t _offset);
212 off_t elf_update(Elf *_elf, Elf_Cmd _cmd);
213 unsigned int elf_version(unsigned int _version);
215 long elf32_checksum(Elf *_elf);
216 size_t elf32_fsize(Elf_Type _type, size_t _count,
217 unsigned int _version);
218 Elf32_Ehdr *elf32_getehdr(Elf *_elf);
219 Elf32_Phdr *elf32_getphdr(Elf *_elf);
220 Elf32_Shdr *elf32_getshdr(Elf_Scn *_scn);
221 Elf32_Ehdr *elf32_newehdr(Elf *_elf);
222 Elf32_Phdr *elf32_newphdr(Elf *_elf, size_t _count);
223 Elf_Data *elf32_xlatetof(Elf_Data *_dst, const Elf_Data *_src,
225 Elf_Data *elf32_xlatetom(Elf_Data *_dst, const Elf_Data *_src,
228 long elf64_checksum(Elf *_elf);
229 size_t elf64_fsize(Elf_Type _type, size_t _count,
230 unsigned int _version);
231 Elf64_Ehdr *elf64_getehdr(Elf *_elf);
232 Elf64_Phdr *elf64_getphdr(Elf *_elf);
233 Elf64_Shdr *elf64_getshdr(Elf_Scn *_scn);
234 Elf64_Ehdr *elf64_newehdr(Elf *_elf);
235 Elf64_Phdr *elf64_newphdr(Elf *_elf, size_t _count);
236 Elf_Data *elf64_xlatetof(Elf_Data *_dst, const Elf_Data *_src,
238 Elf_Data *elf64_xlatetom(Elf_Data *_dst, const Elf_Data *_src,
241 #if defined(LIBELF_TEST_HOOKS)
242 int _libelf_get_elf_class(Elf *_elf);
243 int _libelf_get_max_error(void);
244 const char *_libelf_get_no_error_message(void);
245 const char *_libelf_get_unknown_error_message(void);
246 void _libelf_set_elf_class(Elf *_elf, int _class);
247 void _libelf_set_error(int _error);
248 #endif /* LIBELF_TEST_HOOKS */
251 #endif /* _LIBELF_H_ */