lib/Support/Windows/Program.inc

   1 //===- Win32/Program.cpp - Win32 Program 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 Program class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "WindowsSupport.h"
  15 #include "llvm/ADT/StringExtras.h"
  16 #include "llvm/Support/ConvertUTF.h"
  17 #include "llvm/Support/FileSystem.h"
  18 #include "llvm/Support/raw_ostream.h"
  19 #include "llvm/Support/WindowsError.h"
  20 #include <cstdio>
  21 #include <fcntl.h>
  22 #include <io.h>
  23 #include <malloc.h>
  24
  25 //===----------------------------------------------------------------------===//
  26 //=== WARNING: Implementation here must contain only Win32 specific code
  27 //===          and must not be UNIX code
  28 //===----------------------------------------------------------------------===//
  29
  30 namespace llvm {
  31 using namespace sys;
  32
  33 ProcessInfo::ProcessInfo() : ProcessHandle(0), Pid(0), ReturnCode(0) {}
  34
  35 ErrorOr<std::string> sys::findProgramByName(StringRef Name,
  36                                             ArrayRef<StringRef> Paths) {
  37   assert(!Name.empty() && "Must have a name!");
  38
  39   if (Name.find_first_of("/\\") != StringRef::npos)
  40     return std::string(Name);
  41
  42   const wchar_t *Path = nullptr;
  43   std::wstring PathStorage;
  44   if (!Paths.empty()) {
  45     PathStorage.reserve(Paths.size() * MAX_PATH);
  46     for (unsigned i = 0; i < Paths.size(); ++i) {
  47       if (i)
  48         PathStorage.push_back(L';');
  49       StringRef P = Paths[i];
  50       SmallVector<wchar_t, MAX_PATH> TmpPath;
  51       if (std::error_code EC = windows::UTF8ToUTF16(P, TmpPath))
  52         return EC;
  53       PathStorage.append(TmpPath.begin(), TmpPath.end());
  54     }
  55     Path = PathStorage.c_str();
  56   }
  57
  58   SmallVector<wchar_t, MAX_PATH> U16Name;
  59   if (std::error_code EC = windows::UTF8ToUTF16(Name, U16Name))
  60     return EC;
  61
  62   SmallVector<StringRef, 12> PathExts;
  63   PathExts.push_back("");
  64   PathExts.push_back(".exe"); // FIXME: This must be in %PATHEXT%.
  65   SplitString(std::getenv("PATHEXT"), PathExts, ";");
  66
  67   SmallVector<wchar_t, MAX_PATH> U16Result;
  68   DWORD Len = MAX_PATH;
  69   for (StringRef Ext : PathExts) {
  70     SmallVector<wchar_t, MAX_PATH> U16Ext;
  71     if (std::error_code EC = windows::UTF8ToUTF16(Ext, U16Ext))
  72       return EC;
  73
  74     do {
  75       U16Result.reserve(Len);
  76       Len = ::SearchPathW(Path, c_str(U16Name),
  77                           U16Ext.empty() ? nullptr : c_str(U16Ext),
  78                           U16Result.capacity(), U16Result.data(), nullptr);
  79     } while (Len > U16Result.capacity());
  80
  81     if (Len != 0)
  82       break; // Found it.
  83   }
  84
  85   if (Len == 0)
  86     return mapWindowsError(::GetLastError());
  87
  88   U16Result.set_size(Len);
  89
  90   SmallVector<char, MAX_PATH> U8Result;
  91   if (std::error_code EC =
  92           windows::UTF16ToUTF8(U16Result.data(), U16Result.size(), U8Result))
  93     return EC;
  94
  95   return std::string(U8Result.begin(), U8Result.end());
  96 }
  97
  98 static HANDLE RedirectIO(const StringRef *path, int fd, std::string* ErrMsg) {
  99   HANDLE h;
 100   if (path == 0) {
 101     if (!DuplicateHandle(GetCurrentProcess(), (HANDLE)_get_osfhandle(fd),
 102                          GetCurrentProcess(), &h,
 103                          0, TRUE, DUPLICATE_SAME_ACCESS))
 104       return INVALID_HANDLE_VALUE;
 105     return h;
 106   }
 107
 108   std::string fname;
 109   if (path->empty())
 110     fname = "NUL";
 111   else
 112     fname = *path;
 113
 114   SECURITY_ATTRIBUTES sa;
 115   sa.nLength = sizeof(sa);
 116   sa.lpSecurityDescriptor = 0;
 117   sa.bInheritHandle = TRUE;
 118
 119   SmallVector<wchar_t, 128> fnameUnicode;
 120   if (windows::UTF8ToUTF16(fname, fnameUnicode))
 121     return INVALID_HANDLE_VALUE;
 122
 123   h = CreateFileW(fnameUnicode.data(), fd ? GENERIC_WRITE : GENERIC_READ,
 124                   FILE_SHARE_READ, &sa, fd == 0 ? OPEN_EXISTING : CREATE_ALWAYS,
 125                   FILE_ATTRIBUTE_NORMAL, NULL);
 126   if (h == INVALID_HANDLE_VALUE) {
 127     MakeErrMsg(ErrMsg, std::string(fname) + ": Can't open file for " +
 128         (fd ? "input: " : "output: "));
 129   }
 130
 131   return h;
 132 }
 133
 134 /// ArgNeedsQuotes - Check whether argument needs to be quoted when calling
 135 /// CreateProcess.
 136 static bool ArgNeedsQuotes(const char *Str) {
 137   return Str[0] == '\0' || strpbrk(Str, "\t \"&\'()*<>\\`^|") != 0;
 138 }
 139
 140 /// CountPrecedingBackslashes - Returns the number of backslashes preceding Cur
 141 /// in the C string Start.
 142 static unsigned int CountPrecedingBackslashes(const char *Start,
 143                                               const char *Cur) {
 144   unsigned int Count = 0;
 145   --Cur;
 146   while (Cur >= Start && *Cur == '\\') {
 147     ++Count;
 148     --Cur;
 149   }
 150   return Count;
 151 }
 152
 153 /// EscapePrecedingEscapes - Append a backslash to Dst for every backslash
 154 /// preceding Cur in the Start string.  Assumes Dst has enough space.
 155 static char *EscapePrecedingEscapes(char *Dst, const char *Start,
 156                                     const char *Cur) {
 157   unsigned PrecedingEscapes = CountPrecedingBackslashes(Start, Cur);
 158   while (PrecedingEscapes > 0) {
 159     *Dst++ = '\\';
 160     --PrecedingEscapes;
 161   }
 162   return Dst;
 163 }
 164
 165 /// ArgLenWithQuotes - Check whether argument needs to be quoted when calling
 166 /// CreateProcess and returns length of quoted arg with escaped quotes
 167 static unsigned int ArgLenWithQuotes(const char *Str) {
 168   const char *Start = Str;
 169   bool Quoted = ArgNeedsQuotes(Str);
 170   unsigned int len = Quoted ? 2 : 0;
 171
 172   while (*Str != '\0') {
 173     if (*Str == '\"') {
 174       // We need to add a backslash, but ensure that it isn't escaped.
 175       unsigned PrecedingEscapes = CountPrecedingBackslashes(Start, Str);
 176       len += PrecedingEscapes + 1;
 177     }
 178     // Note that we *don't* need to escape runs of backslashes that don't
 179     // precede a double quote!  See MSDN:
 180     // http://msdn.microsoft.com/en-us/library/17w5ykft%28v=vs.85%29.aspx
 181
 182     ++len;
 183     ++Str;
 184   }
 185
 186   if (Quoted) {
 187     // Make sure the closing quote doesn't get escaped by a trailing backslash.
 188     unsigned PrecedingEscapes = CountPrecedingBackslashes(Start, Str);
 189     len += PrecedingEscapes + 1;
 190   }
 191
 192   return len;
 193 }
 194
 195 }
 196
 197 static std::unique_ptr<char[]> flattenArgs(const char **args) {
 198   // First, determine the length of the command line.
 199   unsigned len = 0;
 200   for (unsigned i = 0; args[i]; i++) {
 201     len += ArgLenWithQuotes(args[i]) + 1;
 202   }
 203
 204   // Now build the command line.
 205   std::unique_ptr<char[]> command(new char[len+1]);
 206   char *p = command.get();
 207
 208   for (unsigned i = 0; args[i]; i++) {
 209     const char *arg = args[i];
 210     const char *start = arg;
 211
 212     bool needsQuoting = ArgNeedsQuotes(arg);
 213     if (needsQuoting)
 214       *p++ = '"';
 215
 216     while (*arg != '\0') {
 217       if (*arg == '\"') {
 218         // Escape all preceding escapes (if any), and then escape the quote.
 219         p = EscapePrecedingEscapes(p, start, arg);
 220         *p++ = '\\';
 221       }
 222
 223       *p++ = *arg++;
 224     }
 225
 226     if (needsQuoting) {
 227       // Make sure our quote doesn't get escaped by a trailing backslash.
 228       p = EscapePrecedingEscapes(p, start, arg);
 229       *p++ = '"';
 230     }
 231     *p++ = ' ';
 232   }
 233
 234   *p = 0;
 235   return command;
 236 }
 237
 238 static bool Execute(ProcessInfo &PI, StringRef Program, const char **args,
 239                     const char **envp, const StringRef **redirects,
 240                     unsigned memoryLimit, std::string *ErrMsg) {
 241   if (!sys::fs::can_execute(Program)) {
 242     if (ErrMsg)
 243       *ErrMsg = "program not executable";
 244     return false;
 245   }
 246
 247   // Windows wants a command line, not an array of args, to pass to the new
 248   // process.  We have to concatenate them all, while quoting the args that
 249   // have embedded spaces (or are empty).
 250   std::unique_ptr<char[]> command = flattenArgs(args);
 251
 252   // The pointer to the environment block for the new process.
 253   std::vector<wchar_t> EnvBlock;
 254
 255   if (envp) {
 256     // An environment block consists of a null-terminated block of
 257     // null-terminated strings. Convert the array of environment variables to
 258     // an environment block by concatenating them.
 259     for (unsigned i = 0; envp[i]; ++i) {
 260       SmallVector<wchar_t, MAX_PATH> EnvString;
 261       if (std::error_code ec = windows::UTF8ToUTF16(envp[i], EnvString)) {
 262         SetLastError(ec.value());
 263         MakeErrMsg(ErrMsg, "Unable to convert environment variable to UTF-16");
 264         return false;
 265       }
 266
 267       EnvBlock.insert(EnvBlock.end(), EnvString.begin(), EnvString.end());
 268       EnvBlock.push_back(0);
 269     }
 270     EnvBlock.push_back(0);
 271   }
 272
 273   // Create a child process.
 274   STARTUPINFOW si;
 275   memset(&si, 0, sizeof(si));
 276   si.cb = sizeof(si);
 277   si.hStdInput = INVALID_HANDLE_VALUE;
 278   si.hStdOutput = INVALID_HANDLE_VALUE;
 279   si.hStdError = INVALID_HANDLE_VALUE;
 280
 281   if (redirects) {
 282     si.dwFlags = STARTF_USESTDHANDLES;
 283
 284     si.hStdInput = RedirectIO(redirects[0], 0, ErrMsg);
 285     if (si.hStdInput == INVALID_HANDLE_VALUE) {
 286       MakeErrMsg(ErrMsg, "can't redirect stdin");
 287       return false;
 288     }
 289     si.hStdOutput = RedirectIO(redirects[1], 1, ErrMsg);
 290     if (si.hStdOutput == INVALID_HANDLE_VALUE) {
 291       CloseHandle(si.hStdInput);
 292       MakeErrMsg(ErrMsg, "can't redirect stdout");
 293       return false;
 294     }
 295     if (redirects[1] && redirects[2] && *(redirects[1]) == *(redirects[2])) {
 296       // If stdout and stderr should go to the same place, redirect stderr
 297       // to the handle already open for stdout.
 298       if (!DuplicateHandle(GetCurrentProcess(), si.hStdOutput,
 299                            GetCurrentProcess(), &si.hStdError,
 300                            0, TRUE, DUPLICATE_SAME_ACCESS)) {
 301         CloseHandle(si.hStdInput);
 302         CloseHandle(si.hStdOutput);
 303         MakeErrMsg(ErrMsg, "can't dup stderr to stdout");
 304         return false;
 305       }
 306     } else {
 307       // Just redirect stderr
 308       si.hStdError = RedirectIO(redirects[2], 2, ErrMsg);
 309       if (si.hStdError == INVALID_HANDLE_VALUE) {
 310         CloseHandle(si.hStdInput);
 311         CloseHandle(si.hStdOutput);
 312         MakeErrMsg(ErrMsg, "can't redirect stderr");
 313         return false;
 314       }
 315     }
 316   }
 317
 318   PROCESS_INFORMATION pi;
 319   memset(&pi, 0, sizeof(pi));
 320
 321   fflush(stdout);
 322   fflush(stderr);
 323
 324   SmallVector<wchar_t, MAX_PATH> ProgramUtf16;
 325   if (std::error_code ec = windows::UTF8ToUTF16(Program, ProgramUtf16)) {
 326     SetLastError(ec.value());
 327     MakeErrMsg(ErrMsg,
 328                std::string("Unable to convert application name to UTF-16"));
 329     return false;
 330   }
 331
 332   SmallVector<wchar_t, MAX_PATH> CommandUtf16;
 333   if (std::error_code ec = windows::UTF8ToUTF16(command.get(), CommandUtf16)) {
 334     SetLastError(ec.value());
 335     MakeErrMsg(ErrMsg,
 336                std::string("Unable to convert command-line to UTF-16"));
 337     return false;
 338   }
 339
 340   BOOL rc = CreateProcessW(ProgramUtf16.data(), CommandUtf16.data(), 0, 0,
 341                            TRUE, CREATE_UNICODE_ENVIRONMENT,
 342                            EnvBlock.empty() ? 0 : EnvBlock.data(), 0, &si,
 343                            &pi);
 344   DWORD err = GetLastError();
 345
 346   // Regardless of whether the process got created or not, we are done with
 347   // the handles we created for it to inherit.
 348   CloseHandle(si.hStdInput);
 349   CloseHandle(si.hStdOutput);
 350   CloseHandle(si.hStdError);
 351
 352   // Now return an error if the process didn't get created.
 353   if (!rc) {
 354     SetLastError(err);
 355     MakeErrMsg(ErrMsg, std::string("Couldn't execute program '") +
 356                Program.str() + "'");
 357     return false;
 358   }
 359
 360   PI.Pid = pi.dwProcessId;
 361   PI.ProcessHandle = pi.hProcess;
 362
 363   // Make sure these get closed no matter what.
 364   ScopedCommonHandle hThread(pi.hThread);
 365
 366   // Assign the process to a job if a memory limit is defined.
 367   ScopedJobHandle hJob;
 368   if (memoryLimit != 0) {
 369     hJob = CreateJobObjectW(0, 0);
 370     bool success = false;
 371     if (hJob) {
 372       JOBOBJECT_EXTENDED_LIMIT_INFORMATION jeli;
 373       memset(&jeli, 0, sizeof(jeli));
 374       jeli.BasicLimitInformation.LimitFlags = JOB_OBJECT_LIMIT_PROCESS_MEMORY;
 375       jeli.ProcessMemoryLimit = uintptr_t(memoryLimit) * 1048576;
 376       if (SetInformationJobObject(hJob, JobObjectExtendedLimitInformation,
 377                                   &jeli, sizeof(jeli))) {
 378         if (AssignProcessToJobObject(hJob, pi.hProcess))
 379           success = true;
 380       }
 381     }
 382     if (!success) {
 383       SetLastError(GetLastError());
 384       MakeErrMsg(ErrMsg, std::string("Unable to set memory limit"));
 385       TerminateProcess(pi.hProcess, 1);
 386       WaitForSingleObject(pi.hProcess, INFINITE);
 387       return false;
 388     }
 389   }
 390
 391   return true;
 392 }
 393
 394 namespace llvm {
 395 ProcessInfo sys::Wait(const ProcessInfo &PI, unsigned SecondsToWait,
 396                       bool WaitUntilChildTerminates, std::string *ErrMsg) {
 397   assert(PI.Pid && "invalid pid to wait on, process not started?");
 398   assert(PI.ProcessHandle &&
 399          "invalid process handle to wait on, process not started?");
 400   DWORD milliSecondsToWait = 0;
 401   if (WaitUntilChildTerminates)
 402     milliSecondsToWait = INFINITE;
 403   else if (SecondsToWait > 0)
 404     milliSecondsToWait = SecondsToWait * 1000;
 405
 406   ProcessInfo WaitResult = PI;
 407   DWORD WaitStatus = WaitForSingleObject(PI.ProcessHandle, milliSecondsToWait);
 408   if (WaitStatus == WAIT_TIMEOUT) {
 409     if (SecondsToWait) {
 410       if (!TerminateProcess(PI.ProcessHandle, 1)) {
 411         if (ErrMsg)
 412           MakeErrMsg(ErrMsg, "Failed to terminate timed-out program.");
 413
 414         // -2 indicates a crash or timeout as opposed to failure to execute.
 415         WaitResult.ReturnCode = -2;
 416         CloseHandle(PI.ProcessHandle);
 417         return WaitResult;
 418       }
 419       WaitForSingleObject(PI.ProcessHandle, INFINITE);
 420       CloseHandle(PI.ProcessHandle);
 421     } else {
 422       // Non-blocking wait.
 423       return ProcessInfo();
 424     }
 425   }
 426
 427   // Get its exit status.
 428   DWORD status;
 429   BOOL rc = GetExitCodeProcess(PI.ProcessHandle, &status);
 430   DWORD err = GetLastError();
 431   CloseHandle(PI.ProcessHandle);
 432
 433   if (!rc) {
 434     SetLastError(err);
 435     if (ErrMsg)
 436       MakeErrMsg(ErrMsg, "Failed getting status for program.");
 437
 438     // -2 indicates a crash or timeout as opposed to failure to execute.
 439     WaitResult.ReturnCode = -2;
 440     return WaitResult;
 441   }
 442
 443   if (!status)
 444     return WaitResult;
 445
 446   // Pass 10(Warning) and 11(Error) to the callee as negative value.
 447   if ((status & 0xBFFF0000U) == 0x80000000U)
 448     WaitResult.ReturnCode = static_cast<int>(status);
 449   else if (status & 0xFF)
 450     WaitResult.ReturnCode = status & 0x7FFFFFFF;
 451   else
 452     WaitResult.ReturnCode = 1;
 453
 454   return WaitResult;
 455 }
 456
 457 std::error_code sys::ChangeStdinToBinary() {
 458   int result = _setmode(_fileno(stdin), _O_BINARY);
 459   if (result == -1)
 460     return std::error_code(errno, std::generic_category());
 461   return std::error_code();
 462 }
 463
 464 std::error_code sys::ChangeStdoutToBinary() {
 465   int result = _setmode(_fileno(stdout), _O_BINARY);
 466   if (result == -1)
 467     return std::error_code(errno, std::generic_category());
 468   return std::error_code();
 469 }
 470
 471 std::error_code
 472 llvm::sys::writeFileWithEncoding(StringRef FileName, StringRef Contents,
 473                                  WindowsEncodingMethod Encoding) {
 474   std::error_code EC;
 475   llvm::raw_fd_ostream OS(FileName, EC, llvm::sys::fs::OpenFlags::F_Text);
 476   if (EC)
 477     return EC;
 478
 479   if (Encoding == WEM_UTF8) {
 480     OS << Contents;
 481   } else if (Encoding == WEM_CurrentCodePage) {
 482     SmallVector<wchar_t, 1> ArgsUTF16;
 483     SmallVector<char, 1> ArgsCurCP;
 484
 485     if ((EC = windows::UTF8ToUTF16(Contents, ArgsUTF16)))
 486       return EC;
 487
 488     if ((EC = windows::UTF16ToCurCP(
 489              ArgsUTF16.data(), ArgsUTF16.size(), ArgsCurCP)))
 490       return EC;
 491
 492     OS.write(ArgsCurCP.data(), ArgsCurCP.size());
 493   } else if (Encoding == WEM_UTF16) {
 494     SmallVector<wchar_t, 1> ArgsUTF16;
 495
 496     if ((EC = windows::UTF8ToUTF16(Contents, ArgsUTF16)))
 497       return EC;
 498
 499     // Endianness guessing
 500     char BOM[2];
 501     uint16_t src = UNI_UTF16_BYTE_ORDER_MARK_NATIVE;
 502     memcpy(BOM, &src, 2);
 503     OS.write(BOM, 2);
 504     OS.write((char *)ArgsUTF16.data(), ArgsUTF16.size() << 1);
 505   } else {
 506     llvm_unreachable("Unknown encoding");
 507   }
 508
 509   if (OS.has_error())
 510     return std::make_error_code(std::errc::io_error);
 511
 512   return EC;
 513 }
 514
 515 bool llvm::sys::argumentsFitWithinSystemLimits(ArrayRef<const char*> Args) {
 516   // The documented max length of the command line passed to CreateProcess.
 517   static const size_t MaxCommandStringLength = 32768;
 518   size_t ArgLength = 0;
 519   for (ArrayRef<const char*>::iterator I = Args.begin(), E = Args.end();
 520        I != E; ++I) {
 521     // Account for the trailing space for every arg but the last one and the
 522     // trailing NULL of the last argument.
 523     ArgLength += ArgLenWithQuotes(*I) + 1;
 524     if (ArgLength > MaxCommandStringLength) {
 525       return false;
 526     }
 527   }
 528   return true;
 529 }
 530 }