//===-- MainLoop.cpp --------------------------------------------*- C++ -*-===// // // The LLVM Compiler Infrastructure // // This file is distributed under the University of Illinois Open Source // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// #include "llvm/Config/llvm-config.h" #include "lldb/Host/MainLoop.h" #include "lldb/Utility/Error.h" #include #include #include #include #include #include #if HAVE_SYS_EVENT_H #include #elif defined(LLVM_ON_WIN32) #include #else #include #endif #ifdef LLVM_ON_WIN32 #define POLL WSAPoll #else #define POLL poll #endif #ifdef __ANDROID__ #define FORCE_PSELECT #endif #if SIGNAL_POLLING_UNSUPPORTED #ifdef LLVM_ON_WIN32 typedef int sigset_t; typedef int siginfo_t; #endif int ppoll(struct pollfd *fds, size_t nfds, const struct timespec *timeout_ts, const sigset_t *) { int timeout = (timeout_ts == nullptr) ? -1 : (timeout_ts->tv_sec * 1000 + timeout_ts->tv_nsec / 1000000); return POLL(fds, nfds, timeout); } #endif using namespace lldb; using namespace lldb_private; static sig_atomic_t g_signal_flags[NSIG]; static void SignalHandler(int signo, siginfo_t *info, void *) { assert(signo < NSIG); g_signal_flags[signo] = 1; } class MainLoop::RunImpl { public: // TODO: Use llvm::Expected static std::unique_ptr Create(MainLoop &loop, Error &error); ~RunImpl(); Error Poll(); template void ForEachReadFD(F &&f); template void ForEachSignal(F &&f); private: MainLoop &loop; #if HAVE_SYS_EVENT_H int queue_id; std::vector in_events; struct kevent out_events[4]; int num_events = -1; RunImpl(MainLoop &loop, int queue_id) : loop(loop), queue_id(queue_id) { in_events.reserve(loop.m_read_fds.size() + loop.m_signals.size()); } #else std::vector signals; #ifdef FORCE_PSELECT fd_set read_fd_set; #else std::vector read_fds; #endif RunImpl(MainLoop &loop) : loop(loop) { signals.reserve(loop.m_signals.size()); } sigset_t get_sigmask(); #endif }; #if HAVE_SYS_EVENT_H MainLoop::RunImpl::~RunImpl() { int r = close(queue_id); assert(r == 0); (void)r; } std::unique_ptr MainLoop::RunImpl::Create(MainLoop &loop, Error &error) { error.Clear(); int queue_id = kqueue(); if(queue_id < 0) { error = Error(errno, eErrorTypePOSIX); return nullptr; } return std::unique_ptr(new RunImpl(loop, queue_id)); } Error MainLoop::RunImpl::Poll() { in_events.resize(loop.m_read_fds.size() + loop.m_signals.size()); unsigned i = 0; for (auto &fd : loop.m_read_fds) EV_SET(&in_events[i++], fd.first, EVFILT_READ, EV_ADD, 0, 0, 0); for (const auto &sig : loop.m_signals) EV_SET(&in_events[i++], sig.first, EVFILT_SIGNAL, EV_ADD, 0, 0, 0); num_events = kevent(queue_id, in_events.data(), in_events.size(), out_events, llvm::array_lengthof(out_events), nullptr); if (num_events < 0) return Error("kevent() failed with error %d\n", num_events); return Error(); } template void MainLoop::RunImpl::ForEachReadFD(F &&f) { assert(num_events >= 0); for (int i = 0; i < num_events; ++i) { f(out_events[i].ident); if (loop.m_terminate_request) return; } } template void MainLoop::RunImpl::ForEachSignal(F && f) {} #else MainLoop::RunImpl::~RunImpl() {} std::unique_ptr MainLoop::RunImpl::Create(MainLoop &loop, Error &error) { error.Clear(); return std::unique_ptr(new RunImpl(loop)); } sigset_t MainLoop::RunImpl::get_sigmask() { #if SIGNAL_POLLING_UNSUPPORTED return 0; #else sigset_t sigmask; int ret = pthread_sigmask(SIG_SETMASK, nullptr, &sigmask); assert(ret == 0); (void) ret; for (const auto &sig : loop.m_signals) { signals.push_back(sig.first); sigdelset(&sigmask, sig.first); } return sigmask; #endif } #ifdef FORCE_PSELECT Error MainLoop::RunImpl::Poll() { signals.clear(); FD_ZERO(&read_fd_set); int nfds = 0; for (const auto &fd : loop.m_read_fds) { FD_SET(fd.first, &read_fd_set); nfds = std::max(nfds, fd.first + 1); } sigset_t sigmask = get_sigmask(); if (pselect(nfds, &read_fd_set, nullptr, nullptr, nullptr, &sigmask) == -1 && errno != EINTR) return Error(errno, eErrorTypePOSIX); return Error(); } template void MainLoop::RunImpl::ForEachReadFD(F &&f) { for (const auto &fd : loop.m_read_fds) { if(!FD_ISSET(fd.first, &read_fd_set)) continue; f(fd.first); if (loop.m_terminate_request) return; } } #else Error MainLoop::RunImpl::Poll() { signals.clear(); read_fds.clear(); sigset_t sigmask = get_sigmask(); for (const auto &fd : loop.m_read_fds) { struct pollfd pfd; pfd.fd = fd.first; pfd.events = POLLIN; pfd.revents = 0; read_fds.push_back(pfd); } if (ppoll(read_fds.data(), read_fds.size(), nullptr, &sigmask) == -1 && errno != EINTR) return Error(errno, eErrorTypePOSIX); return Error(); } template void MainLoop::RunImpl::ForEachReadFD(F &&f) { for (const auto &fd : read_fds) { if ((fd.revents & POLLIN) == 0) continue; f(fd.fd); if (loop.m_terminate_request) return; } } #endif template void MainLoop::RunImpl::ForEachSignal(F &&f) { for (int sig : signals) { if (g_signal_flags[sig] == 0) continue; // No signal g_signal_flags[sig] = 0; f(sig); if (loop.m_terminate_request) return; } } #endif MainLoop::~MainLoop() { assert(m_read_fds.size() == 0); assert(m_signals.size() == 0); } MainLoop::ReadHandleUP MainLoop::RegisterReadObject(const IOObjectSP &object_sp, const Callback &callback, Error &error) { #ifdef LLVM_ON_WIN32 if (object_sp->GetFdType() != IOObject:: eFDTypeSocket) { error.SetErrorString("MainLoop: non-socket types unsupported on Windows"); return nullptr; } #endif if (!object_sp || !object_sp->IsValid()) { error.SetErrorString("IO object is not valid."); return nullptr; } const bool inserted = m_read_fds.insert({object_sp->GetWaitableHandle(), callback}).second; if (!inserted) { error.SetErrorStringWithFormat("File descriptor %d already monitored.", object_sp->GetWaitableHandle()); return nullptr; } return CreateReadHandle(object_sp); } // We shall block the signal, then install the signal handler. The signal will // be unblocked in // the Run() function to check for signal delivery. MainLoop::SignalHandleUP MainLoop::RegisterSignal(int signo, const Callback &callback, Error &error) { #ifdef SIGNAL_POLLING_UNSUPPORTED error.SetErrorString("Signal polling is not supported on this platform."); return nullptr; #else if (m_signals.find(signo) != m_signals.end()) { error.SetErrorStringWithFormat("Signal %d already monitored.", signo); return nullptr; } SignalInfo info; info.callback = callback; struct sigaction new_action; new_action.sa_sigaction = &SignalHandler; new_action.sa_flags = SA_SIGINFO; sigemptyset(&new_action.sa_mask); sigaddset(&new_action.sa_mask, signo); sigset_t old_set; if (int ret = pthread_sigmask(SIG_BLOCK, &new_action.sa_mask, &old_set)) { error.SetErrorStringWithFormat("pthread_sigmask failed with error %d\n", ret); return nullptr; } info.was_blocked = sigismember(&old_set, signo); if (sigaction(signo, &new_action, &info.old_action) == -1) { error.SetErrorToErrno(); if (!info.was_blocked) pthread_sigmask(SIG_UNBLOCK, &new_action.sa_mask, nullptr); return nullptr; } m_signals.insert({signo, info}); g_signal_flags[signo] = 0; return SignalHandleUP(new SignalHandle(*this, signo)); #endif } void MainLoop::UnregisterReadObject(IOObject::WaitableHandle handle) { bool erased = m_read_fds.erase(handle); UNUSED_IF_ASSERT_DISABLED(erased); assert(erased); } void MainLoop::UnregisterSignal(int signo) { #if SIGNAL_POLLING_UNSUPPORTED Error("Signal polling is not supported on this platform."); #else // We undo the actions of RegisterSignal on a best-effort basis. auto it = m_signals.find(signo); assert(it != m_signals.end()); sigaction(signo, &it->second.old_action, nullptr); sigset_t set; sigemptyset(&set); sigaddset(&set, signo); pthread_sigmask(it->second.was_blocked ? SIG_BLOCK : SIG_UNBLOCK, &set, nullptr); m_signals.erase(it); #endif } Error MainLoop::Run() { m_terminate_request = false; Error error; auto impl = RunImpl::Create(*this, error); if (!impl) return error; // run until termination or until we run out of things to listen to while (!m_terminate_request && (!m_read_fds.empty() || !m_signals.empty())) { error = impl->Poll(); if (error.Fail()) return error; impl->ForEachSignal([&](int sig) { auto it = m_signals.find(sig); if (it != m_signals.end()) it->second.callback(*this); // Do the work }); if (m_terminate_request) return Error(); impl->ForEachReadFD([&](int fd) { auto it = m_read_fds.find(fd); if (it != m_read_fds.end()) it->second(*this); // Do the work }); if (m_terminate_request) return Error(); } return Error(); }