lib/Support/SystemUtils.cpp

   1 //===- SystemUtils.h - Utilities to do low-level system stuff --*- C++ -*--===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains functions used to do a variety of low-level, often
  11 // system-specific, tasks.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #define _POSIX_MAPPED_FILES
  16 #include "Support/SystemUtils.h"
  17 #include "Config/sys/types.h"
  18 #include "Config/sys/stat.h"
  19 #include "Config/fcntl.h"
  20 #include "Config/pagesize.h"
  21 #include "Config/sys/wait.h"
  22 #include "Config/sys/mman.h"
  23 #include "Config/unistd.h"
  24 #include <algorithm>
  25 #include <fstream>
  26 #include <iostream>
  27 #include <cstdlib>
  28 #include <cerrno>
  29 #include "Config/windows.h"
  30 using namespace llvm;
  31
  32 /// isExecutableFile - This function returns true if the filename specified
  33 /// exists and is executable.
  34 ///
  35 bool llvm::isExecutableFile(const std::string &ExeFileName) {
  36   struct stat Buf;
  37   if (stat(ExeFileName.c_str(), &Buf))
  38     return false;  // Must not be executable!
  39
  40   if (!(Buf.st_mode & S_IFREG))
  41     return false;                    // Not a regular file?
  42
  43   if (Buf.st_uid == getuid())        // Owner of file?
  44     return Buf.st_mode & S_IXUSR;
  45   else if (Buf.st_gid == getgid())   // In group of file?
  46     return Buf.st_mode & S_IXGRP;
  47   else                               // Unrelated to file?
  48     return Buf.st_mode & S_IXOTH;
  49 }
  50
  51 /// isStandardOutAConsole - Return true if we can tell that the standard output
  52 /// stream goes to a terminal window or console.
  53 bool llvm::isStandardOutAConsole() {
  54 #if HAVE_ISATTY
  55   return isatty(1);
  56 #endif
  57   // If we don't have isatty, just return false.
  58   return false;
  59 }
  60
  61
  62 /// FindExecutable - Find a named executable, giving the argv[0] of program
  63 /// being executed. This allows us to find another LLVM tool if it is built
  64 /// into the same directory, but that directory is neither the current
  65 /// directory, nor in the PATH.  If the executable cannot be found, return an
  66 /// empty string.
  67 ///
  68 #undef FindExecutable   // needed on windows :(
  69 std::string llvm::FindExecutable(const std::string &ExeName,
  70                                  const std::string &ProgramPath) {
  71   // First check the directory that bugpoint is in.  We can do this if
  72   // BugPointPath contains at least one / character, indicating that it is a
  73   // relative path to bugpoint itself.
  74   //
  75   std::string Result = ProgramPath;
  76   while (!Result.empty() && Result[Result.size()-1] != '/')
  77     Result.erase(Result.size()-1, 1);
  78
  79   if (!Result.empty()) {
  80     Result += ExeName;
  81     if (isExecutableFile(Result)) return Result; // Found it?
  82   }
  83
  84   // Okay, if the path to the program didn't tell us anything, try using the
  85   // PATH environment variable.
  86   const char *PathStr = getenv("PATH");
  87   if (PathStr == 0) return "";
  88
  89   // Now we have a colon separated list of directories to search... try them...
  90   unsigned PathLen = strlen(PathStr);
  91   while (PathLen) {
  92     // Find the first colon...
  93     const char *Colon = std::find(PathStr, PathStr+PathLen, ':');
  94
  95     // Check to see if this first directory contains the executable...
  96     std::string FilePath = std::string(PathStr, Colon) + '/' + ExeName;
  97     if (isExecutableFile(FilePath))
  98       return FilePath;                    // Found the executable!
  99
 100     // Nope it wasn't in this directory, check the next range!
 101     PathLen -= Colon-PathStr;
 102     PathStr = Colon;
 103     while (*PathStr == ':') {   // Advance past colons
 104       PathStr++;
 105       PathLen--;
 106     }
 107   }
 108
 109   // If we fell out, we ran out of directories in PATH to search, return failure
 110   return "";
 111 }
 112
 113 static void RedirectFD(const std::string &File, int FD) {
 114   if (File.empty()) return;  // Noop
 115
 116   // Open the file
 117   int InFD = open(File.c_str(), FD == 0 ? O_RDONLY : O_WRONLY|O_CREAT, 0666);
 118   if (InFD == -1) {
 119     std::cerr << "Error opening file '" << File << "' for "
 120               << (FD == 0 ? "input" : "output") << "!\n";
 121     exit(1);
 122   }
 123
 124   dup2(InFD, FD);   // Install it as the requested FD
 125   close(InFD);      // Close the original FD
 126 }
 127
 128 /// RunProgramWithTimeout - This function executes the specified program, with
 129 /// the specified null-terminated argument array, with the stdin/out/err fd's
 130 /// redirected, with a timeout specified on the command line.  This terminates
 131 /// the calling program if there is an error executing the specified program.
 132 /// It returns the return value of the program, or -1 if a timeout is detected.
 133 ///
 134 int llvm::RunProgramWithTimeout(const std::string &ProgramPath,
 135                                 const char **Args,
 136                                 const std::string &StdInFile,
 137                                 const std::string &StdOutFile,
 138                                 const std::string &StdErrFile) {
 139   // FIXME: install sigalarm handler here for timeout...
 140
 141 #ifdef HAVE_SYS_WAIT_H
 142   int Child = fork();
 143   switch (Child) {
 144   case -1:
 145     std::cerr << "ERROR forking!\n";
 146     exit(1);
 147   case 0:               // Child
 148     RedirectFD(StdInFile, 0);      // Redirect file descriptors...
 149     RedirectFD(StdOutFile, 1);
 150     if (StdOutFile != StdErrFile)
 151       RedirectFD(StdErrFile, 2);
 152     else
 153       dup2(1, 2);
 154
 155     execv(ProgramPath.c_str(), (char *const *)Args);
 156     std::cerr << "Error executing program: '" << ProgramPath;
 157     for (; *Args; ++Args)
 158       std::cerr << " " << *Args;
 159     std::cerr << "'\n";
 160     exit(1);
 161
 162   default: break;
 163   }
 164
 165   // Make sure all output has been written while waiting
 166   std::cout << std::flush;
 167
 168   int Status;
 169   if (wait(&Status) != Child) {
 170     if (errno == EINTR) {
 171       static bool FirstTimeout = true;
 172       if (FirstTimeout) {
 173         std::cout <<
 174  "*** Program execution timed out!  This mechanism is designed to handle\n"
 175  "    programs stuck in infinite loops gracefully.  The -timeout option\n"
 176  "    can be used to change the timeout threshold or disable it completely\n"
 177  "    (with -timeout=0).  This message is only displayed once.\n";
 178         FirstTimeout = false;
 179       }
 180       return -1;   // Timeout detected
 181     }
 182
 183     std::cerr << "Error waiting for child process!\n";
 184     exit(1);
 185   }
 186   return Status;
 187
 188 #else
 189   std::cerr << "RunProgramWithTimeout not implemented on this platform!\n";
 190   return -1;
 191 #endif
 192 }
 193
 194
 195 // ExecWait - executes a program with the specified arguments and environment.
 196 // It then waits for the progarm to termiante and then returns to the caller.
 197 //
 198 // Inputs:
 199 //  argv - The arguments to the program as an array of C strings.  The first
 200 //         argument should be the name of the program to execute, and the
 201 //         last argument should be a pointer to NULL.
 202 //
 203 //  envp - The environment passes to the program as an array of C strings in
 204 //         the form of "name=value" pairs.  The last element should be a
 205 //         pointer to NULL.
 206 //
 207 // Outputs:
 208 //  None.
 209 //
 210 // Return value:
 211 //  0 - No errors.
 212 //  1 - The program could not be executed.
 213 //  1 - The program returned a non-zero exit status.
 214 //  1 - The program terminated abnormally.
 215 //
 216 // Notes:
 217 //  The program will inherit the stdin, stdout, and stderr file descriptors
 218 //  as well as other various configuration settings (umask).
 219 //
 220 //  This function should not print anything to stdout/stderr on its own.  It is
 221 //  a generic library function.  The caller or executed program should report
 222 //  errors in the way it sees fit.
 223 //
 224 //  This function does not use $PATH to find programs.
 225 //
 226 int llvm::ExecWait(const char * const old_argv[],
 227                    const char * const old_envp[]) {
 228 #ifdef HAVE_SYS_WAIT_H
 229   // Create local versions of the parameters that can be passed into execve()
 230   // without creating const problems.
 231   char ** const argv = (char ** const) old_argv;
 232   char ** const envp = (char ** const) old_envp;
 233
 234   // Create a child process.
 235   switch (fork()) {
 236     // An error occured:  Return to the caller.
 237     case -1:
 238       return 1;
 239       break;
 240
 241     // Child process: Execute the program.
 242     case 0:
 243       execve (argv[0], argv, envp);
 244       // If the execve() failed, we should exit and let the parent pick up
 245       // our non-zero exit status.
 246       exit (1);
 247
 248     // Parent process: Break out of the switch to do our processing.
 249     default:
 250       break;
 251   }
 252
 253   // Parent process: Wait for the child process to terminate.
 254   int status;
 255   if ((wait (&status)) == -1)
 256     return 1;
 257
 258   // If the program exited normally with a zero exit status, return success!
 259   if (WIFEXITED (status) && (WEXITSTATUS(status) == 0))
 260     return 0;
 261 #else
 262   std::cerr << "llvm::ExecWait not implemented on this platform!\n";
 263 #endif
 264
 265   // Otherwise, return failure.
 266   return 1;
 267 }
 268
 269 /// AllocateRWXMemory - Allocate a slab of memory with read/write/execute
 270 /// permissions.  This is typically used for JIT applications where we want
 271 /// to emit code to the memory then jump to it.  Getting this type of memory
 272 /// is very OS specific.
 273 ///
 274 void *llvm::AllocateRWXMemory(unsigned NumBytes) {
 275   if (NumBytes == 0) return 0;
 276
 277 #if defined(HAVE_WINDOWS_H)
 278   // On windows we use VirtualAlloc.
 279   void *P = VirtualAlloc(0, NumBytes, MEM_COMMIT, PAGE_EXECUTE_READWRITE);
 280   if (P == 0) {
 281     std::cerr << "Error allocating executable memory!\n";
 282     abort();
 283   }
 284   return P;
 285
 286 #elif defined(HAVE_MMAP)
 287   static const long pageSize = GetPageSize();
 288   unsigned NumPages = (NumBytes+pageSize-1)/pageSize;
 289
 290 /* FIXME: This should use the proper autoconf flags */
 291 #if defined(i386) || defined(__i386__) || defined(__x86__)
 292   /* Linux and *BSD tend to have these flags named differently. */
 293 #if defined(MAP_ANON) && !defined(MAP_ANONYMOUS)
 294 # define MAP_ANONYMOUS MAP_ANON
 295 #endif /* defined(MAP_ANON) && !defined(MAP_ANONYMOUS) */
 296 #elif defined(sparc) || defined(__sparc__) || defined(__sparcv9)
 297 /* nothing */
 298 #else
 299   std::cerr << "This architecture has an unknown MMAP implementation!\n";
 300   abort();
 301   return 0;
 302 #endif
 303
 304   int fd = -1;
 305 #if defined(__linux__)
 306   fd = 0;
 307 #endif
 308
 309   unsigned mmapFlags = MAP_PRIVATE|MAP_ANONYMOUS;
 310 #ifdef MAP_NORESERVE
 311   mmapFlags |= MAP_NORESERVE;
 312 #endif
 313
 314   void *pa = mmap(0, pageSize*NumPages, PROT_READ|PROT_WRITE|PROT_EXEC,
 315                   mmapFlags, fd, 0);
 316   if (pa == MAP_FAILED) {
 317     perror("mmap");
 318     abort();
 319   }
 320   return pa;
 321 #else
 322   std::cerr << "Do not know how to allocate mem for the JIT without mmap!\n";
 323   abort();
 324   return 0;
 325 #endif
 326 }
 327
 328