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
NativeThreadNetBSD(NativeProcessNetBSD & process,lldb::tid_t tid)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
Resume()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
SingleStep()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
Suspend()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
SetStoppedBySignal(uint32_t signo,const siginfo_t * info)76 void NativeThreadNetBSD::SetStoppedBySignal(uint32_t signo,
77 const siginfo_t *info) {
78 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_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.details.signal.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
SetStoppedByBreakpoint()100 void NativeThreadNetBSD::SetStoppedByBreakpoint() {
101 SetStopped();
102 m_stop_info.reason = StopReason::eStopReasonBreakpoint;
103 m_stop_info.details.signal.signo = SIGTRAP;
104 }
105
SetStoppedByTrace()106 void NativeThreadNetBSD::SetStoppedByTrace() {
107 SetStopped();
108 m_stop_info.reason = StopReason::eStopReasonTrace;
109 m_stop_info.details.signal.signo = SIGTRAP;
110 }
111
SetStoppedByExec()112 void NativeThreadNetBSD::SetStoppedByExec() {
113 SetStopped();
114 m_stop_info.reason = StopReason::eStopReasonExec;
115 m_stop_info.details.signal.signo = SIGTRAP;
116 }
117
SetStoppedByWatchpoint(uint32_t wp_index)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.details.signal.signo = SIGTRAP;
131 }
132
SetStoppedWithNoReason()133 void NativeThreadNetBSD::SetStoppedWithNoReason() {
134 SetStopped();
135
136 m_stop_info.reason = StopReason::eStopReasonNone;
137 m_stop_info.details.signal.signo = 0;
138 }
139
SetStopped()140 void NativeThreadNetBSD::SetStopped() {
141 const StateType new_state = StateType::eStateStopped;
142 m_state = new_state;
143 m_stop_description.clear();
144 }
145
SetRunning()146 void NativeThreadNetBSD::SetRunning() {
147 m_state = StateType::eStateRunning;
148 m_stop_info.reason = StopReason::eStopReasonNone;
149 }
150
SetStepping()151 void NativeThreadNetBSD::SetStepping() {
152 m_state = StateType::eStateStepping;
153 m_stop_info.reason = StopReason::eStopReasonNone;
154 }
155
GetName()156 std::string NativeThreadNetBSD::GetName() {
157 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_THREAD));
158
159 #ifdef PT_LWPSTATUS
160 struct ptrace_lwpstatus info = {};
161 info.pl_lwpid = m_tid;
162 Status error = NativeProcessNetBSD::PtraceWrapper(
163 PT_LWPSTATUS, static_cast<int>(m_process.GetID()), &info, sizeof(info));
164 if (error.Fail()) {
165 return "";
166 }
167 return info.pl_name;
168 #else
169 std::vector<struct kinfo_lwp> infos;
170 int mib[5] = {CTL_KERN, KERN_LWP, static_cast<int>(m_process.GetID()),
171 sizeof(struct kinfo_lwp), 0};
172 size_t size;
173
174 if (::sysctl(mib, 5, nullptr, &size, nullptr, 0) == -1 || size == 0) {
175 LLDB_LOG(log, "sysctl() for LWP info size failed: {0}",
176 llvm::sys::StrError());
177 return "";
178 }
179
180 mib[4] = size / sizeof(size_t);
181 infos.resize(size / sizeof(struct kinfo_lwp));
182
183 if (sysctl(mib, 5, infos.data(), &size, NULL, 0) == -1 || size == 0) {
184 LLDB_LOG(log, "sysctl() for LWP info failed: {0}", llvm::sys::StrError());
185 return "";
186 }
187
188 size_t nlwps = size / sizeof(struct kinfo_lwp);
189 for (size_t i = 0; i < nlwps; i++) {
190 if (static_cast<lldb::tid_t>(infos[i].l_lid) == m_tid) {
191 return infos[i].l_name;
192 }
193 }
194
195 LLDB_LOG(log, "unable to find lwp {0} in LWP infos", m_tid);
196 return "";
197 #endif
198 }
199
GetState()200 lldb::StateType NativeThreadNetBSD::GetState() { return m_state; }
201
GetStopReason(ThreadStopInfo & stop_info,std::string & description)202 bool NativeThreadNetBSD::GetStopReason(ThreadStopInfo &stop_info,
203 std::string &description) {
204 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_THREAD));
205 description.clear();
206
207 switch (m_state) {
208 case eStateStopped:
209 case eStateCrashed:
210 case eStateExited:
211 case eStateSuspended:
212 case eStateUnloaded:
213 stop_info = m_stop_info;
214 description = m_stop_description;
215
216 return true;
217
218 case eStateInvalid:
219 case eStateConnected:
220 case eStateAttaching:
221 case eStateLaunching:
222 case eStateRunning:
223 case eStateStepping:
224 case eStateDetached:
225 LLDB_LOG(log, "tid = {0} in state {1} cannot answer stop reason", GetID(),
226 StateAsCString(m_state));
227 return false;
228 }
229 llvm_unreachable("unhandled StateType!");
230 }
231
GetRegisterContext()232 NativeRegisterContextNetBSD &NativeThreadNetBSD::GetRegisterContext() {
233 assert(m_reg_context_up);
234 return *m_reg_context_up;
235 }
236
SetWatchpoint(lldb::addr_t addr,size_t size,uint32_t watch_flags,bool hardware)237 Status NativeThreadNetBSD::SetWatchpoint(lldb::addr_t addr, size_t size,
238 uint32_t watch_flags, bool hardware) {
239 assert(m_state == eStateStopped);
240 if (!hardware)
241 return Status("not implemented");
242 Status error = RemoveWatchpoint(addr);
243 if (error.Fail())
244 return error;
245 uint32_t wp_index =
246 GetRegisterContext().SetHardwareWatchpoint(addr, size, watch_flags);
247 if (wp_index == LLDB_INVALID_INDEX32)
248 return Status("Setting hardware watchpoint failed.");
249 m_watchpoint_index_map.insert({addr, wp_index});
250 return Status();
251 }
252
RemoveWatchpoint(lldb::addr_t addr)253 Status NativeThreadNetBSD::RemoveWatchpoint(lldb::addr_t addr) {
254 auto wp = m_watchpoint_index_map.find(addr);
255 if (wp == m_watchpoint_index_map.end())
256 return Status();
257 uint32_t wp_index = wp->second;
258 m_watchpoint_index_map.erase(wp);
259 if (GetRegisterContext().ClearHardwareWatchpoint(wp_index))
260 return Status();
261 return Status("Clearing hardware watchpoint failed.");
262 }
263
SetHardwareBreakpoint(lldb::addr_t addr,size_t size)264 Status NativeThreadNetBSD::SetHardwareBreakpoint(lldb::addr_t addr,
265 size_t size) {
266 assert(m_state == eStateStopped);
267 Status error = RemoveHardwareBreakpoint(addr);
268 if (error.Fail())
269 return error;
270
271 uint32_t bp_index = GetRegisterContext().SetHardwareBreakpoint(addr, size);
272
273 if (bp_index == LLDB_INVALID_INDEX32)
274 return Status("Setting hardware breakpoint failed.");
275
276 m_hw_break_index_map.insert({addr, bp_index});
277 return Status();
278 }
279
RemoveHardwareBreakpoint(lldb::addr_t addr)280 Status NativeThreadNetBSD::RemoveHardwareBreakpoint(lldb::addr_t addr) {
281 auto bp = m_hw_break_index_map.find(addr);
282 if (bp == m_hw_break_index_map.end())
283 return Status();
284
285 uint32_t bp_index = bp->second;
286 if (GetRegisterContext().ClearHardwareBreakpoint(bp_index)) {
287 m_hw_break_index_map.erase(bp);
288 return Status();
289 }
290
291 return Status("Clearing hardware breakpoint failed.");
292 }
293
294 llvm::Error
CopyWatchpointsFrom(NativeThreadNetBSD & source)295 NativeThreadNetBSD::CopyWatchpointsFrom(NativeThreadNetBSD &source) {
296 llvm::Error s = GetRegisterContext().CopyHardwareWatchpointsFrom(
297 source.GetRegisterContext());
298 if (!s) {
299 m_watchpoint_index_map = source.m_watchpoint_index_map;
300 m_hw_break_index_map = source.m_hw_break_index_map;
301 }
302 return s;
303 }
304