src/tint/lang/core/ir/transform/prepare_immediate_data.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/core/ir/transform/prepare_immediate_data.h"

#include <utility>

#include "src/tint/lang/core/ir/builder.h"
#include "src/tint/lang/core/ir/module.h"
#include "src/tint/lang/core/ir/validator.h"

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

namespace tint::core::ir::transform {

namespace {

/// PIMPL state for the transform.
struct State {
    /// The transform config.
    const PrepareImmediateDataConfig& config;

    /// The IR module.
    Module& ir;

    /// The IR builder.
    Builder b{ir};

    /// The type manager.
    core::type::Manager& ty{ir.Types()};

    ImmediateDataLayout Run() {
        if (config.internal_immediate_data.empty()) {
            return ImmediateDataLayout{};
        }

        ImmediateDataLayout layout;
        Var* user_defined_immediates = nullptr;
        Vector<core::type::StructMember*, 4> members;

        // Check for user-defined immediate data.
        for (auto inst : *ir.root_block) {
            auto* var = inst->As<Var>();
            if (!var) {
                continue;
            }
            auto* ptr = var->Result()->Type()->As<core::type::Pointer>();
            if (ptr->AddressSpace() != core::AddressSpace::kImmediate) {
                continue;
            }

            if (user_defined_immediates) {
                TINT_ICE() << "multiple user-defined immediate data variables";
            }
            user_defined_immediates = var;

            // Assume that user-defined constants start at offset 0 until Dawn tells us otherwise.
            members.Push(ty.Get<core::type::StructMember>(ir.symbols.New("user_immediate_data"),
                                                          ptr->StoreType(),
                                                          /* index */ 0u,
                                                          /* offset */ 0u,
                                                          /* align */ ptr->StoreType()->Align(),
                                                          /* size */ ptr->StoreType()->Size(),
                                                          /* attributes */ IOAttributes{}));
        }

        // Create the structure and immediate data variable.
        for (auto& internal : config.internal_immediate_data) {
            if (!members.IsEmpty()) {
                TINT_ASSERT(internal.first >= members.Back()->Offset() + members.Back()->Size());
            }

            auto index = static_cast<uint32_t>(members.Length());
            layout.offset_to_index.Add(internal.first, index);
            members.Push(ty.Get<core::type::StructMember>(internal.second.name,
                                                          internal.second.type,
                                                          /* index */ index,
                                                          /* offset */ internal.first,
                                                          /* align */ internal.second.type->Align(),
                                                          /* size */ internal.second.type->Size(),
                                                          /* attributes */ IOAttributes{}));
        }
        auto* immediate_constant_struct =
            ty.Struct(ir.symbols.New("tint_immediate_data_struct"), std::move(members));
        immediate_constant_struct->SetStructFlag(type::kBlock);
        layout.var =
            b.Var("tint_immediate_data", core::AddressSpace::kImmediate, immediate_constant_struct);
        ir.root_block->Append(layout.var);

        // Update uses of the user defined immediate data variable.
        if (user_defined_immediates) {
            user_defined_immediates->Result()->ReplaceAllUsesWith([&](Usage use) {
                auto* access = b.Access(user_defined_immediates->Result()->Type(), layout.var, 0_u);
                access->InsertBefore(use.instruction);
                return access->Result();
            });
            user_defined_immediates->Destroy();
        }

        return layout;
    }
};

}  // namespace

Result<ImmediateDataLayout> PrepareImmediateData(Module& ir,
                                                 const PrepareImmediateDataConfig& config) {
    auto result = ValidateAndDumpIfNeeded(ir, "core.PrepareImmediateData");
    if (result != Success) {
        return result.Failure();
    }

    return State{config, ir}.Run();
}

}  // namespace tint::core::ir::transform