blob: 84aafcb70d73a933d2db30a010314a6771f2c1e7 [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__) || \
Rafael Espindolaaca97392013-10-31 14:35:00 +000093 defined(__linux__) || defined(__CYGWIN__) || defined(__DragonFly__)
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +000094static int
Sylvestre Ledru21e674722013-12-09 16:27:00 +000095test_dir(char ret[PATH_MAX], const char *dir, const char *bin)
Mehdi Aminie2d8f1b2016-04-01 00:18:08 +000096{
Rafael Espindolae03dfd92013-06-26 05:01:35 +000097 struct stat sb;
Sylvestre Ledru21e674722013-12-09 16:27:00 +000098 char fullpath[PATH_MAX];
Rafael Espindolae03dfd92013-06-26 05:01:35 +000099
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000100 snprintf(fullpath, PATH_MAX, "%s/%s", dir, bin);
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000101 if (!realpath(fullpath, ret))
102 return 1;
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000103 if (stat(fullpath, &sb) != 0)
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000104 return 1;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000105
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000106 return 0;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000107}
108
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000109static char *
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000110getprogpath(char ret[PATH_MAX], const char *bin)
111{
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000112 char *pv, *s, *t;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000113
114 /* First approach: absolute path. */
115 if (bin[0] == '/') {
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000116 if (test_dir(ret, "/", bin) == 0)
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000117 return ret;
118 return nullptr;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000119 }
120
121 /* Second approach: relative path. */
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000122 if (strchr(bin, '/')) {
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000123 char cwd[PATH_MAX];
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000124 if (!getcwd(cwd, PATH_MAX))
125 return nullptr;
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000126 if (test_dir(ret, cwd, bin) == 0)
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000127 return ret;
128 return nullptr;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000129 }
130
131 /* Third approach: $PATH */
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000132 if ((pv = getenv("PATH")) == nullptr)
133 return nullptr;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000134 s = pv = strdup(pv);
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000135 if (!pv)
136 return nullptr;
137 while ((t = strsep(&s, ":")) != nullptr) {
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000138 if (test_dir(ret, t, bin) == 0) {
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000139 free(pv);
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000140 return ret;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000141 }
142 }
143 free(pv);
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000144 return nullptr;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000145}
146#endif // __FreeBSD__ || __NetBSD__ || __FreeBSD_kernel__
147
148/// GetMainExecutable - Return the path to the main executable, given the
149/// value of argv[0] from program startup.
150std::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))
Rafael Espindola4601c462013-06-26 05:25:44 +0000160 return link_path;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000161 }
162#elif defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
Rafael Espindolaaca97392013-10-31 14:35:00 +0000163 defined(__OpenBSD__) || defined(__minix) || defined(__DragonFly__) || \
164 defined(__FreeBSD_kernel__)
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000165 char exe_path[PATH_MAX];
166
167 if (getprogpath(exe_path, argv0) != NULL)
Rafael Espindola2c6f4fe2013-06-26 06:10:32 +0000168 return exe_path;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000169#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));
175 if (len >= 0)
Alexey Samsonov4c798452014-12-29 20:59:02 +0000176 return std::string(exe_path, len);
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000177 } else {
178 // Fall back to the classical detection.
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000179 if (getprogpath(exe_path, argv0))
180 return exe_path;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000181 }
182#elif defined(HAVE_DLFCN_H)
183 // Use dladdr to get executable path if available.
184 Dl_info DLInfo;
185 int err = dladdr(MainAddr, &DLInfo);
186 if (err == 0)
Rafael Espindola2c6f4fe2013-06-26 06:10:32 +0000187 return "";
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000188
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))
Rafael Espindola2c6f4fe2013-06-26 06:10:32 +0000193 return link_path;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000194#else
195#error GetMainExecutable is not implemented on this host yet.
196#endif
197 return "";
198}
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000199
Mehdi Amini1e39ef32016-03-25 07:30:21 +0000200TimeValue file_status::getLastAccessedTime() const {
201 TimeValue Ret;
202 Ret.fromEpochTime(fs_st_atime);
203 return Ret;
204}
205
Rafael Espindolabe3ede72013-06-20 21:51:49 +0000206TimeValue file_status::getLastModificationTime() const {
Rafael Espindoladb5d8fe2013-06-20 18:42:04 +0000207 TimeValue Ret;
208 Ret.fromEpochTime(fs_st_mtime);
209 return Ret;
210}
211
Rafael Espindolad1230992013-07-29 21:55:38 +0000212UniqueID file_status::getUniqueID() const {
Rafael Espindola7f822a92013-07-29 21:26:49 +0000213 return UniqueID(fs_st_dev, fs_st_ino);
214}
215
Mehdi Aminie2d8f1b2016-04-01 00:18:08 +0000216ErrorOr<space_info> disk_space(const Twine &Path) {
217 struct STATVFS Vfs;
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;
225 return SpaceInfo;
226}
227
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000228std::error_code current_path(SmallVectorImpl<char> &result) {
Rafael Espindola6ee16382013-08-10 00:50:57 +0000229 result.clear();
230
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));
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000238 return std::error_code();
Rafael Espindola6ee16382013-08-10 00:50:57 +0000239 }
240
Sylvestre Ledru14ada942012-04-11 15:35:36 +0000241#ifdef MAXPATHLEN
Andrew Tricka4ec5b22011-03-24 16:43:37 +0000242 result.reserve(MAXPATHLEN);
Sylvestre Ledru14ada942012-04-11 15:35:36 +0000243#else
244// For GNU Hurd
245 result.reserve(1024);
246#endif
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000247
Michael J. Spencer20daa282010-12-07 01:22:31 +0000248 while (true) {
Craig Toppere73658d2014-04-28 04:05:08 +0000249 if (::getcwd(result.data(), result.capacity()) == nullptr) {
Michael J. Spencer20daa282010-12-07 01:22:31 +0000250 // See if there was a real error.
Rafael Espindola882ce87b2014-05-31 02:29:28 +0000251 if (errno != ENOMEM)
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000252 return std::error_code(errno, std::generic_category());
Michael J. Spencer20daa282010-12-07 01:22:31 +0000253 // Otherwise there just wasn't enough space.
254 result.reserve(result.capacity() * 2);
255 } else
256 break;
257 }
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000258
259 result.set_size(strlen(result.data()));
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000260 return std::error_code();
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000261}
262
Frederic Riss6b9396c2015-08-06 21:04:55 +0000263std::error_code create_directory(const Twine &path, bool IgnoreExisting,
264 perms Perms) {
Michael J. Spencer31e310c2010-12-03 05:42:11 +0000265 SmallString<128> path_storage;
266 StringRef p = path.toNullTerminatedStringRef(path_storage);
267
Frederic Riss6b9396c2015-08-06 21:04:55 +0000268 if (::mkdir(p.begin(), Perms) == -1) {
Rafael Espindola882ce87b2014-05-31 02:29:28 +0000269 if (errno != EEXIST || !IgnoreExisting)
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000270 return std::error_code(errno, std::generic_category());
Rafael Espindola5c20ac02014-02-23 13:56:14 +0000271 }
Michael J. Spencer31e310c2010-12-03 05:42:11 +0000272
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000273 return std::error_code();
Michael J. Spencer31e310c2010-12-03 05:42:11 +0000274}
275
Rafael Espindola83f858e2014-03-11 18:40:24 +0000276// Note that we are using symbolic link because hard links are not supported by
277// all filesystems (SMB doesn't).
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000278std::error_code create_link(const Twine &to, const Twine &from) {
Michael J. Spencere0c45602010-12-03 05:58:41 +0000279 // Get arguments.
280 SmallString<128> from_storage;
281 SmallString<128> to_storage;
282 StringRef f = from.toNullTerminatedStringRef(from_storage);
283 StringRef t = to.toNullTerminatedStringRef(to_storage);
284
Rafael Espindola83f858e2014-03-11 18:40:24 +0000285 if (::symlink(t.begin(), f.begin()) == -1)
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000286 return std::error_code(errno, std::generic_category());
Michael J. Spencere0c45602010-12-03 05:58:41 +0000287
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000288 return std::error_code();
Michael J. Spencere0c45602010-12-03 05:58:41 +0000289}
290
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000291std::error_code remove(const Twine &path, bool IgnoreNonExisting) {
Michael J. Spencer6e74e112010-12-03 17:53:43 +0000292 SmallString<128> path_storage;
293 StringRef p = path.toNullTerminatedStringRef(path_storage);
294
Rafael Espindola8cd62b02013-06-17 20:35:51 +0000295 struct stat buf;
Argyrios Kyrtzidis37575692014-03-21 01:25:37 +0000296 if (lstat(p.begin(), &buf) != 0) {
Rafael Espindola882ce87b2014-05-31 02:29:28 +0000297 if (errno != ENOENT || !IgnoreNonExisting)
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000298 return std::error_code(errno, std::generic_category());
299 return std::error_code();
Rafael Espindola8cd62b02013-06-17 20:35:51 +0000300 }
301
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.
Argyrios Kyrtzidis37575692014-03-21 01:25:37 +0000307 if (!S_ISREG(buf.st_mode) && !S_ISDIR(buf.st_mode) && !S_ISLNK(buf.st_mode))
Rafael Espindola2a826e42014-06-13 17:20:48 +0000308 return make_error_code(errc::operation_not_permitted);
Rafael Espindola8cd62b02013-06-17 20:35:51 +0000309
Michael J. Spencer6e74e112010-12-03 17:53:43 +0000310 if (::remove(p.begin()) == -1) {
Rafael Espindola882ce87b2014-05-31 02:29:28 +0000311 if (errno != ENOENT || !IgnoreNonExisting)
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000312 return std::error_code(errno, std::generic_category());
Rafael Espindola5c20ac02014-02-23 13:56:14 +0000313 }
Michael J. Spencer6e74e112010-12-03 17:53:43 +0000314
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000315 return std::error_code();
Michael J. Spencer6e74e112010-12-03 17:53:43 +0000316}
317
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000318std::error_code rename(const Twine &from, const Twine &to) {
Michael J. Spencer409f5562010-12-03 17:53:55 +0000319 // Get arguments.
320 SmallString<128> from_storage;
321 SmallString<128> to_storage;
322 StringRef f = from.toNullTerminatedStringRef(from_storage);
323 StringRef t = to.toNullTerminatedStringRef(to_storage);
324
Rafael Espindolab6fea4c2013-07-17 03:33:41 +0000325 if (::rename(f.begin(), t.begin()) == -1)
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000326 return std::error_code(errno, std::generic_category());
Michael J. Spencer409f5562010-12-03 17:53:55 +0000327
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000328 return std::error_code();
Michael J. Spencer409f5562010-12-03 17:53:55 +0000329}
330
Rafael Espindola59aaa6c2014-12-12 17:55:12 +0000331std::error_code resize_file(int FD, uint64_t Size) {
332 if (::ftruncate(FD, Size) == -1)
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000333 return std::error_code(errno, std::generic_category());
Michael J. Spencerc20a0322010-12-03 17:54:07 +0000334
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000335 return std::error_code();
Michael J. Spencerc20a0322010-12-03 17:54:07 +0000336}
337
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000338static int convertAccessMode(AccessMode Mode) {
Rafael Espindola281f23a2014-09-11 20:30:02 +0000339 switch (Mode) {
340 case AccessMode::Exist:
341 return F_OK;
342 case AccessMode::Write:
343 return W_OK;
344 case AccessMode::Execute:
345 return R_OK | X_OK; // scripts also need R_OK.
346 }
347 llvm_unreachable("invalid enum");
348}
Michael J. Spencer45710402010-12-03 01:21:28 +0000349
Rafael Espindola281f23a2014-09-11 20:30:02 +0000350std::error_code access(const Twine &Path, AccessMode Mode) {
351 SmallString<128> PathStorage;
352 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
353
354 if (::access(P.begin(), convertAccessMode(Mode)) == -1)
355 return std::error_code(errno, std::generic_category());
356
357 if (Mode == AccessMode::Execute) {
358 // Don't say that directories are executable.
359 struct stat buf;
360 if (0 != stat(P.begin(), &buf))
361 return errc::permission_denied;
362 if (!S_ISREG(buf.st_mode))
363 return errc::permission_denied;
364 }
Michael J. Spencer45710402010-12-03 01:21:28 +0000365
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000366 return std::error_code();
Michael J. Spencer45710402010-12-03 01:21:28 +0000367}
368
Reid Kleckner89d4b1a2015-09-10 23:28:06 +0000369bool can_execute(const Twine &Path) {
370 return !access(Path, AccessMode::Execute);
371}
372
Michael J. Spencer203d7802011-12-12 06:04:28 +0000373bool equivalent(file_status A, file_status B) {
374 assert(status_known(A) && status_known(B));
Sylvestre Ledru3099f4bd2012-04-23 16:37:23 +0000375 return A.fs_st_dev == B.fs_st_dev &&
376 A.fs_st_ino == B.fs_st_ino;
Michael J. Spencer203d7802011-12-12 06:04:28 +0000377}
378
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000379std::error_code equivalent(const Twine &A, const Twine &B, bool &result) {
Michael J. Spencer203d7802011-12-12 06:04:28 +0000380 file_status fsA, fsB;
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000381 if (std::error_code ec = status(A, fsA))
382 return ec;
383 if (std::error_code ec = status(B, fsB))
384 return ec;
Michael J. Spencer203d7802011-12-12 06:04:28 +0000385 result = equivalent(fsA, fsB);
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000386 return std::error_code();
Michael J. Spencer376d3872010-12-03 18:49:13 +0000387}
388
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000389static std::error_code fillStatus(int StatRet, const struct stat &Status,
390 file_status &Result) {
Rafael Espindola77021c92013-07-16 03:20:13 +0000391 if (StatRet != 0) {
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000392 std::error_code ec(errno, std::generic_category());
Rafael Espindola2a826e42014-06-13 17:20:48 +0000393 if (ec == errc::no_such_file_or_directory)
Rafael Espindola77021c92013-07-16 03:20:13 +0000394 Result = file_status(file_type::file_not_found);
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000395 else
Rafael Espindola77021c92013-07-16 03:20:13 +0000396 Result = file_status(file_type::status_error);
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000397 return ec;
398 }
399
Rafael Espindola9da91a02013-07-16 02:55:33 +0000400 file_type Type = file_type::type_unknown;
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000401
Rafael Espindola77021c92013-07-16 03:20:13 +0000402 if (S_ISDIR(Status.st_mode))
Rafael Espindola9da91a02013-07-16 02:55:33 +0000403 Type = file_type::directory_file;
Rafael Espindola77021c92013-07-16 03:20:13 +0000404 else if (S_ISREG(Status.st_mode))
Rafael Espindola9da91a02013-07-16 02:55:33 +0000405 Type = file_type::regular_file;
Rafael Espindola77021c92013-07-16 03:20:13 +0000406 else if (S_ISBLK(Status.st_mode))
Rafael Espindola9da91a02013-07-16 02:55:33 +0000407 Type = file_type::block_file;
Rafael Espindola77021c92013-07-16 03:20:13 +0000408 else if (S_ISCHR(Status.st_mode))
Rafael Espindola9da91a02013-07-16 02:55:33 +0000409 Type = file_type::character_file;
Rafael Espindola77021c92013-07-16 03:20:13 +0000410 else if (S_ISFIFO(Status.st_mode))
Rafael Espindola9da91a02013-07-16 02:55:33 +0000411 Type = file_type::fifo_file;
Rafael Espindola77021c92013-07-16 03:20:13 +0000412 else if (S_ISSOCK(Status.st_mode))
Rafael Espindola9da91a02013-07-16 02:55:33 +0000413 Type = file_type::socket_file;
414
Rafael Espindola77021c92013-07-16 03:20:13 +0000415 perms Perms = static_cast<perms>(Status.st_mode);
416 Result =
Mehdi Amini1e39ef32016-03-25 07:30:21 +0000417 file_status(Type, Perms, Status.st_dev, Status.st_ino, Status.st_atime,
418 Status.st_mtime, Status.st_uid, Status.st_gid,
419 Status.st_size);
Michael J. Spencer203d7802011-12-12 06:04:28 +0000420
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000421 return std::error_code();
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000422}
423
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000424std::error_code status(const Twine &Path, file_status &Result) {
Rafael Espindola77021c92013-07-16 03:20:13 +0000425 SmallString<128> PathStorage;
426 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
427
428 struct stat Status;
429 int StatRet = ::stat(P.begin(), &Status);
430 return fillStatus(StatRet, Status, Result);
431}
432
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000433std::error_code status(int FD, file_status &Result) {
Rafael Espindola77021c92013-07-16 03:20:13 +0000434 struct stat Status;
435 int StatRet = ::fstat(FD, &Status);
436 return fillStatus(StatRet, Status, Result);
437}
438
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000439std::error_code setLastModificationAndAccessTime(int FD, TimeValue Time) {
Eric Christophera24dc7f2013-07-04 01:10:38 +0000440#if defined(HAVE_FUTIMENS)
441 timespec Times[2];
Dmitri Gribenko70e65852014-02-11 09:11:18 +0000442 Times[0].tv_sec = Time.toEpochTime();
Eric Christophera24dc7f2013-07-04 01:10:38 +0000443 Times[0].tv_nsec = 0;
444 Times[1] = Times[0];
445 if (::futimens(FD, Times))
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000446 return std::error_code(errno, std::generic_category());
447 return std::error_code();
Eric Christophera24dc7f2013-07-04 01:10:38 +0000448#elif defined(HAVE_FUTIMES)
Rafael Espindola4a3365c2013-06-20 20:56:14 +0000449 timeval Times[2];
Dmitri Gribenko70e65852014-02-11 09:11:18 +0000450 Times[0].tv_sec = Time.toEpochTime();
Rafael Espindola4a3365c2013-06-20 20:56:14 +0000451 Times[0].tv_usec = 0;
452 Times[1] = Times[0];
453 if (::futimes(FD, Times))
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000454 return std::error_code(errno, std::generic_category());
455 return std::error_code();
Alp Tokerb30f01e2013-12-11 15:42:33 +0000456#else
457#warning Missing futimes() and futimens()
Alp Tokerb792a012014-06-30 18:57:04 +0000458 return make_error_code(errc::function_not_supported);
Alp Tokerb30f01e2013-12-11 15:42:33 +0000459#endif
Rafael Espindola4a3365c2013-06-20 20:56:14 +0000460}
461
Rafael Espindola7eb1f182014-12-11 20:12:55 +0000462std::error_code mapped_file_region::init(int FD, uint64_t Offset,
463 mapmode Mode) {
Rafael Espindolac69f13b2014-12-12 18:13:23 +0000464 assert(Size != 0);
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000465
466 int flags = (Mode == readwrite) ? MAP_SHARED : MAP_PRIVATE;
467 int prot = (Mode == readonly) ? PROT_READ : (PROT_READ | PROT_WRITE);
Craig Toppere73658d2014-04-28 04:05:08 +0000468 Mapping = ::mmap(nullptr, Size, prot, flags, FD, Offset);
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000469 if (Mapping == MAP_FAILED)
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000470 return std::error_code(errno, std::generic_category());
471 return std::error_code();
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000472}
473
Rafael Espindola7eb1f182014-12-11 20:12:55 +0000474mapped_file_region::mapped_file_region(int fd, mapmode mode, uint64_t length,
475 uint64_t offset, std::error_code &ec)
476 : Size(length), Mapping() {
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000477 // Make sure that the requested size fits within SIZE_T.
478 if (length > std::numeric_limits<size_t>::max()) {
Rafael Espindola2a826e42014-06-13 17:20:48 +0000479 ec = make_error_code(errc::invalid_argument);
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000480 return;
481 }
482
Rafael Espindola7eb1f182014-12-11 20:12:55 +0000483 ec = init(fd, offset, mode);
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000484 if (ec)
Craig Toppere73658d2014-04-28 04:05:08 +0000485 Mapping = nullptr;
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000486}
487
488mapped_file_region::~mapped_file_region() {
489 if (Mapping)
490 ::munmap(Mapping, Size);
491}
492
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000493uint64_t mapped_file_region::size() const {
494 assert(Mapping && "Mapping failed but used anyway!");
495 return Size;
496}
497
498char *mapped_file_region::data() const {
499 assert(Mapping && "Mapping failed but used anyway!");
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000500 return reinterpret_cast<char*>(Mapping);
501}
502
503const char *mapped_file_region::const_data() const {
504 assert(Mapping && "Mapping failed but used anyway!");
505 return reinterpret_cast<const char*>(Mapping);
506}
507
508int mapped_file_region::alignment() {
Rafael Espindolac0610bf2014-12-04 16:59:36 +0000509 return Process::getPageSize();
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000510}
511
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000512std::error_code detail::directory_iterator_construct(detail::DirIterState &it,
Michael J. Spencer0a7625d2011-12-08 22:50:09 +0000513 StringRef path){
Michael J. Spencer52714862011-01-05 16:38:57 +0000514 SmallString<128> path_null(path);
515 DIR *directory = ::opendir(path_null.c_str());
Craig Toppere73658d2014-04-28 04:05:08 +0000516 if (!directory)
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000517 return std::error_code(errno, std::generic_category());
Michael J. Spencer52714862011-01-05 16:38:57 +0000518
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);
524}
525
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000526std::error_code detail::directory_iterator_destruct(detail::DirIterState &it) {
Michael J. Spencer52714862011-01-05 16:38:57 +0000527 if (it.IterationHandle)
528 ::closedir(reinterpret_cast<DIR *>(it.IterationHandle));
529 it.IterationHandle = 0;
530 it.CurrentEntry = directory_entry();
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000531 return std::error_code();
Michael J. Spencer52714862011-01-05 16:38:57 +0000532}
533
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000534std::error_code detail::directory_iterator_increment(detail::DirIterState &it) {
Michael J. Spencer52714862011-01-05 16:38:57 +0000535 errno = 0;
536 dirent *cur_dir = ::readdir(reinterpret_cast<DIR *>(it.IterationHandle));
Craig Toppere73658d2014-04-28 04:05:08 +0000537 if (cur_dir == nullptr && errno != 0) {
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000538 return std::error_code(errno, std::generic_category());
Craig Toppere73658d2014-04-28 04:05:08 +0000539 } else if (cur_dir != nullptr) {
Michael J. Spencer52714862011-01-05 16:38:57 +0000540 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);
545 } else
546 return directory_iterator_destruct(it);
547
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000548 return std::error_code();
Michael J. Spencer52714862011-01-05 16:38:57 +0000549}
550
Taewook Ohd9153272016-06-13 15:54:56 +0000551#if !defined(F_GETPATH)
552static 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);
556 return Result;
557}
558#endif
559
560std::error_code openFileForRead(const Twine &Name, int &ResultFD,
561 SmallVectorImpl<char> *RealPath) {
Rafael Espindolaa0d9b6b2013-07-17 14:58:25 +0000562 SmallString<128> Storage;
563 StringRef P = Name.toNullTerminatedStringRef(Storage);
564 while ((ResultFD = open(P.begin(), O_RDONLY)) < 0) {
565 if (errno != EINTR)
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000566 return std::error_code(errno, std::generic_category());
Rafael Espindolaa0d9b6b2013-07-17 14:58:25 +0000567 }
Taewook Ohd9153272016-06-13 15:54:56 +0000568 // Attempt to get the real name of the file, if the user asked
569 if(!RealPath)
570 return std::error_code();
571 RealPath->clear();
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));
578#else
579 char Buffer[PATH_MAX];
580 if (hasProcSelfFD()) {
581 char ProcPath[64];
582 snprintf(ProcPath, sizeof(ProcPath), "/proc/self/fd/%d", ResultFD);
583 ssize_t CharCount = ::readlink(ProcPath, Buffer, sizeof(Buffer));
584 if (CharCount > 0)
585 RealPath->append(Buffer, Buffer + CharCount);
586 } else {
587 // Use ::realpath to get the real path name
588 if (::realpath(P.begin(), Buffer) != nullptr)
589 RealPath->append(Buffer, Buffer + strlen(Buffer));
590 }
591#endif
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000592 return std::error_code();
Rafael Espindolaa0d9b6b2013-07-17 14:58:25 +0000593}
Nick Kledzik18497e92012-06-20 00:28:54 +0000594
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000595std::error_code openFileForWrite(const Twine &Name, int &ResultFD,
Rafael Espindola67080ce2013-07-19 15:02:03 +0000596 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!");
600
Rafael Espindola7a0b6402014-02-24 03:07:41 +0000601 int OpenFlags = O_CREAT;
602
603 if (Flags & F_RW)
604 OpenFlags |= O_RDWR;
605 else
606 OpenFlags |= O_WRONLY;
Rafael Espindola67080ce2013-07-19 15:02:03 +0000607
608 if (Flags & F_Append)
609 OpenFlags |= O_APPEND;
610 else
611 OpenFlags |= O_TRUNC;
612
613 if (Flags & F_Excl)
614 OpenFlags |= O_EXCL;
615
616 SmallString<128> Storage;
617 StringRef P = Name.toNullTerminatedStringRef(Storage);
618 while ((ResultFD = open(P.begin(), OpenFlags, Mode)) < 0) {
619 if (errno != EINTR)
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000620 return std::error_code(errno, std::generic_category());
Rafael Espindola67080ce2013-07-19 15:02:03 +0000621 }
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000622 return std::error_code();
Rafael Espindola67080ce2013-07-19 15:02:03 +0000623}
624
Taewook Ohd9153272016-06-13 15:54:56 +0000625std::error_code getPathFromOpenFD(int FD, SmallVectorImpl<char> &ResultPath) {
626 if (FD < 0)
627 return make_error_code(errc::bad_file_descriptor);
628
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());
635
636 ResultPath.set_size(strlen(ResultPath.begin()));
637#else
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);
643
644 ResultPath.reserve(PATH_MAX);
645 char ProcPath[64];
646 snprintf(ProcPath, sizeof(ProcPath), "/proc/self/fd/%d", FD);
647 ssize_t CharCount = ::readlink(ProcPath, ResultPath.begin(), ResultPath.capacity());
648 if (CharCount < 0)
649 return std::error_code(errno, std::generic_category());
650
651 // Was the filename truncated?
652 if (static_cast<size_t>(CharCount) == ResultPath.capacity()) {
653 // Use lstat to get the size of the filename
654 struct stat sb;
655 if (::lstat(ProcPath, &sb) < 0)
656 return std::error_code(errno, std::generic_category());
657
658 ResultPath.reserve(sb.st_size + 1);
659 CharCount = ::readlink(ProcPath, ResultPath.begin(), ResultPath.capacity());
660 if (CharCount < 0)
661 return std::error_code(errno, std::generic_category());
662
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());
666 }
667 ResultPath.set_size(static_cast<size_t>(CharCount));
668#endif
669 return std::error_code();
670}
671
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +0000672} // end namespace fs
Peter Collingbournef7d41012014-01-31 23:46:06 +0000673
674namespace path {
675
676bool home_directory(SmallVectorImpl<char> &result) {
677 if (char *RequestedDir = getenv("HOME")) {
678 result.clear();
679 result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
680 return true;
681 }
682
683 return false;
684}
685
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000686static bool getDarwinConfDir(bool TempDir, SmallVectorImpl<char> &Result) {
Pawel Bylica0e97e5c2015-11-02 09:49:17 +0000687 #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);
693 if (ConfLen > 0) {
694 do {
695 Result.resize(ConfLen);
696 ConfLen = confstr(ConfName, Result.data(), Result.size());
697 } while (ConfLen > 0 && ConfLen != Result.size());
698
699 if (ConfLen > 0) {
700 assert(Result.back() == 0);
701 Result.pop_back();
702 return true;
703 }
704
705 Result.clear();
706 }
707 #endif
708 return false;
709}
710
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000711static bool getUserCacheDir(SmallVectorImpl<char> &Result) {
Sean Silvaa915a162016-03-24 22:27:27 +0000712 // First try using XDG_CACHE_HOME env variable,
Pawel Bylica0e97e5c2015-11-02 09:49:17 +0000713 // as specified in XDG Base Directory Specification at
714 // http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
Sean Silvaa915a162016-03-24 22:27:27 +0000715 if (const char *XdgCacheDir = std::getenv("XDG_CACHE_HOME")) {
Pawel Bylica0e97e5c2015-11-02 09:49:17 +0000716 Result.clear();
Sean Silvaa915a162016-03-24 22:27:27 +0000717 Result.append(XdgCacheDir, XdgCacheDir + strlen(XdgCacheDir));
Pawel Bylica0e97e5c2015-11-02 09:49:17 +0000718 return true;
719 }
720
721 // Try Darwin configuration query
722 if (getDarwinConfDir(false, Result))
723 return true;
724
725 // Use "$HOME/.cache" if $HOME is available
726 if (home_directory(Result)) {
727 append(Result, ".cache");
728 return true;
729 }
730
731 return false;
732}
Pawel Bylica0e97e5c2015-11-02 09:49:17 +0000733
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000734static const char *getEnvTempDir() {
Rafael Espindola016a6d52014-08-26 14:47:52 +0000735 // Check whether the temporary directory is specified by an environment
736 // variable.
737 const char *EnvironmentVariables[] = {"TMPDIR", "TMP", "TEMP", "TEMPDIR"};
738 for (const char *Env : EnvironmentVariables) {
739 if (const char *Dir = std::getenv(Env))
740 return Dir;
741 }
742
743 return nullptr;
744}
745
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000746static const char *getDefaultTempDir(bool ErasedOnReboot) {
Rafael Espindola016a6d52014-08-26 14:47:52 +0000747#ifdef P_tmpdir
Benjamin Kramer870d9512014-08-27 11:47:52 +0000748 if ((bool)P_tmpdir)
Rafael Espindola016a6d52014-08-26 14:47:52 +0000749 return P_tmpdir;
750#endif
751
752 if (ErasedOnReboot)
753 return "/tmp";
754 return "/var/tmp";
755}
756
757void system_temp_directory(bool ErasedOnReboot, SmallVectorImpl<char> &Result) {
758 Result.clear();
759
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));
764 return;
765 }
766 }
767
Pawel Bylica0e97e5c2015-11-02 09:49:17 +0000768 if (getDarwinConfDir(ErasedOnReboot, Result))
769 return;
Rafael Espindola016a6d52014-08-26 14:47:52 +0000770
771 const char *RequestedDir = getDefaultTempDir(ErasedOnReboot);
772 Result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
773}
774
Peter Collingbournef7d41012014-01-31 23:46:06 +0000775} // end namespace path
776
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000777} // end namespace sys
778} // end namespace llvm