include/llvm/Support/FileSystem.h

   1 //===- llvm/Support/FileSystem.h - File System OS Concept -------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file declares the llvm::sys::fs namespace. It is designed after
  11 // TR2/boost filesystem (v3), but modified to remove exception handling and the
  12 // path class.
  13 //
  14 // All functions return an error_code and their actual work via the last out
  15 // argument. The out argument is defined if and only if errc::success is
  16 // returned. A function may return any error code in the generic or system
  17 // category. However, they shall be equivalent to any error conditions listed
  18 // in each functions respective documentation if the condition applies. [ note:
  19 // this does not guarantee that error_code will be in the set of explicitly
  20 // listed codes, but it does guarantee that if any of the explicitly listed
  21 // errors occur, the correct error_code will be used ]. All functions may
  22 // return errc::not_enough_memory if there is not enough memory to complete the
  23 // operation.
  24 //
  25 //===----------------------------------------------------------------------===//
  26
  27 #ifndef LLVM_SUPPORT_FILESYSTEM_H
  28 #define LLVM_SUPPORT_FILESYSTEM_H
  29
  30 #include "llvm/ADT/IntrusiveRefCntPtr.h"
  31 #include "llvm/ADT/SmallString.h"
  32 #include "llvm/ADT/Twine.h"
  33 #include "llvm/Support/DataTypes.h"
  34 #include "llvm/Support/ErrorHandling.h"
  35 #include "llvm/Support/TimeValue.h"
  36 #include <ctime>
  37 #include <iterator>
  38 #include <stack>
  39 #include <string>
  40 #include <system_error>
  41 #include <tuple>
  42 #include <vector>
  43
  44 #ifdef HAVE_SYS_STAT_H
  45 #include <sys/stat.h>
  46 #endif
  47
  48 namespace llvm {
  49 namespace sys {
  50 namespace fs {
  51
  52 /// An enumeration for the file system's view of the type.
  53 enum class file_type {
  54   status_error,
  55   file_not_found,
  56   regular_file,
  57   directory_file,
  58   symlink_file,
  59   block_file,
  60   character_file,
  61   fifo_file,
  62   socket_file,
  63   type_unknown
  64 };
  65
  66 /// space_info - Self explanatory.
  67 struct space_info {
  68   uint64_t capacity;
  69   uint64_t free;
  70   uint64_t available;
  71 };
  72
  73 enum perms {
  74   no_perms = 0,
  75   owner_read = 0400,
  76   owner_write = 0200,
  77   owner_exe = 0100,
  78   owner_all = owner_read | owner_write | owner_exe,
  79   group_read = 040,
  80   group_write = 020,
  81   group_exe = 010,
  82   group_all = group_read | group_write | group_exe,
  83   others_read = 04,
  84   others_write = 02,
  85   others_exe = 01,
  86   others_all = others_read | others_write | others_exe,
  87   all_read = owner_read | group_read | others_read,
  88   all_write = owner_write | group_write | others_write,
  89   all_exe = owner_exe | group_exe | others_exe,
  90   all_all = owner_all | group_all | others_all,
  91   set_uid_on_exe = 04000,
  92   set_gid_on_exe = 02000,
  93   sticky_bit = 01000,
  94   perms_not_known = 0xFFFF
  95 };
  96
  97 // Helper functions so that you can use & and | to manipulate perms bits:
  98 inline perms operator|(perms l, perms r) {
  99   return static_cast<perms>(static_cast<unsigned short>(l) |
 100                             static_cast<unsigned short>(r));
 101 }
 102 inline perms operator&(perms l, perms r) {
 103   return static_cast<perms>(static_cast<unsigned short>(l) &
 104                             static_cast<unsigned short>(r));
 105 }
 106 inline perms &operator|=(perms &l, perms r) {
 107   l = l | r;
 108   return l;
 109 }
 110 inline perms &operator&=(perms &l, perms r) {
 111   l = l & r;
 112   return l;
 113 }
 114 inline perms operator~(perms x) {
 115   return static_cast<perms>(~static_cast<unsigned short>(x));
 116 }
 117
 118 class UniqueID {
 119   uint64_t Device;
 120   uint64_t File;
 121
 122 public:
 123   UniqueID() = default;
 124   UniqueID(uint64_t Device, uint64_t File) : Device(Device), File(File) {}
 125   bool operator==(const UniqueID &Other) const {
 126     return Device == Other.Device && File == Other.File;
 127   }
 128   bool operator!=(const UniqueID &Other) const { return !(*this == Other); }
 129   bool operator<(const UniqueID &Other) const {
 130     return std::tie(Device, File) < std::tie(Other.Device, Other.File);
 131   }
 132   uint64_t getDevice() const { return Device; }
 133   uint64_t getFile() const { return File; }
 134 };
 135
 136 /// file_status - Represents the result of a call to stat and friends. It has
 137 ///               a platform-specific member to store the result.
 138 class file_status
 139 {
 140   #if defined(LLVM_ON_UNIX)
 141   dev_t fs_st_dev;
 142   ino_t fs_st_ino;
 143   time_t fs_st_atime;
 144   time_t fs_st_mtime;
 145   uid_t fs_st_uid;
 146   gid_t fs_st_gid;
 147   off_t fs_st_size;
 148   #elif defined (LLVM_ON_WIN32)
 149   uint32_t LastAccessedTimeHigh;
 150   uint32_t LastAccessedTimeLow;
 151   uint32_t LastWriteTimeHigh;
 152   uint32_t LastWriteTimeLow;
 153   uint32_t VolumeSerialNumber;
 154   uint32_t FileSizeHigh;
 155   uint32_t FileSizeLow;
 156   uint32_t FileIndexHigh;
 157   uint32_t FileIndexLow;
 158   #endif
 159   friend bool equivalent(file_status A, file_status B);
 160   file_type Type;
 161   perms Perms;
 162
 163 public:
 164   #if defined(LLVM_ON_UNIX)
 165   file_status()
 166       : fs_st_dev(0), fs_st_ino(0), fs_st_atime(0), fs_st_mtime(0),
 167         fs_st_uid(0), fs_st_gid(0), fs_st_size(0),
 168         Type(file_type::status_error), Perms(perms_not_known) {}
 169
 170   file_status(file_type Type)
 171       : fs_st_dev(0), fs_st_ino(0), fs_st_atime(0), fs_st_mtime(0),
 172         fs_st_uid(0), fs_st_gid(0), fs_st_size(0), Type(Type),
 173         Perms(perms_not_known) {}
 174
 175   file_status(file_type Type, perms Perms, dev_t Dev, ino_t Ino, time_t ATime,
 176               time_t MTime, uid_t UID, gid_t GID, off_t Size)
 177       : fs_st_dev(Dev), fs_st_ino(Ino), fs_st_atime(ATime), fs_st_mtime(MTime),
 178         fs_st_uid(UID), fs_st_gid(GID), fs_st_size(Size), Type(Type),
 179         Perms(Perms) {}
 180   #elif defined(LLVM_ON_WIN32)
 181   file_status()
 182       : LastAccessedTimeHigh(0), LastAccessedTimeLow(0), LastWriteTimeHigh(0),
 183         LastWriteTimeLow(0), VolumeSerialNumber(0), FileSizeHigh(0),
 184         FileSizeLow(0), FileIndexHigh(0), FileIndexLow(0),
 185         Type(file_type::status_error), Perms(perms_not_known) {}
 186
 187   file_status(file_type Type)
 188       : LastAccessedTimeHigh(0), LastAccessedTimeLow(0), LastWriteTimeHigh(0),
 189         LastWriteTimeLow(0), VolumeSerialNumber(0), FileSizeHigh(0),
 190         FileSizeLow(0), FileIndexHigh(0), FileIndexLow(0), Type(Type),
 191         Perms(perms_not_known) {}
 192
 193   file_status(file_type Type, uint32_t LastWriteTimeHigh,
 194               uint32_t LastWriteTimeLow, uint32_t VolumeSerialNumber,
 195               uint32_t FileSizeHigh, uint32_t FileSizeLow,
 196               uint32_t FileIndexHigh, uint32_t FileIndexLow)
 197       : LastAccessedTimeHigh(0), LastAccessedTimeLow(0),
 198         LastWriteTimeHigh(LastWriteTimeHigh),
 199         LastWriteTimeLow(LastWriteTimeLow),
 200         VolumeSerialNumber(VolumeSerialNumber), FileSizeHigh(FileSizeHigh),
 201         FileSizeLow(FileSizeLow), FileIndexHigh(FileIndexHigh),
 202         FileIndexLow(FileIndexLow), Type(Type), Perms(perms_not_known) {}
 203   #endif
 204
 205   // getters
 206   file_type type() const { return Type; }
 207   perms permissions() const { return Perms; }
 208   TimeValue getLastAccessedTime() const;
 209   TimeValue getLastModificationTime() const;
 210   UniqueID getUniqueID() const;
 211
 212   #if defined(LLVM_ON_UNIX)
 213   uint32_t getUser() const { return fs_st_uid; }
 214   uint32_t getGroup() const { return fs_st_gid; }
 215   uint64_t getSize() const { return fs_st_size; }
 216   #elif defined (LLVM_ON_WIN32)
 217   uint32_t getUser() const {
 218     return 9999; // Not applicable to Windows, so...
 219   }
 220   uint32_t getGroup() const {
 221     return 9999; // Not applicable to Windows, so...
 222   }
 223   uint64_t getSize() const {
 224     return (uint64_t(FileSizeHigh) << 32) + FileSizeLow;
 225   }
 226   #endif
 227
 228   // setters
 229   void type(file_type v) { Type = v; }
 230   void permissions(perms p) { Perms = p; }
 231 };
 232
 233 /// file_magic - An "enum class" enumeration of file types based on magic (the first
 234 ///         N bytes of the file).
 235 struct file_magic {
 236   enum Impl {
 237     unknown = 0,              ///< Unrecognized file
 238     bitcode,                  ///< Bitcode file
 239     archive,                  ///< ar style archive file
 240     elf,                      ///< ELF Unknown type
 241     elf_relocatable,          ///< ELF Relocatable object file
 242     elf_executable,           ///< ELF Executable image
 243     elf_shared_object,        ///< ELF dynamically linked shared lib
 244     elf_core,                 ///< ELF core image
 245     macho_object,             ///< Mach-O Object file
 246     macho_executable,         ///< Mach-O Executable
 247     macho_fixed_virtual_memory_shared_lib, ///< Mach-O Shared Lib, FVM
 248     macho_core,               ///< Mach-O Core File
 249     macho_preload_executable, ///< Mach-O Preloaded Executable
 250     macho_dynamically_linked_shared_lib, ///< Mach-O dynlinked shared lib
 251     macho_dynamic_linker,     ///< The Mach-O dynamic linker
 252     macho_bundle,             ///< Mach-O Bundle file
 253     macho_dynamically_linked_shared_lib_stub, ///< Mach-O Shared lib stub
 254     macho_dsym_companion,     ///< Mach-O dSYM companion file
 255     macho_kext_bundle,        ///< Mach-O kext bundle file
 256     macho_universal_binary,   ///< Mach-O universal binary
 257     coff_object,              ///< COFF object file
 258     coff_import_library,      ///< COFF import library
 259     pecoff_executable,        ///< PECOFF executable file
 260     windows_resource          ///< Windows compiled resource file (.rc)
 261   };
 262
 263   bool is_object() const {
 264     return V == unknown ? false : true;
 265   }
 266
 267   file_magic() : V(unknown) {}
 268   file_magic(Impl V) : V(V) {}
 269   operator Impl() const { return V; }
 270
 271 private:
 272   Impl V;
 273 };
 274
 275 /// @}
 276 /// @name Physical Operators
 277 /// @{
 278
 279 /// @brief Make \a path an absolute path.
 280 ///
 281 /// Makes \a path absolute using the \a current_directory if it is not already.
 282 /// An empty \a path will result in the \a current_directory.
 283 ///
 284 /// /absolute/path   => /absolute/path
 285 /// relative/../path => <current-directory>/relative/../path
 286 ///
 287 /// @param path A path that is modified to be an absolute path.
 288 /// @returns errc::success if \a path has been made absolute, otherwise a
 289 ///          platform-specific error_code.
 290 std::error_code make_absolute(const Twine &current_directory,
 291                               SmallVectorImpl<char> &path);
 292
 293 /// @brief Make \a path an absolute path.
 294 ///
 295 /// Makes \a path absolute using the current directory if it is not already. An
 296 /// empty \a path will result in the current directory.
 297 ///
 298 /// /absolute/path   => /absolute/path
 299 /// relative/../path => <current-directory>/relative/../path
 300 ///
 301 /// @param path A path that is modified to be an absolute path.
 302 /// @returns errc::success if \a path has been made absolute, otherwise a
 303 ///          platform-specific error_code.
 304 std::error_code make_absolute(SmallVectorImpl<char> &path);
 305
 306 /// @brief Create all the non-existent directories in path.
 307 ///
 308 /// @param path Directories to create.
 309 /// @returns errc::success if is_directory(path), otherwise a platform
 310 ///          specific error_code. If IgnoreExisting is false, also returns
 311 ///          error if the directory already existed.
 312 std::error_code create_directories(const Twine &path,
 313                                    bool IgnoreExisting = true,
 314                                    perms Perms = owner_all | group_all);
 315
 316 /// @brief Create the directory in path.
 317 ///
 318 /// @param path Directory to create.
 319 /// @returns errc::success if is_directory(path), otherwise a platform
 320 ///          specific error_code. If IgnoreExisting is false, also returns
 321 ///          error if the directory already existed.
 322 std::error_code create_directory(const Twine &path, bool IgnoreExisting = true,
 323                                  perms Perms = owner_all | group_all);
 324
 325 /// @brief Create a link from \a from to \a to.
 326 ///
 327 /// The link may be a soft or a hard link, depending on the platform. The caller
 328 /// may not assume which one. Currently on windows it creates a hard link since
 329 /// soft links require extra privileges. On unix, it creates a soft link since
 330 /// hard links don't work on SMB file systems.
 331 ///
 332 /// @param to The path to hard link to.
 333 /// @param from The path to hard link from. This is created.
 334 /// @returns errc::success if the link was created, otherwise a platform
 335 /// specific error_code.
 336 std::error_code create_link(const Twine &to, const Twine &from);
 337
 338 /// @brief Get the current path.
 339 ///
 340 /// @param result Holds the current path on return.
 341 /// @returns errc::success if the current path has been stored in result,
 342 ///          otherwise a platform-specific error_code.
 343 std::error_code current_path(SmallVectorImpl<char> &result);
 344
 345 /// @brief Remove path. Equivalent to POSIX remove().
 346 ///
 347 /// @param path Input path.
 348 /// @returns errc::success if path has been removed or didn't exist, otherwise a
 349 ///          platform-specific error code. If IgnoreNonExisting is false, also
 350 ///          returns error if the file didn't exist.
 351 std::error_code remove(const Twine &path, bool IgnoreNonExisting = true);
 352
 353 /// @brief Rename \a from to \a to. Files are renamed as if by POSIX rename().
 354 ///
 355 /// @param from The path to rename from.
 356 /// @param to The path to rename to. This is created.
 357 std::error_code rename(const Twine &from, const Twine &to);
 358
 359 /// @brief Copy the contents of \a From to \a To.
 360 ///
 361 /// @param From The path to copy from.
 362 /// @param To The path to copy to. This is created.
 363 std::error_code copy_file(const Twine &From, const Twine &To);
 364
 365 /// @brief Resize path to size. File is resized as if by POSIX truncate().
 366 ///
 367 /// @param FD Input file descriptor.
 368 /// @param Size Size to resize to.
 369 /// @returns errc::success if \a path has been resized to \a size, otherwise a
 370 ///          platform-specific error_code.
 371 std::error_code resize_file(int FD, uint64_t Size);
 372
 373 /// @}
 374 /// @name Physical Observers
 375 /// @{
 376
 377 /// @brief Does file exist?
 378 ///
 379 /// @param status A file_status previously returned from stat.
 380 /// @returns True if the file represented by status exists, false if it does
 381 ///          not.
 382 bool exists(file_status status);
 383
 384 enum class AccessMode { Exist, Write, Execute };
 385
 386 /// @brief Can the file be accessed?
 387 ///
 388 /// @param Path Input path.
 389 /// @returns errc::success if the path can be accessed, otherwise a
 390 ///          platform-specific error_code.
 391 std::error_code access(const Twine &Path, AccessMode Mode);
 392
 393 /// @brief Does file exist?
 394 ///
 395 /// @param Path Input path.
 396 /// @returns True if it exists, false otherwise.
 397 inline bool exists(const Twine &Path) {
 398   return !access(Path, AccessMode::Exist);
 399 }
 400
 401 /// @brief Can we execute this file?
 402 ///
 403 /// @param Path Input path.
 404 /// @returns True if we can execute it, false otherwise.
 405 bool can_execute(const Twine &Path);
 406
 407 /// @brief Can we write this file?
 408 ///
 409 /// @param Path Input path.
 410 /// @returns True if we can write to it, false otherwise.
 411 inline bool can_write(const Twine &Path) {
 412   return !access(Path, AccessMode::Write);
 413 }
 414
 415 /// @brief Do file_status's represent the same thing?
 416 ///
 417 /// @param A Input file_status.
 418 /// @param B Input file_status.
 419 ///
 420 /// assert(status_known(A) || status_known(B));
 421 ///
 422 /// @returns True if A and B both represent the same file system entity, false
 423 ///          otherwise.
 424 bool equivalent(file_status A, file_status B);
 425
 426 /// @brief Do paths represent the same thing?
 427 ///
 428 /// assert(status_known(A) || status_known(B));
 429 ///
 430 /// @param A Input path A.
 431 /// @param B Input path B.
 432 /// @param result Set to true if stat(A) and stat(B) have the same device and
 433 ///               inode (or equivalent).
 434 /// @returns errc::success if result has been successfully set, otherwise a
 435 ///          platform-specific error_code.
 436 std::error_code equivalent(const Twine &A, const Twine &B, bool &result);
 437
 438 /// @brief Simpler version of equivalent for clients that don't need to
 439 ///        differentiate between an error and false.
 440 inline bool equivalent(const Twine &A, const Twine &B) {
 441   bool result;
 442   return !equivalent(A, B, result) && result;
 443 }
 444
 445 /// @brief Does status represent a directory?
 446 ///
 447 /// @param status A file_status previously returned from status.
 448 /// @returns status.type() == file_type::directory_file.
 449 bool is_directory(file_status status);
 450
 451 /// @brief Is path a directory?
 452 ///
 453 /// @param path Input path.
 454 /// @param result Set to true if \a path is a directory, false if it is not.
 455 ///               Undefined otherwise.
 456 /// @returns errc::success if result has been successfully set, otherwise a
 457 ///          platform-specific error_code.
 458 std::error_code is_directory(const Twine &path, bool &result);
 459
 460 /// @brief Simpler version of is_directory for clients that don't need to
 461 ///        differentiate between an error and false.
 462 inline bool is_directory(const Twine &Path) {
 463   bool Result;
 464   return !is_directory(Path, Result) && Result;
 465 }
 466
 467 /// @brief Does status represent a regular file?
 468 ///
 469 /// @param status A file_status previously returned from status.
 470 /// @returns status_known(status) && status.type() == file_type::regular_file.
 471 bool is_regular_file(file_status status);
 472
 473 /// @brief Is path a regular file?
 474 ///
 475 /// @param path Input path.
 476 /// @param result Set to true if \a path is a regular file, false if it is not.
 477 ///               Undefined otherwise.
 478 /// @returns errc::success if result has been successfully set, otherwise a
 479 ///          platform-specific error_code.
 480 std::error_code is_regular_file(const Twine &path, bool &result);
 481
 482 /// @brief Simpler version of is_regular_file for clients that don't need to
 483 ///        differentiate between an error and false.
 484 inline bool is_regular_file(const Twine &Path) {
 485   bool Result;
 486   if (is_regular_file(Path, Result))
 487     return false;
 488   return Result;
 489 }
 490
 491 /// @brief Does this status represent something that exists but is not a
 492 ///        directory, regular file, or symlink?
 493 ///
 494 /// @param status A file_status previously returned from status.
 495 /// @returns exists(s) && !is_regular_file(s) && !is_directory(s)
 496 bool is_other(file_status status);
 497
 498 /// @brief Is path something that exists but is not a directory,
 499 ///        regular file, or symlink?
 500 ///
 501 /// @param path Input path.
 502 /// @param result Set to true if \a path exists, but is not a directory, regular
 503 ///               file, or a symlink, false if it does not. Undefined otherwise.
 504 /// @returns errc::success if result has been successfully set, otherwise a
 505 ///          platform-specific error_code.
 506 std::error_code is_other(const Twine &path, bool &result);
 507
 508 /// @brief Get file status as if by POSIX stat().
 509 ///
 510 /// @param path Input path.
 511 /// @param result Set to the file status.
 512 /// @returns errc::success if result has been successfully set, otherwise a
 513 ///          platform-specific error_code.
 514 std::error_code status(const Twine &path, file_status &result);
 515
 516 /// @brief A version for when a file descriptor is already available.
 517 std::error_code status(int FD, file_status &Result);
 518
 519 /// @brief Get file size.
 520 ///
 521 /// @param Path Input path.
 522 /// @param Result Set to the size of the file in \a Path.
 523 /// @returns errc::success if result has been successfully set, otherwise a
 524 ///          platform-specific error_code.
 525 inline std::error_code file_size(const Twine &Path, uint64_t &Result) {
 526   file_status Status;
 527   std::error_code EC = status(Path, Status);
 528   if (EC)
 529     return EC;
 530   Result = Status.getSize();
 531   return std::error_code();
 532 }
 533
 534 /// @brief Set the file modification and access time.
 535 ///
 536 /// @returns errc::success if the file times were successfully set, otherwise a
 537 ///          platform-specific error_code or errc::function_not_supported on
 538 ///          platforms where the functionality isn't available.
 539 std::error_code setLastModificationAndAccessTime(int FD, TimeValue Time);
 540
 541 /// @brief Is status available?
 542 ///
 543 /// @param s Input file status.
 544 /// @returns True if status() != status_error.
 545 bool status_known(file_status s);
 546
 547 /// @brief Is status available?
 548 ///
 549 /// @param path Input path.
 550 /// @param result Set to true if status() != status_error.
 551 /// @returns errc::success if result has been successfully set, otherwise a
 552 ///          platform-specific error_code.
 553 std::error_code status_known(const Twine &path, bool &result);
 554
 555 /// @brief Create a uniquely named file.
 556 ///
 557 /// Generates a unique path suitable for a temporary file and then opens it as a
 558 /// file. The name is based on \a model with '%' replaced by a random char in
 559 /// [0-9a-f]. If \a model is not an absolute path, the temporary file will be
 560 /// created in the current directory.
 561 ///
 562 /// Example: clang-%%-%%-%%-%%-%%.s => clang-a0-b1-c2-d3-e4.s
 563 ///
 564 /// This is an atomic operation. Either the file is created and opened, or the
 565 /// file system is left untouched.
 566 ///
 567 /// The intended use is for files that are to be kept, possibly after
 568 /// renaming them. For example, when running 'clang -c foo.o', the file can
 569 /// be first created as foo-abc123.o and then renamed.
 570 ///
 571 /// @param Model Name to base unique path off of.
 572 /// @param ResultFD Set to the opened file's file descriptor.
 573 /// @param ResultPath Set to the opened file's absolute path.
 574 /// @returns errc::success if Result{FD,Path} have been successfully set,
 575 ///          otherwise a platform-specific error_code.
 576 std::error_code createUniqueFile(const Twine &Model, int &ResultFD,
 577                                  SmallVectorImpl<char> &ResultPath,
 578                                  unsigned Mode = all_read | all_write);
 579
 580 /// @brief Simpler version for clients that don't want an open file.
 581 std::error_code createUniqueFile(const Twine &Model,
 582                                  SmallVectorImpl<char> &ResultPath);
 583
 584 /// @brief Create a file in the system temporary directory.
 585 ///
 586 /// The filename is of the form prefix-random_chars.suffix. Since the directory
 587 /// is not know to the caller, Prefix and Suffix cannot have path separators.
 588 /// The files are created with mode 0600.
 589 ///
 590 /// This should be used for things like a temporary .s that is removed after
 591 /// running the assembler.
 592 std::error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
 593                                     int &ResultFD,
 594                                     SmallVectorImpl<char> &ResultPath);
 595
 596 /// @brief Simpler version for clients that don't want an open file.
 597 std::error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
 598                                     SmallVectorImpl<char> &ResultPath);
 599
 600 std::error_code createUniqueDirectory(const Twine &Prefix,
 601                                       SmallVectorImpl<char> &ResultPath);
 602
 603 enum OpenFlags : unsigned {
 604   F_None = 0,
 605
 606   /// F_Excl - When opening a file, this flag makes raw_fd_ostream
 607   /// report an error if the file already exists.
 608   F_Excl = 1,
 609
 610   /// F_Append - When opening a file, if it already exists append to the
 611   /// existing file instead of returning an error.  This may not be specified
 612   /// with F_Excl.
 613   F_Append = 2,
 614
 615   /// The file should be opened in text mode on platforms that make this
 616   /// distinction.
 617   F_Text = 4,
 618
 619   /// Open the file for read and write.
 620   F_RW = 8
 621 };
 622
 623 inline OpenFlags operator|(OpenFlags A, OpenFlags B) {
 624   return OpenFlags(unsigned(A) | unsigned(B));
 625 }
 626
 627 inline OpenFlags &operator|=(OpenFlags &A, OpenFlags B) {
 628   A = A | B;
 629   return A;
 630 }
 631
 632 std::error_code openFileForWrite(const Twine &Name, int &ResultFD,
 633                                  OpenFlags Flags, unsigned Mode = 0666);
 634
 635 std::error_code openFileForRead(const Twine &Name, int &ResultFD);
 636
 637 /// @brief Identify the type of a binary file based on how magical it is.
 638 file_magic identify_magic(StringRef magic);
 639
 640 /// @brief Get and identify \a path's type based on its content.
 641 ///
 642 /// @param path Input path.
 643 /// @param result Set to the type of file, or file_magic::unknown.
 644 /// @returns errc::success if result has been successfully set, otherwise a
 645 ///          platform-specific error_code.
 646 std::error_code identify_magic(const Twine &path, file_magic &result);
 647
 648 std::error_code getUniqueID(const Twine Path, UniqueID &Result);
 649
 650 /// This class represents a memory mapped file. It is based on
 651 /// boost::iostreams::mapped_file.
 652 class mapped_file_region {
 653   mapped_file_region() = delete;
 654   mapped_file_region(mapped_file_region&) = delete;
 655   mapped_file_region &operator =(mapped_file_region&) = delete;
 656
 657 public:
 658   enum mapmode {
 659     readonly, ///< May only access map via const_data as read only.
 660     readwrite, ///< May access map via data and modify it. Written to path.
 661     priv ///< May modify via data, but changes are lost on destruction.
 662   };
 663
 664 private:
 665   /// Platform-specific mapping state.
 666   uint64_t Size;
 667   void *Mapping;
 668
 669   std::error_code init(int FD, uint64_t Offset, mapmode Mode);
 670
 671 public:
 672   /// \param fd An open file descriptor to map. mapped_file_region takes
 673   ///   ownership if closefd is true. It must have been opended in the correct
 674   ///   mode.
 675   mapped_file_region(int fd, mapmode mode, uint64_t length, uint64_t offset,
 676                      std::error_code &ec);
 677
 678   ~mapped_file_region();
 679
 680   uint64_t size() const;
 681   char *data() const;
 682
 683   /// Get a const view of the data. Modifying this memory has undefined
 684   /// behavior.
 685   const char *const_data() const;
 686
 687   /// \returns The minimum alignment offset must be.
 688   static int alignment();
 689 };
 690
 691 /// Return the path to the main executable, given the value of argv[0] from
 692 /// program startup and the address of main itself. In extremis, this function
 693 /// may fail and return an empty path.
 694 std::string getMainExecutable(const char *argv0, void *MainExecAddr);
 695
 696 /// @}
 697 /// @name Iterators
 698 /// @{
 699
 700 /// directory_entry - A single entry in a directory. Caches the status either
 701 /// from the result of the iteration syscall, or the first time status is
 702 /// called.
 703 class directory_entry {
 704   std::string Path;
 705   mutable file_status Status;
 706
 707 public:
 708   explicit directory_entry(const Twine &path, file_status st = file_status())
 709     : Path(path.str())
 710     , Status(st) {}
 711
 712   directory_entry() {}
 713
 714   void assign(const Twine &path, file_status st = file_status()) {
 715     Path = path.str();
 716     Status = st;
 717   }
 718
 719   void replace_filename(const Twine &filename, file_status st = file_status());
 720
 721   const std::string &path() const { return Path; }
 722   std::error_code status(file_status &result) const;
 723
 724   bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
 725   bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
 726   bool operator< (const directory_entry& rhs) const;
 727   bool operator<=(const directory_entry& rhs) const;
 728   bool operator> (const directory_entry& rhs) const;
 729   bool operator>=(const directory_entry& rhs) const;
 730 };
 731
 732 namespace detail {
 733   struct DirIterState;
 734
 735   std::error_code directory_iterator_construct(DirIterState &, StringRef);
 736   std::error_code directory_iterator_increment(DirIterState &);
 737   std::error_code directory_iterator_destruct(DirIterState &);
 738
 739   /// DirIterState - Keeps state for the directory_iterator. It is reference
 740   /// counted in order to preserve InputIterator semantics on copy.
 741   struct DirIterState : public RefCountedBase<DirIterState> {
 742     DirIterState()
 743       : IterationHandle(0) {}
 744
 745     ~DirIterState() {
 746       directory_iterator_destruct(*this);
 747     }
 748
 749     intptr_t IterationHandle;
 750     directory_entry CurrentEntry;
 751   };
 752 }
 753
 754 /// directory_iterator - Iterates through the entries in path. There is no
 755 /// operator++ because we need an error_code. If it's really needed we can make
 756 /// it call report_fatal_error on error.
 757 class directory_iterator {
 758   IntrusiveRefCntPtr<detail::DirIterState> State;
 759
 760 public:
 761   explicit directory_iterator(const Twine &path, std::error_code &ec) {
 762     State = new detail::DirIterState;
 763     SmallString<128> path_storage;
 764     ec = detail::directory_iterator_construct(*State,
 765             path.toStringRef(path_storage));
 766   }
 767
 768   explicit directory_iterator(const directory_entry &de, std::error_code &ec) {
 769     State = new detail::DirIterState;
 770     ec = detail::directory_iterator_construct(*State, de.path());
 771   }
 772
 773   /// Construct end iterator.
 774   directory_iterator() : State(nullptr) {}
 775
 776   // No operator++ because we need error_code.
 777   directory_iterator &increment(std::error_code &ec) {
 778     ec = directory_iterator_increment(*State);
 779     return *this;
 780   }
 781
 782   const directory_entry &operator*() const { return State->CurrentEntry; }
 783   const directory_entry *operator->() const { return &State->CurrentEntry; }
 784
 785   bool operator==(const directory_iterator &RHS) const {
 786     if (State == RHS.State)
 787       return true;
 788     if (!RHS.State)
 789       return State->CurrentEntry == directory_entry();
 790     if (!State)
 791       return RHS.State->CurrentEntry == directory_entry();
 792     return State->CurrentEntry == RHS.State->CurrentEntry;
 793   }
 794
 795   bool operator!=(const directory_iterator &RHS) const {
 796     return !(*this == RHS);
 797   }
 798   // Other members as required by
 799   // C++ Std, 24.1.1 Input iterators [input.iterators]
 800 };
 801
 802 namespace detail {
 803   /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
 804   /// reference counted in order to preserve InputIterator semantics on copy.
 805   struct RecDirIterState : public RefCountedBase<RecDirIterState> {
 806     RecDirIterState()
 807       : Level(0)
 808       , HasNoPushRequest(false) {}
 809
 810     std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
 811     uint16_t Level;
 812     bool HasNoPushRequest;
 813   };
 814 }
 815
 816 /// recursive_directory_iterator - Same as directory_iterator except for it
 817 /// recurses down into child directories.
 818 class recursive_directory_iterator {
 819   IntrusiveRefCntPtr<detail::RecDirIterState> State;
 820
 821 public:
 822   recursive_directory_iterator() {}
 823   explicit recursive_directory_iterator(const Twine &path, std::error_code &ec)
 824       : State(new detail::RecDirIterState) {
 825     State->Stack.push(directory_iterator(path, ec));
 826     if (State->Stack.top() == directory_iterator())
 827       State.reset();
 828   }
 829   // No operator++ because we need error_code.
 830   recursive_directory_iterator &increment(std::error_code &ec) {
 831     const directory_iterator end_itr;
 832
 833     if (State->HasNoPushRequest)
 834       State->HasNoPushRequest = false;
 835     else {
 836       file_status st;
 837       if ((ec = State->Stack.top()->status(st))) return *this;
 838       if (is_directory(st)) {
 839         State->Stack.push(directory_iterator(*State->Stack.top(), ec));
 840         if (ec) return *this;
 841         if (State->Stack.top() != end_itr) {
 842           ++State->Level;
 843           return *this;
 844         }
 845         State->Stack.pop();
 846       }
 847     }
 848
 849     while (!State->Stack.empty()
 850            && State->Stack.top().increment(ec) == end_itr) {
 851       State->Stack.pop();
 852       --State->Level;
 853     }
 854
 855     // Check if we are done. If so, create an end iterator.
 856     if (State->Stack.empty())
 857       State.reset();
 858
 859     return *this;
 860   }
 861
 862   const directory_entry &operator*() const { return *State->Stack.top(); }
 863   const directory_entry *operator->() const { return &*State->Stack.top(); }
 864
 865   // observers
 866   /// Gets the current level. Starting path is at level 0.
 867   int level() const { return State->Level; }
 868
 869   /// Returns true if no_push has been called for this directory_entry.
 870   bool no_push_request() const { return State->HasNoPushRequest; }
 871
 872   // modifiers
 873   /// Goes up one level if Level > 0.
 874   void pop() {
 875     assert(State && "Cannot pop an end iterator!");
 876     assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
 877
 878     const directory_iterator end_itr;
 879     std::error_code ec;
 880     do {
 881       if (ec)
 882         report_fatal_error("Error incrementing directory iterator.");
 883       State->Stack.pop();
 884       --State->Level;
 885     } while (!State->Stack.empty()
 886              && State->Stack.top().increment(ec) == end_itr);
 887
 888     // Check if we are done. If so, create an end iterator.
 889     if (State->Stack.empty())
 890       State.reset();
 891   }
 892
 893   /// Does not go down into the current directory_entry.
 894   void no_push() { State->HasNoPushRequest = true; }
 895
 896   bool operator==(const recursive_directory_iterator &RHS) const {
 897     return State == RHS.State;
 898   }
 899
 900   bool operator!=(const recursive_directory_iterator &RHS) const {
 901     return !(*this == RHS);
 902   }
 903   // Other members as required by
 904   // C++ Std, 24.1.1 Input iterators [input.iterators]
 905 };
 906
 907 /// @}
 908
 909 } // end namespace fs
 910 } // end namespace sys
 911 } // end namespace llvm
 912
 913 #endif