1 //===-- MinidumpParser.h -----------------------------------------*- C++-*-===// 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 #ifndef LLDB_SOURCE_PLUGINS_PROCESS_MINIDUMP_MINIDUMPPARSER_H 10 #define LLDB_SOURCE_PLUGINS_PROCESS_MINIDUMP_MINIDUMPPARSER_H 11 12 #include "MinidumpTypes.h" 13 14 #include "lldb/Target/MemoryRegionInfo.h" 15 #include "lldb/Utility/ArchSpec.h" 16 #include "lldb/Utility/DataBuffer.h" 17 #include "lldb/Utility/Status.h" 18 #include "lldb/Utility/UUID.h" 19 20 #include "llvm/ADT/ArrayRef.h" 21 #include "llvm/ADT/DenseMap.h" 22 #include "llvm/ADT/StringRef.h" 23 #include "llvm/Object/Minidump.h" 24 25 // C includes 26 27 // C++ includes 28 #include <cstring> 29 #include <optional> 30 #include <unordered_map> 31 32 namespace lldb_private { 33 34 namespace minidump { 35 36 // Describes a range of memory captured in the Minidump 37 struct Range { 38 lldb::addr_t start; // virtual address of the beginning of the range 39 // range_ref - absolute pointer to the first byte of the range and size 40 llvm::ArrayRef<uint8_t> range_ref; 41 42 Range(lldb::addr_t start, llvm::ArrayRef<uint8_t> range_ref) 43 : start(start), range_ref(range_ref) {} 44 45 friend bool operator==(const Range &lhs, const Range &rhs) { 46 return lhs.start == rhs.start && lhs.range_ref == rhs.range_ref; 47 } 48 }; 49 50 class MinidumpParser { 51 public: 52 static llvm::Expected<MinidumpParser> 53 Create(const lldb::DataBufferSP &data_buf_sp); 54 55 llvm::ArrayRef<uint8_t> GetData(); 56 57 llvm::ArrayRef<uint8_t> GetStream(StreamType stream_type); 58 59 UUID GetModuleUUID(const minidump::Module *module); 60 61 llvm::ArrayRef<minidump::Thread> GetThreads(); 62 63 llvm::ArrayRef<uint8_t> GetThreadContext(const LocationDescriptor &location); 64 65 llvm::ArrayRef<uint8_t> GetThreadContext(const minidump::Thread &td); 66 67 llvm::ArrayRef<uint8_t> GetThreadContextWow64(const minidump::Thread &td); 68 69 ArchSpec GetArchitecture(); 70 71 const MinidumpMiscInfo *GetMiscInfo(); 72 73 std::optional<LinuxProcStatus> GetLinuxProcStatus(); 74 75 std::optional<lldb::pid_t> GetPid(); 76 77 llvm::ArrayRef<minidump::Module> GetModuleList(); 78 79 // There are cases in which there is more than one record in the ModuleList 80 // for the same module name.(e.g. when the binary has non contiguous segments) 81 // So this function returns a filtered module list - if it finds records that 82 // have the same name, it keeps the copy with the lowest load address. 83 std::vector<const minidump::Module *> GetFilteredModuleList(); 84 85 const llvm::minidump::ExceptionStream *GetExceptionStream(); 86 87 std::optional<Range> FindMemoryRange(lldb::addr_t addr); 88 89 llvm::ArrayRef<uint8_t> GetMemory(lldb::addr_t addr, size_t size); 90 91 /// Returns a list of memory regions and a flag indicating whether the list is 92 /// complete (includes all regions mapped into the process memory). 93 std::pair<MemoryRegionInfos, bool> BuildMemoryRegions(); 94 95 static llvm::StringRef GetStreamTypeAsString(StreamType stream_type); 96 97 llvm::object::MinidumpFile &GetMinidumpFile() { return *m_file; } 98 99 static MemoryRegionInfo GetMemoryRegionInfo(const MemoryRegionInfos ®ions, 100 lldb::addr_t load_addr); 101 102 private: 103 MinidumpParser(lldb::DataBufferSP data_sp, 104 std::unique_ptr<llvm::object::MinidumpFile> file); 105 106 lldb::DataBufferSP m_data_sp; 107 std::unique_ptr<llvm::object::MinidumpFile> m_file; 108 ArchSpec m_arch; 109 }; 110 111 } // end namespace minidump 112 } // end namespace lldb_private 113 #endif // LLDB_SOURCE_PLUGINS_PROCESS_MINIDUMP_MINIDUMPPARSER_H 114