1 //===-- NativeThreadNetBSD.cpp --------------------------------------------===//
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 "NativeThreadNetBSD.h"
10 #include "NativeRegisterContextNetBSD.h"
11 
12 #include "NativeProcessNetBSD.h"
13 
14 #include "Plugins/Process/POSIX/CrashReason.h"
15 #include "Plugins/Process/POSIX/ProcessPOSIXLog.h"
16 #include "lldb/Utility/LLDBAssert.h"
17 #include "lldb/Utility/RegisterValue.h"
18 #include "lldb/Utility/State.h"
19 #include "llvm/Support/Errno.h"
20 
21 // clang-format off
22 #include <sys/types.h>
23 #include <sys/ptrace.h>
24 // clang-format on
25 
26 #include <sstream>
27 
28 // clang-format off
29 #include <sys/types.h>
30 #include <sys/sysctl.h>
31 // clang-format on
32 
33 using namespace lldb;
34 using namespace lldb_private;
35 using namespace lldb_private::process_netbsd;
36 
37 NativeThreadNetBSD::NativeThreadNetBSD(NativeProcessNetBSD &process,
38                                        lldb::tid_t tid)
39     : NativeThreadProtocol(process, tid), m_state(StateType::eStateInvalid),
40       m_stop_info(), m_reg_context_up(
41 NativeRegisterContextNetBSD::CreateHostNativeRegisterContextNetBSD(process.GetArchitecture(), *this)
42 ), m_stop_description() {}
43 
44 Status NativeThreadNetBSD::Resume() {
45   Status ret = NativeProcessNetBSD::PtraceWrapper(PT_RESUME, m_process.GetID(),
46                                                   nullptr, GetID());
47   if (!ret.Success())
48     return ret;
49   ret = NativeProcessNetBSD::PtraceWrapper(PT_CLEARSTEP, m_process.GetID(),
50                                            nullptr, GetID());
51   if (ret.Success())
52     SetRunning();
53   return ret;
54 }
55 
56 Status NativeThreadNetBSD::SingleStep() {
57   Status ret = NativeProcessNetBSD::PtraceWrapper(PT_RESUME, m_process.GetID(),
58                                                   nullptr, GetID());
59   if (!ret.Success())
60     return ret;
61   ret = NativeProcessNetBSD::PtraceWrapper(PT_SETSTEP, m_process.GetID(),
62                                            nullptr, GetID());
63   if (ret.Success())
64     SetStepping();
65   return ret;
66 }
67 
68 Status NativeThreadNetBSD::Suspend() {
69   Status ret = NativeProcessNetBSD::PtraceWrapper(PT_SUSPEND, m_process.GetID(),
70                                                   nullptr, GetID());
71   if (ret.Success())
72     SetStopped();
73   return ret;
74 }
75 
76 void NativeThreadNetBSD::SetStoppedBySignal(uint32_t signo,
77                                             const siginfo_t *info) {
78   Log *log = GetLog(POSIXLog::Thread);
79   LLDB_LOG(log, "tid = {0} in called with signal {1}", GetID(), signo);
80 
81   SetStopped();
82 
83   m_stop_info.reason = StopReason::eStopReasonSignal;
84   m_stop_info.signo = signo;
85 
86   m_stop_description.clear();
87   if (info) {
88     switch (signo) {
89     case SIGSEGV:
90     case SIGBUS:
91     case SIGFPE:
92     case SIGILL:
93       const auto reason = GetCrashReason(*info);
94       m_stop_description = GetCrashReasonString(reason, *info);
95       break;
96     }
97   }
98 }
99 
100 void NativeThreadNetBSD::SetStoppedByBreakpoint() {
101   SetStopped();
102   m_stop_info.reason = StopReason::eStopReasonBreakpoint;
103   m_stop_info.signo = SIGTRAP;
104 }
105 
106 void NativeThreadNetBSD::SetStoppedByTrace() {
107   SetStopped();
108   m_stop_info.reason = StopReason::eStopReasonTrace;
109   m_stop_info.signo = SIGTRAP;
110 }
111 
112 void NativeThreadNetBSD::SetStoppedByExec() {
113   SetStopped();
114   m_stop_info.reason = StopReason::eStopReasonExec;
115   m_stop_info.signo = SIGTRAP;
116 }
117 
118 void NativeThreadNetBSD::SetStoppedByWatchpoint(uint32_t wp_index) {
119   lldbassert(wp_index != LLDB_INVALID_INDEX32 && "wp_index cannot be invalid");
120 
121   std::ostringstream ostr;
122   ostr << GetRegisterContext().GetWatchpointAddress(wp_index) << " ";
123   ostr << wp_index;
124 
125   ostr << " " << GetRegisterContext().GetWatchpointHitAddress(wp_index);
126 
127   SetStopped();
128   m_stop_description = ostr.str();
129   m_stop_info.reason = StopReason::eStopReasonWatchpoint;
130   m_stop_info.signo = SIGTRAP;
131 }
132 
133 void NativeThreadNetBSD::SetStoppedByFork(lldb::pid_t child_pid,
134                                            lldb::tid_t child_tid) {
135   SetStopped();
136 
137   m_stop_info.reason = StopReason::eStopReasonFork;
138   m_stop_info.signo = SIGTRAP;
139   m_stop_info.details.fork.child_pid = child_pid;
140   m_stop_info.details.fork.child_tid = child_tid;
141 }
142 
143 void NativeThreadNetBSD::SetStoppedByVFork(lldb::pid_t child_pid,
144                                             lldb::tid_t child_tid) {
145   SetStopped();
146 
147   m_stop_info.reason = StopReason::eStopReasonVFork;
148   m_stop_info.signo = SIGTRAP;
149   m_stop_info.details.fork.child_pid = child_pid;
150   m_stop_info.details.fork.child_tid = child_tid;
151 }
152 
153 void NativeThreadNetBSD::SetStoppedByVForkDone() {
154   SetStopped();
155 
156   m_stop_info.reason = StopReason::eStopReasonVForkDone;
157   m_stop_info.signo = SIGTRAP;
158 }
159 
160 void NativeThreadNetBSD::SetStoppedWithNoReason() {
161   SetStopped();
162 
163   m_stop_info.reason = StopReason::eStopReasonNone;
164   m_stop_info.signo = 0;
165 }
166 
167 void NativeThreadNetBSD::SetStopped() {
168   const StateType new_state = StateType::eStateStopped;
169   m_state = new_state;
170   m_stop_description.clear();
171 }
172 
173 void NativeThreadNetBSD::SetRunning() {
174   m_state = StateType::eStateRunning;
175   m_stop_info.reason = StopReason::eStopReasonNone;
176 }
177 
178 void NativeThreadNetBSD::SetStepping() {
179   m_state = StateType::eStateStepping;
180   m_stop_info.reason = StopReason::eStopReasonNone;
181 }
182 
183 std::string NativeThreadNetBSD::GetName() {
184   Log *log = GetLog(POSIXLog::Thread);
185 
186 #ifdef PT_LWPSTATUS
187   struct ptrace_lwpstatus info = {};
188   info.pl_lwpid = m_tid;
189   Status error = NativeProcessNetBSD::PtraceWrapper(
190       PT_LWPSTATUS, static_cast<int>(m_process.GetID()), &info, sizeof(info));
191   if (error.Fail()) {
192     return "";
193   }
194   return info.pl_name;
195 #else
196   std::vector<struct kinfo_lwp> infos;
197   int mib[5] = {CTL_KERN, KERN_LWP, static_cast<int>(m_process.GetID()),
198                 sizeof(struct kinfo_lwp), 0};
199   size_t size;
200 
201   if (::sysctl(mib, 5, nullptr, &size, nullptr, 0) == -1 || size == 0) {
202     LLDB_LOG(log, "sysctl() for LWP info size failed: {0}",
203              llvm::sys::StrError());
204     return "";
205   }
206 
207   mib[4] = size / sizeof(size_t);
208   infos.resize(size / sizeof(struct kinfo_lwp));
209 
210   if (sysctl(mib, 5, infos.data(), &size, NULL, 0) == -1 || size == 0) {
211     LLDB_LOG(log, "sysctl() for LWP info failed: {0}", llvm::sys::StrError());
212     return "";
213   }
214 
215   size_t nlwps = size / sizeof(struct kinfo_lwp);
216   for (size_t i = 0; i < nlwps; i++) {
217     if (static_cast<lldb::tid_t>(infos[i].l_lid) == m_tid) {
218       return infos[i].l_name;
219     }
220   }
221 
222   LLDB_LOG(log, "unable to find lwp {0} in LWP infos", m_tid);
223   return "";
224 #endif
225 }
226 
227 lldb::StateType NativeThreadNetBSD::GetState() { return m_state; }
228 
229 bool NativeThreadNetBSD::GetStopReason(ThreadStopInfo &stop_info,
230                                        std::string &description) {
231   Log *log = GetLog(POSIXLog::Thread);
232   description.clear();
233 
234   switch (m_state) {
235   case eStateStopped:
236   case eStateCrashed:
237   case eStateExited:
238   case eStateSuspended:
239   case eStateUnloaded:
240     stop_info = m_stop_info;
241     description = m_stop_description;
242 
243     return true;
244 
245   case eStateInvalid:
246   case eStateConnected:
247   case eStateAttaching:
248   case eStateLaunching:
249   case eStateRunning:
250   case eStateStepping:
251   case eStateDetached:
252     LLDB_LOG(log, "tid = {0} in state {1} cannot answer stop reason", GetID(),
253              StateAsCString(m_state));
254     return false;
255   }
256   llvm_unreachable("unhandled StateType!");
257 }
258 
259 NativeRegisterContextNetBSD &NativeThreadNetBSD::GetRegisterContext() {
260   assert(m_reg_context_up);
261   return *m_reg_context_up;
262 }
263 
264 Status NativeThreadNetBSD::SetWatchpoint(lldb::addr_t addr, size_t size,
265                                          uint32_t watch_flags, bool hardware) {
266   assert(m_state == eStateStopped);
267   if (!hardware)
268     return Status("not implemented");
269   Status error = RemoveWatchpoint(addr);
270   if (error.Fail())
271     return error;
272   uint32_t wp_index =
273       GetRegisterContext().SetHardwareWatchpoint(addr, size, watch_flags);
274   if (wp_index == LLDB_INVALID_INDEX32)
275     return Status("Setting hardware watchpoint failed.");
276   m_watchpoint_index_map.insert({addr, wp_index});
277   return Status();
278 }
279 
280 Status NativeThreadNetBSD::RemoveWatchpoint(lldb::addr_t addr) {
281   auto wp = m_watchpoint_index_map.find(addr);
282   if (wp == m_watchpoint_index_map.end())
283     return Status();
284   uint32_t wp_index = wp->second;
285   m_watchpoint_index_map.erase(wp);
286   if (GetRegisterContext().ClearHardwareWatchpoint(wp_index))
287     return Status();
288   return Status("Clearing hardware watchpoint failed.");
289 }
290 
291 Status NativeThreadNetBSD::SetHardwareBreakpoint(lldb::addr_t addr,
292                                                  size_t size) {
293   assert(m_state == eStateStopped);
294   Status error = RemoveHardwareBreakpoint(addr);
295   if (error.Fail())
296     return error;
297 
298   uint32_t bp_index = GetRegisterContext().SetHardwareBreakpoint(addr, size);
299 
300   if (bp_index == LLDB_INVALID_INDEX32)
301     return Status("Setting hardware breakpoint failed.");
302 
303   m_hw_break_index_map.insert({addr, bp_index});
304   return Status();
305 }
306 
307 Status NativeThreadNetBSD::RemoveHardwareBreakpoint(lldb::addr_t addr) {
308   auto bp = m_hw_break_index_map.find(addr);
309   if (bp == m_hw_break_index_map.end())
310     return Status();
311 
312   uint32_t bp_index = bp->second;
313   if (GetRegisterContext().ClearHardwareBreakpoint(bp_index)) {
314     m_hw_break_index_map.erase(bp);
315     return Status();
316   }
317 
318   return Status("Clearing hardware breakpoint failed.");
319 }
320 
321 llvm::Error
322 NativeThreadNetBSD::CopyWatchpointsFrom(NativeThreadNetBSD &source) {
323   llvm::Error s = GetRegisterContext().CopyHardwareWatchpointsFrom(
324       source.GetRegisterContext());
325   if (!s) {
326     m_watchpoint_index_map = source.m_watchpoint_index_map;
327     m_hw_break_index_map = source.m_hw_break_index_map;
328   }
329   return s;
330 }
331