156c290746
This implements coalescing of progress events using a timeout, as discussed in the RFC on Discourse [1]. This PR consists of two commits which, depending on the feedback, I may split up into two PRs. For now, I think it's easier to review this as a whole. 1. The first commit introduces a new generic `Alarm` class. The class lets you to schedule a function (callback) to be executed after a given timeout expires. You can cancel and reset a callback before its corresponding timeout expires. It achieves this with the help of a worker thread that sleeps until the next timeout expires. The only guarantee it provides is that your function is called no sooner than the requested timeout. Because the callback is called directly from the worker thread, a long running callback could potentially block the worker thread. I intentionally kept the implementation as simple as possible while addressing the needs for the `ProgressManager` use case. If we want to rely on this somewhere else, we can reassess whether we need to address those limitations. 2. The second commit uses the Alarm class to coalesce progress events. To recap the Discourse discussion, when multiple progress events with the same title execute in close succession, they get broadcast as one to `eBroadcastBitProgressCategory`. The `ProgressManager` keeps track of the in-flight progress events and when the refcount hits zero, the Alarm class is used to schedule broadcasting the event. If a new progress event comes in before the alarm fires, the alarm is reset (and the process repeats when the new progress event ends). If no new event comes in before the timeout expires, the progress event is broadcast. [1] https://discourse.llvm.org/t/rfc-improve-lldb-progress-reporting/75717/
107 lines
3.4 KiB
C++
107 lines
3.4 KiB
C++
//===-- SystemInitializerFull.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 "SystemInitializerFull.h"
|
|
#include "lldb/API/SBCommandInterpreter.h"
|
|
#include "lldb/Core/Debugger.h"
|
|
#include "lldb/Core/PluginManager.h"
|
|
#include "lldb/Core/Progress.h"
|
|
#include "lldb/Host/Config.h"
|
|
#include "lldb/Host/Host.h"
|
|
#include "lldb/Initialization/SystemInitializerCommon.h"
|
|
#include "lldb/Interpreter/CommandInterpreter.h"
|
|
#include "lldb/Target/ProcessTrace.h"
|
|
#include "lldb/Utility/Timer.h"
|
|
#include "llvm/Support/CommandLine.h"
|
|
#include "llvm/Support/TargetSelect.h"
|
|
|
|
#pragma clang diagnostic push
|
|
#pragma clang diagnostic ignored "-Wglobal-constructors"
|
|
#include "llvm/ExecutionEngine/MCJIT.h"
|
|
#pragma clang diagnostic pop
|
|
|
|
#include <string>
|
|
|
|
#define LLDB_PLUGIN(p) LLDB_PLUGIN_DECLARE(p)
|
|
#include "Plugins/Plugins.def"
|
|
|
|
#if LLDB_ENABLE_PYTHON
|
|
#include "Plugins/ScriptInterpreter/Python/ScriptInterpreterPython.h"
|
|
|
|
constexpr lldb_private::HostInfo::SharedLibraryDirectoryHelper
|
|
*g_shlib_dir_helper =
|
|
lldb_private::ScriptInterpreterPython::SharedLibraryDirectoryHelper;
|
|
|
|
#else
|
|
constexpr lldb_private::HostInfo::SharedLibraryDirectoryHelper
|
|
*g_shlib_dir_helper = nullptr;
|
|
#endif
|
|
|
|
using namespace lldb_private;
|
|
|
|
SystemInitializerFull::SystemInitializerFull()
|
|
: SystemInitializerCommon(g_shlib_dir_helper) {}
|
|
SystemInitializerFull::~SystemInitializerFull() = default;
|
|
|
|
llvm::Error SystemInitializerFull::Initialize() {
|
|
llvm::Error error = SystemInitializerCommon::Initialize();
|
|
if (error)
|
|
return error;
|
|
|
|
// Initialize LLVM and Clang
|
|
llvm::InitializeAllTargets();
|
|
llvm::InitializeAllAsmPrinters();
|
|
llvm::InitializeAllTargetMCs();
|
|
llvm::InitializeAllDisassemblers();
|
|
|
|
// Initialize the command line parser in LLVM. This usually isn't necessary
|
|
// as we aren't dealing with command line options here, but otherwise some
|
|
// other code in Clang/LLVM might be tempted to call this function from a
|
|
// different thread later on which won't work (as the function isn't
|
|
// thread-safe).
|
|
const char *arg0 = "lldb";
|
|
llvm::cl::ParseCommandLineOptions(1, &arg0);
|
|
|
|
// Initialize the progress manager.
|
|
ProgressManager::Initialize();
|
|
|
|
#define LLDB_PLUGIN(p) LLDB_PLUGIN_INITIALIZE(p);
|
|
#include "Plugins/Plugins.def"
|
|
|
|
// Scan for any system or user LLDB plug-ins.
|
|
PluginManager::Initialize();
|
|
|
|
// The process settings need to know about installed plug-ins, so the
|
|
// Settings must be initialized AFTER PluginManager::Initialize is called.
|
|
Debugger::SettingsInitialize();
|
|
|
|
// Use the Debugger's LLDBAssert callback.
|
|
SetLLDBAssertCallback(Debugger::AssertCallback);
|
|
|
|
return llvm::Error::success();
|
|
}
|
|
|
|
void SystemInitializerFull::Terminate() {
|
|
Debugger::SettingsTerminate();
|
|
|
|
// Terminate plug-ins in core LLDB.
|
|
ProcessTrace::Terminate();
|
|
|
|
// Terminate and unload and loaded system or user LLDB plug-ins.
|
|
PluginManager::Terminate();
|
|
|
|
#define LLDB_PLUGIN(p) LLDB_PLUGIN_TERMINATE(p);
|
|
#include "Plugins/Plugins.def"
|
|
|
|
// Terminate the progress manager.
|
|
ProgressManager::Terminate();
|
|
|
|
// Now shutdown the common parts, in reverse order.
|
|
SystemInitializerCommon::Terminate();
|
|
}
|