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 {
37 public:
38     //------------------------------------------------------------------
39     // Constructors and Destructors
40     //------------------------------------------------------------------
41     static lldb::ProcessSP
42     CreateInstance (lldb::TargetSP target_sp,
43                     lldb::ListenerSP listener_sp,
44                     const lldb_private::FileSpec *crash_file_path);
45 
46     static void
47     Initialize();
48 
49     static void
50     Terminate();
51 
52     static lldb_private::ConstString
53     GetPluginNameStatic();
54 
55     static const char *
56     GetPluginDescriptionStatic();
57 
58     //------------------------------------------------------------------
59     // Constructors and Destructors
60     //------------------------------------------------------------------
61     ProcessElfCore(lldb::TargetSP target_sp,
62                    lldb::ListenerSP listener_sp,
63                    const lldb_private::FileSpec &core_file);
64 
65     ~ProcessElfCore() override;
66 
67     //------------------------------------------------------------------
68     // Check if a given Process
69     //------------------------------------------------------------------
70     bool CanDebug(lldb::TargetSP target_sp, bool plugin_specified_by_name) override;
71 
72     //------------------------------------------------------------------
73     // Creating a new process, or attaching to an existing one
74     //------------------------------------------------------------------
75     lldb_private::Error DoLoadCore() override;
76 
77     lldb_private::DynamicLoader *GetDynamicLoader() override;
78 
79     //------------------------------------------------------------------
80     // PluginInterface protocol
81     //------------------------------------------------------------------
82     lldb_private::ConstString GetPluginName() override;
83 
84     uint32_t GetPluginVersion() override;
85 
86     //------------------------------------------------------------------
87     // Process Control
88     //------------------------------------------------------------------
89     lldb_private::Error DoDestroy() override;
90 
91     void RefreshStateAfterStop() override;
92 
93     //------------------------------------------------------------------
94     // Process Queries
95     //------------------------------------------------------------------
96     bool IsAlive() override;
97 
98     //------------------------------------------------------------------
99     // Process Memory
100     //------------------------------------------------------------------
101     size_t ReadMemory(lldb::addr_t addr, void *buf, size_t size, lldb_private::Error &error) override;
102 
103     size_t DoReadMemory(lldb::addr_t addr, void *buf, size_t size, lldb_private::Error &error) override;
104 
105     lldb::addr_t GetImageInfoAddress() override;
106 
107     lldb_private::ArchSpec
108     GetArchitecture();
109 
110     // Returns AUXV structure found in the core file
111     const lldb::DataBufferSP
112     GetAuxvData() override;
113 
114     bool
115     GetProcessInfo(lldb_private::ProcessInstanceInfo &info) override;
116 
117 protected:
118     void
119     Clear ( );
120 
121     bool UpdateThreadList(lldb_private::ThreadList &old_thread_list,
122                           lldb_private::ThreadList &new_thread_list) override;
123 
124 private:
125     struct NT_FILE_Entry
126     {
127         lldb::addr_t start;
128         lldb::addr_t end;
129         lldb::addr_t file_ofs;
130         lldb_private::ConstString path;
131     };
132 
133     //------------------------------------------------------------------
134     // For ProcessElfCore only
135     //------------------------------------------------------------------
136     typedef lldb_private::Range<lldb::addr_t, lldb::addr_t> FileRange;
137     typedef lldb_private::RangeDataArray<lldb::addr_t, lldb::addr_t, FileRange, 1> VMRangeToFileOffset;
138 
139     lldb::ModuleSP m_core_module_sp;
140     lldb_private::FileSpec m_core_file;
141     std::string  m_dyld_plugin_name;
142     DISALLOW_COPY_AND_ASSIGN (ProcessElfCore);
143 
144     llvm::Triple::OSType m_os;
145 
146     // True if m_thread_contexts contains valid entries
147     bool m_thread_data_valid;
148 
149     // Contain thread data read from NOTE segments
150     std::vector<ThreadData> m_thread_data;
151 
152     // AUXV structure found from the NOTE segment
153     lldb_private::DataExtractor m_auxv;
154 
155     // Address ranges found in the core
156     VMRangeToFileOffset m_core_aranges;
157 
158     // NT_FILE entries found from the NOTE segment
159     std::vector<NT_FILE_Entry> m_nt_file_entries;
160 
161     // Parse thread(s) data structures(prstatus, prpsinfo) from given NOTE segment
162     void
163     ParseThreadContextsFromNoteSegment (const elf::ELFProgramHeader *segment_header,
164                                         lldb_private::DataExtractor segment_data);
165 
166     // Returns number of thread contexts stored in the core file
167     uint32_t
168     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