Safe Haskell	None
Language	GHC2021

Language.Futhark.Interpreter.FFI.ServerM

Synopsis

type TypeName = Text
data ValueRef
data Server
startServer :: ServerCfg -> IO Server
newServer :: Server -> IO Server
stopServer :: Server -> IO (Maybe Text)
data ServerM a
runServerM :: Server -> ServerM a -> IO (Either String a)
gc :: ServerM ()
release :: [(ValueRef, VarName)] -> ServerM [VarName]
call :: Name -> [ValueRef] -> ServerM ValueRef
inputs :: Name -> ServerM [TypeName]
output :: Name -> ServerM TypeName
kind :: TypeName -> ServerM Kind
vtype :: ValueRef -> ServerM TypeName
getPrim :: ValueRef -> ServerM PrimValue
putPrim :: PrimValue -> ServerM ValueRef
putData :: Value -> ServerM ValueRef
getData :: ValueRef -> ServerM (Maybe Value)
rank :: TypeName -> ServerM Int
elemType :: TypeName -> ServerM TypeName
mkArray :: TypeName -> [Int64] -> [ValueRef] -> ServerM ValueRef
shape :: ValueRef -> ServerM [Int64]
index :: [Int64] -> ValueRef -> ServerM ValueRef
fieldOrder :: TypeName -> ServerM [(Name, TypeName)]
mkRecord :: TypeName -> Map Name ValueRef -> ServerM ValueRef
project :: ValueRef -> Name -> ServerM ValueRef
unzipArray :: ValueRef -> Int -> ServerM [ValueRef]
variants :: TypeName -> ServerM (Map Name [TypeName])
mkSum :: TypeName -> Name -> [ValueRef] -> ServerM ValueRef
destruct :: ValueRef -> ServerM (Name, [ValueRef])
throwNothing :: MonadError String m => String -> Maybe a -> m a

Documentation

type TypeName = Text #

The name of a server-side type.

data ValueRef Source #

data Server Source #

startServer :: ServerCfg -> IO Server Source #

newServer :: Server -> IO Server Source #

Use an already-running server. Shutting it down remains the responsibility of whoever started it.

stopServer :: Server -> IO (Maybe Text) Source #

Shut down the server. Returns a message on termination failure.

data ServerM a Source #

Instances

Instances details

Applicative ServerM Source #
Instance details Defined in Language.Futhark.Interpreter.FFI.ServerM Methods pure :: a -> ServerM a # (<>) :: ServerM (a -> b) -> ServerM a -> ServerM b # liftA2 :: (a -> b -> c) -> ServerM a -> ServerM b -> ServerM c # (>) :: ServerM a -> ServerM b -> ServerM b # (<*) :: ServerM a -> ServerM b -> ServerM a #
Functor ServerM Source #
Instance details Defined in Language.Futhark.Interpreter.FFI.ServerM Methods fmap :: (a -> b) -> ServerM a -> ServerM b # (<$) :: a -> ServerM b -> ServerM a #
Monad ServerM Source #
Instance details Defined in Language.Futhark.Interpreter.FFI.ServerM Methods (>>=) :: ServerM a -> (a -> ServerM b) -> ServerM b # (>>) :: ServerM a -> ServerM b -> ServerM b # return :: a -> ServerM a #
MonadIO ServerM Source #
Instance details Defined in Language.Futhark.Interpreter.FFI.ServerM Methods liftIO :: IO a -> ServerM a #
MonadError String ServerM Source #
Instance details Defined in Language.Futhark.Interpreter.FFI.ServerM Methods throwError :: String -> ServerM a # catchError :: ServerM a -> (String -> ServerM a) -> ServerM a #

runServerM :: Server -> ServerM a -> IO (Either String a) Source #

gc :: ServerM () Source #

release :: [(ValueRef, VarName)] -> ServerM [VarName] Source #

End the use of this Server. The variables of the given values are adopted by the caller under the given names, and every other variable we have created is freed, whether or not its ValueRef is still reachable. Neither the Server nor any ValueRef may be used afterwards. A variable may occur more than once, in which case it is adopted under the first of its names. Returns the name of the variable of each value.

call :: Name -> [ValueRef] -> ServerM ValueRef Source #

inputs :: Name -> ServerM [TypeName] Source #

output :: Name -> ServerM TypeName Source #

kind :: TypeName -> ServerM Kind Source #

vtype :: ValueRef -> ServerM TypeName Source #

getPrim :: ValueRef -> ServerM PrimValue Source #

putPrim :: PrimValue -> ServerM ValueRef Source #

putData :: Value -> ServerM ValueRef Source #

Put an entire value on the server at once. This is only possible for values that can be represented in the Futhark data format (primitives and arrays of primitive).

getData :: ValueRef -> ServerM (Maybe Value) Source #

Retrieve an entire value from the server at once. This is only possible for values that can be represented in the Futhark data format (primitives and arrays of primitive).

rank :: TypeName -> ServerM Int Source #

elemType :: TypeName -> ServerM TypeName Source #

mkArray :: TypeName -> [Int64] -> [ValueRef] -> ServerM ValueRef Source #

shape :: ValueRef -> ServerM [Int64] Source #

index :: [Int64] -> ValueRef -> ServerM ValueRef Source #

fieldOrder :: TypeName -> ServerM [(Name, TypeName)] Source #

The fields of a record type, in the order the server uses.

mkRecord :: TypeName -> Map Name ValueRef -> ServerM ValueRef Source #

project :: ValueRef -> Name -> ServerM ValueRef Source #

unzipArray :: ValueRef -> Int -> ServerM [ValueRef] Source #

Split an array of records into one array per field, in fieldOrder. The fields of an array cannot be projected one element at a time, and doing so would anyway be impossible for an empty array.

variants :: TypeName -> ServerM (Map Name [TypeName]) Source #

mkSum :: TypeName -> Name -> [ValueRef] -> ServerM ValueRef Source #

destruct :: ValueRef -> ServerM (Name, [ValueRef]) Source #

The variant of a sum, and its payload.

throwNothing :: MonadError String m => String -> Maybe a -> m a Source #