QueueManager.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* libscopehal v0.1                                                                                                     *
*                                                                                                                      *
* Copyright (c) 2012-2022 Andrew D. Zonenberg and contributors                                                         *
* All rights reserved.                                                                                                 *
*                                                                                                                      *
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
* following conditions are met:                                                                                        *
*                                                                                                                      *
*    * Redistributions of source code must retain the above copyright notice, this list of conditions, and the         *
*      following disclaimer.                                                                                           *
*                                                                                                                      *
*    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the       *
*      following disclaimer in the documentation and/or other materials provided with the distribution.                *
*                                                                                                                      *
*    * Neither the name of the author nor the names of any contributors may be used to endorse or promote products     *
*      derived from this software without specific prior written permission.                                           *
*                                                                                                                      *
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED   *
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES        *
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR       *
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE       *
* POSSIBILITY OF SUCH DAMAGE.                                                                                          *
*                                                                                                                      *
***********************************************************************************************************************/
 
#ifndef QueueManager_h
#define QueueManager_h
 
#include <map>
#include <memory>
#include <mutex>
#include <tuple>
#include <vector>
#include <vulkan/vulkan_raii.hpp>
 
class QueueLock;
 
class QueueHandle
{
public:
    QueueHandle(std::shared_ptr<vk::raii::Device> device, size_t family, size_t index, std::string name);
    ~QueueHandle();
 
    void AddName(std::string name);
 
    void Submit(vk::raii::CommandBuffer const& cmdBuf);
    void SubmitAndBlock(vk::raii::CommandBuffer const& cmdBuf);
 
    const std::string& GetName() const
    { return m_name; }
 
public:
    //non-copyable
    QueueHandle(QueueHandle const&) = delete;
    QueueHandle& operator=(QueueHandle const&) = delete;
 
protected:
    void _waitFence();
 
public:
    const size_t m_family;
    const size_t m_index;
 
protected:
    friend QueueLock;
    std::recursive_mutex m_mutex;
    std::string m_name;
    std::shared_ptr<vk::raii::Device> m_device;
    std::unique_ptr<vk::raii::Queue> m_queue;
    std::unique_ptr<vk::raii::Fence> m_fence;
};
 
 
class QueueLock
{
public:
    QueueLock(std::shared_ptr<QueueHandle> handle)
    : m_lock(handle->m_mutex)
    , m_handle(handle)
    { handle->_waitFence(); }
 
    vk::raii::Queue& operator*()
    { return *(m_handle->m_queue); }
 
public:
    //non-copyable
    QueueLock(QueueLock const&) = delete;
    QueueLock& operator=(QueueLock const&) = delete;
 
protected:
    const std::lock_guard<std::recursive_mutex> m_lock;
    std::shared_ptr<QueueHandle> m_handle;
};
 
 
class QueueManager
{
public:
    QueueManager(vk::raii::PhysicalDevice* phys, std::shared_ptr<vk::raii::Device> device);
 
    std::shared_ptr<QueueHandle> GetComputeQueue(std::string name)
    { return GetQueueWithFlags(vk::QueueFlagBits::eCompute | vk::QueueFlagBits::eTransfer, name); }
 
    std::shared_ptr<QueueHandle> GetRenderQueue(std::string name)
    { return GetQueueWithFlags(vk::QueueFlagBits::eGraphics | vk::QueueFlagBits::eTransfer, name); }
 
    std::shared_ptr<QueueHandle> GetTransferQueue(std::string name)
    { return GetQueueWithFlags(vk::QueueFlagBits::eCompute | vk::QueueFlagBits::eTransfer, name); }
 
    std::shared_ptr<QueueHandle> GetQueueWithFlags(vk::QueueFlags flags, std::string name);
 
public:
    //non-copyable
    QueueManager(QueueManager const&) = delete;
    QueueManager& operator=(QueueManager const&) = delete;
 
protected:
    vk::raii::PhysicalDevice* m_phys;
    std::shared_ptr<vk::raii::Device> m_device;
 
    std::mutex m_mutex;
 
    struct QueueInfo
    {
        size_t Family;
        size_t Index;
        vk::QueueFlags Flags;
        std::shared_ptr<QueueHandle> Handle;
    };
 
    std::vector<QueueInfo> m_queues;
};
 
#endif