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