1af245d11STodd Fiala //===-- NativeProcessLinux.cpp -------------------------------- -*- C++ -*-===//
2af245d11STodd Fiala //
3af245d11STodd Fiala //                     The LLVM Compiler Infrastructure
4af245d11STodd Fiala //
5af245d11STodd Fiala // This file is distributed under the University of Illinois Open Source
6af245d11STodd Fiala // License. See LICENSE.TXT for details.
7af245d11STodd Fiala //
8af245d11STodd Fiala //===----------------------------------------------------------------------===//
9af245d11STodd Fiala 
10af245d11STodd Fiala #include "NativeProcessLinux.h"
11af245d11STodd Fiala 
12af245d11STodd Fiala // C Includes
13af245d11STodd Fiala #include <errno.h>
14af245d11STodd Fiala #include <stdint.h>
15b9c1b51eSKate Stone #include <string.h>
16af245d11STodd Fiala #include <unistd.h>
17af245d11STodd Fiala 
18af245d11STodd Fiala // C++ Includes
19af245d11STodd Fiala #include <fstream>
20df7c6995SPavel Labath #include <mutex>
21c076559aSPavel Labath #include <sstream>
22af245d11STodd Fiala #include <string>
235b981ab9SPavel Labath #include <unordered_map>
24af245d11STodd Fiala 
25af245d11STodd Fiala // Other libraries and framework includes
26d8c338d4STamas Berghammer #include "lldb/Core/EmulateInstruction.h"
276edef204SOleksiy Vyalov #include "lldb/Core/ModuleSpec.h"
28af245d11STodd Fiala #include "lldb/Core/RegisterValue.h"
29af245d11STodd Fiala #include "lldb/Core/State.h"
30af245d11STodd Fiala #include "lldb/Host/Host.h"
315ad891f7SPavel Labath #include "lldb/Host/HostProcess.h"
3224ae6294SZachary Turner #include "lldb/Host/PseudoTerminal.h"
3339de3110SZachary Turner #include "lldb/Host/ThreadLauncher.h"
342a86b555SPavel Labath #include "lldb/Host/common/NativeBreakpoint.h"
352a86b555SPavel Labath #include "lldb/Host/common/NativeRegisterContext.h"
364ee1c952SPavel Labath #include "lldb/Host/linux/Ptrace.h"
374ee1c952SPavel Labath #include "lldb/Host/linux/Uio.h"
38816ae4b0SKamil Rytarowski #include "lldb/Host/posix/ProcessLauncherPosixFork.h"
392a86b555SPavel Labath #include "lldb/Symbol/ObjectFile.h"
4090aff47cSZachary Turner #include "lldb/Target/Process.h"
41af245d11STodd Fiala #include "lldb/Target/ProcessLaunchInfo.h"
425b981ab9SPavel Labath #include "lldb/Target/Target.h"
43bf9a7730SZachary Turner #include "lldb/Utility/Error.h"
44c16f5dcaSChaoren Lin #include "lldb/Utility/LLDBAssert.h"
45f805e190SPavel Labath #include "lldb/Utility/StringExtractor.h"
46af245d11STodd Fiala 
47af245d11STodd Fiala #include "NativeThreadLinux.h"
48b9c1b51eSKate Stone #include "Plugins/Process/POSIX/ProcessPOSIXLog.h"
49af245d11STodd Fiala #include "ProcFileReader.h"
501e209fccSTamas Berghammer #include "Procfs.h"
51cacde7dfSTodd Fiala 
524ee1c952SPavel Labath #include "llvm/Support/Threading.h"
534ee1c952SPavel Labath 
54d858487eSTamas Berghammer #include <linux/unistd.h>
55d858487eSTamas Berghammer #include <sys/socket.h>
56df7c6995SPavel Labath #include <sys/syscall.h>
57d858487eSTamas Berghammer #include <sys/types.h>
58d858487eSTamas Berghammer #include <sys/user.h>
59d858487eSTamas Berghammer #include <sys/wait.h>
60d858487eSTamas Berghammer 
61af245d11STodd Fiala // Support hardware breakpoints in case it has not been defined
62af245d11STodd Fiala #ifndef TRAP_HWBKPT
63af245d11STodd Fiala #define TRAP_HWBKPT 4
64af245d11STodd Fiala #endif
65af245d11STodd Fiala 
667cb18bf5STamas Berghammer using namespace lldb;
677cb18bf5STamas Berghammer using namespace lldb_private;
68db264a6dSTamas Berghammer using namespace lldb_private::process_linux;
697cb18bf5STamas Berghammer using namespace llvm;
707cb18bf5STamas Berghammer 
71af245d11STodd Fiala // Private bits we only need internally.
72df7c6995SPavel Labath 
73b9c1b51eSKate Stone static bool ProcessVmReadvSupported() {
74df7c6995SPavel Labath   static bool is_supported;
75c5f28e2aSKamil Rytarowski   static llvm::once_flag flag;
76df7c6995SPavel Labath 
77c5f28e2aSKamil Rytarowski   llvm::call_once(flag, [] {
78a6321a8eSPavel Labath     Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
79df7c6995SPavel Labath 
80df7c6995SPavel Labath     uint32_t source = 0x47424742;
81df7c6995SPavel Labath     uint32_t dest = 0;
82df7c6995SPavel Labath 
83df7c6995SPavel Labath     struct iovec local, remote;
84df7c6995SPavel Labath     remote.iov_base = &source;
85df7c6995SPavel Labath     local.iov_base = &dest;
86df7c6995SPavel Labath     remote.iov_len = local.iov_len = sizeof source;
87df7c6995SPavel Labath 
88b9c1b51eSKate Stone     // We shall try if cross-process-memory reads work by attempting to read a
89b9c1b51eSKate Stone     // value from our own process.
90df7c6995SPavel Labath     ssize_t res = process_vm_readv(getpid(), &local, 1, &remote, 1, 0);
91df7c6995SPavel Labath     is_supported = (res == sizeof(source) && source == dest);
92df7c6995SPavel Labath     if (is_supported)
93a6321a8eSPavel Labath       LLDB_LOG(log,
94a6321a8eSPavel Labath                "Detected kernel support for process_vm_readv syscall. "
95a6321a8eSPavel Labath                "Fast memory reads enabled.");
96df7c6995SPavel Labath     else
97a6321a8eSPavel Labath       LLDB_LOG(log,
98a6321a8eSPavel Labath                "syscall process_vm_readv failed (error: {0}). Fast memory "
99a6321a8eSPavel Labath                "reads disabled.",
100a6321a8eSPavel Labath                strerror(errno));
101df7c6995SPavel Labath   });
102df7c6995SPavel Labath 
103df7c6995SPavel Labath   return is_supported;
104df7c6995SPavel Labath }
105df7c6995SPavel Labath 
106b9c1b51eSKate Stone namespace {
107b9c1b51eSKate Stone void MaybeLogLaunchInfo(const ProcessLaunchInfo &info) {
108a6321a8eSPavel Labath   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
1094abe5d69SPavel Labath   if (!log)
1104abe5d69SPavel Labath     return;
1114abe5d69SPavel Labath 
1124abe5d69SPavel Labath   if (const FileAction *action = info.GetFileActionForFD(STDIN_FILENO))
113a6321a8eSPavel Labath     LLDB_LOG(log, "setting STDIN to '{0}'", action->GetFileSpec());
1144abe5d69SPavel Labath   else
115a6321a8eSPavel Labath     LLDB_LOG(log, "leaving STDIN as is");
1164abe5d69SPavel Labath 
1174abe5d69SPavel Labath   if (const FileAction *action = info.GetFileActionForFD(STDOUT_FILENO))
118a6321a8eSPavel Labath     LLDB_LOG(log, "setting STDOUT to '{0}'", action->GetFileSpec());
1194abe5d69SPavel Labath   else
120a6321a8eSPavel Labath     LLDB_LOG(log, "leaving STDOUT as is");
1214abe5d69SPavel Labath 
1224abe5d69SPavel Labath   if (const FileAction *action = info.GetFileActionForFD(STDERR_FILENO))
123a6321a8eSPavel Labath     LLDB_LOG(log, "setting STDERR to '{0}'", action->GetFileSpec());
1244abe5d69SPavel Labath   else
125a6321a8eSPavel Labath     LLDB_LOG(log, "leaving STDERR as is");
1264abe5d69SPavel Labath 
1274abe5d69SPavel Labath   int i = 0;
128b9c1b51eSKate Stone   for (const char **args = info.GetArguments().GetConstArgumentVector(); *args;
129b9c1b51eSKate Stone        ++args, ++i)
130a6321a8eSPavel Labath     LLDB_LOG(log, "arg {0}: '{1}'", i, *args);
1314abe5d69SPavel Labath }
1324abe5d69SPavel Labath 
133b9c1b51eSKate Stone void DisplayBytes(StreamString &s, void *bytes, uint32_t count) {
134af245d11STodd Fiala   uint8_t *ptr = (uint8_t *)bytes;
135af245d11STodd Fiala   const uint32_t loop_count = std::min<uint32_t>(DEBUG_PTRACE_MAXBYTES, count);
136b9c1b51eSKate Stone   for (uint32_t i = 0; i < loop_count; i++) {
137af245d11STodd Fiala     s.Printf("[%x]", *ptr);
138af245d11STodd Fiala     ptr++;
139af245d11STodd Fiala   }
140af245d11STodd Fiala }
141af245d11STodd Fiala 
142b9c1b51eSKate Stone void PtraceDisplayBytes(int &req, void *data, size_t data_size) {
143aafe053cSPavel Labath   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PTRACE));
144a6321a8eSPavel Labath   if (!log)
145a6321a8eSPavel Labath     return;
146af245d11STodd Fiala   StreamString buf;
147af245d11STodd Fiala 
148b9c1b51eSKate Stone   switch (req) {
149b9c1b51eSKate Stone   case PTRACE_POKETEXT: {
150af245d11STodd Fiala     DisplayBytes(buf, &data, 8);
151aafe053cSPavel Labath     LLDB_LOGV(log, "PTRACE_POKETEXT {0}", buf.GetData());
152af245d11STodd Fiala     break;
153af245d11STodd Fiala   }
154b9c1b51eSKate Stone   case PTRACE_POKEDATA: {
155af245d11STodd Fiala     DisplayBytes(buf, &data, 8);
156aafe053cSPavel Labath     LLDB_LOGV(log, "PTRACE_POKEDATA {0}", buf.GetData());
157af245d11STodd Fiala     break;
158af245d11STodd Fiala   }
159b9c1b51eSKate Stone   case PTRACE_POKEUSER: {
160af245d11STodd Fiala     DisplayBytes(buf, &data, 8);
161aafe053cSPavel Labath     LLDB_LOGV(log, "PTRACE_POKEUSER {0}", buf.GetData());
162af245d11STodd Fiala     break;
163af245d11STodd Fiala   }
164b9c1b51eSKate Stone   case PTRACE_SETREGS: {
165af245d11STodd Fiala     DisplayBytes(buf, data, data_size);
166aafe053cSPavel Labath     LLDB_LOGV(log, "PTRACE_SETREGS {0}", buf.GetData());
167af245d11STodd Fiala     break;
168af245d11STodd Fiala   }
169b9c1b51eSKate Stone   case PTRACE_SETFPREGS: {
170af245d11STodd Fiala     DisplayBytes(buf, data, data_size);
171aafe053cSPavel Labath     LLDB_LOGV(log, "PTRACE_SETFPREGS {0}", buf.GetData());
172af245d11STodd Fiala     break;
173af245d11STodd Fiala   }
174b9c1b51eSKate Stone   case PTRACE_SETSIGINFO: {
175af245d11STodd Fiala     DisplayBytes(buf, data, sizeof(siginfo_t));
176aafe053cSPavel Labath     LLDB_LOGV(log, "PTRACE_SETSIGINFO {0}", buf.GetData());
177af245d11STodd Fiala     break;
178af245d11STodd Fiala   }
179b9c1b51eSKate Stone   case PTRACE_SETREGSET: {
180af245d11STodd Fiala     // Extract iov_base from data, which is a pointer to the struct IOVEC
181af245d11STodd Fiala     DisplayBytes(buf, *(void **)data, data_size);
182aafe053cSPavel Labath     LLDB_LOGV(log, "PTRACE_SETREGSET {0}", buf.GetData());
183af245d11STodd Fiala     break;
184af245d11STodd Fiala   }
185b9c1b51eSKate Stone   default: {}
186af245d11STodd Fiala   }
187af245d11STodd Fiala }
188af245d11STodd Fiala 
18919cbe96aSPavel Labath static constexpr unsigned k_ptrace_word_size = sizeof(void *);
190b9c1b51eSKate Stone static_assert(sizeof(long) >= k_ptrace_word_size,
191b9c1b51eSKate Stone               "Size of long must be larger than ptrace word size");
1921107b5a5SPavel Labath } // end of anonymous namespace
1931107b5a5SPavel Labath 
194bd7cbc5aSPavel Labath // Simple helper function to ensure flags are enabled on the given file
195bd7cbc5aSPavel Labath // descriptor.
196b9c1b51eSKate Stone static Error EnsureFDFlags(int fd, int flags) {
197bd7cbc5aSPavel Labath   Error error;
198bd7cbc5aSPavel Labath 
199bd7cbc5aSPavel Labath   int status = fcntl(fd, F_GETFL);
200b9c1b51eSKate Stone   if (status == -1) {
201bd7cbc5aSPavel Labath     error.SetErrorToErrno();
202bd7cbc5aSPavel Labath     return error;
203bd7cbc5aSPavel Labath   }
204bd7cbc5aSPavel Labath 
205b9c1b51eSKate Stone   if (fcntl(fd, F_SETFL, status | flags) == -1) {
206bd7cbc5aSPavel Labath     error.SetErrorToErrno();
207bd7cbc5aSPavel Labath     return error;
208bd7cbc5aSPavel Labath   }
209bd7cbc5aSPavel Labath 
210bd7cbc5aSPavel Labath   return error;
211bd7cbc5aSPavel Labath }
212bd7cbc5aSPavel Labath 
213af245d11STodd Fiala // -----------------------------------------------------------------------------
214af245d11STodd Fiala // Public Static Methods
215af245d11STodd Fiala // -----------------------------------------------------------------------------
216af245d11STodd Fiala 
217b9c1b51eSKate Stone Error NativeProcessProtocol::Launch(
218db264a6dSTamas Berghammer     ProcessLaunchInfo &launch_info,
219b9c1b51eSKate Stone     NativeProcessProtocol::NativeDelegate &native_delegate, MainLoop &mainloop,
220b9c1b51eSKate Stone     NativeProcessProtocolSP &native_process_sp) {
221a6321a8eSPavel Labath   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
222af245d11STodd Fiala 
2232a86b555SPavel Labath   Error error;
224af245d11STodd Fiala 
225af245d11STodd Fiala   // Verify the working directory is valid if one was specified.
226d3173f34SChaoren Lin   FileSpec working_dir{launch_info.GetWorkingDirectory()};
227d3173f34SChaoren Lin   if (working_dir &&
228d3173f34SChaoren Lin       (!working_dir.ResolvePath() ||
229b9c1b51eSKate Stone        working_dir.GetFileType() != FileSpec::eFileTypeDirectory)) {
230d3173f34SChaoren Lin     error.SetErrorStringWithFormat("No such file or directory: %s",
231d3173f34SChaoren Lin                                    working_dir.GetCString());
232af245d11STodd Fiala     return error;
233af245d11STodd Fiala   }
234af245d11STodd Fiala 
235af245d11STodd Fiala   // Create the NativeProcessLinux in launch mode.
236af245d11STodd Fiala   native_process_sp.reset(new NativeProcessLinux());
237af245d11STodd Fiala 
238b9c1b51eSKate Stone   if (!native_process_sp->RegisterNativeDelegate(native_delegate)) {
239af245d11STodd Fiala     native_process_sp.reset();
240af245d11STodd Fiala     error.SetErrorStringWithFormat("failed to register the native delegate");
241af245d11STodd Fiala     return error;
242af245d11STodd Fiala   }
243af245d11STodd Fiala 
244b9c1b51eSKate Stone   error = std::static_pointer_cast<NativeProcessLinux>(native_process_sp)
245b9c1b51eSKate Stone               ->LaunchInferior(mainloop, launch_info);
246af245d11STodd Fiala 
247b9c1b51eSKate Stone   if (error.Fail()) {
248af245d11STodd Fiala     native_process_sp.reset();
249a6321a8eSPavel Labath     LLDB_LOG(log, "failed to launch process: {0}", error);
250af245d11STodd Fiala     return error;
251af245d11STodd Fiala   }
252af245d11STodd Fiala 
253af245d11STodd Fiala   launch_info.SetProcessID(native_process_sp->GetID());
254af245d11STodd Fiala 
255af245d11STodd Fiala   return error;
256af245d11STodd Fiala }
257af245d11STodd Fiala 
258b9c1b51eSKate Stone Error NativeProcessProtocol::Attach(
259b9c1b51eSKate Stone     lldb::pid_t pid, NativeProcessProtocol::NativeDelegate &native_delegate,
260b9c1b51eSKate Stone     MainLoop &mainloop, NativeProcessProtocolSP &native_process_sp) {
261a6321a8eSPavel Labath   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
262a6321a8eSPavel Labath   LLDB_LOG(log, "pid = {0:x}", pid);
263af245d11STodd Fiala 
264af245d11STodd Fiala   // Retrieve the architecture for the running process.
265af245d11STodd Fiala   ArchSpec process_arch;
2662a86b555SPavel Labath   Error error = ResolveProcessArchitecture(pid, process_arch);
267af245d11STodd Fiala   if (!error.Success())
268af245d11STodd Fiala     return error;
269af245d11STodd Fiala 
270b9c1b51eSKate Stone   std::shared_ptr<NativeProcessLinux> native_process_linux_sp(
271b9c1b51eSKate Stone       new NativeProcessLinux());
272af245d11STodd Fiala 
273b9c1b51eSKate Stone   if (!native_process_linux_sp->RegisterNativeDelegate(native_delegate)) {
274af245d11STodd Fiala     error.SetErrorStringWithFormat("failed to register the native delegate");
275af245d11STodd Fiala     return error;
276af245d11STodd Fiala   }
277af245d11STodd Fiala 
27819cbe96aSPavel Labath   native_process_linux_sp->AttachToInferior(mainloop, pid, error);
279af245d11STodd Fiala   if (!error.Success())
280af245d11STodd Fiala     return error;
281af245d11STodd Fiala 
2821339b5e8SOleksiy Vyalov   native_process_sp = native_process_linux_sp;
283af245d11STodd Fiala   return error;
284af245d11STodd Fiala }
285af245d11STodd Fiala 
286af245d11STodd Fiala // -----------------------------------------------------------------------------
287af245d11STodd Fiala // Public Instance Methods
288af245d11STodd Fiala // -----------------------------------------------------------------------------
289af245d11STodd Fiala 
290b9c1b51eSKate Stone NativeProcessLinux::NativeProcessLinux()
291b9c1b51eSKate Stone     : NativeProcessProtocol(LLDB_INVALID_PROCESS_ID), m_arch(),
292b9c1b51eSKate Stone       m_supports_mem_region(eLazyBoolCalculate), m_mem_region_cache(),
293b9c1b51eSKate Stone       m_pending_notification_tid(LLDB_INVALID_THREAD_ID) {}
294af245d11STodd Fiala 
295b9c1b51eSKate Stone void NativeProcessLinux::AttachToInferior(MainLoop &mainloop, lldb::pid_t pid,
296b9c1b51eSKate Stone                                           Error &error) {
297a6321a8eSPavel Labath   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
298a6321a8eSPavel Labath   LLDB_LOG(log, "pid = {0:x}", pid);
299af245d11STodd Fiala 
300b9c1b51eSKate Stone   m_sigchld_handle = mainloop.RegisterSignal(
301b9c1b51eSKate Stone       SIGCHLD, [this](MainLoopBase &) { SigchldHandler(); }, error);
30219cbe96aSPavel Labath   if (!m_sigchld_handle)
30319cbe96aSPavel Labath     return;
30419cbe96aSPavel Labath 
3052a86b555SPavel Labath   error = ResolveProcessArchitecture(pid, m_arch);
306af245d11STodd Fiala   if (!error.Success())
307af245d11STodd Fiala     return;
308af245d11STodd Fiala 
309af245d11STodd Fiala   // Set the architecture to the exe architecture.
310a6321a8eSPavel Labath   LLDB_LOG(log, "pid = {0:x}, detected architecture {1}", pid,
311a6321a8eSPavel Labath            m_arch.GetArchitectureName());
312af245d11STodd Fiala   m_pid = pid;
313af245d11STodd Fiala   SetState(eStateAttaching);
314af245d11STodd Fiala 
31519cbe96aSPavel Labath   Attach(pid, error);
316af245d11STodd Fiala }
317af245d11STodd Fiala 
318b9c1b51eSKate Stone Error NativeProcessLinux::LaunchInferior(MainLoop &mainloop,
319b9c1b51eSKate Stone                                          ProcessLaunchInfo &launch_info) {
3204abe5d69SPavel Labath   Error error;
321b9c1b51eSKate Stone   m_sigchld_handle = mainloop.RegisterSignal(
322b9c1b51eSKate Stone       SIGCHLD, [this](MainLoopBase &) { SigchldHandler(); }, error);
3234abe5d69SPavel Labath   if (!m_sigchld_handle)
3244abe5d69SPavel Labath     return error;
3254abe5d69SPavel Labath 
3264abe5d69SPavel Labath   SetState(eStateLaunching);
3270c4f01d4SPavel Labath 
3284abe5d69SPavel Labath   MaybeLogLaunchInfo(launch_info);
3294abe5d69SPavel Labath 
330b9c1b51eSKate Stone   ::pid_t pid =
331816ae4b0SKamil Rytarowski       ProcessLauncherPosixFork().LaunchProcess(launch_info, error).GetProcessId();
3325ad891f7SPavel Labath   if (error.Fail())
3334abe5d69SPavel Labath     return error;
3340c4f01d4SPavel Labath 
335a6321a8eSPavel Labath   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
33675f47c3aSTodd Fiala 
337af245d11STodd Fiala   // Wait for the child process to trap on its call to execve.
338af245d11STodd Fiala   ::pid_t wpid;
339af245d11STodd Fiala   int status;
340b9c1b51eSKate Stone   if ((wpid = waitpid(pid, &status, 0)) < 0) {
341bd7cbc5aSPavel Labath     error.SetErrorToErrno();
342a6321a8eSPavel Labath     LLDB_LOG(log, "waitpid for inferior failed with %s", error);
343af245d11STodd Fiala 
344af245d11STodd Fiala     // Mark the inferior as invalid.
345b9c1b51eSKate Stone     // FIXME this could really use a new state - eStateLaunchFailure.  For now,
346b9c1b51eSKate Stone     // using eStateInvalid.
347bd7cbc5aSPavel Labath     SetState(StateType::eStateInvalid);
348af245d11STodd Fiala 
3494abe5d69SPavel Labath     return error;
350af245d11STodd Fiala   }
351af245d11STodd Fiala   assert(WIFSTOPPED(status) && (wpid == static_cast<::pid_t>(pid)) &&
352af245d11STodd Fiala          "Could not sync with inferior process.");
353af245d11STodd Fiala 
354a6321a8eSPavel Labath   LLDB_LOG(log, "inferior started, now in stopped state");
355bd7cbc5aSPavel Labath   error = SetDefaultPtraceOpts(pid);
356b9c1b51eSKate Stone   if (error.Fail()) {
357a6321a8eSPavel Labath     LLDB_LOG(log, "failed to set default ptrace options: {0}", error);
358af245d11STodd Fiala 
359af245d11STodd Fiala     // Mark the inferior as invalid.
360b9c1b51eSKate Stone     // FIXME this could really use a new state - eStateLaunchFailure.  For now,
361b9c1b51eSKate Stone     // using eStateInvalid.
362bd7cbc5aSPavel Labath     SetState(StateType::eStateInvalid);
363af245d11STodd Fiala 
3644abe5d69SPavel Labath     return error;
365af245d11STodd Fiala   }
366af245d11STodd Fiala 
367af245d11STodd Fiala   // Release the master terminal descriptor and pass it off to the
368af245d11STodd Fiala   // NativeProcessLinux instance.  Similarly stash the inferior pid.
3695ad891f7SPavel Labath   m_terminal_fd = launch_info.GetPTY().ReleaseMasterFileDescriptor();
370bd7cbc5aSPavel Labath   m_pid = pid;
3714abe5d69SPavel Labath   launch_info.SetProcessID(pid);
372af245d11STodd Fiala 
373b9c1b51eSKate Stone   if (m_terminal_fd != -1) {
374bd7cbc5aSPavel Labath     error = EnsureFDFlags(m_terminal_fd, O_NONBLOCK);
375b9c1b51eSKate Stone     if (error.Fail()) {
376a6321a8eSPavel Labath       LLDB_LOG(log,
377a6321a8eSPavel Labath                "inferior EnsureFDFlags failed for ensuring terminal "
378a6321a8eSPavel Labath                "O_NONBLOCK setting: {0}",
379a6321a8eSPavel Labath                error);
380af245d11STodd Fiala 
381af245d11STodd Fiala       // Mark the inferior as invalid.
382b9c1b51eSKate Stone       // FIXME this could really use a new state - eStateLaunchFailure.  For
383b9c1b51eSKate Stone       // now, using eStateInvalid.
384bd7cbc5aSPavel Labath       SetState(StateType::eStateInvalid);
385af245d11STodd Fiala 
3864abe5d69SPavel Labath       return error;
387af245d11STodd Fiala     }
3885ad891f7SPavel Labath   }
389af245d11STodd Fiala 
390a6321a8eSPavel Labath   LLDB_LOG(log, "adding pid = {0}", pid);
3912a86b555SPavel Labath   ResolveProcessArchitecture(m_pid, m_arch);
392f9077782SPavel Labath   NativeThreadLinuxSP thread_sp = AddThread(pid);
393af245d11STodd Fiala   assert(thread_sp && "AddThread() returned a nullptr thread");
394f9077782SPavel Labath   thread_sp->SetStoppedBySignal(SIGSTOP);
395f9077782SPavel Labath   ThreadWasCreated(*thread_sp);
396af245d11STodd Fiala 
397af245d11STodd Fiala   // Let our process instance know the thread has stopped.
398bd7cbc5aSPavel Labath   SetCurrentThreadID(thread_sp->GetID());
399bd7cbc5aSPavel Labath   SetState(StateType::eStateStopped);
400af245d11STodd Fiala 
401a6321a8eSPavel Labath   if (error.Fail())
402a6321a8eSPavel Labath     LLDB_LOG(log, "inferior launching failed {0}", error);
4034abe5d69SPavel Labath   return error;
404af245d11STodd Fiala }
405af245d11STodd Fiala 
406b9c1b51eSKate Stone ::pid_t NativeProcessLinux::Attach(lldb::pid_t pid, Error &error) {
407a6321a8eSPavel Labath   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
408af245d11STodd Fiala 
409b9c1b51eSKate Stone   // Use a map to keep track of the threads which we have attached/need to
410b9c1b51eSKate Stone   // attach.
411af245d11STodd Fiala   Host::TidMap tids_to_attach;
412b9c1b51eSKate Stone   if (pid <= 1) {
413bd7cbc5aSPavel Labath     error.SetErrorToGenericError();
414bd7cbc5aSPavel Labath     error.SetErrorString("Attaching to process 1 is not allowed.");
415bd7cbc5aSPavel Labath     return -1;
416af245d11STodd Fiala   }
417af245d11STodd Fiala 
418b9c1b51eSKate Stone   while (Host::FindProcessThreads(pid, tids_to_attach)) {
419af245d11STodd Fiala     for (Host::TidMap::iterator it = tids_to_attach.begin();
420b9c1b51eSKate Stone          it != tids_to_attach.end();) {
421b9c1b51eSKate Stone       if (it->second == false) {
422af245d11STodd Fiala         lldb::tid_t tid = it->first;
423af245d11STodd Fiala 
424af245d11STodd Fiala         // Attach to the requested process.
425af245d11STodd Fiala         // An attach will cause the thread to stop with a SIGSTOP.
4264a9babb2SPavel Labath         error = PtraceWrapper(PTRACE_ATTACH, tid);
427b9c1b51eSKate Stone         if (error.Fail()) {
428af245d11STodd Fiala           // No such thread. The thread may have exited.
429af245d11STodd Fiala           // More error handling may be needed.
430b9c1b51eSKate Stone           if (error.GetError() == ESRCH) {
431af245d11STodd Fiala             it = tids_to_attach.erase(it);
432af245d11STodd Fiala             continue;
433b9c1b51eSKate Stone           } else
434bd7cbc5aSPavel Labath             return -1;
435af245d11STodd Fiala         }
436af245d11STodd Fiala 
437af245d11STodd Fiala         int status;
438af245d11STodd Fiala         // Need to use __WALL otherwise we receive an error with errno=ECHLD
439af245d11STodd Fiala         // At this point we should have a thread stopped if waitpid succeeds.
440b9c1b51eSKate Stone         if ((status = waitpid(tid, NULL, __WALL)) < 0) {
441af245d11STodd Fiala           // No such thread. The thread may have exited.
442af245d11STodd Fiala           // More error handling may be needed.
443b9c1b51eSKate Stone           if (errno == ESRCH) {
444af245d11STodd Fiala             it = tids_to_attach.erase(it);
445af245d11STodd Fiala             continue;
446b9c1b51eSKate Stone           } else {
447bd7cbc5aSPavel Labath             error.SetErrorToErrno();
448bd7cbc5aSPavel Labath             return -1;
449af245d11STodd Fiala           }
450af245d11STodd Fiala         }
451af245d11STodd Fiala 
452bd7cbc5aSPavel Labath         error = SetDefaultPtraceOpts(tid);
453bd7cbc5aSPavel Labath         if (error.Fail())
454bd7cbc5aSPavel Labath           return -1;
455af245d11STodd Fiala 
456a6321a8eSPavel Labath         LLDB_LOG(log, "adding tid = {0}", tid);
457af245d11STodd Fiala         it->second = true;
458af245d11STodd Fiala 
459af245d11STodd Fiala         // Create the thread, mark it as stopped.
460f9077782SPavel Labath         NativeThreadLinuxSP thread_sp(AddThread(static_cast<lldb::tid_t>(tid)));
461af245d11STodd Fiala         assert(thread_sp && "AddThread() returned a nullptr");
462fa03ad2eSChaoren Lin 
463b9c1b51eSKate Stone         // This will notify this is a new thread and tell the system it is
464b9c1b51eSKate Stone         // stopped.
465f9077782SPavel Labath         thread_sp->SetStoppedBySignal(SIGSTOP);
466f9077782SPavel Labath         ThreadWasCreated(*thread_sp);
467bd7cbc5aSPavel Labath         SetCurrentThreadID(thread_sp->GetID());
468af245d11STodd Fiala       }
469af245d11STodd Fiala 
470af245d11STodd Fiala       // move the loop forward
471af245d11STodd Fiala       ++it;
472af245d11STodd Fiala     }
473af245d11STodd Fiala   }
474af245d11STodd Fiala 
475b9c1b51eSKate Stone   if (tids_to_attach.size() > 0) {
476bd7cbc5aSPavel Labath     m_pid = pid;
477af245d11STodd Fiala     // Let our process instance know the thread has stopped.
478bd7cbc5aSPavel Labath     SetState(StateType::eStateStopped);
479b9c1b51eSKate Stone   } else {
480bd7cbc5aSPavel Labath     error.SetErrorToGenericError();
481bd7cbc5aSPavel Labath     error.SetErrorString("No such process.");
482bd7cbc5aSPavel Labath     return -1;
483af245d11STodd Fiala   }
484af245d11STodd Fiala 
485bd7cbc5aSPavel Labath   return pid;
486af245d11STodd Fiala }
487af245d11STodd Fiala 
488b9c1b51eSKate Stone Error NativeProcessLinux::SetDefaultPtraceOpts(lldb::pid_t pid) {
489af245d11STodd Fiala   long ptrace_opts = 0;
490af245d11STodd Fiala 
491af245d11STodd Fiala   // Have the child raise an event on exit.  This is used to keep the child in
492af245d11STodd Fiala   // limbo until it is destroyed.
493af245d11STodd Fiala   ptrace_opts |= PTRACE_O_TRACEEXIT;
494af245d11STodd Fiala 
495af245d11STodd Fiala   // Have the tracer trace threads which spawn in the inferior process.
496af245d11STodd Fiala   // TODO: if we want to support tracing the inferiors' child, add the
497af245d11STodd Fiala   // appropriate ptrace flags here (PTRACE_O_TRACEFORK, PTRACE_O_TRACEVFORK)
498af245d11STodd Fiala   ptrace_opts |= PTRACE_O_TRACECLONE;
499af245d11STodd Fiala 
500af245d11STodd Fiala   // Have the tracer notify us before execve returns
501af245d11STodd Fiala   // (needed to disable legacy SIGTRAP generation)
502af245d11STodd Fiala   ptrace_opts |= PTRACE_O_TRACEEXEC;
503af245d11STodd Fiala 
5044a9babb2SPavel Labath   return PtraceWrapper(PTRACE_SETOPTIONS, pid, nullptr, (void *)ptrace_opts);
505af245d11STodd Fiala }
506af245d11STodd Fiala 
507b9c1b51eSKate Stone static ExitType convert_pid_status_to_exit_type(int status) {
508af245d11STodd Fiala   if (WIFEXITED(status))
509af245d11STodd Fiala     return ExitType::eExitTypeExit;
510af245d11STodd Fiala   else if (WIFSIGNALED(status))
511af245d11STodd Fiala     return ExitType::eExitTypeSignal;
512af245d11STodd Fiala   else if (WIFSTOPPED(status))
513af245d11STodd Fiala     return ExitType::eExitTypeStop;
514b9c1b51eSKate Stone   else {
515af245d11STodd Fiala     // We don't know what this is.
516af245d11STodd Fiala     return ExitType::eExitTypeInvalid;
517af245d11STodd Fiala   }
518af245d11STodd Fiala }
519af245d11STodd Fiala 
520b9c1b51eSKate Stone static int convert_pid_status_to_return_code(int status) {
521af245d11STodd Fiala   if (WIFEXITED(status))
522af245d11STodd Fiala     return WEXITSTATUS(status);
523af245d11STodd Fiala   else if (WIFSIGNALED(status))
524af245d11STodd Fiala     return WTERMSIG(status);
525af245d11STodd Fiala   else if (WIFSTOPPED(status))
526af245d11STodd Fiala     return WSTOPSIG(status);
527b9c1b51eSKate Stone   else {
528af245d11STodd Fiala     // We don't know what this is.
529af245d11STodd Fiala     return ExitType::eExitTypeInvalid;
530af245d11STodd Fiala   }
531af245d11STodd Fiala }
532af245d11STodd Fiala 
5331107b5a5SPavel Labath // Handles all waitpid events from the inferior process.
534b9c1b51eSKate Stone void NativeProcessLinux::MonitorCallback(lldb::pid_t pid, bool exited,
535b9c1b51eSKate Stone                                          int signal, int status) {
536af245d11STodd Fiala   Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS));
537af245d11STodd Fiala 
538b9c1b51eSKate Stone   // Certain activities differ based on whether the pid is the tid of the main
539b9c1b51eSKate Stone   // thread.
5401107b5a5SPavel Labath   const bool is_main_thread = (pid == GetID());
541af245d11STodd Fiala 
542af245d11STodd Fiala   // Handle when the thread exits.
543b9c1b51eSKate Stone   if (exited) {
544a6321a8eSPavel Labath     LLDB_LOG(log, "got exit signal({0}) , tid = {1} ({2} main thread)", signal,
545a6321a8eSPavel Labath              pid, is_main_thread ? "is" : "is not");
546af245d11STodd Fiala 
547af245d11STodd Fiala     // This is a thread that exited.  Ensure we're not tracking it anymore.
5481107b5a5SPavel Labath     const bool thread_found = StopTrackingThread(pid);
549af245d11STodd Fiala 
550b9c1b51eSKate Stone     if (is_main_thread) {
551b9c1b51eSKate Stone       // We only set the exit status and notify the delegate if we haven't
552b9c1b51eSKate Stone       // already set the process
553b9c1b51eSKate Stone       // state to an exited state.  We normally should have received a SIGTRAP |
554b9c1b51eSKate Stone       // (PTRACE_EVENT_EXIT << 8)
555af245d11STodd Fiala       // for the main thread.
556b9c1b51eSKate Stone       const bool already_notified = (GetState() == StateType::eStateExited) ||
557b9c1b51eSKate Stone                                     (GetState() == StateType::eStateCrashed);
558b9c1b51eSKate Stone       if (!already_notified) {
559a6321a8eSPavel Labath         LLDB_LOG(
560a6321a8eSPavel Labath             log,
561a6321a8eSPavel Labath             "tid = {0} handling main thread exit ({1}), expected exit state "
562a6321a8eSPavel Labath             "already set but state was {2} instead, setting exit state now",
563a6321a8eSPavel Labath             pid,
564b9c1b51eSKate Stone             thread_found ? "stopped tracking thread metadata"
565b9c1b51eSKate Stone                          : "thread metadata not found",
5668198db30SPavel Labath             GetState());
567af245d11STodd Fiala         // The main thread exited.  We're done monitoring.  Report to delegate.
568b9c1b51eSKate Stone         SetExitStatus(convert_pid_status_to_exit_type(status),
569b9c1b51eSKate Stone                       convert_pid_status_to_return_code(status), nullptr, true);
570af245d11STodd Fiala 
571af245d11STodd Fiala         // Notify delegate that our process has exited.
5721107b5a5SPavel Labath         SetState(StateType::eStateExited, true);
573a6321a8eSPavel Labath       } else
574a6321a8eSPavel Labath         LLDB_LOG(log, "tid = {0} main thread now exited (%s)", pid,
575b9c1b51eSKate Stone                  thread_found ? "stopped tracking thread metadata"
576b9c1b51eSKate Stone                               : "thread metadata not found");
577b9c1b51eSKate Stone     } else {
578b9c1b51eSKate Stone       // Do we want to report to the delegate in this case?  I think not.  If
579a6321a8eSPavel Labath       // this was an orderly thread exit, we would already have received the
580a6321a8eSPavel Labath       // SIGTRAP | (PTRACE_EVENT_EXIT << 8) signal, and we would have done an
581a6321a8eSPavel Labath       // all-stop then.
582a6321a8eSPavel Labath       LLDB_LOG(log, "tid = {0} handling non-main thread exit (%s)", pid,
583b9c1b51eSKate Stone                thread_found ? "stopped tracking thread metadata"
584b9c1b51eSKate Stone                             : "thread metadata not found");
585af245d11STodd Fiala     }
5861107b5a5SPavel Labath     return;
587af245d11STodd Fiala   }
588af245d11STodd Fiala 
589af245d11STodd Fiala   siginfo_t info;
590b9cc0c75SPavel Labath   const auto info_err = GetSignalInfo(pid, &info);
591b9cc0c75SPavel Labath   auto thread_sp = GetThreadByID(pid);
592b9cc0c75SPavel Labath 
593b9c1b51eSKate Stone   if (!thread_sp) {
594b9c1b51eSKate Stone     // Normally, the only situation when we cannot find the thread is if we have
595a6321a8eSPavel Labath     // just received a new thread notification. This is indicated by
596a6321a8eSPavel Labath     // GetSignalInfo() returning si_code == SI_USER and si_pid == 0
597a6321a8eSPavel Labath     LLDB_LOG(log, "received notification about an unknown tid {0}.", pid);
598b9cc0c75SPavel Labath 
599b9c1b51eSKate Stone     if (info_err.Fail()) {
600a6321a8eSPavel Labath       LLDB_LOG(log,
601a6321a8eSPavel Labath                "(tid {0}) GetSignalInfo failed ({1}). "
602a6321a8eSPavel Labath                "Ingoring this notification.",
603a6321a8eSPavel Labath                pid, info_err);
604b9cc0c75SPavel Labath       return;
605b9cc0c75SPavel Labath     }
606b9cc0c75SPavel Labath 
607a6321a8eSPavel Labath     LLDB_LOG(log, "tid {0}, si_code: {1}, si_pid: {2}", pid, info.si_code,
608a6321a8eSPavel Labath              info.si_pid);
609b9cc0c75SPavel Labath 
610b9cc0c75SPavel Labath     auto thread_sp = AddThread(pid);
611b9cc0c75SPavel Labath     // Resume the newly created thread.
612b9cc0c75SPavel Labath     ResumeThread(*thread_sp, eStateRunning, LLDB_INVALID_SIGNAL_NUMBER);
613b9cc0c75SPavel Labath     ThreadWasCreated(*thread_sp);
614b9cc0c75SPavel Labath     return;
615b9cc0c75SPavel Labath   }
616b9cc0c75SPavel Labath 
617b9cc0c75SPavel Labath   // Get details on the signal raised.
618b9c1b51eSKate Stone   if (info_err.Success()) {
619fa03ad2eSChaoren Lin     // We have retrieved the signal info.  Dispatch appropriately.
620fa03ad2eSChaoren Lin     if (info.si_signo == SIGTRAP)
621b9cc0c75SPavel Labath       MonitorSIGTRAP(info, *thread_sp);
622fa03ad2eSChaoren Lin     else
623b9cc0c75SPavel Labath       MonitorSignal(info, *thread_sp, exited);
624b9c1b51eSKate Stone   } else {
625b9c1b51eSKate Stone     if (info_err.GetError() == EINVAL) {
626fa03ad2eSChaoren Lin       // This is a group stop reception for this tid.
627b9c1b51eSKate Stone       // We can reach here if we reinject SIGSTOP, SIGSTP, SIGTTIN or SIGTTOU
628a6321a8eSPavel Labath       // into the tracee, triggering the group-stop mechanism. Normally
629a6321a8eSPavel Labath       // receiving these would stop the process, pending a SIGCONT. Simulating
630a6321a8eSPavel Labath       // this state in a debugger is hard and is generally not needed (one use
631a6321a8eSPavel Labath       // case is debugging background task being managed by a shell). For
632a6321a8eSPavel Labath       // general use, it is sufficient to stop the process in a signal-delivery
633b9c1b51eSKate Stone       // stop which happens before the group stop. This done by MonitorSignal
634a6321a8eSPavel Labath       // and works correctly for all signals.
635a6321a8eSPavel Labath       LLDB_LOG(log,
636a6321a8eSPavel Labath                "received a group stop for pid {0} tid {1}. Transparent "
637a6321a8eSPavel Labath                "handling of group stops not supported, resuming the "
638a6321a8eSPavel Labath                "thread.",
639a6321a8eSPavel Labath                GetID(), pid);
640b9c1b51eSKate Stone       ResumeThread(*thread_sp, thread_sp->GetState(),
641b9c1b51eSKate Stone                    LLDB_INVALID_SIGNAL_NUMBER);
642b9c1b51eSKate Stone     } else {
643af245d11STodd Fiala       // ptrace(GETSIGINFO) failed (but not due to group-stop).
644af245d11STodd Fiala 
645b9c1b51eSKate Stone       // A return value of ESRCH means the thread/process is no longer on the
646a6321a8eSPavel Labath       // system, so it was killed somehow outside of our control.  Either way,
647a6321a8eSPavel Labath       // we can't do anything with it anymore.
648af245d11STodd Fiala 
649b9c1b51eSKate Stone       // Stop tracking the metadata for the thread since it's entirely off the
650b9c1b51eSKate Stone       // system now.
6511107b5a5SPavel Labath       const bool thread_found = StopTrackingThread(pid);
652af245d11STodd Fiala 
653a6321a8eSPavel Labath       LLDB_LOG(log,
654a6321a8eSPavel Labath                "GetSignalInfo failed: {0}, tid = {1}, signal = {2}, "
655a6321a8eSPavel Labath                "status = {3}, main_thread = {4}, thread_found: {5}",
656a6321a8eSPavel Labath                info_err, pid, signal, status, is_main_thread, thread_found);
657af245d11STodd Fiala 
658b9c1b51eSKate Stone       if (is_main_thread) {
659b9c1b51eSKate Stone         // Notify the delegate - our process is not available but appears to
660b9c1b51eSKate Stone         // have been killed outside
661af245d11STodd Fiala         // our control.  Is eStateExited the right exit state in this case?
662b9c1b51eSKate Stone         SetExitStatus(convert_pid_status_to_exit_type(status),
663b9c1b51eSKate Stone                       convert_pid_status_to_return_code(status), nullptr, true);
6641107b5a5SPavel Labath         SetState(StateType::eStateExited, true);
665b9c1b51eSKate Stone       } else {
666b9c1b51eSKate Stone         // This thread was pulled out from underneath us.  Anything to do here?
667b9c1b51eSKate Stone         // Do we want to do an all stop?
668a6321a8eSPavel Labath         LLDB_LOG(log,
669a6321a8eSPavel Labath                  "pid {0} tid {1} non-main thread exit occurred, didn't "
670a6321a8eSPavel Labath                  "tell delegate anything since thread disappeared out "
671a6321a8eSPavel Labath                  "from underneath us",
672a6321a8eSPavel Labath                  GetID(), pid);
673af245d11STodd Fiala       }
674af245d11STodd Fiala     }
675af245d11STodd Fiala   }
676af245d11STodd Fiala }
677af245d11STodd Fiala 
678b9c1b51eSKate Stone void NativeProcessLinux::WaitForNewThread(::pid_t tid) {
679a6321a8eSPavel Labath   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
680426bdf88SPavel Labath 
681f9077782SPavel Labath   NativeThreadLinuxSP new_thread_sp = GetThreadByID(tid);
682426bdf88SPavel Labath 
683b9c1b51eSKate Stone   if (new_thread_sp) {
684b9c1b51eSKate Stone     // We are already tracking the thread - we got the event on the new thread
685b9c1b51eSKate Stone     // (see
686426bdf88SPavel Labath     // MonitorSignal) before this one. We are done.
687426bdf88SPavel Labath     return;
688426bdf88SPavel Labath   }
689426bdf88SPavel Labath 
690426bdf88SPavel Labath   // The thread is not tracked yet, let's wait for it to appear.
691426bdf88SPavel Labath   int status = -1;
692426bdf88SPavel Labath   ::pid_t wait_pid;
693b9c1b51eSKate Stone   do {
694a6321a8eSPavel Labath     LLDB_LOG(log,
695a6321a8eSPavel Labath              "received thread creation event for tid {0}. tid not tracked "
696a6321a8eSPavel Labath              "yet, waiting for thread to appear...",
697a6321a8eSPavel Labath              tid);
698426bdf88SPavel Labath     wait_pid = waitpid(tid, &status, __WALL);
699b9c1b51eSKate Stone   } while (wait_pid == -1 && errno == EINTR);
700b9c1b51eSKate Stone   // Since we are waiting on a specific tid, this must be the creation event.
701a6321a8eSPavel Labath   // But let's do some checks just in case.
702426bdf88SPavel Labath   if (wait_pid != tid) {
703a6321a8eSPavel Labath     LLDB_LOG(log,
704a6321a8eSPavel Labath              "waiting for tid {0} failed. Assuming the thread has "
705a6321a8eSPavel Labath              "disappeared in the meantime",
706a6321a8eSPavel Labath              tid);
707426bdf88SPavel Labath     // The only way I know of this could happen is if the whole process was
708b9c1b51eSKate Stone     // SIGKILLed in the mean time. In any case, we can't do anything about that
709b9c1b51eSKate Stone     // now.
710426bdf88SPavel Labath     return;
711426bdf88SPavel Labath   }
712b9c1b51eSKate Stone   if (WIFEXITED(status)) {
713a6321a8eSPavel Labath     LLDB_LOG(log,
714a6321a8eSPavel Labath              "waiting for tid {0} returned an 'exited' event. Not "
715a6321a8eSPavel Labath              "tracking the thread.",
716a6321a8eSPavel Labath              tid);
717426bdf88SPavel Labath     // Also a very improbable event.
718426bdf88SPavel Labath     return;
719426bdf88SPavel Labath   }
720426bdf88SPavel Labath 
721a6321a8eSPavel Labath   LLDB_LOG(log, "pid = {0}: tracking new thread tid {1}", GetID(), tid);
722f9077782SPavel Labath   new_thread_sp = AddThread(tid);
723b9cc0c75SPavel Labath   ResumeThread(*new_thread_sp, eStateRunning, LLDB_INVALID_SIGNAL_NUMBER);
724f9077782SPavel Labath   ThreadWasCreated(*new_thread_sp);
725426bdf88SPavel Labath }
726426bdf88SPavel Labath 
727b9c1b51eSKate Stone void NativeProcessLinux::MonitorSIGTRAP(const siginfo_t &info,
728b9c1b51eSKate Stone                                         NativeThreadLinux &thread) {
729a6321a8eSPavel Labath   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
730b9cc0c75SPavel Labath   const bool is_main_thread = (thread.GetID() == GetID());
731af245d11STodd Fiala 
732b9cc0c75SPavel Labath   assert(info.si_signo == SIGTRAP && "Unexpected child signal!");
733af245d11STodd Fiala 
734b9c1b51eSKate Stone   switch (info.si_code) {
735b9c1b51eSKate Stone   // TODO: these two cases are required if we want to support tracing of the
736b9c1b51eSKate Stone   // inferiors' children.  We'd need this to debug a monitor.
737af245d11STodd Fiala   // case (SIGTRAP | (PTRACE_EVENT_FORK << 8)):
738af245d11STodd Fiala   // case (SIGTRAP | (PTRACE_EVENT_VFORK << 8)):
739af245d11STodd Fiala 
740b9c1b51eSKate Stone   case (SIGTRAP | (PTRACE_EVENT_CLONE << 8)): {
741b9c1b51eSKate Stone     // This is the notification on the parent thread which informs us of new
742b9c1b51eSKate Stone     // thread
743426bdf88SPavel Labath     // creation.
744b9c1b51eSKate Stone     // We don't want to do anything with the parent thread so we just resume it.
745b9c1b51eSKate Stone     // In case we
746b9c1b51eSKate Stone     // want to implement "break on thread creation" functionality, we would need
747b9c1b51eSKate Stone     // to stop
748426bdf88SPavel Labath     // here.
749af245d11STodd Fiala 
750af245d11STodd Fiala     unsigned long event_message = 0;
751b9c1b51eSKate Stone     if (GetEventMessage(thread.GetID(), &event_message).Fail()) {
752a6321a8eSPavel Labath       LLDB_LOG(log,
753a6321a8eSPavel Labath                "pid {0} received thread creation event but "
754a6321a8eSPavel Labath                "GetEventMessage failed so we don't know the new tid",
755a6321a8eSPavel Labath                thread.GetID());
756426bdf88SPavel Labath     } else
757426bdf88SPavel Labath       WaitForNewThread(event_message);
758af245d11STodd Fiala 
759b9cc0c75SPavel Labath     ResumeThread(thread, thread.GetState(), LLDB_INVALID_SIGNAL_NUMBER);
760af245d11STodd Fiala     break;
761af245d11STodd Fiala   }
762af245d11STodd Fiala 
763b9c1b51eSKate Stone   case (SIGTRAP | (PTRACE_EVENT_EXEC << 8)): {
764f9077782SPavel Labath     NativeThreadLinuxSP main_thread_sp;
765a6321a8eSPavel Labath     LLDB_LOG(log, "received exec event, code = {0}", info.si_code ^ SIGTRAP);
766a9882ceeSTodd Fiala 
7671dbc6c9cSPavel Labath     // Exec clears any pending notifications.
7680e1d729bSPavel Labath     m_pending_notification_tid = LLDB_INVALID_THREAD_ID;
769fa03ad2eSChaoren Lin 
770b9c1b51eSKate Stone     // Remove all but the main thread here.  Linux fork creates a new process
771b9c1b51eSKate Stone     // which only copies the main thread.
772a6321a8eSPavel Labath     LLDB_LOG(log, "exec received, stop tracking all but main thread");
773a9882ceeSTodd Fiala 
774b9c1b51eSKate Stone     for (auto thread_sp : m_threads) {
775a9882ceeSTodd Fiala       const bool is_main_thread = thread_sp && thread_sp->GetID() == GetID();
776b9c1b51eSKate Stone       if (is_main_thread) {
777f9077782SPavel Labath         main_thread_sp = std::static_pointer_cast<NativeThreadLinux>(thread_sp);
778a6321a8eSPavel Labath         LLDB_LOG(log, "found main thread with tid {0}, keeping",
779a6321a8eSPavel Labath                  main_thread_sp->GetID());
780b9c1b51eSKate Stone       } else {
781a6321a8eSPavel Labath         LLDB_LOG(log, "discarding non-main-thread tid {0} due to exec",
782a6321a8eSPavel Labath                  thread_sp->GetID());
783a9882ceeSTodd Fiala       }
784a9882ceeSTodd Fiala     }
785a9882ceeSTodd Fiala 
786a9882ceeSTodd Fiala     m_threads.clear();
787a9882ceeSTodd Fiala 
788b9c1b51eSKate Stone     if (main_thread_sp) {
789a9882ceeSTodd Fiala       m_threads.push_back(main_thread_sp);
790a9882ceeSTodd Fiala       SetCurrentThreadID(main_thread_sp->GetID());
791f9077782SPavel Labath       main_thread_sp->SetStoppedByExec();
792b9c1b51eSKate Stone     } else {
793a9882ceeSTodd Fiala       SetCurrentThreadID(LLDB_INVALID_THREAD_ID);
794a6321a8eSPavel Labath       LLDB_LOG(log,
795a6321a8eSPavel Labath                "pid {0} no main thread found, discarded all threads, "
796a6321a8eSPavel Labath                "we're in a no-thread state!",
797a6321a8eSPavel Labath                GetID());
798a9882ceeSTodd Fiala     }
799a9882ceeSTodd Fiala 
800fa03ad2eSChaoren Lin     // Tell coordinator about about the "new" (since exec) stopped main thread.
801f9077782SPavel Labath     ThreadWasCreated(*main_thread_sp);
802fa03ad2eSChaoren Lin 
803a9882ceeSTodd Fiala     // Let our delegate know we have just exec'd.
804a9882ceeSTodd Fiala     NotifyDidExec();
805a9882ceeSTodd Fiala 
806a9882ceeSTodd Fiala     // If we have a main thread, indicate we are stopped.
807b9c1b51eSKate Stone     assert(main_thread_sp && "exec called during ptraced process but no main "
808b9c1b51eSKate Stone                              "thread metadata tracked");
809fa03ad2eSChaoren Lin 
810fa03ad2eSChaoren Lin     // Let the process know we're stopped.
811b9cc0c75SPavel Labath     StopRunningThreads(main_thread_sp->GetID());
812a9882ceeSTodd Fiala 
813af245d11STodd Fiala     break;
814a9882ceeSTodd Fiala   }
815af245d11STodd Fiala 
816b9c1b51eSKate Stone   case (SIGTRAP | (PTRACE_EVENT_EXIT << 8)): {
817af245d11STodd Fiala     // The inferior process or one of its threads is about to exit.
818b9c1b51eSKate Stone     // We don't want to do anything with the thread so we just resume it. In
819b9c1b51eSKate Stone     // case we
820b9c1b51eSKate Stone     // want to implement "break on thread exit" functionality, we would need to
821b9c1b51eSKate Stone     // stop
8226e35163cSPavel Labath     // here.
823fa03ad2eSChaoren Lin 
824af245d11STodd Fiala     unsigned long data = 0;
825b9cc0c75SPavel Labath     if (GetEventMessage(thread.GetID(), &data).Fail())
826af245d11STodd Fiala       data = -1;
827af245d11STodd Fiala 
828a6321a8eSPavel Labath     LLDB_LOG(log,
829a6321a8eSPavel Labath              "received PTRACE_EVENT_EXIT, data = {0:x}, WIFEXITED={1}, "
830a6321a8eSPavel Labath              "WIFSIGNALED={2}, pid = {3}, main_thread = {4}",
831a6321a8eSPavel Labath              data, WIFEXITED(data), WIFSIGNALED(data), thread.GetID(),
832a6321a8eSPavel Labath              is_main_thread);
833af245d11STodd Fiala 
834b9c1b51eSKate Stone     if (is_main_thread) {
835b9c1b51eSKate Stone       SetExitStatus(convert_pid_status_to_exit_type(data),
836b9c1b51eSKate Stone                     convert_pid_status_to_return_code(data), nullptr, true);
83775f47c3aSTodd Fiala     }
83875f47c3aSTodd Fiala 
83986852d36SPavel Labath     StateType state = thread.GetState();
840b9c1b51eSKate Stone     if (!StateIsRunningState(state)) {
841b9c1b51eSKate Stone       // Due to a kernel bug, we may sometimes get this stop after the inferior
842b9c1b51eSKate Stone       // gets a
843b9c1b51eSKate Stone       // SIGKILL. This confuses our state tracking logic in ResumeThread(),
844b9c1b51eSKate Stone       // since normally,
845b9c1b51eSKate Stone       // we should not be receiving any ptrace events while the inferior is
846b9c1b51eSKate Stone       // stopped. This
84786852d36SPavel Labath       // makes sure that the inferior is resumed and exits normally.
84886852d36SPavel Labath       state = eStateRunning;
84986852d36SPavel Labath     }
85086852d36SPavel Labath     ResumeThread(thread, state, LLDB_INVALID_SIGNAL_NUMBER);
851af245d11STodd Fiala 
852af245d11STodd Fiala     break;
853af245d11STodd Fiala   }
854af245d11STodd Fiala 
855af245d11STodd Fiala   case 0:
856c16f5dcaSChaoren Lin   case TRAP_TRACE:  // We receive this on single stepping.
857c16f5dcaSChaoren Lin   case TRAP_HWBKPT: // We receive this on watchpoint hit
85886fd8e45SChaoren Lin   {
859c16f5dcaSChaoren Lin     // If a watchpoint was hit, report it
860c16f5dcaSChaoren Lin     uint32_t wp_index;
861b9c1b51eSKate Stone     Error error = thread.GetRegisterContext()->GetWatchpointHitIndex(
862b9c1b51eSKate Stone         wp_index, (uintptr_t)info.si_addr);
863a6321a8eSPavel Labath     if (error.Fail())
864a6321a8eSPavel Labath       LLDB_LOG(log,
865a6321a8eSPavel Labath                "received error while checking for watchpoint hits, pid = "
866a6321a8eSPavel Labath                "{0}, error = {1}",
867a6321a8eSPavel Labath                thread.GetID(), error);
868b9c1b51eSKate Stone     if (wp_index != LLDB_INVALID_INDEX32) {
869b9cc0c75SPavel Labath       MonitorWatchpoint(thread, wp_index);
870c16f5dcaSChaoren Lin       break;
871c16f5dcaSChaoren Lin     }
872b9cc0c75SPavel Labath 
873be379e15STamas Berghammer     // Otherwise, report step over
874be379e15STamas Berghammer     MonitorTrace(thread);
875af245d11STodd Fiala     break;
876b9cc0c75SPavel Labath   }
877af245d11STodd Fiala 
878af245d11STodd Fiala   case SI_KERNEL:
87935799963SMohit K. Bhakkad #if defined __mips__
88035799963SMohit K. Bhakkad     // For mips there is no special signal for watchpoint
88135799963SMohit K. Bhakkad     // So we check for watchpoint in kernel trap
88235799963SMohit K. Bhakkad     {
88335799963SMohit K. Bhakkad       // If a watchpoint was hit, report it
88435799963SMohit K. Bhakkad       uint32_t wp_index;
885b9c1b51eSKate Stone       Error error = thread.GetRegisterContext()->GetWatchpointHitIndex(
886b9c1b51eSKate Stone           wp_index, LLDB_INVALID_ADDRESS);
887a6321a8eSPavel Labath       if (error.Fail())
888a6321a8eSPavel Labath         LLDB_LOG(log,
889a6321a8eSPavel Labath                  "received error while checking for watchpoint hits, pid = "
890a6321a8eSPavel Labath                  "{0}, error = {1}",
891a6321a8eSPavel Labath                  thread.GetID(), error);
892b9c1b51eSKate Stone       if (wp_index != LLDB_INVALID_INDEX32) {
893b9cc0c75SPavel Labath         MonitorWatchpoint(thread, wp_index);
89435799963SMohit K. Bhakkad         break;
89535799963SMohit K. Bhakkad       }
89635799963SMohit K. Bhakkad     }
89735799963SMohit K. Bhakkad // NO BREAK
89835799963SMohit K. Bhakkad #endif
899af245d11STodd Fiala   case TRAP_BRKPT:
900b9cc0c75SPavel Labath     MonitorBreakpoint(thread);
901af245d11STodd Fiala     break;
902af245d11STodd Fiala 
903af245d11STodd Fiala   case SIGTRAP:
904af245d11STodd Fiala   case (SIGTRAP | 0x80):
905a6321a8eSPavel Labath     LLDB_LOG(
906a6321a8eSPavel Labath         log,
907a6321a8eSPavel Labath         "received unknown SIGTRAP stop event ({0}, pid {1} tid {2}, resuming",
908a6321a8eSPavel Labath         info.si_code, GetID(), thread.GetID());
909fa03ad2eSChaoren Lin 
910af245d11STodd Fiala     // Ignore these signals until we know more about them.
911b9cc0c75SPavel Labath     ResumeThread(thread, thread.GetState(), LLDB_INVALID_SIGNAL_NUMBER);
912af245d11STodd Fiala     break;
913af245d11STodd Fiala 
914af245d11STodd Fiala   default:
915a6321a8eSPavel Labath     LLDB_LOG(
916a6321a8eSPavel Labath         log,
917a6321a8eSPavel Labath         "received unknown SIGTRAP stop event ({0}, pid {1} tid {2}, resuming",
918a6321a8eSPavel Labath         info.si_code, GetID(), thread.GetID());
919a6321a8eSPavel Labath     llvm_unreachable("Unexpected SIGTRAP code!");
920af245d11STodd Fiala     break;
921af245d11STodd Fiala   }
922af245d11STodd Fiala }
923af245d11STodd Fiala 
924b9c1b51eSKate Stone void NativeProcessLinux::MonitorTrace(NativeThreadLinux &thread) {
925a6321a8eSPavel Labath   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
926a6321a8eSPavel Labath   LLDB_LOG(log, "received trace event, pid = {0}", thread.GetID());
927c16f5dcaSChaoren Lin 
9280e1d729bSPavel Labath   // This thread is currently stopped.
929b9cc0c75SPavel Labath   thread.SetStoppedByTrace();
930c16f5dcaSChaoren Lin 
931b9cc0c75SPavel Labath   StopRunningThreads(thread.GetID());
932c16f5dcaSChaoren Lin }
933c16f5dcaSChaoren Lin 
934b9c1b51eSKate Stone void NativeProcessLinux::MonitorBreakpoint(NativeThreadLinux &thread) {
935b9c1b51eSKate Stone   Log *log(
936b9c1b51eSKate Stone       GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS | LIBLLDB_LOG_BREAKPOINTS));
937a6321a8eSPavel Labath   LLDB_LOG(log, "received breakpoint event, pid = {0}", thread.GetID());
938c16f5dcaSChaoren Lin 
939c16f5dcaSChaoren Lin   // Mark the thread as stopped at breakpoint.
940b9cc0c75SPavel Labath   thread.SetStoppedByBreakpoint();
941b9cc0c75SPavel Labath   Error error = FixupBreakpointPCAsNeeded(thread);
942c16f5dcaSChaoren Lin   if (error.Fail())
943a6321a8eSPavel Labath     LLDB_LOG(log, "pid = {0} fixup: {1}", thread.GetID(), error);
944d8c338d4STamas Berghammer 
945b9c1b51eSKate Stone   if (m_threads_stepping_with_breakpoint.find(thread.GetID()) !=
946b9c1b51eSKate Stone       m_threads_stepping_with_breakpoint.end())
947b9cc0c75SPavel Labath     thread.SetStoppedByTrace();
948c16f5dcaSChaoren Lin 
949b9cc0c75SPavel Labath   StopRunningThreads(thread.GetID());
950c16f5dcaSChaoren Lin }
951c16f5dcaSChaoren Lin 
952b9c1b51eSKate Stone void NativeProcessLinux::MonitorWatchpoint(NativeThreadLinux &thread,
953b9c1b51eSKate Stone                                            uint32_t wp_index) {
954b9c1b51eSKate Stone   Log *log(
955b9c1b51eSKate Stone       GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS | LIBLLDB_LOG_WATCHPOINTS));
956a6321a8eSPavel Labath   LLDB_LOG(log, "received watchpoint event, pid = {0}, wp_index = {1}",
957a6321a8eSPavel Labath            thread.GetID(), wp_index);
958c16f5dcaSChaoren Lin 
959c16f5dcaSChaoren Lin   // Mark the thread as stopped at watchpoint.
960c16f5dcaSChaoren Lin   // The address is at (lldb::addr_t)info->si_addr if we need it.
961f9077782SPavel Labath   thread.SetStoppedByWatchpoint(wp_index);
962c16f5dcaSChaoren Lin 
963b9c1b51eSKate Stone   // We need to tell all other running threads before we notify the delegate
964b9c1b51eSKate Stone   // about this stop.
965f9077782SPavel Labath   StopRunningThreads(thread.GetID());
966c16f5dcaSChaoren Lin }
967c16f5dcaSChaoren Lin 
968b9c1b51eSKate Stone void NativeProcessLinux::MonitorSignal(const siginfo_t &info,
969b9c1b51eSKate Stone                                        NativeThreadLinux &thread, bool exited) {
970b9cc0c75SPavel Labath   const int signo = info.si_signo;
971b9cc0c75SPavel Labath   const bool is_from_llgs = info.si_pid == getpid();
972af245d11STodd Fiala 
973a6321a8eSPavel Labath   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
974af245d11STodd Fiala 
975af245d11STodd Fiala   // POSIX says that process behaviour is undefined after it ignores a SIGFPE,
976af245d11STodd Fiala   // SIGILL, SIGSEGV, or SIGBUS *unless* that signal was generated by a
977af245d11STodd Fiala   // kill(2) or raise(3).  Similarly for tgkill(2) on Linux.
978af245d11STodd Fiala   //
979af245d11STodd Fiala   // IOW, user generated signals never generate what we consider to be a
980af245d11STodd Fiala   // "crash".
981af245d11STodd Fiala   //
982af245d11STodd Fiala   // Similarly, ACK signals generated by this monitor.
983af245d11STodd Fiala 
984af245d11STodd Fiala   // Handle the signal.
985a6321a8eSPavel Labath   LLDB_LOG(log,
986a6321a8eSPavel Labath            "received signal {0} ({1}) with code {2}, (siginfo pid = {3}, "
987a6321a8eSPavel Labath            "waitpid pid = {4})",
988a6321a8eSPavel Labath            Host::GetSignalAsCString(signo), signo, info.si_code,
989b9cc0c75SPavel Labath            thread.GetID());
99058a2f669STodd Fiala 
99158a2f669STodd Fiala   // Check for thread stop notification.
992b9c1b51eSKate Stone   if (is_from_llgs && (info.si_code == SI_TKILL) && (signo == SIGSTOP)) {
993af245d11STodd Fiala     // This is a tgkill()-based stop.
994a6321a8eSPavel Labath     LLDB_LOG(log, "pid {0} tid {1}, thread stopped", GetID(), thread.GetID());
995fa03ad2eSChaoren Lin 
996aab58633SChaoren Lin     // Check that we're not already marked with a stop reason.
997b9c1b51eSKate Stone     // Note this thread really shouldn't already be marked as stopped - if we
998a6321a8eSPavel Labath     // were, that would imply that the kernel signaled us with the thread
999a6321a8eSPavel Labath     // stopping which we handled and marked as stopped, and that, without an
1000a6321a8eSPavel Labath     // intervening resume, we received another stop.  It is more likely that we
1001a6321a8eSPavel Labath     // are missing the marking of a run state somewhere if we find that the
1002a6321a8eSPavel Labath     // thread was marked as stopped.
1003b9cc0c75SPavel Labath     const StateType thread_state = thread.GetState();
1004b9c1b51eSKate Stone     if (!StateIsStoppedState(thread_state, false)) {
1005ed89c7feSPavel Labath       // An inferior thread has stopped because of a SIGSTOP we have sent it.
1006b9c1b51eSKate Stone       // Generally, these are not important stops and we don't want to report
1007a6321a8eSPavel Labath       // them as they are just used to stop other threads when one thread (the
1008a6321a8eSPavel Labath       // one with the *real* stop reason) hits a breakpoint (watchpoint,
1009a6321a8eSPavel Labath       // etc...). However, in the case of an asynchronous Interrupt(), this *is*
1010a6321a8eSPavel Labath       // the real stop reason, so we leave the signal intact if this is the
1011a6321a8eSPavel Labath       // thread that was chosen as the triggering thread.
1012b9c1b51eSKate Stone       if (m_pending_notification_tid != LLDB_INVALID_THREAD_ID) {
1013b9cc0c75SPavel Labath         if (m_pending_notification_tid == thread.GetID())
1014b9cc0c75SPavel Labath           thread.SetStoppedBySignal(SIGSTOP, &info);
1015ed89c7feSPavel Labath         else
1016b9cc0c75SPavel Labath           thread.SetStoppedWithNoReason();
1017ed89c7feSPavel Labath 
1018b9cc0c75SPavel Labath         SetCurrentThreadID(thread.GetID());
10190e1d729bSPavel Labath         SignalIfAllThreadsStopped();
1020b9c1b51eSKate Stone       } else {
10210e1d729bSPavel Labath         // We can end up here if stop was initiated by LLGS but by this time a
10220e1d729bSPavel Labath         // thread stop has occurred - maybe initiated by another event.
1023b9cc0c75SPavel Labath         Error error = ResumeThread(thread, thread.GetState(), 0);
1024a6321a8eSPavel Labath         if (error.Fail())
1025a6321a8eSPavel Labath           LLDB_LOG(log, "failed to resume thread {0}: {1}", thread.GetID(),
1026a6321a8eSPavel Labath                    error);
10270e1d729bSPavel Labath       }
1028b9c1b51eSKate Stone     } else {
1029a6321a8eSPavel Labath       LLDB_LOG(log,
1030a6321a8eSPavel Labath                "pid {0} tid {1}, thread was already marked as a stopped "
1031a6321a8eSPavel Labath                "state (state={2}), leaving stop signal as is",
10328198db30SPavel Labath                GetID(), thread.GetID(), thread_state);
10330e1d729bSPavel Labath       SignalIfAllThreadsStopped();
1034af245d11STodd Fiala     }
1035af245d11STodd Fiala 
103658a2f669STodd Fiala     // Done handling.
1037af245d11STodd Fiala     return;
1038af245d11STodd Fiala   }
1039af245d11STodd Fiala 
1040*4a705e7eSPavel Labath   // Check if debugger should stop at this signal or just ignore it
1041*4a705e7eSPavel Labath   // and resume the inferior.
1042*4a705e7eSPavel Labath   if (m_signals_to_ignore.find(signo) != m_signals_to_ignore.end()) {
1043*4a705e7eSPavel Labath      ResumeThread(thread, thread.GetState(), signo);
1044*4a705e7eSPavel Labath      return;
1045*4a705e7eSPavel Labath   }
1046*4a705e7eSPavel Labath 
104786fd8e45SChaoren Lin   // This thread is stopped.
1048a6321a8eSPavel Labath   LLDB_LOG(log, "received signal {0}", Host::GetSignalAsCString(signo));
1049b9cc0c75SPavel Labath   thread.SetStoppedBySignal(signo, &info);
105086fd8e45SChaoren Lin 
105186fd8e45SChaoren Lin   // Send a stop to the debugger after we get all other threads to stop.
1052b9cc0c75SPavel Labath   StopRunningThreads(thread.GetID());
1053511e5cdcSTodd Fiala }
1054af245d11STodd Fiala 
1055e7708688STamas Berghammer namespace {
1056e7708688STamas Berghammer 
1057b9c1b51eSKate Stone struct EmulatorBaton {
1058e7708688STamas Berghammer   NativeProcessLinux *m_process;
1059e7708688STamas Berghammer   NativeRegisterContext *m_reg_context;
10606648fcc3SPavel Labath 
10616648fcc3SPavel Labath   // eRegisterKindDWARF -> RegsiterValue
10626648fcc3SPavel Labath   std::unordered_map<uint32_t, RegisterValue> m_register_values;
1063e7708688STamas Berghammer 
1064b9c1b51eSKate Stone   EmulatorBaton(NativeProcessLinux *process, NativeRegisterContext *reg_context)
1065b9c1b51eSKate Stone       : m_process(process), m_reg_context(reg_context) {}
1066e7708688STamas Berghammer };
1067e7708688STamas Berghammer 
1068e7708688STamas Berghammer } // anonymous namespace
1069e7708688STamas Berghammer 
1070b9c1b51eSKate Stone static size_t ReadMemoryCallback(EmulateInstruction *instruction, void *baton,
1071e7708688STamas Berghammer                                  const EmulateInstruction::Context &context,
1072b9c1b51eSKate Stone                                  lldb::addr_t addr, void *dst, size_t length) {
1073e7708688STamas Berghammer   EmulatorBaton *emulator_baton = static_cast<EmulatorBaton *>(baton);
1074e7708688STamas Berghammer 
10753eb4b458SChaoren Lin   size_t bytes_read;
1076e7708688STamas Berghammer   emulator_baton->m_process->ReadMemory(addr, dst, length, bytes_read);
1077e7708688STamas Berghammer   return bytes_read;
1078e7708688STamas Berghammer }
1079e7708688STamas Berghammer 
1080b9c1b51eSKate Stone static bool ReadRegisterCallback(EmulateInstruction *instruction, void *baton,
1081e7708688STamas Berghammer                                  const RegisterInfo *reg_info,
1082b9c1b51eSKate Stone                                  RegisterValue &reg_value) {
1083e7708688STamas Berghammer   EmulatorBaton *emulator_baton = static_cast<EmulatorBaton *>(baton);
1084e7708688STamas Berghammer 
1085b9c1b51eSKate Stone   auto it = emulator_baton->m_register_values.find(
1086b9c1b51eSKate Stone       reg_info->kinds[eRegisterKindDWARF]);
1087b9c1b51eSKate Stone   if (it != emulator_baton->m_register_values.end()) {
10886648fcc3SPavel Labath     reg_value = it->second;
10896648fcc3SPavel Labath     return true;
10906648fcc3SPavel Labath   }
10916648fcc3SPavel Labath 
1092e7708688STamas Berghammer   // The emulator only fill in the dwarf regsiter numbers (and in some case
1093e7708688STamas Berghammer   // the generic register numbers). Get the full register info from the
1094e7708688STamas Berghammer   // register context based on the dwarf register numbers.
1095b9c1b51eSKate Stone   const RegisterInfo *full_reg_info =
1096b9c1b51eSKate Stone       emulator_baton->m_reg_context->GetRegisterInfo(
1097e7708688STamas Berghammer           eRegisterKindDWARF, reg_info->kinds[eRegisterKindDWARF]);
1098e7708688STamas Berghammer 
1099b9c1b51eSKate Stone   Error error =
1100b9c1b51eSKate Stone       emulator_baton->m_reg_context->ReadRegister(full_reg_info, reg_value);
11016648fcc3SPavel Labath   if (error.Success())
11026648fcc3SPavel Labath     return true;
1103cdc22a88SMohit K. Bhakkad 
11046648fcc3SPavel Labath   return false;
1105e7708688STamas Berghammer }
1106e7708688STamas Berghammer 
1107b9c1b51eSKate Stone static bool WriteRegisterCallback(EmulateInstruction *instruction, void *baton,
1108e7708688STamas Berghammer                                   const EmulateInstruction::Context &context,
1109e7708688STamas Berghammer                                   const RegisterInfo *reg_info,
1110b9c1b51eSKate Stone                                   const RegisterValue &reg_value) {
1111e7708688STamas Berghammer   EmulatorBaton *emulator_baton = static_cast<EmulatorBaton *>(baton);
1112b9c1b51eSKate Stone   emulator_baton->m_register_values[reg_info->kinds[eRegisterKindDWARF]] =
1113b9c1b51eSKate Stone       reg_value;
1114e7708688STamas Berghammer   return true;
1115e7708688STamas Berghammer }
1116e7708688STamas Berghammer 
1117b9c1b51eSKate Stone static size_t WriteMemoryCallback(EmulateInstruction *instruction, void *baton,
1118e7708688STamas Berghammer                                   const EmulateInstruction::Context &context,
1119b9c1b51eSKate Stone                                   lldb::addr_t addr, const void *dst,
1120b9c1b51eSKate Stone                                   size_t length) {
1121e7708688STamas Berghammer   return length;
1122e7708688STamas Berghammer }
1123e7708688STamas Berghammer 
1124b9c1b51eSKate Stone static lldb::addr_t ReadFlags(NativeRegisterContext *regsiter_context) {
1125e7708688STamas Berghammer   const RegisterInfo *flags_info = regsiter_context->GetRegisterInfo(
1126e7708688STamas Berghammer       eRegisterKindGeneric, LLDB_REGNUM_GENERIC_FLAGS);
1127b9c1b51eSKate Stone   return regsiter_context->ReadRegisterAsUnsigned(flags_info,
1128b9c1b51eSKate Stone                                                   LLDB_INVALID_ADDRESS);
1129e7708688STamas Berghammer }
1130e7708688STamas Berghammer 
1131b9c1b51eSKate Stone Error NativeProcessLinux::SetupSoftwareSingleStepping(
1132b9c1b51eSKate Stone     NativeThreadLinux &thread) {
1133e7708688STamas Berghammer   Error error;
1134b9cc0c75SPavel Labath   NativeRegisterContextSP register_context_sp = thread.GetRegisterContext();
1135e7708688STamas Berghammer 
1136e7708688STamas Berghammer   std::unique_ptr<EmulateInstruction> emulator_ap(
1137b9c1b51eSKate Stone       EmulateInstruction::FindPlugin(m_arch, eInstructionTypePCModifying,
1138b9c1b51eSKate Stone                                      nullptr));
1139e7708688STamas Berghammer 
1140e7708688STamas Berghammer   if (emulator_ap == nullptr)
1141e7708688STamas Berghammer     return Error("Instruction emulator not found!");
1142e7708688STamas Berghammer 
1143e7708688STamas Berghammer   EmulatorBaton baton(this, register_context_sp.get());
1144e7708688STamas Berghammer   emulator_ap->SetBaton(&baton);
1145e7708688STamas Berghammer   emulator_ap->SetReadMemCallback(&ReadMemoryCallback);
1146e7708688STamas Berghammer   emulator_ap->SetReadRegCallback(&ReadRegisterCallback);
1147e7708688STamas Berghammer   emulator_ap->SetWriteMemCallback(&WriteMemoryCallback);
1148e7708688STamas Berghammer   emulator_ap->SetWriteRegCallback(&WriteRegisterCallback);
1149e7708688STamas Berghammer 
1150e7708688STamas Berghammer   if (!emulator_ap->ReadInstruction())
1151e7708688STamas Berghammer     return Error("Read instruction failed!");
1152e7708688STamas Berghammer 
1153b9c1b51eSKate Stone   bool emulation_result =
1154b9c1b51eSKate Stone       emulator_ap->EvaluateInstruction(eEmulateInstructionOptionAutoAdvancePC);
11556648fcc3SPavel Labath 
1156b9c1b51eSKate Stone   const RegisterInfo *reg_info_pc = register_context_sp->GetRegisterInfo(
1157b9c1b51eSKate Stone       eRegisterKindGeneric, LLDB_REGNUM_GENERIC_PC);
1158b9c1b51eSKate Stone   const RegisterInfo *reg_info_flags = register_context_sp->GetRegisterInfo(
1159b9c1b51eSKate Stone       eRegisterKindGeneric, LLDB_REGNUM_GENERIC_FLAGS);
11606648fcc3SPavel Labath 
1161b9c1b51eSKate Stone   auto pc_it =
1162b9c1b51eSKate Stone       baton.m_register_values.find(reg_info_pc->kinds[eRegisterKindDWARF]);
1163b9c1b51eSKate Stone   auto flags_it =
1164b9c1b51eSKate Stone       baton.m_register_values.find(reg_info_flags->kinds[eRegisterKindDWARF]);
11656648fcc3SPavel Labath 
1166e7708688STamas Berghammer   lldb::addr_t next_pc;
1167e7708688STamas Berghammer   lldb::addr_t next_flags;
1168b9c1b51eSKate Stone   if (emulation_result) {
1169b9c1b51eSKate Stone     assert(pc_it != baton.m_register_values.end() &&
1170b9c1b51eSKate Stone            "Emulation was successfull but PC wasn't updated");
11716648fcc3SPavel Labath     next_pc = pc_it->second.GetAsUInt64();
11726648fcc3SPavel Labath 
11736648fcc3SPavel Labath     if (flags_it != baton.m_register_values.end())
11746648fcc3SPavel Labath       next_flags = flags_it->second.GetAsUInt64();
1175e7708688STamas Berghammer     else
1176e7708688STamas Berghammer       next_flags = ReadFlags(register_context_sp.get());
1177b9c1b51eSKate Stone   } else if (pc_it == baton.m_register_values.end()) {
1178e7708688STamas Berghammer     // Emulate instruction failed and it haven't changed PC. Advance PC
1179e7708688STamas Berghammer     // with the size of the current opcode because the emulation of all
1180e7708688STamas Berghammer     // PC modifying instruction should be successful. The failure most
1181e7708688STamas Berghammer     // likely caused by a not supported instruction which don't modify PC.
1182b9c1b51eSKate Stone     next_pc =
1183b9c1b51eSKate Stone         register_context_sp->GetPC() + emulator_ap->GetOpcode().GetByteSize();
1184e7708688STamas Berghammer     next_flags = ReadFlags(register_context_sp.get());
1185b9c1b51eSKate Stone   } else {
1186e7708688STamas Berghammer     // The instruction emulation failed after it modified the PC. It is an
1187e7708688STamas Berghammer     // unknown error where we can't continue because the next instruction is
1188e7708688STamas Berghammer     // modifying the PC but we don't  know how.
1189e7708688STamas Berghammer     return Error("Instruction emulation failed unexpectedly.");
1190e7708688STamas Berghammer   }
1191e7708688STamas Berghammer 
1192b9c1b51eSKate Stone   if (m_arch.GetMachine() == llvm::Triple::arm) {
1193b9c1b51eSKate Stone     if (next_flags & 0x20) {
1194e7708688STamas Berghammer       // Thumb mode
1195e7708688STamas Berghammer       error = SetSoftwareBreakpoint(next_pc, 2);
1196b9c1b51eSKate Stone     } else {
1197e7708688STamas Berghammer       // Arm mode
1198e7708688STamas Berghammer       error = SetSoftwareBreakpoint(next_pc, 4);
1199e7708688STamas Berghammer     }
1200b9c1b51eSKate Stone   } else if (m_arch.GetMachine() == llvm::Triple::mips64 ||
1201b9c1b51eSKate Stone              m_arch.GetMachine() == llvm::Triple::mips64el ||
1202b9c1b51eSKate Stone              m_arch.GetMachine() == llvm::Triple::mips ||
1203b9c1b51eSKate Stone              m_arch.GetMachine() == llvm::Triple::mipsel)
1204cdc22a88SMohit K. Bhakkad     error = SetSoftwareBreakpoint(next_pc, 4);
1205b9c1b51eSKate Stone   else {
1206e7708688STamas Berghammer     // No size hint is given for the next breakpoint
1207e7708688STamas Berghammer     error = SetSoftwareBreakpoint(next_pc, 0);
1208e7708688STamas Berghammer   }
1209e7708688STamas Berghammer 
121042eb6908SPavel Labath   // If setting the breakpoint fails because next_pc is out of
121142eb6908SPavel Labath   // the address space, ignore it and let the debugee segfault.
121242eb6908SPavel Labath   if (error.GetError() == EIO || error.GetError() == EFAULT) {
1213665be50eSMehdi Amini     return Error();
121442eb6908SPavel Labath   } else if (error.Fail())
1215e7708688STamas Berghammer     return error;
1216e7708688STamas Berghammer 
1217b9cc0c75SPavel Labath   m_threads_stepping_with_breakpoint.insert({thread.GetID(), next_pc});
1218e7708688STamas Berghammer 
1219665be50eSMehdi Amini   return Error();
1220e7708688STamas Berghammer }
1221e7708688STamas Berghammer 
1222b9c1b51eSKate Stone bool NativeProcessLinux::SupportHardwareSingleStepping() const {
1223b9c1b51eSKate Stone   if (m_arch.GetMachine() == llvm::Triple::arm ||
1224b9c1b51eSKate Stone       m_arch.GetMachine() == llvm::Triple::mips64 ||
1225b9c1b51eSKate Stone       m_arch.GetMachine() == llvm::Triple::mips64el ||
1226b9c1b51eSKate Stone       m_arch.GetMachine() == llvm::Triple::mips ||
1227b9c1b51eSKate Stone       m_arch.GetMachine() == llvm::Triple::mipsel)
1228cdc22a88SMohit K. Bhakkad     return false;
1229cdc22a88SMohit K. Bhakkad   return true;
1230e7708688STamas Berghammer }
1231e7708688STamas Berghammer 
1232b9c1b51eSKate Stone Error NativeProcessLinux::Resume(const ResumeActionList &resume_actions) {
1233a6321a8eSPavel Labath   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
1234a6321a8eSPavel Labath   LLDB_LOG(log, "pid {0}", GetID());
1235af245d11STodd Fiala 
1236e7708688STamas Berghammer   bool software_single_step = !SupportHardwareSingleStepping();
1237af245d11STodd Fiala 
1238b9c1b51eSKate Stone   if (software_single_step) {
1239b9c1b51eSKate Stone     for (auto thread_sp : m_threads) {
1240e7708688STamas Berghammer       assert(thread_sp && "thread list should not contain NULL threads");
1241e7708688STamas Berghammer 
1242b9c1b51eSKate Stone       const ResumeAction *const action =
1243b9c1b51eSKate Stone           resume_actions.GetActionForThread(thread_sp->GetID(), true);
1244e7708688STamas Berghammer       if (action == nullptr)
1245e7708688STamas Berghammer         continue;
1246e7708688STamas Berghammer 
1247b9c1b51eSKate Stone       if (action->state == eStateStepping) {
1248b9c1b51eSKate Stone         Error error = SetupSoftwareSingleStepping(
1249b9c1b51eSKate Stone             static_cast<NativeThreadLinux &>(*thread_sp));
1250e7708688STamas Berghammer         if (error.Fail())
1251e7708688STamas Berghammer           return error;
1252e7708688STamas Berghammer       }
1253e7708688STamas Berghammer     }
1254e7708688STamas Berghammer   }
1255e7708688STamas Berghammer 
1256b9c1b51eSKate Stone   for (auto thread_sp : m_threads) {
1257af245d11STodd Fiala     assert(thread_sp && "thread list should not contain NULL threads");
1258af245d11STodd Fiala 
1259b9c1b51eSKate Stone     const ResumeAction *const action =
1260b9c1b51eSKate Stone         resume_actions.GetActionForThread(thread_sp->GetID(), true);
12616a196ce6SChaoren Lin 
1262b9c1b51eSKate Stone     if (action == nullptr) {
1263a6321a8eSPavel Labath       LLDB_LOG(log, "no action specified for pid {0} tid {1}", GetID(),
1264a6321a8eSPavel Labath                thread_sp->GetID());
12656a196ce6SChaoren Lin       continue;
12666a196ce6SChaoren Lin     }
1267af245d11STodd Fiala 
1268a6321a8eSPavel Labath     LLDB_LOG(log, "processing resume action state {0} for pid {1} tid {2}",
12698198db30SPavel Labath              action->state, GetID(), thread_sp->GetID());
1270af245d11STodd Fiala 
1271b9c1b51eSKate Stone     switch (action->state) {
1272af245d11STodd Fiala     case eStateRunning:
1273b9c1b51eSKate Stone     case eStateStepping: {
1274af245d11STodd Fiala       // Run the thread, possibly feeding it the signal.
1275fa03ad2eSChaoren Lin       const int signo = action->signal;
1276b9c1b51eSKate Stone       ResumeThread(static_cast<NativeThreadLinux &>(*thread_sp), action->state,
1277b9c1b51eSKate Stone                    signo);
1278af245d11STodd Fiala       break;
1279ae29d395SChaoren Lin     }
1280af245d11STodd Fiala 
1281af245d11STodd Fiala     case eStateSuspended:
1282af245d11STodd Fiala     case eStateStopped:
1283a6321a8eSPavel Labath       llvm_unreachable("Unexpected state");
1284af245d11STodd Fiala 
1285af245d11STodd Fiala     default:
1286b9c1b51eSKate Stone       return Error("NativeProcessLinux::%s (): unexpected state %s specified "
1287b9c1b51eSKate Stone                    "for pid %" PRIu64 ", tid %" PRIu64,
1288b9c1b51eSKate Stone                    __FUNCTION__, StateAsCString(action->state), GetID(),
1289b9c1b51eSKate Stone                    thread_sp->GetID());
1290af245d11STodd Fiala     }
1291af245d11STodd Fiala   }
1292af245d11STodd Fiala 
1293665be50eSMehdi Amini   return Error();
1294af245d11STodd Fiala }
1295af245d11STodd Fiala 
1296b9c1b51eSKate Stone Error NativeProcessLinux::Halt() {
1297af245d11STodd Fiala   Error error;
1298af245d11STodd Fiala 
1299af245d11STodd Fiala   if (kill(GetID(), SIGSTOP) != 0)
1300af245d11STodd Fiala     error.SetErrorToErrno();
1301af245d11STodd Fiala 
1302af245d11STodd Fiala   return error;
1303af245d11STodd Fiala }
1304af245d11STodd Fiala 
1305b9c1b51eSKate Stone Error NativeProcessLinux::Detach() {
1306af245d11STodd Fiala   Error error;
1307af245d11STodd Fiala 
1308af245d11STodd Fiala   // Stop monitoring the inferior.
130919cbe96aSPavel Labath   m_sigchld_handle.reset();
1310af245d11STodd Fiala 
13117a9495bcSPavel Labath   // Tell ptrace to detach from the process.
13127a9495bcSPavel Labath   if (GetID() == LLDB_INVALID_PROCESS_ID)
13137a9495bcSPavel Labath     return error;
13147a9495bcSPavel Labath 
1315b9c1b51eSKate Stone   for (auto thread_sp : m_threads) {
13167a9495bcSPavel Labath     Error e = Detach(thread_sp->GetID());
13177a9495bcSPavel Labath     if (e.Fail())
1318b9c1b51eSKate Stone       error =
1319b9c1b51eSKate Stone           e; // Save the error, but still attempt to detach from other threads.
13207a9495bcSPavel Labath   }
13217a9495bcSPavel Labath 
1322af245d11STodd Fiala   return error;
1323af245d11STodd Fiala }
1324af245d11STodd Fiala 
1325b9c1b51eSKate Stone Error NativeProcessLinux::Signal(int signo) {
1326af245d11STodd Fiala   Error error;
1327af245d11STodd Fiala 
1328a6321a8eSPavel Labath   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
1329a6321a8eSPavel Labath   LLDB_LOG(log, "sending signal {0} ({1}) to pid {1}", signo,
1330a6321a8eSPavel Labath            Host::GetSignalAsCString(signo), GetID());
1331af245d11STodd Fiala 
1332af245d11STodd Fiala   if (kill(GetID(), signo))
1333af245d11STodd Fiala     error.SetErrorToErrno();
1334af245d11STodd Fiala 
1335af245d11STodd Fiala   return error;
1336af245d11STodd Fiala }
1337af245d11STodd Fiala 
1338b9c1b51eSKate Stone Error NativeProcessLinux::Interrupt() {
1339e9547b80SChaoren Lin   // Pick a running thread (or if none, a not-dead stopped thread) as
1340e9547b80SChaoren Lin   // the chosen thread that will be the stop-reason thread.
1341a6321a8eSPavel Labath   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
1342e9547b80SChaoren Lin 
1343e9547b80SChaoren Lin   NativeThreadProtocolSP running_thread_sp;
1344e9547b80SChaoren Lin   NativeThreadProtocolSP stopped_thread_sp;
1345e9547b80SChaoren Lin 
1346a6321a8eSPavel Labath   LLDB_LOG(log, "selecting running thread for interrupt target");
1347b9c1b51eSKate Stone   for (auto thread_sp : m_threads) {
1348e9547b80SChaoren Lin     // The thread shouldn't be null but lets just cover that here.
1349e9547b80SChaoren Lin     if (!thread_sp)
1350e9547b80SChaoren Lin       continue;
1351e9547b80SChaoren Lin 
1352e9547b80SChaoren Lin     // If we have a running or stepping thread, we'll call that the
1353e9547b80SChaoren Lin     // target of the interrupt.
1354e9547b80SChaoren Lin     const auto thread_state = thread_sp->GetState();
1355b9c1b51eSKate Stone     if (thread_state == eStateRunning || thread_state == eStateStepping) {
1356e9547b80SChaoren Lin       running_thread_sp = thread_sp;
1357e9547b80SChaoren Lin       break;
1358b9c1b51eSKate Stone     } else if (!stopped_thread_sp && StateIsStoppedState(thread_state, true)) {
1359b9c1b51eSKate Stone       // Remember the first non-dead stopped thread.  We'll use that as a backup
1360b9c1b51eSKate Stone       // if there are no running threads.
1361e9547b80SChaoren Lin       stopped_thread_sp = thread_sp;
1362e9547b80SChaoren Lin     }
1363e9547b80SChaoren Lin   }
1364e9547b80SChaoren Lin 
1365b9c1b51eSKate Stone   if (!running_thread_sp && !stopped_thread_sp) {
1366b9c1b51eSKate Stone     Error error("found no running/stepping or live stopped threads as target "
1367b9c1b51eSKate Stone                 "for interrupt");
1368a6321a8eSPavel Labath     LLDB_LOG(log, "skipping due to error: {0}", error);
13695830aa75STamas Berghammer 
1370e9547b80SChaoren Lin     return error;
1371e9547b80SChaoren Lin   }
1372e9547b80SChaoren Lin 
1373b9c1b51eSKate Stone   NativeThreadProtocolSP deferred_signal_thread_sp =
1374b9c1b51eSKate Stone       running_thread_sp ? running_thread_sp : stopped_thread_sp;
1375e9547b80SChaoren Lin 
1376a6321a8eSPavel Labath   LLDB_LOG(log, "pid {0} {1} tid {2} chosen for interrupt target", GetID(),
1377e9547b80SChaoren Lin            running_thread_sp ? "running" : "stopped",
1378e9547b80SChaoren Lin            deferred_signal_thread_sp->GetID());
1379e9547b80SChaoren Lin 
1380ed89c7feSPavel Labath   StopRunningThreads(deferred_signal_thread_sp->GetID());
138145f5cb31SPavel Labath 
1382665be50eSMehdi Amini   return Error();
1383e9547b80SChaoren Lin }
1384e9547b80SChaoren Lin 
1385b9c1b51eSKate Stone Error NativeProcessLinux::Kill() {
1386a6321a8eSPavel Labath   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
1387a6321a8eSPavel Labath   LLDB_LOG(log, "pid {0}", GetID());
1388af245d11STodd Fiala 
1389af245d11STodd Fiala   Error error;
1390af245d11STodd Fiala 
1391b9c1b51eSKate Stone   switch (m_state) {
1392af245d11STodd Fiala   case StateType::eStateInvalid:
1393af245d11STodd Fiala   case StateType::eStateExited:
1394af245d11STodd Fiala   case StateType::eStateCrashed:
1395af245d11STodd Fiala   case StateType::eStateDetached:
1396af245d11STodd Fiala   case StateType::eStateUnloaded:
1397af245d11STodd Fiala     // Nothing to do - the process is already dead.
1398a6321a8eSPavel Labath     LLDB_LOG(log, "ignored for PID {0} due to current state: {1}", GetID(),
13998198db30SPavel Labath              m_state);
1400af245d11STodd Fiala     return error;
1401af245d11STodd Fiala 
1402af245d11STodd Fiala   case StateType::eStateConnected:
1403af245d11STodd Fiala   case StateType::eStateAttaching:
1404af245d11STodd Fiala   case StateType::eStateLaunching:
1405af245d11STodd Fiala   case StateType::eStateStopped:
1406af245d11STodd Fiala   case StateType::eStateRunning:
1407af245d11STodd Fiala   case StateType::eStateStepping:
1408af245d11STodd Fiala   case StateType::eStateSuspended:
1409af245d11STodd Fiala     // We can try to kill a process in these states.
1410af245d11STodd Fiala     break;
1411af245d11STodd Fiala   }
1412af245d11STodd Fiala 
1413b9c1b51eSKate Stone   if (kill(GetID(), SIGKILL) != 0) {
1414af245d11STodd Fiala     error.SetErrorToErrno();
1415af245d11STodd Fiala     return error;
1416af245d11STodd Fiala   }
1417af245d11STodd Fiala 
1418af245d11STodd Fiala   return error;
1419af245d11STodd Fiala }
1420af245d11STodd Fiala 
1421af245d11STodd Fiala static Error
1422b9c1b51eSKate Stone ParseMemoryRegionInfoFromProcMapsLine(const std::string &maps_line,
1423b9c1b51eSKate Stone                                       MemoryRegionInfo &memory_region_info) {
1424af245d11STodd Fiala   memory_region_info.Clear();
1425af245d11STodd Fiala 
1426b9739d40SPavel Labath   StringExtractor line_extractor(maps_line.c_str());
1427af245d11STodd Fiala 
1428b9c1b51eSKate Stone   // Format: {address_start_hex}-{address_end_hex} perms offset  dev   inode
1429b9c1b51eSKate Stone   // pathname
1430b9c1b51eSKate Stone   // perms: rwxp   (letter is present if set, '-' if not, final character is
1431b9c1b51eSKate Stone   // p=private, s=shared).
1432af245d11STodd Fiala 
1433af245d11STodd Fiala   // Parse out the starting address
1434af245d11STodd Fiala   lldb::addr_t start_address = line_extractor.GetHexMaxU64(false, 0);
1435af245d11STodd Fiala 
1436af245d11STodd Fiala   // Parse out hyphen separating start and end address from range.
1437af245d11STodd Fiala   if (!line_extractor.GetBytesLeft() || (line_extractor.GetChar() != '-'))
1438b9c1b51eSKate Stone     return Error(
1439b9c1b51eSKate Stone         "malformed /proc/{pid}/maps entry, missing dash between address range");
1440af245d11STodd Fiala 
1441af245d11STodd Fiala   // Parse out the ending address
1442af245d11STodd Fiala   lldb::addr_t end_address = line_extractor.GetHexMaxU64(false, start_address);
1443af245d11STodd Fiala 
1444af245d11STodd Fiala   // Parse out the space after the address.
1445af245d11STodd Fiala   if (!line_extractor.GetBytesLeft() || (line_extractor.GetChar() != ' '))
1446af245d11STodd Fiala     return Error("malformed /proc/{pid}/maps entry, missing space after range");
1447af245d11STodd Fiala 
1448af245d11STodd Fiala   // Save the range.
1449af245d11STodd Fiala   memory_region_info.GetRange().SetRangeBase(start_address);
1450af245d11STodd Fiala   memory_region_info.GetRange().SetRangeEnd(end_address);
1451af245d11STodd Fiala 
1452b9c1b51eSKate Stone   // Any memory region in /proc/{pid}/maps is by definition mapped into the
1453b9c1b51eSKate Stone   // process.
1454ad007563SHoward Hellyer   memory_region_info.SetMapped(MemoryRegionInfo::OptionalBool::eYes);
1455ad007563SHoward Hellyer 
1456af245d11STodd Fiala   // Parse out each permission entry.
1457af245d11STodd Fiala   if (line_extractor.GetBytesLeft() < 4)
1458b9c1b51eSKate Stone     return Error("malformed /proc/{pid}/maps entry, missing some portion of "
1459b9c1b51eSKate Stone                  "permissions");
1460af245d11STodd Fiala 
1461af245d11STodd Fiala   // Handle read permission.
1462af245d11STodd Fiala   const char read_perm_char = line_extractor.GetChar();
1463af245d11STodd Fiala   if (read_perm_char == 'r')
1464af245d11STodd Fiala     memory_region_info.SetReadable(MemoryRegionInfo::OptionalBool::eYes);
1465c73301bbSTamas Berghammer   else if (read_perm_char == '-')
1466af245d11STodd Fiala     memory_region_info.SetReadable(MemoryRegionInfo::OptionalBool::eNo);
1467c73301bbSTamas Berghammer   else
1468c73301bbSTamas Berghammer     return Error("unexpected /proc/{pid}/maps read permission char");
1469af245d11STodd Fiala 
1470af245d11STodd Fiala   // Handle write permission.
1471af245d11STodd Fiala   const char write_perm_char = line_extractor.GetChar();
1472af245d11STodd Fiala   if (write_perm_char == 'w')
1473af245d11STodd Fiala     memory_region_info.SetWritable(MemoryRegionInfo::OptionalBool::eYes);
1474c73301bbSTamas Berghammer   else if (write_perm_char == '-')
1475af245d11STodd Fiala     memory_region_info.SetWritable(MemoryRegionInfo::OptionalBool::eNo);
1476c73301bbSTamas Berghammer   else
1477c73301bbSTamas Berghammer     return Error("unexpected /proc/{pid}/maps write permission char");
1478af245d11STodd Fiala 
1479af245d11STodd Fiala   // Handle execute permission.
1480af245d11STodd Fiala   const char exec_perm_char = line_extractor.GetChar();
1481af245d11STodd Fiala   if (exec_perm_char == 'x')
1482af245d11STodd Fiala     memory_region_info.SetExecutable(MemoryRegionInfo::OptionalBool::eYes);
1483c73301bbSTamas Berghammer   else if (exec_perm_char == '-')
1484af245d11STodd Fiala     memory_region_info.SetExecutable(MemoryRegionInfo::OptionalBool::eNo);
1485c73301bbSTamas Berghammer   else
1486c73301bbSTamas Berghammer     return Error("unexpected /proc/{pid}/maps exec permission char");
1487af245d11STodd Fiala 
1488d7d69f80STamas Berghammer   line_extractor.GetChar();              // Read the private bit
1489d7d69f80STamas Berghammer   line_extractor.SkipSpaces();           // Skip the separator
1490d7d69f80STamas Berghammer   line_extractor.GetHexMaxU64(false, 0); // Read the offset
1491d7d69f80STamas Berghammer   line_extractor.GetHexMaxU64(false, 0); // Read the major device number
1492d7d69f80STamas Berghammer   line_extractor.GetChar();              // Read the device id separator
1493d7d69f80STamas Berghammer   line_extractor.GetHexMaxU64(false, 0); // Read the major device number
1494d7d69f80STamas Berghammer   line_extractor.SkipSpaces();           // Skip the separator
1495d7d69f80STamas Berghammer   line_extractor.GetU64(0, 10);          // Read the inode number
1496d7d69f80STamas Berghammer 
1497d7d69f80STamas Berghammer   line_extractor.SkipSpaces();
1498b9739d40SPavel Labath   const char *name = line_extractor.Peek();
1499b9739d40SPavel Labath   if (name)
1500b9739d40SPavel Labath     memory_region_info.SetName(name);
1501d7d69f80STamas Berghammer 
1502665be50eSMehdi Amini   return Error();
1503af245d11STodd Fiala }
1504af245d11STodd Fiala 
1505b9c1b51eSKate Stone Error NativeProcessLinux::GetMemoryRegionInfo(lldb::addr_t load_addr,
1506b9c1b51eSKate Stone                                               MemoryRegionInfo &range_info) {
1507b9c1b51eSKate Stone   // FIXME review that the final memory region returned extends to the end of
1508b9c1b51eSKate Stone   // the virtual address space,
1509af245d11STodd Fiala   // with no perms if it is not mapped.
1510af245d11STodd Fiala 
1511af245d11STodd Fiala   // Use an approach that reads memory regions from /proc/{pid}/maps.
1512af245d11STodd Fiala   // Assume proc maps entries are in ascending order.
1513af245d11STodd Fiala   // FIXME assert if we find differently.
1514af245d11STodd Fiala 
1515b9c1b51eSKate Stone   if (m_supports_mem_region == LazyBool::eLazyBoolNo) {
1516af245d11STodd Fiala     // We're done.
1517a6f5795aSTamas Berghammer     return Error("unsupported");
1518af245d11STodd Fiala   }
1519af245d11STodd Fiala 
1520a6f5795aSTamas Berghammer   Error error = PopulateMemoryRegionCache();
1521b9c1b51eSKate Stone   if (error.Fail()) {
1522af245d11STodd Fiala     return error;
1523af245d11STodd Fiala   }
1524af245d11STodd Fiala 
1525af245d11STodd Fiala   lldb::addr_t prev_base_address = 0;
1526af245d11STodd Fiala 
1527b9c1b51eSKate Stone   // FIXME start by finding the last region that is <= target address using
1528b9c1b51eSKate Stone   // binary search.  Data is sorted.
1529af245d11STodd Fiala   // There can be a ton of regions on pthreads apps with lots of threads.
1530b9c1b51eSKate Stone   for (auto it = m_mem_region_cache.begin(); it != m_mem_region_cache.end();
1531b9c1b51eSKate Stone        ++it) {
1532a6f5795aSTamas Berghammer     MemoryRegionInfo &proc_entry_info = it->first;
1533af245d11STodd Fiala 
1534af245d11STodd Fiala     // Sanity check assumption that /proc/{pid}/maps entries are ascending.
1535b9c1b51eSKate Stone     assert((proc_entry_info.GetRange().GetRangeBase() >= prev_base_address) &&
1536b9c1b51eSKate Stone            "descending /proc/pid/maps entries detected, unexpected");
1537af245d11STodd Fiala     prev_base_address = proc_entry_info.GetRange().GetRangeBase();
1538b1554311SHafiz Abid Qadeer     UNUSED_IF_ASSERT_DISABLED(prev_base_address);
1539af245d11STodd Fiala 
1540b9c1b51eSKate Stone     // If the target address comes before this entry, indicate distance to next
1541b9c1b51eSKate Stone     // region.
1542b9c1b51eSKate Stone     if (load_addr < proc_entry_info.GetRange().GetRangeBase()) {
1543af245d11STodd Fiala       range_info.GetRange().SetRangeBase(load_addr);
1544b9c1b51eSKate Stone       range_info.GetRange().SetByteSize(
1545b9c1b51eSKate Stone           proc_entry_info.GetRange().GetRangeBase() - load_addr);
1546af245d11STodd Fiala       range_info.SetReadable(MemoryRegionInfo::OptionalBool::eNo);
1547af245d11STodd Fiala       range_info.SetWritable(MemoryRegionInfo::OptionalBool::eNo);
1548af245d11STodd Fiala       range_info.SetExecutable(MemoryRegionInfo::OptionalBool::eNo);
1549ad007563SHoward Hellyer       range_info.SetMapped(MemoryRegionInfo::OptionalBool::eNo);
1550af245d11STodd Fiala 
1551af245d11STodd Fiala       return error;
1552b9c1b51eSKate Stone     } else if (proc_entry_info.GetRange().Contains(load_addr)) {
1553af245d11STodd Fiala       // The target address is within the memory region we're processing here.
1554af245d11STodd Fiala       range_info = proc_entry_info;
1555af245d11STodd Fiala       return error;
1556af245d11STodd Fiala     }
1557af245d11STodd Fiala 
1558b9c1b51eSKate Stone     // The target memory address comes somewhere after the region we just
1559b9c1b51eSKate Stone     // parsed.
1560af245d11STodd Fiala   }
1561af245d11STodd Fiala 
1562b9c1b51eSKate Stone   // If we made it here, we didn't find an entry that contained the given
1563b9c1b51eSKate Stone   // address. Return the
1564b9c1b51eSKate Stone   // load_addr as start and the amount of bytes betwwen load address and the end
1565b9c1b51eSKate Stone   // of the memory as
156609839c33STamas Berghammer   // size.
156709839c33STamas Berghammer   range_info.GetRange().SetRangeBase(load_addr);
1568ad007563SHoward Hellyer   range_info.GetRange().SetRangeEnd(LLDB_INVALID_ADDRESS);
156909839c33STamas Berghammer   range_info.SetReadable(MemoryRegionInfo::OptionalBool::eNo);
157009839c33STamas Berghammer   range_info.SetWritable(MemoryRegionInfo::OptionalBool::eNo);
157109839c33STamas Berghammer   range_info.SetExecutable(MemoryRegionInfo::OptionalBool::eNo);
1572ad007563SHoward Hellyer   range_info.SetMapped(MemoryRegionInfo::OptionalBool::eNo);
1573af245d11STodd Fiala   return error;
1574af245d11STodd Fiala }
1575af245d11STodd Fiala 
1576a6f5795aSTamas Berghammer Error NativeProcessLinux::PopulateMemoryRegionCache() {
1577a6321a8eSPavel Labath   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
1578a6f5795aSTamas Berghammer 
1579a6f5795aSTamas Berghammer   // If our cache is empty, pull the latest.  There should always be at least
1580a6f5795aSTamas Berghammer   // one memory region if memory region handling is supported.
1581a6f5795aSTamas Berghammer   if (!m_mem_region_cache.empty()) {
1582a6321a8eSPavel Labath     LLDB_LOG(log, "reusing {0} cached memory region entries",
1583a6321a8eSPavel Labath              m_mem_region_cache.size());
1584a6f5795aSTamas Berghammer     return Error();
1585a6f5795aSTamas Berghammer   }
1586a6f5795aSTamas Berghammer 
1587a6f5795aSTamas Berghammer   Error error = ProcFileReader::ProcessLineByLine(
1588a6f5795aSTamas Berghammer       GetID(), "maps", [&](const std::string &line) -> bool {
1589a6f5795aSTamas Berghammer         MemoryRegionInfo info;
1590a6f5795aSTamas Berghammer         const Error parse_error =
1591a6f5795aSTamas Berghammer             ParseMemoryRegionInfoFromProcMapsLine(line, info);
1592a6f5795aSTamas Berghammer         if (parse_error.Success()) {
1593a6f5795aSTamas Berghammer           m_mem_region_cache.emplace_back(
1594a6f5795aSTamas Berghammer               info, FileSpec(info.GetName().GetCString(), true));
1595a6f5795aSTamas Berghammer           return true;
1596a6f5795aSTamas Berghammer         } else {
1597a6321a8eSPavel Labath           LLDB_LOG(log, "failed to parse proc maps line '{0}': {1}", line,
1598a6321a8eSPavel Labath                    parse_error);
1599a6f5795aSTamas Berghammer           return false;
1600a6f5795aSTamas Berghammer         }
1601a6f5795aSTamas Berghammer       });
1602a6f5795aSTamas Berghammer 
1603a6f5795aSTamas Berghammer   // If we had an error, we'll mark unsupported.
1604a6f5795aSTamas Berghammer   if (error.Fail()) {
1605a6f5795aSTamas Berghammer     m_supports_mem_region = LazyBool::eLazyBoolNo;
1606a6f5795aSTamas Berghammer     return error;
1607a6f5795aSTamas Berghammer   } else if (m_mem_region_cache.empty()) {
1608a6f5795aSTamas Berghammer     // No entries after attempting to read them.  This shouldn't happen if
1609a6f5795aSTamas Berghammer     // /proc/{pid}/maps is supported. Assume we don't support map entries
1610a6f5795aSTamas Berghammer     // via procfs.
1611a6321a8eSPavel Labath     LLDB_LOG(log,
1612a6321a8eSPavel Labath              "failed to find any procfs maps entries, assuming no support "
1613a6321a8eSPavel Labath              "for memory region metadata retrieval");
1614a6f5795aSTamas Berghammer     m_supports_mem_region = LazyBool::eLazyBoolNo;
1615a6f5795aSTamas Berghammer     error.SetErrorString("not supported");
1616a6f5795aSTamas Berghammer     return error;
1617a6f5795aSTamas Berghammer   }
1618a6f5795aSTamas Berghammer 
1619a6321a8eSPavel Labath   LLDB_LOG(log, "read {0} memory region entries from /proc/{1}/maps",
1620a6321a8eSPavel Labath            m_mem_region_cache.size(), GetID());
1621a6f5795aSTamas Berghammer 
1622a6f5795aSTamas Berghammer   // We support memory retrieval, remember that.
1623a6f5795aSTamas Berghammer   m_supports_mem_region = LazyBool::eLazyBoolYes;
1624a6f5795aSTamas Berghammer   return Error();
1625a6f5795aSTamas Berghammer }
1626a6f5795aSTamas Berghammer 
1627b9c1b51eSKate Stone void NativeProcessLinux::DoStopIDBumped(uint32_t newBumpId) {
1628a6321a8eSPavel Labath   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
1629a6321a8eSPavel Labath   LLDB_LOG(log, "newBumpId={0}", newBumpId);
1630a6321a8eSPavel Labath   LLDB_LOG(log, "clearing {0} entries from memory region cache",
1631a6321a8eSPavel Labath            m_mem_region_cache.size());
1632af245d11STodd Fiala   m_mem_region_cache.clear();
1633af245d11STodd Fiala }
1634af245d11STodd Fiala 
1635b9c1b51eSKate Stone Error NativeProcessLinux::AllocateMemory(size_t size, uint32_t permissions,
1636b9c1b51eSKate Stone                                          lldb::addr_t &addr) {
1637af245d11STodd Fiala // FIXME implementing this requires the equivalent of
1638af245d11STodd Fiala // InferiorCallPOSIX::InferiorCallMmap, which depends on
1639af245d11STodd Fiala // functional ThreadPlans working with Native*Protocol.
1640af245d11STodd Fiala #if 1
1641af245d11STodd Fiala   return Error("not implemented yet");
1642af245d11STodd Fiala #else
1643af245d11STodd Fiala   addr = LLDB_INVALID_ADDRESS;
1644af245d11STodd Fiala 
1645af245d11STodd Fiala   unsigned prot = 0;
1646af245d11STodd Fiala   if (permissions & lldb::ePermissionsReadable)
1647af245d11STodd Fiala     prot |= eMmapProtRead;
1648af245d11STodd Fiala   if (permissions & lldb::ePermissionsWritable)
1649af245d11STodd Fiala     prot |= eMmapProtWrite;
1650af245d11STodd Fiala   if (permissions & lldb::ePermissionsExecutable)
1651af245d11STodd Fiala     prot |= eMmapProtExec;
1652af245d11STodd Fiala 
1653af245d11STodd Fiala   // TODO implement this directly in NativeProcessLinux
1654af245d11STodd Fiala   // (and lift to NativeProcessPOSIX if/when that class is
1655af245d11STodd Fiala   // refactored out).
1656af245d11STodd Fiala   if (InferiorCallMmap(this, addr, 0, size, prot,
1657af245d11STodd Fiala                        eMmapFlagsAnon | eMmapFlagsPrivate, -1, 0)) {
1658af245d11STodd Fiala     m_addr_to_mmap_size[addr] = size;
1659665be50eSMehdi Amini     return Error();
1660af245d11STodd Fiala   } else {
1661af245d11STodd Fiala     addr = LLDB_INVALID_ADDRESS;
1662b9c1b51eSKate Stone     return Error("unable to allocate %" PRIu64
1663b9c1b51eSKate Stone                  " bytes of memory with permissions %s",
1664b9c1b51eSKate Stone                  size, GetPermissionsAsCString(permissions));
1665af245d11STodd Fiala   }
1666af245d11STodd Fiala #endif
1667af245d11STodd Fiala }
1668af245d11STodd Fiala 
1669b9c1b51eSKate Stone Error NativeProcessLinux::DeallocateMemory(lldb::addr_t addr) {
1670af245d11STodd Fiala   // FIXME see comments in AllocateMemory - required lower-level
1671af245d11STodd Fiala   // bits not in place yet (ThreadPlans)
1672af245d11STodd Fiala   return Error("not implemented");
1673af245d11STodd Fiala }
1674af245d11STodd Fiala 
1675b9c1b51eSKate Stone lldb::addr_t NativeProcessLinux::GetSharedLibraryInfoAddress() {
1676af245d11STodd Fiala   // punt on this for now
1677af245d11STodd Fiala   return LLDB_INVALID_ADDRESS;
1678af245d11STodd Fiala }
1679af245d11STodd Fiala 
1680b9c1b51eSKate Stone size_t NativeProcessLinux::UpdateThreads() {
1681af245d11STodd Fiala   // The NativeProcessLinux monitoring threads are always up to date
1682af245d11STodd Fiala   // with respect to thread state and they keep the thread list
1683af245d11STodd Fiala   // populated properly. All this method needs to do is return the
1684af245d11STodd Fiala   // thread count.
1685af245d11STodd Fiala   return m_threads.size();
1686af245d11STodd Fiala }
1687af245d11STodd Fiala 
1688b9c1b51eSKate Stone bool NativeProcessLinux::GetArchitecture(ArchSpec &arch) const {
1689af245d11STodd Fiala   arch = m_arch;
1690af245d11STodd Fiala   return true;
1691af245d11STodd Fiala }
1692af245d11STodd Fiala 
1693b9c1b51eSKate Stone Error NativeProcessLinux::GetSoftwareBreakpointPCOffset(
1694b9c1b51eSKate Stone     uint32_t &actual_opcode_size) {
1695af245d11STodd Fiala   // FIXME put this behind a breakpoint protocol class that can be
1696af245d11STodd Fiala   // set per architecture.  Need ARM, MIPS support here.
1697af245d11STodd Fiala   static const uint8_t g_i386_opcode[] = {0xCC};
1698bb00d0b6SUlrich Weigand   static const uint8_t g_s390x_opcode[] = {0x00, 0x01};
1699af245d11STodd Fiala 
1700b9c1b51eSKate Stone   switch (m_arch.GetMachine()) {
1701af245d11STodd Fiala   case llvm::Triple::x86:
1702af245d11STodd Fiala   case llvm::Triple::x86_64:
1703af245d11STodd Fiala     actual_opcode_size = static_cast<uint32_t>(sizeof(g_i386_opcode));
1704665be50eSMehdi Amini     return Error();
1705af245d11STodd Fiala 
1706bb00d0b6SUlrich Weigand   case llvm::Triple::systemz:
1707bb00d0b6SUlrich Weigand     actual_opcode_size = static_cast<uint32_t>(sizeof(g_s390x_opcode));
1708665be50eSMehdi Amini     return Error();
1709bb00d0b6SUlrich Weigand 
1710ff7fd900STamas Berghammer   case llvm::Triple::arm:
1711ff7fd900STamas Berghammer   case llvm::Triple::aarch64:
1712e8659b5dSMohit K. Bhakkad   case llvm::Triple::mips64:
1713e8659b5dSMohit K. Bhakkad   case llvm::Triple::mips64el:
1714ce815e45SSagar Thakur   case llvm::Triple::mips:
1715ce815e45SSagar Thakur   case llvm::Triple::mipsel:
1716ff7fd900STamas Berghammer     // On these architectures the PC don't get updated for breakpoint hits
1717c60c9452SJaydeep Patil     actual_opcode_size = 0;
1718665be50eSMehdi Amini     return Error();
1719e8659b5dSMohit K. Bhakkad 
1720af245d11STodd Fiala   default:
1721af245d11STodd Fiala     assert(false && "CPU type not supported!");
1722af245d11STodd Fiala     return Error("CPU type not supported");
1723af245d11STodd Fiala   }
1724af245d11STodd Fiala }
1725af245d11STodd Fiala 
1726b9c1b51eSKate Stone Error NativeProcessLinux::SetBreakpoint(lldb::addr_t addr, uint32_t size,
1727b9c1b51eSKate Stone                                         bool hardware) {
1728af245d11STodd Fiala   if (hardware)
1729af245d11STodd Fiala     return Error("NativeProcessLinux does not support hardware breakpoints");
1730af245d11STodd Fiala   else
1731af245d11STodd Fiala     return SetSoftwareBreakpoint(addr, size);
1732af245d11STodd Fiala }
1733af245d11STodd Fiala 
1734b9c1b51eSKate Stone Error NativeProcessLinux::GetSoftwareBreakpointTrapOpcode(
1735b9c1b51eSKate Stone     size_t trap_opcode_size_hint, size_t &actual_opcode_size,
1736b9c1b51eSKate Stone     const uint8_t *&trap_opcode_bytes) {
173763c8be95STamas Berghammer   // FIXME put this behind a breakpoint protocol class that can be set per
173863c8be95STamas Berghammer   // architecture.  Need MIPS support here.
17392afc5966STodd Fiala   static const uint8_t g_aarch64_opcode[] = {0x00, 0x00, 0x20, 0xd4};
1740be379e15STamas Berghammer   // The ARM reference recommends the use of 0xe7fddefe and 0xdefe but the
1741be379e15STamas Berghammer   // linux kernel does otherwise.
1742be379e15STamas Berghammer   static const uint8_t g_arm_breakpoint_opcode[] = {0xf0, 0x01, 0xf0, 0xe7};
1743af245d11STodd Fiala   static const uint8_t g_i386_opcode[] = {0xCC};
17443df471c3SMohit K. Bhakkad   static const uint8_t g_mips64_opcode[] = {0x00, 0x00, 0x00, 0x0d};
17452c2acf96SMohit K. Bhakkad   static const uint8_t g_mips64el_opcode[] = {0x0d, 0x00, 0x00, 0x00};
1746bb00d0b6SUlrich Weigand   static const uint8_t g_s390x_opcode[] = {0x00, 0x01};
1747be379e15STamas Berghammer   static const uint8_t g_thumb_breakpoint_opcode[] = {0x01, 0xde};
1748af245d11STodd Fiala 
1749b9c1b51eSKate Stone   switch (m_arch.GetMachine()) {
17502afc5966STodd Fiala   case llvm::Triple::aarch64:
17512afc5966STodd Fiala     trap_opcode_bytes = g_aarch64_opcode;
17522afc5966STodd Fiala     actual_opcode_size = sizeof(g_aarch64_opcode);
1753665be50eSMehdi Amini     return Error();
17542afc5966STodd Fiala 
175563c8be95STamas Berghammer   case llvm::Triple::arm:
1756b9c1b51eSKate Stone     switch (trap_opcode_size_hint) {
175763c8be95STamas Berghammer     case 2:
175863c8be95STamas Berghammer       trap_opcode_bytes = g_thumb_breakpoint_opcode;
175963c8be95STamas Berghammer       actual_opcode_size = sizeof(g_thumb_breakpoint_opcode);
1760665be50eSMehdi Amini       return Error();
176163c8be95STamas Berghammer     case 4:
176263c8be95STamas Berghammer       trap_opcode_bytes = g_arm_breakpoint_opcode;
176363c8be95STamas Berghammer       actual_opcode_size = sizeof(g_arm_breakpoint_opcode);
1764665be50eSMehdi Amini       return Error();
176563c8be95STamas Berghammer     default:
176663c8be95STamas Berghammer       assert(false && "Unrecognised trap opcode size hint!");
176763c8be95STamas Berghammer       return Error("Unrecognised trap opcode size hint!");
176863c8be95STamas Berghammer     }
176963c8be95STamas Berghammer 
1770af245d11STodd Fiala   case llvm::Triple::x86:
1771af245d11STodd Fiala   case llvm::Triple::x86_64:
1772af245d11STodd Fiala     trap_opcode_bytes = g_i386_opcode;
1773af245d11STodd Fiala     actual_opcode_size = sizeof(g_i386_opcode);
1774665be50eSMehdi Amini     return Error();
1775af245d11STodd Fiala 
1776ce815e45SSagar Thakur   case llvm::Triple::mips:
17773df471c3SMohit K. Bhakkad   case llvm::Triple::mips64:
17783df471c3SMohit K. Bhakkad     trap_opcode_bytes = g_mips64_opcode;
17793df471c3SMohit K. Bhakkad     actual_opcode_size = sizeof(g_mips64_opcode);
1780665be50eSMehdi Amini     return Error();
17813df471c3SMohit K. Bhakkad 
1782ce815e45SSagar Thakur   case llvm::Triple::mipsel:
17832c2acf96SMohit K. Bhakkad   case llvm::Triple::mips64el:
17842c2acf96SMohit K. Bhakkad     trap_opcode_bytes = g_mips64el_opcode;
17852c2acf96SMohit K. Bhakkad     actual_opcode_size = sizeof(g_mips64el_opcode);
1786665be50eSMehdi Amini     return Error();
17872c2acf96SMohit K. Bhakkad 
1788bb00d0b6SUlrich Weigand   case llvm::Triple::systemz:
1789bb00d0b6SUlrich Weigand     trap_opcode_bytes = g_s390x_opcode;
1790bb00d0b6SUlrich Weigand     actual_opcode_size = sizeof(g_s390x_opcode);
1791665be50eSMehdi Amini     return Error();
1792bb00d0b6SUlrich Weigand 
1793af245d11STodd Fiala   default:
1794af245d11STodd Fiala     assert(false && "CPU type not supported!");
1795af245d11STodd Fiala     return Error("CPU type not supported");
1796af245d11STodd Fiala   }
1797af245d11STodd Fiala }
1798af245d11STodd Fiala 
1799af245d11STodd Fiala #if 0
1800af245d11STodd Fiala ProcessMessage::CrashReason
1801af245d11STodd Fiala NativeProcessLinux::GetCrashReasonForSIGSEGV(const siginfo_t *info)
1802af245d11STodd Fiala {
1803af245d11STodd Fiala     ProcessMessage::CrashReason reason;
1804af245d11STodd Fiala     assert(info->si_signo == SIGSEGV);
1805af245d11STodd Fiala 
1806af245d11STodd Fiala     reason = ProcessMessage::eInvalidCrashReason;
1807af245d11STodd Fiala 
1808af245d11STodd Fiala     switch (info->si_code)
1809af245d11STodd Fiala     {
1810af245d11STodd Fiala     default:
1811af245d11STodd Fiala         assert(false && "unexpected si_code for SIGSEGV");
1812af245d11STodd Fiala         break;
1813af245d11STodd Fiala     case SI_KERNEL:
1814af245d11STodd Fiala         // Linux will occasionally send spurious SI_KERNEL codes.
1815af245d11STodd Fiala         // (this is poorly documented in sigaction)
1816af245d11STodd Fiala         // One way to get this is via unaligned SIMD loads.
1817af245d11STodd Fiala         reason = ProcessMessage::eInvalidAddress; // for lack of anything better
1818af245d11STodd Fiala         break;
1819af245d11STodd Fiala     case SEGV_MAPERR:
1820af245d11STodd Fiala         reason = ProcessMessage::eInvalidAddress;
1821af245d11STodd Fiala         break;
1822af245d11STodd Fiala     case SEGV_ACCERR:
1823af245d11STodd Fiala         reason = ProcessMessage::ePrivilegedAddress;
1824af245d11STodd Fiala         break;
1825af245d11STodd Fiala     }
1826af245d11STodd Fiala 
1827af245d11STodd Fiala     return reason;
1828af245d11STodd Fiala }
1829af245d11STodd Fiala #endif
1830af245d11STodd Fiala 
1831af245d11STodd Fiala #if 0
1832af245d11STodd Fiala ProcessMessage::CrashReason
1833af245d11STodd Fiala NativeProcessLinux::GetCrashReasonForSIGILL(const siginfo_t *info)
1834af245d11STodd Fiala {
1835af245d11STodd Fiala     ProcessMessage::CrashReason reason;
1836af245d11STodd Fiala     assert(info->si_signo == SIGILL);
1837af245d11STodd Fiala 
1838af245d11STodd Fiala     reason = ProcessMessage::eInvalidCrashReason;
1839af245d11STodd Fiala 
1840af245d11STodd Fiala     switch (info->si_code)
1841af245d11STodd Fiala     {
1842af245d11STodd Fiala     default:
1843af245d11STodd Fiala         assert(false && "unexpected si_code for SIGILL");
1844af245d11STodd Fiala         break;
1845af245d11STodd Fiala     case ILL_ILLOPC:
1846af245d11STodd Fiala         reason = ProcessMessage::eIllegalOpcode;
1847af245d11STodd Fiala         break;
1848af245d11STodd Fiala     case ILL_ILLOPN:
1849af245d11STodd Fiala         reason = ProcessMessage::eIllegalOperand;
1850af245d11STodd Fiala         break;
1851af245d11STodd Fiala     case ILL_ILLADR:
1852af245d11STodd Fiala         reason = ProcessMessage::eIllegalAddressingMode;
1853af245d11STodd Fiala         break;
1854af245d11STodd Fiala     case ILL_ILLTRP:
1855af245d11STodd Fiala         reason = ProcessMessage::eIllegalTrap;
1856af245d11STodd Fiala         break;
1857af245d11STodd Fiala     case ILL_PRVOPC:
1858af245d11STodd Fiala         reason = ProcessMessage::ePrivilegedOpcode;
1859af245d11STodd Fiala         break;
1860af245d11STodd Fiala     case ILL_PRVREG:
1861af245d11STodd Fiala         reason = ProcessMessage::ePrivilegedRegister;
1862af245d11STodd Fiala         break;
1863af245d11STodd Fiala     case ILL_COPROC:
1864af245d11STodd Fiala         reason = ProcessMessage::eCoprocessorError;
1865af245d11STodd Fiala         break;
1866af245d11STodd Fiala     case ILL_BADSTK:
1867af245d11STodd Fiala         reason = ProcessMessage::eInternalStackError;
1868af245d11STodd Fiala         break;
1869af245d11STodd Fiala     }
1870af245d11STodd Fiala 
1871af245d11STodd Fiala     return reason;
1872af245d11STodd Fiala }
1873af245d11STodd Fiala #endif
1874af245d11STodd Fiala 
1875af245d11STodd Fiala #if 0
1876af245d11STodd Fiala ProcessMessage::CrashReason
1877af245d11STodd Fiala NativeProcessLinux::GetCrashReasonForSIGFPE(const siginfo_t *info)
1878af245d11STodd Fiala {
1879af245d11STodd Fiala     ProcessMessage::CrashReason reason;
1880af245d11STodd Fiala     assert(info->si_signo == SIGFPE);
1881af245d11STodd Fiala 
1882af245d11STodd Fiala     reason = ProcessMessage::eInvalidCrashReason;
1883af245d11STodd Fiala 
1884af245d11STodd Fiala     switch (info->si_code)
1885af245d11STodd Fiala     {
1886af245d11STodd Fiala     default:
1887af245d11STodd Fiala         assert(false && "unexpected si_code for SIGFPE");
1888af245d11STodd Fiala         break;
1889af245d11STodd Fiala     case FPE_INTDIV:
1890af245d11STodd Fiala         reason = ProcessMessage::eIntegerDivideByZero;
1891af245d11STodd Fiala         break;
1892af245d11STodd Fiala     case FPE_INTOVF:
1893af245d11STodd Fiala         reason = ProcessMessage::eIntegerOverflow;
1894af245d11STodd Fiala         break;
1895af245d11STodd Fiala     case FPE_FLTDIV:
1896af245d11STodd Fiala         reason = ProcessMessage::eFloatDivideByZero;
1897af245d11STodd Fiala         break;
1898af245d11STodd Fiala     case FPE_FLTOVF:
1899af245d11STodd Fiala         reason = ProcessMessage::eFloatOverflow;
1900af245d11STodd Fiala         break;
1901af245d11STodd Fiala     case FPE_FLTUND:
1902af245d11STodd Fiala         reason = ProcessMessage::eFloatUnderflow;
1903af245d11STodd Fiala         break;
1904af245d11STodd Fiala     case FPE_FLTRES:
1905af245d11STodd Fiala         reason = ProcessMessage::eFloatInexactResult;
1906af245d11STodd Fiala         break;
1907af245d11STodd Fiala     case FPE_FLTINV:
1908af245d11STodd Fiala         reason = ProcessMessage::eFloatInvalidOperation;
1909af245d11STodd Fiala         break;
1910af245d11STodd Fiala     case FPE_FLTSUB:
1911af245d11STodd Fiala         reason = ProcessMessage::eFloatSubscriptRange;
1912af245d11STodd Fiala         break;
1913af245d11STodd Fiala     }
1914af245d11STodd Fiala 
1915af245d11STodd Fiala     return reason;
1916af245d11STodd Fiala }
1917af245d11STodd Fiala #endif
1918af245d11STodd Fiala 
1919af245d11STodd Fiala #if 0
1920af245d11STodd Fiala ProcessMessage::CrashReason
1921af245d11STodd Fiala NativeProcessLinux::GetCrashReasonForSIGBUS(const siginfo_t *info)
1922af245d11STodd Fiala {
1923af245d11STodd Fiala     ProcessMessage::CrashReason reason;
1924af245d11STodd Fiala     assert(info->si_signo == SIGBUS);
1925af245d11STodd Fiala 
1926af245d11STodd Fiala     reason = ProcessMessage::eInvalidCrashReason;
1927af245d11STodd Fiala 
1928af245d11STodd Fiala     switch (info->si_code)
1929af245d11STodd Fiala     {
1930af245d11STodd Fiala     default:
1931af245d11STodd Fiala         assert(false && "unexpected si_code for SIGBUS");
1932af245d11STodd Fiala         break;
1933af245d11STodd Fiala     case BUS_ADRALN:
1934af245d11STodd Fiala         reason = ProcessMessage::eIllegalAlignment;
1935af245d11STodd Fiala         break;
1936af245d11STodd Fiala     case BUS_ADRERR:
1937af245d11STodd Fiala         reason = ProcessMessage::eIllegalAddress;
1938af245d11STodd Fiala         break;
1939af245d11STodd Fiala     case BUS_OBJERR:
1940af245d11STodd Fiala         reason = ProcessMessage::eHardwareError;
1941af245d11STodd Fiala         break;
1942af245d11STodd Fiala     }
1943af245d11STodd Fiala 
1944af245d11STodd Fiala     return reason;
1945af245d11STodd Fiala }
1946af245d11STodd Fiala #endif
1947af245d11STodd Fiala 
1948b9c1b51eSKate Stone Error NativeProcessLinux::ReadMemory(lldb::addr_t addr, void *buf, size_t size,
1949b9c1b51eSKate Stone                                      size_t &bytes_read) {
1950df7c6995SPavel Labath   if (ProcessVmReadvSupported()) {
1951b9c1b51eSKate Stone     // The process_vm_readv path is about 50 times faster than ptrace api. We
1952b9c1b51eSKate Stone     // want to use
1953df7c6995SPavel Labath     // this syscall if it is supported.
1954df7c6995SPavel Labath 
1955df7c6995SPavel Labath     const ::pid_t pid = GetID();
1956df7c6995SPavel Labath 
1957df7c6995SPavel Labath     struct iovec local_iov, remote_iov;
1958df7c6995SPavel Labath     local_iov.iov_base = buf;
1959df7c6995SPavel Labath     local_iov.iov_len = size;
1960df7c6995SPavel Labath     remote_iov.iov_base = reinterpret_cast<void *>(addr);
1961df7c6995SPavel Labath     remote_iov.iov_len = size;
1962df7c6995SPavel Labath 
1963df7c6995SPavel Labath     bytes_read = process_vm_readv(pid, &local_iov, 1, &remote_iov, 1, 0);
1964df7c6995SPavel Labath     const bool success = bytes_read == size;
1965df7c6995SPavel Labath 
1966a6321a8eSPavel Labath     Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
1967a6321a8eSPavel Labath     LLDB_LOG(log,
1968a6321a8eSPavel Labath              "using process_vm_readv to read {0} bytes from inferior "
1969a6321a8eSPavel Labath              "address {1:x}: {2}",
1970a6321a8eSPavel Labath              size, addr, success ? "Success" : strerror(errno));
1971df7c6995SPavel Labath 
1972df7c6995SPavel Labath     if (success)
1973665be50eSMehdi Amini       return Error();
1974a6321a8eSPavel Labath     // else the call failed for some reason, let's retry the read using ptrace
1975b9c1b51eSKate Stone     // api.
1976df7c6995SPavel Labath   }
1977df7c6995SPavel Labath 
197819cbe96aSPavel Labath   unsigned char *dst = static_cast<unsigned char *>(buf);
197919cbe96aSPavel Labath   size_t remainder;
198019cbe96aSPavel Labath   long data;
198119cbe96aSPavel Labath 
1982a6321a8eSPavel Labath   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_MEMORY));
1983a6321a8eSPavel Labath   LLDB_LOG(log, "addr = {0}, buf = {1}, size = {2}", addr, buf, size);
198419cbe96aSPavel Labath 
1985b9c1b51eSKate Stone   for (bytes_read = 0; bytes_read < size; bytes_read += remainder) {
1986b9c1b51eSKate Stone     Error error = NativeProcessLinux::PtraceWrapper(
1987b9c1b51eSKate Stone         PTRACE_PEEKDATA, GetID(), (void *)addr, nullptr, 0, &data);
1988a6321a8eSPavel Labath     if (error.Fail())
198919cbe96aSPavel Labath       return error;
199019cbe96aSPavel Labath 
199119cbe96aSPavel Labath     remainder = size - bytes_read;
199219cbe96aSPavel Labath     remainder = remainder > k_ptrace_word_size ? k_ptrace_word_size : remainder;
199319cbe96aSPavel Labath 
199419cbe96aSPavel Labath     // Copy the data into our buffer
1995f6ef187bSMohit K. Bhakkad     memcpy(dst, &data, remainder);
199619cbe96aSPavel Labath 
1997a6321a8eSPavel Labath     LLDB_LOG(log, "[{0:x}]:{1:x}", addr, data);
199819cbe96aSPavel Labath     addr += k_ptrace_word_size;
199919cbe96aSPavel Labath     dst += k_ptrace_word_size;
200019cbe96aSPavel Labath   }
2001665be50eSMehdi Amini   return Error();
2002af245d11STodd Fiala }
2003af245d11STodd Fiala 
2004b9c1b51eSKate Stone Error NativeProcessLinux::ReadMemoryWithoutTrap(lldb::addr_t addr, void *buf,
2005b9c1b51eSKate Stone                                                 size_t size,
2006b9c1b51eSKate Stone                                                 size_t &bytes_read) {
20073eb4b458SChaoren Lin   Error error = ReadMemory(addr, buf, size, bytes_read);
2008b9c1b51eSKate Stone   if (error.Fail())
2009b9c1b51eSKate Stone     return error;
20103eb4b458SChaoren Lin   return m_breakpoint_list.RemoveTrapsFromBuffer(addr, buf, size);
20113eb4b458SChaoren Lin }
20123eb4b458SChaoren Lin 
2013b9c1b51eSKate Stone Error NativeProcessLinux::WriteMemory(lldb::addr_t addr, const void *buf,
2014b9c1b51eSKate Stone                                       size_t size, size_t &bytes_written) {
201519cbe96aSPavel Labath   const unsigned char *src = static_cast<const unsigned char *>(buf);
201619cbe96aSPavel Labath   size_t remainder;
201719cbe96aSPavel Labath   Error error;
201819cbe96aSPavel Labath 
2019a6321a8eSPavel Labath   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_MEMORY));
2020a6321a8eSPavel Labath   LLDB_LOG(log, "addr = {0}, buf = {1}, size = {2}", addr, buf, size);
202119cbe96aSPavel Labath 
2022b9c1b51eSKate Stone   for (bytes_written = 0; bytes_written < size; bytes_written += remainder) {
202319cbe96aSPavel Labath     remainder = size - bytes_written;
202419cbe96aSPavel Labath     remainder = remainder > k_ptrace_word_size ? k_ptrace_word_size : remainder;
202519cbe96aSPavel Labath 
2026b9c1b51eSKate Stone     if (remainder == k_ptrace_word_size) {
202719cbe96aSPavel Labath       unsigned long data = 0;
2028f6ef187bSMohit K. Bhakkad       memcpy(&data, src, k_ptrace_word_size);
202919cbe96aSPavel Labath 
2030a6321a8eSPavel Labath       LLDB_LOG(log, "[{0:x}]:{1:x}", addr, data);
2031b9c1b51eSKate Stone       error = NativeProcessLinux::PtraceWrapper(PTRACE_POKEDATA, GetID(),
2032b9c1b51eSKate Stone                                                 (void *)addr, (void *)data);
2033a6321a8eSPavel Labath       if (error.Fail())
203419cbe96aSPavel Labath         return error;
2035b9c1b51eSKate Stone     } else {
203619cbe96aSPavel Labath       unsigned char buff[8];
203719cbe96aSPavel Labath       size_t bytes_read;
203819cbe96aSPavel Labath       error = ReadMemory(addr, buff, k_ptrace_word_size, bytes_read);
2039a6321a8eSPavel Labath       if (error.Fail())
204019cbe96aSPavel Labath         return error;
204119cbe96aSPavel Labath 
204219cbe96aSPavel Labath       memcpy(buff, src, remainder);
204319cbe96aSPavel Labath 
204419cbe96aSPavel Labath       size_t bytes_written_rec;
204519cbe96aSPavel Labath       error = WriteMemory(addr, buff, k_ptrace_word_size, bytes_written_rec);
2046a6321a8eSPavel Labath       if (error.Fail())
204719cbe96aSPavel Labath         return error;
204819cbe96aSPavel Labath 
2049a6321a8eSPavel Labath       LLDB_LOG(log, "[{0:x}]:{1:x} ({2:x})", addr, *(const unsigned long *)src,
2050b9c1b51eSKate Stone                *(unsigned long *)buff);
205119cbe96aSPavel Labath     }
205219cbe96aSPavel Labath 
205319cbe96aSPavel Labath     addr += k_ptrace_word_size;
205419cbe96aSPavel Labath     src += k_ptrace_word_size;
205519cbe96aSPavel Labath   }
205619cbe96aSPavel Labath   return error;
2057af245d11STodd Fiala }
2058af245d11STodd Fiala 
2059b9c1b51eSKate Stone Error NativeProcessLinux::GetSignalInfo(lldb::tid_t tid, void *siginfo) {
206019cbe96aSPavel Labath   return PtraceWrapper(PTRACE_GETSIGINFO, tid, nullptr, siginfo);
2061af245d11STodd Fiala }
2062af245d11STodd Fiala 
2063b9c1b51eSKate Stone Error NativeProcessLinux::GetEventMessage(lldb::tid_t tid,
2064b9c1b51eSKate Stone                                           unsigned long *message) {
206519cbe96aSPavel Labath   return PtraceWrapper(PTRACE_GETEVENTMSG, tid, nullptr, message);
2066af245d11STodd Fiala }
2067af245d11STodd Fiala 
2068b9c1b51eSKate Stone Error NativeProcessLinux::Detach(lldb::tid_t tid) {
206997ccc294SChaoren Lin   if (tid == LLDB_INVALID_THREAD_ID)
2070665be50eSMehdi Amini     return Error();
207197ccc294SChaoren Lin 
207219cbe96aSPavel Labath   return PtraceWrapper(PTRACE_DETACH, tid);
2073af245d11STodd Fiala }
2074af245d11STodd Fiala 
2075b9c1b51eSKate Stone bool NativeProcessLinux::HasThreadNoLock(lldb::tid_t thread_id) {
2076b9c1b51eSKate Stone   for (auto thread_sp : m_threads) {
2077af245d11STodd Fiala     assert(thread_sp && "thread list should not contain NULL threads");
2078b9c1b51eSKate Stone     if (thread_sp->GetID() == thread_id) {
2079af245d11STodd Fiala       // We have this thread.
2080af245d11STodd Fiala       return true;
2081af245d11STodd Fiala     }
2082af245d11STodd Fiala   }
2083af245d11STodd Fiala 
2084af245d11STodd Fiala   // We don't have this thread.
2085af245d11STodd Fiala   return false;
2086af245d11STodd Fiala }
2087af245d11STodd Fiala 
2088b9c1b51eSKate Stone bool NativeProcessLinux::StopTrackingThread(lldb::tid_t thread_id) {
2089a6321a8eSPavel Labath   Log *const log = ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_THREAD);
2090a6321a8eSPavel Labath   LLDB_LOG(log, "tid: {0})", thread_id);
20911dbc6c9cSPavel Labath 
20921dbc6c9cSPavel Labath   bool found = false;
2093b9c1b51eSKate Stone   for (auto it = m_threads.begin(); it != m_threads.end(); ++it) {
2094b9c1b51eSKate Stone     if (*it && ((*it)->GetID() == thread_id)) {
2095af245d11STodd Fiala       m_threads.erase(it);
20961dbc6c9cSPavel Labath       found = true;
20971dbc6c9cSPavel Labath       break;
2098af245d11STodd Fiala     }
2099af245d11STodd Fiala   }
2100af245d11STodd Fiala 
21019eb1ecb9SPavel Labath   SignalIfAllThreadsStopped();
21021dbc6c9cSPavel Labath   return found;
2103af245d11STodd Fiala }
2104af245d11STodd Fiala 
2105b9c1b51eSKate Stone NativeThreadLinuxSP NativeProcessLinux::AddThread(lldb::tid_t thread_id) {
2106a6321a8eSPavel Labath   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_THREAD));
2107a6321a8eSPavel Labath   LLDB_LOG(log, "pid {0} adding thread with tid {1}", GetID(), thread_id);
2108af245d11STodd Fiala 
2109b9c1b51eSKate Stone   assert(!HasThreadNoLock(thread_id) &&
2110b9c1b51eSKate Stone          "attempted to add a thread by id that already exists");
2111af245d11STodd Fiala 
2112af245d11STodd Fiala   // If this is the first thread, save it as the current thread
2113af245d11STodd Fiala   if (m_threads.empty())
2114af245d11STodd Fiala     SetCurrentThreadID(thread_id);
2115af245d11STodd Fiala 
2116f9077782SPavel Labath   auto thread_sp = std::make_shared<NativeThreadLinux>(this, thread_id);
2117af245d11STodd Fiala   m_threads.push_back(thread_sp);
2118af245d11STodd Fiala   return thread_sp;
2119af245d11STodd Fiala }
2120af245d11STodd Fiala 
2121b9c1b51eSKate Stone Error NativeProcessLinux::FixupBreakpointPCAsNeeded(NativeThreadLinux &thread) {
2122a6321a8eSPavel Labath   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_BREAKPOINTS));
2123af245d11STodd Fiala 
2124af245d11STodd Fiala   Error error;
2125af245d11STodd Fiala 
2126b9c1b51eSKate Stone   // Find out the size of a breakpoint (might depend on where we are in the
2127b9c1b51eSKate Stone   // code).
2128b9cc0c75SPavel Labath   NativeRegisterContextSP context_sp = thread.GetRegisterContext();
2129b9c1b51eSKate Stone   if (!context_sp) {
2130af245d11STodd Fiala     error.SetErrorString("cannot get a NativeRegisterContext for the thread");
2131a6321a8eSPavel Labath     LLDB_LOG(log, "failed: {0}", error);
2132af245d11STodd Fiala     return error;
2133af245d11STodd Fiala   }
2134af245d11STodd Fiala 
2135af245d11STodd Fiala   uint32_t breakpoint_size = 0;
2136b9cc0c75SPavel Labath   error = GetSoftwareBreakpointPCOffset(breakpoint_size);
2137b9c1b51eSKate Stone   if (error.Fail()) {
2138a6321a8eSPavel Labath     LLDB_LOG(log, "GetBreakpointSize() failed: {0}", error);
2139af245d11STodd Fiala     return error;
2140a6321a8eSPavel Labath   } else
2141a6321a8eSPavel Labath     LLDB_LOG(log, "breakpoint size: {0}", breakpoint_size);
2142af245d11STodd Fiala 
2143b9c1b51eSKate Stone   // First try probing for a breakpoint at a software breakpoint location: PC -
2144b9c1b51eSKate Stone   // breakpoint size.
2145b9c1b51eSKate Stone   const lldb::addr_t initial_pc_addr =
2146b9c1b51eSKate Stone       context_sp->GetPCfromBreakpointLocation();
2147af245d11STodd Fiala   lldb::addr_t breakpoint_addr = initial_pc_addr;
2148b9c1b51eSKate Stone   if (breakpoint_size > 0) {
2149af245d11STodd Fiala     // Do not allow breakpoint probe to wrap around.
21503eb4b458SChaoren Lin     if (breakpoint_addr >= breakpoint_size)
21513eb4b458SChaoren Lin       breakpoint_addr -= breakpoint_size;
2152af245d11STodd Fiala   }
2153af245d11STodd Fiala 
2154af245d11STodd Fiala   // Check if we stopped because of a breakpoint.
2155af245d11STodd Fiala   NativeBreakpointSP breakpoint_sp;
2156af245d11STodd Fiala   error = m_breakpoint_list.GetBreakpoint(breakpoint_addr, breakpoint_sp);
2157b9c1b51eSKate Stone   if (!error.Success() || !breakpoint_sp) {
2158af245d11STodd Fiala     // We didn't find one at a software probe location.  Nothing to do.
2159a6321a8eSPavel Labath     LLDB_LOG(log,
2160a6321a8eSPavel Labath              "pid {0} no lldb breakpoint found at current pc with "
2161a6321a8eSPavel Labath              "adjustment: {1}",
2162a6321a8eSPavel Labath              GetID(), breakpoint_addr);
2163665be50eSMehdi Amini     return Error();
2164af245d11STodd Fiala   }
2165af245d11STodd Fiala 
2166af245d11STodd Fiala   // If the breakpoint is not a software breakpoint, nothing to do.
2167b9c1b51eSKate Stone   if (!breakpoint_sp->IsSoftwareBreakpoint()) {
2168a6321a8eSPavel Labath     LLDB_LOG(
2169a6321a8eSPavel Labath         log,
2170a6321a8eSPavel Labath         "pid {0} breakpoint found at {1:x}, not software, nothing to adjust",
2171a6321a8eSPavel Labath         GetID(), breakpoint_addr);
2172665be50eSMehdi Amini     return Error();
2173af245d11STodd Fiala   }
2174af245d11STodd Fiala 
2175af245d11STodd Fiala   //
2176af245d11STodd Fiala   // We have a software breakpoint and need to adjust the PC.
2177af245d11STodd Fiala   //
2178af245d11STodd Fiala 
2179af245d11STodd Fiala   // Sanity check.
2180b9c1b51eSKate Stone   if (breakpoint_size == 0) {
2181af245d11STodd Fiala     // Nothing to do!  How did we get here?
2182a6321a8eSPavel Labath     LLDB_LOG(log,
2183a6321a8eSPavel Labath              "pid {0} breakpoint found at {1:x}, it is software, but the "
2184a6321a8eSPavel Labath              "size is zero, nothing to do (unexpected)",
2185a6321a8eSPavel Labath              GetID(), breakpoint_addr);
2186665be50eSMehdi Amini     return Error();
2187af245d11STodd Fiala   }
2188af245d11STodd Fiala 
2189af245d11STodd Fiala   // Change the program counter.
2190a6321a8eSPavel Labath   LLDB_LOG(log, "pid {0} tid {1}: changing PC from {2:x} to {3:x}", GetID(),
2191a6321a8eSPavel Labath            thread.GetID(), initial_pc_addr, breakpoint_addr);
2192af245d11STodd Fiala 
2193af245d11STodd Fiala   error = context_sp->SetPC(breakpoint_addr);
2194b9c1b51eSKate Stone   if (error.Fail()) {
2195a6321a8eSPavel Labath     LLDB_LOG(log, "pid {0} tid {1}: failed to set PC: {2}", GetID(),
2196a6321a8eSPavel Labath              thread.GetID(), error);
2197af245d11STodd Fiala     return error;
2198af245d11STodd Fiala   }
2199af245d11STodd Fiala 
2200af245d11STodd Fiala   return error;
2201af245d11STodd Fiala }
2202fa03ad2eSChaoren Lin 
2203b9c1b51eSKate Stone Error NativeProcessLinux::GetLoadedModuleFileSpec(const char *module_path,
2204b9c1b51eSKate Stone                                                   FileSpec &file_spec) {
2205a6f5795aSTamas Berghammer   Error error = PopulateMemoryRegionCache();
2206a6f5795aSTamas Berghammer   if (error.Fail())
2207a6f5795aSTamas Berghammer     return error;
2208a6f5795aSTamas Berghammer 
22097cb18bf5STamas Berghammer   FileSpec module_file_spec(module_path, true);
22107cb18bf5STamas Berghammer 
22117cb18bf5STamas Berghammer   file_spec.Clear();
2212a6f5795aSTamas Berghammer   for (const auto &it : m_mem_region_cache) {
2213a6f5795aSTamas Berghammer     if (it.second.GetFilename() == module_file_spec.GetFilename()) {
2214a6f5795aSTamas Berghammer       file_spec = it.second;
2215a6f5795aSTamas Berghammer       return Error();
2216a6f5795aSTamas Berghammer     }
2217a6f5795aSTamas Berghammer   }
22187cb18bf5STamas Berghammer   return Error("Module file (%s) not found in /proc/%" PRIu64 "/maps file!",
22197cb18bf5STamas Berghammer                module_file_spec.GetFilename().AsCString(), GetID());
22207cb18bf5STamas Berghammer }
2221c076559aSPavel Labath 
2222b9c1b51eSKate Stone Error NativeProcessLinux::GetFileLoadAddress(const llvm::StringRef &file_name,
2223b9c1b51eSKate Stone                                              lldb::addr_t &load_addr) {
2224783bfc8cSTamas Berghammer   load_addr = LLDB_INVALID_ADDRESS;
2225a6f5795aSTamas Berghammer   Error error = PopulateMemoryRegionCache();
2226a6f5795aSTamas Berghammer   if (error.Fail())
2227783bfc8cSTamas Berghammer     return error;
2228a6f5795aSTamas Berghammer 
2229a6f5795aSTamas Berghammer   FileSpec file(file_name, false);
2230a6f5795aSTamas Berghammer   for (const auto &it : m_mem_region_cache) {
2231a6f5795aSTamas Berghammer     if (it.second == file) {
2232a6f5795aSTamas Berghammer       load_addr = it.first.GetRange().GetRangeBase();
2233a6f5795aSTamas Berghammer       return Error();
2234a6f5795aSTamas Berghammer     }
2235a6f5795aSTamas Berghammer   }
2236a6f5795aSTamas Berghammer   return Error("No load address found for specified file.");
2237783bfc8cSTamas Berghammer }
2238783bfc8cSTamas Berghammer 
2239b9c1b51eSKate Stone NativeThreadLinuxSP NativeProcessLinux::GetThreadByID(lldb::tid_t tid) {
2240b9c1b51eSKate Stone   return std::static_pointer_cast<NativeThreadLinux>(
2241b9c1b51eSKate Stone       NativeProcessProtocol::GetThreadByID(tid));
2242f9077782SPavel Labath }
2243f9077782SPavel Labath 
2244b9c1b51eSKate Stone Error NativeProcessLinux::ResumeThread(NativeThreadLinux &thread,
2245b9c1b51eSKate Stone                                        lldb::StateType state, int signo) {
2246a6321a8eSPavel Labath   Log *const log = ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_THREAD);
2247a6321a8eSPavel Labath   LLDB_LOG(log, "tid: {0}", thread.GetID());
2248c076559aSPavel Labath 
2249c076559aSPavel Labath   // Before we do the resume below, first check if we have a pending
2250108c325dSPavel Labath   // stop notification that is currently waiting for
22510e1d729bSPavel Labath   // all threads to stop.  This is potentially a buggy situation since
2252c076559aSPavel Labath   // we're ostensibly waiting for threads to stop before we send out the
2253c076559aSPavel Labath   // pending notification, and here we are resuming one before we send
2254c076559aSPavel Labath   // out the pending stop notification.
2255a6321a8eSPavel Labath   if (m_pending_notification_tid != LLDB_INVALID_THREAD_ID) {
2256a6321a8eSPavel Labath     LLDB_LOG(log,
2257a6321a8eSPavel Labath              "about to resume tid {0} per explicit request but we have a "
2258a6321a8eSPavel Labath              "pending stop notification (tid {1}) that is actively "
2259a6321a8eSPavel Labath              "waiting for this thread to stop. Valid sequence of events?",
2260a6321a8eSPavel Labath              thread.GetID(), m_pending_notification_tid);
2261c076559aSPavel Labath   }
2262c076559aSPavel Labath 
2263c076559aSPavel Labath   // Request a resume.  We expect this to be synchronous and the system
2264c076559aSPavel Labath   // to reflect it is running after this completes.
2265b9c1b51eSKate Stone   switch (state) {
2266b9c1b51eSKate Stone   case eStateRunning: {
2267605b51b8SPavel Labath     const auto resume_result = thread.Resume(signo);
22680e1d729bSPavel Labath     if (resume_result.Success())
22690e1d729bSPavel Labath       SetState(eStateRunning, true);
22700e1d729bSPavel Labath     return resume_result;
2271c076559aSPavel Labath   }
2272b9c1b51eSKate Stone   case eStateStepping: {
2273605b51b8SPavel Labath     const auto step_result = thread.SingleStep(signo);
22740e1d729bSPavel Labath     if (step_result.Success())
22750e1d729bSPavel Labath       SetState(eStateRunning, true);
22760e1d729bSPavel Labath     return step_result;
22770e1d729bSPavel Labath   }
22780e1d729bSPavel Labath   default:
22798198db30SPavel Labath     LLDB_LOG(log, "Unhandled state {0}.", state);
22800e1d729bSPavel Labath     llvm_unreachable("Unhandled state for resume");
22810e1d729bSPavel Labath   }
2282c076559aSPavel Labath }
2283c076559aSPavel Labath 
2284c076559aSPavel Labath //===----------------------------------------------------------------------===//
2285c076559aSPavel Labath 
2286b9c1b51eSKate Stone void NativeProcessLinux::StopRunningThreads(const lldb::tid_t triggering_tid) {
2287a6321a8eSPavel Labath   Log *const log = ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_THREAD);
2288a6321a8eSPavel Labath   LLDB_LOG(log, "about to process event: (triggering_tid: {0})",
2289a6321a8eSPavel Labath            triggering_tid);
2290c076559aSPavel Labath 
22910e1d729bSPavel Labath   m_pending_notification_tid = triggering_tid;
22920e1d729bSPavel Labath 
22930e1d729bSPavel Labath   // Request a stop for all the thread stops that need to be stopped
22940e1d729bSPavel Labath   // and are not already known to be stopped.
2295b9c1b51eSKate Stone   for (const auto &thread_sp : m_threads) {
22960e1d729bSPavel Labath     if (StateIsRunningState(thread_sp->GetState()))
22970e1d729bSPavel Labath       static_pointer_cast<NativeThreadLinux>(thread_sp)->RequestStop();
22980e1d729bSPavel Labath   }
22990e1d729bSPavel Labath 
23000e1d729bSPavel Labath   SignalIfAllThreadsStopped();
2301a6321a8eSPavel Labath   LLDB_LOG(log, "event processing done");
2302c076559aSPavel Labath }
2303c076559aSPavel Labath 
2304b9c1b51eSKate Stone void NativeProcessLinux::SignalIfAllThreadsStopped() {
23050e1d729bSPavel Labath   if (m_pending_notification_tid == LLDB_INVALID_THREAD_ID)
23060e1d729bSPavel Labath     return; // No pending notification. Nothing to do.
23070e1d729bSPavel Labath 
2308b9c1b51eSKate Stone   for (const auto &thread_sp : m_threads) {
23090e1d729bSPavel Labath     if (StateIsRunningState(thread_sp->GetState()))
23100e1d729bSPavel Labath       return; // Some threads are still running. Don't signal yet.
23110e1d729bSPavel Labath   }
23120e1d729bSPavel Labath 
23130e1d729bSPavel Labath   // We have a pending notification and all threads have stopped.
2314b9c1b51eSKate Stone   Log *log(
2315b9c1b51eSKate Stone       GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS | LIBLLDB_LOG_BREAKPOINTS));
23169eb1ecb9SPavel Labath 
2317b9c1b51eSKate Stone   // Clear any temporary breakpoints we used to implement software single
2318b9c1b51eSKate Stone   // stepping.
2319b9c1b51eSKate Stone   for (const auto &thread_info : m_threads_stepping_with_breakpoint) {
23209eb1ecb9SPavel Labath     Error error = RemoveBreakpoint(thread_info.second);
23219eb1ecb9SPavel Labath     if (error.Fail())
2322a6321a8eSPavel Labath       LLDB_LOG(log, "pid = {0} remove stepping breakpoint: {1}",
2323a6321a8eSPavel Labath                thread_info.first, error);
23249eb1ecb9SPavel Labath   }
23259eb1ecb9SPavel Labath   m_threads_stepping_with_breakpoint.clear();
23269eb1ecb9SPavel Labath 
23279eb1ecb9SPavel Labath   // Notify the delegate about the stop
23280e1d729bSPavel Labath   SetCurrentThreadID(m_pending_notification_tid);
2329ed89c7feSPavel Labath   SetState(StateType::eStateStopped, true);
23300e1d729bSPavel Labath   m_pending_notification_tid = LLDB_INVALID_THREAD_ID;
2331c076559aSPavel Labath }
2332c076559aSPavel Labath 
2333b9c1b51eSKate Stone void NativeProcessLinux::ThreadWasCreated(NativeThreadLinux &thread) {
2334a6321a8eSPavel Labath   Log *const log = ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_THREAD);
2335a6321a8eSPavel Labath   LLDB_LOG(log, "tid: {0}", thread.GetID());
23361dbc6c9cSPavel Labath 
2337b9c1b51eSKate Stone   if (m_pending_notification_tid != LLDB_INVALID_THREAD_ID &&
2338b9c1b51eSKate Stone       StateIsRunningState(thread.GetState())) {
2339b9c1b51eSKate Stone     // We will need to wait for this new thread to stop as well before firing
2340b9c1b51eSKate Stone     // the
2341c076559aSPavel Labath     // notification.
2342f9077782SPavel Labath     thread.RequestStop();
2343c076559aSPavel Labath   }
2344c076559aSPavel Labath }
2345068f8a7eSTamas Berghammer 
2346b9c1b51eSKate Stone void NativeProcessLinux::SigchldHandler() {
2347a6321a8eSPavel Labath   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
234819cbe96aSPavel Labath   // Process all pending waitpid notifications.
2349b9c1b51eSKate Stone   while (true) {
235019cbe96aSPavel Labath     int status = -1;
235119cbe96aSPavel Labath     ::pid_t wait_pid = waitpid(-1, &status, __WALL | __WNOTHREAD | WNOHANG);
235219cbe96aSPavel Labath 
235319cbe96aSPavel Labath     if (wait_pid == 0)
235419cbe96aSPavel Labath       break; // We are done.
235519cbe96aSPavel Labath 
2356b9c1b51eSKate Stone     if (wait_pid == -1) {
235719cbe96aSPavel Labath       if (errno == EINTR)
235819cbe96aSPavel Labath         continue;
235919cbe96aSPavel Labath 
236019cbe96aSPavel Labath       Error error(errno, eErrorTypePOSIX);
2361a6321a8eSPavel Labath       LLDB_LOG(log, "waitpid (-1, &status, _) failed: {0}", error);
236219cbe96aSPavel Labath       break;
236319cbe96aSPavel Labath     }
236419cbe96aSPavel Labath 
236519cbe96aSPavel Labath     bool exited = false;
236619cbe96aSPavel Labath     int signal = 0;
236719cbe96aSPavel Labath     int exit_status = 0;
236819cbe96aSPavel Labath     const char *status_cstr = nullptr;
2369b9c1b51eSKate Stone     if (WIFSTOPPED(status)) {
237019cbe96aSPavel Labath       signal = WSTOPSIG(status);
237119cbe96aSPavel Labath       status_cstr = "STOPPED";
2372b9c1b51eSKate Stone     } else if (WIFEXITED(status)) {
237319cbe96aSPavel Labath       exit_status = WEXITSTATUS(status);
237419cbe96aSPavel Labath       status_cstr = "EXITED";
237519cbe96aSPavel Labath       exited = true;
2376b9c1b51eSKate Stone     } else if (WIFSIGNALED(status)) {
237719cbe96aSPavel Labath       signal = WTERMSIG(status);
237819cbe96aSPavel Labath       status_cstr = "SIGNALED";
237919cbe96aSPavel Labath       if (wait_pid == static_cast<::pid_t>(GetID())) {
238019cbe96aSPavel Labath         exited = true;
238119cbe96aSPavel Labath         exit_status = -1;
238219cbe96aSPavel Labath       }
2383b9c1b51eSKate Stone     } else
238419cbe96aSPavel Labath       status_cstr = "(\?\?\?)";
238519cbe96aSPavel Labath 
2386a6321a8eSPavel Labath     LLDB_LOG(log,
2387a6321a8eSPavel Labath              "waitpid (-1, &status, _) => pid = {0}, status = {1:x} "
2388a6321a8eSPavel Labath              "({2}), signal = {3}, exit_state = {4}",
2389a6321a8eSPavel Labath              wait_pid, status, status_cstr, signal, exit_status);
239019cbe96aSPavel Labath 
239119cbe96aSPavel Labath     MonitorCallback(wait_pid, exited, signal, exit_status);
239219cbe96aSPavel Labath   }
2393068f8a7eSTamas Berghammer }
2394068f8a7eSTamas Berghammer 
2395068f8a7eSTamas Berghammer // Wrapper for ptrace to catch errors and log calls.
2396b9c1b51eSKate Stone // Note that ptrace sets errno on error because -1 can be a valid result (i.e.
2397b9c1b51eSKate Stone // for PTRACE_PEEK*)
2398b9c1b51eSKate Stone Error NativeProcessLinux::PtraceWrapper(int req, lldb::pid_t pid, void *addr,
2399b9c1b51eSKate Stone                                         void *data, size_t data_size,
2400b9c1b51eSKate Stone                                         long *result) {
24014a9babb2SPavel Labath   Error error;
24024a9babb2SPavel Labath   long int ret;
2403068f8a7eSTamas Berghammer 
2404068f8a7eSTamas Berghammer   Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PTRACE));
2405068f8a7eSTamas Berghammer 
2406068f8a7eSTamas Berghammer   PtraceDisplayBytes(req, data, data_size);
2407068f8a7eSTamas Berghammer 
2408068f8a7eSTamas Berghammer   errno = 0;
2409068f8a7eSTamas Berghammer   if (req == PTRACE_GETREGSET || req == PTRACE_SETREGSET)
2410b9c1b51eSKate Stone     ret = ptrace(static_cast<__ptrace_request>(req), static_cast<::pid_t>(pid),
2411b9c1b51eSKate Stone                  *(unsigned int *)addr, data);
2412068f8a7eSTamas Berghammer   else
2413b9c1b51eSKate Stone     ret = ptrace(static_cast<__ptrace_request>(req), static_cast<::pid_t>(pid),
2414b9c1b51eSKate Stone                  addr, data);
2415068f8a7eSTamas Berghammer 
24164a9babb2SPavel Labath   if (ret == -1)
2417068f8a7eSTamas Berghammer     error.SetErrorToErrno();
2418068f8a7eSTamas Berghammer 
24194a9babb2SPavel Labath   if (result)
24204a9babb2SPavel Labath     *result = ret;
24214a9babb2SPavel Labath 
242228096200SPavel Labath   LLDB_LOG(log, "ptrace({0}, {1}, {2}, {3}, {4})={5:x}", req, pid, addr, data,
242328096200SPavel Labath            data_size, ret);
2424068f8a7eSTamas Berghammer 
2425068f8a7eSTamas Berghammer   PtraceDisplayBytes(req, data, data_size);
2426068f8a7eSTamas Berghammer 
2427a6321a8eSPavel Labath   if (error.Fail())
2428a6321a8eSPavel Labath     LLDB_LOG(log, "ptrace() failed: {0}", error);
2429068f8a7eSTamas Berghammer 
24304a9babb2SPavel Labath   return error;
2431068f8a7eSTamas Berghammer }
2432