1 #ifndef _LTTNG_UST_ELF_H
2 #define _LTTNG_UST_ELF_H
4 * Copyright (C) 2015 Antoine Busque <abusque@efficios.com>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 #include <lttng/ust-endian.h>
28 * Determine native endianness in order to convert when reading an ELF
29 * file if there is a mismatch.
31 #if BYTE_ORDER == LITTLE_ENDIAN
32 #define NATIVE_ELF_ENDIANNESS ELFDATA2LSB
34 #define NATIVE_ELF_ENDIANNESS ELFDATA2MSB
38 * The size in bytes of the debug link CRC as contained in an ELF
41 #define ELF_CRC_SIZE 4
43 * ELF notes are aligned on 4 bytes. ref: ELF specification version
46 #define ELF_NOTE_ENTRY_ALIGN 4
48 * Within an ELF note, the `desc` field is also aligned on 4
49 * bytes. ref: ELF specification version 1.1 p. 2-5.
51 #define ELF_NOTE_DESC_ALIGN 4
55 switch (sizeof(x)) { \
72 #define bswap_phdr(phdr) \
74 bswap((phdr).p_type); \
75 bswap((phdr).p_offset); \
76 bswap((phdr).p_filesz); \
77 bswap((phdr).p_memsz); \
78 bswap((phdr).p_align); \
79 bswap((phdr).p_vaddr); \
82 #define bswap_shdr(shdr) \
84 bswap((shdr).sh_name); \
85 bswap((shdr).sh_type); \
86 bswap((shdr).sh_flags); \
87 bswap((shdr).sh_addr); \
88 bswap((shdr).sh_offset); \
89 bswap((shdr).sh_size); \
90 bswap((shdr).sh_link); \
91 bswap((shdr).sh_info); \
92 bswap((shdr).sh_addralign); \
93 bswap((shdr).sh_entsize); \
96 #define bswap_ehdr(ehdr) \
98 bswap((ehdr).e_type); \
99 bswap((ehdr).e_machine); \
100 bswap((ehdr).e_version); \
101 bswap((ehdr).e_entry); \
102 bswap((ehdr).e_phoff); \
103 bswap((ehdr).e_shoff); \
104 bswap((ehdr).e_flags); \
105 bswap((ehdr).e_ehsize); \
106 bswap((ehdr).e_phentsize); \
107 bswap((ehdr).e_phnum); \
108 bswap((ehdr).e_shentsize); \
109 bswap((ehdr).e_shnum); \
110 bswap((ehdr).e_shstrndx); \
113 #define copy_phdr(src_phdr, dst_phdr) \
115 (dst_phdr).p_type = (src_phdr).p_type; \
116 (dst_phdr).p_offset = (src_phdr).p_offset; \
117 (dst_phdr).p_filesz = (src_phdr).p_filesz; \
118 (dst_phdr).p_memsz = (src_phdr).p_memsz; \
119 (dst_phdr).p_align = (src_phdr).p_align; \
120 (dst_phdr).p_vaddr = (src_phdr).p_vaddr; \
123 #define copy_shdr(src_shdr, dst_shdr) \
125 (dst_shdr).sh_name = (src_shdr).sh_name; \
126 (dst_shdr).sh_type = (src_shdr).sh_type; \
127 (dst_shdr).sh_flags = (src_shdr).sh_flags; \
128 (dst_shdr).sh_addr = (src_shdr).sh_addr; \
129 (dst_shdr).sh_offset = (src_shdr).sh_offset; \
130 (dst_shdr).sh_size = (src_shdr).sh_size; \
131 (dst_shdr).sh_link = (src_shdr).sh_link; \
132 (dst_shdr).sh_info = (src_shdr).sh_info; \
133 (dst_shdr).sh_addralign = (src_shdr).sh_addralign; \
134 (dst_shdr).sh_entsize = (src_shdr).sh_entsize; \
137 #define copy_ehdr(src_ehdr, dst_ehdr) \
139 (dst_ehdr).e_type = (src_ehdr).e_type; \
140 (dst_ehdr).e_machine = (src_ehdr).e_machine; \
141 (dst_ehdr).e_version = (src_ehdr).e_version; \
142 (dst_ehdr).e_entry = (src_ehdr).e_entry; \
143 (dst_ehdr).e_phoff = (src_ehdr).e_phoff; \
144 (dst_ehdr).e_shoff = (src_ehdr).e_shoff; \
145 (dst_ehdr).e_flags = (src_ehdr).e_flags; \
146 (dst_ehdr).e_ehsize = (src_ehdr).e_ehsize; \
147 (dst_ehdr).e_phentsize = (src_ehdr).e_phentsize; \
148 (dst_ehdr).e_phnum = (src_ehdr).e_phnum; \
149 (dst_ehdr).e_shentsize = (src_ehdr).e_shentsize; \
150 (dst_ehdr).e_shnum = (src_ehdr).e_shnum; \
151 (dst_ehdr).e_shstrndx = (src_ehdr).e_shstrndx; \
154 struct lttng_ust_elf_ehdr
{
163 uint16_t e_phentsize
;
165 uint16_t e_shentsize
;
170 struct lttng_ust_elf_phdr
{
179 struct lttng_ust_elf_shdr
{
188 uint64_t sh_addralign
;
192 struct lttng_ust_elf_nhdr
{
198 struct lttng_ust_elf
{
199 /* Offset in bytes to start of section names string table. */
200 off_t section_names_offset
;
201 /* Size in bytes of section names string table. */
202 size_t section_names_size
;
205 struct lttng_ust_elf_ehdr
*ehdr
;
211 int is_elf_32_bit(struct lttng_ust_elf
*elf
)
213 return elf
->bitness
== ELFCLASS32
;
217 int is_elf_native_endian(struct lttng_ust_elf
*elf
)
219 return elf
->endianness
== NATIVE_ELF_ENDIANNESS
;
222 struct lttng_ust_elf
*lttng_ust_elf_create(const char *path
);
223 void lttng_ust_elf_destroy(struct lttng_ust_elf
*elf
);
224 uint8_t lttng_ust_elf_is_pic(struct lttng_ust_elf
*elf
);
225 int lttng_ust_elf_get_memsz(struct lttng_ust_elf
*elf
, uint64_t *memsz
);
226 int lttng_ust_elf_get_build_id(struct lttng_ust_elf
*elf
, uint8_t **build_id
,
227 size_t *length
, int *found
);
228 int lttng_ust_elf_get_debug_link(struct lttng_ust_elf
*elf
, char **filename
,
229 uint32_t *crc
, int *found
);
231 #endif /* _LTTNG_UST_ELF_H */