Remove dead code. NFC.
[oota-llvm.git] / lib / Support / Unix / Path.inc
1 //===- llvm/Support/Unix/Path.inc - Unix Path Implementation ----*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements the Unix specific implementation of the Path API.
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 "Unix.h"
20 #include <limits.h>
21 #include <stdio.h>
22 #if HAVE_SYS_STAT_H
23 #include <sys/stat.h>
24 #endif
25 #if HAVE_FCNTL_H
26 #include <fcntl.h>
27 #endif
28 #ifdef HAVE_SYS_MMAN_H
29 #include <sys/mman.h>
30 #endif
31 #if HAVE_DIRENT_H
32 # include <dirent.h>
33 # define NAMLEN(dirent) strlen((dirent)->d_name)
34 #else
35 # define dirent direct
36 # define NAMLEN(dirent) (dirent)->d_namlen
37 # if HAVE_SYS_NDIR_H
38 #  include <sys/ndir.h>
39 # endif
40 # if HAVE_SYS_DIR_H
41 #  include <sys/dir.h>
42 # endif
43 # if HAVE_NDIR_H
44 #  include <ndir.h>
45 # endif
46 #endif
47
48 #ifdef __APPLE__
49 #include <mach-o/dyld.h>
50 #endif
51
52 // Both stdio.h and cstdio are included via different pathes and
53 // stdcxx's cstdio doesn't include stdio.h, so it doesn't #undef the macros
54 // either.
55 #undef ferror
56 #undef feof
57
58 // For GNU Hurd
59 #if defined(__GNU__) && !defined(PATH_MAX)
60 # define PATH_MAX 4096
61 #endif
62
63 using namespace llvm;
64
65 namespace {
66   /// This class automatically closes the given file descriptor when it goes out
67   /// of scope. You can take back explicit ownership of the file descriptor by
68   /// calling take(). The destructor does not verify that close was successful.
69   /// Therefore, never allow this class to call close on a file descriptor that
70   /// has been read from or written to.
71   struct AutoFD {
72     int FileDescriptor;
73
74     AutoFD(int fd) : FileDescriptor(fd) {}
75     ~AutoFD() {
76       if (FileDescriptor >= 0)
77         ::close(FileDescriptor);
78     }
79
80     int take() {
81       int ret = FileDescriptor;
82       FileDescriptor = -1;
83       return ret;
84     }
85
86     operator int() const {return FileDescriptor;}
87   };
88 }
89
90 namespace llvm {
91 namespace sys  {
92 namespace fs {
93 #if defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
94     defined(__OpenBSD__) || defined(__minix) || defined(__FreeBSD_kernel__) || \
95     defined(__linux__) || defined(__CYGWIN__) || defined(__DragonFly__)
96 static int
97 test_dir(char ret[PATH_MAX], const char *dir, const char *bin)
98 {  
99   struct stat sb;
100   char fullpath[PATH_MAX];
101
102   snprintf(fullpath, PATH_MAX, "%s/%s", dir, bin);
103   if (realpath(fullpath, ret) == NULL)
104     return (1);
105   if (stat(fullpath, &sb) != 0)
106     return (1);
107
108   return (0);
109 }
110
111 static char *
112 getprogpath(char ret[PATH_MAX], const char *bin)
113 {
114   char *pv, *s, *t;
115
116   /* First approach: absolute path. */
117   if (bin[0] == '/') {
118     if (test_dir(ret, "/", bin) == 0)
119       return (ret);
120     return (NULL);
121   }
122
123   /* Second approach: relative path. */
124   if (strchr(bin, '/') != NULL) {
125     char cwd[PATH_MAX];
126     if (getcwd(cwd, PATH_MAX) == NULL)
127       return (NULL);
128     if (test_dir(ret, cwd, bin) == 0)
129       return (ret);
130     return (NULL);
131   }
132
133   /* Third approach: $PATH */
134   if ((pv = getenv("PATH")) == NULL)
135     return (NULL);
136   s = pv = strdup(pv);
137   if (pv == NULL)
138     return (NULL);
139   while ((t = strsep(&s, ":")) != NULL) {
140     if (test_dir(ret, t, bin) == 0) {
141       free(pv);
142       return (ret);
143     }
144   }
145   free(pv);
146   return (NULL);
147 }
148 #endif // __FreeBSD__ || __NetBSD__ || __FreeBSD_kernel__
149
150 /// GetMainExecutable - Return the path to the main executable, given the
151 /// value of argv[0] from program startup.
152 std::string getMainExecutable(const char *argv0, void *MainAddr) {
153 #if defined(__APPLE__)
154   // On OS X the executable path is saved to the stack by dyld. Reading it
155   // from there is much faster than calling dladdr, especially for large
156   // binaries with symbols.
157   char exe_path[MAXPATHLEN];
158   uint32_t size = sizeof(exe_path);
159   if (_NSGetExecutablePath(exe_path, &size) == 0) {
160     char link_path[MAXPATHLEN];
161     if (realpath(exe_path, link_path))
162       return link_path;
163   }
164 #elif defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
165       defined(__OpenBSD__) || defined(__minix) || defined(__DragonFly__) || \
166       defined(__FreeBSD_kernel__)
167   char exe_path[PATH_MAX];
168
169   if (getprogpath(exe_path, argv0) != NULL)
170     return exe_path;
171 #elif defined(__linux__) || defined(__CYGWIN__)
172   char exe_path[MAXPATHLEN];
173   StringRef aPath("/proc/self/exe");
174   if (sys::fs::exists(aPath)) {
175       // /proc is not always mounted under Linux (chroot for example).
176       ssize_t len = readlink(aPath.str().c_str(), exe_path, sizeof(exe_path));
177       if (len >= 0)
178           return StringRef(exe_path, len);
179   } else {
180       // Fall back to the classical detection.
181       if (getprogpath(exe_path, argv0) != NULL)
182           return exe_path;
183   }
184 #elif defined(HAVE_DLFCN_H)
185   // Use dladdr to get executable path if available.
186   Dl_info DLInfo;
187   int err = dladdr(MainAddr, &DLInfo);
188   if (err == 0)
189     return "";
190
191   // If the filename is a symlink, we need to resolve and return the location of
192   // the actual executable.
193   char link_path[MAXPATHLEN];
194   if (realpath(DLInfo.dli_fname, link_path))
195     return link_path;
196 #else
197 #error GetMainExecutable is not implemented on this host yet.
198 #endif
199   return "";
200 }
201
202 TimeValue file_status::getLastModificationTime() const {
203   TimeValue Ret;
204   Ret.fromEpochTime(fs_st_mtime);
205   return Ret;
206 }
207
208 UniqueID file_status::getUniqueID() const {
209   return UniqueID(fs_st_dev, fs_st_ino);
210 }
211
212 std::error_code current_path(SmallVectorImpl<char> &result) {
213   result.clear();
214
215   const char *pwd = ::getenv("PWD");
216   llvm::sys::fs::file_status PWDStatus, DotStatus;
217   if (pwd && llvm::sys::path::is_absolute(pwd) &&
218       !llvm::sys::fs::status(pwd, PWDStatus) &&
219       !llvm::sys::fs::status(".", DotStatus) &&
220       PWDStatus.getUniqueID() == DotStatus.getUniqueID()) {
221     result.append(pwd, pwd + strlen(pwd));
222     return std::error_code();
223   }
224
225 #ifdef MAXPATHLEN
226   result.reserve(MAXPATHLEN);
227 #else
228 // For GNU Hurd
229   result.reserve(1024);
230 #endif
231
232   while (true) {
233     if (::getcwd(result.data(), result.capacity()) == nullptr) {
234       // See if there was a real error.
235       if (errno != ENOMEM)
236         return std::error_code(errno, std::generic_category());
237       // Otherwise there just wasn't enough space.
238       result.reserve(result.capacity() * 2);
239     } else
240       break;
241   }
242
243   result.set_size(strlen(result.data()));
244   return std::error_code();
245 }
246
247 std::error_code create_directory(const Twine &path, bool IgnoreExisting) {
248   SmallString<128> path_storage;
249   StringRef p = path.toNullTerminatedStringRef(path_storage);
250
251   if (::mkdir(p.begin(), S_IRWXU | S_IRWXG) == -1) {
252     if (errno != EEXIST || !IgnoreExisting)
253       return std::error_code(errno, std::generic_category());
254   }
255
256   return std::error_code();
257 }
258
259 // Note that we are using symbolic link because hard links are not supported by
260 // all filesystems (SMB doesn't).
261 std::error_code create_link(const Twine &to, const Twine &from) {
262   // Get arguments.
263   SmallString<128> from_storage;
264   SmallString<128> to_storage;
265   StringRef f = from.toNullTerminatedStringRef(from_storage);
266   StringRef t = to.toNullTerminatedStringRef(to_storage);
267
268   if (::symlink(t.begin(), f.begin()) == -1)
269     return std::error_code(errno, std::generic_category());
270
271   return std::error_code();
272 }
273
274 std::error_code remove(const Twine &path, bool IgnoreNonExisting) {
275   SmallString<128> path_storage;
276   StringRef p = path.toNullTerminatedStringRef(path_storage);
277
278   struct stat buf;
279   if (lstat(p.begin(), &buf) != 0) {
280     if (errno != ENOENT || !IgnoreNonExisting)
281       return std::error_code(errno, std::generic_category());
282     return std::error_code();
283   }
284
285   // Note: this check catches strange situations. In all cases, LLVM should
286   // only be involved in the creation and deletion of regular files.  This
287   // check ensures that what we're trying to erase is a regular file. It
288   // effectively prevents LLVM from erasing things like /dev/null, any block
289   // special file, or other things that aren't "regular" files.
290   if (!S_ISREG(buf.st_mode) && !S_ISDIR(buf.st_mode) && !S_ISLNK(buf.st_mode))
291     return make_error_code(errc::operation_not_permitted);
292
293   if (::remove(p.begin()) == -1) {
294     if (errno != ENOENT || !IgnoreNonExisting)
295       return std::error_code(errno, std::generic_category());
296   }
297
298   return std::error_code();
299 }
300
301 std::error_code rename(const Twine &from, const Twine &to) {
302   // Get arguments.
303   SmallString<128> from_storage;
304   SmallString<128> to_storage;
305   StringRef f = from.toNullTerminatedStringRef(from_storage);
306   StringRef t = to.toNullTerminatedStringRef(to_storage);
307
308   if (::rename(f.begin(), t.begin()) == -1)
309     return std::error_code(errno, std::generic_category());
310
311   return std::error_code();
312 }
313
314 std::error_code resize_file(const Twine &path, uint64_t size) {
315   SmallString<128> path_storage;
316   StringRef p = path.toNullTerminatedStringRef(path_storage);
317
318   if (::truncate(p.begin(), size) == -1)
319     return std::error_code(errno, std::generic_category());
320
321   return std::error_code();
322 }
323
324 static int convertAccessMode(AccessMode Mode) {
325   switch (Mode) {
326   case AccessMode::Exist:
327     return F_OK;
328   case AccessMode::Write:
329     return W_OK;
330   case AccessMode::Execute:
331     return R_OK | X_OK; // scripts also need R_OK.
332   }
333   llvm_unreachable("invalid enum");
334 }
335
336 std::error_code access(const Twine &Path, AccessMode Mode) {
337   SmallString<128> PathStorage;
338   StringRef P = Path.toNullTerminatedStringRef(PathStorage);
339
340   if (::access(P.begin(), convertAccessMode(Mode)) == -1)
341     return std::error_code(errno, std::generic_category());
342
343   if (Mode == AccessMode::Execute) {
344     // Don't say that directories are executable.
345     struct stat buf;
346     if (0 != stat(P.begin(), &buf))
347       return errc::permission_denied;
348     if (!S_ISREG(buf.st_mode))
349       return errc::permission_denied;
350   }
351
352   return std::error_code();
353 }
354
355 bool equivalent(file_status A, file_status B) {
356   assert(status_known(A) && status_known(B));
357   return A.fs_st_dev == B.fs_st_dev &&
358          A.fs_st_ino == B.fs_st_ino;
359 }
360
361 std::error_code equivalent(const Twine &A, const Twine &B, bool &result) {
362   file_status fsA, fsB;
363   if (std::error_code ec = status(A, fsA))
364     return ec;
365   if (std::error_code ec = status(B, fsB))
366     return ec;
367   result = equivalent(fsA, fsB);
368   return std::error_code();
369 }
370
371 static std::error_code fillStatus(int StatRet, const struct stat &Status,
372                              file_status &Result) {
373   if (StatRet != 0) {
374     std::error_code ec(errno, std::generic_category());
375     if (ec == errc::no_such_file_or_directory)
376       Result = file_status(file_type::file_not_found);
377     else
378       Result = file_status(file_type::status_error);
379     return ec;
380   }
381
382   file_type Type = file_type::type_unknown;
383
384   if (S_ISDIR(Status.st_mode))
385     Type = file_type::directory_file;
386   else if (S_ISREG(Status.st_mode))
387     Type = file_type::regular_file;
388   else if (S_ISBLK(Status.st_mode))
389     Type = file_type::block_file;
390   else if (S_ISCHR(Status.st_mode))
391     Type = file_type::character_file;
392   else if (S_ISFIFO(Status.st_mode))
393     Type = file_type::fifo_file;
394   else if (S_ISSOCK(Status.st_mode))
395     Type = file_type::socket_file;
396
397   perms Perms = static_cast<perms>(Status.st_mode);
398   Result =
399       file_status(Type, Perms, Status.st_dev, Status.st_ino, Status.st_mtime,
400                   Status.st_uid, Status.st_gid, Status.st_size);
401
402   return std::error_code();
403 }
404
405 std::error_code status(const Twine &Path, file_status &Result) {
406   SmallString<128> PathStorage;
407   StringRef P = Path.toNullTerminatedStringRef(PathStorage);
408
409   struct stat Status;
410   int StatRet = ::stat(P.begin(), &Status);
411   return fillStatus(StatRet, Status, Result);
412 }
413
414 std::error_code status(int FD, file_status &Result) {
415   struct stat Status;
416   int StatRet = ::fstat(FD, &Status);
417   return fillStatus(StatRet, Status, Result);
418 }
419
420 std::error_code setLastModificationAndAccessTime(int FD, TimeValue Time) {
421 #if defined(HAVE_FUTIMENS)
422   timespec Times[2];
423   Times[0].tv_sec = Time.toEpochTime();
424   Times[0].tv_nsec = 0;
425   Times[1] = Times[0];
426   if (::futimens(FD, Times))
427     return std::error_code(errno, std::generic_category());
428   return std::error_code();
429 #elif defined(HAVE_FUTIMES)
430   timeval Times[2];
431   Times[0].tv_sec = Time.toEpochTime();
432   Times[0].tv_usec = 0;
433   Times[1] = Times[0];
434   if (::futimes(FD, Times))
435     return std::error_code(errno, std::generic_category());
436   return std::error_code();
437 #else
438 #warning Missing futimes() and futimens()
439   return make_error_code(errc::function_not_supported);
440 #endif
441 }
442
443 std::error_code mapped_file_region::init(int FD, bool CloseFD, uint64_t Offset) {
444   AutoFD ScopedFD(FD);
445   if (!CloseFD)
446     ScopedFD.take();
447
448   // Figure out how large the file is.
449   struct stat FileInfo;
450   if (fstat(FD, &FileInfo) == -1)
451     return std::error_code(errno, std::generic_category());
452   uint64_t FileSize = FileInfo.st_size;
453
454   if (Size == 0)
455     Size = FileSize;
456   else if (FileSize < Size) {
457     // We need to grow the file.
458     if (ftruncate(FD, Size) == -1)
459       return std::error_code(errno, std::generic_category());
460   }
461
462   int flags = (Mode == readwrite) ? MAP_SHARED : MAP_PRIVATE;
463   int prot = (Mode == readonly) ? PROT_READ : (PROT_READ | PROT_WRITE);
464 #ifdef MAP_FILE
465   flags |= MAP_FILE;
466 #endif
467   Mapping = ::mmap(nullptr, Size, prot, flags, FD, Offset);
468   if (Mapping == MAP_FAILED)
469     return std::error_code(errno, std::generic_category());
470   return std::error_code();
471 }
472
473 mapped_file_region::mapped_file_region(int fd,
474                                        bool closefd,
475                                        mapmode mode,
476                                        uint64_t length,
477                                        uint64_t offset,
478                                        std::error_code &ec)
479   : Mode(mode)
480   , Size(length)
481   , Mapping() {
482   // Make sure that the requested size fits within SIZE_T.
483   if (length > std::numeric_limits<size_t>::max()) {
484     ec = make_error_code(errc::invalid_argument);
485     return;
486   }
487
488   ec = init(fd, closefd, offset);
489   if (ec)
490     Mapping = nullptr;
491 }
492
493 mapped_file_region::~mapped_file_region() {
494   if (Mapping)
495     ::munmap(Mapping, Size);
496 }
497
498 mapped_file_region::mapped_file_region(mapped_file_region &&other)
499   : Mode(other.Mode), Size(other.Size), Mapping(other.Mapping) {
500   other.Mapping = nullptr;
501 }
502
503 uint64_t mapped_file_region::size() const {
504   assert(Mapping && "Mapping failed but used anyway!");
505   return Size;
506 }
507
508 char *mapped_file_region::data() const {
509   assert(Mapping && "Mapping failed but used anyway!");
510   assert(Mode != readonly && "Cannot get non-const data for readonly mapping!");
511   return reinterpret_cast<char*>(Mapping);
512 }
513
514 const char *mapped_file_region::const_data() const {
515   assert(Mapping && "Mapping failed but used anyway!");
516   return reinterpret_cast<const char*>(Mapping);
517 }
518
519 int mapped_file_region::alignment() {
520   return Process::getPageSize();
521 }
522
523 std::error_code detail::directory_iterator_construct(detail::DirIterState &it,
524                                                 StringRef path){
525   SmallString<128> path_null(path);
526   DIR *directory = ::opendir(path_null.c_str());
527   if (!directory)
528     return std::error_code(errno, std::generic_category());
529
530   it.IterationHandle = reinterpret_cast<intptr_t>(directory);
531   // Add something for replace_filename to replace.
532   path::append(path_null, ".");
533   it.CurrentEntry = directory_entry(path_null.str());
534   return directory_iterator_increment(it);
535 }
536
537 std::error_code detail::directory_iterator_destruct(detail::DirIterState &it) {
538   if (it.IterationHandle)
539     ::closedir(reinterpret_cast<DIR *>(it.IterationHandle));
540   it.IterationHandle = 0;
541   it.CurrentEntry = directory_entry();
542   return std::error_code();
543 }
544
545 std::error_code detail::directory_iterator_increment(detail::DirIterState &it) {
546   errno = 0;
547   dirent *cur_dir = ::readdir(reinterpret_cast<DIR *>(it.IterationHandle));
548   if (cur_dir == nullptr && errno != 0) {
549     return std::error_code(errno, std::generic_category());
550   } else if (cur_dir != nullptr) {
551     StringRef name(cur_dir->d_name, NAMLEN(cur_dir));
552     if ((name.size() == 1 && name[0] == '.') ||
553         (name.size() == 2 && name[0] == '.' && name[1] == '.'))
554       return directory_iterator_increment(it);
555     it.CurrentEntry.replace_filename(name);
556   } else
557     return directory_iterator_destruct(it);
558
559   return std::error_code();
560 }
561
562 std::error_code openFileForRead(const Twine &Name, int &ResultFD) {
563   SmallString<128> Storage;
564   StringRef P = Name.toNullTerminatedStringRef(Storage);
565   while ((ResultFD = open(P.begin(), O_RDONLY)) < 0) {
566     if (errno != EINTR)
567       return std::error_code(errno, std::generic_category());
568   }
569   return std::error_code();
570 }
571
572 std::error_code openFileForWrite(const Twine &Name, int &ResultFD,
573                             sys::fs::OpenFlags Flags, unsigned Mode) {
574   // Verify that we don't have both "append" and "excl".
575   assert((!(Flags & sys::fs::F_Excl) || !(Flags & sys::fs::F_Append)) &&
576          "Cannot specify both 'excl' and 'append' file creation flags!");
577
578   int OpenFlags = O_CREAT;
579
580   if (Flags & F_RW)
581     OpenFlags |= O_RDWR;
582   else
583     OpenFlags |= O_WRONLY;
584
585   if (Flags & F_Append)
586     OpenFlags |= O_APPEND;
587   else
588     OpenFlags |= O_TRUNC;
589
590   if (Flags & F_Excl)
591     OpenFlags |= O_EXCL;
592
593   SmallString<128> Storage;
594   StringRef P = Name.toNullTerminatedStringRef(Storage);
595   while ((ResultFD = open(P.begin(), OpenFlags, Mode)) < 0) {
596     if (errno != EINTR)
597       return std::error_code(errno, std::generic_category());
598   }
599   return std::error_code();
600 }
601
602 } // end namespace fs
603
604 namespace path {
605
606 bool home_directory(SmallVectorImpl<char> &result) {
607   if (char *RequestedDir = getenv("HOME")) {
608     result.clear();
609     result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
610     return true;
611   }
612
613   return false;
614 }
615
616 static const char *getEnvTempDir() {
617   // Check whether the temporary directory is specified by an environment
618   // variable.
619   const char *EnvironmentVariables[] = {"TMPDIR", "TMP", "TEMP", "TEMPDIR"};
620   for (const char *Env : EnvironmentVariables) {
621     if (const char *Dir = std::getenv(Env))
622       return Dir;
623   }
624
625   return nullptr;
626 }
627
628 static const char *getDefaultTempDir(bool ErasedOnReboot) {
629 #ifdef P_tmpdir
630   if ((bool)P_tmpdir)
631     return P_tmpdir;
632 #endif
633
634   if (ErasedOnReboot)
635     return "/tmp";
636   return "/var/tmp";
637 }
638
639 void system_temp_directory(bool ErasedOnReboot, SmallVectorImpl<char> &Result) {
640   Result.clear();
641
642   if (ErasedOnReboot) {
643     // There is no env variable for the cache directory.
644     if (const char *RequestedDir = getEnvTempDir()) {
645       Result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
646       return;
647     }
648   }
649
650 #if defined(_CS_DARWIN_USER_TEMP_DIR) && defined(_CS_DARWIN_USER_CACHE_DIR)
651   // On Darwin, use DARWIN_USER_TEMP_DIR or DARWIN_USER_CACHE_DIR.
652   // macros defined in <unistd.h> on darwin >= 9
653   int ConfName = ErasedOnReboot? _CS_DARWIN_USER_TEMP_DIR
654                                : _CS_DARWIN_USER_CACHE_DIR;
655   size_t ConfLen = confstr(ConfName, nullptr, 0);
656   if (ConfLen > 0) {
657     do {
658       Result.resize(ConfLen);
659       ConfLen = confstr(ConfName, Result.data(), Result.size());
660     } while (ConfLen > 0 && ConfLen != Result.size());
661
662     if (ConfLen > 0) {
663       assert(Result.back() == 0);
664       Result.pop_back();
665       return;
666     }
667
668     Result.clear();
669   }
670 #endif
671
672   const char *RequestedDir = getDefaultTempDir(ErasedOnReboot);
673   Result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
674 }
675
676 } // end namespace path
677
678 } // end namespace sys
679 } // end namespace llvm