1dda28197Spatrick //===-- ProcessMinidump.cpp -----------------------------------------------===//
2061da546Spatrick //
3061da546Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4061da546Spatrick // See https://llvm.org/LICENSE.txt for license information.
5061da546Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6061da546Spatrick //
7061da546Spatrick //===----------------------------------------------------------------------===//
8061da546Spatrick
9061da546Spatrick #include "ProcessMinidump.h"
10061da546Spatrick
11061da546Spatrick #include "ThreadMinidump.h"
12061da546Spatrick
13061da546Spatrick #include "lldb/Core/DumpDataExtractor.h"
14061da546Spatrick #include "lldb/Core/Module.h"
15061da546Spatrick #include "lldb/Core/ModuleSpec.h"
16061da546Spatrick #include "lldb/Core/PluginManager.h"
17061da546Spatrick #include "lldb/Core/Section.h"
18061da546Spatrick #include "lldb/Interpreter/CommandInterpreter.h"
19061da546Spatrick #include "lldb/Interpreter/CommandObject.h"
20061da546Spatrick #include "lldb/Interpreter/CommandObjectMultiword.h"
21061da546Spatrick #include "lldb/Interpreter/CommandReturnObject.h"
22061da546Spatrick #include "lldb/Interpreter/OptionArgParser.h"
23061da546Spatrick #include "lldb/Interpreter/OptionGroupBoolean.h"
24061da546Spatrick #include "lldb/Target/JITLoaderList.h"
25061da546Spatrick #include "lldb/Target/MemoryRegionInfo.h"
26061da546Spatrick #include "lldb/Target/SectionLoadList.h"
27061da546Spatrick #include "lldb/Target/Target.h"
28061da546Spatrick #include "lldb/Target/UnixSignals.h"
29061da546Spatrick #include "lldb/Utility/LLDBAssert.h"
30*f6aab3d8Srobert #include "lldb/Utility/LLDBLog.h"
31061da546Spatrick #include "lldb/Utility/Log.h"
32061da546Spatrick #include "lldb/Utility/State.h"
33061da546Spatrick #include "llvm/BinaryFormat/Magic.h"
34061da546Spatrick #include "llvm/Support/MemoryBuffer.h"
35061da546Spatrick #include "llvm/Support/Threading.h"
36061da546Spatrick
37061da546Spatrick #include "Plugins/Process/Utility/StopInfoMachException.h"
38061da546Spatrick
39061da546Spatrick #include <memory>
40*f6aab3d8Srobert #include <optional>
41061da546Spatrick
42061da546Spatrick using namespace lldb;
43061da546Spatrick using namespace lldb_private;
44061da546Spatrick using namespace minidump;
45061da546Spatrick
46dda28197Spatrick LLDB_PLUGIN_DEFINE(ProcessMinidump)
47dda28197Spatrick
48061da546Spatrick namespace {
49061da546Spatrick
50061da546Spatrick /// A minimal ObjectFile implementation providing a dummy object file for the
51061da546Spatrick /// cases when the real module binary is not available. This allows the module
52061da546Spatrick /// to show up in "image list" and symbols to be added to it.
53061da546Spatrick class PlaceholderObjectFile : public ObjectFile {
54061da546Spatrick public:
PlaceholderObjectFile(const lldb::ModuleSP & module_sp,const ModuleSpec & module_spec,lldb::addr_t base,lldb::addr_t size)55061da546Spatrick PlaceholderObjectFile(const lldb::ModuleSP &module_sp,
56061da546Spatrick const ModuleSpec &module_spec, lldb::addr_t base,
57061da546Spatrick lldb::addr_t size)
58061da546Spatrick : ObjectFile(module_sp, &module_spec.GetFileSpec(), /*file_offset*/ 0,
59061da546Spatrick /*length*/ 0, /*data_sp*/ nullptr, /*data_offset*/ 0),
60061da546Spatrick m_arch(module_spec.GetArchitecture()), m_uuid(module_spec.GetUUID()),
61061da546Spatrick m_base(base), m_size(size) {
62061da546Spatrick m_symtab_up = std::make_unique<Symtab>(this);
63061da546Spatrick }
64061da546Spatrick
GetStaticPluginName()65061da546Spatrick static ConstString GetStaticPluginName() {
66061da546Spatrick return ConstString("placeholder");
67061da546Spatrick }
GetPluginName()68*f6aab3d8Srobert llvm::StringRef GetPluginName() override {
69*f6aab3d8Srobert return GetStaticPluginName().GetStringRef();
70*f6aab3d8Srobert }
ParseHeader()71061da546Spatrick bool ParseHeader() override { return true; }
CalculateType()72061da546Spatrick Type CalculateType() override { return eTypeUnknown; }
CalculateStrata()73061da546Spatrick Strata CalculateStrata() override { return eStrataUnknown; }
GetDependentModules(FileSpecList & file_list)74061da546Spatrick uint32_t GetDependentModules(FileSpecList &file_list) override { return 0; }
IsExecutable() const75061da546Spatrick bool IsExecutable() const override { return false; }
GetArchitecture()76061da546Spatrick ArchSpec GetArchitecture() override { return m_arch; }
GetUUID()77061da546Spatrick UUID GetUUID() override { return m_uuid; }
ParseSymtab(lldb_private::Symtab & symtab)78*f6aab3d8Srobert void ParseSymtab(lldb_private::Symtab &symtab) override {}
IsStripped()79061da546Spatrick bool IsStripped() override { return true; }
GetByteOrder() const80061da546Spatrick ByteOrder GetByteOrder() const override { return m_arch.GetByteOrder(); }
81061da546Spatrick
GetAddressByteSize() const82061da546Spatrick uint32_t GetAddressByteSize() const override {
83061da546Spatrick return m_arch.GetAddressByteSize();
84061da546Spatrick }
85061da546Spatrick
GetBaseAddress()86061da546Spatrick Address GetBaseAddress() override {
87061da546Spatrick return Address(m_sections_up->GetSectionAtIndex(0), 0);
88061da546Spatrick }
89061da546Spatrick
CreateSections(SectionList & unified_section_list)90061da546Spatrick void CreateSections(SectionList &unified_section_list) override {
91061da546Spatrick m_sections_up = std::make_unique<SectionList>();
92061da546Spatrick auto section_sp = std::make_shared<Section>(
93061da546Spatrick GetModule(), this, /*sect_id*/ 0, ConstString(".module_image"),
94061da546Spatrick eSectionTypeOther, m_base, m_size, /*file_offset*/ 0, /*file_size*/ 0,
95061da546Spatrick /*log2align*/ 0, /*flags*/ 0);
96061da546Spatrick section_sp->SetPermissions(ePermissionsReadable | ePermissionsExecutable);
97061da546Spatrick m_sections_up->AddSection(section_sp);
98061da546Spatrick unified_section_list.AddSection(std::move(section_sp));
99061da546Spatrick }
100061da546Spatrick
SetLoadAddress(Target & target,addr_t value,bool value_is_offset)101061da546Spatrick bool SetLoadAddress(Target &target, addr_t value,
102061da546Spatrick bool value_is_offset) override {
103061da546Spatrick assert(!value_is_offset);
104061da546Spatrick assert(value == m_base);
105061da546Spatrick
106061da546Spatrick // Create sections if they haven't been created already.
107061da546Spatrick GetModule()->GetSectionList();
108061da546Spatrick assert(m_sections_up->GetNumSections(0) == 1);
109061da546Spatrick
110061da546Spatrick target.GetSectionLoadList().SetSectionLoadAddress(
111061da546Spatrick m_sections_up->GetSectionAtIndex(0), m_base);
112061da546Spatrick return true;
113061da546Spatrick }
114061da546Spatrick
Dump(Stream * s)115061da546Spatrick void Dump(Stream *s) override {
116061da546Spatrick s->Format("Placeholder object file for {0} loaded at [{1:x}-{2:x})\n",
117061da546Spatrick GetFileSpec(), m_base, m_base + m_size);
118061da546Spatrick }
119061da546Spatrick
GetBaseImageAddress() const120061da546Spatrick lldb::addr_t GetBaseImageAddress() const { return m_base; }
121061da546Spatrick private:
122061da546Spatrick ArchSpec m_arch;
123061da546Spatrick UUID m_uuid;
124061da546Spatrick lldb::addr_t m_base;
125061da546Spatrick lldb::addr_t m_size;
126061da546Spatrick };
127dda28197Spatrick
128dda28197Spatrick /// Duplicate the HashElfTextSection() from the breakpad sources.
129dda28197Spatrick ///
130dda28197Spatrick /// Breakpad, a Google crash log reporting tool suite, creates minidump files
131dda28197Spatrick /// for many different architectures. When using Breakpad to create ELF
132dda28197Spatrick /// minidumps, it will check for a GNU build ID when creating a minidump file
133dda28197Spatrick /// and if one doesn't exist in the file, it will say the UUID of the file is a
134dda28197Spatrick /// checksum of up to the first 4096 bytes of the .text section. Facebook also
135dda28197Spatrick /// uses breakpad and modified this hash to avoid collisions so we can
136dda28197Spatrick /// calculate and check for this as well.
137dda28197Spatrick ///
138dda28197Spatrick /// The breakpad code might end up hashing up to 15 bytes that immediately
139dda28197Spatrick /// follow the .text section in the file, so this code must do exactly what it
140dda28197Spatrick /// does so we can get an exact match for the UUID.
141dda28197Spatrick ///
142dda28197Spatrick /// \param[in] module_sp The module to grab the .text section from.
143dda28197Spatrick ///
144be691f3bSpatrick /// \param[in,out] breakpad_uuid A vector that will receive the calculated
145dda28197Spatrick /// breakpad .text hash.
146dda28197Spatrick ///
147be691f3bSpatrick /// \param[in,out] facebook_uuid A vector that will receive the calculated
148dda28197Spatrick /// facebook .text hash.
149dda28197Spatrick ///
HashElfTextSection(ModuleSP module_sp,std::vector<uint8_t> & breakpad_uuid,std::vector<uint8_t> & facebook_uuid)150dda28197Spatrick void HashElfTextSection(ModuleSP module_sp, std::vector<uint8_t> &breakpad_uuid,
151dda28197Spatrick std::vector<uint8_t> &facebook_uuid) {
152dda28197Spatrick SectionList *sect_list = module_sp->GetSectionList();
153dda28197Spatrick if (sect_list == nullptr)
154dda28197Spatrick return;
155dda28197Spatrick SectionSP sect_sp = sect_list->FindSectionByName(ConstString(".text"));
156dda28197Spatrick if (!sect_sp)
157dda28197Spatrick return;
158dda28197Spatrick constexpr size_t kMDGUIDSize = 16;
159dda28197Spatrick constexpr size_t kBreakpadPageSize = 4096;
160dda28197Spatrick // The breakpad code has a bug where it might access beyond the end of a
161dda28197Spatrick // .text section by up to 15 bytes, so we must ensure we round up to the
162dda28197Spatrick // next kMDGUIDSize byte boundary.
163dda28197Spatrick DataExtractor data;
164dda28197Spatrick const size_t text_size = sect_sp->GetFileSize();
165dda28197Spatrick const size_t read_size = std::min<size_t>(
166dda28197Spatrick llvm::alignTo(text_size, kMDGUIDSize), kBreakpadPageSize);
167dda28197Spatrick sect_sp->GetObjectFile()->GetData(sect_sp->GetFileOffset(), read_size, data);
168dda28197Spatrick
169dda28197Spatrick breakpad_uuid.assign(kMDGUIDSize, 0);
170dda28197Spatrick facebook_uuid.assign(kMDGUIDSize, 0);
171dda28197Spatrick
172dda28197Spatrick // The only difference between the breakpad hash and the facebook hash is the
173dda28197Spatrick // hashing of the text section size into the hash prior to hashing the .text
174dda28197Spatrick // contents.
175dda28197Spatrick for (size_t i = 0; i < kMDGUIDSize; i++)
176dda28197Spatrick facebook_uuid[i] ^= text_size % 255;
177dda28197Spatrick
178dda28197Spatrick // This code carefully duplicates how the hash was created in Breakpad
179dda28197Spatrick // sources, including the error where it might has an extra 15 bytes past the
180dda28197Spatrick // end of the .text section if the .text section is less than a page size in
181dda28197Spatrick // length.
182dda28197Spatrick const uint8_t *ptr = data.GetDataStart();
183dda28197Spatrick const uint8_t *ptr_end = data.GetDataEnd();
184dda28197Spatrick while (ptr < ptr_end) {
185dda28197Spatrick for (unsigned i = 0; i < kMDGUIDSize; i++) {
186dda28197Spatrick breakpad_uuid[i] ^= ptr[i];
187dda28197Spatrick facebook_uuid[i] ^= ptr[i];
188dda28197Spatrick }
189dda28197Spatrick ptr += kMDGUIDSize;
190dda28197Spatrick }
191dda28197Spatrick }
192dda28197Spatrick
193061da546Spatrick } // namespace
194061da546Spatrick
GetPluginDescriptionStatic()195*f6aab3d8Srobert llvm::StringRef ProcessMinidump::GetPluginDescriptionStatic() {
196061da546Spatrick return "Minidump plug-in.";
197061da546Spatrick }
198061da546Spatrick
CreateInstance(lldb::TargetSP target_sp,lldb::ListenerSP listener_sp,const FileSpec * crash_file,bool can_connect)199061da546Spatrick lldb::ProcessSP ProcessMinidump::CreateInstance(lldb::TargetSP target_sp,
200061da546Spatrick lldb::ListenerSP listener_sp,
201be691f3bSpatrick const FileSpec *crash_file,
202be691f3bSpatrick bool can_connect) {
203be691f3bSpatrick if (!crash_file || can_connect)
204061da546Spatrick return nullptr;
205061da546Spatrick
206061da546Spatrick lldb::ProcessSP process_sp;
207061da546Spatrick // Read enough data for the Minidump header
208061da546Spatrick constexpr size_t header_size = sizeof(Header);
209061da546Spatrick auto DataPtr = FileSystem::Instance().CreateDataBuffer(crash_file->GetPath(),
210061da546Spatrick header_size, 0);
211061da546Spatrick if (!DataPtr)
212061da546Spatrick return nullptr;
213061da546Spatrick
214061da546Spatrick lldbassert(DataPtr->GetByteSize() == header_size);
215061da546Spatrick if (identify_magic(toStringRef(DataPtr->GetData())) != llvm::file_magic::minidump)
216061da546Spatrick return nullptr;
217061da546Spatrick
218061da546Spatrick auto AllData =
219061da546Spatrick FileSystem::Instance().CreateDataBuffer(crash_file->GetPath(), -1, 0);
220061da546Spatrick if (!AllData)
221061da546Spatrick return nullptr;
222061da546Spatrick
223061da546Spatrick return std::make_shared<ProcessMinidump>(target_sp, listener_sp, *crash_file,
224061da546Spatrick std::move(AllData));
225061da546Spatrick }
226061da546Spatrick
CanDebug(lldb::TargetSP target_sp,bool plugin_specified_by_name)227061da546Spatrick bool ProcessMinidump::CanDebug(lldb::TargetSP target_sp,
228061da546Spatrick bool plugin_specified_by_name) {
229061da546Spatrick return true;
230061da546Spatrick }
231061da546Spatrick
ProcessMinidump(lldb::TargetSP target_sp,lldb::ListenerSP listener_sp,const FileSpec & core_file,DataBufferSP core_data)232061da546Spatrick ProcessMinidump::ProcessMinidump(lldb::TargetSP target_sp,
233061da546Spatrick lldb::ListenerSP listener_sp,
234061da546Spatrick const FileSpec &core_file,
235061da546Spatrick DataBufferSP core_data)
236be691f3bSpatrick : PostMortemProcess(target_sp, listener_sp), m_core_file(core_file),
237*f6aab3d8Srobert m_core_data(std::move(core_data)), m_active_exception(nullptr),
238*f6aab3d8Srobert m_is_wow64(false) {}
239061da546Spatrick
~ProcessMinidump()240061da546Spatrick ProcessMinidump::~ProcessMinidump() {
241061da546Spatrick Clear();
242061da546Spatrick // We need to call finalize on the process before destroying ourselves to
243061da546Spatrick // make sure all of the broadcaster cleanup goes as planned. If we destruct
244061da546Spatrick // this class, then Process::~Process() might have problems trying to fully
245061da546Spatrick // destroy the broadcaster.
246061da546Spatrick Finalize();
247061da546Spatrick }
248061da546Spatrick
Initialize()249061da546Spatrick void ProcessMinidump::Initialize() {
250061da546Spatrick static llvm::once_flag g_once_flag;
251061da546Spatrick
252061da546Spatrick llvm::call_once(g_once_flag, []() {
253061da546Spatrick PluginManager::RegisterPlugin(GetPluginNameStatic(),
254061da546Spatrick GetPluginDescriptionStatic(),
255061da546Spatrick ProcessMinidump::CreateInstance);
256061da546Spatrick });
257061da546Spatrick }
258061da546Spatrick
Terminate()259061da546Spatrick void ProcessMinidump::Terminate() {
260061da546Spatrick PluginManager::UnregisterPlugin(ProcessMinidump::CreateInstance);
261061da546Spatrick }
262061da546Spatrick
DoLoadCore()263061da546Spatrick Status ProcessMinidump::DoLoadCore() {
264061da546Spatrick auto expected_parser = MinidumpParser::Create(m_core_data);
265061da546Spatrick if (!expected_parser)
266061da546Spatrick return Status(expected_parser.takeError());
267061da546Spatrick m_minidump_parser = std::move(*expected_parser);
268061da546Spatrick
269061da546Spatrick Status error;
270061da546Spatrick
271061da546Spatrick // Do we support the minidump's architecture?
272061da546Spatrick ArchSpec arch = GetArchitecture();
273061da546Spatrick switch (arch.GetMachine()) {
274061da546Spatrick case llvm::Triple::x86:
275061da546Spatrick case llvm::Triple::x86_64:
276061da546Spatrick case llvm::Triple::arm:
277061da546Spatrick case llvm::Triple::aarch64:
278061da546Spatrick // Any supported architectures must be listed here and also supported in
279061da546Spatrick // ThreadMinidump::CreateRegisterContextForFrame().
280061da546Spatrick break;
281061da546Spatrick default:
282061da546Spatrick error.SetErrorStringWithFormat("unsupported minidump architecture: %s",
283061da546Spatrick arch.GetArchitectureName());
284061da546Spatrick return error;
285061da546Spatrick }
286061da546Spatrick GetTarget().SetArchitecture(arch, true /*set_platform*/);
287061da546Spatrick
288061da546Spatrick m_thread_list = m_minidump_parser->GetThreads();
289061da546Spatrick m_active_exception = m_minidump_parser->GetExceptionStream();
290061da546Spatrick
291061da546Spatrick SetUnixSignals(UnixSignals::Create(GetArchitecture()));
292061da546Spatrick
293061da546Spatrick ReadModuleList();
294*f6aab3d8Srobert if (ModuleSP module = GetTarget().GetExecutableModule())
295*f6aab3d8Srobert GetTarget().MergeArchitecture(module->GetArchitecture());
296*f6aab3d8Srobert std::optional<lldb::pid_t> pid = m_minidump_parser->GetPid();
297061da546Spatrick if (!pid) {
298*f6aab3d8Srobert Debugger::ReportWarning("unable to retrieve process ID from minidump file, "
299*f6aab3d8Srobert "setting process ID to 1",
300*f6aab3d8Srobert GetTarget().GetDebugger().GetID());
301dda28197Spatrick pid = 1;
302061da546Spatrick }
303*f6aab3d8Srobert SetID(*pid);
304061da546Spatrick
305061da546Spatrick return error;
306061da546Spatrick }
307061da546Spatrick
DoDestroy()308061da546Spatrick Status ProcessMinidump::DoDestroy() { return Status(); }
309061da546Spatrick
RefreshStateAfterStop()310061da546Spatrick void ProcessMinidump::RefreshStateAfterStop() {
311061da546Spatrick
312061da546Spatrick if (!m_active_exception)
313061da546Spatrick return;
314061da546Spatrick
315061da546Spatrick constexpr uint32_t BreakpadDumpRequested = 0xFFFFFFFF;
316061da546Spatrick if (m_active_exception->ExceptionRecord.ExceptionCode ==
317061da546Spatrick BreakpadDumpRequested) {
318061da546Spatrick // This "ExceptionCode" value is a sentinel that is sometimes used
319061da546Spatrick // when generating a dump for a process that hasn't crashed.
320061da546Spatrick
321061da546Spatrick // TODO: The definition and use of this "dump requested" constant
322061da546Spatrick // in Breakpad are actually Linux-specific, and for similar use
323dda28197Spatrick // cases on Mac/Windows it defines different constants, referring
324061da546Spatrick // to them as "simulated" exceptions; consider moving this check
325061da546Spatrick // down to the OS-specific paths and checking each OS for its own
326061da546Spatrick // constant.
327061da546Spatrick return;
328061da546Spatrick }
329061da546Spatrick
330061da546Spatrick lldb::StopInfoSP stop_info;
331061da546Spatrick lldb::ThreadSP stop_thread;
332061da546Spatrick
333061da546Spatrick Process::m_thread_list.SetSelectedThreadByID(m_active_exception->ThreadId);
334061da546Spatrick stop_thread = Process::m_thread_list.GetSelectedThread();
335061da546Spatrick ArchSpec arch = GetArchitecture();
336061da546Spatrick
337061da546Spatrick if (arch.GetTriple().getOS() == llvm::Triple::Linux) {
338061da546Spatrick uint32_t signo = m_active_exception->ExceptionRecord.ExceptionCode;
339061da546Spatrick
340061da546Spatrick if (signo == 0) {
341061da546Spatrick // No stop.
342061da546Spatrick return;
343061da546Spatrick }
344061da546Spatrick
345061da546Spatrick stop_info = StopInfo::CreateStopReasonWithSignal(
346061da546Spatrick *stop_thread, signo);
347061da546Spatrick } else if (arch.GetTriple().getVendor() == llvm::Triple::Apple) {
348061da546Spatrick stop_info = StopInfoMachException::CreateStopReasonWithMachException(
349061da546Spatrick *stop_thread, m_active_exception->ExceptionRecord.ExceptionCode, 2,
350061da546Spatrick m_active_exception->ExceptionRecord.ExceptionFlags,
351061da546Spatrick m_active_exception->ExceptionRecord.ExceptionAddress, 0);
352061da546Spatrick } else {
353061da546Spatrick std::string desc;
354061da546Spatrick llvm::raw_string_ostream desc_stream(desc);
355061da546Spatrick desc_stream << "Exception "
356061da546Spatrick << llvm::format_hex(
357061da546Spatrick m_active_exception->ExceptionRecord.ExceptionCode, 8)
358061da546Spatrick << " encountered at address "
359061da546Spatrick << llvm::format_hex(
360061da546Spatrick m_active_exception->ExceptionRecord.ExceptionAddress, 8);
361061da546Spatrick stop_info = StopInfo::CreateStopReasonWithException(
362061da546Spatrick *stop_thread, desc_stream.str().c_str());
363061da546Spatrick }
364061da546Spatrick
365061da546Spatrick stop_thread->SetStopInfo(stop_info);
366061da546Spatrick }
367061da546Spatrick
IsAlive()368061da546Spatrick bool ProcessMinidump::IsAlive() { return true; }
369061da546Spatrick
WarnBeforeDetach() const370061da546Spatrick bool ProcessMinidump::WarnBeforeDetach() const { return false; }
371061da546Spatrick
ReadMemory(lldb::addr_t addr,void * buf,size_t size,Status & error)372061da546Spatrick size_t ProcessMinidump::ReadMemory(lldb::addr_t addr, void *buf, size_t size,
373061da546Spatrick Status &error) {
374061da546Spatrick // Don't allow the caching that lldb_private::Process::ReadMemory does since
375061da546Spatrick // we have it all cached in our dump file anyway.
376061da546Spatrick return DoReadMemory(addr, buf, size, error);
377061da546Spatrick }
378061da546Spatrick
DoReadMemory(lldb::addr_t addr,void * buf,size_t size,Status & error)379061da546Spatrick size_t ProcessMinidump::DoReadMemory(lldb::addr_t addr, void *buf, size_t size,
380061da546Spatrick Status &error) {
381061da546Spatrick
382061da546Spatrick llvm::ArrayRef<uint8_t> mem = m_minidump_parser->GetMemory(addr, size);
383061da546Spatrick if (mem.empty()) {
384061da546Spatrick error.SetErrorString("could not parse memory info");
385061da546Spatrick return 0;
386061da546Spatrick }
387061da546Spatrick
388061da546Spatrick std::memcpy(buf, mem.data(), mem.size());
389061da546Spatrick return mem.size();
390061da546Spatrick }
391061da546Spatrick
GetArchitecture()392061da546Spatrick ArchSpec ProcessMinidump::GetArchitecture() {
393061da546Spatrick if (!m_is_wow64) {
394061da546Spatrick return m_minidump_parser->GetArchitecture();
395061da546Spatrick }
396061da546Spatrick
397061da546Spatrick llvm::Triple triple;
398061da546Spatrick triple.setVendor(llvm::Triple::VendorType::UnknownVendor);
399061da546Spatrick triple.setArch(llvm::Triple::ArchType::x86);
400061da546Spatrick triple.setOS(llvm::Triple::OSType::Win32);
401061da546Spatrick return ArchSpec(triple);
402061da546Spatrick }
403061da546Spatrick
BuildMemoryRegions()404061da546Spatrick void ProcessMinidump::BuildMemoryRegions() {
405061da546Spatrick if (m_memory_regions)
406061da546Spatrick return;
407061da546Spatrick m_memory_regions.emplace();
408061da546Spatrick bool is_complete;
409061da546Spatrick std::tie(*m_memory_regions, is_complete) =
410061da546Spatrick m_minidump_parser->BuildMemoryRegions();
411061da546Spatrick
412061da546Spatrick if (is_complete)
413061da546Spatrick return;
414061da546Spatrick
415061da546Spatrick MemoryRegionInfos to_add;
416061da546Spatrick ModuleList &modules = GetTarget().GetImages();
417061da546Spatrick SectionLoadList &load_list = GetTarget().GetSectionLoadList();
418061da546Spatrick modules.ForEach([&](const ModuleSP &module_sp) {
419061da546Spatrick SectionList *sections = module_sp->GetSectionList();
420061da546Spatrick for (size_t i = 0; i < sections->GetSize(); ++i) {
421061da546Spatrick SectionSP section_sp = sections->GetSectionAtIndex(i);
422061da546Spatrick addr_t load_addr = load_list.GetSectionLoadAddress(section_sp);
423061da546Spatrick if (load_addr == LLDB_INVALID_ADDRESS)
424061da546Spatrick continue;
425061da546Spatrick MemoryRegionInfo::RangeType section_range(load_addr,
426061da546Spatrick section_sp->GetByteSize());
427061da546Spatrick MemoryRegionInfo region =
428be691f3bSpatrick MinidumpParser::GetMemoryRegionInfo(*m_memory_regions, load_addr);
429061da546Spatrick if (region.GetMapped() != MemoryRegionInfo::eYes &&
430061da546Spatrick region.GetRange().GetRangeBase() <= section_range.GetRangeBase() &&
431061da546Spatrick section_range.GetRangeEnd() <= region.GetRange().GetRangeEnd()) {
432061da546Spatrick to_add.emplace_back();
433061da546Spatrick to_add.back().GetRange() = section_range;
434061da546Spatrick to_add.back().SetLLDBPermissions(section_sp->GetPermissions());
435061da546Spatrick to_add.back().SetMapped(MemoryRegionInfo::eYes);
436061da546Spatrick to_add.back().SetName(module_sp->GetFileSpec().GetPath().c_str());
437061da546Spatrick }
438061da546Spatrick }
439061da546Spatrick return true;
440061da546Spatrick });
441061da546Spatrick m_memory_regions->insert(m_memory_regions->end(), to_add.begin(),
442061da546Spatrick to_add.end());
443061da546Spatrick llvm::sort(*m_memory_regions);
444061da546Spatrick }
445061da546Spatrick
DoGetMemoryRegionInfo(lldb::addr_t load_addr,MemoryRegionInfo & region)446*f6aab3d8Srobert Status ProcessMinidump::DoGetMemoryRegionInfo(lldb::addr_t load_addr,
447061da546Spatrick MemoryRegionInfo ®ion) {
448061da546Spatrick BuildMemoryRegions();
449be691f3bSpatrick region = MinidumpParser::GetMemoryRegionInfo(*m_memory_regions, load_addr);
450061da546Spatrick return Status();
451061da546Spatrick }
452061da546Spatrick
GetMemoryRegions(MemoryRegionInfos & region_list)453061da546Spatrick Status ProcessMinidump::GetMemoryRegions(MemoryRegionInfos ®ion_list) {
454061da546Spatrick BuildMemoryRegions();
455061da546Spatrick region_list = *m_memory_regions;
456061da546Spatrick return Status();
457061da546Spatrick }
458061da546Spatrick
Clear()459061da546Spatrick void ProcessMinidump::Clear() { Process::m_thread_list.Clear(); }
460061da546Spatrick
DoUpdateThreadList(ThreadList & old_thread_list,ThreadList & new_thread_list)461be691f3bSpatrick bool ProcessMinidump::DoUpdateThreadList(ThreadList &old_thread_list,
462061da546Spatrick ThreadList &new_thread_list) {
463061da546Spatrick for (const minidump::Thread &thread : m_thread_list) {
464061da546Spatrick LocationDescriptor context_location = thread.Context;
465061da546Spatrick
466061da546Spatrick // If the minidump contains an exception context, use it
467061da546Spatrick if (m_active_exception != nullptr &&
468061da546Spatrick m_active_exception->ThreadId == thread.ThreadId) {
469061da546Spatrick context_location = m_active_exception->ThreadContext;
470061da546Spatrick }
471061da546Spatrick
472061da546Spatrick llvm::ArrayRef<uint8_t> context;
473061da546Spatrick if (!m_is_wow64)
474061da546Spatrick context = m_minidump_parser->GetThreadContext(context_location);
475061da546Spatrick else
476061da546Spatrick context = m_minidump_parser->GetThreadContextWow64(thread);
477061da546Spatrick
478061da546Spatrick lldb::ThreadSP thread_sp(new ThreadMinidump(*this, thread, context));
479061da546Spatrick new_thread_list.AddThread(thread_sp);
480061da546Spatrick }
481061da546Spatrick return new_thread_list.GetSize(false) > 0;
482061da546Spatrick }
483061da546Spatrick
GetOrCreateModule(UUID minidump_uuid,llvm::StringRef name,ModuleSpec module_spec)484dda28197Spatrick ModuleSP ProcessMinidump::GetOrCreateModule(UUID minidump_uuid,
485dda28197Spatrick llvm::StringRef name,
486dda28197Spatrick ModuleSpec module_spec) {
487*f6aab3d8Srobert Log *log = GetLog(LLDBLog::DynamicLoader);
488dda28197Spatrick Status error;
489dda28197Spatrick
490dda28197Spatrick ModuleSP module_sp =
491dda28197Spatrick GetTarget().GetOrCreateModule(module_spec, true /* notify */, &error);
492dda28197Spatrick if (!module_sp)
493dda28197Spatrick return module_sp;
494dda28197Spatrick // We consider the module to be a match if the minidump UUID is a
495dda28197Spatrick // prefix of the actual UUID, or if either of the UUIDs are empty.
496dda28197Spatrick const auto dmp_bytes = minidump_uuid.GetBytes();
497dda28197Spatrick const auto mod_bytes = module_sp->GetUUID().GetBytes();
498dda28197Spatrick const bool match = dmp_bytes.empty() || mod_bytes.empty() ||
499dda28197Spatrick mod_bytes.take_front(dmp_bytes.size()) == dmp_bytes;
500dda28197Spatrick if (match) {
501dda28197Spatrick LLDB_LOG(log, "Partial uuid match for {0}.", name);
502dda28197Spatrick return module_sp;
503dda28197Spatrick }
504dda28197Spatrick
505dda28197Spatrick // Breakpad generates minindump files, and if there is no GNU build
506dda28197Spatrick // ID in the binary, it will calculate a UUID by hashing first 4096
507dda28197Spatrick // bytes of the .text section and using that as the UUID for a module
508dda28197Spatrick // in the minidump. Facebook uses a modified breakpad client that
509dda28197Spatrick // uses a slightly modified this hash to avoid collisions. Check for
510dda28197Spatrick // UUIDs from the minindump that match these cases and accept the
511dda28197Spatrick // module we find if they do match.
512dda28197Spatrick std::vector<uint8_t> breakpad_uuid;
513dda28197Spatrick std::vector<uint8_t> facebook_uuid;
514dda28197Spatrick HashElfTextSection(module_sp, breakpad_uuid, facebook_uuid);
515dda28197Spatrick if (dmp_bytes == llvm::ArrayRef<uint8_t>(breakpad_uuid)) {
516dda28197Spatrick LLDB_LOG(log, "Breakpad .text hash match for {0}.", name);
517dda28197Spatrick return module_sp;
518dda28197Spatrick }
519dda28197Spatrick if (dmp_bytes == llvm::ArrayRef<uint8_t>(facebook_uuid)) {
520dda28197Spatrick LLDB_LOG(log, "Facebook .text hash match for {0}.", name);
521dda28197Spatrick return module_sp;
522dda28197Spatrick }
523dda28197Spatrick // The UUID wasn't a partial match and didn't match the .text hash
524dda28197Spatrick // so remove the module from the target, we will need to create a
525dda28197Spatrick // placeholder object file.
526dda28197Spatrick GetTarget().GetImages().Remove(module_sp);
527dda28197Spatrick module_sp.reset();
528dda28197Spatrick return module_sp;
529dda28197Spatrick }
530dda28197Spatrick
ReadModuleList()531061da546Spatrick void ProcessMinidump::ReadModuleList() {
532061da546Spatrick std::vector<const minidump::Module *> filtered_modules =
533061da546Spatrick m_minidump_parser->GetFilteredModuleList();
534061da546Spatrick
535*f6aab3d8Srobert Log *log = GetLog(LLDBLog::DynamicLoader);
536061da546Spatrick
537061da546Spatrick for (auto module : filtered_modules) {
538061da546Spatrick std::string name = cantFail(m_minidump_parser->GetMinidumpFile().getString(
539061da546Spatrick module->ModuleNameRVA));
540061da546Spatrick const uint64_t load_addr = module->BaseOfImage;
541061da546Spatrick const uint64_t load_size = module->SizeOfImage;
542061da546Spatrick LLDB_LOG(log, "found module: name: {0} {1:x10}-{2:x10} size: {3}", name,
543061da546Spatrick load_addr, load_addr + load_size, load_size);
544061da546Spatrick
545061da546Spatrick // check if the process is wow64 - a 32 bit windows process running on a
546061da546Spatrick // 64 bit windows
547be691f3bSpatrick if (llvm::StringRef(name).endswith_insensitive("wow64.dll")) {
548061da546Spatrick m_is_wow64 = true;
549061da546Spatrick }
550061da546Spatrick
551061da546Spatrick const auto uuid = m_minidump_parser->GetModuleUUID(module);
552061da546Spatrick auto file_spec = FileSpec(name, GetArchitecture().GetTriple());
553061da546Spatrick ModuleSpec module_spec(file_spec, uuid);
554061da546Spatrick module_spec.GetArchitecture() = GetArchitecture();
555061da546Spatrick Status error;
556061da546Spatrick // Try and find a module with a full UUID that matches. This function will
557061da546Spatrick // add the module to the target if it finds one.
558061da546Spatrick lldb::ModuleSP module_sp = GetTarget().GetOrCreateModule(module_spec,
559061da546Spatrick true /* notify */, &error);
560061da546Spatrick if (module_sp) {
561dda28197Spatrick LLDB_LOG(log, "Full uuid match for {0}.", name);
562dda28197Spatrick } else {
563dda28197Spatrick // We couldn't find a module with an exactly-matching UUID. Sometimes
564dda28197Spatrick // a minidump UUID is only a partial match or is a hash. So try again
565dda28197Spatrick // without specifying the UUID, then again without specifying the
566dda28197Spatrick // directory if that fails. This will allow us to find modules with
567dda28197Spatrick // partial matches or hash UUIDs in user-provided sysroots or search
568dda28197Spatrick // directories (target.exec-search-paths).
569dda28197Spatrick ModuleSpec partial_module_spec = module_spec;
570dda28197Spatrick partial_module_spec.GetUUID().Clear();
571dda28197Spatrick module_sp = GetOrCreateModule(uuid, name, partial_module_spec);
572dda28197Spatrick if (!module_sp) {
573*f6aab3d8Srobert partial_module_spec.GetFileSpec().ClearDirectory();
574dda28197Spatrick module_sp = GetOrCreateModule(uuid, name, partial_module_spec);
575061da546Spatrick }
576061da546Spatrick }
577061da546Spatrick if (module_sp) {
578061da546Spatrick // Watch out for place holder modules that have different paths, but the
579061da546Spatrick // same UUID. If the base address is different, create a new module. If
580061da546Spatrick // we don't then we will end up setting the load address of a different
581061da546Spatrick // PlaceholderObjectFile and an assertion will fire.
582061da546Spatrick auto *objfile = module_sp->GetObjectFile();
583*f6aab3d8Srobert if (objfile &&
584*f6aab3d8Srobert objfile->GetPluginName() ==
585*f6aab3d8Srobert PlaceholderObjectFile::GetStaticPluginName().GetStringRef()) {
586061da546Spatrick if (((PlaceholderObjectFile *)objfile)->GetBaseImageAddress() !=
587061da546Spatrick load_addr)
588061da546Spatrick module_sp.reset();
589061da546Spatrick }
590061da546Spatrick }
591061da546Spatrick if (!module_sp) {
592061da546Spatrick // We failed to locate a matching local object file. Fortunately, the
593061da546Spatrick // minidump format encodes enough information about each module's memory
594061da546Spatrick // range to allow us to create placeholder modules.
595061da546Spatrick //
596061da546Spatrick // This enables most LLDB functionality involving address-to-module
597061da546Spatrick // translations (ex. identifing the module for a stack frame PC) and
598061da546Spatrick // modules/sections commands (ex. target modules list, ...)
599061da546Spatrick LLDB_LOG(log,
600061da546Spatrick "Unable to locate the matching object file, creating a "
601061da546Spatrick "placeholder module for: {0}",
602061da546Spatrick name);
603061da546Spatrick
604061da546Spatrick module_sp = Module::CreateModuleFromObjectFile<PlaceholderObjectFile>(
605061da546Spatrick module_spec, load_addr, load_size);
606061da546Spatrick GetTarget().GetImages().Append(module_sp, true /* notify */);
607061da546Spatrick }
608061da546Spatrick
609061da546Spatrick bool load_addr_changed = false;
610061da546Spatrick module_sp->SetLoadAddress(GetTarget(), load_addr, false,
611061da546Spatrick load_addr_changed);
612061da546Spatrick }
613061da546Spatrick }
614061da546Spatrick
GetProcessInfo(ProcessInstanceInfo & info)615061da546Spatrick bool ProcessMinidump::GetProcessInfo(ProcessInstanceInfo &info) {
616061da546Spatrick info.Clear();
617061da546Spatrick info.SetProcessID(GetID());
618061da546Spatrick info.SetArchitecture(GetArchitecture());
619061da546Spatrick lldb::ModuleSP module_sp = GetTarget().GetExecutableModule();
620061da546Spatrick if (module_sp) {
621061da546Spatrick const bool add_exe_file_as_first_arg = false;
622061da546Spatrick info.SetExecutableFile(GetTarget().GetExecutableModule()->GetFileSpec(),
623061da546Spatrick add_exe_file_as_first_arg);
624061da546Spatrick }
625061da546Spatrick return true;
626061da546Spatrick }
627061da546Spatrick
628061da546Spatrick // For minidumps there's no runtime generated code so we don't need JITLoader(s)
629061da546Spatrick // Avoiding them will also speed up minidump loading since JITLoaders normally
630061da546Spatrick // try to set up symbolic breakpoints, which in turn may force loading more
631061da546Spatrick // debug information than needed.
GetJITLoaders()632061da546Spatrick JITLoaderList &ProcessMinidump::GetJITLoaders() {
633061da546Spatrick if (!m_jit_loaders_up) {
634061da546Spatrick m_jit_loaders_up = std::make_unique<JITLoaderList>();
635061da546Spatrick }
636061da546Spatrick return *m_jit_loaders_up;
637061da546Spatrick }
638061da546Spatrick
639061da546Spatrick #define INIT_BOOL(VAR, LONG, SHORT, DESC) \
640061da546Spatrick VAR(LLDB_OPT_SET_1, false, LONG, SHORT, DESC, false, true)
641061da546Spatrick #define APPEND_OPT(VAR) \
642061da546Spatrick m_option_group.Append(&VAR, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1)
643061da546Spatrick
644061da546Spatrick class CommandObjectProcessMinidumpDump : public CommandObjectParsed {
645061da546Spatrick private:
646061da546Spatrick OptionGroupOptions m_option_group;
647061da546Spatrick OptionGroupBoolean m_dump_all;
648061da546Spatrick OptionGroupBoolean m_dump_directory;
649061da546Spatrick OptionGroupBoolean m_dump_linux_cpuinfo;
650061da546Spatrick OptionGroupBoolean m_dump_linux_proc_status;
651061da546Spatrick OptionGroupBoolean m_dump_linux_lsb_release;
652061da546Spatrick OptionGroupBoolean m_dump_linux_cmdline;
653061da546Spatrick OptionGroupBoolean m_dump_linux_environ;
654061da546Spatrick OptionGroupBoolean m_dump_linux_auxv;
655061da546Spatrick OptionGroupBoolean m_dump_linux_maps;
656061da546Spatrick OptionGroupBoolean m_dump_linux_proc_stat;
657061da546Spatrick OptionGroupBoolean m_dump_linux_proc_uptime;
658061da546Spatrick OptionGroupBoolean m_dump_linux_proc_fd;
659061da546Spatrick OptionGroupBoolean m_dump_linux_all;
660061da546Spatrick OptionGroupBoolean m_fb_app_data;
661061da546Spatrick OptionGroupBoolean m_fb_build_id;
662061da546Spatrick OptionGroupBoolean m_fb_version;
663061da546Spatrick OptionGroupBoolean m_fb_java_stack;
664061da546Spatrick OptionGroupBoolean m_fb_dalvik;
665061da546Spatrick OptionGroupBoolean m_fb_unwind;
666061da546Spatrick OptionGroupBoolean m_fb_error_log;
667061da546Spatrick OptionGroupBoolean m_fb_app_state;
668061da546Spatrick OptionGroupBoolean m_fb_abort;
669061da546Spatrick OptionGroupBoolean m_fb_thread;
670061da546Spatrick OptionGroupBoolean m_fb_logcat;
671061da546Spatrick OptionGroupBoolean m_fb_all;
672061da546Spatrick
SetDefaultOptionsIfNoneAreSet()673061da546Spatrick void SetDefaultOptionsIfNoneAreSet() {
674061da546Spatrick if (m_dump_all.GetOptionValue().GetCurrentValue() ||
675061da546Spatrick m_dump_linux_all.GetOptionValue().GetCurrentValue() ||
676061da546Spatrick m_fb_all.GetOptionValue().GetCurrentValue() ||
677061da546Spatrick m_dump_directory.GetOptionValue().GetCurrentValue() ||
678061da546Spatrick m_dump_linux_cpuinfo.GetOptionValue().GetCurrentValue() ||
679061da546Spatrick m_dump_linux_proc_status.GetOptionValue().GetCurrentValue() ||
680061da546Spatrick m_dump_linux_lsb_release.GetOptionValue().GetCurrentValue() ||
681061da546Spatrick m_dump_linux_cmdline.GetOptionValue().GetCurrentValue() ||
682061da546Spatrick m_dump_linux_environ.GetOptionValue().GetCurrentValue() ||
683061da546Spatrick m_dump_linux_auxv.GetOptionValue().GetCurrentValue() ||
684061da546Spatrick m_dump_linux_maps.GetOptionValue().GetCurrentValue() ||
685061da546Spatrick m_dump_linux_proc_stat.GetOptionValue().GetCurrentValue() ||
686061da546Spatrick m_dump_linux_proc_uptime.GetOptionValue().GetCurrentValue() ||
687061da546Spatrick m_dump_linux_proc_fd.GetOptionValue().GetCurrentValue() ||
688061da546Spatrick m_fb_app_data.GetOptionValue().GetCurrentValue() ||
689061da546Spatrick m_fb_build_id.GetOptionValue().GetCurrentValue() ||
690061da546Spatrick m_fb_version.GetOptionValue().GetCurrentValue() ||
691061da546Spatrick m_fb_java_stack.GetOptionValue().GetCurrentValue() ||
692061da546Spatrick m_fb_dalvik.GetOptionValue().GetCurrentValue() ||
693061da546Spatrick m_fb_unwind.GetOptionValue().GetCurrentValue() ||
694061da546Spatrick m_fb_error_log.GetOptionValue().GetCurrentValue() ||
695061da546Spatrick m_fb_app_state.GetOptionValue().GetCurrentValue() ||
696061da546Spatrick m_fb_abort.GetOptionValue().GetCurrentValue() ||
697061da546Spatrick m_fb_thread.GetOptionValue().GetCurrentValue() ||
698061da546Spatrick m_fb_logcat.GetOptionValue().GetCurrentValue())
699061da546Spatrick return;
700061da546Spatrick // If no options were set, then dump everything
701061da546Spatrick m_dump_all.GetOptionValue().SetCurrentValue(true);
702061da546Spatrick }
DumpAll() const703061da546Spatrick bool DumpAll() const {
704061da546Spatrick return m_dump_all.GetOptionValue().GetCurrentValue();
705061da546Spatrick }
DumpDirectory() const706061da546Spatrick bool DumpDirectory() const {
707061da546Spatrick return DumpAll() ||
708061da546Spatrick m_dump_directory.GetOptionValue().GetCurrentValue();
709061da546Spatrick }
DumpLinux() const710061da546Spatrick bool DumpLinux() const {
711061da546Spatrick return DumpAll() || m_dump_linux_all.GetOptionValue().GetCurrentValue();
712061da546Spatrick }
DumpLinuxCPUInfo() const713061da546Spatrick bool DumpLinuxCPUInfo() const {
714061da546Spatrick return DumpLinux() ||
715061da546Spatrick m_dump_linux_cpuinfo.GetOptionValue().GetCurrentValue();
716061da546Spatrick }
DumpLinuxProcStatus() const717061da546Spatrick bool DumpLinuxProcStatus() const {
718061da546Spatrick return DumpLinux() ||
719061da546Spatrick m_dump_linux_proc_status.GetOptionValue().GetCurrentValue();
720061da546Spatrick }
DumpLinuxProcStat() const721061da546Spatrick bool DumpLinuxProcStat() const {
722061da546Spatrick return DumpLinux() ||
723061da546Spatrick m_dump_linux_proc_stat.GetOptionValue().GetCurrentValue();
724061da546Spatrick }
DumpLinuxLSBRelease() const725061da546Spatrick bool DumpLinuxLSBRelease() const {
726061da546Spatrick return DumpLinux() ||
727061da546Spatrick m_dump_linux_lsb_release.GetOptionValue().GetCurrentValue();
728061da546Spatrick }
DumpLinuxCMDLine() const729061da546Spatrick bool DumpLinuxCMDLine() const {
730061da546Spatrick return DumpLinux() ||
731061da546Spatrick m_dump_linux_cmdline.GetOptionValue().GetCurrentValue();
732061da546Spatrick }
DumpLinuxEnviron() const733061da546Spatrick bool DumpLinuxEnviron() const {
734061da546Spatrick return DumpLinux() ||
735061da546Spatrick m_dump_linux_environ.GetOptionValue().GetCurrentValue();
736061da546Spatrick }
DumpLinuxAuxv() const737061da546Spatrick bool DumpLinuxAuxv() const {
738061da546Spatrick return DumpLinux() ||
739061da546Spatrick m_dump_linux_auxv.GetOptionValue().GetCurrentValue();
740061da546Spatrick }
DumpLinuxMaps() const741061da546Spatrick bool DumpLinuxMaps() const {
742061da546Spatrick return DumpLinux() ||
743061da546Spatrick m_dump_linux_maps.GetOptionValue().GetCurrentValue();
744061da546Spatrick }
DumpLinuxProcUptime() const745061da546Spatrick bool DumpLinuxProcUptime() const {
746061da546Spatrick return DumpLinux() ||
747061da546Spatrick m_dump_linux_proc_uptime.GetOptionValue().GetCurrentValue();
748061da546Spatrick }
DumpLinuxProcFD() const749061da546Spatrick bool DumpLinuxProcFD() const {
750061da546Spatrick return DumpLinux() ||
751061da546Spatrick m_dump_linux_proc_fd.GetOptionValue().GetCurrentValue();
752061da546Spatrick }
DumpFacebook() const753061da546Spatrick bool DumpFacebook() const {
754061da546Spatrick return DumpAll() || m_fb_all.GetOptionValue().GetCurrentValue();
755061da546Spatrick }
DumpFacebookAppData() const756061da546Spatrick bool DumpFacebookAppData() const {
757061da546Spatrick return DumpFacebook() || m_fb_app_data.GetOptionValue().GetCurrentValue();
758061da546Spatrick }
DumpFacebookBuildID() const759061da546Spatrick bool DumpFacebookBuildID() const {
760061da546Spatrick return DumpFacebook() || m_fb_build_id.GetOptionValue().GetCurrentValue();
761061da546Spatrick }
DumpFacebookVersionName() const762061da546Spatrick bool DumpFacebookVersionName() const {
763061da546Spatrick return DumpFacebook() || m_fb_version.GetOptionValue().GetCurrentValue();
764061da546Spatrick }
DumpFacebookJavaStack() const765061da546Spatrick bool DumpFacebookJavaStack() const {
766061da546Spatrick return DumpFacebook() || m_fb_java_stack.GetOptionValue().GetCurrentValue();
767061da546Spatrick }
DumpFacebookDalvikInfo() const768061da546Spatrick bool DumpFacebookDalvikInfo() const {
769061da546Spatrick return DumpFacebook() || m_fb_dalvik.GetOptionValue().GetCurrentValue();
770061da546Spatrick }
DumpFacebookUnwindSymbols() const771061da546Spatrick bool DumpFacebookUnwindSymbols() const {
772061da546Spatrick return DumpFacebook() || m_fb_unwind.GetOptionValue().GetCurrentValue();
773061da546Spatrick }
DumpFacebookErrorLog() const774061da546Spatrick bool DumpFacebookErrorLog() const {
775061da546Spatrick return DumpFacebook() || m_fb_error_log.GetOptionValue().GetCurrentValue();
776061da546Spatrick }
DumpFacebookAppStateLog() const777061da546Spatrick bool DumpFacebookAppStateLog() const {
778061da546Spatrick return DumpFacebook() || m_fb_app_state.GetOptionValue().GetCurrentValue();
779061da546Spatrick }
DumpFacebookAbortReason() const780061da546Spatrick bool DumpFacebookAbortReason() const {
781061da546Spatrick return DumpFacebook() || m_fb_abort.GetOptionValue().GetCurrentValue();
782061da546Spatrick }
DumpFacebookThreadName() const783061da546Spatrick bool DumpFacebookThreadName() const {
784061da546Spatrick return DumpFacebook() || m_fb_thread.GetOptionValue().GetCurrentValue();
785061da546Spatrick }
DumpFacebookLogcat() const786061da546Spatrick bool DumpFacebookLogcat() const {
787061da546Spatrick return DumpFacebook() || m_fb_logcat.GetOptionValue().GetCurrentValue();
788061da546Spatrick }
789061da546Spatrick public:
CommandObjectProcessMinidumpDump(CommandInterpreter & interpreter)790061da546Spatrick CommandObjectProcessMinidumpDump(CommandInterpreter &interpreter)
791061da546Spatrick : CommandObjectParsed(interpreter, "process plugin dump",
792061da546Spatrick "Dump information from the minidump file.", nullptr),
793061da546Spatrick m_option_group(),
794061da546Spatrick INIT_BOOL(m_dump_all, "all", 'a',
795061da546Spatrick "Dump the everything in the minidump."),
796061da546Spatrick INIT_BOOL(m_dump_directory, "directory", 'd',
797061da546Spatrick "Dump the minidump directory map."),
798061da546Spatrick INIT_BOOL(m_dump_linux_cpuinfo, "cpuinfo", 'C',
799061da546Spatrick "Dump linux /proc/cpuinfo."),
800061da546Spatrick INIT_BOOL(m_dump_linux_proc_status, "status", 's',
801061da546Spatrick "Dump linux /proc/<pid>/status."),
802061da546Spatrick INIT_BOOL(m_dump_linux_lsb_release, "lsb-release", 'r',
803061da546Spatrick "Dump linux /etc/lsb-release."),
804061da546Spatrick INIT_BOOL(m_dump_linux_cmdline, "cmdline", 'c',
805061da546Spatrick "Dump linux /proc/<pid>/cmdline."),
806061da546Spatrick INIT_BOOL(m_dump_linux_environ, "environ", 'e',
807061da546Spatrick "Dump linux /proc/<pid>/environ."),
808061da546Spatrick INIT_BOOL(m_dump_linux_auxv, "auxv", 'x',
809061da546Spatrick "Dump linux /proc/<pid>/auxv."),
810061da546Spatrick INIT_BOOL(m_dump_linux_maps, "maps", 'm',
811061da546Spatrick "Dump linux /proc/<pid>/maps."),
812061da546Spatrick INIT_BOOL(m_dump_linux_proc_stat, "stat", 'S',
813061da546Spatrick "Dump linux /proc/<pid>/stat."),
814061da546Spatrick INIT_BOOL(m_dump_linux_proc_uptime, "uptime", 'u',
815061da546Spatrick "Dump linux process uptime."),
816061da546Spatrick INIT_BOOL(m_dump_linux_proc_fd, "fd", 'f',
817061da546Spatrick "Dump linux /proc/<pid>/fd."),
818061da546Spatrick INIT_BOOL(m_dump_linux_all, "linux", 'l',
819061da546Spatrick "Dump all linux streams."),
820061da546Spatrick INIT_BOOL(m_fb_app_data, "fb-app-data", 1,
821061da546Spatrick "Dump Facebook application custom data."),
822061da546Spatrick INIT_BOOL(m_fb_build_id, "fb-build-id", 2,
823061da546Spatrick "Dump the Facebook build ID."),
824061da546Spatrick INIT_BOOL(m_fb_version, "fb-version", 3,
825061da546Spatrick "Dump Facebook application version string."),
826061da546Spatrick INIT_BOOL(m_fb_java_stack, "fb-java-stack", 4,
827061da546Spatrick "Dump Facebook java stack."),
828061da546Spatrick INIT_BOOL(m_fb_dalvik, "fb-dalvik-info", 5,
829061da546Spatrick "Dump Facebook Dalvik info."),
830061da546Spatrick INIT_BOOL(m_fb_unwind, "fb-unwind-symbols", 6,
831061da546Spatrick "Dump Facebook unwind symbols."),
832061da546Spatrick INIT_BOOL(m_fb_error_log, "fb-error-log", 7,
833061da546Spatrick "Dump Facebook error log."),
834061da546Spatrick INIT_BOOL(m_fb_app_state, "fb-app-state-log", 8,
835061da546Spatrick "Dump Facebook java stack."),
836061da546Spatrick INIT_BOOL(m_fb_abort, "fb-abort-reason", 9,
837061da546Spatrick "Dump Facebook abort reason."),
838061da546Spatrick INIT_BOOL(m_fb_thread, "fb-thread-name", 10,
839061da546Spatrick "Dump Facebook thread name."),
840061da546Spatrick INIT_BOOL(m_fb_logcat, "fb-logcat", 11,
841061da546Spatrick "Dump Facebook logcat."),
842061da546Spatrick INIT_BOOL(m_fb_all, "facebook", 12, "Dump all Facebook streams.") {
843061da546Spatrick APPEND_OPT(m_dump_all);
844061da546Spatrick APPEND_OPT(m_dump_directory);
845061da546Spatrick APPEND_OPT(m_dump_linux_cpuinfo);
846061da546Spatrick APPEND_OPT(m_dump_linux_proc_status);
847061da546Spatrick APPEND_OPT(m_dump_linux_lsb_release);
848061da546Spatrick APPEND_OPT(m_dump_linux_cmdline);
849061da546Spatrick APPEND_OPT(m_dump_linux_environ);
850061da546Spatrick APPEND_OPT(m_dump_linux_auxv);
851061da546Spatrick APPEND_OPT(m_dump_linux_maps);
852061da546Spatrick APPEND_OPT(m_dump_linux_proc_stat);
853061da546Spatrick APPEND_OPT(m_dump_linux_proc_uptime);
854061da546Spatrick APPEND_OPT(m_dump_linux_proc_fd);
855061da546Spatrick APPEND_OPT(m_dump_linux_all);
856061da546Spatrick APPEND_OPT(m_fb_app_data);
857061da546Spatrick APPEND_OPT(m_fb_build_id);
858061da546Spatrick APPEND_OPT(m_fb_version);
859061da546Spatrick APPEND_OPT(m_fb_java_stack);
860061da546Spatrick APPEND_OPT(m_fb_dalvik);
861061da546Spatrick APPEND_OPT(m_fb_unwind);
862061da546Spatrick APPEND_OPT(m_fb_error_log);
863061da546Spatrick APPEND_OPT(m_fb_app_state);
864061da546Spatrick APPEND_OPT(m_fb_abort);
865061da546Spatrick APPEND_OPT(m_fb_thread);
866061da546Spatrick APPEND_OPT(m_fb_logcat);
867061da546Spatrick APPEND_OPT(m_fb_all);
868061da546Spatrick m_option_group.Finalize();
869061da546Spatrick }
870061da546Spatrick
871be691f3bSpatrick ~CommandObjectProcessMinidumpDump() override = default;
872061da546Spatrick
GetOptions()873061da546Spatrick Options *GetOptions() override { return &m_option_group; }
874061da546Spatrick
DoExecute(Args & command,CommandReturnObject & result)875061da546Spatrick bool DoExecute(Args &command, CommandReturnObject &result) override {
876061da546Spatrick const size_t argc = command.GetArgumentCount();
877061da546Spatrick if (argc > 0) {
878061da546Spatrick result.AppendErrorWithFormat("'%s' take no arguments, only options",
879061da546Spatrick m_cmd_name.c_str());
880061da546Spatrick return false;
881061da546Spatrick }
882061da546Spatrick SetDefaultOptionsIfNoneAreSet();
883061da546Spatrick
884061da546Spatrick ProcessMinidump *process = static_cast<ProcessMinidump *>(
885061da546Spatrick m_interpreter.GetExecutionContext().GetProcessPtr());
886061da546Spatrick result.SetStatus(eReturnStatusSuccessFinishResult);
887061da546Spatrick Stream &s = result.GetOutputStream();
888061da546Spatrick MinidumpParser &minidump = *process->m_minidump_parser;
889061da546Spatrick if (DumpDirectory()) {
890061da546Spatrick s.Printf("RVA SIZE TYPE StreamType\n");
891061da546Spatrick s.Printf("---------- ---------- ---------- --------------------------\n");
892061da546Spatrick for (const auto &stream_desc : minidump.GetMinidumpFile().streams())
893061da546Spatrick s.Printf(
894061da546Spatrick "0x%8.8x 0x%8.8x 0x%8.8x %s\n", (uint32_t)stream_desc.Location.RVA,
895061da546Spatrick (uint32_t)stream_desc.Location.DataSize,
896061da546Spatrick (unsigned)(StreamType)stream_desc.Type,
897061da546Spatrick MinidumpParser::GetStreamTypeAsString(stream_desc.Type).data());
898061da546Spatrick s.Printf("\n");
899061da546Spatrick }
900061da546Spatrick auto DumpTextStream = [&](StreamType stream_type,
901061da546Spatrick llvm::StringRef label) -> void {
902061da546Spatrick auto bytes = minidump.GetStream(stream_type);
903061da546Spatrick if (!bytes.empty()) {
904061da546Spatrick if (label.empty())
905061da546Spatrick label = MinidumpParser::GetStreamTypeAsString(stream_type);
906061da546Spatrick s.Printf("%s:\n%s\n\n", label.data(), bytes.data());
907061da546Spatrick }
908061da546Spatrick };
909061da546Spatrick auto DumpBinaryStream = [&](StreamType stream_type,
910061da546Spatrick llvm::StringRef label) -> void {
911061da546Spatrick auto bytes = minidump.GetStream(stream_type);
912061da546Spatrick if (!bytes.empty()) {
913061da546Spatrick if (label.empty())
914061da546Spatrick label = MinidumpParser::GetStreamTypeAsString(stream_type);
915061da546Spatrick s.Printf("%s:\n", label.data());
916061da546Spatrick DataExtractor data(bytes.data(), bytes.size(), eByteOrderLittle,
917061da546Spatrick process->GetAddressByteSize());
918061da546Spatrick DumpDataExtractor(data, &s, 0, lldb::eFormatBytesWithASCII, 1,
919061da546Spatrick bytes.size(), 16, 0, 0, 0);
920061da546Spatrick s.Printf("\n\n");
921061da546Spatrick }
922061da546Spatrick };
923061da546Spatrick
924061da546Spatrick if (DumpLinuxCPUInfo())
925061da546Spatrick DumpTextStream(StreamType::LinuxCPUInfo, "/proc/cpuinfo");
926061da546Spatrick if (DumpLinuxProcStatus())
927061da546Spatrick DumpTextStream(StreamType::LinuxProcStatus, "/proc/PID/status");
928061da546Spatrick if (DumpLinuxLSBRelease())
929061da546Spatrick DumpTextStream(StreamType::LinuxLSBRelease, "/etc/lsb-release");
930061da546Spatrick if (DumpLinuxCMDLine())
931061da546Spatrick DumpTextStream(StreamType::LinuxCMDLine, "/proc/PID/cmdline");
932061da546Spatrick if (DumpLinuxEnviron())
933061da546Spatrick DumpTextStream(StreamType::LinuxEnviron, "/proc/PID/environ");
934061da546Spatrick if (DumpLinuxAuxv())
935061da546Spatrick DumpBinaryStream(StreamType::LinuxAuxv, "/proc/PID/auxv");
936061da546Spatrick if (DumpLinuxMaps())
937061da546Spatrick DumpTextStream(StreamType::LinuxMaps, "/proc/PID/maps");
938061da546Spatrick if (DumpLinuxProcStat())
939061da546Spatrick DumpTextStream(StreamType::LinuxProcStat, "/proc/PID/stat");
940061da546Spatrick if (DumpLinuxProcUptime())
941061da546Spatrick DumpTextStream(StreamType::LinuxProcUptime, "uptime");
942061da546Spatrick if (DumpLinuxProcFD())
943061da546Spatrick DumpTextStream(StreamType::LinuxProcFD, "/proc/PID/fd");
944061da546Spatrick if (DumpFacebookAppData())
945061da546Spatrick DumpTextStream(StreamType::FacebookAppCustomData,
946061da546Spatrick "Facebook App Data");
947061da546Spatrick if (DumpFacebookBuildID()) {
948061da546Spatrick auto bytes = minidump.GetStream(StreamType::FacebookBuildID);
949061da546Spatrick if (bytes.size() >= 4) {
950061da546Spatrick DataExtractor data(bytes.data(), bytes.size(), eByteOrderLittle,
951061da546Spatrick process->GetAddressByteSize());
952061da546Spatrick lldb::offset_t offset = 0;
953061da546Spatrick uint32_t build_id = data.GetU32(&offset);
954061da546Spatrick s.Printf("Facebook Build ID:\n");
955061da546Spatrick s.Printf("%u\n", build_id);
956061da546Spatrick s.Printf("\n");
957061da546Spatrick }
958061da546Spatrick }
959061da546Spatrick if (DumpFacebookVersionName())
960061da546Spatrick DumpTextStream(StreamType::FacebookAppVersionName,
961061da546Spatrick "Facebook Version String");
962061da546Spatrick if (DumpFacebookJavaStack())
963061da546Spatrick DumpTextStream(StreamType::FacebookJavaStack,
964061da546Spatrick "Facebook Java Stack");
965061da546Spatrick if (DumpFacebookDalvikInfo())
966061da546Spatrick DumpTextStream(StreamType::FacebookDalvikInfo,
967061da546Spatrick "Facebook Dalvik Info");
968061da546Spatrick if (DumpFacebookUnwindSymbols())
969061da546Spatrick DumpBinaryStream(StreamType::FacebookUnwindSymbols,
970061da546Spatrick "Facebook Unwind Symbols Bytes");
971061da546Spatrick if (DumpFacebookErrorLog())
972061da546Spatrick DumpTextStream(StreamType::FacebookDumpErrorLog,
973061da546Spatrick "Facebook Error Log");
974061da546Spatrick if (DumpFacebookAppStateLog())
975061da546Spatrick DumpTextStream(StreamType::FacebookAppStateLog,
976061da546Spatrick "Faceook Application State Log");
977061da546Spatrick if (DumpFacebookAbortReason())
978061da546Spatrick DumpTextStream(StreamType::FacebookAbortReason,
979061da546Spatrick "Facebook Abort Reason");
980061da546Spatrick if (DumpFacebookThreadName())
981061da546Spatrick DumpTextStream(StreamType::FacebookThreadName,
982061da546Spatrick "Facebook Thread Name");
983061da546Spatrick if (DumpFacebookLogcat())
984061da546Spatrick DumpTextStream(StreamType::FacebookLogcat,
985061da546Spatrick "Facebook Logcat");
986061da546Spatrick return true;
987061da546Spatrick }
988061da546Spatrick };
989061da546Spatrick
990061da546Spatrick class CommandObjectMultiwordProcessMinidump : public CommandObjectMultiword {
991061da546Spatrick public:
CommandObjectMultiwordProcessMinidump(CommandInterpreter & interpreter)992061da546Spatrick CommandObjectMultiwordProcessMinidump(CommandInterpreter &interpreter)
993061da546Spatrick : CommandObjectMultiword(interpreter, "process plugin",
994061da546Spatrick "Commands for operating on a ProcessMinidump process.",
995061da546Spatrick "process plugin <subcommand> [<subcommand-options>]") {
996061da546Spatrick LoadSubCommand("dump",
997061da546Spatrick CommandObjectSP(new CommandObjectProcessMinidumpDump(interpreter)));
998061da546Spatrick }
999061da546Spatrick
1000be691f3bSpatrick ~CommandObjectMultiwordProcessMinidump() override = default;
1001061da546Spatrick };
1002061da546Spatrick
GetPluginCommandObject()1003061da546Spatrick CommandObject *ProcessMinidump::GetPluginCommandObject() {
1004061da546Spatrick if (!m_command_sp)
1005061da546Spatrick m_command_sp = std::make_shared<CommandObjectMultiwordProcessMinidump>(
1006061da546Spatrick GetTarget().GetDebugger().GetCommandInterpreter());
1007061da546Spatrick return m_command_sp.get();
1008061da546Spatrick }
1009