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_DIRENT_H
  27 # include <dirent.h>
  28 # define NAMLEN(dirent) strlen((dirent)->d_name)
  29 #else
  30 # define dirent direct
  31 # define NAMLEN(dirent) (dirent)->d_namlen
  32 # if HAVE_SYS_NDIR_H
  33 #  include <sys/ndir.h>
  34 # endif
  35 # if HAVE_SYS_DIR_H
  36 #  include <sys/dir.h>
  37 # endif
  38 # if HAVE_NDIR_H
  39 #  include <ndir.h>
  40 # endif
  41 #endif
  42 #if HAVE_STDIO_H
  43 #include <stdio.h>
  44 #endif
  45
  46 using namespace llvm;
  47
  48 namespace {
  49   /// This class automatically closes the given file descriptor when it goes out
  50   /// of scope. You can take back explicit ownership of the file descriptor by
  51   /// calling take(). The destructor does not verify that close was successful.
  52   /// Therefore, never allow this class to call close on a file descriptor that
  53   /// has been read from or written to.
  54   struct AutoFD {
  55     int FileDescriptor;
  56
  57     AutoFD(int fd) : FileDescriptor(fd) {}
  58     ~AutoFD() {
  59       if (FileDescriptor >= 0)
  60         ::close(FileDescriptor);
  61     }
  62
  63     int take() {
  64       int ret = FileDescriptor;
  65       FileDescriptor = -1;
  66       return ret;
  67     }
  68
  69     operator int() const {return FileDescriptor;}
  70   };
  71
  72   error_code TempDir(SmallVectorImpl<char> &result) {
  73     // FIXME: Don't use TMPDIR if program is SUID or SGID enabled.
  74     const char *dir = 0;
  75     (dir = std::getenv("TMPDIR" )) ||
  76     (dir = std::getenv("TMP"    )) ||
  77     (dir = std::getenv("TEMP"   )) ||
  78     (dir = std::getenv("TEMPDIR")) ||
  79 #ifdef P_tmpdir
  80     (dir = P_tmpdir) ||
  81 #endif
  82     (dir = "/tmp");
  83
  84     result.clear();
  85     StringRef d(dir);
  86     result.append(d.begin(), d.end());
  87     return success;
  88   }
  89 }
  90
  91 namespace llvm {
  92 namespace sys  {
  93 namespace fs {
  94
  95 error_code current_path(SmallVectorImpl<char> &result) {
  96   result.reserve(MAXPATHLEN);
  97
  98   while (true) {
  99     if (::getcwd(result.data(), result.capacity()) == 0) {
 100       // See if there was a real error.
 101       if (errno != errc::not_enough_memory)
 102         return error_code(errno, system_category());
 103       // Otherwise there just wasn't enough space.
 104       result.reserve(result.capacity() * 2);
 105     } else
 106       break;
 107   }
 108
 109   result.set_size(strlen(result.data()));
 110   return success;
 111 }
 112
 113 error_code copy_file(const Twine &from, const Twine &to, copy_option copt) {
 114  // Get arguments.
 115   SmallString<128> from_storage;
 116   SmallString<128> to_storage;
 117   StringRef f = from.toNullTerminatedStringRef(from_storage);
 118   StringRef t = to.toNullTerminatedStringRef(to_storage);
 119
 120   const size_t buf_sz = 32768;
 121   char buffer[buf_sz];
 122   int from_file = -1, to_file = -1;
 123
 124   // Open from.
 125   if ((from_file = ::open(f.begin(), O_RDONLY)) < 0)
 126     return error_code(errno, system_category());
 127   AutoFD from_fd(from_file);
 128
 129   // Stat from.
 130   struct stat from_stat;
 131   if (::stat(f.begin(), &from_stat) != 0)
 132     return error_code(errno, system_category());
 133
 134   // Setup to flags.
 135   int to_flags = O_CREAT | O_WRONLY;
 136   if (copt == copy_option::fail_if_exists)
 137     to_flags |= O_EXCL;
 138
 139   // Open to.
 140   if ((to_file = ::open(t.begin(), to_flags, from_stat.st_mode)) < 0)
 141     return error_code(errno, system_category());
 142   AutoFD to_fd(to_file);
 143
 144   // Copy!
 145   ssize_t sz, sz_read = 1, sz_write;
 146   while (sz_read > 0 &&
 147          (sz_read = ::read(from_fd, buffer, buf_sz)) > 0) {
 148     // Allow for partial writes - see Advanced Unix Programming (2nd Ed.),
 149     // Marc Rochkind, Addison-Wesley, 2004, page 94
 150     sz_write = 0;
 151     do {
 152       if ((sz = ::write(to_fd, buffer + sz_write, sz_read - sz_write)) < 0) {
 153         sz_read = sz;  // cause read loop termination.
 154         break;         // error.
 155       }
 156       sz_write += sz;
 157     } while (sz_write < sz_read);
 158   }
 159
 160   // After all the file operations above the return value of close actually
 161   // matters.
 162   if (::close(from_fd.take()) < 0) sz_read = -1;
 163   if (::close(to_fd.take()) < 0) sz_read = -1;
 164
 165   // Check for errors.
 166   if (sz_read < 0)
 167     return error_code(errno, system_category());
 168
 169   return success;
 170 }
 171
 172 error_code create_directory(const Twine &path, bool &existed) {
 173   SmallString<128> path_storage;
 174   StringRef p = path.toNullTerminatedStringRef(path_storage);
 175
 176   if (::mkdir(p.begin(), S_IRWXU | S_IRWXG) == -1) {
 177     if (errno != errc::file_exists)
 178       return error_code(errno, system_category());
 179     existed = true;
 180   } else
 181     existed = false;
 182
 183   return success;
 184 }
 185
 186 error_code create_hard_link(const Twine &to, const Twine &from) {
 187   // Get arguments.
 188   SmallString<128> from_storage;
 189   SmallString<128> to_storage;
 190   StringRef f = from.toNullTerminatedStringRef(from_storage);
 191   StringRef t = to.toNullTerminatedStringRef(to_storage);
 192
 193   if (::link(t.begin(), f.begin()) == -1)
 194     return error_code(errno, system_category());
 195
 196   return success;
 197 }
 198
 199 error_code create_symlink(const Twine &to, const Twine &from) {
 200   // Get arguments.
 201   SmallString<128> from_storage;
 202   SmallString<128> to_storage;
 203   StringRef f = from.toNullTerminatedStringRef(from_storage);
 204   StringRef t = to.toNullTerminatedStringRef(to_storage);
 205
 206   if (::symlink(t.begin(), f.begin()) == -1)
 207     return error_code(errno, system_category());
 208
 209   return success;
 210 }
 211
 212 error_code remove(const Twine &path, bool &existed) {
 213   SmallString<128> path_storage;
 214   StringRef p = path.toNullTerminatedStringRef(path_storage);
 215
 216   if (::remove(p.begin()) == -1) {
 217     if (errno != errc::no_such_file_or_directory)
 218       return error_code(errno, system_category());
 219     existed = false;
 220   } else
 221     existed = true;
 222
 223   return success;
 224 }
 225
 226 error_code rename(const Twine &from, const Twine &to) {
 227   // Get arguments.
 228   SmallString<128> from_storage;
 229   SmallString<128> to_storage;
 230   StringRef f = from.toNullTerminatedStringRef(from_storage);
 231   StringRef t = to.toNullTerminatedStringRef(to_storage);
 232
 233   if (::rename(f.begin(), t.begin()) == -1)
 234     return error_code(errno, system_category());
 235
 236   return success;
 237 }
 238
 239 error_code resize_file(const Twine &path, uint64_t size) {
 240   SmallString<128> path_storage;
 241   StringRef p = path.toNullTerminatedStringRef(path_storage);
 242
 243   if (::truncate(p.begin(), size) == -1)
 244     return error_code(errno, system_category());
 245
 246   return success;
 247 }
 248
 249 error_code exists(const Twine &path, bool &result) {
 250   SmallString<128> path_storage;
 251   StringRef p = path.toNullTerminatedStringRef(path_storage);
 252
 253   struct stat status;
 254   if (::stat(p.begin(), &status) == -1) {
 255     if (errno != errc::no_such_file_or_directory)
 256       return error_code(errno, system_category());
 257     result = false;
 258   } else
 259     result = true;
 260
 261   return success;
 262 }
 263
 264 error_code equivalent(const Twine &A, const Twine &B, bool &result) {
 265   // Get arguments.
 266   SmallString<128> a_storage;
 267   SmallString<128> b_storage;
 268   StringRef a = A.toNullTerminatedStringRef(a_storage);
 269   StringRef b = B.toNullTerminatedStringRef(b_storage);
 270
 271   struct stat stat_a, stat_b;
 272   int error_b = ::stat(b.begin(), &stat_b);
 273   int error_a = ::stat(a.begin(), &stat_a);
 274
 275   // If both are invalid, it's an error. If only one is, the result is false.
 276   if (error_a != 0 || error_b != 0) {
 277     if (error_a == error_b)
 278       return error_code(errno, system_category());
 279     result = false;
 280   } else {
 281     result =
 282       stat_a.st_dev == stat_b.st_dev &&
 283       stat_a.st_ino == stat_b.st_ino;
 284   }
 285
 286   return success;
 287 }
 288
 289 error_code file_size(const Twine &path, uint64_t &result) {
 290   SmallString<128> path_storage;
 291   StringRef p = path.toNullTerminatedStringRef(path_storage);
 292
 293   struct stat status;
 294   if (::stat(p.begin(), &status) == -1)
 295     return error_code(errno, system_category());
 296   if (!S_ISREG(status.st_mode))
 297     return make_error_code(errc::operation_not_permitted);
 298
 299   result = status.st_size;
 300   return success;
 301 }
 302
 303 error_code status(const Twine &path, file_status &result) {
 304   SmallString<128> path_storage;
 305   StringRef p = path.toNullTerminatedStringRef(path_storage);
 306
 307   struct stat status;
 308   if (::stat(p.begin(), &status) != 0) {
 309     error_code ec(errno, system_category());
 310     if (ec == errc::no_such_file_or_directory)
 311       result = file_status(file_type::file_not_found);
 312     else
 313       result = file_status(file_type::status_error);
 314     return ec;
 315   }
 316
 317   if (S_ISDIR(status.st_mode))
 318     result = file_status(file_type::directory_file);
 319   else if (S_ISREG(status.st_mode))
 320     result = file_status(file_type::regular_file);
 321   else if (S_ISBLK(status.st_mode))
 322     result = file_status(file_type::block_file);
 323   else if (S_ISCHR(status.st_mode))
 324     result = file_status(file_type::character_file);
 325   else if (S_ISFIFO(status.st_mode))
 326     result = file_status(file_type::fifo_file);
 327   else if (S_ISSOCK(status.st_mode))
 328     result = file_status(file_type::socket_file);
 329   else
 330     result = file_status(file_type::type_unknown);
 331
 332   return success;
 333 }
 334
 335 error_code unique_file(const Twine &model, int &result_fd,
 336                              SmallVectorImpl<char> &result_path) {
 337   SmallString<128> Model;
 338   model.toVector(Model);
 339   // Null terminate.
 340   Model.c_str();
 341
 342   // Make model absolute by prepending a temp directory if it's not already.
 343   bool absolute = path::is_absolute(Twine(Model));
 344   if (!absolute) {
 345     SmallString<128> TDir;
 346     if (error_code ec = TempDir(TDir)) return ec;
 347     path::append(TDir, Twine(Model));
 348     Model.swap(TDir);
 349   }
 350
 351   // Replace '%' with random chars. From here on, DO NOT modify model. It may be
 352   // needed if the randomly chosen path already exists.
 353   SmallString<128> RandomPath;
 354   RandomPath.reserve(Model.size() + 1);
 355   ::srand(::time(NULL));
 356
 357 retry_random_path:
 358   // This is opened here instead of above to make it easier to track when to
 359   // close it. Collisions should be rare enough for the possible extra syscalls
 360   // not to matter.
 361   FILE *RandomSource = ::fopen("/dev/urandom", "r");
 362   RandomPath.set_size(0);
 363   for (SmallVectorImpl<char>::const_iterator i = Model.begin(),
 364                                              e = Model.end(); i != e; ++i) {
 365     if (*i == '%') {
 366       char val = 0;
 367       if (RandomSource)
 368         val = fgetc(RandomSource);
 369       else
 370         val = ::rand();
 371       RandomPath.push_back("0123456789abcdef"[val & 15]);
 372     } else
 373       RandomPath.push_back(*i);
 374   }
 375
 376   if (RandomSource)
 377     ::fclose(RandomSource);
 378
 379   // Try to open + create the file.
 380 rety_open_create:
 381   int RandomFD = ::open(RandomPath.c_str(), O_RDWR | O_CREAT | O_EXCL, 0600);
 382   if (RandomFD == -1) {
 383     // If the file existed, try again, otherwise, error.
 384     if (errno == errc::file_exists)
 385       goto retry_random_path;
 386     // The path prefix doesn't exist.
 387     if (errno == errc::no_such_file_or_directory) {
 388       StringRef p(RandomPath.begin(), RandomPath.size());
 389       SmallString<64> dir_to_create;
 390       for (path::const_iterator i = path::begin(p),
 391                                 e = --path::end(p); i != e; ++i) {
 392         path::append(dir_to_create, *i);
 393         bool Exists;
 394         if (error_code ec = exists(Twine(dir_to_create), Exists)) return ec;
 395         if (!Exists) {
 396           // Don't try to create network paths.
 397           if (i->size() > 2 && (*i)[0] == '/' &&
 398                                (*i)[1] == '/' &&
 399                                (*i)[2] != '/')
 400             return make_error_code(errc::no_such_file_or_directory);
 401           if (::mkdir(dir_to_create.c_str(), 0700) == -1)
 402             return error_code(errno, system_category());
 403         }
 404       }
 405       goto rety_open_create;
 406     }
 407     return error_code(errno, system_category());
 408   }
 409
 410    // Make the path absolute.
 411   char real_path_buff[PATH_MAX + 1];
 412   if (realpath(RandomPath.c_str(), real_path_buff) == NULL) {
 413     int error = errno;
 414     ::close(RandomFD);
 415     ::unlink(RandomPath.c_str());
 416     return error_code(error, system_category());
 417   }
 418
 419   result_path.clear();
 420   StringRef d(real_path_buff);
 421   result_path.append(d.begin(), d.end());
 422
 423   result_fd = RandomFD;
 424   return success;
 425 }
 426
 427 error_code directory_iterator_construct(directory_iterator &it, StringRef path){
 428   SmallString<128> path_null(path);
 429   DIR *directory = ::opendir(path_null.c_str());
 430   if (directory == 0)
 431     return error_code(errno, system_category());
 432
 433   it.IterationHandle = reinterpret_cast<intptr_t>(directory);
 434   // Add something for replace_filename to replace.
 435   path::append(path_null, ".");
 436   it.CurrentEntry = directory_entry(path_null.str());
 437   return directory_iterator_increment(it);
 438 }
 439
 440 error_code directory_iterator_destruct(directory_iterator& it) {
 441   if (it.IterationHandle)
 442     ::closedir(reinterpret_cast<DIR *>(it.IterationHandle));
 443   it.IterationHandle = 0;
 444   it.CurrentEntry = directory_entry();
 445   return success;
 446 }
 447
 448 error_code directory_iterator_increment(directory_iterator& it) {
 449   errno = 0;
 450   dirent *cur_dir = ::readdir(reinterpret_cast<DIR *>(it.IterationHandle));
 451   if (cur_dir == 0 && errno != 0) {
 452     return error_code(errno, system_category());
 453   } else if (cur_dir != 0) {
 454     StringRef name(cur_dir->d_name, NAMLEN(cur_dir));
 455     if ((name.size() == 1 && name[0] == '.') ||
 456         (name.size() == 2 && name[0] == '.' && name[1] == '.'))
 457       return directory_iterator_increment(it);
 458     it.CurrentEntry.replace_filename(name);
 459   } else
 460     return directory_iterator_destruct(it);
 461
 462   return success;
 463 }
 464
 465 error_code get_magic(const Twine &path, uint32_t len,
 466                      SmallVectorImpl<char> &result) {
 467   SmallString<128> PathStorage;
 468   StringRef Path = path.toNullTerminatedStringRef(PathStorage);
 469   result.set_size(0);
 470
 471   // Open path.
 472   std::FILE *file = std::fopen(Path.data(), "rb");
 473   if (file == 0)
 474     return error_code(errno, system_category());
 475
 476   // Reserve storage.
 477   result.reserve(len);
 478
 479   // Read magic!
 480   size_t size = std::fread(result.data(), 1, len, file);
 481   if (std::ferror(file) != 0) {
 482     std::fclose(file);
 483     return error_code(errno, system_category());
 484   } else if (size != result.size()) {
 485     if (std::feof(file) != 0) {
 486       std::fclose(file);
 487       result.set_size(size);
 488       return make_error_code(errc::value_too_large);
 489     }
 490   }
 491   std::fclose(file);
 492   result.set_size(len);
 493   return success;
 494 }
 495
 496 } // end namespace fs
 497 } // end namespace sys
 498 } // end namespace llvm