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 Device, uint64_t File) : Device(Device), File(File) {}
135 bool operator==(const UniqueID &Other) const {
136 return Device == Other.Device && File == Other.File;
138 bool operator!=(const UniqueID &Other) const { return !(*this == Other); }
139 bool operator<(const UniqueID &Other) const {
140 return Device < Other.Device ||
141 (Device == Other.Device && File < Other.File);
143 uint64_t getDevice() const { return Device; }
144 uint64_t getFile() const { return File; }
147 /// file_status - Represents the result of a call to stat and friends. It has
148 /// a platform specific member to store the result.
151 #if defined(LLVM_ON_UNIX)
158 #elif defined (LLVM_ON_WIN32)
159 uint32_t LastWriteTimeHigh;
160 uint32_t LastWriteTimeLow;
161 uint32_t VolumeSerialNumber;
162 uint32_t FileSizeHigh;
163 uint32_t FileSizeLow;
164 uint32_t FileIndexHigh;
165 uint32_t FileIndexLow;
167 friend bool equivalent(file_status A, file_status B);
171 file_status() : Type(file_type::status_error) {}
172 file_status(file_type Type) : Type(Type) {}
174 #if defined(LLVM_ON_UNIX)
175 file_status(file_type Type, perms Perms, dev_t Dev, ino_t Ino, time_t MTime,
176 uid_t UID, gid_t GID, off_t Size)
177 : fs_st_dev(Dev), fs_st_ino(Ino), fs_st_mtime(MTime), fs_st_uid(UID),
178 fs_st_gid(GID), fs_st_size(Size), Type(Type), Perms(Perms) {}
179 #elif defined(LLVM_ON_WIN32)
180 file_status(file_type Type, uint32_t LastWriteTimeHigh,
181 uint32_t LastWriteTimeLow, uint32_t VolumeSerialNumber,
182 uint32_t FileSizeHigh, uint32_t FileSizeLow,
183 uint32_t FileIndexHigh, uint32_t FileIndexLow)
184 : LastWriteTimeHigh(LastWriteTimeHigh),
185 LastWriteTimeLow(LastWriteTimeLow),
186 VolumeSerialNumber(VolumeSerialNumber), FileSizeHigh(FileSizeHigh),
187 FileSizeLow(FileSizeLow), FileIndexHigh(FileIndexHigh),
188 FileIndexLow(FileIndexLow), Type(Type), Perms(perms_not_known) {}
192 file_type type() const { return Type; }
193 perms permissions() const { return Perms; }
194 TimeValue getLastModificationTime() const;
195 UniqueID getUniqueID() const;
197 #if defined(LLVM_ON_UNIX)
198 uint32_t getUser() const { return fs_st_uid; }
199 uint32_t getGroup() const { return fs_st_gid; }
200 uint64_t getSize() const { return fs_st_size; }
201 #elif defined (LLVM_ON_WIN32)
202 uint32_t getUser() const {
203 return 9999; // Not applicable to Windows, so...
205 uint32_t getGroup() const {
206 return 9999; // Not applicable to Windows, so...
208 uint64_t getSize() const {
209 return (uint64_t(FileSizeHigh) << 32) + FileSizeLow;
214 void type(file_type v) { Type = v; }
215 void permissions(perms p) { Perms = p; }
218 /// file_magic - An "enum class" enumeration of file types based on magic (the first
219 /// N bytes of the file).
222 unknown = 0, ///< Unrecognized file
223 bitcode, ///< Bitcode file
224 archive, ///< ar style archive file
225 elf_relocatable, ///< ELF Relocatable object file
226 elf_executable, ///< ELF Executable image
227 elf_shared_object, ///< ELF dynamically linked shared lib
228 elf_core, ///< ELF core image
229 macho_object, ///< Mach-O Object file
230 macho_executable, ///< Mach-O Executable
231 macho_fixed_virtual_memory_shared_lib, ///< Mach-O Shared Lib, FVM
232 macho_core, ///< Mach-O Core File
233 macho_preload_executable, ///< Mach-O Preloaded Executable
234 macho_dynamically_linked_shared_lib, ///< Mach-O dynlinked shared lib
235 macho_dynamic_linker, ///< The Mach-O dynamic linker
236 macho_bundle, ///< Mach-O Bundle file
237 macho_dynamically_linked_shared_lib_stub, ///< Mach-O Shared lib stub
238 macho_dsym_companion, ///< Mach-O dSYM companion file
239 macho_universal_binary, ///< Mach-O universal binary
240 coff_object, ///< COFF object file
241 pecoff_executable, ///< PECOFF executable file
242 windows_resource, ///< Windows compiled resource file (.rc)
245 bool is_object() const {
246 return V == unknown ? false : true;
249 file_magic() : V(unknown) {}
250 file_magic(Impl V) : V(V) {}
251 operator Impl() const { return V; }
258 /// @name Physical Operators
261 /// @brief Make \a path an absolute path.
263 /// Makes \a path absolute using the current directory if it is not already. An
264 /// empty \a path will result in the current directory.
266 /// /absolute/path => /absolute/path
267 /// relative/../path => <current-directory>/relative/../path
269 /// @param path A path that is modified to be an absolute path.
270 /// @returns errc::success if \a path has been made absolute, otherwise a
271 /// platform specific error_code.
272 error_code make_absolute(SmallVectorImpl<char> &path);
274 /// @brief Create all the non-existent directories in path.
276 /// @param path Directories to create.
277 /// @param existed Set to true if \a path already existed, false otherwise.
278 /// @returns errc::success if is_directory(path) and existed have been set,
279 /// otherwise a platform specific error_code.
280 error_code create_directories(const Twine &path, bool &existed);
282 /// @brief Convenience function for clients that don't need to know if the
283 /// directory existed or not.
284 inline error_code create_directories(const Twine &Path) {
286 return create_directories(Path, Existed);
289 /// @brief Create the directory in path.
291 /// @param path Directory to create.
292 /// @param existed Set to true if \a path already existed, false otherwise.
293 /// @returns errc::success if is_directory(path) and existed have been set,
294 /// otherwise a platform specific error_code.
295 error_code create_directory(const Twine &path, bool &existed);
297 /// @brief Convenience function for clients that don't need to know if the
298 /// directory existed or not.
299 inline error_code create_directory(const Twine &Path) {
301 return create_directory(Path, Existed);
304 /// @brief Create a hard link from \a from to \a to.
306 /// @param to The path to hard link to.
307 /// @param from The path to hard link from. This is created.
308 /// @returns errc::success if exists(to) && exists(from) && equivalent(to, from)
309 /// , otherwise a platform specific error_code.
310 error_code create_hard_link(const Twine &to, const Twine &from);
312 /// @brief Create a symbolic link from \a from to \a to.
314 /// @param to The path to symbolically link to.
315 /// @param from The path to symbolically link from. This is created.
316 /// @returns errc::success if exists(to) && exists(from) && is_symlink(from),
317 /// otherwise a platform specific error_code.
318 error_code create_symlink(const Twine &to, const Twine &from);
320 /// @brief Get the current path.
322 /// @param result Holds the current path on return.
323 /// @returns errc::success if the current path has been stored in result,
324 /// otherwise a platform specific error_code.
325 error_code current_path(SmallVectorImpl<char> &result);
327 /// @brief Remove path. Equivalent to POSIX remove().
329 /// @param path Input path.
330 /// @param existed Set to true if \a path existed, false if it did not.
331 /// undefined otherwise.
332 /// @returns errc::success if path has been removed and existed has been
333 /// successfully set, otherwise a platform specific error_code.
334 error_code remove(const Twine &path, bool &existed);
336 /// @brief Convenience function for clients that don't need to know if the file
338 inline error_code remove(const Twine &Path) {
340 return remove(Path, Existed);
343 /// @brief Recursively remove all files below \a path, then \a path. Files are
344 /// removed as if by POSIX remove().
346 /// @param path Input path.
347 /// @param num_removed Number of files removed.
348 /// @returns errc::success if path has been removed and num_removed has been
349 /// successfully set, otherwise a platform specific error_code.
350 error_code remove_all(const Twine &path, uint32_t &num_removed);
352 /// @brief Convenience function for clients that don't need to know how many
353 /// files were removed.
354 inline error_code remove_all(const Twine &Path) {
356 return remove_all(Path, Removed);
359 /// @brief Rename \a from to \a to. Files are renamed as if by POSIX rename().
361 /// @param from The path to rename from.
362 /// @param to The path to rename to. This is created.
363 error_code rename(const Twine &from, const Twine &to);
365 /// @brief Resize path to size. File is resized as if by POSIX truncate().
367 /// @param path Input path.
368 /// @param size Size to resize to.
369 /// @returns errc::success if \a path has been resized to \a size, otherwise a
370 /// platform specific error_code.
371 error_code resize_file(const Twine &path, uint64_t size);
374 /// @name Physical Observers
377 /// @brief Does file exist?
379 /// @param status A file_status previously returned from stat.
380 /// @returns True if the file represented by status exists, false if it does
382 bool exists(file_status status);
384 /// @brief Does file exist?
386 /// @param path Input path.
387 /// @param result Set to true if the file represented by status exists, false if
388 /// it does not. Undefined otherwise.
389 /// @returns errc::success if result has been successfully set, otherwise a
390 /// platform specific error_code.
391 error_code exists(const Twine &path, bool &result);
393 /// @brief Simpler version of exists for clients that don't need to
394 /// differentiate between an error and false.
395 inline bool exists(const Twine &path) {
397 return !exists(path, result) && result;
400 /// @brief Can we execute this file?
402 /// @param Path Input path.
403 /// @returns True if we can execute it, false otherwise.
404 bool can_execute(const Twine &Path);
406 /// @brief Can we write this file?
408 /// @param Path Input path.
409 /// @returns True if we can write to it, false otherwise.
410 bool can_write(const Twine &Path);
412 /// @brief Do file_status's represent the same thing?
414 /// @param A Input file_status.
415 /// @param B Input file_status.
417 /// assert(status_known(A) || status_known(B));
419 /// @returns True if A and B both represent the same file system entity, false
421 bool equivalent(file_status A, file_status B);
423 /// @brief Do paths represent the same thing?
425 /// assert(status_known(A) || status_known(B));
427 /// @param A Input path A.
428 /// @param B Input path B.
429 /// @param result Set to true if stat(A) and stat(B) have the same device and
430 /// inode (or equivalent).
431 /// @returns errc::success if result has been successfully set, otherwise a
432 /// platform specific error_code.
433 error_code equivalent(const Twine &A, const Twine &B, bool &result);
435 /// @brief Simpler version of equivalent for clients that don't need to
436 /// differentiate between an error and false.
437 inline bool equivalent(const Twine &A, const Twine &B) {
439 return !equivalent(A, B, result) && result;
442 /// @brief Does status represent a directory?
444 /// @param status A file_status previously returned from status.
445 /// @returns status.type() == file_type::directory_file.
446 bool is_directory(file_status status);
448 /// @brief Is path a directory?
450 /// @param path Input path.
451 /// @param result Set to true if \a path is a directory, false if it is not.
452 /// Undefined otherwise.
453 /// @returns errc::success if result has been successfully set, otherwise a
454 /// platform specific error_code.
455 error_code is_directory(const Twine &path, bool &result);
457 /// @brief Simpler version of is_directory for clients that don't need to
458 /// differentiate between an error and false.
459 inline bool is_directory(const Twine &Path) {
461 return !is_directory(Path, Result) && Result;
464 /// @brief Does status represent a regular file?
466 /// @param status A file_status previously returned from status.
467 /// @returns status_known(status) && status.type() == file_type::regular_file.
468 bool is_regular_file(file_status status);
470 /// @brief Is path a regular file?
472 /// @param path Input path.
473 /// @param result Set to true if \a path is a regular file, false if it is not.
474 /// Undefined otherwise.
475 /// @returns errc::success if result has been successfully set, otherwise a
476 /// platform specific error_code.
477 error_code is_regular_file(const Twine &path, bool &result);
479 /// @brief Simpler version of is_regular_file for clients that don't need to
480 /// differentiate between an error and false.
481 inline bool is_regular_file(const Twine &Path) {
483 if (is_regular_file(Path, Result))
488 /// @brief Does this status represent something that exists but is not a
489 /// directory, regular file, or symlink?
491 /// @param status A file_status previously returned from status.
492 /// @returns exists(s) && !is_regular_file(s) && !is_directory(s) &&
494 bool is_other(file_status status);
496 /// @brief Is path something that exists but is not a directory,
497 /// regular file, or symlink?
499 /// @param path Input path.
500 /// @param result Set to true if \a path exists, but is not a directory, regular
501 /// file, or a symlink, false if it does not. Undefined otherwise.
502 /// @returns errc::success if result has been successfully set, otherwise a
503 /// platform specific error_code.
504 error_code is_other(const Twine &path, bool &result);
506 /// @brief Does status represent a symlink?
508 /// @param status A file_status previously returned from stat.
509 /// @returns status.type() == symlink_file.
510 bool is_symlink(file_status status);
512 /// @brief Is path a symlink?
514 /// @param path Input path.
515 /// @param result Set to true if \a path is a symlink, false if it is not.
516 /// Undefined otherwise.
517 /// @returns errc::success if result has been successfully set, otherwise a
518 /// platform specific error_code.
519 error_code is_symlink(const Twine &path, bool &result);
521 /// @brief Get file status as if by POSIX stat().
523 /// @param path Input path.
524 /// @param result Set to the file status.
525 /// @returns errc::success if result has been successfully set, otherwise a
526 /// platform specific error_code.
527 error_code status(const Twine &path, file_status &result);
529 /// @brief A version for when a file descriptor is already available.
530 error_code status(int FD, file_status &Result);
532 /// @brief Get file size.
534 /// @param Path Input path.
535 /// @param Result Set to the size of the file in \a Path.
536 /// @returns errc::success if result has been successfully set, otherwise a
537 /// platform specific error_code.
538 inline error_code file_size(const Twine &Path, uint64_t &Result) {
540 error_code EC = status(Path, Status);
543 Result = Status.getSize();
544 return error_code::success();
547 error_code setLastModificationAndAccessTime(int FD, TimeValue Time);
549 /// @brief Is status available?
551 /// @param s Input file status.
552 /// @returns True if status() != status_error.
553 bool status_known(file_status s);
555 /// @brief Is status available?
557 /// @param path Input path.
558 /// @param result Set to true if status() != status_error.
559 /// @returns errc::success if result has been successfully set, otherwise a
560 /// platform specific error_code.
561 error_code status_known(const Twine &path, bool &result);
563 /// @brief Create a uniquely named file.
565 /// Generates a unique path suitable for a temporary file and then opens it as a
566 /// file. The name is based on \a model with '%' replaced by a random char in
567 /// [0-9a-f]. If \a model is not an absolute path, a suitable temporary
568 /// directory will be prepended.
570 /// Example: clang-%%-%%-%%-%%-%%.s => clang-a0-b1-c2-d3-e4.s
572 /// This is an atomic operation. Either the file is created and opened, or the
573 /// file system is left untouched.
575 /// The intendend use is for files that are to be kept, possibly after
576 /// renaming them. For example, when running 'clang -c foo.o', the file can
577 /// be first created as foo-abc123.o and then renamed.
579 /// @param Model Name to base unique path off of.
580 /// @param ResultFD Set to the opened file's file descriptor.
581 /// @param ResultPath Set to the opened file's absolute path.
582 /// @returns errc::success if Result{FD,Path} have been successfully set,
583 /// otherwise a platform specific error_code.
584 error_code createUniqueFile(const Twine &Model, int &ResultFD,
585 SmallVectorImpl<char> &ResultPath,
586 unsigned Mode = all_read | all_write);
588 /// @brief Simpler version for clients that don't want an open file.
589 error_code createUniqueFile(const Twine &Model,
590 SmallVectorImpl<char> &ResultPath);
592 /// @brief Create a file in the system temporary directory.
594 /// The filename is of the form prefix-random_chars.suffix. Since the directory
595 /// is not know to the caller, Prefix and Suffix cannot have path separators.
596 /// The files are created with mode 0600.
598 /// This should be used for things like a temporary .s that is removed after
599 /// running the assembler.
600 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
602 SmallVectorImpl<char> &ResultPath);
604 /// @brief Simpler version for clients that don't want an open file.
605 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
606 SmallVectorImpl<char> &ResultPath);
608 error_code createUniqueDirectory(const Twine &Prefix,
609 SmallVectorImpl<char> &ResultPath);
614 /// F_Excl - When opening a file, this flag makes raw_fd_ostream
615 /// report an error if the file already exists.
618 /// F_Append - When opening a file, if it already exists append to the
619 /// existing file instead of returning an error. This may not be specified
623 /// F_Binary - The file should be opened in binary mode on platforms that
624 /// make this distinction.
628 inline OpenFlags operator|(OpenFlags A, OpenFlags B) {
629 return OpenFlags(unsigned(A) | unsigned(B));
632 inline OpenFlags &operator|=(OpenFlags &A, OpenFlags B) {
637 error_code openFileForWrite(const Twine &Name, int &ResultFD, OpenFlags Flags,
638 unsigned Mode = 0666);
640 error_code openFileForRead(const Twine &Name, int &ResultFD);
642 /// @brief Canonicalize path.
644 /// Sets result to the file system's idea of what path is. The result is always
645 /// absolute and has the same capitalization as the file system.
647 /// @param path Input path.
648 /// @param result Set to the canonicalized version of \a path.
649 /// @returns errc::success if result has been successfully set, otherwise a
650 /// platform specific error_code.
651 error_code canonicalize(const Twine &path, SmallVectorImpl<char> &result);
653 /// @brief Are \a path's first bytes \a magic?
655 /// @param path Input path.
656 /// @param magic Byte sequence to compare \a path's first len(magic) bytes to.
657 /// @returns errc::success if result has been successfully set, otherwise a
658 /// platform specific error_code.
659 error_code has_magic(const Twine &path, const Twine &magic, bool &result);
661 /// @brief Get \a path's first \a len bytes.
663 /// @param path Input path.
664 /// @param len Number of magic bytes to get.
665 /// @param result Set to the first \a len bytes in the file pointed to by
666 /// \a path. Or the entire file if file_size(path) < len, in which
667 /// case result.size() returns the size of the file.
668 /// @returns errc::success if result has been successfully set,
669 /// errc::value_too_large if len is larger then the file pointed to by
670 /// \a path, otherwise a platform specific error_code.
671 error_code get_magic(const Twine &path, uint32_t len,
672 SmallVectorImpl<char> &result);
674 /// @brief Identify the type of a binary file based on how magical it is.
675 file_magic identify_magic(StringRef magic);
677 /// @brief Get and identify \a path's type based on its content.
679 /// @param path Input path.
680 /// @param result Set to the type of file, or file_magic::unknown.
681 /// @returns errc::success if result has been successfully set, otherwise a
682 /// platform specific error_code.
683 error_code identify_magic(const Twine &path, file_magic &result);
685 error_code getUniqueID(const Twine Path, UniqueID &Result);
687 /// This class represents a memory mapped file. It is based on
688 /// boost::iostreams::mapped_file.
689 class mapped_file_region {
690 mapped_file_region() LLVM_DELETED_FUNCTION;
691 mapped_file_region(mapped_file_region&) LLVM_DELETED_FUNCTION;
692 mapped_file_region &operator =(mapped_file_region&) LLVM_DELETED_FUNCTION;
696 readonly, ///< May only access map via const_data as read only.
697 readwrite, ///< May access map via data and modify it. Written to path.
698 priv ///< May modify via data, but changes are lost on destruction.
702 /// Platform specific mapping state.
709 void *FileMappingHandle;
712 error_code init(int FD, bool CloseFD, uint64_t Offset);
715 typedef char char_type;
717 #if LLVM_HAS_RVALUE_REFERENCES
718 mapped_file_region(mapped_file_region&&);
719 mapped_file_region &operator =(mapped_file_region&&);
722 /// Construct a mapped_file_region at \a path starting at \a offset of length
723 /// \a length and with access \a mode.
725 /// \param path Path to the file to map. If it does not exist it will be
727 /// \param mode How to map the memory.
728 /// \param length Number of bytes to map in starting at \a offset. If the file
729 /// is shorter than this, it will be extended. If \a length is
730 /// 0, the entire file will be mapped.
731 /// \param offset Byte offset from the beginning of the file where the map
732 /// should begin. Must be a multiple of
733 /// mapped_file_region::alignment().
734 /// \param ec This is set to errc::success if the map was constructed
735 /// sucessfully. Otherwise it is set to a platform dependent error.
736 mapped_file_region(const Twine &path,
742 /// \param fd An open file descriptor to map. mapped_file_region takes
743 /// ownership if closefd is true. It must have been opended in the correct
745 mapped_file_region(int fd,
752 ~mapped_file_region();
754 mapmode flags() const;
755 uint64_t size() const;
758 /// Get a const view of the data. Modifying this memory has undefined
760 const char *const_data() const;
762 /// \returns The minimum alignment offset must be.
763 static int alignment();
766 /// @brief Memory maps the contents of a file
768 /// @param path Path to file to map.
769 /// @param file_offset Byte offset in file where mapping should begin.
770 /// @param size Byte length of range of the file to map.
771 /// @param map_writable If true, the file will be mapped in r/w such
772 /// that changes to the mapped buffer will be flushed back
773 /// to the file. If false, the file will be mapped read-only
774 /// and the buffer will be read-only.
775 /// @param result Set to the start address of the mapped buffer.
776 /// @returns errc::success if result has been successfully set, otherwise a
777 /// platform specific error_code.
778 error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
779 bool map_writable, void *&result);
782 /// @brief Memory unmaps the contents of a file
784 /// @param base Pointer to the start of the buffer.
785 /// @param size Byte length of the range to unmmap.
786 /// @returns errc::success if result has been successfully set, otherwise a
787 /// platform specific error_code.
788 error_code unmap_file_pages(void *base, size_t size);
790 /// Return the path to the main executable, given the value of argv[0] from
791 /// program startup and the address of main itself. In extremis, this function
792 /// may fail and return an empty path.
793 std::string getMainExecutable(const char *argv0, void *MainExecAddr);
799 /// directory_entry - A single entry in a directory. Caches the status either
800 /// from the result of the iteration syscall, or the first time status is
802 class directory_entry {
804 mutable file_status Status;
807 explicit directory_entry(const Twine &path, file_status st = file_status())
813 void assign(const Twine &path, file_status st = file_status()) {
818 void replace_filename(const Twine &filename, file_status st = file_status());
820 const std::string &path() const { return Path; }
821 error_code status(file_status &result) const;
823 bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
824 bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
825 bool operator< (const directory_entry& rhs) const;
826 bool operator<=(const directory_entry& rhs) const;
827 bool operator> (const directory_entry& rhs) const;
828 bool operator>=(const directory_entry& rhs) const;
834 error_code directory_iterator_construct(DirIterState&, StringRef);
835 error_code directory_iterator_increment(DirIterState&);
836 error_code directory_iterator_destruct(DirIterState&);
838 /// DirIterState - Keeps state for the directory_iterator. It is reference
839 /// counted in order to preserve InputIterator semantics on copy.
840 struct DirIterState : public RefCountedBase<DirIterState> {
842 : IterationHandle(0) {}
845 directory_iterator_destruct(*this);
848 intptr_t IterationHandle;
849 directory_entry CurrentEntry;
853 /// directory_iterator - Iterates through the entries in path. There is no
854 /// operator++ because we need an error_code. If it's really needed we can make
855 /// it call report_fatal_error on error.
856 class directory_iterator {
857 IntrusiveRefCntPtr<detail::DirIterState> State;
860 explicit directory_iterator(const Twine &path, error_code &ec) {
861 State = new detail::DirIterState;
862 SmallString<128> path_storage;
863 ec = detail::directory_iterator_construct(*State,
864 path.toStringRef(path_storage));
867 explicit directory_iterator(const directory_entry &de, error_code &ec) {
868 State = new detail::DirIterState;
869 ec = detail::directory_iterator_construct(*State, de.path());
872 /// Construct end iterator.
873 directory_iterator() : State(0) {}
875 // No operator++ because we need error_code.
876 directory_iterator &increment(error_code &ec) {
877 ec = directory_iterator_increment(*State);
881 const directory_entry &operator*() const { return State->CurrentEntry; }
882 const directory_entry *operator->() const { return &State->CurrentEntry; }
884 bool operator==(const directory_iterator &RHS) const {
885 if (State == RHS.State)
888 return State->CurrentEntry == directory_entry();
890 return RHS.State->CurrentEntry == directory_entry();
891 return State->CurrentEntry == RHS.State->CurrentEntry;
894 bool operator!=(const directory_iterator &RHS) const {
895 return !(*this == RHS);
897 // Other members as required by
898 // C++ Std, 24.1.1 Input iterators [input.iterators]
902 /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
903 /// reference counted in order to preserve InputIterator semantics on copy.
904 struct RecDirIterState : public RefCountedBase<RecDirIterState> {
907 , HasNoPushRequest(false) {}
909 std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
911 bool HasNoPushRequest;
915 /// recursive_directory_iterator - Same as directory_iterator except for it
916 /// recurses down into child directories.
917 class recursive_directory_iterator {
918 IntrusiveRefCntPtr<detail::RecDirIterState> State;
921 recursive_directory_iterator() {}
922 explicit recursive_directory_iterator(const Twine &path, error_code &ec)
923 : State(new detail::RecDirIterState) {
924 State->Stack.push(directory_iterator(path, ec));
925 if (State->Stack.top() == directory_iterator())
928 // No operator++ because we need error_code.
929 recursive_directory_iterator &increment(error_code &ec) {
930 const directory_iterator end_itr;
932 if (State->HasNoPushRequest)
933 State->HasNoPushRequest = false;
936 if ((ec = State->Stack.top()->status(st))) return *this;
937 if (is_directory(st)) {
938 State->Stack.push(directory_iterator(*State->Stack.top(), ec));
939 if (ec) return *this;
940 if (State->Stack.top() != end_itr) {
948 while (!State->Stack.empty()
949 && State->Stack.top().increment(ec) == end_itr) {
954 // Check if we are done. If so, create an end iterator.
955 if (State->Stack.empty())
961 const directory_entry &operator*() const { return *State->Stack.top(); }
962 const directory_entry *operator->() const { return &*State->Stack.top(); }
965 /// Gets the current level. Starting path is at level 0.
966 int level() const { return State->Level; }
968 /// Returns true if no_push has been called for this directory_entry.
969 bool no_push_request() const { return State->HasNoPushRequest; }
972 /// Goes up one level if Level > 0.
974 assert(State && "Cannot pop an end iterator!");
975 assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
977 const directory_iterator end_itr;
981 report_fatal_error("Error incrementing directory iterator.");
984 } while (!State->Stack.empty()
985 && State->Stack.top().increment(ec) == end_itr);
987 // Check if we are done. If so, create an end iterator.
988 if (State->Stack.empty())
992 /// Does not go down into the current directory_entry.
993 void no_push() { State->HasNoPushRequest = true; }
995 bool operator==(const recursive_directory_iterator &RHS) const {
996 return State == RHS.State;
999 bool operator!=(const recursive_directory_iterator &RHS) const {
1000 return !(*this == RHS);
1002 // Other members as required by
1003 // C++ Std, 24.1.1 Input iterators [input.iterators]
1008 } // end namespace fs
1009 } // end namespace sys
1010 } // end namespace llvm