blob: 94f872077a5a2ad51afbac3d76ae8944e88dfba2 [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"
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +000021#if HAVE_SYS_STAT_H
22#include <sys/stat.h>
23#endif
24#if HAVE_FCNTL_H
25#include <fcntl.h>
26#endif
Nick Kledzik18497e92012-06-20 00:28:54 +000027#ifdef HAVE_SYS_MMAN_H
28#include <sys/mman.h>
29#endif
Michael J. Spencer52714862011-01-05 16:38:57 +000030#if HAVE_DIRENT_H
31# include <dirent.h>
32# define NAMLEN(dirent) strlen((dirent)->d_name)
33#else
34# define dirent direct
35# define NAMLEN(dirent) (dirent)->d_namlen
36# if HAVE_SYS_NDIR_H
37# include <sys/ndir.h>
38# endif
39# if HAVE_SYS_DIR_H
40# include <sys/dir.h>
41# endif
42# if HAVE_NDIR_H
43# include <ndir.h>
44# endif
45#endif
Michael J. Spencer45710402010-12-03 01:21:28 +000046#if HAVE_STDIO_H
47#include <stdio.h>
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +000048#endif
Bill Wendlingbdaa57f2011-09-14 21:49:42 +000049#if HAVE_LIMITS_H
50#include <limits.h>
51#endif
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +000052
Rafael Espindola4601c462013-06-26 05:25:44 +000053#ifdef __APPLE__
54#include <mach-o/dyld.h>
55#endif
56
Joerg Sonnenbergerc0697302012-08-10 10:56:09 +000057// Both stdio.h and cstdio are included via different pathes and
58// stdcxx's cstdio doesn't include stdio.h, so it doesn't #undef the macros
59// either.
60#undef ferror
61#undef feof
62
Sylvestre Ledru14ada942012-04-11 15:35:36 +000063// For GNU Hurd
64#if defined(__GNU__) && !defined(PATH_MAX)
65# define PATH_MAX 4096
66#endif
67
Michael J. Spencer45710402010-12-03 01:21:28 +000068using namespace llvm;
69
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +000070namespace {
Michael J. Spencer5529c572010-12-07 01:23:08 +000071 /// This class automatically closes the given file descriptor when it goes out
72 /// of scope. You can take back explicit ownership of the file descriptor by
73 /// calling take(). The destructor does not verify that close was successful.
74 /// Therefore, never allow this class to call close on a file descriptor that
75 /// has been read from or written to.
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +000076 struct AutoFD {
77 int FileDescriptor;
78
79 AutoFD(int fd) : FileDescriptor(fd) {}
80 ~AutoFD() {
81 if (FileDescriptor >= 0)
82 ::close(FileDescriptor);
83 }
84
85 int take() {
86 int ret = FileDescriptor;
87 FileDescriptor = -1;
88 return ret;
89 }
90
91 operator int() const {return FileDescriptor;}
92 };
Michael J. Spencer45710402010-12-03 01:21:28 +000093
94 error_code TempDir(SmallVectorImpl<char> &result) {
95 // FIXME: Don't use TMPDIR if program is SUID or SGID enabled.
96 const char *dir = 0;
97 (dir = std::getenv("TMPDIR" )) ||
98 (dir = std::getenv("TMP" )) ||
99 (dir = std::getenv("TEMP" )) ||
100 (dir = std::getenv("TEMPDIR")) ||
101#ifdef P_tmpdir
102 (dir = P_tmpdir) ||
103#endif
104 (dir = "/tmp");
105
Michael J. Spencer98c7a112010-12-07 01:23:19 +0000106 result.clear();
Michael J. Spencer45710402010-12-03 01:21:28 +0000107 StringRef d(dir);
108 result.append(d.begin(), d.end());
David Blaikie18544b92012-02-09 19:24:12 +0000109 return error_code::success();
Michael J. Spencer45710402010-12-03 01:21:28 +0000110 }
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +0000111}
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000112
113namespace llvm {
114namespace sys {
Michael J. Spencer20daa282010-12-07 01:22:31 +0000115namespace fs {
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000116#if defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
117 defined(__OpenBSD__) || defined(__minix) || defined(__FreeBSD_kernel__) || \
118 defined(__linux__) || defined(__CYGWIN__)
119static int
120test_dir(char buf[PATH_MAX], char ret[PATH_MAX],
121 const char *dir, const char *bin)
122{
123 struct stat sb;
124
125 snprintf(buf, PATH_MAX, "%s/%s", dir, bin);
126 if (realpath(buf, ret) == NULL)
127 return (1);
128 if (stat(buf, &sb) != 0)
129 return (1);
130
131 return (0);
132}
133
134static char *
135getprogpath(char ret[PATH_MAX], const char *bin)
136{
137 char *pv, *s, *t, buf[PATH_MAX];
138
139 /* First approach: absolute path. */
140 if (bin[0] == '/') {
141 if (test_dir(buf, ret, "/", bin) == 0)
142 return (ret);
143 return (NULL);
144 }
145
146 /* Second approach: relative path. */
147 if (strchr(bin, '/') != NULL) {
148 if (getcwd(buf, PATH_MAX) == NULL)
149 return (NULL);
150 if (test_dir(buf, ret, buf, bin) == 0)
151 return (ret);
152 return (NULL);
153 }
154
155 /* Third approach: $PATH */
156 if ((pv = getenv("PATH")) == NULL)
157 return (NULL);
158 s = pv = strdup(pv);
159 if (pv == NULL)
160 return (NULL);
161 while ((t = strsep(&s, ":")) != NULL) {
162 if (test_dir(buf, ret, t, bin) == 0) {
163 free(pv);
164 return (ret);
165 }
166 }
167 free(pv);
168 return (NULL);
169}
170#endif // __FreeBSD__ || __NetBSD__ || __FreeBSD_kernel__
171
172/// GetMainExecutable - Return the path to the main executable, given the
173/// value of argv[0] from program startup.
174std::string getMainExecutable(const char *argv0, void *MainAddr) {
175#if defined(__APPLE__)
176 // On OS X the executable path is saved to the stack by dyld. Reading it
177 // from there is much faster than calling dladdr, especially for large
178 // binaries with symbols.
179 char exe_path[MAXPATHLEN];
180 uint32_t size = sizeof(exe_path);
181 if (_NSGetExecutablePath(exe_path, &size) == 0) {
182 char link_path[MAXPATHLEN];
183 if (realpath(exe_path, link_path))
Rafael Espindola4601c462013-06-26 05:25:44 +0000184 return link_path;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000185 }
186#elif defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
187 defined(__OpenBSD__) || defined(__minix) || defined(__FreeBSD_kernel__)
188 char exe_path[PATH_MAX];
189
190 if (getprogpath(exe_path, argv0) != NULL)
Rafael Espindola2c6f4fe2013-06-26 06:10:32 +0000191 return exe_path;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000192#elif defined(__linux__) || defined(__CYGWIN__)
193 char exe_path[MAXPATHLEN];
194 StringRef aPath("/proc/self/exe");
195 if (sys::fs::exists(aPath)) {
196 // /proc is not always mounted under Linux (chroot for example).
197 ssize_t len = readlink(aPath.str().c_str(), exe_path, sizeof(exe_path));
198 if (len >= 0)
199 return StringRef(exe_path, len);
200 } else {
201 // Fall back to the classical detection.
202 if (getprogpath(exe_path, argv0) != NULL)
203 return exe_path;
204 }
205#elif defined(HAVE_DLFCN_H)
206 // Use dladdr to get executable path if available.
207 Dl_info DLInfo;
208 int err = dladdr(MainAddr, &DLInfo);
209 if (err == 0)
Rafael Espindola2c6f4fe2013-06-26 06:10:32 +0000210 return "";
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000211
212 // If the filename is a symlink, we need to resolve and return the location of
213 // the actual executable.
214 char link_path[MAXPATHLEN];
215 if (realpath(DLInfo.dli_fname, link_path))
Rafael Espindola2c6f4fe2013-06-26 06:10:32 +0000216 return link_path;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000217#else
218#error GetMainExecutable is not implemented on this host yet.
219#endif
220 return "";
221}
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000222
Rafael Espindolabe3ede72013-06-20 21:51:49 +0000223TimeValue file_status::getLastModificationTime() const {
Rafael Espindoladb5d8fe2013-06-20 18:42:04 +0000224 TimeValue Ret;
225 Ret.fromEpochTime(fs_st_mtime);
226 return Ret;
227}
228
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000229error_code current_path(SmallVectorImpl<char> &result) {
Sylvestre Ledru14ada942012-04-11 15:35:36 +0000230#ifdef MAXPATHLEN
Andrew Tricka4ec5b22011-03-24 16:43:37 +0000231 result.reserve(MAXPATHLEN);
Sylvestre Ledru14ada942012-04-11 15:35:36 +0000232#else
233// For GNU Hurd
234 result.reserve(1024);
235#endif
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000236
Michael J. Spencer20daa282010-12-07 01:22:31 +0000237 while (true) {
238 if (::getcwd(result.data(), result.capacity()) == 0) {
239 // See if there was a real error.
240 if (errno != errc::not_enough_memory)
241 return error_code(errno, system_category());
242 // Otherwise there just wasn't enough space.
243 result.reserve(result.capacity() * 2);
244 } else
245 break;
246 }
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000247
248 result.set_size(strlen(result.data()));
David Blaikie18544b92012-02-09 19:24:12 +0000249 return error_code::success();
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000250}
251
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +0000252error_code copy_file(const Twine &from, const Twine &to, copy_option copt) {
253 // Get arguments.
254 SmallString<128> from_storage;
255 SmallString<128> to_storage;
Michael J. Spencer795adf52010-12-01 20:37:42 +0000256 StringRef f = from.toNullTerminatedStringRef(from_storage);
257 StringRef t = to.toNullTerminatedStringRef(to_storage);
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +0000258
259 const size_t buf_sz = 32768;
260 char buffer[buf_sz];
261 int from_file = -1, to_file = -1;
262
263 // Open from.
264 if ((from_file = ::open(f.begin(), O_RDONLY)) < 0)
265 return error_code(errno, system_category());
266 AutoFD from_fd(from_file);
267
268 // Stat from.
269 struct stat from_stat;
270 if (::stat(f.begin(), &from_stat) != 0)
271 return error_code(errno, system_category());
272
273 // Setup to flags.
274 int to_flags = O_CREAT | O_WRONLY;
275 if (copt == copy_option::fail_if_exists)
276 to_flags |= O_EXCL;
277
278 // Open to.
279 if ((to_file = ::open(t.begin(), to_flags, from_stat.st_mode)) < 0)
280 return error_code(errno, system_category());
281 AutoFD to_fd(to_file);
282
283 // Copy!
284 ssize_t sz, sz_read = 1, sz_write;
285 while (sz_read > 0 &&
286 (sz_read = ::read(from_fd, buffer, buf_sz)) > 0) {
287 // Allow for partial writes - see Advanced Unix Programming (2nd Ed.),
288 // Marc Rochkind, Addison-Wesley, 2004, page 94
289 sz_write = 0;
290 do {
291 if ((sz = ::write(to_fd, buffer + sz_write, sz_read - sz_write)) < 0) {
292 sz_read = sz; // cause read loop termination.
293 break; // error.
294 }
295 sz_write += sz;
296 } while (sz_write < sz_read);
297 }
298
299 // After all the file operations above the return value of close actually
300 // matters.
301 if (::close(from_fd.take()) < 0) sz_read = -1;
302 if (::close(to_fd.take()) < 0) sz_read = -1;
303
304 // Check for errors.
305 if (sz_read < 0)
306 return error_code(errno, system_category());
307
David Blaikie18544b92012-02-09 19:24:12 +0000308 return error_code::success();
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +0000309}
310
Michael J. Spencer31e310c2010-12-03 05:42:11 +0000311error_code create_directory(const Twine &path, bool &existed) {
312 SmallString<128> path_storage;
313 StringRef p = path.toNullTerminatedStringRef(path_storage);
314
Michael J. Spencere5755be2010-12-07 01:23:29 +0000315 if (::mkdir(p.begin(), S_IRWXU | S_IRWXG) == -1) {
Michael J. Spencer66a1f862010-12-04 18:45:32 +0000316 if (errno != errc::file_exists)
Michael J. Spencer31e310c2010-12-03 05:42:11 +0000317 return error_code(errno, system_category());
318 existed = true;
319 } else
320 existed = false;
321
David Blaikie18544b92012-02-09 19:24:12 +0000322 return error_code::success();
Michael J. Spencer31e310c2010-12-03 05:42:11 +0000323}
324
Michael J. Spencere0c45602010-12-03 05:58:41 +0000325error_code create_hard_link(const Twine &to, const Twine &from) {
326 // Get arguments.
327 SmallString<128> from_storage;
328 SmallString<128> to_storage;
329 StringRef f = from.toNullTerminatedStringRef(from_storage);
330 StringRef t = to.toNullTerminatedStringRef(to_storage);
331
332 if (::link(t.begin(), f.begin()) == -1)
333 return error_code(errno, system_category());
334
David Blaikie18544b92012-02-09 19:24:12 +0000335 return error_code::success();
Michael J. Spencere0c45602010-12-03 05:58:41 +0000336}
337
Michael J. Spencer7ee6d5d2010-12-03 07:41:25 +0000338error_code create_symlink(const Twine &to, const Twine &from) {
339 // Get arguments.
340 SmallString<128> from_storage;
341 SmallString<128> to_storage;
342 StringRef f = from.toNullTerminatedStringRef(from_storage);
343 StringRef t = to.toNullTerminatedStringRef(to_storage);
344
345 if (::symlink(t.begin(), f.begin()) == -1)
346 return error_code(errno, system_category());
347
David Blaikie18544b92012-02-09 19:24:12 +0000348 return error_code::success();
Michael J. Spencer7ee6d5d2010-12-03 07:41:25 +0000349}
350
Michael J. Spencer6e74e112010-12-03 17:53:43 +0000351error_code remove(const Twine &path, bool &existed) {
352 SmallString<128> path_storage;
353 StringRef p = path.toNullTerminatedStringRef(path_storage);
354
Rafael Espindola8cd62b02013-06-17 20:35:51 +0000355 struct stat buf;
356 if (stat(p.begin(), &buf) != 0) {
357 if (errno != errc::no_such_file_or_directory)
358 return error_code(errno, system_category());
359 existed = false;
360 return error_code::success();
361 }
362
363 // Note: this check catches strange situations. In all cases, LLVM should
364 // only be involved in the creation and deletion of regular files. This
365 // check ensures that what we're trying to erase is a regular file. It
366 // effectively prevents LLVM from erasing things like /dev/null, any block
367 // special file, or other things that aren't "regular" files.
368 if (!S_ISREG(buf.st_mode) && !S_ISDIR(buf.st_mode))
369 return make_error_code(errc::operation_not_permitted);
370
Michael J. Spencer6e74e112010-12-03 17:53:43 +0000371 if (::remove(p.begin()) == -1) {
Michael J. Spencer66a1f862010-12-04 18:45:32 +0000372 if (errno != errc::no_such_file_or_directory)
Michael J. Spencer6e74e112010-12-03 17:53:43 +0000373 return error_code(errno, system_category());
374 existed = false;
375 } else
376 existed = true;
377
David Blaikie18544b92012-02-09 19:24:12 +0000378 return error_code::success();
Michael J. Spencer6e74e112010-12-03 17:53:43 +0000379}
380
Michael J. Spencer409f5562010-12-03 17:53:55 +0000381error_code rename(const Twine &from, const Twine &to) {
382 // Get arguments.
383 SmallString<128> from_storage;
384 SmallString<128> to_storage;
385 StringRef f = from.toNullTerminatedStringRef(from_storage);
386 StringRef t = to.toNullTerminatedStringRef(to_storage);
387
Michael J. Spencerec202ee2011-01-16 22:18:41 +0000388 if (::rename(f.begin(), t.begin()) == -1) {
389 // If it's a cross device link, copy then delete, otherwise return the error
390 if (errno == EXDEV) {
391 if (error_code ec = copy_file(from, to, copy_option::overwrite_if_exists))
392 return ec;
393 bool Existed;
394 if (error_code ec = remove(from, Existed))
395 return ec;
396 } else
397 return error_code(errno, system_category());
398 }
Michael J. Spencer409f5562010-12-03 17:53:55 +0000399
David Blaikie18544b92012-02-09 19:24:12 +0000400 return error_code::success();
Michael J. Spencer409f5562010-12-03 17:53:55 +0000401}
402
Michael J. Spencerc20a0322010-12-03 17:54:07 +0000403error_code resize_file(const Twine &path, uint64_t size) {
404 SmallString<128> path_storage;
405 StringRef p = path.toNullTerminatedStringRef(path_storage);
406
407 if (::truncate(p.begin(), size) == -1)
408 return error_code(errno, system_category());
409
David Blaikie18544b92012-02-09 19:24:12 +0000410 return error_code::success();
Michael J. Spencerc20a0322010-12-03 17:54:07 +0000411}
412
Michael J. Spencer45710402010-12-03 01:21:28 +0000413error_code exists(const Twine &path, bool &result) {
414 SmallString<128> path_storage;
415 StringRef p = path.toNullTerminatedStringRef(path_storage);
416
Benjamin Kramer172f8082012-06-02 16:28:09 +0000417 if (::access(p.begin(), F_OK) == -1) {
Michael J. Spencer66a1f862010-12-04 18:45:32 +0000418 if (errno != errc::no_such_file_or_directory)
Michael J. Spencer45710402010-12-03 01:21:28 +0000419 return error_code(errno, system_category());
420 result = false;
421 } else
422 result = true;
423
David Blaikie18544b92012-02-09 19:24:12 +0000424 return error_code::success();
Michael J. Spencer45710402010-12-03 01:21:28 +0000425}
426
Rafael Espindolaa1280c12013-06-18 20:56:38 +0000427bool can_write(const Twine &Path) {
428 SmallString<128> PathStorage;
429 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
430 return 0 == access(P.begin(), W_OK);
431}
432
Rafael Espindolab0a5c962013-06-14 19:38:45 +0000433bool can_execute(const Twine &Path) {
434 SmallString<128> PathStorage;
435 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
436
Manuel Klimek52772bf2013-06-17 10:48:34 +0000437 if (0 != access(P.begin(), R_OK | X_OK))
438 return false;
439 struct stat buf;
440 if (0 != stat(P.begin(), &buf))
441 return false;
442 if (!S_ISREG(buf.st_mode))
443 return false;
444 return true;
Rafael Espindolab0a5c962013-06-14 19:38:45 +0000445}
446
Michael J. Spencer203d7802011-12-12 06:04:28 +0000447bool equivalent(file_status A, file_status B) {
448 assert(status_known(A) && status_known(B));
Sylvestre Ledru3099f4bd2012-04-23 16:37:23 +0000449 return A.fs_st_dev == B.fs_st_dev &&
450 A.fs_st_ino == B.fs_st_ino;
Michael J. Spencer203d7802011-12-12 06:04:28 +0000451}
452
Michael J. Spencer376d3872010-12-03 18:49:13 +0000453error_code equivalent(const Twine &A, const Twine &B, bool &result) {
Michael J. Spencer203d7802011-12-12 06:04:28 +0000454 file_status fsA, fsB;
455 if (error_code ec = status(A, fsA)) return ec;
456 if (error_code ec = status(B, fsB)) return ec;
457 result = equivalent(fsA, fsB);
David Blaikie18544b92012-02-09 19:24:12 +0000458 return error_code::success();
Michael J. Spencer376d3872010-12-03 18:49:13 +0000459}
460
Michael J. Spencer818ab4a2010-12-04 00:31:48 +0000461error_code file_size(const Twine &path, uint64_t &result) {
462 SmallString<128> path_storage;
463 StringRef p = path.toNullTerminatedStringRef(path_storage);
464
465 struct stat status;
466 if (::stat(p.begin(), &status) == -1)
467 return error_code(errno, system_category());
468 if (!S_ISREG(status.st_mode))
Michael J. Spencer66a1f862010-12-04 18:45:32 +0000469 return make_error_code(errc::operation_not_permitted);
Michael J. Spencer818ab4a2010-12-04 00:31:48 +0000470
471 result = status.st_size;
David Blaikie18544b92012-02-09 19:24:12 +0000472 return error_code::success();
Michael J. Spencer818ab4a2010-12-04 00:31:48 +0000473}
474
Rafael Espindola7cf7c512013-06-20 15:06:35 +0000475error_code getUniqueID(const Twine Path, uint64_t &Result) {
Rafael Espindola45e6c242013-06-18 19:34:49 +0000476 SmallString<128> Storage;
477 StringRef P = Path.toNullTerminatedStringRef(Storage);
478
479 struct stat Status;
480 if (::stat(P.begin(), &Status) != 0)
481 return error_code(errno, system_category());
482
483 Result = Status.st_ino;
484 return error_code::success();
485}
486
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000487error_code status(const Twine &path, file_status &result) {
488 SmallString<128> path_storage;
489 StringRef p = path.toNullTerminatedStringRef(path_storage);
490
491 struct stat status;
492 if (::stat(p.begin(), &status) != 0) {
493 error_code ec(errno, system_category());
494 if (ec == errc::no_such_file_or_directory)
495 result = file_status(file_type::file_not_found);
496 else
497 result = file_status(file_type::status_error);
498 return ec;
499 }
500
Nick Kledzik18497e92012-06-20 00:28:54 +0000501 perms prms = static_cast<perms>(status.st_mode & perms_mask);
502
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000503 if (S_ISDIR(status.st_mode))
Nick Kledzik18497e92012-06-20 00:28:54 +0000504 result = file_status(file_type::directory_file, prms);
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000505 else if (S_ISREG(status.st_mode))
Nick Kledzik18497e92012-06-20 00:28:54 +0000506 result = file_status(file_type::regular_file, prms);
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000507 else if (S_ISBLK(status.st_mode))
Nick Kledzik18497e92012-06-20 00:28:54 +0000508 result = file_status(file_type::block_file, prms);
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000509 else if (S_ISCHR(status.st_mode))
Nick Kledzik18497e92012-06-20 00:28:54 +0000510 result = file_status(file_type::character_file, prms);
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000511 else if (S_ISFIFO(status.st_mode))
Nick Kledzik18497e92012-06-20 00:28:54 +0000512 result = file_status(file_type::fifo_file, prms);
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000513 else if (S_ISSOCK(status.st_mode))
Nick Kledzik18497e92012-06-20 00:28:54 +0000514 result = file_status(file_type::socket_file, prms);
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000515 else
Nick Kledzik18497e92012-06-20 00:28:54 +0000516 result = file_status(file_type::type_unknown, prms);
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000517
Sylvestre Ledru3099f4bd2012-04-23 16:37:23 +0000518 result.fs_st_dev = status.st_dev;
519 result.fs_st_ino = status.st_ino;
Rafael Espindoladb5d8fe2013-06-20 18:42:04 +0000520 result.fs_st_mtime = status.st_mtime;
Rafael Espindolae34d6a52013-06-20 22:02:10 +0000521 result.fs_st_uid = status.st_uid;
522 result.fs_st_gid = status.st_gid;
Michael J. Spencer203d7802011-12-12 06:04:28 +0000523
David Blaikie18544b92012-02-09 19:24:12 +0000524 return error_code::success();
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000525}
526
Nick Kledzik18497e92012-06-20 00:28:54 +0000527// Modifies permissions on a file.
528error_code permissions(const Twine &path, perms prms) {
529 if ((prms & add_perms) && (prms & remove_perms))
530 llvm_unreachable("add_perms and remove_perms are mutually exclusive");
531
532 // Get current permissions
Rafael Espindola1efb69c2013-06-20 22:07:53 +0000533 // FIXME: We only need this stat for add_perms and remove_perms.
Nick Kledzik18497e92012-06-20 00:28:54 +0000534 file_status info;
535 if (error_code ec = status(path, info)) {
536 return ec;
537 }
538
539 // Set updated permissions.
540 SmallString<128> path_storage;
541 StringRef p = path.toNullTerminatedStringRef(path_storage);
542 perms permsToSet;
543 if (prms & add_perms) {
544 permsToSet = (info.permissions() | prms) & perms_mask;
545 } else if (prms & remove_perms) {
546 permsToSet = (info.permissions() & ~prms) & perms_mask;
547 } else {
548 permsToSet = prms & perms_mask;
549 }
550 if (::chmod(p.begin(), static_cast<mode_t>(permsToSet))) {
551 return error_code(errno, system_category());
552 }
553
554 return error_code::success();
555}
556
Rafael Espindola4a3365c2013-06-20 20:56:14 +0000557error_code setLastModificationAndAccessTime(int FD, TimeValue Time) {
558 timeval Times[2];
559 Times[0].tv_sec = Time.toPosixTime();
560 Times[0].tv_usec = 0;
561 Times[1] = Times[0];
562 if (::futimes(FD, Times))
563 return error_code(errno, system_category());
564 return error_code::success();
565}
566
Michael J. Spencer45710402010-12-03 01:21:28 +0000567error_code unique_file(const Twine &model, int &result_fd,
Eric Christopherb6148ed2012-05-11 00:07:44 +0000568 SmallVectorImpl<char> &result_path,
569 bool makeAbsolute, unsigned mode) {
Michael J. Spencer45710402010-12-03 01:21:28 +0000570 SmallString<128> Model;
571 model.toVector(Model);
572 // Null terminate.
573 Model.c_str();
574
Argyrios Kyrtzidis348937d2011-07-28 00:29:20 +0000575 if (makeAbsolute) {
576 // Make model absolute by prepending a temp directory if it's not already.
577 bool absolute = path::is_absolute(Twine(Model));
578 if (!absolute) {
579 SmallString<128> TDir;
580 if (error_code ec = TempDir(TDir)) return ec;
581 path::append(TDir, Twine(Model));
582 Model.swap(TDir);
583 }
Michael J. Spencer45710402010-12-03 01:21:28 +0000584 }
585
Daniel Dunbar58ed0c62012-05-05 16:39:22 +0000586 // From here on, DO NOT modify model. It may be needed if the randomly chosen
587 // path already exists.
Daniel Dunbar3f0fa192012-05-05 16:36:24 +0000588 SmallString<128> RandomPath = Model;
Michael J. Spencer45710402010-12-03 01:21:28 +0000589
590retry_random_path:
Daniel Dunbar58ed0c62012-05-05 16:39:22 +0000591 // Replace '%' with random chars.
Daniel Dunbar3f0fa192012-05-05 16:36:24 +0000592 for (unsigned i = 0, e = Model.size(); i != e; ++i) {
593 if (Model[i] == '%')
594 RandomPath[i] = "0123456789abcdef"[sys::Process::GetRandomNumber() & 15];
Michael J. Spencer45710402010-12-03 01:21:28 +0000595 }
596
Argyrios Kyrtzidiseed2dc52013-02-28 00:38:19 +0000597 // Make sure we don't fall into an infinite loop by constantly trying
598 // to create the parent path.
599 bool TriedToCreateParent = false;
600
Michael J. Spencer45710402010-12-03 01:21:28 +0000601 // Try to open + create the file.
602rety_open_create:
Eric Christopherb6148ed2012-05-11 00:07:44 +0000603 int RandomFD = ::open(RandomPath.c_str(), O_RDWR | O_CREAT | O_EXCL, mode);
Michael J. Spencer45710402010-12-03 01:21:28 +0000604 if (RandomFD == -1) {
Douglas Gregor95585ab2013-01-10 01:58:46 +0000605 int SavedErrno = errno;
Michael J. Spencer45710402010-12-03 01:21:28 +0000606 // If the file existed, try again, otherwise, error.
Douglas Gregor95585ab2013-01-10 01:58:46 +0000607 if (SavedErrno == errc::file_exists)
Michael J. Spencer45710402010-12-03 01:21:28 +0000608 goto retry_random_path;
Daniel Dunbar61d59f22012-11-15 20:24:52 +0000609 // If path prefix doesn't exist, try to create it.
Douglas Gregor6bd4d8c2013-04-05 20:48:36 +0000610 if (SavedErrno == errc::no_such_file_or_directory && !TriedToCreateParent) {
Argyrios Kyrtzidiseed2dc52013-02-28 00:38:19 +0000611 TriedToCreateParent = true;
Daniel Dunbar61d59f22012-11-15 20:24:52 +0000612 StringRef p(RandomPath);
Michael J. Spencer45710402010-12-03 01:21:28 +0000613 SmallString<64> dir_to_create;
614 for (path::const_iterator i = path::begin(p),
615 e = --path::end(p); i != e; ++i) {
Michael J. Spencer1e090f02010-12-07 03:57:37 +0000616 path::append(dir_to_create, *i);
Michael J. Spencer45710402010-12-03 01:21:28 +0000617 bool Exists;
618 if (error_code ec = exists(Twine(dir_to_create), Exists)) return ec;
619 if (!Exists) {
620 // Don't try to create network paths.
621 if (i->size() > 2 && (*i)[0] == '/' &&
622 (*i)[1] == '/' &&
623 (*i)[2] != '/')
Michael J. Spencer66a1f862010-12-04 18:45:32 +0000624 return make_error_code(errc::no_such_file_or_directory);
Douglas Gregor95585ab2013-01-10 01:58:46 +0000625 if (::mkdir(dir_to_create.c_str(), 0700) == -1 &&
626 errno != errc::file_exists)
Michael J. Spencer45710402010-12-03 01:21:28 +0000627 return error_code(errno, system_category());
628 }
629 }
630 goto rety_open_create;
631 }
Douglas Gregor95585ab2013-01-10 01:58:46 +0000632
633 return error_code(SavedErrno, system_category());
Michael J. Spencer45710402010-12-03 01:21:28 +0000634 }
635
Michael J. Spencer66a1f862010-12-04 18:45:32 +0000636 // Make the path absolute.
Andrew Tricka4ec5b22011-03-24 16:43:37 +0000637 char real_path_buff[PATH_MAX + 1];
638 if (realpath(RandomPath.c_str(), real_path_buff) == NULL) {
639 int error = errno;
Michael J. Spencer45710402010-12-03 01:21:28 +0000640 ::close(RandomFD);
641 ::unlink(RandomPath.c_str());
Andrew Tricka4ec5b22011-03-24 16:43:37 +0000642 return error_code(error, system_category());
Michael J. Spencer45710402010-12-03 01:21:28 +0000643 }
644
Andrew Tricka4ec5b22011-03-24 16:43:37 +0000645 result_path.clear();
646 StringRef d(real_path_buff);
647 result_path.append(d.begin(), d.end());
648
Michael J. Spencer45710402010-12-03 01:21:28 +0000649 result_fd = RandomFD;
David Blaikie18544b92012-02-09 19:24:12 +0000650 return error_code::success();
Michael J. Spencer45710402010-12-03 01:21:28 +0000651}
652
Michael J. Spencer42ad29f2013-03-14 00:20:10 +0000653error_code mapped_file_region::init(int FD, bool CloseFD, uint64_t Offset) {
654 AutoFD ScopedFD(FD);
655 if (!CloseFD)
656 ScopedFD.take();
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000657
658 // Figure out how large the file is.
659 struct stat FileInfo;
Michael J. Spencer42ad29f2013-03-14 00:20:10 +0000660 if (fstat(FD, &FileInfo) == -1)
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000661 return error_code(errno, system_category());
662 uint64_t FileSize = FileInfo.st_size;
663
664 if (Size == 0)
665 Size = FileSize;
666 else if (FileSize < Size) {
667 // We need to grow the file.
Michael J. Spencer42ad29f2013-03-14 00:20:10 +0000668 if (ftruncate(FD, Size) == -1)
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000669 return error_code(errno, system_category());
670 }
671
672 int flags = (Mode == readwrite) ? MAP_SHARED : MAP_PRIVATE;
673 int prot = (Mode == readonly) ? PROT_READ : (PROT_READ | PROT_WRITE);
674#ifdef MAP_FILE
675 flags |= MAP_FILE;
676#endif
Michael J. Spencer42ad29f2013-03-14 00:20:10 +0000677 Mapping = ::mmap(0, Size, prot, flags, FD, Offset);
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000678 if (Mapping == MAP_FAILED)
679 return error_code(errno, system_category());
680 return error_code::success();
681}
682
683mapped_file_region::mapped_file_region(const Twine &path,
684 mapmode mode,
685 uint64_t length,
686 uint64_t offset,
687 error_code &ec)
688 : Mode(mode)
689 , Size(length)
690 , Mapping() {
691 // Make sure that the requested size fits within SIZE_T.
692 if (length > std::numeric_limits<size_t>::max()) {
693 ec = make_error_code(errc::invalid_argument);
694 return;
695 }
696
697 SmallString<128> path_storage;
698 StringRef name = path.toNullTerminatedStringRef(path_storage);
699 int oflags = (mode == readonly) ? O_RDONLY : O_RDWR;
700 int ofd = ::open(name.begin(), oflags);
701 if (ofd == -1) {
702 ec = error_code(errno, system_category());
703 return;
704 }
705
Michael J. Spencer42ad29f2013-03-14 00:20:10 +0000706 ec = init(ofd, true, offset);
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000707 if (ec)
708 Mapping = 0;
709}
710
711mapped_file_region::mapped_file_region(int fd,
Michael J. Spencer42ad29f2013-03-14 00:20:10 +0000712 bool closefd,
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000713 mapmode mode,
714 uint64_t length,
715 uint64_t offset,
716 error_code &ec)
717 : Mode(mode)
718 , Size(length)
719 , Mapping() {
720 // Make sure that the requested size fits within SIZE_T.
721 if (length > std::numeric_limits<size_t>::max()) {
722 ec = make_error_code(errc::invalid_argument);
723 return;
724 }
725
Michael J. Spencer42ad29f2013-03-14 00:20:10 +0000726 ec = init(fd, closefd, offset);
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000727 if (ec)
728 Mapping = 0;
729}
730
731mapped_file_region::~mapped_file_region() {
732 if (Mapping)
733 ::munmap(Mapping, Size);
734}
735
Chandler Carruthf12e3a62012-11-30 11:45:22 +0000736#if LLVM_HAS_RVALUE_REFERENCES
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000737mapped_file_region::mapped_file_region(mapped_file_region &&other)
738 : Mode(other.Mode), Size(other.Size), Mapping(other.Mapping) {
739 other.Mapping = 0;
740}
741#endif
742
743mapped_file_region::mapmode mapped_file_region::flags() const {
744 assert(Mapping && "Mapping failed but used anyway!");
745 return Mode;
746}
747
748uint64_t mapped_file_region::size() const {
749 assert(Mapping && "Mapping failed but used anyway!");
750 return Size;
751}
752
753char *mapped_file_region::data() const {
754 assert(Mapping && "Mapping failed but used anyway!");
755 assert(Mode != readonly && "Cannot get non const data for readonly mapping!");
756 return reinterpret_cast<char*>(Mapping);
757}
758
759const char *mapped_file_region::const_data() const {
760 assert(Mapping && "Mapping failed but used anyway!");
761 return reinterpret_cast<const char*>(Mapping);
762}
763
764int mapped_file_region::alignment() {
Chandler Carruthacd64be2012-12-31 23:31:56 +0000765 return process::get_self()->page_size();
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000766}
767
Michael J. Spencer0a7625d2011-12-08 22:50:09 +0000768error_code detail::directory_iterator_construct(detail::DirIterState &it,
769 StringRef path){
Michael J. Spencer52714862011-01-05 16:38:57 +0000770 SmallString<128> path_null(path);
771 DIR *directory = ::opendir(path_null.c_str());
772 if (directory == 0)
773 return error_code(errno, system_category());
774
775 it.IterationHandle = reinterpret_cast<intptr_t>(directory);
776 // Add something for replace_filename to replace.
777 path::append(path_null, ".");
778 it.CurrentEntry = directory_entry(path_null.str());
779 return directory_iterator_increment(it);
780}
781
Michael J. Spencer0a7625d2011-12-08 22:50:09 +0000782error_code detail::directory_iterator_destruct(detail::DirIterState &it) {
Michael J. Spencer52714862011-01-05 16:38:57 +0000783 if (it.IterationHandle)
784 ::closedir(reinterpret_cast<DIR *>(it.IterationHandle));
785 it.IterationHandle = 0;
786 it.CurrentEntry = directory_entry();
David Blaikie18544b92012-02-09 19:24:12 +0000787 return error_code::success();
Michael J. Spencer52714862011-01-05 16:38:57 +0000788}
789
Michael J. Spencer0a7625d2011-12-08 22:50:09 +0000790error_code detail::directory_iterator_increment(detail::DirIterState &it) {
Michael J. Spencer52714862011-01-05 16:38:57 +0000791 errno = 0;
792 dirent *cur_dir = ::readdir(reinterpret_cast<DIR *>(it.IterationHandle));
793 if (cur_dir == 0 && errno != 0) {
794 return error_code(errno, system_category());
795 } else if (cur_dir != 0) {
796 StringRef name(cur_dir->d_name, NAMLEN(cur_dir));
797 if ((name.size() == 1 && name[0] == '.') ||
798 (name.size() == 2 && name[0] == '.' && name[1] == '.'))
799 return directory_iterator_increment(it);
800 it.CurrentEntry.replace_filename(name);
801 } else
802 return directory_iterator_destruct(it);
803
David Blaikie18544b92012-02-09 19:24:12 +0000804 return error_code::success();
Michael J. Spencer52714862011-01-05 16:38:57 +0000805}
806
Michael J. Spenceree1699c2011-01-15 18:52:33 +0000807error_code get_magic(const Twine &path, uint32_t len,
808 SmallVectorImpl<char> &result) {
809 SmallString<128> PathStorage;
810 StringRef Path = path.toNullTerminatedStringRef(PathStorage);
811 result.set_size(0);
812
813 // Open path.
814 std::FILE *file = std::fopen(Path.data(), "rb");
815 if (file == 0)
816 return error_code(errno, system_category());
817
818 // Reserve storage.
819 result.reserve(len);
820
821 // Read magic!
822 size_t size = std::fread(result.data(), 1, len, file);
823 if (std::ferror(file) != 0) {
824 std::fclose(file);
825 return error_code(errno, system_category());
Evgeniy Stepanov6eb44842013-06-20 15:56:05 +0000826 } else if (size != len) {
Michael J. Spenceree1699c2011-01-15 18:52:33 +0000827 if (std::feof(file) != 0) {
828 std::fclose(file);
829 result.set_size(size);
830 return make_error_code(errc::value_too_large);
831 }
832 }
833 std::fclose(file);
Evgeniy Stepanov6eb44842013-06-20 15:56:05 +0000834 result.set_size(size);
David Blaikie18544b92012-02-09 19:24:12 +0000835 return error_code::success();
Michael J. Spenceree1699c2011-01-15 18:52:33 +0000836}
837
Nick Kledzik18497e92012-06-20 00:28:54 +0000838error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
839 bool map_writable, void *&result) {
840 SmallString<128> path_storage;
841 StringRef name = path.toNullTerminatedStringRef(path_storage);
842 int oflags = map_writable ? O_RDWR : O_RDONLY;
843 int ofd = ::open(name.begin(), oflags);
844 if ( ofd == -1 )
845 return error_code(errno, system_category());
846 AutoFD fd(ofd);
847 int flags = map_writable ? MAP_SHARED : MAP_PRIVATE;
848 int prot = map_writable ? (PROT_READ|PROT_WRITE) : PROT_READ;
849#ifdef MAP_FILE
850 flags |= MAP_FILE;
851#endif
852 result = ::mmap(0, size, prot, flags, fd, file_offset);
853 if (result == MAP_FAILED) {
854 return error_code(errno, system_category());
855 }
856
857 return error_code::success();
858}
859
860error_code unmap_file_pages(void *base, size_t size) {
861 if ( ::munmap(base, size) == -1 )
862 return error_code(errno, system_category());
863
864 return error_code::success();
865}
866
867
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +0000868} // end namespace fs
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000869} // end namespace sys
870} // end namespace llvm