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