1 /* Copyright (c) 2017-2020 Hans-Kristian Arntzen
2  *
3  * Permission is hereby granted, free of charge, to any person obtaining
4  * a copy of this software and associated documentation files (the
5  * "Software"), to deal in the Software without restriction, including
6  * without limitation the rights to use, copy, modify, merge, publish,
7  * distribute, sublicense, and/or sell copies of the Software, and to
8  * permit persons to whom the Software is furnished to do so, subject to
9  * the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be
12  * included in all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
18  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
19  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
20  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21  */
22 
23 #pragma once
24 
25 #include "vulkan_common.hpp"
26 #include "vulkan_headers.hpp"
27 #include "object_pool.hpp"
28 #include "cookie.hpp"
29 #ifdef GRANITE_VULKAN_MT
30 #include <mutex>
31 #endif
32 
33 namespace Vulkan
34 {
35 class Device;
36 
37 class FenceHolder;
38 struct FenceHolderDeleter
39 {
40 	void operator()(FenceHolder *fence);
41 };
42 
43 class FenceHolder : public Util::IntrusivePtrEnabled<FenceHolder, FenceHolderDeleter, HandleCounter>, public InternalSyncEnabled
44 {
45 public:
46 	friend struct FenceHolderDeleter;
47 	friend class WSI;
48 
49 	~FenceHolder();
50 	void wait();
51 	bool wait_timeout(uint64_t nsec);
52 
53 private:
54 	friend class Util::ObjectPool<FenceHolder>;
FenceHolder(Device * device_,VkFence fence_)55 	FenceHolder(Device *device_, VkFence fence_)
56 		: device(device_),
57 		  fence(fence_),
58 		  timeline_semaphore(VK_NULL_HANDLE),
59 		  timeline_value(0)
60 	{
61 	}
62 
FenceHolder(Device * device_,uint64_t value,VkSemaphore timeline_semaphore_)63 	FenceHolder(Device *device_, uint64_t value, VkSemaphore timeline_semaphore_)
64 		: device(device_),
65 		  fence(VK_NULL_HANDLE),
66 		  timeline_semaphore(timeline_semaphore_),
67 		  timeline_value(value)
68 	{
69 		VK_ASSERT(value > 0);
70 	}
71 
72 	VkFence get_fence() const;
73 
74 	Device *device;
75 	VkFence fence;
76 	VkSemaphore timeline_semaphore;
77 	uint64_t timeline_value;
78 	bool observed_wait = false;
79 #ifdef GRANITE_VULKAN_MT
80 	std::mutex lock;
81 #endif
82 };
83 
84 using Fence = Util::IntrusivePtr<FenceHolder>;
85 }
86