1 //===- llvm/Support/Unix/Path.cpp - Unix Path Implementation -----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the Unix specific portion of the Path class.
12 //===----------------------------------------------------------------------===//
14 //===----------------------------------------------------------------------===//
15 //=== WARNING: Implementation here must contain only generic UNIX code that
16 //=== is guaranteed to work on *all* UNIX variants.
17 //===----------------------------------------------------------------------===//
26 #ifdef HAVE_SYS_MMAN_H
29 #ifdef HAVE_SYS_STAT_H
40 # define NAMLEN(dirent) strlen((dirent)->d_name)
42 # define dirent direct
43 # define NAMLEN(dirent) (dirent)->d_namlen
45 # include <sys/ndir.h>
60 #include <mach-o/dyld.h>
64 #if defined(__GNU__) && !defined(MAXPATHLEN)
65 # define MAXPATHLEN 4096
68 // Put in a hack for Cygwin which falsely reports that the mkdtemp function
69 // is available when it is not.
75 inline bool lastIsSlash(const std::string& path) {
76 return !path.empty() && path[path.length() - 1] == '/';
84 const char sys::PathSeparator = ':';
86 StringRef Path::GetEXESuffix() {
90 Path::Path(StringRef p)
93 Path::Path(const char *StrStart, unsigned StrLen)
94 : path(StrStart, StrLen) {}
97 Path::operator=(StringRef that) {
98 path.assign(that.data(), that.size());
103 Path::isValid() const {
104 // Empty paths are considered invalid here.
105 // This code doesn't check MAXPATHLEN because there's no need. Nothing in
106 // LLVM manipulates Paths with fixed-sizes arrays, and if the OS can't
107 // handle names longer than some limit, it'll report this on demand using
109 return !path.empty();
113 Path::isAbsolute(const char *NameStart, unsigned NameLen) {
117 return NameStart[0] == '/';
121 Path::isAbsolute() const {
124 return path[0] == '/';
128 Path::GetTemporaryDirectory(std::string *ErrMsg) {
129 #if defined(HAVE_MKDTEMP)
130 // The best way is with mkdtemp but that's not available on many systems,
131 // Linux and FreeBSD have it. Others probably won't.
132 char pathname[] = "/tmp/llvm_XXXXXX";
133 if (0 == mkdtemp(pathname)) {
135 std::string(pathname) + ": can't create temporary directory");
138 return Path(pathname);
139 #elif defined(HAVE_MKSTEMP)
140 // If no mkdtemp is available, mkstemp can be used to create a temporary file
141 // which is then removed and created as a directory. We prefer this over
142 // mktemp because of mktemp's inherent security and threading risks. We still
143 // have a slight race condition from the time the temporary file is created to
144 // the time it is re-created as a directoy.
145 char pathname[] = "/tmp/llvm_XXXXXX";
147 if (-1 == (fd = mkstemp(pathname))) {
149 std::string(pathname) + ": can't create temporary directory");
153 ::unlink(pathname); // start race condition, ignore errors
154 if (-1 == ::mkdir(pathname, S_IRWXU)) { // end race condition
156 std::string(pathname) + ": can't create temporary directory");
159 return Path(pathname);
160 #elif defined(HAVE_MKTEMP)
161 // If a system doesn't have mkdtemp(3) or mkstemp(3) but it does have
162 // mktemp(3) then we'll assume that system (e.g. AIX) has a reasonable
163 // implementation of mktemp(3) and doesn't follow BSD 4.3's lead of replacing
164 // the XXXXXX with the pid of the process and a letter. That leads to only
165 // twenty six temporary files that can be generated.
166 char pathname[] = "/tmp/llvm_XXXXXX";
167 char *TmpName = ::mktemp(pathname);
170 std::string(TmpName) + ": can't create unique directory name");
173 if (-1 == ::mkdir(TmpName, S_IRWXU)) {
175 std::string(TmpName) + ": can't create temporary directory");
178 return Path(TmpName);
180 // This is the worst case implementation. tempnam(3) leaks memory unless its
181 // on an SVID2 (or later) system. On BSD 4.3 it leaks. tmpnam(3) has thread
182 // issues. The mktemp(3) function doesn't have enough variability in the
183 // temporary name generated. So, we provide our own implementation that
184 // increments an integer from a random number seeded by the current time. This
185 // should be sufficiently unique that we don't have many collisions between
186 // processes. Generally LLVM processes don't run very long and don't use very
187 // many temporary files so this shouldn't be a big issue for LLVM.
188 static time_t num = ::time(0);
189 char pathname[MAXPATHLEN];
192 sprintf(pathname, "/tmp/llvm_%010u", unsigned(num));
193 } while ( 0 == access(pathname, F_OK ) );
194 if (-1 == ::mkdir(pathname, S_IRWXU)) {
196 std::string(pathname) + ": can't create temporary directory");
199 return Path(pathname);
204 Path::GetCurrentDirectory() {
205 char pathname[MAXPATHLEN];
206 if (!getcwd(pathname, MAXPATHLEN)) {
207 assert(false && "Could not query current working directory.");
211 return Path(pathname);
214 #if defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
215 defined(__OpenBSD__) || defined(__minix) || defined(__FreeBSD_kernel__) || \
216 defined(__linux__) || defined(__CYGWIN__)
218 test_dir(char buf[PATH_MAX], char ret[PATH_MAX],
219 const char *dir, const char *bin)
223 snprintf(buf, PATH_MAX, "%s/%s", dir, bin);
224 if (realpath(buf, ret) == NULL)
226 if (stat(buf, &sb) != 0)
233 getprogpath(char ret[PATH_MAX], const char *bin)
235 char *pv, *s, *t, buf[PATH_MAX];
237 /* First approach: absolute path. */
239 if (test_dir(buf, ret, "/", bin) == 0)
244 /* Second approach: relative path. */
245 if (strchr(bin, '/') != NULL) {
246 if (getcwd(buf, PATH_MAX) == NULL)
248 if (test_dir(buf, ret, buf, bin) == 0)
253 /* Third approach: $PATH */
254 if ((pv = getenv("PATH")) == NULL)
259 while ((t = strsep(&s, ":")) != NULL) {
260 if (test_dir(buf, ret, t, bin) == 0) {
268 #endif // __FreeBSD__ || __NetBSD__ || __FreeBSD_kernel__
270 /// GetMainExecutable - Return the path to the main executable, given the
271 /// value of argv[0] from program startup.
272 Path Path::GetMainExecutable(const char *argv0, void *MainAddr) {
273 #if defined(__APPLE__)
274 // On OS X the executable path is saved to the stack by dyld. Reading it
275 // from there is much faster than calling dladdr, especially for large
276 // binaries with symbols.
277 char exe_path[MAXPATHLEN];
278 uint32_t size = sizeof(exe_path);
279 if (_NSGetExecutablePath(exe_path, &size) == 0) {
280 char link_path[MAXPATHLEN];
281 if (realpath(exe_path, link_path))
282 return Path(link_path);
284 #elif defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
285 defined(__OpenBSD__) || defined(__minix) || defined(__FreeBSD_kernel__)
286 char exe_path[PATH_MAX];
288 if (getprogpath(exe_path, argv0) != NULL)
289 return Path(exe_path);
290 #elif defined(__linux__) || defined(__CYGWIN__)
291 char exe_path[MAXPATHLEN];
292 StringRef aPath("/proc/self/exe");
293 if (sys::fs::exists(aPath)) {
294 // /proc is not always mounted under Linux (chroot for example).
295 ssize_t len = readlink(aPath.str().c_str(), exe_path, sizeof(exe_path));
297 return Path(StringRef(exe_path, len));
299 // Fall back to the classical detection.
300 if (getprogpath(exe_path, argv0) != NULL)
301 return Path(exe_path);
303 #elif defined(HAVE_DLFCN_H)
304 // Use dladdr to get executable path if available.
306 int err = dladdr(MainAddr, &DLInfo);
310 // If the filename is a symlink, we need to resolve and return the location of
311 // the actual executable.
312 char link_path[MAXPATHLEN];
313 if (realpath(DLInfo.dli_fname, link_path))
314 return Path(link_path);
316 #error GetMainExecutable is not implemented on this host yet.
323 Path::getSuffix() const {
324 // Find the last slash
325 std::string::size_type slash = path.rfind('/');
326 if (slash == std::string::npos)
331 std::string::size_type dot = path.rfind('.');
332 if (dot == std::string::npos || dot < slash)
335 return StringRef(path).substr(dot + 1);
338 bool Path::getMagicNumber(std::string &Magic, unsigned len) const {
339 assert(len < 1024 && "Request for magic string too long");
341 int fd = ::open(path.c_str(), O_RDONLY);
344 ssize_t bytes_read = ::read(fd, Buf, len);
346 if (ssize_t(len) != bytes_read)
348 Magic.assign(Buf, len);
353 Path::exists() const {
354 return 0 == access(path.c_str(), F_OK );
358 Path::isDirectory() const {
360 if (0 != stat(path.c_str(), &buf))
362 return ((buf.st_mode & S_IFMT) == S_IFDIR) ? true : false;
366 Path::isSymLink() const {
368 if (0 != lstat(path.c_str(), &buf))
370 return S_ISLNK(buf.st_mode);
375 Path::canRead() const {
376 return 0 == access(path.c_str(), R_OK);
380 Path::canWrite() const {
381 return 0 == access(path.c_str(), W_OK);
385 Path::isRegularFile() const {
386 // Get the status so we can determine if it's a file or directory
389 if (0 != stat(path.c_str(), &buf))
392 if (S_ISREG(buf.st_mode))
399 Path::canExecute() const {
400 if (0 != access(path.c_str(), R_OK | X_OK ))
403 if (0 != stat(path.c_str(), &buf))
405 if (!S_ISREG(buf.st_mode))
411 PathWithStatus::getFileStatus(bool update, std::string *ErrStr) const {
412 if (!fsIsValid || update) {
414 if (0 != stat(path.c_str(), &buf)) {
415 MakeErrMsg(ErrStr, path + ": can't get status of file");
418 status.fileSize = buf.st_size;
419 status.modTime.fromEpochTime(buf.st_mtime);
420 status.mode = buf.st_mode;
421 status.user = buf.st_uid;
422 status.group = buf.st_gid;
423 status.uniqueID = uint64_t(buf.st_ino);
424 status.isDir = S_ISDIR(buf.st_mode);
425 status.isFile = S_ISREG(buf.st_mode);
431 static bool AddPermissionBits(const Path &File, int bits) {
432 // Get the umask value from the operating system. We want to use it
433 // when changing the file's permissions. Since calling umask() sets
434 // the umask and returns its old value, we must call it a second
435 // time to reset it to the user's preference.
436 int mask = umask(0777); // The arg. to umask is arbitrary.
437 umask(mask); // Restore the umask.
439 // Get the file's current mode.
441 if (0 != stat(File.c_str(), &buf))
443 // Change the file to have whichever permissions bits from 'bits'
444 // that the umask would not disable.
445 if ((chmod(File.c_str(), (buf.st_mode | (bits & ~mask)))) == -1)
450 bool Path::makeReadableOnDisk(std::string* ErrMsg) {
451 if (!AddPermissionBits(*this, 0444))
452 return MakeErrMsg(ErrMsg, path + ": can't make file readable");
456 bool Path::makeWriteableOnDisk(std::string* ErrMsg) {
457 if (!AddPermissionBits(*this, 0222))
458 return MakeErrMsg(ErrMsg, path + ": can't make file writable");
463 Path::getDirectoryContents(std::set<Path>& result, std::string* ErrMsg) const {
464 DIR* direntries = ::opendir(path.c_str());
466 return MakeErrMsg(ErrMsg, path + ": can't open directory");
468 std::string dirPath = path;
469 if (!lastIsSlash(dirPath))
473 struct dirent* de = ::readdir(direntries);
474 for ( ; de != 0; de = ::readdir(direntries)) {
475 if (de->d_name[0] != '.') {
476 Path aPath(dirPath + (const char*)de->d_name);
478 if (0 != lstat(aPath.path.c_str(), &st)) {
479 if (S_ISLNK(st.st_mode))
480 continue; // dangling symlink -- ignore
481 return MakeErrMsg(ErrMsg,
482 aPath.path + ": can't determine file object type");
484 result.insert(aPath);
488 closedir(direntries);
493 Path::set(StringRef a_path) {
501 Path::appendComponent(StringRef name) {
504 if (!lastIsSlash(path))
511 Path::eraseComponent() {
512 size_t slashpos = path.rfind('/',path.size());
513 if (slashpos == 0 || slashpos == std::string::npos) {
517 if (slashpos == path.size() - 1)
518 slashpos = path.rfind('/',slashpos-1);
519 if (slashpos == std::string::npos) {
523 path.erase(slashpos);
528 Path::eraseSuffix() {
529 size_t dotpos = path.rfind('.',path.size());
530 size_t slashpos = path.rfind('/',path.size());
531 if (dotpos != std::string::npos) {
532 if (slashpos == std::string::npos || dotpos > slashpos+1) {
533 path.erase(dotpos, path.size()-dotpos);
540 static bool createDirectoryHelper(char* beg, char* end, bool create_parents) {
542 if (access(beg, R_OK | W_OK) == 0)
545 if (create_parents) {
549 for (; c != beg; --c)
552 // Recurse to handling the parent directory.
554 bool x = createDirectoryHelper(beg, c, create_parents);
557 // Return if we encountered an error.
565 return mkdir(beg, S_IRWXU | S_IRWXG) != 0;
569 Path::createDirectoryOnDisk( bool create_parents, std::string* ErrMsg ) {
570 // Get a writeable copy of the path name
571 std::string pathname(path);
573 // Null-terminate the last component
574 size_t lastchar = path.length() - 1 ;
576 if (pathname[lastchar] != '/')
579 pathname[lastchar] = '\0';
581 if (createDirectoryHelper(&pathname[0], &pathname[lastchar], create_parents))
582 return MakeErrMsg(ErrMsg, pathname + ": can't create directory");
588 Path::createFileOnDisk(std::string* ErrMsg) {
590 int fd = ::creat(path.c_str(), S_IRUSR | S_IWUSR);
592 return MakeErrMsg(ErrMsg, path + ": can't create file");
598 Path::createTemporaryFileOnDisk(bool reuse_current, std::string* ErrMsg) {
599 // Make this into a unique file name
600 if (makeUnique( reuse_current, ErrMsg ))
604 int fd = ::open(path.c_str(), O_WRONLY|O_CREAT|O_TRUNC, 0666);
606 return MakeErrMsg(ErrMsg, path + ": can't create temporary file");
612 Path::eraseFromDisk(bool remove_contents, std::string *ErrStr) const {
613 // Get the status so we can determine if it's a file or directory.
615 if (0 != stat(path.c_str(), &buf)) {
616 MakeErrMsg(ErrStr, path + ": can't get status of file");
620 // Note: this check catches strange situations. In all cases, LLVM should
621 // only be involved in the creation and deletion of regular files. This
622 // check ensures that what we're trying to erase is a regular file. It
623 // effectively prevents LLVM from erasing things like /dev/null, any block
624 // special file, or other things that aren't "regular" files.
625 if (S_ISREG(buf.st_mode)) {
626 if (unlink(path.c_str()) != 0)
627 return MakeErrMsg(ErrStr, path + ": can't destroy file");
631 if (!S_ISDIR(buf.st_mode)) {
632 if (ErrStr) *ErrStr = "not a file or directory";
636 if (remove_contents) {
637 // Recursively descend the directory to remove its contents.
638 std::string cmd = "/bin/rm -rf " + path;
639 if (system(cmd.c_str()) != 0) {
640 MakeErrMsg(ErrStr, path + ": failed to recursively remove directory.");
646 // Otherwise, try to just remove the one directory.
647 std::string pathname(path);
648 size_t lastchar = path.length() - 1;
649 if (pathname[lastchar] == '/')
650 pathname[lastchar] = '\0';
652 pathname[lastchar+1] = '\0';
654 if (rmdir(pathname.c_str()) != 0)
655 return MakeErrMsg(ErrStr, pathname + ": can't erase directory");
660 Path::renamePathOnDisk(const Path& newName, std::string* ErrMsg) {
661 if (0 != ::rename(path.c_str(), newName.c_str()))
662 return MakeErrMsg(ErrMsg, std::string("can't rename '") + path + "' as '" +
663 newName.str() + "'");
668 Path::setStatusInfoOnDisk(const FileStatus &si, std::string *ErrStr) const {
670 utb.actime = si.modTime.toPosixTime();
671 utb.modtime = utb.actime;
672 if (0 != ::utime(path.c_str(),&utb))
673 return MakeErrMsg(ErrStr, path + ": can't set file modification time");
674 if (0 != ::chmod(path.c_str(),si.mode))
675 return MakeErrMsg(ErrStr, path + ": can't set mode");
680 sys::CopyFile(const sys::Path &Dest, const sys::Path &Src, std::string* ErrMsg){
683 inFile = ::open(Src.c_str(), O_RDONLY);
685 return MakeErrMsg(ErrMsg, Src.str() +
686 ": can't open source file to copy");
688 outFile = ::open(Dest.c_str(), O_WRONLY|O_CREAT, 0666);
691 return MakeErrMsg(ErrMsg, Dest.str() +
692 ": can't create destination file for copy");
695 char Buffer[16*1024];
696 while (ssize_t Amt = ::read(inFile, Buffer, 16*1024)) {
698 if (errno != EINTR && errno != EAGAIN) {
701 return MakeErrMsg(ErrMsg, Src.str()+": can't read source file");
704 char *BufPtr = Buffer;
706 ssize_t AmtWritten = ::write(outFile, BufPtr, Amt);
707 if (AmtWritten == -1) {
708 if (errno != EINTR && errno != EAGAIN) {
711 return MakeErrMsg(ErrMsg, Dest.str() +
712 ": can't write destination file");
716 BufPtr += AmtWritten;
727 Path::makeUnique(bool reuse_current, std::string* ErrMsg) {
729 if (reuse_current && (fs::exists(path, Exists) || !Exists))
730 return false; // File doesn't exist already, just use it!
732 // Append an XXXXXX pattern to the end of the file for use with mkstemp,
733 // mktemp or our own implementation.
734 // This uses std::vector instead of SmallVector to avoid a dependence on
735 // libSupport. And performance isn't critical here.
736 std::vector<char> Buf;
737 Buf.resize(path.size()+8);
738 char *FNBuffer = &Buf[0];
739 path.copy(FNBuffer,path.size());
741 if (!fs::is_directory(path, isdir) && isdir)
742 strcpy(FNBuffer+path.size(), "/XXXXXX");
744 strcpy(FNBuffer+path.size(), "-XXXXXX");
746 #if defined(HAVE_MKSTEMP)
748 if ((TempFD = mkstemp(FNBuffer)) == -1)
749 return MakeErrMsg(ErrMsg, path + ": can't make unique filename");
751 // We don't need to hold the temp file descriptor... we will trust that no one
752 // will overwrite/delete the file before we can open it again.
758 // By default mkstemp sets the mode to 0600, so update mode bits now.
759 AddPermissionBits (*this, 0666);
760 #elif defined(HAVE_MKTEMP)
761 // If we don't have mkstemp, use the old and obsolete mktemp function.
762 if (mktemp(FNBuffer) == 0)
763 return MakeErrMsg(ErrMsg, path + ": can't make unique filename");
768 // Okay, looks like we have to do it all by our lonesome.
769 static unsigned FCounter = 0;
770 // Try to initialize with unique value.
771 if (FCounter == 0) FCounter = ((unsigned)getpid() & 0xFFFF) << 8;
772 char* pos = strstr(FNBuffer, "XXXXXX");
774 if (++FCounter > 0xFFFFFF) {
775 return MakeErrMsg(ErrMsg,
776 path + ": can't make unique filename: too many files");
778 sprintf(pos, "%06X", FCounter);
781 // POSSIBLE SECURITY BUG: An attacker can easily guess the name and exploit
787 const char *Path::MapInFilePages(int FD, size_t FileSize, off_t Offset) {
788 int Flags = MAP_PRIVATE;
792 void *BasePtr = ::mmap(0, FileSize, PROT_READ, Flags, FD, Offset);
793 if (BasePtr == MAP_FAILED)
795 return (const char*)BasePtr;
798 void Path::UnMapFilePages(const char *BasePtr, size_t FileSize) {
799 const void *Addr = static_cast<const void *>(BasePtr);
800 ::munmap(const_cast<void *>(Addr), FileSize);
803 } // end llvm namespace