lib/Support/Unix/PathV2.inc

   1 //===- llvm/Support/Unix/PathV2.cpp - Unix Path Implementation --*- 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 implementation of the PathV2 API.
  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 #if HAVE_SYS_STAT_H
  21 #include <sys/stat.h>
  22 #endif
  23 #if HAVE_FCNTL_H
  24 #include <fcntl.h>
  25 #endif
  26 #if HAVE_STDIO_H
  27 #include <stdio.h>
  28 #endif
  29
  30 using namespace llvm;
  31
  32 namespace {
  33   struct AutoFD {
  34     int FileDescriptor;
  35
  36     AutoFD(int fd) : FileDescriptor(fd) {}
  37     ~AutoFD() {
  38       if (FileDescriptor >= 0)
  39         ::close(FileDescriptor);
  40     }
  41
  42     int take() {
  43       int ret = FileDescriptor;
  44       FileDescriptor = -1;
  45       return ret;
  46     }
  47
  48     operator int() const {return FileDescriptor;}
  49   };
  50
  51   error_code TempDir(SmallVectorImpl<char> &result) {
  52     // FIXME: Don't use TMPDIR if program is SUID or SGID enabled.
  53     const char *dir = 0;
  54     (dir = std::getenv("TMPDIR" )) ||
  55     (dir = std::getenv("TMP"    )) ||
  56     (dir = std::getenv("TEMP"   )) ||
  57     (dir = std::getenv("TEMPDIR")) ||
  58 #ifdef P_tmpdir
  59     (dir = P_tmpdir) ||
  60 #endif
  61     (dir = "/tmp");
  62
  63     result.set_size(0);
  64     StringRef d(dir);
  65     result.append(d.begin(), d.end());
  66     return make_error_code(errc::success);
  67   }
  68 }
  69
  70 namespace llvm {
  71 namespace sys  {
  72 namespace path {
  73
  74 error_code current_path(SmallVectorImpl<char> &result) {
  75   long size = ::pathconf(".", _PC_PATH_MAX);
  76   result.reserve(size + 1);
  77   result.set_size(size + 1);
  78
  79   if (::getcwd(result.data(), result.size()) == 0)
  80     return error_code(errno, system_category());
  81
  82   result.set_size(strlen(result.data()));
  83   return make_error_code(errc::success);
  84 }
  85
  86 } // end namespace path
  87
  88 namespace fs{
  89
  90 error_code copy_file(const Twine &from, const Twine &to, copy_option copt) {
  91  // Get arguments.
  92   SmallString<128> from_storage;
  93   SmallString<128> to_storage;
  94   StringRef f = from.toNullTerminatedStringRef(from_storage);
  95   StringRef t = to.toNullTerminatedStringRef(to_storage);
  96
  97   const size_t buf_sz = 32768;
  98   char buffer[buf_sz];
  99   int from_file = -1, to_file = -1;
 100
 101   // Open from.
 102   if ((from_file = ::open(f.begin(), O_RDONLY)) < 0)
 103     return error_code(errno, system_category());
 104   AutoFD from_fd(from_file);
 105
 106   // Stat from.
 107   struct stat from_stat;
 108   if (::stat(f.begin(), &from_stat) != 0)
 109     return error_code(errno, system_category());
 110
 111   // Setup to flags.
 112   int to_flags = O_CREAT | O_WRONLY;
 113   if (copt == copy_option::fail_if_exists)
 114     to_flags |= O_EXCL;
 115
 116   // Open to.
 117   if ((to_file = ::open(t.begin(), to_flags, from_stat.st_mode)) < 0)
 118     return error_code(errno, system_category());
 119   AutoFD to_fd(to_file);
 120
 121   // Copy!
 122   ssize_t sz, sz_read = 1, sz_write;
 123   while (sz_read > 0 &&
 124          (sz_read = ::read(from_fd, buffer, buf_sz)) > 0) {
 125     // Allow for partial writes - see Advanced Unix Programming (2nd Ed.),
 126     // Marc Rochkind, Addison-Wesley, 2004, page 94
 127     sz_write = 0;
 128     do {
 129       if ((sz = ::write(to_fd, buffer + sz_write, sz_read - sz_write)) < 0) {
 130         sz_read = sz;  // cause read loop termination.
 131         break;         // error.
 132       }
 133       sz_write += sz;
 134     } while (sz_write < sz_read);
 135   }
 136
 137   // After all the file operations above the return value of close actually
 138   // matters.
 139   if (::close(from_fd.take()) < 0) sz_read = -1;
 140   if (::close(to_fd.take()) < 0) sz_read = -1;
 141
 142   // Check for errors.
 143   if (sz_read < 0)
 144     return error_code(errno, system_category());
 145
 146   return make_error_code(errc::success);
 147 }
 148
 149 error_code create_directory(const Twine &path, bool &existed) {
 150   SmallString<128> path_storage;
 151   StringRef p = path.toNullTerminatedStringRef(path_storage);
 152
 153   if (::mkdir(p.begin(), 0700) == -1) {
 154     if (errno != EEXIST)
 155       return error_code(errno, system_category());
 156     existed = true;
 157   } else
 158     existed = false;
 159
 160   return make_error_code(errc::success);
 161 }
 162
 163 error_code create_hard_link(const Twine &to, const Twine &from) {
 164   // Get arguments.
 165   SmallString<128> from_storage;
 166   SmallString<128> to_storage;
 167   StringRef f = from.toNullTerminatedStringRef(from_storage);
 168   StringRef t = to.toNullTerminatedStringRef(to_storage);
 169
 170   if (::link(t.begin(), f.begin()) == -1)
 171     return error_code(errno, system_category());
 172
 173   return make_error_code(errc::success);
 174 }
 175
 176 error_code create_symlink(const Twine &to, const Twine &from) {
 177   // Get arguments.
 178   SmallString<128> from_storage;
 179   SmallString<128> to_storage;
 180   StringRef f = from.toNullTerminatedStringRef(from_storage);
 181   StringRef t = to.toNullTerminatedStringRef(to_storage);
 182
 183   if (::symlink(t.begin(), f.begin()) == -1)
 184     return error_code(errno, system_category());
 185
 186   return make_error_code(errc::success);
 187 }
 188
 189 error_code remove(const Twine &path, bool &existed) {
 190   SmallString<128> path_storage;
 191   StringRef p = path.toNullTerminatedStringRef(path_storage);
 192
 193   if (::remove(p.begin()) == -1) {
 194     if (errno != ENOENT)
 195       return error_code(errno, system_category());
 196     existed = false;
 197   } else
 198     existed = true;
 199
 200   return make_error_code(errc::success);
 201 }
 202
 203 error_code exists(const Twine &path, bool &result) {
 204   SmallString<128> path_storage;
 205   StringRef p = path.toNullTerminatedStringRef(path_storage);
 206
 207   struct stat status;
 208   if (::stat(p.begin(), &status) == -1) {
 209     if (errno != ENOENT)
 210       return error_code(errno, system_category());
 211     result = false;
 212   } else
 213     result = true;
 214
 215   return make_error_code(errc::success);
 216 }
 217
 218 error_code unique_file(const Twine &model, int &result_fd,
 219                              SmallVectorImpl<char> &result_path) {
 220   SmallString<128> Model;
 221   model.toVector(Model);
 222   // Null terminate.
 223   Model.c_str();
 224
 225   // Make model absolute by prepending a temp directory if it's not already.
 226   bool absolute;
 227   if (error_code ec = path::is_absolute(Twine(Model), absolute)) return ec;
 228   if (!absolute) {
 229     SmallString<128> TDir;
 230     if (error_code ec = TempDir(TDir)) return ec;
 231     if (error_code ec = path::append(TDir, Twine(Model))) return ec;
 232     Model.swap(TDir);
 233   }
 234
 235   // Replace '%' with random chars. From here on, DO NOT modify model. It may be
 236   // needed if the randomly chosen path already exists.
 237   SmallString<128> RandomPath;
 238   RandomPath.reserve(Model.size() + 1);
 239   ::srand(::time(NULL));
 240
 241 retry_random_path:
 242   // This is opened here instead of above to make it easier to track when to
 243   // close it. Collisions should be rare enough for the possible extra syscalls
 244   // not to matter.
 245   FILE *RandomSource = ::fopen("/dev/urandom", "r");
 246   RandomPath.set_size(0);
 247   for (SmallVectorImpl<char>::const_iterator i = Model.begin(),
 248                                              e = Model.end(); i != e; ++i) {
 249     if (*i == '%') {
 250       char val = 0;
 251       if (RandomSource)
 252         val = fgetc(RandomSource);
 253       else
 254         val = ::rand();
 255       RandomPath.push_back("0123456789abcdef"[val & 15]);
 256     } else
 257       RandomPath.push_back(*i);
 258   }
 259
 260   if (RandomSource)
 261     ::fclose(RandomSource);
 262
 263   // Try to open + create the file.
 264 rety_open_create:
 265   int RandomFD = ::open(RandomPath.c_str(), O_RDWR | O_CREAT | O_EXCL, 0600);
 266   if (RandomFD == -1) {
 267     // If the file existed, try again, otherwise, error.
 268     if (errno == EEXIST)
 269       goto retry_random_path;
 270     // The path prefix doesn't exist.
 271     if (errno == ENOENT) {
 272       StringRef p(RandomPath.begin(), RandomPath.size());
 273       SmallString<64> dir_to_create;
 274       for (path::const_iterator i = path::begin(p),
 275                                 e = --path::end(p); i != e; ++i) {
 276         if (error_code ec = path::append(dir_to_create, *i)) return ec;
 277         bool Exists;
 278         if (error_code ec = exists(Twine(dir_to_create), Exists)) return ec;
 279         if (!Exists) {
 280           // Don't try to create network paths.
 281           if (i->size() > 2 && (*i)[0] == '/' &&
 282                                (*i)[1] == '/' &&
 283                                (*i)[2] != '/')
 284             return error_code(ENOENT, system_category());
 285           if (::mkdir(dir_to_create.c_str(), 0700) == -1)
 286             return error_code(errno, system_category());
 287         }
 288       }
 289       goto rety_open_create;
 290     }
 291     return error_code(errno, system_category());
 292   }
 293
 294     // Make the path absolute.
 295   char real_path_buff[PATH_MAX + 1];
 296   if (realpath(RandomPath.c_str(), real_path_buff) == NULL) {
 297     ::close(RandomFD);
 298     ::unlink(RandomPath.c_str());
 299     return error_code(errno, system_category());
 300   }
 301
 302   result_path.set_size(0);
 303   StringRef d(real_path_buff);
 304   result_path.append(d.begin(), d.end());
 305
 306   result_fd = RandomFD;
 307   return make_error_code(errc::success);
 308 }
 309
 310 } // end namespace fs
 311 } // end namespace sys
 312 } // end namespace llvm