[NFC]Rename InstrProf::getFuncName{,orExternalSymbol} to getValueName{,orExternalSymbol} #68240
Conversation
This file contains 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
Contributor
mingmingl-llvm
commented
Oct 4, 2023
mingmingl-llvm
commented
- This function looks up MD5ToNameMap to return a name for a given MD5. [InstrFDO][TypeProf] Implement binary instrumentation and profile read/write #66825 adds MD5 of global variable names into this map. So rename methods and update comments
…{,orExternalSymbol}.
- This function looks up MD5ToNameMap to return a name for a given MD5.
llvm#66825 adds MD5 of global variable names into this map. So did the rename.
|
@llvm/pr-subscribers-pgo Changes
Full diff: https://github.com/llvm/llvm-project/pull/68240.diff 6 Files Affected:
diff --git a/llvm/include/llvm/ProfileData/Coverage/CoverageMapping.h b/llvm/include/llvm/ProfileData/Coverage/CoverageMapping.h
index b407fe277c543b8..a21b597c7d09f4a 100644
--- a/llvm/include/llvm/ProfileData/Coverage/CoverageMapping.h
+++ b/llvm/include/llvm/ProfileData/Coverage/CoverageMapping.h
@@ -813,7 +813,7 @@ template <class FuncRecordTy, support::endianness Endian>
Error getFuncNameViaRef(const FuncRecordTy *Record,
InstrProfSymtab &ProfileNames, StringRef &FuncName) {
uint64_t NameRef = getFuncNameRef<FuncRecordTy, Endian>(Record);
- FuncName = ProfileNames.getFuncName(NameRef);
+ FuncName = ProfileNames.getValueName(NameRef);
return Error::success();
}
diff --git a/llvm/include/llvm/ProfileData/InstrProf.h b/llvm/include/llvm/ProfileData/InstrProf.h
index f9096b46157200b..78aa03ca015e262 100644
--- a/llvm/include/llvm/ProfileData/InstrProf.h
+++ b/llvm/include/llvm/ProfileData/InstrProf.h
@@ -510,14 +510,14 @@ class InstrProfSymtab {
/// an empty string.
StringRef getFuncName(uint64_t FuncNameAddress, size_t NameSize);
- /// Return function's PGO name from the name's md5 hash value.
- /// If not found, return an empty string.
- inline StringRef getFuncName(uint64_t FuncMD5Hash);
+ /// Return name of functions or global variables from the name's md5 hash
+ /// value. If not found, return an empty string.
+ inline StringRef getValueName(uint64_t ValMD5Hash);
- /// Just like getFuncName, except that it will return a non-empty StringRef
- /// if the function is external to this symbol table. All such cases
- /// will be represented using the same StringRef value.
- inline StringRef getFuncNameOrExternalSymbol(uint64_t FuncMD5Hash);
+ /// Just like getValueName, except that it will return a non-empty StringRef
+ /// if the value (function or global variable) is external to this symbol
+ /// table. All such cases will be represented using the same StringRef value.
+ inline StringRef getValueNameOrExternalSymbol(uint64_t ValMD5Hash);
/// True if Symbol is the value used to represent external symbols.
static bool isExternalSymbol(const StringRef &Symbol) {
@@ -565,14 +565,14 @@ void InstrProfSymtab::finalizeSymtab() {
Sorted = true;
}
-StringRef InstrProfSymtab::getFuncNameOrExternalSymbol(uint64_t FuncMD5Hash) {
- StringRef ret = getFuncName(FuncMD5Hash);
+StringRef InstrProfSymtab::getValueNameOrExternalSymbol(uint64_t FuncMD5Hash) {
+ StringRef ret = getValueName(FuncMD5Hash);
if (ret.empty())
return InstrProfSymtab::getExternalSymbol();
return ret;
}
-StringRef InstrProfSymtab::getFuncName(uint64_t FuncMD5Hash) {
+StringRef InstrProfSymtab::getValueName(uint64_t FuncMD5Hash) {
finalizeSymtab();
auto Result = llvm::lower_bound(MD5NameMap, FuncMD5Hash,
[](const std::pair<uint64_t, StringRef> &LHS,
diff --git a/llvm/include/llvm/ProfileData/InstrProfReader.h b/llvm/include/llvm/ProfileData/InstrProfReader.h
index 17194e2aa4c73ca..5925fe61e21744e 100644
--- a/llvm/include/llvm/ProfileData/InstrProfReader.h
+++ b/llvm/include/llvm/ProfileData/InstrProfReader.h
@@ -452,7 +452,7 @@ class RawInstrProfReader : public InstrProfReader {
}
StringRef getName(uint64_t NameRef) const {
- return Symtab->getFuncName(swap(NameRef));
+ return Symtab->getValueName(swap(NameRef));
}
int getCounterTypeSize() const {
diff --git a/llvm/lib/ProfileData/InstrProfWriter.cpp b/llvm/lib/ProfileData/InstrProfWriter.cpp
index b74d5c3862d803d..f4be2de95bd37c0 100644
--- a/llvm/lib/ProfileData/InstrProfWriter.cpp
+++ b/llvm/lib/ProfileData/InstrProfWriter.cpp
@@ -722,7 +722,7 @@ void InstrProfWriter::writeRecordInText(StringRef Name, uint64_t Hash,
std::unique_ptr<InstrProfValueData[]> VD = Func.getValueForSite(VK, S);
for (uint32_t I = 0; I < ND; I++) {
if (VK == IPVK_IndirectCallTarget)
- OS << Symtab.getFuncNameOrExternalSymbol(VD[I].Value) << ":"
+ OS << Symtab.getValueNameOrExternalSymbol(VD[I].Value) << ":"
<< VD[I].Count << "\n";
else
OS << VD[I].Value << ":" << VD[I].Count << "\n";
@@ -790,7 +790,7 @@ void InstrProfWriter::writeTextTemporalProfTraceData(raw_fd_ostream &OS,
for (auto &Trace : TemporalProfTraces) {
OS << "# Weight:\n" << Trace.Weight << "\n";
for (auto &NameRef : Trace.FunctionNameRefs)
- OS << Symtab.getFuncName(NameRef) << ",";
+ OS << Symtab.getValueName(NameRef) << ",";
OS << "\n";
}
OS << "\n";
diff --git a/llvm/tools/llvm-profdata/llvm-profdata.cpp b/llvm/tools/llvm-profdata/llvm-profdata.cpp
index fdb2c1405f1237f..5b9579f7f3c0c6a 100644
--- a/llvm/tools/llvm-profdata/llvm-profdata.cpp
+++ b/llvm/tools/llvm-profdata/llvm-profdata.cpp
@@ -2390,7 +2390,7 @@ static void traverseAllValueSites(const InstrProfRecord &Func, uint32_t VK,
if (Symtab == nullptr)
OS << format("%4" PRIu64, VD[V].Value);
else
- OS << Symtab->getFuncName(VD[V].Value);
+ OS << Symtab->getValueName(VD[V].Value);
OS << ", " << format("%10" PRId64, VD[V].Count) << " ] ("
<< format("%.2f%%", (VD[V].Count * 100.0 / SiteSum)) << ")\n";
}
@@ -2644,7 +2644,7 @@ static int showInstrProfile(
OS << " Temporal Profile Trace " << i << " (weight=" << Traces[i].Weight
<< " count=" << Traces[i].FunctionNameRefs.size() << "):\n";
for (auto &NameRef : Traces[i].FunctionNameRefs)
- OS << " " << Reader->getSymtab().getFuncName(NameRef) << "\n";
+ OS << " " << Reader->getSymtab().getValueName(NameRef) << "\n";
}
}
@@ -3079,7 +3079,7 @@ static int order_main(int argc, const char *argv[]) {
WithColor::note() << "# Ordered " << Nodes.size() << " functions\n";
for (auto &N : Nodes) {
auto [Filename, ParsedFuncName] =
- getParsedIRPGOFuncName(Reader->getSymtab().getFuncName(N.Id));
+ getParsedIRPGOFuncName(Reader->getSymtab().getValueName(N.Id));
if (!Filename.empty())
OS << "# " << Filename << "\n";
OS << ParsedFuncName << "\n";
diff --git a/llvm/unittests/ProfileData/InstrProfTest.cpp b/llvm/unittests/ProfileData/InstrProfTest.cpp
index 76f88c058424d03..66e47cbdfd30986 100644
--- a/llvm/unittests/ProfileData/InstrProfTest.cpp
+++ b/llvm/unittests/ProfileData/InstrProfTest.cpp
@@ -1250,23 +1250,23 @@ TEST_P(MaybeSparseInstrProfTest, instr_prof_symtab_test) {
FuncNames.push_back("bar3");
InstrProfSymtab Symtab;
EXPECT_THAT_ERROR(Symtab.create(FuncNames), Succeeded());
- StringRef R = Symtab.getFuncName(IndexedInstrProf::ComputeHash("func1"));
+ StringRef R = Symtab.getValueName(IndexedInstrProf::ComputeHash("func1"));
ASSERT_EQ(StringRef("func1"), R);
- R = Symtab.getFuncName(IndexedInstrProf::ComputeHash("func2"));
+ R = Symtab.getValueName(IndexedInstrProf::ComputeHash("func2"));
ASSERT_EQ(StringRef("func2"), R);
- R = Symtab.getFuncName(IndexedInstrProf::ComputeHash("func3"));
+ R = Symtab.getValueName(IndexedInstrProf::ComputeHash("func3"));
ASSERT_EQ(StringRef("func3"), R);
- R = Symtab.getFuncName(IndexedInstrProf::ComputeHash("bar1"));
+ R = Symtab.getValueName(IndexedInstrProf::ComputeHash("bar1"));
ASSERT_EQ(StringRef("bar1"), R);
- R = Symtab.getFuncName(IndexedInstrProf::ComputeHash("bar2"));
+ R = Symtab.getValueName(IndexedInstrProf::ComputeHash("bar2"));
ASSERT_EQ(StringRef("bar2"), R);
- R = Symtab.getFuncName(IndexedInstrProf::ComputeHash("bar3"));
+ R = Symtab.getValueName(IndexedInstrProf::ComputeHash("bar3"));
ASSERT_EQ(StringRef("bar3"), R);
// negative tests
- R = Symtab.getFuncName(IndexedInstrProf::ComputeHash("bar4"));
+ R = Symtab.getValueName(IndexedInstrProf::ComputeHash("bar4"));
ASSERT_EQ(StringRef(), R);
- R = Symtab.getFuncName(IndexedInstrProf::ComputeHash("foo4"));
+ R = Symtab.getValueName(IndexedInstrProf::ComputeHash("foo4"));
ASSERT_EQ(StringRef(), R);
// Now incrementally update the symtab
@@ -1275,23 +1275,23 @@ TEST_P(MaybeSparseInstrProfTest, instr_prof_symtab_test) {
EXPECT_THAT_ERROR(Symtab.addFuncName("blah_3"), Succeeded());
// Check again
- R = Symtab.getFuncName(IndexedInstrProf::ComputeHash("blah_1"));
+ R = Symtab.getValueName(IndexedInstrProf::ComputeHash("blah_1"));
ASSERT_EQ(StringRef("blah_1"), R);
- R = Symtab.getFuncName(IndexedInstrProf::ComputeHash("blah_2"));
+ R = Symtab.getValueName(IndexedInstrProf::ComputeHash("blah_2"));
ASSERT_EQ(StringRef("blah_2"), R);
- R = Symtab.getFuncName(IndexedInstrProf::ComputeHash("blah_3"));
+ R = Symtab.getValueName(IndexedInstrProf::ComputeHash("blah_3"));
ASSERT_EQ(StringRef("blah_3"), R);
- R = Symtab.getFuncName(IndexedInstrProf::ComputeHash("func1"));
+ R = Symtab.getValueName(IndexedInstrProf::ComputeHash("func1"));
ASSERT_EQ(StringRef("func1"), R);
- R = Symtab.getFuncName(IndexedInstrProf::ComputeHash("func2"));
+ R = Symtab.getValueName(IndexedInstrProf::ComputeHash("func2"));
ASSERT_EQ(StringRef("func2"), R);
- R = Symtab.getFuncName(IndexedInstrProf::ComputeHash("func3"));
+ R = Symtab.getValueName(IndexedInstrProf::ComputeHash("func3"));
ASSERT_EQ(StringRef("func3"), R);
- R = Symtab.getFuncName(IndexedInstrProf::ComputeHash("bar1"));
+ R = Symtab.getValueName(IndexedInstrProf::ComputeHash("bar1"));
ASSERT_EQ(StringRef("bar1"), R);
- R = Symtab.getFuncName(IndexedInstrProf::ComputeHash("bar2"));
+ R = Symtab.getValueName(IndexedInstrProf::ComputeHash("bar2"));
ASSERT_EQ(StringRef("bar2"), R);
- R = Symtab.getFuncName(IndexedInstrProf::ComputeHash("bar3"));
+ R = Symtab.getValueName(IndexedInstrProf::ComputeHash("bar3"));
ASSERT_EQ(StringRef("bar3"), R);
}
@@ -1331,14 +1331,14 @@ TEST_P(MaybeSparseInstrProfTest, instr_prof_symtab_module_test) {
std::string IRPGOName = getIRPGOFuncName(*F);
auto IRPGOFuncName =
- ProfSymtab.getFuncName(IndexedInstrProf::ComputeHash(IRPGOName));
+ ProfSymtab.getValueName(IndexedInstrProf::ComputeHash(IRPGOName));
EXPECT_EQ(StringRef(IRPGOName), IRPGOFuncName);
EXPECT_EQ(StringRef(Funcs[I]),
getParsedIRPGOFuncName(IRPGOFuncName).second);
// Ensure we can still read this old record name.
std::string PGOName = getPGOFuncName(*F);
auto PGOFuncName =
- ProfSymtab.getFuncName(IndexedInstrProf::ComputeHash(PGOName));
+ ProfSymtab.getValueName(IndexedInstrProf::ComputeHash(PGOName));
EXPECT_EQ(StringRef(PGOName), PGOFuncName);
EXPECT_THAT(PGOFuncName.str(), EndsWith(Funcs[I].str()));
}
@@ -1396,9 +1396,10 @@ TEST_P(MaybeSparseInstrProfTest, instr_prof_symtab_compression_test) {
// Now do the checks:
// First sampling some data points:
- StringRef R = Symtab.getFuncName(IndexedInstrProf::ComputeHash(FuncNames1[0]));
+ StringRef R =
+ Symtab.getValueName(IndexedInstrProf::ComputeHash(FuncNames1[0]));
ASSERT_EQ(StringRef("func_0"), R);
- R = Symtab.getFuncName(IndexedInstrProf::ComputeHash(FuncNames1[1]));
+ R = Symtab.getValueName(IndexedInstrProf::ComputeHash(FuncNames1[1]));
ASSERT_EQ(StringRef("f oooooooooooooo_0"), R);
for (int I = 0; I < 3; I++) {
std::string N[4];
@@ -1407,7 +1408,8 @@ TEST_P(MaybeSparseInstrProfTest, instr_prof_symtab_compression_test) {
N[2] = FuncNames2[2 * I];
N[3] = FuncNames2[2 * I + 1];
for (int J = 0; J < 4; J++) {
- StringRef R = Symtab.getFuncName(IndexedInstrProf::ComputeHash(N[J]));
+ StringRef R =
+ Symtab.getValueName(IndexedInstrProf::ComputeHash(N[J]));
ASSERT_EQ(StringRef(N[J]), R);
}
}
|
david-xl
reviewed
Oct 4, 2023
| @@ -813,7 +813,7 @@ template <class FuncRecordTy, support::endianness Endian> | |||
| Error getFuncNameViaRef(const FuncRecordTy *Record, | |||
| InstrProfSymtab &ProfileNames, StringRef &FuncName) { | |||
| uint64_t NameRef = getFuncNameRef<FuncRecordTy, Endian>(Record); | |||
| FuncName = ProfileNames.getFuncName(NameRef); | |||
| FuncName = ProfileNames.getValueName(NameRef); | |||
There was a problem hiding this comment.
nit: make the name clearer: getFuncOrVarName().
| /// Just like getValueName, except that it will return a non-empty StringRef | ||
| /// if the value (function or global variable) is external to this symbol | ||
| /// table. All such cases will be represented using the same StringRef value. | ||
| inline StringRef getValueNameOrExternalSymbol(uint64_t ValMD5Hash); |
There was a problem hiding this comment.
getFuncOrVarNameIfDefined(). Update comment to say 'External Symbol' is returned if not found.
| @@ -565,14 +565,14 @@ void InstrProfSymtab::finalizeSymtab() { | |||
| Sorted = true; | |||
| } | |||
|
|
|||
| StringRef InstrProfSymtab::getFuncNameOrExternalSymbol(uint64_t FuncMD5Hash) { | |||
| StringRef ret = getFuncName(FuncMD5Hash); | |||
| StringRef InstrProfSymtab::getValueNameOrExternalSymbol(uint64_t FuncMD5Hash) { | |||
david-xl
approved these changes
Oct 4, 2023
Merged
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.