1// Copyright (c) 2019 Google LLC.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15#ifndef SOURCE_OPT_GENERATE_WEBGPU_INITIALIZERS_PASS_H_
16#define SOURCE_OPT_GENERATE_WEBGPU_INITIALIZERS_PASS_H_
17
18#include "source/opt/ir_context.h"
19#include "source/opt/module.h"
20#include "source/opt/pass.h"
21
22namespace spvtools {
23namespace opt {
24
25// Adds initializers to variables with storage classes Output, Private, and
26// Function if they are missing. In the WebGPU environment these storage classes
27// require that the variables are initialized. Currently they are initialized to
28// NULL, though in the future some of them may be initialized to the first value
29// that is stored in them, if that was a constant.
30class GenerateWebGPUInitializersPass : public Pass {
31 public:
32 const char* name() const override { return "generate-webgpu-initializers"; }
33 Status Process() override;
34
35 IRContext::Analysis GetPreservedAnalyses() override {
36 return IRContext::kAnalysisInstrToBlockMapping |
37 IRContext::kAnalysisDecorations | IRContext::kAnalysisCombinators |
38 IRContext::kAnalysisCFG | IRContext::kAnalysisDominatorAnalysis |
39 IRContext::kAnalysisLoopAnalysis | IRContext::kAnalysisNameMap |
40 IRContext::kAnalysisScalarEvolution |
41 IRContext::kAnalysisRegisterPressure |
42 IRContext::kAnalysisValueNumberTable |
43 IRContext::kAnalysisStructuredCFG |
44 IRContext::kAnalysisBuiltinVarId |
45 IRContext::kAnalysisIdToFuncMapping | IRContext::kAnalysisTypes |
46 IRContext::kAnalysisDefUse | IRContext::kAnalysisConstants;
47 }
48
49 private:
50 using NullConstantTypeMap = std::unordered_map<uint32_t, Instruction*>;
51 NullConstantTypeMap null_constant_type_map_;
52 std::unordered_set<Instruction*> seen_null_constants_;
53
54 Instruction* GetNullConstantForVariable(Instruction* variable_inst);
55 void AddNullInitializerToVariable(Instruction* constant_inst,
56 Instruction* variable_inst);
57};
58
59} // namespace opt
60} // namespace spvtools
61
62#endif // SOURCE_OPT_GENERATE_WEBGPU_INITIALIZERS_PASS_H_
63