blob: bdfee0153e93ad875f2a7922d6d0c710d1346e9e [file] [log] [blame]
Christopher Ferris3958f802017-02-01 15:44:40 -08001/*
2 * Copyright (C) 2017 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#include <elf.h>
18#include <stdint.h>
19
20#include <memory>
21#include <string>
Christopher Ferrisbeae42b2018-02-15 17:36:33 -080022#include <utility>
Christopher Ferris3958f802017-02-01 15:44:40 -080023
Christopher Ferrisbae69f12017-06-28 14:51:54 -070024#include <7zCrc.h>
25#include <Xz.h>
26#include <XzCrc64.h>
27
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -080028#include <unwindstack/DwarfError.h>
Christopher Ferrisd226a512017-07-14 10:37:19 -070029#include <unwindstack/DwarfSection.h>
30#include <unwindstack/ElfInterface.h>
31#include <unwindstack/Log.h>
Christopher Ferrisd226a512017-07-14 10:37:19 -070032#include <unwindstack/Regs.h>
33
Christopher Ferris61d40972017-06-12 19:14:20 -070034#include "DwarfDebugFrame.h"
35#include "DwarfEhFrame.h"
Christopher Ferrisc9dee842017-11-03 14:50:27 -070036#include "DwarfEhFrameWithHdr.h"
Casey Dahlin6b95a0e2019-03-12 17:50:52 -070037#include "MemoryBuffer.h"
Christopher Ferris8098b1c2017-06-20 13:54:08 -070038#include "Symbols.h"
39
Christopher Ferrisd226a512017-07-14 10:37:19 -070040namespace unwindstack {
41
Christopher Ferris8098b1c2017-06-20 13:54:08 -070042ElfInterface::~ElfInterface() {
43 for (auto symbol : symbols_) {
44 delete symbol;
45 }
46}
Christopher Ferris3958f802017-02-01 15:44:40 -080047
Christopher Ferris150db122017-12-20 18:49:01 -080048bool ElfInterface::IsValidPc(uint64_t pc) {
49 if (!pt_loads_.empty()) {
50 for (auto& entry : pt_loads_) {
51 uint64_t start = entry.second.table_offset;
52 uint64_t end = start + entry.second.table_size;
53 if (pc >= start && pc < end) {
54 return true;
55 }
56 }
57 return false;
58 }
59
60 // No PT_LOAD data, look for a fde for this pc in the section data.
61 if (debug_frame_ != nullptr && debug_frame_->GetFdeFromPc(pc) != nullptr) {
62 return true;
63 }
64
65 if (eh_frame_ != nullptr && eh_frame_->GetFdeFromPc(pc) != nullptr) {
66 return true;
67 }
68
69 return false;
70}
71
Christopher Ferrisbae69f12017-06-28 14:51:54 -070072Memory* ElfInterface::CreateGnuDebugdataMemory() {
73 if (gnu_debugdata_offset_ == 0 || gnu_debugdata_size_ == 0) {
74 return nullptr;
75 }
76
77 // TODO: Only call these initialization functions once.
78 CrcGenerateTable();
79 Crc64GenerateTable();
80
81 std::vector<uint8_t> src(gnu_debugdata_size_);
Josh Gaoef35aa52017-10-18 11:44:51 -070082 if (!memory_->ReadFully(gnu_debugdata_offset_, src.data(), gnu_debugdata_size_)) {
Christopher Ferrisbae69f12017-06-28 14:51:54 -070083 gnu_debugdata_offset_ = 0;
84 gnu_debugdata_size_ = static_cast<uint64_t>(-1);
85 return nullptr;
86 }
87
88 ISzAlloc alloc;
89 CXzUnpacker state;
Sen Jiang2ef03e02018-05-04 12:56:04 -070090 alloc.Alloc = [](ISzAllocPtr, size_t size) { return malloc(size); };
91 alloc.Free = [](ISzAllocPtr, void* ptr) { return free(ptr); };
Christopher Ferrisbae69f12017-06-28 14:51:54 -070092
93 XzUnpacker_Construct(&state, &alloc);
94
95 std::unique_ptr<MemoryBuffer> dst(new MemoryBuffer);
96 int return_val;
97 size_t src_offset = 0;
98 size_t dst_offset = 0;
99 ECoderStatus status;
100 dst->Resize(5 * gnu_debugdata_size_);
101 do {
102 size_t src_remaining = src.size() - src_offset;
103 size_t dst_remaining = dst->Size() - dst_offset;
104 if (dst_remaining < 2 * gnu_debugdata_size_) {
105 dst->Resize(dst->Size() + 2 * gnu_debugdata_size_);
106 dst_remaining += 2 * gnu_debugdata_size_;
107 }
108 return_val = XzUnpacker_Code(&state, dst->GetPtr(dst_offset), &dst_remaining, &src[src_offset],
Sen Jiang2ef03e02018-05-04 12:56:04 -0700109 &src_remaining, true, CODER_FINISH_ANY, &status);
Christopher Ferrisbae69f12017-06-28 14:51:54 -0700110 src_offset += src_remaining;
111 dst_offset += dst_remaining;
112 } while (return_val == SZ_OK && status == CODER_STATUS_NOT_FINISHED);
113 XzUnpacker_Free(&state);
114 if (return_val != SZ_OK || !XzUnpacker_IsStreamWasFinished(&state)) {
115 gnu_debugdata_offset_ = 0;
116 gnu_debugdata_size_ = static_cast<uint64_t>(-1);
117 return nullptr;
118 }
119
120 // Shrink back down to the exact size.
121 dst->Resize(dst_offset);
122
123 return dst.release();
124}
125
Christopher Ferris61d40972017-06-12 19:14:20 -0700126template <typename AddressType>
Christopher Ferris4cc36d22018-06-06 14:47:31 -0700127void ElfInterface::InitHeadersWithTemplate(uint64_t load_bias) {
Christopher Ferrisc9dee842017-11-03 14:50:27 -0700128 if (eh_frame_hdr_offset_ != 0) {
129 eh_frame_.reset(new DwarfEhFrameWithHdr<AddressType>(memory_));
Christopher Ferris4cc36d22018-06-06 14:47:31 -0700130 if (!eh_frame_->Init(eh_frame_hdr_offset_, eh_frame_hdr_size_, load_bias)) {
Christopher Ferrisc9dee842017-11-03 14:50:27 -0700131 eh_frame_.reset(nullptr);
Christopher Ferrisc9dee842017-11-03 14:50:27 -0700132 }
Christopher Ferris1a141a02018-01-24 08:52:47 -0800133 }
134
135 if (eh_frame_.get() == nullptr && eh_frame_offset_ != 0) {
136 // If there is an eh_frame section without an eh_frame_hdr section,
137 // or using the frame hdr object failed to init.
Christopher Ferris61d40972017-06-12 19:14:20 -0700138 eh_frame_.reset(new DwarfEhFrame<AddressType>(memory_));
Christopher Ferris4cc36d22018-06-06 14:47:31 -0700139 if (!eh_frame_->Init(eh_frame_offset_, eh_frame_size_, load_bias)) {
Christopher Ferris61d40972017-06-12 19:14:20 -0700140 eh_frame_.reset(nullptr);
Christopher Ferris61d40972017-06-12 19:14:20 -0700141 }
142 }
143
Christopher Ferris1a141a02018-01-24 08:52:47 -0800144 if (eh_frame_.get() == nullptr) {
145 eh_frame_hdr_offset_ = 0;
146 eh_frame_hdr_size_ = static_cast<uint64_t>(-1);
147 eh_frame_offset_ = 0;
148 eh_frame_size_ = static_cast<uint64_t>(-1);
149 }
150
Christopher Ferris61d40972017-06-12 19:14:20 -0700151 if (debug_frame_offset_ != 0) {
152 debug_frame_.reset(new DwarfDebugFrame<AddressType>(memory_));
Christopher Ferris4cc36d22018-06-06 14:47:31 -0700153 if (!debug_frame_->Init(debug_frame_offset_, debug_frame_size_, load_bias)) {
Christopher Ferris61d40972017-06-12 19:14:20 -0700154 debug_frame_.reset(nullptr);
155 debug_frame_offset_ = 0;
156 debug_frame_size_ = static_cast<uint64_t>(-1);
157 }
158 }
159}
160
Christopher Ferris3958f802017-02-01 15:44:40 -0800161template <typename EhdrType, typename PhdrType, typename ShdrType>
Christopher Ferrise69f4702017-10-19 16:08:58 -0700162bool ElfInterface::ReadAllHeaders(uint64_t* load_bias) {
Christopher Ferris3958f802017-02-01 15:44:40 -0800163 EhdrType ehdr;
Josh Gaoef35aa52017-10-18 11:44:51 -0700164 if (!memory_->ReadFully(0, &ehdr, sizeof(ehdr))) {
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800165 last_error_.code = ERROR_MEMORY_INVALID;
166 last_error_.address = 0;
Christopher Ferris3958f802017-02-01 15:44:40 -0800167 return false;
168 }
169
Christopher Ferris5acf0692018-08-01 13:10:46 -0700170 // If we have enough information that this is an elf file, then allow
171 // malformed program and section headers.
172 ReadProgramHeaders<EhdrType, PhdrType>(ehdr, load_bias);
173 ReadSectionHeaders<EhdrType, ShdrType>(ehdr);
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700174 return true;
Christopher Ferris3958f802017-02-01 15:44:40 -0800175}
176
177template <typename EhdrType, typename PhdrType>
Christopher Ferrisb7de5f52017-12-01 21:37:37 -0800178uint64_t ElfInterface::GetLoadBias(Memory* memory) {
179 EhdrType ehdr;
Christopher Ferriscadacdf2019-01-15 19:10:49 -0800180 if (!memory->ReadFully(0, &ehdr, sizeof(ehdr))) {
Christopher Ferrisb7de5f52017-12-01 21:37:37 -0800181 return false;
182 }
183
184 uint64_t offset = ehdr.e_phoff;
185 for (size_t i = 0; i < ehdr.e_phnum; i++, offset += ehdr.e_phentsize) {
186 PhdrType phdr;
Christopher Ferriscadacdf2019-01-15 19:10:49 -0800187 if (!memory->ReadFully(offset, &phdr, sizeof(phdr))) {
Christopher Ferrisb7de5f52017-12-01 21:37:37 -0800188 return 0;
189 }
190 if (phdr.p_type == PT_LOAD && phdr.p_offset == 0) {
191 return phdr.p_vaddr;
192 }
193 }
194 return 0;
195}
196
197template <typename EhdrType, typename PhdrType>
Christopher Ferris5acf0692018-08-01 13:10:46 -0700198void ElfInterface::ReadProgramHeaders(const EhdrType& ehdr, uint64_t* load_bias) {
Christopher Ferris3958f802017-02-01 15:44:40 -0800199 uint64_t offset = ehdr.e_phoff;
Florian Mayer249c90f2019-07-05 16:48:04 +0100200 bool first_exec_load_header = true;
Christopher Ferris3958f802017-02-01 15:44:40 -0800201 for (size_t i = 0; i < ehdr.e_phnum; i++, offset += ehdr.e_phentsize) {
202 PhdrType phdr;
Christopher Ferris5afddb02018-06-29 16:30:55 -0700203 if (!memory_->ReadFully(offset, &phdr, sizeof(phdr))) {
Christopher Ferris5acf0692018-08-01 13:10:46 -0700204 return;
Christopher Ferris3958f802017-02-01 15:44:40 -0800205 }
206
Christopher Ferris3958f802017-02-01 15:44:40 -0800207 switch (phdr.p_type) {
208 case PT_LOAD:
209 {
Christopher Ferris3958f802017-02-01 15:44:40 -0800210 if ((phdr.p_flags & PF_X) == 0) {
211 continue;
212 }
213
Christopher Ferris3958f802017-02-01 15:44:40 -0800214 pt_loads_[phdr.p_offset] = LoadInfo{phdr.p_offset, phdr.p_vaddr,
215 static_cast<size_t>(phdr.p_memsz)};
Florian Mayer249c90f2019-07-05 16:48:04 +0100216 // Only set the load bias from the first executable load header.
217 if (first_exec_load_header && phdr.p_vaddr > phdr.p_offset) {
218 *load_bias = phdr.p_vaddr - phdr.p_offset;
Christopher Ferris3958f802017-02-01 15:44:40 -0800219 }
Florian Mayer249c90f2019-07-05 16:48:04 +0100220 first_exec_load_header = false;
Christopher Ferris3958f802017-02-01 15:44:40 -0800221 break;
222 }
223
224 case PT_GNU_EH_FRAME:
Christopher Ferrisc9dee842017-11-03 14:50:27 -0700225 // This is really the pointer to the .eh_frame_hdr section.
226 eh_frame_hdr_offset_ = phdr.p_offset;
Christopher Ferrisc9dee842017-11-03 14:50:27 -0700227 eh_frame_hdr_size_ = phdr.p_memsz;
Christopher Ferris3958f802017-02-01 15:44:40 -0800228 break;
229
230 case PT_DYNAMIC:
Christopher Ferris3958f802017-02-01 15:44:40 -0800231 dynamic_offset_ = phdr.p_offset;
Christopher Ferris150db122017-12-20 18:49:01 -0800232 dynamic_vaddr_ = phdr.p_vaddr;
Christopher Ferris3958f802017-02-01 15:44:40 -0800233 dynamic_size_ = phdr.p_memsz;
234 break;
Christopher Ferris5afddb02018-06-29 16:30:55 -0700235
236 default:
237 HandleUnknownType(phdr.p_type, phdr.p_offset, phdr.p_filesz);
238 break;
Christopher Ferris3958f802017-02-01 15:44:40 -0800239 }
240 }
Christopher Ferris3958f802017-02-01 15:44:40 -0800241}
242
Florian Mayerda459e52018-11-23 16:56:17 +0000243template <typename NhdrType>
Christopher Ferrisbf373ed2019-01-16 17:23:39 -0800244std::string ElfInterface::ReadBuildID() {
Florian Mayerda459e52018-11-23 16:56:17 +0000245 // Ensure there is no overflow in any of the calulations below.
246 uint64_t tmp;
247 if (__builtin_add_overflow(gnu_build_id_offset_, gnu_build_id_size_, &tmp)) {
Christopher Ferrisbf373ed2019-01-16 17:23:39 -0800248 return "";
Florian Mayerda459e52018-11-23 16:56:17 +0000249 }
250
251 uint64_t offset = 0;
252 while (offset < gnu_build_id_size_) {
253 if (gnu_build_id_size_ - offset < sizeof(NhdrType)) {
Christopher Ferrisbf373ed2019-01-16 17:23:39 -0800254 return "";
Florian Mayerda459e52018-11-23 16:56:17 +0000255 }
256 NhdrType hdr;
257 if (!memory_->ReadFully(gnu_build_id_offset_ + offset, &hdr, sizeof(hdr))) {
Christopher Ferrisbf373ed2019-01-16 17:23:39 -0800258 return "";
Florian Mayerda459e52018-11-23 16:56:17 +0000259 }
260 offset += sizeof(hdr);
261
262 if (gnu_build_id_size_ - offset < hdr.n_namesz) {
Christopher Ferrisbf373ed2019-01-16 17:23:39 -0800263 return "";
Florian Mayerda459e52018-11-23 16:56:17 +0000264 }
265 if (hdr.n_namesz > 0) {
266 std::string name(hdr.n_namesz, '\0');
267 if (!memory_->ReadFully(gnu_build_id_offset_ + offset, &(name[0]), hdr.n_namesz)) {
Christopher Ferrisbf373ed2019-01-16 17:23:39 -0800268 return "";
Florian Mayerda459e52018-11-23 16:56:17 +0000269 }
270
271 // Trim trailing \0 as GNU is stored as a C string in the ELF file.
272 if (name.back() == '\0')
273 name.resize(name.size() - 1);
274
275 // Align hdr.n_namesz to next power multiple of 4. See man 5 elf.
276 offset += (hdr.n_namesz + 3) & ~3;
277
278 if (name == "GNU" && hdr.n_type == NT_GNU_BUILD_ID) {
Christopher Ferrisbf373ed2019-01-16 17:23:39 -0800279 if (gnu_build_id_size_ - offset < hdr.n_descsz || hdr.n_descsz == 0) {
280 return "";
Florian Mayerda459e52018-11-23 16:56:17 +0000281 }
Christopher Ferris1760b452019-04-03 14:14:30 -0700282 std::string build_id(hdr.n_descsz, '\0');
Christopher Ferrisbf373ed2019-01-16 17:23:39 -0800283 if (memory_->ReadFully(gnu_build_id_offset_ + offset, &build_id[0], hdr.n_descsz)) {
284 return build_id;
285 }
286 return "";
Florian Mayerda459e52018-11-23 16:56:17 +0000287 }
288 }
289 // Align hdr.n_descsz to next power multiple of 4. See man 5 elf.
290 offset += (hdr.n_descsz + 3) & ~3;
291 }
Christopher Ferrisbf373ed2019-01-16 17:23:39 -0800292 return "";
Florian Mayerda459e52018-11-23 16:56:17 +0000293}
294
Christopher Ferris3958f802017-02-01 15:44:40 -0800295template <typename EhdrType, typename ShdrType>
Christopher Ferris5acf0692018-08-01 13:10:46 -0700296void ElfInterface::ReadSectionHeaders(const EhdrType& ehdr) {
Christopher Ferris3958f802017-02-01 15:44:40 -0800297 uint64_t offset = ehdr.e_shoff;
298 uint64_t sec_offset = 0;
299 uint64_t sec_size = 0;
300
301 // Get the location of the section header names.
302 // If something is malformed in the header table data, we aren't going
303 // to terminate, we'll simply ignore this part.
304 ShdrType shdr;
305 if (ehdr.e_shstrndx < ehdr.e_shnum) {
306 uint64_t sh_offset = offset + ehdr.e_shstrndx * ehdr.e_shentsize;
Christopher Ferris5afddb02018-06-29 16:30:55 -0700307 if (memory_->ReadFully(sh_offset, &shdr, sizeof(shdr))) {
Christopher Ferris3958f802017-02-01 15:44:40 -0800308 sec_offset = shdr.sh_offset;
309 sec_size = shdr.sh_size;
310 }
311 }
312
313 // Skip the first header, it's always going to be NULL.
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700314 offset += ehdr.e_shentsize;
Christopher Ferris3958f802017-02-01 15:44:40 -0800315 for (size_t i = 1; i < ehdr.e_shnum; i++, offset += ehdr.e_shentsize) {
Christopher Ferriscadacdf2019-01-15 19:10:49 -0800316 if (!memory_->ReadFully(offset, &shdr, sizeof(shdr))) {
Christopher Ferris5acf0692018-08-01 13:10:46 -0700317 return;
Christopher Ferris3958f802017-02-01 15:44:40 -0800318 }
319
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700320 if (shdr.sh_type == SHT_SYMTAB || shdr.sh_type == SHT_DYNSYM) {
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700321 // Need to go get the information about the section that contains
322 // the string terminated names.
323 ShdrType str_shdr;
324 if (shdr.sh_link >= ehdr.e_shnum) {
Christopher Ferris5acf0692018-08-01 13:10:46 -0700325 continue;
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700326 }
327 uint64_t str_offset = ehdr.e_shoff + shdr.sh_link * ehdr.e_shentsize;
Christopher Ferriscadacdf2019-01-15 19:10:49 -0800328 if (!memory_->ReadFully(str_offset, &str_shdr, sizeof(str_shdr))) {
Christopher Ferris5acf0692018-08-01 13:10:46 -0700329 continue;
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700330 }
331 if (str_shdr.sh_type != SHT_STRTAB) {
Christopher Ferris5acf0692018-08-01 13:10:46 -0700332 continue;
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700333 }
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700334 symbols_.push_back(new Symbols(shdr.sh_offset, shdr.sh_size, shdr.sh_entsize,
335 str_shdr.sh_offset, str_shdr.sh_size));
David Srbeckyb9cc4fb2019-04-05 18:23:32 +0000336 } else if (shdr.sh_type == SHT_PROGBITS && sec_size != 0) {
Christopher Ferris3958f802017-02-01 15:44:40 -0800337 // Look for the .debug_frame and .gnu_debugdata.
Christopher Ferris3958f802017-02-01 15:44:40 -0800338 if (shdr.sh_name < sec_size) {
339 std::string name;
340 if (memory_->ReadString(sec_offset + shdr.sh_name, &name)) {
David Srbeckyb9cc4fb2019-04-05 18:23:32 +0000341 uint64_t* offset_ptr = nullptr;
342 uint64_t* size_ptr = nullptr;
Christopher Ferris3958f802017-02-01 15:44:40 -0800343 if (name == ".debug_frame") {
David Srbeckyb9cc4fb2019-04-05 18:23:32 +0000344 offset_ptr = &debug_frame_offset_;
345 size_ptr = &debug_frame_size_;
Christopher Ferris3958f802017-02-01 15:44:40 -0800346 } else if (name == ".gnu_debugdata") {
David Srbeckyb9cc4fb2019-04-05 18:23:32 +0000347 offset_ptr = &gnu_debugdata_offset_;
348 size_ptr = &gnu_debugdata_size_;
Christopher Ferrisc9dee842017-11-03 14:50:27 -0700349 } else if (name == ".eh_frame") {
David Srbeckyb9cc4fb2019-04-05 18:23:32 +0000350 offset_ptr = &eh_frame_offset_;
351 size_ptr = &eh_frame_size_;
Christopher Ferrisc9dee842017-11-03 14:50:27 -0700352 } else if (eh_frame_hdr_offset_ == 0 && name == ".eh_frame_hdr") {
David Srbeckyb9cc4fb2019-04-05 18:23:32 +0000353 offset_ptr = &eh_frame_hdr_offset_;
354 size_ptr = &eh_frame_hdr_size_;
355 }
356 if (offset_ptr != nullptr) {
357 *offset_ptr = shdr.sh_offset;
358 *size_ptr = shdr.sh_size;
Christopher Ferris3958f802017-02-01 15:44:40 -0800359 }
360 }
361 }
Christopher Ferrisbeae42b2018-02-15 17:36:33 -0800362 } else if (shdr.sh_type == SHT_STRTAB) {
363 // In order to read soname, keep track of address to offset mapping.
364 strtabs_.push_back(std::make_pair<uint64_t, uint64_t>(static_cast<uint64_t>(shdr.sh_addr),
365 static_cast<uint64_t>(shdr.sh_offset)));
Florian Mayerda459e52018-11-23 16:56:17 +0000366 } else if (shdr.sh_type == SHT_NOTE) {
367 if (shdr.sh_name < sec_size) {
368 std::string name;
369 if (memory_->ReadString(sec_offset + shdr.sh_name, &name) &&
370 name == ".note.gnu.build-id") {
371 gnu_build_id_offset_ = shdr.sh_offset;
372 gnu_build_id_size_ = shdr.sh_size;
373 }
374 }
Christopher Ferris3958f802017-02-01 15:44:40 -0800375 }
376 }
Christopher Ferris3958f802017-02-01 15:44:40 -0800377}
378
379template <typename DynType>
Christopher Ferris02a6c442019-03-11 14:43:33 -0700380std::string ElfInterface::GetSonameWithTemplate() {
Christopher Ferris3958f802017-02-01 15:44:40 -0800381 if (soname_type_ == SONAME_INVALID) {
Christopher Ferris02a6c442019-03-11 14:43:33 -0700382 return "";
Christopher Ferris3958f802017-02-01 15:44:40 -0800383 }
384 if (soname_type_ == SONAME_VALID) {
Christopher Ferris02a6c442019-03-11 14:43:33 -0700385 return soname_;
Christopher Ferris3958f802017-02-01 15:44:40 -0800386 }
387
388 soname_type_ = SONAME_INVALID;
389
390 uint64_t soname_offset = 0;
Christopher Ferrisbeae42b2018-02-15 17:36:33 -0800391 uint64_t strtab_addr = 0;
Christopher Ferris3958f802017-02-01 15:44:40 -0800392 uint64_t strtab_size = 0;
393
394 // Find the soname location from the dynamic headers section.
395 DynType dyn;
396 uint64_t offset = dynamic_offset_;
397 uint64_t max_offset = offset + dynamic_size_;
398 for (uint64_t offset = dynamic_offset_; offset < max_offset; offset += sizeof(DynType)) {
Josh Gaoef35aa52017-10-18 11:44:51 -0700399 if (!memory_->ReadFully(offset, &dyn, sizeof(dyn))) {
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800400 last_error_.code = ERROR_MEMORY_INVALID;
401 last_error_.address = offset;
Christopher Ferris02a6c442019-03-11 14:43:33 -0700402 return "";
Christopher Ferris3958f802017-02-01 15:44:40 -0800403 }
404
405 if (dyn.d_tag == DT_STRTAB) {
Christopher Ferrisbeae42b2018-02-15 17:36:33 -0800406 strtab_addr = dyn.d_un.d_ptr;
Christopher Ferris3958f802017-02-01 15:44:40 -0800407 } else if (dyn.d_tag == DT_STRSZ) {
408 strtab_size = dyn.d_un.d_val;
409 } else if (dyn.d_tag == DT_SONAME) {
410 soname_offset = dyn.d_un.d_val;
411 } else if (dyn.d_tag == DT_NULL) {
412 break;
413 }
414 }
415
Christopher Ferrisbeae42b2018-02-15 17:36:33 -0800416 // Need to map the strtab address to the real offset.
417 for (const auto& entry : strtabs_) {
418 if (entry.first == strtab_addr) {
419 soname_offset = entry.second + soname_offset;
420 if (soname_offset >= entry.second + strtab_size) {
Christopher Ferris02a6c442019-03-11 14:43:33 -0700421 return "";
Christopher Ferrisbeae42b2018-02-15 17:36:33 -0800422 }
423 if (!memory_->ReadString(soname_offset, &soname_)) {
Christopher Ferris02a6c442019-03-11 14:43:33 -0700424 return "";
Christopher Ferrisbeae42b2018-02-15 17:36:33 -0800425 }
426 soname_type_ = SONAME_VALID;
Christopher Ferris02a6c442019-03-11 14:43:33 -0700427 return soname_;
Christopher Ferrisbeae42b2018-02-15 17:36:33 -0800428 }
Christopher Ferris3958f802017-02-01 15:44:40 -0800429 }
Christopher Ferris02a6c442019-03-11 14:43:33 -0700430 return "";
Christopher Ferris3958f802017-02-01 15:44:40 -0800431}
432
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700433template <typename SymType>
Christopher Ferris4cc36d22018-06-06 14:47:31 -0700434bool ElfInterface::GetFunctionNameWithTemplate(uint64_t addr, std::string* name,
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700435 uint64_t* func_offset) {
436 if (symbols_.empty()) {
437 return false;
438 }
439
440 for (const auto symbol : symbols_) {
Christopher Ferris4cc36d22018-06-06 14:47:31 -0700441 if (symbol->GetName<SymType>(addr, memory_, name, func_offset)) {
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700442 return true;
443 }
444 }
445 return false;
446}
447
Christopher Ferris150db122017-12-20 18:49:01 -0800448template <typename SymType>
449bool ElfInterface::GetGlobalVariableWithTemplate(const std::string& name, uint64_t* memory_address) {
450 if (symbols_.empty()) {
451 return false;
452 }
453
454 for (const auto symbol : symbols_) {
455 if (symbol->GetGlobal<SymType>(memory_, name, memory_address)) {
456 return true;
457 }
458 }
459 return false;
460}
461
Christopher Ferris4cc36d22018-06-06 14:47:31 -0700462bool ElfInterface::Step(uint64_t pc, Regs* regs, Memory* process_memory, bool* finished) {
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800463 last_error_.code = ERROR_NONE;
464 last_error_.address = 0;
465
Christopher Ferris1a141a02018-01-24 08:52:47 -0800466 // Try the debug_frame first since it contains the most specific unwind
467 // information.
468 DwarfSection* debug_frame = debug_frame_.get();
Christopher Ferris4cc36d22018-06-06 14:47:31 -0700469 if (debug_frame != nullptr && debug_frame->Step(pc, regs, process_memory, finished)) {
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700470 return true;
471 }
472
Christopher Ferris1a141a02018-01-24 08:52:47 -0800473 // Try the eh_frame next.
474 DwarfSection* eh_frame = eh_frame_.get();
Christopher Ferris4cc36d22018-06-06 14:47:31 -0700475 if (eh_frame != nullptr && eh_frame->Step(pc, regs, process_memory, finished)) {
Christopher Ferrise7b66242017-12-15 11:17:45 -0800476 return true;
477 }
478
Christopher Ferrise7b66242017-12-15 11:17:45 -0800479 if (gnu_debugdata_interface_ != nullptr &&
Christopher Ferris4cc36d22018-06-06 14:47:31 -0700480 gnu_debugdata_interface_->Step(pc, regs, process_memory, finished)) {
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700481 return true;
482 }
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800483
484 // Set the error code based on the first error encountered.
485 DwarfSection* section = nullptr;
486 if (debug_frame_ != nullptr) {
487 section = debug_frame_.get();
488 } else if (eh_frame_ != nullptr) {
489 section = eh_frame_.get();
490 } else if (gnu_debugdata_interface_ != nullptr) {
491 last_error_ = gnu_debugdata_interface_->last_error();
492 return false;
493 } else {
494 return false;
495 }
496
497 // Convert the DWARF ERROR to an external error.
498 DwarfErrorCode code = section->LastErrorCode();
499 switch (code) {
500 case DWARF_ERROR_NONE:
501 last_error_.code = ERROR_NONE;
502 break;
503
504 case DWARF_ERROR_MEMORY_INVALID:
505 last_error_.code = ERROR_MEMORY_INVALID;
506 last_error_.address = section->LastErrorAddress();
507 break;
508
509 case DWARF_ERROR_ILLEGAL_VALUE:
510 case DWARF_ERROR_ILLEGAL_STATE:
511 case DWARF_ERROR_STACK_INDEX_NOT_VALID:
512 case DWARF_ERROR_TOO_MANY_ITERATIONS:
513 case DWARF_ERROR_CFA_NOT_DEFINED:
514 case DWARF_ERROR_NO_FDES:
515 last_error_.code = ERROR_UNWIND_INFO;
516 break;
517
518 case DWARF_ERROR_NOT_IMPLEMENTED:
519 case DWARF_ERROR_UNSUPPORTED_VERSION:
520 last_error_.code = ERROR_UNSUPPORTED;
521 break;
522 }
Christopher Ferris3958f802017-02-01 15:44:40 -0800523 return false;
524}
525
Christopher Ferris3f805ac2017-08-30 13:15:19 -0700526// This is an estimation of the size of the elf file using the location
527// of the section headers and size. This assumes that the section headers
528// are at the end of the elf file. If the elf has a load bias, the size
529// will be too large, but this is acceptable.
530template <typename EhdrType>
531void ElfInterface::GetMaxSizeWithTemplate(Memory* memory, uint64_t* size) {
532 EhdrType ehdr;
Josh Gaoef35aa52017-10-18 11:44:51 -0700533 if (!memory->ReadFully(0, &ehdr, sizeof(ehdr))) {
Christopher Ferris3f805ac2017-08-30 13:15:19 -0700534 return;
535 }
536 if (ehdr.e_shnum == 0) {
537 return;
538 }
539 *size = ehdr.e_shoff + ehdr.e_shentsize * ehdr.e_shnum;
540}
541
Christopher Ferrisbf373ed2019-01-16 17:23:39 -0800542template <typename EhdrType, typename ShdrType>
543bool GetBuildIDInfo(Memory* memory, uint64_t* build_id_offset, uint64_t* build_id_size) {
544 EhdrType ehdr;
545 if (!memory->ReadFully(0, &ehdr, sizeof(ehdr))) {
546 return false;
547 }
548
549 uint64_t offset = ehdr.e_shoff;
550 uint64_t sec_offset;
551 uint64_t sec_size;
552 ShdrType shdr;
553 if (ehdr.e_shstrndx >= ehdr.e_shnum) {
554 return false;
555 }
556
557 uint64_t sh_offset = offset + ehdr.e_shstrndx * ehdr.e_shentsize;
558 if (!memory->ReadFully(sh_offset, &shdr, sizeof(shdr))) {
559 return false;
560 }
561 sec_offset = shdr.sh_offset;
562 sec_size = shdr.sh_size;
563
564 // Skip the first header, it's always going to be NULL.
565 offset += ehdr.e_shentsize;
566 for (size_t i = 1; i < ehdr.e_shnum; i++, offset += ehdr.e_shentsize) {
567 if (!memory->ReadFully(offset, &shdr, sizeof(shdr))) {
568 return false;
569 }
570 std::string name;
571 if (shdr.sh_type == SHT_NOTE && shdr.sh_name < sec_size &&
572 memory->ReadString(sec_offset + shdr.sh_name, &name) && name == ".note.gnu.build-id") {
573 *build_id_offset = shdr.sh_offset;
574 *build_id_size = shdr.sh_size;
575 return true;
576 }
577 }
578
579 return false;
580}
581
582template <typename EhdrType, typename ShdrType, typename NhdrType>
583std::string ElfInterface::ReadBuildIDFromMemory(Memory* memory) {
584 uint64_t note_offset;
585 uint64_t note_size;
586 if (!GetBuildIDInfo<EhdrType, ShdrType>(memory, &note_offset, &note_size)) {
587 return "";
588 }
589
590 // Ensure there is no overflow in any of the calculations below.
591 uint64_t tmp;
592 if (__builtin_add_overflow(note_offset, note_size, &tmp)) {
593 return "";
594 }
595
596 uint64_t offset = 0;
597 while (offset < note_size) {
598 if (note_size - offset < sizeof(NhdrType)) {
599 return "";
600 }
601 NhdrType hdr;
602 if (!memory->ReadFully(note_offset + offset, &hdr, sizeof(hdr))) {
603 return "";
604 }
605 offset += sizeof(hdr);
606
607 if (note_size - offset < hdr.n_namesz) {
608 return "";
609 }
610 if (hdr.n_namesz > 0) {
611 std::string name(hdr.n_namesz, '\0');
612 if (!memory->ReadFully(note_offset + offset, &(name[0]), hdr.n_namesz)) {
613 return "";
614 }
615
616 // Trim trailing \0 as GNU is stored as a C string in the ELF file.
617 if (name.back() == '\0') name.resize(name.size() - 1);
618
619 // Align hdr.n_namesz to next power multiple of 4. See man 5 elf.
620 offset += (hdr.n_namesz + 3) & ~3;
621
622 if (name == "GNU" && hdr.n_type == NT_GNU_BUILD_ID) {
623 if (note_size - offset < hdr.n_descsz || hdr.n_descsz == 0) {
624 return "";
625 }
626 std::string build_id(hdr.n_descsz - 1, '\0');
627 if (memory->ReadFully(note_offset + offset, &build_id[0], hdr.n_descsz)) {
628 return build_id;
629 }
630 return "";
631 }
632 }
633 // Align hdr.n_descsz to next power multiple of 4. See man 5 elf.
634 offset += (hdr.n_descsz + 3) & ~3;
635 }
636 return "";
637}
638
Christopher Ferris3958f802017-02-01 15:44:40 -0800639// Instantiate all of the needed template functions.
Christopher Ferris4cc36d22018-06-06 14:47:31 -0700640template void ElfInterface::InitHeadersWithTemplate<uint32_t>(uint64_t);
641template void ElfInterface::InitHeadersWithTemplate<uint64_t>(uint64_t);
Christopher Ferris61d40972017-06-12 19:14:20 -0700642
Christopher Ferrise69f4702017-10-19 16:08:58 -0700643template bool ElfInterface::ReadAllHeaders<Elf32_Ehdr, Elf32_Phdr, Elf32_Shdr>(uint64_t*);
644template bool ElfInterface::ReadAllHeaders<Elf64_Ehdr, Elf64_Phdr, Elf64_Shdr>(uint64_t*);
Christopher Ferris3958f802017-02-01 15:44:40 -0800645
Christopher Ferris5acf0692018-08-01 13:10:46 -0700646template void ElfInterface::ReadProgramHeaders<Elf32_Ehdr, Elf32_Phdr>(const Elf32_Ehdr&,
647 uint64_t*);
648template void ElfInterface::ReadProgramHeaders<Elf64_Ehdr, Elf64_Phdr>(const Elf64_Ehdr&,
649 uint64_t*);
Christopher Ferris3958f802017-02-01 15:44:40 -0800650
Christopher Ferris5acf0692018-08-01 13:10:46 -0700651template void ElfInterface::ReadSectionHeaders<Elf32_Ehdr, Elf32_Shdr>(const Elf32_Ehdr&);
652template void ElfInterface::ReadSectionHeaders<Elf64_Ehdr, Elf64_Shdr>(const Elf64_Ehdr&);
Christopher Ferris3958f802017-02-01 15:44:40 -0800653
Christopher Ferrisbf373ed2019-01-16 17:23:39 -0800654template std::string ElfInterface::ReadBuildID<Elf32_Nhdr>();
655template std::string ElfInterface::ReadBuildID<Elf64_Nhdr>();
Florian Mayerda459e52018-11-23 16:56:17 +0000656
Christopher Ferris02a6c442019-03-11 14:43:33 -0700657template std::string ElfInterface::GetSonameWithTemplate<Elf32_Dyn>();
658template std::string ElfInterface::GetSonameWithTemplate<Elf64_Dyn>();
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700659
Christopher Ferris4cc36d22018-06-06 14:47:31 -0700660template bool ElfInterface::GetFunctionNameWithTemplate<Elf32_Sym>(uint64_t, std::string*,
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700661 uint64_t*);
Christopher Ferris4cc36d22018-06-06 14:47:31 -0700662template bool ElfInterface::GetFunctionNameWithTemplate<Elf64_Sym>(uint64_t, std::string*,
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700663 uint64_t*);
Christopher Ferrisd226a512017-07-14 10:37:19 -0700664
Christopher Ferris150db122017-12-20 18:49:01 -0800665template bool ElfInterface::GetGlobalVariableWithTemplate<Elf32_Sym>(const std::string&, uint64_t*);
666template bool ElfInterface::GetGlobalVariableWithTemplate<Elf64_Sym>(const std::string&, uint64_t*);
667
Christopher Ferris3f805ac2017-08-30 13:15:19 -0700668template void ElfInterface::GetMaxSizeWithTemplate<Elf32_Ehdr>(Memory*, uint64_t*);
669template void ElfInterface::GetMaxSizeWithTemplate<Elf64_Ehdr>(Memory*, uint64_t*);
670
Christopher Ferrisb7de5f52017-12-01 21:37:37 -0800671template uint64_t ElfInterface::GetLoadBias<Elf32_Ehdr, Elf32_Phdr>(Memory*);
672template uint64_t ElfInterface::GetLoadBias<Elf64_Ehdr, Elf64_Phdr>(Memory*);
673
Christopher Ferrisbf373ed2019-01-16 17:23:39 -0800674template std::string ElfInterface::ReadBuildIDFromMemory<Elf32_Ehdr, Elf32_Shdr, Elf32_Nhdr>(
675 Memory*);
676template std::string ElfInterface::ReadBuildIDFromMemory<Elf64_Ehdr, Elf64_Shdr, Elf64_Nhdr>(
677 Memory*);
678
Christopher Ferrisd226a512017-07-14 10:37:19 -0700679} // namespace unwindstack