Skip to content

[DirectX] Move resource logic into PrettyPrinter and TranslateMetadata. NFC #104446

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
Aug 26, 2024
Merged

[DirectX] Move resource logic into PrettyPrinter and TranslateMetadata. NFC #104446

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
33a3ace
[𝘀𝗽𝗿] changes to main this commit is based on
bogner Aug 15, 2024
f09a87c
[𝘀𝗽𝗿] initial version
bogner Aug 15, 2024
ec8ccb1
[𝘀𝗽𝗿] changes introduced through rebase
matthias-springer Aug 26, 2024
210acdf
rebase and clang-format
bogner Aug 26, 2024
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
18 changes: 16 additions & 2 deletions llvm/lib/Target/DirectX/DXILPrettyPrinter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,27 @@
#include "llvm/ADT/StringRef.h"
#include "llvm/IR/PassManager.h"
#include "llvm/Pass.h"
#include "llvm/Support/FormatVariadic.h"
#include "llvm/Support/raw_ostream.h"

using namespace llvm;

static void prettyPrintResources(raw_ostream &OS,
const dxil::Resources &MDResources) {
Copy link
Contributor

@damyanp damyanp Aug 16, 2024

Choose a reason for hiding this comment

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

What does the "MD" in "MDResources" mean?

Copy link
Contributor Author

@bogner bogner Aug 26, 2024

Choose a reason for hiding this comment

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

"Metadata". This is mostly a temporary thing while both DXILResourceAnalysis and DXILResourceMDAnalysis co-exist. The one with "MD" in the name will eventually be removed.

MDResources.print(OS);
// Column widths are arbitrary but match the widths DXC uses.
OS << ";\n; Resource Bindings:\n;\n";
OS << formatv("; {0,-30} {1,10} {2,7} {3,11} {4,7} {5,14} {6,16}\n", "Name",
"Type", "Format", "Dim", "ID", "HLSL Bind", "Count");
OS << formatv(
"; {0,-+30} {1,-+10} {2,-+7} {3,-+11} {4,-+7} {5,-+14} {6,-+16}\n", "",
"", "", "", "", "", "");

if (MDResources.hasCBuffers())
MDResources.printCBuffers(OS);
if (MDResources.hasUAVs())
MDResources.printUAVs(OS);

OS << ";\n";
}

PreservedAnalyses DXILPrettyPrinterPass::run(Module &M,
Expand Down Expand Up @@ -63,7 +77,7 @@ INITIALIZE_PASS_END(DXILPrettyPrinterLegacy, "dxil-pretty-printer",

bool DXILPrettyPrinterLegacy::runOnModule(Module &M) {
dxil::Resources &Res = getAnalysis<DXILResourceMDWrapper>().getDXILResource();
Res.print(OS);
prettyPrintResources(OS, Res);
return false;
}

Expand Down
39 changes: 8 additions & 31 deletions llvm/lib/Target/DirectX/DXILResource.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,37 +333,14 @@ template <typename T> MDNode *ResourceTable<T>::write(Module &M) const {
return MDNode::get(M.getContext(), MDs);
}

void Resources::write(Module &M) const {
Metadata *ResourceMDs[4] = {nullptr, nullptr, nullptr, nullptr};

ResourceMDs[1] = UAVs.write(M);

ResourceMDs[2] = CBuffers.write(M);

bool HasResource = ResourceMDs[0] != nullptr || ResourceMDs[1] != nullptr ||
ResourceMDs[2] != nullptr || ResourceMDs[3] != nullptr;

if (HasResource) {
NamedMDNode *DXResMD = M.getOrInsertNamedMetadata("dx.resources");
DXResMD->addOperand(MDNode::get(M.getContext(), ResourceMDs));
}

NamedMDNode *Entry = M.getNamedMetadata("hlsl.uavs");
if (Entry)
Entry->eraseFromParent();
Metadata *Resources::writeUAVs(Module &M) const { return UAVs.write(M); }
void Resources::printUAVs(raw_ostream &OS) const { UAVs.print(OS); }
Metadata *Resources::writeCBuffers(Module &M) const {
return CBuffers.write(M);
}
void Resources::printCBuffers(raw_ostream &OS) const { CBuffers.print(OS); }

void Resources::print(raw_ostream &O) const {
O << ";\n"
<< "; Resource Bindings:\n"
<< ";\n"
<< "; Name Type Format Dim "
"ID HLSL Bind Count\n"
<< "; ------------------------------ ---------- ------- ----------- "
"------- -------------- ------\n";

CBuffers.print(O);
UAVs.print(O);
void Resources::dump() const {
printCBuffers(dbgs());
printUAVs(dbgs());
}

void Resources::dump() const { print(dbgs()); }
9 changes: 7 additions & 2 deletions llvm/lib/Target/DirectX/DXILResource.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ template <typename T> class ResourceTable {
public:
ResourceTable(StringRef Name) : MDName(Name) {}
void collect(Module &M);
bool empty() const { return Data.empty(); }
MDNode *write(Module &M) const;
void print(raw_ostream &O) const;
};
Expand All @@ -117,8 +118,12 @@ class Resources {

public:
void collect(Module &M);
void write(Module &M) const;
void print(raw_ostream &O) const;
bool hasUAVs() const { return !UAVs.empty(); }
Metadata *writeUAVs(Module &M) const;
void printUAVs(raw_ostream &OS) const;
bool hasCBuffers() const { return !CBuffers.empty(); }
Metadata *writeCBuffers(Module &M) const;
void printCBuffers(raw_ostream &OS) const;
LLVM_DUMP_METHOD void dump() const;
};

Expand Down
26 changes: 25 additions & 1 deletion llvm/lib/Target/DirectX/DXILTranslateMetadata.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,30 @@
using namespace llvm;
using namespace llvm::dxil;

static void emitResourceMetadata(Module &M,
const dxil::Resources &MDResources) {
Metadata *SRVMD = nullptr, *UAVMD = nullptr, *CBufMD = nullptr,
*SmpMD = nullptr;
bool HasResources = false;

if (MDResources.hasUAVs()) {
UAVMD = MDResources.writeUAVs(M);
HasResources = true;
}

if (MDResources.hasCBuffers()) {
CBufMD = MDResources.writeCBuffers(M);
HasResources = true;
}

if (!HasResources)
return;

NamedMDNode *ResourceMD = M.getOrInsertNamedMetadata("dx.resources");
ResourceMD->addOperand(
MDNode::get(M.getContext(), {SRVMD, UAVMD, CBufMD, SmpMD}));
}

static void translateMetadata(Module &M, const dxil::Resources &MDResources,
const ComputedShaderFlags &ShaderFlags) {
dxil::ValidatorVersionMD ValVerMD(M);
Expand All @@ -30,7 +54,7 @@ static void translateMetadata(Module &M, const dxil::Resources &MDResources,
dxil::createShaderModelMD(M);
dxil::createDXILVersionMD(M);

MDResources.write(M);
emitResourceMetadata(M, MDResources);

dxil::createEntryMD(M, static_cast<uint64_t>(ShaderFlags));
}
Expand Down