fmt/src/os.cc

318 lines
9.5 KiB
C++
Raw Normal View History

2019-12-15 20:25:40 +00:00
// Formatting library for C++ - optional OS-specific functionality
2018-01-06 17:09:50 +00:00
//
// Copyright (c) 2012 - 2016, Victor Zverovich
// All rights reserved.
//
// For the license information refer to format.h.
2014-06-09 15:33:48 +00:00
2014-12-17 14:41:21 +00:00
// Disable bogus MSVC warnings.
#if !defined(_CRT_SECURE_NO_WARNINGS) && defined(_MSC_VER)
2019-01-13 02:27:38 +00:00
# define _CRT_SECURE_NO_WARNINGS
#endif
2014-12-17 14:41:21 +00:00
#include "fmt/os.h"
2014-06-09 15:33:48 +00:00
#include <climits>
2019-11-15 13:41:14 +00:00
#if FMT_USE_FCNTL
# include <sys/stat.h>
# include <sys/types.h>
2014-06-09 15:33:48 +00:00
# ifndef _WIN32
# include <unistd.h>
# else
# ifndef WIN32_LEAN_AND_MEAN
# define WIN32_LEAN_AND_MEAN
# endif
# include <io.h>
# include <windows.h>
2014-06-09 15:33:48 +00:00
# define O_CREAT _O_CREAT
# define O_TRUNC _O_TRUNC
2014-07-09 15:39:01 +00:00
# ifndef S_IRUSR
# define S_IRUSR _S_IREAD
# endif
2014-07-09 15:39:01 +00:00
# ifndef S_IWUSR
# define S_IWUSR _S_IWRITE
# endif
2014-06-09 15:33:48 +00:00
# ifdef __MINGW32__
# define _SH_DENYNO 0x40
# endif
# endif // _WIN32
#endif // FMT_USE_FCNTL
2020-02-14 12:54:15 +00:00
#ifdef _WIN32
# include <windows.h>
#endif
2014-06-09 15:33:48 +00:00
#ifdef fileno
2019-01-13 02:27:38 +00:00
# undef fileno
#endif
2014-06-09 15:33:48 +00:00
namespace {
#ifdef _WIN32
// Return type of read and write functions.
using RWResult = int;
2014-06-09 15:33:48 +00:00
// On Windows the count argument to read and write is unsigned, so convert
// it from size_t preventing integer overflow.
inline unsigned convert_rwcount(std::size_t count) {
2014-06-09 15:33:48 +00:00
return count <= UINT_MAX ? static_cast<unsigned>(count) : UINT_MAX;
}
#else
// Return type of read and write functions.
using RWResult = ssize_t;
inline std::size_t convert_rwcount(std::size_t count) { return count; }
2014-06-09 15:33:48 +00:00
#endif
2019-01-13 02:27:38 +00:00
} // namespace
2014-06-09 15:33:48 +00:00
2018-05-12 15:33:51 +00:00
FMT_BEGIN_NAMESPACE
2020-02-14 12:54:15 +00:00
#ifdef _WIN32
2020-05-10 14:25:42 +00:00
detail::utf16_to_utf8::utf16_to_utf8(wstring_view s) {
if (int error_code = convert(s)) {
FMT_THROW(windows_error(error_code,
"cannot convert string from UTF-16 to UTF-8"));
}
}
2020-05-10 14:25:42 +00:00
int detail::utf16_to_utf8::convert(wstring_view s) {
if (s.size() > INT_MAX) return ERROR_INVALID_PARAMETER;
int s_size = static_cast<int>(s.size());
if (s_size == 0) {
// WideCharToMultiByte does not support zero length, handle separately.
buffer_.resize(1);
buffer_[0] = 0;
return 0;
}
int length = WideCharToMultiByte(CP_UTF8, 0, s.data(), s_size, nullptr, 0,
nullptr, nullptr);
if (length == 0) return GetLastError();
buffer_.resize(length + 1);
length = WideCharToMultiByte(CP_UTF8, 0, s.data(), s_size, &buffer_[0],
length, nullptr, nullptr);
if (length == 0) return GetLastError();
buffer_[length] = 0;
return 0;
}
void windows_error::init(int err_code, string_view format_str,
format_args args) {
error_code_ = err_code;
memory_buffer buffer;
2020-05-10 14:25:42 +00:00
detail::format_windows_error(buffer, err_code, vformat(format_str, args));
std::runtime_error& base = *this;
base = std::runtime_error(to_string(buffer));
}
2020-05-10 14:25:42 +00:00
void detail::format_windows_error(detail::buffer<char>& out, int error_code,
string_view message) FMT_NOEXCEPT {
FMT_TRY {
wmemory_buffer buf;
buf.resize(inline_buffer_size);
for (;;) {
wchar_t* system_message = &buf[0];
int result = FormatMessageW(
FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS, nullptr,
error_code, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), system_message,
static_cast<uint32_t>(buf.size()), nullptr);
if (result != 0) {
utf16_to_utf8 utf8_message;
if (utf8_message.convert(system_message) == ERROR_SUCCESS) {
2020-05-07 01:29:04 +00:00
format_to(std::back_inserter(out), "{}: {}", message, utf8_message);
return;
}
break;
}
if (GetLastError() != ERROR_INSUFFICIENT_BUFFER)
break; // Can't get error message, report error code instead.
buf.resize(buf.size() * 2);
}
}
FMT_CATCH(...) {}
format_error_code(out, error_code, message);
}
void report_windows_error(int error_code,
fmt::string_view message) FMT_NOEXCEPT {
2020-05-10 14:25:42 +00:00
report_error(detail::format_windows_error, error_code, message);
}
2020-02-14 12:54:15 +00:00
#endif // _WIN32
2018-05-19 15:57:31 +00:00
buffered_file::~buffered_file() FMT_NOEXCEPT {
2014-06-09 15:33:48 +00:00
if (file_ && FMT_SYSTEM(fclose(file_)) != 0)
2018-05-12 15:33:51 +00:00
report_system_error(errno, "cannot close file");
2014-06-09 15:33:48 +00:00
}
2018-05-19 15:57:31 +00:00
buffered_file::buffered_file(cstring_view filename, cstring_view mode) {
2019-01-13 02:27:38 +00:00
FMT_RETRY_VAL(file_, FMT_SYSTEM(fopen(filename.c_str(), mode.c_str())),
nullptr);
2014-08-28 19:13:03 +00:00
if (!file_)
FMT_THROW(system_error(errno, "cannot open file {}", filename.c_str()));
}
2018-05-19 15:57:31 +00:00
void buffered_file::close() {
2019-01-13 02:27:38 +00:00
if (!file_) return;
2014-06-09 15:33:48 +00:00
int result = FMT_SYSTEM(fclose(file_));
file_ = nullptr;
2019-01-13 02:27:38 +00:00
if (result != 0) FMT_THROW(system_error(errno, "cannot close file"));
2014-06-09 15:33:48 +00:00
}
2015-03-16 15:43:59 +00:00
// A macro used to prevent expansion of fileno on broken versions of MinGW.
#define FMT_ARGS
2018-05-19 15:57:31 +00:00
int buffered_file::fileno() const {
2015-03-16 15:43:59 +00:00
int fd = FMT_POSIX_CALL(fileno FMT_ARGS(file_));
2019-01-13 02:27:38 +00:00
if (fd == -1) FMT_THROW(system_error(errno, "cannot get file descriptor"));
2014-06-09 15:33:48 +00:00
return fd;
}
2019-11-15 13:41:14 +00:00
#if FMT_USE_FCNTL
2018-05-19 17:32:53 +00:00
file::file(cstring_view path, int oflag) {
2014-06-09 15:33:48 +00:00
int mode = S_IRUSR | S_IWUSR;
# if defined(_WIN32) && !defined(__MINGW32__)
2014-06-09 15:33:48 +00:00
fd_ = -1;
FMT_POSIX_CALL(sopen_s(&fd_, path.c_str(), oflag, _SH_DENYNO, mode));
# else
FMT_RETRY(fd_, FMT_POSIX_CALL(open(path.c_str(), oflag, mode)));
# endif
2014-06-09 15:33:48 +00:00
if (fd_ == -1)
FMT_THROW(system_error(errno, "cannot open file {}", path.c_str()));
2014-06-09 15:33:48 +00:00
}
2018-05-19 17:32:53 +00:00
file::~file() FMT_NOEXCEPT {
2014-06-09 15:33:48 +00:00
// Don't retry close in case of EINTR!
// See http://linux.derkeiler.com/Mailing-Lists/Kernel/2005-09/3000.html
if (fd_ != -1 && FMT_POSIX_CALL(close(fd_)) != 0)
2018-05-12 15:33:51 +00:00
report_system_error(errno, "cannot close file");
2014-06-09 15:33:48 +00:00
}
2018-05-19 17:32:53 +00:00
void file::close() {
2019-01-13 02:27:38 +00:00
if (fd_ == -1) return;
2014-06-09 15:33:48 +00:00
// Don't retry close in case of EINTR!
// See http://linux.derkeiler.com/Mailing-Lists/Kernel/2005-09/3000.html
int result = FMT_POSIX_CALL(close(fd_));
fd_ = -1;
2019-01-13 02:27:38 +00:00
if (result != 0) FMT_THROW(system_error(errno, "cannot close file"));
2014-06-09 15:33:48 +00:00
}
2018-05-19 17:32:53 +00:00
long long file::size() const {
# ifdef _WIN32
// Use GetFileSize instead of GetFileSizeEx for the case when _WIN32_WINNT
// is less than 0x0500 as is the case with some default MinGW builds.
// Both functions support large file sizes.
DWORD size_upper = 0;
2014-09-12 19:37:32 +00:00
HANDLE handle = reinterpret_cast<HANDLE>(_get_osfhandle(fd_));
DWORD size_lower = FMT_SYSTEM(GetFileSize(handle, &size_upper));
if (size_lower == INVALID_FILE_SIZE) {
DWORD error = GetLastError();
if (error != NO_ERROR)
FMT_THROW(windows_error(GetLastError(), "cannot get file size"));
}
2017-08-26 16:09:43 +00:00
unsigned long long long_size = size_upper;
2015-05-07 14:19:28 +00:00
return (long_size << sizeof(DWORD) * CHAR_BIT) | size_lower;
# else
using Stat = struct stat;
Stat file_stat = Stat();
if (FMT_POSIX_CALL(fstat(fd_, &file_stat)) == -1)
FMT_THROW(system_error(errno, "cannot get file attributes"));
2017-09-08 15:26:05 +00:00
static_assert(sizeof(long long) >= sizeof(file_stat.st_size),
2019-01-13 02:27:38 +00:00
"return type of file::size is not large enough");
return file_stat.st_size;
# endif
}
2019-01-13 02:27:38 +00:00
std::size_t file::read(void* buffer, std::size_t count) {
RWResult result = 0;
FMT_RETRY(result, FMT_POSIX_CALL(read(fd_, buffer, convert_rwcount(count))));
2019-01-13 02:27:38 +00:00
if (result < 0) FMT_THROW(system_error(errno, "cannot read from file"));
2020-05-10 14:25:42 +00:00
return detail::to_unsigned(result);
2014-06-09 15:33:48 +00:00
}
2019-01-13 02:27:38 +00:00
std::size_t file::write(const void* buffer, std::size_t count) {
RWResult result = 0;
FMT_RETRY(result, FMT_POSIX_CALL(write(fd_, buffer, convert_rwcount(count))));
2019-01-13 02:27:38 +00:00
if (result < 0) FMT_THROW(system_error(errno, "cannot write to file"));
2020-05-10 14:25:42 +00:00
return detail::to_unsigned(result);
2014-06-09 15:33:48 +00:00
}
2018-05-19 17:32:53 +00:00
file file::dup(int fd) {
2014-06-09 15:33:48 +00:00
// Don't retry as dup doesn't return EINTR.
// http://pubs.opengroup.org/onlinepubs/009695399/functions/dup.html
int new_fd = FMT_POSIX_CALL(dup(fd));
if (new_fd == -1)
FMT_THROW(system_error(errno, "cannot duplicate file descriptor {}", fd));
2018-05-19 17:32:53 +00:00
return file(new_fd);
2014-06-09 15:33:48 +00:00
}
2018-05-19 17:32:53 +00:00
void file::dup2(int fd) {
2014-06-09 15:33:48 +00:00
int result = 0;
FMT_RETRY(result, FMT_POSIX_CALL(dup2(fd_, fd)));
if (result == -1) {
2019-01-13 02:27:38 +00:00
FMT_THROW(system_error(errno, "cannot duplicate file descriptor {} to {}",
fd_, fd));
2014-06-09 15:33:48 +00:00
}
}
2019-01-13 02:27:38 +00:00
void file::dup2(int fd, error_code& ec) FMT_NOEXCEPT {
2014-06-09 15:33:48 +00:00
int result = 0;
FMT_RETRY(result, FMT_POSIX_CALL(dup2(fd_, fd)));
2019-01-13 02:27:38 +00:00
if (result == -1) ec = error_code(errno);
2014-06-09 15:33:48 +00:00
}
2019-01-13 02:27:38 +00:00
void file::pipe(file& read_end, file& write_end) {
2014-06-09 15:33:48 +00:00
// Close the descriptors first to make sure that assignments don't throw
// and there are no leaks.
read_end.close();
write_end.close();
int fds[2] = {};
# ifdef _WIN32
2014-06-09 15:33:48 +00:00
// Make the default pipe capacity same as on Linux 2.6.11+.
enum { DEFAULT_CAPACITY = 65536 };
int result = FMT_POSIX_CALL(pipe(fds, DEFAULT_CAPACITY, _O_BINARY));
# else
2014-06-09 15:33:48 +00:00
// Don't retry as the pipe function doesn't return EINTR.
// http://pubs.opengroup.org/onlinepubs/009696799/functions/pipe.html
int result = FMT_POSIX_CALL(pipe(fds));
# endif
2019-01-13 02:27:38 +00:00
if (result != 0) FMT_THROW(system_error(errno, "cannot create pipe"));
2014-06-09 15:33:48 +00:00
// The following assignments don't throw because read_fd and write_fd
// are closed.
2018-05-19 17:32:53 +00:00
read_end = file(fds[0]);
write_end = file(fds[1]);
2014-06-09 15:33:48 +00:00
}
2019-01-13 02:27:38 +00:00
buffered_file file::fdopen(const char* mode) {
2014-06-09 15:33:48 +00:00
// Don't retry as fdopen doesn't return EINTR.
#if defined(__MINGW32__) && defined(_POSIX_)
FILE* f = ::fdopen(fd_, mode);
#else
2019-01-13 02:27:38 +00:00
FILE* f = FMT_POSIX_CALL(fdopen(fd_, mode));
#endif
2014-06-30 21:26:29 +00:00
if (!f)
2019-01-13 02:27:38 +00:00
FMT_THROW(
system_error(errno, "cannot associate stream with file descriptor"));
2018-05-21 00:09:12 +00:00
buffered_file bf(f);
2014-06-09 15:33:48 +00:00
fd_ = -1;
2018-05-21 00:09:12 +00:00
return bf;
2014-06-09 15:33:48 +00:00
}
2018-05-12 15:33:51 +00:00
long getpagesize() {
# ifdef _WIN32
2015-02-17 02:11:42 +00:00
SYSTEM_INFO si;
GetSystemInfo(&si);
return si.dwPageSize;
# else
long size = FMT_POSIX_CALL(sysconf(_SC_PAGESIZE));
2019-01-13 02:27:38 +00:00
if (size < 0) FMT_THROW(system_error(errno, "cannot get memory page size"));
return size;
# endif
}
2019-11-15 13:41:14 +00:00
#endif // FMT_USE_FCNTL
2018-05-12 15:33:51 +00:00
FMT_END_NAMESPACE