xref: /aosp_15_r20/external/tensorflow/tensorflow/core/kernels/collective_nccl.h (revision b6fb3261f9314811a0f4371741dbb8839866f948)
1 /* Copyright 2019 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 #ifndef TENSORFLOW_CORE_KERNELS_COLLECTIVE_NCCL_H_
16 #define TENSORFLOW_CORE_KERNELS_COLLECTIVE_NCCL_H_
17 
18 #include "tensorflow/core/framework/collective.h"
19 
20 namespace tensorflow {
21 #if GOOGLE_CUDA || TENSORFLOW_USE_ROCM
22 
23 class NcclBase : public CollectiveImplementationInterface {
24  public:
25   explicit NcclBase(CollectiveType type, const string& name);
26   ~NcclBase() override = default;
27 
28   // No-op for this collective implementation.
29   Status InitializeCollectiveParams(CollectiveParams* col_params) override;
30 
31   // Initializes the device objects and device localities.
32   Status InitializeCollectiveContext(
33       std::shared_ptr<CollectiveContext> col_ctx) override;
34 
35  protected:
36   const CollectiveType type_;
37   const string name_;
38   std::shared_ptr<CollectiveContext> col_ctx_;
39   const CollectiveParams* col_params_;  // Not owned
40 };
41 
42 #endif  // GOOGLE_CUDA || TENSORFLOW_USE_ROCM
43 }  // namespace tensorflow
44 
45 #endif  // TENSORFLOW_CORE_KERNELS_COLLECTIVE_NCCL_H_
46