{-# language CPP #-} module Vulkan.Extensions.VK_KHR_external_semaphore_fd ( getSemaphoreFdKHR , importSemaphoreFdKHR , ImportSemaphoreFdInfoKHR(..) , SemaphoreGetFdInfoKHR(..) , KHR_EXTERNAL_SEMAPHORE_FD_SPEC_VERSION , pattern KHR_EXTERNAL_SEMAPHORE_FD_SPEC_VERSION , KHR_EXTERNAL_SEMAPHORE_FD_EXTENSION_NAME , pattern KHR_EXTERNAL_SEMAPHORE_FD_EXTENSION_NAME ) where import Control.Exception.Base (bracket) import Control.Monad (unless) import Control.Monad.IO.Class (liftIO) import Foreign.Marshal.Alloc (allocaBytesAligned) import Foreign.Marshal.Alloc (callocBytes) import Foreign.Marshal.Alloc (free) import GHC.Base (when) import GHC.IO (throwIO) import GHC.Ptr (nullFunPtr) import Foreign.Ptr (nullPtr) import Foreign.Ptr (plusPtr) import Control.Monad.Trans.Class (lift) import Control.Monad.Trans.Cont (evalContT) import Foreign.C.Types (CInt(..)) import Control.Monad.IO.Class (MonadIO) import Data.String (IsString) import Data.Typeable (Typeable) import Foreign.C.Types (CInt) import Foreign.C.Types (CInt(CInt)) import Foreign.Storable (Storable) import Foreign.Storable (Storable(peek)) import Foreign.Storable (Storable(poke)) import qualified Foreign.Storable (Storable(..)) import GHC.Generics (Generic) import GHC.IO.Exception (IOErrorType(..)) import GHC.IO.Exception (IOException(..)) import Data.Int (Int32) import Foreign.Ptr (FunPtr) import Foreign.Ptr (Ptr) import Data.Kind (Type) import Control.Monad.Trans.Cont (ContT(..)) import Vulkan.NamedType ((:::)) import Vulkan.Core10.Handles (Device) import Vulkan.Core10.Handles (Device(..)) import Vulkan.Dynamic (DeviceCmds(pVkGetSemaphoreFdKHR)) import Vulkan.Dynamic (DeviceCmds(pVkImportSemaphoreFdKHR)) import Vulkan.Core10.Handles (Device_T) import Vulkan.Core11.Enums.ExternalSemaphoreHandleTypeFlagBits (ExternalSemaphoreHandleTypeFlagBits) import Vulkan.CStruct (FromCStruct) import Vulkan.CStruct (FromCStruct(..)) import Vulkan.Core10.Enums.Result (Result) import Vulkan.Core10.Enums.Result (Result(..)) import Vulkan.Core10.Handles (Semaphore) import Vulkan.Core11.Enums.SemaphoreImportFlagBits (SemaphoreImportFlags) import Vulkan.Core10.Enums.StructureType (StructureType) import Vulkan.CStruct (ToCStruct) import Vulkan.CStruct (ToCStruct(..)) import Vulkan.Exception (VulkanException(..)) import Vulkan.Zero (Zero(..)) import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_IMPORT_SEMAPHORE_FD_INFO_KHR)) import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_SEMAPHORE_GET_FD_INFO_KHR)) import Vulkan.Core10.Enums.Result (Result(SUCCESS)) foreign import ccall #if !defined(SAFE_FOREIGN_CALLS) unsafe #endif "dynamic" mkVkGetSemaphoreFdKHR :: FunPtr (Ptr Device_T -> Ptr SemaphoreGetFdInfoKHR -> Ptr CInt -> IO Result) -> Ptr Device_T -> Ptr SemaphoreGetFdInfoKHR -> Ptr CInt -> IO Result -- | vkGetSemaphoreFdKHR - Get a POSIX file descriptor handle for a semaphore -- -- = Description -- -- Each call to 'getSemaphoreFdKHR' /must/ create a new file descriptor and -- transfer ownership of it to the application. To avoid leaking resources, -- the application /must/ release ownership of the file descriptor when it -- is no longer needed. -- -- Note -- -- Ownership can be released in many ways. For example, the application can -- call @close@() on the file descriptor, or transfer ownership back to -- Vulkan by using the file descriptor to import a semaphore payload. -- -- Where supported by the operating system, the implementation /must/ set -- the file descriptor to be closed automatically when an @execve@ system -- call is made. -- -- Exporting a file descriptor from a semaphore /may/ have side effects -- depending on the transference of the specified handle type, as described -- in -- . -- -- == Return Codes -- -- [] -- -- - 'Vulkan.Core10.Enums.Result.SUCCESS' -- -- [] -- -- - 'Vulkan.Core10.Enums.Result.ERROR_TOO_MANY_OBJECTS' -- -- - 'Vulkan.Core10.Enums.Result.ERROR_OUT_OF_HOST_MEMORY' -- -- = See Also -- -- 'Vulkan.Core10.Handles.Device', 'SemaphoreGetFdInfoKHR' getSemaphoreFdKHR :: forall io . (MonadIO io) => -- | @device@ is the logical device that created the semaphore being -- exported. -- -- @device@ /must/ be a valid 'Vulkan.Core10.Handles.Device' handle Device -> -- | @pGetFdInfo@ is a pointer to a 'SemaphoreGetFdInfoKHR' structure -- containing parameters of the export operation. -- -- @pGetFdInfo@ /must/ be a valid pointer to a valid -- 'SemaphoreGetFdInfoKHR' structure SemaphoreGetFdInfoKHR -> io (("fd" ::: Int32)) getSemaphoreFdKHR device getFdInfo = liftIO . evalContT $ do let vkGetSemaphoreFdKHRPtr = pVkGetSemaphoreFdKHR (deviceCmds (device :: Device)) lift $ unless (vkGetSemaphoreFdKHRPtr /= nullFunPtr) $ throwIO $ IOError Nothing InvalidArgument "" "The function pointer for vkGetSemaphoreFdKHR is null" Nothing Nothing let vkGetSemaphoreFdKHR' = mkVkGetSemaphoreFdKHR vkGetSemaphoreFdKHRPtr pGetFdInfo <- ContT $ withCStruct (getFdInfo) pPFd <- ContT $ bracket (callocBytes @CInt 4) free r <- lift $ vkGetSemaphoreFdKHR' (deviceHandle (device)) pGetFdInfo (pPFd) lift $ when (r < SUCCESS) (throwIO (VulkanException r)) pFd <- lift $ peek @CInt pPFd pure $ (((\(CInt a) -> a) pFd)) foreign import ccall #if !defined(SAFE_FOREIGN_CALLS) unsafe #endif "dynamic" mkVkImportSemaphoreFdKHR :: FunPtr (Ptr Device_T -> Ptr ImportSemaphoreFdInfoKHR -> IO Result) -> Ptr Device_T -> Ptr ImportSemaphoreFdInfoKHR -> IO Result -- | vkImportSemaphoreFdKHR - Import a semaphore from a POSIX file descriptor -- -- = Description -- -- Importing a semaphore payload 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. -- -- Applications /can/ import the same semaphore payload into multiple -- instances of Vulkan, into the same instance from which it was exported, -- and multiple times into a given Vulkan instance. -- -- == Return Codes -- -- [] -- -- - 'Vulkan.Core10.Enums.Result.SUCCESS' -- -- [] -- -- - 'Vulkan.Core10.Enums.Result.ERROR_OUT_OF_HOST_MEMORY' -- -- - 'Vulkan.Core10.Enums.Result.ERROR_INVALID_EXTERNAL_HANDLE' -- -- = See Also -- -- 'Vulkan.Core10.Handles.Device', 'ImportSemaphoreFdInfoKHR' importSemaphoreFdKHR :: forall io . (MonadIO io) => -- | @device@ is the logical device that created the semaphore. -- -- @device@ /must/ be a valid 'Vulkan.Core10.Handles.Device' handle Device -> -- | @pImportSemaphoreFdInfo@ is a pointer to a 'ImportSemaphoreFdInfoKHR' -- structure specifying the semaphore and import parameters. -- -- @pImportSemaphoreFdInfo@ /must/ be a valid pointer to a valid -- 'ImportSemaphoreFdInfoKHR' structure ImportSemaphoreFdInfoKHR -> io () importSemaphoreFdKHR device importSemaphoreFdInfo = liftIO . evalContT $ do let vkImportSemaphoreFdKHRPtr = pVkImportSemaphoreFdKHR (deviceCmds (device :: Device)) lift $ unless (vkImportSemaphoreFdKHRPtr /= nullFunPtr) $ throwIO $ IOError Nothing InvalidArgument "" "The function pointer for vkImportSemaphoreFdKHR is null" Nothing Nothing let vkImportSemaphoreFdKHR' = mkVkImportSemaphoreFdKHR vkImportSemaphoreFdKHRPtr pImportSemaphoreFdInfo <- ContT $ withCStruct (importSemaphoreFdInfo) r <- lift $ vkImportSemaphoreFdKHR' (deviceHandle (device)) pImportSemaphoreFdInfo lift $ when (r < SUCCESS) (throwIO (VulkanException r)) -- | VkImportSemaphoreFdInfoKHR - Structure specifying POSIX file descriptor -- to import to a semaphore -- -- = Description -- -- The handle types supported by @handleType@ are: -- -- +--------------------------------------------------------------------------------------------------------+----------------------+-----------------------+ -- | Handle Type | Transference | Permanence Supported | -- +========================================================================================================+======================+=======================+ -- | 'Vulkan.Core11.Enums.ExternalSemaphoreHandleTypeFlagBits.EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_FD_BIT' | Reference | Temporary,Permanent | -- +--------------------------------------------------------------------------------------------------------+----------------------+-----------------------+ -- | 'Vulkan.Core11.Enums.ExternalSemaphoreHandleTypeFlagBits.EXTERNAL_SEMAPHORE_HANDLE_TYPE_SYNC_FD_BIT' | Copy | Temporary | -- +--------------------------------------------------------------------------------------------------------+----------------------+-----------------------+ -- -- Handle Types Supported by 'ImportSemaphoreFdInfoKHR' -- -- == Valid Usage -- -- - @handleType@ /must/ be a value included in the -- -- table -- -- - @fd@ /must/ obey any requirements listed for @handleType@ in -- -- -- - If @handleType@ is -- 'Vulkan.Core11.Enums.ExternalSemaphoreHandleTypeFlagBits.EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_FD_BIT', -- the 'Vulkan.Core10.QueueSemaphore.SemaphoreCreateInfo'::@flags@ -- field /must/ match that of the semaphore from which @fd@ was -- exported -- -- - If @handleType@ is -- 'Vulkan.Core11.Enums.ExternalSemaphoreHandleTypeFlagBits.EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_FD_BIT', -- the -- 'Vulkan.Core12.Promoted_From_VK_KHR_timeline_semaphore.SemaphoreTypeCreateInfo'::@semaphoreType@ -- field /must/ match that of the semaphore from which @fd@ was -- exported -- -- - If @flags@ contains -- 'Vulkan.Core11.Enums.SemaphoreImportFlagBits.SEMAPHORE_IMPORT_TEMPORARY_BIT', -- the -- 'Vulkan.Core12.Promoted_From_VK_KHR_timeline_semaphore.SemaphoreTypeCreateInfo'::@semaphoreType@ -- field of the semaphore from which @fd@ was exported /must/ not be -- 'Vulkan.Core12.Enums.SemaphoreType.SEMAPHORE_TYPE_TIMELINE' -- -- If @handleType@ is -- 'Vulkan.Core11.Enums.ExternalSemaphoreHandleTypeFlagBits.EXTERNAL_SEMAPHORE_HANDLE_TYPE_SYNC_FD_BIT', -- the special value @-1@ for @fd@ is treated like a valid sync file -- descriptor referring to an object that has already signaled. The import -- operation will succeed and the 'Vulkan.Core10.Handles.Semaphore' will -- have a temporarily imported payload as if a valid file descriptor had -- been provided. -- -- Note -- -- This special behavior for importing an invalid sync file descriptor -- allows easier interoperability with other system APIs which use the -- convention that an invalid sync file descriptor represents work that has -- already completed and does not need to be waited for. It is consistent -- with the option for implementations to return a @-1@ file descriptor -- when exporting a -- 'Vulkan.Core11.Enums.ExternalSemaphoreHandleTypeFlagBits.EXTERNAL_SEMAPHORE_HANDLE_TYPE_SYNC_FD_BIT' -- from a 'Vulkan.Core10.Handles.Semaphore' which is signaled. -- -- == Valid Usage (Implicit) -- -- - @sType@ /must/ be -- 'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_IMPORT_SEMAPHORE_FD_INFO_KHR' -- -- - @pNext@ /must/ be @NULL@ -- -- - @semaphore@ /must/ be a valid 'Vulkan.Core10.Handles.Semaphore' -- handle -- -- - @flags@ /must/ be a valid combination of -- 'Vulkan.Core11.Enums.SemaphoreImportFlagBits.SemaphoreImportFlagBits' -- values -- -- - @handleType@ /must/ be a valid -- 'Vulkan.Core11.Enums.ExternalSemaphoreHandleTypeFlagBits.ExternalSemaphoreHandleTypeFlagBits' -- value -- -- == Host Synchronization -- -- - Host access to @semaphore@ /must/ be externally synchronized -- -- = See Also -- -- 'Vulkan.Core11.Enums.ExternalSemaphoreHandleTypeFlagBits.ExternalSemaphoreHandleTypeFlagBits', -- 'Vulkan.Core10.Handles.Semaphore', -- 'Vulkan.Core11.Enums.SemaphoreImportFlagBits.SemaphoreImportFlags', -- 'Vulkan.Core10.Enums.StructureType.StructureType', -- 'importSemaphoreFdKHR' data ImportSemaphoreFdInfoKHR = ImportSemaphoreFdInfoKHR { -- | @semaphore@ is the semaphore into which the payload will be imported. semaphore :: Semaphore , -- | @flags@ is a bitmask of -- 'Vulkan.Core11.Enums.SemaphoreImportFlagBits.SemaphoreImportFlagBits' -- specifying additional parameters for the semaphore payload import -- operation. flags :: SemaphoreImportFlags , -- | @handleType@ specifies the type of @fd@. handleType :: ExternalSemaphoreHandleTypeFlagBits , -- | @fd@ is the external handle to import. fd :: Int32 } deriving (Typeable, Eq) #if defined(GENERIC_INSTANCES) deriving instance Generic (ImportSemaphoreFdInfoKHR) #endif deriving instance Show ImportSemaphoreFdInfoKHR instance ToCStruct ImportSemaphoreFdInfoKHR where withCStruct x f = allocaBytesAligned 40 8 $ \p -> pokeCStruct p x (f p) pokeCStruct p ImportSemaphoreFdInfoKHR{..} f = do poke ((p `plusPtr` 0 :: Ptr StructureType)) (STRUCTURE_TYPE_IMPORT_SEMAPHORE_FD_INFO_KHR) poke ((p `plusPtr` 8 :: Ptr (Ptr ()))) (nullPtr) poke ((p `plusPtr` 16 :: Ptr Semaphore)) (semaphore) poke ((p `plusPtr` 24 :: Ptr SemaphoreImportFlags)) (flags) poke ((p `plusPtr` 28 :: Ptr ExternalSemaphoreHandleTypeFlagBits)) (handleType) poke ((p `plusPtr` 32 :: Ptr CInt)) (CInt (fd)) f cStructSize = 40 cStructAlignment = 8 pokeZeroCStruct p f = do poke ((p `plusPtr` 0 :: Ptr StructureType)) (STRUCTURE_TYPE_IMPORT_SEMAPHORE_FD_INFO_KHR) poke ((p `plusPtr` 8 :: Ptr (Ptr ()))) (nullPtr) poke ((p `plusPtr` 16 :: Ptr Semaphore)) (zero) poke ((p `plusPtr` 28 :: Ptr ExternalSemaphoreHandleTypeFlagBits)) (zero) poke ((p `plusPtr` 32 :: Ptr CInt)) (CInt (zero)) f instance FromCStruct ImportSemaphoreFdInfoKHR where peekCStruct p = do semaphore <- peek @Semaphore ((p `plusPtr` 16 :: Ptr Semaphore)) flags <- peek @SemaphoreImportFlags ((p `plusPtr` 24 :: Ptr SemaphoreImportFlags)) handleType <- peek @ExternalSemaphoreHandleTypeFlagBits ((p `plusPtr` 28 :: Ptr ExternalSemaphoreHandleTypeFlagBits)) fd <- peek @CInt ((p `plusPtr` 32 :: Ptr CInt)) pure $ ImportSemaphoreFdInfoKHR semaphore flags handleType ((\(CInt a) -> a) fd) instance Storable ImportSemaphoreFdInfoKHR where sizeOf ~_ = 40 alignment ~_ = 8 peek = peekCStruct poke ptr poked = pokeCStruct ptr poked (pure ()) instance Zero ImportSemaphoreFdInfoKHR where zero = ImportSemaphoreFdInfoKHR zero zero zero zero -- | VkSemaphoreGetFdInfoKHR - Structure describing a POSIX FD semaphore -- export operation -- -- = Description -- -- The properties of the file descriptor returned depend on the value of -- @handleType@. See -- 'Vulkan.Core11.Enums.ExternalSemaphoreHandleTypeFlagBits.ExternalSemaphoreHandleTypeFlagBits' -- for a description of the properties of the defined external semaphore -- handle types. -- -- == Valid Usage -- -- - @handleType@ /must/ have been included in -- 'Vulkan.Core11.Promoted_From_VK_KHR_external_semaphore.ExportSemaphoreCreateInfo'::@handleTypes@ -- when @semaphore@’s current payload was created -- -- - @semaphore@ /must/ not currently have its payload replaced by an -- imported payload as described below in -- -- unless that imported payload’s handle type was included in -- 'Vulkan.Core11.Promoted_From_VK_KHR_external_semaphore_capabilities.ExternalSemaphoreProperties'::@exportFromImportedHandleTypes@ -- for @handleType@ -- -- - If @handleType@ refers to a handle type with copy payload -- transference semantics, as defined below in -- , -- there /must/ be no queue waiting on @semaphore@ -- -- - If @handleType@ refers to a handle type with copy payload -- transference semantics, @semaphore@ /must/ be signaled, or have an -- associated -- -- pending execution -- -- - @handleType@ /must/ be defined as a POSIX file descriptor handle -- -- - If @handleType@ refers to a handle type with copy payload -- transference semantics, @semaphore@ /must/ have been created with a -- 'Vulkan.Core12.Enums.SemaphoreType.SemaphoreType' of -- 'Vulkan.Core12.Enums.SemaphoreType.SEMAPHORE_TYPE_BINARY' -- -- - If @handleType@ refers to a handle type with copy payload -- transference semantics, @semaphore@ /must/ have an associated -- semaphore signal operation that has been submitted for execution and -- any semaphore signal operations on which it depends (if any) /must/ -- have also been submitted for execution -- -- == Valid Usage (Implicit) -- -- - @sType@ /must/ be -- 'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_SEMAPHORE_GET_FD_INFO_KHR' -- -- - @pNext@ /must/ be @NULL@ -- -- - @semaphore@ /must/ be a valid 'Vulkan.Core10.Handles.Semaphore' -- handle -- -- - @handleType@ /must/ be a valid -- 'Vulkan.Core11.Enums.ExternalSemaphoreHandleTypeFlagBits.ExternalSemaphoreHandleTypeFlagBits' -- value -- -- = See Also -- -- 'Vulkan.Core11.Enums.ExternalSemaphoreHandleTypeFlagBits.ExternalSemaphoreHandleTypeFlagBits', -- 'Vulkan.Core10.Handles.Semaphore', -- 'Vulkan.Core10.Enums.StructureType.StructureType', 'getSemaphoreFdKHR' data SemaphoreGetFdInfoKHR = SemaphoreGetFdInfoKHR { -- | @semaphore@ is the semaphore from which state will be exported. semaphore :: Semaphore , -- | @handleType@ is the type of handle requested. handleType :: ExternalSemaphoreHandleTypeFlagBits } deriving (Typeable, Eq) #if defined(GENERIC_INSTANCES) deriving instance Generic (SemaphoreGetFdInfoKHR) #endif deriving instance Show SemaphoreGetFdInfoKHR instance ToCStruct SemaphoreGetFdInfoKHR where withCStruct x f = allocaBytesAligned 32 8 $ \p -> pokeCStruct p x (f p) pokeCStruct p SemaphoreGetFdInfoKHR{..} f = do poke ((p `plusPtr` 0 :: Ptr StructureType)) (STRUCTURE_TYPE_SEMAPHORE_GET_FD_INFO_KHR) poke ((p `plusPtr` 8 :: Ptr (Ptr ()))) (nullPtr) poke ((p `plusPtr` 16 :: Ptr Semaphore)) (semaphore) poke ((p `plusPtr` 24 :: Ptr ExternalSemaphoreHandleTypeFlagBits)) (handleType) f cStructSize = 32 cStructAlignment = 8 pokeZeroCStruct p f = do poke ((p `plusPtr` 0 :: Ptr StructureType)) (STRUCTURE_TYPE_SEMAPHORE_GET_FD_INFO_KHR) poke ((p `plusPtr` 8 :: Ptr (Ptr ()))) (nullPtr) poke ((p `plusPtr` 16 :: Ptr Semaphore)) (zero) poke ((p `plusPtr` 24 :: Ptr ExternalSemaphoreHandleTypeFlagBits)) (zero) f instance FromCStruct SemaphoreGetFdInfoKHR where peekCStruct p = do semaphore <- peek @Semaphore ((p `plusPtr` 16 :: Ptr Semaphore)) handleType <- peek @ExternalSemaphoreHandleTypeFlagBits ((p `plusPtr` 24 :: Ptr ExternalSemaphoreHandleTypeFlagBits)) pure $ SemaphoreGetFdInfoKHR semaphore handleType instance Storable SemaphoreGetFdInfoKHR where sizeOf ~_ = 32 alignment ~_ = 8 peek = peekCStruct poke ptr poked = pokeCStruct ptr poked (pure ()) instance Zero SemaphoreGetFdInfoKHR where zero = SemaphoreGetFdInfoKHR zero zero type KHR_EXTERNAL_SEMAPHORE_FD_SPEC_VERSION = 1 -- No documentation found for TopLevel "VK_KHR_EXTERNAL_SEMAPHORE_FD_SPEC_VERSION" pattern KHR_EXTERNAL_SEMAPHORE_FD_SPEC_VERSION :: forall a . Integral a => a pattern KHR_EXTERNAL_SEMAPHORE_FD_SPEC_VERSION = 1 type KHR_EXTERNAL_SEMAPHORE_FD_EXTENSION_NAME = "VK_KHR_external_semaphore_fd" -- No documentation found for TopLevel "VK_KHR_EXTERNAL_SEMAPHORE_FD_EXTENSION_NAME" pattern KHR_EXTERNAL_SEMAPHORE_FD_EXTENSION_NAME :: forall a . (Eq a, IsString a) => a pattern KHR_EXTERNAL_SEMAPHORE_FD_EXTENSION_NAME = "VK_KHR_external_semaphore_fd"