Vulkan: Move SPIR-V validation function to common/

BUILD.gn

@@ -691,6 +691,7 @@ if (angle_enable_vulkan || angle_enable_metal) {
     ]
     deps = [
       ":libANGLE_headers",
+      "$angle_root/src/common/spirv:angle_spirv_base",
       "$angle_root/src/common/spirv:angle_spirv_builder",
       "$angle_root/src/common/spirv:angle_spirv_parser",
       "${angle_glslang_dir}:glslang_default_resource_limits_sources",

scripts/code_generation_hashes/SPIR-V_helpers.json

 {
   "src/common/spirv/gen_spirv_builder_and_parser.py":
-    "4c57f0814056b5b5e80494380854371f",
+    "60a5245905287df8a9fb55be33acfc48",
   "src/common/spirv/spirv_instruction_builder_autogen.cpp":
     "6ea97ca168ecccb4a621a06446e4933a",
   "src/common/spirv/spirv_instruction_builder_autogen.h":
-    "aa4980783495c40873598156b02b7784",
+    "7f0130816be26511615f7b1e33fda196",
   "src/common/spirv/spirv_instruction_parser_autogen.cpp":
     "55d28bb4b003dbecf31e162ff996fc4f",
   "src/common/spirv/spirv_instruction_parser_autogen.h":
-    "68c5746bc94e6b9f891ff2a11869ccd1",
+    "c35834942632d4cd1587bf7d66721df7",
   "third_party/vulkan-deps/spirv-headers/src/include/spirv/1.0/spirv.core.grammar.json":
     "a8c4239344b2fc10bfc4ace7ddee1867"
 }
\ No newline at end of file

src/common/spirv/BUILD.gn

@@ -4,13 +4,29 @@
 
 import("../../../gni/angle.gni")
 
+angle_source_set("angle_spirv_base") {
+  sources = [
+    "angle_spirv_utils.cpp",
+    "spirv_types.h",
+  ]
+  deps = [
+    "$angle_root:angle_common",
+    "${angle_spirv_headers_dir}:spv_headers",
+    "${angle_spirv_tools_dir}:spvtools_headers",
+  ]
+
+  if (dcheck_always_on || is_debug) {
+    deps += [ "$angle_spirv_tools_dir:spvtools_val" ]
+  }
+}
+
 angle_source_set("angle_spirv_builder") {
   sources = [
     "spirv_instruction_builder_autogen.cpp",
     "spirv_instruction_builder_autogen.h",
-    "spirv_types.h",
   ]
   deps = [
+    ":angle_spirv_base",
     "$angle_root:angle_common",
     "${angle_spirv_headers_dir}:spv_headers",
   ]
@@ -20,9 +36,9 @@ angle_source_set("angle_spirv_parser") {
   sources = [
     "spirv_instruction_parser_autogen.cpp",
     "spirv_instruction_parser_autogen.h",
-    "spirv_types.h",
   ]
   deps = [
+    ":angle_spirv_base",
     "$angle_root:angle_common",
     "${angle_spirv_headers_dir}:spv_headers",
   ]

src/common/spirv/angle_spirv_utils.cpp

+// Copyright 2021 The ANGLE Project Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+//
+// spirv_types.cpp:
+//   Helper SPIR-V functions.
+
+#include "spirv_types.h"
+
+// SPIR-V tools include for AST validation.
+#include <spirv-tools/libspirv.hpp>
+
+namespace angle
+{
+namespace spirv
+{
+
+#if defined(ANGLE_ENABLE_ASSERTS)
+namespace
+{
+void ValidateSpirvMessage(spv_message_level_t level,
+                          const char *source,
+                          const spv_position_t &position,
+                          const char *message)
+{
+    WARN() << "Level" << level << ": " << message;
+}
+}  // anonymous namespace
+
+bool Validate(const std::vector<uint32_t> &blob)
+{
+    spvtools::SpirvTools spirvTools(SPV_ENV_VULKAN_1_1);
+
+    spirvTools.SetMessageConsumer(ValidateSpirvMessage);
+    bool result = spirvTools.Validate(blob);
+
+    if (!result)
+    {
+        std::string readableSpirv;
+        spirvTools.Disassemble(blob, &readableSpirv, 0);
+        WARN() << "Invalid SPIR-V:\n" << readableSpirv;
+    }
+
+    return result;
+}
+#else   // ANGLE_ENABLE_ASSERTS
+bool Validate(const std::vector<uint32_t> &blob)
+{
+    // Placeholder implementation since this is only used inside an ASSERT().
+    // Return false to indicate an error in case this is ever accidentally used somewhere else.
+    return false;
+}
+#endif  // ANGLE_ENABLE_ASSERTS
+
+}  // namespace spirv
+}  // namespace angle

src/common/spirv/gen_spirv_builder_and_parser.py

@@ -41,8 +41,6 @@ HEADER_TEMPLATE = """// GENERATED FILE - DO NOT EDIT.
 #ifndef COMMON_SPIRV_{file_name_capitalized}AUTOGEN_H_
 #define COMMON_SPIRV_{file_name_capitalized}AUTOGEN_H_
 
-#include <vector>
-
 #include "spirv_types.h"
 
 namespace angle

src/common/spirv/spirv_instruction_builder_autogen.h

@@ -11,8 +11,6 @@
 #ifndef COMMON_SPIRV_SPIRVINSTRUCTIONBUILDERAUTOGEN_H_
 #define COMMON_SPIRV_SPIRVINSTRUCTIONBUILDERAUTOGEN_H_
 
-#include <vector>
-
 #include "spirv_types.h"
 
 namespace angle

src/common/spirv/spirv_instruction_parser_autogen.h

@@ -11,8 +11,6 @@
 #ifndef COMMON_SPIRV_SPIRVINSTRUCTIONPARSERAUTOGEN_H_
 #define COMMON_SPIRV_SPIRVINSTRUCTIONPARSERAUTOGEN_H_
 
-#include <vector>
-
 #include "spirv_types.h"
 
 namespace angle

src/common/spirv/spirv_types.h

@@ -14,6 +14,8 @@
 
 #include "common/FastVector.h"
 
+#include <vector>
+
 namespace angle
 {
 namespace spirv
@@ -107,6 +109,10 @@ using PairIdRefIdRefList          = FastVectorHelper<PairIdRefIdRef>;
 // Id 0 is invalid in SPIR-V.
 constexpr uint32_t kMinValidId = 1;
 
+// Returns whether SPIR-V is valid.  Useful for ASSERTs.  Automatically generates a warning if
+// SPIR-V is not valid.
+bool Validate(const std::vector<uint32_t> &blob);
+
 }  // namespace spirv
 }  // namespace angle
 

src/libANGLE/renderer/glslang_wrapper_utils.cpp

@@ -24,9 +24,6 @@ ANGLE_REENABLE_SUGGEST_OVERRIDE_WARNINGS
 ANGLE_REENABLE_SHADOWING_WARNING
 ANGLE_REENABLE_EXTRA_SEMI_WARNING
 
-// SPIR-V tools include for AST validation.
-#include <spirv-tools/libspirv.hpp>
-
 #include <array>
 #include <numeric>
 
@@ -1065,40 +1062,6 @@ angle::Result LinkProgram(const GlslangErrorCallback &callback, glslang::TProgra
     return angle::Result::Continue;
 }
 
-#if defined(ANGLE_ENABLE_ASSERTS)
-void ValidateSpirvMessage(spv_message_level_t level,
-                          const char *source,
-                          const spv_position_t &position,
-                          const char *message)
-{
-    WARN() << "Level" << level << ": " << message;
-}
-
-bool ValidateSpirv(const std::vector<uint32_t> &spirvBlob)
-{
-    spvtools::SpirvTools spirvTools(SPV_ENV_VULKAN_1_1);
-
-    spirvTools.SetMessageConsumer(ValidateSpirvMessage);
-    bool result = spirvTools.Validate(spirvBlob);
-
-    if (!result)
-    {
-        std::string readableSpirv;
-        spirvTools.Disassemble(spirvBlob, &readableSpirv, 0);
-        WARN() << "Invalid SPIR-V:\n" << readableSpirv;
-    }
-
-    return result;
-}
-#else   // ANGLE_ENABLE_ASSERTS
-bool ValidateSpirv(const std::vector<uint32_t> &spirvBlob)
-{
-    // Placeholder implementation since this is only used inside an ASSERT().
-    // Return false to indicate an error in case this is ever accidentally used somewhere else.
-    return false;
-}
-#endif  // ANGLE_ENABLE_ASSERTS
-
 // Base class for SPIR-V transformations.
 class SpirvTransformerBase : angle::NonCopyable
 {
@@ -5109,7 +5072,7 @@ angle::Result GlslangTransformSpirvCode(const GlslangErrorCallback &callback,
         ANGLE_GLSLANG_CHECK(callback, aliasingTransformer.transform(), GlslangError::InvalidSpirv);
     }
 
-    ASSERT(ValidateSpirv(*spirvBlobOut));
+    ASSERT(spirv::Validate(*spirvBlobOut));
 
     return angle::Result::Continue;
 }

src/libANGLE/renderer/vulkan/BUILD.gn

@@ -223,10 +223,6 @@ angle_source_set("angle_vulkan_backend") {
     "$angle_root:angle_image_util",
   ]
 
-  if (dcheck_always_on || is_debug) {
-    deps += [ "$angle_spirv_tools_dir:spvtools_val" ]
-  }
-
   public_deps = [
     "$angle_root:angle_glslang_wrapper",
     "$angle_root:libANGLE_headers",