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