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