1 //===-- ProcessElfCore.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 // Notes about Linux Process core dumps: 8 // 1) Linux core dump is stored as ELF file. 9 // 2) The ELF file's PT_NOTE and PT_LOAD segments describes the program's 10 // address space and thread contexts. 11 // 3) PT_NOTE segment contains note entries which describes a thread context. 12 // 4) PT_LOAD segment describes a valid contiguous range of process address 13 // space. 14 //===----------------------------------------------------------------------===// 15 16 #ifndef LLDB_SOURCE_PLUGINS_PROCESS_ELF_CORE_PROCESSELFCORE_H 17 #define LLDB_SOURCE_PLUGINS_PROCESS_ELF_CORE_PROCESSELFCORE_H 18 19 #include <list> 20 #include <vector> 21 22 #include "lldb/Target/PostMortemProcess.h" 23 #include "lldb/Utility/ConstString.h" 24 #include "lldb/Utility/Status.h" 25 26 #include "Plugins/ObjectFile/ELF/ELFHeader.h" 27 #include "Plugins/Process/elf-core/RegisterUtilities.h" 28 29 struct ThreadData; 30 31 class ProcessElfCore : public lldb_private::PostMortemProcess { 32 public: 33 // Constructors and Destructors 34 static lldb::ProcessSP 35 CreateInstance(lldb::TargetSP target_sp, lldb::ListenerSP listener_sp, 36 const lldb_private::FileSpec *crash_file_path, 37 bool can_connect); 38 39 static void Initialize(); 40 41 static void Terminate(); 42 43 static llvm::StringRef GetPluginNameStatic() { return "elf-core"; } 44 45 static llvm::StringRef GetPluginDescriptionStatic(); 46 47 // Constructors and Destructors 48 ProcessElfCore(lldb::TargetSP target_sp, lldb::ListenerSP listener_sp, 49 const lldb_private::FileSpec &core_file); 50 51 ~ProcessElfCore() override; 52 53 // Check if a given Process 54 bool CanDebug(lldb::TargetSP target_sp, 55 bool plugin_specified_by_name) override; 56 57 // Creating a new process, or attaching to an existing one 58 lldb_private::Status DoLoadCore() override; 59 60 lldb_private::DynamicLoader *GetDynamicLoader() override; 61 62 // PluginInterface protocol 63 llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); } 64 65 // Process Control 66 lldb_private::Status DoDestroy() override; 67 68 void RefreshStateAfterStop() override; 69 70 lldb_private::Status WillResume() override { 71 lldb_private::Status error; 72 error.SetErrorStringWithFormatv( 73 "error: {0} does not support resuming processes", GetPluginName()); 74 return error; 75 } 76 77 // Process Queries 78 bool IsAlive() override; 79 80 bool WarnBeforeDetach() const override { return false; } 81 82 // Process Memory 83 size_t ReadMemory(lldb::addr_t addr, void *buf, size_t size, 84 lldb_private::Status &error) override; 85 86 size_t DoReadMemory(lldb::addr_t addr, void *buf, size_t size, 87 lldb_private::Status &error) override; 88 89 lldb::addr_t GetImageInfoAddress() override; 90 91 lldb_private::ArchSpec GetArchitecture(); 92 93 // Returns AUXV structure found in the core file 94 lldb_private::DataExtractor GetAuxvData() override; 95 96 bool GetProcessInfo(lldb_private::ProcessInstanceInfo &info) override; 97 98 protected: 99 void Clear(); 100 101 bool DoUpdateThreadList(lldb_private::ThreadList &old_thread_list, 102 lldb_private::ThreadList &new_thread_list) override; 103 104 lldb_private::Status 105 DoGetMemoryRegionInfo(lldb::addr_t load_addr, 106 lldb_private::MemoryRegionInfo ®ion_info) override; 107 108 private: 109 struct NT_FILE_Entry { 110 lldb::addr_t start; 111 lldb::addr_t end; 112 lldb::addr_t file_ofs; 113 lldb_private::ConstString path; 114 }; 115 116 // For ProcessElfCore only 117 typedef lldb_private::Range<lldb::addr_t, lldb::addr_t> FileRange; 118 typedef lldb_private::RangeDataVector<lldb::addr_t, lldb::addr_t, FileRange> 119 VMRangeToFileOffset; 120 typedef lldb_private::RangeDataVector<lldb::addr_t, lldb::addr_t, uint32_t> 121 VMRangeToPermissions; 122 123 lldb::ModuleSP m_core_module_sp; 124 lldb_private::FileSpec m_core_file; 125 std::string m_dyld_plugin_name; 126 127 // True if m_thread_contexts contains valid entries 128 bool m_thread_data_valid = false; 129 130 // Contain thread data read from NOTE segments 131 std::vector<ThreadData> m_thread_data; 132 133 // AUXV structure found from the NOTE segment 134 lldb_private::DataExtractor m_auxv; 135 136 // Address ranges found in the core 137 VMRangeToFileOffset m_core_aranges; 138 139 // Permissions for all ranges 140 VMRangeToPermissions m_core_range_infos; 141 142 // NT_FILE entries found from the NOTE segment 143 std::vector<NT_FILE_Entry> m_nt_file_entries; 144 145 // Parse thread(s) data structures(prstatus, prpsinfo) from given NOTE segment 146 llvm::Error ParseThreadContextsFromNoteSegment( 147 const elf::ELFProgramHeader &segment_header, 148 const lldb_private::DataExtractor &segment_data); 149 150 // Returns number of thread contexts stored in the core file 151 uint32_t GetNumThreadContexts(); 152 153 // Parse a contiguous address range of the process from LOAD segment 154 lldb::addr_t 155 AddAddressRangeFromLoadSegment(const elf::ELFProgramHeader &header); 156 157 llvm::Expected<std::vector<lldb_private::CoreNote>> 158 parseSegment(const lldb_private::DataExtractor &segment); 159 llvm::Error parseFreeBSDNotes(llvm::ArrayRef<lldb_private::CoreNote> notes); 160 llvm::Error parseNetBSDNotes(llvm::ArrayRef<lldb_private::CoreNote> notes); 161 llvm::Error parseOpenBSDNotes(llvm::ArrayRef<lldb_private::CoreNote> notes); 162 llvm::Error parseLinuxNotes(llvm::ArrayRef<lldb_private::CoreNote> notes); 163 }; 164 165 #endif // LLDB_SOURCE_PLUGINS_PROCESS_ELF_CORE_PROCESSELFCORE_H 166