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
68 #if defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
69 defined(__OpenBSD__) || defined(__minix) || defined(__FreeBSD_kernel__) || \
70 defined(__linux__) || defined(__CYGWIN__) || defined(__DragonFly__)
72 test_dir(char ret[PATH_MAX], const char *dir, const char *bin)
75 char fullpath[PATH_MAX];
77 snprintf(fullpath, PATH_MAX, "%s/%s", dir, bin);
78 if (!realpath(fullpath, ret))
80 if (stat(fullpath, &sb) != 0)
87 getprogpath(char ret[PATH_MAX], const char *bin)
91 /* First approach: absolute path. */
93 if (test_dir(ret, "/", bin) == 0)
98 /* Second approach: relative path. */
99 if (strchr(bin, '/')) {
101 if (!getcwd(cwd, PATH_MAX))
103 if (test_dir(ret, cwd, bin) == 0)
108 /* Third approach: $PATH */
109 if ((pv = getenv("PATH")) == nullptr)
114 while ((t = strsep(&s, ":")) != nullptr) {
115 if (test_dir(ret, t, bin) == 0) {
123 #endif // __FreeBSD__ || __NetBSD__ || __FreeBSD_kernel__
125 /// GetMainExecutable - Return the path to the main executable, given the
126 /// value of argv[0] from program startup.
127 std::string getMainExecutable(const char *argv0, void *MainAddr) {
128 #if defined(__APPLE__)
129 // On OS X the executable path is saved to the stack by dyld. Reading it
130 // from there is much faster than calling dladdr, especially for large
131 // binaries with symbols.
132 char exe_path[MAXPATHLEN];
133 uint32_t size = sizeof(exe_path);
134 if (_NSGetExecutablePath(exe_path, &size) == 0) {
135 char link_path[MAXPATHLEN];
136 if (realpath(exe_path, link_path))
139 #elif defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
140 defined(__OpenBSD__) || defined(__minix) || defined(__DragonFly__) || \
141 defined(__FreeBSD_kernel__)
142 char exe_path[PATH_MAX];
144 if (getprogpath(exe_path, argv0) != NULL)
146 #elif defined(__linux__) || defined(__CYGWIN__)
147 char exe_path[MAXPATHLEN];
148 StringRef aPath("/proc/self/exe");
149 if (sys::fs::exists(aPath)) {
150 // /proc is not always mounted under Linux (chroot for example).
151 ssize_t len = readlink(aPath.str().c_str(), exe_path, sizeof(exe_path));
153 return std::string(exe_path, len);
155 // Fall back to the classical detection.
156 if (getprogpath(exe_path, argv0))
159 #elif defined(HAVE_DLFCN_H)
160 // Use dladdr to get executable path if available.
162 int err = dladdr(MainAddr, &DLInfo);
166 // If the filename is a symlink, we need to resolve and return the location of
167 // the actual executable.
168 char link_path[MAXPATHLEN];
169 if (realpath(DLInfo.dli_fname, link_path))
172 #error GetMainExecutable is not implemented on this host yet.
177 TimeValue file_status::getLastModificationTime() const {
179 Ret.fromEpochTime(fs_st_mtime);
183 UniqueID file_status::getUniqueID() const {
184 return UniqueID(fs_st_dev, fs_st_ino);
187 std::error_code current_path(SmallVectorImpl<char> &result) {
190 const char *pwd = ::getenv("PWD");
191 llvm::sys::fs::file_status PWDStatus, DotStatus;
192 if (pwd && llvm::sys::path::is_absolute(pwd) &&
193 !llvm::sys::fs::status(pwd, PWDStatus) &&
194 !llvm::sys::fs::status(".", DotStatus) &&
195 PWDStatus.getUniqueID() == DotStatus.getUniqueID()) {
196 result.append(pwd, pwd + strlen(pwd));
197 return std::error_code();
201 result.reserve(MAXPATHLEN);
204 result.reserve(1024);
208 if (::getcwd(result.data(), result.capacity()) == nullptr) {
209 // See if there was a real error.
211 return std::error_code(errno, std::generic_category());
212 // Otherwise there just wasn't enough space.
213 result.reserve(result.capacity() * 2);
218 result.set_size(strlen(result.data()));
219 return std::error_code();
222 std::error_code create_directory(const Twine &path, bool IgnoreExisting,
224 SmallString<128> path_storage;
225 StringRef p = path.toNullTerminatedStringRef(path_storage);
227 if (::mkdir(p.begin(), Perms) == -1) {
228 if (errno != EEXIST || !IgnoreExisting)
229 return std::error_code(errno, std::generic_category());
232 return std::error_code();
235 // Note that we are using symbolic link because hard links are not supported by
236 // all filesystems (SMB doesn't).
237 std::error_code create_link(const Twine &to, const Twine &from) {
239 SmallString<128> from_storage;
240 SmallString<128> to_storage;
241 StringRef f = from.toNullTerminatedStringRef(from_storage);
242 StringRef t = to.toNullTerminatedStringRef(to_storage);
244 if (::symlink(t.begin(), f.begin()) == -1)
245 return std::error_code(errno, std::generic_category());
247 return std::error_code();
250 std::error_code remove(const Twine &path, bool IgnoreNonExisting) {
251 SmallString<128> path_storage;
252 StringRef p = path.toNullTerminatedStringRef(path_storage);
255 if (lstat(p.begin(), &buf) != 0) {
256 if (errno != ENOENT || !IgnoreNonExisting)
257 return std::error_code(errno, std::generic_category());
258 return std::error_code();
261 // Note: this check catches strange situations. In all cases, LLVM should
262 // only be involved in the creation and deletion of regular files. This
263 // check ensures that what we're trying to erase is a regular file. It
264 // effectively prevents LLVM from erasing things like /dev/null, any block
265 // special file, or other things that aren't "regular" files.
266 if (!S_ISREG(buf.st_mode) && !S_ISDIR(buf.st_mode) && !S_ISLNK(buf.st_mode))
267 return make_error_code(errc::operation_not_permitted);
269 if (::remove(p.begin()) == -1) {
270 if (errno != ENOENT || !IgnoreNonExisting)
271 return std::error_code(errno, std::generic_category());
274 return std::error_code();
277 std::error_code rename(const Twine &from, const Twine &to) {
279 SmallString<128> from_storage;
280 SmallString<128> to_storage;
281 StringRef f = from.toNullTerminatedStringRef(from_storage);
282 StringRef t = to.toNullTerminatedStringRef(to_storage);
284 if (::rename(f.begin(), t.begin()) == -1)
285 return std::error_code(errno, std::generic_category());
287 return std::error_code();
290 std::error_code resize_file(int FD, uint64_t Size) {
291 if (::ftruncate(FD, Size) == -1)
292 return std::error_code(errno, std::generic_category());
294 return std::error_code();
297 static int convertAccessMode(AccessMode Mode) {
299 case AccessMode::Exist:
301 case AccessMode::Write:
303 case AccessMode::Execute:
304 return R_OK | X_OK; // scripts also need R_OK.
306 llvm_unreachable("invalid enum");
309 std::error_code access(const Twine &Path, AccessMode Mode) {
310 SmallString<128> PathStorage;
311 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
313 if (::access(P.begin(), convertAccessMode(Mode)) == -1)
314 return std::error_code(errno, std::generic_category());
316 if (Mode == AccessMode::Execute) {
317 // Don't say that directories are executable.
319 if (0 != stat(P.begin(), &buf))
320 return errc::permission_denied;
321 if (!S_ISREG(buf.st_mode))
322 return errc::permission_denied;
325 return std::error_code();
328 bool can_execute(const Twine &Path) {
329 return !access(Path, AccessMode::Execute);
332 bool equivalent(file_status A, file_status B) {
333 assert(status_known(A) && status_known(B));
334 return A.fs_st_dev == B.fs_st_dev &&
335 A.fs_st_ino == B.fs_st_ino;
338 std::error_code equivalent(const Twine &A, const Twine &B, bool &result) {
339 file_status fsA, fsB;
340 if (std::error_code ec = status(A, fsA))
342 if (std::error_code ec = status(B, fsB))
344 result = equivalent(fsA, fsB);
345 return std::error_code();
348 static std::error_code fillStatus(int StatRet, const struct stat &Status,
349 file_status &Result) {
351 std::error_code ec(errno, std::generic_category());
352 if (ec == errc::no_such_file_or_directory)
353 Result = file_status(file_type::file_not_found);
355 Result = file_status(file_type::status_error);
359 file_type Type = file_type::type_unknown;
361 if (S_ISDIR(Status.st_mode))
362 Type = file_type::directory_file;
363 else if (S_ISREG(Status.st_mode))
364 Type = file_type::regular_file;
365 else if (S_ISBLK(Status.st_mode))
366 Type = file_type::block_file;
367 else if (S_ISCHR(Status.st_mode))
368 Type = file_type::character_file;
369 else if (S_ISFIFO(Status.st_mode))
370 Type = file_type::fifo_file;
371 else if (S_ISSOCK(Status.st_mode))
372 Type = file_type::socket_file;
374 perms Perms = static_cast<perms>(Status.st_mode);
376 file_status(Type, Perms, Status.st_dev, Status.st_ino, Status.st_mtime,
377 Status.st_uid, Status.st_gid, Status.st_size);
379 return std::error_code();
382 std::error_code status(const Twine &Path, file_status &Result) {
383 SmallString<128> PathStorage;
384 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
387 int StatRet = ::stat(P.begin(), &Status);
388 return fillStatus(StatRet, Status, Result);
391 std::error_code status(int FD, file_status &Result) {
393 int StatRet = ::fstat(FD, &Status);
394 return fillStatus(StatRet, Status, Result);
397 std::error_code setLastModificationAndAccessTime(int FD, TimeValue Time) {
398 #if defined(HAVE_FUTIMENS)
400 Times[0].tv_sec = Time.toEpochTime();
401 Times[0].tv_nsec = 0;
403 if (::futimens(FD, Times))
404 return std::error_code(errno, std::generic_category());
405 return std::error_code();
406 #elif defined(HAVE_FUTIMES)
408 Times[0].tv_sec = Time.toEpochTime();
409 Times[0].tv_usec = 0;
411 if (::futimes(FD, Times))
412 return std::error_code(errno, std::generic_category());
413 return std::error_code();
415 #warning Missing futimes() and futimens()
416 return make_error_code(errc::function_not_supported);
420 std::error_code mapped_file_region::init(int FD, uint64_t Offset,
424 int flags = (Mode == readwrite) ? MAP_SHARED : MAP_PRIVATE;
425 int prot = (Mode == readonly) ? PROT_READ : (PROT_READ | PROT_WRITE);
426 Mapping = ::mmap(nullptr, Size, prot, flags, FD, Offset);
427 if (Mapping == MAP_FAILED)
428 return std::error_code(errno, std::generic_category());
429 return std::error_code();
432 mapped_file_region::mapped_file_region(int fd, mapmode mode, uint64_t length,
433 uint64_t offset, std::error_code &ec)
434 : Size(length), Mapping() {
435 // Make sure that the requested size fits within SIZE_T.
436 if (length > std::numeric_limits<size_t>::max()) {
437 ec = make_error_code(errc::invalid_argument);
441 ec = init(fd, offset, mode);
446 mapped_file_region::~mapped_file_region() {
448 ::munmap(Mapping, Size);
451 uint64_t mapped_file_region::size() const {
452 assert(Mapping && "Mapping failed but used anyway!");
456 char *mapped_file_region::data() const {
457 assert(Mapping && "Mapping failed but used anyway!");
458 return reinterpret_cast<char*>(Mapping);
461 const char *mapped_file_region::const_data() const {
462 assert(Mapping && "Mapping failed but used anyway!");
463 return reinterpret_cast<const char*>(Mapping);
466 int mapped_file_region::alignment() {
467 return Process::getPageSize();
470 std::error_code detail::directory_iterator_construct(detail::DirIterState &it,
472 SmallString<128> path_null(path);
473 DIR *directory = ::opendir(path_null.c_str());
475 return std::error_code(errno, std::generic_category());
477 it.IterationHandle = reinterpret_cast<intptr_t>(directory);
478 // Add something for replace_filename to replace.
479 path::append(path_null, ".");
480 it.CurrentEntry = directory_entry(path_null.str());
481 return directory_iterator_increment(it);
484 std::error_code detail::directory_iterator_destruct(detail::DirIterState &it) {
485 if (it.IterationHandle)
486 ::closedir(reinterpret_cast<DIR *>(it.IterationHandle));
487 it.IterationHandle = 0;
488 it.CurrentEntry = directory_entry();
489 return std::error_code();
492 std::error_code detail::directory_iterator_increment(detail::DirIterState &it) {
494 dirent *cur_dir = ::readdir(reinterpret_cast<DIR *>(it.IterationHandle));
495 if (cur_dir == nullptr && errno != 0) {
496 return std::error_code(errno, std::generic_category());
497 } else if (cur_dir != nullptr) {
498 StringRef name(cur_dir->d_name, NAMLEN(cur_dir));
499 if ((name.size() == 1 && name[0] == '.') ||
500 (name.size() == 2 && name[0] == '.' && name[1] == '.'))
501 return directory_iterator_increment(it);
502 it.CurrentEntry.replace_filename(name);
504 return directory_iterator_destruct(it);
506 return std::error_code();
509 std::error_code openFileForRead(const Twine &Name, int &ResultFD) {
510 SmallString<128> Storage;
511 StringRef P = Name.toNullTerminatedStringRef(Storage);
512 while ((ResultFD = open(P.begin(), O_RDONLY)) < 0) {
514 return std::error_code(errno, std::generic_category());
516 return std::error_code();
519 std::error_code openFileForWrite(const Twine &Name, int &ResultFD,
520 sys::fs::OpenFlags Flags, unsigned Mode) {
521 // Verify that we don't have both "append" and "excl".
522 assert((!(Flags & sys::fs::F_Excl) || !(Flags & sys::fs::F_Append)) &&
523 "Cannot specify both 'excl' and 'append' file creation flags!");
525 int OpenFlags = O_CREAT;
530 OpenFlags |= O_WRONLY;
532 if (Flags & F_Append)
533 OpenFlags |= O_APPEND;
535 OpenFlags |= O_TRUNC;
540 SmallString<128> Storage;
541 StringRef P = Name.toNullTerminatedStringRef(Storage);
542 while ((ResultFD = open(P.begin(), OpenFlags, Mode)) < 0) {
544 return std::error_code(errno, std::generic_category());
546 return std::error_code();
549 } // end namespace fs
553 bool home_directory(SmallVectorImpl<char> &result) {
554 if (char *RequestedDir = getenv("HOME")) {
556 result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
563 static const char *getEnvTempDir() {
564 // Check whether the temporary directory is specified by an environment
566 const char *EnvironmentVariables[] = {"TMPDIR", "TMP", "TEMP", "TEMPDIR"};
567 for (const char *Env : EnvironmentVariables) {
568 if (const char *Dir = std::getenv(Env))
575 static const char *getDefaultTempDir(bool ErasedOnReboot) {
586 void system_temp_directory(bool ErasedOnReboot, SmallVectorImpl<char> &Result) {
589 if (ErasedOnReboot) {
590 // There is no env variable for the cache directory.
591 if (const char *RequestedDir = getEnvTempDir()) {
592 Result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
597 #if defined(_CS_DARWIN_USER_TEMP_DIR) && defined(_CS_DARWIN_USER_CACHE_DIR)
598 // On Darwin, use DARWIN_USER_TEMP_DIR or DARWIN_USER_CACHE_DIR.
599 // macros defined in <unistd.h> on darwin >= 9
600 int ConfName = ErasedOnReboot? _CS_DARWIN_USER_TEMP_DIR
601 : _CS_DARWIN_USER_CACHE_DIR;
602 size_t ConfLen = confstr(ConfName, nullptr, 0);
605 Result.resize(ConfLen);
606 ConfLen = confstr(ConfName, Result.data(), Result.size());
607 } while (ConfLen > 0 && ConfLen != Result.size());
610 assert(Result.back() == 0);
619 const char *RequestedDir = getDefaultTempDir(ErasedOnReboot);
620 Result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
623 } // end namespace path
625 } // end namespace sys
626 } // end namespace llvm