blob: e23e0bd6186e552886340e660aa349decff0cc3d [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
Rafael Espindolae79a8722013-06-28 03:48:47 +0000113static error_code createUniqueEntity(const Twine &Model, int &ResultFD,
114 SmallVectorImpl<char> &ResultPath,
115 bool MakeAbsolute, unsigned Mode,
116 FSEntity Type) {
117 SmallString<128> ModelStorage;
118 Model.toVector(ModelStorage);
119
120 if (MakeAbsolute) {
121 // Make model absolute by prepending a temp directory if it's not already.
122 bool absolute = sys::path::is_absolute(Twine(ModelStorage));
123 if (!absolute) {
124 SmallString<128> TDir;
125 if (error_code ec = TempDir(TDir)) return ec;
126 sys::path::append(TDir, Twine(ModelStorage));
127 ModelStorage.swap(TDir);
128 }
129 }
130
131 // From here on, DO NOT modify model. It may be needed if the randomly chosen
132 // path already exists.
133 ResultPath = ModelStorage;
134 // Null terminate.
135 ResultPath.push_back(0);
136 ResultPath.pop_back();
137
138retry_random_path:
139 // Replace '%' with random chars.
140 for (unsigned i = 0, e = ModelStorage.size(); i != e; ++i) {
141 if (ModelStorage[i] == '%')
142 ResultPath[i] = "0123456789abcdef"[sys::Process::GetRandomNumber() & 15];
143 }
144
145 // Try to open + create the file.
146 switch (Type) {
147 case FS_File: {
148 int RandomFD = ::open(ResultPath.begin(), O_RDWR | O_CREAT | O_EXCL, Mode);
149 if (RandomFD == -1) {
150 int SavedErrno = errno;
151 // If the file existed, try again, otherwise, error.
152 if (SavedErrno == errc::file_exists)
153 goto retry_random_path;
154 return error_code(SavedErrno, system_category());
155 }
156
157 ResultFD = RandomFD;
158 return error_code::success();
159 }
160
161 case FS_Name: {
162 bool Exists;
163 error_code EC = sys::fs::exists(ResultPath.begin(), Exists);
164 if (EC)
165 return EC;
166 if (Exists)
167 goto retry_random_path;
168 return error_code::success();
169 }
170
171 case FS_Dir: {
172 bool Existed;
173 error_code EC = sys::fs::create_directory(ResultPath.begin(), Existed);
174 if (EC)
175 return EC;
176 if (Existed)
177 goto retry_random_path;
178 return error_code::success();
179 }
180 }
Patrik Hagglunddcc336b2013-06-28 06:54:05 +0000181 llvm_unreachable("Invalid Type");
Rafael Espindolae79a8722013-06-28 03:48:47 +0000182}
183
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000184namespace llvm {
185namespace sys {
Michael J. Spencer20daa282010-12-07 01:22:31 +0000186namespace fs {
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000187#if defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
188 defined(__OpenBSD__) || defined(__minix) || defined(__FreeBSD_kernel__) || \
189 defined(__linux__) || defined(__CYGWIN__)
190static int
191test_dir(char buf[PATH_MAX], char ret[PATH_MAX],
192 const char *dir, const char *bin)
193{
194 struct stat sb;
195
196 snprintf(buf, PATH_MAX, "%s/%s", dir, bin);
197 if (realpath(buf, ret) == NULL)
198 return (1);
199 if (stat(buf, &sb) != 0)
200 return (1);
201
202 return (0);
203}
204
205static char *
206getprogpath(char ret[PATH_MAX], const char *bin)
207{
208 char *pv, *s, *t, buf[PATH_MAX];
209
210 /* First approach: absolute path. */
211 if (bin[0] == '/') {
212 if (test_dir(buf, ret, "/", bin) == 0)
213 return (ret);
214 return (NULL);
215 }
216
217 /* Second approach: relative path. */
218 if (strchr(bin, '/') != NULL) {
219 if (getcwd(buf, PATH_MAX) == NULL)
220 return (NULL);
221 if (test_dir(buf, ret, buf, bin) == 0)
222 return (ret);
223 return (NULL);
224 }
225
226 /* Third approach: $PATH */
227 if ((pv = getenv("PATH")) == NULL)
228 return (NULL);
229 s = pv = strdup(pv);
230 if (pv == NULL)
231 return (NULL);
232 while ((t = strsep(&s, ":")) != NULL) {
233 if (test_dir(buf, ret, t, bin) == 0) {
234 free(pv);
235 return (ret);
236 }
237 }
238 free(pv);
239 return (NULL);
240}
241#endif // __FreeBSD__ || __NetBSD__ || __FreeBSD_kernel__
242
243/// GetMainExecutable - Return the path to the main executable, given the
244/// value of argv[0] from program startup.
245std::string getMainExecutable(const char *argv0, void *MainAddr) {
246#if defined(__APPLE__)
247 // On OS X the executable path is saved to the stack by dyld. Reading it
248 // from there is much faster than calling dladdr, especially for large
249 // binaries with symbols.
250 char exe_path[MAXPATHLEN];
251 uint32_t size = sizeof(exe_path);
252 if (_NSGetExecutablePath(exe_path, &size) == 0) {
253 char link_path[MAXPATHLEN];
254 if (realpath(exe_path, link_path))
Rafael Espindola4601c462013-06-26 05:25:44 +0000255 return link_path;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000256 }
257#elif defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
258 defined(__OpenBSD__) || defined(__minix) || defined(__FreeBSD_kernel__)
259 char exe_path[PATH_MAX];
260
261 if (getprogpath(exe_path, argv0) != NULL)
Rafael Espindola2c6f4fe2013-06-26 06:10:32 +0000262 return exe_path;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000263#elif defined(__linux__) || defined(__CYGWIN__)
264 char exe_path[MAXPATHLEN];
265 StringRef aPath("/proc/self/exe");
266 if (sys::fs::exists(aPath)) {
267 // /proc is not always mounted under Linux (chroot for example).
268 ssize_t len = readlink(aPath.str().c_str(), exe_path, sizeof(exe_path));
269 if (len >= 0)
270 return StringRef(exe_path, len);
271 } else {
272 // Fall back to the classical detection.
273 if (getprogpath(exe_path, argv0) != NULL)
274 return exe_path;
275 }
276#elif defined(HAVE_DLFCN_H)
277 // Use dladdr to get executable path if available.
278 Dl_info DLInfo;
279 int err = dladdr(MainAddr, &DLInfo);
280 if (err == 0)
Rafael Espindola2c6f4fe2013-06-26 06:10:32 +0000281 return "";
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000282
283 // If the filename is a symlink, we need to resolve and return the location of
284 // the actual executable.
285 char link_path[MAXPATHLEN];
286 if (realpath(DLInfo.dli_fname, link_path))
Rafael Espindola2c6f4fe2013-06-26 06:10:32 +0000287 return link_path;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000288#else
289#error GetMainExecutable is not implemented on this host yet.
290#endif
291 return "";
292}
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000293
Rafael Espindolabe3ede72013-06-20 21:51:49 +0000294TimeValue file_status::getLastModificationTime() const {
Rafael Espindoladb5d8fe2013-06-20 18:42:04 +0000295 TimeValue Ret;
296 Ret.fromEpochTime(fs_st_mtime);
297 return Ret;
298}
299
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000300error_code current_path(SmallVectorImpl<char> &result) {
Sylvestre Ledru14ada942012-04-11 15:35:36 +0000301#ifdef MAXPATHLEN
Andrew Tricka4ec5b22011-03-24 16:43:37 +0000302 result.reserve(MAXPATHLEN);
Sylvestre Ledru14ada942012-04-11 15:35:36 +0000303#else
304// For GNU Hurd
305 result.reserve(1024);
306#endif
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000307
Michael J. Spencer20daa282010-12-07 01:22:31 +0000308 while (true) {
309 if (::getcwd(result.data(), result.capacity()) == 0) {
310 // See if there was a real error.
311 if (errno != errc::not_enough_memory)
312 return error_code(errno, system_category());
313 // Otherwise there just wasn't enough space.
314 result.reserve(result.capacity() * 2);
315 } else
316 break;
317 }
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000318
319 result.set_size(strlen(result.data()));
David Blaikie18544b92012-02-09 19:24:12 +0000320 return error_code::success();
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000321}
322
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +0000323error_code copy_file(const Twine &from, const Twine &to, copy_option copt) {
324 // Get arguments.
325 SmallString<128> from_storage;
326 SmallString<128> to_storage;
Michael J. Spencer795adf52010-12-01 20:37:42 +0000327 StringRef f = from.toNullTerminatedStringRef(from_storage);
328 StringRef t = to.toNullTerminatedStringRef(to_storage);
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +0000329
330 const size_t buf_sz = 32768;
331 char buffer[buf_sz];
332 int from_file = -1, to_file = -1;
333
334 // Open from.
335 if ((from_file = ::open(f.begin(), O_RDONLY)) < 0)
336 return error_code(errno, system_category());
337 AutoFD from_fd(from_file);
338
339 // Stat from.
340 struct stat from_stat;
341 if (::stat(f.begin(), &from_stat) != 0)
342 return error_code(errno, system_category());
343
344 // Setup to flags.
345 int to_flags = O_CREAT | O_WRONLY;
346 if (copt == copy_option::fail_if_exists)
347 to_flags |= O_EXCL;
348
349 // Open to.
350 if ((to_file = ::open(t.begin(), to_flags, from_stat.st_mode)) < 0)
351 return error_code(errno, system_category());
352 AutoFD to_fd(to_file);
353
354 // Copy!
355 ssize_t sz, sz_read = 1, sz_write;
356 while (sz_read > 0 &&
357 (sz_read = ::read(from_fd, buffer, buf_sz)) > 0) {
358 // Allow for partial writes - see Advanced Unix Programming (2nd Ed.),
359 // Marc Rochkind, Addison-Wesley, 2004, page 94
360 sz_write = 0;
361 do {
362 if ((sz = ::write(to_fd, buffer + sz_write, sz_read - sz_write)) < 0) {
363 sz_read = sz; // cause read loop termination.
364 break; // error.
365 }
366 sz_write += sz;
367 } while (sz_write < sz_read);
368 }
369
370 // After all the file operations above the return value of close actually
371 // matters.
372 if (::close(from_fd.take()) < 0) sz_read = -1;
373 if (::close(to_fd.take()) < 0) sz_read = -1;
374
375 // Check for errors.
376 if (sz_read < 0)
377 return error_code(errno, system_category());
378
David Blaikie18544b92012-02-09 19:24:12 +0000379 return error_code::success();
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +0000380}
381
Michael J. Spencer31e310c2010-12-03 05:42:11 +0000382error_code create_directory(const Twine &path, bool &existed) {
383 SmallString<128> path_storage;
384 StringRef p = path.toNullTerminatedStringRef(path_storage);
385
Michael J. Spencere5755be2010-12-07 01:23:29 +0000386 if (::mkdir(p.begin(), S_IRWXU | S_IRWXG) == -1) {
Michael J. Spencer66a1f862010-12-04 18:45:32 +0000387 if (errno != errc::file_exists)
Michael J. Spencer31e310c2010-12-03 05:42:11 +0000388 return error_code(errno, system_category());
389 existed = true;
390 } else
391 existed = false;
392
David Blaikie18544b92012-02-09 19:24:12 +0000393 return error_code::success();
Michael J. Spencer31e310c2010-12-03 05:42:11 +0000394}
395
Michael J. Spencere0c45602010-12-03 05:58:41 +0000396error_code create_hard_link(const Twine &to, const Twine &from) {
397 // Get arguments.
398 SmallString<128> from_storage;
399 SmallString<128> to_storage;
400 StringRef f = from.toNullTerminatedStringRef(from_storage);
401 StringRef t = to.toNullTerminatedStringRef(to_storage);
402
403 if (::link(t.begin(), f.begin()) == -1)
404 return error_code(errno, system_category());
405
David Blaikie18544b92012-02-09 19:24:12 +0000406 return error_code::success();
Michael J. Spencere0c45602010-12-03 05:58:41 +0000407}
408
Michael J. Spencer7ee6d5d2010-12-03 07:41:25 +0000409error_code create_symlink(const Twine &to, const Twine &from) {
410 // Get arguments.
411 SmallString<128> from_storage;
412 SmallString<128> to_storage;
413 StringRef f = from.toNullTerminatedStringRef(from_storage);
414 StringRef t = to.toNullTerminatedStringRef(to_storage);
415
416 if (::symlink(t.begin(), f.begin()) == -1)
417 return error_code(errno, system_category());
418
David Blaikie18544b92012-02-09 19:24:12 +0000419 return error_code::success();
Michael J. Spencer7ee6d5d2010-12-03 07:41:25 +0000420}
421
Michael J. Spencer6e74e112010-12-03 17:53:43 +0000422error_code remove(const Twine &path, bool &existed) {
423 SmallString<128> path_storage;
424 StringRef p = path.toNullTerminatedStringRef(path_storage);
425
Rafael Espindola8cd62b02013-06-17 20:35:51 +0000426 struct stat buf;
427 if (stat(p.begin(), &buf) != 0) {
428 if (errno != errc::no_such_file_or_directory)
429 return error_code(errno, system_category());
430 existed = false;
431 return error_code::success();
432 }
433
434 // Note: this check catches strange situations. In all cases, LLVM should
435 // only be involved in the creation and deletion of regular files. This
436 // check ensures that what we're trying to erase is a regular file. It
437 // effectively prevents LLVM from erasing things like /dev/null, any block
438 // special file, or other things that aren't "regular" files.
439 if (!S_ISREG(buf.st_mode) && !S_ISDIR(buf.st_mode))
440 return make_error_code(errc::operation_not_permitted);
441
Michael J. Spencer6e74e112010-12-03 17:53:43 +0000442 if (::remove(p.begin()) == -1) {
Michael J. Spencer66a1f862010-12-04 18:45:32 +0000443 if (errno != errc::no_such_file_or_directory)
Michael J. Spencer6e74e112010-12-03 17:53:43 +0000444 return error_code(errno, system_category());
445 existed = false;
446 } else
447 existed = true;
448
David Blaikie18544b92012-02-09 19:24:12 +0000449 return error_code::success();
Michael J. Spencer6e74e112010-12-03 17:53:43 +0000450}
451
Michael J. Spencer409f5562010-12-03 17:53:55 +0000452error_code rename(const Twine &from, const Twine &to) {
453 // Get arguments.
454 SmallString<128> from_storage;
455 SmallString<128> to_storage;
456 StringRef f = from.toNullTerminatedStringRef(from_storage);
457 StringRef t = to.toNullTerminatedStringRef(to_storage);
458
Michael J. Spencerec202ee2011-01-16 22:18:41 +0000459 if (::rename(f.begin(), t.begin()) == -1) {
460 // If it's a cross device link, copy then delete, otherwise return the error
461 if (errno == EXDEV) {
462 if (error_code ec = copy_file(from, to, copy_option::overwrite_if_exists))
463 return ec;
464 bool Existed;
465 if (error_code ec = remove(from, Existed))
466 return ec;
467 } else
468 return error_code(errno, system_category());
469 }
Michael J. Spencer409f5562010-12-03 17:53:55 +0000470
David Blaikie18544b92012-02-09 19:24:12 +0000471 return error_code::success();
Michael J. Spencer409f5562010-12-03 17:53:55 +0000472}
473
Michael J. Spencerc20a0322010-12-03 17:54:07 +0000474error_code resize_file(const Twine &path, uint64_t size) {
475 SmallString<128> path_storage;
476 StringRef p = path.toNullTerminatedStringRef(path_storage);
477
478 if (::truncate(p.begin(), size) == -1)
479 return error_code(errno, system_category());
480
David Blaikie18544b92012-02-09 19:24:12 +0000481 return error_code::success();
Michael J. Spencerc20a0322010-12-03 17:54:07 +0000482}
483
Michael J. Spencer45710402010-12-03 01:21:28 +0000484error_code exists(const Twine &path, bool &result) {
485 SmallString<128> path_storage;
486 StringRef p = path.toNullTerminatedStringRef(path_storage);
487
Benjamin Kramer172f8082012-06-02 16:28:09 +0000488 if (::access(p.begin(), F_OK) == -1) {
Michael J. Spencer66a1f862010-12-04 18:45:32 +0000489 if (errno != errc::no_such_file_or_directory)
Michael J. Spencer45710402010-12-03 01:21:28 +0000490 return error_code(errno, system_category());
491 result = false;
492 } else
493 result = true;
494
David Blaikie18544b92012-02-09 19:24:12 +0000495 return error_code::success();
Michael J. Spencer45710402010-12-03 01:21:28 +0000496}
497
Rafael Espindolaa1280c12013-06-18 20:56:38 +0000498bool can_write(const Twine &Path) {
499 SmallString<128> PathStorage;
500 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
501 return 0 == access(P.begin(), W_OK);
502}
503
Rafael Espindolab0a5c962013-06-14 19:38:45 +0000504bool can_execute(const Twine &Path) {
505 SmallString<128> PathStorage;
506 StringRef P = Path.toNullTerminatedStringRef(PathStorage);
507
Manuel Klimek52772bf2013-06-17 10:48:34 +0000508 if (0 != access(P.begin(), R_OK | X_OK))
509 return false;
510 struct stat buf;
511 if (0 != stat(P.begin(), &buf))
512 return false;
513 if (!S_ISREG(buf.st_mode))
514 return false;
515 return true;
Rafael Espindolab0a5c962013-06-14 19:38:45 +0000516}
517
Michael J. Spencer203d7802011-12-12 06:04:28 +0000518bool equivalent(file_status A, file_status B) {
519 assert(status_known(A) && status_known(B));
Sylvestre Ledru3099f4bd2012-04-23 16:37:23 +0000520 return A.fs_st_dev == B.fs_st_dev &&
521 A.fs_st_ino == B.fs_st_ino;
Michael J. Spencer203d7802011-12-12 06:04:28 +0000522}
523
Michael J. Spencer376d3872010-12-03 18:49:13 +0000524error_code equivalent(const Twine &A, const Twine &B, bool &result) {
Michael J. Spencer203d7802011-12-12 06:04:28 +0000525 file_status fsA, fsB;
526 if (error_code ec = status(A, fsA)) return ec;
527 if (error_code ec = status(B, fsB)) return ec;
528 result = equivalent(fsA, fsB);
David Blaikie18544b92012-02-09 19:24:12 +0000529 return error_code::success();
Michael J. Spencer376d3872010-12-03 18:49:13 +0000530}
531
Michael J. Spencer818ab4a2010-12-04 00:31:48 +0000532error_code file_size(const Twine &path, uint64_t &result) {
533 SmallString<128> path_storage;
534 StringRef p = path.toNullTerminatedStringRef(path_storage);
535
536 struct stat status;
537 if (::stat(p.begin(), &status) == -1)
538 return error_code(errno, system_category());
539 if (!S_ISREG(status.st_mode))
Michael J. Spencer66a1f862010-12-04 18:45:32 +0000540 return make_error_code(errc::operation_not_permitted);
Michael J. Spencer818ab4a2010-12-04 00:31:48 +0000541
542 result = status.st_size;
David Blaikie18544b92012-02-09 19:24:12 +0000543 return error_code::success();
Michael J. Spencer818ab4a2010-12-04 00:31:48 +0000544}
545
Rafael Espindola7cf7c512013-06-20 15:06:35 +0000546error_code getUniqueID(const Twine Path, uint64_t &Result) {
Rafael Espindola45e6c242013-06-18 19:34:49 +0000547 SmallString<128> Storage;
548 StringRef P = Path.toNullTerminatedStringRef(Storage);
549
550 struct stat Status;
551 if (::stat(P.begin(), &Status) != 0)
552 return error_code(errno, system_category());
553
554 Result = Status.st_ino;
555 return error_code::success();
556}
557
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000558error_code status(const Twine &path, file_status &result) {
559 SmallString<128> path_storage;
560 StringRef p = path.toNullTerminatedStringRef(path_storage);
561
562 struct stat status;
563 if (::stat(p.begin(), &status) != 0) {
564 error_code ec(errno, system_category());
565 if (ec == errc::no_such_file_or_directory)
566 result = file_status(file_type::file_not_found);
567 else
568 result = file_status(file_type::status_error);
569 return ec;
570 }
571
Nick Kledzik18497e92012-06-20 00:28:54 +0000572 perms prms = static_cast<perms>(status.st_mode & perms_mask);
573
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000574 if (S_ISDIR(status.st_mode))
Nick Kledzik18497e92012-06-20 00:28:54 +0000575 result = file_status(file_type::directory_file, prms);
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000576 else if (S_ISREG(status.st_mode))
Nick Kledzik18497e92012-06-20 00:28:54 +0000577 result = file_status(file_type::regular_file, prms);
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000578 else if (S_ISBLK(status.st_mode))
Nick Kledzik18497e92012-06-20 00:28:54 +0000579 result = file_status(file_type::block_file, prms);
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000580 else if (S_ISCHR(status.st_mode))
Nick Kledzik18497e92012-06-20 00:28:54 +0000581 result = file_status(file_type::character_file, prms);
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000582 else if (S_ISFIFO(status.st_mode))
Nick Kledzik18497e92012-06-20 00:28:54 +0000583 result = file_status(file_type::fifo_file, prms);
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000584 else if (S_ISSOCK(status.st_mode))
Nick Kledzik18497e92012-06-20 00:28:54 +0000585 result = file_status(file_type::socket_file, prms);
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000586 else
Nick Kledzik18497e92012-06-20 00:28:54 +0000587 result = file_status(file_type::type_unknown, prms);
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000588
Sylvestre Ledru3099f4bd2012-04-23 16:37:23 +0000589 result.fs_st_dev = status.st_dev;
590 result.fs_st_ino = status.st_ino;
Rafael Espindoladb5d8fe2013-06-20 18:42:04 +0000591 result.fs_st_mtime = status.st_mtime;
Rafael Espindolae34d6a52013-06-20 22:02:10 +0000592 result.fs_st_uid = status.st_uid;
593 result.fs_st_gid = status.st_gid;
Michael J. Spencer203d7802011-12-12 06:04:28 +0000594
David Blaikie18544b92012-02-09 19:24:12 +0000595 return error_code::success();
Michael J. Spencerdb5576a2010-12-04 00:32:40 +0000596}
597
Nick Kledzik18497e92012-06-20 00:28:54 +0000598// Modifies permissions on a file.
599error_code permissions(const Twine &path, perms prms) {
600 if ((prms & add_perms) && (prms & remove_perms))
601 llvm_unreachable("add_perms and remove_perms are mutually exclusive");
602
603 // Get current permissions
Rafael Espindola1efb69c2013-06-20 22:07:53 +0000604 // FIXME: We only need this stat for add_perms and remove_perms.
Nick Kledzik18497e92012-06-20 00:28:54 +0000605 file_status info;
606 if (error_code ec = status(path, info)) {
607 return ec;
608 }
609
610 // Set updated permissions.
611 SmallString<128> path_storage;
612 StringRef p = path.toNullTerminatedStringRef(path_storage);
613 perms permsToSet;
614 if (prms & add_perms) {
615 permsToSet = (info.permissions() | prms) & perms_mask;
616 } else if (prms & remove_perms) {
617 permsToSet = (info.permissions() & ~prms) & perms_mask;
618 } else {
619 permsToSet = prms & perms_mask;
620 }
621 if (::chmod(p.begin(), static_cast<mode_t>(permsToSet))) {
622 return error_code(errno, system_category());
623 }
624
625 return error_code::success();
626}
627
Rafael Espindola4a3365c2013-06-20 20:56:14 +0000628error_code setLastModificationAndAccessTime(int FD, TimeValue Time) {
Eric Christophera24dc7f2013-07-04 01:10:38 +0000629#if defined(HAVE_FUTIMENS)
630 timespec Times[2];
631 Times[0].tv_sec = Time.toPosixTime();
632 Times[0].tv_nsec = 0;
633 Times[1] = Times[0];
634 if (::futimens(FD, Times))
635#elif defined(HAVE_FUTIMES)
Rafael Espindola4a3365c2013-06-20 20:56:14 +0000636 timeval Times[2];
637 Times[0].tv_sec = Time.toPosixTime();
638 Times[0].tv_usec = 0;
639 Times[1] = Times[0];
640 if (::futimes(FD, Times))
Eric Christophera24dc7f2013-07-04 01:10:38 +0000641#else
642#error Missing futimes() and futimens()
643#endif
Rafael Espindola4a3365c2013-06-20 20:56:14 +0000644 return error_code(errno, system_category());
645 return error_code::success();
646}
647
Michael J. Spencer42ad29f2013-03-14 00:20:10 +0000648error_code mapped_file_region::init(int FD, bool CloseFD, uint64_t Offset) {
649 AutoFD ScopedFD(FD);
650 if (!CloseFD)
651 ScopedFD.take();
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000652
653 // Figure out how large the file is.
654 struct stat FileInfo;
Michael J. Spencer42ad29f2013-03-14 00:20:10 +0000655 if (fstat(FD, &FileInfo) == -1)
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000656 return error_code(errno, system_category());
657 uint64_t FileSize = FileInfo.st_size;
658
659 if (Size == 0)
660 Size = FileSize;
661 else if (FileSize < Size) {
662 // We need to grow the file.
Michael J. Spencer42ad29f2013-03-14 00:20:10 +0000663 if (ftruncate(FD, Size) == -1)
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000664 return error_code(errno, system_category());
665 }
666
667 int flags = (Mode == readwrite) ? MAP_SHARED : MAP_PRIVATE;
668 int prot = (Mode == readonly) ? PROT_READ : (PROT_READ | PROT_WRITE);
669#ifdef MAP_FILE
670 flags |= MAP_FILE;
671#endif
Michael J. Spencer42ad29f2013-03-14 00:20:10 +0000672 Mapping = ::mmap(0, Size, prot, flags, FD, Offset);
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000673 if (Mapping == MAP_FAILED)
674 return error_code(errno, system_category());
675 return error_code::success();
676}
677
678mapped_file_region::mapped_file_region(const Twine &path,
679 mapmode mode,
680 uint64_t length,
681 uint64_t offset,
682 error_code &ec)
683 : Mode(mode)
684 , Size(length)
685 , Mapping() {
686 // Make sure that the requested size fits within SIZE_T.
687 if (length > std::numeric_limits<size_t>::max()) {
688 ec = make_error_code(errc::invalid_argument);
689 return;
690 }
691
692 SmallString<128> path_storage;
693 StringRef name = path.toNullTerminatedStringRef(path_storage);
694 int oflags = (mode == readonly) ? O_RDONLY : O_RDWR;
695 int ofd = ::open(name.begin(), oflags);
696 if (ofd == -1) {
697 ec = error_code(errno, system_category());
698 return;
699 }
700
Michael J. Spencer42ad29f2013-03-14 00:20:10 +0000701 ec = init(ofd, true, offset);
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000702 if (ec)
703 Mapping = 0;
704}
705
706mapped_file_region::mapped_file_region(int fd,
Michael J. Spencer42ad29f2013-03-14 00:20:10 +0000707 bool closefd,
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000708 mapmode mode,
709 uint64_t length,
710 uint64_t offset,
711 error_code &ec)
712 : Mode(mode)
713 , Size(length)
714 , Mapping() {
715 // Make sure that the requested size fits within SIZE_T.
716 if (length > std::numeric_limits<size_t>::max()) {
717 ec = make_error_code(errc::invalid_argument);
718 return;
719 }
720
Michael J. Spencer42ad29f2013-03-14 00:20:10 +0000721 ec = init(fd, closefd, offset);
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000722 if (ec)
723 Mapping = 0;
724}
725
726mapped_file_region::~mapped_file_region() {
727 if (Mapping)
728 ::munmap(Mapping, Size);
729}
730
Chandler Carruthf12e3a62012-11-30 11:45:22 +0000731#if LLVM_HAS_RVALUE_REFERENCES
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000732mapped_file_region::mapped_file_region(mapped_file_region &&other)
733 : Mode(other.Mode), Size(other.Size), Mapping(other.Mapping) {
734 other.Mapping = 0;
735}
736#endif
737
738mapped_file_region::mapmode mapped_file_region::flags() const {
739 assert(Mapping && "Mapping failed but used anyway!");
740 return Mode;
741}
742
743uint64_t mapped_file_region::size() const {
744 assert(Mapping && "Mapping failed but used anyway!");
745 return Size;
746}
747
748char *mapped_file_region::data() const {
749 assert(Mapping && "Mapping failed but used anyway!");
750 assert(Mode != readonly && "Cannot get non const data for readonly mapping!");
751 return reinterpret_cast<char*>(Mapping);
752}
753
754const char *mapped_file_region::const_data() const {
755 assert(Mapping && "Mapping failed but used anyway!");
756 return reinterpret_cast<const char*>(Mapping);
757}
758
759int mapped_file_region::alignment() {
Chandler Carruthacd64be2012-12-31 23:31:56 +0000760 return process::get_self()->page_size();
Michael J. Spenceref2284f2012-08-15 19:05:47 +0000761}
762
Michael J. Spencer0a7625d2011-12-08 22:50:09 +0000763error_code detail::directory_iterator_construct(detail::DirIterState &it,
764 StringRef path){
Michael J. Spencer52714862011-01-05 16:38:57 +0000765 SmallString<128> path_null(path);
766 DIR *directory = ::opendir(path_null.c_str());
767 if (directory == 0)
768 return error_code(errno, system_category());
769
770 it.IterationHandle = reinterpret_cast<intptr_t>(directory);
771 // Add something for replace_filename to replace.
772 path::append(path_null, ".");
773 it.CurrentEntry = directory_entry(path_null.str());
774 return directory_iterator_increment(it);
775}
776
Michael J. Spencer0a7625d2011-12-08 22:50:09 +0000777error_code detail::directory_iterator_destruct(detail::DirIterState &it) {
Michael J. Spencer52714862011-01-05 16:38:57 +0000778 if (it.IterationHandle)
779 ::closedir(reinterpret_cast<DIR *>(it.IterationHandle));
780 it.IterationHandle = 0;
781 it.CurrentEntry = directory_entry();
David Blaikie18544b92012-02-09 19:24:12 +0000782 return error_code::success();
Michael J. Spencer52714862011-01-05 16:38:57 +0000783}
784
Michael J. Spencer0a7625d2011-12-08 22:50:09 +0000785error_code detail::directory_iterator_increment(detail::DirIterState &it) {
Michael J. Spencer52714862011-01-05 16:38:57 +0000786 errno = 0;
787 dirent *cur_dir = ::readdir(reinterpret_cast<DIR *>(it.IterationHandle));
788 if (cur_dir == 0 && errno != 0) {
789 return error_code(errno, system_category());
790 } else if (cur_dir != 0) {
791 StringRef name(cur_dir->d_name, NAMLEN(cur_dir));
792 if ((name.size() == 1 && name[0] == '.') ||
793 (name.size() == 2 && name[0] == '.' && name[1] == '.'))
794 return directory_iterator_increment(it);
795 it.CurrentEntry.replace_filename(name);
796 } else
797 return directory_iterator_destruct(it);
798
David Blaikie18544b92012-02-09 19:24:12 +0000799 return error_code::success();
Michael J. Spencer52714862011-01-05 16:38:57 +0000800}
801
Michael J. Spenceree1699c2011-01-15 18:52:33 +0000802error_code get_magic(const Twine &path, uint32_t len,
803 SmallVectorImpl<char> &result) {
804 SmallString<128> PathStorage;
805 StringRef Path = path.toNullTerminatedStringRef(PathStorage);
806 result.set_size(0);
807
808 // Open path.
809 std::FILE *file = std::fopen(Path.data(), "rb");
810 if (file == 0)
811 return error_code(errno, system_category());
812
813 // Reserve storage.
814 result.reserve(len);
815
816 // Read magic!
817 size_t size = std::fread(result.data(), 1, len, file);
818 if (std::ferror(file) != 0) {
819 std::fclose(file);
820 return error_code(errno, system_category());
Evgeniy Stepanov6eb44842013-06-20 15:56:05 +0000821 } else if (size != len) {
Michael J. Spenceree1699c2011-01-15 18:52:33 +0000822 if (std::feof(file) != 0) {
823 std::fclose(file);
824 result.set_size(size);
825 return make_error_code(errc::value_too_large);
826 }
827 }
828 std::fclose(file);
Evgeniy Stepanov6eb44842013-06-20 15:56:05 +0000829 result.set_size(size);
David Blaikie18544b92012-02-09 19:24:12 +0000830 return error_code::success();
Michael J. Spenceree1699c2011-01-15 18:52:33 +0000831}
832
Nick Kledzik18497e92012-06-20 00:28:54 +0000833error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
834 bool map_writable, void *&result) {
835 SmallString<128> path_storage;
836 StringRef name = path.toNullTerminatedStringRef(path_storage);
837 int oflags = map_writable ? O_RDWR : O_RDONLY;
838 int ofd = ::open(name.begin(), oflags);
839 if ( ofd == -1 )
840 return error_code(errno, system_category());
841 AutoFD fd(ofd);
842 int flags = map_writable ? MAP_SHARED : MAP_PRIVATE;
843 int prot = map_writable ? (PROT_READ|PROT_WRITE) : PROT_READ;
844#ifdef MAP_FILE
845 flags |= MAP_FILE;
846#endif
847 result = ::mmap(0, size, prot, flags, fd, file_offset);
848 if (result == MAP_FAILED) {
849 return error_code(errno, system_category());
850 }
851
852 return error_code::success();
853}
854
855error_code unmap_file_pages(void *base, size_t size) {
856 if ( ::munmap(base, size) == -1 )
857 return error_code(errno, system_category());
858
859 return error_code::success();
860}
861
862
Michael J. Spencer9fc1d9d2010-12-01 19:32:01 +0000863} // end namespace fs
Michael J. Spencerebad2f92010-11-29 22:28:51 +0000864} // end namespace sys
865} // end namespace llvm