1 #ifndef _VKTSYNCHRONIZATIONUTIL_HPP
2 #define _VKTSYNCHRONIZATIONUTIL_HPP
3 /*------------------------------------------------------------------------
4 * Vulkan Conformance Tests
5 * ------------------------
7 * Copyright (c) 2016 The Khronos Group Inc.
9 * Licensed under the Apache License, Version 2.0 (the "License");
10 * you may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
23 * \brief Synchronization tests utilities
24 *//*--------------------------------------------------------------------*/
27 #include "vkQueryUtil.hpp"
28 #include "vkMemUtil.hpp"
29 #include "vkRefUtil.hpp"
30 #include "vkPrograms.hpp"
31 #include "tcuVector.hpp"
32 #include "deMutex.hpp"
36 namespace synchronization
42 Buffer (const vk::DeviceInterface& vk,
43 const vk::VkDevice device,
44 vk::Allocator& allocator,
45 const vk::VkBufferCreateInfo& bufferCreateInfo,
46 const vk::MemoryRequirement memoryRequirement)
48 : m_buffer (createBuffer(vk, device, &bufferCreateInfo))
49 , m_allocation (allocator.allocate(getBufferMemoryRequirements(vk, device, *m_buffer), memoryRequirement))
51 VK_CHECK(vk.bindBufferMemory(device, *m_buffer, m_allocation->getMemory(), m_allocation->getOffset()));
54 const vk::VkBuffer& get (void) const { return *m_buffer; }
55 const vk::VkBuffer& operator* (void) const { return get(); }
56 vk::Allocation& getAllocation (void) const { return *m_allocation; }
59 const vk::Unique<vk::VkBuffer> m_buffer;
60 const de::UniquePtr<vk::Allocation> m_allocation;
63 Buffer (const Buffer&);
64 Buffer& operator= (const Buffer&);
70 Image (const vk::DeviceInterface& vk,
71 const vk::VkDevice device,
72 vk::Allocator& allocator,
73 const vk::VkImageCreateInfo& imageCreateInfo,
74 const vk::MemoryRequirement memoryRequirement)
76 : m_image (createImage(vk, device, &imageCreateInfo))
77 , m_allocation (allocator.allocate(getImageMemoryRequirements(vk, device, *m_image), memoryRequirement))
79 VK_CHECK(vk.bindImageMemory(device, *m_image, m_allocation->getMemory(), m_allocation->getOffset()));
82 const vk::VkImage& get (void) const { return *m_image; }
83 const vk::VkImage& operator* (void) const { return get(); }
84 vk::Allocation& getAllocation (void) const { return *m_allocation; }
87 const vk::Unique<vk::VkImage> m_image;
88 const de::UniquePtr<vk::Allocation> m_allocation;
92 Image& operator= (const Image&);
95 class PipelineCacheData
98 PipelineCacheData (void);
99 ~PipelineCacheData (void);
101 vk::Move<vk::VkPipelineCache> createPipelineCache (const vk::DeviceInterface& vk, const vk::VkDevice device) const;
102 void setFromPipelineCache (const vk::DeviceInterface& vk, const vk::VkDevice device, const vk::VkPipelineCache pipelineCache);
105 mutable de::Mutex m_lock;
106 std::vector<deUint8> m_data;
109 class GraphicsPipelineBuilder
112 GraphicsPipelineBuilder (void) : m_renderSize (0, 0)
113 , m_shaderStageFlags (0u)
114 , m_cullModeFlags (vk::VK_CULL_MODE_NONE)
115 , m_frontFace (vk::VK_FRONT_FACE_COUNTER_CLOCKWISE)
116 , m_patchControlPoints (1u)
117 , m_blendEnable (false)
118 , m_primitiveTopology (vk::VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST) {}
120 GraphicsPipelineBuilder& setRenderSize (const tcu::IVec2& size) { m_renderSize = size; return *this; }
121 GraphicsPipelineBuilder& setShader (const vk::DeviceInterface& vk, const vk::VkDevice device, const vk::VkShaderStageFlagBits stage, const vk::ProgramBinary& binary, const vk::VkSpecializationInfo* specInfo);
122 GraphicsPipelineBuilder& setPatchControlPoints (const deUint32 controlPoints) { m_patchControlPoints = controlPoints; return *this; }
123 GraphicsPipelineBuilder& setCullModeFlags (const vk::VkCullModeFlags cullModeFlags) { m_cullModeFlags = cullModeFlags; return *this; }
124 GraphicsPipelineBuilder& setFrontFace (const vk::VkFrontFace frontFace) { m_frontFace = frontFace; return *this; }
125 GraphicsPipelineBuilder& setBlend (const bool enable) { m_blendEnable = enable; return *this; }
127 //! Applies only to pipelines without tessellation shaders.
128 GraphicsPipelineBuilder& setPrimitiveTopology (const vk::VkPrimitiveTopology topology) { m_primitiveTopology = topology; return *this; }
130 GraphicsPipelineBuilder& addVertexBinding (const vk::VkVertexInputBindingDescription vertexBinding) { m_vertexInputBindings.push_back(vertexBinding); return *this; }
131 GraphicsPipelineBuilder& addVertexAttribute (const vk::VkVertexInputAttributeDescription vertexAttribute) { m_vertexInputAttributes.push_back(vertexAttribute); return *this; }
133 //! Basic vertex input configuration (uses biding 0, location 0, etc.)
134 GraphicsPipelineBuilder& setVertexInputSingleAttribute (const vk::VkFormat vertexFormat, const deUint32 stride);
136 vk::Move<vk::VkPipeline> build (const vk::DeviceInterface& vk, const vk::VkDevice device, const vk::VkPipelineLayout pipelineLayout, const vk::VkRenderPass renderPass, PipelineCacheData& pipelineCacheData);
139 tcu::IVec2 m_renderSize;
140 vk::Move<vk::VkShaderModule> m_vertexShaderModule;
141 vk::Move<vk::VkShaderModule> m_fragmentShaderModule;
142 vk::Move<vk::VkShaderModule> m_geometryShaderModule;
143 vk::Move<vk::VkShaderModule> m_tessControlShaderModule;
144 vk::Move<vk::VkShaderModule> m_tessEvaluationShaderModule;
145 std::vector<vk::VkPipelineShaderStageCreateInfo> m_shaderStages;
146 std::vector<vk::VkVertexInputBindingDescription> m_vertexInputBindings;
147 std::vector<vk::VkVertexInputAttributeDescription> m_vertexInputAttributes;
148 vk::VkShaderStageFlags m_shaderStageFlags;
149 vk::VkCullModeFlags m_cullModeFlags;
150 vk::VkFrontFace m_frontFace;
151 deUint32 m_patchControlPoints;
153 vk::VkPrimitiveTopology m_primitiveTopology;
155 GraphicsPipelineBuilder (const GraphicsPipelineBuilder&); // "deleted"
156 GraphicsPipelineBuilder& operator= (const GraphicsPipelineBuilder&);
161 FEATURE_TESSELLATION_SHADER = 1u << 0,
162 FEATURE_GEOMETRY_SHADER = 1u << 1,
163 FEATURE_SHADER_FLOAT_64 = 1u << 2,
164 FEATURE_VERTEX_PIPELINE_STORES_AND_ATOMICS = 1u << 3,
165 FEATURE_FRAGMENT_STORES_AND_ATOMICS = 1u << 4,
166 FEATURE_SHADER_TESSELLATION_AND_GEOMETRY_POINT_SIZE = 1u << 5,
167 FEATURE_SHADER_STORAGE_IMAGE_EXTENDED_FORMATS = 1u << 6,
169 typedef deUint32 FeatureFlags;
173 SYNC_PRIMITIVE_FENCE,
174 SYNC_PRIMITIVE_SEMAPHORE,
175 SYNC_PRIMITIVE_BARRIER,
176 SYNC_PRIMITIVE_EVENT,
181 RESOURCE_TYPE_BUFFER,
183 RESOURCE_TYPE_INDIRECT_BUFFER_DRAW,
184 RESOURCE_TYPE_INDIRECT_BUFFER_DRAW_INDEXED,
185 RESOURCE_TYPE_INDIRECT_BUFFER_DISPATCH,
188 struct ResourceDescription
191 tcu::IVec4 size; //!< unused components are 0, e.g. for buffers only x is meaningful
192 vk::VkImageType imageType;
193 vk::VkFormat imageFormat;
194 vk::VkImageAspectFlags imageAspect;
197 struct BufferResource
200 vk::VkDeviceSize offset;
201 vk::VkDeviceSize size;
207 vk::VkExtent3D extent;
208 vk::VkImageType imageType;
210 vk::VkImageSubresourceRange subresourceRange;
211 vk::VkImageSubresourceLayers subresourceLayers;
214 vk::VkBufferCreateInfo makeBufferCreateInfo (const vk::VkDeviceSize bufferSize, const vk::VkBufferUsageFlags usage);
215 vk::VkImageCreateInfo makeImageCreateInfo (const vk::VkImageType imageType, const vk::VkExtent3D& extent, const vk::VkFormat format, const vk::VkImageUsageFlags usage);
216 vk::Move<vk::VkCommandPool> makeCommandPool (const vk::DeviceInterface& vk, const vk::VkDevice device, const deUint32 queueFamilyIndex);
217 vk::Move<vk::VkCommandBuffer> makeCommandBuffer (const vk::DeviceInterface& vk, const vk::VkDevice device, const vk::VkCommandPool commandPool);
218 vk::Move<vk::VkDescriptorSet> makeDescriptorSet (const vk::DeviceInterface& vk, const vk::VkDevice device, const vk::VkDescriptorPool descriptorPool, const vk::VkDescriptorSetLayout setLayout);
219 vk::Move<vk::VkPipelineLayout> makePipelineLayout (const vk::DeviceInterface& vk, const vk::VkDevice device, const vk::VkDescriptorSetLayout descriptorSetLayout);
220 vk::Move<vk::VkPipelineLayout> makePipelineLayoutWithoutDescriptors (const vk::DeviceInterface& vk, const vk::VkDevice device);
221 vk::Move<vk::VkPipeline> makeComputePipeline (const vk::DeviceInterface& vk, const vk::VkDevice device, const vk::VkPipelineLayout pipelineLayout, const vk::VkShaderModule shaderModule, const vk::VkSpecializationInfo* specInfo, PipelineCacheData& pipelineCacheData);
222 vk::Move<vk::VkRenderPass> makeRenderPass (const vk::DeviceInterface& vk, const vk::VkDevice device, const vk::VkFormat colorFormat);
223 vk::Move<vk::VkRenderPass> makeRenderPassWithoutAttachments (const vk::DeviceInterface& vk, const vk::VkDevice device);
224 vk::Move<vk::VkFramebuffer> makeFramebuffer (const vk::DeviceInterface& vk, const vk::VkDevice device, const vk::VkRenderPass renderPass, const vk::VkImageView colorAttachment, const deUint32 width, const deUint32 height, const deUint32 layers);
225 vk::Move<vk::VkFramebuffer> makeFramebufferWithoutAttachments (const vk::DeviceInterface& vk, const vk::VkDevice device, const vk::VkRenderPass renderPass);
226 vk::Move<vk::VkImageView> makeImageView (const vk::DeviceInterface& vk, const vk::VkDevice device, const vk::VkImage image, const vk::VkImageViewType viewType, const vk::VkFormat format, const vk::VkImageSubresourceRange subresourceRange);
227 vk::Move<vk::VkEvent> makeEvent (const vk::DeviceInterface& vk, const vk::VkDevice device);
228 vk::VkBufferImageCopy makeBufferImageCopy (const vk::VkImageSubresourceLayers subresourceLayers, const vk::VkExtent3D extent);
229 vk::VkMemoryBarrier makeMemoryBarrier (const vk::VkAccessFlags srcAccessMask, const vk::VkAccessFlags dstAccessMask);
230 vk::VkBufferMemoryBarrier makeBufferMemoryBarrier (const vk::VkAccessFlags srcAccessMask, const vk::VkAccessFlags dstAccessMask, const vk::VkBuffer buffer, const vk::VkDeviceSize offset, const vk::VkDeviceSize bufferSizeBytes);
231 vk::VkImageMemoryBarrier makeImageMemoryBarrier (const vk::VkAccessFlags srcAccessMask, const vk::VkAccessFlags dstAccessMask, const vk::VkImageLayout oldLayout, const vk::VkImageLayout newLayout, const vk::VkImage image, const vk::VkImageSubresourceRange subresourceRange);
233 void beginCommandBuffer (const vk::DeviceInterface& vk, const vk::VkCommandBuffer commandBuffer);
234 void endCommandBuffer (const vk::DeviceInterface& vk, const vk::VkCommandBuffer commandBuffer);
235 void submitCommandsAndWait (const vk::DeviceInterface& vk, const vk::VkDevice device, const vk::VkQueue queue, const vk::VkCommandBuffer commandBuffer);
236 void beginRenderPass (const vk::DeviceInterface& vk, const vk::VkCommandBuffer commandBuffer, const vk::VkRenderPass renderPass, const vk::VkFramebuffer framebuffer, const vk::VkRect2D& renderArea, const tcu::Vec4& clearColor);
237 void beginRenderPassWithRasterizationDisabled (const vk::DeviceInterface& vk, const vk::VkCommandBuffer commandBuffer, const vk::VkRenderPass renderPass, const vk::VkFramebuffer framebuffer);
238 void endRenderPass (const vk::DeviceInterface& vk, const vk::VkCommandBuffer commandBuffer);
239 void requireFeatures (const vk::InstanceInterface& vki, const vk::VkPhysicalDevice physDevice, const FeatureFlags flags);
240 std::string getResourceName (const ResourceDescription& resource);
241 bool isIndirectBuffer (const ResourceType type);
246 #endif // _VKTSYNCHRONIZATIONUTIL_HPP