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