xref: /aosp_15_r20/external/tensorflow/tensorflow/compiler/mlir/tensorflow/utils/tpu_cluster_util.h (revision b6fb3261f9314811a0f4371741dbb8839866f948)
1 /* Copyright 2022 The TensorFlow Authors. All Rights Reserved.
2 
3 Licensed under the Apache License, Version 2.0 (the "License");
4 you may not use this file except in compliance with the License.
5 You may obtain a copy of the License at
6 
7     http://www.apache.org/licenses/LICENSE-2.0
8 
9 Unless required by applicable law or agreed to in writing, software
10 distributed under the License is distributed on an "AS IS" BASIS,
11 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 See the License for the specific language governing permissions and
13 limitations under the License.
14 ==============================================================================*/
15 
16 #ifndef TENSORFLOW_COMPILER_MLIR_TENSORFLOW_TRANSFORMS_TPU_CLUSTER_UTIL_H_
17 #define TENSORFLOW_COMPILER_MLIR_TENSORFLOW_TRANSFORMS_TPU_CLUSTER_UTIL_H_
18 
19 #include "mlir/Support/LogicalResult.h"  // from @llvm-project
20 #include "tensorflow/compiler/mlir/tensorflow/utils/tpu_rewrite_device_util.h"
21 
22 namespace mlir {
23 namespace TFTPU {
24 
25 // For each TPU cluster in `module`, walk over all ops inside the cluster
26 // and reachable in the call graph from the cluster.
27 // For each op walked, `callback` is applied to the op, the root cluster, and
28 // the root cluster's host device. `callback` returning WasInterrupted
29 // indicates failure.
30 // The host device is null when the tpu_cluster HasModelParallelism: The
31 // HasModelParallelism case is currently unsupported in combination with
32 // outside compilation.
33 mlir::LogicalResult WalkReachableFromTpuCluster(
34     ModuleOp module, std::function<WalkResult(Operation*, tf_device::ClusterOp,
35                                               std::optional<std::string>)>
36                          callback);
37 
38 // Like above, except TPU clusters are not required to have a host device, and
39 // no host device is passed to `callback`.
40 mlir::LogicalResult WalkReachableFromTpuCluster(
41     ModuleOp module,
42     std::function<WalkResult(Operation*, tf_device::ClusterOp)> callback);
43 
44 }  // namespace TFTPU
45 }  // namespace mlir
46 
47 #endif  // TENSORFLOW_COMPILER_MLIR_TENSORFLOW_TRANSFORMS_TPU_CLUSTER_UTIL_H_
48