1 //===- Win32/Program.cpp - Win32 Program 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 Program class.
12 //===----------------------------------------------------------------------===//
14 #include "WindowsSupport.h"
15 #include "llvm/ADT/StringExtras.h"
16 #include "llvm/Support/ConvertUTF.h"
17 #include "llvm/Support/Errc.h"
18 #include "llvm/Support/FileSystem.h"
19 #include "llvm/Support/Path.h"
20 #include "llvm/Support/WindowsError.h"
21 #include "llvm/Support/raw_ostream.h"
27 //===----------------------------------------------------------------------===//
28 //=== WARNING: Implementation here must contain only Win32 specific code
29 //=== and must not be UNIX code
30 //===----------------------------------------------------------------------===//
34 ProcessInfo::ProcessInfo() : Process(0), Pid(0), ReturnCode(0) {}
36 ErrorOr<std::string> sys::findProgramByName(StringRef Name,
37 ArrayRef<StringRef> Paths) {
38 assert(!Name.empty() && "Must have a name!");
40 if (Name.find_first_of("/\\") != StringRef::npos)
41 return std::string(Name);
43 const wchar_t *Path = nullptr;
44 std::wstring PathStorage;
46 PathStorage.reserve(Paths.size() * MAX_PATH);
47 for (unsigned i = 0; i < Paths.size(); ++i) {
49 PathStorage.push_back(L';');
50 StringRef P = Paths[i];
51 SmallVector<wchar_t, MAX_PATH> TmpPath;
52 if (std::error_code EC = windows::UTF8ToUTF16(P, TmpPath))
54 PathStorage.append(TmpPath.begin(), TmpPath.end());
56 Path = PathStorage.c_str();
59 SmallVector<wchar_t, MAX_PATH> U16Name;
60 if (std::error_code EC = windows::UTF8ToUTF16(Name, U16Name))
63 SmallVector<StringRef, 12> PathExts;
64 PathExts.push_back("");
65 PathExts.push_back(".exe"); // FIXME: This must be in %PATHEXT%.
66 if (const char *PathExtEnv = std::getenv("PATHEXT"))
67 SplitString(PathExtEnv, PathExts, ";");
69 SmallVector<wchar_t, MAX_PATH> U16Result;
71 for (StringRef Ext : PathExts) {
72 SmallVector<wchar_t, MAX_PATH> U16Ext;
73 if (std::error_code EC = windows::UTF8ToUTF16(Ext, U16Ext))
77 U16Result.reserve(Len);
78 // Lets attach the extension manually. That is needed for files
79 // with a point in name like aaa.bbb. SearchPathW will not add extension
80 // from its argument to such files because it thinks they already had one.
81 SmallVector<wchar_t, MAX_PATH> U16NameExt;
82 if (std::error_code EC =
83 windows::UTF8ToUTF16(Twine(Name + Ext).str(), U16NameExt))
86 Len = ::SearchPathW(Path, c_str(U16NameExt), nullptr,
87 U16Result.capacity(), U16Result.data(), nullptr);
88 } while (Len > U16Result.capacity());
95 return mapWindowsError(::GetLastError());
97 U16Result.set_size(Len);
99 SmallVector<char, MAX_PATH> U8Result;
100 if (std::error_code EC =
101 windows::UTF16ToUTF8(U16Result.data(), U16Result.size(), U8Result))
104 return std::string(U8Result.begin(), U8Result.end());
107 static HANDLE RedirectIO(Optional<StringRef> Path, int fd,
108 std::string *ErrMsg) {
111 if (!DuplicateHandle(GetCurrentProcess(), (HANDLE)_get_osfhandle(fd),
112 GetCurrentProcess(), &h,
113 0, TRUE, DUPLICATE_SAME_ACCESS))
114 return INVALID_HANDLE_VALUE;
124 SECURITY_ATTRIBUTES sa;
125 sa.nLength = sizeof(sa);
126 sa.lpSecurityDescriptor = 0;
127 sa.bInheritHandle = TRUE;
129 SmallVector<wchar_t, 128> fnameUnicode;
131 // Don't play long-path tricks on "NUL".
132 if (windows::UTF8ToUTF16(fname, fnameUnicode))
133 return INVALID_HANDLE_VALUE;
135 if (path::widenPath(fname, fnameUnicode))
136 return INVALID_HANDLE_VALUE;
138 h = CreateFileW(fnameUnicode.data(), fd ? GENERIC_WRITE : GENERIC_READ,
139 FILE_SHARE_READ, &sa, fd == 0 ? OPEN_EXISTING : CREATE_ALWAYS,
140 FILE_ATTRIBUTE_NORMAL, NULL);
141 if (h == INVALID_HANDLE_VALUE) {
142 MakeErrMsg(ErrMsg, fname + ": Can't open file for " +
143 (fd ? "input" : "output"));
149 /// ArgNeedsQuotes - Check whether argument needs to be quoted when calling
151 static bool ArgNeedsQuotes(const char *Str) {
152 return Str[0] == '\0' || strpbrk(Str, "\t \"&\'()*<>\\`^|") != 0;
155 /// CountPrecedingBackslashes - Returns the number of backslashes preceding Cur
156 /// in the C string Start.
157 static unsigned int CountPrecedingBackslashes(const char *Start,
159 unsigned int Count = 0;
161 while (Cur >= Start && *Cur == '\\') {
168 /// EscapePrecedingEscapes - Append a backslash to Dst for every backslash
169 /// preceding Cur in the Start string. Assumes Dst has enough space.
170 static char *EscapePrecedingEscapes(char *Dst, const char *Start,
172 unsigned PrecedingEscapes = CountPrecedingBackslashes(Start, Cur);
173 while (PrecedingEscapes > 0) {
180 /// ArgLenWithQuotes - Check whether argument needs to be quoted when calling
181 /// CreateProcess and returns length of quoted arg with escaped quotes
182 static unsigned int ArgLenWithQuotes(const char *Str) {
183 const char *Start = Str;
184 bool Quoted = ArgNeedsQuotes(Str);
185 unsigned int len = Quoted ? 2 : 0;
187 while (*Str != '\0') {
189 // We need to add a backslash, but ensure that it isn't escaped.
190 unsigned PrecedingEscapes = CountPrecedingBackslashes(Start, Str);
191 len += PrecedingEscapes + 1;
193 // Note that we *don't* need to escape runs of backslashes that don't
194 // precede a double quote! See MSDN:
195 // http://msdn.microsoft.com/en-us/library/17w5ykft%28v=vs.85%29.aspx
202 // Make sure the closing quote doesn't get escaped by a trailing backslash.
203 unsigned PrecedingEscapes = CountPrecedingBackslashes(Start, Str);
204 len += PrecedingEscapes + 1;
212 static std::unique_ptr<char[]> flattenArgs(const char **Args) {
213 // First, determine the length of the command line.
215 for (unsigned i = 0; Args[i]; i++) {
216 len += ArgLenWithQuotes(Args[i]) + 1;
219 // Now build the command line.
220 std::unique_ptr<char[]> command(new char[len+1]);
221 char *p = command.get();
223 for (unsigned i = 0; Args[i]; i++) {
224 const char *arg = Args[i];
225 const char *start = arg;
227 bool needsQuoting = ArgNeedsQuotes(arg);
231 while (*arg != '\0') {
233 // Escape all preceding escapes (if any), and then escape the quote.
234 p = EscapePrecedingEscapes(p, start, arg);
242 // Make sure our quote doesn't get escaped by a trailing backslash.
243 p = EscapePrecedingEscapes(p, start, arg);
253 static bool Execute(ProcessInfo &PI, StringRef Program, const char **Args,
254 const char **Envp, ArrayRef<Optional<StringRef>> Redirects,
255 unsigned MemoryLimit, std::string *ErrMsg) {
256 if (!sys::fs::can_execute(Program)) {
258 *ErrMsg = "program not executable";
262 // can_execute may succeed by looking at Program + ".exe". CreateProcessW
263 // will implicitly add the .exe if we provide a command line without an
264 // executable path, but since we use an explicit executable, we have to add
266 SmallString<64> ProgramStorage;
267 if (!sys::fs::exists(Program))
268 Program = Twine(Program + ".exe").toStringRef(ProgramStorage);
270 // Windows wants a command line, not an array of args, to pass to the new
271 // process. We have to concatenate them all, while quoting the args that
272 // have embedded spaces (or are empty).
273 std::unique_ptr<char[]> command = flattenArgs(Args);
275 // The pointer to the environment block for the new process.
276 std::vector<wchar_t> EnvBlock;
279 // An environment block consists of a null-terminated block of
280 // null-terminated strings. Convert the array of environment variables to
281 // an environment block by concatenating them.
282 for (unsigned i = 0; Envp[i]; ++i) {
283 SmallVector<wchar_t, MAX_PATH> EnvString;
284 if (std::error_code ec = windows::UTF8ToUTF16(Envp[i], EnvString)) {
285 SetLastError(ec.value());
286 MakeErrMsg(ErrMsg, "Unable to convert environment variable to UTF-16");
290 EnvBlock.insert(EnvBlock.end(), EnvString.begin(), EnvString.end());
291 EnvBlock.push_back(0);
293 EnvBlock.push_back(0);
296 // Create a child process.
298 memset(&si, 0, sizeof(si));
300 si.hStdInput = INVALID_HANDLE_VALUE;
301 si.hStdOutput = INVALID_HANDLE_VALUE;
302 si.hStdError = INVALID_HANDLE_VALUE;
304 if (!Redirects.empty()) {
305 si.dwFlags = STARTF_USESTDHANDLES;
307 si.hStdInput = RedirectIO(Redirects[0], 0, ErrMsg);
308 if (si.hStdInput == INVALID_HANDLE_VALUE) {
309 MakeErrMsg(ErrMsg, "can't redirect stdin");
312 si.hStdOutput = RedirectIO(Redirects[1], 1, ErrMsg);
313 if (si.hStdOutput == INVALID_HANDLE_VALUE) {
314 CloseHandle(si.hStdInput);
315 MakeErrMsg(ErrMsg, "can't redirect stdout");
318 if (Redirects[1] && Redirects[2] && *Redirects[1] == *Redirects[2]) {
319 // If stdout and stderr should go to the same place, redirect stderr
320 // to the handle already open for stdout.
321 if (!DuplicateHandle(GetCurrentProcess(), si.hStdOutput,
322 GetCurrentProcess(), &si.hStdError,
323 0, TRUE, DUPLICATE_SAME_ACCESS)) {
324 CloseHandle(si.hStdInput);
325 CloseHandle(si.hStdOutput);
326 MakeErrMsg(ErrMsg, "can't dup stderr to stdout");
330 // Just redirect stderr
331 si.hStdError = RedirectIO(Redirects[2], 2, ErrMsg);
332 if (si.hStdError == INVALID_HANDLE_VALUE) {
333 CloseHandle(si.hStdInput);
334 CloseHandle(si.hStdOutput);
335 MakeErrMsg(ErrMsg, "can't redirect stderr");
341 PROCESS_INFORMATION pi;
342 memset(&pi, 0, sizeof(pi));
347 SmallVector<wchar_t, MAX_PATH> ProgramUtf16;
348 if (std::error_code ec = path::widenPath(Program, ProgramUtf16)) {
349 SetLastError(ec.value());
351 std::string("Unable to convert application name to UTF-16"));
355 SmallVector<wchar_t, MAX_PATH> CommandUtf16;
356 if (std::error_code ec = windows::UTF8ToUTF16(command.get(), CommandUtf16)) {
357 SetLastError(ec.value());
359 std::string("Unable to convert command-line to UTF-16"));
363 BOOL rc = CreateProcessW(ProgramUtf16.data(), CommandUtf16.data(), 0, 0,
364 TRUE, CREATE_UNICODE_ENVIRONMENT,
365 EnvBlock.empty() ? 0 : EnvBlock.data(), 0, &si,
367 DWORD err = GetLastError();
369 // Regardless of whether the process got created or not, we are done with
370 // the handles we created for it to inherit.
371 CloseHandle(si.hStdInput);
372 CloseHandle(si.hStdOutput);
373 CloseHandle(si.hStdError);
375 // Now return an error if the process didn't get created.
378 MakeErrMsg(ErrMsg, std::string("Couldn't execute program '") +
379 Program.str() + "'");
383 PI.Pid = pi.dwProcessId;
384 PI.Process = pi.hProcess;
386 // Make sure these get closed no matter what.
387 ScopedCommonHandle hThread(pi.hThread);
389 // Assign the process to a job if a memory limit is defined.
390 ScopedJobHandle hJob;
391 if (MemoryLimit != 0) {
392 hJob = CreateJobObjectW(0, 0);
393 bool success = false;
395 JOBOBJECT_EXTENDED_LIMIT_INFORMATION jeli;
396 memset(&jeli, 0, sizeof(jeli));
397 jeli.BasicLimitInformation.LimitFlags = JOB_OBJECT_LIMIT_PROCESS_MEMORY;
398 jeli.ProcessMemoryLimit = uintptr_t(MemoryLimit) * 1048576;
399 if (SetInformationJobObject(hJob, JobObjectExtendedLimitInformation,
400 &jeli, sizeof(jeli))) {
401 if (AssignProcessToJobObject(hJob, pi.hProcess))
406 SetLastError(GetLastError());
407 MakeErrMsg(ErrMsg, std::string("Unable to set memory limit"));
408 TerminateProcess(pi.hProcess, 1);
409 WaitForSingleObject(pi.hProcess, INFINITE);
418 ProcessInfo sys::Wait(const ProcessInfo &PI, unsigned SecondsToWait,
419 bool WaitUntilChildTerminates, std::string *ErrMsg) {
420 assert(PI.Pid && "invalid pid to wait on, process not started?");
421 assert((PI.Process && PI.Process != INVALID_HANDLE_VALUE) &&
422 "invalid process handle to wait on, process not started?");
423 DWORD milliSecondsToWait = 0;
424 if (WaitUntilChildTerminates)
425 milliSecondsToWait = INFINITE;
426 else if (SecondsToWait > 0)
427 milliSecondsToWait = SecondsToWait * 1000;
429 ProcessInfo WaitResult = PI;
430 DWORD WaitStatus = WaitForSingleObject(PI.Process, milliSecondsToWait);
431 if (WaitStatus == WAIT_TIMEOUT) {
433 if (!TerminateProcess(PI.Process, 1)) {
435 MakeErrMsg(ErrMsg, "Failed to terminate timed-out program");
437 // -2 indicates a crash or timeout as opposed to failure to execute.
438 WaitResult.ReturnCode = -2;
439 CloseHandle(PI.Process);
442 WaitForSingleObject(PI.Process, INFINITE);
443 CloseHandle(PI.Process);
445 // Non-blocking wait.
446 return ProcessInfo();
450 // Get its exit status.
452 BOOL rc = GetExitCodeProcess(PI.Process, &status);
453 DWORD err = GetLastError();
454 if (err != ERROR_INVALID_HANDLE)
455 CloseHandle(PI.Process);
460 MakeErrMsg(ErrMsg, "Failed getting status for program");
462 // -2 indicates a crash or timeout as opposed to failure to execute.
463 WaitResult.ReturnCode = -2;
470 // Pass 10(Warning) and 11(Error) to the callee as negative value.
471 if ((status & 0xBFFF0000U) == 0x80000000U)
472 WaitResult.ReturnCode = static_cast<int>(status);
473 else if (status & 0xFF)
474 WaitResult.ReturnCode = status & 0x7FFFFFFF;
476 WaitResult.ReturnCode = 1;
481 std::error_code sys::ChangeStdinToBinary() {
482 int result = _setmode(_fileno(stdin), _O_BINARY);
484 return std::error_code(errno, std::generic_category());
485 return std::error_code();
488 std::error_code sys::ChangeStdoutToBinary() {
489 int result = _setmode(_fileno(stdout), _O_BINARY);
491 return std::error_code(errno, std::generic_category());
492 return std::error_code();
496 llvm::sys::writeFileWithEncoding(StringRef FileName, StringRef Contents,
497 WindowsEncodingMethod Encoding) {
499 llvm::raw_fd_ostream OS(FileName, EC, llvm::sys::fs::F_Text);
503 if (Encoding == WEM_UTF8) {
505 } else if (Encoding == WEM_CurrentCodePage) {
506 SmallVector<wchar_t, 1> ArgsUTF16;
507 SmallVector<char, 1> ArgsCurCP;
509 if ((EC = windows::UTF8ToUTF16(Contents, ArgsUTF16)))
512 if ((EC = windows::UTF16ToCurCP(
513 ArgsUTF16.data(), ArgsUTF16.size(), ArgsCurCP)))
516 OS.write(ArgsCurCP.data(), ArgsCurCP.size());
517 } else if (Encoding == WEM_UTF16) {
518 SmallVector<wchar_t, 1> ArgsUTF16;
520 if ((EC = windows::UTF8ToUTF16(Contents, ArgsUTF16)))
523 // Endianness guessing
525 uint16_t src = UNI_UTF16_BYTE_ORDER_MARK_NATIVE;
526 memcpy(BOM, &src, 2);
528 OS.write((char *)ArgsUTF16.data(), ArgsUTF16.size() << 1);
530 llvm_unreachable("Unknown encoding");
534 return make_error_code(errc::io_error);
539 bool llvm::sys::commandLineFitsWithinSystemLimits(StringRef Program,
540 ArrayRef<const char *> Args) {
541 // The documented max length of the command line passed to CreateProcess.
542 static const size_t MaxCommandStringLength = 32768;
543 // Account for the trailing space for the program path and the
544 // trailing NULL of the last argument.
545 size_t ArgLength = ArgLenWithQuotes(Program.str().c_str()) + 2;
546 for (const char* Arg : Args) {
547 // Account for the trailing space for every arg
548 ArgLength += ArgLenWithQuotes(Arg) + 1;
549 if (ArgLength > MaxCommandStringLength) {