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
36 # define NAMLEN(dirent) strlen((dirent)->d_name)
38 # define dirent direct
39 # define NAMLEN(dirent) (dirent)->d_namlen
41 # include <sys/ndir.h>
52 #include <mach-o/dyld.h>
56 // Both stdio.h and cstdio are included via different pathes and
57 // stdcxx's cstdio doesn't include stdio.h, so it doesn't #undef the macros
63 #if defined(__GNU__) && !defined(PATH_MAX)
64 # define PATH_MAX 4096
67 #include <sys/types.h>
68 #if !defined(__APPLE__) && !defined(__OpenBSD__) && !defined(__ANDROID__)
69 #include <sys/statvfs.h>
70 #define STATVFS statvfs
71 #define STATVFS_F_FRSIZE(vfs) vfs.f_frsize
74 #include <sys/param.h>
75 #include <sys/mount.h>
76 #elif defined(__ANDROID__)
79 #include <sys/mount.h>
81 #define STATVFS statfs
82 #define STATVFS_F_FRSIZE(vfs) static_cast<uint64_t>(vfs.f_bsize)
91 #if defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
92 defined(__OpenBSD__) || defined(__minix) || defined(__FreeBSD_kernel__) || \
93 defined(__linux__) || defined(__CYGWIN__) || defined(__DragonFly__)
95 test_dir(char ret[PATH_MAX], const char *dir, const char *bin)
98 char fullpath[PATH_MAX];
100 snprintf(fullpath, PATH_MAX, "%s/%s", dir, bin);
101 if (!realpath(fullpath, ret))
103 if (stat(fullpath, &sb) != 0)
110 getprogpath(char ret[PATH_MAX], const char *bin)
114 /* First approach: absolute path. */
116 if (test_dir(ret, "/", bin) == 0)
121 /* Second approach: relative path. */
122 if (strchr(bin, '/')) {
124 if (!getcwd(cwd, PATH_MAX))
126 if (test_dir(ret, cwd, bin) == 0)
131 /* Third approach: $PATH */
132 if ((pv = getenv("PATH")) == nullptr)
137 while ((t = strsep(&s, ":")) != nullptr) {
138 if (test_dir(ret, t, bin) == 0) {
146 #endif // __FreeBSD__ || __NetBSD__ || __FreeBSD_kernel__
148 /// GetMainExecutable - Return the path to the main executable, given the
149 /// value of argv[0] from program startup.
150 std::string getMainExecutable(const char *argv0, void *MainAddr) {
151 #if defined(__APPLE__)
152 // On OS X the executable path is saved to the stack by dyld. Reading it
153 // from there is much faster than calling dladdr, especially for large
154 // binaries with symbols.
155 char exe_path[MAXPATHLEN];
156 uint32_t size = sizeof(exe_path);
157 if (_NSGetExecutablePath(exe_path, &size) == 0) {
158 char link_path[MAXPATHLEN];
159 if (realpath(exe_path, link_path))
162 #elif defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
163 defined(__OpenBSD__) || defined(__minix) || defined(__DragonFly__) || \
164 defined(__FreeBSD_kernel__)
165 char exe_path[PATH_MAX];
167 if (getprogpath(exe_path, argv0) != NULL)
169 #elif defined(__linux__) || defined(__CYGWIN__)
170 char exe_path[MAXPATHLEN];
171 StringRef aPath("/proc/self/exe");
172 if (sys::fs::exists(aPath)) {
173 // /proc is not always mounted under Linux (chroot for example).
174 ssize_t len = readlink(aPath.str().c_str(), exe_path, sizeof(exe_path));
176 return std::string(exe_path, len);
178 // Fall back to the classical detection.
179 if (getprogpath(exe_path, argv0))
182 #elif defined(HAVE_DLFCN_H)
183 // Use dladdr to get executable path if available.
185 int err = dladdr(MainAddr, &DLInfo);
189 // If the filename is a symlink, we need to resolve and return the location of
190 // the actual executable.
191 char link_path[MAXPATHLEN];
192 if (realpath(DLInfo.dli_fname, link_path))
195 #error GetMainExecutable is not implemented on this host yet.
200 TimeValue file_status::getLastAccessedTime() const {
202 Ret.fromEpochTime(fs_st_atime);
206 TimeValue file_status::getLastModificationTime() const {
208 Ret.fromEpochTime(fs_st_mtime);
212 UniqueID file_status::getUniqueID() const {
213 return UniqueID(fs_st_dev, fs_st_ino);
216 ErrorOr<space_info> disk_space(const Twine &Path) {
218 if (::STATVFS(Path.str().c_str(), &Vfs))
219 return std::error_code(errno, std::generic_category());
220 auto FrSize = STATVFS_F_FRSIZE(Vfs);
221 space_info SpaceInfo;
222 SpaceInfo.capacity = static_cast<uint64_t>(Vfs.f_blocks) * FrSize;
223 SpaceInfo.free = static_cast<uint64_t>(Vfs.f_bfree) * FrSize;
224 SpaceInfo.available = static_cast<uint64_t>(Vfs.f_bavail) * FrSize;
228 std::error_code current_path(SmallVectorImpl<char> &result) {
231 const char *pwd = ::getenv("PWD");
232 llvm::sys::fs::file_status PWDStatus, DotStatus;
233 if (pwd && llvm::sys::path::is_absolute(pwd) &&
234 !llvm::sys::fs::status(pwd, PWDStatus) &&
235 !llvm::sys::fs::status(".", DotStatus) &&
236 PWDStatus.getUniqueID() == DotStatus.getUniqueID()) {
237 result.append(pwd, pwd + strlen(pwd));
238 return std::error_code();
242 result.reserve(MAXPATHLEN);
245 result.reserve(1024);
249 if (::getcwd(result.data(), result.capacity()) == nullptr) {
250 // See if there was a real error.
252 return std::error_code(errno, std::generic_category());
253 // Otherwise there just wasn't enough space.
254 result.reserve(result.capacity() * 2);
259 result.set_size(strlen(result.data()));
260 return std::error_code();
263 std::error_code create_directory(const Twine &path, bool IgnoreExisting,
265 SmallString<128> path_storage;
266 StringRef p = path.toNullTerminatedStringRef(path_storage);
268 if (::mkdir(p.begin(), Perms) == -1) {
269 if (errno != EEXIST || !IgnoreExisting)
270 return std::error_code(errno, std::generic_category());
273 return std::error_code();
276 // Note that we are using symbolic link because hard links are not supported by
277 // all filesystems (SMB doesn't).
278 std::error_code create_link(const Twine &to, const Twine &from) {
280 SmallString<128> from_storage;
281 SmallString<128> to_storage;
282 StringRef f = from.toNullTerminatedStringRef(from_storage);
283 StringRef t = to.toNullTerminatedStringRef(to_storage);
285 if (::symlink(t.begin(), f.begin()) == -1)
286 return std::error_code(errno, std::generic_category());
288 return std::error_code();
291 std::error_code remove(const Twine &path, bool IgnoreNonExisting) {
292 SmallString<128> path_storage;
293 StringRef p = path.toNullTerminatedStringRef(path_storage);
296 if (lstat(p.begin(), &buf) != 0) {
297 if (errno != ENOENT || !IgnoreNonExisting)
298 return std::error_code(errno, std::generic_category());
299 return std::error_code();
302 // Note: this check catches strange situations. In all cases, LLVM should
303 // only be involved in the creation and deletion of regular files. This
304 // check ensures that what we're trying to erase is a regular file. It
305 // effectively prevents LLVM from erasing things like /dev/null, any block
306 // special file, or other things that aren't "regular" files.
307 if (!S_ISREG(buf.st_mode) && !S_ISDIR(buf.st_mode) && !S_ISLNK(buf.st_mode))
308 return make_error_code(errc::operation_not_permitted);
310 if (::remove(p.begin()) == -1) {
311 if (errno != ENOENT || !IgnoreNonExisting)
312 return std::error_code(errno, std::generic_category());
315 return std::error_code();
318 std::error_code rename(const Twine &from, const Twine &to) {
320 SmallString<128> from_storage;
321 SmallString<128> to_storage;
322 StringRef f = from.toNullTerminatedStringRef(from_storage);
323 StringRef t = to.toNullTerminatedStringRef(to_storage);
325 if (::rename(f.begin(), t.begin()) == -1)
326 return std::error_code(errno, std::generic_category());
328 return std::error_code();
331 std::error_code resize_file(int FD, uint64_t Size) {
332 if (::ftruncate(FD, Size) == -1)
333 return std::error_code(errno, std::generic_category());
335 return std::error_code();
338 static int convertAccessMode(AccessMode Mode) {
340 case AccessMode::Exist:
342 case AccessMode::Write:
344 case AccessMode::Execute:
345 return R_OK | X_OK; // scripts also need R_OK.
347 llvm_unreachable("invalid enum");
350 std::error_code access(const Twine &Path, AccessMode Mode) {
351 SmallString<128> PathStorage;
352 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
354 if (::access(P.begin(), convertAccessMode(Mode)) == -1)
355 return std::error_code(errno, std::generic_category());
357 if (Mode == AccessMode::Execute) {
358 // Don't say that directories are executable.
360 if (0 != stat(P.begin(), &buf))
361 return errc::permission_denied;
362 if (!S_ISREG(buf.st_mode))
363 return errc::permission_denied;
366 return std::error_code();
369 bool can_execute(const Twine &Path) {
370 return !access(Path, AccessMode::Execute);
373 bool equivalent(file_status A, file_status B) {
374 assert(status_known(A) && status_known(B));
375 return A.fs_st_dev == B.fs_st_dev &&
376 A.fs_st_ino == B.fs_st_ino;
379 std::error_code equivalent(const Twine &A, const Twine &B, bool &result) {
380 file_status fsA, fsB;
381 if (std::error_code ec = status(A, fsA))
383 if (std::error_code ec = status(B, fsB))
385 result = equivalent(fsA, fsB);
386 return std::error_code();
389 static std::error_code fillStatus(int StatRet, const struct stat &Status,
390 file_status &Result) {
392 std::error_code ec(errno, std::generic_category());
393 if (ec == errc::no_such_file_or_directory)
394 Result = file_status(file_type::file_not_found);
396 Result = file_status(file_type::status_error);
400 file_type Type = file_type::type_unknown;
402 if (S_ISDIR(Status.st_mode))
403 Type = file_type::directory_file;
404 else if (S_ISREG(Status.st_mode))
405 Type = file_type::regular_file;
406 else if (S_ISBLK(Status.st_mode))
407 Type = file_type::block_file;
408 else if (S_ISCHR(Status.st_mode))
409 Type = file_type::character_file;
410 else if (S_ISFIFO(Status.st_mode))
411 Type = file_type::fifo_file;
412 else if (S_ISSOCK(Status.st_mode))
413 Type = file_type::socket_file;
415 perms Perms = static_cast<perms>(Status.st_mode);
417 file_status(Type, Perms, Status.st_dev, Status.st_ino, Status.st_atime,
418 Status.st_mtime, Status.st_uid, Status.st_gid,
421 return std::error_code();
424 std::error_code status(const Twine &Path, file_status &Result) {
425 SmallString<128> PathStorage;
426 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
429 int StatRet = ::stat(P.begin(), &Status);
430 return fillStatus(StatRet, Status, Result);
433 std::error_code status(int FD, file_status &Result) {
435 int StatRet = ::fstat(FD, &Status);
436 return fillStatus(StatRet, Status, Result);
439 std::error_code setLastModificationAndAccessTime(int FD, TimeValue Time) {
440 #if defined(HAVE_FUTIMENS)
442 Times[0].tv_sec = Time.toEpochTime();
443 Times[0].tv_nsec = 0;
445 if (::futimens(FD, Times))
446 return std::error_code(errno, std::generic_category());
447 return std::error_code();
448 #elif defined(HAVE_FUTIMES)
450 Times[0].tv_sec = Time.toEpochTime();
451 Times[0].tv_usec = 0;
453 if (::futimes(FD, Times))
454 return std::error_code(errno, std::generic_category());
455 return std::error_code();
457 #warning Missing futimes() and futimens()
458 return make_error_code(errc::function_not_supported);
462 std::error_code mapped_file_region::init(int FD, uint64_t Offset,
466 int flags = (Mode == readwrite) ? MAP_SHARED : MAP_PRIVATE;
467 int prot = (Mode == readonly) ? PROT_READ : (PROT_READ | PROT_WRITE);
468 Mapping = ::mmap(nullptr, Size, prot, flags, FD, Offset);
469 if (Mapping == MAP_FAILED)
470 return std::error_code(errno, std::generic_category());
471 return std::error_code();
474 mapped_file_region::mapped_file_region(int fd, mapmode mode, uint64_t length,
475 uint64_t offset, std::error_code &ec)
476 : Size(length), Mapping() {
477 // Make sure that the requested size fits within SIZE_T.
478 if (length > std::numeric_limits<size_t>::max()) {
479 ec = make_error_code(errc::invalid_argument);
483 ec = init(fd, offset, mode);
488 mapped_file_region::~mapped_file_region() {
490 ::munmap(Mapping, Size);
493 uint64_t mapped_file_region::size() const {
494 assert(Mapping && "Mapping failed but used anyway!");
498 char *mapped_file_region::data() const {
499 assert(Mapping && "Mapping failed but used anyway!");
500 return reinterpret_cast<char*>(Mapping);
503 const char *mapped_file_region::const_data() const {
504 assert(Mapping && "Mapping failed but used anyway!");
505 return reinterpret_cast<const char*>(Mapping);
508 int mapped_file_region::alignment() {
509 return Process::getPageSize();
512 std::error_code detail::directory_iterator_construct(detail::DirIterState &it,
514 SmallString<128> path_null(path);
515 DIR *directory = ::opendir(path_null.c_str());
517 return std::error_code(errno, std::generic_category());
519 it.IterationHandle = reinterpret_cast<intptr_t>(directory);
520 // Add something for replace_filename to replace.
521 path::append(path_null, ".");
522 it.CurrentEntry = directory_entry(path_null.str());
523 return directory_iterator_increment(it);
526 std::error_code detail::directory_iterator_destruct(detail::DirIterState &it) {
527 if (it.IterationHandle)
528 ::closedir(reinterpret_cast<DIR *>(it.IterationHandle));
529 it.IterationHandle = 0;
530 it.CurrentEntry = directory_entry();
531 return std::error_code();
534 std::error_code detail::directory_iterator_increment(detail::DirIterState &it) {
536 dirent *cur_dir = ::readdir(reinterpret_cast<DIR *>(it.IterationHandle));
537 if (cur_dir == nullptr && errno != 0) {
538 return std::error_code(errno, std::generic_category());
539 } else if (cur_dir != nullptr) {
540 StringRef name(cur_dir->d_name, NAMLEN(cur_dir));
541 if ((name.size() == 1 && name[0] == '.') ||
542 (name.size() == 2 && name[0] == '.' && name[1] == '.'))
543 return directory_iterator_increment(it);
544 it.CurrentEntry.replace_filename(name);
546 return directory_iterator_destruct(it);
548 return std::error_code();
551 #if !defined(F_GETPATH)
552 static bool hasProcSelfFD() {
553 // If we have a /proc filesystem mounted, we can quickly establish the
554 // real name of the file with readlink
555 static const bool Result = (::access("/proc/self/fd", R_OK) == 0);
560 std::error_code openFileForRead(const Twine &Name, int &ResultFD,
561 SmallVectorImpl<char> *RealPath) {
562 SmallString<128> Storage;
563 StringRef P = Name.toNullTerminatedStringRef(Storage);
564 while ((ResultFD = open(P.begin(), O_RDONLY)) < 0) {
566 return std::error_code(errno, std::generic_category());
568 // Attempt to get the real name of the file, if the user asked
570 return std::error_code();
572 #if defined(F_GETPATH)
573 // When F_GETPATH is availble, it is the quickest way to get
574 // the real path name.
575 char Buffer[MAXPATHLEN];
576 if (::fcntl(ResultFD, F_GETPATH, Buffer) != -1)
577 RealPath->append(Buffer, Buffer + strlen(Buffer));
579 char Buffer[PATH_MAX];
580 if (hasProcSelfFD()) {
582 snprintf(ProcPath, sizeof(ProcPath), "/proc/self/fd/%d", ResultFD);
583 ssize_t CharCount = ::readlink(ProcPath, Buffer, sizeof(Buffer));
585 RealPath->append(Buffer, Buffer + CharCount);
587 // Use ::realpath to get the real path name
588 if (::realpath(P.begin(), Buffer) != nullptr)
589 RealPath->append(Buffer, Buffer + strlen(Buffer));
592 return std::error_code();
595 std::error_code openFileForWrite(const Twine &Name, int &ResultFD,
596 sys::fs::OpenFlags Flags, unsigned Mode) {
597 // Verify that we don't have both "append" and "excl".
598 assert((!(Flags & sys::fs::F_Excl) || !(Flags & sys::fs::F_Append)) &&
599 "Cannot specify both 'excl' and 'append' file creation flags!");
601 int OpenFlags = O_CREAT;
606 OpenFlags |= O_WRONLY;
608 if (Flags & F_Append)
609 OpenFlags |= O_APPEND;
611 OpenFlags |= O_TRUNC;
616 SmallString<128> Storage;
617 StringRef P = Name.toNullTerminatedStringRef(Storage);
618 while ((ResultFD = open(P.begin(), OpenFlags, Mode)) < 0) {
620 return std::error_code(errno, std::generic_category());
622 return std::error_code();
625 std::error_code getPathFromOpenFD(int FD, SmallVectorImpl<char> &ResultPath) {
627 return make_error_code(errc::bad_file_descriptor);
629 #if defined(F_GETPATH)
630 // When F_GETPATH is availble, it is the quickest way to get
631 // the path from a file descriptor.
632 ResultPath.reserve(MAXPATHLEN);
633 if (::fcntl(FD, F_GETPATH, ResultPath.begin()) == -1)
634 return std::error_code(errno, std::generic_category());
636 ResultPath.set_size(strlen(ResultPath.begin()));
638 // If we have a /proc filesystem mounted, we can quickly establish the
639 // real name of the file with readlink. Otherwise, we don't know how to
640 // get the filename from a file descriptor. Give up.
641 if (!fs::hasProcSelfFD())
642 return make_error_code(errc::function_not_supported);
644 ResultPath.reserve(PATH_MAX);
646 snprintf(ProcPath, sizeof(ProcPath), "/proc/self/fd/%d", FD);
647 ssize_t CharCount = ::readlink(ProcPath, ResultPath.begin(), ResultPath.capacity());
649 return std::error_code(errno, std::generic_category());
651 // Was the filename truncated?
652 if (static_cast<size_t>(CharCount) == ResultPath.capacity()) {
653 // Use lstat to get the size of the filename
655 if (::lstat(ProcPath, &sb) < 0)
656 return std::error_code(errno, std::generic_category());
658 ResultPath.reserve(sb.st_size + 1);
659 CharCount = ::readlink(ProcPath, ResultPath.begin(), ResultPath.capacity());
661 return std::error_code(errno, std::generic_category());
663 // Test for race condition: did the link size change?
664 if (CharCount > sb.st_size)
665 return std::error_code(ENAMETOOLONG, std::generic_category());
667 ResultPath.set_size(static_cast<size_t>(CharCount));
669 return std::error_code();
672 } // end namespace fs
676 bool home_directory(SmallVectorImpl<char> &result) {
677 if (char *RequestedDir = getenv("HOME")) {
679 result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
686 static bool getDarwinConfDir(bool TempDir, SmallVectorImpl<char> &Result) {
687 #if defined(_CS_DARWIN_USER_TEMP_DIR) && defined(_CS_DARWIN_USER_CACHE_DIR)
688 // On Darwin, use DARWIN_USER_TEMP_DIR or DARWIN_USER_CACHE_DIR.
689 // macros defined in <unistd.h> on darwin >= 9
690 int ConfName = TempDir ? _CS_DARWIN_USER_TEMP_DIR
691 : _CS_DARWIN_USER_CACHE_DIR;
692 size_t ConfLen = confstr(ConfName, nullptr, 0);
695 Result.resize(ConfLen);
696 ConfLen = confstr(ConfName, Result.data(), Result.size());
697 } while (ConfLen > 0 && ConfLen != Result.size());
700 assert(Result.back() == 0);
711 static bool getUserCacheDir(SmallVectorImpl<char> &Result) {
712 // First try using XDG_CACHE_HOME env variable,
713 // as specified in XDG Base Directory Specification at
714 // http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
715 if (const char *XdgCacheDir = std::getenv("XDG_CACHE_HOME")) {
717 Result.append(XdgCacheDir, XdgCacheDir + strlen(XdgCacheDir));
721 // Try Darwin configuration query
722 if (getDarwinConfDir(false, Result))
725 // Use "$HOME/.cache" if $HOME is available
726 if (home_directory(Result)) {
727 append(Result, ".cache");
734 static const char *getEnvTempDir() {
735 // Check whether the temporary directory is specified by an environment
737 const char *EnvironmentVariables[] = {"TMPDIR", "TMP", "TEMP", "TEMPDIR"};
738 for (const char *Env : EnvironmentVariables) {
739 if (const char *Dir = std::getenv(Env))
746 static const char *getDefaultTempDir(bool ErasedOnReboot) {
757 void system_temp_directory(bool ErasedOnReboot, SmallVectorImpl<char> &Result) {
760 if (ErasedOnReboot) {
761 // There is no env variable for the cache directory.
762 if (const char *RequestedDir = getEnvTempDir()) {
763 Result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
768 if (getDarwinConfDir(ErasedOnReboot, Result))
771 const char *RequestedDir = getDefaultTempDir(ErasedOnReboot);
772 Result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
775 } // end namespace path
777 } // end namespace sys
778 } // end namespace llvm