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