1 //===- llvm/Support/FileSystem.h - File System OS Concept -------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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
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
25 //===----------------------------------------------------------------------===//
27 #ifndef LLVM_SUPPORT_FILESYSTEM_H
28 #define LLVM_SUPPORT_FILESYSTEM_H
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"
44 #ifdef HAVE_SYS_STAT_H
52 /// file_type - An "enum class" enumeration for the file system's view of the
68 file_type(_ v) : v_(v) {}
69 explicit file_type(int v) : v_(_(v)) {}
70 operator int() const {return v_;}
76 /// space_info - Self explanatory.
88 owner_all = owner_read | owner_write | owner_exe,
92 group_all = group_read | group_write | group_exe,
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,
104 perms_not_known = 0xFFFF
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));
112 inline perms operator&(perms l , perms r) {
113 return static_cast<perms>(
114 static_cast<unsigned short>(l) & static_cast<unsigned short>(r));
116 inline perms &operator|=(perms &l, perms r) {
120 inline perms &operator&=(perms &l, perms r) {
124 inline perms operator~(perms x) {
125 return static_cast<perms>(~static_cast<unsigned short>(x));
134 UniqueID(uint64_t A, uint64_t B) : A(A), B(B) {}
135 bool operator==(const UniqueID &Other) const {
136 return A == Other.A && B == Other.B;
138 bool operator!=(const UniqueID &Other) const { return !(*this == Other); }
141 /// file_status - Represents the result of a call to stat and friends. It has
142 /// a platform specific member to store the result.
145 #if defined(LLVM_ON_UNIX)
152 #elif defined (LLVM_ON_WIN32)
153 uint32_t LastWriteTimeHigh;
154 uint32_t LastWriteTimeLow;
155 uint32_t VolumeSerialNumber;
156 uint32_t FileSizeHigh;
157 uint32_t FileSizeLow;
158 uint32_t FileIndexHigh;
159 uint32_t FileIndexLow;
161 friend bool equivalent(file_status A, file_status B);
165 file_status() : Type(file_type::status_error) {}
166 file_status(file_type Type) : Type(Type) {}
168 #if defined(LLVM_ON_UNIX)
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(file_type Type, uint32_t LastWriteTimeHigh,
175 uint32_t LastWriteTimeLow, uint32_t VolumeSerialNumber,
176 uint32_t FileSizeHigh, uint32_t FileSizeLow,
177 uint32_t FileIndexHigh, uint32_t FileIndexLow)
178 : LastWriteTimeHigh(LastWriteTimeHigh),
179 LastWriteTimeLow(LastWriteTimeLow),
180 VolumeSerialNumber(VolumeSerialNumber), FileSizeHigh(FileSizeHigh),
181 FileSizeLow(FileSizeLow), FileIndexHigh(FileIndexHigh),
182 FileIndexLow(FileIndexLow), Type(Type), Perms(perms_not_known) {}
186 file_type type() const { return Type; }
187 perms permissions() const { return Perms; }
188 TimeValue getLastModificationTime() const;
189 UniqueID getUniqueID() const;
191 #if defined(LLVM_ON_UNIX)
192 uint32_t getUser() const { return fs_st_uid; }
193 uint32_t getGroup() const { return fs_st_gid; }
194 uint64_t getSize() const { return fs_st_size; }
195 #elif defined (LLVM_ON_WIN32)
196 uint32_t getUser() const {
197 return 9999; // Not applicable to Windows, so...
199 uint32_t getGroup() const {
200 return 9999; // Not applicable to Windows, so...
202 uint64_t getSize() const {
203 return (uint64_t(FileSizeHigh) << 32) + FileSizeLow;
208 void type(file_type v) { Type = v; }
209 void permissions(perms p) { Perms = p; }
212 /// file_magic - An "enum class" enumeration of file types based on magic (the first
213 /// N bytes of the file).
216 unknown = 0, ///< Unrecognized file
217 bitcode, ///< Bitcode file
218 archive, ///< ar style archive file
219 elf_relocatable, ///< ELF Relocatable object file
220 elf_executable, ///< ELF Executable image
221 elf_shared_object, ///< ELF dynamically linked shared lib
222 elf_core, ///< ELF core image
223 macho_object, ///< Mach-O Object file
224 macho_executable, ///< Mach-O Executable
225 macho_fixed_virtual_memory_shared_lib, ///< Mach-O Shared Lib, FVM
226 macho_core, ///< Mach-O Core File
227 macho_preload_executable, ///< Mach-O Preloaded Executable
228 macho_dynamically_linked_shared_lib, ///< Mach-O dynlinked shared lib
229 macho_dynamic_linker, ///< The Mach-O dynamic linker
230 macho_bundle, ///< Mach-O Bundle file
231 macho_dynamically_linked_shared_lib_stub, ///< Mach-O Shared lib stub
232 macho_dsym_companion, ///< Mach-O dSYM companion file
233 macho_universal_binary, ///< Mach-O universal binary
234 coff_object, ///< COFF object file
235 pecoff_executable ///< PECOFF executable file
238 bool is_object() const {
239 return V == unknown ? false : true;
242 file_magic() : V(unknown) {}
243 file_magic(Impl V) : V(V) {}
244 operator Impl() const { return V; }
251 /// @name Physical Operators
254 /// @brief Make \a path an absolute path.
256 /// Makes \a path absolute using the current directory if it is not already. An
257 /// empty \a path will result in the current directory.
259 /// /absolute/path => /absolute/path
260 /// relative/../path => <current-directory>/relative/../path
262 /// @param path A path that is modified to be an absolute path.
263 /// @returns errc::success if \a path has been made absolute, otherwise a
264 /// platform specific error_code.
265 error_code make_absolute(SmallVectorImpl<char> &path);
267 /// @brief Create all the non-existent directories in path.
269 /// @param path Directories to create.
270 /// @param existed Set to true if \a path already existed, false otherwise.
271 /// @returns errc::success if is_directory(path) and existed have been set,
272 /// otherwise a platform specific error_code.
273 error_code create_directories(const Twine &path, bool &existed);
275 /// @brief Convenience function for clients that don't need to know if the
276 /// directory existed or not.
277 inline error_code create_directories(const Twine &Path) {
279 return create_directories(Path, Existed);
282 /// @brief Create the directory in path.
284 /// @param path Directory to create.
285 /// @param existed Set to true if \a path already existed, false otherwise.
286 /// @returns errc::success if is_directory(path) and existed have been set,
287 /// otherwise a platform specific error_code.
288 error_code create_directory(const Twine &path, bool &existed);
290 /// @brief Convenience function for clients that don't need to know if the
291 /// directory existed or not.
292 inline error_code create_directory(const Twine &Path) {
294 return create_directory(Path, Existed);
297 /// @brief Create a hard link from \a from to \a to.
299 /// @param to The path to hard link to.
300 /// @param from The path to hard link from. This is created.
301 /// @returns errc::success if exists(to) && exists(from) && equivalent(to, from)
302 /// , otherwise a platform specific error_code.
303 error_code create_hard_link(const Twine &to, const Twine &from);
305 /// @brief Create a symbolic link from \a from to \a to.
307 /// @param to The path to symbolically link to.
308 /// @param from The path to symbolically link from. This is created.
309 /// @returns errc::success if exists(to) && exists(from) && is_symlink(from),
310 /// otherwise a platform specific error_code.
311 error_code create_symlink(const Twine &to, const Twine &from);
313 /// @brief Get the current path.
315 /// @param result Holds the current path on return.
316 /// @returns errc::success if the current path has been stored in result,
317 /// otherwise a platform specific error_code.
318 error_code current_path(SmallVectorImpl<char> &result);
320 /// @brief Remove path. Equivalent to POSIX remove().
322 /// @param path Input path.
323 /// @param existed Set to true if \a path existed, false if it did not.
324 /// undefined otherwise.
325 /// @returns errc::success if path has been removed and existed has been
326 /// successfully set, otherwise a platform specific error_code.
327 error_code remove(const Twine &path, bool &existed);
329 /// @brief Convenience function for clients that don't need to know if the file
331 inline error_code remove(const Twine &Path) {
333 return remove(Path, Existed);
336 /// @brief Recursively remove all files below \a path, then \a path. Files are
337 /// removed as if by POSIX remove().
339 /// @param path Input path.
340 /// @param num_removed Number of files removed.
341 /// @returns errc::success if path has been removed and num_removed has been
342 /// successfully set, otherwise a platform specific error_code.
343 error_code remove_all(const Twine &path, uint32_t &num_removed);
345 /// @brief Convenience function for clients that don't need to know how many
346 /// files were removed.
347 inline error_code remove_all(const Twine &Path) {
349 return remove_all(Path, Removed);
352 /// @brief Rename \a from to \a to. Files are renamed as if by POSIX rename().
354 /// @param from The path to rename from.
355 /// @param to The path to rename to. This is created.
356 error_code rename(const Twine &from, const Twine &to);
358 /// @brief Resize path to size. File is resized as if by POSIX truncate().
360 /// @param path Input path.
361 /// @param size Size to resize to.
362 /// @returns errc::success if \a path has been resized to \a size, otherwise a
363 /// platform specific error_code.
364 error_code resize_file(const Twine &path, uint64_t size);
367 /// @name Physical Observers
370 /// @brief Does file exist?
372 /// @param status A file_status previously returned from stat.
373 /// @returns True if the file represented by status exists, false if it does
375 bool exists(file_status status);
377 /// @brief Does file exist?
379 /// @param path Input path.
380 /// @param result Set to true if the file represented by status exists, false if
381 /// it does not. Undefined otherwise.
382 /// @returns errc::success if result has been successfully set, otherwise a
383 /// platform specific error_code.
384 error_code exists(const Twine &path, bool &result);
386 /// @brief Simpler version of exists for clients that don't need to
387 /// differentiate between an error and false.
388 inline bool exists(const Twine &path) {
390 return !exists(path, result) && result;
393 /// @brief Can we execute this file?
395 /// @param Path Input path.
396 /// @returns True if we can execute it, false otherwise.
397 bool can_execute(const Twine &Path);
399 /// @brief Can we write this file?
401 /// @param Path Input path.
402 /// @returns True if we can write to it, false otherwise.
403 bool can_write(const Twine &Path);
405 /// @brief Do file_status's represent the same thing?
407 /// @param A Input file_status.
408 /// @param B Input file_status.
410 /// assert(status_known(A) || status_known(B));
412 /// @returns True if A and B both represent the same file system entity, false
414 bool equivalent(file_status A, file_status B);
416 /// @brief Do paths represent the same thing?
418 /// assert(status_known(A) || status_known(B));
420 /// @param A Input path A.
421 /// @param B Input path B.
422 /// @param result Set to true if stat(A) and stat(B) have the same device and
423 /// inode (or equivalent).
424 /// @returns errc::success if result has been successfully set, otherwise a
425 /// platform specific error_code.
426 error_code equivalent(const Twine &A, const Twine &B, bool &result);
428 /// @brief Simpler version of equivalent for clients that don't need to
429 /// differentiate between an error and false.
430 inline bool equivalent(const Twine &A, const Twine &B) {
432 return !equivalent(A, B, result) && result;
435 /// @brief Does status represent a directory?
437 /// @param status A file_status previously returned from status.
438 /// @returns status.type() == file_type::directory_file.
439 bool is_directory(file_status status);
441 /// @brief Is path a directory?
443 /// @param path Input path.
444 /// @param result Set to true if \a path is a directory, false if it is not.
445 /// Undefined otherwise.
446 /// @returns errc::success if result has been successfully set, otherwise a
447 /// platform specific error_code.
448 error_code is_directory(const Twine &path, bool &result);
450 /// @brief Simpler version of is_directory for clients that don't need to
451 /// differentiate between an error and false.
452 inline bool is_directory(const Twine &Path) {
454 return !is_directory(Path, Result) && Result;
457 /// @brief Does status represent a regular file?
459 /// @param status A file_status previously returned from status.
460 /// @returns status_known(status) && status.type() == file_type::regular_file.
461 bool is_regular_file(file_status status);
463 /// @brief Is path a regular file?
465 /// @param path Input path.
466 /// @param result Set to true if \a path is a regular file, false if it is not.
467 /// Undefined otherwise.
468 /// @returns errc::success if result has been successfully set, otherwise a
469 /// platform specific error_code.
470 error_code is_regular_file(const Twine &path, bool &result);
472 /// @brief Simpler version of is_regular_file for clients that don't need to
473 /// differentiate between an error and false.
474 inline bool is_regular_file(const Twine &Path) {
476 if (is_regular_file(Path, Result))
481 /// @brief Does this status represent something that exists but is not a
482 /// directory, regular file, or symlink?
484 /// @param status A file_status previously returned from status.
485 /// @returns exists(s) && !is_regular_file(s) && !is_directory(s) &&
487 bool is_other(file_status status);
489 /// @brief Is path something that exists but is not a directory,
490 /// regular file, or symlink?
492 /// @param path Input path.
493 /// @param result Set to true if \a path exists, but is not a directory, regular
494 /// file, or a symlink, false if it does not. Undefined otherwise.
495 /// @returns errc::success if result has been successfully set, otherwise a
496 /// platform specific error_code.
497 error_code is_other(const Twine &path, bool &result);
499 /// @brief Does status represent a symlink?
501 /// @param status A file_status previously returned from stat.
502 /// @returns status.type() == symlink_file.
503 bool is_symlink(file_status status);
505 /// @brief Is path a symlink?
507 /// @param path Input path.
508 /// @param result Set to true if \a path is a symlink, false if it is not.
509 /// Undefined otherwise.
510 /// @returns errc::success if result has been successfully set, otherwise a
511 /// platform specific error_code.
512 error_code is_symlink(const Twine &path, bool &result);
514 /// @brief Get file status as if by POSIX stat().
516 /// @param path Input path.
517 /// @param result Set to the file status.
518 /// @returns errc::success if result has been successfully set, otherwise a
519 /// platform specific error_code.
520 error_code status(const Twine &path, file_status &result);
522 /// @brief A version for when a file descriptor is already available.
523 error_code status(int FD, file_status &Result);
525 /// @brief Get file size.
527 /// @param Path Input path.
528 /// @param Result Set to the size of the file in \a Path.
529 /// @returns errc::success if result has been successfully set, otherwise a
530 /// platform specific error_code.
531 inline error_code file_size(const Twine &Path, uint64_t &Result) {
533 error_code EC = status(Path, Status);
536 Result = Status.getSize();
537 return error_code::success();
540 error_code setLastModificationAndAccessTime(int FD, TimeValue Time);
542 /// @brief Is status available?
544 /// @param s Input file status.
545 /// @returns True if status() != status_error.
546 bool status_known(file_status s);
548 /// @brief Is status available?
550 /// @param path Input path.
551 /// @param result Set to true if status() != status_error.
552 /// @returns errc::success if result has been successfully set, otherwise a
553 /// platform specific error_code.
554 error_code status_known(const Twine &path, bool &result);
556 /// @brief Create a uniquely named file.
558 /// Generates a unique path suitable for a temporary file and then opens it as a
559 /// file. The name is based on \a model with '%' replaced by a random char in
560 /// [0-9a-f]. If \a model is not an absolute path, a suitable temporary
561 /// directory will be prepended.
563 /// Example: clang-%%-%%-%%-%%-%%.s => clang-a0-b1-c2-d3-e4.s
565 /// This is an atomic operation. Either the file is created and opened, or the
566 /// file system is left untouched.
568 /// The intendend use is for files that are to be kept, possibly after
569 /// renaming them. For example, when running 'clang -c foo.o', the file can
570 /// be first created as foo-abc123.o and then renamed.
572 /// @param Model Name to base unique path off of.
573 /// @param ResultFD Set to the opened file's file descriptor.
574 /// @param ResultPath Set to the opened file's absolute path.
575 /// @returns errc::success if Result{FD,Path} have been successfully set,
576 /// otherwise a platform specific error_code.
577 error_code createUniqueFile(const Twine &Model, int &ResultFD,
578 SmallVectorImpl<char> &ResultPath,
579 unsigned Mode = all_read | all_write);
581 /// @brief Simpler version for clients that don't want an open file.
582 error_code createUniqueFile(const Twine &Model,
583 SmallVectorImpl<char> &ResultPath);
585 /// @brief Create a file in the system temporary directory.
587 /// The filename is of the form prefix-random_chars.suffix. Since the directory
588 /// is not know to the caller, Prefix and Suffix cannot have path separators.
589 /// The files are created with mode 0600.
591 /// This should be used for things like a temporary .s that is removed after
592 /// running the assembler.
593 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
595 SmallVectorImpl<char> &ResultPath);
597 /// @brief Simpler version for clients that don't want an open file.
598 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
599 SmallVectorImpl<char> &ResultPath);
601 error_code createUniqueDirectory(const Twine &Prefix,
602 SmallVectorImpl<char> &ResultPath);
607 /// F_Excl - When opening a file, this flag makes raw_fd_ostream
608 /// report an error if the file already exists.
611 /// F_Append - When opening a file, if it already exists append to the
612 /// existing file instead of returning an error. This may not be specified
616 /// F_Binary - The file should be opened in binary mode on platforms that
617 /// make this distinction.
621 inline OpenFlags operator|(OpenFlags A, OpenFlags B) {
622 return OpenFlags(unsigned(A) | unsigned(B));
625 inline OpenFlags &operator|=(OpenFlags &A, OpenFlags B) {
630 error_code openFileForWrite(const Twine &Name, int &ResultFD, OpenFlags Flags,
631 unsigned Mode = 0666);
633 error_code openFileForRead(const Twine &Name, int &ResultFD);
635 /// @brief Canonicalize path.
637 /// Sets result to the file system's idea of what path is. The result is always
638 /// absolute and has the same capitalization as the file system.
640 /// @param path Input path.
641 /// @param result Set to the canonicalized version of \a path.
642 /// @returns errc::success if result has been successfully set, otherwise a
643 /// platform specific error_code.
644 error_code canonicalize(const Twine &path, SmallVectorImpl<char> &result);
646 /// @brief Are \a path's first bytes \a magic?
648 /// @param path Input path.
649 /// @param magic Byte sequence to compare \a path's first len(magic) bytes to.
650 /// @returns errc::success if result has been successfully set, otherwise a
651 /// platform specific error_code.
652 error_code has_magic(const Twine &path, const Twine &magic, bool &result);
654 /// @brief Get \a path's first \a len bytes.
656 /// @param path Input path.
657 /// @param len Number of magic bytes to get.
658 /// @param result Set to the first \a len bytes in the file pointed to by
659 /// \a path. Or the entire file if file_size(path) < len, in which
660 /// case result.size() returns the size of the file.
661 /// @returns errc::success if result has been successfully set,
662 /// errc::value_too_large if len is larger then the file pointed to by
663 /// \a path, otherwise a platform specific error_code.
664 error_code get_magic(const Twine &path, uint32_t len,
665 SmallVectorImpl<char> &result);
667 /// @brief Identify the type of a binary file based on how magical it is.
668 file_magic identify_magic(StringRef magic);
670 /// @brief Get and identify \a path's type based on its content.
672 /// @param path Input path.
673 /// @param result Set to the type of file, or file_magic::unknown.
674 /// @returns errc::success if result has been successfully set, otherwise a
675 /// platform specific error_code.
676 error_code identify_magic(const Twine &path, file_magic &result);
678 error_code getUniqueID(const Twine Path, UniqueID &Result);
680 /// This class represents a memory mapped file. It is based on
681 /// boost::iostreams::mapped_file.
682 class mapped_file_region {
683 mapped_file_region() LLVM_DELETED_FUNCTION;
684 mapped_file_region(mapped_file_region&) LLVM_DELETED_FUNCTION;
685 mapped_file_region &operator =(mapped_file_region&) LLVM_DELETED_FUNCTION;
689 readonly, ///< May only access map via const_data as read only.
690 readwrite, ///< May access map via data and modify it. Written to path.
691 priv ///< May modify via data, but changes are lost on destruction.
695 /// Platform specific mapping state.
702 void *FileMappingHandle;
705 error_code init(int FD, bool CloseFD, uint64_t Offset);
708 typedef char char_type;
710 #if LLVM_HAS_RVALUE_REFERENCES
711 mapped_file_region(mapped_file_region&&);
712 mapped_file_region &operator =(mapped_file_region&&);
715 /// Construct a mapped_file_region at \a path starting at \a offset of length
716 /// \a length and with access \a mode.
718 /// \param path Path to the file to map. If it does not exist it will be
720 /// \param mode How to map the memory.
721 /// \param length Number of bytes to map in starting at \a offset. If the file
722 /// is shorter than this, it will be extended. If \a length is
723 /// 0, the entire file will be mapped.
724 /// \param offset Byte offset from the beginning of the file where the map
725 /// should begin. Must be a multiple of
726 /// mapped_file_region::alignment().
727 /// \param ec This is set to errc::success if the map was constructed
728 /// sucessfully. Otherwise it is set to a platform dependent error.
729 mapped_file_region(const Twine &path,
735 /// \param fd An open file descriptor to map. mapped_file_region takes
736 /// ownership if closefd is true. It must have been opended in the correct
738 mapped_file_region(int fd,
745 ~mapped_file_region();
747 mapmode flags() const;
748 uint64_t size() const;
751 /// Get a const view of the data. Modifying this memory has undefined
753 const char *const_data() const;
755 /// \returns The minimum alignment offset must be.
756 static int alignment();
759 /// @brief Memory maps the contents of a file
761 /// @param path Path to file to map.
762 /// @param file_offset Byte offset in file where mapping should begin.
763 /// @param size Byte length of range of the file to map.
764 /// @param map_writable If true, the file will be mapped in r/w such
765 /// that changes to the mapped buffer will be flushed back
766 /// to the file. If false, the file will be mapped read-only
767 /// and the buffer will be read-only.
768 /// @param result Set to the start address of the mapped buffer.
769 /// @returns errc::success if result has been successfully set, otherwise a
770 /// platform specific error_code.
771 error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
772 bool map_writable, void *&result);
775 /// @brief Memory unmaps the contents of a file
777 /// @param base Pointer to the start of the buffer.
778 /// @param size Byte length of the range to unmmap.
779 /// @returns errc::success if result has been successfully set, otherwise a
780 /// platform specific error_code.
781 error_code unmap_file_pages(void *base, size_t size);
783 /// Return the path to the main executable, given the value of argv[0] from
784 /// program startup and the address of main itself. In extremis, this function
785 /// may fail and return an empty path.
786 std::string getMainExecutable(const char *argv0, void *MainExecAddr);
792 /// directory_entry - A single entry in a directory. Caches the status either
793 /// from the result of the iteration syscall, or the first time status is
795 class directory_entry {
797 mutable file_status Status;
800 explicit directory_entry(const Twine &path, file_status st = file_status())
806 void assign(const Twine &path, file_status st = file_status()) {
811 void replace_filename(const Twine &filename, file_status st = file_status());
813 const std::string &path() const { return Path; }
814 error_code status(file_status &result) const;
816 bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
817 bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
818 bool operator< (const directory_entry& rhs) const;
819 bool operator<=(const directory_entry& rhs) const;
820 bool operator> (const directory_entry& rhs) const;
821 bool operator>=(const directory_entry& rhs) const;
827 error_code directory_iterator_construct(DirIterState&, StringRef);
828 error_code directory_iterator_increment(DirIterState&);
829 error_code directory_iterator_destruct(DirIterState&);
831 /// DirIterState - Keeps state for the directory_iterator. It is reference
832 /// counted in order to preserve InputIterator semantics on copy.
833 struct DirIterState : public RefCountedBase<DirIterState> {
835 : IterationHandle(0) {}
838 directory_iterator_destruct(*this);
841 intptr_t IterationHandle;
842 directory_entry CurrentEntry;
846 /// directory_iterator - Iterates through the entries in path. There is no
847 /// operator++ because we need an error_code. If it's really needed we can make
848 /// it call report_fatal_error on error.
849 class directory_iterator {
850 IntrusiveRefCntPtr<detail::DirIterState> State;
853 explicit directory_iterator(const Twine &path, error_code &ec) {
854 State = new detail::DirIterState;
855 SmallString<128> path_storage;
856 ec = detail::directory_iterator_construct(*State,
857 path.toStringRef(path_storage));
860 explicit directory_iterator(const directory_entry &de, error_code &ec) {
861 State = new detail::DirIterState;
862 ec = detail::directory_iterator_construct(*State, de.path());
865 /// Construct end iterator.
866 directory_iterator() : State(new detail::DirIterState) {}
868 // No operator++ because we need error_code.
869 directory_iterator &increment(error_code &ec) {
870 ec = directory_iterator_increment(*State);
874 const directory_entry &operator*() const { return State->CurrentEntry; }
875 const directory_entry *operator->() const { return &State->CurrentEntry; }
877 bool operator==(const directory_iterator &RHS) const {
878 return State->CurrentEntry == RHS.State->CurrentEntry;
881 bool operator!=(const directory_iterator &RHS) const {
882 return !(*this == RHS);
884 // Other members as required by
885 // C++ Std, 24.1.1 Input iterators [input.iterators]
889 /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
890 /// reference counted in order to preserve InputIterator semantics on copy.
891 struct RecDirIterState : public RefCountedBase<RecDirIterState> {
894 , HasNoPushRequest(false) {}
896 std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
898 bool HasNoPushRequest;
902 /// recursive_directory_iterator - Same as directory_iterator except for it
903 /// recurses down into child directories.
904 class recursive_directory_iterator {
905 IntrusiveRefCntPtr<detail::RecDirIterState> State;
908 recursive_directory_iterator() {}
909 explicit recursive_directory_iterator(const Twine &path, error_code &ec)
910 : State(new detail::RecDirIterState) {
911 State->Stack.push(directory_iterator(path, ec));
912 if (State->Stack.top() == directory_iterator())
915 // No operator++ because we need error_code.
916 recursive_directory_iterator &increment(error_code &ec) {
917 static const directory_iterator end_itr;
919 if (State->HasNoPushRequest)
920 State->HasNoPushRequest = false;
923 if ((ec = State->Stack.top()->status(st))) return *this;
924 if (is_directory(st)) {
925 State->Stack.push(directory_iterator(*State->Stack.top(), ec));
926 if (ec) return *this;
927 if (State->Stack.top() != end_itr) {
935 while (!State->Stack.empty()
936 && State->Stack.top().increment(ec) == end_itr) {
941 // Check if we are done. If so, create an end iterator.
942 if (State->Stack.empty())
948 const directory_entry &operator*() const { return *State->Stack.top(); }
949 const directory_entry *operator->() const { return &*State->Stack.top(); }
952 /// Gets the current level. Starting path is at level 0.
953 int level() const { return State->Level; }
955 /// Returns true if no_push has been called for this directory_entry.
956 bool no_push_request() const { return State->HasNoPushRequest; }
959 /// Goes up one level if Level > 0.
961 assert(State && "Cannot pop and end itertor!");
962 assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
964 static const directory_iterator end_itr;
968 report_fatal_error("Error incrementing directory iterator.");
971 } while (!State->Stack.empty()
972 && State->Stack.top().increment(ec) == end_itr);
974 // Check if we are done. If so, create an end iterator.
975 if (State->Stack.empty())
979 /// Does not go down into the current directory_entry.
980 void no_push() { State->HasNoPushRequest = true; }
982 bool operator==(const recursive_directory_iterator &RHS) const {
983 return State == RHS.State;
986 bool operator!=(const recursive_directory_iterator &RHS) const {
987 return !(*this == RHS);
989 // Other members as required by
990 // C++ Std, 24.1.1 Input iterators [input.iterators]
995 } // end namespace fs
996 } // end namespace sys
997 } // end namespace llvm