Implement VK_KHR_present_id and VK_KHR_present_wait

Author: squidbus

Docs/MoltenVK_Runtime_UserGuide.md

@@ -268,6 +268,8 @@ In addition to core *Vulkan* functionality, **MoltenVK**  also supports the foll
 - `VK_KHR_map_memory2`
 - `VK_KHR_multiview`
 - `VK_KHR_portability_subset`
+- `VK_KHR_present_id`
+- `VK_KHR_present_wait`
 - `VK_KHR_push_descriptor`
 - `VK_KHR_relaxed_block_layout`
 - `VK_KHR_sampler_mirror_clamp_to_edge`

MoltenVK/MoltenVK/GPUObjects/MVKDevice.mm

@@ -531,6 +531,16 @@
 				portabilityFeatures->vertexAttributeAccessBeyondStride = true;	// Costs additional buffers. Should make configuration switch.
 				break;
 			}
+			case VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PRESENT_ID_FEATURES_KHR: {
+				auto* presentIdFeatures = (VkPhysicalDevicePresentIdFeaturesKHR*)next;
+				presentIdFeatures->presentId = true;
+				break;
+			}
+			case VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PRESENT_WAIT_FEATURES_KHR: {
+				auto* presentWaitFeatures = (VkPhysicalDevicePresentWaitFeaturesKHR*)next;
+				presentWaitFeatures->presentWait = true;
+				break;
+			}
 			case VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_EXPECT_ASSUME_FEATURES: {
 				auto* shaderExpectAssume = (VkPhysicalDeviceShaderExpectAssumeFeatures*)next;
 				shaderExpectAssume->shaderExpectAssume = true;

MoltenVK/MoltenVK/GPUObjects/MVKDeviceFeatureStructs.def

@@ -73,6 +73,8 @@ MVK_DEVICE_FEATURE_EXTN(FragmentShaderBarycentric,        FRAGMENT_SHADER_BARYCE
 MVK_DEVICE_FEATURE_EXTN(Maintenance6,                     MAINTENANCE_6,                       KHR,   1)
 MVK_DEVICE_FEATURE_EXTN(Maintenance7,                     MAINTENANCE_7,                       KHR,   1)
 MVK_DEVICE_FEATURE_EXTN(PortabilitySubset,                PORTABILITY_SUBSET,                  KHR,  15)
+MVK_DEVICE_FEATURE_EXTN(PresentId,                        PRESENT_ID,                          KHR,   1)
+MVK_DEVICE_FEATURE_EXTN(PresentWait,                      PRESENT_WAIT,                        KHR,   1)
 MVK_DEVICE_FEATURE_EXTN(ShaderExpectAssume,               SHADER_EXPECT_ASSUME,                KHR,   1)
 MVK_DEVICE_FEATURE_EXTN(ShaderRelaxedExtendedInstruction, SHADER_RELAXED_EXTENDED_INSTRUCTION, KHR,   1)
 MVK_DEVICE_FEATURE_EXTN(ShaderSubgroupRotate,             SHADER_SUBGROUP_ROTATE,              KHR,   2)

MoltenVK/MoltenVK/GPUObjects/MVKImage.h

@@ -452,8 +452,9 @@ typedef struct  {
 	MVKPresentableSwapchainImage* presentableImage;
 	MVKQueue* queue;				// The queue on which the vkQueuePresentKHR() command was executed.
 	MVKFence* fence;				// VK_EXT_swapchain_maintenance1 fence signaled when resources can be destroyed
-	uint64_t desiredPresentTime;  	// VK_GOOGLE_display_timing desired presentation time in nanoseconds
-	uint32_t presentID;           	// VK_GOOGLE_display_timing presentID
+	uint64_t presentId;				// VK_KHR_present_id presentId
+	uint64_t desiredPresentTime;	// VK_GOOGLE_display_timing desired presentation time in nanoseconds
+	uint32_t presentIDGoogle;	// VK_GOOGLE_display_timing presentID
 	VkPresentModeKHR presentMode;	// VK_EXT_swapchain_maintenance1 present mode specialization
 } MVKImagePresentInfo;
 

MoltenVK/MoltenVK/GPUObjects/MVKInstance.mm

@@ -450,6 +450,9 @@
 #define ADD_INST_EXT2_ENTRY_POINT(func, API, EXT1, EXT2)	ADD_ENTRY_POINT(func, VK_API_VERSION_##API, VK_##EXT1##_EXTENSION_NAME, VK_##EXT2##_EXTENSION_NAME, nullptr, false)
 #define ADD_DVC_EXT2_ENTRY_POINT(func, API, EXT1, EXT2)		ADD_ENTRY_POINT(func, VK_API_VERSION_##API, VK_##EXT1##_EXTENSION_NAME, VK_##EXT2##_EXTENSION_NAME, nullptr, true)
 
+#define ADD_INST_EXT3_ENTRY_POINT(func, EXT1, EXT2, EXT3)	ADD_ENTRY_POINT(func, 0, VK_##EXT1##_EXTENSION_NAME, VK_##EXT2##_EXTENSION_NAME, VK_##EXT3##_EXTENSION_NAME, false)
+#define ADD_DVC_EXT3_ENTRY_POINT(func, EXT1, EXT2, EXT3)	ADD_ENTRY_POINT(func, 0, VK_##EXT1##_EXTENSION_NAME, VK_##EXT2##_EXTENSION_NAME, VK_##EXT3##_EXTENSION_NAME, true)
+
 #define ADD_INST_EXT_ENTRY_POINT_ALIAS(alias, func, EXT)	ADD_ENTRY_POINT_MAP(alias, func, 0, VK_##EXT##_EXTENSION_NAME, nullptr, nullptr, false)
 #define ADD_DVC_EXT_ENTRY_POINT_ALIAS(alias, func, EXT)		ADD_ENTRY_POINT_MAP(alias, func, 0, VK_##EXT##_EXTENSION_NAME, nullptr, nullptr, true)
 
@@ -757,6 +760,7 @@
 	ADD_DVC_EXT_ENTRY_POINT(vkGetSwapchainImagesKHR, KHR_SWAPCHAIN);
 	ADD_DVC_EXT_ENTRY_POINT(vkAcquireNextImageKHR, KHR_SWAPCHAIN);
 	ADD_DVC_EXT_ENTRY_POINT(vkQueuePresentKHR, KHR_SWAPCHAIN);
+	ADD_DVC_EXT3_ENTRY_POINT(vkWaitForPresentKHR, KHR_SWAPCHAIN, KHR_PRESENT_ID, KHR_PRESENT_WAIT);
 	ADD_DVC_EXT2_ENTRY_POINT(vkGetDeviceGroupPresentCapabilitiesKHR, 1_1, KHR_SWAPCHAIN, KHR_DEVICE_GROUP);
 	ADD_DVC_EXT2_ENTRY_POINT(vkGetDeviceGroupSurfacePresentModesKHR, 1_1, KHR_SWAPCHAIN, KHR_DEVICE_GROUP);
 	ADD_DVC_EXT2_ENTRY_POINT(vkGetPhysicalDevicePresentRectanglesKHR, 1_1, KHR_SWAPCHAIN, KHR_DEVICE_GROUP);

MoltenVK/MoltenVK/GPUObjects/MVKQueue.mm

@@ -788,11 +788,15 @@
 	const VkSwapchainPresentFenceInfoEXT* pPresentFenceInfo = nullptr;
 	const VkSwapchainPresentModeInfoEXT* pPresentModeInfo = nullptr;
 	const VkPresentRegionsKHR* pPresentRegions = nullptr;
+	const VkPresentIdKHR* pPresentId = nullptr;
 	for (auto* next = (const VkBaseInStructure*)pPresentInfo->pNext; next; next = next->pNext) {
 		switch (next->sType) {
 			case VK_STRUCTURE_TYPE_PRESENT_REGIONS_KHR:
 				pPresentRegions = (const VkPresentRegionsKHR*) next;
 				break;
+			case VK_STRUCTURE_TYPE_PRESENT_ID_KHR:
+				pPresentId = (const VkPresentIdKHR*) next;
+				break;
 			case VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_FENCE_INFO_EXT:
 				pPresentFenceInfo = (const VkSwapchainPresentFenceInfoEXT*) next;
 				break;
@@ -828,6 +832,10 @@
 	if (pPresentRegions) {
 		pRegions = pPresentRegions->pRegions;
 	}
+	const uint64_t* pPresentIds = nullptr;
+	if (pPresentId) {
+		pPresentIds = pPresentId->pPresentIds;
+	}
 
 	VkResult* pSCRslts = pPresentInfo->pResults;
 	_presentInfo.reserve(scCnt);
@@ -838,8 +846,9 @@
 		presentInfo.presentableImage = mvkSC->getPresentableImage(pPresentInfo->pImageIndices[scIdx]);
 		presentInfo.presentMode = pPresentModes ? pPresentModes[scIdx] : VK_PRESENT_MODE_MAX_ENUM_KHR;
 		presentInfo.fence = pFences ? (MVKFence*)pFences[scIdx] : nullptr;
+		presentInfo.presentId = pPresentIds ? pPresentIds[scIdx] : 0;
 		if (pPresentTimes) {
-			presentInfo.presentID = pPresentTimes[scIdx].presentID;
+			presentInfo.presentIDGoogle = pPresentTimes[scIdx].presentID;
 			presentInfo.desiredPresentTime = pPresentTimes[scIdx].desiredPresentTime;
 		}
 		mvkSC->setLayerNeedsDisplay(pRegions ? &pRegions[scIdx] : nullptr);

MoltenVK/MoltenVK/GPUObjects/MVKSwapchain.h

@@ -94,6 +94,9 @@ class MVKSwapchain : public MVKVulkanAPIDeviceObject {
 	/** VK_GOOGLE_display_timing - returns past presentation times */
 	VkResult getPastPresentationTiming(uint32_t *pCount, VkPastPresentationTimingGOOGLE *pPresentationTimings);
 
+	/** Waits for the swapchain present ID to meet or exceed the provided ID. */
+	VkResult waitForPresent(uint64_t presentId, uint64_t timeout);
+
 	/** Marks parts of the underlying CAMetalLayer as needing update. */
 	void setLayerNeedsDisplay(const VkPresentRegionKHR* pRegion);
 
@@ -138,4 +141,7 @@ class MVKSwapchain : public MVKVulkanAPIDeviceObject {
 	uint32_t _presentHistoryIndex = 0;
 	uint32_t _presentHistoryHeadIndex = 0;
 	bool _isDeliberatelyScaled = false;
+	uint64_t _currentPresentId = 0;
+	std::mutex _currentPresentIdMutex;
+	std::condition_variable _currentPresentIdCondVar;
 };

MoltenVK/MoltenVK/GPUObjects/MVKSwapchain.mm

@@ -245,6 +245,15 @@
 	return res;
 }
 
+VkResult MVKSwapchain::waitForPresent(uint64_t presentId, uint64_t timeout) {
+	std::unique_lock lock(_currentPresentIdMutex);
+	const auto success = _currentPresentIdCondVar.wait_for(lock, std::chrono::nanoseconds(timeout), [this, presentId] {
+		return _currentPresentId >= presentId || getConfigurationResult() == VK_ERROR_OUT_OF_DATE_KHR;
+	});
+	if (getConfigurationResult() == VK_ERROR_OUT_OF_DATE_KHR) return VK_ERROR_OUT_OF_DATE_KHR;
+	return success ? VK_SUCCESS : VK_TIMEOUT;
+}
+
 void MVKSwapchain::beginPresentation(const MVKImagePresentInfo& presentInfo) {
 	_unpresentedImageCount++;
 }
@@ -261,13 +270,19 @@
 		_presentHistoryHeadIndex = (_presentHistoryHeadIndex + 1) % kMaxPresentationHistory;
 	}
 
-	_presentTimingHistory[_presentHistoryIndex].presentID = presentInfo.presentID;
+	_presentTimingHistory[_presentHistoryIndex].presentID = presentInfo.presentIDGoogle;
 	_presentTimingHistory[_presentHistoryIndex].desiredPresentTime = presentInfo.desiredPresentTime;
 	_presentTimingHistory[_presentHistoryIndex].actualPresentTime = actualPresentTime;
 	// These details are not available in Metal, but can estimate earliestPresentTime by using actualPresentTime instead
 	_presentTimingHistory[_presentHistoryIndex].earliestPresentTime = actualPresentTime;
 	_presentTimingHistory[_presentHistoryIndex].presentMargin = actualPresentTime > beginPresentTime ? actualPresentTime - beginPresentTime : 0;
 	_presentHistoryIndex = (_presentHistoryIndex + 1) % kMaxPresentationHistory;
+
+	if (presentInfo.presentId != 0) {
+		std::unique_lock lock(_currentPresentIdMutex);
+		_currentPresentId = std::max(_currentPresentId, presentInfo.presentId);
+		_currentPresentIdCondVar.notify_all();
+	}
 }
 
 // Because of a regression in Metal, the most recent one or two presentations may not complete

MoltenVK/MoltenVK/Layers/MVKExtensions.def

@@ -68,9 +68,9 @@ MVK_EXTENSION(KHR_format_feature_flags2,               KHR_FORMAT_FEATURE_FLAGS_
 MVK_EXTENSION(KHR_get_memory_requirements2,            KHR_GET_MEMORY_REQUIREMENTS_2,           DEVICE,   10.11,  8.0,  1.0)
 MVK_EXTENSION(KHR_get_physical_device_properties2,     KHR_GET_PHYSICAL_DEVICE_PROPERTIES_2,    INSTANCE, 10.11,  8.0,  1.0)
 MVK_EXTENSION(KHR_get_surface_capabilities2,           KHR_GET_SURFACE_CAPABILITIES_2,          INSTANCE, 10.11,  8.0,  1.0)
-MVK_EXTENSION(KHR_imageless_framebuffer,               KHR_IMAGELESS_FRAMEBUFFER,               DEVICE,   10.11,  8.0,  1.0)
 MVK_EXTENSION(KHR_global_priority,                     KHR_GLOBAL_PRIORITY,                     DEVICE,   10.11,  8.0,  1.0)
 MVK_EXTENSION(KHR_image_format_list,                   KHR_IMAGE_FORMAT_LIST,                   DEVICE,   10.11,  8.0,  1.0)
+MVK_EXTENSION(KHR_imageless_framebuffer,               KHR_IMAGELESS_FRAMEBUFFER,               DEVICE,   10.11,  8.0,  1.0)
 MVK_EXTENSION(KHR_incremental_present,                 KHR_INCREMENTAL_PRESENT,                 DEVICE,   10.11,  8.0,  1.0)
 MVK_EXTENSION(KHR_index_type_uint8,                    KHR_INDEX_TYPE_UINT8,                    DEVICE,   10.11,  8.0,  1.0)
 MVK_EXTENSION(KHR_load_store_op_none,                  KHR_LOAD_STORE_OP_NONE,                  DEVICE,   10.11,  8.0,  1.0)
@@ -82,6 +82,8 @@ MVK_EXTENSION(KHR_maintenance6,                        KHR_MAINTENANCE_6,
 MVK_EXTENSION(KHR_maintenance7,                        KHR_MAINTENANCE_7,                       DEVICE,   10.11,  8.0,  1.0)
 MVK_EXTENSION(KHR_map_memory2,                         KHR_MAP_MEMORY_2,                        DEVICE,   10.11,  8.0,  1.0)
 MVK_EXTENSION(KHR_multiview,                           KHR_MULTIVIEW,                           DEVICE,   10.11,  8.0,  1.0)
+MVK_EXTENSION(KHR_present_id,                          KHR_PRESENT_ID,                          DEVICE,   10.11,  8.0,  1.0)
+MVK_EXTENSION(KHR_present_wait,                        KHR_PRESENT_WAIT,                        DEVICE,   10.11,  8.0,  1.0)
 MVK_EXTENSION(KHR_portability_subset,                  KHR_PORTABILITY_SUBSET,                  DEVICE,   10.11,  8.0,  1.0)
 MVK_EXTENSION(KHR_push_descriptor,                     KHR_PUSH_DESCRIPTOR,                     DEVICE,   10.11,  8.0,  1.0)
 MVK_EXTENSION(KHR_relaxed_block_layout,                KHR_RELAXED_BLOCK_LAYOUT,                DEVICE,   10.11,  8.0,  1.0)

MoltenVK/MoltenVK/Vulkan/vulkan.mm

@@ -3357,6 +3357,23 @@ MVK_PUBLIC_VULKAN_SYMBOL VkResult vkGetMemoryMetalHandlePropertiesEXT(
 MVK_PUBLIC_VULKAN_CORE_ALIAS(vkUnmapMemory2, KHR);
 
 
+#pragma mark -
+#pragma mark VK_KHR_present_wait extension
+
+MVK_PUBLIC_VULKAN_SYMBOL VkResult vkWaitForPresentKHR(
+    VkDevice                                    device,
+    VkSwapchainKHR                              swapchain,
+    uint64_t                                    presentId,
+    uint64_t                                    timeout) {
+
+	MVKTraceVulkanCallStart();
+	MVKSwapchain* mvkSC = (MVKSwapchain*)swapchain;
+	VkResult rslt = mvkSC->waitForPresent(presentId, timeout);
+	MVKTraceVulkanCallEnd();
+	return rslt;
+}
+
+
 #pragma mark -
 #pragma mark VK_KHR_push_descriptor extension