[DirectX backend] Add analysis to collect DXILResources

[python3kgae]

Summary

Now only DXILTranslateMetadata uses DXILResources, so DXILResourceWrapper is only used by DXILTranslateMetadata.
Once we add lower for createHandle, DXILResourceWrapper will be used in more passes.
Also we can add resource index allocation in DXILResourceWrapper.

[python3kgae]

Add printer pass for test

[beanz]

llvm/lib/Target/DirectX/DXILResource.cpp

65 ↗

(On Diff #465239)

How difficult would it be go make the printed output here look more like DXC's disassembly output? It would be very convenient if we could use the printer pass to generate the disassembly printing too.

llvm/lib/Target/DirectX/DXILResource.h

56 ↗

(On Diff #465239)

Maybe rather than print we make these dump functions that default to dbgs(), then we can print them in the debugger.

llvm/lib/Target/DirectX/DXILResourceAnalysis.h

42

This being a pointer is unfortunate. If you change dxil::Resources to not store a reference to the module (which it probably doesn't need), you could add a public collect method and change it to have a constructor that takes the module and a default constructor that doesn't collect the resources.

[python3kgae]

Change print format.
Add Resources::collect and dump.

[python3kgae]

Fix clang-format

[beanz]

llvm/lib/Target/DirectX/DXILResource.cpp

70 ↗

(On Diff #465626)

Instead of a static array if you use a switch statement we don't need the asserts above.

101 ↗

(On Diff #465626)

Using a switch here makes sense too.

176 ↗

(On Diff #465626)

"comment" is a lot longer to write than just adding a ; to the front of the lines, and just including it in the string avoids double-calling operator<<

292 ↗

(On Diff #465626)

here too

llvm/lib/Target/DirectX/DXILResource.h

83 ↗

(On Diff #465626)

84 ↗

(On Diff #465626)

115 ↗

(On Diff #465626)

[beanz]

llvm/lib/Target/DirectX/DXILResource.h

165 ↗

(On Diff #465626)

Include llvm/Support/Compiler.h so that LLVM_DUMP_METHOD is properly defined to make the dump method not stripped in debug builds.

[python3kgae]

Use switch instead of static array.

[beanz]

A few last really nitpicky whitespace issues. Otherwise looks good.

llvm/lib/Target/DirectX/DXILResource.cpp

347 ↗

(On Diff #465922)

nit: please add a blank line between functions.

llvm/lib/Target/DirectX/DXILResourceAnalysis.cpp

28

nit: blank line here too

47

nit: blank line here too

llvm/lib/Target/DirectX/DXILTranslateMetadata.cpp

31–34

nit: blank lines before and after this function too.

[python3kgae]

Add space between functions.

[python3kgae]

clang-format

llvm/lib/Target/DirectX/CMakeLists.txt

add_llvm_target(DirectXCodeGen
   DirectXRegisterInfo.cpp
   DirectXSubtarget.cpp
   DirectXTargetMachine.cpp
   DXILMetadata.cpp
   DXILOpBuilder.cpp
   DXILOpLowering.cpp
   DXILPrepare.cpp
   DXILResource.cpp
+  DXILResourceAnalysis.cpp
   DXILTranslateMetadata.cpp
   PointerTypeAnalysis.cpp
 
   LINK_COMPONENTS
   AsmPrinter
   Core
   SelectionDAG
   Support

llvm/lib/Target/DirectX/DXILResourceAnalysis.h

+//===- DXILResourceAnalysis.h   - DXIL Resource analysis-------------------===//
+//
+// 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 Analysis for information about DXIL resources.
+///
+//===----------------------------------------------------------------------===//
+
+#include "DXILResource.h"
+#include "llvm/IR/PassManager.h"
+#include "llvm/Pass.h"
+#include <memory>
+
+namespace llvm {
+/// Analysis pass that exposes the \c DXILResource for a module.
+class DXILResourceAnalysis : public AnalysisInfoMixin<DXILResourceAnalysis> {
+  friend AnalysisInfoMixin<DXILResourceAnalysis>;
+  static AnalysisKey Key;
+
+public:
+  dxil::Resources run(Module &M, ModuleAnalysisManager &AM);
+};
+
+/// The legacy pass manager's analysis pass to compute DXIL resource
+/// information.
+class DXILResourceWrapper : public ModulePass {
+  std::unique_ptr<dxil::Resources> Resources;
+
+public:
+  static char ID; // Pass identification, replacement for typeid
+
+  DXILResourceWrapper();
+
+  dxil::Resources *getDXILResource() { return Resources.get(); }
+  const dxil::Resources *getDXILResource() const { return Resources.get(); }
+
+  /// Calculate the DXILResource for the module.
+  bool runOnModule(Module &M) override;
+};
+} // namespace llvm

llvm/lib/Target/DirectX/DXILResourceAnalysis.cpp

+//===- DXILResourceAnalysis.cpp - DXIL Resource analysis-------------------===//
+//
+// 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 Analysis for information about DXIL resources.
+///
+//===----------------------------------------------------------------------===//
+
+#include "DXILResourceAnalysis.h"
+#include "DirectX.h"
+
+using namespace llvm;
+
+#define DEBUG_TYPE "dxil-resource-analysis"
+
+dxil::Resources DXILResourceAnalysis::run(Module &M,
+                                          ModuleAnalysisManager &AM) {
+  return dxil::Resources(M);
+}
+AnalysisKey DXILResourceAnalysis::Key;
+
+char DXILResourceWrapper::ID = 0;
+INITIALIZE_PASS_BEGIN(DXILResourceWrapper, DEBUG_TYPE,
+                      "DXIL resource Information", true, true)
+INITIALIZE_PASS_END(DXILResourceWrapper, DEBUG_TYPE,
+                    "DXIL resource Information", true, true)
+
+bool DXILResourceWrapper::runOnModule(Module &M) {
+  Resources = std::make_unique<dxil::Resources>(M);
+  return false;
+}
+DXILResourceWrapper::DXILResourceWrapper()
+    : ModulePass(ID), Resources(nullptr) {}

llvm/lib/Target/DirectX/DXILTranslateMetadata.cpp

 //===- DXILTranslateMetadata.cpp - Pass to emit DXIL metadata ---*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
 ///
 //===----------------------------------------------------------------------===//
 
 #include "DXILMetadata.h"
 #include "DXILResource.h"
+#include "DXILResourceAnalysis.h"
 #include "DirectX.h"
 #include "llvm/ADT/StringSet.h"
 #include "llvm/ADT/Triple.h"
 #include "llvm/IR/Constants.h"
 #include "llvm/IR/Metadata.h"
 #include "llvm/IR/Module.h"
 #include "llvm/Pass.h"
 
 using namespace llvm;
 
 namespace {
 class DXILTranslateMetadata : public ModulePass {
 public:
   static char ID; // Pass identification, replacement for typeid
   explicit DXILTranslateMetadata() : ModulePass(ID) {}
 
   StringRef getPassName() const override { return "DXIL Metadata Emit"; }
-
+  void getAnalysisUsage(AnalysisUsage &AU) const override {
+    AU.setPreservesAll();
+    AU.addRequired<DXILResourceWrapper>();
+  }
   bool runOnModule(Module &M) override;
 };
 
 } // namespace
 
 bool DXILTranslateMetadata::runOnModule(Module &M) {
 
   dxil::ValidatorVersionMD ValVerMD(M);
   if (ValVerMD.isEmpty())
     ValVerMD.update(VersionTuple(1, 0));
   dxil::createShaderModelMD(M);
 
-  dxil::Resources Res(M);
-  Res.write();
+  if (dxil::Resources *Res =
+          getAnalysis<DXILResourceWrapper>().getDXILResource())
+    Res->write();
   return false;
 }
 
 char DXILTranslateMetadata::ID = 0;
 
 ModulePass *llvm::createDXILTranslateMetadataPass() {
   return new DXILTranslateMetadata();
 }
 
-INITIALIZE_PASS(DXILTranslateMetadata, "dxil-metadata-emit",
+INITIALIZE_PASS_BEGIN(DXILTranslateMetadata, "dxil-metadata-emit",
+                      "DXIL Metadata Emit", false, false)
+INITIALIZE_PASS_DEPENDENCY(DXILResourceWrapper)
+INITIALIZE_PASS_END(DXILTranslateMetadata, "dxil-metadata-emit",
                     "DXIL Metadata Emit", false, false)

llvm/lib/Target/DirectX/DirectX.h

 /// Pass to lowering LLVM intrinsic call to DXIL op function call.
 ModulePass *createDXILOpLoweringLegacyPass();
 
 /// Initializer for DXILTranslateMetadata.
 void initializeDXILTranslateMetadataPass(PassRegistry &);
 
 /// Pass to emit metadata for DXIL.
 ModulePass *createDXILTranslateMetadataPass();
+
+/// Initializer for DXILTranslateMetadata.
+void initializeDXILResourceWrapperPass(PassRegistry &);
+
 } // namespace llvm
 
 #endif // LLVM_LIB_TARGET_DIRECTX_DIRECTX_H

llvm/lib/Target/DirectX/DirectXTargetMachine.cpp

 
 extern "C" LLVM_EXTERNAL_VISIBILITY void LLVMInitializeDirectXTarget() {
   RegisterTargetMachine<DirectXTargetMachine> X(getTheDirectXTarget());
   auto *PR = PassRegistry::getPassRegistry();
   initializeDXILPrepareModulePass(*PR);
   initializeEmbedDXILPassPass(*PR);
   initializeDXILOpLoweringLegacyPass(*PR);
   initializeDXILTranslateMetadataPass(*PR);
+  initializeDXILResourceWrapperPass(*PR);
 }
 
 class DXILTargetObjectFile : public TargetLoweringObjectFile {
 public:
   DXILTargetObjectFile() = default;
 
   MCSection *getExplicitSectionGlobal(const GlobalObject *GO, SectionKind Kind,
                                       const TargetMachine &TM) const override {