| /* Copyright 2020 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. |
| ==============================================================================*/ |
| #ifndef TENSORFLOW_CORE_COMMON_RUNTIME_PERMUTER_H_ |
| #define TENSORFLOW_CORE_COMMON_RUNTIME_PERMUTER_H_ |
| |
| #include <deque> |
| #include <memory> |
| #include <string> |
| #include <vector> |
| |
| #include "tensorflow/core/common_runtime/base_collective_executor.h" |
| #include "tensorflow/core/framework/collective.h" |
| |
| namespace tensorflow { |
| class Device; |
| |
| // Implementation of collective permute. |
| // |
| // Permute takes |
| // - a list of devices participating in the collective |
| // - a permutation as a list of integers. |
| // - a tensor |
| // |
| // The list of devices replaces the need for group_key and group_size. The |
| // number of inputs only scales with the number of devices within one group. |
| // |
| // The integers in the permutation are based on indices of the list of devices. |
| // E.g. devices = {"GPU:0", "GPU:1"} and permutation = {1,0} means |
| // - devices[0] sends to devices[permutation[0]] and |
| // - devices[1] sends to devices[permutation[1]]. |
| // |
| // Each device sends exactly one tensor and receives exactly one tensor. |
| class Permuter : public CollectiveImplementationInterface { |
| public: |
| Permuter(); |
| ~Permuter() override = default; |
| |
| void Run(StatusCallback done) override; |
| |
| Status InitializeCollectiveParams(CollectiveParams* col_params) override { |
| return Status::OK(); |
| } |
| |
| // Initializes members of CollectiveContext not yet initialized, i.e. device |
| // and device_locality. Also saves the CollectiveContext in this object. |
| Status InitializeCollectiveContext( |
| std::shared_ptr<CollectiveContext> col_ctx) override; |
| |
| Status InitializeCollectiveGroupRuntimeDetails( |
| CollGroupRuntimeDetails*) override { |
| return Status::OK(); |
| } |
| |
| private: |
| std::shared_ptr<CollectiveContext> col_ctx_; |
| const CollectiveParams* col_params_; // Not owned |
| StatusCallback done_; |
| Status status_; |
| mutex mu_counter_; |
| int counter_ TF_GUARDED_BY(mu_counter_); |
| |
| void DispatchSend(int src_rank, int target_rank, const Tensor* tensor, |
| const StatusCallback& done); |
| |
| void DispatchRecv(int src_rank, int target_rank, Tensor* tensor, |
| const StatusCallback& done); |
| |
| // Checks if counter_ reaches 2. |
| // Atomically increments counter_ by one for sending, one for receiving. |
| // The purpose of this check is to ensure that done_ is called only once. |
| bool CheckCounter(); |
| |
| StatusCallback HalfDone(); |
| }; |
| |
| } // namespace tensorflow |
| #endif // TENSORFLOW_CORE_COMMON_RUNTIME_PERMUTER_H_ |