llvm-project/lldb/source/Host/common/MainLoopBase.cpp
Pavel Labath 55068dc3b7
[lldb] Add timed callbacks to the MainLoop class (#112895)
The motivating use case is being able to "time out" certain operations
(by adding a timed callback which will force the termination of the
loop), but the design is flexible enough to accomodate other use cases
as well (e.g. running a periodic task in the background).

The implementation builds on the existing "pending callback" mechanism,
by associating a time point with each callback -- every time the loop
wakes up, it runs all of the callbacks which are past their point, and
it also makes sure to sleep only until the next callback is scheduled to
run.

I've done some renaming as names like "TriggerPendingCallbacks" were no
longer accurate -- the function may no longer cause any callbacks to be
called (it may just cause the main loop thread to recalculate the time
it wants to sleep).
2024-11-19 08:37:51 +01:00

50 lines
1.5 KiB
C++

//===-- MainLoopBase.cpp --------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "lldb/Host/MainLoopBase.h"
#include <chrono>
using namespace lldb;
using namespace lldb_private;
void MainLoopBase::AddCallback(const Callback &callback, TimePoint point) {
bool interrupt_needed;
{
std::lock_guard<std::mutex> lock{m_callback_mutex};
// We need to interrupt the main thread if this callback is scheduled to
// execute at an earlier time than the earliest callback registered so far.
interrupt_needed = m_callbacks.empty() || point < m_callbacks.top().first;
m_callbacks.emplace(point, callback);
}
if (interrupt_needed)
Interrupt();
}
void MainLoopBase::ProcessCallbacks() {
while (true) {
Callback callback;
{
std::lock_guard<std::mutex> lock{m_callback_mutex};
if (m_callbacks.empty() ||
std::chrono::steady_clock::now() < m_callbacks.top().first)
return;
callback = std::move(m_callbacks.top().second);
m_callbacks.pop();
}
callback(*this);
}
}
std::optional<MainLoopBase::TimePoint> MainLoopBase::GetNextWakeupTime() {
std::lock_guard<std::mutex> lock(m_callback_mutex);
if (m_callbacks.empty())
return std::nullopt;
return m_callbacks.top().first;
}