LWJGL 3.3.3 · org.lwjgl.vulkan.EXTPageableDeviceLocalMemory

Vulkan is frequently implemented on multi-user and multi-process operating systems where the device-local memory can be shared by more than one process. On such systems the size of the device-local memory available to the application may not be the full size of the memory heap at all times. In order for these operating systems to support multiple applications the device-local memory is virtualized and paging is used to move memory between device-local and host-local memory heaps, transparent to the application.

The current Vulkan specification does not expose this behavior well and may cause applications to make suboptimal memory choices when allocating memory. For example, in a system with multiple applications running, the application may think that device-local memory is full and revert to making performance-sensitive allocations from host-local memory. In reality the memory heap might not have been full, it just appeared to be at the time memory consumption was queried, and a device-local allocation would have succeeded. A well designed operating system that implements pageable device-local memory will try to have all memory allocations for the foreground application paged into device-local memory, and paged out for other applications as needed when not in use.

When this extension is exposed by the Vulkan implementation it indicates to the application that the operating system implements pageable device-local memory and the application should adjust its memory allocation strategy accordingly. The extension also exposes a new SetDeviceMemoryPriorityEXT function to allow the application to dynamically adjust the priority of existing memory allocations based on its current needs. This will help the operating system page out lower priority memory allocations before higher priority allocations when needed. It will also help the operating system decide which memory allocations to page back into device-local memory first.

To take best advantage of pageable device-local memory the application must create the Vulkan device with the VkPhysicalDevicePageableDeviceLocalMemoryFeaturesEXT::pageableDeviceLocalMemory feature enabled. When enabled the Vulkan implementation will allow device-local memory allocations to be paged in and out by the operating system, and may not return VK_ERROR_OUT_OF_DEVICE_MEMORY even if device-local memory appears to be full, but will instead page this, or other allocations, out to make room. The Vulkan implementation will also ensure that host-local memory allocations will never be promoted to device-local memory by the operating system, or consume device-local memory.

VK_EXT_pageable_device_local_memory

Name String

VK_EXT_pageable_device_local_memory

Extension Type

Device extension

Registered Extension Number

413

Revision

Extension and Version Dependencies

VK_EXT_memory_priority

Contact

Piers Daniell pdaniell-nv

Other Extension Metadata

Last Modified Date

2021-08-24

Contributors

Hans-Kristian Arntzen, Valve
Axel Gneiting, id Software
Billy Khan, id Software
Daniel Koch, NVIDIA
Chris Lentini, NVIDIA
Joshua Schnarr, NVIDIA
Stu Smith, AMD

Modifier and Type	Field and Description
public static final String	VK_EXT_PAGEABLE_DEVICE_LOCAL_MEMORY_EXTENSION_NAME The extension name.
public static final int	VK_EXT_PAGEABLE_DEVICE_LOCAL_MEMORY_SPEC_VERSION The extension specification version.
public static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PAGEABLE_DEVICE_LOCAL_MEMORY_FEATURES_EXT Extends `VkStructureType`.

Access	Constructor and Description
protected	EXTPageableDeviceLocalMemory()

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public static void	vkSetDeviceMemoryPriorityEXT(VkDevice the logical device that owns the memory. device, long the `VkDeviceMemory` object to which the new priority will be applied. memory, float a floating-point value between 0 and 1, indicating the priority of the allocation relative to other memory allocations. Larger values are higher priority. The granularity of the priorities is implementation-dependent. priority) Change a memory allocation priority.

public static void

vkSetDeviceMemoryPriorityEXT(VkDevice

the logical device that owns the memory.

device, long

the VkDeviceMemory object to which the new priority will be applied.

memory, float

a floating-point value between 0 and 1, indicating the priority of the allocation relative to other memory allocations. Larger values are higher priority. The granularity of the priorities is implementation-dependent.

priority)

Change a memory allocation priority.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

VK_EXT_PAGEABLE_DEVICE_LOCAL_MEMORY_EXTENSION_NAME	back to summary
public static final String VK_EXT_PAGEABLE_DEVICE_LOCAL_MEMORY_EXTENSION_NAME The extension name.

VK_EXT_PAGEABLE_DEVICE_LOCAL_MEMORY_SPEC_VERSION	back to summary
public static final int VK_EXT_PAGEABLE_DEVICE_LOCAL_MEMORY_SPEC_VERSION The extension specification version.

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PAGEABLE_DEVICE_LOCAL_MEMORY_FEATURES_EXT	back to summary
public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PAGEABLE_DEVICE_LOCAL_MEMORY_FEATURES_EXT Extends `VkStructureType`.

EXTPageableDeviceLocalMemory	back to summary
protected EXTPageableDeviceLocalMemory()

Method Detail

vkSetDeviceMemoryPriorityEXT back to summary

vkSetDeviceMemoryPriorityEXT	back to summary
public static void vkSetDeviceMemoryPriorityEXT(VkDevice device, long memory, float priority) Change a memory allocation priority. C Specification To modify the priority of an existing memory allocation, call: `void vkSetDeviceMemoryPriorityEXT( VkDevice device, VkDeviceMemory memory, float priority);` Description Memory allocations with higher priority may be more likely to stay in device-local memory when the system is under memory pressure. Valid Usage `priority` must be between 0 and 1, inclusive Valid Usage (Implicit) `device` must be a valid `VkDevice` handle `memory` must be a valid `VkDeviceMemory` handle `memory` must have been created, allocated, or retrieved from `device` Parameters device:VkDevice the logical device that owns the memory. memory:long the `VkDeviceMemory` object to which the new priority will be applied. priority:float a floating-point value between 0 and 1, indicating the priority of the allocation relative to other memory allocations. Larger values are higher priority. The granularity of the priorities is implementation-dependent.

public static void vkSetDeviceMemoryPriorityEXT(VkDevice device, long memory, float priority)

Change a memory allocation priority.

C Specification

To modify the priority of an existing memory allocation, call:


void vkSetDeviceMemoryPriorityEXT(
    VkDevice                                    device,
    VkDeviceMemory                              memory,
    float                                       priority);

Description

Memory allocations with higher priority may be more likely to stay in device-local memory when the system is under memory pressure.

Valid Usage

priority must be between 0 and 1, inclusive

Valid Usage (Implicit)

device must be a valid VkDevice handle
memory must be a valid VkDeviceMemory handle
memory must have been created, allocated, or retrieved from device

Parameters

device:VkDevice: the logical device that owns the memory.
memory:long: the VkDeviceMemory object to which the new priority will be applied.
priority:float: a floating-point value between 0 and 1, indicating the priority of the allocation relative to other memory allocations. Larger values are higher priority. The granularity of the priorities is implementation-dependent.

public Class EXTPageableDeviceLocalMemory