1 //===- unittest/Support/ProgramTest.cpp -----------------------------------===// 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/Program.h" 10 #include "llvm/Config/llvm-config.h" 11 #include "llvm/Support/CommandLine.h" 12 #include "llvm/Support/ConvertUTF.h" 13 #include "llvm/Support/FileSystem.h" 14 #include "llvm/Support/Path.h" 15 #include "llvm/Support/Signals.h" 16 #include "gtest/gtest.h" 17 #include <stdlib.h> 18 #include <thread> 19 #if defined(__APPLE__) 20 # include <crt_externs.h> 21 #elif !defined(_MSC_VER) 22 // Forward declare environ in case it's not provided by stdlib.h. 23 extern char **environ; 24 #endif 25 26 #if defined(LLVM_ON_UNIX) 27 #include <unistd.h> 28 void sleep_for(unsigned int seconds) { 29 sleep(seconds); 30 } 31 #elif defined(_WIN32) 32 #include <windows.h> 33 void sleep_for(unsigned int seconds) { 34 Sleep(seconds * 1000); 35 } 36 #else 37 #error sleep_for is not implemented on your platform. 38 #endif 39 40 #define ASSERT_NO_ERROR(x) \ 41 if (std::error_code ASSERT_NO_ERROR_ec = x) { \ 42 SmallString<128> MessageStorage; \ 43 raw_svector_ostream Message(MessageStorage); \ 44 Message << #x ": did not return errc::success.\n" \ 45 << "error number: " << ASSERT_NO_ERROR_ec.value() << "\n" \ 46 << "error message: " << ASSERT_NO_ERROR_ec.message() << "\n"; \ 47 GTEST_FATAL_FAILURE_(MessageStorage.c_str()); \ 48 } else { \ 49 } 50 // From TestMain.cpp. 51 extern const char *TestMainArgv0; 52 53 namespace { 54 55 using namespace llvm; 56 using namespace sys; 57 58 static cl::opt<std::string> 59 ProgramTestStringArg1("program-test-string-arg1"); 60 static cl::opt<std::string> 61 ProgramTestStringArg2("program-test-string-arg2"); 62 63 class ProgramEnvTest : public testing::Test { 64 std::vector<StringRef> EnvTable; 65 std::vector<std::string> EnvStorage; 66 67 protected: 68 void SetUp() override { 69 auto EnvP = [] { 70 #if defined(_WIN32) 71 _wgetenv(L"TMP"); // Populate _wenviron, initially is null 72 return _wenviron; 73 #elif defined(__APPLE__) 74 return *_NSGetEnviron(); 75 #else 76 return environ; 77 #endif 78 }(); 79 ASSERT_TRUE(EnvP); 80 81 auto prepareEnvVar = [this](decltype(*EnvP) Var) -> StringRef { 82 #if defined(_WIN32) 83 // On Windows convert UTF16 encoded variable to UTF8 84 auto Len = wcslen(Var); 85 ArrayRef<char> Ref{reinterpret_cast<char const *>(Var), 86 Len * sizeof(*Var)}; 87 EnvStorage.emplace_back(); 88 auto convStatus = convertUTF16ToUTF8String(Ref, EnvStorage.back()); 89 EXPECT_TRUE(convStatus); 90 return EnvStorage.back(); 91 #else 92 (void)this; 93 return StringRef(Var); 94 #endif 95 }; 96 97 while (*EnvP != nullptr) { 98 auto S = prepareEnvVar(*EnvP); 99 if (!StringRef(S).startswith("GTEST_")) 100 EnvTable.emplace_back(S); 101 ++EnvP; 102 } 103 } 104 105 void TearDown() override { 106 EnvTable.clear(); 107 EnvStorage.clear(); 108 } 109 110 void addEnvVar(StringRef Var) { EnvTable.emplace_back(Var); } 111 112 ArrayRef<StringRef> getEnviron() const { return EnvTable; } 113 }; 114 115 #ifdef _WIN32 116 void checkSeparators(StringRef Path) { 117 char UndesiredSeparator = sys::path::get_separator()[0] == '/' ? '\\' : '/'; 118 ASSERT_EQ(Path.find(UndesiredSeparator), StringRef::npos); 119 } 120 121 TEST_F(ProgramEnvTest, CreateProcessLongPath) { 122 if (getenv("LLVM_PROGRAM_TEST_LONG_PATH")) 123 exit(0); 124 125 // getMainExecutable returns an absolute path; prepend the long-path prefix. 126 SmallString<128> MyAbsExe( 127 sys::fs::getMainExecutable(TestMainArgv0, &ProgramTestStringArg1)); 128 checkSeparators(MyAbsExe); 129 // Force a path with backslashes, when we are going to prepend the \\?\ 130 // prefix. 131 sys::path::native(MyAbsExe, sys::path::Style::windows_backslash); 132 std::string MyExe; 133 if (!StringRef(MyAbsExe).startswith("\\\\?\\")) 134 MyExe.append("\\\\?\\"); 135 MyExe.append(std::string(MyAbsExe.begin(), MyAbsExe.end())); 136 137 StringRef ArgV[] = {MyExe, 138 "--gtest_filter=ProgramEnvTest.CreateProcessLongPath"}; 139 140 // Add LLVM_PROGRAM_TEST_LONG_PATH to the environment of the child. 141 addEnvVar("LLVM_PROGRAM_TEST_LONG_PATH=1"); 142 143 // Redirect stdout to a long path. 144 SmallString<128> TestDirectory; 145 ASSERT_NO_ERROR( 146 fs::createUniqueDirectory("program-redirect-test", TestDirectory)); 147 SmallString<256> LongPath(TestDirectory); 148 LongPath.push_back('\\'); 149 // MAX_PATH = 260 150 LongPath.append(260 - TestDirectory.size(), 'a'); 151 152 std::string Error; 153 bool ExecutionFailed; 154 std::optional<StringRef> Redirects[] = {std::nullopt, LongPath.str(), 155 std::nullopt}; 156 int RC = ExecuteAndWait(MyExe, ArgV, getEnviron(), Redirects, 157 /*secondsToWait=*/ 10, /*memoryLimit=*/ 0, &Error, 158 &ExecutionFailed); 159 EXPECT_FALSE(ExecutionFailed) << Error; 160 EXPECT_EQ(0, RC); 161 162 // Remove the long stdout. 163 ASSERT_NO_ERROR(fs::remove(Twine(LongPath))); 164 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory))); 165 } 166 #endif 167 168 TEST_F(ProgramEnvTest, CreateProcessTrailingSlash) { 169 if (getenv("LLVM_PROGRAM_TEST_CHILD")) { 170 if (ProgramTestStringArg1 == "has\\\\ trailing\\" && 171 ProgramTestStringArg2 == "has\\\\ trailing\\") { 172 exit(0); // Success! The arguments were passed and parsed. 173 } 174 exit(1); 175 } 176 177 std::string my_exe = 178 sys::fs::getMainExecutable(TestMainArgv0, &ProgramTestStringArg1); 179 StringRef argv[] = { 180 my_exe, 181 "--gtest_filter=ProgramEnvTest.CreateProcessTrailingSlash", 182 "-program-test-string-arg1", 183 "has\\\\ trailing\\", 184 "-program-test-string-arg2", 185 "has\\\\ trailing\\"}; 186 187 // Add LLVM_PROGRAM_TEST_CHILD to the environment of the child. 188 addEnvVar("LLVM_PROGRAM_TEST_CHILD=1"); 189 190 std::string error; 191 bool ExecutionFailed; 192 // Redirect stdout and stdin to NUL, but let stderr through. 193 #ifdef _WIN32 194 StringRef nul("NUL"); 195 #else 196 StringRef nul("/dev/null"); 197 #endif 198 std::optional<StringRef> redirects[] = {nul, nul, std::nullopt}; 199 int rc = ExecuteAndWait(my_exe, argv, getEnviron(), redirects, 200 /*secondsToWait=*/ 10, /*memoryLimit=*/ 0, &error, 201 &ExecutionFailed); 202 EXPECT_FALSE(ExecutionFailed) << error; 203 EXPECT_EQ(0, rc); 204 } 205 206 TEST_F(ProgramEnvTest, TestExecuteNoWait) { 207 using namespace llvm::sys; 208 209 if (getenv("LLVM_PROGRAM_TEST_EXECUTE_NO_WAIT")) { 210 sleep_for(/*seconds*/ 1); 211 exit(0); 212 } 213 214 std::string Executable = 215 sys::fs::getMainExecutable(TestMainArgv0, &ProgramTestStringArg1); 216 StringRef argv[] = {Executable, 217 "--gtest_filter=ProgramEnvTest.TestExecuteNoWait"}; 218 219 // Add LLVM_PROGRAM_TEST_EXECUTE_NO_WAIT to the environment of the child. 220 addEnvVar("LLVM_PROGRAM_TEST_EXECUTE_NO_WAIT=1"); 221 222 std::string Error; 223 bool ExecutionFailed; 224 ProcessInfo PI1 = ExecuteNoWait(Executable, argv, getEnviron(), {}, 0, &Error, 225 &ExecutionFailed); 226 ASSERT_FALSE(ExecutionFailed) << Error; 227 ASSERT_NE(PI1.Pid, ProcessInfo::InvalidPid) << "Invalid process id"; 228 229 unsigned LoopCount = 0; 230 231 // Test that Wait() with WaitUntilTerminates=true works. In this case, 232 // LoopCount should only be incremented once. 233 while (true) { 234 ++LoopCount; 235 ProcessInfo WaitResult = llvm::sys::Wait(PI1, 0, true, &Error); 236 ASSERT_TRUE(Error.empty()); 237 if (WaitResult.Pid == PI1.Pid) 238 break; 239 } 240 241 EXPECT_EQ(LoopCount, 1u) << "LoopCount should be 1"; 242 243 ProcessInfo PI2 = ExecuteNoWait(Executable, argv, getEnviron(), {}, 0, &Error, 244 &ExecutionFailed); 245 ASSERT_FALSE(ExecutionFailed) << Error; 246 ASSERT_NE(PI2.Pid, ProcessInfo::InvalidPid) << "Invalid process id"; 247 248 // Test that Wait() with SecondsToWait=0 performs a non-blocking wait. In this 249 // cse, LoopCount should be greater than 1 (more than one increment occurs). 250 while (true) { 251 ++LoopCount; 252 ProcessInfo WaitResult = llvm::sys::Wait(PI2, 0, false, &Error); 253 ASSERT_TRUE(Error.empty()); 254 if (WaitResult.Pid == PI2.Pid) 255 break; 256 } 257 258 ASSERT_GT(LoopCount, 1u) << "LoopCount should be >1"; 259 } 260 261 TEST_F(ProgramEnvTest, TestExecuteAndWaitTimeout) { 262 using namespace llvm::sys; 263 264 if (getenv("LLVM_PROGRAM_TEST_TIMEOUT")) { 265 sleep_for(/*seconds*/ 10); 266 exit(0); 267 } 268 269 std::string Executable = 270 sys::fs::getMainExecutable(TestMainArgv0, &ProgramTestStringArg1); 271 StringRef argv[] = { 272 Executable, "--gtest_filter=ProgramEnvTest.TestExecuteAndWaitTimeout"}; 273 274 // Add LLVM_PROGRAM_TEST_TIMEOUT to the environment of the child. 275 addEnvVar("LLVM_PROGRAM_TEST_TIMEOUT=1"); 276 277 std::string Error; 278 bool ExecutionFailed; 279 int RetCode = 280 ExecuteAndWait(Executable, argv, getEnviron(), {}, /*secondsToWait=*/1, 0, 281 &Error, &ExecutionFailed); 282 ASSERT_EQ(-2, RetCode); 283 } 284 285 TEST(ProgramTest, TestExecuteNegative) { 286 std::string Executable = "i_dont_exist"; 287 StringRef argv[] = {Executable}; 288 289 { 290 std::string Error; 291 bool ExecutionFailed; 292 int RetCode = ExecuteAndWait(Executable, argv, std::nullopt, {}, 0, 0, 293 &Error, &ExecutionFailed); 294 ASSERT_LT(RetCode, 0) << "On error ExecuteAndWait should return 0 or " 295 "positive value indicating the result code"; 296 ASSERT_TRUE(ExecutionFailed); 297 ASSERT_FALSE(Error.empty()); 298 } 299 300 { 301 std::string Error; 302 bool ExecutionFailed; 303 ProcessInfo PI = ExecuteNoWait(Executable, argv, std::nullopt, {}, 0, 304 &Error, &ExecutionFailed); 305 ASSERT_EQ(PI.Pid, ProcessInfo::InvalidPid) 306 << "On error ExecuteNoWait should return an invalid ProcessInfo"; 307 ASSERT_TRUE(ExecutionFailed); 308 ASSERT_FALSE(Error.empty()); 309 } 310 311 } 312 313 #ifdef _WIN32 314 const char utf16le_text[] = 315 "\x6c\x00\x69\x00\x6e\x00\x67\x00\xfc\x00\x69\x00\xe7\x00\x61\x00"; 316 const char utf16be_text[] = 317 "\x00\x6c\x00\x69\x00\x6e\x00\x67\x00\xfc\x00\x69\x00\xe7\x00\x61"; 318 #endif 319 const char utf8_text[] = "\x6c\x69\x6e\x67\xc3\xbc\x69\xc3\xa7\x61"; 320 321 TEST(ProgramTest, TestWriteWithSystemEncoding) { 322 SmallString<128> TestDirectory; 323 ASSERT_NO_ERROR(fs::createUniqueDirectory("program-test", TestDirectory)); 324 errs() << "Test Directory: " << TestDirectory << '\n'; 325 errs().flush(); 326 SmallString<128> file_pathname(TestDirectory); 327 path::append(file_pathname, "international-file.txt"); 328 // Only on Windows we should encode in UTF16. For other systems, use UTF8 329 ASSERT_NO_ERROR(sys::writeFileWithEncoding(file_pathname.c_str(), utf8_text, 330 sys::WEM_UTF16)); 331 int fd = 0; 332 ASSERT_NO_ERROR(fs::openFileForRead(file_pathname.c_str(), fd)); 333 #if defined(_WIN32) 334 char buf[18]; 335 ASSERT_EQ(::read(fd, buf, 18), 18); 336 const char *utf16_text; 337 if (strncmp(buf, "\xfe\xff", 2) == 0) { // UTF16-BE 338 utf16_text = utf16be_text; 339 } else if (strncmp(buf, "\xff\xfe", 2) == 0) { // UTF16-LE 340 utf16_text = utf16le_text; 341 } else { 342 FAIL() << "Invalid BOM in UTF-16 file"; 343 } 344 ASSERT_EQ(strncmp(&buf[2], utf16_text, 16), 0); 345 #else 346 char buf[10]; 347 ASSERT_EQ(::read(fd, buf, 10), 10); 348 ASSERT_EQ(strncmp(buf, utf8_text, 10), 0); 349 #endif 350 ::close(fd); 351 ASSERT_NO_ERROR(fs::remove(file_pathname.str())); 352 ASSERT_NO_ERROR(fs::remove(TestDirectory.str())); 353 } 354 355 TEST_F(ProgramEnvTest, TestExecuteAndWaitStatistics) { 356 using namespace llvm::sys; 357 358 if (getenv("LLVM_PROGRAM_TEST_STATISTICS")) 359 exit(0); 360 361 std::string Executable = 362 sys::fs::getMainExecutable(TestMainArgv0, &ProgramTestStringArg1); 363 StringRef argv[] = { 364 Executable, "--gtest_filter=ProgramEnvTest.TestExecuteAndWaitStatistics"}; 365 366 // Add LLVM_PROGRAM_TEST_STATISTICS to the environment of the child. 367 addEnvVar("LLVM_PROGRAM_TEST_STATISTICS=1"); 368 369 std::string Error; 370 bool ExecutionFailed; 371 std::optional<ProcessStatistics> ProcStat; 372 int RetCode = ExecuteAndWait(Executable, argv, getEnviron(), {}, 0, 0, &Error, 373 &ExecutionFailed, &ProcStat); 374 ASSERT_EQ(0, RetCode); 375 ASSERT_TRUE(ProcStat); 376 ASSERT_GE(ProcStat->UserTime, std::chrono::microseconds(0)); 377 ASSERT_GE(ProcStat->TotalTime, ProcStat->UserTime); 378 } 379 380 TEST_F(ProgramEnvTest, TestLockFile) { 381 using namespace llvm::sys; 382 383 if (const char *LockedFile = getenv("LLVM_PROGRAM_TEST_LOCKED_FILE")) { 384 // Child process. 385 int FD2; 386 ASSERT_NO_ERROR(fs::openFileForReadWrite(LockedFile, FD2, 387 fs::CD_OpenExisting, fs::OF_None)); 388 389 std::error_code ErrC = fs::tryLockFile(FD2, std::chrono::seconds(5)); 390 ASSERT_NO_ERROR(ErrC); 391 ASSERT_NO_ERROR(fs::unlockFile(FD2)); 392 close(FD2); 393 exit(0); 394 } 395 396 // Create file that will be locked. 397 SmallString<64> LockedFile; 398 int FD1; 399 ASSERT_NO_ERROR( 400 fs::createTemporaryFile("TestLockFile", "temp", FD1, LockedFile)); 401 402 std::string Executable = 403 sys::fs::getMainExecutable(TestMainArgv0, &ProgramTestStringArg1); 404 StringRef argv[] = {Executable, "--gtest_filter=ProgramEnvTest.TestLockFile"}; 405 406 // Add LLVM_PROGRAM_TEST_LOCKED_FILE to the environment of the child. 407 std::string EnvVar = "LLVM_PROGRAM_TEST_LOCKED_FILE="; 408 EnvVar += LockedFile.str(); 409 addEnvVar(EnvVar); 410 411 // Lock the file. 412 ASSERT_NO_ERROR(fs::tryLockFile(FD1)); 413 414 std::string Error; 415 bool ExecutionFailed; 416 ProcessInfo PI2 = ExecuteNoWait(Executable, argv, getEnviron(), {}, 0, &Error, 417 &ExecutionFailed); 418 ASSERT_FALSE(ExecutionFailed) << Error; 419 ASSERT_TRUE(Error.empty()); 420 ASSERT_NE(PI2.Pid, ProcessInfo::InvalidPid) << "Invalid process id"; 421 422 // Wait some time to give the child process a chance to start. 423 std::this_thread::sleep_for(std::chrono::milliseconds(100)); 424 425 ASSERT_NO_ERROR(fs::unlockFile(FD1)); 426 ProcessInfo WaitResult = llvm::sys::Wait(PI2, 5 /* seconds */, true, &Error); 427 ASSERT_TRUE(Error.empty()); 428 ASSERT_EQ(0, WaitResult.ReturnCode); 429 ASSERT_EQ(WaitResult.Pid, PI2.Pid); 430 sys::fs::remove(LockedFile); 431 } 432 433 TEST_F(ProgramEnvTest, TestExecuteWithNoStacktraceHandler) { 434 using namespace llvm::sys; 435 436 if (getenv("LLVM_PROGRAM_TEST_NO_STACKTRACE_HANDLER")) { 437 sys::PrintStackTrace(errs()); 438 exit(0); 439 } 440 441 std::string Executable = 442 sys::fs::getMainExecutable(TestMainArgv0, &ProgramTestStringArg1); 443 StringRef argv[] = { 444 Executable, 445 "--gtest_filter=ProgramEnvTest.TestExecuteWithNoStacktraceHandler"}; 446 447 addEnvVar("LLVM_PROGRAM_TEST_NO_STACKTRACE_HANDLER=1"); 448 449 std::string Error; 450 bool ExecutionFailed; 451 int RetCode = ExecuteAndWait(Executable, argv, getEnviron(), {}, 0, 0, &Error, 452 &ExecutionFailed); 453 EXPECT_FALSE(ExecutionFailed) << Error; 454 ASSERT_EQ(0, RetCode); 455 } 456 457 } // end anonymous namespace 458