1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
|
//===-- Implementation of the base class for libc unittests----------------===//
//
// 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 "LibcTest.h"
#include "src/__support/CPP/string.h"
#include "src/__support/CPP/string_view.h"
#include "src/__support/UInt128.h"
#include "test/UnitTest/TestLogger.h"
#if __STDC_HOSTED__
#include <time.h>
#elif defined(LIBC_TARGET_ARCH_IS_GPU)
#include "src/__support/GPU/utils.h"
static long clock() { return __llvm_libc::gpu::fixed_frequency_clock(); }
#if defined(LIBC_TARGET_ARCH_IS_NVPTX)
#define CLOCKS_PER_SEC 1000000000UL
#else
// The AMDGPU loader needs to initialize this at runtime by querying the driver.
extern "C" [[gnu::visibility("protected")]] uint64_t
[[clang::address_space(4)]] __llvm_libc_clock_freq;
#define CLOCKS_PER_SEC __llvm_libc_clock_freq
#endif
#else
static long clock() { return 0; }
#define CLOCKS_PER_SEC 1
#endif
namespace __llvm_libc {
namespace testing {
namespace internal {
TestLogger &operator<<(TestLogger &logger, Location Loc) {
return logger << Loc.file << ":" << Loc.line << ": FAILURE\n";
}
// When the value is UInt128, __uint128_t or wider, show its hexadecimal
// digits.
template <typename T>
cpp::enable_if_t<cpp::is_integral_v<T> && (sizeof(T) > sizeof(uint64_t)),
cpp::string>
describeValue(T Value) {
static_assert(sizeof(T) % 8 == 0, "Unsupported size of UInt");
char buf[IntegerToString::hex_bufsize<T>()];
IntegerToString::hex(Value, buf, false);
return "0x" + cpp::string(buf, sizeof(buf));
}
// When the value is of a standard integral type, just display it as normal.
template <typename ValType>
cpp::enable_if_t<cpp::is_integral_v<ValType> &&
sizeof(ValType) <= sizeof(uint64_t),
cpp::string>
describeValue(ValType Value) {
return cpp::to_string(Value);
}
cpp::string_view describeValue(const cpp::string &Value) { return Value; }
cpp::string_view describeValue(cpp::string_view Value) { return Value; }
template <typename ValType>
bool test(RunContext *Ctx, TestCond Cond, ValType LHS, ValType RHS,
const char *LHSStr, const char *RHSStr, Location Loc) {
auto ExplainDifference = [=, &Ctx](bool Cond,
cpp::string_view OpString) -> bool {
if (Cond)
return true;
Ctx->markFail();
size_t OffsetLength = OpString.size() > 2 ? OpString.size() - 2 : 0;
cpp::string Offset(OffsetLength, ' ');
tlog << Loc;
tlog << Offset << "Expected: " << LHSStr << '\n'
<< Offset << "Which is: " << describeValue(LHS) << '\n'
<< "To be " << OpString << ": " << RHSStr << '\n'
<< Offset << "Which is: " << describeValue(RHS) << '\n';
return false;
};
switch (Cond) {
case TestCond::EQ:
return ExplainDifference(LHS == RHS, "equal to");
case TestCond::NE:
return ExplainDifference(LHS != RHS, "not equal to");
case TestCond::LT:
return ExplainDifference(LHS < RHS, "less than");
case TestCond::LE:
return ExplainDifference(LHS <= RHS, "less than or equal to");
case TestCond::GT:
return ExplainDifference(LHS > RHS, "greater than");
case TestCond::GE:
return ExplainDifference(LHS >= RHS, "greater than or equal to");
}
}
} // namespace internal
Test *Test::Start = nullptr;
Test *Test::End = nullptr;
int argc = 0;
char **argv = nullptr;
char **envp = nullptr;
using internal::RunContext;
void Test::addTest(Test *T) {
if (End == nullptr) {
Start = T;
End = T;
return;
}
End->Next = T;
End = T;
}
int Test::runTests(const char *TestFilter) {
int TestCount = 0;
int FailCount = 0;
for (Test *T = Start; T != nullptr; T = T->Next) {
const char *TestName = T->getName();
cpp::string StrTestName(TestName);
constexpr auto GREEN = "\033[32m";
constexpr auto RED = "\033[31m";
constexpr auto RESET = "\033[0m";
if ((TestFilter != nullptr) && (StrTestName != TestFilter)) {
continue;
}
tlog << GREEN << "[ RUN ] " << RESET << TestName << '\n';
[[maybe_unused]] const auto start_time = clock();
RunContext Ctx;
T->SetUp();
T->setContext(&Ctx);
T->Run();
T->TearDown();
[[maybe_unused]] const auto end_time = clock();
switch (Ctx.status()) {
case RunContext::RunResult::Fail:
tlog << RED << "[ FAILED ] " << RESET << TestName << '\n';
++FailCount;
break;
case RunContext::RunResult::Pass:
tlog << GREEN << "[ OK ] " << RESET << TestName;
#if __STDC_HOSTED__ || defined(LIBC_TARGET_ARCH_IS_GPU)
tlog << " (took ";
if (start_time > end_time) {
tlog << "unknown - try rerunning)\n";
} else {
const auto duration = end_time - start_time;
const uint64_t duration_ms = (duration * 1000) / CLOCKS_PER_SEC;
const uint64_t duration_us = (duration * 1000 * 1000) / CLOCKS_PER_SEC;
const uint64_t duration_ns =
(duration * 1000 * 1000 * 1000) / CLOCKS_PER_SEC;
if (duration_ms != 0)
tlog << duration_ms << " ms)\n";
else if (duration_us != 0)
tlog << duration_us << " us)\n";
else
tlog << duration_ns << " ns)\n";
}
#else
tlog << '\n';
#endif
break;
}
++TestCount;
}
if (TestCount > 0) {
tlog << "Ran " << TestCount << " tests. "
<< " PASS: " << TestCount - FailCount << ' ' << " FAIL: " << FailCount
<< '\n';
} else {
tlog << "No tests run.\n";
if (TestFilter) {
tlog << "No matching test for " << TestFilter << '\n';
}
}
return FailCount > 0 || TestCount == 0 ? 1 : 0;
}
namespace internal {
template bool test<char>(RunContext *Ctx, TestCond Cond, char LHS, char RHS,
const char *LHSStr, const char *RHSStr, Location Loc);
template bool test<short>(RunContext *Ctx, TestCond Cond, short LHS, short RHS,
const char *LHSStr, const char *RHSStr, Location Loc);
template bool test<int>(RunContext *Ctx, TestCond Cond, int LHS, int RHS,
const char *LHSStr, const char *RHSStr, Location Loc);
template bool test<long>(RunContext *Ctx, TestCond Cond, long LHS, long RHS,
const char *LHSStr, const char *RHSStr, Location Loc);
template bool test<long long>(RunContext *Ctx, TestCond Cond, long long LHS,
long long RHS, const char *LHSStr,
const char *RHSStr, Location Loc);
template bool test<unsigned char>(RunContext *Ctx, TestCond Cond,
unsigned char LHS, unsigned char RHS,
const char *LHSStr, const char *RHSStr,
Location Loc);
template bool test<unsigned short>(RunContext *Ctx, TestCond Cond,
unsigned short LHS, unsigned short RHS,
const char *LHSStr, const char *RHSStr,
Location Loc);
template bool test<unsigned int>(RunContext *Ctx, TestCond Cond,
unsigned int LHS, unsigned int RHS,
const char *LHSStr, const char *RHSStr,
Location Loc);
template bool test<unsigned long>(RunContext *Ctx, TestCond Cond,
unsigned long LHS, unsigned long RHS,
const char *LHSStr, const char *RHSStr,
Location Loc);
template bool test<bool>(RunContext *Ctx, TestCond Cond, bool LHS, bool RHS,
const char *LHSStr, const char *RHSStr, Location Loc);
template bool test<unsigned long long>(RunContext *Ctx, TestCond Cond,
unsigned long long LHS,
unsigned long long RHS,
const char *LHSStr, const char *RHSStr,
Location Loc);
// We cannot just use a single UInt128 specialization as that resolves to only
// one type, UInt<128> or __uint128_t. We want both overloads as we want to
// be able to unittest UInt<128> on platforms where UInt128 resolves to
// UInt128.
#ifdef __SIZEOF_INT128__
// When builtin __uint128_t type is available, include its specialization
// also.
template bool test<__uint128_t>(RunContext *Ctx, TestCond Cond, __uint128_t LHS,
__uint128_t RHS, const char *LHSStr,
const char *RHSStr, Location Loc);
#endif
template bool test<__llvm_libc::cpp::Int<128>>(RunContext *Ctx, TestCond Cond,
__llvm_libc::cpp::Int<128> LHS,
__llvm_libc::cpp::Int<128> RHS,
const char *LHSStr,
const char *RHSStr,
Location Loc);
template bool test<__llvm_libc::cpp::UInt<128>>(RunContext *Ctx, TestCond Cond,
__llvm_libc::cpp::UInt<128> LHS,
__llvm_libc::cpp::UInt<128> RHS,
const char *LHSStr,
const char *RHSStr,
Location Loc);
template bool test<__llvm_libc::cpp::UInt<192>>(RunContext *Ctx, TestCond Cond,
__llvm_libc::cpp::UInt<192> LHS,
__llvm_libc::cpp::UInt<192> RHS,
const char *LHSStr,
const char *RHSStr,
Location Loc);
template bool test<__llvm_libc::cpp::UInt<256>>(RunContext *Ctx, TestCond Cond,
__llvm_libc::cpp::UInt<256> LHS,
__llvm_libc::cpp::UInt<256> RHS,
const char *LHSStr,
const char *RHSStr,
Location Loc);
template bool test<__llvm_libc::cpp::UInt<320>>(RunContext *Ctx, TestCond Cond,
__llvm_libc::cpp::UInt<320> LHS,
__llvm_libc::cpp::UInt<320> RHS,
const char *LHSStr,
const char *RHSStr,
Location Loc);
template bool test<__llvm_libc::cpp::string_view>(
RunContext *Ctx, TestCond Cond, __llvm_libc::cpp::string_view LHS,
__llvm_libc::cpp::string_view RHS, const char *LHSStr, const char *RHSStr,
Location Loc);
template bool test<__llvm_libc::cpp::string>(RunContext *Ctx, TestCond Cond,
__llvm_libc::cpp::string LHS,
__llvm_libc::cpp::string RHS,
const char *LHSStr,
const char *RHSStr, Location Loc);
} // namespace internal
bool Test::testStrEq(const char *LHS, const char *RHS, const char *LHSStr,
const char *RHSStr, internal::Location Loc) {
return internal::test(
Ctx, TestCond::EQ, LHS ? cpp::string_view(LHS) : cpp::string_view(),
RHS ? cpp::string_view(RHS) : cpp::string_view(), LHSStr, RHSStr, Loc);
}
bool Test::testStrNe(const char *LHS, const char *RHS, const char *LHSStr,
const char *RHSStr, internal::Location Loc) {
return internal::test(
Ctx, TestCond::NE, LHS ? cpp::string_view(LHS) : cpp::string_view(),
RHS ? cpp::string_view(RHS) : cpp::string_view(), LHSStr, RHSStr, Loc);
}
bool Test::testMatch(bool MatchResult, MatcherBase &Matcher, const char *LHSStr,
const char *RHSStr, internal::Location Loc) {
if (MatchResult)
return true;
Ctx->markFail();
if (!Matcher.is_silent()) {
tlog << Loc;
tlog << "Failed to match " << LHSStr << " against " << RHSStr << ".\n";
Matcher.explainError();
}
return false;
}
} // namespace testing
} // namespace __llvm_libc
|