lib/Support/Unix/Program.inc

   1 //===- llvm/Support/Unix/Program.cpp -----------------------------*- 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 implements the Unix specific portion of the Program class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 //===----------------------------------------------------------------------===//
  15 //=== WARNING: Implementation here must contain only generic UNIX code that
  16 //===          is guaranteed to work on *all* UNIX variants.
  17 //===----------------------------------------------------------------------===//
  18
  19 #include "Unix.h"
  20 #include "llvm/Support/Compiler.h"
  21 #include "llvm/Support/FileSystem.h"
  22 #include <llvm/Config/config.h>
  23 #if HAVE_SYS_STAT_H
  24 #include <sys/stat.h>
  25 #endif
  26 #if HAVE_SYS_RESOURCE_H
  27 #include <sys/resource.h>
  28 #endif
  29 #if HAVE_SIGNAL_H
  30 #include <signal.h>
  31 #endif
  32 #if HAVE_FCNTL_H
  33 #include <fcntl.h>
  34 #endif
  35 #if HAVE_UNISTD_H
  36 #include <unistd.h>
  37 #endif
  38 #ifdef HAVE_POSIX_SPAWN
  39 #include <spawn.h>
  40 #if !defined(__APPLE__)
  41   extern char **environ;
  42 #else
  43 #include <crt_externs.h> // _NSGetEnviron
  44 #endif
  45 #endif
  46
  47 namespace llvm {
  48 using namespace sys;
  49
  50 // This function just uses the PATH environment variable to find the program.
  51 Path
  52 sys::FindProgramByName(const std::string& progName) {
  53
  54   // Check some degenerate cases
  55   if (progName.length() == 0) // no program
  56     return Path();
  57   Path temp;
  58   if (!temp.set(progName)) // invalid name
  59     return Path();
  60   // Use the given path verbatim if it contains any slashes; this matches
  61   // the behavior of sh(1) and friends.
  62   if (progName.find('/') != std::string::npos)
  63     return temp;
  64
  65   // At this point, the file name is valid and does not contain slashes. Search
  66   // for it through the directories specified in the PATH environment variable.
  67
  68   // Get the path. If its empty, we can't do anything to find it.
  69   const char *PathStr = getenv("PATH");
  70   if (PathStr == 0)
  71     return Path();
  72
  73   // Now we have a colon separated list of directories to search; try them.
  74   size_t PathLen = strlen(PathStr);
  75   while (PathLen) {
  76     // Find the first colon...
  77     const char *Colon = std::find(PathStr, PathStr+PathLen, ':');
  78
  79     // Check to see if this first directory contains the executable...
  80     Path FilePath;
  81     if (FilePath.set(std::string(PathStr,Colon))) {
  82       FilePath.appendComponent(progName);
  83       if (FilePath.canExecute())
  84         return FilePath;                    // Found the executable!
  85     }
  86
  87     // Nope it wasn't in this directory, check the next path in the list!
  88     PathLen -= Colon-PathStr;
  89     PathStr = Colon;
  90
  91     // Advance past duplicate colons
  92     while (*PathStr == ':') {
  93       PathStr++;
  94       PathLen--;
  95     }
  96   }
  97   return Path();
  98 }
  99
 100 static bool RedirectIO(const Path *Path, int FD, std::string* ErrMsg) {
 101   if (Path == 0) // Noop
 102     return false;
 103   const char *File;
 104   if (Path->isEmpty())
 105     // Redirect empty paths to /dev/null
 106     File = "/dev/null";
 107   else
 108     File = Path->c_str();
 109
 110   // Open the file
 111   int InFD = open(File, FD == 0 ? O_RDONLY : O_WRONLY|O_CREAT, 0666);
 112   if (InFD == -1) {
 113     MakeErrMsg(ErrMsg, "Cannot open file '" + std::string(File) + "' for "
 114               + (FD == 0 ? "input" : "output"));
 115     return true;
 116   }
 117
 118   // Install it as the requested FD
 119   if (dup2(InFD, FD) == -1) {
 120     MakeErrMsg(ErrMsg, "Cannot dup2");
 121     close(InFD);
 122     return true;
 123   }
 124   close(InFD);      // Close the original FD
 125   return false;
 126 }
 127
 128 #ifdef HAVE_POSIX_SPAWN
 129 static bool RedirectIO_PS(const Path *Path, int FD, std::string *ErrMsg,
 130                           posix_spawn_file_actions_t *FileActions) {
 131   if (Path == 0) // Noop
 132     return false;
 133   const char *File;
 134   if (Path->isEmpty())
 135     // Redirect empty paths to /dev/null
 136     File = "/dev/null";
 137   else
 138     File = Path->c_str();
 139
 140   if (int Err = posix_spawn_file_actions_addopen(FileActions, FD,
 141                             File, FD == 0 ? O_RDONLY : O_WRONLY|O_CREAT, 0666))
 142     return MakeErrMsg(ErrMsg, "Cannot dup2", Err);
 143   return false;
 144 }
 145 #endif
 146
 147 static void TimeOutHandler(int Sig) {
 148 }
 149
 150 static void SetMemoryLimits (unsigned size)
 151 {
 152 #if HAVE_SYS_RESOURCE_H && HAVE_GETRLIMIT && HAVE_SETRLIMIT
 153   struct rlimit r;
 154   __typeof__ (r.rlim_cur) limit = (__typeof__ (r.rlim_cur)) (size) * 1048576;
 155
 156   // Heap size
 157   getrlimit (RLIMIT_DATA, &r);
 158   r.rlim_cur = limit;
 159   setrlimit (RLIMIT_DATA, &r);
 160 #ifdef RLIMIT_RSS
 161   // Resident set size.
 162   getrlimit (RLIMIT_RSS, &r);
 163   r.rlim_cur = limit;
 164   setrlimit (RLIMIT_RSS, &r);
 165 #endif
 166 #ifdef RLIMIT_AS  // e.g. NetBSD doesn't have it.
 167   // Don't set virtual memory limit if built with any Sanitizer. They need 80Tb
 168   // of virtual memory for shadow memory mapping.
 169 #if !LLVM_MEMORY_SANITIZER_BUILD && !LLVM_ADDRESS_SANITIZER_BUILD
 170   // Virtual memory.
 171   getrlimit (RLIMIT_AS, &r);
 172   r.rlim_cur = limit;
 173   setrlimit (RLIMIT_AS, &r);
 174 #endif
 175 #endif
 176 #endif
 177 }
 178
 179 }
 180
 181 static bool Execute(void **Data, const Path &path, const char **args,
 182                     const char **envp, const Path **redirects,
 183                     unsigned memoryLimit, std::string *ErrMsg) {
 184   // If this OS has posix_spawn and there is no memory limit being implied, use
 185   // posix_spawn.  It is more efficient than fork/exec.
 186 #ifdef HAVE_POSIX_SPAWN
 187   if (memoryLimit == 0) {
 188     posix_spawn_file_actions_t FileActionsStore;
 189     posix_spawn_file_actions_t *FileActions = 0;
 190
 191     if (redirects) {
 192       FileActions = &FileActionsStore;
 193       posix_spawn_file_actions_init(FileActions);
 194
 195       // Redirect stdin/stdout.
 196       if (RedirectIO_PS(redirects[0], 0, ErrMsg, FileActions) ||
 197           RedirectIO_PS(redirects[1], 1, ErrMsg, FileActions))
 198         return false;
 199       if (redirects[1] == 0 || redirects[2] == 0 ||
 200           *redirects[1] != *redirects[2]) {
 201         // Just redirect stderr
 202         if (RedirectIO_PS(redirects[2], 2, ErrMsg, FileActions)) return false;
 203       } else {
 204         // If stdout and stderr should go to the same place, redirect stderr
 205         // to the FD already open for stdout.
 206         if (int Err = posix_spawn_file_actions_adddup2(FileActions, 1, 2))
 207           return !MakeErrMsg(ErrMsg, "Can't redirect stderr to stdout", Err);
 208       }
 209     }
 210
 211     if (!envp)
 212 #if !defined(__APPLE__)
 213       envp = const_cast<const char **>(environ);
 214 #else
 215       // environ is missing in dylibs.
 216       envp = const_cast<const char **>(*_NSGetEnviron());
 217 #endif
 218
 219     // Explicitly initialized to prevent what appears to be a valgrind false
 220     // positive.
 221     pid_t PID = 0;
 222     int Err = posix_spawn(&PID, path.c_str(), FileActions, /*attrp*/0,
 223                           const_cast<char **>(args), const_cast<char **>(envp));
 224
 225     if (FileActions)
 226       posix_spawn_file_actions_destroy(FileActions);
 227
 228     if (Err)
 229      return !MakeErrMsg(ErrMsg, "posix_spawn failed", Err);
 230
 231     if (Data)
 232       *Data = reinterpret_cast<void*>(PID);
 233     return true;
 234   }
 235 #endif
 236
 237   // Create a child process.
 238   int child = fork();
 239   switch (child) {
 240     // An error occurred:  Return to the caller.
 241     case -1:
 242       MakeErrMsg(ErrMsg, "Couldn't fork");
 243       return false;
 244
 245     // Child process: Execute the program.
 246     case 0: {
 247       // Redirect file descriptors...
 248       if (redirects) {
 249         // Redirect stdin
 250         if (RedirectIO(redirects[0], 0, ErrMsg)) { return false; }
 251         // Redirect stdout
 252         if (RedirectIO(redirects[1], 1, ErrMsg)) { return false; }
 253         if (redirects[1] && redirects[2] &&
 254             *(redirects[1]) == *(redirects[2])) {
 255           // If stdout and stderr should go to the same place, redirect stderr
 256           // to the FD already open for stdout.
 257           if (-1 == dup2(1,2)) {
 258             MakeErrMsg(ErrMsg, "Can't redirect stderr to stdout");
 259             return false;
 260           }
 261         } else {
 262           // Just redirect stderr
 263           if (RedirectIO(redirects[2], 2, ErrMsg)) { return false; }
 264         }
 265       }
 266
 267       // Set memory limits
 268       if (memoryLimit!=0) {
 269         SetMemoryLimits(memoryLimit);
 270       }
 271
 272       // Execute!
 273       if (envp != 0)
 274         execve(path.c_str(),
 275                const_cast<char **>(args),
 276                const_cast<char **>(envp));
 277       else
 278         execv(path.c_str(),
 279               const_cast<char **>(args));
 280       // If the execve() failed, we should exit. Follow Unix protocol and
 281       // return 127 if the executable was not found, and 126 otherwise.
 282       // Use _exit rather than exit so that atexit functions and static
 283       // object destructors cloned from the parent process aren't
 284       // redundantly run, and so that any data buffered in stdio buffers
 285       // cloned from the parent aren't redundantly written out.
 286       _exit(errno == ENOENT ? 127 : 126);
 287     }
 288
 289     // Parent process: Break out of the switch to do our processing.
 290     default:
 291       break;
 292   }
 293
 294   if (Data)
 295     *Data = reinterpret_cast<void*>(child);
 296
 297   return true;
 298 }
 299
 300 static int Wait(void *&Data, const sys::Path &path, unsigned secondsToWait,
 301                 std::string *ErrMsg) {
 302 #ifdef HAVE_SYS_WAIT_H
 303   struct sigaction Act, Old;
 304   assert(Data && "invalid pid to wait on, process not started?");
 305
 306   // Install a timeout handler.  The handler itself does nothing, but the simple
 307   // fact of having a handler at all causes the wait below to return with EINTR,
 308   // unlike if we used SIG_IGN.
 309   if (secondsToWait) {
 310     memset(&Act, 0, sizeof(Act));
 311     Act.sa_handler = TimeOutHandler;
 312     sigemptyset(&Act.sa_mask);
 313     sigaction(SIGALRM, &Act, &Old);
 314     alarm(secondsToWait);
 315   }
 316
 317   // Parent process: Wait for the child process to terminate.
 318   int status;
 319   uint64_t pid = reinterpret_cast<uint64_t>(Data);
 320   pid_t child = static_cast<pid_t>(pid);
 321   while (waitpid(pid, &status, 0) != child)
 322     if (secondsToWait && errno == EINTR) {
 323       // Kill the child.
 324       kill(child, SIGKILL);
 325
 326       // Turn off the alarm and restore the signal handler
 327       alarm(0);
 328       sigaction(SIGALRM, &Old, 0);
 329
 330       // Wait for child to die
 331       if (wait(&status) != child)
 332         MakeErrMsg(ErrMsg, "Child timed out but wouldn't die");
 333       else
 334         MakeErrMsg(ErrMsg, "Child timed out", 0);
 335
 336       return -2;   // Timeout detected
 337     } else if (errno != EINTR) {
 338       MakeErrMsg(ErrMsg, "Error waiting for child process");
 339       return -1;
 340     }
 341
 342   // We exited normally without timeout, so turn off the timer.
 343   if (secondsToWait) {
 344     alarm(0);
 345     sigaction(SIGALRM, &Old, 0);
 346   }
 347
 348   // Return the proper exit status. Detect error conditions
 349   // so we can return -1 for them and set ErrMsg informatively.
 350   int result = 0;
 351   if (WIFEXITED(status)) {
 352     result = WEXITSTATUS(status);
 353 #ifdef HAVE_POSIX_SPAWN
 354     // The posix_spawn child process returns 127 on any kind of error.
 355     // Following the POSIX convention for command-line tools (which posix_spawn
 356     // itself apparently does not), check to see if the failure was due to some
 357     // reason other than the file not existing, and return 126 in this case.
 358     bool Exists;
 359     if (result == 127 && !llvm::sys::fs::exists(path.str(), Exists) && Exists)
 360       result = 126;
 361 #endif
 362     if (result == 127) {
 363       if (ErrMsg)
 364         *ErrMsg = llvm::sys::StrError(ENOENT);
 365       return -1;
 366     }
 367     if (result == 126) {
 368       if (ErrMsg)
 369         *ErrMsg = "Program could not be executed";
 370       return -1;
 371     }
 372   } else if (WIFSIGNALED(status)) {
 373     if (ErrMsg) {
 374       *ErrMsg = strsignal(WTERMSIG(status));
 375 #ifdef WCOREDUMP
 376       if (WCOREDUMP(status))
 377         *ErrMsg += " (core dumped)";
 378 #endif
 379     }
 380     // Return a special value to indicate that the process received an unhandled
 381     // signal during execution as opposed to failing to execute.
 382     return -2;
 383   }
 384   return result;
 385 #else
 386   if (ErrMsg)
 387     *ErrMsg = "Program::Wait is not implemented on this platform yet!";
 388   return -1;
 389 #endif
 390 }
 391
 392 namespace llvm {
 393
 394 error_code sys::ChangeStdinToBinary(){
 395   // Do nothing, as Unix doesn't differentiate between text and binary.
 396   return make_error_code(errc::success);
 397 }
 398
 399 error_code sys::ChangeStdoutToBinary(){
 400   // Do nothing, as Unix doesn't differentiate between text and binary.
 401   return make_error_code(errc::success);
 402 }
 403
 404 error_code sys::ChangeStderrToBinary(){
 405   // Do nothing, as Unix doesn't differentiate between text and binary.
 406   return make_error_code(errc::success);
 407 }
 408
 409 bool llvm::sys::argumentsFitWithinSystemLimits(ArrayRef<const char*> Args) {
 410   static long ArgMax = sysconf(_SC_ARG_MAX);
 411
 412   // System says no practical limit.
 413   if (ArgMax == -1)
 414     return true;
 415
 416   // Conservatively account for space required by environment variables.
 417   ArgMax /= 2;
 418
 419   size_t ArgLength = 0;
 420   for (ArrayRef<const char*>::iterator I = Args.begin(), E = Args.end();
 421        I != E; ++I) {
 422     ArgLength += strlen(*I) + 1;
 423     if (ArgLength > size_t(ArgMax)) {
 424       return false;
 425     }
 426   }
 427   return true;
 428 }
 429
 430 }