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