//===-- Unittests for VDSO ------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#include "hdr/signal_macros.h"
#include "hdr/time_macros.h"
#include "hdr/types/clockid_t.h"
#include "hdr/types/struct_sigaction.h"
#include "hdr/types/struct_timespec.h"
#include "hdr/types/struct_timeval.h"
#include "hdr/types/time_t.h"
#include "src/__support/OSUtil/linux/vdso.h"
#include "src/__support/OSUtil/syscall.h"
#include "src/__support/macros/properties/architectures.h"
#include "src/signal/raise.h"
#include "src/signal/sigaction.h"
#include "test/UnitTest/ErrnoSetterMatcher.h"
#include "test/UnitTest/Test.h"
#include <linux/time_types.h>
#include <sys/syscall.h>

struct riscv_hwprobe {
  int64_t key;
  uint64_t value;
};

namespace LIBC_NAMESPACE_DECL {
// For x86_64, we explicitly test some traditional vdso symbols are indeed
// available.

TEST(LlvmLibcOSUtilVDSOTest, GetTimeOfDay) {
  vdso::TypedSymbol<vdso::VDSOSym::GetTimeOfDay> symbol;
  if (!symbol)
    return;
  timeval tv;
  EXPECT_EQ(symbol(&tv, nullptr), 0);
  // hopefully people are not building time machines using our libc.
  EXPECT_GT(tv.tv_sec, static_cast<decltype(tv.tv_sec)>(0));
}

TEST(LlvmLibcOSUtilVDSOTest, Time) {
  vdso::TypedSymbol<vdso::VDSOSym::Time> symbol;
  if (!symbol)
    return;
  time_t a, b;
  EXPECT_GT(symbol(&a), static_cast<time_t>(0));
  EXPECT_GT(symbol(&b), static_cast<time_t>(0));
  EXPECT_GE(b, a);
}

TEST(LlvmLibcOSUtilVDSOTest, ClockGetTime) {
  vdso::TypedSymbol<vdso::VDSOSym::ClockGetTime> symbol;
  if (!symbol)
    return;
  timespec a, b;
  EXPECT_EQ(symbol(CLOCK_MONOTONIC, &a), 0);
  EXPECT_EQ(symbol(CLOCK_MONOTONIC, &b), 0);
  if (a.tv_sec == b.tv_sec) {
    EXPECT_LT(a.tv_nsec, b.tv_nsec);
  } else {
    EXPECT_LT(a.tv_sec, b.tv_sec);
  }
}

TEST(LlvmLibcOSUtilVDSOTest, ClockGetTime64) {
  vdso::TypedSymbol<vdso::VDSOSym::ClockGetTime64> symbol;
  if (!symbol)
    return;
  // See kernel API at
  // https://elixir.bootlin.com/linux/latest/source/tools/testing/selftests/vDSO/vdso_test_correctness.c#L155
  __kernel_timespec a, b;
  EXPECT_EQ(symbol(CLOCK_MONOTONIC, &a), 0);
  EXPECT_EQ(symbol(CLOCK_MONOTONIC, &b), 0);
  if (a.tv_sec == b.tv_sec) {
    EXPECT_LT(a.tv_nsec, b.tv_nsec);
  } else {
    EXPECT_LT(a.tv_sec, b.tv_sec);
  }
}

TEST(LlvmLibcOSUtilVDSOTest, ClockGetRes) {
  vdso::TypedSymbol<vdso::VDSOSym::ClockGetRes> symbol;
  if (!symbol)
    return;
  timespec res{};
  EXPECT_EQ(symbol(CLOCK_MONOTONIC, &res), 0);
  EXPECT_TRUE(res.tv_sec > 0 || res.tv_nsec > 0);
}

TEST(LlvmLibcOSUtilVDSOTest, GetCpu) {
  // The kernel system call has a third argument, which should be passed as
  // nullptr.
  vdso::TypedSymbol<vdso::VDSOSym::GetCpu> symbol;
  if (!symbol)
    return;
  unsigned cpu = static_cast<unsigned>(-1), node = static_cast<unsigned>(-1);
  EXPECT_EQ(symbol(&cpu, &node, nullptr), 0);
  EXPECT_GE(cpu, 0u);
  EXPECT_GE(node, 0u);
}

static bool flag = false;
static void sigprof_handler [[gnu::used]] (int) { flag = true; }

TEST(LlvmLibcOSUtilVDSOTest, RtSigReturn) {
  using namespace testing::ErrnoSetterMatcher;
  // must use struct since there is a function of the same name in the same
  // scope.
  struct sigaction sa{};
  struct sigaction old_sa{};
  sa.sa_handler = sigprof_handler;
  sa.sa_flags = SA_RESTORER;
  vdso::TypedSymbol<vdso::VDSOSym::RTSigReturn> symbol;
  if (!symbol)
    return;
  sa.sa_restorer = symbol;
  ASSERT_THAT(LIBC_NAMESPACE::sigaction(SIGPROF, &sa, &old_sa), Succeeds());
  raise(SIGPROF);
  ASSERT_TRUE(flag);
  flag = false;
  ASSERT_THAT(LIBC_NAMESPACE::sigaction(SIGPROF, &old_sa, nullptr), Succeeds());
}

TEST(LlvmLibcOSUtilVDSOTest, FlushICache) {
  vdso::TypedSymbol<vdso::VDSOSym::FlushICache> symbol;
  if (!symbol)
    return;
  char buf[512];
  // we just check that the flush will not panic the program.
  // the flags part only take 0/1 as up to kernel 6.10, which is used to
  // indicate whether the flush is local to the core or global.
  symbol(buf, buf + sizeof(buf), 0);
  symbol(buf, buf + sizeof(buf), 1);
}

// https://docs.kernel.org/6.5/riscv/hwprobe.html
TEST(LlvmLibcOSUtilVDSOTest, RiscvHwProbe) {
  using namespace testing::ErrnoSetterMatcher;
  vdso::TypedSymbol<vdso::VDSOSym::RiscvHwProbe> symbol;
  if (!symbol)
    return;
  // If a key is unknown to the kernel, its key field will be cleared to -1, and
  // its value set to 0. We expect probes.value are all 0.
  // Usermode can supply NULL for cpus and 0 for cpu_count as a shortcut for all
  // online CPUs
  riscv_hwprobe probes[2] = {{-1, 1}, {-1, 1}};
  ASSERT_THAT(symbol(/*pairs=*/probes, /*count=*/2, /*cpusetsize=*/0,
                     /*cpuset=*/nullptr,
                     /*flags=*/0),
              Succeeds());
  for (auto &probe : probes) {
    EXPECT_EQ(probe.key, static_cast<decltype(probe.key)>(-1));
    EXPECT_EQ(probe.value, static_cast<decltype(probe.value)>(0));
  }
}

TEST(LlvmLibcOSUtilVDSOTest, GetRandom) {
  using namespace testing::ErrnoSetterMatcher;
  vdso::TypedSymbol<vdso::VDSOSym::GetRandom> symbol;
  if (!symbol)
    return;
  // This structure exists in kernel UAPI header; but we define it on our own to
  // make sure we can test it even on platform without support.
  struct VGetrandomOpaqueParams {
    uint32_t size_of_opaque_states;
    uint32_t mmap_prot;
    uint32_t mmap_flags;
    uint32_t reserved[13];
  };
  VGetrandomOpaqueParams param{0, 0, 0, {}};
  // When getrandom vDSO symbol is called with special parameters (~0 for state
  // size), it populates the desired configuration into VGetrandomOpaqueParams.
  int res = symbol(
      /*buf=*/nullptr, /*count=*/0, /*flags=*/0,
      /*opaque_states=*/&param,
      /*size_of_opaque_states=*/~0);
  // Test that the size of the states are correctly populated after a successful
  // call.
  EXPECT_EQ(res, 0);
  EXPECT_GT(param.size_of_opaque_states, 0u);
}

} // namespace LIBC_NAMESPACE_DECL
