blob: d1d0c5d2694b3ef9c0386a8f28baf3a074829c1a [file] [log] [blame]
Rafael Espindolaf1fc3822013-06-26 19:33:03 +00001//===- llvm/Support/Unix/Path.inc - Unix Path Implementation ----*- C++ -*-===//
Michael J. Spencerebad2f92010-11-29 22:28:51 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
Rafael Espindolaf1fc3822013-06-26 19:33:03 +000010// This file implements the Unix specific implementation of the Path API.
Michael J. Spencerebad2f92010-11-29 22:28:51 +000011//
12//===----------------------------------------------------------------------===//
13
14//===----------------------------------------------------------------------===//
15//=== WARNING: Implementation here must contain only generic UNIX code that
16//=== is guaranteed to work on *all* UNIX variants.
17//===----------------------------------------------------------------------===//
18
19#include "Unix.h"
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +000020#include <limits.h>
21#include <stdio.h>
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +000022#if HAVE_SYS_STAT_H
23#include <sys/stat.h>
24#endif
25#if HAVE_FCNTL_H
26#include <fcntl.h>
27#endif
Taewook Ohd9153272016-06-13 15:54:56 +000028#ifdef HAVE_UNISTD_H
29#include <unistd.h>
30#endif
Nick Kledzik18497e92012-06-20 00:28:54 +000031#ifdef HAVE_SYS_MMAN_H
32#include <sys/mman.h>
33#endif
Michael J. Spencer52714862011-01-05 16:38:57 +000034#if HAVE_DIRENT_H
35# include <dirent.h>
36# define NAMLEN(dirent) strlen((dirent)->d_name)
37#else
38# define dirent direct
39# define NAMLEN(dirent) (dirent)->d_namlen
40# if HAVE_SYS_NDIR_H
41# include <sys/ndir.h>
42# endif
43# if HAVE_SYS_DIR_H
44# include <sys/dir.h>
45# endif
46# if HAVE_NDIR_H
47# include <ndir.h>
48# endif
49#endif
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +000050
Rafael Espindola4601c462013-06-26 05:25:44 +000051#ifdef __APPLE__
52#include <mach-o/dyld.h>
Taewook Ohd9153272016-06-13 15:54:56 +000053#include <sys/attr.h>
Rafael Espindola4601c462013-06-26 05:25:44 +000054#endif
55
Joerg Sonnenbergerc0697302012-08-10 10:56:09 +000056// 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
58// either.
59#undef ferror
60#undef feof
61
Sylvestre Ledru14ada942012-04-11 15:35:36 +000062// For GNU Hurd
63#if defined(__GNU__) && !defined(PATH_MAX)
64# define PATH_MAX 4096
65#endif
66
Mehdi Aminie2d8f1b2016-04-01 00:18:08 +000067#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
72#else
73#ifdef __OpenBSD__
74#include <sys/param.h>
Mehdi Amini3ba84ca2016-04-08 16:45:05 +000075#include <sys/mount.h>
Mehdi Aminie2d8f1b2016-04-01 00:18:08 +000076#elif defined(__ANDROID__)
77#include <sys/vfs.h>
78#else
79#include <sys/mount.h>
80#endif
81#define STATVFS statfs
82#define STATVFS_F_FRSIZE(vfs) static_cast<uint64_t>(vfs.f_bsize)
83#endif
84
85
Michael J. Spencer45710402010-12-03 01:21:28 +000086using namespace llvm;
87
Michael J. Spencerebad2f92010-11-29 22:28:51 +000088namespace llvm {
89namespace sys {
Michael J. Spencer20daa282010-12-07 01:22:31 +000090namespace fs {
Rafael Espindolae03dfd92013-06-26 05:01:35 +000091#if defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
92 defined(__OpenBSD__) || defined(__minix) || defined(__FreeBSD_kernel__) || \
Chandler Carruth2aff7502016-07-19 22:46:39 +000093 defined(__linux__) || defined(__CYGWIN__) || defined(__DragonFly__) || \
94 defined(_AIX)
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +000095static int
Sylvestre Ledru21e674722013-12-09 16:27:00 +000096test_dir(char ret[PATH_MAX], const char *dir, const char *bin)
Mehdi Aminie2d8f1b2016-04-01 00:18:08 +000097{
Rafael Espindolae03dfd92013-06-26 05:01:35 +000098 struct stat sb;
Sylvestre Ledru21e674722013-12-09 16:27:00 +000099 char fullpath[PATH_MAX];
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000100
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000101 snprintf(fullpath, PATH_MAX, "%s/%s", dir, bin);
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000102 if (!realpath(fullpath, ret))
103 return 1;
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000104 if (stat(fullpath, &sb) != 0)
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000105 return 1;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000106
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000107 return 0;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000108}
109
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000110static char *
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000111getprogpath(char ret[PATH_MAX], const char *bin)
112{
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000113 char *pv, *s, *t;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000114
115 /* First approach: absolute path. */
116 if (bin[0] == '/') {
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000117 if (test_dir(ret, "/", bin) == 0)
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000118 return ret;
119 return nullptr;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000120 }
121
122 /* Second approach: relative path. */
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000123 if (strchr(bin, '/')) {
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000124 char cwd[PATH_MAX];
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000125 if (!getcwd(cwd, PATH_MAX))
126 return nullptr;
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000127 if (test_dir(ret, cwd, bin) == 0)
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000128 return ret;
129 return nullptr;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000130 }
131
132 /* Third approach: $PATH */
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000133 if ((pv = getenv("PATH")) == nullptr)
134 return nullptr;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000135 s = pv = strdup(pv);
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000136 if (!pv)
137 return nullptr;
138 while ((t = strsep(&s, ":")) != nullptr) {
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000139 if (test_dir(ret, t, bin) == 0) {
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000140 free(pv);
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000141 return ret;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000142 }
143 }
144 free(pv);
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000145 return nullptr;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000146}
147#endif // __FreeBSD__ || __NetBSD__ || __FreeBSD_kernel__
148
149/// GetMainExecutable - Return the path to the main executable, given the
150/// value of argv[0] from program startup.
151std::string getMainExecutable(const char *argv0, void *MainAddr) {
152#if defined(__APPLE__)
153 // On OS X the executable path is saved to the stack by dyld. Reading it
154 // from there is much faster than calling dladdr, especially for large
155 // binaries with symbols.
156 char exe_path[MAXPATHLEN];
157 uint32_t size = sizeof(exe_path);
158 if (_NSGetExecutablePath(exe_path, &size) == 0) {
159 char link_path[MAXPATHLEN];
160 if (realpath(exe_path, link_path))
Rafael Espindola4601c462013-06-26 05:25:44 +0000161 return link_path;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000162 }
163#elif defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
Rafael Espindolaaca97392013-10-31 14:35:00 +0000164 defined(__OpenBSD__) || defined(__minix) || defined(__DragonFly__) || \
Chandler Carruth2aff7502016-07-19 22:46:39 +0000165 defined(__FreeBSD_kernel__) || defined(_AIX)
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000166 char exe_path[PATH_MAX];
167
168 if (getprogpath(exe_path, argv0) != NULL)
Rafael Espindola2c6f4fe2013-06-26 06:10:32 +0000169 return exe_path;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000170#elif defined(__linux__) || defined(__CYGWIN__)
171 char exe_path[MAXPATHLEN];
172 StringRef aPath("/proc/self/exe");
173 if (sys::fs::exists(aPath)) {
174 // /proc is not always mounted under Linux (chroot for example).
175 ssize_t len = readlink(aPath.str().c_str(), exe_path, sizeof(exe_path));
176 if (len >= 0)
Alexey Samsonov4c798452014-12-29 20:59:02 +0000177 return std::string(exe_path, len);
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000178 } else {
179 // Fall back to the classical detection.
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000180 if (getprogpath(exe_path, argv0))
181 return exe_path;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000182 }
183#elif defined(HAVE_DLFCN_H)
184 // Use dladdr to get executable path if available.
185 Dl_info DLInfo;
186 int err = dladdr(MainAddr, &DLInfo);
187 if (err == 0)
Rafael Espindola2c6f4fe2013-06-26 06:10:32 +0000188 return "";
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000189
190 // If the filename is a symlink, we need to resolve and return the location of
191 // the actual executable.
192 char link_path[MAXPATHLEN];
193 if (realpath(DLInfo.dli_fname, link_path))
Rafael Espindola2c6f4fe2013-06-26 06:10:32 +0000194 return link_path;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000195#else
196#error GetMainExecutable is not implemented on this host yet.
197#endif
198 return "";
199}
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000200
Pavel Labath757ca882016-10-24 10:59:17 +0000201TimePoint<> file_status::getLastAccessedTime() const {
202 return toTimePoint(fs_st_atime);
Mehdi Amini1e39ef32016-03-25 07:30:21 +0000203}
204
Pavel Labath757ca882016-10-24 10:59:17 +0000205TimePoint<> file_status::getLastModificationTime() const {
206 return toTimePoint(fs_st_mtime);
Rafael Espindoladb5d8fe2013-06-20 18:42:04 +0000207}
208
Rafael Espindolad1230992013-07-29 21:55:38 +0000209UniqueID file_status::getUniqueID() const {
Rafael Espindola7f822a92013-07-29 21:26:49 +0000210 return UniqueID(fs_st_dev, fs_st_ino);
211}
212
Mehdi Aminie2d8f1b2016-04-01 00:18:08 +0000213ErrorOr<space_info> disk_space(const Twine &Path) {
214 struct STATVFS Vfs;
215 if (::STATVFS(Path.str().c_str(), &Vfs))
216 return std::error_code(errno, std::generic_category());
217 auto FrSize = STATVFS_F_FRSIZE(Vfs);
218 space_info SpaceInfo;
219 SpaceInfo.capacity = static_cast<uint64_t>(Vfs.f_blocks) * FrSize;
220 SpaceInfo.free = static_cast<uint64_t>(Vfs.f_bfree) * FrSize;
221 SpaceInfo.available = static_cast<uint64_t>(Vfs.f_bavail) * FrSize;
222 return SpaceInfo;
223}
224
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000225std::error_code current_path(SmallVectorImpl<char> &result) {
Rafael Espindola6ee16382013-08-10 00:50:57 +0000226 result.clear();
227
228 const char *pwd = ::getenv("PWD");
229 llvm::sys::fs::file_status PWDStatus, DotStatus;
230 if (pwd && llvm::sys::path::is_absolute(pwd) &&
231 !llvm::sys::fs::status(pwd, PWDStatus) &&
232 !llvm::sys::fs::status(".", DotStatus) &&
233 PWDStatus.getUniqueID() == DotStatus.getUniqueID()) {
234 result.append(pwd, pwd + strlen(pwd));
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000235 return std::error_code();
Rafael Espindola6ee16382013-08-10 00:50:57 +0000236 }
237
Sylvestre Ledru14ada942012-04-11 15:35:36 +0000238#ifdef MAXPATHLEN
Andrew Tricka4ec5b22011-03-24 16:43:37 +0000239 result.reserve(MAXPATHLEN);
Sylvestre Ledru14ada942012-04-11 15:35:36 +0000240#else
241// For GNU Hurd
242 result.reserve(1024);
243#endif
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000244
Michael J. Spencer20daa282010-12-07 01:22:31 +0000245 while (true) {
Craig Toppere73658d2014-04-28 04:05:08 +0000246 if (::getcwd(result.data(), result.capacity()) == nullptr) {
Michael J. Spencer20daa282010-12-07 01:22:31 +0000247 // See if there was a real error.
Rafael Espindola882ce87b2014-05-31 02:29:28 +0000248 if (errno != ENOMEM)
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000249 return std::error_code(errno, std::generic_category());
Michael J. Spencer20daa282010-12-07 01:22:31 +0000250 // Otherwise there just wasn't enough space.
251 result.reserve(result.capacity() * 2);
252 } else
253 break;
254 }
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000255
256 result.set_size(strlen(result.data()));
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000257 return std::error_code();
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000258}
259
Frederic Riss6b9396c2015-08-06 21:04:55 +0000260std::error_code create_directory(const Twine &path, bool IgnoreExisting,
261 perms Perms) {
Michael J. Spencer31e310c2010-12-03 05:42:11 +0000262 SmallString<128> path_storage;
263 StringRef p = path.toNullTerminatedStringRef(path_storage);
264
Frederic Riss6b9396c2015-08-06 21:04:55 +0000265 if (::mkdir(p.begin(), Perms) == -1) {
Rafael Espindola882ce87b2014-05-31 02:29:28 +0000266 if (errno != EEXIST || !IgnoreExisting)
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000267 return std::error_code(errno, std::generic_category());
Rafael Espindola5c20ac02014-02-23 13:56:14 +0000268 }
Michael J. Spencer31e310c2010-12-03 05:42:11 +0000269
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000270 return std::error_code();
Michael J. Spencer31e310c2010-12-03 05:42:11 +0000271}
272
Rafael Espindola83f858e2014-03-11 18:40:24 +0000273// Note that we are using symbolic link because hard links are not supported by
274// all filesystems (SMB doesn't).
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000275std::error_code create_link(const Twine &to, const Twine &from) {
Michael J. Spencere0c45602010-12-03 05:58:41 +0000276 // Get arguments.
277 SmallString<128> from_storage;
278 SmallString<128> to_storage;
279 StringRef f = from.toNullTerminatedStringRef(from_storage);
280 StringRef t = to.toNullTerminatedStringRef(to_storage);
281
Rafael Espindola83f858e2014-03-11 18:40:24 +0000282 if (::symlink(t.begin(), f.begin()) == -1)
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000283 return std::error_code(errno, std::generic_category());
Michael J. Spencere0c45602010-12-03 05:58:41 +0000284
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000285 return std::error_code();
Michael J. Spencere0c45602010-12-03 05:58:41 +0000286}
287
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000288std::error_code remove(const Twine &path, bool IgnoreNonExisting) {
Michael J. Spencer6e74e112010-12-03 17:53:43 +0000289 SmallString<128> path_storage;
290 StringRef p = path.toNullTerminatedStringRef(path_storage);
291
Rafael Espindola8cd62b02013-06-17 20:35:51 +0000292 struct stat buf;
Argyrios Kyrtzidis37575692014-03-21 01:25:37 +0000293 if (lstat(p.begin(), &buf) != 0) {
Rafael Espindola882ce87b2014-05-31 02:29:28 +0000294 if (errno != ENOENT || !IgnoreNonExisting)
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000295 return std::error_code(errno, std::generic_category());
296 return std::error_code();
Rafael Espindola8cd62b02013-06-17 20:35:51 +0000297 }
298
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.
Argyrios Kyrtzidis37575692014-03-21 01:25:37 +0000304 if (!S_ISREG(buf.st_mode) && !S_ISDIR(buf.st_mode) && !S_ISLNK(buf.st_mode))
Rafael Espindola2a826e42014-06-13 17:20:48 +0000305 return make_error_code(errc::operation_not_permitted);
Rafael Espindola8cd62b02013-06-17 20:35:51 +0000306
Michael J. Spencer6e74e112010-12-03 17:53:43 +0000307 if (::remove(p.begin()) == -1) {
Rafael Espindola882ce87b2014-05-31 02:29:28 +0000308 if (errno != ENOENT || !IgnoreNonExisting)
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000309 return std::error_code(errno, std::generic_category());
Rafael Espindola5c20ac02014-02-23 13:56:14 +0000310 }
Michael J. Spencer6e74e112010-12-03 17:53:43 +0000311
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000312 return std::error_code();
Michael J. Spencer6e74e112010-12-03 17:53:43 +0000313}
314
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000315std::error_code rename(const Twine &from, const Twine &to) {
Michael J. Spencer409f5562010-12-03 17:53:55 +0000316 // Get arguments.
317 SmallString<128> from_storage;
318 SmallString<128> to_storage;
319 StringRef f = from.toNullTerminatedStringRef(from_storage);
320 StringRef t = to.toNullTerminatedStringRef(to_storage);
321
Rafael Espindolab6fea4c2013-07-17 03:33:41 +0000322 if (::rename(f.begin(), t.begin()) == -1)
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000323 return std::error_code(errno, std::generic_category());
Michael J. Spencer409f5562010-12-03 17:53:55 +0000324
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000325 return std::error_code();
Michael J. Spencer409f5562010-12-03 17:53:55 +0000326}
327
Rafael Espindola59aaa6c2014-12-12 17:55:12 +0000328std::error_code resize_file(int FD, uint64_t Size) {
Rafael Espindola3816c532016-07-19 20:19:56 +0000329#if defined(HAVE_POSIX_FALLOCATE)
330 // If we have posix_fallocate use it. Unlike ftruncate it always allocates
331 // space, so we get an error if the disk is full.
332 if (int Err = ::posix_fallocate(FD, 0, Size))
333 return std::error_code(Err, std::generic_category());
334#else
335 // Use ftruncate as a fallback. It may or may not allocate space. At least on
336 // OS X with HFS+ it does.
Rafael Espindola59aaa6c2014-12-12 17:55:12 +0000337 if (::ftruncate(FD, Size) == -1)
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000338 return std::error_code(errno, std::generic_category());
Rafael Espindola3816c532016-07-19 20:19:56 +0000339#endif
Michael J. Spencerc20a0322010-12-03 17:54:07 +0000340
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000341 return std::error_code();
Michael J. Spencerc20a0322010-12-03 17:54:07 +0000342}
343
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000344static int convertAccessMode(AccessMode Mode) {
Rafael Espindola281f23a2014-09-11 20:30:02 +0000345 switch (Mode) {
346 case AccessMode::Exist:
347 return F_OK;
348 case AccessMode::Write:
349 return W_OK;
350 case AccessMode::Execute:
351 return R_OK | X_OK; // scripts also need R_OK.
352 }
353 llvm_unreachable("invalid enum");
354}
Michael J. Spencer45710402010-12-03 01:21:28 +0000355
Rafael Espindola281f23a2014-09-11 20:30:02 +0000356std::error_code access(const Twine &Path, AccessMode Mode) {
357 SmallString<128> PathStorage;
358 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
359
360 if (::access(P.begin(), convertAccessMode(Mode)) == -1)
361 return std::error_code(errno, std::generic_category());
362
363 if (Mode == AccessMode::Execute) {
364 // Don't say that directories are executable.
365 struct stat buf;
366 if (0 != stat(P.begin(), &buf))
367 return errc::permission_denied;
368 if (!S_ISREG(buf.st_mode))
369 return errc::permission_denied;
370 }
Michael J. Spencer45710402010-12-03 01:21:28 +0000371
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000372 return std::error_code();
Michael J. Spencer45710402010-12-03 01:21:28 +0000373}
374
Reid Kleckner89d4b1a2015-09-10 23:28:06 +0000375bool can_execute(const Twine &Path) {
376 return !access(Path, AccessMode::Execute);
377}
378
Michael J. Spencer203d7802011-12-12 06:04:28 +0000379bool equivalent(file_status A, file_status B) {
380 assert(status_known(A) && status_known(B));
Sylvestre Ledru3099f4bd2012-04-23 16:37:23 +0000381 return A.fs_st_dev == B.fs_st_dev &&
382 A.fs_st_ino == B.fs_st_ino;
Michael J. Spencer203d7802011-12-12 06:04:28 +0000383}
384
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000385std::error_code equivalent(const Twine &A, const Twine &B, bool &result) {
Michael J. Spencer203d7802011-12-12 06:04:28 +0000386 file_status fsA, fsB;
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000387 if (std::error_code ec = status(A, fsA))
388 return ec;
389 if (std::error_code ec = status(B, fsB))
390 return ec;
Michael J. Spencer203d7802011-12-12 06:04:28 +0000391 result = equivalent(fsA, fsB);
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000392 return std::error_code();
Michael J. Spencer376d3872010-12-03 18:49:13 +0000393}
394
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000395static std::error_code fillStatus(int StatRet, const struct stat &Status,
396 file_status &Result) {
Rafael Espindola77021c92013-07-16 03:20:13 +0000397 if (StatRet != 0) {
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000398 std::error_code ec(errno, std::generic_category());
Rafael Espindola2a826e42014-06-13 17:20:48 +0000399 if (ec == errc::no_such_file_or_directory)
Rafael Espindola77021c92013-07-16 03:20:13 +0000400 Result = file_status(file_type::file_not_found);
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000401 else
Rafael Espindola77021c92013-07-16 03:20:13 +0000402 Result = file_status(file_type::status_error);
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000403 return ec;
404 }
405
Rafael Espindola9da91a02013-07-16 02:55:33 +0000406 file_type Type = file_type::type_unknown;
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000407
Rafael Espindola77021c92013-07-16 03:20:13 +0000408 if (S_ISDIR(Status.st_mode))
Rafael Espindola9da91a02013-07-16 02:55:33 +0000409 Type = file_type::directory_file;
Rafael Espindola77021c92013-07-16 03:20:13 +0000410 else if (S_ISREG(Status.st_mode))
Rafael Espindola9da91a02013-07-16 02:55:33 +0000411 Type = file_type::regular_file;
Rafael Espindola77021c92013-07-16 03:20:13 +0000412 else if (S_ISBLK(Status.st_mode))
Rafael Espindola9da91a02013-07-16 02:55:33 +0000413 Type = file_type::block_file;
Rafael Espindola77021c92013-07-16 03:20:13 +0000414 else if (S_ISCHR(Status.st_mode))
Rafael Espindola9da91a02013-07-16 02:55:33 +0000415 Type = file_type::character_file;
Rafael Espindola77021c92013-07-16 03:20:13 +0000416 else if (S_ISFIFO(Status.st_mode))
Rafael Espindola9da91a02013-07-16 02:55:33 +0000417 Type = file_type::fifo_file;
Rafael Espindola77021c92013-07-16 03:20:13 +0000418 else if (S_ISSOCK(Status.st_mode))
Rafael Espindola9da91a02013-07-16 02:55:33 +0000419 Type = file_type::socket_file;
420
Rafael Espindola77021c92013-07-16 03:20:13 +0000421 perms Perms = static_cast<perms>(Status.st_mode);
422 Result =
Mehdi Amini1e39ef32016-03-25 07:30:21 +0000423 file_status(Type, Perms, Status.st_dev, Status.st_ino, Status.st_atime,
424 Status.st_mtime, Status.st_uid, Status.st_gid,
425 Status.st_size);
Michael J. Spencer203d7802011-12-12 06:04:28 +0000426
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000427 return std::error_code();
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000428}
429
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000430std::error_code status(const Twine &Path, file_status &Result) {
Rafael Espindola77021c92013-07-16 03:20:13 +0000431 SmallString<128> PathStorage;
432 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
433
434 struct stat Status;
435 int StatRet = ::stat(P.begin(), &Status);
436 return fillStatus(StatRet, Status, Result);
437}
438
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000439std::error_code status(int FD, file_status &Result) {
Rafael Espindola77021c92013-07-16 03:20:13 +0000440 struct stat Status;
441 int StatRet = ::fstat(FD, &Status);
442 return fillStatus(StatRet, Status, Result);
443}
444
Pavel Labath757ca882016-10-24 10:59:17 +0000445std::error_code setLastModificationAndAccessTime(int FD, TimePoint<> Time) {
Eric Christophera24dc7f2013-07-04 01:10:38 +0000446#if defined(HAVE_FUTIMENS)
447 timespec Times[2];
Pavel Labath757ca882016-10-24 10:59:17 +0000448 Times[0] = Times[1] = sys::toTimeSpec(Time);
Eric Christophera24dc7f2013-07-04 01:10:38 +0000449 if (::futimens(FD, Times))
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000450 return std::error_code(errno, std::generic_category());
451 return std::error_code();
Eric Christophera24dc7f2013-07-04 01:10:38 +0000452#elif defined(HAVE_FUTIMES)
Rafael Espindola4a3365c2013-06-20 20:56:14 +0000453 timeval Times[2];
Pavel Labath757ca882016-10-24 10:59:17 +0000454 Times[0] = Times[1] = sys::toTimeVal(Time);
Rafael Espindola4a3365c2013-06-20 20:56:14 +0000455 if (::futimes(FD, Times))
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000456 return std::error_code(errno, std::generic_category());
457 return std::error_code();
Alp Tokerb30f01e2013-12-11 15:42:33 +0000458#else
459#warning Missing futimes() and futimens()
Alp Tokerb792a012014-06-30 18:57:04 +0000460 return make_error_code(errc::function_not_supported);
Alp Tokerb30f01e2013-12-11 15:42:33 +0000461#endif
Rafael Espindola4a3365c2013-06-20 20:56:14 +0000462}
463
Rafael Espindola7eb1f182014-12-11 20:12:55 +0000464std::error_code mapped_file_region::init(int FD, uint64_t Offset,
465 mapmode Mode) {
Rafael Espindolac69f13b2014-12-12 18:13:23 +0000466 assert(Size != 0);
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000467
468 int flags = (Mode == readwrite) ? MAP_SHARED : MAP_PRIVATE;
469 int prot = (Mode == readonly) ? PROT_READ : (PROT_READ | PROT_WRITE);
Craig Toppere73658d2014-04-28 04:05:08 +0000470 Mapping = ::mmap(nullptr, Size, prot, flags, FD, Offset);
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000471 if (Mapping == MAP_FAILED)
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000472 return std::error_code(errno, std::generic_category());
473 return std::error_code();
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000474}
475
Rafael Espindola7eb1f182014-12-11 20:12:55 +0000476mapped_file_region::mapped_file_region(int fd, mapmode mode, uint64_t length,
477 uint64_t offset, std::error_code &ec)
478 : Size(length), Mapping() {
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000479 // Make sure that the requested size fits within SIZE_T.
480 if (length > std::numeric_limits<size_t>::max()) {
Rafael Espindola2a826e42014-06-13 17:20:48 +0000481 ec = make_error_code(errc::invalid_argument);
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000482 return;
483 }
484
Rafael Espindola7eb1f182014-12-11 20:12:55 +0000485 ec = init(fd, offset, mode);
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000486 if (ec)
Craig Toppere73658d2014-04-28 04:05:08 +0000487 Mapping = nullptr;
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000488}
489
490mapped_file_region::~mapped_file_region() {
491 if (Mapping)
492 ::munmap(Mapping, Size);
493}
494
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000495uint64_t mapped_file_region::size() const {
496 assert(Mapping && "Mapping failed but used anyway!");
497 return Size;
498}
499
500char *mapped_file_region::data() const {
501 assert(Mapping && "Mapping failed but used anyway!");
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000502 return reinterpret_cast<char*>(Mapping);
503}
504
505const char *mapped_file_region::const_data() const {
506 assert(Mapping && "Mapping failed but used anyway!");
507 return reinterpret_cast<const char*>(Mapping);
508}
509
510int mapped_file_region::alignment() {
Rafael Espindolac0610bf2014-12-04 16:59:36 +0000511 return Process::getPageSize();
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000512}
513
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000514std::error_code detail::directory_iterator_construct(detail::DirIterState &it,
Michael J. Spencer0a7625d2011-12-08 22:50:09 +0000515 StringRef path){
Michael J. Spencer52714862011-01-05 16:38:57 +0000516 SmallString<128> path_null(path);
517 DIR *directory = ::opendir(path_null.c_str());
Craig Toppere73658d2014-04-28 04:05:08 +0000518 if (!directory)
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000519 return std::error_code(errno, std::generic_category());
Michael J. Spencer52714862011-01-05 16:38:57 +0000520
521 it.IterationHandle = reinterpret_cast<intptr_t>(directory);
522 // Add something for replace_filename to replace.
523 path::append(path_null, ".");
524 it.CurrentEntry = directory_entry(path_null.str());
525 return directory_iterator_increment(it);
526}
527
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000528std::error_code detail::directory_iterator_destruct(detail::DirIterState &it) {
Michael J. Spencer52714862011-01-05 16:38:57 +0000529 if (it.IterationHandle)
530 ::closedir(reinterpret_cast<DIR *>(it.IterationHandle));
531 it.IterationHandle = 0;
532 it.CurrentEntry = directory_entry();
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000533 return std::error_code();
Michael J. Spencer52714862011-01-05 16:38:57 +0000534}
535
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000536std::error_code detail::directory_iterator_increment(detail::DirIterState &it) {
Michael J. Spencer52714862011-01-05 16:38:57 +0000537 errno = 0;
538 dirent *cur_dir = ::readdir(reinterpret_cast<DIR *>(it.IterationHandle));
Craig Toppere73658d2014-04-28 04:05:08 +0000539 if (cur_dir == nullptr && errno != 0) {
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000540 return std::error_code(errno, std::generic_category());
Craig Toppere73658d2014-04-28 04:05:08 +0000541 } else if (cur_dir != nullptr) {
Michael J. Spencer52714862011-01-05 16:38:57 +0000542 StringRef name(cur_dir->d_name, NAMLEN(cur_dir));
543 if ((name.size() == 1 && name[0] == '.') ||
544 (name.size() == 2 && name[0] == '.' && name[1] == '.'))
545 return directory_iterator_increment(it);
546 it.CurrentEntry.replace_filename(name);
547 } else
548 return directory_iterator_destruct(it);
549
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000550 return std::error_code();
Michael J. Spencer52714862011-01-05 16:38:57 +0000551}
552
Taewook Ohd9153272016-06-13 15:54:56 +0000553#if !defined(F_GETPATH)
554static bool hasProcSelfFD() {
555 // If we have a /proc filesystem mounted, we can quickly establish the
556 // real name of the file with readlink
557 static const bool Result = (::access("/proc/self/fd", R_OK) == 0);
558 return Result;
559}
560#endif
561
562std::error_code openFileForRead(const Twine &Name, int &ResultFD,
563 SmallVectorImpl<char> *RealPath) {
Rafael Espindolaa0d9b6b2013-07-17 14:58:25 +0000564 SmallString<128> Storage;
565 StringRef P = Name.toNullTerminatedStringRef(Storage);
566 while ((ResultFD = open(P.begin(), O_RDONLY)) < 0) {
567 if (errno != EINTR)
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000568 return std::error_code(errno, std::generic_category());
Rafael Espindolaa0d9b6b2013-07-17 14:58:25 +0000569 }
Taewook Ohd9153272016-06-13 15:54:56 +0000570 // Attempt to get the real name of the file, if the user asked
571 if(!RealPath)
572 return std::error_code();
573 RealPath->clear();
574#if defined(F_GETPATH)
575 // When F_GETPATH is availble, it is the quickest way to get
576 // the real path name.
577 char Buffer[MAXPATHLEN];
578 if (::fcntl(ResultFD, F_GETPATH, Buffer) != -1)
579 RealPath->append(Buffer, Buffer + strlen(Buffer));
580#else
581 char Buffer[PATH_MAX];
582 if (hasProcSelfFD()) {
583 char ProcPath[64];
584 snprintf(ProcPath, sizeof(ProcPath), "/proc/self/fd/%d", ResultFD);
585 ssize_t CharCount = ::readlink(ProcPath, Buffer, sizeof(Buffer));
586 if (CharCount > 0)
587 RealPath->append(Buffer, Buffer + CharCount);
588 } else {
589 // Use ::realpath to get the real path name
590 if (::realpath(P.begin(), Buffer) != nullptr)
591 RealPath->append(Buffer, Buffer + strlen(Buffer));
592 }
593#endif
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000594 return std::error_code();
Rafael Espindolaa0d9b6b2013-07-17 14:58:25 +0000595}
Nick Kledzik18497e92012-06-20 00:28:54 +0000596
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000597std::error_code openFileForWrite(const Twine &Name, int &ResultFD,
Rafael Espindola67080ce2013-07-19 15:02:03 +0000598 sys::fs::OpenFlags Flags, unsigned Mode) {
599 // Verify that we don't have both "append" and "excl".
600 assert((!(Flags & sys::fs::F_Excl) || !(Flags & sys::fs::F_Append)) &&
601 "Cannot specify both 'excl' and 'append' file creation flags!");
602
Rafael Espindola7a0b6402014-02-24 03:07:41 +0000603 int OpenFlags = O_CREAT;
604
605 if (Flags & F_RW)
606 OpenFlags |= O_RDWR;
607 else
608 OpenFlags |= O_WRONLY;
Rafael Espindola67080ce2013-07-19 15:02:03 +0000609
610 if (Flags & F_Append)
611 OpenFlags |= O_APPEND;
612 else
613 OpenFlags |= O_TRUNC;
614
615 if (Flags & F_Excl)
616 OpenFlags |= O_EXCL;
617
618 SmallString<128> Storage;
619 StringRef P = Name.toNullTerminatedStringRef(Storage);
620 while ((ResultFD = open(P.begin(), OpenFlags, Mode)) < 0) {
621 if (errno != EINTR)
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000622 return std::error_code(errno, std::generic_category());
Rafael Espindola67080ce2013-07-19 15:02:03 +0000623 }
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000624 return std::error_code();
Rafael Espindola67080ce2013-07-19 15:02:03 +0000625}
626
Taewook Ohd9153272016-06-13 15:54:56 +0000627std::error_code getPathFromOpenFD(int FD, SmallVectorImpl<char> &ResultPath) {
628 if (FD < 0)
629 return make_error_code(errc::bad_file_descriptor);
630
631#if defined(F_GETPATH)
632 // When F_GETPATH is availble, it is the quickest way to get
633 // the path from a file descriptor.
634 ResultPath.reserve(MAXPATHLEN);
635 if (::fcntl(FD, F_GETPATH, ResultPath.begin()) == -1)
636 return std::error_code(errno, std::generic_category());
637
638 ResultPath.set_size(strlen(ResultPath.begin()));
639#else
640 // If we have a /proc filesystem mounted, we can quickly establish the
641 // real name of the file with readlink. Otherwise, we don't know how to
642 // get the filename from a file descriptor. Give up.
643 if (!fs::hasProcSelfFD())
644 return make_error_code(errc::function_not_supported);
645
646 ResultPath.reserve(PATH_MAX);
647 char ProcPath[64];
648 snprintf(ProcPath, sizeof(ProcPath), "/proc/self/fd/%d", FD);
649 ssize_t CharCount = ::readlink(ProcPath, ResultPath.begin(), ResultPath.capacity());
650 if (CharCount < 0)
651 return std::error_code(errno, std::generic_category());
652
653 // Was the filename truncated?
654 if (static_cast<size_t>(CharCount) == ResultPath.capacity()) {
655 // Use lstat to get the size of the filename
656 struct stat sb;
657 if (::lstat(ProcPath, &sb) < 0)
658 return std::error_code(errno, std::generic_category());
659
660 ResultPath.reserve(sb.st_size + 1);
661 CharCount = ::readlink(ProcPath, ResultPath.begin(), ResultPath.capacity());
662 if (CharCount < 0)
663 return std::error_code(errno, std::generic_category());
664
665 // Test for race condition: did the link size change?
666 if (CharCount > sb.st_size)
667 return std::error_code(ENAMETOOLONG, std::generic_category());
668 }
669 ResultPath.set_size(static_cast<size_t>(CharCount));
670#endif
671 return std::error_code();
672}
673
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +0000674} // end namespace fs
Peter Collingbournef7d41012014-01-31 23:46:06 +0000675
676namespace path {
677
678bool home_directory(SmallVectorImpl<char> &result) {
679 if (char *RequestedDir = getenv("HOME")) {
680 result.clear();
681 result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
682 return true;
683 }
684
685 return false;
686}
687
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000688static bool getDarwinConfDir(bool TempDir, SmallVectorImpl<char> &Result) {
Pawel Bylica0e97e5c2015-11-02 09:49:17 +0000689 #if defined(_CS_DARWIN_USER_TEMP_DIR) && defined(_CS_DARWIN_USER_CACHE_DIR)
690 // On Darwin, use DARWIN_USER_TEMP_DIR or DARWIN_USER_CACHE_DIR.
691 // macros defined in <unistd.h> on darwin >= 9
692 int ConfName = TempDir ? _CS_DARWIN_USER_TEMP_DIR
693 : _CS_DARWIN_USER_CACHE_DIR;
694 size_t ConfLen = confstr(ConfName, nullptr, 0);
695 if (ConfLen > 0) {
696 do {
697 Result.resize(ConfLen);
698 ConfLen = confstr(ConfName, Result.data(), Result.size());
699 } while (ConfLen > 0 && ConfLen != Result.size());
700
701 if (ConfLen > 0) {
702 assert(Result.back() == 0);
703 Result.pop_back();
704 return true;
705 }
706
707 Result.clear();
708 }
709 #endif
710 return false;
711}
712
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000713static bool getUserCacheDir(SmallVectorImpl<char> &Result) {
Sean Silvaa915a162016-03-24 22:27:27 +0000714 // First try using XDG_CACHE_HOME env variable,
Pawel Bylica0e97e5c2015-11-02 09:49:17 +0000715 // as specified in XDG Base Directory Specification at
716 // http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
Sean Silvaa915a162016-03-24 22:27:27 +0000717 if (const char *XdgCacheDir = std::getenv("XDG_CACHE_HOME")) {
Pawel Bylica0e97e5c2015-11-02 09:49:17 +0000718 Result.clear();
Sean Silvaa915a162016-03-24 22:27:27 +0000719 Result.append(XdgCacheDir, XdgCacheDir + strlen(XdgCacheDir));
Pawel Bylica0e97e5c2015-11-02 09:49:17 +0000720 return true;
721 }
722
723 // Try Darwin configuration query
724 if (getDarwinConfDir(false, Result))
725 return true;
726
727 // Use "$HOME/.cache" if $HOME is available
728 if (home_directory(Result)) {
729 append(Result, ".cache");
730 return true;
731 }
732
733 return false;
734}
Pawel Bylica0e97e5c2015-11-02 09:49:17 +0000735
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000736static const char *getEnvTempDir() {
Rafael Espindola016a6d52014-08-26 14:47:52 +0000737 // Check whether the temporary directory is specified by an environment
738 // variable.
739 const char *EnvironmentVariables[] = {"TMPDIR", "TMP", "TEMP", "TEMPDIR"};
740 for (const char *Env : EnvironmentVariables) {
741 if (const char *Dir = std::getenv(Env))
742 return Dir;
743 }
744
745 return nullptr;
746}
747
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000748static const char *getDefaultTempDir(bool ErasedOnReboot) {
Rafael Espindola016a6d52014-08-26 14:47:52 +0000749#ifdef P_tmpdir
Benjamin Kramer870d9512014-08-27 11:47:52 +0000750 if ((bool)P_tmpdir)
Rafael Espindola016a6d52014-08-26 14:47:52 +0000751 return P_tmpdir;
752#endif
753
754 if (ErasedOnReboot)
755 return "/tmp";
756 return "/var/tmp";
757}
758
759void system_temp_directory(bool ErasedOnReboot, SmallVectorImpl<char> &Result) {
760 Result.clear();
761
762 if (ErasedOnReboot) {
763 // There is no env variable for the cache directory.
764 if (const char *RequestedDir = getEnvTempDir()) {
765 Result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
766 return;
767 }
768 }
769
Pawel Bylica0e97e5c2015-11-02 09:49:17 +0000770 if (getDarwinConfDir(ErasedOnReboot, Result))
771 return;
Rafael Espindola016a6d52014-08-26 14:47:52 +0000772
773 const char *RequestedDir = getDefaultTempDir(ErasedOnReboot);
774 Result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
775}
776
Peter Collingbournef7d41012014-01-31 23:46:06 +0000777} // end namespace path
778
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000779} // end namespace sys
780} // end namespace llvm