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