blob: ace6898461f0ccd10ef594741937064634f8990a [file] [log] [blame]
/// Copyright 2023 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/msl/writer/common/option_helpers.h"
#include <utility>
#include "src/tint/utils/containers/hashset.h"
namespace tint::msl::writer {
/// binding::BindingInfo to tint::BindingPoint map
using InfoToPointMap = tint::Hashmap<binding::BindingInfo, tint::BindingPoint, 8>;
Result<SuccessType> ValidateBindingOptions(const Options& options) {
diag::List diagnostics;
tint::Hashmap<tint::BindingPoint, binding::BindingInfo, 8> seen_wgsl_bindings{};
InfoToPointMap seen_msl_buffer_bindings{};
InfoToPointMap seen_msl_texture_bindings{};
InfoToPointMap seen_msl_sampler_bindings{};
// Both wgsl_seen and spirv_seen check to see if the pair of [src, dst] are unique. If we have
// multiple entries that map the same [src, dst] pair, that's fine. We treat it as valid as it's
// possible for multiple entry points to use the remapper at the same time. If the pair doesn't
// match, then we report an error about a duplicate binding point.
auto wgsl_seen = [&diagnostics, &seen_wgsl_bindings](const tint::BindingPoint& src,
const binding::BindingInfo& dst) -> bool {
if (auto binding = seen_wgsl_bindings.Add(src, dst); binding.value != dst) {
diagnostics.AddError(Source{}) << "found duplicate WGSL binding point: " << src;
return true;
}
return false;
};
auto msl_seen = [&diagnostics](InfoToPointMap& map, const binding::BindingInfo& src,
const tint::BindingPoint& dst) -> bool {
if (auto binding = map.Add(src, dst); binding.value != dst) {
diagnostics.AddError(Source{})
<< "found duplicate MSL binding point: [binding: " << src.binding << "]";
return true;
}
return false;
};
auto valid = [&wgsl_seen, &msl_seen](InfoToPointMap& map, const auto& hsh) -> bool {
for (const auto& it : hsh) {
const auto& src_binding = it.first;
const auto& dst_binding = it.second;
if (wgsl_seen(src_binding, dst_binding)) {
return false;
}
if (msl_seen(map, dst_binding, src_binding)) {
return false;
}
}
return true;
};
// Storage and uniform are both [[buffer()]]
if (!valid(seen_msl_buffer_bindings, options.bindings.uniform)) {
diagnostics.AddNote(Source{}) << "when processing uniform";
return Failure{std::move(diagnostics)};
}
if (!valid(seen_msl_buffer_bindings, options.bindings.storage)) {
diagnostics.AddNote(Source{}) << "when processing storage";
return Failure{std::move(diagnostics)};
}
// Sampler is [[sampler()]]
if (!valid(seen_msl_sampler_bindings, options.bindings.sampler)) {
diagnostics.AddNote(Source{}) << "when processing sampler";
return Failure{std::move(diagnostics)};
}
// Texture and storage texture are [[texture()]]
if (!valid(seen_msl_texture_bindings, options.bindings.texture)) {
diagnostics.AddNote(Source{}) << "when processing texture";
return Failure{std::move(diagnostics)};
}
if (!valid(seen_msl_texture_bindings, options.bindings.storage_texture)) {
diagnostics.AddNote(Source{}) << "when processing storage_texture";
return Failure{std::move(diagnostics)};
}
for (const auto& it : options.bindings.external_texture) {
const auto& src_binding = it.first;
const auto& plane0 = it.second.plane0;
const auto& plane1 = it.second.plane1;
const auto& metadata = it.second.metadata;
// Validate with the actual source regardless of what the remapper will do
if (wgsl_seen(src_binding, plane0)) {
diagnostics.AddNote(Source{}) << "when processing external_texture";
return Failure{std::move(diagnostics)};
}
// Plane0 & Plane1 are [[texture()]]
if (msl_seen(seen_msl_texture_bindings, plane0, src_binding)) {
diagnostics.AddNote(Source{}) << "when processing external_texture";
return Failure{std::move(diagnostics)};
}
if (msl_seen(seen_msl_texture_bindings, plane1, src_binding)) {
diagnostics.AddNote(Source{}) << "when processing external_texture";
return Failure{std::move(diagnostics)};
}
// Metadata is [[buffer()]]
if (msl_seen(seen_msl_buffer_bindings, metadata, src_binding)) {
diagnostics.AddNote(Source{}) << "when processing external_texture";
return Failure{std::move(diagnostics)};
}
}
return Success;
}
// The remapped binding data and external texture data need to coordinate in order to put things in
// the correct place when we're done. The binding remapper is run first, so make sure that the
// external texture uses the new binding point.
//
// When the data comes in we have a list of all WGSL origin (group,binding) pairs to MSL
// (binding) in the `uniform`, `storage`, `texture`, and `sampler` arrays.
void PopulateBindingRelatedOptions(
const Options& options,
RemapperData& remapper_data,
ExternalTextureOptions& external_texture,
ArrayLengthFromUniformOptions& array_length_from_uniform_options) {
auto create_remappings = [&remapper_data](const auto& hsh) {
for (const auto& it : hsh) {
const BindingPoint& src_binding_point = it.first;
const binding::BindingInfo& dst_binding_point = it.second;
// Bindings which go to the same slot in MSL do not need to be re-bound.
if (src_binding_point.group == 0 &&
src_binding_point.binding == dst_binding_point.binding) {
continue;
}
remapper_data.emplace(src_binding_point, BindingPoint{0, dst_binding_point.binding});
}
};
create_remappings(options.bindings.uniform);
create_remappings(options.bindings.storage);
create_remappings(options.bindings.texture);
create_remappings(options.bindings.storage_texture);
create_remappings(options.bindings.sampler);
// External textures are re-bound to their plane0 location
for (const auto& it : options.bindings.external_texture) {
const BindingPoint& src_binding_point = it.first;
const binding::BindingInfo& plane0 = it.second.plane0;
const binding::BindingInfo& plane1 = it.second.plane1;
const binding::BindingInfo& metadata = it.second.metadata;
BindingPoint plane0_binding_point{0, plane0.binding};
BindingPoint plane1_binding_point{0, plane1.binding};
BindingPoint metadata_binding_point{0, metadata.binding};
// Use the re-bound MSL plane0 value for the lookup key. The group goes to `0` which is the
// value always used for re-bound data.
external_texture.bindings_map.emplace(
BindingPoint{0, plane0_binding_point.binding},
ExternalTextureOptions::BindingPoints{plane1_binding_point, metadata_binding_point});
// Bindings which go to the same slot in MSL do not need to be re-bound.
if (src_binding_point == plane0_binding_point) {
continue;
}
remapper_data.emplace(src_binding_point, plane0_binding_point);
}
// ArrayLengthFromUniformOptions bindpoints may need to be remapped
{
std::unordered_map<BindingPoint, uint32_t> bindpoint_to_size_index;
for (auto& [bindpoint, index] : options.array_length_from_uniform.bindpoint_to_size_index) {
auto it = remapper_data.find(bindpoint);
if (it != remapper_data.end()) {
bindpoint_to_size_index.emplace(it->second, index);
} else {
bindpoint_to_size_index.emplace(bindpoint, index);
}
}
array_length_from_uniform_options.ubo_binding =
options.array_length_from_uniform.ubo_binding;
array_length_from_uniform_options.bindpoint_to_size_index =
std::move(bindpoint_to_size_index);
}
}
} // namespace tint::msl::writer