lib/Support/Path.cpp

   1 //===-- Path.cpp - Implement OS Path Concept ------------------------------===//
   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 operating system Path API.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Support/COFF.h"
  15 #include "llvm/Support/MachO.h"
  16 #include "llvm/Support/Endian.h"
  17 #include "llvm/Support/Errc.h"
  18 #include "llvm/Support/ErrorHandling.h"
  19 #include "llvm/Support/FileSystem.h"
  20 #include "llvm/Support/Path.h"
  21 #include "llvm/Support/Process.h"
  22 #include <cctype>
  23 #include <cstring>
  24
  25 #if !defined(_MSC_VER) && !defined(__MINGW32__)
  26 #include <unistd.h>
  27 #else
  28 #include <io.h>
  29 #endif
  30
  31 using namespace llvm;
  32 using namespace llvm::support::endian;
  33
  34 namespace {
  35   using llvm::StringRef;
  36   using llvm::sys::path::is_separator;
  37
  38 #ifdef LLVM_ON_WIN32
  39   const char *separators = "\\/";
  40   const char preferred_separator = '\\';
  41 #else
  42   const char  separators = '/';
  43   const char preferred_separator = '/';
  44 #endif
  45
  46   StringRef find_first_component(StringRef path) {
  47     // Look for this first component in the following order.
  48     // * empty (in this case we return an empty string)
  49     // * either C: or {//,\\}net.
  50     // * {/,\}
  51     // * {file,directory}name
  52
  53     if (path.empty())
  54       return path;
  55
  56 #ifdef LLVM_ON_WIN32
  57     // C:
  58     if (path.size() >= 2 && std::isalpha(static_cast<unsigned char>(path[0])) &&
  59         path[1] == ':')
  60       return path.substr(0, 2);
  61 #endif
  62
  63     // //net
  64     if ((path.size() > 2) &&
  65         is_separator(path[0]) &&
  66         path[0] == path[1] &&
  67         !is_separator(path[2])) {
  68       // Find the next directory separator.
  69       size_t end = path.find_first_of(separators, 2);
  70       return path.substr(0, end);
  71     }
  72
  73     // {/,\}
  74     if (is_separator(path[0]))
  75       return path.substr(0, 1);
  76
  77     // * {file,directory}name
  78     size_t end = path.find_first_of(separators);
  79     return path.substr(0, end);
  80   }
  81
  82   size_t filename_pos(StringRef str) {
  83     if (str.size() == 2 &&
  84         is_separator(str[0]) &&
  85         str[0] == str[1])
  86       return 0;
  87
  88     if (str.size() > 0 && is_separator(str[str.size() - 1]))
  89       return str.size() - 1;
  90
  91     size_t pos = str.find_last_of(separators, str.size() - 1);
  92
  93 #ifdef LLVM_ON_WIN32
  94     if (pos == StringRef::npos)
  95       pos = str.find_last_of(':', str.size() - 2);
  96 #endif
  97
  98     if (pos == StringRef::npos ||
  99         (pos == 1 && is_separator(str[0])))
 100       return 0;
 101
 102     return pos + 1;
 103   }
 104
 105   size_t root_dir_start(StringRef str) {
 106     // case "c:/"
 107 #ifdef LLVM_ON_WIN32
 108     if (str.size() > 2 &&
 109         str[1] == ':' &&
 110         is_separator(str[2]))
 111       return 2;
 112 #endif
 113
 114     // case "//"
 115     if (str.size() == 2 &&
 116         is_separator(str[0]) &&
 117         str[0] == str[1])
 118       return StringRef::npos;
 119
 120     // case "//net"
 121     if (str.size() > 3 &&
 122         is_separator(str[0]) &&
 123         str[0] == str[1] &&
 124         !is_separator(str[2])) {
 125       return str.find_first_of(separators, 2);
 126     }
 127
 128     // case "/"
 129     if (str.size() > 0 && is_separator(str[0]))
 130       return 0;
 131
 132     return StringRef::npos;
 133   }
 134
 135   size_t parent_path_end(StringRef path) {
 136     size_t end_pos = filename_pos(path);
 137
 138     bool filename_was_sep = path.size() > 0 && is_separator(path[end_pos]);
 139
 140     // Skip separators except for root dir.
 141     size_t root_dir_pos = root_dir_start(path.substr(0, end_pos));
 142
 143     while(end_pos > 0 &&
 144           (end_pos - 1) != root_dir_pos &&
 145           is_separator(path[end_pos - 1]))
 146       --end_pos;
 147
 148     if (end_pos == 1 && root_dir_pos == 0 && filename_was_sep)
 149       return StringRef::npos;
 150
 151     return end_pos;
 152   }
 153 } // end unnamed namespace
 154
 155 enum FSEntity {
 156   FS_Dir,
 157   FS_File,
 158   FS_Name
 159 };
 160
 161 static std::error_code createUniqueEntity(const Twine &Model, int &ResultFD,
 162                                           SmallVectorImpl<char> &ResultPath,
 163                                           bool MakeAbsolute, unsigned Mode,
 164                                           FSEntity Type) {
 165   SmallString<128> ModelStorage;
 166   Model.toVector(ModelStorage);
 167
 168   if (MakeAbsolute) {
 169     // Make model absolute by prepending a temp directory if it's not already.
 170     if (!sys::path::is_absolute(Twine(ModelStorage))) {
 171       SmallString<128> TDir;
 172       sys::path::system_temp_directory(true, TDir);
 173       sys::path::append(TDir, Twine(ModelStorage));
 174       ModelStorage.swap(TDir);
 175     }
 176   }
 177
 178   // From here on, DO NOT modify model. It may be needed if the randomly chosen
 179   // path already exists.
 180   ResultPath = ModelStorage;
 181   // Null terminate.
 182   ResultPath.push_back(0);
 183   ResultPath.pop_back();
 184
 185 retry_random_path:
 186   // Replace '%' with random chars.
 187   for (unsigned i = 0, e = ModelStorage.size(); i != e; ++i) {
 188     if (ModelStorage[i] == '%')
 189       ResultPath[i] = "0123456789abcdef"[sys::Process::GetRandomNumber() & 15];
 190   }
 191
 192   // Try to open + create the file.
 193   switch (Type) {
 194   case FS_File: {
 195     if (std::error_code EC =
 196             sys::fs::openFileForWrite(Twine(ResultPath.begin()), ResultFD,
 197                                       sys::fs::F_RW | sys::fs::F_Excl, Mode)) {
 198       if (EC == errc::file_exists)
 199         goto retry_random_path;
 200       return EC;
 201     }
 202
 203     return std::error_code();
 204   }
 205
 206   case FS_Name: {
 207     std::error_code EC =
 208         sys::fs::access(ResultPath.begin(), sys::fs::AccessMode::Exist);
 209     if (EC == errc::no_such_file_or_directory)
 210       return std::error_code();
 211     if (EC)
 212       return EC;
 213     goto retry_random_path;
 214   }
 215
 216   case FS_Dir: {
 217     if (std::error_code EC =
 218             sys::fs::create_directory(ResultPath.begin(), false)) {
 219       if (EC == errc::file_exists)
 220         goto retry_random_path;
 221       return EC;
 222     }
 223     return std::error_code();
 224   }
 225   }
 226   llvm_unreachable("Invalid Type");
 227 }
 228
 229 namespace llvm {
 230 namespace sys  {
 231 namespace path {
 232
 233 const_iterator begin(StringRef path) {
 234   const_iterator i;
 235   i.Path      = path;
 236   i.Component = find_first_component(path);
 237   i.Position  = 0;
 238   return i;
 239 }
 240
 241 const_iterator end(StringRef path) {
 242   const_iterator i;
 243   i.Path      = path;
 244   i.Position  = path.size();
 245   return i;
 246 }
 247
 248 const_iterator &const_iterator::operator++() {
 249   assert(Position < Path.size() && "Tried to increment past end!");
 250
 251   // Increment Position to past the current component
 252   Position += Component.size();
 253
 254   // Check for end.
 255   if (Position == Path.size()) {
 256     Component = StringRef();
 257     return *this;
 258   }
 259
 260   // Both POSIX and Windows treat paths that begin with exactly two separators
 261   // specially.
 262   bool was_net = Component.size() > 2 &&
 263     is_separator(Component[0]) &&
 264     Component[1] == Component[0] &&
 265     !is_separator(Component[2]);
 266
 267   // Handle separators.
 268   if (is_separator(Path[Position])) {
 269     // Root dir.
 270     if (was_net
 271 #ifdef LLVM_ON_WIN32
 272         // c:/
 273         || Component.endswith(":")
 274 #endif
 275         ) {
 276       Component = Path.substr(Position, 1);
 277       return *this;
 278     }
 279
 280     // Skip extra separators.
 281     while (Position != Path.size() &&
 282            is_separator(Path[Position])) {
 283       ++Position;
 284     }
 285
 286     // Treat trailing '/' as a '.'.
 287     if (Position == Path.size()) {
 288       --Position;
 289       Component = ".";
 290       return *this;
 291     }
 292   }
 293
 294   // Find next component.
 295   size_t end_pos = Path.find_first_of(separators, Position);
 296   Component = Path.slice(Position, end_pos);
 297
 298   return *this;
 299 }
 300
 301 bool const_iterator::operator==(const const_iterator &RHS) const {
 302   return Path.begin() == RHS.Path.begin() && Position == RHS.Position;
 303 }
 304
 305 ptrdiff_t const_iterator::operator-(const const_iterator &RHS) const {
 306   return Position - RHS.Position;
 307 }
 308
 309 reverse_iterator rbegin(StringRef Path) {
 310   reverse_iterator I;
 311   I.Path = Path;
 312   I.Position = Path.size();
 313   return ++I;
 314 }
 315
 316 reverse_iterator rend(StringRef Path) {
 317   reverse_iterator I;
 318   I.Path = Path;
 319   I.Component = Path.substr(0, 0);
 320   I.Position = 0;
 321   return I;
 322 }
 323
 324 reverse_iterator &reverse_iterator::operator++() {
 325   // If we're at the end and the previous char was a '/', return '.' unless
 326   // we are the root path.
 327   size_t root_dir_pos = root_dir_start(Path);
 328   if (Position == Path.size() &&
 329       Path.size() > root_dir_pos + 1 &&
 330       is_separator(Path[Position - 1])) {
 331     --Position;
 332     Component = ".";
 333     return *this;
 334   }
 335
 336   // Skip separators unless it's the root directory.
 337   size_t end_pos = Position;
 338
 339   while(end_pos > 0 &&
 340         (end_pos - 1) != root_dir_pos &&
 341         is_separator(Path[end_pos - 1]))
 342     --end_pos;
 343
 344   // Find next separator.
 345   size_t start_pos = filename_pos(Path.substr(0, end_pos));
 346   Component = Path.slice(start_pos, end_pos);
 347   Position = start_pos;
 348   return *this;
 349 }
 350
 351 bool reverse_iterator::operator==(const reverse_iterator &RHS) const {
 352   return Path.begin() == RHS.Path.begin() && Component == RHS.Component &&
 353          Position == RHS.Position;
 354 }
 355
 356 ptrdiff_t reverse_iterator::operator-(const reverse_iterator &RHS) const {
 357   return Position - RHS.Position;
 358 }
 359
 360 StringRef root_path(StringRef path) {
 361   const_iterator b = begin(path),
 362                  pos = b,
 363                  e = end(path);
 364   if (b != e) {
 365     bool has_net = b->size() > 2 && is_separator((*b)[0]) && (*b)[1] == (*b)[0];
 366     bool has_drive =
 367 #ifdef LLVM_ON_WIN32
 368       b->endswith(":");
 369 #else
 370       false;
 371 #endif
 372
 373     if (has_net || has_drive) {
 374       if ((++pos != e) && is_separator((*pos)[0])) {
 375         // {C:/,//net/}, so get the first two components.
 376         return path.substr(0, b->size() + pos->size());
 377       } else {
 378         // just {C:,//net}, return the first component.
 379         return *b;
 380       }
 381     }
 382
 383     // POSIX style root directory.
 384     if (is_separator((*b)[0])) {
 385       return *b;
 386     }
 387   }
 388
 389   return StringRef();
 390 }
 391
 392 StringRef root_name(StringRef path) {
 393   const_iterator b = begin(path),
 394                  e = end(path);
 395   if (b != e) {
 396     bool has_net = b->size() > 2 && is_separator((*b)[0]) && (*b)[1] == (*b)[0];
 397     bool has_drive =
 398 #ifdef LLVM_ON_WIN32
 399       b->endswith(":");
 400 #else
 401       false;
 402 #endif
 403
 404     if (has_net || has_drive) {
 405       // just {C:,//net}, return the first component.
 406       return *b;
 407     }
 408   }
 409
 410   // No path or no name.
 411   return StringRef();
 412 }
 413
 414 StringRef root_directory(StringRef path) {
 415   const_iterator b = begin(path),
 416                  pos = b,
 417                  e = end(path);
 418   if (b != e) {
 419     bool has_net = b->size() > 2 && is_separator((*b)[0]) && (*b)[1] == (*b)[0];
 420     bool has_drive =
 421 #ifdef LLVM_ON_WIN32
 422       b->endswith(":");
 423 #else
 424       false;
 425 #endif
 426
 427     if ((has_net || has_drive) &&
 428         // {C:,//net}, skip to the next component.
 429         (++pos != e) && is_separator((*pos)[0])) {
 430       return *pos;
 431     }
 432
 433     // POSIX style root directory.
 434     if (!has_net && is_separator((*b)[0])) {
 435       return *b;
 436     }
 437   }
 438
 439   // No path or no root.
 440   return StringRef();
 441 }
 442
 443 StringRef relative_path(StringRef path) {
 444   StringRef root = root_path(path);
 445   return path.substr(root.size());
 446 }
 447
 448 void append(SmallVectorImpl<char> &path, const Twine &a,
 449                                          const Twine &b,
 450                                          const Twine &c,
 451                                          const Twine &d) {
 452   SmallString<32> a_storage;
 453   SmallString<32> b_storage;
 454   SmallString<32> c_storage;
 455   SmallString<32> d_storage;
 456
 457   SmallVector<StringRef, 4> components;
 458   if (!a.isTriviallyEmpty()) components.push_back(a.toStringRef(a_storage));
 459   if (!b.isTriviallyEmpty()) components.push_back(b.toStringRef(b_storage));
 460   if (!c.isTriviallyEmpty()) components.push_back(c.toStringRef(c_storage));
 461   if (!d.isTriviallyEmpty()) components.push_back(d.toStringRef(d_storage));
 462
 463   for (auto &component : components) {
 464     bool path_has_sep = !path.empty() && is_separator(path[path.size() - 1]);
 465     bool component_has_sep = !component.empty() && is_separator(component[0]);
 466     bool is_root_name = has_root_name(component);
 467
 468     if (path_has_sep) {
 469       // Strip separators from beginning of component.
 470       size_t loc = component.find_first_not_of(separators);
 471       StringRef c = component.substr(loc);
 472
 473       // Append it.
 474       path.append(c.begin(), c.end());
 475       continue;
 476     }
 477
 478     if (!component_has_sep && !(path.empty() || is_root_name)) {
 479       // Add a separator.
 480       path.push_back(preferred_separator);
 481     }
 482
 483     path.append(component.begin(), component.end());
 484   }
 485 }
 486
 487 void append(SmallVectorImpl<char> &path,
 488             const_iterator begin, const_iterator end) {
 489   for (; begin != end; ++begin)
 490     path::append(path, *begin);
 491 }
 492
 493 StringRef parent_path(StringRef path) {
 494   size_t end_pos = parent_path_end(path);
 495   if (end_pos == StringRef::npos)
 496     return StringRef();
 497   else
 498     return path.substr(0, end_pos);
 499 }
 500
 501 void remove_filename(SmallVectorImpl<char> &path) {
 502   size_t end_pos = parent_path_end(StringRef(path.begin(), path.size()));
 503   if (end_pos != StringRef::npos)
 504     path.set_size(end_pos);
 505 }
 506
 507 void replace_extension(SmallVectorImpl<char> &path, const Twine &extension) {
 508   StringRef p(path.begin(), path.size());
 509   SmallString<32> ext_storage;
 510   StringRef ext = extension.toStringRef(ext_storage);
 511
 512   // Erase existing extension.
 513   size_t pos = p.find_last_of('.');
 514   if (pos != StringRef::npos && pos >= filename_pos(p))
 515     path.set_size(pos);
 516
 517   // Append '.' if needed.
 518   if (ext.size() > 0 && ext[0] != '.')
 519     path.push_back('.');
 520
 521   // Append extension.
 522   path.append(ext.begin(), ext.end());
 523 }
 524
 525 void replace_path_prefix(SmallVectorImpl<char> &Path,
 526                          const StringRef &OldPrefix,
 527                          const StringRef &NewPrefix) {
 528   if (OldPrefix.empty() && NewPrefix.empty())
 529     return;
 530
 531   StringRef OrigPath(Path.begin(), Path.size());
 532   if (!OrigPath.startswith(OldPrefix))
 533     return;
 534
 535   // If prefixes have the same size we can simply copy the new one over.
 536   if (OldPrefix.size() == NewPrefix.size()) {
 537     std::copy(NewPrefix.begin(), NewPrefix.end(), Path.begin());
 538     return;
 539   }
 540
 541   StringRef RelPath = OrigPath.substr(OldPrefix.size());
 542   SmallString<256> NewPath;
 543   path::append(NewPath, NewPrefix);
 544   path::append(NewPath, RelPath);
 545   Path.swap(NewPath);
 546 }
 547
 548 void native(const Twine &path, SmallVectorImpl<char> &result) {
 549   assert((!path.isSingleStringRef() ||
 550           path.getSingleStringRef().data() != result.data()) &&
 551          "path and result are not allowed to overlap!");
 552   // Clear result.
 553   result.clear();
 554   path.toVector(result);
 555   native(result);
 556 }
 557
 558 void native(SmallVectorImpl<char> &Path) {
 559   if (Path.empty())
 560     return;
 561 #ifdef LLVM_ON_WIN32
 562   std::replace(Path.begin(), Path.end(), '/', '\\');
 563   if (Path[0] == '~' && (Path.size() == 1 || is_separator(Path[1]))) {
 564     SmallString<128> PathHome;
 565     home_directory(PathHome);
 566     PathHome.append(Path.begin() + 1, Path.end());
 567     Path = PathHome;
 568   }
 569 #else
 570   for (auto PI = Path.begin(), PE = Path.end(); PI < PE; ++PI) {
 571     if (*PI == '\\') {
 572       auto PN = PI + 1;
 573       if (PN < PE && *PN == '\\')
 574         ++PI; // increment once, the for loop will move over the escaped slash
 575       else
 576         *PI = '/';
 577     }
 578   }
 579 #endif
 580 }
 581
 582 std::string convert_to_slash(StringRef path) {
 583 #ifdef LLVM_ON_WIN32
 584   std::string s = path.str();
 585   std::replace(s.begin(), s.end(), '\\', '/');
 586   return s;
 587 #else
 588   return path;
 589 #endif
 590 }
 591
 592 StringRef filename(StringRef path) {
 593   return *rbegin(path);
 594 }
 595
 596 StringRef stem(StringRef path) {
 597   StringRef fname = filename(path);
 598   size_t pos = fname.find_last_of('.');
 599   if (pos == StringRef::npos)
 600     return fname;
 601   else
 602     if ((fname.size() == 1 && fname == ".") ||
 603         (fname.size() == 2 && fname == ".."))
 604       return fname;
 605     else
 606       return fname.substr(0, pos);
 607 }
 608
 609 StringRef extension(StringRef path) {
 610   StringRef fname = filename(path);
 611   size_t pos = fname.find_last_of('.');
 612   if (pos == StringRef::npos)
 613     return StringRef();
 614   else
 615     if ((fname.size() == 1 && fname == ".") ||
 616         (fname.size() == 2 && fname == ".."))
 617       return StringRef();
 618     else
 619       return fname.substr(pos);
 620 }
 621
 622 bool is_separator(char value) {
 623   switch(value) {
 624 #ifdef LLVM_ON_WIN32
 625     case '\\': // fall through
 626 #endif
 627     case '/': return true;
 628     default: return false;
 629   }
 630 }
 631
 632 static const char preferred_separator_string[] = { preferred_separator, '\0' };
 633
 634 StringRef get_separator() {
 635   return preferred_separator_string;
 636 }
 637
 638 bool has_root_name(const Twine &path) {
 639   SmallString<128> path_storage;
 640   StringRef p = path.toStringRef(path_storage);
 641
 642   return !root_name(p).empty();
 643 }
 644
 645 bool has_root_directory(const Twine &path) {
 646   SmallString<128> path_storage;
 647   StringRef p = path.toStringRef(path_storage);
 648
 649   return !root_directory(p).empty();
 650 }
 651
 652 bool has_root_path(const Twine &path) {
 653   SmallString<128> path_storage;
 654   StringRef p = path.toStringRef(path_storage);
 655
 656   return !root_path(p).empty();
 657 }
 658
 659 bool has_relative_path(const Twine &path) {
 660   SmallString<128> path_storage;
 661   StringRef p = path.toStringRef(path_storage);
 662
 663   return !relative_path(p).empty();
 664 }
 665
 666 bool has_filename(const Twine &path) {
 667   SmallString<128> path_storage;
 668   StringRef p = path.toStringRef(path_storage);
 669
 670   return !filename(p).empty();
 671 }
 672
 673 bool has_parent_path(const Twine &path) {
 674   SmallString<128> path_storage;
 675   StringRef p = path.toStringRef(path_storage);
 676
 677   return !parent_path(p).empty();
 678 }
 679
 680 bool has_stem(const Twine &path) {
 681   SmallString<128> path_storage;
 682   StringRef p = path.toStringRef(path_storage);
 683
 684   return !stem(p).empty();
 685 }
 686
 687 bool has_extension(const Twine &path) {
 688   SmallString<128> path_storage;
 689   StringRef p = path.toStringRef(path_storage);
 690
 691   return !extension(p).empty();
 692 }
 693
 694 bool is_absolute(const Twine &path) {
 695   SmallString<128> path_storage;
 696   StringRef p = path.toStringRef(path_storage);
 697
 698   bool rootDir = has_root_directory(p),
 699 #ifdef LLVM_ON_WIN32
 700        rootName = has_root_name(p);
 701 #else
 702        rootName = true;
 703 #endif
 704
 705   return rootDir && rootName;
 706 }
 707
 708 bool is_relative(const Twine &path) { return !is_absolute(path); }
 709
 710 StringRef remove_leading_dotslash(StringRef Path) {
 711   // Remove leading "./" (or ".//" or "././" etc.)
 712   while (Path.size() > 2 && Path[0] == '.' && is_separator(Path[1])) {
 713     Path = Path.substr(2);
 714     while (Path.size() > 0 && is_separator(Path[0]))
 715       Path = Path.substr(1);
 716   }
 717   return Path;
 718 }
 719
 720 static SmallString<256> remove_dots(StringRef path, bool remove_dot_dot) {
 721   SmallVector<StringRef, 16> components;
 722
 723   // Skip the root path, then look for traversal in the components.
 724   StringRef rel = path::relative_path(path);
 725   for (StringRef C : llvm::make_range(path::begin(rel), path::end(rel))) {
 726     if (C == ".")
 727       continue;
 728     // Leading ".." will remain in the path unless it's at the root.
 729     if (remove_dot_dot && C == "..") {
 730       if (!components.empty() && components.back() != "..") {
 731         components.pop_back();
 732         continue;
 733       }
 734       if (path::is_absolute(path))
 735         continue;
 736     }
 737     components.push_back(C);
 738   }
 739
 740   SmallString<256> buffer = path::root_path(path);
 741   for (StringRef C : components)
 742     path::append(buffer, C);
 743   return buffer;
 744 }
 745
 746 bool remove_dots(SmallVectorImpl<char> &path, bool remove_dot_dot) {
 747   StringRef p(path.data(), path.size());
 748
 749   SmallString<256> result = remove_dots(p, remove_dot_dot);
 750   if (result == path)
 751     return false;
 752
 753   path.swap(result);
 754   return true;
 755 }
 756
 757 } // end namespace path
 758
 759 namespace fs {
 760
 761 std::error_code getUniqueID(const Twine Path, UniqueID &Result) {
 762   file_status Status;
 763   std::error_code EC = status(Path, Status);
 764   if (EC)
 765     return EC;
 766   Result = Status.getUniqueID();
 767   return std::error_code();
 768 }
 769
 770 std::error_code createUniqueFile(const Twine &Model, int &ResultFd,
 771                                  SmallVectorImpl<char> &ResultPath,
 772                                  unsigned Mode) {
 773   return createUniqueEntity(Model, ResultFd, ResultPath, false, Mode, FS_File);
 774 }
 775
 776 std::error_code createUniqueFile(const Twine &Model,
 777                                  SmallVectorImpl<char> &ResultPath) {
 778   int Dummy;
 779   return createUniqueEntity(Model, Dummy, ResultPath, false, 0, FS_Name);
 780 }
 781
 782 static std::error_code
 783 createTemporaryFile(const Twine &Model, int &ResultFD,
 784                     llvm::SmallVectorImpl<char> &ResultPath, FSEntity Type) {
 785   SmallString<128> Storage;
 786   StringRef P = Model.toNullTerminatedStringRef(Storage);
 787   assert(P.find_first_of(separators) == StringRef::npos &&
 788          "Model must be a simple filename.");
 789   // Use P.begin() so that createUniqueEntity doesn't need to recreate Storage.
 790   return createUniqueEntity(P.begin(), ResultFD, ResultPath,
 791                             true, owner_read | owner_write, Type);
 792 }
 793
 794 static std::error_code
 795 createTemporaryFile(const Twine &Prefix, StringRef Suffix, int &ResultFD,
 796                     llvm::SmallVectorImpl<char> &ResultPath, FSEntity Type) {
 797   const char *Middle = Suffix.empty() ? "-%%%%%%" : "-%%%%%%.";
 798   return createTemporaryFile(Prefix + Middle + Suffix, ResultFD, ResultPath,
 799                              Type);
 800 }
 801
 802 std::error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
 803                                     int &ResultFD,
 804                                     SmallVectorImpl<char> &ResultPath) {
 805   return createTemporaryFile(Prefix, Suffix, ResultFD, ResultPath, FS_File);
 806 }
 807
 808 std::error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
 809                                     SmallVectorImpl<char> &ResultPath) {
 810   int Dummy;
 811   return createTemporaryFile(Prefix, Suffix, Dummy, ResultPath, FS_Name);
 812 }
 813
 814
 815 // This is a mkdtemp with a different pattern. We use createUniqueEntity mostly
 816 // for consistency. We should try using mkdtemp.
 817 std::error_code createUniqueDirectory(const Twine &Prefix,
 818                                       SmallVectorImpl<char> &ResultPath) {
 819   int Dummy;
 820   return createUniqueEntity(Prefix + "-%%%%%%", Dummy, ResultPath,
 821                             true, 0, FS_Dir);
 822 }
 823
 824 static std::error_code make_absolute(const Twine &current_directory,
 825                                      SmallVectorImpl<char> &path,
 826                                      bool use_current_directory) {
 827   StringRef p(path.data(), path.size());
 828
 829   bool rootDirectory = path::has_root_directory(p),
 830 #ifdef LLVM_ON_WIN32
 831        rootName = path::has_root_name(p);
 832 #else
 833        rootName = true;
 834 #endif
 835
 836   // Already absolute.
 837   if (rootName && rootDirectory)
 838     return std::error_code();
 839
 840   // All of the following conditions will need the current directory.
 841   SmallString<128> current_dir;
 842   if (use_current_directory)
 843     current_directory.toVector(current_dir);
 844   else if (std::error_code ec = current_path(current_dir))
 845     return ec;
 846
 847   // Relative path. Prepend the current directory.
 848   if (!rootName && !rootDirectory) {
 849     // Append path to the current directory.
 850     path::append(current_dir, p);
 851     // Set path to the result.
 852     path.swap(current_dir);
 853     return std::error_code();
 854   }
 855
 856   if (!rootName && rootDirectory) {
 857     StringRef cdrn = path::root_name(current_dir);
 858     SmallString<128> curDirRootName(cdrn.begin(), cdrn.end());
 859     path::append(curDirRootName, p);
 860     // Set path to the result.
 861     path.swap(curDirRootName);
 862     return std::error_code();
 863   }
 864
 865   if (rootName && !rootDirectory) {
 866     StringRef pRootName      = path::root_name(p);
 867     StringRef bRootDirectory = path::root_directory(current_dir);
 868     StringRef bRelativePath  = path::relative_path(current_dir);
 869     StringRef pRelativePath  = path::relative_path(p);
 870
 871     SmallString<128> res;
 872     path::append(res, pRootName, bRootDirectory, bRelativePath, pRelativePath);
 873     path.swap(res);
 874     return std::error_code();
 875   }
 876
 877   llvm_unreachable("All rootName and rootDirectory combinations should have "
 878                    "occurred above!");
 879 }
 880
 881 std::error_code make_absolute(const Twine &current_directory,
 882                               SmallVectorImpl<char> &path) {
 883   return make_absolute(current_directory, path, true);
 884 }
 885
 886 std::error_code make_absolute(SmallVectorImpl<char> &path) {
 887   return make_absolute(Twine(), path, false);
 888 }
 889
 890 std::error_code create_directories(const Twine &Path, bool IgnoreExisting,
 891                                    perms Perms) {
 892   SmallString<128> PathStorage;
 893   StringRef P = Path.toStringRef(PathStorage);
 894
 895   // Be optimistic and try to create the directory
 896   std::error_code EC = create_directory(P, IgnoreExisting, Perms);
 897   // If we succeeded, or had any error other than the parent not existing, just
 898   // return it.
 899   if (EC != errc::no_such_file_or_directory)
 900     return EC;
 901
 902   // We failed because of a no_such_file_or_directory, try to create the
 903   // parent.
 904   StringRef Parent = path::parent_path(P);
 905   if (Parent.empty())
 906     return EC;
 907
 908   if ((EC = create_directories(Parent, IgnoreExisting, Perms)))
 909       return EC;
 910
 911   return create_directory(P, IgnoreExisting, Perms);
 912 }
 913
 914 std::error_code copy_file(const Twine &From, const Twine &To) {
 915   int ReadFD, WriteFD;
 916   if (std::error_code EC = openFileForRead(From, ReadFD))
 917     return EC;
 918   if (std::error_code EC = openFileForWrite(To, WriteFD, F_None)) {
 919     close(ReadFD);
 920     return EC;
 921   }
 922
 923   const size_t BufSize = 4096;
 924   char *Buf = new char[BufSize];
 925   int BytesRead = 0, BytesWritten = 0;
 926   for (;;) {
 927     BytesRead = read(ReadFD, Buf, BufSize);
 928     if (BytesRead <= 0)
 929       break;
 930     while (BytesRead) {
 931       BytesWritten = write(WriteFD, Buf, BytesRead);
 932       if (BytesWritten < 0)
 933         break;
 934       BytesRead -= BytesWritten;
 935     }
 936     if (BytesWritten < 0)
 937       break;
 938   }
 939   close(ReadFD);
 940   close(WriteFD);
 941   delete[] Buf;
 942
 943   if (BytesRead < 0 || BytesWritten < 0)
 944     return std::error_code(errno, std::generic_category());
 945   return std::error_code();
 946 }
 947
 948 bool exists(file_status status) {
 949   return status_known(status) && status.type() != file_type::file_not_found;
 950 }
 951
 952 bool status_known(file_status s) {
 953   return s.type() != file_type::status_error;
 954 }
 955
 956 file_type get_file_type(const Twine &Path, bool Follow) {
 957   file_status st;
 958   if (status(Path, st, Follow))
 959     return file_type::status_error;
 960   return st.type();
 961 }
 962
 963 bool is_directory(file_status status) {
 964   return status.type() == file_type::directory_file;
 965 }
 966
 967 std::error_code is_directory(const Twine &path, bool &result) {
 968   file_status st;
 969   if (std::error_code ec = status(path, st))
 970     return ec;
 971   result = is_directory(st);
 972   return std::error_code();
 973 }
 974
 975 bool is_regular_file(file_status status) {
 976   return status.type() == file_type::regular_file;
 977 }
 978
 979 std::error_code is_regular_file(const Twine &path, bool &result) {
 980   file_status st;
 981   if (std::error_code ec = status(path, st))
 982     return ec;
 983   result = is_regular_file(st);
 984   return std::error_code();
 985 }
 986
 987 bool is_symlink_file(file_status status) {
 988   return status.type() == file_type::symlink_file;
 989 }
 990
 991 std::error_code is_symlink_file(const Twine &path, bool &result) {
 992   file_status st;
 993   if (std::error_code ec = status(path, st, false))
 994     return ec;
 995   result = is_symlink_file(st);
 996   return std::error_code();
 997 }
 998
 999 bool is_other(file_status status) {
1000   return exists(status) &&
1001          !is_regular_file(status) &&
1002          !is_directory(status);
1003 }
1004
1005 std::error_code is_other(const Twine &Path, bool &Result) {
1006   file_status FileStatus;
1007   if (std::error_code EC = status(Path, FileStatus))
1008     return EC;
1009   Result = is_other(FileStatus);
1010   return std::error_code();
1011 }
1012
1013 void directory_entry::replace_filename(const Twine &filename, file_status st) {
1014   SmallString<128> path = path::parent_path(Path);
1015   path::append(path, filename);
1016   Path = path.str();
1017   Status = st;
1018 }
1019
1020 template <size_t N>
1021 static bool startswith(StringRef Magic, const char (&S)[N]) {
1022   return Magic.startswith(StringRef(S, N - 1));
1023 }
1024
1025 /// @brief Identify the magic in magic.
1026 file_magic identify_magic(StringRef Magic) {
1027   if (Magic.size() < 4)
1028     return file_magic::unknown;
1029   switch ((unsigned char)Magic[0]) {
1030     case 0x00: {
1031       // COFF bigobj, CL.exe's LTO object file, or short import library file
1032       if (startswith(Magic, "\0\0\xFF\xFF")) {
1033         size_t MinSize = offsetof(COFF::BigObjHeader, UUID) + sizeof(COFF::BigObjMagic);
1034         if (Magic.size() < MinSize)
1035           return file_magic::coff_import_library;
1036
1037         const char *Start = Magic.data() + offsetof(COFF::BigObjHeader, UUID);
1038         if (memcmp(Start, COFF::BigObjMagic, sizeof(COFF::BigObjMagic)) == 0)
1039           return file_magic::coff_object;
1040         if (memcmp(Start, COFF::ClGlObjMagic, sizeof(COFF::BigObjMagic)) == 0)
1041           return file_magic::coff_cl_gl_object;
1042         return file_magic::coff_import_library;
1043       }
1044       // Windows resource file
1045       if (startswith(Magic, "\0\0\0\0\x20\0\0\0\xFF"))
1046         return file_magic::windows_resource;
1047       // 0x0000 = COFF unknown machine type
1048       if (Magic[1] == 0)
1049         return file_magic::coff_object;
1050       if (startswith(Magic, "\0asm"))
1051         return file_magic::wasm_object;
1052       break;
1053     }
1054     case 0xDE:  // 0x0B17C0DE = BC wraper
1055       if (startswith(Magic, "\xDE\xC0\x17\x0B"))
1056         return file_magic::bitcode;
1057       break;
1058     case 'B':
1059       if (startswith(Magic, "BC\xC0\xDE"))
1060         return file_magic::bitcode;
1061       break;
1062     case '!':
1063       if (startswith(Magic, "!<arch>\n") || startswith(Magic, "!<thin>\n"))
1064         return file_magic::archive;
1065       break;
1066
1067     case '\177':
1068       if (startswith(Magic, "\177ELF") && Magic.size() >= 18) {
1069         bool Data2MSB = Magic[5] == 2;
1070         unsigned high = Data2MSB ? 16 : 17;
1071         unsigned low  = Data2MSB ? 17 : 16;
1072         if (Magic[high] == 0) {
1073           switch (Magic[low]) {
1074             default: return file_magic::elf;
1075             case 1: return file_magic::elf_relocatable;
1076             case 2: return file_magic::elf_executable;
1077             case 3: return file_magic::elf_shared_object;
1078             case 4: return file_magic::elf_core;
1079           }
1080         }
1081         // It's still some type of ELF file.
1082         return file_magic::elf;
1083       }
1084       break;
1085
1086     case 0xCA:
1087       if (startswith(Magic, "\xCA\xFE\xBA\xBE") ||
1088           startswith(Magic, "\xCA\xFE\xBA\xBF")) {
1089         // This is complicated by an overlap with Java class files.
1090         // See the Mach-O section in /usr/share/file/magic for details.
1091         if (Magic.size() >= 8 && Magic[7] < 43)
1092           return file_magic::macho_universal_binary;
1093       }
1094       break;
1095
1096       // The two magic numbers for mach-o are:
1097       // 0xfeedface - 32-bit mach-o
1098       // 0xfeedfacf - 64-bit mach-o
1099     case 0xFE:
1100     case 0xCE:
1101     case 0xCF: {
1102       uint16_t type = 0;
1103       if (startswith(Magic, "\xFE\xED\xFA\xCE") ||
1104           startswith(Magic, "\xFE\xED\xFA\xCF")) {
1105         /* Native endian */
1106         size_t MinSize;
1107         if (Magic[3] == char(0xCE))
1108           MinSize = sizeof(MachO::mach_header);
1109         else
1110           MinSize = sizeof(MachO::mach_header_64);
1111         if (Magic.size() >= MinSize)
1112           type = Magic[12] << 24 | Magic[13] << 12 | Magic[14] << 8 | Magic[15];
1113       } else if (startswith(Magic, "\xCE\xFA\xED\xFE") ||
1114                  startswith(Magic, "\xCF\xFA\xED\xFE")) {
1115         /* Reverse endian */
1116         size_t MinSize;
1117         if (Magic[0] == char(0xCE))
1118           MinSize = sizeof(MachO::mach_header);
1119         else
1120           MinSize = sizeof(MachO::mach_header_64);
1121         if (Magic.size() >= MinSize)
1122           type = Magic[15] << 24 | Magic[14] << 12 |Magic[13] << 8 | Magic[12];
1123       }
1124       switch (type) {
1125         default: break;
1126         case 1: return file_magic::macho_object;
1127         case 2: return file_magic::macho_executable;
1128         case 3: return file_magic::macho_fixed_virtual_memory_shared_lib;
1129         case 4: return file_magic::macho_core;
1130         case 5: return file_magic::macho_preload_executable;
1131         case 6: return file_magic::macho_dynamically_linked_shared_lib;
1132         case 7: return file_magic::macho_dynamic_linker;
1133         case 8: return file_magic::macho_bundle;
1134         case 9: return file_magic::macho_dynamically_linked_shared_lib_stub;
1135         case 10: return file_magic::macho_dsym_companion;
1136         case 11: return file_magic::macho_kext_bundle;
1137       }
1138       break;
1139     }
1140     case 0xF0: // PowerPC Windows
1141     case 0x83: // Alpha 32-bit
1142     case 0x84: // Alpha 64-bit
1143     case 0x66: // MPS R4000 Windows
1144     case 0x50: // mc68K
1145     case 0x4c: // 80386 Windows
1146     case 0xc4: // ARMNT Windows
1147       if (Magic[1] == 0x01)
1148         return file_magic::coff_object;
1149
1150     case 0x90: // PA-RISC Windows
1151     case 0x68: // mc68K Windows
1152       if (Magic[1] == 0x02)
1153         return file_magic::coff_object;
1154       break;
1155
1156     case 'M': // Possible MS-DOS stub on Windows PE file
1157       if (startswith(Magic, "MZ")) {
1158         uint32_t off = read32le(Magic.data() + 0x3c);
1159         // PE/COFF file, either EXE or DLL.
1160         if (off < Magic.size() &&
1161             memcmp(Magic.data()+off, COFF::PEMagic, sizeof(COFF::PEMagic)) == 0)
1162           return file_magic::pecoff_executable;
1163       }
1164       break;
1165
1166     case 0x64: // x86-64 Windows.
1167       if (Magic[1] == char(0x86))
1168         return file_magic::coff_object;
1169       break;
1170
1171     default:
1172       break;
1173   }
1174   return file_magic::unknown;
1175 }
1176
1177 std::error_code identify_magic(const Twine &Path, file_magic &Result) {
1178   int FD;
1179   if (std::error_code EC = openFileForRead(Path, FD))
1180     return EC;
1181
1182   char Buffer[32];
1183   int Length = read(FD, Buffer, sizeof(Buffer));
1184   if (close(FD) != 0 || Length < 0)
1185     return std::error_code(errno, std::generic_category());
1186
1187   Result = identify_magic(StringRef(Buffer, Length));
1188   return std::error_code();
1189 }
1190
1191 std::error_code directory_entry::status(file_status &result) const {
1192   return fs::status(Path, result, FollowSymlinks);\r
1193 }\r
1194 \r
1195 ErrorOr<perms> getPermissions(const Twine &Path) {\r
1196   file_status Status;\r
1197   if (std::error_code EC = status(Path, Status))\r
1198     return EC;\r
1199 \r
1200   return Status.permissions();\r
1201 }\r
1202 \r
1203 } // end namespace fs\r
1204 } // end namespace sys\r
1205 } // end namespace llvm\r
1206
1207 // Include the truly platform-specific parts.
1208 #if defined(LLVM_ON_UNIX)
1209 #include "Unix/Path.inc"
1210 #endif
1211 #if defined(LLVM_ON_WIN32)
1212 #include "Windows/Path.inc"
1213 #endif
1214
1215 namespace llvm {
1216 namespace sys {
1217 namespace path {
1218
1219 bool user_cache_directory(SmallVectorImpl<char> &Result, const Twine &Path1,
1220                           const Twine &Path2, const Twine &Path3) {
1221   if (getUserCacheDir(Result)) {
1222     append(Result, Path1, Path2, Path3);
1223     return true;
1224   }
1225   return false;
1226 }
1227
1228 } // end namespace path
1229 } // end namsspace sys
1230 } // end namespace llvm