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