1 //========- unittests/Support/Host.cpp - Host.cpp tests --------------========// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include "llvm/Support/Host.h" 10 #include "llvm/ADT/SmallVector.h" 11 #include "llvm/ADT/Triple.h" 12 #include "llvm/Config/config.h" 13 #include "llvm/Support/FileSystem.h" 14 #include "llvm/Support/Path.h" 15 #include "llvm/Support/Program.h" 16 #include "llvm/Support/Threading.h" 17 18 #include "gtest/gtest.h" 19 20 #define ASSERT_NO_ERROR(x) \ 21 if (std::error_code ASSERT_NO_ERROR_ec = x) { \ 22 SmallString<128> MessageStorage; \ 23 raw_svector_ostream Message(MessageStorage); \ 24 Message << #x ": did not return errc::success.\n" \ 25 << "error number: " << ASSERT_NO_ERROR_ec.value() << "\n" \ 26 << "error message: " << ASSERT_NO_ERROR_ec.message() << "\n"; \ 27 GTEST_FATAL_FAILURE_(MessageStorage.c_str()); \ 28 } else { \ 29 } 30 31 using namespace llvm; 32 33 class HostTest : public testing::Test { 34 Triple Host; 35 36 protected: 37 bool isSupportedArchAndOS() { 38 // Initially this is only testing detection of the number of 39 // physical cores, which is currently only supported/tested on 40 // some systems. 41 return (Host.isOSWindows() && llvm_is_multithreaded()) || 42 Host.isOSDarwin() || (Host.isX86() && Host.isOSLinux()) || 43 (Host.isPPC64() && Host.isOSLinux()) || 44 (Host.isSystemZ() && (Host.isOSLinux() || Host.isOSzOS())); 45 } 46 47 HostTest() : Host(Triple::normalize(sys::getProcessTriple())) {} 48 }; 49 50 TEST_F(HostTest, NumPhysicalCoresSupported) { 51 if (!isSupportedArchAndOS()) 52 GTEST_SKIP(); 53 int Num = sys::getHostNumPhysicalCores(); 54 ASSERT_GT(Num, 0); 55 } 56 57 TEST_F(HostTest, NumPhysicalCoresUnsupported) { 58 if (isSupportedArchAndOS()) 59 GTEST_SKIP(); 60 int Num = sys::getHostNumPhysicalCores(); 61 ASSERT_EQ(Num, -1); 62 } 63 64 TEST(getLinuxHostCPUName, ARM) { 65 StringRef CortexA9ProcCpuinfo = R"( 66 processor : 0 67 model name : ARMv7 Processor rev 10 (v7l) 68 BogoMIPS : 1393.66 69 Features : half thumb fastmult vfp edsp thumbee neon vfpv3 tls vfpd32 70 CPU implementer : 0x41 71 CPU architecture: 7 72 CPU variant : 0x2 73 CPU part : 0xc09 74 CPU revision : 10 75 76 processor : 1 77 model name : ARMv7 Processor rev 10 (v7l) 78 BogoMIPS : 1393.66 79 Features : half thumb fastmult vfp edsp thumbee neon vfpv3 tls vfpd32 80 CPU implementer : 0x41 81 CPU architecture: 7 82 CPU variant : 0x2 83 CPU part : 0xc09 84 CPU revision : 10 85 86 Hardware : Generic OMAP4 (Flattened Device Tree) 87 Revision : 0000 88 Serial : 0000000000000000 89 )"; 90 91 EXPECT_EQ(sys::detail::getHostCPUNameForARM(CortexA9ProcCpuinfo), 92 "cortex-a9"); 93 EXPECT_EQ(sys::detail::getHostCPUNameForARM("CPU implementer : 0x41\n" 94 "CPU part : 0xc0f"), 95 "cortex-a15"); 96 // Verify that both CPU implementer and CPU part are checked: 97 EXPECT_EQ(sys::detail::getHostCPUNameForARM("CPU implementer : 0x40\n" 98 "CPU part : 0xc0f"), 99 "generic"); 100 EXPECT_EQ(sys::detail::getHostCPUNameForARM("CPU implementer : 0x51\n" 101 "CPU part : 0x06f"), 102 "krait"); 103 } 104 105 TEST(getLinuxHostCPUName, AArch64) { 106 EXPECT_EQ(sys::detail::getHostCPUNameForARM("CPU implementer : 0x41\n" 107 "CPU part : 0xd03"), 108 "cortex-a53"); 109 110 EXPECT_EQ(sys::detail::getHostCPUNameForARM("CPU implementer : 0x41\n" 111 "CPU part : 0xd40"), 112 "neoverse-v1"); 113 EXPECT_EQ(sys::detail::getHostCPUNameForARM("CPU implementer : 0x41\n" 114 "CPU part : 0xd0c"), 115 "neoverse-n1"); 116 // Verify that both CPU implementer and CPU part are checked: 117 EXPECT_EQ(sys::detail::getHostCPUNameForARM("CPU implementer : 0x40\n" 118 "CPU part : 0xd03"), 119 "generic"); 120 EXPECT_EQ(sys::detail::getHostCPUNameForARM("CPU implementer : 0x51\n" 121 "CPU part : 0x201"), 122 "kryo"); 123 EXPECT_EQ(sys::detail::getHostCPUNameForARM("CPU implementer : 0x51\n" 124 "CPU part : 0x800"), 125 "cortex-a73"); 126 EXPECT_EQ(sys::detail::getHostCPUNameForARM("CPU implementer : 0x51\n" 127 "CPU part : 0x801"), 128 "cortex-a73"); 129 EXPECT_EQ(sys::detail::getHostCPUNameForARM("CPU implementer : 0x51\n" 130 "CPU part : 0xc00"), 131 "falkor"); 132 EXPECT_EQ(sys::detail::getHostCPUNameForARM("CPU implementer : 0x51\n" 133 "CPU part : 0xc01"), 134 "saphira"); 135 136 // MSM8992/4 weirdness 137 StringRef MSM8992ProcCpuInfo = R"( 138 Processor : AArch64 Processor rev 3 (aarch64) 139 processor : 0 140 processor : 1 141 processor : 2 142 processor : 3 143 processor : 4 144 processor : 5 145 Features : fp asimd evtstrm aes pmull sha1 sha2 crc32 146 CPU implementer : 0x41 147 CPU architecture: 8 148 CPU variant : 0x0 149 CPU part : 0xd03 150 CPU revision : 3 151 152 Hardware : Qualcomm Technologies, Inc MSM8992 153 )"; 154 155 EXPECT_EQ(sys::detail::getHostCPUNameForARM(MSM8992ProcCpuInfo), 156 "cortex-a53"); 157 158 // Exynos big.LITTLE weirdness 159 const std::string ExynosProcCpuInfo = R"( 160 processor : 0 161 Features : fp asimd evtstrm aes pmull sha1 sha2 crc32 162 CPU implementer : 0x41 163 CPU architecture: 8 164 CPU variant : 0x0 165 CPU part : 0xd05 166 167 processor : 1 168 Features : fp asimd evtstrm aes pmull sha1 sha2 crc32 169 CPU implementer : 0x53 170 CPU architecture: 8 171 )"; 172 173 // Verify default for Exynos. 174 EXPECT_EQ(sys::detail::getHostCPUNameForARM(ExynosProcCpuInfo + 175 "CPU variant : 0xc\n" 176 "CPU part : 0xafe"), 177 "exynos-m3"); 178 // Verify Exynos M3. 179 EXPECT_EQ(sys::detail::getHostCPUNameForARM(ExynosProcCpuInfo + 180 "CPU variant : 0x1\n" 181 "CPU part : 0x002"), 182 "exynos-m3"); 183 // Verify Exynos M4. 184 EXPECT_EQ(sys::detail::getHostCPUNameForARM(ExynosProcCpuInfo + 185 "CPU variant : 0x1\n" 186 "CPU part : 0x003"), 187 "exynos-m4"); 188 189 const std::string ThunderX2T99ProcCpuInfo = R"( 190 processor : 0 191 BogoMIPS : 400.00 192 Features : fp asimd evtstrm aes pmull sha1 sha2 crc32 atomics 193 CPU implementer : 0x43 194 CPU architecture: 8 195 CPU variant : 0x1 196 CPU part : 0x0af 197 )"; 198 199 // Verify different versions of ThunderX2T99. 200 EXPECT_EQ(sys::detail::getHostCPUNameForARM(ThunderX2T99ProcCpuInfo + 201 "CPU implementer : 0x42\n" 202 "CPU part : 0x516"), 203 "thunderx2t99"); 204 205 EXPECT_EQ(sys::detail::getHostCPUNameForARM(ThunderX2T99ProcCpuInfo + 206 "CPU implementer : 0x42\n" 207 "CPU part : 0x0516"), 208 "thunderx2t99"); 209 210 EXPECT_EQ(sys::detail::getHostCPUNameForARM(ThunderX2T99ProcCpuInfo + 211 "CPU implementer : 0x43\n" 212 "CPU part : 0x516"), 213 "thunderx2t99"); 214 215 EXPECT_EQ(sys::detail::getHostCPUNameForARM(ThunderX2T99ProcCpuInfo + 216 "CPU implementer : 0x43\n" 217 "CPU part : 0x0516"), 218 "thunderx2t99"); 219 220 EXPECT_EQ(sys::detail::getHostCPUNameForARM(ThunderX2T99ProcCpuInfo + 221 "CPU implementer : 0x42\n" 222 "CPU part : 0xaf"), 223 "thunderx2t99"); 224 225 EXPECT_EQ(sys::detail::getHostCPUNameForARM(ThunderX2T99ProcCpuInfo + 226 "CPU implementer : 0x42\n" 227 "CPU part : 0x0af"), 228 "thunderx2t99"); 229 230 EXPECT_EQ(sys::detail::getHostCPUNameForARM(ThunderX2T99ProcCpuInfo + 231 "CPU implementer : 0x43\n" 232 "CPU part : 0xaf"), 233 "thunderx2t99"); 234 235 EXPECT_EQ(sys::detail::getHostCPUNameForARM(ThunderX2T99ProcCpuInfo + 236 "CPU implementer : 0x43\n" 237 "CPU part : 0x0af"), 238 "thunderx2t99"); 239 240 // Verify ThunderXT88. 241 const std::string ThunderXT88ProcCpuInfo = R"( 242 processor : 0 243 BogoMIPS : 200.00 244 Features : fp asimd evtstrm aes pmull sha1 sha2 crc32 245 CPU implementer : 0x43 246 CPU architecture: 8 247 CPU variant : 0x1 248 CPU part : 0x0a1 249 )"; 250 251 EXPECT_EQ(sys::detail::getHostCPUNameForARM(ThunderXT88ProcCpuInfo + 252 "CPU implementer : 0x43\n" 253 "CPU part : 0x0a1"), 254 "thunderxt88"); 255 256 EXPECT_EQ(sys::detail::getHostCPUNameForARM(ThunderXT88ProcCpuInfo + 257 "CPU implementer : 0x43\n" 258 "CPU part : 0xa1"), 259 "thunderxt88"); 260 261 // Verify HiSilicon processors. 262 EXPECT_EQ(sys::detail::getHostCPUNameForARM("CPU implementer : 0x48\n" 263 "CPU part : 0xd01"), 264 "tsv110"); 265 266 // Verify A64FX. 267 const std::string A64FXProcCpuInfo = R"( 268 processor : 0 269 BogoMIPS : 200.00 270 Features : fp asimd evtstrm sha1 sha2 crc32 atomics fphp asimdhp cpuid asimdrdm fcma dcpop sve 271 CPU implementer : 0x46 272 CPU architecture: 8 273 CPU variant : 0x1 274 CPU part : 0x001 275 )"; 276 277 EXPECT_EQ(sys::detail::getHostCPUNameForARM(A64FXProcCpuInfo), "a64fx"); 278 279 // Verify Nvidia Carmel. 280 const std::string CarmelProcCpuInfo = R"( 281 processor : 0 282 model name : ARMv8 Processor rev 0 (v8l) 283 BogoMIPS : 62.50 284 Features : fp asimd evtstrm aes pmull sha1 sha2 crc32 atomics fphp asimdhp cpuid asimdrdm dcpop 285 CPU implementer : 0x4e 286 CPU architecture: 8 287 CPU variant : 0x0 288 CPU part : 0x004 289 CPU revision : 0 290 )"; 291 292 EXPECT_EQ(sys::detail::getHostCPUNameForARM(CarmelProcCpuInfo), "carmel"); 293 294 // Snapdragon mixed implementer quirk 295 const std::string Snapdragon865ProcCPUInfo = R"( 296 processor : 0 297 BogoMIPS : 38.40 298 Features : fp asimd evtstrm aes pmull sha1 sha2 crc32 atomics fphp asimdhp cpuid asimdrdm lrcpc dcpop asimddp 299 CPU implementer : 0x51 300 CPU architecture: 8 301 CPU variant : 0xd 302 CPU part : 0x805 303 CPU revision : 14 304 processor : 1 305 processor : 2 306 processor : 3 307 processor : 4 308 processor : 5 309 processor : 6 310 BogoMIPS : 38.40 311 Features : fp asimd evtstrm aes pmull sha1 sha2 crc32 atomics fphp asimdhp cpuid asimdrdm lrcpc dcpop asimddp 312 CPU implementer : 0x41 313 CPU architecture: 8 314 CPU variant : 0x1 315 CPU part : 0xd0d 316 CPU revision : 0 317 )"; 318 EXPECT_EQ(sys::detail::getHostCPUNameForARM(Snapdragon865ProcCPUInfo), "cortex-a77"); 319 } 320 321 TEST(getLinuxHostCPUName, s390x) { 322 SmallVector<std::string> ModelIDs( 323 {"3931", "8561", "3906", "2964", "2827", "2817", "2097", "2064"}); 324 SmallVector<std::string> VectorSupport({"", "vx"}); 325 SmallVector<StringRef> ExpectedCPUs; 326 327 // Model Id: 3931 328 ExpectedCPUs.push_back("zEC12"); 329 ExpectedCPUs.push_back("z16"); 330 331 // Model Id: 8561 332 ExpectedCPUs.push_back("zEC12"); 333 ExpectedCPUs.push_back("z15"); 334 335 // Model Id: 3906 336 ExpectedCPUs.push_back("zEC12"); 337 ExpectedCPUs.push_back("z14"); 338 339 // Model Id: 2964 340 ExpectedCPUs.push_back("zEC12"); 341 ExpectedCPUs.push_back("z13"); 342 343 // Model Id: 2827 344 ExpectedCPUs.push_back("zEC12"); 345 ExpectedCPUs.push_back("zEC12"); 346 347 // Model Id: 2817 348 ExpectedCPUs.push_back("z196"); 349 ExpectedCPUs.push_back("z196"); 350 351 // Model Id: 2097 352 ExpectedCPUs.push_back("z10"); 353 ExpectedCPUs.push_back("z10"); 354 355 // Model Id: 2064 356 ExpectedCPUs.push_back("generic"); 357 ExpectedCPUs.push_back("generic"); 358 359 const std::string DummyBaseVectorInfo = 360 "features : esan3 zarch stfle msa ldisp eimm dfp edat etf3eh highgprs " 361 "te "; 362 const std::string DummyBaseMachineInfo = 363 "processor 0: version = FF, identification = 059C88, machine = "; 364 365 int CheckIndex = 0; 366 for (size_t I = 0; I < ModelIDs.size(); I++) { 367 for (size_t J = 0; J < VectorSupport.size(); J++) { 368 const std::string DummyCPUInfo = DummyBaseVectorInfo + VectorSupport[J] + 369 "\n" + DummyBaseMachineInfo + 370 ModelIDs[I]; 371 EXPECT_EQ(sys::detail::getHostCPUNameForS390x(DummyCPUInfo), 372 ExpectedCPUs[CheckIndex++]); 373 } 374 } 375 } 376 377 static bool runAndGetCommandOutput( 378 const char *ExePath, ArrayRef<llvm::StringRef> argv, 379 std::unique_ptr<char[]> &Buffer, off_t &Size) { 380 bool Success = false; 381 [ExePath, argv, &Buffer, &Size, &Success] { 382 using namespace llvm::sys; 383 SmallString<128> TestDirectory; 384 ASSERT_NO_ERROR(fs::createUniqueDirectory("host_test", TestDirectory)); 385 386 SmallString<128> OutputFile(TestDirectory); 387 path::append(OutputFile, "out"); 388 StringRef OutputPath = OutputFile.str(); 389 390 const Optional<StringRef> Redirects[] = { 391 /*STDIN=*/None, /*STDOUT=*/OutputPath, /*STDERR=*/None}; 392 int RetCode = ExecuteAndWait(ExePath, argv, /*env=*/llvm::None, Redirects); 393 ASSERT_EQ(0, RetCode); 394 395 int FD = 0; 396 ASSERT_NO_ERROR(fs::openFileForRead(OutputPath, FD)); 397 Size = ::lseek(FD, 0, SEEK_END); 398 ASSERT_NE(-1, Size); 399 ::lseek(FD, 0, SEEK_SET); 400 Buffer = std::make_unique<char[]>(Size); 401 ASSERT_EQ(::read(FD, Buffer.get(), Size), Size); 402 ::close(FD); 403 404 ASSERT_NO_ERROR(fs::remove(OutputPath)); 405 ASSERT_NO_ERROR(fs::remove(TestDirectory.str())); 406 Success = true; 407 }(); 408 return Success; 409 } 410 411 TEST_F(HostTest, DummyRunAndGetCommandOutputUse) { 412 // Suppress defined-but-not-used warnings when the tests using the helper are 413 // disabled. 414 (void)&runAndGetCommandOutput; 415 } 416 417 TEST_F(HostTest, getMacOSHostVersion) { 418 llvm::Triple HostTriple(llvm::sys::getProcessTriple()); 419 if (!HostTriple.isMacOSX()) 420 GTEST_SKIP(); 421 422 const char *SwVersPath = "/usr/bin/sw_vers"; 423 StringRef argv[] = {SwVersPath, "-productVersion"}; 424 std::unique_ptr<char[]> Buffer; 425 off_t Size; 426 ASSERT_EQ(runAndGetCommandOutput(SwVersPath, argv, Buffer, Size), true); 427 StringRef SystemVersionStr = StringRef(Buffer.get(), Size).rtrim(); 428 429 // Ensure that the two versions match. 430 VersionTuple SystemVersion; 431 ASSERT_EQ(llvm::Triple((Twine("x86_64-apple-macos") + SystemVersionStr)) 432 .getMacOSXVersion(SystemVersion), 433 true); 434 VersionTuple HostVersion; 435 ASSERT_EQ(HostTriple.getMacOSXVersion(HostVersion), true); 436 437 if (SystemVersion.getMajor() > 10) { 438 // Don't compare the 'Minor' and 'Micro' versions, as they're always '0' for 439 // the 'Darwin' triples on 11.x. 440 ASSERT_EQ(SystemVersion.getMajor(), HostVersion.getMajor()); 441 } else { 442 // Don't compare the 'Micro' version, as it's always '0' for the 'Darwin' 443 // triples. 444 ASSERT_EQ(SystemVersion.getMajor(), HostVersion.getMajor()); 445 ASSERT_EQ(SystemVersion.getMinor(), HostVersion.getMinor()); 446 } 447 } 448 449 // Helper to return AIX system version. Must return void to use ASSERT_*. 450 static void getAIXSystemVersion(VersionTuple &SystemVersion) { 451 const char *ExePath = "/usr/bin/oslevel"; 452 StringRef argv[] = {ExePath}; 453 std::unique_ptr<char[]> Buffer; 454 off_t Size; 455 ASSERT_EQ(runAndGetCommandOutput(ExePath, argv, Buffer, Size), true); 456 StringRef SystemVersionStr = StringRef(Buffer.get(), Size).rtrim(); 457 458 SystemVersion = 459 llvm::Triple((Twine("powerpc-ibm-aix") + SystemVersionStr)) 460 .getOSVersion(); 461 } 462 463 TEST_F(HostTest, AIXHostVersionDetect) { 464 llvm::Triple HostTriple(llvm::sys::getProcessTriple()); 465 if (HostTriple.getOS() != Triple::AIX) 466 GTEST_SKIP(); 467 468 llvm::Triple ConfiguredHostTriple(LLVM_HOST_TRIPLE); 469 ASSERT_EQ(ConfiguredHostTriple.getOS(), Triple::AIX); 470 471 VersionTuple SystemVersion; 472 getAIXSystemVersion(SystemVersion); 473 474 // Ensure that the host triple version (major) and release (minor) numbers, 475 // unless explicitly configured, match with those of the current system. 476 auto SysMajor = SystemVersion.getMajor(); 477 auto SysMinor = SystemVersion.getMinor(); 478 VersionTuple HostVersion = HostTriple.getOSVersion(); 479 if (ConfiguredHostTriple.getOSMajorVersion()) { 480 // Explicitly configured, force a match. We do it this way so the 481 // asserts are always executed. 482 SysMajor = HostVersion.getMajor(); 483 SysMinor = HostVersion.getMinor(); 484 } 485 ASSERT_EQ(SysMajor, HostVersion.getMajor()); 486 ASSERT_EQ(SysMinor, HostVersion.getMinor()); 487 } 488 489 TEST_F(HostTest, AIXTargetVersionDetect) { 490 llvm::Triple TargetTriple(llvm::sys::getDefaultTargetTriple()); 491 if (TargetTriple.getOS() != Triple::AIX) 492 GTEST_SKIP(); 493 494 // Ensure that the target triple version (major) and release (minor) numbers 495 // match with those of the current system. 496 llvm::Triple ConfiguredTargetTriple(LLVM_DEFAULT_TARGET_TRIPLE); 497 if (ConfiguredTargetTriple.getOSMajorVersion()) 498 GTEST_SKIP(); // The version was configured explicitly; skip. 499 500 VersionTuple SystemVersion; 501 getAIXSystemVersion(SystemVersion); 502 VersionTuple TargetVersion = TargetTriple.getOSVersion(); 503 ASSERT_EQ(SystemVersion.getMajor(), TargetVersion.getMajor()); 504 ASSERT_EQ(SystemVersion.getMinor(), TargetVersion.getMinor()); 505 } 506 507 TEST_F(HostTest, AIXHostCPUDetect) { 508 llvm::Triple HostTriple(llvm::sys::getProcessTriple()); 509 if (HostTriple.getOS() != Triple::AIX) 510 GTEST_SKIP(); 511 512 // Return a value based on the current processor implementation mode. 513 const char *ExePath = "/usr/sbin/getsystype"; 514 StringRef argv[] = {ExePath, "-i"}; 515 std::unique_ptr<char[]> Buffer; 516 off_t Size; 517 ASSERT_EQ(runAndGetCommandOutput(ExePath, argv, Buffer, Size), true); 518 StringRef CPU(Buffer.get(), Size); 519 StringRef MCPU = StringSwitch<const char *>(CPU) 520 .Case("POWER 4\n", "pwr4") 521 .Case("POWER 5\n", "pwr5") 522 .Case("POWER 6\n", "pwr6") 523 .Case("POWER 7\n", "pwr7") 524 .Case("POWER 8\n", "pwr8") 525 .Case("POWER 9\n", "pwr9") 526 .Case("POWER 10\n", "pwr10") 527 .Default("unknown"); 528 529 StringRef HostCPU = sys::getHostCPUName(); 530 531 // Just do the comparison on the base implementation mode. 532 if (HostCPU == "970") 533 HostCPU = StringRef("pwr4"); 534 else 535 HostCPU = HostCPU.rtrim('x'); 536 537 EXPECT_EQ(HostCPU, MCPU); 538 } 539