glslang: Add SPIR-V human readable form. (Use -H.)

SPIRV/CMakeLists.txt

@@ -4,13 +4,17 @@ include_directories(.. ${CMAKE_CURRENT_BINARY_DIR})
 
 set(SOURCES
     GlslangToSpv.cpp
-    SpvBuilder.cpp)
+    SpvBuilder.cpp
+    doc.cpp
+    disassemble.cpp)
 
 set(HEADERS
     spirv.h
     GlslangToSpv.h
     SpvBuilder.h
-    spvIR.h)
+    spvIR.h
+    doc.h
+    disassemble.h)
 
 add_library(SPIRV STATIC ${SOURCES} ${HEADERS})
 

SPIRV/disassemble.h

+//
+//Copyright (C) 2014 LunarG, Inc.
+//
+//All rights reserved.
+//
+//Redistribution and use in source and binary forms, with or without
+//modification, are permitted provided that the following conditions
+//are met:
+//
+//    Redistributions of source code must retain the above copyright
+//    notice, this list of conditions and the following disclaimer.
+//
+//    Redistributions in binary form must reproduce the above
+//    copyright notice, this list of conditions and the following
+//    disclaimer in the documentation and/or other materials provided
+//    with the distribution.
+//
+//    Neither the name of 3Dlabs Inc. Ltd. nor the names of its
+//    contributors may be used to endorse or promote products derived
+//    from this software without specific prior written permission.
+//
+//THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+//"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+//LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+//FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+//COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+//INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+//BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+//LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+//CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+//LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+//ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+//POSSIBILITY OF SUCH DAMAGE.
+
+//
+// Author: John Kessenich, LunarG
+//
+
+//
+// Disassembler for SPIR-V.
+//
+
+#pragma once
+#ifndef disassembler_H
+#define disassembler_H
+
+#include <iostream>
+#include <vector>
+
+namespace spv {
+
+    void Disassemble(std::ostream& out, const std::vector<unsigned int>&);
+
+};  // end namespace spv
+
+#endif // disassembler_H

SPIRV/doc.h

+//
+//Copyright (C) 2014 LunarG, Inc.
+//
+//All rights reserved.
+//
+//Redistribution and use in source and binary forms, with or without
+//modification, are permitted provided that the following conditions
+//are met:
+//
+//    Redistributions of source code must retain the above copyright
+//    notice, this list of conditions and the following disclaimer.
+//
+//    Redistributions in binary form must reproduce the above
+//    copyright notice, this list of conditions and the following
+//    disclaimer in the documentation and/or other materials provided
+//    with the distribution.
+//
+//    Neither the name of 3Dlabs Inc. Ltd. nor the names of its
+//    contributors may be used to endorse or promote products derived
+//    from this software without specific prior written permission.
+//
+//THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+//"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+//LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+//FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+//COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+//INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+//BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+//LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+//CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+//LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+//ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+//POSSIBILITY OF SUCH DAMAGE.
+
+//
+// Author: John Kessenich, LunarG
+//
+
+//
+// Return English versions of instruction/operand information.
+// This can be used for disassembly, printing documentation, etc.
+//
+
+#include "spirv.h"
+
+#include <vector>
+
+namespace spv {
+
+// Fill in all the parameters of the instruction set
+void Parameterize();
+
+// Return the English names of all the enums.
+const char* SourceString(int);
+const char* AddressingString(int);
+const char* MemoryString(int);
+const char* ExecutionModelString(int);
+const char* ExecutionModeString(int);
+const char* StorageClassString(int);
+const char* DecorationString(int);
+const char* BuiltInString(int);
+const char* DimensionString(int);
+const char* SelectControlString(int);
+const char* LoopControlString(int);
+const char* FunctionControlString(int);
+const char* SamplerAddressingModeString(int);
+const char* SamplerFilterModeString(int);
+const char* FPFastMathString(int);
+const char* FPRoundingModeString(int);
+const char* LinkageTypeString(int);
+const char* FuncParamAttrString(int);
+const char* AccessQualifierString(int);
+const char* MemorySemanticsString(int);
+const char* MemoryAccessString(int);
+const char* ExecutionScopeString(int);
+const char* GroupOperationString(int);
+const char* KernelEnqueueFlagsString(int);
+const char* KernelProfilingInfoString(int);
+
+// For parameterizing operands.
+enum OperandClass {
+    OperandNone,
+    OperandId,
+    OperandOptionalId,
+    OperandVariableIds,
+    OperandVariableLiterals,
+    OperandVariableLiteralId,
+    OperandLiteralNumber,
+    OperandLiteralString,
+    OperandSource,
+    OperandExecutionModel,
+    OperandAddressing,
+    OperandMemory,
+    OperandExecutionMode,
+    OperandStorage,
+    OperandDimensionality,
+    OperandSamplerAddressingMode,
+    OperandSamplerFilterMode,
+    OperandFPFastMath,
+    OperandFPRoundingMode,
+    OperandLinkageType,
+    OperandFuncParamAttr,
+    OperandDecoration,
+    OperandBuiltIn,
+    OperandSelect,
+    OperandLoop,
+    OperandFunction,
+    OperandAccessQualifier,
+    OperandMemorySemantics,
+    OperandMemoryAccess,
+    OperandExecutionScope,
+	OperandGroupOperation,
+    OperandKernelEnqueueFlags,
+    OperandKernelProfilingInfo,
+    OperandCount
+};
+
+// Parameterize a set of operands with their OperandClass(es) and descriptions.
+class OperandParameters {
+public:
+    OperandParameters() { }
+    void push(OperandClass oc)
+    {
+        opClass.push_back(oc);
+    }
+    OperandClass getClass(int op) const { return opClass[op]; }
+    int getNum() const { return (int)opClass.size(); }
+
+protected:
+    std::vector<OperandClass> opClass;
+};
+
+// Parameterize an instruction's logical format, including its known set of operands,
+// per OperandParameters above.
+class InstructionParameters {
+public:
+    InstructionParameters() :
+        typePresent(true),         // most normal, only exceptions have to be spelled out
+        resultPresent(true),       // most normal, only exceptions have to be spelled out
+        opName(0)
+    { }
+
+    void setResultAndType(bool r, bool t)
+    {
+        resultPresent = r;
+        typePresent = t;
+    }
+
+    bool hasResult() const { return resultPresent != 0; }
+    bool hasType()   const { return typePresent != 0; }
+
+    const char* opName;
+    OperandParameters operands;
+
+protected:
+    int typePresent   : 1;
+    int resultPresent : 1;
+};
+
+// The set of objects that hold all the instruction/operand
+// parameterization information.
+extern InstructionParameters InstructionDesc[spv::OpCount];
+
+};  // end namespace spv

StandAlone/StandAlone.cpp

@@ -42,6 +42,8 @@
 #include "./../glslang/Public/ShaderLang.h"
 #include "../SPIRV/GlslangToSpv.h"
 #include "../SPIRV/GLSL450Lib.h"
+#include "../SPIRV/doc.h"
+#include "../SPIRV/disassemble.h"
 #include <string.h>
 #include <stdlib.h>
 #include <math.h>
@@ -54,20 +56,21 @@ extern "C" {
 
 // Command-line options
 enum TOptions {
-    EOptionNone               = 0x000,
-    EOptionIntermediate       = 0x001,
-    EOptionSuppressInfolog    = 0x002,
-    EOptionMemoryLeakMode     = 0x004,
-    EOptionRelaxedErrors      = 0x008,
-    EOptionGiveWarnings       = 0x010,
-    EOptionLinkProgram        = 0x020,
-    EOptionMultiThreaded      = 0x040,
-    EOptionDumpConfig         = 0x080,
-    EOptionDumpReflection     = 0x100,
-    EOptionSuppressWarnings   = 0x200,
-    EOptionDumpVersions       = 0x400,
-    EOptionSpv                = 0x800,
-    EOptionDefaultDesktop     = 0x1000,
+    EOptionNone               = 0x0000,
+    EOptionIntermediate       = 0x0001,
+    EOptionSuppressInfolog    = 0x0002,
+    EOptionMemoryLeakMode     = 0x0004,
+    EOptionRelaxedErrors      = 0x0008,
+    EOptionGiveWarnings       = 0x0010,
+    EOptionLinkProgram        = 0x0020,
+    EOptionMultiThreaded      = 0x0040,
+    EOptionDumpConfig         = 0x0080,
+    EOptionDumpReflection     = 0x0100,
+    EOptionSuppressWarnings   = 0x0200,
+    EOptionDumpVersions       = 0x0400,
+    EOptionSpv                = 0x0800,
+    EOptionHumanReadableSpv   = 0x1000,
+    EOptionDefaultDesktop     = 0x2000,
 };
 
 //
@@ -479,6 +482,9 @@ bool ProcessArguments(int argc, char* argv[])
         Work[argc] = 0;
         if (argv[0][0] == '-') {
             switch (argv[0][1]) {
+            case 'H':
+                Options |= EOptionHumanReadableSpv;
+                // fall through to -V
             case 'V':
                 Options |= EOptionSpv;
                 Options |= EOptionLinkProgram;
@@ -570,6 +576,8 @@ CompileShaders(void*)
     return 0;
 }
 
+const char* GlslStd450DebugNames[GLSL_STD_450::Count];
+
 //
 // For linking mode: Will independently parse each item in the worklist, but then put them
 // in the same program and link them together.
@@ -653,6 +661,11 @@ void CompileAndLinkShaders()
                     default:                     name = "unknown"; break;
                     }
                     glslang::OutputSpv(spirv, name);
+                    if (Options & EOptionHumanReadableSpv) {
+                        spv::Parameterize();
+                        GLSL_STD_450::GetDebugNames(GlslStd450DebugNames);
+                        spv::Disassemble(std::cout, spirv);
+                    }
                 }
             }
         }
@@ -854,6 +867,7 @@ void usage()
            "To get other information, use one of the following options:\n"
            "(Each option must be specified separately, but can go anywhere in the command line.)\n"
            "  -V  create SPIR-V in file <stage>.spv\n"
+           "  -H  print human readable form of SPIR-V; turns on -V\n"
            "  -c  configuration dump; use to create default configuration file (redirect to a .conf file)\n"
            "  -d  default to desktop (#version 110) when there is no version in the shader (default is ES version 100)\n"
            "  -i  intermediate tree (glslang AST) is printed out\n"