• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 //
2 // Copyright (C) 2014-2016 LunarG, Inc.
3 // Copyright (C) 2015-2020 Google, Inc.
4 // Copyright (C) 2017 ARM Limited.
5 // Modifications Copyright (C) 2020 Advanced Micro Devices, Inc. All rights reserved.
6 //
7 // All rights reserved.
8 //
9 // Redistribution and use in source and binary forms, with or without
10 // modification, are permitted provided that the following conditions
11 // are met:
12 //
13 //    Redistributions of source code must retain the above copyright
14 //    notice, this list of conditions and the following disclaimer.
15 //
16 //    Redistributions in binary form must reproduce the above
17 //    copyright notice, this list of conditions and the following
18 //    disclaimer in the documentation and/or other materials provided
19 //    with the distribution.
20 //
21 //    Neither the name of 3Dlabs Inc. Ltd. nor the names of its
22 //    contributors may be used to endorse or promote products derived
23 //    from this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
28 // FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29 // COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
30 // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31 // BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32 // LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33 // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 // LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
35 // ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 // POSSIBILITY OF SUCH DAMAGE.
37 
38 //
39 // Visit the nodes in the glslang intermediate tree representation to
40 // translate them to SPIR-V.
41 //
42 
43 #include "spirv.hpp"
44 #include "GlslangToSpv.h"
45 #include "SpvBuilder.h"
46 namespace spv {
47     #include "GLSL.std.450.h"
48     #include "GLSL.ext.KHR.h"
49     #include "GLSL.ext.EXT.h"
50     #include "GLSL.ext.AMD.h"
51     #include "GLSL.ext.NV.h"
52     #include "NonSemanticDebugPrintf.h"
53 }
54 
55 // Glslang includes
56 #include "../glslang/MachineIndependent/localintermediate.h"
57 #include "../glslang/MachineIndependent/SymbolTable.h"
58 #include "../glslang/Include/Common.h"
59 
60 // Build-time generated includes
61 #include "glslang/build_info.h"
62 
63 #include <fstream>
64 #include <iomanip>
65 #include <list>
66 #include <map>
67 #include <stack>
68 #include <string>
69 #include <vector>
70 
71 namespace {
72 
73 namespace {
74 class SpecConstantOpModeGuard {
75 public:
SpecConstantOpModeGuard(spv::Builder * builder)76     SpecConstantOpModeGuard(spv::Builder* builder)
77         : builder_(builder) {
78         previous_flag_ = builder->isInSpecConstCodeGenMode();
79     }
~SpecConstantOpModeGuard()80     ~SpecConstantOpModeGuard() {
81         previous_flag_ ? builder_->setToSpecConstCodeGenMode()
82                        : builder_->setToNormalCodeGenMode();
83     }
turnOnSpecConstantOpMode()84     void turnOnSpecConstantOpMode() {
85         builder_->setToSpecConstCodeGenMode();
86     }
87 
88 private:
89     spv::Builder* builder_;
90     bool previous_flag_;
91 };
92 
93 struct OpDecorations {
94     public:
OpDecorations__anon9a371beb0111::__anon9a371beb0211::OpDecorations95         OpDecorations(spv::Decoration precision, spv::Decoration noContraction, spv::Decoration nonUniform) :
96             precision(precision)
97 #ifndef GLSLANG_WEB
98             ,
99             noContraction(noContraction),
100             nonUniform(nonUniform)
101 #endif
102         { }
103 
104     spv::Decoration precision;
105 
106 #ifdef GLSLANG_WEB
addNoContraction__anon9a371beb0111::__anon9a371beb0211::OpDecorations107         void addNoContraction(spv::Builder&, spv::Id) const { }
addNonUniform__anon9a371beb0111::__anon9a371beb0211::OpDecorations108         void addNonUniform(spv::Builder&, spv::Id) const { }
109 #else
addNoContraction__anon9a371beb0111::__anon9a371beb0211::OpDecorations110         void addNoContraction(spv::Builder& builder, spv::Id t) { builder.addDecoration(t, noContraction); }
addNonUniform__anon9a371beb0111::__anon9a371beb0211::OpDecorations111         void addNonUniform(spv::Builder& builder, spv::Id t)  { builder.addDecoration(t, nonUniform); }
112     protected:
113         spv::Decoration noContraction;
114         spv::Decoration nonUniform;
115 #endif
116 
117 };
118 
119 } // namespace
120 
121 //
122 // The main holder of information for translating glslang to SPIR-V.
123 //
124 // Derives from the AST walking base class.
125 //
126 class TGlslangToSpvTraverser : public glslang::TIntermTraverser {
127 public:
128     TGlslangToSpvTraverser(unsigned int spvVersion, const glslang::TIntermediate*, spv::SpvBuildLogger* logger,
129         glslang::SpvOptions& options);
~TGlslangToSpvTraverser()130     virtual ~TGlslangToSpvTraverser() { }
131 
132     bool visitAggregate(glslang::TVisit, glslang::TIntermAggregate*);
133     bool visitBinary(glslang::TVisit, glslang::TIntermBinary*);
134     void visitConstantUnion(glslang::TIntermConstantUnion*);
135     bool visitSelection(glslang::TVisit, glslang::TIntermSelection*);
136     bool visitSwitch(glslang::TVisit, glslang::TIntermSwitch*);
137     void visitSymbol(glslang::TIntermSymbol* symbol);
138     bool visitUnary(glslang::TVisit, glslang::TIntermUnary*);
139     bool visitLoop(glslang::TVisit, glslang::TIntermLoop*);
140     bool visitBranch(glslang::TVisit visit, glslang::TIntermBranch*);
141 
142     void finishSpv();
143     void dumpSpv(std::vector<unsigned int>& out);
144 
145 protected:
146     TGlslangToSpvTraverser(TGlslangToSpvTraverser&);
147     TGlslangToSpvTraverser& operator=(TGlslangToSpvTraverser&);
148 
149     spv::Decoration TranslateInterpolationDecoration(const glslang::TQualifier& qualifier);
150     spv::Decoration TranslateAuxiliaryStorageDecoration(const glslang::TQualifier& qualifier);
151     spv::Decoration TranslateNonUniformDecoration(const glslang::TQualifier& qualifier);
152     spv::Decoration TranslateNonUniformDecoration(const spv::Builder::AccessChain::CoherentFlags& coherentFlags);
153     spv::Builder::AccessChain::CoherentFlags TranslateCoherent(const glslang::TType& type);
154     spv::MemoryAccessMask TranslateMemoryAccess(const spv::Builder::AccessChain::CoherentFlags &coherentFlags);
155     spv::ImageOperandsMask TranslateImageOperands(const spv::Builder::AccessChain::CoherentFlags &coherentFlags);
156     spv::Scope TranslateMemoryScope(const spv::Builder::AccessChain::CoherentFlags &coherentFlags);
157     spv::BuiltIn TranslateBuiltInDecoration(glslang::TBuiltInVariable, bool memberDeclaration);
158     spv::ImageFormat TranslateImageFormat(const glslang::TType& type);
159     spv::SelectionControlMask TranslateSelectionControl(const glslang::TIntermSelection&) const;
160     spv::SelectionControlMask TranslateSwitchControl(const glslang::TIntermSwitch&) const;
161     spv::LoopControlMask TranslateLoopControl(const glslang::TIntermLoop&, std::vector<unsigned int>& operands) const;
162     spv::StorageClass TranslateStorageClass(const glslang::TType&);
163     void TranslateLiterals(const glslang::TVector<const glslang::TIntermConstantUnion*>&, std::vector<unsigned>&) const;
164     void addIndirectionIndexCapabilities(const glslang::TType& baseType, const glslang::TType& indexType);
165     spv::Id createSpvVariable(const glslang::TIntermSymbol*, spv::Id forcedType);
166     spv::Id getSampledType(const glslang::TSampler&);
167     spv::Id getInvertedSwizzleType(const glslang::TIntermTyped&);
168     spv::Id createInvertedSwizzle(spv::Decoration precision, const glslang::TIntermTyped&, spv::Id parentResult);
169     void convertSwizzle(const glslang::TIntermAggregate&, std::vector<unsigned>& swizzle);
170     spv::Id convertGlslangToSpvType(const glslang::TType& type, bool forwardReferenceOnly = false);
171     spv::Id convertGlslangToSpvType(const glslang::TType& type, glslang::TLayoutPacking, const glslang::TQualifier&,
172         bool lastBufferBlockMember, bool forwardReferenceOnly = false);
173     bool filterMember(const glslang::TType& member);
174     spv::Id convertGlslangStructToSpvType(const glslang::TType&, const glslang::TTypeList* glslangStruct,
175                                           glslang::TLayoutPacking, const glslang::TQualifier&);
176     void decorateStructType(const glslang::TType&, const glslang::TTypeList* glslangStruct, glslang::TLayoutPacking,
177                             const glslang::TQualifier&, spv::Id);
178     spv::Id makeArraySizeId(const glslang::TArraySizes&, int dim);
179     spv::Id accessChainLoad(const glslang::TType& type);
180     void    accessChainStore(const glslang::TType& type, spv::Id rvalue);
181     void multiTypeStore(const glslang::TType&, spv::Id rValue);
182     spv::Id convertLoadedBoolInUniformToUint(const glslang::TType& type, spv::Id nominalTypeId, spv::Id loadedId);
183     glslang::TLayoutPacking getExplicitLayout(const glslang::TType& type) const;
184     int getArrayStride(const glslang::TType& arrayType, glslang::TLayoutPacking, glslang::TLayoutMatrix);
185     int getMatrixStride(const glslang::TType& matrixType, glslang::TLayoutPacking, glslang::TLayoutMatrix);
186     void updateMemberOffset(const glslang::TType& structType, const glslang::TType& memberType, int& currentOffset,
187                             int& nextOffset, glslang::TLayoutPacking, glslang::TLayoutMatrix);
188     void declareUseOfStructMember(const glslang::TTypeList& members, int glslangMember);
189 
190     bool isShaderEntryPoint(const glslang::TIntermAggregate* node);
191     bool writableParam(glslang::TStorageQualifier) const;
192     bool originalParam(glslang::TStorageQualifier, const glslang::TType&, bool implicitThisParam);
193     void makeFunctions(const glslang::TIntermSequence&);
194     void makeGlobalInitializers(const glslang::TIntermSequence&);
195     void collectRayTracingLinkerObjects();
196     void visitFunctions(const glslang::TIntermSequence&);
197     void handleFunctionEntry(const glslang::TIntermAggregate* node);
198     void translateArguments(const glslang::TIntermAggregate& node, std::vector<spv::Id>& arguments,
199         spv::Builder::AccessChain::CoherentFlags &lvalueCoherentFlags);
200     void translateArguments(glslang::TIntermUnary& node, std::vector<spv::Id>& arguments);
201     spv::Id createImageTextureFunctionCall(glslang::TIntermOperator* node);
202     spv::Id handleUserFunctionCall(const glslang::TIntermAggregate*);
203 
204     spv::Id createBinaryOperation(glslang::TOperator op, OpDecorations&, spv::Id typeId, spv::Id left, spv::Id right,
205                                   glslang::TBasicType typeProxy, bool reduceComparison = true);
206     spv::Id createBinaryMatrixOperation(spv::Op, OpDecorations&, spv::Id typeId, spv::Id left, spv::Id right);
207     spv::Id createUnaryOperation(glslang::TOperator op, OpDecorations&, spv::Id typeId, spv::Id operand,
208                                  glslang::TBasicType typeProxy,
209                                  const spv::Builder::AccessChain::CoherentFlags &lvalueCoherentFlags);
210     spv::Id createUnaryMatrixOperation(spv::Op op, OpDecorations&, spv::Id typeId, spv::Id operand,
211                                        glslang::TBasicType typeProxy);
212     spv::Id createConversion(glslang::TOperator op, OpDecorations&, spv::Id destTypeId, spv::Id operand,
213                              glslang::TBasicType typeProxy);
214     spv::Id createIntWidthConversion(glslang::TOperator op, spv::Id operand, int vectorSize);
215     spv::Id makeSmearedConstant(spv::Id constant, int vectorSize);
216     spv::Id createAtomicOperation(glslang::TOperator op, spv::Decoration precision, spv::Id typeId,
217         std::vector<spv::Id>& operands, glslang::TBasicType typeProxy,
218         const spv::Builder::AccessChain::CoherentFlags &lvalueCoherentFlags);
219     spv::Id createInvocationsOperation(glslang::TOperator op, spv::Id typeId, std::vector<spv::Id>& operands,
220         glslang::TBasicType typeProxy);
221     spv::Id CreateInvocationsVectorOperation(spv::Op op, spv::GroupOperation groupOperation,
222         spv::Id typeId, std::vector<spv::Id>& operands);
223     spv::Id createSubgroupOperation(glslang::TOperator op, spv::Id typeId, std::vector<spv::Id>& operands,
224         glslang::TBasicType typeProxy);
225     spv::Id createMiscOperation(glslang::TOperator op, spv::Decoration precision, spv::Id typeId,
226         std::vector<spv::Id>& operands, glslang::TBasicType typeProxy);
227     spv::Id createNoArgOperation(glslang::TOperator op, spv::Decoration precision, spv::Id typeId);
228     spv::Id getSymbolId(const glslang::TIntermSymbol* node);
229     void addMeshNVDecoration(spv::Id id, int member, const glslang::TQualifier & qualifier);
230     spv::Id createSpvConstant(const glslang::TIntermTyped&);
231     spv::Id createSpvConstantFromConstUnionArray(const glslang::TType& type, const glslang::TConstUnionArray&,
232         int& nextConst, bool specConstant);
233     bool isTrivialLeaf(const glslang::TIntermTyped* node);
234     bool isTrivial(const glslang::TIntermTyped* node);
235     spv::Id createShortCircuit(glslang::TOperator, glslang::TIntermTyped& left, glslang::TIntermTyped& right);
236     spv::Id getExtBuiltins(const char* name);
237     std::pair<spv::Id, spv::Id> getForcedType(glslang::TBuiltInVariable builtIn, const glslang::TType&);
238     spv::Id translateForcedType(spv::Id object);
239     spv::Id createCompositeConstruct(spv::Id typeId, std::vector<spv::Id> constituents);
240 
241     glslang::SpvOptions& options;
242     spv::Function* shaderEntry;
243     spv::Function* currentFunction;
244     spv::Instruction* entryPoint;
245     int sequenceDepth;
246 
247     spv::SpvBuildLogger* logger;
248 
249     // There is a 1:1 mapping between a spv builder and a module; this is thread safe
250     spv::Builder builder;
251     bool inEntryPoint;
252     bool entryPointTerminated;
253     bool linkageOnly;                  // true when visiting the set of objects in the AST present only for
254                                        // establishing interface, whether or not they were statically used
255     std::set<spv::Id> iOSet;           // all input/output variables from either static use or declaration of interface
256     const glslang::TIntermediate* glslangIntermediate;
257     bool nanMinMaxClamp;               // true if use NMin/NMax/NClamp instead of FMin/FMax/FClamp
258     spv::Id stdBuiltins;
259     spv::Id nonSemanticDebugPrintf;
260     std::unordered_map<std::string, spv::Id> extBuiltinMap;
261 
262     std::unordered_map<long long, spv::Id> symbolValues;
263     std::unordered_set<long long> rValueParameters;  // set of formal function parameters passed as rValues,
264                                                // rather than a pointer
265     std::unordered_map<std::string, spv::Function*> functionMap;
266     std::unordered_map<const glslang::TTypeList*, spv::Id> structMap[glslang::ElpCount][glslang::ElmCount];
267     // for mapping glslang block indices to spv indices (e.g., due to hidden members):
268     std::unordered_map<long long, std::vector<int>> memberRemapper;
269     // for mapping glslang symbol struct to symbol Id
270     std::unordered_map<const glslang::TTypeList*, long long> glslangTypeToIdMap;
271     std::stack<bool> breakForLoop;  // false means break for switch
272     std::unordered_map<std::string, const glslang::TIntermSymbol*> counterOriginator;
273     // Map pointee types for EbtReference to their forward pointers
274     std::map<const glslang::TType *, spv::Id> forwardPointers;
275     // Type forcing, for when SPIR-V wants a different type than the AST,
276     // requiring local translation to and from SPIR-V type on every access.
277     // Maps <builtin-variable-id -> AST-required-type-id>
278     std::unordered_map<spv::Id, spv::Id> forceType;
279 
280     // Used later for generating OpTraceKHR/OpExecuteCallableKHR
281     std::unordered_map<unsigned int, glslang::TIntermSymbol *> locationToSymbol[2];
282 };
283 
284 //
285 // Helper functions for translating glslang representations to SPIR-V enumerants.
286 //
287 
288 // Translate glslang profile to SPIR-V source language.
TranslateSourceLanguage(glslang::EShSource source,EProfile profile)289 spv::SourceLanguage TranslateSourceLanguage(glslang::EShSource source, EProfile profile)
290 {
291 #ifdef GLSLANG_WEB
292     return spv::SourceLanguageESSL;
293 #elif defined(GLSLANG_ANGLE)
294     return spv::SourceLanguageGLSL;
295 #endif
296 
297     switch (source) {
298     case glslang::EShSourceGlsl:
299         switch (profile) {
300         case ENoProfile:
301         case ECoreProfile:
302         case ECompatibilityProfile:
303             return spv::SourceLanguageGLSL;
304         case EEsProfile:
305             return spv::SourceLanguageESSL;
306         default:
307             return spv::SourceLanguageUnknown;
308         }
309     case glslang::EShSourceHlsl:
310         return spv::SourceLanguageHLSL;
311     default:
312         return spv::SourceLanguageUnknown;
313     }
314 }
315 
316 // Translate glslang language (stage) to SPIR-V execution model.
TranslateExecutionModel(EShLanguage stage)317 spv::ExecutionModel TranslateExecutionModel(EShLanguage stage)
318 {
319     switch (stage) {
320     case EShLangVertex:           return spv::ExecutionModelVertex;
321     case EShLangFragment:         return spv::ExecutionModelFragment;
322     case EShLangCompute:          return spv::ExecutionModelGLCompute;
323 #ifndef GLSLANG_WEB
324     case EShLangTessControl:      return spv::ExecutionModelTessellationControl;
325     case EShLangTessEvaluation:   return spv::ExecutionModelTessellationEvaluation;
326     case EShLangGeometry:         return spv::ExecutionModelGeometry;
327     case EShLangRayGen:           return spv::ExecutionModelRayGenerationKHR;
328     case EShLangIntersect:        return spv::ExecutionModelIntersectionKHR;
329     case EShLangAnyHit:           return spv::ExecutionModelAnyHitKHR;
330     case EShLangClosestHit:       return spv::ExecutionModelClosestHitKHR;
331     case EShLangMiss:             return spv::ExecutionModelMissKHR;
332     case EShLangCallable:         return spv::ExecutionModelCallableKHR;
333     case EShLangTaskNV:           return spv::ExecutionModelTaskNV;
334     case EShLangMeshNV:           return spv::ExecutionModelMeshNV;
335 #endif
336     default:
337         assert(0);
338         return spv::ExecutionModelFragment;
339     }
340 }
341 
342 // Translate glslang sampler type to SPIR-V dimensionality.
TranslateDimensionality(const glslang::TSampler & sampler)343 spv::Dim TranslateDimensionality(const glslang::TSampler& sampler)
344 {
345     switch (sampler.dim) {
346     case glslang::Esd1D:      return spv::Dim1D;
347     case glslang::Esd2D:      return spv::Dim2D;
348     case glslang::Esd3D:      return spv::Dim3D;
349     case glslang::EsdCube:    return spv::DimCube;
350     case glslang::EsdRect:    return spv::DimRect;
351     case glslang::EsdBuffer:  return spv::DimBuffer;
352     case glslang::EsdSubpass: return spv::DimSubpassData;
353     default:
354         assert(0);
355         return spv::Dim2D;
356     }
357 }
358 
359 // Translate glslang precision to SPIR-V precision decorations.
TranslatePrecisionDecoration(glslang::TPrecisionQualifier glslangPrecision)360 spv::Decoration TranslatePrecisionDecoration(glslang::TPrecisionQualifier glslangPrecision)
361 {
362     switch (glslangPrecision) {
363     case glslang::EpqLow:    return spv::DecorationRelaxedPrecision;
364     case glslang::EpqMedium: return spv::DecorationRelaxedPrecision;
365     default:
366         return spv::NoPrecision;
367     }
368 }
369 
370 // Translate glslang type to SPIR-V precision decorations.
TranslatePrecisionDecoration(const glslang::TType & type)371 spv::Decoration TranslatePrecisionDecoration(const glslang::TType& type)
372 {
373     return TranslatePrecisionDecoration(type.getQualifier().precision);
374 }
375 
376 // Translate glslang type to SPIR-V block decorations.
TranslateBlockDecoration(const glslang::TType & type,bool useStorageBuffer)377 spv::Decoration TranslateBlockDecoration(const glslang::TType& type, bool useStorageBuffer)
378 {
379     if (type.getBasicType() == glslang::EbtBlock) {
380         switch (type.getQualifier().storage) {
381         case glslang::EvqUniform:      return spv::DecorationBlock;
382         case glslang::EvqBuffer:       return useStorageBuffer ? spv::DecorationBlock : spv::DecorationBufferBlock;
383         case glslang::EvqVaryingIn:    return spv::DecorationBlock;
384         case glslang::EvqVaryingOut:   return spv::DecorationBlock;
385         case glslang::EvqShared:       return spv::DecorationBlock;
386 #ifndef GLSLANG_WEB
387         case glslang::EvqPayload:      return spv::DecorationBlock;
388         case glslang::EvqPayloadIn:    return spv::DecorationBlock;
389         case glslang::EvqHitAttr:      return spv::DecorationBlock;
390         case glslang::EvqCallableData:   return spv::DecorationBlock;
391         case glslang::EvqCallableDataIn: return spv::DecorationBlock;
392 #endif
393         default:
394             assert(0);
395             break;
396         }
397     }
398 
399     return spv::DecorationMax;
400 }
401 
402 // Translate glslang type to SPIR-V memory decorations.
TranslateMemoryDecoration(const glslang::TQualifier & qualifier,std::vector<spv::Decoration> & memory,bool useVulkanMemoryModel)403 void TranslateMemoryDecoration(const glslang::TQualifier& qualifier, std::vector<spv::Decoration>& memory,
404     bool useVulkanMemoryModel)
405 {
406     if (!useVulkanMemoryModel) {
407         if (qualifier.isCoherent())
408             memory.push_back(spv::DecorationCoherent);
409         if (qualifier.isVolatile()) {
410             memory.push_back(spv::DecorationVolatile);
411             memory.push_back(spv::DecorationCoherent);
412         }
413     }
414     if (qualifier.isRestrict())
415         memory.push_back(spv::DecorationRestrict);
416     if (qualifier.isReadOnly())
417         memory.push_back(spv::DecorationNonWritable);
418     if (qualifier.isWriteOnly())
419        memory.push_back(spv::DecorationNonReadable);
420 }
421 
422 // Translate glslang type to SPIR-V layout decorations.
TranslateLayoutDecoration(const glslang::TType & type,glslang::TLayoutMatrix matrixLayout)423 spv::Decoration TranslateLayoutDecoration(const glslang::TType& type, glslang::TLayoutMatrix matrixLayout)
424 {
425     if (type.isMatrix()) {
426         switch (matrixLayout) {
427         case glslang::ElmRowMajor:
428             return spv::DecorationRowMajor;
429         case glslang::ElmColumnMajor:
430             return spv::DecorationColMajor;
431         default:
432             // opaque layouts don't need a majorness
433             return spv::DecorationMax;
434         }
435     } else {
436         switch (type.getBasicType()) {
437         default:
438             return spv::DecorationMax;
439             break;
440         case glslang::EbtBlock:
441             switch (type.getQualifier().storage) {
442             case glslang::EvqShared:
443             case glslang::EvqUniform:
444             case glslang::EvqBuffer:
445                 switch (type.getQualifier().layoutPacking) {
446                 case glslang::ElpShared:  return spv::DecorationGLSLShared;
447                 case glslang::ElpPacked:  return spv::DecorationGLSLPacked;
448                 default:
449                     return spv::DecorationMax;
450                 }
451             case glslang::EvqVaryingIn:
452             case glslang::EvqVaryingOut:
453                 if (type.getQualifier().isTaskMemory()) {
454                     switch (type.getQualifier().layoutPacking) {
455                     case glslang::ElpShared:  return spv::DecorationGLSLShared;
456                     case glslang::ElpPacked:  return spv::DecorationGLSLPacked;
457                     default: break;
458                     }
459                 } else {
460                     assert(type.getQualifier().layoutPacking == glslang::ElpNone);
461                 }
462                 return spv::DecorationMax;
463 #ifndef GLSLANG_WEB
464             case glslang::EvqPayload:
465             case glslang::EvqPayloadIn:
466             case glslang::EvqHitAttr:
467             case glslang::EvqCallableData:
468             case glslang::EvqCallableDataIn:
469                 return spv::DecorationMax;
470 #endif
471             default:
472                 assert(0);
473                 return spv::DecorationMax;
474             }
475         }
476     }
477 }
478 
479 // Translate glslang type to SPIR-V interpolation decorations.
480 // Returns spv::DecorationMax when no decoration
481 // should be applied.
TranslateInterpolationDecoration(const glslang::TQualifier & qualifier)482 spv::Decoration TGlslangToSpvTraverser::TranslateInterpolationDecoration(const glslang::TQualifier& qualifier)
483 {
484     if (qualifier.smooth)
485         // Smooth decoration doesn't exist in SPIR-V 1.0
486         return spv::DecorationMax;
487     else if (qualifier.isNonPerspective())
488         return spv::DecorationNoPerspective;
489     else if (qualifier.flat)
490         return spv::DecorationFlat;
491     else if (qualifier.isExplicitInterpolation()) {
492         builder.addExtension(spv::E_SPV_AMD_shader_explicit_vertex_parameter);
493         return spv::DecorationExplicitInterpAMD;
494     }
495     else
496         return spv::DecorationMax;
497 }
498 
499 // Translate glslang type to SPIR-V auxiliary storage decorations.
500 // Returns spv::DecorationMax when no decoration
501 // should be applied.
TranslateAuxiliaryStorageDecoration(const glslang::TQualifier & qualifier)502 spv::Decoration TGlslangToSpvTraverser::TranslateAuxiliaryStorageDecoration(const glslang::TQualifier& qualifier)
503 {
504     if (qualifier.centroid)
505         return spv::DecorationCentroid;
506 #ifndef GLSLANG_WEB
507     else if (qualifier.patch)
508         return spv::DecorationPatch;
509     else if (qualifier.sample) {
510         builder.addCapability(spv::CapabilitySampleRateShading);
511         return spv::DecorationSample;
512     }
513 #endif
514 
515     return spv::DecorationMax;
516 }
517 
518 // If glslang type is invariant, return SPIR-V invariant decoration.
TranslateInvariantDecoration(const glslang::TQualifier & qualifier)519 spv::Decoration TranslateInvariantDecoration(const glslang::TQualifier& qualifier)
520 {
521     if (qualifier.invariant)
522         return spv::DecorationInvariant;
523     else
524         return spv::DecorationMax;
525 }
526 
527 // If glslang type is noContraction, return SPIR-V NoContraction decoration.
TranslateNoContractionDecoration(const glslang::TQualifier & qualifier)528 spv::Decoration TranslateNoContractionDecoration(const glslang::TQualifier& qualifier)
529 {
530 #ifndef GLSLANG_WEB
531     if (qualifier.isNoContraction())
532         return spv::DecorationNoContraction;
533     else
534 #endif
535         return spv::DecorationMax;
536 }
537 
538 // If glslang type is nonUniform, return SPIR-V NonUniform decoration.
TranslateNonUniformDecoration(const glslang::TQualifier & qualifier)539 spv::Decoration TGlslangToSpvTraverser::TranslateNonUniformDecoration(const glslang::TQualifier& qualifier)
540 {
541 #ifndef GLSLANG_WEB
542     if (qualifier.isNonUniform()) {
543         builder.addIncorporatedExtension("SPV_EXT_descriptor_indexing", spv::Spv_1_5);
544         builder.addCapability(spv::CapabilityShaderNonUniformEXT);
545         return spv::DecorationNonUniformEXT;
546     } else
547 #endif
548         return spv::DecorationMax;
549 }
550 
551 // If lvalue flags contains nonUniform, return SPIR-V NonUniform decoration.
TranslateNonUniformDecoration(const spv::Builder::AccessChain::CoherentFlags & coherentFlags)552 spv::Decoration TGlslangToSpvTraverser::TranslateNonUniformDecoration(
553     const spv::Builder::AccessChain::CoherentFlags& coherentFlags)
554 {
555 #ifndef GLSLANG_WEB
556     if (coherentFlags.isNonUniform()) {
557         builder.addIncorporatedExtension("SPV_EXT_descriptor_indexing", spv::Spv_1_5);
558         builder.addCapability(spv::CapabilityShaderNonUniformEXT);
559         return spv::DecorationNonUniformEXT;
560     } else
561 #endif
562         return spv::DecorationMax;
563 }
564 
TranslateMemoryAccess(const spv::Builder::AccessChain::CoherentFlags & coherentFlags)565 spv::MemoryAccessMask TGlslangToSpvTraverser::TranslateMemoryAccess(
566     const spv::Builder::AccessChain::CoherentFlags &coherentFlags)
567 {
568     spv::MemoryAccessMask mask = spv::MemoryAccessMaskNone;
569 
570 #ifndef GLSLANG_WEB
571     if (!glslangIntermediate->usingVulkanMemoryModel() || coherentFlags.isImage)
572         return mask;
573 
574     if (coherentFlags.isVolatile() || coherentFlags.anyCoherent()) {
575         mask = mask | spv::MemoryAccessMakePointerAvailableKHRMask |
576                       spv::MemoryAccessMakePointerVisibleKHRMask;
577     }
578 
579     if (coherentFlags.nonprivate) {
580         mask = mask | spv::MemoryAccessNonPrivatePointerKHRMask;
581     }
582     if (coherentFlags.volatil) {
583         mask = mask | spv::MemoryAccessVolatileMask;
584     }
585     if (mask != spv::MemoryAccessMaskNone) {
586         builder.addCapability(spv::CapabilityVulkanMemoryModelKHR);
587     }
588 #endif
589 
590     return mask;
591 }
592 
TranslateImageOperands(const spv::Builder::AccessChain::CoherentFlags & coherentFlags)593 spv::ImageOperandsMask TGlslangToSpvTraverser::TranslateImageOperands(
594     const spv::Builder::AccessChain::CoherentFlags &coherentFlags)
595 {
596     spv::ImageOperandsMask mask = spv::ImageOperandsMaskNone;
597 
598 #ifndef GLSLANG_WEB
599     if (!glslangIntermediate->usingVulkanMemoryModel())
600         return mask;
601 
602     if (coherentFlags.volatil ||
603         coherentFlags.anyCoherent()) {
604         mask = mask | spv::ImageOperandsMakeTexelAvailableKHRMask |
605                       spv::ImageOperandsMakeTexelVisibleKHRMask;
606     }
607     if (coherentFlags.nonprivate) {
608         mask = mask | spv::ImageOperandsNonPrivateTexelKHRMask;
609     }
610     if (coherentFlags.volatil) {
611         mask = mask | spv::ImageOperandsVolatileTexelKHRMask;
612     }
613     if (mask != spv::ImageOperandsMaskNone) {
614         builder.addCapability(spv::CapabilityVulkanMemoryModelKHR);
615     }
616 #endif
617 
618     return mask;
619 }
620 
TranslateCoherent(const glslang::TType & type)621 spv::Builder::AccessChain::CoherentFlags TGlslangToSpvTraverser::TranslateCoherent(const glslang::TType& type)
622 {
623     spv::Builder::AccessChain::CoherentFlags flags = {};
624 #ifndef GLSLANG_WEB
625     flags.coherent = type.getQualifier().coherent;
626     flags.devicecoherent = type.getQualifier().devicecoherent;
627     flags.queuefamilycoherent = type.getQualifier().queuefamilycoherent;
628     // shared variables are implicitly workgroupcoherent in GLSL.
629     flags.workgroupcoherent = type.getQualifier().workgroupcoherent ||
630                               type.getQualifier().storage == glslang::EvqShared;
631     flags.subgroupcoherent = type.getQualifier().subgroupcoherent;
632     flags.shadercallcoherent = type.getQualifier().shadercallcoherent;
633     flags.volatil = type.getQualifier().volatil;
634     // *coherent variables are implicitly nonprivate in GLSL
635     flags.nonprivate = type.getQualifier().nonprivate ||
636                        flags.anyCoherent() ||
637                        flags.volatil;
638     flags.isImage = type.getBasicType() == glslang::EbtSampler;
639 #endif
640     flags.nonUniform = type.getQualifier().nonUniform;
641     return flags;
642 }
643 
TranslateMemoryScope(const spv::Builder::AccessChain::CoherentFlags & coherentFlags)644 spv::Scope TGlslangToSpvTraverser::TranslateMemoryScope(
645     const spv::Builder::AccessChain::CoherentFlags &coherentFlags)
646 {
647     spv::Scope scope = spv::ScopeMax;
648 
649 #ifndef GLSLANG_WEB
650     if (coherentFlags.volatil || coherentFlags.coherent) {
651         // coherent defaults to Device scope in the old model, QueueFamilyKHR scope in the new model
652         scope = glslangIntermediate->usingVulkanMemoryModel() ? spv::ScopeQueueFamilyKHR : spv::ScopeDevice;
653     } else if (coherentFlags.devicecoherent) {
654         scope = spv::ScopeDevice;
655     } else if (coherentFlags.queuefamilycoherent) {
656         scope = spv::ScopeQueueFamilyKHR;
657     } else if (coherentFlags.workgroupcoherent) {
658         scope = spv::ScopeWorkgroup;
659     } else if (coherentFlags.subgroupcoherent) {
660         scope = spv::ScopeSubgroup;
661     } else if (coherentFlags.shadercallcoherent) {
662         scope = spv::ScopeShaderCallKHR;
663     }
664     if (glslangIntermediate->usingVulkanMemoryModel() && scope == spv::ScopeDevice) {
665         builder.addCapability(spv::CapabilityVulkanMemoryModelDeviceScopeKHR);
666     }
667 #endif
668 
669     return scope;
670 }
671 
672 // Translate a glslang built-in variable to a SPIR-V built in decoration.  Also generate
673 // associated capabilities when required.  For some built-in variables, a capability
674 // is generated only when using the variable in an executable instruction, but not when
675 // just declaring a struct member variable with it.  This is true for PointSize,
676 // ClipDistance, and CullDistance.
TranslateBuiltInDecoration(glslang::TBuiltInVariable builtIn,bool memberDeclaration)677 spv::BuiltIn TGlslangToSpvTraverser::TranslateBuiltInDecoration(glslang::TBuiltInVariable builtIn,
678     bool memberDeclaration)
679 {
680     switch (builtIn) {
681     case glslang::EbvPointSize:
682 #ifndef GLSLANG_WEB
683         // Defer adding the capability until the built-in is actually used.
684         if (! memberDeclaration) {
685             switch (glslangIntermediate->getStage()) {
686             case EShLangGeometry:
687                 builder.addCapability(spv::CapabilityGeometryPointSize);
688                 break;
689             case EShLangTessControl:
690             case EShLangTessEvaluation:
691                 builder.addCapability(spv::CapabilityTessellationPointSize);
692                 break;
693             default:
694                 break;
695             }
696         }
697 #endif
698         return spv::BuiltInPointSize;
699 
700     case glslang::EbvPosition:             return spv::BuiltInPosition;
701     case glslang::EbvVertexId:             return spv::BuiltInVertexId;
702     case glslang::EbvInstanceId:           return spv::BuiltInInstanceId;
703     case glslang::EbvVertexIndex:          return spv::BuiltInVertexIndex;
704     case glslang::EbvInstanceIndex:        return spv::BuiltInInstanceIndex;
705 
706     case glslang::EbvFragCoord:            return spv::BuiltInFragCoord;
707     case glslang::EbvPointCoord:           return spv::BuiltInPointCoord;
708     case glslang::EbvFace:                 return spv::BuiltInFrontFacing;
709     case glslang::EbvFragDepth:            return spv::BuiltInFragDepth;
710 
711     case glslang::EbvNumWorkGroups:        return spv::BuiltInNumWorkgroups;
712     case glslang::EbvWorkGroupSize:        return spv::BuiltInWorkgroupSize;
713     case glslang::EbvWorkGroupId:          return spv::BuiltInWorkgroupId;
714     case glslang::EbvLocalInvocationId:    return spv::BuiltInLocalInvocationId;
715     case glslang::EbvLocalInvocationIndex: return spv::BuiltInLocalInvocationIndex;
716     case glslang::EbvGlobalInvocationId:   return spv::BuiltInGlobalInvocationId;
717 
718 #ifndef GLSLANG_WEB
719     // These *Distance capabilities logically belong here, but if the member is declared and
720     // then never used, consumers of SPIR-V prefer the capability not be declared.
721     // They are now generated when used, rather than here when declared.
722     // Potentially, the specification should be more clear what the minimum
723     // use needed is to trigger the capability.
724     //
725     case glslang::EbvClipDistance:
726         if (!memberDeclaration)
727             builder.addCapability(spv::CapabilityClipDistance);
728         return spv::BuiltInClipDistance;
729 
730     case glslang::EbvCullDistance:
731         if (!memberDeclaration)
732             builder.addCapability(spv::CapabilityCullDistance);
733         return spv::BuiltInCullDistance;
734 
735     case glslang::EbvViewportIndex:
736         if (glslangIntermediate->getStage() == EShLangGeometry ||
737             glslangIntermediate->getStage() == EShLangFragment) {
738             builder.addCapability(spv::CapabilityMultiViewport);
739         }
740         if (glslangIntermediate->getStage() == EShLangVertex ||
741             glslangIntermediate->getStage() == EShLangTessControl ||
742             glslangIntermediate->getStage() == EShLangTessEvaluation) {
743 
744             if (builder.getSpvVersion() < spv::Spv_1_5) {
745                 builder.addIncorporatedExtension(spv::E_SPV_EXT_shader_viewport_index_layer, spv::Spv_1_5);
746                 builder.addCapability(spv::CapabilityShaderViewportIndexLayerEXT);
747             }
748             else
749                 builder.addCapability(spv::CapabilityShaderViewportIndex);
750         }
751         return spv::BuiltInViewportIndex;
752 
753     case glslang::EbvSampleId:
754         builder.addCapability(spv::CapabilitySampleRateShading);
755         return spv::BuiltInSampleId;
756 
757     case glslang::EbvSamplePosition:
758         builder.addCapability(spv::CapabilitySampleRateShading);
759         return spv::BuiltInSamplePosition;
760 
761     case glslang::EbvSampleMask:
762         return spv::BuiltInSampleMask;
763 
764     case glslang::EbvLayer:
765         if (glslangIntermediate->getStage() == EShLangMeshNV) {
766             return spv::BuiltInLayer;
767         }
768         if (glslangIntermediate->getStage() == EShLangGeometry ||
769             glslangIntermediate->getStage() == EShLangFragment) {
770             builder.addCapability(spv::CapabilityGeometry);
771         }
772         if (glslangIntermediate->getStage() == EShLangVertex ||
773             glslangIntermediate->getStage() == EShLangTessControl ||
774             glslangIntermediate->getStage() == EShLangTessEvaluation) {
775 
776             if (builder.getSpvVersion() < spv::Spv_1_5) {
777                 builder.addIncorporatedExtension(spv::E_SPV_EXT_shader_viewport_index_layer, spv::Spv_1_5);
778                 builder.addCapability(spv::CapabilityShaderViewportIndexLayerEXT);
779             } else
780                 builder.addCapability(spv::CapabilityShaderLayer);
781         }
782         return spv::BuiltInLayer;
783 
784     case glslang::EbvBaseVertex:
785         builder.addIncorporatedExtension(spv::E_SPV_KHR_shader_draw_parameters, spv::Spv_1_3);
786         builder.addCapability(spv::CapabilityDrawParameters);
787         return spv::BuiltInBaseVertex;
788 
789     case glslang::EbvBaseInstance:
790         builder.addIncorporatedExtension(spv::E_SPV_KHR_shader_draw_parameters, spv::Spv_1_3);
791         builder.addCapability(spv::CapabilityDrawParameters);
792         return spv::BuiltInBaseInstance;
793 
794     case glslang::EbvDrawId:
795         builder.addIncorporatedExtension(spv::E_SPV_KHR_shader_draw_parameters, spv::Spv_1_3);
796         builder.addCapability(spv::CapabilityDrawParameters);
797         return spv::BuiltInDrawIndex;
798 
799     case glslang::EbvPrimitiveId:
800         if (glslangIntermediate->getStage() == EShLangFragment)
801             builder.addCapability(spv::CapabilityGeometry);
802         return spv::BuiltInPrimitiveId;
803 
804     case glslang::EbvFragStencilRef:
805         builder.addExtension(spv::E_SPV_EXT_shader_stencil_export);
806         builder.addCapability(spv::CapabilityStencilExportEXT);
807         return spv::BuiltInFragStencilRefEXT;
808 
809     case glslang::EbvShadingRateKHR:
810         builder.addExtension(spv::E_SPV_KHR_fragment_shading_rate);
811         builder.addCapability(spv::CapabilityFragmentShadingRateKHR);
812         return spv::BuiltInShadingRateKHR;
813 
814     case glslang::EbvPrimitiveShadingRateKHR:
815         builder.addExtension(spv::E_SPV_KHR_fragment_shading_rate);
816         builder.addCapability(spv::CapabilityFragmentShadingRateKHR);
817         return spv::BuiltInPrimitiveShadingRateKHR;
818 
819     case glslang::EbvInvocationId:         return spv::BuiltInInvocationId;
820     case glslang::EbvTessLevelInner:       return spv::BuiltInTessLevelInner;
821     case glslang::EbvTessLevelOuter:       return spv::BuiltInTessLevelOuter;
822     case glslang::EbvTessCoord:            return spv::BuiltInTessCoord;
823     case glslang::EbvPatchVertices:        return spv::BuiltInPatchVertices;
824     case glslang::EbvHelperInvocation:     return spv::BuiltInHelperInvocation;
825 
826     case glslang::EbvSubGroupSize:
827         builder.addExtension(spv::E_SPV_KHR_shader_ballot);
828         builder.addCapability(spv::CapabilitySubgroupBallotKHR);
829         return spv::BuiltInSubgroupSize;
830 
831     case glslang::EbvSubGroupInvocation:
832         builder.addExtension(spv::E_SPV_KHR_shader_ballot);
833         builder.addCapability(spv::CapabilitySubgroupBallotKHR);
834         return spv::BuiltInSubgroupLocalInvocationId;
835 
836     case glslang::EbvSubGroupEqMask:
837         builder.addExtension(spv::E_SPV_KHR_shader_ballot);
838         builder.addCapability(spv::CapabilitySubgroupBallotKHR);
839         return spv::BuiltInSubgroupEqMask;
840 
841     case glslang::EbvSubGroupGeMask:
842         builder.addExtension(spv::E_SPV_KHR_shader_ballot);
843         builder.addCapability(spv::CapabilitySubgroupBallotKHR);
844         return spv::BuiltInSubgroupGeMask;
845 
846     case glslang::EbvSubGroupGtMask:
847         builder.addExtension(spv::E_SPV_KHR_shader_ballot);
848         builder.addCapability(spv::CapabilitySubgroupBallotKHR);
849         return spv::BuiltInSubgroupGtMask;
850 
851     case glslang::EbvSubGroupLeMask:
852         builder.addExtension(spv::E_SPV_KHR_shader_ballot);
853         builder.addCapability(spv::CapabilitySubgroupBallotKHR);
854         return spv::BuiltInSubgroupLeMask;
855 
856     case glslang::EbvSubGroupLtMask:
857         builder.addExtension(spv::E_SPV_KHR_shader_ballot);
858         builder.addCapability(spv::CapabilitySubgroupBallotKHR);
859         return spv::BuiltInSubgroupLtMask;
860 
861     case glslang::EbvNumSubgroups:
862         builder.addCapability(spv::CapabilityGroupNonUniform);
863         return spv::BuiltInNumSubgroups;
864 
865     case glslang::EbvSubgroupID:
866         builder.addCapability(spv::CapabilityGroupNonUniform);
867         return spv::BuiltInSubgroupId;
868 
869     case glslang::EbvSubgroupSize2:
870         builder.addCapability(spv::CapabilityGroupNonUniform);
871         return spv::BuiltInSubgroupSize;
872 
873     case glslang::EbvSubgroupInvocation2:
874         builder.addCapability(spv::CapabilityGroupNonUniform);
875         return spv::BuiltInSubgroupLocalInvocationId;
876 
877     case glslang::EbvSubgroupEqMask2:
878         builder.addCapability(spv::CapabilityGroupNonUniform);
879         builder.addCapability(spv::CapabilityGroupNonUniformBallot);
880         return spv::BuiltInSubgroupEqMask;
881 
882     case glslang::EbvSubgroupGeMask2:
883         builder.addCapability(spv::CapabilityGroupNonUniform);
884         builder.addCapability(spv::CapabilityGroupNonUniformBallot);
885         return spv::BuiltInSubgroupGeMask;
886 
887     case glslang::EbvSubgroupGtMask2:
888         builder.addCapability(spv::CapabilityGroupNonUniform);
889         builder.addCapability(spv::CapabilityGroupNonUniformBallot);
890         return spv::BuiltInSubgroupGtMask;
891 
892     case glslang::EbvSubgroupLeMask2:
893         builder.addCapability(spv::CapabilityGroupNonUniform);
894         builder.addCapability(spv::CapabilityGroupNonUniformBallot);
895         return spv::BuiltInSubgroupLeMask;
896 
897     case glslang::EbvSubgroupLtMask2:
898         builder.addCapability(spv::CapabilityGroupNonUniform);
899         builder.addCapability(spv::CapabilityGroupNonUniformBallot);
900         return spv::BuiltInSubgroupLtMask;
901 
902     case glslang::EbvBaryCoordNoPersp:
903         builder.addExtension(spv::E_SPV_AMD_shader_explicit_vertex_parameter);
904         return spv::BuiltInBaryCoordNoPerspAMD;
905 
906     case glslang::EbvBaryCoordNoPerspCentroid:
907         builder.addExtension(spv::E_SPV_AMD_shader_explicit_vertex_parameter);
908         return spv::BuiltInBaryCoordNoPerspCentroidAMD;
909 
910     case glslang::EbvBaryCoordNoPerspSample:
911         builder.addExtension(spv::E_SPV_AMD_shader_explicit_vertex_parameter);
912         return spv::BuiltInBaryCoordNoPerspSampleAMD;
913 
914     case glslang::EbvBaryCoordSmooth:
915         builder.addExtension(spv::E_SPV_AMD_shader_explicit_vertex_parameter);
916         return spv::BuiltInBaryCoordSmoothAMD;
917 
918     case glslang::EbvBaryCoordSmoothCentroid:
919         builder.addExtension(spv::E_SPV_AMD_shader_explicit_vertex_parameter);
920         return spv::BuiltInBaryCoordSmoothCentroidAMD;
921 
922     case glslang::EbvBaryCoordSmoothSample:
923         builder.addExtension(spv::E_SPV_AMD_shader_explicit_vertex_parameter);
924         return spv::BuiltInBaryCoordSmoothSampleAMD;
925 
926     case glslang::EbvBaryCoordPullModel:
927         builder.addExtension(spv::E_SPV_AMD_shader_explicit_vertex_parameter);
928         return spv::BuiltInBaryCoordPullModelAMD;
929 
930     case glslang::EbvDeviceIndex:
931         builder.addIncorporatedExtension(spv::E_SPV_KHR_device_group, spv::Spv_1_3);
932         builder.addCapability(spv::CapabilityDeviceGroup);
933         return spv::BuiltInDeviceIndex;
934 
935     case glslang::EbvViewIndex:
936         builder.addIncorporatedExtension(spv::E_SPV_KHR_multiview, spv::Spv_1_3);
937         builder.addCapability(spv::CapabilityMultiView);
938         return spv::BuiltInViewIndex;
939 
940     case glslang::EbvFragSizeEXT:
941         builder.addExtension(spv::E_SPV_EXT_fragment_invocation_density);
942         builder.addCapability(spv::CapabilityFragmentDensityEXT);
943         return spv::BuiltInFragSizeEXT;
944 
945     case glslang::EbvFragInvocationCountEXT:
946         builder.addExtension(spv::E_SPV_EXT_fragment_invocation_density);
947         builder.addCapability(spv::CapabilityFragmentDensityEXT);
948         return spv::BuiltInFragInvocationCountEXT;
949 
950     case glslang::EbvViewportMaskNV:
951         if (!memberDeclaration) {
952             builder.addExtension(spv::E_SPV_NV_viewport_array2);
953             builder.addCapability(spv::CapabilityShaderViewportMaskNV);
954         }
955         return spv::BuiltInViewportMaskNV;
956     case glslang::EbvSecondaryPositionNV:
957         if (!memberDeclaration) {
958             builder.addExtension(spv::E_SPV_NV_stereo_view_rendering);
959             builder.addCapability(spv::CapabilityShaderStereoViewNV);
960         }
961         return spv::BuiltInSecondaryPositionNV;
962     case glslang::EbvSecondaryViewportMaskNV:
963         if (!memberDeclaration) {
964             builder.addExtension(spv::E_SPV_NV_stereo_view_rendering);
965             builder.addCapability(spv::CapabilityShaderStereoViewNV);
966         }
967         return spv::BuiltInSecondaryViewportMaskNV;
968     case glslang::EbvPositionPerViewNV:
969         if (!memberDeclaration) {
970             builder.addExtension(spv::E_SPV_NVX_multiview_per_view_attributes);
971             builder.addCapability(spv::CapabilityPerViewAttributesNV);
972         }
973         return spv::BuiltInPositionPerViewNV;
974     case glslang::EbvViewportMaskPerViewNV:
975         if (!memberDeclaration) {
976             builder.addExtension(spv::E_SPV_NVX_multiview_per_view_attributes);
977             builder.addCapability(spv::CapabilityPerViewAttributesNV);
978         }
979         return spv::BuiltInViewportMaskPerViewNV;
980     case glslang::EbvFragFullyCoveredNV:
981         builder.addExtension(spv::E_SPV_EXT_fragment_fully_covered);
982         builder.addCapability(spv::CapabilityFragmentFullyCoveredEXT);
983         return spv::BuiltInFullyCoveredEXT;
984     case glslang::EbvFragmentSizeNV:
985         builder.addExtension(spv::E_SPV_NV_shading_rate);
986         builder.addCapability(spv::CapabilityShadingRateNV);
987         return spv::BuiltInFragmentSizeNV;
988     case glslang::EbvInvocationsPerPixelNV:
989         builder.addExtension(spv::E_SPV_NV_shading_rate);
990         builder.addCapability(spv::CapabilityShadingRateNV);
991         return spv::BuiltInInvocationsPerPixelNV;
992 
993     // ray tracing
994     case glslang::EbvLaunchId:
995         return spv::BuiltInLaunchIdKHR;
996     case glslang::EbvLaunchSize:
997         return spv::BuiltInLaunchSizeKHR;
998     case glslang::EbvWorldRayOrigin:
999         return spv::BuiltInWorldRayOriginKHR;
1000     case glslang::EbvWorldRayDirection:
1001         return spv::BuiltInWorldRayDirectionKHR;
1002     case glslang::EbvObjectRayOrigin:
1003         return spv::BuiltInObjectRayOriginKHR;
1004     case glslang::EbvObjectRayDirection:
1005         return spv::BuiltInObjectRayDirectionKHR;
1006     case glslang::EbvRayTmin:
1007         return spv::BuiltInRayTminKHR;
1008     case glslang::EbvRayTmax:
1009         return spv::BuiltInRayTmaxKHR;
1010     case glslang::EbvInstanceCustomIndex:
1011         return spv::BuiltInInstanceCustomIndexKHR;
1012     case glslang::EbvHitT:
1013         {
1014             // this is a GLSL alias of RayTmax
1015             // in SPV_NV_ray_tracing it has a dedicated builtin
1016             // but in SPV_KHR_ray_tracing it gets mapped to RayTmax
1017             auto& extensions = glslangIntermediate->getRequestedExtensions();
1018             if (extensions.find("GL_NV_ray_tracing") != extensions.end()) {
1019                 return spv::BuiltInHitTNV;
1020             } else {
1021                 return spv::BuiltInRayTmaxKHR;
1022             }
1023         }
1024     case glslang::EbvHitKind:
1025         return spv::BuiltInHitKindKHR;
1026     case glslang::EbvObjectToWorld:
1027     case glslang::EbvObjectToWorld3x4:
1028         return spv::BuiltInObjectToWorldKHR;
1029     case glslang::EbvWorldToObject:
1030     case glslang::EbvWorldToObject3x4:
1031         return spv::BuiltInWorldToObjectKHR;
1032     case glslang::EbvIncomingRayFlags:
1033         return spv::BuiltInIncomingRayFlagsKHR;
1034     case glslang::EbvGeometryIndex:
1035         return spv::BuiltInRayGeometryIndexKHR;
1036     case glslang::EbvCurrentRayTimeNV:
1037         builder.addExtension(spv::E_SPV_NV_ray_tracing_motion_blur);
1038         builder.addCapability(spv::CapabilityRayTracingMotionBlurNV);
1039         return spv::BuiltInCurrentRayTimeNV;
1040 
1041     // barycentrics
1042     case glslang::EbvBaryCoordNV:
1043         builder.addExtension(spv::E_SPV_NV_fragment_shader_barycentric);
1044         builder.addCapability(spv::CapabilityFragmentBarycentricNV);
1045         return spv::BuiltInBaryCoordNV;
1046     case glslang::EbvBaryCoordNoPerspNV:
1047         builder.addExtension(spv::E_SPV_NV_fragment_shader_barycentric);
1048         builder.addCapability(spv::CapabilityFragmentBarycentricNV);
1049         return spv::BuiltInBaryCoordNoPerspNV;
1050 
1051     // mesh shaders
1052     case glslang::EbvTaskCountNV:
1053         return spv::BuiltInTaskCountNV;
1054     case glslang::EbvPrimitiveCountNV:
1055         return spv::BuiltInPrimitiveCountNV;
1056     case glslang::EbvPrimitiveIndicesNV:
1057         return spv::BuiltInPrimitiveIndicesNV;
1058     case glslang::EbvClipDistancePerViewNV:
1059         return spv::BuiltInClipDistancePerViewNV;
1060     case glslang::EbvCullDistancePerViewNV:
1061         return spv::BuiltInCullDistancePerViewNV;
1062     case glslang::EbvLayerPerViewNV:
1063         return spv::BuiltInLayerPerViewNV;
1064     case glslang::EbvMeshViewCountNV:
1065         return spv::BuiltInMeshViewCountNV;
1066     case glslang::EbvMeshViewIndicesNV:
1067         return spv::BuiltInMeshViewIndicesNV;
1068 
1069     // sm builtins
1070     case glslang::EbvWarpsPerSM:
1071         builder.addExtension(spv::E_SPV_NV_shader_sm_builtins);
1072         builder.addCapability(spv::CapabilityShaderSMBuiltinsNV);
1073         return spv::BuiltInWarpsPerSMNV;
1074     case glslang::EbvSMCount:
1075         builder.addExtension(spv::E_SPV_NV_shader_sm_builtins);
1076         builder.addCapability(spv::CapabilityShaderSMBuiltinsNV);
1077         return spv::BuiltInSMCountNV;
1078     case glslang::EbvWarpID:
1079         builder.addExtension(spv::E_SPV_NV_shader_sm_builtins);
1080         builder.addCapability(spv::CapabilityShaderSMBuiltinsNV);
1081         return spv::BuiltInWarpIDNV;
1082     case glslang::EbvSMID:
1083         builder.addExtension(spv::E_SPV_NV_shader_sm_builtins);
1084         builder.addCapability(spv::CapabilityShaderSMBuiltinsNV);
1085         return spv::BuiltInSMIDNV;
1086 #endif
1087 
1088     default:
1089         return spv::BuiltInMax;
1090     }
1091 }
1092 
1093 // Translate glslang image layout format to SPIR-V image format.
TranslateImageFormat(const glslang::TType & type)1094 spv::ImageFormat TGlslangToSpvTraverser::TranslateImageFormat(const glslang::TType& type)
1095 {
1096     assert(type.getBasicType() == glslang::EbtSampler);
1097 
1098 #ifdef GLSLANG_WEB
1099     return spv::ImageFormatUnknown;
1100 #endif
1101 
1102     // Check for capabilities
1103     switch (type.getQualifier().getFormat()) {
1104     case glslang::ElfRg32f:
1105     case glslang::ElfRg16f:
1106     case glslang::ElfR11fG11fB10f:
1107     case glslang::ElfR16f:
1108     case glslang::ElfRgba16:
1109     case glslang::ElfRgb10A2:
1110     case glslang::ElfRg16:
1111     case glslang::ElfRg8:
1112     case glslang::ElfR16:
1113     case glslang::ElfR8:
1114     case glslang::ElfRgba16Snorm:
1115     case glslang::ElfRg16Snorm:
1116     case glslang::ElfRg8Snorm:
1117     case glslang::ElfR16Snorm:
1118     case glslang::ElfR8Snorm:
1119 
1120     case glslang::ElfRg32i:
1121     case glslang::ElfRg16i:
1122     case glslang::ElfRg8i:
1123     case glslang::ElfR16i:
1124     case glslang::ElfR8i:
1125 
1126     case glslang::ElfRgb10a2ui:
1127     case glslang::ElfRg32ui:
1128     case glslang::ElfRg16ui:
1129     case glslang::ElfRg8ui:
1130     case glslang::ElfR16ui:
1131     case glslang::ElfR8ui:
1132         builder.addCapability(spv::CapabilityStorageImageExtendedFormats);
1133         break;
1134 
1135     case glslang::ElfR64ui:
1136     case glslang::ElfR64i:
1137         builder.addExtension(spv::E_SPV_EXT_shader_image_int64);
1138         builder.addCapability(spv::CapabilityInt64ImageEXT);
1139     default:
1140         break;
1141     }
1142 
1143     // do the translation
1144     switch (type.getQualifier().getFormat()) {
1145     case glslang::ElfNone:          return spv::ImageFormatUnknown;
1146     case glslang::ElfRgba32f:       return spv::ImageFormatRgba32f;
1147     case glslang::ElfRgba16f:       return spv::ImageFormatRgba16f;
1148     case glslang::ElfR32f:          return spv::ImageFormatR32f;
1149     case glslang::ElfRgba8:         return spv::ImageFormatRgba8;
1150     case glslang::ElfRgba8Snorm:    return spv::ImageFormatRgba8Snorm;
1151     case glslang::ElfRg32f:         return spv::ImageFormatRg32f;
1152     case glslang::ElfRg16f:         return spv::ImageFormatRg16f;
1153     case glslang::ElfR11fG11fB10f:  return spv::ImageFormatR11fG11fB10f;
1154     case glslang::ElfR16f:          return spv::ImageFormatR16f;
1155     case glslang::ElfRgba16:        return spv::ImageFormatRgba16;
1156     case glslang::ElfRgb10A2:       return spv::ImageFormatRgb10A2;
1157     case glslang::ElfRg16:          return spv::ImageFormatRg16;
1158     case glslang::ElfRg8:           return spv::ImageFormatRg8;
1159     case glslang::ElfR16:           return spv::ImageFormatR16;
1160     case glslang::ElfR8:            return spv::ImageFormatR8;
1161     case glslang::ElfRgba16Snorm:   return spv::ImageFormatRgba16Snorm;
1162     case glslang::ElfRg16Snorm:     return spv::ImageFormatRg16Snorm;
1163     case glslang::ElfRg8Snorm:      return spv::ImageFormatRg8Snorm;
1164     case glslang::ElfR16Snorm:      return spv::ImageFormatR16Snorm;
1165     case glslang::ElfR8Snorm:       return spv::ImageFormatR8Snorm;
1166     case glslang::ElfRgba32i:       return spv::ImageFormatRgba32i;
1167     case glslang::ElfRgba16i:       return spv::ImageFormatRgba16i;
1168     case glslang::ElfRgba8i:        return spv::ImageFormatRgba8i;
1169     case glslang::ElfR32i:          return spv::ImageFormatR32i;
1170     case glslang::ElfRg32i:         return spv::ImageFormatRg32i;
1171     case glslang::ElfRg16i:         return spv::ImageFormatRg16i;
1172     case glslang::ElfRg8i:          return spv::ImageFormatRg8i;
1173     case glslang::ElfR16i:          return spv::ImageFormatR16i;
1174     case glslang::ElfR8i:           return spv::ImageFormatR8i;
1175     case glslang::ElfRgba32ui:      return spv::ImageFormatRgba32ui;
1176     case glslang::ElfRgba16ui:      return spv::ImageFormatRgba16ui;
1177     case glslang::ElfRgba8ui:       return spv::ImageFormatRgba8ui;
1178     case glslang::ElfR32ui:         return spv::ImageFormatR32ui;
1179     case glslang::ElfRg32ui:        return spv::ImageFormatRg32ui;
1180     case glslang::ElfRg16ui:        return spv::ImageFormatRg16ui;
1181     case glslang::ElfRgb10a2ui:     return spv::ImageFormatRgb10a2ui;
1182     case glslang::ElfRg8ui:         return spv::ImageFormatRg8ui;
1183     case glslang::ElfR16ui:         return spv::ImageFormatR16ui;
1184     case glslang::ElfR8ui:          return spv::ImageFormatR8ui;
1185     case glslang::ElfR64ui:         return spv::ImageFormatR64ui;
1186     case glslang::ElfR64i:          return spv::ImageFormatR64i;
1187     default:                        return spv::ImageFormatMax;
1188     }
1189 }
1190 
TranslateSelectionControl(const glslang::TIntermSelection & selectionNode) const1191 spv::SelectionControlMask TGlslangToSpvTraverser::TranslateSelectionControl(
1192     const glslang::TIntermSelection& selectionNode) const
1193 {
1194     if (selectionNode.getFlatten())
1195         return spv::SelectionControlFlattenMask;
1196     if (selectionNode.getDontFlatten())
1197         return spv::SelectionControlDontFlattenMask;
1198     return spv::SelectionControlMaskNone;
1199 }
1200 
TranslateSwitchControl(const glslang::TIntermSwitch & switchNode) const1201 spv::SelectionControlMask TGlslangToSpvTraverser::TranslateSwitchControl(const glslang::TIntermSwitch& switchNode)
1202     const
1203 {
1204     if (switchNode.getFlatten())
1205         return spv::SelectionControlFlattenMask;
1206     if (switchNode.getDontFlatten())
1207         return spv::SelectionControlDontFlattenMask;
1208     return spv::SelectionControlMaskNone;
1209 }
1210 
1211 // return a non-0 dependency if the dependency argument must be set
TranslateLoopControl(const glslang::TIntermLoop & loopNode,std::vector<unsigned int> & operands) const1212 spv::LoopControlMask TGlslangToSpvTraverser::TranslateLoopControl(const glslang::TIntermLoop& loopNode,
1213     std::vector<unsigned int>& operands) const
1214 {
1215     spv::LoopControlMask control = spv::LoopControlMaskNone;
1216 
1217     if (loopNode.getDontUnroll())
1218         control = control | spv::LoopControlDontUnrollMask;
1219     if (loopNode.getUnroll())
1220         control = control | spv::LoopControlUnrollMask;
1221     if (unsigned(loopNode.getLoopDependency()) == glslang::TIntermLoop::dependencyInfinite)
1222         control = control | spv::LoopControlDependencyInfiniteMask;
1223     else if (loopNode.getLoopDependency() > 0) {
1224         control = control | spv::LoopControlDependencyLengthMask;
1225         operands.push_back((unsigned int)loopNode.getLoopDependency());
1226     }
1227     if (glslangIntermediate->getSpv().spv >= glslang::EShTargetSpv_1_4) {
1228         if (loopNode.getMinIterations() > 0) {
1229             control = control | spv::LoopControlMinIterationsMask;
1230             operands.push_back(loopNode.getMinIterations());
1231         }
1232         if (loopNode.getMaxIterations() < glslang::TIntermLoop::iterationsInfinite) {
1233             control = control | spv::LoopControlMaxIterationsMask;
1234             operands.push_back(loopNode.getMaxIterations());
1235         }
1236         if (loopNode.getIterationMultiple() > 1) {
1237             control = control | spv::LoopControlIterationMultipleMask;
1238             operands.push_back(loopNode.getIterationMultiple());
1239         }
1240         if (loopNode.getPeelCount() > 0) {
1241             control = control | spv::LoopControlPeelCountMask;
1242             operands.push_back(loopNode.getPeelCount());
1243         }
1244         if (loopNode.getPartialCount() > 0) {
1245             control = control | spv::LoopControlPartialCountMask;
1246             operands.push_back(loopNode.getPartialCount());
1247         }
1248     }
1249 
1250     return control;
1251 }
1252 
1253 // Translate glslang type to SPIR-V storage class.
TranslateStorageClass(const glslang::TType & type)1254 spv::StorageClass TGlslangToSpvTraverser::TranslateStorageClass(const glslang::TType& type)
1255 {
1256     if (type.getBasicType() == glslang::EbtRayQuery)
1257         return spv::StorageClassPrivate;
1258 #ifndef GLSLANG_WEB
1259     if (type.getQualifier().isSpirvByReference()) {
1260         if (type.getQualifier().isParamInput() || type.getQualifier().isParamOutput())
1261             return spv::StorageClassFunction;
1262     }
1263 #endif
1264     if (type.getQualifier().isPipeInput())
1265         return spv::StorageClassInput;
1266     if (type.getQualifier().isPipeOutput())
1267         return spv::StorageClassOutput;
1268 
1269     if (glslangIntermediate->getSource() != glslang::EShSourceHlsl ||
1270             type.getQualifier().storage == glslang::EvqUniform) {
1271         if (type.isAtomic())
1272             return spv::StorageClassAtomicCounter;
1273         if (type.containsOpaque())
1274             return spv::StorageClassUniformConstant;
1275     }
1276 
1277     if (type.getQualifier().isUniformOrBuffer() &&
1278         type.getQualifier().isShaderRecord()) {
1279         return spv::StorageClassShaderRecordBufferKHR;
1280     }
1281 
1282     if (glslangIntermediate->usingStorageBuffer() && type.getQualifier().storage == glslang::EvqBuffer) {
1283         builder.addIncorporatedExtension(spv::E_SPV_KHR_storage_buffer_storage_class, spv::Spv_1_3);
1284         return spv::StorageClassStorageBuffer;
1285     }
1286 
1287     if (type.getQualifier().isUniformOrBuffer()) {
1288         if (type.getQualifier().isPushConstant())
1289             return spv::StorageClassPushConstant;
1290         if (type.getBasicType() == glslang::EbtBlock)
1291             return spv::StorageClassUniform;
1292         return spv::StorageClassUniformConstant;
1293     }
1294 
1295     if (type.getQualifier().storage == glslang::EvqShared && type.getBasicType() == glslang::EbtBlock) {
1296         builder.addExtension(spv::E_SPV_KHR_workgroup_memory_explicit_layout);
1297         builder.addCapability(spv::CapabilityWorkgroupMemoryExplicitLayoutKHR);
1298         return spv::StorageClassWorkgroup;
1299     }
1300 
1301     switch (type.getQualifier().storage) {
1302     case glslang::EvqGlobal:        return spv::StorageClassPrivate;
1303     case glslang::EvqConstReadOnly: return spv::StorageClassFunction;
1304     case glslang::EvqTemporary:     return spv::StorageClassFunction;
1305     case glslang::EvqShared:           return spv::StorageClassWorkgroup;
1306 #ifndef GLSLANG_WEB
1307     case glslang::EvqPayload:        return spv::StorageClassRayPayloadKHR;
1308     case glslang::EvqPayloadIn:      return spv::StorageClassIncomingRayPayloadKHR;
1309     case glslang::EvqHitAttr:        return spv::StorageClassHitAttributeKHR;
1310     case glslang::EvqCallableData:   return spv::StorageClassCallableDataKHR;
1311     case glslang::EvqCallableDataIn: return spv::StorageClassIncomingCallableDataKHR;
1312     case glslang::EvqSpirvStorageClass: return static_cast<spv::StorageClass>(type.getQualifier().spirvStorageClass);
1313 #endif
1314     default:
1315         assert(0);
1316         break;
1317     }
1318 
1319     return spv::StorageClassFunction;
1320 }
1321 
1322 // Translate glslang constants to SPIR-V literals
TranslateLiterals(const glslang::TVector<const glslang::TIntermConstantUnion * > & constants,std::vector<unsigned> & literals) const1323 void TGlslangToSpvTraverser::TranslateLiterals(const glslang::TVector<const glslang::TIntermConstantUnion*>& constants,
1324                                                std::vector<unsigned>& literals) const
1325 {
1326     for (auto constant : constants) {
1327         if (constant->getBasicType() == glslang::EbtFloat) {
1328             float floatValue = static_cast<float>(constant->getConstArray()[0].getDConst());
1329             unsigned literal = *reinterpret_cast<unsigned*>(&floatValue);
1330             literals.push_back(literal);
1331         } else if (constant->getBasicType() == glslang::EbtInt) {
1332             unsigned literal = constant->getConstArray()[0].getIConst();
1333             literals.push_back(literal);
1334         } else if (constant->getBasicType() == glslang::EbtUint) {
1335             unsigned literal = constant->getConstArray()[0].getUConst();
1336             literals.push_back(literal);
1337         } else if (constant->getBasicType() == glslang::EbtBool) {
1338             unsigned literal = constant->getConstArray()[0].getBConst();
1339             literals.push_back(literal);
1340         } else if (constant->getBasicType() == glslang::EbtString) {
1341             auto str = constant->getConstArray()[0].getSConst()->c_str();
1342             unsigned literal = 0;
1343             char* literalPtr = reinterpret_cast<char*>(&literal);
1344             unsigned charCount = 0;
1345             char ch = 0;
1346             do {
1347                 ch = *(str++);
1348                 *(literalPtr++) = ch;
1349                 ++charCount;
1350                 if (charCount == 4) {
1351                     literals.push_back(literal);
1352                     literalPtr = reinterpret_cast<char*>(&literal);
1353                     charCount = 0;
1354                 }
1355             } while (ch != 0);
1356 
1357             // Partial literal is padded with 0
1358             if (charCount > 0) {
1359                 for (; charCount < 4; ++charCount)
1360                     *(literalPtr++) = 0;
1361                 literals.push_back(literal);
1362             }
1363         } else
1364             assert(0); // Unexpected type
1365     }
1366 }
1367 
1368 // Add capabilities pertaining to how an array is indexed.
addIndirectionIndexCapabilities(const glslang::TType & baseType,const glslang::TType & indexType)1369 void TGlslangToSpvTraverser::addIndirectionIndexCapabilities(const glslang::TType& baseType,
1370                                                              const glslang::TType& indexType)
1371 {
1372 #ifndef GLSLANG_WEB
1373     if (indexType.getQualifier().isNonUniform()) {
1374         // deal with an asserted non-uniform index
1375         // SPV_EXT_descriptor_indexing already added in TranslateNonUniformDecoration
1376         if (baseType.getBasicType() == glslang::EbtSampler) {
1377             if (baseType.getQualifier().hasAttachment())
1378                 builder.addCapability(spv::CapabilityInputAttachmentArrayNonUniformIndexingEXT);
1379             else if (baseType.isImage() && baseType.getSampler().isBuffer())
1380                 builder.addCapability(spv::CapabilityStorageTexelBufferArrayNonUniformIndexingEXT);
1381             else if (baseType.isTexture() && baseType.getSampler().isBuffer())
1382                 builder.addCapability(spv::CapabilityUniformTexelBufferArrayNonUniformIndexingEXT);
1383             else if (baseType.isImage())
1384                 builder.addCapability(spv::CapabilityStorageImageArrayNonUniformIndexingEXT);
1385             else if (baseType.isTexture())
1386                 builder.addCapability(spv::CapabilitySampledImageArrayNonUniformIndexingEXT);
1387         } else if (baseType.getBasicType() == glslang::EbtBlock) {
1388             if (baseType.getQualifier().storage == glslang::EvqBuffer)
1389                 builder.addCapability(spv::CapabilityStorageBufferArrayNonUniformIndexingEXT);
1390             else if (baseType.getQualifier().storage == glslang::EvqUniform)
1391                 builder.addCapability(spv::CapabilityUniformBufferArrayNonUniformIndexingEXT);
1392         }
1393     } else {
1394         // assume a dynamically uniform index
1395         if (baseType.getBasicType() == glslang::EbtSampler) {
1396             if (baseType.getQualifier().hasAttachment()) {
1397                 builder.addIncorporatedExtension("SPV_EXT_descriptor_indexing", spv::Spv_1_5);
1398                 builder.addCapability(spv::CapabilityInputAttachmentArrayDynamicIndexingEXT);
1399             } else if (baseType.isImage() && baseType.getSampler().isBuffer()) {
1400                 builder.addIncorporatedExtension("SPV_EXT_descriptor_indexing", spv::Spv_1_5);
1401                 builder.addCapability(spv::CapabilityStorageTexelBufferArrayDynamicIndexingEXT);
1402             } else if (baseType.isTexture() && baseType.getSampler().isBuffer()) {
1403                 builder.addIncorporatedExtension("SPV_EXT_descriptor_indexing", spv::Spv_1_5);
1404                 builder.addCapability(spv::CapabilityUniformTexelBufferArrayDynamicIndexingEXT);
1405             }
1406         }
1407     }
1408 #endif
1409 }
1410 
1411 // Return whether or not the given type is something that should be tied to a
1412 // descriptor set.
IsDescriptorResource(const glslang::TType & type)1413 bool IsDescriptorResource(const glslang::TType& type)
1414 {
1415     // uniform and buffer blocks are included, unless it is a push_constant
1416     if (type.getBasicType() == glslang::EbtBlock)
1417         return type.getQualifier().isUniformOrBuffer() &&
1418         ! type.getQualifier().isShaderRecord() &&
1419         ! type.getQualifier().isPushConstant();
1420 
1421     // non block...
1422     // basically samplerXXX/subpass/sampler/texture are all included
1423     // if they are the global-scope-class, not the function parameter
1424     // (or local, if they ever exist) class.
1425     if (type.getBasicType() == glslang::EbtSampler ||
1426         type.getBasicType() == glslang::EbtAccStruct)
1427         return type.getQualifier().isUniformOrBuffer();
1428 
1429     // None of the above.
1430     return false;
1431 }
1432 
InheritQualifiers(glslang::TQualifier & child,const glslang::TQualifier & parent)1433 void InheritQualifiers(glslang::TQualifier& child, const glslang::TQualifier& parent)
1434 {
1435     if (child.layoutMatrix == glslang::ElmNone)
1436         child.layoutMatrix = parent.layoutMatrix;
1437 
1438     if (parent.invariant)
1439         child.invariant = true;
1440     if (parent.flat)
1441         child.flat = true;
1442     if (parent.centroid)
1443         child.centroid = true;
1444 #ifndef GLSLANG_WEB
1445     if (parent.nopersp)
1446         child.nopersp = true;
1447     if (parent.explicitInterp)
1448         child.explicitInterp = true;
1449     if (parent.perPrimitiveNV)
1450         child.perPrimitiveNV = true;
1451     if (parent.perViewNV)
1452         child.perViewNV = true;
1453     if (parent.perTaskNV)
1454         child.perTaskNV = true;
1455     if (parent.patch)
1456         child.patch = true;
1457     if (parent.sample)
1458         child.sample = true;
1459     if (parent.coherent)
1460         child.coherent = true;
1461     if (parent.devicecoherent)
1462         child.devicecoherent = true;
1463     if (parent.queuefamilycoherent)
1464         child.queuefamilycoherent = true;
1465     if (parent.workgroupcoherent)
1466         child.workgroupcoherent = true;
1467     if (parent.subgroupcoherent)
1468         child.subgroupcoherent = true;
1469     if (parent.shadercallcoherent)
1470         child.shadercallcoherent = true;
1471     if (parent.nonprivate)
1472         child.nonprivate = true;
1473     if (parent.volatil)
1474         child.volatil = true;
1475     if (parent.restrict)
1476         child.restrict = true;
1477     if (parent.readonly)
1478         child.readonly = true;
1479     if (parent.writeonly)
1480         child.writeonly = true;
1481 #endif
1482     if (parent.nonUniform)
1483         child.nonUniform = true;
1484 }
1485 
HasNonLayoutQualifiers(const glslang::TType & type,const glslang::TQualifier & qualifier)1486 bool HasNonLayoutQualifiers(const glslang::TType& type, const glslang::TQualifier& qualifier)
1487 {
1488     // This should list qualifiers that simultaneous satisfy:
1489     // - struct members might inherit from a struct declaration
1490     //     (note that non-block structs don't explicitly inherit,
1491     //      only implicitly, meaning no decoration involved)
1492     // - affect decorations on the struct members
1493     //     (note smooth does not, and expecting something like volatile
1494     //      to effect the whole object)
1495     // - are not part of the offset/st430/etc or row/column-major layout
1496     return qualifier.invariant || (qualifier.hasLocation() && type.getBasicType() == glslang::EbtBlock);
1497 }
1498 
1499 //
1500 // Implement the TGlslangToSpvTraverser class.
1501 //
1502 
TGlslangToSpvTraverser(unsigned int spvVersion,const glslang::TIntermediate * glslangIntermediate,spv::SpvBuildLogger * buildLogger,glslang::SpvOptions & options)1503 TGlslangToSpvTraverser::TGlslangToSpvTraverser(unsigned int spvVersion,
1504     const glslang::TIntermediate* glslangIntermediate,
1505     spv::SpvBuildLogger* buildLogger, glslang::SpvOptions& options) :
1506         TIntermTraverser(true, false, true),
1507         options(options),
1508         shaderEntry(nullptr), currentFunction(nullptr),
1509         sequenceDepth(0), logger(buildLogger),
1510         builder(spvVersion, (glslang::GetKhronosToolId() << 16) | glslang::GetSpirvGeneratorVersion(), logger),
1511         inEntryPoint(false), entryPointTerminated(false), linkageOnly(false),
1512         glslangIntermediate(glslangIntermediate),
1513         nanMinMaxClamp(glslangIntermediate->getNanMinMaxClamp()),
1514         nonSemanticDebugPrintf(0)
1515 {
1516     spv::ExecutionModel executionModel = TranslateExecutionModel(glslangIntermediate->getStage());
1517 
1518     builder.clearAccessChain();
1519     builder.setSource(TranslateSourceLanguage(glslangIntermediate->getSource(), glslangIntermediate->getProfile()),
1520                       glslangIntermediate->getVersion());
1521 
1522     if (options.generateDebugInfo) {
1523         builder.setEmitOpLines();
1524         builder.setSourceFile(glslangIntermediate->getSourceFile());
1525 
1526         // Set the source shader's text. If for SPV version 1.0, include
1527         // a preamble in comments stating the OpModuleProcessed instructions.
1528         // Otherwise, emit those as actual instructions.
1529         std::string text;
1530         const std::vector<std::string>& processes = glslangIntermediate->getProcesses();
1531         for (int p = 0; p < (int)processes.size(); ++p) {
1532             if (glslangIntermediate->getSpv().spv < glslang::EShTargetSpv_1_1) {
1533                 text.append("// OpModuleProcessed ");
1534                 text.append(processes[p]);
1535                 text.append("\n");
1536             } else
1537                 builder.addModuleProcessed(processes[p]);
1538         }
1539         if (glslangIntermediate->getSpv().spv < glslang::EShTargetSpv_1_1 && (int)processes.size() > 0)
1540             text.append("#line 1\n");
1541         text.append(glslangIntermediate->getSourceText());
1542         builder.setSourceText(text);
1543         // Pass name and text for all included files
1544         const std::map<std::string, std::string>& include_txt = glslangIntermediate->getIncludeText();
1545         for (auto iItr = include_txt.begin(); iItr != include_txt.end(); ++iItr)
1546             builder.addInclude(iItr->first, iItr->second);
1547     }
1548     stdBuiltins = builder.import("GLSL.std.450");
1549 
1550     spv::AddressingModel addressingModel = spv::AddressingModelLogical;
1551     spv::MemoryModel memoryModel = spv::MemoryModelGLSL450;
1552 
1553     if (glslangIntermediate->usingPhysicalStorageBuffer()) {
1554         addressingModel = spv::AddressingModelPhysicalStorageBuffer64EXT;
1555         builder.addIncorporatedExtension(spv::E_SPV_KHR_physical_storage_buffer, spv::Spv_1_5);
1556         builder.addCapability(spv::CapabilityPhysicalStorageBufferAddressesEXT);
1557     }
1558     if (glslangIntermediate->usingVulkanMemoryModel()) {
1559         memoryModel = spv::MemoryModelVulkanKHR;
1560         builder.addCapability(spv::CapabilityVulkanMemoryModelKHR);
1561         builder.addIncorporatedExtension(spv::E_SPV_KHR_vulkan_memory_model, spv::Spv_1_5);
1562     }
1563     builder.setMemoryModel(addressingModel, memoryModel);
1564 
1565     if (glslangIntermediate->usingVariablePointers()) {
1566         builder.addCapability(spv::CapabilityVariablePointers);
1567     }
1568 
1569     shaderEntry = builder.makeEntryPoint(glslangIntermediate->getEntryPointName().c_str());
1570     entryPoint = builder.addEntryPoint(executionModel, shaderEntry, glslangIntermediate->getEntryPointName().c_str());
1571 
1572     // Add the source extensions
1573     const auto& sourceExtensions = glslangIntermediate->getRequestedExtensions();
1574     for (auto it = sourceExtensions.begin(); it != sourceExtensions.end(); ++it)
1575         builder.addSourceExtension(it->c_str());
1576 
1577     // Add the top-level modes for this shader.
1578 
1579     if (glslangIntermediate->getXfbMode()) {
1580         builder.addCapability(spv::CapabilityTransformFeedback);
1581         builder.addExecutionMode(shaderEntry, spv::ExecutionModeXfb);
1582     }
1583 
1584     if (glslangIntermediate->getLayoutPrimitiveCulling()) {
1585         builder.addCapability(spv::CapabilityRayTraversalPrimitiveCullingKHR);
1586     }
1587 
1588 #ifndef GLSLANG_WEB
1589     if (glslangIntermediate->getSubgroupUniformControlFlow()) {
1590         builder.addExtension(spv::E_SPV_KHR_subgroup_uniform_control_flow);
1591         builder.addExecutionMode(shaderEntry, spv::ExecutionModeSubgroupUniformControlFlowKHR);
1592     }
1593 #endif
1594 
1595     unsigned int mode;
1596     switch (glslangIntermediate->getStage()) {
1597     case EShLangVertex:
1598         builder.addCapability(spv::CapabilityShader);
1599         break;
1600 
1601     case EShLangFragment:
1602         builder.addCapability(spv::CapabilityShader);
1603         if (glslangIntermediate->getPixelCenterInteger())
1604             builder.addExecutionMode(shaderEntry, spv::ExecutionModePixelCenterInteger);
1605 
1606         if (glslangIntermediate->getOriginUpperLeft())
1607             builder.addExecutionMode(shaderEntry, spv::ExecutionModeOriginUpperLeft);
1608         else
1609             builder.addExecutionMode(shaderEntry, spv::ExecutionModeOriginLowerLeft);
1610 
1611         if (glslangIntermediate->getEarlyFragmentTests())
1612             builder.addExecutionMode(shaderEntry, spv::ExecutionModeEarlyFragmentTests);
1613 
1614         if (glslangIntermediate->getPostDepthCoverage()) {
1615             builder.addCapability(spv::CapabilitySampleMaskPostDepthCoverage);
1616             builder.addExecutionMode(shaderEntry, spv::ExecutionModePostDepthCoverage);
1617             builder.addExtension(spv::E_SPV_KHR_post_depth_coverage);
1618         }
1619 
1620         if (glslangIntermediate->isDepthReplacing())
1621             builder.addExecutionMode(shaderEntry, spv::ExecutionModeDepthReplacing);
1622 
1623 #ifndef GLSLANG_WEB
1624 
1625         switch(glslangIntermediate->getDepth()) {
1626         case glslang::EldGreater:   mode = spv::ExecutionModeDepthGreater;   break;
1627         case glslang::EldLess:      mode = spv::ExecutionModeDepthLess;      break;
1628         case glslang::EldUnchanged: mode = spv::ExecutionModeDepthUnchanged; break;
1629         default:                    mode = spv::ExecutionModeMax;            break;
1630         }
1631         if (mode != spv::ExecutionModeMax)
1632             builder.addExecutionMode(shaderEntry, (spv::ExecutionMode)mode);
1633         switch (glslangIntermediate->getInterlockOrdering()) {
1634         case glslang::EioPixelInterlockOrdered:         mode = spv::ExecutionModePixelInterlockOrderedEXT;
1635             break;
1636         case glslang::EioPixelInterlockUnordered:       mode = spv::ExecutionModePixelInterlockUnorderedEXT;
1637             break;
1638         case glslang::EioSampleInterlockOrdered:        mode = spv::ExecutionModeSampleInterlockOrderedEXT;
1639             break;
1640         case glslang::EioSampleInterlockUnordered:      mode = spv::ExecutionModeSampleInterlockUnorderedEXT;
1641             break;
1642         case glslang::EioShadingRateInterlockOrdered:   mode = spv::ExecutionModeShadingRateInterlockOrderedEXT;
1643             break;
1644         case glslang::EioShadingRateInterlockUnordered: mode = spv::ExecutionModeShadingRateInterlockUnorderedEXT;
1645             break;
1646         default:                                        mode = spv::ExecutionModeMax;
1647             break;
1648         }
1649         if (mode != spv::ExecutionModeMax) {
1650             builder.addExecutionMode(shaderEntry, (spv::ExecutionMode)mode);
1651             if (mode == spv::ExecutionModeShadingRateInterlockOrderedEXT ||
1652                 mode == spv::ExecutionModeShadingRateInterlockUnorderedEXT) {
1653                 builder.addCapability(spv::CapabilityFragmentShaderShadingRateInterlockEXT);
1654             } else if (mode == spv::ExecutionModePixelInterlockOrderedEXT ||
1655                        mode == spv::ExecutionModePixelInterlockUnorderedEXT) {
1656                 builder.addCapability(spv::CapabilityFragmentShaderPixelInterlockEXT);
1657             } else {
1658                 builder.addCapability(spv::CapabilityFragmentShaderSampleInterlockEXT);
1659             }
1660             builder.addExtension(spv::E_SPV_EXT_fragment_shader_interlock);
1661         }
1662 #endif
1663     break;
1664 
1665     case EShLangCompute:
1666         builder.addCapability(spv::CapabilityShader);
1667         if (glslangIntermediate->getSpv().spv >= glslang::EShTargetSpv_1_6) {
1668           std::vector<spv::Id> dimConstId;
1669           for (int dim = 0; dim < 3; ++dim) {
1670             bool specConst = (glslangIntermediate->getLocalSizeSpecId(dim) != glslang::TQualifier::layoutNotSet);
1671             dimConstId.push_back(builder.makeUintConstant(glslangIntermediate->getLocalSize(dim), specConst));
1672             if (specConst) {
1673                 builder.addDecoration(dimConstId.back(), spv::DecorationSpecId,
1674                                       glslangIntermediate->getLocalSizeSpecId(dim));
1675             }
1676           }
1677           builder.addExecutionModeId(shaderEntry, spv::ExecutionModeLocalSizeId, dimConstId);
1678         } else {
1679           builder.addExecutionMode(shaderEntry, spv::ExecutionModeLocalSize, glslangIntermediate->getLocalSize(0),
1680                                                                              glslangIntermediate->getLocalSize(1),
1681                                                                              glslangIntermediate->getLocalSize(2));
1682         }
1683         if (glslangIntermediate->getLayoutDerivativeModeNone() == glslang::LayoutDerivativeGroupQuads) {
1684             builder.addCapability(spv::CapabilityComputeDerivativeGroupQuadsNV);
1685             builder.addExecutionMode(shaderEntry, spv::ExecutionModeDerivativeGroupQuadsNV);
1686             builder.addExtension(spv::E_SPV_NV_compute_shader_derivatives);
1687         } else if (glslangIntermediate->getLayoutDerivativeModeNone() == glslang::LayoutDerivativeGroupLinear) {
1688             builder.addCapability(spv::CapabilityComputeDerivativeGroupLinearNV);
1689             builder.addExecutionMode(shaderEntry, spv::ExecutionModeDerivativeGroupLinearNV);
1690             builder.addExtension(spv::E_SPV_NV_compute_shader_derivatives);
1691         }
1692         break;
1693 #ifndef GLSLANG_WEB
1694     case EShLangTessEvaluation:
1695     case EShLangTessControl:
1696         builder.addCapability(spv::CapabilityTessellation);
1697 
1698         glslang::TLayoutGeometry primitive;
1699 
1700         if (glslangIntermediate->getStage() == EShLangTessControl) {
1701             builder.addExecutionMode(shaderEntry, spv::ExecutionModeOutputVertices,
1702                 glslangIntermediate->getVertices());
1703             primitive = glslangIntermediate->getOutputPrimitive();
1704         } else {
1705             primitive = glslangIntermediate->getInputPrimitive();
1706         }
1707 
1708         switch (primitive) {
1709         case glslang::ElgTriangles:           mode = spv::ExecutionModeTriangles;     break;
1710         case glslang::ElgQuads:               mode = spv::ExecutionModeQuads;         break;
1711         case glslang::ElgIsolines:            mode = spv::ExecutionModeIsolines;      break;
1712         default:                              mode = spv::ExecutionModeMax;           break;
1713         }
1714         if (mode != spv::ExecutionModeMax)
1715             builder.addExecutionMode(shaderEntry, (spv::ExecutionMode)mode);
1716 
1717         switch (glslangIntermediate->getVertexSpacing()) {
1718         case glslang::EvsEqual:            mode = spv::ExecutionModeSpacingEqual;          break;
1719         case glslang::EvsFractionalEven:   mode = spv::ExecutionModeSpacingFractionalEven; break;
1720         case glslang::EvsFractionalOdd:    mode = spv::ExecutionModeSpacingFractionalOdd;  break;
1721         default:                           mode = spv::ExecutionModeMax;                   break;
1722         }
1723         if (mode != spv::ExecutionModeMax)
1724             builder.addExecutionMode(shaderEntry, (spv::ExecutionMode)mode);
1725 
1726         switch (glslangIntermediate->getVertexOrder()) {
1727         case glslang::EvoCw:     mode = spv::ExecutionModeVertexOrderCw;  break;
1728         case glslang::EvoCcw:    mode = spv::ExecutionModeVertexOrderCcw; break;
1729         default:                 mode = spv::ExecutionModeMax;            break;
1730         }
1731         if (mode != spv::ExecutionModeMax)
1732             builder.addExecutionMode(shaderEntry, (spv::ExecutionMode)mode);
1733 
1734         if (glslangIntermediate->getPointMode())
1735             builder.addExecutionMode(shaderEntry, spv::ExecutionModePointMode);
1736         break;
1737 
1738     case EShLangGeometry:
1739         builder.addCapability(spv::CapabilityGeometry);
1740         switch (glslangIntermediate->getInputPrimitive()) {
1741         case glslang::ElgPoints:             mode = spv::ExecutionModeInputPoints;             break;
1742         case glslang::ElgLines:              mode = spv::ExecutionModeInputLines;              break;
1743         case glslang::ElgLinesAdjacency:     mode = spv::ExecutionModeInputLinesAdjacency;     break;
1744         case glslang::ElgTriangles:          mode = spv::ExecutionModeTriangles;               break;
1745         case glslang::ElgTrianglesAdjacency: mode = spv::ExecutionModeInputTrianglesAdjacency; break;
1746         default:                             mode = spv::ExecutionModeMax;                     break;
1747         }
1748         if (mode != spv::ExecutionModeMax)
1749             builder.addExecutionMode(shaderEntry, (spv::ExecutionMode)mode);
1750 
1751         builder.addExecutionMode(shaderEntry, spv::ExecutionModeInvocations, glslangIntermediate->getInvocations());
1752 
1753         switch (glslangIntermediate->getOutputPrimitive()) {
1754         case glslang::ElgPoints:        mode = spv::ExecutionModeOutputPoints;                 break;
1755         case glslang::ElgLineStrip:     mode = spv::ExecutionModeOutputLineStrip;              break;
1756         case glslang::ElgTriangleStrip: mode = spv::ExecutionModeOutputTriangleStrip;          break;
1757         default:                        mode = spv::ExecutionModeMax;                          break;
1758         }
1759         if (mode != spv::ExecutionModeMax)
1760             builder.addExecutionMode(shaderEntry, (spv::ExecutionMode)mode);
1761         builder.addExecutionMode(shaderEntry, spv::ExecutionModeOutputVertices, glslangIntermediate->getVertices());
1762         break;
1763 
1764     case EShLangRayGen:
1765     case EShLangIntersect:
1766     case EShLangAnyHit:
1767     case EShLangClosestHit:
1768     case EShLangMiss:
1769     case EShLangCallable:
1770     {
1771         auto& extensions = glslangIntermediate->getRequestedExtensions();
1772         if (extensions.find("GL_NV_ray_tracing") == extensions.end()) {
1773             builder.addCapability(spv::CapabilityRayTracingKHR);
1774             builder.addExtension("SPV_KHR_ray_tracing");
1775         }
1776         else {
1777             builder.addCapability(spv::CapabilityRayTracingNV);
1778             builder.addExtension("SPV_NV_ray_tracing");
1779         }
1780         break;
1781     }
1782     case EShLangTaskNV:
1783     case EShLangMeshNV:
1784         builder.addCapability(spv::CapabilityMeshShadingNV);
1785         builder.addExtension(spv::E_SPV_NV_mesh_shader);
1786         if (glslangIntermediate->getSpv().spv >= glslang::EShTargetSpv_1_6) {
1787             std::vector<spv::Id> dimConstId;
1788             for (int dim = 0; dim < 3; ++dim) {
1789                 bool specConst = (glslangIntermediate->getLocalSizeSpecId(dim) != glslang::TQualifier::layoutNotSet);
1790                 dimConstId.push_back(builder.makeUintConstant(glslangIntermediate->getLocalSize(dim), specConst));
1791                 if (specConst) {
1792                     builder.addDecoration(dimConstId.back(), spv::DecorationSpecId,
1793                                           glslangIntermediate->getLocalSizeSpecId(dim));
1794                 }
1795             }
1796             builder.addExecutionModeId(shaderEntry, spv::ExecutionModeLocalSizeId, dimConstId);
1797         } else {
1798             builder.addExecutionMode(shaderEntry, spv::ExecutionModeLocalSize, glslangIntermediate->getLocalSize(0),
1799                                                                                glslangIntermediate->getLocalSize(1),
1800                                                                                glslangIntermediate->getLocalSize(2));
1801         }
1802         if (glslangIntermediate->getStage() == EShLangMeshNV) {
1803             builder.addExecutionMode(shaderEntry, spv::ExecutionModeOutputVertices,
1804                 glslangIntermediate->getVertices());
1805             builder.addExecutionMode(shaderEntry, spv::ExecutionModeOutputPrimitivesNV,
1806                 glslangIntermediate->getPrimitives());
1807 
1808             switch (glslangIntermediate->getOutputPrimitive()) {
1809             case glslang::ElgPoints:        mode = spv::ExecutionModeOutputPoints;      break;
1810             case glslang::ElgLines:         mode = spv::ExecutionModeOutputLinesNV;     break;
1811             case glslang::ElgTriangles:     mode = spv::ExecutionModeOutputTrianglesNV; break;
1812             default:                        mode = spv::ExecutionModeMax;               break;
1813             }
1814             if (mode != spv::ExecutionModeMax)
1815                 builder.addExecutionMode(shaderEntry, (spv::ExecutionMode)mode);
1816         }
1817         break;
1818 #endif
1819 
1820     default:
1821         break;
1822     }
1823 
1824 #ifndef GLSLANG_WEB
1825     //
1826     // Add SPIR-V requirements (GL_EXT_spirv_intrinsics)
1827     //
1828     if (glslangIntermediate->hasSpirvRequirement()) {
1829         const glslang::TSpirvRequirement& spirvRequirement = glslangIntermediate->getSpirvRequirement();
1830 
1831         // Add SPIR-V extension requirement
1832         for (auto& extension : spirvRequirement.extensions)
1833             builder.addExtension(extension.c_str());
1834 
1835         // Add SPIR-V capability requirement
1836         for (auto capability : spirvRequirement.capabilities)
1837             builder.addCapability(static_cast<spv::Capability>(capability));
1838     }
1839 
1840     //
1841     // Add SPIR-V execution mode qualifiers (GL_EXT_spirv_intrinsics)
1842     //
1843     if (glslangIntermediate->hasSpirvExecutionMode()) {
1844         const glslang::TSpirvExecutionMode spirvExecutionMode = glslangIntermediate->getSpirvExecutionMode();
1845 
1846         // Add spirv_execution_mode
1847         for (auto& mode : spirvExecutionMode.modes) {
1848             if (!mode.second.empty()) {
1849                 std::vector<unsigned> literals;
1850                 TranslateLiterals(mode.second, literals);
1851                 builder.addExecutionMode(shaderEntry, static_cast<spv::ExecutionMode>(mode.first), literals);
1852             } else
1853                 builder.addExecutionMode(shaderEntry, static_cast<spv::ExecutionMode>(mode.first));
1854         }
1855 
1856         // Add spirv_execution_mode_id
1857         for (auto& modeId : spirvExecutionMode.modeIds) {
1858             std::vector<spv::Id> operandIds;
1859             assert(!modeId.second.empty());
1860             for (auto extraOperand : modeId.second) {
1861                 if (extraOperand->getType().getQualifier().isSpecConstant())
1862                     operandIds.push_back(getSymbolId(extraOperand->getAsSymbolNode()));
1863                 else
1864                     operandIds.push_back(createSpvConstant(*extraOperand));
1865             }
1866             builder.addExecutionModeId(shaderEntry, static_cast<spv::ExecutionMode>(modeId.first), operandIds);
1867         }
1868     }
1869 #endif
1870 }
1871 
1872 // Finish creating SPV, after the traversal is complete.
finishSpv()1873 void TGlslangToSpvTraverser::finishSpv()
1874 {
1875     // Finish the entry point function
1876     if (! entryPointTerminated) {
1877         builder.setBuildPoint(shaderEntry->getLastBlock());
1878         builder.leaveFunction();
1879     }
1880 
1881     // finish off the entry-point SPV instruction by adding the Input/Output <id>
1882     for (auto it = iOSet.cbegin(); it != iOSet.cend(); ++it)
1883         entryPoint->addIdOperand(*it);
1884 
1885     // Add capabilities, extensions, remove unneeded decorations, etc.,
1886     // based on the resulting SPIR-V.
1887     // Note: WebGPU code generation must have the opportunity to aggressively
1888     // prune unreachable merge blocks and continue targets.
1889     builder.postProcess();
1890 }
1891 
1892 // Write the SPV into 'out'.
dumpSpv(std::vector<unsigned int> & out)1893 void TGlslangToSpvTraverser::dumpSpv(std::vector<unsigned int>& out)
1894 {
1895     builder.dump(out);
1896 }
1897 
1898 //
1899 // Implement the traversal functions.
1900 //
1901 // Return true from interior nodes to have the external traversal
1902 // continue on to children.  Return false if children were
1903 // already processed.
1904 //
1905 
1906 //
1907 // Symbols can turn into
1908 //  - uniform/input reads
1909 //  - output writes
1910 //  - complex lvalue base setups:  foo.bar[3]....  , where we see foo and start up an access chain
1911 //  - something simple that degenerates into the last bullet
1912 //
visitSymbol(glslang::TIntermSymbol * symbol)1913 void TGlslangToSpvTraverser::visitSymbol(glslang::TIntermSymbol* symbol)
1914 {
1915     SpecConstantOpModeGuard spec_constant_op_mode_setter(&builder);
1916     if (symbol->getType().isStruct())
1917         glslangTypeToIdMap[symbol->getType().getStruct()] = symbol->getId();
1918 
1919     if (symbol->getType().getQualifier().isSpecConstant())
1920         spec_constant_op_mode_setter.turnOnSpecConstantOpMode();
1921 
1922 #ifdef ENABLE_HLSL
1923     // Skip symbol handling if it is string-typed
1924     if (symbol->getBasicType() == glslang::EbtString)
1925         return;
1926 #endif
1927 
1928     // getSymbolId() will set up all the IO decorations on the first call.
1929     // Formal function parameters were mapped during makeFunctions().
1930     spv::Id id = getSymbolId(symbol);
1931 
1932     if (builder.isPointer(id)) {
1933         if (!symbol->getType().getQualifier().isParamInput() &&
1934             !symbol->getType().getQualifier().isParamOutput()) {
1935             // Include all "static use" and "linkage only" interface variables on the OpEntryPoint instruction
1936             // Consider adding to the OpEntryPoint interface list.
1937             // Only looking at structures if they have at least one member.
1938             if (!symbol->getType().isStruct() || symbol->getType().getStruct()->size() > 0) {
1939                 spv::StorageClass sc = builder.getStorageClass(id);
1940                 // Before SPIR-V 1.4, we only want to include Input and Output.
1941                 // Starting with SPIR-V 1.4, we want all globals.
1942                 if ((glslangIntermediate->getSpv().spv >= glslang::EShTargetSpv_1_4 && builder.isGlobalStorage(id)) ||
1943                     (sc == spv::StorageClassInput || sc == spv::StorageClassOutput)) {
1944                     iOSet.insert(id);
1945                 }
1946             }
1947         }
1948 
1949         // If the SPIR-V type is required to be different than the AST type
1950         // (for ex SubgroupMasks or 3x4 ObjectToWorld/WorldToObject matrices),
1951         // translate now from the SPIR-V type to the AST type, for the consuming
1952         // operation.
1953         // Note this turns it from an l-value to an r-value.
1954         // Currently, all symbols needing this are inputs; avoid the map lookup when non-input.
1955         if (symbol->getType().getQualifier().storage == glslang::EvqVaryingIn)
1956             id = translateForcedType(id);
1957     }
1958 
1959     // Only process non-linkage-only nodes for generating actual static uses
1960     if (! linkageOnly || symbol->getQualifier().isSpecConstant()) {
1961         // Prepare to generate code for the access
1962 
1963         // L-value chains will be computed left to right.  We're on the symbol now,
1964         // which is the left-most part of the access chain, so now is "clear" time,
1965         // followed by setting the base.
1966         builder.clearAccessChain();
1967 
1968         // For now, we consider all user variables as being in memory, so they are pointers,
1969         // except for
1970         // A) R-Value arguments to a function, which are an intermediate object.
1971         //    See comments in handleUserFunctionCall().
1972         // B) Specialization constants (normal constants don't even come in as a variable),
1973         //    These are also pure R-values.
1974         // C) R-Values from type translation, see above call to translateForcedType()
1975         glslang::TQualifier qualifier = symbol->getQualifier();
1976         if (qualifier.isSpecConstant() || rValueParameters.find(symbol->getId()) != rValueParameters.end() ||
1977             !builder.isPointerType(builder.getTypeId(id)))
1978             builder.setAccessChainRValue(id);
1979         else
1980             builder.setAccessChainLValue(id);
1981     }
1982 
1983 #ifdef ENABLE_HLSL
1984     // Process linkage-only nodes for any special additional interface work.
1985     if (linkageOnly) {
1986         if (glslangIntermediate->getHlslFunctionality1()) {
1987             // Map implicit counter buffers to their originating buffers, which should have been
1988             // seen by now, given earlier pruning of unused counters, and preservation of order
1989             // of declaration.
1990             if (symbol->getType().getQualifier().isUniformOrBuffer()) {
1991                 if (!glslangIntermediate->hasCounterBufferName(symbol->getName())) {
1992                     // Save possible originating buffers for counter buffers, keyed by
1993                     // making the potential counter-buffer name.
1994                     std::string keyName = symbol->getName().c_str();
1995                     keyName = glslangIntermediate->addCounterBufferName(keyName);
1996                     counterOriginator[keyName] = symbol;
1997                 } else {
1998                     // Handle a counter buffer, by finding the saved originating buffer.
1999                     std::string keyName = symbol->getName().c_str();
2000                     auto it = counterOriginator.find(keyName);
2001                     if (it != counterOriginator.end()) {
2002                         id = getSymbolId(it->second);
2003                         if (id != spv::NoResult) {
2004                             spv::Id counterId = getSymbolId(symbol);
2005                             if (counterId != spv::NoResult) {
2006                                 builder.addExtension("SPV_GOOGLE_hlsl_functionality1");
2007                                 builder.addDecorationId(id, spv::DecorationHlslCounterBufferGOOGLE, counterId);
2008                             }
2009                         }
2010                     }
2011                 }
2012             }
2013         }
2014     }
2015 #endif
2016 }
2017 
visitBinary(glslang::TVisit,glslang::TIntermBinary * node)2018 bool TGlslangToSpvTraverser::visitBinary(glslang::TVisit /* visit */, glslang::TIntermBinary* node)
2019 {
2020     builder.setLine(node->getLoc().line, node->getLoc().getFilename());
2021     if (node->getLeft()->getAsSymbolNode() != nullptr && node->getLeft()->getType().isStruct()) {
2022         glslangTypeToIdMap[node->getLeft()->getType().getStruct()] = node->getLeft()->getAsSymbolNode()->getId();
2023     }
2024     if (node->getRight()->getAsSymbolNode() != nullptr && node->getRight()->getType().isStruct()) {
2025         glslangTypeToIdMap[node->getRight()->getType().getStruct()] = node->getRight()->getAsSymbolNode()->getId();
2026     }
2027 
2028     SpecConstantOpModeGuard spec_constant_op_mode_setter(&builder);
2029     if (node->getType().getQualifier().isSpecConstant())
2030         spec_constant_op_mode_setter.turnOnSpecConstantOpMode();
2031 
2032     // First, handle special cases
2033     switch (node->getOp()) {
2034     case glslang::EOpAssign:
2035     case glslang::EOpAddAssign:
2036     case glslang::EOpSubAssign:
2037     case glslang::EOpMulAssign:
2038     case glslang::EOpVectorTimesMatrixAssign:
2039     case glslang::EOpVectorTimesScalarAssign:
2040     case glslang::EOpMatrixTimesScalarAssign:
2041     case glslang::EOpMatrixTimesMatrixAssign:
2042     case glslang::EOpDivAssign:
2043     case glslang::EOpModAssign:
2044     case glslang::EOpAndAssign:
2045     case glslang::EOpInclusiveOrAssign:
2046     case glslang::EOpExclusiveOrAssign:
2047     case glslang::EOpLeftShiftAssign:
2048     case glslang::EOpRightShiftAssign:
2049         // A bin-op assign "a += b" means the same thing as "a = a + b"
2050         // where a is evaluated before b. For a simple assignment, GLSL
2051         // says to evaluate the left before the right.  So, always, left
2052         // node then right node.
2053         {
2054             // get the left l-value, save it away
2055             builder.clearAccessChain();
2056             node->getLeft()->traverse(this);
2057             spv::Builder::AccessChain lValue = builder.getAccessChain();
2058 
2059             // evaluate the right
2060             builder.clearAccessChain();
2061             node->getRight()->traverse(this);
2062             spv::Id rValue = accessChainLoad(node->getRight()->getType());
2063 
2064             if (node->getOp() != glslang::EOpAssign) {
2065                 // the left is also an r-value
2066                 builder.setAccessChain(lValue);
2067                 spv::Id leftRValue = accessChainLoad(node->getLeft()->getType());
2068 
2069                 // do the operation
2070                 spv::Builder::AccessChain::CoherentFlags coherentFlags = TranslateCoherent(node->getLeft()->getType());
2071                 coherentFlags |= TranslateCoherent(node->getRight()->getType());
2072                 OpDecorations decorations = { TranslatePrecisionDecoration(node->getOperationPrecision()),
2073                                               TranslateNoContractionDecoration(node->getType().getQualifier()),
2074                                               TranslateNonUniformDecoration(coherentFlags) };
2075                 rValue = createBinaryOperation(node->getOp(), decorations,
2076                                                convertGlslangToSpvType(node->getType()), leftRValue, rValue,
2077                                                node->getType().getBasicType());
2078 
2079                 // these all need their counterparts in createBinaryOperation()
2080                 assert(rValue != spv::NoResult);
2081             }
2082 
2083             // store the result
2084             builder.setAccessChain(lValue);
2085             multiTypeStore(node->getLeft()->getType(), rValue);
2086 
2087             // assignments are expressions having an rValue after they are evaluated...
2088             builder.clearAccessChain();
2089             builder.setAccessChainRValue(rValue);
2090         }
2091         return false;
2092     case glslang::EOpIndexDirect:
2093     case glslang::EOpIndexDirectStruct:
2094         {
2095             // Structure, array, matrix, or vector indirection with statically known index.
2096             // Get the left part of the access chain.
2097             node->getLeft()->traverse(this);
2098 
2099             // Add the next element in the chain
2100 
2101             const int glslangIndex = node->getRight()->getAsConstantUnion()->getConstArray()[0].getIConst();
2102             if (! node->getLeft()->getType().isArray() &&
2103                 node->getLeft()->getType().isVector() &&
2104                 node->getOp() == glslang::EOpIndexDirect) {
2105                 // Swizzle is uniform so propagate uniform into access chain
2106                 spv::Builder::AccessChain::CoherentFlags coherentFlags = TranslateCoherent(node->getLeft()->getType());
2107                 coherentFlags.nonUniform = 0;
2108                 // This is essentially a hard-coded vector swizzle of size 1,
2109                 // so short circuit the access-chain stuff with a swizzle.
2110                 std::vector<unsigned> swizzle;
2111                 swizzle.push_back(glslangIndex);
2112                 int dummySize;
2113                 builder.accessChainPushSwizzle(swizzle, convertGlslangToSpvType(node->getLeft()->getType()),
2114                                                coherentFlags,
2115                                                glslangIntermediate->getBaseAlignmentScalar(
2116                                                    node->getLeft()->getType(), dummySize));
2117             } else {
2118 
2119                 // Load through a block reference is performed with a dot operator that
2120                 // is mapped to EOpIndexDirectStruct. When we get to the actual reference,
2121                 // do a load and reset the access chain.
2122                 if (node->getLeft()->isReference() &&
2123                     !node->getLeft()->getType().isArray() &&
2124                     node->getOp() == glslang::EOpIndexDirectStruct)
2125                 {
2126                     spv::Id left = accessChainLoad(node->getLeft()->getType());
2127                     builder.clearAccessChain();
2128                     builder.setAccessChainLValue(left);
2129                 }
2130 
2131                 int spvIndex = glslangIndex;
2132                 if (node->getLeft()->getBasicType() == glslang::EbtBlock &&
2133                     node->getOp() == glslang::EOpIndexDirectStruct)
2134                 {
2135                     // This may be, e.g., an anonymous block-member selection, which generally need
2136                     // index remapping due to hidden members in anonymous blocks.
2137                     long long glslangId = glslangTypeToIdMap[node->getLeft()->getType().getStruct()];
2138                     if (memberRemapper.find(glslangId) != memberRemapper.end()) {
2139                         std::vector<int>& remapper = memberRemapper[glslangId];
2140                         assert(remapper.size() > 0);
2141                         spvIndex = remapper[glslangIndex];
2142                     }
2143                 }
2144 
2145                 // Struct reference propagates uniform lvalue
2146                 spv::Builder::AccessChain::CoherentFlags coherentFlags =
2147                         TranslateCoherent(node->getLeft()->getType());
2148                 coherentFlags.nonUniform = 0;
2149 
2150                 // normal case for indexing array or structure or block
2151                 builder.accessChainPush(builder.makeIntConstant(spvIndex),
2152                         coherentFlags,
2153                         node->getLeft()->getType().getBufferReferenceAlignment());
2154 
2155                 // Add capabilities here for accessing PointSize and clip/cull distance.
2156                 // We have deferred generation of associated capabilities until now.
2157                 if (node->getLeft()->getType().isStruct() && ! node->getLeft()->getType().isArray())
2158                     declareUseOfStructMember(*(node->getLeft()->getType().getStruct()), glslangIndex);
2159             }
2160         }
2161         return false;
2162     case glslang::EOpIndexIndirect:
2163         {
2164             // Array, matrix, or vector indirection with variable index.
2165             // Will use native SPIR-V access-chain for and array indirection;
2166             // matrices are arrays of vectors, so will also work for a matrix.
2167             // Will use the access chain's 'component' for variable index into a vector.
2168 
2169             // This adapter is building access chains left to right.
2170             // Set up the access chain to the left.
2171             node->getLeft()->traverse(this);
2172 
2173             // save it so that computing the right side doesn't trash it
2174             spv::Builder::AccessChain partial = builder.getAccessChain();
2175 
2176             // compute the next index in the chain
2177             builder.clearAccessChain();
2178             node->getRight()->traverse(this);
2179             spv::Id index = accessChainLoad(node->getRight()->getType());
2180 
2181             addIndirectionIndexCapabilities(node->getLeft()->getType(), node->getRight()->getType());
2182 
2183             // restore the saved access chain
2184             builder.setAccessChain(partial);
2185 
2186             // Only if index is nonUniform should we propagate nonUniform into access chain
2187             spv::Builder::AccessChain::CoherentFlags index_flags = TranslateCoherent(node->getRight()->getType());
2188             spv::Builder::AccessChain::CoherentFlags coherent_flags = TranslateCoherent(node->getLeft()->getType());
2189             coherent_flags.nonUniform = index_flags.nonUniform;
2190 
2191             if (! node->getLeft()->getType().isArray() && node->getLeft()->getType().isVector()) {
2192                 int dummySize;
2193                 builder.accessChainPushComponent(
2194                     index, convertGlslangToSpvType(node->getLeft()->getType()), coherent_flags,
2195                                                 glslangIntermediate->getBaseAlignmentScalar(node->getLeft()->getType(),
2196                                                 dummySize));
2197             } else
2198                 builder.accessChainPush(index, coherent_flags,
2199                                         node->getLeft()->getType().getBufferReferenceAlignment());
2200         }
2201         return false;
2202     case glslang::EOpVectorSwizzle:
2203         {
2204             node->getLeft()->traverse(this);
2205             std::vector<unsigned> swizzle;
2206             convertSwizzle(*node->getRight()->getAsAggregate(), swizzle);
2207             int dummySize;
2208             builder.accessChainPushSwizzle(swizzle, convertGlslangToSpvType(node->getLeft()->getType()),
2209                                            TranslateCoherent(node->getLeft()->getType()),
2210                                            glslangIntermediate->getBaseAlignmentScalar(node->getLeft()->getType(),
2211                                                dummySize));
2212         }
2213         return false;
2214     case glslang::EOpMatrixSwizzle:
2215         logger->missingFunctionality("matrix swizzle");
2216         return true;
2217     case glslang::EOpLogicalOr:
2218     case glslang::EOpLogicalAnd:
2219         {
2220 
2221             // These may require short circuiting, but can sometimes be done as straight
2222             // binary operations.  The right operand must be short circuited if it has
2223             // side effects, and should probably be if it is complex.
2224             if (isTrivial(node->getRight()->getAsTyped()))
2225                 break; // handle below as a normal binary operation
2226             // otherwise, we need to do dynamic short circuiting on the right operand
2227             spv::Id result = createShortCircuit(node->getOp(), *node->getLeft()->getAsTyped(),
2228                 *node->getRight()->getAsTyped());
2229             builder.clearAccessChain();
2230             builder.setAccessChainRValue(result);
2231         }
2232         return false;
2233     default:
2234         break;
2235     }
2236 
2237     // Assume generic binary op...
2238 
2239     // get right operand
2240     builder.clearAccessChain();
2241     node->getLeft()->traverse(this);
2242     spv::Id left = accessChainLoad(node->getLeft()->getType());
2243 
2244     // get left operand
2245     builder.clearAccessChain();
2246     node->getRight()->traverse(this);
2247     spv::Id right = accessChainLoad(node->getRight()->getType());
2248 
2249     // get result
2250     OpDecorations decorations = { TranslatePrecisionDecoration(node->getOperationPrecision()),
2251                                   TranslateNoContractionDecoration(node->getType().getQualifier()),
2252                                   TranslateNonUniformDecoration(node->getType().getQualifier()) };
2253     spv::Id result = createBinaryOperation(node->getOp(), decorations,
2254                                            convertGlslangToSpvType(node->getType()), left, right,
2255                                            node->getLeft()->getType().getBasicType());
2256 
2257     builder.clearAccessChain();
2258     if (! result) {
2259         logger->missingFunctionality("unknown glslang binary operation");
2260         return true;  // pick up a child as the place-holder result
2261     } else {
2262         builder.setAccessChainRValue(result);
2263         return false;
2264     }
2265 }
2266 
convertLoadedBoolInUniformToUint(const glslang::TType & type,spv::Id nominalTypeId,spv::Id loadedId)2267 spv::Id TGlslangToSpvTraverser::convertLoadedBoolInUniformToUint(const glslang::TType& type,
2268                                                                  spv::Id nominalTypeId,
2269                                                                  spv::Id loadedId)
2270 {
2271     if (builder.isScalarType(nominalTypeId)) {
2272         // Conversion for bool
2273         spv::Id boolType = builder.makeBoolType();
2274         if (nominalTypeId != boolType)
2275             return builder.createBinOp(spv::OpINotEqual, boolType, loadedId, builder.makeUintConstant(0));
2276     } else if (builder.isVectorType(nominalTypeId)) {
2277         // Conversion for bvec
2278         int vecSize = builder.getNumTypeComponents(nominalTypeId);
2279         spv::Id bvecType = builder.makeVectorType(builder.makeBoolType(), vecSize);
2280         if (nominalTypeId != bvecType)
2281             loadedId = builder.createBinOp(spv::OpINotEqual, bvecType, loadedId,
2282                 makeSmearedConstant(builder.makeUintConstant(0), vecSize));
2283     } else if (builder.isArrayType(nominalTypeId)) {
2284         // Conversion for bool array
2285         spv::Id boolArrayTypeId = convertGlslangToSpvType(type);
2286         if (nominalTypeId != boolArrayTypeId)
2287         {
2288             // Use OpCopyLogical from SPIR-V 1.4 if available.
2289             if (glslangIntermediate->getSpv().spv >= glslang::EShTargetSpv_1_4)
2290                 return builder.createUnaryOp(spv::OpCopyLogical, boolArrayTypeId, loadedId);
2291 
2292             glslang::TType glslangElementType(type, 0);
2293             spv::Id elementNominalTypeId = builder.getContainedTypeId(nominalTypeId);
2294             std::vector<spv::Id> constituents;
2295             for (int index = 0; index < type.getOuterArraySize(); ++index) {
2296                 // get the element
2297                 spv::Id elementValue = builder.createCompositeExtract(loadedId, elementNominalTypeId, index);
2298 
2299                 // recursively convert it
2300                 spv::Id elementConvertedValue = convertLoadedBoolInUniformToUint(glslangElementType, elementNominalTypeId, elementValue);
2301                 constituents.push_back(elementConvertedValue);
2302             }
2303             return builder.createCompositeConstruct(boolArrayTypeId, constituents);
2304         }
2305     }
2306 
2307     return loadedId;
2308 }
2309 
2310 // Figure out what, if any, type changes are needed when accessing a specific built-in.
2311 // Returns <the type SPIR-V requires for declarion, the type to translate to on use>.
2312 // Also see comment for 'forceType', regarding tracking SPIR-V-required types.
getForcedType(glslang::TBuiltInVariable glslangBuiltIn,const glslang::TType & glslangType)2313 std::pair<spv::Id, spv::Id> TGlslangToSpvTraverser::getForcedType(glslang::TBuiltInVariable glslangBuiltIn,
2314     const glslang::TType& glslangType)
2315 {
2316     switch(glslangBuiltIn)
2317     {
2318         case glslang::EbvSubGroupEqMask:
2319         case glslang::EbvSubGroupGeMask:
2320         case glslang::EbvSubGroupGtMask:
2321         case glslang::EbvSubGroupLeMask:
2322         case glslang::EbvSubGroupLtMask: {
2323             // these require changing a 64-bit scaler -> a vector of 32-bit components
2324             if (glslangType.isVector())
2325                 break;
2326             spv::Id ivec4_type = builder.makeVectorType(builder.makeUintType(32), 4);
2327             spv::Id uint64_type = builder.makeUintType(64);
2328             std::pair<spv::Id, spv::Id> ret(ivec4_type, uint64_type);
2329             return ret;
2330         }
2331         // There are no SPIR-V builtins defined for these and map onto original non-transposed
2332         // builtins. During visitBinary we insert a transpose
2333         case glslang::EbvWorldToObject3x4:
2334         case glslang::EbvObjectToWorld3x4: {
2335             spv::Id mat43 = builder.makeMatrixType(builder.makeFloatType(32), 4, 3);
2336             spv::Id mat34 = builder.makeMatrixType(builder.makeFloatType(32), 3, 4);
2337             std::pair<spv::Id, spv::Id> ret(mat43, mat34);
2338             return ret;
2339         }
2340         default:
2341             break;
2342     }
2343 
2344     std::pair<spv::Id, spv::Id> ret(spv::NoType, spv::NoType);
2345     return ret;
2346 }
2347 
2348 // For an object previously identified (see getForcedType() and forceType)
2349 // as needing type translations, do the translation needed for a load, turning
2350 // an L-value into in R-value.
translateForcedType(spv::Id object)2351 spv::Id TGlslangToSpvTraverser::translateForcedType(spv::Id object)
2352 {
2353     const auto forceIt = forceType.find(object);
2354     if (forceIt == forceType.end())
2355         return object;
2356 
2357     spv::Id desiredTypeId = forceIt->second;
2358     spv::Id objectTypeId = builder.getTypeId(object);
2359     assert(builder.isPointerType(objectTypeId));
2360     objectTypeId = builder.getContainedTypeId(objectTypeId);
2361     if (builder.isVectorType(objectTypeId) &&
2362         builder.getScalarTypeWidth(builder.getContainedTypeId(objectTypeId)) == 32) {
2363         if (builder.getScalarTypeWidth(desiredTypeId) == 64) {
2364             // handle 32-bit v.xy* -> 64-bit
2365             builder.clearAccessChain();
2366             builder.setAccessChainLValue(object);
2367             object = builder.accessChainLoad(spv::NoPrecision, spv::DecorationMax, spv::DecorationMax, objectTypeId);
2368             std::vector<spv::Id> components;
2369             components.push_back(builder.createCompositeExtract(object, builder.getContainedTypeId(objectTypeId), 0));
2370             components.push_back(builder.createCompositeExtract(object, builder.getContainedTypeId(objectTypeId), 1));
2371 
2372             spv::Id vecType = builder.makeVectorType(builder.getContainedTypeId(objectTypeId), 2);
2373             return builder.createUnaryOp(spv::OpBitcast, desiredTypeId,
2374                                          builder.createCompositeConstruct(vecType, components));
2375         } else {
2376             logger->missingFunctionality("forcing 32-bit vector type to non 64-bit scalar");
2377         }
2378     } else if (builder.isMatrixType(objectTypeId)) {
2379             // There are no SPIR-V builtins defined for 3x4 variants of ObjectToWorld/WorldToObject
2380             // and we insert a transpose after loading the original non-transposed builtins
2381             builder.clearAccessChain();
2382             builder.setAccessChainLValue(object);
2383             object = builder.accessChainLoad(spv::NoPrecision, spv::DecorationMax, spv::DecorationMax, objectTypeId);
2384             return builder.createUnaryOp(spv::OpTranspose, desiredTypeId, object);
2385 
2386     } else  {
2387         logger->missingFunctionality("forcing non 32-bit vector type");
2388     }
2389 
2390     return object;
2391 }
2392 
visitUnary(glslang::TVisit,glslang::TIntermUnary * node)2393 bool TGlslangToSpvTraverser::visitUnary(glslang::TVisit /* visit */, glslang::TIntermUnary* node)
2394 {
2395     builder.setLine(node->getLoc().line, node->getLoc().getFilename());
2396 
2397     SpecConstantOpModeGuard spec_constant_op_mode_setter(&builder);
2398     if (node->getType().getQualifier().isSpecConstant())
2399         spec_constant_op_mode_setter.turnOnSpecConstantOpMode();
2400 
2401     spv::Id result = spv::NoResult;
2402 
2403     // try texturing first
2404     result = createImageTextureFunctionCall(node);
2405     if (result != spv::NoResult) {
2406         builder.clearAccessChain();
2407         builder.setAccessChainRValue(result);
2408 
2409         return false; // done with this node
2410     }
2411 
2412     // Non-texturing.
2413 
2414     if (node->getOp() == glslang::EOpArrayLength) {
2415         // Quite special; won't want to evaluate the operand.
2416 
2417         // Currently, the front-end does not allow .length() on an array until it is sized,
2418         // except for the last block membeor of an SSBO.
2419         // TODO: If this changes, link-time sized arrays might show up here, and need their
2420         // size extracted.
2421 
2422         // Normal .length() would have been constant folded by the front-end.
2423         // So, this has to be block.lastMember.length().
2424         // SPV wants "block" and member number as the operands, go get them.
2425 
2426         spv::Id length;
2427         if (node->getOperand()->getType().isCoopMat()) {
2428             spec_constant_op_mode_setter.turnOnSpecConstantOpMode();
2429 
2430             spv::Id typeId = convertGlslangToSpvType(node->getOperand()->getType());
2431             assert(builder.isCooperativeMatrixType(typeId));
2432 
2433             length = builder.createCooperativeMatrixLength(typeId);
2434         } else {
2435             glslang::TIntermTyped* block = node->getOperand()->getAsBinaryNode()->getLeft();
2436             block->traverse(this);
2437             unsigned int member = node->getOperand()->getAsBinaryNode()->getRight()->getAsConstantUnion()
2438                 ->getConstArray()[0].getUConst();
2439             length = builder.createArrayLength(builder.accessChainGetLValue(), member);
2440         }
2441 
2442         // GLSL semantics say the result of .length() is an int, while SPIR-V says
2443         // signedness must be 0. So, convert from SPIR-V unsigned back to GLSL's
2444         // AST expectation of a signed result.
2445         if (glslangIntermediate->getSource() == glslang::EShSourceGlsl) {
2446             if (builder.isInSpecConstCodeGenMode()) {
2447                 length = builder.createBinOp(spv::OpIAdd, builder.makeIntType(32), length, builder.makeIntConstant(0));
2448             } else {
2449                 length = builder.createUnaryOp(spv::OpBitcast, builder.makeIntType(32), length);
2450             }
2451         }
2452 
2453         builder.clearAccessChain();
2454         builder.setAccessChainRValue(length);
2455 
2456         return false;
2457     }
2458 
2459     // Start by evaluating the operand
2460 
2461     // Does it need a swizzle inversion?  If so, evaluation is inverted;
2462     // operate first on the swizzle base, then apply the swizzle.
2463     spv::Id invertedType = spv::NoType;
2464     auto resultType = [&invertedType, &node, this](){ return invertedType != spv::NoType ?
2465         invertedType : convertGlslangToSpvType(node->getType()); };
2466     if (node->getOp() == glslang::EOpInterpolateAtCentroid)
2467         invertedType = getInvertedSwizzleType(*node->getOperand());
2468 
2469     builder.clearAccessChain();
2470     TIntermNode *operandNode;
2471     if (invertedType != spv::NoType)
2472         operandNode = node->getOperand()->getAsBinaryNode()->getLeft();
2473     else
2474         operandNode = node->getOperand();
2475 
2476     operandNode->traverse(this);
2477 
2478     spv::Id operand = spv::NoResult;
2479 
2480     spv::Builder::AccessChain::CoherentFlags lvalueCoherentFlags;
2481 
2482 #ifndef GLSLANG_WEB
2483     if (node->getOp() == glslang::EOpAtomicCounterIncrement ||
2484         node->getOp() == glslang::EOpAtomicCounterDecrement ||
2485         node->getOp() == glslang::EOpAtomicCounter          ||
2486         (node->getOp() == glslang::EOpInterpolateAtCentroid &&
2487           glslangIntermediate->getSource() != glslang::EShSourceHlsl)  ||
2488         node->getOp() == glslang::EOpRayQueryProceed        ||
2489         node->getOp() == glslang::EOpRayQueryGetRayTMin     ||
2490         node->getOp() == glslang::EOpRayQueryGetRayFlags    ||
2491         node->getOp() == glslang::EOpRayQueryGetWorldRayOrigin ||
2492         node->getOp() == glslang::EOpRayQueryGetWorldRayDirection ||
2493         node->getOp() == glslang::EOpRayQueryGetIntersectionCandidateAABBOpaque ||
2494         node->getOp() == glslang::EOpRayQueryTerminate ||
2495         node->getOp() == glslang::EOpRayQueryConfirmIntersection ||
2496         (node->getOp() == glslang::EOpSpirvInst && operandNode->getAsTyped()->getQualifier().isSpirvByReference())) {
2497         operand = builder.accessChainGetLValue(); // Special case l-value operands
2498         lvalueCoherentFlags = builder.getAccessChain().coherentFlags;
2499         lvalueCoherentFlags |= TranslateCoherent(operandNode->getAsTyped()->getType());
2500     } else if (operandNode->getAsTyped()->getQualifier().isSpirvLiteral()) {
2501         // Will be translated to a literal value, make a placeholder here
2502         operand = spv::NoResult;
2503     } else
2504 #endif
2505     {
2506         operand = accessChainLoad(node->getOperand()->getType());
2507     }
2508 
2509     OpDecorations decorations = { TranslatePrecisionDecoration(node->getOperationPrecision()),
2510                                   TranslateNoContractionDecoration(node->getType().getQualifier()),
2511                                   TranslateNonUniformDecoration(node->getType().getQualifier()) };
2512 
2513     // it could be a conversion
2514     if (! result)
2515         result = createConversion(node->getOp(), decorations, resultType(), operand,
2516             node->getOperand()->getBasicType());
2517 
2518     // if not, then possibly an operation
2519     if (! result)
2520         result = createUnaryOperation(node->getOp(), decorations, resultType(), operand,
2521             node->getOperand()->getBasicType(), lvalueCoherentFlags);
2522 
2523 #ifndef GLSLANG_WEB
2524     // it could be attached to a SPIR-V intruction
2525     if (!result) {
2526         if (node->getOp() == glslang::EOpSpirvInst) {
2527             const auto& spirvInst = node->getSpirvInstruction();
2528             if (spirvInst.set == "") {
2529                 spv::IdImmediate idImmOp = {true, operand};
2530                 if (operandNode->getAsTyped()->getQualifier().isSpirvLiteral()) {
2531                     // Translate the constant to a literal value
2532                     std::vector<unsigned> literals;
2533                     glslang::TVector<const glslang::TIntermConstantUnion*> constants;
2534                     constants.push_back(operandNode->getAsConstantUnion());
2535                     TranslateLiterals(constants, literals);
2536                     idImmOp = {false, literals[0]};
2537                 }
2538 
2539                 if (node->getBasicType() == glslang::EbtVoid)
2540                     builder.createNoResultOp(static_cast<spv::Op>(spirvInst.id), {idImmOp});
2541                 else
2542                     result = builder.createOp(static_cast<spv::Op>(spirvInst.id), resultType(), {idImmOp});
2543             } else {
2544                 result = builder.createBuiltinCall(
2545                     resultType(), spirvInst.set == "GLSL.std.450" ? stdBuiltins : getExtBuiltins(spirvInst.set.c_str()),
2546                     spirvInst.id, {operand});
2547             }
2548 
2549             if (node->getBasicType() == glslang::EbtVoid)
2550                 return false; // done with this node
2551         }
2552     }
2553 #endif
2554 
2555     if (result) {
2556         if (invertedType) {
2557             result = createInvertedSwizzle(decorations.precision, *node->getOperand(), result);
2558             decorations.addNonUniform(builder, result);
2559         }
2560 
2561         builder.clearAccessChain();
2562         builder.setAccessChainRValue(result);
2563 
2564         return false; // done with this node
2565     }
2566 
2567     // it must be a special case, check...
2568     switch (node->getOp()) {
2569     case glslang::EOpPostIncrement:
2570     case glslang::EOpPostDecrement:
2571     case glslang::EOpPreIncrement:
2572     case glslang::EOpPreDecrement:
2573         {
2574             // we need the integer value "1" or the floating point "1.0" to add/subtract
2575             spv::Id one = 0;
2576             if (node->getBasicType() == glslang::EbtFloat)
2577                 one = builder.makeFloatConstant(1.0F);
2578 #ifndef GLSLANG_WEB
2579             else if (node->getBasicType() == glslang::EbtDouble)
2580                 one = builder.makeDoubleConstant(1.0);
2581             else if (node->getBasicType() == glslang::EbtFloat16)
2582                 one = builder.makeFloat16Constant(1.0F);
2583             else if (node->getBasicType() == glslang::EbtInt8  || node->getBasicType() == glslang::EbtUint8)
2584                 one = builder.makeInt8Constant(1);
2585             else if (node->getBasicType() == glslang::EbtInt16 || node->getBasicType() == glslang::EbtUint16)
2586                 one = builder.makeInt16Constant(1);
2587             else if (node->getBasicType() == glslang::EbtInt64 || node->getBasicType() == glslang::EbtUint64)
2588                 one = builder.makeInt64Constant(1);
2589 #endif
2590             else
2591                 one = builder.makeIntConstant(1);
2592             glslang::TOperator op;
2593             if (node->getOp() == glslang::EOpPreIncrement ||
2594                 node->getOp() == glslang::EOpPostIncrement)
2595                 op = glslang::EOpAdd;
2596             else
2597                 op = glslang::EOpSub;
2598 
2599             spv::Id result = createBinaryOperation(op, decorations,
2600                                                    convertGlslangToSpvType(node->getType()), operand, one,
2601                                                    node->getType().getBasicType());
2602             assert(result != spv::NoResult);
2603 
2604             // The result of operation is always stored, but conditionally the
2605             // consumed result.  The consumed result is always an r-value.
2606             builder.accessChainStore(result,
2607                                      TranslateNonUniformDecoration(builder.getAccessChain().coherentFlags));
2608             builder.clearAccessChain();
2609             if (node->getOp() == glslang::EOpPreIncrement ||
2610                 node->getOp() == glslang::EOpPreDecrement)
2611                 builder.setAccessChainRValue(result);
2612             else
2613                 builder.setAccessChainRValue(operand);
2614         }
2615 
2616         return false;
2617 
2618 #ifndef GLSLANG_WEB
2619     case glslang::EOpEmitStreamVertex:
2620         builder.createNoResultOp(spv::OpEmitStreamVertex, operand);
2621         return false;
2622     case glslang::EOpEndStreamPrimitive:
2623         builder.createNoResultOp(spv::OpEndStreamPrimitive, operand);
2624         return false;
2625     case glslang::EOpRayQueryTerminate:
2626         builder.createNoResultOp(spv::OpRayQueryTerminateKHR, operand);
2627         return false;
2628     case glslang::EOpRayQueryConfirmIntersection:
2629         builder.createNoResultOp(spv::OpRayQueryConfirmIntersectionKHR, operand);
2630         return false;
2631 #endif
2632 
2633     default:
2634         logger->missingFunctionality("unknown glslang unary");
2635         return true;  // pick up operand as placeholder result
2636     }
2637 }
2638 
2639 // Construct a composite object, recursively copying members if their types don't match
createCompositeConstruct(spv::Id resultTypeId,std::vector<spv::Id> constituents)2640 spv::Id TGlslangToSpvTraverser::createCompositeConstruct(spv::Id resultTypeId, std::vector<spv::Id> constituents)
2641 {
2642     for (int c = 0; c < (int)constituents.size(); ++c) {
2643         spv::Id& constituent = constituents[c];
2644         spv::Id lType = builder.getContainedTypeId(resultTypeId, c);
2645         spv::Id rType = builder.getTypeId(constituent);
2646         if (lType != rType) {
2647             if (glslangIntermediate->getSpv().spv >= glslang::EShTargetSpv_1_4) {
2648                 constituent = builder.createUnaryOp(spv::OpCopyLogical, lType, constituent);
2649             } else if (builder.isStructType(rType)) {
2650                 std::vector<spv::Id> rTypeConstituents;
2651                 int numrTypeConstituents = builder.getNumTypeConstituents(rType);
2652                 for (int i = 0; i < numrTypeConstituents; ++i) {
2653                     rTypeConstituents.push_back(builder.createCompositeExtract(constituent,
2654                         builder.getContainedTypeId(rType, i), i));
2655                 }
2656                 constituents[c] = createCompositeConstruct(lType, rTypeConstituents);
2657             } else {
2658                 assert(builder.isArrayType(rType));
2659                 std::vector<spv::Id> rTypeConstituents;
2660                 int numrTypeConstituents = builder.getNumTypeConstituents(rType);
2661 
2662                 spv::Id elementRType = builder.getContainedTypeId(rType);
2663                 for (int i = 0; i < numrTypeConstituents; ++i) {
2664                     rTypeConstituents.push_back(builder.createCompositeExtract(constituent, elementRType, i));
2665                 }
2666                 constituents[c] = createCompositeConstruct(lType, rTypeConstituents);
2667             }
2668         }
2669     }
2670     return builder.createCompositeConstruct(resultTypeId, constituents);
2671 }
2672 
visitAggregate(glslang::TVisit visit,glslang::TIntermAggregate * node)2673 bool TGlslangToSpvTraverser::visitAggregate(glslang::TVisit visit, glslang::TIntermAggregate* node)
2674 {
2675     SpecConstantOpModeGuard spec_constant_op_mode_setter(&builder);
2676     if (node->getType().getQualifier().isSpecConstant())
2677         spec_constant_op_mode_setter.turnOnSpecConstantOpMode();
2678 
2679     spv::Id result = spv::NoResult;
2680     spv::Id invertedType = spv::NoType;                     // to use to override the natural type of the node
2681     std::vector<spv::Builder::AccessChain> complexLvalues;  // for holding swizzling l-values too complex for
2682                                                             // SPIR-V, for an out parameter
2683     std::vector<spv::Id> temporaryLvalues;                  // temporaries to pass, as proxies for complexLValues
2684 
2685     auto resultType = [&invertedType, &node, this](){ return invertedType != spv::NoType ?
2686         invertedType :
2687         convertGlslangToSpvType(node->getType()); };
2688 
2689     // try texturing
2690     result = createImageTextureFunctionCall(node);
2691     if (result != spv::NoResult) {
2692         builder.clearAccessChain();
2693         builder.setAccessChainRValue(result);
2694 
2695         return false;
2696     }
2697 #ifndef GLSLANG_WEB
2698     else if (node->getOp() == glslang::EOpImageStore ||
2699         node->getOp() == glslang::EOpImageStoreLod ||
2700         node->getOp() == glslang::EOpImageAtomicStore) {
2701         // "imageStore" is a special case, which has no result
2702         return false;
2703     }
2704 #endif
2705 
2706     glslang::TOperator binOp = glslang::EOpNull;
2707     bool reduceComparison = true;
2708     bool isMatrix = false;
2709     bool noReturnValue = false;
2710     bool atomic = false;
2711 
2712     spv::Builder::AccessChain::CoherentFlags lvalueCoherentFlags;
2713 
2714     assert(node->getOp());
2715 
2716     spv::Decoration precision = TranslatePrecisionDecoration(node->getOperationPrecision());
2717 
2718     switch (node->getOp()) {
2719     case glslang::EOpSequence:
2720     {
2721         if (preVisit)
2722             ++sequenceDepth;
2723         else
2724             --sequenceDepth;
2725 
2726         if (sequenceDepth == 1) {
2727             // If this is the parent node of all the functions, we want to see them
2728             // early, so all call points have actual SPIR-V functions to reference.
2729             // In all cases, still let the traverser visit the children for us.
2730             makeFunctions(node->getAsAggregate()->getSequence());
2731 
2732             // Also, we want all globals initializers to go into the beginning of the entry point, before
2733             // anything else gets there, so visit out of order, doing them all now.
2734             makeGlobalInitializers(node->getAsAggregate()->getSequence());
2735 
2736             //Pre process linker objects for ray tracing stages
2737             if (glslangIntermediate->isRayTracingStage())
2738                 collectRayTracingLinkerObjects();
2739 
2740             // Initializers are done, don't want to visit again, but functions and link objects need to be processed,
2741             // so do them manually.
2742             visitFunctions(node->getAsAggregate()->getSequence());
2743 
2744             return false;
2745         }
2746 
2747         return true;
2748     }
2749     case glslang::EOpLinkerObjects:
2750     {
2751         if (visit == glslang::EvPreVisit)
2752             linkageOnly = true;
2753         else
2754             linkageOnly = false;
2755 
2756         return true;
2757     }
2758     case glslang::EOpComma:
2759     {
2760         // processing from left to right naturally leaves the right-most
2761         // lying around in the access chain
2762         glslang::TIntermSequence& glslangOperands = node->getSequence();
2763         for (int i = 0; i < (int)glslangOperands.size(); ++i)
2764             glslangOperands[i]->traverse(this);
2765 
2766         return false;
2767     }
2768     case glslang::EOpFunction:
2769         if (visit == glslang::EvPreVisit) {
2770             if (isShaderEntryPoint(node)) {
2771                 inEntryPoint = true;
2772                 builder.setBuildPoint(shaderEntry->getLastBlock());
2773                 currentFunction = shaderEntry;
2774             } else {
2775                 handleFunctionEntry(node);
2776             }
2777         } else {
2778             if (inEntryPoint)
2779                 entryPointTerminated = true;
2780             builder.leaveFunction();
2781             inEntryPoint = false;
2782         }
2783 
2784         return true;
2785     case glslang::EOpParameters:
2786         // Parameters will have been consumed by EOpFunction processing, but not
2787         // the body, so we still visited the function node's children, making this
2788         // child redundant.
2789         return false;
2790     case glslang::EOpFunctionCall:
2791     {
2792         builder.setLine(node->getLoc().line, node->getLoc().getFilename());
2793         if (node->isUserDefined())
2794             result = handleUserFunctionCall(node);
2795         if (result) {
2796             builder.clearAccessChain();
2797             builder.setAccessChainRValue(result);
2798         } else
2799             logger->missingFunctionality("missing user function; linker needs to catch that");
2800 
2801         return false;
2802     }
2803     case glslang::EOpConstructMat2x2:
2804     case glslang::EOpConstructMat2x3:
2805     case glslang::EOpConstructMat2x4:
2806     case glslang::EOpConstructMat3x2:
2807     case glslang::EOpConstructMat3x3:
2808     case glslang::EOpConstructMat3x4:
2809     case glslang::EOpConstructMat4x2:
2810     case glslang::EOpConstructMat4x3:
2811     case glslang::EOpConstructMat4x4:
2812     case glslang::EOpConstructDMat2x2:
2813     case glslang::EOpConstructDMat2x3:
2814     case glslang::EOpConstructDMat2x4:
2815     case glslang::EOpConstructDMat3x2:
2816     case glslang::EOpConstructDMat3x3:
2817     case glslang::EOpConstructDMat3x4:
2818     case glslang::EOpConstructDMat4x2:
2819     case glslang::EOpConstructDMat4x3:
2820     case glslang::EOpConstructDMat4x4:
2821     case glslang::EOpConstructIMat2x2:
2822     case glslang::EOpConstructIMat2x3:
2823     case glslang::EOpConstructIMat2x4:
2824     case glslang::EOpConstructIMat3x2:
2825     case glslang::EOpConstructIMat3x3:
2826     case glslang::EOpConstructIMat3x4:
2827     case glslang::EOpConstructIMat4x2:
2828     case glslang::EOpConstructIMat4x3:
2829     case glslang::EOpConstructIMat4x4:
2830     case glslang::EOpConstructUMat2x2:
2831     case glslang::EOpConstructUMat2x3:
2832     case glslang::EOpConstructUMat2x4:
2833     case glslang::EOpConstructUMat3x2:
2834     case glslang::EOpConstructUMat3x3:
2835     case glslang::EOpConstructUMat3x4:
2836     case glslang::EOpConstructUMat4x2:
2837     case glslang::EOpConstructUMat4x3:
2838     case glslang::EOpConstructUMat4x4:
2839     case glslang::EOpConstructBMat2x2:
2840     case glslang::EOpConstructBMat2x3:
2841     case glslang::EOpConstructBMat2x4:
2842     case glslang::EOpConstructBMat3x2:
2843     case glslang::EOpConstructBMat3x3:
2844     case glslang::EOpConstructBMat3x4:
2845     case glslang::EOpConstructBMat4x2:
2846     case glslang::EOpConstructBMat4x3:
2847     case glslang::EOpConstructBMat4x4:
2848     case glslang::EOpConstructF16Mat2x2:
2849     case glslang::EOpConstructF16Mat2x3:
2850     case glslang::EOpConstructF16Mat2x4:
2851     case glslang::EOpConstructF16Mat3x2:
2852     case glslang::EOpConstructF16Mat3x3:
2853     case glslang::EOpConstructF16Mat3x4:
2854     case glslang::EOpConstructF16Mat4x2:
2855     case glslang::EOpConstructF16Mat4x3:
2856     case glslang::EOpConstructF16Mat4x4:
2857         isMatrix = true;
2858         // fall through
2859     case glslang::EOpConstructFloat:
2860     case glslang::EOpConstructVec2:
2861     case glslang::EOpConstructVec3:
2862     case glslang::EOpConstructVec4:
2863     case glslang::EOpConstructDouble:
2864     case glslang::EOpConstructDVec2:
2865     case glslang::EOpConstructDVec3:
2866     case glslang::EOpConstructDVec4:
2867     case glslang::EOpConstructFloat16:
2868     case glslang::EOpConstructF16Vec2:
2869     case glslang::EOpConstructF16Vec3:
2870     case glslang::EOpConstructF16Vec4:
2871     case glslang::EOpConstructBool:
2872     case glslang::EOpConstructBVec2:
2873     case glslang::EOpConstructBVec3:
2874     case glslang::EOpConstructBVec4:
2875     case glslang::EOpConstructInt8:
2876     case glslang::EOpConstructI8Vec2:
2877     case glslang::EOpConstructI8Vec3:
2878     case glslang::EOpConstructI8Vec4:
2879     case glslang::EOpConstructUint8:
2880     case glslang::EOpConstructU8Vec2:
2881     case glslang::EOpConstructU8Vec3:
2882     case glslang::EOpConstructU8Vec4:
2883     case glslang::EOpConstructInt16:
2884     case glslang::EOpConstructI16Vec2:
2885     case glslang::EOpConstructI16Vec3:
2886     case glslang::EOpConstructI16Vec4:
2887     case glslang::EOpConstructUint16:
2888     case glslang::EOpConstructU16Vec2:
2889     case glslang::EOpConstructU16Vec3:
2890     case glslang::EOpConstructU16Vec4:
2891     case glslang::EOpConstructInt:
2892     case glslang::EOpConstructIVec2:
2893     case glslang::EOpConstructIVec3:
2894     case glslang::EOpConstructIVec4:
2895     case glslang::EOpConstructUint:
2896     case glslang::EOpConstructUVec2:
2897     case glslang::EOpConstructUVec3:
2898     case glslang::EOpConstructUVec4:
2899     case glslang::EOpConstructInt64:
2900     case glslang::EOpConstructI64Vec2:
2901     case glslang::EOpConstructI64Vec3:
2902     case glslang::EOpConstructI64Vec4:
2903     case glslang::EOpConstructUint64:
2904     case glslang::EOpConstructU64Vec2:
2905     case glslang::EOpConstructU64Vec3:
2906     case glslang::EOpConstructU64Vec4:
2907     case glslang::EOpConstructStruct:
2908     case glslang::EOpConstructTextureSampler:
2909     case glslang::EOpConstructReference:
2910     case glslang::EOpConstructCooperativeMatrix:
2911     {
2912         builder.setLine(node->getLoc().line, node->getLoc().getFilename());
2913         std::vector<spv::Id> arguments;
2914         translateArguments(*node, arguments, lvalueCoherentFlags);
2915         spv::Id constructed;
2916         if (node->getOp() == glslang::EOpConstructTextureSampler)
2917             constructed = builder.createOp(spv::OpSampledImage, resultType(), arguments);
2918         else if (node->getOp() == glslang::EOpConstructStruct ||
2919                  node->getOp() == glslang::EOpConstructCooperativeMatrix ||
2920                  node->getType().isArray()) {
2921             std::vector<spv::Id> constituents;
2922             for (int c = 0; c < (int)arguments.size(); ++c)
2923                 constituents.push_back(arguments[c]);
2924             constructed = createCompositeConstruct(resultType(), constituents);
2925         } else if (isMatrix)
2926             constructed = builder.createMatrixConstructor(precision, arguments, resultType());
2927         else
2928             constructed = builder.createConstructor(precision, arguments, resultType());
2929 
2930         if (node->getType().getQualifier().isNonUniform()) {
2931             builder.addDecoration(constructed, spv::DecorationNonUniformEXT);
2932         }
2933 
2934         builder.clearAccessChain();
2935         builder.setAccessChainRValue(constructed);
2936 
2937         return false;
2938     }
2939 
2940     // These six are component-wise compares with component-wise results.
2941     // Forward on to createBinaryOperation(), requesting a vector result.
2942     case glslang::EOpLessThan:
2943     case glslang::EOpGreaterThan:
2944     case glslang::EOpLessThanEqual:
2945     case glslang::EOpGreaterThanEqual:
2946     case glslang::EOpVectorEqual:
2947     case glslang::EOpVectorNotEqual:
2948     {
2949         // Map the operation to a binary
2950         binOp = node->getOp();
2951         reduceComparison = false;
2952         switch (node->getOp()) {
2953         case glslang::EOpVectorEqual:     binOp = glslang::EOpVectorEqual;      break;
2954         case glslang::EOpVectorNotEqual:  binOp = glslang::EOpVectorNotEqual;   break;
2955         default:                          binOp = node->getOp();                break;
2956         }
2957 
2958         break;
2959     }
2960     case glslang::EOpMul:
2961         // component-wise matrix multiply
2962         binOp = glslang::EOpMul;
2963         break;
2964     case glslang::EOpOuterProduct:
2965         // two vectors multiplied to make a matrix
2966         binOp = glslang::EOpOuterProduct;
2967         break;
2968     case glslang::EOpDot:
2969     {
2970         // for scalar dot product, use multiply
2971         glslang::TIntermSequence& glslangOperands = node->getSequence();
2972         if (glslangOperands[0]->getAsTyped()->getVectorSize() == 1)
2973             binOp = glslang::EOpMul;
2974         break;
2975     }
2976     case glslang::EOpMod:
2977         // when an aggregate, this is the floating-point mod built-in function,
2978         // which can be emitted by the one in createBinaryOperation()
2979         binOp = glslang::EOpMod;
2980         break;
2981 
2982     case glslang::EOpEmitVertex:
2983     case glslang::EOpEndPrimitive:
2984     case glslang::EOpBarrier:
2985     case glslang::EOpMemoryBarrier:
2986     case glslang::EOpMemoryBarrierAtomicCounter:
2987     case glslang::EOpMemoryBarrierBuffer:
2988     case glslang::EOpMemoryBarrierImage:
2989     case glslang::EOpMemoryBarrierShared:
2990     case glslang::EOpGroupMemoryBarrier:
2991     case glslang::EOpDeviceMemoryBarrier:
2992     case glslang::EOpAllMemoryBarrierWithGroupSync:
2993     case glslang::EOpDeviceMemoryBarrierWithGroupSync:
2994     case glslang::EOpWorkgroupMemoryBarrier:
2995     case glslang::EOpWorkgroupMemoryBarrierWithGroupSync:
2996     case glslang::EOpSubgroupBarrier:
2997     case glslang::EOpSubgroupMemoryBarrier:
2998     case glslang::EOpSubgroupMemoryBarrierBuffer:
2999     case glslang::EOpSubgroupMemoryBarrierImage:
3000     case glslang::EOpSubgroupMemoryBarrierShared:
3001         noReturnValue = true;
3002         // These all have 0 operands and will naturally finish up in the code below for 0 operands
3003         break;
3004 
3005     case glslang::EOpAtomicAdd:
3006     case glslang::EOpAtomicSubtract:
3007     case glslang::EOpAtomicMin:
3008     case glslang::EOpAtomicMax:
3009     case glslang::EOpAtomicAnd:
3010     case glslang::EOpAtomicOr:
3011     case glslang::EOpAtomicXor:
3012     case glslang::EOpAtomicExchange:
3013     case glslang::EOpAtomicCompSwap:
3014         atomic = true;
3015         break;
3016 
3017 #ifndef GLSLANG_WEB
3018     case glslang::EOpAtomicStore:
3019         noReturnValue = true;
3020         // fallthrough
3021     case glslang::EOpAtomicLoad:
3022         atomic = true;
3023         break;
3024 
3025     case glslang::EOpAtomicCounterAdd:
3026     case glslang::EOpAtomicCounterSubtract:
3027     case glslang::EOpAtomicCounterMin:
3028     case glslang::EOpAtomicCounterMax:
3029     case glslang::EOpAtomicCounterAnd:
3030     case glslang::EOpAtomicCounterOr:
3031     case glslang::EOpAtomicCounterXor:
3032     case glslang::EOpAtomicCounterExchange:
3033     case glslang::EOpAtomicCounterCompSwap:
3034         builder.addExtension("SPV_KHR_shader_atomic_counter_ops");
3035         builder.addCapability(spv::CapabilityAtomicStorageOps);
3036         atomic = true;
3037         break;
3038 
3039     case glslang::EOpAbsDifference:
3040     case glslang::EOpAddSaturate:
3041     case glslang::EOpSubSaturate:
3042     case glslang::EOpAverage:
3043     case glslang::EOpAverageRounded:
3044     case glslang::EOpMul32x16:
3045         builder.addCapability(spv::CapabilityIntegerFunctions2INTEL);
3046         builder.addExtension("SPV_INTEL_shader_integer_functions2");
3047         binOp = node->getOp();
3048         break;
3049 
3050     case glslang::EOpIgnoreIntersectionNV:
3051     case glslang::EOpTerminateRayNV:
3052     case glslang::EOpTraceNV:
3053     case glslang::EOpTraceRayMotionNV:
3054     case glslang::EOpTraceKHR:
3055     case glslang::EOpExecuteCallableNV:
3056     case glslang::EOpExecuteCallableKHR:
3057     case glslang::EOpWritePackedPrimitiveIndices4x8NV:
3058         noReturnValue = true;
3059         break;
3060     case glslang::EOpRayQueryInitialize:
3061     case glslang::EOpRayQueryTerminate:
3062     case glslang::EOpRayQueryGenerateIntersection:
3063     case glslang::EOpRayQueryConfirmIntersection:
3064         builder.addExtension("SPV_KHR_ray_query");
3065         builder.addCapability(spv::CapabilityRayQueryKHR);
3066         noReturnValue = true;
3067         break;
3068     case glslang::EOpRayQueryProceed:
3069     case glslang::EOpRayQueryGetIntersectionType:
3070     case glslang::EOpRayQueryGetRayTMin:
3071     case glslang::EOpRayQueryGetRayFlags:
3072     case glslang::EOpRayQueryGetIntersectionT:
3073     case glslang::EOpRayQueryGetIntersectionInstanceCustomIndex:
3074     case glslang::EOpRayQueryGetIntersectionInstanceId:
3075     case glslang::EOpRayQueryGetIntersectionInstanceShaderBindingTableRecordOffset:
3076     case glslang::EOpRayQueryGetIntersectionGeometryIndex:
3077     case glslang::EOpRayQueryGetIntersectionPrimitiveIndex:
3078     case glslang::EOpRayQueryGetIntersectionBarycentrics:
3079     case glslang::EOpRayQueryGetIntersectionFrontFace:
3080     case glslang::EOpRayQueryGetIntersectionCandidateAABBOpaque:
3081     case glslang::EOpRayQueryGetIntersectionObjectRayDirection:
3082     case glslang::EOpRayQueryGetIntersectionObjectRayOrigin:
3083     case glslang::EOpRayQueryGetWorldRayDirection:
3084     case glslang::EOpRayQueryGetWorldRayOrigin:
3085     case glslang::EOpRayQueryGetIntersectionObjectToWorld:
3086     case glslang::EOpRayQueryGetIntersectionWorldToObject:
3087         builder.addExtension("SPV_KHR_ray_query");
3088         builder.addCapability(spv::CapabilityRayQueryKHR);
3089         break;
3090     case glslang::EOpCooperativeMatrixLoad:
3091     case glslang::EOpCooperativeMatrixStore:
3092         noReturnValue = true;
3093         break;
3094     case glslang::EOpBeginInvocationInterlock:
3095     case glslang::EOpEndInvocationInterlock:
3096         builder.addExtension(spv::E_SPV_EXT_fragment_shader_interlock);
3097         noReturnValue = true;
3098         break;
3099 #endif
3100 
3101     case glslang::EOpDebugPrintf:
3102         noReturnValue = true;
3103         break;
3104 
3105     default:
3106         break;
3107     }
3108 
3109     //
3110     // See if it maps to a regular operation.
3111     //
3112     if (binOp != glslang::EOpNull) {
3113         glslang::TIntermTyped* left = node->getSequence()[0]->getAsTyped();
3114         glslang::TIntermTyped* right = node->getSequence()[1]->getAsTyped();
3115         assert(left && right);
3116 
3117         builder.clearAccessChain();
3118         left->traverse(this);
3119         spv::Id leftId = accessChainLoad(left->getType());
3120 
3121         builder.clearAccessChain();
3122         right->traverse(this);
3123         spv::Id rightId = accessChainLoad(right->getType());
3124 
3125         builder.setLine(node->getLoc().line, node->getLoc().getFilename());
3126         OpDecorations decorations = { precision,
3127                                       TranslateNoContractionDecoration(node->getType().getQualifier()),
3128                                       TranslateNonUniformDecoration(node->getType().getQualifier()) };
3129         result = createBinaryOperation(binOp, decorations,
3130                                        resultType(), leftId, rightId,
3131                                        left->getType().getBasicType(), reduceComparison);
3132 
3133         // code above should only make binOp that exists in createBinaryOperation
3134         assert(result != spv::NoResult);
3135         builder.clearAccessChain();
3136         builder.setAccessChainRValue(result);
3137 
3138         return false;
3139     }
3140 
3141     //
3142     // Create the list of operands.
3143     //
3144     glslang::TIntermSequence& glslangOperands = node->getSequence();
3145     std::vector<spv::Id> operands;
3146     std::vector<spv::IdImmediate> memoryAccessOperands;
3147     for (int arg = 0; arg < (int)glslangOperands.size(); ++arg) {
3148         // special case l-value operands; there are just a few
3149         bool lvalue = false;
3150         switch (node->getOp()) {
3151         case glslang::EOpModf:
3152             if (arg == 1)
3153                 lvalue = true;
3154             break;
3155 
3156         case glslang::EOpRayQueryInitialize:
3157         case glslang::EOpRayQueryTerminate:
3158         case glslang::EOpRayQueryConfirmIntersection:
3159         case glslang::EOpRayQueryProceed:
3160         case glslang::EOpRayQueryGenerateIntersection:
3161         case glslang::EOpRayQueryGetIntersectionType:
3162         case glslang::EOpRayQueryGetIntersectionT:
3163         case glslang::EOpRayQueryGetIntersectionInstanceCustomIndex:
3164         case glslang::EOpRayQueryGetIntersectionInstanceId:
3165         case glslang::EOpRayQueryGetIntersectionInstanceShaderBindingTableRecordOffset:
3166         case glslang::EOpRayQueryGetIntersectionGeometryIndex:
3167         case glslang::EOpRayQueryGetIntersectionPrimitiveIndex:
3168         case glslang::EOpRayQueryGetIntersectionBarycentrics:
3169         case glslang::EOpRayQueryGetIntersectionFrontFace:
3170         case glslang::EOpRayQueryGetIntersectionObjectRayDirection:
3171         case glslang::EOpRayQueryGetIntersectionObjectRayOrigin:
3172         case glslang::EOpRayQueryGetIntersectionObjectToWorld:
3173         case glslang::EOpRayQueryGetIntersectionWorldToObject:
3174             if (arg == 0)
3175                 lvalue = true;
3176             break;
3177 
3178         case glslang::EOpAtomicAdd:
3179         case glslang::EOpAtomicSubtract:
3180         case glslang::EOpAtomicMin:
3181         case glslang::EOpAtomicMax:
3182         case glslang::EOpAtomicAnd:
3183         case glslang::EOpAtomicOr:
3184         case glslang::EOpAtomicXor:
3185         case glslang::EOpAtomicExchange:
3186         case glslang::EOpAtomicCompSwap:
3187             if (arg == 0)
3188                 lvalue = true;
3189             break;
3190 
3191 #ifndef GLSLANG_WEB
3192         case glslang::EOpFrexp:
3193             if (arg == 1)
3194                 lvalue = true;
3195             break;
3196         case glslang::EOpInterpolateAtSample:
3197         case glslang::EOpInterpolateAtOffset:
3198         case glslang::EOpInterpolateAtVertex:
3199             if (arg == 0) {
3200                 // If GLSL, use the address of the interpolant argument.
3201                 // If HLSL, use an internal version of OpInterolates that takes
3202                 // the rvalue of the interpolant. A fixup pass in spirv-opt
3203                 // legalization will remove the OpLoad and convert to an lvalue.
3204                 // Had to do this because legalization will only propagate a
3205                 // builtin into an rvalue.
3206                 lvalue = glslangIntermediate->getSource() != glslang::EShSourceHlsl;
3207 
3208                 // Does it need a swizzle inversion?  If so, evaluation is inverted;
3209                 // operate first on the swizzle base, then apply the swizzle.
3210                 // That is, we transform
3211                 //
3212                 //    interpolate(v.zy)  ->  interpolate(v).zy
3213                 //
3214                 if (glslangOperands[0]->getAsOperator() &&
3215                     glslangOperands[0]->getAsOperator()->getOp() == glslang::EOpVectorSwizzle)
3216                     invertedType = convertGlslangToSpvType(
3217                         glslangOperands[0]->getAsBinaryNode()->getLeft()->getType());
3218             }
3219             break;
3220         case glslang::EOpAtomicLoad:
3221         case glslang::EOpAtomicStore:
3222         case glslang::EOpAtomicCounterAdd:
3223         case glslang::EOpAtomicCounterSubtract:
3224         case glslang::EOpAtomicCounterMin:
3225         case glslang::EOpAtomicCounterMax:
3226         case glslang::EOpAtomicCounterAnd:
3227         case glslang::EOpAtomicCounterOr:
3228         case glslang::EOpAtomicCounterXor:
3229         case glslang::EOpAtomicCounterExchange:
3230         case glslang::EOpAtomicCounterCompSwap:
3231             if (arg == 0)
3232                 lvalue = true;
3233             break;
3234         case glslang::EOpAddCarry:
3235         case glslang::EOpSubBorrow:
3236             if (arg == 2)
3237                 lvalue = true;
3238             break;
3239         case glslang::EOpUMulExtended:
3240         case glslang::EOpIMulExtended:
3241             if (arg >= 2)
3242                 lvalue = true;
3243             break;
3244         case glslang::EOpCooperativeMatrixLoad:
3245             if (arg == 0 || arg == 1)
3246                 lvalue = true;
3247             break;
3248         case glslang::EOpCooperativeMatrixStore:
3249             if (arg == 1)
3250                 lvalue = true;
3251             break;
3252         case glslang::EOpSpirvInst:
3253             if (glslangOperands[arg]->getAsTyped()->getQualifier().isSpirvByReference())
3254                 lvalue = true;
3255             break;
3256 #endif
3257         default:
3258             break;
3259         }
3260         builder.clearAccessChain();
3261         if (invertedType != spv::NoType && arg == 0)
3262             glslangOperands[0]->getAsBinaryNode()->getLeft()->traverse(this);
3263         else
3264             glslangOperands[arg]->traverse(this);
3265 
3266 #ifndef GLSLANG_WEB
3267         if (node->getOp() == glslang::EOpCooperativeMatrixLoad ||
3268             node->getOp() == glslang::EOpCooperativeMatrixStore) {
3269 
3270             if (arg == 1) {
3271                 // fold "element" parameter into the access chain
3272                 spv::Builder::AccessChain save = builder.getAccessChain();
3273                 builder.clearAccessChain();
3274                 glslangOperands[2]->traverse(this);
3275 
3276                 spv::Id elementId = accessChainLoad(glslangOperands[2]->getAsTyped()->getType());
3277 
3278                 builder.setAccessChain(save);
3279 
3280                 // Point to the first element of the array.
3281                 builder.accessChainPush(elementId,
3282                     TranslateCoherent(glslangOperands[arg]->getAsTyped()->getType()),
3283                                       glslangOperands[arg]->getAsTyped()->getType().getBufferReferenceAlignment());
3284 
3285                 spv::Builder::AccessChain::CoherentFlags coherentFlags = builder.getAccessChain().coherentFlags;
3286                 unsigned int alignment = builder.getAccessChain().alignment;
3287 
3288                 int memoryAccess = TranslateMemoryAccess(coherentFlags);
3289                 if (node->getOp() == glslang::EOpCooperativeMatrixLoad)
3290                     memoryAccess &= ~spv::MemoryAccessMakePointerAvailableKHRMask;
3291                 if (node->getOp() == glslang::EOpCooperativeMatrixStore)
3292                     memoryAccess &= ~spv::MemoryAccessMakePointerVisibleKHRMask;
3293                 if (builder.getStorageClass(builder.getAccessChain().base) ==
3294                     spv::StorageClassPhysicalStorageBufferEXT) {
3295                     memoryAccess = (spv::MemoryAccessMask)(memoryAccess | spv::MemoryAccessAlignedMask);
3296                 }
3297 
3298                 memoryAccessOperands.push_back(spv::IdImmediate(false, memoryAccess));
3299 
3300                 if (memoryAccess & spv::MemoryAccessAlignedMask) {
3301                     memoryAccessOperands.push_back(spv::IdImmediate(false, alignment));
3302                 }
3303 
3304                 if (memoryAccess &
3305                     (spv::MemoryAccessMakePointerAvailableKHRMask | spv::MemoryAccessMakePointerVisibleKHRMask)) {
3306                     memoryAccessOperands.push_back(spv::IdImmediate(true,
3307                         builder.makeUintConstant(TranslateMemoryScope(coherentFlags))));
3308                 }
3309             } else if (arg == 2) {
3310                 continue;
3311             }
3312         }
3313 #endif
3314 
3315         // for l-values, pass the address, for r-values, pass the value
3316         if (lvalue) {
3317             if (invertedType == spv::NoType && !builder.isSpvLvalue()) {
3318                 // SPIR-V cannot represent an l-value containing a swizzle that doesn't
3319                 // reduce to a simple access chain.  So, we need a temporary vector to
3320                 // receive the result, and must later swizzle that into the original
3321                 // l-value.
3322                 complexLvalues.push_back(builder.getAccessChain());
3323                 temporaryLvalues.push_back(builder.createVariable(
3324                     spv::NoPrecision, spv::StorageClassFunction,
3325                     builder.accessChainGetInferredType(), "swizzleTemp"));
3326                 operands.push_back(temporaryLvalues.back());
3327             } else {
3328                 operands.push_back(builder.accessChainGetLValue());
3329             }
3330             lvalueCoherentFlags = builder.getAccessChain().coherentFlags;
3331             lvalueCoherentFlags |= TranslateCoherent(glslangOperands[arg]->getAsTyped()->getType());
3332         } else {
3333             builder.setLine(node->getLoc().line, node->getLoc().getFilename());
3334              glslang::TOperator glslangOp = node->getOp();
3335              if (arg == 1 &&
3336                 (glslangOp == glslang::EOpRayQueryGetIntersectionType ||
3337                  glslangOp == glslang::EOpRayQueryGetIntersectionT ||
3338                  glslangOp == glslang::EOpRayQueryGetIntersectionInstanceCustomIndex ||
3339                  glslangOp == glslang::EOpRayQueryGetIntersectionInstanceId ||
3340                  glslangOp == glslang::EOpRayQueryGetIntersectionInstanceShaderBindingTableRecordOffset ||
3341                  glslangOp == glslang::EOpRayQueryGetIntersectionGeometryIndex ||
3342                  glslangOp == glslang::EOpRayQueryGetIntersectionPrimitiveIndex ||
3343                  glslangOp == glslang::EOpRayQueryGetIntersectionBarycentrics ||
3344                  glslangOp == glslang::EOpRayQueryGetIntersectionFrontFace ||
3345                  glslangOp == glslang::EOpRayQueryGetIntersectionObjectRayDirection ||
3346                  glslangOp == glslang::EOpRayQueryGetIntersectionObjectRayOrigin ||
3347                  glslangOp == glslang::EOpRayQueryGetIntersectionObjectToWorld ||
3348                  glslangOp == glslang::EOpRayQueryGetIntersectionWorldToObject
3349                     )) {
3350                 bool cond = glslangOperands[arg]->getAsConstantUnion()->getConstArray()[0].getBConst();
3351                 operands.push_back(builder.makeIntConstant(cond ? 1 : 0));
3352              } else if ((arg == 10 && glslangOp == glslang::EOpTraceKHR) ||
3353                         (arg == 11 && glslangOp == glslang::EOpTraceRayMotionNV) ||
3354                         (arg == 1  && glslangOp == glslang::EOpExecuteCallableKHR)) {
3355                  const int opdNum = glslangOp == glslang::EOpTraceKHR ? 10 : (glslangOp == glslang::EOpTraceRayMotionNV ? 11 : 1);
3356                  const int set = glslangOp == glslang::EOpExecuteCallableKHR ? 1 : 0;
3357 
3358                  const int location = glslangOperands[opdNum]->getAsConstantUnion()->getConstArray()[0].getUConst();
3359                  auto itNode = locationToSymbol[set].find(location);
3360                  visitSymbol(itNode->second);
3361                  spv::Id symId = getSymbolId(itNode->second);
3362                  operands.push_back(symId);
3363 #ifndef GLSLANG_WEB
3364              } else if (glslangOperands[arg]->getAsTyped()->getQualifier().isSpirvLiteral()) {
3365                  // Will be translated to a literal value, make a placeholder here
3366                  operands.push_back(spv::NoResult);
3367 #endif
3368              } else  {
3369                 operands.push_back(accessChainLoad(glslangOperands[arg]->getAsTyped()->getType()));
3370              }
3371         }
3372     }
3373 
3374     builder.setLine(node->getLoc().line, node->getLoc().getFilename());
3375 #ifndef GLSLANG_WEB
3376     if (node->getOp() == glslang::EOpCooperativeMatrixLoad) {
3377         std::vector<spv::IdImmediate> idImmOps;
3378 
3379         idImmOps.push_back(spv::IdImmediate(true, operands[1])); // buf
3380         idImmOps.push_back(spv::IdImmediate(true, operands[2])); // stride
3381         idImmOps.push_back(spv::IdImmediate(true, operands[3])); // colMajor
3382         idImmOps.insert(idImmOps.end(), memoryAccessOperands.begin(), memoryAccessOperands.end());
3383         // get the pointee type
3384         spv::Id typeId = builder.getContainedTypeId(builder.getTypeId(operands[0]));
3385         assert(builder.isCooperativeMatrixType(typeId));
3386         // do the op
3387         spv::Id result = builder.createOp(spv::OpCooperativeMatrixLoadNV, typeId, idImmOps);
3388         // store the result to the pointer (out param 'm')
3389         builder.createStore(result, operands[0]);
3390         result = 0;
3391     } else if (node->getOp() == glslang::EOpCooperativeMatrixStore) {
3392         std::vector<spv::IdImmediate> idImmOps;
3393 
3394         idImmOps.push_back(spv::IdImmediate(true, operands[1])); // buf
3395         idImmOps.push_back(spv::IdImmediate(true, operands[0])); // object
3396         idImmOps.push_back(spv::IdImmediate(true, operands[2])); // stride
3397         idImmOps.push_back(spv::IdImmediate(true, operands[3])); // colMajor
3398         idImmOps.insert(idImmOps.end(), memoryAccessOperands.begin(), memoryAccessOperands.end());
3399 
3400         builder.createNoResultOp(spv::OpCooperativeMatrixStoreNV, idImmOps);
3401         result = 0;
3402     } else
3403 #endif
3404     if (atomic) {
3405         // Handle all atomics
3406         glslang::TBasicType typeProxy = (node->getOp() == glslang::EOpAtomicStore)
3407             ? node->getSequence()[0]->getAsTyped()->getBasicType() : node->getBasicType();
3408         result = createAtomicOperation(node->getOp(), precision, resultType(), operands, typeProxy,
3409             lvalueCoherentFlags);
3410 #ifndef GLSLANG_WEB
3411     } else if (node->getOp() == glslang::EOpSpirvInst) {
3412         const auto& spirvInst = node->getSpirvInstruction();
3413         if (spirvInst.set == "") {
3414             std::vector<spv::IdImmediate> idImmOps;
3415             for (unsigned int i = 0; i < glslangOperands.size(); ++i) {
3416                 if (glslangOperands[i]->getAsTyped()->getQualifier().isSpirvLiteral()) {
3417                     // Translate the constant to a literal value
3418                     std::vector<unsigned> literals;
3419                     glslang::TVector<const glslang::TIntermConstantUnion*> constants;
3420                     constants.push_back(glslangOperands[i]->getAsConstantUnion());
3421                     TranslateLiterals(constants, literals);
3422                     idImmOps.push_back({false, literals[0]});
3423                 } else
3424                     idImmOps.push_back({true, operands[i]});
3425             }
3426 
3427             if (node->getBasicType() == glslang::EbtVoid)
3428                 builder.createNoResultOp(static_cast<spv::Op>(spirvInst.id), idImmOps);
3429             else
3430                 result = builder.createOp(static_cast<spv::Op>(spirvInst.id), resultType(), idImmOps);
3431         } else {
3432             result = builder.createBuiltinCall(
3433                 resultType(), spirvInst.set == "GLSL.std.450" ? stdBuiltins : getExtBuiltins(spirvInst.set.c_str()),
3434                 spirvInst.id, operands);
3435         }
3436         noReturnValue = node->getBasicType() == glslang::EbtVoid;
3437 #endif
3438     } else if (node->getOp() == glslang::EOpDebugPrintf) {
3439         if (!nonSemanticDebugPrintf) {
3440             nonSemanticDebugPrintf = builder.import("NonSemantic.DebugPrintf");
3441         }
3442         result = builder.createBuiltinCall(builder.makeVoidType(), nonSemanticDebugPrintf, spv::NonSemanticDebugPrintfDebugPrintf, operands);
3443         builder.addExtension(spv::E_SPV_KHR_non_semantic_info);
3444     } else {
3445         // Pass through to generic operations.
3446         switch (glslangOperands.size()) {
3447         case 0:
3448             result = createNoArgOperation(node->getOp(), precision, resultType());
3449             break;
3450         case 1:
3451             {
3452                 OpDecorations decorations = { precision,
3453                                               TranslateNoContractionDecoration(node->getType().getQualifier()),
3454                                               TranslateNonUniformDecoration(node->getType().getQualifier()) };
3455                 result = createUnaryOperation(
3456                     node->getOp(), decorations,
3457                     resultType(), operands.front(),
3458                     glslangOperands[0]->getAsTyped()->getBasicType(), lvalueCoherentFlags);
3459             }
3460             break;
3461         default:
3462             result = createMiscOperation(node->getOp(), precision, resultType(), operands, node->getBasicType());
3463             break;
3464         }
3465 
3466         if (invertedType != spv::NoResult)
3467             result = createInvertedSwizzle(precision, *glslangOperands[0]->getAsBinaryNode(), result);
3468 
3469         for (unsigned int i = 0; i < temporaryLvalues.size(); ++i) {
3470             builder.setAccessChain(complexLvalues[i]);
3471             builder.accessChainStore(builder.createLoad(temporaryLvalues[i], spv::NoPrecision),
3472                 TranslateNonUniformDecoration(complexLvalues[i].coherentFlags));
3473         }
3474     }
3475 
3476     if (noReturnValue)
3477         return false;
3478 
3479     if (! result) {
3480         logger->missingFunctionality("unknown glslang aggregate");
3481         return true;  // pick up a child as a placeholder operand
3482     } else {
3483         builder.clearAccessChain();
3484         builder.setAccessChainRValue(result);
3485         return false;
3486     }
3487 }
3488 
3489 // This path handles both if-then-else and ?:
3490 // The if-then-else has a node type of void, while
3491 // ?: has either a void or a non-void node type
3492 //
3493 // Leaving the result, when not void:
3494 // GLSL only has r-values as the result of a :?, but
3495 // if we have an l-value, that can be more efficient if it will
3496 // become the base of a complex r-value expression, because the
3497 // next layer copies r-values into memory to use the access-chain mechanism
visitSelection(glslang::TVisit,glslang::TIntermSelection * node)3498 bool TGlslangToSpvTraverser::visitSelection(glslang::TVisit /* visit */, glslang::TIntermSelection* node)
3499 {
3500     // see if OpSelect can handle it
3501     const auto isOpSelectable = [&]() {
3502         if (node->getBasicType() == glslang::EbtVoid)
3503             return false;
3504         // OpSelect can do all other types starting with SPV 1.4
3505         if (glslangIntermediate->getSpv().spv < glslang::EShTargetSpv_1_4) {
3506             // pre-1.4, only scalars and vectors can be handled
3507             if ((!node->getType().isScalar() && !node->getType().isVector()))
3508                 return false;
3509         }
3510         return true;
3511     };
3512 
3513     // See if it simple and safe, or required, to execute both sides.
3514     // Crucially, side effects must be either semantically required or avoided,
3515     // and there are performance trade-offs.
3516     // Return true if required or a good idea (and safe) to execute both sides,
3517     // false otherwise.
3518     const auto bothSidesPolicy = [&]() -> bool {
3519         // do we have both sides?
3520         if (node->getTrueBlock()  == nullptr ||
3521             node->getFalseBlock() == nullptr)
3522             return false;
3523 
3524         // required? (unless we write additional code to look for side effects
3525         // and make performance trade-offs if none are present)
3526         if (!node->getShortCircuit())
3527             return true;
3528 
3529         // if not required to execute both, decide based on performance/practicality...
3530 
3531         if (!isOpSelectable())
3532             return false;
3533 
3534         assert(node->getType() == node->getTrueBlock() ->getAsTyped()->getType() &&
3535                node->getType() == node->getFalseBlock()->getAsTyped()->getType());
3536 
3537         // return true if a single operand to ? : is okay for OpSelect
3538         const auto operandOkay = [](glslang::TIntermTyped* node) {
3539             return node->getAsSymbolNode() || node->getType().getQualifier().isConstant();
3540         };
3541 
3542         return operandOkay(node->getTrueBlock() ->getAsTyped()) &&
3543                operandOkay(node->getFalseBlock()->getAsTyped());
3544     };
3545 
3546     spv::Id result = spv::NoResult; // upcoming result selecting between trueValue and falseValue
3547     // emit the condition before doing anything with selection
3548     node->getCondition()->traverse(this);
3549     spv::Id condition = accessChainLoad(node->getCondition()->getType());
3550 
3551     // Find a way of executing both sides and selecting the right result.
3552     const auto executeBothSides = [&]() -> void {
3553         // execute both sides
3554         node->getTrueBlock()->traverse(this);
3555         spv::Id trueValue = accessChainLoad(node->getTrueBlock()->getAsTyped()->getType());
3556         node->getFalseBlock()->traverse(this);
3557         spv::Id falseValue = accessChainLoad(node->getTrueBlock()->getAsTyped()->getType());
3558 
3559         builder.setLine(node->getLoc().line, node->getLoc().getFilename());
3560 
3561         // done if void
3562         if (node->getBasicType() == glslang::EbtVoid)
3563             return;
3564 
3565         // emit code to select between trueValue and falseValue
3566 
3567         // see if OpSelect can handle it
3568         if (isOpSelectable()) {
3569             // Emit OpSelect for this selection.
3570 
3571             // smear condition to vector, if necessary (AST is always scalar)
3572             // Before 1.4, smear like for mix(), starting with 1.4, keep it scalar
3573             if (glslangIntermediate->getSpv().spv < glslang::EShTargetSpv_1_4 && builder.isVector(trueValue)) {
3574                 condition = builder.smearScalar(spv::NoPrecision, condition,
3575                                                 builder.makeVectorType(builder.makeBoolType(),
3576                                                                        builder.getNumComponents(trueValue)));
3577             }
3578 
3579             // OpSelect
3580             result = builder.createTriOp(spv::OpSelect,
3581                                          convertGlslangToSpvType(node->getType()), condition,
3582                                                                  trueValue, falseValue);
3583 
3584             builder.clearAccessChain();
3585             builder.setAccessChainRValue(result);
3586         } else {
3587             // We need control flow to select the result.
3588             // TODO: Once SPIR-V OpSelect allows arbitrary types, eliminate this path.
3589             result = builder.createVariable(TranslatePrecisionDecoration(node->getType()),
3590                 spv::StorageClassFunction, convertGlslangToSpvType(node->getType()));
3591 
3592             // Selection control:
3593             const spv::SelectionControlMask control = TranslateSelectionControl(*node);
3594 
3595             // make an "if" based on the value created by the condition
3596             spv::Builder::If ifBuilder(condition, control, builder);
3597 
3598             // emit the "then" statement
3599             builder.createStore(trueValue, result);
3600             ifBuilder.makeBeginElse();
3601             // emit the "else" statement
3602             builder.createStore(falseValue, result);
3603 
3604             // finish off the control flow
3605             ifBuilder.makeEndIf();
3606 
3607             builder.clearAccessChain();
3608             builder.setAccessChainLValue(result);
3609         }
3610     };
3611 
3612     // Execute the one side needed, as per the condition
3613     const auto executeOneSide = [&]() {
3614         // Always emit control flow.
3615         if (node->getBasicType() != glslang::EbtVoid) {
3616             result = builder.createVariable(TranslatePrecisionDecoration(node->getType()), spv::StorageClassFunction,
3617                 convertGlslangToSpvType(node->getType()));
3618         }
3619 
3620         // Selection control:
3621         const spv::SelectionControlMask control = TranslateSelectionControl(*node);
3622 
3623         // make an "if" based on the value created by the condition
3624         spv::Builder::If ifBuilder(condition, control, builder);
3625 
3626         // emit the "then" statement
3627         if (node->getTrueBlock() != nullptr) {
3628             node->getTrueBlock()->traverse(this);
3629             if (result != spv::NoResult)
3630                 builder.createStore(accessChainLoad(node->getTrueBlock()->getAsTyped()->getType()), result);
3631         }
3632 
3633         if (node->getFalseBlock() != nullptr) {
3634             ifBuilder.makeBeginElse();
3635             // emit the "else" statement
3636             node->getFalseBlock()->traverse(this);
3637             if (result != spv::NoResult)
3638                 builder.createStore(accessChainLoad(node->getFalseBlock()->getAsTyped()->getType()), result);
3639         }
3640 
3641         // finish off the control flow
3642         ifBuilder.makeEndIf();
3643 
3644         if (result != spv::NoResult) {
3645             builder.clearAccessChain();
3646             builder.setAccessChainLValue(result);
3647         }
3648     };
3649 
3650     // Try for OpSelect (or a requirement to execute both sides)
3651     if (bothSidesPolicy()) {
3652         SpecConstantOpModeGuard spec_constant_op_mode_setter(&builder);
3653         if (node->getType().getQualifier().isSpecConstant())
3654             spec_constant_op_mode_setter.turnOnSpecConstantOpMode();
3655         executeBothSides();
3656     } else
3657         executeOneSide();
3658 
3659     return false;
3660 }
3661 
visitSwitch(glslang::TVisit,glslang::TIntermSwitch * node)3662 bool TGlslangToSpvTraverser::visitSwitch(glslang::TVisit /* visit */, glslang::TIntermSwitch* node)
3663 {
3664     // emit and get the condition before doing anything with switch
3665     node->getCondition()->traverse(this);
3666     spv::Id selector = accessChainLoad(node->getCondition()->getAsTyped()->getType());
3667 
3668     // Selection control:
3669     const spv::SelectionControlMask control = TranslateSwitchControl(*node);
3670 
3671     // browse the children to sort out code segments
3672     int defaultSegment = -1;
3673     std::vector<TIntermNode*> codeSegments;
3674     glslang::TIntermSequence& sequence = node->getBody()->getSequence();
3675     std::vector<int> caseValues;
3676     std::vector<int> valueIndexToSegment(sequence.size());  // note: probably not all are used, it is an overestimate
3677     for (glslang::TIntermSequence::iterator c = sequence.begin(); c != sequence.end(); ++c) {
3678         TIntermNode* child = *c;
3679         if (child->getAsBranchNode() && child->getAsBranchNode()->getFlowOp() == glslang::EOpDefault)
3680             defaultSegment = (int)codeSegments.size();
3681         else if (child->getAsBranchNode() && child->getAsBranchNode()->getFlowOp() == glslang::EOpCase) {
3682             valueIndexToSegment[caseValues.size()] = (int)codeSegments.size();
3683             caseValues.push_back(child->getAsBranchNode()->getExpression()->getAsConstantUnion()
3684                 ->getConstArray()[0].getIConst());
3685         } else
3686             codeSegments.push_back(child);
3687     }
3688 
3689     // handle the case where the last code segment is missing, due to no code
3690     // statements between the last case and the end of the switch statement
3691     if ((caseValues.size() && (int)codeSegments.size() == valueIndexToSegment[caseValues.size() - 1]) ||
3692         (int)codeSegments.size() == defaultSegment)
3693         codeSegments.push_back(nullptr);
3694 
3695     // make the switch statement
3696     std::vector<spv::Block*> segmentBlocks; // returned, as the blocks allocated in the call
3697     builder.makeSwitch(selector, control, (int)codeSegments.size(), caseValues, valueIndexToSegment, defaultSegment,
3698         segmentBlocks);
3699 
3700     // emit all the code in the segments
3701     breakForLoop.push(false);
3702     for (unsigned int s = 0; s < codeSegments.size(); ++s) {
3703         builder.nextSwitchSegment(segmentBlocks, s);
3704         if (codeSegments[s])
3705             codeSegments[s]->traverse(this);
3706         else
3707             builder.addSwitchBreak();
3708     }
3709     breakForLoop.pop();
3710 
3711     builder.endSwitch(segmentBlocks);
3712 
3713     return false;
3714 }
3715 
visitConstantUnion(glslang::TIntermConstantUnion * node)3716 void TGlslangToSpvTraverser::visitConstantUnion(glslang::TIntermConstantUnion* node)
3717 {
3718 #ifndef GLSLANG_WEB
3719     if (node->getQualifier().isSpirvLiteral())
3720         return; // Translated to a literal value, skip further processing
3721 #endif
3722 
3723     int nextConst = 0;
3724     spv::Id constant = createSpvConstantFromConstUnionArray(node->getType(), node->getConstArray(), nextConst, false);
3725 
3726     builder.clearAccessChain();
3727     builder.setAccessChainRValue(constant);
3728 }
3729 
visitLoop(glslang::TVisit,glslang::TIntermLoop * node)3730 bool TGlslangToSpvTraverser::visitLoop(glslang::TVisit /* visit */, glslang::TIntermLoop* node)
3731 {
3732     auto blocks = builder.makeNewLoop();
3733     builder.createBranch(&blocks.head);
3734 
3735     // Loop control:
3736     std::vector<unsigned int> operands;
3737     const spv::LoopControlMask control = TranslateLoopControl(*node, operands);
3738 
3739     // Spec requires back edges to target header blocks, and every header block
3740     // must dominate its merge block.  Make a header block first to ensure these
3741     // conditions are met.  By definition, it will contain OpLoopMerge, followed
3742     // by a block-ending branch.  But we don't want to put any other body/test
3743     // instructions in it, since the body/test may have arbitrary instructions,
3744     // including merges of its own.
3745     builder.setLine(node->getLoc().line, node->getLoc().getFilename());
3746     builder.setBuildPoint(&blocks.head);
3747     builder.createLoopMerge(&blocks.merge, &blocks.continue_target, control, operands);
3748     if (node->testFirst() && node->getTest()) {
3749         spv::Block& test = builder.makeNewBlock();
3750         builder.createBranch(&test);
3751 
3752         builder.setBuildPoint(&test);
3753         node->getTest()->traverse(this);
3754         spv::Id condition = accessChainLoad(node->getTest()->getType());
3755         builder.createConditionalBranch(condition, &blocks.body, &blocks.merge);
3756 
3757         builder.setBuildPoint(&blocks.body);
3758         breakForLoop.push(true);
3759         if (node->getBody())
3760             node->getBody()->traverse(this);
3761         builder.createBranch(&blocks.continue_target);
3762         breakForLoop.pop();
3763 
3764         builder.setBuildPoint(&blocks.continue_target);
3765         if (node->getTerminal())
3766             node->getTerminal()->traverse(this);
3767         builder.createBranch(&blocks.head);
3768     } else {
3769         builder.setLine(node->getLoc().line, node->getLoc().getFilename());
3770         builder.createBranch(&blocks.body);
3771 
3772         breakForLoop.push(true);
3773         builder.setBuildPoint(&blocks.body);
3774         if (node->getBody())
3775             node->getBody()->traverse(this);
3776         builder.createBranch(&blocks.continue_target);
3777         breakForLoop.pop();
3778 
3779         builder.setBuildPoint(&blocks.continue_target);
3780         if (node->getTerminal())
3781             node->getTerminal()->traverse(this);
3782         if (node->getTest()) {
3783             node->getTest()->traverse(this);
3784             spv::Id condition =
3785                 accessChainLoad(node->getTest()->getType());
3786             builder.createConditionalBranch(condition, &blocks.head, &blocks.merge);
3787         } else {
3788             // TODO: unless there was a break/return/discard instruction
3789             // somewhere in the body, this is an infinite loop, so we should
3790             // issue a warning.
3791             builder.createBranch(&blocks.head);
3792         }
3793     }
3794     builder.setBuildPoint(&blocks.merge);
3795     builder.closeLoop();
3796     return false;
3797 }
3798 
visitBranch(glslang::TVisit,glslang::TIntermBranch * node)3799 bool TGlslangToSpvTraverser::visitBranch(glslang::TVisit /* visit */, glslang::TIntermBranch* node)
3800 {
3801     if (node->getExpression())
3802         node->getExpression()->traverse(this);
3803 
3804     builder.setLine(node->getLoc().line, node->getLoc().getFilename());
3805 
3806     switch (node->getFlowOp()) {
3807     case glslang::EOpKill:
3808         if (glslangIntermediate->getSpv().spv >= glslang::EShTargetSpv_1_6) {
3809             if (glslangIntermediate->getSource() == glslang::EShSourceHlsl) {
3810               builder.addCapability(spv::CapabilityDemoteToHelperInvocation);
3811               builder.createNoResultOp(spv::OpDemoteToHelperInvocationEXT);
3812             } else {
3813                 builder.makeStatementTerminator(spv::OpTerminateInvocation, "post-terminate-invocation");
3814             }
3815         } else {
3816             builder.makeStatementTerminator(spv::OpKill, "post-discard");
3817         }
3818         break;
3819     case glslang::EOpTerminateInvocation:
3820         builder.addExtension(spv::E_SPV_KHR_terminate_invocation);
3821         builder.makeStatementTerminator(spv::OpTerminateInvocation, "post-terminate-invocation");
3822         break;
3823     case glslang::EOpBreak:
3824         if (breakForLoop.top())
3825             builder.createLoopExit();
3826         else
3827             builder.addSwitchBreak();
3828         break;
3829     case glslang::EOpContinue:
3830         builder.createLoopContinue();
3831         break;
3832     case glslang::EOpReturn:
3833         if (node->getExpression() != nullptr) {
3834             const glslang::TType& glslangReturnType = node->getExpression()->getType();
3835             spv::Id returnId = accessChainLoad(glslangReturnType);
3836             if (builder.getTypeId(returnId) != currentFunction->getReturnType() ||
3837                 TranslatePrecisionDecoration(glslangReturnType) != currentFunction->getReturnPrecision()) {
3838                 builder.clearAccessChain();
3839                 spv::Id copyId = builder.createVariable(currentFunction->getReturnPrecision(),
3840                     spv::StorageClassFunction, currentFunction->getReturnType());
3841                 builder.setAccessChainLValue(copyId);
3842                 multiTypeStore(glslangReturnType, returnId);
3843                 returnId = builder.createLoad(copyId, currentFunction->getReturnPrecision());
3844             }
3845             builder.makeReturn(false, returnId);
3846         } else
3847             builder.makeReturn(false);
3848 
3849         builder.clearAccessChain();
3850         break;
3851 
3852 #ifndef GLSLANG_WEB
3853     case glslang::EOpDemote:
3854         builder.createNoResultOp(spv::OpDemoteToHelperInvocationEXT);
3855         builder.addExtension(spv::E_SPV_EXT_demote_to_helper_invocation);
3856         builder.addCapability(spv::CapabilityDemoteToHelperInvocationEXT);
3857         break;
3858     case glslang::EOpTerminateRayKHR:
3859         builder.makeStatementTerminator(spv::OpTerminateRayKHR, "post-terminateRayKHR");
3860         break;
3861     case glslang::EOpIgnoreIntersectionKHR:
3862         builder.makeStatementTerminator(spv::OpIgnoreIntersectionKHR, "post-ignoreIntersectionKHR");
3863         break;
3864 #endif
3865 
3866     default:
3867         assert(0);
3868         break;
3869     }
3870 
3871     return false;
3872 }
3873 
createSpvVariable(const glslang::TIntermSymbol * node,spv::Id forcedType)3874 spv::Id TGlslangToSpvTraverser::createSpvVariable(const glslang::TIntermSymbol* node, spv::Id forcedType)
3875 {
3876     // First, steer off constants, which are not SPIR-V variables, but
3877     // can still have a mapping to a SPIR-V Id.
3878     // This includes specialization constants.
3879     if (node->getQualifier().isConstant()) {
3880         spv::Id result = createSpvConstant(*node);
3881         if (result != spv::NoResult)
3882             return result;
3883     }
3884 
3885     // Now, handle actual variables
3886     spv::StorageClass storageClass = TranslateStorageClass(node->getType());
3887     spv::Id spvType = forcedType == spv::NoType ? convertGlslangToSpvType(node->getType())
3888                                                 : forcedType;
3889 
3890     const bool contains16BitType = node->getType().contains16BitFloat() ||
3891                                    node->getType().contains16BitInt();
3892     if (contains16BitType) {
3893         switch (storageClass) {
3894         case spv::StorageClassInput:
3895         case spv::StorageClassOutput:
3896             builder.addIncorporatedExtension(spv::E_SPV_KHR_16bit_storage, spv::Spv_1_3);
3897             builder.addCapability(spv::CapabilityStorageInputOutput16);
3898             break;
3899         case spv::StorageClassUniform:
3900             builder.addIncorporatedExtension(spv::E_SPV_KHR_16bit_storage, spv::Spv_1_3);
3901             if (node->getType().getQualifier().storage == glslang::EvqBuffer)
3902                 builder.addCapability(spv::CapabilityStorageUniformBufferBlock16);
3903             else
3904                 builder.addCapability(spv::CapabilityStorageUniform16);
3905             break;
3906 #ifndef GLSLANG_WEB
3907         case spv::StorageClassPushConstant:
3908             builder.addIncorporatedExtension(spv::E_SPV_KHR_16bit_storage, spv::Spv_1_3);
3909             builder.addCapability(spv::CapabilityStoragePushConstant16);
3910             break;
3911         case spv::StorageClassStorageBuffer:
3912         case spv::StorageClassPhysicalStorageBufferEXT:
3913             builder.addIncorporatedExtension(spv::E_SPV_KHR_16bit_storage, spv::Spv_1_3);
3914             builder.addCapability(spv::CapabilityStorageUniformBufferBlock16);
3915             break;
3916 #endif
3917         default:
3918             if (storageClass == spv::StorageClassWorkgroup &&
3919                 node->getType().getBasicType() == glslang::EbtBlock) {
3920                 builder.addCapability(spv::CapabilityWorkgroupMemoryExplicitLayout16BitAccessKHR);
3921                 break;
3922             }
3923             if (node->getType().contains16BitFloat())
3924                 builder.addCapability(spv::CapabilityFloat16);
3925             if (node->getType().contains16BitInt())
3926                 builder.addCapability(spv::CapabilityInt16);
3927             break;
3928         }
3929     }
3930 
3931     if (node->getType().contains8BitInt()) {
3932         if (storageClass == spv::StorageClassPushConstant) {
3933             builder.addIncorporatedExtension(spv::E_SPV_KHR_8bit_storage, spv::Spv_1_5);
3934             builder.addCapability(spv::CapabilityStoragePushConstant8);
3935         } else if (storageClass == spv::StorageClassUniform) {
3936             builder.addIncorporatedExtension(spv::E_SPV_KHR_8bit_storage, spv::Spv_1_5);
3937             builder.addCapability(spv::CapabilityUniformAndStorageBuffer8BitAccess);
3938         } else if (storageClass == spv::StorageClassStorageBuffer) {
3939             builder.addIncorporatedExtension(spv::E_SPV_KHR_8bit_storage, spv::Spv_1_5);
3940             builder.addCapability(spv::CapabilityStorageBuffer8BitAccess);
3941         } else if (storageClass == spv::StorageClassWorkgroup &&
3942                    node->getType().getBasicType() == glslang::EbtBlock) {
3943             builder.addCapability(spv::CapabilityWorkgroupMemoryExplicitLayout8BitAccessKHR);
3944         } else {
3945             builder.addCapability(spv::CapabilityInt8);
3946         }
3947     }
3948 
3949     const char* name = node->getName().c_str();
3950     if (glslang::IsAnonymous(name))
3951         name = "";
3952 
3953     spv::Id initializer = spv::NoResult;
3954 
3955     if (node->getType().getQualifier().storage == glslang::EvqUniform && !node->getConstArray().empty()) {
3956         int nextConst = 0;
3957         initializer = createSpvConstantFromConstUnionArray(node->getType(),
3958                                                            node->getConstArray(),
3959                                                            nextConst,
3960                                                            false /* specConst */);
3961     } else if (node->getType().getQualifier().isNullInit()) {
3962         initializer = builder.makeNullConstant(spvType);
3963     }
3964 
3965     return builder.createVariable(spv::NoPrecision, storageClass, spvType, name, initializer);
3966 }
3967 
3968 // Return type Id of the sampled type.
getSampledType(const glslang::TSampler & sampler)3969 spv::Id TGlslangToSpvTraverser::getSampledType(const glslang::TSampler& sampler)
3970 {
3971     switch (sampler.type) {
3972         case glslang::EbtInt:      return builder.makeIntType(32);
3973         case glslang::EbtUint:     return builder.makeUintType(32);
3974         case glslang::EbtFloat:    return builder.makeFloatType(32);
3975 #ifndef GLSLANG_WEB
3976         case glslang::EbtFloat16:
3977             builder.addExtension(spv::E_SPV_AMD_gpu_shader_half_float_fetch);
3978             builder.addCapability(spv::CapabilityFloat16ImageAMD);
3979             return builder.makeFloatType(16);
3980         case glslang::EbtInt64:
3981             builder.addExtension(spv::E_SPV_EXT_shader_image_int64);
3982             builder.addCapability(spv::CapabilityInt64ImageEXT);
3983             return builder.makeIntType(64);
3984         case glslang::EbtUint64:
3985             builder.addExtension(spv::E_SPV_EXT_shader_image_int64);
3986             builder.addCapability(spv::CapabilityInt64ImageEXT);
3987             return builder.makeUintType(64);
3988 #endif
3989         default:
3990             assert(0);
3991             return builder.makeFloatType(32);
3992     }
3993 }
3994 
3995 // If node is a swizzle operation, return the type that should be used if
3996 // the swizzle base is first consumed by another operation, before the swizzle
3997 // is applied.
getInvertedSwizzleType(const glslang::TIntermTyped & node)3998 spv::Id TGlslangToSpvTraverser::getInvertedSwizzleType(const glslang::TIntermTyped& node)
3999 {
4000     if (node.getAsOperator() &&
4001         node.getAsOperator()->getOp() == glslang::EOpVectorSwizzle)
4002         return convertGlslangToSpvType(node.getAsBinaryNode()->getLeft()->getType());
4003     else
4004         return spv::NoType;
4005 }
4006 
4007 // When inverting a swizzle with a parent op, this function
4008 // will apply the swizzle operation to a completed parent operation.
createInvertedSwizzle(spv::Decoration precision,const glslang::TIntermTyped & node,spv::Id parentResult)4009 spv::Id TGlslangToSpvTraverser::createInvertedSwizzle(spv::Decoration precision, const glslang::TIntermTyped& node,
4010     spv::Id parentResult)
4011 {
4012     std::vector<unsigned> swizzle;
4013     convertSwizzle(*node.getAsBinaryNode()->getRight()->getAsAggregate(), swizzle);
4014     return builder.createRvalueSwizzle(precision, convertGlslangToSpvType(node.getType()), parentResult, swizzle);
4015 }
4016 
4017 // Convert a glslang AST swizzle node to a swizzle vector for building SPIR-V.
convertSwizzle(const glslang::TIntermAggregate & node,std::vector<unsigned> & swizzle)4018 void TGlslangToSpvTraverser::convertSwizzle(const glslang::TIntermAggregate& node, std::vector<unsigned>& swizzle)
4019 {
4020     const glslang::TIntermSequence& swizzleSequence = node.getSequence();
4021     for (int i = 0; i < (int)swizzleSequence.size(); ++i)
4022         swizzle.push_back(swizzleSequence[i]->getAsConstantUnion()->getConstArray()[0].getIConst());
4023 }
4024 
4025 // Convert from a glslang type to an SPV type, by calling into a
4026 // recursive version of this function. This establishes the inherited
4027 // layout state rooted from the top-level type.
convertGlslangToSpvType(const glslang::TType & type,bool forwardReferenceOnly)4028 spv::Id TGlslangToSpvTraverser::convertGlslangToSpvType(const glslang::TType& type, bool forwardReferenceOnly)
4029 {
4030     return convertGlslangToSpvType(type, getExplicitLayout(type), type.getQualifier(), false, forwardReferenceOnly);
4031 }
4032 
4033 // Do full recursive conversion of an arbitrary glslang type to a SPIR-V Id.
4034 // explicitLayout can be kept the same throughout the hierarchical recursive walk.
4035 // Mutually recursive with convertGlslangStructToSpvType().
convertGlslangToSpvType(const glslang::TType & type,glslang::TLayoutPacking explicitLayout,const glslang::TQualifier & qualifier,bool lastBufferBlockMember,bool forwardReferenceOnly)4036 spv::Id TGlslangToSpvTraverser::convertGlslangToSpvType(const glslang::TType& type,
4037     glslang::TLayoutPacking explicitLayout, const glslang::TQualifier& qualifier,
4038     bool lastBufferBlockMember, bool forwardReferenceOnly)
4039 {
4040     spv::Id spvType = spv::NoResult;
4041 
4042     switch (type.getBasicType()) {
4043     case glslang::EbtVoid:
4044         spvType = builder.makeVoidType();
4045         assert (! type.isArray());
4046         break;
4047     case glslang::EbtBool:
4048         // "transparent" bool doesn't exist in SPIR-V.  The GLSL convention is
4049         // a 32-bit int where non-0 means true.
4050         if (explicitLayout != glslang::ElpNone)
4051             spvType = builder.makeUintType(32);
4052         else
4053             spvType = builder.makeBoolType();
4054         break;
4055     case glslang::EbtInt:
4056         spvType = builder.makeIntType(32);
4057         break;
4058     case glslang::EbtUint:
4059         spvType = builder.makeUintType(32);
4060         break;
4061     case glslang::EbtFloat:
4062         spvType = builder.makeFloatType(32);
4063         break;
4064 #ifndef GLSLANG_WEB
4065     case glslang::EbtDouble:
4066         spvType = builder.makeFloatType(64);
4067         break;
4068     case glslang::EbtFloat16:
4069         spvType = builder.makeFloatType(16);
4070         break;
4071     case glslang::EbtInt8:
4072         spvType = builder.makeIntType(8);
4073         break;
4074     case glslang::EbtUint8:
4075         spvType = builder.makeUintType(8);
4076         break;
4077     case glslang::EbtInt16:
4078         spvType = builder.makeIntType(16);
4079         break;
4080     case glslang::EbtUint16:
4081         spvType = builder.makeUintType(16);
4082         break;
4083     case glslang::EbtInt64:
4084         spvType = builder.makeIntType(64);
4085         break;
4086     case glslang::EbtUint64:
4087         spvType = builder.makeUintType(64);
4088         break;
4089     case glslang::EbtAtomicUint:
4090         builder.addCapability(spv::CapabilityAtomicStorage);
4091         spvType = builder.makeUintType(32);
4092         break;
4093     case glslang::EbtAccStruct:
4094         switch (glslangIntermediate->getStage()) {
4095         case EShLangRayGen:
4096         case EShLangIntersect:
4097         case EShLangAnyHit:
4098         case EShLangClosestHit:
4099         case EShLangMiss:
4100         case EShLangCallable:
4101             // these all should have the RayTracingNV/KHR capability already
4102             break;
4103         default:
4104             {
4105                 auto& extensions = glslangIntermediate->getRequestedExtensions();
4106                 if (extensions.find("GL_EXT_ray_query") != extensions.end()) {
4107                     builder.addExtension(spv::E_SPV_KHR_ray_query);
4108                     builder.addCapability(spv::CapabilityRayQueryKHR);
4109                 }
4110             }
4111             break;
4112         }
4113         spvType = builder.makeAccelerationStructureType();
4114         break;
4115     case glslang::EbtRayQuery:
4116         {
4117             auto& extensions = glslangIntermediate->getRequestedExtensions();
4118             if (extensions.find("GL_EXT_ray_query") != extensions.end()) {
4119                 builder.addExtension(spv::E_SPV_KHR_ray_query);
4120                 builder.addCapability(spv::CapabilityRayQueryKHR);
4121             }
4122             spvType = builder.makeRayQueryType();
4123         }
4124         break;
4125     case glslang::EbtReference:
4126         {
4127             // Make the forward pointer, then recurse to convert the structure type, then
4128             // patch up the forward pointer with a real pointer type.
4129             if (forwardPointers.find(type.getReferentType()) == forwardPointers.end()) {
4130                 spv::Id forwardId = builder.makeForwardPointer(spv::StorageClassPhysicalStorageBufferEXT);
4131                 forwardPointers[type.getReferentType()] = forwardId;
4132             }
4133             spvType = forwardPointers[type.getReferentType()];
4134             if (!forwardReferenceOnly) {
4135                 spv::Id referentType = convertGlslangToSpvType(*type.getReferentType());
4136                 builder.makePointerFromForwardPointer(spv::StorageClassPhysicalStorageBufferEXT,
4137                                                       forwardPointers[type.getReferentType()],
4138                                                       referentType);
4139             }
4140         }
4141         break;
4142 #endif
4143     case glslang::EbtSampler:
4144         {
4145             const glslang::TSampler& sampler = type.getSampler();
4146             if (sampler.isPureSampler()) {
4147                 spvType = builder.makeSamplerType();
4148             } else {
4149                 // an image is present, make its type
4150                 spvType = builder.makeImageType(getSampledType(sampler), TranslateDimensionality(sampler),
4151                                                 sampler.isShadow(), sampler.isArrayed(), sampler.isMultiSample(),
4152                                                 sampler.isImageClass() ? 2 : 1, TranslateImageFormat(type));
4153                 if (sampler.isCombined()) {
4154                     // already has both image and sampler, make the combined type
4155                     spvType = builder.makeSampledImageType(spvType);
4156                 }
4157             }
4158         }
4159         break;
4160     case glslang::EbtStruct:
4161     case glslang::EbtBlock:
4162         {
4163             // If we've seen this struct type, return it
4164             const glslang::TTypeList* glslangMembers = type.getStruct();
4165 
4166             // Try to share structs for different layouts, but not yet for other
4167             // kinds of qualification (primarily not yet including interpolant qualification).
4168             if (! HasNonLayoutQualifiers(type, qualifier))
4169                 spvType = structMap[explicitLayout][qualifier.layoutMatrix][glslangMembers];
4170             if (spvType != spv::NoResult)
4171                 break;
4172 
4173             // else, we haven't seen it...
4174             if (type.getBasicType() == glslang::EbtBlock)
4175                 memberRemapper[glslangTypeToIdMap[glslangMembers]].resize(glslangMembers->size());
4176             spvType = convertGlslangStructToSpvType(type, glslangMembers, explicitLayout, qualifier);
4177         }
4178         break;
4179     case glslang::EbtString:
4180         // no type used for OpString
4181         return 0;
4182 #ifndef GLSLANG_WEB
4183     case glslang::EbtSpirvType: {
4184         // GL_EXT_spirv_intrinsics
4185         const auto& spirvType = type.getSpirvType();
4186         const auto& spirvInst = spirvType.spirvInst;
4187 
4188         std::vector<spv::IdImmediate> operands;
4189         for (const auto& typeParam : spirvType.typeParams) {
4190             // Constant expression
4191             if (typeParam.constant->isLiteral()) {
4192                 if (typeParam.constant->getBasicType() == glslang::EbtFloat) {
4193                     float floatValue = static_cast<float>(typeParam.constant->getConstArray()[0].getDConst());
4194                     unsigned literal = *reinterpret_cast<unsigned*>(&floatValue);
4195                     operands.push_back({false, literal});
4196                 } else if (typeParam.constant->getBasicType() == glslang::EbtInt) {
4197                     unsigned literal = typeParam.constant->getConstArray()[0].getIConst();
4198                     operands.push_back({false, literal});
4199                 } else if (typeParam.constant->getBasicType() == glslang::EbtUint) {
4200                     unsigned literal = typeParam.constant->getConstArray()[0].getUConst();
4201                     operands.push_back({false, literal});
4202                 } else if (typeParam.constant->getBasicType() == glslang::EbtBool) {
4203                     unsigned literal = typeParam.constant->getConstArray()[0].getBConst();
4204                     operands.push_back({false, literal});
4205                 } else if (typeParam.constant->getBasicType() == glslang::EbtString) {
4206                     auto str = typeParam.constant->getConstArray()[0].getSConst()->c_str();
4207                     unsigned literal = 0;
4208                     char* literalPtr = reinterpret_cast<char*>(&literal);
4209                     unsigned charCount = 0;
4210                     char ch = 0;
4211                     do {
4212                         ch = *(str++);
4213                         *(literalPtr++) = ch;
4214                         ++charCount;
4215                         if (charCount == 4) {
4216                             operands.push_back({false, literal});
4217                             literalPtr = reinterpret_cast<char*>(&literal);
4218                             charCount = 0;
4219                         }
4220                     } while (ch != 0);
4221 
4222                     // Partial literal is padded with 0
4223                     if (charCount > 0) {
4224                         for (; charCount < 4; ++charCount)
4225                             *(literalPtr++) = 0;
4226                         operands.push_back({false, literal});
4227                     }
4228                 } else
4229                     assert(0); // Unexpected type
4230             } else
4231                 operands.push_back({true, createSpvConstant(*typeParam.constant)});
4232         }
4233 
4234         assert(spirvInst.set == ""); // Currently, couldn't be extended instructions.
4235         spvType = builder.makeGenericType(static_cast<spv::Op>(spirvInst.id), operands);
4236 
4237         break;
4238     }
4239 #endif
4240     default:
4241         assert(0);
4242         break;
4243     }
4244 
4245     if (type.isMatrix())
4246         spvType = builder.makeMatrixType(spvType, type.getMatrixCols(), type.getMatrixRows());
4247     else {
4248         // If this variable has a vector element count greater than 1, create a SPIR-V vector
4249         if (type.getVectorSize() > 1)
4250             spvType = builder.makeVectorType(spvType, type.getVectorSize());
4251     }
4252 
4253     if (type.isCoopMat()) {
4254         builder.addCapability(spv::CapabilityCooperativeMatrixNV);
4255         builder.addExtension(spv::E_SPV_NV_cooperative_matrix);
4256         if (type.getBasicType() == glslang::EbtFloat16)
4257             builder.addCapability(spv::CapabilityFloat16);
4258         if (type.getBasicType() == glslang::EbtUint8 ||
4259             type.getBasicType() == glslang::EbtInt8) {
4260             builder.addCapability(spv::CapabilityInt8);
4261         }
4262 
4263         spv::Id scope = makeArraySizeId(*type.getTypeParameters(), 1);
4264         spv::Id rows = makeArraySizeId(*type.getTypeParameters(), 2);
4265         spv::Id cols = makeArraySizeId(*type.getTypeParameters(), 3);
4266 
4267         spvType = builder.makeCooperativeMatrixType(spvType, scope, rows, cols);
4268     }
4269 
4270     if (type.isArray()) {
4271         int stride = 0;  // keep this 0 unless doing an explicit layout; 0 will mean no decoration, no stride
4272 
4273         // Do all but the outer dimension
4274         if (type.getArraySizes()->getNumDims() > 1) {
4275             // We need to decorate array strides for types needing explicit layout, except blocks.
4276             if (explicitLayout != glslang::ElpNone && type.getBasicType() != glslang::EbtBlock) {
4277                 // Use a dummy glslang type for querying internal strides of
4278                 // arrays of arrays, but using just a one-dimensional array.
4279                 glslang::TType simpleArrayType(type, 0); // deference type of the array
4280                 while (simpleArrayType.getArraySizes()->getNumDims() > 1)
4281                     simpleArrayType.getArraySizes()->dereference();
4282 
4283                 // Will compute the higher-order strides here, rather than making a whole
4284                 // pile of types and doing repetitive recursion on their contents.
4285                 stride = getArrayStride(simpleArrayType, explicitLayout, qualifier.layoutMatrix);
4286             }
4287 
4288             // make the arrays
4289             for (int dim = type.getArraySizes()->getNumDims() - 1; dim > 0; --dim) {
4290                 spvType = builder.makeArrayType(spvType, makeArraySizeId(*type.getArraySizes(), dim), stride);
4291                 if (stride > 0)
4292                     builder.addDecoration(spvType, spv::DecorationArrayStride, stride);
4293                 stride *= type.getArraySizes()->getDimSize(dim);
4294             }
4295         } else {
4296             // single-dimensional array, and don't yet have stride
4297 
4298             // We need to decorate array strides for types needing explicit layout, except blocks.
4299             if (explicitLayout != glslang::ElpNone && type.getBasicType() != glslang::EbtBlock)
4300                 stride = getArrayStride(type, explicitLayout, qualifier.layoutMatrix);
4301         }
4302 
4303         // Do the outer dimension, which might not be known for a runtime-sized array.
4304         // (Unsized arrays that survive through linking will be runtime-sized arrays)
4305         if (type.isSizedArray())
4306             spvType = builder.makeArrayType(spvType, makeArraySizeId(*type.getArraySizes(), 0), stride);
4307         else {
4308 #ifndef GLSLANG_WEB
4309             if (!lastBufferBlockMember) {
4310                 builder.addIncorporatedExtension("SPV_EXT_descriptor_indexing", spv::Spv_1_5);
4311                 builder.addCapability(spv::CapabilityRuntimeDescriptorArrayEXT);
4312             }
4313 #endif
4314             spvType = builder.makeRuntimeArray(spvType);
4315         }
4316         if (stride > 0)
4317             builder.addDecoration(spvType, spv::DecorationArrayStride, stride);
4318     }
4319 
4320     return spvType;
4321 }
4322 
4323 // TODO: this functionality should exist at a higher level, in creating the AST
4324 //
4325 // Identify interface members that don't have their required extension turned on.
4326 //
filterMember(const glslang::TType & member)4327 bool TGlslangToSpvTraverser::filterMember(const glslang::TType& member)
4328 {
4329 #ifndef GLSLANG_WEB
4330     auto& extensions = glslangIntermediate->getRequestedExtensions();
4331 
4332     if (member.getFieldName() == "gl_SecondaryViewportMaskNV" &&
4333         extensions.find("GL_NV_stereo_view_rendering") == extensions.end())
4334         return true;
4335     if (member.getFieldName() == "gl_SecondaryPositionNV" &&
4336         extensions.find("GL_NV_stereo_view_rendering") == extensions.end())
4337         return true;
4338 
4339     if (glslangIntermediate->getStage() != EShLangMeshNV) {
4340         if (member.getFieldName() == "gl_ViewportMask" &&
4341             extensions.find("GL_NV_viewport_array2") == extensions.end())
4342             return true;
4343         if (member.getFieldName() == "gl_PositionPerViewNV" &&
4344             extensions.find("GL_NVX_multiview_per_view_attributes") == extensions.end())
4345             return true;
4346         if (member.getFieldName() == "gl_ViewportMaskPerViewNV" &&
4347             extensions.find("GL_NVX_multiview_per_view_attributes") == extensions.end())
4348             return true;
4349     }
4350 #endif
4351 
4352     return false;
4353 };
4354 
4355 // Do full recursive conversion of a glslang structure (or block) type to a SPIR-V Id.
4356 // explicitLayout can be kept the same throughout the hierarchical recursive walk.
4357 // Mutually recursive with convertGlslangToSpvType().
convertGlslangStructToSpvType(const glslang::TType & type,const glslang::TTypeList * glslangMembers,glslang::TLayoutPacking explicitLayout,const glslang::TQualifier & qualifier)4358 spv::Id TGlslangToSpvTraverser::convertGlslangStructToSpvType(const glslang::TType& type,
4359                                                               const glslang::TTypeList* glslangMembers,
4360                                                               glslang::TLayoutPacking explicitLayout,
4361                                                               const glslang::TQualifier& qualifier)
4362 {
4363     // Create a vector of struct types for SPIR-V to consume
4364     std::vector<spv::Id> spvMembers;
4365     int memberDelta = 0;  // how much the member's index changes from glslang to SPIR-V, normally 0,
4366                           // except sometimes for blocks
4367     std::vector<std::pair<glslang::TType*, glslang::TQualifier> > deferredForwardPointers;
4368     for (int i = 0; i < (int)glslangMembers->size(); i++) {
4369         glslang::TType& glslangMember = *(*glslangMembers)[i].type;
4370         if (glslangMember.hiddenMember()) {
4371             ++memberDelta;
4372             if (type.getBasicType() == glslang::EbtBlock)
4373                 memberRemapper[glslangTypeToIdMap[glslangMembers]][i] = -1;
4374         } else {
4375             if (type.getBasicType() == glslang::EbtBlock) {
4376                 if (filterMember(glslangMember)) {
4377                     memberDelta++;
4378                     memberRemapper[glslangTypeToIdMap[glslangMembers]][i] = -1;
4379                     continue;
4380                 }
4381                 memberRemapper[glslangTypeToIdMap[glslangMembers]][i] = i - memberDelta;
4382             }
4383             // modify just this child's view of the qualifier
4384             glslang::TQualifier memberQualifier = glslangMember.getQualifier();
4385             InheritQualifiers(memberQualifier, qualifier);
4386 
4387             // manually inherit location
4388             if (! memberQualifier.hasLocation() && qualifier.hasLocation())
4389                 memberQualifier.layoutLocation = qualifier.layoutLocation;
4390 
4391             // recurse
4392             bool lastBufferBlockMember = qualifier.storage == glslang::EvqBuffer &&
4393                                          i == (int)glslangMembers->size() - 1;
4394 
4395             // Make forward pointers for any pointer members, and create a list of members to
4396             // convert to spirv types after creating the struct.
4397             if (glslangMember.isReference()) {
4398                 if (forwardPointers.find(glslangMember.getReferentType()) == forwardPointers.end()) {
4399                     deferredForwardPointers.push_back(std::make_pair(&glslangMember, memberQualifier));
4400                 }
4401                 spvMembers.push_back(
4402                     convertGlslangToSpvType(glslangMember, explicitLayout, memberQualifier, lastBufferBlockMember,
4403                         true));
4404             } else {
4405                 spvMembers.push_back(
4406                     convertGlslangToSpvType(glslangMember, explicitLayout, memberQualifier, lastBufferBlockMember,
4407                         false));
4408             }
4409         }
4410     }
4411 
4412     // Make the SPIR-V type
4413     spv::Id spvType = builder.makeStructType(spvMembers, type.getTypeName().c_str());
4414     if (! HasNonLayoutQualifiers(type, qualifier))
4415         structMap[explicitLayout][qualifier.layoutMatrix][glslangMembers] = spvType;
4416 
4417     // Decorate it
4418     decorateStructType(type, glslangMembers, explicitLayout, qualifier, spvType);
4419 
4420     for (int i = 0; i < (int)deferredForwardPointers.size(); ++i) {
4421         auto it = deferredForwardPointers[i];
4422         convertGlslangToSpvType(*it.first, explicitLayout, it.second, false);
4423     }
4424 
4425     return spvType;
4426 }
4427 
decorateStructType(const glslang::TType & type,const glslang::TTypeList * glslangMembers,glslang::TLayoutPacking explicitLayout,const glslang::TQualifier & qualifier,spv::Id spvType)4428 void TGlslangToSpvTraverser::decorateStructType(const glslang::TType& type,
4429                                                 const glslang::TTypeList* glslangMembers,
4430                                                 glslang::TLayoutPacking explicitLayout,
4431                                                 const glslang::TQualifier& qualifier,
4432                                                 spv::Id spvType)
4433 {
4434     // Name and decorate the non-hidden members
4435     int offset = -1;
4436     bool memberLocationInvalid = type.isArrayOfArrays() ||
4437         (type.isArray() && (type.getQualifier().isArrayedIo(glslangIntermediate->getStage()) == false));
4438     for (int i = 0; i < (int)glslangMembers->size(); i++) {
4439         glslang::TType& glslangMember = *(*glslangMembers)[i].type;
4440         int member = i;
4441         if (type.getBasicType() == glslang::EbtBlock) {
4442             member = memberRemapper[glslangTypeToIdMap[glslangMembers]][i];
4443             if (filterMember(glslangMember))
4444                 continue;
4445         }
4446 
4447         // modify just this child's view of the qualifier
4448         glslang::TQualifier memberQualifier = glslangMember.getQualifier();
4449         InheritQualifiers(memberQualifier, qualifier);
4450 
4451         // using -1 above to indicate a hidden member
4452         if (member < 0)
4453             continue;
4454 
4455         builder.addMemberName(spvType, member, glslangMember.getFieldName().c_str());
4456         builder.addMemberDecoration(spvType, member,
4457                                     TranslateLayoutDecoration(glslangMember, memberQualifier.layoutMatrix));
4458         builder.addMemberDecoration(spvType, member, TranslatePrecisionDecoration(glslangMember));
4459         // Add interpolation and auxiliary storage decorations only to
4460         // top-level members of Input and Output storage classes
4461         if (type.getQualifier().storage == glslang::EvqVaryingIn ||
4462             type.getQualifier().storage == glslang::EvqVaryingOut) {
4463             if (type.getBasicType() == glslang::EbtBlock ||
4464                 glslangIntermediate->getSource() == glslang::EShSourceHlsl) {
4465                 builder.addMemberDecoration(spvType, member, TranslateInterpolationDecoration(memberQualifier));
4466                 builder.addMemberDecoration(spvType, member, TranslateAuxiliaryStorageDecoration(memberQualifier));
4467 #ifndef GLSLANG_WEB
4468                 addMeshNVDecoration(spvType, member, memberQualifier);
4469 #endif
4470             }
4471         }
4472         builder.addMemberDecoration(spvType, member, TranslateInvariantDecoration(memberQualifier));
4473 
4474 #ifndef GLSLANG_WEB
4475         if (type.getBasicType() == glslang::EbtBlock &&
4476             qualifier.storage == glslang::EvqBuffer) {
4477             // Add memory decorations only to top-level members of shader storage block
4478             std::vector<spv::Decoration> memory;
4479             TranslateMemoryDecoration(memberQualifier, memory, glslangIntermediate->usingVulkanMemoryModel());
4480             for (unsigned int i = 0; i < memory.size(); ++i)
4481                 builder.addMemberDecoration(spvType, member, memory[i]);
4482         }
4483 
4484 #endif
4485 
4486         // Location assignment was already completed correctly by the front end,
4487         // just track whether a member needs to be decorated.
4488         // Ignore member locations if the container is an array, as that's
4489         // ill-specified and decisions have been made to not allow this.
4490         if (!memberLocationInvalid && memberQualifier.hasLocation())
4491             builder.addMemberDecoration(spvType, member, spv::DecorationLocation, memberQualifier.layoutLocation);
4492 
4493         // component, XFB, others
4494         if (glslangMember.getQualifier().hasComponent())
4495             builder.addMemberDecoration(spvType, member, spv::DecorationComponent,
4496                                         glslangMember.getQualifier().layoutComponent);
4497         if (glslangMember.getQualifier().hasXfbOffset())
4498             builder.addMemberDecoration(spvType, member, spv::DecorationOffset,
4499                                         glslangMember.getQualifier().layoutXfbOffset);
4500         else if (explicitLayout != glslang::ElpNone) {
4501             // figure out what to do with offset, which is accumulating
4502             int nextOffset;
4503             updateMemberOffset(type, glslangMember, offset, nextOffset, explicitLayout, memberQualifier.layoutMatrix);
4504             if (offset >= 0)
4505                 builder.addMemberDecoration(spvType, member, spv::DecorationOffset, offset);
4506             offset = nextOffset;
4507         }
4508 
4509         if (glslangMember.isMatrix() && explicitLayout != glslang::ElpNone)
4510             builder.addMemberDecoration(spvType, member, spv::DecorationMatrixStride,
4511                                         getMatrixStride(glslangMember, explicitLayout, memberQualifier.layoutMatrix));
4512 
4513         // built-in variable decorations
4514         spv::BuiltIn builtIn = TranslateBuiltInDecoration(glslangMember.getQualifier().builtIn, true);
4515         if (builtIn != spv::BuiltInMax)
4516             builder.addMemberDecoration(spvType, member, spv::DecorationBuiltIn, (int)builtIn);
4517 
4518 #ifndef GLSLANG_WEB
4519         // nonuniform
4520         builder.addMemberDecoration(spvType, member, TranslateNonUniformDecoration(glslangMember.getQualifier()));
4521 
4522         if (glslangIntermediate->getHlslFunctionality1() && memberQualifier.semanticName != nullptr) {
4523             builder.addExtension("SPV_GOOGLE_hlsl_functionality1");
4524             builder.addMemberDecoration(spvType, member, (spv::Decoration)spv::DecorationHlslSemanticGOOGLE,
4525                                         memberQualifier.semanticName);
4526         }
4527 
4528         if (builtIn == spv::BuiltInLayer) {
4529             // SPV_NV_viewport_array2 extension
4530             if (glslangMember.getQualifier().layoutViewportRelative){
4531                 builder.addMemberDecoration(spvType, member, (spv::Decoration)spv::DecorationViewportRelativeNV);
4532                 builder.addCapability(spv::CapabilityShaderViewportMaskNV);
4533                 builder.addExtension(spv::E_SPV_NV_viewport_array2);
4534             }
4535             if (glslangMember.getQualifier().layoutSecondaryViewportRelativeOffset != -2048){
4536                 builder.addMemberDecoration(spvType, member,
4537                                             (spv::Decoration)spv::DecorationSecondaryViewportRelativeNV,
4538                                             glslangMember.getQualifier().layoutSecondaryViewportRelativeOffset);
4539                 builder.addCapability(spv::CapabilityShaderStereoViewNV);
4540                 builder.addExtension(spv::E_SPV_NV_stereo_view_rendering);
4541             }
4542         }
4543         if (glslangMember.getQualifier().layoutPassthrough) {
4544             builder.addMemberDecoration(spvType, member, (spv::Decoration)spv::DecorationPassthroughNV);
4545             builder.addCapability(spv::CapabilityGeometryShaderPassthroughNV);
4546             builder.addExtension(spv::E_SPV_NV_geometry_shader_passthrough);
4547         }
4548 
4549         //
4550         // Add SPIR-V decorations for members (GL_EXT_spirv_intrinsics)
4551         //
4552         if (glslangMember.getQualifier().hasSprivDecorate()) {
4553             const glslang::TSpirvDecorate& spirvDecorate = glslangMember.getQualifier().getSpirvDecorate();
4554 
4555             // Add spirv_decorate
4556             for (auto& decorate : spirvDecorate.decorates) {
4557                 if (!decorate.second.empty()) {
4558                     std::vector<unsigned> literals;
4559                     TranslateLiterals(decorate.second, literals);
4560                     builder.addMemberDecoration(spvType, member, static_cast<spv::Decoration>(decorate.first), literals);
4561                 }
4562                 else
4563                     builder.addMemberDecoration(spvType, member, static_cast<spv::Decoration>(decorate.first));
4564             }
4565 
4566             // spirv_decorate_id not applied to members
4567             assert(spirvDecorate.decorateIds.empty());
4568 
4569             // Add spirv_decorate_string
4570             for (auto& decorateString : spirvDecorate.decorateStrings) {
4571                 std::vector<const char*> strings;
4572                 assert(!decorateString.second.empty());
4573                 for (auto extraOperand : decorateString.second) {
4574                     const char* string = extraOperand->getConstArray()[0].getSConst()->c_str();
4575                     strings.push_back(string);
4576                 }
4577                 builder.addDecoration(spvType, static_cast<spv::Decoration>(decorateString.first), strings);
4578             }
4579         }
4580 #endif
4581     }
4582 
4583     // Decorate the structure
4584     builder.addDecoration(spvType, TranslateLayoutDecoration(type, qualifier.layoutMatrix));
4585     builder.addDecoration(spvType, TranslateBlockDecoration(type, glslangIntermediate->usingStorageBuffer()));
4586 }
4587 
4588 // Turn the expression forming the array size into an id.
4589 // This is not quite trivial, because of specialization constants.
4590 // Sometimes, a raw constant is turned into an Id, and sometimes
4591 // a specialization constant expression is.
makeArraySizeId(const glslang::TArraySizes & arraySizes,int dim)4592 spv::Id TGlslangToSpvTraverser::makeArraySizeId(const glslang::TArraySizes& arraySizes, int dim)
4593 {
4594     // First, see if this is sized with a node, meaning a specialization constant:
4595     glslang::TIntermTyped* specNode = arraySizes.getDimNode(dim);
4596     if (specNode != nullptr) {
4597         builder.clearAccessChain();
4598         SpecConstantOpModeGuard spec_constant_op_mode_setter(&builder);
4599         spec_constant_op_mode_setter.turnOnSpecConstantOpMode();
4600         specNode->traverse(this);
4601         return accessChainLoad(specNode->getAsTyped()->getType());
4602     }
4603 
4604     // Otherwise, need a compile-time (front end) size, get it:
4605     int size = arraySizes.getDimSize(dim);
4606     assert(size > 0);
4607     return builder.makeUintConstant(size);
4608 }
4609 
4610 // Wrap the builder's accessChainLoad to:
4611 //  - localize handling of RelaxedPrecision
4612 //  - use the SPIR-V inferred type instead of another conversion of the glslang type
4613 //    (avoids unnecessary work and possible type punning for structures)
4614 //  - do conversion of concrete to abstract type
accessChainLoad(const glslang::TType & type)4615 spv::Id TGlslangToSpvTraverser::accessChainLoad(const glslang::TType& type)
4616 {
4617     spv::Id nominalTypeId = builder.accessChainGetInferredType();
4618 
4619     spv::Builder::AccessChain::CoherentFlags coherentFlags = builder.getAccessChain().coherentFlags;
4620     coherentFlags |= TranslateCoherent(type);
4621 
4622     unsigned int alignment = builder.getAccessChain().alignment;
4623     alignment |= type.getBufferReferenceAlignment();
4624 
4625     spv::Id loadedId = builder.accessChainLoad(TranslatePrecisionDecoration(type),
4626         TranslateNonUniformDecoration(builder.getAccessChain().coherentFlags),
4627         TranslateNonUniformDecoration(type.getQualifier()),
4628         nominalTypeId,
4629         spv::MemoryAccessMask(TranslateMemoryAccess(coherentFlags) & ~spv::MemoryAccessMakePointerAvailableKHRMask),
4630         TranslateMemoryScope(coherentFlags),
4631         alignment);
4632 
4633     // Need to convert to abstract types when necessary
4634     if (type.getBasicType() == glslang::EbtBool) {
4635         loadedId = convertLoadedBoolInUniformToUint(type, nominalTypeId, loadedId);
4636     }
4637 
4638     return loadedId;
4639 }
4640 
4641 // Wrap the builder's accessChainStore to:
4642 //  - do conversion of concrete to abstract type
4643 //
4644 // Implicitly uses the existing builder.accessChain as the storage target.
accessChainStore(const glslang::TType & type,spv::Id rvalue)4645 void TGlslangToSpvTraverser::accessChainStore(const glslang::TType& type, spv::Id rvalue)
4646 {
4647     // Need to convert to abstract types when necessary
4648     if (type.getBasicType() == glslang::EbtBool) {
4649         spv::Id nominalTypeId = builder.accessChainGetInferredType();
4650 
4651         if (builder.isScalarType(nominalTypeId)) {
4652             // Conversion for bool
4653             spv::Id boolType = builder.makeBoolType();
4654             if (nominalTypeId != boolType) {
4655                 // keep these outside arguments, for determinant order-of-evaluation
4656                 spv::Id one = builder.makeUintConstant(1);
4657                 spv::Id zero = builder.makeUintConstant(0);
4658                 rvalue = builder.createTriOp(spv::OpSelect, nominalTypeId, rvalue, one, zero);
4659             } else if (builder.getTypeId(rvalue) != boolType)
4660                 rvalue = builder.createBinOp(spv::OpINotEqual, boolType, rvalue, builder.makeUintConstant(0));
4661         } else if (builder.isVectorType(nominalTypeId)) {
4662             // Conversion for bvec
4663             int vecSize = builder.getNumTypeComponents(nominalTypeId);
4664             spv::Id bvecType = builder.makeVectorType(builder.makeBoolType(), vecSize);
4665             if (nominalTypeId != bvecType) {
4666                 // keep these outside arguments, for determinant order-of-evaluation
4667                 spv::Id one = makeSmearedConstant(builder.makeUintConstant(1), vecSize);
4668                 spv::Id zero = makeSmearedConstant(builder.makeUintConstant(0), vecSize);
4669                 rvalue = builder.createTriOp(spv::OpSelect, nominalTypeId, rvalue, one, zero);
4670             } else if (builder.getTypeId(rvalue) != bvecType)
4671                 rvalue = builder.createBinOp(spv::OpINotEqual, bvecType, rvalue,
4672                                              makeSmearedConstant(builder.makeUintConstant(0), vecSize));
4673         }
4674     }
4675 
4676     spv::Builder::AccessChain::CoherentFlags coherentFlags = builder.getAccessChain().coherentFlags;
4677     coherentFlags |= TranslateCoherent(type);
4678 
4679     unsigned int alignment = builder.getAccessChain().alignment;
4680     alignment |= type.getBufferReferenceAlignment();
4681 
4682     builder.accessChainStore(rvalue, TranslateNonUniformDecoration(builder.getAccessChain().coherentFlags),
4683                              spv::MemoryAccessMask(TranslateMemoryAccess(coherentFlags) &
4684                                 ~spv::MemoryAccessMakePointerVisibleKHRMask),
4685                              TranslateMemoryScope(coherentFlags), alignment);
4686 }
4687 
4688 // For storing when types match at the glslang level, but not might match at the
4689 // SPIR-V level.
4690 //
4691 // This especially happens when a single glslang type expands to multiple
4692 // SPIR-V types, like a struct that is used in a member-undecorated way as well
4693 // as in a member-decorated way.
4694 //
4695 // NOTE: This function can handle any store request; if it's not special it
4696 // simplifies to a simple OpStore.
4697 //
4698 // Implicitly uses the existing builder.accessChain as the storage target.
multiTypeStore(const glslang::TType & type,spv::Id rValue)4699 void TGlslangToSpvTraverser::multiTypeStore(const glslang::TType& type, spv::Id rValue)
4700 {
4701     // we only do the complex path here if it's an aggregate
4702     if (! type.isStruct() && ! type.isArray()) {
4703         accessChainStore(type, rValue);
4704         return;
4705     }
4706 
4707     // and, it has to be a case of type aliasing
4708     spv::Id rType = builder.getTypeId(rValue);
4709     spv::Id lValue = builder.accessChainGetLValue();
4710     spv::Id lType = builder.getContainedTypeId(builder.getTypeId(lValue));
4711     if (lType == rType) {
4712         accessChainStore(type, rValue);
4713         return;
4714     }
4715 
4716     // Recursively (as needed) copy an aggregate type to a different aggregate type,
4717     // where the two types were the same type in GLSL. This requires member
4718     // by member copy, recursively.
4719 
4720     // SPIR-V 1.4 added an instruction to do help do this.
4721     if (glslangIntermediate->getSpv().spv >= glslang::EShTargetSpv_1_4) {
4722         // However, bool in uniform space is changed to int, so
4723         // OpCopyLogical does not work for that.
4724         // TODO: It would be more robust to do a full recursive verification of the types satisfying SPIR-V rules.
4725         bool rBool = builder.containsType(builder.getTypeId(rValue), spv::OpTypeBool, 0);
4726         bool lBool = builder.containsType(lType, spv::OpTypeBool, 0);
4727         if (lBool == rBool) {
4728             spv::Id logicalCopy = builder.createUnaryOp(spv::OpCopyLogical, lType, rValue);
4729             accessChainStore(type, logicalCopy);
4730             return;
4731         }
4732     }
4733 
4734     // If an array, copy element by element.
4735     if (type.isArray()) {
4736         glslang::TType glslangElementType(type, 0);
4737         spv::Id elementRType = builder.getContainedTypeId(rType);
4738         for (int index = 0; index < type.getOuterArraySize(); ++index) {
4739             // get the source member
4740             spv::Id elementRValue = builder.createCompositeExtract(rValue, elementRType, index);
4741 
4742             // set up the target storage
4743             builder.clearAccessChain();
4744             builder.setAccessChainLValue(lValue);
4745             builder.accessChainPush(builder.makeIntConstant(index), TranslateCoherent(type),
4746                 type.getBufferReferenceAlignment());
4747 
4748             // store the member
4749             multiTypeStore(glslangElementType, elementRValue);
4750         }
4751     } else {
4752         assert(type.isStruct());
4753 
4754         // loop over structure members
4755         const glslang::TTypeList& members = *type.getStruct();
4756         for (int m = 0; m < (int)members.size(); ++m) {
4757             const glslang::TType& glslangMemberType = *members[m].type;
4758 
4759             // get the source member
4760             spv::Id memberRType = builder.getContainedTypeId(rType, m);
4761             spv::Id memberRValue = builder.createCompositeExtract(rValue, memberRType, m);
4762 
4763             // set up the target storage
4764             builder.clearAccessChain();
4765             builder.setAccessChainLValue(lValue);
4766             builder.accessChainPush(builder.makeIntConstant(m), TranslateCoherent(type),
4767                 type.getBufferReferenceAlignment());
4768 
4769             // store the member
4770             multiTypeStore(glslangMemberType, memberRValue);
4771         }
4772     }
4773 }
4774 
4775 // Decide whether or not this type should be
4776 // decorated with offsets and strides, and if so
4777 // whether std140 or std430 rules should be applied.
getExplicitLayout(const glslang::TType & type) const4778 glslang::TLayoutPacking TGlslangToSpvTraverser::getExplicitLayout(const glslang::TType& type) const
4779 {
4780     // has to be a block
4781     if (type.getBasicType() != glslang::EbtBlock)
4782         return glslang::ElpNone;
4783 
4784     // has to be a uniform or buffer block or task in/out blocks
4785     if (type.getQualifier().storage != glslang::EvqUniform &&
4786         type.getQualifier().storage != glslang::EvqBuffer &&
4787         type.getQualifier().storage != glslang::EvqShared &&
4788         !type.getQualifier().isTaskMemory())
4789         return glslang::ElpNone;
4790 
4791     // return the layout to use
4792     switch (type.getQualifier().layoutPacking) {
4793     case glslang::ElpStd140:
4794     case glslang::ElpStd430:
4795     case glslang::ElpScalar:
4796         return type.getQualifier().layoutPacking;
4797     default:
4798         return glslang::ElpNone;
4799     }
4800 }
4801 
4802 // Given an array type, returns the integer stride required for that array
getArrayStride(const glslang::TType & arrayType,glslang::TLayoutPacking explicitLayout,glslang::TLayoutMatrix matrixLayout)4803 int TGlslangToSpvTraverser::getArrayStride(const glslang::TType& arrayType, glslang::TLayoutPacking explicitLayout,
4804     glslang::TLayoutMatrix matrixLayout)
4805 {
4806     int size;
4807     int stride;
4808     glslangIntermediate->getMemberAlignment(arrayType, size, stride, explicitLayout,
4809         matrixLayout == glslang::ElmRowMajor);
4810 
4811     return stride;
4812 }
4813 
4814 // Given a matrix type, or array (of array) of matrixes type, returns the integer stride required for that matrix
4815 // when used as a member of an interface block
getMatrixStride(const glslang::TType & matrixType,glslang::TLayoutPacking explicitLayout,glslang::TLayoutMatrix matrixLayout)4816 int TGlslangToSpvTraverser::getMatrixStride(const glslang::TType& matrixType, glslang::TLayoutPacking explicitLayout,
4817     glslang::TLayoutMatrix matrixLayout)
4818 {
4819     glslang::TType elementType;
4820     elementType.shallowCopy(matrixType);
4821     elementType.clearArraySizes();
4822 
4823     int size;
4824     int stride;
4825     glslangIntermediate->getMemberAlignment(elementType, size, stride, explicitLayout,
4826         matrixLayout == glslang::ElmRowMajor);
4827 
4828     return stride;
4829 }
4830 
4831 // Given a member type of a struct, realign the current offset for it, and compute
4832 // the next (not yet aligned) offset for the next member, which will get aligned
4833 // on the next call.
4834 // 'currentOffset' should be passed in already initialized, ready to modify, and reflecting
4835 // the migration of data from nextOffset -> currentOffset.  It should be -1 on the first call.
4836 // -1 means a non-forced member offset (no decoration needed).
updateMemberOffset(const glslang::TType & structType,const glslang::TType & memberType,int & currentOffset,int & nextOffset,glslang::TLayoutPacking explicitLayout,glslang::TLayoutMatrix matrixLayout)4837 void TGlslangToSpvTraverser::updateMemberOffset(const glslang::TType& structType, const glslang::TType& memberType,
4838     int& currentOffset, int& nextOffset, glslang::TLayoutPacking explicitLayout, glslang::TLayoutMatrix matrixLayout)
4839 {
4840     // this will get a positive value when deemed necessary
4841     nextOffset = -1;
4842 
4843     // override anything in currentOffset with user-set offset
4844     if (memberType.getQualifier().hasOffset())
4845         currentOffset = memberType.getQualifier().layoutOffset;
4846 
4847     // It could be that current linker usage in glslang updated all the layoutOffset,
4848     // in which case the following code does not matter.  But, that's not quite right
4849     // once cross-compilation unit GLSL validation is done, as the original user
4850     // settings are needed in layoutOffset, and then the following will come into play.
4851 
4852     if (explicitLayout == glslang::ElpNone) {
4853         if (! memberType.getQualifier().hasOffset())
4854             currentOffset = -1;
4855 
4856         return;
4857     }
4858 
4859     // Getting this far means we need explicit offsets
4860     if (currentOffset < 0)
4861         currentOffset = 0;
4862 
4863     // Now, currentOffset is valid (either 0, or from a previous nextOffset),
4864     // but possibly not yet correctly aligned.
4865 
4866     int memberSize;
4867     int dummyStride;
4868     int memberAlignment = glslangIntermediate->getMemberAlignment(memberType, memberSize, dummyStride, explicitLayout,
4869         matrixLayout == glslang::ElmRowMajor);
4870 
4871     // Adjust alignment for HLSL rules
4872     // TODO: make this consistent in early phases of code:
4873     //       adjusting this late means inconsistencies with earlier code, which for reflection is an issue
4874     // Until reflection is brought in sync with these adjustments, don't apply to $Global,
4875     // which is the most likely to rely on reflection, and least likely to rely implicit layouts
4876     if (glslangIntermediate->usingHlslOffsets() &&
4877         ! memberType.isArray() && memberType.isVector() && structType.getTypeName().compare("$Global") != 0) {
4878         int dummySize;
4879         int componentAlignment = glslangIntermediate->getBaseAlignmentScalar(memberType, dummySize);
4880         if (componentAlignment <= 4)
4881             memberAlignment = componentAlignment;
4882     }
4883 
4884     // Bump up to member alignment
4885     glslang::RoundToPow2(currentOffset, memberAlignment);
4886 
4887     // Bump up to vec4 if there is a bad straddle
4888     if (explicitLayout != glslang::ElpScalar && glslangIntermediate->improperStraddle(memberType, memberSize,
4889         currentOffset))
4890         glslang::RoundToPow2(currentOffset, 16);
4891 
4892     nextOffset = currentOffset + memberSize;
4893 }
4894 
declareUseOfStructMember(const glslang::TTypeList & members,int glslangMember)4895 void TGlslangToSpvTraverser::declareUseOfStructMember(const glslang::TTypeList& members, int glslangMember)
4896 {
4897     const glslang::TBuiltInVariable glslangBuiltIn = members[glslangMember].type->getQualifier().builtIn;
4898     switch (glslangBuiltIn)
4899     {
4900     case glslang::EbvPointSize:
4901 #ifndef GLSLANG_WEB
4902     case glslang::EbvClipDistance:
4903     case glslang::EbvCullDistance:
4904     case glslang::EbvViewportMaskNV:
4905     case glslang::EbvSecondaryPositionNV:
4906     case glslang::EbvSecondaryViewportMaskNV:
4907     case glslang::EbvPositionPerViewNV:
4908     case glslang::EbvViewportMaskPerViewNV:
4909     case glslang::EbvTaskCountNV:
4910     case glslang::EbvPrimitiveCountNV:
4911     case glslang::EbvPrimitiveIndicesNV:
4912     case glslang::EbvClipDistancePerViewNV:
4913     case glslang::EbvCullDistancePerViewNV:
4914     case glslang::EbvLayerPerViewNV:
4915     case glslang::EbvMeshViewCountNV:
4916     case glslang::EbvMeshViewIndicesNV:
4917 #endif
4918         // Generate the associated capability.  Delegate to TranslateBuiltInDecoration.
4919         // Alternately, we could just call this for any glslang built-in, since the
4920         // capability already guards against duplicates.
4921         TranslateBuiltInDecoration(glslangBuiltIn, false);
4922         break;
4923     default:
4924         // Capabilities were already generated when the struct was declared.
4925         break;
4926     }
4927 }
4928 
isShaderEntryPoint(const glslang::TIntermAggregate * node)4929 bool TGlslangToSpvTraverser::isShaderEntryPoint(const glslang::TIntermAggregate* node)
4930 {
4931     return node->getName().compare(glslangIntermediate->getEntryPointMangledName().c_str()) == 0;
4932 }
4933 
4934 // Does parameter need a place to keep writes, separate from the original?
4935 // Assumes called after originalParam(), which filters out block/buffer/opaque-based
4936 // qualifiers such that we should have only in/out/inout/constreadonly here.
writableParam(glslang::TStorageQualifier qualifier) const4937 bool TGlslangToSpvTraverser::writableParam(glslang::TStorageQualifier qualifier) const
4938 {
4939     assert(qualifier == glslang::EvqIn ||
4940            qualifier == glslang::EvqOut ||
4941            qualifier == glslang::EvqInOut ||
4942            qualifier == glslang::EvqUniform ||
4943            qualifier == glslang::EvqConstReadOnly);
4944     return qualifier != glslang::EvqConstReadOnly &&
4945            qualifier != glslang::EvqUniform;
4946 }
4947 
4948 // Is parameter pass-by-original?
originalParam(glslang::TStorageQualifier qualifier,const glslang::TType & paramType,bool implicitThisParam)4949 bool TGlslangToSpvTraverser::originalParam(glslang::TStorageQualifier qualifier, const glslang::TType& paramType,
4950                                            bool implicitThisParam)
4951 {
4952     if (implicitThisParam)                                                                     // implicit this
4953         return true;
4954     if (glslangIntermediate->getSource() == glslang::EShSourceHlsl)
4955         return paramType.getBasicType() == glslang::EbtBlock;
4956     return paramType.containsOpaque() ||                                                       // sampler, etc.
4957 #ifndef GLSLANG_WEB
4958            paramType.getQualifier().isSpirvByReference() ||                                    // spirv_by_reference
4959 #endif
4960            (paramType.getBasicType() == glslang::EbtBlock && qualifier == glslang::EvqBuffer); // SSBO
4961 }
4962 
4963 // Make all the functions, skeletally, without actually visiting their bodies.
makeFunctions(const glslang::TIntermSequence & glslFunctions)4964 void TGlslangToSpvTraverser::makeFunctions(const glslang::TIntermSequence& glslFunctions)
4965 {
4966     const auto getParamDecorations = [&](std::vector<spv::Decoration>& decorations, const glslang::TType& type,
4967         bool useVulkanMemoryModel) {
4968         spv::Decoration paramPrecision = TranslatePrecisionDecoration(type);
4969         if (paramPrecision != spv::NoPrecision)
4970             decorations.push_back(paramPrecision);
4971         TranslateMemoryDecoration(type.getQualifier(), decorations, useVulkanMemoryModel);
4972         if (type.isReference()) {
4973             // Original and non-writable params pass the pointer directly and
4974             // use restrict/aliased, others are stored to a pointer in Function
4975             // memory and use RestrictPointer/AliasedPointer.
4976             if (originalParam(type.getQualifier().storage, type, false) ||
4977                 !writableParam(type.getQualifier().storage)) {
4978                 decorations.push_back(type.getQualifier().isRestrict() ? spv::DecorationRestrict :
4979                                                                          spv::DecorationAliased);
4980             } else {
4981                 decorations.push_back(type.getQualifier().isRestrict() ? spv::DecorationRestrictPointerEXT :
4982                                                                          spv::DecorationAliasedPointerEXT);
4983             }
4984         }
4985     };
4986 
4987     for (int f = 0; f < (int)glslFunctions.size(); ++f) {
4988         glslang::TIntermAggregate* glslFunction = glslFunctions[f]->getAsAggregate();
4989         if (! glslFunction || glslFunction->getOp() != glslang::EOpFunction || isShaderEntryPoint(glslFunction))
4990             continue;
4991 
4992         // We're on a user function.  Set up the basic interface for the function now,
4993         // so that it's available to call.  Translating the body will happen later.
4994         //
4995         // Typically (except for a "const in" parameter), an address will be passed to the
4996         // function.  What it is an address of varies:
4997         //
4998         // - "in" parameters not marked as "const" can be written to without modifying the calling
4999         //   argument so that write needs to be to a copy, hence the address of a copy works.
5000         //
5001         // - "const in" parameters can just be the r-value, as no writes need occur.
5002         //
5003         // - "out" and "inout" arguments can't be done as pointers to the calling argument, because
5004         //   GLSL has copy-in/copy-out semantics.  They can be handled though with a pointer to a copy.
5005 
5006         std::vector<spv::Id> paramTypes;
5007         std::vector<std::vector<spv::Decoration>> paramDecorations; // list of decorations per parameter
5008         glslang::TIntermSequence& parameters = glslFunction->getSequence()[0]->getAsAggregate()->getSequence();
5009 
5010 #ifdef ENABLE_HLSL
5011         bool implicitThis = (int)parameters.size() > 0 && parameters[0]->getAsSymbolNode()->getName() ==
5012                                                           glslangIntermediate->implicitThisName;
5013 #else
5014         bool implicitThis = false;
5015 #endif
5016 
5017         paramDecorations.resize(parameters.size());
5018         for (int p = 0; p < (int)parameters.size(); ++p) {
5019             const glslang::TType& paramType = parameters[p]->getAsTyped()->getType();
5020             spv::Id typeId = convertGlslangToSpvType(paramType);
5021             if (originalParam(paramType.getQualifier().storage, paramType, implicitThis && p == 0))
5022                 typeId = builder.makePointer(TranslateStorageClass(paramType), typeId);
5023             else if (writableParam(paramType.getQualifier().storage))
5024                 typeId = builder.makePointer(spv::StorageClassFunction, typeId);
5025             else
5026                 rValueParameters.insert(parameters[p]->getAsSymbolNode()->getId());
5027             getParamDecorations(paramDecorations[p], paramType, glslangIntermediate->usingVulkanMemoryModel());
5028             paramTypes.push_back(typeId);
5029         }
5030 
5031         spv::Block* functionBlock;
5032         spv::Function *function = builder.makeFunctionEntry(TranslatePrecisionDecoration(glslFunction->getType()),
5033                                                             convertGlslangToSpvType(glslFunction->getType()),
5034                                                             glslFunction->getName().c_str(), paramTypes,
5035                                                             paramDecorations, &functionBlock);
5036         if (implicitThis)
5037             function->setImplicitThis();
5038 
5039         // Track function to emit/call later
5040         functionMap[glslFunction->getName().c_str()] = function;
5041 
5042         // Set the parameter id's
5043         for (int p = 0; p < (int)parameters.size(); ++p) {
5044             symbolValues[parameters[p]->getAsSymbolNode()->getId()] = function->getParamId(p);
5045             // give a name too
5046             builder.addName(function->getParamId(p), parameters[p]->getAsSymbolNode()->getName().c_str());
5047 
5048             const glslang::TType& paramType = parameters[p]->getAsTyped()->getType();
5049             if (paramType.contains8BitInt())
5050                 builder.addCapability(spv::CapabilityInt8);
5051             if (paramType.contains16BitInt())
5052                 builder.addCapability(spv::CapabilityInt16);
5053             if (paramType.contains16BitFloat())
5054                 builder.addCapability(spv::CapabilityFloat16);
5055         }
5056     }
5057 }
5058 
5059 // Process all the initializers, while skipping the functions and link objects
makeGlobalInitializers(const glslang::TIntermSequence & initializers)5060 void TGlslangToSpvTraverser::makeGlobalInitializers(const glslang::TIntermSequence& initializers)
5061 {
5062     builder.setBuildPoint(shaderEntry->getLastBlock());
5063     for (int i = 0; i < (int)initializers.size(); ++i) {
5064         glslang::TIntermAggregate* initializer = initializers[i]->getAsAggregate();
5065         if (initializer && initializer->getOp() != glslang::EOpFunction && initializer->getOp() !=
5066             glslang::EOpLinkerObjects) {
5067 
5068             // We're on a top-level node that's not a function.  Treat as an initializer, whose
5069             // code goes into the beginning of the entry point.
5070             initializer->traverse(this);
5071         }
5072     }
5073 }
5074 // Walk over all linker objects to create a map for payload and callable data linker objects
5075 // and their location to be used during codegen for OpTraceKHR and OpExecuteCallableKHR
5076 // This is done here since it is possible that these linker objects are not be referenced in the AST
collectRayTracingLinkerObjects()5077 void TGlslangToSpvTraverser::collectRayTracingLinkerObjects()
5078 {
5079     glslang::TIntermAggregate* linkerObjects = glslangIntermediate->findLinkerObjects();
5080     for (auto& objSeq : linkerObjects->getSequence()) {
5081         auto objNode = objSeq->getAsSymbolNode();
5082         if (objNode != nullptr) {
5083             if (objNode->getQualifier().hasLocation()) {
5084                 unsigned int location = objNode->getQualifier().layoutLocation;
5085                 auto st = objNode->getQualifier().storage;
5086                 int set;
5087                 switch (st)
5088                 {
5089                 case glslang::EvqPayload:
5090                 case glslang::EvqPayloadIn:
5091                     set = 0;
5092                     break;
5093                 case glslang::EvqCallableData:
5094                 case glslang::EvqCallableDataIn:
5095                     set = 1;
5096                     break;
5097 
5098                 default:
5099                     set = -1;
5100                 }
5101                 if (set != -1)
5102                     locationToSymbol[set].insert(std::make_pair(location, objNode));
5103             }
5104         }
5105     }
5106 }
5107 // Process all the functions, while skipping initializers.
visitFunctions(const glslang::TIntermSequence & glslFunctions)5108 void TGlslangToSpvTraverser::visitFunctions(const glslang::TIntermSequence& glslFunctions)
5109 {
5110     for (int f = 0; f < (int)glslFunctions.size(); ++f) {
5111         glslang::TIntermAggregate* node = glslFunctions[f]->getAsAggregate();
5112         if (node && (node->getOp() == glslang::EOpFunction || node->getOp() == glslang::EOpLinkerObjects))
5113             node->traverse(this);
5114     }
5115 }
5116 
handleFunctionEntry(const glslang::TIntermAggregate * node)5117 void TGlslangToSpvTraverser::handleFunctionEntry(const glslang::TIntermAggregate* node)
5118 {
5119     // SPIR-V functions should already be in the functionMap from the prepass
5120     // that called makeFunctions().
5121     currentFunction = functionMap[node->getName().c_str()];
5122     spv::Block* functionBlock = currentFunction->getEntryBlock();
5123     builder.setBuildPoint(functionBlock);
5124 }
5125 
translateArguments(const glslang::TIntermAggregate & node,std::vector<spv::Id> & arguments,spv::Builder::AccessChain::CoherentFlags & lvalueCoherentFlags)5126 void TGlslangToSpvTraverser::translateArguments(const glslang::TIntermAggregate& node, std::vector<spv::Id>& arguments,
5127     spv::Builder::AccessChain::CoherentFlags &lvalueCoherentFlags)
5128 {
5129     const glslang::TIntermSequence& glslangArguments = node.getSequence();
5130 
5131     glslang::TSampler sampler = {};
5132     bool cubeCompare = false;
5133 #ifndef GLSLANG_WEB
5134     bool f16ShadowCompare = false;
5135 #endif
5136     if (node.isTexture() || node.isImage()) {
5137         sampler = glslangArguments[0]->getAsTyped()->getType().getSampler();
5138         cubeCompare = sampler.dim == glslang::EsdCube && sampler.arrayed && sampler.shadow;
5139 #ifndef GLSLANG_WEB
5140         f16ShadowCompare = sampler.shadow &&
5141             glslangArguments[1]->getAsTyped()->getType().getBasicType() == glslang::EbtFloat16;
5142 #endif
5143     }
5144 
5145     for (int i = 0; i < (int)glslangArguments.size(); ++i) {
5146         builder.clearAccessChain();
5147         glslangArguments[i]->traverse(this);
5148 
5149 #ifndef GLSLANG_WEB
5150         // Special case l-value operands
5151         bool lvalue = false;
5152         switch (node.getOp()) {
5153         case glslang::EOpImageAtomicAdd:
5154         case glslang::EOpImageAtomicMin:
5155         case glslang::EOpImageAtomicMax:
5156         case glslang::EOpImageAtomicAnd:
5157         case glslang::EOpImageAtomicOr:
5158         case glslang::EOpImageAtomicXor:
5159         case glslang::EOpImageAtomicExchange:
5160         case glslang::EOpImageAtomicCompSwap:
5161         case glslang::EOpImageAtomicLoad:
5162         case glslang::EOpImageAtomicStore:
5163             if (i == 0)
5164                 lvalue = true;
5165             break;
5166         case glslang::EOpSparseImageLoad:
5167             if ((sampler.ms && i == 3) || (! sampler.ms && i == 2))
5168                 lvalue = true;
5169             break;
5170         case glslang::EOpSparseTexture:
5171             if (((cubeCompare || f16ShadowCompare) && i == 3) || (! (cubeCompare || f16ShadowCompare) && i == 2))
5172                 lvalue = true;
5173             break;
5174         case glslang::EOpSparseTextureClamp:
5175             if (((cubeCompare || f16ShadowCompare) && i == 4) || (! (cubeCompare || f16ShadowCompare) && i == 3))
5176                 lvalue = true;
5177             break;
5178         case glslang::EOpSparseTextureLod:
5179         case glslang::EOpSparseTextureOffset:
5180             if  ((f16ShadowCompare && i == 4) || (! f16ShadowCompare && i == 3))
5181                 lvalue = true;
5182             break;
5183         case glslang::EOpSparseTextureFetch:
5184             if ((sampler.dim != glslang::EsdRect && i == 3) || (sampler.dim == glslang::EsdRect && i == 2))
5185                 lvalue = true;
5186             break;
5187         case glslang::EOpSparseTextureFetchOffset:
5188             if ((sampler.dim != glslang::EsdRect && i == 4) || (sampler.dim == glslang::EsdRect && i == 3))
5189                 lvalue = true;
5190             break;
5191         case glslang::EOpSparseTextureLodOffset:
5192         case glslang::EOpSparseTextureGrad:
5193         case glslang::EOpSparseTextureOffsetClamp:
5194             if ((f16ShadowCompare && i == 5) || (! f16ShadowCompare && i == 4))
5195                 lvalue = true;
5196             break;
5197         case glslang::EOpSparseTextureGradOffset:
5198         case glslang::EOpSparseTextureGradClamp:
5199             if ((f16ShadowCompare && i == 6) || (! f16ShadowCompare && i == 5))
5200                 lvalue = true;
5201             break;
5202         case glslang::EOpSparseTextureGradOffsetClamp:
5203             if ((f16ShadowCompare && i == 7) || (! f16ShadowCompare && i == 6))
5204                 lvalue = true;
5205             break;
5206         case glslang::EOpSparseTextureGather:
5207             if ((sampler.shadow && i == 3) || (! sampler.shadow && i == 2))
5208                 lvalue = true;
5209             break;
5210         case glslang::EOpSparseTextureGatherOffset:
5211         case glslang::EOpSparseTextureGatherOffsets:
5212             if ((sampler.shadow && i == 4) || (! sampler.shadow && i == 3))
5213                 lvalue = true;
5214             break;
5215         case glslang::EOpSparseTextureGatherLod:
5216             if (i == 3)
5217                 lvalue = true;
5218             break;
5219         case glslang::EOpSparseTextureGatherLodOffset:
5220         case glslang::EOpSparseTextureGatherLodOffsets:
5221             if (i == 4)
5222                 lvalue = true;
5223             break;
5224         case glslang::EOpSparseImageLoadLod:
5225             if (i == 3)
5226                 lvalue = true;
5227             break;
5228         case glslang::EOpImageSampleFootprintNV:
5229             if (i == 4)
5230                 lvalue = true;
5231             break;
5232         case glslang::EOpImageSampleFootprintClampNV:
5233         case glslang::EOpImageSampleFootprintLodNV:
5234             if (i == 5)
5235                 lvalue = true;
5236             break;
5237         case glslang::EOpImageSampleFootprintGradNV:
5238             if (i == 6)
5239                 lvalue = true;
5240             break;
5241         case glslang::EOpImageSampleFootprintGradClampNV:
5242             if (i == 7)
5243                 lvalue = true;
5244             break;
5245         default:
5246             break;
5247         }
5248 
5249         if (lvalue) {
5250             spv::Id lvalue_id = builder.accessChainGetLValue();
5251             arguments.push_back(lvalue_id);
5252             lvalueCoherentFlags = builder.getAccessChain().coherentFlags;
5253             builder.addDecoration(lvalue_id, TranslateNonUniformDecoration(lvalueCoherentFlags));
5254             lvalueCoherentFlags |= TranslateCoherent(glslangArguments[i]->getAsTyped()->getType());
5255         } else
5256 #endif
5257             arguments.push_back(accessChainLoad(glslangArguments[i]->getAsTyped()->getType()));
5258     }
5259 }
5260 
translateArguments(glslang::TIntermUnary & node,std::vector<spv::Id> & arguments)5261 void TGlslangToSpvTraverser::translateArguments(glslang::TIntermUnary& node, std::vector<spv::Id>& arguments)
5262 {
5263     builder.clearAccessChain();
5264     node.getOperand()->traverse(this);
5265     arguments.push_back(accessChainLoad(node.getOperand()->getType()));
5266 }
5267 
createImageTextureFunctionCall(glslang::TIntermOperator * node)5268 spv::Id TGlslangToSpvTraverser::createImageTextureFunctionCall(glslang::TIntermOperator* node)
5269 {
5270     if (! node->isImage() && ! node->isTexture())
5271         return spv::NoResult;
5272 
5273     builder.setLine(node->getLoc().line, node->getLoc().getFilename());
5274 
5275     // Process a GLSL texturing op (will be SPV image)
5276 
5277     const glslang::TType &imageType = node->getAsAggregate()
5278                                         ? node->getAsAggregate()->getSequence()[0]->getAsTyped()->getType()
5279                                         : node->getAsUnaryNode()->getOperand()->getAsTyped()->getType();
5280     const glslang::TSampler sampler = imageType.getSampler();
5281 #ifdef GLSLANG_WEB
5282     const bool f16ShadowCompare = false;
5283 #else
5284     bool f16ShadowCompare = (sampler.shadow && node->getAsAggregate())
5285             ? node->getAsAggregate()->getSequence()[1]->getAsTyped()->getType().getBasicType() == glslang::EbtFloat16
5286             : false;
5287 #endif
5288 
5289     const auto signExtensionMask = [&]() {
5290         if (builder.getSpvVersion() >= spv::Spv_1_4) {
5291             if (sampler.type == glslang::EbtUint)
5292                 return spv::ImageOperandsZeroExtendMask;
5293             else if (sampler.type == glslang::EbtInt)
5294                 return spv::ImageOperandsSignExtendMask;
5295         }
5296         return spv::ImageOperandsMaskNone;
5297     };
5298 
5299     spv::Builder::AccessChain::CoherentFlags lvalueCoherentFlags;
5300 
5301     std::vector<spv::Id> arguments;
5302     if (node->getAsAggregate())
5303         translateArguments(*node->getAsAggregate(), arguments, lvalueCoherentFlags);
5304     else
5305         translateArguments(*node->getAsUnaryNode(), arguments);
5306     spv::Decoration precision = TranslatePrecisionDecoration(node->getType());
5307 
5308     spv::Builder::TextureParameters params = { };
5309     params.sampler = arguments[0];
5310 
5311     glslang::TCrackedTextureOp cracked;
5312     node->crackTexture(sampler, cracked);
5313 
5314     const bool isUnsignedResult = node->getType().getBasicType() == glslang::EbtUint;
5315 
5316     if (builder.isSampledImage(params.sampler) &&
5317         ((cracked.query && node->getOp() != glslang::EOpTextureQueryLod) || cracked.fragMask || cracked.fetch)) {
5318         params.sampler = builder.createUnaryOp(spv::OpImage, builder.getImageType(params.sampler), params.sampler);
5319         if (imageType.getQualifier().isNonUniform()) {
5320             builder.addDecoration(params.sampler, spv::DecorationNonUniformEXT);
5321         }
5322     }
5323     // Check for queries
5324     if (cracked.query) {
5325         switch (node->getOp()) {
5326         case glslang::EOpImageQuerySize:
5327         case glslang::EOpTextureQuerySize:
5328             if (arguments.size() > 1) {
5329                 params.lod = arguments[1];
5330                 return builder.createTextureQueryCall(spv::OpImageQuerySizeLod, params, isUnsignedResult);
5331             } else
5332                 return builder.createTextureQueryCall(spv::OpImageQuerySize, params, isUnsignedResult);
5333 #ifndef GLSLANG_WEB
5334         case glslang::EOpImageQuerySamples:
5335         case glslang::EOpTextureQuerySamples:
5336             return builder.createTextureQueryCall(spv::OpImageQuerySamples, params, isUnsignedResult);
5337         case glslang::EOpTextureQueryLod:
5338             params.coords = arguments[1];
5339             return builder.createTextureQueryCall(spv::OpImageQueryLod, params, isUnsignedResult);
5340         case glslang::EOpTextureQueryLevels:
5341             return builder.createTextureQueryCall(spv::OpImageQueryLevels, params, isUnsignedResult);
5342         case glslang::EOpSparseTexelsResident:
5343             return builder.createUnaryOp(spv::OpImageSparseTexelsResident, builder.makeBoolType(), arguments[0]);
5344 #endif
5345         default:
5346             assert(0);
5347             break;
5348         }
5349     }
5350 
5351     int components = node->getType().getVectorSize();
5352 
5353     if (node->getOp() == glslang::EOpImageLoad ||
5354         node->getOp() == glslang::EOpImageLoadLod ||
5355         node->getOp() == glslang::EOpTextureFetch ||
5356         node->getOp() == glslang::EOpTextureFetchOffset) {
5357         // These must produce 4 components, per SPIR-V spec.  We'll add a conversion constructor if needed.
5358         // This will only happen through the HLSL path for operator[], so we do not have to handle e.g.
5359         // the EOpTexture/Proj/Lod/etc family.  It would be harmless to do so, but would need more logic
5360         // here around e.g. which ones return scalars or other types.
5361         components = 4;
5362     }
5363 
5364     glslang::TType returnType(node->getType().getBasicType(), glslang::EvqTemporary, components);
5365 
5366     auto resultType = [&returnType,this]{ return convertGlslangToSpvType(returnType); };
5367 
5368     // Check for image functions other than queries
5369     if (node->isImage()) {
5370         std::vector<spv::IdImmediate> operands;
5371         auto opIt = arguments.begin();
5372         spv::IdImmediate image = { true, *(opIt++) };
5373         operands.push_back(image);
5374 
5375         // Handle subpass operations
5376         // TODO: GLSL should change to have the "MS" only on the type rather than the
5377         // built-in function.
5378         if (cracked.subpass) {
5379             // add on the (0,0) coordinate
5380             spv::Id zero = builder.makeIntConstant(0);
5381             std::vector<spv::Id> comps;
5382             comps.push_back(zero);
5383             comps.push_back(zero);
5384             spv::IdImmediate coord = { true,
5385                 builder.makeCompositeConstant(builder.makeVectorType(builder.makeIntType(32), 2), comps) };
5386             operands.push_back(coord);
5387             spv::IdImmediate imageOperands = { false, spv::ImageOperandsMaskNone };
5388             imageOperands.word = imageOperands.word | signExtensionMask();
5389             if (sampler.isMultiSample()) {
5390                 imageOperands.word = imageOperands.word | spv::ImageOperandsSampleMask;
5391             }
5392             if (imageOperands.word != spv::ImageOperandsMaskNone) {
5393                 operands.push_back(imageOperands);
5394                 if (sampler.isMultiSample()) {
5395                     spv::IdImmediate imageOperand = { true, *(opIt++) };
5396                     operands.push_back(imageOperand);
5397                 }
5398             }
5399             spv::Id result = builder.createOp(spv::OpImageRead, resultType(), operands);
5400             builder.setPrecision(result, precision);
5401             return result;
5402         }
5403 
5404         spv::IdImmediate coord = { true, *(opIt++) };
5405         operands.push_back(coord);
5406         if (node->getOp() == glslang::EOpImageLoad || node->getOp() == glslang::EOpImageLoadLod) {
5407             spv::ImageOperandsMask mask = spv::ImageOperandsMaskNone;
5408             if (sampler.isMultiSample()) {
5409                 mask = mask | spv::ImageOperandsSampleMask;
5410             }
5411             if (cracked.lod) {
5412                 builder.addExtension(spv::E_SPV_AMD_shader_image_load_store_lod);
5413                 builder.addCapability(spv::CapabilityImageReadWriteLodAMD);
5414                 mask = mask | spv::ImageOperandsLodMask;
5415             }
5416             mask = mask | TranslateImageOperands(TranslateCoherent(imageType));
5417             mask = (spv::ImageOperandsMask)(mask & ~spv::ImageOperandsMakeTexelAvailableKHRMask);
5418             mask = mask | signExtensionMask();
5419             if (mask != spv::ImageOperandsMaskNone) {
5420                 spv::IdImmediate imageOperands = { false, (unsigned int)mask };
5421                 operands.push_back(imageOperands);
5422             }
5423             if (mask & spv::ImageOperandsSampleMask) {
5424                 spv::IdImmediate imageOperand = { true, *opIt++ };
5425                 operands.push_back(imageOperand);
5426             }
5427             if (mask & spv::ImageOperandsLodMask) {
5428                 spv::IdImmediate imageOperand = { true, *opIt++ };
5429                 operands.push_back(imageOperand);
5430             }
5431             if (mask & spv::ImageOperandsMakeTexelVisibleKHRMask) {
5432                 spv::IdImmediate imageOperand = { true,
5433                                     builder.makeUintConstant(TranslateMemoryScope(TranslateCoherent(imageType))) };
5434                 operands.push_back(imageOperand);
5435             }
5436 
5437             if (builder.getImageTypeFormat(builder.getImageType(operands.front().word)) == spv::ImageFormatUnknown)
5438                 builder.addCapability(spv::CapabilityStorageImageReadWithoutFormat);
5439 
5440             std::vector<spv::Id> result(1, builder.createOp(spv::OpImageRead, resultType(), operands));
5441             builder.setPrecision(result[0], precision);
5442 
5443             // If needed, add a conversion constructor to the proper size.
5444             if (components != node->getType().getVectorSize())
5445                 result[0] = builder.createConstructor(precision, result, convertGlslangToSpvType(node->getType()));
5446 
5447             return result[0];
5448         } else if (node->getOp() == glslang::EOpImageStore || node->getOp() == glslang::EOpImageStoreLod) {
5449 
5450             // Push the texel value before the operands
5451             if (sampler.isMultiSample() || cracked.lod) {
5452                 spv::IdImmediate texel = { true, *(opIt + 1) };
5453                 operands.push_back(texel);
5454             } else {
5455                 spv::IdImmediate texel = { true, *opIt };
5456                 operands.push_back(texel);
5457             }
5458 
5459             spv::ImageOperandsMask mask = spv::ImageOperandsMaskNone;
5460             if (sampler.isMultiSample()) {
5461                 mask = mask | spv::ImageOperandsSampleMask;
5462             }
5463             if (cracked.lod) {
5464                 builder.addExtension(spv::E_SPV_AMD_shader_image_load_store_lod);
5465                 builder.addCapability(spv::CapabilityImageReadWriteLodAMD);
5466                 mask = mask | spv::ImageOperandsLodMask;
5467             }
5468             mask = mask | TranslateImageOperands(TranslateCoherent(imageType));
5469             mask = (spv::ImageOperandsMask)(mask & ~spv::ImageOperandsMakeTexelVisibleKHRMask);
5470             mask = mask | signExtensionMask();
5471             if (mask != spv::ImageOperandsMaskNone) {
5472                 spv::IdImmediate imageOperands = { false, (unsigned int)mask };
5473                 operands.push_back(imageOperands);
5474             }
5475             if (mask & spv::ImageOperandsSampleMask) {
5476                 spv::IdImmediate imageOperand = { true, *opIt++ };
5477                 operands.push_back(imageOperand);
5478             }
5479             if (mask & spv::ImageOperandsLodMask) {
5480                 spv::IdImmediate imageOperand = { true, *opIt++ };
5481                 operands.push_back(imageOperand);
5482             }
5483             if (mask & spv::ImageOperandsMakeTexelAvailableKHRMask) {
5484                 spv::IdImmediate imageOperand = { true,
5485                     builder.makeUintConstant(TranslateMemoryScope(TranslateCoherent(imageType))) };
5486                 operands.push_back(imageOperand);
5487             }
5488 
5489             builder.createNoResultOp(spv::OpImageWrite, operands);
5490             if (builder.getImageTypeFormat(builder.getImageType(operands.front().word)) == spv::ImageFormatUnknown)
5491                 builder.addCapability(spv::CapabilityStorageImageWriteWithoutFormat);
5492             return spv::NoResult;
5493         } else if (node->getOp() == glslang::EOpSparseImageLoad ||
5494                    node->getOp() == glslang::EOpSparseImageLoadLod) {
5495             builder.addCapability(spv::CapabilitySparseResidency);
5496             if (builder.getImageTypeFormat(builder.getImageType(operands.front().word)) == spv::ImageFormatUnknown)
5497                 builder.addCapability(spv::CapabilityStorageImageReadWithoutFormat);
5498 
5499             spv::ImageOperandsMask mask = spv::ImageOperandsMaskNone;
5500             if (sampler.isMultiSample()) {
5501                 mask = mask | spv::ImageOperandsSampleMask;
5502             }
5503             if (cracked.lod) {
5504                 builder.addExtension(spv::E_SPV_AMD_shader_image_load_store_lod);
5505                 builder.addCapability(spv::CapabilityImageReadWriteLodAMD);
5506 
5507                 mask = mask | spv::ImageOperandsLodMask;
5508             }
5509             mask = mask | TranslateImageOperands(TranslateCoherent(imageType));
5510             mask = (spv::ImageOperandsMask)(mask & ~spv::ImageOperandsMakeTexelAvailableKHRMask);
5511             mask = mask | signExtensionMask();
5512             if (mask != spv::ImageOperandsMaskNone) {
5513                 spv::IdImmediate imageOperands = { false, (unsigned int)mask };
5514                 operands.push_back(imageOperands);
5515             }
5516             if (mask & spv::ImageOperandsSampleMask) {
5517                 spv::IdImmediate imageOperand = { true, *opIt++ };
5518                 operands.push_back(imageOperand);
5519             }
5520             if (mask & spv::ImageOperandsLodMask) {
5521                 spv::IdImmediate imageOperand = { true, *opIt++ };
5522                 operands.push_back(imageOperand);
5523             }
5524             if (mask & spv::ImageOperandsMakeTexelVisibleKHRMask) {
5525                 spv::IdImmediate imageOperand = { true, builder.makeUintConstant(TranslateMemoryScope(
5526                     TranslateCoherent(imageType))) };
5527                 operands.push_back(imageOperand);
5528             }
5529 
5530             // Create the return type that was a special structure
5531             spv::Id texelOut = *opIt;
5532             spv::Id typeId0 = resultType();
5533             spv::Id typeId1 = builder.getDerefTypeId(texelOut);
5534             spv::Id resultTypeId = builder.makeStructResultType(typeId0, typeId1);
5535 
5536             spv::Id resultId = builder.createOp(spv::OpImageSparseRead, resultTypeId, operands);
5537 
5538             // Decode the return type
5539             builder.createStore(builder.createCompositeExtract(resultId, typeId1, 1), texelOut);
5540             return builder.createCompositeExtract(resultId, typeId0, 0);
5541         } else {
5542             // Process image atomic operations
5543 
5544             // GLSL "IMAGE_PARAMS" will involve in constructing an image texel pointer and this pointer,
5545             // as the first source operand, is required by SPIR-V atomic operations.
5546             // For non-MS, the sample value should be 0
5547             spv::IdImmediate sample = { true, sampler.isMultiSample() ? *(opIt++) : builder.makeUintConstant(0) };
5548             operands.push_back(sample);
5549 
5550             spv::Id resultTypeId;
5551             // imageAtomicStore has a void return type so base the pointer type on
5552             // the type of the value operand.
5553             if (node->getOp() == glslang::EOpImageAtomicStore) {
5554                 resultTypeId = builder.makePointer(spv::StorageClassImage, builder.getTypeId(*opIt));
5555             } else {
5556                 resultTypeId = builder.makePointer(spv::StorageClassImage, resultType());
5557             }
5558             spv::Id pointer = builder.createOp(spv::OpImageTexelPointer, resultTypeId, operands);
5559             if (imageType.getQualifier().nonUniform) {
5560                 builder.addDecoration(pointer, spv::DecorationNonUniformEXT);
5561             }
5562 
5563             std::vector<spv::Id> operands;
5564             operands.push_back(pointer);
5565             for (; opIt != arguments.end(); ++opIt)
5566                 operands.push_back(*opIt);
5567 
5568             return createAtomicOperation(node->getOp(), precision, resultType(), operands, node->getBasicType(),
5569                 lvalueCoherentFlags);
5570         }
5571     }
5572 
5573 #ifndef GLSLANG_WEB
5574     // Check for fragment mask functions other than queries
5575     if (cracked.fragMask) {
5576         assert(sampler.ms);
5577 
5578         auto opIt = arguments.begin();
5579         std::vector<spv::Id> operands;
5580 
5581         operands.push_back(params.sampler);
5582         ++opIt;
5583 
5584         if (sampler.isSubpass()) {
5585             // add on the (0,0) coordinate
5586             spv::Id zero = builder.makeIntConstant(0);
5587             std::vector<spv::Id> comps;
5588             comps.push_back(zero);
5589             comps.push_back(zero);
5590             operands.push_back(builder.makeCompositeConstant(
5591                 builder.makeVectorType(builder.makeIntType(32), 2), comps));
5592         }
5593 
5594         for (; opIt != arguments.end(); ++opIt)
5595             operands.push_back(*opIt);
5596 
5597         spv::Op fragMaskOp = spv::OpNop;
5598         if (node->getOp() == glslang::EOpFragmentMaskFetch)
5599             fragMaskOp = spv::OpFragmentMaskFetchAMD;
5600         else if (node->getOp() == glslang::EOpFragmentFetch)
5601             fragMaskOp = spv::OpFragmentFetchAMD;
5602 
5603         builder.addExtension(spv::E_SPV_AMD_shader_fragment_mask);
5604         builder.addCapability(spv::CapabilityFragmentMaskAMD);
5605         return builder.createOp(fragMaskOp, resultType(), operands);
5606     }
5607 #endif
5608 
5609     // Check for texture functions other than queries
5610     bool sparse = node->isSparseTexture();
5611     bool imageFootprint = node->isImageFootprint();
5612     bool cubeCompare = sampler.dim == glslang::EsdCube && sampler.isArrayed() && sampler.isShadow();
5613 
5614     // check for bias argument
5615     bool bias = false;
5616     if (! cracked.lod && ! cracked.grad && ! cracked.fetch && ! cubeCompare) {
5617         int nonBiasArgCount = 2;
5618         if (cracked.gather)
5619             ++nonBiasArgCount; // comp argument should be present when bias argument is present
5620 
5621         if (f16ShadowCompare)
5622             ++nonBiasArgCount;
5623         if (cracked.offset)
5624             ++nonBiasArgCount;
5625         else if (cracked.offsets)
5626             ++nonBiasArgCount;
5627         if (cracked.grad)
5628             nonBiasArgCount += 2;
5629         if (cracked.lodClamp)
5630             ++nonBiasArgCount;
5631         if (sparse)
5632             ++nonBiasArgCount;
5633         if (imageFootprint)
5634             //Following three extra arguments
5635             // int granularity, bool coarse, out gl_TextureFootprint2DNV footprint
5636             nonBiasArgCount += 3;
5637         if ((int)arguments.size() > nonBiasArgCount)
5638             bias = true;
5639     }
5640 
5641 #ifndef GLSLANG_WEB
5642     if (cracked.gather) {
5643         const auto& sourceExtensions = glslangIntermediate->getRequestedExtensions();
5644         if (bias || cracked.lod ||
5645             sourceExtensions.find(glslang::E_GL_AMD_texture_gather_bias_lod) != sourceExtensions.end()) {
5646             builder.addExtension(spv::E_SPV_AMD_texture_gather_bias_lod);
5647             builder.addCapability(spv::CapabilityImageGatherBiasLodAMD);
5648         }
5649     }
5650 #endif
5651 
5652     // set the rest of the arguments
5653 
5654     params.coords = arguments[1];
5655     int extraArgs = 0;
5656     bool noImplicitLod = false;
5657 
5658     // sort out where Dref is coming from
5659     if (cubeCompare || f16ShadowCompare) {
5660         params.Dref = arguments[2];
5661         ++extraArgs;
5662     } else if (sampler.shadow && cracked.gather) {
5663         params.Dref = arguments[2];
5664         ++extraArgs;
5665     } else if (sampler.shadow) {
5666         std::vector<spv::Id> indexes;
5667         int dRefComp;
5668         if (cracked.proj)
5669             dRefComp = 2;  // "The resulting 3rd component of P in the shadow forms is used as Dref"
5670         else
5671             dRefComp = builder.getNumComponents(params.coords) - 1;
5672         indexes.push_back(dRefComp);
5673         params.Dref = builder.createCompositeExtract(params.coords,
5674             builder.getScalarTypeId(builder.getTypeId(params.coords)), indexes);
5675     }
5676 
5677     // lod
5678     if (cracked.lod) {
5679         params.lod = arguments[2 + extraArgs];
5680         ++extraArgs;
5681     } else if (glslangIntermediate->getStage() != EShLangFragment &&
5682                !(glslangIntermediate->getStage() == EShLangCompute &&
5683                  glslangIntermediate->hasLayoutDerivativeModeNone())) {
5684         // we need to invent the default lod for an explicit lod instruction for a non-fragment stage
5685         noImplicitLod = true;
5686     }
5687 
5688     // multisample
5689     if (sampler.isMultiSample()) {
5690         params.sample = arguments[2 + extraArgs]; // For MS, "sample" should be specified
5691         ++extraArgs;
5692     }
5693 
5694     // gradient
5695     if (cracked.grad) {
5696         params.gradX = arguments[2 + extraArgs];
5697         params.gradY = arguments[3 + extraArgs];
5698         extraArgs += 2;
5699     }
5700 
5701     // offset and offsets
5702     if (cracked.offset) {
5703         params.offset = arguments[2 + extraArgs];
5704         ++extraArgs;
5705     } else if (cracked.offsets) {
5706         params.offsets = arguments[2 + extraArgs];
5707         ++extraArgs;
5708     }
5709 
5710 #ifndef GLSLANG_WEB
5711     // lod clamp
5712     if (cracked.lodClamp) {
5713         params.lodClamp = arguments[2 + extraArgs];
5714         ++extraArgs;
5715     }
5716     // sparse
5717     if (sparse) {
5718         params.texelOut = arguments[2 + extraArgs];
5719         ++extraArgs;
5720     }
5721     // gather component
5722     if (cracked.gather && ! sampler.shadow) {
5723         // default component is 0, if missing, otherwise an argument
5724         if (2 + extraArgs < (int)arguments.size()) {
5725             params.component = arguments[2 + extraArgs];
5726             ++extraArgs;
5727         } else
5728             params.component = builder.makeIntConstant(0);
5729     }
5730     spv::Id  resultStruct = spv::NoResult;
5731     if (imageFootprint) {
5732         //Following three extra arguments
5733         // int granularity, bool coarse, out gl_TextureFootprint2DNV footprint
5734         params.granularity = arguments[2 + extraArgs];
5735         params.coarse = arguments[3 + extraArgs];
5736         resultStruct = arguments[4 + extraArgs];
5737         extraArgs += 3;
5738     }
5739 #endif
5740     // bias
5741     if (bias) {
5742         params.bias = arguments[2 + extraArgs];
5743         ++extraArgs;
5744     }
5745 
5746 #ifndef GLSLANG_WEB
5747     if (imageFootprint) {
5748         builder.addExtension(spv::E_SPV_NV_shader_image_footprint);
5749         builder.addCapability(spv::CapabilityImageFootprintNV);
5750 
5751 
5752         //resultStructType(OpenGL type) contains 5 elements:
5753         //struct gl_TextureFootprint2DNV {
5754         //    uvec2 anchor;
5755         //    uvec2 offset;
5756         //    uvec2 mask;
5757         //    uint  lod;
5758         //    uint  granularity;
5759         //};
5760         //or
5761         //struct gl_TextureFootprint3DNV {
5762         //    uvec3 anchor;
5763         //    uvec3 offset;
5764         //    uvec2 mask;
5765         //    uint  lod;
5766         //    uint  granularity;
5767         //};
5768         spv::Id resultStructType = builder.getContainedTypeId(builder.getTypeId(resultStruct));
5769         assert(builder.isStructType(resultStructType));
5770 
5771         //resType (SPIR-V type) contains 6 elements:
5772         //Member 0 must be a Boolean type scalar(LOD),
5773         //Member 1 must be a vector of integer type, whose Signedness operand is 0(anchor),
5774         //Member 2 must be a vector of integer type, whose Signedness operand is 0(offset),
5775         //Member 3 must be a vector of integer type, whose Signedness operand is 0(mask),
5776         //Member 4 must be a scalar of integer type, whose Signedness operand is 0(lod),
5777         //Member 5 must be a scalar of integer type, whose Signedness operand is 0(granularity).
5778         std::vector<spv::Id> members;
5779         members.push_back(resultType());
5780         for (int i = 0; i < 5; i++) {
5781             members.push_back(builder.getContainedTypeId(resultStructType, i));
5782         }
5783         spv::Id resType = builder.makeStructType(members, "ResType");
5784 
5785         //call ImageFootprintNV
5786         spv::Id res = builder.createTextureCall(precision, resType, sparse, cracked.fetch, cracked.proj,
5787                                                 cracked.gather, noImplicitLod, params, signExtensionMask());
5788 
5789         //copy resType (SPIR-V type) to resultStructType(OpenGL type)
5790         for (int i = 0; i < 5; i++) {
5791             builder.clearAccessChain();
5792             builder.setAccessChainLValue(resultStruct);
5793 
5794             //Accessing to a struct we created, no coherent flag is set
5795             spv::Builder::AccessChain::CoherentFlags flags;
5796             flags.clear();
5797 
5798             builder.accessChainPush(builder.makeIntConstant(i), flags, 0);
5799             builder.accessChainStore(builder.createCompositeExtract(res, builder.getContainedTypeId(resType, i+1),
5800                 i+1), TranslateNonUniformDecoration(imageType.getQualifier()));
5801         }
5802         return builder.createCompositeExtract(res, resultType(), 0);
5803     }
5804 #endif
5805 
5806     // projective component (might not to move)
5807     // GLSL: "The texture coordinates consumed from P, not including the last component of P,
5808     //       are divided by the last component of P."
5809     // SPIR-V:  "... (u [, v] [, w], q)... It may be a vector larger than needed, but all
5810     //          unused components will appear after all used components."
5811     if (cracked.proj) {
5812         int projSourceComp = builder.getNumComponents(params.coords) - 1;
5813         int projTargetComp;
5814         switch (sampler.dim) {
5815         case glslang::Esd1D:   projTargetComp = 1;              break;
5816         case glslang::Esd2D:   projTargetComp = 2;              break;
5817         case glslang::EsdRect: projTargetComp = 2;              break;
5818         default:               projTargetComp = projSourceComp; break;
5819         }
5820         // copy the projective coordinate if we have to
5821         if (projTargetComp != projSourceComp) {
5822             spv::Id projComp = builder.createCompositeExtract(params.coords,
5823                                     builder.getScalarTypeId(builder.getTypeId(params.coords)), projSourceComp);
5824             params.coords = builder.createCompositeInsert(projComp, params.coords,
5825                                     builder.getTypeId(params.coords), projTargetComp);
5826         }
5827     }
5828 
5829 #ifndef GLSLANG_WEB
5830     // nonprivate
5831     if (imageType.getQualifier().nonprivate) {
5832         params.nonprivate = true;
5833     }
5834 
5835     // volatile
5836     if (imageType.getQualifier().volatil) {
5837         params.volatil = true;
5838     }
5839 #endif
5840 
5841     std::vector<spv::Id> result( 1,
5842         builder.createTextureCall(precision, resultType(), sparse, cracked.fetch, cracked.proj, cracked.gather,
5843                                   noImplicitLod, params, signExtensionMask())
5844     );
5845 
5846     if (components != node->getType().getVectorSize())
5847         result[0] = builder.createConstructor(precision, result, convertGlslangToSpvType(node->getType()));
5848 
5849     return result[0];
5850 }
5851 
handleUserFunctionCall(const glslang::TIntermAggregate * node)5852 spv::Id TGlslangToSpvTraverser::handleUserFunctionCall(const glslang::TIntermAggregate* node)
5853 {
5854     // Grab the function's pointer from the previously created function
5855     spv::Function* function = functionMap[node->getName().c_str()];
5856     if (! function)
5857         return 0;
5858 
5859     const glslang::TIntermSequence& glslangArgs = node->getSequence();
5860     const glslang::TQualifierList& qualifiers = node->getQualifierList();
5861 
5862     //  See comments in makeFunctions() for details about the semantics for parameter passing.
5863     //
5864     // These imply we need a four step process:
5865     // 1. Evaluate the arguments
5866     // 2. Allocate and make copies of in, out, and inout arguments
5867     // 3. Make the call
5868     // 4. Copy back the results
5869 
5870     // 1. Evaluate the arguments and their types
5871     std::vector<spv::Builder::AccessChain> lValues;
5872     std::vector<spv::Id> rValues;
5873     std::vector<const glslang::TType*> argTypes;
5874     for (int a = 0; a < (int)glslangArgs.size(); ++a) {
5875         argTypes.push_back(&glslangArgs[a]->getAsTyped()->getType());
5876         // build l-value
5877         builder.clearAccessChain();
5878         glslangArgs[a]->traverse(this);
5879         // keep outputs and pass-by-originals as l-values, evaluate others as r-values
5880         if (originalParam(qualifiers[a], *argTypes[a], function->hasImplicitThis() && a == 0) ||
5881             writableParam(qualifiers[a])) {
5882             // save l-value
5883             lValues.push_back(builder.getAccessChain());
5884         } else {
5885             // process r-value
5886             rValues.push_back(accessChainLoad(*argTypes.back()));
5887         }
5888     }
5889 
5890     // 2. Allocate space for anything needing a copy, and if it's "in" or "inout"
5891     // copy the original into that space.
5892     //
5893     // Also, build up the list of actual arguments to pass in for the call
5894     int lValueCount = 0;
5895     int rValueCount = 0;
5896     std::vector<spv::Id> spvArgs;
5897     for (int a = 0; a < (int)glslangArgs.size(); ++a) {
5898         spv::Id arg;
5899         if (originalParam(qualifiers[a], *argTypes[a], function->hasImplicitThis() && a == 0)) {
5900             builder.setAccessChain(lValues[lValueCount]);
5901             arg = builder.accessChainGetLValue();
5902             ++lValueCount;
5903         } else if (writableParam(qualifiers[a])) {
5904             // need space to hold the copy
5905             arg = builder.createVariable(function->getParamPrecision(a), spv::StorageClassFunction,
5906                 builder.getContainedTypeId(function->getParamType(a)), "param");
5907             if (qualifiers[a] == glslang::EvqIn || qualifiers[a] == glslang::EvqInOut) {
5908                 // need to copy the input into output space
5909                 builder.setAccessChain(lValues[lValueCount]);
5910                 spv::Id copy = accessChainLoad(*argTypes[a]);
5911                 builder.clearAccessChain();
5912                 builder.setAccessChainLValue(arg);
5913                 multiTypeStore(*argTypes[a], copy);
5914             }
5915             ++lValueCount;
5916         } else {
5917             // process r-value, which involves a copy for a type mismatch
5918             if (function->getParamType(a) != builder.getTypeId(rValues[rValueCount]) ||
5919                 TranslatePrecisionDecoration(*argTypes[a]) != function->getParamPrecision(a))
5920             {
5921                 spv::Id argCopy = builder.createVariable(function->getParamPrecision(a), spv::StorageClassFunction, function->getParamType(a), "arg");
5922                 builder.clearAccessChain();
5923                 builder.setAccessChainLValue(argCopy);
5924                 multiTypeStore(*argTypes[a], rValues[rValueCount]);
5925                 arg = builder.createLoad(argCopy, function->getParamPrecision(a));
5926             } else
5927                 arg = rValues[rValueCount];
5928             ++rValueCount;
5929         }
5930         spvArgs.push_back(arg);
5931     }
5932 
5933     // 3. Make the call.
5934     spv::Id result = builder.createFunctionCall(function, spvArgs);
5935     builder.setPrecision(result, TranslatePrecisionDecoration(node->getType()));
5936     builder.addDecoration(result, TranslateNonUniformDecoration(node->getType().getQualifier()));
5937 
5938     // 4. Copy back out an "out" arguments.
5939     lValueCount = 0;
5940     for (int a = 0; a < (int)glslangArgs.size(); ++a) {
5941         if (originalParam(qualifiers[a], *argTypes[a], function->hasImplicitThis() && a == 0))
5942             ++lValueCount;
5943         else if (writableParam(qualifiers[a])) {
5944             if (qualifiers[a] == glslang::EvqOut || qualifiers[a] == glslang::EvqInOut) {
5945                 spv::Id copy = builder.createLoad(spvArgs[a], spv::NoPrecision);
5946                 builder.addDecoration(copy, TranslateNonUniformDecoration(argTypes[a]->getQualifier()));
5947                 builder.setAccessChain(lValues[lValueCount]);
5948                 multiTypeStore(*argTypes[a], copy);
5949             }
5950             ++lValueCount;
5951         }
5952     }
5953 
5954     return result;
5955 }
5956 
5957 // Translate AST operation to SPV operation, already having SPV-based operands/types.
createBinaryOperation(glslang::TOperator op,OpDecorations & decorations,spv::Id typeId,spv::Id left,spv::Id right,glslang::TBasicType typeProxy,bool reduceComparison)5958 spv::Id TGlslangToSpvTraverser::createBinaryOperation(glslang::TOperator op, OpDecorations& decorations,
5959                                                       spv::Id typeId, spv::Id left, spv::Id right,
5960                                                       glslang::TBasicType typeProxy, bool reduceComparison)
5961 {
5962     bool isUnsigned = isTypeUnsignedInt(typeProxy);
5963     bool isFloat = isTypeFloat(typeProxy);
5964     bool isBool = typeProxy == glslang::EbtBool;
5965 
5966     spv::Op binOp = spv::OpNop;
5967     bool needMatchingVectors = true;  // for non-matrix ops, would a scalar need to smear to match a vector?
5968     bool comparison = false;
5969 
5970     switch (op) {
5971     case glslang::EOpAdd:
5972     case glslang::EOpAddAssign:
5973         if (isFloat)
5974             binOp = spv::OpFAdd;
5975         else
5976             binOp = spv::OpIAdd;
5977         break;
5978     case glslang::EOpSub:
5979     case glslang::EOpSubAssign:
5980         if (isFloat)
5981             binOp = spv::OpFSub;
5982         else
5983             binOp = spv::OpISub;
5984         break;
5985     case glslang::EOpMul:
5986     case glslang::EOpMulAssign:
5987         if (isFloat)
5988             binOp = spv::OpFMul;
5989         else
5990             binOp = spv::OpIMul;
5991         break;
5992     case glslang::EOpVectorTimesScalar:
5993     case glslang::EOpVectorTimesScalarAssign:
5994         if (isFloat && (builder.isVector(left) || builder.isVector(right))) {
5995             if (builder.isVector(right))
5996                 std::swap(left, right);
5997             assert(builder.isScalar(right));
5998             needMatchingVectors = false;
5999             binOp = spv::OpVectorTimesScalar;
6000         } else if (isFloat)
6001             binOp = spv::OpFMul;
6002           else
6003             binOp = spv::OpIMul;
6004         break;
6005     case glslang::EOpVectorTimesMatrix:
6006     case glslang::EOpVectorTimesMatrixAssign:
6007         binOp = spv::OpVectorTimesMatrix;
6008         break;
6009     case glslang::EOpMatrixTimesVector:
6010         binOp = spv::OpMatrixTimesVector;
6011         break;
6012     case glslang::EOpMatrixTimesScalar:
6013     case glslang::EOpMatrixTimesScalarAssign:
6014         binOp = spv::OpMatrixTimesScalar;
6015         break;
6016     case glslang::EOpMatrixTimesMatrix:
6017     case glslang::EOpMatrixTimesMatrixAssign:
6018         binOp = spv::OpMatrixTimesMatrix;
6019         break;
6020     case glslang::EOpOuterProduct:
6021         binOp = spv::OpOuterProduct;
6022         needMatchingVectors = false;
6023         break;
6024 
6025     case glslang::EOpDiv:
6026     case glslang::EOpDivAssign:
6027         if (isFloat)
6028             binOp = spv::OpFDiv;
6029         else if (isUnsigned)
6030             binOp = spv::OpUDiv;
6031         else
6032             binOp = spv::OpSDiv;
6033         break;
6034     case glslang::EOpMod:
6035     case glslang::EOpModAssign:
6036         if (isFloat)
6037             binOp = spv::OpFMod;
6038         else if (isUnsigned)
6039             binOp = spv::OpUMod;
6040         else
6041             binOp = spv::OpSMod;
6042         break;
6043     case glslang::EOpRightShift:
6044     case glslang::EOpRightShiftAssign:
6045         if (isUnsigned)
6046             binOp = spv::OpShiftRightLogical;
6047         else
6048             binOp = spv::OpShiftRightArithmetic;
6049         break;
6050     case glslang::EOpLeftShift:
6051     case glslang::EOpLeftShiftAssign:
6052         binOp = spv::OpShiftLeftLogical;
6053         break;
6054     case glslang::EOpAnd:
6055     case glslang::EOpAndAssign:
6056         binOp = spv::OpBitwiseAnd;
6057         break;
6058     case glslang::EOpLogicalAnd:
6059         needMatchingVectors = false;
6060         binOp = spv::OpLogicalAnd;
6061         break;
6062     case glslang::EOpInclusiveOr:
6063     case glslang::EOpInclusiveOrAssign:
6064         binOp = spv::OpBitwiseOr;
6065         break;
6066     case glslang::EOpLogicalOr:
6067         needMatchingVectors = false;
6068         binOp = spv::OpLogicalOr;
6069         break;
6070     case glslang::EOpExclusiveOr:
6071     case glslang::EOpExclusiveOrAssign:
6072         binOp = spv::OpBitwiseXor;
6073         break;
6074     case glslang::EOpLogicalXor:
6075         needMatchingVectors = false;
6076         binOp = spv::OpLogicalNotEqual;
6077         break;
6078 
6079     case glslang::EOpAbsDifference:
6080         binOp = isUnsigned ? spv::OpAbsUSubINTEL : spv::OpAbsISubINTEL;
6081         break;
6082 
6083     case glslang::EOpAddSaturate:
6084         binOp = isUnsigned ? spv::OpUAddSatINTEL : spv::OpIAddSatINTEL;
6085         break;
6086 
6087     case glslang::EOpSubSaturate:
6088         binOp = isUnsigned ? spv::OpUSubSatINTEL : spv::OpISubSatINTEL;
6089         break;
6090 
6091     case glslang::EOpAverage:
6092         binOp = isUnsigned ? spv::OpUAverageINTEL : spv::OpIAverageINTEL;
6093         break;
6094 
6095     case glslang::EOpAverageRounded:
6096         binOp = isUnsigned ? spv::OpUAverageRoundedINTEL : spv::OpIAverageRoundedINTEL;
6097         break;
6098 
6099     case glslang::EOpMul32x16:
6100         binOp = isUnsigned ? spv::OpUMul32x16INTEL : spv::OpIMul32x16INTEL;
6101         break;
6102 
6103     case glslang::EOpLessThan:
6104     case glslang::EOpGreaterThan:
6105     case glslang::EOpLessThanEqual:
6106     case glslang::EOpGreaterThanEqual:
6107     case glslang::EOpEqual:
6108     case glslang::EOpNotEqual:
6109     case glslang::EOpVectorEqual:
6110     case glslang::EOpVectorNotEqual:
6111         comparison = true;
6112         break;
6113     default:
6114         break;
6115     }
6116 
6117     // handle mapped binary operations (should be non-comparison)
6118     if (binOp != spv::OpNop) {
6119         assert(comparison == false);
6120         if (builder.isMatrix(left) || builder.isMatrix(right) ||
6121             builder.isCooperativeMatrix(left) || builder.isCooperativeMatrix(right))
6122             return createBinaryMatrixOperation(binOp, decorations, typeId, left, right);
6123 
6124         // No matrix involved; make both operands be the same number of components, if needed
6125         if (needMatchingVectors)
6126             builder.promoteScalar(decorations.precision, left, right);
6127 
6128         spv::Id result = builder.createBinOp(binOp, typeId, left, right);
6129         decorations.addNoContraction(builder, result);
6130         decorations.addNonUniform(builder, result);
6131         return builder.setPrecision(result, decorations.precision);
6132     }
6133 
6134     if (! comparison)
6135         return 0;
6136 
6137     // Handle comparison instructions
6138 
6139     if (reduceComparison && (op == glslang::EOpEqual || op == glslang::EOpNotEqual)
6140                          && (builder.isVector(left) || builder.isMatrix(left) || builder.isAggregate(left))) {
6141         spv::Id result = builder.createCompositeCompare(decorations.precision, left, right, op == glslang::EOpEqual);
6142         decorations.addNonUniform(builder, result);
6143         return result;
6144     }
6145 
6146     switch (op) {
6147     case glslang::EOpLessThan:
6148         if (isFloat)
6149             binOp = spv::OpFOrdLessThan;
6150         else if (isUnsigned)
6151             binOp = spv::OpULessThan;
6152         else
6153             binOp = spv::OpSLessThan;
6154         break;
6155     case glslang::EOpGreaterThan:
6156         if (isFloat)
6157             binOp = spv::OpFOrdGreaterThan;
6158         else if (isUnsigned)
6159             binOp = spv::OpUGreaterThan;
6160         else
6161             binOp = spv::OpSGreaterThan;
6162         break;
6163     case glslang::EOpLessThanEqual:
6164         if (isFloat)
6165             binOp = spv::OpFOrdLessThanEqual;
6166         else if (isUnsigned)
6167             binOp = spv::OpULessThanEqual;
6168         else
6169             binOp = spv::OpSLessThanEqual;
6170         break;
6171     case glslang::EOpGreaterThanEqual:
6172         if (isFloat)
6173             binOp = spv::OpFOrdGreaterThanEqual;
6174         else if (isUnsigned)
6175             binOp = spv::OpUGreaterThanEqual;
6176         else
6177             binOp = spv::OpSGreaterThanEqual;
6178         break;
6179     case glslang::EOpEqual:
6180     case glslang::EOpVectorEqual:
6181         if (isFloat)
6182             binOp = spv::OpFOrdEqual;
6183         else if (isBool)
6184             binOp = spv::OpLogicalEqual;
6185         else
6186             binOp = spv::OpIEqual;
6187         break;
6188     case glslang::EOpNotEqual:
6189     case glslang::EOpVectorNotEqual:
6190         if (isFloat)
6191             binOp = spv::OpFUnordNotEqual;
6192         else if (isBool)
6193             binOp = spv::OpLogicalNotEqual;
6194         else
6195             binOp = spv::OpINotEqual;
6196         break;
6197     default:
6198         break;
6199     }
6200 
6201     if (binOp != spv::OpNop) {
6202         spv::Id result = builder.createBinOp(binOp, typeId, left, right);
6203         decorations.addNoContraction(builder, result);
6204         decorations.addNonUniform(builder, result);
6205         return builder.setPrecision(result, decorations.precision);
6206     }
6207 
6208     return 0;
6209 }
6210 
6211 //
6212 // Translate AST matrix operation to SPV operation, already having SPV-based operands/types.
6213 // These can be any of:
6214 //
6215 //   matrix * scalar
6216 //   scalar * matrix
6217 //   matrix * matrix     linear algebraic
6218 //   matrix * vector
6219 //   vector * matrix
6220 //   matrix * matrix     componentwise
6221 //   matrix op matrix    op in {+, -, /}
6222 //   matrix op scalar    op in {+, -, /}
6223 //   scalar op matrix    op in {+, -, /}
6224 //
createBinaryMatrixOperation(spv::Op op,OpDecorations & decorations,spv::Id typeId,spv::Id left,spv::Id right)6225 spv::Id TGlslangToSpvTraverser::createBinaryMatrixOperation(spv::Op op, OpDecorations& decorations, spv::Id typeId,
6226                                                             spv::Id left, spv::Id right)
6227 {
6228     bool firstClass = true;
6229 
6230     // First, handle first-class matrix operations (* and matrix/scalar)
6231     switch (op) {
6232     case spv::OpFDiv:
6233         if (builder.isMatrix(left) && builder.isScalar(right)) {
6234             // turn matrix / scalar into a multiply...
6235             spv::Id resultType = builder.getTypeId(right);
6236             right = builder.createBinOp(spv::OpFDiv, resultType, builder.makeFpConstant(resultType, 1.0), right);
6237             op = spv::OpMatrixTimesScalar;
6238         } else
6239             firstClass = false;
6240         break;
6241     case spv::OpMatrixTimesScalar:
6242         if (builder.isMatrix(right) || builder.isCooperativeMatrix(right))
6243             std::swap(left, right);
6244         assert(builder.isScalar(right));
6245         break;
6246     case spv::OpVectorTimesMatrix:
6247         assert(builder.isVector(left));
6248         assert(builder.isMatrix(right));
6249         break;
6250     case spv::OpMatrixTimesVector:
6251         assert(builder.isMatrix(left));
6252         assert(builder.isVector(right));
6253         break;
6254     case spv::OpMatrixTimesMatrix:
6255         assert(builder.isMatrix(left));
6256         assert(builder.isMatrix(right));
6257         break;
6258     default:
6259         firstClass = false;
6260         break;
6261     }
6262 
6263     if (builder.isCooperativeMatrix(left) || builder.isCooperativeMatrix(right))
6264         firstClass = true;
6265 
6266     if (firstClass) {
6267         spv::Id result = builder.createBinOp(op, typeId, left, right);
6268         decorations.addNoContraction(builder, result);
6269         decorations.addNonUniform(builder, result);
6270         return builder.setPrecision(result, decorations.precision);
6271     }
6272 
6273     // Handle component-wise +, -, *, %, and / for all combinations of type.
6274     // The result type of all of them is the same type as the (a) matrix operand.
6275     // The algorithm is to:
6276     //   - break the matrix(es) into vectors
6277     //   - smear any scalar to a vector
6278     //   - do vector operations
6279     //   - make a matrix out the vector results
6280     switch (op) {
6281     case spv::OpFAdd:
6282     case spv::OpFSub:
6283     case spv::OpFDiv:
6284     case spv::OpFMod:
6285     case spv::OpFMul:
6286     {
6287         // one time set up...
6288         bool  leftMat = builder.isMatrix(left);
6289         bool rightMat = builder.isMatrix(right);
6290         unsigned int numCols = leftMat ? builder.getNumColumns(left) : builder.getNumColumns(right);
6291         int numRows = leftMat ? builder.getNumRows(left) : builder.getNumRows(right);
6292         spv::Id scalarType = builder.getScalarTypeId(typeId);
6293         spv::Id vecType = builder.makeVectorType(scalarType, numRows);
6294         std::vector<spv::Id> results;
6295         spv::Id smearVec = spv::NoResult;
6296         if (builder.isScalar(left))
6297             smearVec = builder.smearScalar(decorations.precision, left, vecType);
6298         else if (builder.isScalar(right))
6299             smearVec = builder.smearScalar(decorations.precision, right, vecType);
6300 
6301         // do each vector op
6302         for (unsigned int c = 0; c < numCols; ++c) {
6303             std::vector<unsigned int> indexes;
6304             indexes.push_back(c);
6305             spv::Id  leftVec =  leftMat ? builder.createCompositeExtract( left, vecType, indexes) : smearVec;
6306             spv::Id rightVec = rightMat ? builder.createCompositeExtract(right, vecType, indexes) : smearVec;
6307             spv::Id result = builder.createBinOp(op, vecType, leftVec, rightVec);
6308             decorations.addNoContraction(builder, result);
6309             decorations.addNonUniform(builder, result);
6310             results.push_back(builder.setPrecision(result, decorations.precision));
6311         }
6312 
6313         // put the pieces together
6314         spv::Id result = builder.setPrecision(builder.createCompositeConstruct(typeId, results), decorations.precision);
6315         decorations.addNonUniform(builder, result);
6316         return result;
6317     }
6318     default:
6319         assert(0);
6320         return spv::NoResult;
6321     }
6322 }
6323 
createUnaryOperation(glslang::TOperator op,OpDecorations & decorations,spv::Id typeId,spv::Id operand,glslang::TBasicType typeProxy,const spv::Builder::AccessChain::CoherentFlags & lvalueCoherentFlags)6324 spv::Id TGlslangToSpvTraverser::createUnaryOperation(glslang::TOperator op, OpDecorations& decorations, spv::Id typeId,
6325     spv::Id operand, glslang::TBasicType typeProxy, const spv::Builder::AccessChain::CoherentFlags &lvalueCoherentFlags)
6326 {
6327     spv::Op unaryOp = spv::OpNop;
6328     int extBuiltins = -1;
6329     int libCall = -1;
6330     bool isUnsigned = isTypeUnsignedInt(typeProxy);
6331     bool isFloat = isTypeFloat(typeProxy);
6332 
6333     switch (op) {
6334     case glslang::EOpNegative:
6335         if (isFloat) {
6336             unaryOp = spv::OpFNegate;
6337             if (builder.isMatrixType(typeId))
6338                 return createUnaryMatrixOperation(unaryOp, decorations, typeId, operand, typeProxy);
6339         } else
6340             unaryOp = spv::OpSNegate;
6341         break;
6342 
6343     case glslang::EOpLogicalNot:
6344     case glslang::EOpVectorLogicalNot:
6345         unaryOp = spv::OpLogicalNot;
6346         break;
6347     case glslang::EOpBitwiseNot:
6348         unaryOp = spv::OpNot;
6349         break;
6350 
6351     case glslang::EOpDeterminant:
6352         libCall = spv::GLSLstd450Determinant;
6353         break;
6354     case glslang::EOpMatrixInverse:
6355         libCall = spv::GLSLstd450MatrixInverse;
6356         break;
6357     case glslang::EOpTranspose:
6358         unaryOp = spv::OpTranspose;
6359         break;
6360 
6361     case glslang::EOpRadians:
6362         libCall = spv::GLSLstd450Radians;
6363         break;
6364     case glslang::EOpDegrees:
6365         libCall = spv::GLSLstd450Degrees;
6366         break;
6367     case glslang::EOpSin:
6368         libCall = spv::GLSLstd450Sin;
6369         break;
6370     case glslang::EOpCos:
6371         libCall = spv::GLSLstd450Cos;
6372         break;
6373     case glslang::EOpTan:
6374         libCall = spv::GLSLstd450Tan;
6375         break;
6376     case glslang::EOpAcos:
6377         libCall = spv::GLSLstd450Acos;
6378         break;
6379     case glslang::EOpAsin:
6380         libCall = spv::GLSLstd450Asin;
6381         break;
6382     case glslang::EOpAtan:
6383         libCall = spv::GLSLstd450Atan;
6384         break;
6385 
6386     case glslang::EOpAcosh:
6387         libCall = spv::GLSLstd450Acosh;
6388         break;
6389     case glslang::EOpAsinh:
6390         libCall = spv::GLSLstd450Asinh;
6391         break;
6392     case glslang::EOpAtanh:
6393         libCall = spv::GLSLstd450Atanh;
6394         break;
6395     case glslang::EOpTanh:
6396         libCall = spv::GLSLstd450Tanh;
6397         break;
6398     case glslang::EOpCosh:
6399         libCall = spv::GLSLstd450Cosh;
6400         break;
6401     case glslang::EOpSinh:
6402         libCall = spv::GLSLstd450Sinh;
6403         break;
6404 
6405     case glslang::EOpLength:
6406         libCall = spv::GLSLstd450Length;
6407         break;
6408     case glslang::EOpNormalize:
6409         libCall = spv::GLSLstd450Normalize;
6410         break;
6411 
6412     case glslang::EOpExp:
6413         libCall = spv::GLSLstd450Exp;
6414         break;
6415     case glslang::EOpLog:
6416         libCall = spv::GLSLstd450Log;
6417         break;
6418     case glslang::EOpExp2:
6419         libCall = spv::GLSLstd450Exp2;
6420         break;
6421     case glslang::EOpLog2:
6422         libCall = spv::GLSLstd450Log2;
6423         break;
6424     case glslang::EOpSqrt:
6425         libCall = spv::GLSLstd450Sqrt;
6426         break;
6427     case glslang::EOpInverseSqrt:
6428         libCall = spv::GLSLstd450InverseSqrt;
6429         break;
6430 
6431     case glslang::EOpFloor:
6432         libCall = spv::GLSLstd450Floor;
6433         break;
6434     case glslang::EOpTrunc:
6435         libCall = spv::GLSLstd450Trunc;
6436         break;
6437     case glslang::EOpRound:
6438         libCall = spv::GLSLstd450Round;
6439         break;
6440     case glslang::EOpRoundEven:
6441         libCall = spv::GLSLstd450RoundEven;
6442         break;
6443     case glslang::EOpCeil:
6444         libCall = spv::GLSLstd450Ceil;
6445         break;
6446     case glslang::EOpFract:
6447         libCall = spv::GLSLstd450Fract;
6448         break;
6449 
6450     case glslang::EOpIsNan:
6451         unaryOp = spv::OpIsNan;
6452         break;
6453     case glslang::EOpIsInf:
6454         unaryOp = spv::OpIsInf;
6455         break;
6456     case glslang::EOpIsFinite:
6457         unaryOp = spv::OpIsFinite;
6458         break;
6459 
6460     case glslang::EOpFloatBitsToInt:
6461     case glslang::EOpFloatBitsToUint:
6462     case glslang::EOpIntBitsToFloat:
6463     case glslang::EOpUintBitsToFloat:
6464     case glslang::EOpDoubleBitsToInt64:
6465     case glslang::EOpDoubleBitsToUint64:
6466     case glslang::EOpInt64BitsToDouble:
6467     case glslang::EOpUint64BitsToDouble:
6468     case glslang::EOpFloat16BitsToInt16:
6469     case glslang::EOpFloat16BitsToUint16:
6470     case glslang::EOpInt16BitsToFloat16:
6471     case glslang::EOpUint16BitsToFloat16:
6472         unaryOp = spv::OpBitcast;
6473         break;
6474 
6475     case glslang::EOpPackSnorm2x16:
6476         libCall = spv::GLSLstd450PackSnorm2x16;
6477         break;
6478     case glslang::EOpUnpackSnorm2x16:
6479         libCall = spv::GLSLstd450UnpackSnorm2x16;
6480         break;
6481     case glslang::EOpPackUnorm2x16:
6482         libCall = spv::GLSLstd450PackUnorm2x16;
6483         break;
6484     case glslang::EOpUnpackUnorm2x16:
6485         libCall = spv::GLSLstd450UnpackUnorm2x16;
6486         break;
6487     case glslang::EOpPackHalf2x16:
6488         libCall = spv::GLSLstd450PackHalf2x16;
6489         break;
6490     case glslang::EOpUnpackHalf2x16:
6491         libCall = spv::GLSLstd450UnpackHalf2x16;
6492         break;
6493 #ifndef GLSLANG_WEB
6494     case glslang::EOpPackSnorm4x8:
6495         libCall = spv::GLSLstd450PackSnorm4x8;
6496         break;
6497     case glslang::EOpUnpackSnorm4x8:
6498         libCall = spv::GLSLstd450UnpackSnorm4x8;
6499         break;
6500     case glslang::EOpPackUnorm4x8:
6501         libCall = spv::GLSLstd450PackUnorm4x8;
6502         break;
6503     case glslang::EOpUnpackUnorm4x8:
6504         libCall = spv::GLSLstd450UnpackUnorm4x8;
6505         break;
6506     case glslang::EOpPackDouble2x32:
6507         libCall = spv::GLSLstd450PackDouble2x32;
6508         break;
6509     case glslang::EOpUnpackDouble2x32:
6510         libCall = spv::GLSLstd450UnpackDouble2x32;
6511         break;
6512 #endif
6513 
6514     case glslang::EOpPackInt2x32:
6515     case glslang::EOpUnpackInt2x32:
6516     case glslang::EOpPackUint2x32:
6517     case glslang::EOpUnpackUint2x32:
6518     case glslang::EOpPack16:
6519     case glslang::EOpPack32:
6520     case glslang::EOpPack64:
6521     case glslang::EOpUnpack32:
6522     case glslang::EOpUnpack16:
6523     case glslang::EOpUnpack8:
6524     case glslang::EOpPackInt2x16:
6525     case glslang::EOpUnpackInt2x16:
6526     case glslang::EOpPackUint2x16:
6527     case glslang::EOpUnpackUint2x16:
6528     case glslang::EOpPackInt4x16:
6529     case glslang::EOpUnpackInt4x16:
6530     case glslang::EOpPackUint4x16:
6531     case glslang::EOpUnpackUint4x16:
6532     case glslang::EOpPackFloat2x16:
6533     case glslang::EOpUnpackFloat2x16:
6534         unaryOp = spv::OpBitcast;
6535         break;
6536 
6537     case glslang::EOpDPdx:
6538         unaryOp = spv::OpDPdx;
6539         break;
6540     case glslang::EOpDPdy:
6541         unaryOp = spv::OpDPdy;
6542         break;
6543     case glslang::EOpFwidth:
6544         unaryOp = spv::OpFwidth;
6545         break;
6546 
6547     case glslang::EOpAny:
6548         unaryOp = spv::OpAny;
6549         break;
6550     case glslang::EOpAll:
6551         unaryOp = spv::OpAll;
6552         break;
6553 
6554     case glslang::EOpAbs:
6555         if (isFloat)
6556             libCall = spv::GLSLstd450FAbs;
6557         else
6558             libCall = spv::GLSLstd450SAbs;
6559         break;
6560     case glslang::EOpSign:
6561         if (isFloat)
6562             libCall = spv::GLSLstd450FSign;
6563         else
6564             libCall = spv::GLSLstd450SSign;
6565         break;
6566 
6567 #ifndef GLSLANG_WEB
6568     case glslang::EOpDPdxFine:
6569         unaryOp = spv::OpDPdxFine;
6570         break;
6571     case glslang::EOpDPdyFine:
6572         unaryOp = spv::OpDPdyFine;
6573         break;
6574     case glslang::EOpFwidthFine:
6575         unaryOp = spv::OpFwidthFine;
6576         break;
6577     case glslang::EOpDPdxCoarse:
6578         unaryOp = spv::OpDPdxCoarse;
6579         break;
6580     case glslang::EOpDPdyCoarse:
6581         unaryOp = spv::OpDPdyCoarse;
6582         break;
6583     case glslang::EOpFwidthCoarse:
6584         unaryOp = spv::OpFwidthCoarse;
6585         break;
6586     case glslang::EOpRayQueryProceed:
6587         unaryOp = spv::OpRayQueryProceedKHR;
6588         break;
6589     case glslang::EOpRayQueryGetRayTMin:
6590         unaryOp = spv::OpRayQueryGetRayTMinKHR;
6591         break;
6592     case glslang::EOpRayQueryGetRayFlags:
6593         unaryOp = spv::OpRayQueryGetRayFlagsKHR;
6594         break;
6595     case glslang::EOpRayQueryGetWorldRayOrigin:
6596         unaryOp = spv::OpRayQueryGetWorldRayOriginKHR;
6597         break;
6598     case glslang::EOpRayQueryGetWorldRayDirection:
6599         unaryOp = spv::OpRayQueryGetWorldRayDirectionKHR;
6600         break;
6601     case glslang::EOpRayQueryGetIntersectionCandidateAABBOpaque:
6602         unaryOp = spv::OpRayQueryGetIntersectionCandidateAABBOpaqueKHR;
6603         break;
6604     case glslang::EOpInterpolateAtCentroid:
6605         if (typeProxy == glslang::EbtFloat16)
6606             builder.addExtension(spv::E_SPV_AMD_gpu_shader_half_float);
6607         libCall = spv::GLSLstd450InterpolateAtCentroid;
6608         break;
6609     case glslang::EOpAtomicCounterIncrement:
6610     case glslang::EOpAtomicCounterDecrement:
6611     case glslang::EOpAtomicCounter:
6612     {
6613         // Handle all of the atomics in one place, in createAtomicOperation()
6614         std::vector<spv::Id> operands;
6615         operands.push_back(operand);
6616         return createAtomicOperation(op, decorations.precision, typeId, operands, typeProxy, lvalueCoherentFlags);
6617     }
6618 
6619     case glslang::EOpBitFieldReverse:
6620         unaryOp = spv::OpBitReverse;
6621         break;
6622     case glslang::EOpBitCount:
6623         unaryOp = spv::OpBitCount;
6624         break;
6625     case glslang::EOpFindLSB:
6626         libCall = spv::GLSLstd450FindILsb;
6627         break;
6628     case glslang::EOpFindMSB:
6629         if (isUnsigned)
6630             libCall = spv::GLSLstd450FindUMsb;
6631         else
6632             libCall = spv::GLSLstd450FindSMsb;
6633         break;
6634 
6635     case glslang::EOpCountLeadingZeros:
6636         builder.addCapability(spv::CapabilityIntegerFunctions2INTEL);
6637         builder.addExtension("SPV_INTEL_shader_integer_functions2");
6638         unaryOp = spv::OpUCountLeadingZerosINTEL;
6639         break;
6640 
6641     case glslang::EOpCountTrailingZeros:
6642         builder.addCapability(spv::CapabilityIntegerFunctions2INTEL);
6643         builder.addExtension("SPV_INTEL_shader_integer_functions2");
6644         unaryOp = spv::OpUCountTrailingZerosINTEL;
6645         break;
6646 
6647     case glslang::EOpBallot:
6648     case glslang::EOpReadFirstInvocation:
6649     case glslang::EOpAnyInvocation:
6650     case glslang::EOpAllInvocations:
6651     case glslang::EOpAllInvocationsEqual:
6652     case glslang::EOpMinInvocations:
6653     case glslang::EOpMaxInvocations:
6654     case glslang::EOpAddInvocations:
6655     case glslang::EOpMinInvocationsNonUniform:
6656     case glslang::EOpMaxInvocationsNonUniform:
6657     case glslang::EOpAddInvocationsNonUniform:
6658     case glslang::EOpMinInvocationsInclusiveScan:
6659     case glslang::EOpMaxInvocationsInclusiveScan:
6660     case glslang::EOpAddInvocationsInclusiveScan:
6661     case glslang::EOpMinInvocationsInclusiveScanNonUniform:
6662     case glslang::EOpMaxInvocationsInclusiveScanNonUniform:
6663     case glslang::EOpAddInvocationsInclusiveScanNonUniform:
6664     case glslang::EOpMinInvocationsExclusiveScan:
6665     case glslang::EOpMaxInvocationsExclusiveScan:
6666     case glslang::EOpAddInvocationsExclusiveScan:
6667     case glslang::EOpMinInvocationsExclusiveScanNonUniform:
6668     case glslang::EOpMaxInvocationsExclusiveScanNonUniform:
6669     case glslang::EOpAddInvocationsExclusiveScanNonUniform:
6670     {
6671         std::vector<spv::Id> operands;
6672         operands.push_back(operand);
6673         return createInvocationsOperation(op, typeId, operands, typeProxy);
6674     }
6675     case glslang::EOpSubgroupAll:
6676     case glslang::EOpSubgroupAny:
6677     case glslang::EOpSubgroupAllEqual:
6678     case glslang::EOpSubgroupBroadcastFirst:
6679     case glslang::EOpSubgroupBallot:
6680     case glslang::EOpSubgroupInverseBallot:
6681     case glslang::EOpSubgroupBallotBitCount:
6682     case glslang::EOpSubgroupBallotInclusiveBitCount:
6683     case glslang::EOpSubgroupBallotExclusiveBitCount:
6684     case glslang::EOpSubgroupBallotFindLSB:
6685     case glslang::EOpSubgroupBallotFindMSB:
6686     case glslang::EOpSubgroupAdd:
6687     case glslang::EOpSubgroupMul:
6688     case glslang::EOpSubgroupMin:
6689     case glslang::EOpSubgroupMax:
6690     case glslang::EOpSubgroupAnd:
6691     case glslang::EOpSubgroupOr:
6692     case glslang::EOpSubgroupXor:
6693     case glslang::EOpSubgroupInclusiveAdd:
6694     case glslang::EOpSubgroupInclusiveMul:
6695     case glslang::EOpSubgroupInclusiveMin:
6696     case glslang::EOpSubgroupInclusiveMax:
6697     case glslang::EOpSubgroupInclusiveAnd:
6698     case glslang::EOpSubgroupInclusiveOr:
6699     case glslang::EOpSubgroupInclusiveXor:
6700     case glslang::EOpSubgroupExclusiveAdd:
6701     case glslang::EOpSubgroupExclusiveMul:
6702     case glslang::EOpSubgroupExclusiveMin:
6703     case glslang::EOpSubgroupExclusiveMax:
6704     case glslang::EOpSubgroupExclusiveAnd:
6705     case glslang::EOpSubgroupExclusiveOr:
6706     case glslang::EOpSubgroupExclusiveXor:
6707     case glslang::EOpSubgroupQuadSwapHorizontal:
6708     case glslang::EOpSubgroupQuadSwapVertical:
6709     case glslang::EOpSubgroupQuadSwapDiagonal: {
6710         std::vector<spv::Id> operands;
6711         operands.push_back(operand);
6712         return createSubgroupOperation(op, typeId, operands, typeProxy);
6713     }
6714     case glslang::EOpMbcnt:
6715         extBuiltins = getExtBuiltins(spv::E_SPV_AMD_shader_ballot);
6716         libCall = spv::MbcntAMD;
6717         break;
6718 
6719     case glslang::EOpCubeFaceIndex:
6720         extBuiltins = getExtBuiltins(spv::E_SPV_AMD_gcn_shader);
6721         libCall = spv::CubeFaceIndexAMD;
6722         break;
6723 
6724     case glslang::EOpCubeFaceCoord:
6725         extBuiltins = getExtBuiltins(spv::E_SPV_AMD_gcn_shader);
6726         libCall = spv::CubeFaceCoordAMD;
6727         break;
6728     case glslang::EOpSubgroupPartition:
6729         unaryOp = spv::OpGroupNonUniformPartitionNV;
6730         break;
6731     case glslang::EOpConstructReference:
6732         unaryOp = spv::OpBitcast;
6733         break;
6734 
6735     case glslang::EOpConvUint64ToAccStruct:
6736     case glslang::EOpConvUvec2ToAccStruct:
6737         unaryOp = spv::OpConvertUToAccelerationStructureKHR;
6738         break;
6739 #endif
6740 
6741     case glslang::EOpCopyObject:
6742         unaryOp = spv::OpCopyObject;
6743         break;
6744 
6745     default:
6746         return 0;
6747     }
6748 
6749     spv::Id id;
6750     if (libCall >= 0) {
6751         std::vector<spv::Id> args;
6752         args.push_back(operand);
6753         id = builder.createBuiltinCall(typeId, extBuiltins >= 0 ? extBuiltins : stdBuiltins, libCall, args);
6754     } else {
6755         id = builder.createUnaryOp(unaryOp, typeId, operand);
6756     }
6757 
6758     decorations.addNoContraction(builder, id);
6759     decorations.addNonUniform(builder, id);
6760     return builder.setPrecision(id, decorations.precision);
6761 }
6762 
6763 // Create a unary operation on a matrix
createUnaryMatrixOperation(spv::Op op,OpDecorations & decorations,spv::Id typeId,spv::Id operand,glslang::TBasicType)6764 spv::Id TGlslangToSpvTraverser::createUnaryMatrixOperation(spv::Op op, OpDecorations& decorations, spv::Id typeId,
6765                                                            spv::Id operand, glslang::TBasicType /* typeProxy */)
6766 {
6767     // Handle unary operations vector by vector.
6768     // The result type is the same type as the original type.
6769     // The algorithm is to:
6770     //   - break the matrix into vectors
6771     //   - apply the operation to each vector
6772     //   - make a matrix out the vector results
6773 
6774     // get the types sorted out
6775     int numCols = builder.getNumColumns(operand);
6776     int numRows = builder.getNumRows(operand);
6777     spv::Id srcVecType  = builder.makeVectorType(builder.getScalarTypeId(builder.getTypeId(operand)), numRows);
6778     spv::Id destVecType = builder.makeVectorType(builder.getScalarTypeId(typeId), numRows);
6779     std::vector<spv::Id> results;
6780 
6781     // do each vector op
6782     for (int c = 0; c < numCols; ++c) {
6783         std::vector<unsigned int> indexes;
6784         indexes.push_back(c);
6785         spv::Id srcVec  = builder.createCompositeExtract(operand, srcVecType, indexes);
6786         spv::Id destVec = builder.createUnaryOp(op, destVecType, srcVec);
6787         decorations.addNoContraction(builder, destVec);
6788         decorations.addNonUniform(builder, destVec);
6789         results.push_back(builder.setPrecision(destVec, decorations.precision));
6790     }
6791 
6792     // put the pieces together
6793     spv::Id result = builder.setPrecision(builder.createCompositeConstruct(typeId, results), decorations.precision);
6794     decorations.addNonUniform(builder, result);
6795     return result;
6796 }
6797 
6798 // For converting integers where both the bitwidth and the signedness could
6799 // change, but only do the width change here. The caller is still responsible
6800 // for the signedness conversion.
createIntWidthConversion(glslang::TOperator op,spv::Id operand,int vectorSize)6801 spv::Id TGlslangToSpvTraverser::createIntWidthConversion(glslang::TOperator op, spv::Id operand, int vectorSize)
6802 {
6803     // Get the result type width, based on the type to convert to.
6804     int width = 32;
6805     switch(op) {
6806     case glslang::EOpConvInt16ToUint8:
6807     case glslang::EOpConvIntToUint8:
6808     case glslang::EOpConvInt64ToUint8:
6809     case glslang::EOpConvUint16ToInt8:
6810     case glslang::EOpConvUintToInt8:
6811     case glslang::EOpConvUint64ToInt8:
6812         width = 8;
6813         break;
6814     case glslang::EOpConvInt8ToUint16:
6815     case glslang::EOpConvIntToUint16:
6816     case glslang::EOpConvInt64ToUint16:
6817     case glslang::EOpConvUint8ToInt16:
6818     case glslang::EOpConvUintToInt16:
6819     case glslang::EOpConvUint64ToInt16:
6820         width = 16;
6821         break;
6822     case glslang::EOpConvInt8ToUint:
6823     case glslang::EOpConvInt16ToUint:
6824     case glslang::EOpConvInt64ToUint:
6825     case glslang::EOpConvUint8ToInt:
6826     case glslang::EOpConvUint16ToInt:
6827     case glslang::EOpConvUint64ToInt:
6828         width = 32;
6829         break;
6830     case glslang::EOpConvInt8ToUint64:
6831     case glslang::EOpConvInt16ToUint64:
6832     case glslang::EOpConvIntToUint64:
6833     case glslang::EOpConvUint8ToInt64:
6834     case glslang::EOpConvUint16ToInt64:
6835     case glslang::EOpConvUintToInt64:
6836         width = 64;
6837         break;
6838 
6839     default:
6840         assert(false && "Default missing");
6841         break;
6842     }
6843 
6844     // Get the conversion operation and result type,
6845     // based on the target width, but the source type.
6846     spv::Id type = spv::NoType;
6847     spv::Op convOp = spv::OpNop;
6848     switch(op) {
6849     case glslang::EOpConvInt8ToUint16:
6850     case glslang::EOpConvInt8ToUint:
6851     case glslang::EOpConvInt8ToUint64:
6852     case glslang::EOpConvInt16ToUint8:
6853     case glslang::EOpConvInt16ToUint:
6854     case glslang::EOpConvInt16ToUint64:
6855     case glslang::EOpConvIntToUint8:
6856     case glslang::EOpConvIntToUint16:
6857     case glslang::EOpConvIntToUint64:
6858     case glslang::EOpConvInt64ToUint8:
6859     case glslang::EOpConvInt64ToUint16:
6860     case glslang::EOpConvInt64ToUint:
6861         convOp = spv::OpSConvert;
6862         type = builder.makeIntType(width);
6863         break;
6864     default:
6865         convOp = spv::OpUConvert;
6866         type = builder.makeUintType(width);
6867         break;
6868     }
6869 
6870     if (vectorSize > 0)
6871         type = builder.makeVectorType(type, vectorSize);
6872 
6873     return builder.createUnaryOp(convOp, type, operand);
6874 }
6875 
createConversion(glslang::TOperator op,OpDecorations & decorations,spv::Id destType,spv::Id operand,glslang::TBasicType typeProxy)6876 spv::Id TGlslangToSpvTraverser::createConversion(glslang::TOperator op, OpDecorations& decorations, spv::Id destType,
6877                                                  spv::Id operand, glslang::TBasicType typeProxy)
6878 {
6879     spv::Op convOp = spv::OpNop;
6880     spv::Id zero = 0;
6881     spv::Id one = 0;
6882 
6883     int vectorSize = builder.isVectorType(destType) ? builder.getNumTypeComponents(destType) : 0;
6884 
6885     switch (op) {
6886     case glslang::EOpConvIntToBool:
6887     case glslang::EOpConvUintToBool:
6888         zero = builder.makeUintConstant(0);
6889         zero = makeSmearedConstant(zero, vectorSize);
6890         return builder.createBinOp(spv::OpINotEqual, destType, operand, zero);
6891     case glslang::EOpConvFloatToBool:
6892         zero = builder.makeFloatConstant(0.0F);
6893         zero = makeSmearedConstant(zero, vectorSize);
6894         return builder.createBinOp(spv::OpFUnordNotEqual, destType, operand, zero);
6895     case glslang::EOpConvBoolToFloat:
6896         convOp = spv::OpSelect;
6897         zero = builder.makeFloatConstant(0.0F);
6898         one  = builder.makeFloatConstant(1.0F);
6899         break;
6900 
6901     case glslang::EOpConvBoolToInt:
6902     case glslang::EOpConvBoolToInt64:
6903 #ifndef GLSLANG_WEB
6904         if (op == glslang::EOpConvBoolToInt64) {
6905             zero = builder.makeInt64Constant(0);
6906             one = builder.makeInt64Constant(1);
6907         } else
6908 #endif
6909         {
6910             zero = builder.makeIntConstant(0);
6911             one = builder.makeIntConstant(1);
6912         }
6913 
6914         convOp = spv::OpSelect;
6915         break;
6916 
6917     case glslang::EOpConvBoolToUint:
6918     case glslang::EOpConvBoolToUint64:
6919 #ifndef GLSLANG_WEB
6920         if (op == glslang::EOpConvBoolToUint64) {
6921             zero = builder.makeUint64Constant(0);
6922             one = builder.makeUint64Constant(1);
6923         } else
6924 #endif
6925         {
6926             zero = builder.makeUintConstant(0);
6927             one = builder.makeUintConstant(1);
6928         }
6929 
6930         convOp = spv::OpSelect;
6931         break;
6932 
6933     case glslang::EOpConvInt8ToFloat16:
6934     case glslang::EOpConvInt8ToFloat:
6935     case glslang::EOpConvInt8ToDouble:
6936     case glslang::EOpConvInt16ToFloat16:
6937     case glslang::EOpConvInt16ToFloat:
6938     case glslang::EOpConvInt16ToDouble:
6939     case glslang::EOpConvIntToFloat16:
6940     case glslang::EOpConvIntToFloat:
6941     case glslang::EOpConvIntToDouble:
6942     case glslang::EOpConvInt64ToFloat:
6943     case glslang::EOpConvInt64ToDouble:
6944     case glslang::EOpConvInt64ToFloat16:
6945         convOp = spv::OpConvertSToF;
6946         break;
6947 
6948     case glslang::EOpConvUint8ToFloat16:
6949     case glslang::EOpConvUint8ToFloat:
6950     case glslang::EOpConvUint8ToDouble:
6951     case glslang::EOpConvUint16ToFloat16:
6952     case glslang::EOpConvUint16ToFloat:
6953     case glslang::EOpConvUint16ToDouble:
6954     case glslang::EOpConvUintToFloat16:
6955     case glslang::EOpConvUintToFloat:
6956     case glslang::EOpConvUintToDouble:
6957     case glslang::EOpConvUint64ToFloat:
6958     case glslang::EOpConvUint64ToDouble:
6959     case glslang::EOpConvUint64ToFloat16:
6960         convOp = spv::OpConvertUToF;
6961         break;
6962 
6963     case glslang::EOpConvFloat16ToInt8:
6964     case glslang::EOpConvFloatToInt8:
6965     case glslang::EOpConvDoubleToInt8:
6966     case glslang::EOpConvFloat16ToInt16:
6967     case glslang::EOpConvFloatToInt16:
6968     case glslang::EOpConvDoubleToInt16:
6969     case glslang::EOpConvFloat16ToInt:
6970     case glslang::EOpConvFloatToInt:
6971     case glslang::EOpConvDoubleToInt:
6972     case glslang::EOpConvFloat16ToInt64:
6973     case glslang::EOpConvFloatToInt64:
6974     case glslang::EOpConvDoubleToInt64:
6975         convOp = spv::OpConvertFToS;
6976         break;
6977 
6978     case glslang::EOpConvUint8ToInt8:
6979     case glslang::EOpConvInt8ToUint8:
6980     case glslang::EOpConvUint16ToInt16:
6981     case glslang::EOpConvInt16ToUint16:
6982     case glslang::EOpConvUintToInt:
6983     case glslang::EOpConvIntToUint:
6984     case glslang::EOpConvUint64ToInt64:
6985     case glslang::EOpConvInt64ToUint64:
6986         if (builder.isInSpecConstCodeGenMode()) {
6987             // Build zero scalar or vector for OpIAdd.
6988 #ifndef GLSLANG_WEB
6989             if(op == glslang::EOpConvUint8ToInt8 || op == glslang::EOpConvInt8ToUint8) {
6990                 zero = builder.makeUint8Constant(0);
6991             } else if (op == glslang::EOpConvUint16ToInt16 || op == glslang::EOpConvInt16ToUint16) {
6992                 zero = builder.makeUint16Constant(0);
6993             } else if (op == glslang::EOpConvUint64ToInt64 || op == glslang::EOpConvInt64ToUint64) {
6994                 zero = builder.makeUint64Constant(0);
6995             } else
6996 #endif
6997             {
6998                 zero = builder.makeUintConstant(0);
6999             }
7000             zero = makeSmearedConstant(zero, vectorSize);
7001             // Use OpIAdd, instead of OpBitcast to do the conversion when
7002             // generating for OpSpecConstantOp instruction.
7003             return builder.createBinOp(spv::OpIAdd, destType, operand, zero);
7004         }
7005         // For normal run-time conversion instruction, use OpBitcast.
7006         convOp = spv::OpBitcast;
7007         break;
7008 
7009     case glslang::EOpConvFloat16ToUint8:
7010     case glslang::EOpConvFloatToUint8:
7011     case glslang::EOpConvDoubleToUint8:
7012     case glslang::EOpConvFloat16ToUint16:
7013     case glslang::EOpConvFloatToUint16:
7014     case glslang::EOpConvDoubleToUint16:
7015     case glslang::EOpConvFloat16ToUint:
7016     case glslang::EOpConvFloatToUint:
7017     case glslang::EOpConvDoubleToUint:
7018     case glslang::EOpConvFloatToUint64:
7019     case glslang::EOpConvDoubleToUint64:
7020     case glslang::EOpConvFloat16ToUint64:
7021         convOp = spv::OpConvertFToU;
7022         break;
7023 
7024 #ifndef GLSLANG_WEB
7025     case glslang::EOpConvInt8ToBool:
7026     case glslang::EOpConvUint8ToBool:
7027         zero = builder.makeUint8Constant(0);
7028         zero = makeSmearedConstant(zero, vectorSize);
7029         return builder.createBinOp(spv::OpINotEqual, destType, operand, zero);
7030     case glslang::EOpConvInt16ToBool:
7031     case glslang::EOpConvUint16ToBool:
7032         zero = builder.makeUint16Constant(0);
7033         zero = makeSmearedConstant(zero, vectorSize);
7034         return builder.createBinOp(spv::OpINotEqual, destType, operand, zero);
7035     case glslang::EOpConvInt64ToBool:
7036     case glslang::EOpConvUint64ToBool:
7037         zero = builder.makeUint64Constant(0);
7038         zero = makeSmearedConstant(zero, vectorSize);
7039         return builder.createBinOp(spv::OpINotEqual, destType, operand, zero);
7040     case glslang::EOpConvDoubleToBool:
7041         zero = builder.makeDoubleConstant(0.0);
7042         zero = makeSmearedConstant(zero, vectorSize);
7043         return builder.createBinOp(spv::OpFUnordNotEqual, destType, operand, zero);
7044     case glslang::EOpConvFloat16ToBool:
7045         zero = builder.makeFloat16Constant(0.0F);
7046         zero = makeSmearedConstant(zero, vectorSize);
7047         return builder.createBinOp(spv::OpFUnordNotEqual, destType, operand, zero);
7048     case glslang::EOpConvBoolToDouble:
7049         convOp = spv::OpSelect;
7050         zero = builder.makeDoubleConstant(0.0);
7051         one  = builder.makeDoubleConstant(1.0);
7052         break;
7053     case glslang::EOpConvBoolToFloat16:
7054         convOp = spv::OpSelect;
7055         zero = builder.makeFloat16Constant(0.0F);
7056         one = builder.makeFloat16Constant(1.0F);
7057         break;
7058     case glslang::EOpConvBoolToInt8:
7059         zero = builder.makeInt8Constant(0);
7060         one  = builder.makeInt8Constant(1);
7061         convOp = spv::OpSelect;
7062         break;
7063     case glslang::EOpConvBoolToUint8:
7064         zero = builder.makeUint8Constant(0);
7065         one  = builder.makeUint8Constant(1);
7066         convOp = spv::OpSelect;
7067         break;
7068     case glslang::EOpConvBoolToInt16:
7069         zero = builder.makeInt16Constant(0);
7070         one  = builder.makeInt16Constant(1);
7071         convOp = spv::OpSelect;
7072         break;
7073     case glslang::EOpConvBoolToUint16:
7074         zero = builder.makeUint16Constant(0);
7075         one  = builder.makeUint16Constant(1);
7076         convOp = spv::OpSelect;
7077         break;
7078     case glslang::EOpConvDoubleToFloat:
7079     case glslang::EOpConvFloatToDouble:
7080     case glslang::EOpConvDoubleToFloat16:
7081     case glslang::EOpConvFloat16ToDouble:
7082     case glslang::EOpConvFloatToFloat16:
7083     case glslang::EOpConvFloat16ToFloat:
7084         convOp = spv::OpFConvert;
7085         if (builder.isMatrixType(destType))
7086             return createUnaryMatrixOperation(convOp, decorations, destType, operand, typeProxy);
7087         break;
7088 
7089     case glslang::EOpConvInt8ToInt16:
7090     case glslang::EOpConvInt8ToInt:
7091     case glslang::EOpConvInt8ToInt64:
7092     case glslang::EOpConvInt16ToInt8:
7093     case glslang::EOpConvInt16ToInt:
7094     case glslang::EOpConvInt16ToInt64:
7095     case glslang::EOpConvIntToInt8:
7096     case glslang::EOpConvIntToInt16:
7097     case glslang::EOpConvIntToInt64:
7098     case glslang::EOpConvInt64ToInt8:
7099     case glslang::EOpConvInt64ToInt16:
7100     case glslang::EOpConvInt64ToInt:
7101         convOp = spv::OpSConvert;
7102         break;
7103 
7104     case glslang::EOpConvUint8ToUint16:
7105     case glslang::EOpConvUint8ToUint:
7106     case glslang::EOpConvUint8ToUint64:
7107     case glslang::EOpConvUint16ToUint8:
7108     case glslang::EOpConvUint16ToUint:
7109     case glslang::EOpConvUint16ToUint64:
7110     case glslang::EOpConvUintToUint8:
7111     case glslang::EOpConvUintToUint16:
7112     case glslang::EOpConvUintToUint64:
7113     case glslang::EOpConvUint64ToUint8:
7114     case glslang::EOpConvUint64ToUint16:
7115     case glslang::EOpConvUint64ToUint:
7116         convOp = spv::OpUConvert;
7117         break;
7118 
7119     case glslang::EOpConvInt8ToUint16:
7120     case glslang::EOpConvInt8ToUint:
7121     case glslang::EOpConvInt8ToUint64:
7122     case glslang::EOpConvInt16ToUint8:
7123     case glslang::EOpConvInt16ToUint:
7124     case glslang::EOpConvInt16ToUint64:
7125     case glslang::EOpConvIntToUint8:
7126     case glslang::EOpConvIntToUint16:
7127     case glslang::EOpConvIntToUint64:
7128     case glslang::EOpConvInt64ToUint8:
7129     case glslang::EOpConvInt64ToUint16:
7130     case glslang::EOpConvInt64ToUint:
7131     case glslang::EOpConvUint8ToInt16:
7132     case glslang::EOpConvUint8ToInt:
7133     case glslang::EOpConvUint8ToInt64:
7134     case glslang::EOpConvUint16ToInt8:
7135     case glslang::EOpConvUint16ToInt:
7136     case glslang::EOpConvUint16ToInt64:
7137     case glslang::EOpConvUintToInt8:
7138     case glslang::EOpConvUintToInt16:
7139     case glslang::EOpConvUintToInt64:
7140     case glslang::EOpConvUint64ToInt8:
7141     case glslang::EOpConvUint64ToInt16:
7142     case glslang::EOpConvUint64ToInt:
7143         // OpSConvert/OpUConvert + OpBitCast
7144         operand = createIntWidthConversion(op, operand, vectorSize);
7145 
7146         if (builder.isInSpecConstCodeGenMode()) {
7147             // Build zero scalar or vector for OpIAdd.
7148             switch(op) {
7149             case glslang::EOpConvInt16ToUint8:
7150             case glslang::EOpConvIntToUint8:
7151             case glslang::EOpConvInt64ToUint8:
7152             case glslang::EOpConvUint16ToInt8:
7153             case glslang::EOpConvUintToInt8:
7154             case glslang::EOpConvUint64ToInt8:
7155                 zero = builder.makeUint8Constant(0);
7156                 break;
7157             case glslang::EOpConvInt8ToUint16:
7158             case glslang::EOpConvIntToUint16:
7159             case glslang::EOpConvInt64ToUint16:
7160             case glslang::EOpConvUint8ToInt16:
7161             case glslang::EOpConvUintToInt16:
7162             case glslang::EOpConvUint64ToInt16:
7163                 zero = builder.makeUint16Constant(0);
7164                 break;
7165             case glslang::EOpConvInt8ToUint:
7166             case glslang::EOpConvInt16ToUint:
7167             case glslang::EOpConvInt64ToUint:
7168             case glslang::EOpConvUint8ToInt:
7169             case glslang::EOpConvUint16ToInt:
7170             case glslang::EOpConvUint64ToInt:
7171                 zero = builder.makeUintConstant(0);
7172                 break;
7173             case glslang::EOpConvInt8ToUint64:
7174             case glslang::EOpConvInt16ToUint64:
7175             case glslang::EOpConvIntToUint64:
7176             case glslang::EOpConvUint8ToInt64:
7177             case glslang::EOpConvUint16ToInt64:
7178             case glslang::EOpConvUintToInt64:
7179                 zero = builder.makeUint64Constant(0);
7180                 break;
7181             default:
7182                 assert(false && "Default missing");
7183                 break;
7184             }
7185             zero = makeSmearedConstant(zero, vectorSize);
7186             // Use OpIAdd, instead of OpBitcast to do the conversion when
7187             // generating for OpSpecConstantOp instruction.
7188             return builder.createBinOp(spv::OpIAdd, destType, operand, zero);
7189         }
7190         // For normal run-time conversion instruction, use OpBitcast.
7191         convOp = spv::OpBitcast;
7192         break;
7193     case glslang::EOpConvUint64ToPtr:
7194         convOp = spv::OpConvertUToPtr;
7195         break;
7196     case glslang::EOpConvPtrToUint64:
7197         convOp = spv::OpConvertPtrToU;
7198         break;
7199     case glslang::EOpConvPtrToUvec2:
7200     case glslang::EOpConvUvec2ToPtr:
7201         convOp = spv::OpBitcast;
7202         break;
7203 #endif
7204 
7205     default:
7206         break;
7207     }
7208 
7209     spv::Id result = 0;
7210     if (convOp == spv::OpNop)
7211         return result;
7212 
7213     if (convOp == spv::OpSelect) {
7214         zero = makeSmearedConstant(zero, vectorSize);
7215         one  = makeSmearedConstant(one, vectorSize);
7216         result = builder.createTriOp(convOp, destType, operand, one, zero);
7217     } else
7218         result = builder.createUnaryOp(convOp, destType, operand);
7219 
7220     result = builder.setPrecision(result, decorations.precision);
7221     decorations.addNonUniform(builder, result);
7222     return result;
7223 }
7224 
makeSmearedConstant(spv::Id constant,int vectorSize)7225 spv::Id TGlslangToSpvTraverser::makeSmearedConstant(spv::Id constant, int vectorSize)
7226 {
7227     if (vectorSize == 0)
7228         return constant;
7229 
7230     spv::Id vectorTypeId = builder.makeVectorType(builder.getTypeId(constant), vectorSize);
7231     std::vector<spv::Id> components;
7232     for (int c = 0; c < vectorSize; ++c)
7233         components.push_back(constant);
7234     return builder.makeCompositeConstant(vectorTypeId, components);
7235 }
7236 
7237 // For glslang ops that map to SPV atomic opCodes
createAtomicOperation(glslang::TOperator op,spv::Decoration,spv::Id typeId,std::vector<spv::Id> & operands,glslang::TBasicType typeProxy,const spv::Builder::AccessChain::CoherentFlags & lvalueCoherentFlags)7238 spv::Id TGlslangToSpvTraverser::createAtomicOperation(glslang::TOperator op, spv::Decoration /*precision*/,
7239     spv::Id typeId, std::vector<spv::Id>& operands, glslang::TBasicType typeProxy,
7240     const spv::Builder::AccessChain::CoherentFlags &lvalueCoherentFlags)
7241 {
7242     spv::Op opCode = spv::OpNop;
7243 
7244     switch (op) {
7245     case glslang::EOpAtomicAdd:
7246     case glslang::EOpImageAtomicAdd:
7247     case glslang::EOpAtomicCounterAdd:
7248         opCode = spv::OpAtomicIAdd;
7249         if (typeProxy == glslang::EbtFloat16 || typeProxy == glslang::EbtFloat || typeProxy == glslang::EbtDouble) {
7250             opCode = spv::OpAtomicFAddEXT;
7251             builder.addExtension(spv::E_SPV_EXT_shader_atomic_float_add);
7252             if (typeProxy == glslang::EbtFloat16) {
7253                 builder.addExtension(spv::E_SPV_EXT_shader_atomic_float16_add);
7254                 builder.addCapability(spv::CapabilityAtomicFloat16AddEXT);
7255             } else if (typeProxy == glslang::EbtFloat) {
7256                 builder.addCapability(spv::CapabilityAtomicFloat32AddEXT);
7257             } else {
7258                 builder.addCapability(spv::CapabilityAtomicFloat64AddEXT);
7259             }
7260         }
7261         break;
7262     case glslang::EOpAtomicSubtract:
7263     case glslang::EOpAtomicCounterSubtract:
7264         opCode = spv::OpAtomicISub;
7265         break;
7266     case glslang::EOpAtomicMin:
7267     case glslang::EOpImageAtomicMin:
7268     case glslang::EOpAtomicCounterMin:
7269         if (typeProxy == glslang::EbtFloat16 || typeProxy == glslang::EbtFloat || typeProxy == glslang::EbtDouble) {
7270             opCode = spv::OpAtomicFMinEXT;
7271             builder.addExtension(spv::E_SPV_EXT_shader_atomic_float_min_max);
7272             if (typeProxy == glslang::EbtFloat16)
7273                 builder.addCapability(spv::CapabilityAtomicFloat16MinMaxEXT);
7274             else if (typeProxy == glslang::EbtFloat)
7275                 builder.addCapability(spv::CapabilityAtomicFloat32MinMaxEXT);
7276             else
7277                 builder.addCapability(spv::CapabilityAtomicFloat64MinMaxEXT);
7278         } else if (typeProxy == glslang::EbtUint || typeProxy == glslang::EbtUint64) {
7279             opCode = spv::OpAtomicUMin;
7280         } else {
7281             opCode = spv::OpAtomicSMin;
7282         }
7283         break;
7284     case glslang::EOpAtomicMax:
7285     case glslang::EOpImageAtomicMax:
7286     case glslang::EOpAtomicCounterMax:
7287         if (typeProxy == glslang::EbtFloat16 || typeProxy == glslang::EbtFloat || typeProxy == glslang::EbtDouble) {
7288             opCode = spv::OpAtomicFMaxEXT;
7289             builder.addExtension(spv::E_SPV_EXT_shader_atomic_float_min_max);
7290             if (typeProxy == glslang::EbtFloat16)
7291                 builder.addCapability(spv::CapabilityAtomicFloat16MinMaxEXT);
7292             else if (typeProxy == glslang::EbtFloat)
7293                 builder.addCapability(spv::CapabilityAtomicFloat32MinMaxEXT);
7294             else
7295                 builder.addCapability(spv::CapabilityAtomicFloat64MinMaxEXT);
7296         } else if (typeProxy == glslang::EbtUint || typeProxy == glslang::EbtUint64) {
7297             opCode = spv::OpAtomicUMax;
7298         } else {
7299             opCode = spv::OpAtomicSMax;
7300         }
7301         break;
7302     case glslang::EOpAtomicAnd:
7303     case glslang::EOpImageAtomicAnd:
7304     case glslang::EOpAtomicCounterAnd:
7305         opCode = spv::OpAtomicAnd;
7306         break;
7307     case glslang::EOpAtomicOr:
7308     case glslang::EOpImageAtomicOr:
7309     case glslang::EOpAtomicCounterOr:
7310         opCode = spv::OpAtomicOr;
7311         break;
7312     case glslang::EOpAtomicXor:
7313     case glslang::EOpImageAtomicXor:
7314     case glslang::EOpAtomicCounterXor:
7315         opCode = spv::OpAtomicXor;
7316         break;
7317     case glslang::EOpAtomicExchange:
7318     case glslang::EOpImageAtomicExchange:
7319     case glslang::EOpAtomicCounterExchange:
7320         opCode = spv::OpAtomicExchange;
7321         break;
7322     case glslang::EOpAtomicCompSwap:
7323     case glslang::EOpImageAtomicCompSwap:
7324     case glslang::EOpAtomicCounterCompSwap:
7325         opCode = spv::OpAtomicCompareExchange;
7326         break;
7327     case glslang::EOpAtomicCounterIncrement:
7328         opCode = spv::OpAtomicIIncrement;
7329         break;
7330     case glslang::EOpAtomicCounterDecrement:
7331         opCode = spv::OpAtomicIDecrement;
7332         break;
7333     case glslang::EOpAtomicCounter:
7334     case glslang::EOpImageAtomicLoad:
7335     case glslang::EOpAtomicLoad:
7336         opCode = spv::OpAtomicLoad;
7337         break;
7338     case glslang::EOpAtomicStore:
7339     case glslang::EOpImageAtomicStore:
7340         opCode = spv::OpAtomicStore;
7341         break;
7342     default:
7343         assert(0);
7344         break;
7345     }
7346 
7347     if (typeProxy == glslang::EbtInt64 || typeProxy == glslang::EbtUint64)
7348         builder.addCapability(spv::CapabilityInt64Atomics);
7349 
7350     // Sort out the operands
7351     //  - mapping from glslang -> SPV
7352     //  - there are extra SPV operands that are optional in glslang
7353     //  - compare-exchange swaps the value and comparator
7354     //  - compare-exchange has an extra memory semantics
7355     //  - EOpAtomicCounterDecrement needs a post decrement
7356     spv::Id pointerId = 0, compareId = 0, valueId = 0;
7357     // scope defaults to Device in the old model, QueueFamilyKHR in the new model
7358     spv::Id scopeId;
7359     if (glslangIntermediate->usingVulkanMemoryModel()) {
7360         scopeId = builder.makeUintConstant(spv::ScopeQueueFamilyKHR);
7361     } else {
7362         scopeId = builder.makeUintConstant(spv::ScopeDevice);
7363     }
7364     // semantics default to relaxed
7365     spv::Id semanticsId = builder.makeUintConstant(lvalueCoherentFlags.isVolatile() &&
7366         glslangIntermediate->usingVulkanMemoryModel() ?
7367                                                     spv::MemorySemanticsVolatileMask :
7368                                                     spv::MemorySemanticsMaskNone);
7369     spv::Id semanticsId2 = semanticsId;
7370 
7371     pointerId = operands[0];
7372     if (opCode == spv::OpAtomicIIncrement || opCode == spv::OpAtomicIDecrement) {
7373         // no additional operands
7374     } else if (opCode == spv::OpAtomicCompareExchange) {
7375         compareId = operands[1];
7376         valueId = operands[2];
7377         if (operands.size() > 3) {
7378             scopeId = operands[3];
7379             semanticsId = builder.makeUintConstant(
7380                 builder.getConstantScalar(operands[4]) | builder.getConstantScalar(operands[5]));
7381             semanticsId2 = builder.makeUintConstant(
7382                 builder.getConstantScalar(operands[6]) | builder.getConstantScalar(operands[7]));
7383         }
7384     } else if (opCode == spv::OpAtomicLoad) {
7385         if (operands.size() > 1) {
7386             scopeId = operands[1];
7387             semanticsId = builder.makeUintConstant(
7388                 builder.getConstantScalar(operands[2]) | builder.getConstantScalar(operands[3]));
7389         }
7390     } else {
7391         // atomic store or RMW
7392         valueId = operands[1];
7393         if (operands.size() > 2) {
7394             scopeId = operands[2];
7395             semanticsId = builder.makeUintConstant
7396                 (builder.getConstantScalar(operands[3]) | builder.getConstantScalar(operands[4]));
7397         }
7398     }
7399 
7400     // Check for capabilities
7401     unsigned semanticsImmediate = builder.getConstantScalar(semanticsId) | builder.getConstantScalar(semanticsId2);
7402     if (semanticsImmediate & (spv::MemorySemanticsMakeAvailableKHRMask |
7403                               spv::MemorySemanticsMakeVisibleKHRMask |
7404                               spv::MemorySemanticsOutputMemoryKHRMask |
7405                               spv::MemorySemanticsVolatileMask)) {
7406         builder.addCapability(spv::CapabilityVulkanMemoryModelKHR);
7407     }
7408 
7409     if (builder.getConstantScalar(scopeId) == spv::ScopeQueueFamily) {
7410         builder.addCapability(spv::CapabilityVulkanMemoryModelKHR);
7411     }
7412 
7413     if (glslangIntermediate->usingVulkanMemoryModel() && builder.getConstantScalar(scopeId) == spv::ScopeDevice) {
7414         builder.addCapability(spv::CapabilityVulkanMemoryModelDeviceScopeKHR);
7415     }
7416 
7417     std::vector<spv::Id> spvAtomicOperands;  // hold the spv operands
7418     spvAtomicOperands.push_back(pointerId);
7419     spvAtomicOperands.push_back(scopeId);
7420     spvAtomicOperands.push_back(semanticsId);
7421     if (opCode == spv::OpAtomicCompareExchange) {
7422         spvAtomicOperands.push_back(semanticsId2);
7423         spvAtomicOperands.push_back(valueId);
7424         spvAtomicOperands.push_back(compareId);
7425     } else if (opCode != spv::OpAtomicLoad && opCode != spv::OpAtomicIIncrement && opCode != spv::OpAtomicIDecrement) {
7426         spvAtomicOperands.push_back(valueId);
7427     }
7428 
7429     if (opCode == spv::OpAtomicStore) {
7430         builder.createNoResultOp(opCode, spvAtomicOperands);
7431         return 0;
7432     } else {
7433         spv::Id resultId = builder.createOp(opCode, typeId, spvAtomicOperands);
7434 
7435         // GLSL and HLSL atomic-counter decrement return post-decrement value,
7436         // while SPIR-V returns pre-decrement value. Translate between these semantics.
7437         if (op == glslang::EOpAtomicCounterDecrement)
7438             resultId = builder.createBinOp(spv::OpISub, typeId, resultId, builder.makeIntConstant(1));
7439 
7440         return resultId;
7441     }
7442 }
7443 
7444 // Create group invocation operations.
createInvocationsOperation(glslang::TOperator op,spv::Id typeId,std::vector<spv::Id> & operands,glslang::TBasicType typeProxy)7445 spv::Id TGlslangToSpvTraverser::createInvocationsOperation(glslang::TOperator op, spv::Id typeId,
7446     std::vector<spv::Id>& operands, glslang::TBasicType typeProxy)
7447 {
7448     bool isUnsigned = isTypeUnsignedInt(typeProxy);
7449     bool isFloat = isTypeFloat(typeProxy);
7450 
7451     spv::Op opCode = spv::OpNop;
7452     std::vector<spv::IdImmediate> spvGroupOperands;
7453     spv::GroupOperation groupOperation = spv::GroupOperationMax;
7454 
7455     if (op == glslang::EOpBallot || op == glslang::EOpReadFirstInvocation ||
7456         op == glslang::EOpReadInvocation) {
7457         builder.addExtension(spv::E_SPV_KHR_shader_ballot);
7458         builder.addCapability(spv::CapabilitySubgroupBallotKHR);
7459     } else if (op == glslang::EOpAnyInvocation ||
7460         op == glslang::EOpAllInvocations ||
7461         op == glslang::EOpAllInvocationsEqual) {
7462         builder.addExtension(spv::E_SPV_KHR_subgroup_vote);
7463         builder.addCapability(spv::CapabilitySubgroupVoteKHR);
7464     } else {
7465         builder.addCapability(spv::CapabilityGroups);
7466         if (op == glslang::EOpMinInvocationsNonUniform ||
7467             op == glslang::EOpMaxInvocationsNonUniform ||
7468             op == glslang::EOpAddInvocationsNonUniform ||
7469             op == glslang::EOpMinInvocationsInclusiveScanNonUniform ||
7470             op == glslang::EOpMaxInvocationsInclusiveScanNonUniform ||
7471             op == glslang::EOpAddInvocationsInclusiveScanNonUniform ||
7472             op == glslang::EOpMinInvocationsExclusiveScanNonUniform ||
7473             op == glslang::EOpMaxInvocationsExclusiveScanNonUniform ||
7474             op == glslang::EOpAddInvocationsExclusiveScanNonUniform)
7475             builder.addExtension(spv::E_SPV_AMD_shader_ballot);
7476 
7477         switch (op) {
7478         case glslang::EOpMinInvocations:
7479         case glslang::EOpMaxInvocations:
7480         case glslang::EOpAddInvocations:
7481         case glslang::EOpMinInvocationsNonUniform:
7482         case glslang::EOpMaxInvocationsNonUniform:
7483         case glslang::EOpAddInvocationsNonUniform:
7484             groupOperation = spv::GroupOperationReduce;
7485             break;
7486         case glslang::EOpMinInvocationsInclusiveScan:
7487         case glslang::EOpMaxInvocationsInclusiveScan:
7488         case glslang::EOpAddInvocationsInclusiveScan:
7489         case glslang::EOpMinInvocationsInclusiveScanNonUniform:
7490         case glslang::EOpMaxInvocationsInclusiveScanNonUniform:
7491         case glslang::EOpAddInvocationsInclusiveScanNonUniform:
7492             groupOperation = spv::GroupOperationInclusiveScan;
7493             break;
7494         case glslang::EOpMinInvocationsExclusiveScan:
7495         case glslang::EOpMaxInvocationsExclusiveScan:
7496         case glslang::EOpAddInvocationsExclusiveScan:
7497         case glslang::EOpMinInvocationsExclusiveScanNonUniform:
7498         case glslang::EOpMaxInvocationsExclusiveScanNonUniform:
7499         case glslang::EOpAddInvocationsExclusiveScanNonUniform:
7500             groupOperation = spv::GroupOperationExclusiveScan;
7501             break;
7502         default:
7503             break;
7504         }
7505         spv::IdImmediate scope = { true, builder.makeUintConstant(spv::ScopeSubgroup) };
7506         spvGroupOperands.push_back(scope);
7507         if (groupOperation != spv::GroupOperationMax) {
7508             spv::IdImmediate groupOp = { false, (unsigned)groupOperation };
7509             spvGroupOperands.push_back(groupOp);
7510         }
7511     }
7512 
7513     for (auto opIt = operands.begin(); opIt != operands.end(); ++opIt) {
7514         spv::IdImmediate op = { true, *opIt };
7515         spvGroupOperands.push_back(op);
7516     }
7517 
7518     switch (op) {
7519     case glslang::EOpAnyInvocation:
7520         opCode = spv::OpSubgroupAnyKHR;
7521         break;
7522     case glslang::EOpAllInvocations:
7523         opCode = spv::OpSubgroupAllKHR;
7524         break;
7525     case glslang::EOpAllInvocationsEqual:
7526         opCode = spv::OpSubgroupAllEqualKHR;
7527         break;
7528     case glslang::EOpReadInvocation:
7529         opCode = spv::OpSubgroupReadInvocationKHR;
7530         if (builder.isVectorType(typeId))
7531             return CreateInvocationsVectorOperation(opCode, groupOperation, typeId, operands);
7532         break;
7533     case glslang::EOpReadFirstInvocation:
7534         opCode = spv::OpSubgroupFirstInvocationKHR;
7535         if (builder.isVectorType(typeId))
7536             return CreateInvocationsVectorOperation(opCode, groupOperation, typeId, operands);
7537         break;
7538     case glslang::EOpBallot:
7539     {
7540         // NOTE: According to the spec, the result type of "OpSubgroupBallotKHR" must be a 4 component vector of 32
7541         // bit integer types. The GLSL built-in function "ballotARB()" assumes the maximum number of invocations in
7542         // a subgroup is 64. Thus, we have to convert uvec4.xy to uint64_t as follow:
7543         //
7544         //     result = Bitcast(SubgroupBallotKHR(Predicate).xy)
7545         //
7546         spv::Id uintType  = builder.makeUintType(32);
7547         spv::Id uvec4Type = builder.makeVectorType(uintType, 4);
7548         spv::Id result = builder.createOp(spv::OpSubgroupBallotKHR, uvec4Type, spvGroupOperands);
7549 
7550         std::vector<spv::Id> components;
7551         components.push_back(builder.createCompositeExtract(result, uintType, 0));
7552         components.push_back(builder.createCompositeExtract(result, uintType, 1));
7553 
7554         spv::Id uvec2Type = builder.makeVectorType(uintType, 2);
7555         return builder.createUnaryOp(spv::OpBitcast, typeId,
7556                                      builder.createCompositeConstruct(uvec2Type, components));
7557     }
7558 
7559     case glslang::EOpMinInvocations:
7560     case glslang::EOpMaxInvocations:
7561     case glslang::EOpAddInvocations:
7562     case glslang::EOpMinInvocationsInclusiveScan:
7563     case glslang::EOpMaxInvocationsInclusiveScan:
7564     case glslang::EOpAddInvocationsInclusiveScan:
7565     case glslang::EOpMinInvocationsExclusiveScan:
7566     case glslang::EOpMaxInvocationsExclusiveScan:
7567     case glslang::EOpAddInvocationsExclusiveScan:
7568         if (op == glslang::EOpMinInvocations ||
7569             op == glslang::EOpMinInvocationsInclusiveScan ||
7570             op == glslang::EOpMinInvocationsExclusiveScan) {
7571             if (isFloat)
7572                 opCode = spv::OpGroupFMin;
7573             else {
7574                 if (isUnsigned)
7575                     opCode = spv::OpGroupUMin;
7576                 else
7577                     opCode = spv::OpGroupSMin;
7578             }
7579         } else if (op == glslang::EOpMaxInvocations ||
7580                    op == glslang::EOpMaxInvocationsInclusiveScan ||
7581                    op == glslang::EOpMaxInvocationsExclusiveScan) {
7582             if (isFloat)
7583                 opCode = spv::OpGroupFMax;
7584             else {
7585                 if (isUnsigned)
7586                     opCode = spv::OpGroupUMax;
7587                 else
7588                     opCode = spv::OpGroupSMax;
7589             }
7590         } else {
7591             if (isFloat)
7592                 opCode = spv::OpGroupFAdd;
7593             else
7594                 opCode = spv::OpGroupIAdd;
7595         }
7596 
7597         if (builder.isVectorType(typeId))
7598             return CreateInvocationsVectorOperation(opCode, groupOperation, typeId, operands);
7599 
7600         break;
7601     case glslang::EOpMinInvocationsNonUniform:
7602     case glslang::EOpMaxInvocationsNonUniform:
7603     case glslang::EOpAddInvocationsNonUniform:
7604     case glslang::EOpMinInvocationsInclusiveScanNonUniform:
7605     case glslang::EOpMaxInvocationsInclusiveScanNonUniform:
7606     case glslang::EOpAddInvocationsInclusiveScanNonUniform:
7607     case glslang::EOpMinInvocationsExclusiveScanNonUniform:
7608     case glslang::EOpMaxInvocationsExclusiveScanNonUniform:
7609     case glslang::EOpAddInvocationsExclusiveScanNonUniform:
7610         if (op == glslang::EOpMinInvocationsNonUniform ||
7611             op == glslang::EOpMinInvocationsInclusiveScanNonUniform ||
7612             op == glslang::EOpMinInvocationsExclusiveScanNonUniform) {
7613             if (isFloat)
7614                 opCode = spv::OpGroupFMinNonUniformAMD;
7615             else {
7616                 if (isUnsigned)
7617                     opCode = spv::OpGroupUMinNonUniformAMD;
7618                 else
7619                     opCode = spv::OpGroupSMinNonUniformAMD;
7620             }
7621         }
7622         else if (op == glslang::EOpMaxInvocationsNonUniform ||
7623                  op == glslang::EOpMaxInvocationsInclusiveScanNonUniform ||
7624                  op == glslang::EOpMaxInvocationsExclusiveScanNonUniform) {
7625             if (isFloat)
7626                 opCode = spv::OpGroupFMaxNonUniformAMD;
7627             else {
7628                 if (isUnsigned)
7629                     opCode = spv::OpGroupUMaxNonUniformAMD;
7630                 else
7631                     opCode = spv::OpGroupSMaxNonUniformAMD;
7632             }
7633         }
7634         else {
7635             if (isFloat)
7636                 opCode = spv::OpGroupFAddNonUniformAMD;
7637             else
7638                 opCode = spv::OpGroupIAddNonUniformAMD;
7639         }
7640 
7641         if (builder.isVectorType(typeId))
7642             return CreateInvocationsVectorOperation(opCode, groupOperation, typeId, operands);
7643 
7644         break;
7645     default:
7646         logger->missingFunctionality("invocation operation");
7647         return spv::NoResult;
7648     }
7649 
7650     assert(opCode != spv::OpNop);
7651     return builder.createOp(opCode, typeId, spvGroupOperands);
7652 }
7653 
7654 // Create group invocation operations on a vector
CreateInvocationsVectorOperation(spv::Op op,spv::GroupOperation groupOperation,spv::Id typeId,std::vector<spv::Id> & operands)7655 spv::Id TGlslangToSpvTraverser::CreateInvocationsVectorOperation(spv::Op op, spv::GroupOperation groupOperation,
7656     spv::Id typeId, std::vector<spv::Id>& operands)
7657 {
7658     assert(op == spv::OpGroupFMin || op == spv::OpGroupUMin || op == spv::OpGroupSMin ||
7659            op == spv::OpGroupFMax || op == spv::OpGroupUMax || op == spv::OpGroupSMax ||
7660            op == spv::OpGroupFAdd || op == spv::OpGroupIAdd || op == spv::OpGroupBroadcast ||
7661            op == spv::OpSubgroupReadInvocationKHR || op == spv::OpSubgroupFirstInvocationKHR ||
7662            op == spv::OpGroupFMinNonUniformAMD || op == spv::OpGroupUMinNonUniformAMD ||
7663            op == spv::OpGroupSMinNonUniformAMD ||
7664            op == spv::OpGroupFMaxNonUniformAMD || op == spv::OpGroupUMaxNonUniformAMD ||
7665            op == spv::OpGroupSMaxNonUniformAMD ||
7666            op == spv::OpGroupFAddNonUniformAMD || op == spv::OpGroupIAddNonUniformAMD);
7667 
7668     // Handle group invocation operations scalar by scalar.
7669     // The result type is the same type as the original type.
7670     // The algorithm is to:
7671     //   - break the vector into scalars
7672     //   - apply the operation to each scalar
7673     //   - make a vector out the scalar results
7674 
7675     // get the types sorted out
7676     int numComponents = builder.getNumComponents(operands[0]);
7677     spv::Id scalarType = builder.getScalarTypeId(builder.getTypeId(operands[0]));
7678     std::vector<spv::Id> results;
7679 
7680     // do each scalar op
7681     for (int comp = 0; comp < numComponents; ++comp) {
7682         std::vector<unsigned int> indexes;
7683         indexes.push_back(comp);
7684         spv::IdImmediate scalar = { true, builder.createCompositeExtract(operands[0], scalarType, indexes) };
7685         std::vector<spv::IdImmediate> spvGroupOperands;
7686         if (op == spv::OpSubgroupReadInvocationKHR) {
7687             spvGroupOperands.push_back(scalar);
7688             spv::IdImmediate operand = { true, operands[1] };
7689             spvGroupOperands.push_back(operand);
7690         } else if (op == spv::OpSubgroupFirstInvocationKHR) {
7691             spvGroupOperands.push_back(scalar);
7692         } else if (op == spv::OpGroupBroadcast) {
7693             spv::IdImmediate scope = { true, builder.makeUintConstant(spv::ScopeSubgroup) };
7694             spvGroupOperands.push_back(scope);
7695             spvGroupOperands.push_back(scalar);
7696             spv::IdImmediate operand = { true, operands[1] };
7697             spvGroupOperands.push_back(operand);
7698         } else {
7699             spv::IdImmediate scope = { true, builder.makeUintConstant(spv::ScopeSubgroup) };
7700             spvGroupOperands.push_back(scope);
7701             spv::IdImmediate groupOp = { false, (unsigned)groupOperation };
7702             spvGroupOperands.push_back(groupOp);
7703             spvGroupOperands.push_back(scalar);
7704         }
7705 
7706         results.push_back(builder.createOp(op, scalarType, spvGroupOperands));
7707     }
7708 
7709     // put the pieces together
7710     return builder.createCompositeConstruct(typeId, results);
7711 }
7712 
7713 // Create subgroup invocation operations.
createSubgroupOperation(glslang::TOperator op,spv::Id typeId,std::vector<spv::Id> & operands,glslang::TBasicType typeProxy)7714 spv::Id TGlslangToSpvTraverser::createSubgroupOperation(glslang::TOperator op, spv::Id typeId,
7715     std::vector<spv::Id>& operands, glslang::TBasicType typeProxy)
7716 {
7717     // Add the required capabilities.
7718     switch (op) {
7719     case glslang::EOpSubgroupElect:
7720         builder.addCapability(spv::CapabilityGroupNonUniform);
7721         break;
7722     case glslang::EOpSubgroupAll:
7723     case glslang::EOpSubgroupAny:
7724     case glslang::EOpSubgroupAllEqual:
7725         builder.addCapability(spv::CapabilityGroupNonUniform);
7726         builder.addCapability(spv::CapabilityGroupNonUniformVote);
7727         break;
7728     case glslang::EOpSubgroupBroadcast:
7729     case glslang::EOpSubgroupBroadcastFirst:
7730     case glslang::EOpSubgroupBallot:
7731     case glslang::EOpSubgroupInverseBallot:
7732     case glslang::EOpSubgroupBallotBitExtract:
7733     case glslang::EOpSubgroupBallotBitCount:
7734     case glslang::EOpSubgroupBallotInclusiveBitCount:
7735     case glslang::EOpSubgroupBallotExclusiveBitCount:
7736     case glslang::EOpSubgroupBallotFindLSB:
7737     case glslang::EOpSubgroupBallotFindMSB:
7738         builder.addCapability(spv::CapabilityGroupNonUniform);
7739         builder.addCapability(spv::CapabilityGroupNonUniformBallot);
7740         break;
7741     case glslang::EOpSubgroupShuffle:
7742     case glslang::EOpSubgroupShuffleXor:
7743         builder.addCapability(spv::CapabilityGroupNonUniform);
7744         builder.addCapability(spv::CapabilityGroupNonUniformShuffle);
7745         break;
7746     case glslang::EOpSubgroupShuffleUp:
7747     case glslang::EOpSubgroupShuffleDown:
7748         builder.addCapability(spv::CapabilityGroupNonUniform);
7749         builder.addCapability(spv::CapabilityGroupNonUniformShuffleRelative);
7750         break;
7751     case glslang::EOpSubgroupAdd:
7752     case glslang::EOpSubgroupMul:
7753     case glslang::EOpSubgroupMin:
7754     case glslang::EOpSubgroupMax:
7755     case glslang::EOpSubgroupAnd:
7756     case glslang::EOpSubgroupOr:
7757     case glslang::EOpSubgroupXor:
7758     case glslang::EOpSubgroupInclusiveAdd:
7759     case glslang::EOpSubgroupInclusiveMul:
7760     case glslang::EOpSubgroupInclusiveMin:
7761     case glslang::EOpSubgroupInclusiveMax:
7762     case glslang::EOpSubgroupInclusiveAnd:
7763     case glslang::EOpSubgroupInclusiveOr:
7764     case glslang::EOpSubgroupInclusiveXor:
7765     case glslang::EOpSubgroupExclusiveAdd:
7766     case glslang::EOpSubgroupExclusiveMul:
7767     case glslang::EOpSubgroupExclusiveMin:
7768     case glslang::EOpSubgroupExclusiveMax:
7769     case glslang::EOpSubgroupExclusiveAnd:
7770     case glslang::EOpSubgroupExclusiveOr:
7771     case glslang::EOpSubgroupExclusiveXor:
7772         builder.addCapability(spv::CapabilityGroupNonUniform);
7773         builder.addCapability(spv::CapabilityGroupNonUniformArithmetic);
7774         break;
7775     case glslang::EOpSubgroupClusteredAdd:
7776     case glslang::EOpSubgroupClusteredMul:
7777     case glslang::EOpSubgroupClusteredMin:
7778     case glslang::EOpSubgroupClusteredMax:
7779     case glslang::EOpSubgroupClusteredAnd:
7780     case glslang::EOpSubgroupClusteredOr:
7781     case glslang::EOpSubgroupClusteredXor:
7782         builder.addCapability(spv::CapabilityGroupNonUniform);
7783         builder.addCapability(spv::CapabilityGroupNonUniformClustered);
7784         break;
7785     case glslang::EOpSubgroupQuadBroadcast:
7786     case glslang::EOpSubgroupQuadSwapHorizontal:
7787     case glslang::EOpSubgroupQuadSwapVertical:
7788     case glslang::EOpSubgroupQuadSwapDiagonal:
7789         builder.addCapability(spv::CapabilityGroupNonUniform);
7790         builder.addCapability(spv::CapabilityGroupNonUniformQuad);
7791         break;
7792     case glslang::EOpSubgroupPartitionedAdd:
7793     case glslang::EOpSubgroupPartitionedMul:
7794     case glslang::EOpSubgroupPartitionedMin:
7795     case glslang::EOpSubgroupPartitionedMax:
7796     case glslang::EOpSubgroupPartitionedAnd:
7797     case glslang::EOpSubgroupPartitionedOr:
7798     case glslang::EOpSubgroupPartitionedXor:
7799     case glslang::EOpSubgroupPartitionedInclusiveAdd:
7800     case glslang::EOpSubgroupPartitionedInclusiveMul:
7801     case glslang::EOpSubgroupPartitionedInclusiveMin:
7802     case glslang::EOpSubgroupPartitionedInclusiveMax:
7803     case glslang::EOpSubgroupPartitionedInclusiveAnd:
7804     case glslang::EOpSubgroupPartitionedInclusiveOr:
7805     case glslang::EOpSubgroupPartitionedInclusiveXor:
7806     case glslang::EOpSubgroupPartitionedExclusiveAdd:
7807     case glslang::EOpSubgroupPartitionedExclusiveMul:
7808     case glslang::EOpSubgroupPartitionedExclusiveMin:
7809     case glslang::EOpSubgroupPartitionedExclusiveMax:
7810     case glslang::EOpSubgroupPartitionedExclusiveAnd:
7811     case glslang::EOpSubgroupPartitionedExclusiveOr:
7812     case glslang::EOpSubgroupPartitionedExclusiveXor:
7813         builder.addExtension(spv::E_SPV_NV_shader_subgroup_partitioned);
7814         builder.addCapability(spv::CapabilityGroupNonUniformPartitionedNV);
7815         break;
7816     default: assert(0 && "Unhandled subgroup operation!");
7817     }
7818 
7819 
7820     const bool isUnsigned = isTypeUnsignedInt(typeProxy);
7821     const bool isFloat = isTypeFloat(typeProxy);
7822     const bool isBool = typeProxy == glslang::EbtBool;
7823 
7824     spv::Op opCode = spv::OpNop;
7825 
7826     // Figure out which opcode to use.
7827     switch (op) {
7828     case glslang::EOpSubgroupElect:                   opCode = spv::OpGroupNonUniformElect; break;
7829     case glslang::EOpSubgroupAll:                     opCode = spv::OpGroupNonUniformAll; break;
7830     case glslang::EOpSubgroupAny:                     opCode = spv::OpGroupNonUniformAny; break;
7831     case glslang::EOpSubgroupAllEqual:                opCode = spv::OpGroupNonUniformAllEqual; break;
7832     case glslang::EOpSubgroupBroadcast:               opCode = spv::OpGroupNonUniformBroadcast; break;
7833     case glslang::EOpSubgroupBroadcastFirst:          opCode = spv::OpGroupNonUniformBroadcastFirst; break;
7834     case glslang::EOpSubgroupBallot:                  opCode = spv::OpGroupNonUniformBallot; break;
7835     case glslang::EOpSubgroupInverseBallot:           opCode = spv::OpGroupNonUniformInverseBallot; break;
7836     case glslang::EOpSubgroupBallotBitExtract:        opCode = spv::OpGroupNonUniformBallotBitExtract; break;
7837     case glslang::EOpSubgroupBallotBitCount:
7838     case glslang::EOpSubgroupBallotInclusiveBitCount:
7839     case glslang::EOpSubgroupBallotExclusiveBitCount: opCode = spv::OpGroupNonUniformBallotBitCount; break;
7840     case glslang::EOpSubgroupBallotFindLSB:           opCode = spv::OpGroupNonUniformBallotFindLSB; break;
7841     case glslang::EOpSubgroupBallotFindMSB:           opCode = spv::OpGroupNonUniformBallotFindMSB; break;
7842     case glslang::EOpSubgroupShuffle:                 opCode = spv::OpGroupNonUniformShuffle; break;
7843     case glslang::EOpSubgroupShuffleXor:              opCode = spv::OpGroupNonUniformShuffleXor; break;
7844     case glslang::EOpSubgroupShuffleUp:               opCode = spv::OpGroupNonUniformShuffleUp; break;
7845     case glslang::EOpSubgroupShuffleDown:             opCode = spv::OpGroupNonUniformShuffleDown; break;
7846     case glslang::EOpSubgroupAdd:
7847     case glslang::EOpSubgroupInclusiveAdd:
7848     case glslang::EOpSubgroupExclusiveAdd:
7849     case glslang::EOpSubgroupClusteredAdd:
7850     case glslang::EOpSubgroupPartitionedAdd:
7851     case glslang::EOpSubgroupPartitionedInclusiveAdd:
7852     case glslang::EOpSubgroupPartitionedExclusiveAdd:
7853         if (isFloat) {
7854             opCode = spv::OpGroupNonUniformFAdd;
7855         } else {
7856             opCode = spv::OpGroupNonUniformIAdd;
7857         }
7858         break;
7859     case glslang::EOpSubgroupMul:
7860     case glslang::EOpSubgroupInclusiveMul:
7861     case glslang::EOpSubgroupExclusiveMul:
7862     case glslang::EOpSubgroupClusteredMul:
7863     case glslang::EOpSubgroupPartitionedMul:
7864     case glslang::EOpSubgroupPartitionedInclusiveMul:
7865     case glslang::EOpSubgroupPartitionedExclusiveMul:
7866         if (isFloat) {
7867             opCode = spv::OpGroupNonUniformFMul;
7868         } else {
7869             opCode = spv::OpGroupNonUniformIMul;
7870         }
7871         break;
7872     case glslang::EOpSubgroupMin:
7873     case glslang::EOpSubgroupInclusiveMin:
7874     case glslang::EOpSubgroupExclusiveMin:
7875     case glslang::EOpSubgroupClusteredMin:
7876     case glslang::EOpSubgroupPartitionedMin:
7877     case glslang::EOpSubgroupPartitionedInclusiveMin:
7878     case glslang::EOpSubgroupPartitionedExclusiveMin:
7879         if (isFloat) {
7880             opCode = spv::OpGroupNonUniformFMin;
7881         } else if (isUnsigned) {
7882             opCode = spv::OpGroupNonUniformUMin;
7883         } else {
7884             opCode = spv::OpGroupNonUniformSMin;
7885         }
7886         break;
7887     case glslang::EOpSubgroupMax:
7888     case glslang::EOpSubgroupInclusiveMax:
7889     case glslang::EOpSubgroupExclusiveMax:
7890     case glslang::EOpSubgroupClusteredMax:
7891     case glslang::EOpSubgroupPartitionedMax:
7892     case glslang::EOpSubgroupPartitionedInclusiveMax:
7893     case glslang::EOpSubgroupPartitionedExclusiveMax:
7894         if (isFloat) {
7895             opCode = spv::OpGroupNonUniformFMax;
7896         } else if (isUnsigned) {
7897             opCode = spv::OpGroupNonUniformUMax;
7898         } else {
7899             opCode = spv::OpGroupNonUniformSMax;
7900         }
7901         break;
7902     case glslang::EOpSubgroupAnd:
7903     case glslang::EOpSubgroupInclusiveAnd:
7904     case glslang::EOpSubgroupExclusiveAnd:
7905     case glslang::EOpSubgroupClusteredAnd:
7906     case glslang::EOpSubgroupPartitionedAnd:
7907     case glslang::EOpSubgroupPartitionedInclusiveAnd:
7908     case glslang::EOpSubgroupPartitionedExclusiveAnd:
7909         if (isBool) {
7910             opCode = spv::OpGroupNonUniformLogicalAnd;
7911         } else {
7912             opCode = spv::OpGroupNonUniformBitwiseAnd;
7913         }
7914         break;
7915     case glslang::EOpSubgroupOr:
7916     case glslang::EOpSubgroupInclusiveOr:
7917     case glslang::EOpSubgroupExclusiveOr:
7918     case glslang::EOpSubgroupClusteredOr:
7919     case glslang::EOpSubgroupPartitionedOr:
7920     case glslang::EOpSubgroupPartitionedInclusiveOr:
7921     case glslang::EOpSubgroupPartitionedExclusiveOr:
7922         if (isBool) {
7923             opCode = spv::OpGroupNonUniformLogicalOr;
7924         } else {
7925             opCode = spv::OpGroupNonUniformBitwiseOr;
7926         }
7927         break;
7928     case glslang::EOpSubgroupXor:
7929     case glslang::EOpSubgroupInclusiveXor:
7930     case glslang::EOpSubgroupExclusiveXor:
7931     case glslang::EOpSubgroupClusteredXor:
7932     case glslang::EOpSubgroupPartitionedXor:
7933     case glslang::EOpSubgroupPartitionedInclusiveXor:
7934     case glslang::EOpSubgroupPartitionedExclusiveXor:
7935         if (isBool) {
7936             opCode = spv::OpGroupNonUniformLogicalXor;
7937         } else {
7938             opCode = spv::OpGroupNonUniformBitwiseXor;
7939         }
7940         break;
7941     case glslang::EOpSubgroupQuadBroadcast:      opCode = spv::OpGroupNonUniformQuadBroadcast; break;
7942     case glslang::EOpSubgroupQuadSwapHorizontal:
7943     case glslang::EOpSubgroupQuadSwapVertical:
7944     case glslang::EOpSubgroupQuadSwapDiagonal:   opCode = spv::OpGroupNonUniformQuadSwap; break;
7945     default: assert(0 && "Unhandled subgroup operation!");
7946     }
7947 
7948     // get the right Group Operation
7949     spv::GroupOperation groupOperation = spv::GroupOperationMax;
7950     switch (op) {
7951     default:
7952         break;
7953     case glslang::EOpSubgroupBallotBitCount:
7954     case glslang::EOpSubgroupAdd:
7955     case glslang::EOpSubgroupMul:
7956     case glslang::EOpSubgroupMin:
7957     case glslang::EOpSubgroupMax:
7958     case glslang::EOpSubgroupAnd:
7959     case glslang::EOpSubgroupOr:
7960     case glslang::EOpSubgroupXor:
7961         groupOperation = spv::GroupOperationReduce;
7962         break;
7963     case glslang::EOpSubgroupBallotInclusiveBitCount:
7964     case glslang::EOpSubgroupInclusiveAdd:
7965     case glslang::EOpSubgroupInclusiveMul:
7966     case glslang::EOpSubgroupInclusiveMin:
7967     case glslang::EOpSubgroupInclusiveMax:
7968     case glslang::EOpSubgroupInclusiveAnd:
7969     case glslang::EOpSubgroupInclusiveOr:
7970     case glslang::EOpSubgroupInclusiveXor:
7971         groupOperation = spv::GroupOperationInclusiveScan;
7972         break;
7973     case glslang::EOpSubgroupBallotExclusiveBitCount:
7974     case glslang::EOpSubgroupExclusiveAdd:
7975     case glslang::EOpSubgroupExclusiveMul:
7976     case glslang::EOpSubgroupExclusiveMin:
7977     case glslang::EOpSubgroupExclusiveMax:
7978     case glslang::EOpSubgroupExclusiveAnd:
7979     case glslang::EOpSubgroupExclusiveOr:
7980     case glslang::EOpSubgroupExclusiveXor:
7981         groupOperation = spv::GroupOperationExclusiveScan;
7982         break;
7983     case glslang::EOpSubgroupClusteredAdd:
7984     case glslang::EOpSubgroupClusteredMul:
7985     case glslang::EOpSubgroupClusteredMin:
7986     case glslang::EOpSubgroupClusteredMax:
7987     case glslang::EOpSubgroupClusteredAnd:
7988     case glslang::EOpSubgroupClusteredOr:
7989     case glslang::EOpSubgroupClusteredXor:
7990         groupOperation = spv::GroupOperationClusteredReduce;
7991         break;
7992     case glslang::EOpSubgroupPartitionedAdd:
7993     case glslang::EOpSubgroupPartitionedMul:
7994     case glslang::EOpSubgroupPartitionedMin:
7995     case glslang::EOpSubgroupPartitionedMax:
7996     case glslang::EOpSubgroupPartitionedAnd:
7997     case glslang::EOpSubgroupPartitionedOr:
7998     case glslang::EOpSubgroupPartitionedXor:
7999         groupOperation = spv::GroupOperationPartitionedReduceNV;
8000         break;
8001     case glslang::EOpSubgroupPartitionedInclusiveAdd:
8002     case glslang::EOpSubgroupPartitionedInclusiveMul:
8003     case glslang::EOpSubgroupPartitionedInclusiveMin:
8004     case glslang::EOpSubgroupPartitionedInclusiveMax:
8005     case glslang::EOpSubgroupPartitionedInclusiveAnd:
8006     case glslang::EOpSubgroupPartitionedInclusiveOr:
8007     case glslang::EOpSubgroupPartitionedInclusiveXor:
8008         groupOperation = spv::GroupOperationPartitionedInclusiveScanNV;
8009         break;
8010     case glslang::EOpSubgroupPartitionedExclusiveAdd:
8011     case glslang::EOpSubgroupPartitionedExclusiveMul:
8012     case glslang::EOpSubgroupPartitionedExclusiveMin:
8013     case glslang::EOpSubgroupPartitionedExclusiveMax:
8014     case glslang::EOpSubgroupPartitionedExclusiveAnd:
8015     case glslang::EOpSubgroupPartitionedExclusiveOr:
8016     case glslang::EOpSubgroupPartitionedExclusiveXor:
8017         groupOperation = spv::GroupOperationPartitionedExclusiveScanNV;
8018         break;
8019     }
8020 
8021     // build the instruction
8022     std::vector<spv::IdImmediate> spvGroupOperands;
8023 
8024     // Every operation begins with the Execution Scope operand.
8025     spv::IdImmediate executionScope = { true, builder.makeUintConstant(spv::ScopeSubgroup) };
8026     spvGroupOperands.push_back(executionScope);
8027 
8028     // Next, for all operations that use a Group Operation, push that as an operand.
8029     if (groupOperation != spv::GroupOperationMax) {
8030         spv::IdImmediate groupOperand = { false, (unsigned)groupOperation };
8031         spvGroupOperands.push_back(groupOperand);
8032     }
8033 
8034     // Push back the operands next.
8035     for (auto opIt = operands.cbegin(); opIt != operands.cend(); ++opIt) {
8036         spv::IdImmediate operand = { true, *opIt };
8037         spvGroupOperands.push_back(operand);
8038     }
8039 
8040     // Some opcodes have additional operands.
8041     spv::Id directionId = spv::NoResult;
8042     switch (op) {
8043     default: break;
8044     case glslang::EOpSubgroupQuadSwapHorizontal: directionId = builder.makeUintConstant(0); break;
8045     case glslang::EOpSubgroupQuadSwapVertical:   directionId = builder.makeUintConstant(1); break;
8046     case glslang::EOpSubgroupQuadSwapDiagonal:   directionId = builder.makeUintConstant(2); break;
8047     }
8048     if (directionId != spv::NoResult) {
8049         spv::IdImmediate direction = { true, directionId };
8050         spvGroupOperands.push_back(direction);
8051     }
8052 
8053     return builder.createOp(opCode, typeId, spvGroupOperands);
8054 }
8055 
createMiscOperation(glslang::TOperator op,spv::Decoration precision,spv::Id typeId,std::vector<spv::Id> & operands,glslang::TBasicType typeProxy)8056 spv::Id TGlslangToSpvTraverser::createMiscOperation(glslang::TOperator op, spv::Decoration precision,
8057     spv::Id typeId, std::vector<spv::Id>& operands, glslang::TBasicType typeProxy)
8058 {
8059     bool isUnsigned = isTypeUnsignedInt(typeProxy);
8060     bool isFloat = isTypeFloat(typeProxy);
8061 
8062     spv::Op opCode = spv::OpNop;
8063     int extBuiltins = -1;
8064     int libCall = -1;
8065     size_t consumedOperands = operands.size();
8066     spv::Id typeId0 = 0;
8067     if (consumedOperands > 0)
8068         typeId0 = builder.getTypeId(operands[0]);
8069     spv::Id typeId1 = 0;
8070     if (consumedOperands > 1)
8071         typeId1 = builder.getTypeId(operands[1]);
8072     spv::Id frexpIntType = 0;
8073 
8074     switch (op) {
8075     case glslang::EOpMin:
8076         if (isFloat)
8077             libCall = nanMinMaxClamp ? spv::GLSLstd450NMin : spv::GLSLstd450FMin;
8078         else if (isUnsigned)
8079             libCall = spv::GLSLstd450UMin;
8080         else
8081             libCall = spv::GLSLstd450SMin;
8082         builder.promoteScalar(precision, operands.front(), operands.back());
8083         break;
8084     case glslang::EOpModf:
8085         libCall = spv::GLSLstd450Modf;
8086         break;
8087     case glslang::EOpMax:
8088         if (isFloat)
8089             libCall = nanMinMaxClamp ? spv::GLSLstd450NMax : spv::GLSLstd450FMax;
8090         else if (isUnsigned)
8091             libCall = spv::GLSLstd450UMax;
8092         else
8093             libCall = spv::GLSLstd450SMax;
8094         builder.promoteScalar(precision, operands.front(), operands.back());
8095         break;
8096     case glslang::EOpPow:
8097         libCall = spv::GLSLstd450Pow;
8098         break;
8099     case glslang::EOpDot:
8100         opCode = spv::OpDot;
8101         break;
8102     case glslang::EOpAtan:
8103         libCall = spv::GLSLstd450Atan2;
8104         break;
8105 
8106     case glslang::EOpClamp:
8107         if (isFloat)
8108             libCall = nanMinMaxClamp ? spv::GLSLstd450NClamp : spv::GLSLstd450FClamp;
8109         else if (isUnsigned)
8110             libCall = spv::GLSLstd450UClamp;
8111         else
8112             libCall = spv::GLSLstd450SClamp;
8113         builder.promoteScalar(precision, operands.front(), operands[1]);
8114         builder.promoteScalar(precision, operands.front(), operands[2]);
8115         break;
8116     case glslang::EOpMix:
8117         if (! builder.isBoolType(builder.getScalarTypeId(builder.getTypeId(operands.back())))) {
8118             assert(isFloat);
8119             libCall = spv::GLSLstd450FMix;
8120         } else {
8121             opCode = spv::OpSelect;
8122             std::swap(operands.front(), operands.back());
8123         }
8124         builder.promoteScalar(precision, operands.front(), operands.back());
8125         break;
8126     case glslang::EOpStep:
8127         libCall = spv::GLSLstd450Step;
8128         builder.promoteScalar(precision, operands.front(), operands.back());
8129         break;
8130     case glslang::EOpSmoothStep:
8131         libCall = spv::GLSLstd450SmoothStep;
8132         builder.promoteScalar(precision, operands[0], operands[2]);
8133         builder.promoteScalar(precision, operands[1], operands[2]);
8134         break;
8135 
8136     case glslang::EOpDistance:
8137         libCall = spv::GLSLstd450Distance;
8138         break;
8139     case glslang::EOpCross:
8140         libCall = spv::GLSLstd450Cross;
8141         break;
8142     case glslang::EOpFaceForward:
8143         libCall = spv::GLSLstd450FaceForward;
8144         break;
8145     case glslang::EOpReflect:
8146         libCall = spv::GLSLstd450Reflect;
8147         break;
8148     case glslang::EOpRefract:
8149         libCall = spv::GLSLstd450Refract;
8150         break;
8151     case glslang::EOpBarrier:
8152         {
8153             // This is for the extended controlBarrier function, with four operands.
8154             // The unextended barrier() goes through createNoArgOperation.
8155             assert(operands.size() == 4);
8156             unsigned int executionScope = builder.getConstantScalar(operands[0]);
8157             unsigned int memoryScope = builder.getConstantScalar(operands[1]);
8158             unsigned int semantics = builder.getConstantScalar(operands[2]) | builder.getConstantScalar(operands[3]);
8159             builder.createControlBarrier((spv::Scope)executionScope, (spv::Scope)memoryScope,
8160                 (spv::MemorySemanticsMask)semantics);
8161             if (semantics & (spv::MemorySemanticsMakeAvailableKHRMask |
8162                              spv::MemorySemanticsMakeVisibleKHRMask |
8163                              spv::MemorySemanticsOutputMemoryKHRMask |
8164                              spv::MemorySemanticsVolatileMask)) {
8165                 builder.addCapability(spv::CapabilityVulkanMemoryModelKHR);
8166             }
8167             if (glslangIntermediate->usingVulkanMemoryModel() && (executionScope == spv::ScopeDevice ||
8168                 memoryScope == spv::ScopeDevice)) {
8169                 builder.addCapability(spv::CapabilityVulkanMemoryModelDeviceScopeKHR);
8170             }
8171             return 0;
8172         }
8173         break;
8174     case glslang::EOpMemoryBarrier:
8175         {
8176             // This is for the extended memoryBarrier function, with three operands.
8177             // The unextended memoryBarrier() goes through createNoArgOperation.
8178             assert(operands.size() == 3);
8179             unsigned int memoryScope = builder.getConstantScalar(operands[0]);
8180             unsigned int semantics = builder.getConstantScalar(operands[1]) | builder.getConstantScalar(operands[2]);
8181             builder.createMemoryBarrier((spv::Scope)memoryScope, (spv::MemorySemanticsMask)semantics);
8182             if (semantics & (spv::MemorySemanticsMakeAvailableKHRMask |
8183                              spv::MemorySemanticsMakeVisibleKHRMask |
8184                              spv::MemorySemanticsOutputMemoryKHRMask |
8185                              spv::MemorySemanticsVolatileMask)) {
8186                 builder.addCapability(spv::CapabilityVulkanMemoryModelKHR);
8187             }
8188             if (glslangIntermediate->usingVulkanMemoryModel() && memoryScope == spv::ScopeDevice) {
8189                 builder.addCapability(spv::CapabilityVulkanMemoryModelDeviceScopeKHR);
8190             }
8191             return 0;
8192         }
8193         break;
8194 
8195 #ifndef GLSLANG_WEB
8196     case glslang::EOpInterpolateAtSample:
8197         if (typeProxy == glslang::EbtFloat16)
8198             builder.addExtension(spv::E_SPV_AMD_gpu_shader_half_float);
8199         libCall = spv::GLSLstd450InterpolateAtSample;
8200         break;
8201     case glslang::EOpInterpolateAtOffset:
8202         if (typeProxy == glslang::EbtFloat16)
8203             builder.addExtension(spv::E_SPV_AMD_gpu_shader_half_float);
8204         libCall = spv::GLSLstd450InterpolateAtOffset;
8205         break;
8206     case glslang::EOpAddCarry:
8207         opCode = spv::OpIAddCarry;
8208         typeId = builder.makeStructResultType(typeId0, typeId0);
8209         consumedOperands = 2;
8210         break;
8211     case glslang::EOpSubBorrow:
8212         opCode = spv::OpISubBorrow;
8213         typeId = builder.makeStructResultType(typeId0, typeId0);
8214         consumedOperands = 2;
8215         break;
8216     case glslang::EOpUMulExtended:
8217         opCode = spv::OpUMulExtended;
8218         typeId = builder.makeStructResultType(typeId0, typeId0);
8219         consumedOperands = 2;
8220         break;
8221     case glslang::EOpIMulExtended:
8222         opCode = spv::OpSMulExtended;
8223         typeId = builder.makeStructResultType(typeId0, typeId0);
8224         consumedOperands = 2;
8225         break;
8226     case glslang::EOpBitfieldExtract:
8227         if (isUnsigned)
8228             opCode = spv::OpBitFieldUExtract;
8229         else
8230             opCode = spv::OpBitFieldSExtract;
8231         break;
8232     case glslang::EOpBitfieldInsert:
8233         opCode = spv::OpBitFieldInsert;
8234         break;
8235 
8236     case glslang::EOpFma:
8237         libCall = spv::GLSLstd450Fma;
8238         break;
8239     case glslang::EOpFrexp:
8240         {
8241             libCall = spv::GLSLstd450FrexpStruct;
8242             assert(builder.isPointerType(typeId1));
8243             typeId1 = builder.getContainedTypeId(typeId1);
8244             int width = builder.getScalarTypeWidth(typeId1);
8245             if (width == 16)
8246                 // Using 16-bit exp operand, enable extension SPV_AMD_gpu_shader_int16
8247                 builder.addExtension(spv::E_SPV_AMD_gpu_shader_int16);
8248             if (builder.getNumComponents(operands[0]) == 1)
8249                 frexpIntType = builder.makeIntegerType(width, true);
8250             else
8251                 frexpIntType = builder.makeVectorType(builder.makeIntegerType(width, true),
8252                     builder.getNumComponents(operands[0]));
8253             typeId = builder.makeStructResultType(typeId0, frexpIntType);
8254             consumedOperands = 1;
8255         }
8256         break;
8257     case glslang::EOpLdexp:
8258         libCall = spv::GLSLstd450Ldexp;
8259         break;
8260 
8261     case glslang::EOpReadInvocation:
8262         return createInvocationsOperation(op, typeId, operands, typeProxy);
8263 
8264     case glslang::EOpSubgroupBroadcast:
8265     case glslang::EOpSubgroupBallotBitExtract:
8266     case glslang::EOpSubgroupShuffle:
8267     case glslang::EOpSubgroupShuffleXor:
8268     case glslang::EOpSubgroupShuffleUp:
8269     case glslang::EOpSubgroupShuffleDown:
8270     case glslang::EOpSubgroupClusteredAdd:
8271     case glslang::EOpSubgroupClusteredMul:
8272     case glslang::EOpSubgroupClusteredMin:
8273     case glslang::EOpSubgroupClusteredMax:
8274     case glslang::EOpSubgroupClusteredAnd:
8275     case glslang::EOpSubgroupClusteredOr:
8276     case glslang::EOpSubgroupClusteredXor:
8277     case glslang::EOpSubgroupQuadBroadcast:
8278     case glslang::EOpSubgroupPartitionedAdd:
8279     case glslang::EOpSubgroupPartitionedMul:
8280     case glslang::EOpSubgroupPartitionedMin:
8281     case glslang::EOpSubgroupPartitionedMax:
8282     case glslang::EOpSubgroupPartitionedAnd:
8283     case glslang::EOpSubgroupPartitionedOr:
8284     case glslang::EOpSubgroupPartitionedXor:
8285     case glslang::EOpSubgroupPartitionedInclusiveAdd:
8286     case glslang::EOpSubgroupPartitionedInclusiveMul:
8287     case glslang::EOpSubgroupPartitionedInclusiveMin:
8288     case glslang::EOpSubgroupPartitionedInclusiveMax:
8289     case glslang::EOpSubgroupPartitionedInclusiveAnd:
8290     case glslang::EOpSubgroupPartitionedInclusiveOr:
8291     case glslang::EOpSubgroupPartitionedInclusiveXor:
8292     case glslang::EOpSubgroupPartitionedExclusiveAdd:
8293     case glslang::EOpSubgroupPartitionedExclusiveMul:
8294     case glslang::EOpSubgroupPartitionedExclusiveMin:
8295     case glslang::EOpSubgroupPartitionedExclusiveMax:
8296     case glslang::EOpSubgroupPartitionedExclusiveAnd:
8297     case glslang::EOpSubgroupPartitionedExclusiveOr:
8298     case glslang::EOpSubgroupPartitionedExclusiveXor:
8299         return createSubgroupOperation(op, typeId, operands, typeProxy);
8300 
8301     case glslang::EOpSwizzleInvocations:
8302         extBuiltins = getExtBuiltins(spv::E_SPV_AMD_shader_ballot);
8303         libCall = spv::SwizzleInvocationsAMD;
8304         break;
8305     case glslang::EOpSwizzleInvocationsMasked:
8306         extBuiltins = getExtBuiltins(spv::E_SPV_AMD_shader_ballot);
8307         libCall = spv::SwizzleInvocationsMaskedAMD;
8308         break;
8309     case glslang::EOpWriteInvocation:
8310         extBuiltins = getExtBuiltins(spv::E_SPV_AMD_shader_ballot);
8311         libCall = spv::WriteInvocationAMD;
8312         break;
8313 
8314     case glslang::EOpMin3:
8315         extBuiltins = getExtBuiltins(spv::E_SPV_AMD_shader_trinary_minmax);
8316         if (isFloat)
8317             libCall = spv::FMin3AMD;
8318         else {
8319             if (isUnsigned)
8320                 libCall = spv::UMin3AMD;
8321             else
8322                 libCall = spv::SMin3AMD;
8323         }
8324         break;
8325     case glslang::EOpMax3:
8326         extBuiltins = getExtBuiltins(spv::E_SPV_AMD_shader_trinary_minmax);
8327         if (isFloat)
8328             libCall = spv::FMax3AMD;
8329         else {
8330             if (isUnsigned)
8331                 libCall = spv::UMax3AMD;
8332             else
8333                 libCall = spv::SMax3AMD;
8334         }
8335         break;
8336     case glslang::EOpMid3:
8337         extBuiltins = getExtBuiltins(spv::E_SPV_AMD_shader_trinary_minmax);
8338         if (isFloat)
8339             libCall = spv::FMid3AMD;
8340         else {
8341             if (isUnsigned)
8342                 libCall = spv::UMid3AMD;
8343             else
8344                 libCall = spv::SMid3AMD;
8345         }
8346         break;
8347 
8348     case glslang::EOpInterpolateAtVertex:
8349         if (typeProxy == glslang::EbtFloat16)
8350             builder.addExtension(spv::E_SPV_AMD_gpu_shader_half_float);
8351         extBuiltins = getExtBuiltins(spv::E_SPV_AMD_shader_explicit_vertex_parameter);
8352         libCall = spv::InterpolateAtVertexAMD;
8353         break;
8354 
8355     case glslang::EOpReportIntersection:
8356         typeId = builder.makeBoolType();
8357         opCode = spv::OpReportIntersectionKHR;
8358         break;
8359     case glslang::EOpTraceNV:
8360         builder.createNoResultOp(spv::OpTraceNV, operands);
8361         return 0;
8362     case glslang::EOpTraceRayMotionNV:
8363         builder.addExtension(spv::E_SPV_NV_ray_tracing_motion_blur);
8364         builder.addCapability(spv::CapabilityRayTracingMotionBlurNV);
8365         builder.createNoResultOp(spv::OpTraceRayMotionNV, operands);
8366         return 0;
8367     case glslang::EOpTraceKHR:
8368         builder.createNoResultOp(spv::OpTraceRayKHR, operands);
8369         return 0;
8370     case glslang::EOpExecuteCallableNV:
8371         builder.createNoResultOp(spv::OpExecuteCallableNV, operands);
8372         return 0;
8373     case glslang::EOpExecuteCallableKHR:
8374         builder.createNoResultOp(spv::OpExecuteCallableKHR, operands);
8375         return 0;
8376 
8377     case glslang::EOpRayQueryInitialize:
8378         builder.createNoResultOp(spv::OpRayQueryInitializeKHR, operands);
8379         return 0;
8380     case glslang::EOpRayQueryTerminate:
8381         builder.createNoResultOp(spv::OpRayQueryTerminateKHR, operands);
8382         return 0;
8383     case glslang::EOpRayQueryGenerateIntersection:
8384         builder.createNoResultOp(spv::OpRayQueryGenerateIntersectionKHR, operands);
8385         return 0;
8386     case glslang::EOpRayQueryConfirmIntersection:
8387         builder.createNoResultOp(spv::OpRayQueryConfirmIntersectionKHR, operands);
8388         return 0;
8389     case glslang::EOpRayQueryProceed:
8390         typeId = builder.makeBoolType();
8391         opCode = spv::OpRayQueryProceedKHR;
8392         break;
8393     case glslang::EOpRayQueryGetIntersectionType:
8394         typeId = builder.makeUintType(32);
8395         opCode = spv::OpRayQueryGetIntersectionTypeKHR;
8396         break;
8397     case glslang::EOpRayQueryGetRayTMin:
8398         typeId = builder.makeFloatType(32);
8399         opCode = spv::OpRayQueryGetRayTMinKHR;
8400         break;
8401     case glslang::EOpRayQueryGetRayFlags:
8402         typeId = builder.makeIntType(32);
8403         opCode = spv::OpRayQueryGetRayFlagsKHR;
8404         break;
8405     case glslang::EOpRayQueryGetIntersectionT:
8406         typeId = builder.makeFloatType(32);
8407         opCode = spv::OpRayQueryGetIntersectionTKHR;
8408         break;
8409     case glslang::EOpRayQueryGetIntersectionInstanceCustomIndex:
8410         typeId = builder.makeIntType(32);
8411         opCode = spv::OpRayQueryGetIntersectionInstanceCustomIndexKHR;
8412         break;
8413     case glslang::EOpRayQueryGetIntersectionInstanceId:
8414         typeId = builder.makeIntType(32);
8415         opCode = spv::OpRayQueryGetIntersectionInstanceIdKHR;
8416         break;
8417     case glslang::EOpRayQueryGetIntersectionInstanceShaderBindingTableRecordOffset:
8418         typeId = builder.makeUintType(32);
8419         opCode = spv::OpRayQueryGetIntersectionInstanceShaderBindingTableRecordOffsetKHR;
8420         break;
8421     case glslang::EOpRayQueryGetIntersectionGeometryIndex:
8422         typeId = builder.makeIntType(32);
8423         opCode = spv::OpRayQueryGetIntersectionGeometryIndexKHR;
8424         break;
8425     case glslang::EOpRayQueryGetIntersectionPrimitiveIndex:
8426         typeId = builder.makeIntType(32);
8427         opCode = spv::OpRayQueryGetIntersectionPrimitiveIndexKHR;
8428         break;
8429     case glslang::EOpRayQueryGetIntersectionBarycentrics:
8430         typeId = builder.makeVectorType(builder.makeFloatType(32), 2);
8431         opCode = spv::OpRayQueryGetIntersectionBarycentricsKHR;
8432         break;
8433     case glslang::EOpRayQueryGetIntersectionFrontFace:
8434         typeId = builder.makeBoolType();
8435         opCode = spv::OpRayQueryGetIntersectionFrontFaceKHR;
8436         break;
8437     case glslang::EOpRayQueryGetIntersectionCandidateAABBOpaque:
8438         typeId = builder.makeBoolType();
8439         opCode = spv::OpRayQueryGetIntersectionCandidateAABBOpaqueKHR;
8440         break;
8441     case glslang::EOpRayQueryGetIntersectionObjectRayDirection:
8442         typeId = builder.makeVectorType(builder.makeFloatType(32), 3);
8443         opCode = spv::OpRayQueryGetIntersectionObjectRayDirectionKHR;
8444         break;
8445     case glslang::EOpRayQueryGetIntersectionObjectRayOrigin:
8446         typeId = builder.makeVectorType(builder.makeFloatType(32), 3);
8447         opCode = spv::OpRayQueryGetIntersectionObjectRayOriginKHR;
8448         break;
8449     case glslang::EOpRayQueryGetWorldRayDirection:
8450         typeId = builder.makeVectorType(builder.makeFloatType(32), 3);
8451         opCode = spv::OpRayQueryGetWorldRayDirectionKHR;
8452         break;
8453     case glslang::EOpRayQueryGetWorldRayOrigin:
8454         typeId = builder.makeVectorType(builder.makeFloatType(32), 3);
8455         opCode = spv::OpRayQueryGetWorldRayOriginKHR;
8456         break;
8457     case glslang::EOpRayQueryGetIntersectionObjectToWorld:
8458         typeId = builder.makeMatrixType(builder.makeFloatType(32), 4, 3);
8459         opCode = spv::OpRayQueryGetIntersectionObjectToWorldKHR;
8460         break;
8461     case glslang::EOpRayQueryGetIntersectionWorldToObject:
8462         typeId = builder.makeMatrixType(builder.makeFloatType(32), 4, 3);
8463         opCode = spv::OpRayQueryGetIntersectionWorldToObjectKHR;
8464         break;
8465     case glslang::EOpWritePackedPrimitiveIndices4x8NV:
8466         builder.createNoResultOp(spv::OpWritePackedPrimitiveIndices4x8NV, operands);
8467         return 0;
8468     case glslang::EOpCooperativeMatrixMulAdd:
8469         opCode = spv::OpCooperativeMatrixMulAddNV;
8470         break;
8471 #endif // GLSLANG_WEB
8472     default:
8473         return 0;
8474     }
8475 
8476     spv::Id id = 0;
8477     if (libCall >= 0) {
8478         // Use an extended instruction from the standard library.
8479         // Construct the call arguments, without modifying the original operands vector.
8480         // We might need the remaining arguments, e.g. in the EOpFrexp case.
8481         std::vector<spv::Id> callArguments(operands.begin(), operands.begin() + consumedOperands);
8482         id = builder.createBuiltinCall(typeId, extBuiltins >= 0 ? extBuiltins : stdBuiltins, libCall, callArguments);
8483     } else if (opCode == spv::OpDot && !isFloat) {
8484         // int dot(int, int)
8485         // NOTE: never called for scalar/vector1, this is turned into simple mul before this can be reached
8486         const int componentCount = builder.getNumComponents(operands[0]);
8487         spv::Id mulOp = builder.createBinOp(spv::OpIMul, builder.getTypeId(operands[0]), operands[0], operands[1]);
8488         builder.setPrecision(mulOp, precision);
8489         id = builder.createCompositeExtract(mulOp, typeId, 0);
8490         for (int i = 1; i < componentCount; ++i) {
8491             builder.setPrecision(id, precision);
8492             id = builder.createBinOp(spv::OpIAdd, typeId, id, builder.createCompositeExtract(mulOp, typeId, i));
8493         }
8494     } else {
8495         switch (consumedOperands) {
8496         case 0:
8497             // should all be handled by visitAggregate and createNoArgOperation
8498             assert(0);
8499             return 0;
8500         case 1:
8501             // should all be handled by createUnaryOperation
8502             assert(0);
8503             return 0;
8504         case 2:
8505             id = builder.createBinOp(opCode, typeId, operands[0], operands[1]);
8506             break;
8507         default:
8508             // anything 3 or over doesn't have l-value operands, so all should be consumed
8509             assert(consumedOperands == operands.size());
8510             id = builder.createOp(opCode, typeId, operands);
8511             break;
8512         }
8513     }
8514 
8515 #ifndef GLSLANG_WEB
8516     // Decode the return types that were structures
8517     switch (op) {
8518     case glslang::EOpAddCarry:
8519     case glslang::EOpSubBorrow:
8520         builder.createStore(builder.createCompositeExtract(id, typeId0, 1), operands[2]);
8521         id = builder.createCompositeExtract(id, typeId0, 0);
8522         break;
8523     case glslang::EOpUMulExtended:
8524     case glslang::EOpIMulExtended:
8525         builder.createStore(builder.createCompositeExtract(id, typeId0, 0), operands[3]);
8526         builder.createStore(builder.createCompositeExtract(id, typeId0, 1), operands[2]);
8527         break;
8528     case glslang::EOpFrexp:
8529         {
8530             assert(operands.size() == 2);
8531             if (builder.isFloatType(builder.getScalarTypeId(typeId1))) {
8532                 // "exp" is floating-point type (from HLSL intrinsic)
8533                 spv::Id member1 = builder.createCompositeExtract(id, frexpIntType, 1);
8534                 member1 = builder.createUnaryOp(spv::OpConvertSToF, typeId1, member1);
8535                 builder.createStore(member1, operands[1]);
8536             } else
8537                 // "exp" is integer type (from GLSL built-in function)
8538                 builder.createStore(builder.createCompositeExtract(id, frexpIntType, 1), operands[1]);
8539             id = builder.createCompositeExtract(id, typeId0, 0);
8540         }
8541         break;
8542     default:
8543         break;
8544     }
8545 #endif
8546 
8547     return builder.setPrecision(id, precision);
8548 }
8549 
8550 // Intrinsics with no arguments (or no return value, and no precision).
createNoArgOperation(glslang::TOperator op,spv::Decoration precision,spv::Id typeId)8551 spv::Id TGlslangToSpvTraverser::createNoArgOperation(glslang::TOperator op, spv::Decoration precision, spv::Id typeId)
8552 {
8553     // GLSL memory barriers use queuefamily scope in new model, device scope in old model
8554     spv::Scope memoryBarrierScope = glslangIntermediate->usingVulkanMemoryModel() ?
8555         spv::ScopeQueueFamilyKHR : spv::ScopeDevice;
8556 
8557     switch (op) {
8558     case glslang::EOpBarrier:
8559         if (glslangIntermediate->getStage() == EShLangTessControl) {
8560             if (glslangIntermediate->usingVulkanMemoryModel()) {
8561                 builder.createControlBarrier(spv::ScopeWorkgroup, spv::ScopeWorkgroup,
8562                                              spv::MemorySemanticsOutputMemoryKHRMask |
8563                                              spv::MemorySemanticsAcquireReleaseMask);
8564                 builder.addCapability(spv::CapabilityVulkanMemoryModelKHR);
8565             } else {
8566                 builder.createControlBarrier(spv::ScopeWorkgroup, spv::ScopeInvocation, spv::MemorySemanticsMaskNone);
8567             }
8568         } else {
8569             builder.createControlBarrier(spv::ScopeWorkgroup, spv::ScopeWorkgroup,
8570                                             spv::MemorySemanticsWorkgroupMemoryMask |
8571                                             spv::MemorySemanticsAcquireReleaseMask);
8572         }
8573         return 0;
8574     case glslang::EOpMemoryBarrier:
8575         builder.createMemoryBarrier(memoryBarrierScope, spv::MemorySemanticsAllMemory |
8576                                                         spv::MemorySemanticsAcquireReleaseMask);
8577         return 0;
8578     case glslang::EOpMemoryBarrierBuffer:
8579         builder.createMemoryBarrier(memoryBarrierScope, spv::MemorySemanticsUniformMemoryMask |
8580                                                         spv::MemorySemanticsAcquireReleaseMask);
8581         return 0;
8582     case glslang::EOpMemoryBarrierShared:
8583         builder.createMemoryBarrier(memoryBarrierScope, spv::MemorySemanticsWorkgroupMemoryMask |
8584                                                         spv::MemorySemanticsAcquireReleaseMask);
8585         return 0;
8586     case glslang::EOpGroupMemoryBarrier:
8587         builder.createMemoryBarrier(spv::ScopeWorkgroup, spv::MemorySemanticsAllMemory |
8588                                                          spv::MemorySemanticsAcquireReleaseMask);
8589         return 0;
8590 #ifndef GLSLANG_WEB
8591     case glslang::EOpMemoryBarrierAtomicCounter:
8592         builder.createMemoryBarrier(memoryBarrierScope, spv::MemorySemanticsAtomicCounterMemoryMask |
8593                                                         spv::MemorySemanticsAcquireReleaseMask);
8594         return 0;
8595     case glslang::EOpMemoryBarrierImage:
8596         builder.createMemoryBarrier(memoryBarrierScope, spv::MemorySemanticsImageMemoryMask |
8597                                                         spv::MemorySemanticsAcquireReleaseMask);
8598         return 0;
8599     case glslang::EOpAllMemoryBarrierWithGroupSync:
8600         builder.createControlBarrier(spv::ScopeWorkgroup, spv::ScopeDevice,
8601                                         spv::MemorySemanticsAllMemory |
8602                                         spv::MemorySemanticsAcquireReleaseMask);
8603         return 0;
8604     case glslang::EOpDeviceMemoryBarrier:
8605         builder.createMemoryBarrier(spv::ScopeDevice, spv::MemorySemanticsUniformMemoryMask |
8606                                                       spv::MemorySemanticsImageMemoryMask |
8607                                                       spv::MemorySemanticsAcquireReleaseMask);
8608         return 0;
8609     case glslang::EOpDeviceMemoryBarrierWithGroupSync:
8610         builder.createControlBarrier(spv::ScopeWorkgroup, spv::ScopeDevice, spv::MemorySemanticsUniformMemoryMask |
8611                                                                             spv::MemorySemanticsImageMemoryMask |
8612                                                                             spv::MemorySemanticsAcquireReleaseMask);
8613         return 0;
8614     case glslang::EOpWorkgroupMemoryBarrier:
8615         builder.createMemoryBarrier(spv::ScopeWorkgroup, spv::MemorySemanticsWorkgroupMemoryMask |
8616                                                          spv::MemorySemanticsAcquireReleaseMask);
8617         return 0;
8618     case glslang::EOpWorkgroupMemoryBarrierWithGroupSync:
8619         builder.createControlBarrier(spv::ScopeWorkgroup, spv::ScopeWorkgroup,
8620                                         spv::MemorySemanticsWorkgroupMemoryMask |
8621                                         spv::MemorySemanticsAcquireReleaseMask);
8622         return 0;
8623     case glslang::EOpSubgroupBarrier:
8624         builder.createControlBarrier(spv::ScopeSubgroup, spv::ScopeSubgroup, spv::MemorySemanticsAllMemory |
8625                                                                              spv::MemorySemanticsAcquireReleaseMask);
8626         return spv::NoResult;
8627     case glslang::EOpSubgroupMemoryBarrier:
8628         builder.createMemoryBarrier(spv::ScopeSubgroup, spv::MemorySemanticsAllMemory |
8629                                                         spv::MemorySemanticsAcquireReleaseMask);
8630         return spv::NoResult;
8631     case glslang::EOpSubgroupMemoryBarrierBuffer:
8632         builder.createMemoryBarrier(spv::ScopeSubgroup, spv::MemorySemanticsUniformMemoryMask |
8633                                                         spv::MemorySemanticsAcquireReleaseMask);
8634         return spv::NoResult;
8635     case glslang::EOpSubgroupMemoryBarrierImage:
8636         builder.createMemoryBarrier(spv::ScopeSubgroup, spv::MemorySemanticsImageMemoryMask |
8637                                                         spv::MemorySemanticsAcquireReleaseMask);
8638         return spv::NoResult;
8639     case glslang::EOpSubgroupMemoryBarrierShared:
8640         builder.createMemoryBarrier(spv::ScopeSubgroup, spv::MemorySemanticsWorkgroupMemoryMask |
8641                                                         spv::MemorySemanticsAcquireReleaseMask);
8642         return spv::NoResult;
8643 
8644     case glslang::EOpEmitVertex:
8645         builder.createNoResultOp(spv::OpEmitVertex);
8646         return 0;
8647     case glslang::EOpEndPrimitive:
8648         builder.createNoResultOp(spv::OpEndPrimitive);
8649         return 0;
8650 
8651     case glslang::EOpSubgroupElect: {
8652         std::vector<spv::Id> operands;
8653         return createSubgroupOperation(op, typeId, operands, glslang::EbtVoid);
8654     }
8655     case glslang::EOpTime:
8656     {
8657         std::vector<spv::Id> args; // Dummy arguments
8658         spv::Id id = builder.createBuiltinCall(typeId, getExtBuiltins(spv::E_SPV_AMD_gcn_shader), spv::TimeAMD, args);
8659         return builder.setPrecision(id, precision);
8660     }
8661     case glslang::EOpIgnoreIntersectionNV:
8662         builder.createNoResultOp(spv::OpIgnoreIntersectionNV);
8663         return 0;
8664     case glslang::EOpTerminateRayNV:
8665         builder.createNoResultOp(spv::OpTerminateRayNV);
8666         return 0;
8667     case glslang::EOpRayQueryInitialize:
8668         builder.createNoResultOp(spv::OpRayQueryInitializeKHR);
8669         return 0;
8670     case glslang::EOpRayQueryTerminate:
8671         builder.createNoResultOp(spv::OpRayQueryTerminateKHR);
8672         return 0;
8673     case glslang::EOpRayQueryGenerateIntersection:
8674         builder.createNoResultOp(spv::OpRayQueryGenerateIntersectionKHR);
8675         return 0;
8676     case glslang::EOpRayQueryConfirmIntersection:
8677         builder.createNoResultOp(spv::OpRayQueryConfirmIntersectionKHR);
8678         return 0;
8679     case glslang::EOpBeginInvocationInterlock:
8680         builder.createNoResultOp(spv::OpBeginInvocationInterlockEXT);
8681         return 0;
8682     case glslang::EOpEndInvocationInterlock:
8683         builder.createNoResultOp(spv::OpEndInvocationInterlockEXT);
8684         return 0;
8685 
8686     case glslang::EOpIsHelperInvocation:
8687     {
8688         std::vector<spv::Id> args; // Dummy arguments
8689         builder.addExtension(spv::E_SPV_EXT_demote_to_helper_invocation);
8690         builder.addCapability(spv::CapabilityDemoteToHelperInvocationEXT);
8691         return builder.createOp(spv::OpIsHelperInvocationEXT, typeId, args);
8692     }
8693 
8694     case glslang::EOpReadClockSubgroupKHR: {
8695         std::vector<spv::Id> args;
8696         args.push_back(builder.makeUintConstant(spv::ScopeSubgroup));
8697         builder.addExtension(spv::E_SPV_KHR_shader_clock);
8698         builder.addCapability(spv::CapabilityShaderClockKHR);
8699         return builder.createOp(spv::OpReadClockKHR, typeId, args);
8700     }
8701 
8702     case glslang::EOpReadClockDeviceKHR: {
8703         std::vector<spv::Id> args;
8704         args.push_back(builder.makeUintConstant(spv::ScopeDevice));
8705         builder.addExtension(spv::E_SPV_KHR_shader_clock);
8706         builder.addCapability(spv::CapabilityShaderClockKHR);
8707         return builder.createOp(spv::OpReadClockKHR, typeId, args);
8708     }
8709 #endif
8710     default:
8711         break;
8712     }
8713 
8714     logger->missingFunctionality("unknown operation with no arguments");
8715 
8716     return 0;
8717 }
8718 
getSymbolId(const glslang::TIntermSymbol * symbol)8719 spv::Id TGlslangToSpvTraverser::getSymbolId(const glslang::TIntermSymbol* symbol)
8720 {
8721     auto iter = symbolValues.find(symbol->getId());
8722     spv::Id id;
8723     if (symbolValues.end() != iter) {
8724         id = iter->second;
8725         return id;
8726     }
8727 
8728     // it was not found, create it
8729     spv::BuiltIn builtIn = TranslateBuiltInDecoration(symbol->getQualifier().builtIn, false);
8730     auto forcedType = getForcedType(symbol->getQualifier().builtIn, symbol->getType());
8731     id = createSpvVariable(symbol, forcedType.first);
8732     symbolValues[symbol->getId()] = id;
8733     if (forcedType.second != spv::NoType)
8734         forceType[id] = forcedType.second;
8735 
8736     if (symbol->getBasicType() != glslang::EbtBlock) {
8737         builder.addDecoration(id, TranslatePrecisionDecoration(symbol->getType()));
8738         builder.addDecoration(id, TranslateInterpolationDecoration(symbol->getType().getQualifier()));
8739         builder.addDecoration(id, TranslateAuxiliaryStorageDecoration(symbol->getType().getQualifier()));
8740 #ifndef GLSLANG_WEB
8741         addMeshNVDecoration(id, /*member*/ -1, symbol->getType().getQualifier());
8742         if (symbol->getQualifier().hasComponent())
8743             builder.addDecoration(id, spv::DecorationComponent, symbol->getQualifier().layoutComponent);
8744         if (symbol->getQualifier().hasIndex())
8745             builder.addDecoration(id, spv::DecorationIndex, symbol->getQualifier().layoutIndex);
8746 #endif
8747         if (symbol->getType().getQualifier().hasSpecConstantId())
8748             builder.addDecoration(id, spv::DecorationSpecId, symbol->getType().getQualifier().layoutSpecConstantId);
8749         // atomic counters use this:
8750         if (symbol->getQualifier().hasOffset())
8751             builder.addDecoration(id, spv::DecorationOffset, symbol->getQualifier().layoutOffset);
8752     }
8753 
8754     if (symbol->getQualifier().hasLocation()) {
8755         if (!(glslangIntermediate->isRayTracingStage() && glslangIntermediate->IsRequestedExtension(glslang::E_GL_EXT_ray_tracing)
8756               && (builder.getStorageClass(id) == spv::StorageClassRayPayloadKHR ||
8757                   builder.getStorageClass(id) == spv::StorageClassIncomingRayPayloadKHR ||
8758                   builder.getStorageClass(id) == spv::StorageClassCallableDataKHR ||
8759                   builder.getStorageClass(id) == spv::StorageClassIncomingCallableDataKHR))) {
8760             // Location values are used to link TraceRayKHR and ExecuteCallableKHR to corresponding variables
8761             // but are not valid in SPIRV since they are supported only for Input/Output Storage classes.
8762             builder.addDecoration(id, spv::DecorationLocation, symbol->getQualifier().layoutLocation);
8763         }
8764     }
8765 
8766     builder.addDecoration(id, TranslateInvariantDecoration(symbol->getType().getQualifier()));
8767     if (symbol->getQualifier().hasStream() && glslangIntermediate->isMultiStream()) {
8768         builder.addCapability(spv::CapabilityGeometryStreams);
8769         builder.addDecoration(id, spv::DecorationStream, symbol->getQualifier().layoutStream);
8770     }
8771     if (symbol->getQualifier().hasSet())
8772         builder.addDecoration(id, spv::DecorationDescriptorSet, symbol->getQualifier().layoutSet);
8773     else if (IsDescriptorResource(symbol->getType())) {
8774         // default to 0
8775         builder.addDecoration(id, spv::DecorationDescriptorSet, 0);
8776     }
8777     if (symbol->getQualifier().hasBinding())
8778         builder.addDecoration(id, spv::DecorationBinding, symbol->getQualifier().layoutBinding);
8779     else if (IsDescriptorResource(symbol->getType())) {
8780         // default to 0
8781         builder.addDecoration(id, spv::DecorationBinding, 0);
8782     }
8783     if (symbol->getQualifier().hasAttachment())
8784         builder.addDecoration(id, spv::DecorationInputAttachmentIndex, symbol->getQualifier().layoutAttachment);
8785     if (glslangIntermediate->getXfbMode()) {
8786         builder.addCapability(spv::CapabilityTransformFeedback);
8787         if (symbol->getQualifier().hasXfbBuffer()) {
8788             builder.addDecoration(id, spv::DecorationXfbBuffer, symbol->getQualifier().layoutXfbBuffer);
8789             unsigned stride = glslangIntermediate->getXfbStride(symbol->getQualifier().layoutXfbBuffer);
8790             if (stride != glslang::TQualifier::layoutXfbStrideEnd)
8791                 builder.addDecoration(id, spv::DecorationXfbStride, stride);
8792         }
8793         if (symbol->getQualifier().hasXfbOffset())
8794             builder.addDecoration(id, spv::DecorationOffset, symbol->getQualifier().layoutXfbOffset);
8795     }
8796 
8797     // add built-in variable decoration
8798     if (builtIn != spv::BuiltInMax) {
8799         // WorkgroupSize deprecated in spirv1.6
8800         if (glslangIntermediate->getSpv().spv < glslang::EShTargetSpv_1_6 ||
8801             builtIn != spv::BuiltInWorkgroupSize)
8802             builder.addDecoration(id, spv::DecorationBuiltIn, (int)builtIn);
8803     }
8804 
8805     // Add volatile decoration to HelperInvocation for spirv1.6 and beyond
8806     if (builtIn == spv::BuiltInHelperInvocation &&
8807         glslangIntermediate->getSpv().spv >= glslang::EShTargetSpv_1_6) {
8808         builder.addDecoration(id, spv::DecorationVolatile);
8809     }
8810 
8811 #ifndef GLSLANG_WEB
8812     // Subgroup builtins which have input storage class are volatile for ray tracing stages.
8813     if (symbol->getType().isImage() || symbol->getQualifier().isPipeInput()) {
8814         std::vector<spv::Decoration> memory;
8815         TranslateMemoryDecoration(symbol->getType().getQualifier(), memory,
8816             glslangIntermediate->usingVulkanMemoryModel());
8817         for (unsigned int i = 0; i < memory.size(); ++i)
8818             builder.addDecoration(id, memory[i]);
8819     }
8820 
8821     if (builtIn == spv::BuiltInSampleMask) {
8822           spv::Decoration decoration;
8823           // GL_NV_sample_mask_override_coverage extension
8824           if (glslangIntermediate->getLayoutOverrideCoverage())
8825               decoration = (spv::Decoration)spv::DecorationOverrideCoverageNV;
8826           else
8827               decoration = (spv::Decoration)spv::DecorationMax;
8828         builder.addDecoration(id, decoration);
8829         if (decoration != spv::DecorationMax) {
8830             builder.addCapability(spv::CapabilitySampleMaskOverrideCoverageNV);
8831             builder.addExtension(spv::E_SPV_NV_sample_mask_override_coverage);
8832         }
8833     }
8834     else if (builtIn == spv::BuiltInLayer) {
8835         // SPV_NV_viewport_array2 extension
8836         if (symbol->getQualifier().layoutViewportRelative) {
8837             builder.addDecoration(id, (spv::Decoration)spv::DecorationViewportRelativeNV);
8838             builder.addCapability(spv::CapabilityShaderViewportMaskNV);
8839             builder.addExtension(spv::E_SPV_NV_viewport_array2);
8840         }
8841         if (symbol->getQualifier().layoutSecondaryViewportRelativeOffset != -2048) {
8842             builder.addDecoration(id, (spv::Decoration)spv::DecorationSecondaryViewportRelativeNV,
8843                                   symbol->getQualifier().layoutSecondaryViewportRelativeOffset);
8844             builder.addCapability(spv::CapabilityShaderStereoViewNV);
8845             builder.addExtension(spv::E_SPV_NV_stereo_view_rendering);
8846         }
8847     }
8848 
8849     if (symbol->getQualifier().layoutPassthrough) {
8850         builder.addDecoration(id, spv::DecorationPassthroughNV);
8851         builder.addCapability(spv::CapabilityGeometryShaderPassthroughNV);
8852         builder.addExtension(spv::E_SPV_NV_geometry_shader_passthrough);
8853     }
8854     if (symbol->getQualifier().pervertexNV) {
8855         builder.addDecoration(id, spv::DecorationPerVertexNV);
8856         builder.addCapability(spv::CapabilityFragmentBarycentricNV);
8857         builder.addExtension(spv::E_SPV_NV_fragment_shader_barycentric);
8858     }
8859 
8860     if (glslangIntermediate->getHlslFunctionality1() && symbol->getType().getQualifier().semanticName != nullptr) {
8861         builder.addExtension("SPV_GOOGLE_hlsl_functionality1");
8862         builder.addDecoration(id, (spv::Decoration)spv::DecorationHlslSemanticGOOGLE,
8863                               symbol->getType().getQualifier().semanticName);
8864     }
8865 
8866     if (symbol->isReference()) {
8867         builder.addDecoration(id, symbol->getType().getQualifier().restrict ?
8868             spv::DecorationRestrictPointerEXT : spv::DecorationAliasedPointerEXT);
8869     }
8870 
8871     //
8872     // Add SPIR-V decorations for structure (GL_EXT_spirv_intrinsics)
8873     //
8874     if (symbol->getType().getQualifier().hasSprivDecorate()) {
8875         const glslang::TSpirvDecorate& spirvDecorate = symbol->getType().getQualifier().getSpirvDecorate();
8876 
8877         // Add spirv_decorate
8878         for (auto& decorate : spirvDecorate.decorates) {
8879             if (!decorate.second.empty()) {
8880                 std::vector<unsigned> literals;
8881                 TranslateLiterals(decorate.second, literals);
8882                 builder.addDecoration(id, static_cast<spv::Decoration>(decorate.first), literals);
8883             }
8884             else
8885                 builder.addDecoration(id, static_cast<spv::Decoration>(decorate.first));
8886         }
8887 
8888         // Add spirv_decorate_id
8889         for (auto& decorateId : spirvDecorate.decorateIds) {
8890             std::vector<spv::Id> operandIds;
8891             assert(!decorateId.second.empty());
8892             for (auto extraOperand : decorateId.second) {
8893                 if (extraOperand->getQualifier().isSpecConstant())
8894                     operandIds.push_back(getSymbolId(extraOperand->getAsSymbolNode()));
8895                 else
8896                     operandIds.push_back(createSpvConstant(*extraOperand));
8897             }
8898             builder.addDecorationId(id, static_cast<spv::Decoration>(decorateId.first), operandIds);
8899         }
8900 
8901         // Add spirv_decorate_string
8902         for (auto& decorateString : spirvDecorate.decorateStrings) {
8903             std::vector<const char*> strings;
8904             assert(!decorateString.second.empty());
8905             for (auto extraOperand : decorateString.second) {
8906                 const char* string = extraOperand->getConstArray()[0].getSConst()->c_str();
8907                 strings.push_back(string);
8908             }
8909             builder.addDecoration(id, static_cast<spv::Decoration>(decorateString.first), strings);
8910         }
8911     }
8912 #endif
8913 
8914     return id;
8915 }
8916 
8917 #ifndef GLSLANG_WEB
8918 // add per-primitive, per-view. per-task decorations to a struct member (member >= 0) or an object
addMeshNVDecoration(spv::Id id,int member,const glslang::TQualifier & qualifier)8919 void TGlslangToSpvTraverser::addMeshNVDecoration(spv::Id id, int member, const glslang::TQualifier& qualifier)
8920 {
8921     if (member >= 0) {
8922         if (qualifier.perPrimitiveNV) {
8923             // Need to add capability/extension for fragment shader.
8924             // Mesh shader already adds this by default.
8925             if (glslangIntermediate->getStage() == EShLangFragment) {
8926                 builder.addCapability(spv::CapabilityMeshShadingNV);
8927                 builder.addExtension(spv::E_SPV_NV_mesh_shader);
8928             }
8929             builder.addMemberDecoration(id, (unsigned)member, spv::DecorationPerPrimitiveNV);
8930         }
8931         if (qualifier.perViewNV)
8932             builder.addMemberDecoration(id, (unsigned)member, spv::DecorationPerViewNV);
8933         if (qualifier.perTaskNV)
8934             builder.addMemberDecoration(id, (unsigned)member, spv::DecorationPerTaskNV);
8935     } else {
8936         if (qualifier.perPrimitiveNV) {
8937             // Need to add capability/extension for fragment shader.
8938             // Mesh shader already adds this by default.
8939             if (glslangIntermediate->getStage() == EShLangFragment) {
8940                 builder.addCapability(spv::CapabilityMeshShadingNV);
8941                 builder.addExtension(spv::E_SPV_NV_mesh_shader);
8942             }
8943             builder.addDecoration(id, spv::DecorationPerPrimitiveNV);
8944         }
8945         if (qualifier.perViewNV)
8946             builder.addDecoration(id, spv::DecorationPerViewNV);
8947         if (qualifier.perTaskNV)
8948             builder.addDecoration(id, spv::DecorationPerTaskNV);
8949     }
8950 }
8951 #endif
8952 
8953 // Make a full tree of instructions to build a SPIR-V specialization constant,
8954 // or regular constant if possible.
8955 //
8956 // TBD: this is not yet done, nor verified to be the best design, it does do the leaf symbols though
8957 //
8958 // Recursively walk the nodes.  The nodes form a tree whose leaves are
8959 // regular constants, which themselves are trees that createSpvConstant()
8960 // recursively walks.  So, this function walks the "top" of the tree:
8961 //  - emit specialization constant-building instructions for specConstant
8962 //  - when running into a non-spec-constant, switch to createSpvConstant()
createSpvConstant(const glslang::TIntermTyped & node)8963 spv::Id TGlslangToSpvTraverser::createSpvConstant(const glslang::TIntermTyped& node)
8964 {
8965     assert(node.getQualifier().isConstant());
8966 
8967     // Handle front-end constants first (non-specialization constants).
8968     if (! node.getQualifier().specConstant) {
8969         // hand off to the non-spec-constant path
8970         assert(node.getAsConstantUnion() != nullptr || node.getAsSymbolNode() != nullptr);
8971         int nextConst = 0;
8972         return createSpvConstantFromConstUnionArray(node.getType(), node.getAsConstantUnion() ?
8973             node.getAsConstantUnion()->getConstArray() : node.getAsSymbolNode()->getConstArray(),
8974             nextConst, false);
8975     }
8976 
8977     // We now know we have a specialization constant to build
8978 
8979     // Extra capabilities may be needed.
8980     if (node.getType().contains8BitInt())
8981         builder.addCapability(spv::CapabilityInt8);
8982     if (node.getType().contains16BitFloat())
8983         builder.addCapability(spv::CapabilityFloat16);
8984     if (node.getType().contains16BitInt())
8985         builder.addCapability(spv::CapabilityInt16);
8986     if (node.getType().contains64BitInt())
8987         builder.addCapability(spv::CapabilityInt64);
8988     if (node.getType().containsDouble())
8989         builder.addCapability(spv::CapabilityFloat64);
8990 
8991     // gl_WorkGroupSize is a special case until the front-end handles hierarchical specialization constants,
8992     // even then, it's specialization ids are handled by special case syntax in GLSL: layout(local_size_x = ...
8993     if (node.getType().getQualifier().builtIn == glslang::EbvWorkGroupSize) {
8994         std::vector<spv::Id> dimConstId;
8995         for (int dim = 0; dim < 3; ++dim) {
8996             bool specConst = (glslangIntermediate->getLocalSizeSpecId(dim) != glslang::TQualifier::layoutNotSet);
8997             dimConstId.push_back(builder.makeUintConstant(glslangIntermediate->getLocalSize(dim), specConst));
8998             if (specConst) {
8999                 builder.addDecoration(dimConstId.back(), spv::DecorationSpecId,
9000                                       glslangIntermediate->getLocalSizeSpecId(dim));
9001             }
9002         }
9003         return builder.makeCompositeConstant(builder.makeVectorType(builder.makeUintType(32), 3), dimConstId, true);
9004     }
9005 
9006     // An AST node labelled as specialization constant should be a symbol node.
9007     // Its initializer should either be a sub tree with constant nodes, or a constant union array.
9008     if (auto* sn = node.getAsSymbolNode()) {
9009         spv::Id result;
9010         if (auto* sub_tree = sn->getConstSubtree()) {
9011             // Traverse the constant constructor sub tree like generating normal run-time instructions.
9012             // During the AST traversal, if the node is marked as 'specConstant', SpecConstantOpModeGuard
9013             // will set the builder into spec constant op instruction generating mode.
9014             sub_tree->traverse(this);
9015             result = accessChainLoad(sub_tree->getType());
9016         } else if (auto* const_union_array = &sn->getConstArray()) {
9017             int nextConst = 0;
9018             result = createSpvConstantFromConstUnionArray(sn->getType(), *const_union_array, nextConst, true);
9019         } else {
9020             logger->missingFunctionality("Invalid initializer for spec onstant.");
9021             return spv::NoResult;
9022         }
9023         builder.addName(result, sn->getName().c_str());
9024         return result;
9025     }
9026 
9027     // Neither a front-end constant node, nor a specialization constant node with constant union array or
9028     // constant sub tree as initializer.
9029     logger->missingFunctionality("Neither a front-end constant nor a spec constant.");
9030     return spv::NoResult;
9031 }
9032 
9033 // Use 'consts' as the flattened glslang source of scalar constants to recursively
9034 // build the aggregate SPIR-V constant.
9035 //
9036 // If there are not enough elements present in 'consts', 0 will be substituted;
9037 // an empty 'consts' can be used to create a fully zeroed SPIR-V constant.
9038 //
createSpvConstantFromConstUnionArray(const glslang::TType & glslangType,const glslang::TConstUnionArray & consts,int & nextConst,bool specConstant)9039 spv::Id TGlslangToSpvTraverser::createSpvConstantFromConstUnionArray(const glslang::TType& glslangType,
9040     const glslang::TConstUnionArray& consts, int& nextConst, bool specConstant)
9041 {
9042     // vector of constants for SPIR-V
9043     std::vector<spv::Id> spvConsts;
9044 
9045     // Type is used for struct and array constants
9046     spv::Id typeId = convertGlslangToSpvType(glslangType);
9047 
9048     if (glslangType.isArray()) {
9049         glslang::TType elementType(glslangType, 0);
9050         for (int i = 0; i < glslangType.getOuterArraySize(); ++i)
9051             spvConsts.push_back(createSpvConstantFromConstUnionArray(elementType, consts, nextConst, false));
9052     } else if (glslangType.isMatrix()) {
9053         glslang::TType vectorType(glslangType, 0);
9054         for (int col = 0; col < glslangType.getMatrixCols(); ++col)
9055             spvConsts.push_back(createSpvConstantFromConstUnionArray(vectorType, consts, nextConst, false));
9056     } else if (glslangType.isCoopMat()) {
9057         glslang::TType componentType(glslangType.getBasicType());
9058         spvConsts.push_back(createSpvConstantFromConstUnionArray(componentType, consts, nextConst, false));
9059     } else if (glslangType.isStruct()) {
9060         glslang::TVector<glslang::TTypeLoc>::const_iterator iter;
9061         for (iter = glslangType.getStruct()->begin(); iter != glslangType.getStruct()->end(); ++iter)
9062             spvConsts.push_back(createSpvConstantFromConstUnionArray(*iter->type, consts, nextConst, false));
9063     } else if (glslangType.getVectorSize() > 1) {
9064         for (unsigned int i = 0; i < (unsigned int)glslangType.getVectorSize(); ++i) {
9065             bool zero = nextConst >= consts.size();
9066             switch (glslangType.getBasicType()) {
9067             case glslang::EbtInt:
9068                 spvConsts.push_back(builder.makeIntConstant(zero ? 0 : consts[nextConst].getIConst()));
9069                 break;
9070             case glslang::EbtUint:
9071                 spvConsts.push_back(builder.makeUintConstant(zero ? 0 : consts[nextConst].getUConst()));
9072                 break;
9073             case glslang::EbtFloat:
9074                 spvConsts.push_back(builder.makeFloatConstant(zero ? 0.0F : (float)consts[nextConst].getDConst()));
9075                 break;
9076             case glslang::EbtBool:
9077                 spvConsts.push_back(builder.makeBoolConstant(zero ? false : consts[nextConst].getBConst()));
9078                 break;
9079 #ifndef GLSLANG_WEB
9080             case glslang::EbtInt8:
9081                 builder.addCapability(spv::CapabilityInt8);
9082                 spvConsts.push_back(builder.makeInt8Constant(zero ? 0 : consts[nextConst].getI8Const()));
9083                 break;
9084             case glslang::EbtUint8:
9085                 builder.addCapability(spv::CapabilityInt8);
9086                 spvConsts.push_back(builder.makeUint8Constant(zero ? 0 : consts[nextConst].getU8Const()));
9087                 break;
9088             case glslang::EbtInt16:
9089                 builder.addCapability(spv::CapabilityInt16);
9090                 spvConsts.push_back(builder.makeInt16Constant(zero ? 0 : consts[nextConst].getI16Const()));
9091                 break;
9092             case glslang::EbtUint16:
9093                 builder.addCapability(spv::CapabilityInt16);
9094                 spvConsts.push_back(builder.makeUint16Constant(zero ? 0 : consts[nextConst].getU16Const()));
9095                 break;
9096             case glslang::EbtInt64:
9097                 spvConsts.push_back(builder.makeInt64Constant(zero ? 0 : consts[nextConst].getI64Const()));
9098                 break;
9099             case glslang::EbtUint64:
9100                 spvConsts.push_back(builder.makeUint64Constant(zero ? 0 : consts[nextConst].getU64Const()));
9101                 break;
9102             case glslang::EbtDouble:
9103                 spvConsts.push_back(builder.makeDoubleConstant(zero ? 0.0 : consts[nextConst].getDConst()));
9104                 break;
9105             case glslang::EbtFloat16:
9106                 builder.addCapability(spv::CapabilityFloat16);
9107                 spvConsts.push_back(builder.makeFloat16Constant(zero ? 0.0F : (float)consts[nextConst].getDConst()));
9108                 break;
9109 #endif
9110             default:
9111                 assert(0);
9112                 break;
9113             }
9114             ++nextConst;
9115         }
9116     } else {
9117         // we have a non-aggregate (scalar) constant
9118         bool zero = nextConst >= consts.size();
9119         spv::Id scalar = 0;
9120         switch (glslangType.getBasicType()) {
9121         case glslang::EbtInt:
9122             scalar = builder.makeIntConstant(zero ? 0 : consts[nextConst].getIConst(), specConstant);
9123             break;
9124         case glslang::EbtUint:
9125             scalar = builder.makeUintConstant(zero ? 0 : consts[nextConst].getUConst(), specConstant);
9126             break;
9127         case glslang::EbtFloat:
9128             scalar = builder.makeFloatConstant(zero ? 0.0F : (float)consts[nextConst].getDConst(), specConstant);
9129             break;
9130         case glslang::EbtBool:
9131             scalar = builder.makeBoolConstant(zero ? false : consts[nextConst].getBConst(), specConstant);
9132             break;
9133 #ifndef GLSLANG_WEB
9134         case glslang::EbtInt8:
9135             builder.addCapability(spv::CapabilityInt8);
9136             scalar = builder.makeInt8Constant(zero ? 0 : consts[nextConst].getI8Const(), specConstant);
9137             break;
9138         case glslang::EbtUint8:
9139             builder.addCapability(spv::CapabilityInt8);
9140             scalar = builder.makeUint8Constant(zero ? 0 : consts[nextConst].getU8Const(), specConstant);
9141             break;
9142         case glslang::EbtInt16:
9143             builder.addCapability(spv::CapabilityInt16);
9144             scalar = builder.makeInt16Constant(zero ? 0 : consts[nextConst].getI16Const(), specConstant);
9145             break;
9146         case glslang::EbtUint16:
9147             builder.addCapability(spv::CapabilityInt16);
9148             scalar = builder.makeUint16Constant(zero ? 0 : consts[nextConst].getU16Const(), specConstant);
9149             break;
9150         case glslang::EbtInt64:
9151             scalar = builder.makeInt64Constant(zero ? 0 : consts[nextConst].getI64Const(), specConstant);
9152             break;
9153         case glslang::EbtUint64:
9154             scalar = builder.makeUint64Constant(zero ? 0 : consts[nextConst].getU64Const(), specConstant);
9155             break;
9156         case glslang::EbtDouble:
9157             scalar = builder.makeDoubleConstant(zero ? 0.0 : consts[nextConst].getDConst(), specConstant);
9158             break;
9159         case glslang::EbtFloat16:
9160             builder.addCapability(spv::CapabilityFloat16);
9161             scalar = builder.makeFloat16Constant(zero ? 0.0F : (float)consts[nextConst].getDConst(), specConstant);
9162             break;
9163         case glslang::EbtReference:
9164             scalar = builder.makeUint64Constant(zero ? 0 : consts[nextConst].getU64Const(), specConstant);
9165             scalar = builder.createUnaryOp(spv::OpBitcast, typeId, scalar);
9166             break;
9167 #endif
9168         case glslang::EbtString:
9169             scalar = builder.getStringId(consts[nextConst].getSConst()->c_str());
9170             break;
9171         default:
9172             assert(0);
9173             break;
9174         }
9175         ++nextConst;
9176         return scalar;
9177     }
9178 
9179     return builder.makeCompositeConstant(typeId, spvConsts);
9180 }
9181 
9182 // Return true if the node is a constant or symbol whose reading has no
9183 // non-trivial observable cost or effect.
isTrivialLeaf(const glslang::TIntermTyped * node)9184 bool TGlslangToSpvTraverser::isTrivialLeaf(const glslang::TIntermTyped* node)
9185 {
9186     // don't know what this is
9187     if (node == nullptr)
9188         return false;
9189 
9190     // a constant is safe
9191     if (node->getAsConstantUnion() != nullptr)
9192         return true;
9193 
9194     // not a symbol means non-trivial
9195     if (node->getAsSymbolNode() == nullptr)
9196         return false;
9197 
9198     // a symbol, depends on what's being read
9199     switch (node->getType().getQualifier().storage) {
9200     case glslang::EvqTemporary:
9201     case glslang::EvqGlobal:
9202     case glslang::EvqIn:
9203     case glslang::EvqInOut:
9204     case glslang::EvqConst:
9205     case glslang::EvqConstReadOnly:
9206     case glslang::EvqUniform:
9207         return true;
9208     default:
9209         return false;
9210     }
9211 }
9212 
9213 // A node is trivial if it is a single operation with no side effects.
9214 // HLSL (and/or vectors) are always trivial, as it does not short circuit.
9215 // Otherwise, error on the side of saying non-trivial.
9216 // Return true if trivial.
isTrivial(const glslang::TIntermTyped * node)9217 bool TGlslangToSpvTraverser::isTrivial(const glslang::TIntermTyped* node)
9218 {
9219     if (node == nullptr)
9220         return false;
9221 
9222     // count non scalars as trivial, as well as anything coming from HLSL
9223     if (! node->getType().isScalarOrVec1() || glslangIntermediate->getSource() == glslang::EShSourceHlsl)
9224         return true;
9225 
9226     // symbols and constants are trivial
9227     if (isTrivialLeaf(node))
9228         return true;
9229 
9230     // otherwise, it needs to be a simple operation or one or two leaf nodes
9231 
9232     // not a simple operation
9233     const glslang::TIntermBinary* binaryNode = node->getAsBinaryNode();
9234     const glslang::TIntermUnary* unaryNode = node->getAsUnaryNode();
9235     if (binaryNode == nullptr && unaryNode == nullptr)
9236         return false;
9237 
9238     // not on leaf nodes
9239     if (binaryNode && (! isTrivialLeaf(binaryNode->getLeft()) || ! isTrivialLeaf(binaryNode->getRight())))
9240         return false;
9241 
9242     if (unaryNode && ! isTrivialLeaf(unaryNode->getOperand())) {
9243         return false;
9244     }
9245 
9246     switch (node->getAsOperator()->getOp()) {
9247     case glslang::EOpLogicalNot:
9248     case glslang::EOpConvIntToBool:
9249     case glslang::EOpConvUintToBool:
9250     case glslang::EOpConvFloatToBool:
9251     case glslang::EOpConvDoubleToBool:
9252     case glslang::EOpEqual:
9253     case glslang::EOpNotEqual:
9254     case glslang::EOpLessThan:
9255     case glslang::EOpGreaterThan:
9256     case glslang::EOpLessThanEqual:
9257     case glslang::EOpGreaterThanEqual:
9258     case glslang::EOpIndexDirect:
9259     case glslang::EOpIndexDirectStruct:
9260     case glslang::EOpLogicalXor:
9261     case glslang::EOpAny:
9262     case glslang::EOpAll:
9263         return true;
9264     default:
9265         return false;
9266     }
9267 }
9268 
9269 // Emit short-circuiting code, where 'right' is never evaluated unless
9270 // the left side is true (for &&) or false (for ||).
createShortCircuit(glslang::TOperator op,glslang::TIntermTyped & left,glslang::TIntermTyped & right)9271 spv::Id TGlslangToSpvTraverser::createShortCircuit(glslang::TOperator op, glslang::TIntermTyped& left,
9272     glslang::TIntermTyped& right)
9273 {
9274     spv::Id boolTypeId = builder.makeBoolType();
9275 
9276     // emit left operand
9277     builder.clearAccessChain();
9278     left.traverse(this);
9279     spv::Id leftId = accessChainLoad(left.getType());
9280 
9281     // Operands to accumulate OpPhi operands
9282     std::vector<spv::Id> phiOperands;
9283     // accumulate left operand's phi information
9284     phiOperands.push_back(leftId);
9285     phiOperands.push_back(builder.getBuildPoint()->getId());
9286 
9287     // Make the two kinds of operation symmetric with a "!"
9288     //   || => emit "if (! left) result = right"
9289     //   && => emit "if (  left) result = right"
9290     //
9291     // TODO: this runtime "not" for || could be avoided by adding functionality
9292     // to 'builder' to have an "else" without an "then"
9293     if (op == glslang::EOpLogicalOr)
9294         leftId = builder.createUnaryOp(spv::OpLogicalNot, boolTypeId, leftId);
9295 
9296     // make an "if" based on the left value
9297     spv::Builder::If ifBuilder(leftId, spv::SelectionControlMaskNone, builder);
9298 
9299     // emit right operand as the "then" part of the "if"
9300     builder.clearAccessChain();
9301     right.traverse(this);
9302     spv::Id rightId = accessChainLoad(right.getType());
9303 
9304     // accumulate left operand's phi information
9305     phiOperands.push_back(rightId);
9306     phiOperands.push_back(builder.getBuildPoint()->getId());
9307 
9308     // finish the "if"
9309     ifBuilder.makeEndIf();
9310 
9311     // phi together the two results
9312     return builder.createOp(spv::OpPhi, boolTypeId, phiOperands);
9313 }
9314 
9315 #ifndef GLSLANG_WEB
9316 // Return type Id of the imported set of extended instructions corresponds to the name.
9317 // Import this set if it has not been imported yet.
getExtBuiltins(const char * name)9318 spv::Id TGlslangToSpvTraverser::getExtBuiltins(const char* name)
9319 {
9320     if (extBuiltinMap.find(name) != extBuiltinMap.end())
9321         return extBuiltinMap[name];
9322     else {
9323         builder.addExtension(name);
9324         spv::Id extBuiltins = builder.import(name);
9325         extBuiltinMap[name] = extBuiltins;
9326         return extBuiltins;
9327     }
9328 }
9329 #endif
9330 
9331 };  // end anonymous namespace
9332 
9333 namespace glslang {
9334 
GetSpirvVersion(std::string & version)9335 void GetSpirvVersion(std::string& version)
9336 {
9337     const int bufSize = 100;
9338     char buf[bufSize];
9339     snprintf(buf, bufSize, "0x%08x, Revision %d", spv::Version, spv::Revision);
9340     version = buf;
9341 }
9342 
9343 // For low-order part of the generator's magic number. Bump up
9344 // when there is a change in the style (e.g., if SSA form changes,
9345 // or a different instruction sequence to do something gets used).
GetSpirvGeneratorVersion()9346 int GetSpirvGeneratorVersion()
9347 {
9348     // return 1; // start
9349     // return 2; // EOpAtomicCounterDecrement gets a post decrement, to map between GLSL -> SPIR-V
9350     // return 3; // change/correct barrier-instruction operands, to match memory model group decisions
9351     // return 4; // some deeper access chains: for dynamic vector component, and local Boolean component
9352     // return 5; // make OpArrayLength result type be an int with signedness of 0
9353     // return 6; // revert version 5 change, which makes a different (new) kind of incorrect code,
9354                  // versions 4 and 6 each generate OpArrayLength as it has long been done
9355     // return 7; // GLSL volatile keyword maps to both SPIR-V decorations Volatile and Coherent
9356     // return 8; // switch to new dead block eliminator; use OpUnreachable
9357     // return 9; // don't include opaque function parameters in OpEntryPoint global's operand list
9358     return 10; // Generate OpFUnordNotEqual for != comparisons
9359 }
9360 
9361 // Write SPIR-V out to a binary file
OutputSpvBin(const std::vector<unsigned int> & spirv,const char * baseName)9362 void OutputSpvBin(const std::vector<unsigned int>& spirv, const char* baseName)
9363 {
9364     std::ofstream out;
9365     out.open(baseName, std::ios::binary | std::ios::out);
9366     if (out.fail())
9367         printf("ERROR: Failed to open file: %s\n", baseName);
9368     for (int i = 0; i < (int)spirv.size(); ++i) {
9369         unsigned int word = spirv[i];
9370         out.write((const char*)&word, 4);
9371     }
9372     out.close();
9373 }
9374 
9375 // Write SPIR-V out to a text file with 32-bit hexadecimal words
OutputSpvHex(const std::vector<unsigned int> & spirv,const char * baseName,const char * varName)9376 void OutputSpvHex(const std::vector<unsigned int>& spirv, const char* baseName, const char* varName)
9377 {
9378 #if !defined(GLSLANG_WEB) && !defined(GLSLANG_ANGLE)
9379     std::ofstream out;
9380     out.open(baseName, std::ios::binary | std::ios::out);
9381     if (out.fail())
9382         printf("ERROR: Failed to open file: %s\n", baseName);
9383     out << "\t// " <<
9384         GetSpirvGeneratorVersion() <<
9385         GLSLANG_VERSION_MAJOR << "." << GLSLANG_VERSION_MINOR << "." << GLSLANG_VERSION_PATCH <<
9386         GLSLANG_VERSION_FLAVOR << std::endl;
9387     if (varName != nullptr) {
9388         out << "\t #pragma once" << std::endl;
9389         out << "const uint32_t " << varName << "[] = {" << std::endl;
9390     }
9391     const int WORDS_PER_LINE = 8;
9392     for (int i = 0; i < (int)spirv.size(); i += WORDS_PER_LINE) {
9393         out << "\t";
9394         for (int j = 0; j < WORDS_PER_LINE && i + j < (int)spirv.size(); ++j) {
9395             const unsigned int word = spirv[i + j];
9396             out << "0x" << std::hex << std::setw(8) << std::setfill('0') << word;
9397             if (i + j + 1 < (int)spirv.size()) {
9398                 out << ",";
9399             }
9400         }
9401         out << std::endl;
9402     }
9403     if (varName != nullptr) {
9404         out << "};";
9405         out << std::endl;
9406     }
9407     out.close();
9408 #endif
9409 }
9410 
9411 //
9412 // Set up the glslang traversal
9413 //
GlslangToSpv(const TIntermediate & intermediate,std::vector<unsigned int> & spirv,SpvOptions * options)9414 void GlslangToSpv(const TIntermediate& intermediate, std::vector<unsigned int>& spirv, SpvOptions* options)
9415 {
9416     spv::SpvBuildLogger logger;
9417     GlslangToSpv(intermediate, spirv, &logger, options);
9418 }
9419 
GlslangToSpv(const TIntermediate & intermediate,std::vector<unsigned int> & spirv,spv::SpvBuildLogger * logger,SpvOptions * options)9420 void GlslangToSpv(const TIntermediate& intermediate, std::vector<unsigned int>& spirv,
9421                   spv::SpvBuildLogger* logger, SpvOptions* options)
9422 {
9423     TIntermNode* root = intermediate.getTreeRoot();
9424 
9425     if (root == 0)
9426         return;
9427 
9428     SpvOptions defaultOptions;
9429     if (options == nullptr)
9430         options = &defaultOptions;
9431 
9432     GetThreadPoolAllocator().push();
9433 
9434     TGlslangToSpvTraverser it(intermediate.getSpv().spv, &intermediate, logger, *options);
9435     root->traverse(&it);
9436     it.finishSpv();
9437     it.dumpSpv(spirv);
9438 
9439 #if ENABLE_OPT
9440     // If from HLSL, run spirv-opt to "legalize" the SPIR-V for Vulkan
9441     // eg. forward and remove memory writes of opaque types.
9442     bool prelegalization = intermediate.getSource() == EShSourceHlsl;
9443     if ((prelegalization || options->optimizeSize) && !options->disableOptimizer) {
9444         SpirvToolsTransform(intermediate, spirv, logger, options);
9445         prelegalization = false;
9446     }
9447     else if (options->stripDebugInfo) {
9448         // Strip debug info even if optimization is disabled.
9449         SpirvToolsStripDebugInfo(intermediate, spirv, logger);
9450     }
9451 
9452     if (options->validate)
9453         SpirvToolsValidate(intermediate, spirv, logger, prelegalization);
9454 
9455     if (options->disassemble)
9456         SpirvToolsDisassemble(std::cout, spirv);
9457 
9458 #endif
9459 
9460     GetThreadPoolAllocator().pop();
9461 }
9462 
9463 }; // end namespace glslang
9464