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;}
90 static error_code TempDir(SmallVectorImpl<char> &result) {
91 // FIXME: Don't use TMPDIR if program is SUID or SGID enabled.
93 (dir = std::getenv("TMPDIR")) || (dir = std::getenv("TMP")) ||
94 (dir = std::getenv("TEMP")) || (dir = std::getenv("TEMPDIR")) ||
102 result.append(d.begin(), d.end());
103 return error_code::success();
109 #if defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
110 defined(__OpenBSD__) || defined(__minix) || defined(__FreeBSD_kernel__) || \
111 defined(__linux__) || defined(__CYGWIN__) || defined(__DragonFly__)
113 test_dir(char ret[PATH_MAX], const char *dir, const char *bin)
116 char fullpath[PATH_MAX];
118 snprintf(fullpath, PATH_MAX, "%s/%s", dir, bin);
119 if (realpath(fullpath, ret) == NULL)
121 if (stat(fullpath, &sb) != 0)
128 getprogpath(char ret[PATH_MAX], const char *bin)
132 /* First approach: absolute path. */
134 if (test_dir(ret, "/", bin) == 0)
139 /* Second approach: relative path. */
140 if (strchr(bin, '/') != NULL) {
142 if (getcwd(cwd, PATH_MAX) == NULL)
144 if (test_dir(ret, cwd, bin) == 0)
149 /* Third approach: $PATH */
150 if ((pv = getenv("PATH")) == NULL)
155 while ((t = strsep(&s, ":")) != NULL) {
156 if (test_dir(ret, t, bin) == 0) {
164 #endif // __FreeBSD__ || __NetBSD__ || __FreeBSD_kernel__
166 /// GetMainExecutable - Return the path to the main executable, given the
167 /// value of argv[0] from program startup.
168 std::string getMainExecutable(const char *argv0, void *MainAddr) {
169 #if defined(__APPLE__)
170 // On OS X the executable path is saved to the stack by dyld. Reading it
171 // from there is much faster than calling dladdr, especially for large
172 // binaries with symbols.
173 char exe_path[MAXPATHLEN];
174 uint32_t size = sizeof(exe_path);
175 if (_NSGetExecutablePath(exe_path, &size) == 0) {
176 char link_path[MAXPATHLEN];
177 if (realpath(exe_path, link_path))
180 #elif defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
181 defined(__OpenBSD__) || defined(__minix) || defined(__DragonFly__) || \
182 defined(__FreeBSD_kernel__)
183 char exe_path[PATH_MAX];
185 if (getprogpath(exe_path, argv0) != NULL)
187 #elif defined(__linux__) || defined(__CYGWIN__)
188 char exe_path[MAXPATHLEN];
189 StringRef aPath("/proc/self/exe");
190 if (sys::fs::exists(aPath)) {
191 // /proc is not always mounted under Linux (chroot for example).
192 ssize_t len = readlink(aPath.str().c_str(), exe_path, sizeof(exe_path));
194 return StringRef(exe_path, len);
196 // Fall back to the classical detection.
197 if (getprogpath(exe_path, argv0) != NULL)
200 #elif defined(HAVE_DLFCN_H)
201 // Use dladdr to get executable path if available.
203 int err = dladdr(MainAddr, &DLInfo);
207 // If the filename is a symlink, we need to resolve and return the location of
208 // the actual executable.
209 char link_path[MAXPATHLEN];
210 if (realpath(DLInfo.dli_fname, link_path))
213 #error GetMainExecutable is not implemented on this host yet.
218 TimeValue file_status::getLastModificationTime() const {
220 Ret.fromEpochTime(fs_st_mtime);
224 UniqueID file_status::getUniqueID() const {
225 return UniqueID(fs_st_dev, fs_st_ino);
228 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 error_code::success();
242 result.reserve(MAXPATHLEN);
245 result.reserve(1024);
249 if (::getcwd(result.data(), result.capacity()) == 0) {
250 // See if there was a real error.
251 if (errno != errc::not_enough_memory)
252 return error_code(errno, system_category());
253 // Otherwise there just wasn't enough space.
254 result.reserve(result.capacity() * 2);
259 result.set_size(strlen(result.data()));
260 return error_code::success();
263 error_code create_directory(const Twine &path, bool IgnoreExisting) {
264 SmallString<128> path_storage;
265 StringRef p = path.toNullTerminatedStringRef(path_storage);
267 if (::mkdir(p.begin(), S_IRWXU | S_IRWXG) == -1) {
268 if (errno != errc::file_exists || !IgnoreExisting)
269 return error_code(errno, system_category());
272 return error_code::success();
275 error_code create_hard_link(const Twine &to, const Twine &from) {
277 SmallString<128> from_storage;
278 SmallString<128> to_storage;
279 StringRef f = from.toNullTerminatedStringRef(from_storage);
280 StringRef t = to.toNullTerminatedStringRef(to_storage);
282 if (::link(t.begin(), f.begin()) == -1)
283 return error_code(errno, system_category());
285 return error_code::success();
288 error_code remove(const Twine &path, bool IgnoreNonExisting) {
289 SmallString<128> path_storage;
290 StringRef p = path.toNullTerminatedStringRef(path_storage);
293 if (stat(p.begin(), &buf) != 0) {
294 if (errno != errc::no_such_file_or_directory || !IgnoreNonExisting)
295 return error_code(errno, system_category());
296 return error_code::success();
299 // Note: this check catches strange situations. In all cases, LLVM should
300 // only be involved in the creation and deletion of regular files. This
301 // check ensures that what we're trying to erase is a regular file. It
302 // effectively prevents LLVM from erasing things like /dev/null, any block
303 // special file, or other things that aren't "regular" files.
304 if (!S_ISREG(buf.st_mode) && !S_ISDIR(buf.st_mode))
305 return make_error_code(errc::operation_not_permitted);
307 if (::remove(p.begin()) == -1) {
308 if (errno != errc::no_such_file_or_directory || !IgnoreNonExisting)
309 return error_code(errno, system_category());
312 return error_code::success();
315 error_code rename(const Twine &from, const Twine &to) {
317 SmallString<128> from_storage;
318 SmallString<128> to_storage;
319 StringRef f = from.toNullTerminatedStringRef(from_storage);
320 StringRef t = to.toNullTerminatedStringRef(to_storage);
322 if (::rename(f.begin(), t.begin()) == -1)
323 return error_code(errno, system_category());
325 return error_code::success();
328 error_code resize_file(const Twine &path, uint64_t size) {
329 SmallString<128> path_storage;
330 StringRef p = path.toNullTerminatedStringRef(path_storage);
332 if (::truncate(p.begin(), size) == -1)
333 return error_code(errno, system_category());
335 return error_code::success();
338 error_code exists(const Twine &path, bool &result) {
339 SmallString<128> path_storage;
340 StringRef p = path.toNullTerminatedStringRef(path_storage);
342 if (::access(p.begin(), F_OK) == -1) {
343 if (errno != errc::no_such_file_or_directory)
344 return error_code(errno, system_category());
349 return error_code::success();
352 bool can_write(const Twine &Path) {
353 SmallString<128> PathStorage;
354 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
355 return 0 == access(P.begin(), W_OK);
358 bool can_execute(const Twine &Path) {
359 SmallString<128> PathStorage;
360 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
362 if (0 != access(P.begin(), R_OK | X_OK))
365 if (0 != stat(P.begin(), &buf))
367 if (!S_ISREG(buf.st_mode))
372 bool equivalent(file_status A, file_status B) {
373 assert(status_known(A) && status_known(B));
374 return A.fs_st_dev == B.fs_st_dev &&
375 A.fs_st_ino == B.fs_st_ino;
378 error_code equivalent(const Twine &A, const Twine &B, bool &result) {
379 file_status fsA, fsB;
380 if (error_code ec = status(A, fsA)) return ec;
381 if (error_code ec = status(B, fsB)) return ec;
382 result = equivalent(fsA, fsB);
383 return error_code::success();
386 static error_code fillStatus(int StatRet, const struct stat &Status,
387 file_status &Result) {
389 error_code ec(errno, system_category());
390 if (ec == errc::no_such_file_or_directory)
391 Result = file_status(file_type::file_not_found);
393 Result = file_status(file_type::status_error);
397 file_type Type = file_type::type_unknown;
399 if (S_ISDIR(Status.st_mode))
400 Type = file_type::directory_file;
401 else if (S_ISREG(Status.st_mode))
402 Type = file_type::regular_file;
403 else if (S_ISBLK(Status.st_mode))
404 Type = file_type::block_file;
405 else if (S_ISCHR(Status.st_mode))
406 Type = file_type::character_file;
407 else if (S_ISFIFO(Status.st_mode))
408 Type = file_type::fifo_file;
409 else if (S_ISSOCK(Status.st_mode))
410 Type = file_type::socket_file;
412 perms Perms = static_cast<perms>(Status.st_mode);
414 file_status(Type, Perms, Status.st_dev, Status.st_ino, Status.st_mtime,
415 Status.st_uid, Status.st_gid, Status.st_size);
417 return error_code::success();
420 error_code status(const Twine &Path, file_status &Result) {
421 SmallString<128> PathStorage;
422 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
425 int StatRet = ::stat(P.begin(), &Status);
426 return fillStatus(StatRet, Status, Result);
429 error_code status(int FD, file_status &Result) {
431 int StatRet = ::fstat(FD, &Status);
432 return fillStatus(StatRet, Status, Result);
435 error_code setLastModificationAndAccessTime(int FD, TimeValue Time) {
436 #if defined(HAVE_FUTIMENS)
438 Times[0].tv_sec = Time.toEpochTime();
439 Times[0].tv_nsec = 0;
441 if (::futimens(FD, Times))
442 return error_code(errno, system_category());
443 return error_code::success();
444 #elif defined(HAVE_FUTIMES)
446 Times[0].tv_sec = Time.toEpochTime();
447 Times[0].tv_usec = 0;
449 if (::futimes(FD, Times))
450 return error_code(errno, system_category());
451 return error_code::success();
453 #warning Missing futimes() and futimens()
454 return make_error_code(errc::not_supported);
458 error_code mapped_file_region::init(int FD, bool CloseFD, uint64_t Offset) {
463 // Figure out how large the file is.
464 struct stat FileInfo;
465 if (fstat(FD, &FileInfo) == -1)
466 return error_code(errno, system_category());
467 uint64_t FileSize = FileInfo.st_size;
471 else if (FileSize < Size) {
472 // We need to grow the file.
473 if (ftruncate(FD, Size) == -1)
474 return error_code(errno, system_category());
477 int flags = (Mode == readwrite) ? MAP_SHARED : MAP_PRIVATE;
478 int prot = (Mode == readonly) ? PROT_READ : (PROT_READ | PROT_WRITE);
482 Mapping = ::mmap(0, Size, prot, flags, FD, Offset);
483 if (Mapping == MAP_FAILED)
484 return error_code(errno, system_category());
485 return error_code::success();
488 mapped_file_region::mapped_file_region(const Twine &path,
496 // Make sure that the requested size fits within SIZE_T.
497 if (length > std::numeric_limits<size_t>::max()) {
498 ec = make_error_code(errc::invalid_argument);
502 SmallString<128> path_storage;
503 StringRef name = path.toNullTerminatedStringRef(path_storage);
504 int oflags = (mode == readonly) ? O_RDONLY : O_RDWR;
505 int ofd = ::open(name.begin(), oflags);
507 ec = error_code(errno, system_category());
511 ec = init(ofd, true, offset);
516 mapped_file_region::mapped_file_region(int fd,
525 // Make sure that the requested size fits within SIZE_T.
526 if (length > std::numeric_limits<size_t>::max()) {
527 ec = make_error_code(errc::invalid_argument);
531 ec = init(fd, closefd, offset);
536 mapped_file_region::~mapped_file_region() {
538 ::munmap(Mapping, Size);
541 mapped_file_region::mapped_file_region(mapped_file_region &&other)
542 : Mode(other.Mode), Size(other.Size), Mapping(other.Mapping) {
546 mapped_file_region::mapmode mapped_file_region::flags() const {
547 assert(Mapping && "Mapping failed but used anyway!");
551 uint64_t mapped_file_region::size() const {
552 assert(Mapping && "Mapping failed but used anyway!");
556 char *mapped_file_region::data() const {
557 assert(Mapping && "Mapping failed but used anyway!");
558 assert(Mode != readonly && "Cannot get non-const data for readonly mapping!");
559 return reinterpret_cast<char*>(Mapping);
562 const char *mapped_file_region::const_data() const {
563 assert(Mapping && "Mapping failed but used anyway!");
564 return reinterpret_cast<const char*>(Mapping);
567 int mapped_file_region::alignment() {
568 return process::get_self()->page_size();
571 error_code detail::directory_iterator_construct(detail::DirIterState &it,
573 SmallString<128> path_null(path);
574 DIR *directory = ::opendir(path_null.c_str());
576 return error_code(errno, system_category());
578 it.IterationHandle = reinterpret_cast<intptr_t>(directory);
579 // Add something for replace_filename to replace.
580 path::append(path_null, ".");
581 it.CurrentEntry = directory_entry(path_null.str());
582 return directory_iterator_increment(it);
585 error_code detail::directory_iterator_destruct(detail::DirIterState &it) {
586 if (it.IterationHandle)
587 ::closedir(reinterpret_cast<DIR *>(it.IterationHandle));
588 it.IterationHandle = 0;
589 it.CurrentEntry = directory_entry();
590 return error_code::success();
593 error_code detail::directory_iterator_increment(detail::DirIterState &it) {
595 dirent *cur_dir = ::readdir(reinterpret_cast<DIR *>(it.IterationHandle));
596 if (cur_dir == 0 && errno != 0) {
597 return error_code(errno, system_category());
598 } else if (cur_dir != 0) {
599 StringRef name(cur_dir->d_name, NAMLEN(cur_dir));
600 if ((name.size() == 1 && name[0] == '.') ||
601 (name.size() == 2 && name[0] == '.' && name[1] == '.'))
602 return directory_iterator_increment(it);
603 it.CurrentEntry.replace_filename(name);
605 return directory_iterator_destruct(it);
607 return error_code::success();
610 error_code get_magic(const Twine &path, uint32_t len,
611 SmallVectorImpl<char> &result) {
612 SmallString<128> PathStorage;
613 StringRef Path = path.toNullTerminatedStringRef(PathStorage);
617 std::FILE *file = std::fopen(Path.data(), "rb");
619 return error_code(errno, system_category());
625 size_t size = std::fread(result.data(), 1, len, file);
626 if (std::ferror(file) != 0) {
628 return error_code(errno, system_category());
629 } else if (size != len) {
630 if (std::feof(file) != 0) {
632 result.set_size(size);
633 return make_error_code(errc::value_too_large);
637 result.set_size(size);
638 return error_code::success();
641 error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
642 bool map_writable, void *&result) {
643 SmallString<128> path_storage;
644 StringRef name = path.toNullTerminatedStringRef(path_storage);
645 int oflags = map_writable ? O_RDWR : O_RDONLY;
646 int ofd = ::open(name.begin(), oflags);
648 return error_code(errno, system_category());
650 int flags = map_writable ? MAP_SHARED : MAP_PRIVATE;
651 int prot = map_writable ? (PROT_READ|PROT_WRITE) : PROT_READ;
655 result = ::mmap(0, size, prot, flags, fd, file_offset);
656 if (result == MAP_FAILED) {
657 return error_code(errno, system_category());
660 return error_code::success();
663 error_code unmap_file_pages(void *base, size_t size) {
664 if ( ::munmap(base, size) == -1 )
665 return error_code(errno, system_category());
667 return error_code::success();
670 error_code openFileForRead(const Twine &Name, int &ResultFD) {
671 SmallString<128> Storage;
672 StringRef P = Name.toNullTerminatedStringRef(Storage);
673 while ((ResultFD = open(P.begin(), O_RDONLY)) < 0) {
675 return error_code(errno, system_category());
677 return error_code::success();
680 error_code openFileForWrite(const Twine &Name, int &ResultFD,
681 sys::fs::OpenFlags Flags, unsigned Mode) {
682 // Verify that we don't have both "append" and "excl".
683 assert((!(Flags & sys::fs::F_Excl) || !(Flags & sys::fs::F_Append)) &&
684 "Cannot specify both 'excl' and 'append' file creation flags!");
686 int OpenFlags = O_CREAT;
691 OpenFlags |= O_WRONLY;
693 if (Flags & F_Append)
694 OpenFlags |= O_APPEND;
696 OpenFlags |= O_TRUNC;
701 SmallString<128> Storage;
702 StringRef P = Name.toNullTerminatedStringRef(Storage);
703 while ((ResultFD = open(P.begin(), OpenFlags, Mode)) < 0) {
705 return error_code(errno, system_category());
707 return error_code::success();
710 } // end namespace fs
714 bool home_directory(SmallVectorImpl<char> &result) {
715 if (char *RequestedDir = getenv("HOME")) {
717 result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
724 } // end namespace path
726 } // end namespace sys
727 } // end namespace llvm