Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_KHR_external_memory_fd

Description

Name

VK_KHR_external_memory_fd - device extension

VK_KHR_external_memory_fd

Name String: VK_KHR_external_memory_fd

Extension Type

Device extension

Registered Extension Number

75

Revision

1

Extension and Version Dependencies

Requires Vulkan 1.0
Requires VK_KHR_external_memory

Contact

James Jones https://github.com/KhronosGroup/Vulkan-Docs/issues/new?title=VK_KHR_external_memory_fd:%20&body=@cubanismo%20

Other Extension Metadata

Last Modified Date: 2016-10-21

IP Status

No known IP claims.

Contributors

James Jones, NVIDIA
Jeff Juliano, NVIDIA

Description

An application may wish to reference device memory in multiple Vulkan logical devices or instances, in multiple processes, and/or in multiple APIs. This extension enables an application to export POSIX file descriptor handles from Vulkan memory objects and to import Vulkan memory objects from POSIX file descriptor handles exported from other Vulkan memory objects or from similar resources in other APIs.

New Commands

getMemoryFdKHR

getMemoryFdPropertiesKHR

New Structures

MemoryFdPropertiesKHR

MemoryGetFdInfoKHR
Extending MemoryAllocateInfo:
- ImportMemoryFdInfoKHR

New Enum Constants

KHR_EXTERNAL_MEMORY_FD_EXTENSION_NAME

Issues

1) Does the application need to close the file descriptor returned by getMemoryFdKHR?

RESOLVED: Yes, unless it is passed back in to a driver instance to import the memory. A successful get call transfers ownership of the file descriptor to the application, and a successful import transfers it back to the driver. Destroying the original memory object will not close the file descriptor or remove its reference to the underlying memory resource associated with it.

2) Do drivers ever need to expose multiple file descriptors per memory object?

RESOLVED: No. This would indicate there are actually multiple memory objects, rather than a single memory object.

3) How should the valid size and memory type for POSIX file descriptor memory handles created outside of Vulkan be specified?

RESOLVED: The valid memory types are queried directly from the external handle. The size will be specified by future extensions that introduce such external memory handle types.

Version History

Revision 1, 2016-10-21 (James Jones)
- Initial revision

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

getMemoryFdKHR :: forall io. MonadIO io => Device -> MemoryGetFdInfoKHR -> io ("fd" ::: Int32)
getMemoryFdPropertiesKHR :: forall io. MonadIO io => Device -> ExternalMemoryHandleTypeFlagBits -> ("fd" ::: Int32) -> io MemoryFdPropertiesKHR
data ImportMemoryFdInfoKHR = ImportMemoryFdInfoKHR {
- handleType :: ExternalMemoryHandleTypeFlagBits
- fd :: Int32
}
data MemoryFdPropertiesKHR = MemoryFdPropertiesKHR {
- memoryTypeBits :: Word32
}
data MemoryGetFdInfoKHR = MemoryGetFdInfoKHR {
- memory :: DeviceMemory
- handleType :: ExternalMemoryHandleTypeFlagBits
}
type KHR_EXTERNAL_MEMORY_FD_SPEC_VERSION = 1
pattern KHR_EXTERNAL_MEMORY_FD_SPEC_VERSION :: forall a. Integral a => a
type KHR_EXTERNAL_MEMORY_FD_EXTENSION_NAME = "VK_KHR_external_memory_fd"
pattern KHR_EXTERNAL_MEMORY_FD_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

getMemoryFdKHR Source #

Arguments

:: forall io. MonadIO io
=> Device	`device` is the logical device that created the device memory being exported. `device` must be a valid `Device` handle
-> MemoryGetFdInfoKHR	`pGetFdInfo` is a pointer to a `MemoryGetFdInfoKHR` structure containing parameters of the export operation. `pGetFdInfo` must be a valid pointer to a valid `MemoryGetFdInfoKHR` structure
-> io ("fd" ::: Int32)

vkGetMemoryFdKHR - Get a POSIX file descriptor for a memory object

Description

Each call to getMemoryFdKHR must create a new file descriptor holding a reference to the memory object’s payload and transfer ownership of the file descriptor to the application. To avoid leaking resources, the application must release ownership of the file descriptor using the close system call when it is no longer needed, or by importing a Vulkan memory object from it. Where supported by the operating system, the implementation must set the file descriptor to be closed automatically when an execve system call is made.

Return Codes

Success

SUCCESS

Failure

Description

Importing memory from a file descriptor transfers ownership of the file descriptor from the application to the Vulkan implementation. The application must not perform any operations on the file descriptor after a successful import. The imported memory object holds a reference to its payload.

Applications can import the same payload into multiple instances of Vulkan, into the same instance from which it was exported, and multiple times into a given Vulkan instance. In all cases, each import operation must create a distinct DeviceMemory object.

Valid Usage

If handleType is not 0, it must be supported for import, as reported by ExternalImageFormatProperties or ExternalBufferProperties

The memory from which fd was exported must have been created on the same underlying physical device as device
If handleType is not 0, it must be defined as a POSIX file descriptor handle
If handleType is not 0, fd must be a valid handle of the type specified by handleType
The memory represented by fd must have been created from a physical device and driver that is compatible with device and handleType, as described in https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#external-memory-handle-types-compatibility
fd must obey any requirements listed for handleType in external memory handle types compatibility

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_IMPORT_MEMORY_FD_INFO_KHR

If handleType is not 0, handleType must be a valid ExternalMemoryHandleTypeFlagBits value

Description

The properties of the file descriptor exported depend on the value of handleType. See ExternalMemoryHandleTypeFlagBits for a description of the properties of the defined external memory handle types.

Note

The size of the exported file may be larger than the size requested by MemoryAllocateInfo::allocationSize. If handleType is EXTERNAL_MEMORY_HANDLE_TYPE_DMA_BUF_BIT_EXT, then the application can query the file’s actual size with lseek(2).

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

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

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

Name

VK_KHR_external_memory_fd

Other Extension Metadata

Description

New Commands

New Structures

New Enum Constants

Issues

Version History

See Also

Document Notes

Documentation

Description

Return Codes

See Also

Return Codes

See Also

Description

Valid Usage

Valid Usage (Implicit)

See Also

Instances

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

:: forall io. MonadIO io
=> Device	`device` is the logical device that will be importing `fd`. `device` must be a valid `Device` handle
-> ExternalMemoryHandleTypeFlagBits	`handleType` is the type of the handle `fd`. `handleType` must not be `EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR` `handleType` must be a valid `ExternalMemoryHandleTypeFlagBits` value
-> ("fd" ::: Int32)	`fd` is the handle which will be imported. `fd` must be an external memory handle created outside of the Vulkan API
-> io MemoryFdPropertiesKHR

ImportMemoryFdInfoKHR
Fields handleType :: ExternalMemoryHandleTypeFlagBits `handleType` specifies the handle type of `fd`. fd :: Int32 `fd` is the external handle to import.

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