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