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