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 /// @returns errc::success if is_directory(path), otherwise a platform
 277 ///          specific error_code. If IgnoreExisting is false, also returns
 278 ///          error if the directory already existed.
 279 error_code create_directories(const Twine &path, bool IgnoreExisting = true);
 280
 281 /// @brief Create the directory in path.
 282 ///
 283 /// @param path Directory to create.
 284 /// @returns errc::success if is_directory(path), otherwise a platform
 285 ///          specific error_code. If IgnoreExisting is false, also returns
 286 ///          error if the directory already existed.
 287 error_code create_directory(const Twine &path, bool IgnoreExisting = true);
 288
 289 /// @brief Create a hard link from \a from to \a to.
 290 ///
 291 /// @param to The path to hard link to.
 292 /// @param from The path to hard link from. This is created.
 293 /// @returns errc::success if exists(to) && exists(from) && equivalent(to, from)
 294 ///          , otherwise a platform specific error_code.
 295 error_code create_hard_link(const Twine &to, const Twine &from);
 296
 297 /// @brief Get the current path.
 298 ///
 299 /// @param result Holds the current path on return.
 300 /// @returns errc::success if the current path has been stored in result,
 301 ///          otherwise a platform specific error_code.
 302 error_code current_path(SmallVectorImpl<char> &result);
 303
 304 /// @brief Remove path. Equivalent to POSIX remove().
 305 ///
 306 /// @param path Input path.
 307 /// @returns errc::success if path has been removed or didn't exist, otherwise a
 308 ///          platform specific error code. If IgnoreNonExisting is false, also
 309 ///          returns error if the file didn't exist.
 310 error_code remove(const Twine &path, bool IgnoreNonExisting = true);
 311
 312 /// @brief Rename \a from to \a to. Files are renamed as if by POSIX rename().
 313 ///
 314 /// @param from The path to rename from.
 315 /// @param to The path to rename to. This is created.
 316 error_code rename(const Twine &from, const Twine &to);
 317
 318 /// @brief Resize path to size. File is resized as if by POSIX truncate().
 319 ///
 320 /// @param path Input path.
 321 /// @param size Size to resize to.
 322 /// @returns errc::success if \a path has been resized to \a size, otherwise a
 323 ///          platform specific error_code.
 324 error_code resize_file(const Twine &path, uint64_t size);
 325
 326 /// @}
 327 /// @name Physical Observers
 328 /// @{
 329
 330 /// @brief Does file exist?
 331 ///
 332 /// @param status A file_status previously returned from stat.
 333 /// @returns True if the file represented by status exists, false if it does
 334 ///          not.
 335 bool exists(file_status status);
 336
 337 /// @brief Does file exist?
 338 ///
 339 /// @param path Input path.
 340 /// @param result Set to true if the file represented by status exists, false if
 341 ///               it does not. Undefined otherwise.
 342 /// @returns errc::success if result has been successfully set, otherwise a
 343 ///          platform specific error_code.
 344 error_code exists(const Twine &path, bool &result);
 345
 346 /// @brief Simpler version of exists for clients that don't need to
 347 ///        differentiate between an error and false.
 348 inline bool exists(const Twine &path) {
 349   bool result;
 350   return !exists(path, result) && result;
 351 }
 352
 353 /// @brief Can we execute this file?
 354 ///
 355 /// @param Path Input path.
 356 /// @returns True if we can execute it, false otherwise.
 357 bool can_execute(const Twine &Path);
 358
 359 /// @brief Can we write this file?
 360 ///
 361 /// @param Path Input path.
 362 /// @returns True if we can write to it, false otherwise.
 363 bool can_write(const Twine &Path);
 364
 365 /// @brief Do file_status's represent the same thing?
 366 ///
 367 /// @param A Input file_status.
 368 /// @param B Input file_status.
 369 ///
 370 /// assert(status_known(A) || status_known(B));
 371 ///
 372 /// @returns True if A and B both represent the same file system entity, false
 373 ///          otherwise.
 374 bool equivalent(file_status A, file_status B);
 375
 376 /// @brief Do paths represent the same thing?
 377 ///
 378 /// assert(status_known(A) || status_known(B));
 379 ///
 380 /// @param A Input path A.
 381 /// @param B Input path B.
 382 /// @param result Set to true if stat(A) and stat(B) have the same device and
 383 ///               inode (or equivalent).
 384 /// @returns errc::success if result has been successfully set, otherwise a
 385 ///          platform specific error_code.
 386 error_code equivalent(const Twine &A, const Twine &B, bool &result);
 387
 388 /// @brief Simpler version of equivalent for clients that don't need to
 389 ///        differentiate between an error and false.
 390 inline bool equivalent(const Twine &A, const Twine &B) {
 391   bool result;
 392   return !equivalent(A, B, result) && result;
 393 }
 394
 395 /// @brief Does status represent a directory?
 396 ///
 397 /// @param status A file_status previously returned from status.
 398 /// @returns status.type() == file_type::directory_file.
 399 bool is_directory(file_status status);
 400
 401 /// @brief Is path a directory?
 402 ///
 403 /// @param path Input path.
 404 /// @param result Set to true if \a path is a directory, false if it is not.
 405 ///               Undefined otherwise.
 406 /// @returns errc::success if result has been successfully set, otherwise a
 407 ///          platform specific error_code.
 408 error_code is_directory(const Twine &path, bool &result);
 409
 410 /// @brief Simpler version of is_directory for clients that don't need to
 411 ///        differentiate between an error and false.
 412 inline bool is_directory(const Twine &Path) {
 413   bool Result;
 414   return !is_directory(Path, Result) && Result;
 415 }
 416
 417 /// @brief Does status represent a regular file?
 418 ///
 419 /// @param status A file_status previously returned from status.
 420 /// @returns status_known(status) && status.type() == file_type::regular_file.
 421 bool is_regular_file(file_status status);
 422
 423 /// @brief Is path a regular file?
 424 ///
 425 /// @param path Input path.
 426 /// @param result Set to true if \a path is a regular file, false if it is not.
 427 ///               Undefined otherwise.
 428 /// @returns errc::success if result has been successfully set, otherwise a
 429 ///          platform specific error_code.
 430 error_code is_regular_file(const Twine &path, bool &result);
 431
 432 /// @brief Simpler version of is_regular_file for clients that don't need to
 433 ///        differentiate between an error and false.
 434 inline bool is_regular_file(const Twine &Path) {
 435   bool Result;
 436   if (is_regular_file(Path, Result))
 437     return false;
 438   return Result;
 439 }
 440
 441 /// @brief Does this status represent something that exists but is not a
 442 ///        directory, regular file, or symlink?
 443 ///
 444 /// @param status A file_status previously returned from status.
 445 /// @returns exists(s) && !is_regular_file(s) && !is_directory(s) &&
 446 ///          !is_symlink(s)
 447 bool is_other(file_status status);
 448
 449 /// @brief Is path something that exists but is not a directory,
 450 ///        regular file, or symlink?
 451 ///
 452 /// @param path Input path.
 453 /// @param result Set to true if \a path exists, but is not a directory, regular
 454 ///               file, or a symlink, false if it does not. Undefined otherwise.
 455 /// @returns errc::success if result has been successfully set, otherwise a
 456 ///          platform specific error_code.
 457 error_code is_other(const Twine &path, bool &result);
 458
 459 /// @brief Does status represent a symlink?
 460 ///
 461 /// @param status A file_status previously returned from stat.
 462 /// @returns status.type() == symlink_file.
 463 bool is_symlink(file_status status);
 464
 465 /// @brief Is path a symlink?
 466 ///
 467 /// @param path Input path.
 468 /// @param result Set to true if \a path is a symlink, false if it is not.
 469 ///               Undefined otherwise.
 470 /// @returns errc::success if result has been successfully set, otherwise a
 471 ///          platform specific error_code.
 472 error_code is_symlink(const Twine &path, bool &result);
 473
 474 /// @brief Get file status as if by POSIX stat().
 475 ///
 476 /// @param path Input path.
 477 /// @param result Set to the file status.
 478 /// @returns errc::success if result has been successfully set, otherwise a
 479 ///          platform specific error_code.
 480 error_code status(const Twine &path, file_status &result);
 481
 482 /// @brief A version for when a file descriptor is already available.
 483 error_code status(int FD, file_status &Result);
 484
 485 /// @brief Get file size.
 486 ///
 487 /// @param Path Input path.
 488 /// @param Result Set to the size of the file in \a Path.
 489 /// @returns errc::success if result has been successfully set, otherwise a
 490 ///          platform specific error_code.
 491 inline error_code file_size(const Twine &Path, uint64_t &Result) {
 492   file_status Status;
 493   error_code EC = status(Path, Status);
 494   if (EC)
 495     return EC;
 496   Result = Status.getSize();
 497   return error_code::success();
 498 }
 499
 500 /// @brief Set the file modification and access time.
 501 ///
 502 /// @returns errc::success if the file times were successfully set, otherwise a
 503 ///          platform specific error_code or errc::not_supported on platforms
 504 ///          where the functionality isn't available.
 505 error_code setLastModificationAndAccessTime(int FD, TimeValue Time);
 506
 507 /// @brief Is status available?
 508 ///
 509 /// @param s Input file status.
 510 /// @returns True if status() != status_error.
 511 bool status_known(file_status s);
 512
 513 /// @brief Is status available?
 514 ///
 515 /// @param path Input path.
 516 /// @param result Set to true if status() != status_error.
 517 /// @returns errc::success if result has been successfully set, otherwise a
 518 ///          platform specific error_code.
 519 error_code status_known(const Twine &path, bool &result);
 520
 521 /// @brief Create a uniquely named file.
 522 ///
 523 /// Generates a unique path suitable for a temporary file and then opens it as a
 524 /// file. The name is based on \a model with '%' replaced by a random char in
 525 /// [0-9a-f]. If \a model is not an absolute path, a suitable temporary
 526 /// directory will be prepended.
 527 ///
 528 /// Example: clang-%%-%%-%%-%%-%%.s => clang-a0-b1-c2-d3-e4.s
 529 ///
 530 /// This is an atomic operation. Either the file is created and opened, or the
 531 /// file system is left untouched.
 532 ///
 533 /// The intendend use is for files that are to be kept, possibly after
 534 /// renaming them. For example, when running 'clang -c foo.o', the file can
 535 /// be first created as foo-abc123.o and then renamed.
 536 ///
 537 /// @param Model Name to base unique path off of.
 538 /// @param ResultFD Set to the opened file's file descriptor.
 539 /// @param ResultPath Set to the opened file's absolute path.
 540 /// @returns errc::success if Result{FD,Path} have been successfully set,
 541 ///          otherwise a platform specific error_code.
 542 error_code createUniqueFile(const Twine &Model, int &ResultFD,
 543                             SmallVectorImpl<char> &ResultPath,
 544                             unsigned Mode = all_read | all_write);
 545
 546 /// @brief Simpler version for clients that don't want an open file.
 547 error_code createUniqueFile(const Twine &Model,
 548                             SmallVectorImpl<char> &ResultPath);
 549
 550 /// @brief Create a file in the system temporary directory.
 551 ///
 552 /// The filename is of the form prefix-random_chars.suffix. Since the directory
 553 /// is not know to the caller, Prefix and Suffix cannot have path separators.
 554 /// The files are created with mode 0600.
 555 ///
 556 /// This should be used for things like a temporary .s that is removed after
 557 /// running the assembler.
 558 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
 559                                int &ResultFD,
 560                                SmallVectorImpl<char> &ResultPath);
 561
 562 /// @brief Simpler version for clients that don't want an open file.
 563 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
 564                                SmallVectorImpl<char> &ResultPath);
 565
 566 error_code createUniqueDirectory(const Twine &Prefix,
 567                                  SmallVectorImpl<char> &ResultPath);
 568
 569 enum OpenFlags {
 570   F_None = 0,
 571
 572   /// F_Excl - When opening a file, this flag makes raw_fd_ostream
 573   /// report an error if the file already exists.
 574   F_Excl = 1,
 575
 576   /// F_Append - When opening a file, if it already exists append to the
 577   /// existing file instead of returning an error.  This may not be specified
 578   /// with F_Excl.
 579   F_Append = 2,
 580
 581   /// F_Binary - The file should be opened in binary mode on platforms that
 582   /// make this distinction.
 583   F_Binary = 4,
 584
 585   /// Open the file for read and write.
 586   F_RW = 8
 587 };
 588
 589 inline OpenFlags operator|(OpenFlags A, OpenFlags B) {
 590   return OpenFlags(unsigned(A) | unsigned(B));
 591 }
 592
 593 inline OpenFlags &operator|=(OpenFlags &A, OpenFlags B) {
 594   A = A | B;
 595   return A;
 596 }
 597
 598 error_code openFileForWrite(const Twine &Name, int &ResultFD, OpenFlags Flags,
 599                             unsigned Mode = 0666);
 600
 601 error_code openFileForRead(const Twine &Name, int &ResultFD);
 602
 603 /// @brief Are \a path's first bytes \a magic?
 604 ///
 605 /// @param path Input path.
 606 /// @param magic Byte sequence to compare \a path's first len(magic) bytes to.
 607 /// @returns errc::success if result has been successfully set, otherwise a
 608 ///          platform specific error_code.
 609 error_code has_magic(const Twine &path, const Twine &magic, bool &result);
 610
 611 /// @brief Get \a path's first \a len bytes.
 612 ///
 613 /// @param path Input path.
 614 /// @param len Number of magic bytes to get.
 615 /// @param result Set to the first \a len bytes in the file pointed to by
 616 ///               \a path. Or the entire file if file_size(path) < len, in which
 617 ///               case result.size() returns the size of the file.
 618 /// @returns errc::success if result has been successfully set,
 619 ///          errc::value_too_large if len is larger then the file pointed to by
 620 ///          \a path, otherwise a platform specific error_code.
 621 error_code get_magic(const Twine &path, uint32_t len,
 622                      SmallVectorImpl<char> &result);
 623
 624 /// @brief Identify the type of a binary file based on how magical it is.
 625 file_magic identify_magic(StringRef magic);
 626
 627 /// @brief Get and identify \a path's type based on its content.
 628 ///
 629 /// @param path Input path.
 630 /// @param result Set to the type of file, or file_magic::unknown.
 631 /// @returns errc::success if result has been successfully set, otherwise a
 632 ///          platform specific error_code.
 633 error_code identify_magic(const Twine &path, file_magic &result);
 634
 635 error_code getUniqueID(const Twine Path, UniqueID &Result);
 636
 637 /// This class represents a memory mapped file. It is based on
 638 /// boost::iostreams::mapped_file.
 639 class mapped_file_region {
 640   mapped_file_region() LLVM_DELETED_FUNCTION;
 641   mapped_file_region(mapped_file_region&) LLVM_DELETED_FUNCTION;
 642   mapped_file_region &operator =(mapped_file_region&) LLVM_DELETED_FUNCTION;
 643
 644 public:
 645   enum mapmode {
 646     readonly, ///< May only access map via const_data as read only.
 647     readwrite, ///< May access map via data and modify it. Written to path.
 648     priv ///< May modify via data, but changes are lost on destruction.
 649   };
 650
 651 private:
 652   /// Platform specific mapping state.
 653   mapmode Mode;
 654   uint64_t Size;
 655   void *Mapping;
 656 #ifdef LLVM_ON_WIN32
 657   int FileDescriptor;
 658   void *FileHandle;
 659   void *FileMappingHandle;
 660 #endif
 661
 662   error_code init(int FD, bool CloseFD, uint64_t Offset);
 663
 664 public:
 665   typedef char char_type;
 666
 667 #if LLVM_HAS_RVALUE_REFERENCES
 668   mapped_file_region(mapped_file_region&&);
 669   mapped_file_region &operator =(mapped_file_region&&);
 670 #endif
 671
 672   /// Construct a mapped_file_region at \a path starting at \a offset of length
 673   /// \a length and with access \a mode.
 674   ///
 675   /// \param path Path to the file to map. If it does not exist it will be
 676   ///             created.
 677   /// \param mode How to map the memory.
 678   /// \param length Number of bytes to map in starting at \a offset. If the file
 679   ///               is shorter than this, it will be extended. If \a length is
 680   ///               0, the entire file will be mapped.
 681   /// \param offset Byte offset from the beginning of the file where the map
 682   ///               should begin. Must be a multiple of
 683   ///               mapped_file_region::alignment().
 684   /// \param ec This is set to errc::success if the map was constructed
 685   ///           successfully. Otherwise it is set to a platform dependent error.
 686   mapped_file_region(const Twine &path,
 687                      mapmode mode,
 688                      uint64_t length,
 689                      uint64_t offset,
 690                      error_code &ec);
 691
 692   /// \param fd An open file descriptor to map. mapped_file_region takes
 693   ///   ownership if closefd is true. It must have been opended in the correct
 694   ///   mode.
 695   mapped_file_region(int fd,
 696                      bool closefd,
 697                      mapmode mode,
 698                      uint64_t length,
 699                      uint64_t offset,
 700                      error_code &ec);
 701
 702   ~mapped_file_region();
 703
 704   mapmode flags() const;
 705   uint64_t size() const;
 706   char *data() const;
 707
 708   /// Get a const view of the data. Modifying this memory has undefined
 709   /// behavior.
 710   const char *const_data() const;
 711
 712   /// \returns The minimum alignment offset must be.
 713   static int alignment();
 714 };
 715
 716 /// @brief Memory maps the contents of a file
 717 ///
 718 /// @param path Path to file to map.
 719 /// @param file_offset Byte offset in file where mapping should begin.
 720 /// @param size Byte length of range of the file to map.
 721 /// @param map_writable If true, the file will be mapped in r/w such
 722 ///        that changes to the mapped buffer will be flushed back
 723 ///        to the file.  If false, the file will be mapped read-only
 724 ///        and the buffer will be read-only.
 725 /// @param result Set to the start address of the mapped buffer.
 726 /// @returns errc::success if result has been successfully set, otherwise a
 727 ///          platform specific error_code.
 728 error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
 729                           bool map_writable, void *&result);
 730
 731
 732 /// @brief Memory unmaps the contents of a file
 733 ///
 734 /// @param base Pointer to the start of the buffer.
 735 /// @param size Byte length of the range to unmmap.
 736 /// @returns errc::success if result has been successfully set, otherwise a
 737 ///          platform specific error_code.
 738 error_code unmap_file_pages(void *base, size_t size);
 739
 740 /// Return the path to the main executable, given the value of argv[0] from
 741 /// program startup and the address of main itself. In extremis, this function
 742 /// may fail and return an empty path.
 743 std::string getMainExecutable(const char *argv0, void *MainExecAddr);
 744
 745 /// @}
 746 /// @name Iterators
 747 /// @{
 748
 749 /// directory_entry - A single entry in a directory. Caches the status either
 750 /// from the result of the iteration syscall, or the first time status is
 751 /// called.
 752 class directory_entry {
 753   std::string Path;
 754   mutable file_status Status;
 755
 756 public:
 757   explicit directory_entry(const Twine &path, file_status st = file_status())
 758     : Path(path.str())
 759     , Status(st) {}
 760
 761   directory_entry() {}
 762
 763   void assign(const Twine &path, file_status st = file_status()) {
 764     Path = path.str();
 765     Status = st;
 766   }
 767
 768   void replace_filename(const Twine &filename, file_status st = file_status());
 769
 770   const std::string &path() const { return Path; }
 771   error_code status(file_status &result) const;
 772
 773   bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
 774   bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
 775   bool operator< (const directory_entry& rhs) const;
 776   bool operator<=(const directory_entry& rhs) const;
 777   bool operator> (const directory_entry& rhs) const;
 778   bool operator>=(const directory_entry& rhs) const;
 779 };
 780
 781 namespace detail {
 782   struct DirIterState;
 783
 784   error_code directory_iterator_construct(DirIterState&, StringRef);
 785   error_code directory_iterator_increment(DirIterState&);
 786   error_code directory_iterator_destruct(DirIterState&);
 787
 788   /// DirIterState - Keeps state for the directory_iterator. It is reference
 789   /// counted in order to preserve InputIterator semantics on copy.
 790   struct DirIterState : public RefCountedBase<DirIterState> {
 791     DirIterState()
 792       : IterationHandle(0) {}
 793
 794     ~DirIterState() {
 795       directory_iterator_destruct(*this);
 796     }
 797
 798     intptr_t IterationHandle;
 799     directory_entry CurrentEntry;
 800   };
 801 }
 802
 803 /// directory_iterator - Iterates through the entries in path. There is no
 804 /// operator++ because we need an error_code. If it's really needed we can make
 805 /// it call report_fatal_error on error.
 806 class directory_iterator {
 807   IntrusiveRefCntPtr<detail::DirIterState> State;
 808
 809 public:
 810   explicit directory_iterator(const Twine &path, error_code &ec) {
 811     State = new detail::DirIterState;
 812     SmallString<128> path_storage;
 813     ec = detail::directory_iterator_construct(*State,
 814             path.toStringRef(path_storage));
 815   }
 816
 817   explicit directory_iterator(const directory_entry &de, error_code &ec) {
 818     State = new detail::DirIterState;
 819     ec = detail::directory_iterator_construct(*State, de.path());
 820   }
 821
 822   /// Construct end iterator.
 823   directory_iterator() : State(0) {}
 824
 825   // No operator++ because we need error_code.
 826   directory_iterator &increment(error_code &ec) {
 827     ec = directory_iterator_increment(*State);
 828     return *this;
 829   }
 830
 831   const directory_entry &operator*() const { return State->CurrentEntry; }
 832   const directory_entry *operator->() const { return &State->CurrentEntry; }
 833
 834   bool operator==(const directory_iterator &RHS) const {
 835     if (State == RHS.State)
 836       return true;
 837     if (RHS.State == 0)
 838       return State->CurrentEntry == directory_entry();
 839     if (State == 0)
 840       return RHS.State->CurrentEntry == directory_entry();
 841     return State->CurrentEntry == RHS.State->CurrentEntry;
 842   }
 843
 844   bool operator!=(const directory_iterator &RHS) const {
 845     return !(*this == RHS);
 846   }
 847   // Other members as required by
 848   // C++ Std, 24.1.1 Input iterators [input.iterators]
 849 };
 850
 851 namespace detail {
 852   /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
 853   /// reference counted in order to preserve InputIterator semantics on copy.
 854   struct RecDirIterState : public RefCountedBase<RecDirIterState> {
 855     RecDirIterState()
 856       : Level(0)
 857       , HasNoPushRequest(false) {}
 858
 859     std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
 860     uint16_t Level;
 861     bool HasNoPushRequest;
 862   };
 863 }
 864
 865 /// recursive_directory_iterator - Same as directory_iterator except for it
 866 /// recurses down into child directories.
 867 class recursive_directory_iterator {
 868   IntrusiveRefCntPtr<detail::RecDirIterState> State;
 869
 870 public:
 871   recursive_directory_iterator() {}
 872   explicit recursive_directory_iterator(const Twine &path, error_code &ec)
 873     : State(new detail::RecDirIterState) {
 874     State->Stack.push(directory_iterator(path, ec));
 875     if (State->Stack.top() == directory_iterator())
 876       State.reset();
 877   }
 878   // No operator++ because we need error_code.
 879   recursive_directory_iterator &increment(error_code &ec) {
 880     const directory_iterator end_itr;
 881
 882     if (State->HasNoPushRequest)
 883       State->HasNoPushRequest = false;
 884     else {
 885       file_status st;
 886       if ((ec = State->Stack.top()->status(st))) return *this;
 887       if (is_directory(st)) {
 888         State->Stack.push(directory_iterator(*State->Stack.top(), ec));
 889         if (ec) return *this;
 890         if (State->Stack.top() != end_itr) {
 891           ++State->Level;
 892           return *this;
 893         }
 894         State->Stack.pop();
 895       }
 896     }
 897
 898     while (!State->Stack.empty()
 899            && State->Stack.top().increment(ec) == end_itr) {
 900       State->Stack.pop();
 901       --State->Level;
 902     }
 903
 904     // Check if we are done. If so, create an end iterator.
 905     if (State->Stack.empty())
 906       State.reset();
 907
 908     return *this;
 909   }
 910
 911   const directory_entry &operator*() const { return *State->Stack.top(); }
 912   const directory_entry *operator->() const { return &*State->Stack.top(); }
 913
 914   // observers
 915   /// Gets the current level. Starting path is at level 0.
 916   int level() const { return State->Level; }
 917
 918   /// Returns true if no_push has been called for this directory_entry.
 919   bool no_push_request() const { return State->HasNoPushRequest; }
 920
 921   // modifiers
 922   /// Goes up one level if Level > 0.
 923   void pop() {
 924     assert(State && "Cannot pop an end iterator!");
 925     assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
 926
 927     const directory_iterator end_itr;
 928     error_code ec;
 929     do {
 930       if (ec)
 931         report_fatal_error("Error incrementing directory iterator.");
 932       State->Stack.pop();
 933       --State->Level;
 934     } while (!State->Stack.empty()
 935              && State->Stack.top().increment(ec) == end_itr);
 936
 937     // Check if we are done. If so, create an end iterator.
 938     if (State->Stack.empty())
 939       State.reset();
 940   }
 941
 942   /// Does not go down into the current directory_entry.
 943   void no_push() { State->HasNoPushRequest = true; }
 944
 945   bool operator==(const recursive_directory_iterator &RHS) const {
 946     return State == RHS.State;
 947   }
 948
 949   bool operator!=(const recursive_directory_iterator &RHS) const {
 950     return !(*this == RHS);
 951   }
 952   // Other members as required by
 953   // C++ Std, 24.1.1 Input iterators [input.iterators]
 954 };
 955
 956 /// @}
 957
 958 } // end namespace fs
 959 } // end namespace sys
 960 } // end namespace llvm
 961
 962 #endif