xref: /freebsd/contrib/elftoolchain/libelf/gelf.h (revision 0b57cec536236d46e3dba9bd041533462f33dbb7)
1 /*-
2  * Copyright (c) 2006,2008 Joseph Koshy
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
13  *
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
24  * SUCH DAMAGE.
25  *
26  * $Id: gelf.h 3174 2015-03-27 17:13:41Z emaste $
27  */
28 
29 #ifndef	_GELF_H_
30 #define	_GELF_H_
31 
32 #include <libelf.h>
33 
34 typedef Elf64_Addr	GElf_Addr;	/* Addresses */
35 typedef Elf64_Half	GElf_Half;	/* Half words (16 bit) */
36 typedef Elf64_Off	GElf_Off;	/* Offsets */
37 typedef Elf64_Sword	GElf_Sword;	/* Signed words (32 bit) */
38 typedef Elf64_Sxword	GElf_Sxword;	/* Signed long words (64 bit) */
39 typedef Elf64_Word	GElf_Word;	/* Unsigned words (32 bit) */
40 typedef Elf64_Xword	GElf_Xword;	/* Unsigned long words (64 bit) */
41 
42 typedef Elf64_Dyn	GElf_Dyn;	/* ".dynamic" section entries */
43 typedef Elf64_Ehdr	GElf_Ehdr;	/* ELF header */
44 typedef Elf64_Phdr	GElf_Phdr;	/* Program header */
45 typedef Elf64_Shdr	GElf_Shdr;	/* Section header */
46 typedef Elf64_Sym	GElf_Sym;	/* Symbol table entries */
47 typedef Elf64_Rel	GElf_Rel;	/* Relocation entries */
48 typedef Elf64_Rela	GElf_Rela;	/* Relocation entries with addend */
49 
50 typedef	Elf64_Cap	GElf_Cap;	/* SW/HW capabilities */
51 typedef Elf64_Move	GElf_Move;	/* Move entries */
52 typedef Elf64_Syminfo	GElf_Syminfo;	/* Symbol information */
53 
54 #define	GELF_M_INFO			ELF64_M_INFO
55 #define	GELF_M_SIZE			ELF64_M_SIZE
56 #define	GELF_M_SYM			ELF64_M_SYM
57 
58 #define	GELF_R_INFO			ELF64_R_INFO
59 #define	GELF_R_SYM			ELF64_R_SYM
60 #define	GELF_R_TYPE			ELF64_R_TYPE
61 #define	GELF_R_TYPE_DATA		ELF64_R_TYPE_DATA
62 #define	GELF_R_TYPE_ID			ELF64_R_TYPE_ID
63 #define	GELF_R_TYPE_INFO		ELF64_R_TYPE_INFO
64 
65 #define	GELF_ST_BIND			ELF64_ST_BIND
66 #define	GELF_ST_INFO			ELF64_ST_INFO
67 #define	GELF_ST_TYPE			ELF64_ST_TYPE
68 #define	GELF_ST_VISIBILITY		ELF64_ST_VISIBILITY
69 
70 #ifdef __cplusplus
71 extern "C" {
72 #endif
73 long		gelf_checksum(Elf *_elf);
74 size_t		gelf_fsize(Elf *_elf, Elf_Type _type, size_t _count,
75 			unsigned int _version);
76 int		gelf_getclass(Elf *_elf);
77 GElf_Dyn	*gelf_getdyn(Elf_Data *_data, int _index, GElf_Dyn *_dst);
78 GElf_Ehdr	*gelf_getehdr(Elf *_elf, GElf_Ehdr *_dst);
79 GElf_Phdr	*gelf_getphdr(Elf *_elf, int _index, GElf_Phdr *_dst);
80 GElf_Rel	*gelf_getrel(Elf_Data *_src, int _index, GElf_Rel *_dst);
81 GElf_Rela	*gelf_getrela(Elf_Data *_src, int _index, GElf_Rela *_dst);
82 GElf_Shdr	*gelf_getshdr(Elf_Scn *_scn, GElf_Shdr *_dst);
83 GElf_Sym	*gelf_getsym(Elf_Data *_src, int _index, GElf_Sym *_dst);
84 GElf_Sym	*gelf_getsymshndx(Elf_Data *_src, Elf_Data *_shindexsrc,
85 			int _index, GElf_Sym *_dst, Elf32_Word *_shindexdst);
86 void *		gelf_newehdr(Elf *_elf, int _class);
87 void *		gelf_newphdr(Elf *_elf, size_t _phnum);
88 int		gelf_update_dyn(Elf_Data *_dst, int _index, GElf_Dyn *_src);
89 int		gelf_update_ehdr(Elf *_elf, GElf_Ehdr *_src);
90 int		gelf_update_phdr(Elf *_elf, int _index, GElf_Phdr *_src);
91 int		gelf_update_rel(Elf_Data *_dst, int _index, GElf_Rel *_src);
92 int		gelf_update_rela(Elf_Data *_dst, int _index, GElf_Rela *_src);
93 int		gelf_update_shdr(Elf_Scn *_dst, GElf_Shdr *_src);
94 int		gelf_update_sym(Elf_Data *_dst, int _index, GElf_Sym *_src);
95 int		gelf_update_symshndx(Elf_Data *_symdst, Elf_Data *_shindexdst,
96 			int _index, GElf_Sym *_symsrc, Elf32_Word _shindexsrc);
97 Elf_Data 	*gelf_xlatetof(Elf *_elf, Elf_Data *_dst, const Elf_Data *_src, unsigned int _encode);
98 Elf_Data 	*gelf_xlatetom(Elf *_elf, Elf_Data *_dst, const Elf_Data *_src, unsigned int _encode);
99 
100 GElf_Cap	*gelf_getcap(Elf_Data *_data, int _index, GElf_Cap *_cap);
101 GElf_Move	*gelf_getmove(Elf_Data *_src, int _index, GElf_Move *_dst);
102 GElf_Syminfo	*gelf_getsyminfo(Elf_Data *_src, int _index, GElf_Syminfo *_dst);
103 int		gelf_update_cap(Elf_Data *_dst, int _index, GElf_Cap *_src);
104 int		gelf_update_move(Elf_Data *_dst, int _index, GElf_Move *_src);
105 int		gelf_update_syminfo(Elf_Data *_dst, int _index, GElf_Syminfo *_src);
106 #ifdef __cplusplus
107 }
108 #endif
109 
110 #endif	/* _GELF_H_ */
111