vulkan/overlay: properly register layer object with loader
[mesa.git] / src / vulkan / overlay-layer / overlay.cpp
1 /*
2 * Copyright © 2019 Intel Corporation
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
13 * Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21 * IN THE SOFTWARE.
22 */
23
24 #include <string.h>
25 #include <stdlib.h>
26 #include <assert.h>
27
28 #include <vulkan/vulkan.h>
29 #include <vulkan/vk_layer.h>
30
31 #include "imgui.h"
32
33 #include "overlay_params.h"
34
35 #include "util/debug.h"
36 #include "util/hash_table.h"
37 #include "util/ralloc.h"
38 #include "util/os_time.h"
39 #include "util/simple_mtx.h"
40
41 #include "vk_enum_to_str.h"
42 #include "vk_util.h"
43
44 /* Mapped from VkInstace/VkPhysicalDevice */
45 struct instance_data {
46 struct vk_instance_dispatch_table vtable;
47 VkInstance instance;
48
49 struct overlay_params params;
50 };
51
52 struct frame_stat {
53 uint32_t stats[OVERLAY_PARAM_ENABLED_MAX];
54 };
55
56 /* Mapped from VkDevice/VkCommandBuffer */
57 struct queue_data;
58 struct device_data {
59 struct instance_data *instance;
60
61 PFN_vkSetDeviceLoaderData set_device_loader_data;
62
63 struct vk_device_dispatch_table vtable;
64 VkPhysicalDevice physical_device;
65 VkDevice device;
66
67 VkPhysicalDeviceProperties properties;
68
69 struct queue_data *graphic_queue;
70
71 struct queue_data **queues;
72 uint32_t n_queues;
73
74 struct frame_stat stats;
75 };
76
77 /* Mapped from VkQueue */
78 struct queue_data {
79 struct device_data *device;
80
81 VkQueue queue;
82 VkQueueFlags flags;
83 uint32_t family_index;
84 };
85
86 /* Mapped from VkSwapchainKHR */
87 struct swapchain_data {
88 struct device_data *device;
89
90 VkSwapchainKHR swapchain;
91 unsigned width, height;
92 VkFormat format;
93
94 uint32_t n_images;
95 VkImage *images;
96 VkImageView *image_views;
97 VkFramebuffer *framebuffers;
98
99 VkRenderPass render_pass;
100
101 VkDescriptorPool descriptor_pool;
102 VkDescriptorSetLayout descriptor_layout;
103 VkDescriptorSet descriptor_set;
104
105 VkSampler font_sampler;
106
107 VkPipelineLayout pipeline_layout;
108 VkPipeline pipeline;
109
110 VkCommandPool command_pool;
111
112 struct {
113 VkCommandBuffer command_buffer;
114
115 VkBuffer vertex_buffer;
116 VkDeviceMemory vertex_buffer_mem;
117 VkDeviceSize vertex_buffer_size;
118
119 VkBuffer index_buffer;
120 VkDeviceMemory index_buffer_mem;
121 VkDeviceSize index_buffer_size;
122 } frame_data[2];
123
124 bool font_uploaded;
125 VkImage font_image;
126 VkImageView font_image_view;
127 VkDeviceMemory font_mem;
128 VkBuffer upload_font_buffer;
129 VkDeviceMemory upload_font_buffer_mem;
130
131 VkFence fence;
132 VkSemaphore submission_semaphore;
133
134 /**/
135 ImGuiContext* imgui_context;
136 ImVec2 window_size;
137
138 /**/
139 uint64_t n_frames;
140 uint64_t last_present_time;
141
142 unsigned n_frames_since_update;
143 uint64_t last_fps_update;
144 double fps;
145
146 double frame_times[200];
147
148 double acquire_times[200];
149 uint64_t n_acquire;
150
151 enum overlay_param_enabled stat_selector;
152 struct frame_stat stats_min, stats_max;
153 struct frame_stat stats[200];
154 };
155
156 static struct hash_table *vk_object_to_data = NULL;
157 static simple_mtx_t vk_object_to_data_mutex = _SIMPLE_MTX_INITIALIZER_NP;
158
159 thread_local ImGuiContext* __MesaImGui;
160
161 static inline void ensure_vk_object_map(void)
162 {
163 if (!vk_object_to_data) {
164 vk_object_to_data = _mesa_hash_table_create(NULL,
165 _mesa_hash_pointer,
166 _mesa_key_pointer_equal);
167 }
168 }
169
170 #define FIND_SWAPCHAIN_DATA(obj) ((struct swapchain_data *)find_object_data((void *) obj))
171 #define FIND_DEVICE_DATA(obj) ((struct device_data *)find_object_data((void *) obj))
172 #define FIND_QUEUE_DATA(obj) ((struct queue_data *)find_object_data((void *) obj))
173 #define FIND_PHYSICAL_DEVICE_DATA(obj) ((struct instance_data *)find_object_data((void *) obj))
174 #define FIND_INSTANCE_DATA(obj) ((struct instance_data *)find_object_data((void *) obj))
175 static void *find_object_data(void *obj)
176 {
177 simple_mtx_lock(&vk_object_to_data_mutex);
178 ensure_vk_object_map();
179 struct hash_entry *entry = _mesa_hash_table_search(vk_object_to_data, obj);
180 void *data = entry ? entry->data : NULL;
181 simple_mtx_unlock(&vk_object_to_data_mutex);
182 return data;
183 }
184
185 static void map_object(void *obj, void *data)
186 {
187 simple_mtx_lock(&vk_object_to_data_mutex);
188 ensure_vk_object_map();
189 _mesa_hash_table_insert(vk_object_to_data, obj, data);
190 simple_mtx_unlock(&vk_object_to_data_mutex);
191 }
192
193 static void unmap_object(void *obj)
194 {
195 simple_mtx_lock(&vk_object_to_data_mutex);
196 struct hash_entry *entry = _mesa_hash_table_search(vk_object_to_data, obj);
197 _mesa_hash_table_remove(vk_object_to_data, entry);
198 simple_mtx_unlock(&vk_object_to_data_mutex);
199 }
200
201 /**/
202
203 static void check_vk_result(VkResult err)
204 {
205 if (err != VK_SUCCESS)
206 printf("ERROR!\n");
207 }
208
209 /**/
210
211 static VkLayerInstanceCreateInfo *get_instance_chain_info(const VkInstanceCreateInfo *pCreateInfo,
212 VkLayerFunction func)
213 {
214 vk_foreach_struct(item, pCreateInfo->pNext) {
215 if (item->sType == VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO &&
216 ((VkLayerInstanceCreateInfo *) item)->function == func)
217 return (VkLayerInstanceCreateInfo *) item;
218 }
219 unreachable("instance chain info not found");
220 return NULL;
221 }
222
223 static VkLayerDeviceCreateInfo *get_device_chain_info(const VkDeviceCreateInfo *pCreateInfo,
224 VkLayerFunction func)
225 {
226 vk_foreach_struct(item, pCreateInfo->pNext) {
227 if (item->sType == VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO &&
228 ((VkLayerDeviceCreateInfo *) item)->function == func)
229 return (VkLayerDeviceCreateInfo *)item;
230 }
231 unreachable("device chain info not found");
232 return NULL;
233 }
234
235 /**/
236
237 static struct instance_data *new_instance_data(VkInstance instance)
238 {
239 struct instance_data *data = rzalloc(NULL, struct instance_data);
240 data->instance = instance;
241 map_object(data->instance, data);
242 return data;
243 }
244
245 static void destroy_instance_data(struct instance_data *data)
246 {
247 if (data->params.output_file)
248 fclose(data->params.output_file);
249 unmap_object(data->instance);
250 ralloc_free(data);
251 }
252
253 static void instance_data_map_physical_devices(struct instance_data *instance_data,
254 bool map)
255 {
256 uint32_t physicalDeviceCount = 0;
257 instance_data->vtable.EnumeratePhysicalDevices(instance_data->instance,
258 &physicalDeviceCount,
259 NULL);
260
261 VkPhysicalDevice *physicalDevices = (VkPhysicalDevice *) malloc(sizeof(VkPhysicalDevice) * physicalDeviceCount);
262 instance_data->vtable.EnumeratePhysicalDevices(instance_data->instance,
263 &physicalDeviceCount,
264 physicalDevices);
265
266 for (uint32_t i = 0; i < physicalDeviceCount; i++) {
267 if (map)
268 map_object(physicalDevices[i], instance_data);
269 else
270 unmap_object(physicalDevices[i]);
271 }
272
273 free(physicalDevices);
274 }
275
276 /**/
277 static struct device_data *new_device_data(VkDevice device, struct instance_data *instance)
278 {
279 struct device_data *data = rzalloc(NULL, struct device_data);
280 data->instance = instance;
281 data->device = device;
282 map_object(data->device, data);
283 return data;
284 }
285
286 static struct queue_data *new_queue_data(VkQueue queue,
287 const VkQueueFamilyProperties *family_props,
288 uint32_t family_index,
289 struct device_data *device_data)
290 {
291 struct queue_data *data = rzalloc(device_data, struct queue_data);
292 data->device = device_data;
293 data->queue = queue;
294 data->flags = family_props->queueFlags;
295 data->family_index = family_index;
296 map_object(data->queue, data);
297
298 if (data->flags & VK_QUEUE_GRAPHICS_BIT)
299 device_data->graphic_queue = data;
300
301 return data;
302 }
303
304 static void device_map_queues(struct device_data *data,
305 const VkDeviceCreateInfo *pCreateInfo)
306 {
307 for (uint32_t i = 0; i < pCreateInfo->queueCreateInfoCount; i++)
308 data->n_queues += pCreateInfo->pQueueCreateInfos[i].queueCount;
309 data->queues = ralloc_array(data, struct queue_data *, data->n_queues);
310
311 struct instance_data *instance_data = data->instance;
312 uint32_t n_family_props;
313 instance_data->vtable.GetPhysicalDeviceQueueFamilyProperties(data->physical_device,
314 &n_family_props,
315 NULL);
316 VkQueueFamilyProperties *family_props =
317 (VkQueueFamilyProperties *)malloc(sizeof(VkQueueFamilyProperties) * n_family_props);
318 instance_data->vtable.GetPhysicalDeviceQueueFamilyProperties(data->physical_device,
319 &n_family_props,
320 family_props);
321
322 uint32_t queue_index = 0;
323 for (uint32_t i = 0; i < pCreateInfo->queueCreateInfoCount; i++) {
324 for (uint32_t j = 0; j < pCreateInfo->pQueueCreateInfos[i].queueCount; j++) {
325 VkQueue queue;
326 data->vtable.GetDeviceQueue(data->device,
327 pCreateInfo->pQueueCreateInfos[i].queueFamilyIndex,
328 j, &queue);
329
330 VkResult err = data->set_device_loader_data(data->device, queue);
331 check_vk_result(err);
332
333 data->queues[queue_index++] =
334 new_queue_data(queue, &family_props[pCreateInfo->pQueueCreateInfos[i].queueFamilyIndex],
335 pCreateInfo->pQueueCreateInfos[i].queueFamilyIndex, data);
336 }
337 }
338
339 free(family_props);
340 }
341
342 static void device_unmap_queues(struct device_data *data)
343 {
344 for (uint32_t i = 0; i < data->n_queues; i++)
345 unmap_object(data->queues[i]->queue);
346 }
347
348 static void destroy_device_data(struct device_data *data)
349 {
350 unmap_object(data->device);
351 ralloc_free(data);
352 }
353
354 /**/
355 static struct swapchain_data *new_swapchain_data(VkSwapchainKHR swapchain,
356 struct device_data *device_data)
357 {
358 struct swapchain_data *data = rzalloc(NULL, struct swapchain_data);
359 data->device = device_data;
360 data->swapchain = swapchain;
361 data->window_size = ImVec2(300, 300);
362 map_object((void *) data->swapchain, data);
363 return data;
364 }
365
366 static void destroy_swapchain_data(struct swapchain_data *data)
367 {
368 unmap_object((void *) data->swapchain);
369 ralloc_free(data);
370 }
371
372 static void snapshot_swapchain_frame(struct swapchain_data *data)
373 {
374 struct instance_data *instance_data = data->device->instance;
375 uint64_t now = os_time_get(); /* us */
376
377 if (data->last_present_time) {
378 data->frame_times[(data->n_frames - 1) % ARRAY_SIZE(data->frame_times)] =
379 ((double)now - (double)data->last_present_time) / 1000.0;
380 }
381
382 if (data->last_fps_update) {
383 double elapsed = (double)(now - data->last_fps_update); /* us */
384 if (elapsed >= instance_data->params.fps_sampling_period) {
385 data->fps = 1000000.0f * data->n_frames_since_update / elapsed;
386 data->n_frames_since_update = 0;
387 data->last_fps_update = now;
388 if (instance_data->params.output_file) {
389 fprintf(instance_data->params.output_file, "%.2f\n", data->fps);
390 fflush(instance_data->params.output_file);
391 }
392 }
393 } else {
394 data->last_fps_update = now;
395 }
396
397 struct device_data *device_data = data->device;
398 data->stats[data->n_frames % ARRAY_SIZE(data->frame_times)] = device_data->stats;
399 memset(&device_data->stats, 0, sizeof(device_data->stats));
400
401 data->last_present_time = now;
402 data->n_frames++;
403 data->n_frames_since_update++;
404 }
405
406 static float get_frame_timing(void *_data, int _idx)
407 {
408 struct swapchain_data *data = (struct swapchain_data *) _data;
409 if ((ARRAY_SIZE(data->frame_times) - _idx) > (data->n_frames - 2))
410 return 0.0f;
411 int idx = ARRAY_SIZE(data->frame_times) +
412 (data->n_frames - 2) < ARRAY_SIZE(data->frame_times) ?
413 _idx - (data->n_frames - 2) :
414 _idx + (data->n_frames - 2);
415 idx %= ARRAY_SIZE(data->frame_times);
416 return data->frame_times[idx];
417 }
418
419 static float get_acquire_timing(void *_data, int _idx)
420 {
421 struct swapchain_data *data = (struct swapchain_data *) _data;
422 if ((ARRAY_SIZE(data->acquire_times) - _idx) > data->n_acquire)
423 return 0.0f;
424 int idx = ARRAY_SIZE(data->acquire_times) +
425 data->n_acquire < ARRAY_SIZE(data->acquire_times) ?
426 _idx - data->n_acquire :
427 _idx + data->n_acquire;
428 idx %= ARRAY_SIZE(data->acquire_times);
429 return data->acquire_times[idx];
430 }
431
432 static float get_stat(void *_data, int _idx)
433 {
434 struct swapchain_data *data = (struct swapchain_data *) _data;
435 if ((ARRAY_SIZE(data->stats) - _idx) > data->n_frames)
436 return 0.0f;
437 int idx = ARRAY_SIZE(data->stats) +
438 data->n_frames < ARRAY_SIZE(data->stats) ?
439 _idx - data->n_frames :
440 _idx + data->n_frames;
441 idx %= ARRAY_SIZE(data->stats);
442 return data->stats[idx].stats[data->stat_selector];
443 }
444
445 static void position_layer(struct swapchain_data *data)
446
447 {
448 struct device_data *device_data = data->device;
449 struct instance_data *instance_data = device_data->instance;
450
451 ImGui::SetNextWindowBgAlpha(0.5);
452 ImGui::SetNextWindowSize(data->window_size, ImGuiCond_Always);
453 switch (instance_data->params.position) {
454 case LAYER_POSITION_TOP_LEFT:
455 ImGui::SetNextWindowPos(ImVec2(0, 0), ImGuiCond_Always);
456 break;
457 case LAYER_POSITION_TOP_RIGHT:
458 ImGui::SetNextWindowPos(ImVec2(data->width - data->window_size.x, 0),
459 ImGuiCond_Always);
460 break;
461 case LAYER_POSITION_BOTTOM_LEFT:
462 ImGui::SetNextWindowPos(ImVec2(0, data->height - data->window_size.y),
463 ImGuiCond_Always);
464 break;
465 case LAYER_POSITION_BOTTOM_RIGHT:
466 ImGui::SetNextWindowPos(ImVec2(data->width - data->window_size.x,
467 data->height - data->window_size.y),
468 ImGuiCond_Always);
469 break;
470 }
471 }
472
473 static void compute_swapchain_display(struct swapchain_data *data)
474 {
475 struct device_data *device_data = data->device;
476 struct instance_data *instance_data = device_data->instance;
477
478 ImGui::SetCurrentContext(data->imgui_context);
479 ImGui::NewFrame();
480 position_layer(data);
481 ImGui::Begin("Mesa overlay");
482 ImGui::Text("Device: %s", device_data->properties.deviceName);
483
484 const char *format_name = vk_Format_to_str(data->format);
485 format_name = format_name ? (format_name + strlen("VK_FORMAT_")) : "unknown";
486 ImGui::Text("Swapchain format: %s", format_name);
487 ImGui::Text("Frames: %" PRIu64, data->n_frames);
488 if (instance_data->params.enabled[OVERLAY_PARAM_ENABLED_fps])
489 ImGui::Text("FPS: %.2f" , data->fps);
490
491 if (instance_data->params.enabled[OVERLAY_PARAM_ENABLED_frame_timing]){
492 double min_time = FLT_MAX, max_time = 0.0f;
493 for (uint32_t i = 0; i < MIN2(data->n_frames - 2, ARRAY_SIZE(data->frame_times)); i++) {
494 min_time = MIN2(min_time, data->frame_times[i]);
495 max_time = MAX2(max_time, data->frame_times[i]);
496 }
497 ImGui::PlotHistogram("##Frame timings", get_frame_timing, data,
498 ARRAY_SIZE(data->frame_times), 0,
499 NULL, min_time, max_time,
500 ImVec2(ImGui::GetContentRegionAvailWidth(), 30));
501 ImGui::Text("Frame timing: %.3fms [%.3f, %.3f]",
502 get_frame_timing(data, ARRAY_SIZE(data->frame_times) - 1),
503 min_time, max_time);
504 }
505
506 if (instance_data->params.enabled[OVERLAY_PARAM_ENABLED_acquire_timing]) {
507 double min_time = FLT_MAX, max_time = 0.0f;
508 for (uint32_t i = 0; i < MIN2(data->n_acquire - 2, ARRAY_SIZE(data->acquire_times)); i++) {
509 min_time = MIN2(min_time, data->acquire_times[i]);
510 max_time = MAX2(max_time, data->acquire_times[i]);
511 }
512 ImGui::PlotHistogram("##Acquire timings", get_acquire_timing, data,
513 ARRAY_SIZE(data->acquire_times), 0,
514 NULL, min_time, max_time,
515 ImVec2(ImGui::GetContentRegionAvailWidth(), 30));
516 ImGui::Text("Acquire timing: %.3fms [%.3f, %.3f]",
517 get_acquire_timing(data, ARRAY_SIZE(data->acquire_times) - 1),
518 min_time, max_time);
519 }
520
521 for (uint32_t i = 0; i < ARRAY_SIZE(data->stats_min.stats); i++) {
522 data->stats_min.stats[i] = UINT32_MAX;
523 data->stats_max.stats[i] = 0;
524 }
525 for (uint32_t i = 0; i < MIN2(data->n_frames - 1, ARRAY_SIZE(data->stats)); i++) {
526 for (uint32_t j = 0; j < ARRAY_SIZE(data->stats[0].stats); j++) {
527 data->stats_min.stats[j] = MIN2(data->stats[i].stats[j],
528 data->stats_min.stats[j]);
529 data->stats_max.stats[j] = MAX2(data->stats[i].stats[j],
530 data->stats_max.stats[j]);
531 }
532 }
533
534 for (uint32_t i = 0; i < ARRAY_SIZE(device_data->stats.stats); i++) {
535 if (!instance_data->params.enabled[i] ||
536 i == OVERLAY_PARAM_ENABLED_fps ||
537 i == OVERLAY_PARAM_ENABLED_frame_timing ||
538 i == OVERLAY_PARAM_ENABLED_acquire_timing)
539 continue;
540
541 char hash[40];
542 snprintf(hash, sizeof(hash), "##%s", overlay_param_names[i]);
543 data->stat_selector = (enum overlay_param_enabled) i;
544
545 ImGui::PlotHistogram(hash, get_stat, data,
546 ARRAY_SIZE(data->stats), 0,
547 NULL,
548 data->stats_min.stats[i],
549 data->stats_max.stats[i],
550 ImVec2(ImGui::GetContentRegionAvailWidth(), 30));
551 ImGui::Text("%s: %.0f [%u, %u]", overlay_param_names[i],
552 get_stat(data, ARRAY_SIZE(data->stats) - 1),
553 data->stats_min.stats[i], data->stats_max.stats[i]);
554 }
555 data->window_size = ImVec2(data->window_size.x, ImGui::GetCursorPosY() + 10.0f);
556 ImGui::End();
557 ImGui::EndFrame();
558 ImGui::Render();
559 }
560
561 static uint32_t vk_memory_type(struct device_data *data,
562 VkMemoryPropertyFlags properties,
563 uint32_t type_bits)
564 {
565 VkPhysicalDeviceMemoryProperties prop;
566 data->instance->vtable.GetPhysicalDeviceMemoryProperties(data->physical_device, &prop);
567 for (uint32_t i = 0; i < prop.memoryTypeCount; i++)
568 if ((prop.memoryTypes[i].propertyFlags & properties) == properties && type_bits & (1<<i))
569 return i;
570 return 0xFFFFFFFF; // Unable to find memoryType
571 }
572
573 static void ensure_swapchain_fonts(struct swapchain_data *data,
574 VkCommandBuffer command_buffer)
575 {
576 if (data->font_uploaded)
577 return;
578
579 data->font_uploaded = true;
580
581 struct device_data *device_data = data->device;
582 VkResult err;
583 ImGuiIO& io = ImGui::GetIO();
584 unsigned char* pixels;
585 int width, height;
586 io.Fonts->GetTexDataAsRGBA32(&pixels, &width, &height);
587 size_t upload_size = width * height * 4 * sizeof(char);
588
589 /* Upload buffer */
590 VkBufferCreateInfo buffer_info = {};
591 buffer_info.sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO;
592 buffer_info.size = upload_size;
593 buffer_info.usage = VK_BUFFER_USAGE_TRANSFER_SRC_BIT;
594 buffer_info.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
595 err = device_data->vtable.CreateBuffer(device_data->device, &buffer_info,
596 NULL, &data->upload_font_buffer);
597 check_vk_result(err);
598 VkMemoryRequirements upload_buffer_req;
599 device_data->vtable.GetBufferMemoryRequirements(device_data->device,
600 data->upload_font_buffer,
601 &upload_buffer_req);
602 VkMemoryAllocateInfo upload_alloc_info = {};
603 upload_alloc_info.sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO;
604 upload_alloc_info.allocationSize = upload_buffer_req.size;
605 upload_alloc_info.memoryTypeIndex = vk_memory_type(device_data,
606 VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT,
607 upload_buffer_req.memoryTypeBits);
608 err = device_data->vtable.AllocateMemory(device_data->device,
609 &upload_alloc_info,
610 NULL,
611 &data->upload_font_buffer_mem);
612 check_vk_result(err);
613 err = device_data->vtable.BindBufferMemory(device_data->device,
614 data->upload_font_buffer,
615 data->upload_font_buffer_mem, 0);
616 check_vk_result(err);
617
618 /* Upload to Buffer */
619 char* map = NULL;
620 err = device_data->vtable.MapMemory(device_data->device,
621 data->upload_font_buffer_mem,
622 0, upload_size, 0, (void**)(&map));
623 check_vk_result(err);
624 memcpy(map, pixels, upload_size);
625 VkMappedMemoryRange range[1] = {};
626 range[0].sType = VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE;
627 range[0].memory = data->upload_font_buffer_mem;
628 range[0].size = upload_size;
629 err = device_data->vtable.FlushMappedMemoryRanges(device_data->device, 1, range);
630 check_vk_result(err);
631 device_data->vtable.UnmapMemory(device_data->device,
632 data->upload_font_buffer_mem);
633
634 /* Copy buffer to image */
635 VkImageMemoryBarrier copy_barrier[1] = {};
636 copy_barrier[0].sType = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER;
637 copy_barrier[0].dstAccessMask = VK_ACCESS_TRANSFER_WRITE_BIT;
638 copy_barrier[0].oldLayout = VK_IMAGE_LAYOUT_UNDEFINED;
639 copy_barrier[0].newLayout = VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL;
640 copy_barrier[0].srcQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
641 copy_barrier[0].dstQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
642 copy_barrier[0].image = data->font_image;
643 copy_barrier[0].subresourceRange.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
644 copy_barrier[0].subresourceRange.levelCount = 1;
645 copy_barrier[0].subresourceRange.layerCount = 1;
646 device_data->vtable.CmdPipelineBarrier(command_buffer,
647 VK_PIPELINE_STAGE_HOST_BIT,
648 VK_PIPELINE_STAGE_TRANSFER_BIT,
649 0, 0, NULL, 0, NULL,
650 1, copy_barrier);
651
652 VkBufferImageCopy region = {};
653 region.imageSubresource.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
654 region.imageSubresource.layerCount = 1;
655 region.imageExtent.width = width;
656 region.imageExtent.height = height;
657 region.imageExtent.depth = 1;
658 device_data->vtable.CmdCopyBufferToImage(command_buffer,
659 data->upload_font_buffer,
660 data->font_image,
661 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL,
662 1, &region);
663
664 VkImageMemoryBarrier use_barrier[1] = {};
665 use_barrier[0].sType = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER;
666 use_barrier[0].srcAccessMask = VK_ACCESS_TRANSFER_WRITE_BIT;
667 use_barrier[0].dstAccessMask = VK_ACCESS_SHADER_READ_BIT;
668 use_barrier[0].oldLayout = VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL;
669 use_barrier[0].newLayout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
670 use_barrier[0].srcQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
671 use_barrier[0].dstQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
672 use_barrier[0].image = data->font_image;
673 use_barrier[0].subresourceRange.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
674 use_barrier[0].subresourceRange.levelCount = 1;
675 use_barrier[0].subresourceRange.layerCount = 1;
676 device_data->vtable.CmdPipelineBarrier(command_buffer,
677 VK_PIPELINE_STAGE_TRANSFER_BIT,
678 VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT,
679 0,
680 0, NULL,
681 0, NULL,
682 1, use_barrier);
683
684 /* Store our identifier */
685 io.Fonts->TexID = (ImTextureID)(intptr_t)data->font_image;
686 }
687
688 static void CreateOrResizeBuffer(struct device_data *data,
689 VkBuffer *buffer,
690 VkDeviceMemory *buffer_memory,
691 VkDeviceSize *buffer_size,
692 size_t new_size, VkBufferUsageFlagBits usage)
693 {
694 VkResult err;
695 if (*buffer != VK_NULL_HANDLE)
696 data->vtable.DestroyBuffer(data->device, *buffer, NULL);
697 if (*buffer_memory)
698 data->vtable.FreeMemory(data->device, *buffer_memory, NULL);
699
700 VkBufferCreateInfo buffer_info = {};
701 buffer_info.sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO;
702 buffer_info.size = new_size;
703 buffer_info.usage = usage;
704 buffer_info.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
705 err = data->vtable.CreateBuffer(data->device, &buffer_info, NULL, buffer);
706 check_vk_result(err);
707
708 VkMemoryRequirements req;
709 data->vtable.GetBufferMemoryRequirements(data->device, *buffer, &req);
710 VkMemoryAllocateInfo alloc_info = {};
711 alloc_info.sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO;
712 alloc_info.allocationSize = req.size;
713 alloc_info.memoryTypeIndex =
714 vk_memory_type(data, VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT, req.memoryTypeBits);
715 err = data->vtable.AllocateMemory(data->device, &alloc_info, NULL, buffer_memory);
716 check_vk_result(err);
717
718 err = data->vtable.BindBufferMemory(data->device, *buffer, *buffer_memory, 0);
719 check_vk_result(err);
720 *buffer_size = new_size;
721 }
722
723 static void render_swapchain_display(struct swapchain_data *data, unsigned image_index)
724 {
725 ImDrawData* draw_data = ImGui::GetDrawData();
726 if (draw_data->TotalVtxCount == 0)
727 return;
728
729 struct device_data *device_data = data->device;
730 uint32_t idx = data->n_frames % ARRAY_SIZE(data->frame_data);
731 VkCommandBuffer command_buffer = data->frame_data[idx].command_buffer;
732 VkResult err;
733
734 device_data->vtable.ResetCommandBuffer(command_buffer, 0);
735
736 VkRenderPassBeginInfo render_pass_info = {};
737 render_pass_info.sType = VK_STRUCTURE_TYPE_RENDER_PASS_BEGIN_INFO;
738 render_pass_info.renderPass = data->render_pass;
739 render_pass_info.framebuffer = data->framebuffers[image_index];
740 render_pass_info.renderArea.extent.width = data->width;
741 render_pass_info.renderArea.extent.height = data->height;
742
743 VkCommandBufferBeginInfo buffer_begin_info = {};
744 buffer_begin_info.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO;
745
746 device_data->vtable.BeginCommandBuffer(command_buffer, &buffer_begin_info);
747
748 ensure_swapchain_fonts(data, command_buffer);
749
750 /* Bounce the image to display back to color attachment layout for
751 * rendering on top of it.
752 */
753 VkImageMemoryBarrier imb;
754 imb.sType = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER;
755 imb.pNext = nullptr;
756 imb.dstAccessMask = VK_ACCESS_MEMORY_READ_BIT;
757 imb.srcAccessMask = VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT;
758 imb.oldLayout = VK_IMAGE_LAYOUT_PRESENT_SRC_KHR;
759 imb.newLayout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL;
760 imb.image = data->images[image_index];
761 imb.subresourceRange.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
762 imb.subresourceRange.baseMipLevel = 0;
763 imb.subresourceRange.levelCount = 1;
764 imb.subresourceRange.baseArrayLayer = 0;
765 imb.subresourceRange.layerCount = 1;
766 imb.srcQueueFamilyIndex = device_data->graphic_queue->family_index;
767 imb.dstQueueFamilyIndex = device_data->graphic_queue->family_index;
768 device_data->vtable.CmdPipelineBarrier(command_buffer,
769 VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT,
770 VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT,
771 0, /* dependency flags */
772 0, nullptr, /* memory barriers */
773 0, nullptr, /* buffer memory barriers */
774 1, &imb); /* image memory barriers */
775
776 device_data->vtable.CmdBeginRenderPass(command_buffer, &render_pass_info,
777 VK_SUBPASS_CONTENTS_INLINE);
778
779 /* Create/Resize vertex & index buffers */
780 size_t vertex_size = draw_data->TotalVtxCount * sizeof(ImDrawVert);
781 size_t index_size = draw_data->TotalIdxCount * sizeof(ImDrawIdx);
782 if (data->frame_data[idx].vertex_buffer_size < vertex_size) {
783 CreateOrResizeBuffer(device_data,
784 &data->frame_data[idx].vertex_buffer,
785 &data->frame_data[idx].vertex_buffer_mem,
786 &data->frame_data[idx].vertex_buffer_size,
787 vertex_size, VK_BUFFER_USAGE_VERTEX_BUFFER_BIT);
788 }
789 if (data->frame_data[idx].index_buffer_size < index_size) {
790 CreateOrResizeBuffer(device_data,
791 &data->frame_data[idx].index_buffer,
792 &data->frame_data[idx].index_buffer_mem,
793 &data->frame_data[idx].index_buffer_size,
794 index_size, VK_BUFFER_USAGE_INDEX_BUFFER_BIT);
795 }
796
797 /* Upload vertex & index data */
798 VkBuffer vertex_buffer = data->frame_data[idx].vertex_buffer;
799 VkDeviceMemory vertex_mem = data->frame_data[idx].vertex_buffer_mem;
800 VkBuffer index_buffer = data->frame_data[idx].index_buffer;
801 VkDeviceMemory index_mem = data->frame_data[idx].index_buffer_mem;
802 ImDrawVert* vtx_dst = NULL;
803 ImDrawIdx* idx_dst = NULL;
804 err = device_data->vtable.MapMemory(device_data->device, vertex_mem,
805 0, vertex_size, 0, (void**)(&vtx_dst));
806 check_vk_result(err);
807 err = device_data->vtable.MapMemory(device_data->device, index_mem,
808 0, index_size, 0, (void**)(&idx_dst));
809 check_vk_result(err);
810 for (int n = 0; n < draw_data->CmdListsCount; n++)
811 {
812 const ImDrawList* cmd_list = draw_data->CmdLists[n];
813 memcpy(vtx_dst, cmd_list->VtxBuffer.Data, cmd_list->VtxBuffer.Size * sizeof(ImDrawVert));
814 memcpy(idx_dst, cmd_list->IdxBuffer.Data, cmd_list->IdxBuffer.Size * sizeof(ImDrawIdx));
815 vtx_dst += cmd_list->VtxBuffer.Size;
816 idx_dst += cmd_list->IdxBuffer.Size;
817 }
818 VkMappedMemoryRange range[2] = {};
819 range[0].sType = VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE;
820 range[0].memory = vertex_mem;
821 range[0].size = VK_WHOLE_SIZE;
822 range[1].sType = VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE;
823 range[1].memory = index_mem;
824 range[1].size = VK_WHOLE_SIZE;
825 err = device_data->vtable.FlushMappedMemoryRanges(device_data->device, 2, range);
826 check_vk_result(err);
827 device_data->vtable.UnmapMemory(device_data->device, vertex_mem);
828 device_data->vtable.UnmapMemory(device_data->device, index_mem);
829
830 /* Bind pipeline and descriptor sets */
831 device_data->vtable.CmdBindPipeline(command_buffer, VK_PIPELINE_BIND_POINT_GRAPHICS, data->pipeline);
832 VkDescriptorSet desc_set[1] = { data->descriptor_set };
833 device_data->vtable.CmdBindDescriptorSets(command_buffer, VK_PIPELINE_BIND_POINT_GRAPHICS,
834 data->pipeline_layout, 0, 1, desc_set, 0, NULL);
835
836 /* Bind vertex & index buffers */
837 VkBuffer vertex_buffers[1] = { vertex_buffer };
838 VkDeviceSize vertex_offset[1] = { 0 };
839 device_data->vtable.CmdBindVertexBuffers(command_buffer, 0, 1, vertex_buffers, vertex_offset);
840 device_data->vtable.CmdBindIndexBuffer(command_buffer, index_buffer, 0, VK_INDEX_TYPE_UINT16);
841
842 /* Setup viewport */
843 VkViewport viewport;
844 viewport.x = 0;
845 viewport.y = 0;
846 viewport.width = draw_data->DisplaySize.x;
847 viewport.height = draw_data->DisplaySize.y;
848 viewport.minDepth = 0.0f;
849 viewport.maxDepth = 1.0f;
850 device_data->vtable.CmdSetViewport(command_buffer, 0, 1, &viewport);
851
852
853 /* Setup scale and translation through push constants :
854 *
855 * Our visible imgui space lies from draw_data->DisplayPos (top left) to
856 * draw_data->DisplayPos+data_data->DisplaySize (bottom right). DisplayMin
857 * is typically (0,0) for single viewport apps.
858 */
859 float scale[2];
860 scale[0] = 2.0f / draw_data->DisplaySize.x;
861 scale[1] = 2.0f / draw_data->DisplaySize.y;
862 float translate[2];
863 translate[0] = -1.0f - draw_data->DisplayPos.x * scale[0];
864 translate[1] = -1.0f - draw_data->DisplayPos.y * scale[1];
865 device_data->vtable.CmdPushConstants(command_buffer, data->pipeline_layout,
866 VK_SHADER_STAGE_VERTEX_BIT,
867 sizeof(float) * 0, sizeof(float) * 2, scale);
868 device_data->vtable.CmdPushConstants(command_buffer, data->pipeline_layout,
869 VK_SHADER_STAGE_VERTEX_BIT,
870 sizeof(float) * 2, sizeof(float) * 2, translate);
871
872 // Render the command lists:
873 int vtx_offset = 0;
874 int idx_offset = 0;
875 ImVec2 display_pos = draw_data->DisplayPos;
876 for (int n = 0; n < draw_data->CmdListsCount; n++)
877 {
878 const ImDrawList* cmd_list = draw_data->CmdLists[n];
879 for (int cmd_i = 0; cmd_i < cmd_list->CmdBuffer.Size; cmd_i++)
880 {
881 const ImDrawCmd* pcmd = &cmd_list->CmdBuffer[cmd_i];
882 // Apply scissor/clipping rectangle
883 // FIXME: We could clamp width/height based on clamped min/max values.
884 VkRect2D scissor;
885 scissor.offset.x = (int32_t)(pcmd->ClipRect.x - display_pos.x) > 0 ? (int32_t)(pcmd->ClipRect.x - display_pos.x) : 0;
886 scissor.offset.y = (int32_t)(pcmd->ClipRect.y - display_pos.y) > 0 ? (int32_t)(pcmd->ClipRect.y - display_pos.y) : 0;
887 scissor.extent.width = (uint32_t)(pcmd->ClipRect.z - pcmd->ClipRect.x);
888 scissor.extent.height = (uint32_t)(pcmd->ClipRect.w - pcmd->ClipRect.y + 1); // FIXME: Why +1 here?
889 device_data->vtable.CmdSetScissor(command_buffer, 0, 1, &scissor);
890
891 // Draw
892 device_data->vtable.CmdDrawIndexed(command_buffer, pcmd->ElemCount, 1, idx_offset, vtx_offset, 0);
893
894 idx_offset += pcmd->ElemCount;
895 }
896 vtx_offset += cmd_list->VtxBuffer.Size;
897 }
898
899 device_data->vtable.CmdEndRenderPass(command_buffer);
900 device_data->vtable.EndCommandBuffer(command_buffer);
901
902 if (data->submission_semaphore) {
903 device_data->vtable.DestroySemaphore(device_data->device,
904 data->submission_semaphore,
905 NULL);
906 }
907 /* Submission semaphore */
908 VkSemaphoreCreateInfo semaphore_info = {};
909 semaphore_info.sType = VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO;
910 err = device_data->vtable.CreateSemaphore(device_data->device, &semaphore_info,
911 NULL, &data->submission_semaphore);
912 check_vk_result(err);
913
914 VkSubmitInfo submit_info = {};
915 submit_info.sType = VK_STRUCTURE_TYPE_SUBMIT_INFO;
916 submit_info.commandBufferCount = 1;
917 submit_info.pCommandBuffers = &command_buffer;
918 submit_info.signalSemaphoreCount = 1;
919 submit_info.pSignalSemaphores = &data->submission_semaphore;
920
921 device_data->vtable.WaitForFences(device_data->device, 1, &data->fence, VK_TRUE, UINT64_MAX);
922 device_data->vtable.ResetFences(device_data->device, 1, &data->fence);
923 device_data->vtable.QueueSubmit(device_data->graphic_queue->queue, 1, &submit_info, data->fence);
924 }
925
926 static const uint32_t overlay_vert_spv[] = {
927 #include "overlay.vert.spv.h"
928 };
929 static const uint32_t overlay_frag_spv[] = {
930 #include "overlay.frag.spv.h"
931 };
932
933 static void setup_swapchain_data_pipeline(struct swapchain_data *data)
934 {
935 struct device_data *device_data = data->device;
936 VkShaderModule vert_module, frag_module;
937 VkResult err;
938
939 /* Create shader modules */
940 VkShaderModuleCreateInfo vert_info = {};
941 vert_info.sType = VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO;
942 vert_info.codeSize = sizeof(overlay_vert_spv);
943 vert_info.pCode = overlay_vert_spv;
944 err = device_data->vtable.CreateShaderModule(device_data->device,
945 &vert_info, NULL, &vert_module);
946 check_vk_result(err);
947 VkShaderModuleCreateInfo frag_info = {};
948 frag_info.sType = VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO;
949 frag_info.codeSize = sizeof(overlay_frag_spv);
950 frag_info.pCode = (uint32_t*)overlay_frag_spv;
951 err = device_data->vtable.CreateShaderModule(device_data->device,
952 &frag_info, NULL, &frag_module);
953 check_vk_result(err);
954
955 /* Font sampler */
956 VkSamplerCreateInfo sampler_info = {};
957 sampler_info.sType = VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO;
958 sampler_info.magFilter = VK_FILTER_LINEAR;
959 sampler_info.minFilter = VK_FILTER_LINEAR;
960 sampler_info.mipmapMode = VK_SAMPLER_MIPMAP_MODE_LINEAR;
961 sampler_info.addressModeU = VK_SAMPLER_ADDRESS_MODE_REPEAT;
962 sampler_info.addressModeV = VK_SAMPLER_ADDRESS_MODE_REPEAT;
963 sampler_info.addressModeW = VK_SAMPLER_ADDRESS_MODE_REPEAT;
964 sampler_info.minLod = -1000;
965 sampler_info.maxLod = 1000;
966 sampler_info.maxAnisotropy = 1.0f;
967 err = device_data->vtable.CreateSampler(device_data->device, &sampler_info,
968 NULL, &data->font_sampler);
969 check_vk_result(err);
970
971 /* Descriptor pool */
972 VkDescriptorPoolSize sampler_pool_size = {};
973 sampler_pool_size.type = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER;
974 sampler_pool_size.descriptorCount = 1;
975 VkDescriptorPoolCreateInfo desc_pool_info = {};
976 desc_pool_info.sType = VK_STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO;
977 desc_pool_info.maxSets = 1;
978 desc_pool_info.poolSizeCount = 1;
979 desc_pool_info.pPoolSizes = &sampler_pool_size;
980 err = device_data->vtable.CreateDescriptorPool(device_data->device,
981 &desc_pool_info,
982 NULL, &data->descriptor_pool);
983 check_vk_result(err);
984
985 /* Descriptor layout */
986 VkSampler sampler[1] = { data->font_sampler };
987 VkDescriptorSetLayoutBinding binding[1] = {};
988 binding[0].descriptorType = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER;
989 binding[0].descriptorCount = 1;
990 binding[0].stageFlags = VK_SHADER_STAGE_FRAGMENT_BIT;
991 binding[0].pImmutableSamplers = sampler;
992 VkDescriptorSetLayoutCreateInfo set_layout_info = {};
993 set_layout_info.sType = VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO;
994 set_layout_info.bindingCount = 1;
995 set_layout_info.pBindings = binding;
996 err = device_data->vtable.CreateDescriptorSetLayout(device_data->device,
997 &set_layout_info,
998 NULL, &data->descriptor_layout);
999 check_vk_result(err);
1000
1001 /* Descriptor set */
1002 VkDescriptorSetAllocateInfo alloc_info = {};
1003 alloc_info.sType = VK_STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO;
1004 alloc_info.descriptorPool = data->descriptor_pool;
1005 alloc_info.descriptorSetCount = 1;
1006 alloc_info.pSetLayouts = &data->descriptor_layout;
1007 err = device_data->vtable.AllocateDescriptorSets(device_data->device,
1008 &alloc_info,
1009 &data->descriptor_set);
1010 check_vk_result(err);
1011
1012 /* Constants: we are using 'vec2 offset' and 'vec2 scale' instead of a full
1013 * 3d projection matrix
1014 */
1015 VkPushConstantRange push_constants[1] = {};
1016 push_constants[0].stageFlags = VK_SHADER_STAGE_VERTEX_BIT;
1017 push_constants[0].offset = sizeof(float) * 0;
1018 push_constants[0].size = sizeof(float) * 4;
1019 VkPipelineLayoutCreateInfo layout_info = {};
1020 layout_info.sType = VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO;
1021 layout_info.setLayoutCount = 1;
1022 layout_info.pSetLayouts = &data->descriptor_layout;
1023 layout_info.pushConstantRangeCount = 1;
1024 layout_info.pPushConstantRanges = push_constants;
1025 err = device_data->vtable.CreatePipelineLayout(device_data->device,
1026 &layout_info,
1027 NULL, &data->pipeline_layout);
1028 check_vk_result(err);
1029
1030
1031 VkPipelineShaderStageCreateInfo stage[2] = {};
1032 stage[0].sType = VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO;
1033 stage[0].stage = VK_SHADER_STAGE_VERTEX_BIT;
1034 stage[0].module = vert_module;
1035 stage[0].pName = "main";
1036 stage[1].sType = VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO;
1037 stage[1].stage = VK_SHADER_STAGE_FRAGMENT_BIT;
1038 stage[1].module = frag_module;
1039 stage[1].pName = "main";
1040
1041 VkVertexInputBindingDescription binding_desc[1] = {};
1042 binding_desc[0].stride = sizeof(ImDrawVert);
1043 binding_desc[0].inputRate = VK_VERTEX_INPUT_RATE_VERTEX;
1044
1045 VkVertexInputAttributeDescription attribute_desc[3] = {};
1046 attribute_desc[0].location = 0;
1047 attribute_desc[0].binding = binding_desc[0].binding;
1048 attribute_desc[0].format = VK_FORMAT_R32G32_SFLOAT;
1049 attribute_desc[0].offset = IM_OFFSETOF(ImDrawVert, pos);
1050 attribute_desc[1].location = 1;
1051 attribute_desc[1].binding = binding_desc[0].binding;
1052 attribute_desc[1].format = VK_FORMAT_R32G32_SFLOAT;
1053 attribute_desc[1].offset = IM_OFFSETOF(ImDrawVert, uv);
1054 attribute_desc[2].location = 2;
1055 attribute_desc[2].binding = binding_desc[0].binding;
1056 attribute_desc[2].format = VK_FORMAT_R8G8B8A8_UNORM;
1057 attribute_desc[2].offset = IM_OFFSETOF(ImDrawVert, col);
1058
1059 VkPipelineVertexInputStateCreateInfo vertex_info = {};
1060 vertex_info.sType = VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO;
1061 vertex_info.vertexBindingDescriptionCount = 1;
1062 vertex_info.pVertexBindingDescriptions = binding_desc;
1063 vertex_info.vertexAttributeDescriptionCount = 3;
1064 vertex_info.pVertexAttributeDescriptions = attribute_desc;
1065
1066 VkPipelineInputAssemblyStateCreateInfo ia_info = {};
1067 ia_info.sType = VK_STRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFO;
1068 ia_info.topology = VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST;
1069
1070 VkPipelineViewportStateCreateInfo viewport_info = {};
1071 viewport_info.sType = VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO;
1072 viewport_info.viewportCount = 1;
1073 viewport_info.scissorCount = 1;
1074
1075 VkPipelineRasterizationStateCreateInfo raster_info = {};
1076 raster_info.sType = VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_STATE_CREATE_INFO;
1077 raster_info.polygonMode = VK_POLYGON_MODE_FILL;
1078 raster_info.cullMode = VK_CULL_MODE_NONE;
1079 raster_info.frontFace = VK_FRONT_FACE_COUNTER_CLOCKWISE;
1080 raster_info.lineWidth = 1.0f;
1081
1082 VkPipelineMultisampleStateCreateInfo ms_info = {};
1083 ms_info.sType = VK_STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO;
1084 ms_info.rasterizationSamples = VK_SAMPLE_COUNT_1_BIT;
1085
1086 VkPipelineColorBlendAttachmentState color_attachment[1] = {};
1087 color_attachment[0].blendEnable = VK_TRUE;
1088 color_attachment[0].srcColorBlendFactor = VK_BLEND_FACTOR_SRC_ALPHA;
1089 color_attachment[0].dstColorBlendFactor = VK_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA;
1090 color_attachment[0].colorBlendOp = VK_BLEND_OP_ADD;
1091 color_attachment[0].srcAlphaBlendFactor = VK_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA;
1092 color_attachment[0].dstAlphaBlendFactor = VK_BLEND_FACTOR_ZERO;
1093 color_attachment[0].alphaBlendOp = VK_BLEND_OP_ADD;
1094 color_attachment[0].colorWriteMask = VK_COLOR_COMPONENT_R_BIT |
1095 VK_COLOR_COMPONENT_G_BIT | VK_COLOR_COMPONENT_B_BIT | VK_COLOR_COMPONENT_A_BIT;
1096
1097 VkPipelineDepthStencilStateCreateInfo depth_info = {};
1098 depth_info.sType = VK_STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO;
1099
1100 VkPipelineColorBlendStateCreateInfo blend_info = {};
1101 blend_info.sType = VK_STRUCTURE_TYPE_PIPELINE_COLOR_BLEND_STATE_CREATE_INFO;
1102 blend_info.attachmentCount = 1;
1103 blend_info.pAttachments = color_attachment;
1104
1105 VkDynamicState dynamic_states[2] = { VK_DYNAMIC_STATE_VIEWPORT, VK_DYNAMIC_STATE_SCISSOR };
1106 VkPipelineDynamicStateCreateInfo dynamic_state = {};
1107 dynamic_state.sType = VK_STRUCTURE_TYPE_PIPELINE_DYNAMIC_STATE_CREATE_INFO;
1108 dynamic_state.dynamicStateCount = (uint32_t)IM_ARRAYSIZE(dynamic_states);
1109 dynamic_state.pDynamicStates = dynamic_states;
1110
1111 VkGraphicsPipelineCreateInfo info = {};
1112 info.sType = VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO;
1113 info.flags = 0;
1114 info.stageCount = 2;
1115 info.pStages = stage;
1116 info.pVertexInputState = &vertex_info;
1117 info.pInputAssemblyState = &ia_info;
1118 info.pViewportState = &viewport_info;
1119 info.pRasterizationState = &raster_info;
1120 info.pMultisampleState = &ms_info;
1121 info.pDepthStencilState = &depth_info;
1122 info.pColorBlendState = &blend_info;
1123 info.pDynamicState = &dynamic_state;
1124 info.layout = data->pipeline_layout;
1125 info.renderPass = data->render_pass;
1126 err = device_data->vtable.CreateGraphicsPipelines(device_data->device, VK_NULL_HANDLE,
1127 1, &info,
1128 NULL, &data->pipeline);
1129 check_vk_result(err);
1130
1131 device_data->vtable.DestroyShaderModule(device_data->device, vert_module, NULL);
1132 device_data->vtable.DestroyShaderModule(device_data->device, frag_module, NULL);
1133
1134 ImGuiIO& io = ImGui::GetIO();
1135 unsigned char* pixels;
1136 int width, height;
1137 io.Fonts->GetTexDataAsRGBA32(&pixels, &width, &height);
1138
1139 /* Font image */
1140 VkImageCreateInfo image_info = {};
1141 image_info.sType = VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO;
1142 image_info.imageType = VK_IMAGE_TYPE_2D;
1143 image_info.format = VK_FORMAT_R8G8B8A8_UNORM;
1144 image_info.extent.width = width;
1145 image_info.extent.height = height;
1146 image_info.extent.depth = 1;
1147 image_info.mipLevels = 1;
1148 image_info.arrayLayers = 1;
1149 image_info.samples = VK_SAMPLE_COUNT_1_BIT;
1150 image_info.tiling = VK_IMAGE_TILING_OPTIMAL;
1151 image_info.usage = VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_TRANSFER_DST_BIT;
1152 image_info.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
1153 image_info.initialLayout = VK_IMAGE_LAYOUT_UNDEFINED;
1154 err = device_data->vtable.CreateImage(device_data->device, &image_info,
1155 NULL, &data->font_image);
1156 check_vk_result(err);
1157 VkMemoryRequirements font_image_req;
1158 device_data->vtable.GetImageMemoryRequirements(device_data->device,
1159 data->font_image, &font_image_req);
1160 VkMemoryAllocateInfo image_alloc_info = {};
1161 image_alloc_info.sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO;
1162 image_alloc_info.allocationSize = font_image_req.size;
1163 image_alloc_info.memoryTypeIndex = vk_memory_type(device_data,
1164 VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT,
1165 font_image_req.memoryTypeBits);
1166 err = device_data->vtable.AllocateMemory(device_data->device, &image_alloc_info,
1167 NULL, &data->font_mem);
1168 check_vk_result(err);
1169 err = device_data->vtable.BindImageMemory(device_data->device,
1170 data->font_image,
1171 data->font_mem, 0);
1172 check_vk_result(err);
1173
1174 /* Font image view */
1175 VkImageViewCreateInfo view_info = {};
1176 view_info.sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO;
1177 view_info.image = data->font_image;
1178 view_info.viewType = VK_IMAGE_VIEW_TYPE_2D;
1179 view_info.format = VK_FORMAT_R8G8B8A8_UNORM;
1180 view_info.subresourceRange.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
1181 view_info.subresourceRange.levelCount = 1;
1182 view_info.subresourceRange.layerCount = 1;
1183 err = device_data->vtable.CreateImageView(device_data->device, &view_info,
1184 NULL, &data->font_image_view);
1185 check_vk_result(err);
1186
1187 /* Descriptor set */
1188 VkDescriptorImageInfo desc_image[1] = {};
1189 desc_image[0].sampler = data->font_sampler;
1190 desc_image[0].imageView = data->font_image_view;
1191 desc_image[0].imageLayout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
1192 VkWriteDescriptorSet write_desc[1] = {};
1193 write_desc[0].sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
1194 write_desc[0].dstSet = data->descriptor_set;
1195 write_desc[0].descriptorCount = 1;
1196 write_desc[0].descriptorType = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER;
1197 write_desc[0].pImageInfo = desc_image;
1198 device_data->vtable.UpdateDescriptorSets(device_data->device, 1, write_desc, 0, NULL);
1199 }
1200
1201 static void setup_swapchain_data(struct swapchain_data *data,
1202 const VkSwapchainCreateInfoKHR *pCreateInfo)
1203 {
1204 data->width = pCreateInfo->imageExtent.width;
1205 data->height = pCreateInfo->imageExtent.height;
1206 data->format = pCreateInfo->imageFormat;
1207
1208 data->imgui_context = ImGui::CreateContext();
1209 ImGui::SetCurrentContext(data->imgui_context);
1210
1211 ImGui::GetIO().IniFilename = NULL;
1212 ImGui::GetIO().DisplaySize = ImVec2((float)data->width, (float)data->height);
1213
1214 struct device_data *device_data = data->device;
1215 VkResult err;
1216
1217 /* Render pass */
1218 VkAttachmentDescription attachment_desc = {};
1219 attachment_desc.format = pCreateInfo->imageFormat;
1220 attachment_desc.samples = VK_SAMPLE_COUNT_1_BIT;
1221 attachment_desc.loadOp = VK_ATTACHMENT_LOAD_OP_LOAD;
1222 attachment_desc.storeOp = VK_ATTACHMENT_STORE_OP_STORE;
1223 attachment_desc.stencilLoadOp = VK_ATTACHMENT_LOAD_OP_DONT_CARE;
1224 attachment_desc.stencilStoreOp = VK_ATTACHMENT_STORE_OP_DONT_CARE;
1225 attachment_desc.initialLayout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL;
1226 attachment_desc.finalLayout = VK_IMAGE_LAYOUT_PRESENT_SRC_KHR;
1227 VkAttachmentReference color_attachment = {};
1228 color_attachment.attachment = 0;
1229 color_attachment.layout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL;
1230 VkSubpassDescription subpass = {};
1231 subpass.pipelineBindPoint = VK_PIPELINE_BIND_POINT_GRAPHICS;
1232 subpass.colorAttachmentCount = 1;
1233 subpass.pColorAttachments = &color_attachment;
1234 VkSubpassDependency dependency = {};
1235 dependency.srcSubpass = VK_SUBPASS_EXTERNAL;
1236 dependency.dstSubpass = 0;
1237 dependency.srcStageMask = VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT;
1238 dependency.dstStageMask = VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT;
1239 dependency.srcAccessMask = 0;
1240 dependency.dstAccessMask = VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT;
1241 VkRenderPassCreateInfo render_pass_info = {};
1242 render_pass_info.sType = VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO;
1243 render_pass_info.attachmentCount = 1;
1244 render_pass_info.pAttachments = &attachment_desc;
1245 render_pass_info.subpassCount = 1;
1246 render_pass_info.pSubpasses = &subpass;
1247 render_pass_info.dependencyCount = 1;
1248 render_pass_info.pDependencies = &dependency;
1249 err = device_data->vtable.CreateRenderPass(device_data->device,
1250 &render_pass_info,
1251 NULL, &data->render_pass);
1252 check_vk_result(err);
1253
1254 setup_swapchain_data_pipeline(data);
1255
1256 device_data->vtable.GetSwapchainImagesKHR(device_data->device,
1257 data->swapchain,
1258 &data->n_images,
1259 NULL);
1260 data->images = ralloc_array(data, VkImage, data->n_images);
1261 data->image_views = ralloc_array(data, VkImageView, data->n_images);
1262 data->framebuffers = ralloc_array(data, VkFramebuffer, data->n_images);
1263
1264 device_data->vtable.GetSwapchainImagesKHR(device_data->device,
1265 data->swapchain,
1266 &data->n_images,
1267 data->images);
1268
1269 /* Image views */
1270 VkImageViewCreateInfo view_info = {};
1271 view_info.sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO;
1272 view_info.viewType = VK_IMAGE_VIEW_TYPE_2D;
1273 view_info.format = pCreateInfo->imageFormat;
1274 view_info.components.r = VK_COMPONENT_SWIZZLE_R;
1275 view_info.components.g = VK_COMPONENT_SWIZZLE_G;
1276 view_info.components.b = VK_COMPONENT_SWIZZLE_B;
1277 view_info.components.a = VK_COMPONENT_SWIZZLE_A;
1278 view_info.subresourceRange = { VK_IMAGE_ASPECT_COLOR_BIT, 0, 1, 0, 1 };
1279 for (uint32_t i = 0; i < data->n_images; i++) {
1280 view_info.image = data->images[i];
1281 err = device_data->vtable.CreateImageView(device_data->device, &view_info,
1282 NULL, &data->image_views[i]);
1283 check_vk_result(err);
1284 }
1285
1286 /* Framebuffers */
1287 VkImageView attachment[1];
1288 VkFramebufferCreateInfo fb_info = {};
1289 fb_info.sType = VK_STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO;
1290 fb_info.renderPass = data->render_pass;
1291 fb_info.attachmentCount = 1;
1292 fb_info.pAttachments = attachment;
1293 fb_info.width = data->width;
1294 fb_info.height = data->height;
1295 fb_info.layers = 1;
1296 for (uint32_t i = 0; i < data->n_images; i++) {
1297 attachment[0] = data->image_views[i];
1298 err = device_data->vtable.CreateFramebuffer(device_data->device, &fb_info,
1299 NULL, &data->framebuffers[i]);
1300 check_vk_result(err);
1301 }
1302
1303 /* Command buffer */
1304 VkCommandPoolCreateInfo cmd_buffer_pool_info = {};
1305 cmd_buffer_pool_info.sType = VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO;
1306 cmd_buffer_pool_info.flags = VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT;
1307 cmd_buffer_pool_info.queueFamilyIndex = device_data->graphic_queue->family_index;
1308 err = device_data->vtable.CreateCommandPool(device_data->device,
1309 &cmd_buffer_pool_info,
1310 NULL, &data->command_pool);
1311 check_vk_result(err);
1312
1313 VkCommandBuffer cmd_bufs[ARRAY_SIZE(data->frame_data)];
1314
1315 VkCommandBufferAllocateInfo cmd_buffer_info = {};
1316 cmd_buffer_info.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO;
1317 cmd_buffer_info.commandPool = data->command_pool;
1318 cmd_buffer_info.level = VK_COMMAND_BUFFER_LEVEL_PRIMARY;
1319 cmd_buffer_info.commandBufferCount = 2;
1320 err = device_data->vtable.AllocateCommandBuffers(device_data->device,
1321 &cmd_buffer_info,
1322 cmd_bufs);
1323 check_vk_result(err);
1324
1325 for (uint32_t i = 0; i < ARRAY_SIZE(data->frame_data); i++) {
1326 err = device_data->set_device_loader_data(device_data->device,
1327 cmd_bufs[i]);
1328 check_vk_result(err);
1329
1330 data->frame_data[i].command_buffer = cmd_bufs[i];
1331 }
1332
1333 /* Submission fence */
1334 VkFenceCreateInfo fence_info = {};
1335 fence_info.sType = VK_STRUCTURE_TYPE_FENCE_CREATE_INFO;
1336 fence_info.flags = VK_FENCE_CREATE_SIGNALED_BIT;
1337 err = device_data->vtable.CreateFence(device_data->device, &fence_info,
1338 NULL, &data->fence);
1339 check_vk_result(err);
1340 }
1341
1342 static void shutdown_swapchain_data(struct swapchain_data *data)
1343 {
1344 struct device_data *device_data = data->device;
1345
1346 for (uint32_t i = 0; i < data->n_images; i++) {
1347 device_data->vtable.DestroyImageView(device_data->device, data->image_views[i], NULL);
1348 device_data->vtable.DestroyFramebuffer(device_data->device, data->framebuffers[i], NULL);
1349 }
1350
1351 device_data->vtable.DestroyRenderPass(device_data->device, data->render_pass, NULL);
1352
1353 for (uint32_t i = 0; i < ARRAY_SIZE(data->frame_data); i++) {
1354 device_data->vtable.FreeCommandBuffers(device_data->device,
1355 data->command_pool,
1356 1, &data->frame_data[i].command_buffer);
1357 if (data->frame_data[i].vertex_buffer)
1358 device_data->vtable.DestroyBuffer(device_data->device, data->frame_data[i].vertex_buffer, NULL);
1359 if (data->frame_data[i].index_buffer)
1360 device_data->vtable.DestroyBuffer(device_data->device, data->frame_data[i].index_buffer, NULL);
1361 if (data->frame_data[i].vertex_buffer_mem)
1362 device_data->vtable.FreeMemory(device_data->device, data->frame_data[i].vertex_buffer_mem, NULL);
1363 if (data->frame_data[i].index_buffer_mem)
1364 device_data->vtable.FreeMemory(device_data->device, data->frame_data[i].index_buffer_mem, NULL);
1365 }
1366 device_data->vtable.DestroyCommandPool(device_data->device, data->command_pool, NULL);
1367
1368 device_data->vtable.DestroyFence(device_data->device, data->fence, NULL);
1369 if (data->submission_semaphore)
1370 device_data->vtable.DestroySemaphore(device_data->device, data->submission_semaphore, NULL);
1371
1372 device_data->vtable.DestroyPipeline(device_data->device, data->pipeline, NULL);
1373 device_data->vtable.DestroyPipelineLayout(device_data->device, data->pipeline_layout, NULL);
1374
1375 device_data->vtable.FreeDescriptorSets(device_data->device, data->descriptor_pool,
1376 1, &data->descriptor_set);
1377 device_data->vtable.DestroyDescriptorPool(device_data->device,
1378 data->descriptor_pool, NULL);
1379 device_data->vtable.DestroyDescriptorSetLayout(device_data->device,
1380 data->descriptor_layout, NULL);
1381
1382 device_data->vtable.DestroySampler(device_data->device, data->font_sampler, NULL);
1383 device_data->vtable.DestroyImageView(device_data->device, data->font_image_view, NULL);
1384 device_data->vtable.DestroyImage(device_data->device, data->font_image, NULL);
1385 device_data->vtable.FreeMemory(device_data->device, data->font_mem, NULL);
1386
1387 device_data->vtable.DestroyBuffer(device_data->device, data->upload_font_buffer, NULL);
1388 device_data->vtable.FreeMemory(device_data->device, data->upload_font_buffer_mem, NULL);
1389
1390 ImGui::DestroyContext(data->imgui_context);
1391 }
1392
1393 static void before_present(struct swapchain_data *swapchain_data,
1394 unsigned imageIndex)
1395 {
1396 snapshot_swapchain_frame(swapchain_data);
1397
1398 compute_swapchain_display(swapchain_data);
1399 render_swapchain_display(swapchain_data, imageIndex);
1400 }
1401
1402 VKAPI_ATTR VkResult VKAPI_CALL overlay_CreateSwapchainKHR(
1403 VkDevice device,
1404 const VkSwapchainCreateInfoKHR* pCreateInfo,
1405 const VkAllocationCallbacks* pAllocator,
1406 VkSwapchainKHR* pSwapchain)
1407 {
1408 struct device_data *device_data = FIND_DEVICE_DATA(device);
1409 VkResult result = device_data->vtable.CreateSwapchainKHR(device, pCreateInfo, pAllocator, pSwapchain);
1410 if (result != VK_SUCCESS) return result;
1411
1412 struct swapchain_data *swapchain_data = new_swapchain_data(*pSwapchain, device_data);
1413 setup_swapchain_data(swapchain_data, pCreateInfo);
1414 return result;
1415 }
1416
1417 VKAPI_ATTR void VKAPI_CALL overlay_DestroySwapchainKHR(
1418 VkDevice device,
1419 VkSwapchainKHR swapchain,
1420 const VkAllocationCallbacks* pAllocator)
1421 {
1422 struct swapchain_data *swapchain_data = FIND_SWAPCHAIN_DATA(swapchain);
1423
1424 shutdown_swapchain_data(swapchain_data);
1425 swapchain_data->device->vtable.DestroySwapchainKHR(device, swapchain, pAllocator);
1426 destroy_swapchain_data(swapchain_data);
1427 }
1428
1429 VKAPI_ATTR VkResult VKAPI_CALL overlay_QueuePresentKHR(
1430 VkQueue queue,
1431 const VkPresentInfoKHR* pPresentInfo)
1432 {
1433 struct queue_data *queue_data = FIND_QUEUE_DATA(queue);
1434 struct device_data *device_data = queue_data->device;
1435
1436 /* If we present on the graphic queue this layer is using to draw an
1437 * overlay, we don't need more than submitting the overlay draw prior to
1438 * present.
1439 */
1440 if (queue_data == device_data->graphic_queue) {
1441 for (uint32_t i = 0; i < pPresentInfo->swapchainCount; i++) {
1442 struct swapchain_data *swapchain_data = FIND_SWAPCHAIN_DATA(pPresentInfo->pSwapchains[i]);
1443 before_present(swapchain_data, pPresentInfo->pImageIndices[i]);
1444 }
1445 return queue_data->device->vtable.QueuePresentKHR(queue, pPresentInfo);
1446 }
1447
1448 /* Otherwise we need to do cross queue synchronization to tie the overlay
1449 * draw into the present queue.
1450 */
1451 VkPresentInfoKHR present_info = *pPresentInfo;
1452 VkSemaphore *semaphores =
1453 (VkSemaphore *)malloc(sizeof(VkSemaphore) * (pPresentInfo->waitSemaphoreCount + pPresentInfo->swapchainCount));
1454 for (uint32_t i = 0; i < pPresentInfo->waitSemaphoreCount; i++)
1455 semaphores[i] = pPresentInfo->pWaitSemaphores[i];
1456 for (uint32_t i = 0; i < pPresentInfo->swapchainCount; i++) {
1457 struct swapchain_data *swapchain_data = FIND_SWAPCHAIN_DATA(pPresentInfo->pSwapchains[i]);
1458 before_present(swapchain_data, pPresentInfo->pImageIndices[i]);
1459 semaphores[pPresentInfo->waitSemaphoreCount + i] = swapchain_data->submission_semaphore;
1460 }
1461 present_info.pWaitSemaphores = semaphores;
1462 present_info.waitSemaphoreCount = pPresentInfo->waitSemaphoreCount + pPresentInfo->swapchainCount;
1463 VkResult result = queue_data->device->vtable.QueuePresentKHR(queue, &present_info);
1464 free(semaphores);
1465 return result;
1466 }
1467
1468 VKAPI_ATTR VkResult VKAPI_CALL overlay_AcquireNextImageKHR(
1469 VkDevice device,
1470 VkSwapchainKHR swapchain,
1471 uint64_t timeout,
1472 VkSemaphore semaphore,
1473 VkFence fence,
1474 uint32_t* pImageIndex)
1475 {
1476 struct swapchain_data *swapchain_data = FIND_SWAPCHAIN_DATA(swapchain);
1477 struct device_data *device_data = swapchain_data->device;
1478
1479 uint64_t ts0 = os_time_get();
1480 VkResult result = device_data->vtable.AcquireNextImageKHR(device, swapchain, timeout,
1481 semaphore, fence, pImageIndex);
1482 uint64_t ts1 = os_time_get();
1483
1484 swapchain_data->acquire_times[swapchain_data->n_acquire %
1485 ARRAY_SIZE(swapchain_data->acquire_times)] =
1486 ((double)ts1 - (double)ts0) / 1000.0;
1487 swapchain_data->n_acquire++;
1488
1489 return result;
1490 }
1491
1492 VKAPI_ATTR VkResult VKAPI_CALL overlay_AcquireNextImage2KHR(
1493 VkDevice device,
1494 const VkAcquireNextImageInfoKHR* pAcquireInfo,
1495 uint32_t* pImageIndex)
1496 {
1497 struct swapchain_data *swapchain_data = FIND_SWAPCHAIN_DATA(pAcquireInfo->swapchain);
1498 struct device_data *device_data = swapchain_data->device;
1499
1500 uint64_t ts0 = os_time_get();
1501 VkResult result = device_data->vtable.AcquireNextImage2KHR(device, pAcquireInfo, pImageIndex);
1502 uint64_t ts1 = os_time_get();
1503
1504 swapchain_data->acquire_times[swapchain_data->n_acquire %
1505 ARRAY_SIZE(swapchain_data->acquire_times)] =
1506 ((double)ts1 - (double)ts0) / 1000.0;
1507 swapchain_data->n_acquire++;
1508
1509 return result;
1510 }
1511
1512 VKAPI_ATTR void VKAPI_CALL overlay_CmdDraw(
1513 VkCommandBuffer commandBuffer,
1514 uint32_t vertexCount,
1515 uint32_t instanceCount,
1516 uint32_t firstVertex,
1517 uint32_t firstInstance)
1518 {
1519 struct device_data *device_data = FIND_DEVICE_DATA(commandBuffer);
1520 device_data->vtable.CmdDraw(commandBuffer, vertexCount, instanceCount,
1521 firstVertex, firstInstance);
1522 device_data->stats.stats[OVERLAY_PARAM_ENABLED_draw]++;
1523 }
1524
1525 VKAPI_ATTR void VKAPI_CALL overlay_CmdDrawIndexed(
1526 VkCommandBuffer commandBuffer,
1527 uint32_t indexCount,
1528 uint32_t instanceCount,
1529 uint32_t firstIndex,
1530 int32_t vertexOffset,
1531 uint32_t firstInstance)
1532 {
1533 struct device_data *device_data = FIND_DEVICE_DATA(commandBuffer);
1534 device_data->vtable.CmdDrawIndexed(commandBuffer, indexCount, instanceCount,
1535 firstIndex, vertexOffset, firstInstance);
1536 device_data->stats.stats[OVERLAY_PARAM_ENABLED_draw_indexed]++;
1537 }
1538
1539 VKAPI_ATTR void VKAPI_CALL overlay_CmdDrawIndirect(
1540 VkCommandBuffer commandBuffer,
1541 VkBuffer buffer,
1542 VkDeviceSize offset,
1543 uint32_t drawCount,
1544 uint32_t stride)
1545 {
1546 struct device_data *device_data = FIND_DEVICE_DATA(commandBuffer);
1547 device_data->vtable.CmdDrawIndirect(commandBuffer, buffer, offset, drawCount, stride);
1548 device_data->stats.stats[OVERLAY_PARAM_ENABLED_draw_indirect]++;
1549 }
1550
1551 VKAPI_ATTR void VKAPI_CALL overlay_CmdDrawIndexedIndirect(
1552 VkCommandBuffer commandBuffer,
1553 VkBuffer buffer,
1554 VkDeviceSize offset,
1555 uint32_t drawCount,
1556 uint32_t stride)
1557 {
1558 struct device_data *device_data = FIND_DEVICE_DATA(commandBuffer);
1559 device_data->vtable.CmdDrawIndexedIndirect(commandBuffer, buffer, offset, drawCount, stride);
1560 device_data->stats.stats[OVERLAY_PARAM_ENABLED_draw_indexed_indirect]++;
1561 }
1562
1563 VKAPI_ATTR void VKAPI_CALL overlay_CmdDrawIndirectCountKHR(
1564 VkCommandBuffer commandBuffer,
1565 VkBuffer buffer,
1566 VkDeviceSize offset,
1567 VkBuffer countBuffer,
1568 VkDeviceSize countBufferOffset,
1569 uint32_t maxDrawCount,
1570 uint32_t stride)
1571 {
1572 struct device_data *device_data = FIND_DEVICE_DATA(commandBuffer);
1573 device_data->vtable.CmdDrawIndirectCountKHR(commandBuffer, buffer, offset,
1574 countBuffer, countBufferOffset,
1575 maxDrawCount, stride);
1576 device_data->stats.stats[OVERLAY_PARAM_ENABLED_draw_indirect_count]++;
1577 }
1578
1579 VKAPI_ATTR void VKAPI_CALL overlay_CmdDrawIndexedIndirectCountKHR(
1580 VkCommandBuffer commandBuffer,
1581 VkBuffer buffer,
1582 VkDeviceSize offset,
1583 VkBuffer countBuffer,
1584 VkDeviceSize countBufferOffset,
1585 uint32_t maxDrawCount,
1586 uint32_t stride)
1587 {
1588 struct device_data *device_data = FIND_DEVICE_DATA(commandBuffer);
1589 device_data->vtable.CmdDrawIndexedIndirectCountKHR(commandBuffer, buffer, offset,
1590 countBuffer, countBufferOffset,
1591 maxDrawCount, stride);
1592 device_data->stats.stats[OVERLAY_PARAM_ENABLED_draw_indexed_indirect_count]++;
1593 }
1594
1595 VKAPI_ATTR void VKAPI_CALL overlay_CmdDispatch(
1596 VkCommandBuffer commandBuffer,
1597 uint32_t groupCountX,
1598 uint32_t groupCountY,
1599 uint32_t groupCountZ)
1600 {
1601 struct device_data *device_data = FIND_DEVICE_DATA(commandBuffer);
1602 device_data->vtable.CmdDispatch(commandBuffer, groupCountX, groupCountY, groupCountZ);
1603 device_data->stats.stats[OVERLAY_PARAM_ENABLED_dispatch]++;
1604 }
1605
1606 VKAPI_ATTR void VKAPI_CALL overlay_CmdDispatchIndirect(
1607 VkCommandBuffer commandBuffer,
1608 VkBuffer buffer,
1609 VkDeviceSize offset)
1610 {
1611 struct device_data *device_data = FIND_DEVICE_DATA(commandBuffer);
1612 device_data->vtable.CmdDispatchIndirect(commandBuffer, buffer, offset);
1613 device_data->stats.stats[OVERLAY_PARAM_ENABLED_dispatch_indirect]++;
1614 }
1615
1616 VKAPI_ATTR void VKAPI_CALL overlay_CmdBindPipeline(
1617 VkCommandBuffer commandBuffer,
1618 VkPipelineBindPoint pipelineBindPoint,
1619 VkPipeline pipeline)
1620 {
1621 struct device_data *device_data = FIND_DEVICE_DATA(commandBuffer);
1622 device_data->vtable.CmdBindPipeline(commandBuffer, pipelineBindPoint, pipeline);
1623 switch (pipelineBindPoint) {
1624 case VK_PIPELINE_BIND_POINT_GRAPHICS: device_data->stats.stats[OVERLAY_PARAM_ENABLED_pipeline_graphics]++; break;
1625 case VK_PIPELINE_BIND_POINT_COMPUTE: device_data->stats.stats[OVERLAY_PARAM_ENABLED_pipeline_compute]++; break;
1626 case VK_PIPELINE_BIND_POINT_RAY_TRACING_NV: device_data->stats.stats[OVERLAY_PARAM_ENABLED_pipeline_raytracing]++; break;
1627 default: break;
1628 }
1629 }
1630
1631 VKAPI_ATTR VkResult VKAPI_CALL overlay_AllocateCommandBuffers(VkDevice device,
1632 const VkCommandBufferAllocateInfo* pAllocateInfo,
1633 VkCommandBuffer* pCommandBuffers)
1634 {
1635 struct device_data *device_data = FIND_DEVICE_DATA(device);
1636
1637 VkResult result =
1638 device_data->vtable.AllocateCommandBuffers(device, pAllocateInfo, pCommandBuffers);
1639 if (result != VK_SUCCESS) return result;
1640
1641 for (uint32_t i = 0; i < pAllocateInfo->commandBufferCount; i++)
1642 map_object(pCommandBuffers[i], device_data);
1643
1644 return result;
1645 }
1646
1647 VKAPI_ATTR void VKAPI_CALL overlay_FreeCommandBuffers(VkDevice device,
1648 VkCommandPool commandPool,
1649 uint32_t commandBufferCount,
1650 const VkCommandBuffer* pCommandBuffers)
1651 {
1652 struct device_data *device_data = FIND_DEVICE_DATA(device);
1653
1654 for (uint32_t i = 0; i < commandBufferCount; i++)
1655 unmap_object(pCommandBuffers[i]);
1656
1657 device_data->vtable.FreeCommandBuffers(device, commandPool,
1658 commandBufferCount, pCommandBuffers);
1659 }
1660
1661 VKAPI_ATTR VkResult VKAPI_CALL overlay_QueueSubmit(
1662 VkQueue queue,
1663 uint32_t submitCount,
1664 const VkSubmitInfo* pSubmits,
1665 VkFence fence)
1666 {
1667 struct queue_data *queue_data = FIND_QUEUE_DATA(queue);
1668 struct device_data *device_data = queue_data->device;
1669
1670 device_data->stats.stats[OVERLAY_PARAM_ENABLED_submit]++;
1671
1672 return device_data->vtable.QueueSubmit(queue, submitCount, pSubmits, fence);
1673 }
1674
1675 VKAPI_ATTR VkResult VKAPI_CALL overlay_CreateDevice(
1676 VkPhysicalDevice physicalDevice,
1677 const VkDeviceCreateInfo* pCreateInfo,
1678 const VkAllocationCallbacks* pAllocator,
1679 VkDevice* pDevice)
1680 {
1681 struct instance_data *instance_data = FIND_PHYSICAL_DEVICE_DATA(physicalDevice);
1682 VkLayerDeviceCreateInfo *chain_info =
1683 get_device_chain_info(pCreateInfo, VK_LAYER_LINK_INFO);
1684
1685 assert(chain_info->u.pLayerInfo);
1686 PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr = chain_info->u.pLayerInfo->pfnNextGetInstanceProcAddr;
1687 PFN_vkGetDeviceProcAddr fpGetDeviceProcAddr = chain_info->u.pLayerInfo->pfnNextGetDeviceProcAddr;
1688 PFN_vkCreateDevice fpCreateDevice = (PFN_vkCreateDevice)fpGetInstanceProcAddr(NULL, "vkCreateDevice");
1689 if (fpCreateDevice == NULL) {
1690 return VK_ERROR_INITIALIZATION_FAILED;
1691 }
1692
1693 // Advance the link info for the next element on the chain
1694 chain_info->u.pLayerInfo = chain_info->u.pLayerInfo->pNext;
1695
1696 VkResult result = fpCreateDevice(physicalDevice, pCreateInfo, pAllocator, pDevice);
1697 if (result != VK_SUCCESS) return result;
1698
1699 struct device_data *device_data = new_device_data(*pDevice, instance_data);
1700 device_data->physical_device = physicalDevice;
1701 vk_load_device_commands(*pDevice, fpGetDeviceProcAddr, &device_data->vtable);
1702
1703 instance_data->vtable.GetPhysicalDeviceProperties(device_data->physical_device,
1704 &device_data->properties);
1705
1706 VkLayerDeviceCreateInfo *load_data_info =
1707 get_device_chain_info(pCreateInfo, VK_LOADER_DATA_CALLBACK);
1708 device_data->set_device_loader_data = load_data_info->u.pfnSetDeviceLoaderData;
1709
1710 device_map_queues(device_data, pCreateInfo);
1711
1712 return result;
1713 }
1714
1715 VKAPI_ATTR void VKAPI_CALL overlay_DestroyDevice(
1716 VkDevice device,
1717 const VkAllocationCallbacks* pAllocator)
1718 {
1719 struct device_data *device_data = FIND_DEVICE_DATA(device);
1720 device_unmap_queues(device_data);
1721 device_data->vtable.DestroyDevice(device, pAllocator);
1722 destroy_device_data(device_data);
1723 }
1724
1725 VKAPI_ATTR VkResult VKAPI_CALL overlay_CreateInstance(
1726 const VkInstanceCreateInfo* pCreateInfo,
1727 const VkAllocationCallbacks* pAllocator,
1728 VkInstance* pInstance)
1729 {
1730 VkLayerInstanceCreateInfo *chain_info =
1731 get_instance_chain_info(pCreateInfo, VK_LAYER_LINK_INFO);
1732
1733 assert(chain_info->u.pLayerInfo);
1734 PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr =
1735 chain_info->u.pLayerInfo->pfnNextGetInstanceProcAddr;
1736 PFN_vkCreateInstance fpCreateInstance =
1737 (PFN_vkCreateInstance)fpGetInstanceProcAddr(NULL, "vkCreateInstance");
1738 if (fpCreateInstance == NULL) {
1739 return VK_ERROR_INITIALIZATION_FAILED;
1740 }
1741
1742 // Advance the link info for the next element on the chain
1743 chain_info->u.pLayerInfo = chain_info->u.pLayerInfo->pNext;
1744
1745 VkResult result = fpCreateInstance(pCreateInfo, pAllocator, pInstance);
1746 if (result != VK_SUCCESS) return result;
1747
1748 struct instance_data *instance_data = new_instance_data(*pInstance);
1749 vk_load_instance_commands(instance_data->instance,
1750 fpGetInstanceProcAddr,
1751 &instance_data->vtable);
1752 instance_data_map_physical_devices(instance_data, true);
1753
1754 parse_overlay_env(&instance_data->params, getenv("VK_LAYER_MESA_OVERLAY_CONFIG"));
1755
1756 return result;
1757 }
1758
1759 VKAPI_ATTR void VKAPI_CALL overlay_DestroyInstance(
1760 VkInstance instance,
1761 const VkAllocationCallbacks* pAllocator)
1762 {
1763 struct instance_data *instance_data = FIND_INSTANCE_DATA(instance);
1764 instance_data_map_physical_devices(instance_data, false);
1765 instance_data->vtable.DestroyInstance(instance, pAllocator);
1766 destroy_instance_data(instance_data);
1767 }
1768
1769 static const struct {
1770 const char *name;
1771 void *ptr;
1772 } name_to_funcptr_map[] = {
1773 { "vkGetDeviceProcAddr", (void *) vkGetDeviceProcAddr },
1774 #define ADD_HOOK(fn) { "vk" # fn, (void *) overlay_ ## fn }
1775 ADD_HOOK(AllocateCommandBuffers),
1776
1777 ADD_HOOK(CmdDraw),
1778 ADD_HOOK(CmdDrawIndexed),
1779 ADD_HOOK(CmdDrawIndexedIndirect),
1780 ADD_HOOK(CmdDispatch),
1781 ADD_HOOK(CmdDispatchIndirect),
1782 ADD_HOOK(CmdDrawIndirectCountKHR),
1783 ADD_HOOK(CmdDrawIndexedIndirectCountKHR),
1784
1785 ADD_HOOK(CmdBindPipeline),
1786
1787 ADD_HOOK(CreateSwapchainKHR),
1788 ADD_HOOK(QueuePresentKHR),
1789 ADD_HOOK(DestroySwapchainKHR),
1790 ADD_HOOK(AcquireNextImageKHR),
1791 ADD_HOOK(AcquireNextImage2KHR),
1792
1793 ADD_HOOK(QueueSubmit),
1794 ADD_HOOK(CreateInstance),
1795 ADD_HOOK(DestroyInstance),
1796 ADD_HOOK(CreateDevice),
1797 ADD_HOOK(DestroyDevice),
1798 #undef ADD_HOOK
1799 };
1800
1801 static void *find_ptr(const char *name)
1802 {
1803 for (uint32_t i = 0; i < ARRAY_SIZE(name_to_funcptr_map); i++) {
1804 if (strcmp(name, name_to_funcptr_map[i].name) == 0)
1805 return name_to_funcptr_map[i].ptr;
1806 }
1807
1808 return NULL;
1809 }
1810
1811 VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetDeviceProcAddr(VkDevice dev,
1812 const char *funcName)
1813 {
1814 void *ptr = find_ptr(funcName);
1815 if (ptr) return reinterpret_cast<PFN_vkVoidFunction>(ptr);
1816
1817 if (dev == NULL) return NULL;
1818
1819 struct device_data *device_data = FIND_DEVICE_DATA(dev);
1820 if (device_data->vtable.GetDeviceProcAddr == NULL) return NULL;
1821 return device_data->vtable.GetDeviceProcAddr(dev, funcName);
1822 }
1823
1824 VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance,
1825 const char *funcName)
1826 {
1827 void *ptr = find_ptr(funcName);
1828 if (ptr) return reinterpret_cast<PFN_vkVoidFunction>(ptr);
1829
1830 if (instance == NULL) return NULL;
1831
1832 struct instance_data *instance_data = FIND_INSTANCE_DATA(instance);
1833 if (instance_data->vtable.GetInstanceProcAddr == NULL) return NULL;
1834 return instance_data->vtable.GetInstanceProcAddr(instance, funcName);
1835 }