blob: 89285b48132f98cf93432aada0138048c8dfb651 [file] [log] [blame]
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001//===- llvm/System/Unix/Path.cpp - Unix Path Implementation -----*- C++ -*-===//
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +00002//
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner081ce942007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +00007//
Dan Gohmanf17a25c2007-07-18 16:29:46 +00008//===----------------------------------------------------------------------===//
9//
10// This file implements the Unix specific portion of the Path class.
11//
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
Chris Lattner8755dee2009-08-23 22:57:38 +000019#include "llvm/ADT/SmallVector.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000020#include "Unix.h"
21#if HAVE_SYS_STAT_H
22#include <sys/stat.h>
23#endif
24#if HAVE_FCNTL_H
25#include <fcntl.h>
26#endif
Chris Lattner116abbf2008-04-01 06:25:23 +000027#ifdef HAVE_SYS_MMAN_H
28#include <sys/mman.h>
29#endif
30#ifdef HAVE_SYS_STAT_H
31#include <sys/stat.h>
32#endif
Dan Gohmanf17a25c2007-07-18 16:29:46 +000033#if HAVE_UTIME_H
34#include <utime.h>
35#endif
36#if HAVE_TIME_H
37#include <time.h>
38#endif
39#if HAVE_DIRENT_H
40# include <dirent.h>
41# define NAMLEN(dirent) strlen((dirent)->d_name)
42#else
43# define dirent direct
44# define NAMLEN(dirent) (dirent)->d_namlen
45# if HAVE_SYS_NDIR_H
46# include <sys/ndir.h>
47# endif
48# if HAVE_SYS_DIR_H
49# include <sys/dir.h>
50# endif
51# if HAVE_NDIR_H
52# include <ndir.h>
53# endif
54#endif
55
Chris Lattner365f2202008-03-03 02:55:43 +000056#if HAVE_DLFCN_H
57#include <dlfcn.h>
58#endif
59
Benjamin Kramer76629852009-09-09 12:09:08 +000060#ifdef __APPLE__
61#include <mach-o/dyld.h>
62#endif
63
Dan Gohmanf17a25c2007-07-18 16:29:46 +000064// Put in a hack for Cygwin which falsely reports that the mkdtemp function
65// is available when it is not.
66#ifdef __CYGWIN__
67# undef HAVE_MKDTEMP
68#endif
69
70namespace {
71inline bool lastIsSlash(const std::string& path) {
72 return !path.empty() && path[path.length() - 1] == '/';
73}
74
75}
76
77namespace llvm {
78using namespace sys;
79
Chris Lattner4b8f1c62008-02-27 06:17:10 +000080extern const char sys::PathSeparator = ':';
81
Nick Lewycky4fd4b462008-05-11 17:37:40 +000082Path::Path(const std::string& p)
83 : path(p) {}
84
85Path::Path(const char *StrStart, unsigned StrLen)
86 : path(StrStart, StrLen) {}
87
Chris Lattner43ac42b2008-08-11 23:39:47 +000088Path&
89Path::operator=(const std::string &that) {
90 path = that;
91 return *this;
92}
93
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +000094bool
Dan Gohmanf17a25c2007-07-18 16:29:46 +000095Path::isValid() const {
96 // Check some obvious things
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +000097 if (path.empty())
Dan Gohmanf17a25c2007-07-18 16:29:46 +000098 return false;
Chris Lattnerb898cff2009-07-12 19:01:16 +000099 return path.length() < MAXPATHLEN;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000100}
101
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000102bool
Chris Lattnerd024d8d2009-06-15 04:17:07 +0000103Path::isAbsolute(const char *NameStart, unsigned NameLen) {
104 assert(NameStart);
105 if (NameLen == 0)
106 return false;
107 return NameStart[0] == '/';
108}
109
110bool
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000111Path::isAbsolute() const {
112 if (path.empty())
113 return false;
114 return path[0] == '/';
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000115}
Daniel Dunbarbf8e8712009-07-12 20:23:56 +0000116
117void Path::makeAbsolute() {
118 if (isAbsolute())
119 return;
120
121 Path CWD = Path::GetCurrentDirectory();
122 assert(CWD.isAbsolute() && "GetCurrentDirectory returned relative path!");
123
124 CWD.appendComponent(path);
125
Chris Lattnerb1aa85b2009-08-23 22:45:37 +0000126 path = CWD.str();
Daniel Dunbarbf8e8712009-07-12 20:23:56 +0000127}
128
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000129Path
130Path::GetRootDirectory() {
131 Path result;
132 result.set("/");
133 return result;
134}
135
136Path
Chris Lattnera8164e42009-02-19 05:34:35 +0000137Path::GetTemporaryDirectory(std::string *ErrMsg) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000138#if defined(HAVE_MKDTEMP)
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000139 // The best way is with mkdtemp but that's not available on many systems,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000140 // Linux and FreeBSD have it. Others probably won't.
141 char pathname[MAXPATHLEN];
142 strcpy(pathname,"/tmp/llvm_XXXXXX");
143 if (0 == mkdtemp(pathname)) {
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000144 MakeErrMsg(ErrMsg,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000145 std::string(pathname) + ": can't create temporary directory");
146 return Path();
147 }
148 Path result;
149 result.set(pathname);
150 assert(result.isValid() && "mkdtemp didn't create a valid pathname!");
151 return result;
152#elif defined(HAVE_MKSTEMP)
153 // If no mkdtemp is available, mkstemp can be used to create a temporary file
154 // which is then removed and created as a directory. We prefer this over
155 // mktemp because of mktemp's inherent security and threading risks. We still
156 // have a slight race condition from the time the temporary file is created to
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000157 // the time it is re-created as a directoy.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000158 char pathname[MAXPATHLEN];
159 strcpy(pathname, "/tmp/llvm_XXXXXX");
160 int fd = 0;
161 if (-1 == (fd = mkstemp(pathname))) {
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000162 MakeErrMsg(ErrMsg,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000163 std::string(pathname) + ": can't create temporary directory");
164 return Path();
165 }
166 ::close(fd);
167 ::unlink(pathname); // start race condition, ignore errors
168 if (-1 == ::mkdir(pathname, S_IRWXU)) { // end race condition
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000169 MakeErrMsg(ErrMsg,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000170 std::string(pathname) + ": can't create temporary directory");
171 return Path();
172 }
173 Path result;
174 result.set(pathname);
175 assert(result.isValid() && "mkstemp didn't create a valid pathname!");
176 return result;
177#elif defined(HAVE_MKTEMP)
178 // If a system doesn't have mkdtemp(3) or mkstemp(3) but it does have
179 // mktemp(3) then we'll assume that system (e.g. AIX) has a reasonable
180 // implementation of mktemp(3) and doesn't follow BSD 4.3's lead of replacing
181 // the XXXXXX with the pid of the process and a letter. That leads to only
182 // twenty six temporary files that can be generated.
183 char pathname[MAXPATHLEN];
184 strcpy(pathname, "/tmp/llvm_XXXXXX");
185 char *TmpName = ::mktemp(pathname);
186 if (TmpName == 0) {
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000187 MakeErrMsg(ErrMsg,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000188 std::string(TmpName) + ": can't create unique directory name");
189 return Path();
190 }
191 if (-1 == ::mkdir(TmpName, S_IRWXU)) {
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000192 MakeErrMsg(ErrMsg,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000193 std::string(TmpName) + ": can't create temporary directory");
194 return Path();
195 }
196 Path result;
197 result.set(TmpName);
198 assert(result.isValid() && "mktemp didn't create a valid pathname!");
199 return result;
200#else
201 // This is the worst case implementation. tempnam(3) leaks memory unless its
202 // on an SVID2 (or later) system. On BSD 4.3 it leaks. tmpnam(3) has thread
203 // issues. The mktemp(3) function doesn't have enough variability in the
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000204 // temporary name generated. So, we provide our own implementation that
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000205 // increments an integer from a random number seeded by the current time. This
206 // should be sufficiently unique that we don't have many collisions between
207 // processes. Generally LLVM processes don't run very long and don't use very
208 // many temporary files so this shouldn't be a big issue for LLVM.
209 static time_t num = ::time(0);
210 char pathname[MAXPATHLEN];
211 do {
212 num++;
213 sprintf(pathname, "/tmp/llvm_%010u", unsigned(num));
214 } while ( 0 == access(pathname, F_OK ) );
215 if (-1 == ::mkdir(pathname, S_IRWXU)) {
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000216 MakeErrMsg(ErrMsg,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000217 std::string(pathname) + ": can't create temporary directory");
218 return Path();
219 }
220 Path result;
221 result.set(pathname);
222 assert(result.isValid() && "mkstemp didn't create a valid pathname!");
223 return result;
224#endif
225}
226
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000227void
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000228Path::GetSystemLibraryPaths(std::vector<sys::Path>& Paths) {
229#ifdef LTDL_SHLIBPATH_VAR
230 char* env_var = getenv(LTDL_SHLIBPATH_VAR);
231 if (env_var != 0) {
232 getPathList(env_var,Paths);
233 }
234#endif
235 // FIXME: Should this look at LD_LIBRARY_PATH too?
236 Paths.push_back(sys::Path("/usr/local/lib/"));
237 Paths.push_back(sys::Path("/usr/X11R6/lib/"));
238 Paths.push_back(sys::Path("/usr/lib/"));
239 Paths.push_back(sys::Path("/lib/"));
240}
241
242void
243Path::GetBitcodeLibraryPaths(std::vector<sys::Path>& Paths) {
244 char * env_var = getenv("LLVM_LIB_SEARCH_PATH");
245 if (env_var != 0) {
246 getPathList(env_var,Paths);
247 }
248#ifdef LLVM_LIBDIR
249 {
250 Path tmpPath;
251 if (tmpPath.set(LLVM_LIBDIR))
252 if (tmpPath.canRead())
253 Paths.push_back(tmpPath);
254 }
255#endif
256 GetSystemLibraryPaths(Paths);
257}
258
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000259Path
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000260Path::GetLLVMDefaultConfigDir() {
261 return Path("/etc/llvm/");
262}
263
264Path
265Path::GetUserHomeDirectory() {
266 const char* home = getenv("HOME");
267 if (home) {
268 Path result;
269 if (result.set(home))
270 return result;
271 }
272 return GetRootDirectory();
273}
274
Ted Kremenekb05c9352007-12-18 22:07:33 +0000275Path
276Path::GetCurrentDirectory() {
277 char pathname[MAXPATHLEN];
278 if (!getcwd(pathname,MAXPATHLEN)) {
279 assert (false && "Could not query current working directory.");
280 return Path("");
281 }
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000282
Ted Kremenekb05c9352007-12-18 22:07:33 +0000283 return Path(pathname);
284}
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000285
Chris Lattner085fe052009-03-02 22:17:15 +0000286#ifdef __FreeBSD__
287static int
288test_dir(char buf[PATH_MAX], char ret[PATH_MAX],
289 const char *dir, const char *bin)
290{
Bill Wendlingc1946742009-05-30 01:09:53 +0000291 struct stat sb;
Chris Lattner085fe052009-03-02 22:17:15 +0000292
Bill Wendlingc1946742009-05-30 01:09:53 +0000293 snprintf(buf, PATH_MAX, "%s//%s", dir, bin);
294 if (realpath(buf, ret) == NULL)
295 return (1);
296 if (stat(buf, &sb) != 0)
297 return (1);
298
299 return (0);
Chris Lattner085fe052009-03-02 22:17:15 +0000300}
301
302static char *
303getprogpath(char ret[PATH_MAX], const char *bin)
304{
Bill Wendlingc1946742009-05-30 01:09:53 +0000305 char *pv, *s, *t, buf[PATH_MAX];
Chris Lattner085fe052009-03-02 22:17:15 +0000306
Bill Wendlingc1946742009-05-30 01:09:53 +0000307 /* First approach: absolute path. */
308 if (bin[0] == '/') {
309 if (test_dir(buf, ret, "/", bin) == 0)
310 return (ret);
311 return (NULL);
312 }
Chris Lattner085fe052009-03-02 22:17:15 +0000313
Bill Wendlingc1946742009-05-30 01:09:53 +0000314 /* Second approach: relative path. */
315 if (strchr(bin, '/') != NULL) {
316 if (getcwd(buf, PATH_MAX) == NULL)
317 return (NULL);
318 if (test_dir(buf, ret, buf, bin) == 0)
319 return (ret);
320 return (NULL);
321 }
Chris Lattner085fe052009-03-02 22:17:15 +0000322
Bill Wendlingc1946742009-05-30 01:09:53 +0000323 /* Third approach: $PATH */
324 if ((pv = getenv("PATH")) == NULL)
325 return (NULL);
326 s = pv = strdup(pv);
327 if (pv == NULL)
328 return (NULL);
329 while ((t = strsep(&s, ":")) != NULL) {
330 if (test_dir(buf, ret, t, bin) == 0) {
331 free(pv);
332 return (ret);
333 }
334 }
335 free(pv);
336 return (NULL);
Chris Lattner085fe052009-03-02 22:17:15 +0000337}
338#endif
339
Chris Lattner365f2202008-03-03 02:55:43 +0000340/// GetMainExecutable - Return the path to the main executable, given the
341/// value of argv[0] from program startup.
342Path Path::GetMainExecutable(const char *argv0, void *MainAddr) {
Benjamin Kramer76629852009-09-09 12:09:08 +0000343#if defined(__APPLE__)
344 // On OS X the executable path is saved to the stack by dyld. Reading it
345 // from there is much faster than calling dladdr, especially for large
346 // binaries with symbols.
347 char exe_path[MAXPATHLEN];
348 uint32_t size = sizeof(exe_path);
349 if (_NSGetExecutablePath(exe_path, &size) == 0) {
350 char link_path[MAXPATHLEN];
351 return Path(std::string(realpath(exe_path, link_path)));
352 }
353#elif defined(__FreeBSD__)
Chris Lattner085fe052009-03-02 22:17:15 +0000354 char exe_path[PATH_MAX];
355
356 if (getprogpath(exe_path, argv0) != NULL)
357 return Path(std::string(exe_path));
358#elif defined(__linux__) || defined(__CYGWIN__)
Chris Lattnerc9aca312008-03-13 05:22:05 +0000359 char exe_path[MAXPATHLEN];
Seo Sanghyeon4d048212008-06-27 22:55:30 +0000360 ssize_t len = readlink("/proc/self/exe", exe_path, sizeof(exe_path));
Dan Gohmand285c8f2009-08-05 20:16:55 +0000361 if (len >= 0)
362 return Path(std::string(exe_path, len));
Chris Lattnerc9aca312008-03-13 05:22:05 +0000363#elif defined(HAVE_DLFCN_H)
Chris Lattner365f2202008-03-03 02:55:43 +0000364 // Use dladdr to get executable path if available.
Chris Lattner365f2202008-03-03 02:55:43 +0000365 Dl_info DLInfo;
366 int err = dladdr(MainAddr, &DLInfo);
Chris Lattnera8164e42009-02-19 05:34:35 +0000367 if (err == 0)
368 return Path();
Bill Wendlingc1946742009-05-30 01:09:53 +0000369
Chris Lattnera8164e42009-02-19 05:34:35 +0000370 // If the filename is a symlink, we need to resolve and return the location of
371 // the actual executable.
372 char link_path[MAXPATHLEN];
373 return Path(std::string(realpath(DLInfo.dli_fname, link_path)));
Chris Lattner365f2202008-03-03 02:55:43 +0000374#endif
375 return Path();
376}
377
378
Ted Kremenekb169dfa2008-04-07 22:01:32 +0000379std::string Path::getDirname() const {
380 return getDirnameCharSep(path, '/');
381}
Ted Kremenek4a4f5ed2008-04-07 21:53:57 +0000382
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000383std::string
384Path::getBasename() const {
385 // Find the last slash
Ted Kremenek4a4f5ed2008-04-07 21:53:57 +0000386 std::string::size_type slash = path.rfind('/');
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000387 if (slash == std::string::npos)
388 slash = 0;
389 else
390 slash++;
391
Ted Kremenek4a4f5ed2008-04-07 21:53:57 +0000392 std::string::size_type dot = path.rfind('.');
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000393 if (dot == std::string::npos || dot < slash)
394 return path.substr(slash);
395 else
396 return path.substr(slash, dot - slash);
397}
398
Argiris Kirtzidisc8f4a3a2008-06-15 15:15:19 +0000399std::string
400Path::getSuffix() const {
401 // Find the last slash
402 std::string::size_type slash = path.rfind('/');
403 if (slash == std::string::npos)
404 slash = 0;
405 else
406 slash++;
407
408 std::string::size_type dot = path.rfind('.');
409 if (dot == std::string::npos || dot < slash)
Wojciech Matyjewiczce6f1372008-06-15 18:02:47 +0000410 return std::string();
Argiris Kirtzidisc8f4a3a2008-06-15 15:15:19 +0000411 else
412 return path.substr(dot + 1);
413}
414
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000415bool Path::getMagicNumber(std::string& Magic, unsigned len) const {
416 assert(len < 1024 && "Request for magic string too long");
Chris Lattner8755dee2009-08-23 22:57:38 +0000417 SmallVector<char, 128> Buf;
418 Buf.resize(1 + len);
419 char* buf = Buf.data();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000420 int fd = ::open(path.c_str(), O_RDONLY);
421 if (fd < 0)
422 return false;
423 ssize_t bytes_read = ::read(fd, buf, len);
424 ::close(fd);
425 if (ssize_t(len) != bytes_read) {
426 Magic.clear();
427 return false;
428 }
429 Magic.assign(buf,len);
430 return true;
431}
432
433bool
434Path::exists() const {
435 return 0 == access(path.c_str(), F_OK );
436}
437
438bool
Ted Kremenek65149be2007-12-18 19:46:22 +0000439Path::isDirectory() const {
440 struct stat buf;
441 if (0 != stat(path.c_str(), &buf))
442 return false;
443 return buf.st_mode & S_IFDIR ? true : false;
444}
445
446bool
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000447Path::canRead() const {
Dan Gohman979c9d32009-07-28 23:22:01 +0000448 return 0 == access(path.c_str(), R_OK);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000449}
450
451bool
452Path::canWrite() const {
Dan Gohman979c9d32009-07-28 23:22:01 +0000453 return 0 == access(path.c_str(), W_OK);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000454}
455
456bool
457Path::canExecute() const {
458 if (0 != access(path.c_str(), R_OK | X_OK ))
459 return false;
460 struct stat buf;
461 if (0 != stat(path.c_str(), &buf))
462 return false;
463 if (!S_ISREG(buf.st_mode))
464 return false;
465 return true;
466}
467
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000468std::string
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000469Path::getLast() const {
470 // Find the last slash
471 size_t pos = path.rfind('/');
472
473 // Handle the corner cases
474 if (pos == std::string::npos)
475 return path;
476
477 // If the last character is a slash
478 if (pos == path.length()-1) {
479 // Find the second to last slash
480 size_t pos2 = path.rfind('/', pos-1);
481 if (pos2 == std::string::npos)
482 return path.substr(0,pos);
483 else
484 return path.substr(pos2+1,pos-pos2-1);
485 }
486 // Return everything after the last slash
487 return path.substr(pos+1);
488}
489
490const FileStatus *
491PathWithStatus::getFileStatus(bool update, std::string *ErrStr) const {
492 if (!fsIsValid || update) {
493 struct stat buf;
494 if (0 != stat(path.c_str(), &buf)) {
495 MakeErrMsg(ErrStr, path + ": can't get status of file");
496 return 0;
497 }
498 status.fileSize = buf.st_size;
499 status.modTime.fromEpochTime(buf.st_mtime);
500 status.mode = buf.st_mode;
501 status.user = buf.st_uid;
502 status.group = buf.st_gid;
503 status.uniqueID = uint64_t(buf.st_ino);
504 status.isDir = S_ISDIR(buf.st_mode);
505 status.isFile = S_ISREG(buf.st_mode);
506 fsIsValid = true;
507 }
508 return &status;
509}
510
511static bool AddPermissionBits(const Path &File, int bits) {
512 // Get the umask value from the operating system. We want to use it
513 // when changing the file's permissions. Since calling umask() sets
514 // the umask and returns its old value, we must call it a second
515 // time to reset it to the user's preference.
516 int mask = umask(0777); // The arg. to umask is arbitrary.
517 umask(mask); // Restore the umask.
518
519 // Get the file's current mode.
520 struct stat buf;
Chris Lattnerb1aa85b2009-08-23 22:45:37 +0000521 if (0 != stat(File.c_str(), &buf))
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000522 return false;
523 // Change the file to have whichever permissions bits from 'bits'
524 // that the umask would not disable.
525 if ((chmod(File.c_str(), (buf.st_mode | (bits & ~mask)))) == -1)
526 return false;
527 return true;
528}
529
530bool Path::makeReadableOnDisk(std::string* ErrMsg) {
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000531 if (!AddPermissionBits(*this, 0444))
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000532 return MakeErrMsg(ErrMsg, path + ": can't make file readable");
533 return false;
534}
535
536bool Path::makeWriteableOnDisk(std::string* ErrMsg) {
537 if (!AddPermissionBits(*this, 0222))
538 return MakeErrMsg(ErrMsg, path + ": can't make file writable");
539 return false;
540}
541
542bool Path::makeExecutableOnDisk(std::string* ErrMsg) {
543 if (!AddPermissionBits(*this, 0111))
544 return MakeErrMsg(ErrMsg, path + ": can't make file executable");
545 return false;
546}
547
548bool
549Path::getDirectoryContents(std::set<Path>& result, std::string* ErrMsg) const {
550 DIR* direntries = ::opendir(path.c_str());
551 if (direntries == 0)
552 return MakeErrMsg(ErrMsg, path + ": can't open directory");
553
554 std::string dirPath = path;
555 if (!lastIsSlash(dirPath))
556 dirPath += '/';
557
558 result.clear();
559 struct dirent* de = ::readdir(direntries);
560 for ( ; de != 0; de = ::readdir(direntries)) {
561 if (de->d_name[0] != '.') {
562 Path aPath(dirPath + (const char*)de->d_name);
563 struct stat st;
564 if (0 != lstat(aPath.path.c_str(), &st)) {
565 if (S_ISLNK(st.st_mode))
566 continue; // dangling symlink -- ignore
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000567 return MakeErrMsg(ErrMsg,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000568 aPath.path + ": can't determine file object type");
569 }
570 result.insert(aPath);
571 }
572 }
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000573
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000574 closedir(direntries);
575 return false;
576}
577
578bool
579Path::set(const std::string& a_path) {
580 if (a_path.empty())
581 return false;
582 std::string save(path);
583 path = a_path;
584 if (!isValid()) {
585 path = save;
586 return false;
587 }
588 return true;
589}
590
591bool
592Path::appendComponent(const std::string& name) {
593 if (name.empty())
594 return false;
595 std::string save(path);
596 if (!lastIsSlash(path))
597 path += '/';
598 path += name;
599 if (!isValid()) {
600 path = save;
601 return false;
602 }
603 return true;
604}
605
606bool
607Path::eraseComponent() {
608 size_t slashpos = path.rfind('/',path.size());
609 if (slashpos == 0 || slashpos == std::string::npos) {
610 path.erase();
611 return true;
612 }
613 if (slashpos == path.size() - 1)
614 slashpos = path.rfind('/',slashpos-1);
615 if (slashpos == std::string::npos) {
616 path.erase();
617 return true;
618 }
619 path.erase(slashpos);
620 return true;
621}
622
623bool
624Path::appendSuffix(const std::string& suffix) {
625 std::string save(path);
626 path.append(".");
627 path.append(suffix);
628 if (!isValid()) {
629 path = save;
630 return false;
631 }
632 return true;
633}
634
635bool
636Path::eraseSuffix() {
637 std::string save = path;
638 size_t dotpos = path.rfind('.',path.size());
639 size_t slashpos = path.rfind('/',path.size());
640 if (dotpos != std::string::npos) {
641 if (slashpos == std::string::npos || dotpos > slashpos+1) {
642 path.erase(dotpos, path.size()-dotpos);
643 return true;
644 }
645 }
646 if (!isValid())
647 path = save;
648 return false;
649}
650
Ted Kremenekf8cce7d2008-04-03 16:11:31 +0000651static bool createDirectoryHelper(char* beg, char* end, bool create_parents) {
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000652
Dan Gohman54356b972009-07-29 00:02:58 +0000653 if (access(beg, R_OK | W_OK) == 0)
Ted Kremenekf8cce7d2008-04-03 16:11:31 +0000654 return false;
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000655
Ted Kremenekf8cce7d2008-04-03 16:11:31 +0000656 if (create_parents) {
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000657
Ted Kremenekf8cce7d2008-04-03 16:11:31 +0000658 char* c = end;
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000659
Ted Kremenekf8cce7d2008-04-03 16:11:31 +0000660 for (; c != beg; --c)
661 if (*c == '/') {
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000662
Ted Kremenekf8cce7d2008-04-03 16:11:31 +0000663 // Recurse to handling the parent directory.
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000664 *c = '\0';
Ted Kremenekf8cce7d2008-04-03 16:11:31 +0000665 bool x = createDirectoryHelper(beg, c, create_parents);
666 *c = '/';
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000667
Ted Kremenekf8cce7d2008-04-03 16:11:31 +0000668 // Return if we encountered an error.
669 if (x)
670 return true;
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000671
Ted Kremenekf8cce7d2008-04-03 16:11:31 +0000672 break;
673 }
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000674 }
675
Ted Kremenekf8cce7d2008-04-03 16:11:31 +0000676 return mkdir(beg, S_IRWXU | S_IRWXG) != 0;
677}
678
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000679bool
680Path::createDirectoryOnDisk( bool create_parents, std::string* ErrMsg ) {
681 // Get a writeable copy of the path name
682 char pathname[MAXPATHLEN];
683 path.copy(pathname,MAXPATHLEN);
684
685 // Null-terminate the last component
Evan Cheng591bfc82008-05-05 18:30:58 +0000686 size_t lastchar = path.length() - 1 ;
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000687
Ted Kremenekf8cce7d2008-04-03 16:11:31 +0000688 if (pathname[lastchar] != '/')
689 ++lastchar;
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000690
Ted Kremenekf8cce7d2008-04-03 16:11:31 +0000691 pathname[lastchar] = 0;
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000692
Ted Kremenekf8cce7d2008-04-03 16:11:31 +0000693 if (createDirectoryHelper(pathname, pathname+lastchar, create_parents))
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000694 return MakeErrMsg(ErrMsg,
Ted Kremenekf8cce7d2008-04-03 16:11:31 +0000695 std::string(pathname) + ": can't create directory");
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000696
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000697 return false;
698}
699
700bool
701Path::createFileOnDisk(std::string* ErrMsg) {
702 // Create the file
703 int fd = ::creat(path.c_str(), S_IRUSR | S_IWUSR);
704 if (fd < 0)
705 return MakeErrMsg(ErrMsg, path + ": can't create file");
706 ::close(fd);
707 return false;
708}
709
710bool
711Path::createTemporaryFileOnDisk(bool reuse_current, std::string* ErrMsg) {
712 // Make this into a unique file name
713 if (makeUnique( reuse_current, ErrMsg ))
714 return true;
715
716 // create the file
717 int fd = ::open(path.c_str(), O_WRONLY|O_CREAT|O_TRUNC, 0666);
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000718 if (fd < 0)
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000719 return MakeErrMsg(ErrMsg, path + ": can't create temporary file");
720 ::close(fd);
721 return false;
722}
723
724bool
725Path::eraseFromDisk(bool remove_contents, std::string *ErrStr) const {
726 // Get the status so we can determin if its a file or directory
727 struct stat buf;
728 if (0 != stat(path.c_str(), &buf)) {
729 MakeErrMsg(ErrStr, path + ": can't get status of file");
730 return true;
731 }
732
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000733 // Note: this check catches strange situations. In all cases, LLVM should
734 // only be involved in the creation and deletion of regular files. This
735 // check ensures that what we're trying to erase is a regular file. It
736 // effectively prevents LLVM from erasing things like /dev/null, any block
737 // special file, or other things that aren't "regular" files.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000738 if (S_ISREG(buf.st_mode)) {
739 if (unlink(path.c_str()) != 0)
740 return MakeErrMsg(ErrStr, path + ": can't destroy file");
741 return false;
742 }
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000743
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000744 if (!S_ISDIR(buf.st_mode)) {
745 if (ErrStr) *ErrStr = "not a file or directory";
746 return true;
747 }
748
749 if (remove_contents) {
750 // Recursively descend the directory to remove its contents.
751 std::string cmd = "/bin/rm -rf " + path;
Mikhail Glushenkov61c9b982009-02-15 03:20:32 +0000752 if (system(cmd.c_str()) != 0) {
753 MakeErrMsg(ErrStr, path + ": failed to recursively remove directory.");
754 return true;
755 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000756 return false;
757 }
758
759 // Otherwise, try to just remove the one directory.
760 char pathname[MAXPATHLEN];
761 path.copy(pathname, MAXPATHLEN);
Evan Cheng591bfc82008-05-05 18:30:58 +0000762 size_t lastchar = path.length() - 1;
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000763 if (pathname[lastchar] == '/')
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000764 pathname[lastchar] = 0;
765 else
766 pathname[lastchar+1] = 0;
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000767
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000768 if (rmdir(pathname) != 0)
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000769 return MakeErrMsg(ErrStr,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000770 std::string(pathname) + ": can't erase directory");
771 return false;
772}
773
774bool
775Path::renamePathOnDisk(const Path& newName, std::string* ErrMsg) {
776 if (0 != ::rename(path.c_str(), newName.c_str()))
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000777 return MakeErrMsg(ErrMsg, std::string("can't rename '") + path + "' as '" +
Chris Lattnerb1aa85b2009-08-23 22:45:37 +0000778 newName.str() + "'");
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000779 return false;
780}
781
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000782bool
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000783Path::setStatusInfoOnDisk(const FileStatus &si, std::string *ErrStr) const {
784 struct utimbuf utb;
785 utb.actime = si.modTime.toPosixTime();
786 utb.modtime = utb.actime;
787 if (0 != ::utime(path.c_str(),&utb))
788 return MakeErrMsg(ErrStr, path + ": can't set file modification time");
789 if (0 != ::chmod(path.c_str(),si.mode))
790 return MakeErrMsg(ErrStr, path + ": can't set mode");
791 return false;
792}
793
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000794bool
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000795sys::CopyFile(const sys::Path &Dest, const sys::Path &Src, std::string* ErrMsg){
796 int inFile = -1;
797 int outFile = -1;
798 inFile = ::open(Src.c_str(), O_RDONLY);
799 if (inFile == -1)
Chris Lattnerb1aa85b2009-08-23 22:45:37 +0000800 return MakeErrMsg(ErrMsg, Src.str() +
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000801 ": can't open source file to copy");
802
803 outFile = ::open(Dest.c_str(), O_WRONLY|O_CREAT, 0666);
804 if (outFile == -1) {
805 ::close(inFile);
Chris Lattnerb1aa85b2009-08-23 22:45:37 +0000806 return MakeErrMsg(ErrMsg, Dest.str() +
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000807 ": can't create destination file for copy");
808 }
809
810 char Buffer[16*1024];
811 while (ssize_t Amt = ::read(inFile, Buffer, 16*1024)) {
812 if (Amt == -1) {
813 if (errno != EINTR && errno != EAGAIN) {
814 ::close(inFile);
815 ::close(outFile);
Chris Lattnerb1aa85b2009-08-23 22:45:37 +0000816 return MakeErrMsg(ErrMsg, Src.str()+": can't read source file");
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000817 }
818 } else {
819 char *BufPtr = Buffer;
820 while (Amt) {
821 ssize_t AmtWritten = ::write(outFile, BufPtr, Amt);
822 if (AmtWritten == -1) {
823 if (errno != EINTR && errno != EAGAIN) {
824 ::close(inFile);
825 ::close(outFile);
Chris Lattnerb1aa85b2009-08-23 22:45:37 +0000826 return MakeErrMsg(ErrMsg, Dest.str() +
Daniel Dunbarf7ea85d2009-04-20 20:50:13 +0000827 ": can't write destination file");
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000828 }
829 } else {
830 Amt -= AmtWritten;
831 BufPtr += AmtWritten;
832 }
833 }
834 }
835 }
836 ::close(inFile);
837 ::close(outFile);
838 return false;
839}
840
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000841bool
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000842Path::makeUnique(bool reuse_current, std::string* ErrMsg) {
843 if (reuse_current && !exists())
844 return false; // File doesn't exist already, just use it!
845
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000846 // Append an XXXXXX pattern to the end of the file for use with mkstemp,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000847 // mktemp or our own implementation.
Chris Lattner8755dee2009-08-23 22:57:38 +0000848 SmallVector<char, 128> Buf;
849 Buf.resize(path.size()+8);
850 char *FNBuffer = Buf.data();
Devang Patel79612e12008-07-22 20:02:39 +0000851 path.copy(FNBuffer,path.size());
Devang Pateldb08c702008-07-24 00:35:38 +0000852 if (isDirectory())
853 strcpy(FNBuffer+path.size(), "/XXXXXX");
854 else
Devang Patel79612e12008-07-22 20:02:39 +0000855 strcpy(FNBuffer+path.size(), "-XXXXXX");
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000856
857#if defined(HAVE_MKSTEMP)
858 int TempFD;
859 if ((TempFD = mkstemp(FNBuffer)) == -1)
860 return MakeErrMsg(ErrMsg, path + ": can't make unique filename");
861
862 // We don't need to hold the temp file descriptor... we will trust that no one
863 // will overwrite/delete the file before we can open it again.
864 close(TempFD);
865
866 // Save the name
867 path = FNBuffer;
868#elif defined(HAVE_MKTEMP)
869 // If we don't have mkstemp, use the old and obsolete mktemp function.
870 if (mktemp(FNBuffer) == 0)
871 return MakeErrMsg(ErrMsg, path + ": can't make unique filename");
872
873 // Save the name
874 path = FNBuffer;
875#else
876 // Okay, looks like we have to do it all by our lonesome.
877 static unsigned FCounter = 0;
878 unsigned offset = path.size() + 1;
879 while ( FCounter < 999999 && exists()) {
880 sprintf(FNBuffer+offset,"%06u",++FCounter);
881 path = FNBuffer;
882 }
883 if (FCounter > 999999)
Mikhail Glushenkov9c369df2009-02-15 03:20:03 +0000884 return MakeErrMsg(ErrMsg,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000885 path + ": can't make unique filename: too many files");
886#endif
887 return false;
888}
889
Chris Lattner157d70a2008-04-01 06:00:12 +0000890const char *Path::MapInFilePages(int FD, uint64_t FileSize) {
Chris Lattner7bbb6d62008-04-01 06:16:24 +0000891 int Flags = MAP_PRIVATE;
892#ifdef MAP_FILE
893 Flags |= MAP_FILE;
894#endif
895 void *BasePtr = ::mmap(0, FileSize, PROT_READ, Flags, FD, 0);
896 if (BasePtr == MAP_FAILED)
897 return 0;
Chris Lattner116abbf2008-04-01 06:25:23 +0000898 return (const char*)BasePtr;
Chris Lattner157d70a2008-04-01 06:00:12 +0000899}
900
Chris Lattner7bbb6d62008-04-01 06:16:24 +0000901void Path::UnMapFilePages(const char *BasePtr, uint64_t FileSize) {
Chris Lattner116abbf2008-04-01 06:25:23 +0000902 ::munmap((void*)BasePtr, FileSize);
Chris Lattner157d70a2008-04-01 06:00:12 +0000903}
904
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000905} // end llvm namespace