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