src/compiler/spirv/tests/control_flow_tests.cpp

/*
 * Copyright © 2023 Intel Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

#include <gtest/gtest.h>

#include "helpers.h"

class ControlFlow : public spirv_test {};

TEST_F(ControlFlow, Basic)
{
   /*
    ; Extra arguments for spirv-as --target-env spv1.3

               OpCapability Shader
          %1 = OpExtInstImport "GLSL.std.450"
               OpMemoryModel Logical GLSL450
               OpEntryPoint GLCompute %4 "main"
               OpExecutionMode %4 LocalSize 1 1 1
               OpMemberDecorate %_struct_7 0 Offset 0
               OpDecorate %_struct_7 BufferBlock
               OpDecorate %9 DescriptorSet 0
               OpDecorate %9 Binding 0
       %void = OpTypeVoid
          %3 = OpTypeFunction %void
       %uint = OpTypeInt 32 0
  %_struct_7 = OpTypeStruct %uint
%_ptr_Uniform__struct_7 = OpTypePointer Uniform %_struct_7
          %9 = OpVariable %_ptr_Uniform__struct_7 Uniform
        %int = OpTypeInt 32 1
      %int_0 = OpConstant %int 0
%_ptr_Uniform_uint = OpTypePointer Uniform %uint
          %4 = OpFunction %void None %3
          %5 = OpLabel
         %13 = OpAccessChain %_ptr_Uniform_uint %9 %int_0
         %14 = OpLoad %uint %13 Volatile
               OpStore %13 %14
               OpReturn
               OpFunctionEnd
    */
   static const uint32_t words[] = {
      0x07230203, 0x00010300, 0x00070000, 0x0000000f, 0x00000000, 0x00020011,
      0x00000001, 0x0006000b, 0x00000001, 0x4c534c47, 0x6474732e, 0x3035342e,
      0x00000000, 0x0003000e, 0x00000000, 0x00000001, 0x0005000f, 0x00000005,
      0x00000002, 0x6e69616d, 0x00000000, 0x00060010, 0x00000002, 0x00000011,
      0x00000001, 0x00000001, 0x00000001, 0x00050048, 0x00000003, 0x00000000,
      0x00000023, 0x00000000, 0x00030047, 0x00000003, 0x00000003, 0x00040047,
      0x00000004, 0x00000022, 0x00000000, 0x00040047, 0x00000004, 0x00000021,
      0x00000000, 0x00020013, 0x00000005, 0x00030021, 0x00000006, 0x00000005,
      0x00040015, 0x00000007, 0x00000020, 0x00000000, 0x0003001e, 0x00000003,
      0x00000007, 0x00040020, 0x00000008, 0x00000002, 0x00000003, 0x0004003b,
      0x00000008, 0x00000004, 0x00000002, 0x00040015, 0x00000009, 0x00000020,
      0x00000001, 0x0004002b, 0x00000009, 0x0000000a, 0x00000000, 0x00040020,
      0x0000000b, 0x00000002, 0x00000007, 0x00050036, 0x00000005, 0x00000002,
      0x00000000, 0x00000006, 0x000200f8, 0x0000000c, 0x00050041, 0x0000000b,
      0x0000000d, 0x00000004, 0x0000000a, 0x0005003d, 0x00000007, 0x0000000e,
      0x0000000d, 0x00000001, 0x0003003e, 0x0000000d, 0x0000000e, 0x000100fd,
      0x00010038,
   };
   get_nir(sizeof(words) / sizeof(words[0]), words);
   ASSERT_TRUE(shader);
}

TEST_F(ControlFlow, BreakIfConditionWithLoop)
{
   // From https://gitlab.khronos.org/spirv/SPIR-V/-/issues/659.

   /*
    ; Extra arguments for spirv-as --target-env spv1.5

OpCapability Shader
OpMemoryModel Logical Simple
OpEntryPoint GLCompute %100 "main"
OpExecutionMode %100 LocalSize 1 1 1
%void = OpTypeVoid
%8 = OpTypeFunction %void
%bool = OpTypeBool
%cond = OpConstantNull %bool ;  a boring "false".

%100 = OpFunction %void None %8
%10 = OpLabel
OpBranch %20

%20 = OpLabel
OpLoopMerge %90 %80 None
OpBranch %30

   %30 = OpLabel
   OpSelectionMerge %50 None
   OpBranchConditional %cond %90 %50

   %50 = OpLabel
   OpBranch %80

   %80 = OpLabel ; continue target for loop
   OpBranch %20

%90 = OpLabel ; merge for loop
OpReturn
OpFunctionEnd
 */
   static const uint32_t words[] = {
      0x07230203, 0x00010500, 0x00070000, 0x0000000c, 0x00000000, 0x00020011,
      0x00000001, 0x0003000e, 0x00000000, 0x00000000, 0x0005000f, 0x00000005,
      0x00000001, 0x6e69616d, 0x00000000, 0x00060010, 0x00000001, 0x00000011,
      0x00000001, 0x00000001, 0x00000001, 0x00020013, 0x00000002, 0x00030021,
      0x00000003, 0x00000002, 0x00020014, 0x00000004, 0x0003002e, 0x00000004,
      0x00000005, 0x00050036, 0x00000002, 0x00000001, 0x00000000, 0x00000003,
      0x000200f8, 0x00000006, 0x000200f9, 0x00000007, 0x000200f8, 0x00000007,
      0x000400f6, 0x00000008, 0x00000009, 0x00000000, 0x000200f9, 0x0000000a,
      0x000200f8, 0x0000000a, 0x000300f7, 0x0000000b, 0x00000000, 0x000400fa,
      0x00000005, 0x00000008, 0x0000000b, 0x000200f8, 0x0000000b, 0x000200f9,
      0x00000009, 0x000200f8, 0x00000009, 0x000200f9, 0x00000007, 0x000200f8,
      0x00000008, 0x000100fd, 0x00010038,
   };
   get_nir(sizeof(words) / sizeof(words[0]), words);
   ASSERT_TRUE(shader);
}

TEST_F(ControlFlow, EarlyMerge)
{
   // From https://gitlab.khronos.org/spirv/SPIR-V/-/issues/640.

   /*
    ; Extra arguments for spirv-as --target-env spv1.0

               OpCapability Shader
          %1 = OpExtInstImport "GLSL.std.450"
               OpMemoryModel Logical GLSL450
               OpEntryPoint Fragment %main "main" %colour
               OpExecutionMode %main OriginUpperLeft
               OpSource GLSL 460
               OpName %main "main"
               OpName %colour "colour"
               OpDecorate %colour Location 0
       %void = OpTypeVoid
          %3 = OpTypeFunction %void
       %bool = OpTypeBool
      %false = OpConstantFalse %bool
       %true = OpConstantTrue %bool
      %float = OpTypeFloat 32
       %vec4 = OpTypeVector %float 4
      %pvec4 = OpTypePointer Output %vec4
     %colour = OpVariable %pvec4 Output
         %f0 = OpConstant %float 0.0
         %f1 = OpConstant %float 1.0
         %13 = OpConstantComposite %vec4 %f0 %f1 %f0 %f1
       %main = OpFunction %void None %3
         %B5 = OpLabel
               OpSelectionMerge %B8 None
               OpBranchConditional %true %B6 %B7
         %B6 = OpLabel
               OpBranch %B7
         %B7 = OpLabel
               OpBranch %B8
         %B8 = OpLabel
               OpStore %colour %13
               OpReturn
               OpFunctionEnd
    */
   static const uint32_t words[] = {
      0x07230203, 0x00010000, 0x00070000, 0x00000013, 0x00000000, 0x00020011,
      0x00000001, 0x0006000b, 0x00000001, 0x4c534c47, 0x6474732e, 0x3035342e,
      0x00000000, 0x0003000e, 0x00000000, 0x00000001, 0x0006000f, 0x00000004,
      0x00000002, 0x6e69616d, 0x00000000, 0x00000003, 0x00030010, 0x00000002,
      0x00000007, 0x00030003, 0x00000002, 0x000001cc, 0x00040005, 0x00000002,
      0x6e69616d, 0x00000000, 0x00040005, 0x00000003, 0x6f6c6f63, 0x00007275,
      0x00040047, 0x00000003, 0x0000001e, 0x00000000, 0x00020013, 0x00000004,
      0x00030021, 0x00000005, 0x00000004, 0x00020014, 0x00000006, 0x0003002a,
      0x00000006, 0x00000007, 0x00030029, 0x00000006, 0x00000008, 0x00030016,
      0x00000009, 0x00000020, 0x00040017, 0x0000000a, 0x00000009, 0x00000004,
      0x00040020, 0x0000000b, 0x00000003, 0x0000000a, 0x0004003b, 0x0000000b,
      0x00000003, 0x00000003, 0x0004002b, 0x00000009, 0x0000000c, 0x00000000,
      0x0004002b, 0x00000009, 0x0000000d, 0x3f800000, 0x0007002c, 0x0000000a,
      0x0000000e, 0x0000000c, 0x0000000d, 0x0000000c, 0x0000000d, 0x00050036,
      0x00000004, 0x00000002, 0x00000000, 0x00000005, 0x000200f8, 0x0000000f,
      0x000300f7, 0x00000010, 0x00000000, 0x000400fa, 0x00000008, 0x00000011,
      0x00000012, 0x000200f8, 0x00000011, 0x000200f9, 0x00000012, 0x000200f8,
      0x00000012, 0x000200f9, 0x00000010, 0x000200f8, 0x00000010, 0x0003003e,
      0x00000003, 0x0000000e, 0x000100fd, 0x00010038,
   };
   get_nir(sizeof(words) / sizeof(words[0]), words, MESA_SHADER_FRAGMENT);
   ASSERT_TRUE(shader);
}

TEST_F(ControlFlow, SingleBlockLoop)
{
   /*
OpCapability Shader
OpMemoryModel Logical Simple
OpEntryPoint GLCompute %100 "main"
OpExecutionMode %100 LocalSize 1 1 1
%void = OpTypeVoid
%8 = OpTypeFunction %void
%bool = OpTypeBool
%cond = OpConstantNull %bool

%100 = OpFunction %void None %8
%10 = OpLabel
OpBranch %20

%20 = OpLabel
OpLoopMerge %30 %20 None
OpBranchConditional %cond %20 %30

%30 = OpLabel
OpReturn
OpFunctionEnd
 */
   static const uint32_t words[] = {
      0x07230203, 0x00010600, 0x00070000, 0x00000009, 0x00000000, 0x00020011,
      0x00000001, 0x0003000e, 0x00000000, 0x00000000, 0x0005000f, 0x00000005,
      0x00000001, 0x6e69616d, 0x00000000, 0x00060010, 0x00000001, 0x00000011,
      0x00000001, 0x00000001, 0x00000001, 0x00020013, 0x00000002, 0x00030021,
      0x00000003, 0x00000002, 0x00020014, 0x00000004, 0x0003002e, 0x00000004,
      0x00000005, 0x00050036, 0x00000002, 0x00000001, 0x00000000, 0x00000003,
      0x000200f8, 0x00000006, 0x000200f9, 0x00000007, 0x000200f8, 0x00000007,
      0x000400f6, 0x00000008, 0x00000007, 0x00000000, 0x000400fa, 0x00000005,
      0x00000007, 0x00000008, 0x000200f8, 0x00000008, 0x000100fd, 0x00010038,
   };
   get_nir(ARRAY_SIZE(words), words, MESA_SHADER_COMPUTE);
   ASSERT_TRUE(shader);
}