forked from llvm/offload-test-suite
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathDevice.cpp
More file actions
4758 lines (4202 loc) · 190 KB
/
Copy pathDevice.cpp
File metadata and controls
4758 lines (4202 loc) · 190 KB
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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//===- VX/Device.cpp - Vulkan Device API ----------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
//
//===----------------------------------------------------------------------===//
#include "API/Device.h"
#include "API/Encoder.h"
#include "API/FormatConversion.h"
#include "Support/Pipeline.h"
#include "Support/VkError.h"
#include "VKResources.h"
#include "llvm/ADT/DenseSet.h"
#include "llvm/ADT/ScopeExit.h"
#include "llvm/Support/Error.h"
#include "llvm/Support/FormatVariadic.h"
#include "../Util.h"
#include <algorithm>
#include <cmath>
#include <map>
#include <memory>
#include <numeric>
#include <system_error>
using namespace offloadtest;
#define VKFormats(FMT, BITS) \
if (Channels == 1) \
return VK_FORMAT_R##BITS##_##FMT; \
if (Channels == 2) \
return VK_FORMAT_R##BITS##G##BITS##_##FMT; \
if (Channels == 3) \
return VK_FORMAT_R##BITS##G##BITS##B##BITS##_##FMT; \
if (Channels == 4) \
return VK_FORMAT_R##BITS##G##BITS##B##BITS##A##BITS##_##FMT;
static VkFormat getVKFormat(DataFormat Format, int Channels) {
switch (Format) {
case DataFormat::Int16:
VKFormats(SINT, 16) break;
case DataFormat::UInt16:
VKFormats(UINT, 16) break;
case DataFormat::Int32:
VKFormats(SINT, 32) break;
case DataFormat::UInt32:
VKFormats(UINT, 32) break;
case DataFormat::Float32:
VKFormats(SFLOAT, 32) break;
case DataFormat::Int64:
VKFormats(SINT, 64) break;
case DataFormat::UInt64:
VKFormats(UINT, 64) break;
case DataFormat::Float64:
VKFormats(SFLOAT, 64) break;
case DataFormat::Depth32:
if (Channels != 1)
llvm_unreachable("Depth32 format only supports a single channel.");
return VK_FORMAT_D32_SFLOAT;
default:
llvm_unreachable("Unsupported Resource format specified");
}
return VK_FORMAT_UNDEFINED;
}
static VkDescriptorType getDescriptorType(const ResourceKind RK) {
switch (RK) {
case ResourceKind::Buffer:
return VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER;
case ResourceKind::RWBuffer:
return VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER;
case ResourceKind::Texture2D:
return VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE;
case ResourceKind::RWTexture2D:
return VK_DESCRIPTOR_TYPE_STORAGE_IMAGE;
case ResourceKind::ByteAddressBuffer:
case ResourceKind::RWByteAddressBuffer:
case ResourceKind::StructuredBuffer:
case ResourceKind::RWStructuredBuffer:
return VK_DESCRIPTOR_TYPE_STORAGE_BUFFER;
case ResourceKind::ConstantBuffer:
return VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER;
case ResourceKind::Sampler:
return VK_DESCRIPTOR_TYPE_SAMPLER;
case ResourceKind::SampledTexture2D:
return VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER;
case ResourceKind::AccelerationStructure:
return VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR;
}
llvm_unreachable("All cases handled");
}
static VkFilter getVKFilter(FilterMode Mode) {
switch (Mode) {
case FilterMode::Nearest:
return VK_FILTER_NEAREST;
case FilterMode::Linear:
return VK_FILTER_LINEAR;
}
llvm_unreachable("All filter cases handled");
}
static VkSamplerAddressMode getVKAddressMode(AddressMode Mode) {
switch (Mode) {
case AddressMode::Clamp:
return VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE;
case AddressMode::Repeat:
return VK_SAMPLER_ADDRESS_MODE_REPEAT;
case AddressMode::Mirror:
return VK_SAMPLER_ADDRESS_MODE_MIRRORED_REPEAT;
case AddressMode::Border:
return VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER;
case AddressMode::MirrorOnce:
return VK_SAMPLER_ADDRESS_MODE_MIRROR_CLAMP_TO_EDGE;
}
llvm_unreachable("All address mode cases handled");
}
static VkCompareOp getVKCompareOp(CompareFunction Func) {
switch (Func) {
case CompareFunction::Never:
return VK_COMPARE_OP_NEVER;
case CompareFunction::Less:
return VK_COMPARE_OP_LESS;
case CompareFunction::Equal:
return VK_COMPARE_OP_EQUAL;
case CompareFunction::LessEqual:
return VK_COMPARE_OP_LESS_OR_EQUAL;
case CompareFunction::Greater:
return VK_COMPARE_OP_GREATER;
case CompareFunction::NotEqual:
return VK_COMPARE_OP_NOT_EQUAL;
case CompareFunction::GreaterEqual:
return VK_COMPARE_OP_GREATER_OR_EQUAL;
case CompareFunction::Always:
return VK_COMPARE_OP_ALWAYS;
}
llvm_unreachable("All compare op cases handled");
}
static VkBufferUsageFlagBits getFlagBits(const ResourceKind RK) {
switch (RK) {
case ResourceKind::Buffer:
return VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT;
case ResourceKind::RWBuffer:
return VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT;
case ResourceKind::ByteAddressBuffer:
case ResourceKind::RWByteAddressBuffer:
case ResourceKind::StructuredBuffer:
case ResourceKind::RWStructuredBuffer:
return VK_BUFFER_USAGE_STORAGE_BUFFER_BIT;
case ResourceKind::ConstantBuffer:
return VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT;
case ResourceKind::Texture2D:
case ResourceKind::RWTexture2D:
case ResourceKind::Sampler:
case ResourceKind::SampledTexture2D:
case ResourceKind::AccelerationStructure:
llvm_unreachable(
"Textures, samplers, and AS don't have buffer usage bits!");
}
llvm_unreachable("All cases handled");
}
static VkImageViewType getImageViewType(const ResourceKind RK) {
switch (RK) {
case ResourceKind::Texture2D:
case ResourceKind::RWTexture2D:
case ResourceKind::SampledTexture2D:
return VK_IMAGE_VIEW_TYPE_2D;
case ResourceKind::Buffer:
case ResourceKind::RWBuffer:
case ResourceKind::ByteAddressBuffer:
case ResourceKind::RWByteAddressBuffer:
case ResourceKind::StructuredBuffer:
case ResourceKind::RWStructuredBuffer:
case ResourceKind::ConstantBuffer:
case ResourceKind::Sampler:
case ResourceKind::AccelerationStructure:
llvm_unreachable("Not an image view!");
}
llvm_unreachable("All cases handled");
}
static VkImageType getVKImageType(const ResourceKind RK) {
switch (RK) {
case ResourceKind::Texture2D:
case ResourceKind::RWTexture2D:
case ResourceKind::SampledTexture2D:
return VK_IMAGE_TYPE_2D;
default:
llvm_unreachable("Unsupported image kind");
}
llvm_unreachable("All cases handled");
}
static VkShaderStageFlagBits getShaderStageFlag(Stages Stage) {
switch (Stage) {
case Stages::Compute:
return VK_SHADER_STAGE_COMPUTE_BIT;
case Stages::Vertex:
return VK_SHADER_STAGE_VERTEX_BIT;
case Stages::Hull:
return VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT;
case Stages::Domain:
return VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT;
case Stages::Geometry:
return VK_SHADER_STAGE_GEOMETRY_BIT;
case Stages::Pixel:
return VK_SHADER_STAGE_FRAGMENT_BIT;
case Stages::Amplification:
return VK_SHADER_STAGE_TASK_BIT_EXT;
case Stages::Mesh:
return VK_SHADER_STAGE_MESH_BIT_EXT;
}
llvm_unreachable("All cases handled");
}
static VkPrimitiveTopology getVkPrimitiveTopology(PrimitiveTopology Topology) {
switch (Topology) {
case PrimitiveTopology::TriangleList:
return VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST;
case PrimitiveTopology::PointList:
return VK_PRIMITIVE_TOPOLOGY_POINT_LIST;
case PrimitiveTopology::PatchList:
return VK_PRIMITIVE_TOPOLOGY_PATCH_LIST;
}
llvm_unreachable("All PrimitiveTopology cases handled");
}
static std::string getMessageSeverityString(
VkDebugUtilsMessageSeverityFlagBitsEXT MessageSeverity) {
if (MessageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT)
return "Error";
if (MessageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT)
return "Warning";
if (MessageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_INFO_BIT_EXT)
return "Info";
if (MessageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_VERBOSE_BIT_EXT)
return "Verbose";
return "Unknown";
}
static VkBool32
debugCallback(VkDebugUtilsMessageSeverityFlagBitsEXT MessageSeverity,
VkDebugUtilsMessageTypeFlagsEXT MessageType,
const VkDebugUtilsMessengerCallbackDataEXT *Data, void *) {
// Only interested in messages from the validation layers.
if (!(MessageType & VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT))
return VK_FALSE;
llvm::dbgs() << "Validation " << getMessageSeverityString(MessageSeverity);
llvm::dbgs() << ": [ " << Data->pMessageIdName << " ]\n";
llvm::dbgs() << Data->pMessage;
for (uint32_t I = 0; I < Data->objectCount; I++) {
llvm::dbgs() << '\n';
if (Data->pObjects[I].pObjectName) {
llvm::dbgs() << "[" << Data->pObjects[I].pObjectName << "]";
}
}
llvm::dbgs() << '\n';
// Return true to turn the validation error or warning into an error in the
// vulkan API. This should causes tests to fail.
const bool IsErrorOrWarning =
MessageSeverity & (VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT |
VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT);
if (IsErrorOrWarning)
return VK_TRUE;
// Continue to run even with VERBOSE and INFO messages.
return VK_FALSE;
}
static VkDebugUtilsMessengerEXT registerDebugUtilCallback(VkInstance Instance) {
VkDebugUtilsMessengerCreateInfoEXT CreateInfo = {};
CreateInfo.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXT;
CreateInfo.messageSeverity = VK_DEBUG_UTILS_MESSAGE_SEVERITY_VERBOSE_BIT_EXT |
VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT |
VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT;
CreateInfo.messageType = VK_DEBUG_UTILS_MESSAGE_TYPE_GENERAL_BIT_EXT |
VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT |
VK_DEBUG_UTILS_MESSAGE_TYPE_PERFORMANCE_BIT_EXT;
CreateInfo.pfnUserCallback = debugCallback;
CreateInfo.pUserData = nullptr; // Optional
auto Func = (PFN_vkCreateDebugUtilsMessengerEXT)vkGetInstanceProcAddr(
Instance, "vkCreateDebugUtilsMessengerEXT");
if (Func == nullptr)
return VK_NULL_HANDLE;
VkDebugUtilsMessengerEXT DebugMessenger;
Func(Instance, &CreateInfo, nullptr, &DebugMessenger);
return DebugMessenger;
}
static llvm::Expected<uint32_t>
getMemoryIndex(VkPhysicalDevice Device, uint32_t MemoryTypeBits,
VkMemoryPropertyFlags MemoryFlags) {
VkPhysicalDeviceMemoryProperties MemProperties;
vkGetPhysicalDeviceMemoryProperties(Device, &MemProperties);
for (uint32_t I = 0; I < MemProperties.memoryTypeCount; ++I) {
const uint32_t Bit = (1u << I);
if ((MemoryTypeBits & Bit) == 0)
continue;
if ((MemProperties.memoryTypes[I].propertyFlags & MemoryFlags) ==
MemoryFlags)
return I;
}
return llvm::createStringError(std::errc::not_enough_memory,
"Could not identify appropriate memory.");
}
static llvm::SmallVector<VkLayerProperties, 0> queryInstanceLayers() {
uint32_t LayerCount;
vkEnumerateInstanceLayerProperties(&LayerCount, nullptr);
llvm::SmallVector<VkLayerProperties, 0> Layers;
if (LayerCount == 0)
return Layers;
Layers.resize(LayerCount);
vkEnumerateInstanceLayerProperties(&LayerCount, Layers.data());
return Layers;
}
static bool
isLayerSupported(const llvm::SmallVector<VkLayerProperties, 0> &Layers,
llvm::StringRef QueryName) {
for (auto &Layer : Layers) {
if (Layer.layerName == QueryName)
return true;
}
return false;
}
static llvm::SmallVector<VkExtensionProperties, 0>
queryInstanceExtensions(const char *InstanceLayer) {
uint32_t ExtCount;
vkEnumerateInstanceExtensionProperties(InstanceLayer, &ExtCount, nullptr);
llvm::SmallVector<VkExtensionProperties, 0> Extensions;
if (ExtCount == 0)
return Extensions;
Extensions.resize(ExtCount);
vkEnumerateInstanceExtensionProperties(nullptr, &ExtCount, Extensions.data());
return Extensions;
}
static llvm::SmallVector<VkExtensionProperties, 0>
queryDeviceExtensions(VkPhysicalDevice PhysicalDevice) {
uint32_t ExtCount;
vkEnumerateDeviceExtensionProperties(PhysicalDevice, nullptr, &ExtCount,
nullptr);
llvm::SmallVector<VkExtensionProperties, 0> Extensions;
if (ExtCount == 0)
return Extensions;
Extensions.resize(ExtCount);
vkEnumerateDeviceExtensionProperties(PhysicalDevice, nullptr, &ExtCount,
Extensions.data());
return Extensions;
}
static bool isExtensionSupported(
const llvm::SmallVector<VkExtensionProperties, 0> &Extensions,
llvm::StringRef QueryName) {
for (const auto &Ext : Extensions) {
if (Ext.extensionName == QueryName)
return true;
}
return false;
}
struct VulkanInstance {
VkInstance Instance;
VkDebugUtilsMessengerEXT DebugMessenger;
VulkanInstance(VkInstance Instance, VkDebugUtilsMessengerEXT DebugMessenger)
: Instance(Instance), DebugMessenger(DebugMessenger) {}
VulkanInstance(const VulkanInstance &) = delete;
VulkanInstance(VulkanInstance &&) = delete;
VulkanInstance &operator=(const VulkanInstance &) = delete;
VulkanInstance &operator=(VulkanInstance &&) = delete;
~VulkanInstance() {
if (DebugMessenger) {
auto Func = (PFN_vkDestroyDebugUtilsMessengerEXT)vkGetInstanceProcAddr(
Instance, "vkDestroyDebugUtilsMessengerEXT");
assert(Func != nullptr);
Func(Instance, DebugMessenger, nullptr);
}
vkDestroyInstance(Instance, nullptr);
}
};
namespace {
struct MeshShaderFunctions {
PFN_vkCmdDrawMeshTasksEXT VkCmdDrawMeshTasksEXT = nullptr;
static MeshShaderFunctions create(VkDevice Device) {
MeshShaderFunctions Result;
Result.VkCmdDrawMeshTasksEXT =
(PFN_vkCmdDrawMeshTasksEXT)vkGetDeviceProcAddr(Device,
"vkCmdDrawMeshTasksEXT");
return Result;
}
};
class VulkanBuffer : public offloadtest::Buffer {
public:
VkDevice Dev; // Needed for clean-up
VkBuffer Buffer;
VkDeviceMemory Memory;
VkDeviceAddress DeviceAddress;
std::string Name;
BufferCreateDesc Desc;
size_t SizeInBytes;
VulkanBuffer(VkDevice Dev, VkBuffer Buffer, VkDeviceMemory Memory,
VkDeviceAddress DeviceAddress, llvm::StringRef Name,
BufferCreateDesc Desc, size_t SizeInBytes)
: offloadtest::Buffer(GPUAPI::Vulkan), Dev(Dev), Buffer(Buffer),
Memory(Memory), DeviceAddress(DeviceAddress), Name(Name), Desc(Desc),
SizeInBytes(SizeInBytes) {}
size_t getSizeInBytes() const override { return SizeInBytes; }
llvm::Expected<void *> map() override {
if (Desc.Location == MemoryLocation::GpuOnly)
return llvm::createStringError(std::errc::invalid_argument,
"Cannot map a GpuOnly buffer.");
void *Ptr = nullptr;
if (vkMapMemory(Dev, Memory, 0, SizeInBytes, 0, &Ptr) != VK_SUCCESS)
return llvm::createStringError(std::errc::io_error,
"Failed to map buffer.");
// HOST_CACHED memory that is *not* HOST_COHERENT (GpuToCpu) needs explicit
// invalidation so the CPU sees the GPU-side writes.
if (Desc.Location == MemoryLocation::GpuToCpu) {
VkMappedMemoryRange Range = {};
Range.sType = VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE;
Range.memory = Memory;
Range.offset = 0;
Range.size = VK_WHOLE_SIZE;
vkInvalidateMappedMemoryRanges(Dev, 1, &Range);
}
return Ptr;
}
void unmap() override { vkUnmapMemory(Dev, Memory); }
~VulkanBuffer() override {
vkDestroyBuffer(Dev, Buffer, nullptr);
vkFreeMemory(Dev, Memory, nullptr);
}
// Only valid when the buffer was created with VK_BUFFER_USAGE_SHADER_DEVICE_
// ADDRESS_BIT, which the device adds whenever ray tracing is supported.
VkDeviceAddress getDeviceAddress() const { return DeviceAddress; }
static bool classof(const offloadtest::Buffer *B) {
return B->getAPI() == GPUAPI::Vulkan;
}
};
class VulkanTexture : public offloadtest::Texture {
public:
VkDevice Dev;
VkImage Image;
VkDeviceMemory Memory;
// TODO:
// RenderTarget and DepthStencil views are created at texture creation time.
// Ideally Sampled/Storage image views would also live here, but they are
// currently created during descriptor set setup, which determines their
// binding layout.
VkImageView View = VK_NULL_HANDLE;
std::string Name;
TextureCreateDesc Desc;
VkImageLayout PreferredLayout = VK_IMAGE_LAYOUT_GENERAL;
VkImageSubresourceRange FullRange;
bool IsInUndefinedLayout = true;
VulkanTexture(VkDevice Dev, VkImage Image, VkDeviceMemory Memory,
llvm::StringRef Name, TextureCreateDesc Desc,
VkImageLayout PreferredLayout,
VkImageSubresourceRange FullRange)
: offloadtest::Texture(GPUAPI::Vulkan), Dev(Dev), Image(Image),
Memory(Memory), Name(Name), Desc(Desc),
PreferredLayout(PreferredLayout), FullRange(FullRange) {}
~VulkanTexture() override {
if (View)
vkDestroyImageView(Dev, View, nullptr);
vkDestroyImage(Dev, Image, nullptr);
vkFreeMemory(Dev, Memory, nullptr);
}
VkImageLayout preferredLayoutOrUndefined() {
return IsInUndefinedLayout ? VK_IMAGE_LAYOUT_UNDEFINED : PreferredLayout;
}
const TextureCreateDesc &getDesc() const override { return Desc; }
static bool classof(const offloadtest::Texture *T) {
return T->getAPI() == GPUAPI::Vulkan;
}
};
class VulkanAccelerationStructure : public offloadtest::AccelerationStructure {
public:
VkDevice Dev;
VkAccelerationStructureKHR AccelStruct;
VkBuffer Buffer;
VkDeviceMemory Memory;
VkDeviceAddress DeviceAddress;
PFN_vkDestroyAccelerationStructureKHR FnDestroyAS;
VulkanAccelerationStructure(VkDevice Dev,
VkAccelerationStructureKHR AccelStruct,
VkBuffer Buffer, VkDeviceMemory Memory,
VkDeviceAddress DeviceAddress,
PFN_vkDestroyAccelerationStructureKHR FnDestroyAS,
const AccelerationStructureSizes &Sizes)
: offloadtest::AccelerationStructure(GPUAPI::Vulkan, Sizes), Dev(Dev),
AccelStruct(AccelStruct), Buffer(Buffer), Memory(Memory),
DeviceAddress(DeviceAddress), FnDestroyAS(FnDestroyAS) {}
~VulkanAccelerationStructure() override {
if (AccelStruct != VK_NULL_HANDLE)
FnDestroyAS(Dev, AccelStruct, nullptr);
if (Buffer != VK_NULL_HANDLE)
vkDestroyBuffer(Dev, Buffer, nullptr);
if (Memory != VK_NULL_HANDLE)
vkFreeMemory(Dev, Memory, nullptr);
}
VkDeviceAddress getDeviceAddress() const { return DeviceAddress; }
static bool classof(const offloadtest::AccelerationStructure *AS) {
return AS->getAPI() == GPUAPI::Vulkan;
}
};
class VulkanFence : public offloadtest::Fence {
public:
VulkanFence(VkDevice Device, VkSemaphore Semaphore, llvm::StringRef Name)
: Name(Name), Device(Device), Semaphore(Semaphore) {}
std::string Name;
VkDevice Device;
VkSemaphore Semaphore;
static llvm::Expected<std::unique_ptr<VulkanFence>>
create(VkDevice Device, llvm::StringRef Name) {
VkSemaphoreTypeCreateInfo TypeCreateInfo = {};
TypeCreateInfo.sType = VK_STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO;
TypeCreateInfo.semaphoreType = VK_SEMAPHORE_TYPE_TIMELINE;
VkSemaphoreCreateInfo CreateInfo = {};
CreateInfo.sType = VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO;
CreateInfo.pNext = &TypeCreateInfo;
VkSemaphore Semaphore = VK_NULL_HANDLE;
if (auto Err = VK::toError(
vkCreateSemaphore(Device, &CreateInfo, nullptr, &Semaphore),
"Failed to create Semaphore."))
return Err;
return std::make_unique<VulkanFence>(Device, Semaphore, Name);
}
~VulkanFence() { vkDestroySemaphore(Device, Semaphore, nullptr); }
uint64_t getFenceValue() override {
uint64_t Value = 0;
[[maybe_unused]] const VkResult Ret =
vkGetSemaphoreCounterValue(Device, Semaphore, &Value);
assert(!Ret && "vkGetSemaphoreCounterValue failed but should never fail.");
return Value;
}
llvm::Error waitForCompletion(uint64_t SignalValue) override {
VkSemaphoreWaitInfo WaitInfo = {};
WaitInfo.sType = VK_STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO;
WaitInfo.semaphoreCount = 1;
WaitInfo.pSemaphores = &Semaphore;
WaitInfo.pValues = &SignalValue;
if (auto Err = VK::toError(vkWaitSemaphores(Device, &WaitInfo, UINT64_MAX),
"Failed to wait on Semaphore."))
return Err;
return llvm::Error::success();
}
};
class VulkanQueue : public offloadtest::Queue {
public:
using Queue::submit;
VkQueue Queue = VK_NULL_HANDLE;
uint32_t QueueFamilyIdx = 0;
// TODO: Ensure device lifetime is managed (e.g. via shared_ptr).
VkDevice Device = VK_NULL_HANDLE;
std::unique_ptr<VulkanFence> SubmitFence;
uint64_t FenceCounter = 0;
// Batches of command buffers submitted to the GPU that may still be
// in-flight. VulkanCommandBuffer's destructor destroys the VkCommandPool,
// which would invalidate any still-pending command buffers. Each batch
// records the fence value it signals so we can non-blockingly query
// progress and release completed batches.
struct InFlightBatch {
uint64_t FenceValue;
llvm::SmallVector<std::unique_ptr<offloadtest::CommandBuffer>> CBs;
};
llvm::SmallVector<InFlightBatch> InFlightBatches;
VulkanQueue(VkQueue Q, uint32_t QueueFamilyIdx, VkDevice Device,
std::unique_ptr<VulkanFence> SubmitFence)
: Queue(Q), QueueFamilyIdx(QueueFamilyIdx), Device(Device),
SubmitFence(std::move(SubmitFence)) {}
llvm::Expected<offloadtest::SubmitResult>
submit(llvm::SmallVector<std::unique_ptr<offloadtest::CommandBuffer>> CBs)
override;
};
class VulkanDevice; // forward decl — defined below in this same anon ns
class VulkanCommandBuffer : public offloadtest::CommandBuffer {
public:
VkDevice Device = VK_NULL_HANDLE;
MeshShaderFunctions MeshShaderFns;
// Back-pointer to the owning device. Used by encoders that need access to
// device-loaded function pointers (e.g. ray-tracing entry points) and
// helper allocators.
VulkanDevice *Dev = nullptr;
// Owned per command buffer so that recording, submission, and lifetime
// management of each command buffer are independently safe without external
// synchronization.
VkCommandPool CmdPool = VK_NULL_HANDLE;
VkCommandBuffer CmdBuffer = VK_NULL_HANDLE;
PFN_vkCmdBeginDebugUtilsLabelEXT CmdBeginDebugUtilsLabel = nullptr;
PFN_vkCmdEndDebugUtilsLabelEXT CmdEndDebugUtilsLabel = nullptr;
PFN_vkCmdInsertDebugUtilsLabelEXT CmdInsertDebugUtilsLabel = nullptr;
/// Keep-alive list for Framebuffers constructed by RencderEncoders.
llvm::SmallVector<VkFramebuffer, 4> OwnedFramebuffers;
static llvm::Expected<std::unique_ptr<VulkanCommandBuffer>>
create(VkDevice Device, uint32_t QueueFamilyIdx,
PFN_vkCmdBeginDebugUtilsLabelEXT CmdBeginDebugUtilsLabel,
PFN_vkCmdEndDebugUtilsLabelEXT CmdEndDebugUtilsLabel,
PFN_vkCmdInsertDebugUtilsLabelEXT CmdInsertDebugUtilsLabel,
MeshShaderFunctions MeshShaderFns) {
auto CB = std::unique_ptr<VulkanCommandBuffer>(new VulkanCommandBuffer());
CB->Device = Device;
VkCommandPoolCreateInfo CmdPoolInfo = {};
CmdPoolInfo.sType = VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO;
CmdPoolInfo.queueFamilyIndex = QueueFamilyIdx;
CmdPoolInfo.flags = VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT;
if (auto Err = VK::toError(
vkCreateCommandPool(Device, &CmdPoolInfo, nullptr, &CB->CmdPool),
"Could not create command pool."))
return Err;
VkCommandBufferAllocateInfo CBufAllocInfo = {};
CBufAllocInfo.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO;
CBufAllocInfo.commandPool = CB->CmdPool;
CBufAllocInfo.level = VK_COMMAND_BUFFER_LEVEL_PRIMARY;
CBufAllocInfo.commandBufferCount = 1;
if (auto Err = VK::toError(
vkAllocateCommandBuffers(Device, &CBufAllocInfo, &CB->CmdBuffer),
"Could not create command buffer."))
return Err;
VkCommandBufferBeginInfo BufferInfo = {};
BufferInfo.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO;
if (auto Err = VK::toError(vkBeginCommandBuffer(CB->CmdBuffer, &BufferInfo),
"Could not begin command buffer."))
return Err;
CB->CmdBeginDebugUtilsLabel = CmdBeginDebugUtilsLabel;
CB->CmdEndDebugUtilsLabel = CmdEndDebugUtilsLabel;
CB->CmdInsertDebugUtilsLabel = CmdInsertDebugUtilsLabel;
CB->MeshShaderFns = MeshShaderFns;
return CB;
}
/// Pending pipeline barrier state accumulated by encoders. Lives on the
/// command buffer because in Vulkan all encoders record into the same
/// VkCommandBuffer. Src tracks what prior commands produced; Dst tracks
/// what the next command will consume.
VkPipelineStageFlags PendingSrcStage = VK_PIPELINE_STAGE_HOST_BIT;
VkAccessFlags PendingSrcAccess = VK_ACCESS_HOST_WRITE_BIT;
VkPipelineStageFlags PendingDstStage = 0;
VkAccessFlags PendingDstAccess = 0;
llvm::SmallVector<VkImageMemoryBarrier> PendingImageTransitions;
void addImageTransition(VkAccessFlags SrcAccessMask,
VkAccessFlags DstAccessMask, VkImageLayout OldLayout,
VkImageLayout NewLayout, VulkanTexture &Texture) {
assert(
NewLayout != VK_IMAGE_LAYOUT_UNDEFINED &&
"There should be no reason to ever transition to an undefined layout.");
PendingImageTransitions.push_back(VkImageMemoryBarrier{
VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER, /*sType*/
nullptr, /*pNext*/
SrcAccessMask,
DstAccessMask,
OldLayout,
NewLayout,
0, /*srcQueueFamilyIndex*/
0, /*dstQueueFamilyIndex*/
Texture.Image,
Texture.FullRange,
});
Texture.IsInUndefinedLayout = false;
}
void addPendingBarrier(VkPipelineStageFlags Stage, VkAccessFlags Access) {
PendingDstStage |= Stage;
PendingDstAccess |= Access;
}
void flushBarrier() {
if (PendingSrcStage != 0 || !PendingImageTransitions.empty()) {
VkMemoryBarrier Barrier = {};
Barrier.sType = VK_STRUCTURE_TYPE_MEMORY_BARRIER;
Barrier.srcAccessMask = PendingSrcAccess;
Barrier.dstAccessMask = PendingDstAccess;
vkCmdPipelineBarrier(CmdBuffer, PendingSrcStage, PendingDstStage, 0, 1,
&Barrier, 0, nullptr, PendingImageTransitions.size(),
PendingImageTransitions.size() == 0
? nullptr
: PendingImageTransitions.data());
PendingImageTransitions.clear();
}
PendingSrcStage = PendingDstStage;
PendingSrcAccess = PendingDstAccess;
PendingDstStage = 0;
PendingDstAccess = 0;
}
void pushDebugGroup(llvm::StringRef Label) {
if (!CmdBeginDebugUtilsLabel)
return;
VkDebugUtilsLabelEXT LabelInfo = {};
LabelInfo.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_LABEL_EXT;
LabelInfo.pLabelName = Label.data();
CmdBeginDebugUtilsLabel(CmdBuffer, &LabelInfo);
}
void popDebugGroup() {
if (CmdEndDebugUtilsLabel)
CmdEndDebugUtilsLabel(CmdBuffer);
}
void insertDebugSignpost(llvm::StringRef Label) {
if (!CmdInsertDebugUtilsLabel)
return;
VkDebugUtilsLabelEXT LabelInfo = {};
LabelInfo.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_LABEL_EXT;
LabelInfo.pLabelName = Label.data();
CmdInsertDebugUtilsLabel(CmdBuffer, &LabelInfo);
}
/// Abstract-API Buffer wrappers (e.g. AS scratch and TLAS instance array
/// buffers) that must outlive submission. Held as unique_ptr so the wrapper
/// destructor frees both the VkBuffer and VkDeviceMemory.
llvm::SmallVector<std::unique_ptr<offloadtest::Buffer>> KeepAliveOwned;
~VulkanCommandBuffer() override {
for (VkFramebuffer FB : OwnedFramebuffers)
vkDestroyFramebuffer(Device, FB, nullptr);
if (CmdPool != VK_NULL_HANDLE)
vkDestroyCommandPool(Device, CmdPool, nullptr);
}
static bool classof(const CommandBuffer *CB) {
return CB->getKind() == GPUAPI::Vulkan;
}
llvm::Expected<std::unique_ptr<offloadtest::ComputeEncoder>>
createComputeEncoder() override;
llvm::Expected<std::unique_ptr<offloadtest::RenderEncoder>>
createRenderEncoder(const offloadtest::RenderPassBeginDesc &Desc) override;
private:
VulkanCommandBuffer() : CommandBuffer(GPUAPI::Vulkan) {}
};
class VulkanPipelineState : public offloadtest::PipelineState {
public:
std::string Name;
VkDevice Dev;
VkPipeline Pipeline;
VkPipelineLayout Layout;
llvm::SmallVector<VkDescriptorSetLayout> SetLayouts;
VulkanPipelineState(llvm::StringRef Name, VkDevice Dev, VkPipeline Pipeline,
VkPipelineLayout Layout,
llvm::SmallVector<VkDescriptorSetLayout> SetLayouts)
: offloadtest::PipelineState(GPUAPI::Vulkan), Name(Name.str()), Dev(Dev),
Pipeline(Pipeline), Layout(Layout), SetLayouts(std::move(SetLayouts)) {}
~VulkanPipelineState() override {
vkDestroyPipeline(Dev, Pipeline, nullptr);
vkDestroyPipelineLayout(Dev, Layout, nullptr);
for (VkDescriptorSetLayout L : SetLayouts)
vkDestroyDescriptorSetLayout(Dev, L, nullptr);
}
static bool classof(const offloadtest::PipelineState *B) {
return B->getAPI() == GPUAPI::Vulkan;
}
};
class VKComputeEncoder : public offloadtest::ComputeEncoder {
VulkanCommandBuffer &CB;
void addDstBarrier(VkPipelineStageFlags DstStage, VkAccessFlags DstAccess) {
CB.addPendingBarrier(DstStage, DstAccess);
CB.flushBarrier();
}
public:
VKComputeEncoder(VulkanCommandBuffer &CB)
: ComputeEncoder(GPUAPI::Vulkan), CB(CB) {}
~VKComputeEncoder() override { endEncoding(); }
static bool classof(const CommandEncoder *E) {
return E->getAPI() == GPUAPI::Vulkan;
}
void pushDebugGroup(llvm::StringRef Label) override {
CB.pushDebugGroup(Label);
}
void popDebugGroup() override { CB.popDebugGroup(); }
void insertDebugSignpost(llvm::StringRef Label) override {
CB.insertDebugSignpost(Label);
}
llvm::Error dispatch(const offloadtest::PipelineState &PSO,
uint32_t GroupCountX, uint32_t GroupCountY,
uint32_t GroupCountZ) override {
const auto &VKPSO = llvm::cast<VulkanPipelineState>(PSO);
// Include AS_READ so dispatches that issue RayQuery against a TLAS get a
// proper hand-off from the prior AS-build's AS_WRITE.
addDstBarrier(VK_PIPELINE_STAGE_COMPUTE_SHADER_BIT,
VK_ACCESS_SHADER_WRITE_BIT | VK_ACCESS_SHADER_READ_BIT |
VK_ACCESS_ACCELERATION_STRUCTURE_READ_BIT_KHR);
insertDebugSignpost(llvm::formatv("Dispatch [{0},{1},{2}]", GroupCountX,
GroupCountY, GroupCountZ)
.str());
vkCmdBindPipeline(CB.CmdBuffer, VK_PIPELINE_BIND_POINT_COMPUTE,
VKPSO.Pipeline);
vkCmdDispatch(CB.CmdBuffer, GroupCountX, GroupCountY, GroupCountZ);
return llvm::Error::success();
}
llvm::Error copyBufferToBuffer(offloadtest::Buffer &Src, size_t SrcOffset,
offloadtest::Buffer &Dst, size_t DstOffset,
size_t Size) override {
auto &VKSrc = static_cast<VulkanBuffer &>(Src);
auto &VKDst = static_cast<VulkanBuffer &>(Dst);
VkBufferCopy Region = {};
Region.srcOffset = SrcOffset;
Region.dstOffset = DstOffset;
Region.size = Size;
addDstBarrier(VK_PIPELINE_STAGE_TRANSFER_BIT, VK_ACCESS_TRANSFER_WRITE_BIT);
insertDebugSignpost(llvm::formatv("CopyBuffer {0}B", Size).str());
vkCmdCopyBuffer(CB.CmdBuffer, VKSrc.Buffer, VKDst.Buffer, 1, &Region);
return llvm::Error::success();
}
llvm::Error copyBufferToTexture(offloadtest::Buffer &Src,
offloadtest::Texture &Dst) override {
auto &VKSrc = llvm::cast<VulkanBuffer>(Src);
auto &VKDst = llvm::cast<VulkanTexture>(Dst);
CB.addImageTransition(CB.PendingSrcAccess, /*SrcAccessMask*/
VK_ACCESS_TRANSFER_WRITE_BIT, /*DstAccessMask*/
VKDst.preferredLayoutOrUndefined(), /*OldLayout*/
VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, /*NewLayout*/
VKDst);
VKDst.IsInUndefinedLayout = false;
CB.addPendingBarrier(VK_PIPELINE_STAGE_TRANSFER_BIT,
VK_ACCESS_TRANSFER_READ_BIT |
VK_ACCESS_TRANSFER_WRITE_BIT);
CB.flushBarrier();
insertDebugSignpost(
llvm::formatv("copyTextureToBuffer {0} -> {1}", VKSrc.Name, VKDst.Name)
.str());
vkCmdCopyBufferToImage(CB.CmdBuffer, VKSrc.Buffer, VKDst.Image,
VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, 0, nullptr);
CB.addImageTransition(VK_ACCESS_TRANSFER_WRITE_BIT, /*SrcAccessMask*/
VK_ACCESS_NONE, /*DstAccessMask*/
VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, /*OldLayout*/
VKDst.preferredLayoutOrUndefined(), /*NewLayout*/
VKDst);
return llvm::Error::success();
}
// Defined out-of-line below — needs VulkanDevice's full type for access to
// the device-loaded ray-tracing entry points and helpers.
llvm::Error batchBuildAS(llvm::ArrayRef<ASBuildItem> Items) override;
void endEncodingImpl() override { popDebugGroup(); }
};
llvm::Expected<std::unique_ptr<offloadtest::ComputeEncoder>>
VulkanCommandBuffer::createComputeEncoder() {
auto Enc = std::make_unique<VKComputeEncoder>(*this);
Enc->pushDebugGroup("ComputeEncoder");
return Enc;
}
static VkAttachmentLoadOp getVkLoadOp(offloadtest::LoadAction Action) {
switch (Action) {
case offloadtest::LoadAction::Load:
return VK_ATTACHMENT_LOAD_OP_LOAD;
case offloadtest::LoadAction::Clear:
return VK_ATTACHMENT_LOAD_OP_CLEAR;
case offloadtest::LoadAction::DontCare:
return VK_ATTACHMENT_LOAD_OP_DONT_CARE;
}
llvm_unreachable("All LoadAction cases handled");
}
static VkAttachmentStoreOp getVkStoreOp(offloadtest::StoreAction Action) {
switch (Action) {
case offloadtest::StoreAction::Store:
return VK_ATTACHMENT_STORE_OP_STORE;
case offloadtest::StoreAction::DontCare:
return VK_ATTACHMENT_STORE_OP_DONT_CARE;
}
llvm_unreachable("All StoreAction cases handled");
}
class VulkanRenderPass final : public offloadtest::RenderPass {
public:
VkDevice Dev;
VkRenderPass Handle;
offloadtest::RenderPassDesc Desc;
VulkanRenderPass(VkDevice Dev, VkRenderPass Handle,
offloadtest::RenderPassDesc Desc)
: RenderPass(GPUAPI::Vulkan), Dev(Dev), Handle(Handle),
Desc(std::move(Desc)) {}
~VulkanRenderPass() override {
if (Handle != VK_NULL_HANDLE)
vkDestroyRenderPass(Dev, Handle, nullptr);
}
static bool classof(const offloadtest::RenderPass *RP) {
return RP->getAPI() == GPUAPI::Vulkan;
}
};
class VulkanRenderEncoder : public offloadtest::RenderEncoder {
VulkanCommandBuffer &CB;
offloadtest::RenderPassBeginDesc Desc;
// Encoder contract: viewport and scissor must both be set before draw().
bool ViewportSet = false;
bool ScissorSet = false;