Skip to content

[lldb] Provide TrackingOutputBufferDeleter for custom unique_ptr deleter #142815

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
Jun 5, 2025
Merged

[lldb] Provide TrackingOutputBufferDeleter for custom unique_ptr deleter #142815

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
14a5860
[lldb] Provide TrackingOutputBufferDeleter for custom unique_ptr deleter
rupprecht Jun 4, 2025
498de8f
Add docs
rupprecht Jun 4, 2025
118b4f2
Move class to test
rupprecht Jun 4, 2025
ca2d2d5
Move the corresponding include too
rupprecht Jun 4, 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
20 changes: 20 additions & 0 deletions lldb/include/lldb/Core/DemangledNameInfo.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
#include "llvm/Demangle/Utility.h"

#include <cstddef>
#include <cstdlib>
#include <utility>

namespace lldb_private {
Expand Down Expand Up @@ -159,4 +160,23 @@ struct TrackingOutputBuffer : public llvm::itanium_demangle::OutputBuffer {
};
} // namespace lldb_private

/// Custom deleter to use with unique_ptr.
///
/// Usage:
/// \code{.cpp}
///
/// auto OB =
/// std::unique_ptr<TrackingOutputBuffer, TrackingOutputBufferDeleter>(
/// new TrackingOutputBuffer());
///
/// \endcode
struct TrackingOutputBufferDeleter {
Copy link
Member

Choose a reason for hiding this comment

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

Can we just put it into the test file for now? And put it back into the header once we actually need it elsewhere?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Definitely

void operator()(TrackingOutputBuffer *TOB) {
if (!TOB)
return;
std::free(TOB->getBuffer());
delete TOB;
}
};

#endif // LLDB_CORE_DEMANGLEDNAMEINFO_H
72 changes: 36 additions & 36 deletions lldb/unittests/Core/MangledTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@

#include "gtest/gtest.h"

#include <memory>

using namespace lldb;
using namespace lldb_private;

Expand Down Expand Up @@ -589,25 +591,25 @@ TEST_P(DemanglingPartsTestFixture, DemanglingParts) {

ASSERT_NE(nullptr, Root);

TrackingOutputBuffer OB;
Root->print(OB);
auto demangled = std::string_view(OB);
auto OB = std::unique_ptr<TrackingOutputBuffer, TrackingOutputBufferDeleter>(
new TrackingOutputBuffer());
Root->print(*OB);
auto demangled = std::string_view(*OB);

ASSERT_EQ(OB.NameInfo.hasBasename(), valid_basename);
ASSERT_EQ(OB->NameInfo.hasBasename(), valid_basename);

EXPECT_EQ(OB.NameInfo.BasenameRange, info.BasenameRange);
EXPECT_EQ(OB.NameInfo.ScopeRange, info.ScopeRange);
EXPECT_EQ(OB.NameInfo.ArgumentsRange, info.ArgumentsRange);
EXPECT_EQ(OB.NameInfo.QualifiersRange, info.QualifiersRange);
EXPECT_EQ(OB->NameInfo.BasenameRange, info.BasenameRange);
EXPECT_EQ(OB->NameInfo.ScopeRange, info.ScopeRange);
EXPECT_EQ(OB->NameInfo.ArgumentsRange, info.ArgumentsRange);
EXPECT_EQ(OB->NameInfo.QualifiersRange, info.QualifiersRange);

auto get_part = [&](const std::pair<size_t, size_t> &loc) {
return demangled.substr(loc.first, loc.second - loc.first);
};

EXPECT_EQ(get_part(OB.NameInfo.BasenameRange), basename);
EXPECT_EQ(get_part(OB.NameInfo.ScopeRange), scope);
EXPECT_EQ(get_part(OB.NameInfo.QualifiersRange), qualifiers);
std::free(OB.getBuffer());
EXPECT_EQ(get_part(OB->NameInfo.BasenameRange), basename);
EXPECT_EQ(get_part(OB->NameInfo.ScopeRange), scope);
EXPECT_EQ(get_part(OB->NameInfo.QualifiersRange), qualifiers);
}

INSTANTIATE_TEST_SUITE_P(DemanglingPartsTests, DemanglingPartsTestFixture,
Expand Down Expand Up @@ -635,44 +637,42 @@ TEST_P(DemanglingInfoCorrectnessTestFixutre, Correctness) {

ASSERT_NE(nullptr, Root);

TrackingOutputBuffer OB;
Root->print(OB);
auto OB = std::unique_ptr<TrackingOutputBuffer, TrackingOutputBufferDeleter>(
new TrackingOutputBuffer());
Root->print(*OB);

// Filter out cases which would never show up in frames. We only care about
// function names.
if (Root->getKind() !=
llvm::itanium_demangle::Node::Kind::KFunctionEncoding &&
Root->getKind() != llvm::itanium_demangle::Node::Kind::KDotSuffix) {
std::free(OB.getBuffer());
Root->getKind() != llvm::itanium_demangle::Node::Kind::KDotSuffix)
return;
}

ASSERT_TRUE(OB.NameInfo.hasBasename());

auto tracked_name = llvm::StringRef(OB);

auto return_left = tracked_name.slice(0, OB.NameInfo.ScopeRange.first);
auto scope = tracked_name.slice(OB.NameInfo.ScopeRange.first,
OB.NameInfo.ScopeRange.second);
auto basename = tracked_name.slice(OB.NameInfo.BasenameRange.first,
OB.NameInfo.BasenameRange.second);
auto template_args = tracked_name.slice(OB.NameInfo.BasenameRange.second,
OB.NameInfo.ArgumentsRange.first);
auto args = tracked_name.slice(OB.NameInfo.ArgumentsRange.first,
OB.NameInfo.ArgumentsRange.second);
auto return_right = tracked_name.slice(OB.NameInfo.ArgumentsRange.second,
OB.NameInfo.QualifiersRange.first);
auto qualifiers = tracked_name.slice(OB.NameInfo.QualifiersRange.first,
OB.NameInfo.QualifiersRange.second);
auto suffix = tracked_name.slice(OB.NameInfo.QualifiersRange.second,
ASSERT_TRUE(OB->NameInfo.hasBasename());

auto tracked_name = llvm::StringRef(*OB);

auto return_left = tracked_name.slice(0, OB->NameInfo.ScopeRange.first);
auto scope = tracked_name.slice(OB->NameInfo.ScopeRange.first,
OB->NameInfo.ScopeRange.second);
auto basename = tracked_name.slice(OB->NameInfo.BasenameRange.first,
OB->NameInfo.BasenameRange.second);
auto template_args = tracked_name.slice(OB->NameInfo.BasenameRange.second,
OB->NameInfo.ArgumentsRange.first);
auto args = tracked_name.slice(OB->NameInfo.ArgumentsRange.first,
OB->NameInfo.ArgumentsRange.second);
auto return_right = tracked_name.slice(OB->NameInfo.ArgumentsRange.second,
OB->NameInfo.QualifiersRange.first);
auto qualifiers = tracked_name.slice(OB->NameInfo.QualifiersRange.first,
OB->NameInfo.QualifiersRange.second);
auto suffix = tracked_name.slice(OB->NameInfo.QualifiersRange.second,
llvm::StringRef::npos);

auto reconstructed_name =
llvm::join_items("", return_left, scope, basename, template_args, args,
return_right, qualifiers, suffix);

EXPECT_EQ(reconstructed_name, demangled);
std::free(OB.getBuffer());
}

INSTANTIATE_TEST_SUITE_P(
Expand Down
Loading