// 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_ZERO_INIT_WORKGROUP_MEMORY_H_
#define SRC_TRANSFORM_ZERO_INIT_WORKGROUP_MEMORY_H_

#include "src/transform/transform.h"

namespace tint {
namespace transform {

/// ZeroInitWorkgroupMemory is a transform that injects code at the top of entry
/// points to zero-initialize workgroup memory used by that entry point (and all
/// transitive functions called by that entry point)
class ZeroInitWorkgroupMemory : public Transform {
 public:
  /// Constructor
  ZeroInitWorkgroupMemory();

  /// Destructor
  ~ZeroInitWorkgroupMemory() override;

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

 private:
  struct State;
};

}  // namespace transform
}  // namespace tint

#endif  // SRC_TRANSFORM_ZERO_INIT_WORKGROUP_MEMORY_H_