QueueGenericThreadsBlocking.hpp

Go to the documentation of this file.

/* Copyright 2022 Axel Huebl, Benjamin Worpitz, Matthias Werner, Jan Stephan, Bernhard Manfred Gruber
 * SPDX-License-Identifier: MPL-2.0
 */
 
#pragma once
 
#include "alpaka/dev/Traits.hpp"
#include "alpaka/event/Traits.hpp"
#include "alpaka/queue/Traits.hpp"
#include "alpaka/queue/cpu/IGenericThreadsQueue.hpp"
#include "alpaka/wait/Traits.hpp"
 
#include <atomic>
#include <memory>
#include <mutex>
 
namespace alpaka
{
    template<typename TDev>
    class EventGenericThreads;
 
    namespace generic
    {
        namespace detail
        {
#if BOOST_COMP_CLANG
// avoid diagnostic warning: "has no out-of-line virtual method definitions; its vtable will be emitted in every
// translation unit [-Werror,-Wweak-vtables]" https://stackoverflow.com/a/29288300
#    pragma clang diagnostic push
#    pragma clang diagnostic ignored "-Wweak-vtables"
#endif
            //! The CPU device queue implementation.
            template<typename TDev>
            class QueueGenericThreadsBlockingImpl final : public IGenericThreadsQueue<TDev>
#if BOOST_COMP_CLANG
#    pragma clang diagnostic pop
#endif
            {
            public:
                explicit QueueGenericThreadsBlockingImpl(TDev dev) noexcept
                    : m_dev(std::move(dev))
                    , m_bCurrentlyExecutingTask(false)
                {
                }
 
                QueueGenericThreadsBlockingImpl(QueueGenericThreadsBlockingImpl<TDev> const&) = delete;
                auto operator=(QueueGenericThreadsBlockingImpl<TDev> const&)
                    -> QueueGenericThreadsBlockingImpl<TDev>& = delete;
 
                void enqueue(EventGenericThreads<TDev>& ev) final
                {
                    alpaka::enqueue(*this, ev);
                }
 
                void wait(EventGenericThreads<TDev> const& ev) final
                {
                    alpaka::wait(*this, ev);
                }
 
            public:
                TDev const m_dev; //!< The device this queue is bound to.
                std::mutex mutable m_mutex;
                std::atomic<bool> m_bCurrentlyExecutingTask;
            };
        } // namespace detail
    } // namespace generic
 
    //! The CPU device queue.
    template<typename TDev>
    class QueueGenericThreadsBlocking final
        : public interface::Implements<ConceptCurrentThreadWaitFor, QueueGenericThreadsBlocking<TDev>>
        , public interface::Implements<ConceptQueue, QueueGenericThreadsBlocking<TDev>>
        , public interface::Implements<ConceptGetDev, QueueGenericThreadsBlocking<TDev>>
    {
    public:
        explicit QueueGenericThreadsBlocking(TDev const& dev)
            : m_spQueueImpl(std::make_shared<generic::detail::QueueGenericThreadsBlockingImpl<TDev>>(dev))
        {
            ALPAKA_DEBUG_FULL_LOG_SCOPE;
 
            dev.registerQueue(m_spQueueImpl);
        }
 
        auto operator==(QueueGenericThreadsBlocking<TDev> const& rhs) const -> bool
        {
            return (m_spQueueImpl == rhs.m_spQueueImpl);
        }
 
        auto operator!=(QueueGenericThreadsBlocking<TDev> const& rhs) const -> bool
        {
            return !((*this) == rhs);
        }
 
    public:
        std::shared_ptr<generic::detail::QueueGenericThreadsBlockingImpl<TDev>> m_spQueueImpl;
    };
 
    namespace trait
    {
        //! The CPU blocking device queue device type trait specialization.
        template<typename TDev>
        struct DevType<QueueGenericThreadsBlocking<TDev>>
        {
            using type = TDev;
        };
 
        //! The CPU blocking device queue device get trait specialization.
        template<typename TDev>
        struct GetDev<QueueGenericThreadsBlocking<TDev>>
        {
            ALPAKA_FN_HOST static auto getDev(QueueGenericThreadsBlocking<TDev> const& queue) -> TDev
            {
                return queue.m_spQueueImpl->m_dev;
            }
        };
 
        //! The CPU blocking device queue event type trait specialization.
        template<typename TDev>
        struct EventType<QueueGenericThreadsBlocking<TDev>>
        {
            using type = EventGenericThreads<TDev>;
        };
 
        //! The CPU blocking device queue enqueue trait specialization.
        //! This default implementation for all tasks directly invokes the function call operator of the task.
        template<typename TDev, typename TTask>
        struct Enqueue<QueueGenericThreadsBlocking<TDev>, TTask>
        {
            ALPAKA_FN_HOST static auto enqueue(QueueGenericThreadsBlocking<TDev>& queue, TTask const& task) -> void
            {
                std::lock_guard<std::mutex> lk(queue.m_spQueueImpl->m_mutex);
 
                queue.m_spQueueImpl->m_bCurrentlyExecutingTask = true;
 
                task();
 
                queue.m_spQueueImpl->m_bCurrentlyExecutingTask = false;
            }
        };
 
        //! The CPU blocking device queue test trait specialization.
        template<typename TDev>
        struct Empty<QueueGenericThreadsBlocking<TDev>>
        {
            ALPAKA_FN_HOST static auto empty(QueueGenericThreadsBlocking<TDev> const& queue) -> bool
            {
                return !queue.m_spQueueImpl->m_bCurrentlyExecutingTask;
            }
        };
 
        //! The CPU blocking device queue thread wait trait specialization.
        //!
        //! Blocks execution of the calling thread until the queue has finished processing all previously requested
        //! tasks (kernels, data copies, ...)
        template<typename TDev>
        struct CurrentThreadWaitFor<QueueGenericThreadsBlocking<TDev>>
        {
            ALPAKA_FN_HOST static auto currentThreadWaitFor(QueueGenericThreadsBlocking<TDev> const& queue) -> void
            {
                std::lock_guard<std::mutex> lk(queue.m_spQueueImpl->m_mutex);
            }
        };
    } // namespace trait
} // namespace alpaka
 
#include "alpaka/event/EventGenericThreads.hpp"