vkexpr::VulkanContext Class Reference

#include <llvmexpr/runtime/vulkan/VulkanContext.hpp>

Public Member Functions
	VulkanContext (int device_id=-1)
	~VulkanContext ()
	VulkanContext (const VulkanContext &)=delete
VulkanContext &	operator= (const VulkanContext &)=delete
	VulkanContext (VulkanContext &&)=delete
VulkanContext &	operator= (VulkanContext &&)=delete
vk::raii::Context &	getContext ()
vk::raii::Instance &	getInstanceRef ()
vk::raii::PhysicalDevice &	getPhysicalDevice ()
vk::raii::Device &	getDevice ()
vk::raii::Queue &	getComputeQueue ()
uint32_t	getQueueFamilyIndex () const
void	submit (const vk::SubmitInfo &submit_info, const vk::Fence &fence)
void	waitIdle ()

Static Public Member Functions
static VulkanContext &	getInstance ()
static VulkanContext &	getInstance (int device_id)

Detailed Description

Definition at line 36 of file VulkanContext.hpp.

Constructor & Destructor Documentation

VulkanContext() [1/3]

vkexpr::VulkanContext::VulkanContext ( int device_id = -1 )

explicit

Definition at line 100 of file VulkanContext.cpp.

    : device_id(device_id), instance(nullptr) {
 
    createInstance();
    // Re-load volk with the instance
    volkLoadInstance(*instance);
 
    pickPhysicalDevice();
    createDevice();
}

Referenced by getInstance(), getInstance(), operator=(), operator=(), VulkanContext(), and VulkanContext().

~VulkanContext()

vkexpr::VulkanContext::~VulkanContext

(

)

Definition at line 111 of file VulkanContext.cpp.

                              {
    try {
        waitIdle();
    } catch (...) {
    }
}

References waitIdle().

VulkanContext() [2/3]

vkexpr::VulkanContext::VulkanContext ( const VulkanContext & )

delete

References VulkanContext().

VulkanContext() [3/3]

vkexpr::VulkanContext::VulkanContext ( VulkanContext && )

delete

References VulkanContext().

Member Function Documentation

getComputeQueue()

vk::raii::Queue & vkexpr::VulkanContext::getComputeQueue ( )

inline

Definition at line 53 of file VulkanContext.hpp.

{ return compute_queue; }

getContext()

vk::raii::Context & vkexpr::VulkanContext::getContext ( )

inline

Definition at line 49 of file VulkanContext.hpp.

{ return context; }

getDevice()

vk::raii::Device & vkexpr::VulkanContext::getDevice ( )

inline

Definition at line 52 of file VulkanContext.hpp.

{ return device; }

getInstance() [1/2]

VulkanContext & vkexpr::VulkanContext::getInstance ( )

static

Definition at line 65 of file VulkanContext.cpp.

{ return getInstance(-1); }

References getInstance(), and VulkanContext().

Referenced by getInstance().

getInstance() [2/2]

VulkanContext & vkexpr::VulkanContext::getInstance ( int device_id )

static

Definition at line 67 of file VulkanContext.cpp.

                                                       {
    static bool initialized = []() { return volkInitialize() == VK_SUCCESS; }();
    if (!initialized) {
        throw std::runtime_error("Failed to initialize volk");
    }
 
    struct NoDestroy {
        void operator()(VulkanContext* /*ptr*/) const {}
    };
    using ContextPtr = std::unique_ptr<VulkanContext, NoDestroy>;
 
    static std::mutex context_mutex;
    static std::unordered_map<int, ContextPtr> contexts;
 
    int key = device_id;
    if (key < 0) {
        key = -1;
    }
 
    std::lock_guard<std::mutex> lock(context_mutex);
    auto it = contexts.find(key);
    if (it != contexts.end()) {
        return *it->second;
    }
 
    auto created = std::make_unique<VulkanContext>(key);
    VulkanContext& ref = *created;
 
    // Leaky Singleton
    contexts.emplace(key, ContextPtr(created.release()));
    return ref;
}

References VulkanContext().

getInstanceRef()

vk::raii::Instance & vkexpr::VulkanContext::getInstanceRef ( )

inline

Definition at line 50 of file VulkanContext.hpp.

{ return instance; }

getPhysicalDevice()

vk::raii::PhysicalDevice & vkexpr::VulkanContext::getPhysicalDevice ( )

inline

Definition at line 51 of file VulkanContext.hpp.

{ return physical_device; }

getQueueFamilyIndex()

uint32_t vkexpr::VulkanContext::getQueueFamilyIndex ( ) const

inlinenodiscard

Definition at line 54 of file VulkanContext.hpp.

                                                       {
        return queue_family_index;
    }

operator=() [1/2]

VulkanContext & vkexpr::VulkanContext::operator= ( const VulkanContext & )

delete

References VulkanContext().

operator=() [2/2]

VulkanContext & vkexpr::VulkanContext::operator= ( VulkanContext && )

delete

References VulkanContext().

submit()

void vkexpr::VulkanContext::submit	(	const vk::SubmitInfo &	submit_info,
		const vk::Fence &	fence )

Definition at line 249 of file VulkanContext.cpp.

                                                 {
    std::lock_guard<std::mutex> lock(queue_mutex);
    compute_queue.submit(submit_info, fence);
}

waitIdle()

void vkexpr::VulkanContext::waitIdle

(

)

Definition at line 255 of file VulkanContext.cpp.

                             {
    if (!*device) {
        return;
    }
    std::lock_guard<std::mutex> lock(queue_mutex);
    device.waitIdle();
}

Referenced by ~VulkanContext().

---

The documentation for this class was generated from the following files:

• llvmexpr/runtime/vulkan/VulkanContext.hpp
• llvmexpr/runtime/vulkan/VulkanContext.cpp