LLDB  mainline
ProcessElfCore.h
Go to the documentation of this file.
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 
24 #include "lldb/Utility/Status.h"
25 
28 
29 struct ThreadData;
30 
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 
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
59 
61 
62  // PluginInterface protocol
64 
65  uint32_t GetPluginVersion() override;
66 
67  // Process Control
69 
70  void RefreshStateAfterStop() override;
71 
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 
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 
94  lldb_private::MemoryRegionInfo &region_info) override;
95 
97 
99 
100  // Returns AUXV structure found in the core file
102 
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 {
117  };
118 
119  // For ProcessElfCore only
125 
126  lldb::ModuleSP m_core_module_sp;
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
138 
139  // Address ranges found in the core
141 
142  // Permissions for all ranges
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
150  const elf::ELFProgramHeader &segment_header,
151  lldb_private::DataExtractor segment_data);
152 
153  // Returns number of thread contexts stored in the core file
155 
156  // Parse a contiguous address range of the process from LOAD segment
159 
160  llvm::Expected<std::vector<lldb_private::CoreNote>>
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
lldb_private::ProcessInstanceInfo
Definition: ProcessInfo.h:108
ProcessElfCore::Initialize
static void Initialize()
Definition: ProcessElfCore.cpp:386
ProcessElfCore::GetAuxvData
lldb_private::DataExtractor GetAuxvData() override
Definition: ProcessElfCore.cpp:918
lldb_private::ArchSpec
Definition: ArchSpec.h:33
ProcessElfCore::parseLinuxNotes
llvm::Error parseLinuxNotes(llvm::ArrayRef< lldb_private::CoreNote > notes)
A description of a linux process usually contains the following NOTE entries:
Definition: ProcessElfCore.cpp:786
ProcessElfCore::GetPluginNameStatic
static lldb_private::ConstString GetPluginNameStatic()
Definition: ProcessElfCore.cpp:40
ProcessElfCore::GetPluginName
lldb_private::ConstString GetPluginName() override
Definition: ProcessElfCore.cpp:114
ProcessElfCore::ReadMemory
size_t ReadMemory(lldb::addr_t addr, void *buf, size_t size, lldb_private::Status &error) override
Read of memory from a process.
Definition: ProcessElfCore.cpp:287
ProcessElfCore::AddAddressRangeFromLoadSegment
lldb::addr_t AddAddressRangeFromLoadSegment(const elf::ELFProgramHeader &header)
Definition: ProcessElfCore.cpp:118
ProcessElfCore::m_dyld_plugin_name
std::string m_dyld_plugin_name
Definition: ProcessElfCore.h:128
ProcessElfCore::m_core_file
lldb_private::FileSpec m_core_file
Definition: ProcessElfCore.h:127
ProcessElfCore::IsAlive
bool IsAlive() override
Check if a process is still alive.
Definition: ProcessElfCore.cpp:284
ProcessElfCore::RefreshStateAfterStop
void RefreshStateAfterStop() override
Currently called as part of ShouldStop.
Definition: ProcessElfCore.cpp:278
ProcessElfCore::WillResume
lldb_private::Status WillResume() override
Called before resuming to a process.
Definition: ProcessElfCore.h:72
RegisterUtilities.h
ProcessElfCore::m_core_range_infos
VMRangeToPermissions m_core_range_infos
Definition: ProcessElfCore.h:143
ProcessElfCore::m_thread_data_valid
bool m_thread_data_valid
Definition: ProcessElfCore.h:131
lldb_private::MemoryRegionInfo
Definition: MemoryRegionInfo.h:18
lldb::addr_t
uint64_t addr_t
Definition: lldb-types.h:83
ProcessElfCore::DoLoadCore
lldb_private::Status DoLoadCore() override
Definition: ProcessElfCore.cpp:152
ProcessElfCore::m_core_aranges
VMRangeToFileOffset m_core_aranges
Definition: ProcessElfCore.h:140
ProcessElfCore::NT_FILE_Entry
Definition: ProcessElfCore.h:112
ProcessElfCore::GetDynamicLoader
lldb_private::DynamicLoader * GetDynamicLoader() override
Get the dynamic loader plug-in for this process.
Definition: ProcessElfCore.cpp:257
ELFHeader.h
ProcessElfCore::GetImageInfoAddress
lldb::addr_t GetImageInfoAddress() override
Get the image information address for the current process.
Definition: ProcessElfCore.cpp:395
ProcessElfCore::VMRangeToFileOffset
lldb_private::RangeDataVector< lldb::addr_t, lldb::addr_t, FileRange > VMRangeToFileOffset
Definition: ProcessElfCore.h:122
lldb_private::FileSpec
Definition: FileSpec.h:56
error
static llvm::raw_ostream & error(Stream &strm)
Definition: CommandReturnObject.cpp:17
ProcessElfCore::GetPluginVersion
uint32_t GetPluginVersion() override
Definition: ProcessElfCore.cpp:116
ProcessElfCore::Terminate
static void Terminate()
Definition: ProcessElfCore.cpp:49
ProcessElfCore::ParseThreadContextsFromNoteSegment
llvm::Error ParseThreadContextsFromNoteSegment(const elf::ELFProgramHeader &segment_header, lldb_private::DataExtractor segment_data)
Parse Thread context from PT_NOTE segment and store it in the thread list A note segment consists of ...
Definition: ProcessElfCore.cpp:873
lldb_private::DataExtractor
Definition: DataExtractor.h:48
ProcessElfCore::FileRange
lldb_private::Range< lldb::addr_t, lldb::addr_t > FileRange
Definition: ProcessElfCore.h:120
ProcessElfCore::~ProcessElfCore
~ProcessElfCore() override
Definition: ProcessElfCore.cpp:104
ProcessElfCore::VMRangeToPermissions
lldb_private::RangeDataVector< lldb::addr_t, lldb::addr_t, uint32_t > VMRangeToPermissions
Definition: ProcessElfCore.h:124
ProcessElfCore::GetNumThreadContexts
uint32_t GetNumThreadContexts()
Definition: ProcessElfCore.cpp:896
ProcessElfCore::GetProcessInfo
bool GetProcessInfo(lldb_private::ProcessInstanceInfo &info) override
Definition: ProcessElfCore.cpp:925
ProcessElfCore::m_auxv
lldb_private::DataExtractor m_auxv
Definition: ProcessElfCore.h:137
lldb_private::ThreadList
Definition: ThreadList.h:26
lldb_private::ConstString
Definition: ConstString.h:40
lldb_private::PostMortemProcess
Definition: PostMortemProcess.h:23
ProcessElfCore::m_thread_data
std::vector< ThreadData > m_thread_data
Definition: ProcessElfCore.h:134
lldb_private::Range< lldb::addr_t, lldb::addr_t >
ProcessElfCore::DoUpdateThreadList
bool DoUpdateThreadList(lldb_private::ThreadList &old_thread_list, lldb_private::ThreadList &new_thread_list) override
Update the thread list following process plug-in's specific logic.
Definition: ProcessElfCore.cpp:264
ProcessElfCore::DoReadMemory
size_t DoReadMemory(lldb::addr_t addr, void *buf, size_t size, lldb_private::Status &error) override
Actually do the reading of memory from a process.
Definition: ProcessElfCore.cpp:334
ProcessElfCore::parseSegment
llvm::Expected< std::vector< lldb_private::CoreNote > > parseSegment(const lldb_private::DataExtractor &segment)
Definition: ProcessElfCore.cpp:510
lldb_private::DynamicLoader
Definition: DynamicLoader.h:52
ProcessElfCore::ProcessElfCore
ProcessElfCore(lldb::TargetSP target_sp, lldb::ListenerSP listener_sp, const lldb_private::FileSpec &core_file)
Definition: ProcessElfCore.cpp:98
string
string(SUBSTRING ${p} 10 -1 pStripped) if($
Definition: Plugins/CMakeLists.txt:38
ProcessElfCore::WarnBeforeDetach
bool WarnBeforeDetach() const override
Before lldb detaches from a process, it warns the user that they are about to lose their debug sessio...
Definition: ProcessElfCore.h:83
ProcessElfCore::m_core_module_sp
lldb::ModuleSP m_core_module_sp
Definition: ProcessElfCore.h:126
PostMortemProcess.h
ProcessElfCore::GetPluginDescriptionStatic
static const char * GetPluginDescriptionStatic()
Definition: ProcessElfCore.cpp:45
ProcessElfCore::Clear
void Clear()
Definition: ProcessElfCore.cpp:380
ProcessElfCore::NT_FILE_Entry::file_ofs
lldb::addr_t file_ofs
Definition: ProcessElfCore.h:115
lldb_private::Status
Definition: Status.h:44
ProcessElfCore::GetMemoryRegionInfo
lldb_private::Status GetMemoryRegionInfo(lldb::addr_t load_addr, lldb_private::MemoryRegionInfo &region_info) override
Locate the memory region that contains load_addr.
Definition: ProcessElfCore.cpp:294
uint32_t
ProcessElfCore::NT_FILE_Entry::start
lldb::addr_t start
Definition: ProcessElfCore.h:113
ThreadData
Definition: ThreadElfCore.h:126
lldb_private::RangeDataVector< lldb::addr_t, lldb::addr_t, FileRange >
elf::ELFProgramHeader
Definition: ELFHeader.h:192
ProcessElfCore::parseNetBSDNotes
llvm::Error parseNetBSDNotes(llvm::ArrayRef< lldb_private::CoreNote > notes)
NetBSD specific Thread context from PT_NOTE segment.
Definition: ProcessElfCore.cpp:608
ProcessElfCore::DoDestroy
lldb_private::Status DoDestroy() override
Definition: ProcessElfCore.cpp:280
ProcessElfCore::parseFreeBSDNotes
llvm::Error parseFreeBSDNotes(llvm::ArrayRef< lldb_private::CoreNote > notes)
Definition: ProcessElfCore.cpp:531
Status.h
ProcessElfCore::NT_FILE_Entry::path
lldb_private::ConstString path
Definition: ProcessElfCore.h:116
ProcessElfCore::parseOpenBSDNotes
llvm::Error parseOpenBSDNotes(llvm::ArrayRef< lldb_private::CoreNote > notes)
Definition: ProcessElfCore.cpp:742
Error
llvm::Error Error
Definition: UdtRecordCompleter.cpp:29
ProcessElfCore::m_nt_file_entries
std::vector< NT_FILE_Entry > m_nt_file_entries
Definition: ProcessElfCore.h:146
ConstString.h
ProcessElfCore::NT_FILE_Entry::end
lldb::addr_t end
Definition: ProcessElfCore.h:114
ProcessElfCore
Definition: ProcessElfCore.h:31
ProcessElfCore::CreateInstance
static lldb::ProcessSP CreateInstance(lldb::TargetSP target_sp, lldb::ListenerSP listener_sp, const lldb_private::FileSpec *crash_file_path, bool can_connect)
Definition: ProcessElfCore.cpp:53
ProcessElfCore::CanDebug
bool CanDebug(lldb::TargetSP target_sp, bool plugin_specified_by_name) override
Check if a plug-in instance can debug the file in module.
Definition: ProcessElfCore.cpp:81
ProcessElfCore::GetArchitecture
lldb_private::ArchSpec GetArchitecture()
Definition: ProcessElfCore.cpp:902