blob: 734ea5d110a96332efcd4e247d6e1c6e86a66cfb [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"
Daniel Dunbar3f0fa192012-05-05 16:36:24 +000020#include "llvm/Support/Process.h"
Reid Kleckner37f69de2013-07-26 16:54:23 +000021#include <limits.h>
22#include <stdio.h>
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +000023#if HAVE_SYS_STAT_H
24#include <sys/stat.h>
25#endif
26#if HAVE_FCNTL_H
27#include <fcntl.h>
28#endif
Nick Kledzik18497e92012-06-20 00:28:54 +000029#ifdef HAVE_SYS_MMAN_H
30#include <sys/mman.h>
31#endif
Michael J. Spencer52714862011-01-05 16:38:57 +000032#if HAVE_DIRENT_H
33# include <dirent.h>
34# define NAMLEN(dirent) strlen((dirent)->d_name)
35#else
36# define dirent direct
37# define NAMLEN(dirent) (dirent)->d_namlen
38# if HAVE_SYS_NDIR_H
39# include <sys/ndir.h>
40# endif
41# if HAVE_SYS_DIR_H
42# include <sys/dir.h>
43# endif
44# if HAVE_NDIR_H
45# include <ndir.h>
46# endif
47#endif
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +000048
Rafael Espindola4601c462013-06-26 05:25:44 +000049#ifdef __APPLE__
50#include <mach-o/dyld.h>
51#endif
52
Joerg Sonnenbergerc0697302012-08-10 10:56:09 +000053// Both stdio.h and cstdio are included via different pathes and
54// stdcxx's cstdio doesn't include stdio.h, so it doesn't #undef the macros
55// either.
56#undef ferror
57#undef feof
58
Sylvestre Ledru14ada942012-04-11 15:35:36 +000059// For GNU Hurd
60#if defined(__GNU__) && !defined(PATH_MAX)
61# define PATH_MAX 4096
62#endif
63
Michael J. Spencer45710402010-12-03 01:21:28 +000064using namespace llvm;
65
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +000066namespace {
Michael J. Spencer5529c572010-12-07 01:23:08 +000067 /// This class automatically closes the given file descriptor when it goes out
68 /// of scope. You can take back explicit ownership of the file descriptor by
69 /// calling take(). The destructor does not verify that close was successful.
70 /// Therefore, never allow this class to call close on a file descriptor that
71 /// has been read from or written to.
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +000072 struct AutoFD {
73 int FileDescriptor;
74
75 AutoFD(int fd) : FileDescriptor(fd) {}
76 ~AutoFD() {
77 if (FileDescriptor >= 0)
78 ::close(FileDescriptor);
79 }
80
81 int take() {
82 int ret = FileDescriptor;
83 FileDescriptor = -1;
84 return ret;
85 }
86
87 operator int() const {return FileDescriptor;}
88 };
Michael J. Spencer45710402010-12-03 01:21:28 +000089
90 error_code TempDir(SmallVectorImpl<char> &result) {
91 // FIXME: Don't use TMPDIR if program is SUID or SGID enabled.
92 const char *dir = 0;
93 (dir = std::getenv("TMPDIR" )) ||
94 (dir = std::getenv("TMP" )) ||
95 (dir = std::getenv("TEMP" )) ||
96 (dir = std::getenv("TEMPDIR")) ||
97#ifdef P_tmpdir
98 (dir = P_tmpdir) ||
99#endif
100 (dir = "/tmp");
101
Michael J. Spencer98c7a112010-12-07 01:23:19 +0000102 result.clear();
Michael J. Spencer45710402010-12-03 01:21:28 +0000103 StringRef d(dir);
104 result.append(d.begin(), d.end());
David Blaikie18544b92012-02-09 19:24:12 +0000105 return error_code::success();
Michael J. Spencer45710402010-12-03 01:21:28 +0000106 }
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +0000107}
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000108
Rafael Espindolae79a8722013-06-28 03:48:47 +0000109static error_code createUniqueEntity(const Twine &Model, int &ResultFD,
110 SmallVectorImpl<char> &ResultPath,
111 bool MakeAbsolute, unsigned Mode,
112 FSEntity Type) {
113 SmallString<128> ModelStorage;
114 Model.toVector(ModelStorage);
115
116 if (MakeAbsolute) {
117 // Make model absolute by prepending a temp directory if it's not already.
118 bool absolute = sys::path::is_absolute(Twine(ModelStorage));
119 if (!absolute) {
120 SmallString<128> TDir;
121 if (error_code ec = TempDir(TDir)) return ec;
122 sys::path::append(TDir, Twine(ModelStorage));
123 ModelStorage.swap(TDir);
124 }
125 }
126
127 // From here on, DO NOT modify model. It may be needed if the randomly chosen
128 // path already exists.
129 ResultPath = ModelStorage;
130 // Null terminate.
131 ResultPath.push_back(0);
132 ResultPath.pop_back();
133
134retry_random_path:
135 // Replace '%' with random chars.
136 for (unsigned i = 0, e = ModelStorage.size(); i != e; ++i) {
137 if (ModelStorage[i] == '%')
138 ResultPath[i] = "0123456789abcdef"[sys::Process::GetRandomNumber() & 15];
139 }
140
141 // Try to open + create the file.
142 switch (Type) {
143 case FS_File: {
144 int RandomFD = ::open(ResultPath.begin(), O_RDWR | O_CREAT | O_EXCL, Mode);
145 if (RandomFD == -1) {
146 int SavedErrno = errno;
147 // If the file existed, try again, otherwise, error.
148 if (SavedErrno == errc::file_exists)
149 goto retry_random_path;
150 return error_code(SavedErrno, system_category());
151 }
152
153 ResultFD = RandomFD;
154 return error_code::success();
155 }
156
157 case FS_Name: {
158 bool Exists;
159 error_code EC = sys::fs::exists(ResultPath.begin(), Exists);
160 if (EC)
161 return EC;
162 if (Exists)
163 goto retry_random_path;
164 return error_code::success();
165 }
166
167 case FS_Dir: {
168 bool Existed;
169 error_code EC = sys::fs::create_directory(ResultPath.begin(), Existed);
170 if (EC)
171 return EC;
172 if (Existed)
173 goto retry_random_path;
174 return error_code::success();
175 }
176 }
Patrik Hagglunddcc336b2013-06-28 06:54:05 +0000177 llvm_unreachable("Invalid Type");
Rafael Espindolae79a8722013-06-28 03:48:47 +0000178}
179
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000180namespace llvm {
181namespace sys {
Michael J. Spencer20daa282010-12-07 01:22:31 +0000182namespace fs {
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000183#if defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
184 defined(__OpenBSD__) || defined(__minix) || defined(__FreeBSD_kernel__) || \
Rafael Espindolaaca97392013-10-31 14:35:00 +0000185 defined(__linux__) || defined(__CYGWIN__) || defined(__DragonFly__)
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000186static int
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000187test_dir(char ret[PATH_MAX], const char *dir, const char *bin)
188{
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000189 struct stat sb;
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000190 char fullpath[PATH_MAX];
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000191
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000192 snprintf(fullpath, PATH_MAX, "%s/%s", dir, bin);
193 if (realpath(fullpath, ret) == NULL)
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000194 return (1);
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000195 if (stat(fullpath, &sb) != 0)
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000196 return (1);
197
198 return (0);
199}
200
201static char *
202getprogpath(char ret[PATH_MAX], const char *bin)
203{
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000204 char *pv, *s, *t;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000205
206 /* First approach: absolute path. */
207 if (bin[0] == '/') {
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000208 if (test_dir(ret, "/", bin) == 0)
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000209 return (ret);
210 return (NULL);
211 }
212
213 /* Second approach: relative path. */
214 if (strchr(bin, '/') != NULL) {
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000215 char cwd[PATH_MAX];
216 if (getcwd(cwd, PATH_MAX) == NULL)
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000217 return (NULL);
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000218 if (test_dir(ret, cwd, bin) == 0)
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000219 return (ret);
220 return (NULL);
221 }
222
223 /* Third approach: $PATH */
224 if ((pv = getenv("PATH")) == NULL)
225 return (NULL);
226 s = pv = strdup(pv);
227 if (pv == NULL)
228 return (NULL);
229 while ((t = strsep(&s, ":")) != NULL) {
Sylvestre Ledru21e674722013-12-09 16:27:00 +0000230 if (test_dir(ret, t, bin) == 0) {
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000231 free(pv);
232 return (ret);
233 }
234 }
235 free(pv);
236 return (NULL);
237}
238#endif // __FreeBSD__ || __NetBSD__ || __FreeBSD_kernel__
239
240/// GetMainExecutable - Return the path to the main executable, given the
241/// value of argv[0] from program startup.
242std::string getMainExecutable(const char *argv0, void *MainAddr) {
243#if defined(__APPLE__)
244 // On OS X the executable path is saved to the stack by dyld. Reading it
245 // from there is much faster than calling dladdr, especially for large
246 // binaries with symbols.
247 char exe_path[MAXPATHLEN];
248 uint32_t size = sizeof(exe_path);
249 if (_NSGetExecutablePath(exe_path, &size) == 0) {
250 char link_path[MAXPATHLEN];
251 if (realpath(exe_path, link_path))
Rafael Espindola4601c462013-06-26 05:25:44 +0000252 return link_path;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000253 }
254#elif defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
Rafael Espindolaaca97392013-10-31 14:35:00 +0000255 defined(__OpenBSD__) || defined(__minix) || defined(__DragonFly__) || \
256 defined(__FreeBSD_kernel__)
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000257 char exe_path[PATH_MAX];
258
259 if (getprogpath(exe_path, argv0) != NULL)
Rafael Espindola2c6f4fe2013-06-26 06:10:32 +0000260 return exe_path;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000261#elif defined(__linux__) || defined(__CYGWIN__)
262 char exe_path[MAXPATHLEN];
263 StringRef aPath("/proc/self/exe");
264 if (sys::fs::exists(aPath)) {
265 // /proc is not always mounted under Linux (chroot for example).
266 ssize_t len = readlink(aPath.str().c_str(), exe_path, sizeof(exe_path));
267 if (len >= 0)
268 return StringRef(exe_path, len);
269 } else {
270 // Fall back to the classical detection.
271 if (getprogpath(exe_path, argv0) != NULL)
272 return exe_path;
273 }
274#elif defined(HAVE_DLFCN_H)
275 // Use dladdr to get executable path if available.
276 Dl_info DLInfo;
277 int err = dladdr(MainAddr, &DLInfo);
278 if (err == 0)
Rafael Espindola2c6f4fe2013-06-26 06:10:32 +0000279 return "";
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000280
281 // If the filename is a symlink, we need to resolve and return the location of
282 // the actual executable.
283 char link_path[MAXPATHLEN];
284 if (realpath(DLInfo.dli_fname, link_path))
Rafael Espindola2c6f4fe2013-06-26 06:10:32 +0000285 return link_path;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000286#else
287#error GetMainExecutable is not implemented on this host yet.
288#endif
289 return "";
290}
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000291
Rafael Espindolabe3ede72013-06-20 21:51:49 +0000292TimeValue file_status::getLastModificationTime() const {
Rafael Espindoladb5d8fe2013-06-20 18:42:04 +0000293 TimeValue Ret;
294 Ret.fromEpochTime(fs_st_mtime);
295 return Ret;
296}
297
Rafael Espindolad1230992013-07-29 21:55:38 +0000298UniqueID file_status::getUniqueID() const {
Rafael Espindola7f822a92013-07-29 21:26:49 +0000299 return UniqueID(fs_st_dev, fs_st_ino);
300}
301
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000302error_code current_path(SmallVectorImpl<char> &result) {
Rafael Espindola6ee16382013-08-10 00:50:57 +0000303 result.clear();
304
305 const char *pwd = ::getenv("PWD");
306 llvm::sys::fs::file_status PWDStatus, DotStatus;
307 if (pwd && llvm::sys::path::is_absolute(pwd) &&
308 !llvm::sys::fs::status(pwd, PWDStatus) &&
309 !llvm::sys::fs::status(".", DotStatus) &&
310 PWDStatus.getUniqueID() == DotStatus.getUniqueID()) {
311 result.append(pwd, pwd + strlen(pwd));
312 return error_code::success();
313 }
314
Sylvestre Ledru14ada942012-04-11 15:35:36 +0000315#ifdef MAXPATHLEN
Andrew Tricka4ec5b22011-03-24 16:43:37 +0000316 result.reserve(MAXPATHLEN);
Sylvestre Ledru14ada942012-04-11 15:35:36 +0000317#else
318// For GNU Hurd
319 result.reserve(1024);
320#endif
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000321
Michael J. Spencer20daa282010-12-07 01:22:31 +0000322 while (true) {
323 if (::getcwd(result.data(), result.capacity()) == 0) {
324 // See if there was a real error.
325 if (errno != errc::not_enough_memory)
326 return error_code(errno, system_category());
327 // Otherwise there just wasn't enough space.
328 result.reserve(result.capacity() * 2);
329 } else
330 break;
331 }
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000332
333 result.set_size(strlen(result.data()));
David Blaikie18544b92012-02-09 19:24:12 +0000334 return error_code::success();
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000335}
336
Michael J. Spencer31e310c2010-12-03 05:42:11 +0000337error_code create_directory(const Twine &path, bool &existed) {
338 SmallString<128> path_storage;
339 StringRef p = path.toNullTerminatedStringRef(path_storage);
340
Michael J. Spencere5755be2010-12-07 01:23:29 +0000341 if (::mkdir(p.begin(), S_IRWXU | S_IRWXG) == -1) {
Michael J. Spencer66a1f862010-12-04 18:45:32 +0000342 if (errno != errc::file_exists)
Michael J. Spencer31e310c2010-12-03 05:42:11 +0000343 return error_code(errno, system_category());
344 existed = true;
345 } else
346 existed = false;
347
David Blaikie18544b92012-02-09 19:24:12 +0000348 return error_code::success();
Michael J. Spencer31e310c2010-12-03 05:42:11 +0000349}
350
Michael J. Spencere0c45602010-12-03 05:58:41 +0000351error_code create_hard_link(const Twine &to, const Twine &from) {
352 // Get arguments.
353 SmallString<128> from_storage;
354 SmallString<128> to_storage;
355 StringRef f = from.toNullTerminatedStringRef(from_storage);
356 StringRef t = to.toNullTerminatedStringRef(to_storage);
357
358 if (::link(t.begin(), f.begin()) == -1)
359 return error_code(errno, system_category());
360
David Blaikie18544b92012-02-09 19:24:12 +0000361 return error_code::success();
Michael J. Spencere0c45602010-12-03 05:58:41 +0000362}
363
Michael J. Spencer7ee6d5d2010-12-03 07:41:25 +0000364error_code create_symlink(const Twine &to, const Twine &from) {
365 // Get arguments.
366 SmallString<128> from_storage;
367 SmallString<128> to_storage;
368 StringRef f = from.toNullTerminatedStringRef(from_storage);
369 StringRef t = to.toNullTerminatedStringRef(to_storage);
370
371 if (::symlink(t.begin(), f.begin()) == -1)
372 return error_code(errno, system_category());
373
David Blaikie18544b92012-02-09 19:24:12 +0000374 return error_code::success();
Michael J. Spencer7ee6d5d2010-12-03 07:41:25 +0000375}
376
Michael J. Spencer6e74e112010-12-03 17:53:43 +0000377error_code remove(const Twine &path, bool &existed) {
378 SmallString<128> path_storage;
379 StringRef p = path.toNullTerminatedStringRef(path_storage);
380
Rafael Espindola8cd62b02013-06-17 20:35:51 +0000381 struct stat buf;
382 if (stat(p.begin(), &buf) != 0) {
383 if (errno != errc::no_such_file_or_directory)
384 return error_code(errno, system_category());
385 existed = false;
386 return error_code::success();
387 }
388
389 // Note: this check catches strange situations. In all cases, LLVM should
390 // only be involved in the creation and deletion of regular files. This
391 // check ensures that what we're trying to erase is a regular file. It
392 // effectively prevents LLVM from erasing things like /dev/null, any block
393 // special file, or other things that aren't "regular" files.
394 if (!S_ISREG(buf.st_mode) && !S_ISDIR(buf.st_mode))
395 return make_error_code(errc::operation_not_permitted);
396
Michael J. Spencer6e74e112010-12-03 17:53:43 +0000397 if (::remove(p.begin()) == -1) {
Michael J. Spencer66a1f862010-12-04 18:45:32 +0000398 if (errno != errc::no_such_file_or_directory)
Michael J. Spencer6e74e112010-12-03 17:53:43 +0000399 return error_code(errno, system_category());
400 existed = false;
401 } else
402 existed = true;
403
David Blaikie18544b92012-02-09 19:24:12 +0000404 return error_code::success();
Michael J. Spencer6e74e112010-12-03 17:53:43 +0000405}
406
Michael J. Spencer409f5562010-12-03 17:53:55 +0000407error_code rename(const Twine &from, const Twine &to) {
408 // Get arguments.
409 SmallString<128> from_storage;
410 SmallString<128> to_storage;
411 StringRef f = from.toNullTerminatedStringRef(from_storage);
412 StringRef t = to.toNullTerminatedStringRef(to_storage);
413
Rafael Espindolab6fea4c2013-07-17 03:33:41 +0000414 if (::rename(f.begin(), t.begin()) == -1)
415 return error_code(errno, system_category());
Michael J. Spencer409f5562010-12-03 17:53:55 +0000416
David Blaikie18544b92012-02-09 19:24:12 +0000417 return error_code::success();
Michael J. Spencer409f5562010-12-03 17:53:55 +0000418}
419
Michael J. Spencerc20a0322010-12-03 17:54:07 +0000420error_code resize_file(const Twine &path, uint64_t size) {
421 SmallString<128> path_storage;
422 StringRef p = path.toNullTerminatedStringRef(path_storage);
423
424 if (::truncate(p.begin(), size) == -1)
425 return error_code(errno, system_category());
426
David Blaikie18544b92012-02-09 19:24:12 +0000427 return error_code::success();
Michael J. Spencerc20a0322010-12-03 17:54:07 +0000428}
429
Michael J. Spencer45710402010-12-03 01:21:28 +0000430error_code exists(const Twine &path, bool &result) {
431 SmallString<128> path_storage;
432 StringRef p = path.toNullTerminatedStringRef(path_storage);
433
Benjamin Kramer172f8082012-06-02 16:28:09 +0000434 if (::access(p.begin(), F_OK) == -1) {
Michael J. Spencer66a1f862010-12-04 18:45:32 +0000435 if (errno != errc::no_such_file_or_directory)
Michael J. Spencer45710402010-12-03 01:21:28 +0000436 return error_code(errno, system_category());
437 result = false;
438 } else
439 result = true;
440
David Blaikie18544b92012-02-09 19:24:12 +0000441 return error_code::success();
Michael J. Spencer45710402010-12-03 01:21:28 +0000442}
443
Rafael Espindolaa1280c12013-06-18 20:56:38 +0000444bool can_write(const Twine &Path) {
445 SmallString<128> PathStorage;
446 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
447 return 0 == access(P.begin(), W_OK);
448}
449
Rafael Espindolab0a5c962013-06-14 19:38:45 +0000450bool can_execute(const Twine &Path) {
451 SmallString<128> PathStorage;
452 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
453
Manuel Klimek52772bf2013-06-17 10:48:34 +0000454 if (0 != access(P.begin(), R_OK | X_OK))
455 return false;
456 struct stat buf;
457 if (0 != stat(P.begin(), &buf))
458 return false;
459 if (!S_ISREG(buf.st_mode))
460 return false;
461 return true;
Rafael Espindolab0a5c962013-06-14 19:38:45 +0000462}
463
Michael J. Spencer203d7802011-12-12 06:04:28 +0000464bool equivalent(file_status A, file_status B) {
465 assert(status_known(A) && status_known(B));
Sylvestre Ledru3099f4bd2012-04-23 16:37:23 +0000466 return A.fs_st_dev == B.fs_st_dev &&
467 A.fs_st_ino == B.fs_st_ino;
Michael J. Spencer203d7802011-12-12 06:04:28 +0000468}
469
Michael J. Spencer376d3872010-12-03 18:49:13 +0000470error_code equivalent(const Twine &A, const Twine &B, bool &result) {
Michael J. Spencer203d7802011-12-12 06:04:28 +0000471 file_status fsA, fsB;
472 if (error_code ec = status(A, fsA)) return ec;
473 if (error_code ec = status(B, fsB)) return ec;
474 result = equivalent(fsA, fsB);
David Blaikie18544b92012-02-09 19:24:12 +0000475 return error_code::success();
Michael J. Spencer376d3872010-12-03 18:49:13 +0000476}
477
Rafael Espindola77021c92013-07-16 03:20:13 +0000478static error_code fillStatus(int StatRet, const struct stat &Status,
479 file_status &Result) {
480 if (StatRet != 0) {
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000481 error_code ec(errno, system_category());
482 if (ec == errc::no_such_file_or_directory)
Rafael Espindola77021c92013-07-16 03:20:13 +0000483 Result = file_status(file_type::file_not_found);
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000484 else
Rafael Espindola77021c92013-07-16 03:20:13 +0000485 Result = file_status(file_type::status_error);
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000486 return ec;
487 }
488
Rafael Espindola9da91a02013-07-16 02:55:33 +0000489 file_type Type = file_type::type_unknown;
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000490
Rafael Espindola77021c92013-07-16 03:20:13 +0000491 if (S_ISDIR(Status.st_mode))
Rafael Espindola9da91a02013-07-16 02:55:33 +0000492 Type = file_type::directory_file;
Rafael Espindola77021c92013-07-16 03:20:13 +0000493 else if (S_ISREG(Status.st_mode))
Rafael Espindola9da91a02013-07-16 02:55:33 +0000494 Type = file_type::regular_file;
Rafael Espindola77021c92013-07-16 03:20:13 +0000495 else if (S_ISBLK(Status.st_mode))
Rafael Espindola9da91a02013-07-16 02:55:33 +0000496 Type = file_type::block_file;
Rafael Espindola77021c92013-07-16 03:20:13 +0000497 else if (S_ISCHR(Status.st_mode))
Rafael Espindola9da91a02013-07-16 02:55:33 +0000498 Type = file_type::character_file;
Rafael Espindola77021c92013-07-16 03:20:13 +0000499 else if (S_ISFIFO(Status.st_mode))
Rafael Espindola9da91a02013-07-16 02:55:33 +0000500 Type = file_type::fifo_file;
Rafael Espindola77021c92013-07-16 03:20:13 +0000501 else if (S_ISSOCK(Status.st_mode))
Rafael Espindola9da91a02013-07-16 02:55:33 +0000502 Type = file_type::socket_file;
503
Rafael Espindola77021c92013-07-16 03:20:13 +0000504 perms Perms = static_cast<perms>(Status.st_mode);
505 Result =
506 file_status(Type, Perms, Status.st_dev, Status.st_ino, Status.st_mtime,
507 Status.st_uid, Status.st_gid, Status.st_size);
Michael J. Spencer203d7802011-12-12 06:04:28 +0000508
David Blaikie18544b92012-02-09 19:24:12 +0000509 return error_code::success();
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000510}
511
Rafael Espindola77021c92013-07-16 03:20:13 +0000512error_code status(const Twine &Path, file_status &Result) {
513 SmallString<128> PathStorage;
514 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
515
516 struct stat Status;
517 int StatRet = ::stat(P.begin(), &Status);
518 return fillStatus(StatRet, Status, Result);
519}
520
521error_code status(int FD, file_status &Result) {
522 struct stat Status;
523 int StatRet = ::fstat(FD, &Status);
524 return fillStatus(StatRet, Status, Result);
525}
526
Rafael Espindola4a3365c2013-06-20 20:56:14 +0000527error_code setLastModificationAndAccessTime(int FD, TimeValue Time) {
Eric Christophera24dc7f2013-07-04 01:10:38 +0000528#if defined(HAVE_FUTIMENS)
529 timespec Times[2];
530 Times[0].tv_sec = Time.toPosixTime();
531 Times[0].tv_nsec = 0;
532 Times[1] = Times[0];
533 if (::futimens(FD, Times))
534#elif defined(HAVE_FUTIMES)
Rafael Espindola4a3365c2013-06-20 20:56:14 +0000535 timeval Times[2];
536 Times[0].tv_sec = Time.toPosixTime();
537 Times[0].tv_usec = 0;
538 Times[1] = Times[0];
539 if (::futimes(FD, Times))
Eric Christophera24dc7f2013-07-04 01:10:38 +0000540#else
541#error Missing futimes() and futimens()
542#endif
Rafael Espindola4a3365c2013-06-20 20:56:14 +0000543 return error_code(errno, system_category());
544 return error_code::success();
545}
546
Michael J. Spencer42ad29f2013-03-14 00:20:10 +0000547error_code mapped_file_region::init(int FD, bool CloseFD, uint64_t Offset) {
548 AutoFD ScopedFD(FD);
549 if (!CloseFD)
550 ScopedFD.take();
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000551
552 // Figure out how large the file is.
553 struct stat FileInfo;
Michael J. Spencer42ad29f2013-03-14 00:20:10 +0000554 if (fstat(FD, &FileInfo) == -1)
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000555 return error_code(errno, system_category());
556 uint64_t FileSize = FileInfo.st_size;
557
558 if (Size == 0)
559 Size = FileSize;
560 else if (FileSize < Size) {
561 // We need to grow the file.
Michael J. Spencer42ad29f2013-03-14 00:20:10 +0000562 if (ftruncate(FD, Size) == -1)
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000563 return error_code(errno, system_category());
564 }
565
566 int flags = (Mode == readwrite) ? MAP_SHARED : MAP_PRIVATE;
567 int prot = (Mode == readonly) ? PROT_READ : (PROT_READ | PROT_WRITE);
568#ifdef MAP_FILE
569 flags |= MAP_FILE;
570#endif
Michael J. Spencer42ad29f2013-03-14 00:20:10 +0000571 Mapping = ::mmap(0, Size, prot, flags, FD, Offset);
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000572 if (Mapping == MAP_FAILED)
573 return error_code(errno, system_category());
574 return error_code::success();
575}
576
577mapped_file_region::mapped_file_region(const Twine &path,
578 mapmode mode,
579 uint64_t length,
580 uint64_t offset,
581 error_code &ec)
582 : Mode(mode)
583 , Size(length)
584 , Mapping() {
585 // Make sure that the requested size fits within SIZE_T.
586 if (length > std::numeric_limits<size_t>::max()) {
587 ec = make_error_code(errc::invalid_argument);
588 return;
589 }
590
591 SmallString<128> path_storage;
592 StringRef name = path.toNullTerminatedStringRef(path_storage);
593 int oflags = (mode == readonly) ? O_RDONLY : O_RDWR;
594 int ofd = ::open(name.begin(), oflags);
595 if (ofd == -1) {
596 ec = error_code(errno, system_category());
597 return;
598 }
599
Michael J. Spencer42ad29f2013-03-14 00:20:10 +0000600 ec = init(ofd, true, offset);
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000601 if (ec)
602 Mapping = 0;
603}
604
605mapped_file_region::mapped_file_region(int fd,
Michael J. Spencer42ad29f2013-03-14 00:20:10 +0000606 bool closefd,
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000607 mapmode mode,
608 uint64_t length,
609 uint64_t offset,
610 error_code &ec)
611 : Mode(mode)
612 , Size(length)
613 , Mapping() {
614 // Make sure that the requested size fits within SIZE_T.
615 if (length > std::numeric_limits<size_t>::max()) {
616 ec = make_error_code(errc::invalid_argument);
617 return;
618 }
619
Michael J. Spencer42ad29f2013-03-14 00:20:10 +0000620 ec = init(fd, closefd, offset);
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000621 if (ec)
622 Mapping = 0;
623}
624
625mapped_file_region::~mapped_file_region() {
626 if (Mapping)
627 ::munmap(Mapping, Size);
628}
629
Chandler Carruthf12e3a62012-11-30 11:45:22 +0000630#if LLVM_HAS_RVALUE_REFERENCES
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000631mapped_file_region::mapped_file_region(mapped_file_region &&other)
632 : Mode(other.Mode), Size(other.Size), Mapping(other.Mapping) {
633 other.Mapping = 0;
634}
635#endif
636
637mapped_file_region::mapmode mapped_file_region::flags() const {
638 assert(Mapping && "Mapping failed but used anyway!");
639 return Mode;
640}
641
642uint64_t mapped_file_region::size() const {
643 assert(Mapping && "Mapping failed but used anyway!");
644 return Size;
645}
646
647char *mapped_file_region::data() const {
648 assert(Mapping && "Mapping failed but used anyway!");
Alp Tokerf907b892013-12-05 05:44:44 +0000649 assert(Mode != readonly && "Cannot get non-const data for readonly mapping!");
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000650 return reinterpret_cast<char*>(Mapping);
651}
652
653const char *mapped_file_region::const_data() const {
654 assert(Mapping && "Mapping failed but used anyway!");
655 return reinterpret_cast<const char*>(Mapping);
656}
657
658int mapped_file_region::alignment() {
Chandler Carruthacd64be2012-12-31 23:31:56 +0000659 return process::get_self()->page_size();
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000660}
661
Michael J. Spencer0a7625d2011-12-08 22:50:09 +0000662error_code detail::directory_iterator_construct(detail::DirIterState &it,
663 StringRef path){
Michael J. Spencer52714862011-01-05 16:38:57 +0000664 SmallString<128> path_null(path);
665 DIR *directory = ::opendir(path_null.c_str());
666 if (directory == 0)
667 return error_code(errno, system_category());
668
669 it.IterationHandle = reinterpret_cast<intptr_t>(directory);
670 // Add something for replace_filename to replace.
671 path::append(path_null, ".");
672 it.CurrentEntry = directory_entry(path_null.str());
673 return directory_iterator_increment(it);
674}
675
Michael J. Spencer0a7625d2011-12-08 22:50:09 +0000676error_code detail::directory_iterator_destruct(detail::DirIterState &it) {
Michael J. Spencer52714862011-01-05 16:38:57 +0000677 if (it.IterationHandle)
678 ::closedir(reinterpret_cast<DIR *>(it.IterationHandle));
679 it.IterationHandle = 0;
680 it.CurrentEntry = directory_entry();
David Blaikie18544b92012-02-09 19:24:12 +0000681 return error_code::success();
Michael J. Spencer52714862011-01-05 16:38:57 +0000682}
683
Michael J. Spencer0a7625d2011-12-08 22:50:09 +0000684error_code detail::directory_iterator_increment(detail::DirIterState &it) {
Michael J. Spencer52714862011-01-05 16:38:57 +0000685 errno = 0;
686 dirent *cur_dir = ::readdir(reinterpret_cast<DIR *>(it.IterationHandle));
687 if (cur_dir == 0 && errno != 0) {
688 return error_code(errno, system_category());
689 } else if (cur_dir != 0) {
690 StringRef name(cur_dir->d_name, NAMLEN(cur_dir));
691 if ((name.size() == 1 && name[0] == '.') ||
692 (name.size() == 2 && name[0] == '.' && name[1] == '.'))
693 return directory_iterator_increment(it);
694 it.CurrentEntry.replace_filename(name);
695 } else
696 return directory_iterator_destruct(it);
697
David Blaikie18544b92012-02-09 19:24:12 +0000698 return error_code::success();
Michael J. Spencer52714862011-01-05 16:38:57 +0000699}
700
Michael J. Spenceree1699c2011-01-15 18:52:33 +0000701error_code get_magic(const Twine &path, uint32_t len,
702 SmallVectorImpl<char> &result) {
703 SmallString<128> PathStorage;
704 StringRef Path = path.toNullTerminatedStringRef(PathStorage);
705 result.set_size(0);
706
707 // Open path.
708 std::FILE *file = std::fopen(Path.data(), "rb");
709 if (file == 0)
710 return error_code(errno, system_category());
711
712 // Reserve storage.
713 result.reserve(len);
714
715 // Read magic!
716 size_t size = std::fread(result.data(), 1, len, file);
717 if (std::ferror(file) != 0) {
718 std::fclose(file);
719 return error_code(errno, system_category());
Evgeniy Stepanov6eb44842013-06-20 15:56:05 +0000720 } else if (size != len) {
Michael J. Spenceree1699c2011-01-15 18:52:33 +0000721 if (std::feof(file) != 0) {
722 std::fclose(file);
723 result.set_size(size);
724 return make_error_code(errc::value_too_large);
725 }
726 }
727 std::fclose(file);
Evgeniy Stepanov6eb44842013-06-20 15:56:05 +0000728 result.set_size(size);
David Blaikie18544b92012-02-09 19:24:12 +0000729 return error_code::success();
Michael J. Spenceree1699c2011-01-15 18:52:33 +0000730}
731
Nick Kledzik18497e92012-06-20 00:28:54 +0000732error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
733 bool map_writable, void *&result) {
734 SmallString<128> path_storage;
735 StringRef name = path.toNullTerminatedStringRef(path_storage);
736 int oflags = map_writable ? O_RDWR : O_RDONLY;
737 int ofd = ::open(name.begin(), oflags);
738 if ( ofd == -1 )
739 return error_code(errno, system_category());
740 AutoFD fd(ofd);
741 int flags = map_writable ? MAP_SHARED : MAP_PRIVATE;
742 int prot = map_writable ? (PROT_READ|PROT_WRITE) : PROT_READ;
743#ifdef MAP_FILE
744 flags |= MAP_FILE;
745#endif
746 result = ::mmap(0, size, prot, flags, fd, file_offset);
747 if (result == MAP_FAILED) {
748 return error_code(errno, system_category());
749 }
750
751 return error_code::success();
752}
753
754error_code unmap_file_pages(void *base, size_t size) {
755 if ( ::munmap(base, size) == -1 )
756 return error_code(errno, system_category());
757
758 return error_code::success();
759}
760
Rafael Espindolaa0d9b6b2013-07-17 14:58:25 +0000761error_code openFileForRead(const Twine &Name, int &ResultFD) {
762 SmallString<128> Storage;
763 StringRef P = Name.toNullTerminatedStringRef(Storage);
764 while ((ResultFD = open(P.begin(), O_RDONLY)) < 0) {
765 if (errno != EINTR)
766 return error_code(errno, system_category());
767 }
768 return error_code::success();
769}
Nick Kledzik18497e92012-06-20 00:28:54 +0000770
Rafael Espindola67080ce2013-07-19 15:02:03 +0000771error_code openFileForWrite(const Twine &Name, int &ResultFD,
772 sys::fs::OpenFlags Flags, unsigned Mode) {
773 // Verify that we don't have both "append" and "excl".
774 assert((!(Flags & sys::fs::F_Excl) || !(Flags & sys::fs::F_Append)) &&
775 "Cannot specify both 'excl' and 'append' file creation flags!");
776
777 int OpenFlags = O_WRONLY | O_CREAT;
778
779 if (Flags & F_Append)
780 OpenFlags |= O_APPEND;
781 else
782 OpenFlags |= O_TRUNC;
783
784 if (Flags & F_Excl)
785 OpenFlags |= O_EXCL;
786
787 SmallString<128> Storage;
788 StringRef P = Name.toNullTerminatedStringRef(Storage);
789 while ((ResultFD = open(P.begin(), OpenFlags, Mode)) < 0) {
790 if (errno != EINTR)
791 return error_code(errno, system_category());
792 }
793 return error_code::success();
794}
795
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +0000796} // end namespace fs
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000797} // end namespace sys
798} // end namespace llvm