xref: /aosp_15_r20/external/tensorflow/tensorflow/compiler/xla/service/collectives_schedule_linearizer.h (revision b6fb3261f9314811a0f4371741dbb8839866f948)
1 /* Copyright 2021 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_XLA_SERVICE_COLLECTIVES_SCHEDULE_LINEARIZER_H_
17 #define TENSORFLOW_COMPILER_XLA_SERVICE_COLLECTIVES_SCHEDULE_LINEARIZER_H_
18 
19 #include "absl/strings/string_view.h"
20 #include "tensorflow/compiler/xla/array2d.h"
21 #include "tensorflow/compiler/xla/service/hlo_module.h"
22 #include "tensorflow/compiler/xla/service/hlo_pass_interface.h"
23 #include "tensorflow/compiler/xla/statusor.h"
24 #include "tensorflow/compiler/xla/xla_data.pb.h"
25 
26 namespace xla {
27 
28 // Enforces a total order on all collectives present in the module, based on the
29 // order given to the instructions.
30 //
31 // Does not insert inter-computation dependencies, only linearizes the order
32 // within each computation.
33 class CollectivesScheduleLinearizer : public HloModulePass {
34  public:
name()35   absl::string_view name() const override {
36     return "collectives-schedule-linearizer";
37   }
38 
39   CollectivesScheduleLinearizer() = default;
40 
41   using HloPassInterface::Run;
42   StatusOr<bool> Run(
43       HloModule* module,
44       const absl::flat_hash_set<absl::string_view>& execution_threads) override;
45 };
46 
47 }  // namespace xla
48 
49 #endif  // TENSORFLOW_COMPILER_XLA_SERVICE_COLLECTIVES_SCHEDULE_LINEARIZER_H_
50