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 lldb_private::ConstString GetPluginNameStatic(); 44 45 static const char *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 lldb_private::ConstString GetPluginName() override; 64 65 uint32_t GetPluginVersion() override; 66 67 // Process Control 68 lldb_private::Status DoDestroy() override; 69 70 void RefreshStateAfterStop() override; 71 WillResume()72 lldb_private::Status WillResume() override { 73 lldb_private::Status error; 74 error.SetErrorStringWithFormat( 75 "error: %s does not support resuming processes", 76 GetPluginName().GetCString()); 77 return error; 78 } 79 80 // Process Queries 81 bool IsAlive() override; 82 WarnBeforeDetach()83 bool WarnBeforeDetach() const override { return false; } 84 85 // Process Memory 86 size_t ReadMemory(lldb::addr_t addr, void *buf, size_t size, 87 lldb_private::Status &error) override; 88 89 size_t DoReadMemory(lldb::addr_t addr, void *buf, size_t size, 90 lldb_private::Status &error) override; 91 92 lldb_private::Status 93 GetMemoryRegionInfo(lldb::addr_t load_addr, 94 lldb_private::MemoryRegionInfo ®ion_info) override; 95 96 lldb::addr_t GetImageInfoAddress() override; 97 98 lldb_private::ArchSpec GetArchitecture(); 99 100 // Returns AUXV structure found in the core file 101 lldb_private::DataExtractor GetAuxvData() override; 102 103 bool GetProcessInfo(lldb_private::ProcessInstanceInfo &info) override; 104 105 protected: 106 void Clear(); 107 108 bool DoUpdateThreadList(lldb_private::ThreadList &old_thread_list, 109 lldb_private::ThreadList &new_thread_list) override; 110 111 private: 112 struct NT_FILE_Entry { 113 lldb::addr_t start; 114 lldb::addr_t end; 115 lldb::addr_t file_ofs; 116 lldb_private::ConstString path; 117 }; 118 119 // For ProcessElfCore only 120 typedef lldb_private::Range<lldb::addr_t, lldb::addr_t> FileRange; 121 typedef lldb_private::RangeDataVector<lldb::addr_t, lldb::addr_t, FileRange> 122 VMRangeToFileOffset; 123 typedef lldb_private::RangeDataVector<lldb::addr_t, lldb::addr_t, uint32_t> 124 VMRangeToPermissions; 125 126 lldb::ModuleSP m_core_module_sp; 127 lldb_private::FileSpec m_core_file; 128 std::string m_dyld_plugin_name; 129 130 // True if m_thread_contexts contains valid entries 131 bool m_thread_data_valid = false; 132 133 // Contain thread data read from NOTE segments 134 std::vector<ThreadData> m_thread_data; 135 136 // AUXV structure found from the NOTE segment 137 lldb_private::DataExtractor m_auxv; 138 139 // Address ranges found in the core 140 VMRangeToFileOffset m_core_aranges; 141 142 // Permissions for all ranges 143 VMRangeToPermissions m_core_range_infos; 144 145 // NT_FILE entries found from the NOTE segment 146 std::vector<NT_FILE_Entry> m_nt_file_entries; 147 148 // Parse thread(s) data structures(prstatus, prpsinfo) from given NOTE segment 149 llvm::Error ParseThreadContextsFromNoteSegment( 150 const elf::ELFProgramHeader &segment_header, 151 lldb_private::DataExtractor segment_data); 152 153 // Returns number of thread contexts stored in the core file 154 uint32_t GetNumThreadContexts(); 155 156 // Parse a contiguous address range of the process from LOAD segment 157 lldb::addr_t 158 AddAddressRangeFromLoadSegment(const elf::ELFProgramHeader &header); 159 160 llvm::Expected<std::vector<lldb_private::CoreNote>> 161 parseSegment(const lldb_private::DataExtractor &segment); 162 llvm::Error parseFreeBSDNotes(llvm::ArrayRef<lldb_private::CoreNote> notes); 163 llvm::Error parseNetBSDNotes(llvm::ArrayRef<lldb_private::CoreNote> notes); 164 llvm::Error parseOpenBSDNotes(llvm::ArrayRef<lldb_private::CoreNote> notes); 165 llvm::Error parseLinuxNotes(llvm::ArrayRef<lldb_private::CoreNote> notes); 166 }; 167 168 #endif // LLDB_SOURCE_PLUGINS_PROCESS_ELF_CORE_PROCESSELFCORE_H 169