Skip to content

[LLDB][SBProgress] Fix bad optional in sbprogress #128971

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
Feb 27, 2025
Merged

[LLDB][SBProgress] Fix bad optional in sbprogress #128971

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ac90ec7
Fix bad optional access in sbprogress
Jlalond Feb 26, 2025
4f1aaa6
Expand test case based on Dave's feedback
Jlalond Feb 27, 2025
6e9ce7e
Further asserts based on Greg's feedback
Jlalond Feb 27, 2025
eea877a
Move the optional
Jlalond Feb 27, 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
5 changes: 4 additions & 1 deletion lldb/source/API/SBProgress.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,10 @@ SBProgress::~SBProgress() = default;
void SBProgress::Increment(uint64_t amount, const char *description) {
LLDB_INSTRUMENT_VA(amount, description);

m_opaque_up->Increment(amount, description);
std::optional<std::string> description_opt;
if (description && description[0])
Copy link
Contributor

@dmpots dmpots Feb 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So this only calls increment if there is a non-null and non-empty description. Is that the correct behavior? Or should we still be calling increment with a nullopt in that case?

Copy link
Contributor Author

@Jlalond Jlalond Feb 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No we only set the value of the description optional if non-null, non-empty description. So Increment(1, NULL/None in Python) will bump the count by one but send no message.

Copy link
Contributor

@dmpots dmpots Feb 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yeah, I read that wrong. Thanks for confirming.

description_opt = description;
m_opaque_up->Increment(amount, description_opt);
}

lldb_private::Progress &SBProgress::ref() const { return *m_opaque_up; }
12 changes: 12 additions & 0 deletions lldb/test/API/python_api/sbprogress/TestSBProgress.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,15 @@ def test_without_external_bit_set(self):
expected_string = "Test progress first increment"
progress.Increment(1, expected_string)
self.assertFalse(listener.PeekAtNextEvent(event))

def test_with_external_bit_set(self):
"""Test SBProgress can handle null events."""

progress = lldb.SBProgress("Test SBProgress", "Test progress", self.dbg)
listener = lldb.SBListener("Test listener")
broadcaster = self.dbg.GetBroadcaster()
broadcaster.AddListener(listener, lldb.eBroadcastBitExternalProgress)
event = lldb.SBEvent()

progress.Increment(1, None)
Copy link
Contributor

@dmpots dmpots Feb 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would progress.Increment(1, "") map to the case where description[0] == '\0'? If so seems like a cheap test to add.

Copy link
Contributor Author

@Jlalond Jlalond Feb 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good callout, I expanded the test case.

self.assertTrue(listener.PeekAtNextEvent(event))