lib/System/Win32/Program.inc

   1 //===- Win32/Program.cpp - Win32 Program Implementation ------- -*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Jeff Cohen and is distributed under the
   6 // University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file provides the Win32 specific implementation of the Program class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "Win32.h"
  15 #include <cstdio>
  16 #include <malloc.h>
  17 #include <io.h>
  18 #include <fcntl.h>
  19
  20 //===----------------------------------------------------------------------===//
  21 //=== WARNING: Implementation here must contain only Win32 specific code
  22 //===          and must not be UNIX code
  23 //===----------------------------------------------------------------------===//
  24
  25 namespace llvm {
  26 using namespace sys;
  27
  28 // This function just uses the PATH environment variable to find the program.
  29 Path
  30 Program::FindProgramByName(const std::string& progName) {
  31
  32   // Check some degenerate cases
  33   if (progName.length() == 0) // no program
  34     return Path();
  35   Path temp;
  36   if (!temp.set(progName)) // invalid name
  37     return Path();
  38   if (temp.canExecute()) // already executable as is
  39     return temp;
  40
  41   // At this point, the file name is valid and its not executable.
  42   // Let Windows search for it.
  43   char buffer[MAX_PATH];
  44   char *dummy = NULL;
  45   DWORD len = SearchPath(NULL, progName.c_str(), ".exe", MAX_PATH,
  46                          buffer, &dummy);
  47
  48   // See if it wasn't found.
  49   if (len == 0)
  50     return Path();
  51
  52   // See if we got the entire path.
  53   if (len < MAX_PATH)
  54     return Path(buffer);
  55
  56   // Buffer was too small; grow and retry.
  57   while (true) {
  58     char *b = reinterpret_cast<char *>(_alloca(len+1));
  59     DWORD len2 = SearchPath(NULL, progName.c_str(), ".exe", len+1, b, &dummy);
  60
  61     // It is unlikely the search failed, but it's always possible some file
  62     // was added or removed since the last search, so be paranoid...
  63     if (len2 == 0)
  64       return Path();
  65     else if (len2 <= len)
  66       return Path(b);
  67
  68     len = len2;
  69   }
  70 }
  71
  72 static HANDLE RedirectIO(const Path *path, int fd, std::string* ErrMsg) {
  73   HANDLE h;
  74   if (path == 0) {
  75     DuplicateHandle(GetCurrentProcess(), (HANDLE)_get_osfhandle(fd),
  76                     GetCurrentProcess(), &h,
  77                     0, TRUE, DUPLICATE_SAME_ACCESS);
  78     return h;
  79   }
  80
  81   const char *fname = path->toString().c_str();
  82   if (*fname == 0)
  83     fname = "NUL";
  84
  85   SECURITY_ATTRIBUTES sa;
  86   sa.nLength = sizeof(sa);
  87   sa.lpSecurityDescriptor = 0;
  88   sa.bInheritHandle = TRUE;
  89
  90   h = CreateFile(fname, fd ? GENERIC_WRITE : GENERIC_READ, FILE_SHARE_READ,
  91                  &sa, fd == 0 ? OPEN_EXISTING : CREATE_ALWAYS,
  92                  FILE_ATTRIBUTE_NORMAL, NULL);
  93   if (h == INVALID_HANDLE_VALUE) {
  94     MakeErrMsg(ErrMsg, std::string(fname) + ": Can't open file for " +
  95         (fd ? "input: " : "output: "));
  96   }
  97
  98   return h;
  99 }
 100
 101 #ifdef __MINGW32__
 102   // Due to unknown reason, mingw32's w32api doesn't have this declaration.
 103   BOOL WINAPI SetInformationJobObject(HANDLE hJob,
 104                                       JOBOBJECTINFOCLASS JobObjectInfoClass,
 105                                       LPVOID lpJobObjectInfo,
 106                                       DWORD cbJobObjectInfoLength);
 107 #endif
 108
 109 int
 110 Program::ExecuteAndWait(const Path& path,
 111                         const char** args,
 112                         const char** envp,
 113                         const Path** redirects,
 114                         unsigned secondsToWait,
 115                         unsigned memoryLimit,
 116                         std::string* ErrMsg) {
 117   if (!path.canExecute()) {
 118     if (ErrMsg)
 119       *ErrMsg = "program not executable";
 120     return -1;
 121   }
 122
 123   // Windows wants a command line, not an array of args, to pass to the new
 124   // process.  We have to concatenate them all, while quoting the args that
 125   // have embedded spaces.
 126
 127   // First, determine the length of the command line.
 128   unsigned len = 0;
 129   for (unsigned i = 0; args[i]; i++) {
 130     len += strlen(args[i]) + 1;
 131     if (strchr(args[i], ' '))
 132       len += 2;
 133   }
 134
 135   // Now build the command line.
 136   char *command = reinterpret_cast<char *>(_alloca(len));
 137   char *p = command;
 138
 139   for (unsigned i = 0; args[i]; i++) {
 140     const char *arg = args[i];
 141     size_t len = strlen(arg);
 142     bool needsQuoting = strchr(arg, ' ') != 0;
 143     if (needsQuoting)
 144       *p++ = '"';
 145     memcpy(p, arg, len);
 146     p += len;
 147     if (needsQuoting)
 148       *p++ = '"';
 149     *p++ = ' ';
 150   }
 151
 152   *p = 0;
 153
 154   // Create a child process.
 155   STARTUPINFO si;
 156   memset(&si, 0, sizeof(si));
 157   si.cb = sizeof(si);
 158   si.hStdInput = INVALID_HANDLE_VALUE;
 159   si.hStdOutput = INVALID_HANDLE_VALUE;
 160   si.hStdError = INVALID_HANDLE_VALUE;
 161
 162   if (redirects) {
 163     si.dwFlags = STARTF_USESTDHANDLES;
 164
 165     si.hStdInput = RedirectIO(redirects[0], 0, ErrMsg);
 166     if (si.hStdInput == INVALID_HANDLE_VALUE) {
 167       MakeErrMsg(ErrMsg, "can't redirect stdin");
 168       return -1;
 169     }
 170     si.hStdOutput = RedirectIO(redirects[1], 1, ErrMsg);
 171     if (si.hStdOutput == INVALID_HANDLE_VALUE) {
 172       CloseHandle(si.hStdInput);
 173       MakeErrMsg(ErrMsg, "can't redirect stdout");
 174       return -1;
 175     }
 176     if (redirects[1] && redirects[2] && *(redirects[1]) != *(redirects[2])) {
 177       si.hStdError = RedirectIO(redirects[2], 2, ErrMsg);
 178       if (si.hStdError == INVALID_HANDLE_VALUE) {
 179         CloseHandle(si.hStdInput);
 180         CloseHandle(si.hStdOutput);
 181         MakeErrMsg(ErrMsg, "can't redirect stderr");
 182         return -1;
 183       }
 184     } else {
 185       DuplicateHandle(GetCurrentProcess(), si.hStdOutput,
 186                       GetCurrentProcess(), &si.hStdError,
 187                       0, TRUE, DUPLICATE_SAME_ACCESS);
 188     }
 189   }
 190
 191   PROCESS_INFORMATION pi;
 192   memset(&pi, 0, sizeof(pi));
 193
 194   fflush(stdout);
 195   fflush(stderr);
 196   BOOL rc = CreateProcess(path.c_str(), command, NULL, NULL, FALSE, 0,
 197                           envp, NULL, &si, &pi);
 198   DWORD err = GetLastError();
 199
 200   // Regardless of whether the process got created or not, we are done with
 201   // the handles we created for it to inherit.
 202   CloseHandle(si.hStdInput);
 203   CloseHandle(si.hStdOutput);
 204   CloseHandle(si.hStdError);
 205
 206   // Now return an error if the process didn't get created.
 207   if (!rc)
 208   {
 209     SetLastError(err);
 210     MakeErrMsg(ErrMsg, std::string("Couldn't execute program '") +
 211                path.toString() + "'");
 212     return -1;
 213   }
 214
 215   // Make sure these get closed no matter what.
 216   AutoHandle hProcess(pi.hProcess);
 217   AutoHandle hThread(pi.hThread);
 218
 219   // Assign the process to a job if a memory limit is defined.
 220   AutoHandle hJob(0);
 221   if (memoryLimit != 0) {
 222     hJob = CreateJobObject(0, 0);
 223     bool success = false;
 224     if (hJob != 0) {
 225       JOBOBJECT_EXTENDED_LIMIT_INFORMATION jeli;
 226       memset(&jeli, 0, sizeof(jeli));
 227       jeli.BasicLimitInformation.LimitFlags = JOB_OBJECT_LIMIT_PROCESS_MEMORY;
 228       jeli.ProcessMemoryLimit = uintptr_t(memoryLimit) * 1048576;
 229       if (SetInformationJobObject(hJob, JobObjectExtendedLimitInformation,
 230                                   &jeli, sizeof(jeli))) {
 231         if (AssignProcessToJobObject(hJob, pi.hProcess))
 232           success = true;
 233       }
 234     }
 235     if (!success) {
 236       SetLastError(GetLastError());
 237       MakeErrMsg(ErrMsg, std::string("Unable to set memory limit"));
 238       TerminateProcess(pi.hProcess, 1);
 239       WaitForSingleObject(pi.hProcess, INFINITE);
 240       return -1;
 241     }
 242   }
 243
 244   // Wait for it to terminate.
 245   DWORD millisecondsToWait = INFINITE;
 246   if (secondsToWait > 0)
 247     millisecondsToWait = secondsToWait * 1000;
 248
 249   if (WaitForSingleObject(pi.hProcess, millisecondsToWait) == WAIT_TIMEOUT) {
 250     if (!TerminateProcess(pi.hProcess, 1)) {
 251       MakeErrMsg(ErrMsg, std::string("Failed to terminate timed-out program '")
 252           + path.toString() + "'");
 253       return -1;
 254     }
 255     WaitForSingleObject(pi.hProcess, INFINITE);
 256   }
 257
 258   // Get its exit status.
 259   DWORD status;
 260   rc = GetExitCodeProcess(pi.hProcess, &status);
 261   err = GetLastError();
 262
 263   if (!rc) {
 264     SetLastError(err);
 265     MakeErrMsg(ErrMsg, std::string("Failed getting status for program '") +
 266                path.toString() + "'");
 267     return -1;
 268   }
 269
 270   return status;
 271 }
 272
 273 bool Program::ChangeStdinToBinary(){
 274   int result = _setmode( _fileno(stdin), _O_BINARY );
 275   return result == -1;
 276 }
 277
 278 bool Program::ChangeStdoutToBinary(){
 279   int result = _setmode( _fileno(stdout), _O_BINARY );
 280   return result == -1;
 281 }
 282
 283 }