Skip to content

Fix buffer and heap out-of-sync in initExternalMemory() #2667

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
billhollings merged 1 commit into from
Dec 12, 2025
+22 −7
Merged

Fix buffer and heap out-of-sync in initExternalMemory() #2667

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion MoltenVK/MoltenVK/GPUObjects/MVKDeviceMemory.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ class MVKDeviceMemory : public MVKVulkanAPIDeviceObject {
bool ensureHostMemory();
void freeHostMemory();
MVKResource* getDedicatedResource();
void initExternalMemory(MVKImage* dedicatedImage);
void initExternalMemory(MVKImage* dedicatedImage, bool wantsHeap);

MVKSmallVector<MVKBuffer*, 4> _buffers;
MVKSmallVector<MVKImageMemoryBinding*, 4> _imageMemoryBindings;
Expand Down
27 changes: 21 additions & 6 deletions MoltenVK/MoltenVK/GPUObjects/MVKDeviceMemory.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,9 @@
// Can't create a MTLHeap on imported memory
if (_isHostMemImported) { return true; }

// Can't create a MTLHeap if we already have a _mtlBuffer
if (_mtlBuffer) { return true; }

// Don't bother if we don't have placement heaps.
if (!getMetalFeatures().placementHeaps) { return true; }

Expand Down Expand Up @@ -311,6 +314,7 @@
_allocationSize = pAllocateInfo->allocationSize;

bool willExportMTLBuffer = false;
bool wantsHeap = true;
MVKImage* dedicatedImage = nullptr;
VkBuffer dedicatedBuffer = VK_NULL_HANDLE;
for (const auto* next = (const VkBaseInStructure*)pAllocateInfo->pNext; next; next = next->pNext) {
Expand Down Expand Up @@ -356,6 +360,7 @@
_mtlStorageMode = _mtlBuffer.storageMode;
_mtlCPUCacheMode = _mtlBuffer.cpuCacheMode;
_allocationSize = _mtlBuffer.length;
wantsHeap = false;
break;
}
case VK_STRUCTURE_TYPE_EXPORT_METAL_OBJECT_CREATE_INFO_EXT: {
Expand Down Expand Up @@ -388,6 +393,7 @@
_mtlCPUCacheMode = _mtlBuffer.cpuCacheMode;
_allocationSize = _mtlBuffer.length;
_pMemory = isMemoryHostAccessible() ? _mtlBuffer.contents : nullptr;
wantsHeap = false;
} else if (pImportInfo->handleType & VK_EXTERNAL_MEMORY_HANDLE_TYPE_MTLTEXTURE_BIT_EXT) {
[_mtlTexture release];
_mtlTexture = [((id<MTLTexture>)pImportInfo->handle) retain];
Expand All @@ -398,7 +404,7 @@
}
}

initExternalMemory(dedicatedImage); // After setting _isDedicated
initExternalMemory(dedicatedImage, wantsHeap); // After setting _isDedicated

// "Dedicated" means this memory can only be used for this image or buffer.
if (dedicatedImage) {
Expand All @@ -421,7 +427,7 @@
}

// If we can, create a MTLHeap. This should happen before creating the buffer, allowing us to map its contents.
if (!ensureMTLHeap()) {
if (wantsHeap && !ensureMTLHeap()) {
setConfigurationResult(reportError(VK_ERROR_OUT_OF_DEVICE_MEMORY, "vkAllocateMemory(): Could not allocate VkDeviceMemory of size %llu bytes.", _allocationSize));
return;
}
Expand All @@ -434,7 +440,7 @@
}
}

void MVKDeviceMemory::initExternalMemory(MVKImage* dedicatedImage) {
void MVKDeviceMemory::initExternalMemory(MVKImage* dedicatedImage, bool wantsHeap) {
if ( !_externalMemoryHandleType ) { return; }

if ( !mvkIsOnlyAnyFlagEnabled(_externalMemoryHandleType, VK_EXTERNAL_MEMORY_HANDLE_TYPE_MTLBUFFER_BIT_EXT | VK_EXTERNAL_MEMORY_HANDLE_TYPE_MTLTEXTURE_BIT_EXT | VK_EXTERNAL_MEMORY_HANDLE_TYPE_MTLHEAP_BIT_EXT) ) {
Expand All @@ -445,14 +451,23 @@
if (mvkIsAnyFlagEnabled(_externalMemoryHandleType, VK_EXTERNAL_MEMORY_HANDLE_TYPE_MTLHEAP_BIT_EXT)) {
auto& xmProps = getPhysicalDevice()->getExternalBufferProperties(VK_EXTERNAL_MEMORY_HANDLE_TYPE_MTLHEAP_BIT_EXT);
requiresDedicated = requiresDedicated || mvkIsAnyFlagEnabled(xmProps.externalMemoryFeatures, VK_EXTERNAL_MEMORY_FEATURE_DEDICATED_ONLY_BIT);

// Make sure allocation happens at creation time since we may need to export the memory before usage
ensureMTLHeap();

if (wantsHeap) {
// Make sure allocation happens at creation time since we may need to export the memory before usage
ensureMTLHeap();
} else {
setConfigurationResult(reportError(VK_ERROR_INITIALIZATION_FAILED, "vkAllocateMemory(): Cannot export MTLHeap from an imported MTLBuffer."));
}
}
if (mvkIsAnyFlagEnabled(_externalMemoryHandleType, VK_EXTERNAL_MEMORY_HANDLE_TYPE_MTLBUFFER_BIT_EXT)) {
auto& xmProps = getPhysicalDevice()->getExternalBufferProperties(VK_EXTERNAL_MEMORY_HANDLE_TYPE_MTLBUFFER_BIT_EXT);
requiresDedicated = requiresDedicated || mvkIsAnyFlagEnabled(xmProps.externalMemoryFeatures, VK_EXTERNAL_MEMORY_FEATURE_DEDICATED_ONLY_BIT);

if (wantsHeap) {
// Make sure to initialize heap before buffer if we need one
ensureMTLHeap();
}

// Make sure allocation happens at creation time since we may need to export the memory before usage
ensureMTLBuffer();
}
Expand Down