Add a uniqueID field to the FileStatus structure for Paths. This will map
[oota-llvm.git] / lib / System / Unix / Path.inc
index 2da76e8ad133427fe27d8a9c7945b6c4e537a5c4..5557282964eded2cc28b3c9ee47e756b4e9c1962 100644 (file)
@@ -63,16 +63,6 @@ inline bool lastIsSlash(const std::string& path) {
 namespace llvm {
 using namespace sys;
 
-Path::Path(const std::string& unverified_path) : path(unverified_path) {
-  if (unverified_path.empty())
-    return;
-  if (this->isValid()) 
-    return;
-  // oops, not valid.
-  path.clear();
-  ThrowErrno(unverified_path + ": path is not valid");
-}
-
 bool 
 Path::isValid() const {
   // Check some obvious things
@@ -89,6 +79,12 @@ Path::isValid() const {
   return i >= len; 
 }
 
+bool 
+Path::isAbsolute() const {
+  if (path.empty())
+    return false;
+  return path[0] == '/';
+} 
 Path
 Path::GetRootDirectory() {
   Path result;
@@ -97,14 +93,17 @@ Path::GetRootDirectory() {
 }
 
 Path
-Path::GetTemporaryDirectory() {
+Path::GetTemporaryDirectory(std::string* ErrMsg ) {
 #if defined(HAVE_MKDTEMP)
   // 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))
-    ThrowErrno(std::string(pathname) + ": can't create temporary directory");
+  if (0 == mkdtemp(pathname)) {
+    MakeErrMsg(ErrMsg, 
+      std::string(pathname) + ": can't create temporary directory");
+    return Path();
+  }
   Path result;
   result.set(pathname);
   assert(result.isValid() && "mkdtemp didn't create a valid pathname!");
@@ -118,12 +117,18 @@ Path::GetTemporaryDirectory() {
   char pathname[MAXPATHLEN];
   strcpy(pathname, "/tmp/llvm_XXXXXX");
   int fd = 0;
-  if (-1 == (fd = mkstemp(pathname)))
-    ThrowErrno(std::string(pathname) + ": can't create temporary directory");
+  if (-1 == (fd = mkstemp(pathname))) {
+    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
-    ThrowErrno(std::string(pathname) + ": can't create temporary directory");
+  if (-1 == ::mkdir(pathname, S_IRWXU)) { // end race condition
+    MakeErrMsg(ErrMsg, 
+      std::string(pathname) + ": can't create temporary directory");
+    return Path();
+  }
   Path result;
   result.set(pathname);
   assert(result.isValid() && "mkstemp didn't create a valid pathname!");
@@ -137,10 +142,16 @@ Path::GetTemporaryDirectory() {
   char pathname[MAXPATHLEN];
   strcpy(pathname, "/tmp/llvm_XXXXXX");
   char *TmpName = ::mktemp(pathname);
-  if (TmpName == 0)
-    ThrowErrno(std::string(TmpName) + ": can't create unique directory name");
-  if (-1 == ::mkdir(TmpName, S_IRWXU))
-    ThrowErrno(std::string(TmpName) + ": can't create temporary directory");
+  if (TmpName == 0) {
+    MakeErrMsg(ErrMsg, 
+      std::string(TmpName) + ": can't create unique directory name");
+    return Path();
+  }
+  if (-1 == ::mkdir(TmpName, S_IRWXU)) {
+    MakeErrMsg(ErrMsg, 
+        std::string(TmpName) + ": can't create temporary directory");
+    return Path();
+  }
   Path result;
   result.set(TmpName);
   assert(result.isValid() && "mktemp didn't create a valid pathname!");
@@ -160,8 +171,11 @@ Path::GetTemporaryDirectory() {
     num++;
     sprintf(pathname, "/tmp/llvm_%010u", unsigned(num));
   } while ( 0 == access(pathname, F_OK ) );
-  if (-1 == ::mkdir(pathname, S_IRWXU))
-    ThrowErrno(std::string(pathname) + ": can't create temporary directory");
+  if (-1 == ::mkdir(pathname, S_IRWXU)) {
+    MakeErrMsg(ErrMsg, 
+      std::string(pathname) + ": can't create temporary directory");
+    return Path();
+  }
   Path result;
   result.set(pathname);
   assert(result.isValid() && "mkstemp didn't create a valid pathname!");
@@ -236,38 +250,6 @@ Path::GetUserHomeDirectory() {
   return GetRootDirectory();
 }
 
-bool
-Path::isFile() const {
-  if (!exists())
-    return false;
-  struct stat buf;
-  if (0 != stat(path.c_str(), &buf)) {
-    ThrowErrno(path + ": can't determine type of path object: ");
-  }
-  return S_ISREG(buf.st_mode);
-}
-
-bool
-Path::isDirectory() const {
-  if (!exists())
-    return false;
-  struct stat buf;
-  if (0 != stat(path.c_str(), &buf)) {
-    ThrowErrno(path + ": can't determine type of path object: ");
-  }
-  return S_ISDIR(buf.st_mode);
-}
-
-bool
-Path::isHidden() const {
-  if (!exists())
-    return false;
-  size_t slash = path.rfind('/');
-  return (slash != std::string::npos && 
-          slash < path.length()-1 && 
-          path[slash+1] == '.') || 
-         (!path.empty() && slash == std::string::npos && path[0] == '.');
-}
 
 std::string
 Path::getBasename() const {
@@ -286,12 +268,10 @@ Path::getBasename() const {
 }
 
 bool Path::hasMagicNumber(const std::string &Magic) const {
-  if (!isFile())
-    return false;
   size_t len = Magic.size();
   assert(len < 1024 && "Request for magic string too long");
   char* buf = (char*) alloca(1 + len);
-  int fd = ::open(path.c_str(),O_RDONLY);
+  int fd = ::open(path.c_str(), O_RDONLY);
   if (fd < 0)
     return false;
   size_t read_len = ::read(fd, buf, len);
@@ -303,11 +283,9 @@ bool Path::hasMagicNumber(const std::string &Magic) const {
 }
 
 bool Path::getMagicNumber(std::string& Magic, unsigned len) const {
-  if (!isFile())
-    return false;
   assert(len < 1024 && "Request for magic string too long");
   char* buf = (char*) alloca(1 + len);
-  int fd = ::open(path.c_str(),O_RDONLY);
+  int fd = ::open(path.c_str(), O_RDONLY);
   if (fd < 0)
     return false;
   ssize_t bytes_read = ::read(fd, buf, len);
@@ -322,11 +300,9 @@ bool Path::getMagicNumber(std::string& Magic, unsigned len) const {
 
 bool 
 Path::isBytecodeFile() const {
-  if (!isFile())
-    return false;
-  char buffer[ 4];
+  char buffer[4];
   buffer[0] = 0;
-  int fd = ::open(path.c_str(),O_RDONLY);
+  int fd = ::open(path.c_str(), O_RDONLY);
   if (fd < 0)
     return false;
   ssize_t bytes_read = ::read(fd, buffer, 4);
@@ -335,7 +311,7 @@ Path::isBytecodeFile() const {
     return false;
 
   return (buffer[0] == 'l' && buffer[1] == 'l' && buffer[2] == 'v' &&
-      (buffer[3] == 'c' || buffer[3] == 'm'));
+         (buffer[3] == 'c' || buffer[3] == 'm'));
 }
 
 bool
@@ -386,21 +362,28 @@ Path::getLast() const {
   return path.substr(pos+1);
 }
 
-void
-Path::getStatusInfo(StatusInfo& info) const {
-  struct stat buf;
-  if (0 != stat(path.c_str(), &buf)) {
-    ThrowErrno(path + ": can't determine type of path object: ");
+bool
+Path::getFileStatus(FileStatus &info, bool update, std::string *ErrStr) const {
+  if (status == 0 || update) {
+    struct stat buf;
+    if (0 != stat(path.c_str(), &buf))
+      return MakeErrMsg(ErrStr, path + ": can't get status of file");
+    if (status == 0)
+      status = new FileStatus;
+    status->fileSize = buf.st_size;
+    status->modTime.fromEpochTime(buf.st_mtime);
+    status->mode = buf.st_mode;
+    status->user = buf.st_uid;
+    status->group = buf.st_gid;
+    status->uniqueID = uint64_t(buf.st_ino);
+    status->isDir  = S_ISDIR(buf.st_mode);
+    status->isFile = S_ISREG(buf.st_mode);
   }
-  info.fileSize = buf.st_size;
-  info.modTime.fromEpochTime(buf.st_mtime);
-  info.mode = buf.st_mode;
-  info.user = buf.st_uid;
-  info.group = buf.st_gid;
-  info.isDir = S_ISDIR(buf.st_mode);
+  info = *status;
+  return false;
 }
 
-static bool AddPermissionBits(const std::string& Filename, int bits) {
+static bool AddPermissionBits(const Path &File, int bits) {
   // Get the umask value from the operating system.  We want to use it
   // when changing the file's permissions. Since calling umask() sets
   // the umask and returns its old value, we must call it a second
@@ -409,40 +392,40 @@ static bool AddPermissionBits(const std::string& Filename, int bits) {
   umask(mask);            // Restore the umask.
 
   // Get the file's current mode.
-  struct stat st;
-  if ((stat(Filename.c_str(), &st)) == -1)
-    return false;
+  FileStatus Stat;
+  if (File.getFileStatus(Stat)) return false;
 
   // Change the file to have whichever permissions bits from 'bits'
   // that the umask would not disable.
-  if ((chmod(Filename.c_str(), (st.st_mode | (bits & ~mask)))) == -1)
+  if ((chmod(File.c_str(), (Stat.getMode() | (bits & ~mask)))) == -1)
     return false;
 
   return true;
 }
 
-void Path::makeReadableOnDisk() {
-  if (!AddPermissionBits(path,0444))
-    ThrowErrno(path + ": can't make file readable");
+bool Path::makeReadableOnDisk(std::string* ErrMsg) {
+  if (!AddPermissionBits(*this, 0444)) 
+    return MakeErrMsg(ErrMsg, path + ": can't make file readable");
+  return false;
 }
 
-void Path::makeWriteableOnDisk() {
-  if (!AddPermissionBits(path,0222))
-    ThrowErrno(path + ": can't make file writable");
+bool Path::makeWriteableOnDisk(std::string* ErrMsg) {
+  if (!AddPermissionBits(*this, 0222))
+    return MakeErrMsg(ErrMsg, path + ": can't make file writable");
+  return false;
 }
 
-void Path::makeExecutableOnDisk() {
-  if (!AddPermissionBits(path,0111))
-    ThrowErrno(path + ": can't make file executable");
+bool Path::makeExecutableOnDisk(std::string* ErrMsg) {
+  if (!AddPermissionBits(*this, 0111))
+    return MakeErrMsg(ErrMsg, path + ": can't make file executable");
+  return false;
 }
 
 bool
-Path::getDirectoryContents(std::set<Path>& result) const {
-  if (!isDirectory())
-    return false;
+Path::getDirectoryContents(std::set<Path>& result, std::string* ErrMsg) const {
   DIR* direntries = ::opendir(path.c_str());
   if (direntries == 0)
-    ThrowErrno(path + ": can't open directory");
+    return MakeErrMsg(ErrMsg, path + ": can't open directory");
 
   std::string dirPath = path;
   if (!lastIsSlash(dirPath))
@@ -453,21 +436,19 @@ Path::getDirectoryContents(std::set<Path>& result) const {
   for ( ; de != 0; de = ::readdir(direntries)) {
     if (de->d_name[0] != '.') {
       Path aPath(dirPath + (const char*)de->d_name);
-      struct stat buf;
-      if (0 != stat(aPath.path.c_str(), &buf)) {
-        int stat_errno = errno;
-        struct stat st;
-        if (0 == lstat(aPath.path.c_str(), &st) && S_ISLNK(st.st_mode))
+      struct stat st;
+      if (0 != lstat(aPath.path.c_str(), &st)) {
+        if (S_ISLNK(st.st_mode))
           continue; // dangling symlink -- ignore
-        ThrowErrno(aPath.path + 
-          ": can't determine file object type", stat_errno);
+        return MakeErrMsg(ErrMsg, 
+                          aPath.path +  ": can't determine file object type");
       }
       result.insert(aPath);
     }
   }
   
   closedir(direntries);
-  return true;
+  return false;
 }
 
 bool
@@ -544,7 +525,7 @@ Path::eraseSuffix() {
 }
 
 bool
-Path::createDirectoryOnDisk( bool create_parents) {
+Path::createDirectoryOnDisk( bool create_parents, std::string* ErrMsg ) {
   // Get a writeable copy of the path name
   char pathname[MAXPATHLEN];
   path.copy(pathname,MAXPATHLEN);
@@ -567,8 +548,10 @@ Path::createDirectoryOnDisk( bool create_parents) {
     while ( next != 0 ) {
       *next = 0;
       if (0 != access(pathname, F_OK | R_OK | W_OK))
-        if (0 != mkdir(pathname, S_IRWXU | S_IRWXG))
-          ThrowErrno(std::string(pathname) + ": can't create directory");
+        if (0 != mkdir(pathname, S_IRWXU | S_IRWXG)) {
+          return MakeErrMsg(ErrMsg, 
+                            std::string(pathname) + ": can't create directory");
+        }
       char* save = next;
       next = strchr(next+1,'/');
       *save = '/';
@@ -576,133 +559,151 @@ Path::createDirectoryOnDisk( bool create_parents) {
   } 
 
   if (0 != access(pathname, F_OK | R_OK))
-    if (0 != mkdir(pathname, S_IRWXU | S_IRWXG))
-      ThrowErrno(std::string(pathname) + ": can't create directory");
-  return true;
+    if (0 != mkdir(pathname, S_IRWXU | S_IRWXG)) {
+      return MakeErrMsg(ErrMsg, 
+                        std::string(pathname) + ": can't create directory");
+    }
+  return false;
 }
 
 bool
-Path::createFileOnDisk() {
+Path::createFileOnDisk(std::string* ErrMsg) {
   // Create the file
   int fd = ::creat(path.c_str(), S_IRUSR | S_IWUSR);
   if (fd < 0)
-    ThrowErrno(path + ": can't create file");
+    return MakeErrMsg(ErrMsg, path + ": can't create file");
   ::close(fd);
-
-  return true;
+  return false;
 }
 
 bool
-Path::createTemporaryFileOnDisk(bool reuse_current) {
+Path::createTemporaryFileOnDisk(bool reuse_current, std::string* ErrMsg) {
   // Make this into a unique file name
-  makeUnique( reuse_current );
+  if (makeUnique( reuse_current, ErrMsg ))
+    return true;
 
   // create the file
-  int outFile = ::open(path.c_str(), O_WRONLY|O_CREAT|O_TRUNC, 0666);
-  if (outFile != -1) {
-    ::close(outFile);
-    return true;
-  }
+  int fd = ::open(path.c_str(), O_WRONLY|O_CREAT|O_TRUNC, 0666);
+  if (fd < 0) 
+    return MakeErrMsg(ErrMsg, path + ": can't create temporary file");
+  ::close(fd);
   return false;
 }
 
 bool
-Path::eraseFromDisk(bool remove_contents) const {
-  // Make sure we're dealing with a directory
-  if (isFile()) {
-    if (0 != unlink(path.c_str()))
-      ThrowErrno(path + ": can't destroy file");
-  } else if (isDirectory()) {
-    if (remove_contents) {
-      // Recursively descend the directory to remove its content
-      std::string cmd("/bin/rm -rf ");
-      cmd += path;
-      system(cmd.c_str());
-    } else {
-      // Otherwise, try to just remove the one directory
-      char pathname[MAXPATHLEN];
-      path.copy(pathname,MAXPATHLEN);
-      int lastchar = path.length() - 1 ; 
-      if (pathname[lastchar] == '/') 
-        pathname[lastchar] = 0;
-      else
-        pathname[lastchar+1] = 0;
-      if ( 0 != rmdir(pathname))
-        ThrowErrno(std::string(pathname) + ": can't destroy directory");
-    }
+Path::eraseFromDisk(bool remove_contents, std::string *ErrStr) const {
+  FileStatus Status;
+  if (getFileStatus(Status, ErrStr))
+    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. 
+  if (Status.isFile) {
+    if (unlink(path.c_str()) != 0)
+      return MakeErrMsg(ErrStr, path + ": can't destroy file");
+    return false;
   }
-  else
+  
+  if (!Status.isDir) {
+    if (ErrStr) *ErrStr = "not a file or directory";
+    return true;
+  }
+  if (remove_contents) {
+    // Recursively descend the directory to remove its contents.
+    std::string cmd = "/bin/rm -rf " + path;
+    system(cmd.c_str());
     return false;
-  return true;
+  }
+
+  // Otherwise, try to just remove the one directory.
+  char pathname[MAXPATHLEN];
+  path.copy(pathname, MAXPATHLEN);
+  int lastchar = path.length() - 1 ; 
+  if (pathname[lastchar] == '/') 
+    pathname[lastchar] = 0;
+  else
+    pathname[lastchar+1] = 0;
+    
+  if (rmdir(pathname) != 0)
+    return MakeErrMsg(ErrStr, 
+      std::string(pathname) + ": can't destroy directory");
+  return false;
 }
 
 bool
-Path::renamePathOnDisk(const Path& newName) {
+Path::renamePathOnDisk(const Path& newName, std::string* ErrMsg) {
   if (0 != ::rename(path.c_str(), newName.c_str()))
-    ThrowErrno(std::string("can't rename '") + path + "' as '" + 
+    return MakeErrMsg(ErrMsg, std::string("can't rename '") + path + "' as '" + 
                newName.toString() + "' ");
-  return true;
+  return false;
 }
 
 bool
-Path::setStatusInfoOnDisk(const StatusInfo& si) const {
+Path::setStatusInfoOnDisk(const FileStatus &si, std::string *ErrStr) const {
   struct utimbuf utb;
   utb.actime = si.modTime.toPosixTime();
   utb.modtime = utb.actime;
   if (0 != ::utime(path.c_str(),&utb))
-    ThrowErrno(path + ": can't set file modification time");
+    return MakeErrMsg(ErrStr, path + ": can't set file modification time");
   if (0 != ::chmod(path.c_str(),si.mode))
-    ThrowErrno(path + ": can't set mode");
-  return true;
+    return MakeErrMsg(ErrStr, path + ": can't set mode");
+  return false;
 }
 
-void 
-sys::CopyFile(const sys::Path &Dest, const sys::Path &Src{
+bool 
+sys::CopyFile(const sys::Path &Dest, const sys::Path &Src, std::string* ErrMsg){
   int inFile = -1;
   int outFile = -1;
-  try {
-    inFile = ::open(Src.c_str(), O_RDONLY);
-    if (inFile == -1)
-      ThrowErrno(Src.toString() + ": can't open source file to copy: ");
-
-    outFile = ::open(Dest.c_str(), O_WRONLY|O_CREAT, 0666);
-    if (outFile == -1)
-      ThrowErrno(Dest.toString() +": can't create destination file for copy: ");
-
-    char Buffer[16*1024];
-    while (ssize_t Amt = ::read(inFile, Buffer, 16*1024)) {
-      if (Amt == -1) {
-        if (errno != EINTR && errno != EAGAIN) 
-          ThrowErrno(Src.toString()+": can't read source file: ");
-      } else {
-        char *BufPtr = Buffer;
-        while (Amt) {
-          ssize_t AmtWritten = ::write(outFile, BufPtr, Amt);
-          if (AmtWritten == -1) {
-            if (errno != EINTR && errno != EAGAIN) 
-              ThrowErrno(Dest.toString() + ": can't write destination file: ");
-          } else {
-            Amt -= AmtWritten;
-            BufPtr += AmtWritten;
+  inFile = ::open(Src.c_str(), O_RDONLY);
+  if (inFile == -1)
+    return MakeErrMsg(ErrMsg, Src.toString() + 
+      ": 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() +
+      ": can't create destination file for copy");
+  }
+
+  char Buffer[16*1024];
+  while (ssize_t Amt = ::read(inFile, Buffer, 16*1024)) {
+    if (Amt == -1) {
+      if (errno != EINTR && errno != EAGAIN) {
+        ::close(inFile);
+        ::close(outFile);
+        return MakeErrMsg(ErrMsg, Src.toString()+": can't read source file: ");
+      }
+    } else {
+      char *BufPtr = Buffer;
+      while (Amt) {
+        ssize_t AmtWritten = ::write(outFile, BufPtr, Amt);
+        if (AmtWritten == -1) {
+          if (errno != EINTR && errno != EAGAIN) {
+            ::close(inFile);
+            ::close(outFile);
+            return MakeErrMsg(ErrMsg, Dest.toString() + 
+              ": can't write destination file: ");
           }
+        } else {
+          Amt -= AmtWritten;
+          BufPtr += AmtWritten;
         }
       }
     }
-    ::close(inFile);
-    ::close(outFile);
-  } catch (...) {
-    if (inFile != -1)
-      ::close(inFile);
-    if (outFile != -1)
-      ::close(outFile);
-    throw;
   }
+  ::close(inFile);
+  ::close(outFile);
+  return false;
 }
 
-void 
-Path::makeUnique(bool reuse_current) {
+bool 
+Path::makeUnique(bool reuse_current, std::string* ErrMsg) {
   if (reuse_current && !exists())
-    return; // File doesn't exist already, just use it!
+    return false; // File doesn't exist already, just use it!
 
   // Append an XXXXXX pattern to the end of the file for use with mkstemp, 
   // mktemp or our own implementation.
@@ -712,9 +713,8 @@ Path::makeUnique(bool reuse_current) {
 
 #if defined(HAVE_MKSTEMP)
   int TempFD;
-  if ((TempFD = mkstemp(FNBuffer)) == -1) {
-    ThrowErrno(path + ": can't make unique filename");
-  }
+  if ((TempFD = mkstemp(FNBuffer)) == -1)
+    return MakeErrMsg(ErrMsg, path + ": can't make unique filename");
 
   // We don't need to hold the temp file descriptor... we will trust that no one
   // will overwrite/delete the file before we can open it again.
@@ -724,9 +724,8 @@ Path::makeUnique(bool reuse_current) {
   path = FNBuffer;
 #elif defined(HAVE_MKTEMP)
   // If we don't have mkstemp, use the old and obsolete mktemp function.
-  if (mktemp(FNBuffer) == 0) {
-    ThrowErrno(path + ": can't make unique filename");
-  }
+  if (mktemp(FNBuffer) == 0)
+    return MakeErrMsg(ErrMsg, path + ": can't make unique filename");
 
   // Save the name
   path = FNBuffer;
@@ -739,9 +738,11 @@ Path::makeUnique(bool reuse_current) {
     path = FNBuffer;
   }
   if (FCounter > 999999)
-    throw std::string(path + ": can't make unique filename: too many files");
+    return MakeErrMsg(ErrMsg, 
+      path + ": can't make unique filename: too many files");
 #endif
-
-}
+  return false;
 }
 
+} // end llvm namespace
+