QueueHandle.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* libscopehal                                                                                                          *
*                                                                                                                      *
* Copyright (c) 2012-2026 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 QueueHandle_h
#define QueueHandle_h
 
#include <map>
#include <memory>
#include <mutex>
#include <tuple>
#include <vector>
#include <vulkan/vulkan_raii.hpp>
 
#include "QueueWrapper.h"
 
//needs to be here not in ScratchBufferManager so QueueHandle can use it
class ScratchBufferBase
{
public:
    ScratchBufferBase();
    virtual ~ScratchBufferBase();
};
 
class QueueHandle
{
public:
 
    QueueHandle(std::shared_ptr<QueueWrapper>& queue, const std::string& name);
    ~QueueHandle();
 
    void Submit(vk::raii::CommandBuffer const& cmdBuf);
 
    void SubmitAndBlock(vk::raii::CommandBuffer const& cmdBuf);
 
    const std::string GetName() const
    { return m_queue->GetName(); }
 
    template<class T>
    void MarkScratchBufferUsed(T& buf);
 
    void WaitIdle()
    {
        const std::lock_guard<std::recursive_mutex> lock(m_queue->GetMutex());
        _waitFence();
    }
 
    bool WaitIdleWithTimeout(uint64_t nanoseconds);
 
    std::shared_ptr<QueueWrapper> GetQueue()
    { return m_queue; }
 
public:
    //non-copyable
    QueueHandle(QueueHandle const&) = delete;
    QueueHandle& operator=(QueueHandle const&) = delete;
 
protected:
    void _waitFence();
 
protected:
    friend QueueLock;
    std::shared_ptr<QueueWrapper> m_queue;
    std::unique_ptr<vk::raii::Fence> m_fence;
    bool m_fenceBusy;
 
    std::string m_fenceName;
 
    std::recursive_mutex m_fenceMutex;
 
    std::set<std::unique_ptr<ScratchBufferBase> > m_usedScratchBuffers;
};
 
 
#endif