Skip to content

Commit

Permalink
[glsl] Move combined texture sampler naming to printer
Browse files Browse the repository at this point in the history
Instead of setting the name for combined texture sampler variables in
the TexturePolyfill transform, apply them in the Printer instead. We
do this by adding a new instruction for combined texture sampler
variables that the polyfill transform generates. The printer can then
perform the map lookup to find the desired name.

This removes the need to preserve the names that are held in the IR
module, which in turn simplifies the renaming process.

Bug: 380043958
Change-Id: I47b50927847eaaf93384049457cf3d01da48e789
Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/219234
Reviewed-by: Antonio Maiorano <[email protected]>
Commit-Queue: James Price <[email protected]>
  • Loading branch information
jrprice authored and Dawn LUCI CQ committed Dec 13, 2024
1 parent 65727b7 commit 02b5367
Show file tree
Hide file tree
Showing 17 changed files with 410 additions and 592 deletions.
2 changes: 1 addition & 1 deletion src/tint/lang/core/ir/var.h
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
namespace tint::core::ir {

/// A var instruction in the IR.
class Var final : public Castable<Var, OperandInstruction<1, 1>> {
class Var : public Castable<Var, OperandInstruction<1, 1>> {
public:
/// The offset in Operands() for the initializer
static constexpr size_t kInitializerOperandOffset = 0;
Expand Down
3 changes: 3 additions & 0 deletions src/tint/lang/glsl/ir/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,12 @@ cc_library(
name = "ir",
srcs = [
"builtin_call.cc",
"combined_texture_sampler_var.cc",
"member_builtin_call.cc",
],
hdrs = [
"builtin_call.h",
"combined_texture_sampler_var.h",
"member_builtin_call.h",
],
deps = [
Expand Down Expand Up @@ -76,6 +78,7 @@ cc_library(
alwayslink = True,
srcs = [
"builtin_call_test.cc",
"combined_texture_sampler_var_test.cc",
"member_builtin_call_test.cc",
],
deps = [
Expand Down
3 changes: 3 additions & 0 deletions src/tint/lang/glsl/ir/BUILD.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@
tint_add_target(tint_lang_glsl_ir lib
lang/glsl/ir/builtin_call.cc
lang/glsl/ir/builtin_call.h
lang/glsl/ir/combined_texture_sampler_var.cc
lang/glsl/ir/combined_texture_sampler_var.h
lang/glsl/ir/member_builtin_call.cc
lang/glsl/ir/member_builtin_call.h
)
Expand Down Expand Up @@ -77,6 +79,7 @@ tint_target_add_external_dependencies(tint_lang_glsl_ir lib
################################################################################
tint_add_target(tint_lang_glsl_ir_test test
lang/glsl/ir/builtin_call_test.cc
lang/glsl/ir/combined_texture_sampler_var_test.cc
lang/glsl/ir/member_builtin_call_test.cc
)

Expand Down
3 changes: 3 additions & 0 deletions src/tint/lang/glsl/ir/BUILD.gn
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ libtint_source_set("ir") {
sources = [
"builtin_call.cc",
"builtin_call.h",
"combined_texture_sampler_var.cc",
"combined_texture_sampler_var.h",
"member_builtin_call.cc",
"member_builtin_call.h",
]
Expand Down Expand Up @@ -77,6 +79,7 @@ if (tint_build_unittests) {
tint_unittests_source_set("unittests") {
sources = [
"builtin_call_test.cc",
"combined_texture_sampler_var_test.cc",
"member_builtin_call_test.cc",
]
deps = [
Expand Down
56 changes: 56 additions & 0 deletions src/tint/lang/glsl/ir/combined_texture_sampler_var.cc
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
// 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/ir/combined_texture_sampler_var.h"

#include <utility>

#include "src/tint/lang/core/ir/clone_context.h"
#include "src/tint/lang/core/ir/module.h"
#include "src/tint/utils/ice/ice.h"

TINT_INSTANTIATE_TYPEINFO(tint::glsl::ir::CombinedTextureSamplerVar);

namespace tint::glsl::ir {

CombinedTextureSamplerVar::CombinedTextureSamplerVar(Id id,
core::ir::InstructionResult* result,
tint::BindingPoint texture_bp,
tint::BindingPoint sampler_bp)
: Base(id, result), sampler_binding_point_(sampler_bp) {
SetBindingPoint(texture_bp.group, texture_bp.binding);
}

CombinedTextureSamplerVar::~CombinedTextureSamplerVar() = default;

CombinedTextureSamplerVar* CombinedTextureSamplerVar::Clone(core::ir::CloneContext& ctx) {
auto* new_result = ctx.Clone(Result(0));
return ctx.ir.CreateInstruction<CombinedTextureSamplerVar>(new_result, TextureBindingPoint(),
SamplerBindingPoint());
}

} // namespace tint::glsl::ir
75 changes: 75 additions & 0 deletions src/tint/lang/glsl/ir/combined_texture_sampler_var.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
// 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.

#ifndef SRC_TINT_LANG_GLSL_IR_COMBINED_TEXTURE_SAMPLER_VAR_H_
#define SRC_TINT_LANG_GLSL_IR_COMBINED_TEXTURE_SAMPLER_VAR_H_

#include <string>

#include "src/tint/lang/core/ir/var.h"
#include "src/tint/utils/rtti/castable.h"

namespace tint::glsl::ir {

/// A combined texture sampler variable instruction in the IR.
class CombinedTextureSamplerVar final : public Castable<CombinedTextureSamplerVar, core::ir::Var> {
public:
/// Constructor
/// @param id the instruction id
/// @param result the result value
/// @param texture_bp the texture binding point
/// @param sampler_bp the sampler binding point
CombinedTextureSamplerVar(Id id,
core::ir::InstructionResult* result,
tint::BindingPoint texture_bp,
tint::BindingPoint sampler_bp);

~CombinedTextureSamplerVar() override;

/// @returns the texture binding point
tint::BindingPoint TextureBindingPoint() {
auto bp = BindingPoint();
TINT_ASSERT(bp);
return *bp;
}

/// @returns the sampler binding point
tint::BindingPoint SamplerBindingPoint() { return sampler_binding_point_; }

/// @copydoc core::ir::Instruction::Clone()
CombinedTextureSamplerVar* Clone(core::ir::CloneContext& ctx) override;

/// @returns the friendly name for the instruction
std::string FriendlyName() const override { return "combined_texture_sampler"; }

private:
tint::BindingPoint sampler_binding_point_;
};

} // namespace tint::glsl::ir

#endif // SRC_TINT_LANG_GLSL_IR_COMBINED_TEXTURE_SAMPLER_VAR_H_
63 changes: 63 additions & 0 deletions src/tint/lang/glsl/ir/combined_texture_sampler_var_test.cc
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
// 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/ir/combined_texture_sampler_var.h"

#include "gtest/gtest.h"
#include "src/tint/lang/core/ir/ir_helper_test.h"
#include "src/tint/lang/core/ir/validator.h"
#include "src/tint/lang/core/type/sampled_texture.h"

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

namespace tint::glsl::ir {
namespace {

using namespace tint::core::number_suffixes; // NOLINT
//
using IR_GlslCombinedTextureSamplerTest = core::ir::IRTestHelper;

TEST_F(IR_GlslCombinedTextureSamplerTest, Clone) {
BindingPoint texture_bp{1, 2};
BindingPoint sampler_bp{3, 4};
auto* type = ty.ptr<handle>(
ty.Get<core::type::SampledTexture>(core::type::TextureDimension::k2d, ty.f32()));
auto* var = mod.CreateInstruction<CombinedTextureSamplerVar>(b.InstructionResult(type),
texture_bp, sampler_bp);

auto* new_var = clone_ctx.Clone(var);

EXPECT_NE(var, new_var);
EXPECT_NE(var->Result(0), new_var->Result(0));
EXPECT_EQ(new_var->Result(0)->Type(), type);

EXPECT_EQ(new_var->TextureBindingPoint(), texture_bp);
EXPECT_EQ(new_var->SamplerBindingPoint(), sampler_bp);
}

} // namespace
} // namespace tint::glsl::ir
5 changes: 5 additions & 0 deletions src/tint/lang/glsl/writer/printer/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@ cc_library(
"//src/tint/lang/glsl",
"//src/tint/lang/glsl/intrinsic",
"//src/tint/lang/glsl/ir",
"//src/tint/lang/wgsl",
"//src/tint/lang/wgsl/ast",
"//src/tint/lang/wgsl/ast/transform",
"//src/tint/lang/wgsl/program",
"//src/tint/lang/wgsl/sem",
"//src/tint/utils",
"//src/tint/utils/containers",
"//src/tint/utils/diagnostic",
Expand Down
5 changes: 5 additions & 0 deletions src/tint/lang/glsl/writer/printer/BUILD.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@ tint_target_add_dependencies(tint_lang_glsl_writer_printer lib
tint_lang_glsl
tint_lang_glsl_intrinsic
tint_lang_glsl_ir
tint_lang_wgsl
tint_lang_wgsl_ast
tint_lang_wgsl_ast_transform
tint_lang_wgsl_program
tint_lang_wgsl_sem
tint_utils
tint_utils_containers
tint_utils_diagnostic
Expand Down
5 changes: 5 additions & 0 deletions src/tint/lang/glsl/writer/printer/BUILD.gn
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@ if (tint_build_glsl_writer) {
"${tint_src_dir}/lang/glsl",
"${tint_src_dir}/lang/glsl/intrinsic",
"${tint_src_dir}/lang/glsl/ir",
"${tint_src_dir}/lang/wgsl",
"${tint_src_dir}/lang/wgsl/ast",
"${tint_src_dir}/lang/wgsl/ast/transform",
"${tint_src_dir}/lang/wgsl/program",
"${tint_src_dir}/lang/wgsl/sem",
"${tint_src_dir}/utils",
"${tint_src_dir}/utils/containers",
"${tint_src_dir}/utils/diagnostic",
Expand Down
Loading

0 comments on commit 02b5367

Please sign in to comment.