Device and shader framework framework changes to support Metal argument buffers.
Add MVKPhysicalDeviceMetalFeatures::argumentBuffers.
Add MVKConfiguration::useMetalArgumentBuffers and
MVK_CONFIG_USE_METAL_ARGUMENT_BUFFERS env var.
MVKPhysicalDevice and MVKDeviceTrackingMixin add isUsingMetalArgumentBuffers().
Populate VkPhysicalDeviceDescriptorIndexingPropertiesEXT with larger Tier2
limits when supported.
Populate pipelineCacheUUID with feature flag if Metal arg buffers are used.
SPIRVToMSLConversionConfiguration add content to extract shader texture types
and mark discrete descriptor sets.
diff --git a/MoltenVK/MoltenVK/API/vk_mvk_moltenvk.h b/MoltenVK/MoltenVK/API/vk_mvk_moltenvk.h
index 7a90a4d..dcc8619 100644
--- a/MoltenVK/MoltenVK/API/vk_mvk_moltenvk.h
+++ b/MoltenVK/MoltenVK/API/vk_mvk_moltenvk.h
@@ -776,6 +776,25 @@
*/
MVKConfigAdvertiseExtensions advertiseExtensions;
+ /**
+ * Controls whether MoltenVK should use Metal argument buffers for resources defined in
+ * descriptor sets, if Metal argument buffers are supported on the platform. Using Metal
+ * argument buffers dramatically increases the number of buffers, textures and samplers
+ * that can be bound to a pipeline shader, and in most cases improves performance. If this
+ * setting is enabled, MoltenVK will use Metal argument buffers to bind resources to the
+ * shaders. If this setting is disabled, MoltenVK will bind resources to shaders discretely.
+ *
+ * The value of this parameter must be changed before creating a VkInstance,
+ * for the change to take effect.
+ *
+ * The initial value or this parameter is set by the
+ * MVK_CONFIG_USE_METAL_ARGUMENT_BUFFERS
+ * runtime environment variable or MoltenVK compile-time build setting.
+ * If neither is set, this setting is enabled by default, and MoltenVK
+ * will use Metal argument buffers.
+ */
+ VkBool32 useMetalArgumentBuffers;
+
} MVKConfiguration;
/**
@@ -855,6 +874,7 @@
uint32_t minSubgroupSize; /**< The minimum number of threads in a SIMD-group. */
VkBool32 textureBarriers; /**< If true, texture barriers are supported within Metal render passes. */
VkBool32 tileBasedDeferredRendering; /**< If true, this device uses tile-based deferred rendering. */
+ VkBool32 argumentBuffers; /**< If true, argument buffers are supported. */
} MVKPhysicalDeviceMetalFeatures;
/** MoltenVK performance of a particular type of activity. */
diff --git a/MoltenVK/MoltenVK/GPUObjects/MVKDescriptorSet.h b/MoltenVK/MoltenVK/GPUObjects/MVKDescriptorSet.h
index 4d69c35..bccb2ec 100644
--- a/MoltenVK/MoltenVK/GPUObjects/MVKDescriptorSet.h
+++ b/MoltenVK/MoltenVK/GPUObjects/MVKDescriptorSet.h
@@ -72,6 +72,9 @@
/** Returns true if this layout is for push descriptors only. */
bool isPushDescriptorLayout() const { return _isPushDescriptorLayout; }
+ /** Returns whether this layout is using an argument buffer. */
+ inline bool isUsingMetalArgumentBuffer() { return isUsingMetalArgumentBuffers() && !isPushDescriptorLayout(); };
+
MVKDescriptorSetLayout(MVKDevice* device, const VkDescriptorSetLayoutCreateInfo* pCreateInfo);
protected:
diff --git a/MoltenVK/MoltenVK/GPUObjects/MVKDescriptorSet.mm b/MoltenVK/MoltenVK/GPUObjects/MVKDescriptorSet.mm
index 7e233f1..d8145a0 100644
--- a/MoltenVK/MoltenVK/GPUObjects/MVKDescriptorSet.mm
+++ b/MoltenVK/MoltenVK/GPUObjects/MVKDescriptorSet.mm
@@ -166,6 +166,11 @@
for (uint32_t bindIdx = 0; bindIdx < bindCnt; bindIdx++) {
_bindings[bindIdx].populateShaderConverterContext(context, dslMTLRezIdxOffsets, dslIndex);
}
+
+ // Mark if Metal argument buffers are in use, but this descriptor set layout is not using them.
+ if (isUsingMetalArgumentBuffers() && !isUsingMetalArgumentBuffer()) {
+ context.discreteDescriptorSets.push_back(dslIndex);
+ }
}
MVKDescriptorSetLayout::MVKDescriptorSetLayout(MVKDevice* device,
diff --git a/MoltenVK/MoltenVK/GPUObjects/MVKDevice.h b/MoltenVK/MoltenVK/GPUObjects/MVKDevice.h
index b8b6dd3..ebd3bd8 100644
--- a/MoltenVK/MoltenVK/GPUObjects/MVKDevice.h
+++ b/MoltenVK/MoltenVK/GPUObjects/MVKDevice.h
@@ -18,6 +18,7 @@
#pragma once
+#include "MVKEnvironment.h"
#include "MVKFoundation.h"
#include "MVKVulkanAPIObject.h"
#include "MVKMTLResourceBindings.h"
@@ -325,6 +326,9 @@
/** Returns whether the MSL version is supported on this device. */
inline bool mslVersionIsAtLeast(MTLLanguageVersion minVer) { return _metalFeatures.mslVersionEnum >= minVer; }
+ /** Returns whether this device is using Metal argument buffers. */
+ inline bool isUsingMetalArgumentBuffers() const { return _metalFeatures.argumentBuffers && mvkConfig()->useMetalArgumentBuffers; };
+
#pragma mark Construction
@@ -848,6 +852,9 @@
/** Returns info about the pixel format supported by the physical device. */
inline MVKPixelFormats* getPixelFormats() { return _device->getPixelFormats(); }
+ /** Returns whether this device is using Metal argument buffers. */
+ inline bool isUsingMetalArgumentBuffers() { return getPhysicalDevice()->isUsingMetalArgumentBuffers(); };
+
/** Constructs an instance for the specified device. */
MVKDeviceTrackingMixin(MVKDevice* device) : _device(device) { assert(_device); }
diff --git a/MoltenVK/MoltenVK/GPUObjects/MVKDevice.mm b/MoltenVK/MoltenVK/GPUObjects/MVKDevice.mm
index d304fa0..9af9db9 100644
--- a/MoltenVK/MoltenVK/GPUObjects/MVKDevice.mm
+++ b/MoltenVK/MoltenVK/GPUObjects/MVKDevice.mm
@@ -375,6 +375,7 @@
break;
}
case VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_DESCRIPTOR_INDEXING_PROPERTIES_EXT: {
+ bool isTier2 = isUsingMetalArgumentBuffers() && (_mtlDevice.argumentBuffersSupport == MTLArgumentBuffersTier2);
auto* pDescIdxProps = (VkPhysicalDeviceDescriptorIndexingPropertiesEXT*)next;
pDescIdxProps->maxUpdateAfterBindDescriptorsInAllPools = kMVKUndefinedLargeUInt32;
pDescIdxProps->shaderUniformBufferArrayNonUniformIndexingNative = false;
@@ -384,20 +385,20 @@
pDescIdxProps->shaderInputAttachmentArrayNonUniformIndexingNative = _metalFeatures.arrayOfTextures;
pDescIdxProps->robustBufferAccessUpdateAfterBind = _features.robustBufferAccess;
pDescIdxProps->quadDivergentImplicitLod = false;
- pDescIdxProps->maxPerStageDescriptorUpdateAfterBindSamplers = _properties.limits.maxPerStageDescriptorSamplers;
- pDescIdxProps->maxPerStageDescriptorUpdateAfterBindUniformBuffers = _properties.limits.maxPerStageDescriptorUniformBuffers;
- pDescIdxProps->maxPerStageDescriptorUpdateAfterBindStorageBuffers = _properties.limits.maxPerStageDescriptorStorageBuffers;
- pDescIdxProps->maxPerStageDescriptorUpdateAfterBindSampledImages = _properties.limits.maxPerStageDescriptorSampledImages;
- pDescIdxProps->maxPerStageDescriptorUpdateAfterBindStorageImages = _properties.limits.maxPerStageDescriptorStorageImages;
+ pDescIdxProps->maxPerStageDescriptorUpdateAfterBindSamplers = isTier2 ? 2048 : _properties.limits.maxPerStageDescriptorSamplers;
+ pDescIdxProps->maxPerStageDescriptorUpdateAfterBindUniformBuffers = isTier2 ? 500000 : _properties.limits.maxPerStageDescriptorUniformBuffers;
+ pDescIdxProps->maxPerStageDescriptorUpdateAfterBindStorageBuffers = isTier2 ? 500000 : _properties.limits.maxPerStageDescriptorStorageBuffers;
+ pDescIdxProps->maxPerStageDescriptorUpdateAfterBindSampledImages = isTier2 ? 500000 : _properties.limits.maxPerStageDescriptorSampledImages;
+ pDescIdxProps->maxPerStageDescriptorUpdateAfterBindStorageImages = isTier2 ? 500000 : _properties.limits.maxPerStageDescriptorStorageImages;
pDescIdxProps->maxPerStageDescriptorUpdateAfterBindInputAttachments = _properties.limits.maxPerStageDescriptorInputAttachments;
- pDescIdxProps->maxPerStageUpdateAfterBindResources = _properties.limits.maxPerStageResources;
- pDescIdxProps->maxDescriptorSetUpdateAfterBindSamplers = _properties.limits.maxDescriptorSetSamplers;
- pDescIdxProps->maxDescriptorSetUpdateAfterBindUniformBuffers = _properties.limits.maxDescriptorSetUniformBuffers;
- pDescIdxProps->maxDescriptorSetUpdateAfterBindUniformBuffersDynamic = _properties.limits.maxDescriptorSetUniformBuffersDynamic;
- pDescIdxProps->maxDescriptorSetUpdateAfterBindStorageBuffers = _properties.limits.maxDescriptorSetStorageBuffers;
- pDescIdxProps->maxDescriptorSetUpdateAfterBindStorageBuffersDynamic = _properties.limits.maxDescriptorSetStorageBuffersDynamic;
- pDescIdxProps->maxDescriptorSetUpdateAfterBindSampledImages = _properties.limits.maxDescriptorSetSampledImages;
- pDescIdxProps->maxDescriptorSetUpdateAfterBindStorageImages = _properties.limits.maxDescriptorSetStorageImages;
+ pDescIdxProps->maxPerStageUpdateAfterBindResources = isTier2 ? 500000 : _properties.limits.maxPerStageResources;
+ pDescIdxProps->maxDescriptorSetUpdateAfterBindSamplers = isTier2 ? 2048 : _properties.limits.maxDescriptorSetSamplers;
+ pDescIdxProps->maxDescriptorSetUpdateAfterBindUniformBuffers = isTier2 ? 500000 : _properties.limits.maxDescriptorSetUniformBuffers;
+ pDescIdxProps->maxDescriptorSetUpdateAfterBindUniformBuffersDynamic = isTier2 ? 500000 : _properties.limits.maxDescriptorSetUniformBuffersDynamic;
+ pDescIdxProps->maxDescriptorSetUpdateAfterBindStorageBuffers = isTier2 ? 500000 : _properties.limits.maxDescriptorSetStorageBuffers;
+ pDescIdxProps->maxDescriptorSetUpdateAfterBindStorageBuffersDynamic = isTier2 ? 500000 : _properties.limits.maxDescriptorSetStorageBuffersDynamic;
+ pDescIdxProps->maxDescriptorSetUpdateAfterBindSampledImages = isTier2 ? 500000 : _properties.limits.maxDescriptorSetSampledImages;
+ pDescIdxProps->maxDescriptorSetUpdateAfterBindStorageImages = isTier2 ? 500000 : _properties.limits.maxDescriptorSetStorageImages;
pDescIdxProps->maxDescriptorSetUpdateAfterBindInputAttachments = _properties.limits.maxDescriptorSetInputAttachments;
break;
}
@@ -1205,6 +1206,7 @@
if (supportsMTLFeatureSet(tvOS_GPUFamily1_v3)) {
_metalFeatures.mslVersionEnum = MTLLanguageVersion2_0;
_metalFeatures.renderWithoutAttachments = true;
+ _metalFeatures.argumentBuffers = true;
}
if (supportsMTLFeatureSet(tvOS_GPUFamily1_v4)) {
@@ -1279,6 +1281,7 @@
if (supportsMTLFeatureSet(iOS_GPUFamily1_v4)) {
_metalFeatures.mslVersionEnum = MTLLanguageVersion2_0;
_metalFeatures.renderWithoutAttachments = true;
+ _metalFeatures.argumentBuffers = true;
}
if (supportsMTLFeatureSet(iOS_GPUFamily1_v5)) {
@@ -1387,6 +1390,7 @@
_metalFeatures.presentModeImmediate = true;
_metalFeatures.fences = true;
_metalFeatures.nonUniformThreadgroups = true;
+ _metalFeatures.argumentBuffers = true;
}
if (supportsMTLFeatureSet(macOS_GPUFamily1_v4)) {
@@ -2377,6 +2381,7 @@
// Next 4 bytes contains flags based on enabled Metal features that
// might affect the contents of the pipeline cache (mostly MSL content).
uint32_t mtlFeatures = 0;
+ mtlFeatures |= isUsingMetalArgumentBuffers() << 0;
*(uint32_t*)&_properties.pipelineCacheUUID[uuidComponentOffset] = NSSwapHostIntToBig(mtlFeatures);
uuidComponentOffset += sizeof(mtlFeatures);
}
@@ -3650,6 +3655,7 @@
if ( !_defaultMTLSamplerState ) {
@autoreleasepool {
MTLSamplerDescriptor* mtlSampDesc = [[MTLSamplerDescriptor new] autorelease];
+ mtlSampDesc.supportArgumentBuffers = _physicalDevice->isUsingMetalArgumentBuffers();
_defaultMTLSamplerState = [getMTLDevice() newSamplerStateWithDescriptor: mtlSampDesc]; // retained
}
}
diff --git a/MoltenVK/MoltenVK/GPUObjects/MVKPipeline.mm b/MoltenVK/MoltenVK/GPUObjects/MVKPipeline.mm
index 792d768..790bf3c 100644
--- a/MoltenVK/MoltenVK/GPUObjects/MVKPipeline.mm
+++ b/MoltenVK/MoltenVK/GPUObjects/MVKPipeline.mm
@@ -17,7 +17,6 @@
*/
#include "MVKPipeline.h"
-#include <MoltenVKShaderConverter/SPIRVToMSLConverter.h>
#include "MVKRenderPass.h"
#include "MVKCommandBuffer.h"
#include "MVKFoundation.h"
@@ -77,6 +76,7 @@
void MVKPipelineLayout::populateShaderConverterContext(SPIRVToMSLConversionConfiguration& context) {
context.resourceBindings.clear();
+ context.discreteDescriptorSets.clear();
// Add resource bindings defined in the descriptor set layouts
uint32_t dslCnt = (uint32_t)_descriptorSetLayouts.size();
@@ -135,9 +135,8 @@
// Set implicit buffer indices
// FIXME: Many of these are optional. We shouldn't set the ones that aren't
- // present--or at least, we should move the ones that are down to avoid
- // running over the limit of available buffers. But we can't know that
- // until we compile the shaders.
+ // present--or at least, we should move the ones that are down to avoid running over
+ // the limit of available buffers. But we can't know that until we compile the shaders.
for (uint32_t i = kMVKShaderStageVertex; i < kMVKShaderStageMax; i++) {
_swizzleBufferIndex.stages[i] = _pushConstantsMTLResourceIndexes.stages[i].bufferIndex + 1;
_bufferSizeBufferIndex.stages[i] = _swizzleBufferIndex.stages[i] + 1;
@@ -1447,6 +1446,8 @@
shaderContext.options.mslOptions.texel_buffer_texture_width = _device->_pMetalFeatures->maxTextureDimension;
shaderContext.options.mslOptions.r32ui_linear_texture_alignment = (uint32_t)_device->getVkFormatTexelBufferAlignment(VK_FORMAT_R32_UINT, this);
shaderContext.options.mslOptions.texture_buffer_native = _device->_pMetalFeatures->textureBuffers;
+ shaderContext.options.mslOptions.argument_buffers = isUsingMetalArgumentBuffers();
+ shaderContext.options.mslOptions.force_active_argument_buffer_resources = isUsingMetalArgumentBuffers();
MVKPipelineLayout* layout = (MVKPipelineLayout*)pCreateInfo->layout;
layout->populateShaderConverterContext(shaderContext);
@@ -1691,6 +1692,8 @@
shaderContext.options.mslOptions.dispatch_base = _allowsDispatchBase;
shaderContext.options.mslOptions.texture_1D_as_2D = mvkConfig()->texture1DAs2D;
shaderContext.options.mslOptions.fixed_subgroup_size = mvkIsAnyFlagEnabled(pSS->flags, VK_PIPELINE_SHADER_STAGE_CREATE_ALLOW_VARYING_SUBGROUP_SIZE_BIT_EXT) ? 0 : _device->_pMetalFeatures->maxSubgroupSize;
+ shaderContext.options.mslOptions.argument_buffers = isUsingMetalArgumentBuffers();
+ shaderContext.options.mslOptions.force_active_argument_buffer_resources = isUsingMetalArgumentBuffers();
#if MVK_MACOS
shaderContext.options.mslOptions.emulate_subgroups = !_device->_pMetalFeatures->simdPermute;
#endif
@@ -2098,15 +2101,23 @@
void serialize(Archive & archive, MSLResourceBinding& rb) {
archive(rb.resourceBinding,
rb.constExprSampler,
+ rb.mtlTextureType,
rb.requiresConstExprSampler,
rb.isUsedByShader);
}
template<class Archive>
+ void serialize(Archive & archive, DescriptorBinding& db) {
+ archive(db.descriptorSet,
+ db.binding);
+ }
+
+ template<class Archive>
void serialize(Archive & archive, SPIRVToMSLConversionConfiguration& ctx) {
archive(ctx.options,
ctx.shaderInputs,
- ctx.resourceBindings);
+ ctx.resourceBindings,
+ ctx.discreteDescriptorSets);
}
template<class Archive>
diff --git a/MoltenVK/MoltenVK/Utility/MVKEnvironment.cpp b/MoltenVK/MoltenVK/Utility/MVKEnvironment.cpp
index 840cd7d..05f0db3 100644
--- a/MoltenVK/MoltenVK/Utility/MVKEnvironment.cpp
+++ b/MoltenVK/MoltenVK/Utility/MVKEnvironment.cpp
@@ -60,6 +60,7 @@
MVK_SET_FROM_ENV_OR_BUILD_BOOL (evCfg.useMTLHeap, MVK_CONFIG_USE_MTLHEAP);
MVK_SET_FROM_ENV_OR_BUILD_INT32 (evCfg.apiVersionToAdvertise, MVK_CONFIG_API_VERSION_TO_ADVERTISE);
MVK_SET_FROM_ENV_OR_BUILD_INT32 (evCfg.advertiseExtensions, MVK_CONFIG_ADVERTISE_EXTENSIONS);
+ MVK_SET_FROM_ENV_OR_BUILD_BOOL (evCfg.useMetalArgumentBuffers, MVK_CONFIG_USE_METAL_ARGUMENT_BUFFERS);
mvkSetConfig(&evCfg);
}
diff --git a/MoltenVK/MoltenVK/Utility/MVKEnvironment.h b/MoltenVK/MoltenVK/Utility/MVKEnvironment.h
index b41bdd1..89d26e7 100644
--- a/MoltenVK/MoltenVK/Utility/MVKEnvironment.h
+++ b/MoltenVK/MoltenVK/Utility/MVKEnvironment.h
@@ -272,3 +272,8 @@
#ifndef MVK_CONFIG_ADVERTISE_EXTENSIONS
# define MVK_CONFIG_ADVERTISE_EXTENSIONS MVK_CONFIG_ADVERTISE_EXTENSIONS_ALL
#endif
+
+/** Support Metal argument buffers. Enabled by default. */
+#ifndef MVK_CONFIG_USE_METAL_ARGUMENT_BUFFERS
+# define MVK_CONFIG_USE_METAL_ARGUMENT_BUFFERS 1
+#endif
diff --git a/MoltenVKShaderConverter/MoltenVKShaderConverter.xcodeproj/project.pbxproj b/MoltenVKShaderConverter/MoltenVKShaderConverter.xcodeproj/project.pbxproj
index 81736b2..74f3e62 100644
--- a/MoltenVKShaderConverter/MoltenVKShaderConverter.xcodeproj/project.pbxproj
+++ b/MoltenVKShaderConverter/MoltenVKShaderConverter.xcodeproj/project.pbxproj
@@ -14,13 +14,13 @@
2FEA0D052490381A00EEF3AD /* SPIRVToMSLConverter.h in Headers */ = {isa = PBXBuildFile; fileRef = A9093F5B1C58013E0094110D /* SPIRVToMSLConverter.h */; };
2FEA0D062490381A00EEF3AD /* MVKCommonEnvironment.h in Headers */ = {isa = PBXBuildFile; fileRef = A9F042AA1FB4D060009FCCB8 /* MVKCommonEnvironment.h */; };
2FEA0D082490381A00EEF3AD /* FileSupport.mm in Sources */ = {isa = PBXBuildFile; fileRef = A925B70A1C7754B2006E7ECD /* FileSupport.mm */; };
- 2FEA0D092490381A00EEF3AD /* SPIRVToMSLConverter.cpp in Sources */ = {isa = PBXBuildFile; fileRef = A9093F5A1C58013E0094110D /* SPIRVToMSLConverter.cpp */; };
+ 2FEA0D092490381A00EEF3AD /* SPIRVToMSLConverter.mm in Sources */ = {isa = PBXBuildFile; fileRef = A9093F5A1C58013E0094110D /* SPIRVToMSLConverter.mm */; };
2FEA0D0A2490381A00EEF3AD /* SPIRVSupport.cpp in Sources */ = {isa = PBXBuildFile; fileRef = A9C70F5E221B321700FBA31A /* SPIRVSupport.cpp */; };
2FEA0D0B2490381A00EEF3AD /* SPIRVConversion.mm in Sources */ = {isa = PBXBuildFile; fileRef = A928C9181D0488DC00071B88 /* SPIRVConversion.mm */; };
450A4F61220CB180007203D7 /* SPIRVReflection.h in Headers */ = {isa = PBXBuildFile; fileRef = 450A4F5E220CB180007203D7 /* SPIRVReflection.h */; };
450A4F62220CB180007203D7 /* SPIRVReflection.h in Headers */ = {isa = PBXBuildFile; fileRef = 450A4F5E220CB180007203D7 /* SPIRVReflection.h */; };
- A909408A1C58013E0094110D /* SPIRVToMSLConverter.cpp in Sources */ = {isa = PBXBuildFile; fileRef = A9093F5A1C58013E0094110D /* SPIRVToMSLConverter.cpp */; };
- A909408B1C58013E0094110D /* SPIRVToMSLConverter.cpp in Sources */ = {isa = PBXBuildFile; fileRef = A9093F5A1C58013E0094110D /* SPIRVToMSLConverter.cpp */; };
+ A909408A1C58013E0094110D /* SPIRVToMSLConverter.mm in Sources */ = {isa = PBXBuildFile; fileRef = A9093F5A1C58013E0094110D /* SPIRVToMSLConverter.mm */; };
+ A909408B1C58013E0094110D /* SPIRVToMSLConverter.mm in Sources */ = {isa = PBXBuildFile; fileRef = A9093F5A1C58013E0094110D /* SPIRVToMSLConverter.mm */; };
A909408C1C58013E0094110D /* SPIRVToMSLConverter.h in Headers */ = {isa = PBXBuildFile; fileRef = A9093F5B1C58013E0094110D /* SPIRVToMSLConverter.h */; };
A909408D1C58013E0094110D /* SPIRVToMSLConverter.h in Headers */ = {isa = PBXBuildFile; fileRef = A9093F5B1C58013E0094110D /* SPIRVToMSLConverter.h */; };
A920A8A3251B75B70076851C /* GLSLToSPIRVConverter.cpp in Sources */ = {isa = PBXBuildFile; fileRef = A920A89F251B75B70076851C /* GLSLToSPIRVConverter.cpp */; };
@@ -80,7 +80,7 @@
/* Begin PBXFileReference section */
2FEA0D142490381A00EEF3AD /* libMoltenVKShaderConverter.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = libMoltenVKShaderConverter.a; sourceTree = BUILT_PRODUCTS_DIR; };
450A4F5E220CB180007203D7 /* SPIRVReflection.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SPIRVReflection.h; sourceTree = "<group>"; };
- A9093F5A1C58013E0094110D /* SPIRVToMSLConverter.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = SPIRVToMSLConverter.cpp; sourceTree = "<group>"; };
+ A9093F5A1C58013E0094110D /* SPIRVToMSLConverter.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = SPIRVToMSLConverter.mm; sourceTree = "<group>"; };
A9093F5B1C58013E0094110D /* SPIRVToMSLConverter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SPIRVToMSLConverter.h; sourceTree = "<group>"; };
A920A89F251B75B70076851C /* GLSLToSPIRVConverter.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = GLSLToSPIRVConverter.cpp; sourceTree = "<group>"; };
A920A8A0251B75B70076851C /* GLSLConversion.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = GLSLConversion.h; sourceTree = "<group>"; };
@@ -165,7 +165,7 @@
A928C9171D0488DC00071B88 /* SPIRVConversion.h */,
A928C9181D0488DC00071B88 /* SPIRVConversion.mm */,
450A4F5E220CB180007203D7 /* SPIRVReflection.h */,
- A9093F5A1C58013E0094110D /* SPIRVToMSLConverter.cpp */,
+ A9093F5A1C58013E0094110D /* SPIRVToMSLConverter.mm */,
A9093F5B1C58013E0094110D /* SPIRVToMSLConverter.h */,
);
path = MoltenVKShaderConverter;
@@ -460,7 +460,7 @@
2FEA0D082490381A00EEF3AD /* FileSupport.mm in Sources */,
A920A8AA251B75B70076851C /* GLSLConversion.mm in Sources */,
A920A8A4251B75B70076851C /* GLSLToSPIRVConverter.cpp in Sources */,
- 2FEA0D092490381A00EEF3AD /* SPIRVToMSLConverter.cpp in Sources */,
+ 2FEA0D092490381A00EEF3AD /* SPIRVToMSLConverter.mm in Sources */,
2FEA0D0A2490381A00EEF3AD /* SPIRVSupport.cpp in Sources */,
2FEA0D0B2490381A00EEF3AD /* SPIRVConversion.mm in Sources */,
);
@@ -485,7 +485,7 @@
A95096BB2003D00300F10950 /* FileSupport.mm in Sources */,
A920A8A9251B75B70076851C /* GLSLConversion.mm in Sources */,
A920A8A3251B75B70076851C /* GLSLToSPIRVConverter.cpp in Sources */,
- A909408A1C58013E0094110D /* SPIRVToMSLConverter.cpp in Sources */,
+ A909408A1C58013E0094110D /* SPIRVToMSLConverter.mm in Sources */,
A9C70F66221B321700FBA31A /* SPIRVSupport.cpp in Sources */,
A928C91B1D0488DC00071B88 /* SPIRVConversion.mm in Sources */,
);
@@ -498,7 +498,7 @@
A95096BC2003D00300F10950 /* FileSupport.mm in Sources */,
A920A8AB251B75B70076851C /* GLSLConversion.mm in Sources */,
A920A8A5251B75B70076851C /* GLSLToSPIRVConverter.cpp in Sources */,
- A909408B1C58013E0094110D /* SPIRVToMSLConverter.cpp in Sources */,
+ A909408B1C58013E0094110D /* SPIRVToMSLConverter.mm in Sources */,
A9C70F67221B321700FBA31A /* SPIRVSupport.cpp in Sources */,
A928C91C1D0488DC00071B88 /* SPIRVConversion.mm in Sources */,
);
diff --git a/MoltenVKShaderConverter/MoltenVKShaderConverter/SPIRVReflection.h b/MoltenVKShaderConverter/MoltenVKShaderConverter/SPIRVReflection.h
index 5d851da..5768610 100644
--- a/MoltenVKShaderConverter/MoltenVKShaderConverter/SPIRVReflection.h
+++ b/MoltenVKShaderConverter/MoltenVKShaderConverter/SPIRVReflection.h
@@ -26,6 +26,24 @@
#include <string>
#include <vector>
+#ifdef __OBJC__
+#import <Metal/Metal.h>
+#else
+enum MTLTextureType {
+ MTLTextureType1D,
+ MTLTextureType1DArray,
+ MTLTextureType2D,
+ MTLTextureType2DArray,
+ MTLTextureType2DMultisample,
+ MTLTextureType2DMultisampleArray,
+ MTLTextureType3D,
+ MTLTextureTypeCube,
+ MTLTextureTypeCubeArray,
+ MTLTextureTypeTextureBuffer
+};
+#endif
+
+
namespace mvk {
#pragma mark -
@@ -264,5 +282,51 @@
#endif
}
+ /** Given the compiler, returns the MTLTextureType of the descriptor set binding. */
+ template<typename C>
+ MTLTextureType getMTLTextureType(C* compiler, uint32_t desc_set, uint32_t binding) {
+ for (auto varID : compiler->get_active_interface_variables()) {
+ if (compiler->has_decoration(varID, spv::DecorationDescriptorSet) &&
+ compiler->get_decoration(varID, spv::DecorationDescriptorSet) == desc_set &&
+ compiler->has_decoration(varID, spv::DecorationBinding) &&
+ compiler->get_decoration(varID, spv::DecorationBinding) == binding) {
+
+ auto& mslOpts = compiler->get_msl_options();
+ auto& imgType = compiler->get_type_from_variable(varID).image;
+ bool isArray = imgType.arrayed;
+ switch (imgType.dim) {
+ case spv::DimBuffer:
+ return mslOpts.texture_buffer_native ? MTLTextureTypeTextureBuffer : MTLTextureType2D;
+
+ case spv::Dim1D:
+ return (mslOpts.texture_1D_as_2D
+ ? (isArray ? MTLTextureType2DArray : MTLTextureType2D)
+ : (isArray ? MTLTextureType1DArray : MTLTextureType1D));
+
+ case spv::Dim2D:
+ case spv::DimSubpassData:
+#if MVK_MACOS_OR_IOS
+ if (isArray && imgType.ms) { return MTLTextureType2DMultisampleArray; }
+#endif
+ return (isArray
+ ? MTLTextureType2DArray
+ : (imgType.ms ? MTLTextureType2DMultisample : MTLTextureType2D));
+
+ case spv::Dim3D:
+ return MTLTextureType3D;
+
+ case spv::DimCube:
+ return (mslOpts.emulate_cube_array
+ ? (isArray ? MTLTextureType2DArray : MTLTextureType2D)
+ : (isArray ? MTLTextureTypeCubeArray : MTLTextureTypeCube));
+
+ default:
+ return MTLTextureType2D;
+ }
+ }
+ }
+ return MTLTextureType2D;
+ }
+
}
#endif
diff --git a/MoltenVKShaderConverter/MoltenVKShaderConverter/SPIRVToMSLConverter.h b/MoltenVKShaderConverter/MoltenVKShaderConverter/SPIRVToMSLConverter.h
index 0a360de..d6a5cec 100644
--- a/MoltenVKShaderConverter/MoltenVKShaderConverter/SPIRVToMSLConverter.h
+++ b/MoltenVKShaderConverter/MoltenVKShaderConverter/SPIRVToMSLConverter.h
@@ -19,11 +19,12 @@
#ifndef __SPIRVToMSLConverter_h_
#define __SPIRVToMSLConverter_h_ 1
+#include "SPIRVReflection.h"
#include <spirv.hpp>
#include <spirv_msl.hpp>
#include <string>
#include <vector>
-#include <unordered_map>
+
namespace mvk {
@@ -107,6 +108,7 @@
typedef struct MSLResourceBinding {
SPIRV_CROSS_NAMESPACE::MSLResourceBinding resourceBinding;
SPIRV_CROSS_NAMESPACE::MSLConstexprSampler constExprSampler;
+ MTLTextureType mtlTextureType = MTLTextureType2D;
bool requiresConstExprSampler = false;
bool isUsedByShader = false;
@@ -120,6 +122,20 @@
} MSLResourceBinding;
/**
+ * Identifies a descriptor set binding.
+ *
+ * THIS STRUCT IS STREAMED OUT AS PART OF THE PIPELINE CACHE.
+ * CHANGES TO THIS STRUCT SHOULD BE CAPTURED IN THE STREAMING LOGIC OF THE PIPELINE CACHE.
+ */
+ typedef struct DescriptorBinding {
+ uint32_t descriptorSet = 0;
+ uint32_t binding = 0;
+
+ bool matches(const DescriptorBinding& other) const;
+
+ } DescriptorBinding;
+
+ /**
* Configuration passed to the SPIRVToMSLConverter.
*
* THIS STRUCT IS STREAMED OUT AS PART OF THE PIEPLINE CACHE.
@@ -129,6 +145,7 @@
SPIRVToMSLConversionOptions options;
std::vector<MSLShaderInput> shaderInputs;
std::vector<MSLResourceBinding> resourceBindings;
+ std::vector<uint32_t> discreteDescriptorSets;
/** Returns whether the pipeline stage being converted supports vertex attributes. */
bool stageSupportsVertexAttributes() const;
@@ -142,6 +159,9 @@
/** Returns whether the vertex buffer at the specified Vulkan binding is used by the shader. */
bool isVertexBufferUsed(uint32_t binding) const { return countShaderInputsAt(binding) > 0; }
+ /** Returns the MTLTextureType of the image resource at the descriptor set and binding. */
+ MTLTextureType getMTLTextureType(uint32_t descSet, uint32_t binding) const;
+
/** Marks all input variables and resources as being used by the shader. */
void markAllInputsAndResourcesUsed();
diff --git a/MoltenVKShaderConverter/MoltenVKShaderConverter/SPIRVToMSLConverter.cpp b/MoltenVKShaderConverter/MoltenVKShaderConverter/SPIRVToMSLConverter.mm
similarity index 91%
rename from MoltenVKShaderConverter/MoltenVKShaderConverter/SPIRVToMSLConverter.cpp
rename to MoltenVKShaderConverter/MoltenVKShaderConverter/SPIRVToMSLConverter.mm
index 996374a..1693e25 100644
--- a/MoltenVKShaderConverter/MoltenVKShaderConverter/SPIRVToMSLConverter.cpp
+++ b/MoltenVKShaderConverter/MoltenVKShaderConverter/SPIRVToMSLConverter.mm
@@ -1,5 +1,5 @@
/*
- * SPIRVToMSLConverter.cpp
+ * SPIRVToMSLConverter.mm
*
* Copyright (c) 2015-2021 The Brenwill Workshop Ltd. (http://www.brenwill.com)
*
@@ -32,6 +32,13 @@
#pragma mark -
#pragma mark SPIRVToMSLConversionConfiguration
+// Returns whether the container contains an item equal to the value.
+template<class C, class T>
+bool contains(const C& container, const T& val) {
+ for (const T& cVal : container) { if (cVal == val) { return true; } }
+ return false;
+}
+
// Returns whether the vector contains the value (using a matches(T&) comparison member function). */
template<class T>
bool containsMatching(const vector<T>& vec, const T& val) {
@@ -106,6 +113,7 @@
if (resourceBinding.msl_buffer != other.resourceBinding.msl_buffer) { return false; }
if (resourceBinding.msl_texture != other.resourceBinding.msl_texture) { return false; }
if (resourceBinding.msl_sampler != other.resourceBinding.msl_sampler) { return false; }
+ if (mtlTextureType != other.mtlTextureType) { return false; }
if (requiresConstExprSampler != other.requiresConstExprSampler) { return false; }
@@ -144,6 +152,12 @@
return true;
}
+MVK_PUBLIC_SYMBOL bool mvk::DescriptorBinding::matches(const mvk::DescriptorBinding& other) const {
+ if (descriptorSet != other.descriptorSet) { return false; }
+ if (binding != other.binding) { return false; }
+ return true;
+}
+
MVK_PUBLIC_SYMBOL bool SPIRVToMSLConversionConfiguration::stageSupportsVertexAttributes() const {
return (options.entryPointStage == ExecutionModelVertex ||
options.entryPointStage == ExecutionModelTessellationControl ||
@@ -166,6 +180,16 @@
return siCnt;
}
+MVK_PUBLIC_SYMBOL MTLTextureType SPIRVToMSLConversionConfiguration::getMTLTextureType(uint32_t descSet, uint32_t binding) const {
+ for (auto& rb : resourceBindings) {
+ auto& rbb = rb.resourceBinding;
+ if (rb.isUsedByShader && rbb.desc_set == descSet && rbb.binding == binding) {
+ return rb.mtlTextureType;
+ }
+ }
+ return MTLTextureType2D;
+}
+
MVK_PUBLIC_SYMBOL void SPIRVToMSLConversionConfiguration::markAllInputsAndResourcesUsed() {
for (auto& si : shaderInputs) { si.isUsedByShader = true; }
for (auto& rb : resourceBindings) { rb.isUsedByShader = true; }
@@ -183,6 +207,10 @@
if (rb.isUsedByShader && !containsMatching(other.resourceBindings, rb)) { return false; }
}
+ for (uint32_t dsIdx : discreteDescriptorSets) {
+ if ( !contains(other.discreteDescriptorSets, dsIdx)) { return false; }
+ }
+
return true;
}
@@ -199,7 +227,10 @@
for (auto& rb : resourceBindings) {
rb.isUsedByShader = false;
for (auto& srcRB : srcContext.resourceBindings) {
- if (rb.matches(srcRB)) { rb.isUsedByShader = srcRB.isUsedByShader; }
+ if (rb.matches(srcRB)) {
+ rb.mtlTextureType = srcRB.mtlTextureType;
+ rb.isUsedByShader = srcRB.isUsedByShader;
+ }
}
}
}
@@ -278,6 +309,12 @@
}
}
+ // Add any descriptor sets that are not using Metal argument buffers.
+ // This only has an effect if SPIRVToMSLConversionConfiguration::options::mslOptions::argument_buffers is enabled.
+ for (uint32_t dsIdx : context.discreteDescriptorSets) {
+ pMSLCompiler->add_discrete_descriptor_set(dsIdx);
+ }
+
_msl = pMSLCompiler->compile();
if (shouldLogMSL) { logSource(_msl, "MSL", "Converted"); }
@@ -311,6 +348,9 @@
ctxSI.isUsedByShader = pMSLCompiler->is_msl_shader_input_used(ctxSI.shaderInput.location);
}
for (auto& ctxRB : context.resourceBindings) {
+ ctxRB.mtlTextureType = getMTLTextureType(pMSLCompiler,
+ ctxRB.resourceBinding.desc_set,
+ ctxRB.resourceBinding.binding);
ctxRB.isUsedByShader = pMSLCompiler->is_msl_resource_binding_used(ctxRB.resourceBinding.stage,
ctxRB.resourceBinding.desc_set,
ctxRB.resourceBinding.binding);
