Base device class. More...

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

Inheritance diagram for os::posix::device:

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
	device (device_impl &impl, type t, const char *name)

virtual	~device () override

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)

Public Member Functions
int	open (const char *path=nullptr, int oflag=0,...)

int	vopen (const char *path, int oflag, std::va_list args)

virtual int	close (void) override

int	ioctl (int request,...)

virtual int	vioctl (int request, std::va_list args)

virtual void	sync (void)

virtual bool	match_name (const char *name) const

const char *	name (void) const

device_impl &	impl (void) const

static const char *	device_prefix (void)

Detailed Description

Definition at line 66 of file device.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

◆ device()

os::posix::device::device	(	device_impl &	impl,
		type	t,
		const char *	name
	)

Definition at line 39 of file device.cpp.

        : io{ impl, t }, //
          name_ (name)
    {
#if defined(OS_TRACE_POSIX_IO_DEVICE)
      trace::printf ("device::%s(\"%s\")=%p\n", __func__, name_, this);
#endif
    }

References os::trace::printf().

◆ ~device()

os::posix::device::~device ( )

overridevirtual

Definition at line 48 of file device.cpp.

    {
#if defined(OS_TRACE_POSIX_IO_DEVICE)
      trace::printf ("device::%s() @%p\n", __func__, this);
#endif
 
      registry_links_.unlink ();
 
      name_ = nullptr;
    }

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

overridevirtual

Reimplemented from os::posix::io.

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

Definition at line 111 of file device.cpp.

    {
#if defined(OS_TRACE_POSIX_IO_DEVICE)
      trace::printf ("device::%s() @%p\n", __func__, this);
#endif
 
      errno = 0;
 
      int ret = 0;
      if (impl ().open_count_ == 1)
        {
          ret = io::close ();
        }
 
      if (impl ().open_count_ > 0)
        {
          // Must be after close(), to keep do_is_open() true.
          --(impl ().open_count_);
        }
 
      return ret;
    }

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

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

◆ device_prefix()

const char * os::posix::device::device_prefix ( void )

inlinestatic

Definition at line 316 of file device.h.

    {
      return OS_STRING_POSIX_DEVICE_PREFIX;
    }

References OS_STRING_POSIX_DEVICE_PREFIX.

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

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

device_impl & os::posix::device::impl ( void ) const

inline

Definition at line 310 of file device.h.

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

Referenced by close(), sync(), vioctl(), and vopen().

◆ ioctl()

int os::posix::device::ioctl	(	int	request,
			...
	)

Definition at line 135 of file device.cpp.

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

References vioctl().

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

◆ match_name()

bool os::posix::device::match_name ( const char * name ) const

virtual

Definition at line 189 of file device.cpp.

    {
      assert (name != nullptr);
      assert (name_ != nullptr);
 
      return (std::strcmp (name, name_) == 0);
    }

References name().

◆ name()

const char * os::posix::device::name ( void ) const

inline

Definition at line 304 of file device.h.

    {
      return name_;
    }

Referenced by os::posix::device_registry< T >::link(), and match_name().

◆ open()

int os::posix::device::open	(	const char *	path = `nullptr`,
		int	oflag = `0`,
			...
	)

Parameters

path	May be nullptr.
oflag	Output flags

Returns: non-negative file descriptor, -1 on failure

Definition at line 62 of file device.cpp.

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

References vopen().

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

◆ sync()

void os::posix::device::sync ( void )

virtual

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

Definition at line 171 of file device.cpp.

    {
#if defined(OS_TRACE_POSIX_IO_DEVICE)
      trace::printf ("device::%s() @%p\n", __func__, this);
#endif
 
      if (impl ().open_count_ == 0)
        {
          errno = EBADF; // Not opened.
          return;
        }
 
      impl ().do_sync ();
    }

References os::posix::device_impl::do_sync(), impl(), and os::trace::printf().

Referenced by os::posix::block_device_lockable< T, L >::sync().

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

◆ vioctl()

int os::posix::device::vioctl	(	int	request,
		std::va_list	args
	)

virtual

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

Definition at line 152 of file device.cpp.

    {
#if defined(OS_TRACE_POSIX_IO_DEVICE)
      trace::printf ("device::%s(%d) @%p\n", __func__, request, this);
#endif
 
      if (impl ().open_count_ == 0)
        {
          errno = EBADF; // Not opened.
          return -1;
        }
 
      errno = 0;
 
      return impl ().do_vioctl (request, args);
    }

References os::posix::device_impl::do_vioctl(), impl(), and os::trace::printf().

Referenced by ioctl().

◆ vopen()

int os::posix::device::vopen	(	const char *	path,
		int	oflag,
		std::va_list	args
	)

Parameters

path	May be nullptr.
oflag	Output flags
args	Arguments

Returns: non-negative file descriptor, -1 on failure

Definition at line 74 of file device.cpp.

    {
#if defined(OS_TRACE_POSIX_IO_DEVICE)
      trace::printf ("device::%s(\"%s\") @%p\n", __func__, path ? path : "",
                     this);
#endif
 
      errno = 0;
 
      int ret = 0;
      if (impl ().open_count_ == 0)
        {
          // If so, use the implementation to open the device.
          ret = impl ().do_vopen (path, oflag, args);
          if (ret < 0)
            {
              // Open failed.
              return -1;
            }
 
          auto iop = alloc_file_descriptor ();
          if (iop == nullptr)
            {
              return -1;
            }
        }
      ++(impl ().open_count_);
      ret = file_descriptor ();
#if defined(OS_TRACE_POSIX_IO_DEVICE)
      trace::printf ("device::%s(\"%s\")=%p fd=%d\n", __func__,
                     path ? path : "", this, ret);
#endif
 
      return ret;
    }

References os::posix::io::alloc_file_descriptor(), os::posix::device_impl::do_vopen(), os::posix::io::file_descriptor(), impl(), and os::trace::printf().

Referenced by open().

◆ 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:

Public Types

Public Member Functions

Protected Member Functions

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ type_t

Member Enumeration Documentation

◆ type

Constructor & Destructor Documentation

◆ device()

◆ ~device()

Member Function Documentation

◆ alloc_file_descriptor()

◆ clear_file_descriptor()

◆ close()

◆ device_prefix()

◆ fcntl()

◆ file_descriptor() [1/2]

◆ file_descriptor() [2/2]

◆ fstat()

◆ get_type()

◆ impl()

◆ ioctl()

◆ is_opened()

◆ isatty()

◆ lseek()

◆ match_name()

◆ name()

◆ open()

◆ read()

◆ sync()

◆ vfcntl()

◆ vioctl()

◆ vopen()

◆ write()

◆ writev()