src/tint/lang/spirv/reader/parser/bit_test.cc

// Copyright 2025 The Dawn & Tint Authors
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
//
// 2. 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.
//
// 3. Neither the name of the copyright holder 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 HOLDER 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.

#include "src/tint/lang/spirv/reader/parser/helper_test.h"

namespace tint::spirv::reader {
namespace {

struct SpirvBitwiseParam {
    std::string name;
};
[[maybe_unused]] inline std::ostream& operator<<(std::ostream& out, SpirvBitwiseParam c) {
    out << c.name;
    return out;
}

using SpirvParser_BitwiseTest = SpirvParserTestWithParam<SpirvBitwiseParam>;

TEST_P(SpirvParser_BitwiseTest, Scalar_SignedSigned_Signed) {
    auto& params = GetParam();
    EXPECT_IR(R"(
               OpCapability Shader
               OpMemoryModel Logical GLSL450
               OpEntryPoint GLCompute %main "main"
               OpExecutionMode %main LocalSize 1 1 1
       %void = OpTypeVoid
        %int = OpTypeInt 32 1
        %one = OpConstant %int 1
        %two = OpConstant %int 2
    %void_fn = OpTypeFunction %void

       %main = OpFunction %void None %void_fn
 %main_start = OpLabel
               %1 = OpBitwise)" +
                  params.name + R"( %int %one %two
               OpReturn
               OpFunctionEnd
)",
              R"(
%main = @compute @workgroup_size(1u, 1u, 1u) func():void {
  $B1: {
    %2:i32 = spirv.bitwise)" +
                  params.name + R"(<i32> 1i, 2i
    ret
  }
}
)");
}

TEST_P(SpirvParser_BitwiseTest, Scalar_SignedUnsigned_Signed) {
    auto& params = GetParam();
    EXPECT_IR(R"(
               OpCapability Shader
               OpMemoryModel Logical GLSL450
               OpEntryPoint GLCompute %main "main"
               OpExecutionMode %main LocalSize 1 1 1
       %void = OpTypeVoid
       %uint = OpTypeInt 32 0
        %int = OpTypeInt 32 1
        %one = OpConstant %int 1
        %two = OpConstant %int 2
      %eight = OpConstant %uint 8
       %nine = OpConstant %uint 9
    %void_fn = OpTypeFunction %void

       %main = OpFunction %void None %void_fn
 %main_start = OpLabel
               %1 = OpBitwise)" +
                  params.name + R"( %int %one %eight
               OpReturn
               OpFunctionEnd
)",
              R"(
%main = @compute @workgroup_size(1u, 1u, 1u) func():void {
  $B1: {
    %2:i32 = spirv.bitwise)" +
                  params.name + R"(<i32> 1i, 8u
    ret
  }
}
)");
}

TEST_P(SpirvParser_BitwiseTest, Scalar_UnsignedSigned_Signed) {
    auto& params = GetParam();
    EXPECT_IR(R"(
               OpCapability Shader
               OpMemoryModel Logical GLSL450
               OpEntryPoint GLCompute %main "main"
               OpExecutionMode %main LocalSize 1 1 1
       %void = OpTypeVoid
       %uint = OpTypeInt 32 0
        %int = OpTypeInt 32 1
        %one = OpConstant %int 1
        %two = OpConstant %int 2
      %eight = OpConstant %uint 8
       %nine = OpConstant %uint 9
    %void_fn = OpTypeFunction %void

       %main = OpFunction %void None %void_fn
 %main_start = OpLabel
               %1 = OpBitwise)" +
                  params.name + R"( %int %eight %one
               OpReturn
               OpFunctionEnd
)",
              R"(
%main = @compute @workgroup_size(1u, 1u, 1u) func():void {
  $B1: {
    %2:i32 = spirv.bitwise)" +
                  params.name + R"(<i32> 8u, 1i
    ret
  }
}
)");
}

TEST_P(SpirvParser_BitwiseTest, Scalar_UnsignedUnsigned_Signed) {
    auto& params = GetParam();
    EXPECT_IR(R"(
               OpCapability Shader
               OpMemoryModel Logical GLSL450
               OpEntryPoint GLCompute %main "main"
               OpExecutionMode %main LocalSize 1 1 1
       %void = OpTypeVoid
       %uint = OpTypeInt 32 0
        %int = OpTypeInt 32 1
        %one = OpConstant %int 1
        %two = OpConstant %int 2
      %eight = OpConstant %uint 8
       %nine = OpConstant %uint 9
    %void_fn = OpTypeFunction %void

       %main = OpFunction %void None %void_fn
 %main_start = OpLabel
               %1 = OpBitwise)" +
                  params.name + R"( %int %eight %nine
               OpReturn
               OpFunctionEnd
)",
              R"(
%main = @compute @workgroup_size(1u, 1u, 1u) func():void {
  $B1: {
    %2:i32 = spirv.bitwise)" +
                  params.name + R"(<i32> 8u, 9u
    ret
  }
}
)");
}

TEST_P(SpirvParser_BitwiseTest, Scalar_UnsignedUnsigned_Unsigned) {
    auto& params = GetParam();
    EXPECT_IR(R"(
               OpCapability Shader
               OpMemoryModel Logical GLSL450
               OpEntryPoint GLCompute %main "main"
               OpExecutionMode %main LocalSize 1 1 1
       %void = OpTypeVoid
        %int = OpTypeInt 32 1
       %uint = OpTypeInt 32 0
        %one = OpConstant %int 1
        %two = OpConstant %int 2
      %eight = OpConstant %uint 8
       %nine = OpConstant %uint 9
    %void_fn = OpTypeFunction %void

       %main = OpFunction %void None %void_fn
 %main_start = OpLabel
               %1 = OpBitwise)" +
                  params.name + R"( %uint %eight %nine
               OpReturn
               OpFunctionEnd
)",
              R"(
%main = @compute @workgroup_size(1u, 1u, 1u) func():void {
  $B1: {
    %2:u32 = spirv.bitwise)" +
                  params.name + R"(<u32> 8u, 9u
    ret
  }
}
)");
}

TEST_P(SpirvParser_BitwiseTest, Scalar_UnsignedSigned_Unsigned) {
    auto& params = GetParam();
    EXPECT_IR(R"(
               OpCapability Shader
               OpMemoryModel Logical GLSL450
               OpEntryPoint GLCompute %main "main"
               OpExecutionMode %main LocalSize 1 1 1
       %void = OpTypeVoid
       %uint = OpTypeInt 32 0
        %int = OpTypeInt 32 1
        %one = OpConstant %int 1
        %two = OpConstant %int 2
      %eight = OpConstant %uint 8
       %nine = OpConstant %uint 9
    %void_fn = OpTypeFunction %void

       %main = OpFunction %void None %void_fn
 %main_start = OpLabel
               %1 = OpBitwise)" +
                  params.name + R"( %uint %eight %one
               OpReturn
               OpFunctionEnd
)",
              R"(
%main = @compute @workgroup_size(1u, 1u, 1u) func():void {
  $B1: {
    %2:u32 = spirv.bitwise)" +
                  params.name + R"(<u32> 8u, 1i
    ret
  }
}
)");
}

TEST_P(SpirvParser_BitwiseTest, Scalar_SignedUnsigned_Unsigned) {
    auto& params = GetParam();
    EXPECT_IR(R"(
               OpCapability Shader
               OpMemoryModel Logical GLSL450
               OpEntryPoint GLCompute %main "main"
               OpExecutionMode %main LocalSize 1 1 1
       %void = OpTypeVoid
       %uint = OpTypeInt 32 0
        %int = OpTypeInt 32 1
        %one = OpConstant %int 1
        %two = OpConstant %int 2
      %eight = OpConstant %uint 8
       %nine = OpConstant %uint 9
    %void_fn = OpTypeFunction %void

       %main = OpFunction %void None %void_fn
 %main_start = OpLabel
               %1 = OpBitwise)" +
                  params.name + R"( %uint %one %eight
               OpReturn
               OpFunctionEnd
)",
              R"(
%main = @compute @workgroup_size(1u, 1u, 1u) func():void {
  $B1: {
    %2:u32 = spirv.bitwise)" +
                  params.name + R"(<u32> 1i, 8u
    ret
  }
}
)");
}

TEST_P(SpirvParser_BitwiseTest, Scalar_SignedSigned_Unsigned) {
    auto& params = GetParam();
    EXPECT_IR(R"(
               OpCapability Shader
               OpMemoryModel Logical GLSL450
               OpEntryPoint GLCompute %main "main"
               OpExecutionMode %main LocalSize 1 1 1
       %void = OpTypeVoid
       %uint = OpTypeInt 32 0
        %int = OpTypeInt 32 1
        %one = OpConstant %int 1
        %two = OpConstant %int 2
      %eight = OpConstant %uint 8
       %nine = OpConstant %uint 9
    %void_fn = OpTypeFunction %void

       %main = OpFunction %void None %void_fn
 %main_start = OpLabel
               %1 = OpBitwise)" +
                  params.name + R"( %uint %one %two
               OpReturn
               OpFunctionEnd
)",
              R"(
%main = @compute @workgroup_size(1u, 1u, 1u) func():void {
  $B1: {
    %2:u32 = spirv.bitwise)" +
                  params.name + R"(<u32> 1i, 2i
    ret
  }
}
)");
}

TEST_P(SpirvParser_BitwiseTest, Vector_SignedSigned_Signed) {
    auto& params = GetParam();
    EXPECT_IR(R"(
               OpCapability Shader
               OpMemoryModel Logical GLSL450
               OpEntryPoint GLCompute %main "main"
               OpExecutionMode %main LocalSize 1 1 1
       %void = OpTypeVoid
       %uint = OpTypeInt 32 0
        %int = OpTypeInt 32 1
     %v2uint = OpTypeVector %uint 2
      %v2int = OpTypeVector %int 2
        %one = OpConstant %int 1
        %two = OpConstant %int 2
      %eight = OpConstant %uint 8
       %nine = OpConstant %uint 9
      %v2one = OpConstantComposite %v2int %one %one
      %v2two = OpConstantComposite %v2int %two %two
    %v2eight = OpConstantComposite %v2uint %eight %eight
     %v2nine = OpConstantComposite %v2uint %nine %nine
    %void_fn = OpTypeFunction %void

       %main = OpFunction %void None %void_fn
 %main_start = OpLabel
               %1 = OpBitwise)" +
                  params.name + R"( %v2int %v2one %v2two
               OpReturn
               OpFunctionEnd
)",
              R"(
%main = @compute @workgroup_size(1u, 1u, 1u) func():void {
  $B1: {
    %2:vec2<i32> = spirv.bitwise)" +
                  params.name + R"(<i32> vec2<i32>(1i), vec2<i32>(2i)
    ret
  }
}
)");
}

TEST_P(SpirvParser_BitwiseTest, Vector_SignedUnsigned_Signed) {
    auto& params = GetParam();
    EXPECT_IR(R"(
               OpCapability Shader
               OpMemoryModel Logical GLSL450
               OpEntryPoint GLCompute %main "main"
               OpExecutionMode %main LocalSize 1 1 1
       %void = OpTypeVoid
       %uint = OpTypeInt 32 0
        %int = OpTypeInt 32 1
     %v2uint = OpTypeVector %uint 2
      %v2int = OpTypeVector %int 2
        %one = OpConstant %int 1
        %two = OpConstant %int 2
      %eight = OpConstant %uint 8
       %nine = OpConstant %uint 9
      %v2one = OpConstantComposite %v2int %one %one
      %v2two = OpConstantComposite %v2int %two %two
    %v2eight = OpConstantComposite %v2uint %eight %eight
     %v2nine = OpConstantComposite %v2uint %nine %nine
    %void_fn = OpTypeFunction %void

       %main = OpFunction %void None %void_fn
 %main_start = OpLabel
               %1 = OpBitwise)" +
                  params.name + R"( %v2int %v2one %v2eight
               OpReturn
               OpFunctionEnd
)",
              R"(
%main = @compute @workgroup_size(1u, 1u, 1u) func():void {
  $B1: {
    %2:vec2<i32> = spirv.bitwise)" +
                  params.name + R"(<i32> vec2<i32>(1i), vec2<u32>(8u)
    ret
  }
}
)");
}

TEST_P(SpirvParser_BitwiseTest, Vector_UnsignedSigned_Signed) {
    auto& params = GetParam();
    EXPECT_IR(R"(
               OpCapability Shader
               OpMemoryModel Logical GLSL450
               OpEntryPoint GLCompute %main "main"
               OpExecutionMode %main LocalSize 1 1 1
       %void = OpTypeVoid
       %uint = OpTypeInt 32 0
        %int = OpTypeInt 32 1
     %v2uint = OpTypeVector %uint 2
      %v2int = OpTypeVector %int 2
        %one = OpConstant %int 1
        %two = OpConstant %int 2
      %eight = OpConstant %uint 8
       %nine = OpConstant %uint 9
      %v2one = OpConstantComposite %v2int %one %one
      %v2two = OpConstantComposite %v2int %two %two
    %v2eight = OpConstantComposite %v2uint %eight %eight
     %v2nine = OpConstantComposite %v2uint %nine %nine
    %void_fn = OpTypeFunction %void

       %main = OpFunction %void None %void_fn
 %main_start = OpLabel
               %1 = OpBitwise)" +
                  params.name + R"( %v2int %v2eight %v2one
               OpReturn
               OpFunctionEnd
)",
              R"(
%main = @compute @workgroup_size(1u, 1u, 1u) func():void {
  $B1: {
    %2:vec2<i32> = spirv.bitwise)" +
                  params.name + R"(<i32> vec2<u32>(8u), vec2<i32>(1i)
    ret
  }
}
)");
}

TEST_P(SpirvParser_BitwiseTest, Vector_UnsignedUnsigned_Signed) {
    auto& params = GetParam();
    EXPECT_IR(R"(
               OpCapability Shader
               OpMemoryModel Logical GLSL450
               OpEntryPoint GLCompute %main "main"
               OpExecutionMode %main LocalSize 1 1 1
       %void = OpTypeVoid
       %uint = OpTypeInt 32 0
        %int = OpTypeInt 32 1
     %v2uint = OpTypeVector %uint 2
      %v2int = OpTypeVector %int 2
        %one = OpConstant %int 1
        %two = OpConstant %int 2
      %eight = OpConstant %uint 8
       %nine = OpConstant %uint 9
      %v2one = OpConstantComposite %v2int %one %one
      %v2two = OpConstantComposite %v2int %two %two
    %v2eight = OpConstantComposite %v2uint %eight %eight
     %v2nine = OpConstantComposite %v2uint %nine %nine
    %void_fn = OpTypeFunction %void

       %main = OpFunction %void None %void_fn
 %main_start = OpLabel
               %1 = OpBitwise)" +
                  params.name + R"( %v2int %v2eight %v2nine
               OpReturn
               OpFunctionEnd
)",
              R"(
%main = @compute @workgroup_size(1u, 1u, 1u) func():void {
  $B1: {
    %2:vec2<i32> = spirv.bitwise)" +
                  params.name + R"(<i32> vec2<u32>(8u), vec2<u32>(9u)
    ret
  }
}
)");
}

TEST_P(SpirvParser_BitwiseTest, Vector_UnsignedUnsigned_Unsigned) {
    auto& params = GetParam();
    EXPECT_IR(R"(
               OpCapability Shader
               OpMemoryModel Logical GLSL450
               OpEntryPoint GLCompute %main "main"
               OpExecutionMode %main LocalSize 1 1 1
       %void = OpTypeVoid
       %uint = OpTypeInt 32 0
        %int = OpTypeInt 32 1
     %v2uint = OpTypeVector %uint 2
      %v2int = OpTypeVector %int 2
        %one = OpConstant %int 1
        %two = OpConstant %int 2
      %eight = OpConstant %uint 8
       %nine = OpConstant %uint 9
      %v2one = OpConstantComposite %v2int %one %one
      %v2two = OpConstantComposite %v2int %two %two
    %v2eight = OpConstantComposite %v2uint %eight %eight
     %v2nine = OpConstantComposite %v2uint %nine %nine
    %void_fn = OpTypeFunction %void

       %main = OpFunction %void None %void_fn
 %main_start = OpLabel
               %1 = OpBitwise)" +
                  params.name + R"( %v2uint %v2eight %v2nine
               OpReturn
               OpFunctionEnd
)",
              R"(
%main = @compute @workgroup_size(1u, 1u, 1u) func():void {
  $B1: {
    %2:vec2<u32> = spirv.bitwise)" +
                  params.name + R"(<u32> vec2<u32>(8u), vec2<u32>(9u)
    ret
  }
}
)");
}

TEST_P(SpirvParser_BitwiseTest, Vector_UnsignedSigned_Unsigned) {
    auto& params = GetParam();
    EXPECT_IR(R"(
               OpCapability Shader
               OpMemoryModel Logical GLSL450
               OpEntryPoint GLCompute %main "main"
               OpExecutionMode %main LocalSize 1 1 1
       %void = OpTypeVoid
       %uint = OpTypeInt 32 0
        %int = OpTypeInt 32 1
     %v2uint = OpTypeVector %uint 2
      %v2int = OpTypeVector %int 2
        %one = OpConstant %int 1
        %two = OpConstant %int 2
      %eight = OpConstant %uint 8
       %nine = OpConstant %uint 9
      %v2one = OpConstantComposite %v2int %one %one
      %v2two = OpConstantComposite %v2int %two %two
    %v2eight = OpConstantComposite %v2uint %eight %eight
     %v2nine = OpConstantComposite %v2uint %nine %nine
    %void_fn = OpTypeFunction %void

       %main = OpFunction %void None %void_fn
 %main_start = OpLabel
               %1 = OpBitwise)" +
                  params.name + R"( %v2uint %v2eight %v2one
               OpReturn
               OpFunctionEnd
)",
              R"(
%main = @compute @workgroup_size(1u, 1u, 1u) func():void {
  $B1: {
    %2:vec2<u32> = spirv.bitwise)" +
                  params.name + R"(<u32> vec2<u32>(8u), vec2<i32>(1i)
    ret
  }
}
)");
}

TEST_P(SpirvParser_BitwiseTest, Vector_SignedUnsigned_Unsigned) {
    auto& params = GetParam();
    EXPECT_IR(R"(
               OpCapability Shader
               OpMemoryModel Logical GLSL450
               OpEntryPoint GLCompute %main "main"
               OpExecutionMode %main LocalSize 1 1 1
       %void = OpTypeVoid
       %uint = OpTypeInt 32 0
        %int = OpTypeInt 32 1
     %v2uint = OpTypeVector %uint 2
      %v2int = OpTypeVector %int 2
        %one = OpConstant %int 1
        %two = OpConstant %int 2
      %eight = OpConstant %uint 8
       %nine = OpConstant %uint 9
      %v2one = OpConstantComposite %v2int %one %one
      %v2two = OpConstantComposite %v2int %two %two
    %v2eight = OpConstantComposite %v2uint %eight %eight
     %v2nine = OpConstantComposite %v2uint %nine %nine
    %void_fn = OpTypeFunction %void

       %main = OpFunction %void None %void_fn
 %main_start = OpLabel
               %1 = OpBitwise)" +
                  params.name + R"( %v2uint %v2one %v2eight
               OpReturn
               OpFunctionEnd
)",
              R"(
%main = @compute @workgroup_size(1u, 1u, 1u) func():void {
  $B1: {
    %2:vec2<u32> = spirv.bitwise)" +
                  params.name + R"(<u32> vec2<i32>(1i), vec2<u32>(8u)
    ret
  }
}
)");
}

TEST_P(SpirvParser_BitwiseTest, Vector_SignedSigned_Unsigned) {
    auto& params = GetParam();
    EXPECT_IR(R"(
               OpCapability Shader
               OpMemoryModel Logical GLSL450
               OpEntryPoint GLCompute %main "main"
               OpExecutionMode %main LocalSize 1 1 1
       %void = OpTypeVoid
       %uint = OpTypeInt 32 0
        %int = OpTypeInt 32 1
     %v2uint = OpTypeVector %uint 2
      %v2int = OpTypeVector %int 2
        %one = OpConstant %int 1
        %two = OpConstant %int 2
      %eight = OpConstant %uint 8
       %nine = OpConstant %uint 9
      %v2one = OpConstantComposite %v2int %one %one
      %v2two = OpConstantComposite %v2int %two %two
    %v2eight = OpConstantComposite %v2uint %eight %eight
     %v2nine = OpConstantComposite %v2uint %nine %nine
    %void_fn = OpTypeFunction %void

       %main = OpFunction %void None %void_fn
 %main_start = OpLabel
               %1 = OpBitwise)" +
                  params.name + R"( %v2uint %v2one %v2two
               OpReturn
               OpFunctionEnd
)",
              R"(
%main = @compute @workgroup_size(1u, 1u, 1u) func():void {
  $B1: {
    %2:vec2<u32> = spirv.bitwise)" +
                  params.name + R"(<u32> vec2<i32>(1i), vec2<i32>(2i)
    ret
  }
}
)");
}

INSTANTIATE_TEST_SUITE_P(SpirvParser,
                         SpirvParser_BitwiseTest,
                         testing::Values(SpirvBitwiseParam{"And"},  //
                                         SpirvBitwiseParam{"Or"},   //
                                         SpirvBitwiseParam{"Xor"}));

}  // namespace
}  // namespace tint::spirv::reader