nfc: factor out validations in translate metadata

Author: inbelic

llvm/lib/Target/DirectX/DXILTranslateMetadata.cpp

@@ -36,26 +36,6 @@ using namespace llvm;
 using namespace llvm::dxil;
 
 namespace {
-/// A simple Wrapper DiagnosticInfo that generates Module-level diagnostic
-/// for TranslateMetadata pass
-class DiagnosticInfoTranslateMD : public DiagnosticInfo {
-private:
-  const Twine &Msg;
-  const Module &Mod;
-
-public:
-  /// \p M is the module for which the diagnostic is being emitted. \p Msg is
-  /// the message to show. Note that this class does not copy this message, so
-  /// this reference must be valid for the whole life time of the diagnostic.
-  DiagnosticInfoTranslateMD(const Module &M,
-                            const Twine &Msg LLVM_LIFETIME_BOUND,
-                            DiagnosticSeverity Severity = DS_Error)
-      : DiagnosticInfo(DK_Unsupported, Severity), Msg(Msg), Mod(M) {}
-
-  void print(DiagnosticPrinter &DP) const override {
-    DP << Mod.getName() << ": " << Msg << '\n';
-  }
-};
 
 enum class EntryPropsTag {
   ShaderFlags = 0,
@@ -391,9 +371,6 @@ static void translateGlobalMetadata(Module &M, DXILResourceMap &DRM,
     uint64_t CombinedMask = ShaderFlags.getCombinedFlags();
     EntryFnMDNodes.emplace_back(
         emitTopLevelLibraryNode(M, ResourceMD, CombinedMask));
-  } else if (MMDI.EntryPropertyVec.size() > 1) {
-    M.getContext().diagnose(DiagnosticInfoTranslateMD(
-        M, "Non-library shader: One and only one entry expected"));
   }
 
   for (const EntryProperties &EntryProp : MMDI.EntryPropertyVec) {
@@ -402,20 +379,9 @@ static void translateGlobalMetadata(Module &M, DXILResourceMap &DRM,
 
     // If ShaderProfile is Library, mask is already consolidated in the
     // top-level library node. Hence it is not emitted.
-    uint64_t EntryShaderFlags = 0;
-    if (MMDI.ShaderProfile != Triple::EnvironmentType::Library) {
-      EntryShaderFlags = EntrySFMask;
-      if (EntryProp.ShaderStage != MMDI.ShaderProfile) {
-        M.getContext().diagnose(DiagnosticInfoTranslateMD(
-            M,
-            "Shader stage '" +
-                Twine(getShortShaderStage(EntryProp.ShaderStage) +
-                      "' for entry '" + Twine(EntryProp.Entry->getName()) +
-                      "' different from specified target profile '" +
-                      Twine(Triple::getEnvironmentTypeName(MMDI.ShaderProfile) +
-                            "'"))));
-      }
-    }
+    uint64_t EntryShaderFlags =
+        MMDI.ShaderProfile == Triple::EnvironmentType::Library ? 0
+                                                               : EntrySFMask;
     EntryFnMDNodes.emplace_back(emitEntryMD(EntryProp, Signatures, ResourceMD,
                                             EntryShaderFlags,
                                             MMDI.ShaderProfile));

llvm/lib/Target/DirectX/DXILValidateMetadata.cpp

@@ -10,6 +10,7 @@
 #include "DXILTranslateMetadata.h"
 #include "DirectX.h"
 #include "llvm/ADT/Twine.h"
+#include "llvm/Analysis/DXILMetadataAnalysis.h"
 #include "llvm/IR/BasicBlock.h"
 #include "llvm/IR/DiagnosticInfo.h"
 #include "llvm/IR/DiagnosticPrinter.h"
@@ -43,14 +44,43 @@ class DiagnosticInfoValidateMD : public DiagnosticInfo {
   }
 };
 
+static bool reportError(Module &M, Twine Message,
+                        DiagnosticSeverity Severity = DS_Error) {
+  M.getContext().diagnose(DiagnosticInfoValidateMD(M, Message, Severity));
+  return true;
+}
+
 } // namespace
 
 static void validateInstructionMetadata(Module &M) {
   llvm::errs() << "hello from new pass!\n";
 }
 
+static void validateGlobalMetadata(Module &M,
+                                   const dxil::ModuleMetadataInfo &MMDI) {
+  if (MMDI.ShaderProfile != Triple::EnvironmentType::Library) {
+    if (1 < MMDI.EntryPropertyVec.size())
+      reportError(M, "Non-library shader: One and only one entry expected");
+
+    for (const dxil::EntryProperties &EntryProp : MMDI.EntryPropertyVec)
+      if (EntryProp.ShaderStage != MMDI.ShaderProfile)
+        reportError(
+            M,
+            "Shader stage '" +
+                Twine(Twine(Triple::getEnvironmentTypeName(
+                          EntryProp.ShaderStage)) +
+                      "' for entry '" + Twine(EntryProp.Entry->getName()) +
+                      "' different from specified target profile '" +
+                      Twine(Triple::getEnvironmentTypeName(MMDI.ShaderProfile) +
+                            "'")));
+  }
+}
+
 PreservedAnalyses DXILValidateMetadata::run(Module &M,
                                             ModuleAnalysisManager &MAM) {
+
+  const dxil::ModuleMetadataInfo MMDI = MAM.getResult<DXILMetadataAnalysis>(M);
+  validateGlobalMetadata(M, MMDI);
   validateInstructionMetadata(M);
 
   return PreservedAnalyses::all();
@@ -65,12 +95,15 @@ class DXILValidateMetadataLegacy : public ModulePass {
   StringRef getPassName() const override { return "DXIL Validate Metadata"; }
 
   void getAnalysisUsage(AnalysisUsage &AU) const override {
+    AU.addRequired<DXILMetadataAnalysisWrapperPass>();
     AU.addRequired<DXILTranslateMetadataLegacy>();
     AU.setPreservesAll();
   }
 
   bool runOnModule(Module &M) override {
-    validateInstructionMetadata();
+    dxil::ModuleMetadataInfo MMDI =
+        getAnalysis<DXILMetadataAnalysisWrapperPass>().getModuleMetadata();
+    validateGlobalMetadata(M, MMDI);
     return true;
   }
 };
@@ -85,6 +118,7 @@ ModulePass *llvm::createDXILValidateMetadataLegacyPass() {
 
 INITIALIZE_PASS_BEGIN(DXILValidateMetadataLegacy, "dxil-validate-metadata",
                       "DXIL Validate Metadata", false, false)
+INITIALIZE_PASS_DEPENDENCY(DXILMetadataAnalysisWrapperPass)
 INITIALIZE_PASS_DEPENDENCY(DXILTranslateMetadataLegacy)
 INITIALIZE_PASS_END(DXILValidateMetadataLegacy, "dxil-validate-metadata",
                     "DXIL validate Metadata", false, false)

llvm/test/CodeGen/DirectX/Metadata/multiple-entries-cs-error.ll

@@ -1,4 +1,4 @@
-; RUN: not opt -S  -S -dxil-translate-metadata %s 2>&1 | FileCheck %s
+; RUN: not opt -S -dxil-validate-metadata %s 2>&1 | FileCheck %s
 target triple = "dxil-pc-shadermodel6.8-compute"
 
 ; CHECK: Non-library shader: One and only one entry expected

llvm/test/CodeGen/DirectX/Metadata/target-profile-error.ll

@@ -1,8 +1,8 @@
-; RUN: not opt -S -dxil-translate-metadata %s 2>&1 | FileCheck %s
+; RUN: not opt -S -dxil-validate-metadata %s 2>&1 | FileCheck %s
 
 target triple = "dxil-pc-shadermodel6.6-pixel"
 
-; CHECK: Shader stage 'cs' for entry 'entry' different from specified target profile 'pixel'
+; CHECK: Shader stage 'compute' for entry 'entry' different from specified target profile 'pixel'
 
 define void @entry() #0 {
 entry: