Skip to content

[lldb] Emit a progress event from the source manager #165802

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 31, 2025
Merged

[lldb] Emit a progress event from the source manager #165802

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bf237ee
[lldb] Emit a progress event from the source manager
JDevlieghere Oct 30, 2025
3ed096e
Merge branch 'main' into source-manager-progress
JDevlieghere Oct 31, 2025
7058a8c
Fix typo, capture by value
JDevlieghere Oct 31, 2025
af24247
Merge branch 'main' into source-manager-progress
JDevlieghere Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions lldb/include/lldb/Core/SourceManager.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,8 @@ class SourceManager {
private:
void CommonInitializer(lldb::SupportFileSP support_file_sp,
lldb::TargetSP target_sp);
void CommonInitializerImpl(lldb::SupportFileSP support_file_sp,
lldb::TargetSP target_sp);
};

typedef std::shared_ptr<File> FileSP;
Expand Down
26 changes: 24 additions & 2 deletions lldb/source/Core/SourceManager.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@

#include "llvm/ADT/Twine.h"

#include <future>
#include <memory>
#include <optional>
#include <utility>
Expand All @@ -54,8 +55,7 @@ using namespace lldb_private;
static inline bool is_newline_char(char ch) { return ch == '\n' || ch == '\r'; }

static void resolve_tilde(FileSpec &file_spec) {
if (!FileSystem::Instance().Exists(file_spec) &&
file_spec.GetDirectory() &&
if (!FileSystem::Instance().Exists(file_spec) && file_spec.GetDirectory() &&
file_spec.GetDirectory().GetCString()[0] == '~') {
FileSystem::Instance().Resolve(file_spec);
}
Expand Down Expand Up @@ -477,6 +477,28 @@ SourceManager::File::File(SupportFileSP support_file_sp, TargetSP target_sp)

void SourceManager::File::CommonInitializer(SupportFileSP support_file_sp,
TargetSP target_sp) {
// It might take a while to read a source file, for example because it's
// coming from a virtual file system that's fetching the data on demand. When
// reading the data exceeds a certain threshold, show a progress event to let
// the user know what's going on.
static constexpr auto g_progress_delay = std::chrono::milliseconds(500);

std::future<void> future = std::async(std::launch::async, [&]() {
CommonInitializer(support_file_sp, target_sp);
});

std::optional<Progress> progress;
if (future.wait_for(g_progress_delay) == std::future_status::timeout) {
Debugger *debugger = target_sp ? &target_sp->GetDebugger() : nullptr;
progress.emplace("Loading source file",
support_file_sp->GetSpecOnly().GetFilename().GetString(),
1, debugger);
}
future.wait();
}

void SourceManager::File::CommonInitializerImpl(SupportFileSP support_file_sp,
TargetSP target_sp) {
// Set the file and update the modification time.
SetSupportFile(support_file_sp);

Expand Down
Loading