lib/Support/Unix/Path.inc

   1 //===- llvm/Support/Unix/Path.inc - 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 Path 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 #include <limits.h>
  21 #include <stdio.h>
  22 #if HAVE_SYS_STAT_H
  23 #include <sys/stat.h>
  24 #endif
  25 #if HAVE_FCNTL_H
  26 #include <fcntl.h>
  27 #endif
  28 #ifdef HAVE_UNISTD_H
  29 #include <unistd.h>
  30 #endif
  31 #ifdef HAVE_SYS_MMAN_H
  32 #include <sys/mman.h>
  33 #endif
  34 #if HAVE_DIRENT_H
  35 # include <dirent.h>
  36 # define NAMLEN(dirent) strlen((dirent)->d_name)
  37 #else
  38 # define dirent direct
  39 # define NAMLEN(dirent) (dirent)->d_namlen
  40 # if HAVE_SYS_NDIR_H
  41 #  include <sys/ndir.h>
  42 # endif
  43 # if HAVE_SYS_DIR_H
  44 #  include <sys/dir.h>
  45 # endif
  46 # if HAVE_NDIR_H
  47 #  include <ndir.h>
  48 # endif
  49 #endif
  50
  51 #include <pwd.h>
  52
  53 #ifdef __APPLE__
  54 #include <mach-o/dyld.h>
  55 #include <sys/attr.h>
  56 #endif
  57
  58 // Both stdio.h and cstdio are included via different paths and
  59 // stdcxx's cstdio doesn't include stdio.h, so it doesn't #undef the macros
  60 // either.
  61 #undef ferror
  62 #undef feof
  63
  64 // For GNU Hurd
  65 #if defined(__GNU__) && !defined(PATH_MAX)
  66 # define PATH_MAX 4096
  67 #endif
  68
  69 #include <sys/types.h>
  70 #if !defined(__APPLE__) && !defined(__OpenBSD__) && !defined(__FreeBSD__) &&   \
  71     !defined(__linux__)
  72 #include <sys/statvfs.h>
  73 #define STATVFS statvfs
  74 #define FSTATVFS fstatvfs
  75 #define STATVFS_F_FRSIZE(vfs) vfs.f_frsize
  76 #else
  77 #if defined(__OpenBSD__) || defined(__FreeBSD__)
  78 #include <sys/param.h>
  79 #include <sys/mount.h>
  80 #elif defined(__linux__)
  81 #if defined(HAVE_LINUX_MAGIC_H)
  82 #include <linux/magic.h>
  83 #else
  84 #if defined(HAVE_LINUX_NFS_FS_H)
  85 #include <linux/nfs_fs.h>
  86 #endif
  87 #if defined(HAVE_LINUX_SMB_H)
  88 #include <linux/smb.h>
  89 #endif
  90 #endif
  91 #include <sys/vfs.h>
  92 #else
  93 #include <sys/mount.h>
  94 #endif
  95 #define STATVFS statfs
  96 #define FSTATVFS fstatfs
  97 #define STATVFS_F_FRSIZE(vfs) static_cast<uint64_t>(vfs.f_bsize)
  98 #endif
  99
 100 #if defined(__NetBSD__)
 101 #define STATVFS_F_FLAG(vfs) (vfs).f_flag
 102 #else
 103 #define STATVFS_F_FLAG(vfs) (vfs).f_flags
 104 #endif
 105
 106 using namespace llvm;
 107
 108 namespace llvm {
 109 namespace sys  {
 110 namespace fs {
 111 #if defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
 112     defined(__OpenBSD__) || defined(__minix) || defined(__FreeBSD_kernel__) || \
 113     defined(__linux__) || defined(__CYGWIN__) || defined(__DragonFly__) || \
 114     defined(_AIX)
 115 static int
 116 test_dir(char ret[PATH_MAX], const char *dir, const char *bin)
 117 {
 118   struct stat sb;
 119   char fullpath[PATH_MAX];
 120
 121   snprintf(fullpath, PATH_MAX, "%s/%s", dir, bin);
 122   if (!realpath(fullpath, ret))
 123     return 1;
 124   if (stat(fullpath, &sb) != 0)
 125     return 1;
 126
 127   return 0;
 128 }
 129
 130 static char *
 131 getprogpath(char ret[PATH_MAX], const char *bin)
 132 {
 133   char *pv, *s, *t;
 134
 135   /* First approach: absolute path. */
 136   if (bin[0] == '/') {
 137     if (test_dir(ret, "/", bin) == 0)
 138       return ret;
 139     return nullptr;
 140   }
 141
 142   /* Second approach: relative path. */
 143   if (strchr(bin, '/')) {
 144     char cwd[PATH_MAX];
 145     if (!getcwd(cwd, PATH_MAX))
 146       return nullptr;
 147     if (test_dir(ret, cwd, bin) == 0)
 148       return ret;
 149     return nullptr;
 150   }
 151
 152   /* Third approach: $PATH */
 153   if ((pv = getenv("PATH")) == nullptr)
 154     return nullptr;
 155   s = pv = strdup(pv);
 156   if (!pv)
 157     return nullptr;
 158   while ((t = strsep(&s, ":")) != nullptr) {
 159     if (test_dir(ret, t, bin) == 0) {
 160       free(pv);
 161       return ret;
 162     }
 163   }
 164   free(pv);
 165   return nullptr;
 166 }
 167 #endif // __FreeBSD__ || __NetBSD__ || __FreeBSD_kernel__
 168
 169 /// GetMainExecutable - Return the path to the main executable, given the
 170 /// value of argv[0] from program startup.
 171 std::string getMainExecutable(const char *argv0, void *MainAddr) {
 172 #if defined(__APPLE__)
 173   // On OS X the executable path is saved to the stack by dyld. Reading it
 174   // from there is much faster than calling dladdr, especially for large
 175   // binaries with symbols.
 176   char exe_path[MAXPATHLEN];
 177   uint32_t size = sizeof(exe_path);
 178   if (_NSGetExecutablePath(exe_path, &size) == 0) {
 179     char link_path[MAXPATHLEN];
 180     if (realpath(exe_path, link_path))
 181       return link_path;
 182   }
 183 #elif defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
 184       defined(__OpenBSD__) || defined(__minix) || defined(__DragonFly__) || \
 185       defined(__FreeBSD_kernel__) || defined(_AIX)
 186   char exe_path[PATH_MAX];
 187
 188   if (getprogpath(exe_path, argv0) != NULL)
 189     return exe_path;
 190 #elif defined(__linux__) || defined(__CYGWIN__)
 191   char exe_path[MAXPATHLEN];
 192   StringRef aPath("/proc/self/exe");
 193   if (sys::fs::exists(aPath)) {
 194       // /proc is not always mounted under Linux (chroot for example).
 195       ssize_t len = readlink(aPath.str().c_str(), exe_path, sizeof(exe_path));
 196       if (len >= 0)
 197           return std::string(exe_path, len);
 198   } else {
 199       // Fall back to the classical detection.
 200       if (getprogpath(exe_path, argv0))
 201         return exe_path;
 202   }
 203 #elif defined(HAVE_DLFCN_H) && defined(HAVE_DLADDR)
 204   // Use dladdr to get executable path if available.
 205   Dl_info DLInfo;
 206   int err = dladdr(MainAddr, &DLInfo);
 207   if (err == 0)
 208     return "";
 209
 210   // If the filename is a symlink, we need to resolve and return the location of
 211   // the actual executable.
 212   char link_path[MAXPATHLEN];
 213   if (realpath(DLInfo.dli_fname, link_path))
 214     return link_path;
 215 #else
 216 #error GetMainExecutable is not implemented on this host yet.
 217 #endif
 218   return "";
 219 }
 220
 221 TimePoint<> file_status::getLastAccessedTime() const {
 222   return toTimePoint(fs_st_atime);
 223 }
 224
 225 TimePoint<> file_status::getLastModificationTime() const {
 226   return toTimePoint(fs_st_mtime);
 227 }
 228
 229 UniqueID file_status::getUniqueID() const {
 230   return UniqueID(fs_st_dev, fs_st_ino);
 231 }
 232
 233 ErrorOr<space_info> disk_space(const Twine &Path) {
 234   struct STATVFS Vfs;
 235   if (::STATVFS(Path.str().c_str(), &Vfs))
 236     return std::error_code(errno, std::generic_category());
 237   auto FrSize = STATVFS_F_FRSIZE(Vfs);
 238   space_info SpaceInfo;
 239   SpaceInfo.capacity = static_cast<uint64_t>(Vfs.f_blocks) * FrSize;
 240   SpaceInfo.free = static_cast<uint64_t>(Vfs.f_bfree) * FrSize;
 241   SpaceInfo.available = static_cast<uint64_t>(Vfs.f_bavail) * FrSize;
 242   return SpaceInfo;
 243 }
 244
 245 std::error_code current_path(SmallVectorImpl<char> &result) {
 246   result.clear();
 247
 248   const char *pwd = ::getenv("PWD");
 249   llvm::sys::fs::file_status PWDStatus, DotStatus;
 250   if (pwd && llvm::sys::path::is_absolute(pwd) &&
 251       !llvm::sys::fs::status(pwd, PWDStatus) &&
 252       !llvm::sys::fs::status(".", DotStatus) &&
 253       PWDStatus.getUniqueID() == DotStatus.getUniqueID()) {
 254     result.append(pwd, pwd + strlen(pwd));
 255     return std::error_code();
 256   }
 257
 258 #ifdef MAXPATHLEN
 259   result.reserve(MAXPATHLEN);
 260 #else
 261 // For GNU Hurd
 262   result.reserve(1024);
 263 #endif
 264
 265   while (true) {
 266     if (::getcwd(result.data(), result.capacity()) == nullptr) {
 267       // See if there was a real error.
 268       if (errno != ENOMEM)
 269         return std::error_code(errno, std::generic_category());
 270       // Otherwise there just wasn't enough space.
 271       result.reserve(result.capacity() * 2);
 272     } else
 273       break;
 274   }
 275
 276   result.set_size(strlen(result.data()));
 277   return std::error_code();
 278 }
 279
 280 std::error_code set_current_path(const Twine &path) {
 281   SmallString<128> path_storage;
 282   StringRef p = path.toNullTerminatedStringRef(path_storage);
 283
 284   if (::chdir(p.begin()) == -1)
 285     return std::error_code(errno, std::generic_category());
 286
 287   return std::error_code();
 288 }
 289
 290 std::error_code create_directory(const Twine &path, bool IgnoreExisting,
 291                                  perms Perms) {
 292   SmallString<128> path_storage;
 293   StringRef p = path.toNullTerminatedStringRef(path_storage);
 294
 295   if (::mkdir(p.begin(), Perms) == -1) {
 296     if (errno != EEXIST || !IgnoreExisting)
 297       return std::error_code(errno, std::generic_category());
 298   }
 299
 300   return std::error_code();
 301 }
 302
 303 // Note that we are using symbolic link because hard links are not supported by
 304 // all filesystems (SMB doesn't).
 305 std::error_code create_link(const Twine &to, const Twine &from) {
 306   // Get arguments.
 307   SmallString<128> from_storage;
 308   SmallString<128> to_storage;
 309   StringRef f = from.toNullTerminatedStringRef(from_storage);
 310   StringRef t = to.toNullTerminatedStringRef(to_storage);
 311
 312   if (::symlink(t.begin(), f.begin()) == -1)
 313     return std::error_code(errno, std::generic_category());
 314
 315   return std::error_code();
 316 }
 317
 318 std::error_code create_hard_link(const Twine &to, const Twine &from) {
 319   // Get arguments.
 320   SmallString<128> from_storage;
 321   SmallString<128> to_storage;
 322   StringRef f = from.toNullTerminatedStringRef(from_storage);
 323   StringRef t = to.toNullTerminatedStringRef(to_storage);
 324
 325   if (::link(t.begin(), f.begin()) == -1)
 326     return std::error_code(errno, std::generic_category());
 327
 328   return std::error_code();
 329 }
 330
 331 std::error_code remove(const Twine &path, bool IgnoreNonExisting) {
 332   SmallString<128> path_storage;
 333   StringRef p = path.toNullTerminatedStringRef(path_storage);
 334
 335   struct stat buf;
 336   if (lstat(p.begin(), &buf) != 0) {
 337     if (errno != ENOENT || !IgnoreNonExisting)
 338       return std::error_code(errno, std::generic_category());
 339     return std::error_code();
 340   }
 341
 342   // Note: this check catches strange situations. In all cases, LLVM should
 343   // only be involved in the creation and deletion of regular files.  This
 344   // check ensures that what we're trying to erase is a regular file. It
 345   // effectively prevents LLVM from erasing things like /dev/null, any block
 346   // special file, or other things that aren't "regular" files.
 347   if (!S_ISREG(buf.st_mode) && !S_ISDIR(buf.st_mode) && !S_ISLNK(buf.st_mode))
 348     return make_error_code(errc::operation_not_permitted);
 349
 350   if (::remove(p.begin()) == -1) {
 351     if (errno != ENOENT || !IgnoreNonExisting)
 352       return std::error_code(errno, std::generic_category());
 353   }
 354
 355   return std::error_code();
 356 }
 357
 358 static bool is_local_impl(struct STATVFS &Vfs) {
 359 #if defined(__linux__)
 360 #ifndef NFS_SUPER_MAGIC
 361 #define NFS_SUPER_MAGIC 0x6969
 362 #endif
 363 #ifndef SMB_SUPER_MAGIC
 364 #define SMB_SUPER_MAGIC 0x517B
 365 #endif
 366 #ifndef CIFS_MAGIC_NUMBER
 367 #define CIFS_MAGIC_NUMBER 0xFF534D42
 368 #endif
 369   switch ((uint32_t)Vfs.f_type) {
 370   case NFS_SUPER_MAGIC:
 371   case SMB_SUPER_MAGIC:
 372   case CIFS_MAGIC_NUMBER:
 373     return false;
 374   default:
 375     return true;
 376   }
 377 #elif defined(__CYGWIN__)
 378   // Cygwin doesn't expose this information; would need to use Win32 API.
 379   return false;
 380 #else
 381   return !!(STATVFS_F_FLAG(Vfs) & MNT_LOCAL);
 382 #endif
 383 }
 384
 385 std::error_code is_local(const Twine &Path, bool &Result) {
 386   struct STATVFS Vfs;
 387   if (::STATVFS(Path.str().c_str(), &Vfs))
 388     return std::error_code(errno, std::generic_category());
 389
 390   Result = is_local_impl(Vfs);
 391   return std::error_code();
 392 }
 393
 394 std::error_code is_local(int FD, bool &Result) {
 395   struct STATVFS Vfs;
 396   if (::FSTATVFS(FD, &Vfs))
 397     return std::error_code(errno, std::generic_category());
 398
 399   Result = is_local_impl(Vfs);
 400   return std::error_code();
 401 }
 402
 403 std::error_code rename(const Twine &from, const Twine &to) {
 404   // Get arguments.
 405   SmallString<128> from_storage;
 406   SmallString<128> to_storage;
 407   StringRef f = from.toNullTerminatedStringRef(from_storage);
 408   StringRef t = to.toNullTerminatedStringRef(to_storage);
 409
 410   if (::rename(f.begin(), t.begin()) == -1)
 411     return std::error_code(errno, std::generic_category());
 412
 413   return std::error_code();
 414 }
 415
 416 std::error_code resize_file(int FD, uint64_t Size) {
 417 #if defined(HAVE_POSIX_FALLOCATE)
 418   // If we have posix_fallocate use it. Unlike ftruncate it always allocates
 419   // space, so we get an error if the disk is full.
 420   if (int Err = ::posix_fallocate(FD, 0, Size))
 421     return std::error_code(Err, std::generic_category());
 422 #else
 423   // Use ftruncate as a fallback. It may or may not allocate space. At least on
 424   // OS X with HFS+ it does.
 425   if (::ftruncate(FD, Size) == -1)
 426     return std::error_code(errno, std::generic_category());
 427 #endif
 428
 429   return std::error_code();
 430 }
 431
 432 static int convertAccessMode(AccessMode Mode) {
 433   switch (Mode) {
 434   case AccessMode::Exist:
 435     return F_OK;
 436   case AccessMode::Write:
 437     return W_OK;
 438   case AccessMode::Execute:
 439     return R_OK | X_OK; // scripts also need R_OK.
 440   }
 441   llvm_unreachable("invalid enum");
 442 }
 443
 444 std::error_code access(const Twine &Path, AccessMode Mode) {
 445   SmallString<128> PathStorage;
 446   StringRef P = Path.toNullTerminatedStringRef(PathStorage);
 447
 448   if (::access(P.begin(), convertAccessMode(Mode)) == -1)
 449     return std::error_code(errno, std::generic_category());
 450
 451   if (Mode == AccessMode::Execute) {
 452     // Don't say that directories are executable.
 453     struct stat buf;
 454     if (0 != stat(P.begin(), &buf))
 455       return errc::permission_denied;
 456     if (!S_ISREG(buf.st_mode))
 457       return errc::permission_denied;
 458   }
 459
 460   return std::error_code();
 461 }
 462
 463 bool can_execute(const Twine &Path) {
 464   return !access(Path, AccessMode::Execute);
 465 }
 466
 467 bool equivalent(file_status A, file_status B) {
 468   assert(status_known(A) && status_known(B));
 469   return A.fs_st_dev == B.fs_st_dev &&
 470          A.fs_st_ino == B.fs_st_ino;
 471 }
 472
 473 std::error_code equivalent(const Twine &A, const Twine &B, bool &result) {
 474   file_status fsA, fsB;
 475   if (std::error_code ec = status(A, fsA))
 476     return ec;
 477   if (std::error_code ec = status(B, fsB))
 478     return ec;
 479   result = equivalent(fsA, fsB);
 480   return std::error_code();
 481 }
 482
 483 static void expandTildeExpr(SmallVectorImpl<char> &Path) {
 484   StringRef PathStr(Path.begin(), Path.size());
 485   if (PathStr.empty() || !PathStr.startswith("~"))
 486     return;
 487
 488   PathStr = PathStr.drop_front();
 489   StringRef Expr = PathStr.take_until(path::is_separator);
 490   StringRef Remainder = PathStr.substr(Expr.size() + 1);
 491   SmallString<128> Storage;
 492   if (Expr.empty()) {
 493     // This is just ~/..., resolve it to the current user's home dir.
 494     if (!path::home_directory(Storage)) {
 495       // For some reason we couldn't get the home directory.  Just exit.
 496       return;
 497     }
 498
 499     // Overwrite the first character and insert the rest.
 500     Path[0] = Storage[0];
 501     Path.insert(Path.begin() + 1, Storage.begin() + 1, Storage.end());
 502     return;
 503   }
 504
 505   // This is a string of the form ~username/, look up this user's entry in the
 506   // password database.
 507   struct passwd *Entry = nullptr;
 508   std::string User = Expr.str();
 509   Entry = ::getpwnam(User.c_str());
 510
 511   if (!Entry) {
 512     // Unable to look up the entry, just return back the original path.
 513     return;
 514   }
 515
 516   Storage = Remainder;
 517   Path.clear();
 518   Path.append(Entry->pw_dir, Entry->pw_dir + strlen(Entry->pw_dir));
 519   llvm::sys::path::append(Path, Storage);
 520 }
 521
 522 static std::error_code fillStatus(int StatRet, const struct stat &Status,
 523                              file_status &Result) {
 524   if (StatRet != 0) {
 525     std::error_code ec(errno, std::generic_category());
 526     if (ec == errc::no_such_file_or_directory)
 527       Result = file_status(file_type::file_not_found);
 528     else
 529       Result = file_status(file_type::status_error);
 530     return ec;
 531   }
 532
 533   file_type Type = file_type::type_unknown;
 534
 535   if (S_ISDIR(Status.st_mode))
 536     Type = file_type::directory_file;
 537   else if (S_ISREG(Status.st_mode))
 538     Type = file_type::regular_file;
 539   else if (S_ISBLK(Status.st_mode))
 540     Type = file_type::block_file;
 541   else if (S_ISCHR(Status.st_mode))
 542     Type = file_type::character_file;
 543   else if (S_ISFIFO(Status.st_mode))
 544     Type = file_type::fifo_file;
 545   else if (S_ISSOCK(Status.st_mode))
 546     Type = file_type::socket_file;
 547   else if (S_ISLNK(Status.st_mode))
 548     Type = file_type::symlink_file;
 549
 550   perms Perms = static_cast<perms>(Status.st_mode);
 551   Result =
 552       file_status(Type, Perms, Status.st_dev, Status.st_ino, Status.st_atime,
 553                   Status.st_mtime, Status.st_uid, Status.st_gid,
 554                   Status.st_size);
 555
 556   return std::error_code();
 557 }
 558
 559 std::error_code status(const Twine &Path, file_status &Result, bool Follow) {
 560   SmallString<128> PathStorage;
 561   StringRef P = Path.toNullTerminatedStringRef(PathStorage);
 562
 563   struct stat Status;
 564   int StatRet = (Follow ? ::stat : ::lstat)(P.begin(), &Status);
 565   return fillStatus(StatRet, Status, Result);
 566 }
 567
 568 std::error_code status(int FD, file_status &Result) {
 569   struct stat Status;
 570   int StatRet = ::fstat(FD, &Status);
 571   return fillStatus(StatRet, Status, Result);
 572 }
 573
 574 std::error_code setLastModificationAndAccessTime(int FD, TimePoint<> Time) {
 575 #if defined(HAVE_FUTIMENS)
 576   timespec Times[2];
 577   Times[0] = Times[1] = sys::toTimeSpec(Time);
 578   if (::futimens(FD, Times))
 579     return std::error_code(errno, std::generic_category());
 580   return std::error_code();
 581 #elif defined(HAVE_FUTIMES)
 582   timeval Times[2];
 583   Times[0] = Times[1] = sys::toTimeVal(
 584       std::chrono::time_point_cast<std::chrono::microseconds>(Time));
 585   if (::futimes(FD, Times))
 586     return std::error_code(errno, std::generic_category());
 587   return std::error_code();
 588 #else
 589 #warning Missing futimes() and futimens()
 590   return make_error_code(errc::function_not_supported);
 591 #endif
 592 }
 593
 594 std::error_code mapped_file_region::init(int FD, uint64_t Offset,
 595                                          mapmode Mode) {
 596   assert(Size != 0);
 597
 598   int flags = (Mode == readwrite) ? MAP_SHARED : MAP_PRIVATE;
 599   int prot = (Mode == readonly) ? PROT_READ : (PROT_READ | PROT_WRITE);
 600 #if defined(__APPLE__)
 601   //----------------------------------------------------------------------
 602   // Newer versions of MacOSX have a flag that will allow us to read from
 603   // binaries whose code signature is invalid without crashing by using
 604   // the MAP_RESILIENT_CODESIGN flag. Also if a file from removable media
 605   // is mapped we can avoid crashing and return zeroes to any pages we try
 606   // to read if the media becomes unavailable by using the
 607   // MAP_RESILIENT_MEDIA flag.  These flags are only usable when mapping
 608   // with PROT_READ, so take care not to specify them otherwise.
 609   //----------------------------------------------------------------------
 610   if (Mode == readonly) {
 611 #if defined(MAP_RESILIENT_CODESIGN)
 612     flags |= MAP_RESILIENT_CODESIGN;
 613 #endif
 614 #if defined(MAP_RESILIENT_MEDIA)
 615     flags |= MAP_RESILIENT_MEDIA;
 616 #endif
 617   }
 618 #endif // #if defined (__APPLE__)
 619
 620   Mapping = ::mmap(nullptr, Size, prot, flags, FD, Offset);
 621   if (Mapping == MAP_FAILED)
 622     return std::error_code(errno, std::generic_category());
 623   return std::error_code();
 624 }
 625
 626 mapped_file_region::mapped_file_region(int fd, mapmode mode, uint64_t length,
 627                                        uint64_t offset, std::error_code &ec)
 628     : Size(length), Mapping() {
 629   // Make sure that the requested size fits within SIZE_T.
 630   if (length > std::numeric_limits<size_t>::max()) {
 631     ec = make_error_code(errc::invalid_argument);
 632     return;
 633   }
 634
 635   ec = init(fd, offset, mode);
 636   if (ec)
 637     Mapping = nullptr;
 638 }
 639
 640 mapped_file_region::~mapped_file_region() {
 641   if (Mapping)
 642     ::munmap(Mapping, Size);
 643 }
 644
 645 uint64_t mapped_file_region::size() const {
 646   assert(Mapping && "Mapping failed but used anyway!");
 647   return Size;
 648 }
 649
 650 char *mapped_file_region::data() const {
 651   assert(Mapping && "Mapping failed but used anyway!");
 652   return reinterpret_cast<char*>(Mapping);
 653 }
 654
 655 const char *mapped_file_region::const_data() const {
 656   assert(Mapping && "Mapping failed but used anyway!");
 657   return reinterpret_cast<const char*>(Mapping);
 658 }
 659
 660 int mapped_file_region::alignment() {
 661   return Process::getPageSize();
 662 }
 663
 664 std::error_code detail::directory_iterator_construct(detail::DirIterState &it,
 665                                                      StringRef path,
 666                                                      bool follow_symlinks) {
 667   SmallString<128> path_null(path);
 668   DIR *directory = ::opendir(path_null.c_str());
 669   if (!directory)
 670     return std::error_code(errno, std::generic_category());
 671
 672   it.IterationHandle = reinterpret_cast<intptr_t>(directory);
 673   // Add something for replace_filename to replace.
 674   path::append(path_null, ".");
 675   it.CurrentEntry = directory_entry(path_null.str(), follow_symlinks);
 676   return directory_iterator_increment(it);
 677 }
 678
 679 std::error_code detail::directory_iterator_destruct(detail::DirIterState &it) {
 680   if (it.IterationHandle)
 681     ::closedir(reinterpret_cast<DIR *>(it.IterationHandle));
 682   it.IterationHandle = 0;
 683   it.CurrentEntry = directory_entry();
 684   return std::error_code();
 685 }
 686
 687 std::error_code detail::directory_iterator_increment(detail::DirIterState &it) {
 688   errno = 0;
 689   dirent *cur_dir = ::readdir(reinterpret_cast<DIR *>(it.IterationHandle));
 690   if (cur_dir == nullptr && errno != 0) {
 691     return std::error_code(errno, std::generic_category());
 692   } else if (cur_dir != nullptr) {
 693     StringRef name(cur_dir->d_name, NAMLEN(cur_dir));
 694     if ((name.size() == 1 && name[0] == '.') ||
 695         (name.size() == 2 && name[0] == '.' && name[1] == '.'))
 696       return directory_iterator_increment(it);
 697     it.CurrentEntry.replace_filename(name);
 698   } else
 699     return directory_iterator_destruct(it);
 700
 701   return std::error_code();
 702 }
 703
 704 #if !defined(F_GETPATH)
 705 static bool hasProcSelfFD() {
 706   // If we have a /proc filesystem mounted, we can quickly establish the
 707   // real name of the file with readlink
 708   static const bool Result = (::access("/proc/self/fd", R_OK) == 0);
 709   return Result;
 710 }
 711 #endif
 712
 713 std::error_code openFileForRead(const Twine &Name, int &ResultFD,
 714                                 SmallVectorImpl<char> *RealPath) {
 715   SmallString<128> Storage;
 716   StringRef P = Name.toNullTerminatedStringRef(Storage);
 717   int OpenFlags = O_RDONLY;
 718 #ifdef O_CLOEXEC
 719   OpenFlags |= O_CLOEXEC;
 720 #endif
 721   while ((ResultFD = open(P.begin(), OpenFlags)) < 0) {
 722     if (errno != EINTR)
 723       return std::error_code(errno, std::generic_category());
 724   }
 725 #ifndef O_CLOEXEC
 726   int r = fcntl(ResultFD, F_SETFD, FD_CLOEXEC);
 727   (void)r;
 728   assert(r == 0 && "fcntl(F_SETFD, FD_CLOEXEC) failed");
 729 #endif
 730   // Attempt to get the real name of the file, if the user asked
 731   if(!RealPath)
 732     return std::error_code();
 733   RealPath->clear();
 734 #if defined(F_GETPATH)
 735   // When F_GETPATH is availble, it is the quickest way to get
 736   // the real path name.
 737   char Buffer[MAXPATHLEN];
 738   if (::fcntl(ResultFD, F_GETPATH, Buffer) != -1)
 739     RealPath->append(Buffer, Buffer + strlen(Buffer));
 740 #else
 741   char Buffer[PATH_MAX];
 742   if (hasProcSelfFD()) {
 743     char ProcPath[64];
 744     snprintf(ProcPath, sizeof(ProcPath), "/proc/self/fd/%d", ResultFD);
 745     ssize_t CharCount = ::readlink(ProcPath, Buffer, sizeof(Buffer));
 746     if (CharCount > 0)
 747       RealPath->append(Buffer, Buffer + CharCount);
 748   } else {
 749     // Use ::realpath to get the real path name
 750     if (::realpath(P.begin(), Buffer) != nullptr)
 751       RealPath->append(Buffer, Buffer + strlen(Buffer));
 752   }
 753 #endif
 754   return std::error_code();
 755 }
 756
 757 std::error_code openFileForWrite(const Twine &Name, int &ResultFD,
 758                             sys::fs::OpenFlags Flags, unsigned Mode) {
 759   // Verify that we don't have both "append" and "excl".
 760   assert((!(Flags & sys::fs::F_Excl) || !(Flags & sys::fs::F_Append)) &&
 761          "Cannot specify both 'excl' and 'append' file creation flags!");
 762
 763   int OpenFlags = O_CREAT;
 764
 765 #ifdef O_CLOEXEC
 766   OpenFlags |= O_CLOEXEC;
 767 #endif
 768
 769   if (Flags & F_RW)
 770     OpenFlags |= O_RDWR;
 771   else
 772     OpenFlags |= O_WRONLY;
 773
 774   if (Flags & F_Append)
 775     OpenFlags |= O_APPEND;
 776   else
 777     OpenFlags |= O_TRUNC;
 778
 779   if (Flags & F_Excl)
 780     OpenFlags |= O_EXCL;
 781
 782   SmallString<128> Storage;
 783   StringRef P = Name.toNullTerminatedStringRef(Storage);
 784   while ((ResultFD = open(P.begin(), OpenFlags, Mode)) < 0) {
 785     if (errno != EINTR)
 786       return std::error_code(errno, std::generic_category());
 787   }
 788 #ifndef O_CLOEXEC
 789   int r = fcntl(ResultFD, F_SETFD, FD_CLOEXEC);
 790   (void)r;
 791   assert(r == 0 && "fcntl(F_SETFD, FD_CLOEXEC) failed");
 792 #endif
 793   return std::error_code();
 794 }
 795
 796 std::error_code getPathFromOpenFD(int FD, SmallVectorImpl<char> &ResultPath) {
 797   if (FD < 0)
 798     return make_error_code(errc::bad_file_descriptor);
 799
 800 #if defined(F_GETPATH)
 801   // When F_GETPATH is availble, it is the quickest way to get
 802   // the path from a file descriptor.
 803   ResultPath.reserve(MAXPATHLEN);
 804   if (::fcntl(FD, F_GETPATH, ResultPath.begin()) == -1)
 805     return std::error_code(errno, std::generic_category());
 806
 807   ResultPath.set_size(strlen(ResultPath.begin()));
 808 #else
 809   // If we have a /proc filesystem mounted, we can quickly establish the
 810   // real name of the file with readlink. Otherwise, we don't know how to
 811   // get the filename from a file descriptor. Give up.
 812   if (!fs::hasProcSelfFD())
 813     return make_error_code(errc::function_not_supported);
 814
 815   ResultPath.reserve(PATH_MAX);
 816   char ProcPath[64];
 817   snprintf(ProcPath, sizeof(ProcPath), "/proc/self/fd/%d", FD);
 818   ssize_t CharCount = ::readlink(ProcPath, ResultPath.begin(), ResultPath.capacity());
 819   if (CharCount < 0)
 820       return std::error_code(errno, std::generic_category());
 821
 822   // Was the filename truncated?
 823   if (static_cast<size_t>(CharCount) == ResultPath.capacity()) {
 824     // Use lstat to get the size of the filename
 825     struct stat sb;
 826     if (::lstat(ProcPath, &sb) < 0)
 827       return std::error_code(errno, std::generic_category());
 828
 829     ResultPath.reserve(sb.st_size + 1);
 830     CharCount = ::readlink(ProcPath, ResultPath.begin(), ResultPath.capacity());
 831     if (CharCount < 0)
 832       return std::error_code(errno, std::generic_category());
 833
 834     // Test for race condition: did the link size change?
 835     if (CharCount > sb.st_size)
 836       return std::error_code(ENAMETOOLONG, std::generic_category());
 837   }
 838   ResultPath.set_size(static_cast<size_t>(CharCount));
 839 #endif
 840   return std::error_code();
 841 }
 842
 843 template <typename T>
 844 static std::error_code remove_directories_impl(const T &Entry,
 845                                                bool IgnoreErrors) {
 846   std::error_code EC;
 847   directory_iterator Begin(Entry, EC, false);
 848   directory_iterator End;
 849   while (Begin != End) {
 850     auto &Item = *Begin;
 851     file_status st;
 852     EC = Item.status(st);
 853     if (EC && !IgnoreErrors)
 854       return EC;
 855
 856     if (is_directory(st)) {
 857       EC = remove_directories_impl(Item, IgnoreErrors);
 858       if (EC && !IgnoreErrors)
 859         return EC;
 860     }
 861
 862     EC = fs::remove(Item.path(), true);
 863     if (EC && !IgnoreErrors)
 864       return EC;
 865
 866     Begin.increment(EC);
 867     if (EC && !IgnoreErrors)
 868       return EC;
 869   }
 870   return std::error_code();
 871 }
 872
 873 std::error_code remove_directories(const Twine &path, bool IgnoreErrors) {
 874   auto EC = remove_directories_impl(path, IgnoreErrors);
 875   if (EC && !IgnoreErrors)
 876     return EC;
 877   EC = fs::remove(path, true);
 878   if (EC && !IgnoreErrors)
 879     return EC;
 880   return std::error_code();
 881 }
 882
 883 std::error_code real_path(const Twine &path, SmallVectorImpl<char> &dest,
 884                           bool expand_tilde) {
 885   dest.clear();
 886   if (path.isTriviallyEmpty())
 887     return std::error_code();
 888
 889   if (expand_tilde) {
 890     SmallString<128> Storage;
 891     path.toVector(Storage);
 892     expandTildeExpr(Storage);
 893     return real_path(Storage, dest, false);
 894   }
 895
 896   int fd;
 897   std::error_code EC = openFileForRead(path, fd, &dest);
 898
 899   if (EC)
 900     return EC;
 901   ::close(fd);
 902   return std::error_code();
 903 }
 904
 905 } // end namespace fs
 906
 907 namespace path {
 908
 909 bool home_directory(SmallVectorImpl<char> &result) {
 910   if (char *RequestedDir = getenv("HOME")) {
 911     result.clear();
 912     result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
 913     return true;
 914   }
 915   return false;
 916 }
 917
 918 static bool getDarwinConfDir(bool TempDir, SmallVectorImpl<char> &Result) {
 919   #if defined(_CS_DARWIN_USER_TEMP_DIR) && defined(_CS_DARWIN_USER_CACHE_DIR)
 920   // On Darwin, use DARWIN_USER_TEMP_DIR or DARWIN_USER_CACHE_DIR.
 921   // macros defined in <unistd.h> on darwin >= 9
 922   int ConfName = TempDir ? _CS_DARWIN_USER_TEMP_DIR
 923                          : _CS_DARWIN_USER_CACHE_DIR;
 924   size_t ConfLen = confstr(ConfName, nullptr, 0);
 925   if (ConfLen > 0) {
 926     do {
 927       Result.resize(ConfLen);
 928       ConfLen = confstr(ConfName, Result.data(), Result.size());
 929     } while (ConfLen > 0 && ConfLen != Result.size());
 930
 931     if (ConfLen > 0) {
 932       assert(Result.back() == 0);
 933       Result.pop_back();
 934       return true;
 935     }
 936
 937     Result.clear();
 938   }
 939   #endif
 940   return false;
 941 }
 942
 943 static bool getUserCacheDir(SmallVectorImpl<char> &Result) {
 944   // First try using XDG_CACHE_HOME env variable,
 945   // as specified in XDG Base Directory Specification at
 946   // http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
 947   if (const char *XdgCacheDir = std::getenv("XDG_CACHE_HOME")) {
 948     Result.clear();
 949     Result.append(XdgCacheDir, XdgCacheDir + strlen(XdgCacheDir));
 950     return true;
 951   }
 952
 953   // Try Darwin configuration query
 954   if (getDarwinConfDir(false, Result))
 955     return true;
 956
 957   // Use "$HOME/.cache" if $HOME is available
 958   if (home_directory(Result)) {
 959     append(Result, ".cache");
 960     return true;
 961   }
 962
 963   return false;
 964 }
 965
 966 static const char *getEnvTempDir() {
 967   // Check whether the temporary directory is specified by an environment
 968   // variable.
 969   const char *EnvironmentVariables[] = {"TMPDIR", "TMP", "TEMP", "TEMPDIR"};
 970   for (const char *Env : EnvironmentVariables) {
 971     if (const char *Dir = std::getenv(Env))
 972       return Dir;
 973   }
 974
 975   return nullptr;
 976 }
 977
 978 static const char *getDefaultTempDir(bool ErasedOnReboot) {
 979 #ifdef P_tmpdir
 980   if ((bool)P_tmpdir)
 981     return P_tmpdir;
 982 #endif
 983
 984   if (ErasedOnReboot)
 985     return "/tmp";
 986   return "/var/tmp";
 987 }
 988
 989 void system_temp_directory(bool ErasedOnReboot, SmallVectorImpl<char> &Result) {
 990   Result.clear();
 991
 992   if (ErasedOnReboot) {
 993     // There is no env variable for the cache directory.
 994     if (const char *RequestedDir = getEnvTempDir()) {
 995       Result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
 996       return;
 997     }
 998   }
 999
1000   if (getDarwinConfDir(ErasedOnReboot, Result))
1001     return;
1002
1003   const char *RequestedDir = getDefaultTempDir(ErasedOnReboot);
1004   Result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
1005 }
1006
1007 } // end namespace path
1008
1009 } // end namespace sys
1010 } // end namespace llvm