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