1 //===- llvm/Support/Unix/Path.inc - Unix Path Implementation ----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the Unix specific implementation of the Path API.
12 //===----------------------------------------------------------------------===//
14 //===----------------------------------------------------------------------===//
15 //=== WARNING: Implementation here must contain only generic UNIX code that
16 //=== is guaranteed to work on *all* UNIX variants.
17 //===----------------------------------------------------------------------===//
31 #ifdef HAVE_SYS_MMAN_H
39 #include <mach-o/dyld.h>
43 // Both stdio.h and cstdio are included via different paths and
44 // stdcxx's cstdio doesn't include stdio.h, so it doesn't #undef the macros
50 #if defined(__GNU__) && !defined(PATH_MAX)
51 # define PATH_MAX 4096
54 #include <sys/types.h>
55 #if !defined(__APPLE__) && !defined(__OpenBSD__) && !defined(__FreeBSD__) && \
57 #include <sys/statvfs.h>
58 #define STATVFS statvfs
59 #define FSTATVFS fstatvfs
60 #define STATVFS_F_FRSIZE(vfs) vfs.f_frsize
62 #if defined(__OpenBSD__) || defined(__FreeBSD__)
63 #include <sys/mount.h>
64 #include <sys/param.h>
65 #elif defined(__linux__)
66 #if defined(HAVE_LINUX_MAGIC_H)
67 #include <linux/magic.h>
69 #if defined(HAVE_LINUX_NFS_FS_H)
70 #include <linux/nfs_fs.h>
72 #if defined(HAVE_LINUX_SMB_H)
73 #include <linux/smb.h>
78 #include <sys/mount.h>
80 #define STATVFS statfs
81 #define FSTATVFS fstatfs
82 #define STATVFS_F_FRSIZE(vfs) static_cast<uint64_t>(vfs.f_bsize)
85 #if defined(__NetBSD__)
86 #define STATVFS_F_FLAG(vfs) (vfs).f_flag
88 #define STATVFS_F_FLAG(vfs) (vfs).f_flags
97 const file_t kInvalidFile = -1;
99 #if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || \
100 defined(__minix) || defined(__FreeBSD_kernel__) || defined(__linux__) || \
101 defined(__CYGWIN__) || defined(__DragonFly__) || defined(_AIX)
103 test_dir(char ret[PATH_MAX], const char *dir, const char *bin)
106 char fullpath[PATH_MAX];
108 snprintf(fullpath, PATH_MAX, "%s/%s", dir, bin);
109 if (!realpath(fullpath, ret))
111 if (stat(fullpath, &sb) != 0)
118 getprogpath(char ret[PATH_MAX], const char *bin)
122 /* First approach: absolute path. */
124 if (test_dir(ret, "/", bin) == 0)
129 /* Second approach: relative path. */
130 if (strchr(bin, '/')) {
132 if (!getcwd(cwd, PATH_MAX))
134 if (test_dir(ret, cwd, bin) == 0)
139 /* Third approach: $PATH */
140 if ((pv = getenv("PATH")) == nullptr)
145 while ((t = strsep(&s, ":")) != nullptr) {
146 if (test_dir(ret, t, bin) == 0) {
154 #endif // __FreeBSD__ || __NetBSD__ || __FreeBSD_kernel__
156 /// GetMainExecutable - Return the path to the main executable, given the
157 /// value of argv[0] from program startup.
158 std::string getMainExecutable(const char *argv0, void *MainAddr) {
159 #if defined(__APPLE__)
160 // On OS X the executable path is saved to the stack by dyld. Reading it
161 // from there is much faster than calling dladdr, especially for large
162 // binaries with symbols.
163 char exe_path[MAXPATHLEN];
164 uint32_t size = sizeof(exe_path);
165 if (_NSGetExecutablePath(exe_path, &size) == 0) {
166 char link_path[MAXPATHLEN];
167 if (realpath(exe_path, link_path))
170 #elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || \
171 defined(__minix) || defined(__DragonFly__) || \
172 defined(__FreeBSD_kernel__) || defined(_AIX)
173 char exe_path[PATH_MAX];
175 if (getprogpath(exe_path, argv0) != NULL)
177 #elif defined(__linux__) || defined(__CYGWIN__)
178 char exe_path[MAXPATHLEN];
179 StringRef aPath("/proc/self/exe");
180 if (sys::fs::exists(aPath)) {
181 // /proc is not always mounted under Linux (chroot for example).
182 ssize_t len = readlink(aPath.str().c_str(), exe_path, sizeof(exe_path));
184 return std::string(exe_path, len);
186 // Fall back to the classical detection.
187 if (getprogpath(exe_path, argv0))
190 #elif defined(HAVE_DLFCN_H) && defined(HAVE_DLADDR)
191 // Use dladdr to get executable path if available.
193 int err = dladdr(MainAddr, &DLInfo);
197 // If the filename is a symlink, we need to resolve and return the location of
198 // the actual executable.
199 char link_path[MAXPATHLEN];
200 if (realpath(DLInfo.dli_fname, link_path))
203 #error GetMainExecutable is not implemented on this host yet.
208 TimePoint<> basic_file_status::getLastAccessedTime() const {
209 return toTimePoint(fs_st_atime);
212 TimePoint<> basic_file_status::getLastModificationTime() const {
213 return toTimePoint(fs_st_mtime);
216 UniqueID file_status::getUniqueID() const {
217 return UniqueID(fs_st_dev, fs_st_ino);
220 uint32_t file_status::getLinkCount() const {
224 ErrorOr<space_info> disk_space(const Twine &Path) {
226 if (::STATVFS(Path.str().c_str(), &Vfs))
227 return std::error_code(errno, std::generic_category());
228 auto FrSize = STATVFS_F_FRSIZE(Vfs);
229 space_info SpaceInfo;
230 SpaceInfo.capacity = static_cast<uint64_t>(Vfs.f_blocks) * FrSize;
231 SpaceInfo.free = static_cast<uint64_t>(Vfs.f_bfree) * FrSize;
232 SpaceInfo.available = static_cast<uint64_t>(Vfs.f_bavail) * FrSize;
236 std::error_code current_path(SmallVectorImpl<char> &result) {
239 const char *pwd = ::getenv("PWD");
240 llvm::sys::fs::file_status PWDStatus, DotStatus;
241 if (pwd && llvm::sys::path::is_absolute(pwd) &&
242 !llvm::sys::fs::status(pwd, PWDStatus) &&
243 !llvm::sys::fs::status(".", DotStatus) &&
244 PWDStatus.getUniqueID() == DotStatus.getUniqueID()) {
245 result.append(pwd, pwd + strlen(pwd));
246 return std::error_code();
250 result.reserve(MAXPATHLEN);
253 result.reserve(1024);
257 if (::getcwd(result.data(), result.capacity()) == nullptr) {
258 // See if there was a real error.
260 return std::error_code(errno, std::generic_category());
261 // Otherwise there just wasn't enough space.
262 result.reserve(result.capacity() * 2);
267 result.set_size(strlen(result.data()));
268 return std::error_code();
271 std::error_code set_current_path(const Twine &path) {
272 SmallString<128> path_storage;
273 StringRef p = path.toNullTerminatedStringRef(path_storage);
275 if (::chdir(p.begin()) == -1)
276 return std::error_code(errno, std::generic_category());
278 return std::error_code();
281 std::error_code create_directory(const Twine &path, bool IgnoreExisting,
283 SmallString<128> path_storage;
284 StringRef p = path.toNullTerminatedStringRef(path_storage);
286 if (::mkdir(p.begin(), Perms) == -1) {
287 if (errno != EEXIST || !IgnoreExisting)
288 return std::error_code(errno, std::generic_category());
291 return std::error_code();
294 // Note that we are using symbolic link because hard links are not supported by
295 // all filesystems (SMB doesn't).
296 std::error_code create_link(const Twine &to, const Twine &from) {
298 SmallString<128> from_storage;
299 SmallString<128> to_storage;
300 StringRef f = from.toNullTerminatedStringRef(from_storage);
301 StringRef t = to.toNullTerminatedStringRef(to_storage);
303 if (::symlink(t.begin(), f.begin()) == -1)
304 return std::error_code(errno, std::generic_category());
306 return std::error_code();
309 std::error_code create_hard_link(const Twine &to, const Twine &from) {
311 SmallString<128> from_storage;
312 SmallString<128> to_storage;
313 StringRef f = from.toNullTerminatedStringRef(from_storage);
314 StringRef t = to.toNullTerminatedStringRef(to_storage);
316 if (::link(t.begin(), f.begin()) == -1)
317 return std::error_code(errno, std::generic_category());
319 return std::error_code();
322 std::error_code remove(const Twine &path, bool IgnoreNonExisting) {
323 SmallString<128> path_storage;
324 StringRef p = path.toNullTerminatedStringRef(path_storage);
327 if (lstat(p.begin(), &buf) != 0) {
328 if (errno != ENOENT || !IgnoreNonExisting)
329 return std::error_code(errno, std::generic_category());
330 return std::error_code();
333 // Note: this check catches strange situations. In all cases, LLVM should
334 // only be involved in the creation and deletion of regular files. This
335 // check ensures that what we're trying to erase is a regular file. It
336 // effectively prevents LLVM from erasing things like /dev/null, any block
337 // special file, or other things that aren't "regular" files.
338 if (!S_ISREG(buf.st_mode) && !S_ISDIR(buf.st_mode) && !S_ISLNK(buf.st_mode))
339 return make_error_code(errc::operation_not_permitted);
341 if (::remove(p.begin()) == -1) {
342 if (errno != ENOENT || !IgnoreNonExisting)
343 return std::error_code(errno, std::generic_category());
346 return std::error_code();
349 static bool is_local_impl(struct STATVFS &Vfs) {
350 #if defined(__linux__)
351 #ifndef NFS_SUPER_MAGIC
352 #define NFS_SUPER_MAGIC 0x6969
354 #ifndef SMB_SUPER_MAGIC
355 #define SMB_SUPER_MAGIC 0x517B
357 #ifndef CIFS_MAGIC_NUMBER
358 #define CIFS_MAGIC_NUMBER 0xFF534D42
360 switch ((uint32_t)Vfs.f_type) {
361 case NFS_SUPER_MAGIC:
362 case SMB_SUPER_MAGIC:
363 case CIFS_MAGIC_NUMBER:
368 #elif defined(__CYGWIN__)
369 // Cygwin doesn't expose this information; would need to use Win32 API.
371 #elif defined(__Fuchsia__)
372 // Fuchsia doesn't yet support remote filesystem mounts.
374 #elif defined(__HAIKU__)
375 // Haiku doesn't expose this information.
378 // statvfs::f_basetype contains a null-terminated FSType name of the mounted target
379 StringRef fstype(Vfs.f_basetype);
380 // NFS is the only non-local fstype??
381 return !fstype.equals("nfs");
383 return !!(STATVFS_F_FLAG(Vfs) & MNT_LOCAL);
387 std::error_code is_local(const Twine &Path, bool &Result) {
389 if (::STATVFS(Path.str().c_str(), &Vfs))
390 return std::error_code(errno, std::generic_category());
392 Result = is_local_impl(Vfs);
393 return std::error_code();
396 std::error_code is_local(int FD, bool &Result) {
398 if (::FSTATVFS(FD, &Vfs))
399 return std::error_code(errno, std::generic_category());
401 Result = is_local_impl(Vfs);
402 return std::error_code();
405 std::error_code rename(const Twine &from, const Twine &to) {
407 SmallString<128> from_storage;
408 SmallString<128> to_storage;
409 StringRef f = from.toNullTerminatedStringRef(from_storage);
410 StringRef t = to.toNullTerminatedStringRef(to_storage);
412 if (::rename(f.begin(), t.begin()) == -1)
413 return std::error_code(errno, std::generic_category());
415 return std::error_code();
418 std::error_code resize_file(int FD, uint64_t Size) {
419 #if defined(HAVE_POSIX_FALLOCATE)
420 // If we have posix_fallocate use it. Unlike ftruncate it always allocates
421 // space, so we get an error if the disk is full.
422 if (int Err = ::posix_fallocate(FD, 0, Size)) {
423 if (Err != EINVAL && Err != EOPNOTSUPP)
424 return std::error_code(Err, std::generic_category());
427 // Use ftruncate as a fallback. It may or may not allocate space. At least on
428 // OS X with HFS+ it does.
429 if (::ftruncate(FD, Size) == -1)
430 return std::error_code(errno, std::generic_category());
432 return std::error_code();
435 static int convertAccessMode(AccessMode Mode) {
437 case AccessMode::Exist:
439 case AccessMode::Write:
441 case AccessMode::Execute:
442 return R_OK | X_OK; // scripts also need R_OK.
444 llvm_unreachable("invalid enum");
447 std::error_code access(const Twine &Path, AccessMode Mode) {
448 SmallString<128> PathStorage;
449 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
451 if (::access(P.begin(), convertAccessMode(Mode)) == -1)
452 return std::error_code(errno, std::generic_category());
454 if (Mode == AccessMode::Execute) {
455 // Don't say that directories are executable.
457 if (0 != stat(P.begin(), &buf))
458 return errc::permission_denied;
459 if (!S_ISREG(buf.st_mode))
460 return errc::permission_denied;
463 return std::error_code();
466 bool can_execute(const Twine &Path) {
467 return !access(Path, AccessMode::Execute);
470 bool equivalent(file_status A, file_status B) {
471 assert(status_known(A) && status_known(B));
472 return A.fs_st_dev == B.fs_st_dev &&
473 A.fs_st_ino == B.fs_st_ino;
476 std::error_code equivalent(const Twine &A, const Twine &B, bool &result) {
477 file_status fsA, fsB;
478 if (std::error_code ec = status(A, fsA))
480 if (std::error_code ec = status(B, fsB))
482 result = equivalent(fsA, fsB);
483 return std::error_code();
486 static void expandTildeExpr(SmallVectorImpl<char> &Path) {
487 StringRef PathStr(Path.begin(), Path.size());
488 if (PathStr.empty() || !PathStr.startswith("~"))
491 PathStr = PathStr.drop_front();
493 PathStr.take_until([](char c) { return path::is_separator(c); });
494 StringRef Remainder = PathStr.substr(Expr.size() + 1);
495 SmallString<128> Storage;
497 // This is just ~/..., resolve it to the current user's home dir.
498 if (!path::home_directory(Storage)) {
499 // For some reason we couldn't get the home directory. Just exit.
503 // Overwrite the first character and insert the rest.
504 Path[0] = Storage[0];
505 Path.insert(Path.begin() + 1, Storage.begin() + 1, Storage.end());
509 // This is a string of the form ~username/, look up this user's entry in the
510 // password database.
511 struct passwd *Entry = nullptr;
512 std::string User = Expr.str();
513 Entry = ::getpwnam(User.c_str());
516 // Unable to look up the entry, just return back the original path.
522 Path.append(Entry->pw_dir, Entry->pw_dir + strlen(Entry->pw_dir));
523 llvm::sys::path::append(Path, Storage);
526 static std::error_code fillStatus(int StatRet, const struct stat &Status,
527 file_status &Result) {
529 std::error_code ec(errno, std::generic_category());
530 if (ec == errc::no_such_file_or_directory)
531 Result = file_status(file_type::file_not_found);
533 Result = file_status(file_type::status_error);
537 file_type Type = file_type::type_unknown;
539 if (S_ISDIR(Status.st_mode))
540 Type = file_type::directory_file;
541 else if (S_ISREG(Status.st_mode))
542 Type = file_type::regular_file;
543 else if (S_ISBLK(Status.st_mode))
544 Type = file_type::block_file;
545 else if (S_ISCHR(Status.st_mode))
546 Type = file_type::character_file;
547 else if (S_ISFIFO(Status.st_mode))
548 Type = file_type::fifo_file;
549 else if (S_ISSOCK(Status.st_mode))
550 Type = file_type::socket_file;
551 else if (S_ISLNK(Status.st_mode))
552 Type = file_type::symlink_file;
554 perms Perms = static_cast<perms>(Status.st_mode) & all_perms;
555 Result = file_status(Type, Perms, Status.st_dev, Status.st_nlink,
556 Status.st_ino, Status.st_atime, Status.st_mtime,
557 Status.st_uid, Status.st_gid, Status.st_size);
559 return std::error_code();
562 std::error_code status(const Twine &Path, file_status &Result, bool Follow) {
563 SmallString<128> PathStorage;
564 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
567 int StatRet = (Follow ? ::stat : ::lstat)(P.begin(), &Status);
568 return fillStatus(StatRet, Status, Result);
571 std::error_code status(int FD, file_status &Result) {
573 int StatRet = ::fstat(FD, &Status);
574 return fillStatus(StatRet, Status, Result);
577 std::error_code setPermissions(const Twine &Path, perms Permissions) {
578 SmallString<128> PathStorage;
579 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
581 if (::chmod(P.begin(), Permissions))
582 return std::error_code(errno, std::generic_category());
583 return std::error_code();
586 std::error_code setLastModificationAndAccessTime(int FD, TimePoint<> Time) {
587 #if defined(HAVE_FUTIMENS)
589 Times[0] = Times[1] = sys::toTimeSpec(Time);
590 if (::futimens(FD, Times))
591 return std::error_code(errno, std::generic_category());
592 return std::error_code();
593 #elif defined(HAVE_FUTIMES)
595 Times[0] = Times[1] = sys::toTimeVal(
596 std::chrono::time_point_cast<std::chrono::microseconds>(Time));
597 if (::futimes(FD, Times))
598 return std::error_code(errno, std::generic_category());
599 return std::error_code();
601 #warning Missing futimes() and futimens()
602 return make_error_code(errc::function_not_supported);
606 std::error_code mapped_file_region::init(int FD, uint64_t Offset,
610 int flags = (Mode == readwrite) ? MAP_SHARED : MAP_PRIVATE;
611 int prot = (Mode == readonly) ? PROT_READ : (PROT_READ | PROT_WRITE);
612 #if defined(__APPLE__)
613 //----------------------------------------------------------------------
614 // Newer versions of MacOSX have a flag that will allow us to read from
615 // binaries whose code signature is invalid without crashing by using
616 // the MAP_RESILIENT_CODESIGN flag. Also if a file from removable media
617 // is mapped we can avoid crashing and return zeroes to any pages we try
618 // to read if the media becomes unavailable by using the
619 // MAP_RESILIENT_MEDIA flag. These flags are only usable when mapping
620 // with PROT_READ, so take care not to specify them otherwise.
621 //----------------------------------------------------------------------
622 if (Mode == readonly) {
623 #if defined(MAP_RESILIENT_CODESIGN)
624 flags |= MAP_RESILIENT_CODESIGN;
626 #if defined(MAP_RESILIENT_MEDIA)
627 flags |= MAP_RESILIENT_MEDIA;
630 #endif // #if defined (__APPLE__)
632 Mapping = ::mmap(nullptr, Size, prot, flags, FD, Offset);
633 if (Mapping == MAP_FAILED)
634 return std::error_code(errno, std::generic_category());
635 return std::error_code();
638 mapped_file_region::mapped_file_region(int fd, mapmode mode, size_t length,
639 uint64_t offset, std::error_code &ec)
640 : Size(length), Mapping(), Mode(mode) {
642 ec = init(fd, offset, mode);
647 mapped_file_region::~mapped_file_region() {
649 ::munmap(Mapping, Size);
652 size_t mapped_file_region::size() const {
653 assert(Mapping && "Mapping failed but used anyway!");
657 char *mapped_file_region::data() const {
658 assert(Mapping && "Mapping failed but used anyway!");
659 return reinterpret_cast<char*>(Mapping);
662 const char *mapped_file_region::const_data() const {
663 assert(Mapping && "Mapping failed but used anyway!");
664 return reinterpret_cast<const char*>(Mapping);
667 int mapped_file_region::alignment() {
668 return Process::getPageSize();
671 std::error_code detail::directory_iterator_construct(detail::DirIterState &it,
673 bool follow_symlinks) {
674 SmallString<128> path_null(path);
675 DIR *directory = ::opendir(path_null.c_str());
677 return std::error_code(errno, std::generic_category());
679 it.IterationHandle = reinterpret_cast<intptr_t>(directory);
680 // Add something for replace_filename to replace.
681 path::append(path_null, ".");
682 it.CurrentEntry = directory_entry(path_null.str(), follow_symlinks);
683 return directory_iterator_increment(it);
686 std::error_code detail::directory_iterator_destruct(detail::DirIterState &it) {
687 if (it.IterationHandle)
688 ::closedir(reinterpret_cast<DIR *>(it.IterationHandle));
689 it.IterationHandle = 0;
690 it.CurrentEntry = directory_entry();
691 return std::error_code();
694 std::error_code detail::directory_iterator_increment(detail::DirIterState &it) {
696 dirent *cur_dir = ::readdir(reinterpret_cast<DIR *>(it.IterationHandle));
697 if (cur_dir == nullptr && errno != 0) {
698 return std::error_code(errno, std::generic_category());
699 } else if (cur_dir != nullptr) {
700 StringRef name(cur_dir->d_name);
701 if ((name.size() == 1 && name[0] == '.') ||
702 (name.size() == 2 && name[0] == '.' && name[1] == '.'))
703 return directory_iterator_increment(it);
704 it.CurrentEntry.replace_filename(name);
706 return directory_iterator_destruct(it);
708 return std::error_code();
711 ErrorOr<basic_file_status> directory_entry::status() const {
713 if (auto EC = fs::status(Path, s, FollowSymlinks))
718 #if !defined(F_GETPATH)
719 static bool hasProcSelfFD() {
720 // If we have a /proc filesystem mounted, we can quickly establish the
721 // real name of the file with readlink
722 static const bool Result = (::access("/proc/self/fd", R_OK) == 0);
727 static int nativeOpenFlags(CreationDisposition Disp, OpenFlags Flags,
730 if (Access == FA_Read)
732 else if (Access == FA_Write)
734 else if (Access == (FA_Read | FA_Write))
737 // This is for compatibility with old code that assumed F_Append implied
738 // would open an existing file. See Windows/Path.inc for a longer comment.
739 if (Flags & F_Append)
740 Disp = CD_OpenAlways;
742 if (Disp == CD_CreateNew) {
743 Result |= O_CREAT; // Create if it doesn't exist.
744 Result |= O_EXCL; // Fail if it does.
745 } else if (Disp == CD_CreateAlways) {
746 Result |= O_CREAT; // Create if it doesn't exist.
747 Result |= O_TRUNC; // Truncate if it does.
748 } else if (Disp == CD_OpenAlways) {
749 Result |= O_CREAT; // Create if it doesn't exist.
750 } else if (Disp == CD_OpenExisting) {
751 // Nothing special, just don't add O_CREAT and we get these semantics.
754 if (Flags & F_Append)
758 if (!(Flags & OF_ChildInherit))
765 std::error_code openFile(const Twine &Name, int &ResultFD,
766 CreationDisposition Disp, FileAccess Access,
767 OpenFlags Flags, unsigned Mode) {
768 int OpenFlags = nativeOpenFlags(Disp, Flags, Access);
770 SmallString<128> Storage;
771 StringRef P = Name.toNullTerminatedStringRef(Storage);
772 if ((ResultFD = sys::RetryAfterSignal(-1, ::open, P.begin(), OpenFlags, Mode)) <
774 return std::error_code(errno, std::generic_category());
776 if (!(Flags & OF_ChildInherit)) {
777 int r = fcntl(ResultFD, F_SETFD, FD_CLOEXEC);
779 assert(r == 0 && "fcntl(F_SETFD, FD_CLOEXEC) failed");
782 return std::error_code();
785 Expected<int> openNativeFile(const Twine &Name, CreationDisposition Disp,
786 FileAccess Access, OpenFlags Flags,
790 std::error_code EC = openFile(Name, FD, Disp, Access, Flags, Mode);
792 return errorCodeToError(EC);
796 std::error_code openFileForRead(const Twine &Name, int &ResultFD,
798 SmallVectorImpl<char> *RealPath) {
800 openFile(Name, ResultFD, CD_OpenExisting, FA_Read, Flags, 0666);
804 // Attempt to get the real name of the file, if the user asked
806 return std::error_code();
808 #if defined(F_GETPATH)
809 // When F_GETPATH is availble, it is the quickest way to get
810 // the real path name.
811 char Buffer[MAXPATHLEN];
812 if (::fcntl(ResultFD, F_GETPATH, Buffer) != -1)
813 RealPath->append(Buffer, Buffer + strlen(Buffer));
815 char Buffer[PATH_MAX];
816 if (hasProcSelfFD()) {
818 snprintf(ProcPath, sizeof(ProcPath), "/proc/self/fd/%d", ResultFD);
819 ssize_t CharCount = ::readlink(ProcPath, Buffer, sizeof(Buffer));
821 RealPath->append(Buffer, Buffer + CharCount);
823 SmallString<128> Storage;
824 StringRef P = Name.toNullTerminatedStringRef(Storage);
826 // Use ::realpath to get the real path name
827 if (::realpath(P.begin(), Buffer) != nullptr)
828 RealPath->append(Buffer, Buffer + strlen(Buffer));
831 return std::error_code();
834 Expected<file_t> openNativeFileForRead(const Twine &Name, OpenFlags Flags,
835 SmallVectorImpl<char> *RealPath) {
837 std::error_code EC = openFileForRead(Name, ResultFD, Flags, RealPath);
839 return errorCodeToError(EC);
843 void closeFile(file_t &F) {
848 template <typename T>
849 static std::error_code remove_directories_impl(const T &Entry,
852 directory_iterator Begin(Entry, EC, false);
853 directory_iterator End;
854 while (Begin != End) {
856 ErrorOr<basic_file_status> st = Item.status();
857 if (!st && !IgnoreErrors)
858 return st.getError();
860 if (is_directory(*st)) {
861 EC = remove_directories_impl(Item, IgnoreErrors);
862 if (EC && !IgnoreErrors)
866 EC = fs::remove(Item.path(), true);
867 if (EC && !IgnoreErrors)
871 if (EC && !IgnoreErrors)
874 return std::error_code();
877 std::error_code remove_directories(const Twine &path, bool IgnoreErrors) {
878 auto EC = remove_directories_impl(path, IgnoreErrors);
879 if (EC && !IgnoreErrors)
881 EC = fs::remove(path, true);
882 if (EC && !IgnoreErrors)
884 return std::error_code();
887 std::error_code real_path(const Twine &path, SmallVectorImpl<char> &dest,
890 if (path.isTriviallyEmpty())
891 return std::error_code();
894 SmallString<128> Storage;
895 path.toVector(Storage);
896 expandTildeExpr(Storage);
897 return real_path(Storage, dest, false);
900 SmallString<128> Storage;
901 StringRef P = path.toNullTerminatedStringRef(Storage);
902 char Buffer[PATH_MAX];
903 if (::realpath(P.begin(), Buffer) == nullptr)
904 return std::error_code(errno, std::generic_category());
905 dest.append(Buffer, Buffer + strlen(Buffer));
906 return std::error_code();
909 } // end namespace fs
913 bool home_directory(SmallVectorImpl<char> &result) {
914 char *RequestedDir = getenv("HOME");
916 struct passwd *pw = getpwuid(getuid());
917 if (pw && pw->pw_dir)
918 RequestedDir = pw->pw_dir;
924 result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
928 static bool getDarwinConfDir(bool TempDir, SmallVectorImpl<char> &Result) {
929 #if defined(_CS_DARWIN_USER_TEMP_DIR) && defined(_CS_DARWIN_USER_CACHE_DIR)
930 // On Darwin, use DARWIN_USER_TEMP_DIR or DARWIN_USER_CACHE_DIR.
931 // macros defined in <unistd.h> on darwin >= 9
932 int ConfName = TempDir ? _CS_DARWIN_USER_TEMP_DIR
933 : _CS_DARWIN_USER_CACHE_DIR;
934 size_t ConfLen = confstr(ConfName, nullptr, 0);
937 Result.resize(ConfLen);
938 ConfLen = confstr(ConfName, Result.data(), Result.size());
939 } while (ConfLen > 0 && ConfLen != Result.size());
942 assert(Result.back() == 0);
953 static bool getUserCacheDir(SmallVectorImpl<char> &Result) {
954 // First try using XDG_CACHE_HOME env variable,
955 // as specified in XDG Base Directory Specification at
956 // http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
957 if (const char *XdgCacheDir = std::getenv("XDG_CACHE_HOME")) {
959 Result.append(XdgCacheDir, XdgCacheDir + strlen(XdgCacheDir));
963 // Try Darwin configuration query
964 if (getDarwinConfDir(false, Result))
967 // Use "$HOME/.cache" if $HOME is available
968 if (home_directory(Result)) {
969 append(Result, ".cache");
976 static const char *getEnvTempDir() {
977 // Check whether the temporary directory is specified by an environment
979 const char *EnvironmentVariables[] = {"TMPDIR", "TMP", "TEMP", "TEMPDIR"};
980 for (const char *Env : EnvironmentVariables) {
981 if (const char *Dir = std::getenv(Env))
988 static const char *getDefaultTempDir(bool ErasedOnReboot) {
999 void system_temp_directory(bool ErasedOnReboot, SmallVectorImpl<char> &Result) {
1002 if (ErasedOnReboot) {
1003 // There is no env variable for the cache directory.
1004 if (const char *RequestedDir = getEnvTempDir()) {
1005 Result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
1010 if (getDarwinConfDir(ErasedOnReboot, Result))
1013 const char *RequestedDir = getDefaultTempDir(ErasedOnReboot);
1014 Result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
1017 } // end namespace path
1019 } // end namespace sys
1020 } // end namespace llvm