1 //===- llvm/System/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 //===----------------------------------------------------------------------===//
19 #include "llvm/Config/alloca.h"
27 #ifdef HAVE_SYS_MMAN_H
30 #ifdef HAVE_SYS_STAT_H
41 # define NAMLEN(dirent) strlen((dirent)->d_name)
43 # define dirent direct
44 # define NAMLEN(dirent) (dirent)->d_namlen
46 # include <sys/ndir.h>
60 // Put in a hack for Cygwin which falsely reports that the mkdtemp function
61 // is available when it is not.
67 inline bool lastIsSlash(const std::string& path) {
68 return !path.empty() && path[path.length() - 1] == '/';
76 extern const char sys::PathSeparator = ':';
78 Path::Path(const std::string& p)
81 Path::Path(const char *StrStart, unsigned StrLen)
82 : path(StrStart, StrLen) {}
85 Path::operator=(const std::string &that) {
91 Path::isValid() const {
92 // Check some obvious things
95 else if (path.length() >= MAXPATHLEN)
98 // Check that the characters are ascii chars
99 size_t len = path.length();
101 while (i < len && isascii(path[i]))
107 Path::isAbsolute() const {
110 return path[0] == '/';
113 Path::GetRootDirectory() {
120 Path::GetTemporaryDirectory(std::string *ErrMsg) {
121 #if defined(HAVE_MKDTEMP)
122 // The best way is with mkdtemp but that's not available on many systems,
123 // Linux and FreeBSD have it. Others probably won't.
124 char pathname[MAXPATHLEN];
125 strcpy(pathname,"/tmp/llvm_XXXXXX");
126 if (0 == mkdtemp(pathname)) {
128 std::string(pathname) + ": can't create temporary directory");
132 result.set(pathname);
133 assert(result.isValid() && "mkdtemp didn't create a valid pathname!");
135 #elif defined(HAVE_MKSTEMP)
136 // If no mkdtemp is available, mkstemp can be used to create a temporary file
137 // which is then removed and created as a directory. We prefer this over
138 // mktemp because of mktemp's inherent security and threading risks. We still
139 // have a slight race condition from the time the temporary file is created to
140 // the time it is re-created as a directoy.
141 char pathname[MAXPATHLEN];
142 strcpy(pathname, "/tmp/llvm_XXXXXX");
144 if (-1 == (fd = mkstemp(pathname))) {
146 std::string(pathname) + ": can't create temporary directory");
150 ::unlink(pathname); // start race condition, ignore errors
151 if (-1 == ::mkdir(pathname, S_IRWXU)) { // end race condition
153 std::string(pathname) + ": can't create temporary directory");
157 result.set(pathname);
158 assert(result.isValid() && "mkstemp didn't create a valid 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[MAXPATHLEN];
167 strcpy(pathname, "/tmp/llvm_XXXXXX");
168 char *TmpName = ::mktemp(pathname);
171 std::string(TmpName) + ": can't create unique directory name");
174 if (-1 == ::mkdir(TmpName, S_IRWXU)) {
176 std::string(TmpName) + ": can't create temporary directory");
181 assert(result.isValid() && "mktemp didn't create a valid pathname!");
184 // This is the worst case implementation. tempnam(3) leaks memory unless its
185 // on an SVID2 (or later) system. On BSD 4.3 it leaks. tmpnam(3) has thread
186 // issues. The mktemp(3) function doesn't have enough variability in the
187 // temporary name generated. So, we provide our own implementation that
188 // increments an integer from a random number seeded by the current time. This
189 // should be sufficiently unique that we don't have many collisions between
190 // processes. Generally LLVM processes don't run very long and don't use very
191 // many temporary files so this shouldn't be a big issue for LLVM.
192 static time_t num = ::time(0);
193 char pathname[MAXPATHLEN];
196 sprintf(pathname, "/tmp/llvm_%010u", unsigned(num));
197 } while ( 0 == access(pathname, F_OK ) );
198 if (-1 == ::mkdir(pathname, S_IRWXU)) {
200 std::string(pathname) + ": can't create temporary directory");
204 result.set(pathname);
205 assert(result.isValid() && "mkstemp didn't create a valid pathname!");
211 Path::GetSystemLibraryPaths(std::vector<sys::Path>& Paths) {
212 #ifdef LTDL_SHLIBPATH_VAR
213 char* env_var = getenv(LTDL_SHLIBPATH_VAR);
215 getPathList(env_var,Paths);
218 // FIXME: Should this look at LD_LIBRARY_PATH too?
219 Paths.push_back(sys::Path("/usr/local/lib/"));
220 Paths.push_back(sys::Path("/usr/X11R6/lib/"));
221 Paths.push_back(sys::Path("/usr/lib/"));
222 Paths.push_back(sys::Path("/lib/"));
226 Path::GetBitcodeLibraryPaths(std::vector<sys::Path>& Paths) {
227 char * env_var = getenv("LLVM_LIB_SEARCH_PATH");
229 getPathList(env_var,Paths);
234 if (tmpPath.set(LLVM_LIBDIR))
235 if (tmpPath.canRead())
236 Paths.push_back(tmpPath);
239 GetSystemLibraryPaths(Paths);
243 Path::GetLLVMDefaultConfigDir() {
244 return Path("/etc/llvm/");
248 Path::GetUserHomeDirectory() {
249 const char* home = getenv("HOME");
252 if (result.set(home))
255 return GetRootDirectory();
259 Path::GetCurrentDirectory() {
260 char pathname[MAXPATHLEN];
261 if (!getcwd(pathname,MAXPATHLEN)) {
262 assert (false && "Could not query current working directory.");
266 return Path(pathname);
271 test_dir(char buf[PATH_MAX], char ret[PATH_MAX],
272 const char *dir, const char *bin)
276 snprintf(buf, PATH_MAX, "%s//%s", dir, bin);
277 if (realpath(buf, ret) == NULL)
279 if (stat(buf, &sb) != 0)
286 getprogpath(char ret[PATH_MAX], const char *bin)
288 char *pv, *s, *t, buf[PATH_MAX];
290 /* First approach: absolute path. */
292 if (test_dir(buf, ret, "/", bin) == 0)
297 /* Second approach: relative path. */
298 if (strchr(bin, '/') != NULL) {
299 if (getcwd(buf, PATH_MAX) == NULL)
301 if (test_dir(buf, ret, buf, bin) == 0)
306 /* Third approach: $PATH */
307 if ((pv = getenv("PATH")) == NULL)
312 while ((t = strsep(&s, ":")) != NULL) {
313 if (test_dir(buf, ret, t, bin) == 0) {
323 /// GetMainExecutable - Return the path to the main executable, given the
324 /// value of argv[0] from program startup.
325 Path Path::GetMainExecutable(const char *argv0, void *MainAddr) {
326 #if defined(__FreeBSD__)
327 char exe_path[PATH_MAX];
329 if (getprogpath(exe_path, argv0) != NULL)
330 return Path(std::string(exe_path));
331 #elif defined(__linux__) || defined(__CYGWIN__)
332 char exe_path[MAXPATHLEN];
333 ssize_t len = readlink("/proc/self/exe", exe_path, sizeof(exe_path));
334 if (len > 0 && len < MAXPATHLEN - 1) {
335 exe_path[len] = '\0';
336 return Path(std::string(exe_path));
338 #elif defined(HAVE_DLFCN_H)
339 // Use dladdr to get executable path if available.
341 int err = dladdr(MainAddr, &DLInfo);
345 // If the filename is a symlink, we need to resolve and return the location of
346 // the actual executable.
347 char link_path[MAXPATHLEN];
348 return Path(std::string(realpath(DLInfo.dli_fname, link_path)));
354 std::string Path::getDirname() const {
355 return getDirnameCharSep(path, '/');
359 Path::getBasename() const {
360 // Find the last slash
361 std::string::size_type slash = path.rfind('/');
362 if (slash == std::string::npos)
367 std::string::size_type dot = path.rfind('.');
368 if (dot == std::string::npos || dot < slash)
369 return path.substr(slash);
371 return path.substr(slash, dot - slash);
375 Path::getSuffix() const {
376 // Find the last slash
377 std::string::size_type slash = path.rfind('/');
378 if (slash == std::string::npos)
383 std::string::size_type dot = path.rfind('.');
384 if (dot == std::string::npos || dot < slash)
385 return std::string();
387 return path.substr(dot + 1);
390 bool Path::getMagicNumber(std::string& Magic, unsigned len) const {
391 assert(len < 1024 && "Request for magic string too long");
392 char* buf = (char*) alloca(1 + len);
393 int fd = ::open(path.c_str(), O_RDONLY);
396 ssize_t bytes_read = ::read(fd, buf, len);
398 if (ssize_t(len) != bytes_read) {
402 Magic.assign(buf,len);
407 Path::exists() const {
408 return 0 == access(path.c_str(), F_OK );
412 Path::isDirectory() const {
414 if (0 != stat(path.c_str(), &buf))
416 return buf.st_mode & S_IFDIR ? true : false;
420 Path::canRead() const {
421 return 0 == access(path.c_str(), F_OK | R_OK );
425 Path::canWrite() const {
426 return 0 == access(path.c_str(), F_OK | W_OK );
430 Path::canExecute() const {
431 if (0 != access(path.c_str(), R_OK | X_OK ))
434 if (0 != stat(path.c_str(), &buf))
436 if (!S_ISREG(buf.st_mode))
442 Path::getLast() const {
443 // Find the last slash
444 size_t pos = path.rfind('/');
446 // Handle the corner cases
447 if (pos == std::string::npos)
450 // If the last character is a slash
451 if (pos == path.length()-1) {
452 // Find the second to last slash
453 size_t pos2 = path.rfind('/', pos-1);
454 if (pos2 == std::string::npos)
455 return path.substr(0,pos);
457 return path.substr(pos2+1,pos-pos2-1);
459 // Return everything after the last slash
460 return path.substr(pos+1);
464 PathWithStatus::getFileStatus(bool update, std::string *ErrStr) const {
465 if (!fsIsValid || update) {
467 if (0 != stat(path.c_str(), &buf)) {
468 MakeErrMsg(ErrStr, path + ": can't get status of file");
471 status.fileSize = buf.st_size;
472 status.modTime.fromEpochTime(buf.st_mtime);
473 status.mode = buf.st_mode;
474 status.user = buf.st_uid;
475 status.group = buf.st_gid;
476 status.uniqueID = uint64_t(buf.st_ino);
477 status.isDir = S_ISDIR(buf.st_mode);
478 status.isFile = S_ISREG(buf.st_mode);
484 static bool AddPermissionBits(const Path &File, int bits) {
485 // Get the umask value from the operating system. We want to use it
486 // when changing the file's permissions. Since calling umask() sets
487 // the umask and returns its old value, we must call it a second
488 // time to reset it to the user's preference.
489 int mask = umask(0777); // The arg. to umask is arbitrary.
490 umask(mask); // Restore the umask.
492 // Get the file's current mode.
494 if (0 != stat(File.toString().c_str(), &buf))
496 // Change the file to have whichever permissions bits from 'bits'
497 // that the umask would not disable.
498 if ((chmod(File.c_str(), (buf.st_mode | (bits & ~mask)))) == -1)
503 bool Path::makeReadableOnDisk(std::string* ErrMsg) {
504 if (!AddPermissionBits(*this, 0444))
505 return MakeErrMsg(ErrMsg, path + ": can't make file readable");
509 bool Path::makeWriteableOnDisk(std::string* ErrMsg) {
510 if (!AddPermissionBits(*this, 0222))
511 return MakeErrMsg(ErrMsg, path + ": can't make file writable");
515 bool Path::makeExecutableOnDisk(std::string* ErrMsg) {
516 if (!AddPermissionBits(*this, 0111))
517 return MakeErrMsg(ErrMsg, path + ": can't make file executable");
522 Path::getDirectoryContents(std::set<Path>& result, std::string* ErrMsg) const {
523 DIR* direntries = ::opendir(path.c_str());
525 return MakeErrMsg(ErrMsg, path + ": can't open directory");
527 std::string dirPath = path;
528 if (!lastIsSlash(dirPath))
532 struct dirent* de = ::readdir(direntries);
533 for ( ; de != 0; de = ::readdir(direntries)) {
534 if (de->d_name[0] != '.') {
535 Path aPath(dirPath + (const char*)de->d_name);
537 if (0 != lstat(aPath.path.c_str(), &st)) {
538 if (S_ISLNK(st.st_mode))
539 continue; // dangling symlink -- ignore
540 return MakeErrMsg(ErrMsg,
541 aPath.path + ": can't determine file object type");
543 result.insert(aPath);
547 closedir(direntries);
552 Path::set(const std::string& a_path) {
555 std::string save(path);
565 Path::appendComponent(const std::string& name) {
568 std::string save(path);
569 if (!lastIsSlash(path))
580 Path::eraseComponent() {
581 size_t slashpos = path.rfind('/',path.size());
582 if (slashpos == 0 || slashpos == std::string::npos) {
586 if (slashpos == path.size() - 1)
587 slashpos = path.rfind('/',slashpos-1);
588 if (slashpos == std::string::npos) {
592 path.erase(slashpos);
597 Path::appendSuffix(const std::string& suffix) {
598 std::string save(path);
609 Path::eraseSuffix() {
610 std::string save = path;
611 size_t dotpos = path.rfind('.',path.size());
612 size_t slashpos = path.rfind('/',path.size());
613 if (dotpos != std::string::npos) {
614 if (slashpos == std::string::npos || dotpos > slashpos+1) {
615 path.erase(dotpos, path.size()-dotpos);
624 static bool createDirectoryHelper(char* beg, char* end, bool create_parents) {
626 if (access(beg, F_OK | R_OK | W_OK) == 0)
629 if (create_parents) {
633 for (; c != beg; --c)
636 // Recurse to handling the parent directory.
638 bool x = createDirectoryHelper(beg, c, create_parents);
641 // Return if we encountered an error.
649 return mkdir(beg, S_IRWXU | S_IRWXG) != 0;
653 Path::createDirectoryOnDisk( bool create_parents, std::string* ErrMsg ) {
654 // Get a writeable copy of the path name
655 char pathname[MAXPATHLEN];
656 path.copy(pathname,MAXPATHLEN);
658 // Null-terminate the last component
659 size_t lastchar = path.length() - 1 ;
661 if (pathname[lastchar] != '/')
664 pathname[lastchar] = 0;
666 if (createDirectoryHelper(pathname, pathname+lastchar, create_parents))
667 return MakeErrMsg(ErrMsg,
668 std::string(pathname) + ": can't create directory");
674 Path::createFileOnDisk(std::string* ErrMsg) {
676 int fd = ::creat(path.c_str(), S_IRUSR | S_IWUSR);
678 return MakeErrMsg(ErrMsg, path + ": can't create file");
684 Path::createTemporaryFileOnDisk(bool reuse_current, std::string* ErrMsg) {
685 // Make this into a unique file name
686 if (makeUnique( reuse_current, ErrMsg ))
690 int fd = ::open(path.c_str(), O_WRONLY|O_CREAT|O_TRUNC, 0666);
692 return MakeErrMsg(ErrMsg, path + ": can't create temporary file");
698 Path::eraseFromDisk(bool remove_contents, std::string *ErrStr) const {
699 // Get the status so we can determin if its a file or directory
701 if (0 != stat(path.c_str(), &buf)) {
702 MakeErrMsg(ErrStr, path + ": can't get status of file");
706 // Note: this check catches strange situations. In all cases, LLVM should
707 // only be involved in the creation and deletion of regular files. This
708 // check ensures that what we're trying to erase is a regular file. It
709 // effectively prevents LLVM from erasing things like /dev/null, any block
710 // special file, or other things that aren't "regular" files.
711 if (S_ISREG(buf.st_mode)) {
712 if (unlink(path.c_str()) != 0)
713 return MakeErrMsg(ErrStr, path + ": can't destroy file");
717 if (!S_ISDIR(buf.st_mode)) {
718 if (ErrStr) *ErrStr = "not a file or directory";
722 if (remove_contents) {
723 // Recursively descend the directory to remove its contents.
724 std::string cmd = "/bin/rm -rf " + path;
725 if (system(cmd.c_str()) != 0) {
726 MakeErrMsg(ErrStr, path + ": failed to recursively remove directory.");
732 // Otherwise, try to just remove the one directory.
733 char pathname[MAXPATHLEN];
734 path.copy(pathname, MAXPATHLEN);
735 size_t lastchar = path.length() - 1;
736 if (pathname[lastchar] == '/')
737 pathname[lastchar] = 0;
739 pathname[lastchar+1] = 0;
741 if (rmdir(pathname) != 0)
742 return MakeErrMsg(ErrStr,
743 std::string(pathname) + ": can't erase directory");
748 Path::renamePathOnDisk(const Path& newName, std::string* ErrMsg) {
749 if (0 != ::rename(path.c_str(), newName.c_str()))
750 return MakeErrMsg(ErrMsg, std::string("can't rename '") + path + "' as '" +
751 newName.toString() + "'");
756 Path::setStatusInfoOnDisk(const FileStatus &si, std::string *ErrStr) const {
758 utb.actime = si.modTime.toPosixTime();
759 utb.modtime = utb.actime;
760 if (0 != ::utime(path.c_str(),&utb))
761 return MakeErrMsg(ErrStr, path + ": can't set file modification time");
762 if (0 != ::chmod(path.c_str(),si.mode))
763 return MakeErrMsg(ErrStr, path + ": can't set mode");
768 sys::CopyFile(const sys::Path &Dest, const sys::Path &Src, std::string* ErrMsg){
771 inFile = ::open(Src.c_str(), O_RDONLY);
773 return MakeErrMsg(ErrMsg, Src.toString() +
774 ": can't open source file to copy");
776 outFile = ::open(Dest.c_str(), O_WRONLY|O_CREAT, 0666);
779 return MakeErrMsg(ErrMsg, Dest.toString() +
780 ": can't create destination file for copy");
783 char Buffer[16*1024];
784 while (ssize_t Amt = ::read(inFile, Buffer, 16*1024)) {
786 if (errno != EINTR && errno != EAGAIN) {
789 return MakeErrMsg(ErrMsg, Src.toString()+": can't read source file");
792 char *BufPtr = Buffer;
794 ssize_t AmtWritten = ::write(outFile, BufPtr, Amt);
795 if (AmtWritten == -1) {
796 if (errno != EINTR && errno != EAGAIN) {
799 return MakeErrMsg(ErrMsg, Dest.toString() +
800 ": can't write destination file");
804 BufPtr += AmtWritten;
815 Path::makeUnique(bool reuse_current, std::string* ErrMsg) {
816 if (reuse_current && !exists())
817 return false; // File doesn't exist already, just use it!
819 // Append an XXXXXX pattern to the end of the file for use with mkstemp,
820 // mktemp or our own implementation.
821 char *FNBuffer = (char*) alloca(path.size()+8);
822 path.copy(FNBuffer,path.size());
824 strcpy(FNBuffer+path.size(), "/XXXXXX");
826 strcpy(FNBuffer+path.size(), "-XXXXXX");
828 #if defined(HAVE_MKSTEMP)
830 if ((TempFD = mkstemp(FNBuffer)) == -1)
831 return MakeErrMsg(ErrMsg, path + ": can't make unique filename");
833 // We don't need to hold the temp file descriptor... we will trust that no one
834 // will overwrite/delete the file before we can open it again.
839 #elif defined(HAVE_MKTEMP)
840 // If we don't have mkstemp, use the old and obsolete mktemp function.
841 if (mktemp(FNBuffer) == 0)
842 return MakeErrMsg(ErrMsg, path + ": can't make unique filename");
847 // Okay, looks like we have to do it all by our lonesome.
848 static unsigned FCounter = 0;
849 unsigned offset = path.size() + 1;
850 while ( FCounter < 999999 && exists()) {
851 sprintf(FNBuffer+offset,"%06u",++FCounter);
854 if (FCounter > 999999)
855 return MakeErrMsg(ErrMsg,
856 path + ": can't make unique filename: too many files");
861 const char *Path::MapInFilePages(int FD, uint64_t FileSize) {
862 int Flags = MAP_PRIVATE;
866 void *BasePtr = ::mmap(0, FileSize, PROT_READ, Flags, FD, 0);
867 if (BasePtr == MAP_FAILED)
869 return (const char*)BasePtr;
872 void Path::UnMapFilePages(const char *BasePtr, uint64_t FileSize) {
873 ::munmap((void*)BasePtr, FileSize);
876 } // end llvm namespace