1 //===- llvm/System/Unix/Path.cpp - Unix Path Implementation -----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by Reid Spencer and is distributed under the
6 // University of Illinois Open Source 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"
35 # define NAMLEN(dirent) strlen((dirent)->d_name)
37 # define dirent direct
38 # define NAMLEN(dirent) (dirent)->d_namlen
40 # include <sys/ndir.h>
50 // Put in a hack for Cygwin which falsely reports that the mkdtemp function
51 // is available when it is not.
59 Path::Path(const std::string& unverified_path) : path(unverified_path) {
60 if (unverified_path.empty())
66 ThrowErrno(unverified_path + ": path is not valid");
70 Path::isValid() const {
73 else if (path.length() >= MAXPATHLEN)
75 #if defined(HAVE_REALPATH)
76 char pathname[MAXPATHLEN];
77 if (0 == realpath(path.c_str(), pathname))
78 if (errno != EACCES && errno != EIO && errno != ENOENT && errno != ENOTDIR)
85 Path::GetRootDirectory() {
92 Path::GetTemporaryDirectory() {
93 #if defined(HAVE_MKDTEMP)
94 // The best way is with mkdtemp but that's not available on many systems,
95 // Linux and FreeBSD have it. Others probably won't.
96 char pathname[MAXPATHLEN];
97 strcpy(pathname,"/tmp/llvm_XXXXXX");
98 if (0 == mkdtemp(pathname))
99 ThrowErrno(std::string(pathname) + ": can't create temporary directory");
101 result.set(pathname);
102 assert(result.isValid() && "mkdtemp didn't create a valid pathname!");
104 #elif defined(HAVE_MKSTEMP)
105 // If no mkdtemp is available, mkstemp can be used to create a temporary file
106 // which is then removed and created as a directory. We prefer this over
107 // mktemp because of mktemp's inherent security and threading risks. We still
108 // have a slight race condition from the time the temporary file is created to
109 // the time it is re-created as a directoy.
110 char pathname[MAXPATHLEN];
111 strcpy(pathname, "/tmp/llvm_XXXXXX");
113 if (-1 == (fd = mkstemp(pathname)))
114 ThrowErrno(std::string(pathname) + ": can't create temporary directory");
116 ::unlink(pathname); // start race condition, ignore errors
117 if (-1 == ::mkdir(pathname, S_IRWXU)) // end race condition
118 ThrowErrno(std::string(pathname) + ": can't create temporary directory");
120 result.set(pathname);
121 assert(result.isValid() && "mkstemp didn't create a valid pathname!");
123 #elif defined(HAVE_MKTEMP)
124 // If a system doesn't have mkdtemp(3) or mkstemp(3) but it does have
125 // mktemp(3) then we'll assume that system (e.g. AIX) has a reasonable
126 // implementation of mktemp(3) and doesn't follow BSD 4.3's lead of replacing
127 // the XXXXXX with the pid of the process and a letter. That leads to only
128 // twenty six temporary files that can be generated.
129 char pathname[MAXPATHLEN];
130 strcpy(pathname, "/tmp/llvm_XXXXXX");
131 char *TmpName = ::mktemp(pathname);
133 ThrowErrno(std::string(TmpName) + ": can't create unique directory name");
134 if (-1 == ::mkdir(TmpName, S_IRWXU))
135 ThrowErrno(std::string(TmpName) + ": can't create temporary directory");
138 assert(result.isValid() && "mktemp didn't create a valid pathname!");
141 // This is the worst case implementation. tempnam(3) leaks memory unless its
142 // on an SVID2 (or later) system. On BSD 4.3 it leaks. tmpnam(3) has thread
143 // issues. The mktemp(3) function doesn't have enough variability in the
144 // temporary name generated. So, we provide our own implementation that
145 // increments an integer from a random number seeded by the current time. This
146 // should be sufficiently unique that we don't have many collisions between
147 // processes. Generally LLVM processes don't run very long and don't use very
148 // many temporary files so this shouldn't be a big issue for LLVM.
149 static time_t num = ::time(0);
150 char pathname[MAXPATHLEN];
153 sprintf(pathname, "/tmp/llvm_%010u", unsigned(num));
154 } while ( 0 == access(pathname, F_OK ) );
155 if (-1 == ::mkdir(pathname, S_IRWXU))
156 ThrowErrno(std::string(pathname) + ": can't create temporary directory");
158 result.set(pathname);
159 assert(result.isValid() && "mkstemp didn't create a valid pathname!");
164 static void getPathList(const char*path, std::vector<sys::Path>& Paths) {
165 const char* at = path;
166 const char* delim = strchr(at, ':');
168 while( delim != 0 ) {
169 std::string tmp(at, size_t(delim-at));
170 if (tmpPath.set(tmp))
171 if (tmpPath.canRead())
172 Paths.push_back(tmpPath);
174 delim = strchr(at, ':');
177 if (tmpPath.set(std::string(at)))
178 if (tmpPath.canRead())
179 Paths.push_back(tmpPath);
184 Path::GetSystemLibraryPaths(std::vector<sys::Path>& Paths) {
185 #ifdef LTDL_SHLIBPATH_VAR
186 char* env_var = getenv(LTDL_SHLIBPATH_VAR);
188 getPathList(env_var,Paths);
191 // FIXME: Should this look at LD_LIBRARY_PATH too?
192 Paths.push_back(sys::Path("/usr/local/lib/"));
193 Paths.push_back(sys::Path("/usr/X11R6/lib/"));
194 Paths.push_back(sys::Path("/usr/lib/"));
195 Paths.push_back(sys::Path("/lib/"));
199 Path::GetBytecodeLibraryPaths(std::vector<sys::Path>& Paths) {
200 char * env_var = getenv("LLVM_LIB_SEARCH_PATH");
202 getPathList(env_var,Paths);
207 if (tmpPath.set(LLVM_LIBDIR))
208 if (tmpPath.canRead())
209 Paths.push_back(tmpPath);
212 GetSystemLibraryPaths(Paths);
216 Path::GetLLVMDefaultConfigDir() {
217 return Path("/etc/llvm/");
221 Path::GetUserHomeDirectory() {
222 const char* home = getenv("HOME");
225 if (result.set(home))
228 return GetRootDirectory();
232 Path::isFile() const {
234 if (0 != stat(path.c_str(), &buf)) {
235 ThrowErrno(path + ": can't determine type of path object: ");
237 return S_ISREG(buf.st_mode);
241 Path::isDirectory() const {
243 if (0 != stat(path.c_str(), &buf)) {
244 ThrowErrno(path + ": can't determine type of path object: ");
246 return S_ISDIR(buf.st_mode);
250 Path::getBasename() const {
251 // Find the last slash
252 size_t slash = path.rfind('/');
253 if (slash == std::string::npos)
258 return path.substr(slash, path.rfind('.'));
261 bool Path::hasMagicNumber(const std::string &Magic) const {
262 size_t len = Magic.size();
263 assert(len < 1024 && "Request for magic string too long");
264 char* buf = (char*) alloca(1 + len);
265 int fd = ::open(path.c_str(),O_RDONLY);
268 size_t read_len = ::read(fd, buf, len);
276 bool Path::getMagicNumber(std::string& Magic, unsigned len) const {
279 assert(len < 1024 && "Request for magic string too long");
280 char* buf = (char*) alloca(1 + len);
281 int fd = ::open(path.c_str(),O_RDONLY);
284 ssize_t bytes_read = ::read(fd, buf, len);
286 if (ssize_t(len) != bytes_read) {
290 Magic.assign(buf,len);
295 Path::isBytecodeFile() const {
298 int fd = ::open(path.c_str(),O_RDONLY);
301 ssize_t bytes_read = ::read(fd, buffer, 4);
306 return (buffer[0] == 'l' && buffer[1] == 'l' && buffer[2] == 'v' &&
307 (buffer[3] == 'c' || buffer[3] == 'm'));
311 Path::exists() const {
312 return 0 == access(path.c_str(), F_OK );
316 Path::canRead() const {
317 return 0 == access(path.c_str(), F_OK | R_OK );
321 Path::canWrite() const {
322 return 0 == access(path.c_str(), F_OK | W_OK );
326 Path::canExecute() const {
328 int r = stat(path.c_str(), &st);
329 if (r != 0 || !S_ISREG(st.st_mode))
331 return 0 == access(path.c_str(), R_OK | X_OK );
335 Path::getLast() const {
336 // Find the last slash
337 size_t pos = path.rfind('/');
339 // Handle the corner cases
340 if (pos == std::string::npos)
343 // If the last character is a slash
344 if (pos == path.length()-1) {
345 // Find the second to last slash
346 size_t pos2 = path.rfind('/', pos-1);
347 if (pos2 == std::string::npos)
348 return path.substr(0,pos);
350 return path.substr(pos2+1,pos-pos2-1);
352 // Return everything after the last slash
353 return path.substr(pos+1);
357 Path::getStatusInfo(StatusInfo& info) const {
359 if (0 != stat(path.c_str(), &buf)) {
360 ThrowErrno(path + ": can't determine type of path object: ");
362 info.fileSize = buf.st_size;
363 info.modTime.fromEpochTime(buf.st_mtime);
364 info.mode = buf.st_mode;
365 info.user = buf.st_uid;
366 info.group = buf.st_gid;
367 info.isDir = S_ISDIR(buf.st_mode);
370 static bool AddPermissionBits(const std::string& Filename, int bits) {
371 // Get the umask value from the operating system. We want to use it
372 // when changing the file's permissions. Since calling umask() sets
373 // the umask and returns its old value, we must call it a second
374 // time to reset it to the user's preference.
375 int mask = umask(0777); // The arg. to umask is arbitrary.
376 umask(mask); // Restore the umask.
378 // Get the file's current mode.
380 if ((stat(Filename.c_str(), &st)) == -1)
383 // Change the file to have whichever permissions bits from 'bits'
384 // that the umask would not disable.
385 if ((chmod(Filename.c_str(), (st.st_mode | (bits & ~mask)))) == -1)
391 void Path::makeReadable() {
392 if (!AddPermissionBits(path,0444))
393 ThrowErrno(path + ": can't make file readable");
396 void Path::makeWriteable() {
397 if (!AddPermissionBits(path,0222))
398 ThrowErrno(path + ": can't make file writable");
401 void Path::makeExecutable() {
402 if (!AddPermissionBits(path,0111))
403 ThrowErrno(path + ": can't make file executable");
407 Path::getDirectoryContents(std::set<Path>& result) const {
410 DIR* direntries = ::opendir(path.c_str());
412 ThrowErrno(path + ": can't open directory");
415 struct dirent* de = ::readdir(direntries);
416 for ( ; de != 0; de = ::readdir(direntries)) {
417 if (de->d_name[0] != '.') {
418 Path aPath(path + (const char*)de->d_name);
420 if (0 != stat(aPath.path.c_str(), &buf)) {
421 int stat_errno = errno;
423 if (0 == lstat(aPath.path.c_str(), &st) && S_ISLNK(st.st_mode))
424 continue; // dangling symlink -- ignore
425 ThrowErrno(aPath.path +
426 ": can't determine file object type", stat_errno);
428 result.insert(aPath);
432 closedir(direntries);
437 Path::set(const std::string& a_path) {
440 std::string save(path);
450 Path::appendComponent(const std::string& name) {
453 std::string save(path);
455 size_t last = path.size() - 1;
456 if (path[last] != '/')
468 Path::eraseComponent() {
469 size_t slashpos = path.rfind('/',path.size());
470 if (slashpos == 0 || slashpos == std::string::npos) {
474 if (slashpos == path.size() - 1)
475 slashpos = path.rfind('/',slashpos-1);
476 if (slashpos == std::string::npos) {
480 path.erase(slashpos);
485 Path::appendSuffix(const std::string& suffix) {
486 std::string save(path);
497 Path::eraseSuffix() {
498 std::string save(path);
499 size_t dotpos = path.rfind('.',path.size());
500 size_t slashpos = path.rfind('/',path.size());
501 if (slashpos != std::string::npos &&
502 dotpos != std::string::npos &&
504 path.erase(dotpos, path.size()-dotpos);
514 Path::createDirectory( bool create_parents) {
515 // Get a writeable copy of the path name
516 char pathname[MAXPATHLEN];
517 path.copy(pathname,MAXPATHLEN);
519 // Null-terminate the last component
520 int lastchar = path.length() - 1 ;
521 if (pathname[lastchar] == '/')
522 pathname[lastchar] = 0;
524 pathname[lastchar+1] = 0;
526 // If we're supposed to create intermediate directories
527 if ( create_parents ) {
528 // Find the end of the initial name component
529 char * next = strchr(pathname,'/');
530 if ( pathname[0] == '/')
531 next = strchr(&pathname[1],'/');
533 // Loop through the directory components until we're done
534 while ( next != 0 ) {
536 if (0 != access(pathname, F_OK | R_OK | W_OK))
537 if (0 != mkdir(pathname, S_IRWXU | S_IRWXG))
538 ThrowErrno(std::string(pathname) + ": can't create directory");
540 next = strchr(next+1,'/');
545 if (0 != access(pathname, F_OK | R_OK))
546 if (0 != mkdir(pathname, S_IRWXU | S_IRWXG))
547 ThrowErrno(std::string(pathname) + ": can't create directory");
554 int fd = ::creat(path.c_str(), S_IRUSR | S_IWUSR);
556 ThrowErrno(path + ": can't create file");
563 Path::createTemporaryFile(bool reuse_current) {
564 // Make this into a unique file name
565 makeUnique( reuse_current );
568 int outFile = ::open(path.c_str(), O_WRONLY|O_CREAT|O_TRUNC, 0666);
577 Path::destroy(bool remove_contents) const {
578 // Make sure we're dealing with a directory
580 if (0 != unlink(path.c_str()))
581 ThrowErrno(path + ": can't destroy file");
582 } else if (isDirectory()) {
583 if (remove_contents) {
584 // Recursively descend the directory to remove its content
585 std::string cmd("/bin/rm -rf ");
589 // Otherwise, try to just remove the one directory
590 char pathname[MAXPATHLEN];
591 path.copy(pathname,MAXPATHLEN);
592 int lastchar = path.length() - 1 ;
593 if (pathname[lastchar] == '/')
594 pathname[lastchar] = 0;
596 pathname[lastchar+1] = 0;
597 if ( 0 != rmdir(pathname))
598 ThrowErrno(std::string(pathname) + ": can't destroy directory");
607 Path::rename(const Path& newName) {
608 if (0 != ::rename(path.c_str(), newName.c_str()))
609 ThrowErrno(std::string("can't rename '") + path + "' as '" +
610 newName.toString() + "' ");
615 Path::setStatusInfo(const StatusInfo& si) const {
617 utb.actime = si.modTime.toPosixTime();
618 utb.modtime = utb.actime;
619 if (0 != ::utime(path.c_str(),&utb))
620 ThrowErrno(path + ": can't set file modification time");
621 if (0 != ::chmod(path.c_str(),si.mode))
622 ThrowErrno(path + ": can't set mode");
627 sys::CopyFile(const sys::Path &Dest, const sys::Path &Src) {
631 inFile = ::open(Src.c_str(), O_RDONLY);
633 ThrowErrno(Src.toString() + ": can't open source file to copy: ");
635 outFile = ::open(Dest.c_str(), O_WRONLY|O_CREAT, 0666);
637 ThrowErrno(Dest.toString() +": can't create destination file for copy: ");
639 char Buffer[16*1024];
640 while (ssize_t Amt = ::read(inFile, Buffer, 16*1024)) {
642 if (errno != EINTR && errno != EAGAIN)
643 ThrowErrno(Src.toString()+": can't read source file: ");
645 char *BufPtr = Buffer;
647 ssize_t AmtWritten = ::write(outFile, BufPtr, Amt);
648 if (AmtWritten == -1) {
649 if (errno != EINTR && errno != EAGAIN)
650 ThrowErrno(Dest.toString() + ": can't write destination file: ");
653 BufPtr += AmtWritten;
670 Path::makeUnique(bool reuse_current) {
671 if (reuse_current && !exists())
672 return; // File doesn't exist already, just use it!
674 // Append an XXXXXX pattern to the end of the file for use with mkstemp,
675 // mktemp or our own implementation.
676 char *FNBuffer = (char*) alloca(path.size()+8);
677 path.copy(FNBuffer,path.size());
678 strcpy(FNBuffer+path.size(), "-XXXXXX");
680 #if defined(HAVE_MKSTEMP)
682 if ((TempFD = mkstemp(FNBuffer)) == -1) {
683 ThrowErrno(path + ": can't make unique filename");
686 // We don't need to hold the temp file descriptor... we will trust that no one
687 // will overwrite/delete the file before we can open it again.
692 #elif defined(HAVE_MKTEMP)
693 // If we don't have mkstemp, use the old and obsolete mktemp function.
694 if (mktemp(FNBuffer) == 0) {
695 ThrowErrno(path + ": can't make unique filename");
701 // Okay, looks like we have to do it all by our lonesome.
702 static unsigned FCounter = 0;
703 unsigned offset = path.size() + 1;
704 while ( FCounter < 999999 && exists()) {
705 sprintf(FNBuffer+offset,"%06u",++FCounter);
708 if (FCounter > 999999)
709 throw std::string(path + ": can't make unique filename: too many files");