1 //===-- ProcessMonitor.cpp ------------------------------------ -*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
16 #include <sys/ptrace.h>
17 #include <sys/socket.h>
18 #include <sys/types.h>
23 // Other libraries and framework includes
24 #include "lldb/Core/RegisterValue.h"
25 #include "lldb/Core/Scalar.h"
26 #include "lldb/Host/Host.h"
27 #include "lldb/Host/PseudoTerminal.h"
28 #include "lldb/Host/ThreadLauncher.h"
29 #include "lldb/Target/RegisterContext.h"
30 #include "lldb/Target/Thread.h"
31 #include "lldb/Target/UnixSignals.h"
32 #include "lldb/Utility/Status.h"
33 #include "llvm/Support/Errno.h"
35 #include "FreeBSDThread.h"
36 #include "Plugins/Process/POSIX/CrashReason.h"
37 #include "Plugins/Process/POSIX/ProcessPOSIXLog.h"
38 #include "ProcessFreeBSD.h"
39 #include "ProcessMonitor.h"
42 extern char **environ;
46 using namespace lldb_private;
48 // We disable the tracing of ptrace calls for integration builds to
49 // avoid the additional indirection and checks.
50 #ifndef LLDB_CONFIGURATION_BUILDANDINTEGRATION
51 // Wrapper for ptrace to catch errors and log calls.
53 const char *Get_PT_IO_OP(int op) {
68 // Wrapper for ptrace to catch errors and log calls.
69 // Note that ptrace sets errno on error because -1 is reserved as a valid
71 extern long PtraceWrapper(int req, lldb::pid_t pid, void *addr, int data,
72 const char *reqName, const char *file, int line) {
75 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PTRACE));
78 log->Printf("ptrace(%s, %" PRIu64 ", %p, %x) called from file %s line %d",
79 reqName, pid, addr, data, file, line);
81 struct ptrace_io_desc *pi = (struct ptrace_io_desc *)addr;
83 log->Printf("PT_IO: op=%s offs=%zx size=%zu", Get_PT_IO_OP(pi->piod_op),
84 (size_t)pi->piod_offs, pi->piod_len);
88 // PtraceDisplayBytes(req, data);
91 result = ptrace(req, pid, (caddr_t)addr, data);
93 // PtraceDisplayBytes(req, data);
95 if (log && errno != 0) {
113 log->Printf("ptrace() failed; errno=%d (%s)", errno, str);
118 if (req == PT_GETREGS) {
119 struct reg *r = (struct reg *)addr;
121 log->Printf("PT_GETREGS: rip=0x%lx rsp=0x%lx rbp=0x%lx rax=0x%lx",
122 r->r_rip, r->r_rsp, r->r_rbp, r->r_rax);
124 if (req == PT_GETDBREGS || req == PT_SETDBREGS) {
125 struct dbreg *r = (struct dbreg *)addr;
126 char setget = (req == PT_GETDBREGS) ? 'G' : 'S';
128 for (int i = 0; i <= 7; i++)
129 log->Printf("PT_%cETDBREGS: dr[%d]=0x%lx", setget, i, r->dr[i]);
137 // Wrapper for ptrace when logging is not required.
138 // Sets errno to 0 prior to calling ptrace.
139 extern long PtraceWrapper(int req, lldb::pid_t pid, void *addr, int data) {
142 result = ptrace(req, pid, (caddr_t)addr, data);
146 #define PTRACE(req, pid, addr, data) \
147 PtraceWrapper((req), (pid), (addr), (data), #req, __FILE__, __LINE__)
149 PtraceWrapper((req), (pid), (addr), (data))
152 //------------------------------------------------------------------------------
153 // Static implementations of ProcessMonitor::ReadMemory and
154 // ProcessMonitor::WriteMemory. This enables mutual recursion between these
155 // functions without needed to go thru the thread funnel.
157 static size_t DoReadMemory(lldb::pid_t pid, lldb::addr_t vm_addr, void *buf,
158 size_t size, Status &error) {
159 struct ptrace_io_desc pi_desc;
161 pi_desc.piod_op = PIOD_READ_D;
162 pi_desc.piod_offs = (void *)vm_addr;
163 pi_desc.piod_addr = buf;
164 pi_desc.piod_len = size;
166 if (PTRACE(PT_IO, pid, (caddr_t)&pi_desc, 0) < 0) {
167 error.SetErrorToErrno();
170 return pi_desc.piod_len;
173 static size_t DoWriteMemory(lldb::pid_t pid, lldb::addr_t vm_addr,
174 const void *buf, size_t size, Status &error) {
175 struct ptrace_io_desc pi_desc;
177 pi_desc.piod_op = PIOD_WRITE_D;
178 pi_desc.piod_offs = (void *)vm_addr;
179 pi_desc.piod_addr = (void *)buf;
180 pi_desc.piod_len = size;
182 if (PTRACE(PT_IO, pid, (caddr_t)&pi_desc, 0) < 0)
183 error.SetErrorToErrno();
184 return pi_desc.piod_len;
187 // Simple helper function to ensure flags are enabled on the given file
189 static bool EnsureFDFlags(int fd, int flags, Status &error) {
192 if ((status = fcntl(fd, F_GETFL)) == -1) {
193 error.SetErrorToErrno();
197 if (fcntl(fd, F_SETFL, status | flags) == -1) {
198 error.SetErrorToErrno();
205 //------------------------------------------------------------------------------
207 /// @brief Represents a ProcessMonitor operation.
209 /// Under FreeBSD, it is not possible to ptrace() from any other thread but the
210 /// one that spawned or attached to the process from the start. Therefore, when
211 /// a ProcessMonitor is asked to deliver or change the state of an inferior
212 /// process the operation must be "funneled" to a specific thread to perform the
213 /// task. The Operation class provides an abstract base for all services the
214 /// ProcessMonitor must perform via the single virtual function Execute, thus
215 /// encapsulating the code that needs to run in the privileged context.
218 virtual ~Operation() {}
219 virtual void Execute(ProcessMonitor *monitor) = 0;
222 //------------------------------------------------------------------------------
223 /// @class ReadOperation
224 /// @brief Implements ProcessMonitor::ReadMemory.
225 class ReadOperation : public Operation {
227 ReadOperation(lldb::addr_t addr, void *buff, size_t size, Status &error,
229 : m_addr(addr), m_buff(buff), m_size(size), m_error(error),
232 void Execute(ProcessMonitor *monitor);
242 void ReadOperation::Execute(ProcessMonitor *monitor) {
243 lldb::pid_t pid = monitor->GetPID();
245 m_result = DoReadMemory(pid, m_addr, m_buff, m_size, m_error);
248 //------------------------------------------------------------------------------
249 /// @class WriteOperation
250 /// @brief Implements ProcessMonitor::WriteMemory.
251 class WriteOperation : public Operation {
253 WriteOperation(lldb::addr_t addr, const void *buff, size_t size,
254 Status &error, size_t &result)
255 : m_addr(addr), m_buff(buff), m_size(size), m_error(error),
258 void Execute(ProcessMonitor *monitor);
268 void WriteOperation::Execute(ProcessMonitor *monitor) {
269 lldb::pid_t pid = monitor->GetPID();
271 m_result = DoWriteMemory(pid, m_addr, m_buff, m_size, m_error);
274 //------------------------------------------------------------------------------
275 /// @class ReadRegOperation
276 /// @brief Implements ProcessMonitor::ReadRegisterValue.
277 class ReadRegOperation : public Operation {
279 ReadRegOperation(lldb::tid_t tid, unsigned offset, unsigned size,
280 RegisterValue &value, bool &result)
281 : m_tid(tid), m_offset(offset), m_size(size), m_value(value),
284 void Execute(ProcessMonitor *monitor);
290 RegisterValue &m_value;
294 void ReadRegOperation::Execute(ProcessMonitor *monitor) {
298 if ((rc = PTRACE(PT_GETREGS, m_tid, (caddr_t)®s, 0)) < 0) {
301 // 'struct reg' contains only 32- or 64-bit register values. Punt on
302 // others. Also, not all entries may be uintptr_t sized, such as 32-bit
303 // processes on powerpc64 (probably the same for i386 on amd64)
304 if (m_size == sizeof(uint32_t))
305 m_value = *(uint32_t *)(((caddr_t)®s) + m_offset);
306 else if (m_size == sizeof(uint64_t))
307 m_value = *(uint64_t *)(((caddr_t)®s) + m_offset);
309 memcpy((void *)&m_value, (((caddr_t)®s) + m_offset), m_size);
314 //------------------------------------------------------------------------------
315 /// @class WriteRegOperation
316 /// @brief Implements ProcessMonitor::WriteRegisterValue.
317 class WriteRegOperation : public Operation {
319 WriteRegOperation(lldb::tid_t tid, unsigned offset,
320 const RegisterValue &value, bool &result)
321 : m_tid(tid), m_offset(offset), m_value(value), m_result(result) {}
323 void Execute(ProcessMonitor *monitor);
328 const RegisterValue &m_value;
332 void WriteRegOperation::Execute(ProcessMonitor *monitor) {
335 if (PTRACE(PT_GETREGS, m_tid, (caddr_t)®s, 0) < 0) {
339 *(uintptr_t *)(((caddr_t)®s) + m_offset) =
340 (uintptr_t)m_value.GetAsUInt64();
341 if (PTRACE(PT_SETREGS, m_tid, (caddr_t)®s, 0) < 0)
347 //------------------------------------------------------------------------------
348 /// @class ReadDebugRegOperation
349 /// @brief Implements ProcessMonitor::ReadDebugRegisterValue.
350 class ReadDebugRegOperation : public Operation {
352 ReadDebugRegOperation(lldb::tid_t tid, unsigned offset, unsigned size,
353 RegisterValue &value, bool &result)
354 : m_tid(tid), m_offset(offset), m_size(size), m_value(value),
357 void Execute(ProcessMonitor *monitor);
363 RegisterValue &m_value;
367 void ReadDebugRegOperation::Execute(ProcessMonitor *monitor) {
371 if ((rc = PTRACE(PT_GETDBREGS, m_tid, (caddr_t)®s, 0)) < 0) {
374 if (m_size == sizeof(uintptr_t))
375 m_value = *(uintptr_t *)(((caddr_t)®s) + m_offset);
377 memcpy((void *)&m_value, (((caddr_t)®s) + m_offset), m_size);
382 //------------------------------------------------------------------------------
383 /// @class WriteDebugRegOperation
384 /// @brief Implements ProcessMonitor::WriteDebugRegisterValue.
385 class WriteDebugRegOperation : public Operation {
387 WriteDebugRegOperation(lldb::tid_t tid, unsigned offset,
388 const RegisterValue &value, bool &result)
389 : m_tid(tid), m_offset(offset), m_value(value), m_result(result) {}
391 void Execute(ProcessMonitor *monitor);
396 const RegisterValue &m_value;
400 void WriteDebugRegOperation::Execute(ProcessMonitor *monitor) {
403 if (PTRACE(PT_GETDBREGS, m_tid, (caddr_t)®s, 0) < 0) {
407 *(uintptr_t *)(((caddr_t)®s) + m_offset) =
408 (uintptr_t)m_value.GetAsUInt64();
409 if (PTRACE(PT_SETDBREGS, m_tid, (caddr_t)®s, 0) < 0)
415 //------------------------------------------------------------------------------
416 /// @class ReadGPROperation
417 /// @brief Implements ProcessMonitor::ReadGPR.
418 class ReadGPROperation : public Operation {
420 ReadGPROperation(lldb::tid_t tid, void *buf, bool &result)
421 : m_tid(tid), m_buf(buf), m_result(result) {}
423 void Execute(ProcessMonitor *monitor);
431 void ReadGPROperation::Execute(ProcessMonitor *monitor) {
435 rc = PTRACE(PT_GETREGS, m_tid, (caddr_t)m_buf, 0);
442 //------------------------------------------------------------------------------
443 /// @class ReadFPROperation
444 /// @brief Implements ProcessMonitor::ReadFPR.
445 class ReadFPROperation : public Operation {
447 ReadFPROperation(lldb::tid_t tid, void *buf, bool &result)
448 : m_tid(tid), m_buf(buf), m_result(result) {}
450 void Execute(ProcessMonitor *monitor);
458 void ReadFPROperation::Execute(ProcessMonitor *monitor) {
459 if (PTRACE(PT_GETFPREGS, m_tid, (caddr_t)m_buf, 0) < 0)
465 //------------------------------------------------------------------------------
466 /// @class WriteGPROperation
467 /// @brief Implements ProcessMonitor::WriteGPR.
468 class WriteGPROperation : public Operation {
470 WriteGPROperation(lldb::tid_t tid, void *buf, bool &result)
471 : m_tid(tid), m_buf(buf), m_result(result) {}
473 void Execute(ProcessMonitor *monitor);
481 void WriteGPROperation::Execute(ProcessMonitor *monitor) {
482 if (PTRACE(PT_SETREGS, m_tid, (caddr_t)m_buf, 0) < 0)
488 //------------------------------------------------------------------------------
489 /// @class WriteFPROperation
490 /// @brief Implements ProcessMonitor::WriteFPR.
491 class WriteFPROperation : public Operation {
493 WriteFPROperation(lldb::tid_t tid, void *buf, bool &result)
494 : m_tid(tid), m_buf(buf), m_result(result) {}
496 void Execute(ProcessMonitor *monitor);
504 void WriteFPROperation::Execute(ProcessMonitor *monitor) {
505 if (PTRACE(PT_SETFPREGS, m_tid, (caddr_t)m_buf, 0) < 0)
511 //------------------------------------------------------------------------------
512 /// @class ResumeOperation
513 /// @brief Implements ProcessMonitor::Resume.
514 class ResumeOperation : public Operation {
516 ResumeOperation(uint32_t signo, bool &result)
517 : m_signo(signo), m_result(result) {}
519 void Execute(ProcessMonitor *monitor);
526 void ResumeOperation::Execute(ProcessMonitor *monitor) {
527 lldb::pid_t pid = monitor->GetPID();
530 if (m_signo != LLDB_INVALID_SIGNAL_NUMBER)
533 if (PTRACE(PT_CONTINUE, pid, (caddr_t)1, data)) {
534 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
535 LLDB_LOG(log, "ResumeOperation ({0}) failed: {1}", pid,
536 llvm::sys::StrError(errno));
542 //------------------------------------------------------------------------------
543 /// @class SingleStepOperation
544 /// @brief Implements ProcessMonitor::SingleStep.
545 class SingleStepOperation : public Operation {
547 SingleStepOperation(uint32_t signo, bool &result)
548 : m_signo(signo), m_result(result) {}
550 void Execute(ProcessMonitor *monitor);
557 void SingleStepOperation::Execute(ProcessMonitor *monitor) {
558 lldb::pid_t pid = monitor->GetPID();
561 if (m_signo != LLDB_INVALID_SIGNAL_NUMBER)
564 if (PTRACE(PT_STEP, pid, NULL, data))
570 //------------------------------------------------------------------------------
571 /// @class LwpInfoOperation
572 /// @brief Implements ProcessMonitor::GetLwpInfo.
573 class LwpInfoOperation : public Operation {
575 LwpInfoOperation(lldb::tid_t tid, void *info, bool &result, int &ptrace_err)
576 : m_tid(tid), m_info(info), m_result(result), m_err(ptrace_err) {}
578 void Execute(ProcessMonitor *monitor);
587 void LwpInfoOperation::Execute(ProcessMonitor *monitor) {
588 struct ptrace_lwpinfo plwp;
590 if (PTRACE(PT_LWPINFO, m_tid, (caddr_t)&plwp, sizeof(plwp))) {
594 memcpy(m_info, &plwp, sizeof(plwp));
599 //------------------------------------------------------------------------------
600 /// @class ThreadSuspendOperation
601 /// @brief Implements ProcessMonitor::ThreadSuspend.
602 class ThreadSuspendOperation : public Operation {
604 ThreadSuspendOperation(lldb::tid_t tid, bool suspend, bool &result)
605 : m_tid(tid), m_suspend(suspend), m_result(result) {}
607 void Execute(ProcessMonitor *monitor);
615 void ThreadSuspendOperation::Execute(ProcessMonitor *monitor) {
616 m_result = !PTRACE(m_suspend ? PT_SUSPEND : PT_RESUME, m_tid, NULL, 0);
619 //------------------------------------------------------------------------------
620 /// @class EventMessageOperation
621 /// @brief Implements ProcessMonitor::GetEventMessage.
622 class EventMessageOperation : public Operation {
624 EventMessageOperation(lldb::tid_t tid, unsigned long *message, bool &result)
625 : m_tid(tid), m_message(message), m_result(result) {}
627 void Execute(ProcessMonitor *monitor);
631 unsigned long *m_message;
635 void EventMessageOperation::Execute(ProcessMonitor *monitor) {
636 struct ptrace_lwpinfo plwp;
638 if (PTRACE(PT_LWPINFO, m_tid, (caddr_t)&plwp, sizeof(plwp)))
641 if (plwp.pl_flags & PL_FLAG_FORKED) {
642 *m_message = plwp.pl_child_pid;
649 //------------------------------------------------------------------------------
650 /// @class KillOperation
651 /// @brief Implements ProcessMonitor::Kill.
652 class KillOperation : public Operation {
654 KillOperation(bool &result) : m_result(result) {}
656 void Execute(ProcessMonitor *monitor);
662 void KillOperation::Execute(ProcessMonitor *monitor) {
663 lldb::pid_t pid = monitor->GetPID();
665 if (PTRACE(PT_KILL, pid, NULL, 0))
671 //------------------------------------------------------------------------------
672 /// @class DetachOperation
673 /// @brief Implements ProcessMonitor::Detach.
674 class DetachOperation : public Operation {
676 DetachOperation(Status &result) : m_error(result) {}
678 void Execute(ProcessMonitor *monitor);
684 void DetachOperation::Execute(ProcessMonitor *monitor) {
685 lldb::pid_t pid = monitor->GetPID();
687 if (PTRACE(PT_DETACH, pid, NULL, 0) < 0)
688 m_error.SetErrorToErrno();
691 ProcessMonitor::OperationArgs::OperationArgs(ProcessMonitor *monitor)
692 : m_monitor(monitor) {
693 sem_init(&m_semaphore, 0, 0);
696 ProcessMonitor::OperationArgs::~OperationArgs() { sem_destroy(&m_semaphore); }
698 ProcessMonitor::LaunchArgs::LaunchArgs(ProcessMonitor *monitor,
699 lldb_private::Module *module,
700 char const **argv, char const **envp,
701 const FileSpec &stdin_file_spec,
702 const FileSpec &stdout_file_spec,
703 const FileSpec &stderr_file_spec,
704 const FileSpec &working_dir)
705 : OperationArgs(monitor), m_module(module), m_argv(argv), m_envp(envp),
706 m_stdin_file_spec(stdin_file_spec), m_stdout_file_spec(stdout_file_spec),
707 m_stderr_file_spec(stderr_file_spec), m_working_dir(working_dir) {}
709 ProcessMonitor::LaunchArgs::~LaunchArgs() {}
711 ProcessMonitor::AttachArgs::AttachArgs(ProcessMonitor *monitor, lldb::pid_t pid)
712 : OperationArgs(monitor), m_pid(pid) {}
714 ProcessMonitor::AttachArgs::~AttachArgs() {}
716 //------------------------------------------------------------------------------
717 /// The basic design of the ProcessMonitor is built around two threads.
719 /// One thread (@see SignalThread) simply blocks on a call to waitpid() looking
720 /// for changes in the debugee state. When a change is detected a
721 /// ProcessMessage is sent to the associated ProcessFreeBSD instance. This
723 /// "drives" state changes in the debugger.
725 /// The second thread (@see OperationThread) is responsible for two things 1)
726 /// launching or attaching to the inferior process, and then 2) servicing
727 /// operations such as register reads/writes, stepping, etc. See the comments
728 /// on the Operation class for more info as to why this is needed.
729 ProcessMonitor::ProcessMonitor(
730 ProcessFreeBSD *process, Module *module, const char *argv[],
731 const char *envp[], const FileSpec &stdin_file_spec,
732 const FileSpec &stdout_file_spec, const FileSpec &stderr_file_spec,
733 const FileSpec &working_dir,
734 const lldb_private::ProcessLaunchInfo & /* launch_info */,
735 lldb_private::Status &error)
736 : m_process(static_cast<ProcessFreeBSD *>(process)),
737 m_pid(LLDB_INVALID_PROCESS_ID), m_terminal_fd(-1), m_operation(0) {
738 using namespace std::placeholders;
740 std::unique_ptr<LaunchArgs> args(
741 new LaunchArgs(this, module, argv, envp, stdin_file_spec,
742 stdout_file_spec, stderr_file_spec, working_dir));
744 sem_init(&m_operation_pending, 0, 0);
745 sem_init(&m_operation_done, 0, 0);
747 StartLaunchOpThread(args.get(), error);
748 if (!error.Success())
751 if (llvm::sys::RetryAfterSignal(-1, sem_wait, &args->m_semaphore) == -1) {
752 error.SetErrorToErrno();
756 // Check that the launch was a success.
757 if (!args->m_error.Success()) {
759 error = args->m_error;
763 // Finally, start monitoring the child process for change in state.
764 m_monitor_thread = Host::StartMonitoringChildProcess(
765 std::bind(&ProcessMonitor::MonitorCallback, this, _1, _2, _3, _4),
767 if (!m_monitor_thread.IsJoinable()) {
768 error.SetErrorToGenericError();
769 error.SetErrorString("Process launch failed.");
774 ProcessMonitor::ProcessMonitor(ProcessFreeBSD *process, lldb::pid_t pid,
775 lldb_private::Status &error)
776 : m_process(static_cast<ProcessFreeBSD *>(process)), m_pid(pid),
777 m_terminal_fd(-1), m_operation(0) {
778 using namespace std::placeholders;
780 sem_init(&m_operation_pending, 0, 0);
781 sem_init(&m_operation_done, 0, 0);
783 std::unique_ptr<AttachArgs> args(new AttachArgs(this, pid));
785 StartAttachOpThread(args.get(), error);
786 if (!error.Success())
789 if (llvm::sys::RetryAfterSignal(-1, sem_wait, &args->m_semaphore) == -1) {
790 error.SetErrorToErrno();
794 // Check that the attach was a success.
795 if (!args->m_error.Success()) {
797 error = args->m_error;
801 // Finally, start monitoring the child process for change in state.
802 m_monitor_thread = Host::StartMonitoringChildProcess(
803 std::bind(&ProcessMonitor::MonitorCallback, this, _1, _2, _3, _4),
805 if (!m_monitor_thread.IsJoinable()) {
806 error.SetErrorToGenericError();
807 error.SetErrorString("Process attach failed.");
812 ProcessMonitor::~ProcessMonitor() { StopMonitor(); }
814 //------------------------------------------------------------------------------
815 // Thread setup and tear down.
816 void ProcessMonitor::StartLaunchOpThread(LaunchArgs *args, Status &error) {
817 static const char *g_thread_name = "lldb.process.freebsd.operation";
819 if (m_operation_thread.IsJoinable())
823 ThreadLauncher::LaunchThread(g_thread_name, LaunchOpThread, args, &error);
826 void *ProcessMonitor::LaunchOpThread(void *arg) {
827 LaunchArgs *args = static_cast<LaunchArgs *>(arg);
830 sem_post(&args->m_semaphore);
834 ServeOperation(args);
838 bool ProcessMonitor::Launch(LaunchArgs *args) {
839 ProcessMonitor *monitor = args->m_monitor;
840 ProcessFreeBSD &process = monitor->GetProcess();
841 const char **argv = args->m_argv;
842 const char **envp = args->m_envp;
843 const FileSpec &stdin_file_spec = args->m_stdin_file_spec;
844 const FileSpec &stdout_file_spec = args->m_stdout_file_spec;
845 const FileSpec &stderr_file_spec = args->m_stderr_file_spec;
846 const FileSpec &working_dir = args->m_working_dir;
848 PseudoTerminal terminal;
849 const size_t err_len = 1024;
850 char err_str[err_len];
853 // Propagate the environment if one is not supplied.
854 if (envp == NULL || envp[0] == NULL)
855 envp = const_cast<const char **>(environ);
857 if ((pid = terminal.Fork(err_str, err_len)) == -1) {
858 args->m_error.SetErrorToGenericError();
859 args->m_error.SetErrorString("Process fork failed.");
863 // Recognized child exit status codes.
876 // Trace this process.
877 if (PTRACE(PT_TRACE_ME, 0, NULL, 0) < 0)
880 // terminal has already dupped the tty descriptors to stdin/out/err.
881 // This closes original fd from which they were copied (and avoids
882 // leaking descriptors to the debugged process.
883 terminal.CloseSlaveFileDescriptor();
885 // Do not inherit setgid powers.
886 if (setgid(getgid()) != 0)
889 // Let us have our own process group.
892 // Dup file descriptors if needed.
894 // FIXME: If two or more of the paths are the same we needlessly open
895 // the same file multiple times.
897 if (!DupDescriptor(stdin_file_spec, STDIN_FILENO, O_RDONLY))
898 exit(eDupStdinFailed);
900 if (stdout_file_spec)
901 if (!DupDescriptor(stdout_file_spec, STDOUT_FILENO, O_WRONLY | O_CREAT))
902 exit(eDupStdoutFailed);
904 if (stderr_file_spec)
905 if (!DupDescriptor(stderr_file_spec, STDERR_FILENO, O_WRONLY | O_CREAT))
906 exit(eDupStderrFailed);
908 // Change working directory
909 if (working_dir && 0 != ::chdir(working_dir.GetCString()))
912 // Execute. We should never return.
913 execve(argv[0], const_cast<char *const *>(argv),
914 const_cast<char *const *>(envp));
918 // Wait for the child process to to trap on its call to execve.
921 if ((wpid = waitpid(pid, &status, 0)) < 0) {
922 args->m_error.SetErrorToErrno();
924 } else if (WIFEXITED(status)) {
925 // open, dup or execve likely failed for some reason.
926 args->m_error.SetErrorToGenericError();
927 switch (WEXITSTATUS(status)) {
929 args->m_error.SetErrorString("Child ptrace failed.");
931 case eDupStdinFailed:
932 args->m_error.SetErrorString("Child open stdin failed.");
934 case eDupStdoutFailed:
935 args->m_error.SetErrorString("Child open stdout failed.");
937 case eDupStderrFailed:
938 args->m_error.SetErrorString("Child open stderr failed.");
941 args->m_error.SetErrorString("Child failed to set working directory.");
944 args->m_error.SetErrorString("Child exec failed.");
947 args->m_error.SetErrorString("Child setgid failed.");
950 args->m_error.SetErrorString("Child returned unknown exit status.");
955 assert(WIFSTOPPED(status) && wpid == (::pid_t)pid &&
956 "Could not sync with inferior process.");
959 // Have the child raise an event on exit. This is used to keep the child in
960 // limbo until it is destroyed.
961 if (PTRACE(PTRACE_SETOPTIONS, pid, NULL, PTRACE_O_TRACEEXIT) < 0) {
962 args->m_error.SetErrorToErrno();
966 // Release the master terminal descriptor and pass it off to the
967 // ProcessMonitor instance. Similarly stash the inferior pid.
968 monitor->m_terminal_fd = terminal.ReleaseMasterFileDescriptor();
969 monitor->m_pid = pid;
971 // Set the terminal fd to be in non blocking mode (it simplifies the
972 // implementation of ProcessFreeBSD::GetSTDOUT to have a non-blocking
973 // descriptor to read from).
974 if (!EnsureFDFlags(monitor->m_terminal_fd, O_NONBLOCK, args->m_error))
977 process.SendMessage(ProcessMessage::Attach(pid));
980 return args->m_error.Success();
983 void ProcessMonitor::StartAttachOpThread(AttachArgs *args,
984 lldb_private::Status &error) {
985 static const char *g_thread_name = "lldb.process.freebsd.operation";
987 if (m_operation_thread.IsJoinable())
991 ThreadLauncher::LaunchThread(g_thread_name, AttachOpThread, args, &error);
994 void *ProcessMonitor::AttachOpThread(void *arg) {
995 AttachArgs *args = static_cast<AttachArgs *>(arg);
999 ServeOperation(args);
1003 void ProcessMonitor::Attach(AttachArgs *args) {
1004 lldb::pid_t pid = args->m_pid;
1006 ProcessMonitor *monitor = args->m_monitor;
1007 ProcessFreeBSD &process = monitor->GetProcess();
1010 args->m_error.SetErrorToGenericError();
1011 args->m_error.SetErrorString("Attaching to process 1 is not allowed.");
1015 // Attach to the requested process.
1016 if (PTRACE(PT_ATTACH, pid, NULL, 0) < 0) {
1017 args->m_error.SetErrorToErrno();
1022 if ((status = waitpid(pid, NULL, 0)) < 0) {
1023 args->m_error.SetErrorToErrno();
1027 process.SendMessage(ProcessMessage::Attach(pid));
1031 ProcessMonitor::GetCurrentThreadIDs(std::vector<lldb::tid_t> &thread_ids) {
1037 tdcnt = PTRACE(PT_GETNUMLWPS, m_pid, NULL, 0);
1040 tids = (lwpid_t *)malloc(tdcnt * sizeof(*tids));
1043 if (PTRACE(PT_GETLWPLIST, m_pid, (void *)tids, tdcnt) < 0) {
1047 thread_ids = std::vector<lldb::tid_t>(tids, tids + tdcnt);
1049 return thread_ids.size();
1052 bool ProcessMonitor::MonitorCallback(ProcessMonitor *monitor, lldb::pid_t pid,
1053 bool exited, int signal, int status) {
1054 ProcessMessage message;
1055 ProcessFreeBSD *process = monitor->m_process;
1057 bool stop_monitoring;
1058 struct ptrace_lwpinfo plwp;
1061 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
1065 log->Printf("ProcessMonitor::%s() got exit signal, tid = %" PRIu64,
1067 message = ProcessMessage::Exit(pid, status);
1068 process->SendMessage(message);
1069 return pid == process->GetID();
1072 if (!monitor->GetLwpInfo(pid, &plwp, ptrace_err))
1073 stop_monitoring = true; // pid is gone. Bail.
1075 switch (plwp.pl_siginfo.si_signo) {
1077 message = MonitorSIGTRAP(monitor, &plwp.pl_siginfo, plwp.pl_lwpid);
1081 message = MonitorSignal(monitor, &plwp.pl_siginfo, plwp.pl_lwpid);
1085 process->SendMessage(message);
1086 stop_monitoring = message.GetKind() == ProcessMessage::eExitMessage;
1089 return stop_monitoring;
1092 ProcessMessage ProcessMonitor::MonitorSIGTRAP(ProcessMonitor *monitor,
1093 const siginfo_t *info,
1095 ProcessMessage message;
1097 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
1100 assert(info && info->si_signo == SIGTRAP && "Unexpected child signal!");
1102 switch (info->si_code) {
1104 assert(false && "Unexpected SIGTRAP code!");
1107 case (SIGTRAP /* | (PTRACE_EVENT_EXIT << 8) */): {
1108 // The inferior process is about to exit. Maintain the process in a
1109 // state of "limbo" until we are explicitly commanded to detach,
1110 // destroy, resume, etc.
1111 unsigned long data = 0;
1112 if (!monitor->GetEventMessage(tid, &data))
1115 log->Printf("ProcessMonitor::%s() received exit? event, data = %lx, tid "
1117 __FUNCTION__, data, tid);
1118 message = ProcessMessage::Limbo(tid, (data >> 8));
1125 // Map TRAP_CAP to a trace trap in the absense of a more specific handler.
1129 log->Printf("ProcessMonitor::%s() received trace event, tid = %" PRIu64
1131 __FUNCTION__, tid, info->si_code);
1132 message = ProcessMessage::Trace(tid);
1137 if (monitor->m_process->IsSoftwareStepBreakpoint(tid)) {
1139 log->Printf("ProcessMonitor::%s() received sw single step breakpoint "
1140 "event, tid = %" PRIu64,
1142 message = ProcessMessage::Trace(tid);
1146 "ProcessMonitor::%s() received breakpoint event, tid = %" PRIu64,
1148 message = ProcessMessage::Break(tid);
1156 ProcessMessage ProcessMonitor::MonitorSignal(ProcessMonitor *monitor,
1157 const siginfo_t *info,
1159 ProcessMessage message;
1160 int signo = info->si_signo;
1162 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
1164 // POSIX says that process behaviour is undefined after it ignores a SIGFPE,
1165 // SIGILL, SIGSEGV, or SIGBUS *unless* that signal was generated by a
1166 // kill(2) or raise(3). Similarly for tgkill(2) on FreeBSD.
1168 // IOW, user generated signals never generate what we consider to be a
1171 // Similarly, ACK signals generated by this monitor.
1172 if (info->si_code == SI_USER) {
1175 "ProcessMonitor::%s() received signal %s with code %s, pid = %d",
1177 monitor->m_process->GetUnixSignals()->GetSignalAsCString(signo),
1178 "SI_USER", info->si_pid);
1179 if (info->si_pid == getpid())
1180 return ProcessMessage::SignalDelivered(tid, signo);
1182 return ProcessMessage::Signal(tid, signo);
1187 "ProcessMonitor::%s() received signal %s", __FUNCTION__,
1188 monitor->m_process->GetUnixSignals()->GetSignalAsCString(signo));
1195 lldb::addr_t fault_addr = reinterpret_cast<lldb::addr_t>(info->si_addr);
1196 const auto reason = GetCrashReason(*info);
1197 if (reason != CrashReason::eInvalidCrashReason) {
1198 return ProcessMessage::Crash(tid, reason, signo, fault_addr);
1199 } // else; Use atleast si_signo info for other si_code
1202 // Everything else is "normal" and does not require any special action on
1204 return ProcessMessage::Signal(tid, signo);
1207 void ProcessMonitor::ServeOperation(OperationArgs *args) {
1208 ProcessMonitor *monitor = args->m_monitor;
1210 // We are finised with the arguments and are ready to go. Sync with the
1211 // parent thread and start serving operations on the inferior.
1212 sem_post(&args->m_semaphore);
1215 // wait for next pending operation
1216 sem_wait(&monitor->m_operation_pending);
1218 monitor->m_operation->Execute(monitor);
1220 // notify calling thread that operation is complete
1221 sem_post(&monitor->m_operation_done);
1225 void ProcessMonitor::DoOperation(Operation *op) {
1226 std::lock_guard<std::mutex> guard(m_operation_mutex);
1230 // notify operation thread that an operation is ready to be processed
1231 sem_post(&m_operation_pending);
1233 // wait for operation to complete
1234 sem_wait(&m_operation_done);
1237 size_t ProcessMonitor::ReadMemory(lldb::addr_t vm_addr, void *buf, size_t size,
1240 ReadOperation op(vm_addr, buf, size, error, result);
1245 size_t ProcessMonitor::WriteMemory(lldb::addr_t vm_addr, const void *buf,
1246 size_t size, lldb_private::Status &error) {
1248 WriteOperation op(vm_addr, buf, size, error, result);
1253 bool ProcessMonitor::ReadRegisterValue(lldb::tid_t tid, unsigned offset,
1254 const char *reg_name, unsigned size,
1255 RegisterValue &value) {
1257 ReadRegOperation op(tid, offset, size, value, result);
1262 bool ProcessMonitor::WriteRegisterValue(lldb::tid_t tid, unsigned offset,
1263 const char *reg_name,
1264 const RegisterValue &value) {
1266 WriteRegOperation op(tid, offset, value, result);
1271 bool ProcessMonitor::ReadDebugRegisterValue(
1272 lldb::tid_t tid, unsigned offset, const char *reg_name, unsigned size,
1273 lldb_private::RegisterValue &value) {
1275 ReadDebugRegOperation op(tid, offset, size, value, result);
1280 bool ProcessMonitor::WriteDebugRegisterValue(
1281 lldb::tid_t tid, unsigned offset, const char *reg_name,
1282 const lldb_private::RegisterValue &value) {
1284 WriteDebugRegOperation op(tid, offset, value, result);
1289 bool ProcessMonitor::ReadGPR(lldb::tid_t tid, void *buf, size_t buf_size) {
1291 ReadGPROperation op(tid, buf, result);
1296 bool ProcessMonitor::ReadFPR(lldb::tid_t tid, void *buf, size_t buf_size) {
1298 ReadFPROperation op(tid, buf, result);
1303 bool ProcessMonitor::ReadRegisterSet(lldb::tid_t tid, void *buf,
1304 size_t buf_size, unsigned int regset) {
1308 bool ProcessMonitor::WriteGPR(lldb::tid_t tid, void *buf, size_t buf_size) {
1310 WriteGPROperation op(tid, buf, result);
1315 bool ProcessMonitor::WriteFPR(lldb::tid_t tid, void *buf, size_t buf_size) {
1317 WriteFPROperation op(tid, buf, result);
1322 bool ProcessMonitor::WriteRegisterSet(lldb::tid_t tid, void *buf,
1323 size_t buf_size, unsigned int regset) {
1327 bool ProcessMonitor::ReadThreadPointer(lldb::tid_t tid, lldb::addr_t &value) {
1331 bool ProcessMonitor::Resume(lldb::tid_t unused, uint32_t signo) {
1333 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
1336 const char *signame =
1337 m_process->GetUnixSignals()->GetSignalAsCString(signo);
1338 if (signame == nullptr)
1340 log->Printf("ProcessMonitor::%s() resuming pid %" PRIu64 " with signal %s",
1341 __FUNCTION__, GetPID(), signame);
1343 ResumeOperation op(signo, result);
1346 log->Printf("ProcessMonitor::%s() resuming result = %s", __FUNCTION__,
1347 result ? "true" : "false");
1351 bool ProcessMonitor::SingleStep(lldb::tid_t unused, uint32_t signo) {
1353 SingleStepOperation op(signo, result);
1358 bool ProcessMonitor::Kill() {
1360 KillOperation op(result);
1365 bool ProcessMonitor::GetLwpInfo(lldb::tid_t tid, void *lwpinfo,
1368 LwpInfoOperation op(tid, lwpinfo, result, ptrace_err);
1373 bool ProcessMonitor::ThreadSuspend(lldb::tid_t tid, bool suspend) {
1375 ThreadSuspendOperation op(tid, suspend, result);
1380 bool ProcessMonitor::GetEventMessage(lldb::tid_t tid, unsigned long *message) {
1382 EventMessageOperation op(tid, message, result);
1387 lldb_private::Status ProcessMonitor::Detach(lldb::tid_t tid) {
1388 lldb_private::Status error;
1389 if (tid != LLDB_INVALID_THREAD_ID) {
1390 DetachOperation op(error);
1396 bool ProcessMonitor::DupDescriptor(const FileSpec &file_spec, int fd,
1398 int target_fd = open(file_spec.GetCString(), flags, 0666);
1400 if (target_fd == -1)
1403 if (dup2(target_fd, fd) == -1)
1406 return (close(target_fd) == -1) ? false : true;
1409 void ProcessMonitor::StopMonitoringChildProcess() {
1410 if (m_monitor_thread.IsJoinable()) {
1411 m_monitor_thread.Cancel();
1412 m_monitor_thread.Join(nullptr);
1413 m_monitor_thread.Reset();
1417 void ProcessMonitor::StopMonitor() {
1418 StopMonitoringChildProcess();
1420 sem_destroy(&m_operation_pending);
1421 sem_destroy(&m_operation_done);
1422 if (m_terminal_fd >= 0) {
1423 close(m_terminal_fd);
1428 // FIXME: On Linux, when a new thread is created, we receive to notifications,
1429 // (1) a SIGTRAP|PTRACE_EVENT_CLONE from the main process thread with the
1430 // child thread id as additional information, and (2) a SIGSTOP|SI_USER from
1431 // the new child thread indicating that it has is stopped because we attached.
1432 // We have no guarantee of the order in which these arrive, but we need both
1433 // before we are ready to proceed. We currently keep a list of threads which
1434 // have sent the initial SIGSTOP|SI_USER event. Then when we receive the
1435 // SIGTRAP|PTRACE_EVENT_CLONE notification, if the initial stop has not occurred
1436 // we call ProcessMonitor::WaitForInitialTIDStop() to wait for it.
1438 // Right now, the above logic is in ProcessPOSIX, so we need a definition of
1439 // this function in the FreeBSD ProcessMonitor implementation even if it isn't
1440 // logically needed.
1442 // We really should figure out what actually happens on FreeBSD and move the
1443 // Linux-specific logic out of ProcessPOSIX as needed.
1445 bool ProcessMonitor::WaitForInitialTIDStop(lldb::tid_t tid) { return true; }
1447 void ProcessMonitor::StopOpThread() {
1448 if (!m_operation_thread.IsJoinable())
1451 m_operation_thread.Cancel();
1452 m_operation_thread.Join(nullptr);
1453 m_operation_thread.Reset();