_libelf.h revision 272461
1132720Skan/*- 2132720Skan * Copyright (c) 2006 Joseph Koshy 3169691Skan * All rights reserved. 4169691Skan * 5132720Skan * Redistribution and use in source and binary forms, with or without 6132720Skan * modification, are permitted provided that the following conditions 7132720Skan * are met: 8132720Skan * 1. Redistributions of source code must retain the above copyright 9132720Skan * notice, this list of conditions and the following disclaimer. 10132720Skan * 2. Redistributions in binary form must reproduce the above copyright 11132720Skan * notice, this list of conditions and the following disclaimer in the 12132720Skan * documentation and/or other materials provided with the distribution. 13132720Skan * 14132720Skan * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15132720Skan * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16132720Skan * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17132720Skan * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18132720Skan * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19169691Skan * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20132720Skan * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21132720Skan * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22132720Skan * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23132720Skan * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24132720Skan * SUCH DAMAGE. 25132720Skan * 26132720Skan * $FreeBSD: releng/10.1/lib/libelf/_libelf.h 210348 2010-07-21 12:54:34Z kaiw $ 27132720Skan */ 28132720Skan 29132720Skan#ifndef __LIBELF_H_ 30132720Skan#define __LIBELF_H_ 31169691Skan 32132720Skan#include <sys/queue.h> 33132720Skan 34132720Skan#ifndef NULL 35132720Skan#define NULL ((void *) 0) 36169691Skan#endif 37169691Skan 38132720Skan/* 39132720Skan * Library-private data structures. 40132720Skan */ 41132720Skan 42132720Skan#define LIBELF_MSG_SIZE 256 43132720Skan 44132720Skanstruct _libelf_globals { 45169691Skan int libelf_arch; 46169691Skan unsigned int libelf_byteorder; 47132720Skan int libelf_class; 48132720Skan int libelf_error; 49132720Skan int libelf_fillchar; 50132720Skan unsigned int libelf_version; 51132720Skan char libelf_msg[LIBELF_MSG_SIZE]; 52132720Skan}; 53132720Skan 54132720Skanextern struct _libelf_globals _libelf; 55132720Skan 56132720Skan#define LIBELF_PRIVATE(N) (_libelf.libelf_##N) 57132720Skan 58132720Skan#define LIBELF_ELF_ERROR_MASK 0xFF 59132720Skan#define LIBELF_OS_ERROR_SHIFT 8 60132720Skan 61132720Skan#define LIBELF_SET_ERROR(E, O) do { \ 62132720Skan LIBELF_PRIVATE(error) = ((ELF_E_##E & LIBELF_ELF_ERROR_MASK)| \ 63132720Skan ((O) << LIBELF_OS_ERROR_SHIFT)); \ 64132720Skan } while (0) 65132720Skan 66132720Skan#define LIBELF_ADJUST_AR_SIZE(S) (((S) + 1U) & ~1U) 67132720Skan 68132720Skan/* 69132720Skan * Flags for library internal use. These use the upper 16 bits of a 70169691Skan * flags field. 71169691Skan */ 72132720Skan#define LIBELF_F_MALLOCED 0x010000 /* whether data was malloc'ed */ 73132720Skan#define LIBELF_F_MMAP 0x020000 /* whether e_rawfile was mmap'ed */ 74132720Skan#define LIBELF_F_SHDRS_LOADED 0x040000 /* whether all shdrs were read in */ 75132720Skan 76132720Skanstruct _Elf { 77169691Skan int e_activations; /* activation count */ 78169691Skan Elf_Arhdr *e_arhdr; /* header for archive members */ 79132720Skan unsigned int e_byteorder; /* ELFDATA* */ 80132720Skan int e_class; /* ELFCLASS* */ 81132720Skan Elf_Cmd e_cmd; /* ELF_C_* used at creation time */ 82132720Skan int e_fd; /* associated file descriptor */ 83132720Skan unsigned int e_flags; /* ELF_F_*, LIBELF_F_* flags */ 84169691Skan Elf_Kind e_kind; /* ELF_K_* */ 85169691Skan Elf *e_parent; /* non-NULL for archive members */ 86132720Skan char *e_rawfile; /* uninterpreted bytes */ 87132720Skan size_t e_rawsize; /* size of uninterpreted bytes */ 88132720Skan unsigned int e_version; /* file version */ 89132720Skan 90132720Skan union { 91169691Skan struct { /* ar(1) archives */ 92169691Skan off_t e_next; /* set by elf_rand()/elf_next() */ 93132720Skan int e_nchildren; 94132720Skan char *e_rawstrtab; /* file name strings */ 95132720Skan size_t e_rawstrtabsz; 96132720Skan char *e_rawsymtab; /* symbol table */ 97132720Skan size_t e_rawsymtabsz; 98169691Skan Elf_Arsym *e_symtab; 99169691Skan size_t e_symtabsz; 100132720Skan } e_ar; 101132720Skan struct { /* regular ELF files */ 102132720Skan union { 103132720Skan Elf32_Ehdr *e_ehdr32; 104132720Skan Elf64_Ehdr *e_ehdr64; 105169691Skan } e_ehdr; 106169691Skan union { 107132720Skan Elf32_Phdr *e_phdr32; 108132720Skan Elf64_Phdr *e_phdr64; 109132720Skan } e_phdr; 110132720Skan STAILQ_HEAD(, _Elf_Scn) e_scn; /* section list */ 111132720Skan size_t e_nphdr; /* number of Phdr entries */ 112169691Skan size_t e_nscn; /* number of sections */ 113169691Skan size_t e_strndx; /* string table section index */ 114132720Skan } e_elf; 115132720Skan } e_u; 116132720Skan}; 117132720Skan 118132720Skanstruct _Elf_Scn { 119169691Skan union { 120169691Skan Elf32_Shdr s_shdr32; 121132720Skan Elf64_Shdr s_shdr64; 122132720Skan } s_shdr; 123132720Skan STAILQ_HEAD(, _Elf_Data) s_data; /* list of Elf_Data descriptors */ 124132720Skan STAILQ_HEAD(, _Elf_Data) s_rawdata; /* raw data for this section */ 125132720Skan STAILQ_ENTRY(_Elf_Scn) s_next; 126169691Skan struct _Elf *s_elf; /* parent ELF descriptor */ 127169691Skan unsigned int s_flags; /* flags for the section as a whole */ 128132720Skan size_t s_ndx; /* index# for this section */ 129132720Skan uint64_t s_offset; /* managed by elf_update() */ 130132720Skan uint64_t s_rawoff; /* original offset in the file */ 131132720Skan uint64_t s_size; /* managed by elf_update() */ 132132720Skan}; 133169691Skan 134169691Skan 135132720Skanenum { 136132720Skan ELF_TOFILE, 137132720Skan ELF_TOMEMORY 138132720Skan}; 139132720Skan 140169691Skan#define LIBELF_COPY_U32(DST,SRC,NAME) do { \ 141169691Skan if ((SRC)->NAME > UINT_MAX) { \ 142132720Skan LIBELF_SET_ERROR(RANGE, 0); \ 143132720Skan return (0); \ 144132720Skan } \ 145132720Skan (DST)->NAME = (SRC)->NAME; \ 146132720Skan } while (0) 147169691Skan 148169691Skan#define LIBELF_COPY_S32(DST,SRC,NAME) do { \ 149132720Skan if ((SRC)->NAME > INT_MAX || \ 150132720Skan (SRC)->NAME < INT_MIN) { \ 151132720Skan LIBELF_SET_ERROR(RANGE, 0); \ 152132720Skan return (0); \ 153132720Skan } \ 154169691Skan (DST)->NAME = (SRC)->NAME; \ 155169691Skan } while (0) 156132720Skan 157132720Skan 158132720Skan/* 159132720Skan * Prototypes 160132720Skan */ 161169691Skan 162169691SkanElf_Data *_libelf_allocate_data(Elf_Scn *_s); 163132720SkanElf *_libelf_allocate_elf(void); 164132720SkanElf_Scn *_libelf_allocate_scn(Elf *_e, size_t _ndx); 165132720SkanElf_Arhdr *_libelf_ar_gethdr(Elf *_e); 166132720SkanElf *_libelf_ar_open(Elf *_e); 167132720SkanElf *_libelf_ar_open_member(int _fd, Elf_Cmd _c, Elf *_ar); 168132720Skanint _libelf_ar_get_member(char *_s, size_t _sz, int _base, size_t *_ret); 169132720Skanchar *_libelf_ar_get_string(const char *_buf, size_t _sz, int _rawname); 170132720Skanchar *_libelf_ar_get_name(char *_buf, size_t _sz, Elf *_e); 171132720Skanint _libelf_ar_get_number(char *_buf, size_t _sz, int _base, size_t *_ret); 172169691SkanElf_Arsym *_libelf_ar_process_symtab(Elf *_ar, size_t *_dst); 173169691Skanunsigned long _libelf_checksum(Elf *_e, int _elfclass); 174132720Skanvoid *_libelf_ehdr(Elf *_e, int _elfclass, int _allocate); 175132720Skanint _libelf_falign(Elf_Type _t, int _elfclass); 176132720Skansize_t _libelf_fsize(Elf_Type _t, int _elfclass, unsigned int _version, 177132720Skan size_t count); 178132720Skanint (*_libelf_get_translator(Elf_Type _t, int _direction, int _elfclass)) 179169691Skan (char *_dst, size_t dsz, char *_src, size_t _cnt, int _byteswap); 180169691Skanvoid *_libelf_getphdr(Elf *_e, int _elfclass); 181132720Skanvoid *_libelf_getshdr(Elf_Scn *_scn, int _elfclass); 182132720Skanvoid _libelf_init_elf(Elf *_e, Elf_Kind _kind); 183132720Skanint _libelf_load_scn(Elf *e, void *ehdr); 184132720Skanint _libelf_malign(Elf_Type _t, int _elfclass); 185132720Skansize_t _libelf_msize(Elf_Type _t, int _elfclass, unsigned int _version); 186169691Skanvoid *_libelf_newphdr(Elf *_e, int _elfclass, size_t _count); 187169691SkanElf_Data *_libelf_release_data(Elf_Data *_d); 188132720SkanElf *_libelf_release_elf(Elf *_e); 189132720SkanElf_Scn *_libelf_release_scn(Elf_Scn *_s); 190132720Skanint _libelf_setphnum(Elf *_e, void *_eh, int _elfclass, size_t _phnum); 191132720Skanint _libelf_setshnum(Elf *_e, void *_eh, int _elfclass, size_t _shnum); 192132720Skanint _libelf_setshstrndx(Elf *_e, void *_eh, int _elfclass, 193132720Skan size_t _shstrndx); 194132720SkanElf_Data *_libelf_xlate(Elf_Data *_d, const Elf_Data *_s, 195132720Skan unsigned int _encoding, int _elfclass, int _direction); 196132720Skanint _libelf_xlate_shtype(uint32_t _sht); 197132720Skan 198132720Skan#endif /* __LIBELF_H_ */ 199132720Skan