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