1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
|
/* Copyright (c) 2025 The Khronos Group Inc.
* Copyright (c) 2025 Valve Corporation
* Copyright (c) 2025 LunarG, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "../framework/sync_val_tests.h"
struct NegativeSyncValWsi : public VkSyncValTest {};
// Wrap FAIL:
// * DRY for common messages
// * for test stability reasons sometimes cleanup code is required *prior* to the return hidden in FAIL
// * result_arg_ *can* (should) have side-effect, but is referenced exactly once
// * label_ must be converitble to bool, and *should* *not* have side-effects
// * "{}" or ";" are valid clean_ values for noop
#define REQUIRE_SUCCESS(result_arg_, label_) \
{ \
const VkResult result_ = (result_arg_); \
if (result_ != VK_SUCCESS) { \
{ \
m_device->Wait(); \
} \
if (bool(label_)) { \
FAIL() << string_VkResult(result_) << ": " << (label_); \
} else { \
FAIL() << string_VkResult(result_); \
} \
} \
}
TEST_F(NegativeSyncValWsi, PresentAcquire) {
TEST_DESCRIPTION("Try destroying a swapchain presentable image with vkDestroyImage");
AddSurfaceExtension();
RETURN_IF_SKIP(InitSyncValFramework());
RETURN_IF_SKIP(InitState());
RETURN_IF_SKIP(InitSwapchain());
const std::vector<VkImage> images = m_swapchain.GetImages();
std::vector<bool> image_used(images.size(), false);
vkt::Fence fence(*m_device);
// Loop through the indices until we find one we are reusing...
// When fence is non-null this can timeout so we need to track results
// Acquire can always timeout, so we need to track results
auto acquire_used_image_semaphore = [this, &image_used](const vkt::Semaphore& sem, uint32_t& index) {
VkResult result = VK_SUCCESS;
while (true) {
index = m_swapchain.AcquireNextImage(sem, kWaitTimeout, &result);
if ((result != VK_SUCCESS) || image_used[index]) break;
result = m_default_queue->Present(m_swapchain, index, sem);
if (result != VK_SUCCESS) break;
image_used[index] = true;
}
return result;
};
auto acquire_used_image_fence = [this, &image_used](const vkt::Fence& fence, uint32_t& index) {
VkResult result = VK_SUCCESS;
while (true) {
index = m_swapchain.AcquireNextImage(fence, kWaitTimeout, &result);
if ((result != VK_SUCCESS) || image_used[index]) break;
result = fence.Wait(kWaitTimeout);
fence.Reset();
m_default_queue->Present(m_swapchain, index, vkt::no_semaphore);
if (result != VK_SUCCESS) break;
image_used[index] = true;
}
return result;
};
auto write_barrier_cb = [this](const VkImage h_image, VkImageLayout from, VkImageLayout to) {
VkImageSubresourceRange full_image{VK_IMAGE_ASPECT_COLOR_BIT, 0, 1, 0, 1};
VkImageMemoryBarrier image_barrier = vku::InitStructHelper();
image_barrier.srcAccessMask = 0U;
image_barrier.dstAccessMask = 0U;
image_barrier.oldLayout = from;
image_barrier.newLayout = to;
image_barrier.image = h_image;
image_barrier.subresourceRange = full_image;
m_command_buffer.Begin();
vk::CmdPipelineBarrier(m_command_buffer, VK_PIPELINE_STAGE_TRANSFER_BIT, VK_PIPELINE_STAGE_TRANSFER_BIT, 0, 0, nullptr, 0,
nullptr, 1, &image_barrier);
m_command_buffer.End();
};
// Transition swapchain images to PRESENT_SRC layout for presentation
for (VkImage image : images) {
write_barrier_cb(image, VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PRESENT_SRC_KHR);
m_default_queue->Submit(m_command_buffer);
m_device->Wait();
m_command_buffer.Reset();
}
uint32_t acquired_index = 0;
REQUIRE_SUCCESS(acquire_used_image_fence(fence, acquired_index), "acquire_used_image");
write_barrier_cb(images[acquired_index], VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PRESENT_SRC_KHR);
// Look for errors between the acquire and first use...
// No sync operations...
m_errorMonitor->SetDesiredError("SYNC-HAZARD-WRITE-AFTER-PRESENT");
m_default_queue->Submit(m_command_buffer);
m_errorMonitor->VerifyFound();
// Sync operations that should ignore present operations
m_device->Wait();
m_errorMonitor->SetDesiredError("SYNC-HAZARD-WRITE-AFTER-PRESENT");
m_default_queue->Submit(m_command_buffer);
m_errorMonitor->VerifyFound();
// Finally we wait for the fence associated with the acquire
REQUIRE_SUCCESS(vk::WaitForFences(*m_device, 1, &fence.handle(), VK_TRUE, kWaitTimeout), "WaitForFences");
fence.Reset();
m_default_queue->Submit(m_command_buffer);
m_device->Wait();
// Release the image back to the present engine, so we don't run out
m_default_queue->Present(m_swapchain, acquired_index, vkt::no_semaphore); // present without fence can't timeout
vkt::Semaphore sem(*m_device);
REQUIRE_SUCCESS(acquire_used_image_semaphore(sem, acquired_index), "acquire_used_image");
m_command_buffer.Reset();
write_barrier_cb(images[acquired_index], VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PRESENT_SRC_KHR);
// The wait mask doesn't match the operations in the command buffer
m_errorMonitor->SetDesiredError("SYNC-HAZARD-WRITE-AFTER-READ");
m_default_queue->Submit(m_command_buffer, vkt::Wait(sem, VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT));
m_errorMonitor->VerifyFound();
// Now then wait mask matches the operations in the command buffer
m_default_queue->Submit(m_command_buffer, vkt::Wait(sem, VK_PIPELINE_STAGE_TRANSFER_BIT));
// Try presenting without waiting for the ILT to finish
m_errorMonitor->SetDesiredError("SYNC-HAZARD-PRESENT-AFTER-WRITE");
m_default_queue->Present(m_swapchain, acquired_index, vkt::no_semaphore); // present without fence can't timeout
m_errorMonitor->VerifyFound();
// Let the ILT complete, and the release the image back
m_device->Wait();
m_default_queue->Present(m_swapchain, acquired_index, vkt::no_semaphore); // present without fence can't timeout
REQUIRE_SUCCESS(acquire_used_image_fence(fence, acquired_index), "acquire_used_index");
REQUIRE_SUCCESS(fence.Wait(kWaitTimeout), "WaitForFences");
m_command_buffer.Reset();
write_barrier_cb(images[acquired_index], VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PRESENT_SRC_KHR);
fence.Reset();
m_default_queue->Submit(m_command_buffer, vkt::Signal(sem));
m_errorMonitor->SetDesiredError("SYNC-HAZARD-PRESENT-AFTER-WRITE");
m_default_queue->Present(m_swapchain, acquired_index, vkt::no_semaphore); // present without fence can't timeout
m_errorMonitor->VerifyFound();
m_default_queue->Present(m_swapchain, acquired_index, sem); // present without fence can't timeout
m_device->Wait();
}
// TODO: https://github.com/KhronosGroup/Vulkan-ValidationLayers/issues/5240
TEST_F(NegativeSyncValWsi, SubmitDoesNotWaitForAcquire) {
TEST_DESCRIPTION("Submit does not wait for the swapchain acquire semaphore");
SetTargetApiVersion(VK_API_VERSION_1_3);
AddSurfaceExtension();
AddRequiredFeature(vkt::Feature::synchronization2);
RETURN_IF_SKIP(InitSyncVal());
RETURN_IF_SKIP(InitSwapchain());
const vkt::Semaphore acquire_semaphore(*m_device);
const auto swapchain_images = m_swapchain.GetImages();
const uint32_t image_index = m_swapchain.AcquireNextImage(acquire_semaphore, kWaitTimeout);
VkImageMemoryBarrier2 layout_transition = vku::InitStructHelper();
layout_transition.srcStageMask = VK_PIPELINE_STAGE_2_NONE;
layout_transition.srcAccessMask = 0;
layout_transition.dstStageMask = VK_PIPELINE_STAGE_2_NONE;
layout_transition.dstAccessMask = 0;
layout_transition.oldLayout = VK_IMAGE_LAYOUT_UNDEFINED;
layout_transition.newLayout = VK_IMAGE_LAYOUT_PRESENT_SRC_KHR;
layout_transition.image = swapchain_images[image_index];
layout_transition.subresourceRange = {VK_IMAGE_ASPECT_COLOR_BIT, 0, 1, 0, 1};
m_command_buffer.Begin();
m_command_buffer.Barrier(layout_transition);
m_command_buffer.End();
// TODO: current implementation does not report that the image is still being read by the acquire
// and at the same time it is being transitioned (there is no wait on the acquire semaphore).
// Fix this and ensure the following submit triggers validation error.
m_default_queue->Submit2(m_command_buffer);
m_device->Wait();
}
TEST_F(NegativeSyncValWsi, PresentDoesNotWaitForSubmit2) {
TEST_DESCRIPTION("Present does not specify semaphore to wait for submit.");
SetTargetApiVersion(VK_API_VERSION_1_3);
AddSurfaceExtension();
AddRequiredFeature(vkt::Feature::synchronization2);
RETURN_IF_SKIP(InitSyncValFramework());
RETURN_IF_SKIP(InitState());
RETURN_IF_SKIP(InitSwapchain());
const vkt::Semaphore acquire_semaphore(*m_device);
const vkt::Semaphore submit_semaphore(*m_device);
const auto swapchain_images = m_swapchain.GetImages();
const uint32_t image_index = m_swapchain.AcquireNextImage(acquire_semaphore, kWaitTimeout);
VkImageMemoryBarrier2 layout_transition = vku::InitStructHelper();
layout_transition.srcStageMask = VK_PIPELINE_STAGE_2_COLOR_ATTACHMENT_OUTPUT_BIT;
layout_transition.srcAccessMask = 0;
layout_transition.dstStageMask = VK_PIPELINE_STAGE_2_COLOR_ATTACHMENT_OUTPUT_BIT;
layout_transition.dstAccessMask = 0;
layout_transition.oldLayout = VK_IMAGE_LAYOUT_UNDEFINED;
layout_transition.newLayout = VK_IMAGE_LAYOUT_PRESENT_SRC_KHR;
layout_transition.image = swapchain_images[image_index];
layout_transition.subresourceRange.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
layout_transition.subresourceRange.baseMipLevel = 0;
layout_transition.subresourceRange.levelCount = 1;
layout_transition.subresourceRange.baseArrayLayer = 0;
layout_transition.subresourceRange.layerCount = 1;
m_command_buffer.Begin();
m_command_buffer.Barrier(layout_transition);
m_command_buffer.End();
m_default_queue->Submit2(m_command_buffer, vkt::Wait(acquire_semaphore, VK_PIPELINE_STAGE_2_COLOR_ATTACHMENT_OUTPUT_BIT),
vkt::Signal(submit_semaphore, VK_PIPELINE_STAGE_2_COLOR_ATTACHMENT_OUTPUT_BIT));
// DO NOT wait for submit. This should generate present after write (ILT) harard.
m_errorMonitor->SetDesiredError("SYNC-HAZARD-PRESENT-AFTER-WRITE");
m_default_queue->Present(m_swapchain, image_index, vkt::no_semaphore);
m_errorMonitor->VerifyFound();
m_device->Wait();
}
TEST_F(NegativeSyncValWsi, PresentDoesNotWaitForSubmit) {
TEST_DESCRIPTION("Present does not specify semaphore to wait for submit.");
AddSurfaceExtension();
RETURN_IF_SKIP(InitSyncValFramework());
RETURN_IF_SKIP(InitState());
RETURN_IF_SKIP(InitSwapchain());
const vkt::Semaphore acquire_semaphore(*m_device);
const vkt::Semaphore submit_semaphore(*m_device);
const auto swapchain_images = m_swapchain.GetImages();
const uint32_t image_index = m_swapchain.AcquireNextImage(acquire_semaphore, kWaitTimeout);
VkImageMemoryBarrier layout_transition = vku::InitStructHelper();
layout_transition.srcAccessMask = 0;
layout_transition.dstAccessMask = 0;
layout_transition.oldLayout = VK_IMAGE_LAYOUT_UNDEFINED;
layout_transition.newLayout = VK_IMAGE_LAYOUT_PRESENT_SRC_KHR;
layout_transition.image = swapchain_images[image_index];
layout_transition.subresourceRange.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
layout_transition.subresourceRange.baseMipLevel = 0;
layout_transition.subresourceRange.levelCount = 1;
layout_transition.subresourceRange.baseArrayLayer = 0;
layout_transition.subresourceRange.layerCount = 1;
m_command_buffer.Begin();
vk::CmdPipelineBarrier(m_command_buffer, VK_PIPELINE_STAGE_2_COLOR_ATTACHMENT_OUTPUT_BIT,
VK_PIPELINE_STAGE_2_COLOR_ATTACHMENT_OUTPUT_BIT, 0, 0, nullptr, 0, nullptr, 1, &layout_transition);
m_command_buffer.End();
m_default_queue->Submit(m_command_buffer, vkt::Wait(acquire_semaphore, VK_PIPELINE_STAGE_2_COLOR_ATTACHMENT_OUTPUT_BIT),
vkt::Signal(submit_semaphore));
// DO NOT wait for submit. This should generate present after write (ILT) harard.
m_errorMonitor->SetDesiredError("SYNC-HAZARD-PRESENT-AFTER-WRITE");
m_default_queue->Present(m_swapchain, image_index, vkt::no_semaphore);
m_errorMonitor->VerifyFound();
m_device->Wait();
}
TEST_F(NegativeSyncValWsi, LayoutTransitionDoesNotWaitForAcquire) {
TEST_DESCRIPTION("Ensure error message does not suggest to synchronize with VK_PIPELINE_STAGE_2_NONE");
SetTargetApiVersion(VK_API_VERSION_1_3);
AddSurfaceExtension();
AddRequiredFeature(vkt::Feature::synchronization2);
RETURN_IF_SKIP(InitSyncVal());
RETURN_IF_SKIP(InitSwapchain());
const vkt::Semaphore acquire_semaphore(*m_device);
const auto swapchain_images = m_swapchain.GetImages();
const uint32_t image_index = m_swapchain.AcquireNextImage(acquire_semaphore, kWaitTimeout);
VkImageMemoryBarrier2 layout_transition = vku::InitStructHelper();
layout_transition.srcStageMask = VK_PIPELINE_STAGE_2_NONE;
layout_transition.srcAccessMask = VK_ACCESS_2_NONE;
layout_transition.dstStageMask = VK_PIPELINE_STAGE_2_COLOR_ATTACHMENT_OUTPUT_BIT;
layout_transition.dstAccessMask = VK_ACCESS_2_COLOR_ATTACHMENT_READ_BIT;
layout_transition.oldLayout = VK_IMAGE_LAYOUT_UNDEFINED;
layout_transition.newLayout = VK_IMAGE_LAYOUT_PRESENT_SRC_KHR;
layout_transition.image = swapchain_images[image_index];
layout_transition.subresourceRange = {VK_IMAGE_ASPECT_COLOR_BIT, 0, 1, 0, 1};
m_command_buffer.Begin();
m_command_buffer.Barrier(layout_transition);
m_command_buffer.End();
// NOTE: Currently c++ regex does not support well checking absense of substring.
// Instead check that new version of message is used (that we know does not have VK_PIPELINE_STAGE_2_NONE);
m_errorMonitor->SetDesiredErrorRegex("SYNC-HAZARD-WRITE-AFTER-READ",
"but layout transition does not synchronize with these stages");
m_default_queue->Submit(m_command_buffer, vkt::Wait(acquire_semaphore, VK_PIPELINE_STAGE_2_COLOR_ATTACHMENT_OUTPUT_BIT));
m_errorMonitor->VerifyFound();
m_device->Wait();
}
|
