Final Changes For PR495:
[oota-llvm.git] / lib / System / Unix / Path.inc
1 //===- llvm/System/Unix/Path.cpp - Unix Path Implementation -----*- C++ -*-===//
2 // 
3 //                     The LLVM Compiler Infrastructure
4 //
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.
7 // 
8 //===----------------------------------------------------------------------===//
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
19 #include "llvm/Config/alloca.h"
20 #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
27 #if HAVE_UTIME_H
28 #include <utime.h>
29 #endif
30 #if HAVE_TIME_H
31 #include <time.h>
32 #endif
33 #if HAVE_DIRENT_H
34 # include <dirent.h>
35 # define NAMLEN(dirent) strlen((dirent)->d_name)
36 #else
37 # define dirent direct
38 # define NAMLEN(dirent) (dirent)->d_namlen
39 # if HAVE_SYS_NDIR_H
40 #  include <sys/ndir.h>
41 # endif
42 # if HAVE_SYS_DIR_H
43 #  include <sys/dir.h>
44 # endif
45 # if HAVE_NDIR_H
46 #  include <ndir.h>
47 # endif
48 #endif
49
50 // Put in a hack for Cygwin which falsely reports that the mkdtemp function
51 // is available when it is not.
52 #ifdef __CYGWIN__
53 # undef HAVE_MKDTEMP
54 #endif
55
56 namespace llvm {
57 using namespace sys;
58
59 Path::Path(const std::string& unverified_path) : path(unverified_path) {
60   if (unverified_path.empty())
61     return;
62   if (this->isValid()) 
63     return;
64   // oops, not valid.
65   path.clear();
66   ThrowErrno(unverified_path + ": path is not valid");
67 }
68
69 bool 
70 Path::isValid() const {
71   if (path.empty()) 
72     return false;
73   else if (path.length() >= MAXPATHLEN)
74     return false;
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)
79       return false;
80 #endif
81   return true;
82 }
83
84 Path
85 Path::GetRootDirectory() {
86   Path result;
87   result.set("/");
88   return result;
89 }
90
91 Path
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");
100   Path result;
101   result.set(pathname);
102   assert(result.isValid() && "mkdtemp didn't create a valid pathname!");
103   return result;
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");
112   int fd = 0;
113   if (-1 == (fd = mkstemp(pathname)))
114     ThrowErrno(std::string(pathname) + ": can't create temporary directory");
115   ::close(fd);
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");
119   Path result;
120   result.set(pathname);
121   assert(result.isValid() && "mkstemp didn't create a valid pathname!");
122   return result;
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);
132   if (TmpName == 0)
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");
136   Path result;
137   result.set(TmpName);
138   assert(result.isValid() && "mktemp didn't create a valid pathname!");
139   return result;
140 #else
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];
151   do {
152     num++;
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");
157   Path result;
158   result.set(pathname);
159   assert(result.isValid() && "mkstemp didn't create a valid pathname!");
160   return result;
161 #endif
162 }
163
164 static void getPathList(const char*path, std::vector<sys::Path>& Paths) {
165   const char* at = path;
166   const char* delim = strchr(at, ':');
167   Path tmpPath;
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);
173     at = delim + 1;
174     delim = strchr(at, ':');
175   }
176   if (*at != 0)
177     if (tmpPath.set(std::string(at)))
178       if (tmpPath.canRead())
179         Paths.push_back(tmpPath);
180
181 }
182
183 void 
184 Path::GetSystemLibraryPaths(std::vector<sys::Path>& Paths) {
185 #ifdef LTDL_SHLIBPATH_VAR
186   char* env_var = getenv(LTDL_SHLIBPATH_VAR);
187   if (env_var != 0) {
188     getPathList(env_var,Paths);
189   }
190 #endif
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/"));
196 }
197
198 void
199 Path::GetBytecodeLibraryPaths(std::vector<sys::Path>& Paths) {
200   char * env_var = getenv("LLVM_LIB_SEARCH_PATH");
201   if (env_var != 0) {
202     getPathList(env_var,Paths);
203   }
204 #ifdef LLVM_LIBDIR
205   {
206     Path tmpPath;
207     if (tmpPath.set(LLVM_LIBDIR))
208       if (tmpPath.canRead())
209         Paths.push_back(tmpPath);
210   }
211 #endif
212   GetSystemLibraryPaths(Paths);
213 }
214
215 Path 
216 Path::GetLLVMDefaultConfigDir() {
217   return Path("/etc/llvm/");
218 }
219
220 Path
221 Path::GetUserHomeDirectory() {
222   const char* home = getenv("HOME");
223   if (home) {
224     Path result;
225     if (result.set(home))
226       return result;
227   }
228   return GetRootDirectory();
229 }
230
231 bool
232 Path::isFile() const {
233   struct stat buf;
234   if (0 != stat(path.c_str(), &buf)) {
235     ThrowErrno(path + ": can't determine type of path object: ");
236   }
237   return S_ISREG(buf.st_mode);
238 }
239
240 bool
241 Path::isDirectory() const {
242   struct stat buf;
243   if (0 != stat(path.c_str(), &buf)) {
244     ThrowErrno(path + ": can't determine type of path object: ");
245   }
246   return S_ISDIR(buf.st_mode);
247 }
248
249 bool
250 Path::isHidden() const {
251   size_t slash = path.rfind('/');
252   return (slash != std::string::npos && 
253           slash < path.length()-1 && 
254           path[slash+1] == '.') || 
255          (!path.empty() && slash == std::string::npos && path[0] == '.');
256 }
257
258 std::string
259 Path::getBasename() const {
260   // Find the last slash
261   size_t slash = path.rfind('/');
262   if (slash == std::string::npos)
263     slash = 0;
264   else
265     slash++;
266
267   return path.substr(slash, path.rfind('.'));
268 }
269
270 bool Path::hasMagicNumber(const std::string &Magic) const {
271   size_t len = Magic.size();
272   assert(len < 1024 && "Request for magic string too long");
273   char* buf = (char*) alloca(1 + len);
274   int fd = ::open(path.c_str(),O_RDONLY);
275   if (fd < 0)
276     return false;
277   size_t read_len = ::read(fd, buf, len);
278   close(fd);
279   if (len != read_len)
280     return false;
281   buf[len] = '\0';
282   return Magic == buf;
283 }
284
285 bool Path::getMagicNumber(std::string& Magic, unsigned len) const {
286   if (!isFile())
287     return false;
288   assert(len < 1024 && "Request for magic string too long");
289   char* buf = (char*) alloca(1 + len);
290   int fd = ::open(path.c_str(),O_RDONLY);
291   if (fd < 0)
292     return false;
293   ssize_t bytes_read = ::read(fd, buf, len);
294   ::close(fd);
295   if (ssize_t(len) != bytes_read) {
296     Magic.clear();
297     return false;
298   }
299   Magic.assign(buf,len);
300   return true;
301 }
302
303 bool 
304 Path::isBytecodeFile() const {
305   char buffer[ 4];
306   buffer[0] = 0;
307   int fd = ::open(path.c_str(),O_RDONLY);
308   if (fd < 0)
309     return false;
310   ssize_t bytes_read = ::read(fd, buffer, 4);
311   ::close(fd);
312   if (4 != bytes_read) 
313     return false;
314
315   return (buffer[0] == 'l' && buffer[1] == 'l' && buffer[2] == 'v' &&
316       (buffer[3] == 'c' || buffer[3] == 'm'));
317 }
318
319 bool
320 Path::exists() const {
321   return 0 == access(path.c_str(), F_OK );
322 }
323
324 bool
325 Path::canRead() const {
326   return 0 == access(path.c_str(), F_OK | R_OK );
327 }
328
329 bool
330 Path::canWrite() const {
331   return 0 == access(path.c_str(), F_OK | W_OK );
332 }
333
334 bool
335 Path::canExecute() const {
336   struct stat st;
337   int r = stat(path.c_str(), &st);
338   if (r != 0 || !S_ISREG(st.st_mode))
339     return false;
340   return 0 == access(path.c_str(), R_OK | X_OK );
341 }
342
343 std::string 
344 Path::getLast() const {
345   // Find the last slash
346   size_t pos = path.rfind('/');
347
348   // Handle the corner cases
349   if (pos == std::string::npos)
350     return path;
351
352   // If the last character is a slash
353   if (pos == path.length()-1) {
354     // Find the second to last slash
355     size_t pos2 = path.rfind('/', pos-1);
356     if (pos2 == std::string::npos)
357       return path.substr(0,pos);
358     else
359       return path.substr(pos2+1,pos-pos2-1);
360   }
361   // Return everything after the last slash
362   return path.substr(pos+1);
363 }
364
365 void
366 Path::getStatusInfo(StatusInfo& info) const {
367   struct stat buf;
368   if (0 != stat(path.c_str(), &buf)) {
369     ThrowErrno(path + ": can't determine type of path object: ");
370   }
371   info.fileSize = buf.st_size;
372   info.modTime.fromEpochTime(buf.st_mtime);
373   info.mode = buf.st_mode;
374   info.user = buf.st_uid;
375   info.group = buf.st_gid;
376   info.isDir = S_ISDIR(buf.st_mode);
377 }
378
379 static bool AddPermissionBits(const std::string& Filename, int bits) {
380   // Get the umask value from the operating system.  We want to use it
381   // when changing the file's permissions. Since calling umask() sets
382   // the umask and returns its old value, we must call it a second
383   // time to reset it to the user's preference.
384   int mask = umask(0777); // The arg. to umask is arbitrary.
385   umask(mask);            // Restore the umask.
386
387   // Get the file's current mode.
388   struct stat st;
389   if ((stat(Filename.c_str(), &st)) == -1)
390     return false;
391
392   // Change the file to have whichever permissions bits from 'bits'
393   // that the umask would not disable.
394   if ((chmod(Filename.c_str(), (st.st_mode | (bits & ~mask)))) == -1)
395     return false;
396
397   return true;
398 }
399
400 void Path::makeReadableOnDisk() {
401   if (!AddPermissionBits(path,0444))
402     ThrowErrno(path + ": can't make file readable");
403 }
404
405 void Path::makeWriteableOnDisk() {
406   if (!AddPermissionBits(path,0222))
407     ThrowErrno(path + ": can't make file writable");
408 }
409
410 void Path::makeExecutableOnDisk() {
411   if (!AddPermissionBits(path,0111))
412     ThrowErrno(path + ": can't make file executable");
413 }
414
415 bool
416 Path::getDirectoryContents(std::set<Path>& result) const {
417   if (!isDirectory())
418     return false;
419   DIR* direntries = ::opendir(path.c_str());
420   if (direntries == 0)
421     ThrowErrno(path + ": can't open directory");
422
423   result.clear();
424   struct dirent* de = ::readdir(direntries);
425   for ( ; de != 0; de = ::readdir(direntries)) {
426     if (de->d_name[0] != '.') {
427       Path aPath(path + (const char*)de->d_name);
428       struct stat buf;
429       if (0 != stat(aPath.path.c_str(), &buf)) {
430         int stat_errno = errno;
431         struct stat st;
432         if (0 == lstat(aPath.path.c_str(), &st) && S_ISLNK(st.st_mode))
433           continue; // dangling symlink -- ignore
434         ThrowErrno(aPath.path + 
435           ": can't determine file object type", stat_errno);
436       }
437       result.insert(aPath);
438     }
439   }
440   
441   closedir(direntries);
442   return true;
443 }
444
445 bool
446 Path::set(const std::string& a_path) {
447   if (a_path.empty())
448     return false;
449   std::string save(path);
450   path = a_path;
451   if (!isValid()) {
452     path = save;
453     return false;
454   }
455   return true;
456 }
457
458 bool
459 Path::appendComponent(const std::string& name) {
460   if (name.empty())
461     return false;
462   std::string save(path);
463   if (!path.empty()) {
464     size_t last = path.size() - 1;
465     if (path[last] != '/') 
466       path += '/';
467   }
468   path += name;
469   if (!isValid()) {
470     path = save;
471     return false;
472   }
473   return true;
474 }
475
476 bool
477 Path::eraseComponent() {
478   size_t slashpos = path.rfind('/',path.size());
479   if (slashpos == 0 || slashpos == std::string::npos) {
480     path.erase();
481     return true;
482   }
483   if (slashpos == path.size() - 1)
484     slashpos = path.rfind('/',slashpos-1);
485   if (slashpos == std::string::npos) {
486     path.erase();
487     return true;
488   }
489   path.erase(slashpos);
490   return true;
491 }
492
493 bool
494 Path::appendSuffix(const std::string& suffix) {
495   std::string save(path);
496   path.append(".");
497   path.append(suffix);
498   if (!isValid()) {
499     path = save;
500     return false;
501   }
502   return true;
503 }
504
505 bool
506 Path::eraseSuffix() {
507   std::string save(path);
508   size_t dotpos = path.rfind('.',path.size());
509   size_t slashpos = path.rfind('/',path.size());
510   if (slashpos != std::string::npos && 
511       dotpos != std::string::npos &&
512       dotpos > slashpos) {
513     path.erase(dotpos, path.size()-dotpos);
514   }
515   if (!isValid()) {
516     path = save;
517     return false;
518   }
519   return true;
520 }
521
522 bool
523 Path::createDirectoryOnDisk( bool create_parents) {
524   // Get a writeable copy of the path name
525   char pathname[MAXPATHLEN];
526   path.copy(pathname,MAXPATHLEN);
527
528   // Null-terminate the last component
529   int lastchar = path.length() - 1 ; 
530   if (pathname[lastchar] == '/') 
531     pathname[lastchar] = 0;
532   else 
533     pathname[lastchar+1] = 0;
534
535   // If we're supposed to create intermediate directories
536   if ( create_parents ) {
537     // Find the end of the initial name component
538     char * next = strchr(pathname,'/');
539     if ( pathname[0] == '/') 
540       next = strchr(&pathname[1],'/');
541
542     // Loop through the directory components until we're done 
543     while ( next != 0 ) {
544       *next = 0;
545       if (0 != access(pathname, F_OK | R_OK | W_OK))
546         if (0 != mkdir(pathname, S_IRWXU | S_IRWXG))
547           ThrowErrno(std::string(pathname) + ": can't create directory");
548       char* save = next;
549       next = strchr(next+1,'/');
550       *save = '/';
551     }
552   } 
553
554   if (0 != access(pathname, F_OK | R_OK))
555     if (0 != mkdir(pathname, S_IRWXU | S_IRWXG))
556       ThrowErrno(std::string(pathname) + ": can't create directory");
557   return true;
558 }
559
560 bool
561 Path::createFileOnDisk() {
562   // Create the file
563   int fd = ::creat(path.c_str(), S_IRUSR | S_IWUSR);
564   if (fd < 0)
565     ThrowErrno(path + ": can't create file");
566   ::close(fd);
567
568   return true;
569 }
570
571 bool
572 Path::createTemporaryFileOnDisk(bool reuse_current) {
573   // Make this into a unique file name
574   makeUnique( reuse_current );
575
576   // create the file
577   int outFile = ::open(path.c_str(), O_WRONLY|O_CREAT|O_TRUNC, 0666);
578   if (outFile != -1) {
579     ::close(outFile);
580     return true;
581   }
582   return false;
583 }
584
585 bool
586 Path::eraseFromDisk(bool remove_contents) const {
587   // Make sure we're dealing with a directory
588   if (isFile()) {
589     if (0 != unlink(path.c_str()))
590       ThrowErrno(path + ": can't destroy file");
591   } else if (isDirectory()) {
592     if (remove_contents) {
593       // Recursively descend the directory to remove its content
594       std::string cmd("/bin/rm -rf ");
595       cmd += path;
596       system(cmd.c_str());
597     } else {
598       // Otherwise, try to just remove the one directory
599       char pathname[MAXPATHLEN];
600       path.copy(pathname,MAXPATHLEN);
601       int lastchar = path.length() - 1 ; 
602       if (pathname[lastchar] == '/') 
603         pathname[lastchar] = 0;
604       else
605         pathname[lastchar+1] = 0;
606       if ( 0 != rmdir(pathname))
607         ThrowErrno(std::string(pathname) + ": can't destroy directory");
608     }
609   }
610   else
611     return false;
612   return true;
613 }
614
615 bool
616 Path::renamePathOnDisk(const Path& newName) {
617   if (0 != ::rename(path.c_str(), newName.c_str()))
618     ThrowErrno(std::string("can't rename '") + path + "' as '" + 
619                newName.toString() + "' ");
620   return true;
621 }
622
623 bool
624 Path::setStatusInfoOnDisk(const StatusInfo& si) const {
625   struct utimbuf utb;
626   utb.actime = si.modTime.toPosixTime();
627   utb.modtime = utb.actime;
628   if (0 != ::utime(path.c_str(),&utb))
629     ThrowErrno(path + ": can't set file modification time");
630   if (0 != ::chmod(path.c_str(),si.mode))
631     ThrowErrno(path + ": can't set mode");
632   return true;
633 }
634
635 void 
636 sys::CopyFile(const sys::Path &Dest, const sys::Path &Src) {
637   int inFile = -1;
638   int outFile = -1;
639   try {
640     inFile = ::open(Src.c_str(), O_RDONLY);
641     if (inFile == -1)
642       ThrowErrno(Src.toString() + ": can't open source file to copy: ");
643
644     outFile = ::open(Dest.c_str(), O_WRONLY|O_CREAT, 0666);
645     if (outFile == -1)
646       ThrowErrno(Dest.toString() +": can't create destination file for copy: ");
647
648     char Buffer[16*1024];
649     while (ssize_t Amt = ::read(inFile, Buffer, 16*1024)) {
650       if (Amt == -1) {
651         if (errno != EINTR && errno != EAGAIN) 
652           ThrowErrno(Src.toString()+": can't read source file: ");
653       } else {
654         char *BufPtr = Buffer;
655         while (Amt) {
656           ssize_t AmtWritten = ::write(outFile, BufPtr, Amt);
657           if (AmtWritten == -1) {
658             if (errno != EINTR && errno != EAGAIN) 
659               ThrowErrno(Dest.toString() + ": can't write destination file: ");
660           } else {
661             Amt -= AmtWritten;
662             BufPtr += AmtWritten;
663           }
664         }
665       }
666     }
667     ::close(inFile);
668     ::close(outFile);
669   } catch (...) {
670     if (inFile != -1)
671       ::close(inFile);
672     if (outFile != -1)
673       ::close(outFile);
674     throw;
675   }
676 }
677
678 void 
679 Path::makeUnique(bool reuse_current) {
680   if (reuse_current && !exists())
681     return; // File doesn't exist already, just use it!
682
683   // Append an XXXXXX pattern to the end of the file for use with mkstemp, 
684   // mktemp or our own implementation.
685   char *FNBuffer = (char*) alloca(path.size()+8);
686   path.copy(FNBuffer,path.size());
687   strcpy(FNBuffer+path.size(), "-XXXXXX");
688
689 #if defined(HAVE_MKSTEMP)
690   int TempFD;
691   if ((TempFD = mkstemp(FNBuffer)) == -1) {
692     ThrowErrno(path + ": can't make unique filename");
693   }
694
695   // We don't need to hold the temp file descriptor... we will trust that no one
696   // will overwrite/delete the file before we can open it again.
697   close(TempFD);
698
699   // Save the name
700   path = FNBuffer;
701 #elif defined(HAVE_MKTEMP)
702   // If we don't have mkstemp, use the old and obsolete mktemp function.
703   if (mktemp(FNBuffer) == 0) {
704     ThrowErrno(path + ": can't make unique filename");
705   }
706
707   // Save the name
708   path = FNBuffer;
709 #else
710   // Okay, looks like we have to do it all by our lonesome.
711   static unsigned FCounter = 0;
712   unsigned offset = path.size() + 1;
713   while ( FCounter < 999999 && exists()) {
714     sprintf(FNBuffer+offset,"%06u",++FCounter);
715     path = FNBuffer;
716   }
717   if (FCounter > 999999)
718     throw std::string(path + ": can't make unique filename: too many files");
719 #endif
720
721 }
722 }
723