1//=- DXILMetadataAnalysis.h - Representation of Module metadata --*- C++ -*-=//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLVM_ANALYSIS_DXILMETADATA_H
10#define LLVM_ANALYSIS_DXILMETADATA_H
11
12#include "llvm/ADT/SmallVector.h"
13#include "llvm/IR/PassManager.h"
14#include "llvm/MC/DXContainerInfo.h"
15#include "llvm/Pass.h"
16#include "llvm/Support/VersionTuple.h"
17#include "llvm/TargetParser/Triple.h"
18
19namespace llvm {
20
21class Function;
22namespace dxil {
23
24struct EntryProperties {
25 const Function *Entry{nullptr};
26 // Specific target shader stage may be specified for entry functions
27 Triple::EnvironmentType ShaderStage{Triple::UnknownEnvironment};
28 unsigned NumThreadsX{0}; // X component
29 unsigned NumThreadsY{0}; // Y component
30 unsigned NumThreadsZ{0}; // Z component
31 unsigned WaveSizeMin{0}; // Minimum component
32 unsigned WaveSizeMax{0}; // Maximum component
33 unsigned WaveSizePref{0}; // Preferred component
34
35 EntryProperties(const Function *Fn = nullptr) : Entry(Fn) {};
36};
37
38struct ModuleMetadataInfo {
39 VersionTuple DXILVersion{};
40 VersionTuple ShaderModelVersion{};
41 Triple::EnvironmentType ShaderProfile{Triple::UnknownEnvironment};
42 VersionTuple ValidatorVersion{};
43 SmallVector<EntryProperties> EntryPropertyVec{};
44 std::optional<mcdxbc::SourceInfoBuilder> SourceInfo;
45 LLVM_ABI void print(raw_ostream &OS) const;
46};
47
48} // namespace dxil
49
50// Module metadata analysis pass for new pass manager
51class DXILMetadataAnalysis : public AnalysisInfoMixin<DXILMetadataAnalysis> {
52 friend AnalysisInfoMixin<DXILMetadataAnalysis>;
53
54 static AnalysisKey Key;
55
56public:
57 using Result = dxil::ModuleMetadataInfo;
58 /// Gather module metadata info for the module \c M.
59 LLVM_ABI dxil::ModuleMetadataInfo run(Module &M, ModuleAnalysisManager &AM);
60};
61
62/// Printer pass for the \c DXILMetadataAnalysis results.
63class DXILMetadataAnalysisPrinterPass
64 : public RequiredPassInfoMixin<DXILMetadataAnalysisPrinterPass> {
65 raw_ostream &OS;
66
67public:
68 explicit DXILMetadataAnalysisPrinterPass(raw_ostream &OS) : OS(OS) {}
69
70 LLVM_ABI PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM);
71};
72
73/// Legacy pass
74class LLVM_ABI DXILMetadataAnalysisWrapperPass : public ModulePass {
75 std::unique_ptr<dxil::ModuleMetadataInfo> MetadataInfo;
76
77public:
78 static char ID; // Class identification, replacement for typeinfo
79
80 DXILMetadataAnalysisWrapperPass();
81 ~DXILMetadataAnalysisWrapperPass() override;
82
83 const dxil::ModuleMetadataInfo &getModuleMetadata() const {
84 return *MetadataInfo;
85 }
86 dxil::ModuleMetadataInfo &getModuleMetadata() { return *MetadataInfo; }
87
88 void getAnalysisUsage(AnalysisUsage &AU) const override;
89 bool runOnModule(Module &M) override;
90 void releaseMemory() override;
91
92 void print(raw_ostream &OS, const Module *M) const override;
93 void dump() const;
94};
95
96} // namespace llvm
97
98#endif // LLVM_ANALYSIS_DXILMETADATA_H
99