io.h

Go to the documentation of this file.

/*
 * This file is part of the µOS++ project (https://micro-os-plus.github.io/).
 * Copyright (c) 2015-2025 Liviu Ionescu. All rights reserved.
 *
 * Permission to use, copy, modify, and/or distribute this software
 * for any purpose is hereby granted, under the terms of the MIT license.
 *
 * If a copy of the license was not distributed with this file, it can
 * be obtained from https://opensource.org/licenses/mit.
 */
 
#ifndef CMSIS_PLUS_POSIX_IO_IO_H_
#define CMSIS_PLUS_POSIX_IO_IO_H_
 
// ----------------------------------------------------------------------------
 
#if defined(__cplusplus)
 
// ----------------------------------------------------------------------------
 
#if defined(OS_USE_OS_APP_CONFIG_H)
#include <cmsis-plus/os-app-config.h>
#endif
 
#include <cmsis-plus/posix-io/types.h>
#include <cmsis-plus/diag/trace.h>
 
#include <cstddef>
#include <cstdarg>
 
// Needed for ssize_t
#include <sys/types.h>
 
// ----------------------------------------------------------------------------
 
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wc++98-compat"
#pragma clang diagnostic ignored "-Wdocumentation-unknown-command"
#endif
 
// ----------------------------------------------------------------------------
 
struct iovec;
 
namespace os
{
  namespace posix
  {
    // ------------------------------------------------------------------------
 
    class io;
    class io_impl;
 
    class file_system;
    class socket;
 
    // ------------------------------------------------------------------------
    io*
    open (const char* path, int oflag, ...);
 
    io*
    vopen (const char* path, int oflag, std::va_list args);
 
    // ========================================================================
#pragma GCC diagnostic push
#if defined(__clang__)
#elif defined(__GNUC__)
#pragma GCC diagnostic ignored "-Wsuggest-final-methods"
#endif
    class io
    {
      // ----------------------------------------------------------------------
 
      friend class file_system;
      friend class file_descriptors_manager;
 
      friend io*
      vopen (const char* path, int oflag, std::va_list args);
 
#pragma GCC diagnostic push
#if defined(__clang__)
#elif defined(__GNUC__)
#pragma GCC diagnostic ignored "-Wshadow"
#endif
      friend /* class */ socket*
      socket (int domain, int type, int protocol);
#pragma GCC diagnostic pop
 
      // ----------------------------------------------------------------------
    public:
#pragma GCC diagnostic push
#if defined(__clang__)
#elif defined(__GNUC__)
#pragma GCC diagnostic ignored "-Wshadow"
#endif
 
      using type_t = unsigned int;
      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
      };
 
#pragma GCC diagnostic pop
 
      // ----------------------------------------------------------------------
    protected:
      io (io_impl& impl, type t);
 
      // The rule of five.
      io (const io&) = delete;
      io (io&&) = delete;
      io&
      operator= (const io&)
          = delete;
      io&
      operator= (io&&)
          = delete;
 
      // ----------------------------------------------------------------------
    public:
      virtual ~io ();
 
      // ----------------------------------------------------------------------
    public:
      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 /* struct */ iovec* iov, int iovcnt);
 
      int
      fcntl (int cmd, ...);
 
      virtual int
      vfcntl (int cmd, std::va_list args);
 
      int
      isatty (void);
 
#pragma GCC diagnostic push
#if defined(__clang__)
#elif defined(__GNUC__)
#pragma GCC diagnostic ignored "-Wredundant-tags"
#endif
      virtual int
      fstat (struct stat* buf);
#pragma GCC diagnostic pop
 
      virtual off_t
      lseek (off_t offset, int whence);
 
      // ----------------------------------------------------------------------
      // Support functions.
 
      type_t
      get_type (void) const;
 
      file_descriptor_t
      file_descriptor (void) const;
 
      bool
      is_opened (void);
 
      io_impl&
      impl (void) const;
 
      // ----------------------------------------------------------------------
    protected:
      // ----------------------------------------------------------------------
      // Support functions.
 
#if 0
      // Is called at the end of close, to release objects
      // acquired from a pool.
      virtual void
      do_release (void);
#endif
 
      void
      file_descriptor (file_descriptor_t fildes);
 
      void
      clear_file_descriptor (void);
 
      io*
      alloc_file_descriptor (void);
 
      // ----------------------------------------------------------------------
    protected:
      io_impl& impl_;
 
      // ----------------------------------------------------------------------
    protected:
      type_t type_ = static_cast<type_t> (type::not_set);
 
      file_descriptor_t file_descriptor_ = no_file_descriptor;
 
    };
#pragma GCC diagnostic pop
 
    // ========================================================================
 
#pragma GCC diagnostic push
#if defined(__clang__)
#elif defined(__GNUC__)
#pragma GCC diagnostic ignored "-Wsuggest-final-methods"
#pragma GCC diagnostic ignored "-Wsuggest-final-types"
#endif
    class io_impl
    {
      // ----------------------------------------------------------------------
 
      friend class io;
 
    public:
      io_impl (void);
 
      // The rule of five.
      io_impl (const io_impl&) = delete;
      io_impl (io_impl&&) = delete;
      io_impl&
      operator= (const io_impl&)
          = delete;
      io_impl&
      operator= (io_impl&&)
          = delete;
 
      virtual ~io_impl ();
 
      // ----------------------------------------------------------------------
    public:
      // Implementations
 
      virtual void
      do_deallocate (void);
 
      virtual bool
      do_is_opened (void)
          = 0;
 
      virtual bool
      do_is_connected (void);
 
      virtual ssize_t
      do_read (void* buf, std::size_t nbyte)
          = 0;
 
      virtual ssize_t
      do_write (const void* buf, std::size_t nbyte)
          = 0;
 
      virtual ssize_t
      do_writev (const /* struct */ iovec* iov, int iovcnt);
 
      virtual int
      do_vfcntl (int cmd, std::va_list args);
 
      virtual int
      do_isatty (void);
 
#pragma GCC diagnostic push
#if defined(__clang__)
#elif defined(__GNUC__)
#pragma GCC diagnostic ignored "-Wredundant-tags"
#endif
      virtual int
      do_fstat (struct stat* buf);
#pragma GCC diagnostic pop
 
      virtual off_t
      do_lseek (off_t offset, int whence)
          = 0;
 
      virtual int
      do_close (void)
          = 0;
 
      // ----------------------------------------------------------------------
      // Support functions.
 
      off_t
      offset (void);
 
      void
      offset (off_t offset);
 
      // ----------------------------------------------------------------------
    protected:
      off_t offset_ = 0;
 
    };
#pragma GCC diagnostic pop
 
    // ========================================================================
  } /* namespace posix */
} /* namespace os */
 
// ===== Inline & template implementations ====================================
 
namespace os
{
  namespace posix
  {
    // ========================================================================
 
    inline io::type_t
    io::get_type (void) const
    {
      return type_;
    }
 
    inline void
    io::file_descriptor (file_descriptor_t fildes)
    {
      file_descriptor_ = fildes;
    }
 
    inline void
    io::clear_file_descriptor (void)
    {
      file_descriptor_ = no_file_descriptor;
    }
 
    inline file_descriptor_t
    io::file_descriptor (void) const
    {
      return file_descriptor_;
    }
 
    inline bool
    io::is_opened (void)
    {
      return impl ().do_is_opened ();
    }
 
    inline io_impl&
    io::impl (void) const
    {
      return impl_;
    }
 
    // ========================================================================
 
    inline off_t
    io_impl::offset (void)
    {
      return offset_;
    }
 
    inline void
    io_impl::offset (off_t offset)
    {
      offset_ = offset;
    }
 
    // ========================================================================
  } /* namespace posix */
} /* namespace os */
 
#pragma GCC diagnostic pop
 
// ----------------------------------------------------------------------------
 
#endif /* __cplusplus */
 
// ----------------------------------------------------------------------------
 
#endif /* CMSIS_PLUS_POSIX_IO_IO_H_ */