Merge gerrit/vulkan-cts-1.0.1 into gerrit/vulkan-cts-1.0.2
[platform/upstream/VK-GL-CTS.git] / external / vulkancts / modules / vulkan / sparse_resources / vktSparseResourcesBufferTests.cpp
1 /*------------------------------------------------------------------------
2  * Vulkan Conformance Tests
3  * ------------------------
4  *
5  * Copyright (c) 2016 The Khronos Group Inc.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  *//*!
20  * \file
21  * \brief Sparse buffer tests
22  *//*--------------------------------------------------------------------*/
23
24 #include "vktSparseResourcesBufferTests.hpp"
25 #include "vktTestCaseUtil.hpp"
26 #include "vktTestGroupUtil.hpp"
27 #include "vktSparseResourcesTestsUtil.hpp"
28 #include "vktSparseResourcesBase.hpp"
29 #include "vktSparseResourcesBufferSparseBinding.hpp"
30 #include "vktSparseResourcesBufferSparseResidency.hpp"
31 #include "vktSparseResourcesBufferMemoryAliasing.hpp"
32
33 #include "vkRef.hpp"
34 #include "vkRefUtil.hpp"
35 #include "vkPlatform.hpp"
36 #include "vkPrograms.hpp"
37 #include "vkMemUtil.hpp"
38 #include "vkBuilderUtil.hpp"
39 #include "vkQueryUtil.hpp"
40 #include "vkTypeUtil.hpp"
41
42 #include "deUniquePtr.hpp"
43 #include "deSharedPtr.hpp"
44 #include "deMath.h"
45
46 #include <string>
47 #include <vector>
48 #include <map>
49
50 using namespace vk;
51 using de::MovePtr;
52 using de::UniquePtr;
53 using de::SharedPtr;
54 using tcu::Vec4;
55 using tcu::IVec2;
56 using tcu::IVec4;
57
58 namespace vkt
59 {
60 namespace sparse
61 {
62 namespace
63 {
64
65 typedef SharedPtr<UniquePtr<Allocation> > AllocationSp;
66
67 enum
68 {
69         RENDER_SIZE     = 128,                          //!< framebuffer size in pixels
70         GRID_SIZE       = RENDER_SIZE / 8,      //!< number of grid tiles in a row
71 };
72
73 enum TestFlagBits
74 {
75                                                                                                 //   sparseBinding is implied
76         TEST_FLAG_ALIASED                               = 1u << 0,      //!< sparseResidencyAliased
77         TEST_FLAG_RESIDENCY                             = 1u << 1,      //!< sparseResidencyBuffer
78         TEST_FLAG_NON_RESIDENT_STRICT   = 1u << 2,      //!< residencyNonResidentStrict
79 };
80 typedef deUint32 TestFlags;
81
82 //! SparseAllocationBuilder output. Owns the allocated memory.
83 struct SparseAllocation
84 {
85         deUint32                                                        numResourceChunks;
86         VkDeviceSize                                            resourceSize;           //!< buffer size in bytes
87         std::vector<AllocationSp>                       allocations;            //!< actual allocated memory
88         std::vector<VkSparseMemoryBind>         memoryBinds;            //!< memory binds backing the resource
89 };
90
91 //! Utility to lay out memory allocations for a sparse buffer, including holes and aliased regions.
92 //! Will allocate memory upon building.
93 class SparseAllocationBuilder
94 {
95 public:
96                                                                 SparseAllocationBuilder (void);
97
98         // \note "chunk" is the smallest (due to alignment) bindable amount of memory
99
100         SparseAllocationBuilder&        addMemoryHole                   (const deUint32 numChunks = 1u);
101         SparseAllocationBuilder&        addResourceHole                 (const deUint32 numChunks = 1u);
102         SparseAllocationBuilder&        addMemoryBind                   (const deUint32 numChunks = 1u);
103         SparseAllocationBuilder&        addAliasedMemoryBind    (const deUint32 allocationNdx, const deUint32 chunkOffset, const deUint32 numChunks = 1u);
104         SparseAllocationBuilder&        addMemoryAllocation             (void);
105
106         MovePtr<SparseAllocation>       build                                   (const DeviceInterface&         vk,
107                                                                                                                  const VkDevice                         device,
108                                                                                                                  Allocator&                                     allocator,
109                                                                                                                  VkBufferCreateInfo                     referenceCreateInfo,            //!< buffer size is ignored in this info
110                                                                                                                  const VkDeviceSize                     minChunkSize = 0ull) const;     //!< make sure chunks are at least this big
111
112 private:
113         struct MemoryBind
114         {
115                 deUint32        allocationNdx;
116                 deUint32        resourceChunkNdx;
117                 deUint32        memoryChunkNdx;
118                 deUint32        numChunks;
119         };
120
121         deUint32                                        m_allocationNdx;
122         deUint32                                        m_resourceChunkNdx;
123         deUint32                                        m_memoryChunkNdx;
124         std::vector<MemoryBind>         m_memoryBinds;
125         std::vector<deUint32>           m_chunksPerAllocation;
126
127 };
128
129 SparseAllocationBuilder::SparseAllocationBuilder (void)
130         : m_allocationNdx               (0)
131         , m_resourceChunkNdx    (0)
132         , m_memoryChunkNdx              (0)
133 {
134         m_chunksPerAllocation.push_back(0);
135 }
136
137 SparseAllocationBuilder& SparseAllocationBuilder::addMemoryHole (const deUint32 numChunks)
138 {
139         m_memoryChunkNdx                                                += numChunks;
140         m_chunksPerAllocation[m_allocationNdx]  += numChunks;
141
142         return *this;
143 }
144
145 SparseAllocationBuilder& SparseAllocationBuilder::addResourceHole (const deUint32 numChunks)
146 {
147         m_resourceChunkNdx += numChunks;
148
149         return *this;
150 }
151
152 SparseAllocationBuilder& SparseAllocationBuilder::addMemoryAllocation (void)
153 {
154         DE_ASSERT(m_memoryChunkNdx != 0);       // doesn't make sense to have an empty allocation
155
156         m_allocationNdx  += 1;
157         m_memoryChunkNdx  = 0;
158         m_chunksPerAllocation.push_back(0);
159
160         return *this;
161 }
162
163 SparseAllocationBuilder& SparseAllocationBuilder::addMemoryBind (const deUint32 numChunks)
164 {
165         const MemoryBind memoryBind =
166         {
167                 m_allocationNdx,
168                 m_resourceChunkNdx,
169                 m_memoryChunkNdx,
170                 numChunks
171         };
172         m_memoryBinds.push_back(memoryBind);
173
174         m_resourceChunkNdx                                              += numChunks;
175         m_memoryChunkNdx                                                += numChunks;
176         m_chunksPerAllocation[m_allocationNdx]  += numChunks;
177
178         return *this;
179 }
180
181 SparseAllocationBuilder& SparseAllocationBuilder::addAliasedMemoryBind  (const deUint32 allocationNdx, const deUint32 chunkOffset, const deUint32 numChunks)
182 {
183         DE_ASSERT(allocationNdx <= m_allocationNdx);
184
185         const MemoryBind memoryBind =
186         {
187                 allocationNdx,
188                 m_resourceChunkNdx,
189                 chunkOffset,
190                 numChunks
191         };
192         m_memoryBinds.push_back(memoryBind);
193
194         m_resourceChunkNdx += numChunks;
195
196         return *this;
197 }
198
199 inline VkMemoryRequirements requirementsWithSize (VkMemoryRequirements requirements, const VkDeviceSize size)
200 {
201         requirements.size = size;
202         return requirements;
203 }
204
205 inline VkDeviceSize alignSize (const VkDeviceSize val, const VkDeviceSize align)
206 {
207         DE_ASSERT(deIsPowerOfTwo64(align));
208         return (val + align - 1) & ~(align - 1);
209 }
210
211 MovePtr<SparseAllocation> SparseAllocationBuilder::build (const DeviceInterface&        vk,
212                                                                                                                   const VkDevice                        device,
213                                                                                                                   Allocator&                            allocator,
214                                                                                                                   VkBufferCreateInfo            referenceCreateInfo,
215                                                                                                                   const VkDeviceSize            minChunkSize) const
216 {
217
218         MovePtr<SparseAllocation>       sparseAllocation                        (new SparseAllocation());
219
220                                                                 referenceCreateInfo.size        = sizeof(deUint32);
221         const Unique<VkBuffer>          refBuffer                                       (createBuffer(vk, device, &referenceCreateInfo));
222         const VkMemoryRequirements      memoryRequirements                      = getBufferMemoryRequirements(vk, device, *refBuffer);
223         const VkDeviceSize                      chunkSize                                       = std::max(memoryRequirements.alignment, alignSize(minChunkSize, memoryRequirements.alignment));
224
225         for (std::vector<deUint32>::const_iterator numChunksIter = m_chunksPerAllocation.begin(); numChunksIter != m_chunksPerAllocation.end(); ++numChunksIter)
226         {
227                 sparseAllocation->allocations.push_back(makeDeSharedPtr(
228                         allocator.allocate(requirementsWithSize(memoryRequirements, *numChunksIter * chunkSize), MemoryRequirement::Any)));
229         }
230
231         for (std::vector<MemoryBind>::const_iterator memBindIter = m_memoryBinds.begin(); memBindIter != m_memoryBinds.end(); ++memBindIter)
232         {
233                 const Allocation&                       alloc   = **sparseAllocation->allocations[memBindIter->allocationNdx];
234                 const VkSparseMemoryBind        bind    =
235                 {
236                         memBindIter->resourceChunkNdx * chunkSize,                                                      // VkDeviceSize               resourceOffset;
237                         memBindIter->numChunks * chunkSize,                                                                     // VkDeviceSize               size;
238                         alloc.getMemory(),                                                                                                      // VkDeviceMemory             memory;
239                         alloc.getOffset() + memBindIter->memoryChunkNdx * chunkSize,            // VkDeviceSize               memoryOffset;
240                         (VkSparseMemoryBindFlags)0,                                                                                     // VkSparseMemoryBindFlags    flags;
241                 };
242                 sparseAllocation->memoryBinds.push_back(bind);
243                 referenceCreateInfo.size = std::max(referenceCreateInfo.size, bind.resourceOffset + bind.size);
244         }
245
246         sparseAllocation->resourceSize          = referenceCreateInfo.size;
247         sparseAllocation->numResourceChunks = m_resourceChunkNdx;
248
249         return sparseAllocation;
250 }
251
252 VkImageCreateInfo makeImageCreateInfo (const VkFormat format, const IVec2& size, const VkImageUsageFlags usage)
253 {
254         const VkImageCreateInfo imageParams =
255         {
256                 VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO,                    // VkStructureType                      sType;
257                 DE_NULL,                                                                                // const void*                          pNext;
258                 (VkImageCreateFlags)0,                                                  // VkImageCreateFlags           flags;
259                 VK_IMAGE_TYPE_2D,                                                               // VkImageType                          imageType;
260                 format,                                                                                 // VkFormat                                     format;
261                 makeExtent3D(size.x(), size.y(), 1),                    // VkExtent3D                           extent;
262                 1u,                                                                                             // deUint32                                     mipLevels;
263                 1u,                                                                                             // deUint32                                     arrayLayers;
264                 VK_SAMPLE_COUNT_1_BIT,                                                  // VkSampleCountFlagBits        samples;
265                 VK_IMAGE_TILING_OPTIMAL,                                                // VkImageTiling                        tiling;
266                 usage,                                                                                  // VkImageUsageFlags            usage;
267                 VK_SHARING_MODE_EXCLUSIVE,                                              // VkSharingMode                        sharingMode;
268                 0u,                                                                                             // deUint32                                     queueFamilyIndexCount;
269                 DE_NULL,                                                                                // const deUint32*                      pQueueFamilyIndices;
270                 VK_IMAGE_LAYOUT_UNDEFINED,                                              // VkImageLayout                        initialLayout;
271         };
272         return imageParams;
273 }
274
275 Move<VkRenderPass> makeRenderPass (const DeviceInterface&       vk,
276                                                                    const VkDevice                       device,
277                                                                    const VkFormat                       colorFormat)
278 {
279         const VkAttachmentDescription colorAttachmentDescription =
280         {
281                 (VkAttachmentDescriptionFlags)0,                                        // VkAttachmentDescriptionFlags         flags;
282                 colorFormat,                                                                            // VkFormat                                                     format;
283                 VK_SAMPLE_COUNT_1_BIT,                                                          // VkSampleCountFlagBits                        samples;
284                 VK_ATTACHMENT_LOAD_OP_CLEAR,                                            // VkAttachmentLoadOp                           loadOp;
285                 VK_ATTACHMENT_STORE_OP_STORE,                                           // VkAttachmentStoreOp                          storeOp;
286                 VK_ATTACHMENT_LOAD_OP_DONT_CARE,                                        // VkAttachmentLoadOp                           stencilLoadOp;
287                 VK_ATTACHMENT_STORE_OP_DONT_CARE,                                       // VkAttachmentStoreOp                          stencilStoreOp;
288                 VK_IMAGE_LAYOUT_UNDEFINED,                                                      // VkImageLayout                                        initialLayout;
289                 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL,                       // VkImageLayout                                        finalLayout;
290         };
291
292         const VkAttachmentReference colorAttachmentRef =
293         {
294                 0u,                                                                                                     // deUint32                     attachment;
295                 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL                        // VkImageLayout        layout;
296         };
297
298         const VkSubpassDescription subpassDescription =
299         {
300                 (VkSubpassDescriptionFlags)0,                                           // VkSubpassDescriptionFlags            flags;
301                 VK_PIPELINE_BIND_POINT_GRAPHICS,                                        // VkPipelineBindPoint                          pipelineBindPoint;
302                 0u,                                                                                                     // deUint32                                                     inputAttachmentCount;
303                 DE_NULL,                                                                                        // const VkAttachmentReference*         pInputAttachments;
304                 1u,                                                                                                     // deUint32                                                     colorAttachmentCount;
305                 &colorAttachmentRef,                                                            // const VkAttachmentReference*         pColorAttachments;
306                 DE_NULL,                                                                                        // const VkAttachmentReference*         pResolveAttachments;
307                 DE_NULL,                                                                                        // const VkAttachmentReference*         pDepthStencilAttachment;
308                 0u,                                                                                                     // deUint32                                                     preserveAttachmentCount;
309                 DE_NULL                                                                                         // const deUint32*                                      pPreserveAttachments;
310         };
311
312         const VkRenderPassCreateInfo renderPassInfo =
313         {
314                 VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO,                      // VkStructureType                                      sType;
315                 DE_NULL,                                                                                        // const void*                                          pNext;
316                 (VkRenderPassCreateFlags)0,                                                     // VkRenderPassCreateFlags                      flags;
317                 1u,                                                                                                     // deUint32                                                     attachmentCount;
318                 &colorAttachmentDescription,                                            // const VkAttachmentDescription*       pAttachments;
319                 1u,                                                                                                     // deUint32                                                     subpassCount;
320                 &subpassDescription,                                                            // const VkSubpassDescription*          pSubpasses;
321                 0u,                                                                                                     // deUint32                                                     dependencyCount;
322                 DE_NULL                                                                                         // const VkSubpassDependency*           pDependencies;
323         };
324
325         return createRenderPass(vk, device, &renderPassInfo);
326 }
327
328 Move<VkPipeline> makeGraphicsPipeline (const DeviceInterface&                                   vk,
329                                                                            const VkDevice                                                       device,
330                                                                            const VkPipelineLayout                                       pipelineLayout,
331                                                                            const VkRenderPass                                           renderPass,
332                                                                            const IVec2                                                          renderSize,
333                                                                            const VkPrimitiveTopology                            topology,
334                                                                            const deUint32                                                       stageCount,
335                                                                            const VkPipelineShaderStageCreateInfo*       pStages)
336 {
337         const VkVertexInputBindingDescription vertexInputBindingDescription =
338         {
339                 0u,                                                             // uint32_t                             binding;
340                 sizeof(Vec4),                                   // uint32_t                             stride;
341                 VK_VERTEX_INPUT_RATE_VERTEX,    // VkVertexInputRate    inputRate;
342         };
343
344         const VkVertexInputAttributeDescription vertexInputAttributeDescription =
345         {
346                 0u,                                                                     // uint32_t                     location;
347                 0u,                                                                     // uint32_t                     binding;
348                 VK_FORMAT_R32G32B32A32_SFLOAT,          // VkFormat                     format;
349                 0u,                                                                     // uint32_t                     offset;
350         };
351
352         const VkPipelineVertexInputStateCreateInfo vertexInputStateInfo =
353         {
354                 VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO,              // VkStructureType                             sType;
355                 DE_NULL,                                                                                                                // const void*                                 pNext;
356                 (VkPipelineVertexInputStateCreateFlags)0,                                               // VkPipelineVertexInputStateCreateFlags       flags;
357                 1u,                                                                                                                             // uint32_t                                    vertexBindingDescriptionCount;
358                 &vertexInputBindingDescription,                                                                 // const VkVertexInputBindingDescription*      pVertexBindingDescriptions;
359                 1u,                                                                                                                             // uint32_t                                    vertexAttributeDescriptionCount;
360                 &vertexInputAttributeDescription,                                                               // const VkVertexInputAttributeDescription*    pVertexAttributeDescriptions;
361         };
362
363         const VkPipelineInputAssemblyStateCreateInfo pipelineInputAssemblyStateInfo =
364         {
365                 VK_STRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFO,    // VkStructureType                             sType;
366                 DE_NULL,                                                                                                                // const void*                                 pNext;
367                 (VkPipelineInputAssemblyStateCreateFlags)0,                                             // VkPipelineInputAssemblyStateCreateFlags     flags;
368                 topology,                                                                                                               // VkPrimitiveTopology                         topology;
369                 VK_FALSE,                                                                                                               // VkBool32                                    primitiveRestartEnable;
370         };
371
372         const VkViewport viewport = makeViewport(
373                 0.0f, 0.0f,
374                 static_cast<float>(renderSize.x()), static_cast<float>(renderSize.y()),
375                 0.0f, 1.0f);
376
377         const VkRect2D scissor = {
378                 makeOffset2D(0, 0),
379                 makeExtent2D(static_cast<deUint32>(renderSize.x()), static_cast<deUint32>(renderSize.y())),
380         };
381
382         const VkPipelineViewportStateCreateInfo pipelineViewportStateInfo =
383         {
384                 VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO,                  // VkStructureType                             sType;
385                 DE_NULL,                                                                                                                // const void*                                 pNext;
386                 (VkPipelineViewportStateCreateFlags)0,                                                  // VkPipelineViewportStateCreateFlags          flags;
387                 1u,                                                                                                                             // uint32_t                                    viewportCount;
388                 &viewport,                                                                                                              // const VkViewport*                           pViewports;
389                 1u,                                                                                                                             // uint32_t                                    scissorCount;
390                 &scissor,                                                                                                               // const VkRect2D*                             pScissors;
391         };
392
393         const VkPipelineRasterizationStateCreateInfo pipelineRasterizationStateInfo =
394         {
395                 VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_STATE_CREATE_INFO,             // VkStructureType                          sType;
396                 DE_NULL,                                                                                                                // const void*                              pNext;
397                 (VkPipelineRasterizationStateCreateFlags)0,                                             // VkPipelineRasterizationStateCreateFlags  flags;
398                 VK_FALSE,                                                                                                               // VkBool32                                 depthClampEnable;
399                 VK_FALSE,                                                                                                               // VkBool32                                 rasterizerDiscardEnable;
400                 VK_POLYGON_MODE_FILL,                                                                                   // VkPolygonMode                                                        polygonMode;
401                 VK_CULL_MODE_NONE,                                                                                              // VkCullModeFlags                                                      cullMode;
402                 VK_FRONT_FACE_COUNTER_CLOCKWISE,                                                                // VkFrontFace                                                          frontFace;
403                 VK_FALSE,                                                                                                               // VkBool32                                                                     depthBiasEnable;
404                 0.0f,                                                                                                                   // float                                                                        depthBiasConstantFactor;
405                 0.0f,                                                                                                                   // float                                                                        depthBiasClamp;
406                 0.0f,                                                                                                                   // float                                                                        depthBiasSlopeFactor;
407                 1.0f,                                                                                                                   // float                                                                        lineWidth;
408         };
409
410         const VkPipelineMultisampleStateCreateInfo pipelineMultisampleStateInfo =
411         {
412                 VK_STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO,               // VkStructureType                                                      sType;
413                 DE_NULL,                                                                                                                // const void*                                                          pNext;
414                 (VkPipelineMultisampleStateCreateFlags)0,                                               // VkPipelineMultisampleStateCreateFlags        flags;
415                 VK_SAMPLE_COUNT_1_BIT,                                                                                  // VkSampleCountFlagBits                                        rasterizationSamples;
416                 VK_FALSE,                                                                                                               // VkBool32                                                                     sampleShadingEnable;
417                 0.0f,                                                                                                                   // float                                                                        minSampleShading;
418                 DE_NULL,                                                                                                                // const VkSampleMask*                                          pSampleMask;
419                 VK_FALSE,                                                                                                               // VkBool32                                                                     alphaToCoverageEnable;
420                 VK_FALSE                                                                                                                // VkBool32                                                                     alphaToOneEnable;
421         };
422
423         const VkStencilOpState stencilOpState = makeStencilOpState(
424                 VK_STENCIL_OP_KEEP,                             // stencil fail
425                 VK_STENCIL_OP_KEEP,                             // depth & stencil pass
426                 VK_STENCIL_OP_KEEP,                             // depth only fail
427                 VK_COMPARE_OP_ALWAYS,                   // compare op
428                 0u,                                                             // compare mask
429                 0u,                                                             // write mask
430                 0u);                                                    // reference
431
432         VkPipelineDepthStencilStateCreateInfo pipelineDepthStencilStateInfo =
433         {
434                 VK_STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO,             // VkStructureType                                                      sType;
435                 DE_NULL,                                                                                                                // const void*                                                          pNext;
436                 (VkPipelineDepthStencilStateCreateFlags)0,                                              // VkPipelineDepthStencilStateCreateFlags       flags;
437                 VK_FALSE,                                                                                                               // VkBool32                                                                     depthTestEnable;
438                 VK_FALSE,                                                                                                               // VkBool32                                                                     depthWriteEnable;
439                 VK_COMPARE_OP_LESS,                                                                                             // VkCompareOp                                                          depthCompareOp;
440                 VK_FALSE,                                                                                                               // VkBool32                                                                     depthBoundsTestEnable;
441                 VK_FALSE,                                                                                                               // VkBool32                                                                     stencilTestEnable;
442                 stencilOpState,                                                                                                 // VkStencilOpState                                                     front;
443                 stencilOpState,                                                                                                 // VkStencilOpState                                                     back;
444                 0.0f,                                                                                                                   // float                                                                        minDepthBounds;
445                 1.0f,                                                                                                                   // float                                                                        maxDepthBounds;
446         };
447
448         const VkColorComponentFlags                                     colorComponentsAll                                      = VK_COLOR_COMPONENT_R_BIT | VK_COLOR_COMPONENT_G_BIT | VK_COLOR_COMPONENT_B_BIT | VK_COLOR_COMPONENT_A_BIT;
449         const VkPipelineColorBlendAttachmentState       pipelineColorBlendAttachmentState       =
450         {
451                 VK_FALSE,                                               // VkBool32                                     blendEnable;
452                 VK_BLEND_FACTOR_ONE,                    // VkBlendFactor                        srcColorBlendFactor;
453                 VK_BLEND_FACTOR_ZERO,                   // VkBlendFactor                        dstColorBlendFactor;
454                 VK_BLEND_OP_ADD,                                // VkBlendOp                            colorBlendOp;
455                 VK_BLEND_FACTOR_ONE,                    // VkBlendFactor                        srcAlphaBlendFactor;
456                 VK_BLEND_FACTOR_ZERO,                   // VkBlendFactor                        dstAlphaBlendFactor;
457                 VK_BLEND_OP_ADD,                                // VkBlendOp                            alphaBlendOp;
458                 colorComponentsAll,                             // VkColorComponentFlags        colorWriteMask;
459         };
460
461         const VkPipelineColorBlendStateCreateInfo pipelineColorBlendStateInfo =
462         {
463                 VK_STRUCTURE_TYPE_PIPELINE_COLOR_BLEND_STATE_CREATE_INFO,               // VkStructureType                                                              sType;
464                 DE_NULL,                                                                                                                // const void*                                                                  pNext;
465                 (VkPipelineColorBlendStateCreateFlags)0,                                                // VkPipelineColorBlendStateCreateFlags                 flags;
466                 VK_FALSE,                                                                                                               // VkBool32                                                                             logicOpEnable;
467                 VK_LOGIC_OP_COPY,                                                                                               // VkLogicOp                                                                    logicOp;
468                 1u,                                                                                                                             // deUint32                                                                             attachmentCount;
469                 &pipelineColorBlendAttachmentState,                                                             // const VkPipelineColorBlendAttachmentState*   pAttachments;
470                 { 0.0f, 0.0f, 0.0f, 0.0f },                                                                             // float                                                                                blendConstants[4];
471         };
472
473         const VkGraphicsPipelineCreateInfo graphicsPipelineInfo =
474         {
475                 VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO,        // VkStructureType                                                                      sType;
476                 DE_NULL,                                                                                        // const void*                                                                          pNext;
477                 (VkPipelineCreateFlags)0,                                                       // VkPipelineCreateFlags                                                        flags;
478                 stageCount,                                                                                     // deUint32                                                                                     stageCount;
479                 pStages,                                                                                        // const VkPipelineShaderStageCreateInfo*                       pStages;
480                 &vertexInputStateInfo,                                                          // const VkPipelineVertexInputStateCreateInfo*          pVertexInputState;
481                 &pipelineInputAssemblyStateInfo,                                        // const VkPipelineInputAssemblyStateCreateInfo*        pInputAssemblyState;
482                 DE_NULL,                                                                                        // const VkPipelineTessellationStateCreateInfo*         pTessellationState;
483                 &pipelineViewportStateInfo,                                                     // const VkPipelineViewportStateCreateInfo*                     pViewportState;
484                 &pipelineRasterizationStateInfo,                                        // const VkPipelineRasterizationStateCreateInfo*        pRasterizationState;
485                 &pipelineMultisampleStateInfo,                                          // const VkPipelineMultisampleStateCreateInfo*          pMultisampleState;
486                 &pipelineDepthStencilStateInfo,                                         // const VkPipelineDepthStencilStateCreateInfo*         pDepthStencilState;
487                 &pipelineColorBlendStateInfo,                                           // const VkPipelineColorBlendStateCreateInfo*           pColorBlendState;
488                 DE_NULL,                                                                                        // const VkPipelineDynamicStateCreateInfo*                      pDynamicState;
489                 pipelineLayout,                                                                         // VkPipelineLayout                                                                     layout;
490                 renderPass,                                                                                     // VkRenderPass                                                                         renderPass;
491                 0u,                                                                                                     // deUint32                                                                                     subpass;
492                 DE_NULL,                                                                                        // VkPipeline                                                                           basePipelineHandle;
493                 0,                                                                                                      // deInt32                                                                                      basePipelineIndex;
494         };
495
496         return createGraphicsPipeline(vk, device, DE_NULL, &graphicsPipelineInfo);
497 }
498
499 //! Return true if there are any red (or all zero) pixels in the image
500 bool imageHasErrorPixels (const tcu::ConstPixelBufferAccess image)
501 {
502         const Vec4 errorColor   = Vec4(1.0f, 0.0f, 0.0f, 1.0f);
503         const Vec4 blankColor   = Vec4();
504
505         for (int y = 0; y < image.getHeight(); ++y)
506         for (int x = 0; x < image.getWidth(); ++x)
507         {
508                 const Vec4 color = image.getPixel(x, y);
509                 if (color == errorColor || color == blankColor)
510                         return true;
511         }
512
513         return false;
514 }
515
516 class Renderer
517 {
518 public:
519         typedef std::map<VkShaderStageFlagBits, const VkSpecializationInfo*>    SpecializationMap;
520
521         //! Use the delegate to bind descriptor sets, vertex buffers, etc. and make a draw call
522         struct Delegate
523         {
524                 virtual                 ~Delegate               (void) {}
525                 virtual void    rendererDraw    (const VkPipelineLayout pipelineLayout, const VkCommandBuffer cmdBuffer) const = 0;
526         };
527
528         Renderer (const DeviceInterface&                                        vk,
529                           const VkDevice                                                        device,
530                           Allocator&                                                            allocator,
531                           const deUint32                                                        queueFamilyIndex,
532                           const VkDescriptorSetLayout                           descriptorSetLayout,    //!< may be NULL, if no descriptors are used
533                           ProgramCollection<vk::ProgramBinary>&         binaryCollection,
534                           const std::string&                                            vertexName,
535                           const std::string&                                            fragmentName,
536                           const VkBuffer                                                        colorBuffer,
537                           const IVec2&                                                          renderSize,
538                           const VkFormat                                                        colorFormat,
539                           const Vec4&                                                           clearColor,
540                           const VkPrimitiveTopology                                     topology,
541                           SpecializationMap                                                     specMap = SpecializationMap())
542                 : m_colorBuffer                         (colorBuffer)
543                 , m_renderSize                          (renderSize)
544                 , m_colorFormat                         (colorFormat)
545                 , m_colorSubresourceRange       (makeImageSubresourceRange(VK_IMAGE_ASPECT_COLOR_BIT, 0u, 1u, 0u, 1u))
546                 , m_clearColor                          (clearColor)
547                 , m_topology                            (topology)
548                 , m_descriptorSetLayout         (descriptorSetLayout)
549         {
550                 m_colorImage            = makeImage             (vk, device, makeImageCreateInfo(m_colorFormat, m_renderSize, VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_TRANSFER_SRC_BIT));
551                 m_colorImageAlloc       = bindImage             (vk, device, allocator, *m_colorImage, MemoryRequirement::Any);
552                 m_colorAttachment       = makeImageView (vk, device, *m_colorImage, VK_IMAGE_VIEW_TYPE_2D, m_colorFormat, m_colorSubresourceRange);
553
554                 m_vertexModule          = createShaderModule    (vk, device, binaryCollection.get(vertexName), 0u);
555                 m_fragmentModule        = createShaderModule    (vk, device, binaryCollection.get(fragmentName), 0u);
556
557                 const VkPipelineShaderStageCreateInfo pShaderStages[] =
558                 {
559                         {
560                                 VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO,            // VkStructureType                                              sType;
561                                 DE_NULL,                                                                                                        // const void*                                                  pNext;
562                                 (VkPipelineShaderStageCreateFlags)0,                                            // VkPipelineShaderStageCreateFlags             flags;
563                                 VK_SHADER_STAGE_VERTEX_BIT,                                                                     // VkShaderStageFlagBits                                stage;
564                                 *m_vertexModule,                                                                                        // VkShaderModule                                               module;
565                                 "main",                                                                                                         // const char*                                                  pName;
566                                 specMap[VK_SHADER_STAGE_VERTEX_BIT],                                            // const VkSpecializationInfo*                  pSpecializationInfo;
567                         },
568                         {
569                                 VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO,            // VkStructureType                                              sType;
570                                 DE_NULL,                                                                                                        // const void*                                                  pNext;
571                                 (VkPipelineShaderStageCreateFlags)0,                                            // VkPipelineShaderStageCreateFlags             flags;
572                                 VK_SHADER_STAGE_FRAGMENT_BIT,                                                           // VkShaderStageFlagBits                                stage;
573                                 *m_fragmentModule,                                                                                      // VkShaderModule                                               module;
574                                 "main",                                                                                                         // const char*                                                  pName;
575                                 specMap[VK_SHADER_STAGE_FRAGMENT_BIT],                                          // const VkSpecializationInfo*                  pSpecializationInfo;
576                         }
577                 };
578
579                 m_renderPass            = makeRenderPass                (vk, device, m_colorFormat);
580                 m_framebuffer           = makeFramebuffer               (vk, device, *m_renderPass, 1u, &m_colorAttachment.get(),
581                                                                                                          static_cast<deUint32>(m_renderSize.x()), static_cast<deUint32>(m_renderSize.y()));
582                 m_pipelineLayout        = makePipelineLayout    (vk, device, m_descriptorSetLayout);
583                 m_pipeline                      = makeGraphicsPipeline  (vk, device, *m_pipelineLayout, *m_renderPass, m_renderSize, m_topology, DE_LENGTH_OF_ARRAY(pShaderStages), pShaderStages);
584                 m_cmdPool                       = makeCommandPool               (vk, device, queueFamilyIndex);
585                 m_cmdBuffer                     = makeCommandBuffer             (vk, device, *m_cmdPool);
586         }
587
588         void draw (const DeviceInterface&       vk,
589                            const VkDevice                       device,
590                            const VkQueue                        queue,
591                            const Delegate&                      drawDelegate) const
592         {
593                 beginCommandBuffer(vk, *m_cmdBuffer);
594
595                 const VkClearValue                      clearValue      = makeClearValueColor(m_clearColor);
596                 const VkRect2D                          renderArea      =
597                 {
598                         makeOffset2D(0, 0),
599                         makeExtent2D(m_renderSize.x(), m_renderSize.y()),
600                 };
601                 const VkRenderPassBeginInfo renderPassBeginInfo =
602                 {
603                         VK_STRUCTURE_TYPE_RENDER_PASS_BEGIN_INFO,               // VkStructureType         sType;
604                         DE_NULL,                                                                                // const void*             pNext;
605                         *m_renderPass,                                                                  // VkRenderPass            renderPass;
606                         *m_framebuffer,                                                                 // VkFramebuffer           framebuffer;
607                         renderArea,                                                                             // VkRect2D                renderArea;
608                         1u,                                                                                             // uint32_t                clearValueCount;
609                         &clearValue,                                                                    // const VkClearValue*     pClearValues;
610                 };
611                 vk.cmdBeginRenderPass(*m_cmdBuffer, &renderPassBeginInfo, VK_SUBPASS_CONTENTS_INLINE);
612
613                 vk.cmdBindPipeline(*m_cmdBuffer, VK_PIPELINE_BIND_POINT_GRAPHICS, *m_pipeline);
614                 drawDelegate.rendererDraw(*m_pipelineLayout, *m_cmdBuffer);
615
616                 vk.cmdEndRenderPass(*m_cmdBuffer);
617
618                 // Prepare color image for copy
619                 {
620                         const VkImageMemoryBarrier barriers[] =
621                         {
622                                 {
623                                         VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER,                                         // VkStructureType                      sType;
624                                         DE_NULL,                                                                                                        // const void*                          pNext;
625                                         VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT,                                           // VkAccessFlags                        outputMask;
626                                         VK_ACCESS_TRANSFER_READ_BIT,                                                            // VkAccessFlags                        inputMask;
627                                         VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL,                                       // VkImageLayout                        oldLayout;
628                                         VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL,                                           // VkImageLayout                        newLayout;
629                                         VK_QUEUE_FAMILY_IGNORED,                                                                        // deUint32                                     srcQueueFamilyIndex;
630                                         VK_QUEUE_FAMILY_IGNORED,                                                                        // deUint32                                     destQueueFamilyIndex;
631                                         *m_colorImage,                                                                                          // VkImage                                      image;
632                                         m_colorSubresourceRange,                                                                        // VkImageSubresourceRange      subresourceRange;
633                                 },
634                         };
635
636                         vk.cmdPipelineBarrier(*m_cmdBuffer, VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT, VK_PIPELINE_STAGE_TRANSFER_BIT, 0u,
637                                 0u, DE_NULL, 0u, DE_NULL, DE_LENGTH_OF_ARRAY(barriers), barriers);
638                 }
639                 // Color image -> host buffer
640                 {
641                         const VkBufferImageCopy region =
642                         {
643                                 0ull,                                                                                                                                           // VkDeviceSize                bufferOffset;
644                                 0u,                                                                                                                                                     // uint32_t                    bufferRowLength;
645                                 0u,                                                                                                                                                     // uint32_t                    bufferImageHeight;
646                                 makeImageSubresourceLayers(VK_IMAGE_ASPECT_COLOR_BIT, 0u, 0u, 1u),                      // VkImageSubresourceLayers    imageSubresource;
647                                 makeOffset3D(0, 0, 0),                                                                                                          // VkOffset3D                  imageOffset;
648                                 makeExtent3D(m_renderSize.x(), m_renderSize.y(), 1u),                                           // VkExtent3D                  imageExtent;
649                         };
650
651                         vk.cmdCopyImageToBuffer(*m_cmdBuffer, *m_colorImage, VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, m_colorBuffer, 1u, &region);
652                 }
653                 // Buffer write barrier
654                 {
655                         const VkBufferMemoryBarrier barriers[] =
656                         {
657                                 {
658                                         VK_STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER,                // VkStructureType    sType;
659                                         DE_NULL,                                                                                // const void*        pNext;
660                                         VK_ACCESS_TRANSFER_WRITE_BIT,                                   // VkAccessFlags      srcAccessMask;
661                                         VK_ACCESS_HOST_READ_BIT,                                                // VkAccessFlags      dstAccessMask;
662                                         VK_QUEUE_FAMILY_IGNORED,                                                // uint32_t           srcQueueFamilyIndex;
663                                         VK_QUEUE_FAMILY_IGNORED,                                                // uint32_t           dstQueueFamilyIndex;
664                                         m_colorBuffer,                                                                  // VkBuffer           buffer;
665                                         0ull,                                                                                   // VkDeviceSize       offset;
666                                         VK_WHOLE_SIZE,                                                                  // VkDeviceSize       size;
667                                 },
668                         };
669
670                         vk.cmdPipelineBarrier(*m_cmdBuffer, VK_PIPELINE_STAGE_TRANSFER_BIT, VK_PIPELINE_STAGE_HOST_BIT, 0u,
671                                 0u, DE_NULL, DE_LENGTH_OF_ARRAY(barriers), barriers, DE_NULL, 0u);
672                 }
673
674                 VK_CHECK(vk.endCommandBuffer(*m_cmdBuffer));
675                 submitCommandsAndWait(vk, device, queue, *m_cmdBuffer);
676         }
677
678 private:
679         const VkBuffer                                  m_colorBuffer;
680         const IVec2                                             m_renderSize;
681         const VkFormat                                  m_colorFormat;
682         const VkImageSubresourceRange   m_colorSubresourceRange;
683         const Vec4                                              m_clearColor;
684         const VkPrimitiveTopology               m_topology;
685         const VkDescriptorSetLayout             m_descriptorSetLayout;
686
687         Move<VkImage>                                   m_colorImage;
688         MovePtr<Allocation>                             m_colorImageAlloc;
689         Move<VkImageView>                               m_colorAttachment;
690         Move<VkShaderModule>                    m_vertexModule;
691         Move<VkShaderModule>                    m_fragmentModule;
692         Move<VkRenderPass>                              m_renderPass;
693         Move<VkFramebuffer>                             m_framebuffer;
694         Move<VkPipelineLayout>                  m_pipelineLayout;
695         Move<VkPipeline>                                m_pipeline;
696         Move<VkCommandPool>                             m_cmdPool;
697         Move<VkCommandBuffer>                   m_cmdBuffer;
698
699         // "deleted"
700                                 Renderer        (const Renderer&);
701         Renderer&       operator=       (const Renderer&);
702 };
703
704 void bindSparseBuffer (const DeviceInterface& vk, const VkDevice device, const VkQueue sparseQueue, const VkBuffer buffer, const SparseAllocation& sparseAllocation)
705 {
706         const VkSparseBufferMemoryBindInfo sparseBufferMemoryBindInfo =
707         {
708                 buffer,                                                                                                         // VkBuffer                     buffer;
709                 static_cast<deUint32>(sparseAllocation.memoryBinds.size()),     // uint32_t                     bindCount;
710                 &sparseAllocation.memoryBinds[0],                                                       // const VkSparseMemoryBind*    pBinds;
711         };
712
713         const VkBindSparseInfo bindInfo =
714         {
715                 VK_STRUCTURE_TYPE_BIND_SPARSE_INFO,                                     // VkStructureType                             sType;
716                 DE_NULL,                                                                                        // const void*                                 pNext;
717                 0u,                                                                                                     // uint32_t                                    waitSemaphoreCount;
718                 DE_NULL,                                                                                        // const VkSemaphore*                          pWaitSemaphores;
719                 1u,                                                                                                     // uint32_t                                    bufferBindCount;
720                 &sparseBufferMemoryBindInfo,                                            // const VkSparseBufferMemoryBindInfo*         pBufferBinds;
721                 0u,                                                                                                     // uint32_t                                    imageOpaqueBindCount;
722                 DE_NULL,                                                                                        // const VkSparseImageOpaqueMemoryBindInfo*    pImageOpaqueBinds;
723                 0u,                                                                                                     // uint32_t                                    imageBindCount;
724                 DE_NULL,                                                                                        // const VkSparseImageMemoryBindInfo*          pImageBinds;
725                 0u,                                                                                                     // uint32_t                                    signalSemaphoreCount;
726                 DE_NULL,                                                                                        // const VkSemaphore*                          pSignalSemaphores;
727         };
728
729         const Unique<VkFence> fence(makeFence(vk, device));
730
731         VK_CHECK(vk.queueBindSparse(sparseQueue, 1u, &bindInfo, *fence));
732         VK_CHECK(vk.waitForFences(device, 1u, &fence.get(), VK_TRUE, ~0ull));
733 }
734
735 class SparseBufferTestInstance : public SparseResourcesBaseInstance, Renderer::Delegate
736 {
737 public:
738         SparseBufferTestInstance (Context& context, const TestFlags flags)
739                 : SparseResourcesBaseInstance   (context)
740                 , m_aliased                                             ((flags & TEST_FLAG_ALIASED)   != 0)
741                 , m_residency                                   ((flags & TEST_FLAG_RESIDENCY) != 0)
742                 , m_nonResidentStrict                   ((flags & TEST_FLAG_NON_RESIDENT_STRICT) != 0)
743                 , m_deviceProperties                    (getPhysicalDeviceProperties(m_context.getInstanceInterface(), m_context.getPhysicalDevice()))
744                 , m_renderSize                                  (RENDER_SIZE, RENDER_SIZE)
745                 , m_colorFormat                                 (VK_FORMAT_R8G8B8A8_UNORM)
746                 , m_colorBufferSize                             (m_renderSize.x() * m_renderSize.y() * tcu::getPixelSize(mapVkFormat(m_colorFormat)))
747         {
748                 const VkPhysicalDeviceFeatures  features        = getPhysicalDeviceFeatures(m_context.getInstanceInterface(), m_context.getPhysicalDevice());
749
750                 if (!features.sparseBinding)
751                         TCU_THROW(NotSupportedError, "Missing feature: sparseBinding");
752
753                 if (m_residency && !features.sparseResidencyBuffer)
754                         TCU_THROW(NotSupportedError, "Missing feature: sparseResidencyBuffer");
755
756                 if (m_aliased && !features.sparseResidencyAliased)
757                         TCU_THROW(NotSupportedError, "Missing feature: sparseResidencyAliased");
758
759                 if (m_nonResidentStrict && !m_deviceProperties.sparseProperties.residencyNonResidentStrict)
760                         TCU_THROW(NotSupportedError, "Missing sparse property: residencyNonResidentStrict");
761
762                 {
763                         QueueRequirementsVec requirements;
764                         requirements.push_back(QueueRequirements(VK_QUEUE_SPARSE_BINDING_BIT, 1u));
765                         requirements.push_back(QueueRequirements(VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, 1u));
766
767                         createDeviceSupportingQueues(requirements);
768                 }
769
770                 const DeviceInterface& vk               = getDeviceInterface();
771                 m_sparseQueue                                   = getQueue(VK_QUEUE_SPARSE_BINDING_BIT, 0u);
772                 m_universalQueue                                = getQueue(VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, 0u);
773
774                 m_sharedQueueFamilyIndices[0]   = m_sparseQueue.queueFamilyIndex;
775                 m_sharedQueueFamilyIndices[1]   = m_universalQueue.queueFamilyIndex;
776
777                 m_colorBuffer                                   = makeBuffer(vk, getDevice(), makeBufferCreateInfo(m_colorBufferSize, VK_BUFFER_USAGE_TRANSFER_DST_BIT));
778                 m_colorBufferAlloc                              = bindBuffer(vk, getDevice(), getAllocator(), *m_colorBuffer, MemoryRequirement::HostVisible);
779
780                 deMemset(m_colorBufferAlloc->getHostPtr(), 0, static_cast<std::size_t>(m_colorBufferSize));
781                 flushMappedMemoryRange(vk, getDevice(), m_colorBufferAlloc->getMemory(), m_colorBufferAlloc->getOffset(), m_colorBufferSize);
782         }
783
784 protected:
785         VkBufferCreateInfo getSparseBufferCreateInfo (const VkBufferUsageFlags usage) const
786         {
787                 VkBufferCreateFlags     flags = VK_BUFFER_CREATE_SPARSE_BINDING_BIT;
788                 if (m_residency)
789                         flags |= VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT;
790                 if (m_aliased)
791                         flags |= VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
792
793                 VkBufferCreateInfo referenceBufferCreateInfo =
794                 {
795                         VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO,                           // VkStructureType        sType;
796                         DE_NULL,                                                                                        // const void*            pNext;
797                         flags,                                                                                          // VkBufferCreateFlags    flags;
798                         0u,     // override later                                                               // VkDeviceSize           size;
799                         VK_BUFFER_USAGE_TRANSFER_DST_BIT | usage,                       // VkBufferUsageFlags     usage;
800                         VK_SHARING_MODE_EXCLUSIVE,                                                      // VkSharingMode          sharingMode;
801                         0u,                                                                                                     // uint32_t               queueFamilyIndexCount;
802                         DE_NULL,                                                                                        // const uint32_t*        pQueueFamilyIndices;
803                 };
804
805                 if (m_sparseQueue.queueFamilyIndex != m_universalQueue.queueFamilyIndex)
806                 {
807                         referenceBufferCreateInfo.sharingMode                   = VK_SHARING_MODE_CONCURRENT;
808                         referenceBufferCreateInfo.queueFamilyIndexCount = DE_LENGTH_OF_ARRAY(m_sharedQueueFamilyIndices);
809                         referenceBufferCreateInfo.pQueueFamilyIndices   = m_sharedQueueFamilyIndices;
810                 }
811
812                 return referenceBufferCreateInfo;
813         }
814
815         void draw (const VkPrimitiveTopology    topology,
816                            const VkDescriptorSetLayout  descriptorSetLayout     = DE_NULL,
817                            Renderer::SpecializationMap  specMap                         = Renderer::SpecializationMap())
818         {
819                 const UniquePtr<Renderer> renderer(new Renderer(
820                         getDeviceInterface(), getDevice(), getAllocator(), m_universalQueue.queueFamilyIndex, descriptorSetLayout,
821                         m_context.getBinaryCollection(), "vert", "frag", *m_colorBuffer, m_renderSize, m_colorFormat, Vec4(1.0f, 0.0f, 0.0f, 1.0f), topology, specMap));
822
823                 renderer->draw(getDeviceInterface(), getDevice(), m_universalQueue.queueHandle, *this);
824         }
825
826         tcu::TestStatus verifyDrawResult (void) const
827         {
828                 invalidateMappedMemoryRange(getDeviceInterface(), getDevice(), m_colorBufferAlloc->getMemory(), 0ull, m_colorBufferSize);
829
830                 const tcu::ConstPixelBufferAccess resultImage (mapVkFormat(m_colorFormat), m_renderSize.x(), m_renderSize.y(), 1u, m_colorBufferAlloc->getHostPtr());
831
832                 m_context.getTestContext().getLog()
833                         << tcu::LogImageSet("Result", "Result") << tcu::LogImage("color0", "", resultImage) << tcu::TestLog::EndImageSet;
834
835                 if (imageHasErrorPixels(resultImage))
836                         return tcu::TestStatus::fail("Some buffer values were incorrect");
837                 else
838                         return tcu::TestStatus::pass("Pass");
839         }
840
841         const bool                                                      m_aliased;
842         const bool                                                      m_residency;
843         const bool                                                      m_nonResidentStrict;
844         const VkPhysicalDeviceProperties        m_deviceProperties;
845
846         Queue                                                           m_sparseQueue;
847         Queue                                                           m_universalQueue;
848
849 private:
850         const IVec2                                                     m_renderSize;
851         const VkFormat                                          m_colorFormat;
852         const VkDeviceSize                                      m_colorBufferSize;
853
854         Move<VkBuffer>                                          m_colorBuffer;
855         MovePtr<Allocation>                                     m_colorBufferAlloc;
856
857         deUint32                                                        m_sharedQueueFamilyIndices[2];
858 };
859
860 void initProgramsDrawWithUBO (vk::SourceCollections& programCollection, const TestFlags flags)
861 {
862         // Vertex shader
863         {
864                 std::ostringstream src;
865                 src << glu::getGLSLVersionDeclaration(glu::GLSL_VERSION_450) << "\n"
866                         << "\n"
867                         << "layout(location = 0) in vec4 in_position;\n"
868                         << "\n"
869                         << "out gl_PerVertex {\n"
870                         << "    vec4 gl_Position;\n"
871                         << "};\n"
872                         << "\n"
873                         << "void main(void)\n"
874                         << "{\n"
875                         << "    gl_Position = in_position;\n"
876                         << "}\n";
877
878                 programCollection.glslSources.add("vert") << glu::VertexSource(src.str());
879         }
880
881         // Fragment shader
882         {
883                 const bool                      aliased                         = (flags & TEST_FLAG_ALIASED) != 0;
884                 const bool                      residency                       = (flags & TEST_FLAG_RESIDENCY) != 0;
885                 const bool                      nonResidentStrict       = (flags & TEST_FLAG_NON_RESIDENT_STRICT) != 0;
886                 const std::string       valueExpr                       = (aliased ? "ivec4(3*(ndx % nonAliasedSize) ^ 127, 0, 0, 0)" : "ivec4(3*ndx ^ 127, 0, 0, 0)");
887
888                 std::ostringstream src;
889                 src << glu::getGLSLVersionDeclaration(glu::GLSL_VERSION_450) << "\n"
890                         << "\n"
891                         << "layout(location = 0) out vec4 o_color;\n"
892                         << "\n"
893                         << "layout(constant_id = 1) const int dataSize  = 1;\n"
894                         << "layout(constant_id = 2) const int chunkSize = 1;\n"
895                         << "\n"
896                         << "layout(set = 0, binding = 0, std140) uniform SparseBuffer {\n"
897                         << "    ivec4 data[dataSize];\n"
898                         << "} ubo;\n"
899                         << "\n"
900                         << "void main(void)\n"
901                         << "{\n"
902                         << "    const int fragNdx        = int(gl_FragCoord.x) + " << RENDER_SIZE << " * int(gl_FragCoord.y);\n"
903                         << "    const int pageSize       = " << RENDER_SIZE << " * " << RENDER_SIZE << ";\n"
904                         << "    const int numChunks      = dataSize / chunkSize;\n";
905
906                 if (aliased)
907                         src << "    const int nonAliasedSize = (numChunks > 1 ? dataSize - chunkSize : dataSize);\n";
908
909                 src << "    bool      ok             = true;\n"
910                         << "\n"
911                         << "    for (int ndx = fragNdx; ndx < dataSize; ndx += pageSize)\n"
912                         << "    {\n";
913
914                 if (residency && nonResidentStrict)
915                 {
916                         src << "        if (ndx >= chunkSize && ndx < 2*chunkSize)\n"
917                                 << "            ok = ok && (ubo.data[ndx] == ivec4(0));\n"
918                                 << "        else\n"
919                                 << "            ok = ok && (ubo.data[ndx] == " + valueExpr + ");\n";
920                 }
921                 else if (residency)
922                 {
923                         src << "        if (ndx >= chunkSize && ndx < 2*chunkSize)\n"
924                                 << "            continue;\n"
925                                 << "        ok = ok && (ubo.data[ndx] == " << valueExpr << ");\n";
926                 }
927                 else
928                         src << "        ok = ok && (ubo.data[ndx] == " << valueExpr << ");\n";
929
930                 src << "    }\n"
931                         << "\n"
932                         << "    if (ok)\n"
933                         << "        o_color = vec4(0.0, 1.0, 0.0, 1.0);\n"
934                         << "    else\n"
935                         << "        o_color = vec4(1.0, 0.0, 0.0, 1.0);\n"
936                         << "}\n";
937
938                 programCollection.glslSources.add("frag") << glu::FragmentSource(src.str());
939         }
940 }
941
942 //! Sparse buffer backing a UBO
943 class UBOTestInstance : public SparseBufferTestInstance
944 {
945 public:
946         UBOTestInstance (Context& context, const TestFlags flags)
947                 : SparseBufferTestInstance      (context, flags)
948         {
949         }
950
951         void rendererDraw (const VkPipelineLayout pipelineLayout, const VkCommandBuffer cmdBuffer) const
952         {
953                 const DeviceInterface&  vk                              = getDeviceInterface();
954                 const VkDeviceSize              vertexOffset    = 0ull;
955
956                 vk.cmdBindVertexBuffers (cmdBuffer, 0u, 1u, &m_vertexBuffer.get(), &vertexOffset);
957                 vk.cmdBindDescriptorSets(cmdBuffer, VK_PIPELINE_BIND_POINT_GRAPHICS, pipelineLayout, 0u, 1u, &m_descriptorSet.get(), 0u, DE_NULL);
958                 vk.cmdDraw                              (cmdBuffer, 4u, 1u, 0u, 0u);
959         }
960
961         tcu::TestStatus iterate (void)
962         {
963                 const DeviceInterface&          vk                                      = getDeviceInterface();
964                 MovePtr<SparseAllocation>       sparseAllocation;
965                 Move<VkBuffer>                          sparseBuffer;
966                 Move<VkBuffer>                          sparseBufferAliased;
967
968                 // Set up the sparse buffer
969                 {
970                         VkBufferCreateInfo      referenceBufferCreateInfo       = getSparseBufferCreateInfo(VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT);
971                         const VkDeviceSize      minChunkSize                            = 512u; // make sure the smallest allocation is at least this big
972                         deUint32                        numMaxChunks                            = 0u;
973
974                         // Check how many chunks we can allocate given the alignment and size requirements of UBOs
975                         {
976                                 const UniquePtr<SparseAllocation> minAllocation(SparseAllocationBuilder()
977                                         .addMemoryBind()
978                                         .build(vk, getDevice(), getAllocator(), referenceBufferCreateInfo, minChunkSize));
979
980                                 if (minAllocation->resourceSize > m_deviceProperties.limits.maxUniformBufferRange)
981                                         return tcu::TestStatus::fail("The smallest sparse UBO size exceeds maxUniformBufferRange limit");
982
983                                 numMaxChunks = static_cast<deUint32>(m_deviceProperties.limits.maxUniformBufferRange / minAllocation->resourceSize);
984                         }
985
986                         if (numMaxChunks < 4)
987                         {
988                                 sparseAllocation = SparseAllocationBuilder()
989                                         .addMemoryBind()
990                                         .build(vk, getDevice(), getAllocator(), referenceBufferCreateInfo, minChunkSize);
991                         }
992                         else
993                         {
994                                 // Try to use a non-trivial memory allocation scheme to make it different from a non-sparse binding
995                                 SparseAllocationBuilder builder;
996                                 builder.addMemoryBind();
997
998                                 if (m_residency)
999                                         builder.addResourceHole();
1000
1001                                 builder
1002                                         .addMemoryAllocation()
1003                                         .addMemoryHole()
1004                                         .addMemoryBind();
1005
1006                                 if (m_aliased)
1007                                         builder.addAliasedMemoryBind(0u, 0u);
1008
1009                                 sparseAllocation = builder.build(vk, getDevice(), getAllocator(), referenceBufferCreateInfo, minChunkSize);
1010                                 DE_ASSERT(sparseAllocation->resourceSize <= m_deviceProperties.limits.maxUniformBufferRange);
1011                         }
1012
1013                         // Create the buffer
1014                         referenceBufferCreateInfo.size  = sparseAllocation->resourceSize;
1015                         sparseBuffer                                    = makeBuffer(vk, getDevice(), referenceBufferCreateInfo);
1016                         bindSparseBuffer(vk, getDevice(), m_sparseQueue.queueHandle, *sparseBuffer, *sparseAllocation);
1017
1018                         if (m_aliased)
1019                         {
1020                                 sparseBufferAliased = makeBuffer(vk, getDevice(), referenceBufferCreateInfo);
1021                                 bindSparseBuffer(vk, getDevice(), m_sparseQueue.queueHandle, *sparseBufferAliased, *sparseAllocation);
1022                         }
1023                 }
1024
1025                 // Set uniform data
1026                 {
1027                         const bool                                      hasAliasedChunk         = (m_aliased && sparseAllocation->memoryBinds.size() > 1u);
1028                         const VkDeviceSize                      chunkSize                       = sparseAllocation->resourceSize / sparseAllocation->numResourceChunks;
1029                         const VkDeviceSize                      stagingBufferSize       = sparseAllocation->resourceSize - (hasAliasedChunk ? chunkSize : 0);
1030                         const deUint32                          numBufferEntries        = static_cast<deUint32>(stagingBufferSize / sizeof(IVec4));
1031
1032                         const Unique<VkBuffer>          stagingBuffer           (makeBuffer(vk, getDevice(), makeBufferCreateInfo(stagingBufferSize, VK_BUFFER_USAGE_TRANSFER_SRC_BIT)));
1033                         const UniquePtr<Allocation>     stagingBufferAlloc      (bindBuffer(vk, getDevice(), getAllocator(), *stagingBuffer, MemoryRequirement::HostVisible));
1034
1035                         {
1036                                 // If aliased chunk is used, the staging buffer is smaller than the sparse buffer and we don't overwrite the last chunk
1037                                 IVec4* const pData = static_cast<IVec4*>(stagingBufferAlloc->getHostPtr());
1038                                 for (deUint32 i = 0; i < numBufferEntries; ++i)
1039                                         pData[i] = IVec4(3*i ^ 127, 0, 0, 0);
1040
1041                                 flushMappedMemoryRange(vk, getDevice(), stagingBufferAlloc->getMemory(), stagingBufferAlloc->getOffset(), stagingBufferSize);
1042
1043                                 const VkBufferCopy copyRegion =
1044                                 {
1045                                         0ull,                                           // VkDeviceSize    srcOffset;
1046                                         0ull,                                           // VkDeviceSize    dstOffset;
1047                                         stagingBufferSize,                      // VkDeviceSize    size;
1048                                 };
1049
1050                                 const Unique<VkCommandPool>             cmdPool         (makeCommandPool        (vk, getDevice(), m_universalQueue.queueFamilyIndex));
1051                                 const Unique<VkCommandBuffer>   cmdBuffer       (makeCommandBuffer      (vk, getDevice(), *cmdPool));
1052
1053                                 beginCommandBuffer      (vk, *cmdBuffer);
1054                                 vk.cmdCopyBuffer        (*cmdBuffer, *stagingBuffer, *sparseBuffer, 1u, &copyRegion);
1055                                 endCommandBuffer        (vk, *cmdBuffer);
1056
1057                                 submitCommandsAndWait(vk, getDevice(), m_universalQueue.queueHandle, *cmdBuffer);
1058                                 // Once the fence is signaled, the write is also available to the aliasing buffer.
1059                         }
1060                 }
1061
1062                 // Descriptor sets
1063                 {
1064                         m_descriptorSetLayout = DescriptorSetLayoutBuilder()
1065                                 .addSingleBinding(VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER, VK_SHADER_STAGE_FRAGMENT_BIT)
1066                                 .build(vk, getDevice());
1067
1068                         m_descriptorPool = DescriptorPoolBuilder()
1069                                 .addType(VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER)
1070                                 .build(vk, getDevice(), VK_DESCRIPTOR_POOL_CREATE_FREE_DESCRIPTOR_SET_BIT, 1u);
1071
1072                         m_descriptorSet = makeDescriptorSet(vk, getDevice(), *m_descriptorPool, *m_descriptorSetLayout);
1073
1074                         const VkBuffer                                  buffer                          = (m_aliased ? *sparseBufferAliased : *sparseBuffer);
1075                         const VkDescriptorBufferInfo    sparseBufferInfo        = makeDescriptorBufferInfo(buffer, 0ull, sparseAllocation->resourceSize);
1076
1077                         DescriptorSetUpdateBuilder()
1078                                 .writeSingle(*m_descriptorSet, DescriptorSetUpdateBuilder::Location::binding(0u), VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER, &sparseBufferInfo)
1079                                 .update(vk, getDevice());
1080                 }
1081
1082                 // Vertex data
1083                 {
1084                         const Vec4 vertexData[] =
1085                         {
1086                                 Vec4(-1.0f, -1.0f, 0.0f, 1.0f),
1087                                 Vec4(-1.0f,  1.0f, 0.0f, 1.0f),
1088                                 Vec4( 1.0f, -1.0f, 0.0f, 1.0f),
1089                                 Vec4( 1.0f,  1.0f, 0.0f, 1.0f),
1090                         };
1091
1092                         const VkDeviceSize      vertexBufferSize        = sizeof(vertexData);
1093
1094                         m_vertexBuffer          = makeBuffer(vk, getDevice(), makeBufferCreateInfo(vertexBufferSize, VK_BUFFER_USAGE_VERTEX_BUFFER_BIT));
1095                         m_vertexBufferAlloc     = bindBuffer(vk, getDevice(), getAllocator(), *m_vertexBuffer, MemoryRequirement::HostVisible);
1096
1097                         deMemcpy(m_vertexBufferAlloc->getHostPtr(), &vertexData[0], vertexBufferSize);
1098                         flushMappedMemoryRange(vk, getDevice(), m_vertexBufferAlloc->getMemory(), m_vertexBufferAlloc->getOffset(), vertexBufferSize);
1099                 }
1100
1101                 // Draw
1102                 {
1103                         std::vector<deInt32> specializationData;
1104                         {
1105                                 const deUint32  numBufferEntries        = static_cast<deUint32>(sparseAllocation->resourceSize / sizeof(IVec4));
1106                                 const deUint32  numEntriesPerChunk      = numBufferEntries / sparseAllocation->numResourceChunks;
1107
1108                                 specializationData.push_back(numBufferEntries);
1109                                 specializationData.push_back(numEntriesPerChunk);
1110                         }
1111
1112                         const VkSpecializationMapEntry  specMapEntries[] =
1113                         {
1114                                 {
1115                                         1u,                                     // uint32_t    constantID;
1116                                         0u,                                     // uint32_t    offset;
1117                                         sizeof(deInt32),        // size_t      size;
1118                                 },
1119                                 {
1120                                         2u,                                     // uint32_t    constantID;
1121                                         sizeof(deInt32),        // uint32_t    offset;
1122                                         sizeof(deInt32),        // size_t      size;
1123                                 },
1124                         };
1125
1126                         const VkSpecializationInfo specInfo =
1127                         {
1128                                 DE_LENGTH_OF_ARRAY(specMapEntries),             // uint32_t                           mapEntryCount;
1129                                 specMapEntries,                                                 // const VkSpecializationMapEntry*    pMapEntries;
1130                                 sizeInBytes(specializationData),                // size_t                             dataSize;
1131                                 getDataOrNullptr(specializationData),   // const void*                        pData;
1132                         };
1133
1134                         Renderer::SpecializationMap     specMap;
1135                         specMap[VK_SHADER_STAGE_FRAGMENT_BIT] = &specInfo;
1136
1137                         draw(VK_PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP, *m_descriptorSetLayout, specMap);
1138                 }
1139
1140                 return verifyDrawResult();
1141         }
1142
1143 private:
1144         Move<VkBuffer>                                  m_vertexBuffer;
1145         MovePtr<Allocation>                             m_vertexBufferAlloc;
1146
1147         Move<VkDescriptorSetLayout>             m_descriptorSetLayout;
1148         Move<VkDescriptorPool>                  m_descriptorPool;
1149         Move<VkDescriptorSet>                   m_descriptorSet;
1150 };
1151
1152 void initProgramsDrawGrid (vk::SourceCollections& programCollection, const TestFlags flags)
1153 {
1154         DE_UNREF(flags);
1155
1156         // Vertex shader
1157         {
1158                 std::ostringstream src;
1159                 src << glu::getGLSLVersionDeclaration(glu::GLSL_VERSION_450) << "\n"
1160                         << "\n"
1161                         << "layout(location = 0) in  vec4 in_position;\n"
1162                         << "layout(location = 0) out int  out_ndx;\n"
1163                         << "\n"
1164                         << "out gl_PerVertex {\n"
1165                         << "    vec4 gl_Position;\n"
1166                         << "};\n"
1167                         << "\n"
1168                         << "void main(void)\n"
1169                         << "{\n"
1170                         << "    gl_Position = in_position;\n"
1171                         << "    out_ndx     = gl_VertexIndex;\n"
1172                         << "}\n";
1173
1174                 programCollection.glslSources.add("vert") << glu::VertexSource(src.str());
1175         }
1176
1177         // Fragment shader
1178         {
1179                 std::ostringstream src;
1180                 src << glu::getGLSLVersionDeclaration(glu::GLSL_VERSION_450) << "\n"
1181                         << "\n"
1182                         << "layout(location = 0) flat in  int  in_ndx;\n"
1183                         << "layout(location = 0)      out vec4 o_color;\n"
1184                         << "\n"
1185                         << "void main(void)\n"
1186                         << "{\n"
1187                         << "    if (in_ndx % 2 == 0)\n"
1188                         << "        o_color = vec4(vec3(1.0), 1.0);\n"
1189                         << "    else\n"
1190                         << "        o_color = vec4(vec3(0.75), 1.0);\n"
1191                         << "}\n";
1192
1193                 programCollection.glslSources.add("frag") << glu::FragmentSource(src.str());
1194         }
1195 }
1196
1197 //! Generate vertex positions for a grid of tiles composed of two triangles each (6 vertices)
1198 void generateGrid (void* pRawData, const float step, const float ox, const float oy, const deUint32 numX, const deUint32 numY, const float z = 0.0f)
1199 {
1200         typedef Vec4 (*TilePtr)[6];
1201
1202         TilePtr const pData = static_cast<TilePtr>(pRawData);
1203         {
1204                 for (deUint32 iy = 0; iy < numY; ++iy)
1205                 for (deUint32 ix = 0; ix < numX; ++ix)
1206                 {
1207                         const deUint32  ndx     = ix + numX * iy;
1208                         const float             x       = ox + step * static_cast<float>(ix);
1209                         const float             y       = oy + step * static_cast<float>(iy);
1210
1211                         pData[ndx][0] = Vec4(x + step,  y,                      z, 1.0f);
1212                         pData[ndx][1] = Vec4(x,                 y,                      z, 1.0f);
1213                         pData[ndx][2] = Vec4(x,                 y + step,       z, 1.0f);
1214
1215                         pData[ndx][3] = Vec4(x,                 y + step,       z, 1.0f);
1216                         pData[ndx][4] = Vec4(x + step,  y + step,       z, 1.0f);
1217                         pData[ndx][5] = Vec4(x + step,  y,                      z, 1.0f);
1218                 }
1219         }
1220 }
1221
1222 //! Base test for a sparse buffer backing a vertex/index buffer
1223 class DrawGridTestInstance : public SparseBufferTestInstance
1224 {
1225 public:
1226         DrawGridTestInstance (Context& context, const TestFlags flags, const VkBufferUsageFlags usage, const VkDeviceSize minChunkSize)
1227                 : SparseBufferTestInstance      (context, flags)
1228         {
1229                 const DeviceInterface&  vk                                                      = getDeviceInterface();
1230                 VkBufferCreateInfo              referenceBufferCreateInfo       = getSparseBufferCreateInfo(usage);
1231
1232                 {
1233                         // Allocate two chunks, each covering half of the viewport
1234                         SparseAllocationBuilder builder;
1235                         builder.addMemoryBind();
1236
1237                         if (m_residency)
1238                                 builder.addResourceHole();
1239
1240                         builder
1241                                 .addMemoryAllocation()
1242                                 .addMemoryHole()
1243                                 .addMemoryBind();
1244
1245                         if (m_aliased)
1246                                 builder.addAliasedMemoryBind(0u, 0u);
1247
1248                         m_sparseAllocation      = builder.build(vk, getDevice(), getAllocator(), referenceBufferCreateInfo, minChunkSize);
1249                 }
1250
1251                 // Create the buffer
1252                 referenceBufferCreateInfo.size  = m_sparseAllocation->resourceSize;
1253                 m_sparseBuffer                                  = makeBuffer(vk, getDevice(), referenceBufferCreateInfo);
1254
1255                 // Bind the memory
1256                 bindSparseBuffer(vk, getDevice(), m_sparseQueue.queueHandle, *m_sparseBuffer, *m_sparseAllocation);
1257
1258                 m_perDrawBufferOffset   = m_sparseAllocation->resourceSize / m_sparseAllocation->numResourceChunks;
1259                 m_stagingBufferSize             = 2 * m_perDrawBufferOffset;
1260                 m_stagingBuffer                 = makeBuffer(vk, getDevice(), makeBufferCreateInfo(m_stagingBufferSize, VK_BUFFER_USAGE_TRANSFER_SRC_BIT));
1261                 m_stagingBufferAlloc    = bindBuffer(vk, getDevice(), getAllocator(), *m_stagingBuffer, MemoryRequirement::HostVisible);
1262         }
1263
1264         tcu::TestStatus iterate (void)
1265         {
1266                 initializeBuffers();
1267
1268                 const DeviceInterface&  vk      = getDeviceInterface();
1269
1270                 // Upload to the sparse buffer
1271                 {
1272                         flushMappedMemoryRange(vk, getDevice(), m_stagingBufferAlloc->getMemory(), m_stagingBufferAlloc->getOffset(), m_stagingBufferSize);
1273
1274                         VkDeviceSize    firstChunkOffset        = 0ull;
1275                         VkDeviceSize    secondChunkOffset       = m_perDrawBufferOffset;
1276
1277                         if (m_residency)
1278                                 secondChunkOffset += m_perDrawBufferOffset;
1279
1280                         if (m_aliased)
1281                                 firstChunkOffset = secondChunkOffset + m_perDrawBufferOffset;
1282
1283                         const VkBufferCopy copyRegions[] =
1284                         {
1285                                 {
1286                                         0ull,                                           // VkDeviceSize    srcOffset;
1287                                         firstChunkOffset,                       // VkDeviceSize    dstOffset;
1288                                         m_perDrawBufferOffset,          // VkDeviceSize    size;
1289                                 },
1290                                 {
1291                                         m_perDrawBufferOffset,          // VkDeviceSize    srcOffset;
1292                                         secondChunkOffset,                      // VkDeviceSize    dstOffset;
1293                                         m_perDrawBufferOffset,          // VkDeviceSize    size;
1294                                 },
1295                         };
1296
1297                         const Unique<VkCommandPool>             cmdPool         (makeCommandPool        (vk, getDevice(), m_universalQueue.queueFamilyIndex));
1298                         const Unique<VkCommandBuffer>   cmdBuffer       (makeCommandBuffer      (vk, getDevice(), *cmdPool));
1299
1300                         beginCommandBuffer      (vk, *cmdBuffer);
1301                         vk.cmdCopyBuffer        (*cmdBuffer, *m_stagingBuffer, *m_sparseBuffer, DE_LENGTH_OF_ARRAY(copyRegions), copyRegions);
1302                         endCommandBuffer        (vk, *cmdBuffer);
1303
1304                         submitCommandsAndWait(vk, getDevice(), m_universalQueue.queueHandle, *cmdBuffer);
1305                 }
1306
1307                 draw(VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST);
1308
1309                 return verifyDrawResult();
1310         }
1311
1312 protected:
1313         virtual void                            initializeBuffers               (void) = 0;
1314
1315         VkDeviceSize                            m_perDrawBufferOffset;
1316
1317         VkDeviceSize                            m_stagingBufferSize;
1318         Move<VkBuffer>                          m_stagingBuffer;
1319         MovePtr<Allocation>                     m_stagingBufferAlloc;
1320
1321         MovePtr<SparseAllocation>       m_sparseAllocation;
1322         Move<VkBuffer>                          m_sparseBuffer;
1323 };
1324
1325 //! Sparse buffer backing a vertex input buffer
1326 class VertexBufferTestInstance : public DrawGridTestInstance
1327 {
1328 public:
1329         VertexBufferTestInstance (Context& context, const TestFlags flags)
1330                 : DrawGridTestInstance  (context,
1331                                                                  flags,
1332                                                                  VK_BUFFER_USAGE_VERTEX_BUFFER_BIT,
1333                                                                  GRID_SIZE * GRID_SIZE * 6 * sizeof(Vec4))
1334         {
1335         }
1336
1337         void rendererDraw (const VkPipelineLayout pipelineLayout, const VkCommandBuffer cmdBuffer) const
1338         {
1339                 DE_UNREF(pipelineLayout);
1340
1341                 m_context.getTestContext().getLog()
1342                         << tcu::TestLog::Message << "Drawing a grid of triangles backed by a sparse vertex buffer. There should be no red pixels visible." << tcu::TestLog::EndMessage;
1343
1344                 const DeviceInterface&  vk                              = getDeviceInterface();
1345                 const deUint32                  vertexCount             = 6 * (GRID_SIZE * GRID_SIZE) / 2;
1346                 VkDeviceSize                    vertexOffset    = 0ull;
1347
1348                 vk.cmdBindVertexBuffers (cmdBuffer, 0u, 1u, &m_sparseBuffer.get(), &vertexOffset);
1349                 vk.cmdDraw                              (cmdBuffer, vertexCount, 1u, 0u, 0u);
1350
1351                 vertexOffset += m_perDrawBufferOffset * (m_residency ? 2 : 1);
1352
1353                 vk.cmdBindVertexBuffers (cmdBuffer, 0u, 1u, &m_sparseBuffer.get(), &vertexOffset);
1354                 vk.cmdDraw                              (cmdBuffer, vertexCount, 1u, 0u, 0u);
1355         }
1356
1357         void initializeBuffers (void)
1358         {
1359                 deUint8*        pData   = static_cast<deUint8*>(m_stagingBufferAlloc->getHostPtr());
1360                 const float     step    = 2.0f / static_cast<float>(GRID_SIZE);
1361
1362                 // Prepare data for two draw calls
1363                 generateGrid(pData,                                                     step, -1.0f, -1.0f, GRID_SIZE, GRID_SIZE/2);
1364                 generateGrid(pData + m_perDrawBufferOffset,     step, -1.0f,  0.0f, GRID_SIZE, GRID_SIZE/2);
1365         }
1366 };
1367
1368 //! Sparse buffer backing an index buffer
1369 class IndexBufferTestInstance : public DrawGridTestInstance
1370 {
1371 public:
1372         IndexBufferTestInstance (Context& context, const TestFlags flags)
1373                 : DrawGridTestInstance  (context,
1374                                                                  flags,
1375                                                                  VK_BUFFER_USAGE_INDEX_BUFFER_BIT,
1376                                                                  GRID_SIZE * GRID_SIZE * 6 * sizeof(deUint32))
1377                 , m_halfVertexCount             (6 * (GRID_SIZE * GRID_SIZE) / 2)
1378         {
1379         }
1380
1381         void rendererDraw (const VkPipelineLayout pipelineLayout, const VkCommandBuffer cmdBuffer) const
1382         {
1383                 DE_UNREF(pipelineLayout);
1384
1385                 m_context.getTestContext().getLog()
1386                         << tcu::TestLog::Message << "Drawing a grid of triangles from a sparse index buffer. There should be no red pixels visible." << tcu::TestLog::EndMessage;
1387
1388                 const DeviceInterface&  vk                              = getDeviceInterface();
1389                 const VkDeviceSize              vertexOffset    = 0ull;
1390                 VkDeviceSize                    indexOffset             = 0ull;
1391
1392                 vk.cmdBindVertexBuffers (cmdBuffer, 0u, 1u, &m_vertexBuffer.get(), &vertexOffset);
1393
1394                 vk.cmdBindIndexBuffer   (cmdBuffer, *m_sparseBuffer, indexOffset, VK_INDEX_TYPE_UINT32);
1395                 vk.cmdDrawIndexed               (cmdBuffer, m_halfVertexCount, 1u, 0u, 0, 0u);
1396
1397                 indexOffset += m_perDrawBufferOffset * (m_residency ? 2 : 1);
1398
1399                 vk.cmdBindIndexBuffer   (cmdBuffer, *m_sparseBuffer, indexOffset, VK_INDEX_TYPE_UINT32);
1400                 vk.cmdDrawIndexed               (cmdBuffer, m_halfVertexCount, 1u, 0u, 0, 0u);
1401         }
1402
1403         void initializeBuffers (void)
1404         {
1405                 // Vertex buffer
1406                 const DeviceInterface&  vk                                      = getDeviceInterface();
1407                 const VkDeviceSize              vertexBufferSize        = 2 * m_halfVertexCount * sizeof(Vec4);
1408                                                                 m_vertexBuffer          = makeBuffer(vk, getDevice(), makeBufferCreateInfo(vertexBufferSize, VK_BUFFER_USAGE_VERTEX_BUFFER_BIT));
1409                                                                 m_vertexBufferAlloc     = bindBuffer(vk, getDevice(), getAllocator(), *m_vertexBuffer, MemoryRequirement::HostVisible);
1410
1411                 {
1412                         const float     step = 2.0f / static_cast<float>(GRID_SIZE);
1413
1414                         generateGrid(m_vertexBufferAlloc->getHostPtr(), step, -1.0f, -1.0f, GRID_SIZE, GRID_SIZE);
1415
1416                         flushMappedMemoryRange(vk, getDevice(), m_vertexBufferAlloc->getMemory(), m_vertexBufferAlloc->getOffset(), vertexBufferSize);
1417                 }
1418
1419                 // Sparse index buffer
1420                 for (deUint32 chunkNdx = 0u; chunkNdx < 2; ++chunkNdx)
1421                 {
1422                         deUint8* const  pData           = static_cast<deUint8*>(m_stagingBufferAlloc->getHostPtr()) + chunkNdx * m_perDrawBufferOffset;
1423                         deUint32* const pIndexData      = reinterpret_cast<deUint32*>(pData);
1424                         const deUint32  ndxBase         = chunkNdx * m_halfVertexCount;
1425
1426                         for (deUint32 i = 0u; i < m_halfVertexCount; ++i)
1427                                 pIndexData[i] = ndxBase + i;
1428                 }
1429         }
1430
1431 private:
1432         const deUint32                  m_halfVertexCount;
1433         Move<VkBuffer>                  m_vertexBuffer;
1434         MovePtr<Allocation>             m_vertexBufferAlloc;
1435 };
1436
1437 //! Draw from a sparse indirect buffer
1438 class IndirectBufferTestInstance : public DrawGridTestInstance
1439 {
1440 public:
1441         IndirectBufferTestInstance (Context& context, const TestFlags flags)
1442                 : DrawGridTestInstance  (context,
1443                                                                  flags,
1444                                                                  VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT,
1445                                                                  sizeof(VkDrawIndirectCommand))
1446         {
1447         }
1448
1449         void rendererDraw (const VkPipelineLayout pipelineLayout, const VkCommandBuffer cmdBuffer) const
1450         {
1451                 DE_UNREF(pipelineLayout);
1452
1453                 m_context.getTestContext().getLog()
1454                         << tcu::TestLog::Message << "Drawing two triangles covering the whole viewport. There should be no red pixels visible." << tcu::TestLog::EndMessage;
1455
1456                 const DeviceInterface&  vk                              = getDeviceInterface();
1457                 const VkDeviceSize              vertexOffset    = 0ull;
1458                 VkDeviceSize                    indirectOffset  = 0ull;
1459
1460                 vk.cmdBindVertexBuffers (cmdBuffer, 0u, 1u, &m_vertexBuffer.get(), &vertexOffset);
1461                 vk.cmdDrawIndirect              (cmdBuffer, *m_sparseBuffer, indirectOffset, 1u, 0u);
1462
1463                 indirectOffset += m_perDrawBufferOffset * (m_residency ? 2 : 1);
1464
1465                 vk.cmdDrawIndirect              (cmdBuffer, *m_sparseBuffer, indirectOffset, 1u, 0u);
1466         }
1467
1468         void initializeBuffers (void)
1469         {
1470                 // Vertex buffer
1471                 const DeviceInterface&  vk                                      = getDeviceInterface();
1472                 const VkDeviceSize              vertexBufferSize        = 2 * 3 * sizeof(Vec4);
1473                                                                 m_vertexBuffer          = makeBuffer(vk, getDevice(), makeBufferCreateInfo(vertexBufferSize, VK_BUFFER_USAGE_VERTEX_BUFFER_BIT));
1474                                                                 m_vertexBufferAlloc     = bindBuffer(vk, getDevice(), getAllocator(), *m_vertexBuffer, MemoryRequirement::HostVisible);
1475
1476                 {
1477                         generateGrid(m_vertexBufferAlloc->getHostPtr(), 2.0f, -1.0f, -1.0f, 1, 1);
1478                         flushMappedMemoryRange(vk, getDevice(), m_vertexBufferAlloc->getMemory(), m_vertexBufferAlloc->getOffset(), vertexBufferSize);
1479                 }
1480
1481                 // Indirect buffer
1482                 for (deUint32 chunkNdx = 0u; chunkNdx < 2; ++chunkNdx)
1483                 {
1484                         deUint8* const                                  pData           = static_cast<deUint8*>(m_stagingBufferAlloc->getHostPtr()) + chunkNdx * m_perDrawBufferOffset;
1485                         VkDrawIndirectCommand* const    pCmdData        = reinterpret_cast<VkDrawIndirectCommand*>(pData);
1486
1487                         pCmdData->firstVertex   = 3u * chunkNdx;
1488                         pCmdData->firstInstance = 0u;
1489                         pCmdData->vertexCount   = 3u;
1490                         pCmdData->instanceCount = 1u;
1491                 }
1492         }
1493
1494 private:
1495         Move<VkBuffer>                  m_vertexBuffer;
1496         MovePtr<Allocation>             m_vertexBufferAlloc;
1497 };
1498
1499 //! Similar to the class in vktTestCaseUtil.hpp, but uses Arg0 directly rather than through a InstanceFunction1
1500 template<typename Arg0>
1501 class FunctionProgramsSimple1
1502 {
1503 public:
1504         typedef void    (*Function)                             (vk::SourceCollections& dst, Arg0 arg0);
1505                                         FunctionProgramsSimple1 (Function func) : m_func(func)                                                  {}
1506         void                    init                                    (vk::SourceCollections& dst, const Arg0& arg0) const    { m_func(dst, arg0); }
1507
1508 private:
1509         const Function  m_func;
1510 };
1511
1512 //! Convenience function to create a TestCase based on a freestanding initPrograms and a TestInstance implementation
1513 template<typename TestInstanceT, typename Arg0>
1514 TestCase* createTestInstanceWithPrograms (tcu::TestContext&                                                                     testCtx,
1515                                                                                   const std::string&                                                            name,
1516                                                                                   const std::string&                                                            desc,
1517                                                                                   typename FunctionProgramsSimple1<Arg0>::Function      initPrograms,
1518                                                                                   Arg0                                                                                          arg0)
1519 {
1520         return new InstanceFactory1<TestInstanceT, Arg0, FunctionProgramsSimple1<Arg0> >(
1521                 testCtx, tcu::NODETYPE_SELF_VALIDATE, name, desc, FunctionProgramsSimple1<Arg0>(initPrograms), arg0);
1522 }
1523
1524 void populateTestGroup (tcu::TestCaseGroup* parentGroup)
1525 {
1526         const struct
1527         {
1528                 std::string             name;
1529                 TestFlags               flags;
1530         } groups[] =
1531         {
1532                 { "sparse_binding",                                                     0u                                                                                                              },
1533                 { "sparse_binding_aliased",                                     TEST_FLAG_ALIASED,                                                                              },
1534                 { "sparse_residency",                                           TEST_FLAG_RESIDENCY,                                                                    },
1535                 { "sparse_residency_aliased",                           TEST_FLAG_RESIDENCY | TEST_FLAG_ALIASED,                                },
1536                 { "sparse_residency_non_resident_strict",       TEST_FLAG_RESIDENCY | TEST_FLAG_NON_RESIDENT_STRICT,    },
1537         };
1538
1539         const int numGroupsIncludingNonResidentStrict   = DE_LENGTH_OF_ARRAY(groups);
1540         const int numGroupsDefaultList                                  = numGroupsIncludingNonResidentStrict - 1;
1541
1542         // Transfer
1543         {
1544                 MovePtr<tcu::TestCaseGroup> group(new tcu::TestCaseGroup(parentGroup->getTestContext(), "transfer", ""));
1545                 {
1546                         MovePtr<tcu::TestCaseGroup> subGroup(new tcu::TestCaseGroup(parentGroup->getTestContext(), "sparse_binding", ""));
1547                         addBufferSparseBindingTests(subGroup.get());
1548                         group->addChild(subGroup.release());
1549                 }
1550                 parentGroup->addChild(group.release());
1551         }
1552
1553         // SSBO
1554         {
1555                 MovePtr<tcu::TestCaseGroup> group(new tcu::TestCaseGroup(parentGroup->getTestContext(), "ssbo", ""));
1556                 {
1557                         MovePtr<tcu::TestCaseGroup> subGroup(new tcu::TestCaseGroup(parentGroup->getTestContext(), "sparse_binding_aliased", ""));
1558                         addBufferSparseMemoryAliasingTests(subGroup.get());
1559                         group->addChild(subGroup.release());
1560                 }
1561                 {
1562                         MovePtr<tcu::TestCaseGroup> subGroup(new tcu::TestCaseGroup(parentGroup->getTestContext(), "sparse_residency", ""));
1563                         addBufferSparseResidencyTests(subGroup.get());
1564                         group->addChild(subGroup.release());
1565                 }
1566                 parentGroup->addChild(group.release());
1567         }
1568
1569         // UBO
1570         {
1571                 MovePtr<tcu::TestCaseGroup> group(new tcu::TestCaseGroup(parentGroup->getTestContext(), "ubo", ""));
1572
1573                 for (int groupNdx = 0u; groupNdx < numGroupsIncludingNonResidentStrict; ++groupNdx)
1574                         group->addChild(createTestInstanceWithPrograms<UBOTestInstance>(group->getTestContext(), groups[groupNdx].name.c_str(), "", initProgramsDrawWithUBO, groups[groupNdx].flags));
1575
1576                 parentGroup->addChild(group.release());
1577         }
1578
1579         // Vertex buffer
1580         {
1581                 MovePtr<tcu::TestCaseGroup> group(new tcu::TestCaseGroup(parentGroup->getTestContext(), "vertex_buffer", ""));
1582
1583                 for (int groupNdx = 0u; groupNdx < numGroupsDefaultList; ++groupNdx)
1584                         group->addChild(createTestInstanceWithPrograms<VertexBufferTestInstance>(group->getTestContext(), groups[groupNdx].name.c_str(), "", initProgramsDrawGrid, groups[groupNdx].flags));
1585
1586                 parentGroup->addChild(group.release());
1587         }
1588
1589         // Index buffer
1590         {
1591                 MovePtr<tcu::TestCaseGroup> group(new tcu::TestCaseGroup(parentGroup->getTestContext(), "index_buffer", ""));
1592
1593                 for (int groupNdx = 0u; groupNdx < numGroupsDefaultList; ++groupNdx)
1594                         group->addChild(createTestInstanceWithPrograms<IndexBufferTestInstance>(group->getTestContext(), groups[groupNdx].name.c_str(), "", initProgramsDrawGrid, groups[groupNdx].flags));
1595
1596                 parentGroup->addChild(group.release());
1597         }
1598
1599         // Indirect buffer
1600         {
1601                 MovePtr<tcu::TestCaseGroup> group(new tcu::TestCaseGroup(parentGroup->getTestContext(), "indirect_buffer", ""));
1602
1603                 for (int groupNdx = 0u; groupNdx < numGroupsDefaultList; ++groupNdx)
1604                         group->addChild(createTestInstanceWithPrograms<IndirectBufferTestInstance>(group->getTestContext(), groups[groupNdx].name.c_str(), "", initProgramsDrawGrid, groups[groupNdx].flags));
1605
1606                 parentGroup->addChild(group.release());
1607         }
1608 }
1609
1610 } // anonymous ns
1611
1612 tcu::TestCaseGroup* createSparseBufferTests (tcu::TestContext& testCtx)
1613 {
1614         return createTestGroup(testCtx, "buffer", "Sparse buffer usage tests", populateTestGroup);
1615 }
1616
1617 } // sparse
1618 } // vkt