os-lists.h

Go to the documentation of this file.

/*
 * This file is part of the µOS++ distribution.
 *   (https://github.com/micro-os-plus)
 * Copyright (c) 2016 Liviu Ionescu.
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom
 * the Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef CMSIS_PLUS_RTOS_INTERNAL_OS_LISTS_H_
#define CMSIS_PLUS_RTOS_INTERNAL_OS_LISTS_H_

// ----------------------------------------------------------------------------

#ifdef  __cplusplus

#include <cmsis-plus/utils/lists.h>

#include <cstdint>
#include <cstddef>
#include <cassert>
#include <iterator>

namespace os
{
  namespace rtos
  {
    class thread;

    namespace internal
    {
      // ======================================================================

#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wpadded"

      class waiting_thread_node : public utils::double_list_links
      {
      public:

        waiting_thread_node (thread& th);

        waiting_thread_node (const waiting_thread_node&) = delete;
        waiting_thread_node (waiting_thread_node&&) = delete;
        waiting_thread_node&
        operator= (const waiting_thread_node&) = delete;
        waiting_thread_node&
        operator= (waiting_thread_node&&) = delete;

        ~waiting_thread_node ();

      public:

        rtos::thread* thread_;

      };

#pragma GCC diagnostic pop

      // ======================================================================

#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wpadded"

      class timestamp_node : public utils::double_list_links
      {
      public:

        timestamp_node (port::clock::timestamp_t ts);

        timestamp_node (const timestamp_node&) = delete;
        timestamp_node (timestamp_node&&) = delete;
        timestamp_node&
        operator= (const timestamp_node&) = delete;
        timestamp_node&
        operator= (timestamp_node&&) = delete;

        virtual
        ~timestamp_node ();

      public:

        virtual void
        action (void) = 0;

      public:

        port::clock::timestamp_t timestamp;

      };

#pragma GCC diagnostic pop

      // ======================================================================

#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wpadded"

      class timeout_thread_node : public timestamp_node
      {
      public:

        timeout_thread_node (port::clock::timestamp_t ts, thread& th);

        timeout_thread_node (const timeout_thread_node&) = delete;
        timeout_thread_node (timeout_thread_node&&) = delete;
        timeout_thread_node&
        operator= (const timeout_thread_node&) = delete;
        timeout_thread_node&
        operator= (timeout_thread_node&&) = delete;

        virtual
        ~timeout_thread_node () override;

      public:

        virtual void
        action (void) override;

      public:

        rtos::thread& thread;

      };

#pragma GCC diagnostic pop

      // ======================================================================

#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wpadded"

      class timer_node : public timestamp_node
      {
      public:

        timer_node (port::clock::timestamp_t ts, timer& tm);

        timer_node (const timer_node&) = delete;
        timer_node (timer_node&&) = delete;
        timer_node&
        operator= (const timer_node&) = delete;
        timer_node&
        operator= (timer_node&&) = delete;
        virtual
        ~timer_node () override;

      public:

        virtual void
        action (void) override;

      public:

        timer& tmr;

      };

#pragma GCC diagnostic pop

      // ======================================================================

      class thread_children_list : public utils::double_list
      {
      public:

        thread_children_list ();

        thread_children_list (const thread_children_list&) = delete;
        thread_children_list (thread_children_list&&) = delete;
        thread_children_list&
        operator= (const thread_children_list&) = delete;
        thread_children_list&
        operator= (thread_children_list&&) = delete;

        ~thread_children_list ();

      public:

        void
        link (thread& thread);

        // TODO add iterator begin(), end()

      };

      // ======================================================================

      class ready_threads_list : public utils::static_double_list
      {
      public:

        ready_threads_list ();

        ready_threads_list (const ready_threads_list&) = delete;
        ready_threads_list (ready_threads_list&&) = delete;
        ready_threads_list&
        operator= (const ready_threads_list&) = delete;
        ready_threads_list&
        operator= (ready_threads_list&&) = delete;

        ~ready_threads_list ();

      public:

        void
        link (waiting_thread_node& node);

        volatile waiting_thread_node*
        head (void) const;

        thread*
        unlink_head (void);

        // TODO add iterator begin(), end()

      };

      // ======================================================================

      class waiting_threads_list : public utils::double_list
      {
      public:

        using iterator = utils::double_list_iterator<thread, waiting_thread_node, &waiting_thread_node::thread_>;

        waiting_threads_list ();

        waiting_threads_list (const waiting_threads_list&) = delete;
        waiting_threads_list (waiting_threads_list&&) = delete;
        waiting_threads_list&
        operator= (const waiting_threads_list&) = delete;
        waiting_threads_list&
        operator= (waiting_threads_list&&) = delete;

        ~waiting_threads_list ();

      public:

        void
        link (waiting_thread_node& node);

        volatile waiting_thread_node*
        head (void) const;

        bool
        resume_one (void);

        void
        resume_all (void);

        iterator
        begin () const;

        iterator
        end () const;

      };

      // ======================================================================

      class clock_timestamps_list : public utils::double_list
      {
      public:

        clock_timestamps_list ();

        clock_timestamps_list (const clock_timestamps_list&) = delete;
        clock_timestamps_list (clock_timestamps_list&&) = delete;
        clock_timestamps_list&
        operator= (const clock_timestamps_list&) = delete;
        clock_timestamps_list&
        operator= (clock_timestamps_list&&) = delete;

        ~clock_timestamps_list ();

      public:

        void
        link (timestamp_node& node);

        volatile timestamp_node*
        head (void) const;

        void
        check_timestamp (port::clock::timestamp_t now);

      };

      // ======================================================================

      class terminated_threads_list : public utils::static_double_list
      {
      public:

        terminated_threads_list ();

        terminated_threads_list (const terminated_threads_list&) = delete;
        terminated_threads_list (terminated_threads_list&&) = delete;
        terminated_threads_list&
        operator= (const terminated_threads_list&) = delete;
        terminated_threads_list&
        operator= (terminated_threads_list&&) = delete;

        ~terminated_threads_list ();

      public:

        void
        link (waiting_thread_node& node);

        volatile waiting_thread_node*
        head (void) const;

        // TODO add iterator begin(), end()

      };

    }
    ;
    /* namespace internal */

    // ------------------------------------------------------------------------
    namespace scheduler
    {
      void
      internal_link_node (internal::waiting_threads_list& list,
                          internal::waiting_thread_node& node);

      void
      internal_unlink_node (internal::waiting_thread_node& node);

      void
      internal_link_node (internal::waiting_threads_list& list,
                          internal::waiting_thread_node& node,
                          internal::clock_timestamps_list& timeout_list,
                          internal::timeout_thread_node& timeout_node);

      void
      internal_unlink_node (internal::waiting_thread_node& node,
                            internal::timeout_thread_node& timeout_node);

    } /* namespace this_thread */

  // --------------------------------------------------------------------------

  } /* namespace rtos */
} /* namespace os */

// ----------------------------------------------------------------------------

namespace os
{
  namespace rtos
  {
    namespace internal
    {

      // ======================================================================

      inline
      waiting_thread_node::waiting_thread_node (rtos::thread& th) :
          thread_ (&th)
      {
        ;
      }

      inline
      waiting_thread_node::~waiting_thread_node ()
      {
        ;
      }

      // ======================================================================

      inline
      thread_children_list::thread_children_list ()
      {
        ;
      }

      inline
      thread_children_list::~thread_children_list ()
      {
        ;
      }

      // ======================================================================

      inline
      ready_threads_list::ready_threads_list ()
      {
        ;
      }

      inline
      ready_threads_list::~ready_threads_list ()
      {
        ;
      }

      inline volatile waiting_thread_node*
      ready_threads_list::head (void) const
      {
        return static_cast<volatile waiting_thread_node*> (static_double_list::head ());
      }

      // ======================================================================

      inline
      waiting_threads_list::waiting_threads_list ()
      {
        ;
      }

      inline
      waiting_threads_list::~waiting_threads_list ()
      {
        ;
      }

      inline volatile waiting_thread_node*
      waiting_threads_list::head (void) const
      {
        return static_cast<volatile waiting_thread_node*> (double_list::head ());
      }

      inline waiting_threads_list::iterator
      waiting_threads_list::begin () const
      {
        return iterator
          {
              static_cast<waiting_threads_list::iterator::iterator_pointer> (head_.next ()) };
      }

      inline waiting_threads_list::iterator
      waiting_threads_list::end () const
      {
        return iterator
          {
              static_cast<waiting_threads_list::iterator::iterator_pointer> (const_cast<utils::static_double_list_links*> (&head_)) };
      }

      // ======================================================================

      inline
      clock_timestamps_list::clock_timestamps_list ()
      {
        ;
      }

      inline
      clock_timestamps_list::~clock_timestamps_list ()
      {
        ;
      }

      inline volatile timestamp_node*
      clock_timestamps_list::head (void) const
      {
        return static_cast<volatile timestamp_node*> (double_list::head ());
      }

      // ======================================================================

      inline
      terminated_threads_list::terminated_threads_list ()
      {
        ;
      }

      inline
      terminated_threads_list::~terminated_threads_list ()
      {
        ;
      }

      inline volatile waiting_thread_node*
      terminated_threads_list::head (void) const
      {
        return static_cast<volatile waiting_thread_node*> (static_double_list::head ());
      }

    // ------------------------------------------------------------------------
    } /* namespace internal */
  } /* namespace rtos */
} /* namespace os */

// ----------------------------------------------------------------------------

#endif /* __cplusplus */

#endif /* CMSIS_PLUS_RTOS_INTERNAL_OS_LISTS_H_ */