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/mount.h>
  79 #include <sys/param.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 uint32_t file_status::getLinkCount() const {
 234   return fs_st_nlinks;
 235 }
 236
 237 ErrorOr<space_info> disk_space(const Twine &Path) {
 238   struct STATVFS Vfs;
 239   if (::STATVFS(Path.str().c_str(), &Vfs))
 240     return std::error_code(errno, std::generic_category());
 241   auto FrSize = STATVFS_F_FRSIZE(Vfs);
 242   space_info SpaceInfo;
 243   SpaceInfo.capacity = static_cast<uint64_t>(Vfs.f_blocks) * FrSize;
 244   SpaceInfo.free = static_cast<uint64_t>(Vfs.f_bfree) * FrSize;
 245   SpaceInfo.available = static_cast<uint64_t>(Vfs.f_bavail) * FrSize;
 246   return SpaceInfo;
 247 }
 248
 249 std::error_code current_path(SmallVectorImpl<char> &result) {
 250   result.clear();
 251
 252   const char *pwd = ::getenv("PWD");
 253   llvm::sys::fs::file_status PWDStatus, DotStatus;
 254   if (pwd && llvm::sys::path::is_absolute(pwd) &&
 255       !llvm::sys::fs::status(pwd, PWDStatus) &&
 256       !llvm::sys::fs::status(".", DotStatus) &&
 257       PWDStatus.getUniqueID() == DotStatus.getUniqueID()) {
 258     result.append(pwd, pwd + strlen(pwd));
 259     return std::error_code();
 260   }
 261
 262 #ifdef MAXPATHLEN
 263   result.reserve(MAXPATHLEN);
 264 #else
 265 // For GNU Hurd
 266   result.reserve(1024);
 267 #endif
 268
 269   while (true) {
 270     if (::getcwd(result.data(), result.capacity()) == nullptr) {
 271       // See if there was a real error.
 272       if (errno != ENOMEM)
 273         return std::error_code(errno, std::generic_category());
 274       // Otherwise there just wasn't enough space.
 275       result.reserve(result.capacity() * 2);
 276     } else
 277       break;
 278   }
 279
 280   result.set_size(strlen(result.data()));
 281   return std::error_code();
 282 }
 283
 284 std::error_code set_current_path(const Twine &path) {
 285   SmallString<128> path_storage;
 286   StringRef p = path.toNullTerminatedStringRef(path_storage);
 287
 288   if (::chdir(p.begin()) == -1)
 289     return std::error_code(errno, std::generic_category());
 290
 291   return std::error_code();
 292 }
 293
 294 std::error_code create_directory(const Twine &path, bool IgnoreExisting,
 295                                  perms Perms) {
 296   SmallString<128> path_storage;
 297   StringRef p = path.toNullTerminatedStringRef(path_storage);
 298
 299   if (::mkdir(p.begin(), Perms) == -1) {
 300     if (errno != EEXIST || !IgnoreExisting)
 301       return std::error_code(errno, std::generic_category());
 302   }
 303
 304   return std::error_code();
 305 }
 306
 307 // Note that we are using symbolic link because hard links are not supported by
 308 // all filesystems (SMB doesn't).
 309 std::error_code create_link(const Twine &to, const Twine &from) {
 310   // Get arguments.
 311   SmallString<128> from_storage;
 312   SmallString<128> to_storage;
 313   StringRef f = from.toNullTerminatedStringRef(from_storage);
 314   StringRef t = to.toNullTerminatedStringRef(to_storage);
 315
 316   if (::symlink(t.begin(), f.begin()) == -1)
 317     return std::error_code(errno, std::generic_category());
 318
 319   return std::error_code();
 320 }
 321
 322 std::error_code create_hard_link(const Twine &to, const Twine &from) {
 323   // Get arguments.
 324   SmallString<128> from_storage;
 325   SmallString<128> to_storage;
 326   StringRef f = from.toNullTerminatedStringRef(from_storage);
 327   StringRef t = to.toNullTerminatedStringRef(to_storage);
 328
 329   if (::link(t.begin(), f.begin()) == -1)
 330     return std::error_code(errno, std::generic_category());
 331
 332   return std::error_code();
 333 }
 334
 335 std::error_code remove(const Twine &path, bool IgnoreNonExisting) {
 336   SmallString<128> path_storage;
 337   StringRef p = path.toNullTerminatedStringRef(path_storage);
 338
 339   struct stat buf;
 340   if (lstat(p.begin(), &buf) != 0) {
 341     if (errno != ENOENT || !IgnoreNonExisting)
 342       return std::error_code(errno, std::generic_category());
 343     return std::error_code();
 344   }
 345
 346   // Note: this check catches strange situations. In all cases, LLVM should
 347   // only be involved in the creation and deletion of regular files.  This
 348   // check ensures that what we're trying to erase is a regular file. It
 349   // effectively prevents LLVM from erasing things like /dev/null, any block
 350   // special file, or other things that aren't "regular" files.
 351   if (!S_ISREG(buf.st_mode) && !S_ISDIR(buf.st_mode) && !S_ISLNK(buf.st_mode))
 352     return make_error_code(errc::operation_not_permitted);
 353
 354   if (::remove(p.begin()) == -1) {
 355     if (errno != ENOENT || !IgnoreNonExisting)
 356       return std::error_code(errno, std::generic_category());
 357   }
 358
 359   return std::error_code();
 360 }
 361
 362 static bool is_local_impl(struct STATVFS &Vfs) {
 363 #if defined(__linux__)
 364 #ifndef NFS_SUPER_MAGIC
 365 #define NFS_SUPER_MAGIC 0x6969
 366 #endif
 367 #ifndef SMB_SUPER_MAGIC
 368 #define SMB_SUPER_MAGIC 0x517B
 369 #endif
 370 #ifndef CIFS_MAGIC_NUMBER
 371 #define CIFS_MAGIC_NUMBER 0xFF534D42
 372 #endif
 373   switch ((uint32_t)Vfs.f_type) {
 374   case NFS_SUPER_MAGIC:
 375   case SMB_SUPER_MAGIC:
 376   case CIFS_MAGIC_NUMBER:
 377     return false;
 378   default:
 379     return true;
 380   }
 381 #elif defined(__CYGWIN__)
 382   // Cygwin doesn't expose this information; would need to use Win32 API.
 383   return false;
 384 #elif defined(__sun)
 385   // statvfs::f_basetype contains a null-terminated FSType name of the mounted target
 386   StringRef fstype(Vfs.f_basetype);
 387   // NFS is the only non-local fstype??
 388   return !fstype.equals("nfs");
 389 #else
 390   return !!(STATVFS_F_FLAG(Vfs) & MNT_LOCAL);
 391 #endif
 392 }
 393
 394 std::error_code is_local(const Twine &Path, bool &Result) {
 395   struct STATVFS Vfs;
 396   if (::STATVFS(Path.str().c_str(), &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 is_local(int FD, bool &Result) {
 404   struct STATVFS Vfs;
 405   if (::FSTATVFS(FD, &Vfs))
 406     return std::error_code(errno, std::generic_category());
 407
 408   Result = is_local_impl(Vfs);
 409   return std::error_code();
 410 }
 411
 412 std::error_code rename(const Twine &from, const Twine &to) {
 413   // Get arguments.
 414   SmallString<128> from_storage;
 415   SmallString<128> to_storage;
 416   StringRef f = from.toNullTerminatedStringRef(from_storage);
 417   StringRef t = to.toNullTerminatedStringRef(to_storage);
 418
 419   if (::rename(f.begin(), t.begin()) == -1)
 420     return std::error_code(errno, std::generic_category());
 421
 422   return std::error_code();
 423 }
 424
 425 std::error_code resize_file(int FD, uint64_t Size) {
 426 #if defined(HAVE_POSIX_FALLOCATE)
 427   // If we have posix_fallocate use it. Unlike ftruncate it always allocates
 428   // space, so we get an error if the disk is full.
 429   if (int Err = ::posix_fallocate(FD, 0, Size)) {
 430     if (Err != EOPNOTSUPP)
 431       return std::error_code(Err, std::generic_category());
 432   }
 433 #endif
 434   // Use ftruncate as a fallback. It may or may not allocate space. At least on
 435   // OS X with HFS+ it does.
 436   if (::ftruncate(FD, Size) == -1)
 437     return std::error_code(errno, std::generic_category());
 438
 439   return std::error_code();
 440 }
 441
 442 static int convertAccessMode(AccessMode Mode) {
 443   switch (Mode) {
 444   case AccessMode::Exist:
 445     return F_OK;
 446   case AccessMode::Write:
 447     return W_OK;
 448   case AccessMode::Execute:
 449     return R_OK | X_OK; // scripts also need R_OK.
 450   }
 451   llvm_unreachable("invalid enum");
 452 }
 453
 454 std::error_code access(const Twine &Path, AccessMode Mode) {
 455   SmallString<128> PathStorage;
 456   StringRef P = Path.toNullTerminatedStringRef(PathStorage);
 457
 458   if (::access(P.begin(), convertAccessMode(Mode)) == -1)
 459     return std::error_code(errno, std::generic_category());
 460
 461   if (Mode == AccessMode::Execute) {
 462     // Don't say that directories are executable.
 463     struct stat buf;
 464     if (0 != stat(P.begin(), &buf))
 465       return errc::permission_denied;
 466     if (!S_ISREG(buf.st_mode))
 467       return errc::permission_denied;
 468   }
 469
 470   return std::error_code();
 471 }
 472
 473 bool can_execute(const Twine &Path) {
 474   return !access(Path, AccessMode::Execute);
 475 }
 476
 477 bool equivalent(file_status A, file_status B) {
 478   assert(status_known(A) && status_known(B));
 479   return A.fs_st_dev == B.fs_st_dev &&
 480          A.fs_st_ino == B.fs_st_ino;
 481 }
 482
 483 std::error_code equivalent(const Twine &A, const Twine &B, bool &result) {
 484   file_status fsA, fsB;
 485   if (std::error_code ec = status(A, fsA))
 486     return ec;
 487   if (std::error_code ec = status(B, fsB))
 488     return ec;
 489   result = equivalent(fsA, fsB);
 490   return std::error_code();
 491 }
 492
 493 static void expandTildeExpr(SmallVectorImpl<char> &Path) {
 494   StringRef PathStr(Path.begin(), Path.size());
 495   if (PathStr.empty() || !PathStr.startswith("~"))
 496     return;
 497
 498   PathStr = PathStr.drop_front();
 499   StringRef Expr =
 500       PathStr.take_until([](char c) { return path::is_separator(c); });
 501   StringRef Remainder = PathStr.substr(Expr.size() + 1);
 502   SmallString<128> Storage;
 503   if (Expr.empty()) {
 504     // This is just ~/..., resolve it to the current user's home dir.
 505     if (!path::home_directory(Storage)) {
 506       // For some reason we couldn't get the home directory.  Just exit.
 507       return;
 508     }
 509
 510     // Overwrite the first character and insert the rest.
 511     Path[0] = Storage[0];
 512     Path.insert(Path.begin() + 1, Storage.begin() + 1, Storage.end());
 513     return;
 514   }
 515
 516   // This is a string of the form ~username/, look up this user's entry in the
 517   // password database.
 518   struct passwd *Entry = nullptr;
 519   std::string User = Expr.str();
 520   Entry = ::getpwnam(User.c_str());
 521
 522   if (!Entry) {
 523     // Unable to look up the entry, just return back the original path.
 524     return;
 525   }
 526
 527   Storage = Remainder;
 528   Path.clear();
 529   Path.append(Entry->pw_dir, Entry->pw_dir + strlen(Entry->pw_dir));
 530   llvm::sys::path::append(Path, Storage);
 531 }
 532
 533 static std::error_code fillStatus(int StatRet, const struct stat &Status,
 534                              file_status &Result) {
 535   if (StatRet != 0) {
 536     std::error_code ec(errno, std::generic_category());
 537     if (ec == errc::no_such_file_or_directory)
 538       Result = file_status(file_type::file_not_found);
 539     else
 540       Result = file_status(file_type::status_error);
 541     return ec;
 542   }
 543
 544   file_type Type = file_type::type_unknown;
 545
 546   if (S_ISDIR(Status.st_mode))
 547     Type = file_type::directory_file;
 548   else if (S_ISREG(Status.st_mode))
 549     Type = file_type::regular_file;
 550   else if (S_ISBLK(Status.st_mode))
 551     Type = file_type::block_file;
 552   else if (S_ISCHR(Status.st_mode))
 553     Type = file_type::character_file;
 554   else if (S_ISFIFO(Status.st_mode))
 555     Type = file_type::fifo_file;
 556   else if (S_ISSOCK(Status.st_mode))
 557     Type = file_type::socket_file;
 558   else if (S_ISLNK(Status.st_mode))
 559     Type = file_type::symlink_file;
 560
 561   perms Perms = static_cast<perms>(Status.st_mode) & all_perms;
 562   Result = file_status(Type, Perms, Status.st_dev, Status.st_nlink,
 563                        Status.st_ino, Status.st_atime, Status.st_mtime,
 564                        Status.st_uid, Status.st_gid, Status.st_size);
 565
 566   return std::error_code();
 567 }
 568
 569 std::error_code status(const Twine &Path, file_status &Result, bool Follow) {
 570   SmallString<128> PathStorage;
 571   StringRef P = Path.toNullTerminatedStringRef(PathStorage);
 572
 573   struct stat Status;
 574   int StatRet = (Follow ? ::stat : ::lstat)(P.begin(), &Status);
 575   return fillStatus(StatRet, Status, Result);
 576 }
 577
 578 std::error_code status(int FD, file_status &Result) {
 579   struct stat Status;
 580   int StatRet = ::fstat(FD, &Status);
 581   return fillStatus(StatRet, Status, Result);
 582 }
 583
 584 std::error_code setPermissions(const Twine &Path, perms Permissions) {
 585   SmallString<128> PathStorage;
 586   StringRef P = Path.toNullTerminatedStringRef(PathStorage);
 587
 588   if (::chmod(P.begin(), Permissions))
 589     return std::error_code(errno, std::generic_category());
 590   return std::error_code();
 591 }
 592
 593 std::error_code setLastModificationAndAccessTime(int FD, TimePoint<> Time) {
 594 #if defined(HAVE_FUTIMENS)
 595   timespec Times[2];
 596   Times[0] = Times[1] = sys::toTimeSpec(Time);
 597   if (::futimens(FD, Times))
 598     return std::error_code(errno, std::generic_category());
 599   return std::error_code();
 600 #elif defined(HAVE_FUTIMES)
 601   timeval Times[2];
 602   Times[0] = Times[1] = sys::toTimeVal(
 603       std::chrono::time_point_cast<std::chrono::microseconds>(Time));
 604   if (::futimes(FD, Times))
 605     return std::error_code(errno, std::generic_category());
 606   return std::error_code();
 607 #else
 608 #warning Missing futimes() and futimens()
 609   return make_error_code(errc::function_not_supported);
 610 #endif
 611 }
 612
 613 std::error_code mapped_file_region::init(int FD, uint64_t Offset,
 614                                          mapmode Mode) {
 615   assert(Size != 0);
 616
 617   int flags = (Mode == readwrite) ? MAP_SHARED : MAP_PRIVATE;
 618   int prot = (Mode == readonly) ? PROT_READ : (PROT_READ | PROT_WRITE);
 619 #if defined(__APPLE__)
 620   //----------------------------------------------------------------------
 621   // Newer versions of MacOSX have a flag that will allow us to read from
 622   // binaries whose code signature is invalid without crashing by using
 623   // the MAP_RESILIENT_CODESIGN flag. Also if a file from removable media
 624   // is mapped we can avoid crashing and return zeroes to any pages we try
 625   // to read if the media becomes unavailable by using the
 626   // MAP_RESILIENT_MEDIA flag.  These flags are only usable when mapping
 627   // with PROT_READ, so take care not to specify them otherwise.
 628   //----------------------------------------------------------------------
 629   if (Mode == readonly) {
 630 #if defined(MAP_RESILIENT_CODESIGN)
 631     flags |= MAP_RESILIENT_CODESIGN;
 632 #endif
 633 #if defined(MAP_RESILIENT_MEDIA)
 634     flags |= MAP_RESILIENT_MEDIA;
 635 #endif
 636   }
 637 #endif // #if defined (__APPLE__)
 638
 639   Mapping = ::mmap(nullptr, Size, prot, flags, FD, Offset);
 640   if (Mapping == MAP_FAILED)
 641     return std::error_code(errno, std::generic_category());
 642   return std::error_code();
 643 }
 644
 645 mapped_file_region::mapped_file_region(int fd, mapmode mode, uint64_t length,
 646                                        uint64_t offset, std::error_code &ec)
 647     : Size(length), Mapping() {
 648   // Make sure that the requested size fits within SIZE_T.
 649   if (length > std::numeric_limits<size_t>::max()) {
 650     ec = make_error_code(errc::invalid_argument);
 651     return;
 652   }
 653
 654   ec = init(fd, offset, mode);
 655   if (ec)
 656     Mapping = nullptr;
 657 }
 658
 659 mapped_file_region::~mapped_file_region() {
 660   if (Mapping)
 661     ::munmap(Mapping, Size);
 662 }
 663
 664 uint64_t mapped_file_region::size() const {
 665   assert(Mapping && "Mapping failed but used anyway!");
 666   return Size;
 667 }
 668
 669 char *mapped_file_region::data() const {
 670   assert(Mapping && "Mapping failed but used anyway!");
 671   return reinterpret_cast<char*>(Mapping);
 672 }
 673
 674 const char *mapped_file_region::const_data() const {
 675   assert(Mapping && "Mapping failed but used anyway!");
 676   return reinterpret_cast<const char*>(Mapping);
 677 }
 678
 679 int mapped_file_region::alignment() {
 680   return Process::getPageSize();
 681 }
 682
 683 std::error_code detail::directory_iterator_construct(detail::DirIterState &it,
 684                                                      StringRef path,
 685                                                      bool follow_symlinks) {
 686   SmallString<128> path_null(path);
 687   DIR *directory = ::opendir(path_null.c_str());
 688   if (!directory)
 689     return std::error_code(errno, std::generic_category());
 690
 691   it.IterationHandle = reinterpret_cast<intptr_t>(directory);
 692   // Add something for replace_filename to replace.
 693   path::append(path_null, ".");
 694   it.CurrentEntry = directory_entry(path_null.str(), follow_symlinks);
 695   return directory_iterator_increment(it);
 696 }
 697
 698 std::error_code detail::directory_iterator_destruct(detail::DirIterState &it) {
 699   if (it.IterationHandle)
 700     ::closedir(reinterpret_cast<DIR *>(it.IterationHandle));
 701   it.IterationHandle = 0;
 702   it.CurrentEntry = directory_entry();
 703   return std::error_code();
 704 }
 705
 706 std::error_code detail::directory_iterator_increment(detail::DirIterState &it) {
 707   errno = 0;
 708   dirent *cur_dir = ::readdir(reinterpret_cast<DIR *>(it.IterationHandle));
 709   if (cur_dir == nullptr && errno != 0) {
 710     return std::error_code(errno, std::generic_category());
 711   } else if (cur_dir != nullptr) {
 712     StringRef name(cur_dir->d_name, NAMLEN(cur_dir));
 713     if ((name.size() == 1 && name[0] == '.') ||
 714         (name.size() == 2 && name[0] == '.' && name[1] == '.'))
 715       return directory_iterator_increment(it);
 716     it.CurrentEntry.replace_filename(name);
 717   } else
 718     return directory_iterator_destruct(it);
 719
 720   return std::error_code();
 721 }
 722
 723 #if !defined(F_GETPATH)
 724 static bool hasProcSelfFD() {
 725   // If we have a /proc filesystem mounted, we can quickly establish the
 726   // real name of the file with readlink
 727   static const bool Result = (::access("/proc/self/fd", R_OK) == 0);
 728   return Result;
 729 }
 730 #endif
 731
 732 std::error_code openFileForRead(const Twine &Name, int &ResultFD,
 733                                 SmallVectorImpl<char> *RealPath) {
 734   SmallString<128> Storage;
 735   StringRef P = Name.toNullTerminatedStringRef(Storage);
 736   int OpenFlags = O_RDONLY;
 737 #ifdef O_CLOEXEC
 738   OpenFlags |= O_CLOEXEC;
 739 #endif
 740   if ((ResultFD = sys::RetryAfterSignal(-1, open, P.begin(), OpenFlags)) < 0)
 741     return std::error_code(errno, std::generic_category());
 742 #ifndef O_CLOEXEC
 743   int r = fcntl(ResultFD, F_SETFD, FD_CLOEXEC);
 744   (void)r;
 745   assert(r == 0 && "fcntl(F_SETFD, FD_CLOEXEC) failed");
 746 #endif
 747   // Attempt to get the real name of the file, if the user asked
 748   if(!RealPath)
 749     return std::error_code();
 750   RealPath->clear();
 751 #if defined(F_GETPATH)
 752   // When F_GETPATH is availble, it is the quickest way to get
 753   // the real path name.
 754   char Buffer[MAXPATHLEN];
 755   if (::fcntl(ResultFD, F_GETPATH, Buffer) != -1)
 756     RealPath->append(Buffer, Buffer + strlen(Buffer));
 757 #else
 758   char Buffer[PATH_MAX];
 759   if (hasProcSelfFD()) {
 760     char ProcPath[64];
 761     snprintf(ProcPath, sizeof(ProcPath), "/proc/self/fd/%d", ResultFD);
 762     ssize_t CharCount = ::readlink(ProcPath, Buffer, sizeof(Buffer));
 763     if (CharCount > 0)
 764       RealPath->append(Buffer, Buffer + CharCount);
 765   } else {
 766     // Use ::realpath to get the real path name
 767     if (::realpath(P.begin(), Buffer) != nullptr)
 768       RealPath->append(Buffer, Buffer + strlen(Buffer));
 769   }
 770 #endif
 771   return std::error_code();
 772 }
 773
 774 std::error_code openFileForWrite(const Twine &Name, int &ResultFD,
 775                             sys::fs::OpenFlags Flags, unsigned Mode) {
 776   // Verify that we don't have both "append" and "excl".
 777   assert((!(Flags & sys::fs::F_Excl) || !(Flags & sys::fs::F_Append)) &&
 778          "Cannot specify both 'excl' and 'append' file creation flags!");
 779
 780   int OpenFlags = O_CREAT;
 781
 782 #ifdef O_CLOEXEC
 783   OpenFlags |= O_CLOEXEC;
 784 #endif
 785
 786   if (Flags & F_RW)
 787     OpenFlags |= O_RDWR;
 788   else
 789     OpenFlags |= O_WRONLY;
 790
 791   if (Flags & F_Append)
 792     OpenFlags |= O_APPEND;
 793   else
 794     OpenFlags |= O_TRUNC;
 795
 796   if (Flags & F_Excl)
 797     OpenFlags |= O_EXCL;
 798
 799   SmallString<128> Storage;
 800   StringRef P = Name.toNullTerminatedStringRef(Storage);
 801   if ((ResultFD = sys::RetryAfterSignal(-1, open, P.begin(), OpenFlags, Mode)) < 0)
 802     return std::error_code(errno, std::generic_category());
 803 #ifndef O_CLOEXEC
 804   int r = fcntl(ResultFD, F_SETFD, FD_CLOEXEC);
 805   (void)r;
 806   assert(r == 0 && "fcntl(F_SETFD, FD_CLOEXEC) failed");
 807 #endif
 808   return std::error_code();
 809 }
 810
 811 std::error_code getPathFromOpenFD(int FD, SmallVectorImpl<char> &ResultPath) {
 812   if (FD < 0)
 813     return make_error_code(errc::bad_file_descriptor);
 814
 815 #if defined(F_GETPATH)
 816   // When F_GETPATH is availble, it is the quickest way to get
 817   // the path from a file descriptor.
 818   ResultPath.reserve(MAXPATHLEN);
 819   if (::fcntl(FD, F_GETPATH, ResultPath.begin()) == -1)
 820     return std::error_code(errno, std::generic_category());
 821
 822   ResultPath.set_size(strlen(ResultPath.begin()));
 823 #else
 824   // If we have a /proc filesystem mounted, we can quickly establish the
 825   // real name of the file with readlink. Otherwise, we don't know how to
 826   // get the filename from a file descriptor. Give up.
 827   if (!fs::hasProcSelfFD())
 828     return make_error_code(errc::function_not_supported);
 829
 830   ResultPath.reserve(PATH_MAX);
 831   char ProcPath[64];
 832   snprintf(ProcPath, sizeof(ProcPath), "/proc/self/fd/%d", FD);
 833   ssize_t CharCount = ::readlink(ProcPath, ResultPath.begin(), ResultPath.capacity());
 834   if (CharCount < 0)
 835       return std::error_code(errno, std::generic_category());
 836
 837   // Was the filename truncated?
 838   if (static_cast<size_t>(CharCount) == ResultPath.capacity()) {
 839     // Use lstat to get the size of the filename
 840     struct stat sb;
 841     if (::lstat(ProcPath, &sb) < 0)
 842       return std::error_code(errno, std::generic_category());
 843
 844     ResultPath.reserve(sb.st_size + 1);
 845     CharCount = ::readlink(ProcPath, ResultPath.begin(), ResultPath.capacity());
 846     if (CharCount < 0)
 847       return std::error_code(errno, std::generic_category());
 848
 849     // Test for race condition: did the link size change?
 850     if (CharCount > sb.st_size)
 851       return std::error_code(ENAMETOOLONG, std::generic_category());
 852   }
 853   ResultPath.set_size(static_cast<size_t>(CharCount));
 854 #endif
 855   return std::error_code();
 856 }
 857
 858 template <typename T>
 859 static std::error_code remove_directories_impl(const T &Entry,
 860                                                bool IgnoreErrors) {
 861   std::error_code EC;
 862   directory_iterator Begin(Entry, EC, false);
 863   directory_iterator End;
 864   while (Begin != End) {
 865     auto &Item = *Begin;
 866     file_status st;
 867     EC = Item.status(st);
 868     if (EC && !IgnoreErrors)
 869       return EC;
 870
 871     if (is_directory(st)) {
 872       EC = remove_directories_impl(Item, IgnoreErrors);
 873       if (EC && !IgnoreErrors)
 874         return EC;
 875     }
 876
 877     EC = fs::remove(Item.path(), true);
 878     if (EC && !IgnoreErrors)
 879       return EC;
 880
 881     Begin.increment(EC);
 882     if (EC && !IgnoreErrors)
 883       return EC;
 884   }
 885   return std::error_code();
 886 }
 887
 888 std::error_code remove_directories(const Twine &path, bool IgnoreErrors) {
 889   auto EC = remove_directories_impl(path, IgnoreErrors);
 890   if (EC && !IgnoreErrors)
 891     return EC;
 892   EC = fs::remove(path, true);
 893   if (EC && !IgnoreErrors)
 894     return EC;
 895   return std::error_code();
 896 }
 897
 898 std::error_code real_path(const Twine &path, SmallVectorImpl<char> &dest,
 899                           bool expand_tilde) {
 900   dest.clear();
 901   if (path.isTriviallyEmpty())
 902     return std::error_code();
 903
 904   if (expand_tilde) {
 905     SmallString<128> Storage;
 906     path.toVector(Storage);
 907     expandTildeExpr(Storage);
 908     return real_path(Storage, dest, false);
 909   }
 910
 911   int fd;
 912   std::error_code EC = openFileForRead(path, fd, &dest);
 913
 914   if (EC)
 915     return EC;
 916   ::close(fd);
 917   return std::error_code();
 918 }
 919
 920 } // end namespace fs
 921
 922 namespace path {
 923
 924 bool home_directory(SmallVectorImpl<char> &result) {
 925   char *RequestedDir = getenv("HOME");
 926   if (!RequestedDir) {
 927     struct passwd *pw = getpwuid(getuid());
 928     if (pw && pw->pw_dir)
 929       RequestedDir = pw->pw_dir;
 930   }
 931   if (!RequestedDir)
 932     return false;
 933
 934   result.clear();
 935   result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
 936   return true;
 937 }
 938
 939 static bool getDarwinConfDir(bool TempDir, SmallVectorImpl<char> &Result) {
 940   #if defined(_CS_DARWIN_USER_TEMP_DIR) && defined(_CS_DARWIN_USER_CACHE_DIR)
 941   // On Darwin, use DARWIN_USER_TEMP_DIR or DARWIN_USER_CACHE_DIR.
 942   // macros defined in <unistd.h> on darwin >= 9
 943   int ConfName = TempDir ? _CS_DARWIN_USER_TEMP_DIR
 944                          : _CS_DARWIN_USER_CACHE_DIR;
 945   size_t ConfLen = confstr(ConfName, nullptr, 0);
 946   if (ConfLen > 0) {
 947     do {
 948       Result.resize(ConfLen);
 949       ConfLen = confstr(ConfName, Result.data(), Result.size());
 950     } while (ConfLen > 0 && ConfLen != Result.size());
 951
 952     if (ConfLen > 0) {
 953       assert(Result.back() == 0);
 954       Result.pop_back();
 955       return true;
 956     }
 957
 958     Result.clear();
 959   }
 960   #endif
 961   return false;
 962 }
 963
 964 static bool getUserCacheDir(SmallVectorImpl<char> &Result) {
 965   // First try using XDG_CACHE_HOME env variable,
 966   // as specified in XDG Base Directory Specification at
 967   // http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
 968   if (const char *XdgCacheDir = std::getenv("XDG_CACHE_HOME")) {
 969     Result.clear();
 970     Result.append(XdgCacheDir, XdgCacheDir + strlen(XdgCacheDir));
 971     return true;
 972   }
 973
 974   // Try Darwin configuration query
 975   if (getDarwinConfDir(false, Result))
 976     return true;
 977
 978   // Use "$HOME/.cache" if $HOME is available
 979   if (home_directory(Result)) {
 980     append(Result, ".cache");
 981     return true;
 982   }
 983
 984   return false;
 985 }
 986
 987 static const char *getEnvTempDir() {
 988   // Check whether the temporary directory is specified by an environment
 989   // variable.
 990   const char *EnvironmentVariables[] = {"TMPDIR", "TMP", "TEMP", "TEMPDIR"};
 991   for (const char *Env : EnvironmentVariables) {
 992     if (const char *Dir = std::getenv(Env))
 993       return Dir;
 994   }
 995
 996   return nullptr;
 997 }
 998
 999 static const char *getDefaultTempDir(bool ErasedOnReboot) {
1000 #ifdef P_tmpdir
1001   if ((bool)P_tmpdir)
1002     return P_tmpdir;
1003 #endif
1004
1005   if (ErasedOnReboot)
1006     return "/tmp";
1007   return "/var/tmp";
1008 }
1009
1010 void system_temp_directory(bool ErasedOnReboot, SmallVectorImpl<char> &Result) {
1011   Result.clear();
1012
1013   if (ErasedOnReboot) {
1014     // There is no env variable for the cache directory.
1015     if (const char *RequestedDir = getEnvTempDir()) {
1016       Result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
1017       return;
1018     }
1019   }
1020
1021   if (getDarwinConfDir(ErasedOnReboot, Result))
1022     return;
1023
1024   const char *RequestedDir = getDefaultTempDir(ErasedOnReboot);
1025   Result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
1026 }
1027
1028 } // end namespace path
1029
1030 } // end namespace sys
1031 } // end namespace llvm