block-device-partition.h

Go to the documentation of this file.

/*
 * This file is part of the µOS++ distribution.
 *   (https://github.com/micro-os-plus)
 * Copyright (c) 2018-2023 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_PARTITION_H_
#define CMSIS_PLUS_POSIX_IO_BLOCK_DEVICE_PARTITION_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/block-device.h>
 
// ----------------------------------------------------------------------------
 
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wc++98-compat"
#endif
 
// ----------------------------------------------------------------------------
 
namespace os
{
  namespace posix
  {
    // ------------------------------------------------------------------------
 
    class block_device_partition_impl;
 
    // ========================================================================
 
    class block_device_partition : public block_device
    {
      // ----------------------------------------------------------------------
 
    public:
 
      block_device_partition (block_device_impl& impl, const char* name);
 
      // The rule of five.
      block_device_partition (const block_device_partition&) = delete;
      block_device_partition (block_device_partition&&) = delete;
      block_device_partition&
      operator= (const block_device_partition&) = delete;
      block_device_partition&
      operator= (block_device_partition&&) = delete;
 
      virtual
      ~block_device_partition () override;
 
      // ----------------------------------------------------------------------
    public:
 
      void
      configure (blknum_t offset, blknum_t nblocks);
 
      // ----------------------------------------------------------------------
      // Support functions.
 
      block_device_partition_impl&
      impl (void) const;
 
    };
 
    // ========================================================================
 
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wpadded"
#elif defined(__GNUC__)
#pragma GCC diagnostic ignored "-Wpadded"
#endif
 
    class block_device_partition_impl : public block_device_impl
    {
      // ----------------------------------------------------------------------
 
      friend block_device_partition;
 
      // ----------------------------------------------------------------------
 
    public:
 
      block_device_partition_impl (block_device& parent);
 
      // The rule of five.
      block_device_partition_impl (const block_device_partition_impl&) = delete;
      block_device_partition_impl (block_device_partition_impl&&) = delete;
      block_device_partition_impl&
      operator= (const block_device_partition_impl&) = delete;
      block_device_partition_impl&
      operator= (block_device_partition_impl&&) = delete;
 
      virtual
      ~block_device_partition_impl () override;
 
      // ----------------------------------------------------------------------
    public:
 
      virtual int
      do_vioctl (int request, std::va_list args) override;
 
      virtual int
      do_vopen (const char* path, int oflag, std::va_list args) override;
 
      virtual ssize_t
      do_read_block (void* buf, blknum_t blknum, std::size_t nblocks) override;
 
      virtual ssize_t
      do_write_block (const void* buf, blknum_t blknum, std::size_t nblocks)
          override;
 
      virtual void
      do_sync (void) override;
 
      virtual int
      do_close (void) override;
 
      // ----------------------------------------------------------------------
 
      void
      configure (blknum_t offset, blknum_t nblocks);
 
      // ----------------------------------------------------------------------
    protected:
 
      block_device& parent_;
 
      blknum_t partition_offset_blocks_ = 0;
 
    };
 
#pragma GCC diagnostic pop
 
    // ========================================================================
 
    template<typename T = block_device_partition_impl>
      class block_device_partition_implementable : public block_device_partition
      {
        // --------------------------------------------------------------------
 
      public:
 
        using value_type = T;
 
        // --------------------------------------------------------------------
 
      public:
 
        template<typename ... Args>
          block_device_partition_implementable (const char* name,
                                                block_device& parent,
                                                Args&&... args);
 
        // The rule of five.
        block_device_partition_implementable (
            const block_device_partition_implementable&) = delete;
        block_device_partition_implementable (
            block_device_partition_implementable&&) = delete;
        block_device_partition_implementable&
        operator= (const block_device_partition_implementable&) = delete;
        block_device_partition_implementable&
        operator= (block_device_partition_implementable&&) = delete;
 
        virtual
        ~block_device_partition_implementable () override;
 
        // --------------------------------------------------------------------
      public:
 
        // Support functions.
 
        value_type&
        impl (void) const;
 
        // --------------------------------------------------------------------
      protected:
 
        // Include the implementation as a member.
        value_type impl_instance_;
 
      };
 
    // ========================================================================
 
    template<typename T, typename L>
      class block_device_partition_lockable : public block_device_partition
      {
        // --------------------------------------------------------------------
 
      public:
 
        using value_type = T;
        using lockable_type = L;
 
        // --------------------------------------------------------------------
 
      public:
 
        template<typename ... Args>
          block_device_partition_lockable (const char* name,
                                           block_device& parent,
                                           lockable_type& locker,
                                           Args&&... args);
 
        // The rule of five.
        block_device_partition_lockable (const block_device_partition_lockable&) = delete;
        block_device_partition_lockable (block_device_partition_lockable&&) = delete;
        block_device_partition_lockable&
        operator= (const block_device_partition_lockable&) = delete;
        block_device_partition_lockable&
        operator= (block_device_partition_lockable&&) = delete;
 
        virtual
        ~block_device_partition_lockable () 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)
            override;
 
        virtual ssize_t
        write_block (const void* buf, blknum_t blknum, std::size_t nblocks = 1)
            override;
 
        // --------------------------------------------------------------------
        // Support functions.
 
        value_type&
        impl (void) const;
 
        // --------------------------------------------------------------------
      protected:
 
        // Include the implementation as a member.
        value_type impl_instance_;
 
        lockable_type& locker_;
 
      };
 
    // ========================================================================
 
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wweak-template-vtables"
// error: extern templates are incompatible with C++98 [-Werror,-Wc++98-compat-pedantic]
#pragma clang diagnostic ignored "-Wc++98-compat-pedantic"
#endif
 
    extern template class block_device_partition_implementable<
        block_device_partition_impl> ;
 
#pragma GCC diagnostic pop
 
  // ==========================================================================
  } /* namespace posix */
} /* namespace os */
 
// ===== Inline & template implementations ====================================
 
namespace os
{
  namespace posix
  {
    // ========================================================================
 
    inline block_device_partition_impl&
    block_device_partition::impl (void) const
    {
      return static_cast<block_device_partition_impl&> (impl_);
    }
 
    // ========================================================================
 
    template<typename T>
      template<typename ... Args>
        block_device_partition_implementable<T>::block_device_partition_implementable (
            const char* name, block_device& parent, Args&&... args) :
            block_device_partition
              { impl_instance_, name }, //
            impl_instance_
              { parent, std::forward<Args>(args)... }
        {
#if defined(OS_TRACE_POSIX_IO_BLOCK_DEVICE_PARTITION)
          trace::printf (
              "block_device_partition_implementable::%s(\"%s\")=@%p\n",
              __func__, name_, this);
#endif
        }
 
    template<typename T>
      block_device_partition_implementable<T>::~block_device_partition_implementable ()
      {
#if defined(OS_TRACE_POSIX_IO_BLOCK_DEVICE_PARTITION)
        trace::printf ("block_device_partition_implementable::%s() @%p %s\n",
                       __func__, this, name_);
#endif
      }
 
    template<typename T>
      typename block_device_partition_implementable<T>::value_type&
      block_device_partition_implementable<T>::impl (void) const
      {
        return static_cast<value_type&> (impl_);
      }
 
    // ========================================================================
 
    template<typename T, typename L>
      template<typename ... Args>
        block_device_partition_lockable<T, L>::block_device_partition_lockable (
            const char* name, block_device& parent, lockable_type& locker,
            Args&&... args) :
            block_device_partition
              { impl_instance_, name }, //
            impl_instance_
              { parent, std::forward<Args>(args)... }, //
            locker_ (locker)
        {
#if defined(OS_TRACE_POSIX_IO_BLOCK_DEVICE_PARTITION)
          trace::printf ("block_device_partition_lockable::%s(\"%s\")=@%p\n",
                         __func__, name_, this);
#endif
 
        }
 
    template<typename T, typename L>
      block_device_partition_lockable<T, L>::~block_device_partition_lockable ()
      {
#if defined(OS_TRACE_POSIX_IO_BLOCK_DEVICE_PARTITION)
        trace::printf ("block_device_partition_lockable::%s() @%p %s\n",
                       __func__, this, name_);
#endif
      }
 
    // ------------------------------------------------------------------------
 
    template<typename T, typename L>
      int
      block_device_partition_lockable<T, L>::vioctl (int request,
                                                     std::va_list args)
      {
#if defined(OS_TRACE_POSIX_IO_BLOCK_DEVICE_PARTITION)
        trace::printf ("block_device_partition_lockable::%s(%d) @%p\n",
                       __func__, request, this);
#endif
 
        std::lock_guard<L> lock
          { locker_ };
 
        return block_device_partition::vioctl (request, args);
      }
 
    template<typename T, typename L>
      ssize_t
      block_device_partition_lockable<T, L>::read_block (void* buf,
                                                         blknum_t blknum,
                                                         std::size_t nblocks)
      {
#if defined(OS_TRACE_POSIX_IO_BLOCK_DEVICE_PARTITION)
        trace::printf ("block_device_partition_lockable::%s(%p, %u, %u) @%p\n",
                       __func__, buf, blknum, nblocks, this);
#endif
 
        std::lock_guard<L> lock
          { locker_ };
 
        return block_device_partition::read_block (buf, blknum, nblocks);
      }
 
    template<typename T, typename L>
      ssize_t
      block_device_partition_lockable<T, L>::write_block (const void* buf,
                                                          blknum_t blknum,
                                                          std::size_t nblocks)
      {
#if defined(OS_TRACE_POSIX_IO_BLOCK_DEVICE_PARTITION)
        trace::printf ("block_device_partition_lockable::%s(%p, %u, %u) @%p\n",
                       __func__, buf, blknum, nblocks, this);
#endif
 
        std::lock_guard<L> lock
          { locker_ };
 
        return block_device_partition::write_block (buf, blknum, nblocks);
      }
 
    template<typename T, typename L>
      typename block_device_partition_lockable<T, L>::value_type&
      block_device_partition_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_PARTITION_H_ */