Skip to content

[ctx_prof] Extend WorkloadImportsManager to use the contextual profile #98682

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.

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 9 commits into from
Jul 29, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
80 changes: 71 additions & 9 deletions llvm/lib/Transforms/IPO/FunctionImport.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
#include "llvm/ADT/StringRef.h"
#include "llvm/Bitcode/BitcodeReader.h"
#include "llvm/IR/AutoUpgrade.h"
#include "llvm/IR/Constants.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/GlobalAlias.h"
#include "llvm/IR/GlobalObject.h"
Expand All @@ -30,6 +29,7 @@
#include "llvm/IR/ModuleSummaryIndex.h"
#include "llvm/IRReader/IRReader.h"
#include "llvm/Linker/IRMover.h"
#include "llvm/ProfileData/PGOCtxProfReader.h"
#include "llvm/Support/Casting.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/Debug.h"
Expand Down Expand Up @@ -174,6 +174,10 @@ static cl::opt<std::string> WorkloadDefinitions(
"}"),
cl::Hidden);

static cl::opt<std::string>
ContextualProfile("thinlto-pgo-ctx-prof",
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add a test to exercise this handling?

Copy link
Member Author

@mtrofin mtrofin Jul 17, 2024

Choose a reason for hiding this comment

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

We don't currently have a textual representation of the contextual profile, and the import manager is internal to this file, meaning we can't write a unittest. I'd do either, though, if the new functionality was more involved, but it's really just taking data from the ctx profile reader - which is tested - and filling a set with it.

Copy link
Contributor

Choose a reason for hiding this comment

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

I meant a lit test. I think it would be good to add (reading the binary format like I am assuming the ctx profile reader tests do?), otherwise this is untested functionality.

Copy link
Member Author

Choose a reason for hiding this comment

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

Right - need to figure out where to place it, because it would need to be a test that runs a program to generate a profile. Meaning it needs compiler-rt.

Copy link
Member Author

Choose a reason for hiding this comment

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

done.

cl::desc("Path to a contextual profile."), cl::Hidden);

namespace llvm {
extern cl::opt<bool> EnableMemProfContextDisambiguation;
}
Expand Down Expand Up @@ -586,13 +590,7 @@ class WorkloadImportsManager : public ModuleImportsManager {
LLVM_DEBUG(dbgs() << "[Workload] Done\n");
}

public:
WorkloadImportsManager(
function_ref<bool(GlobalValue::GUID, const GlobalValueSummary *)>
IsPrevailing,
const ModuleSummaryIndex &Index,
DenseMap<StringRef, FunctionImporter::ExportSetTy> *ExportLists)
: ModuleImportsManager(IsPrevailing, Index, ExportLists) {
void loadFromJson() {
// Since the workload def uses names, we need a quick lookup
// name->ValueInfo.
StringMap<ValueInfo> NameToValueInfo;
Expand Down Expand Up @@ -672,14 +670,78 @@ class WorkloadImportsManager : public ModuleImportsManager {
});
}
}

void loadFromCtxProf() {
std::error_code EC;
auto BufferOrErr = MemoryBuffer::getFileOrSTDIN(ContextualProfile);
if (std::error_code EC = BufferOrErr.getError()) {
report_fatal_error("Failed to open contextual profile file");
return;
}
auto Buffer = std::move(BufferOrErr.get());

BitstreamCursor Cursor(*Buffer);
PGOCtxProfileReader Reader(Cursor);
auto Ctx = Reader.loadContexts();
if (!Ctx) {
report_fatal_error("Failed to parse contextual profiles");
return;
}
const auto &CtxMap = *Ctx;
DenseSet<GlobalValue::GUID> ContainedGUIDs;
for (const auto &[RootGuid, Root] : CtxMap) {
// Avoid ContainedGUIDs to get in/out of scope. Reuse its memory for
// subsequent roots, but clear its contents.
ContainedGUIDs.clear();

auto RootVI = Index.getValueInfo(RootGuid);
if (!RootVI) {
LLVM_DEBUG(dbgs() << "[Workload] Root " << RootGuid
<< " not found in this linkage unit.\n");
continue;
}
if (RootVI.getSummaryList().size() != 1) {
LLVM_DEBUG(dbgs() << "[Workload] Root " << RootGuid
<< " should have exactly one summary, but has "
<< RootVI.getSummaryList().size() << ". Skipping.\n");
continue;
}
StringRef RootDefiningModule =
RootVI.getSummaryList().front()->modulePath();
LLVM_DEBUG(dbgs() << "[Workload] Root defining module for " << RootGuid
<< " is : " << RootDefiningModule << "\n");
auto &Set = Workloads[RootDefiningModule];
Root.getContainedGuids(ContainedGUIDs);
for (auto Guid : ContainedGUIDs)
if (auto VI = Index.getValueInfo(Guid))
Set.insert(VI);
Copy link
Contributor

Choose a reason for hiding this comment

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

The json case has some debug printing of the eventual Set contents - needed here too?

Copy link
Member Author

Choose a reason for hiding this comment

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

Moved in a common place.

}
}

public:
WorkloadImportsManager(
function_ref<bool(GlobalValue::GUID, const GlobalValueSummary *)>
IsPrevailing,
const ModuleSummaryIndex &Index,
DenseMap<StringRef, FunctionImporter::ExportSetTy> *ExportLists)
: ModuleImportsManager(IsPrevailing, Index, ExportLists) {
if (ContextualProfile.empty() == WorkloadDefinitions.empty()) {
report_fatal_error(
"Pass only one of: -thinlto-pgo-ctx-prof or -thinlto-workload-def");
return;
}
if (!ContextualProfile.empty())
loadFromCtxProf();
loadFromJson();
}
};

std::unique_ptr<ModuleImportsManager> ModuleImportsManager::create(
function_ref<bool(GlobalValue::GUID, const GlobalValueSummary *)>
IsPrevailing,
const ModuleSummaryIndex &Index,
DenseMap<StringRef, FunctionImporter::ExportSetTy> *ExportLists) {
if (WorkloadDefinitions.empty()) {
if (WorkloadDefinitions.empty() && ContextualProfile.empty()) {
LLVM_DEBUG(dbgs() << "[Workload] Using the regular imports manager.\n");
return std::unique_ptr<ModuleImportsManager>(
new ModuleImportsManager(IsPrevailing, Index, ExportLists));
Expand Down
9 changes: 9 additions & 0 deletions llvm/unittests/ProfileData/PGOCtxProfReaderWriterTest.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,15 @@ TEST_F(PGOCtxProfRWTest, RoundTrip) {
EXPECT_EQ(Ctxes.size(), 2U);
for (auto &[G, R] : roots())
checkSame(*R, Ctxes.find(G)->second);

DenseSet<GlobalValue::GUID> Guids;
Ctxes.at(1U).getContainedGuids(Guids);
Copy link
Contributor

Choose a reason for hiding this comment

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

It is unclear to me how this test change is related to the rest of the PR.

Copy link
Member Author

Choose a reason for hiding this comment

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

It's not, but this is the API that the rest of this patch hinges on. I could introduce the test separately.

Copy link
Contributor

Choose a reason for hiding this comment

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

I would just commit that separately (no need for another review, that part lgtm) since that isn't a new API here.

Copy link
Member Author

Choose a reason for hiding this comment

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

done (a742693)

EXPECT_THAT(Guids,
testing::WhenSorted(testing::ElementsAre(1U, 2U, 4U, 5U)));

Guids.clear();
Ctxes.at(3U).getContainedGuids(Guids);
EXPECT_THAT(Guids, testing::ElementsAre(3U));
}
}

Expand Down
Loading