Safe Haskell	Safe-Inferred
Language	Haskell2010

Vulkan.Extensions.VK_EXT_external_memory_host

Description

Name

VK_EXT_external_memory_host - device extension

VK_EXT_external_memory_host

Name String: VK_EXT_external_memory_host

Extension Type

Device extension

Registered Extension Number

179

Revision

1

Ratification Status

Not ratified

Extension and Version Dependencies

VK_KHR_external_memory or Version 1.1

Contact

Daniel Rakos @drakos-amd%0A*Here describe the issue or question you have about the VK_EXT_external_memory_host extension*

Other Extension Metadata

Last Modified Date: 2017-11-10

IP Status

No known IP claims.

Contributors

Jaakko Konttinen, AMD
David Mao, AMD
Daniel Rakos, AMD
Tobias Hector, Imagination Technologies
Faith Ekstrand, Intel
James Jones, NVIDIA

Description

This extension enables an application to import host allocations and host mapped foreign device memory to Vulkan memory objects.

New Commands

getMemoryHostPointerPropertiesEXT

New Structures

MemoryHostPointerPropertiesEXT

Extending MemoryAllocateInfo:
- ImportMemoryHostPointerInfoEXT
Extending PhysicalDeviceProperties2:
- PhysicalDeviceExternalMemoryHostPropertiesEXT

New Enum Constants

EXT_EXTERNAL_MEMORY_HOST_EXTENSION_NAME

Issues

1) What memory type has to be used to import host pointers?

RESOLVED: Depends on the implementation. Applications have to use the new getMemoryHostPointerPropertiesEXT command to query the supported memory types for a particular host pointer. The reported memory types may include memory types that come from a memory heap that is otherwise not usable for regular memory object allocation and thus such a heap’s size may be zero.

2) Can the application still access the contents of the host allocation after importing?

RESOLVED: Yes. However, usual synchronization requirements apply.

3) Can the application free the host allocation?

RESOLVED: No, it violates valid usage conditions. Using the memory object imported from a host allocation that is already freed thus results in undefined behavior.

4) Is mapMemory expected to return the same host address which was specified when importing it to the memory object?

RESOLVED: No. Implementations are allowed to return the same address but it is not required. Some implementations might return a different virtual mapping of the allocation, although the same physical pages will be used.

5) Is there any limitation on the alignment of the host pointer and/or size?

RESOLVED: Yes. Both the address and the size have to be an integer multiple of minImportedHostPointerAlignment. In addition, some platforms and foreign devices may have additional restrictions.

6) Can the same host allocation be imported multiple times into a given physical device?

RESOLVED: No, at least not guaranteed by this extension. Some platforms do not allow locking the same physical pages for device access multiple times, so attempting to do it may result in undefined behavior.

7) Does this extension support exporting the new handle type?

RESOLVED: No.

8) Should we include the possibility to import host mapped foreign device memory using this API?

RESOLVED: Yes, through a separate handle type. Implementations are still allowed to support only one of the handle types introduced by this extension by not returning import support for a particular handle type as returned in ExternalMemoryPropertiesKHR.

Version History

Revision 1, 2017-11-10 (Daniel Rakos)
- Internal revisions

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Synopsis

getMemoryHostPointerPropertiesEXT :: forall io. MonadIO io => Device -> ExternalMemoryHandleTypeFlagBits -> ("hostPointer" ::: Ptr ()) -> io MemoryHostPointerPropertiesEXT
data ImportMemoryHostPointerInfoEXT = ImportMemoryHostPointerInfoEXT {
- handleType :: ExternalMemoryHandleTypeFlagBits
- hostPointer :: Ptr ()
}
data MemoryHostPointerPropertiesEXT = MemoryHostPointerPropertiesEXT {
- memoryTypeBits :: Word32
}
data PhysicalDeviceExternalMemoryHostPropertiesEXT = PhysicalDeviceExternalMemoryHostPropertiesEXT {
- minImportedHostPointerAlignment :: DeviceSize
}
type EXT_EXTERNAL_MEMORY_HOST_SPEC_VERSION = 1
pattern EXT_EXTERNAL_MEMORY_HOST_SPEC_VERSION :: forall a. Integral a => a
type EXT_EXTERNAL_MEMORY_HOST_EXTENSION_NAME = "VK_EXT_external_memory_host"
pattern EXT_EXTERNAL_MEMORY_HOST_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

getMemoryHostPointerPropertiesEXT Source #

Arguments

:: forall io. MonadIO io
=> Device	`device` is the logical device that will be importing `pHostPointer`.
-> ExternalMemoryHandleTypeFlagBits	`handleType` is a `ExternalMemoryHandleTypeFlagBits` value specifying the type of the handle `pHostPointer`.
-> ("hostPointer" ::: Ptr ())	`pHostPointer` is the host pointer to import from.
-> io MemoryHostPointerPropertiesEXT

vkGetMemoryHostPointerPropertiesEXT - Get properties of external memory host pointer

Valid Usage

handleType must be EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT or EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT

pHostPointer must be a pointer aligned to an integer multiple of PhysicalDeviceExternalMemoryHostPropertiesEXT::minImportedHostPointerAlignment
If handleType is EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT, pHostPointer must be a pointer to host memory
If handleType is EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT, pHostPointer must be a pointer to host mapped foreign memory

Valid Usage (Implicit)

device must be a valid Device handle

handleType must be a valid ExternalMemoryHandleTypeFlagBits value
pHostPointer must be a pointer value
pMemoryHostPointerProperties must be a valid pointer to a MemoryHostPointerPropertiesEXT structure

Return Codes

Success

SUCCESS

Failure

Description

Importing memory from a host pointer shares ownership of the memory between the host and the Vulkan implementation. The application can continue to access the memory through the host pointer but it is the application’s responsibility to synchronize device and non-device access to the payload as defined in Host Access to Device Memory Objects.

Applications can import the same payload into multiple instances of Vulkan and multiple times into a given Vulkan instance. However, implementations may fail to import the same payload multiple times into a given physical device due to platform constraints.

Importing memory from a particular host pointer may not be possible due to additional platform-specific restrictions beyond the scope of this specification in which case the implementation must fail the memory import operation with the error code ERROR_INVALID_EXTERNAL_HANDLE_KHR.

Whether device memory objects imported from a host pointer hold a reference to their payload is undefined. As such, the application must ensure that the imported memory range remains valid and accessible for the lifetime of the imported memory object.

Valid Usage

If handleType is not 0, it must be supported for import, as reported in ExternalMemoryProperties

If handleType is not 0, it must be EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT or EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT
pHostPointer must be a pointer aligned to an integer multiple of PhysicalDeviceExternalMemoryHostPropertiesEXT::minImportedHostPointerAlignment
If handleType is EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT, pHostPointer must be a pointer to allocationSize number of bytes of host memory, where allocationSize is the member of the MemoryAllocateInfo structure this structure is chained to
If handleType is EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT, pHostPointer must be a pointer to allocationSize number of bytes of host mapped foreign memory, where allocationSize is the member of the MemoryAllocateInfo structure this structure is chained to

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_IMPORT_MEMORY_HOST_POINTER_INFO_EXT

handleType must be a valid ExternalMemoryHandleTypeFlagBits value
pHostPointer must be a pointer value

Description

The value returned by memoryTypeBits must only include bits that identify memory types which are host visible.

Valid Usage (Implicit)

Description

If the PhysicalDeviceExternalMemoryHostPropertiesEXT structure is included in the pNext chain of the PhysicalDeviceProperties2 structure passed to getPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Storable ImportMemoryHostPointerInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods sizeOf :: ImportMemoryHostPointerInfoEXT -> Int # alignment :: ImportMemoryHostPointerInfoEXT -> Int # peekElemOff :: Ptr ImportMemoryHostPointerInfoEXT -> Int -> IO ImportMemoryHostPointerInfoEXT # pokeElemOff :: Ptr ImportMemoryHostPointerInfoEXT -> Int -> ImportMemoryHostPointerInfoEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO ImportMemoryHostPointerInfoEXT # pokeByteOff :: Ptr b -> Int -> ImportMemoryHostPointerInfoEXT -> IO () # peek :: Ptr ImportMemoryHostPointerInfoEXT -> IO ImportMemoryHostPointerInfoEXT # poke :: Ptr ImportMemoryHostPointerInfoEXT -> ImportMemoryHostPointerInfoEXT -> IO () #
Show ImportMemoryHostPointerInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods showsPrec :: Int -> ImportMemoryHostPointerInfoEXT -> ShowS # show :: ImportMemoryHostPointerInfoEXT -> String # showList :: [ImportMemoryHostPointerInfoEXT] -> ShowS #
FromCStruct ImportMemoryHostPointerInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods peekCStruct :: Ptr ImportMemoryHostPointerInfoEXT -> IO ImportMemoryHostPointerInfoEXT Source #
ToCStruct ImportMemoryHostPointerInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods withCStruct :: ImportMemoryHostPointerInfoEXT -> (Ptr ImportMemoryHostPointerInfoEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr ImportMemoryHostPointerInfoEXT -> ImportMemoryHostPointerInfoEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr ImportMemoryHostPointerInfoEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr ImportMemoryHostPointerInfoEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero ImportMemoryHostPointerInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods zero :: ImportMemoryHostPointerInfoEXT Source #

Storable MemoryHostPointerPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods sizeOf :: MemoryHostPointerPropertiesEXT -> Int # alignment :: MemoryHostPointerPropertiesEXT -> Int # peekElemOff :: Ptr MemoryHostPointerPropertiesEXT -> Int -> IO MemoryHostPointerPropertiesEXT # pokeElemOff :: Ptr MemoryHostPointerPropertiesEXT -> Int -> MemoryHostPointerPropertiesEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO MemoryHostPointerPropertiesEXT # pokeByteOff :: Ptr b -> Int -> MemoryHostPointerPropertiesEXT -> IO () # peek :: Ptr MemoryHostPointerPropertiesEXT -> IO MemoryHostPointerPropertiesEXT # poke :: Ptr MemoryHostPointerPropertiesEXT -> MemoryHostPointerPropertiesEXT -> IO () #
Show MemoryHostPointerPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods showsPrec :: Int -> MemoryHostPointerPropertiesEXT -> ShowS # show :: MemoryHostPointerPropertiesEXT -> String # showList :: [MemoryHostPointerPropertiesEXT] -> ShowS #
Eq MemoryHostPointerPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods (==) :: MemoryHostPointerPropertiesEXT -> MemoryHostPointerPropertiesEXT -> Bool # (/=) :: MemoryHostPointerPropertiesEXT -> MemoryHostPointerPropertiesEXT -> Bool #
FromCStruct MemoryHostPointerPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods peekCStruct :: Ptr MemoryHostPointerPropertiesEXT -> IO MemoryHostPointerPropertiesEXT Source #
ToCStruct MemoryHostPointerPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods withCStruct :: MemoryHostPointerPropertiesEXT -> (Ptr MemoryHostPointerPropertiesEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr MemoryHostPointerPropertiesEXT -> MemoryHostPointerPropertiesEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr MemoryHostPointerPropertiesEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr MemoryHostPointerPropertiesEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero MemoryHostPointerPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods zero :: MemoryHostPointerPropertiesEXT Source #

Storable PhysicalDeviceExternalMemoryHostPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods sizeOf :: PhysicalDeviceExternalMemoryHostPropertiesEXT -> Int # alignment :: PhysicalDeviceExternalMemoryHostPropertiesEXT -> Int # peekElemOff :: Ptr PhysicalDeviceExternalMemoryHostPropertiesEXT -> Int -> IO PhysicalDeviceExternalMemoryHostPropertiesEXT # pokeElemOff :: Ptr PhysicalDeviceExternalMemoryHostPropertiesEXT -> Int -> PhysicalDeviceExternalMemoryHostPropertiesEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceExternalMemoryHostPropertiesEXT # pokeByteOff :: Ptr b -> Int -> PhysicalDeviceExternalMemoryHostPropertiesEXT -> IO () # peek :: Ptr PhysicalDeviceExternalMemoryHostPropertiesEXT -> IO PhysicalDeviceExternalMemoryHostPropertiesEXT # poke :: Ptr PhysicalDeviceExternalMemoryHostPropertiesEXT -> PhysicalDeviceExternalMemoryHostPropertiesEXT -> IO () #
Show PhysicalDeviceExternalMemoryHostPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods showsPrec :: Int -> PhysicalDeviceExternalMemoryHostPropertiesEXT -> ShowS # show :: PhysicalDeviceExternalMemoryHostPropertiesEXT -> String # showList :: [PhysicalDeviceExternalMemoryHostPropertiesEXT] -> ShowS #
Eq PhysicalDeviceExternalMemoryHostPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods (==) :: PhysicalDeviceExternalMemoryHostPropertiesEXT -> PhysicalDeviceExternalMemoryHostPropertiesEXT -> Bool # (/=) :: PhysicalDeviceExternalMemoryHostPropertiesEXT -> PhysicalDeviceExternalMemoryHostPropertiesEXT -> Bool #
FromCStruct PhysicalDeviceExternalMemoryHostPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods peekCStruct :: Ptr PhysicalDeviceExternalMemoryHostPropertiesEXT -> IO PhysicalDeviceExternalMemoryHostPropertiesEXT Source #
ToCStruct PhysicalDeviceExternalMemoryHostPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods withCStruct :: PhysicalDeviceExternalMemoryHostPropertiesEXT -> (Ptr PhysicalDeviceExternalMemoryHostPropertiesEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceExternalMemoryHostPropertiesEXT -> PhysicalDeviceExternalMemoryHostPropertiesEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceExternalMemoryHostPropertiesEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceExternalMemoryHostPropertiesEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDeviceExternalMemoryHostPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods zero :: PhysicalDeviceExternalMemoryHostPropertiesEXT Source #

Name

VK_EXT_external_memory_host

Other Extension Metadata

Description

New Commands

New Structures

New Enum Constants

Issues

Version History

See Also

Document Notes

Documentation

Valid Usage

Valid Usage (Implicit)

Return Codes

See Also

Description

Valid Usage

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

ImportMemoryHostPointerInfoEXT
Fields handleType :: ExternalMemoryHandleTypeFlagBits `handleType` is a `ExternalMemoryHandleTypeFlagBits` value specifying the handle type. hostPointer :: Ptr () `pHostPointer` is the host pointer to import from.

MemoryHostPointerPropertiesEXT
Fields memoryTypeBits :: Word32 `memoryTypeBits` is a bitmask containing one bit set for every memory type which the specified host pointer can be imported as.

PhysicalDeviceExternalMemoryHostPropertiesEXT
Fields minImportedHostPointerAlignment :: DeviceSize `minImportedHostPointerAlignment` is the minimum required alignment, in bytes, for the base address and size of host pointers that can be imported to a Vulkan memory object. The value must be a power of two.