[Metadata] Return the valid DebugLoc if one of them is null with -pick-merged-source-locations. #138148
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
…k-merged-source-locations. Previously when getMergedLocation was passed nullptr as one of the parameters we returned nullptr. Change that behaviour to instead return a valid DebugLoc. This is beneficial for binaries from which SamplePGO profiles are obtained.
This stack of pull requests is managed by Graphite. Learn more about stacking. |
|
@llvm/pr-subscribers-debuginfo Author: Snehasish Kumar (snehasish) ChangesPreviously when getMergedLocation was passed nullptr as one of the Full diff: https://github.com/llvm/llvm-project/pull/138148.diff 2 Files Affected:
diff --git a/llvm/lib/IR/DebugInfoMetadata.cpp b/llvm/lib/IR/DebugInfoMetadata.cpp
index 4f1b9e836120e..e0cc95ac0ca79 100644
--- a/llvm/lib/IR/DebugInfoMetadata.cpp
+++ b/llvm/lib/IR/DebugInfoMetadata.cpp
@@ -33,13 +33,13 @@ namespace llvm {
cl::opt<bool> EnableFSDiscriminator(
"enable-fs-discriminator", cl::Hidden,
cl::desc("Enable adding flow sensitive discriminators"));
-} // namespace llvm
// When true, preserves line and column number by picking one of the merged
// location info in a deterministic manner to assist sample based PGO.
-static cl::opt<bool> PickMergedSourceLocations(
+cl::opt<bool> PickMergedSourceLocations(
"pick-merged-source-locations", cl::init(false), cl::Hidden,
cl::desc("Preserve line and column number when merging locations."));
+} // namespace llvm
uint32_t DIType::getAlignInBits() const {
return (getTag() == dwarf::DW_TAG_LLVM_ptrauth_type ? 0 : SubclassData32);
@@ -218,17 +218,18 @@ struct ScopeLocationsMatcher {
};
DILocation *DILocation::getMergedLocation(DILocation *LocA, DILocation *LocB) {
- if (!LocA || !LocB)
- return nullptr;
-
if (LocA == LocB)
return LocA;
// For some use cases (SamplePGO), it is important to retain distinct source
// locations. When this flag is set, we choose arbitrarily between A and B,
// rather than computing a merged location using line 0, which is typically
- // not useful for PGO.
+ // not useful for PGO. If one of them is null, then try to return one which is
+ // valid.
if (PickMergedSourceLocations) {
+ if (!LocA || !LocB)
+ return LocA ? LocA : LocB;
+
auto A = std::make_tuple(LocA->getLine(), LocA->getColumn(),
LocA->getDiscriminator(), LocA->getFilename(),
LocA->getDirectory());
@@ -238,6 +239,9 @@ DILocation *DILocation::getMergedLocation(DILocation *LocA, DILocation *LocB) {
return A < B ? LocA : LocB;
}
+ if (!LocA || !LocB)
+ return nullptr;
+
LLVMContext &C = LocA->getContext();
using LocVec = SmallVector<const DILocation *>;
diff --git a/llvm/unittests/IR/MetadataTest.cpp b/llvm/unittests/IR/MetadataTest.cpp
index e710f7845df5e..e0d96aab5bfa3 100644
--- a/llvm/unittests/IR/MetadataTest.cpp
+++ b/llvm/unittests/IR/MetadataTest.cpp
@@ -25,6 +25,10 @@
#include <optional>
using namespace llvm;
+namespace llvm {
+ extern cl::opt<bool> PickMergedSourceLocations;
+} // namespace llvm
+
namespace {
TEST(ContextAndReplaceableUsesTest, FromContext) {
@@ -1444,6 +1448,25 @@ TEST_F(DILocationTest, Merge) {
auto *M2 = DILocation::getMergedLocation(A2, B);
EXPECT_EQ(M1, M2);
}
+
+ {
+ // If PickMergedSourceLocation is enabled, when one source location is null
+ // we should return the valid location.
+ PickMergedSourceLocations = true;
+ auto *A = DILocation::get(Context, 2, 7, N);
+ auto *M1 = DILocation::getMergedLocation(A, nullptr);
+ ASSERT_NE(nullptr, M1);
+ EXPECT_EQ(2u, M1->getLine());
+ EXPECT_EQ(7u, M1->getColumn());
+ EXPECT_EQ(N, M1->getScope());
+
+ auto *M2 = DILocation::getMergedLocation(nullptr, A);
+ ASSERT_NE(nullptr, M2);
+ EXPECT_EQ(2u, M2->getLine());
+ EXPECT_EQ(7u, M2->getColumn());
+ EXPECT_EQ(N, M2->getScope());
+ PickMergedSourceLocations = false;
+ }
}
TEST_F(DILocationTest, getDistinct) {
|
|
@llvm/pr-subscribers-llvm-ir Author: Snehasish Kumar (snehasish) ChangesPreviously when getMergedLocation was passed nullptr as one of the Full diff: https://github.com/llvm/llvm-project/pull/138148.diff 2 Files Affected:
diff --git a/llvm/lib/IR/DebugInfoMetadata.cpp b/llvm/lib/IR/DebugInfoMetadata.cpp
index 4f1b9e836120e..e0cc95ac0ca79 100644
--- a/llvm/lib/IR/DebugInfoMetadata.cpp
+++ b/llvm/lib/IR/DebugInfoMetadata.cpp
@@ -33,13 +33,13 @@ namespace llvm {
cl::opt<bool> EnableFSDiscriminator(
"enable-fs-discriminator", cl::Hidden,
cl::desc("Enable adding flow sensitive discriminators"));
-} // namespace llvm
// When true, preserves line and column number by picking one of the merged
// location info in a deterministic manner to assist sample based PGO.
-static cl::opt<bool> PickMergedSourceLocations(
+cl::opt<bool> PickMergedSourceLocations(
"pick-merged-source-locations", cl::init(false), cl::Hidden,
cl::desc("Preserve line and column number when merging locations."));
+} // namespace llvm
uint32_t DIType::getAlignInBits() const {
return (getTag() == dwarf::DW_TAG_LLVM_ptrauth_type ? 0 : SubclassData32);
@@ -218,17 +218,18 @@ struct ScopeLocationsMatcher {
};
DILocation *DILocation::getMergedLocation(DILocation *LocA, DILocation *LocB) {
- if (!LocA || !LocB)
- return nullptr;
-
if (LocA == LocB)
return LocA;
// For some use cases (SamplePGO), it is important to retain distinct source
// locations. When this flag is set, we choose arbitrarily between A and B,
// rather than computing a merged location using line 0, which is typically
- // not useful for PGO.
+ // not useful for PGO. If one of them is null, then try to return one which is
+ // valid.
if (PickMergedSourceLocations) {
+ if (!LocA || !LocB)
+ return LocA ? LocA : LocB;
+
auto A = std::make_tuple(LocA->getLine(), LocA->getColumn(),
LocA->getDiscriminator(), LocA->getFilename(),
LocA->getDirectory());
@@ -238,6 +239,9 @@ DILocation *DILocation::getMergedLocation(DILocation *LocA, DILocation *LocB) {
return A < B ? LocA : LocB;
}
+ if (!LocA || !LocB)
+ return nullptr;
+
LLVMContext &C = LocA->getContext();
using LocVec = SmallVector<const DILocation *>;
diff --git a/llvm/unittests/IR/MetadataTest.cpp b/llvm/unittests/IR/MetadataTest.cpp
index e710f7845df5e..e0d96aab5bfa3 100644
--- a/llvm/unittests/IR/MetadataTest.cpp
+++ b/llvm/unittests/IR/MetadataTest.cpp
@@ -25,6 +25,10 @@
#include <optional>
using namespace llvm;
+namespace llvm {
+ extern cl::opt<bool> PickMergedSourceLocations;
+} // namespace llvm
+
namespace {
TEST(ContextAndReplaceableUsesTest, FromContext) {
@@ -1444,6 +1448,25 @@ TEST_F(DILocationTest, Merge) {
auto *M2 = DILocation::getMergedLocation(A2, B);
EXPECT_EQ(M1, M2);
}
+
+ {
+ // If PickMergedSourceLocation is enabled, when one source location is null
+ // we should return the valid location.
+ PickMergedSourceLocations = true;
+ auto *A = DILocation::get(Context, 2, 7, N);
+ auto *M1 = DILocation::getMergedLocation(A, nullptr);
+ ASSERT_NE(nullptr, M1);
+ EXPECT_EQ(2u, M1->getLine());
+ EXPECT_EQ(7u, M1->getColumn());
+ EXPECT_EQ(N, M1->getScope());
+
+ auto *M2 = DILocation::getMergedLocation(nullptr, A);
+ ASSERT_NE(nullptr, M2);
+ EXPECT_EQ(2u, M2->getLine());
+ EXPECT_EQ(7u, M2->getColumn());
+ EXPECT_EQ(N, M2->getScope());
+ PickMergedSourceLocations = false;
+ }
}
TEST_F(DILocationTest, getDistinct) {
|
|
✅ With the latest revision this PR passed the C/C++ code formatter. |
rnk
approved these changes
May 1, 2025
jmorse
approved these changes
May 2, 2025
Merge activity
|
IanWood1
pushed a commit
to IanWood1/llvm-project
that referenced
this pull request
May 6, 2025
…k-merged-source-locations. (llvm#138148) Previously when getMergedLocation was passed nullptr as one of the parameters we returned nullptr. Change that behaviour to instead return a valid DebugLoc. This is beneficial for binaries from which SamplePGO profiles are obtained.
IanWood1
pushed a commit
to IanWood1/llvm-project
that referenced
this pull request
May 6, 2025
…k-merged-source-locations. (llvm#138148) Previously when getMergedLocation was passed nullptr as one of the parameters we returned nullptr. Change that behaviour to instead return a valid DebugLoc. This is beneficial for binaries from which SamplePGO profiles are obtained.
IanWood1
pushed a commit
to IanWood1/llvm-project
that referenced
this pull request
May 6, 2025
…k-merged-source-locations. (llvm#138148) Previously when getMergedLocation was passed nullptr as one of the parameters we returned nullptr. Change that behaviour to instead return a valid DebugLoc. This is beneficial for binaries from which SamplePGO profiles are obtained.
GeorgeARM
pushed a commit
to GeorgeARM/llvm-project
that referenced
this pull request
May 7, 2025
…k-merged-source-locations. (llvm#138148) Previously when getMergedLocation was passed nullptr as one of the parameters we returned nullptr. Change that behaviour to instead return a valid DebugLoc. This is beneficial for binaries from which SamplePGO profiles are obtained.
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.
Previously when getMergedLocation was passed nullptr as one of the
parameters we returned nullptr. Change that behaviour to instead return
a valid DebugLoc. This is beneficial for binaries from which SamplePGO
profiles are obtained.