src/transform/duplicate_storage_structs.h

// Copyright 2021 The Tint Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef SRC_TRANSFORM_DUPLICATE_STORAGE_STRUCTS_H_
#define SRC_TRANSFORM_DUPLICATE_STORAGE_STRUCTS_H_

#include <string>
#include <unordered_map>

#include "src/transform/transform.h"

namespace tint {
namespace transform {

/// DuplicateStorageStructs is a Transform that creates duplicates of storage
/// structures, one per access control type.
///
/// This transform is currently required by Dawn for it's GLSL backend so that
/// SPIRV-Cross does not end up renaming the structures internally, which it
/// does to fix aliasing problems (see
/// https://github.com/KhronosGroup/SPIRV-Cross/pull/799). We can remove this
/// transform if/once Dawn using binding numbers rather than names for
/// uniform/storage buffer data. See https://crbug.com/tint/386.
///
class DuplicateStorageStructs : public Transform {
 public:
  /// Constructor
  DuplicateStorageStructs();

  /// Destructor
  ~DuplicateStorageStructs() override;

  /// Runs the transform on `program`, returning the transformation result.
  /// @param program the source program to transform
  /// @param data optional extra transform-specific data
  /// @returns the transformation result
  Output Run(const Program* program, const DataMap& data = {}) override;
};

}  // namespace transform
}  // namespace tint

#endif  // SRC_TRANSFORM_DUPLICATE_STORAGE_STRUCTS_H_