1 //===----------------------------------------------------------------------===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
10 #include <__utility/unreachable.h>
16 #include <string_view>
17 #include <type_traits>
20 #include "filesystem_common.h"
22 #include "posix_compat.h"
24 #if defined(_LIBCPP_WIN32API)
25 # define WIN32_LEAN_AND_MEAN
30 # include <sys/stat.h>
31 # include <sys/statvfs.h>
35 #include <fcntl.h> /* values for fchmodat */
37 #if __has_include(<sys/sendfile.h>)
38 # include <sys/sendfile.h>
39 # define _LIBCPP_FILESYSTEM_USE_SENDFILE
40 #elif defined(__APPLE__) || __has_include(<copyfile.h>)
41 # include <copyfile.h>
42 # define _LIBCPP_FILESYSTEM_USE_COPYFILE
45 # define _LIBCPP_FILESYSTEM_USE_FSTREAM
48 #if !defined(CLOCK_REALTIME) && !defined(_LIBCPP_WIN32API)
49 # include <sys/time.h> // for gettimeofday and timeval
52 #if defined(__ELF__) && defined(_LIBCPP_LINK_RT_LIB)
53 # pragma comment(lib, "rt")
56 _LIBCPP_BEGIN_NAMESPACE_FILESYSTEM
60 bool isSeparator(path::value_type C
) {
63 #if defined(_LIBCPP_WIN32API)
70 bool isDriveLetter(path::value_type C
) {
71 return (C
>= 'a' && C
<= 'z') || (C
>= 'A' && C
<= 'Z');
76 using string_view_t
= path::__string_view
;
77 using string_view_pair
= pair
<string_view_t
, string_view_t
>;
78 using PosPtr
= path::value_type
const*;
81 enum ParserState
: unsigned char {
82 // Zero is a special sentinel value used by default constructed iterators.
83 PS_BeforeBegin
= path::iterator::_BeforeBegin
,
84 PS_InRootName
= path::iterator::_InRootName
,
85 PS_InRootDir
= path::iterator::_InRootDir
,
86 PS_InFilenames
= path::iterator::_InFilenames
,
87 PS_InTrailingSep
= path::iterator::_InTrailingSep
,
88 PS_AtEnd
= path::iterator::_AtEnd
91 const string_view_t Path
;
92 string_view_t RawEntry
;
96 PathParser(string_view_t P
, ParserState State
) noexcept
: Path(P
),
100 PathParser(string_view_t P
, string_view_t E
, unsigned char S
)
101 : Path(P
), RawEntry(E
), State(static_cast<ParserState
>(S
)) {
102 // S cannot be '0' or PS_BeforeBegin.
105 static PathParser
CreateBegin(string_view_t P
) noexcept
{
106 PathParser
PP(P
, PS_BeforeBegin
);
111 static PathParser
CreateEnd(string_view_t P
) noexcept
{
112 PathParser
PP(P
, PS_AtEnd
);
116 PosPtr
peek() const noexcept
{
117 auto TkEnd
= getNextTokenStartPos();
118 auto End
= getAfterBack();
119 return TkEnd
== End
? nullptr : TkEnd
;
122 void increment() noexcept
{
123 const PosPtr End
= getAfterBack();
124 const PosPtr Start
= getNextTokenStartPos();
126 return makeState(PS_AtEnd
);
129 case PS_BeforeBegin
: {
130 PosPtr TkEnd
= consumeRootName(Start
, End
);
132 return makeState(PS_InRootName
, Start
, TkEnd
);
134 _LIBCPP_FALLTHROUGH();
135 case PS_InRootName
: {
136 PosPtr TkEnd
= consumeAllSeparators(Start
, End
);
138 return makeState(PS_InRootDir
, Start
, TkEnd
);
140 return makeState(PS_InFilenames
, Start
, consumeName(Start
, End
));
143 return makeState(PS_InFilenames
, Start
, consumeName(Start
, End
));
145 case PS_InFilenames
: {
146 PosPtr SepEnd
= consumeAllSeparators(Start
, End
);
148 PosPtr TkEnd
= consumeName(SepEnd
, End
);
150 return makeState(PS_InFilenames
, SepEnd
, TkEnd
);
152 return makeState(PS_InTrailingSep
, Start
, SepEnd
);
155 case PS_InTrailingSep
:
156 return makeState(PS_AtEnd
);
159 __libcpp_unreachable();
163 void decrement() noexcept
{
164 const PosPtr REnd
= getBeforeFront();
165 const PosPtr RStart
= getCurrentTokenStartPos() - 1;
166 if (RStart
== REnd
) // we're decrementing the begin
167 return makeState(PS_BeforeBegin
);
171 // Try to consume a trailing separator or root directory first.
172 if (PosPtr SepEnd
= consumeAllSeparators(RStart
, REnd
)) {
174 return makeState(PS_InRootDir
, Path
.data(), RStart
+ 1);
175 PosPtr TkStart
= consumeRootName(SepEnd
, REnd
);
177 return makeState(PS_InRootDir
, RStart
, RStart
+ 1);
178 return makeState(PS_InTrailingSep
, SepEnd
+ 1, RStart
+ 1);
180 PosPtr TkStart
= consumeRootName(RStart
, REnd
);
182 return makeState(PS_InRootName
, TkStart
+ 1, RStart
+ 1);
183 TkStart
= consumeName(RStart
, REnd
);
184 return makeState(PS_InFilenames
, TkStart
+ 1, RStart
+ 1);
187 case PS_InTrailingSep
:
188 return makeState(PS_InFilenames
, consumeName(RStart
, REnd
) + 1,
190 case PS_InFilenames
: {
191 PosPtr SepEnd
= consumeAllSeparators(RStart
, REnd
);
193 return makeState(PS_InRootDir
, Path
.data(), RStart
+ 1);
194 PosPtr TkStart
= consumeRootName(SepEnd
? SepEnd
: RStart
, REnd
);
195 if (TkStart
== REnd
) {
197 return makeState(PS_InRootDir
, SepEnd
+ 1, RStart
+ 1);
198 return makeState(PS_InRootName
, TkStart
+ 1, RStart
+ 1);
200 TkStart
= consumeName(SepEnd
, REnd
);
201 return makeState(PS_InFilenames
, TkStart
+ 1, SepEnd
+ 1);
204 return makeState(PS_InRootName
, Path
.data(), RStart
+ 1);
207 __libcpp_unreachable();
211 /// \brief Return a view with the "preferred representation" of the current
212 /// element. For example trailing separators are represented as a '.'
213 string_view_t
operator*() const noexcept
{
219 if (RawEntry
[0] == '\\')
223 case PS_InTrailingSep
:
229 __libcpp_unreachable();
232 explicit operator bool() const noexcept
{
233 return State
!= PS_BeforeBegin
&& State
!= PS_AtEnd
;
236 PathParser
& operator++() noexcept
{
241 PathParser
& operator--() noexcept
{
246 bool atEnd() const noexcept
{
247 return State
== PS_AtEnd
;
250 bool inRootDir() const noexcept
{
251 return State
== PS_InRootDir
;
254 bool inRootName() const noexcept
{
255 return State
== PS_InRootName
;
258 bool inRootPath() const noexcept
{
259 return inRootName() || inRootDir();
263 void makeState(ParserState NewState
, PosPtr Start
, PosPtr End
) noexcept
{
265 RawEntry
= string_view_t(Start
, End
- Start
);
267 void makeState(ParserState NewState
) noexcept
{
272 PosPtr
getAfterBack() const noexcept
{ return Path
.data() + Path
.size(); }
274 PosPtr
getBeforeFront() const noexcept
{ return Path
.data() - 1; }
276 /// \brief Return a pointer to the first character after the currently
278 PosPtr
getNextTokenStartPos() const noexcept
{
285 return &RawEntry
.back() + 1;
286 case PS_InTrailingSep
:
288 return getAfterBack();
290 __libcpp_unreachable();
293 /// \brief Return a pointer to the first character in the currently lexed
295 PosPtr
getCurrentTokenStartPos() const noexcept
{
299 return &Path
.front();
302 case PS_InTrailingSep
:
303 return &RawEntry
.front();
305 return &Path
.back() + 1;
307 __libcpp_unreachable();
310 // Consume all consecutive separators.
311 PosPtr
consumeAllSeparators(PosPtr P
, PosPtr End
) const noexcept
{
312 if (P
== nullptr || P
== End
|| !isSeparator(*P
))
314 const int Inc
= P
< End
? 1 : -1;
316 while (P
!= End
&& isSeparator(*P
))
321 // Consume exactly N separators, or return nullptr.
322 PosPtr
consumeNSeparators(PosPtr P
, PosPtr End
, int N
) const noexcept
{
323 PosPtr Ret
= consumeAllSeparators(P
, End
);
336 PosPtr
consumeName(PosPtr P
, PosPtr End
) const noexcept
{
338 if (P
== nullptr || P
== End
|| isSeparator(*P
))
340 const int Inc
= P
< End
? 1 : -1;
342 while (P
!= End
&& !isSeparator(*P
))
344 if (P
== End
&& Inc
< 0) {
345 // Iterating backwards and consumed all the rest of the input.
346 // Check if the start of the string would have been considered
348 PosPtr RootEnd
= consumeRootName(End
+ 1, Start
);
355 PosPtr
consumeDriveLetter(PosPtr P
, PosPtr End
) const noexcept
{
359 if (P
+ 1 == End
|| !isDriveLetter(P
[0]) || P
[1] != ':')
363 if (P
- 1 == End
|| !isDriveLetter(P
[-1]) || P
[0] != ':')
369 PosPtr
consumeNetworkRoot(PosPtr P
, PosPtr End
) const noexcept
{
373 return consumeName(consumeNSeparators(P
, End
, 2), End
);
375 return consumeNSeparators(consumeName(P
, End
), End
, 2);
378 PosPtr
consumeRootName(PosPtr P
, PosPtr End
) const noexcept
{
379 #if defined(_LIBCPP_WIN32API)
380 if (PosPtr Ret
= consumeDriveLetter(P
, End
))
382 if (PosPtr Ret
= consumeNetworkRoot(P
, End
))
389 string_view_pair
separate_filename(string_view_t
const& s
) {
390 if (s
== PS(".") || s
== PS("..") || s
.empty())
391 return string_view_pair
{s
, PS("")};
392 auto pos
= s
.find_last_of('.');
393 if (pos
== string_view_t::npos
|| pos
== 0)
394 return string_view_pair
{s
, string_view_t
{}};
395 return string_view_pair
{s
.substr(0, pos
), s
.substr(pos
)};
398 string_view_t
createView(PosPtr S
, PosPtr E
) noexcept
{
399 return {S
, static_cast<size_t>(E
- S
) + 1};
402 } // namespace parser
407 #if defined(_LIBCPP_WIN32API)
410 errc
__win_err_to_errc(int err
) {
414 } win_error_mapping
[] = {
415 {ERROR_ACCESS_DENIED
, errc::permission_denied
},
416 {ERROR_ALREADY_EXISTS
, errc::file_exists
},
417 {ERROR_BAD_NETPATH
, errc::no_such_file_or_directory
},
418 {ERROR_BAD_PATHNAME
, errc::no_such_file_or_directory
},
419 {ERROR_BAD_UNIT
, errc::no_such_device
},
420 {ERROR_BROKEN_PIPE
, errc::broken_pipe
},
421 {ERROR_BUFFER_OVERFLOW
, errc::filename_too_long
},
422 {ERROR_BUSY
, errc::device_or_resource_busy
},
423 {ERROR_BUSY_DRIVE
, errc::device_or_resource_busy
},
424 {ERROR_CANNOT_MAKE
, errc::permission_denied
},
425 {ERROR_CANTOPEN
, errc::io_error
},
426 {ERROR_CANTREAD
, errc::io_error
},
427 {ERROR_CANTWRITE
, errc::io_error
},
428 {ERROR_CURRENT_DIRECTORY
, errc::permission_denied
},
429 {ERROR_DEV_NOT_EXIST
, errc::no_such_device
},
430 {ERROR_DEVICE_IN_USE
, errc::device_or_resource_busy
},
431 {ERROR_DIR_NOT_EMPTY
, errc::directory_not_empty
},
432 {ERROR_DIRECTORY
, errc::invalid_argument
},
433 {ERROR_DISK_FULL
, errc::no_space_on_device
},
434 {ERROR_FILE_EXISTS
, errc::file_exists
},
435 {ERROR_FILE_NOT_FOUND
, errc::no_such_file_or_directory
},
436 {ERROR_HANDLE_DISK_FULL
, errc::no_space_on_device
},
437 {ERROR_INVALID_ACCESS
, errc::permission_denied
},
438 {ERROR_INVALID_DRIVE
, errc::no_such_device
},
439 {ERROR_INVALID_FUNCTION
, errc::function_not_supported
},
440 {ERROR_INVALID_HANDLE
, errc::invalid_argument
},
441 {ERROR_INVALID_NAME
, errc::no_such_file_or_directory
},
442 {ERROR_INVALID_PARAMETER
, errc::invalid_argument
},
443 {ERROR_LOCK_VIOLATION
, errc::no_lock_available
},
444 {ERROR_LOCKED
, errc::no_lock_available
},
445 {ERROR_NEGATIVE_SEEK
, errc::invalid_argument
},
446 {ERROR_NOACCESS
, errc::permission_denied
},
447 {ERROR_NOT_ENOUGH_MEMORY
, errc::not_enough_memory
},
448 {ERROR_NOT_READY
, errc::resource_unavailable_try_again
},
449 {ERROR_NOT_SAME_DEVICE
, errc::cross_device_link
},
450 {ERROR_NOT_SUPPORTED
, errc::not_supported
},
451 {ERROR_OPEN_FAILED
, errc::io_error
},
452 {ERROR_OPEN_FILES
, errc::device_or_resource_busy
},
453 {ERROR_OPERATION_ABORTED
, errc::operation_canceled
},
454 {ERROR_OUTOFMEMORY
, errc::not_enough_memory
},
455 {ERROR_PATH_NOT_FOUND
, errc::no_such_file_or_directory
},
456 {ERROR_READ_FAULT
, errc::io_error
},
457 {ERROR_REPARSE_TAG_INVALID
, errc::invalid_argument
},
458 {ERROR_RETRY
, errc::resource_unavailable_try_again
},
459 {ERROR_SEEK
, errc::io_error
},
460 {ERROR_SHARING_VIOLATION
, errc::permission_denied
},
461 {ERROR_TOO_MANY_OPEN_FILES
, errc::too_many_files_open
},
462 {ERROR_WRITE_FAULT
, errc::io_error
},
463 {ERROR_WRITE_PROTECT
, errc::permission_denied
},
466 for (const auto &pair
: win_error_mapping
)
467 if (pair
.win
== static_cast<DWORD
>(err
))
469 return errc::invalid_argument
;
472 } // namespace detail
478 using value_type
= path::value_type
;
479 using string_type
= path::string_type
;
481 struct FileDescriptor
{
485 file_status m_status
;
487 template <class... Args
>
488 static FileDescriptor
create(const path
* p
, error_code
& ec
, Args
... args
) {
491 if ((fd
= detail::open(p
->c_str(), args
...)) == -1) {
492 ec
= capture_errno();
493 return FileDescriptor
{p
};
495 return FileDescriptor(p
, fd
);
498 template <class... Args
>
499 static FileDescriptor
create_with_status(const path
* p
, error_code
& ec
,
501 FileDescriptor fd
= create(p
, ec
, args
...);
503 fd
.refresh_status(ec
);
508 file_status
get_status() const { return m_status
; }
509 StatT
const& get_stat() const { return m_stat
; }
511 bool status_known() const { return _VSTD_FS::status_known(m_status
); }
513 file_status
refresh_status(error_code
& ec
);
515 void close() noexcept
{
521 FileDescriptor(FileDescriptor
&& other
)
522 : name(other
.name
), fd(other
.fd
), m_stat(other
.m_stat
),
523 m_status(other
.m_status
) {
525 other
.m_status
= file_status
{};
528 ~FileDescriptor() { close(); }
530 FileDescriptor(FileDescriptor
const&) = delete;
531 FileDescriptor
& operator=(FileDescriptor
const&) = delete;
534 explicit FileDescriptor(const path
* p
, int fd
= -1) : name(*p
), fd(fd
) {}
537 perms
posix_get_perms(const StatT
& st
) noexcept
{
538 return static_cast<perms
>(st
.st_mode
) & perms::mask
;
541 file_status
create_file_status(error_code
& m_ec
, path
const& p
,
542 const StatT
& path_stat
, error_code
* ec
) {
545 if (m_ec
&& (m_ec
.value() == ENOENT
|| m_ec
.value() == ENOTDIR
)) {
546 return file_status(file_type::not_found
);
548 ErrorHandler
<void> err("posix_stat", ec
, &p
);
549 err
.report(m_ec
, "failed to determine attributes for the specified path");
550 return file_status(file_type::none
);
555 auto const mode
= path_stat
.st_mode
;
557 fs_tmp
.type(file_type::symlink
);
558 else if (S_ISREG(mode
))
559 fs_tmp
.type(file_type::regular
);
560 else if (S_ISDIR(mode
))
561 fs_tmp
.type(file_type::directory
);
562 else if (S_ISBLK(mode
))
563 fs_tmp
.type(file_type::block
);
564 else if (S_ISCHR(mode
))
565 fs_tmp
.type(file_type::character
);
566 else if (S_ISFIFO(mode
))
567 fs_tmp
.type(file_type::fifo
);
568 else if (S_ISSOCK(mode
))
569 fs_tmp
.type(file_type::socket
);
571 fs_tmp
.type(file_type::unknown
);
573 fs_tmp
.permissions(detail::posix_get_perms(path_stat
));
577 file_status
posix_stat(path
const& p
, StatT
& path_stat
, error_code
* ec
) {
579 if (detail::stat(p
.c_str(), &path_stat
) == -1)
580 m_ec
= detail::capture_errno();
581 return create_file_status(m_ec
, p
, path_stat
, ec
);
584 file_status
posix_stat(path
const& p
, error_code
* ec
) {
586 return posix_stat(p
, path_stat
, ec
);
589 file_status
posix_lstat(path
const& p
, StatT
& path_stat
, error_code
* ec
) {
591 if (detail::lstat(p
.c_str(), &path_stat
) == -1)
592 m_ec
= detail::capture_errno();
593 return create_file_status(m_ec
, p
, path_stat
, ec
);
596 file_status
posix_lstat(path
const& p
, error_code
* ec
) {
598 return posix_lstat(p
, path_stat
, ec
);
601 // http://pubs.opengroup.org/onlinepubs/9699919799/functions/ftruncate.html
602 bool posix_ftruncate(const FileDescriptor
& fd
, off_t to_size
, error_code
& ec
) {
603 if (detail::ftruncate(fd
.fd
, to_size
) == -1) {
604 ec
= capture_errno();
611 bool posix_fchmod(const FileDescriptor
& fd
, const StatT
& st
, error_code
& ec
) {
612 if (detail::fchmod(fd
.fd
, st
.st_mode
) == -1) {
613 ec
= capture_errno();
620 bool stat_equivalent(const StatT
& st1
, const StatT
& st2
) {
621 return (st1
.st_dev
== st2
.st_dev
&& st1
.st_ino
== st2
.st_ino
);
624 file_status
FileDescriptor::refresh_status(error_code
& ec
) {
625 // FD must be open and good.
626 m_status
= file_status
{};
629 if (detail::fstat(fd
, &m_stat
) == -1)
630 m_ec
= capture_errno();
631 m_status
= create_file_status(m_ec
, name
, m_stat
, &ec
);
635 } // end namespace detail
637 using detail::capture_errno
;
638 using detail::ErrorHandler
;
640 using detail::TimeSpec
;
641 using parser::createView
;
642 using parser::PathParser
;
643 using parser::string_view_t
;
645 const bool _FilesystemClock::is_steady
;
647 _FilesystemClock::time_point
_FilesystemClock::now() noexcept
{
648 typedef chrono::duration
<rep
> __secs
;
649 #if defined(_LIBCPP_WIN32API)
650 typedef chrono::duration
<rep
, nano
> __nsecs
;
652 GetSystemTimeAsFileTime(&time
);
653 TimeSpec tp
= detail::filetime_to_timespec(time
);
654 return time_point(__secs(tp
.tv_sec
) +
655 chrono::duration_cast
<duration
>(__nsecs(tp
.tv_nsec
)));
656 #elif defined(CLOCK_REALTIME)
657 typedef chrono::duration
<rep
, nano
> __nsecs
;
659 if (0 != clock_gettime(CLOCK_REALTIME
, &tp
))
660 __throw_system_error(errno
, "clock_gettime(CLOCK_REALTIME) failed");
661 return time_point(__secs(tp
.tv_sec
) +
662 chrono::duration_cast
<duration
>(__nsecs(tp
.tv_nsec
)));
664 typedef chrono::duration
<rep
, micro
> __microsecs
;
666 gettimeofday(&tv
, 0);
667 return time_point(__secs(tv
.tv_sec
) + __microsecs(tv
.tv_usec
));
668 #endif // CLOCK_REALTIME
671 filesystem_error::~filesystem_error() {}
673 void filesystem_error::__create_what(int __num_paths
) {
674 const char* derived_what
= system_error::what();
675 __storage_
->__what_
= [&]() -> string
{
676 switch (__num_paths
) {
678 return detail::format_string("filesystem error: %s", derived_what
);
680 return detail::format_string("filesystem error: %s [" PATH_CSTR_FMT
"]",
681 derived_what
, path1().c_str());
683 return detail::format_string("filesystem error: %s [" PATH_CSTR_FMT
"] [" PATH_CSTR_FMT
"]",
684 derived_what
, path1().c_str(), path2().c_str());
686 __libcpp_unreachable();
690 static path
__do_absolute(const path
& p
, path
* cwd
, error_code
* ec
) {
695 *cwd
= __current_path(ec
);
701 path
__absolute(const path
& p
, error_code
* ec
) {
703 return __do_absolute(p
, &cwd
, ec
);
706 path
__canonical(path
const& orig_p
, error_code
* ec
) {
708 ErrorHandler
<path
> err("canonical", ec
, &orig_p
, &cwd
);
710 path p
= __do_absolute(orig_p
, &cwd
, ec
);
711 #if (defined(_POSIX_VERSION) && _POSIX_VERSION >= 200112) || defined(_LIBCPP_WIN32API)
712 std::unique_ptr
<path::value_type
, decltype(&::free
)>
713 hold(detail::realpath(p
.c_str(), nullptr), &::free
);
714 if (hold
.get() == nullptr)
715 return err
.report(capture_errno());
718 #if defined(__MVS__) && !defined(PATH_MAX)
719 path::value_type buff
[ _XOPEN_PATH_MAX
+ 1 ];
721 path::value_type buff
[PATH_MAX
+ 1];
723 path::value_type
* ret
;
724 if ((ret
= detail::realpath(p
.c_str(), buff
)) == nullptr)
725 return err
.report(capture_errno());
730 void __copy(const path
& from
, const path
& to
, copy_options options
,
732 ErrorHandler
<void> err("copy", ec
, &from
, &to
);
734 const bool sym_status
= bool(
735 options
& (copy_options::create_symlinks
| copy_options::skip_symlinks
));
737 const bool sym_status2
= bool(options
& copy_options::copy_symlinks
);
741 const file_status f
= sym_status
|| sym_status2
742 ? detail::posix_lstat(from
, f_st
, &m_ec1
)
743 : detail::posix_stat(from
, f_st
, &m_ec1
);
745 return err
.report(m_ec1
);
748 const file_status t
= sym_status
? detail::posix_lstat(to
, t_st
, &m_ec1
)
749 : detail::posix_stat(to
, t_st
, &m_ec1
);
751 if (not status_known(t
))
752 return err
.report(m_ec1
);
754 if (!exists(f
) || is_other(f
) || is_other(t
) ||
755 (is_directory(f
) && is_regular_file(t
)) ||
756 detail::stat_equivalent(f_st
, t_st
)) {
757 return err
.report(errc::function_not_supported
);
764 if (bool(copy_options::skip_symlinks
& options
)) {
766 } else if (not exists(t
)) {
767 __copy_symlink(from
, to
, ec
);
769 return err
.report(errc::file_exists
);
772 } else if (is_regular_file(f
)) {
773 if (bool(copy_options::directories_only
& options
)) {
775 } else if (bool(copy_options::create_symlinks
& options
)) {
776 __create_symlink(from
, to
, ec
);
777 } else if (bool(copy_options::create_hard_links
& options
)) {
778 __create_hard_link(from
, to
, ec
);
779 } else if (is_directory(t
)) {
780 __copy_file(from
, to
/ from
.filename(), options
, ec
);
782 __copy_file(from
, to
, options
, ec
);
785 } else if (is_directory(f
) && bool(copy_options::create_symlinks
& options
)) {
786 return err
.report(errc::is_a_directory
);
787 } else if (is_directory(f
) && (bool(copy_options::recursive
& options
) ||
788 copy_options::none
== options
)) {
791 // create directory to with attributes from 'from'.
792 __create_directory(to
, from
, ec
);
797 directory_iterator it
=
798 ec
? directory_iterator(from
, *ec
) : directory_iterator(from
);
803 for (; it
!= directory_iterator(); it
.increment(m_ec2
)) {
805 return err
.report(m_ec2
);
807 __copy(it
->path(), to
/ it
->path().filename(),
808 options
| copy_options::__in_recursive_copy
, ec
);
819 #if defined(_LIBCPP_FILESYSTEM_USE_SENDFILE)
820 bool copy_file_impl(FileDescriptor
& read_fd
, FileDescriptor
& write_fd
, error_code
& ec
) {
821 size_t count
= read_fd
.get_stat().st_size
;
824 if ((res
= ::sendfile(write_fd
.fd
, read_fd
.fd
, nullptr, count
)) == -1) {
825 ec
= capture_errno();
835 #elif defined(_LIBCPP_FILESYSTEM_USE_COPYFILE)
836 bool copy_file_impl(FileDescriptor
& read_fd
, FileDescriptor
& write_fd
, error_code
& ec
) {
837 struct CopyFileState
{
838 copyfile_state_t state
;
839 CopyFileState() { state
= copyfile_state_alloc(); }
840 ~CopyFileState() { copyfile_state_free(state
); }
843 CopyFileState(CopyFileState
const&) = delete;
844 CopyFileState
& operator=(CopyFileState
const&) = delete;
848 if (fcopyfile(read_fd
.fd
, write_fd
.fd
, cfs
.state
, COPYFILE_DATA
) < 0) {
849 ec
= capture_errno();
856 #elif defined(_LIBCPP_FILESYSTEM_USE_FSTREAM)
857 bool copy_file_impl(FileDescriptor
& read_fd
, FileDescriptor
& write_fd
, error_code
& ec
) {
859 in
.__open(read_fd
.fd
, ios::binary
);
861 // This assumes that __open didn't reset the error code.
862 ec
= capture_errno();
867 out
.__open(write_fd
.fd
, ios::binary
);
868 if (!out
.is_open()) {
869 ec
= capture_errno();
874 if (in
.good() && out
.good()) {
875 using InIt
= istreambuf_iterator
<char>;
876 using OutIt
= ostreambuf_iterator
<char>;
880 copy(bin
, ein
, bout
);
882 if (out
.fail() || in
.fail()) {
883 ec
= make_error_code(errc::io_error
);
891 # error "Unknown implementation for copy_file_impl"
892 #endif // copy_file_impl implementation
894 } // end anonymous namespace
895 } // end namespace detail
897 bool __copy_file(const path
& from
, const path
& to
, copy_options options
,
899 using detail::FileDescriptor
;
900 ErrorHandler
<bool> err("copy_file", ec
, &to
, &from
);
903 FileDescriptor from_fd
= FileDescriptor::create_with_status(
904 &from
, m_ec
, O_RDONLY
| O_NONBLOCK
| O_BINARY
);
906 return err
.report(m_ec
);
908 auto from_st
= from_fd
.get_status();
909 StatT
const& from_stat
= from_fd
.get_stat();
910 if (!is_regular_file(from_st
)) {
912 m_ec
= make_error_code(errc::not_supported
);
913 return err
.report(m_ec
);
916 const bool skip_existing
= bool(copy_options::skip_existing
& options
);
917 const bool update_existing
= bool(copy_options::update_existing
& options
);
918 const bool overwrite_existing
=
919 bool(copy_options::overwrite_existing
& options
);
922 file_status to_st
= detail::posix_stat(to
, to_stat_path
, &m_ec
);
923 if (!status_known(to_st
))
924 return err
.report(m_ec
);
926 const bool to_exists
= exists(to_st
);
927 if (to_exists
&& !is_regular_file(to_st
))
928 return err
.report(errc::not_supported
);
930 if (to_exists
&& detail::stat_equivalent(from_stat
, to_stat_path
))
931 return err
.report(errc::file_exists
);
933 if (to_exists
&& skip_existing
)
936 bool ShouldCopy
= [&]() {
937 if (to_exists
&& update_existing
) {
938 auto from_time
= detail::extract_mtime(from_stat
);
939 auto to_time
= detail::extract_mtime(to_stat_path
);
940 if (from_time
.tv_sec
< to_time
.tv_sec
)
942 if (from_time
.tv_sec
== to_time
.tv_sec
&&
943 from_time
.tv_nsec
<= to_time
.tv_nsec
)
947 if (!to_exists
|| overwrite_existing
)
949 return err
.report(errc::file_exists
);
954 // Don't truncate right away. We may not be opening the file we originally
955 // looked at; we'll check this later.
956 int to_open_flags
= O_WRONLY
| O_BINARY
;
958 to_open_flags
|= O_CREAT
;
959 FileDescriptor to_fd
= FileDescriptor::create_with_status(
960 &to
, m_ec
, to_open_flags
, from_stat
.st_mode
);
962 return err
.report(m_ec
);
965 // Check that the file we initially stat'ed is equivalent to the one
967 // FIXME: report this better.
968 if (!detail::stat_equivalent(to_stat_path
, to_fd
.get_stat()))
969 return err
.report(errc::bad_file_descriptor
);
971 // Set the permissions and truncate the file we opened.
972 if (detail::posix_fchmod(to_fd
, from_stat
, m_ec
))
973 return err
.report(m_ec
);
974 if (detail::posix_ftruncate(to_fd
, 0, m_ec
))
975 return err
.report(m_ec
);
978 if (!copy_file_impl(from_fd
, to_fd
, m_ec
)) {
979 // FIXME: Remove the dest file if we failed, and it didn't exist previously.
980 return err
.report(m_ec
);
986 void __copy_symlink(const path
& existing_symlink
, const path
& new_symlink
,
988 const path
real_path(__read_symlink(existing_symlink
, ec
));
992 #if defined(_LIBCPP_WIN32API)
994 if (is_directory(real_path
, local_ec
))
995 __create_directory_symlink(real_path
, new_symlink
, ec
);
998 __create_symlink(real_path
, new_symlink
, ec
);
1001 bool __create_directories(const path
& p
, error_code
* ec
) {
1002 ErrorHandler
<bool> err("create_directories", ec
, &p
);
1005 auto const st
= detail::posix_stat(p
, &m_ec
);
1006 if (!status_known(st
))
1007 return err
.report(m_ec
);
1008 else if (is_directory(st
))
1010 else if (exists(st
))
1011 return err
.report(errc::file_exists
);
1013 const path parent
= p
.parent_path();
1014 if (!parent
.empty()) {
1015 const file_status parent_st
= status(parent
, m_ec
);
1016 if (not status_known(parent_st
))
1017 return err
.report(m_ec
);
1018 if (not exists(parent_st
)) {
1020 return err
.report(errc::invalid_argument
);
1021 __create_directories(parent
, ec
);
1025 } else if (not is_directory(parent_st
))
1026 return err
.report(errc::not_a_directory
);
1028 bool ret
= __create_directory(p
, &m_ec
);
1030 return err
.report(m_ec
);
1034 bool __create_directory(const path
& p
, error_code
* ec
) {
1035 ErrorHandler
<bool> err("create_directory", ec
, &p
);
1037 if (detail::mkdir(p
.c_str(), static_cast<int>(perms::all
)) == 0)
1040 if (errno
!= EEXIST
)
1041 return err
.report(capture_errno());
1042 error_code mec
= capture_errno();
1043 error_code ignored_ec
;
1044 const file_status st
= status(p
, ignored_ec
);
1045 if (!is_directory(st
))
1046 return err
.report(mec
);
1050 bool __create_directory(path
const& p
, path
const& attributes
, error_code
* ec
) {
1051 ErrorHandler
<bool> err("create_directory", ec
, &p
, &attributes
);
1055 file_status st
= detail::posix_stat(attributes
, attr_stat
, &mec
);
1056 if (!status_known(st
))
1057 return err
.report(mec
);
1058 if (!is_directory(st
))
1059 return err
.report(errc::not_a_directory
,
1060 "the specified attribute path is invalid");
1062 if (detail::mkdir(p
.c_str(), attr_stat
.st_mode
) == 0)
1065 if (errno
!= EEXIST
)
1066 return err
.report(capture_errno());
1068 mec
= capture_errno();
1069 error_code ignored_ec
;
1070 st
= status(p
, ignored_ec
);
1071 if (!is_directory(st
))
1072 return err
.report(mec
);
1076 void __create_directory_symlink(path
const& from
, path
const& to
,
1078 ErrorHandler
<void> err("create_directory_symlink", ec
, &from
, &to
);
1079 if (detail::symlink_dir(from
.c_str(), to
.c_str()) == -1)
1080 return err
.report(capture_errno());
1083 void __create_hard_link(const path
& from
, const path
& to
, error_code
* ec
) {
1084 ErrorHandler
<void> err("create_hard_link", ec
, &from
, &to
);
1085 if (detail::link(from
.c_str(), to
.c_str()) == -1)
1086 return err
.report(capture_errno());
1089 void __create_symlink(path
const& from
, path
const& to
, error_code
* ec
) {
1090 ErrorHandler
<void> err("create_symlink", ec
, &from
, &to
);
1091 if (detail::symlink_file(from
.c_str(), to
.c_str()) == -1)
1092 return err
.report(capture_errno());
1095 path
__current_path(error_code
* ec
) {
1096 ErrorHandler
<path
> err("current_path", ec
);
1098 #if defined(_LIBCPP_WIN32API) || defined(__GLIBC__) || defined(__APPLE__)
1099 // Common extension outside of POSIX getcwd() spec, without needing to
1100 // preallocate a buffer. Also supported by a number of other POSIX libcs.
1102 path::value_type
* ptr
= nullptr;
1103 typedef decltype(&::free
) Deleter
;
1104 Deleter deleter
= &::free
;
1106 auto size
= ::pathconf(".", _PC_PATH_MAX
);
1107 _LIBCPP_ASSERT(size
>= 0, "pathconf returned a 0 as max size");
1109 auto buff
= unique_ptr
<path::value_type
[]>(new path::value_type
[size
+ 1]);
1110 path::value_type
* ptr
= buff
.get();
1112 // Preallocated buffer, don't free the buffer in the second unique_ptr
1114 struct Deleter
{ void operator()(void*) const {} };
1118 unique_ptr
<path::value_type
, Deleter
> hold(detail::getcwd(ptr
, size
),
1120 if (hold
.get() == nullptr)
1121 return err
.report(capture_errno(), "call to getcwd failed");
1123 return {hold
.get()};
1126 void __current_path(const path
& p
, error_code
* ec
) {
1127 ErrorHandler
<void> err("current_path", ec
, &p
);
1128 if (detail::chdir(p
.c_str()) == -1)
1129 err
.report(capture_errno());
1132 bool __equivalent(const path
& p1
, const path
& p2
, error_code
* ec
) {
1133 ErrorHandler
<bool> err("equivalent", ec
, &p1
, &p2
);
1135 error_code ec1
, ec2
;
1136 StatT st1
= {}, st2
= {};
1137 auto s1
= detail::posix_stat(p1
.native(), st1
, &ec1
);
1139 return err
.report(errc::not_supported
);
1140 auto s2
= detail::posix_stat(p2
.native(), st2
, &ec2
);
1142 return err
.report(errc::not_supported
);
1144 return detail::stat_equivalent(st1
, st2
);
1147 uintmax_t __file_size(const path
& p
, error_code
* ec
) {
1148 ErrorHandler
<uintmax_t> err("file_size", ec
, &p
);
1152 file_status fst
= detail::posix_stat(p
, st
, &m_ec
);
1153 if (!exists(fst
) || !is_regular_file(fst
)) {
1155 is_directory(fst
) ? errc::is_a_directory
: errc::not_supported
;
1157 m_ec
= make_error_code(error_kind
);
1158 return err
.report(m_ec
);
1160 // is_regular_file(p) == true
1161 return static_cast<uintmax_t>(st
.st_size
);
1164 uintmax_t __hard_link_count(const path
& p
, error_code
* ec
) {
1165 ErrorHandler
<uintmax_t> err("hard_link_count", ec
, &p
);
1169 detail::posix_stat(p
, st
, &m_ec
);
1171 return err
.report(m_ec
);
1172 return static_cast<uintmax_t>(st
.st_nlink
);
1175 bool __fs_is_empty(const path
& p
, error_code
* ec
) {
1176 ErrorHandler
<bool> err("is_empty", ec
, &p
);
1180 auto st
= detail::posix_stat(p
, pst
, &m_ec
);
1182 return err
.report(m_ec
);
1183 else if (!is_directory(st
) && !is_regular_file(st
))
1184 return err
.report(errc::not_supported
);
1185 else if (is_directory(st
)) {
1186 auto it
= ec
? directory_iterator(p
, *ec
) : directory_iterator(p
);
1189 return it
== directory_iterator
{};
1190 } else if (is_regular_file(st
))
1191 return static_cast<uintmax_t>(pst
.st_size
) == 0;
1193 __libcpp_unreachable();
1196 static file_time_type
__extract_last_write_time(const path
& p
, const StatT
& st
,
1198 using detail::fs_time
;
1199 ErrorHandler
<file_time_type
> err("last_write_time", ec
, &p
);
1201 auto ts
= detail::extract_mtime(st
);
1202 if (!fs_time::is_representable(ts
))
1203 return err
.report(errc::value_too_large
);
1205 return fs_time::convert_from_timespec(ts
);
1208 file_time_type
__last_write_time(const path
& p
, error_code
* ec
) {
1209 using namespace chrono
;
1210 ErrorHandler
<file_time_type
> err("last_write_time", ec
, &p
);
1214 detail::posix_stat(p
, st
, &m_ec
);
1216 return err
.report(m_ec
);
1217 return __extract_last_write_time(p
, st
, ec
);
1220 void __last_write_time(const path
& p
, file_time_type new_time
, error_code
* ec
) {
1221 using detail::fs_time
;
1222 ErrorHandler
<void> err("last_write_time", ec
, &p
);
1224 #if defined(_LIBCPP_WIN32API)
1226 if (!fs_time::convert_to_timespec(ts
, new_time
))
1227 return err
.report(errc::value_too_large
);
1228 detail::WinHandle
h(p
.c_str(), FILE_WRITE_ATTRIBUTES
, 0);
1230 return err
.report(detail::make_windows_error(GetLastError()));
1231 FILETIME last_write
= timespec_to_filetime(ts
);
1232 if (!SetFileTime(h
, nullptr, nullptr, &last_write
))
1233 return err
.report(detail::make_windows_error(GetLastError()));
1236 array
<TimeSpec
, 2> tbuf
;
1237 #if !defined(_LIBCPP_USE_UTIMENSAT)
1238 // This implementation has a race condition between determining the
1239 // last access time and attempting to set it to the same value using
1242 file_status fst
= detail::posix_stat(p
, st
, &m_ec
);
1244 return err
.report(m_ec
);
1245 tbuf
[0] = detail::extract_atime(st
);
1248 tbuf
[0].tv_nsec
= UTIME_OMIT
;
1250 if (!fs_time::convert_to_timespec(tbuf
[1], new_time
))
1251 return err
.report(errc::value_too_large
);
1253 detail::set_file_times(p
, tbuf
, m_ec
);
1255 return err
.report(m_ec
);
1259 void __permissions(const path
& p
, perms prms
, perm_options opts
,
1261 ErrorHandler
<void> err("permissions", ec
, &p
);
1263 auto has_opt
= [&](perm_options o
) { return bool(o
& opts
); };
1264 const bool resolve_symlinks
= !has_opt(perm_options::nofollow
);
1265 const bool add_perms
= has_opt(perm_options::add
);
1266 const bool remove_perms
= has_opt(perm_options::remove
);
1268 (add_perms
+ remove_perms
+ has_opt(perm_options::replace
)) == 1,
1269 "One and only one of the perm_options constants replace, add, or remove "
1270 "is present in opts");
1272 bool set_sym_perms
= false;
1273 prms
&= perms::mask
;
1274 if (!resolve_symlinks
|| (add_perms
|| remove_perms
)) {
1276 file_status st
= resolve_symlinks
? detail::posix_stat(p
, &m_ec
)
1277 : detail::posix_lstat(p
, &m_ec
);
1278 set_sym_perms
= is_symlink(st
);
1280 return err
.report(m_ec
);
1281 _LIBCPP_ASSERT(st
.permissions() != perms::unknown
,
1282 "Permissions unexpectedly unknown");
1284 prms
|= st
.permissions();
1285 else if (remove_perms
)
1286 prms
= st
.permissions() & ~prms
;
1288 const auto real_perms
= static_cast<detail::ModeT
>(prms
& perms::mask
);
1290 #if defined(AT_SYMLINK_NOFOLLOW) && defined(AT_FDCWD)
1291 const int flags
= set_sym_perms
? AT_SYMLINK_NOFOLLOW
: 0;
1292 if (detail::fchmodat(AT_FDCWD
, p
.c_str(), real_perms
, flags
) == -1) {
1293 return err
.report(capture_errno());
1297 return err
.report(errc::operation_not_supported
);
1298 if (::chmod(p
.c_str(), real_perms
) == -1) {
1299 return err
.report(capture_errno());
1304 path
__read_symlink(const path
& p
, error_code
* ec
) {
1305 ErrorHandler
<path
> err("read_symlink", ec
, &p
);
1307 #if defined(PATH_MAX) || defined(MAX_SYMLINK_SIZE)
1308 struct NullDeleter
{ void operator()(void*) const {} };
1309 #ifdef MAX_SYMLINK_SIZE
1310 const size_t size
= MAX_SYMLINK_SIZE
+ 1;
1312 const size_t size
= PATH_MAX
+ 1;
1314 path::value_type stack_buff
[size
];
1315 auto buff
= std::unique_ptr
<path::value_type
[], NullDeleter
>(stack_buff
);
1318 if (detail::lstat(p
.c_str(), &sb
) == -1) {
1319 return err
.report(capture_errno());
1321 const size_t size
= sb
.st_size
+ 1;
1322 auto buff
= unique_ptr
<path::value_type
[]>(new path::value_type
[size
]);
1325 if ((ret
= detail::readlink(p
.c_str(), buff
.get(), size
)) == -1)
1326 return err
.report(capture_errno());
1327 _LIBCPP_ASSERT(ret
> 0, "TODO");
1328 if (static_cast<size_t>(ret
) >= size
)
1329 return err
.report(errc::value_too_large
);
1331 return {buff
.get()};
1334 bool __remove(const path
& p
, error_code
* ec
) {
1335 ErrorHandler
<bool> err("remove", ec
, &p
);
1336 if (detail::remove(p
.c_str()) == -1) {
1337 if (errno
!= ENOENT
)
1338 err
.report(capture_errno());
1344 // We currently have two implementations of `__remove_all`. The first one is general and
1345 // used on platforms where we don't have access to the `openat()` family of POSIX functions.
1346 // That implementation uses `directory_iterator`, however it is vulnerable to some race
1347 // conditions, see https://reviews.llvm.org/D118134 for details.
1349 // The second implementation is used on platforms where `openat()` & friends are available,
1350 // and it threads file descriptors through recursive calls to avoid such race conditions.
1351 #if defined(_LIBCPP_WIN32API)
1352 # define REMOVE_ALL_USE_DIRECTORY_ITERATOR
1355 #if defined(REMOVE_ALL_USE_DIRECTORY_ITERATOR)
1359 uintmax_t remove_all_impl(path
const& p
, error_code
& ec
) {
1360 const auto npos
= static_cast<uintmax_t>(-1);
1361 const file_status st
= __symlink_status(p
, &ec
);
1364 uintmax_t count
= 1;
1365 if (is_directory(st
)) {
1366 for (directory_iterator
it(p
, ec
); !ec
&& it
!= directory_iterator();
1368 auto other_count
= remove_all_impl(it
->path(), ec
);
1371 count
+= other_count
;
1376 if (!__remove(p
, &ec
))
1383 uintmax_t __remove_all(const path
& p
, error_code
* ec
) {
1384 ErrorHandler
<uintmax_t> err("remove_all", ec
, &p
);
1387 auto count
= remove_all_impl(p
, mec
);
1389 if (mec
== errc::no_such_file_or_directory
)
1391 return err
.report(mec
);
1396 #else // !REMOVE_ALL_USE_DIRECTORY_ITERATOR
1400 template <class Cleanup
>
1402 explicit scope_exit(Cleanup
const& cleanup
)
1406 ~scope_exit() { cleanup_(); }
1412 uintmax_t remove_all_impl(int parent_directory
, const path
& p
, error_code
& ec
) {
1413 // First, try to open the path as a directory.
1414 const int options
= O_CLOEXEC
| O_RDONLY
| O_DIRECTORY
| O_NOFOLLOW
;
1415 int fd
= ::openat(parent_directory
, p
.c_str(), options
);
1417 // If that worked, iterate over the contents of the directory and
1418 // remove everything in it, recursively.
1419 DIR* stream
= ::fdopendir(fd
);
1420 if (stream
== nullptr) {
1422 ec
= detail::capture_errno();
1425 // Note: `::closedir` will also close the associated file descriptor, so
1426 // there should be no call to `close(fd)`.
1427 scope_exit
close_stream([=] { ::closedir(stream
); });
1429 uintmax_t count
= 0;
1431 auto [str
, type
] = detail::posix_readdir(stream
, ec
);
1432 static_assert(std::is_same_v
<decltype(str
), std::string_view
>);
1433 if (str
== "." || str
== "..") {
1435 } else if (ec
|| str
.empty()) {
1436 break; // we're done iterating through the directory
1438 count
+= remove_all_impl(fd
, str
, ec
);
1442 // Then, remove the now-empty directory itself.
1443 if (::unlinkat(parent_directory
, p
.c_str(), AT_REMOVEDIR
) == -1) {
1444 ec
= detail::capture_errno();
1448 return count
+ 1; // the contents of the directory + the directory itself
1451 ec
= detail::capture_errno();
1453 // If we failed to open `p` because it didn't exist, it's not an
1454 // error -- it might have moved or have been deleted already.
1455 if (ec
== errc::no_such_file_or_directory
) {
1460 // If opening `p` failed because it wasn't a directory, remove it as
1461 // a normal file instead. Note that `openat()` can return either ENOTDIR
1462 // or ELOOP depending on the exact reason of the failure.
1463 if (ec
== errc::not_a_directory
|| ec
== errc::too_many_symbolic_link_levels
) {
1465 if (::unlinkat(parent_directory
, p
.c_str(), /* flags = */0) == -1) {
1466 ec
= detail::capture_errno();
1472 // Otherwise, it's a real error -- we don't remove anything.
1478 uintmax_t __remove_all(const path
& p
, error_code
* ec
) {
1479 ErrorHandler
<uintmax_t> err("remove_all", ec
, &p
);
1481 uintmax_t count
= remove_all_impl(AT_FDCWD
, p
, mec
);
1483 return err
.report(mec
);
1487 #endif // REMOVE_ALL_USE_DIRECTORY_ITERATOR
1489 void __rename(const path
& from
, const path
& to
, error_code
* ec
) {
1490 ErrorHandler
<void> err("rename", ec
, &from
, &to
);
1491 if (detail::rename(from
.c_str(), to
.c_str()) == -1)
1492 err
.report(capture_errno());
1495 void __resize_file(const path
& p
, uintmax_t size
, error_code
* ec
) {
1496 ErrorHandler
<void> err("resize_file", ec
, &p
);
1497 if (detail::truncate(p
.c_str(), static_cast< ::off_t
>(size
)) == -1)
1498 return err
.report(capture_errno());
1501 space_info
__space(const path
& p
, error_code
* ec
) {
1502 ErrorHandler
<void> err("space", ec
, &p
);
1504 detail::StatVFS m_svfs
= {};
1505 if (detail::statvfs(p
.c_str(), &m_svfs
) == -1) {
1506 err
.report(capture_errno());
1507 si
.capacity
= si
.free
= si
.available
= static_cast<uintmax_t>(-1);
1510 // Multiply with overflow checking.
1511 auto do_mult
= [&](uintmax_t& out
, uintmax_t other
) {
1512 out
= other
* m_svfs
.f_frsize
;
1513 if (other
== 0 || out
/ other
!= m_svfs
.f_frsize
)
1514 out
= static_cast<uintmax_t>(-1);
1516 do_mult(si
.capacity
, m_svfs
.f_blocks
);
1517 do_mult(si
.free
, m_svfs
.f_bfree
);
1518 do_mult(si
.available
, m_svfs
.f_bavail
);
1522 file_status
__status(const path
& p
, error_code
* ec
) {
1523 return detail::posix_stat(p
, ec
);
1526 file_status
__symlink_status(const path
& p
, error_code
* ec
) {
1527 return detail::posix_lstat(p
, ec
);
1530 path
__temp_directory_path(error_code
* ec
) {
1531 ErrorHandler
<path
> err("temp_directory_path", ec
);
1533 #if defined(_LIBCPP_WIN32API)
1534 wchar_t buf
[MAX_PATH
];
1535 DWORD retval
= GetTempPathW(MAX_PATH
, buf
);
1537 return err
.report(detail::make_windows_error(GetLastError()));
1538 if (retval
> MAX_PATH
)
1539 return err
.report(errc::filename_too_long
);
1540 // GetTempPathW returns a path with a trailing slash, which we
1541 // shouldn't include for consistency.
1542 if (buf
[retval
-1] == L
'\\')
1543 buf
[retval
-1] = L
'\0';
1546 const char* env_paths
[] = {"TMPDIR", "TMP", "TEMP", "TEMPDIR"};
1547 const char* ret
= nullptr;
1549 for (auto& ep
: env_paths
)
1550 if ((ret
= getenv(ep
)))
1558 file_status st
= detail::posix_stat(p
, &m_ec
);
1559 if (!status_known(st
))
1560 return err
.report(m_ec
, "cannot access path " PATH_CSTR_FMT
, p
.c_str());
1562 if (!exists(st
) || !is_directory(st
))
1563 return err
.report(errc::not_a_directory
,
1564 "path " PATH_CSTR_FMT
" is not a directory", p
.c_str());
1569 path
__weakly_canonical(const path
& p
, error_code
* ec
) {
1570 ErrorHandler
<path
> err("weakly_canonical", ec
, &p
);
1573 return __canonical("", ec
);
1577 tmp
.__reserve(p
.native().size());
1578 auto PP
= PathParser::CreateEnd(p
.native());
1580 vector
<string_view_t
> DNEParts
;
1582 while (PP
.State
!= PathParser::PS_BeforeBegin
) {
1583 tmp
.assign(createView(p
.native().data(), &PP
.RawEntry
.back()));
1585 file_status st
= __status(tmp
, &m_ec
);
1586 if (!status_known(st
)) {
1587 return err
.report(m_ec
);
1588 } else if (exists(st
)) {
1589 result
= __canonical(tmp
, ec
);
1592 DNEParts
.push_back(*PP
);
1595 if (PP
.State
== PathParser::PS_BeforeBegin
)
1596 result
= __canonical("", ec
);
1599 if (DNEParts
.empty())
1601 for (auto It
= DNEParts
.rbegin(); It
!= DNEParts
.rend(); ++It
)
1603 return result
.lexically_normal();
1606 ///////////////////////////////////////////////////////////////////////////////
1608 ///////////////////////////////////////////////////////////////////////////////
1610 constexpr path::value_type
path::preferred_separator
;
1612 path
& path::replace_extension(path
const& replacement
) {
1613 path p
= extension();
1614 if (not p
.empty()) {
1615 __pn_
.erase(__pn_
.size() - p
.native().size());
1617 if (!replacement
.empty()) {
1618 if (replacement
.native()[0] != '.') {
1621 __pn_
.append(replacement
.__pn_
);
1626 ///////////////////////////////////////////////////////////////////////////////
1629 string_view_t
path::__root_name() const {
1630 auto PP
= PathParser::CreateBegin(__pn_
);
1631 if (PP
.State
== PathParser::PS_InRootName
)
1636 string_view_t
path::__root_directory() const {
1637 auto PP
= PathParser::CreateBegin(__pn_
);
1638 if (PP
.State
== PathParser::PS_InRootName
)
1640 if (PP
.State
== PathParser::PS_InRootDir
)
1645 string_view_t
path::__root_path_raw() const {
1646 auto PP
= PathParser::CreateBegin(__pn_
);
1647 if (PP
.State
== PathParser::PS_InRootName
) {
1648 auto NextCh
= PP
.peek();
1649 if (NextCh
&& isSeparator(*NextCh
)) {
1651 return createView(__pn_
.data(), &PP
.RawEntry
.back());
1655 if (PP
.State
== PathParser::PS_InRootDir
)
1660 static bool ConsumeRootName(PathParser
*PP
) {
1661 static_assert(PathParser::PS_BeforeBegin
== 1 &&
1662 PathParser::PS_InRootName
== 2,
1663 "Values for enums are incorrect");
1664 while (PP
->State
<= PathParser::PS_InRootName
)
1666 return PP
->State
== PathParser::PS_AtEnd
;
1669 static bool ConsumeRootDir(PathParser
* PP
) {
1670 static_assert(PathParser::PS_BeforeBegin
== 1 &&
1671 PathParser::PS_InRootName
== 2 &&
1672 PathParser::PS_InRootDir
== 3, "Values for enums are incorrect");
1673 while (PP
->State
<= PathParser::PS_InRootDir
)
1675 return PP
->State
== PathParser::PS_AtEnd
;
1678 string_view_t
path::__relative_path() const {
1679 auto PP
= PathParser::CreateBegin(__pn_
);
1680 if (ConsumeRootDir(&PP
))
1682 return createView(PP
.RawEntry
.data(), &__pn_
.back());
1685 string_view_t
path::__parent_path() const {
1688 // Determine if we have a root path but not a relative path. In that case
1691 auto PP
= PathParser::CreateBegin(__pn_
);
1692 if (ConsumeRootDir(&PP
))
1695 // Otherwise remove a single element from the end of the path, and return
1696 // a string representing that path
1698 auto PP
= PathParser::CreateEnd(__pn_
);
1700 if (PP
.RawEntry
.data() == __pn_
.data())
1703 return createView(__pn_
.data(), &PP
.RawEntry
.back());
1707 string_view_t
path::__filename() const {
1711 PathParser PP
= PathParser::CreateBegin(__pn_
);
1712 if (ConsumeRootDir(&PP
))
1715 return *(--PathParser::CreateEnd(__pn_
));
1718 string_view_t
path::__stem() const {
1719 return parser::separate_filename(__filename()).first
;
1722 string_view_t
path::__extension() const {
1723 return parser::separate_filename(__filename()).second
;
1726 ////////////////////////////////////////////////////////////////////////////
1729 enum PathPartKind
: unsigned char {
1738 static PathPartKind
ClassifyPathPart(string_view_t Part
) {
1740 return PK_TrailingSep
;
1741 if (Part
== PS("."))
1743 if (Part
== PS(".."))
1745 if (Part
== PS("/"))
1747 #if defined(_LIBCPP_WIN32API)
1748 if (Part
== PS("\\"))
1754 path
path::lexically_normal() const {
1758 using PartKindPair
= pair
<string_view_t
, PathPartKind
>;
1759 vector
<PartKindPair
> Parts
;
1760 // Guess as to how many elements the path has to avoid reallocating.
1763 // Track the total size of the parts as we collect them. This allows the
1764 // resulting path to reserve the correct amount of memory.
1765 size_t NewPathSize
= 0;
1766 auto AddPart
= [&](PathPartKind K
, string_view_t P
) {
1767 NewPathSize
+= P
.size();
1768 Parts
.emplace_back(P
, K
);
1770 auto LastPartKind
= [&]() {
1773 return Parts
.back().second
;
1776 bool MaybeNeedTrailingSep
= false;
1777 // Build a stack containing the remaining elements of the path, popping off
1778 // elements which occur before a '..' entry.
1779 for (auto PP
= PathParser::CreateBegin(__pn_
); PP
; ++PP
) {
1781 PathPartKind Kind
= ClassifyPathPart(Part
);
1785 // Add all non-dot and non-dot-dot elements to the stack of elements.
1786 AddPart(Kind
, Part
);
1787 MaybeNeedTrailingSep
= false;
1791 // Only push a ".." element if there are no elements preceding the "..",
1792 // or if the preceding element is itself "..".
1793 auto LastKind
= LastPartKind();
1794 if (LastKind
== PK_Filename
) {
1795 NewPathSize
-= Parts
.back().first
.size();
1797 } else if (LastKind
!= PK_RootSep
)
1798 AddPart(PK_DotDot
, PS(".."));
1799 MaybeNeedTrailingSep
= LastKind
== PK_Filename
;
1803 case PK_TrailingSep
: {
1804 MaybeNeedTrailingSep
= true;
1808 __libcpp_unreachable();
1811 // [fs.path.generic]p6.8: If the path is empty, add a dot.
1815 // [fs.path.generic]p6.7: If the last filename is dot-dot, remove any
1816 // trailing directory-separator.
1817 bool NeedTrailingSep
= MaybeNeedTrailingSep
&& LastPartKind() == PK_Filename
;
1820 Result
.__pn_
.reserve(Parts
.size() + NewPathSize
+ NeedTrailingSep
);
1821 for (auto& PK
: Parts
)
1824 if (NeedTrailingSep
)
1827 Result
.make_preferred();
1831 static int DetermineLexicalElementCount(PathParser PP
) {
1835 if (Elem
== PS(".."))
1837 else if (Elem
!= PS(".") && Elem
!= PS(""))
1843 path
path::lexically_relative(const path
& base
) const {
1844 { // perform root-name/root-directory mismatch checks
1845 auto PP
= PathParser::CreateBegin(__pn_
);
1846 auto PPBase
= PathParser::CreateBegin(base
.__pn_
);
1847 auto CheckIterMismatchAtBase
= [&]() {
1848 return PP
.State
!= PPBase
.State
&&
1849 (PP
.inRootPath() || PPBase
.inRootPath());
1851 if (PP
.inRootName() && PPBase
.inRootName()) {
1854 } else if (CheckIterMismatchAtBase())
1857 if (PP
.inRootPath())
1859 if (PPBase
.inRootPath())
1861 if (CheckIterMismatchAtBase())
1865 // Find the first mismatching element
1866 auto PP
= PathParser::CreateBegin(__pn_
);
1867 auto PPBase
= PathParser::CreateBegin(base
.__pn_
);
1868 while (PP
&& PPBase
&& PP
.State
== PPBase
.State
&& *PP
== *PPBase
) {
1873 // If there is no mismatch, return ".".
1877 // Otherwise, determine the number of elements, 'n', which are not dot or
1878 // dot-dot minus the number of dot-dot elements.
1879 int ElemCount
= DetermineLexicalElementCount(PPBase
);
1883 // if n == 0 and (a == end() || a->empty()), returns path("."); otherwise
1884 if (ElemCount
== 0 && (PP
.atEnd() || *PP
== PS("")))
1887 // return a path constructed with 'n' dot-dot elements, followed by the the
1888 // elements of '*this' after the mismatch.
1890 // FIXME: Reserve enough room in Result that it won't have to re-allocate.
1898 ////////////////////////////////////////////////////////////////////////////
1900 static int CompareRootName(PathParser
*LHS
, PathParser
*RHS
) {
1901 if (!LHS
->inRootName() && !RHS
->inRootName())
1904 auto GetRootName
= [](PathParser
*Parser
) -> string_view_t
{
1905 return Parser
->inRootName() ? **Parser
: PS("");
1907 int res
= GetRootName(LHS
).compare(GetRootName(RHS
));
1908 ConsumeRootName(LHS
);
1909 ConsumeRootName(RHS
);
1913 static int CompareRootDir(PathParser
*LHS
, PathParser
*RHS
) {
1914 if (!LHS
->inRootDir() && RHS
->inRootDir())
1916 else if (LHS
->inRootDir() && !RHS
->inRootDir())
1919 ConsumeRootDir(LHS
);
1920 ConsumeRootDir(RHS
);
1925 static int CompareRelative(PathParser
*LHSPtr
, PathParser
*RHSPtr
) {
1926 auto &LHS
= *LHSPtr
;
1927 auto &RHS
= *RHSPtr
;
1930 while (LHS
&& RHS
) {
1931 if ((res
= (*LHS
).compare(*RHS
)) != 0)
1939 static int CompareEndState(PathParser
*LHS
, PathParser
*RHS
) {
1940 if (LHS
->atEnd() && !RHS
->atEnd())
1942 else if (!LHS
->atEnd() && RHS
->atEnd())
1947 int path::__compare(string_view_t __s
) const {
1948 auto LHS
= PathParser::CreateBegin(__pn_
);
1949 auto RHS
= PathParser::CreateBegin(__s
);
1952 if ((res
= CompareRootName(&LHS
, &RHS
)) != 0)
1955 if ((res
= CompareRootDir(&LHS
, &RHS
)) != 0)
1958 if ((res
= CompareRelative(&LHS
, &RHS
)) != 0)
1961 return CompareEndState(&LHS
, &RHS
);
1964 ////////////////////////////////////////////////////////////////////////////
1966 size_t hash_value(const path
& __p
) noexcept
{
1967 auto PP
= PathParser::CreateBegin(__p
.native());
1968 size_t hash_value
= 0;
1969 hash
<string_view_t
> hasher
;
1971 hash_value
= __hash_combine(hash_value
, hasher(*PP
));
1977 ////////////////////////////////////////////////////////////////////////////
1979 path::iterator
path::begin() const {
1980 auto PP
= PathParser::CreateBegin(__pn_
);
1982 it
.__path_ptr_
= this;
1983 it
.__state_
= static_cast<path::iterator::_ParserState
>(PP
.State
);
1984 it
.__entry_
= PP
.RawEntry
;
1985 it
.__stashed_elem_
.__assign_view(*PP
);
1989 path::iterator
path::end() const {
1991 it
.__state_
= path::iterator::_AtEnd
;
1992 it
.__path_ptr_
= this;
1996 path::iterator
& path::iterator::__increment() {
1997 PathParser
PP(__path_ptr_
->native(), __entry_
, __state_
);
1999 __state_
= static_cast<_ParserState
>(PP
.State
);
2000 __entry_
= PP
.RawEntry
;
2001 __stashed_elem_
.__assign_view(*PP
);
2005 path::iterator
& path::iterator::__decrement() {
2006 PathParser
PP(__path_ptr_
->native(), __entry_
, __state_
);
2008 __state_
= static_cast<_ParserState
>(PP
.State
);
2009 __entry_
= PP
.RawEntry
;
2010 __stashed_elem_
.__assign_view(*PP
);
2014 #if defined(_LIBCPP_WIN32API)
2015 ////////////////////////////////////////////////////////////////////////////
2016 // Windows path conversions
2017 size_t __wide_to_char(const wstring
&str
, char *out
, size_t outlen
) {
2020 ErrorHandler
<size_t> err("__wide_to_char", nullptr);
2021 UINT codepage
= AreFileApisANSI() ? CP_ACP
: CP_OEMCP
;
2022 BOOL used_default
= FALSE
;
2023 int ret
= WideCharToMultiByte(codepage
, 0, str
.data(), str
.size(), out
,
2024 outlen
, nullptr, &used_default
);
2025 if (ret
<= 0 || used_default
)
2026 return err
.report(errc::illegal_byte_sequence
);
2030 size_t __char_to_wide(const string
&str
, wchar_t *out
, size_t outlen
) {
2033 ErrorHandler
<size_t> err("__char_to_wide", nullptr);
2034 UINT codepage
= AreFileApisANSI() ? CP_ACP
: CP_OEMCP
;
2035 int ret
= MultiByteToWideChar(codepage
, MB_ERR_INVALID_CHARS
, str
.data(),
2036 str
.size(), out
, outlen
);
2038 return err
.report(errc::illegal_byte_sequence
);
2044 ///////////////////////////////////////////////////////////////////////////////
2045 // directory entry definitions
2046 ///////////////////////////////////////////////////////////////////////////////
2048 error_code
directory_entry::__do_refresh() noexcept
{
2050 error_code failure_ec
;
2053 file_status st
= detail::posix_lstat(__p_
, full_st
, &failure_ec
);
2054 if (!status_known(st
)) {
2059 if (!_VSTD_FS::exists(st
) || !_VSTD_FS::is_symlink(st
)) {
2060 __data_
.__cache_type_
= directory_entry::_RefreshNonSymlink
;
2061 __data_
.__type_
= st
.type();
2062 __data_
.__non_sym_perms_
= st
.permissions();
2063 } else { // we have a symlink
2064 __data_
.__sym_perms_
= st
.permissions();
2065 // Get the information about the linked entity.
2066 // Ignore errors from stat, since we don't want errors regarding symlink
2067 // resolution to be reported to the user.
2068 error_code ignored_ec
;
2069 st
= detail::posix_stat(__p_
, full_st
, &ignored_ec
);
2071 __data_
.__type_
= st
.type();
2072 __data_
.__non_sym_perms_
= st
.permissions();
2074 // If we failed to resolve the link, then only partially populate the
2076 if (!status_known(st
)) {
2077 __data_
.__cache_type_
= directory_entry::_RefreshSymlinkUnresolved
;
2078 return error_code
{};
2080 // Otherwise, we resolved the link, potentially as not existing.
2082 __data_
.__cache_type_
= directory_entry::_RefreshSymlink
;
2085 if (_VSTD_FS::is_regular_file(st
))
2086 __data_
.__size_
= static_cast<uintmax_t>(full_st
.st_size
);
2088 if (_VSTD_FS::exists(st
)) {
2089 __data_
.__nlink_
= static_cast<uintmax_t>(full_st
.st_nlink
);
2091 // Attempt to extract the mtime, and fail if it's not representable using
2092 // file_time_type. For now we ignore the error, as we'll report it when
2093 // the value is actually used.
2094 error_code ignored_ec
;
2095 __data_
.__write_time_
=
2096 __extract_last_write_time(__p_
, full_st
, &ignored_ec
);
2102 _LIBCPP_END_NAMESPACE_FILESYSTEM