[lldb][progress] Mitigate non-specific LLDB progress reports in Swift #8623
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
When LLDB reports progress on importing Swift modules, it was delivering non-specific progress reports with only the title of "Importing Swift modules" and no details. To report progress on activity within Swift, LLDB first creates a progress report then updates that progress report using a callback that LLDB sets and the Swift compiler invokes when performing a full import. When LLDB triggers Swift to import modules that were already imported before, Swift will not perform a full import. Since the progress report would've already been displayed, but the callback is never invoked, this leads to the non-specific messages that were being displayed when importing Swift modules. This commit sets a unique pointer to create a progress report from within the callback function instead of creating the report before setting the callback. It also clears the callback on scope exit instead of setting it to a new progress report.
chelcassanova
force-pushed
the
fix-unspecific-swift-progress-reports
branch
from
1e82295 to
84e7e51
Compare
|
@swift-ci please test |
adrian-prantl
approved these changes
Apr 23, 2024
|
Just updated this to update the test. |
|
@swift-ci please test |
|
@swift-ci please test windows |
Updates the test for Swift progress reporting by checking that the "Importing Swift modules" message only appears twice on its own as the rest of the reports for this category will have details attached.
chelcassanova
force-pushed
the
fix-unspecific-swift-progress-reports
branch
from
b614143 to
21e9d75
Compare
|
@swift-ci please test |
|
@swift-ci please test windows |
Comment on lines
+3780
to
+3785
| std::unique_ptr<Progress> progress; | ||
| ast->SetPreModuleImportCallback( | ||
| [&progress](llvm::StringRef module_name, | ||
| swift::ASTContext::ModuleImportKind kind) { | ||
| if (!progress) | ||
| progress = std::make_unique<Progress>("Importing Swift modules"); |
There was a problem hiding this comment.
Are these callbacks always called on the same thread?
There was a problem hiding this comment.
I'm actually unsure of this but I can check.
There was a problem hiding this comment.
I asked Adrian and he noted that while it's not guaranteed that the callbacks will be performed on the same thread, it is guaranteed that they will be called synchronously.
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.
When LLDB reports progress on importing Swift modules, it was delivering non-specific progress reports with only the title of "Importing Swift modules" and no details. To report progress on activity within Swift, LLDB first creates a progress report then updates that progress report using a callback that LLDB sets and the Swift compiler invokes when performing a full import.
When LLDB triggers Swift to import modules that were already imported before, Swift will not perform a full import. Since the progress report would've already been displayed, but the callback is never invoked, this leads to the non-specific messages that were being displayed when importing Swift modules.
This commit sets a unique pointer to create a progress report from within the callback function instead of creating the report before setting the callback. It also clears the callback on scope exit instead of setting it to a new progress report.
rdar://122050052
#8572