diff options
Diffstat (limited to 'include/distortos')
102 files changed, 0 insertions, 12287 deletions
diff --git a/include/distortos/ConditionVariable.hpp b/include/distortos/ConditionVariable.hpp deleted file mode 100644 index 6b7f869..0000000 --- a/include/distortos/ConditionVariable.hpp +++ /dev/null @@ -1,304 +0,0 @@ -/** - * \file - * \brief ConditionVariable class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_CONDITIONVARIABLE_HPP_ -#define INCLUDE_DISTORTOS_CONDITIONVARIABLE_HPP_ - -#include "distortos/internal/scheduler/ThreadList.hpp" - -#include "distortos/TickClock.hpp" - -namespace distortos -{ - -class Mutex; - -/** - * \brief ConditionVariable is an advanced synchronization primitive - * - * Similar to std::condition_variable - http://en.cppreference.com/w/cpp/thread/condition_variable - * Similar to POSIX pthread_cond_t - * - * \ingroup synchronization - */ - -class ConditionVariable -{ -public: - - /** - * \brief ConditionVariable constructor - * - * Similar to std::condition_variable::condition_variable() - - * http://en.cppreference.com/w/cpp/thread/condition_variable/condition_variable - * Similar to pthread_cond_init() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_cond_init.html - */ - - constexpr ConditionVariable() : - blockedList_{} - { - - } - - /** - * \brief Notifies all waiting threads. - * - * Similar to std::condition_variable::notify_all() - - * http://en.cppreference.com/w/cpp/thread/condition_variable/notify_all - * Similar to pthread_cond_broadcast() - - * http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_cond_signal.html - * - * Unblocks all threads waiting on this condition variable. The notifying thread does not need to hold the same - * mutex as the one held by the waiting thread(s). - */ - - void notifyAll(); - - /** - * \brief Notifies one waiting thread. - * - * Similar to std::condition_variable::notify_one() - - * http://en.cppreference.com/w/cpp/thread/condition_variable/notify_one - * Similar to pthread_cond_signal() - - * http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_cond_signal.html - * - * Unblocks one thread waiting on this condition variable. The notifying thread does not need to hold the same - * mutex as the one held by the waiting thread(s). - */ - - void notifyOne(); - - /** - * \brief Waits for notification. - * - * Similar to std::condition_variable::wait() - http://en.cppreference.com/w/cpp/thread/condition_variable/wait - * Similar to pthread_cond_wait() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_cond_wait.html - * - * Atomically releases supplied mutex and blocks current thread until the condition variable is notified. The thread - * will be unblocked when notifyAll() or notifyOne() is executed. It may also be unblocked spuriously. When - * unblocked, regardless of the reason, lock is reacquired and wait exits. - * - * \param [in] mutex is a reference to mutex which must be owned by calling thread - * - * \return zero if the wait was completed successfully, error code otherwise: - * - EPERM - the mutex type is ErrorChecking or Recursive, and the current thread does not own the mutex; - */ - - int wait(Mutex& mutex); - - /** - * \brief Waits for predicate to become true. - * - * Similar to std::condition_variable::wait() - http://en.cppreference.com/w/cpp/thread/condition_variable/wait - * Similar to pthread_cond_wait() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_cond_wait.html - * - * Overload for wait() which also checks the predicate. This function will return only if the predicate is true. - * - * \tparam Predicate is a type of functor to check the predicate - * - * \param [in] mutex is a reference to mutex which must be owned by calling thread - * \param [in] predicate is the predicate that will be checked - * - * \return zero if the wait was completed successfully, error code otherwise: - * - EPERM - the mutex type is ErrorChecking or Recursive, and the current thread does not own the mutex; - */ - - template<typename Predicate> - int wait(Mutex& mutex, Predicate predicate); - - /** - * \brief Waits for notification for given duration of time. - * - * Similar to std::condition_variable::wait_for() - - * http://en.cppreference.com/w/cpp/thread/condition_variable/wait_for - * Similar to pthread_cond_timedwait() - - * http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_cond_timedwait.html# - * - * Atomically releases supplied mutex and blocks current thread until the condition variable is notified. The thread - * will be unblocked when notifyAll() or notifyOne() is executed or when given duration of time expires. It may also - * be unblocked spuriously. When unblocked, regardless of the reason, lock is reacquired and wait exits. - * - * \param [in] mutex is a reference to mutex which must be owned by calling thread - * \param [in] duration is the duration after which the wait for notification will be terminated - * - * \return zero if the wait was completed successfully, error code otherwise: - * - EPERM - the mutex type is ErrorChecking or Recursive, and the current thread does not own the mutex; - * - ETIMEDOUT - no notification was received before the specified timeout expired; - */ - - int waitFor(Mutex& mutex, TickClock::duration duration); - - /** - * \brief Waits for notification for given duration of time. - * - * Similar to std::condition_variable::wait_for() - - * http://en.cppreference.com/w/cpp/thread/condition_variable/wait_for - * Similar to pthread_cond_timedwait() - - * http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_cond_timedwait.html# - * - * Template variant of waitFor(Mutex& mutex, TickClock::duration duration). - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * - * \param [in] mutex is a reference to mutex which must be owned by calling thread - * \param [in] duration is the duration after which the wait for notification will be terminated - * - * \return zero if the wait was completed successfully, error code otherwise: - * - EPERM - the mutex type is ErrorChecking or Recursive, and the current thread does not own the mutex; - * - ETIMEDOUT - no notification was received before the specified timeout expired; - */ - - template<typename Rep, typename Period> - int waitFor(Mutex& mutex, const std::chrono::duration<Rep, Period> duration) - { - return waitFor(mutex, std::chrono::duration_cast<TickClock::duration>(duration)); - } - - /** - * \brief Waits for predicate to become true for given duration of time. - * - * Similar to std::condition_variable::wait_for() - - * http://en.cppreference.com/w/cpp/thread/condition_variable/wait_for - * Similar to pthread_cond_timedwait() - - * http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_cond_timedwait.html# - * - * Overload for waitFor() which also checks the predicate. This function will return only if the predicate is true - * or when given duration of time expires. - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * \tparam Predicate is a type of functor to check the predicate - * - * \param [in] mutex is a reference to mutex which must be owned by calling thread - * \param [in] duration is the duration after which the wait for notification will be terminated - * \param [in] predicate is the predicate that will be checked - * - * \return zero if the wait was completed successfully, error code otherwise: - * - EPERM - the mutex type is ErrorChecking or Recursive, and the current thread does not own the mutex; - * - ETIMEDOUT - no notification was received before the specified timeout expired; - */ - - template<typename Rep, typename Period, typename Predicate> - int waitFor(Mutex& mutex, const std::chrono::duration<Rep, Period> duration, Predicate predicate) - { - return waitUntil(mutex, TickClock::now() + duration + TickClock::duration{1}, std::move(predicate)); - } - - /** - * \brief Waits for notification until given time point. - * - * Similar to std::condition_variable::wait_until() - - * http://en.cppreference.com/w/cpp/thread/condition_variable/wait_until - * Similar to pthread_cond_timedwait() - - * http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_cond_timedwait.html# - * - * Atomically releases supplied mutex and blocks current thread until the condition variable is notified. The thread - * will be unblocked when notifyAll() or notifyOne() is executed or when given time point is reached. It may also be - * unblocked spuriously. When unblocked, regardless of the reason, lock is reacquired and wait exits. - * - * \param [in] mutex is a reference to mutex which must be owned by calling thread - * \param [in] timePoint is the time point at which the wait for notification will be terminated - * - * \return zero if the wait was completed successfully, error code otherwise: - * - EPERM - the mutex type is ErrorChecking or Recursive, and the current thread does not own the mutex; - * - ETIMEDOUT - no notification was received before the specified timeout expired; - */ - - int waitUntil(Mutex& mutex, TickClock::time_point timePoint); - - /** - * \brief Waits for notification until given time point. - * - * Similar to std::condition_variable::wait_until() - - * http://en.cppreference.com/w/cpp/thread/condition_variable/wait_until - * Similar to pthread_cond_timedwait() - - * http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_cond_timedwait.html# - * - * Template variant of waitUntil(Mutex& mutex, TickClock::time_point timePoint). - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * - * \param [in] mutex is a reference to mutex which must be owned by calling thread - * \param [in] timePoint is the time point at which the wait for notification will be terminated - * - * \return zero if the wait was completed successfully, error code otherwise: - * - EPERM - the mutex type is ErrorChecking or Recursive, and the current thread does not own the mutex; - * - ETIMEDOUT - no notification was received before the specified timeout expired; - */ - - template<typename Duration> - int waitUntil(Mutex& mutex, const std::chrono::time_point<TickClock, Duration> timePoint) - { - return waitUntil(mutex, std::chrono::time_point_cast<TickClock::duration>(timePoint)); - } - - /** - * \brief Waits for predicate to become true until given time point. - * - * Similar to std::condition_variable::wait_until() - - * http://en.cppreference.com/w/cpp/thread/condition_variable/wait_until - * Similar to pthread_cond_timedwait() - - * http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_cond_timedwait.html# - * - * Overload for waitUntil() which also checks the predicate. This function will return only if the predicate is true - * or when given time point is reached. - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * \tparam Predicate is a type of functor to check the predicate - * - * \param [in] mutex is a reference to mutex which must be owned by calling thread - * \param [in] timePoint is the time point at which the wait for notification will be terminated - * \param [in] predicate is the predicate that will be checked - * - * \return zero if the wait was completed successfully, error code otherwise: - * - EPERM - the mutex type is ErrorChecking or Recursive, and the current thread does not own the mutex; - * - ETIMEDOUT - no notification was received before the specified timeout expired; - */ - - template<typename Duration, typename Predicate> - int waitUntil(Mutex& mutex, std::chrono::time_point<TickClock, Duration> timePoint, Predicate predicate); - -private: - - /// ThreadControlBlock objects blocked on this condition variable - internal::ThreadList blockedList_; -}; - -template<typename Predicate> -int ConditionVariable::wait(Mutex& mutex, Predicate predicate) -{ - while (predicate() == false) - { - const auto ret = wait(mutex); - if (ret != 0) - return ret; - } - - return 0; -} - -template<typename Duration, typename Predicate> -int ConditionVariable::waitUntil(Mutex& mutex, const std::chrono::time_point<TickClock, Duration> timePoint, Predicate predicate) -{ - while (predicate() == false) - { - const auto ret = waitUntil(mutex, timePoint); - if (ret != 0) - return ret; - } - - return 0; -} - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_CONDITIONVARIABLE_HPP_ diff --git a/include/distortos/DynamicFifoQueue.hpp b/include/distortos/DynamicFifoQueue.hpp deleted file mode 100644 index fba876f..0000000 --- a/include/distortos/DynamicFifoQueue.hpp +++ /dev/null @@ -1,56 +0,0 @@ -/** - * \file - * \brief DynamicFifoQueue class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_DYNAMICFIFOQUEUE_HPP_ -#define INCLUDE_DISTORTOS_DYNAMICFIFOQUEUE_HPP_ - -#include "FifoQueue.hpp" - -#include "distortos/internal/memory/storageDeleter.hpp" - -namespace distortos -{ - -/** - * \brief DynamicFifoQueue class is a variant of FifoQueue that has dynamic storage for queue's contents. - * - * \tparam T is the type of data in queue - * - * \ingroup queues - */ - -template<typename T> -class DynamicFifoQueue : public FifoQueue<T> -{ -public: - - /// import Storage type from base class - using typename FifoQueue<T>::Storage; - - /** - * \brief DynamicFifoQueue's constructor - * - * \param [in] queueSize is the maximum number of elements in queue - */ - - explicit DynamicFifoQueue(size_t queueSize); -}; - -template<typename T> -DynamicFifoQueue<T>::DynamicFifoQueue(const size_t queueSize) : - FifoQueue<T>{{new Storage[queueSize], internal::storageDeleter<Storage>}, queueSize} -{ - -} - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_DYNAMICFIFOQUEUE_HPP_ diff --git a/include/distortos/DynamicMessageQueue.hpp b/include/distortos/DynamicMessageQueue.hpp deleted file mode 100644 index b298351..0000000 --- a/include/distortos/DynamicMessageQueue.hpp +++ /dev/null @@ -1,60 +0,0 @@ -/** - * \file - * \brief DynamicMessageQueue class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_DYNAMICMESSAGEQUEUE_HPP_ -#define INCLUDE_DISTORTOS_DYNAMICMESSAGEQUEUE_HPP_ - -#include "MessageQueue.hpp" - -#include "distortos/internal/memory/storageDeleter.hpp" - -namespace distortos -{ - -/** - * \brief DynamicMessageQueue class is a variant of MessageQueue that has dynamic storage for queue's contents. - * - * \tparam T is the type of data in queue - * - * \ingroup queues - */ - -template<typename T> -class DynamicMessageQueue : public MessageQueue<T> -{ -public: - - /// import EntryStorage type from base class - using typename MessageQueue<T>::EntryStorage; - - /// import ValueStorage type from base class - using typename MessageQueue<T>::ValueStorage; - - /** - * \brief DynamicMessageQueue's constructor - * - * \param [in] queueSize is the maximum number of elements in queue - */ - - explicit DynamicMessageQueue(size_t queueSize); -}; - -template<typename T> -DynamicMessageQueue<T>::DynamicMessageQueue(const size_t queueSize) : - MessageQueue<T>{{new EntryStorage[queueSize], internal::storageDeleter<EntryStorage>}, - {new ValueStorage[queueSize], internal::storageDeleter<ValueStorage>}, queueSize} -{ - -} - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_DYNAMICMESSAGEQUEUE_HPP_ diff --git a/include/distortos/DynamicRawFifoQueue.hpp b/include/distortos/DynamicRawFifoQueue.hpp deleted file mode 100644 index afd2f0b..0000000 --- a/include/distortos/DynamicRawFifoQueue.hpp +++ /dev/null @@ -1,42 +0,0 @@ -/** - * \file - * \brief DynamicRawFifoQueue class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_DYNAMICRAWFIFOQUEUE_HPP_ -#define INCLUDE_DISTORTOS_DYNAMICRAWFIFOQUEUE_HPP_ - -#include "RawFifoQueue.hpp" - -namespace distortos -{ - -/** - * \brief DynamicRawFifoQueue class is a variant of RawFifoQueue that has dynamic storage for queue's contents. - * - * \ingroup queues - */ - -class DynamicRawFifoQueue : public RawFifoQueue -{ -public: - - /** - * \brief DynamicRawFifoQueue's constructor - * - * \param [in] elementSize is the size of single queue element, bytes - * \param [in] queueSize is the maximum number of elements in queue - */ - - DynamicRawFifoQueue(size_t elementSize, size_t queueSize); -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_DYNAMICRAWFIFOQUEUE_HPP_ diff --git a/include/distortos/DynamicRawMessageQueue.hpp b/include/distortos/DynamicRawMessageQueue.hpp deleted file mode 100644 index ab68807..0000000 --- a/include/distortos/DynamicRawMessageQueue.hpp +++ /dev/null @@ -1,42 +0,0 @@ -/** - * \file - * \brief DynamicRawMessageQueue class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_DYNAMICRAWMESSAGEQUEUE_HPP_ -#define INCLUDE_DISTORTOS_DYNAMICRAWMESSAGEQUEUE_HPP_ - -#include "distortos/RawMessageQueue.hpp" - -namespace distortos -{ - -/** - * \brief DynamicRawMessageQueue class is a variant of RawMessageQueue that has dynamic storage for queue's contents. - * - * \ingroup queues - */ - -class DynamicRawMessageQueue : public RawMessageQueue -{ -public: - - /** - * \brief DynamicRawMessageQueue's constructor - * - * \param [in] elementSize is the size of single queue element, bytes - * \param [in] queueSize is the maximum number of elements in queue - */ - - DynamicRawMessageQueue(size_t elementSize, size_t queueSize); -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_DYNAMICRAWMESSAGEQUEUE_HPP_ diff --git a/include/distortos/DynamicSignalsReceiver.hpp b/include/distortos/DynamicSignalsReceiver.hpp deleted file mode 100644 index 386a612..0000000 --- a/include/distortos/DynamicSignalsReceiver.hpp +++ /dev/null @@ -1,52 +0,0 @@ -/** - * \file - * \brief DynamicSignalsReceiver class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_DYNAMICSIGNALSRECEIVER_HPP_ -#define INCLUDE_DISTORTOS_DYNAMICSIGNALSRECEIVER_HPP_ - -#include "distortos/SignalInformationQueueWrapper.hpp" -#include "distortos/SignalsCatcher.hpp" -#include "distortos/SignalsReceiver.hpp" - -namespace distortos -{ - -/** - * \brief DynamicSignalsReceiver class is a templated interface for SignalsReceiver that has dynamic storage for queued - * signals and SignalAction associations required for catching signals. - */ - -class DynamicSignalsReceiver : public SignalsReceiver -{ -public: - - /** - * \brief DynamicSignalsReceiver's constructor - * - * \param [in] queuedSignals is the max number of queued signals, 0 to disable queuing of signals for this receiver - * \param [in] signalActions is the max number of different SignalAction objects, 0 to disable catching of signals - * for this receiver - */ - - DynamicSignalsReceiver(size_t queuedSignals, size_t signalActions); - -private: - - /// internal SignalInformationQueueWrapper object - SignalInformationQueueWrapper signalInformationQueueWrapper_; - - /// internal SignalsCatcher object - SignalsCatcher signalsCatcher_; -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_DYNAMICSIGNALSRECEIVER_HPP_ diff --git a/include/distortos/DynamicThread.hpp b/include/distortos/DynamicThread.hpp deleted file mode 100644 index 4d7550a..0000000 --- a/include/distortos/DynamicThread.hpp +++ /dev/null @@ -1,373 +0,0 @@ -/** - * \file - * \brief DynamicThread class header - * - * \author Copyright (C) 2015-2016 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_DYNAMICTHREAD_HPP_ -#define INCLUDE_DISTORTOS_DYNAMICTHREAD_HPP_ - -#include "distortos/internal/scheduler/DynamicThreadBase.hpp" - -namespace distortos -{ - -/// \addtogroup threads -/// \{ - -/** - * \brief DynamicThread class is a type-erased interface for thread that has dynamic storage for bounded function, stack - * and internal DynamicSignalsReceiver object. - */ - -#ifdef CONFIG_THREAD_DETACH_ENABLE - -class DynamicThread : public Thread -{ -public: - - /** - * \brief DynamicThread's constructor - * - * \tparam Function is the function that will be executed in separate thread - * \tparam Args are the arguments for \a Function - * - * \param [in] stackSize is the size of stack, bytes - * \param [in] canReceiveSignals selects whether reception of signals is enabled (true) or disabled (false) for this - * thread - * \param [in] queuedSignals is the max number of queued signals for this thread, relevant only if - * \a canReceiveSignals == true, 0 to disable queuing of signals for this thread - * \param [in] signalActions is the max number of different SignalAction objects for this thread, relevant only if - * \a canReceiveSignals == true, 0 to disable catching of signals for this thread - * \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest - * \param [in] schedulingPolicy is the scheduling policy of the thread - * \param [in] function is a function that will be executed in separate thread - * \param [in] args are arguments for \a function - */ - - template<typename Function, typename... Args> - DynamicThread(size_t stackSize, bool canReceiveSignals, size_t queuedSignals, size_t signalActions, - uint8_t priority, SchedulingPolicy schedulingPolicy, Function&& function, Args&&... args); - - /** - * \brief DynamicThread's constructor - * - * \tparam Function is the function that will be executed in separate thread - * \tparam Args are the arguments for \a Function - * - * \param [in] parameters is a DynamicThreadParameters struct with thread parameters - * \param [in] function is a function that will be executed in separate thread - * \param [in] args are arguments for \a function - */ - - template<typename Function, typename... Args> - DynamicThread(const DynamicThreadParameters parameters, Function&& function, Args&&... args) : - DynamicThread{parameters.stackSize, parameters.canReceiveSignals, parameters.queuedSignals, - parameters.signalActions, parameters.priority, parameters.schedulingPolicy, - std::forward<Function>(function), std::forward<Args>(args)...} - { - - } - - /** - * \brief DynamicThread's destructor - */ - - ~DynamicThread() override; - - /** - * \brief Detaches the thread. - * - * Similar to std::thread::detach() - http://en.cppreference.com/w/cpp/thread/thread/detach - * Similar to POSIX pthread_detach() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_detach.html - * - * Detaches the executing thread from the Thread object, allowing execution to continue independently. All resources - * allocated for the thread will be deallocated when the thread terminates. - * - * \return 0 on success, error code otherwise: - * - EINVAL - this thread is already detached; - */ - - int detach() override; - - /** - * \brief Generates signal for thread. - * - * Similar to pthread_kill() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_kill.html - * - * Adds the signalNumber to set of pending signals. If this thread is currently waiting for this signal, it will be - * unblocked. - * - * \param [in] signalNumber is the signal that will be generated, [0; 31] - * - * \return 0 on success, error code otherwise: - * - EINVAL - \a signalNumber value is invalid; - * - ENOTSUP - reception of signals is disabled for this thread; - * - EINVAL - internal thread object was detached; - * - * \ingroup signals - */ - - int generateSignal(uint8_t signalNumber) override; - - /** - * \return effective priority of thread - */ - - uint8_t getEffectivePriority() const override; - - /** - * \brief Gets set of currently pending signals. - * - * Similar to sigpending() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sigpending.html - * - * This function shall return the set of signals that are blocked from delivery and are pending on the thread. - * - * \return set of currently pending signals - * - * \ingroup signals - */ - - SignalSet getPendingSignalSet() const override; - - /** - * \return priority of thread - */ - - uint8_t getPriority() const override; - - /** - * \return scheduling policy of the thread - */ - - SchedulingPolicy getSchedulingPolicy() const override; - - /** - * \return current state of thread - */ - - ThreadState getState() const override; - - /** - * \brief Waits for thread termination. - * - * Similar to std::thread::join() - http://en.cppreference.com/w/cpp/thread/thread/join - * Similar to POSIX pthread_join() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_join.html - * - * Blocks current thread until this thread finishes its execution. The results of multiple simultaneous calls to - * join() on the same target thread are undefined. - * - * \return 0 on success, error code otherwise: - * - EDEADLK - deadlock condition was detected, - * - EINVAL - this thread is not joinable, - * - EINVAL - internal thread object was detached; - * - ... - * - * \ingroup synchronization - */ - - int join() override; - - /** - * \brief Queues signal for thread. - * - * Similar to sigqueue() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sigqueue.html - * - * Adds the signalNumber and signal value (sigval union) to queue of SignalInformation objects. If this thread is - * currently waiting for this signal, it will be unblocked. - * - * \param [in] signalNumber is the signal that will be queued, [0; 31] - * \param [in] value is the signal value - * - * \return 0 on success, error code otherwise: - * - EAGAIN - no resources are available to queue the signal, maximal number of signals is already queued in - * associated queue of SignalInformation objects; - * - EINVAL - \a signalNumber value is invalid; - * - ENOTSUP - reception or queuing of signals are disabled for this thread; - * - EINVAL - internal thread object was detached; - * - * \ingroup signals - */ - - int queueSignal(uint8_t signalNumber, sigval value) override; - - /** - * \brief Changes priority of thread. - * - * If the priority really changes, the position in the thread list is adjusted and context switch may be requested. - * - * \param [in] priority is the new priority of thread - * \param [in] alwaysBehind selects the method of ordering when lowering the priority - * - false - the thread is moved to the head of the group of threads with the new priority (default), - * - true - the thread is moved to the tail of the group of threads with the new priority. - */ - - void setPriority(uint8_t priority, bool alwaysBehind = {}) override; - - /** - * param [in] schedulingPolicy is the new scheduling policy of the thread - */ - - void setSchedulingPolicy(SchedulingPolicy schedulingPolicy) override; - - /** - * \brief Starts the thread. - * - * This operation can be performed on threads in "New" state only. - * - * \return 0 on success, error code otherwise: - * - EINVAL - thread is already started; - * - EINVAL - internal thread object was detached; - * - error codes returned by scheduler::Scheduler::add(); - */ - - int start() override; - - DynamicThread(const DynamicThread&) = delete; - DynamicThread(DynamicThread&&) = default; - const DynamicThread& operator=(const DynamicThread&) = delete; - DynamicThread& operator=(DynamicThread&&) = delete; - -private: - - /// internal thread object - std::unique_ptr<internal::DynamicThreadBase> detachableThread_; -}; - -#else // !def CONFIG_THREAD_DETACH_ENABLE - -class DynamicThread : public internal::DynamicThreadBase -{ -public: - - using internal::DynamicThreadBase::DynamicThreadBase; -}; - -#endif // !def CONFIG_THREAD_DETACH_ENABLE - -/** - * \brief Helper factory function to make DynamicThread object - * - * \tparam Function is the function that will be executed - * \tparam Args are the arguments for \a Function - * - * \param [in] stackSize is the size of stack, bytes - * \param [in] canReceiveSignals selects whether reception of signals is enabled (true) or disabled (false) for this - * thread - * \param [in] queuedSignals is the max number of queued signals for this thread, relevant only if - * \a canReceiveSignals == true, 0 to disable queuing of signals for this thread - * \param [in] signalActions is the max number of different SignalAction objects for this thread, relevant only if - * \a canReceiveSignals == true, 0 to disable catching of signals for this thread - * \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest - * \param [in] schedulingPolicy is the scheduling policy of the thread - * \param [in] function is a function that will be executed in separate thread - * \param [in] args are arguments for \a function - * - * \return DynamicThread object - */ - -template<typename Function, typename... Args> -DynamicThread makeDynamicThread(const size_t stackSize, const bool canReceiveSignals, const size_t queuedSignals, - const size_t signalActions, const uint8_t priority, const SchedulingPolicy schedulingPolicy, - Function&& function, Args&&... args) -{ - return {stackSize, canReceiveSignals, queuedSignals, signalActions, priority, schedulingPolicy, - std::forward<Function>(function), std::forward<Args>(args)...}; -} - -/** - * \brief Helper factory function to make DynamicThread object - * - * \tparam Function is the function that will be executed - * \tparam Args are the arguments for \a Function - * - * \param [in] parameters is a DynamicThreadParameters struct with thread parameters - * \param [in] function is a function that will be executed in separate thread - * \param [in] args are arguments for \a function - * - * \return DynamicThread object - */ - -template<typename Function, typename... Args> -DynamicThread makeDynamicThread(const DynamicThreadParameters parameters, Function&& function, Args&&... args) -{ - return {parameters, std::forward<Function>(function), std::forward<Args>(args)...}; -} - -/** - * \brief Helper factory function to make and start DynamicThread object - * - * \tparam Function is the function that will be executed - * \tparam Args are the arguments for \a Function - * - * \param [in] stackSize is the size of stack, bytes - * \param [in] canReceiveSignals selects whether reception of signals is enabled (true) or disabled (false) for this - * thread - * \param [in] queuedSignals is the max number of queued signals for this thread, relevant only if - * \a canReceiveSignals == true, 0 to disable queuing of signals for this thread - * \param [in] signalActions is the max number of different SignalAction objects for this thread, relevant only if - * \a canReceiveSignals == true, 0 to disable catching of signals for this thread - * \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest - * \param [in] schedulingPolicy is the scheduling policy of the thread - * \param [in] function is a function that will be executed in separate thread - * \param [in] args are arguments for \a function - * - * \return DynamicThread object - */ - -template<typename Function, typename... Args> -DynamicThread makeAndStartDynamicThread(const size_t stackSize, const bool canReceiveSignals, - const size_t queuedSignals, const size_t signalActions, const uint8_t priority, - const SchedulingPolicy schedulingPolicy, Function&& function, Args&&... args) -{ - auto thread = makeDynamicThread(stackSize, canReceiveSignals, queuedSignals, signalActions, priority, - schedulingPolicy, std::forward<Function>(function), std::forward<Args>(args)...); - thread.start(); /// \todo make sure this never fails - return thread; -} - -/** - * \brief Helper factory function to make and start DynamicThread object - * - * \tparam Function is the function that will be executed - * \tparam Args are the arguments for \a Function - * - * \param [in] parameters is a DynamicThreadParameters struct with thread parameters - * \param [in] function is a function that will be executed in separate thread - * \param [in] args are arguments for \a function - * - * \return DynamicThread object - */ - -template<typename Function, typename... Args> -DynamicThread makeAndStartDynamicThread(const DynamicThreadParameters parameters, Function&& function, Args&&... args) -{ - auto thread = makeDynamicThread(parameters, std::forward<Function>(function), std::forward<Args>(args)...); - thread.start(); /// \todo make sure this never fails - return thread; -} - -/// \} - -#ifdef CONFIG_THREAD_DETACH_ENABLE - -template<typename Function, typename... Args> -DynamicThread::DynamicThread(const size_t stackSize, const bool canReceiveSignals, const size_t queuedSignals, - const size_t signalActions, const uint8_t priority, const SchedulingPolicy schedulingPolicy, - Function&& function, Args&&... args) : - detachableThread_{new internal::DynamicThreadBase{stackSize, canReceiveSignals, queuedSignals, signalActions, - priority, schedulingPolicy, *this, std::forward<Function>(function), std::forward<Args>(args)...}} -{ - -} - -#endif // def CONFIG_THREAD_DETACH_ENABLE - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_DYNAMICTHREAD_HPP_ diff --git a/include/distortos/DynamicThreadParameters.hpp b/include/distortos/DynamicThreadParameters.hpp deleted file mode 100644 index b27056c..0000000 --- a/include/distortos/DynamicThreadParameters.hpp +++ /dev/null @@ -1,99 +0,0 @@ -/** - * \file - * \brief DynamicThreadParameters class header - * - * \author Copyright (C) 2015-2016 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_DYNAMICTHREADPARAMETERS_HPP_ -#define INCLUDE_DISTORTOS_DYNAMICTHREADPARAMETERS_HPP_ - -#include "distortos/SchedulingPolicy.hpp" - -#include <cstddef> - -namespace distortos -{ - -/** - * \brief DynamicThreadParameters struct is a helper with parameters for DynamicThread's constructor - * - * This struct is a replacement for overloads of DynamicThread's constructor, makeDynamicThread() and - * makeAndStartDynamicThread() which - unfortunately - cannot be used, as they would lead to compilation errors due to - * ambiguity. - * - * \ingroup threads - */ - -struct DynamicThreadParameters -{ - /** - * \brief DynamicThreadParameters's constructor - * - * \param [in] stackSizee is the size of stack, bytes - * \param [in] canReceiveSignalss selects whether reception of signals is enabled (true) or disabled (false) for - * this thread - * \param [in] queuedSignalss is the max number of queued signals for this thread, relevant only if - * \a canReceiveSignals == true, 0 to disable queuing of signals for this thread - * \param [in] signalActionss is the max number of different SignalAction objects for this thread, relevant only if - * \a canReceiveSignals == true, 0 to disable catching of signals for this thread - * \param [in] priorityy is the thread's priority, 0 - lowest, UINT8_MAX - highest - * \param [in] schedulingPolicyy is the scheduling policy of the thread, default - SchedulingPolicy::roundRobin - */ - - constexpr DynamicThreadParameters(const size_t stackSizee, const bool canReceiveSignalss, - const size_t queuedSignalss, const size_t signalActionss, const uint8_t priorityy, - const SchedulingPolicy schedulingPolicyy = SchedulingPolicy::roundRobin) : - queuedSignals{queuedSignalss}, - signalActions{signalActionss}, - stackSize{stackSizee}, - canReceiveSignals{canReceiveSignalss}, - priority{priorityy}, - schedulingPolicy{schedulingPolicyy} - { - - } - - /** - * \brief DynamicThreadParameters's constructor - * - * \param [in] stackSizee is the size of stack, bytes - * \param [in] priorityy is the thread's priority, 0 - lowest, UINT8_MAX - highest - * \param [in] schedulingPolicyy is the scheduling policy of the thread, default - SchedulingPolicy::roundRobin - */ - - constexpr DynamicThreadParameters(const size_t stackSizee, const uint8_t priorityy, - const SchedulingPolicy schedulingPolicyy = SchedulingPolicy::roundRobin) : - DynamicThreadParameters{stackSizee, false, 0, 0, priorityy, schedulingPolicyy} - { - - } - - /// max number of queued signals for this thread, relevant only if \a canReceiveSignals == true, 0 to disable - /// queuing of signals for this thread - size_t queuedSignals; - - /// max number of different SignalAction objects for this thread, relevant only if \a canReceiveSignals == true, 0 - /// to disable catching of signals for this thread - size_t signalActions; - - /// size of stack, bytes - size_t stackSize; - - /// selects whether reception of signals is enabled (true) or disabled (false) for this thread - bool canReceiveSignals; - - /// thread's priority, 0 - lowest, UINT8_MAX - highest - uint8_t priority; - - /// scheduling policy of the thread - SchedulingPolicy schedulingPolicy; -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_DYNAMICTHREADPARAMETERS_HPP_ diff --git a/include/distortos/FifoQueue.hpp b/include/distortos/FifoQueue.hpp deleted file mode 100644 index 9f6c952..0000000 --- a/include/distortos/FifoQueue.hpp +++ /dev/null @@ -1,682 +0,0 @@ -/** - * \file - * \brief FifoQueue class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_FIFOQUEUE_HPP_ -#define INCLUDE_DISTORTOS_FIFOQUEUE_HPP_ - -#include "distortos/internal/synchronization/FifoQueueBase.hpp" -#include "distortos/internal/synchronization/BoundQueueFunctor.hpp" -#include "distortos/internal/synchronization/CopyConstructQueueFunctor.hpp" -#include "distortos/internal/synchronization/MoveConstructQueueFunctor.hpp" -#include "distortos/internal/synchronization/SwapPopQueueFunctor.hpp" -#include "distortos/internal/synchronization/SemaphoreWaitFunctor.hpp" -#include "distortos/internal/synchronization/SemaphoreTryWaitFunctor.hpp" -#include "distortos/internal/synchronization/SemaphoreTryWaitForFunctor.hpp" -#include "distortos/internal/synchronization/SemaphoreTryWaitUntilFunctor.hpp" - -/// GCC 4.9 is needed for all FifoQueue::*emplace*() functions - earlier versions don't support parameter pack expansion -/// in lambdas -#define DISTORTOS_FIFOQUEUE_EMPLACE_SUPPORTED __GNUC_PREREQ(4, 9) - -namespace distortos -{ - -/** - * \brief FifoQueue class is a simple FIFO queue for thread-thread, thread-interrupt or interrupt-interrupt - * communication. It supports multiple readers and multiple writers. It is implemented as a wrapper for - * internal::FifoQueueBase. - * - * \tparam T is the type of data in queue - * - * \ingroup queues - */ - -template<typename T> -class FifoQueue -{ -public: - - /// type of uninitialized storage for data - using Storage = typename std::aligned_storage<sizeof(T), alignof(T)>::type; - - /// unique_ptr (with deleter) to Storage[] - using StorageUniquePointer = - std::unique_ptr<Storage[], internal::FifoQueueBase::StorageUniquePointer::deleter_type>; - - /** - * \brief FifoQueue's constructor - * - * \param [in] storageUniquePointer is a rvalue reference to StorageUniquePointer with storage for queue elements - * (sufficiently large for \a maxElements, each sizeof(T) bytes long) and appropriate deleter - * \param [in] maxElements is the number of elements in storage array - */ - - FifoQueue(StorageUniquePointer&& storageUniquePointer, const size_t maxElements) : - fifoQueueBase_{{storageUniquePointer.release(), storageUniquePointer.get_deleter()}, sizeof(T), maxElements} - { - - } - - /** - * \brief FifoQueue's destructor - * - * Pops all remaining elements from the queue. - */ - - ~FifoQueue(); - -#if DISTORTOS_FIFOQUEUE_EMPLACE_SUPPORTED == 1 || DOXYGEN == 1 - - /** - * \brief Emplaces the element in the queue. - * - * \note This function requires GCC 4.9. - * - * \tparam Args are types of arguments for constructor of T - * - * \param [in] args are arguments for constructor of T - * - * \return zero if element was emplaced successfully, error code otherwise: - * - error codes returned by Semaphore::wait(); - * - error codes returned by Semaphore::post(); - */ - - template<typename... Args> - int emplace(Args&&... args) - { - const internal::SemaphoreWaitFunctor semaphoreWaitFunctor; - return emplaceInternal(semaphoreWaitFunctor, std::forward<Args>(args)...); - } - -#endif // DISTORTOS_FIFOQUEUE_EMPLACE_SUPPORTED == 1 || DOXYGEN == 1 - - /** - * \brief Pops the oldest (first) element from the queue. - * - * \param [out] value is a reference to object that will be used to return popped value, its contents are swapped - * with the value in the queue's storage and destructed when no longer needed - * - * \return zero if element was popped successfully, error code otherwise: - * - error codes returned by Semaphore::wait(); - * - error codes returned by Semaphore::post(); - */ - - int pop(T& value) - { - const internal::SemaphoreWaitFunctor semaphoreWaitFunctor; - return popInternal(semaphoreWaitFunctor, value); - } - - /** - * \brief Pushes the element to the queue. - * - * \param [in] value is a reference to object that will be pushed, value in queue's storage is copy-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::wait(); - * - error codes returned by Semaphore::post(); - */ - - int push(const T& value) - { - const internal::SemaphoreWaitFunctor semaphoreWaitFunctor; - return pushInternal(semaphoreWaitFunctor, value); - } - - /** - * \brief Pushes the element to the queue. - * - * \param [in] value is a rvalue reference to object that will be pushed, value in queue's storage is - * move-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::wait(); - * - error codes returned by Semaphore::post(); - */ - - int push(T&& value) - { - const internal::SemaphoreWaitFunctor semaphoreWaitFunctor; - return pushInternal(semaphoreWaitFunctor, std::move(value)); - } - -#if DISTORTOS_FIFOQUEUE_EMPLACE_SUPPORTED == 1 || DOXYGEN == 1 - - /** - * \brief Tries to emplace the element in the queue. - * - * \note This function requires GCC 4.9. - * - * \tparam Args are types of arguments for constructor of T - * - * \param [in] args are arguments for constructor of T - * - * \return zero if element was emplaced successfully, error code otherwise: - * - error codes returned by Semaphore::tryWait(); - * - error codes returned by Semaphore::post(); - */ - - template<typename... Args> - int tryEmplace(Args&&... args) - { - const internal::SemaphoreTryWaitFunctor semaphoreTryWaitFunctor; - return emplaceInternal(semaphoreTryWaitFunctor, std::forward<Args>(args)...); - } - - /** - * \brief Tries to emplace the element in the queue for a given duration of time. - * - * \note This function requires GCC 4.9. - * - * \tparam Args are types of arguments for constructor of T - * - * \param [in] duration is the duration after which the wait will be terminated without emplacing the element - * \param [in] args are arguments for constructor of T - * - * \return zero if element was emplaced successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - template<typename... Args> - int tryEmplaceFor(const TickClock::duration duration, Args&&... args) - { - const internal::SemaphoreTryWaitForFunctor semaphoreTryWaitForFunctor {duration}; - return emplaceInternal(semaphoreTryWaitForFunctor, std::forward<Args>(args)...); - } - - /** - * \brief Tries to emplace the element in the queue for a given duration of time. - * - * Template variant of FifoQueue::tryEmplaceFor(TickClock::duration, Args&&...). - * - * \note This function requires GCC 4.9. - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * \tparam Args are types of arguments for constructor of T - * - * \param [in] duration is the duration after which the wait will be terminated without emplacing the element - * \param [in] args are arguments for constructor of T - * - * \return zero if element was emplaced successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Rep, typename Period, typename... Args> - int tryEmplaceFor(const std::chrono::duration<Rep, Period> duration, Args&&... args) - { - return tryEmplaceFor(std::chrono::duration_cast<TickClock::duration>(duration), std::forward<Args>(args)...); - } - - /** - * \brief Tries to emplace the element in the queue until a given time point. - * - * \note This function requires GCC 4.9. - * - * \tparam Args are types of arguments for constructor of T - * - * \param [in] timePoint is the time point at which the call will be terminated without emplacing the element - * \param [in] args are arguments for constructor of T - * - * \return zero if element was emplaced successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - template<typename... Args> - int tryEmplaceUntil(const TickClock::time_point timePoint, Args&&... args) - { - const internal::SemaphoreTryWaitUntilFunctor semaphoreTryWaitUntilFunctor {timePoint}; - return emplaceInternal(semaphoreTryWaitUntilFunctor, std::forward<Args>(args)...); - } - - /** - * \brief Tries to emplace the element in the queue until a given time point. - * - * Template variant of FifoQueue::tryEmplaceUntil(TickClock::time_point, Args&&...). - * - * \note This function requires GCC 4.9. - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * \tparam Args are types of arguments for constructor of T - * - * \param [in] timePoint is the time point at which the call will be terminated without emplacing the element - * \param [in] args are arguments for constructor of T - * - * \return zero if element was emplaced successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Duration, typename... Args> - int tryEmplaceUntil(const std::chrono::time_point<TickClock, Duration> timePoint, Args&&... args) - { - return tryEmplaceUntil(std::chrono::time_point_cast<TickClock::duration>(timePoint), - std::forward<Args>(args)...); - } - -#endif // DISTORTOS_FIFOQUEUE_EMPLACE_SUPPORTED == 1 || DOXYGEN == 1 - - /** - * \brief Tries to pop the oldest (first) element from the queue. - * - * \param [out] value is a reference to object that will be used to return popped value, its contents are swapped - * with the value in the queue's storage and destructed when no longer needed - * - * \return zero if element was popped successfully, error code otherwise: - * - error codes returned by Semaphore::tryWait(); - * - error codes returned by Semaphore::post(); - */ - - int tryPop(T& value) - { - internal::SemaphoreTryWaitFunctor semaphoreTryWaitFunctor; - return popInternal(semaphoreTryWaitFunctor, value); - } - - /** - * \brief Tries to pop the oldest (first) element from the queue for a given duration of time. - * - * \param [in] duration is the duration after which the call will be terminated without popping the element - * \param [out] value is a reference to object that will be used to return popped value, its contents are swapped - * with the value in the queue's storage and destructed when no longer needed - * - * \return zero if element was popped successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - int tryPopFor(const TickClock::duration duration, T& value) - { - const internal::SemaphoreTryWaitForFunctor semaphoreTryWaitForFunctor {duration}; - return popInternal(semaphoreTryWaitForFunctor, value); - } - - /** - * \brief Tries to pop the oldest (first) element from the queue for a given duration of time. - * - * Template variant of tryPopFor(TickClock::duration, T&). - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * - * \param [in] duration is the duration after which the call will be terminated without popping the element - * \param [out] value is a reference to object that will be used to return popped value, its contents are swapped - * with the value in the queue's storage and destructed when no longer needed - * - * \return zero if element was popped successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Rep, typename Period> - int tryPopFor(const std::chrono::duration<Rep, Period> duration, T& value) - { - return tryPopFor(std::chrono::duration_cast<TickClock::duration>(duration), value); - } - - /** - * \brief Tries to pop the oldest (first) element from the queue until a given time point. - * - * \param [in] timePoint is the time point at which the call will be terminated without popping the element - * \param [out] value is a reference to object that will be used to return popped value, its contents are swapped - * with the value in the queue's storage and destructed when no longer needed - * - * \return zero if element was popped successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - int tryPopUntil(const TickClock::time_point timePoint, T& value) - { - const internal::SemaphoreTryWaitUntilFunctor semaphoreTryWaitUntilFunctor {timePoint}; - return popInternal(semaphoreTryWaitUntilFunctor, value); - } - - /** - * \brief Tries to pop the oldest (first) element from the queue until a given time point. - * - * Template variant of tryPopUntil(TickClock::time_point, T&). - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * - * \param [in] timePoint is the time point at which the call will be terminated without popping the element - * \param [out] value is a reference to object that will be used to return popped value, its contents are swapped - * with the value in the queue's storage and destructed when no longer needed - * - * \return zero if element was popped successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Duration> - int tryPopUntil(const std::chrono::time_point<TickClock, Duration> timePoint, T& value) - { - return tryPopUntil(std::chrono::time_point_cast<TickClock::duration>(timePoint), value); - } - - /** - * \brief Tries to push the element to the queue. - * - * \param [in] value is a reference to object that will be pushed, value in queue's storage is copy-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::tryWait(); - * - error codes returned by Semaphore::post(); - */ - - int tryPush(const T& value) - { - const internal::SemaphoreTryWaitFunctor semaphoreTryWaitFunctor; - return pushInternal(semaphoreTryWaitFunctor, value); - } - - /** - * \brief Tries to push the element to the queue. - * - * \param [in] value is a rvalue reference to object that will be pushed, value in queue's storage is - * move-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::tryWait(); - * - error codes returned by Semaphore::post(); - */ - - int tryPush(T&& value) - { - const internal::SemaphoreTryWaitFunctor semaphoreTryWaitFunctor; - return pushInternal(semaphoreTryWaitFunctor, std::move(value)); - } - - /** - * \brief Tries to push the element to the queue for a given duration of time. - * - * \param [in] duration is the duration after which the wait will be terminated without pushing the element - * \param [in] value is a reference to object that will be pushed, value in queue's storage is copy-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - int tryPushFor(const TickClock::duration duration, const T& value) - { - const internal::SemaphoreTryWaitForFunctor semaphoreTryWaitForFunctor {duration}; - return pushInternal(semaphoreTryWaitForFunctor, value); - } - - /** - * \brief Tries to push the element to the queue for a given duration of time. - * - * Template variant of tryPushFor(TickClock::duration, const T&). - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * - * \param [in] duration is the duration after which the wait will be terminated without pushing the element - * \param [in] value is a reference to object that will be pushed, value in queue's storage is copy-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Rep, typename Period> - int tryPushFor(const std::chrono::duration<Rep, Period> duration, const T& value) - { - return tryPushFor(std::chrono::duration_cast<TickClock::duration>(duration), value); - } - - /** - * \brief Tries to push the element to the queue for a given duration of time. - * - * \param [in] duration is the duration after which the call will be terminated without pushing the element - * \param [in] value is a rvalue reference to object that will be pushed, value in queue's storage is - * move-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - int tryPushFor(const TickClock::duration duration, T&& value) - { - const internal::SemaphoreTryWaitForFunctor semaphoreTryWaitForFunctor {duration}; - return pushInternal(semaphoreTryWaitForFunctor, std::move(value)); - } - - /** - * \brief Tries to push the element to the queue for a given duration of time. - * - * Template variant of tryPushFor(TickClock::duration, T&&). - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * - * \param [in] duration is the duration after which the call will be terminated without pushing the element - * \param [in] value is a rvalue reference to object that will be pushed, value in queue's storage is - * move-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Rep, typename Period> - int tryPushFor(const std::chrono::duration<Rep, Period> duration, T&& value) - { - return tryPushFor(std::chrono::duration_cast<TickClock::duration>(duration), std::move(value)); - } - - /** - * \brief Tries to push the element to the queue until a given time point. - * - * \param [in] timePoint is the time point at which the call will be terminated without pushing the element - * \param [in] value is a reference to object that will be pushed, value in queue's storage is copy-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - int tryPushUntil(const TickClock::time_point timePoint, const T& value) - { - const internal::SemaphoreTryWaitUntilFunctor semaphoreTryWaitUntilFunctor {timePoint}; - return pushInternal(semaphoreTryWaitUntilFunctor, value); - } - - /** - * \brief Tries to push the element to the queue until a given time point. - * - * Template variant of tryPushUntil(TickClock::time_point, const T&). - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * - * \param [in] timePoint is the time point at which the call will be terminated without pushing the element - * \param [in] value is a reference to object that will be pushed, value in queue's storage is copy-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Duration> - int tryPushUntil(const std::chrono::time_point<TickClock, Duration> timePoint, const T& value) - { - return tryPushUntil(std::chrono::time_point_cast<TickClock::duration>(timePoint), value); - } - - /** - * \brief Tries to push the element to the queue until a given time point. - * - * \param [in] timePoint is the time point at which the call will be terminated without pushing the element - * \param [in] value is a rvalue reference to object that will be pushed, value in queue's storage is - * move-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - int tryPushUntil(const TickClock::time_point timePoint, T&& value) - { - const internal::SemaphoreTryWaitUntilFunctor semaphoreTryWaitUntilFunctor {timePoint}; - return pushInternal(semaphoreTryWaitUntilFunctor, std::move(value)); - } - - /** - * \brief Tries to push the element to the queue until a given time point. - * - * Template variant of tryPushUntil(TickClock::time_point, T&&). - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * - * \param [in] timePoint is the time point at which the call will be terminated without pushing the element - * \param [in] value is a rvalue reference to object that will be pushed, value in queue's storage is - * move-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Duration> - int tryPushUntil(const std::chrono::time_point<TickClock, Duration> timePoint, T&& value) - { - return tryPushUntil(std::chrono::time_point_cast<TickClock::duration>(timePoint), std::move(value)); - } - -private: - -#if DISTORTOS_FIFOQUEUE_EMPLACE_SUPPORTED == 1 || DOXYGEN == 1 - - /** - * \brief Emplaces the element in the queue. - * - * Internal version - builds the Functor object. - * - * \note This function requires GCC 4.9. - * - * \tparam Args are types of arguments for constructor of T - * - * \param [in] waitSemaphoreFunctor is a reference to SemaphoreFunctor which will be executed with \a pushSemaphore_ - * \param [in] args are arguments for constructor of T - * - * \return zero if element was emplaced successfully, error code otherwise: - * - error codes returned by \a waitSemaphoreFunctor's operator() call; - * - error codes returned by Semaphore::post(); - */ - - template<typename... Args> - int emplaceInternal(const internal::SemaphoreFunctor& waitSemaphoreFunctor, Args&&... args); - -#endif // DISTORTOS_FIFOQUEUE_EMPLACE_SUPPORTED == 1 || DOXYGEN == 1 - - /** - * \brief Pops the oldest (first) element from the queue. - * - * Internal version - builds the Functor object. - * - * \param [in] waitSemaphoreFunctor is a reference to SemaphoreFunctor which will be executed with \a popSemaphore_ - * \param [out] value is a reference to object that will be used to return popped value, its contents are swapped - * with the value in the queue's storage and destructed when no longer needed - * - * \return zero if element was popped successfully, error code otherwise: - * - error codes returned by \a waitSemaphoreFunctor's operator() call; - * - error codes returned by Semaphore::post(); - */ - - int popInternal(const internal::SemaphoreFunctor& waitSemaphoreFunctor, T& value); - - /** - * \brief Pushes the element to the queue. - * - * Internal version - builds the Functor object. - * - * \param [in] waitSemaphoreFunctor is a reference to SemaphoreFunctor which will be executed with \a pushSemaphore_ - * \param [in] value is a reference to object that will be pushed, value in queue's storage is copy-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by \a waitSemaphoreFunctor's operator() call; - * - error codes returned by Semaphore::post(); - */ - - int pushInternal(const internal::SemaphoreFunctor& waitSemaphoreFunctor, const T& value); - - /** - * \brief Pushes the element to the queue. - * - * Internal version - builds the Functor object. - * - * \param [in] waitSemaphoreFunctor is a reference to SemaphoreFunctor which will be executed with \a pushSemaphore_ - * \param [in] value is a rvalue reference to object that will be pushed, value in queue's storage is - * move-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by \a waitSemaphoreFunctor's operator() call; - * - error codes returned by Semaphore::post(); - */ - - int pushInternal(const internal::SemaphoreFunctor& waitSemaphoreFunctor, T&& value); - - /// contained internal::FifoQueueBase object which implements whole functionality - internal::FifoQueueBase fifoQueueBase_; -}; - -template<typename T> -FifoQueue<T>::~FifoQueue() -{ - T value; - while (tryPop(value) == 0); -} - -#if DISTORTOS_FIFOQUEUE_EMPLACE_SUPPORTED == 1 || DOXYGEN == 1 - -template<typename T> -template<typename... Args> -int FifoQueue<T>::emplaceInternal(const internal::SemaphoreFunctor& waitSemaphoreFunctor, Args&&... args) -{ - const auto emplaceFunctor = internal::makeBoundQueueFunctor( - [&args...](void* const storage) - { - new (storage) T{std::forward<Args>(args)...}; - }); - return fifoQueueBase_.push(waitSemaphoreFunctor, emplaceFunctor); -} - -#endif // DISTORTOS_FIFOQUEUE_EMPLACE_SUPPORTED == 1 || DOXYGEN == 1 - -template<typename T> -int FifoQueue<T>::popInternal(const internal::SemaphoreFunctor& waitSemaphoreFunctor, T& value) -{ - const internal::SwapPopQueueFunctor<T> swapPopQueueFunctor {value}; - return fifoQueueBase_.pop(waitSemaphoreFunctor, swapPopQueueFunctor); -} - -template<typename T> -int FifoQueue<T>::pushInternal(const internal::SemaphoreFunctor& waitSemaphoreFunctor, const T& value) -{ - const internal::CopyConstructQueueFunctor<T> copyConstructQueueFunctor {value}; - return fifoQueueBase_.push(waitSemaphoreFunctor, copyConstructQueueFunctor); -} - -template<typename T> -int FifoQueue<T>::pushInternal(const internal::SemaphoreFunctor& waitSemaphoreFunctor, T&& value) -{ - const internal::MoveConstructQueueFunctor<T> moveConstructQueueFunctor {std::move(value)}; - return fifoQueueBase_.push(waitSemaphoreFunctor, moveConstructQueueFunctor); -} - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_FIFOQUEUE_HPP_ diff --git a/include/distortos/MessageQueue.hpp b/include/distortos/MessageQueue.hpp deleted file mode 100644 index 0f44d8f..0000000 --- a/include/distortos/MessageQueue.hpp +++ /dev/null @@ -1,762 +0,0 @@ -/** - * \file - * \brief MessageQueue class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_MESSAGEQUEUE_HPP_ -#define INCLUDE_DISTORTOS_MESSAGEQUEUE_HPP_ - -#include "distortos/internal/synchronization/MessageQueueBase.hpp" -#include "distortos/internal/synchronization/BoundQueueFunctor.hpp" -#include "distortos/internal/synchronization/CopyConstructQueueFunctor.hpp" -#include "distortos/internal/synchronization/MoveConstructQueueFunctor.hpp" -#include "distortos/internal/synchronization/SwapPopQueueFunctor.hpp" -#include "distortos/internal/synchronization/SemaphoreWaitFunctor.hpp" -#include "distortos/internal/synchronization/SemaphoreTryWaitFunctor.hpp" -#include "distortos/internal/synchronization/SemaphoreTryWaitForFunctor.hpp" -#include "distortos/internal/synchronization/SemaphoreTryWaitUntilFunctor.hpp" - -namespace distortos -{ - -/// GCC 4.9 is needed for all MessageQueue::*emplace*() functions - earlier versions don't support parameter pack -/// expansion in lambdas -#define DISTORTOS_MESSAGEQUEUE_EMPLACE_SUPPORTED __GNUC_PREREQ(4, 9) - -/** - * \brief MessageQueue class is a message queue for thread-thread, thread-interrupt or interrupt-interrupt - * communication. It supports multiple readers and multiple writers. It is implemented as a wrapper for - * internal::MessageQueueBase. - * - * Similar to POSIX mqd_t - http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/mqueue.h.html - * - * \tparam T is the type of data in queue - * - * \ingroup queues - */ - -template<typename T> -class MessageQueue -{ -public: - - /// type of uninitialized storage for Entry with link - using EntryStorage = internal::MessageQueueBase::EntryStorage; - - /// type of uninitialized storage for value - using ValueStorage = internal::MessageQueueBase::ValueStorage<T>; - - /// import EntryStorageUniquePointer type from internal::MessageQueueBase class - using EntryStorageUniquePointer = internal::MessageQueueBase::EntryStorageUniquePointer; - - /// unique_ptr (with deleter) to ValueStorage[] - using ValueStorageUniquePointer = - std::unique_ptr<ValueStorage[], internal::MessageQueueBase::ValueStorageUniquePointer::deleter_type>; - - /** - * \brief MessageQueue's constructor - * - * \param [in] entryStorageUniquePointer is a rvalue reference to EntryStorageUniquePointer with storage for queue - * entries (sufficiently large for \a maxElements EntryStorage objects) and appropriate deleter - * \param [in] valueStorageUniquePointer is a rvalue reference to ValueStorageUniquePointer with storage for queue - * elements (sufficiently large for \a maxElements, each sizeof(T) bytes long) and appropriate deleter - * \param [in] maxElements is the number of elements in \a entryStorage and \a valueStorage arrays - */ - - MessageQueue(EntryStorageUniquePointer&& entryStorageUniquePointer, - ValueStorageUniquePointer&& valueStorageUniquePointer, const size_t maxElements) : - messageQueueBase_{std::move(entryStorageUniquePointer), - {valueStorageUniquePointer.release(), valueStorageUniquePointer.get_deleter()}, - sizeof(*valueStorageUniquePointer.get()), maxElements} - { - - } - - /** - * \brief MessageQueue's destructor - * - * Pops all remaining elements from the queue. - */ - - ~MessageQueue(); - -#if DISTORTOS_MESSAGEQUEUE_EMPLACE_SUPPORTED == 1 || DOXYGEN == 1 - - /** - * \brief Emplaces the element in the queue. - * - * Similar to mq_send() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_send.html# - * - * \note This function requires GCC 4.9. - * - * \tparam Args are types of arguments for constructor of T - * - * \param [in] priority is the priority of new element - * \param [in] args are arguments for constructor of T - * - * \return zero if element was emplaced successfully, error code otherwise: - * - error codes returned by Semaphore::wait(); - * - error codes returned by Semaphore::post(); - */ - - template<typename... Args> - int emplace(const uint8_t priority, Args&&... args) - { - const internal::SemaphoreWaitFunctor semaphoreWaitFunctor; - return emplaceInternal(semaphoreWaitFunctor, priority, std::forward<Args>(args)...); - } - -#endif // DISTORTOS_MESSAGEQUEUE_EMPLACE_SUPPORTED == 1 || DOXYGEN == 1 - - /** - * \brief Pops oldest element with highest priority from the queue. - * - * Similar to mq_receive() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_receive.html# - * - * \param [out] priority is a reference to variable that will be used to return priority of popped value - * \param [out] value is a reference to object that will be used to return popped value, its contents are swapped - * with the value in the queue's storage and destructed when no longer needed - * - * \return zero if element was popped successfully, error code otherwise: - * - error codes returned by Semaphore::wait(); - * - error codes returned by Semaphore::post(); - */ - - int pop(uint8_t& priority, T& value) - { - const internal::SemaphoreWaitFunctor semaphoreWaitFunctor; - return popInternal(semaphoreWaitFunctor, priority, value); - } - - /** - * \brief Pushes the element to the queue. - * - * Similar to mq_send() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_send.html# - * - * \param [in] priority is the priority of new element - * \param [in] value is a reference to object that will be pushed, value in queue's storage is copy-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::wait(); - * - error codes returned by Semaphore::post(); - */ - - int push(const uint8_t priority, const T& value) - { - const internal::SemaphoreWaitFunctor semaphoreWaitFunctor; - return pushInternal(semaphoreWaitFunctor, priority, value); - } - - /** - * \brief Pushes the element to the queue. - * - * Similar to mq_send() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_send.html# - * - * \param [in] priority is the priority of new element - * \param [in] value is a rvalue reference to object that will be pushed, value in queue's storage is - * move-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::wait(); - * - error codes returned by Semaphore::post(); - */ - - int push(const uint8_t priority, T&& value) - { - const internal::SemaphoreWaitFunctor semaphoreWaitFunctor; - return pushInternal(semaphoreWaitFunctor, priority, std::move(value)); - } - -#if DISTORTOS_MESSAGEQUEUE_EMPLACE_SUPPORTED == 1 || DOXYGEN == 1 - - /** - * \brief Tries to emplace the element in the queue. - * - * Similar to mq_send() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_send.html# - * - * \note This function requires GCC 4.9. - * - * \tparam Args are types of arguments for constructor of T - * - * \param [in] priority is the priority of new element - * \param [in] args are arguments for constructor of T - * - * \return zero if element was emplaced successfully, error code otherwise: - * - error codes returned by Semaphore::tryWait(); - * - error codes returned by Semaphore::post(); - */ - - template<typename... Args> - int tryEmplace(const uint8_t priority, Args&&... args) - { - const internal::SemaphoreTryWaitFunctor semaphoreTryWaitFunctor; - return emplaceInternal(semaphoreTryWaitFunctor, priority, std::forward<Args>(args)...); - } - - /** - * \brief Tries to emplace the element in the queue for a given duration of time. - * - * Similar to mq_timedsend() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_send.html# - * - * \note This function requires GCC 4.9. - * - * \tparam Args are types of arguments for constructor of T - * - * \param [in] duration is the duration after which the wait will be terminated without emplacing the element - * \param [in] priority is the priority of new element - * \param [in] args are arguments for constructor of T - * - * \return zero if element was emplaced successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - template<typename... Args> - int tryEmplaceFor(const TickClock::duration duration, const uint8_t priority, Args&&... args) - { - const internal::SemaphoreTryWaitForFunctor semaphoreTryWaitForFunctor {duration}; - return emplaceInternal(semaphoreTryWaitForFunctor, priority, std::forward<Args>(args)...); - } - - /** - * \brief Tries to emplace the element in the queue for a given duration of time. - * - * Template variant of MessageQueue::tryEmplaceFor(TickClock::duration, uint8_t, Args&&...). - * - * \note This function requires GCC 4.9. - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * \tparam Args are types of arguments for constructor of T - * - * \param [in] duration is the duration after which the wait will be terminated without emplacing the element - * \param [in] priority is the priority of new element - * \param [in] args are arguments for constructor of T - * - * \return zero if element was emplaced successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Rep, typename Period, typename... Args> - int tryEmplaceFor(const std::chrono::duration<Rep, Period> duration, const uint8_t priority, Args&&... args) - { - return tryEmplaceFor(std::chrono::duration_cast<TickClock::duration>(duration), priority, - std::forward<Args>(args)...); - } - - /** - * \brief Tries to emplace the element in the queue until a given time point. - * - * Similar to mq_timedsend() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_send.html# - * - * \note This function requires GCC 4.9. - * - * \tparam Args are types of arguments for constructor of T - * - * \param [in] timePoint is the time point at which the call will be terminated without emplacing the element - * \param [in] priority is the priority of new element - * \param [in] args are arguments for constructor of T - * - * \return zero if element was emplaced successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - template<typename... Args> - int tryEmplaceUntil(const TickClock::time_point timePoint, const uint8_t priority, Args&&... args) - { - const internal::SemaphoreTryWaitUntilFunctor semaphoreTryWaitUntilFunctor {timePoint}; - return emplaceInternal(semaphoreTryWaitUntilFunctor, priority, std::forward<Args>(args)...); - } - - /** - * \brief Tries to emplace the element in the queue until a given time point. - * - * Template variant of FifoQueue::tryEmplaceUntil(TickClock::time_point, uint8_t, Args&&...). - * - * \note This function requires GCC 4.9. - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * \tparam Args are types of arguments for constructor of T - * - * \param [in] timePoint is the time point at which the call will be terminated without emplacing the element - * \param [in] priority is the priority of new element - * \param [in] args are arguments for constructor of T - * - * \return zero if element was emplaced successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Duration, typename... Args> - int tryEmplaceUntil(const std::chrono::time_point<TickClock, Duration> timePoint, const uint8_t priority, - Args&&... args) - { - return tryEmplaceUntil(std::chrono::time_point_cast<TickClock::duration>(timePoint), priority, - std::forward<Args>(args)...); - } - -#endif // DISTORTOS_MESSAGEQUEUE_EMPLACE_SUPPORTED == 1 || DOXYGEN == 1 - - /** - * \brief Tries to pop oldest element with highest priority from the queue. - * - * Similar to mq_receive() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_receive.html# - * - * \param [out] priority is a reference to variable that will be used to return priority of popped value - * \param [out] value is a reference to object that will be used to return popped value, its contents are swapped - * with the value in the queue's storage and destructed when no longer needed - * - * \return zero if element was popped successfully, error code otherwise: - * - error codes returned by Semaphore::tryWait(); - * - error codes returned by Semaphore::post(); - */ - - int tryPop(uint8_t& priority, T& value) - { - const internal::SemaphoreTryWaitFunctor semaphoreTryWaitFunctor; - return popInternal(semaphoreTryWaitFunctor, priority, value); - } - - /** - * \brief Tries to pop oldest element with highest priority from the queue for a given duration of time. - * - * Similar to mq_timedreceive() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_receive.html# - * - * \param [in] duration is the duration after which the call will be terminated without popping the element - * \param [out] priority is a reference to variable that will be used to return priority of popped value - * \param [out] value is a reference to object that will be used to return popped value, its contents are swapped - * with the value in the queue's storage and destructed when no longer needed - * - * \return zero if element was popped successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - int tryPopFor(const TickClock::duration duration, uint8_t& priority, T& value) - { - const internal::SemaphoreTryWaitForFunctor semaphoreTryWaitForFunctor {duration}; - return popInternal(semaphoreTryWaitForFunctor, priority, value); - } - - /** - * \brief Tries to pop oldest element with highest priority from the queue for a given duration of time. - * - * Template variant of tryPopFor(TickClock::duration, uint8_t&, T&). - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * - * \param [in] duration is the duration after which the call will be terminated without popping the element - * \param [out] priority is a reference to variable that will be used to return priority of popped value - * \param [out] value is a reference to object that will be used to return popped value, its contents are swapped - * with the value in the queue's storage and destructed when no longer needed - * - * \return zero if element was popped successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Rep, typename Period> - int tryPopFor(const std::chrono::duration<Rep, Period> duration, uint8_t& priority, T& value) - { - return tryPopFor(std::chrono::duration_cast<TickClock::duration>(duration), priority, value); - } - - /** - * \brief Tries to pop oldest element with highest priority from the queue until a given time point. - * - * Similar to mq_timedreceive() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_receive.html# - * - * \param [in] timePoint is the time point at which the call will be terminated without popping the element - * \param [out] priority is a reference to variable that will be used to return priority of popped value - * \param [out] value is a reference to object that will be used to return popped value, its contents are swapped - * with the value in the queue's storage and destructed when no longer needed - * - * \return zero if element was popped successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - int tryPopUntil(const TickClock::time_point timePoint, uint8_t& priority, T& value) - { - const internal::SemaphoreTryWaitUntilFunctor semaphoreTryWaitUntilFunctor {timePoint}; - return popInternal(semaphoreTryWaitUntilFunctor, priority, value); - } - - /** - * \brief Tries to pop oldest element with highest priority from the queue until a given time point. - * - * Template variant of tryPopUntil(TickClock::time_point, uint8_t&, T&). - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * - * \param [in] timePoint is the time point at which the call will be terminated without popping the element - * \param [out] priority is a reference to variable that will be used to return priority of popped value - * \param [out] value is a reference to object that will be used to return popped value, its contents are swapped - * with the value in the queue's storage and destructed when no longer needed - * - * \return zero if element was popped successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Duration> - int tryPopUntil(const std::chrono::time_point<TickClock, Duration> timePoint, uint8_t& priority, T& value) - { - return tryPopUntil(std::chrono::time_point_cast<TickClock::duration>(timePoint), priority, value); - } - - /** - * \brief Tries to push the element to the queue. - * - * Similar to mq_send() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_send.html# - * - * \param [in] priority is the priority of new element - * \param [in] value is a reference to object that will be pushed, value in queue's storage is copy-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::tryWait(); - * - error codes returned by Semaphore::post(); - */ - - int tryPush(const uint8_t priority, const T& value) - { - const internal::SemaphoreTryWaitFunctor semaphoreTryWaitFunctor; - return pushInternal(semaphoreTryWaitFunctor, priority, value); - } - - /** - * \brief Tries to push the element to the queue. - * - * Similar to mq_send() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_send.html# - * - * \param [in] priority is the priority of new element - * \param [in] value is a rvalue reference to object that will be pushed, value in queue's storage is - * move-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::tryWait(); - * - error codes returned by Semaphore::post(); - */ - - int tryPush(const uint8_t priority, T&& value) - { - const internal::SemaphoreTryWaitFunctor semaphoreTryWaitFunctor; - return pushInternal(semaphoreTryWaitFunctor, priority, std::move(value)); - } - - /** - * \brief Tries to push the element to the queue for a given duration of time. - * - * Similar to mq_timedsend() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_send.html# - * - * \param [in] duration is the duration after which the wait will be terminated without pushing the element - * \param [in] priority is the priority of new element - * \param [in] value is a reference to object that will be pushed, value in queue's storage is copy-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - int tryPushFor(const TickClock::duration duration, const uint8_t priority, const T& value) - { - const internal::SemaphoreTryWaitForFunctor semaphoreTryWaitForFunctor {duration}; - return pushInternal(semaphoreTryWaitForFunctor, priority, value); - } - - /** - * \brief Tries to push the element to the queue for a given duration of time. - * - * Template variant of tryPushFor(TickClock::duration, uint8_t, const T&). - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * - * \param [in] duration is the duration after which the wait will be terminated without pushing the element - * \param [in] priority is the priority of new element - * \param [in] value is a reference to object that will be pushed, value in queue's storage is copy-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Rep, typename Period> - int tryPushFor(const std::chrono::duration<Rep, Period> duration, const uint8_t priority, const T& value) - { - return tryPushFor(std::chrono::duration_cast<TickClock::duration>(duration), priority, value); - } - - /** - * \brief Tries to push the element to the queue for a given duration of time. - * - * Similar to mq_timedsend() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_send.html# - * - * \param [in] duration is the duration after which the wait will be terminated without pushing the element - * \param [in] priority is the priority of new element - * \param [in] value is a rvalue reference to object that will be pushed, value in queue's storage is - * move-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - int tryPushFor(const TickClock::duration duration, const uint8_t priority, T&& value) - { - const internal::SemaphoreTryWaitForFunctor semaphoreTryWaitForFunctor {duration}; - return pushInternal(semaphoreTryWaitForFunctor, priority, std::move(value)); - } - - /** - * \brief Tries to push the element to the queue for a given duration of time. - * - * Template variant of tryPushFor(TickClock::duration, uint8_t, T&&). - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * - * \param [in] duration is the duration after which the call will be terminated without pushing the element - * \param [in] priority is the priority of new element - * \param [in] value is a rvalue reference to object that will be pushed, value in queue's storage is - * move-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Rep, typename Period> - int tryPushFor(const std::chrono::duration<Rep, Period> duration, const uint8_t priority, T&& value) - { - return tryPushFor(std::chrono::duration_cast<TickClock::duration>(duration), priority, std::move(value)); - } - - /** - * \brief Tries to push the element to the queue until a given time point. - * - * Similar to mq_timedsend() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_send.html# - * - * \param [in] timePoint is the time point at which the call will be terminated without pushing the element - * \param [in] priority is the priority of new element - * \param [in] value is a reference to object that will be pushed, value in queue's storage is copy-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - int tryPushUntil(const TickClock::time_point timePoint, const uint8_t priority, const T& value) - { - const internal::SemaphoreTryWaitUntilFunctor semaphoreTryWaitUntilFunctor {timePoint}; - return pushInternal(semaphoreTryWaitUntilFunctor, priority, value); - } - - /** - * \brief Tries to push the element to the queue until a given time point. - * - * Template variant of tryPushUntil(TickClock::time_point, uint8_t, const T&). - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * - * \param [in] timePoint is the time point at which the call will be terminated without pushing the element - * \param [in] priority is the priority of new element - * \param [in] value is a reference to object that will be pushed, value in queue's storage is copy-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Duration> - int tryPushUntil(const std::chrono::time_point<TickClock, Duration> timePoint, const uint8_t priority, - const T& value) - { - return tryPushUntil(std::chrono::time_point_cast<TickClock::duration>(timePoint), priority, value); - } - - /** - * \brief Tries to push the element to the queue until a given time point. - * - * Similar to mq_timedsend() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_send.html# - * - * \param [in] timePoint is the time point at which the call will be terminated without pushing the element - * \param [in] priority is the priority of new element - * \param [in] value is a rvalue reference to object that will be pushed, value in queue's storage is - * move-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - int tryPushUntil(const TickClock::time_point timePoint, const uint8_t priority, T&& value) - { - const internal::SemaphoreTryWaitUntilFunctor semaphoreTryWaitUntilFunctor {timePoint}; - return pushInternal(semaphoreTryWaitUntilFunctor, priority, std::move(value)); - } - - /** - * \brief Tries to push the element to the queue until a given time point. - * - * Template variant of tryPushUntil(TickClock::time_point, uint8_t, T&&). - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * - * \param [in] timePoint is the time point at which the call will be terminated without pushing the element - * \param [in] priority is the priority of new element - * \param [in] value is a rvalue reference to object that will be pushed, value in queue's storage is - * move-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Duration> - int tryPushUntil(const std::chrono::time_point<TickClock, Duration> timePoint, const uint8_t priority, T&& value) - { - return tryPushUntil(std::chrono::time_point_cast<TickClock::duration>(timePoint), priority, std::move(value)); - } - -private: - -#if DISTORTOS_MESSAGEQUEUE_EMPLACE_SUPPORTED == 1 || DOXYGEN == 1 - - /** - * \brief Emplaces the element in the queue. - * - * Internal version - builds the Functor object. - * - * \note This function requires GCC 4.9. - * - * \tparam Args are types of arguments for constructor of T - * - * \param [in] waitSemaphoreFunctor is a reference to SemaphoreFunctor which will be executed with \a pushSemaphore_ - * \param [in] priority is the priority of new element - * \param [in] args are arguments for constructor of T - * - * \return zero if element was emplaced successfully, error code otherwise: - * - error codes returned by \a waitSemaphoreFunctor's operator() call; - * - error codes returned by Semaphore::post(); - */ - - template<typename... Args> - int emplaceInternal(const internal::SemaphoreFunctor& waitSemaphoreFunctor, uint8_t priority, Args&&... args); - -#endif // DISTORTOS_MESSAGEQUEUE_EMPLACE_SUPPORTED == 1 || DOXYGEN == 1 - - /** - * \brief Pops oldest element with highest priority from the queue. - * - * Internal version - builds the Functor object. - * - * \param [in] waitSemaphoreFunctor is a reference to SemaphoreFunctor which will be executed with \a popSemaphore_ - * \param [out] priority is a reference to variable that will be used to return priority of popped value - * \param [out] value is a reference to object that will be used to return popped value, its contents are swapped - * with the value in the queue's storage and destructed when no longer needed - * - * \return zero if element was popped successfully, error code otherwise: - * - error codes returned by \a waitSemaphoreFunctor's operator() call; - * - error codes returned by Semaphore::post(); - */ - - int popInternal(const internal::SemaphoreFunctor& waitSemaphoreFunctor, uint8_t& priority, T& value); - - /** - * \brief Pushes the element to the queue. - * - * Internal version - builds the Functor object. - * - * \param [in] waitSemaphoreFunctor is a reference to SemaphoreFunctor which will be executed with \a pushSemaphore_ - * \param [in] priority is the priority of new element - * \param [in] value is a reference to object that will be pushed, value in queue's storage is copy-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by \a waitSemaphoreFunctor's operator() call; - * - error codes returned by Semaphore::post(); - */ - - int pushInternal(const internal::SemaphoreFunctor& waitSemaphoreFunctor, uint8_t priority, const T& value); - - /** - * \brief Pushes the element to the queue. - * - * Internal version - builds the Functor object. - * - * \param [in] waitSemaphoreFunctor is a reference to SemaphoreFunctor which will be executed with \a pushSemaphore_ - * \param [in] priority is the priority of new element - * \param [in] value is a rvalue reference to object that will be pushed, value in queue's storage is - * move-constructed - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by \a waitSemaphoreFunctor's operator() call; - * - error codes returned by Semaphore::post(); - */ - - int pushInternal(const internal::SemaphoreFunctor& waitSemaphoreFunctor, uint8_t priority, T&& value); - - /// contained internal::MessageQueueBase object which implements whole functionality - internal::MessageQueueBase messageQueueBase_; -}; - -template<typename T> -MessageQueue<T>::~MessageQueue() -{ - uint8_t priority; - T value; - while (tryPop(priority, value) == 0); -} - -#if DISTORTOS_MESSAGEQUEUE_EMPLACE_SUPPORTED == 1 || DOXYGEN == 1 - -template<typename T> -template<typename... Args> -int MessageQueue<T>::emplaceInternal(const internal::SemaphoreFunctor& waitSemaphoreFunctor, const uint8_t priority, - Args&&... args) -{ - const auto emplaceFunctor = internal::makeBoundQueueFunctor( - [&args...](void* const storage) - { - new (storage) T{std::forward<Args>(args)...}; - }); - return messageQueueBase_.push(waitSemaphoreFunctor, priority, emplaceFunctor); -} - -#endif // DISTORTOS_MESSAGEQUEUE_EMPLACE_SUPPORTED == 1 || DOXYGEN == 1 - -template<typename T> -int MessageQueue<T>::popInternal(const internal::SemaphoreFunctor& waitSemaphoreFunctor, uint8_t& priority, T& value) -{ - const internal::SwapPopQueueFunctor<T> swapPopQueueFunctor {value}; - return messageQueueBase_.pop(waitSemaphoreFunctor, priority, swapPopQueueFunctor); -} - -template<typename T> -int MessageQueue<T>::pushInternal(const internal::SemaphoreFunctor& waitSemaphoreFunctor, const uint8_t priority, - const T& value) -{ - const internal::CopyConstructQueueFunctor<T> copyConstructQueueFunctor {value}; - return messageQueueBase_.push(waitSemaphoreFunctor, priority, copyConstructQueueFunctor); -} - -template<typename T> -int MessageQueue<T>::pushInternal(const internal::SemaphoreFunctor& waitSemaphoreFunctor, const uint8_t priority, - T&& value) -{ - const internal::MoveConstructQueueFunctor<T> moveConstructQueueFunctor {std::move(value)}; - return messageQueueBase_.push(waitSemaphoreFunctor, priority, moveConstructQueueFunctor); -} - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_MESSAGEQUEUE_HPP_ diff --git a/include/distortos/Mutex.hpp b/include/distortos/Mutex.hpp deleted file mode 100644 index 481700d..0000000 --- a/include/distortos/Mutex.hpp +++ /dev/null @@ -1,280 +0,0 @@ -/** - * \file - * \brief Mutex class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_MUTEX_HPP_ -#define INCLUDE_DISTORTOS_MUTEX_HPP_ - -#include "distortos/internal/synchronization/MutexControlBlock.hpp" - -namespace distortos -{ - -/** - * \brief Mutex is the basic synchronization primitive - * - * Similar to std::mutex - http://en.cppreference.com/w/cpp/thread/mutex - * Similar to POSIX pthread_mutex_t - - * http://pubs.opengroup.org/onlinepubs/9699919799/functions/V2_chap02.html#tag_15_09 -> 2.9.3 Thread Mutexes - * - * \ingroup synchronization - */ - -class Mutex -{ -public: - - /// mutex protocols - using Protocol = internal::MutexControlBlock::Protocol; - - /// type used for counting recursive locks - using RecursiveLocksCount = uint16_t; - - /// type of mutex - enum class Type : uint8_t - { - /// normal mutex, similar to PTHREAD_MUTEX_NORMAL - normal, - /// mutex with additional error checking, similar to PTHREAD_MUTEX_ERRORCHECK - errorChecking, - /// recursive mutex, similar to PTHREAD_MUTEX_RECURSIVE - recursive - }; - - /** - * \brief Gets the maximum number of recursive locks possible before returning EAGAIN - * - * \note Actual number of lock() operations possible is getMaxRecursiveLocks() + 1. - * - * \return maximum number of recursive locks possible before returning EAGAIN - */ - - constexpr static RecursiveLocksCount getMaxRecursiveLocks() - { - return std::numeric_limits<RecursiveLocksCount>::max(); - } - - /** - * \brief Mutex constructor - * - * Similar to std::mutex::mutex() - http://en.cppreference.com/w/cpp/thread/mutex/mutex - * Similar to pthread_mutex_init() - - * http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_mutex_init.html - * - * \param [in] type is the type of mutex, default - Type::normal - * \param [in] protocol is the mutex protocol, default - Protocol::none - * \param [in] priorityCeiling is the priority ceiling of mutex, ignored when protocol != Protocol::priorityProtect, - * default - 0 - */ - - constexpr explicit Mutex(const Type type = Type::normal, const Protocol protocol = Protocol::none, - const uint8_t priorityCeiling = {}) : - controlBlock_{protocol, priorityCeiling}, - recursiveLocksCount_{}, - type_{type} - { - - } - - /** - * \brief Locks the mutex. - * - * Similar to std::mutex::lock() - http://en.cppreference.com/w/cpp/thread/mutex/lock - * Similar to pthread_mutex_lock() - - * http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_mutex_lock.html# - * - * If the mutex is already locked by another thread, the calling thread shall block until the mutex becomes - * available. This function shall return with the mutex in the locked state with the calling thread as its owner. If - * a thread attempts to relock a mutex that it has already locked, deadlock occurs. - * - * \return zero if the caller successfully locked the mutex, error code otherwise: - * - EAGAIN - the mutex could not be acquired because the maximum number of recursive locks for mutex has been - * exceeded; - * - EDEADLK - the mutex type is ErrorChecking and the current thread already owns the mutex; - * - EINVAL - the mutex was created with the protocol attribute having the value PriorityProtect and the calling - * thread's priority is higher than the mutex's current priority ceiling; - */ - - int lock(); - - /** - * \brief Tries to lock the mutex. - * - * Similar to std::mutex::try_lock() - http://en.cppreference.com/w/cpp/thread/mutex/try_lock - * Similar to pthread_mutex_trylock() - - * http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_mutex_lock.html# - * - * This function shall be equivalent to lock(), except that if the mutex is currently locked (by any thread, - * including the current thread), the call shall return immediately. - * - * \return zero if the caller successfully locked the mutex, error code otherwise: - * - EAGAIN - the mutex could not be acquired because the maximum number of recursive locks for mutex has been - * exceeded; - * - EBUSY - the mutex could not be acquired because it was already locked; - * - EINVAL - the mutex was created with the protocol attribute having the value PriorityProtect and the calling - * thread's priority is higher than the mutex's current priority ceiling; - */ - - int tryLock(); - - /** - * \brief Tries to lock the mutex for given duration of time. - * - * Similar to std::timed_mutex::try_lock_for() - http://en.cppreference.com/w/cpp/thread/timed_mutex/try_lock_for - * Similar to pthread_mutex_timedlock() - - * http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_mutex_timedlock.html# - * - * If the mutex is already locked, the calling thread shall block until the mutex becomes available as in lock() - * function. If the mutex cannot be locked without waiting for another thread to unlock the mutex, this wait shall - * be terminated when the specified timeout expires. - * - * Under no circumstance shall the function fail with a timeout if the mutex can be locked immediately. The validity - * of the duration parameter need not be checked if the mutex can be locked immediately. - * - * \param [in] duration is the duration after which the wait will be terminated without locking the mutex - * - * \return zero if the caller successfully locked the mutex, error code otherwise: - * - EAGAIN - the mutex could not be acquired because the maximum number of recursive locks for mutex has been - * exceeded; - * - EDEADLK - the mutex type is ErrorChecking and the current thread already owns the mutex; - * - EINVAL - the mutex was created with the protocol attribute having the value PriorityProtect and the calling - * thread's priority is higher than the mutex's current priority ceiling; - * - ETIMEDOUT - the mutex could not be locked before the specified timeout expired; - */ - - int tryLockFor(TickClock::duration duration); - - /** - * Tries to lock the mutex for given duration of time. - * - * Template variant of tryLockFor(TickClock::duration duration). - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * - * \param [in] duration is the duration after which the wait will be terminated without locking the mutex - * - * \return zero if the caller successfully locked the mutex, error code otherwise: - * - EAGAIN - the mutex could not be acquired because the maximum number of recursive locks for mutex has been - * exceeded; - * - EDEADLK - the mutex type is ErrorChecking and the current thread already owns the mutex; - * - EINVAL - the mutex was created with the protocol attribute having the value PriorityProtect and the calling - * thread's priority is higher than the mutex's current priority ceiling; - * - ETIMEDOUT - the mutex could not be locked before the specified timeout expired; - */ - - template<typename Rep, typename Period> - int tryLockFor(const std::chrono::duration<Rep, Period> duration) - { - return tryLockFor(std::chrono::duration_cast<TickClock::duration>(duration)); - } - - /** - * \brief Tries to lock the mutex until given time point. - * - * Similar to std::timed_mutex::try_lock_until() - - * http://en.cppreference.com/w/cpp/thread/timed_mutex/try_lock_until - * Similar to pthread_mutex_timedlock() - - * http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_mutex_timedlock.html# - * - * If the mutex is already locked, the calling thread shall block until the mutex becomes available as in lock() - * function. If the mutex cannot be locked without waiting for another thread to unlock the mutex, this wait shall - * be terminated when the specified timeout expires. - * - * Under no circumstance shall the function fail with a timeout if the mutex can be locked immediately. The validity - * of the timePoint parameter need not be checked if the mutex can be locked immediately. - * - * \param [in] timePoint is the time point at which the wait will be terminated without locking the mutex - * - * \return zero if the caller successfully locked the mutex, error code otherwise: - * - EAGAIN - the mutex could not be acquired because the maximum number of recursive locks for mutex has been - * exceeded; - * - EDEADLK - the mutex type is ErrorChecking and the current thread already owns the mutex; - * - EINVAL - the mutex was created with the protocol attribute having the value PriorityProtect and the calling - * thread's priority is higher than the mutex's current priority ceiling; - * - ETIMEDOUT - the mutex could not be locked before the specified timeout expired; - */ - - int tryLockUntil(TickClock::time_point timePoint); - - /** - * \brief Tries to lock the mutex until given time point. - * - * Template variant of tryLockUntil(TickClock::time_point timePoint). - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * - * \param [in] timePoint is the time point at which the wait will be terminated without locking the mutex - * - * \return zero if the caller successfully locked the mutex, error code otherwise: - * - EAGAIN - the mutex could not be acquired because the maximum number of recursive locks for mutex has been - * exceeded; - * - EDEADLK - the mutex type is ErrorChecking and the current thread already owns the mutex; - * - EINVAL - the mutex was created with the protocol attribute having the value PriorityProtect and the calling - * thread's priority is higher than the mutex's current priority ceiling; - * - ETIMEDOUT - the mutex could not be locked before the specified timeout expired; - */ - - template<typename Duration> - int tryLockUntil(const std::chrono::time_point<TickClock, Duration> timePoint) - { - return tryLockUntil(std::chrono::time_point_cast<TickClock::duration>(timePoint)); - } - - /** - * \brief Unlocks the mutex. - * - * Similar to std::mutex::unlock() - http://en.cppreference.com/w/cpp/thread/mutex/unlock - * Similar to pthread_mutex_unlock() - - * http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_mutex_lock.html# - * - * The mutex must be locked by the current thread, otherwise, the behavior is undefined. If there are threads - * blocked on this mutex, the highest priority waiting thread shall be unblocked, and if there is more than one - * highest priority thread blocked waiting, then the highest priority thread that has been waiting the longest shall - * be unblocked. - * - * \return zero if the caller successfully unlocked the mutex, error code otherwise: - * - EPERM - the mutex type is ErrorChecking or Recursive, and the current thread does not own the mutex; - */ - - int unlock(); - -private: - - /** - * \brief Internal version of tryLock(). - * - * Internal version with no interrupt masking and additional code for ErrorChecking type (which is not required for - * tryLock()). - * - * \return zero if the caller successfully locked the mutex, error code otherwise: - * - EAGAIN - the mutex could not be acquired because the maximum number of recursive locks for mutex has been - * exceeded; - * - EBUSY - the mutex could not be acquired because it was already locked; - * - EDEADLK - the mutex type is ErrorChecking and the current thread already owns the mutex; - * - EINVAL - the mutex was created with the protocol attribute having the value PriorityProtect and the calling - * thread's priority is higher than the mutex's current priority ceiling; - */ - - int tryLockInternal(); - - /// instance of control block - internal::MutexControlBlock controlBlock_; - - /// number of recursive locks, used when mutex type is Recursive - RecursiveLocksCount recursiveLocksCount_; - - /// type of mutex - Type type_; -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_MUTEX_HPP_ diff --git a/include/distortos/OnceFlag.hpp b/include/distortos/OnceFlag.hpp deleted file mode 100644 index 0ac6185..0000000 --- a/include/distortos/OnceFlag.hpp +++ /dev/null @@ -1,60 +0,0 @@ -/** - * \file - * \brief OnceFlag class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_ONCEFLAG_HPP_ -#define INCLUDE_DISTORTOS_ONCEFLAG_HPP_ - -#include "distortos/internal/synchronization/CallOnceControlBlock.hpp" - -#if DISTORTOS_CALLONCE_SUPPORTED == 1 || DOXYGEN == 1 - -namespace distortos -{ - -/** - * \brief OnceFlag is a helper class for callOnce(). - * - * Similar to std::once_flag - http://en.cppreference.com/w/cpp/thread/once_flag - * Similar to POSIX pthread_once_t - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_once.html# - * - * \note This class requires GCC 4.9. - * - * \ingroup synchronization - */ - -class OnceFlag -{ - template<typename Function, typename... Args> - friend void callOnce(OnceFlag& onceFlag, Function&& function, Args&&... args); - -public: - - /** - * \brief OnceFlag's constructor - */ - - constexpr OnceFlag() : - callOnceControlBlock_{} - { - - } - -private: - - /// internal internal::CallOnceControlBlock object used by callOnce() - internal::CallOnceControlBlock callOnceControlBlock_; -}; - -} // namespace distortos - -#endif // DISTORTOS_CALLONCE_SUPPORTED == 1 || DOXYGEN == 1 - -#endif // INCLUDE_DISTORTOS_ONCEFLAG_HPP_ diff --git a/include/distortos/RawFifoQueue.hpp b/include/distortos/RawFifoQueue.hpp deleted file mode 100644 index 94456a7..0000000 --- a/include/distortos/RawFifoQueue.hpp +++ /dev/null @@ -1,463 +0,0 @@ -/** - * \file - * \brief RawFifoQueue class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_RAWFIFOQUEUE_HPP_ -#define INCLUDE_DISTORTOS_RAWFIFOQUEUE_HPP_ - -#include "distortos/internal/synchronization/FifoQueueBase.hpp" - -namespace distortos -{ - -/** - * \brief RawFifoQueue class is very similar to FifoQueue, but optimized for binary serializable types (like POD types). - * - * Type \a T can be used with both RawFifoQueue and FifoQueue only when - * <em>std::is_trivially_copyable<T>::value == true</em>, otherwise only FifoQueue use is safe, while using RawFifoQueue - * results in undefined behavior. - * - * \ingroup queues - */ - -class RawFifoQueue -{ -public: - - /// unique_ptr (with deleter) to storage - using StorageUniquePointer = internal::FifoQueueBase::StorageUniquePointer; - - /** - * \brief RawFifoQueue's constructor - * - * \param [in] storageUniquePointer is a rvalue reference to StorageUniquePointer with storage for queue elements - * (sufficiently large for \a maxElements, each \a elementSize bytes long) and appropriate deleter - * \param [in] elementSize is the size of single queue element, bytes - * \param [in] maxElements is the number of elements in storage memory block - */ - - RawFifoQueue(StorageUniquePointer&& storageUniquePointer, size_t elementSize, size_t maxElements); - - /** - * \brief Pops the oldest (first) element from the queue. - * - * \param [out] buffer is a pointer to buffer for popped element - * \param [in] size is the size of \a buffer, bytes - must be equal to the \a elementSize attribute of RawFifoQueue - * - * \return zero if element was popped successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawFifoQueue; - * - error codes returned by Semaphore::wait(); - * - error codes returned by Semaphore::post(); - */ - - int pop(void* buffer, size_t size); - - /** - * \brief Pops the oldest (first) element from the queue. - * - * \tparam T is the type of data popped from the queue - * - * \param [out] buffer is a reference to object that will be used to return popped value - * - * \return zero if element was popped successfully, error code otherwise: - * - EMSGSIZE - sizeof(T) doesn't match the \a elementSize attribute of RawFifoQueue; - * - error codes returned by Semaphore::wait(); - * - error codes returned by Semaphore::post(); - */ - - template<typename T> - int pop(T& buffer) - { - return pop(&buffer, sizeof(buffer)); - } - - /** - * \brief Pushes the element to the queue. - * - * \param [in] data is a pointer to data that will be pushed to RawFifoQueue - * \param [in] size is the size of \a data, bytes - must be equal to the \a elementSize attribute of RawFifoQueue - * - * \return zero if element was pushed successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawFifoQueue; - * - error codes returned by Semaphore::wait(); - * - error codes returned by Semaphore::post(); - */ - - int push(const void* data, size_t size); - - /** - * \brief Pushes the element to the queue. - * - * \tparam T is the type of data pushed to the queue - * - * \param [in] data is a reference to data that will be pushed to RawFifoQueue - * - * \return zero if element was pushed successfully, error code otherwise: - * - EMSGSIZE - sizeof(T) doesn't match the \a elementSize attribute of RawFifoQueue; - * - error codes returned by Semaphore::wait(); - * - error codes returned by Semaphore::post(); - */ - - template<typename T> - int push(const T& data) - { - return push(&data, sizeof(data)); - } - - /** - * \brief Tries to pop the oldest (first) element from the queue. - * - * \param [out] buffer is a pointer to buffer for popped element - * \param [in] size is the size of \a buffer, bytes - must be equal to the \a elementSize attribute of RawFifoQueue - * - * \return zero if element was popped successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawFifoQueue; - * - error codes returned by Semaphore::tryWait(); - * - error codes returned by Semaphore::post(); - */ - - int tryPop(void* buffer, size_t size); - - /** - * \brief Tries to pop the oldest (first) element from the queue. - * - * \tparam T is the type of data popped from the queue - * - * \param [out] buffer is a reference to object that will be used to return popped value - * - * \return zero if element was popped successfully, error code otherwise: - * - EMSGSIZE - sizeof(T) doesn't match the \a elementSize attribute of RawFifoQueue; - * - error codes returned by Semaphore::tryWait(); - * - error codes returned by Semaphore::post(); - */ - - template<typename T> - int tryPop(T& buffer) - { - return tryPop(&buffer, sizeof(buffer)); - } - - /** - * \brief Tries to pop the oldest (first) element from the queue for a given duration of time. - * - * \param [in] duration is the duration after which the call will be terminated without popping the element - * \param [out] buffer is a pointer to buffer for popped element - * \param [in] size is the size of \a buffer, bytes - must be equal to the \a elementSize attribute of RawFifoQueue - * - * \return zero if element was popped successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawFifoQueue; - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - int tryPopFor(TickClock::duration duration, void* buffer, size_t size); - - /** - * \brief Tries to pop the oldest (first) element from the queue for a given duration of time. - * - * Template variant of tryPopFor(TickClock::duration, void*, size_t). - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * - * \param [in] duration is the duration after which the call will be terminated without popping the element - * \param [out] buffer is a pointer to buffer for popped element - * \param [in] size is the size of \a buffer, bytes - must be equal to the \a elementSize attribute of RawFifoQueue - * - * \return zero if element was popped successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawFifoQueue; - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Rep, typename Period> - int tryPopFor(const std::chrono::duration<Rep, Period> duration, void* const buffer, const size_t size) - { - return tryPopFor(std::chrono::duration_cast<TickClock::duration>(duration), buffer, size); - } - - /** - * \brief Tries to pop the oldest (first) element from the queue for a given duration of time. - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * \tparam T is the type of data popped from the queue - * - * \param [in] duration is the duration after which the call will be terminated without popping the element - * \param [out] buffer is a reference to object that will be used to return popped value - * - * \return zero if element was popped successfully, error code otherwise: - * - EMSGSIZE - sizeof(T) doesn't match the \a elementSize attribute of RawFifoQueue; - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Rep, typename Period, typename T> - int tryPopFor(const std::chrono::duration<Rep, Period> duration, T& buffer) - { - return tryPopFor(std::chrono::duration_cast<TickClock::duration>(duration), &buffer, sizeof(buffer)); - } - - /** - * \brief Tries to pop the oldest (first) element from the queue until a given time point. - * - * \param [in] timePoint is the time point at which the call will be terminated without popping the element - * \param [out] buffer is a pointer to buffer for popped element - * \param [in] size is the size of \a buffer, bytes - must be equal to the \a elementSize attribute of RawFifoQueue - * - * \return zero if element was popped successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawFifoQueue; - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - int tryPopUntil(TickClock::time_point timePoint, void* buffer, size_t size); - - /** - * \brief Tries to pop the oldest (first) element from the queue until a given time point. - * - * Template variant of tryPopUntil(TickClock::time_point, void*, size_t). - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * - * \param [in] timePoint is the time point at which the call will be terminated without popping the element - * \param [out] buffer is a pointer to buffer for popped element - * \param [in] size is the size of \a buffer, bytes - must be equal to the \a elementSize attribute of RawFifoQueue - * - * \return zero if element was popped successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawFifoQueue; - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Duration> - int tryPopUntil(const std::chrono::time_point<TickClock, Duration> timePoint, void* const buffer, const size_t size) - { - return tryPopUntil(std::chrono::time_point_cast<TickClock::duration>(timePoint), buffer, size); - } - - /** - * \brief Tries to pop the oldest (first) element from the queue until a given time point. - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * \tparam T is the type of data popped from the queue - * - * \param [in] timePoint is the time point at which the call will be terminated without popping the element - * \param [out] buffer is a reference to object that will be used to return popped value - * - * \return zero if element was popped successfully, error code otherwise: - * - EMSGSIZE - sizeof(T) doesn't match the \a elementSize attribute of RawFifoQueue; - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Duration, typename T> - int tryPopUntil(const std::chrono::time_point<TickClock, Duration> timePoint, T& buffer) - { - return tryPopUntil(std::chrono::time_point_cast<TickClock::duration>(timePoint), &buffer, sizeof(buffer)); - } - - /** - * \brief Tries to push the element to the queue. - * - * \param [in] data is a pointer to data that will be pushed to RawFifoQueue - * \param [in] size is the size of \a data, bytes - must be equal to the \a elementSize attribute of RawFifoQueue - * - * \return zero if element was pushed successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawFifoQueue; - * - error codes returned by Semaphore::tryWait(); - * - error codes returned by Semaphore::post(); - */ - - int tryPush(const void* data, size_t size); - - /** - * \brief Tries to push the element to the queue. - * - * \tparam T is the type of data pushed to the queue - * - * \param [in] data is a reference to data that will be pushed to RawFifoQueue - * - * \return zero if element was pushed successfully, error code otherwise: - * - EMSGSIZE - sizeof(T) doesn't match the \a elementSize attribute of RawFifoQueue; - * - error codes returned by Semaphore::tryWait(); - * - error codes returned by Semaphore::post(); - */ - - template<typename T> - int tryPush(const T& data) - { - return tryPush(&data, sizeof(data)); - } - - /** - * \brief Tries to push the element to the queue for a given duration of time. - * - * \param [in] duration is the duration after which the wait will be terminated without pushing the element - * \param [in] data is a pointer to data that will be pushed to RawFifoQueue - * \param [in] size is the size of \a data, bytes - must be equal to the \a elementSize attribute of RawFifoQueue - * - * \return zero if element was pushed successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawFifoQueue; - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - int tryPushFor(TickClock::duration duration, const void* data, size_t size); - - /** - * \brief Tries to push the element to the queue for a given duration of time. - * - * Template variant of tryPushFor(TickClock::duration, const void*, size_t). - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * - * \param [in] duration is the duration after which the wait will be terminated without pushing the element - * \param [in] data is a pointer to data that will be pushed to RawFifoQueue - * \param [in] size is the size of \a data, bytes - must be equal to the \a elementSize attribute of RawFifoQueue - * - * \return zero if element was pushed successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawFifoQueue; - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Rep, typename Period> - int tryPushFor(const std::chrono::duration<Rep, Period> duration, const void* const data, const size_t size) - { - return tryPushFor(std::chrono::duration_cast<TickClock::duration>(duration), data, size); - } - - /** - * \brief Tries to push the element to the queue for a given duration of time. - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * \tparam T is the type of data pushed to the queue - * - * \param [in] duration is the duration after which the wait will be terminated without pushing the element - * \param [in] data is a reference to data that will be pushed to RawFifoQueue - * - * \return zero if element was pushed successfully, error code otherwise: - * - EMSGSIZE - sizeof(T) doesn't match the \a elementSize attribute of RawFifoQueue; - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Rep, typename Period, typename T> - int tryPushFor(const std::chrono::duration<Rep, Period> duration, const T& data) - { - return tryPushFor(std::chrono::duration_cast<TickClock::duration>(duration), &data, sizeof(data)); - } - - /** - * \brief Tries to push the element to the queue until a given time point. - * - * \param [in] timePoint is the time point at which the call will be terminated without pushing the element - * \param [in] data is a pointer to data that will be pushed to RawFifoQueue - * \param [in] size is the size of \a data, bytes - must be equal to the \a elementSize attribute of RawFifoQueue - * - * \return zero if element was pushed successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawFifoQueue; - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - int tryPushUntil(TickClock::time_point timePoint, const void* data, size_t size); - - /** - * \brief Tries to push the element to the queue until a given time point. - * - * Template variant of tryPushUntil(TickClock::time_point, const void*, size_t). - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * - * \param [in] timePoint is the time point at which the call will be terminated without pushing the element - * \param [in] data is a pointer to data that will be pushed to RawFifoQueue - * \param [in] size is the size of \a data, bytes - must be equal to the \a elementSize attribute of RawFifoQueue - * - * \return zero if element was pushed successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawFifoQueue; - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Duration> - int tryPushUntil(const std::chrono::time_point<TickClock, Duration> timePoint, const void* const data, - const size_t size) - { - return tryPushUntil(std::chrono::time_point_cast<TickClock::duration>(timePoint), data, size); - } - - /** - * \brief Tries to push the element to the queue until a given time point. - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * \tparam T is the type of data pushed to the queue - * - * \param [in] timePoint is the time point at which the call will be terminated without pushing the element - * \param [in] data is a reference to data that will be pushed to RawFifoQueue - * - * \return zero if element was pushed successfully, error code otherwise: - * - EMSGSIZE - sizeof(T) doesn't match the \a elementSize attribute of RawFifoQueue; - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Duration, typename T> - int tryPushUntil(const std::chrono::time_point<TickClock, Duration> timePoint, const T& data) - { - return tryPushUntil(std::chrono::time_point_cast<TickClock::duration>(timePoint), &data, sizeof(data)); - } - -private: - - /** - * \brief Pops the oldest (first) element from the queue. - * - * Internal version - builds the Functor object. - * - * \param [in] waitSemaphoreFunctor is a reference to SemaphoreFunctor which will be executed with \a popSemaphore_ - * \param [out] buffer is a pointer to buffer for popped element - * \param [in] size is the size of \a buffer, bytes - must be equal to the \a elementSize attribute of RawFifoQueue - * - * \return zero if element was popped successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawFifoQueue; - * - error codes returned by \a waitSemaphoreFunctor's operator() call; - * - error codes returned by Semaphore::post(); - */ - - int popInternal(const internal::SemaphoreFunctor& waitSemaphoreFunctor, void* buffer, size_t size); - - /** - * \brief Pushes the element to the queue. - * - * Internal version - builds the Functor object. - * - * \param [in] waitSemaphoreFunctor is a reference to SemaphoreFunctor which will be executed with \a pushSemaphore_ - * \param [in] data is a pointer to data that will be pushed to RawFifoQueue - * \param [in] size is the size of \a data, bytes - must be equal to the \a elementSize attribute of RawFifoQueue - * - * \return zero if element was pushed successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawFifoQueue; - * - error codes returned by \a waitSemaphoreFunctor's operator() call; - * - error codes returned by Semaphore::post(); - */ - - int pushInternal(const internal::SemaphoreFunctor& waitSemaphoreFunctor, const void* data, size_t size); - - /// contained internal::FifoQueueBase object which implements base functionality - internal::FifoQueueBase fifoQueueBase_; -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_RAWFIFOQUEUE_HPP_ diff --git a/include/distortos/RawMessageQueue.hpp b/include/distortos/RawMessageQueue.hpp deleted file mode 100644 index d4b2a54..0000000 --- a/include/distortos/RawMessageQueue.hpp +++ /dev/null @@ -1,555 +0,0 @@ -/** - * \file - * \brief RawMessageQueue class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_RAWMESSAGEQUEUE_HPP_ -#define INCLUDE_DISTORTOS_RAWMESSAGEQUEUE_HPP_ - -#include "distortos/internal/synchronization/MessageQueueBase.hpp" - -namespace distortos -{ - -/** - * \brief RawMessageQueue class is very similar to MessageQueue, but optimized for binary serializable types (like POD - * types). - * - * Type \a T can be used with both RawMessageQueue and MessageQueue only when - * <em>std::is_trivially_copyable<T>::value == true</em>, otherwise only MessageQueue use is safe, while using - * RawMessageQueue results in undefined behavior. - * - * Similar to POSIX mqd_t - http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/mqueue.h.html - * - * \ingroup queues - */ - -class RawMessageQueue -{ -public: - - /// type of uninitialized storage for Entry with link - using EntryStorage = internal::MessageQueueBase::EntryStorage; - - /// import EntryStorageUniquePointer type from internal::MessageQueueBase class - using EntryStorageUniquePointer = internal::MessageQueueBase::EntryStorageUniquePointer; - - /** - * type of uninitialized storage for value - * - * \tparam T is the type of data in queue - */ - - template<typename T> - using ValueStorage = internal::MessageQueueBase::ValueStorage<T>; - - using ValueStorageUniquePointer = internal::MessageQueueBase::ValueStorageUniquePointer; - - /** - * \brief RawMessageQueue's constructor - * - * \param [in] entryStorageUniquePointer is a rvalue reference to EntryStorageUniquePointer with storage for queue - * entries (sufficiently large for \a maxElements EntryStorage objects) and appropriate deleter - * \param [in] valueStorageUniquePointer is a rvalue reference to ValueStorageUniquePointer with storage for queue - * elements (sufficiently large for \a maxElements, each \a elementSize bytes long) and appropriate deleter - * \param [in] elementSize is the size of single queue element, bytes - * \param [in] maxElements is the number of elements in \a entryStorage array and \a valueStorage memory block - */ - - RawMessageQueue(EntryStorageUniquePointer&& entryStorageUniquePointer, - ValueStorageUniquePointer&& valueStorageUniquePointer, size_t elementSize, size_t maxElements); - - /** - * \brief Pops oldest element with highest priority from the queue. - * - * Similar to mq_receive() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_receive.html# - * - * \param [out] priority is a reference to variable that will be used to return priority of popped value - * \param [out] buffer is a pointer to buffer for popped element - * \param [in] size is the size of \a buffer, bytes - must be equal to the \a elementSize attribute of - * RawMessageQueue - * - * \return zero if element was popped successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawMessageQueue; - * - error codes returned by Semaphore::wait(); - * - error codes returned by Semaphore::post(); - */ - - int pop(uint8_t& priority, void* buffer, size_t size); - - /** - * \brief Pops oldest element with highest priority from the queue. - * - * Similar to mq_receive() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_receive.html# - * - * \tparam T is the type of data popped from the queue - * - * \param [out] priority is a reference to variable that will be used to return priority of popped value - * \param [out] buffer is a reference to object that will be used to return popped value - * - * \return zero if element was popped successfully, error code otherwise: - * - EMSGSIZE - sizeof(T) doesn't match the \a elementSize attribute of RawMessageQueue; - * - error codes returned by Semaphore::wait(); - * - error codes returned by Semaphore::post(); - */ - - template<typename T> - int pop(uint8_t& priority, T& buffer) - { - return pop(priority, &buffer, sizeof(buffer)); - } - - /** - * \brief Pushes the element to the queue. - * - * Similar to mq_send() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_send.html# - * - * \param [in] priority is the priority of new element - * \param [in] data is a pointer to data that will be pushed to RawMessageQueue - * \param [in] size is the size of \a data, bytes - must be equal to the \a elementSize attribute of RawMessageQueue - * - * \return zero if element was pushed successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawMessageQueue; - * - error codes returned by Semaphore::wait(); - * - error codes returned by Semaphore::post(); - */ - - int push(uint8_t priority, const void* data, size_t size); - - /** - * \brief Pushes the element to the queue. - * - * Similar to mq_send() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_send.html# - * - * \tparam T is the type of data pushed to the queue - * - * \param [in] priority is the priority of new element - * \param [in] data is a reference to data that will be pushed to RawMessageQueue - * - * \return zero if element was pushed successfully, error code otherwise: - * - EMSGSIZE - sizeof(T) doesn't match the \a elementSize attribute of RawMessageQueue; - * - error codes returned by Semaphore::wait(); - * - error codes returned by Semaphore::post(); - */ - - template<typename T> - int push(const uint8_t priority, const T& data) - { - return push(priority, &data, sizeof(data)); - } - - /** - * \brief Tries to pop the oldest element with highest priority from the queue. - * - * Similar to mq_receive() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_receive.html# - * - * \param [out] priority is a reference to variable that will be used to return priority of popped value - * \param [out] buffer is a pointer to buffer for popped element - * \param [in] size is the size of \a buffer, bytes - must be equal to the \a elementSize attribute of - * RawMessageQueue - * - * \return zero if element was popped successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawMessageQueue; - * - error codes returned by Semaphore::tryWait(); - * - error codes returned by Semaphore::post(); - */ - - int tryPop(uint8_t& priority, void* buffer, size_t size); - - /** - * \brief Tries to pop the oldest element with highest priority from the queue. - * - * Similar to mq_receive() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_receive.html# - * - * \tparam T is the type of data popped from the queue - * - * \param [out] priority is a reference to variable that will be used to return priority of popped value - * \param [out] buffer is a reference to object that will be used to return popped value - * - * \return zero if element was popped successfully, error code otherwise: - * - EMSGSIZE - sizeof(T) doesn't match the \a elementSize attribute of RawMessageQueue; - * - error codes returned by Semaphore::tryWait(); - * - error codes returned by Semaphore::post(); - */ - - template<typename T> - int tryPop(uint8_t& priority, T& buffer) - { - return tryPop(priority, &buffer, sizeof(buffer)); - } - - /** - * \brief Tries to pop the oldest element with highest priority from the queue for a given duration of time. - * - * Similar to mq_timedreceive() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_receive.html# - * - * \param [in] duration is the duration after which the call will be terminated without popping the element - * \param [out] priority is a reference to variable that will be used to return priority of popped value - * \param [out] buffer is a pointer to buffer for popped element - * \param [in] size is the size of \a buffer, bytes - must be equal to the \a elementSize attribute of - * RawMessageQueue - * - * \return zero if element was popped successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawMessageQueue; - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - int tryPopFor(TickClock::duration duration, uint8_t& priority, void* buffer, size_t size); - - /** - * \brief Tries to pop the oldest element with highest priority from the queue for a given duration of time. - * - * Template variant of tryPopFor(TickClock::duration, uint8_t&, void*, size_t). - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * - * \param [in] duration is the duration after which the call will be terminated without popping the element - * \param [out] priority is a reference to variable that will be used to return priority of popped value - * \param [out] buffer is a pointer to buffer for popped element - * \param [in] size is the size of \a buffer, bytes - must be equal to the \a elementSize attribute of - * RawMessageQueue - * - * \return zero if element was popped successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawMessageQueue; - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Rep, typename Period> - int tryPopFor(const std::chrono::duration<Rep, Period> duration, uint8_t& priority, void* const buffer, - const size_t size) - { - return tryPopFor(std::chrono::duration_cast<TickClock::duration>(duration), priority, buffer, size); - } - - /** - * \brief Tries to pop the oldest element with highest priority from the queue for a given duration of time. - * - * Similar to mq_timedreceive() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_receive.html# - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * \tparam T is the type of data popped from the queue - * - * \param [in] duration is the duration after which the call will be terminated without popping the element - * \param [out] priority is a reference to variable that will be used to return priority of popped value - * \param [out] buffer is a reference to object that will be used to return popped value - * - * \return zero if element was popped successfully, error code otherwise: - * - EMSGSIZE - sizeof(T) doesn't match the \a elementSize attribute of RawMessageQueue; - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Rep, typename Period, typename T> - int tryPopFor(const std::chrono::duration<Rep, Period> duration, uint8_t& priority, T& buffer) - { - return tryPopFor(std::chrono::duration_cast<TickClock::duration>(duration), priority, &buffer, sizeof(buffer)); - } - - /** - * \brief Tries to pop the oldest element with highest priority from the queue until a given time point. - * - * Similar to mq_timedreceive() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_receive.html# - * - * \param [in] timePoint is the time point at which the call will be terminated without popping the element - * \param [out] priority is a reference to variable that will be used to return priority of popped value - * \param [out] buffer is a pointer to buffer for popped element - * \param [in] size is the size of \a buffer, bytes - must be equal to the \a elementSize attribute of - * RawMessageQueue - * - * \return zero if element was popped successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawMessageQueue; - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - int tryPopUntil(TickClock::time_point timePoint, uint8_t& priority, void* buffer, size_t size); - - /** - * \brief Tries to pop the oldest element with highest priority from the queue until a given time point. - * - * Template variant of tryPopUntil(TickClock::time_point, uint8_t&, void*, size_t). - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * - * \param [in] timePoint is the time point at which the call will be terminated without popping the element - * \param [out] priority is a reference to variable that will be used to return priority of popped value - * \param [out] buffer is a pointer to buffer for popped element - * \param [in] size is the size of \a buffer, bytes - must be equal to the \a elementSize attribute of - * RawMessageQueue - * - * \return zero if element was popped successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawMessageQueue; - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Duration> - int tryPopUntil(const std::chrono::time_point<TickClock, Duration> timePoint, uint8_t& priority, void* const buffer, - const size_t size) - { - return tryPopUntil(std::chrono::time_point_cast<TickClock::duration>(timePoint), priority, buffer, size); - } - - /** - * \brief Tries to pop the oldest element with highest priority from the queue until a given time point. - * - * Similar to mq_timedreceive() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_receive.html# - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * \tparam T is the type of data popped from the queue - * - * \param [in] timePoint is the time point at which the call will be terminated without popping the element - * \param [out] priority is a reference to variable that will be used to return priority of popped value - * \param [out] buffer is a reference to object that will be used to return popped value - * - * \return zero if element was popped successfully, error code otherwise: - * - EMSGSIZE - sizeof(T) doesn't match the \a elementSize attribute of RawMessageQueue; - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Duration, typename T> - int tryPopUntil(const std::chrono::time_point<TickClock, Duration> timePoint, uint8_t& priority, T& buffer) - { - return tryPopUntil(std::chrono::time_point_cast<TickClock::duration>(timePoint), priority, &buffer, - sizeof(buffer)); - } - - /** - * \brief Tries to push the element to the queue. - * - * Similar to mq_send() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_send.html# - * - * \param [in] priority is the priority of new element - * \param [in] data is a pointer to data that will be pushed to RawMessageQueue - * \param [in] size is the size of \a data, bytes - must be equal to the \a elementSize attribute of RawMessageQueue - * - * \return zero if element was pushed successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawMessageQueue; - * - error codes returned by Semaphore::tryWait(); - * - error codes returned by Semaphore::post(); - */ - - int tryPush(uint8_t priority, const void* data, size_t size); - - /** - * \brief Tries to push the element to the queue. - * - * Similar to mq_send() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_send.html# - * - * \tparam T is the type of data pushed to the queue - * - * \param [in] priority is the priority of new element - * \param [in] data is a reference to data that will be pushed to RawMessageQueue - * - * \return zero if element was pushed successfully, error code otherwise: - * - EMSGSIZE - sizeof(T) doesn't match the \a elementSize attribute of RawMessageQueue; - * - error codes returned by Semaphore::tryWait(); - * - error codes returned by Semaphore::post(); - */ - - template<typename T> - int tryPush(const uint8_t priority, const T& data) - { - return tryPush(priority, &data, sizeof(data)); - } - - /** - * \brief Tries to push the element to the queue for a given duration of time. - * - * Similar to mq_timedsend() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_send.html# - * - * \param [in] duration is the duration after which the wait will be terminated without pushing the element - * \param [in] priority is the priority of new element - * \param [in] data is a pointer to data that will be pushed to RawMessageQueue - * \param [in] size is the size of \a data, bytes - must be equal to the \a elementSize attribute of RawMessageQueue - * - * \return zero if element was pushed successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawMessageQueue; - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - int tryPushFor(TickClock::duration duration, uint8_t priority, const void* data, size_t size); - - /** - * \brief Tries to push the element to the queue for a given duration of time. - * - * Template variant of tryPushFor(TickClock::duration, uint8_t, const void*, size_t). - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * - * \param [in] duration is the duration after which the wait will be terminated without pushing the element - * \param [in] priority is the priority of new element - * \param [in] data is a pointer to data that will be pushed to RawMessageQueue - * \param [in] size is the size of \a data, bytes - must be equal to the \a elementSize attribute of RawMessageQueue - * - * \return zero if element was pushed successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawMessageQueue; - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Rep, typename Period> - int tryPushFor(const std::chrono::duration<Rep, Period> duration, const uint8_t priority, const void* const data, - const size_t size) - { - return tryPushFor(std::chrono::duration_cast<TickClock::duration>(duration), priority, data, size); - } - - /** - * \brief Tries to push the element to the queue for a given duration of time. - * - * Similar to mq_timedsend() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_send.html# - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * \tparam T is the type of data pushed to the queue - * - * \param [in] duration is the duration after which the wait will be terminated without pushing the element - * \param [in] priority is the priority of new element - * \param [in] data is a reference to data that will be pushed to RawMessageQueue - * - * \return zero if element was pushed successfully, error code otherwise: - * - EMSGSIZE - sizeof(T) doesn't match the \a elementSize attribute of RawMessageQueue; - * - error codes returned by Semaphore::tryWaitFor(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Rep, typename Period, typename T> - int tryPushFor(const std::chrono::duration<Rep, Period> duration, const uint8_t priority, const T& data) - { - return tryPushFor(std::chrono::duration_cast<TickClock::duration>(duration), priority, &data, sizeof(data)); - } - - /** - * \brief Tries to push the element to the queue until a given time point. - * - * Similar to mq_timedsend() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_send.html# - * - * \param [in] timePoint is the time point at which the call will be terminated without pushing the element - * \param [in] priority is the priority of new element - * \param [in] data is a pointer to data that will be pushed to RawMessageQueue - * \param [in] size is the size of \a data, bytes - must be equal to the \a elementSize attribute of RawMessageQueue - * - * \return zero if element was pushed successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawMessageQueue; - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - int tryPushUntil(TickClock::time_point timePoint, uint8_t priority, const void* data, size_t size); - - /** - * \brief Tries to push the element to the queue until a given time point. - * - * Template variant of tryPushUntil(TickClock::time_point, uint8_t, const void*, size_t). - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * - * \param [in] timePoint is the time point at which the call will be terminated without pushing the element - * \param [in] priority is the priority of new element - * \param [in] data is a pointer to data that will be pushed to RawMessageQueue - * \param [in] size is the size of \a data, bytes - must be equal to the \a elementSize attribute of RawMessageQueue - * - * \return zero if element was pushed successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawMessageQueue; - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Duration> - int tryPushUntil(const std::chrono::time_point<TickClock, Duration> timePoint, const uint8_t priority, - const void* const data, const size_t size) - { - return tryPushUntil(std::chrono::time_point_cast<TickClock::duration>(timePoint), priority, data, size); - } - - /** - * \brief Tries to push the element to the queue until a given time point. - * - * Similar to mq_timedsend() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_send.html# - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * \tparam T is the type of data pushed to the queue - * - * \param [in] timePoint is the time point at which the call will be terminated without pushing the element - * \param [in] priority is the priority of new element - * \param [in] data is a reference to data that will be pushed to RawMessageQueue - * - * \return zero if element was pushed successfully, error code otherwise: - * - EMSGSIZE - sizeof(T) doesn't match the \a elementSize attribute of RawMessageQueue; - * - error codes returned by Semaphore::tryWaitUntil(); - * - error codes returned by Semaphore::post(); - */ - - template<typename Duration, typename T> - int tryPushUntil(const std::chrono::time_point<TickClock, Duration> timePoint, const uint8_t priority, - const T& data) - { - return tryPushUntil(std::chrono::time_point_cast<TickClock::duration>(timePoint), priority, &data, - sizeof(data)); - } - -private: - - /** - * \brief Pops oldest element with highest priority from the queue. - * - * Internal version - builds the Functor object. - * - * \param [in] waitSemaphoreFunctor is a reference to SemaphoreFunctor which will be executed with \a popSemaphore_ - * \param [out] priority is a reference to variable that will be used to return priority of popped value - * \param [out] buffer is a pointer to buffer for popped element - * \param [in] size is the size of \a buffer, bytes - must be equal to the \a elementSize attribute of - * RawMessageQueue - * - * \return zero if element was popped successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawMessageQueue; - * - error codes returned by \a waitSemaphoreFunctor's operator() call; - * - error codes returned by Semaphore::post(); - */ - - int popInternal(const internal::SemaphoreFunctor& waitSemaphoreFunctor, uint8_t& priority, void* buffer, - size_t size); - - /** - * \brief Pushes the element to the queue. - * - * Internal version - builds the Functor object. - * - * \param [in] waitSemaphoreFunctor is a reference to SemaphoreFunctor which will be executed with \a pushSemaphore_ - * \param [in] priority is the priority of new element - * \param [in] data is a pointer to data that will be pushed to RawMessageQueue - * \param [in] size is the size of \a data, bytes - must be equal to the \a elementSize attribute of RawMessageQueue - * - * \return zero if element was pushed successfully, error code otherwise: - * - EMSGSIZE - \a size doesn't match the \a elementSize attribute of RawMessageQueue; - * - error codes returned by \a waitSemaphoreFunctor's operator() call; - * - error codes returned by Semaphore::post(); - */ - - int pushInternal(const internal::SemaphoreFunctor& waitSemaphoreFunctor, uint8_t priority, const void* data, - size_t size); - - /// contained internal::MessageQueueBase object which implements base functionality - internal::MessageQueueBase messageQueueBase_; - - /// size of single queue element, bytes - const size_t elementSize_; -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_RAWMESSAGEQUEUE_HPP_ diff --git a/include/distortos/SchedulingPolicy.hpp b/include/distortos/SchedulingPolicy.hpp deleted file mode 100644 index 8793fb4..0000000 --- a/include/distortos/SchedulingPolicy.hpp +++ /dev/null @@ -1,36 +0,0 @@ -/** - * \file - * \brief SchedulingPolicy enum class header - * - * \author Copyright (C) 2014 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_SCHEDULINGPOLICY_HPP_ -#define INCLUDE_DISTORTOS_SCHEDULINGPOLICY_HPP_ - -#include <cstdint> - -namespace distortos -{ - -/** - * \brief scheduling policy of the thread - * - * \ingroup threads - */ - -enum class SchedulingPolicy : uint8_t -{ - /// FIFO scheduling policy - fifo, - /// round-robin scheduling policy - roundRobin, -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_SCHEDULINGPOLICY_HPP_ diff --git a/include/distortos/Semaphore.hpp b/include/distortos/Semaphore.hpp deleted file mode 100644 index 26ca298..0000000 --- a/include/distortos/Semaphore.hpp +++ /dev/null @@ -1,245 +0,0 @@ -/** - * \file - * \brief Semaphore class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_SEMAPHORE_HPP_ -#define INCLUDE_DISTORTOS_SEMAPHORE_HPP_ - -#include "distortos/internal/scheduler/ThreadList.hpp" - -#include "distortos/TickClock.hpp" - -namespace distortos -{ - -/** - * \brief Semaphore is the basic synchronization primitive - * - * Similar to POSIX semaphores - http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap04.html#tag_04_16 - * - * \ingroup synchronization - */ - -class Semaphore -{ -public: - - /// type used for semaphore's "value" - using Value = unsigned int; - - /** - * \brief Semaphore constructor - * - * Similar to sem_init() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sem_init.html# - * - * \param [in] value is the initial value of the semaphore, if this value is greater than maxValue, it will be - * truncated - * \param [in] maxValue is the max value of the semaphore before post() returns EOVERFLOW, default - max for Value - * type - */ - - constexpr explicit Semaphore(const Value value, const Value maxValue = std::numeric_limits<Value>::max()) : - blockedList_{}, - value_{value <= maxValue ? value : maxValue}, - maxValue_{maxValue} - { - - } - - /** - * \brief Semaphore destructor - * - * Similar to sem_destroy() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sem_destroy.html# - * - * It is safe to destroy a semaphore upon which no threads are currently blocked. The effect of destroying a - * semaphore upon which other threads are currently blocked is system error. - */ - - ~Semaphore() - { - - } - - /** - * \brief Gets current value of semaphore. - * - * Similar to sem_getvalue() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sem_getvalue.html# - * - * \return current value of semaphore, positive value if semaphore is not locked, zero otherwise - */ - - Value getValue() const - { - return value_; - } - - /** - * \brief Unlocks the semaphore. - * - * Similar to sem_post() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sem_post.html# - * - * This function shall unlock the semaphore by performing a semaphore unlock operation. If the semaphore value - * resulting from this operation is positive, then no threads were blocked waiting for the semaphore to become - * unlocked; the semaphore value is simply incremented. Otherwise one of the threads blocked waiting for the - * semaphore shall be allowed to return successfully from its call to lock() - the highest priority waiting thread - * shall be unblocked, and if there is more than one highest priority thread blocked waiting for the semaphore, then - * the highest priority thread that has been waiting the longest shall be unblocked. - * - * \return zero if the calling process successfully "posted" the semaphore, error code otherwise: - * - EOVERFLOW - the maximum allowable value for a semaphore would be exceeded; - */ - - int post(); - - /** - * \brief Tries to lock the semaphore. - * - * Similar to sem_trywait() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sem_trywait.html# - * - * This function shall lock the semaphore only if the semaphore is currently not locked; that is, if the semaphore - * value is currently positive. Otherwise, it shall not lock the semaphore. Upon successful return, the state of the - * semaphore shall be locked and shall remain locked until unlock() function is executed. - * - * \return zero if the calling process successfully performed the semaphore lock operation, error code otherwise: - * - EAGAIN - semaphore was already locked, so it cannot be immediately locked by the tryWait() operation; - */ - - int tryWait(); - - /** - * \brief Tries to lock the semaphore for given duration of time. - * - * Similar to sem_timedwait() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sem_timedwait.html# - * - * If the semaphore is already locked, the calling thread shall block until the semaphore becomes available as in - * wait() function. If the semaphore cannot be locked without waiting for another thread to unlock the semaphore, - * this wait shall be terminated when the specified timeout expires. - * - * Under no circumstance shall the function fail with a timeout if the semaphore can be locked immediately. The - * validity of the duration parameter need not be checked if the semaphore can be locked immediately. - * - * \param [in] duration is the duration after which the wait will be terminated without locking the semaphore - * - * \return zero if the calling process successfully performed the semaphore lock operation, error code otherwise: - * - EINTR - the wait was interrupted by an unmasked, caught signal; - * - ETIMEDOUT - the semaphore could not be locked before the specified timeout expired; - */ - - int tryWaitFor(TickClock::duration duration); - - /** - * \brief Tries to lock the semaphore for given duration of time. - * - * Template variant of tryWaitFor(TickClock::duration duration). - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * - * \param [in] duration is the duration after which the wait will be terminated without locking the semaphore - * - * \return zero if the calling process successfully performed the semaphore lock operation, error code otherwise: - * - EINTR - the wait was interrupted by an unmasked, caught signal; - * - ETIMEDOUT - the semaphore could not be locked before the specified timeout expired; - */ - - template<typename Rep, typename Period> - int tryWaitFor(const std::chrono::duration<Rep, Period> duration) - { - return tryWaitFor(std::chrono::duration_cast<TickClock::duration>(duration)); - } - - /** - * \brief Tries to lock the semaphore until given time point. - * - * Similar to sem_timedwait() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sem_timedwait.html# - * - * If the semaphore is already locked, the calling thread shall block until the semaphore becomes available as in - * wait() function. If the semaphore cannot be locked without waiting for another thread to unlock the semaphore, - * this wait shall be terminated when the specified timeout expires. - * - * Under no circumstance shall the function fail with a timeout if the semaphore can be locked immediately. The - * validity of the timePoint parameter need not be checked if the semaphore can be locked immediately. - * - * \param [in] timePoint is the time point at which the wait will be terminated without locking the semaphore - * - * \return zero if the calling process successfully performed the semaphore lock operation, error code otherwise: - * - EINTR - the wait was interrupted by an unmasked, caught signal; - * - ETIMEDOUT - the semaphore could not be locked before the specified timeout expired; - */ - - int tryWaitUntil(TickClock::time_point timePoint); - - /** - * \brief Tries to lock the semaphore until given time point. - * - * Template variant of tryWaitUntil(TickClock::time_point timePoint). - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * - * \param [in] timePoint is the time point at which the wait will be terminated without locking the semaphore - * - * \return zero if the calling process successfully performed the semaphore lock operation, error code otherwise: - * - EINTR - the wait was interrupted by an unmasked, caught signal; - * - ETIMEDOUT - the semaphore could not be locked before the specified timeout expired; - */ - - template<typename Duration> - int tryWaitUntil(const std::chrono::time_point<TickClock, Duration> timePoint) - { - return tryWaitUntil(std::chrono::time_point_cast<TickClock::duration>(timePoint)); - } - - /** - * \brief Locks the semaphore. - * - * Similar to sem_wait() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sem_trywait.html# - * - * This function shall lock the semaphore by performing a semaphore lock operation on that semaphore. If the - * semaphore value is currently zero, then the calling thread shall not return from the call to lock() until it - * either locks the semaphore or the call is interrupted by a signal. Upon successful return, the state of the - * semaphore shall be locked and shall remain locked until unlock() function is executed. - * - * \return zero if the calling process successfully performed the semaphore lock operation, error code otherwise: - * - EINTR - the wait was interrupted by an unmasked, caught signal; - */ - - int wait(); - - Semaphore(const Semaphore&) = delete; - Semaphore(Semaphore&&) = default; - const Semaphore& operator=(const Semaphore&) = delete; - Semaphore& operator=(Semaphore&&) = delete; - -private: - - /** - * \brief Internal version of tryWait(). - * - * Internal version with no interrupt masking. - * - * \return zero if the calling process successfully performed the semaphore lock operation, error code otherwise: - * - EAGAIN - semaphore was already locked, so it cannot be immediately locked by the tryWait() operation; - */ - - int tryWaitInternal(); - - /// ThreadControlBlock objects blocked on this semaphore - internal::ThreadList blockedList_; - - /// internal value of the semaphore - Value value_; - - /// max value of the semaphore - Value maxValue_; -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_SEMAPHORE_HPP_ diff --git a/include/distortos/SignalAction.hpp b/include/distortos/SignalAction.hpp deleted file mode 100644 index d91d696..0000000 --- a/include/distortos/SignalAction.hpp +++ /dev/null @@ -1,96 +0,0 @@ -/** - * \file - * \brief SignalAction class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_SIGNALACTION_HPP_ -#define INCLUDE_DISTORTOS_SIGNALACTION_HPP_ - -#include "distortos/SignalSet.hpp" - -namespace distortos -{ - -class SignalInformation; - -/** - * \brief SignalAction class contains information needed to handle signal that was caught - * - * Similar to \a sigaction - http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/signal.h.html - * - * \ingroup signals - */ - -class SignalAction -{ -public: - - /// handler function - using Handler = void(const SignalInformation&); - - /** - * \brief SignalAction's constructor which uses "default" signal handler. - */ - - constexpr SignalAction() : - signalMask_{SignalSet::empty}, - handler_{} - { - - } - - /** - * \brief SignalAction's constructor. - * - * \param [in] handler is a reference to handler function (similar to \a sa_sigaction member of \a sigaction) - * \param [in] signalMask is the additional set of signals to be masked during execution of signal-catching function - * (similar to \a sa_mask member of \a sigaction) - */ - - constexpr SignalAction(Handler& handler, const SignalSet signalMask) : - signalMask_{signalMask}, - handler_{&handler} - { - - } - - /** - * \return pointer to handler function (similar to \a sa_sigaction member of \a sigaction), nullptr if use of - * default handler was configured (similar to \a SIG_DFL) - */ - - Handler* getHandler() const - { - return handler_; - } - - /** - * \return additional set of signals to be masked during execution of signal-catching function (similar to - * \a sa_mask member of \a sigaction) - */ - - SignalSet getSignalMask() const - { - return signalMask_; - } - -private: - - /// additional set of signals to be masked during execution of signal-catching function (similar to \a sa_mask - /// member of \a sigaction) - SignalSet signalMask_; - - /// pointer to handler function (similar to \a sa_sigaction member of \a sigaction), nullptr to use default handler - /// (similar to \a SIG_DFL) - Handler* handler_; -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_SIGNALACTION_HPP_ diff --git a/include/distortos/SignalInformation.hpp b/include/distortos/SignalInformation.hpp deleted file mode 100644 index b3d897c..0000000 --- a/include/distortos/SignalInformation.hpp +++ /dev/null @@ -1,100 +0,0 @@ -/** - * \file - * \brief SignalInformation class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_SIGNALINFORMATION_HPP_ -#define INCLUDE_DISTORTOS_SIGNALINFORMATION_HPP_ - -#include <csignal> -#include <cstdint> - -namespace distortos -{ - -/** - * \brief SignalInformation class contains information about queued signal - * - * Similar to siginfo_t - http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/signal.h.html - * - * \ingroup signals - */ - -class SignalInformation -{ -public: - - /// replacement for predefined \a si_code values - enum class Code : uint8_t - { - /// signal generated by Thread::generateSignal() or ThisThread::Signals::generateSignal() (similar to - /// \a SI_USER) - generated, - /// signal queued by Thread::queueSignal() or ThisThread::Signals::queueSignal() (similar to \a SI_QUEUE) - queued, - }; - - /** - * \brief SignalInformation's constructor. - * - * \param [in] signalNumber is the signal number (similar to \a si_signo member of \a siginfo_t) - * \param [in] code is the signal code (similar to \a si_code member of \a siginfo_t) - * \param [in] value is the signal value (similar to \a si_value member of \a siginfo_t) - */ - - constexpr SignalInformation(const uint8_t signalNumber, const Code code, const sigval value) : - value_(value), - code_{code}, - signalNumber_{signalNumber} - { - - } - - /** - * \return signal code (similar to \a si_code member of \a siginfo_t) - */ - - Code getCode() const - { - return code_; - } - - /** - * \return signal number (similar to \a si_signo member of \a siginfo_t) - */ - - uint8_t getSignalNumber() const - { - return signalNumber_; - } - - /** - * \return signal value (similar to \a si_value member of \a siginfo_t) - */ - - sigval getValue() const - { - return value_; - } - -private: - - /// signal value (similar to \a si_value member of \a siginfo_t) - sigval value_; - - /// signal code (similar to \a si_code member of \a siginfo_t) - Code code_; - - /// signal number (similar to \a si_signo member of \a siginfo_t) - uint8_t signalNumber_; -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_SIGNALINFORMATION_HPP_ diff --git a/include/distortos/SignalInformationQueueWrapper.hpp b/include/distortos/SignalInformationQueueWrapper.hpp deleted file mode 100644 index f3825a5..0000000 --- a/include/distortos/SignalInformationQueueWrapper.hpp +++ /dev/null @@ -1,62 +0,0 @@ -/** - * \file - * \brief SignalInformationQueueWrapper class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_SIGNALINFORMATIONQUEUEWRAPPER_HPP_ -#define INCLUDE_DISTORTOS_SIGNALINFORMATIONQUEUEWRAPPER_HPP_ - -#include "distortos/internal/synchronization/SignalInformationQueue.hpp" - -namespace distortos -{ - -namespace internal -{ - -class SignalsReceiverControlBlock; - -} // namespace internal - -/// SignalInformationQueueWrapper class is a container for internal::SignalInformationQueue -class SignalInformationQueueWrapper -{ - friend class internal::SignalsReceiverControlBlock; - -public: - - /// import Storage type alias from internal::SignalInformationQueue - using Storage = internal::SignalInformationQueue::Storage; - - /// import StorageUniquePointer type alias from internal::SignalInformationQueue - using StorageUniquePointer = internal::SignalInformationQueue::StorageUniquePointer; - - /** - * \brief SignalInformationQueueWrapper's constructor - * - * \param [in] storageUniquePointer is a rvalue reference to StorageUniquePointer with storage for queue elements - * (sufficiently large for \a maxElements Storage objects) and appropriate deleter - * \param [in] maxElements is the number of elements in \a storage array - */ - - SignalInformationQueueWrapper(StorageUniquePointer&& storageUniquePointer, const size_t maxElements) : - signalInformationQueue_{std::move(storageUniquePointer), maxElements} - { - - } - -private: - - /// contained internal::SignalInformationQueue object - internal::SignalInformationQueue signalInformationQueue_; -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_SIGNALINFORMATIONQUEUEWRAPPER_HPP_ diff --git a/include/distortos/SignalSet.hpp b/include/distortos/SignalSet.hpp deleted file mode 100644 index 8473bdd..0000000 --- a/include/distortos/SignalSet.hpp +++ /dev/null @@ -1,179 +0,0 @@ -/** - * \file - * \brief SignalSet class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_SIGNALSET_HPP_ -#define INCLUDE_DISTORTOS_SIGNALSET_HPP_ - -#include <bitset> - -namespace distortos -{ - -/** - * \brief SignalSet class is used as a set of signals. - * - * Similar to POSIX sigset_t - http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/signal.h.html - * - * \ingroup signals - */ - -class SignalSet -{ -public: - - /// type of internal bitset for 32 signals - using Bitset = std::bitset<32>; - - /// tag struct to construct empty SignalSet - struct Empty - { - - }; - - /// tag struct to construct full SignalSet - struct Full - { - - }; - - /// tag object to construct empty SignalSet - constexpr static Empty empty = {}; - - /// tag object to construct full SignalSet - constexpr static Full full = {}; - - /** - * \brief SignalSet's constructor - * - * \param [in] bitmask is the bit mask used to initialize internal bitset - */ - - constexpr explicit SignalSet(uint32_t bitmask) : - bitset_{bitmask} - { - - } - - /** - * \brief SignalSet's constructor - * - * \param [in] bitset is a reference to Bitset from which internal bitset is copy-constructed - */ - - constexpr explicit SignalSet(const Bitset& bitset) : - bitset_{bitset} - { - - } - - /** - * \brief SignalSet's constructor - * - * Constructs empty SignalSet. - * - * Similar to sigemptyset() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sigemptyset.html# - */ - - constexpr explicit SignalSet(const Empty&) : - SignalSet{uint32_t{}} - { - - } - - /** - * \brief SignalSet's constructor - * - * Constructs full SignalSet. - * - * Similar to sigfillset() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sigfillset.html# - */ - - constexpr explicit SignalSet(const Full&) : - SignalSet{~uint32_t{}} - { - - } - - /** - * \brief Sets single bit. - * - * Similar to sigaddset() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sigaddset.html# - * - * \param [in] signalNumber is the bit position that will be set, [0; 31] - * - * \return 0 on success, error code otherwise: - * - EINVAL - \a signalNumber value is invalid; - */ - - int add(const uint8_t signalNumber) - { - return set(signalNumber, true); - } - - /** - * \return copy of internal bitset - */ - - Bitset getBitset() const - { - return bitset_; - } - - /** - * \brief Clears single bit. - * - * Similar to sigdelset() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sigdelset.html# - * - * \param [in] signalNumber is the bit position that will be cleared, [0; 31] - * - * \return 0 on success, error code otherwise: - * - EINVAL - \a signalNumber value is invalid; - */ - - int remove(const uint8_t signalNumber) - { - return set(signalNumber, false); - } - - /** - * \brief Tests whether the bit is set. - * - * Similar to sigismember() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sigismember.html# - * - * \param [in] signalNumber is the bit position that will be tested, [0; 31] - * - * \return pair with return code (0 on success, error code otherwise) and value of selected bit; error codes: - * - EINVAL - \a signalNumber value is invalid; - */ - - std::pair<int, bool> test(uint8_t signalNumber) const; - -private: - - /** - * \brief Sets value of single bit. - * - * \param [in] signalNumber is the bit position that will be modified, [0; 31] - * \param [in] value is the new value for selected bit - * - * \return 0 on success, error code otherwise: - * - EINVAL - \a signalNumber value is invalid; - */ - - int set(uint8_t signalNumber, bool value); - - /// internal bitset for 32 signals - Bitset bitset_; -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_SIGNALSET_HPP_ diff --git a/include/distortos/SignalsCatcher.hpp b/include/distortos/SignalsCatcher.hpp deleted file mode 100644 index effaf73..0000000 --- a/include/distortos/SignalsCatcher.hpp +++ /dev/null @@ -1,62 +0,0 @@ -/** - * \file - * \brief SignalsCatcher class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_SIGNALSCATCHER_HPP_ -#define INCLUDE_DISTORTOS_SIGNALSCATCHER_HPP_ - -#include "distortos/internal/synchronization/SignalsCatcherControlBlock.hpp" - -namespace distortos -{ - -namespace internal -{ - -class SignalsReceiverControlBlock; - -} // namespace internal - -/// SignalsCatcher class is a container for internal::SignalsCatcherControlBlock -class SignalsCatcher -{ - friend class internal::SignalsReceiverControlBlock; - -public: - - /// import Storage type alias from internal::SignalsCatcherControlBlock - using Storage = internal::SignalsCatcherControlBlock::Storage; - - /// import StorageUniquePointer type alias from internal::SignalsCatcherControlBlock - using StorageUniquePointer = internal::SignalsCatcherControlBlock::StorageUniquePointer; - - /** - * \brief SignalsCatcher's constructor - * - * \param [in] storageUniquePointer is a rvalue reference to StorageUniquePointer with storage for - * internal::Association objects (sufficiently large for \a storageSize elements) and appropriate deleter - * \param [in] storageSize is the number of elements in \a storage array - */ - - SignalsCatcher(StorageUniquePointer&& storageUniquePointer, const size_t storageSize) : - signalsCatcherControlBlock_{std::move(storageUniquePointer), storageSize} - { - - } - -private: - - /// contained internal::SignalsCatcherControlBlock object - internal::SignalsCatcherControlBlock signalsCatcherControlBlock_; -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_SIGNALSCATCHER_HPP_ diff --git a/include/distortos/SignalsReceiver.hpp b/include/distortos/SignalsReceiver.hpp deleted file mode 100644 index fa41cad..0000000 --- a/include/distortos/SignalsReceiver.hpp +++ /dev/null @@ -1,58 +0,0 @@ -/** - * \file - * \brief SignalsReceiver class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_SIGNALSRECEIVER_HPP_ -#define INCLUDE_DISTORTOS_SIGNALSRECEIVER_HPP_ - -#include "distortos/internal/synchronization/SignalsReceiverControlBlock.hpp" - -namespace distortos -{ - -namespace internal -{ - -class ThreadControlBlock; - -} // namespace internal - -/// SignalsReceiver class is a container for internal::SignalsReceiverControlBlock -class SignalsReceiver -{ - friend class internal::ThreadControlBlock; - -public: - - /** - * \brief SignalsReceiver's constructor - * - * \param [in] signalInformationQueueWrapper is a pointer to SignalInformationQueueWrapper for this receiver, - * nullptr to disable queuing of signals for this receiver - * \param [in] signalsCatcher is a pointer to SignalsCatcher for this receiver, nullptr if this receiver cannot - * catch/handle signals - */ - - explicit SignalsReceiver(SignalInformationQueueWrapper* const signalInformationQueueWrapper, - SignalsCatcher* const signalsCatcher) : - signalsReceiverControlBlock_{signalInformationQueueWrapper, signalsCatcher} - { - - } - -private: - - /// contained internal::SignalsReceiverControlBlock object - internal::SignalsReceiverControlBlock signalsReceiverControlBlock_; -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_SIGNALSRECEIVER_HPP_ diff --git a/include/distortos/SoftwareTimer.hpp b/include/distortos/SoftwareTimer.hpp deleted file mode 100644 index c10060c..0000000 --- a/include/distortos/SoftwareTimer.hpp +++ /dev/null @@ -1,130 +0,0 @@ -/** - * \file - * \brief SoftwareTimer class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_SOFTWARETIMER_HPP_ -#define INCLUDE_DISTORTOS_SOFTWARETIMER_HPP_ - -#include "distortos/TickClock.hpp" - -namespace distortos -{ - -/** - * \brief SoftwareTimer class is an abstract interface for software timers - * - * \ingroup softwareTimers - */ - -class SoftwareTimer -{ -public: - - /** - * \brief SoftwareTimer's destructor - */ - - virtual ~SoftwareTimer() = 0; - - /** - * \return true if the timer is running, false otherwise - */ - - virtual bool isRunning() const = 0; - - /** - * \brief Starts the timer. - * - * \note The duration will never be shorter, so one additional tick is always added to the duration. - * - * \param [in] duration is the duration after which the function will be executed - * - * \return 0 on success, error code otherwise - */ - - int start(TickClock::duration duration); - - /** - * \brief Starts the timer. - * - * \note The duration must not be shorter, so one additional tick is always added to the duration. - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * - * \param [in] duration is the duration after which the function will be executed - * - * \return 0 on success, error code otherwise - */ - - template<typename Rep, typename Period> - int start(const std::chrono::duration<Rep, Period> duration) - { - return start(std::chrono::duration_cast<TickClock::duration>(duration)); - } - - /** - * \brief Starts the timer. - * - * \param [in] timePoint is the time point at which the function will be executed - * - * \return 0 on success, error code otherwise - */ - - virtual int start(TickClock::time_point timePoint) = 0; - - /** - * \brief Starts the timer. - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * - * \param [in] timePoint is the time point at which the function will be executed - * - * \return 0 on success, error code otherwise - */ - - template<typename Duration> - int start(const std::chrono::time_point<TickClock, Duration> timePoint) - { - return start(std::chrono::time_point_cast<TickClock::duration>(timePoint)); - } - - /** - * \brief Stops the timer. - * - * \return 0 on success, error code otherwise - */ - - virtual int stop() = 0; - -protected: - - /** - * \brief Software timer's function runner - * - * \param [in] softwareTimer is a reference to SoftwareTimer object that is being run - */ - - static void softwareTimerRunner(SoftwareTimer& softwareTimer); - -private: - - /** - * \brief "Run" function of software timer - * - * This should be overridden by derived classes. - */ - - virtual void run() = 0; -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_SOFTWARETIMER_HPP_ diff --git a/include/distortos/SoftwareTimerCommon.hpp b/include/distortos/SoftwareTimerCommon.hpp deleted file mode 100644 index 636a264..0000000 --- a/include/distortos/SoftwareTimerCommon.hpp +++ /dev/null @@ -1,87 +0,0 @@ -/** - * \file - * \brief SoftwareTimerCommon class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_SOFTWARETIMERCOMMON_HPP_ -#define INCLUDE_DISTORTOS_SOFTWARETIMERCOMMON_HPP_ - -#include "distortos/SoftwareTimer.hpp" - -#include "distortos/internal/scheduler/SoftwareTimerControlBlock.hpp" - -namespace distortos -{ - -/** - * \brief SoftwareTimerCommon class implements common functionality of software timers - * - * \ingroup softwareTimers - */ - -class SoftwareTimerCommon : public SoftwareTimer -{ -public: - - /** - * \brief SoftwareTimerCommon's constructor - */ - - constexpr SoftwareTimerCommon() : - softwareTimerControlBlock_{softwareTimerRunner, *this} - { - - } - - /** - * \brief SoftwareTimerCommon's destructor - */ - - ~SoftwareTimerCommon() override; - - /** - * \return true if the timer is running, false otherwise - */ - - bool isRunning() const override; - - /** - * \brief Starts the timer. - * - * \param [in] timePoint is the time point at which the function will be executed - * - * \return 0 on success, error code otherwise - */ - - int start(TickClock::time_point timePoint) override; - - using SoftwareTimer::start; - - /** - * \brief Stops the timer. - * - * \return 0 on success, error code otherwise - */ - - int stop() override; - - SoftwareTimerCommon(const SoftwareTimerCommon&) = delete; - SoftwareTimerCommon(SoftwareTimerCommon&&) = default; - const SoftwareTimerCommon& operator=(const SoftwareTimerCommon&) = delete; - SoftwareTimerCommon& operator=(SoftwareTimerCommon&&) = delete; - -private: - - /// internal SoftwareTimerControlBlock object - internal::SoftwareTimerControlBlock softwareTimerControlBlock_; -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_SOFTWARETIMERCOMMON_HPP_ diff --git a/include/distortos/StaticFifoQueue.hpp b/include/distortos/StaticFifoQueue.hpp deleted file mode 100644 index 63bb636..0000000 --- a/include/distortos/StaticFifoQueue.hpp +++ /dev/null @@ -1,57 +0,0 @@ -/** - * \file - * \brief StaticFifoQueue class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_STATICFIFOQUEUE_HPP_ -#define INCLUDE_DISTORTOS_STATICFIFOQUEUE_HPP_ - -#include "FifoQueue.hpp" - -#include "distortos/internal/memory/dummyDeleter.hpp" - -namespace distortos -{ - -/** - * \brief StaticFifoQueue class is a variant of FifoQueue that has automatic storage for queue's contents. - * - * \tparam T is the type of data in queue - * \tparam QueueSize is the maximum number of elements in queue - * - * \ingroup queues - */ - -template<typename T, size_t QueueSize> -class StaticFifoQueue : public FifoQueue<T> -{ -public: - - /// import Storage type from base class - using typename FifoQueue<T>::Storage; - - /** - * \brief StaticFifoQueue's constructor - */ - - explicit StaticFifoQueue() : - FifoQueue<T>{{storage_.data(), internal::dummyDeleter<Storage>}, storage_.size()} - { - - } - -private: - - /// storage for queue's contents - std::array<Storage, QueueSize> storage_; -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_STATICFIFOQUEUE_HPP_ diff --git a/include/distortos/StaticMessageQueue.hpp b/include/distortos/StaticMessageQueue.hpp deleted file mode 100644 index ed370d0..0000000 --- a/include/distortos/StaticMessageQueue.hpp +++ /dev/null @@ -1,64 +0,0 @@ -/** - * \file - * \brief StaticMessageQueue class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_STATICMESSAGEQUEUE_HPP_ -#define INCLUDE_DISTORTOS_STATICMESSAGEQUEUE_HPP_ - -#include "MessageQueue.hpp" - -#include "distortos/internal/memory/dummyDeleter.hpp" - -namespace distortos -{ - -/** - * \brief StaticMessageQueue class is a variant of MessageQueue that has automatic storage for queue's contents. - * - * \tparam T is the type of data in queue - * \tparam QueueSize is the maximum number of elements in queue - * - * \ingroup queues - */ - -template<typename T, size_t QueueSize> -class StaticMessageQueue : public MessageQueue<T> -{ -public: - - /// import EntryStorage type from base class - using typename MessageQueue<T>::EntryStorage; - - /// import ValueStorage type from base class - using typename MessageQueue<T>::ValueStorage; - - /** - * \brief StaticMessageQueue's constructor - */ - - explicit StaticMessageQueue() : - MessageQueue<T>{{entryStorage_.data(), internal::dummyDeleter<EntryStorage>}, - {valueStorage_.data(), internal::dummyDeleter<ValueStorage>}, valueStorage_.size()} - { - - } - -private: - - /// storage for queue's entries - std::array<EntryStorage, QueueSize> entryStorage_; - - /// storage for queue's contents - std::array<ValueStorage, QueueSize> valueStorage_; -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_STATICMESSAGEQUEUE_HPP_ diff --git a/include/distortos/StaticRawFifoQueue.hpp b/include/distortos/StaticRawFifoQueue.hpp deleted file mode 100644 index a271020..0000000 --- a/include/distortos/StaticRawFifoQueue.hpp +++ /dev/null @@ -1,69 +0,0 @@ -/** - * \file - * \brief StaticRawFifoQueue class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_STATICRAWFIFOQUEUE_HPP_ -#define INCLUDE_DISTORTOS_STATICRAWFIFOQUEUE_HPP_ - -#include "RawFifoQueue.hpp" - -#include "distortos/internal/memory/dummyDeleter.hpp" - -namespace distortos -{ - -/** - * \brief StaticRawFifoQueue class is a variant of RawFifoQueue that has automatic storage for queue's contents. - * - * \tparam T is the type of data in queue - * \tparam QueueSize is the maximum number of elements in queue - * - * \ingroup queues - */ - -template<typename T, size_t QueueSize> -class StaticRawFifoQueue : public RawFifoQueue -{ -public: - - /// type of uninitialized storage for data - using Storage = typename std::aligned_storage<sizeof(T), alignof(T)>::type; - - /** - * \brief StaticRawFifoQueue's constructor - */ - - explicit StaticRawFifoQueue() : - RawFifoQueue{{storage_.data(), internal::dummyDeleter<Storage>}, sizeof(*storage_.data()), storage_.size()} - { - - } - -private: - - /// storage for queue's contents - std::array<Storage, QueueSize> storage_; -}; - -/** - * \brief StaticRawFifoQueueFromSize type alias is a variant of StaticRawFifoQueue which uses size of element (instead - * of type) as template argument. - * - * \tparam ElementSize is the size of single queue element, bytes - * \tparam QueueSize is the maximum number of elements in queue - */ - -template<size_t ElementSize, size_t QueueSize> -using StaticRawFifoQueueFromSize = - StaticRawFifoQueue<typename std::aligned_storage<ElementSize, ElementSize>::type, QueueSize>; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_STATICRAWFIFOQUEUE_HPP_ diff --git a/include/distortos/StaticRawMessageQueue.hpp b/include/distortos/StaticRawMessageQueue.hpp deleted file mode 100644 index 8120d17..0000000 --- a/include/distortos/StaticRawMessageQueue.hpp +++ /dev/null @@ -1,71 +0,0 @@ -/** - * \file - * \brief StaticRawMessageQueue class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_STATICRAWMESSAGEQUEUE_HPP_ -#define INCLUDE_DISTORTOS_STATICRAWMESSAGEQUEUE_HPP_ - -#include "distortos/RawMessageQueue.hpp" - -#include "distortos/internal/memory/dummyDeleter.hpp" - -namespace distortos -{ - -/** - * \brief StaticRawMessageQueue class is a variant of RawMessageQueue that has automatic storage for queue's contents. - * - * \tparam T is the type of data in queue - * \tparam QueueSize is the maximum number of elements in queue - * - * \ingroup queues - */ - -template<typename T, size_t QueueSize> -class StaticRawMessageQueue : public RawMessageQueue -{ -public: - - /** - * \brief StaticRawMessageQueue's constructor - */ - - explicit StaticRawMessageQueue() : - RawMessageQueue{{entryStorage_.data(), internal::dummyDeleter<EntryStorage>}, - {valueStorage_.data(), internal::dummyDeleter<ValueStorage<T>>}, sizeof(*valueStorage_.data()), - valueStorage_.size()} - { - - } - -private: - - /// storage for queue's entries - std::array<EntryStorage, QueueSize> entryStorage_; - - /// storage for queue's contents - std::array<ValueStorage<T>, QueueSize> valueStorage_; -}; - -/** - * \brief StaticRawMessageQueueFromSize type alias is a variant of StaticRawMessageQueue which uses size of element - * (instead of type) as template argument. - * - * \tparam ElementSize is the size of single queue element, bytes - * \tparam QueueSize is the maximum number of elements in queue - */ - -template<size_t ElementSize, size_t QueueSize> -using StaticRawMessageQueueFromSize = - StaticRawMessageQueue<typename std::aligned_storage<ElementSize, ElementSize>::type, QueueSize>; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_STATICRAWMESSAGEQUEUE_HPP_ diff --git a/include/distortos/StaticSignalsReceiver.hpp b/include/distortos/StaticSignalsReceiver.hpp deleted file mode 100644 index a6894ab..0000000 --- a/include/distortos/StaticSignalsReceiver.hpp +++ /dev/null @@ -1,166 +0,0 @@ -/** - * \file - * \brief StaticSignalsReceiver class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_STATICSIGNALSRECEIVER_HPP_ -#define INCLUDE_DISTORTOS_STATICSIGNALSRECEIVER_HPP_ - -#include "distortos/SignalInformationQueueWrapper.hpp" -#include "distortos/SignalsCatcher.hpp" -#include "distortos/SignalsReceiver.hpp" - -#include "distortos/internal/memory/dummyDeleter.hpp" - -namespace distortos -{ - -/** - * \brief StaticSignalsReceiver class is a templated interface for SignalsReceiver that has automatic storage for queued - * signals and SignalAction associations required for catching signals. - * - * \tparam QueuedSignals is the max number of queued signals, 0 to disable queuing of signals for this receiver - * \tparam SignalActions is the max number of different SignalAction objects, 0 to disable catching of signals for this - * receiver - */ - -template<size_t QueuedSignals, size_t SignalActions> -class StaticSignalsReceiver : public SignalsReceiver -{ -public: - - /** - * \brief StaticSignalsReceiver's constructor - */ - - StaticSignalsReceiver() : - SignalsReceiver{&signalInformationQueueWrapper_, &signalsCatcher_}, - signalInformationQueueWrapper_{{signalInformationQueueWrapperStorage_.data(), - internal::dummyDeleter<SignalInformationQueueWrapper::Storage>}, - signalInformationQueueWrapperStorage_.size()}, - signalsCatcher_{{signalsCatcherStorage_.data(), internal::dummyDeleter<SignalsCatcher::Storage>}, - signalsCatcherStorage_.size()} - { - - } - -private: - - /// storage for \a signalInformationQueueWrapper_ - std::array<SignalInformationQueueWrapper::Storage, QueuedSignals> signalInformationQueueWrapperStorage_; - - /// internal SignalInformationQueueWrapper object - SignalInformationQueueWrapper signalInformationQueueWrapper_; - - /// storage for \a signalsCatcher_ - std::array<SignalsCatcher::Storage, SignalActions> signalsCatcherStorage_; - - /// internal SignalsCatcher object - SignalsCatcher signalsCatcher_; -}; - -/** - * \brief StaticSignalsReceiver class is a templated interface for SignalsReceiver that has automatic storage for queued - * signals and SignalAction associations required for catching signals. - * - * \tparam QueuedSignals is the max number of queued signals - * - * Specialization for receiver with enabled queuing (QueuedSignals != 0) and disabled catching (SignalActions == 0) of - * signals - */ - -template<size_t QueuedSignals> -class StaticSignalsReceiver<QueuedSignals, 0> : public SignalsReceiver -{ -public: - - /** - * \brief StaticSignalsReceiver's constructor - */ - - StaticSignalsReceiver() : - SignalsReceiver{&signalInformationQueueWrapper_, nullptr}, - signalInformationQueueWrapper_{{signalInformationQueueWrapperStorage_.data(), - internal::dummyDeleter<SignalInformationQueueWrapper::Storage>}, - signalInformationQueueWrapperStorage_.size()} - { - - } - -private: - - /// storage for \a signalInformationQueueWrapper_ - std::array<SignalInformationQueueWrapper::Storage, QueuedSignals> signalInformationQueueWrapperStorage_; - - /// internal SignalInformationQueueWrapper object - SignalInformationQueueWrapper signalInformationQueueWrapper_; -}; - -/** - * \brief StaticSignalsReceiver class is a templated interface for SignalsReceiver that has automatic storage for queued - * signals and SignalAction associations required for catching signals. - * - * \tparam SignalActions is the max number of different SignalAction objects - * - * Specialization for receiver with disabled queuing (QueuedSignals == 0) and enabled catching (SignalActions != 0) of - * signals - */ - -template<size_t SignalActions> -class StaticSignalsReceiver<0, SignalActions> : public SignalsReceiver -{ -public: - - /** - * \brief StaticSignalsReceiver's constructor - */ - - StaticSignalsReceiver() : - SignalsReceiver{nullptr, &signalsCatcher_}, - signalsCatcher_{{signalsCatcherStorage_.data(), internal::dummyDeleter<SignalsCatcher::Storage>}, - signalsCatcherStorage_.size()} - { - - } - -private: - - /// storage for \a signalsCatcher_ - std::array<SignalsCatcher::Storage, SignalActions> signalsCatcherStorage_; - - /// internal SignalsCatcher object - SignalsCatcher signalsCatcher_; -}; - -/** - * \brief StaticSignalsReceiver class is a templated interface for SignalsReceiver that has automatic storage for queued - * signals and SignalAction associations required for catching signals. - * - * Specialization for receiver with disabled queuing (QueuedSignals == 0) and catching (SignalActions == 0) of signals - */ - -template<> -class StaticSignalsReceiver<0, 0> : public SignalsReceiver -{ -public: - - /** - * \brief StaticSignalsReceiver's constructor - */ - - StaticSignalsReceiver() : - SignalsReceiver{nullptr, nullptr} - { - - } -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_STATICSIGNALSRECEIVER_HPP_ diff --git a/include/distortos/StaticSoftwareTimer.hpp b/include/distortos/StaticSoftwareTimer.hpp deleted file mode 100644 index e1c27f7..0000000 --- a/include/distortos/StaticSoftwareTimer.hpp +++ /dev/null @@ -1,90 +0,0 @@ -/** - * \file - * \brief StaticSoftwareTimer class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_STATICSOFTWARETIMER_HPP_ -#define INCLUDE_DISTORTOS_STATICSOFTWARETIMER_HPP_ - -#include "distortos/SoftwareTimerCommon.hpp" - -#include <functional> - -namespace distortos -{ - -/// \addtogroup softwareTimers -/// \{ - -/** - * \brief StaticSoftwareTimer class is a templated interface for software timer - * - * \tparam Function is the function that will be executed - * \tparam Args are the arguments for function - */ - -template<typename Function, typename... Args> -class StaticSoftwareTimer : public SoftwareTimerCommon -{ -public: - - /** - * \brief StaticSoftwareTimer's constructor - * - * \param [in] function is a function that will be executed from interrupt context at a later time - * \param [in] args are arguments for function - */ - - StaticSoftwareTimer(Function&& function, Args&&... args) : - SoftwareTimerCommon{}, - boundFunction_{std::bind(std::forward<Function>(function), std::forward<Args>(args)...)} - { - - } - -private: - - /** - * \brief "Run" function of software timer - * - * Executes bound function object. - */ - - void run() override - { - boundFunction_(); - } - - /// bound function object - decltype(std::bind(std::declval<Function>(), std::declval<Args>()...)) boundFunction_; -}; - -/** - * \brief Helper factory function to make StaticSoftwareTimer object with deduced template arguments - * - * \tparam Function is the function that will be executed - * \tparam Args are the arguments for function - * - * \param [in] function is a function that will be executed from interrupt context at a later time - * \param [in] args are arguments for function - * - * \return StaticSoftwareTimer object with deduced template arguments - */ - -template<typename Function, typename... Args> -StaticSoftwareTimer<Function, Args...> makeStaticSoftwareTimer(Function&& function, Args&&... args) -{ - return {std::forward<Function>(function), std::forward<Args>(args)...}; -} - -/// \} - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_STATICSOFTWARETIMER_HPP_ diff --git a/include/distortos/StaticThread.hpp b/include/distortos/StaticThread.hpp deleted file mode 100644 index c135e55..0000000 --- a/include/distortos/StaticThread.hpp +++ /dev/null @@ -1,357 +0,0 @@ -/** - * \file - * \brief StaticThread class header - * - * \author Copyright (C) 2014-2016 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_STATICTHREAD_HPP_ -#define INCLUDE_DISTORTOS_STATICTHREAD_HPP_ - -#include "distortos/StaticSignalsReceiver.hpp" -#include "distortos/UndetachableThread.hpp" - -namespace distortos -{ - -namespace internal -{ - -/** - * \brief StaticThreadBase class is a templated common base for StaticThread - * - * \tparam Function is the function that will be executed in separate thread - * \tparam Args are the arguments for \a Function - */ - -template<typename Function, typename... Args> -class StaticThreadBase : public UndetachableThread -{ -public: - - /// base of StaticThreadBase - using Base = UndetachableThread; - - /** - * \brief StaticThreadBase's constructor - * - * \param [in] stackStorageUniquePointer is a rvalue reference to StackStorageUniquePointer with storage for stack - * (\a size bytes long) and appropriate deleter - * \param [in] size is the size of stack's storage, bytes - * \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest - * \param [in] schedulingPolicy is the scheduling policy of the thread - * \param [in] signalsReceiver is a pointer to SignalsReceiver object for this thread, nullptr to disable reception - * of signals for this thread - * \param [in] function is a function that will be executed in separate thread - * \param [in] args are arguments for function - */ - - StaticThreadBase(StackStorageUniquePointer&& stackStorageUniquePointer, const size_t size, const uint8_t priority, - const SchedulingPolicy schedulingPolicy, SignalsReceiver* const signalsReceiver, Function&& function, - Args&&... args) : - Base{{std::move(stackStorageUniquePointer), size, *this, run, nullptr, terminationHook}, - priority, schedulingPolicy, nullptr, signalsReceiver}, - boundFunction_{std::bind(std::forward<Function>(function), std::forward<Args>(args)...)} - { - - } - - StaticThreadBase(const StaticThreadBase&) = delete; - StaticThreadBase(StaticThreadBase&&) = default; - const StaticThreadBase& operator=(const StaticThreadBase&) = delete; - StaticThreadBase& operator=(StaticThreadBase&&) = delete; - -private: - - /** - * \brief Thread's "run" function. - * - * Executes bound function object. - * - * \param [in] thread is a reference to Thread object, this must be StaticThreadBase! - */ - - static void run(Thread& thread) - { - static_cast<StaticThreadBase&>(thread).boundFunction_(); - } - - /// bound function object - decltype(std::bind(std::declval<Function>(), std::declval<Args>()...)) boundFunction_; -}; - -} // namespace internal - -/// \addtogroup threads -/// \{ - -/** - * \brief StaticThread class is a templated interface for thread that has automatic storage for stack. - * - * \tparam StackSize is the size of stack, bytes - * \tparam CanReceiveSignals selects whether reception of signals is enabled (true) or disabled (false) for this thread - * \tparam QueuedSignals is the max number of queued signals for this thread, relevant only if - * CanReceiveSignals == true, 0 to disable queuing of signals for this thread - * \tparam SignalActions is the max number of different SignalAction objects for this thread, relevant only if - * CanReceiveSignals == true, 0 to disable catching of signals for this thread - * \tparam Function is the function that will be executed in separate thread - * \tparam Args are the arguments for \a Function - */ - -template<size_t StackSize, bool CanReceiveSignals, size_t QueuedSignals, size_t SignalActions, typename Function, - typename... Args> -class StaticThread : public internal::StaticThreadBase<Function, Args...> -{ -public: - - /// base of StaticThread - using Base = internal::StaticThreadBase<Function, Args...>; - - /** - * \brief StaticThread's constructor - * - * \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest - * \param [in] schedulingPolicy is the scheduling policy of the thread - * \param [in] function is a function that will be executed in separate thread - * \param [in] args are arguments for function - */ - - StaticThread(uint8_t priority, SchedulingPolicy schedulingPolicy, Function&& function, Args&&... args); - - /** - * \brief StaticThread's constructor - * - * \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest - * \param [in] function is a function that will be executed in separate thread - * \param [in] args are arguments for function - */ - - StaticThread(const uint8_t priority, Function&& function, Args&&... args) : - StaticThread{priority, SchedulingPolicy::roundRobin, std::forward<Function>(function), - std::forward<Args>(args)...} - { - - } - - StaticThread(const StaticThread&) = delete; - StaticThread(StaticThread&&) = default; - const StaticThread& operator=(const StaticThread&) = delete; - StaticThread& operator=(StaticThread&&) = delete; - -private: - - /// stack buffer - typename std::aligned_storage<StackSize>::type stack_; -}; - -/** - * \brief StaticThread class is a templated interface for thread that has automatic storage for stack and internal - * StaticSignalsReceiver object. - * - * Specialization for threads with enabled reception of signals (CanReceiveSignals == true) - * - * \tparam StackSize is the size of stack, bytes - * \tparam QueuedSignals is the max number of queued signals for this thread, 0 to disable queuing of signals for this - * thread - * \tparam SignalActions is the max number of different SignalAction objects for this thread, relevant only if - * CanReceiveSignals == true, 0 to disable catching of signals for this thread - * \tparam Function is the function that will be executed in separate thread - * \tparam Args are the arguments for \a Function - */ - -template<size_t StackSize, size_t QueuedSignals, size_t SignalActions, typename Function, typename... Args> -class StaticThread<StackSize, true, QueuedSignals, SignalActions, Function, Args...> : - public internal::StaticThreadBase<Function, Args...> -{ -public: - - /// base of StaticThread - using Base = internal::StaticThreadBase<Function, Args...>; - - /** - * \brief StaticThread's constructor - * - * \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest - * \param [in] schedulingPolicy is the scheduling policy of the thread - * \param [in] function is a function that will be executed in separate thread - * \param [in] args are arguments for function - */ - - StaticThread(uint8_t priority, SchedulingPolicy schedulingPolicy, Function&& function, Args&&... args); - - /** - * \brief StaticThread's constructor - * - * \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest - * \param [in] function is a function that will be executed in separate thread - * \param [in] args are arguments for function - */ - - StaticThread(const uint8_t priority, Function&& function, Args&&... args) : - StaticThread{priority, SchedulingPolicy::roundRobin, std::forward<Function>(function), - std::forward<Args>(args)...} - { - - } - - StaticThread(const StaticThread&) = delete; - StaticThread(StaticThread&&) = default; - const StaticThread& operator=(const StaticThread&) = delete; - StaticThread& operator=(StaticThread&&) = delete; - -private: - - /// stack buffer - typename std::aligned_storage<StackSize>::type stack_; - - /// internal StaticSignalsReceiver object - StaticSignalsReceiver<QueuedSignals, SignalActions> staticSignalsReceiver_; -}; - -/** - * \brief Helper factory function to make StaticThread object with partially deduced template arguments - * - * \tparam StackSize is the size of stack, bytes - * \tparam CanReceiveSignals selects whether reception of signals is enabled (true) or disabled (false) for this thread - * \tparam QueuedSignals is the max number of queued signals for this thread, relevant only if - * CanReceiveSignals == true, 0 to disable queuing of signals for this thread - * \tparam SignalActions is the max number of different SignalAction objects for this thread, relevant only if - * CanReceiveSignals == true, 0 to disable catching of signals for this thread - * \tparam Function is the function that will be executed - * \tparam Args are the arguments for \a Function - * - * \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest - * \param [in] schedulingPolicy is the scheduling policy of the thread - * \param [in] function is a function that will be executed in separate thread - * \param [in] args are arguments for function - * - * \return StaticThread object with partially deduced template arguments - */ - -template<size_t StackSize, bool CanReceiveSignals = {}, size_t QueuedSignals = {}, size_t SignalActions = {}, - typename Function, typename... Args> -StaticThread<StackSize, CanReceiveSignals, QueuedSignals, SignalActions, Function, Args...> -makeStaticThread(const uint8_t priority, const SchedulingPolicy schedulingPolicy, Function&& function, Args&&... args) -{ - return {priority, schedulingPolicy, std::forward<Function>(function), std::forward<Args>(args)...}; -} - -/** - * \brief Helper factory function to make StaticThread object with partially deduced template arguments - * - * \tparam StackSize is the size of stack, bytes - * \tparam CanReceiveSignals selects whether reception of signals is enabled (true) or disabled (false) for this thread - * \tparam QueuedSignals is the max number of queued signals for this thread, relevant only if - * CanReceiveSignals == true, 0 to disable queuing of signals for this thread - * \tparam SignalActions is the max number of different SignalAction objects for this thread, relevant only if - * CanReceiveSignals == true, 0 to disable catching of signals for this thread - * \tparam Function is the function that will be executed - * \tparam Args are the arguments for \a Function - * - * \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest - * \param [in] function is a function that will be executed in separate thread - * \param [in] args are arguments for function - * - * \return StaticThread object with partially deduced template arguments - */ - -template<size_t StackSize, bool CanReceiveSignals = {}, size_t QueuedSignals = {}, size_t SignalActions = {}, - typename Function, typename... Args> -StaticThread<StackSize, CanReceiveSignals, QueuedSignals, SignalActions, Function, Args...> -makeStaticThread(const uint8_t priority, Function&& function, Args&&... args) -{ - return {priority, std::forward<Function>(function), std::forward<Args>(args)...}; -} - -/** - * \brief Helper factory function to make and start StaticThread object with partially deduced template arguments - * - * \tparam StackSize is the size of stack, bytes - * \tparam CanReceiveSignals selects whether reception of signals is enabled (true) or disabled (false) for this thread - * \tparam QueuedSignals is the max number of queued signals for this thread, relevant only if - * CanReceiveSignals == true, 0 to disable queuing of signals for this thread - * \tparam SignalActions is the max number of different SignalAction objects for this thread, relevant only if - * CanReceiveSignals == true, 0 to disable catching of signals for this thread - * \tparam Function is the function that will be executed - * \tparam Args are the arguments for \a Function - * - * \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest - * \param [in] schedulingPolicy is the scheduling policy of the thread - * \param [in] function is a function that will be executed in separate thread - * \param [in] args are arguments for function - * - * \return StaticThread object with partially deduced template arguments - */ - -template<size_t StackSize, bool CanReceiveSignals = {}, size_t QueuedSignals = {}, size_t SignalActions = {}, - typename Function, typename... Args> -StaticThread<StackSize, CanReceiveSignals, QueuedSignals, SignalActions, Function, Args...> -makeAndStartStaticThread(const uint8_t priority, const SchedulingPolicy schedulingPolicy, Function&& function, - Args&&... args) -{ - auto thread = makeStaticThread<StackSize, CanReceiveSignals, QueuedSignals, SignalActions>(priority, - schedulingPolicy, std::forward<Function>(function), std::forward<Args>(args)...); - thread.start(); /// \todo make sure this never fails - return thread; -} - -/** - * \brief Helper factory function to make and start StaticThread object with partially deduced template arguments - * - * \tparam StackSize is the size of stack, bytes - * \tparam CanReceiveSignals selects whether reception of signals is enabled (true) or disabled (false) for this thread - * \tparam QueuedSignals is the max number of queued signals for this thread, relevant only if - * CanReceiveSignals == true, 0 to disable queuing of signals for this thread - * \tparam SignalActions is the max number of different SignalAction objects for this thread, relevant only if - * CanReceiveSignals == true, 0 to disable catching of signals for this thread - * \tparam Function is the function that will be executed - * \tparam Args are the arguments for \a Function - * - * \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest - * \param [in] function is a function that will be executed in separate thread - * \param [in] args are arguments for function - * - * \return StaticThread object with partially deduced template arguments - */ - -template<size_t StackSize, bool CanReceiveSignals = {}, size_t QueuedSignals = {}, size_t SignalActions = {}, - typename Function, typename... Args> -StaticThread<StackSize, CanReceiveSignals, QueuedSignals, SignalActions, Function, Args...> -makeAndStartStaticThread(const uint8_t priority, Function&& function, Args&&... args) -{ - auto thread = makeStaticThread<StackSize, CanReceiveSignals, QueuedSignals, SignalActions>(priority, - std::forward<Function>(function), std::forward<Args>(args)...); - thread.start(); /// \todo make sure this never fails - return thread; -} - -/// \} - -template<size_t StackSize, bool CanReceiveSignals, size_t QueuedSignals, size_t SignalActions, typename Function, - typename... Args> -StaticThread<StackSize, CanReceiveSignals, QueuedSignals, SignalActions, Function, Args...>:: -StaticThread(const uint8_t priority, const SchedulingPolicy schedulingPolicy, Function&& function, Args&&... args) : - Base{{&stack_, internal::dummyDeleter<decltype(stack_)>}, sizeof(stack_), priority, schedulingPolicy, nullptr, - std::forward<Function>(function), std::forward<Args>(args)...} -{ - -} - -template<size_t StackSize, size_t QueuedSignals, size_t SignalActions, typename Function, typename... Args> -StaticThread<StackSize, true, QueuedSignals, SignalActions, Function, Args...>::StaticThread(const uint8_t priority, - const SchedulingPolicy schedulingPolicy, Function&& function, Args&&... args) : - Base{{&stack_, internal::dummyDeleter<decltype(stack_)>}, sizeof(stack_), priority, schedulingPolicy, - &static_cast<SignalsReceiver&>(staticSignalsReceiver_), std::forward<Function>(function), - std::forward<Args>(args)...}, - staticSignalsReceiver_{} -{ - -} - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_STATICTHREAD_HPP_ diff --git a/include/distortos/ThisThread-Signals.hpp b/include/distortos/ThisThread-Signals.hpp deleted file mode 100644 index b0a808d..0000000 --- a/include/distortos/ThisThread-Signals.hpp +++ /dev/null @@ -1,279 +0,0 @@ -/** - * \file - * \brief ThisThread::Signals namespace header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_THISTHREAD_SIGNALS_HPP_ -#define INCLUDE_DISTORTOS_THISTHREAD_SIGNALS_HPP_ - -#include "distortos/SignalInformation.hpp" -#include "distortos/TickClock.hpp" - -#include <utility> - -#include <cstdint> - -namespace distortos -{ - -class SignalAction; -class SignalSet; - -namespace ThisThread -{ - -namespace Signals -{ - -/// \addtogroup signals -/// \{ - -/** - * \brief Generates signal for current thread. - * - * Similar to raise() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/raise.html - * - * Adds the signalNumber to set of pending signals of current thread. - * - * \param [in] signalNumber is the signal that will be generated, [0; 31] - * - * \return 0 on success, error code otherwise: - * - EINVAL - \a signalNumber value is invalid; - * - ENOTSUP - reception of signals is disabled for current thread; - */ - -int generateSignal(uint8_t signalNumber); - -/** - * \brief Gets set of currently pending signals for current thread. - * - * Similar to sigpending() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sigpending.html - * - * This function shall return the set of signals that are blocked from delivery and are pending on the current thread. - * - * \return set of currently pending signals for current thread - */ - -SignalSet getPendingSignalSet(); - -/** - * \brief Gets SignalAction associated with given signal number. - * - * Similar to sigaction() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sigaction.html - * - * \param [in] signalNumber is the signal for which the association is requested, [0; 31] - * - * \return pair with return code (0 on success, error code otherwise) and SignalAction that is associated with - * \a signalNumber, default-constructed object if no association was found; - * error codes: - * - EINVAL - \a signalNumber value is invalid; - * - ENOTSUP - reception or catching/handling of signals are disabled for current thread; - */ - -std::pair<int, SignalAction> getSignalAction(uint8_t signalNumber); - -/** - * \brief Gets signal mask for current thread. - * - * Similar to pthread_sigmask() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_sigmask.html# - * - * \return SignalSet with signal mask for current thread - */ - -SignalSet getSignalMask(); - -/** - * \brief Queues signal for current thread. - * - * Similar to sigqueue() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sigqueue.html - * - * Adds the signalNumber and signal value (sigval union) to queue of SignalInformation objects. - * - * \param [in] signalNumber is the signal that will be queued, [0; 31] - * \param [in] value is the signal value - * - * \return 0 on success, error code otherwise: - * - EAGAIN - no resources are available to queue the signal, maximal number of signals is already queued in - * associated queue of SignalInformation objects; - * - EINVAL - \a signalNumber value is invalid; - * - ENOTSUP - reception or queuing of signals are disabled for current thread; - */ - -int queueSignal(uint8_t signalNumber, sigval value); - -/** - * \brief Sets association for given signal number. - * - * Similar to sigaction() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sigaction.html - * - * \param [in] signalNumber is the signal for which the association will be set, [0; 31] - * \param [in] signalAction is a reference to SignalAction that will be associated with given signal number, object in - * internal storage is copy-constructed - * - * \return pair with return code (0 on success, error code otherwise) and SignalAction that was associated with - * \a signalNumber, default-constructed object if no association was found; - * error codes: - * - EAGAIN - no resources are available to associate \a signalNumber with \a signalAction; - * - EINVAL - \a signalNumber value is invalid; - * - ENOTSUP - reception or catching/handling of signals are disabled for current thread; - */ - -std::pair<int, SignalAction> setSignalAction(uint8_t signalNumber, const SignalAction& signalAction); - -/** - * \brief Sets signal mask for current thread. - * - * Similar to pthread_sigmask() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_sigmask.html# - * - * \param [in] signalMask is the SignalSet with new signal mask for current thread - * - * \return 0 on success, error code otherwise: - * - ENOTSUP - reception or catching/handling of signals are disabled for current thread; - */ - -int setSignalMask(SignalSet signalMask); - -/** - * \brief Tries to accept pending signals. - * - * Similar to sigtimedwait() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sigtimedwait.html - * - * This function shall select the lowest pending signal from provided set, atomically clear it from current thread's set - * of pending signals and return that signal number. If no signal in provided set is pending at the time of the call, - * then this function shall return immediately with an error. - * - * \param [in] signalSet is a reference to set of signals that may be accepted - * - * \return pair with return code (0 on success, error code otherwise) and SignalInformation object for accepted signal; - * error codes: - * - EAGAIN - no signal specified by \a signalSet was pending; - * - ENOTSUP - reception of signals is disabled for current thread; - */ - -std::pair<int, SignalInformation> tryWait(const SignalSet& signalSet); - -/** - * \brief Tries to wait for signals for given duration of time. - * - * Similar to sigtimedwait() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sigtimedwait.html - * - * This function shall select the lowest pending signal from provided set, atomically clear it from current thread's set - * of pending signals and return that signal number. If no signal in provided set is pending at the time of the call, - * the thread shall be suspended until one or more becomes pending or until given duration of time expires. - * - * \param [in] signalSet is a reference to set of signals that will be waited for - * \param [in] duration is the duration after which the wait for signals will be terminated - * - * \return pair with return code (0 on success, error code otherwise) and SignalInformation object for accepted signal; - * error codes: - * - EINTR - the wait was interrupted by an unmasked, caught signal; - * - ENOTSUP - reception of signals is disabled for current thread; - * - ETIMEDOUT - no signal specified by \a signalSet was generated before the specified \a duration passed; - */ - -std::pair<int, SignalInformation> tryWaitFor(const SignalSet& signalSet, TickClock::duration duration); - -/** - * \brief Tries to wait for signals for given duration of time. - * - * Template variant of tryWaitFor(const SignalSet&, TickClock::duration). - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * - * \param [in] signalSet is a reference to set of signals that will be waited for - * \param [in] duration is the duration after which the wait for signals will be terminated - * - * \return pair with return code (0 on success, error code otherwise) and SignalInformation object for accepted signal; - * error codes: - * - EINTR - the wait was interrupted by an unmasked, caught signal; - * - ENOTSUP - reception of signals is disabled for current thread; - * - ETIMEDOUT - no signal specified by \a signalSet was generated before the specified \a duration passed; - */ - -template<typename Rep, typename Period> -std::pair<int, SignalInformation> tryWaitFor(const SignalSet& signalSet, - const std::chrono::duration<Rep, Period> duration) -{ - return tryWaitFor(signalSet, std::chrono::duration_cast<TickClock::duration>(duration)); -} - -/** - * \brief Tries to wait for signals until given time point. - * - * Similar to sigtimedwait() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sigtimedwait.html - * - * This function shall select the lowest pending signal from provided set, atomically clear it from current thread's set - * of pending signals and return that signal number. If no signal in provided set is pending at the time of the call, - * the thread shall be suspended until one or more becomes pending or until given time point is reached - * - * \param [in] signalSet is a reference to set of signals that will be waited for - * \param [in] timePoint is the time point at which the wait for signals will be terminated - * - * \return pair with return code (0 on success, error code otherwise) and SignalInformation object for accepted signal; - * error codes: - * - EINTR - the wait was interrupted by an unmasked, caught signal; - * - ENOTSUP - reception of signals is disabled for current thread; - * - ETIMEDOUT - no signal specified by \a signalSet was generated before specified \a timePoint; - */ - -std::pair<int, SignalInformation> tryWaitUntil(const SignalSet& signalSet, TickClock::time_point timePoint); - -/** - * \brief Tries to wait for signals until given time point. - * - * Template variant of tryWaitUntil(const SignalSet&, TickClock::time_point). - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * - * \param [in] signalSet is a reference to set of signals that will be waited for - * \param [in] timePoint is the time point at which the wait for signals will be terminated - * - * \return pair with return code (0 on success, error code otherwise) and SignalInformation object for accepted signal; - * error codes: - * - EINTR - the wait was interrupted by an unmasked, caught signal; - * - ENOTSUP - reception of signals is disabled for current thread; - * - ETIMEDOUT - no signal specified by \a signalSet was generated before specified \a timePoint; - */ - -template<typename Duration> -std::pair<int, SignalInformation> tryWaitUntil(const SignalSet& signalSet, - const std::chrono::time_point<TickClock, Duration> timePoint) -{ - return tryWaitUntil(signalSet, std::chrono::time_point_cast<TickClock::duration>(timePoint)); -} - -/** - * \brief Waits for signals. - * - * Similar to sigwait() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sigwait.html - * - * This function shall select the lowest pending signal from provided set, atomically clear it from current thread's set - * of pending signals and return that signal number. If no signal in provided set is pending at the time of the call, - * the thread shall be suspended until one or more becomes pending. - * - * \param [in] signalSet is a reference to set of signals that will be waited for - * - * \return pair with return code (0 on success, error code otherwise) and SignalInformation object for accepted signal; - * error codes: - * - EINTR - the wait was interrupted by an unmasked, caught signal; - * - ENOTSUP - reception of signals is disabled for current thread; - */ - -std::pair<int, SignalInformation> wait(const SignalSet& signalSet); - -/// \} - -} // namespace Signals - -} // namespace ThisThread - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_THISTHREAD_SIGNALS_HPP_ diff --git a/include/distortos/ThisThread.hpp b/include/distortos/ThisThread.hpp deleted file mode 100644 index 5528412..0000000 --- a/include/distortos/ThisThread.hpp +++ /dev/null @@ -1,158 +0,0 @@ -/** - * \file - * \brief ThisThread namespace header - * - * \author Copyright (C) 2014-2016 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_THISTHREAD_HPP_ -#define INCLUDE_DISTORTOS_THISTHREAD_HPP_ - -#include "distortos/TickClock.hpp" - -namespace distortos -{ - -class Thread; - -namespace ThisThread -{ - -/// \addtogroup threads -/// \{ - -#ifdef CONFIG_THREAD_DETACH_ENABLE - -/** - * \brief Detaches calling (current) thread. - * - * Similar to std::thread::detach() - http://en.cppreference.com/w/cpp/thread/thread/detach - * Similar to POSIX pthread_detach() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_detach.html - * - * Detaches calling (current) thread from its Thread object, allowing execution to continue independently. All resources - * allocated for the thread will be deallocated when the thread terminates. - * - * \return 0 on success, error code otherwise: - * - EINVAL - current thread is already detached; - * - ENOTSUP - current thread cannot be detached; - */ - -int detach(); - -#endif // def CONFIG_THREAD_DETACH_ENABLE - -/** - * \return reference to Thread object of currently active thread - */ - -Thread& get(); - -/** - * \return effective priority of calling (current) thread - */ - -uint8_t getEffectivePriority(); - -/** - * \return priority of calling (current) thread - */ - -uint8_t getPriority(); - -/** - * Changes priority of calling (current) thread. - * - * \param [in] priority is the new priority for thread - * \param [in] alwaysBehind selects the method of ordering when lowering the priority - * - false - the thread is moved to the head of the group of threads with the new priority (default), - * - true - the thread is moved to the tail of the group of threads with the new priority. - */ - -void setPriority(uint8_t priority, bool alwaysBehind = {}); - -/** - * \brief Makes the calling (current) thread sleep for at least given duration. - * - * Current thread's state is changed to "sleeping". - * - * \note To fulfill the "at least" requirement, one additional tick is always added to the sleep duration. - * - * \param [in] duration is the duration after which the thread will be woken - * - * \return 0 on success, error code otherwise: - * - EINTR - the sleep was interrupted by an unmasked, caught signal; - */ - -int sleepFor(TickClock::duration duration); - -/** - * \brief Makes the calling (current) thread sleep for at least given duration. - * - * Current thread's state is changed to "sleeping". - * - * \note To fulfill the "at least" requirement, one additional tick is always added to the sleep duration. - * - * \tparam Rep is type of tick counter - * \tparam Period is std::ratio type representing the tick period of the clock, in seconds - * - * \param [in] duration is the duration after which the thread will be woken - * - * \return 0 on success, error code otherwise: - * - EINTR - the sleep was interrupted by an unmasked, caught signal; - */ - -template<typename Rep, typename Period> -int sleepFor(const std::chrono::duration<Rep, Period> duration) -{ - return sleepFor(std::chrono::duration_cast<TickClock::duration>(duration)); -} - -/** - * \brief Makes the calling (current) thread sleep until some time point is reached. - * - * Current thread's state is changed to "sleeping". - * - * \param [in] timePoint is the time point at which the thread will be woken - * - * \return 0 on success, error code otherwise: - * - EINTR - the sleep was interrupted by an unmasked, caught signal; - */ - -int sleepUntil(TickClock::time_point timePoint); - -/** - * \brief Makes the calling (current) thread sleep until some time point is reached. - * - * Current thread's state is changed to "sleeping". - * - * \tparam Duration is a std::chrono::duration type used to measure duration - * - * \param [in] timePoint is the time point at which the thread will be woken - * - * \return 0 on success, error code otherwise: - * - EINTR - the sleep was interrupted by an unmasked, caught signal; - */ - -template<typename Duration> -int sleepUntil(const std::chrono::time_point<TickClock, Duration> timePoint) -{ - return sleepUntil(std::chrono::time_point_cast<TickClock::duration>(timePoint)); -} - -/** - * \brief Yields time slot of the scheduler to next thread. - */ - -void yield(); - -/// \} - -} // namespace ThisThread - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_THISTHREAD_HPP_ diff --git a/include/distortos/Thread.hpp b/include/distortos/Thread.hpp deleted file mode 100644 index 54139c1..0000000 --- a/include/distortos/Thread.hpp +++ /dev/null @@ -1,194 +0,0 @@ -/** - * \file - * \brief Thread class header - * - * \author Copyright (C) 2014-2016 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_THREAD_HPP_ -#define INCLUDE_DISTORTOS_THREAD_HPP_ - -#include "distortos/distortosConfiguration.h" - -#include "distortos/SchedulingPolicy.hpp" -#include "distortos/SignalSet.hpp" -#include "distortos/ThreadState.hpp" - -#include <csignal> - -namespace distortos -{ - -/** - * \brief Thread class is a pure abstract interface for threads - * - * \ingroup threads - */ - -class Thread -{ -public: - - /** - * \brief Thread's destructor - */ - - virtual ~Thread() = 0; - -#ifdef CONFIG_THREAD_DETACH_ENABLE - - /** - * \brief Detaches the thread. - * - * Similar to std::thread::detach() - http://en.cppreference.com/w/cpp/thread/thread/detach - * Similar to POSIX pthread_detach() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_detach.html - * - * Detaches the executing thread from the Thread object, allowing execution to continue independently. All resources - * allocated for the thread will be deallocated when the thread terminates. - * - * \return 0 on success, error code otherwise: - * - EINVAL - this thread is already detached; - * - ENOTSUP - this thread cannot be detached; - */ - - virtual int detach() = 0; - -#endif // def CONFIG_THREAD_DETACH_ENABLE - - /** - * \brief Generates signal for thread. - * - * Similar to pthread_kill() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_kill.html - * - * Adds the signalNumber to set of pending signals. If this thread is currently waiting for this signal, it will be - * unblocked. - * - * \param [in] signalNumber is the signal that will be generated, [0; 31] - * - * \return 0 on success, error code otherwise: - * - EINVAL - \a signalNumber value is invalid; - * - ENOTSUP - reception of signals is disabled for this thread; - * - * \ingroup signals - */ - - virtual int generateSignal(uint8_t signalNumber) = 0; - - /** - * \return effective priority of thread - */ - - virtual uint8_t getEffectivePriority() const = 0; - - /** - * \brief Gets set of currently pending signals. - * - * Similar to sigpending() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sigpending.html - * - * This function shall return the set of signals that are blocked from delivery and are pending on the thread. - * - * \return set of currently pending signals - * - * \ingroup signals - */ - - virtual SignalSet getPendingSignalSet() const = 0; - - /** - * \return priority of thread - */ - - virtual uint8_t getPriority() const = 0; - - /** - * \return scheduling policy of the thread - */ - - virtual SchedulingPolicy getSchedulingPolicy() const = 0; - - /** - * \return current state of thread - */ - - virtual ThreadState getState() const = 0; - - /** - * \brief Waits for thread termination. - * - * Similar to std::thread::join() - http://en.cppreference.com/w/cpp/thread/thread/join - * Similar to POSIX pthread_join() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_join.html - * - * Blocks current thread until this thread finishes its execution. The results of multiple simultaneous calls to - * join() on the same target thread are undefined. - * - * \return 0 on success, error code otherwise: - * - EDEADLK - deadlock condition was detected, - * - EINVAL - this thread is not joinable, - * - ... - * - * \ingroup synchronization - */ - - virtual int join() = 0; - - /** - * \brief Queues signal for thread. - * - * Similar to sigqueue() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sigqueue.html - * - * Adds the signalNumber and signal value (sigval union) to queue of SignalInformation objects. If this thread is - * currently waiting for this signal, it will be unblocked. - * - * \param [in] signalNumber is the signal that will be queued, [0; 31] - * \param [in] value is the signal value - * - * \return 0 on success, error code otherwise: - * - EAGAIN - no resources are available to queue the signal, maximal number of signals is already queued in - * associated queue of SignalInformation objects; - * - EINVAL - \a signalNumber value is invalid; - * - ENOTSUP - reception or queuing of signals are disabled for this thread; - * - * \ingroup signals - */ - - virtual int queueSignal(uint8_t signalNumber, sigval value) = 0; - - /** - * \brief Changes priority of thread. - * - * If the priority really changes, the position in the thread list is adjusted and context switch may be requested. - * - * \param [in] priority is the new priority of thread - * \param [in] alwaysBehind selects the method of ordering when lowering the priority - * - false - the thread is moved to the head of the group of threads with the new priority (default), - * - true - the thread is moved to the tail of the group of threads with the new priority. - */ - - virtual void setPriority(uint8_t priority, bool alwaysBehind = {}) = 0; - - /** - * param [in] schedulingPolicy is the new scheduling policy of the thread - */ - - virtual void setSchedulingPolicy(SchedulingPolicy schedulingPolicy) = 0; - - /** - * \brief Starts the thread. - * - * This operation can be performed on threads in "New" state only. - * - * \return 0 on success, error code otherwise: - * - EINVAL - thread is already started; - * - error codes returned by scheduler::Scheduler::add(); - */ - - virtual int start() = 0; -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_THREAD_HPP_ diff --git a/include/distortos/ThreadCommon.hpp b/include/distortos/ThreadCommon.hpp deleted file mode 100644 index 8f34290..0000000 --- a/include/distortos/ThreadCommon.hpp +++ /dev/null @@ -1,230 +0,0 @@ -/** - * \file - * \brief ThreadCommon class header - * - * \author Copyright (C) 2015-2016 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_THREADCOMMON_HPP_ -#define INCLUDE_DISTORTOS_THREADCOMMON_HPP_ - -#include "distortos/internal/scheduler/ThreadControlBlock.hpp" - -#include "distortos/Semaphore.hpp" -#include "distortos/Thread.hpp" - -namespace distortos -{ - -/** - * \brief ThreadCommon class implements common functionality of threads - * - * \ingroup threads - */ - -class ThreadCommon : public Thread -{ -public: - - /// unique_ptr (with deleter) to storage for stack - using StackStorageUniquePointer = architecture::Stack::StorageUniquePointer; - - /** - * \brief ThreadCommon's constructor - * - * \param [in] stack is an rvalue reference to architecture::Stack object which will be adopted for this thread - * \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest - * \param [in] schedulingPolicy is the scheduling policy of the thread - * \param [in] threadGroupControlBlock is a pointer to internal::ThreadGroupControlBlock to which this object will - * be added, nullptr to inherit thread group from currently running thread - * \param [in] signalsReceiver is a pointer to SignalsReceiver object for this thread, nullptr to disable reception - * of signals for this thread - */ - - ThreadCommon(architecture::Stack&& stack, uint8_t priority, SchedulingPolicy schedulingPolicy, - internal::ThreadGroupControlBlock* threadGroupControlBlock, SignalsReceiver* signalsReceiver); - - /** - * \brief ThreadCommon's destructor - */ - - ~ThreadCommon() override; - - /** - * \brief Generates signal for thread. - * - * Similar to pthread_kill() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_kill.html - * - * Adds the signalNumber to set of pending signals. If this thread is currently waiting for this signal, it will be - * unblocked. - * - * \param [in] signalNumber is the signal that will be generated, [0; 31] - * - * \return 0 on success, error code otherwise: - * - EINVAL - \a signalNumber value is invalid; - * - ENOTSUP - reception of signals is disabled for this thread; - * - * \ingroup signals - */ - - int generateSignal(uint8_t signalNumber) override; - - /** - * \return effective priority of thread - */ - - uint8_t getEffectivePriority() const override; - - /** - * \brief Gets set of currently pending signals. - * - * Similar to sigpending() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sigpending.html - * - * This function shall return the set of signals that are blocked from delivery and are pending on the thread. - * - * \return set of currently pending signals - * - * \ingroup signals - */ - - SignalSet getPendingSignalSet() const override; - - /** - * \return priority of thread - */ - - uint8_t getPriority() const override; - - /** - * \return scheduling policy of the thread - */ - - SchedulingPolicy getSchedulingPolicy() const override; - - /** - * \return current state of thread - */ - - ThreadState getState() const override; - - /** - * \brief Waits for thread termination. - * - * Similar to std::thread::join() - http://en.cppreference.com/w/cpp/thread/thread/join - * Similar to POSIX pthread_join() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_join.html - * - * Blocks current thread until this thread finishes its execution. The results of multiple simultaneous calls to - * join() on the same target thread are undefined. - * - * \return 0 on success, error code otherwise: - * - EDEADLK - deadlock condition was detected, - * - EINVAL - this thread is not joinable, - * - ... - * - * \ingroup synchronization - */ - - int join() override; - - /** - * \brief Queues signal for thread. - * - * Similar to sigqueue() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sigqueue.html - * - * Adds the signalNumber and signal value (sigval union) to queue of SignalInformation objects. If this thread is - * currently waiting for this signal, it will be unblocked. - * - * \param [in] signalNumber is the signal that will be queued, [0; 31] - * \param [in] value is the signal value - * - * \return 0 on success, error code otherwise: - * - EAGAIN - no resources are available to queue the signal, maximal number of signals is already queued in - * associated queue of SignalInformation objects; - * - EINVAL - \a signalNumber value is invalid; - * - ENOTSUP - reception or queuing of signals are disabled for this thread; - * - * \ingroup signals - */ - - int queueSignal(uint8_t signalNumber, sigval value) override; - - /** - * \brief Changes priority of thread. - * - * If the priority really changes, the position in the thread list is adjusted and context switch may be requested. - * - * \param [in] priority is the new priority of thread - * \param [in] alwaysBehind selects the method of ordering when lowering the priority - * - false - the thread is moved to the head of the group of threads with the new priority (default), - * - true - the thread is moved to the tail of the group of threads with the new priority. - */ - - void setPriority(uint8_t priority, bool alwaysBehind = {}) override; - - /** - * param [in] schedulingPolicy is the new scheduling policy of the thread - */ - - void setSchedulingPolicy(SchedulingPolicy schedulingPolicy) override; - - /** - * \brief Starts the thread. - * - * This operation can be performed on threads in "New" state only. - * - * \return 0 on success, error code otherwise: - * - EINVAL - thread is already started; - * - error codes returned by internal::Scheduler::add(); - */ - - int start() override; - - ThreadCommon(const ThreadCommon&) = delete; - ThreadCommon(ThreadCommon&&) = default; - const ThreadCommon& operator=(const ThreadCommon&) = delete; - ThreadCommon& operator=(ThreadCommon&&) = delete; - -protected: - - /** - * \return reference to internal ThreadControlBlock object - */ - - internal::ThreadControlBlock& getThreadControlBlock() - { - return threadControlBlock_; - } - - /** - * \return const reference to internal ThreadControlBlock object - */ - - const internal::ThreadControlBlock& getThreadControlBlock() const - { - return threadControlBlock_; - } - - /** - * \brief Termination hook function of thread - * - * \param [in] thread is a reference to Thread object, this must be ThreadCommon! - */ - - static void terminationHook(Thread& thread); - -private: - - /// internal ThreadControlBlock object - internal::ThreadControlBlock threadControlBlock_; - - /// semaphore used by join() - Semaphore joinSemaphore_; -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_THREADCOMMON_HPP_ diff --git a/include/distortos/ThreadState.hpp b/include/distortos/ThreadState.hpp deleted file mode 100644 index 15a92e3..0000000 --- a/include/distortos/ThreadState.hpp +++ /dev/null @@ -1,54 +0,0 @@ -/** - * \file - * \brief ThreadState enum class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_THREADSTATE_HPP_ -#define INCLUDE_DISTORTOS_THREADSTATE_HPP_ - -#include <cstdint> - -namespace distortos -{ - -/** - * \brief state of the thread - * - * \ingroup threads - */ - -enum class ThreadState : uint8_t -{ - /// state in which thread is created, before being added to Scheduler - created, - /// thread is runnable - runnable, - /// thread is terminated - terminated, - /// thread is sleeping - sleeping, - /// thread is blocked on Semaphore - blockedOnSemaphore, - /// thread is suspended - suspended, - /// thread is blocked on Mutex - blockedOnMutex, - /// thread is blocked on ConditionVariable - blockedOnConditionVariable, - /// thread is waiting for signal - waitingForSignal, - /// thread is blocked on OnceFlag - blockedOnOnceFlag, - /// internal thread object was detached - detached, -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_THREADSTATE_HPP_ diff --git a/include/distortos/TickClock.hpp b/include/distortos/TickClock.hpp deleted file mode 100644 index 7f1ace0..0000000 --- a/include/distortos/TickClock.hpp +++ /dev/null @@ -1,56 +0,0 @@ -/** - * \file - * \brief TickClock class header - * - * \author Copyright (C) 2014-2016 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_TICKCLOCK_HPP_ -#define INCLUDE_DISTORTOS_TICKCLOCK_HPP_ - -#include "distortos/distortosConfiguration.h" - -#include <chrono> - -namespace distortos -{ - -/** - * \brief TickClock is a std::chrono clock, equivalent of std::chrono::steady_clock - * - * \ingroup clocks - */ - -class TickClock -{ -public: - - /// type of tick counter - using rep = uint64_t; - - /// std::ratio type representing the tick period of the clock, in seconds - using period = std::ratio<1, CONFIG_TICK_FREQUENCY>; - - /// basic duration type of clock - using duration = std::chrono::duration<rep, period>; - - /// basic time_point type of clock - using time_point = std::chrono::time_point<TickClock>; - - /** - * \return time_point representing the current value of the clock - */ - - static time_point now(); - - /// this is a steady clock - it cannot be adjusted - static constexpr bool is_steady {true}; -}; - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_TICKCLOCK_HPP_ diff --git a/include/distortos/UndetachableThread.hpp b/include/distortos/UndetachableThread.hpp deleted file mode 100644 index 772b9aa..0000000 --- a/include/distortos/UndetachableThread.hpp +++ /dev/null @@ -1,57 +0,0 @@ -/** - * \file - * \brief UndetachableThread class header - * - * \author Copyright (C) 2015-2016 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_UNDETACHABLETHREAD_HPP_ -#define INCLUDE_DISTORTOS_UNDETACHABLETHREAD_HPP_ - -#include "distortos/ThreadCommon.hpp" - -namespace distortos -{ - -/** - * \brief UndetachableThread class is a ThreadCommon that cannot be detached - * - * \ingroup threads - */ - -#ifdef CONFIG_THREAD_DETACH_ENABLE - -class UndetachableThread : public ThreadCommon -{ -public: - - using ThreadCommon::ThreadCommon; - - /** - * \brief Detaches the thread. - * - * Similar to std::thread::detach() - http://en.cppreference.com/w/cpp/thread/thread/detach - * Similar to POSIX pthread_detach() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_detach.html - * - * Detaches the executing thread from the Thread object, allowing execution to continue independently. All resources - * allocated for the thread will be deallocated when the thread terminates. - * - * \return ENOTSUP - this thread cannot be detached; - */ - - int detach() override; -}; - -#else // !def CONFIG_THREAD_DETACH_ENABLE - -using UndetachableThread = ThreadCommon; - -#endif // !def CONFIG_THREAD_DETACH_ENABLE - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_UNDETACHABLETHREAD_HPP_ diff --git a/include/distortos/architecture/InterruptMaskingLock.hpp b/include/distortos/architecture/InterruptMaskingLock.hpp deleted file mode 100644 index 6f8253b..0000000 --- a/include/distortos/architecture/InterruptMaskingLock.hpp +++ /dev/null @@ -1,34 +0,0 @@ -/** - * \file - * \brief InterruptMaskingLock class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_ARCHITECTURE_INTERRUPTMASKINGLOCK_HPP_ -#define INCLUDE_DISTORTOS_ARCHITECTURE_INTERRUPTMASKINGLOCK_HPP_ - -#include "distortos/architecture/InterruptMaskingUnmaskingLock.hpp" -#include "distortos/architecture/enableInterruptMasking.hpp" - -namespace distortos -{ - -namespace architecture -{ - -/// InterruptMaskingLock class is a RAII wrapper for enableInterruptMasking() / restoreInterruptMasking() -class InterruptMaskingLock : private InterruptMaskingUnmaskingLock<enableInterruptMasking> -{ - -}; - -} // namespace architecture - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_ARCHITECTURE_INTERRUPTMASKINGLOCK_HPP_ diff --git a/include/distortos/architecture/InterruptMaskingUnmaskingLock.hpp b/include/distortos/architecture/InterruptMaskingUnmaskingLock.hpp deleted file mode 100644 index 65bd0f0..0000000 --- a/include/distortos/architecture/InterruptMaskingUnmaskingLock.hpp +++ /dev/null @@ -1,73 +0,0 @@ -/** - * \file - * \brief InterruptMaskingUnmaskingLock class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_ARCHITECTURE_INTERRUPTMASKINGUNMASKINGLOCK_HPP_ -#define INCLUDE_DISTORTOS_ARCHITECTURE_INTERRUPTMASKINGUNMASKINGLOCK_HPP_ - -#include "distortos/architecture/restoreInterruptMasking.hpp" - -namespace distortos -{ - -namespace architecture -{ - -/** - * \brief InterruptMaskingUnmaskingLock class is a RAII wrapper for interrupt mask manipulation. - * - * \tparam Function is a reference to function which modifies interrupt mask and returns InterruptMask; - * enableInterruptMasking() or disableInterruptMasking() should be used - */ - -template<InterruptMask (& Function)()> -class InterruptMaskingUnmaskingLock -{ -public: - - /** - * \brief InterruptMaskingUnmaskingLock's constructor - * - * Enables/disables interrupt masking, saving current interrupt mask for use in destructor. - */ - - InterruptMaskingUnmaskingLock() : - interruptMask_{Function()} - { - - } - - /** - * \brief InterruptMaskingUnmaskingLock's destructor - * - * Restores previous interrupt masking state by restoring interrupt mask saved in constructor. - */ - - ~InterruptMaskingUnmaskingLock() - { - restoreInterruptMasking(interruptMask_); - } - - InterruptMaskingUnmaskingLock(const InterruptMaskingUnmaskingLock&) = delete; - InterruptMaskingUnmaskingLock(InterruptMaskingUnmaskingLock&&) = delete; - InterruptMaskingUnmaskingLock& operator=(const InterruptMaskingUnmaskingLock&) = delete; - InterruptMaskingUnmaskingLock& operator=(InterruptMaskingUnmaskingLock&&) = delete; - -private: - - /// interrupt mask - const InterruptMask interruptMask_; -}; - -} // namespace architecture - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_ARCHITECTURE_INTERRUPTMASKINGUNMASKINGLOCK_HPP_ diff --git a/include/distortos/architecture/InterruptUnmaskingLock.hpp b/include/distortos/architecture/InterruptUnmaskingLock.hpp deleted file mode 100644 index 263bbea..0000000 --- a/include/distortos/architecture/InterruptUnmaskingLock.hpp +++ /dev/null @@ -1,34 +0,0 @@ -/** - * \file - * \brief InterruptUnmaskingLock class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_ARCHITECTURE_INTERRUPTUNMASKINGLOCK_HPP_ -#define INCLUDE_DISTORTOS_ARCHITECTURE_INTERRUPTUNMASKINGLOCK_HPP_ - -#include "distortos/architecture/InterruptMaskingUnmaskingLock.hpp" -#include "distortos/architecture/disableInterruptMasking.hpp" - -namespace distortos -{ - -namespace architecture -{ - -/// InterruptUnmaskingLock class is a RAII wrapper for disableInterruptMasking() / restoreInterruptMasking() -class InterruptUnmaskingLock : private InterruptMaskingUnmaskingLock<disableInterruptMasking> -{ - -}; - -} // namespace architecture - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_ARCHITECTURE_INTERRUPTUNMASKINGLOCK_HPP_ diff --git a/include/distortos/architecture/Stack.hpp b/include/distortos/architecture/Stack.hpp deleted file mode 100644 index bd23452..0000000 --- a/include/distortos/architecture/Stack.hpp +++ /dev/null @@ -1,122 +0,0 @@ -/** - * \file - * \brief Stack class header - * - * \author Copyright (C) 2014-2016 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_ARCHITECTURE_STACK_HPP_ -#define INCLUDE_DISTORTOS_ARCHITECTURE_STACK_HPP_ - -#include <memory> - -namespace distortos -{ - -class Thread; - -namespace architecture -{ - -/// Stack class is an abstraction of architecture's stack -class Stack -{ -public: - - /// unique_ptr (with deleter) to storage - using StorageUniquePointer = std::unique_ptr<void, void(&)(void*)>; - - /** - * \brief Stack's constructor - * - * This function initializes valid architecture-specific stack in provided storage. This requires following steps: - * - adjustment of storage's address to suit architecture's alignment requirements, - * - adjustment of storage's size to suit architecture's divisibility requirements, - * - creating hardware and software stack frame in suitable place in the stack, - * - calculation of stack pointer register value. - * - * After this constructor completes, stack is ready for context switching. - * - * \param [in] storageUniquePointer is a rvalue reference to StorageUniquePointer with storage for stack (\a size - * bytes long) and appropriate deleter - * \param [in] size is the size of stack's storage, bytes - * \param [in] thread is a reference to Thread object passed to function - * \param [in] run is a reference to Thread's "run" function - * \param [in] preTerminationHook is a pointer to Thread's pre-termination hook, nullptr to skip - * \param [in] terminationHook is a reference to Thread's termination hook - */ - - Stack(StorageUniquePointer&& storageUniquePointer, size_t size, Thread& thread, void (& run)(Thread&), - void (* preTerminationHook)(Thread&), void (& terminationHook)(Thread&)); - - /** - * \brief Stack's constructor - * - * This function adopts existing valid architecture-specific stack in provided storage. No adjustments are done, - * no stack frame is created and stack pointer register's value is not calculated. - * - * This is meant to adopt main()'s stack. - * - * \param [in] storage is a pointer to stack's storage - * \param [in] size is the size of stack's storage, bytes - */ - - Stack(void* storage, size_t size); - - /** - * \brief Stack's destructor - */ - - ~Stack(); - - /** - * \brief Gets current value of stack pointer. - * - * \return current value of stack pointer - */ - - void* getStackPointer() const - { - return stackPointer_; - } - - /** - * \brief Sets value of stack pointer. - * - * \param [in] stackPointer is the new value of stack pointer - */ - - void setStackPointer(void* const stackPointer) - { - stackPointer_ = stackPointer; - } - - Stack(const Stack&) = delete; - Stack(Stack&&) = default; - const Stack& operator=(const Stack&) = delete; - Stack& operator=(Stack&&) = delete; - -private: - - /// storage for stack - StorageUniquePointer storageUniquePointer_; - - /// adjusted address of stack's storage - void* const adjustedStorage_; - - /// adjusted size of stack's storage - const size_t adjustedSize_; - - /// current value of stack pointer register - void* stackPointer_; -}; - -} // namespace architecture - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_ARCHITECTURE_STACK_HPP_ diff --git a/include/distortos/architecture/disableInterruptMasking.hpp b/include/distortos/architecture/disableInterruptMasking.hpp deleted file mode 100644 index d82eda1..0000000 --- a/include/distortos/architecture/disableInterruptMasking.hpp +++ /dev/null @@ -1,37 +0,0 @@ -/** - * \file - * \brief disableInterruptMasking() declaration - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_ARCHITECTURE_DISABLEINTERRUPTMASKING_HPP_ -#define INCLUDE_DISTORTOS_ARCHITECTURE_DISABLEINTERRUPTMASKING_HPP_ - -#include "distortos/architecture/parameters.hpp" - -namespace distortos -{ - -namespace architecture -{ - -/** - * \brief Disables interrupt masking. - * - * Enables normal-priority interrupts. - * - * \return previous value of interrupts' mask, must be used for matched restoreInterruptMasking() call - */ - -InterruptMask disableInterruptMasking(); - -} // namespace architecture - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_ARCHITECTURE_DISABLEINTERRUPTMASKING_HPP_ diff --git a/include/distortos/architecture/enableInterruptMasking.hpp b/include/distortos/architecture/enableInterruptMasking.hpp deleted file mode 100644 index 8fb6566..0000000 --- a/include/distortos/architecture/enableInterruptMasking.hpp +++ /dev/null @@ -1,40 +0,0 @@ -/** - * \file - * \brief enableInterruptMasking() declaration - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_ARCHITECTURE_ENABLEINTERRUPTMASKING_HPP_ -#define INCLUDE_DISTORTOS_ARCHITECTURE_ENABLEINTERRUPTMASKING_HPP_ - -#include "distortos/architecture/parameters.hpp" - -namespace distortos -{ - -namespace architecture -{ - -/** - * \brief Enables interrupt masking. - * - * Disables normal-priority interrupts. - * - * \note High-priority interrupts are not controlled by distortos, so they may be left enabled. Support for that feature - * is architecture-dependent. - * - * \return previous value of interrupts' mask, must be used for matched restoreInterruptMasking() call - */ - -InterruptMask enableInterruptMasking(); - -} // namespace architecture - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_ARCHITECTURE_ENABLEINTERRUPTMASKING_HPP_ diff --git a/include/distortos/architecture/getMainStack.hpp b/include/distortos/architecture/getMainStack.hpp deleted file mode 100644 index 6f75c2b..0000000 --- a/include/distortos/architecture/getMainStack.hpp +++ /dev/null @@ -1,37 +0,0 @@ -/** - * \file - * \brief getMainStack() declaration - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_ARCHITECTURE_GETMAINSTACK_HPP_ -#define INCLUDE_DISTORTOS_ARCHITECTURE_GETMAINSTACK_HPP_ - -#include <utility> - -#include <cstddef> - -namespace distortos -{ - -namespace architecture -{ - -/** - * \brief Gets the stack used to run main(). - * - * \return beginning of stack and its size in bytes - */ - -std::pair<void*, size_t> getMainStack(); - -} // namespace architecture - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_ARCHITECTURE_GETMAINSTACK_HPP_ diff --git a/include/distortos/architecture/initializeStack.hpp b/include/distortos/architecture/initializeStack.hpp deleted file mode 100644 index 6cc73ae..0000000 --- a/include/distortos/architecture/initializeStack.hpp +++ /dev/null @@ -1,50 +0,0 @@ -/** - * \file - * \brief initializeStack() declaration - * - * \author Copyright (C) 2014-2016 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_ARCHITECTURE_INITIALIZESTACK_HPP_ -#define INCLUDE_DISTORTOS_ARCHITECTURE_INITIALIZESTACK_HPP_ - -#include <cstddef> - -namespace distortos -{ - -class Thread; - -namespace architecture -{ - -/** - * \brief Architecture-specific stack initialization. - * - * This function fills provided buffer with hardware and software stack frame and calculates value of stack pointer - * register. After this function completes, stack is ready for context switching. - * - * \attention buffer and size must be properly adjusted for architecture requirements - * - * \param [in] buffer is a pointer to stack's buffer - * \param [in] size is the size of stack's buffer, bytes - * \param [in] thread is a reference to Thread object passed to function - * \param [in] run is a reference to Thread's "run" function - * \param [in] preTerminationHook is a pointer to Thread's pre-termination hook, nullptr to skip - * \param [in] terminationHook is a reference to Thread's termination hook - * - * \return value that can be used as thread's stack pointer, ready for context switching - */ - -void* initializeStack(void* buffer, size_t size, Thread& thread, void (& run)(Thread&), - void (* preTerminationHook)(Thread&), void (& terminationHook)(Thread&)); - -} // namespace architecture - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_ARCHITECTURE_INITIALIZESTACK_HPP_ diff --git a/include/distortos/architecture/lowLevelInitialization.hpp b/include/distortos/architecture/lowLevelInitialization.hpp deleted file mode 100644 index 4c9d3d2..0000000 --- a/include/distortos/architecture/lowLevelInitialization.hpp +++ /dev/null @@ -1,34 +0,0 @@ -/** - * \file - * \brief lowLevelInitialization() declaration - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_ARCHITECTURE_LOWLEVELINITIALIZATION_HPP_ -#define INCLUDE_DISTORTOS_ARCHITECTURE_LOWLEVELINITIALIZATION_HPP_ - -namespace distortos -{ - -namespace architecture -{ - -/** - * \brief Low level architecture initialization. - * - * This function is called before constructors for global and static objects from __libc_init_array() via address in - * distortosPreinitArray[]. - */ - -void lowLevelInitialization(); - -} // namespace architecture - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_ARCHITECTURE_LOWLEVELINITIALIZATION_HPP_ diff --git a/include/distortos/architecture/requestContextSwitch.hpp b/include/distortos/architecture/requestContextSwitch.hpp deleted file mode 100644 index bc92b6b..0000000 --- a/include/distortos/architecture/requestContextSwitch.hpp +++ /dev/null @@ -1,35 +0,0 @@ -/** - * \file - * \brief requestContextSwitch() declaration - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_ARCHITECTURE_REQUESTCONTEXTSWITCH_HPP_ -#define INCLUDE_DISTORTOS_ARCHITECTURE_REQUESTCONTEXTSWITCH_HPP_ - -namespace distortos -{ - -namespace architecture -{ - -/** - * \brief Architecture-specific request for context switch. - * - * Causes the architecture to do context save, call scheduler::getScheduler().switchContext() and do context restore. - * The call to scheduler::getScheduler().switchContext() must be done from the context in which such call is valid - * (usually system interrupt). - */ - -void requestContextSwitch(); - -} // namespace architecture - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_ARCHITECTURE_REQUESTCONTEXTSWITCH_HPP_ diff --git a/include/distortos/architecture/requestFunctionExecution.hpp b/include/distortos/architecture/requestFunctionExecution.hpp deleted file mode 100644 index 69c9eda..0000000 --- a/include/distortos/architecture/requestFunctionExecution.hpp +++ /dev/null @@ -1,53 +0,0 @@ -/** - * \file - * \brief requestFunctionExecution() declaration - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_ARCHITECTURE_REQUESTFUNCTIONEXECUTION_HPP_ -#define INCLUDE_DISTORTOS_ARCHITECTURE_REQUESTFUNCTIONEXECUTION_HPP_ - -namespace distortos -{ - -namespace internal -{ - -class ThreadControlBlock; - -} // namespace internal - -namespace architecture -{ - -/** - * \brief Requests execution of provided function in the specified thread. - * - * Main use case for this function is to request execution of signals delivery function. In such case it is called when - * an unblocked signal, which is not ignored, is generated or queued for specified thread. - * - * It must arrange for given function to be executed in specified thread as soon as possible. This generally requires - * dealing with following scenarios: - * - current thread is sending the request to itself - in that case just execute function right away; - * - current thread is sending the request to non-current thread; - * - interrupt is sending the request to current thread; - * - interrupt is sending the request to non-current thread; - * - * \param [in] threadControlBlock is a reference to internal::ThreadControlBlock of thread in which \a function should - * be executed - * \param [in] function is a reference to function that should be executed in thread associated with - * \a threadControlBlock - */ - -void requestFunctionExecution(internal::ThreadControlBlock& threadControlBlock, void (& function)()); - -} // namespace architecture - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_ARCHITECTURE_REQUESTFUNCTIONEXECUTION_HPP_ diff --git a/include/distortos/architecture/restoreInterruptMasking.hpp b/include/distortos/architecture/restoreInterruptMasking.hpp deleted file mode 100644 index 268159b..0000000 --- a/include/distortos/architecture/restoreInterruptMasking.hpp +++ /dev/null @@ -1,39 +0,0 @@ -/** - * \file - * \brief restoreInterruptMasking() declaration - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_ARCHITECTURE_RESTOREINTERRUPTMASKING_HPP_ -#define INCLUDE_DISTORTOS_ARCHITECTURE_RESTOREINTERRUPTMASKING_HPP_ - -#include "distortos/architecture/parameters.hpp" - -namespace distortos -{ - -namespace architecture -{ - -/** - * \brief Restores interrupt masking. - * - * Restores previous interrupt masking state (before matching enableInterruptMasking() or disableInterruptMasking() was - * called), enabling some (maybe all, maybe none) interrupts. - * - * \param [in] interruptMask is the value of interrupts' mask, must come from previous call to enableInterruptMasking() - * or disableInterruptMasking() - */ - -void restoreInterruptMasking(InterruptMask interruptMask); - -} // namespace architecture - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_ARCHITECTURE_RESTOREINTERRUPTMASKING_HPP_ diff --git a/include/distortos/architecture/startScheduling.hpp b/include/distortos/architecture/startScheduling.hpp deleted file mode 100644 index 20db514..0000000 --- a/include/distortos/architecture/startScheduling.hpp +++ /dev/null @@ -1,33 +0,0 @@ -/** - * \file - * \brief startScheduling() declaration - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_ARCHITECTURE_STARTSCHEDULING_HPP_ -#define INCLUDE_DISTORTOS_ARCHITECTURE_STARTSCHEDULING_HPP_ - -namespace distortos -{ - -namespace architecture -{ - -/** - * \brief Architecture-specific start of scheduling. - * - * Initializes all required hardware/software to perform context switching and starts the scheduling. - */ - -void startScheduling(); - -} // namespace architecture - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_ARCHITECTURE_STARTSCHEDULING_HPP_ diff --git a/include/distortos/board/lowLevelInitialization.hpp b/include/distortos/board/lowLevelInitialization.hpp deleted file mode 100644 index 6007422..0000000 --- a/include/distortos/board/lowLevelInitialization.hpp +++ /dev/null @@ -1,36 +0,0 @@ -/** - * \file - * \brief board::lowLevelInitialization() declaration - * - * \author Copyright (C) 2016 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_BOARD_LOWLEVELINITIALIZATION_HPP_ -#define INCLUDE_DISTORTOS_BOARD_LOWLEVELINITIALIZATION_HPP_ - -namespace distortos -{ - -namespace board -{ - -/** - * \brief Low level board initialization. - * - * This function is called before constructors for global and static objects from __libc_init_array() via address in - * distortosPreinitArray[]. - * - * \note Use of this function is optional - it may be left undefined, in which case it will not be called. - */ - -void lowLevelInitialization() __attribute__ ((weak)); - -} // namespace board - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_BOARD_LOWLEVELINITIALIZATION_HPP_ diff --git a/include/distortos/callOnce.hpp b/include/distortos/callOnce.hpp deleted file mode 100644 index ed1cd1d..0000000 --- a/include/distortos/callOnce.hpp +++ /dev/null @@ -1,50 +0,0 @@ -/** - * \file - * \brief callOnce() header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_CALLONCE_HPP_ -#define INCLUDE_DISTORTOS_CALLONCE_HPP_ - -#include "distortos/OnceFlag.hpp" - -#if DISTORTOS_CALLONCE_SUPPORTED == 1 || DOXYGEN == 1 - -namespace distortos -{ - -/** - * \brief Executes the callable object exactly once, even if called from multiple threads. - * - * Similar to std::call_once() - http://en.cppreference.com/w/cpp/thread/call_once - * Similar to POSIX pthread_once() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_once.html# - * - * \note This function requires GCC 4.9. - * - * \tparam Function is the function object that will be executed - * \tparam Args are the arguments for \a Function - * - * \param [in] onceFlag is a reference to shared OnceFlag object - * \param [in] function is the function object that will be executed - * \param [in] args are arguments for \a function - * - * \ingroup synchronization - */ - -template<typename Function, typename... Args> -void callOnce(OnceFlag& onceFlag, Function&& function, Args&&... args) -{ - onceFlag.callOnceControlBlock_(std::forward<Function>(function), std::forward<Args>(args)...); -} - -} // namespace distortos - -#endif // DISTORTOS_CALLONCE_SUPPORTED == 1 || DOXYGEN == 1 - -#endif // INCLUDE_DISTORTOS_CALLONCE_HPP_ diff --git a/include/distortos/chip/lowLevelInitialization.hpp b/include/distortos/chip/lowLevelInitialization.hpp deleted file mode 100644 index f9e28ac..0000000 --- a/include/distortos/chip/lowLevelInitialization.hpp +++ /dev/null @@ -1,34 +0,0 @@ -/** - * \file - * \brief chip::lowLevelInitialization() declaration - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_CHIP_LOWLEVELINITIALIZATION_HPP_ -#define INCLUDE_DISTORTOS_CHIP_LOWLEVELINITIALIZATION_HPP_ - -namespace distortos -{ - -namespace chip -{ - -/** - * \brief Low level chip initialization. - * - * This function is called before constructors for global and static objects from __libc_init_array() via address in - * distortosPreinitArray[]. - */ - -void lowLevelInitialization(); - -} // namespace chip - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_CHIP_LOWLEVELINITIALIZATION_HPP_ diff --git a/include/distortos/devices/io/InputPin.hpp b/include/distortos/devices/io/InputPin.hpp deleted file mode 100644 index 9838998..0000000 --- a/include/distortos/devices/io/InputPin.hpp +++ /dev/null @@ -1,48 +0,0 @@ -/** - * \file - * \brief InputPin class header - * - * \author Copyright (C) 2016 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_DEVICES_IO_INPUTPIN_HPP_ -#define INCLUDE_DISTORTOS_DEVICES_IO_INPUTPIN_HPP_ - -namespace distortos -{ - -namespace devices -{ - -/** - * InputPin class is an interface for single input pin - * - * \ingroup devices - */ - -class InputPin -{ -public: - - /** - * \brief InputPin's destructor - */ - - virtual ~InputPin() = 0; - - /** - * \return current state of pin - */ - - virtual bool get() const = 0; -}; - -} // namespace devices - -} // namespace devices - -#endif // INCLUDE_DISTORTOS_DEVICES_IO_INPUTPIN_HPP_ diff --git a/include/distortos/devices/io/OutputPin.hpp b/include/distortos/devices/io/OutputPin.hpp deleted file mode 100644 index 6651d9d..0000000 --- a/include/distortos/devices/io/OutputPin.hpp +++ /dev/null @@ -1,46 +0,0 @@ -/** - * \file - * \brief OutputPin class header - * - * \author Copyright (C) 2016 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_DEVICES_IO_OUTPUTPIN_HPP_ -#define INCLUDE_DISTORTOS_DEVICES_IO_OUTPUTPIN_HPP_ - -#include "distortos/devices/io/InputPin.hpp" - -namespace distortos -{ - -namespace devices -{ - -/** - * OutputPin class is an interface for single output pin - * - * \ingroup devices - */ - -class OutputPin : public InputPin -{ -public: - - /** - * \brief Sets state of pin. - * - * \param [in] state is the new state of pin - */ - - virtual void set(bool state) = 0; -}; - -} // namespace devices - -} // namespace devices - -#endif // INCLUDE_DISTORTOS_DEVICES_IO_OUTPUTPIN_HPP_ diff --git a/include/distortos/distortosConfiguration.h b/include/distortos/distortosConfiguration.h deleted file mode 100644 index 831df6e..0000000 --- a/include/distortos/distortosConfiguration.h +++ /dev/null @@ -1,387 +0,0 @@ -/** - * \file - * \brief distortos configuration - * - * \warning - * Automatically generated file - do not edit! - * - * \date 2016-11-08 19:50:28 - */ - -#ifndef INCLUDE_DISTORTOS_DISTORTOSCONFIGURATION_H_ -#define INCLUDE_DISTORTOS_DISTORTOSCONFIGURATION_H_ - -#define CONFIG_CHIP_STM32 -#undef CONFIG_CHIP_STM32F0 -#define CONFIG_CHIP_STM32F1 -#undef CONFIG_CHIP_STM32F4 -#define CONFIG_BOARD_CUSTOM -#undef CONFIG_BOARD_NUCLEO_F103RB -#undef CONFIG_CHIP_STM32F100C4_SELECTED -#undef CONFIG_CHIP_STM32F100C6_SELECTED -#undef CONFIG_CHIP_STM32F100C8_SELECTED -#undef CONFIG_CHIP_STM32F100CB_SELECTED -#undef CONFIG_CHIP_STM32F100R4_SELECTED -#undef CONFIG_CHIP_STM32F100R6_SELECTED -#undef CONFIG_CHIP_STM32F100R8_SELECTED -#undef CONFIG_CHIP_STM32F100RB_SELECTED -#undef CONFIG_CHIP_STM32F100RC_SELECTED -#undef CONFIG_CHIP_STM32F100RD_SELECTED -#undef CONFIG_CHIP_STM32F100RE_SELECTED -#undef CONFIG_CHIP_STM32F100V8_SELECTED -#undef CONFIG_CHIP_STM32F100VB_SELECTED -#undef CONFIG_CHIP_STM32F100VC_SELECTED -#undef CONFIG_CHIP_STM32F100VD_SELECTED -#undef CONFIG_CHIP_STM32F100VE_SELECTED -#undef CONFIG_CHIP_STM32F100ZC_SELECTED -#undef CONFIG_CHIP_STM32F100ZD_SELECTED -#undef CONFIG_CHIP_STM32F100ZE_SELECTED -#undef CONFIG_CHIP_STM32F101C6_SELECTED -#undef CONFIG_CHIP_STM32F101C8_SELECTED -#undef CONFIG_CHIP_STM32F101CB_SELECTED -#undef CONFIG_CHIP_STM32F101R4_SELECTED -#undef CONFIG_CHIP_STM32F101R6_SELECTED -#undef CONFIG_CHIP_STM32F101R8_SELECTED -#undef CONFIG_CHIP_STM32F101RB_SELECTED -#undef CONFIG_CHIP_STM32F101RC_SELECTED -#undef CONFIG_CHIP_STM32F101RD_SELECTED -#undef CONFIG_CHIP_STM32F101RE_SELECTED -#undef CONFIG_CHIP_STM32F101RF_SELECTED -#undef CONFIG_CHIP_STM32F101RG_SELECTED -#undef CONFIG_CHIP_STM32F101T4_SELECTED -#undef CONFIG_CHIP_STM32F101T6_SELECTED -#undef CONFIG_CHIP_STM32F101T8_SELECTED -#undef CONFIG_CHIP_STM32F101TB_SELECTED -#undef CONFIG_CHIP_STM32F101V8_SELECTED -#undef CONFIG_CHIP_STM32F101VB_SELECTED -#undef CONFIG_CHIP_STM32F101VC_SELECTED -#undef CONFIG_CHIP_STM32F101VD_SELECTED -#undef CONFIG_CHIP_STM32F101VE_SELECTED -#undef CONFIG_CHIP_STM32F101VF_SELECTED -#undef CONFIG_CHIP_STM32F101VG_SELECTED -#undef CONFIG_CHIP_STM32F101ZC_SELECTED -#undef CONFIG_CHIP_STM32F101ZD_SELECTED -#undef CONFIG_CHIP_STM32F101ZE_SELECTED -#undef CONFIG_CHIP_STM32F101ZF_SELECTED -#undef CONFIG_CHIP_STM32F101ZG_SELECTED -#undef CONFIG_CHIP_STM32F102C4_SELECTED -#undef CONFIG_CHIP_STM32F102C6_SELECTED -#undef CONFIG_CHIP_STM32F102C8_SELECTED -#undef CONFIG_CHIP_STM32F102CB_SELECTED -#undef CONFIG_CHIP_STM32F102R4_SELECTED -#undef CONFIG_CHIP_STM32F102R6_SELECTED -#undef CONFIG_CHIP_STM32F102R8_SELECTED -#undef CONFIG_CHIP_STM32F102RB_SELECTED -#undef CONFIG_CHIP_STM32F103C4_SELECTED -#undef CONFIG_CHIP_STM32F103C6_SELECTED -#undef CONFIG_CHIP_STM32F103C8_SELECTED -#undef CONFIG_CHIP_STM32F103CB_SELECTED -#undef CONFIG_CHIP_STM32F103R4_SELECTED -#undef CONFIG_CHIP_STM32F103R6_SELECTED -#undef CONFIG_CHIP_STM32F103R8_SELECTED -#undef CONFIG_CHIP_STM32F103RB_SELECTED -#undef CONFIG_CHIP_STM32F103RC_SELECTED -#undef CONFIG_CHIP_STM32F103RD_SELECTED -#undef CONFIG_CHIP_STM32F103RE_SELECTED -#undef CONFIG_CHIP_STM32F103RF_SELECTED -#undef CONFIG_CHIP_STM32F103RG_SELECTED -#undef CONFIG_CHIP_STM32F103T4_SELECTED -#undef CONFIG_CHIP_STM32F103T6_SELECTED -#undef CONFIG_CHIP_STM32F103T8_SELECTED -#undef CONFIG_CHIP_STM32F103TB_SELECTED -#undef CONFIG_CHIP_STM32F103V8_SELECTED -#undef CONFIG_CHIP_STM32F103VB_SELECTED -#undef CONFIG_CHIP_STM32F103VC_SELECTED -#define CONFIG_CHIP_STM32F103VD_SELECTED -#undef CONFIG_CHIP_STM32F103VE_SELECTED -#undef CONFIG_CHIP_STM32F103VF_SELECTED -#undef CONFIG_CHIP_STM32F103VG_SELECTED -#undef CONFIG_CHIP_STM32F103ZC_SELECTED -#undef CONFIG_CHIP_STM32F103ZD_SELECTED -#undef CONFIG_CHIP_STM32F103ZE_SELECTED -#undef CONFIG_CHIP_STM32F103ZF_SELECTED -#undef CONFIG_CHIP_STM32F103ZG_SELECTED -#undef CONFIG_CHIP_STM32F105R8_SELECTED -#undef CONFIG_CHIP_STM32F105RB_SELECTED -#undef CONFIG_CHIP_STM32F105RC_SELECTED -#undef CONFIG_CHIP_STM32F105V8_SELECTED -#undef CONFIG_CHIP_STM32F105VB_SELECTED -#undef CONFIG_CHIP_STM32F105VC_SELECTED -#undef CONFIG_CHIP_STM32F107RB_SELECTED -#undef CONFIG_CHIP_STM32F107RC_SELECTED -#undef CONFIG_CHIP_STM32F107VB_SELECTED -#undef CONFIG_CHIP_STM32F107VC_SELECTED -#define CONFIG_BOARD_TOTAL_BUTTONS 0 -#define CONFIG_BOARD_TOTAL_LEDS 0 -#define CONFIG_BOARD "Custom" -#define CONFIG_CHIP "STM32F103VD" -#define CONFIG_CHIP_INCLUDES "source/chip/STM32/STM32F1/include external/CMSIS-STM32F1 external/CMSIS" -#define CONFIG_CHIP_STM32F1_STANDARD_CLOCK_CONFIGURATION_ENABLE -#undef CONFIG_CHIP_STM32F1_RCC_HSE_ENABLE -#define CONFIG_CHIP_STM32F1_RCC_PLL_ENABLE -#define CONFIG_CHIP_STM32F1_RCC_PLLSRC_HSIDIV2 -#undef CONFIG_CHIP_STM32F1_RCC_PLLMUL2 -#undef CONFIG_CHIP_STM32F1_RCC_PLLMUL3 -#undef CONFIG_CHIP_STM32F1_RCC_PLLMUL4 -#undef CONFIG_CHIP_STM32F1_RCC_PLLMUL5 -#undef CONFIG_CHIP_STM32F1_RCC_PLLMUL6 -#undef CONFIG_CHIP_STM32F1_RCC_PLLMUL7 -#undef CONFIG_CHIP_STM32F1_RCC_PLLMUL8 -#undef CONFIG_CHIP_STM32F1_RCC_PLLMUL9 -#undef CONFIG_CHIP_STM32F1_RCC_PLLMUL10 -#undef CONFIG_CHIP_STM32F1_RCC_PLLMUL11 -#undef CONFIG_CHIP_STM32F1_RCC_PLLMUL12 -#undef CONFIG_CHIP_STM32F1_RCC_PLLMUL13 -#undef CONFIG_CHIP_STM32F1_RCC_PLLMUL14 -#undef CONFIG_CHIP_STM32F1_RCC_PLLMUL15 -#define CONFIG_CHIP_STM32F1_RCC_PLLMUL16 -#undef CONFIG_CHIP_STM32F1_RCC_SYSCLK_HSI -#define CONFIG_CHIP_STM32F1_RCC_SYSCLK_PLL -#define CONFIG_CHIP_STM32F1_RCC_AHB_DIV1 -#undef CONFIG_CHIP_STM32F1_RCC_AHB_DIV2 -#undef CONFIG_CHIP_STM32F1_RCC_AHB_DIV4 -#undef CONFIG_CHIP_STM32F1_RCC_AHB_DIV8 -#undef CONFIG_CHIP_STM32F1_RCC_AHB_DIV16 -#undef CONFIG_CHIP_STM32F1_RCC_AHB_DIV64 -#undef CONFIG_CHIP_STM32F1_RCC_AHB_DIV128 -#undef CONFIG_CHIP_STM32F1_RCC_AHB_DIV256 -#undef CONFIG_CHIP_STM32F1_RCC_AHB_DIV512 -#undef CONFIG_CHIP_STM32F1_RCC_APB1_DIV1 -#define CONFIG_CHIP_STM32F1_RCC_APB1_DIV2 -#undef CONFIG_CHIP_STM32F1_RCC_APB1_DIV4 -#undef CONFIG_CHIP_STM32F1_RCC_APB1_DIV8 -#undef CONFIG_CHIP_STM32F1_RCC_APB1_DIV16 -#define CONFIG_CHIP_STM32F1_RCC_APB2_DIV1 -#undef CONFIG_CHIP_STM32F1_RCC_APB2_DIV2 -#undef CONFIG_CHIP_STM32F1_RCC_APB2_DIV4 -#undef CONFIG_CHIP_STM32F1_RCC_APB2_DIV8 -#undef CONFIG_CHIP_STM32F1_RCC_APB2_DIV16 -#define CONFIG_CHIP_STM32F1_FLASH_PREFETCH_ENABLE -#undef CONFIG_CHIP_STM32F1_FLASH_HALF_CYCLE_ACCESS_ENABLE -#define CONFIG_CHIP_STM32F10 -#undef CONFIG_CHIP_STM32F100 -#undef CONFIG_CHIP_STM32F100C -#undef CONFIG_CHIP_STM32F100C4 -#undef CONFIG_CHIP_STM32F100C6 -#undef CONFIG_CHIP_STM32F100C8 -#undef CONFIG_CHIP_STM32F100CB -#undef CONFIG_CHIP_STM32F100R -#undef CONFIG_CHIP_STM32F100R4 -#undef CONFIG_CHIP_STM32F100R6 -#undef CONFIG_CHIP_STM32F100R8 -#undef CONFIG_CHIP_STM32F100RB -#undef CONFIG_CHIP_STM32F100RC -#undef CONFIG_CHIP_STM32F100RD -#undef CONFIG_CHIP_STM32F100RE -#undef CONFIG_CHIP_STM32F100V -#undef CONFIG_CHIP_STM32F100V8 -#undef CONFIG_CHIP_STM32F100VB -#undef CONFIG_CHIP_STM32F100VC -#undef CONFIG_CHIP_STM32F100VD -#undef CONFIG_CHIP_STM32F100VE -#undef CONFIG_CHIP_STM32F100Z -#undef CONFIG_CHIP_STM32F100ZC -#undef CONFIG_CHIP_STM32F100ZD -#undef CONFIG_CHIP_STM32F100ZE -#undef CONFIG_CHIP_STM32F101 -#undef CONFIG_CHIP_STM32F101C -#undef CONFIG_CHIP_STM32F101C6 -#undef CONFIG_CHIP_STM32F101C8 -#undef CONFIG_CHIP_STM32F101CB -#undef CONFIG_CHIP_STM32F101R -#undef CONFIG_CHIP_STM32F101R4 -#undef CONFIG_CHIP_STM32F101R6 -#undef CONFIG_CHIP_STM32F101R8 -#undef CONFIG_CHIP_STM32F101RB -#undef CONFIG_CHIP_STM32F101RC -#undef CONFIG_CHIP_STM32F101RD -#undef CONFIG_CHIP_STM32F101RE -#undef CONFIG_CHIP_STM32F101RF -#undef CONFIG_CHIP_STM32F101RG -#undef CONFIG_CHIP_STM32F101T -#undef CONFIG_CHIP_STM32F101T4 -#undef CONFIG_CHIP_STM32F101T6 -#undef CONFIG_CHIP_STM32F101T8 -#undef CONFIG_CHIP_STM32F101TB -#undef CONFIG_CHIP_STM32F101V -#undef CONFIG_CHIP_STM32F101V8 -#undef CONFIG_CHIP_STM32F101VB -#undef CONFIG_CHIP_STM32F101VC -#undef CONFIG_CHIP_STM32F101VD -#undef CONFIG_CHIP_STM32F101VE -#undef CONFIG_CHIP_STM32F101VF -#undef CONFIG_CHIP_STM32F101VG -#undef CONFIG_CHIP_STM32F101Z -#undef CONFIG_CHIP_STM32F101ZC -#undef CONFIG_CHIP_STM32F101ZD -#undef CONFIG_CHIP_STM32F101ZE -#undef CONFIG_CHIP_STM32F101ZF -#undef CONFIG_CHIP_STM32F101ZG -#undef CONFIG_CHIP_STM32F102 -#undef CONFIG_CHIP_STM32F102C -#undef CONFIG_CHIP_STM32F102C4 -#undef CONFIG_CHIP_STM32F102C6 -#undef CONFIG_CHIP_STM32F102C8 -#undef CONFIG_CHIP_STM32F102CB -#undef CONFIG_CHIP_STM32F102R -#undef CONFIG_CHIP_STM32F102R4 -#undef CONFIG_CHIP_STM32F102R6 -#undef CONFIG_CHIP_STM32F102R8 -#undef CONFIG_CHIP_STM32F102RB -#define CONFIG_CHIP_STM32F103 -#undef CONFIG_CHIP_STM32F103C -#undef CONFIG_CHIP_STM32F103C4 -#undef CONFIG_CHIP_STM32F103C6 -#undef CONFIG_CHIP_STM32F103C8 -#undef CONFIG_CHIP_STM32F103CB -#undef CONFIG_CHIP_STM32F103R -#undef CONFIG_CHIP_STM32F103R4 -#undef CONFIG_CHIP_STM32F103R6 -#undef CONFIG_CHIP_STM32F103R8 -#undef CONFIG_CHIP_STM32F103RB -#undef CONFIG_CHIP_STM32F103RC -#undef CONFIG_CHIP_STM32F103RD -#undef CONFIG_CHIP_STM32F103RE -#undef CONFIG_CHIP_STM32F103RF -#undef CONFIG_CHIP_STM32F103RG -#undef CONFIG_CHIP_STM32F103T -#undef CONFIG_CHIP_STM32F103T4 -#undef CONFIG_CHIP_STM32F103T6 -#undef CONFIG_CHIP_STM32F103T8 -#undef CONFIG_CHIP_STM32F103TB -#define CONFIG_CHIP_STM32F103V -#undef CONFIG_CHIP_STM32F103V8 -#undef CONFIG_CHIP_STM32F103VB -#undef CONFIG_CHIP_STM32F103VC -#define CONFIG_CHIP_STM32F103VD -#undef CONFIG_CHIP_STM32F103VE -#undef CONFIG_CHIP_STM32F103VF -#undef CONFIG_CHIP_STM32F103VG -#undef CONFIG_CHIP_STM32F103Z -#undef CONFIG_CHIP_STM32F103ZC -#undef CONFIG_CHIP_STM32F103ZD -#undef CONFIG_CHIP_STM32F103ZE -#undef CONFIG_CHIP_STM32F103ZF -#undef CONFIG_CHIP_STM32F103ZG -#undef CONFIG_CHIP_STM32F105 -#undef CONFIG_CHIP_STM32F105R -#undef CONFIG_CHIP_STM32F105R8 -#undef CONFIG_CHIP_STM32F105RB -#undef CONFIG_CHIP_STM32F105RC -#undef CONFIG_CHIP_STM32F105V -#undef CONFIG_CHIP_STM32F105V8 -#undef CONFIG_CHIP_STM32F105VB -#undef CONFIG_CHIP_STM32F105VC -#undef CONFIG_CHIP_STM32F107 -#undef CONFIG_CHIP_STM32F107R -#undef CONFIG_CHIP_STM32F107RB -#undef CONFIG_CHIP_STM32F107RC -#undef CONFIG_CHIP_STM32F107V -#undef CONFIG_CHIP_STM32F107VB -#undef CONFIG_CHIP_STM32F107VC -#define CONFIG_CHIP_STM32F1_FLASH_SIZE 393216 -#define CONFIG_CHIP_STM32F1_FLASH_ADDRESS 0x08000000 -#define CONFIG_CHIP_STM32F1_SRAM_SIZE 65536 -#define CONFIG_CHIP_STM32F1_SRAM_ADDRESS 0x20000000 -#define CONFIG_CHIP_STM32F1_RCC_HSE_CLOCK_BYPASS_CONFIGURABLE -#undef CONFIG_CHIP_STM32F1_RCC_HSE_CLOCK_BYPASS_DEFAULT -#define CONFIG_CHIP_STM32F1_RCC_HSE_FREQUENCY_CONFIGURABLE -#define CONFIG_CHIP_STM32F1_RCC_HSE_FREQUENCY_DEFAULT 8000000 -#define CONFIG_CHIP_STM32F1_RCC_HPRE 1 -#define CONFIG_CHIP_STM32F1_RCC_PLLMUL_DENOMINATOR 1 -#define CONFIG_CHIP_STM32F1_RCC_PLLMUL_NUMERATOR 16 -#define CONFIG_CHIP_STM32F1_RCC_PPRE1 2 -#define CONFIG_CHIP_STM32F1_RCC_PPRE2 1 -#define CONFIG_CHIP_LFBGA100_SELECTED -#undef CONFIG_CHIP_LQFP100_SELECTED -#undef CONFIG_ARCHITECTURE_ARMV6_M -#define CONFIG_ARCHITECTURE_ARMV7_M -#define CONFIG_TOOLCHAIN_PREFIX "arm-none-eabi-" -#define CONFIG_ARCHITECTURE_FLAGS "-mcpu=cortex-m3 -mthumb" -#define CONFIG_ARCHITECTURE_ARMV7_M_KERNEL_BASEPRI 0 -#define CONFIG_ARCHITECTURE_ARM_CORTEX_M3 -#undef CONFIG_ARCHITECTURE_ARM_CORTEX_M4 -#undef CONFIG_ARCHITECTURE_ARM_CORTEX_M7 -#undef CONFIG_ARCHITECTURE_HAS_FPV5_D16 -#define CONFIG_ARCHITECTURE_ARMV6_M_ARMV7_M_MAIN_STACK_SIZE 2048 -#define CONFIG_ARCHITECTURE_INCLUDES "source/architecture/ARM/ARMv6-M-ARMv7-M/include" -#undef CONFIG_ARCHITECTURE_HAS_FPU -#define CONFIG_ARCHITECTURE_ARM -#define CONFIG_CHIP_HAS_LFBGA100 -#undef CONFIG_CHIP_HAS_LFBGA144 -#undef CONFIG_CHIP_HAS_LQFP32 -#undef CONFIG_CHIP_HAS_LQFP48 -#undef CONFIG_CHIP_HAS_LQFP64 -#define CONFIG_CHIP_HAS_LQFP100 -#undef CONFIG_CHIP_HAS_LQFP144 -#undef CONFIG_CHIP_HAS_LQFP176 -#undef CONFIG_CHIP_HAS_LQFP208 -#undef CONFIG_CHIP_HAS_TFBGA64 -#undef CONFIG_CHIP_HAS_TFBGA216 -#undef CONFIG_CHIP_HAS_TSSOP20 -#undef CONFIG_CHIP_HAS_UFBGA64 -#undef CONFIG_CHIP_HAS_UFBGA100 -#undef CONFIG_CHIP_HAS_UFBGA144 -#undef CONFIG_CHIP_HAS_UFBGA169 -#undef CONFIG_CHIP_HAS_UFBGA176 -#undef CONFIG_CHIP_HAS_UFQFPN28 -#undef CONFIG_CHIP_HAS_UFQFPN32 -#undef CONFIG_CHIP_HAS_UFQFPN48 -#undef CONFIG_CHIP_HAS_VFQFPN36 -#undef CONFIG_CHIP_HAS_WLCSP25 -#undef CONFIG_CHIP_HAS_WLCSP36 -#undef CONFIG_CHIP_HAS_WLCSP49 -#undef CONFIG_CHIP_HAS_WLCSP64 -#undef CONFIG_CHIP_HAS_WLCSP81 -#undef CONFIG_CHIP_HAS_WLCSP90 -#undef CONFIG_CHIP_HAS_WLCSP143 -#undef CONFIG_CHIP_HAS_WLCSP168 -#define CONFIG_CHIP_LFBGA100 -#undef CONFIG_CHIP_LFBGA144 -#undef CONFIG_CHIP_LQFP32 -#undef CONFIG_CHIP_LQFP48 -#undef CONFIG_CHIP_LQFP64 -#undef CONFIG_CHIP_LQFP100 -#undef CONFIG_CHIP_LQFP144 -#undef CONFIG_CHIP_LQFP176 -#undef CONFIG_CHIP_LQFP208 -#undef CONFIG_CHIP_TFBGA64 -#undef CONFIG_CHIP_TFBGA216 -#undef CONFIG_CHIP_TSSOP20 -#undef CONFIG_CHIP_UFBGA64 -#undef CONFIG_CHIP_UFBGA100 -#undef CONFIG_CHIP_UFBGA144 -#undef CONFIG_CHIP_UFBGA169 -#undef CONFIG_CHIP_UFBGA176 -#undef CONFIG_CHIP_UFQFPN28 -#undef CONFIG_CHIP_UFQFPN32 -#undef CONFIG_CHIP_UFQFPN48 -#undef CONFIG_CHIP_VFQFPN36 -#undef CONFIG_CHIP_WLCSP25 -#undef CONFIG_CHIP_WLCSP36 -#undef CONFIG_CHIP_WLCSP49 -#undef CONFIG_CHIP_WLCSP64 -#undef CONFIG_CHIP_WLCSP81 -#undef CONFIG_CHIP_WLCSP90 -#undef CONFIG_CHIP_WLCSP143 -#undef CONFIG_CHIP_WLCSP168 -#define CONFIG_CHIP_PACKAGE "LFBGA100" -#define CONFIG_TICK_FREQUENCY 1000 -#define CONFIG_ROUND_ROBIN_FREQUENCY 10 -#define CONFIG_THREAD_DETACH_ENABLE -#define CONFIG_MAIN_THREAD_STACK_SIZE 2048 -#define CONFIG_MAIN_THREAD_PRIORITY 127 -#undef CONFIG_MAIN_THREAD_CAN_RECEIVE_SIGNALS -#undef CONFIG_TEST_APPLICATION_ENABLE -#undef CONFIG_BUILD_OPTIMIZATION_O0 -#undef CONFIG_BUILD_OPTIMIZATION_O1 -#undef CONFIG_BUILD_OPTIMIZATION_O2 -#define CONFIG_BUILD_OPTIMIZATION_O3 -#undef CONFIG_BUILD_OPTIMIZATION_OS -#undef CONFIG_BUILD_OPTIMIZATION_OG -#undef CONFIG_DEBUGGING_INFORMATION_ENABLE -#define CONFIG_BUILD_OPTIMIZATION "-O3" -#define CONFIG_DEBUGGING_INFORMATION_COMPILATION "" -#define CONFIG_DEBUGGING_INFORMATION_LINKING "" - -#endif /* INCLUDE_DISTORTOS_DISTORTOSCONFIGURATION_H_ */ diff --git a/include/distortos/distortosVersion.h b/include/distortos/distortosVersion.h deleted file mode 100644 index 554758d..0000000 --- a/include/distortos/distortosVersion.h +++ /dev/null @@ -1,37 +0,0 @@ -/** - * \file - * \brief distortos version - * - * \author Copyright (C) 2016 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_DISTORTOSVERSION_H_ -#define INCLUDE_DISTORTOS_DISTORTOSVERSION_H_ - -/// major version of distortos -#define DISTORTOS_VERSION_MAJOR 0 - -/// minor version of distortos -#define DISTORTOS_VERSION_MINOR 2 - -/// patch version of distortos -#define DISTORTOS_VERSION_PATCH 0 - -/// distortos version as a 32-bit variable -#define DISTORTOS_VERSION ((DISTORTOS_VERSION_MAJOR << 16) | (DISTORTOS_VERSION_MINOR << 8) | DISTORTOS_VERSION_PATCH) - -/// internals of STRINGIZE() macro -#define STRINGIZE_INTERNAL(x) #x - -/// macro used for stringification -#define STRINGIZE(x) STRINGIZE_INTERNAL(x) - -/// distortos version as string -#define DISTORTOS_VERSION_STRING \ - STRINGIZE(DISTORTOS_VERSION_MAJOR) "." STRINGIZE(DISTORTOS_VERSION_MINOR) "." STRINGIZE(DISTORTOS_VERSION_PATCH) - -#endif /* INCLUDE_DISTORTOS_DISTORTOSVERSION_H_ */ diff --git a/include/distortos/internal/memory/DeferredThreadDeleter.hpp b/include/distortos/internal/memory/DeferredThreadDeleter.hpp deleted file mode 100644 index bb38ebc..0000000 --- a/include/distortos/internal/memory/DeferredThreadDeleter.hpp +++ /dev/null @@ -1,121 +0,0 @@ -/** - * \file - * \brief DeferredThreadDeleter class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_MEMORY_DEFERREDTHREADDELETER_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_MEMORY_DEFERREDTHREADDELETER_HPP_ - -#include "distortos/distortosConfiguration.h" - -#ifdef CONFIG_THREAD_DETACH_ENABLE - -#include "distortos/Mutex.hpp" - -namespace distortos -{ - -namespace internal -{ - -/// DeferredThreadDeleter class can be used to defer deletion of dynamic detached threads -class DeferredThreadDeleter -{ -public: - - /** - * \brief DeferredThreadDeleter's constructor - */ - - constexpr DeferredThreadDeleter() : - list_{}, - mutex_{Mutex::Type::normal, Mutex::Protocol::priorityInheritance}, - notEmpty_{} - { - - } - - /** - * \brief DeferredThreadDeleter's function call operator - * - * Adds thread to internal list of threads scheduled for deferred deletion and marks the list as "not empty". - * - * \note The object must be locked (with a successful call to DeferredThreadDeleter::lock()) before this function is - * used! - * - * \param [in] threadControlBlock is a reference to ThreadControlBlock object associated with dynamic and detached - * thread that has terminated its execution - * - * \return 0 on success, error code otherwise: - * - error codes returned by Mutex::unlock(); - */ - - int operator()(ThreadControlBlock& threadControlBlock); - - /** - * \brief Locks the object, preparing it for adding thread to internal list. - * - * Locks the mutex that synchronizes access to internal list. Locking (performed in this function) and unlocking - * (performed at the end of function call operator) are separated, because the locking must be done while the thread - * is still runnable, while the transfer to internal list is performed when the thread is not in this state. - * - * \note This function must be called before function call operator is used! - * - * \return 0 on success, error code otherwise: - * - error codes returned by Mutex::lock(); - */ - - int lock(); - - /** - * \brief Tries to perform deferred deletion of threads. - * - * Does nothing is the list is not marked as "not empty". Otherwise this function first tries to lock following two - * mutexes: - * - mutex that protects dynamic memory allocator; - * - mutex that synchronizes access to list of threads scheduled for deferred deletion; - * If any Mutex::tryLock() call fails, this function just returns (unlocking any mutexes is necessary). Otherwise - * the threads are removed from the list and deleted, while the list's "not empty" marker is cleared. - * - * \return 0 on success, error code otherwise: - * - error codes returned by Mutex::tryLock(); - * - error codes returned by Mutex::unlock(); - */ - - int tryCleanup(); - -private: - - /** - * \brief Internals of tryCleanup(). - * - * \return 0 on success, error code otherwise: - * - error codes returned by Mutex::tryLock(); - * - error codes returned by Mutex::unlock(); - */ - - int tryCleanupInternal(); - - /// list of threads scheduled for deferred deletion - ThreadList::UnsortedIntrusiveList list_; - - /// mutex that synchronizes access to the \a list_ - Mutex mutex_; - - /// true if \a list_ is not empty, false otherwise - bool notEmpty_; -}; - -} // namespace internal - -} // namespace distortos - -#endif // def CONFIG_THREAD_DETACH_ENABLE - -#endif // INCLUDE_DISTORTOS_INTERNAL_MEMORY_DEFERREDTHREADDELETER_HPP_ diff --git a/include/distortos/internal/memory/dummyDeleter.hpp b/include/distortos/internal/memory/dummyDeleter.hpp deleted file mode 100644 index 3cee5cf..0000000 --- a/include/distortos/internal/memory/dummyDeleter.hpp +++ /dev/null @@ -1,48 +0,0 @@ -/** - * \file - * \brief dummyDeleter() declaration - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_MEMORY_DUMMYDELETER_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_MEMORY_DUMMYDELETER_HPP_ - -#include <type_traits> - -namespace distortos -{ - -namespace internal -{ - -/*---------------------------------------------------------------------------------------------------------------------+ -| global functions' declarations -+---------------------------------------------------------------------------------------------------------------------*/ - -/** - * \brief A "no-op" dummy deleter that can be used with std::unique_ptr and automatic storage that is trivially - * destructible. - * - * \tparam T is the real type of storage, must be trivially destructible - * \tparam U is the type of \a storage pointer - * - * \param [in] storage is a pointer to storage - */ - -template<typename T, typename U> -void dummyDeleter(U*) -{ - static_assert(std::is_trivially_destructible<T>::value == true, - "internal::dummyDeleter() cannot be used with types that are not trivially destructible!"); -} - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_MEMORY_DUMMYDELETER_HPP_ diff --git a/include/distortos/internal/memory/getDeferredThreadDeleter.hpp b/include/distortos/internal/memory/getDeferredThreadDeleter.hpp deleted file mode 100644 index 30fea99..0000000 --- a/include/distortos/internal/memory/getDeferredThreadDeleter.hpp +++ /dev/null @@ -1,39 +0,0 @@ -/** - * \file - * \brief getDeferredThreadDeleter() declaration - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_MEMORY_GETDEFERREDTHREADDELETER_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_MEMORY_GETDEFERREDTHREADDELETER_HPP_ - -#include "distortos/distortosConfiguration.h" - -#ifdef CONFIG_THREAD_DETACH_ENABLE - -namespace distortos -{ - -namespace internal -{ - -class DeferredThreadDeleter; - -/** - * \return reference to main instance of DeferredThreadDeleter - */ - -DeferredThreadDeleter& getDeferredThreadDeleter(); - -} // namespace internal - -} // namespace distortos - -#endif // def CONFIG_THREAD_DETACH_ENABLE - -#endif // INCLUDE_DISTORTOS_INTERNAL_MEMORY_GETDEFERREDTHREADDELETER_HPP_ diff --git a/include/distortos/internal/memory/getMallocMutex.hpp b/include/distortos/internal/memory/getMallocMutex.hpp deleted file mode 100644 index 0ba5621..0000000 --- a/include/distortos/internal/memory/getMallocMutex.hpp +++ /dev/null @@ -1,33 +0,0 @@ -/** - * \file - * \brief getMallocMutex() declaration - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_MEMORY_GETMALLOCMUTEX_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_MEMORY_GETMALLOCMUTEX_HPP_ - -namespace distortos -{ - -class Mutex; - -namespace internal -{ - -/** - * \return reference to main instance of Mutex used for malloc() and free() locking - */ - -Mutex& getMallocMutex(); - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_MEMORY_GETMALLOCMUTEX_HPP_ diff --git a/include/distortos/internal/memory/storageDeleter.hpp b/include/distortos/internal/memory/storageDeleter.hpp deleted file mode 100644 index da7173f..0000000 --- a/include/distortos/internal/memory/storageDeleter.hpp +++ /dev/null @@ -1,44 +0,0 @@ -/** - * \file - * \brief storageDeleter() definition - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_MEMORY_STORAGEDELETER_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_MEMORY_STORAGEDELETER_HPP_ - -namespace distortos -{ - -namespace internal -{ - -/*---------------------------------------------------------------------------------------------------------------------+ -| global functions' declarations -+---------------------------------------------------------------------------------------------------------------------*/ - -/** - * \brief Templated deleter that can be used with std::unique_ptr and dynamic storage allocated with new T[]. - * - * \tparam T is the real type of allocated storage - * \tparam U is the type of \a storage pointer - * - * \param [in] storage is a pointer to storage that will be deleted - */ - -template<typename T, typename U> -void storageDeleter(U* const storage) -{ - delete[] reinterpret_cast<T*>(storage); -} - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_MEMORY_STORAGEDELETER_HPP_ diff --git a/include/distortos/internal/scheduler/DynamicThreadBase.hpp b/include/distortos/internal/scheduler/DynamicThreadBase.hpp deleted file mode 100644 index 5ca3ff8..0000000 --- a/include/distortos/internal/scheduler/DynamicThreadBase.hpp +++ /dev/null @@ -1,231 +0,0 @@ -/** - * \file - * \brief DynamicThreadBase class header - * - * \author Copyright (C) 2015-2016 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_DYNAMICTHREADBASE_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_DYNAMICTHREADBASE_HPP_ - -#include "distortos/DynamicSignalsReceiver.hpp" -#include "distortos/DynamicThreadParameters.hpp" -#include "distortos/ThreadCommon.hpp" - -#include "distortos/internal/memory/storageDeleter.hpp" - -namespace distortos -{ - -#ifdef CONFIG_THREAD_DETACH_ENABLE - -class DynamicThread; - -#endif // def CONFIG_THREAD_DETACH_ENABLE - -namespace internal -{ - -/** - * \brief DynamicThreadBase class is a type-erased interface for thread that has dynamic storage for bounded function, - * stack and internal DynamicSignalsReceiver object. - * - * If thread detachment is enabled (CONFIG_THREAD_DETACH_ENABLE is defined) then this class is dynamically allocated by - * DynamicThread - which allows it to be "detached". Otherwise - if thread detachment is disabled - * (CONFIG_THREAD_DETACH_ENABLE is not defined) - DynamicThread just inherits from this class. - */ - -class DynamicThreadBase : public ThreadCommon -{ -public: - -#ifdef CONFIG_THREAD_DETACH_ENABLE - - /** - * \brief DynamicThreadBase's constructor - * - * \tparam Function is the function that will be executed in separate thread - * \tparam Args are the arguments for \a Function - * - * \param [in] stackSize is the size of stack, bytes - * \param [in] canReceiveSignals selects whether reception of signals is enabled (true) or disabled (false) for this - * thread - * \param [in] queuedSignals is the max number of queued signals for this thread, relevant only if - * \a canReceiveSignals == true, 0 to disable queuing of signals for this thread - * \param [in] signalActions is the max number of different SignalAction objects for this thread, relevant only if - * \a canReceiveSignals == true, 0 to disable catching of signals for this thread - * \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest - * \param [in] schedulingPolicy is the scheduling policy of the thread - * \param [in] owner is a reference to owner DynamicThread object - * \param [in] function is a function that will be executed in separate thread - * \param [in] args are arguments for \a function - */ - - template<typename Function, typename... Args> - DynamicThreadBase(size_t stackSize, bool canReceiveSignals, size_t queuedSignals, size_t signalActions, - uint8_t priority, SchedulingPolicy schedulingPolicy, DynamicThread& owner, Function&& function, - Args&&... args); - - /** - * \brief Detaches the thread. - * - * Similar to std::thread::detach() - http://en.cppreference.com/w/cpp/thread/thread/detach - * Similar to POSIX pthread_detach() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_detach.html - * - * Detaches the executing thread from the Thread object, allowing execution to continue independently. All resources - * allocated for the thread will be deallocated when the thread terminates. - * - * \return 0 on success, error code otherwise: - * - EINVAL - this thread is already detached; - */ - - int detach() override; - -#else // !def CONFIG_THREAD_DETACH_ENABLE - - /** - * \brief DynamicThreadBase's constructor - * - * \tparam Function is the function that will be executed in separate thread - * \tparam Args are the arguments for \a Function - * - * \param [in] stackSize is the size of stack, bytes - * \param [in] canReceiveSignals selects whether reception of signals is enabled (true) or disabled (false) for this - * thread - * \param [in] queuedSignals is the max number of queued signals for this thread, relevant only if - * \a canReceiveSignals == true, 0 to disable queuing of signals for this thread - * \param [in] signalActions is the max number of different SignalAction objects for this thread, relevant only if - * \a canReceiveSignals == true, 0 to disable catching of signals for this thread - * \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest - * \param [in] schedulingPolicy is the scheduling policy of the thread - * \param [in] function is a function that will be executed in separate thread - * \param [in] args are arguments for \a function - */ - - template<typename Function, typename... Args> - DynamicThreadBase(size_t stackSize, bool canReceiveSignals, size_t queuedSignals, size_t signalActions, - uint8_t priority, SchedulingPolicy schedulingPolicy, Function&& function, Args&&... args); - - /** - * \brief DynamicThreadBase's constructor - * - * \tparam Function is the function that will be executed in separate thread - * \tparam Args are the arguments for \a Function - * - * \param [in] parameters is a DynamicThreadParameters struct with thread parameters - * \param [in] function is a function that will be executed in separate thread - * \param [in] args are arguments for \a function - */ - - template<typename Function, typename... Args> - DynamicThreadBase(const DynamicThreadParameters parameters, Function&& function, Args&&... args) : - DynamicThreadBase{parameters.stackSize, parameters.canReceiveSignals, parameters.queuedSignals, - parameters.signalActions, parameters.priority, parameters.schedulingPolicy, - std::forward<Function>(function), std::forward<Args>(args)...} - { - - } - -#endif // !def CONFIG_THREAD_DETACH_ENABLE - - DynamicThreadBase(const DynamicThreadBase&) = delete; - DynamicThreadBase(DynamicThreadBase&&) = default; - const DynamicThreadBase& operator=(const DynamicThreadBase&) = delete; - DynamicThreadBase& operator=(DynamicThreadBase&&) = delete; - -protected: - -#ifdef CONFIG_THREAD_DETACH_ENABLE - - /** - * \brief Pre-termination hook function of thread - * - * If thread is detached, locks object used for deferred deletion. - * - * \param [in] thread is a reference to Thread object, this must be DynamicThreadBase! - */ - - static void preTerminationHook(Thread& thread); - - /** - * \brief Termination hook function of thread - * - * Calls ThreadCommon::terminationHook() and - if thread is detached - schedules itself for deferred deletion. - * - * \param [in] thread is a reference to Thread object, this must be DynamicThreadBase! - */ - - static void terminationHook(Thread& thread); - -#endif // def CONFIG_THREAD_DETACH_ENABLE - -private: - - /** - * \brief Thread's "run" function. - * - * Executes bound function object. - * - * \param [in] thread is a reference to Thread object, this must be DynamicThreadBase! - */ - - static void run(Thread& thread); - - /// internal DynamicSignalsReceiver object - DynamicSignalsReceiver dynamicSignalsReceiver_; - - /// bound function object - std::function<void()> boundFunction_; - -#ifdef CONFIG_THREAD_DETACH_ENABLE - - /// pointer to owner DynamicThread object, nullptr if thread is detached - DynamicThread* owner_; - -#endif // def CONFIG_THREAD_DETACH_ENABLE -}; - -#ifdef CONFIG_THREAD_DETACH_ENABLE - -template<typename Function, typename... Args> -DynamicThreadBase::DynamicThreadBase(const size_t stackSize, const bool canReceiveSignals, const size_t queuedSignals, - const size_t signalActions, const uint8_t priority, const SchedulingPolicy schedulingPolicy, - DynamicThread& owner, Function&& function, Args&&... args) : - ThreadCommon{{{new uint8_t[stackSize], storageDeleter<uint8_t>}, stackSize, *this, run, - preTerminationHook, terminationHook}, priority, schedulingPolicy, nullptr, - canReceiveSignals == true ? &dynamicSignalsReceiver_ : nullptr}, - dynamicSignalsReceiver_{canReceiveSignals == true ? queuedSignals : 0, - canReceiveSignals == true ? signalActions : 0}, - boundFunction_{std::bind(std::forward<Function>(function), std::forward<Args>(args)...)}, - owner_{&owner} -{ - -} - -#else // !def CONFIG_THREAD_DETACH_ENABLE - -template<typename Function, typename... Args> -DynamicThreadBase::DynamicThreadBase(const size_t stackSize, const bool canReceiveSignals, const size_t queuedSignals, - const size_t signalActions, const uint8_t priority, const SchedulingPolicy schedulingPolicy, - Function&& function, Args&&... args) : - ThreadCommon{{{new uint8_t[stackSize], storageDeleter<uint8_t>}, stackSize, *this, run, nullptr, - terminationHook}, priority, schedulingPolicy, nullptr, - canReceiveSignals == true ? &dynamicSignalsReceiver_ : nullptr}, - dynamicSignalsReceiver_{canReceiveSignals == true ? queuedSignals : 0, - canReceiveSignals == true ? signalActions : 0}, - boundFunction_{std::bind(std::forward<Function>(function), std::forward<Args>(args)...)} -{ - -} - -#endif // !def CONFIG_THREAD_DETACH_ENABLE - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_DYNAMICTHREADBASE_HPP_ diff --git a/include/distortos/internal/scheduler/MainThread.hpp b/include/distortos/internal/scheduler/MainThread.hpp deleted file mode 100644 index 2eadab6..0000000 --- a/include/distortos/internal/scheduler/MainThread.hpp +++ /dev/null @@ -1,46 +0,0 @@ -/** - * \file - * \brief MainThread class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_MAINTHREAD_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_MAINTHREAD_HPP_ - -#include "distortos/UndetachableThread.hpp" - -namespace distortos -{ - -namespace internal -{ - -/// MainThread class is a Thread for main() -class MainThread : public UndetachableThread -{ -public: - - /** - * \brief MainThread's constructor. - * - * \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest - * \param [in] threadGroupControlBlock is a reference to ThreadGroupControlBlock to which this object will be added - * \param [in] signalsReceiver is a pointer to SignalsReceiver object for main thread, nullptr to disable reception - * of signals for main thread - */ - - MainThread(uint8_t priority, ThreadGroupControlBlock& threadGroupControlBlock, SignalsReceiver* signalsReceiver); - - using UndetachableThread::getThreadControlBlock; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_MAINTHREAD_HPP_ diff --git a/include/distortos/internal/scheduler/RoundRobinQuantum.hpp b/include/distortos/internal/scheduler/RoundRobinQuantum.hpp deleted file mode 100644 index e0a443e..0000000 --- a/include/distortos/internal/scheduler/RoundRobinQuantum.hpp +++ /dev/null @@ -1,123 +0,0 @@ -/** - * \file - * \brief RoundRobinQuantum class header - * - * \author Copyright (C) 2014-2016 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_ROUNDROBINQUANTUM_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_ROUNDROBINQUANTUM_HPP_ - -#include "distortos/TickClock.hpp" - -namespace distortos -{ - -namespace internal -{ - -/// RoundRobinQuantum class is a quantum of time for round-robin scheduling -class RoundRobinQuantum -{ -public: - - /// type of quantum counter - using Representation = uint8_t; - - /// duration type used for quantum - using Duration = std::chrono::duration<Representation, TickClock::period>; - - /** - * \return initial value for round-robin quantum - */ - - constexpr static Duration getInitial() - { - return Duration{quantumRawInitializer_}; - } - - /** - * \brief RoundRobinQuantum's constructor - * - * Initializes quantum value to initial value - just like after call to reset(). - */ - - constexpr RoundRobinQuantum() : - quantum_{getInitial()} - { - - } - - /** - * \brief Decrements round-robin's quantum. - * - * This function should be called from tick interrupt for the currently running thread. Underflow of quantum after - * this decrement is not possible. - * - * \note this function must be called with enabled interrupt masking - */ - - void decrement() - { - if (isZero() == false) - --quantum_; - } - - /** - * \brief Gets current value of round-robin's quantum. - * - * \return current value of round-robin's quantum of the thread - */ - - Duration get() const - { - return quantum_; - } - - /** - * \brief Convenience function to test whether the quantum is already at 0. - * - * \return true if quantum is zero, false otherwise - */ - - bool isZero() const - { - return quantum_ == Duration{0}; - } - - /** - * \brief Resets value of round-robin's quantum. - * - * This function should be called from context switcher after selecting new task that will be run. - */ - - void reset() - { - quantum_ = getInitial(); - } - -private: - - static_assert(CONFIG_TICK_FREQUENCY > 0, "CONFIG_TICK_FREQUENCY must be positive and non-zero!"); - static_assert(CONFIG_ROUND_ROBIN_FREQUENCY > 0, "CONFIG_ROUND_ROBIN_FREQUENCY must be positive and non-zero!"); - - /// raw initializer value for round-robin quantum, calculated with rounding to nearest - constexpr static auto quantumRawInitializer_ = (CONFIG_TICK_FREQUENCY + CONFIG_ROUND_ROBIN_FREQUENCY / 2) / - CONFIG_ROUND_ROBIN_FREQUENCY; - - static_assert(quantumRawInitializer_ > 0 || quantumRawInitializer_ <= UINT8_MAX, - "CONFIG_TICK_FREQUENCY and CONFIG_ROUND_ROBIN_FREQUENCY values produce invalid round-robin quantum!"); - - /// round-robin quantum - Duration quantum_; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_ROUNDROBINQUANTUM_HPP_ diff --git a/include/distortos/internal/scheduler/Scheduler.hpp b/include/distortos/internal/scheduler/Scheduler.hpp deleted file mode 100644 index 42037f2..0000000 --- a/include/distortos/internal/scheduler/Scheduler.hpp +++ /dev/null @@ -1,351 +0,0 @@ -/** - * \file - * \brief Scheduler class header - * - * \author Copyright (C) 2014-2016 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_SCHEDULER_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_SCHEDULER_HPP_ - -#include "distortos/internal/scheduler/ThreadControlBlock.hpp" -#include "distortos/internal/scheduler/ThreadList.hpp" -#include "distortos/internal/scheduler/SoftwareTimerSupervisor.hpp" - -namespace distortos -{ - -namespace internal -{ - -class MainThread; - -/// Scheduler class is a system's scheduler -class Scheduler -{ -public: - - /** - * \brief Scheduler's constructor - */ - - constexpr Scheduler() : - currentThreadControlBlock_{}, - runnableList_{}, - suspendedList_{}, - softwareTimerSupervisor_{}, - contextSwitchCount_{}, - tickCount_{} - { - - } - - /** - * \brief Adds new ThreadControlBlock to scheduler. - * - * ThreadControlBlock's state is changed to "runnable". - * - * \param [in] threadControlBlock is a reference to added ThreadControlBlock object - * - * \return 0 on success, error code otherwise: - * - EINVAL - thread is already started; - * - error codes returned by Scheduler::addInternal(); - */ - - int add(ThreadControlBlock& threadControlBlock); - - /** - * \brief Blocks current thread, transferring it to provided container. - * - * \param [in] container is a reference to destination container to which the thread will be transferred - * \param [in] state is the new state of thread that will be blocked - * \param [in] unblockFunctor is a pointer to ThreadControlBlock::UnblockFunctor which will be executed in - * ThreadControlBlock::unblockHook(), default - nullptr (no functor will be executed) - * - * \return 0 on success, error code otherwise: - * - EINTR - thread was unblocked with ThreadControlBlock::UnblockReason::signal; - * - ETIMEDOUT - thread was unblocked with ThreadControlBlock::UnblockReason::timeout; - */ - - int block(ThreadList& container, ThreadState state, const ThreadControlBlock::UnblockFunctor* unblockFunctor = {}); - - /** - * \brief Blocks thread, transferring it to provided container. - * - * The thread must be on "runnable" list - trying to block thread in other state is an error. - * - * \param [in] container is a reference to destination container to which the thread will be transferred - * \param [in] iterator is the iterator to the thread that will be blocked - * \param [in] state is the new state of thread that will be blocked - * \param [in] unblockFunctor is a pointer to ThreadControlBlock::UnblockFunctor which will be executed in - * ThreadControlBlock::unblockHook(), default - nullptr (no functor will be executed) - * - * \return 0 on success, error code otherwise: - * - EINTR - thread was unblocked with ThreadControlBlock::UnblockReason::signal (possible only when blocking - * current thread); - * - EINVAL - provided thread is not on "runnable" list; - * - ETIMEDOUT - thread was unblocked with ThreadControlBlock::UnblockReason::timeout (possible only when blocking - * current thread); - */ - - int block(ThreadList& container, ThreadList::iterator iterator, ThreadState state, - const ThreadControlBlock::UnblockFunctor* unblockFunctor = {}); - - /** - * \brief Blocks current thread with timeout, transferring it to provided container. - * - * \param [in] container is a reference to destination container to which the thread will be transferred - * \param [in] state is the new state of thread that will be blocked - * \param [in] timePoint is the time point at which the thread will be unblocked (if not already unblocked) - * \param [in] unblockFunctor is a pointer to ThreadControlBlock::UnblockFunctor which will be executed in - * ThreadControlBlock::unblockHook(), default - nullptr (no functor will be executed) - * - * \return 0 on success, error code otherwise: - * - EINTR - thread was unblocked with ThreadControlBlock::UnblockReason::signal; - * - ETIMEDOUT - thread was unblocked because timePoint was reached; - */ - - int blockUntil(ThreadList& container, ThreadState state, TickClock::time_point timePoint, - const ThreadControlBlock::UnblockFunctor* unblockFunctor = {}); - - /** - * \return number of context switches - */ - - uint64_t getContextSwitchCount() const; - - /** - * \return reference to currently active ThreadControlBlock - */ - - ThreadControlBlock& getCurrentThreadControlBlock() const - { - return *currentThreadControlBlock_; - } - - /** - * \return reference to internal SoftwareTimerSupervisor object - */ - - SoftwareTimerSupervisor& getSoftwareTimerSupervisor() - { - return softwareTimerSupervisor_; - } - - /** - * \return const reference to internal SoftwareTimerSupervisor object - */ - - const SoftwareTimerSupervisor& getSoftwareTimerSupervisor() const - { - return softwareTimerSupervisor_; - } - - /** - * \return current value of tick count - */ - - uint64_t getTickCount() const; - - /** - * \brief Scheduler's initialization - * - * \attention This must be called after constructor, before enabling any scheduling. Priority of main thread must - * be higher than priority of idle thread - * - * \param [in] mainThread is a reference to main thread - * - * \return 0 on success, error code otherwise: - * - error codes returned by Scheduler::addInternal(); - */ - - int initialize(MainThread& mainThread); - - /** - * \brief Requests context switch if it is needed. - * - * \attention This function must be called with interrupt masking enabled. - */ - - void maybeRequestContextSwitch() const; - - /** - * \brief Removes current thread from Scheduler's control. - * - * Thread's state is changed to "terminated". - * - * \note This function must be called with masked interrupts. - * - * \note This function can be used only after thread's function returns an all cleanup is done. - * - * \return 0 on success, error code otherwise: - * - EINVAL - provided thread is not on "runnable" list and cannot be removed/terminated; - */ - - int remove(); - - /** - * \brief Resumes suspended thread. - * - * The thread must be on the "suspended" list - trying to resume thread that is not suspended is an error. - * - * \param [in] iterator is the iterator to the thread that will be resumed - * - * \return 0 on success, error code otherwise: - * - EINVAL - provided thread is not on "suspended" list; - */ - - int resume(ThreadList::iterator iterator); - - /** - * \brief Suspends current thread. - * - * \return 0 on success, error code otherwise: - * - EINTR - thread was unblocked with ThreadControlBlock::UnblockReason::signal; - */ - - int suspend(); - - /** - * \brief Suspends thread. - * - * The thread must be on "runnable" list - trying to suspend thread in other state is an error. - * - * \param [in] iterator is the iterator to the thread that will be suspended - * - * \return 0 on success, error code otherwise: - * - EINTR - thread was unblocked with ThreadControlBlock::UnblockReason::signal; - * - EINVAL - provided thread is not on "runnable" list; - */ - - int suspend(ThreadList::iterator iterator); - - /** - * \brief Called by architecture-specific code to do final context switch. - * - * Current task is suspended and the next available task is started. - * - * \param [in] stackPointer is the current value of current thread's stack pointer - * - * \return new thread's stack pointer - */ - - void* switchContext(void* stackPointer); - - /** - * \brief Handler of "tick" interrupt. - * - * \note this must not be called by user code - * - * \return true if context switch is required, false otherwise - */ - - bool tickInterruptHandler(); - - /** - * \brief Unblocks provided thread, transferring it from it's current container to "runnable" container. - * - * Current container of the thread is obtained with ThreadControlBlock::getList(). - * - * \param [in] iterator is the iterator which points to unblocked thread - * \param [in] unblockReason is the reason of unblocking of the thread, default - - * ThreadControlBlock::UnblockReason::unblockRequest - */ - - void unblock(ThreadList::iterator iterator, - ThreadControlBlock::UnblockReason unblockReason = ThreadControlBlock::UnblockReason::unblockRequest); - - /** - * \brief Yields time slot of the scheduler to next thread. - */ - - void yield(); - -private: - - /** - * \brief Adds new ThreadControlBlock to scheduler. - * - * Internal version - without interrupt masking and call to Scheduler::maybeRequestContextSwitch() - * - * \param [in] threadControlBlock is a reference to added ThreadControlBlock object - * - * \return 0 on success, error code otherwise: - * - error codes returned by ThreadControlBlock::addHook(); - */ - - int addInternal(ThreadControlBlock& threadControlBlock); - - /** - * \brief Blocks thread, transferring it to provided container. - * - * Internal version - without interrupt masking and forced context switch. - * - * \param [in] container is a reference to destination container to which the thread will be transferred - * \param [in] iterator is the iterator to the thread that will be blocked - * \param [in] state is the new state of thread that will be blocked - * \param [in] unblockFunctor is a pointer to ThreadControlBlock::UnblockFunctor which will be executed in - * ThreadControlBlock::unblockHook() - * - * \return 0 on success, error code otherwise: - * - EINVAL - provided thread is not on "runnable" list; - */ - - int blockInternal(ThreadList& container, ThreadList::iterator iterator, ThreadState state, - const ThreadControlBlock::UnblockFunctor* unblockFunctor); - - /** - * \brief Tests whether context switch is required or not. - * - * Context switch is required in following situations: - * - current thread is no longer on "runnable" list, - * - current thread is no longer on the beginning of the "runnable" list (because higher-priority thread is - * available or current thread was "rotated" due to round-robin scheduling policy). - * - * \return true if context switch is required - */ - - bool isContextSwitchRequired() const; - - /** - * \brief Unblocks provided thread, transferring it from it's current container to "runnable" container. - * - * Current container of the thread is obtained with ThreadControlBlock::getList(). Round-robin quantum of thread is - * reset. - * - * \note Internal version - without interrupt masking and yield() - * - * \param [in] iterator is the iterator which points to unblocked thread - * \param [in] unblockReason is the reason of unblocking of the thread - */ - - void unblockInternal(ThreadList::iterator iterator, ThreadControlBlock::UnblockReason unblockReason); - - /// iterator to the currently active ThreadControlBlock - ThreadList::iterator currentThreadControlBlock_; - - /// list of ThreadControlBlock elements in "runnable" state, sorted by priority in descending order - ThreadList runnableList_; - - /// list of ThreadControlBlock elements in "suspended" state, sorted by priority in descending order - ThreadList suspendedList_; - - /// internal SoftwareTimerSupervisor object - SoftwareTimerSupervisor softwareTimerSupervisor_; - - /// number of context switches - uint64_t contextSwitchCount_; - - /// tick count - uint64_t tickCount_; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_SCHEDULER_HPP_ diff --git a/include/distortos/internal/scheduler/SoftwareTimerControlBlock.hpp b/include/distortos/internal/scheduler/SoftwareTimerControlBlock.hpp deleted file mode 100644 index c020d35..0000000 --- a/include/distortos/internal/scheduler/SoftwareTimerControlBlock.hpp +++ /dev/null @@ -1,111 +0,0 @@ -/** - * \file - * \brief SoftwareTimerControlBlock class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_SOFTWARETIMERCONTROLBLOCK_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_SOFTWARETIMERCONTROLBLOCK_HPP_ - -#include "distortos/internal/scheduler/SoftwareTimerListNode.hpp" - -namespace distortos -{ - -class SoftwareTimer; - -namespace internal -{ - -/// SoftwareTimerControlBlock class is a control block of software timer -class SoftwareTimerControlBlock : public SoftwareTimerListNode -{ -public: - - /// type of runner for software timer's function - using FunctionRunner = void(SoftwareTimer&); - - /** - * \brief SoftwareTimerControlBlock's constructor - * - * \param [in] functionRunner is a reference to runner for software timer's function - * \param [in] owner is a reference to SoftwareTimer object that owns this SoftwareTimerControlBlock - */ - - constexpr SoftwareTimerControlBlock(FunctionRunner& functionRunner, SoftwareTimer& owner) : - SoftwareTimerListNode{}, - functionRunner_{functionRunner}, - owner_{owner} - { - - } - - /** - * \brief SoftwareTimerControlBlock's destructor - * - * If the timer is running it is stopped. - */ - - ~SoftwareTimerControlBlock() - { - stop(); - } - - /** - * \return true if the timer is running, false otherwise - */ - - bool isRunning() const - { - return node.isLinked(); - } - - /** - * \brief Runs software timer's function. - * - * \note this should only be called by SoftwareTimerSupervisor::tickInterruptHandler() - */ - - void run() const - { - functionRunner_(owner_); - } - - /** - * \brief Starts the timer. - * - * \param [in] timePoint is the time point at which the function will be executed - */ - - void start(TickClock::time_point timePoint); - - /** - * \brief Stops the timer. - */ - - void stop(); - - SoftwareTimerControlBlock(const SoftwareTimerControlBlock&) = delete; - SoftwareTimerControlBlock(SoftwareTimerControlBlock&&) = default; - const SoftwareTimerControlBlock& operator=(const SoftwareTimerControlBlock&) = delete; - SoftwareTimerControlBlock& operator=(SoftwareTimerControlBlock&&) = delete; - -private: - - /// reference to runner for software timer's function - FunctionRunner& functionRunner_; - - /// reference to SoftwareTimer object that owns this SoftwareTimerControlBlock - SoftwareTimer& owner_; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_SOFTWARETIMERCONTROLBLOCK_HPP_ diff --git a/include/distortos/internal/scheduler/SoftwareTimerList.hpp b/include/distortos/internal/scheduler/SoftwareTimerList.hpp deleted file mode 100644 index 5d38f47..0000000 --- a/include/distortos/internal/scheduler/SoftwareTimerList.hpp +++ /dev/null @@ -1,62 +0,0 @@ -/** - * \file - * \brief SoftwareTimerList class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_SOFTWARETIMERLIST_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_SOFTWARETIMERLIST_HPP_ - -#include "distortos/internal/scheduler/SoftwareTimerListNode.hpp" - -#include "estd/SortedIntrusiveList.hpp" - -namespace distortos -{ - -namespace internal -{ - -class SoftwareTimerControlBlock; - -/// functor which gives ascending expiration time point order of elements on the list -struct SoftwareTimerAscendingTimePoint -{ - /** - * \brief SoftwareTimerAscendingTimePoint's constructor - */ - - constexpr SoftwareTimerAscendingTimePoint() - { - - } - - /** - * \brief SoftwareTimerAscendingTimePoint's function call operator - * - * \param [in] left is the object on the left side of comparison - * \param [in] right is the object on the right side of comparison - * - * \return true if left's expiration time point is greater than right's expiration time point - */ - - bool operator()(const SoftwareTimerListNode& left, const SoftwareTimerListNode& right) const - { - return left.getTimePoint() > right.getTimePoint(); - } -}; - -/// sorted intrusive list of software timers (software timer control blocks) -using SoftwareTimerList = estd::SortedIntrusiveList<SoftwareTimerAscendingTimePoint, SoftwareTimerListNode, - &SoftwareTimerListNode::node, SoftwareTimerControlBlock>; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_SOFTWARETIMERLIST_HPP_ diff --git a/include/distortos/internal/scheduler/SoftwareTimerListNode.hpp b/include/distortos/internal/scheduler/SoftwareTimerListNode.hpp deleted file mode 100644 index 299e078..0000000 --- a/include/distortos/internal/scheduler/SoftwareTimerListNode.hpp +++ /dev/null @@ -1,82 +0,0 @@ -/** - * \file - * \brief SoftwareTimerListNode class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_SOFTWARETIMERLISTNODE_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_SOFTWARETIMERLISTNODE_HPP_ - -#include "distortos/TickClock.hpp" - -#include "estd/IntrusiveList.hpp" - -namespace distortos -{ - -namespace internal -{ - -/** - * \brief SoftwareTimerListNode class is a base for SoftwareTimerControlBlock that serves as a node in intrusive list of - * software timers (software timer control blocks) - * - * This class is needed to break any potential circular dependencies. - */ - -class SoftwareTimerListNode -{ -public: - - /** - * \brief SoftwareTimerListNode's constructor - */ - - constexpr SoftwareTimerListNode() : - node{}, - timePoint_{} - { - - } - - /** - * \return const reference to expiration time point - */ - - const TickClock::time_point& getTimePoint() const - { - return timePoint_; - } - - /// node for intrusive list - estd::IntrusiveListNode node; - -protected: - - /** - * \brief Sets time point of expiration - * - * \param [in] timePoint is the new time point of expiration - */ - - void setTimePoint(const TickClock::time_point timePoint) - { - timePoint_ = timePoint; - } - -private: - - ///time point of expiration - TickClock::time_point timePoint_; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_SOFTWARETIMERLISTNODE_HPP_ diff --git a/include/distortos/internal/scheduler/SoftwareTimerSupervisor.hpp b/include/distortos/internal/scheduler/SoftwareTimerSupervisor.hpp deleted file mode 100644 index 8367a0a..0000000 --- a/include/distortos/internal/scheduler/SoftwareTimerSupervisor.hpp +++ /dev/null @@ -1,66 +0,0 @@ -/** - * \file - * \brief SoftwareTimerSupervisor class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_SOFTWARETIMERSUPERVISOR_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_SOFTWARETIMERSUPERVISOR_HPP_ - -#include "distortos/internal/scheduler/SoftwareTimerList.hpp" - -namespace distortos -{ - -namespace internal -{ - -/// SoftwareTimerSupervisor class is a supervisor of software timers -class SoftwareTimerSupervisor -{ -public: - - /** - * \brief SoftwareTimerControlBlock's constructor - */ - - constexpr SoftwareTimerSupervisor() : - activeList_{} - { - - } - - /** - * \brief Adds SoftwareTimerControlBlock to supervisor, effectively starting the software timer. - * - * \param [in] softwareTimerControlBlock is the SoftwareTimerControlBlock being added/started - */ - - void add(SoftwareTimerControlBlock& softwareTimerControlBlock); - - /** - * \brief Handler of "tick" interrupt. - * - * \note this must not be called by user code - * - * \param [in] timePoint is the current time point - */ - - void tickInterruptHandler(TickClock::time_point timePoint); - -private: - - /// list of active software timers (waiting for execution) - SoftwareTimerList activeList_; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_SOFTWARETIMERSUPERVISOR_HPP_ diff --git a/include/distortos/internal/scheduler/ThreadControlBlock.hpp b/include/distortos/internal/scheduler/ThreadControlBlock.hpp deleted file mode 100644 index 6d6f458..0000000 --- a/include/distortos/internal/scheduler/ThreadControlBlock.hpp +++ /dev/null @@ -1,336 +0,0 @@ -/** - * \file - * \brief ThreadControlBlock class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_THREADCONTROLBLOCK_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_THREADCONTROLBLOCK_HPP_ - -#include "distortos/internal/scheduler/RoundRobinQuantum.hpp" -#include "distortos/internal/scheduler/ThreadListNode.hpp" - -#include "distortos/internal/synchronization/MutexList.hpp" - -#include "distortos/architecture/Stack.hpp" - -#include "distortos/SchedulingPolicy.hpp" -#include "distortos/ThreadState.hpp" - -#include "estd/TypeErasedFunctor.hpp" - -namespace distortos -{ - -class SignalsReceiver; - -namespace internal -{ - -class SignalsReceiverControlBlock; -class ThreadList; -class ThreadGroupControlBlock; - -/// ThreadControlBlock class is a simple description of a Thread -class ThreadControlBlock : public ThreadListNode -{ -public: - - /// reason of thread unblocking - enum class UnblockReason : uint8_t - { - /// explicit request to unblock the thread - normal unblock - unblockRequest, - /// timeout - unblock via software timer - timeout, - /// signal handler - unblock to deliver unmasked signal - signal, - }; - - /// UnblockFunctor is a functor executed when unblocking the thread, it receives two parameter - a reference to - /// ThreadControlBlock that is being unblocked and the reason of thread unblocking - class UnblockFunctor : public estd::TypeErasedFunctor<void(ThreadControlBlock&, UnblockReason)> - { - - }; - - /** - * \brief ThreadControlBlock constructor. - * - * \param [in] stack is an rvalue reference to architecture::Stack object which will be adopted for this thread - * \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest - * \param [in] schedulingPolicy is the scheduling policy of the thread - * \param [in] threadGroupControlBlock is a pointer to ThreadGroupControlBlock to which this object will be added, - * nullptr to inherit thread group from currently running thread - * \param [in] signalsReceiver is a pointer to SignalsReceiver object for this thread, nullptr to disable reception - * of signals for this thread - * \param [in] owner is a reference to Thread object that owns this ThreadControlBlock - */ - - ThreadControlBlock(architecture::Stack&& stack, uint8_t priority, SchedulingPolicy schedulingPolicy, - ThreadGroupControlBlock* threadGroupControlBlock, SignalsReceiver* signalsReceiver, Thread& owner); - - /** - * \brief ThreadControlBlock's destructor - */ - - ~ThreadControlBlock(); - - /** - * \brief Hook function executed when thread is added to scheduler. - * - * If threadGroupControlBlock_ is nullptr, it is inherited from currently running thread. Then this object is added - * to the thread group (if it is valid). - * - * \attention This function should be called only by Scheduler::addInternal(). - * - * \return 0 on success, error code otherwise: - * - EINVAL - inherited thread group is invalid; - */ - - int addHook(); - - /** - * \brief Block hook function of thread - * - * Saves pointer to UnblockFunctor. - * - * \attention This function should be called only by Scheduler::blockInternal(). - * - * \param [in] unblockFunctor is a pointer to UnblockFunctor which will be executed in unblockHook() - */ - - void blockHook(const UnblockFunctor* const unblockFunctor) - { - unblockFunctor_ = unblockFunctor; - } - - /** - * \return pointer to list that has this object - */ - - ThreadList* getList() const - { - return list_; - } - - /** - * \return reference to list of mutexes (mutex control blocks) with enabled priority protocol owned by this thread - */ - - MutexList& getOwnedProtocolMutexList() - { - return ownedProtocolMutexList_; - } - - /** - * \return reference to Thread object that owns this ThreadControlBlock - */ - - Thread& getOwner() const - { - return owner_; - } - - /** - * \return reference to internal RoundRobinQuantum object - */ - - RoundRobinQuantum& getRoundRobinQuantum() - { - return roundRobinQuantum_; - } - - /** - * \return scheduling policy of the thread - */ - - SchedulingPolicy getSchedulingPolicy() const - { - return schedulingPolicy_; - } - - /** - * \return pointer to SignalsReceiverControlBlock object for this thread, nullptr if this thread cannot receive - * signals - */ - - SignalsReceiverControlBlock* getSignalsReceiverControlBlock() const - { - return signalsReceiverControlBlock_; - } - - /** - * \return reference to internal Stack object - */ - - architecture::Stack& getStack() - { - return stack_; - } - - /** - * \return current state of object - */ - - ThreadState getState() const - { - return state_; - } - - /** - * \brief Sets the list that has this object. - * - * \param [in] list is a pointer to list that has this object - */ - - void setList(ThreadList* const list) - { - list_ = list; - } - - /** - * \brief Changes priority of thread. - * - * If the priority really changes, the position in the thread list is adjusted and context switch may be requested. - * - * \param [in] priority is the new priority of thread - * \param [in] alwaysBehind selects the method of ordering when lowering the priority - * - false - the thread is moved to the head of the group of threads with the new priority (default), - * - true - the thread is moved to the tail of the group of threads with the new priority. - */ - - void setPriority(uint8_t priority, bool alwaysBehind = {}); - - /** - * \param [in] priorityInheritanceMutexControlBlock is a pointer to MutexControlBlock (with PriorityInheritance - * protocol) that blocks this thread - */ - - void setPriorityInheritanceMutexControlBlock(const MutexControlBlock* const priorityInheritanceMutexControlBlock) - { - priorityInheritanceMutexControlBlock_ = priorityInheritanceMutexControlBlock; - } - - /** - * param [in] schedulingPolicy is the new scheduling policy of the thread - */ - - void setSchedulingPolicy(SchedulingPolicy schedulingPolicy); - - /** - * \param [in] state is the new state of object - */ - - void setState(const ThreadState state) - { - state_ = state; - } - - /** - * \brief Hook function called when context is switched to this thread. - * - * Sets global _impure_ptr (from newlib) to thread's \a reent_ member variable. - * - * \attention This function should be called only by Scheduler::switchContext(). - */ - - void switchedToHook() - { - _impure_ptr = &reent_; - } - - /** - * \brief Unblock hook function of thread - * - * Resets round-robin's quantum and executes unblock functor saved in blockHook(). - * - * \attention This function should be called only by Scheduler::unblockInternal(). - * - * \param [in] unblockReason is the new reason of unblocking of the thread - */ - - void unblockHook(UnblockReason unblockReason); - - /** - * \brief Updates boosted priority of the thread. - * - * This function should be called after all operations involving this thread and a mutex with enabled priority - * protocol. - * - * \param [in] boostedPriority is the initial boosted priority, this should be effective priority of the thread that - * is about to be blocked on a mutex owned by this thread, default - 0 - */ - - void updateBoostedPriority(uint8_t boostedPriority = {}); - - ThreadControlBlock(const ThreadControlBlock&) = delete; - ThreadControlBlock(ThreadControlBlock&&) = default; - const ThreadControlBlock& operator=(const ThreadControlBlock&) = delete; - ThreadControlBlock& operator=(ThreadControlBlock&&) = delete; - -private: - - /** - * \brief Repositions the thread on the list it's currently on. - * - * This function should be called when thread's effective priority changes. - * - * \attention list_ must not be nullptr - * - * \param [in] loweringBefore selects the method of ordering when lowering the priority (it must be false when the - * priority is raised!): - * - true - the thread is moved to the head of the group of threads with the new priority, this is accomplished by - * temporarily boosting effective priority by 1, - * - false - the thread is moved to the tail of the group of threads with the new priority. - */ - - void reposition(bool loweringBefore); - - /// internal stack object - architecture::Stack stack_; - - /// reference to Thread object that owns this ThreadControlBlock - Thread& owner_; - - /// list of mutexes (mutex control blocks) with enabled priority protocol owned by this thread - MutexList ownedProtocolMutexList_; - - /// pointer to MutexControlBlock (with PriorityInheritance protocol) that blocks this thread - const MutexControlBlock* priorityInheritanceMutexControlBlock_; - - /// pointer to list that has this object - ThreadList* list_; - - /// pointer to ThreadGroupControlBlock with which this object is associated - ThreadGroupControlBlock* threadGroupControlBlock_; - - /// functor executed in unblockHook() - const UnblockFunctor* unblockFunctor_; - - /// pointer to SignalsReceiverControlBlock object for this thread, nullptr if this thread cannot receive signals - SignalsReceiverControlBlock* signalsReceiverControlBlock_; - - /// newlib's _reent structure with thread-specific data - _reent reent_; - - /// round-robin quantum - RoundRobinQuantum roundRobinQuantum_; - - /// scheduling policy of the thread - SchedulingPolicy schedulingPolicy_; - - /// current state of object - ThreadState state_; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_THREADCONTROLBLOCK_HPP_ diff --git a/include/distortos/internal/scheduler/ThreadGroupControlBlock.hpp b/include/distortos/internal/scheduler/ThreadGroupControlBlock.hpp deleted file mode 100644 index 59ff313..0000000 --- a/include/distortos/internal/scheduler/ThreadGroupControlBlock.hpp +++ /dev/null @@ -1,61 +0,0 @@ -/** - * \file - * \brief ThreadGroupControlBlock class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_THREADGROUPCONTROLBLOCK_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_THREADGROUPCONTROLBLOCK_HPP_ - -#include "distortos/internal/scheduler/ThreadListNode.hpp" - -namespace distortos -{ - -namespace internal -{ - -class ThreadControlBlock; - -/// ThreadGroupControlBlock class is a control block for ThreadGroup -class ThreadGroupControlBlock -{ -public: - - /** - * \brief ThreadGroupControlBlock's constructor - */ - - constexpr ThreadGroupControlBlock() : - threadList_{} - { - - } - - /** - * \brief Adds new ThreadControlBlock to internal list of this object. - * - * \param [in] threadControlBlock is a reference to added ThreadControlBlock object - */ - - void add(ThreadControlBlock& threadControlBlock); - -private: - - /// intrusive list of threads (thread control blocks) - using List = estd::IntrusiveList<ThreadListNode, &ThreadListNode::threadGroupNode, ThreadControlBlock>; - - /// list of threads (thread control blocks) in this group - List threadList_; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_THREADGROUPCONTROLBLOCK_HPP_ diff --git a/include/distortos/internal/scheduler/ThreadList.hpp b/include/distortos/internal/scheduler/ThreadList.hpp deleted file mode 100644 index edf2483..0000000 --- a/include/distortos/internal/scheduler/ThreadList.hpp +++ /dev/null @@ -1,65 +0,0 @@ -/** - * \file - * \brief ThreadList class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_THREADLIST_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_THREADLIST_HPP_ - -#include "distortos/internal/scheduler/ThreadListNode.hpp" - -#include "estd/SortedIntrusiveList.hpp" - -namespace distortos -{ - -namespace internal -{ - -class ThreadControlBlock; - -/// functor which gives descending effective priority order of elements on the list -struct ThreadDescendingEffectivePriority -{ - /** - * \brief ThreadDescendingEffectivePriority's constructor - */ - - constexpr ThreadDescendingEffectivePriority() - { - - } - - /** - * \brief ThreadDescendingEffectivePriority's function call operator - * - * \param [in] left is the object on the left-hand side of comparison - * \param [in] right is the object on the right-hand side of comparison - * - * \return true if left's effective priority is less than right's effective priority - */ - - bool operator()(const ThreadListNode& left, const ThreadListNode& right) const - { - return left.getEffectivePriority() < right.getEffectivePriority(); - } -}; - -/// sorted intrusive list of threads (thread control blocks) -class ThreadList : public estd::SortedIntrusiveList<ThreadDescendingEffectivePriority, ThreadListNode, - &ThreadListNode::threadListNode, ThreadControlBlock> -{ - -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_THREADLIST_HPP_ diff --git a/include/distortos/internal/scheduler/ThreadListNode.hpp b/include/distortos/internal/scheduler/ThreadListNode.hpp deleted file mode 100644 index fcd7c85..0000000 --- a/include/distortos/internal/scheduler/ThreadListNode.hpp +++ /dev/null @@ -1,86 +0,0 @@ -/** - * \file - * \brief ThreadListNode class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_THREADLISTNODE_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_THREADLISTNODE_HPP_ - -#include "estd/IntrusiveList.hpp" - -namespace distortos -{ - -namespace internal -{ - -/** - * \brief ThreadListNode class is a base for ThreadControlBlock that provides nodes for intrusive lists - * - * This class is needed to break circular dependency - MutexList is contained in ThreadControlBlock and ThreadList is - * contained in MutexControlBlock. - */ - -class ThreadListNode -{ -public: - - /** - * \brief ThreadListNode's constructor - * - * \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest - */ - - constexpr ThreadListNode(const uint8_t priority) : - threadListNode{}, - threadGroupNode{}, - priority_{priority}, - boostedPriority_{} - { - - } - - /** - * \return effective priority of thread - */ - - uint8_t getEffectivePriority() const - { - return std::max(priority_, boostedPriority_); - } - - /** - * \return priority of thread - */ - - uint8_t getPriority() const - { - return priority_; - } - - /// node for intrusive list in thread lists - estd::IntrusiveListNode threadListNode; - - /// node for intrusive list in thread group - estd::IntrusiveListNode threadGroupNode; - -protected: - - /// thread's priority, 0 - lowest, UINT8_MAX - highest - uint8_t priority_; - - /// thread's boosted priority, 0 - no boosting - uint8_t boostedPriority_; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_THREADLISTNODE_HPP_ diff --git a/include/distortos/internal/scheduler/forceContextSwitch.hpp b/include/distortos/internal/scheduler/forceContextSwitch.hpp deleted file mode 100644 index 4509e51..0000000 --- a/include/distortos/internal/scheduler/forceContextSwitch.hpp +++ /dev/null @@ -1,33 +0,0 @@ -/** - * \file - * \brief forceContextSwitch() declaration - * - * \author Copyright (C) 2014-2016 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_FORCECONTEXTSWITCH_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_FORCECONTEXTSWITCH_HPP_ - -namespace distortos -{ - -namespace internal -{ - -/** - * \brief Forces unconditional context switch. - * - * Requests unconditional context switch and temporarily disables any interrupt masking. - */ - -void forceContextSwitch(); - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_FORCECONTEXTSWITCH_HPP_ diff --git a/include/distortos/internal/scheduler/getScheduler.hpp b/include/distortos/internal/scheduler/getScheduler.hpp deleted file mode 100644 index f95d51c..0000000 --- a/include/distortos/internal/scheduler/getScheduler.hpp +++ /dev/null @@ -1,33 +0,0 @@ -/** - * \file - * \brief getScheduler() declaration - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_GETSCHEDULER_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_GETSCHEDULER_HPP_ - -namespace distortos -{ - -namespace internal -{ - -class Scheduler; - -/** - * \return reference to main instance of system's Scheduler - */ - -Scheduler& getScheduler(); - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_GETSCHEDULER_HPP_ diff --git a/include/distortos/internal/scheduler/idleThreadFunction.hpp b/include/distortos/internal/scheduler/idleThreadFunction.hpp deleted file mode 100644 index 23699d4..0000000 --- a/include/distortos/internal/scheduler/idleThreadFunction.hpp +++ /dev/null @@ -1,31 +0,0 @@ -/** - * \file - * \brief idleThreadFunction() declaration - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_IDLETHREADFUNCTION_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_IDLETHREADFUNCTION_HPP_ - -namespace distortos -{ - -namespace internal -{ - -/** - * \brief Idle thread's function - */ - -void idleThreadFunction(); - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_IDLETHREADFUNCTION_HPP_ diff --git a/include/distortos/internal/scheduler/lowLevelInitialization.hpp b/include/distortos/internal/scheduler/lowLevelInitialization.hpp deleted file mode 100644 index a6298c2..0000000 --- a/include/distortos/internal/scheduler/lowLevelInitialization.hpp +++ /dev/null @@ -1,44 +0,0 @@ -/** - * \file - * \brief internal::lowLevelInitialization() declaration - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_LOWLEVELINITIALIZATION_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_LOWLEVELINITIALIZATION_HPP_ - -namespace distortos -{ - -namespace internal -{ - -/*---------------------------------------------------------------------------------------------------------------------+ -| global functions' declarations -+---------------------------------------------------------------------------------------------------------------------*/ - -/** - * \brief Low level system initialization - * - * 1. Initializes main instance of system's Scheduler; - * 2. Initializes main thread with its group; - * 3. Starts idle thread; - * 4. Initializes main instance of Mutex used for malloc() and free() locking; - * 5. Initializes main instance of DeferredThreadDeleter (only if CONFIG_THREAD_DETACH_ENABLE option is enabled); - * - * This function is called before constructors for global and static objects from __libc_init_array() via address in - * distortosPreinitArray[]. - */ - -void lowLevelInitialization(); - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_LOWLEVELINITIALIZATION_HPP_ diff --git a/include/distortos/internal/scheduler/threadRunner.hpp b/include/distortos/internal/scheduler/threadRunner.hpp deleted file mode 100644 index 1cee654..0000000 --- a/include/distortos/internal/scheduler/threadRunner.hpp +++ /dev/null @@ -1,48 +0,0 @@ -/** - * \file - * \brief threadRunner() declaration - * - * \author Copyright (C) 2014-2016 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_THREADRUNNER_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_THREADRUNNER_HPP_ - -namespace distortos -{ - -class Thread; - -namespace internal -{ - -/** - * \brief Thread runner function - entry point of threads. - * - * Performs following actions: - * - executes thread's "run" function; - * - thread's pre-termination hook is executed (if provided); - * - thread is terminated and removed from scheduler; - * - thread's termination hook is executed; - * - context switch is forced; - * - * This function never returns. - * - * \param [in] thread is a reference to Thread object that is being run - * \param [in] run is a reference to Thread's "run" function - * \param [in] preTerminationHook is a pointer to Thread's pre-termination hook, nullptr to skip - * \param [in] terminationHook is a reference to Thread's termination hook - */ - -void threadRunner(Thread& thread, void (& run)(Thread&), void (* preTerminationHook)(Thread&), - void (& terminationHook)(Thread&)) __attribute__ ((noreturn)); - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_THREADRUNNER_HPP_ diff --git a/include/distortos/internal/synchronization/BoundQueueFunctor.hpp b/include/distortos/internal/synchronization/BoundQueueFunctor.hpp deleted file mode 100644 index 35a9d14..0000000 --- a/include/distortos/internal/synchronization/BoundQueueFunctor.hpp +++ /dev/null @@ -1,89 +0,0 @@ -/** - * \file - * \brief BoundQueueFunctor class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_BOUNDQUEUEFUNCTOR_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_BOUNDQUEUEFUNCTOR_HPP_ - -#include "distortos/internal/synchronization/QueueFunctor.hpp" - -#include <utility> - -namespace distortos -{ - -namespace internal -{ - -/** - * \brief BoundQueueFunctor is a type-erased QueueFunctor which calls its bound functor to execute actions on queue's - * storage - * - * \tparam F is the type of bound functor, it will be called with <em>void*</em> as only argument - */ - -template<typename F> -class BoundQueueFunctor : public QueueFunctor -{ -public: - - /** - * \brief BoundQueueFunctor's constructor - * - * \param [in] boundFunctor is a rvalue reference to bound functor which will be used to move-construct internal - * bound functor - */ - - constexpr explicit BoundQueueFunctor(F&& boundFunctor) : - boundFunctor_{std::move(boundFunctor)} - { - - } - - /** - * \brief Calls the bound functor which will execute some action on queue's storage (like copy-constructing, - * swapping, destroying, emplacing, ...) - * - * \param [in,out] storage is a pointer to storage with/for element - */ - - void operator()(void* const storage) const override - { - boundFunctor_(storage); - } - -private: - - /// bound functor - F boundFunctor_; -}; - -/** - * \brief Helper factory function to make BoundQueueFunctor object with deduced template arguments - * - * \tparam F is the type of bound functor, it will be called with <em>void*</em> as only argument - * - * \param [in] boundFunctor is a rvalue reference to bound functor which will be used to move-construct internal bound - * functor - * - * \return BoundQueueFunctor object with deduced template arguments - */ - -template<typename F> -constexpr BoundQueueFunctor<F> makeBoundQueueFunctor(F&& boundFunctor) -{ - return BoundQueueFunctor<F>{std::move(boundFunctor)}; -} - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_BOUNDQUEUEFUNCTOR_HPP_ diff --git a/include/distortos/internal/synchronization/CallOnceControlBlock.hpp b/include/distortos/internal/synchronization/CallOnceControlBlock.hpp deleted file mode 100644 index 1684faf..0000000 --- a/include/distortos/internal/synchronization/CallOnceControlBlock.hpp +++ /dev/null @@ -1,172 +0,0 @@ -/** - * \file - * \brief CallOnceControlBlock class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_CALLONCECONTROLBLOCK_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_CALLONCECONTROLBLOCK_HPP_ - -#include "estd/invoke.hpp" -#include "estd/TypeErasedFunctor.hpp" - -#include <sys/features.h> - -namespace distortos -{ - -/// GCC 4.9 is needed for CallOnceControlBlock::operator()() function - and thus for OnceFlag and callOnce() - earlier -/// versions don't support parameter pack expansion in lambdas -#define DISTORTOS_CALLONCE_SUPPORTED __GNUC_PREREQ(4, 9) - -#if DISTORTOS_CALLONCE_SUPPORTED == 1 || DOXYGEN == 1 - -namespace internal -{ - -class ThreadList; - -/// CallOnceControlBlock class implements functionality of OnceFlag class and callOnce() -/// \note This class requires GCC 4.9. -class CallOnceControlBlock -{ -public: - - /** - * \brief CallOnceControlBlock's constructor - */ - - constexpr CallOnceControlBlock() : - blockedList_{}, - done_{} - { - - } - - /** - * \brief CallOnceControlBlock's function call operator - * - * Does nothing if any function was already called for this object. In other case provided function and arguments - * are wrapped in a type-erased functor and passed to callOnceImplementation(). - * - * \tparam Function is the function object that will be executed - * \tparam Args are the arguments for \a Function - * - * \param [in] function is the function object that will be executed - * \param [in] args are arguments for \a function - */ - - template<typename Function, typename... Args> - void operator()(Function&& function, Args&&... args); - -private: - - /// Functor is a type-erased interface for functors which execute bounded function with bounded arguments - class Functor : public estd::TypeErasedFunctor<void()> - { - - }; - - /** - * \brief BoundedFunctor is a type-erased Functor which calls its bounded functor - * - * \tparam F is the type of bounded functor - */ - - template<typename F> - class BoundedFunctor : public Functor - { - public: - - /** - * \brief BoundedFunctor's constructor - * - * \param [in] boundedFunctor is a rvalue reference to bounded functor which will be used to move-construct - * internal bounded functor - */ - - constexpr explicit BoundedFunctor(F&& boundedFunctor) : - boundedFunctor_{std::move(boundedFunctor)} - { - - } - - /** - * \brief BoundedFunctor's function call operator - * - * Calls the bounded functor. - */ - - void operator()() const override - { - boundedFunctor_(); - } - - private: - - /// bounded functor - F boundedFunctor_; - }; - - /** - * \brief Helper factory function to make BoundedFunctor object with deduced template arguments - * - * \tparam F is the type of bounded functor - * - * \param [in] boundedFunctor is a rvalue reference to bounded functor which will be used to move-construct internal - * bounded functor - * - * \return BoundedFunctor object with deduced template arguments - */ - - template<typename F> - constexpr static BoundedFunctor<F> makeBoundedFunctor(F&& boundedFunctor) - { - return BoundedFunctor<F>{std::move(boundedFunctor)}; - } - - /** - * \brief Implements callOnce() using type-erased functor. - * - * Does nothing if any function was already called for this object. If the function is currently being executed, but - * not yet done, then the calling thread is blocked. In other case the function is executed and - after it is done - - * all blocked threads are unblocked. - * - * \param [in] functor is a reference to functor which will execute bounded function with bounded arguments - */ - - void callOnceImplementation(const Functor& functor); - - /// pointer to stack-allocated list of ThreadControlBlock objects blocked on associated OnceFlag - ThreadList* blockedList_; - - /// tells whether any function was already called for this object (true) or not (false) - bool done_; -}; - -template<typename Function, typename... Args> -void CallOnceControlBlock::operator()(Function&& function, Args&&... args) -{ - if (done_ == true) // function already executed? - return; - - const auto functor = makeBoundedFunctor( - [&function, &args...]() - { - estd::invoke(std::forward<Function>(function), std::forward<Args>(args)...); - }); - callOnceImplementation(functor); -} - -} // namespace internal - -#endif // DISTORTOS_CALLONCE_SUPPORTED == 1 || DOXYGEN == 1 - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_CALLONCECONTROLBLOCK_HPP_ diff --git a/include/distortos/internal/synchronization/CopyConstructQueueFunctor.hpp b/include/distortos/internal/synchronization/CopyConstructQueueFunctor.hpp deleted file mode 100644 index 7c29c8a..0000000 --- a/include/distortos/internal/synchronization/CopyConstructQueueFunctor.hpp +++ /dev/null @@ -1,67 +0,0 @@ -/** - * \file - * \brief CopyConstructQueueFunctor class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_COPYCONSTRUCTQUEUEFUNCTOR_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_COPYCONSTRUCTQUEUEFUNCTOR_HPP_ - -#include "distortos/internal/synchronization/QueueFunctor.hpp" - -namespace distortos -{ - -namespace internal -{ - -/** - * CopyConstructQueueFunctor is a functor used for pushing of data to the queue using copy-construction - * - * \tparam T is the type of data pushed to the queue - */ - -template<typename T> -class CopyConstructQueueFunctor : public QueueFunctor -{ -public: - - /** - * \brief CopyConstructQueueFunctor's constructor - * - * \param [in] value is a reference to object that will be used as argument of copy constructor - */ - - constexpr explicit CopyConstructQueueFunctor(const T& value) : - value_{value} - { - - } - - /** - * \brief Copy-constructs the element in the queue's storage - * - * \param [in,out] storage is a pointer to storage for element - */ - - void operator()(void* const storage) const override - { - new (storage) T{value_}; - } - -private: - - /// reference to object that will be used as argument of copy constructor - const T& value_; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_COPYCONSTRUCTQUEUEFUNCTOR_HPP_ diff --git a/include/distortos/internal/synchronization/FifoQueueBase.hpp b/include/distortos/internal/synchronization/FifoQueueBase.hpp deleted file mode 100644 index f45eec8..0000000 --- a/include/distortos/internal/synchronization/FifoQueueBase.hpp +++ /dev/null @@ -1,145 +0,0 @@ -/** - * \file - * \brief FifoQueueBase class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_FIFOQUEUEBASE_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_FIFOQUEUEBASE_HPP_ - -#include "distortos/Semaphore.hpp" - -#include "distortos/internal/synchronization/QueueFunctor.hpp" -#include "distortos/internal/synchronization/SemaphoreFunctor.hpp" - -#include <memory> - -namespace distortos -{ - -namespace internal -{ - -/// FifoQueueBase class implements basic functionality of FifoQueue template class -class FifoQueueBase -{ -public: - - /// unique_ptr (with deleter) to storage - using StorageUniquePointer = std::unique_ptr<void, void(&)(void*)>; - - /** - * \brief FifoQueueBase's constructor - * - * \param [in] storageUniquePointer is a rvalue reference to StorageUniquePointer with storage for queue elements - * (sufficiently large for \a maxElements, each \a elementSize bytes long) and appropriate deleter - * \param [in] elementSize is the size of single queue element, bytes - * \param [in] maxElements is the number of elements in storage - */ - - FifoQueueBase(StorageUniquePointer&& storageUniquePointer, size_t elementSize, size_t maxElements); - - /** - * \brief FifoQueueBase's destructor - */ - - ~FifoQueueBase(); - - /** - * \return size of single queue element, bytes - */ - - size_t getElementSize() const - { - return elementSize_; - } - - /** - * \brief Implementation of pop() using type-erased functor - * - * \param [in] waitSemaphoreFunctor is a reference to SemaphoreFunctor which will be executed with \a popSemaphore_ - * \param [in] functor is a reference to QueueFunctor which will execute actions related to popping - it will get - * readPosition_ as argument - * - * \return zero if element was popped successfully, error code otherwise: - * - error codes returned by \a waitSemaphoreFunctor's operator() call; - * - error codes returned by Semaphore::post(); - */ - - int pop(const SemaphoreFunctor& waitSemaphoreFunctor, const QueueFunctor& functor) - { - return popPush(waitSemaphoreFunctor, functor, popSemaphore_, pushSemaphore_, readPosition_); - } - - /** - * \brief Implementation of push() using type-erased functor - * - * \param [in] waitSemaphoreFunctor is a reference to SemaphoreFunctor which will be executed with \a pushSemaphore_ - * \param [in] functor is a reference to QueueFunctor which will execute actions related to pushing - it will get - * writePosition_ as argument - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by \a waitSemaphoreFunctor's operator() call; - * - error codes returned by Semaphore::post(); - */ - - int push(const SemaphoreFunctor& waitSemaphoreFunctor, const QueueFunctor& functor) - { - return popPush(waitSemaphoreFunctor, functor, pushSemaphore_, popSemaphore_, writePosition_); - } - -private: - - /** - * \brief Implementation of pop() and push() using type-erased functor - * - * \param [in] waitSemaphoreFunctor is a reference to SemaphoreFunctor which will be executed with \a waitSemaphore - * \param [in] functor is a reference to QueueFunctor which will execute actions related to popping/pushing - it - * will get \a storage as argument - * \param [in] waitSemaphore is a reference to semaphore that will be waited for, \a popSemaphore_ for pop(), \a - * pushSemaphore_ for push() - * \param [in] postSemaphore is a reference to semaphore that will be posted after the operation, \a pushSemaphore_ - * for pop(), \a popSemaphore_ for push() - * \param [in] storage is a reference to appropriate pointer to storage, which will be passed to \a functor, \a - * readPosition_ for pop(), \a writePosition_ for push() - * - * \return zero if operation was successful, error code otherwise: - * - error codes returned by \a waitSemaphoreFunctor's operator() call; - * - error codes returned by Semaphore::post(); - */ - - int popPush(const SemaphoreFunctor& waitSemaphoreFunctor, const QueueFunctor& functor, Semaphore& waitSemaphore, - Semaphore& postSemaphore, void*& storage); - - /// semaphore guarding access to "pop" functions - its value is equal to the number of available elements - Semaphore popSemaphore_; - - /// semaphore guarding access to "push" functions - its value is equal to the number of free slots - Semaphore pushSemaphore_; - - /// storage for queue elements - const StorageUniquePointer storageUniquePointer_; - - /// pointer to past-the-last element of storage for queue elements - const void* const storageEnd_; - - /// pointer to first element available for reading - void* readPosition_; - - /// pointer to first free slot available for writing - void* writePosition_; - - /// size of single queue element, bytes - const size_t elementSize_; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_FIFOQUEUEBASE_HPP_ diff --git a/include/distortos/internal/synchronization/MemcpyPopQueueFunctor.hpp b/include/distortos/internal/synchronization/MemcpyPopQueueFunctor.hpp deleted file mode 100644 index 29113a5..0000000 --- a/include/distortos/internal/synchronization/MemcpyPopQueueFunctor.hpp +++ /dev/null @@ -1,65 +0,0 @@ -/** - * \file - * \brief MemcpyPopQueueFunctor class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_MEMCPYPOPQUEUEFUNCTOR_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_MEMCPYPOPQUEUEFUNCTOR_HPP_ - -#include "distortos/internal/synchronization/QueueFunctor.hpp" - -#include <cstddef> - -namespace distortos -{ - -namespace internal -{ - -/// MemcpyPopQueueFunctor is a functor used for popping of data from the raw queue with memecpy() -class MemcpyPopQueueFunctor : public QueueFunctor -{ -public: - - /** - * \brief MemcpyPopQueueFunctor's constructor - * - * \param [out] buffer is a pointer to buffer for popped element - * \param [in] size is the size of \a buffer, bytes - */ - - constexpr MemcpyPopQueueFunctor(void* const buffer, const size_t size) : - buffer_{buffer}, - size_{size} - { - - } - - /** - * \brief Copies the data from raw queue's storage (with memcpy()). - * - * \param [in,out] storage is a pointer to storage for element - */ - - void operator()(void* storage) const override; - -private: - - /// pointer to buffer for popped element - void* const buffer_; - - /// size of \a buffer_, bytes - const size_t size_; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_MEMCPYPOPQUEUEFUNCTOR_HPP_ diff --git a/include/distortos/internal/synchronization/MemcpyPushQueueFunctor.hpp b/include/distortos/internal/synchronization/MemcpyPushQueueFunctor.hpp deleted file mode 100644 index 89fb4b0..0000000 --- a/include/distortos/internal/synchronization/MemcpyPushQueueFunctor.hpp +++ /dev/null @@ -1,65 +0,0 @@ -/** - * \file - * \brief MemcpyPushQueueFunctor class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_MEMCPYPUSHQUEUEFUNCTOR_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_MEMCPYPUSHQUEUEFUNCTOR_HPP_ - -#include "distortos/internal/synchronization/QueueFunctor.hpp" - -#include <cstddef> - -namespace distortos -{ - -namespace internal -{ - -/// MemcpyPushQueueFunctor is a functor used for pushing of data to the raw queue with memcpy() -class MemcpyPushQueueFunctor : public QueueFunctor -{ -public: - - /** - * \brief MemcpyPushQueueFunctor's constructor - * - * \param [in] data is a pointer to data that will be pushed to raw queue - * \param [in] size is the size of \a data, bytes - */ - - constexpr MemcpyPushQueueFunctor(const void* const data, const size_t size) : - data_{data}, - size_{size} - { - - } - - /** - * \brief Copies the data to raw queue's storage (with memcpy()). - * - * \param [in,out] storage is a pointer to storage for element - */ - - void operator()(void* storage) const override; - -private: - - /// pointer to data that will be pushed to raw queue - const void* const data_; - - /// size of \a data_, bytes - const size_t size_; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_MEMCPYPUSHQUEUEFUNCTOR_HPP_ diff --git a/include/distortos/internal/synchronization/MessageQueueBase.hpp b/include/distortos/internal/synchronization/MessageQueueBase.hpp deleted file mode 100644 index e0bd4e5..0000000 --- a/include/distortos/internal/synchronization/MessageQueueBase.hpp +++ /dev/null @@ -1,221 +0,0 @@ -/** - * \file - * \brief MessageQueueBase class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_MESSAGEQUEUEBASE_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_MESSAGEQUEUEBASE_HPP_ - -#include "distortos/Semaphore.hpp" - -#include "distortos/internal/synchronization/QueueFunctor.hpp" -#include "distortos/internal/synchronization/SemaphoreFunctor.hpp" - -#include "estd/SortedIntrusiveForwardList.hpp" - -#include <memory> - -namespace distortos -{ - -namespace internal -{ - -/// MessageQueueBase class implements basic functionality of MessageQueue template class -class MessageQueueBase -{ -public: - - /// entry in the MessageQueueBase - struct Entry - { - /** - * \brief Entry's constructor - * - * \param [in] priorityy is the priority of the entry - * \param [in] storagee is the storage for the entry - */ - - constexpr Entry(const uint8_t priorityy, void* const storagee) : - node{}, - priority{priorityy}, - storage{storagee} - { - - } - - /// node for intrusive forward list - estd::IntrusiveForwardListNode node; - - /// priority of the entry - uint8_t priority; - - /// storage for the entry - void* storage; - }; - - /// type of uninitialized storage for Entry - using EntryStorage = typename std::aligned_storage<sizeof(Entry), alignof(Entry)>::type; - - /// unique_ptr (with deleter) to EntryStorage[] - using EntryStorageUniquePointer = std::unique_ptr<EntryStorage[], void(&)(EntryStorage*)>; - - /** - * type of uninitialized storage for value - * - * \tparam T is the type of data in queue - */ - - template<typename T> - using ValueStorage = typename std::aligned_storage<sizeof(T), alignof(T)>::type; - - /// unique_ptr (with deleter) to storage - using ValueStorageUniquePointer = std::unique_ptr<void, void(&)(void*)>; - - /// functor which gives descending priority order of elements on the list - struct DescendingPriority - { - /** - * \brief DescendingPriority's constructor - */ - - constexpr DescendingPriority() - { - - } - - /** - * \brief DescendingPriority's function call operator - * - * \param [in] left is the object on the left side of comparison - * \param [in] right is the object on the right side of comparison - * - * \return true if left's priority is less than right's priority - */ - - bool operator()(const Entry& left, const Entry& right) const - { - return left.priority < right.priority; - } - }; - - /// type of entry list - using EntryList = estd::SortedIntrusiveForwardList<DescendingPriority, Entry, &Entry::node>; - - /// type of free entry list - using FreeEntryList = EntryList::UnsortedIntrusiveForwardList; - - /** - * \brief InternalFunctor is a type-erased interface for functors which execute common code of pop() and push() - * operations. - * - * The functor will be called by MessageQueueBase internals with references to \a entryList_ and \a freeEntryList_. - * It should perform common actions and execute the QueueFunctor passed from callers. - */ - - class InternalFunctor : public estd::TypeErasedFunctor<void(EntryList&, FreeEntryList&)> - { - - }; - - /** - * \brief MessageQueueBase's constructor - * - * \param [in] entryStorageUniquePointer is a rvalue reference to EntryStorageUniquePointer with storage for queue - * entries (sufficiently large for \a maxElements EntryStorage objects) and appropriate deleter - * \param [in] valueStorageUniquePointer is a rvalue reference to ValueStorageUniquePointer with storage for queue - * elements (sufficiently large for \a maxElements, each \a elementSize bytes long) and appropriate deleter - * \param [in] elementSize is the size of single queue element, bytes - * \param [in] maxElements is the number of elements in \a entryStorage array and valueStorage memory block - */ - - MessageQueueBase(EntryStorageUniquePointer&& entryStorageUniquePointer, - ValueStorageUniquePointer&& valueStorageUniquePointer, size_t elementSize, size_t maxElements); - - /** - * \brief MessageQueueBase's destructor - */ - - ~MessageQueueBase(); - - /** - * \brief Implementation of pop() using type-erased functor - * - * \param [in] waitSemaphoreFunctor is a reference to SemaphoreFunctor which will be executed with \a popSemaphore_ - * \param [out] priority is a reference to variable that will be used to return priority of popped value - * \param [in] functor is a reference to QueueFunctor which will execute actions related to popping - it will get a - * pointer to storage with element - * - * \return zero if element was popped successfully, error code otherwise: - * - error codes returned by \a waitSemaphoreFunctor's operator() call; - * - error codes returned by Semaphore::post(); - */ - - int pop(const SemaphoreFunctor& waitSemaphoreFunctor, uint8_t& priority, const QueueFunctor& functor); - - /** - * \brief Implementation of push() using type-erased functor - * - * \param [in] waitSemaphoreFunctor is a reference to SemaphoreFunctor which will be executed with \a pushSemaphore_ - * \param [in] priority is the priority of new element - * \param [in] functor is a reference to QueueFunctor which will execute actions related to pushing - it will get a - * pointer to storage for element - * - * \return zero if element was pushed successfully, error code otherwise: - * - error codes returned by \a waitSemaphoreFunctor's operator() call; - * - error codes returned by Semaphore::post(); - */ - - int push(const SemaphoreFunctor& waitSemaphoreFunctor, uint8_t priority, const QueueFunctor& functor); - -private: - - /** - * \brief Implementation of pop() and push() using type-erased internal functor - * - * \param [in] waitSemaphoreFunctor is a reference to SemaphoreFunctor which will be executed with \a waitSemaphore - * \param [in] internalFunctor is a reference to InternalFunctor which will execute actions related to - * popping/pushing - * \param [in] waitSemaphore is a reference to semaphore that will be waited for, \a popSemaphore_ for pop(), \a - * pushSemaphore_ for push() - * \param [in] postSemaphore is a reference to semaphore that will be posted after the operation, \a pushSemaphore_ - * for pop(), \a popSemaphore_ for push() - * - * \return zero if operation was successful, error code otherwise: - * - error codes returned by \a waitSemaphoreFunctor's operator() call; - * - error codes returned by Semaphore::post(); - */ - - int popPush(const SemaphoreFunctor& waitSemaphoreFunctor, const InternalFunctor& internalFunctor, - Semaphore& waitSemaphore, Semaphore& postSemaphore); - - /// semaphore guarding access to "pop" functions - its value is equal to the number of available elements - Semaphore popSemaphore_; - - /// semaphore guarding access to "push" functions - its value is equal to the number of free slots - Semaphore pushSemaphore_; - - /// storage for queue entries - const EntryStorageUniquePointer entryStorageUniquePointer_; - - /// storage for queue elements - const ValueStorageUniquePointer valueStorageUniquePointer_; - - /// list of available entries, sorted in descending order of priority - EntryList entryList_; - - /// list of "free" entries - FreeEntryList freeEntryList_; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_MESSAGEQUEUEBASE_HPP_ diff --git a/include/distortos/internal/synchronization/MoveConstructQueueFunctor.hpp b/include/distortos/internal/synchronization/MoveConstructQueueFunctor.hpp deleted file mode 100644 index ff6587f..0000000 --- a/include/distortos/internal/synchronization/MoveConstructQueueFunctor.hpp +++ /dev/null @@ -1,69 +0,0 @@ -/** - * \file - * \brief MoveConstructQueueFunctor class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_MOVECONSTRUCTQUEUEFUNCTOR_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_MOVECONSTRUCTQUEUEFUNCTOR_HPP_ - -#include "distortos/internal/synchronization/QueueFunctor.hpp" - -#include <utility> - -namespace distortos -{ - -namespace internal -{ - -/** - * MoveConstructQueueFunctor is a functor used for pushing of data to the queue using move-construction - * - * \tparam T is the type of data pushed to the queue - */ - -template<typename T> -class MoveConstructQueueFunctor : public QueueFunctor -{ -public: - - /** - * \brief MoveConstructQueueFunctor's constructor - * - * \param [in] value is a rvalue reference to object that will be used as argument of move constructor - */ - - constexpr explicit MoveConstructQueueFunctor(T&& value) : - value_{std::move(value)} - { - - } - - /** - * \brief Move-constructs the element in the queue's storage - * - * \param [in,out] storage is a pointer to storage for element - */ - - void operator()(void* const storage) const override - { - new (storage) T{std::move(value_)}; - } - -private: - - /// rvalue reference to object that will be used as argument of move constructor - T&& value_; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_MOVECONSTRUCTQUEUEFUNCTOR_HPP_ diff --git a/include/distortos/internal/synchronization/MutexControlBlock.hpp b/include/distortos/internal/synchronization/MutexControlBlock.hpp deleted file mode 100644 index 93c3ee6..0000000 --- a/include/distortos/internal/synchronization/MutexControlBlock.hpp +++ /dev/null @@ -1,184 +0,0 @@ -/** - * \file - * \brief MutexControlBlock class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_MUTEXCONTROLBLOCK_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_MUTEXCONTROLBLOCK_HPP_ - -#include "distortos/internal/scheduler/ThreadList.hpp" - -#include "distortos/internal/synchronization/MutexListNode.hpp" - -#include "distortos/TickClock.hpp" - -namespace distortos -{ - -namespace internal -{ - -/// MutexControlBlock class is a control block for Mutex -class MutexControlBlock : public MutexListNode -{ -public: - - /// mutex protocols - enum class Protocol : uint8_t - { - /// no protocol, similar to PTHREAD_PRIO_NONE - none, - /// priority inheritance protocol, similar to PTHREAD_PRIO_INHERIT - priorityInheritance, - /// priority protection protocol (Immediate Ceiling Priority Protocol), similar to PTHREAD_PRIO_PROTECT - priorityProtect, - }; - - /** - * \brief MutexControlBlock constructor - * - * \param [in] protocol is the mutex protocol - * \param [in] priorityCeiling is the priority ceiling of mutex, ignored when protocol != Protocol::priorityProtect - */ - - constexpr MutexControlBlock(const Protocol protocol, const uint8_t priorityCeiling) : - MutexListNode{}, - blockedList_{}, - owner_{}, - protocol_{protocol}, - priorityCeiling_{priorityCeiling} - { - - } - - /** - * \brief Blocks current thread, transferring it to blockedList_. - * - * \return 0 on success, error code otherwise: - * - values returned by Scheduler::block(); - */ - - int block(); - - /** - * \brief Blocks current thread with timeout, transferring it to blockedList_. - * - * \param [in] timePoint is the time point at which the thread will be unblocked (if not already unblocked) - * - * \return 0 on success, error code otherwise: - * - values returned by Scheduler::blockUntil(); - */ - - int blockUntil(TickClock::time_point timePoint); - - /** - * \brief Gets "boosted priority" of the mutex. - * - * "Boosted priority" of the mutex depends on the selected priority protocol: - * - None - 0, - * - PriorityInheritance - effective priority of the highest priority thread blocked on this mutex or 0 if no - * threads are blocked, - * - PriorityProtect - priority ceiling. - * - * \return "boosted priority" of the mutex - */ - - uint8_t getBoostedPriority() const; - - /** - * \return owner of the mutex, nullptr if mutex is currently unlocked - */ - - ThreadControlBlock* getOwner() const - { - return owner_; - } - - /** - * \return priority ceiling of mutex, valid only when protocol_ == Protocol::priorityProtect - */ - - uint8_t getPriorityCeiling() const - { - return priorityCeiling_; - } - - /** - * \return mutex protocol - */ - - Protocol getProtocol() const - { - return protocol_; - } - - /** - * \brief Performs actual locking of previously unlocked mutex. - * - * \attention mutex must be unlocked - */ - - void lock(); - - /** - * \brief Performs unlocking or transfer of lock from current owner to next thread on the list. - * - * Mutex is unlocked if blockedList_ is empty, otherwise the ownership is transfered to the next thread. - * - * \attention mutex must be locked - */ - - void unlockOrTransferLock(); - -private: - - /** - * \brief Performs action required for priority inheritance before actually blocking on the mutex. - * - * This must be called in block() and blockUntil() before actually blocking of the calling thread. - * - * \attantion mutex's protocol must be PriorityInheritance - */ - - void priorityInheritanceBeforeBlock() const; - - /** - * \brief Performs transfer of lock from current owner to next thread on the list. - * - * \attention mutex must be locked and blockedList_ must not be empty - */ - - void transferLock(); - - /** - * \brief Performs actual unlocking of previously locked mutex. - * - * \attention mutex must be locked and blockedList_ must be empty - */ - - void unlock(); - - /// ThreadControlBlock objects blocked on mutex - ThreadList blockedList_; - - /// owner of the mutex - ThreadControlBlock* owner_; - - /// mutex protocol - Protocol protocol_; - - /// priority ceiling of mutex, valid only when protocol_ == Protocol::priorityProtect - uint8_t priorityCeiling_; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_MUTEXCONTROLBLOCK_HPP_ diff --git a/include/distortos/internal/synchronization/MutexList.hpp b/include/distortos/internal/synchronization/MutexList.hpp deleted file mode 100644 index 18d5794..0000000 --- a/include/distortos/internal/synchronization/MutexList.hpp +++ /dev/null @@ -1,32 +0,0 @@ -/** - * \file - * \brief MutexList class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_MUTEXLIST_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_MUTEXLIST_HPP_ - -#include "distortos/internal/synchronization/MutexListNode.hpp" - -namespace distortos -{ - -namespace internal -{ - -class MutexControlBlock; - -/// intrusive list of mutexes (mutex control blocks) -using MutexList = estd::IntrusiveList<MutexListNode, &MutexListNode::node, MutexControlBlock>; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_MUTEXLIST_HPP_ diff --git a/include/distortos/internal/synchronization/MutexListNode.hpp b/include/distortos/internal/synchronization/MutexListNode.hpp deleted file mode 100644 index 049eb76..0000000 --- a/include/distortos/internal/synchronization/MutexListNode.hpp +++ /dev/null @@ -1,53 +0,0 @@ -/** - * \file - * \brief MutexListNode class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_MUTEXLISTNODE_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_MUTEXLISTNODE_HPP_ - -#include "estd/IntrusiveList.hpp" - -namespace distortos -{ - -namespace internal -{ - -/** - * \brief MutexListNode class is a base for MutexControlBlock that serves as a node in intrusive list of mutexes (mutex - * control blocks) - * - * This class is needed to break circular dependency - MutexList is contained in ThreadControlBlock and ThreadList is - * contained in MutexControlBlock. - */ - -class MutexListNode -{ -public: - - /** - * \brief MutexListNode's constructor - */ - - constexpr MutexListNode() : - node{} - { - - } - - /// node for intrusive list - estd::IntrusiveListNode node; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_MUTEXLISTNODE_HPP_ diff --git a/include/distortos/internal/synchronization/QueueFunctor.hpp b/include/distortos/internal/synchronization/QueueFunctor.hpp deleted file mode 100644 index 7c14a59..0000000 --- a/include/distortos/internal/synchronization/QueueFunctor.hpp +++ /dev/null @@ -1,40 +0,0 @@ -/** - * \file - * \brief QueueFunctor class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_QUEUEFUNCTOR_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_QUEUEFUNCTOR_HPP_ - -#include "estd/TypeErasedFunctor.hpp" - -namespace distortos -{ - -namespace internal -{ - -/** - * \brief QueueFunctor is a type-erased interface for functors which execute some action on queue's storage (like - * copy-constructing, swapping, destroying, emplacing, ...). - * - * The functor will be called by queue internals with one argument - \a storage - which is a pointer to storage with/for - * element - */ - -class QueueFunctor : public estd::TypeErasedFunctor<void(void*)> -{ - -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_SYNCHRONIZATION_QUEUEFUNCTOR_HPP_ diff --git a/include/distortos/internal/synchronization/SemaphoreFunctor.hpp b/include/distortos/internal/synchronization/SemaphoreFunctor.hpp deleted file mode 100644 index 0b937ff..0000000 --- a/include/distortos/internal/synchronization/SemaphoreFunctor.hpp +++ /dev/null @@ -1,43 +0,0 @@ -/** - * \file - * \brief SemaphoreFunctor class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SEMAPHOREFUNCTOR_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SEMAPHOREFUNCTOR_HPP_ - -#include "estd/TypeErasedFunctor.hpp" - -namespace distortos -{ - -class Semaphore; - -namespace internal -{ - -/** - * \brief SemaphoreFunctor is a type-erased interface for functors which execute some action on semaphore (wait(), - * tryWait(), tryWaitFor(), tryWaitUntil(), ...). - * - * The functor will be called with one argument - \a semaphore - which is a reference to Semaphore object on which the - * action will be executed. Functor's operator should return zero if the action was executed successfully, error code - * otherwise. - */ - -class SemaphoreFunctor : public estd::TypeErasedFunctor<int(Semaphore&)> -{ - -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SEMAPHOREFUNCTOR_HPP_ diff --git a/include/distortos/internal/synchronization/SemaphoreTryWaitForFunctor.hpp b/include/distortos/internal/synchronization/SemaphoreTryWaitForFunctor.hpp deleted file mode 100644 index 88580de..0000000 --- a/include/distortos/internal/synchronization/SemaphoreTryWaitForFunctor.hpp +++ /dev/null @@ -1,62 +0,0 @@ -/** - * \file - * \brief SemaphoreTryWaitForFunctor class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SEMAPHORETRYWAITFORFUNCTOR_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SEMAPHORETRYWAITFORFUNCTOR_HPP_ - -#include "distortos/internal/synchronization/SemaphoreFunctor.hpp" - -#include "distortos/TickClock.hpp" - -namespace distortos -{ - -namespace internal -{ - -/// SemaphoreTryWaitForFunctor class is a SemaphoreFunctor which calls Semaphore::tryWaitFor() with bounded duration -class SemaphoreTryWaitForFunctor : public SemaphoreFunctor -{ -public: - - /** - * \brief SemaphoreTryWaitForFunctor's constructor - * - * \param [in] duration is the bounded duration for Semaphore::tryWaitFor() call - */ - - constexpr explicit SemaphoreTryWaitForFunctor(const TickClock::duration duration) : - duration_{duration} - { - - } - - /** - * \brief Calls Semaphore::tryWaitFor() with bounded duration - * - * \param [in] semaphore is a reference to Semaphore object for which Semaphore::tryWaitFor() will be called - * - * \return value returned by Semaphore::tryWaitFor() - */ - - int operator()(Semaphore& semaphore) const override; - -private: - - /// bounded duration for Semaphore::tryWaitFor() call - const TickClock::duration duration_; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SEMAPHORETRYWAITFORFUNCTOR_HPP_ diff --git a/include/distortos/internal/synchronization/SemaphoreTryWaitFunctor.hpp b/include/distortos/internal/synchronization/SemaphoreTryWaitFunctor.hpp deleted file mode 100644 index 4084563..0000000 --- a/include/distortos/internal/synchronization/SemaphoreTryWaitFunctor.hpp +++ /dev/null @@ -1,43 +0,0 @@ -/** - * \file - * \brief SemaphoreTryWaitFunctor class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SEMAPHORETRYWAITFUNCTOR_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SEMAPHORETRYWAITFUNCTOR_HPP_ - -#include "distortos/internal/synchronization/SemaphoreFunctor.hpp" - -namespace distortos -{ - -namespace internal -{ - -/// SemaphoreTryWaitFunctor class is a SemaphoreFunctor which calls Semaphore::tryWait() -class SemaphoreTryWaitFunctor : public SemaphoreFunctor -{ -public: - - /** - * \brief Calls Semaphore::tryWait() - * - * \param [in] semaphore is a reference to Semaphore object for which Semaphore::tryWait() will be called - * - * \return value returned by Semaphore::tryWait() - */ - - int operator()(Semaphore& semaphore) const override; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SEMAPHORETRYWAITFUNCTOR_HPP_ diff --git a/include/distortos/internal/synchronization/SemaphoreTryWaitUntilFunctor.hpp b/include/distortos/internal/synchronization/SemaphoreTryWaitUntilFunctor.hpp deleted file mode 100644 index a8eaab2..0000000 --- a/include/distortos/internal/synchronization/SemaphoreTryWaitUntilFunctor.hpp +++ /dev/null @@ -1,63 +0,0 @@ -/** - * \file - * \brief SemaphoreTryWaitUntilFunctor class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SEMAPHORETRYWAITUNTILFUNCTOR_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SEMAPHORETRYWAITUNTILFUNCTOR_HPP_ - -#include "distortos/internal/synchronization/SemaphoreFunctor.hpp" - -#include "distortos/TickClock.hpp" - -namespace distortos -{ - -namespace internal -{ - -/// SemaphoreTryWaitUntilFunctor class is a SemaphoreFunctor which calls Semaphore::tryWaitUntil() with bounded time -/// point -class SemaphoreTryWaitUntilFunctor : public SemaphoreFunctor -{ -public: - - /** - * \brief SemaphoreTryWaitUntilFunctor's constructor - * - * \param [in] timePoint is the bounded time point for Semaphore::tryWaitUntil() call - */ - - constexpr explicit SemaphoreTryWaitUntilFunctor(const TickClock::time_point timePoint) : - timePoint_{timePoint} - { - - } - - /** - * \brief Calls Semaphore::tryWaitUntil() with bounded time point. - * - * \param [in] semaphore is a reference to Semaphore object for which Semaphore::tryWaitUntil() will be called - * - * \return value returned by Semaphore::tryWaitUntil() - */ - - int operator()(Semaphore& semaphore) const override; - -private: - - /// bounded time point for Semaphore::tryWaitUntil() call - const TickClock::time_point timePoint_; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SEMAPHORETRYWAITUNTILFUNCTOR_HPP_ diff --git a/include/distortos/internal/synchronization/SemaphoreWaitFunctor.hpp b/include/distortos/internal/synchronization/SemaphoreWaitFunctor.hpp deleted file mode 100644 index a787b2b..0000000 --- a/include/distortos/internal/synchronization/SemaphoreWaitFunctor.hpp +++ /dev/null @@ -1,43 +0,0 @@ -/** - * \file - * \brief SemaphoreWaitFunctor class header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SEMAPHOREWAITFUNCTOR_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SEMAPHOREWAITFUNCTOR_HPP_ - -#include "distortos/internal/synchronization/SemaphoreFunctor.hpp" - -namespace distortos -{ - -namespace internal -{ - -/// SemaphoreWaitFunctor class is a SemaphoreFunctor which calls Semaphore::wait() -class SemaphoreWaitFunctor : public SemaphoreFunctor -{ -public: - - /** - * \brief Calls Semaphore::wait() - * - * \param [in] semaphore is a reference to Semaphore object for which Semaphore::wait() will be called - * - * \return value returned by Semaphore::wait() - */ - - int operator()(Semaphore& semaphore) const override; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SEMAPHOREWAITFUNCTOR_HPP_ diff --git a/include/distortos/internal/synchronization/SignalInformationQueue.hpp b/include/distortos/internal/synchronization/SignalInformationQueue.hpp deleted file mode 100644 index 7a9d08a..0000000 --- a/include/distortos/internal/synchronization/SignalInformationQueue.hpp +++ /dev/null @@ -1,123 +0,0 @@ -/** - * \file - * \brief SignalInformationQueue class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SIGNALINFORMATIONQUEUE_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SIGNALINFORMATIONQUEUE_HPP_ - -#include "distortos/SignalInformation.hpp" - -#include "estd/IntrusiveForwardList.hpp" - -#include <memory> - -namespace distortos -{ - -class SignalSet; - -namespace internal -{ - -/// SignalInformationQueue class can be used for queuing of SignalInformation objects -class SignalInformationQueue -{ -public: - - /// single node of internal forward list - estd::IntrusiveForwardListNode and SignalInformation - struct QueueNode - { - /// node for intrusive forward list - estd::IntrusiveForwardListNode node; - - /// queued SignalInformation - SignalInformation signalInformation; - }; - - /// type of uninitialized storage for QueueNode - using Storage = typename std::aligned_storage<sizeof(QueueNode), alignof(QueueNode)>::type; - - /// unique_ptr (with deleter) to Storage[] - using StorageUniquePointer = std::unique_ptr<Storage[], void(&)(Storage*)>; - - /** - * \brief SignalInformationQueue's constructor - * - * \param [in] storageUniquePointer is a rvalue reference to StorageUniquePointer with storage for queue elements - * (sufficiently large for \a maxElements Storage objects) and appropriate deleter - * \param [in] maxElements is the number of elements in \a storage array - */ - - SignalInformationQueue(StorageUniquePointer&& storageUniquePointer, size_t maxElements); - - /** - * \brief SignalInformationQueue's destructor - */ - - ~SignalInformationQueue(); - - /** - * \brief Accepts (dequeues) one of signals that are queued. - * - * This should be called when the signal is "accepted". - * - * \param [in] signalNumber is the signal that will be accepted, [0; 31] - * - * \return pair with return code (0 on success, error code otherwise) and dequeued SignalInformation object; - * error codes: - * - EAGAIN - no SignalInformation object with signal number equal to \a signalNumber was queued; - */ - - std::pair<int, SignalInformation> acceptQueuedSignal(uint8_t signalNumber); - - /** - * \return set of currently queued signals - */ - - SignalSet getQueuedSignalSet() const; - - /** - * \brief Adds the signalNumber and signal value (sigval union) to list of queued SignalInformation objects. - * - * \param [in] signalNumber is the signal that will be queued, [0; 31] - * \param [in] value is the signal value - * - * \return 0 on success, error code otherwise: - * - EAGAIN - no resources are available to queue the signal, \a maxElements signals are already queued; - * - EINVAL - \a signalNumber value is invalid; - */ - - int queueSignal(uint8_t signalNumber, sigval value); - - SignalInformationQueue(const SignalInformationQueue&) = delete; - SignalInformationQueue(SignalInformationQueue&&) = default; - const SignalInformationQueue& operator=(const SignalInformationQueue&) = delete; - SignalInformationQueue& operator=(SignalInformationQueue&&) = delete; - -private: - - /// type of container with SignalInformation objects - using List = estd::IntrusiveForwardList<QueueNode, &QueueNode::node>; - - /// storage for queue elements - StorageUniquePointer storageUniquePointer_; - - /// list of queued SignalInformation objects - List signalInformationList_; - - /// list of "free" SignalInformation objects - List freeSignalInformationList_; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SIGNALINFORMATIONQUEUE_HPP_ diff --git a/include/distortos/internal/synchronization/SignalsCatcherControlBlock.hpp b/include/distortos/internal/synchronization/SignalsCatcherControlBlock.hpp deleted file mode 100644 index 6676216..0000000 --- a/include/distortos/internal/synchronization/SignalsCatcherControlBlock.hpp +++ /dev/null @@ -1,213 +0,0 @@ -/** - * \file - * \brief SignalsCatcherControlBlock class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SIGNALSCATCHERCONTROLBLOCK_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SIGNALSCATCHERCONTROLBLOCK_HPP_ - -#include "distortos/SignalAction.hpp" - -#include <memory> - -namespace distortos -{ - -namespace internal -{ - -class SignalsReceiverControlBlock; -class ThreadControlBlock; - -/// SignalsCatcherControlBlock class is a structure required by threads for "catching" and "handling" of signals -class SignalsCatcherControlBlock -{ -public: - - /// association of signal numbers (as SignalSet) with SignalAction - using Association = std::pair<SignalSet, SignalAction>; - - /// type of uninitialized storage for Association objects - using Storage = std::aligned_storage<sizeof(Association), alignof(Association)>::type; - - /// unique_ptr (with deleter) to Storage[] - using StorageUniquePointer = std::unique_ptr<Storage[], void(&)(Storage*)>; - - /** - * \brief SignalsCatcherControlBlock's constructor - * - * \param [in] storageUniquePointer is a rvalue reference to StorageUniquePointer with storage for Association - * objects (sufficiently large for \a storageSize elements) and appropriate deleter - * \param [in] storageSize is the number of elements in \a storage array - */ - - SignalsCatcherControlBlock(StorageUniquePointer&& storageUniquePointer, size_t storageSize); - - /** - * \brief SignalsCatcherControlBlock's destructor - */ - - ~SignalsCatcherControlBlock(); - - /** - * \brief Hook function executed when delivery of signals is started. - * - * Clears "delivery pending" flag. - * - * \attention This function should be called only by SignalsReceiverControlBlock::deliveryOfSignalsFinishedHook(). - */ - - void deliveryOfSignalsStartedHook() - { - deliveryIsPending_ = false; - } - - /** - * \brief Gets SignalAction associated with given signal number. - * - * \param [in] signalNumber is the signal for which the association is requested, [0; 31] - * - * \return pair with return code (0 on success, error code otherwise) and SignalAction that is associated with - * \a signalNumber, default-constructed object if no association was found; - * error codes: - * - EINVAL - \a signalNumber value is invalid; - */ - - std::pair<int, SignalAction> getAssociation(uint8_t signalNumber) const; - - /** - * \return SignalSet with signal mask for associated thread - */ - - SignalSet getSignalMask() const - { - return signalMask_; - } - - /** - * \brief Part of SignalsReceiverControlBlock::postGenerate() specific to catching unmasked signals. - * - * Requests delivery of signals to associated thread if there is some non-default signal handler for the signal. - * - * \param [in] signalNumber is the unmasked signal that was generated, [0; 31] - * \param [in] threadControlBlock is a reference to associated ThreadControlBlock - * - * \return 0 on success, error code otherwise: - * - EINVAL - \a signalNumber value is invalid; - */ - - int postGenerate(uint8_t signalNumber, ThreadControlBlock& threadControlBlock); - - /** - * \brief Sets association for given signal number. - * - * \param [in] signalNumber is the signal for which the association will be set, [0; 31] - * \param [in] signalAction is a reference to SignalAction that will be associated with given signal number, object - * in internal storage is copy-constructed - * - * \return pair with return code (0 on success, error code otherwise) and SignalAction that was associated with - * \a signalNumber, default-constructed object if no association was found; - * error codes: - * - EAGAIN - no resources are available to associate \a signalNumber with \a signalAction; - * - EINVAL - \a signalNumber value is invalid; - */ - - std::pair<int, SignalAction> setAssociation(uint8_t signalNumber, const SignalAction& signalAction); - - /** - * \brief Sets signal mask for associated thread. - * - * If any pending signal is unblocked and \a owner doesn't equal nullptr, then delivery of signals to associated - * thread will be requested. - * - * \param [in] signalMask is the SignalSet with new signal mask for associated thread - * \param [in] owner selects whether delivery of signals will be requested if any pending signal is unblocked - * (pointer to owner SignalsReceiverControlBlock object) or not (nullptr) - */ - - void setSignalMask(SignalSet signalMask, const SignalsReceiverControlBlock* owner); - - SignalsCatcherControlBlock(const SignalsCatcherControlBlock&) = delete; - SignalsCatcherControlBlock(SignalsCatcherControlBlock&&) = default; - const SignalsCatcherControlBlock& operator=(const SignalsCatcherControlBlock&) = delete; - SignalsCatcherControlBlock& operator=(SignalsCatcherControlBlock&&) = delete; - -private: - - /** - * \brief Clears association for given signal number. - * - * \param [in] signalNumber is the signal for which the association will be cleared, [0; 31] - * - * \return SignalAction that was associated with \a signalNumber, default-constructed object if no association was - * found - */ - - SignalAction clearAssociation(uint8_t signalNumber); - - /** - * \brief Clears given association for given signal number. - * - * \param [in] signalNumber is the signal for which the association will be cleared, [0; 31] - * \param [in] association is a reference to Association object from <em>[associationsBegin_; associationsEnd_)</em> - * range that will be removed - * - * \return SignalAction from \a association - */ - - SignalAction clearAssociation(uint8_t signalNumber, Association& association); - - /** - * \return pointer to first element of range of Association objects - */ - - Association* getAssociationsBegin() const - { - return reinterpret_cast<Association*>(storageUniquePointer_.get()); - } - - /** - * \brief Requests delivery of signals to associated thread. - * - * Delivery of signals (via special function executed in the associated thread) is requested only if it's not - * already pending. The thread is unblocked if it was blocked. - * - * \param [in] threadControlBlock is a reference to associated ThreadControlBlock - */ - - void requestDeliveryOfSignals(ThreadControlBlock& threadControlBlock); - - /// storage for Association objects - StorageUniquePointer storageUniquePointer_; - - /// SignalSet with signal mask for associated thread - SignalSet signalMask_; - - /// union binds \a associationsEnd_ and \a storageBegin_ - these point to the same address - union - { - /// pointer to "one past the last" element of range of Association objects - Association* associationsEnd_; - - /// pointer to first element of range of Storage objects - Storage* storageBegin_; - }; - - /// pointer to "one past the last" element of range of Storage objects - Storage* storageEnd_; - - /// true if signal delivery is pending, false otherwise - bool deliveryIsPending_; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SIGNALSCATCHERCONTROLBLOCK_HPP_ diff --git a/include/distortos/internal/synchronization/SignalsReceiverControlBlock.hpp b/include/distortos/internal/synchronization/SignalsReceiverControlBlock.hpp deleted file mode 100644 index c70d79d..0000000 --- a/include/distortos/internal/synchronization/SignalsReceiverControlBlock.hpp +++ /dev/null @@ -1,243 +0,0 @@ -/** - * \file - * \brief SignalsReceiverControlBlock class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SIGNALSRECEIVERCONTROLBLOCK_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SIGNALSRECEIVERCONTROLBLOCK_HPP_ - -#include "distortos/SignalSet.hpp" - -#include <cstdint> - -union sigval; - -namespace distortos -{ - -class SignalAction; -class SignalInformation; -class SignalInformationQueueWrapper; -class SignalsCatcher; - -namespace internal -{ - -class SignalInformationQueue; -class SignalsCatcherControlBlock; -class ThreadControlBlock; - -/// SignalsReceiverControlBlock class is a structure required by threads for "receiving" of signals -class SignalsReceiverControlBlock -{ -public: - - /** - * \brief SignalsReceiverControlBlock's constructor - * - * \param [in] signalInformationQueueWrapper is a pointer to SignalInformationQueueWrapper for this receiver, - * nullptr to disable queuing of signals for this receiver - * \param [in] signalsCatcher is a pointer to SignalsCatcher for this receiver, nullptr if this receiver cannot - * catch/handle signals - */ - - explicit SignalsReceiverControlBlock(SignalInformationQueueWrapper* signalInformationQueueWrapper, - SignalsCatcher* signalsCatcher); - - /** - * \brief Accepts (clears) one of signals that are pending. - * - * This should be called when the signal is "accepted". - * - * \param [in] signalNumber is the signal that will be accepted, [0; 31] - * - * \return pair with return code (0 on success, error code otherwise) and SignalInformation object for accepted - * signal; error codes: - * - EAGAIN - no signal specified by \a signalNumber was pending; - * - EINVAL - \a signalNumber value is invalid; - */ - - std::pair<int, SignalInformation> acceptPendingSignal(uint8_t signalNumber); - - /** - * \brief Hook function executed when delivery of signals is started. - * - * Calls SignalsCatcherControlBlock::deliveryOfSignalsStartedHook(). - * - * \attention This function should be called only by the function that delivers signals (<em>deliverSignals()</em>). - * - * \return 0 on success, error code otherwise: - * - ENOTSUP - catching/handling of signals is disabled for this receiver; - */ - - int deliveryOfSignalsStartedHook() const; - - /** - * \brief Generates signal for associated thread. - * - * Similar to pthread_kill() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_kill.html - * - * Adds the signalNumber to set of pending signals. If associated thread is currently waiting for this signal, it - * will be unblocked. - * - * \param [in] signalNumber is the signal that will be generated, [0; 31] - * \param [in] threadControlBlock is a reference to associated ThreadControlBlock - * - * \return 0 on success, error code otherwise: - * - EINVAL - \a signalNumber value is invalid; - */ - - int generateSignal(uint8_t signalNumber, ThreadControlBlock& threadControlBlock); - - /** - * \return set of currently pending signals - */ - - SignalSet getPendingSignalSet() const; - - /** - * \brief Gets SignalAction associated with given signal number. - * - * Similar to sigaction() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sigaction.html - * - * \param [in] signalNumber is the signal for which the association is requested, [0; 31] - * - * \return pair with return code (0 on success, error code otherwise) and SignalAction that is associated with - * \a signalNumber, default-constructed object if no association was found; - * error codes: - * - EINVAL - \a signalNumber value is invalid; - * - ENOTSUP - catching/handling of signals is disabled for this receiver; - */ - - std::pair<int, SignalAction> getSignalAction(uint8_t signalNumber) const; - - /** - * \brief Gets signal mask for associated thread. - * - * Similar to pthread_sigmask() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_sigmask.html# - * - * \return SignalSet with signal mask for associated thread - */ - - SignalSet getSignalMask() const; - - /** - * \brief Queues signal for associated thread. - * - * Similar to sigqueue() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sigqueue.html - * - * Queues the signalNumber and signal value (sigval union) in associated SignalInformationQueue object. If - * associated thread is currently waiting for this signal, it will be unblocked. - * - * \param [in] signalNumber is the signal that will be queued, [0; 31] - * \param [in] value is the signal value - * \param [in] threadControlBlock is a reference to associated ThreadControlBlock - * - * \return 0 on success, error code otherwise: - * - EAGAIN - no resources are available to queue the signal, maximal number of signals is already queued in - * associated SignalInformationQueue object; - * - EINVAL - \a signalNumber value is invalid; - * - ENOTSUP - queuing of signals is disabled for this receiver; - */ - - int queueSignal(uint8_t signalNumber, sigval value, ThreadControlBlock& threadControlBlock) const; - - /** - * \brief Sets association for given signal number. - * - * Similar to sigaction() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/sigaction.html - * - * \param [in] signalNumber is the signal for which the association will be set, [0; 31] - * \param [in] signalAction is a reference to SignalAction that will be associated with given signal number, object - * in internal storage is copy-constructed - * - * \return pair with return code (0 on success, error code otherwise) and SignalAction that was associated with - * \a signalNumber, default-constructed object if no association was found; - * error codes: - * - EAGAIN - no resources are available to associate \a signalNumber with \a signalAction; - * - EINVAL - \a signalNumber value is invalid; - * - ENOTSUP - catching/handling of signals is disabled for this receiver; - */ - - std::pair<int, SignalAction> setSignalAction(uint8_t signalNumber, const SignalAction& signalAction); - - /** - * \brief Sets signal mask for associated thread. - * - * Similar to pthread_sigmask() - http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_sigmask.html# - * - * \param [in] signalMask is the SignalSet with new signal mask for associated thread - * \param [in] requestDelivery selects whether delivery of signals will be requested if any pending signal is - * unblocked (true) or not (false) - * - * \return 0 on success, error code otherwise: - * - ENOTSUP - catching/handling of signals is disabled for this receiver; - */ - - int setSignalMask(SignalSet signalMask, bool requestDelivery); - - /** - * \param [in] signalSet is a pointer to set of signals that will be "waited for", nullptr when wait was terminated - */ - - void setWaitingSignalSet(const SignalSet* const signalSet) - { - waitingSignalSet_ = signalSet; - } - -private: - - /** - * \brief Checks whether signal is ignored. - * - * Signal is ignored if it has no SignalAction object associated. Signal is never ignored if catching/handling of - * signals is disabled for this receiver. - * - * \param [in] signalNumber is the signal for which the check will be performed, [0; 31] - * - * \return pair with return code (0 on success, error code otherwise) and boolean telling whether the signal is - * ignored (true) or not (false); - * error codes: - * - EINVAL - \a signalNumber value is invalid; - */ - - std::pair<int, bool> isSignalIgnored(uint8_t signalNumber) const; - - /** - * \brief Actions executed after signal is "generated" with generateSignal() or queueSignal(). - * - * If associated thread is currently waiting for the signal that was generated, it will be unblocked. - * - * \param [in] signalNumber is the signal that was generated, [0; 31] - * \param [in] threadControlBlock is a reference to associated ThreadControlBlock - * - * \return 0 on success, error code otherwise: - * - EINVAL - \a signalNumber value is invalid; - */ - - int postGenerate(uint8_t signalNumber, ThreadControlBlock& threadControlBlock) const; - - /// set of pending signals - SignalSet pendingSignalSet_; - - /// pointer to set of "waited for" signals, nullptr if associated thread is not waiting for any signals - const SignalSet* waitingSignalSet_; - - /// pointer to SignalsCatcherControlBlock for this receiver, nullptr if this receiver cannot catch/handle signals - SignalsCatcherControlBlock* signalsCatcherControlBlock_; - - /// pointer to SignalInformationQueue for this receiver, nullptr if this receiver cannot queue signals - SignalInformationQueue* signalInformationQueue_; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SIGNALSRECEIVERCONTROLBLOCK_HPP_ diff --git a/include/distortos/internal/synchronization/SwapPopQueueFunctor.hpp b/include/distortos/internal/synchronization/SwapPopQueueFunctor.hpp deleted file mode 100644 index 1009f3c..0000000 --- a/include/distortos/internal/synchronization/SwapPopQueueFunctor.hpp +++ /dev/null @@ -1,74 +0,0 @@ -/** - * \file - * \brief SwapPopQueueFunctor class header - * - * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SWAPPOPQUEUEFUNCTOR_HPP_ -#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SWAPPOPQUEUEFUNCTOR_HPP_ - -#include "distortos/internal/synchronization/QueueFunctor.hpp" - -#include <utility> - -namespace distortos -{ - -namespace internal -{ - -/** - * SwapPopQueueFunctor is a functor used for popping of data from the queue using swap - * - * \tparam T is the type of data popped from the queue - */ - -template<typename T> -class SwapPopQueueFunctor : public QueueFunctor -{ -public: - - /** - * \brief SwapPopQueueFunctor's constructor - * - * \param [out] value is a reference to object that will be used to return popped value, its contents are swapped - * with the value in the queue's storage and destructed when no longer needed - */ - - constexpr explicit SwapPopQueueFunctor(T& value) : - value_{value} - { - - } - - /** - * \brief Swaps the element in the queue's storage with the value provided by user and destroys this value when no - * longer needed. - * - * \param [in,out] storage is a pointer to storage with element - */ - - void operator()(void* const storage) const override - { - auto& swappedValue = *reinterpret_cast<T*>(storage); - using std::swap; - swap(value_, swappedValue); - swappedValue.~T(); - } - -private: - - /// reference to object that will be used to return popped value - T& value_; -}; - -} // namespace internal - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SWAPPOPQUEUEFUNCTOR_HPP_ diff --git a/include/distortos/statistics.hpp b/include/distortos/statistics.hpp deleted file mode 100644 index 68645ef..0000000 --- a/include/distortos/statistics.hpp +++ /dev/null @@ -1,38 +0,0 @@ -/** - * \file - * \brief statistics namespace header - * - * \author Copyright (C) 2014-2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info - * - * \par License - * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not - * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -#ifndef INCLUDE_DISTORTOS_STATISTICS_HPP_ -#define INCLUDE_DISTORTOS_STATISTICS_HPP_ - -#include <cstdint> - -namespace distortos -{ - -namespace statistics -{ - -/// \addtogroup statistics -/// \{ - -/** - * \return number of context switches - */ - -uint64_t getContextSwitchCount(); - -/// \} - -} // namespace statistics - -} // namespace distortos - -#endif // INCLUDE_DISTORTOS_STATISTICS_HPP_ |