Base I/O class. More...

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

Inheritance diagram for os::posix::io:

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
Public Member Functions
virtual int	close (void)

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)

io_impl &	impl (void) const

Protected Member Functions
Private Member Functions
void	file_descriptor (file_descriptor_t fildes)

void	clear_file_descriptor (void)

io *	alloc_file_descriptor (void)

Constructors & Destructor
	io (io_impl &impl, type t)

virtual	~io ()

Detailed Description

Definition at line 85 of file io.h.

Member Typedef Documentation

◆ type_t

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

Definition at line 125 of file io.h.

Member Enumeration Documentation

◆ type

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

strong

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

◆ io()

os::posix::io::io	(	io_impl &	impl,
		type	t
	)

protected

Definition at line 141 of file io.cpp.

        : impl_ (impl), //
          type_ (static_cast<type_t> (t))
    {
#if defined(OS_TRACE_POSIX_IO_IO)
      trace::printf ("io::%s()=%p\n", __func__, this);
#endif
 
      file_descriptor_ = no_file_descriptor;
    }

References os::posix::no_file_descriptor, and os::trace::printf().

◆ ~io()

os::posix::io::~io ( )

virtual

Definition at line 152 of file io.cpp.

    {
#if defined(OS_TRACE_POSIX_IO_IO)
      trace::printf ("io::%s() @%p\n", __func__, this);
#endif
 
      file_descriptor_ = no_file_descriptor;
    }

References os::posix::no_file_descriptor, and os::trace::printf().

Member Function Documentation

◆ alloc_file_descriptor()

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

protected

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(), clear_file_descriptor(), os::posix::io_impl::do_close(), 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 )

inlineprotected

Definition at line 446 of file io.h.

    {
      file_descriptor_ = no_file_descriptor;
    }

References os::posix::no_file_descriptor.

Referenced by alloc_file_descriptor().

◆ close()

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

virtual

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

Definition at line 164 of file io.cpp.

    {
#if defined(OS_TRACE_POSIX_IO_IO)
      trace::printf ("io::%s() @%p\n", __func__, this);
#endif
 
      if (!impl ().do_is_opened ())
        {
          errno = EBADF; // Not opened.
          return -1;
        }
 
      errno = 0;
 
      // Execute the implementation specific code.
      int ret = impl ().do_close ();
 
      // Remove this IO from the file descriptors registry.
      file_descriptors_manager::deallocate (file_descriptor_);
      file_descriptor_ = no_file_descriptor;
 
      return ret;
    }

References os::posix::file_descriptors_manager::deallocate(), os::posix::io_impl::do_close(), impl(), os::posix::no_file_descriptor, and os::trace::printf().

Referenced by os::posix::device::close(), os::posix::file::close(), and os::posix::socket_lockable< T, L >::close().

◆ fcntl()

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

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 vfcntl().

◆ file_descriptor() [1/2]

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

inlineprotected

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

inline

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 )

virtual

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(), impl(), and os::trace::printf().

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

◆ get_type()

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

inline

Definition at line 434 of file io.h.

    {
      return type_;
    }

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

◆ impl()

io_impl & os::posix::io::impl ( void ) const

inline

Definition at line 464 of file io.h.

    {
      return impl_;
    }

Referenced by alloc_file_descriptor(), close(), fstat(), is_opened(), isatty(), lseek(), read(), vfcntl(), write(), and writev().

◆ is_opened()

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

inline

Definition at line 458 of file io.h.

    {
      return impl ().do_is_opened ();
    }

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

◆ isatty()

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

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 impl().

◆ lseek()

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

virtual

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(), 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
	)

virtual

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(), 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
	)

virtual

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(), impl(), and os::trace::printf().

Referenced by 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
	)

virtual

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(), 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
	)

virtual

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(), 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:

io.h
io.cpp

Public Types

Public Member Functions

Protected Member Functions

Constructors & Destructor

Detailed Description

Member Typedef Documentation

◆ type_t

Member Enumeration Documentation

◆ type

Constructor & Destructor Documentation

◆ io()

◆ ~io()

Member Function Documentation

◆ alloc_file_descriptor()

◆ clear_file_descriptor()

◆ close()

◆ fcntl()

◆ file_descriptor() [1/2]

◆ file_descriptor() [2/2]

◆ fstat()

◆ get_type()

◆ impl()

◆ is_opened()

◆ isatty()

◆ lseek()

◆ read()

◆ vfcntl()

◆ write()

◆ writev()