[DXIL] Add support for root signature flag element in DXContainer #123147
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,224 @@ | ||
| //===- DXILRootSignature.cpp - DXIL Root Signature helper objects -------===// | ||
| // | ||
| // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. | ||
| // See https://llvm.org/LICENSE.txt for license information. | ||
| // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
| /// | ||
| /// \file This file contains helper objects and APIs for working with DXIL | ||
| /// Root Signatures. | ||
| /// | ||
| //===----------------------------------------------------------------------===// | ||
| #include "DXILRootSignature.h" | ||
| #include "DirectX.h" | ||
| #include "llvm/ADT/StringSwitch.h" | ||
| #include "llvm/ADT/Twine.h" | ||
| #include "llvm/Analysis/DXILMetadataAnalysis.h" | ||
| #include "llvm/BinaryFormat/DXContainer.h" | ||
| #include "llvm/IR/Constants.h" | ||
| #include "llvm/IR/DiagnosticInfo.h" | ||
| #include "llvm/IR/Function.h" | ||
| #include "llvm/IR/LLVMContext.h" | ||
| #include "llvm/IR/Metadata.h" | ||
| #include "llvm/IR/Module.h" | ||
| #include "llvm/InitializePasses.h" | ||
| #include "llvm/Pass.h" | ||
| #include "llvm/Support/Error.h" | ||
| #include "llvm/Support/ErrorHandling.h" | ||
| #include <cstdint> | ||
| #include <optional> | ||
| #include <utility> | ||
|
|
||
| using namespace llvm; | ||
| using namespace llvm::dxil; | ||
|
|
||
| static bool reportError(LLVMContext *Ctx, Twine Message, | ||
| DiagnosticSeverity Severity = DS_Error) { | ||
| Ctx->diagnose(DiagnosticInfoGeneric(Message, Severity)); | ||
| return true; | ||
| } | ||
|
|
||
| static bool parseRootFlags(LLVMContext *Ctx, ModuleRootSignature &MRS, | ||
| MDNode *RootFlagNode) { | ||
|
|
||
| if (RootFlagNode->getNumOperands() != 2) | ||
| return reportError(Ctx, "Invalid format for RootFlag Element"); | ||
|
|
||
| auto *Flag = mdconst::extract<ConstantInt>(RootFlagNode->getOperand(1)); | ||
| MRS.Flags = Flag->getZExtValue(); | ||
|
|
||
| return false; | ||
| } | ||
|
|
||
| static bool parseRootSignatureElement(LLVMContext *Ctx, | ||
| ModuleRootSignature &MRS, | ||
| MDNode *Element) { | ||
| MDString *ElementText = cast<MDString>(Element->getOperand(0)); | ||
| if (ElementText == nullptr) | ||
| return reportError(Ctx, "Invalid format for Root Element"); | ||
|
|
||
| RootSignatureElementKind ElementKind = | ||
| StringSwitch<RootSignatureElementKind>(ElementText->getString()) | ||
| .Case("RootFlags", RootSignatureElementKind::RootFlags) | ||
| .Default(RootSignatureElementKind::None); | ||
|
There was a problem hiding this comment. Should |
||
|
|
||
| switch (ElementKind) { | ||
|
|
||
| case RootSignatureElementKind::RootFlags: | ||
| return parseRootFlags(Ctx, MRS, Element); | ||
| case RootSignatureElementKind::None: | ||
| return reportError(Ctx, "Invalid Root Signature Element: " + | ||
| ElementText->getString()); | ||
| } | ||
|
|
||
| llvm_unreachable("Root signature element kind not expected."); | ||
|
There was a problem hiding this comment. Wording nit: This isn't "unexpected" - it should be impossible if folks are reading compiler warnings. I might say "Unhandled RootSignatureElementKind enum" here. |
||
| } | ||
|
|
||
| static bool parse(LLVMContext *Ctx, ModuleRootSignature &MRS, MDNode *Node) { | ||
| bool HasError = false; | ||
|
|
||
| // Loop through the Root Elements of the root signature. | ||
| for (const auto &Operand : Node->operands()) { | ||
| MDNode *Element = dyn_cast<MDNode>(Operand); | ||
| if (Element == nullptr) | ||
| return reportError(Ctx, "Missing Root Element Metadata Node."); | ||
|
|
||
| HasError = HasError || parseRootSignatureElement(Ctx, MRS, Element); | ||
| } | ||
|
|
||
| return HasError; | ||
| } | ||
|
|
||
| static bool validate(LLVMContext *Ctx, const ModuleRootSignature &MRS) { | ||
| if (!dxbc::RootSignatureValidations::isValidRootFlag(MRS.Flags)) { | ||
| return reportError(Ctx, "Invalid Root Signature flag value"); | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| static SmallDenseMap<const Function *, ModuleRootSignature> | ||
| analyzeModule(Module &M) { | ||
|
|
||
| /** Root Signature are specified as following in the metadata: | ||
|
|
||
| !dx.rootsignatures = !{!2} ; list of function/root signature pairs | ||
| !2 = !{ ptr @main, !3 } ; function, root signature | ||
| !3 = !{ !4, !5, !6, !7 } ; list of root signature elements | ||
|
|
||
| So for each MDNode inside dx.rootsignatures NamedMDNode | ||
| (the Root parameter of this function), the parsing process needs | ||
| to loop through each of its operands and process the function, | ||
| signature pair. | ||
| */ | ||
|
|
||
| LLVMContext *Ctx = &M.getContext(); | ||
|
|
||
| SmallDenseMap<const Function *, ModuleRootSignature> MRSMap; | ||
|
|
||
| NamedMDNode *RootSignatureNode = M.getNamedMetadata("dx.rootsignatures"); | ||
| if (RootSignatureNode == nullptr) | ||
| return MRSMap; | ||
|
|
||
| for (const auto &RSDefNode : RootSignatureNode->operands()) { | ||
| if (RSDefNode->getNumOperands() != 2) { | ||
| reportError(Ctx, "Invalid format for Root Signature Definition. Pairs " | ||
| "of function, root signature expected."); | ||
| continue; | ||
| } | ||
|
|
||
| // Function was pruned during compilation. | ||
| const MDOperand &FunctionPointerMdNode = RSDefNode->getOperand(0); | ||
| if (FunctionPointerMdNode == nullptr) { | ||
| continue; | ||
| } | ||
|
There was a problem hiding this comment. This should probably be a (there's an argument that some of these could be asserts, depending on whether we consider invalid IR to be user input or a frontend bug, but for consistency with the other cases here reportError seems the most appropriate) There was a problem hiding this comment. Is it possible that a function might be removed, but the root signature metadata associated with it is not? For example, if the user change the Entry function using the CLI flag? If that is possible, we might need to update There was a problem hiding this comment. I can't think of any way that we could get here from HLSL, no. As far as I can tell the only way we can get to this situation is if we have invalid LLVM IR in the first place. |
||
|
|
||
| ValueAsMetadata *VAM = | ||
| llvm::dyn_cast<ValueAsMetadata>(FunctionPointerMdNode.get()); | ||
| if (VAM == nullptr) { | ||
| reportError(Ctx, "First element of root signature is not a Value"); | ||
| continue; | ||
| } | ||
|
|
||
| Function *F = dyn_cast<Function>(VAM->getValue()); | ||
| if (F == nullptr) { | ||
| reportError(Ctx, "First element of root signature is not a Function"); | ||
| continue; | ||
| } | ||
|
|
||
| MDNode *RootElementListNode = | ||
| dyn_cast<MDNode>(RSDefNode->getOperand(1).get()); | ||
|
|
||
| if (RootElementListNode == nullptr) { | ||
| reportError(Ctx, "Missing Root Element List Metadata node."); | ||
| } | ||
|
Comment on lines
+156
to
+158
There was a problem hiding this comment. Should there be a |
||
|
|
||
| ModuleRootSignature MRS; | ||
|
|
||
| if (parse(Ctx, MRS, RootElementListNode) || validate(Ctx, MRS)) { | ||
| return MRSMap; | ||
| } | ||
|
|
||
| MRSMap.insert(std::make_pair(F, MRS)); | ||
| } | ||
|
|
||
| return MRSMap; | ||
| } | ||
|
|
||
| AnalysisKey RootSignatureAnalysis::Key; | ||
|
|
||
| SmallDenseMap<const Function *, ModuleRootSignature> | ||
| RootSignatureAnalysis::run(Module &M, ModuleAnalysisManager &AM) { | ||
| return analyzeModule(M); | ||
| } | ||
|
|
||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| static void printSpaces(raw_ostream &Stream, unsigned int Count) { | ||
| for (unsigned int I = 0; I < Count; ++I) { | ||
| Stream << ' '; | ||
| } | ||
| } | ||
|
|
||
| PreservedAnalyses RootSignatureAnalysisPrinter::run(Module &M, | ||
| ModuleAnalysisManager &AM) { | ||
|
|
||
| SmallDenseMap<const Function *, ModuleRootSignature> &MRSMap = | ||
| AM.getResult<RootSignatureAnalysis>(M); | ||
| OS << "Root Signature Definitions" | ||
| << "\n"; | ||
| uint8_t Space = 0; | ||
| for (const auto &P : MRSMap) { | ||
| const auto &[Function, MRS] = P; | ||
| OS << "Definition for '" << Function->getName() << "':\n"; | ||
|
|
||
| // start root signature header | ||
| Space++; | ||
| printSpaces(OS, Space); | ||
| OS << "Flags: " << format_hex(MRS.Flags, 8) << ":\n"; | ||
| Space--; | ||
|
There was a problem hiding this comment. I think you can use |
||
| // end root signature header | ||
| } | ||
|
|
||
| return PreservedAnalyses::all(); | ||
| } | ||
|
|
||
| //===----------------------------------------------------------------------===// | ||
| bool RootSignatureAnalysisWrapper::runOnModule(Module &M) { | ||
| MRS = analyzeModule(M); | ||
| return false; | ||
| } | ||
|
|
||
| void RootSignatureAnalysisWrapper::getAnalysisUsage(AnalysisUsage &AU) const { | ||
| AU.setPreservesAll(); | ||
| AU.addRequired<DXILMetadataAnalysisWrapperPass>(); | ||
| } | ||
|
|
||
| char RootSignatureAnalysisWrapper::ID = 0; | ||
damyanp marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| INITIALIZE_PASS_BEGIN(RootSignatureAnalysisWrapper, | ||
| "dxil-root-signature-analysis", | ||
| "DXIL Root Signature Analysis", true, true) | ||
| INITIALIZE_PASS_END(RootSignatureAnalysisWrapper, | ||
| "dxil-root-signature-analysis", | ||
| "DXIL Root Signature Analysis", true, true) | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please keep the blank line between the sources and the LINK_COMPONENTS line - it makes this easier to read.