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