[LLDB][LLDB-DAP] Wire up DAP to listen to external progress events #123826
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@llvm/pr-subscribers-lldb Author: Jacob Lalonde (Jlalond) ChangesRecently I added SBProgress (#119052), and during that original commit I tested if the progress event was sent over LLDB-DAP, and it was. However upon the suggestion of @JDevlieghere and @labath we added an external category (#120171), which I did not test. This small patch wires up DAP to listen for external events by default, and adds the external category to the SBDebugger enumeration. Full diff: https://github.com/llvm/llvm-project/pull/123826.diff 2 Files Affected:
diff --git a/lldb/include/lldb/API/SBDebugger.h b/lldb/include/lldb/API/SBDebugger.h
index eb371e33c4951c..7f56bf34c37388 100644
--- a/lldb/include/lldb/API/SBDebugger.h
+++ b/lldb/include/lldb/API/SBDebugger.h
@@ -46,8 +46,8 @@ class LLDB_API SBDebugger {
eBroadcastBitProgress = lldb::DebuggerBroadcastBit::eBroadcastBitProgress,
eBroadcastBitWarning = lldb::DebuggerBroadcastBit::eBroadcastBitWarning,
eBroadcastBitError = lldb::DebuggerBroadcastBit::eBroadcastBitError,
- eBroadcastBitProgressCategory =
- lldb::DebuggerBroadcastBit::eBroadcastBitProgressCategory,
+ eBroadcastBitExternalProgress =
+ lldb::DebuggerBroadcastBit::eBroadcastBitExternalProgress,
};
SBDebugger();
diff --git a/lldb/tools/lldb-dap/lldb-dap.cpp b/lldb/tools/lldb-dap/lldb-dap.cpp
index 7e8f7b5f6df679..6b12569d90a831 100644
--- a/lldb/tools/lldb-dap/lldb-dap.cpp
+++ b/lldb/tools/lldb-dap/lldb-dap.cpp
@@ -414,7 +414,8 @@ void SendStdOutStdErr(DAP &dap, lldb::SBProcess &process) {
void ProgressEventThreadFunction(DAP &dap) {
lldb::SBListener listener("lldb-dap.progress.listener");
dap.debugger.GetBroadcaster().AddListener(
- listener, lldb::SBDebugger::eBroadcastBitProgress);
+ listener, lldb::SBDebugger::eBroadcastBitProgress |
+ lldb::SBDebugger::eBroadcastBitExternalProgress);
dap.broadcaster.AddListener(listener, eBroadcastBitStopProgressThread);
lldb::SBEvent event;
bool done = false;
|
|
CC @youngdfb |
|
✅ With the latest revision this PR passed the C/C++ code formatter. |
Jlalond
force-pushed
the
external-progress-dap
branch
2 times, most recently
from
1e14270 to
ae32d8b
Compare
walter-erquinigo
approved these changes
Jan 21, 2025
jeffreytan81
requested changes
Jan 21, 2025
lldb/include/lldb/API/SBDebugger.h
Outdated
Comment on lines
49
to
54
| eBroadcastBitExternalProgressCategory = | ||
| lldb::DebuggerBroadcastBit::eBroadcastBitExternalProgressCategory, | ||
| eBroadcastBitExternalProgress = | ||
| lldb::DebuggerBroadcastBit::eBroadcastBitExternalProgress, | ||
| eBroadcastBitExternalProgressCategory = | ||
| lldb::DebuggerBroadcastBit::eBroadcastBitExternalProgressCategory, |
There was a problem hiding this comment.
There are two duplicated eBroadcastBitExternalProgressCategory. Remove one?
…ration in SBDebugger
Jlalond
force-pushed
the
external-progress-dap
branch
from
ae32d8b to
fac56f0
Compare
jeffreytan81
approved these changes
Jan 21, 2025
JDevlieghere
approved these changes
Jan 21, 2025
Jlalond
added a commit
that referenced
this pull request
Jan 22, 2025
When testing my SBProgress DAP PR (#123826), I noticed Progress update messages aren't sent over DAP. This patch adds the lldb progress event's message to the body when sent over DAP. Before  Now  Tested with my [progress tester command](https://gist.github.com/Jlalond/48d85e75a91f7a137e3142e6a13d0947), testing 10 events 5 seconds apart 1-10
JDevlieghere
pushed a commit
to swiftlang/llvm-project
that referenced
this pull request
Jan 27, 2025
When testing my SBProgress DAP PR (llvm#123826), I noticed Progress update messages aren't sent over DAP. This patch adds the lldb progress event's message to the body when sent over DAP. Before  Now  Tested with my [progress tester command](https://gist.github.com/Jlalond/48d85e75a91f7a137e3142e6a13d0947), testing 10 events 5 seconds apart 1-10 (cherry picked from commit a939a9f)
JDevlieghere
pushed a commit
to swiftlang/llvm-project
that referenced
this pull request
Jan 27, 2025
…lvm#123826) Recently I added SBProgress (llvm#119052), and during that original commit I tested if the progress event was sent over LLDB-DAP, and it was. However upon the suggestion of @JDevlieghere and @labath we added an external category (llvm#120171), which I did not test. This small patch wires up DAP to listen for external events by default, and adds the external category to the SBDebugger enumeration. (cherry picked from commit b9813ce)
JDevlieghere
pushed a commit
to swiftlang/llvm-project
that referenced
this pull request
Feb 25, 2025
…lvm#123826) Recently I added SBProgress (llvm#119052), and during that original commit I tested if the progress event was sent over LLDB-DAP, and it was. However upon the suggestion of @JDevlieghere and @labath we added an external category (llvm#120171), which I did not test. This small patch wires up DAP to listen for external events by default, and adds the external category to the SBDebugger enumeration. (cherry picked from commit b9813ce)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Recently I added SBProgress (#119052), and during that original commit I tested if the progress event was sent over LLDB-DAP, and it was. However upon the suggestion of @JDevlieghere and @labath we added an external category (#120171), which I did not test.
This small patch wires up DAP to listen for external events by default, and adds the external category to the SBDebugger enumeration.