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