xref: /freebsd/contrib/llvm-project/llvm/lib/Support/Windows/Process.inc (revision 38a52bd3b5cac3da6f7f6eef3dd050e6aa08ebb3) 
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.resize_for_overwrite(Size);
133    SetLastError(NO_ERROR);
134    Size =
135      GetEnvironmentVariableW(NameUTF16.data(), Buf.data(), Buf.size());
136    if (Size == 0 && GetLastError() == ERROR_ENVVAR_NOT_FOUND)
137      return None;
138
139    // Try again with larger buffer.
140  } while (Size > Buf.size());
141  Buf.truncate(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(Dir.str()).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  // Make a copy of the filename since assign makes the StringRef invalid.
232  std::string Base = sys::path::filename(Filename.data()).str();
233  Filename.assign(Base.begin(), Base.end());
234  return std::error_code();
235}
236
237std::error_code
238windows::GetCommandLineArguments(SmallVectorImpl<const char *> &Args,
239                                 BumpPtrAllocator &Alloc) {
240  const wchar_t *CmdW = GetCommandLineW();
241  assert(CmdW);
242  std::error_code EC;
243  SmallString<MAX_PATH> Cmd;
244  EC = windows::UTF16ToUTF8(CmdW, wcslen(CmdW), Cmd);
245  if (EC)
246    return EC;
247
248  SmallVector<const char *, 20> TmpArgs;
249  StringSaver Saver(Alloc);
250  cl::TokenizeWindowsCommandLine(Cmd, Saver, TmpArgs, /*MarkEOLs=*/false);
251
252  for (const char *Arg : TmpArgs) {
253    EC = WildcardExpand(Arg, Args, Saver);
254    if (EC)
255      return EC;
256  }
257
258  SmallVector<char, MAX_PATH> Arg0(Args[0], Args[0] + strlen(Args[0]));
259  SmallVector<char, MAX_PATH> Filename;
260  sys::path::remove_filename(Arg0);
261  EC = GetExecutableName(Filename);
262  if (EC)
263    return EC;
264  sys::path::make_preferred(Arg0);
265  sys::path::append(Arg0, Filename);
266  Args[0] = Saver.save(Arg0).data();
267  return std::error_code();
268}
269
270std::error_code Process::FixupStandardFileDescriptors() {
271  return std::error_code();
272}
273
274std::error_code Process::SafelyCloseFileDescriptor(int FD) {
275  if (::close(FD) < 0)
276    return std::error_code(errno, std::generic_category());
277  return std::error_code();
278}
279
280bool Process::StandardInIsUserInput() {
281  return FileDescriptorIsDisplayed(0);
282}
283
284bool Process::StandardOutIsDisplayed() {
285  return FileDescriptorIsDisplayed(1);
286}
287
288bool Process::StandardErrIsDisplayed() {
289  return FileDescriptorIsDisplayed(2);
290}
291
292bool Process::FileDescriptorIsDisplayed(int fd) {
293  DWORD Mode;  // Unused
294  return (GetConsoleMode((HANDLE)_get_osfhandle(fd), &Mode) != 0);
295}
296
297unsigned Process::StandardOutColumns() {
298  unsigned Columns = 0;
299  CONSOLE_SCREEN_BUFFER_INFO csbi;
300  if (GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &csbi))
301    Columns = csbi.dwSize.X;
302  return Columns;
303}
304
305unsigned Process::StandardErrColumns() {
306  unsigned Columns = 0;
307  CONSOLE_SCREEN_BUFFER_INFO csbi;
308  if (GetConsoleScreenBufferInfo(GetStdHandle(STD_ERROR_HANDLE), &csbi))
309    Columns = csbi.dwSize.X;
310  return Columns;
311}
312
313// The terminal always has colors.
314bool Process::FileDescriptorHasColors(int fd) {
315  return FileDescriptorIsDisplayed(fd);
316}
317
318bool Process::StandardOutHasColors() {
319  return FileDescriptorHasColors(1);
320}
321
322bool Process::StandardErrHasColors() {
323  return FileDescriptorHasColors(2);
324}
325
326static bool UseANSI = false;
327void Process::UseANSIEscapeCodes(bool enable) {
328#if defined(ENABLE_VIRTUAL_TERMINAL_PROCESSING)
329  if (enable) {
330    HANDLE Console = GetStdHandle(STD_OUTPUT_HANDLE);
331    DWORD Mode;
332    GetConsoleMode(Console, &Mode);
333    Mode |= ENABLE_VIRTUAL_TERMINAL_PROCESSING;
334    SetConsoleMode(Console, Mode);
335  }
336#endif
337  UseANSI = enable;
338}
339
340namespace {
341class DefaultColors
342{
343  private:
344    WORD defaultColor;
345  public:
346    DefaultColors()
347     :defaultColor(GetCurrentColor()) {}
348    static unsigned GetCurrentColor() {
349      CONSOLE_SCREEN_BUFFER_INFO csbi;
350      if (GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &csbi))
351        return csbi.wAttributes;
352      return 0;
353    }
354    WORD operator()() const { return defaultColor; }
355};
356
357DefaultColors defaultColors;
358
359WORD fg_color(WORD color) {
360  return color & (FOREGROUND_BLUE | FOREGROUND_GREEN |
361                  FOREGROUND_INTENSITY | FOREGROUND_RED);
362}
363
364WORD bg_color(WORD color) {
365  return color & (BACKGROUND_BLUE | BACKGROUND_GREEN |
366                  BACKGROUND_INTENSITY | BACKGROUND_RED);
367}
368}
369
370bool Process::ColorNeedsFlush() {
371  return !UseANSI;
372}
373
374const char *Process::OutputBold(bool bg) {
375  if (UseANSI) return "\033[1m";
376
377  WORD colors = DefaultColors::GetCurrentColor();
378  if (bg)
379    colors |= BACKGROUND_INTENSITY;
380  else
381    colors |= FOREGROUND_INTENSITY;
382  SetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE), colors);
383  return 0;
384}
385
386const char *Process::OutputColor(char code, bool bold, bool bg) {
387  if (UseANSI) return colorcodes[bg?1:0][bold?1:0][code&7];
388
389  WORD current = DefaultColors::GetCurrentColor();
390  WORD colors;
391  if (bg) {
392    colors = ((code&1) ? BACKGROUND_RED : 0) |
393      ((code&2) ? BACKGROUND_GREEN : 0 ) |
394      ((code&4) ? BACKGROUND_BLUE : 0);
395    if (bold)
396      colors |= BACKGROUND_INTENSITY;
397    colors |= fg_color(current);
398  } else {
399    colors = ((code&1) ? FOREGROUND_RED : 0) |
400      ((code&2) ? FOREGROUND_GREEN : 0 ) |
401      ((code&4) ? FOREGROUND_BLUE : 0);
402    if (bold)
403      colors |= FOREGROUND_INTENSITY;
404    colors |= bg_color(current);
405  }
406  SetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE), colors);
407  return 0;
408}
409
410static WORD GetConsoleTextAttribute(HANDLE hConsoleOutput) {
411  CONSOLE_SCREEN_BUFFER_INFO info;
412  GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &info);
413  return info.wAttributes;
414}
415
416const char *Process::OutputReverse() {
417  if (UseANSI) return "\033[7m";
418
419  const WORD attributes
420   = GetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE));
421
422  const WORD foreground_mask = FOREGROUND_BLUE | FOREGROUND_GREEN |
423    FOREGROUND_RED | FOREGROUND_INTENSITY;
424  const WORD background_mask = BACKGROUND_BLUE | BACKGROUND_GREEN |
425    BACKGROUND_RED | BACKGROUND_INTENSITY;
426  const WORD color_mask = foreground_mask | background_mask;
427
428  WORD new_attributes =
429    ((attributes & FOREGROUND_BLUE     )?BACKGROUND_BLUE     :0) |
430    ((attributes & FOREGROUND_GREEN    )?BACKGROUND_GREEN    :0) |
431    ((attributes & FOREGROUND_RED      )?BACKGROUND_RED      :0) |
432    ((attributes & FOREGROUND_INTENSITY)?BACKGROUND_INTENSITY:0) |
433    ((attributes & BACKGROUND_BLUE     )?FOREGROUND_BLUE     :0) |
434    ((attributes & BACKGROUND_GREEN    )?FOREGROUND_GREEN    :0) |
435    ((attributes & BACKGROUND_RED      )?FOREGROUND_RED      :0) |
436    ((attributes & BACKGROUND_INTENSITY)?FOREGROUND_INTENSITY:0) |
437    0;
438  new_attributes = (attributes & ~color_mask) | (new_attributes & color_mask);
439
440  SetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE), new_attributes);
441  return 0;
442}
443
444const char *Process::ResetColor() {
445  if (UseANSI) return "\033[0m";
446  SetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE), defaultColors());
447  return 0;
448}
449
450static unsigned GetRandomNumberSeed() {
451  // Generate a random number seed from the millisecond-resolution Windows
452  // system clock and the current process id.
453  FILETIME Time;
454  GetSystemTimeAsFileTime(&Time);
455  DWORD Pid = GetCurrentProcessId();
456  return hash_combine(Time.dwHighDateTime, Time.dwLowDateTime, Pid);
457}
458
459static unsigned GetPseudoRandomNumber() {
460  // Arrange to call srand once when this function is first used, and
461  // otherwise (if GetRandomNumber always succeeds in using
462  // CryptGenRandom) don't bother at all.
463  static int x = (static_cast<void>(::srand(GetRandomNumberSeed())), 0);
464  (void)x;
465  return ::rand();
466}
467
468unsigned Process::GetRandomNumber() {
469  // Try to use CryptGenRandom.
470  HCRYPTPROV HCPC;
471  if (::CryptAcquireContextW(&HCPC, NULL, NULL, PROV_RSA_FULL,
472                             CRYPT_VERIFYCONTEXT)) {
473    ScopedCryptContext CryptoProvider(HCPC);
474    unsigned Ret;
475    if (::CryptGenRandom(CryptoProvider, sizeof(Ret),
476                         reinterpret_cast<BYTE *>(&Ret)))
477      return Ret;
478  }
479
480  // If that fails, fall back to pseudo-random numbers.
481  return GetPseudoRandomNumber();
482}
483
484typedef NTSTATUS(WINAPI* RtlGetVersionPtr)(PRTL_OSVERSIONINFOW);
485#define STATUS_SUCCESS ((NTSTATUS)0x00000000L)
486
487llvm::VersionTuple llvm::GetWindowsOSVersion() {
488  HMODULE hMod = ::GetModuleHandleW(L"ntdll.dll");
489  if (hMod) {
490    auto getVer = (RtlGetVersionPtr)::GetProcAddress(hMod, "RtlGetVersion");
491    if (getVer) {
492      RTL_OSVERSIONINFOEXW info{};
493      info.dwOSVersionInfoSize = sizeof(info);
494      if (getVer((PRTL_OSVERSIONINFOW)&info) == STATUS_SUCCESS) {
495        return llvm::VersionTuple(info.dwMajorVersion, info.dwMinorVersion, 0,
496                                  info.dwBuildNumber);
497      }
498    }
499  }
500  return llvm::VersionTuple(0, 0, 0, 0);
501}
502
503bool llvm::RunningWindows8OrGreater() {
504  // Windows 8 is version 6.2, service pack 0.
505  return GetWindowsOSVersion() >= llvm::VersionTuple(6, 2, 0, 0);
506}
507
508[[noreturn]] void Process::ExitNoCleanup(int RetCode) {
509  TerminateProcess(GetCurrentProcess(), RetCode);
510  llvm_unreachable("TerminateProcess doesn't return");
511}
512