1//===- Win32/Process.cpp - Win32 Process Implementation ------- -*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file provides the Win32 specific implementation of the Process class.
11//
12//===----------------------------------------------------------------------===//
13
14#include "llvm/Support/Allocator.h"
15#include "llvm/Support/ErrorHandling.h"
16#include "llvm/Support/WindowsError.h"
17#include <malloc.h>
18
19// The Windows.h header must be after LLVM and standard headers.
20#include "WindowsSupport.h"
21
22#include <direct.h>
23#include <io.h>
24#include <psapi.h>
25#include <shellapi.h>
26
27#ifdef __MINGW32__
28 #if (HAVE_LIBPSAPI != 1)
29  #error "libpsapi.a should be present"
30 #endif
31 #if (HAVE_LIBSHELL32 != 1)
32  #error "libshell32.a should be present"
33 #endif
34#else
35 #pragma comment(lib, "psapi.lib")
36 #pragma comment(lib, "shell32.lib")
37#endif
38
39//===----------------------------------------------------------------------===//
40//=== WARNING: Implementation here must contain only Win32 specific code
41//===          and must not be UNIX code
42//===----------------------------------------------------------------------===//
43
44#ifdef __MINGW32__
45// This ban should be lifted when MinGW 1.0+ has defined this value.
46#  define _HEAPOK (-2)
47#endif
48
49using namespace llvm;
50using namespace sys;
51
52static TimeValue getTimeValueFromFILETIME(FILETIME Time) {
53  ULARGE_INTEGER TimeInteger;
54  TimeInteger.LowPart = Time.dwLowDateTime;
55  TimeInteger.HighPart = Time.dwHighDateTime;
56
57  // FILETIME's are # of 100 nanosecond ticks (1/10th of a microsecond)
58  return TimeValue(
59      static_cast<TimeValue::SecondsType>(TimeInteger.QuadPart / 10000000),
60      static_cast<TimeValue::NanoSecondsType>(
61          (TimeInteger.QuadPart % 10000000) * 100));
62}
63
64// This function retrieves the page size using GetNativeSystemInfo() and is
65// present solely so it can be called once to initialize the self_process member
66// below.
67static unsigned computePageSize() {
68  // GetNativeSystemInfo() provides the physical page size which may differ
69  // from GetSystemInfo() in 32-bit applications running under WOW64.
70  SYSTEM_INFO info;
71  GetNativeSystemInfo(&info);
72  // FIXME: FileOffset in MapViewOfFile() should be aligned to not dwPageSize,
73  // but dwAllocationGranularity.
74  return static_cast<unsigned>(info.dwPageSize);
75}
76
77unsigned Process::getPageSize() {
78  static unsigned Ret = computePageSize();
79  return Ret;
80}
81
82size_t
83Process::GetMallocUsage()
84{
85  _HEAPINFO hinfo;
86  hinfo._pentry = NULL;
87
88  size_t size = 0;
89
90  while (_heapwalk(&hinfo) == _HEAPOK)
91    size += hinfo._size;
92
93  return size;
94}
95
96void Process::GetTimeUsage(TimeValue &elapsed, TimeValue &user_time,
97                           TimeValue &sys_time) {
98  elapsed = TimeValue::now();
99
100  FILETIME ProcCreate, ProcExit, KernelTime, UserTime;
101  if (GetProcessTimes(GetCurrentProcess(), &ProcCreate, &ProcExit, &KernelTime,
102                      &UserTime) == 0)
103    return;
104
105  user_time = getTimeValueFromFILETIME(UserTime);
106  sys_time = getTimeValueFromFILETIME(KernelTime);
107}
108
109// Some LLVM programs such as bugpoint produce core files as a normal part of
110// their operation. To prevent the disk from filling up, this configuration
111// item does what's necessary to prevent their generation.
112void Process::PreventCoreFiles() {
113  // Windows does have the concept of core files, called minidumps.  However,
114  // disabling minidumps for a particular application extends past the lifetime
115  // of that application, which is the incorrect behavior for this API.
116  // Additionally, the APIs require elevated privileges to disable and re-
117  // enable minidumps, which makes this untenable. For more information, see
118  // WerAddExcludedApplication and WerRemoveExcludedApplication (Vista and
119  // later).
120  //
121  // Windows also has modal pop-up message boxes.  As this method is used by
122  // bugpoint, preventing these pop-ups is additionally important.
123  SetErrorMode(SEM_FAILCRITICALERRORS |
124               SEM_NOGPFAULTERRORBOX |
125               SEM_NOOPENFILEERRORBOX);
126
127  coreFilesPrevented = true;
128}
129
130/// Returns the environment variable \arg Name's value as a string encoded in
131/// UTF-8. \arg Name is assumed to be in UTF-8 encoding.
132Optional<std::string> Process::GetEnv(StringRef Name) {
133  // Convert the argument to UTF-16 to pass it to _wgetenv().
134  SmallVector<wchar_t, 128> NameUTF16;
135  if (windows::UTF8ToUTF16(Name, NameUTF16))
136    return None;
137
138  // Environment variable can be encoded in non-UTF8 encoding, and there's no
139  // way to know what the encoding is. The only reliable way to look up
140  // multibyte environment variable is to use GetEnvironmentVariableW().
141  SmallVector<wchar_t, MAX_PATH> Buf;
142  size_t Size = MAX_PATH;
143  do {
144    Buf.reserve(Size);
145    Size =
146        GetEnvironmentVariableW(NameUTF16.data(), Buf.data(), Buf.capacity());
147    if (Size == 0)
148      return None;
149
150    // Try again with larger buffer.
151  } while (Size > Buf.capacity());
152  Buf.set_size(Size);
153
154  // Convert the result from UTF-16 to UTF-8.
155  SmallVector<char, MAX_PATH> Res;
156  if (windows::UTF16ToUTF8(Buf.data(), Size, Res))
157    return None;
158  return std::string(Res.data());
159}
160
161static void AllocateAndPush(const SmallVectorImpl<char> &S,
162                            SmallVectorImpl<const char *> &Vector,
163                            SpecificBumpPtrAllocator<char> &Allocator) {
164  char *Buffer = Allocator.Allocate(S.size() + 1);
165  ::memcpy(Buffer, S.data(), S.size());
166  Buffer[S.size()] = '\0';
167  Vector.push_back(Buffer);
168}
169
170/// Convert Arg from UTF-16 to UTF-8 and push it onto Args.
171static std::error_code
172ConvertAndPushArg(const wchar_t *Arg, SmallVectorImpl<const char *> &Args,
173                  SpecificBumpPtrAllocator<char> &Allocator) {
174  SmallVector<char, MAX_PATH> ArgString;
175  if (std::error_code ec = windows::UTF16ToUTF8(Arg, wcslen(Arg), ArgString))
176    return ec;
177  AllocateAndPush(ArgString, Args, Allocator);
178  return std::error_code();
179}
180
181/// \brief Perform wildcard expansion of Arg, or just push it into Args if it
182/// doesn't have wildcards or doesn't match any files.
183static std::error_code
184WildcardExpand(const wchar_t *Arg, SmallVectorImpl<const char *> &Args,
185               SpecificBumpPtrAllocator<char> &Allocator) {
186  if (!wcspbrk(Arg, L"*?")) {
187    // Arg does not contain any wildcard characters. This is the common case.
188    return ConvertAndPushArg(Arg, Args, Allocator);
189  }
190
191  if (wcscmp(Arg, L"/?") == 0 || wcscmp(Arg, L"-?") == 0) {
192    // Don't wildcard expand /?. Always treat it as an option.
193    return ConvertAndPushArg(Arg, Args, Allocator);
194  }
195
196  // Extract any directory part of the argument.
197  SmallVector<char, MAX_PATH> Dir;
198  if (std::error_code ec = windows::UTF16ToUTF8(Arg, wcslen(Arg), Dir))
199    return ec;
200  sys::path::remove_filename(Dir);
201  const int DirSize = Dir.size();
202
203  // Search for matching files.
204  WIN32_FIND_DATAW FileData;
205  HANDLE FindHandle = FindFirstFileW(Arg, &FileData);
206  if (FindHandle == INVALID_HANDLE_VALUE) {
207    return ConvertAndPushArg(Arg, Args, Allocator);
208  }
209
210  std::error_code ec;
211  do {
212    SmallVector<char, MAX_PATH> FileName;
213    ec = windows::UTF16ToUTF8(FileData.cFileName, wcslen(FileData.cFileName),
214                              FileName);
215    if (ec)
216      break;
217
218    // Push the filename onto Dir, and remove it afterwards.
219    llvm::sys::path::append(Dir, StringRef(FileName.data(), FileName.size()));
220    AllocateAndPush(Dir, Args, Allocator);
221    Dir.resize(DirSize);
222  } while (FindNextFileW(FindHandle, &FileData));
223
224  FindClose(FindHandle);
225  return ec;
226}
227
228std::error_code
229Process::GetArgumentVector(SmallVectorImpl<const char *> &Args,
230                           ArrayRef<const char *>,
231                           SpecificBumpPtrAllocator<char> &ArgAllocator) {
232  int ArgCount;
233  wchar_t **UnicodeCommandLine =
234      CommandLineToArgvW(GetCommandLineW(), &ArgCount);
235  if (!UnicodeCommandLine)
236    return mapWindowsError(::GetLastError());
237
238  Args.reserve(ArgCount);
239  std::error_code ec;
240
241  for (int i = 0; i < ArgCount; ++i) {
242    ec = WildcardExpand(UnicodeCommandLine[i], Args, ArgAllocator);
243    if (ec)
244      break;
245  }
246
247  LocalFree(UnicodeCommandLine);
248  return ec;
249}
250
251std::error_code Process::FixupStandardFileDescriptors() {
252  return std::error_code();
253}
254
255std::error_code Process::SafelyCloseFileDescriptor(int FD) {
256  if (::close(FD) < 0)
257    return std::error_code(errno, std::generic_category());
258  return std::error_code();
259}
260
261bool Process::StandardInIsUserInput() {
262  return FileDescriptorIsDisplayed(0);
263}
264
265bool Process::StandardOutIsDisplayed() {
266  return FileDescriptorIsDisplayed(1);
267}
268
269bool Process::StandardErrIsDisplayed() {
270  return FileDescriptorIsDisplayed(2);
271}
272
273bool Process::FileDescriptorIsDisplayed(int fd) {
274  DWORD Mode;  // Unused
275  return (GetConsoleMode((HANDLE)_get_osfhandle(fd), &Mode) != 0);
276}
277
278unsigned Process::StandardOutColumns() {
279  unsigned Columns = 0;
280  CONSOLE_SCREEN_BUFFER_INFO csbi;
281  if (GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &csbi))
282    Columns = csbi.dwSize.X;
283  return Columns;
284}
285
286unsigned Process::StandardErrColumns() {
287  unsigned Columns = 0;
288  CONSOLE_SCREEN_BUFFER_INFO csbi;
289  if (GetConsoleScreenBufferInfo(GetStdHandle(STD_ERROR_HANDLE), &csbi))
290    Columns = csbi.dwSize.X;
291  return Columns;
292}
293
294// The terminal always has colors.
295bool Process::FileDescriptorHasColors(int fd) {
296  return FileDescriptorIsDisplayed(fd);
297}
298
299bool Process::StandardOutHasColors() {
300  return FileDescriptorHasColors(1);
301}
302
303bool Process::StandardErrHasColors() {
304  return FileDescriptorHasColors(2);
305}
306
307static bool UseANSI = false;
308void Process::UseANSIEscapeCodes(bool enable) {
309  UseANSI = enable;
310}
311
312namespace {
313class DefaultColors
314{
315  private:
316    WORD defaultColor;
317  public:
318    DefaultColors()
319     :defaultColor(GetCurrentColor()) {}
320    static unsigned GetCurrentColor() {
321      CONSOLE_SCREEN_BUFFER_INFO csbi;
322      if (GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &csbi))
323        return csbi.wAttributes;
324      return 0;
325    }
326    WORD operator()() const { return defaultColor; }
327};
328
329DefaultColors defaultColors;
330
331WORD fg_color(WORD color) {
332  return color & (FOREGROUND_BLUE | FOREGROUND_GREEN |
333                  FOREGROUND_INTENSITY | FOREGROUND_RED);
334}
335
336WORD bg_color(WORD color) {
337  return color & (BACKGROUND_BLUE | BACKGROUND_GREEN |
338                  BACKGROUND_INTENSITY | BACKGROUND_RED);
339}
340}
341
342bool Process::ColorNeedsFlush() {
343  return !UseANSI;
344}
345
346const char *Process::OutputBold(bool bg) {
347  if (UseANSI) return "\033[1m";
348
349  WORD colors = DefaultColors::GetCurrentColor();
350  if (bg)
351    colors |= BACKGROUND_INTENSITY;
352  else
353    colors |= FOREGROUND_INTENSITY;
354  SetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE), colors);
355  return 0;
356}
357
358const char *Process::OutputColor(char code, bool bold, bool bg) {
359  if (UseANSI) return colorcodes[bg?1:0][bold?1:0][code&7];
360
361  WORD current = DefaultColors::GetCurrentColor();
362  WORD colors;
363  if (bg) {
364    colors = ((code&1) ? BACKGROUND_RED : 0) |
365      ((code&2) ? BACKGROUND_GREEN : 0 ) |
366      ((code&4) ? BACKGROUND_BLUE : 0);
367    if (bold)
368      colors |= BACKGROUND_INTENSITY;
369    colors |= fg_color(current);
370  } else {
371    colors = ((code&1) ? FOREGROUND_RED : 0) |
372      ((code&2) ? FOREGROUND_GREEN : 0 ) |
373      ((code&4) ? FOREGROUND_BLUE : 0);
374    if (bold)
375      colors |= FOREGROUND_INTENSITY;
376    colors |= bg_color(current);
377  }
378  SetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE), colors);
379  return 0;
380}
381
382static WORD GetConsoleTextAttribute(HANDLE hConsoleOutput) {
383  CONSOLE_SCREEN_BUFFER_INFO info;
384  GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &info);
385  return info.wAttributes;
386}
387
388const char *Process::OutputReverse() {
389  if (UseANSI) return "\033[7m";
390
391  const WORD attributes
392   = GetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE));
393
394  const WORD foreground_mask = FOREGROUND_BLUE | FOREGROUND_GREEN |
395    FOREGROUND_RED | FOREGROUND_INTENSITY;
396  const WORD background_mask = BACKGROUND_BLUE | BACKGROUND_GREEN |
397    BACKGROUND_RED | BACKGROUND_INTENSITY;
398  const WORD color_mask = foreground_mask | background_mask;
399
400  WORD new_attributes =
401    ((attributes & FOREGROUND_BLUE     )?BACKGROUND_BLUE     :0) |
402    ((attributes & FOREGROUND_GREEN    )?BACKGROUND_GREEN    :0) |
403    ((attributes & FOREGROUND_RED      )?BACKGROUND_RED      :0) |
404    ((attributes & FOREGROUND_INTENSITY)?BACKGROUND_INTENSITY:0) |
405    ((attributes & BACKGROUND_BLUE     )?FOREGROUND_BLUE     :0) |
406    ((attributes & BACKGROUND_GREEN    )?FOREGROUND_GREEN    :0) |
407    ((attributes & BACKGROUND_RED      )?FOREGROUND_RED      :0) |
408    ((attributes & BACKGROUND_INTENSITY)?FOREGROUND_INTENSITY:0) |
409    0;
410  new_attributes = (attributes & ~color_mask) | (new_attributes & color_mask);
411
412  SetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE), new_attributes);
413  return 0;
414}
415
416const char *Process::ResetColor() {
417  if (UseANSI) return "\033[0m";
418  SetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE), defaultColors());
419  return 0;
420}
421
422// Include GetLastError() in a fatal error message.
423static void ReportLastErrorFatal(const char *Msg) {
424  std::string ErrMsg;
425  MakeErrMsg(&ErrMsg, Msg);
426  report_fatal_error(ErrMsg);
427}
428
429unsigned Process::GetRandomNumber() {
430  HCRYPTPROV HCPC;
431  if (!::CryptAcquireContextW(&HCPC, NULL, NULL, PROV_RSA_FULL,
432                              CRYPT_VERIFYCONTEXT))
433    ReportLastErrorFatal("Could not acquire a cryptographic context");
434
435  ScopedCryptContext CryptoProvider(HCPC);
436  unsigned Ret;
437  if (!::CryptGenRandom(CryptoProvider, sizeof(Ret),
438                        reinterpret_cast<BYTE *>(&Ret)))
439    ReportLastErrorFatal("Could not generate a random number");
440  return Ret;
441}
442