include/llvm/Support/FileSystem.h

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