1 //===-- ThreadElfCore.cpp --------------------------------------*- 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 //===----------------------------------------------------------------------===//
8 
9 #include "lldb/Target/RegisterContext.h"
10 #include "lldb/Target/StopInfo.h"
11 #include "lldb/Target/Target.h"
12 #include "lldb/Target/Unwind.h"
13 #include "lldb/Utility/DataExtractor.h"
14 #include "lldb/Utility/Log.h"
15 
16 #include "Plugins/Process/Utility/RegisterContextFreeBSD_i386.h"
17 #include "Plugins/Process/Utility/RegisterContextFreeBSD_mips64.h"
18 #include "Plugins/Process/Utility/RegisterContextFreeBSD_powerpc.h"
19 #include "Plugins/Process/Utility/RegisterContextFreeBSD_x86_64.h"
20 #include "Plugins/Process/Utility/RegisterContextLinux_i386.h"
21 #include "Plugins/Process/Utility/RegisterContextLinux_mips.h"
22 #include "Plugins/Process/Utility/RegisterContextLinux_mips64.h"
23 #include "Plugins/Process/Utility/RegisterContextLinux_s390x.h"
24 #include "Plugins/Process/Utility/RegisterContextLinux_x86_64.h"
25 #include "Plugins/Process/Utility/RegisterContextNetBSD_x86_64.h"
26 #include "Plugins/Process/Utility/RegisterContextOpenBSD_i386.h"
27 #include "Plugins/Process/Utility/RegisterContextOpenBSD_x86_64.h"
28 #include "Plugins/Process/Utility/RegisterInfoPOSIX_arm.h"
29 #include "Plugins/Process/Utility/RegisterInfoPOSIX_arm64.h"
30 #include "Plugins/Process/Utility/RegisterInfoPOSIX_ppc64le.h"
31 #include "ProcessElfCore.h"
32 #include "RegisterContextPOSIXCore_arm.h"
33 #include "RegisterContextPOSIXCore_arm64.h"
34 #include "RegisterContextPOSIXCore_mips64.h"
35 #include "RegisterContextPOSIXCore_powerpc.h"
36 #include "RegisterContextPOSIXCore_ppc64le.h"
37 #include "RegisterContextPOSIXCore_s390x.h"
38 #include "RegisterContextPOSIXCore_x86_64.h"
39 #include "ThreadElfCore.h"
40 
41 using namespace lldb;
42 using namespace lldb_private;
43 
44 //----------------------------------------------------------------------
45 // Construct a Thread object with given data
46 //----------------------------------------------------------------------
47 ThreadElfCore::ThreadElfCore(Process &process, const ThreadData &td)
48     : Thread(process, td.tid), m_thread_name(td.name), m_thread_reg_ctx_sp(),
49       m_signo(td.signo), m_gpregset_data(td.gpregset), m_notes(td.notes) {}
50 
51 ThreadElfCore::~ThreadElfCore() { DestroyThread(); }
52 
53 void ThreadElfCore::RefreshStateAfterStop() {
54   GetRegisterContext()->InvalidateIfNeeded(false);
55 }
56 
57 RegisterContextSP ThreadElfCore::GetRegisterContext() {
58   if (!m_reg_context_sp) {
59     m_reg_context_sp = CreateRegisterContextForFrame(nullptr);
60   }
61   return m_reg_context_sp;
62 }
63 
64 RegisterContextSP
65 ThreadElfCore::CreateRegisterContextForFrame(StackFrame *frame) {
66   RegisterContextSP reg_ctx_sp;
67   uint32_t concrete_frame_idx = 0;
68   Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_THREAD));
69 
70   if (frame)
71     concrete_frame_idx = frame->GetConcreteFrameIndex();
72 
73   if (concrete_frame_idx == 0) {
74     if (m_thread_reg_ctx_sp)
75       return m_thread_reg_ctx_sp;
76 
77     ProcessElfCore *process = static_cast<ProcessElfCore *>(GetProcess().get());
78     ArchSpec arch = process->GetArchitecture();
79     RegisterInfoInterface *reg_interface = nullptr;
80 
81     switch (arch.GetTriple().getOS()) {
82     case llvm::Triple::FreeBSD: {
83       switch (arch.GetMachine()) {
84       case llvm::Triple::aarch64:
85         reg_interface = new RegisterInfoPOSIX_arm64(arch);
86         break;
87       case llvm::Triple::arm:
88         reg_interface = new RegisterInfoPOSIX_arm(arch);
89         break;
90       case llvm::Triple::ppc:
91         reg_interface = new RegisterContextFreeBSD_powerpc32(arch);
92         break;
93       case llvm::Triple::ppc64:
94         reg_interface = new RegisterContextFreeBSD_powerpc64(arch);
95         break;
96       case llvm::Triple::mips64:
97         reg_interface = new RegisterContextFreeBSD_mips64(arch);
98         break;
99       case llvm::Triple::x86:
100         reg_interface = new RegisterContextFreeBSD_i386(arch);
101         break;
102       case llvm::Triple::x86_64:
103         reg_interface = new RegisterContextFreeBSD_x86_64(arch);
104         break;
105       default:
106         break;
107       }
108       break;
109     }
110 
111     case llvm::Triple::NetBSD: {
112       switch (arch.GetMachine()) {
113       case llvm::Triple::x86_64:
114         reg_interface = new RegisterContextNetBSD_x86_64(arch);
115         break;
116       default:
117         break;
118       }
119       break;
120     }
121 
122     case llvm::Triple::Linux: {
123       switch (arch.GetMachine()) {
124       case llvm::Triple::arm:
125         reg_interface = new RegisterInfoPOSIX_arm(arch);
126         break;
127       case llvm::Triple::aarch64:
128         reg_interface = new RegisterInfoPOSIX_arm64(arch);
129         break;
130       case llvm::Triple::mipsel:
131       case llvm::Triple::mips:
132         reg_interface = new RegisterContextLinux_mips(arch);
133         break;
134       case llvm::Triple::mips64el:
135       case llvm::Triple::mips64:
136         reg_interface = new RegisterContextLinux_mips64(arch);
137         break;
138       case llvm::Triple::ppc64le:
139         reg_interface = new RegisterInfoPOSIX_ppc64le(arch);
140         break;
141       case llvm::Triple::systemz:
142         reg_interface = new RegisterContextLinux_s390x(arch);
143         break;
144       case llvm::Triple::x86:
145         reg_interface = new RegisterContextLinux_i386(arch);
146         break;
147       case llvm::Triple::x86_64:
148         reg_interface = new RegisterContextLinux_x86_64(arch);
149         break;
150       default:
151         break;
152       }
153       break;
154     }
155 
156     case llvm::Triple::OpenBSD: {
157       switch (arch.GetMachine()) {
158       case llvm::Triple::aarch64:
159         reg_interface = new RegisterInfoPOSIX_arm64(arch);
160         break;
161       case llvm::Triple::arm:
162         reg_interface = new RegisterInfoPOSIX_arm(arch);
163         break;
164       case llvm::Triple::x86:
165         reg_interface = new RegisterContextOpenBSD_i386(arch);
166         break;
167       case llvm::Triple::x86_64:
168         reg_interface = new RegisterContextOpenBSD_x86_64(arch);
169         break;
170       default:
171         break;
172       }
173       break;
174     }
175 
176     default:
177       break;
178     }
179 
180     if (!reg_interface) {
181       if (log)
182         log->Printf("elf-core::%s:: Architecture(%d) or OS(%d) not supported",
183                     __FUNCTION__, arch.GetMachine(), arch.GetTriple().getOS());
184       assert(false && "Architecture or OS not supported");
185     }
186 
187     switch (arch.GetMachine()) {
188     case llvm::Triple::aarch64:
189       m_thread_reg_ctx_sp.reset(new RegisterContextCorePOSIX_arm64(
190           *this, reg_interface, m_gpregset_data, m_notes));
191       break;
192     case llvm::Triple::arm:
193       m_thread_reg_ctx_sp.reset(new RegisterContextCorePOSIX_arm(
194           *this, reg_interface, m_gpregset_data, m_notes));
195       break;
196     case llvm::Triple::mipsel:
197     case llvm::Triple::mips:
198       m_thread_reg_ctx_sp.reset(new RegisterContextCorePOSIX_mips64(
199           *this, reg_interface, m_gpregset_data, m_notes));
200       break;
201     case llvm::Triple::mips64:
202     case llvm::Triple::mips64el:
203       m_thread_reg_ctx_sp.reset(new RegisterContextCorePOSIX_mips64(
204           *this, reg_interface, m_gpregset_data, m_notes));
205       break;
206     case llvm::Triple::ppc:
207     case llvm::Triple::ppc64:
208       m_thread_reg_ctx_sp.reset(new RegisterContextCorePOSIX_powerpc(
209           *this, reg_interface, m_gpregset_data, m_notes));
210       break;
211     case llvm::Triple::ppc64le:
212       m_thread_reg_ctx_sp.reset(new RegisterContextCorePOSIX_ppc64le(
213           *this, reg_interface, m_gpregset_data, m_notes));
214       break;
215     case llvm::Triple::systemz:
216       m_thread_reg_ctx_sp.reset(new RegisterContextCorePOSIX_s390x(
217           *this, reg_interface, m_gpregset_data, m_notes));
218       break;
219     case llvm::Triple::x86:
220     case llvm::Triple::x86_64:
221       m_thread_reg_ctx_sp.reset(new RegisterContextCorePOSIX_x86_64(
222           *this, reg_interface, m_gpregset_data, m_notes));
223       break;
224     default:
225       break;
226     }
227 
228     reg_ctx_sp = m_thread_reg_ctx_sp;
229   } else {
230     Unwind *unwinder = GetUnwinder();
231     if (unwinder != nullptr)
232       reg_ctx_sp = unwinder->CreateRegisterContextForFrame(frame);
233   }
234   return reg_ctx_sp;
235 }
236 
237 bool ThreadElfCore::CalculateStopInfo() {
238   ProcessSP process_sp(GetProcess());
239   if (process_sp) {
240     SetStopInfo(StopInfo::CreateStopReasonWithSignal(*this, m_signo));
241     return true;
242   }
243   return false;
244 }
245 
246 //----------------------------------------------------------------
247 // Parse PRSTATUS from NOTE entry
248 //----------------------------------------------------------------
249 ELFLinuxPrStatus::ELFLinuxPrStatus() {
250   memset(this, 0, sizeof(ELFLinuxPrStatus));
251 }
252 
253 size_t ELFLinuxPrStatus::GetSize(const lldb_private::ArchSpec &arch) {
254   constexpr size_t mips_linux_pr_status_size_o32 = 96;
255   constexpr size_t mips_linux_pr_status_size_n32 = 72;
256   if (arch.IsMIPS()) {
257     std::string abi = arch.GetTargetABI();
258     assert(!abi.empty() && "ABI is not set");
259     if (!abi.compare("n64"))
260       return sizeof(ELFLinuxPrStatus);
261     else if (!abi.compare("o32"))
262       return mips_linux_pr_status_size_o32;
263     // N32 ABI
264     return mips_linux_pr_status_size_n32;
265   }
266   switch (arch.GetCore()) {
267   case lldb_private::ArchSpec::eCore_s390x_generic:
268   case lldb_private::ArchSpec::eCore_x86_64_x86_64:
269   case lldb_private::ArchSpec::eCore_ppc64le_generic:
270     return sizeof(ELFLinuxPrStatus);
271   case lldb_private::ArchSpec::eCore_x86_32_i386:
272   case lldb_private::ArchSpec::eCore_x86_32_i486:
273     return 72;
274   default:
275     return 0;
276   }
277 }
278 
279 Status ELFLinuxPrStatus::Parse(const DataExtractor &data,
280                                const ArchSpec &arch) {
281   Status error;
282   if (GetSize(arch) > data.GetByteSize()) {
283     error.SetErrorStringWithFormat(
284         "NT_PRSTATUS size should be %zu, but the remaining bytes are: %" PRIu64,
285         GetSize(arch), data.GetByteSize());
286     return error;
287   }
288 
289   // Read field by field to correctly account for endianess of both the core
290   // dump and the platform running lldb.
291   offset_t offset = 0;
292   si_signo = data.GetU32(&offset);
293   si_code = data.GetU32(&offset);
294   si_errno = data.GetU32(&offset);
295 
296   pr_cursig = data.GetU16(&offset);
297   offset += 2; // pad
298 
299   pr_sigpend = data.GetPointer(&offset);
300   pr_sighold = data.GetPointer(&offset);
301 
302   pr_pid = data.GetU32(&offset);
303   pr_ppid = data.GetU32(&offset);
304   pr_pgrp = data.GetU32(&offset);
305   pr_sid = data.GetU32(&offset);
306 
307   pr_utime.tv_sec = data.GetPointer(&offset);
308   pr_utime.tv_usec = data.GetPointer(&offset);
309 
310   pr_stime.tv_sec = data.GetPointer(&offset);
311   pr_stime.tv_usec = data.GetPointer(&offset);
312 
313   pr_cutime.tv_sec = data.GetPointer(&offset);
314   pr_cutime.tv_usec = data.GetPointer(&offset);
315 
316   pr_cstime.tv_sec = data.GetPointer(&offset);
317   pr_cstime.tv_usec = data.GetPointer(&offset);
318 
319   return error;
320 }
321 
322 //----------------------------------------------------------------
323 // Parse PRPSINFO from NOTE entry
324 //----------------------------------------------------------------
325 ELFLinuxPrPsInfo::ELFLinuxPrPsInfo() {
326   memset(this, 0, sizeof(ELFLinuxPrPsInfo));
327 }
328 
329 size_t ELFLinuxPrPsInfo::GetSize(const lldb_private::ArchSpec &arch) {
330   constexpr size_t mips_linux_pr_psinfo_size_o32_n32 = 128;
331   if (arch.IsMIPS()) {
332     uint8_t address_byte_size = arch.GetAddressByteSize();
333     if (address_byte_size == 8)
334       return sizeof(ELFLinuxPrPsInfo);
335     return mips_linux_pr_psinfo_size_o32_n32;
336   }
337 
338   switch (arch.GetCore()) {
339   case lldb_private::ArchSpec::eCore_s390x_generic:
340   case lldb_private::ArchSpec::eCore_x86_64_x86_64:
341     return sizeof(ELFLinuxPrPsInfo);
342   case lldb_private::ArchSpec::eCore_x86_32_i386:
343   case lldb_private::ArchSpec::eCore_x86_32_i486:
344     return 124;
345   default:
346     return 0;
347   }
348 }
349 
350 Status ELFLinuxPrPsInfo::Parse(const DataExtractor &data,
351                                const ArchSpec &arch) {
352   Status error;
353   ByteOrder byteorder = data.GetByteOrder();
354   if (GetSize(arch) > data.GetByteSize()) {
355     error.SetErrorStringWithFormat(
356         "NT_PRPSINFO size should be %zu, but the remaining bytes are: %" PRIu64,
357         GetSize(arch), data.GetByteSize());
358     return error;
359   }
360   size_t size = 0;
361   offset_t offset = 0;
362 
363   pr_state = data.GetU8(&offset);
364   pr_sname = data.GetU8(&offset);
365   pr_zomb = data.GetU8(&offset);
366   pr_nice = data.GetU8(&offset);
367   if (data.GetAddressByteSize() == 8) {
368     // Word align the next field on 64 bit.
369     offset += 4;
370   }
371 
372   pr_flag = data.GetPointer(&offset);
373 
374   if (arch.IsMIPS()) {
375     // The pr_uid and pr_gid is always 32 bit irrespective of platforms
376     pr_uid = data.GetU32(&offset);
377     pr_gid = data.GetU32(&offset);
378   } else {
379     // 16 bit on 32 bit platforms, 32 bit on 64 bit platforms
380     pr_uid = data.GetMaxU64(&offset, data.GetAddressByteSize() >> 1);
381     pr_gid = data.GetMaxU64(&offset, data.GetAddressByteSize() >> 1);
382   }
383 
384   pr_pid = data.GetU32(&offset);
385   pr_ppid = data.GetU32(&offset);
386   pr_pgrp = data.GetU32(&offset);
387   pr_sid = data.GetU32(&offset);
388 
389   size = 16;
390   data.ExtractBytes(offset, size, byteorder, pr_fname);
391   offset += size;
392 
393   size = 80;
394   data.ExtractBytes(offset, size, byteorder, pr_psargs);
395   offset += size;
396 
397   return error;
398 }
399 
400 //----------------------------------------------------------------
401 // Parse SIGINFO from NOTE entry
402 //----------------------------------------------------------------
403 ELFLinuxSigInfo::ELFLinuxSigInfo() { memset(this, 0, sizeof(ELFLinuxSigInfo)); }
404 
405 size_t ELFLinuxSigInfo::GetSize(const lldb_private::ArchSpec &arch) {
406   if (arch.IsMIPS())
407     return sizeof(ELFLinuxSigInfo);
408   switch (arch.GetCore()) {
409   case lldb_private::ArchSpec::eCore_x86_64_x86_64:
410     return sizeof(ELFLinuxSigInfo);
411   case lldb_private::ArchSpec::eCore_s390x_generic:
412   case lldb_private::ArchSpec::eCore_x86_32_i386:
413   case lldb_private::ArchSpec::eCore_x86_32_i486:
414     return 12;
415   default:
416     return 0;
417   }
418 }
419 
420 Status ELFLinuxSigInfo::Parse(const DataExtractor &data, const ArchSpec &arch) {
421   Status error;
422   if (GetSize(arch) > data.GetByteSize()) {
423     error.SetErrorStringWithFormat(
424         "NT_SIGINFO size should be %zu, but the remaining bytes are: %" PRIu64,
425         GetSize(arch), data.GetByteSize());
426     return error;
427   }
428 
429   // Parsing from a 32 bit ELF core file, and populating/reusing the structure
430   // properly, because the struct is for the 64 bit version
431   offset_t offset = 0;
432   si_signo = data.GetU32(&offset);
433   si_code = data.GetU32(&offset);
434   si_errno = data.GetU32(&offset);
435 
436   return error;
437 }
438