/* Copyright 2024 The OpenXLA 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 XLA_SERVICE_SPMD_SHARDY_SHARDY_XLA_PASS_H_
#define XLA_SERVICE_SPMD_SHARDY_SHARDY_XLA_PASS_H_

#include "absl/container/flat_hash_set.h"
#include "absl/status/statusor.h"
#include "absl/strings/string_view.h"
#include "shardy/dialect/sdy/transforms/propagation/passes.h"
#include "xla/hlo/ir/hlo_module.h"
#include "xla/hlo/pass/hlo_pass_interface.h"

namespace xla {
namespace sdy {

// An HloModulePass to run Shardy. The pass:
// 1. converts the HLO module into StableHLO and the SDY (Shardy) dialect,
// 2. runs Shardy passes, including sharding propagation and partitioner,
// 3. converts the StableHLO back to the HLO module.
class ShardyXLA : public xla::HloModulePass {
 public:
  explicit ShardyXLA(bool runSdyShardingPropagation = true,
                     mlir::sdy::PropagationOptions defaultOptions =
                         mlir::sdy::PropagationOptions{})
      : runSdyShardingPropagation(runSdyShardingPropagation),
        defaultOptions(defaultOptions) {}

  absl::string_view name() const override { return "shardy-xla"; }

  using HloPassInterface::Run;
  absl::StatusOr<bool> Run(
      xla::HloModule* hloModule,
      const absl::flat_hash_set<absl::string_view>& executionThreads) override;

  void setRunSdyShardingPropagation(bool runSdyShardingPropagation) {
    this->runSdyShardingPropagation = runSdyShardingPropagation;
  }

 private:
  bool runSdyShardingPropagation;
  mlir::sdy::PropagationOptions defaultOptions;
  // TODO. Run other SDY passes with flags.
};

}  // namespace sdy
}  // namespace xla

#endif  // XLA_SERVICE_SPMD_SHARDY_SHARDY_XLA_PASS_H_