blob: e34273cd5f3e0898bbec306b7873c9cd6988d7a4 [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 Ferris819f1312019-10-03 13:35:48 -0700127void ElfInterface::InitHeadersWithTemplate() {
Christopher Ferrisc9dee842017-11-03 14:50:27 -0700128 if (eh_frame_hdr_offset_ != 0) {
129 eh_frame_.reset(new DwarfEhFrameWithHdr<AddressType>(memory_));
Christopher Ferris819f1312019-10-03 13:35:48 -0700130 if (!eh_frame_->Init(eh_frame_hdr_offset_, eh_frame_hdr_size_, eh_frame_hdr_section_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 Ferris819f1312019-10-03 13:35:48 -0700139 if (!eh_frame_->Init(eh_frame_offset_, eh_frame_size_, eh_frame_section_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;
Christopher Ferris819f1312019-10-03 13:35:48 -0700146 eh_frame_hdr_section_bias_ = 0;
Christopher Ferris1a141a02018-01-24 08:52:47 -0800147 eh_frame_hdr_size_ = static_cast<uint64_t>(-1);
148 eh_frame_offset_ = 0;
Christopher Ferris819f1312019-10-03 13:35:48 -0700149 eh_frame_section_bias_ = 0;
Christopher Ferris1a141a02018-01-24 08:52:47 -0800150 eh_frame_size_ = static_cast<uint64_t>(-1);
151 }
152
Christopher Ferris61d40972017-06-12 19:14:20 -0700153 if (debug_frame_offset_ != 0) {
154 debug_frame_.reset(new DwarfDebugFrame<AddressType>(memory_));
Christopher Ferris819f1312019-10-03 13:35:48 -0700155 if (!debug_frame_->Init(debug_frame_offset_, debug_frame_size_, debug_frame_section_bias_)) {
Christopher Ferris61d40972017-06-12 19:14:20 -0700156 debug_frame_.reset(nullptr);
157 debug_frame_offset_ = 0;
158 debug_frame_size_ = static_cast<uint64_t>(-1);
159 }
160 }
161}
162
Christopher Ferris3958f802017-02-01 15:44:40 -0800163template <typename EhdrType, typename PhdrType, typename ShdrType>
Christopher Ferris819f1312019-10-03 13:35:48 -0700164bool ElfInterface::ReadAllHeaders(int64_t* load_bias) {
Christopher Ferris3958f802017-02-01 15:44:40 -0800165 EhdrType ehdr;
Josh Gaoef35aa52017-10-18 11:44:51 -0700166 if (!memory_->ReadFully(0, &ehdr, sizeof(ehdr))) {
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800167 last_error_.code = ERROR_MEMORY_INVALID;
168 last_error_.address = 0;
Christopher Ferris3958f802017-02-01 15:44:40 -0800169 return false;
170 }
171
Christopher Ferris5acf0692018-08-01 13:10:46 -0700172 // If we have enough information that this is an elf file, then allow
173 // malformed program and section headers.
174 ReadProgramHeaders<EhdrType, PhdrType>(ehdr, load_bias);
175 ReadSectionHeaders<EhdrType, ShdrType>(ehdr);
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700176 return true;
Christopher Ferris3958f802017-02-01 15:44:40 -0800177}
178
179template <typename EhdrType, typename PhdrType>
Christopher Ferris819f1312019-10-03 13:35:48 -0700180int64_t ElfInterface::GetLoadBias(Memory* memory) {
Christopher Ferrisb7de5f52017-12-01 21:37:37 -0800181 EhdrType ehdr;
Christopher Ferriscadacdf2019-01-15 19:10:49 -0800182 if (!memory->ReadFully(0, &ehdr, sizeof(ehdr))) {
Christopher Ferrisb7de5f52017-12-01 21:37:37 -0800183 return false;
184 }
185
186 uint64_t offset = ehdr.e_phoff;
187 for (size_t i = 0; i < ehdr.e_phnum; i++, offset += ehdr.e_phentsize) {
188 PhdrType phdr;
Christopher Ferriscadacdf2019-01-15 19:10:49 -0800189 if (!memory->ReadFully(offset, &phdr, sizeof(phdr))) {
Christopher Ferrisb7de5f52017-12-01 21:37:37 -0800190 return 0;
191 }
Christopher Ferris6c8ac562019-10-02 17:41:16 -0700192
193 // Find the first executable load when looking for the load bias.
194 if (phdr.p_type == PT_LOAD && (phdr.p_flags & PF_X)) {
Christopher Ferris819f1312019-10-03 13:35:48 -0700195 return static_cast<uint64_t>(phdr.p_vaddr) - phdr.p_offset;
Christopher Ferrisb7de5f52017-12-01 21:37:37 -0800196 }
197 }
198 return 0;
199}
200
201template <typename EhdrType, typename PhdrType>
Christopher Ferris819f1312019-10-03 13:35:48 -0700202void ElfInterface::ReadProgramHeaders(const EhdrType& ehdr, int64_t* load_bias) {
Christopher Ferris3958f802017-02-01 15:44:40 -0800203 uint64_t offset = ehdr.e_phoff;
Florian Mayer249c90f2019-07-05 16:48:04 +0100204 bool first_exec_load_header = true;
Christopher Ferris3958f802017-02-01 15:44:40 -0800205 for (size_t i = 0; i < ehdr.e_phnum; i++, offset += ehdr.e_phentsize) {
206 PhdrType phdr;
Christopher Ferris5afddb02018-06-29 16:30:55 -0700207 if (!memory_->ReadFully(offset, &phdr, sizeof(phdr))) {
Christopher Ferris5acf0692018-08-01 13:10:46 -0700208 return;
Christopher Ferris3958f802017-02-01 15:44:40 -0800209 }
210
Christopher Ferris3958f802017-02-01 15:44:40 -0800211 switch (phdr.p_type) {
212 case PT_LOAD:
213 {
Christopher Ferris3958f802017-02-01 15:44:40 -0800214 if ((phdr.p_flags & PF_X) == 0) {
215 continue;
216 }
217
Christopher Ferris3958f802017-02-01 15:44:40 -0800218 pt_loads_[phdr.p_offset] = LoadInfo{phdr.p_offset, phdr.p_vaddr,
219 static_cast<size_t>(phdr.p_memsz)};
Florian Mayer249c90f2019-07-05 16:48:04 +0100220 // Only set the load bias from the first executable load header.
Christopher Ferris819f1312019-10-03 13:35:48 -0700221 if (first_exec_load_header) {
222 *load_bias = static_cast<uint64_t>(phdr.p_vaddr) - phdr.p_offset;
Christopher Ferris3958f802017-02-01 15:44:40 -0800223 }
Florian Mayer249c90f2019-07-05 16:48:04 +0100224 first_exec_load_header = false;
Christopher Ferris3958f802017-02-01 15:44:40 -0800225 break;
226 }
227
228 case PT_GNU_EH_FRAME:
Christopher Ferrisc9dee842017-11-03 14:50:27 -0700229 // This is really the pointer to the .eh_frame_hdr section.
230 eh_frame_hdr_offset_ = phdr.p_offset;
Christopher Ferris819f1312019-10-03 13:35:48 -0700231 eh_frame_hdr_section_bias_ = static_cast<uint64_t>(phdr.p_paddr) - phdr.p_offset;
Christopher Ferrisc9dee842017-11-03 14:50:27 -0700232 eh_frame_hdr_size_ = phdr.p_memsz;
Christopher Ferris3958f802017-02-01 15:44:40 -0800233 break;
234
235 case PT_DYNAMIC:
Christopher Ferris3958f802017-02-01 15:44:40 -0800236 dynamic_offset_ = phdr.p_offset;
Christopher Ferris150db122017-12-20 18:49:01 -0800237 dynamic_vaddr_ = phdr.p_vaddr;
Christopher Ferris3958f802017-02-01 15:44:40 -0800238 dynamic_size_ = phdr.p_memsz;
239 break;
Christopher Ferris5afddb02018-06-29 16:30:55 -0700240
241 default:
242 HandleUnknownType(phdr.p_type, phdr.p_offset, phdr.p_filesz);
243 break;
Christopher Ferris3958f802017-02-01 15:44:40 -0800244 }
245 }
Christopher Ferris3958f802017-02-01 15:44:40 -0800246}
247
Florian Mayerda459e52018-11-23 16:56:17 +0000248template <typename NhdrType>
Christopher Ferrisbf373ed2019-01-16 17:23:39 -0800249std::string ElfInterface::ReadBuildID() {
Florian Mayerda459e52018-11-23 16:56:17 +0000250 // Ensure there is no overflow in any of the calulations below.
251 uint64_t tmp;
252 if (__builtin_add_overflow(gnu_build_id_offset_, gnu_build_id_size_, &tmp)) {
Christopher Ferrisbf373ed2019-01-16 17:23:39 -0800253 return "";
Florian Mayerda459e52018-11-23 16:56:17 +0000254 }
255
256 uint64_t offset = 0;
257 while (offset < gnu_build_id_size_) {
258 if (gnu_build_id_size_ - offset < sizeof(NhdrType)) {
Christopher Ferrisbf373ed2019-01-16 17:23:39 -0800259 return "";
Florian Mayerda459e52018-11-23 16:56:17 +0000260 }
261 NhdrType hdr;
262 if (!memory_->ReadFully(gnu_build_id_offset_ + offset, &hdr, sizeof(hdr))) {
Christopher Ferrisbf373ed2019-01-16 17:23:39 -0800263 return "";
Florian Mayerda459e52018-11-23 16:56:17 +0000264 }
265 offset += sizeof(hdr);
266
267 if (gnu_build_id_size_ - offset < hdr.n_namesz) {
Christopher Ferrisbf373ed2019-01-16 17:23:39 -0800268 return "";
Florian Mayerda459e52018-11-23 16:56:17 +0000269 }
270 if (hdr.n_namesz > 0) {
271 std::string name(hdr.n_namesz, '\0');
272 if (!memory_->ReadFully(gnu_build_id_offset_ + offset, &(name[0]), hdr.n_namesz)) {
Christopher Ferrisbf373ed2019-01-16 17:23:39 -0800273 return "";
Florian Mayerda459e52018-11-23 16:56:17 +0000274 }
275
276 // Trim trailing \0 as GNU is stored as a C string in the ELF file.
277 if (name.back() == '\0')
278 name.resize(name.size() - 1);
279
280 // Align hdr.n_namesz to next power multiple of 4. See man 5 elf.
281 offset += (hdr.n_namesz + 3) & ~3;
282
283 if (name == "GNU" && hdr.n_type == NT_GNU_BUILD_ID) {
Christopher Ferrisbf373ed2019-01-16 17:23:39 -0800284 if (gnu_build_id_size_ - offset < hdr.n_descsz || hdr.n_descsz == 0) {
285 return "";
Florian Mayerda459e52018-11-23 16:56:17 +0000286 }
Christopher Ferris1760b452019-04-03 14:14:30 -0700287 std::string build_id(hdr.n_descsz, '\0');
Christopher Ferrisbf373ed2019-01-16 17:23:39 -0800288 if (memory_->ReadFully(gnu_build_id_offset_ + offset, &build_id[0], hdr.n_descsz)) {
289 return build_id;
290 }
291 return "";
Florian Mayerda459e52018-11-23 16:56:17 +0000292 }
293 }
294 // Align hdr.n_descsz to next power multiple of 4. See man 5 elf.
295 offset += (hdr.n_descsz + 3) & ~3;
296 }
Christopher Ferrisbf373ed2019-01-16 17:23:39 -0800297 return "";
Florian Mayerda459e52018-11-23 16:56:17 +0000298}
299
Christopher Ferris3958f802017-02-01 15:44:40 -0800300template <typename EhdrType, typename ShdrType>
Christopher Ferris5acf0692018-08-01 13:10:46 -0700301void ElfInterface::ReadSectionHeaders(const EhdrType& ehdr) {
Christopher Ferris3958f802017-02-01 15:44:40 -0800302 uint64_t offset = ehdr.e_shoff;
303 uint64_t sec_offset = 0;
304 uint64_t sec_size = 0;
305
306 // Get the location of the section header names.
307 // If something is malformed in the header table data, we aren't going
308 // to terminate, we'll simply ignore this part.
309 ShdrType shdr;
310 if (ehdr.e_shstrndx < ehdr.e_shnum) {
311 uint64_t sh_offset = offset + ehdr.e_shstrndx * ehdr.e_shentsize;
Christopher Ferris5afddb02018-06-29 16:30:55 -0700312 if (memory_->ReadFully(sh_offset, &shdr, sizeof(shdr))) {
Christopher Ferris3958f802017-02-01 15:44:40 -0800313 sec_offset = shdr.sh_offset;
314 sec_size = shdr.sh_size;
315 }
316 }
317
318 // Skip the first header, it's always going to be NULL.
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700319 offset += ehdr.e_shentsize;
Christopher Ferris3958f802017-02-01 15:44:40 -0800320 for (size_t i = 1; i < ehdr.e_shnum; i++, offset += ehdr.e_shentsize) {
Christopher Ferriscadacdf2019-01-15 19:10:49 -0800321 if (!memory_->ReadFully(offset, &shdr, sizeof(shdr))) {
Christopher Ferris5acf0692018-08-01 13:10:46 -0700322 return;
Christopher Ferris3958f802017-02-01 15:44:40 -0800323 }
324
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700325 if (shdr.sh_type == SHT_SYMTAB || shdr.sh_type == SHT_DYNSYM) {
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700326 // Need to go get the information about the section that contains
327 // the string terminated names.
328 ShdrType str_shdr;
329 if (shdr.sh_link >= ehdr.e_shnum) {
Christopher Ferris5acf0692018-08-01 13:10:46 -0700330 continue;
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700331 }
332 uint64_t str_offset = ehdr.e_shoff + shdr.sh_link * ehdr.e_shentsize;
Christopher Ferriscadacdf2019-01-15 19:10:49 -0800333 if (!memory_->ReadFully(str_offset, &str_shdr, sizeof(str_shdr))) {
Christopher Ferris5acf0692018-08-01 13:10:46 -0700334 continue;
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700335 }
336 if (str_shdr.sh_type != SHT_STRTAB) {
Christopher Ferris5acf0692018-08-01 13:10:46 -0700337 continue;
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700338 }
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700339 symbols_.push_back(new Symbols(shdr.sh_offset, shdr.sh_size, shdr.sh_entsize,
340 str_shdr.sh_offset, str_shdr.sh_size));
David Srbeckyb9cc4fb2019-04-05 18:23:32 +0000341 } else if (shdr.sh_type == SHT_PROGBITS && sec_size != 0) {
Christopher Ferris3958f802017-02-01 15:44:40 -0800342 // Look for the .debug_frame and .gnu_debugdata.
Christopher Ferris3958f802017-02-01 15:44:40 -0800343 if (shdr.sh_name < sec_size) {
344 std::string name;
345 if (memory_->ReadString(sec_offset + shdr.sh_name, &name)) {
346 if (name == ".debug_frame") {
Christopher Ferris819f1312019-10-03 13:35:48 -0700347 debug_frame_offset_ = shdr.sh_offset;
348 debug_frame_size_ = shdr.sh_size;
349 debug_frame_section_bias_ = static_cast<uint64_t>(shdr.sh_addr) - shdr.sh_offset;
Christopher Ferris3958f802017-02-01 15:44:40 -0800350 } else if (name == ".gnu_debugdata") {
Christopher Ferris819f1312019-10-03 13:35:48 -0700351 gnu_debugdata_offset_ = shdr.sh_offset;
352 gnu_debugdata_size_ = shdr.sh_size;
Christopher Ferrisc9dee842017-11-03 14:50:27 -0700353 } else if (name == ".eh_frame") {
Christopher Ferris819f1312019-10-03 13:35:48 -0700354 eh_frame_offset_ = shdr.sh_offset;
355 eh_frame_section_bias_ = static_cast<uint64_t>(shdr.sh_addr) - shdr.sh_offset;
356 eh_frame_size_ = shdr.sh_size;
Christopher Ferrisc9dee842017-11-03 14:50:27 -0700357 } else if (eh_frame_hdr_offset_ == 0 && name == ".eh_frame_hdr") {
Christopher Ferris819f1312019-10-03 13:35:48 -0700358 eh_frame_hdr_offset_ = shdr.sh_offset;
359 eh_frame_hdr_section_bias_ = static_cast<uint64_t>(shdr.sh_addr) - shdr.sh_offset;
360 eh_frame_hdr_size_ = shdr.sh_size;
Christopher Ferris3958f802017-02-01 15:44:40 -0800361 }
362 }
363 }
Christopher Ferrisbeae42b2018-02-15 17:36:33 -0800364 } else if (shdr.sh_type == SHT_STRTAB) {
365 // In order to read soname, keep track of address to offset mapping.
366 strtabs_.push_back(std::make_pair<uint64_t, uint64_t>(static_cast<uint64_t>(shdr.sh_addr),
367 static_cast<uint64_t>(shdr.sh_offset)));
Florian Mayerda459e52018-11-23 16:56:17 +0000368 } else if (shdr.sh_type == SHT_NOTE) {
369 if (shdr.sh_name < sec_size) {
370 std::string name;
371 if (memory_->ReadString(sec_offset + shdr.sh_name, &name) &&
372 name == ".note.gnu.build-id") {
373 gnu_build_id_offset_ = shdr.sh_offset;
374 gnu_build_id_size_ = shdr.sh_size;
375 }
376 }
Christopher Ferris3958f802017-02-01 15:44:40 -0800377 }
378 }
Christopher Ferris3958f802017-02-01 15:44:40 -0800379}
380
381template <typename DynType>
Christopher Ferris02a6c442019-03-11 14:43:33 -0700382std::string ElfInterface::GetSonameWithTemplate() {
Christopher Ferris3958f802017-02-01 15:44:40 -0800383 if (soname_type_ == SONAME_INVALID) {
Christopher Ferris02a6c442019-03-11 14:43:33 -0700384 return "";
Christopher Ferris3958f802017-02-01 15:44:40 -0800385 }
386 if (soname_type_ == SONAME_VALID) {
Christopher Ferris02a6c442019-03-11 14:43:33 -0700387 return soname_;
Christopher Ferris3958f802017-02-01 15:44:40 -0800388 }
389
390 soname_type_ = SONAME_INVALID;
391
392 uint64_t soname_offset = 0;
Christopher Ferrisbeae42b2018-02-15 17:36:33 -0800393 uint64_t strtab_addr = 0;
Christopher Ferris3958f802017-02-01 15:44:40 -0800394 uint64_t strtab_size = 0;
395
396 // Find the soname location from the dynamic headers section.
397 DynType dyn;
398 uint64_t offset = dynamic_offset_;
399 uint64_t max_offset = offset + dynamic_size_;
400 for (uint64_t offset = dynamic_offset_; offset < max_offset; offset += sizeof(DynType)) {
Josh Gaoef35aa52017-10-18 11:44:51 -0700401 if (!memory_->ReadFully(offset, &dyn, sizeof(dyn))) {
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800402 last_error_.code = ERROR_MEMORY_INVALID;
403 last_error_.address = offset;
Christopher Ferris02a6c442019-03-11 14:43:33 -0700404 return "";
Christopher Ferris3958f802017-02-01 15:44:40 -0800405 }
406
407 if (dyn.d_tag == DT_STRTAB) {
Christopher Ferrisbeae42b2018-02-15 17:36:33 -0800408 strtab_addr = dyn.d_un.d_ptr;
Christopher Ferris3958f802017-02-01 15:44:40 -0800409 } else if (dyn.d_tag == DT_STRSZ) {
410 strtab_size = dyn.d_un.d_val;
411 } else if (dyn.d_tag == DT_SONAME) {
412 soname_offset = dyn.d_un.d_val;
413 } else if (dyn.d_tag == DT_NULL) {
414 break;
415 }
416 }
417
Christopher Ferrisbeae42b2018-02-15 17:36:33 -0800418 // Need to map the strtab address to the real offset.
419 for (const auto& entry : strtabs_) {
420 if (entry.first == strtab_addr) {
421 soname_offset = entry.second + soname_offset;
422 if (soname_offset >= entry.second + strtab_size) {
Christopher Ferris02a6c442019-03-11 14:43:33 -0700423 return "";
Christopher Ferrisbeae42b2018-02-15 17:36:33 -0800424 }
425 if (!memory_->ReadString(soname_offset, &soname_)) {
Christopher Ferris02a6c442019-03-11 14:43:33 -0700426 return "";
Christopher Ferrisbeae42b2018-02-15 17:36:33 -0800427 }
428 soname_type_ = SONAME_VALID;
Christopher Ferris02a6c442019-03-11 14:43:33 -0700429 return soname_;
Christopher Ferrisbeae42b2018-02-15 17:36:33 -0800430 }
Christopher Ferris3958f802017-02-01 15:44:40 -0800431 }
Christopher Ferris02a6c442019-03-11 14:43:33 -0700432 return "";
Christopher Ferris3958f802017-02-01 15:44:40 -0800433}
434
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700435template <typename SymType>
Christopher Ferris4cc36d22018-06-06 14:47:31 -0700436bool ElfInterface::GetFunctionNameWithTemplate(uint64_t addr, std::string* name,
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700437 uint64_t* func_offset) {
438 if (symbols_.empty()) {
439 return false;
440 }
441
442 for (const auto symbol : symbols_) {
Christopher Ferris4cc36d22018-06-06 14:47:31 -0700443 if (symbol->GetName<SymType>(addr, memory_, name, func_offset)) {
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700444 return true;
445 }
446 }
447 return false;
448}
449
Christopher Ferris150db122017-12-20 18:49:01 -0800450template <typename SymType>
451bool ElfInterface::GetGlobalVariableWithTemplate(const std::string& name, uint64_t* memory_address) {
452 if (symbols_.empty()) {
453 return false;
454 }
455
456 for (const auto symbol : symbols_) {
457 if (symbol->GetGlobal<SymType>(memory_, name, memory_address)) {
458 return true;
459 }
460 }
461 return false;
462}
463
Christopher Ferris4cc36d22018-06-06 14:47:31 -0700464bool ElfInterface::Step(uint64_t pc, Regs* regs, Memory* process_memory, bool* finished) {
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800465 last_error_.code = ERROR_NONE;
466 last_error_.address = 0;
467
Christopher Ferris1a141a02018-01-24 08:52:47 -0800468 // Try the debug_frame first since it contains the most specific unwind
469 // information.
470 DwarfSection* debug_frame = debug_frame_.get();
Christopher Ferris4cc36d22018-06-06 14:47:31 -0700471 if (debug_frame != nullptr && debug_frame->Step(pc, regs, process_memory, finished)) {
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700472 return true;
473 }
474
Christopher Ferris1a141a02018-01-24 08:52:47 -0800475 // Try the eh_frame next.
476 DwarfSection* eh_frame = eh_frame_.get();
Christopher Ferris4cc36d22018-06-06 14:47:31 -0700477 if (eh_frame != nullptr && eh_frame->Step(pc, regs, process_memory, finished)) {
Christopher Ferrise7b66242017-12-15 11:17:45 -0800478 return true;
479 }
480
Christopher Ferrise7b66242017-12-15 11:17:45 -0800481 if (gnu_debugdata_interface_ != nullptr &&
Christopher Ferris4cc36d22018-06-06 14:47:31 -0700482 gnu_debugdata_interface_->Step(pc, regs, process_memory, finished)) {
Christopher Ferris8098b1c2017-06-20 13:54:08 -0700483 return true;
484 }
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800485
486 // Set the error code based on the first error encountered.
487 DwarfSection* section = nullptr;
488 if (debug_frame_ != nullptr) {
489 section = debug_frame_.get();
490 } else if (eh_frame_ != nullptr) {
491 section = eh_frame_.get();
492 } else if (gnu_debugdata_interface_ != nullptr) {
493 last_error_ = gnu_debugdata_interface_->last_error();
494 return false;
495 } else {
496 return false;
497 }
498
499 // Convert the DWARF ERROR to an external error.
500 DwarfErrorCode code = section->LastErrorCode();
501 switch (code) {
502 case DWARF_ERROR_NONE:
503 last_error_.code = ERROR_NONE;
504 break;
505
506 case DWARF_ERROR_MEMORY_INVALID:
507 last_error_.code = ERROR_MEMORY_INVALID;
508 last_error_.address = section->LastErrorAddress();
509 break;
510
511 case DWARF_ERROR_ILLEGAL_VALUE:
512 case DWARF_ERROR_ILLEGAL_STATE:
513 case DWARF_ERROR_STACK_INDEX_NOT_VALID:
514 case DWARF_ERROR_TOO_MANY_ITERATIONS:
515 case DWARF_ERROR_CFA_NOT_DEFINED:
516 case DWARF_ERROR_NO_FDES:
517 last_error_.code = ERROR_UNWIND_INFO;
518 break;
519
520 case DWARF_ERROR_NOT_IMPLEMENTED:
521 case DWARF_ERROR_UNSUPPORTED_VERSION:
522 last_error_.code = ERROR_UNSUPPORTED;
523 break;
524 }
Christopher Ferris3958f802017-02-01 15:44:40 -0800525 return false;
526}
527
Christopher Ferris3f805ac2017-08-30 13:15:19 -0700528// This is an estimation of the size of the elf file using the location
529// of the section headers and size. This assumes that the section headers
530// are at the end of the elf file. If the elf has a load bias, the size
531// will be too large, but this is acceptable.
532template <typename EhdrType>
533void ElfInterface::GetMaxSizeWithTemplate(Memory* memory, uint64_t* size) {
534 EhdrType ehdr;
Josh Gaoef35aa52017-10-18 11:44:51 -0700535 if (!memory->ReadFully(0, &ehdr, sizeof(ehdr))) {
Christopher Ferris3f805ac2017-08-30 13:15:19 -0700536 return;
537 }
538 if (ehdr.e_shnum == 0) {
539 return;
540 }
541 *size = ehdr.e_shoff + ehdr.e_shentsize * ehdr.e_shnum;
542}
543
Christopher Ferrisbf373ed2019-01-16 17:23:39 -0800544template <typename EhdrType, typename ShdrType>
545bool GetBuildIDInfo(Memory* memory, uint64_t* build_id_offset, uint64_t* build_id_size) {
546 EhdrType ehdr;
547 if (!memory->ReadFully(0, &ehdr, sizeof(ehdr))) {
548 return false;
549 }
550
551 uint64_t offset = ehdr.e_shoff;
552 uint64_t sec_offset;
553 uint64_t sec_size;
554 ShdrType shdr;
555 if (ehdr.e_shstrndx >= ehdr.e_shnum) {
556 return false;
557 }
558
559 uint64_t sh_offset = offset + ehdr.e_shstrndx * ehdr.e_shentsize;
560 if (!memory->ReadFully(sh_offset, &shdr, sizeof(shdr))) {
561 return false;
562 }
563 sec_offset = shdr.sh_offset;
564 sec_size = shdr.sh_size;
565
566 // Skip the first header, it's always going to be NULL.
567 offset += ehdr.e_shentsize;
568 for (size_t i = 1; i < ehdr.e_shnum; i++, offset += ehdr.e_shentsize) {
569 if (!memory->ReadFully(offset, &shdr, sizeof(shdr))) {
570 return false;
571 }
572 std::string name;
573 if (shdr.sh_type == SHT_NOTE && shdr.sh_name < sec_size &&
574 memory->ReadString(sec_offset + shdr.sh_name, &name) && name == ".note.gnu.build-id") {
575 *build_id_offset = shdr.sh_offset;
576 *build_id_size = shdr.sh_size;
577 return true;
578 }
579 }
580
581 return false;
582}
583
584template <typename EhdrType, typename ShdrType, typename NhdrType>
585std::string ElfInterface::ReadBuildIDFromMemory(Memory* memory) {
586 uint64_t note_offset;
587 uint64_t note_size;
588 if (!GetBuildIDInfo<EhdrType, ShdrType>(memory, &note_offset, &note_size)) {
589 return "";
590 }
591
592 // Ensure there is no overflow in any of the calculations below.
593 uint64_t tmp;
594 if (__builtin_add_overflow(note_offset, note_size, &tmp)) {
595 return "";
596 }
597
598 uint64_t offset = 0;
599 while (offset < note_size) {
600 if (note_size - offset < sizeof(NhdrType)) {
601 return "";
602 }
603 NhdrType hdr;
604 if (!memory->ReadFully(note_offset + offset, &hdr, sizeof(hdr))) {
605 return "";
606 }
607 offset += sizeof(hdr);
608
609 if (note_size - offset < hdr.n_namesz) {
610 return "";
611 }
612 if (hdr.n_namesz > 0) {
613 std::string name(hdr.n_namesz, '\0');
614 if (!memory->ReadFully(note_offset + offset, &(name[0]), hdr.n_namesz)) {
615 return "";
616 }
617
618 // Trim trailing \0 as GNU is stored as a C string in the ELF file.
619 if (name.back() == '\0') name.resize(name.size() - 1);
620
621 // Align hdr.n_namesz to next power multiple of 4. See man 5 elf.
622 offset += (hdr.n_namesz + 3) & ~3;
623
624 if (name == "GNU" && hdr.n_type == NT_GNU_BUILD_ID) {
625 if (note_size - offset < hdr.n_descsz || hdr.n_descsz == 0) {
626 return "";
627 }
628 std::string build_id(hdr.n_descsz - 1, '\0');
629 if (memory->ReadFully(note_offset + offset, &build_id[0], hdr.n_descsz)) {
630 return build_id;
631 }
632 return "";
633 }
634 }
635 // Align hdr.n_descsz to next power multiple of 4. See man 5 elf.
636 offset += (hdr.n_descsz + 3) & ~3;
637 }
638 return "";
639}
640
Christopher Ferris3958f802017-02-01 15:44:40 -0800641// Instantiate all of the needed template functions.
Christopher Ferris819f1312019-10-03 13:35:48 -0700642template void ElfInterface::InitHeadersWithTemplate<uint32_t>();
643template void ElfInterface::InitHeadersWithTemplate<uint64_t>();
Christopher Ferris61d40972017-06-12 19:14:20 -0700644
Christopher Ferris819f1312019-10-03 13:35:48 -0700645template bool ElfInterface::ReadAllHeaders<Elf32_Ehdr, Elf32_Phdr, Elf32_Shdr>(int64_t*);
646template bool ElfInterface::ReadAllHeaders<Elf64_Ehdr, Elf64_Phdr, Elf64_Shdr>(int64_t*);
Christopher Ferris3958f802017-02-01 15:44:40 -0800647
Christopher Ferris819f1312019-10-03 13:35:48 -0700648template void ElfInterface::ReadProgramHeaders<Elf32_Ehdr, Elf32_Phdr>(const Elf32_Ehdr&, int64_t*);
649template void ElfInterface::ReadProgramHeaders<Elf64_Ehdr, Elf64_Phdr>(const Elf64_Ehdr&, int64_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 Ferris819f1312019-10-03 13:35:48 -0700671template int64_t ElfInterface::GetLoadBias<Elf32_Ehdr, Elf32_Phdr>(Memory*);
672template int64_t ElfInterface::GetLoadBias<Elf64_Ehdr, Elf64_Phdr>(Memory*);
Christopher Ferrisb7de5f52017-12-01 21:37:37 -0800673
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