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