1 //===-- ProcessMinidump.cpp -----------------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "ProcessMinidump.h"
10 
11 #include "ThreadMinidump.h"
12 
13 #include "lldb/Core/DumpDataExtractor.h"
14 #include "lldb/Core/Module.h"
15 #include "lldb/Core/ModuleSpec.h"
16 #include "lldb/Core/PluginManager.h"
17 #include "lldb/Core/Section.h"
18 #include "lldb/Interpreter/CommandInterpreter.h"
19 #include "lldb/Interpreter/CommandObject.h"
20 #include "lldb/Interpreter/CommandObjectMultiword.h"
21 #include "lldb/Interpreter/CommandReturnObject.h"
22 #include "lldb/Interpreter/OptionArgParser.h"
23 #include "lldb/Interpreter/OptionGroupBoolean.h"
24 #include "lldb/Target/JITLoaderList.h"
25 #include "lldb/Target/MemoryRegionInfo.h"
26 #include "lldb/Target/SectionLoadList.h"
27 #include "lldb/Target/Target.h"
28 #include "lldb/Target/UnixSignals.h"
29 #include "lldb/Utility/LLDBAssert.h"
30 #include "lldb/Utility/Log.h"
31 #include "lldb/Utility/State.h"
32 #include "llvm/BinaryFormat/Magic.h"
33 #include "llvm/Support/MemoryBuffer.h"
34 #include "llvm/Support/Threading.h"
35 
36 #include "Plugins/Process/Utility/StopInfoMachException.h"
37 
38 #include <memory>
39 
40 using namespace lldb;
41 using namespace lldb_private;
42 using namespace minidump;
43 
44 LLDB_PLUGIN_DEFINE(ProcessMinidump)
45 
46 namespace {
47 
48 /// A minimal ObjectFile implementation providing a dummy object file for the
49 /// cases when the real module binary is not available. This allows the module
50 /// to show up in "image list" and symbols to be added to it.
51 class PlaceholderObjectFile : public ObjectFile {
52 public:
53   PlaceholderObjectFile(const lldb::ModuleSP &module_sp,
54                         const ModuleSpec &module_spec, lldb::addr_t base,
55                         lldb::addr_t size)
56       : ObjectFile(module_sp, &module_spec.GetFileSpec(), /*file_offset*/ 0,
57                    /*length*/ 0, /*data_sp*/ nullptr, /*data_offset*/ 0),
58         m_arch(module_spec.GetArchitecture()), m_uuid(module_spec.GetUUID()),
59         m_base(base), m_size(size) {
60     m_symtab_up = std::make_unique<Symtab>(this);
61   }
62 
63   static ConstString GetStaticPluginName() {
64     return ConstString("placeholder");
65   }
66   ConstString GetPluginName() override { return GetStaticPluginName(); }
67   uint32_t GetPluginVersion() override { return 1; }
68   bool ParseHeader() override { return true; }
69   Type CalculateType() override { return eTypeUnknown; }
70   Strata CalculateStrata() override { return eStrataUnknown; }
71   uint32_t GetDependentModules(FileSpecList &file_list) override { return 0; }
72   bool IsExecutable() const override { return false; }
73   ArchSpec GetArchitecture() override { return m_arch; }
74   UUID GetUUID() override { return m_uuid; }
75   Symtab *GetSymtab() override { return m_symtab_up.get(); }
76   bool IsStripped() override { return true; }
77   ByteOrder GetByteOrder() const override { return m_arch.GetByteOrder(); }
78 
79   uint32_t GetAddressByteSize() const override {
80     return m_arch.GetAddressByteSize();
81   }
82 
83   Address GetBaseAddress() override {
84     return Address(m_sections_up->GetSectionAtIndex(0), 0);
85   }
86 
87   void CreateSections(SectionList &unified_section_list) override {
88     m_sections_up = std::make_unique<SectionList>();
89     auto section_sp = std::make_shared<Section>(
90         GetModule(), this, /*sect_id*/ 0, ConstString(".module_image"),
91         eSectionTypeOther, m_base, m_size, /*file_offset*/ 0, /*file_size*/ 0,
92         /*log2align*/ 0, /*flags*/ 0);
93     section_sp->SetPermissions(ePermissionsReadable | ePermissionsExecutable);
94     m_sections_up->AddSection(section_sp);
95     unified_section_list.AddSection(std::move(section_sp));
96   }
97 
98   bool SetLoadAddress(Target &target, addr_t value,
99                       bool value_is_offset) override {
100     assert(!value_is_offset);
101     assert(value == m_base);
102 
103     // Create sections if they haven't been created already.
104     GetModule()->GetSectionList();
105     assert(m_sections_up->GetNumSections(0) == 1);
106 
107     target.GetSectionLoadList().SetSectionLoadAddress(
108         m_sections_up->GetSectionAtIndex(0), m_base);
109     return true;
110   }
111 
112   void Dump(Stream *s) override {
113     s->Format("Placeholder object file for {0} loaded at [{1:x}-{2:x})\n",
114               GetFileSpec(), m_base, m_base + m_size);
115   }
116 
117   lldb::addr_t GetBaseImageAddress() const { return m_base; }
118 private:
119   ArchSpec m_arch;
120   UUID m_uuid;
121   lldb::addr_t m_base;
122   lldb::addr_t m_size;
123 };
124 
125 /// Duplicate the HashElfTextSection() from the breakpad sources.
126 ///
127 /// Breakpad, a Google crash log reporting tool suite, creates minidump files
128 /// for many different architectures. When using Breakpad to create ELF
129 /// minidumps, it will check for a GNU build ID when creating a minidump file
130 /// and if one doesn't exist in the file, it will say the UUID of the file is a
131 /// checksum of up to the first 4096 bytes of the .text section. Facebook also
132 /// uses breakpad and modified this hash to avoid collisions so we can
133 /// calculate and check for this as well.
134 ///
135 /// The breakpad code might end up hashing up to 15 bytes that immediately
136 /// follow the .text section in the file, so this code must do exactly what it
137 /// does so we can get an exact match for the UUID.
138 ///
139 /// \param[in] module_sp The module to grab the .text section from.
140 ///
141 /// \param[in/out] breakpad_uuid A vector that will receive the calculated
142 ///                breakpad .text hash.
143 ///
144 /// \param[in/out] facebook_uuid A vector that will receive the calculated
145 ///                facebook .text hash.
146 ///
147 void HashElfTextSection(ModuleSP module_sp, std::vector<uint8_t> &breakpad_uuid,
148                         std::vector<uint8_t> &facebook_uuid) {
149   SectionList *sect_list = module_sp->GetSectionList();
150   if (sect_list == nullptr)
151     return;
152   SectionSP sect_sp = sect_list->FindSectionByName(ConstString(".text"));
153   if (!sect_sp)
154     return;
155   constexpr size_t kMDGUIDSize = 16;
156   constexpr size_t kBreakpadPageSize = 4096;
157   // The breakpad code has a bug where it might access beyond the end of a
158   // .text section by up to 15 bytes, so we must ensure we round up to the
159   // next kMDGUIDSize byte boundary.
160   DataExtractor data;
161   const size_t text_size = sect_sp->GetFileSize();
162   const size_t read_size = std::min<size_t>(
163       llvm::alignTo(text_size, kMDGUIDSize), kBreakpadPageSize);
164   sect_sp->GetObjectFile()->GetData(sect_sp->GetFileOffset(), read_size, data);
165 
166   breakpad_uuid.assign(kMDGUIDSize, 0);
167   facebook_uuid.assign(kMDGUIDSize, 0);
168 
169   // The only difference between the breakpad hash and the facebook hash is the
170   // hashing of the text section size into the hash prior to hashing the .text
171   // contents.
172   for (size_t i = 0; i < kMDGUIDSize; i++)
173     facebook_uuid[i] ^= text_size % 255;
174 
175   // This code carefully duplicates how the hash was created in Breakpad
176   // sources, including the error where it might has an extra 15 bytes past the
177   // end of the .text section if the .text section is less than a page size in
178   // length.
179   const uint8_t *ptr = data.GetDataStart();
180   const uint8_t *ptr_end = data.GetDataEnd();
181   while (ptr < ptr_end) {
182     for (unsigned i = 0; i < kMDGUIDSize; i++) {
183       breakpad_uuid[i] ^= ptr[i];
184       facebook_uuid[i] ^= ptr[i];
185     }
186     ptr += kMDGUIDSize;
187   }
188 }
189 
190 } // namespace
191 
192 ConstString ProcessMinidump::GetPluginNameStatic() {
193   static ConstString g_name("minidump");
194   return g_name;
195 }
196 
197 const char *ProcessMinidump::GetPluginDescriptionStatic() {
198   return "Minidump plug-in.";
199 }
200 
201 lldb::ProcessSP ProcessMinidump::CreateInstance(lldb::TargetSP target_sp,
202                                                 lldb::ListenerSP listener_sp,
203                                                 const FileSpec *crash_file) {
204   if (!crash_file)
205     return nullptr;
206 
207   lldb::ProcessSP process_sp;
208   // Read enough data for the Minidump header
209   constexpr size_t header_size = sizeof(Header);
210   auto DataPtr = FileSystem::Instance().CreateDataBuffer(crash_file->GetPath(),
211                                                          header_size, 0);
212   if (!DataPtr)
213     return nullptr;
214 
215   lldbassert(DataPtr->GetByteSize() == header_size);
216   if (identify_magic(toStringRef(DataPtr->GetData())) != llvm::file_magic::minidump)
217     return nullptr;
218 
219   auto AllData =
220       FileSystem::Instance().CreateDataBuffer(crash_file->GetPath(), -1, 0);
221   if (!AllData)
222     return nullptr;
223 
224   return std::make_shared<ProcessMinidump>(target_sp, listener_sp, *crash_file,
225                                            std::move(AllData));
226 }
227 
228 bool ProcessMinidump::CanDebug(lldb::TargetSP target_sp,
229                                bool plugin_specified_by_name) {
230   return true;
231 }
232 
233 ProcessMinidump::ProcessMinidump(lldb::TargetSP target_sp,
234                                  lldb::ListenerSP listener_sp,
235                                  const FileSpec &core_file,
236                                  DataBufferSP core_data)
237     : Process(target_sp, listener_sp), m_core_file(core_file),
238       m_core_data(std::move(core_data)), m_is_wow64(false) {}
239 
240 ProcessMinidump::~ProcessMinidump() {
241   Clear();
242   // We need to call finalize on the process before destroying ourselves to
243   // make sure all of the broadcaster cleanup goes as planned. If we destruct
244   // this class, then Process::~Process() might have problems trying to fully
245   // destroy the broadcaster.
246   Finalize();
247 }
248 
249 void ProcessMinidump::Initialize() {
250   static llvm::once_flag g_once_flag;
251 
252   llvm::call_once(g_once_flag, []() {
253     PluginManager::RegisterPlugin(GetPluginNameStatic(),
254                                   GetPluginDescriptionStatic(),
255                                   ProcessMinidump::CreateInstance);
256   });
257 }
258 
259 void ProcessMinidump::Terminate() {
260   PluginManager::UnregisterPlugin(ProcessMinidump::CreateInstance);
261 }
262 
263 Status ProcessMinidump::DoLoadCore() {
264   auto expected_parser = MinidumpParser::Create(m_core_data);
265   if (!expected_parser)
266     return Status(expected_parser.takeError());
267   m_minidump_parser = std::move(*expected_parser);
268 
269   Status error;
270 
271   // Do we support the minidump's architecture?
272   ArchSpec arch = GetArchitecture();
273   switch (arch.GetMachine()) {
274   case llvm::Triple::x86:
275   case llvm::Triple::x86_64:
276   case llvm::Triple::arm:
277   case llvm::Triple::aarch64:
278     // Any supported architectures must be listed here and also supported in
279     // ThreadMinidump::CreateRegisterContextForFrame().
280     break;
281   default:
282     error.SetErrorStringWithFormat("unsupported minidump architecture: %s",
283                                    arch.GetArchitectureName());
284     return error;
285   }
286   GetTarget().SetArchitecture(arch, true /*set_platform*/);
287 
288   m_thread_list = m_minidump_parser->GetThreads();
289   m_active_exception = m_minidump_parser->GetExceptionStream();
290 
291   SetUnixSignals(UnixSignals::Create(GetArchitecture()));
292 
293   ReadModuleList();
294 
295   llvm::Optional<lldb::pid_t> pid = m_minidump_parser->GetPid();
296   if (!pid) {
297     GetTarget().GetDebugger().GetAsyncErrorStream()->PutCString(
298         "Unable to retrieve process ID from minidump file, setting process ID "
299         "to 1.\n");
300     pid = 1;
301   }
302   SetID(pid.getValue());
303 
304   return error;
305 }
306 
307 ConstString ProcessMinidump::GetPluginName() { return GetPluginNameStatic(); }
308 
309 uint32_t ProcessMinidump::GetPluginVersion() { return 1; }
310 
311 Status ProcessMinidump::DoDestroy() { return Status(); }
312 
313 void ProcessMinidump::RefreshStateAfterStop() {
314 
315   if (!m_active_exception)
316     return;
317 
318   constexpr uint32_t BreakpadDumpRequested = 0xFFFFFFFF;
319   if (m_active_exception->ExceptionRecord.ExceptionCode ==
320       BreakpadDumpRequested) {
321     // This "ExceptionCode" value is a sentinel that is sometimes used
322     // when generating a dump for a process that hasn't crashed.
323 
324     // TODO: The definition and use of this "dump requested" constant
325     // in Breakpad are actually Linux-specific, and for similar use
326     // cases on Mac/Windows it defines different constants, referring
327     // to them as "simulated" exceptions; consider moving this check
328     // down to the OS-specific paths and checking each OS for its own
329     // constant.
330     return;
331   }
332 
333   lldb::StopInfoSP stop_info;
334   lldb::ThreadSP stop_thread;
335 
336   Process::m_thread_list.SetSelectedThreadByID(m_active_exception->ThreadId);
337   stop_thread = Process::m_thread_list.GetSelectedThread();
338   ArchSpec arch = GetArchitecture();
339 
340   if (arch.GetTriple().getOS() == llvm::Triple::Linux) {
341     uint32_t signo = m_active_exception->ExceptionRecord.ExceptionCode;
342 
343     if (signo == 0) {
344       // No stop.
345       return;
346     }
347 
348     stop_info = StopInfo::CreateStopReasonWithSignal(
349         *stop_thread, signo);
350   } else if (arch.GetTriple().getVendor() == llvm::Triple::Apple) {
351     stop_info = StopInfoMachException::CreateStopReasonWithMachException(
352         *stop_thread, m_active_exception->ExceptionRecord.ExceptionCode, 2,
353         m_active_exception->ExceptionRecord.ExceptionFlags,
354         m_active_exception->ExceptionRecord.ExceptionAddress, 0);
355   } else {
356     std::string desc;
357     llvm::raw_string_ostream desc_stream(desc);
358     desc_stream << "Exception "
359                 << llvm::format_hex(
360                        m_active_exception->ExceptionRecord.ExceptionCode, 8)
361                 << " encountered at address "
362                 << llvm::format_hex(
363                        m_active_exception->ExceptionRecord.ExceptionAddress, 8);
364     stop_info = StopInfo::CreateStopReasonWithException(
365         *stop_thread, desc_stream.str().c_str());
366   }
367 
368   stop_thread->SetStopInfo(stop_info);
369 }
370 
371 bool ProcessMinidump::IsAlive() { return true; }
372 
373 bool ProcessMinidump::WarnBeforeDetach() const { return false; }
374 
375 size_t ProcessMinidump::ReadMemory(lldb::addr_t addr, void *buf, size_t size,
376                                    Status &error) {
377   // Don't allow the caching that lldb_private::Process::ReadMemory does since
378   // we have it all cached in our dump file anyway.
379   return DoReadMemory(addr, buf, size, error);
380 }
381 
382 size_t ProcessMinidump::DoReadMemory(lldb::addr_t addr, void *buf, size_t size,
383                                      Status &error) {
384 
385   llvm::ArrayRef<uint8_t> mem = m_minidump_parser->GetMemory(addr, size);
386   if (mem.empty()) {
387     error.SetErrorString("could not parse memory info");
388     return 0;
389   }
390 
391   std::memcpy(buf, mem.data(), mem.size());
392   return mem.size();
393 }
394 
395 ArchSpec ProcessMinidump::GetArchitecture() {
396   if (!m_is_wow64) {
397     return m_minidump_parser->GetArchitecture();
398   }
399 
400   llvm::Triple triple;
401   triple.setVendor(llvm::Triple::VendorType::UnknownVendor);
402   triple.setArch(llvm::Triple::ArchType::x86);
403   triple.setOS(llvm::Triple::OSType::Win32);
404   return ArchSpec(triple);
405 }
406 
407 void ProcessMinidump::BuildMemoryRegions() {
408   if (m_memory_regions)
409     return;
410   m_memory_regions.emplace();
411   bool is_complete;
412   std::tie(*m_memory_regions, is_complete) =
413       m_minidump_parser->BuildMemoryRegions();
414 
415   if (is_complete)
416     return;
417 
418   MemoryRegionInfos to_add;
419   ModuleList &modules = GetTarget().GetImages();
420   SectionLoadList &load_list = GetTarget().GetSectionLoadList();
421   modules.ForEach([&](const ModuleSP &module_sp) {
422     SectionList *sections = module_sp->GetSectionList();
423     for (size_t i = 0; i < sections->GetSize(); ++i) {
424       SectionSP section_sp = sections->GetSectionAtIndex(i);
425       addr_t load_addr = load_list.GetSectionLoadAddress(section_sp);
426       if (load_addr == LLDB_INVALID_ADDRESS)
427         continue;
428       MemoryRegionInfo::RangeType section_range(load_addr,
429                                                 section_sp->GetByteSize());
430       MemoryRegionInfo region =
431           MinidumpParser::GetMemoryRegionInfo(*m_memory_regions, load_addr);
432       if (region.GetMapped() != MemoryRegionInfo::eYes &&
433           region.GetRange().GetRangeBase() <= section_range.GetRangeBase() &&
434           section_range.GetRangeEnd() <= region.GetRange().GetRangeEnd()) {
435         to_add.emplace_back();
436         to_add.back().GetRange() = section_range;
437         to_add.back().SetLLDBPermissions(section_sp->GetPermissions());
438         to_add.back().SetMapped(MemoryRegionInfo::eYes);
439         to_add.back().SetName(module_sp->GetFileSpec().GetPath().c_str());
440       }
441     }
442     return true;
443   });
444   m_memory_regions->insert(m_memory_regions->end(), to_add.begin(),
445                            to_add.end());
446   llvm::sort(*m_memory_regions);
447 }
448 
449 Status ProcessMinidump::GetMemoryRegionInfo(lldb::addr_t load_addr,
450                                             MemoryRegionInfo &region) {
451   BuildMemoryRegions();
452   region = MinidumpParser::GetMemoryRegionInfo(*m_memory_regions, load_addr);
453   return Status();
454 }
455 
456 Status ProcessMinidump::GetMemoryRegions(MemoryRegionInfos &region_list) {
457   BuildMemoryRegions();
458   region_list = *m_memory_regions;
459   return Status();
460 }
461 
462 void ProcessMinidump::Clear() { Process::m_thread_list.Clear(); }
463 
464 bool ProcessMinidump::UpdateThreadList(ThreadList &old_thread_list,
465                                        ThreadList &new_thread_list) {
466   for (const minidump::Thread &thread : m_thread_list) {
467     LocationDescriptor context_location = thread.Context;
468 
469     // If the minidump contains an exception context, use it
470     if (m_active_exception != nullptr &&
471         m_active_exception->ThreadId == thread.ThreadId) {
472       context_location = m_active_exception->ThreadContext;
473     }
474 
475     llvm::ArrayRef<uint8_t> context;
476     if (!m_is_wow64)
477       context = m_minidump_parser->GetThreadContext(context_location);
478     else
479       context = m_minidump_parser->GetThreadContextWow64(thread);
480 
481     lldb::ThreadSP thread_sp(new ThreadMinidump(*this, thread, context));
482     new_thread_list.AddThread(thread_sp);
483   }
484   return new_thread_list.GetSize(false) > 0;
485 }
486 
487 ModuleSP ProcessMinidump::GetOrCreateModule(UUID minidump_uuid,
488                                             llvm::StringRef name,
489                                             ModuleSpec module_spec) {
490   Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_DYNAMIC_LOADER));
491   Status error;
492 
493   ModuleSP module_sp =
494       GetTarget().GetOrCreateModule(module_spec, true /* notify */, &error);
495   if (!module_sp)
496     return module_sp;
497   // We consider the module to be a match if the minidump UUID is a
498   // prefix of the actual UUID, or if either of the UUIDs are empty.
499   const auto dmp_bytes = minidump_uuid.GetBytes();
500   const auto mod_bytes = module_sp->GetUUID().GetBytes();
501   const bool match = dmp_bytes.empty() || mod_bytes.empty() ||
502                      mod_bytes.take_front(dmp_bytes.size()) == dmp_bytes;
503   if (match) {
504     LLDB_LOG(log, "Partial uuid match for {0}.", name);
505     return module_sp;
506   }
507 
508   // Breakpad generates minindump files, and if there is no GNU build
509   // ID in the binary, it will calculate a UUID by hashing first 4096
510   // bytes of the .text section and using that as the UUID for a module
511   // in the minidump. Facebook uses a modified breakpad client that
512   // uses a slightly modified this hash to avoid collisions. Check for
513   // UUIDs from the minindump that match these cases and accept the
514   // module we find if they do match.
515   std::vector<uint8_t> breakpad_uuid;
516   std::vector<uint8_t> facebook_uuid;
517   HashElfTextSection(module_sp, breakpad_uuid, facebook_uuid);
518   if (dmp_bytes == llvm::ArrayRef<uint8_t>(breakpad_uuid)) {
519     LLDB_LOG(log, "Breakpad .text hash match for {0}.", name);
520     return module_sp;
521   }
522   if (dmp_bytes == llvm::ArrayRef<uint8_t>(facebook_uuid)) {
523     LLDB_LOG(log, "Facebook .text hash match for {0}.", name);
524     return module_sp;
525   }
526   // The UUID wasn't a partial match and didn't match the .text hash
527   // so remove the module from the target, we will need to create a
528   // placeholder object file.
529   GetTarget().GetImages().Remove(module_sp);
530   module_sp.reset();
531   return module_sp;
532 }
533 
534 void ProcessMinidump::ReadModuleList() {
535   std::vector<const minidump::Module *> filtered_modules =
536       m_minidump_parser->GetFilteredModuleList();
537 
538   Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_DYNAMIC_LOADER));
539 
540   for (auto module : filtered_modules) {
541     std::string name = cantFail(m_minidump_parser->GetMinidumpFile().getString(
542         module->ModuleNameRVA));
543     const uint64_t load_addr = module->BaseOfImage;
544     const uint64_t load_size = module->SizeOfImage;
545     LLDB_LOG(log, "found module: name: {0} {1:x10}-{2:x10} size: {3}", name,
546              load_addr, load_addr + load_size, load_size);
547 
548     // check if the process is wow64 - a 32 bit windows process running on a
549     // 64 bit windows
550     if (llvm::StringRef(name).endswith_lower("wow64.dll")) {
551       m_is_wow64 = true;
552     }
553 
554     const auto uuid = m_minidump_parser->GetModuleUUID(module);
555     auto file_spec = FileSpec(name, GetArchitecture().GetTriple());
556     ModuleSpec module_spec(file_spec, uuid);
557     module_spec.GetArchitecture() = GetArchitecture();
558     Status error;
559     // Try and find a module with a full UUID that matches. This function will
560     // add the module to the target if it finds one.
561     lldb::ModuleSP module_sp = GetTarget().GetOrCreateModule(module_spec,
562                                                      true /* notify */, &error);
563     if (module_sp) {
564       LLDB_LOG(log, "Full uuid match for {0}.", name);
565     } else {
566       // We couldn't find a module with an exactly-matching UUID.  Sometimes
567       // a minidump UUID is only a partial match or is a hash.  So try again
568       // without specifying the UUID, then again without specifying the
569       // directory if that fails.  This will allow us to find modules with
570       // partial matches or hash UUIDs in user-provided sysroots or search
571       // directories (target.exec-search-paths).
572       ModuleSpec partial_module_spec = module_spec;
573       partial_module_spec.GetUUID().Clear();
574       module_sp = GetOrCreateModule(uuid, name, partial_module_spec);
575       if (!module_sp) {
576         partial_module_spec.GetFileSpec().GetDirectory().Clear();
577         module_sp = GetOrCreateModule(uuid, name, partial_module_spec);
578       }
579     }
580     if (module_sp) {
581       // Watch out for place holder modules that have different paths, but the
582       // same UUID. If the base address is different, create a new module. If
583       // we don't then we will end up setting the load address of a different
584       // PlaceholderObjectFile and an assertion will fire.
585       auto *objfile = module_sp->GetObjectFile();
586       if (objfile && objfile->GetPluginName() ==
587           PlaceholderObjectFile::GetStaticPluginName()) {
588         if (((PlaceholderObjectFile *)objfile)->GetBaseImageAddress() !=
589             load_addr)
590           module_sp.reset();
591       }
592     }
593     if (!module_sp) {
594       // We failed to locate a matching local object file. Fortunately, the
595       // minidump format encodes enough information about each module's memory
596       // range to allow us to create placeholder modules.
597       //
598       // This enables most LLDB functionality involving address-to-module
599       // translations (ex. identifing the module for a stack frame PC) and
600       // modules/sections commands (ex. target modules list, ...)
601       LLDB_LOG(log,
602                "Unable to locate the matching object file, creating a "
603                "placeholder module for: {0}",
604                name);
605 
606       module_sp = Module::CreateModuleFromObjectFile<PlaceholderObjectFile>(
607           module_spec, load_addr, load_size);
608       GetTarget().GetImages().Append(module_sp, true /* notify */);
609     }
610 
611     bool load_addr_changed = false;
612     module_sp->SetLoadAddress(GetTarget(), load_addr, false,
613                               load_addr_changed);
614   }
615 }
616 
617 bool ProcessMinidump::GetProcessInfo(ProcessInstanceInfo &info) {
618   info.Clear();
619   info.SetProcessID(GetID());
620   info.SetArchitecture(GetArchitecture());
621   lldb::ModuleSP module_sp = GetTarget().GetExecutableModule();
622   if (module_sp) {
623     const bool add_exe_file_as_first_arg = false;
624     info.SetExecutableFile(GetTarget().GetExecutableModule()->GetFileSpec(),
625                            add_exe_file_as_first_arg);
626   }
627   return true;
628 }
629 
630 // For minidumps there's no runtime generated code so we don't need JITLoader(s)
631 // Avoiding them will also speed up minidump loading since JITLoaders normally
632 // try to set up symbolic breakpoints, which in turn may force loading more
633 // debug information than needed.
634 JITLoaderList &ProcessMinidump::GetJITLoaders() {
635   if (!m_jit_loaders_up) {
636     m_jit_loaders_up = std::make_unique<JITLoaderList>();
637   }
638   return *m_jit_loaders_up;
639 }
640 
641 #define INIT_BOOL(VAR, LONG, SHORT, DESC) \
642     VAR(LLDB_OPT_SET_1, false, LONG, SHORT, DESC, false, true)
643 #define APPEND_OPT(VAR) \
644     m_option_group.Append(&VAR, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1)
645 
646 class CommandObjectProcessMinidumpDump : public CommandObjectParsed {
647 private:
648   OptionGroupOptions m_option_group;
649   OptionGroupBoolean m_dump_all;
650   OptionGroupBoolean m_dump_directory;
651   OptionGroupBoolean m_dump_linux_cpuinfo;
652   OptionGroupBoolean m_dump_linux_proc_status;
653   OptionGroupBoolean m_dump_linux_lsb_release;
654   OptionGroupBoolean m_dump_linux_cmdline;
655   OptionGroupBoolean m_dump_linux_environ;
656   OptionGroupBoolean m_dump_linux_auxv;
657   OptionGroupBoolean m_dump_linux_maps;
658   OptionGroupBoolean m_dump_linux_proc_stat;
659   OptionGroupBoolean m_dump_linux_proc_uptime;
660   OptionGroupBoolean m_dump_linux_proc_fd;
661   OptionGroupBoolean m_dump_linux_all;
662   OptionGroupBoolean m_fb_app_data;
663   OptionGroupBoolean m_fb_build_id;
664   OptionGroupBoolean m_fb_version;
665   OptionGroupBoolean m_fb_java_stack;
666   OptionGroupBoolean m_fb_dalvik;
667   OptionGroupBoolean m_fb_unwind;
668   OptionGroupBoolean m_fb_error_log;
669   OptionGroupBoolean m_fb_app_state;
670   OptionGroupBoolean m_fb_abort;
671   OptionGroupBoolean m_fb_thread;
672   OptionGroupBoolean m_fb_logcat;
673   OptionGroupBoolean m_fb_all;
674 
675   void SetDefaultOptionsIfNoneAreSet() {
676     if (m_dump_all.GetOptionValue().GetCurrentValue() ||
677         m_dump_linux_all.GetOptionValue().GetCurrentValue() ||
678         m_fb_all.GetOptionValue().GetCurrentValue() ||
679         m_dump_directory.GetOptionValue().GetCurrentValue() ||
680         m_dump_linux_cpuinfo.GetOptionValue().GetCurrentValue() ||
681         m_dump_linux_proc_status.GetOptionValue().GetCurrentValue() ||
682         m_dump_linux_lsb_release.GetOptionValue().GetCurrentValue() ||
683         m_dump_linux_cmdline.GetOptionValue().GetCurrentValue() ||
684         m_dump_linux_environ.GetOptionValue().GetCurrentValue() ||
685         m_dump_linux_auxv.GetOptionValue().GetCurrentValue() ||
686         m_dump_linux_maps.GetOptionValue().GetCurrentValue() ||
687         m_dump_linux_proc_stat.GetOptionValue().GetCurrentValue() ||
688         m_dump_linux_proc_uptime.GetOptionValue().GetCurrentValue() ||
689         m_dump_linux_proc_fd.GetOptionValue().GetCurrentValue() ||
690         m_fb_app_data.GetOptionValue().GetCurrentValue() ||
691         m_fb_build_id.GetOptionValue().GetCurrentValue() ||
692         m_fb_version.GetOptionValue().GetCurrentValue() ||
693         m_fb_java_stack.GetOptionValue().GetCurrentValue() ||
694         m_fb_dalvik.GetOptionValue().GetCurrentValue() ||
695         m_fb_unwind.GetOptionValue().GetCurrentValue() ||
696         m_fb_error_log.GetOptionValue().GetCurrentValue() ||
697         m_fb_app_state.GetOptionValue().GetCurrentValue() ||
698         m_fb_abort.GetOptionValue().GetCurrentValue() ||
699         m_fb_thread.GetOptionValue().GetCurrentValue() ||
700         m_fb_logcat.GetOptionValue().GetCurrentValue())
701       return;
702     // If no options were set, then dump everything
703     m_dump_all.GetOptionValue().SetCurrentValue(true);
704   }
705   bool DumpAll() const {
706     return m_dump_all.GetOptionValue().GetCurrentValue();
707   }
708   bool DumpDirectory() const {
709     return DumpAll() ||
710         m_dump_directory.GetOptionValue().GetCurrentValue();
711   }
712   bool DumpLinux() const {
713     return DumpAll() || m_dump_linux_all.GetOptionValue().GetCurrentValue();
714   }
715   bool DumpLinuxCPUInfo() const {
716     return DumpLinux() ||
717         m_dump_linux_cpuinfo.GetOptionValue().GetCurrentValue();
718   }
719   bool DumpLinuxProcStatus() const {
720     return DumpLinux() ||
721         m_dump_linux_proc_status.GetOptionValue().GetCurrentValue();
722   }
723   bool DumpLinuxProcStat() const {
724     return DumpLinux() ||
725         m_dump_linux_proc_stat.GetOptionValue().GetCurrentValue();
726   }
727   bool DumpLinuxLSBRelease() const {
728     return DumpLinux() ||
729         m_dump_linux_lsb_release.GetOptionValue().GetCurrentValue();
730   }
731   bool DumpLinuxCMDLine() const {
732     return DumpLinux() ||
733         m_dump_linux_cmdline.GetOptionValue().GetCurrentValue();
734   }
735   bool DumpLinuxEnviron() const {
736     return DumpLinux() ||
737         m_dump_linux_environ.GetOptionValue().GetCurrentValue();
738   }
739   bool DumpLinuxAuxv() const {
740     return DumpLinux() ||
741         m_dump_linux_auxv.GetOptionValue().GetCurrentValue();
742   }
743   bool DumpLinuxMaps() const {
744     return DumpLinux() ||
745         m_dump_linux_maps.GetOptionValue().GetCurrentValue();
746   }
747   bool DumpLinuxProcUptime() const {
748     return DumpLinux() ||
749         m_dump_linux_proc_uptime.GetOptionValue().GetCurrentValue();
750   }
751   bool DumpLinuxProcFD() const {
752     return DumpLinux() ||
753         m_dump_linux_proc_fd.GetOptionValue().GetCurrentValue();
754   }
755   bool DumpFacebook() const {
756     return DumpAll() || m_fb_all.GetOptionValue().GetCurrentValue();
757   }
758   bool DumpFacebookAppData() const {
759     return DumpFacebook() || m_fb_app_data.GetOptionValue().GetCurrentValue();
760   }
761   bool DumpFacebookBuildID() const {
762     return DumpFacebook() || m_fb_build_id.GetOptionValue().GetCurrentValue();
763   }
764   bool DumpFacebookVersionName() const {
765     return DumpFacebook() || m_fb_version.GetOptionValue().GetCurrentValue();
766   }
767   bool DumpFacebookJavaStack() const {
768     return DumpFacebook() || m_fb_java_stack.GetOptionValue().GetCurrentValue();
769   }
770   bool DumpFacebookDalvikInfo() const {
771     return DumpFacebook() || m_fb_dalvik.GetOptionValue().GetCurrentValue();
772   }
773   bool DumpFacebookUnwindSymbols() const {
774     return DumpFacebook() || m_fb_unwind.GetOptionValue().GetCurrentValue();
775   }
776   bool DumpFacebookErrorLog() const {
777     return DumpFacebook() || m_fb_error_log.GetOptionValue().GetCurrentValue();
778   }
779   bool DumpFacebookAppStateLog() const {
780     return DumpFacebook() || m_fb_app_state.GetOptionValue().GetCurrentValue();
781   }
782   bool DumpFacebookAbortReason() const {
783     return DumpFacebook() || m_fb_abort.GetOptionValue().GetCurrentValue();
784   }
785   bool DumpFacebookThreadName() const {
786     return DumpFacebook() || m_fb_thread.GetOptionValue().GetCurrentValue();
787   }
788   bool DumpFacebookLogcat() const {
789     return DumpFacebook() || m_fb_logcat.GetOptionValue().GetCurrentValue();
790   }
791 public:
792   CommandObjectProcessMinidumpDump(CommandInterpreter &interpreter)
793   : CommandObjectParsed(interpreter, "process plugin dump",
794       "Dump information from the minidump file.", nullptr),
795     m_option_group(),
796     INIT_BOOL(m_dump_all, "all", 'a',
797               "Dump the everything in the minidump."),
798     INIT_BOOL(m_dump_directory, "directory", 'd',
799               "Dump the minidump directory map."),
800     INIT_BOOL(m_dump_linux_cpuinfo, "cpuinfo", 'C',
801               "Dump linux /proc/cpuinfo."),
802     INIT_BOOL(m_dump_linux_proc_status, "status", 's',
803               "Dump linux /proc/<pid>/status."),
804     INIT_BOOL(m_dump_linux_lsb_release, "lsb-release", 'r',
805               "Dump linux /etc/lsb-release."),
806     INIT_BOOL(m_dump_linux_cmdline, "cmdline", 'c',
807               "Dump linux /proc/<pid>/cmdline."),
808     INIT_BOOL(m_dump_linux_environ, "environ", 'e',
809               "Dump linux /proc/<pid>/environ."),
810     INIT_BOOL(m_dump_linux_auxv, "auxv", 'x',
811               "Dump linux /proc/<pid>/auxv."),
812     INIT_BOOL(m_dump_linux_maps, "maps", 'm',
813               "Dump linux /proc/<pid>/maps."),
814     INIT_BOOL(m_dump_linux_proc_stat, "stat", 'S',
815               "Dump linux /proc/<pid>/stat."),
816     INIT_BOOL(m_dump_linux_proc_uptime, "uptime", 'u',
817               "Dump linux process uptime."),
818     INIT_BOOL(m_dump_linux_proc_fd, "fd", 'f',
819               "Dump linux /proc/<pid>/fd."),
820     INIT_BOOL(m_dump_linux_all, "linux", 'l',
821               "Dump all linux streams."),
822     INIT_BOOL(m_fb_app_data, "fb-app-data", 1,
823               "Dump Facebook application custom data."),
824     INIT_BOOL(m_fb_build_id, "fb-build-id", 2,
825               "Dump the Facebook build ID."),
826     INIT_BOOL(m_fb_version, "fb-version", 3,
827               "Dump Facebook application version string."),
828     INIT_BOOL(m_fb_java_stack, "fb-java-stack", 4,
829               "Dump Facebook java stack."),
830     INIT_BOOL(m_fb_dalvik, "fb-dalvik-info", 5,
831               "Dump Facebook Dalvik info."),
832     INIT_BOOL(m_fb_unwind, "fb-unwind-symbols", 6,
833               "Dump Facebook unwind symbols."),
834     INIT_BOOL(m_fb_error_log, "fb-error-log", 7,
835               "Dump Facebook error log."),
836     INIT_BOOL(m_fb_app_state, "fb-app-state-log", 8,
837               "Dump Facebook java stack."),
838     INIT_BOOL(m_fb_abort, "fb-abort-reason", 9,
839               "Dump Facebook abort reason."),
840     INIT_BOOL(m_fb_thread, "fb-thread-name", 10,
841               "Dump Facebook thread name."),
842     INIT_BOOL(m_fb_logcat, "fb-logcat", 11,
843               "Dump Facebook logcat."),
844     INIT_BOOL(m_fb_all, "facebook", 12, "Dump all Facebook streams.") {
845     APPEND_OPT(m_dump_all);
846     APPEND_OPT(m_dump_directory);
847     APPEND_OPT(m_dump_linux_cpuinfo);
848     APPEND_OPT(m_dump_linux_proc_status);
849     APPEND_OPT(m_dump_linux_lsb_release);
850     APPEND_OPT(m_dump_linux_cmdline);
851     APPEND_OPT(m_dump_linux_environ);
852     APPEND_OPT(m_dump_linux_auxv);
853     APPEND_OPT(m_dump_linux_maps);
854     APPEND_OPT(m_dump_linux_proc_stat);
855     APPEND_OPT(m_dump_linux_proc_uptime);
856     APPEND_OPT(m_dump_linux_proc_fd);
857     APPEND_OPT(m_dump_linux_all);
858     APPEND_OPT(m_fb_app_data);
859     APPEND_OPT(m_fb_build_id);
860     APPEND_OPT(m_fb_version);
861     APPEND_OPT(m_fb_java_stack);
862     APPEND_OPT(m_fb_dalvik);
863     APPEND_OPT(m_fb_unwind);
864     APPEND_OPT(m_fb_error_log);
865     APPEND_OPT(m_fb_app_state);
866     APPEND_OPT(m_fb_abort);
867     APPEND_OPT(m_fb_thread);
868     APPEND_OPT(m_fb_logcat);
869     APPEND_OPT(m_fb_all);
870     m_option_group.Finalize();
871   }
872 
873   ~CommandObjectProcessMinidumpDump() override {}
874 
875   Options *GetOptions() override { return &m_option_group; }
876 
877   bool DoExecute(Args &command, CommandReturnObject &result) override {
878     const size_t argc = command.GetArgumentCount();
879     if (argc > 0) {
880       result.AppendErrorWithFormat("'%s' take no arguments, only options",
881                                    m_cmd_name.c_str());
882       result.SetStatus(eReturnStatusFailed);
883       return false;
884     }
885     SetDefaultOptionsIfNoneAreSet();
886 
887     ProcessMinidump *process = static_cast<ProcessMinidump *>(
888         m_interpreter.GetExecutionContext().GetProcessPtr());
889     result.SetStatus(eReturnStatusSuccessFinishResult);
890     Stream &s = result.GetOutputStream();
891     MinidumpParser &minidump = *process->m_minidump_parser;
892     if (DumpDirectory()) {
893       s.Printf("RVA        SIZE       TYPE       StreamType\n");
894       s.Printf("---------- ---------- ---------- --------------------------\n");
895       for (const auto &stream_desc : minidump.GetMinidumpFile().streams())
896         s.Printf(
897             "0x%8.8x 0x%8.8x 0x%8.8x %s\n", (uint32_t)stream_desc.Location.RVA,
898             (uint32_t)stream_desc.Location.DataSize,
899             (unsigned)(StreamType)stream_desc.Type,
900             MinidumpParser::GetStreamTypeAsString(stream_desc.Type).data());
901       s.Printf("\n");
902     }
903     auto DumpTextStream = [&](StreamType stream_type,
904                               llvm::StringRef label) -> void {
905       auto bytes = minidump.GetStream(stream_type);
906       if (!bytes.empty()) {
907         if (label.empty())
908           label = MinidumpParser::GetStreamTypeAsString(stream_type);
909         s.Printf("%s:\n%s\n\n", label.data(), bytes.data());
910       }
911     };
912     auto DumpBinaryStream = [&](StreamType stream_type,
913                                 llvm::StringRef label) -> void {
914       auto bytes = minidump.GetStream(stream_type);
915       if (!bytes.empty()) {
916         if (label.empty())
917           label = MinidumpParser::GetStreamTypeAsString(stream_type);
918         s.Printf("%s:\n", label.data());
919         DataExtractor data(bytes.data(), bytes.size(), eByteOrderLittle,
920                            process->GetAddressByteSize());
921         DumpDataExtractor(data, &s, 0, lldb::eFormatBytesWithASCII, 1,
922                           bytes.size(), 16, 0, 0, 0);
923         s.Printf("\n\n");
924       }
925     };
926 
927     if (DumpLinuxCPUInfo())
928       DumpTextStream(StreamType::LinuxCPUInfo, "/proc/cpuinfo");
929     if (DumpLinuxProcStatus())
930       DumpTextStream(StreamType::LinuxProcStatus, "/proc/PID/status");
931     if (DumpLinuxLSBRelease())
932       DumpTextStream(StreamType::LinuxLSBRelease, "/etc/lsb-release");
933     if (DumpLinuxCMDLine())
934       DumpTextStream(StreamType::LinuxCMDLine, "/proc/PID/cmdline");
935     if (DumpLinuxEnviron())
936       DumpTextStream(StreamType::LinuxEnviron, "/proc/PID/environ");
937     if (DumpLinuxAuxv())
938       DumpBinaryStream(StreamType::LinuxAuxv, "/proc/PID/auxv");
939     if (DumpLinuxMaps())
940       DumpTextStream(StreamType::LinuxMaps, "/proc/PID/maps");
941     if (DumpLinuxProcStat())
942       DumpTextStream(StreamType::LinuxProcStat, "/proc/PID/stat");
943     if (DumpLinuxProcUptime())
944       DumpTextStream(StreamType::LinuxProcUptime, "uptime");
945     if (DumpLinuxProcFD())
946       DumpTextStream(StreamType::LinuxProcFD, "/proc/PID/fd");
947     if (DumpFacebookAppData())
948       DumpTextStream(StreamType::FacebookAppCustomData,
949                      "Facebook App Data");
950     if (DumpFacebookBuildID()) {
951       auto bytes = minidump.GetStream(StreamType::FacebookBuildID);
952       if (bytes.size() >= 4) {
953         DataExtractor data(bytes.data(), bytes.size(), eByteOrderLittle,
954                            process->GetAddressByteSize());
955         lldb::offset_t offset = 0;
956         uint32_t build_id = data.GetU32(&offset);
957         s.Printf("Facebook Build ID:\n");
958         s.Printf("%u\n", build_id);
959         s.Printf("\n");
960       }
961     }
962     if (DumpFacebookVersionName())
963       DumpTextStream(StreamType::FacebookAppVersionName,
964                      "Facebook Version String");
965     if (DumpFacebookJavaStack())
966       DumpTextStream(StreamType::FacebookJavaStack,
967                      "Facebook Java Stack");
968     if (DumpFacebookDalvikInfo())
969       DumpTextStream(StreamType::FacebookDalvikInfo,
970                      "Facebook Dalvik Info");
971     if (DumpFacebookUnwindSymbols())
972       DumpBinaryStream(StreamType::FacebookUnwindSymbols,
973                        "Facebook Unwind Symbols Bytes");
974     if (DumpFacebookErrorLog())
975       DumpTextStream(StreamType::FacebookDumpErrorLog,
976                      "Facebook Error Log");
977     if (DumpFacebookAppStateLog())
978       DumpTextStream(StreamType::FacebookAppStateLog,
979                      "Faceook Application State Log");
980     if (DumpFacebookAbortReason())
981       DumpTextStream(StreamType::FacebookAbortReason,
982                      "Facebook Abort Reason");
983     if (DumpFacebookThreadName())
984       DumpTextStream(StreamType::FacebookThreadName,
985                      "Facebook Thread Name");
986     if (DumpFacebookLogcat())
987       DumpTextStream(StreamType::FacebookLogcat,
988                      "Facebook Logcat");
989     return true;
990   }
991 };
992 
993 class CommandObjectMultiwordProcessMinidump : public CommandObjectMultiword {
994 public:
995   CommandObjectMultiwordProcessMinidump(CommandInterpreter &interpreter)
996     : CommandObjectMultiword(interpreter, "process plugin",
997           "Commands for operating on a ProcessMinidump process.",
998           "process plugin <subcommand> [<subcommand-options>]") {
999     LoadSubCommand("dump",
1000         CommandObjectSP(new CommandObjectProcessMinidumpDump(interpreter)));
1001   }
1002 
1003   ~CommandObjectMultiwordProcessMinidump() override {}
1004 };
1005 
1006 CommandObject *ProcessMinidump::GetPluginCommandObject() {
1007   if (!m_command_sp)
1008     m_command_sp = std::make_shared<CommandObjectMultiwordProcessMinidump>(
1009         GetTarget().GetDebugger().GetCommandInterpreter());
1010   return m_command_sp.get();
1011 }
1012