1//===- Win32/Process.cpp - Win32 Process Implementation ------- -*- C++ -*-===// 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// This file provides the Win32 specific implementation of the Process class. 10// 11//===----------------------------------------------------------------------===// 12 13#include "llvm/Support/Allocator.h" 14#include "llvm/Support/CommandLine.h" 15#include "llvm/Support/ConvertUTF.h" 16#include "llvm/Support/ErrorHandling.h" 17#include "llvm/Support/StringSaver.h" 18#include "llvm/Support/WindowsError.h" 19#include <malloc.h> 20 21// The Windows.h header must be after LLVM and standard headers. 22#include "llvm/Support/Windows/WindowsSupport.h" 23 24#include <direct.h> 25#include <io.h> 26#include <psapi.h> 27#include <shellapi.h> 28 29#if !defined(__MINGW32__) 30 #pragma comment(lib, "psapi.lib") 31 #pragma comment(lib, "shell32.lib") 32#endif 33 34//===----------------------------------------------------------------------===// 35//=== WARNING: Implementation here must contain only Win32 specific code 36//=== and must not be UNIX code 37//===----------------------------------------------------------------------===// 38 39#ifdef __MINGW32__ 40// This ban should be lifted when MinGW 1.0+ has defined this value. 41# define _HEAPOK (-2) 42#endif 43 44using namespace llvm; 45 46Process::Pid Process::getProcessId() { 47 static_assert(sizeof(Pid) >= sizeof(DWORD), 48 "Process::Pid should be big enough to store DWORD"); 49 return Pid(::GetCurrentProcessId()); 50} 51 52// This function retrieves the page size using GetNativeSystemInfo() and is 53// present solely so it can be called once to initialize the self_process member 54// below. 55static unsigned computePageSize() { 56 // GetNativeSystemInfo() provides the physical page size which may differ 57 // from GetSystemInfo() in 32-bit applications running under WOW64. 58 SYSTEM_INFO info; 59 GetNativeSystemInfo(&info); 60 // FIXME: FileOffset in MapViewOfFile() should be aligned to not dwPageSize, 61 // but dwAllocationGranularity. 62 return static_cast<unsigned>(info.dwPageSize); 63} 64 65Expected<unsigned> Process::getPageSize() { 66 static unsigned Ret = computePageSize(); 67 return Ret; 68} 69 70size_t 71Process::GetMallocUsage() 72{ 73 _HEAPINFO hinfo; 74 hinfo._pentry = NULL; 75 76 size_t size = 0; 77 78 while (_heapwalk(&hinfo) == _HEAPOK) 79 size += hinfo._size; 80 81 return size; 82} 83 84void Process::GetTimeUsage(TimePoint<> &elapsed, std::chrono::nanoseconds &user_time, 85 std::chrono::nanoseconds &sys_time) { 86 elapsed = std::chrono::system_clock::now();; 87 88 FILETIME ProcCreate, ProcExit, KernelTime, UserTime; 89 if (GetProcessTimes(GetCurrentProcess(), &ProcCreate, &ProcExit, &KernelTime, 90 &UserTime) == 0) 91 return; 92 93 user_time = toDuration(UserTime); 94 sys_time = toDuration(KernelTime); 95} 96 97// Some LLVM programs such as bugpoint produce core files as a normal part of 98// their operation. To prevent the disk from filling up, this configuration 99// item does what's necessary to prevent their generation. 100void Process::PreventCoreFiles() { 101 // Windows does have the concept of core files, called minidumps. However, 102 // disabling minidumps for a particular application extends past the lifetime 103 // of that application, which is the incorrect behavior for this API. 104 // Additionally, the APIs require elevated privileges to disable and re- 105 // enable minidumps, which makes this untenable. For more information, see 106 // WerAddExcludedApplication and WerRemoveExcludedApplication (Vista and 107 // later). 108 // 109 // Windows also has modal pop-up message boxes. As this method is used by 110 // bugpoint, preventing these pop-ups is additionally important. 111 SetErrorMode(SEM_FAILCRITICALERRORS | 112 SEM_NOGPFAULTERRORBOX | 113 SEM_NOOPENFILEERRORBOX); 114 115 coreFilesPrevented = true; 116} 117 118/// Returns the environment variable \arg Name's value as a string encoded in 119/// UTF-8. \arg Name is assumed to be in UTF-8 encoding. 120Optional<std::string> Process::GetEnv(StringRef Name) { 121 // Convert the argument to UTF-16 to pass it to _wgetenv(). 122 SmallVector<wchar_t, 128> NameUTF16; 123 if (windows::UTF8ToUTF16(Name, NameUTF16)) 124 return None; 125 126 // Environment variable can be encoded in non-UTF8 encoding, and there's no 127 // way to know what the encoding is. The only reliable way to look up 128 // multibyte environment variable is to use GetEnvironmentVariableW(). 129 SmallVector<wchar_t, MAX_PATH> Buf; 130 size_t Size = MAX_PATH; 131 do { 132 Buf.reserve(Size); 133 SetLastError(NO_ERROR); 134 Size = 135 GetEnvironmentVariableW(NameUTF16.data(), Buf.data(), Buf.capacity()); 136 if (Size == 0 && GetLastError() == ERROR_ENVVAR_NOT_FOUND) 137 return None; 138 139 // Try again with larger buffer. 140 } while (Size > Buf.capacity()); 141 Buf.set_size(Size); 142 143 // Convert the result from UTF-16 to UTF-8. 144 SmallVector<char, MAX_PATH> Res; 145 if (windows::UTF16ToUTF8(Buf.data(), Size, Res)) 146 return None; 147 return std::string(Res.data()); 148} 149 150/// Perform wildcard expansion of Arg, or just push it into Args if it doesn't 151/// have wildcards or doesn't match any files. 152static std::error_code WildcardExpand(StringRef Arg, 153 SmallVectorImpl<const char *> &Args, 154 StringSaver &Saver) { 155 std::error_code EC; 156 157 // Don't expand Arg if it does not contain any wildcard characters. This is 158 // the common case. Also don't wildcard expand /?. Always treat it as an 159 // option. 160 if (Arg.find_first_of("*?") == StringRef::npos || Arg == "/?" || 161 Arg == "-?") { 162 Args.push_back(Arg.data()); 163 return EC; 164 } 165 166 // Convert back to UTF-16 so we can call FindFirstFileW. 167 SmallVector<wchar_t, MAX_PATH> ArgW; 168 EC = windows::UTF8ToUTF16(Arg, ArgW); 169 if (EC) 170 return EC; 171 172 // Search for matching files. 173 // FIXME: This assumes the wildcard is only in the file name and not in the 174 // directory portion of the file path. For example, it doesn't handle 175 // "*\foo.c" nor "s?c\bar.cpp". 176 WIN32_FIND_DATAW FileData; 177 HANDLE FindHandle = FindFirstFileW(ArgW.data(), &FileData); 178 if (FindHandle == INVALID_HANDLE_VALUE) { 179 Args.push_back(Arg.data()); 180 return EC; 181 } 182 183 // Extract any directory part of the argument. 184 SmallString<MAX_PATH> Dir = Arg; 185 sys::path::remove_filename(Dir); 186 const int DirSize = Dir.size(); 187 188 do { 189 SmallString<MAX_PATH> FileName; 190 EC = windows::UTF16ToUTF8(FileData.cFileName, wcslen(FileData.cFileName), 191 FileName); 192 if (EC) 193 break; 194 195 // Append FileName to Dir, and remove it afterwards. 196 llvm::sys::path::append(Dir, FileName); 197 Args.push_back(Saver.save(StringRef(Dir)).data()); 198 Dir.resize(DirSize); 199 } while (FindNextFileW(FindHandle, &FileData)); 200 201 FindClose(FindHandle); 202 return EC; 203} 204 205static std::error_code GetExecutableName(SmallVectorImpl<char> &Filename) { 206 // The first argument may contain just the name of the executable (e.g., 207 // "clang") rather than the full path, so swap it with the full path. 208 wchar_t ModuleName[MAX_PATH]; 209 size_t Length = ::GetModuleFileNameW(NULL, ModuleName, MAX_PATH); 210 if (Length == 0 || Length == MAX_PATH) { 211 return mapWindowsError(GetLastError()); 212 } 213 214 // If the first argument is a shortened (8.3) name (which is possible even 215 // if we got the module name), the driver will have trouble distinguishing it 216 // (e.g., clang.exe v. clang++.exe), so expand it now. 217 Length = GetLongPathNameW(ModuleName, ModuleName, MAX_PATH); 218 if (Length == 0) 219 return mapWindowsError(GetLastError()); 220 if (Length > MAX_PATH) { 221 // We're not going to try to deal with paths longer than MAX_PATH, so we'll 222 // treat this as an error. GetLastError() returns ERROR_SUCCESS, which 223 // isn't useful, so we'll hardcode an appropriate error value. 224 return mapWindowsError(ERROR_INSUFFICIENT_BUFFER); 225 } 226 227 std::error_code EC = windows::UTF16ToUTF8(ModuleName, Length, Filename); 228 if (EC) 229 return EC; 230 231 StringRef Base = sys::path::filename(Filename.data()); 232 Filename.assign(Base.begin(), Base.end()); 233 return std::error_code(); 234} 235 236std::error_code 237windows::GetCommandLineArguments(SmallVectorImpl<const char *> &Args, 238 BumpPtrAllocator &Alloc) { 239 const wchar_t *CmdW = GetCommandLineW(); 240 assert(CmdW); 241 std::error_code EC; 242 SmallString<MAX_PATH> Cmd; 243 EC = windows::UTF16ToUTF8(CmdW, wcslen(CmdW), Cmd); 244 if (EC) 245 return EC; 246 247 SmallVector<const char *, 20> TmpArgs; 248 StringSaver Saver(Alloc); 249 cl::TokenizeWindowsCommandLine(Cmd, Saver, TmpArgs, /*MarkEOLs=*/false); 250 251 for (const char *Arg : TmpArgs) { 252 EC = WildcardExpand(Arg, Args, Saver); 253 if (EC) 254 return EC; 255 } 256 257 SmallVector<char, MAX_PATH> Arg0(Args[0], Args[0] + strlen(Args[0])); 258 SmallVector<char, MAX_PATH> Filename; 259 sys::path::remove_filename(Arg0); 260 EC = GetExecutableName(Filename); 261 if (EC) 262 return EC; 263 sys::path::append(Arg0, Filename); 264 Args[0] = Saver.save(Arg0).data(); 265 return std::error_code(); 266} 267 268std::error_code Process::FixupStandardFileDescriptors() { 269 return std::error_code(); 270} 271 272std::error_code Process::SafelyCloseFileDescriptor(int FD) { 273 if (::close(FD) < 0) 274 return std::error_code(errno, std::generic_category()); 275 return std::error_code(); 276} 277 278bool Process::StandardInIsUserInput() { 279 return FileDescriptorIsDisplayed(0); 280} 281 282bool Process::StandardOutIsDisplayed() { 283 return FileDescriptorIsDisplayed(1); 284} 285 286bool Process::StandardErrIsDisplayed() { 287 return FileDescriptorIsDisplayed(2); 288} 289 290bool Process::FileDescriptorIsDisplayed(int fd) { 291 DWORD Mode; // Unused 292 return (GetConsoleMode((HANDLE)_get_osfhandle(fd), &Mode) != 0); 293} 294 295unsigned Process::StandardOutColumns() { 296 unsigned Columns = 0; 297 CONSOLE_SCREEN_BUFFER_INFO csbi; 298 if (GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &csbi)) 299 Columns = csbi.dwSize.X; 300 return Columns; 301} 302 303unsigned Process::StandardErrColumns() { 304 unsigned Columns = 0; 305 CONSOLE_SCREEN_BUFFER_INFO csbi; 306 if (GetConsoleScreenBufferInfo(GetStdHandle(STD_ERROR_HANDLE), &csbi)) 307 Columns = csbi.dwSize.X; 308 return Columns; 309} 310 311// The terminal always has colors. 312bool Process::FileDescriptorHasColors(int fd) { 313 return FileDescriptorIsDisplayed(fd); 314} 315 316bool Process::StandardOutHasColors() { 317 return FileDescriptorHasColors(1); 318} 319 320bool Process::StandardErrHasColors() { 321 return FileDescriptorHasColors(2); 322} 323 324static bool UseANSI = false; 325void Process::UseANSIEscapeCodes(bool enable) { 326#if defined(ENABLE_VIRTUAL_TERMINAL_PROCESSING) 327 if (enable) { 328 HANDLE Console = GetStdHandle(STD_OUTPUT_HANDLE); 329 DWORD Mode; 330 GetConsoleMode(Console, &Mode); 331 Mode |= ENABLE_VIRTUAL_TERMINAL_PROCESSING; 332 SetConsoleMode(Console, Mode); 333 } 334#endif 335 UseANSI = enable; 336} 337 338namespace { 339class DefaultColors 340{ 341 private: 342 WORD defaultColor; 343 public: 344 DefaultColors() 345 :defaultColor(GetCurrentColor()) {} 346 static unsigned GetCurrentColor() { 347 CONSOLE_SCREEN_BUFFER_INFO csbi; 348 if (GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &csbi)) 349 return csbi.wAttributes; 350 return 0; 351 } 352 WORD operator()() const { return defaultColor; } 353}; 354 355DefaultColors defaultColors; 356 357WORD fg_color(WORD color) { 358 return color & (FOREGROUND_BLUE | FOREGROUND_GREEN | 359 FOREGROUND_INTENSITY | FOREGROUND_RED); 360} 361 362WORD bg_color(WORD color) { 363 return color & (BACKGROUND_BLUE | BACKGROUND_GREEN | 364 BACKGROUND_INTENSITY | BACKGROUND_RED); 365} 366} 367 368bool Process::ColorNeedsFlush() { 369 return !UseANSI; 370} 371 372const char *Process::OutputBold(bool bg) { 373 if (UseANSI) return "\033[1m"; 374 375 WORD colors = DefaultColors::GetCurrentColor(); 376 if (bg) 377 colors |= BACKGROUND_INTENSITY; 378 else 379 colors |= FOREGROUND_INTENSITY; 380 SetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE), colors); 381 return 0; 382} 383 384const char *Process::OutputColor(char code, bool bold, bool bg) { 385 if (UseANSI) return colorcodes[bg?1:0][bold?1:0][code&7]; 386 387 WORD current = DefaultColors::GetCurrentColor(); 388 WORD colors; 389 if (bg) { 390 colors = ((code&1) ? BACKGROUND_RED : 0) | 391 ((code&2) ? BACKGROUND_GREEN : 0 ) | 392 ((code&4) ? BACKGROUND_BLUE : 0); 393 if (bold) 394 colors |= BACKGROUND_INTENSITY; 395 colors |= fg_color(current); 396 } else { 397 colors = ((code&1) ? FOREGROUND_RED : 0) | 398 ((code&2) ? FOREGROUND_GREEN : 0 ) | 399 ((code&4) ? FOREGROUND_BLUE : 0); 400 if (bold) 401 colors |= FOREGROUND_INTENSITY; 402 colors |= bg_color(current); 403 } 404 SetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE), colors); 405 return 0; 406} 407 408static WORD GetConsoleTextAttribute(HANDLE hConsoleOutput) { 409 CONSOLE_SCREEN_BUFFER_INFO info; 410 GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &info); 411 return info.wAttributes; 412} 413 414const char *Process::OutputReverse() { 415 if (UseANSI) return "\033[7m"; 416 417 const WORD attributes 418 = GetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE)); 419 420 const WORD foreground_mask = FOREGROUND_BLUE | FOREGROUND_GREEN | 421 FOREGROUND_RED | FOREGROUND_INTENSITY; 422 const WORD background_mask = BACKGROUND_BLUE | BACKGROUND_GREEN | 423 BACKGROUND_RED | BACKGROUND_INTENSITY; 424 const WORD color_mask = foreground_mask | background_mask; 425 426 WORD new_attributes = 427 ((attributes & FOREGROUND_BLUE )?BACKGROUND_BLUE :0) | 428 ((attributes & FOREGROUND_GREEN )?BACKGROUND_GREEN :0) | 429 ((attributes & FOREGROUND_RED )?BACKGROUND_RED :0) | 430 ((attributes & FOREGROUND_INTENSITY)?BACKGROUND_INTENSITY:0) | 431 ((attributes & BACKGROUND_BLUE )?FOREGROUND_BLUE :0) | 432 ((attributes & BACKGROUND_GREEN )?FOREGROUND_GREEN :0) | 433 ((attributes & BACKGROUND_RED )?FOREGROUND_RED :0) | 434 ((attributes & BACKGROUND_INTENSITY)?FOREGROUND_INTENSITY:0) | 435 0; 436 new_attributes = (attributes & ~color_mask) | (new_attributes & color_mask); 437 438 SetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE), new_attributes); 439 return 0; 440} 441 442const char *Process::ResetColor() { 443 if (UseANSI) return "\033[0m"; 444 SetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE), defaultColors()); 445 return 0; 446} 447 448static unsigned GetRandomNumberSeed() { 449 // Generate a random number seed from the millisecond-resolution Windows 450 // system clock and the current process id. 451 FILETIME Time; 452 GetSystemTimeAsFileTime(&Time); 453 DWORD Pid = GetCurrentProcessId(); 454 return hash_combine(Time.dwHighDateTime, Time.dwLowDateTime, Pid); 455} 456 457static unsigned GetPseudoRandomNumber() { 458 // Arrange to call srand once when this function is first used, and 459 // otherwise (if GetRandomNumber always succeeds in using 460 // CryptGenRandom) don't bother at all. 461 static int x = (static_cast<void>(::srand(GetRandomNumberSeed())), 0); 462 (void)x; 463 return ::rand(); 464} 465 466unsigned Process::GetRandomNumber() { 467 // Try to use CryptGenRandom. 468 HCRYPTPROV HCPC; 469 if (::CryptAcquireContextW(&HCPC, NULL, NULL, PROV_RSA_FULL, 470 CRYPT_VERIFYCONTEXT)) { 471 ScopedCryptContext CryptoProvider(HCPC); 472 unsigned Ret; 473 if (::CryptGenRandom(CryptoProvider, sizeof(Ret), 474 reinterpret_cast<BYTE *>(&Ret))) 475 return Ret; 476 } 477 478 // If that fails, fall back to pseudo-random numbers. 479 return GetPseudoRandomNumber(); 480} 481 482typedef NTSTATUS(WINAPI* RtlGetVersionPtr)(PRTL_OSVERSIONINFOW); 483#define STATUS_SUCCESS ((NTSTATUS)0x00000000L) 484 485llvm::VersionTuple llvm::GetWindowsOSVersion() { 486 HMODULE hMod = ::GetModuleHandleW(L"ntdll.dll"); 487 if (hMod) { 488 auto getVer = (RtlGetVersionPtr)::GetProcAddress(hMod, "RtlGetVersion"); 489 if (getVer) { 490 RTL_OSVERSIONINFOEXW info{}; 491 info.dwOSVersionInfoSize = sizeof(info); 492 if (getVer((PRTL_OSVERSIONINFOW)&info) == STATUS_SUCCESS) { 493 return llvm::VersionTuple(info.dwMajorVersion, info.dwMinorVersion, 0, 494 info.dwBuildNumber); 495 } 496 } 497 } 498 return llvm::VersionTuple(0, 0, 0, 0); 499} 500 501bool llvm::RunningWindows8OrGreater() { 502 // Windows 8 is version 6.2, service pack 0. 503 return GetWindowsOSVersion() >= llvm::VersionTuple(6, 2, 0, 0); 504} 505