src/tint/lang/glsl/writer/raise/offset_first_index_test.cc

// Copyright 2024 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/glsl/writer/raise/offset_first_index.h"

#include "gtest/gtest.h"
#include "src/tint/lang/core/fluent_types.h"
#include "src/tint/lang/core/ir/transform/helper_test.h"
#include "src/tint/lang/core/number.h"

using namespace tint::core::fluent_types;     // NOLINT
using namespace tint::core::number_suffixes;  // NOLINT

namespace tint::glsl::writer::raise {
namespace {

using GlslWriter_OffsetFirstIndexTest = core::ir::transform::TransformTest;

TEST_F(GlslWriter_OffsetFirstIndexTest, NoModify_NoBuiltins) {
    auto* func = b.Function("foo", ty.vec4<f32>(), core::ir::Function::PipelineStage::kVertex);
    func->SetReturnBuiltin(core::BuiltinValue::kPosition);
    b.Append(func->Block(), [&] {  //
        b.Return(func, b.Zero(ty.vec4<f32>()));
    });

    auto* src = R"(
%foo = @vertex func():vec4<f32> [@position] {
  $B1: {
    ret vec4<f32>(0.0f)
  }
}
)";
    EXPECT_EQ(src, str());

    auto* expect = src;

    core::ir::transform::PreparePushConstantsConfig push_constants_config;
    auto push_constants = PreparePushConstants(mod, push_constants_config);
    EXPECT_EQ(push_constants, Success);

    OffsetFirstIndexConfig config{push_constants.Get()};
    config.first_vertex_offset = 4;
    config.first_instance_offset = 8;
    Run(OffsetFirstIndex, config);
    EXPECT_EQ(expect, str());
}

TEST_F(GlslWriter_OffsetFirstIndexTest, NoModify_BuiltinsWithNoOffsets) {
    core::IOAttributes attributes;

    auto* vertex_idx = b.Var("vertex_index", ty.ptr(core::AddressSpace::kIn, ty.u32()));
    attributes.builtin = core::BuiltinValue::kVertexIndex;
    vertex_idx->SetAttributes(attributes);
    mod.root_block->Append(vertex_idx);

    auto* instance_idx = b.Var("instance_index", ty.ptr(core::AddressSpace::kIn, ty.u32()));
    attributes.builtin = core::BuiltinValue::kInstanceIndex;
    instance_idx->SetAttributes(attributes);
    mod.root_block->Append(instance_idx);

    auto* func = b.Function("foo", ty.vec4<f32>(), core::ir::Function::PipelineStage::kVertex);
    func->SetReturnBuiltin(core::BuiltinValue::kPosition);

    b.Append(func->Block(), [&] {
        auto* vertex = b.Convert<u32>(b.Load(vertex_idx));
        auto* instance = b.Convert<u32>(b.Load(instance_idx));
        b.Let("add", b.Add<u32>(vertex, instance));
        b.Return(func, b.Zero(ty.vec4<f32>()));
    });

    auto* src = R"(
$B1: {  # root
  %vertex_index:ptr<__in, u32, read> = var @builtin(vertex_index)
  %instance_index:ptr<__in, u32, read> = var @builtin(instance_index)
}

%foo = @vertex func():vec4<f32> [@position] {
  $B2: {
    %4:u32 = load %vertex_index
    %5:u32 = convert %4
    %6:u32 = load %instance_index
    %7:u32 = convert %6
    %8:u32 = add %5, %7
    %add:u32 = let %8
    ret vec4<f32>(0.0f)
  }
}
)";
    EXPECT_EQ(src, str());

    auto* expect = src;

    core::ir::transform::PreparePushConstantsConfig push_constants_config;
    auto push_constants = PreparePushConstants(mod, push_constants_config);
    EXPECT_EQ(push_constants, Success);

    OffsetFirstIndexConfig config{push_constants.Get()};
    Run(OffsetFirstIndex, config);
    EXPECT_EQ(expect, str());
}

TEST_F(GlslWriter_OffsetFirstIndexTest, VertexOffset) {
    core::IOAttributes attributes;

    auto* vertex_idx = b.Var("vertex_index", ty.ptr(core::AddressSpace::kIn, ty.u32()));
    attributes.builtin = core::BuiltinValue::kVertexIndex;
    vertex_idx->SetAttributes(attributes);
    mod.root_block->Append(vertex_idx);

    auto* instance_idx = b.Var("instance_index", ty.ptr(core::AddressSpace::kIn, ty.u32()));
    attributes.builtin = core::BuiltinValue::kInstanceIndex;
    instance_idx->SetAttributes(attributes);
    mod.root_block->Append(instance_idx);

    auto* func = b.Function("foo", ty.vec4<f32>(), core::ir::Function::PipelineStage::kVertex);
    func->SetReturnBuiltin(core::BuiltinValue::kPosition);

    b.Append(func->Block(), [&] {
        auto* vertex = b.Convert<u32>(b.Load(vertex_idx));
        auto* instance = b.Convert<u32>(b.Load(instance_idx));
        b.Let("add", b.Add<u32>(vertex, instance));
        b.Return(func, b.Zero(ty.vec4<f32>()));
    });

    auto* src = R"(
$B1: {  # root
  %vertex_index:ptr<__in, u32, read> = var @builtin(vertex_index)
  %instance_index:ptr<__in, u32, read> = var @builtin(instance_index)
}

%foo = @vertex func():vec4<f32> [@position] {
  $B2: {
    %4:u32 = load %vertex_index
    %5:u32 = convert %4
    %6:u32 = load %instance_index
    %7:u32 = convert %6
    %8:u32 = add %5, %7
    %add:u32 = let %8
    ret vec4<f32>(0.0f)
  }
}
)";
    EXPECT_EQ(src, str());

    auto* expect = R"(
tint_push_constant_struct = struct @align(4), @block {
  first_vertex:u32 @offset(4)
}

$B1: {  # root
  %vertex_index:ptr<__in, u32, read> = var @builtin(vertex_index)
  %instance_index:ptr<__in, u32, read> = var @builtin(instance_index)
  %tint_push_constants:ptr<push_constant, tint_push_constant_struct, read> = var
}

%foo = @vertex func():vec4<f32> [@position] {
  $B2: {
    %5:u32 = load %vertex_index
    %6:u32 = convert %5
    %7:ptr<push_constant, u32, read> = access %tint_push_constants, 0u
    %8:u32 = load %7
    %9:u32 = add %6, %8
    %10:u32 = load %instance_index
    %11:u32 = convert %10
    %12:u32 = add %9, %11
    %add:u32 = let %12
    ret vec4<f32>(0.0f)
  }
}
)";

    core::ir::transform::PreparePushConstantsConfig push_constants_config;
    push_constants_config.AddInternalConstant(4, mod.symbols.New("first_vertex"), ty.u32());
    auto push_constants = PreparePushConstants(mod, push_constants_config);
    EXPECT_EQ(push_constants, Success);

    OffsetFirstIndexConfig config{push_constants.Get()};
    config.first_vertex_offset = 4;
    Run(OffsetFirstIndex, config);
    EXPECT_EQ(expect, str());
}

TEST_F(GlslWriter_OffsetFirstIndexTest, InstanceOffset) {
    core::IOAttributes attributes;

    auto* vertex_idx = b.Var("vertex_index", ty.ptr(core::AddressSpace::kIn, ty.u32()));
    attributes.builtin = core::BuiltinValue::kVertexIndex;
    vertex_idx->SetAttributes(attributes);
    mod.root_block->Append(vertex_idx);

    auto* instance_idx = b.Var("instance_index", ty.ptr(core::AddressSpace::kIn, ty.u32()));
    attributes.builtin = core::BuiltinValue::kInstanceIndex;
    instance_idx->SetAttributes(attributes);
    mod.root_block->Append(instance_idx);

    auto* func = b.Function("foo", ty.vec4<f32>(), core::ir::Function::PipelineStage::kVertex);
    func->SetReturnBuiltin(core::BuiltinValue::kPosition);

    b.Append(func->Block(), [&] {
        auto* vertex = b.Convert<u32>(b.Load(vertex_idx));
        auto* instance = b.Convert<u32>(b.Load(instance_idx));
        b.Let("add", b.Add<u32>(vertex, instance));
        b.Return(func, b.Zero(ty.vec4<f32>()));
    });

    auto* src = R"(
$B1: {  # root
  %vertex_index:ptr<__in, u32, read> = var @builtin(vertex_index)
  %instance_index:ptr<__in, u32, read> = var @builtin(instance_index)
}

%foo = @vertex func():vec4<f32> [@position] {
  $B2: {
    %4:u32 = load %vertex_index
    %5:u32 = convert %4
    %6:u32 = load %instance_index
    %7:u32 = convert %6
    %8:u32 = add %5, %7
    %add:u32 = let %8
    ret vec4<f32>(0.0f)
  }
}
)";
    EXPECT_EQ(src, str());

    auto* expect = R"(
tint_push_constant_struct = struct @align(4), @block {
  first_instance:u32 @offset(4)
}

$B1: {  # root
  %vertex_index:ptr<__in, u32, read> = var @builtin(vertex_index)
  %instance_index:ptr<__in, u32, read> = var @builtin(instance_index)
  %tint_push_constants:ptr<push_constant, tint_push_constant_struct, read> = var
}

%foo = @vertex func():vec4<f32> [@position] {
  $B2: {
    %5:u32 = load %vertex_index
    %6:u32 = convert %5
    %7:u32 = load %instance_index
    %8:u32 = convert %7
    %9:ptr<push_constant, u32, read> = access %tint_push_constants, 0u
    %10:u32 = load %9
    %11:u32 = add %8, %10
    %12:u32 = add %6, %11
    %add:u32 = let %12
    ret vec4<f32>(0.0f)
  }
}
)";

    core::ir::transform::PreparePushConstantsConfig push_constants_config;
    push_constants_config.AddInternalConstant(4, mod.symbols.New("first_instance"), ty.u32());
    auto push_constants = PreparePushConstants(mod, push_constants_config);
    EXPECT_EQ(push_constants, Success);

    OffsetFirstIndexConfig config{push_constants.Get()};
    config.first_instance_offset = 4;
    Run(OffsetFirstIndex, config);
    EXPECT_EQ(expect, str());
}

TEST_F(GlslWriter_OffsetFirstIndexTest, VertexAndInstanceOffset) {
    core::IOAttributes attributes;

    auto* vertex_idx = b.Var("vertex_index", ty.ptr(core::AddressSpace::kIn, ty.u32()));
    attributes.builtin = core::BuiltinValue::kVertexIndex;
    vertex_idx->SetAttributes(attributes);
    mod.root_block->Append(vertex_idx);

    auto* instance_idx = b.Var("instance_index", ty.ptr(core::AddressSpace::kIn, ty.u32()));
    attributes.builtin = core::BuiltinValue::kInstanceIndex;
    instance_idx->SetAttributes(attributes);
    mod.root_block->Append(instance_idx);

    auto* func = b.Function("foo", ty.vec4<f32>(), core::ir::Function::PipelineStage::kVertex);
    func->SetReturnBuiltin(core::BuiltinValue::kPosition);

    b.Append(func->Block(), [&] {
        auto* vertex = b.Convert<u32>(b.Load(vertex_idx));
        auto* instance = b.Convert<u32>(b.Load(instance_idx));
        b.Let("add", b.Add<u32>(vertex, instance));
        b.Return(func, b.Zero(ty.vec4<f32>()));
    });

    auto* src = R"(
$B1: {  # root
  %vertex_index:ptr<__in, u32, read> = var @builtin(vertex_index)
  %instance_index:ptr<__in, u32, read> = var @builtin(instance_index)
}

%foo = @vertex func():vec4<f32> [@position] {
  $B2: {
    %4:u32 = load %vertex_index
    %5:u32 = convert %4
    %6:u32 = load %instance_index
    %7:u32 = convert %6
    %8:u32 = add %5, %7
    %add:u32 = let %8
    ret vec4<f32>(0.0f)
  }
}
)";
    EXPECT_EQ(src, str());

    auto* expect = R"(
tint_push_constant_struct = struct @align(4), @block {
  first_vertex:u32 @offset(4)
  first_instance:u32 @offset(8)
}

$B1: {  # root
  %vertex_index:ptr<__in, u32, read> = var @builtin(vertex_index)
  %instance_index:ptr<__in, u32, read> = var @builtin(instance_index)
  %tint_push_constants:ptr<push_constant, tint_push_constant_struct, read> = var
}

%foo = @vertex func():vec4<f32> [@position] {
  $B2: {
    %5:u32 = load %vertex_index
    %6:u32 = convert %5
    %7:ptr<push_constant, u32, read> = access %tint_push_constants, 0u
    %8:u32 = load %7
    %9:u32 = add %6, %8
    %10:u32 = load %instance_index
    %11:u32 = convert %10
    %12:ptr<push_constant, u32, read> = access %tint_push_constants, 1u
    %13:u32 = load %12
    %14:u32 = add %11, %13
    %15:u32 = add %9, %14
    %add:u32 = let %15
    ret vec4<f32>(0.0f)
  }
}
)";

    core::ir::transform::PreparePushConstantsConfig push_constants_config;
    push_constants_config.AddInternalConstant(4, mod.symbols.New("first_vertex"), ty.u32());
    push_constants_config.AddInternalConstant(8, mod.symbols.New("first_instance"), ty.u32());
    auto push_constants = PreparePushConstants(mod, push_constants_config);
    EXPECT_EQ(push_constants, Success);

    OffsetFirstIndexConfig config{push_constants.Get()};
    config.first_vertex_offset = 4;
    config.first_instance_offset = 8;
    Run(OffsetFirstIndex, config);
    EXPECT_EQ(expect, str());
}

}  // namespace
}  // namespace tint::glsl::writer::raise