1/* $NetBSD: libelf.h,v 1.7 2024/04/01 18:33:22 riastradh Exp $ */
2
3/*-
4 * Copyright (c) 2006,2008-2010 Joseph Koshy
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 *
28 * Id: libelf.h 3984 2022-05-06 11:22:42Z jkoshy
29 */
30
31#ifndef _LIBELF_H_
32#define _LIBELF_H_
33
34#if HAVE_NBTOOL_CONFIG_H
35# include "nbtool_config.h"
36#else
37# include <sys/types.h>
38#endif
39
40#include "elfdefinitions.h"
41
42/* Library private data structures */
43typedef struct _Elf Elf;
44typedef struct _Elf_Scn Elf_Scn;
45
46/* File types */
47typedef enum {
48 ELF_K_NONE = 0,
49 ELF_K_AR, /* `ar' archives */
50 ELF_K_COFF, /* COFF files (unsupported) */
51 ELF_K_ELF, /* ELF files */
52 ELF_K_NUM
53} Elf_Kind;
54
55#define ELF_K_FIRST ELF_K_NONE
56#define ELF_K_LAST ELF_K_NUM
57
58/* Data types */
59typedef enum {
60 ELF_T_ADDR,
61 ELF_T_BYTE,
62 ELF_T_CAP,
63 ELF_T_DYN,
64 ELF_T_EHDR,
65 ELF_T_HALF,
66 ELF_T_LWORD,
67 ELF_T_MOVE,
68 ELF_T_MOVEP,
69 ELF_T_NOTE,
70 ELF_T_OFF,
71 ELF_T_PHDR,
72 ELF_T_REL,
73 ELF_T_RELA,
74 ELF_T_SHDR,
75 ELF_T_SWORD,
76 ELF_T_SXWORD,
77 ELF_T_SYMINFO,
78 ELF_T_SYM,
79 ELF_T_VDEF,
80 ELF_T_VNEED,
81 ELF_T_WORD,
82 ELF_T_XWORD,
83 ELF_T_GNUHASH, /* GNU style hash tables. */
84 ELF_T_NUM
85} Elf_Type;
86
87#define ELF_T_FIRST ELF_T_ADDR
88#define ELF_T_LAST ELF_T_GNUHASH
89
90/* Commands */
91typedef enum {
92 ELF_C_NULL = 0,
93 ELF_C_CLR,
94 ELF_C_FDDONE,
95 ELF_C_FDREAD,
96 ELF_C_RDWR,
97 ELF_C_READ,
98 ELF_C_SET,
99 ELF_C_WRITE,
100 ELF_C_NUM
101} Elf_Cmd;
102
103#define ELF_C_FIRST ELF_C_NULL
104#define ELF_C_LAST ELF_C_NUM
105
106/*
107 * An `Elf_Data' structure describes data in an
108 * ELF section.
109 */
110typedef struct _Elf_Data {
111 /*
112 * `Public' members that are part of the ELF(3) API.
113 */
114 uint64_t d_align;
115 void *d_buf;
116 uint64_t d_off;
117 uint64_t d_size;
118 Elf_Type d_type;
119 unsigned int d_version;
120} Elf_Data;
121
122/*
123 * An `Elf_Arhdr' structure describes an archive
124 * header.
125 */
126typedef struct {
127 time_t ar_date;
128 char *ar_name; /* archive member name */
129 gid_t ar_gid;
130 mode_t ar_mode;
131 char *ar_rawname; /* 'raw' member name */
132 size_t ar_size;
133 uid_t ar_uid;
134
135 /*
136 * Members that are not part of the public API.
137 */
138 unsigned int ar_flags;
139} Elf_Arhdr;
140
141/*
142 * An `Elf_Arsym' describes an entry in the archive
143 * symbol table.
144 */
145typedef struct {
146 off_t as_off; /* byte offset to member's header */
147 unsigned long as_hash; /* elf_hash() value for name */
148 char *as_name; /* null terminated symbol name */
149} Elf_Arsym;
150
151/*
152 * Error numbers.
153 */
154
155enum Elf_Error {
156 ELF_E_NONE, /* No error */
157 ELF_E_ARCHIVE, /* Malformed ar(1) archive */
158 ELF_E_ARGUMENT, /* Invalid argument */
159 ELF_E_CLASS, /* Mismatched ELF class */
160 ELF_E_DATA, /* Invalid data descriptor */
161 ELF_E_HEADER, /* Missing or malformed ELF header */
162 ELF_E_IO, /* I/O error */
163 ELF_E_LAYOUT, /* Layout constraint violation */
164 ELF_E_MODE, /* Wrong mode for ELF descriptor */
165 ELF_E_RANGE, /* Value out of range */
166 ELF_E_RESOURCE, /* Resource exhaustion */
167 ELF_E_SECTION, /* Invalid section descriptor */
168 ELF_E_SEQUENCE, /* API calls out of sequence */
169 ELF_E_UNIMPL, /* Feature is unimplemented */
170 ELF_E_VERSION, /* Unknown API version */
171 ELF_E_NUM /* Max error number */
172};
173
174/*
175 * Flags defined by the API.
176 */
177
178#define ELF_F_LAYOUT 0x001U /* application will layout the file */
179#define ELF_F_DIRTY 0x002U /* a section or ELF file is dirty */
180
181/* ELF(3) API extensions. */
182#define ELF_F_ARCHIVE 0x100U /* archive creation */
183#define ELF_F_ARCHIVE_SYSV 0x200U /* SYSV style archive */
184
185#ifdef __cplusplus
186extern "C" {
187#endif
188Elf *elf_begin(int _fd, Elf_Cmd _cmd, Elf *_elf);
189int elf_cntl(Elf *_elf, Elf_Cmd _cmd);
190int elf_end(Elf *_elf);
191const char *elf_errmsg(int _error);
192int elf_errno(void);
193void elf_fill(int _fill);
194unsigned int elf_flagarhdr(Elf_Arhdr *_arh, Elf_Cmd _cmd,
195 unsigned int _flags);
196unsigned int elf_flagdata(Elf_Data *_data, Elf_Cmd _cmd,
197 unsigned int _flags);
198unsigned int elf_flagehdr(Elf *_elf, Elf_Cmd _cmd, unsigned int _flags);
199unsigned int elf_flagelf(Elf *_elf, Elf_Cmd _cmd, unsigned int _flags);
200unsigned int elf_flagphdr(Elf *_elf, Elf_Cmd _cmd, unsigned int _flags);
201unsigned int elf_flagscn(Elf_Scn *_scn, Elf_Cmd _cmd, unsigned int _flags);
202unsigned int elf_flagshdr(Elf_Scn *_scn, Elf_Cmd _cmd, unsigned int _flags);
203Elf_Arhdr *elf_getarhdr(Elf *_elf);
204Elf_Arsym *elf_getarsym(Elf *_elf, size_t *_ptr);
205off_t elf_getbase(Elf *_elf);
206Elf_Data *elf_getdata(Elf_Scn *, Elf_Data *);
207char *elf_getident(Elf *_elf, size_t *_ptr);
208int elf_getphdrnum(Elf *_elf, size_t *_dst);
209int elf_getphnum(Elf *_elf, size_t *_dst); /* Deprecated */
210Elf_Scn *elf_getscn(Elf *_elf, size_t _index);
211int elf_getshdrnum(Elf *_elf, size_t *_dst);
212int elf_getshnum(Elf *_elf, size_t *_dst); /* Deprecated */
213int elf_getshdrstrndx(Elf *_elf, size_t *_dst);
214int elf_getshstrndx(Elf *_elf, size_t *_dst); /* Deprecated */
215unsigned int elf_getversion(Elf *_elf);
216unsigned long elf_hash(const void *_name);
217Elf_Kind elf_kind(Elf *_elf);
218Elf *elf_memory(char *_image, size_t _size);
219size_t elf_ndxscn(Elf_Scn *_scn);
220Elf_Data *elf_newdata(Elf_Scn *_scn);
221Elf_Scn *elf_newscn(Elf *_elf);
222Elf_Scn *elf_nextscn(Elf *_elf, Elf_Scn *_scn);
223Elf_Cmd elf_next(Elf *_elf);
224Elf *elf_open(int _fd);
225Elf *elf_openmemory(char *_image, size_t _size);
226off_t elf_rand(Elf *_elf, off_t _off);
227Elf_Data *elf_rawdata(Elf_Scn *_scn, Elf_Data *_data);
228char *elf_rawfile(Elf *_elf, size_t *_size);
229int elf_setshstrndx(Elf *_elf, size_t _shnum);
230char *elf_strptr(Elf *_elf, size_t _section, size_t _offset);
231off_t elf_update(Elf *_elf, Elf_Cmd _cmd);
232unsigned int elf_version(unsigned int _version);
233
234long elf32_checksum(Elf *_elf);
235size_t elf32_fsize(Elf_Type _type, size_t _count,
236 unsigned int _version);
237Elf32_Ehdr *elf32_getehdr(Elf *_elf);
238Elf32_Phdr *elf32_getphdr(Elf *_elf);
239Elf32_Shdr *elf32_getshdr(Elf_Scn *_scn);
240Elf32_Ehdr *elf32_newehdr(Elf *_elf);
241Elf32_Phdr *elf32_newphdr(Elf *_elf, size_t _count);
242Elf_Data *elf32_xlatetof(Elf_Data *_dst, const Elf_Data *_src,
243 unsigned int _enc);
244Elf_Data *elf32_xlatetom(Elf_Data *_dst, const Elf_Data *_src,
245 unsigned int _enc);
246
247long elf64_checksum(Elf *_elf);
248size_t elf64_fsize(Elf_Type _type, size_t _count,
249 unsigned int _version);
250Elf64_Ehdr *elf64_getehdr(Elf *_elf);
251Elf64_Phdr *elf64_getphdr(Elf *_elf);
252Elf64_Shdr *elf64_getshdr(Elf_Scn *_scn);
253Elf64_Ehdr *elf64_newehdr(Elf *_elf);
254Elf64_Phdr *elf64_newphdr(Elf *_elf, size_t _count);
255Elf_Data *elf64_xlatetof(Elf_Data *_dst, const Elf_Data *_src,
256 unsigned int _enc);
257Elf_Data *elf64_xlatetom(Elf_Data *_dst, const Elf_Data *_src,
258 unsigned int _enc);
259#ifdef __cplusplus
260}
261#endif
262
263#endif /* _LIBELF_H_ */