block-device.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_BLOCK_DEVICE_H_
#define CMSIS_PLUS_POSIX_IO_BLOCK_DEVICE_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/device.h>
 
// ----------------------------------------------------------------------------
 
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wc++98-compat"
#endif
 
// ----------------------------------------------------------------------------
 
namespace os
{
  namespace posix
  {
    // ------------------------------------------------------------------------
 
    class block_device_impl;
 
    // ========================================================================
 
    // TODO: add support to indicate that there is no media in drive.
    // TODO: add support to indicate the media is write protected.
 
#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 block_device : public device
    {
      // ----------------------------------------------------------------------
 
    public:
      using blknum_t = std::size_t;
 
      // ----------------------------------------------------------------------
 
    public:
      block_device (block_device_impl& impl, const char* name);
 
      // The rule of five.
      block_device (const block_device&) = delete;
      block_device (block_device&&) = delete;
      block_device&
      operator= (const block_device&)
          = delete;
      block_device&
      operator= (block_device&&)
          = delete;
 
      virtual ~block_device () override;
 
      // ----------------------------------------------------------------------
    public:
      virtual int
      vioctl (int request, std::va_list args) override;
 
      virtual ssize_t
      read_block (void* buf, blknum_t blknum, std::size_t nblocks = 1);
 
      virtual ssize_t
      write_block (const void* buf, blknum_t blknum, std::size_t nblocks = 1);
 
      // ----------------------------------------------------------------------
 
      blknum_t
      blocks (void);
 
      std::size_t
      block_logical_size_bytes (void);
 
      std::size_t
      block_physical_size_bytes (void);
 
      // ----------------------------------------------------------------------
      // Support functions.
 
      block_device_impl&
      impl (void) const;
 
      // ----------------------------------------------------------------------
    };
#pragma GCC diagnostic pop
 
    // ========================================================================
 
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wpadded"
#elif defined(__GNUC__)
#pragma GCC diagnostic ignored "-Wpadded"
#endif
 
    class block_device_impl : public device_impl
    {
      // ----------------------------------------------------------------------
 
      friend class block_device;
 
    public:
      using blknum_t = block_device::blknum_t;
 
      // ----------------------------------------------------------------------
 
    public:
      block_device_impl (void);
 
      // The rule of five.
      block_device_impl (const block_device_impl&) = delete;
      block_device_impl (block_device_impl&&) = delete;
      block_device_impl&
      operator= (const block_device_impl&)
          = delete;
      block_device_impl&
      operator= (block_device_impl&&)
          = delete;
 
      virtual ~block_device_impl () override;
 
      // ----------------------------------------------------------------------
    public:
      virtual ssize_t
      do_read (void* buf, std::size_t nbyte) override;
 
      virtual ssize_t
      do_write (const void* buf, std::size_t nbyte) override;
 
      virtual off_t
      do_lseek (off_t offset, int whence) override;
 
      virtual ssize_t
      do_read_block (void* buf, blknum_t blknum, std::size_t nblocks)
          = 0;
 
      virtual ssize_t
      do_write_block (const void* buf, blknum_t blknum, std::size_t nblocks)
          = 0;
 
      // ----------------------------------------------------------------------
    protected:
      std::size_t block_logical_size_bytes_ = 0;
 
      std::size_t block_physical_size_bytes_ = 0;
 
      blknum_t num_blocks_ = 0;
 
    };
 
#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
    template <typename T>
    class block_device_implementable : public block_device
    {
      // ----------------------------------------------------------------------
 
    public:
      using value_type = T;
 
      // ----------------------------------------------------------------------
 
    public:
      template <typename... Args>
      block_device_implementable (const char* name, Args&&... args);
 
      // The rule of five.
      block_device_implementable (const block_device_implementable&) = delete;
      block_device_implementable (block_device_implementable&&) = delete;
      block_device_implementable&
      operator= (const block_device_implementable&)
          = delete;
      block_device_implementable&
      operator= (block_device_implementable&&)
          = delete;
 
      virtual ~block_device_implementable () override;
 
      // ----------------------------------------------------------------------
    public:
      // Support functions.
 
      value_type&
      impl (void) const;
 
      // ----------------------------------------------------------------------
    protected:
      // Include the implementation as a member.
      value_type impl_instance_;
 
    };
#pragma GCC diagnostic pop
 
    // ========================================================================
 
    template <typename T, typename L>
    class block_device_lockable : public block_device
    {
      // ----------------------------------------------------------------------
 
    public:
      using value_type = T;
      using lockable_type = L;
 
      // ----------------------------------------------------------------------
 
    public:
      template <typename... Args>
      block_device_lockable (const char* name, lockable_type& locker,
                             Args&&... args);
 
      // The rule of five.
      block_device_lockable (const block_device_lockable&) = delete;
      block_device_lockable (block_device_lockable&&) = delete;
      block_device_lockable&
      operator= (const block_device_lockable&)
          = delete;
      block_device_lockable&
      operator= (block_device_lockable&&)
          = delete;
 
      virtual ~block_device_lockable () override;
 
      // ----------------------------------------------------------------------
    public:
      virtual int
      close (void) override;
 
      virtual ssize_t
      read (void* buf, std::size_t nbyte) override;
 
      virtual ssize_t
      write (const void* buf, std::size_t nbyte) override;
 
      virtual ssize_t
      writev (const /* struct */ iovec* iov, int iovcnt) override;
 
      virtual int
      vfcntl (int cmd, std::va_list args) override;
 
      virtual int
      vioctl (int request, std::va_list args) override;
 
      virtual off_t
      lseek (off_t offset, int whence) override;
 
      virtual ssize_t
      read_block (void* buf, blknum_t blknum,
                  std::size_t nblocks = 1) override;
 
      virtual ssize_t
      write_block (const void* buf, blknum_t blknum,
                   std::size_t nblocks = 1) override;
 
      virtual void
      sync (void) override;
 
      // ----------------------------------------------------------------------
      // Support functions.
 
      value_type&
      impl (void) const;
 
      // ----------------------------------------------------------------------
    protected:
      value_type impl_instance_;
 
      lockable_type& locker_;
 
    };
 
    // ========================================================================
  } /* namespace posix */
} /* namespace os */
 
// ===== Inline & template implementations ====================================
 
namespace os
{
  namespace posix
  {
    // ========================================================================
 
    inline block_device::blknum_t
    block_device::blocks (void)
    {
      return impl ().num_blocks_;
    }
 
    inline std::size_t
    block_device::block_logical_size_bytes (void)
    {
      return impl ().block_logical_size_bytes_;
    }
 
    inline std::size_t
    block_device::block_physical_size_bytes (void)
    {
      return impl ().block_physical_size_bytes_;
    }
 
    inline block_device_impl&
    block_device::impl (void) const
    {
      return static_cast<block_device_impl&> (impl_);
    }
 
    // ========================================================================
 
    template <typename T>
    template <typename... Args>
    block_device_implementable<T>::block_device_implementable (
        const char* name, Args&&... args)
        : block_device{ impl_instance_, name }, //
          impl_instance_{ std::forward<Args> (args)... }
    {
#if defined(OS_TRACE_POSIX_IO_BLOCK_DEVICE)
      trace::printf ("block_device_implementable::%s(\"%s\")=@%p\n", __func__,
                     name_, this);
#endif
    }
 
#pragma GCC diagnostic push
#if defined(__clang__)
#elif defined(__GNUC__)
#pragma GCC diagnostic ignored "-Wsuggest-final-methods"
#endif
    template <typename T>
    block_device_implementable<T>::~block_device_implementable ()
    {
#if defined(OS_TRACE_POSIX_IO_BLOCK_DEVICE)
      trace::printf ("block_device_implementable::%s() @%p %s\n", __func__,
                     this, name_);
#endif
    }
#pragma GCC diagnostic pop
 
    template <typename T>
    typename block_device_implementable<T>::value_type&
    block_device_implementable<T>::impl (void) const
    {
      return static_cast<value_type&> (impl_);
    }
 
    // ========================================================================
 
    template <typename T, typename L>
    template <typename... Args>
    block_device_lockable<T, L>::block_device_lockable (const char* name,
                                                        lockable_type& locker,
                                                        Args&&... args)
        : block_device{ impl_instance_, name }, //
          impl_instance_{ std::forward<Args> (args)... }, //
          locker_ (locker)
    {
#if defined(OS_TRACE_POSIX_IO_BLOCK_DEVICE)
      trace::printf ("block_device_lockable::%s(\"%s\")=@%p\n", __func__,
                     name_, this);
#endif
    }
 
    template <typename T, typename L>
    block_device_lockable<T, L>::~block_device_lockable ()
    {
#if defined(OS_TRACE_POSIX_IO_BLOCK_DEVICE)
      trace::printf ("block_device_lockable::%s() @%p %s\n", __func__, this,
                     name_);
#endif
    }
 
    // ------------------------------------------------------------------------
 
    template <typename T, typename L>
    int
    block_device_lockable<T, L>::close (void)
    {
#if defined(OS_TRACE_POSIX_IO_BLOCK_DEVICE)
      trace::printf ("block_device_lockable::%s() @%p\n", __func__, this);
#endif
 
      std::lock_guard<L> lock{ locker_ };
 
      return block_device::close ();
    }
 
    template <typename T, typename L>
    ssize_t
    block_device_lockable<T, L>::read (void* buf, std::size_t nbyte)
    {
#if defined(OS_TRACE_POSIX_IO_BLOCK_DEVICE)
      trace::printf ("block_device_lockable::%s(0x0%X, %u) @%p\n", __func__,
                     buf, nbyte, this);
#endif
 
      std::lock_guard<L> lock{ locker_ };
 
      return block_device::read (buf, nbyte);
    }
 
    template <typename T, typename L>
    ssize_t
    block_device_lockable<T, L>::write (const void* buf, std::size_t nbyte)
    {
#if defined(OS_TRACE_POSIX_IO_BLOCK_DEVICE)
      trace::printf ("block_device_lockable::%s(0x0%X, %u) @%p\n", __func__,
                     buf, nbyte, this);
#endif
 
      std::lock_guard<L> lock{ locker_ };
 
      return block_device::write (buf, nbyte);
    }
 
    template <typename T, typename L>
    ssize_t
    block_device_lockable<T, L>::writev (const /* struct */ iovec* iov,
                                         int iovcnt)
    {
#if defined(OS_TRACE_POSIX_IO_BLOCK_DEVICE)
      trace::printf ("block_device_lockable::%s(0x0%X, %d) @%p\n", __func__,
                     iov, iovcnt, this);
#endif
 
      std::lock_guard<L> lock{ locker_ };
 
      return block_device::writev (iov, iovcnt);
    }
 
    template <typename T, typename L>
    int
    block_device_lockable<T, L>::vfcntl (int cmd, std::va_list args)
    {
#if defined(OS_TRACE_POSIX_IO_BLOCK_DEVICE)
      trace::printf ("block_device_lockable::%s(%d) @%p\n", __func__, cmd,
                     this);
#endif
 
      std::lock_guard<L> lock{ locker_ };
 
      return block_device::vfcntl (cmd, args);
    }
 
    template <typename T, typename L>
    int
    block_device_lockable<T, L>::vioctl (int request, std::va_list args)
    {
#if defined(OS_TRACE_POSIX_IO_BLOCK_DEVICE)
      trace::printf ("block_device_lockable::%s(%d) @%p\n", __func__, request,
                     this);
#endif
 
      std::lock_guard<L> lock{ locker_ };
 
      return block_device::vioctl (request, args);
    }
 
    template <typename T, typename L>
    off_t
    block_device_lockable<T, L>::lseek (off_t offset, int whence)
    {
#if defined(OS_TRACE_POSIX_IO_BLOCK_DEVICE)
      trace::printf ("block_device_lockable::%s(%d, %d) @%p\n", __func__,
                     offset, whence, this);
#endif
 
      std::lock_guard<L> lock{ locker_ };
 
      return block_device::lseek (offset, whence);
    }
 
    template <typename T, typename L>
    ssize_t
    block_device_lockable<T, L>::read_block (void* buf, blknum_t blknum,
                                             std::size_t nblocks)
    {
#if defined(OS_TRACE_POSIX_IO_BLOCK_DEVICE)
      trace::printf ("block_device_lockable::%s(%p, %u, %u) @%p\n", __func__,
                     buf, blknum, nblocks, this);
#endif
 
      std::lock_guard<L> lock{ locker_ };
 
      return block_device::read_block (buf, blknum, nblocks);
    }
 
    template <typename T, typename L>
    ssize_t
    block_device_lockable<T, L>::write_block (const void* buf, blknum_t blknum,
                                              std::size_t nblocks)
    {
#if defined(OS_TRACE_POSIX_IO_BLOCK_DEVICE)
      trace::printf ("block_device_lockable::%s(%p, %u, %u) @%p\n", __func__,
                     buf, blknum, nblocks, this);
#endif
 
      std::lock_guard<L> lock{ locker_ };
 
      return block_device::write_block (buf, blknum, nblocks);
    }
 
    template <typename T, typename L>
    void
    block_device_lockable<T, L>::sync (void)
    {
#if defined(OS_TRACE_POSIX_IO_BLOCK_DEVICE)
      trace::printf ("block_device_lockable::%s() @%p\n", __func__, this);
#endif
 
      std::lock_guard<L> lock{ locker_ };
 
      return block_device::sync ();
    }
 
    template <typename T, typename L>
    typename block_device_lockable<T, L>::value_type&
    block_device_lockable<T, L>::impl (void) const
    {
      return static_cast<value_type&> (impl_);
    }
 
    // ========================================================================
  } /* namespace posix */
} /* namespace os */
 
#pragma GCC diagnostic pop
 
// ----------------------------------------------------------------------------
 
#endif /* __cplusplus */
 
// ----------------------------------------------------------------------------
 
#endif /* CMSIS_PLUS_POSIX_IO_BLOCK_DEVICE_H_ */