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