/* Copyright 2022 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.
==============================================================================*/

#include <memory>
#include <string>
#include <utility>

#include "tensorflow/compiler/xla/service/gpu/tests/gpu_codegen_test.h"
#include "tensorflow/compiler/xla/tests/hlo_test_base.h"
#include "tensorflow/tsl/platform/test.h"

namespace xla {
namespace {

class TransposeEmitterTest : public gpu::GpuCodegenTest {
 protected:
  TransposeEmitterTest() {}
};

// TODO(cheshire): Test vectorization somehow.

TEST_F(TransposeEmitterTest, Simple) {
  const char* const kHloString = R"(
  HloModule m

  ENTRY e {
    para0 = f16[32,16,64]{2,1,0} parameter(0)
    ROOT copy1 = f16[32,16,64]{1,0,2} copy(para0)
  })";

  auto expected_ir = R"(
; CHECK: call void BARRIER()
)";
  CompileAndVerifyIr(kHloString, MakePlatformSpecificLlvm(expected_ir),
                     /*match_optimized_ir=*/true,
                     /*run_optimization_passes=*/false);
  EXPECT_TRUE(RunAndCompareNoHloPasses(kHloString, ErrorSpec{1e-3}));
}

TEST_F(TransposeEmitterTest, SimpleLogicalTranspose) {
  const char* const kHloString = R"(
  HloModule m

  ENTRY e {
    para0 = f16[32,16,64]{2,1,0} parameter(0)
    ROOT copy1 = f16[64,32,16]{2,1,0} transpose(para0), dimensions={2,0,1}
  })";

  auto expected_ir = R"(
; CHECK: call void BARRIER()
)";
  CompileAndVerifyIr(kHloString, MakePlatformSpecificLlvm(expected_ir),
                     /*match_optimized_ir=*/true,
                     /*run_optimization_passes=*/false);
  EXPECT_TRUE(RunAndCompareNoHloPasses(kHloString, ErrorSpec{1e-3}));
}

TEST_F(TransposeEmitterTest, BatchedLogicalTranspose) {
  const char* const kHloString = R"(
  HloModule m

  ENTRY e {
    para0 = f16[32,48,64]{2,1,0} parameter(0)
    ROOT copy1 = f16[32,64,48]{2,1,0} transpose(para0), dimensions={0,2,1}
  })";

  auto expected_ir = R"(
; CHECK: call void BARRIER()
)";
  CompileAndVerifyIr(kHloString, MakePlatformSpecificLlvm(expected_ir),
                     /*match_optimized_ir=*/true,
                     /*run_optimization_passes=*/false);
  EXPECT_TRUE(RunAndCompareNoHloPasses(kHloString, ErrorSpec{1e-3}));
}

TEST_F(TransposeEmitterTest, FusionAfterHero) {
  const char* hlo = R"(
HloModule m

%fused_computation {
  %param_0.1 = f32[16,32]{1,0} parameter(0)
  %s.1 = f32[16,32]{1,0} sqrt(%param_0.1)
  %c.1 = f32[16,32]{0,1} copy(%s.1)
  b = f32[16,32,1]{0,1,2} bitcast(%c.1)
  ROOT o = f32[16,32,1]{0,1,2} sqrt(b)
}

ENTRY main {
  %p = f32[16,32]{1,0} parameter(0)
  ROOT %fusion = f32[16,32,1]{0,1,2} fusion(%p), kind=kInput, calls=%fused_computation
}
  )";

  CompileAndVerifyIr(hlo, MakePlatformSpecificLlvm(R"(
// CHECK: call void BARRIER()
  )"),
                     /*match_optimized_ir=*/true,
                     /*run_optimization_passes=*/false);
  EXPECT_TRUE(RunAndCompareNoHloPasses(hlo, ErrorSpec{1e-3}));
}

TEST_F(TransposeEmitterTest, MultipleCopiesWithPostFusion) {
  const char* hlo = R"(
HloModule m

%fused_computation {
  %param_0.1 = f32[16,32]{1,0} parameter(0)
  %s.1 = f32[16,32]{1,0} sqrt(%param_0.1)
  %c.1 = f32[16,32]{0,1} copy(%s.1)
  %c1.1 = f32[16,32]{0,1} copy(%param_0.1)
  %r.1 = f32[16,32,1]{0,1,2} reshape(%c.1)
  %r1.1 = f32[16,32,1]{0,1,2} reshape(%c1.1)
  ROOT %tuple = (f32[16,32,1]{0,1,2}, f32[16,32,1]{0,1,2}) tuple(%r.1, %r1.1)
}

ENTRY main {
  %p = f32[16,32]{1,0} parameter(0)
  ROOT %fusion = (f32[16,32,1]{0,1,2}, f32[16,32,1]{0,1,2}) fusion(%p), kind=kInput, calls=%fused_computation
}
  )";

  CompileAndVerifyIr(hlo, MakePlatformSpecificLlvm(R"(
// CHECK: call void BARRIER()
  )"),
                     /*match_optimized_ir=*/true,
                     /*run_optimization_passes=*/false);
  EXPECT_TRUE(RunAndCompareNoHloPasses(hlo, ErrorSpec{1e-3}));
}

TEST_F(TransposeEmitterTest, MultipleCopies) {
  const char* hlo = R"(
HloModule m

%fused_computation {
  %param_0.1 = f32[16,32]{1,0} parameter(0)
  %s.1 = f32[16,32]{1,0} sqrt(%param_0.1)
  %c.1 = f32[16,32]{0,1} copy(%s.1)
  %c1.1 = f32[16,32]{0,1} copy(%param_0.1)
  ROOT %tuple = (f32[16,32]{0,1}, f32[16,32]{0,1}) tuple(%c.1, %c1.1)
}

ENTRY main {
  %p = f32[16,32]{1,0} parameter(0)
  ROOT %fusion = (f32[16,32]{0,1}, f32[16,32]{0,1}) fusion(%p), kind=kInput, calls=%fused_computation
}
  )";

  CompileAndVerifyIr(hlo, MakePlatformSpecificLlvm(R"(
// CHECK: call void BARRIER()
  )"),
                     /*match_optimized_ir=*/true,
                     /*run_optimization_passes=*/false);
  EXPECT_TRUE(RunAndCompareNoHloPasses(hlo, ErrorSpec{1e-3}));
}

TEST_F(TransposeEmitterTest, MultipleTransposesLogical) {
  const char* hlo = R"(
HloModule m

%fused_computation {
  %param_0.1 = f32[16,32]{1,0} parameter(0)
  %s.1 = f32[16,32]{1,0} sqrt(%param_0.1)
  %c.1 = f32[32,16]{1,0} transpose(%s.1), dimensions={1,0}
  %c1.1 = f32[32,16]{1,0} transpose(%param_0.1), dimensions={1,0}
  ROOT %tuple = (f32[32,16]{1,0}, f32[32,16]{1,0}) tuple(%c.1, %c1.1)
}

ENTRY main {
  %p = f32[16,32]{1,0} parameter(0)
  ROOT %fusion = (f32[32,16]{1,0}, f32[32,16]{1,0}) fusion(%p), kind=kInput, calls=%fused_computation
}
  )";

  CompileAndVerifyIr(hlo, MakePlatformSpecificLlvm(R"(
// CHECK: call void BARRIER()
  )"),
                     /*match_optimized_ir=*/true,
                     /*run_optimization_passes=*/false);
  EXPECT_TRUE(RunAndCompareNoHloPasses(hlo, ErrorSpec{1e-3}));
}

TEST_F(TransposeEmitterTest, MultipleCopiesDifferentTypes) {
  const char* hlo = R"(
HloModule module

%fused_computation (param_0.1: f16[16,32]) -> (f32[16,32], f16[16,32]) {
  %param_0.1 = f16[16,32]{1,0} parameter(0)
  %s.1 = f32[16,32]{1,0} convert(%param_0.1)
  %c.1 = f32[16,32]{0,1} copy(%s.1)
  %c1.1 = f16[16,32]{0,1} copy(%param_0.1)
  ROOT %tuple = (f32[16,32]{0,1}, f16[16,32]{0,1}) tuple(%c.1, %c1.1)
}

ENTRY %main (p: f16[16,32]) -> (f32[16,32], f16[16,32]) {
  %p = f16[16,32]{1,0} parameter(0)
  %fusion = (f32[16,32]{0,1}, f16[16,32]{0,1}) fusion(%p), kind=kInput, calls=%fused_computation
  %get-tuple-element = f32[16,32]{0,1} get-tuple-element(%fusion), index=0
  %get-tuple-element.1 = f16[16,32]{0,1} get-tuple-element(%fusion), index=1
  ROOT %t = (f32[16,32]{0,1}, f16[16,32]{0,1}) tuple(%get-tuple-element, %get-tuple-element.1)
}
  )";

  CompileAndVerifyIr(hlo, MakePlatformSpecificLlvm(R"(
// CHECK: call void BARRIER()
  )"),
                     /*match_optimized_ir=*/true,
                     /*run_optimization_passes=*/false);
  EXPECT_TRUE(RunAndCompareNoHloPasses(hlo, ErrorSpec{1e-3}));
}

TEST_F(TransposeEmitterTest, CopyAndInput) {
  const char* hlo = R"(
HloModule m

%fused_computation {
  %param_0.1 = f32[16,32]{1,0} parameter(0)
  %s.1 = f32[16,32]{1,0} sqrt(%param_0.1)
  %c.1 = f32[16,32]{0,1} copy(%s.1)
  %c1.1 = f32[16,32]{1,0} exponential(%param_0.1)
  ROOT %tuple = (f32[16,32]{0,1}, f32[16,32]{1,0}) tuple(%c.1, %c1.1)
}

ENTRY entry {
  %p = f32[16,32]{1,0} parameter(0)
  ROOT %fusion = (f32[16,32]{0,1}, f32[16,32]{1,0}) fusion(%p), kind=kInput, calls=%fused_computation
}
  )";

  CompileAndVerifyIr(hlo, MakePlatformSpecificLlvm(R"(
// CHECK: call void BARRIER()
  )"),
                     /*match_optimized_ir=*/true,
                     /*run_optimization_passes=*/false);
  EXPECT_TRUE(RunAndCompareNoHloPasses(hlo, ErrorSpec{1e-3}));
}

TEST_F(TransposeEmitterTest, TransposeAndInput) {
  const char* hlo = R"(
HloModule m

%fused_computation {
  %param_0.1 = f32[16,32]{1,0} parameter(0)
  %s.1 = f32[16,32]{1,0} sqrt(%param_0.1)
  %c.1 = f32[32,16]{1,0} transpose(%s.1), dimensions={1,0}
  %c1.1 = f32[16,32]{1,0} exponential(%param_0.1)
  ROOT %tuple = (f32[32,16]{1,0}, f32[16,32]{1,0}) tuple(%c.1, %c1.1)
}

ENTRY entry {
  %p = f32[16,32]{1,0} parameter(0)
  ROOT %fusion = (f32[32,16]{1,0}, f32[16,32]{1,0}) fusion(%p), kind=kInput, calls=%fused_computation
}
  )";

  CompileAndVerifyIr(hlo, MakePlatformSpecificLlvm(R"(
// CHECK: call void BARRIER()
  )"),
                     /*match_optimized_ir=*/true,
                     /*run_optimization_passes=*/false);
  EXPECT_TRUE(RunAndCompareNoHloPasses(hlo, ErrorSpec{1e-3}));
}

TEST_F(TransposeEmitterTest, InconsistentTransposes) {
  const char* hlo = R"(
HloModule module

fusion {
  p0 = f32[32, 64] parameter(0)
  p1 = f32[64, 32] parameter(1)
  t0 = f32[64, 32] transpose(p0), dimensions={1,0}
  t1 = f32[32, 64] transpose(p1), dimensions={1,0}
  ROOT tuple = (f32[64, 32], f32[32, 64]) tuple(t0, t1)
}

ENTRY module {
  p0 = f32[32, 64] parameter(0)
  p1 = f32[64, 32] parameter(1)
  ROOT fusion = (f32[64, 32], f32[32, 64]) fusion(p0, p1), kind=kLoop, calls=fusion
}
  )";
  CompileAndVerifyIr(hlo, MakePlatformSpecificLlvm(R"(
// CHECK-NOT: call void BARRIER()
  )"),
                     /*match_optimized_ir=*/true,
                     /*run_optimization_passes=*/false);
  EXPECT_TRUE(RunAndCompareNoHloPasses(hlo, ErrorSpec{1e-3}));
}

}  // namespace
}  // namespace xla
