1//===-- SPIRV.h - Top-level interface for SPIR-V representation -*- 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_LIB_TARGET_SPIRV_SPIRV_H
10#define LLVM_LIB_TARGET_SPIRV_SPIRV_H
11
12#include "MCTargetDesc/SPIRVMCTargetDesc.h"
13#include "llvm/CodeGen/MachineFunctionAnalysisManager.h"
14#include "llvm/CodeGen/MachinePassManager.h"
15#include "llvm/IR/Analysis.h"
16#include "llvm/IR/PassManager.h"
17#include "llvm/Pass.h"
18#include "llvm/PassRegistry.h"
19#include "llvm/Target/TargetMachine.h"
20
21namespace llvm {
22class SPIRVTargetMachine;
23class SPIRVSubtarget;
24class InstructionSelector;
25class RegisterBankInfo;
26
27class SPIRVPrepareFunctionsPass
28 : public RequiredPassInfoMixin<SPIRVPrepareFunctionsPass> {
29 const SPIRVTargetMachine &TM;
30
31public:
32 explicit SPIRVPrepareFunctionsPass(const SPIRVTargetMachine &TM) : TM(TM) {}
33 PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM);
34};
35
36ModulePass *createSPIRVPrepareFunctionsPass(const SPIRVTargetMachine &TM);
37
38class SPIRVStructurizerPass
39 : public RequiredPassInfoMixin<SPIRVStructurizerPass> {
40public:
41 PreservedAnalyses run(Function &M, FunctionAnalysisManager &AM);
42};
43
44FunctionPass *createSPIRVStructurizerPass();
45
46class SPIRVRemoveUnusedResourcesPass
47 : public RequiredPassInfoMixin<SPIRVRemoveUnusedResourcesPass> {
48public:
49 PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM);
50};
51
52ModulePass *createSPIRVRemoveUnusedResourcesLegacyPass();
53
54class SPIRVCBufferAccessPass
55 : public RequiredPassInfoMixin<SPIRVCBufferAccessPass> {
56public:
57 PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM);
58};
59
60ModulePass *createSPIRVCBufferAccessLegacyPass();
61
62class SPIRVPushConstantAccessPass
63 : public RequiredPassInfoMixin<SPIRVPushConstantAccessPass> {
64 const SPIRVTargetMachine &TM;
65
66public:
67 SPIRVPushConstantAccessPass(const SPIRVTargetMachine &TM) : TM(TM) {}
68 PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM);
69};
70
71ModulePass *createSPIRVPushConstantAccessLegacyPass(SPIRVTargetMachine *TM);
72
73class SPIRVMergeRegionExitTargetsPass
74 : public RequiredPassInfoMixin<SPIRVMergeRegionExitTargetsPass> {
75public:
76 PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM);
77};
78
79FunctionPass *createSPIRVMergeRegionExitTargetsPass();
80
81class SPIRVLegalizeResourceBindingPass
82 : public RequiredPassInfoMixin<SPIRVLegalizeResourceBindingPass> {
83public:
84 PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM);
85};
86
87ModulePass *createSPIRVLegalizeResourceBindingPass();
88
89class SPIRVLegalizeZeroSizeArraysPass
90 : public RequiredPassInfoMixin<SPIRVLegalizeZeroSizeArraysPass> {
91 const SPIRVTargetMachine &TM;
92
93public:
94 SPIRVLegalizeZeroSizeArraysPass(const SPIRVTargetMachine &TM) : TM(TM) {}
95 PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM);
96};
97
98ModulePass *createSPIRVLegalizeZeroSizeArraysPass(const SPIRVTargetMachine &TM);
99
100class SPIRVFinalizeShaderLinkagePass
101 : public RequiredPassInfoMixin<SPIRVFinalizeShaderLinkagePass> {
102 const SPIRVTargetMachine &TM;
103
104public:
105 SPIRVFinalizeShaderLinkagePass(const SPIRVTargetMachine &TM) : TM(TM) {}
106 PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM);
107};
108
109ModulePass *createSPIRVFinalizeShaderLinkagePass(const SPIRVTargetMachine &TM);
110
111class SPIRVLegalizePointerCastPass
112 : public RequiredPassInfoMixin<SPIRVLegalizePointerCastPass> {
113 const SPIRVTargetMachine &TM;
114
115public:
116 explicit SPIRVLegalizePointerCastPass(const SPIRVTargetMachine &TM)
117 : TM(TM) {}
118 PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM);
119};
120
121FunctionPass *createSPIRVLegalizePointerCastPass(SPIRVTargetMachine *TM);
122
123class SPIRVRegularizerPass
124 : public RequiredPassInfoMixin<SPIRVRegularizerPass> {
125public:
126 PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM);
127};
128
129FunctionPass *createSPIRVRegularizerPass();
130
131class SPIRVPreLegalizerPass
132 : public RequiredPassInfoMixin<SPIRVPreLegalizerPass> {
133public:
134 PreservedAnalyses run(MachineFunction &MF,
135 MachineFunctionAnalysisManager &MFAM);
136};
137
138FunctionPass *createSPIRVPreLegalizerLegacyPass();
139
140class SPIRVPreLegalizerCombinerPass
141 : public RequiredPassInfoMixin<SPIRVPreLegalizerCombinerPass> {
142public:
143 PreservedAnalyses run(MachineFunction &MF,
144 MachineFunctionAnalysisManager &MFAM);
145};
146
147FunctionPass *createSPIRVPreLegalizerCombinerLegacyPass();
148
149class SPIRVPostLegalizerPass
150 : public RequiredPassInfoMixin<SPIRVPostLegalizerPass> {
151public:
152 PreservedAnalyses run(MachineFunction &MF,
153 MachineFunctionAnalysisManager &MFAM);
154 // Register classes are final from here, as there is no RegBankSelect.
155 MachineFunctionProperties getSetProperties() const {
156 return MachineFunctionProperties().setRegBankSelected();
157 }
158};
159
160FunctionPass *createSPIRVPostLegalizerLegacyPass();
161
162/// Rewrites MIR into the form SPIRVModuleAnalysis expects.
163class SPIRVPrepareModuleAnalysisPass
164 : public RequiredPassInfoMixin<SPIRVPrepareModuleAnalysisPass> {
165public:
166 PreservedAnalyses run(MachineFunction &MF,
167 MachineFunctionAnalysisManager &MFAM);
168};
169
170FunctionPass *createSPIRVPrepareModuleAnalysisLegacyPass();
171
172class SPIRVEmitIntrinsicsPass
173 : public RequiredPassInfoMixin<SPIRVEmitIntrinsicsPass> {
174 const SPIRVTargetMachine &TM;
175
176public:
177 SPIRVEmitIntrinsicsPass(const SPIRVTargetMachine &TM) : TM(TM) {}
178 PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM);
179};
180
181ModulePass *createSPIRVEmitIntrinsicsPass(const SPIRVTargetMachine &TM);
182
183class SPIRVPrepareGlobalsPass
184 : public RequiredPassInfoMixin<SPIRVPrepareGlobalsPass> {
185public:
186 PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM);
187};
188
189ModulePass *createSPIRVPrepareGlobalsPass();
190
191/// Lower llvm.global_ctors and llvm.global_dtors to special kernels.
192class SPIRVCtorDtorLoweringPass
193 : public RequiredPassInfoMixin<SPIRVCtorDtorLoweringPass> {
194public:
195 PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM);
196};
197
198ModulePass *createSPIRVCtorDtorLoweringLegacyPass();
199InstructionSelector *
200createSPIRVInstructionSelector(const SPIRVTargetMachine &TM,
201 const SPIRVSubtarget &Subtarget,
202 const RegisterBankInfo &RBI);
203
204void initializeSPIRVModuleAnalysisWrapperPassPass(PassRegistry &);
205void initializeSPIRVAsmPrinterPass(PassRegistry &);
206void initializeSPIRVConvergenceRegionAnalysisWrapperPassPass(PassRegistry &);
207void initializeSPIRVPreLegalizerLegacyPass(PassRegistry &);
208void initializeSPIRVPreLegalizerCombinerLegacyPass(PassRegistry &);
209void initializeSPIRVPostLegalizerLegacyPass(PassRegistry &);
210void initializeSPIRVPrepareModuleAnalysisLegacyPass(PassRegistry &);
211void initializeSPIRVStructurizerPass(PassRegistry &);
212void initializeSPIRVCBufferAccessLegacyPass(PassRegistry &);
213void initializeSPIRVRemoveUnusedResourcesLegacyPass(PassRegistry &);
214void initializeSPIRVPushConstantAccessLegacyPass(PassRegistry &);
215void initializeSPIRVEmitIntrinsicsLegacyPass(PassRegistry &);
216void initializeSPIRVLegalizePointerCastLegacyPass(PassRegistry &);
217void initializeSPIRVRegularizerLegacyPass(PassRegistry &);
218void initializeSPIRVMergeRegionExitTargetsLegacyPass(PassRegistry &);
219void initializeSPIRVPrepareFunctionsLegacyPass(PassRegistry &);
220void initializeSPIRVPrepareGlobalsLegacyPass(PassRegistry &);
221void initializeSPIRVLegalizeResourceBindingLegacyPass(PassRegistry &);
222void initializeSPIRVLegalizeZeroSizeArraysLegacyPass(PassRegistry &);
223void initializeSPIRVFinalizeShaderLinkageLegacyPass(PassRegistry &);
224void initializeSPIRVCtorDtorLoweringLegacyPass(PassRegistry &);
225} // namespace llvm
226
227#endif // LLVM_LIB_TARGET_SPIRV_SPIRV_H
228