xref: /aosp_15_r20/external/tensorflow/tensorflow/compiler/xla/service/broadcast_canonicalizer.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_XLA_SERVICE_BROADCAST_CANONICALIZER_H_
17 #define TENSORFLOW_COMPILER_XLA_SERVICE_BROADCAST_CANONICALIZER_H_
18 
19 #include <optional>
20 
21 #include "tensorflow/compiler/xla/service/hlo_pass_interface.h"
22 
23 namespace xla {
24 
25 // This transform ensures that dimensions in all broadcast operations are
26 // sorted.
27 class BroadcastCanonicalizer : public HloModulePass {
28  public:
29   explicit BroadcastCanonicalizer();
30 
name()31   absl::string_view name() const override { return "broadcast_canonicalizer"; }
32   using HloPassInterface::Run;
33   StatusOr<bool> Run(
34       HloModule* module,
35       const absl::flat_hash_set<absl::string_view>& execution_threads) override;
36 };
37 
38 }  // namespace xla
39 
40 #endif  // TENSORFLOW_COMPILER_XLA_SERVICE_BROADCAST_CANONICALIZER_H_
41