Most stack straces don't need 3 digits worth of levels.
[oota-llvm.git] / lib / System / Unix / Path.inc
index 9f4b5914ce0e2450d10b1e3af8a5a3b784735589..89285b48132f98cf93432aada0138048c8dfb651 100644 (file)
@@ -1,10 +1,10 @@
 //===- llvm/System/Unix/Path.cpp - Unix Path Implementation -----*- C++ -*-===//
-// 
+//
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
-// 
+//
 //===----------------------------------------------------------------------===//
 //
 // This file implements the Unix specific portion of the Path class.
@@ -16,7 +16,7 @@
 //===          is guaranteed to work on *all* UNIX variants.
 //===----------------------------------------------------------------------===//
 
-#include "llvm/Config/alloca.h"
+#include "llvm/ADT/SmallVector.h"
 #include "Unix.h"
 #if HAVE_SYS_STAT_H
 #include <sys/stat.h>
 #include <dlfcn.h>
 #endif
 
+#ifdef __APPLE__
+#include <mach-o/dyld.h>
+#endif
+
 // Put in a hack for Cygwin which falsely reports that the mkdtemp function
 // is available when it is not.
 #ifdef __CYGWIN__
@@ -75,28 +79,53 @@ using namespace sys;
 
 extern const char sys::PathSeparator = ':';
 
-bool 
+Path::Path(const std::string& p)
+  : path(p) {}
+
+Path::Path(const char *StrStart, unsigned StrLen)
+  : path(StrStart, StrLen) {}
+
+Path&
+Path::operator=(const std::string &that) {
+  path = that;
+  return *this;
+}
+
+bool
 Path::isValid() const {
   // Check some obvious things
-  if (path.empty()) 
-    return false;
-  else if (path.length() >= MAXPATHLEN)
+  if (path.empty())
     return false;
+  return path.length() < MAXPATHLEN;
+}
 
-  // Check that the characters are ascii chars
-  size_t len = path.length();
-  unsigned i = 0;
-  while (i < len && isascii(path[i])) 
-    ++i;
-  return i >= len; 
+bool
+Path::isAbsolute(const char *NameStart, unsigned NameLen) {
+  assert(NameStart);
+  if (NameLen == 0)
+    return false;
+  return NameStart[0] == '/';
 }
 
-bool 
+bool
 Path::isAbsolute() const {
   if (path.empty())
     return false;
   return path[0] == '/';
-} 
+}
+
+void Path::makeAbsolute() {
+  if (isAbsolute())
+    return;
+
+  Path CWD = Path::GetCurrentDirectory();
+  assert(CWD.isAbsolute() && "GetCurrentDirectory returned relative path!");
+
+  CWD.appendComponent(path);
+
+  path = CWD.str();
+}
+
 Path
 Path::GetRootDirectory() {
   Path result;
@@ -105,14 +134,14 @@ Path::GetRootDirectory() {
 }
 
 Path
-Path::GetTemporaryDirectory(std::string* ErrMsg ) {
+Path::GetTemporaryDirectory(std::string *ErrMsg) {
 #if defined(HAVE_MKDTEMP)
-  // The best way is with mkdtemp but that's not available on many systems, 
+  // The best way is with mkdtemp but that's not available on many systems,
   // Linux and FreeBSD have it. Others probably won't.
   char pathname[MAXPATHLEN];
   strcpy(pathname,"/tmp/llvm_XXXXXX");
   if (0 == mkdtemp(pathname)) {
-    MakeErrMsg(ErrMsg, 
+    MakeErrMsg(ErrMsg,
       std::string(pathname) + ": can't create temporary directory");
     return Path();
   }
@@ -125,19 +154,19 @@ Path::GetTemporaryDirectory(std::string* ErrMsg ) {
   // which is then removed and created as a directory. We prefer this over
   // mktemp because of mktemp's inherent security and threading risks. We still
   // have a slight race condition from the time the temporary file is created to
-  // the time it is re-created as a directoy. 
+  // the time it is re-created as a directoy.
   char pathname[MAXPATHLEN];
   strcpy(pathname, "/tmp/llvm_XXXXXX");
   int fd = 0;
   if (-1 == (fd = mkstemp(pathname))) {
-    MakeErrMsg(ErrMsg, 
+    MakeErrMsg(ErrMsg,
       std::string(pathname) + ": can't create temporary directory");
     return Path();
   }
   ::close(fd);
   ::unlink(pathname); // start race condition, ignore errors
   if (-1 == ::mkdir(pathname, S_IRWXU)) { // end race condition
-    MakeErrMsg(ErrMsg, 
+    MakeErrMsg(ErrMsg,
       std::string(pathname) + ": can't create temporary directory");
     return Path();
   }
@@ -155,12 +184,12 @@ Path::GetTemporaryDirectory(std::string* ErrMsg ) {
   strcpy(pathname, "/tmp/llvm_XXXXXX");
   char *TmpName = ::mktemp(pathname);
   if (TmpName == 0) {
-    MakeErrMsg(ErrMsg, 
+    MakeErrMsg(ErrMsg,
       std::string(TmpName) + ": can't create unique directory name");
     return Path();
   }
   if (-1 == ::mkdir(TmpName, S_IRWXU)) {
-    MakeErrMsg(ErrMsg, 
+    MakeErrMsg(ErrMsg,
         std::string(TmpName) + ": can't create temporary directory");
     return Path();
   }
@@ -172,7 +201,7 @@ Path::GetTemporaryDirectory(std::string* ErrMsg ) {
   // This is the worst case implementation. tempnam(3) leaks memory unless its
   // on an SVID2 (or later) system. On BSD 4.3 it leaks. tmpnam(3) has thread
   // issues. The mktemp(3) function doesn't have enough variability in the
-  // temporary name generated. So, we provide our own implementation that 
+  // temporary name generated. So, we provide our own implementation that
   // increments an integer from a random number seeded by the current time. This
   // should be sufficiently unique that we don't have many collisions between
   // processes. Generally LLVM processes don't run very long and don't use very
@@ -184,7 +213,7 @@ Path::GetTemporaryDirectory(std::string* ErrMsg ) {
     sprintf(pathname, "/tmp/llvm_%010u", unsigned(num));
   } while ( 0 == access(pathname, F_OK ) );
   if (-1 == ::mkdir(pathname, S_IRWXU)) {
-    MakeErrMsg(ErrMsg, 
+    MakeErrMsg(ErrMsg,
       std::string(pathname) + ": can't create temporary directory");
     return Path();
   }
@@ -195,7 +224,7 @@ Path::GetTemporaryDirectory(std::string* ErrMsg ) {
 #endif
 }
 
-void 
+void
 Path::GetSystemLibraryPaths(std::vector<sys::Path>& Paths) {
 #ifdef LTDL_SHLIBPATH_VAR
   char* env_var = getenv(LTDL_SHLIBPATH_VAR);
@@ -227,7 +256,7 @@ Path::GetBitcodeLibraryPaths(std::vector<sys::Path>& Paths) {
   GetSystemLibraryPaths(Paths);
 }
 
-Path 
+Path
 Path::GetLLVMDefaultConfigDir() {
   return Path("/etc/llvm/");
 }
@@ -250,28 +279,98 @@ Path::GetCurrentDirectory() {
     assert (false && "Could not query current working directory.");
     return Path("");
   }
-  
+
   return Path(pathname);
 }
 
+#ifdef __FreeBSD__
+static int
+test_dir(char buf[PATH_MAX], char ret[PATH_MAX],
+    const char *dir, const char *bin)
+{
+  struct stat sb;
+
+  snprintf(buf, PATH_MAX, "%s//%s", dir, bin);
+  if (realpath(buf, ret) == NULL)
+    return (1);
+  if (stat(buf, &sb) != 0)
+    return (1);
+
+  return (0);
+}
+
+static char *
+getprogpath(char ret[PATH_MAX], const char *bin)
+{
+  char *pv, *s, *t, buf[PATH_MAX];
+
+  /* First approach: absolute path. */
+  if (bin[0] == '/') {
+    if (test_dir(buf, ret, "/", bin) == 0)
+      return (ret);
+    return (NULL);
+  }
+
+  /* Second approach: relative path. */
+  if (strchr(bin, '/') != NULL) {
+    if (getcwd(buf, PATH_MAX) == NULL)
+      return (NULL);
+    if (test_dir(buf, ret, buf, bin) == 0)
+      return (ret);
+    return (NULL);
+  }
+
+  /* Third approach: $PATH */
+  if ((pv = getenv("PATH")) == NULL)
+    return (NULL);
+  s = pv = strdup(pv);
+  if (pv == NULL)
+    return (NULL);
+  while ((t = strsep(&s, ":")) != NULL) {
+    if (test_dir(buf, ret, t, bin) == 0) {
+      free(pv);
+      return (ret);
+    }
+  }
+  free(pv);
+  return (NULL);
+}
+#endif
+
 /// GetMainExecutable - Return the path to the main executable, given the
 /// value of argv[0] from program startup.
 Path Path::GetMainExecutable(const char *argv0, void *MainAddr) {
-#if defined(__CYGWIN__)
-  char exe_link[64];
-  snprintf(exe_link, sizeof(exe_link), "/proc/%d/exe", getpid());
+#if defined(__APPLE__)
+  // On OS X the executable path is saved to the stack by dyld. Reading it
+  // from there is much faster than calling dladdr, especially for large
+  // binaries with symbols.
   char exe_path[MAXPATHLEN];
-  ssize_t len = readlink(exe_link, exe_path, sizeof(exe_path));
-  if (len > 0 && len < MAXPATHLEN - 1) {
-    exe_path[len] = '\0';
-    return Path(std::string(exe_path));
+  uint32_t size = sizeof(exe_path);
+  if (_NSGetExecutablePath(exe_path, &size) == 0) {
+    char link_path[MAXPATHLEN];
+    return Path(std::string(realpath(exe_path, link_path)));
   }
+#elif defined(__FreeBSD__)
+  char exe_path[PATH_MAX];
+
+  if (getprogpath(exe_path, argv0) != NULL)
+    return Path(std::string(exe_path));
+#elif defined(__linux__) || defined(__CYGWIN__)
+  char exe_path[MAXPATHLEN];
+  ssize_t len = readlink("/proc/self/exe", exe_path, sizeof(exe_path));
+  if (len >= 0)
+    return Path(std::string(exe_path, len));
 #elif defined(HAVE_DLFCN_H)
   // Use dladdr to get executable path if available.
   Dl_info DLInfo;
   int err = dladdr(MainAddr, &DLInfo);
-  if (err != 0)
-    return Path(std::string(DLInfo.dli_fname));
+  if (err == 0)
+    return Path();
+
+  // If the filename is a symlink, we need to resolve and return the location of
+  // the actual executable.
+  char link_path[MAXPATHLEN];
+  return Path(std::string(realpath(DLInfo.dli_fname, link_path)));
 #endif
   return Path();
 }
@@ -297,9 +396,27 @@ Path::getBasename() const {
     return path.substr(slash, dot - slash);
 }
 
+std::string
+Path::getSuffix() const {
+  // Find the last slash
+  std::string::size_type slash = path.rfind('/');
+  if (slash == std::string::npos)
+    slash = 0;
+  else
+    slash++;
+
+  std::string::size_type dot = path.rfind('.');
+  if (dot == std::string::npos || dot < slash)
+    return std::string();
+  else
+    return path.substr(dot + 1);
+}
+
 bool Path::getMagicNumber(std::string& Magic, unsigned len) const {
   assert(len < 1024 && "Request for magic string too long");
-  char* buf = (char*) alloca(1 + len);
+  SmallVector<char, 128> Buf;
+  Buf.resize(1 + len);
+  char* buf = Buf.data();
   int fd = ::open(path.c_str(), O_RDONLY);
   if (fd < 0)
     return false;
@@ -328,12 +445,12 @@ Path::isDirectory() const {
 
 bool
 Path::canRead() const {
-  return 0 == access(path.c_str(), F_OK | R_OK );
+  return 0 == access(path.c_str(), R_OK);
 }
 
 bool
 Path::canWrite() const {
-  return 0 == access(path.c_str(), F_OK | W_OK );
+  return 0 == access(path.c_str(), W_OK);
 }
 
 bool
@@ -348,7 +465,7 @@ Path::canExecute() const {
   return true;
 }
 
-std::string 
+std::string
 Path::getLast() const {
   // Find the last slash
   size_t pos = path.rfind('/');
@@ -401,7 +518,7 @@ static bool AddPermissionBits(const Path &File, int bits) {
 
   // Get the file's current mode.
   struct stat buf;
-  if (0 != stat(File.toString().c_str(), &buf)) 
+  if (0 != stat(File.c_str(), &buf))
     return false;
   // Change the file to have whichever permissions bits from 'bits'
   // that the umask would not disable.
@@ -411,7 +528,7 @@ static bool AddPermissionBits(const Path &File, int bits) {
 }
 
 bool Path::makeReadableOnDisk(std::string* ErrMsg) {
-  if (!AddPermissionBits(*this, 0444)) 
+  if (!AddPermissionBits(*this, 0444))
     return MakeErrMsg(ErrMsg, path + ": can't make file readable");
   return false;
 }
@@ -447,13 +564,13 @@ Path::getDirectoryContents(std::set<Path>& result, std::string* ErrMsg) const {
       if (0 != lstat(aPath.path.c_str(), &st)) {
         if (S_ISLNK(st.st_mode))
           continue; // dangling symlink -- ignore
-        return MakeErrMsg(ErrMsg, 
+        return MakeErrMsg(ErrMsg,
                           aPath.path +  ": can't determine file object type");
       }
       result.insert(aPath);
     }
   }
-  
+
   closedir(direntries);
   return false;
 }
@@ -532,30 +649,30 @@ Path::eraseSuffix() {
 }
 
 static bool createDirectoryHelper(char* beg, char* end, bool create_parents) {
-  
-  if (access(beg, F_OK | R_OK | W_OK) == 0)
+
+  if (access(beg, R_OK | W_OK) == 0)
     return false;
-    
+
   if (create_parents) {
-    
+
     char* c = end;
-        
+
     for (; c != beg; --c)
       if (*c == '/') {
-        
+
         // Recurse to handling the parent directory.
-        *c = '\0';          
+        *c = '\0';
         bool x = createDirectoryHelper(beg, c, create_parents);
         *c = '/';
-        
+
         // Return if we encountered an error.
         if (x)
           return true;
-          
+
         break;
       }
-  }      
-  
+  }
+
   return mkdir(beg, S_IRWXU | S_IRWXG) != 0;
 }
 
@@ -567,16 +684,16 @@ Path::createDirectoryOnDisk( bool create_parents, std::string* ErrMsg ) {
 
   // Null-terminate the last component
   size_t lastchar = path.length() - 1 ;
-  
+
   if (pathname[lastchar] != '/')
     ++lastchar;
-    
+
   pathname[lastchar] = 0;
-    
+
   if (createDirectoryHelper(pathname, pathname+lastchar, create_parents))
-    return MakeErrMsg(ErrMsg, 
+    return MakeErrMsg(ErrMsg,
                       std::string(pathname) + ": can't create directory");
-  
+
   return false;
 }
 
@@ -598,7 +715,7 @@ Path::createTemporaryFileOnDisk(bool reuse_current, std::string* ErrMsg) {
 
   // create the file
   int fd = ::open(path.c_str(), O_WRONLY|O_CREAT|O_TRUNC, 0666);
-  if (fd < 0) 
+  if (fd < 0)
     return MakeErrMsg(ErrMsg, path + ": can't create temporary file");
   ::close(fd);
   return false;
@@ -613,17 +730,17 @@ Path::eraseFromDisk(bool remove_contents, std::string *ErrStr) const {
     return true;
   }
 
-  // Note: this check catches strange situations. In all cases, LLVM should 
-  // only be involved in the creation and deletion of regular files.  This 
-  // check ensures that what we're trying to erase is a regular file. It 
-  // effectively prevents LLVM from erasing things like /dev/null, any block 
-  // special file, or other things that aren't "regular" files. 
+  // Note: this check catches strange situations. In all cases, LLVM should
+  // only be involved in the creation and deletion of regular files.  This
+  // check ensures that what we're trying to erase is a regular file. It
+  // effectively prevents LLVM from erasing things like /dev/null, any block
+  // special file, or other things that aren't "regular" files.
   if (S_ISREG(buf.st_mode)) {
     if (unlink(path.c_str()) != 0)
       return MakeErrMsg(ErrStr, path + ": can't destroy file");
     return false;
   }
-  
+
   if (!S_ISDIR(buf.st_mode)) {
     if (ErrStr) *ErrStr = "not a file or directory";
     return true;
@@ -632,7 +749,10 @@ Path::eraseFromDisk(bool remove_contents, std::string *ErrStr) const {
   if (remove_contents) {
     // Recursively descend the directory to remove its contents.
     std::string cmd = "/bin/rm -rf " + path;
-    system(cmd.c_str());
+    if (system(cmd.c_str()) != 0) {
+      MakeErrMsg(ErrStr, path + ": failed to recursively remove directory.");
+      return true;
+    }
     return false;
   }
 
@@ -640,13 +760,13 @@ Path::eraseFromDisk(bool remove_contents, std::string *ErrStr) const {
   char pathname[MAXPATHLEN];
   path.copy(pathname, MAXPATHLEN);
   size_t lastchar = path.length() - 1;
-  if (pathname[lastchar] == '/') 
+  if (pathname[lastchar] == '/')
     pathname[lastchar] = 0;
   else
     pathname[lastchar+1] = 0;
-    
+
   if (rmdir(pathname) != 0)
-    return MakeErrMsg(ErrStr, 
+    return MakeErrMsg(ErrStr,
       std::string(pathname) + ": can't erase directory");
   return false;
 }
@@ -654,12 +774,12 @@ Path::eraseFromDisk(bool remove_contents, std::string *ErrStr) const {
 bool
 Path::renamePathOnDisk(const Path& newName, std::string* ErrMsg) {
   if (0 != ::rename(path.c_str(), newName.c_str()))
-    return MakeErrMsg(ErrMsg, std::string("can't rename '") + path + "' as '" + 
-               newName.toString() + "' ");
+    return MakeErrMsg(ErrMsg, std::string("can't rename '") + path + "' as '" +
+               newName.str() + "'");
   return false;
 }
 
-bool 
+bool
 Path::setStatusInfoOnDisk(const FileStatus &si, std::string *ErrStr) const {
   struct utimbuf utb;
   utb.actime = si.modTime.toPosixTime();
@@ -671,19 +791,19 @@ Path::setStatusInfoOnDisk(const FileStatus &si, std::string *ErrStr) const {
   return false;
 }
 
-bool 
+bool
 sys::CopyFile(const sys::Path &Dest, const sys::Path &Src, std::string* ErrMsg){
   int inFile = -1;
   int outFile = -1;
   inFile = ::open(Src.c_str(), O_RDONLY);
   if (inFile == -1)
-    return MakeErrMsg(ErrMsg, Src.toString() + 
+    return MakeErrMsg(ErrMsg, Src.str() +
       ": can't open source file to copy");
 
   outFile = ::open(Dest.c_str(), O_WRONLY|O_CREAT, 0666);
   if (outFile == -1) {
     ::close(inFile);
-    return MakeErrMsg(ErrMsg, Dest.toString() +
+    return MakeErrMsg(ErrMsg, Dest.str() +
       ": can't create destination file for copy");
   }
 
@@ -693,7 +813,7 @@ sys::CopyFile(const sys::Path &Dest, const sys::Path &Src, std::string* ErrMsg){
       if (errno != EINTR && errno != EAGAIN) {
         ::close(inFile);
         ::close(outFile);
-        return MakeErrMsg(ErrMsg, Src.toString()+": can't read source file: ");
+        return MakeErrMsg(ErrMsg, Src.str()+": can't read source file");
       }
     } else {
       char *BufPtr = Buffer;
@@ -703,8 +823,8 @@ sys::CopyFile(const sys::Path &Dest, const sys::Path &Src, std::string* ErrMsg){
           if (errno != EINTR && errno != EAGAIN) {
             ::close(inFile);
             ::close(outFile);
-            return MakeErrMsg(ErrMsg, Dest.toString() + 
-              ": can't write destination file");
+            return MakeErrMsg(ErrMsg, Dest.str() +
+              ": can't write destination file");
           }
         } else {
           Amt -= AmtWritten;
@@ -718,16 +838,21 @@ sys::CopyFile(const sys::Path &Dest, const sys::Path &Src, std::string* ErrMsg){
   return false;
 }
 
-bool 
+bool
 Path::makeUnique(bool reuse_current, std::string* ErrMsg) {
   if (reuse_current && !exists())
     return false; // File doesn't exist already, just use it!
 
-  // Append an XXXXXX pattern to the end of the file for use with mkstemp, 
+  // Append an XXXXXX pattern to the end of the file for use with mkstemp,
   // mktemp or our own implementation.
-  char *FNBuffer = (char*) alloca(path.size()+8);
-  path.copy(FNBuffer,path.size());
-  strcpy(FNBuffer+path.size(), "-XXXXXX");
+  SmallVector<char, 128> Buf;
+  Buf.resize(path.size()+8);
+  char *FNBuffer = Buf.data();
+    path.copy(FNBuffer,path.size());
+  if (isDirectory())
+    strcpy(FNBuffer+path.size(), "/XXXXXX");
+  else
+    strcpy(FNBuffer+path.size(), "-XXXXXX");
 
 #if defined(HAVE_MKSTEMP)
   int TempFD;
@@ -756,7 +881,7 @@ Path::makeUnique(bool reuse_current, std::string* ErrMsg) {
     path = FNBuffer;
   }
   if (FCounter > 999999)
-    return MakeErrMsg(ErrMsg, 
+    return MakeErrMsg(ErrMsg,
       path + ": can't make unique filename: too many files");
 #endif
   return false;
@@ -778,4 +903,3 @@ void Path::UnMapFilePages(const char *BasePtr, uint64_t FileSize) {
 }
 
 } // end llvm namespace
-