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