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/SmallString.h"
31 #include "llvm/ADT/StringRef.h"
32 #include "llvm/ADT/Twine.h"
33 #include "llvm/Config/llvm-config.h"
34 #include "llvm/Support/Chrono.h"
35 #include "llvm/Support/Error.h"
36 #include "llvm/Support/ErrorHandling.h"
37 #include "llvm/Support/ErrorOr.h"
38 #include "llvm/Support/MD5.h"
45 #include <system_error>
49 #ifdef HAVE_SYS_STAT_H
58 // A Win32 HANDLE is a typedef of void*
59 using file_t = void *;
64 extern const file_t kInvalidFile;
66 /// An enumeration for the file system's view of the type.
67 enum class file_type {
80 /// space_info - Self explanatory.
92 owner_all = owner_read | owner_write | owner_exe,
96 group_all = group_read | group_write | group_exe,
100 others_all = others_read | others_write | others_exe,
101 all_read = owner_read | group_read | others_read,
102 all_write = owner_write | group_write | others_write,
103 all_exe = owner_exe | group_exe | others_exe,
104 all_all = owner_all | group_all | others_all,
105 set_uid_on_exe = 04000,
106 set_gid_on_exe = 02000,
108 all_perms = all_all | set_uid_on_exe | set_gid_on_exe | sticky_bit,
109 perms_not_known = 0xFFFF
112 // Helper functions so that you can use & and | to manipulate perms bits:
113 inline perms operator|(perms l, perms r) {
114 return static_cast<perms>(static_cast<unsigned short>(l) |
115 static_cast<unsigned short>(r));
117 inline perms operator&(perms l, perms r) {
118 return static_cast<perms>(static_cast<unsigned short>(l) &
119 static_cast<unsigned short>(r));
121 inline perms &operator|=(perms &l, perms r) {
125 inline perms &operator&=(perms &l, perms r) {
129 inline perms operator~(perms x) {
130 // Avoid UB by explicitly truncating the (unsigned) ~ result.
131 return static_cast<perms>(
132 static_cast<unsigned short>(~static_cast<unsigned short>(x)));
140 UniqueID() = default;
141 UniqueID(uint64_t Device, uint64_t File) : Device(Device), File(File) {}
143 bool operator==(const UniqueID &Other) const {
144 return Device == Other.Device && File == Other.File;
146 bool operator!=(const UniqueID &Other) const { return !(*this == Other); }
147 bool operator<(const UniqueID &Other) const {
148 return std::tie(Device, File) < std::tie(Other.Device, Other.File);
151 uint64_t getDevice() const { return Device; }
152 uint64_t getFile() const { return File; }
155 /// Represents the result of a call to directory_iterator::status(). This is a
156 /// subset of the information returned by a regular sys::fs::status() call, and
157 /// represents the information provided by Windows FileFirstFile/FindNextFile.
158 class basic_file_status {
160 #if defined(LLVM_ON_UNIX)
161 time_t fs_st_atime = 0;
162 time_t fs_st_mtime = 0;
165 off_t fs_st_size = 0;
166 #elif defined (_WIN32)
167 uint32_t LastAccessedTimeHigh = 0;
168 uint32_t LastAccessedTimeLow = 0;
169 uint32_t LastWriteTimeHigh = 0;
170 uint32_t LastWriteTimeLow = 0;
171 uint32_t FileSizeHigh = 0;
172 uint32_t FileSizeLow = 0;
174 file_type Type = file_type::status_error;
175 perms Perms = perms_not_known;
178 basic_file_status() = default;
180 explicit basic_file_status(file_type Type) : Type(Type) {}
182 #if defined(LLVM_ON_UNIX)
183 basic_file_status(file_type Type, perms Perms, time_t ATime, time_t MTime,
184 uid_t UID, gid_t GID, off_t Size)
185 : fs_st_atime(ATime), fs_st_mtime(MTime), fs_st_uid(UID), fs_st_gid(GID),
186 fs_st_size(Size), Type(Type), Perms(Perms) {}
187 #elif defined(_WIN32)
188 basic_file_status(file_type Type, perms Perms, uint32_t LastAccessTimeHigh,
189 uint32_t LastAccessTimeLow, uint32_t LastWriteTimeHigh,
190 uint32_t LastWriteTimeLow, uint32_t FileSizeHigh,
191 uint32_t FileSizeLow)
192 : LastAccessedTimeHigh(LastAccessTimeHigh),
193 LastAccessedTimeLow(LastAccessTimeLow),
194 LastWriteTimeHigh(LastWriteTimeHigh),
195 LastWriteTimeLow(LastWriteTimeLow), FileSizeHigh(FileSizeHigh),
196 FileSizeLow(FileSizeLow), Type(Type), Perms(Perms) {}
200 file_type type() const { return Type; }
201 perms permissions() const { return Perms; }
202 TimePoint<> getLastAccessedTime() const;
203 TimePoint<> getLastModificationTime() const;
205 #if defined(LLVM_ON_UNIX)
206 uint32_t getUser() const { return fs_st_uid; }
207 uint32_t getGroup() const { return fs_st_gid; }
208 uint64_t getSize() const { return fs_st_size; }
209 #elif defined (_WIN32)
210 uint32_t getUser() const {
211 return 9999; // Not applicable to Windows, so...
214 uint32_t getGroup() const {
215 return 9999; // Not applicable to Windows, so...
218 uint64_t getSize() const {
219 return (uint64_t(FileSizeHigh) << 32) + FileSizeLow;
224 void type(file_type v) { Type = v; }
225 void permissions(perms p) { Perms = p; }
228 /// Represents the result of a call to sys::fs::status().
229 class file_status : public basic_file_status {
230 friend bool equivalent(file_status A, file_status B);
232 #if defined(LLVM_ON_UNIX)
234 nlink_t fs_st_nlinks = 0;
236 #elif defined (_WIN32)
237 uint32_t NumLinks = 0;
238 uint32_t VolumeSerialNumber = 0;
239 uint32_t FileIndexHigh = 0;
240 uint32_t FileIndexLow = 0;
244 file_status() = default;
246 explicit file_status(file_type Type) : basic_file_status(Type) {}
248 #if defined(LLVM_ON_UNIX)
249 file_status(file_type Type, perms Perms, dev_t Dev, nlink_t Links, ino_t Ino,
250 time_t ATime, time_t MTime, uid_t UID, gid_t GID, off_t Size)
251 : basic_file_status(Type, Perms, ATime, MTime, UID, GID, Size),
252 fs_st_dev(Dev), fs_st_nlinks(Links), fs_st_ino(Ino) {}
253 #elif defined(_WIN32)
254 file_status(file_type Type, perms Perms, uint32_t LinkCount,
255 uint32_t LastAccessTimeHigh, uint32_t LastAccessTimeLow,
256 uint32_t LastWriteTimeHigh, uint32_t LastWriteTimeLow,
257 uint32_t VolumeSerialNumber, uint32_t FileSizeHigh,
258 uint32_t FileSizeLow, uint32_t FileIndexHigh,
259 uint32_t FileIndexLow)
260 : basic_file_status(Type, Perms, LastAccessTimeHigh, LastAccessTimeLow,
261 LastWriteTimeHigh, LastWriteTimeLow, FileSizeHigh,
263 NumLinks(LinkCount), VolumeSerialNumber(VolumeSerialNumber),
264 FileIndexHigh(FileIndexHigh), FileIndexLow(FileIndexLow) {}
267 UniqueID getUniqueID() const;
268 uint32_t getLinkCount() const;
272 /// @name Physical Operators
275 /// Make \a path an absolute path.
277 /// Makes \a path absolute using the \a current_directory if it is not already.
278 /// An empty \a path will result in the \a current_directory.
280 /// /absolute/path => /absolute/path
281 /// relative/../path => <current-directory>/relative/../path
283 /// @param path A path that is modified to be an absolute path.
284 /// @returns errc::success if \a path has been made absolute, otherwise a
285 /// platform-specific error_code.
286 std::error_code make_absolute(const Twine ¤t_directory,
287 SmallVectorImpl<char> &path);
289 /// Make \a path an absolute path.
291 /// Makes \a path absolute using the current directory if it is not already. An
292 /// empty \a path will result in the current directory.
294 /// /absolute/path => /absolute/path
295 /// relative/../path => <current-directory>/relative/../path
297 /// @param path A path that is modified to be an absolute path.
298 /// @returns errc::success if \a path has been made absolute, otherwise a
299 /// platform-specific error_code.
300 std::error_code make_absolute(SmallVectorImpl<char> &path);
302 /// Create all the non-existent directories in path.
304 /// @param path Directories to create.
305 /// @returns errc::success if is_directory(path), otherwise a platform
306 /// specific error_code. If IgnoreExisting is false, also returns
307 /// error if the directory already existed.
308 std::error_code create_directories(const Twine &path,
309 bool IgnoreExisting = true,
310 perms Perms = owner_all | group_all);
312 /// Create the directory in path.
314 /// @param path Directory to create.
315 /// @returns errc::success if is_directory(path), otherwise a platform
316 /// specific error_code. If IgnoreExisting is false, also returns
317 /// error if the directory already existed.
318 std::error_code create_directory(const Twine &path, bool IgnoreExisting = true,
319 perms Perms = owner_all | group_all);
321 /// Create a link from \a from to \a to.
323 /// The link may be a soft or a hard link, depending on the platform. The caller
324 /// may not assume which one. Currently on windows it creates a hard link since
325 /// soft links require extra privileges. On unix, it creates a soft link since
326 /// hard links don't work on SMB file systems.
328 /// @param to The path to hard link to.
329 /// @param from The path to hard link from. This is created.
330 /// @returns errc::success if the link was created, otherwise a platform
331 /// specific error_code.
332 std::error_code create_link(const Twine &to, const Twine &from);
334 /// Create a hard link from \a from to \a to, or return an error.
336 /// @param to The path to hard link to.
337 /// @param from The path to hard link from. This is created.
338 /// @returns errc::success if the link was created, otherwise a platform
339 /// specific error_code.
340 std::error_code create_hard_link(const Twine &to, const Twine &from);
342 /// Collapse all . and .. patterns, resolve all symlinks, and optionally
343 /// expand ~ expressions to the user's home directory.
345 /// @param path The path to resolve.
346 /// @param output The location to store the resolved path.
347 /// @param expand_tilde If true, resolves ~ expressions to the user's home
349 std::error_code real_path(const Twine &path, SmallVectorImpl<char> &output,
350 bool expand_tilde = false);
352 /// Get the current path.
354 /// @param result Holds the current path on return.
355 /// @returns errc::success if the current path has been stored in result,
356 /// otherwise a platform-specific error_code.
357 std::error_code current_path(SmallVectorImpl<char> &result);
359 /// Set the current path.
361 /// @param path The path to set.
362 /// @returns errc::success if the current path was successfully set,
363 /// otherwise a platform-specific error_code.
364 std::error_code set_current_path(const Twine &path);
366 /// Remove path. Equivalent to POSIX remove().
368 /// @param path Input path.
369 /// @returns errc::success if path has been removed or didn't exist, otherwise a
370 /// platform-specific error code. If IgnoreNonExisting is false, also
371 /// returns error if the file didn't exist.
372 std::error_code remove(const Twine &path, bool IgnoreNonExisting = true);
374 /// Recursively delete a directory.
376 /// @param path Input path.
377 /// @returns errc::success if path has been removed or didn't exist, otherwise a
378 /// platform-specific error code.
379 std::error_code remove_directories(const Twine &path, bool IgnoreErrors = true);
381 /// Rename \a from to \a to.
383 /// Files are renamed as if by POSIX rename(), except that on Windows there may
384 /// be a short interval of time during which the destination file does not
387 /// @param from The path to rename from.
388 /// @param to The path to rename to. This is created.
389 std::error_code rename(const Twine &from, const Twine &to);
391 /// Copy the contents of \a From to \a To.
393 /// @param From The path to copy from.
394 /// @param To The path to copy to. This is created.
395 std::error_code copy_file(const Twine &From, const Twine &To);
397 /// Copy the contents of \a From to \a To.
399 /// @param From The path to copy from.
400 /// @param ToFD The open file descriptor of the destination file.
401 std::error_code copy_file(const Twine &From, int ToFD);
403 /// Resize path to size. File is resized as if by POSIX truncate().
405 /// @param FD Input file descriptor.
406 /// @param Size Size to resize to.
407 /// @returns errc::success if \a path has been resized to \a size, otherwise a
408 /// platform-specific error_code.
409 std::error_code resize_file(int FD, uint64_t Size);
411 /// Compute an MD5 hash of a file's contents.
413 /// @param FD Input file descriptor.
414 /// @returns An MD5Result with the hash computed, if successful, otherwise a
416 ErrorOr<MD5::MD5Result> md5_contents(int FD);
418 /// Version of compute_md5 that doesn't require an open file descriptor.
419 ErrorOr<MD5::MD5Result> md5_contents(const Twine &Path);
422 /// @name Physical Observers
427 /// @param status A basic_file_status previously returned from stat.
428 /// @returns True if the file represented by status exists, false if it does
430 bool exists(const basic_file_status &status);
432 enum class AccessMode { Exist, Write, Execute };
434 /// Can the file be accessed?
436 /// @param Path Input path.
437 /// @returns errc::success if the path can be accessed, otherwise a
438 /// platform-specific error_code.
439 std::error_code access(const Twine &Path, AccessMode Mode);
443 /// @param Path Input path.
444 /// @returns True if it exists, false otherwise.
445 inline bool exists(const Twine &Path) {
446 return !access(Path, AccessMode::Exist);
449 /// Can we execute this file?
451 /// @param Path Input path.
452 /// @returns True if we can execute it, false otherwise.
453 bool can_execute(const Twine &Path);
455 /// Can we write this file?
457 /// @param Path Input path.
458 /// @returns True if we can write to it, false otherwise.
459 inline bool can_write(const Twine &Path) {
460 return !access(Path, AccessMode::Write);
463 /// Do file_status's represent the same thing?
465 /// @param A Input file_status.
466 /// @param B Input file_status.
468 /// assert(status_known(A) || status_known(B));
470 /// @returns True if A and B both represent the same file system entity, false
472 bool equivalent(file_status A, file_status B);
474 /// Do paths represent the same thing?
476 /// assert(status_known(A) || status_known(B));
478 /// @param A Input path A.
479 /// @param B Input path B.
480 /// @param result Set to true if stat(A) and stat(B) have the same device and
481 /// inode (or equivalent).
482 /// @returns errc::success if result has been successfully set, otherwise a
483 /// platform-specific error_code.
484 std::error_code equivalent(const Twine &A, const Twine &B, bool &result);
486 /// Simpler version of equivalent for clients that don't need to
487 /// differentiate between an error and false.
488 inline bool equivalent(const Twine &A, const Twine &B) {
490 return !equivalent(A, B, result) && result;
493 /// Is the file mounted on a local filesystem?
495 /// @param path Input path.
496 /// @param result Set to true if \a path is on fixed media such as a hard disk,
497 /// false if it is not.
498 /// @returns errc::success if result has been successfully set, otherwise a
499 /// platform specific error_code.
500 std::error_code is_local(const Twine &path, bool &result);
502 /// Version of is_local accepting an open file descriptor.
503 std::error_code is_local(int FD, bool &result);
505 /// Simpler version of is_local for clients that don't need to
506 /// differentiate between an error and false.
507 inline bool is_local(const Twine &Path) {
509 return !is_local(Path, Result) && Result;
512 /// Simpler version of is_local accepting an open file descriptor for
513 /// clients that don't need to differentiate between an error and false.
514 inline bool is_local(int FD) {
516 return !is_local(FD, Result) && Result;
519 /// Does status represent a directory?
521 /// @param Path The path to get the type of.
522 /// @param Follow For symbolic links, indicates whether to return the file type
523 /// of the link itself, or of the target.
524 /// @returns A value from the file_type enumeration indicating the type of file.
525 file_type get_file_type(const Twine &Path, bool Follow = true);
527 /// Does status represent a directory?
529 /// @param status A basic_file_status previously returned from status.
530 /// @returns status.type() == file_type::directory_file.
531 bool is_directory(const basic_file_status &status);
533 /// Is path a directory?
535 /// @param path Input path.
536 /// @param result Set to true if \a path is a directory (after following
537 /// symlinks, false if it is not. Undefined otherwise.
538 /// @returns errc::success if result has been successfully set, otherwise a
539 /// platform-specific error_code.
540 std::error_code is_directory(const Twine &path, bool &result);
542 /// Simpler version of is_directory for clients that don't need to
543 /// differentiate between an error and false.
544 inline bool is_directory(const Twine &Path) {
546 return !is_directory(Path, Result) && Result;
549 /// Does status represent a regular file?
551 /// @param status A basic_file_status previously returned from status.
552 /// @returns status_known(status) && status.type() == file_type::regular_file.
553 bool is_regular_file(const basic_file_status &status);
555 /// Is path a regular file?
557 /// @param path Input path.
558 /// @param result Set to true if \a path is a regular file (after following
559 /// symlinks), false if it is not. Undefined otherwise.
560 /// @returns errc::success if result has been successfully set, otherwise a
561 /// platform-specific error_code.
562 std::error_code is_regular_file(const Twine &path, bool &result);
564 /// Simpler version of is_regular_file for clients that don't need to
565 /// differentiate between an error and false.
566 inline bool is_regular_file(const Twine &Path) {
568 if (is_regular_file(Path, Result))
573 /// Does status represent a symlink file?
575 /// @param status A basic_file_status previously returned from status.
576 /// @returns status_known(status) && status.type() == file_type::symlink_file.
577 bool is_symlink_file(const basic_file_status &status);
579 /// Is path a symlink file?
581 /// @param path Input path.
582 /// @param result Set to true if \a path is a symlink file, false if it is not.
583 /// Undefined otherwise.
584 /// @returns errc::success if result has been successfully set, otherwise a
585 /// platform-specific error_code.
586 std::error_code is_symlink_file(const Twine &path, bool &result);
588 /// Simpler version of is_symlink_file for clients that don't need to
589 /// differentiate between an error and false.
590 inline bool is_symlink_file(const Twine &Path) {
592 if (is_symlink_file(Path, Result))
597 /// Does this status represent something that exists but is not a
598 /// directory or regular file?
600 /// @param status A basic_file_status previously returned from status.
601 /// @returns exists(s) && !is_regular_file(s) && !is_directory(s)
602 bool is_other(const basic_file_status &status);
604 /// Is path something that exists but is not a directory,
605 /// regular file, or symlink?
607 /// @param path Input path.
608 /// @param result Set to true if \a path exists, but is not a directory, regular
609 /// file, or a symlink, false if it does not. Undefined otherwise.
610 /// @returns errc::success if result has been successfully set, otherwise a
611 /// platform-specific error_code.
612 std::error_code is_other(const Twine &path, bool &result);
614 /// Get file status as if by POSIX stat().
616 /// @param path Input path.
617 /// @param result Set to the file status.
618 /// @param follow When true, follows symlinks. Otherwise, the symlink itself is
620 /// @returns errc::success if result has been successfully set, otherwise a
621 /// platform-specific error_code.
622 std::error_code status(const Twine &path, file_status &result,
625 /// A version for when a file descriptor is already available.
626 std::error_code status(int FD, file_status &Result);
628 /// Set file permissions.
630 /// @param Path File to set permissions on.
631 /// @param Permissions New file permissions.
632 /// @returns errc::success if the permissions were successfully set, otherwise
633 /// a platform-specific error_code.
634 /// @note On Windows, all permissions except *_write are ignored. Using any of
635 /// owner_write, group_write, or all_write will make the file writable.
636 /// Otherwise, the file will be marked as read-only.
637 std::error_code setPermissions(const Twine &Path, perms Permissions);
639 /// Get file permissions.
641 /// @param Path File to get permissions from.
642 /// @returns the permissions if they were successfully retrieved, otherwise a
643 /// platform-specific error_code.
644 /// @note On Windows, if the file does not have the FILE_ATTRIBUTE_READONLY
645 /// attribute, all_all will be returned. Otherwise, all_read | all_exe
646 /// will be returned.
647 ErrorOr<perms> getPermissions(const Twine &Path);
651 /// @param Path Input path.
652 /// @param Result Set to the size of the file in \a Path.
653 /// @returns errc::success if result has been successfully set, otherwise a
654 /// platform-specific error_code.
655 inline std::error_code file_size(const Twine &Path, uint64_t &Result) {
657 std::error_code EC = status(Path, Status);
660 Result = Status.getSize();
661 return std::error_code();
664 /// Set the file modification and access time.
666 /// @returns errc::success if the file times were successfully set, otherwise a
667 /// platform-specific error_code or errc::function_not_supported on
668 /// platforms where the functionality isn't available.
669 std::error_code setLastModificationAndAccessTime(int FD, TimePoint<> Time);
671 /// Is status available?
673 /// @param s Input file status.
674 /// @returns True if status() != status_error.
675 bool status_known(const basic_file_status &s);
677 /// Is status available?
679 /// @param path Input path.
680 /// @param result Set to true if status() != status_error.
681 /// @returns errc::success if result has been successfully set, otherwise a
682 /// platform-specific error_code.
683 std::error_code status_known(const Twine &path, bool &result);
685 enum CreationDisposition : unsigned {
686 /// CD_CreateAlways - When opening a file:
687 /// * If it already exists, truncate it.
688 /// * If it does not already exist, create a new file.
691 /// CD_CreateNew - When opening a file:
692 /// * If it already exists, fail.
693 /// * If it does not already exist, create a new file.
696 /// CD_OpenAlways - When opening a file:
697 /// * If it already exists, open the file with the offset set to 0.
698 /// * If it does not already exist, fail.
701 /// CD_OpenAlways - When opening a file:
702 /// * If it already exists, open the file with the offset set to 0.
703 /// * If it does not already exist, create a new file.
707 enum FileAccess : unsigned {
712 enum OpenFlags : unsigned {
714 F_None = 0, // For compatibility
716 /// The file should be opened in text mode on platforms that make this
719 F_Text = 1, // For compatibility
721 /// The file should be opened in append mode.
723 F_Append = 2, // For compatibility
725 /// Delete the file on close. Only makes a difference on windows.
728 /// When a child process is launched, this file should remain open in the
732 /// Force files Atime to be updated on access. Only makes a difference on windows.
736 /// Create a uniquely named file.
738 /// Generates a unique path suitable for a temporary file and then opens it as a
739 /// file. The name is based on \a model with '%' replaced by a random char in
740 /// [0-9a-f]. If \a model is not an absolute path, the temporary file will be
741 /// created in the current directory.
743 /// Example: clang-%%-%%-%%-%%-%%.s => clang-a0-b1-c2-d3-e4.s
745 /// This is an atomic operation. Either the file is created and opened, or the
746 /// file system is left untouched.
748 /// The intended use is for files that are to be kept, possibly after
749 /// renaming them. For example, when running 'clang -c foo.o', the file can
750 /// be first created as foo-abc123.o and then renamed.
752 /// @param Model Name to base unique path off of.
753 /// @param ResultFD Set to the opened file's file descriptor.
754 /// @param ResultPath Set to the opened file's absolute path.
755 /// @returns errc::success if Result{FD,Path} have been successfully set,
756 /// otherwise a platform-specific error_code.
757 std::error_code createUniqueFile(const Twine &Model, int &ResultFD,
758 SmallVectorImpl<char> &ResultPath,
759 unsigned Mode = all_read | all_write);
761 /// Simpler version for clients that don't want an open file. An empty
762 /// file will still be created.
763 std::error_code createUniqueFile(const Twine &Model,
764 SmallVectorImpl<char> &ResultPath,
765 unsigned Mode = all_read | all_write);
767 /// Represents a temporary file.
769 /// The temporary file must be eventually discarded or given a final name and
772 /// The destructor doesn't implicitly discard because there is no way to
773 /// properly handle errors in a destructor.
776 TempFile(StringRef Name, int FD);
779 /// This creates a temporary file with createUniqueFile and schedules it for
780 /// deletion with sys::RemoveFileOnSignal.
781 static Expected<TempFile> create(const Twine &Model,
782 unsigned Mode = all_read | all_write);
783 TempFile(TempFile &&Other);
784 TempFile &operator=(TempFile &&Other);
786 // Name of the temporary file.
789 // The open file descriptor.
792 // Keep this with the given name.
793 Error keep(const Twine &Name);
795 // Keep this with the temporary name.
801 // This checks that keep or delete was called.
805 /// Create a file in the system temporary directory.
807 /// The filename is of the form prefix-random_chars.suffix. Since the directory
808 /// is not know to the caller, Prefix and Suffix cannot have path separators.
809 /// The files are created with mode 0600.
811 /// This should be used for things like a temporary .s that is removed after
812 /// running the assembler.
813 std::error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
815 SmallVectorImpl<char> &ResultPath);
817 /// Simpler version for clients that don't want an open file. An empty
818 /// file will still be created.
819 std::error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
820 SmallVectorImpl<char> &ResultPath);
822 std::error_code createUniqueDirectory(const Twine &Prefix,
823 SmallVectorImpl<char> &ResultPath);
825 /// Get a unique name, not currently exisiting in the filesystem. Subject
826 /// to race conditions, prefer to use createUniqueFile instead.
828 /// Similar to createUniqueFile, but instead of creating a file only
829 /// checks if it exists. This function is subject to race conditions, if you
830 /// want to use the returned name to actually create a file, use
831 /// createUniqueFile instead.
832 std::error_code getPotentiallyUniqueFileName(const Twine &Model,
833 SmallVectorImpl<char> &ResultPath);
835 /// Get a unique temporary file name, not currently exisiting in the
836 /// filesystem. Subject to race conditions, prefer to use createTemporaryFile
839 /// Similar to createTemporaryFile, but instead of creating a file only
840 /// checks if it exists. This function is subject to race conditions, if you
841 /// want to use the returned name to actually create a file, use
842 /// createTemporaryFile instead.
844 getPotentiallyUniqueTempFileName(const Twine &Prefix, StringRef Suffix,
845 SmallVectorImpl<char> &ResultPath);
847 inline OpenFlags operator|(OpenFlags A, OpenFlags B) {
848 return OpenFlags(unsigned(A) | unsigned(B));
851 inline OpenFlags &operator|=(OpenFlags &A, OpenFlags B) {
856 inline FileAccess operator|(FileAccess A, FileAccess B) {
857 return FileAccess(unsigned(A) | unsigned(B));
860 inline FileAccess &operator|=(FileAccess &A, FileAccess B) {
865 /// @brief Opens a file with the specified creation disposition, access mode,
866 /// and flags and returns a file descriptor.
868 /// The caller is responsible for closing the file descriptor once they are
869 /// finished with it.
871 /// @param Name The path of the file to open, relative or absolute.
872 /// @param ResultFD If the file could be opened successfully, its descriptor
873 /// is stored in this location. Otherwise, this is set to -1.
874 /// @param Disp Value specifying the existing-file behavior.
875 /// @param Access Value specifying whether to open the file in read, write, or
877 /// @param Flags Additional flags.
878 /// @param Mode The access permissions of the file, represented in octal.
879 /// @returns errc::success if \a Name has been opened, otherwise a
880 /// platform-specific error_code.
881 std::error_code openFile(const Twine &Name, int &ResultFD,
882 CreationDisposition Disp, FileAccess Access,
883 OpenFlags Flags, unsigned Mode = 0666);
885 /// @brief Opens a file with the specified creation disposition, access mode,
886 /// and flags and returns a platform-specific file object.
888 /// The caller is responsible for closing the file object once they are
889 /// finished with it.
891 /// @param Name The path of the file to open, relative or absolute.
892 /// @param Disp Value specifying the existing-file behavior.
893 /// @param Access Value specifying whether to open the file in read, write, or
895 /// @param Flags Additional flags.
896 /// @param Mode The access permissions of the file, represented in octal.
897 /// @returns errc::success if \a Name has been opened, otherwise a
898 /// platform-specific error_code.
899 Expected<file_t> openNativeFile(const Twine &Name, CreationDisposition Disp,
900 FileAccess Access, OpenFlags Flags,
901 unsigned Mode = 0666);
903 /// @brief Opens the file with the given name in a write-only or read-write
904 /// mode, returning its open file descriptor. If the file does not exist, it
907 /// The caller is responsible for closing the file descriptor once they are
908 /// finished with it.
910 /// @param Name The path of the file to open, relative or absolute.
911 /// @param ResultFD If the file could be opened successfully, its descriptor
912 /// is stored in this location. Otherwise, this is set to -1.
913 /// @param Flags Additional flags used to determine whether the file should be
914 /// opened in, for example, read-write or in write-only mode.
915 /// @param Mode The access permissions of the file, represented in octal.
916 /// @returns errc::success if \a Name has been opened, otherwise a
917 /// platform-specific error_code.
918 inline std::error_code
919 openFileForWrite(const Twine &Name, int &ResultFD,
920 CreationDisposition Disp = CD_CreateAlways,
921 OpenFlags Flags = OF_None, unsigned Mode = 0666) {
922 return openFile(Name, ResultFD, Disp, FA_Write, Flags, Mode);
925 /// @brief Opens the file with the given name in a write-only or read-write
926 /// mode, returning its open file descriptor. If the file does not exist, it
929 /// The caller is responsible for closing the freeing the file once they are
930 /// finished with it.
932 /// @param Name The path of the file to open, relative or absolute.
933 /// @param Flags Additional flags used to determine whether the file should be
934 /// opened in, for example, read-write or in write-only mode.
935 /// @param Mode The access permissions of the file, represented in octal.
936 /// @returns a platform-specific file descriptor if \a Name has been opened,
937 /// otherwise an error object.
938 inline Expected<file_t> openNativeFileForWrite(const Twine &Name,
939 CreationDisposition Disp,
941 unsigned Mode = 0666) {
942 return openNativeFile(Name, Disp, FA_Write, Flags, Mode);
945 /// @brief Opens the file with the given name in a write-only or read-write
946 /// mode, returning its open file descriptor. If the file does not exist, it
949 /// The caller is responsible for closing the file descriptor once they are
950 /// finished with it.
952 /// @param Name The path of the file to open, relative or absolute.
953 /// @param ResultFD If the file could be opened successfully, its descriptor
954 /// is stored in this location. Otherwise, this is set to -1.
955 /// @param Flags Additional flags used to determine whether the file should be
956 /// opened in, for example, read-write or in write-only mode.
957 /// @param Mode The access permissions of the file, represented in octal.
958 /// @returns errc::success if \a Name has been opened, otherwise a
959 /// platform-specific error_code.
960 inline std::error_code openFileForReadWrite(const Twine &Name, int &ResultFD,
961 CreationDisposition Disp,
963 unsigned Mode = 0666) {
964 return openFile(Name, ResultFD, Disp, FA_Write | FA_Read, Flags, Mode);
967 /// @brief Opens the file with the given name in a write-only or read-write
968 /// mode, returning its open file descriptor. If the file does not exist, it
971 /// The caller is responsible for closing the freeing the file once they are
972 /// finished with it.
974 /// @param Name The path of the file to open, relative or absolute.
975 /// @param Flags Additional flags used to determine whether the file should be
976 /// opened in, for example, read-write or in write-only mode.
977 /// @param Mode The access permissions of the file, represented in octal.
978 /// @returns a platform-specific file descriptor if \a Name has been opened,
979 /// otherwise an error object.
980 inline Expected<file_t> openNativeFileForReadWrite(const Twine &Name,
981 CreationDisposition Disp,
983 unsigned Mode = 0666) {
984 return openNativeFile(Name, Disp, FA_Write | FA_Read, Flags, Mode);
987 /// @brief Opens the file with the given name in a read-only mode, returning
988 /// its open file descriptor.
990 /// The caller is responsible for closing the file descriptor once they are
991 /// finished with it.
993 /// @param Name The path of the file to open, relative or absolute.
994 /// @param ResultFD If the file could be opened successfully, its descriptor
995 /// is stored in this location. Otherwise, this is set to -1.
996 /// @param RealPath If nonnull, extra work is done to determine the real path
997 /// of the opened file, and that path is stored in this
999 /// @returns errc::success if \a Name has been opened, otherwise a
1000 /// platform-specific error_code.
1001 std::error_code openFileForRead(const Twine &Name, int &ResultFD,
1002 OpenFlags Flags = OF_None,
1003 SmallVectorImpl<char> *RealPath = nullptr);
1005 /// @brief Opens the file with the given name in a read-only mode, returning
1006 /// its open file descriptor.
1008 /// The caller is responsible for closing the freeing the file once they are
1009 /// finished with it.
1011 /// @param Name The path of the file to open, relative or absolute.
1012 /// @param RealPath If nonnull, extra work is done to determine the real path
1013 /// of the opened file, and that path is stored in this
1015 /// @returns a platform-specific file descriptor if \a Name has been opened,
1016 /// otherwise an error object.
1018 openNativeFileForRead(const Twine &Name, OpenFlags Flags = OF_None,
1019 SmallVectorImpl<char> *RealPath = nullptr);
1021 /// @brief Close the file object. This should be used instead of ::close for
1024 /// @param F On input, this is the file to close. On output, the file is
1025 /// set to kInvalidFile.
1026 void closeFile(file_t &F);
1028 std::error_code getUniqueID(const Twine Path, UniqueID &Result);
1030 /// Get disk space usage information.
1032 /// Note: Users must be careful about "Time Of Check, Time Of Use" kind of bug.
1033 /// Note: Windows reports results according to the quota allocated to the user.
1035 /// @param Path Input path.
1036 /// @returns a space_info structure filled with the capacity, free, and
1037 /// available space on the device \a Path is on. A platform specific error_code
1038 /// is returned on error.
1039 ErrorOr<space_info> disk_space(const Twine &Path);
1041 /// This class represents a memory mapped file. It is based on
1042 /// boost::iostreams::mapped_file.
1043 class mapped_file_region {
1046 readonly, ///< May only access map via const_data as read only.
1047 readwrite, ///< May access map via data and modify it. Written to path.
1048 priv ///< May modify via data, but changes are lost on destruction.
1052 /// Platform-specific mapping state.
1060 std::error_code init(int FD, uint64_t Offset, mapmode Mode);
1063 mapped_file_region() = delete;
1064 mapped_file_region(mapped_file_region&) = delete;
1065 mapped_file_region &operator =(mapped_file_region&) = delete;
1067 /// \param fd An open file descriptor to map. mapped_file_region takes
1068 /// ownership if closefd is true. It must have been opended in the correct
1070 mapped_file_region(int fd, mapmode mode, size_t length, uint64_t offset,
1071 std::error_code &ec);
1073 ~mapped_file_region();
1075 size_t size() const;
1078 /// Get a const view of the data. Modifying this memory has undefined
1080 const char *const_data() const;
1082 /// \returns The minimum alignment offset must be.
1083 static int alignment();
1086 /// Return the path to the main executable, given the value of argv[0] from
1087 /// program startup and the address of main itself. In extremis, this function
1088 /// may fail and return an empty path.
1089 std::string getMainExecutable(const char *argv0, void *MainExecAddr);
1095 /// directory_entry - A single entry in a directory. Caches the status either
1096 /// from the result of the iteration syscall, or the first time status is
1098 class directory_entry {
1100 bool FollowSymlinks;
1101 basic_file_status Status;
1104 explicit directory_entry(const Twine &path, bool follow_symlinks = true,
1105 basic_file_status st = basic_file_status())
1106 : Path(path.str()), FollowSymlinks(follow_symlinks), Status(st) {}
1108 directory_entry() = default;
1110 void assign(const Twine &path, basic_file_status st = basic_file_status()) {
1115 void replace_filename(const Twine &filename,
1116 basic_file_status st = basic_file_status());
1118 const std::string &path() const { return Path; }
1119 ErrorOr<basic_file_status> status() const;
1121 bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
1122 bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
1123 bool operator< (const directory_entry& rhs) const;
1124 bool operator<=(const directory_entry& rhs) const;
1125 bool operator> (const directory_entry& rhs) const;
1126 bool operator>=(const directory_entry& rhs) const;
1131 struct DirIterState;
1133 std::error_code directory_iterator_construct(DirIterState &, StringRef, bool);
1134 std::error_code directory_iterator_increment(DirIterState &);
1135 std::error_code directory_iterator_destruct(DirIterState &);
1137 /// Keeps state for the directory_iterator.
1138 struct DirIterState {
1140 directory_iterator_destruct(*this);
1143 intptr_t IterationHandle = 0;
1144 directory_entry CurrentEntry;
1147 } // end namespace detail
1149 /// directory_iterator - Iterates through the entries in path. There is no
1150 /// operator++ because we need an error_code. If it's really needed we can make
1151 /// it call report_fatal_error on error.
1152 class directory_iterator {
1153 std::shared_ptr<detail::DirIterState> State;
1154 bool FollowSymlinks = true;
1157 explicit directory_iterator(const Twine &path, std::error_code &ec,
1158 bool follow_symlinks = true)
1159 : FollowSymlinks(follow_symlinks) {
1160 State = std::make_shared<detail::DirIterState>();
1161 SmallString<128> path_storage;
1162 ec = detail::directory_iterator_construct(
1163 *State, path.toStringRef(path_storage), FollowSymlinks);
1164 update_error_code_for_current_entry(ec);
1167 explicit directory_iterator(const directory_entry &de, std::error_code &ec,
1168 bool follow_symlinks = true)
1169 : FollowSymlinks(follow_symlinks) {
1170 State = std::make_shared<detail::DirIterState>();
1171 ec = detail::directory_iterator_construct(
1172 *State, de.path(), FollowSymlinks);
1173 update_error_code_for_current_entry(ec);
1176 /// Construct end iterator.
1177 directory_iterator() = default;
1179 // No operator++ because we need error_code.
1180 directory_iterator &increment(std::error_code &ec) {
1181 ec = directory_iterator_increment(*State);
1182 update_error_code_for_current_entry(ec);
1186 const directory_entry &operator*() const { return State->CurrentEntry; }
1187 const directory_entry *operator->() const { return &State->CurrentEntry; }
1189 bool operator==(const directory_iterator &RHS) const {
1190 if (State == RHS.State)
1193 return State->CurrentEntry == directory_entry();
1195 return RHS.State->CurrentEntry == directory_entry();
1196 return State->CurrentEntry == RHS.State->CurrentEntry;
1199 bool operator!=(const directory_iterator &RHS) const {
1200 return !(*this == RHS);
1202 // Other members as required by
1203 // C++ Std, 24.1.1 Input iterators [input.iterators]
1206 // Checks if current entry is valid and populates error code. For example,
1207 // current entry may not exist due to broken symbol links.
1208 void update_error_code_for_current_entry(std::error_code &ec) {
1209 // Bail out if error has already occured earlier to avoid overwriting it.
1213 // Empty directory entry is used to mark the end of an interation, it's not
1215 if (State->CurrentEntry == directory_entry())
1218 ErrorOr<basic_file_status> status = State->CurrentEntry.status();
1220 ec = status.getError();
1226 /// Keeps state for the recursive_directory_iterator.
1227 struct RecDirIterState {
1228 std::stack<directory_iterator, std::vector<directory_iterator>> Stack;
1230 bool HasNoPushRequest = false;
1233 } // end namespace detail
1235 /// recursive_directory_iterator - Same as directory_iterator except for it
1236 /// recurses down into child directories.
1237 class recursive_directory_iterator {
1238 std::shared_ptr<detail::RecDirIterState> State;
1242 recursive_directory_iterator() = default;
1243 explicit recursive_directory_iterator(const Twine &path, std::error_code &ec,
1244 bool follow_symlinks = true)
1245 : State(std::make_shared<detail::RecDirIterState>()),
1246 Follow(follow_symlinks) {
1247 State->Stack.push(directory_iterator(path, ec, Follow));
1248 if (State->Stack.top() == directory_iterator())
1252 // No operator++ because we need error_code.
1253 recursive_directory_iterator &increment(std::error_code &ec) {
1254 const directory_iterator end_itr = {};
1256 if (State->HasNoPushRequest)
1257 State->HasNoPushRequest = false;
1259 ErrorOr<basic_file_status> status = State->Stack.top()->status();
1260 if (status && is_directory(*status)) {
1261 State->Stack.push(directory_iterator(*State->Stack.top(), ec, Follow));
1262 if (State->Stack.top() != end_itr) {
1270 while (!State->Stack.empty()
1271 && State->Stack.top().increment(ec) == end_itr) {
1276 // Check if we are done. If so, create an end iterator.
1277 if (State->Stack.empty())
1283 const directory_entry &operator*() const { return *State->Stack.top(); }
1284 const directory_entry *operator->() const { return &*State->Stack.top(); }
1287 /// Gets the current level. Starting path is at level 0.
1288 int level() const { return State->Level; }
1290 /// Returns true if no_push has been called for this directory_entry.
1291 bool no_push_request() const { return State->HasNoPushRequest; }
1294 /// Goes up one level if Level > 0.
1296 assert(State && "Cannot pop an end iterator!");
1297 assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
1299 const directory_iterator end_itr = {};
1303 report_fatal_error("Error incrementing directory iterator.");
1306 } while (!State->Stack.empty()
1307 && State->Stack.top().increment(ec) == end_itr);
1309 // Check if we are done. If so, create an end iterator.
1310 if (State->Stack.empty())
1314 /// Does not go down into the current directory_entry.
1315 void no_push() { State->HasNoPushRequest = true; }
1317 bool operator==(const recursive_directory_iterator &RHS) const {
1318 return State == RHS.State;
1321 bool operator!=(const recursive_directory_iterator &RHS) const {
1322 return !(*this == RHS);
1324 // Other members as required by
1325 // C++ Std, 24.1.1 Input iterators [input.iterators]
1330 } // end namespace fs
1331 } // end namespace sys
1332 } // end namespace llvm
1334 #endif // LLVM_SUPPORT_FILESYSTEM_H