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