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