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 //===----------------------------------------------------------------------===//
28 #ifdef HAVE_SYS_MMAN_H
33 # define NAMLEN(dirent) strlen((dirent)->d_name)
35 # define dirent direct
36 # define NAMLEN(dirent) (dirent)->d_namlen
38 # include <sys/ndir.h>
49 #include <mach-o/dyld.h>
52 // Both stdio.h and cstdio are included via different pathes and
53 // stdcxx's cstdio doesn't include stdio.h, so it doesn't #undef the macros
59 #if defined(__GNU__) && !defined(PATH_MAX)
60 # define PATH_MAX 4096
66 /// This class automatically closes the given file descriptor when it goes out
67 /// of scope. You can take back explicit ownership of the file descriptor by
68 /// calling take(). The destructor does not verify that close was successful.
69 /// Therefore, never allow this class to call close on a file descriptor that
70 /// has been read from or written to.
74 AutoFD(int fd) : FileDescriptor(fd) {}
76 if (FileDescriptor >= 0)
77 ::close(FileDescriptor);
81 int ret = FileDescriptor;
86 operator int() const {return FileDescriptor;}
93 #if defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
94 defined(__OpenBSD__) || defined(__minix) || defined(__FreeBSD_kernel__) || \
95 defined(__linux__) || defined(__CYGWIN__) || defined(__DragonFly__)
97 test_dir(char ret[PATH_MAX], const char *dir, const char *bin)
100 char fullpath[PATH_MAX];
102 snprintf(fullpath, PATH_MAX, "%s/%s", dir, bin);
103 if (realpath(fullpath, ret) == NULL)
105 if (stat(fullpath, &sb) != 0)
112 getprogpath(char ret[PATH_MAX], const char *bin)
116 /* First approach: absolute path. */
118 if (test_dir(ret, "/", bin) == 0)
123 /* Second approach: relative path. */
124 if (strchr(bin, '/') != NULL) {
126 if (getcwd(cwd, PATH_MAX) == NULL)
128 if (test_dir(ret, cwd, bin) == 0)
133 /* Third approach: $PATH */
134 if ((pv = getenv("PATH")) == NULL)
139 while ((t = strsep(&s, ":")) != NULL) {
140 if (test_dir(ret, t, bin) == 0) {
148 #endif // __FreeBSD__ || __NetBSD__ || __FreeBSD_kernel__
150 /// GetMainExecutable - Return the path to the main executable, given the
151 /// value of argv[0] from program startup.
152 std::string getMainExecutable(const char *argv0, void *MainAddr) {
153 #if defined(__APPLE__)
154 // On OS X the executable path is saved to the stack by dyld. Reading it
155 // from there is much faster than calling dladdr, especially for large
156 // binaries with symbols.
157 char exe_path[MAXPATHLEN];
158 uint32_t size = sizeof(exe_path);
159 if (_NSGetExecutablePath(exe_path, &size) == 0) {
160 char link_path[MAXPATHLEN];
161 if (realpath(exe_path, link_path))
164 #elif defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
165 defined(__OpenBSD__) || defined(__minix) || defined(__DragonFly__) || \
166 defined(__FreeBSD_kernel__)
167 char exe_path[PATH_MAX];
169 if (getprogpath(exe_path, argv0) != NULL)
171 #elif defined(__linux__) || defined(__CYGWIN__)
172 char exe_path[MAXPATHLEN];
173 StringRef aPath("/proc/self/exe");
174 if (sys::fs::exists(aPath)) {
175 // /proc is not always mounted under Linux (chroot for example).
176 ssize_t len = readlink(aPath.str().c_str(), exe_path, sizeof(exe_path));
178 return StringRef(exe_path, len);
180 // Fall back to the classical detection.
181 if (getprogpath(exe_path, argv0) != NULL)
184 #elif defined(HAVE_DLFCN_H)
185 // Use dladdr to get executable path if available.
187 int err = dladdr(MainAddr, &DLInfo);
191 // If the filename is a symlink, we need to resolve and return the location of
192 // the actual executable.
193 char link_path[MAXPATHLEN];
194 if (realpath(DLInfo.dli_fname, link_path))
197 #error GetMainExecutable is not implemented on this host yet.
202 TimeValue file_status::getLastModificationTime() const {
204 Ret.fromEpochTime(fs_st_mtime);
208 UniqueID file_status::getUniqueID() const {
209 return UniqueID(fs_st_dev, fs_st_ino);
212 std::error_code current_path(SmallVectorImpl<char> &result) {
215 const char *pwd = ::getenv("PWD");
216 llvm::sys::fs::file_status PWDStatus, DotStatus;
217 if (pwd && llvm::sys::path::is_absolute(pwd) &&
218 !llvm::sys::fs::status(pwd, PWDStatus) &&
219 !llvm::sys::fs::status(".", DotStatus) &&
220 PWDStatus.getUniqueID() == DotStatus.getUniqueID()) {
221 result.append(pwd, pwd + strlen(pwd));
222 return std::error_code();
226 result.reserve(MAXPATHLEN);
229 result.reserve(1024);
233 if (::getcwd(result.data(), result.capacity()) == nullptr) {
234 // See if there was a real error.
236 return std::error_code(errno, std::generic_category());
237 // Otherwise there just wasn't enough space.
238 result.reserve(result.capacity() * 2);
243 result.set_size(strlen(result.data()));
244 return std::error_code();
247 std::error_code create_directory(const Twine &path, bool IgnoreExisting) {
248 SmallString<128> path_storage;
249 StringRef p = path.toNullTerminatedStringRef(path_storage);
251 if (::mkdir(p.begin(), S_IRWXU | S_IRWXG) == -1) {
252 if (errno != EEXIST || !IgnoreExisting)
253 return std::error_code(errno, std::generic_category());
256 return std::error_code();
259 // Note that we are using symbolic link because hard links are not supported by
260 // all filesystems (SMB doesn't).
261 std::error_code create_link(const Twine &to, const Twine &from) {
263 SmallString<128> from_storage;
264 SmallString<128> to_storage;
265 StringRef f = from.toNullTerminatedStringRef(from_storage);
266 StringRef t = to.toNullTerminatedStringRef(to_storage);
268 if (::symlink(t.begin(), f.begin()) == -1)
269 return std::error_code(errno, std::generic_category());
271 return std::error_code();
274 std::error_code remove(const Twine &path, bool IgnoreNonExisting) {
275 SmallString<128> path_storage;
276 StringRef p = path.toNullTerminatedStringRef(path_storage);
279 if (lstat(p.begin(), &buf) != 0) {
280 if (errno != ENOENT || !IgnoreNonExisting)
281 return std::error_code(errno, std::generic_category());
282 return std::error_code();
285 // Note: this check catches strange situations. In all cases, LLVM should
286 // only be involved in the creation and deletion of regular files. This
287 // check ensures that what we're trying to erase is a regular file. It
288 // effectively prevents LLVM from erasing things like /dev/null, any block
289 // special file, or other things that aren't "regular" files.
290 if (!S_ISREG(buf.st_mode) && !S_ISDIR(buf.st_mode) && !S_ISLNK(buf.st_mode))
291 return make_error_code(errc::operation_not_permitted);
293 if (::remove(p.begin()) == -1) {
294 if (errno != ENOENT || !IgnoreNonExisting)
295 return std::error_code(errno, std::generic_category());
298 return std::error_code();
301 std::error_code rename(const Twine &from, const Twine &to) {
303 SmallString<128> from_storage;
304 SmallString<128> to_storage;
305 StringRef f = from.toNullTerminatedStringRef(from_storage);
306 StringRef t = to.toNullTerminatedStringRef(to_storage);
308 if (::rename(f.begin(), t.begin()) == -1)
309 return std::error_code(errno, std::generic_category());
311 return std::error_code();
314 std::error_code resize_file(const Twine &path, uint64_t size) {
315 SmallString<128> path_storage;
316 StringRef p = path.toNullTerminatedStringRef(path_storage);
318 if (::truncate(p.begin(), size) == -1)
319 return std::error_code(errno, std::generic_category());
321 return std::error_code();
324 static int convertAccessMode(AccessMode Mode) {
326 case AccessMode::Exist:
328 case AccessMode::Write:
330 case AccessMode::Execute:
331 return R_OK | X_OK; // scripts also need R_OK.
333 llvm_unreachable("invalid enum");
336 std::error_code access(const Twine &Path, AccessMode Mode) {
337 SmallString<128> PathStorage;
338 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
340 if (::access(P.begin(), convertAccessMode(Mode)) == -1)
341 return std::error_code(errno, std::generic_category());
343 if (Mode == AccessMode::Execute) {
344 // Don't say that directories are executable.
346 if (0 != stat(P.begin(), &buf))
347 return errc::permission_denied;
348 if (!S_ISREG(buf.st_mode))
349 return errc::permission_denied;
352 return std::error_code();
355 bool equivalent(file_status A, file_status B) {
356 assert(status_known(A) && status_known(B));
357 return A.fs_st_dev == B.fs_st_dev &&
358 A.fs_st_ino == B.fs_st_ino;
361 std::error_code equivalent(const Twine &A, const Twine &B, bool &result) {
362 file_status fsA, fsB;
363 if (std::error_code ec = status(A, fsA))
365 if (std::error_code ec = status(B, fsB))
367 result = equivalent(fsA, fsB);
368 return std::error_code();
371 static std::error_code fillStatus(int StatRet, const struct stat &Status,
372 file_status &Result) {
374 std::error_code ec(errno, std::generic_category());
375 if (ec == errc::no_such_file_or_directory)
376 Result = file_status(file_type::file_not_found);
378 Result = file_status(file_type::status_error);
382 file_type Type = file_type::type_unknown;
384 if (S_ISDIR(Status.st_mode))
385 Type = file_type::directory_file;
386 else if (S_ISREG(Status.st_mode))
387 Type = file_type::regular_file;
388 else if (S_ISBLK(Status.st_mode))
389 Type = file_type::block_file;
390 else if (S_ISCHR(Status.st_mode))
391 Type = file_type::character_file;
392 else if (S_ISFIFO(Status.st_mode))
393 Type = file_type::fifo_file;
394 else if (S_ISSOCK(Status.st_mode))
395 Type = file_type::socket_file;
397 perms Perms = static_cast<perms>(Status.st_mode);
399 file_status(Type, Perms, Status.st_dev, Status.st_ino, Status.st_mtime,
400 Status.st_uid, Status.st_gid, Status.st_size);
402 return std::error_code();
405 std::error_code status(const Twine &Path, file_status &Result) {
406 SmallString<128> PathStorage;
407 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
410 int StatRet = ::stat(P.begin(), &Status);
411 return fillStatus(StatRet, Status, Result);
414 std::error_code status(int FD, file_status &Result) {
416 int StatRet = ::fstat(FD, &Status);
417 return fillStatus(StatRet, Status, Result);
420 std::error_code setLastModificationAndAccessTime(int FD, TimeValue Time) {
421 #if defined(HAVE_FUTIMENS)
423 Times[0].tv_sec = Time.toEpochTime();
424 Times[0].tv_nsec = 0;
426 if (::futimens(FD, Times))
427 return std::error_code(errno, std::generic_category());
428 return std::error_code();
429 #elif defined(HAVE_FUTIMES)
431 Times[0].tv_sec = Time.toEpochTime();
432 Times[0].tv_usec = 0;
434 if (::futimes(FD, Times))
435 return std::error_code(errno, std::generic_category());
436 return std::error_code();
438 #warning Missing futimes() and futimens()
439 return make_error_code(errc::function_not_supported);
443 std::error_code mapped_file_region::init(int FD, bool CloseFD, uint64_t Offset) {
448 // Figure out how large the file is.
449 struct stat FileInfo;
450 if (fstat(FD, &FileInfo) == -1)
451 return std::error_code(errno, std::generic_category());
452 uint64_t FileSize = FileInfo.st_size;
456 else if (FileSize < Size) {
457 // We need to grow the file.
458 if (ftruncate(FD, Size) == -1)
459 return std::error_code(errno, std::generic_category());
462 int flags = (Mode == readwrite) ? MAP_SHARED : MAP_PRIVATE;
463 int prot = (Mode == readonly) ? PROT_READ : (PROT_READ | PROT_WRITE);
467 Mapping = ::mmap(nullptr, Size, prot, flags, FD, Offset);
468 if (Mapping == MAP_FAILED)
469 return std::error_code(errno, std::generic_category());
470 return std::error_code();
473 mapped_file_region::mapped_file_region(const Twine &path,
481 // Make sure that the requested size fits within SIZE_T.
482 if (length > std::numeric_limits<size_t>::max()) {
483 ec = make_error_code(errc::invalid_argument);
487 SmallString<128> path_storage;
488 StringRef name = path.toNullTerminatedStringRef(path_storage);
489 int oflags = (mode == readonly) ? O_RDONLY : O_RDWR;
490 int ofd = ::open(name.begin(), oflags);
492 ec = std::error_code(errno, std::generic_category());
496 ec = init(ofd, true, offset);
501 mapped_file_region::mapped_file_region(int fd,
510 // Make sure that the requested size fits within SIZE_T.
511 if (length > std::numeric_limits<size_t>::max()) {
512 ec = make_error_code(errc::invalid_argument);
516 ec = init(fd, closefd, offset);
521 mapped_file_region::~mapped_file_region() {
523 ::munmap(Mapping, Size);
526 mapped_file_region::mapped_file_region(mapped_file_region &&other)
527 : Mode(other.Mode), Size(other.Size), Mapping(other.Mapping) {
528 other.Mapping = nullptr;
531 mapped_file_region::mapmode mapped_file_region::flags() const {
532 assert(Mapping && "Mapping failed but used anyway!");
536 uint64_t mapped_file_region::size() const {
537 assert(Mapping && "Mapping failed but used anyway!");
541 char *mapped_file_region::data() const {
542 assert(Mapping && "Mapping failed but used anyway!");
543 assert(Mode != readonly && "Cannot get non-const data for readonly mapping!");
544 return reinterpret_cast<char*>(Mapping);
547 const char *mapped_file_region::const_data() const {
548 assert(Mapping && "Mapping failed but used anyway!");
549 return reinterpret_cast<const char*>(Mapping);
552 int mapped_file_region::alignment() {
553 return process::get_self()->page_size();
556 std::error_code detail::directory_iterator_construct(detail::DirIterState &it,
558 SmallString<128> path_null(path);
559 DIR *directory = ::opendir(path_null.c_str());
561 return std::error_code(errno, std::generic_category());
563 it.IterationHandle = reinterpret_cast<intptr_t>(directory);
564 // Add something for replace_filename to replace.
565 path::append(path_null, ".");
566 it.CurrentEntry = directory_entry(path_null.str());
567 return directory_iterator_increment(it);
570 std::error_code detail::directory_iterator_destruct(detail::DirIterState &it) {
571 if (it.IterationHandle)
572 ::closedir(reinterpret_cast<DIR *>(it.IterationHandle));
573 it.IterationHandle = 0;
574 it.CurrentEntry = directory_entry();
575 return std::error_code();
578 std::error_code detail::directory_iterator_increment(detail::DirIterState &it) {
580 dirent *cur_dir = ::readdir(reinterpret_cast<DIR *>(it.IterationHandle));
581 if (cur_dir == nullptr && errno != 0) {
582 return std::error_code(errno, std::generic_category());
583 } else if (cur_dir != nullptr) {
584 StringRef name(cur_dir->d_name, NAMLEN(cur_dir));
585 if ((name.size() == 1 && name[0] == '.') ||
586 (name.size() == 2 && name[0] == '.' && name[1] == '.'))
587 return directory_iterator_increment(it);
588 it.CurrentEntry.replace_filename(name);
590 return directory_iterator_destruct(it);
592 return std::error_code();
595 std::error_code openFileForRead(const Twine &Name, int &ResultFD) {
596 SmallString<128> Storage;
597 StringRef P = Name.toNullTerminatedStringRef(Storage);
598 while ((ResultFD = open(P.begin(), O_RDONLY)) < 0) {
600 return std::error_code(errno, std::generic_category());
602 return std::error_code();
605 std::error_code openFileForWrite(const Twine &Name, int &ResultFD,
606 sys::fs::OpenFlags Flags, unsigned Mode) {
607 // Verify that we don't have both "append" and "excl".
608 assert((!(Flags & sys::fs::F_Excl) || !(Flags & sys::fs::F_Append)) &&
609 "Cannot specify both 'excl' and 'append' file creation flags!");
611 int OpenFlags = O_CREAT;
616 OpenFlags |= O_WRONLY;
618 if (Flags & F_Append)
619 OpenFlags |= O_APPEND;
621 OpenFlags |= O_TRUNC;
626 SmallString<128> Storage;
627 StringRef P = Name.toNullTerminatedStringRef(Storage);
628 while ((ResultFD = open(P.begin(), OpenFlags, Mode)) < 0) {
630 return std::error_code(errno, std::generic_category());
632 return std::error_code();
635 } // end namespace fs
639 bool home_directory(SmallVectorImpl<char> &result) {
640 if (char *RequestedDir = getenv("HOME")) {
642 result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
649 static const char *getEnvTempDir() {
650 // Check whether the temporary directory is specified by an environment
652 const char *EnvironmentVariables[] = {"TMPDIR", "TMP", "TEMP", "TEMPDIR"};
653 for (const char *Env : EnvironmentVariables) {
654 if (const char *Dir = std::getenv(Env))
661 static const char *getDefaultTempDir(bool ErasedOnReboot) {
672 void system_temp_directory(bool ErasedOnReboot, SmallVectorImpl<char> &Result) {
675 if (ErasedOnReboot) {
676 // There is no env variable for the cache directory.
677 if (const char *RequestedDir = getEnvTempDir()) {
678 Result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
683 #if defined(_CS_DARWIN_USER_TEMP_DIR) && defined(_CS_DARWIN_USER_CACHE_DIR)
684 // On Darwin, use DARWIN_USER_TEMP_DIR or DARWIN_USER_CACHE_DIR.
685 // macros defined in <unistd.h> on darwin >= 9
686 int ConfName = ErasedOnReboot? _CS_DARWIN_USER_TEMP_DIR
687 : _CS_DARWIN_USER_CACHE_DIR;
688 size_t ConfLen = confstr(ConfName, nullptr, 0);
691 Result.resize(ConfLen);
692 ConfLen = confstr(ConfName, Result.data(), Result.size());
693 } while (ConfLen > 0 && ConfLen != Result.size());
696 assert(Result.back() == 0);
705 const char *RequestedDir = getDefaultTempDir(ErasedOnReboot);
706 Result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
709 } // end namespace path
711 } // end namespace sys
712 } // end namespace llvm