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