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