1 /* $NetBSD: libelf.h,v 1.8 2025/12/25 18:58:13 jkoshy 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 <stdint.h> 41 42 #include "elfdefinitions.h" 43 44 /* Library private data structures */ 45 typedef struct _Elf Elf; 46 typedef struct _Elf_Scn Elf_Scn; 47 48 /* File types */ 49 typedef enum { 50 ELF_K_NONE = 0, 51 ELF_K_AR, /* `ar' archives */ 52 ELF_K_COFF, /* COFF files (unsupported) */ 53 ELF_K_ELF, /* ELF files */ 54 ELF_K_NUM 55 } Elf_Kind; 56 57 #define ELF_K_FIRST ELF_K_NONE 58 #define ELF_K_LAST ELF_K_NUM 59 60 /* Data types */ 61 typedef enum { 62 ELF_T_ADDR, 63 ELF_T_BYTE, 64 ELF_T_CAP, 65 ELF_T_DYN, 66 ELF_T_EHDR, 67 ELF_T_HALF, 68 ELF_T_LWORD, 69 ELF_T_MOVE, 70 ELF_T_MOVEP, 71 ELF_T_NOTE, 72 ELF_T_OFF, 73 ELF_T_PHDR, 74 ELF_T_REL, 75 ELF_T_RELA, 76 ELF_T_SHDR, 77 ELF_T_SWORD, 78 ELF_T_SXWORD, 79 ELF_T_SYMINFO, 80 ELF_T_SYM, 81 ELF_T_VDEF, 82 ELF_T_VNEED, 83 ELF_T_WORD, 84 ELF_T_XWORD, 85 ELF_T_GNUHASH, /* GNU style hash tables. */ 86 ELF_T_NUM 87 } Elf_Type; 88 89 #define ELF_T_FIRST ELF_T_ADDR 90 #define ELF_T_LAST ELF_T_GNUHASH 91 92 /* Commands */ 93 typedef enum { 94 ELF_C_NULL = 0, 95 ELF_C_CLR, 96 ELF_C_FDDONE, 97 ELF_C_FDREAD, 98 ELF_C_RDWR, 99 ELF_C_READ, 100 ELF_C_SET, 101 ELF_C_WRITE, 102 ELF_C_NUM 103 } Elf_Cmd; 104 105 #define ELF_C_FIRST ELF_C_NULL 106 #define ELF_C_LAST ELF_C_NUM 107 108 /* 109 * An `Elf_Data' structure describes data in an 110 * ELF section. 111 */ 112 typedef struct _Elf_Data { 113 /* 114 * `Public' members that are part of the ELF(3) API. 115 */ 116 uint64_t d_align; 117 void *d_buf; 118 uint64_t d_off; 119 uint64_t d_size; 120 Elf_Type d_type; 121 unsigned int d_version; 122 } Elf_Data; 123 124 /* 125 * An `Elf_Arhdr' structure describes an archive 126 * header. 127 */ 128 typedef struct { 129 time_t ar_date; 130 char *ar_name; /* archive member name */ 131 gid_t ar_gid; 132 mode_t ar_mode; 133 char *ar_rawname; /* 'raw' member name */ 134 size_t ar_size; 135 uid_t ar_uid; 136 137 /* 138 * Members that are not part of the public API. 139 */ 140 unsigned int ar_flags; 141 } Elf_Arhdr; 142 143 /* 144 * An `Elf_Arsym' describes an entry in the archive 145 * symbol table. 146 */ 147 typedef struct { 148 off_t as_off; /* byte offset to member's header */ 149 unsigned long as_hash; /* elf_hash() value for name */ 150 char *as_name; /* null terminated symbol name */ 151 } Elf_Arsym; 152 153 /* 154 * Error numbers. 155 */ 156 157 enum Elf_Error { 158 ELF_E_NONE, /* No error */ 159 ELF_E_ARCHIVE, /* Malformed ar(1) archive */ 160 ELF_E_ARGUMENT, /* Invalid argument */ 161 ELF_E_CLASS, /* Mismatched ELF class */ 162 ELF_E_DATA, /* Invalid data descriptor */ 163 ELF_E_HEADER, /* Missing or malformed ELF header */ 164 ELF_E_IO, /* I/O error */ 165 ELF_E_LAYOUT, /* Layout constraint violation */ 166 ELF_E_MODE, /* Wrong mode for ELF descriptor */ 167 ELF_E_RANGE, /* Value out of range */ 168 ELF_E_RESOURCE, /* Resource exhaustion */ 169 ELF_E_SECTION, /* Invalid section descriptor */ 170 ELF_E_SEQUENCE, /* API calls out of sequence */ 171 ELF_E_UNIMPL, /* Feature is unimplemented */ 172 ELF_E_VERSION, /* Unknown API version */ 173 ELF_E_NUM /* Max error number */ 174 }; 175 176 /* 177 * Flags defined by the API. 178 */ 179 180 #define ELF_F_LAYOUT 0x001U /* application will layout the file */ 181 #define ELF_F_DIRTY 0x002U /* a section or ELF file is dirty */ 182 183 /* ELF(3) API extensions. */ 184 #define ELF_F_ARCHIVE 0x100U /* archive creation */ 185 #define ELF_F_ARCHIVE_SYSV 0x200U /* SYSV style archive */ 186 187 #ifdef __cplusplus 188 extern "C" { 189 #endif 190 Elf *elf_begin(int _fd, Elf_Cmd _cmd, Elf *_elf); 191 int elf_cntl(Elf *_elf, Elf_Cmd _cmd); 192 int elf_end(Elf *_elf); 193 const char *elf_errmsg(int _error); 194 int elf_errno(void); 195 void elf_fill(int _fill); 196 unsigned int elf_flagarhdr(Elf_Arhdr *_arh, Elf_Cmd _cmd, 197 unsigned int _flags); 198 unsigned int elf_flagdata(Elf_Data *_data, Elf_Cmd _cmd, 199 unsigned int _flags); 200 unsigned int elf_flagehdr(Elf *_elf, Elf_Cmd _cmd, unsigned int _flags); 201 unsigned int elf_flagelf(Elf *_elf, Elf_Cmd _cmd, unsigned int _flags); 202 unsigned int elf_flagphdr(Elf *_elf, Elf_Cmd _cmd, unsigned int _flags); 203 unsigned int elf_flagscn(Elf_Scn *_scn, Elf_Cmd _cmd, unsigned int _flags); 204 unsigned int elf_flagshdr(Elf_Scn *_scn, Elf_Cmd _cmd, unsigned int _flags); 205 Elf_Arhdr *elf_getarhdr(Elf *_elf); 206 Elf_Arsym *elf_getarsym(Elf *_elf, size_t *_ptr); 207 off_t elf_getbase(Elf *_elf); 208 Elf_Data *elf_getdata(Elf_Scn *, Elf_Data *); 209 char *elf_getident(Elf *_elf, size_t *_ptr); 210 int elf_getphdrnum(Elf *_elf, size_t *_dst); 211 int elf_getphnum(Elf *_elf, size_t *_dst); /* Deprecated */ 212 Elf_Scn *elf_getscn(Elf *_elf, size_t _index); 213 int elf_getshdrnum(Elf *_elf, size_t *_dst); 214 int elf_getshnum(Elf *_elf, size_t *_dst); /* Deprecated */ 215 int elf_getshdrstrndx(Elf *_elf, size_t *_dst); 216 int elf_getshstrndx(Elf *_elf, size_t *_dst); /* Deprecated */ 217 unsigned int elf_getversion(Elf *_elf); 218 unsigned long elf_hash(const char *_name); 219 Elf_Kind elf_kind(Elf *_elf); 220 Elf *elf_memory(char *_image, size_t _size); 221 size_t elf_ndxscn(Elf_Scn *_scn); 222 Elf_Data *elf_newdata(Elf_Scn *_scn); 223 Elf_Scn *elf_newscn(Elf *_elf); 224 Elf_Scn *elf_nextscn(Elf *_elf, Elf_Scn *_scn); 225 Elf_Cmd elf_next(Elf *_elf); 226 Elf *elf_open(int _fd); 227 Elf *elf_openmemory(char *_image, size_t _size); 228 off_t elf_rand(Elf *_elf, off_t _off); 229 Elf_Data *elf_rawdata(Elf_Scn *_scn, Elf_Data *_data); 230 char *elf_rawfile(Elf *_elf, size_t *_size); 231 int elf_setshstrndx(Elf *_elf, size_t _shnum); 232 char *elf_strptr(Elf *_elf, size_t _section, size_t _offset); 233 off_t elf_update(Elf *_elf, Elf_Cmd _cmd); 234 unsigned int elf_version(unsigned int _version); 235 236 long elf32_checksum(Elf *_elf); 237 size_t elf32_fsize(Elf_Type _type, size_t _count, 238 unsigned int _version); 239 Elf32_Ehdr *elf32_getehdr(Elf *_elf); 240 Elf32_Phdr *elf32_getphdr(Elf *_elf); 241 Elf32_Shdr *elf32_getshdr(Elf_Scn *_scn); 242 Elf32_Ehdr *elf32_newehdr(Elf *_elf); 243 Elf32_Phdr *elf32_newphdr(Elf *_elf, size_t _count); 244 Elf_Data *elf32_xlatetof(Elf_Data *_dst, const Elf_Data *_src, 245 unsigned int _enc); 246 Elf_Data *elf32_xlatetom(Elf_Data *_dst, const Elf_Data *_src, 247 unsigned int _enc); 248 249 long elf64_checksum(Elf *_elf); 250 size_t elf64_fsize(Elf_Type _type, size_t _count, 251 unsigned int _version); 252 Elf64_Ehdr *elf64_getehdr(Elf *_elf); 253 Elf64_Phdr *elf64_getphdr(Elf *_elf); 254 Elf64_Shdr *elf64_getshdr(Elf_Scn *_scn); 255 Elf64_Ehdr *elf64_newehdr(Elf *_elf); 256 Elf64_Phdr *elf64_newphdr(Elf *_elf, size_t _count); 257 Elf_Data *elf64_xlatetof(Elf_Data *_dst, const Elf_Data *_src, 258 unsigned int _enc); 259 Elf_Data *elf64_xlatetom(Elf_Data *_dst, const Elf_Data *_src, 260 unsigned int _enc); 261 #ifdef __cplusplus 262 } 263 #endif 264 265 #endif /* _LIBELF_H_ */ 266
Indexes created Tue Feb 24 08:35:24 UTC 2026