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 //===----------------------------------------------------------------------===//
20 //===----------------------------------------------------------------------===//
21 //=== WARNING: Implementation here must contain only Win32 specific code
22 //=== and must not be UNIX code
23 //===----------------------------------------------------------------------===//
26 struct Win32ProcessInfo {
35 Program::Program() : Data_(0) {}
39 Win32ProcessInfo* wpi = reinterpret_cast<Win32ProcessInfo*>(Data_);
40 CloseHandle(wpi->hProcess);
46 // This function just uses the PATH environment variable to find the program.
48 Program::FindProgramByName(const std::string& progName) {
50 // Check some degenerate cases
51 if (progName.length() == 0) // no program
54 if (!temp.set(progName)) // invalid name
56 // Return paths with slashes verbatim.
57 if (progName.find('\\') != std::string::npos ||
58 progName.find('/') != std::string::npos)
61 // At this point, the file name is valid and does not contain slashes.
62 // Let Windows search for it.
63 char buffer[MAX_PATH];
65 DWORD len = SearchPath(NULL, progName.c_str(), ".exe", MAX_PATH,
68 // See if it wasn't found.
72 // See if we got the entire path.
76 // Buffer was too small; grow and retry.
78 char *b = reinterpret_cast<char *>(_alloca(len+1));
79 DWORD len2 = SearchPath(NULL, progName.c_str(), ".exe", len+1, b, &dummy);
81 // It is unlikely the search failed, but it's always possible some file
82 // was added or removed since the last search, so be paranoid...
92 static HANDLE RedirectIO(const Path *path, int fd, std::string* ErrMsg) {
95 DuplicateHandle(GetCurrentProcess(), (HANDLE)_get_osfhandle(fd),
96 GetCurrentProcess(), &h,
97 0, TRUE, DUPLICATE_SAME_ACCESS);
105 fname = path->c_str();
107 SECURITY_ATTRIBUTES sa;
108 sa.nLength = sizeof(sa);
109 sa.lpSecurityDescriptor = 0;
110 sa.bInheritHandle = TRUE;
112 h = CreateFile(fname, fd ? GENERIC_WRITE : GENERIC_READ, FILE_SHARE_READ,
113 &sa, fd == 0 ? OPEN_EXISTING : CREATE_ALWAYS,
114 FILE_ATTRIBUTE_NORMAL, NULL);
115 if (h == INVALID_HANDLE_VALUE) {
116 MakeErrMsg(ErrMsg, std::string(fname) + ": Can't open file for " +
117 (fd ? "input: " : "output: "));
123 /// ArgNeedsQuotes - Check whether argument needs to be quoted when calling
125 static bool ArgNeedsQuotes(const char *Str) {
126 return Str[0] == '\0' || strpbrk(Str, "\t \"&\'()*<>\\`^|") != 0;
129 /// CountPrecedingBackslashes - Returns the number of backslashes preceding Cur
130 /// in the C string Start.
131 static unsigned int CountPrecedingBackslashes(const char *Start,
133 unsigned int Count = 0;
135 while (Cur >= Start && *Cur == '\\') {
142 /// EscapePrecedingEscapes - Append a backslash to Dst for every backslash
143 /// preceding Cur in the Start string. Assumes Dst has enough space.
144 static char *EscapePrecedingEscapes(char *Dst, const char *Start,
146 unsigned PrecedingEscapes = CountPrecedingBackslashes(Start, Cur);
147 while (PrecedingEscapes > 0) {
154 /// ArgLenWithQuotes - Check whether argument needs to be quoted when calling
155 /// CreateProcess and returns length of quoted arg with escaped quotes
156 static unsigned int ArgLenWithQuotes(const char *Str) {
157 const char *Start = Str;
158 unsigned int len = ArgNeedsQuotes(Str) ? 2 : 0;
160 while (*Str != '\0') {
162 // We need to add a backslash, but ensure that it isn't escaped.
163 unsigned PrecedingEscapes = CountPrecedingBackslashes(Start, Str);
164 len += PrecedingEscapes + 1;
166 // Note that we *don't* need to escape runs of backslashes that don't
167 // precede a double quote! See MSDN:
168 // http://msdn.microsoft.com/en-us/library/17w5ykft%28v=vs.85%29.aspx
179 Program::Execute(const Path& path,
182 const Path** redirects,
183 unsigned memoryLimit,
184 std::string* ErrMsg) {
186 Win32ProcessInfo* wpi = reinterpret_cast<Win32ProcessInfo*>(Data_);
187 CloseHandle(wpi->hProcess);
192 if (!path.canExecute()) {
194 *ErrMsg = "program not executable";
198 // Windows wants a command line, not an array of args, to pass to the new
199 // process. We have to concatenate them all, while quoting the args that
200 // have embedded spaces (or are empty).
202 // First, determine the length of the command line.
204 for (unsigned i = 0; args[i]; i++) {
205 len += ArgLenWithQuotes(args[i]) + 1;
208 // Now build the command line.
209 char *command = reinterpret_cast<char *>(_alloca(len+1));
212 for (unsigned i = 0; args[i]; i++) {
213 const char *arg = args[i];
214 const char *start = arg;
216 bool needsQuoting = ArgNeedsQuotes(arg);
220 while (*arg != '\0') {
222 // Escape all preceding escapes (if any), and then escape the quote.
223 p = EscapePrecedingEscapes(p, start, arg);
231 // Make sure our quote doesn't get escaped by a trailing backslash.
232 p = EscapePrecedingEscapes(p, start, arg);
240 // The pointer to the environment block for the new process.
244 // An environment block consists of a null-terminated block of
245 // null-terminated strings. Convert the array of environment variables to
246 // an environment block by concatenating them.
248 // First, determine the length of the environment block.
250 for (unsigned i = 0; envp[i]; i++)
251 len += strlen(envp[i]) + 1;
253 // Now build the environment block.
254 envblock = reinterpret_cast<char *>(_alloca(len+1));
257 for (unsigned i = 0; envp[i]; i++) {
258 const char *ev = envp[i];
259 size_t len = strlen(ev) + 1;
267 // Create a child process.
269 memset(&si, 0, sizeof(si));
271 si.hStdInput = INVALID_HANDLE_VALUE;
272 si.hStdOutput = INVALID_HANDLE_VALUE;
273 si.hStdError = INVALID_HANDLE_VALUE;
276 si.dwFlags = STARTF_USESTDHANDLES;
278 si.hStdInput = RedirectIO(redirects[0], 0, ErrMsg);
279 if (si.hStdInput == INVALID_HANDLE_VALUE) {
280 MakeErrMsg(ErrMsg, "can't redirect stdin");
283 si.hStdOutput = RedirectIO(redirects[1], 1, ErrMsg);
284 if (si.hStdOutput == INVALID_HANDLE_VALUE) {
285 CloseHandle(si.hStdInput);
286 MakeErrMsg(ErrMsg, "can't redirect stdout");
289 if (redirects[1] && redirects[2] && *(redirects[1]) == *(redirects[2])) {
290 // If stdout and stderr should go to the same place, redirect stderr
291 // to the handle already open for stdout.
292 DuplicateHandle(GetCurrentProcess(), si.hStdOutput,
293 GetCurrentProcess(), &si.hStdError,
294 0, TRUE, DUPLICATE_SAME_ACCESS);
296 // Just redirect stderr
297 si.hStdError = RedirectIO(redirects[2], 2, ErrMsg);
298 if (si.hStdError == INVALID_HANDLE_VALUE) {
299 CloseHandle(si.hStdInput);
300 CloseHandle(si.hStdOutput);
301 MakeErrMsg(ErrMsg, "can't redirect stderr");
307 PROCESS_INFORMATION pi;
308 memset(&pi, 0, sizeof(pi));
312 BOOL rc = CreateProcess(path.c_str(), command, NULL, NULL, TRUE, 0,
313 envblock, NULL, &si, &pi);
314 DWORD err = GetLastError();
316 // Regardless of whether the process got created or not, we are done with
317 // the handles we created for it to inherit.
318 CloseHandle(si.hStdInput);
319 CloseHandle(si.hStdOutput);
320 CloseHandle(si.hStdError);
322 // Now return an error if the process didn't get created.
325 MakeErrMsg(ErrMsg, std::string("Couldn't execute program '") +
329 Win32ProcessInfo* wpi = new Win32ProcessInfo;
330 wpi->hProcess = pi.hProcess;
331 wpi->dwProcessId = pi.dwProcessId;
334 // Make sure these get closed no matter what.
335 ScopedCommonHandle hThread(pi.hThread);
337 // Assign the process to a job if a memory limit is defined.
338 ScopedJobHandle hJob;
339 if (memoryLimit != 0) {
340 hJob = CreateJobObject(0, 0);
341 bool success = false;
343 JOBOBJECT_EXTENDED_LIMIT_INFORMATION jeli;
344 memset(&jeli, 0, sizeof(jeli));
345 jeli.BasicLimitInformation.LimitFlags = JOB_OBJECT_LIMIT_PROCESS_MEMORY;
346 jeli.ProcessMemoryLimit = uintptr_t(memoryLimit) * 1048576;
347 if (SetInformationJobObject(hJob, JobObjectExtendedLimitInformation,
348 &jeli, sizeof(jeli))) {
349 if (AssignProcessToJobObject(hJob, pi.hProcess))
354 SetLastError(GetLastError());
355 MakeErrMsg(ErrMsg, std::string("Unable to set memory limit"));
356 TerminateProcess(pi.hProcess, 1);
357 WaitForSingleObject(pi.hProcess, INFINITE);
366 Program::Wait(const Path &path,
367 unsigned secondsToWait,
368 std::string* ErrMsg) {
370 MakeErrMsg(ErrMsg, "Process not started!");
374 Win32ProcessInfo* wpi = reinterpret_cast<Win32ProcessInfo*>(Data_);
375 HANDLE hProcess = wpi->hProcess;
377 // Wait for the process to terminate.
378 DWORD millisecondsToWait = INFINITE;
379 if (secondsToWait > 0)
380 millisecondsToWait = secondsToWait * 1000;
382 if (WaitForSingleObject(hProcess, millisecondsToWait) == WAIT_TIMEOUT) {
383 if (!TerminateProcess(hProcess, 1)) {
384 MakeErrMsg(ErrMsg, "Failed to terminate timed-out program.");
385 // -2 indicates a crash or timeout as opposed to failure to execute.
388 WaitForSingleObject(hProcess, INFINITE);
391 // Get its exit status.
393 BOOL rc = GetExitCodeProcess(hProcess, &status);
394 DWORD err = GetLastError();
398 MakeErrMsg(ErrMsg, "Failed getting status for program.");
399 // -2 indicates a crash or timeout as opposed to failure to execute.
406 // Pass 10(Warning) and 11(Error) to the callee as negative value.
407 if ((status & 0xBFFF0000U) == 0x80000000U)
411 return status & 0x7FFFFFFF;
416 error_code Program::ChangeStdinToBinary(){
417 int result = _setmode( _fileno(stdin), _O_BINARY );
419 return error_code(errno, generic_category());
420 return make_error_code(errc::success);
423 error_code Program::ChangeStdoutToBinary(){
424 int result = _setmode( _fileno(stdout), _O_BINARY );
426 return error_code(errno, generic_category());
427 return make_error_code(errc::success);
430 error_code Program::ChangeStderrToBinary(){
431 int result = _setmode( _fileno(stderr), _O_BINARY );
433 return error_code(errno, generic_category());
434 return make_error_code(errc::success);
437 bool llvm::sys::argumentsFitWithinSystemLimits(ArrayRef<const char*> Args) {
438 // The documented max length of the command line passed to CreateProcess.
439 static const size_t MaxCommandStringLength = 32768;
440 size_t ArgLength = 0;
441 for (ArrayRef<const char*>::iterator I = Args.begin(), E = Args.end();
443 // Account for the trailing space for every arg but the last one and the
444 // trailing NULL of the last argument.
445 ArgLength += ArgLenWithQuotes(*I) + 1;
446 if (ArgLength > MaxCommandStringLength) {