Allow any cl::opt to use the method getPosition() to retrieve the option's
[oota-llvm.git] / lib / Support / SystemUtils.cpp
index c88a516e9f38ce3053ffb49799122e188cf2d086..b831f4096d0f4facbc7b73c1902e333b0433c5e7 100644 (file)
@@ -1,60 +1,39 @@
-//===- SystemUtils.h - Utilities to do low-level system stuff --*- C++ -*--===//
+//===- SystemUtils.cpp - Utilities for low-level system tasks -------------===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
 //
 // This file contains functions used to do a variety of low-level, often
 // system-specific, tasks.
 //
 //===----------------------------------------------------------------------===//
 
-#include "SystemUtils.h"
+#define _POSIX_MAPPED_FILES
+#include "Support/SystemUtils.h"
+#include "Config/fcntl.h"
+#include "Config/pagesize.h"
+#include "Config/unistd.h"
+#include "Config/windows.h"
+#include "Config/sys/mman.h"
+#include "Config/sys/stat.h"
+#include "Config/sys/types.h"
+#include "Config/sys/wait.h"
 #include <algorithm>
+#include <cerrno>
+#include <cstdlib>
 #include <fstream>
 #include <iostream>
-#include <cstdlib>
-#include "Support/Alloca.h"
-#include <sys/types.h>
-#include <sys/stat.h>
-#include <fcntl.h>
-#include <sys/wait.h>
-#include <unistd.h>
-#include <errno.h>
-
-/// removeFile - Delete the specified file
-///
-void removeFile(const std::string &Filename) {
-  unlink(Filename.c_str());
-}
-
-/// getUniqueFilename - Return a filename with the specified prefix.  If the
-/// file does not exist yet, return it, otherwise add a suffix to make it
-/// unique.
-///
-std::string getUniqueFilename(const std::string &FilenameBase) {
-  if (!std::ifstream(FilenameBase.c_str()))
-    return FilenameBase;    // Couldn't open the file? Use it!
-
-  // Create a pattern for mkstemp...
-  char *FNBuffer = (char*)alloca(FilenameBase.size()+8);
-  strcpy(FNBuffer, FilenameBase.c_str());
-  strcpy(FNBuffer+FilenameBase.size(), "-XXXXXX");
-
-  // Agree on a temporary file name to use....
-  int TempFD;
-  if ((TempFD = mkstemp(FNBuffer)) == -1) {
-    std::cerr << "bugpoint: ERROR: Cannot create temporary file in the current "
-             << " directory!\n";
-    exit(1);
-  }
-
-  // We don't need to hold the temp file descriptor... we will trust that noone
-  // will overwrite/delete the file while we are working on it...
-  close(TempFD);
-  return FNBuffer;
-}
+#include <signal.h>
+using namespace llvm;
 
 /// isExecutableFile - This function returns true if the filename specified
 /// exists and is executable.
 ///
-bool isExecutableFile(const std::string &ExeFileName) {
+bool llvm::isExecutableFile(const std::string &ExeFileName) {
   struct stat Buf;
   if (stat(ExeFileName.c_str(), &Buf))
     return false;  // Must not be executable!
@@ -70,18 +49,31 @@ bool isExecutableFile(const std::string &ExeFileName) {
     return Buf.st_mode & S_IXOTH;
 }
 
+/// isStandardOutAConsole - Return true if we can tell that the standard output
+/// stream goes to a terminal window or console.
+bool llvm::isStandardOutAConsole() {
+#if HAVE_ISATTY
+  return isatty(1);
+#endif
+  // If we don't have isatty, just return false.
+  return false;
+}
 
-// FindExecutable - Find a named executable, giving the argv[0] of bugpoint.
-// This assumes the executable is in the same directory as bugpoint itself.
-// If the executable cannot be found, return an empty string.
-//
-std::string FindExecutable(const std::string &ExeName,
-                          const std::string &BugPointPath) {
+
+/// FindExecutable - Find a named executable, giving the argv[0] of program
+/// being executed. This allows us to find another LLVM tool if it is built
+/// into the same directory, but that directory is neither the current
+/// directory, nor in the PATH.  If the executable cannot be found, return an
+/// empty string.
+/// 
+#undef FindExecutable   // needed on windows :(
+std::string llvm::FindExecutable(const std::string &ExeName,
+                                 const std::string &ProgramPath) {
   // First check the directory that bugpoint is in.  We can do this if
   // BugPointPath contains at least one / character, indicating that it is a
   // relative path to bugpoint itself.
   //
-  std::string Result = BugPointPath;
+  std::string Result = ProgramPath;
   while (!Result.empty() && Result[Result.size()-1] != '/')
     Result.erase(Result.size()-1, 1);
 
@@ -90,12 +82,12 @@ std::string FindExecutable(const std::string &ExeName,
     if (isExecutableFile(Result)) return Result; // Found it?
   }
 
-  // Okay, if the path to bugpoint didn't tell us anything, try using the PATH
-  // environment variable.
+  // Okay, if the path to the program didn't tell us anything, try using the
+  // PATH environment variable.
   const char *PathStr = getenv("PATH");
   if (PathStr == 0) return "";
 
-  // Now we have a colon seperated list of directories to search... try them...
+  // Now we have a colon separated list of directories to search... try them...
   unsigned PathLen = strlen(PathStr);
   while (PathLen) {
     // Find the first colon...
@@ -126,7 +118,7 @@ static void RedirectFD(const std::string &File, int FD) {
   int InFD = open(File.c_str(), FD == 0 ? O_RDONLY : O_WRONLY|O_CREAT, 0666);
   if (InFD == -1) {
     std::cerr << "Error opening file '" << File << "' for "
-             << (FD == 0 ? "input" : "output") << "!\n";
+              << (FD == 0 ? "input" : "output") << "!\n";
     exit(1);
   }
 
@@ -134,19 +126,24 @@ static void RedirectFD(const std::string &File, int FD) {
   close(InFD);      // Close the original FD
 }
 
+static bool Timeout = false;
+static void TimeOutHandler(int Sig) {
+  Timeout = true;
+}
+
 /// RunProgramWithTimeout - This function executes the specified program, with
 /// the specified null-terminated argument array, with the stdin/out/err fd's
-/// redirected, with a timeout specified on the commandline.  This terminates
+/// redirected, with a timeout specified by the last argument.  This terminates
 /// the calling program if there is an error executing the specified program.
 /// It returns the return value of the program, or -1 if a timeout is detected.
 ///
-int RunProgramWithTimeout(const std::string &ProgramPath, const char **Args,
-                         const std::string &StdInFile,
-                         const std::string &StdOutFile,
-                         const std::string &StdErrFile) {
-
-  // FIXME: install sigalarm handler here for timeout...
-
+int llvm::RunProgramWithTimeout(const std::string &ProgramPath,
+                                const char **Args,
+                                const std::string &StdInFile,
+                                const std::string &StdOutFile,
+                                const std::string &StdErrFile,
+                                unsigned NumSeconds) {
+#ifdef HAVE_SYS_WAIT_H
   int Child = fork();
   switch (Child) {
   case -1:
@@ -155,12 +152,16 @@ int RunProgramWithTimeout(const std::string &ProgramPath, const char **Args,
   case 0:               // Child
     RedirectFD(StdInFile, 0);      // Redirect file descriptors...
     RedirectFD(StdOutFile, 1);
-    RedirectFD(StdErrFile, 2);
+    if (StdOutFile != StdErrFile)
+      RedirectFD(StdErrFile, 2);
+    else
+      dup2(1, 2);
 
     execv(ProgramPath.c_str(), (char *const *)Args);
-    std::cerr << "Error executing program '" << ProgramPath;
+    std::cerr << "Error executing program: '" << ProgramPath;
     for (; *Args; ++Args)
       std::cerr << " " << *Args;
+    std::cerr << "'\n";
     exit(1);
 
   default: break;
@@ -169,23 +170,180 @@ int RunProgramWithTimeout(const std::string &ProgramPath, const char **Args,
   // Make sure all output has been written while waiting
   std::cout << std::flush;
 
+  // Install a timeout handler.
+  Timeout = false;
+  struct sigaction Act, Old;
+  Act.sa_sigaction = 0;
+  Act.sa_handler = TimeOutHandler;
+  sigemptyset(&Act.sa_mask);
+  Act.sa_flags = 0;
+  sigaction(SIGALRM, &Act, &Old);
+
+  // Set the timeout if one is set.
+  if (NumSeconds)
+    alarm(NumSeconds);
+
   int Status;
-  if (wait(&Status) != Child) {
+  while (wait(&Status) != Child)
     if (errno == EINTR) {
-      static bool FirstTimeout = true;
-      if (FirstTimeout) {
-       std::cout <<
- "*** Program execution timed out!  This mechanism is designed to handle\n"
- "    programs stuck in infinite loops gracefully.  The -timeout option\n"
- "    can be used to change the timeout threshold or disable it completely\n"
- "    (with -timeout=0).  This message is only displayed once.\n";
-       FirstTimeout = false;
+      if (Timeout) {
+        // Kill the child.
+        kill(Child, SIGKILL);
+        
+        if (wait(&Status) != Child)
+          std::cerr << "Something funny happened waiting for the child!\n";
+        
+        alarm(0);
+        sigaction(SIGALRM, &Old, 0);
+        return -1;   // Timeout detected
+      } else {
+        std::cerr << "Error waiting for child process!\n";
+        exit(1);
       }
-      return -1;   // Timeout detected
     }
 
-    std::cerr << "Error waiting for child process!\n";
-    exit(1);
-  }
+  alarm(0);
+  sigaction(SIGALRM, &Old, 0);
   return Status;
+
+#else
+  std::cerr << "RunProgramWithTimeout not implemented on this platform!\n";
+  return -1;
+#endif
 }
+
+
+// ExecWait - executes a program with the specified arguments and environment.
+// It then waits for the progarm to termiante and then returns to the caller.
+//
+// Inputs:
+//  argv - The arguments to the program as an array of C strings.  The first
+//         argument should be the name of the program to execute, and the
+//         last argument should be a pointer to NULL.
+//
+//  envp - The environment passes to the program as an array of C strings in
+//         the form of "name=value" pairs.  The last element should be a
+//         pointer to NULL.
+//
+// Outputs:
+//  None.
+//
+// Return value:
+//  0 - No errors.
+//  1 - The program could not be executed.
+//  1 - The program returned a non-zero exit status.
+//  1 - The program terminated abnormally.
+//
+// Notes:
+//  The program will inherit the stdin, stdout, and stderr file descriptors
+//  as well as other various configuration settings (umask).
+//
+//  This function should not print anything to stdout/stderr on its own.  It is
+//  a generic library function.  The caller or executed program should report
+//  errors in the way it sees fit.
+//
+//  This function does not use $PATH to find programs.
+//
+int llvm::ExecWait(const char * const old_argv[],
+                   const char * const old_envp[]) {
+#ifdef HAVE_SYS_WAIT_H
+  // Create local versions of the parameters that can be passed into execve()
+  // without creating const problems.
+  char ** const argv = (char ** const) old_argv;
+  char ** const envp = (char ** const) old_envp;
+
+  // Create a child process.
+  switch (fork()) {
+    // An error occured:  Return to the caller.
+    case -1:
+      return 1;
+      break;
+
+    // Child process: Execute the program.
+    case 0:
+      execve (argv[0], argv, envp);
+      // If the execve() failed, we should exit and let the parent pick up
+      // our non-zero exit status.
+      exit (1);
+
+    // Parent process: Break out of the switch to do our processing.
+    default:
+      break;
+  }
+
+  // Parent process: Wait for the child process to terminate.
+  int status;
+  if ((wait (&status)) == -1)
+    return 1;
+
+  // If the program exited normally with a zero exit status, return success!
+  if (WIFEXITED (status) && (WEXITSTATUS(status) == 0))
+    return 0;
+#else
+  std::cerr << "llvm::ExecWait not implemented on this platform!\n";
+#endif
+
+  // Otherwise, return failure.
+  return 1;
+}
+
+/// AllocateRWXMemory - Allocate a slab of memory with read/write/execute
+/// permissions.  This is typically used for JIT applications where we want
+/// to emit code to the memory then jump to it.  Getting this type of memory
+/// is very OS specific.
+///
+void *llvm::AllocateRWXMemory(unsigned NumBytes) {
+  if (NumBytes == 0) return 0;
+
+#if defined(HAVE_WINDOWS_H)
+  // On windows we use VirtualAlloc.
+  void *P = VirtualAlloc(0, NumBytes, MEM_COMMIT, PAGE_EXECUTE_READWRITE);
+  if (P == 0) {
+    std::cerr << "Error allocating executable memory!\n";
+    abort();
+  }
+  return P;
+
+#elif defined(HAVE_MMAP)
+  static const long pageSize = GetPageSize();
+  unsigned NumPages = (NumBytes+pageSize-1)/pageSize;
+
+/* FIXME: This should use the proper autoconf flags */
+#if defined(i386) || defined(__i386__) || defined(__x86__)
+  /* Linux and *BSD tend to have these flags named differently. */
+#if defined(MAP_ANON) && !defined(MAP_ANONYMOUS)
+# define MAP_ANONYMOUS MAP_ANON
+#endif /* defined(MAP_ANON) && !defined(MAP_ANONYMOUS) */
+#elif defined(sparc) || defined(__sparc__) || defined(__sparcv9)
+/* nothing */
+#else
+  std::cerr << "This architecture has an unknown MMAP implementation!\n";
+  abort();
+  return 0;
+#endif
+
+  int fd = -1;
+#if defined(__linux__)
+  fd = 0;
+#endif
+
+  unsigned mmapFlags = MAP_PRIVATE|MAP_ANONYMOUS;
+#ifdef MAP_NORESERVE
+  mmapFlags |= MAP_NORESERVE;
+#endif
+
+  void *pa = mmap(0, pageSize*NumPages, PROT_READ|PROT_WRITE|PROT_EXEC,
+                  mmapFlags, fd, 0);
+  if (pa == MAP_FAILED) {
+    perror("mmap");
+    abort();
+  }
+  return pa;
+#else
+  std::cerr << "Do not know how to allocate mem for the JIT without mmap!\n";
+  abort();
+  return 0;
+#endif
+}
+
+