// Wrapper of C-language FILE struct -*- C++ -*-
-// Copyright (C) 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
+// Copyright (C) 2000-2024 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
// terms of the GNU General Public License as published by the
-// Free Software Foundation; either version 2, or (at your option)
+// Free Software Foundation; either version 3, or (at your option)
// any later version.
// This library is distributed in the hope that it will be useful,
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
-// You should have received a copy of the GNU General Public License along
-// with this library; see the file COPYING. If not, write to the Free
-// Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
-// USA.
+// Under Section 7 of GPL version 3, you are granted additional
+// permissions described in the GCC Runtime Library Exception, version
+// 3.1, as published by the Free Software Foundation.
-// As a special exception, you may use this file as part of a free software
-// library without restriction. Specifically, if other files instantiate
-// templates or use macros or inline functions from this file, or you compile
-// this file and link it with other files to produce an executable, this
-// file does not by itself cause the resulting executable to be covered by
-// the GNU General Public License. This exception does not however
-// invalidate any other reasons why the executable file might be covered by
-// the GNU General Public License.
+// You should have received a copy of the GNU General Public License and
+// a copy of the GCC Runtime Library Exception along with this program;
+// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
+// <http://www.gnu.org/licenses/>.
//
// ISO C++ 14882: 27.8 File-based streams
//
+#include <bits/largefile-config.h>
#include <bits/basic_file.h>
#include <fcntl.h>
-#include <unistd.h>
#include <errno.h>
-#ifdef _GLIBCPP_HAVE_SYS_IOCTL_H
-#define BSD_COMP /* Get FIONREAD on Solaris2. */
+#ifdef _GLIBCXX_HAVE_POLL
+#include <poll.h>
+#endif
+
+// Pick up ioctl on Solaris 2.8
+#ifdef _GLIBCXX_HAVE_UNISTD_H
+#include <unistd.h>
+#endif
+
+// Pick up FIONREAD on Solaris 2
+#ifdef _GLIBCXX_HAVE_SYS_IOCTL_H
+#define BSD_COMP
#include <sys/ioctl.h>
#endif
// Pick up FIONREAD on Solaris 2.5.
-#ifdef _GLIBCPP_HAVE_SYS_FILIO_H
+#ifdef _GLIBCXX_HAVE_SYS_FILIO_H
#include <sys/filio.h>
#endif
-#ifdef _GLIBCPP_HAVE_POLL
-#include <poll.h>
+#ifdef _GLIBCXX_HAVE_SYS_UIO_H
+#include <sys/uio.h>
#endif
-#if defined(_GLIBCPP_HAVE_S_ISREG) || defined(_GLIBCPP_HAVE_S_IFREG)
+#if defined(_GLIBCXX_HAVE_S_ISREG) || defined(_GLIBCXX_HAVE_S_IFREG)
# include <sys/stat.h>
-# ifdef _GLIBCPP_HAVE_S_ISREG
-# define _GLIBCPP_ISREG(x) S_ISREG(x)
+# ifdef _GLIBCXX_HAVE_S_ISREG
+# define _GLIBCXX_ISREG(x) S_ISREG(x)
# else
-# define _GLIBCPP_ISREG(x) (((x) & S_IFMT) == S_IFREG)
+# define _GLIBCXX_ISREG(x) (((x) & S_IFMT) == S_IFREG)
# endif
#endif
-namespace std
-{
- // Definitions for __basic_file<char>.
- __basic_file<char>::__basic_file(__c_lock* /*__lock*/)
- : _M_cfile(NULL), _M_cfile_created(false) { }
+#include <limits> // For <off_t>::max() and min() and <streamsize>::max()
- __basic_file<char>::~__basic_file()
- { this->close(); }
-
- void
- __basic_file<char>::_M_open_mode(ios_base::openmode __mode, int& __p_mode,
- int&, char* __c_mode)
- {
- bool __testb = __mode & ios_base::binary;
- bool __testi = __mode & ios_base::in;
- bool __testo = __mode & ios_base::out;
- bool __testt = __mode & ios_base::trunc;
- bool __testa = __mode & ios_base::app;
-
- // Set __c_mode for use in fopen.
- // Set __p_mode for use in open.
- if (!__testi && __testo && !__testt && !__testa)
- {
- strcpy(__c_mode, "w");
- __p_mode = (O_WRONLY | O_CREAT);
- }
- if (!__testi && __testo && !__testt && __testa)
- {
- strcpy(__c_mode, "a");
- __p_mode |= O_WRONLY | O_CREAT | O_APPEND;
- }
- if (!__testi && __testo && __testt && !__testa)
+#if _GLIBCXX_USE__GET_OSFHANDLE
+# include <stdint.h> // For intptr_t
+# include <io.h> // For _get_osfhandle
+#endif
+
+namespace
+{
+ // Map ios_base::openmode flags to a string for use in fopen().
+ // Table of valid combinations as given in [lib.filebuf.members]/2.
+ static const char*
+ fopen_mode(std::ios_base::openmode mode)
+ {
+ enum
{
- strcpy(__c_mode, "w");
- __p_mode |= O_WRONLY | O_CREAT | O_TRUNC;
- }
+ in = std::ios_base::in,
+ out = std::ios_base::out,
+ trunc = std::ios_base::trunc,
+ app = std::ios_base::app,
+ binary = std::ios_base::binary,
+ noreplace = std::_S_noreplace
+ };
- if (__testi && !__testo && !__testt && !__testa)
+ // _GLIBCXX_RESOLVE_LIB_DEFECTS
+ // 596. 27.8.1.3 Table 112 omits "a+" and "a+b" modes.
+ switch (mode & (in|out|trunc|app|binary|noreplace))
{
- strcpy(__c_mode, "r");
- __p_mode |= O_RDONLY;
+ case ( out ): return "w";
+ case ( out |noreplace): return "wx";
+ case ( out|trunc ): return "w";
+ case ( out|trunc |noreplace): return "wx";
+ case ( out |app ): return "a";
+ case ( app ): return "a";
+ case (in ): return "r";
+ case (in|out ): return "r+";
+ case (in|out|trunc ): return "w+";
+ case (in|out|trunc |noreplace): return "w+x";
+ case (in|out |app ): return "a+";
+ case (in |app ): return "a+";
+
+ case ( out |binary ): return "wb";
+ case ( out |binary|noreplace): return "wbx";
+ case ( out |app|binary ): return "ab";
+ case ( app|binary ): return "ab";
+ case ( out|trunc |binary ): return "wb";
+ case (in |binary ): return "rb";
+ case (in|out |binary ): return "r+b";
+ case (in|out|trunc |binary ): return "w+b";
+ case (in|out|trunc |binary|noreplace): return "w+bx";
+ case (in|out |app|binary ): return "a+b";
+ case (in |app|binary ): return "a+b";
+
+ default: return 0; // invalid
}
- if (__testi && __testo && !__testt && !__testa)
+ }
+
+ // Wrapper handling partial write.
+ static std::streamsize
+#ifdef _GLIBCXX_USE_STDIO_PURE
+ xwrite(FILE *__file, const char* __s, std::streamsize __n)
+#else
+ xwrite(int __fd, const char* __s, std::streamsize __n)
+#endif
+ {
+ std::streamsize __nleft = __n;
+
+ for (;;)
{
- strcpy(__c_mode, "r+");
- __p_mode |= O_RDWR | O_CREAT;
+#ifdef _GLIBCXX_USE_STDIO_PURE
+ const std::streamsize __ret = fwrite(__s, 1, __nleft, __file);
+ if (__ret == 0 && ferror(__file))
+ break;
+#else
+ const std::streamsize __ret = write(__fd, __s, __nleft);
+ if (__ret == -1L && errno == EINTR)
+ continue;
+ if (__ret == -1L)
+ break;
+#endif
+ __nleft -= __ret;
+ if (__nleft == 0)
+ break;
+
+ __s += __ret;
}
- if (__testi && __testo && __testt && !__testa)
+
+ return __n - __nleft;
+ }
+
+#if defined(_GLIBCXX_HAVE_WRITEV) && !defined(_GLIBCXX_USE_STDIO_PURE)
+ // Wrapper handling partial writev.
+ static std::streamsize
+ xwritev(int __fd, const char* __s1, std::streamsize __n1,
+ const char* __s2, std::streamsize __n2)
+ {
+ std::streamsize __nleft = __n1 + __n2;
+ std::streamsize __n1_left = __n1;
+
+ struct iovec __iov[2];
+ __iov[1].iov_base = const_cast<char*>(__s2);
+ __iov[1].iov_len = __n2;
+
+ for (;;)
{
- strcpy(__c_mode, "w+");
- __p_mode |= O_RDWR | O_CREAT | O_TRUNC;
+ __iov[0].iov_base = const_cast<char*>(__s1);
+ __iov[0].iov_len = __n1_left;
+
+ const std::streamsize __ret = writev(__fd, __iov, 2);
+ if (__ret == -1L && errno == EINTR)
+ continue;
+ if (__ret == -1L)
+ break;
+
+ __nleft -= __ret;
+ if (__nleft == 0)
+ break;
+
+ const std::streamsize __off = __ret - __n1_left;
+ if (__off >= 0)
+ {
+ __nleft -= xwrite(__fd, __s2 + __off, __n2 - __off);
+ break;
+ }
+
+ __s1 += __ret;
+ __n1_left -= __ret;
}
- if (__testb)
- strcat(__c_mode, "b");
+
+ return __n1 + __n2 - __nleft;
}
-
+#endif
+} // anonymous namespace
+
+
+namespace std _GLIBCXX_VISIBILITY(default)
+{
+_GLIBCXX_BEGIN_NAMESPACE_VERSION
+
+ // Definitions for __basic_file<char>.
+ __basic_file<char>::__basic_file(__c_lock* /*__lock*/) throw()
+ : _M_cfile(NULL), _M_cfile_created(false) { }
+
+ __basic_file<char>::~__basic_file()
+ { this->close(); }
+
__basic_file<char>*
- __basic_file<char>::sys_open(__c_file* __file, ios_base::openmode)
+ __basic_file<char>::sys_open(__c_file* __file, ios_base::openmode)
{
__basic_file* __ret = NULL;
if (!this->is_open() && __file)
{
- _M_cfile = __file;
- _M_cfile_created = false;
- __ret = this;
+ int __err, __save_errno = errno;
+ // POSIX guarantees that fflush sets errno on error, but C doesn't.
+ errno = 0;
+ do
+ __err = fflush(__file);
+ while (__err && errno == EINTR);
+ errno = __save_errno;
+ if (!__err)
+ {
+ _M_cfile = __file;
+ _M_cfile_created = false;
+ __ret = this;
+ }
}
return __ret;
}
-
+
__basic_file<char>*
- __basic_file<char>::sys_open(int __fd, ios_base::openmode __mode,
- bool __del)
+ __basic_file<char>::sys_open(int __fd, ios_base::openmode __mode) throw ()
{
__basic_file* __ret = NULL;
- int __p_mode = 0;
- int __rw_mode = 0;
- char __c_mode[4];
-
- _M_open_mode(__mode, __p_mode, __rw_mode, __c_mode);
- if (!this->is_open() && (_M_cfile = fdopen(__fd, __c_mode)))
+ const char* __c_mode = fopen_mode(__mode);
+ if (__c_mode && !this->is_open() && (_M_cfile = fdopen(__fd, __c_mode)))
{
- // Iff __del is true, then close will fclose the fd.
- _M_cfile_created = __del;
-
+ char* __buf = NULL;
+ _M_cfile_created = true;
if (__fd == 0)
- setvbuf(_M_cfile, reinterpret_cast<char*>(NULL), _IONBF, 0);
-
+ setvbuf(_M_cfile, __buf, _IONBF, 0);
__ret = this;
}
return __ret;
}
- int
- __basic_file<char>::sys_getc()
- { return getc(_M_cfile); }
-
- int
- __basic_file<char>::sys_ungetc(int __c)
- { return ungetc(__c, _M_cfile); }
-
- __basic_file<char>*
- __basic_file<char>::open(const char* __name, ios_base::openmode __mode,
+ __basic_file<char>*
+ __basic_file<char>::open(const char* __name, ios_base::openmode __mode,
int /*__prot*/)
{
__basic_file* __ret = NULL;
- int __p_mode = 0;
- int __rw_mode = 0;
- char __c_mode[4];
-
- _M_open_mode(__mode, __p_mode, __rw_mode, __c_mode);
-
- if (!this->is_open())
+ const char* __c_mode = fopen_mode(__mode);
+ if (__c_mode && !this->is_open())
{
if ((_M_cfile = fopen(__name, __c_mode)))
{
}
return __ret;
}
-
- bool
- __basic_file<char>::is_open() const
+
+#if _GLIBCXX_HAVE__WFOPEN && _GLIBCXX_USE_WCHAR_T
+ __basic_file<char>*
+ __basic_file<char>::open(const wchar_t* __name, ios_base::openmode __mode)
+ {
+ __basic_file* __ret = NULL;
+ const char* __c_mode = fopen_mode(__mode);
+ if (__c_mode && !this->is_open())
+ {
+ wchar_t __wc_mode[4] = { };
+ int __i = 0;
+ do
+ {
+ switch(__c_mode[__i]) {
+ case 'a': __wc_mode[__i] = L'a'; break;
+ case 'b': __wc_mode[__i] = L'b'; break;
+ case 'r': __wc_mode[__i] = L'r'; break;
+ case 'w': __wc_mode[__i] = L'w'; break;
+ case '+': __wc_mode[__i] = L'+'; break;
+ default: return __ret;
+ }
+ }
+ while (__c_mode[++__i]);
+
+ if ((_M_cfile = _wfopen(__name, __wc_mode)))
+ {
+ _M_cfile_created = true;
+ __ret = this;
+ }
+ }
+ return __ret;
+ }
+#endif
+
+ bool
+ __basic_file<char>::is_open() const throw ()
{ return _M_cfile != 0; }
-
- int
- __basic_file<char>::fd()
- { return fileno(_M_cfile) ; }
-
- __basic_file<char>*
+
+#ifndef _GLIBCCXX_USE_STDIO_PURE
+ int
+ __basic_file<char>::fd() throw ()
+ { return fileno(_M_cfile); }
+#endif
+
+ __c_file*
+ __basic_file<char>::file() throw ()
+ { return _M_cfile; }
+
+ __basic_file<char>*
__basic_file<char>::close()
- {
- __basic_file* __retval = static_cast<__basic_file*>(NULL);
+ {
+ __basic_file* __ret = static_cast<__basic_file*>(NULL);
if (this->is_open())
{
+ int __err = 0;
if (_M_cfile_created)
- fclose(_M_cfile);
- else
- fflush(_M_cfile);
+ __err = fclose(_M_cfile);
_M_cfile = 0;
- __retval = this;
+ if (!__err)
+ __ret = this;
}
- return __retval;
+ return __ret;
}
-
- streamsize
+
+ streamsize
__basic_file<char>::xsgetn(char* __s, streamsize __n)
- { return fread(__s, 1, __n, _M_cfile); }
-
- streamsize
+ {
+ streamsize __ret;
+#ifdef _GLIBCXX_USE_STDIO_PURE
+ __ret = fread(__s, 1, __n, this->file());
+ if (__ret == 0 && ferror(this->file()))
+ __ret = -1;
+#else
+ do
+ __ret = read(this->fd(), __s, __n);
+ while (__ret == -1L && errno == EINTR);
+#endif
+ return __ret;
+ }
+
+ streamsize
__basic_file<char>::xsputn(const char* __s, streamsize __n)
- { return fwrite(__s, 1, __n, _M_cfile); }
+ {
+#ifdef _GLIBCXX_USE_STDIO_PURE
+ return xwrite(this->file(), __s, __n);
+#else
+ return xwrite(this->fd(), __s, __n);
+#endif
+ }
+
+ streamsize
+ __basic_file<char>::xsputn_2(const char* __s1, streamsize __n1,
+ const char* __s2, streamsize __n2)
+ {
+ streamsize __ret = 0;
+#if defined(_GLIBCXX_HAVE_WRITEV) && !defined(_GLIBCXX_USE_STDIO_PURE)
+ __ret = xwritev(this->fd(), __s1, __n1, __s2, __n2);
+#else
+ if (__n1)
+#ifdef _GLIBCXX_USE_STDIO_PURE
+ __ret = xwrite(this->file(), __s1, __n1);
+#else
+ __ret = xwrite(this->fd(), __s1, __n1);
+#endif
+
+ if (__ret == __n1)
+#ifdef _GLIBCXX_USE_STDIO_PURE
+ __ret += xwrite(this->file(), __s2, __n2);
+#else
+ __ret += xwrite(this->fd(), __s2, __n2);
+#endif
+#endif
+ return __ret;
+ }
- streampos
- __basic_file<char>::seekoff(streamoff off, ios_base::seekdir way,
- ios_base::openmode /*__mode*/)
+ namespace
{
- streampos ret(-1);
- fpos_t tmp;
- if (!fseek(_M_cfile, off, way) && !fgetpos(_M_cfile, &tmp))
- ret = tmp;
- return ret;
+ inline streamoff
+ get_file_offset(__basic_file<char>* __f)
+ {
+#ifdef _GLIBCXX_USE_STDIO_PURE
+# ifdef _GLIBCXX_USE_FSEEKO_FTELLO
+ return ftello(__f->file());
+# else
+ return ftell(__f->file());
+# endif
+#else
+ return lseek(__f->fd(), 0, (int)ios_base::cur);
+#endif
+ }
}
- streampos
- __basic_file<char>::seekpos(streampos pos, ios_base::openmode /*__mode*/)
+ streamoff
+ __basic_file<char>::seekoff(streamoff __off, ios_base::seekdir __way) throw ()
{
- streampos ret(-1);
- fpos_t tmp = pos;
- if (!fsetpos(_M_cfile, &tmp) && !fgetpos(_M_cfile, &tmp))
- ret = tmp;
- return ret;
+#ifdef _GLIBCXX_USE_STDIO_PURE
+#ifdef _GLIBCXX_USE_FSEEKO_FTELLO
+ if _GLIBCXX17_CONSTEXPR (sizeof(off_t) > sizeof(long))
+ {
+ if (fseeko(this->file(), __off, __way))
+ return -1;
+ }
+ else
+#endif
+ {
+ if (__off > numeric_limits<long>::max()
+ || __off < numeric_limits<long>::min())
+ return -1;
+ if (fseek(this->file(), __off, __way))
+ return -1;
+ }
+ return __way == ios_base::beg ? __off : std::get_file_offset(this);
+#else
+ if _GLIBCXX17_CONSTEXPR (sizeof(streamoff) > sizeof(off_t))
+ if (__off > numeric_limits<off_t>::max()
+ || __off < numeric_limits<off_t>::min())
+ return -1L;
+ return lseek(this->fd(), __off, __way);
+#endif
}
- int
- __basic_file<char>::sync()
+ int
+ __basic_file<char>::sync()
{ return fflush(_M_cfile); }
streamsize
__basic_file<char>::showmanyc()
{
+#if !defined(_GLIBCXX_NO_IOCTL) && !defined(_GLIBCXX_USE_STDIO_PURE)
#ifdef FIONREAD
- // Pipes and sockets.
+ // Pipes and sockets.
int __num = 0;
int __r = ioctl(this->fd(), FIONREAD, &__num);
if (!__r && __num >= 0)
- return __num;
-#endif
+ return __num;
+#endif
+#endif
-#ifdef _GLIBCPP_HAVE_POLL
+#if defined(_GLIBCXX_HAVE_POLL) && !defined(_GLIBCXX_USE_STDIO_PURE)
// Cheap test.
struct pollfd __pfd[1];
__pfd[0].fd = this->fd();
__pfd[0].events = POLLIN;
if (poll(__pfd, 1, 0) <= 0)
return 0;
-#endif
+#endif
-#if defined(_GLIBCPP_HAVE_S_ISREG) || defined(_GLIBCPP_HAVE_S_IFREG)
+#if defined(_GLIBCXX_HAVE_S_ISREG) || defined(_GLIBCXX_HAVE_S_IFREG)
// Regular files.
struct stat __buffer;
- int __ret = fstat(this->fd(), &__buffer);
- if (!__ret && _GLIBCPP_ISREG(__buffer.st_mode))
- return __buffer.st_size - lseek(this->fd(), 0, ios_base::cur);
+ const int __err = fstat(this->fd(), &__buffer);
+ if (!__err && _GLIBCXX_ISREG(__buffer.st_mode))
+ {
+ const streamoff __off = __buffer.st_size - std::get_file_offset(this);
+ return std::min(__off, streamoff(numeric_limits<streamsize>::max()));
+ }
#endif
return 0;
}
-} // namespace std
+ __basic_file<char>::native_handle_type
+ __basic_file<char>::native_handle() const noexcept
+ {
+#ifdef _GLIBCXX_USE_STDIO_PURE
+ return _M_cfile;
+#elif _GLIBCXX_USE__GET_OSFHANDLE
+ const intptr_t handle = _M_cfile ? _get_osfhandle(fileno(_M_cfile)) : -1;
+ return reinterpret_cast<native_handle_type>(handle);
+#else
+ return fileno(_M_cfile);
+#endif
+ }
+
+_GLIBCXX_END_NAMESPACE_VERSION
+} // namespace
+