/* Copyright 2021 The TensorFlow Authors. All Rights Reserved.

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.
==============================================================================*/
#include <cstdint>
#include <memory>
#include <utility>

#include "llvm/ADT/DenseMap.h"
#include "llvm/ADT/DenseMapInfo.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/Support/Casting.h"
#include "mlir/Dialect/Func/IR/FuncOps.h"  // from @llvm-project
#include "mlir/IR/Block.h"  // from @llvm-project
#include "mlir/IR/BuiltinAttributes.h"  // from @llvm-project
#include "mlir/IR/BuiltinTypes.h"  // from @llvm-project
#include "mlir/IR/MLIRContext.h"  // from @llvm-project
#include "mlir/IR/Operation.h"  // from @llvm-project
#include "mlir/IR/OperationSupport.h"  // from @llvm-project
#include "mlir/IR/PatternMatch.h"  // from @llvm-project
#include "mlir/Pass/Pass.h"  // from @llvm-project
#include "mlir/Pass/PassRegistry.h"  // from @llvm-project
#include "mlir/Rewrite/FrozenRewritePatternSet.h"  // from @llvm-project
#include "mlir/Support/LLVM.h"  // from @llvm-project
#include "mlir/Support/TypeID.h"  // from @llvm-project
#include "mlir/Transforms/GreedyPatternRewriteDriver.h"  // from @llvm-project
#include "tensorflow/compiler/mlir/tensorflow/ir/tf_ops.h"
#include "tensorflow/compiler/mlir/tfrt/transforms/passes.h"
#include "tensorflow/core/util/device_name_utils.h"

namespace tensorflow {
namespace tfrt_compiler {
namespace {

// Fold tf.DeviceIndex to tf.Const if it has device assigned.
class FoldDeviceIndex : public mlir::OpRewritePattern<mlir::TF::DeviceIndexOp> {
 public:
  using mlir::OpRewritePattern<mlir::TF::DeviceIndexOp>::OpRewritePattern;

  mlir::LogicalResult matchAndRewrite(
      mlir::TF::DeviceIndexOp op,
      mlir::PatternRewriter &rewriter) const override {
    auto device = op->getAttrOfType<mlir::StringAttr>("device");
    if (!device) return mlir::failure();

    DeviceNameUtils::ParsedName parsed_name;
    if (!DeviceNameUtils::ParseFullName(device.getValue().str(),
                                        &parsed_name) ||
        !parsed_name.has_type)
      return mlir::failure();

    int32_t i = 0;
    mlir::ArrayAttr device_names = op.getDeviceNames();
    for (; i < device_names.size(); ++i) {
      auto device_name =
          mlir::cast<mlir::StringAttr>(device_names[i]).getValue();
      if (device_name == parsed_name.type) break;
    }

    rewriter.replaceOpWithNewOp<mlir::TF::ConstOp>(
        op,
        mlir::DenseIntElementsAttr::get(
            mlir::RankedTensorType::get(/*shape=*/{}, rewriter.getI32Type()),
            i));

    return mlir::success();
  }
};

// A custom hash and compare function for finding out common ops.
struct SimpleOperationInfo : public llvm::DenseMapInfo<mlir::Operation *> {
  static unsigned getHashValue(const mlir::Operation *opC) {
    return mlir::OperationEquivalence::computeHash(
        const_cast<mlir::Operation *>(opC),
        /*hashOperands=*/mlir::OperationEquivalence::directHashValue,
        /*hashResults=*/mlir::OperationEquivalence::ignoreHashValue,
        mlir::OperationEquivalence::IgnoreLocations);
  }
  static bool isEqual(const mlir::Operation *lhsC,
                      const mlir::Operation *rhsC) {
    auto *lhs = const_cast<mlir::Operation *>(lhsC);
    auto *rhs = const_cast<mlir::Operation *>(rhsC);
    if (lhs == rhs) return true;
    if (lhs == getTombstoneKey() || lhs == getEmptyKey() ||
        rhs == getTombstoneKey() || rhs == getEmptyKey())
      return false;
    return mlir::OperationEquivalence::isEquivalentTo(
        const_cast<mlir::Operation *>(lhsC),
        const_cast<mlir::Operation *>(rhsC),
        mlir::OperationEquivalence::IgnoreLocations);
  }
};

void EliminateCommonMultinomialOps(mlir::Block &block) {
  llvm::SmallDenseMap<mlir::Operation *,
                      llvm::SmallVector<mlir::TF::MultinomialOp>, 2,
                      SimpleOperationInfo>
      multinomial_to_eliminate;

  auto eliminate = [&]() {
    auto &list = multinomial_to_eliminate.begin()->second;
    auto first = list.front();
    for (auto op : llvm::drop_begin(list)) {
      op.getOutput().replaceAllUsesWith(first.getOutput());
      op->erase();
    }
    multinomial_to_eliminate.clear();
  };

  for (auto &op : block) {
    auto multinomial_op = llvm::dyn_cast<mlir::TF::MultinomialOp>(&op);
    // Conservatively, we only eliminate back-to-back tf.Multinomial ops.
    if (multinomial_op) {
      if (multinomial_to_eliminate.find(multinomial_op) ==
              multinomial_to_eliminate.end() &&
          !multinomial_to_eliminate.empty()) {
        // If the current op is a tf.Multinomial but it is different from the
        // preiously found tf.Multinomial, then we eliminate the prviously found
        // tf.Multinomial.
        eliminate();
      }
      multinomial_to_eliminate[multinomial_op].push_back(multinomial_op);
    } else if (!multinomial_to_eliminate.empty()) {
      // If the current op is not a tf.Multinomial, then we eliminate previously
      // found tf.Multinomial
      eliminate();
    }
  }
}

// Optimization pass for TFRT-specific rewrite patterns.
class OptimizeTfForTfrt
    : public mlir::PassWrapper<OptimizeTfForTfrt,
                               mlir::OperationPass<mlir::func::FuncOp>> {
 public:
  MLIR_DEFINE_EXPLICIT_INTERNAL_INLINE_TYPE_ID(OptimizeTfForTfrt)

  llvm::StringRef getArgument() const final { return "optimize-tf-for-tfrt"; }

  llvm::StringRef getDescription() const final {
    return "optmize TF MLIR for TFRT workflow.";
  }

  mlir::LogicalResult initialize(mlir::MLIRContext *context) override {
    mlir::RewritePatternSet pattern_list(context);
    pattern_list.add<FoldDeviceIndex>(context);
    patterns_ = std::move(pattern_list);
    return mlir::success();
  }

  void runOnOperation() override {
    auto func = getOperation();

    EliminateCommonMultinomialOps(func.getBody().front());

    if (mlir::failed(mlir::applyPatternsGreedily(func, patterns_)))
      signalPassFailure();
  }

 private:
  mlir::FrozenRewritePatternSet patterns_;
};

}  // namespace

std::unique_ptr<mlir::OperationPass<mlir::func::FuncOp>>
CreateOptimizeTfForTfrtPass() {
  return std::make_unique<OptimizeTfForTfrt>();
}

static mlir::PassRegistration<OptimizeTfForTfrt> register_pass;

}  // namespace tfrt_compiler
}  // namespace tensorflow
