test/opt/pass_remove_duplicates_test.cpp - external/github.com/KhronosGroup/SPIRV-Tools - Git at Google

 // Copyright (c) 2017 Pierre Moreau
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
 //     http://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.

 #include <iostream>
 #include <memory>
 #include <string>
 #include <vector>

 #include "gmock/gmock.h"
 #include "source/opt/build_module.h"
 #include "source/opt/ir_context.h"
 #include "source/opt/pass_manager.h"
 #include "source/opt/remove_duplicates_pass.h"
 #include "source/spirv_constant.h"
 #include "test/unit_spirv.h"

 namespace spvtools {
 namespace opt {
 namespace {

 class RemoveDuplicatesTest : public ::testing::Test {
  public:
   RemoveDuplicatesTest()
       : tools_(SPV_ENV_UNIVERSAL_1_2),
         context_(),
         consumer_([this](spv_message_level_t level, const char*,
                          const spv_position_t& position, const char* message) {
           if (!error_message_.empty()) error_message_ += "\n";
           switch (level) {
             case SPV_MSG_FATAL:
             case SPV_MSG_INTERNAL_ERROR:
             case SPV_MSG_ERROR:
               error_message_ += "ERROR";
               break;
             case SPV_MSG_WARNING:
               error_message_ += "WARNING";
               break;
             case SPV_MSG_INFO:
               error_message_ += "INFO";
               break;
             case SPV_MSG_DEBUG:
               error_message_ += "DEBUG";
               break;
           }
           error_message_ +=
               ": " + std::to_string(position.index) + ": " + message;
         }),
         disassemble_options_(SPV_BINARY_TO_TEXT_OPTION_NO_HEADER),
         error_message_() {
     tools_.SetMessageConsumer(consumer_);
   }

   void TearDown() override { error_message_.clear(); }

   std::string RunPass(const std::string& text) {
     context_ = spvtools::BuildModule(SPV_ENV_UNIVERSAL_1_2, consumer_, text);
     if (!context_.get()) return std::string();

     PassManager manager;
     manager.SetMessageConsumer(consumer_);
     manager.AddPass<RemoveDuplicatesPass>();

     Pass::Status pass_res = manager.Run(context_.get());
     if (pass_res == Pass::Status::Failure) return std::string();

     return ModuleToText();
   }

   // Disassembles |binary| and outputs the result in |text|. If |text| is a
   // null pointer, SPV_ERROR_INVALID_POINTER is returned.
   spv_result_t Disassemble(const std::vector<uint32_t>& binary,
                            std::string* text) {
     if (!text) return SPV_ERROR_INVALID_POINTER;
     return tools_.Disassemble(binary, text, disassemble_options_)
                ? SPV_SUCCESS
                : SPV_ERROR_INVALID_BINARY;
   }

   // Returns the accumulated error messages for the test.
   std::string GetErrorMessage() const { return error_message_; }

   std::string ToText(const std::vector<Instruction*>& inst) {
     std::vector<uint32_t> binary = {SpvMagicNumber, 0x10200, 0u, 2u, 0u};
     for (const Instruction* i : inst)
       i->ToBinaryWithoutAttachedDebugInsts(&binary);
     std::string text;
     Disassemble(binary, &text);
     return text;
   }

   std::string ModuleToText() {
     std::vector<uint32_t> binary;
     context_->module()->ToBinary(&binary, false);
     std::string text;
     Disassemble(binary, &text);
     return text;
   }

  private:
   spvtools::SpirvTools
       tools_;  // An instance for calling SPIRV-Tools functionalities.
   std::unique_ptr<IRContext> context_;
   spvtools::MessageConsumer consumer_;
   uint32_t disassemble_options_;
   std::string error_message_;
 };

 TEST_F(RemoveDuplicatesTest, DuplicateCapabilities) {
   const std::string spirv = R"(
 OpCapability Shader
 OpCapability Linkage
 OpCapability Shader
 OpMemoryModel Logical GLSL450
 )";
   const std::string after = R"(OpCapability Shader
 OpCapability Linkage
 OpMemoryModel Logical GLSL450
 )";

   EXPECT_EQ(RunPass(spirv), after);
   EXPECT_EQ(GetErrorMessage(), "");
 }

 TEST_F(RemoveDuplicatesTest, DuplicateExtInstImports) {
   const std::string spirv = R"(
 OpCapability Shader
 OpCapability Linkage
 %1 = OpExtInstImport "OpenCL.std"
 %2 = OpExtInstImport "OpenCL.std"
 %3 = OpExtInstImport "GLSL.std.450"
 OpMemoryModel Logical GLSL450
 )";
   const std::string after = R"(OpCapability Shader
 OpCapability Linkage
 %1 = OpExtInstImport "OpenCL.std"
 %3 = OpExtInstImport "GLSL.std.450"
 OpMemoryModel Logical GLSL450
 )";

   EXPECT_EQ(RunPass(spirv), after);
   EXPECT_EQ(GetErrorMessage(), "");
 }

 TEST_F(RemoveDuplicatesTest, DuplicateTypes) {
   const std::string spirv = R"(
 OpCapability Shader
 OpCapability Linkage
 OpMemoryModel Logical GLSL450
 %1 = OpTypeInt 32 0
 %2 = OpTypeInt 32 0
 %3 = OpTypeStruct %1 %2
 )";
   const std::string after = R"(OpCapability Shader
 OpCapability Linkage
 OpMemoryModel Logical GLSL450
 %1 = OpTypeInt 32 0
 %3 = OpTypeStruct %1 %1
 )";

   EXPECT_EQ(RunPass(spirv), after);
   EXPECT_EQ(GetErrorMessage(), "");
 }

 TEST_F(RemoveDuplicatesTest, SameTypeDifferentMemberDecoration) {
   const std::string spirv = R"(
 OpCapability Shader
 OpCapability Linkage
 OpMemoryModel Logical GLSL450
 OpDecorate %1 GLSLPacked
 %2 = OpTypeInt 32 0
 %1 = OpTypeStruct %2 %2
 %3 = OpTypeStruct %2 %2
 )";
   const std::string after = R"(OpCapability Shader
 OpCapability Linkage
 OpMemoryModel Logical GLSL450
 OpDecorate %1 GLSLPacked
 %2 = OpTypeInt 32 0
 %1 = OpTypeStruct %2 %2
 %3 = OpTypeStruct %2 %2
 )";

   EXPECT_EQ(RunPass(spirv), after);
   EXPECT_EQ(GetErrorMessage(), "");
 }

 TEST_F(RemoveDuplicatesTest, SameTypeAndMemberDecoration) {
   const std::string spirv = R"(
 OpCapability Shader
 OpCapability Linkage
 OpMemoryModel Logical GLSL450
 OpDecorate %1 GLSLPacked
 OpDecorate %2 GLSLPacked
 %3 = OpTypeInt 32 0
 %1 = OpTypeStruct %3 %3
 %2 = OpTypeStruct %3 %3
 )";
   const std::string after = R"(OpCapability Shader
 OpCapability Linkage
 OpMemoryModel Logical GLSL450
 OpDecorate %1 GLSLPacked
 %3 = OpTypeInt 32 0
 %1 = OpTypeStruct %3 %3
 )";

   EXPECT_EQ(RunPass(spirv), after);
   EXPECT_EQ(GetErrorMessage(), "");
 }

 TEST_F(RemoveDuplicatesTest, SameTypeAndDifferentName) {
   const std::string spirv = R"(
 OpCapability Shader
 OpCapability Linkage
 OpMemoryModel Logical GLSL450
 OpName %1 "Type1"
 OpName %2 "Type2"
 %3 = OpTypeInt 32 0
 %1 = OpTypeStruct %3 %3
 %2 = OpTypeStruct %3 %3
 )";
   const std::string after = R"(OpCapability Shader
 OpCapability Linkage
 OpMemoryModel Logical GLSL450
 OpName %1 "Type1"
 %3 = OpTypeInt 32 0
 %1 = OpTypeStruct %3 %3
 )";

   EXPECT_EQ(RunPass(spirv), after);
   EXPECT_EQ(GetErrorMessage(), "");
 }

 // Check that #1033 has been fixed.
 TEST_F(RemoveDuplicatesTest, DoNotRemoveDifferentOpDecorationGroup) {
   const std::string spirv = R"(
 OpCapability Shader
 OpCapability Linkage
 OpMemoryModel Logical GLSL450
 OpDecorate %1 Constant
 %1 = OpDecorationGroup
 OpDecorate %2 Restrict
 %2 = OpDecorationGroup
 OpGroupDecorate %3 %1 %2
 %4 = OpTypeInt 32 0
 %3 = OpVariable %4 Uniform
 )";
   const std::string after = R"(OpCapability Shader
 OpCapability Linkage
 OpMemoryModel Logical GLSL450
 OpDecorate %1 Constant
 %1 = OpDecorationGroup
 OpDecorate %2 Restrict
 %2 = OpDecorationGroup
 OpGroupDecorate %3 %1 %2
 %4 = OpTypeInt 32 0
 %3 = OpVariable %4 Uniform
 )";

   EXPECT_EQ(RunPass(spirv), after);
   EXPECT_EQ(GetErrorMessage(), "");
 }

 TEST_F(RemoveDuplicatesTest, DifferentDecorationGroup) {
   const std::string spirv = R"(
 OpCapability Shader
 OpCapability Linkage
 OpMemoryModel Logical GLSL450
 OpDecorate %1 Constant
 OpDecorate %1 Restrict
 %1 = OpDecorationGroup
 OpDecorate %2 Constant
 %2 = OpDecorationGroup
 OpGroupDecorate %1 %3
 OpGroupDecorate %2 %4
 %5 = OpTypeInt 32 0
 %3 = OpVariable %5 Uniform
 %4 = OpVariable %5 Uniform
 )";
   const std::string after = R"(OpCapability Shader
 OpCapability Linkage
 OpMemoryModel Logical GLSL450
 OpDecorate %1 Constant
 OpDecorate %1 Restrict
 %1 = OpDecorationGroup
 OpDecorate %2 Constant
 %2 = OpDecorationGroup
 OpGroupDecorate %1 %3
 OpGroupDecorate %2 %4
 %5 = OpTypeInt 32 0
 %3 = OpVariable %5 Uniform
 %4 = OpVariable %5 Uniform
 )";

   EXPECT_EQ(RunPass(spirv), after);
   EXPECT_EQ(GetErrorMessage(), "");
 }

 // Test what happens when a type is a resource type.  For now we are merging
 // them, but, if we want to merge types and make reflection work (issue #1372),
 // we will not be able to merge %2 and %3 below.
 TEST_F(RemoveDuplicatesTest, DontMergeNestedResourceTypes) {
   const std::string spirv = R"(OpCapability Shader
 OpMemoryModel Logical GLSL450
 OpSource HLSL 600
 OpName %1 "PositionAdjust"
 OpMemberName %1 0 "XAdjust"
 OpName %2 "NormalAdjust"
 OpMemberName %2 0 "XDir"
 OpMemberName %3 0 "AdjustXYZ"
 OpMemberName %3 1 "AdjustDir"
 OpName %4 "Constants"
 OpMemberDecorate %1 0 Offset 0
 OpMemberDecorate %2 0 Offset 0
 OpMemberDecorate %3 0 Offset 0
 OpMemberDecorate %3 1 Offset 16
 OpDecorate %3 Block
 OpDecorate %4 DescriptorSet 0
 OpDecorate %4 Binding 0
 %5 = OpTypeFloat 32
 %6 = OpTypeVector %5 3
 %1 = OpTypeStruct %6
 %2 = OpTypeStruct %6
 %3 = OpTypeStruct %1 %2
 %7 = OpTypePointer Uniform %3
 %4 = OpVariable %7 Uniform
 )";

   const std::string result = R"(OpCapability Shader
 OpMemoryModel Logical GLSL450
 OpSource HLSL 600
 OpName %1 "PositionAdjust"
 OpMemberName %1 0 "XAdjust"
 OpMemberName %3 0 "AdjustXYZ"
 OpMemberName %3 1 "AdjustDir"
 OpName %4 "Constants"
 OpMemberDecorate %1 0 Offset 0
 OpMemberDecorate %3 0 Offset 0
 OpMemberDecorate %3 1 Offset 16
 OpDecorate %3 Block
 OpDecorate %4 DescriptorSet 0
 OpDecorate %4 Binding 0
 %5 = OpTypeFloat 32
 %6 = OpTypeVector %5 3
 %1 = OpTypeStruct %6
 %3 = OpTypeStruct %1 %1
 %7 = OpTypePointer Uniform %3
 %4 = OpVariable %7 Uniform
 )";

   EXPECT_EQ(RunPass(spirv), result);
   EXPECT_EQ(GetErrorMessage(), "");
 }

 // See comment for DontMergeNestedResourceTypes.
 TEST_F(RemoveDuplicatesTest, DontMergeResourceTypes) {
   const std::string spirv = R"(OpCapability Shader
 OpMemoryModel Logical GLSL450
 OpSource HLSL 600
 OpName %1 "PositionAdjust"
 OpMemberName %1 0 "XAdjust"
 OpName %2 "NormalAdjust"
 OpMemberName %2 0 "XDir"
 OpName %3 "Constants"
 OpMemberDecorate %1 0 Offset 0
 OpMemberDecorate %2 0 Offset 0
 OpDecorate %3 DescriptorSet 0
 OpDecorate %3 Binding 0
 OpDecorate %4 DescriptorSet 1
 OpDecorate %4 Binding 0
 %5 = OpTypeFloat 32
 %6 = OpTypeVector %5 3
 %1 = OpTypeStruct %6
 %2 = OpTypeStruct %6
 %7 = OpTypePointer Uniform %1
 %8 = OpTypePointer Uniform %2
 %3 = OpVariable %7 Uniform
 %4 = OpVariable %8 Uniform
 )";

   const std::string result = R"(OpCapability Shader
 OpMemoryModel Logical GLSL450
 OpSource HLSL 600
 OpName %1 "PositionAdjust"
 OpMemberName %1 0 "XAdjust"
 OpName %3 "Constants"
 OpMemberDecorate %1 0 Offset 0
 OpDecorate %3 DescriptorSet 0
 OpDecorate %3 Binding 0
 OpDecorate %4 DescriptorSet 1
 OpDecorate %4 Binding 0
 %5 = OpTypeFloat 32
 %6 = OpTypeVector %5 3
 %1 = OpTypeStruct %6
 %7 = OpTypePointer Uniform %1
 %3 = OpVariable %7 Uniform
 %4 = OpVariable %7 Uniform
 )";

   EXPECT_EQ(RunPass(spirv), result);
   EXPECT_EQ(GetErrorMessage(), "");
 }

 // See comment for DontMergeNestedResourceTypes.
 TEST_F(RemoveDuplicatesTest, DontMergeResourceTypesContainingArray) {
   const std::string spirv = R"(OpCapability Shader
 OpMemoryModel Logical GLSL450
 OpSource HLSL 600
 OpName %1 "PositionAdjust"
 OpMemberName %1 0 "XAdjust"
 OpName %2 "NormalAdjust"
 OpMemberName %2 0 "XDir"
 OpName %3 "Constants"
 OpMemberDecorate %1 0 Offset 0
 OpMemberDecorate %2 0 Offset 0
 OpDecorate %3 DescriptorSet 0
 OpDecorate %3 Binding 0
 OpDecorate %4 DescriptorSet 1
 OpDecorate %4 Binding 0
 %5 = OpTypeFloat 32
 %6 = OpTypeVector %5 3
 %1 = OpTypeStruct %6
 %2 = OpTypeStruct %6
 %7 = OpTypeInt 32 0
 %8 = OpConstant %7 4
 %9 = OpTypeArray %1 %8
 %10 = OpTypeArray %2 %8
 %11 = OpTypePointer Uniform %9
 %12 = OpTypePointer Uniform %10
 %3 = OpVariable %11 Uniform
 %4 = OpVariable %12 Uniform
 )";

   const std::string result = R"(OpCapability Shader
 OpMemoryModel Logical GLSL450
 OpSource HLSL 600
 OpName %1 "PositionAdjust"
 OpMemberName %1 0 "XAdjust"
 OpName %3 "Constants"
 OpMemberDecorate %1 0 Offset 0
 OpDecorate %3 DescriptorSet 0
 OpDecorate %3 Binding 0
 OpDecorate %4 DescriptorSet 1
 OpDecorate %4 Binding 0
 %5 = OpTypeFloat 32
 %6 = OpTypeVector %5 3
 %1 = OpTypeStruct %6
 %7 = OpTypeInt 32 0
 %8 = OpConstant %7 4
 %9 = OpTypeArray %1 %8
 %11 = OpTypePointer Uniform %9
 %3 = OpVariable %11 Uniform
 %4 = OpVariable %11 Uniform
 )";

   EXPECT_EQ(RunPass(spirv), result);
   EXPECT_EQ(GetErrorMessage(), "");
 }

 // Test that we merge the type of a resource with a type that is not the type
 // a resource.  The resource type appears first in this case.  We must keep
 // the resource type.
 TEST_F(RemoveDuplicatesTest, MergeResourceTypeWithNonresourceType1) {
   const std::string spirv = R"(OpCapability Shader
 OpMemoryModel Logical GLSL450
 OpSource HLSL 600
 OpName %1 "PositionAdjust"
 OpMemberName %1 0 "XAdjust"
 OpName %2 "NormalAdjust"
 OpMemberName %2 0 "XDir"
 OpName %3 "Constants"
 OpMemberDecorate %1 0 Offset 0
 OpMemberDecorate %2 0 Offset 0
 OpDecorate %3 DescriptorSet 0
 OpDecorate %3 Binding 0
 %4 = OpTypeFloat 32
 %5 = OpTypeVector %4 3
 %1 = OpTypeStruct %5
 %2 = OpTypeStruct %5
 %6 = OpTypePointer Uniform %1
 %7 = OpTypePointer Uniform %2
 %3 = OpVariable %6 Uniform
 %8 = OpVariable %7 Uniform
 )";

   const std::string result = R"(OpCapability Shader
 OpMemoryModel Logical GLSL450
 OpSource HLSL 600
 OpName %1 "PositionAdjust"
 OpMemberName %1 0 "XAdjust"
 OpName %3 "Constants"
 OpMemberDecorate %1 0 Offset 0
 OpDecorate %3 DescriptorSet 0
 OpDecorate %3 Binding 0
 %4 = OpTypeFloat 32
 %5 = OpTypeVector %4 3
 %1 = OpTypeStruct %5
 %6 = OpTypePointer Uniform %1
 %3 = OpVariable %6 Uniform
 %8 = OpVariable %6 Uniform
 )";

   EXPECT_EQ(RunPass(spirv), result);
   EXPECT_EQ(GetErrorMessage(), "");
 }

 // Test that we merge the type of a resource with a type that is not the type
 // a resource.  The resource type appears second in this case.  We must keep
 // the resource type.
 //
 // See comment for DontMergeNestedResourceTypes.
 TEST_F(RemoveDuplicatesTest, MergeResourceTypeWithNonresourceType2) {
   const std::string spirv = R"(OpCapability Shader
 OpMemoryModel Logical GLSL450
 OpSource HLSL 600
 OpName %1 "PositionAdjust"
 OpMemberName %1 0 "XAdjust"
 OpName %2 "NormalAdjust"
 OpMemberName %2 0 "XDir"
 OpName %3 "Constants"
 OpMemberDecorate %1 0 Offset 0
 OpMemberDecorate %2 0 Offset 0
 OpDecorate %3 DescriptorSet 0
 OpDecorate %3 Binding 0
 %4 = OpTypeFloat 32
 %5 = OpTypeVector %4 3
 %1 = OpTypeStruct %5
 %2 = OpTypeStruct %5
 %6 = OpTypePointer Uniform %1
 %7 = OpTypePointer Uniform %2
 %8 = OpVariable %6 Uniform
 %3 = OpVariable %7 Uniform
 )";

   const std::string result = R"(OpCapability Shader
 OpMemoryModel Logical GLSL450
 OpSource HLSL 600
 OpName %1 "PositionAdjust"
 OpMemberName %1 0 "XAdjust"
 OpName %3 "Constants"
 OpMemberDecorate %1 0 Offset 0
 OpDecorate %3 DescriptorSet 0
 OpDecorate %3 Binding 0
 %4 = OpTypeFloat 32
 %5 = OpTypeVector %4 3
 %1 = OpTypeStruct %5
 %6 = OpTypePointer Uniform %1
 %8 = OpVariable %6 Uniform
 %3 = OpVariable %6 Uniform
 )";

   EXPECT_EQ(RunPass(spirv), result);
   EXPECT_EQ(GetErrorMessage(), "");
 }

 // In this test, %8 and %9 are the same and only %9 is used in a resource.
 // However, we cannot merge them unless we also merge %2 and %3, which cannot
 // happen because both are used in resources.
 //
 // If we try to avoid replaces resource types, then remove duplicates should
 // have not change in this case.  That is not currently implemented.
 TEST_F(RemoveDuplicatesTest, MergeResourceTypeWithNonresourceType3) {
   const std::string spirv = R"(OpCapability Shader
 OpMemoryModel Logical GLSL450
 OpEntryPoint GLCompute %1 "main"
 OpSource HLSL 600
 OpName %2 "PositionAdjust"
 OpMemberName %2 0 "XAdjust"
 OpName %3 "NormalAdjust"
 OpMemberName %3 0 "XDir"
 OpName %4 "Constants"
 OpMemberDecorate %2 0 Offset 0
 OpMemberDecorate %3 0 Offset 0
 OpDecorate %4 DescriptorSet 0
 OpDecorate %4 Binding 0
 OpDecorate %5 DescriptorSet 1
 OpDecorate %5 Binding 0
 %6 = OpTypeFloat 32
 %7 = OpTypeVector %6 3
 %2 = OpTypeStruct %7
 %3 = OpTypeStruct %7
 %8 = OpTypePointer Uniform %3
 %9 = OpTypePointer Uniform %2
 %10 = OpTypeStruct %3
 %11 = OpTypePointer Uniform %10
 %5 = OpVariable %9 Uniform
 %4 = OpVariable %11 Uniform
 %12 = OpTypeVoid
 %13 = OpTypeFunction %12
 %14 = OpTypeInt 32 0
 %15 = OpConstant %14 0
 %1 = OpFunction %12 None %13
 %16 = OpLabel
 %17 = OpAccessChain %8 %4 %15
 OpReturn
 OpFunctionEnd
 )";

   const std::string result = R"(OpCapability Shader
 OpMemoryModel Logical GLSL450
 OpEntryPoint GLCompute %1 "main"
 OpSource HLSL 600
 OpName %2 "PositionAdjust"
 OpMemberName %2 0 "XAdjust"
 OpName %4 "Constants"
 OpMemberDecorate %2 0 Offset 0
 OpDecorate %4 DescriptorSet 0
 OpDecorate %4 Binding 0
 OpDecorate %5 DescriptorSet 1
 OpDecorate %5 Binding 0
 %6 = OpTypeFloat 32
 %7 = OpTypeVector %6 3
 %2 = OpTypeStruct %7
 %8 = OpTypePointer Uniform %2
 %10 = OpTypeStruct %2
 %11 = OpTypePointer Uniform %10
 %5 = OpVariable %8 Uniform
 %4 = OpVariable %11 Uniform
 %12 = OpTypeVoid
 %13 = OpTypeFunction %12
 %14 = OpTypeInt 32 0
 %15 = OpConstant %14 0
 %1 = OpFunction %12 None %13
 %16 = OpLabel
 %17 = OpAccessChain %8 %4 %15
 OpReturn
 OpFunctionEnd
 )";

   EXPECT_EQ(RunPass(spirv), result);
   EXPECT_EQ(GetErrorMessage(), "");
 }

 }  // namespace
 }  // namespace opt
 }  // namespace spvtools
	// Copyright (c) 2017 Pierre Moreau
	//
	// Licensed under the Apache License, Version 2.0 (the "License");
	// you may not use this file except in compliance with the License.
	// You may obtain a copy of the License at
	//
	// http://www.apache.org/licenses/LICENSE-2.0
	//
	// Unless required by applicable law or agreed to in writing, software
	// distributed under the License is distributed on an "AS IS" BASIS,
	// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	// See the License for the specific language governing permissions and
	// limitations under the License.

	#include <iostream>
	#include <memory>
	#include <string>
	#include <vector>

	#include "gmock/gmock.h"
	#include "source/opt/build_module.h"
	#include "source/opt/ir_context.h"
	#include "source/opt/pass_manager.h"
	#include "source/opt/remove_duplicates_pass.h"
	#include "source/spirv_constant.h"
	#include "test/unit_spirv.h"

	namespace spvtools {
	namespace opt {
	namespace {

	class RemoveDuplicatesTest : public ::testing::Test {
	public:
	RemoveDuplicatesTest()
	: tools_(SPV_ENV_UNIVERSAL_1_2),
	context_(),
	consumer_([this](spv_message_level_t level, const char*,
	const spv_position_t& position, const char* message) {
	if (!error_message_.empty()) error_message_ += "\n";
	switch (level) {
	case SPV_MSG_FATAL:
	case SPV_MSG_INTERNAL_ERROR:
	case SPV_MSG_ERROR:
	error_message_ += "ERROR";
	break;
	case SPV_MSG_WARNING:
	error_message_ += "WARNING";
	break;
	case SPV_MSG_INFO:
	error_message_ += "INFO";
	break;
	case SPV_MSG_DEBUG:
	error_message_ += "DEBUG";
	break;
	}
	error_message_ +=
	": " + std::to_string(position.index) + ": " + message;
	}),
	disassemble_options_(SPV_BINARY_TO_TEXT_OPTION_NO_HEADER),
	error_message_() {
	tools_.SetMessageConsumer(consumer_);
	}

	void TearDown() override { error_message_.clear(); }

	std::string RunPass(const std::string& text) {
	context_ = spvtools::BuildModule(SPV_ENV_UNIVERSAL_1_2, consumer_, text);
	if (!context_.get()) return std::string();

	PassManager manager;
	manager.SetMessageConsumer(consumer_);
	manager.AddPass<RemoveDuplicatesPass>();

	Pass::Status pass_res = manager.Run(context_.get());
	if (pass_res == Pass::Status::Failure) return std::string();

	return ModuleToText();
	}

	// Disassembles \|binary\| and outputs the result in \|text\|. If \|text\| is a
	// null pointer, SPV_ERROR_INVALID_POINTER is returned.
	spv_result_t Disassemble(const std::vector<uint32_t>& binary,
	std::string* text) {
	if (!text) return SPV_ERROR_INVALID_POINTER;
	return tools_.Disassemble(binary, text, disassemble_options_)
	? SPV_SUCCESS
	: SPV_ERROR_INVALID_BINARY;
	}

	// Returns the accumulated error messages for the test.
	std::string GetErrorMessage() const { return error_message_; }

	std::string ToText(const std::vector<Instruction*>& inst) {
	std::vector<uint32_t> binary = {SpvMagicNumber, 0x10200, 0u, 2u, 0u};
	for (const Instruction* i : inst)
	i->ToBinaryWithoutAttachedDebugInsts(&binary);
	std::string text;
	Disassemble(binary, &text);
	return text;
	}

	std::string ModuleToText() {
	std::vector<uint32_t> binary;
	context_->module()->ToBinary(&binary, false);
	std::string text;
	Disassemble(binary, &text);
	return text;
	}

	private:
	spvtools::SpirvTools
	tools_; // An instance for calling SPIRV-Tools functionalities.
	std::unique_ptr<IRContext> context_;
	spvtools::MessageConsumer consumer_;
	uint32_t disassemble_options_;
	std::string error_message_;
	};

	TEST_F(RemoveDuplicatesTest, DuplicateCapabilities) {
	const std::string spirv = R"(
	OpCapability Shader
	OpCapability Linkage
	OpCapability Shader
	OpMemoryModel Logical GLSL450
	)";
	const std::string after = R"(OpCapability Shader
	OpCapability Linkage
	OpMemoryModel Logical GLSL450
	)";

	EXPECT_EQ(RunPass(spirv), after);
	EXPECT_EQ(GetErrorMessage(), "");
	}

	TEST_F(RemoveDuplicatesTest, DuplicateExtInstImports) {
	const std::string spirv = R"(
	OpCapability Shader
	OpCapability Linkage
	%1 = OpExtInstImport "OpenCL.std"
	%2 = OpExtInstImport "OpenCL.std"
	%3 = OpExtInstImport "GLSL.std.450"
	OpMemoryModel Logical GLSL450
	)";
	const std::string after = R"(OpCapability Shader
	OpCapability Linkage
	%1 = OpExtInstImport "OpenCL.std"
	%3 = OpExtInstImport "GLSL.std.450"
	OpMemoryModel Logical GLSL450
	)";

	EXPECT_EQ(RunPass(spirv), after);
	EXPECT_EQ(GetErrorMessage(), "");
	}

	TEST_F(RemoveDuplicatesTest, DuplicateTypes) {
	const std::string spirv = R"(
	OpCapability Shader
	OpCapability Linkage
	OpMemoryModel Logical GLSL450
	%1 = OpTypeInt 32 0
	%2 = OpTypeInt 32 0
	%3 = OpTypeStruct %1 %2
	)";
	const std::string after = R"(OpCapability Shader
	OpCapability Linkage
	OpMemoryModel Logical GLSL450
	%1 = OpTypeInt 32 0
	%3 = OpTypeStruct %1 %1
	)";

	EXPECT_EQ(RunPass(spirv), after);
	EXPECT_EQ(GetErrorMessage(), "");
	}

	TEST_F(RemoveDuplicatesTest, SameTypeDifferentMemberDecoration) {
	const std::string spirv = R"(
	OpCapability Shader
	OpCapability Linkage
	OpMemoryModel Logical GLSL450
	OpDecorate %1 GLSLPacked
	%2 = OpTypeInt 32 0
	%1 = OpTypeStruct %2 %2
	%3 = OpTypeStruct %2 %2
	)";
	const std::string after = R"(OpCapability Shader
	OpCapability Linkage
	OpMemoryModel Logical GLSL450
	OpDecorate %1 GLSLPacked
	%2 = OpTypeInt 32 0
	%1 = OpTypeStruct %2 %2
	%3 = OpTypeStruct %2 %2
	)";

	EXPECT_EQ(RunPass(spirv), after);
	EXPECT_EQ(GetErrorMessage(), "");
	}

	TEST_F(RemoveDuplicatesTest, SameTypeAndMemberDecoration) {
	const std::string spirv = R"(
	OpCapability Shader
	OpCapability Linkage
	OpMemoryModel Logical GLSL450
	OpDecorate %1 GLSLPacked
	OpDecorate %2 GLSLPacked
	%3 = OpTypeInt 32 0
	%1 = OpTypeStruct %3 %3
	%2 = OpTypeStruct %3 %3
	)";
	const std::string after = R"(OpCapability Shader
	OpCapability Linkage
	OpMemoryModel Logical GLSL450
	OpDecorate %1 GLSLPacked
	%3 = OpTypeInt 32 0
	%1 = OpTypeStruct %3 %3
	)";

	EXPECT_EQ(RunPass(spirv), after);
	EXPECT_EQ(GetErrorMessage(), "");
	}

	TEST_F(RemoveDuplicatesTest, SameTypeAndDifferentName) {
	const std::string spirv = R"(
	OpCapability Shader
	OpCapability Linkage
	OpMemoryModel Logical GLSL450
	OpName %1 "Type1"
	OpName %2 "Type2"
	%3 = OpTypeInt 32 0
	%1 = OpTypeStruct %3 %3
	%2 = OpTypeStruct %3 %3
	)";
	const std::string after = R"(OpCapability Shader
	OpCapability Linkage
	OpMemoryModel Logical GLSL450
	OpName %1 "Type1"
	%3 = OpTypeInt 32 0
	%1 = OpTypeStruct %3 %3
	)";

	EXPECT_EQ(RunPass(spirv), after);
	EXPECT_EQ(GetErrorMessage(), "");
	}

	// Check that #1033 has been fixed.
	TEST_F(RemoveDuplicatesTest, DoNotRemoveDifferentOpDecorationGroup) {
	const std::string spirv = R"(
	OpCapability Shader
	OpCapability Linkage
	OpMemoryModel Logical GLSL450
	OpDecorate %1 Constant
	%1 = OpDecorationGroup
	OpDecorate %2 Restrict
	%2 = OpDecorationGroup
	OpGroupDecorate %3 %1 %2
	%4 = OpTypeInt 32 0
	%3 = OpVariable %4 Uniform
	)";
	const std::string after = R"(OpCapability Shader
	OpCapability Linkage
	OpMemoryModel Logical GLSL450
	OpDecorate %1 Constant
	%1 = OpDecorationGroup
	OpDecorate %2 Restrict
	%2 = OpDecorationGroup
	OpGroupDecorate %3 %1 %2
	%4 = OpTypeInt 32 0
	%3 = OpVariable %4 Uniform
	)";

	EXPECT_EQ(RunPass(spirv), after);
	EXPECT_EQ(GetErrorMessage(), "");
	}

	TEST_F(RemoveDuplicatesTest, DifferentDecorationGroup) {
	const std::string spirv = R"(
	OpCapability Shader
	OpCapability Linkage
	OpMemoryModel Logical GLSL450
	OpDecorate %1 Constant
	OpDecorate %1 Restrict
	%1 = OpDecorationGroup
	OpDecorate %2 Constant
	%2 = OpDecorationGroup
	OpGroupDecorate %1 %3
	OpGroupDecorate %2 %4
	%5 = OpTypeInt 32 0
	%3 = OpVariable %5 Uniform
	%4 = OpVariable %5 Uniform
	)";
	const std::string after = R"(OpCapability Shader
	OpCapability Linkage
	OpMemoryModel Logical GLSL450
	OpDecorate %1 Constant
	OpDecorate %1 Restrict
	%1 = OpDecorationGroup
	OpDecorate %2 Constant
	%2 = OpDecorationGroup
	OpGroupDecorate %1 %3
	OpGroupDecorate %2 %4
	%5 = OpTypeInt 32 0
	%3 = OpVariable %5 Uniform
	%4 = OpVariable %5 Uniform
	)";

	EXPECT_EQ(RunPass(spirv), after);
	EXPECT_EQ(GetErrorMessage(), "");
	}

	// Test what happens when a type is a resource type. For now we are merging
	// them, but, if we want to merge types and make reflection work (issue #1372),
	// we will not be able to merge %2 and %3 below.
	TEST_F(RemoveDuplicatesTest, DontMergeNestedResourceTypes) {
	const std::string spirv = R"(OpCapability Shader
	OpMemoryModel Logical GLSL450
	OpSource HLSL 600
	OpName %1 "PositionAdjust"
	OpMemberName %1 0 "XAdjust"
	OpName %2 "NormalAdjust"
	OpMemberName %2 0 "XDir"
	OpMemberName %3 0 "AdjustXYZ"
	OpMemberName %3 1 "AdjustDir"
	OpName %4 "Constants"
	OpMemberDecorate %1 0 Offset 0
	OpMemberDecorate %2 0 Offset 0
	OpMemberDecorate %3 0 Offset 0
	OpMemberDecorate %3 1 Offset 16
	OpDecorate %3 Block
	OpDecorate %4 DescriptorSet 0
	OpDecorate %4 Binding 0
	%5 = OpTypeFloat 32
	%6 = OpTypeVector %5 3
	%1 = OpTypeStruct %6
	%2 = OpTypeStruct %6
	%3 = OpTypeStruct %1 %2
	%7 = OpTypePointer Uniform %3
	%4 = OpVariable %7 Uniform
	)";

	const std::string result = R"(OpCapability Shader
	OpMemoryModel Logical GLSL450
	OpSource HLSL 600
	OpName %1 "PositionAdjust"
	OpMemberName %1 0 "XAdjust"
	OpMemberName %3 0 "AdjustXYZ"
	OpMemberName %3 1 "AdjustDir"
	OpName %4 "Constants"
	OpMemberDecorate %1 0 Offset 0
	OpMemberDecorate %3 0 Offset 0
	OpMemberDecorate %3 1 Offset 16
	OpDecorate %3 Block
	OpDecorate %4 DescriptorSet 0
	OpDecorate %4 Binding 0
	%5 = OpTypeFloat 32
	%6 = OpTypeVector %5 3
	%1 = OpTypeStruct %6
	%3 = OpTypeStruct %1 %1
	%7 = OpTypePointer Uniform %3
	%4 = OpVariable %7 Uniform
	)";

	EXPECT_EQ(RunPass(spirv), result);
	EXPECT_EQ(GetErrorMessage(), "");
	}

	// See comment for DontMergeNestedResourceTypes.
	TEST_F(RemoveDuplicatesTest, DontMergeResourceTypes) {
	const std::string spirv = R"(OpCapability Shader
	OpMemoryModel Logical GLSL450
	OpSource HLSL 600
	OpName %1 "PositionAdjust"
	OpMemberName %1 0 "XAdjust"
	OpName %2 "NormalAdjust"
	OpMemberName %2 0 "XDir"
	OpName %3 "Constants"
	OpMemberDecorate %1 0 Offset 0
	OpMemberDecorate %2 0 Offset 0
	OpDecorate %3 DescriptorSet 0
	OpDecorate %3 Binding 0
	OpDecorate %4 DescriptorSet 1
	OpDecorate %4 Binding 0
	%5 = OpTypeFloat 32
	%6 = OpTypeVector %5 3
	%1 = OpTypeStruct %6
	%2 = OpTypeStruct %6
	%7 = OpTypePointer Uniform %1
	%8 = OpTypePointer Uniform %2
	%3 = OpVariable %7 Uniform
	%4 = OpVariable %8 Uniform
	)";

	const std::string result = R"(OpCapability Shader
	OpMemoryModel Logical GLSL450
	OpSource HLSL 600
	OpName %1 "PositionAdjust"
	OpMemberName %1 0 "XAdjust"
	OpName %3 "Constants"
	OpMemberDecorate %1 0 Offset 0
	OpDecorate %3 DescriptorSet 0
	OpDecorate %3 Binding 0
	OpDecorate %4 DescriptorSet 1
	OpDecorate %4 Binding 0
	%5 = OpTypeFloat 32
	%6 = OpTypeVector %5 3
	%1 = OpTypeStruct %6
	%7 = OpTypePointer Uniform %1
	%3 = OpVariable %7 Uniform
	%4 = OpVariable %7 Uniform
	)";

	EXPECT_EQ(RunPass(spirv), result);
	EXPECT_EQ(GetErrorMessage(), "");
	}

	// See comment for DontMergeNestedResourceTypes.
	TEST_F(RemoveDuplicatesTest, DontMergeResourceTypesContainingArray) {
	const std::string spirv = R"(OpCapability Shader
	OpMemoryModel Logical GLSL450
	OpSource HLSL 600
	OpName %1 "PositionAdjust"
	OpMemberName %1 0 "XAdjust"
	OpName %2 "NormalAdjust"
	OpMemberName %2 0 "XDir"
	OpName %3 "Constants"
	OpMemberDecorate %1 0 Offset 0
	OpMemberDecorate %2 0 Offset 0
	OpDecorate %3 DescriptorSet 0
	OpDecorate %3 Binding 0
	OpDecorate %4 DescriptorSet 1
	OpDecorate %4 Binding 0
	%5 = OpTypeFloat 32
	%6 = OpTypeVector %5 3
	%1 = OpTypeStruct %6
	%2 = OpTypeStruct %6
	%7 = OpTypeInt 32 0
	%8 = OpConstant %7 4
	%9 = OpTypeArray %1 %8
	%10 = OpTypeArray %2 %8
	%11 = OpTypePointer Uniform %9
	%12 = OpTypePointer Uniform %10
	%3 = OpVariable %11 Uniform
	%4 = OpVariable %12 Uniform
	)";

	const std::string result = R"(OpCapability Shader
	OpMemoryModel Logical GLSL450
	OpSource HLSL 600
	OpName %1 "PositionAdjust"
	OpMemberName %1 0 "XAdjust"
	OpName %3 "Constants"
	OpMemberDecorate %1 0 Offset 0
	OpDecorate %3 DescriptorSet 0
	OpDecorate %3 Binding 0
	OpDecorate %4 DescriptorSet 1
	OpDecorate %4 Binding 0
	%5 = OpTypeFloat 32
	%6 = OpTypeVector %5 3
	%1 = OpTypeStruct %6
	%7 = OpTypeInt 32 0
	%8 = OpConstant %7 4
	%9 = OpTypeArray %1 %8
	%11 = OpTypePointer Uniform %9
	%3 = OpVariable %11 Uniform
	%4 = OpVariable %11 Uniform
	)";

	EXPECT_EQ(RunPass(spirv), result);
	EXPECT_EQ(GetErrorMessage(), "");
	}

	// Test that we merge the type of a resource with a type that is not the type
	// a resource. The resource type appears first in this case. We must keep
	// the resource type.
	TEST_F(RemoveDuplicatesTest, MergeResourceTypeWithNonresourceType1) {
	const std::string spirv = R"(OpCapability Shader
	OpMemoryModel Logical GLSL450
	OpSource HLSL 600
	OpName %1 "PositionAdjust"
	OpMemberName %1 0 "XAdjust"
	OpName %2 "NormalAdjust"
	OpMemberName %2 0 "XDir"
	OpName %3 "Constants"
	OpMemberDecorate %1 0 Offset 0
	OpMemberDecorate %2 0 Offset 0
	OpDecorate %3 DescriptorSet 0
	OpDecorate %3 Binding 0
	%4 = OpTypeFloat 32
	%5 = OpTypeVector %4 3
	%1 = OpTypeStruct %5
	%2 = OpTypeStruct %5
	%6 = OpTypePointer Uniform %1
	%7 = OpTypePointer Uniform %2
	%3 = OpVariable %6 Uniform
	%8 = OpVariable %7 Uniform
	)";

	const std::string result = R"(OpCapability Shader
	OpMemoryModel Logical GLSL450
	OpSource HLSL 600
	OpName %1 "PositionAdjust"
	OpMemberName %1 0 "XAdjust"
	OpName %3 "Constants"
	OpMemberDecorate %1 0 Offset 0
	OpDecorate %3 DescriptorSet 0
	OpDecorate %3 Binding 0
	%4 = OpTypeFloat 32
	%5 = OpTypeVector %4 3
	%1 = OpTypeStruct %5
	%6 = OpTypePointer Uniform %1
	%3 = OpVariable %6 Uniform
	%8 = OpVariable %6 Uniform
	)";

	EXPECT_EQ(RunPass(spirv), result);
	EXPECT_EQ(GetErrorMessage(), "");
	}

	// Test that we merge the type of a resource with a type that is not the type
	// a resource. The resource type appears second in this case. We must keep
	// the resource type.
	//
	// See comment for DontMergeNestedResourceTypes.
	TEST_F(RemoveDuplicatesTest, MergeResourceTypeWithNonresourceType2) {
	const std::string spirv = R"(OpCapability Shader
	OpMemoryModel Logical GLSL450
	OpSource HLSL 600
	OpName %1 "PositionAdjust"
	OpMemberName %1 0 "XAdjust"
	OpName %2 "NormalAdjust"
	OpMemberName %2 0 "XDir"
	OpName %3 "Constants"
	OpMemberDecorate %1 0 Offset 0
	OpMemberDecorate %2 0 Offset 0
	OpDecorate %3 DescriptorSet 0
	OpDecorate %3 Binding 0
	%4 = OpTypeFloat 32
	%5 = OpTypeVector %4 3
	%1 = OpTypeStruct %5
	%2 = OpTypeStruct %5
	%6 = OpTypePointer Uniform %1
	%7 = OpTypePointer Uniform %2
	%8 = OpVariable %6 Uniform
	%3 = OpVariable %7 Uniform
	)";

	const std::string result = R"(OpCapability Shader
	OpMemoryModel Logical GLSL450
	OpSource HLSL 600
	OpName %1 "PositionAdjust"
	OpMemberName %1 0 "XAdjust"
	OpName %3 "Constants"
	OpMemberDecorate %1 0 Offset 0
	OpDecorate %3 DescriptorSet 0
	OpDecorate %3 Binding 0
	%4 = OpTypeFloat 32
	%5 = OpTypeVector %4 3
	%1 = OpTypeStruct %5
	%6 = OpTypePointer Uniform %1
	%8 = OpVariable %6 Uniform
	%3 = OpVariable %6 Uniform
	)";

	EXPECT_EQ(RunPass(spirv), result);
	EXPECT_EQ(GetErrorMessage(), "");
	}

	// In this test, %8 and %9 are the same and only %9 is used in a resource.
	// However, we cannot merge them unless we also merge %2 and %3, which cannot
	// happen because both are used in resources.
	//
	// If we try to avoid replaces resource types, then remove duplicates should
	// have not change in this case. That is not currently implemented.
	TEST_F(RemoveDuplicatesTest, MergeResourceTypeWithNonresourceType3) {
	const std::string spirv = R"(OpCapability Shader
	OpMemoryModel Logical GLSL450
	OpEntryPoint GLCompute %1 "main"
	OpSource HLSL 600
	OpName %2 "PositionAdjust"
	OpMemberName %2 0 "XAdjust"
	OpName %3 "NormalAdjust"
	OpMemberName %3 0 "XDir"
	OpName %4 "Constants"
	OpMemberDecorate %2 0 Offset 0
	OpMemberDecorate %3 0 Offset 0
	OpDecorate %4 DescriptorSet 0
	OpDecorate %4 Binding 0
	OpDecorate %5 DescriptorSet 1
	OpDecorate %5 Binding 0
	%6 = OpTypeFloat 32
	%7 = OpTypeVector %6 3
	%2 = OpTypeStruct %7
	%3 = OpTypeStruct %7
	%8 = OpTypePointer Uniform %3
	%9 = OpTypePointer Uniform %2
	%10 = OpTypeStruct %3
	%11 = OpTypePointer Uniform %10
	%5 = OpVariable %9 Uniform
	%4 = OpVariable %11 Uniform
	%12 = OpTypeVoid
	%13 = OpTypeFunction %12
	%14 = OpTypeInt 32 0
	%15 = OpConstant %14 0
	%1 = OpFunction %12 None %13
	%16 = OpLabel
	%17 = OpAccessChain %8 %4 %15
	OpReturn
	OpFunctionEnd
	)";

	const std::string result = R"(OpCapability Shader
	OpMemoryModel Logical GLSL450
	OpEntryPoint GLCompute %1 "main"
	OpSource HLSL 600
	OpName %2 "PositionAdjust"
	OpMemberName %2 0 "XAdjust"
	OpName %4 "Constants"
	OpMemberDecorate %2 0 Offset 0
	OpDecorate %4 DescriptorSet 0
	OpDecorate %4 Binding 0
	OpDecorate %5 DescriptorSet 1
	OpDecorate %5 Binding 0
	%6 = OpTypeFloat 32
	%7 = OpTypeVector %6 3
	%2 = OpTypeStruct %7
	%8 = OpTypePointer Uniform %2
	%10 = OpTypeStruct %2
	%11 = OpTypePointer Uniform %10
	%5 = OpVariable %8 Uniform
	%4 = OpVariable %11 Uniform
	%12 = OpTypeVoid
	%13 = OpTypeFunction %12
	%14 = OpTypeInt 32 0
	%15 = OpConstant %14 0
	%1 = OpFunction %12 None %13
	%16 = OpLabel
	%17 = OpAccessChain %8 %4 %15
	OpReturn
	OpFunctionEnd
	)";

	EXPECT_EQ(RunPass(spirv), result);
	EXPECT_EQ(GetErrorMessage(), "");
	}

	} // namespace
	} // namespace opt
	} // namespace spvtools