tensorflow/compiler/mlir/tensorflow/transforms/test_cluster_ops_by_policy.cc

/* Copyright 2019 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 "mlir/Pass/Pass.h"  // from @llvm-project
#include "tensorflow/compiler/mlir/tensorflow/transforms/cluster_ops_by_policy.h"
#include "tensorflow/compiler/mlir/tensorflow/transforms/test_passes_detail.h"

namespace mlir {
namespace tf_test {
namespace {

using mlir::TFDevice::ClusteringPolicy;
using mlir::TFDevice::ClusteringPolicySet;
using mlir::TFDevice::ValueConstraint;
using mlir::TFDevice::ValuesConstraintSet;

struct TestClusteringPolicyPass
    : public TestClusteringPolicyPassBase<TestClusteringPolicyPass> {
  void runOnOperation() override;
};

// Clustering policy for `test.OpA` and `test.OpB` operations;
class TestOpsClusteringPolicy : public ClusteringPolicy {
  LogicalResult MatchAndUpdateConstraints(
      Operation* op, const ValuesConstraintSet& results,
      ValuesConstraintSet& operands) const final {
    // Check if operation is `test.OpA` or `test.OpB`.
    bool is_op_a = op->getName().getStringRef() == "test.OpA";
    bool is_op_b = op->getName().getStringRef() == "test.OpB";
    if (!is_op_a && !is_op_b) return failure();

    if (auto result_constraint = results.GetConstraint(op->getResult(0))) {
      // `test.OpA` converts shape constraint to rank constraint.
      if (is_op_a && *result_constraint == ValueConstraint::kShape)
        operands.Insert(op->getOperand(0), ValueConstraint::kRank);

      // `test.OpB` converts value constraint to shape constraint.
      if (*result_constraint == ValueConstraint::kValue)
        operands.Insert(op->getOperand(0), ValueConstraint::kShape);
    }

    return success();
  }
};

void TestClusteringPolicyPass::runOnOperation() {
  func::FuncOp func = getOperation();
  ValuesConstraintSet constraints;

  ClusteringPolicySet policies;
  policies.Add<TestOpsClusteringPolicy>();

  // Initialize constraints based on the return type attributes.
  if (failed(InferFunctionBodyValuesConstraints(func, constraints)))
    return signalPassFailure();

  // Propagate constraints though the function body.
  auto result =
      PropagateValuesConstraints(func.getBody(), policies, constraints,
                                 /*resolve=*/false, /*emit_remarks=*/true);
  (void)result;

  // Emit remarks for all operations that use constrained values.
  EmitValueConstraintsRemarks(constraints);
}

}  // anonymous namespace

std::unique_ptr<OperationPass<func::FuncOp>> CreateTestClusteringPolicyPass() {
  return std::make_unique<TestClusteringPolicyPass>();
}

}  // namespace tf_test
}  // namespace mlir