1 //===- Win32/Process.cpp - Win32 Process Implementation ------- -*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file provides the Win32 specific implementation of the Process class.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/Support/Allocator.h"
17 // The Windows.h header must be after LLVM and standard headers.
26 #if (HAVE_LIBPSAPI != 1)
27 #error "libpsapi.a should be present"
29 #if (HAVE_LIBSHELL32 != 1)
30 #error "libshell32.a should be present"
33 #pragma comment(lib, "psapi.lib")
34 #pragma comment(lib, "shell32.lib")
37 //===----------------------------------------------------------------------===//
38 //=== WARNING: Implementation here must contain only Win32 specific code
39 //=== and must not be UNIX code
40 //===----------------------------------------------------------------------===//
43 // This ban should be lifted when MinGW 1.0+ has defined this value.
51 process::id_type self_process::get_id() {
52 return GetCurrentProcessId();
55 static TimeValue getTimeValueFromFILETIME(FILETIME Time) {
56 ULARGE_INTEGER TimeInteger;
57 TimeInteger.LowPart = Time.dwLowDateTime;
58 TimeInteger.HighPart = Time.dwHighDateTime;
60 // FILETIME's are # of 100 nanosecond ticks (1/10th of a microsecond)
62 static_cast<TimeValue::SecondsType>(TimeInteger.QuadPart / 10000000),
63 static_cast<TimeValue::NanoSecondsType>(
64 (TimeInteger.QuadPart % 10000000) * 100));
67 TimeValue self_process::get_user_time() const {
68 FILETIME ProcCreate, ProcExit, KernelTime, UserTime;
69 if (GetProcessTimes(GetCurrentProcess(), &ProcCreate, &ProcExit, &KernelTime,
73 return getTimeValueFromFILETIME(UserTime);
76 TimeValue self_process::get_system_time() const {
77 FILETIME ProcCreate, ProcExit, KernelTime, UserTime;
78 if (GetProcessTimes(GetCurrentProcess(), &ProcCreate, &ProcExit, &KernelTime,
82 return getTimeValueFromFILETIME(KernelTime);
85 // This function retrieves the page size using GetSystemInfo and is present
86 // solely so it can be called once to initialize the self_process member below.
87 static unsigned getPageSize() {
88 // NOTE: A 32-bit application running under WOW64 is supposed to use
89 // GetNativeSystemInfo. However, this interface is not present prior
90 // to Windows XP so to use it requires dynamic linking. It is not clear
91 // how this affects the reported page size, if at all. One could argue
92 // that LLVM ought to run as 64-bits on a 64-bit system, anyway.
95 // FIXME: FileOffset in MapViewOfFile() should be aligned to not dwPageSize,
96 // but dwAllocationGranularity.
97 return static_cast<unsigned>(info.dwPageSize);
100 // This constructor guaranteed to be run exactly once on a single thread, and
101 // sets up various process invariants that can be queried cheaply from then on.
102 self_process::self_process() : PageSize(getPageSize()) {
107 Process::GetMallocUsage()
110 hinfo._pentry = NULL;
114 while (_heapwalk(&hinfo) == _HEAPOK)
120 void Process::GetTimeUsage(TimeValue &elapsed, TimeValue &user_time,
121 TimeValue &sys_time) {
122 elapsed = TimeValue::now();
124 FILETIME ProcCreate, ProcExit, KernelTime, UserTime;
125 if (GetProcessTimes(GetCurrentProcess(), &ProcCreate, &ProcExit, &KernelTime,
129 user_time = getTimeValueFromFILETIME(UserTime);
130 sys_time = getTimeValueFromFILETIME(KernelTime);
133 // Some LLVM programs such as bugpoint produce core files as a normal part of
134 // their operation. To prevent the disk from filling up, this configuration
135 // item does what's necessary to prevent their generation.
136 void Process::PreventCoreFiles() {
137 // Windows does have the concept of core files, called minidumps. However,
138 // disabling minidumps for a particular application extends past the lifetime
139 // of that application, which is the incorrect behavior for this API.
140 // Additionally, the APIs require elevated privileges to disable and re-
141 // enable minidumps, which makes this untenable. For more information, see
142 // WerAddExcludedApplication and WerRemoveExcludedApplication (Vista and
145 // Windows also has modal pop-up message boxes. As this method is used by
146 // bugpoint, preventing these pop-ups is additionally important.
147 SetErrorMode(SEM_FAILCRITICALERRORS |
148 SEM_NOGPFAULTERRORBOX |
149 SEM_NOOPENFILEERRORBOX);
152 /// Returns the environment variable \arg Name's value as a string encoded in
153 /// UTF-8. \arg Name is assumed to be in UTF-8 encoding.
154 Optional<std::string> Process::GetEnv(StringRef Name) {
155 // Convert the argument to UTF-16 to pass it to _wgetenv().
156 SmallVector<wchar_t, 128> NameUTF16;
157 if (error_code ec = windows::UTF8ToUTF16(Name, NameUTF16))
160 // Environment variable can be encoded in non-UTF8 encoding, and there's no
161 // way to know what the encoding is. The only reliable way to look up
162 // multibyte environment variable is to use GetEnvironmentVariableW().
163 SmallVector<wchar_t, MAX_PATH> Buf;
164 size_t Size = MAX_PATH;
168 GetEnvironmentVariableW(NameUTF16.data(), Buf.data(), Buf.capacity());
172 // Try again with larger buffer.
173 } while (Size > Buf.capacity());
176 // Convert the result from UTF-16 to UTF-8.
177 SmallVector<char, MAX_PATH> Res;
178 if (error_code ec = windows::UTF16ToUTF8(Buf.data(), Size, Res))
180 return std::string(Res.data());
184 Process::GetArgumentVector(SmallVectorImpl<const char *> &Args,
185 ArrayRef<const char *>,
186 SpecificBumpPtrAllocator<char> &ArgAllocator) {
190 wchar_t **UnicodeCommandLine = CommandLineToArgvW(GetCommandLineW(),
192 if (!UnicodeCommandLine)
193 return windows_error(::GetLastError());
195 Args.reserve(NewArgCount);
197 for (int i = 0; i < NewArgCount; ++i) {
198 SmallVector<char, MAX_PATH> NewArgString;
199 ec = windows::UTF16ToUTF8(UnicodeCommandLine[i],
200 wcslen(UnicodeCommandLine[i]),
205 char *Buffer = ArgAllocator.Allocate(NewArgString.size() + 1);
206 ::memcpy(Buffer, NewArgString.data(), NewArgString.size() + 1);
207 Args.push_back(Buffer);
209 LocalFree(UnicodeCommandLine);
213 return error_code::success();
216 bool Process::StandardInIsUserInput() {
217 return FileDescriptorIsDisplayed(0);
220 bool Process::StandardOutIsDisplayed() {
221 return FileDescriptorIsDisplayed(1);
224 bool Process::StandardErrIsDisplayed() {
225 return FileDescriptorIsDisplayed(2);
228 bool Process::FileDescriptorIsDisplayed(int fd) {
229 DWORD Mode; // Unused
230 return (GetConsoleMode((HANDLE)_get_osfhandle(fd), &Mode) != 0);
233 unsigned Process::StandardOutColumns() {
234 unsigned Columns = 0;
235 CONSOLE_SCREEN_BUFFER_INFO csbi;
236 if (GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &csbi))
237 Columns = csbi.dwSize.X;
241 unsigned Process::StandardErrColumns() {
242 unsigned Columns = 0;
243 CONSOLE_SCREEN_BUFFER_INFO csbi;
244 if (GetConsoleScreenBufferInfo(GetStdHandle(STD_ERROR_HANDLE), &csbi))
245 Columns = csbi.dwSize.X;
249 // The terminal always has colors.
250 bool Process::FileDescriptorHasColors(int fd) {
251 return FileDescriptorIsDisplayed(fd);
254 bool Process::StandardOutHasColors() {
255 return FileDescriptorHasColors(1);
258 bool Process::StandardErrHasColors() {
259 return FileDescriptorHasColors(2);
262 static bool UseANSI = false;
263 void Process::UseANSIEscapeCodes(bool enable) {
274 :defaultColor(GetCurrentColor()) {}
275 static unsigned GetCurrentColor() {
276 CONSOLE_SCREEN_BUFFER_INFO csbi;
277 if (GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &csbi))
278 return csbi.wAttributes;
281 WORD operator()() const { return defaultColor; }
284 DefaultColors defaultColors;
287 bool Process::ColorNeedsFlush() {
291 const char *Process::OutputBold(bool bg) {
292 if (UseANSI) return "\033[1m";
294 WORD colors = DefaultColors::GetCurrentColor();
296 colors |= BACKGROUND_INTENSITY;
298 colors |= FOREGROUND_INTENSITY;
299 SetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE), colors);
303 const char *Process::OutputColor(char code, bool bold, bool bg) {
304 if (UseANSI) return colorcodes[bg?1:0][bold?1:0][code&7];
308 colors = ((code&1) ? BACKGROUND_RED : 0) |
309 ((code&2) ? BACKGROUND_GREEN : 0 ) |
310 ((code&4) ? BACKGROUND_BLUE : 0);
312 colors |= BACKGROUND_INTENSITY;
314 colors = ((code&1) ? FOREGROUND_RED : 0) |
315 ((code&2) ? FOREGROUND_GREEN : 0 ) |
316 ((code&4) ? FOREGROUND_BLUE : 0);
318 colors |= FOREGROUND_INTENSITY;
320 SetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE), colors);
324 static WORD GetConsoleTextAttribute(HANDLE hConsoleOutput) {
325 CONSOLE_SCREEN_BUFFER_INFO info;
326 GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &info);
327 return info.wAttributes;
330 const char *Process::OutputReverse() {
331 if (UseANSI) return "\033[7m";
333 const WORD attributes
334 = GetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE));
336 const WORD foreground_mask = FOREGROUND_BLUE | FOREGROUND_GREEN |
337 FOREGROUND_RED | FOREGROUND_INTENSITY;
338 const WORD background_mask = BACKGROUND_BLUE | BACKGROUND_GREEN |
339 BACKGROUND_RED | BACKGROUND_INTENSITY;
340 const WORD color_mask = foreground_mask | background_mask;
342 WORD new_attributes =
343 ((attributes & FOREGROUND_BLUE )?BACKGROUND_BLUE :0) |
344 ((attributes & FOREGROUND_GREEN )?BACKGROUND_GREEN :0) |
345 ((attributes & FOREGROUND_RED )?BACKGROUND_RED :0) |
346 ((attributes & FOREGROUND_INTENSITY)?BACKGROUND_INTENSITY:0) |
347 ((attributes & BACKGROUND_BLUE )?FOREGROUND_BLUE :0) |
348 ((attributes & BACKGROUND_GREEN )?FOREGROUND_GREEN :0) |
349 ((attributes & BACKGROUND_RED )?FOREGROUND_RED :0) |
350 ((attributes & BACKGROUND_INTENSITY)?FOREGROUND_INTENSITY:0) |
352 new_attributes = (attributes & ~color_mask) | (new_attributes & color_mask);
354 SetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE), new_attributes);
358 const char *Process::ResetColor() {
359 if (UseANSI) return "\033[0m";
360 SetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE), defaultColors());
364 unsigned Process::GetRandomNumber() {
366 const errno_t ec = rand_s(&result);
367 assert(ec == 0 && "rand_s failed");