os::posix::file Class Reference

File class. More...

#include <cmsis-plus/posix-io/file.h>

Inheritance diagram for os::posix::file:

Public Types
Types & Constants
enum class	type : type_t {   unknown = 0 ,   not_set = 1 << 0 ,   char_device = 1 << 1 ,   block_device = 1 << 2 ,   tty = 1 << 3 ,   file = 1 << 4 ,   socket = 1 << 5 }
using	type_t = unsigned int

Public Member Functions
Constructors & Destructor
	file (file_impl &impl)
virtual	~file () override
Public Member Functions
virtual int	close (void) override
virtual int	ftruncate (off_t length)
virtual int	fsync (void)
virtual int	fstatvfs (struct statvfs *buf)
class file_system &	get_file_system (void)
file_impl &	impl (void) const
Public Member Functions
virtual ssize_t	read (void *buf, std::size_t nbyte)
virtual ssize_t	write (const void *buf, std::size_t nbyte)
virtual ssize_t	writev (const iovec *iov, int iovcnt)
int	fcntl (int cmd,...)
virtual int	vfcntl (int cmd, std::va_list args)
int	isatty (void)
virtual int	fstat (struct stat *buf)
virtual off_t	lseek (off_t offset, int whence)
type_t	get_type (void) const
file_descriptor_t	file_descriptor (void) const
bool	is_opened (void)

Protected Member Functions
Private Member Functions
void	file_descriptor (file_descriptor_t fildes)
void	clear_file_descriptor (void)
io *	alloc_file_descriptor (void)

Detailed Description

Definition at line 63 of file file.h.

Member Typedef Documentation

type_t

using os::posix::io::type_t = unsigned int

inherited

Definition at line 125 of file io.h.

Member Enumeration Documentation

type

enum class os::posix::io::type : type_t

stronginherited

Enumerator
unknown
not_set
char_device
block_device
tty
file
socket

Definition at line 126 of file io.h.

      {
        unknown = 0,
        not_set = 1 << 0,
        char_device = 1 << 1,
        block_device = 1 << 2,
        tty = 1 << 3,
        file = 1 << 4,
        socket = 1 << 5
      };

Constructor & Destructor Documentation

file()

os::posix::file::file

(

file_impl &

impl

)

Definition at line 37 of file file.cpp.

                               : io{ impl, type::file }
    {
#if defined(OS_TRACE_POSIX_IO_FILE)
      trace::printf ("file::%s()=%p\n", __func__, this);
#endif
    }

References os::trace::printf().

~file()

os::posix::file::~file ( )

overridevirtual

Definition at line 44 of file file.cpp.

    {
#if defined(OS_TRACE_POSIX_IO_FILE)
      trace::printf ("file::%s() @%p\n", __func__, this);
#endif
    }

References os::trace::printf().

Member Function Documentation

alloc_file_descriptor()

io * os::posix::io::alloc_file_descriptor ( void  )

protectedinherited

Definition at line 189 of file io.cpp.

    {
#if defined(OS_TRACE_POSIX_IO_IO)
      trace::printf ("io::%s() @%p\n", __func__, this);
#endif
 
      int fd = file_descriptors_manager::allocate (this);
      if (fd < 0)
        {
          // If allocation failed, close this object.
          impl ().do_close ();
          clear_file_descriptor ();
          return nullptr;
        }
 
#if defined(OS_TRACE_POSIX_IO_IO)
      trace::printf ("io::%s() @%p fd=%d\n", __func__, this, fd);
#endif
 
      // Return a valid pointer to an object derived from `io`.
      return this;
    }

References os::posix::file_descriptors_manager::allocate(), os::posix::io::clear_file_descriptor(), os::posix::io_impl::do_close(), os::posix::io::impl(), and os::trace::printf().

Referenced by os::posix::socket::accept(), os::posix::socket(), os::posix::device::vopen(), and os::posix::file_system::vopen().

clear_file_descriptor()

void os::posix::io::clear_file_descriptor ( void  )

inlineprotectedinherited

Definition at line 446 of file io.h.

    {
      file_descriptor_ = no_file_descriptor;
    }

References os::posix::no_file_descriptor.

Referenced by os::posix::io::alloc_file_descriptor().

close()

int os::posix::file::close ( void  )

overridevirtual

Reimplemented from os::posix::io.

Reimplemented in os::posix::file_lockable< T, L >.

Definition at line 54 of file file.cpp.

    {
#if defined(OS_TRACE_POSIX_IO_FILE)
      trace::printf ("file::%s() @%p\n", __func__, this);
#endif
 
      int ret = io::close ();
 
      // Note: the constructor is not called here.
 
      // Link the file object to a list kept by the file system.
      // It will be deallocated at the next open.
      get_file_system ().add_deferred_file (this);
 
      return ret;
    }

References os::posix::file_system::add_deferred_file(), os::posix::io::close(), get_file_system(), and os::trace::printf().

Referenced by os::posix::file_lockable< T, L >::close().

fcntl()

int os::posix::io::fcntl ( int  cmd,   ...  )

inherited

Definition at line 363 of file io.cpp.

    {
      // Forward to the variadic version of the function.
      std::va_list args;
      va_start (args, cmd);
      int ret = vfcntl (cmd, args);
      va_end (args);
 
      return ret;
    }

References os::posix::io::vfcntl().

file_descriptor() [1/2]

void os::posix::io::file_descriptor ( file_descriptor_t  fildes )

inlineprotectedinherited

Definition at line 440 of file io.h.

    {
      file_descriptor_ = fildes;
    }

file_descriptor() [2/2]

file_descriptor_t os::posix::io::file_descriptor ( void  ) const

inlineinherited

Definition at line 452 of file io.h.

    {
      return file_descriptor_;
    }

Referenced by os::posix::file_descriptors_manager::allocate(), os::posix::file_descriptors_manager::assign(), os::posix::device::vopen(), and os::posix::vopen().

fstat()

int os::posix::io::fstat ( struct stat *  buf )

virtualinherited

Reimplemented in os::posix::file_lockable< T, L >.

Definition at line 416 of file io.cpp.

    {
#if defined(OS_TRACE_POSIX_IO_IO)
      trace::printf ("io::%s(%p) @%p\n", __func__, buf, this);
#endif
 
      if (buf == nullptr)
        {
          errno = EFAULT;
          return -1;
        }
 
      if (!impl ().do_is_opened ())
        {
          errno = EBADF; // Not opened.
          return -1;
        }
 
      if (!impl ().do_is_connected ())
        {
          errno = EIO; // Not opened.
          return -1;
        }
 
      errno = 0;
 
      // Execute the implementation specific code.
      return impl ().do_fstat (buf);
    }

References os::posix::io_impl::do_fstat(), os::posix::io::impl(), and os::trace::printf().

Referenced by os::posix::file_lockable< T, L >::fstat().

fstatvfs()

int os::posix::file::fstatvfs ( struct statvfs *  buf )

virtual

Definition at line 104 of file file.cpp.

    {
#if defined(OS_TRACE_POSIX_IO_FILE)
      trace::printf ("file::%s(%p) @%p\n", __func__, buf, this);
#endif
 
      errno = 0;
 
      // Execute the file system code. Might be locked there.
      return get_file_system ().statvfs (buf);
    }

References get_file_system(), os::trace::printf(), and os::posix::file_system::statvfs().

fsync()

int os::posix::file::fsync ( void  )

virtual

Reimplemented in os::posix::file_lockable< T, L >.

Definition at line 91 of file file.cpp.

    {
#if defined(OS_TRACE_POSIX_IO_FILE)
      trace::printf ("file::%s() @%p\n", __func__, this);
#endif
 
      errno = 0;
 
      // Execute the implementation specific code.
      return impl ().do_fsync ();
    }

References os::posix::file_impl::do_fsync(), impl(), and os::trace::printf().

Referenced by os::posix::file_lockable< T, L >::fsync().

ftruncate()

int os::posix::file::ftruncate ( off_t  length )

virtual

Reimplemented in os::posix::file_lockable< T, L >.

Definition at line 72 of file file.cpp.

    {
#if defined(OS_TRACE_POSIX_IO_FILE)
      trace::printf ("file::%s(%u) @%p\n", __func__, length, this);
#endif
 
      if (length < 0)
        {
          errno = EINVAL;
          return -1;
        }
 
      errno = 0;
 
      // Execute the implementation specific code.
      return impl ().do_ftruncate (length);
    }

References os::posix::file_impl::do_ftruncate(), impl(), and os::trace::printf().

Referenced by os::posix::file_lockable< T, L >::ftruncate().

get_file_system()

file_system & os::posix::file::get_file_system ( void  )

inline

Definition at line 478 of file file.h.

    {
      return impl ().get_file_system ();
    }

References os::posix::file_impl::get_file_system(), and impl().

Referenced by close(), and fstatvfs().

get_type()

io::type_t os::posix::io::get_type ( void  ) const

inlineinherited

Definition at line 434 of file io.h.

    {
      return type_;
    }

Referenced by os::posix::file_descriptors_manager::socket().

impl()

file_impl & os::posix::file::impl ( void  ) const

inline

Definition at line 484 of file file.h.

    {
      return static_cast<file_impl&> (impl_);
    }

Referenced by fsync(), ftruncate(), and get_file_system().

is_opened()

bool os::posix::io::is_opened ( void  )

inlineinherited

Definition at line 458 of file io.h.

    {
      return impl ().do_is_opened ();
    }

References os::posix::io_impl::do_is_opened(), and os::posix::io::impl().

isatty()

int os::posix::io::isatty ( void  )

inherited

Definition at line 406 of file io.cpp.

    {
      errno = 0;
 
      // Execute the implementation specific code.
      return impl ().do_isatty ();
    }

References os::posix::io_impl::do_isatty(), and os::posix::io::impl().

lseek()

off_t os::posix::io::lseek ( off_t  offset, int  whence  )

virtualinherited

Reimplemented in os::posix::block_device_lockable< T, L >, and os::posix::file_lockable< T, L >.

Definition at line 447 of file io.cpp.

    {
#if defined(OS_TRACE_POSIX_IO_IO)
      trace::printf ("io::%s(%d, %d) @%p\n", __func__, offset, whence, this);
#endif
 
      if (!impl ().do_is_opened ())
        {
          errno = EBADF; // Not opened.
          return -1;
        }
 
      errno = 0;
 
      // Execute the implementation specific code.
      return impl ().do_lseek (offset, whence);
    }

References os::posix::io_impl::do_lseek(), os::posix::io::impl(), and os::trace::printf().

Referenced by os::posix::block_device_lockable< T, L >::lseek(), and os::posix::file_lockable< T, L >::lseek().

read()

ssize_t os::posix::io::read ( void *  buf, std::size_t  nbyte  )

virtualinherited

Reimplemented in os::posix::block_device_lockable< T, L >, and os::posix::file_lockable< T, L >.

Definition at line 217 of file io.cpp.

    {
#if defined(OS_TRACE_POSIX_IO_IO)
      trace::printf ("io::%s(0x0%X, %u) @%p\n", __func__, buf, nbyte, this);
#endif
 
      if (buf == nullptr)
        {
          errno = EFAULT;
          return -1;
        }
 
      if (!impl ().do_is_opened ())
        {
          errno = EBADF; // Not opened.
          return -1;
        }
 
      if (!impl ().do_is_connected ())
        {
          errno = EIO; // Not opened.
          return -1;
        }
 
      errno = 0;
 
      // http://pubs.opengroup.org/onlinepubs/9699919799/functions/read.html
      // Before any action described below is taken, and if nbyte is zero,
      // the read() function may detect and return errors as described below.
      // In the absence of errors, or if error detection is not performed,
      // the read() function shall return zero and have no other results.
      if (nbyte == 0)
        {
          return 0; // Nothing to do.
        }
 
      // Execute the implementation specific code.
      ssize_t ret = impl ().do_read (buf, nbyte);
      if (ret >= 0)
        {
          impl ().offset_ += ret;
        }
 
#if defined(OS_TRACE_POSIX_IO_IO)
      trace::printf ("io::%s(0x0%X, %u) @%p n=%d\n", __func__, buf, nbyte,
                     this, ret);
#endif
      return ret;
    }

References os::posix::io_impl::do_read(), os::posix::io::impl(), and os::trace::printf().

Referenced by os::posix::block_device_lockable< T, L >::read(), and os::posix::file_lockable< T, L >::read().

vfcntl()

int os::posix::io::vfcntl ( int  cmd, std::va_list  args  )

virtualinherited

Reimplemented in os::posix::block_device_lockable< T, L >, and os::posix::file_lockable< T, L >.

Definition at line 380 of file io.cpp.

    {
#if defined(OS_TRACE_POSIX_IO_IO)
      trace::printf ("io::%s(%d) @%p\n", __func__, cmd, this);
#endif
 
      if (!impl ().do_is_opened ())
        {
          errno = EBADF; // Not opened.
          return -1;
        }
 
      if (!impl ().do_is_connected ())
        {
          errno = EIO; // Not opened.
          return -1;
        }
 
      errno = 0;
 
      // Execute the implementation specific code.
      return impl ().do_vfcntl (cmd, args);
    }

References os::posix::io_impl::do_vfcntl(), os::posix::io::impl(), and os::trace::printf().

Referenced by os::posix::io::fcntl(), os::posix::block_device_lockable< T, L >::vfcntl(), and os::posix::file_lockable< T, L >::vfcntl().

write()

ssize_t os::posix::io::write ( const void *  buf, std::size_t  nbyte  )

virtualinherited

Reimplemented in os::posix::block_device_lockable< T, L >, and os::posix::file_lockable< T, L >.

Definition at line 268 of file io.cpp.

    {
#if defined(OS_TRACE_POSIX_IO_IO)
      trace::printf ("io::%s(0x0%X, %u) @%p\n", __func__, buf, nbyte, this);
#endif
 
      if (buf == nullptr)
        {
          errno = EFAULT;
          return -1;
        }
 
      if (!impl ().do_is_opened ())
        {
          errno = EBADF; // Not opened.
          return -1;
        }
 
      if (!impl ().do_is_connected ())
        {
          errno = EIO; // Not opened.
          return -1;
        }
 
      errno = 0;
 
      // http://pubs.opengroup.org/onlinepubs/9699919799/functions/pwrite.html
      // Before any action described below is taken, and if nbyte is zero
      // and the file is a regular file, the write() function may detect and
      // return errors as described below. In the absence of errors, or if
      // error detection is not performed, the write() function shall return
      // zero and have no other results. If nbyte is zero and the file is
      // not a regular file, the results are unspecified.
      if (nbyte == 0)
        {
          return 0; // Nothing to do.
        }
 
      // Execute the implementation specific code.
      ssize_t ret = impl ().do_write (buf, nbyte);
      if (ret >= 0)
        {
          impl ().offset_ += ret;
        }
 
#if defined(OS_TRACE_POSIX_IO_IO)
      trace::printf ("io::%s(0x0%X, %u) @%p n=%d\n", __func__, buf, nbyte,
                     this, ret);
#endif
      return ret;
    }

References os::posix::io_impl::do_write(), os::posix::io::impl(), and os::trace::printf().

Referenced by os::posix::block_device_lockable< T, L >::write(), and os::posix::file_lockable< T, L >::write().

writev()

ssize_t os::posix::io::writev ( const iovec *  iov, int  iovcnt  )

virtualinherited

Reimplemented in os::posix::block_device_lockable< T, L >, and os::posix::file_lockable< T, L >.

Definition at line 321 of file io.cpp.

    {
#if defined(OS_TRACE_POSIX_IO_IO)
      trace::printf ("io::%s(0x0%X, %d) @%p\n", __func__, iov, iovcnt, this);
#endif
 
      if (iov == nullptr)
        {
          errno = EFAULT;
          return -1;
        }
 
      if (iovcnt <= 0)
        {
          errno = EINVAL;
          return -1;
        }
 
      if (!impl ().do_is_opened ())
        {
          errno = EBADF; // Not opened.
          return -1;
        }
 
      if (!impl ().do_is_connected ())
        {
          errno = EIO; // Not opened.
          return -1;
        }
 
      errno = 0;
 
      // Execute the implementation specific code.
      ssize_t ret = impl ().do_writev (iov, iovcnt);
      if (ret >= 0)
        {
          impl ().offset_ += ret;
        }
      return ret;
    }

References os::posix::io_impl::do_writev(), os::posix::io::impl(), and os::trace::printf().

Referenced by os::posix::block_device_lockable< T, L >::writev(), and os::posix::file_lockable< T, L >::writev().

---

The documentation for this class was generated from the following files:

• file.h
• file.cpp