Safe Haskell	None
Language	Haskell2010

Futhark.CodeGen.Backends.GenericC.Manifest

Description

C manifest data structure and serialisation to JSON.

A manifest contains machine-readable information about the API of the compiled Futhark program. Specifically which entry points are available, which types are exposed, and what their C names are.

Synopsis

data Manifest = Manifest {
- manifestEntryPoints :: Map Text EntryPoint
- manifestTypes :: Map Text Type
- manifestBackend :: Text
}
data Input = Input {
- inputName :: Text
- inputType :: Text
- inputUnique :: Bool
}
data Output = Output {
- outputType :: Text
- outputUnique :: Bool
}
data EntryPoint = EntryPoint {
- entryPointCFun :: Text
- entryPointOutputs :: [Output]
- entryPointInputs :: [Input]
}
data Type
- = TypeArray Text Text Int ArrayOps
- | TypeOpaque Text OpaqueOps
data ArrayOps = ArrayOps {
- arrayFree :: Text
- arrayShape :: Text
- arrayValues :: Text
- arrayNew :: Text
}
data OpaqueOps = OpaqueOps {
- opaqueFree :: Text
- opaqueStore :: Text
- opaqueRestore :: Text
}
manifestToJSON :: Manifest -> Text

Documentation

data Manifest Source #

A manifest for a compiled program.

Constructors

Manifest

Fields

manifestEntryPoints :: Map Text EntryPoint
A mapping from Futhark entry points to how they are represented in C.
manifestTypes :: Map Text Type
A mapping from Futhark type name to how they are represented at the C level. Should not contain any of the primitive scalar types. For array types, these have empty dimensions, e.g. []i32.
manifestBackend :: Text
The compiler backend used to compile the program, e.g. c.

Instances

Instances details

Eq Manifest Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods (==) :: Manifest -> Manifest -> Bool # (/=) :: Manifest -> Manifest -> Bool #
Ord Manifest Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods compare :: Manifest -> Manifest -> Ordering # (<) :: Manifest -> Manifest -> Bool # (<=) :: Manifest -> Manifest -> Bool # (>) :: Manifest -> Manifest -> Bool # (>=) :: Manifest -> Manifest -> Bool # max :: Manifest -> Manifest -> Manifest # min :: Manifest -> Manifest -> Manifest #
Show Manifest Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods showsPrec :: Int -> Manifest -> ShowS # show :: Manifest -> String # showList :: [Manifest] -> ShowS #
ToJSON Manifest Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods toJSON :: Manifest -> Value # toEncoding :: Manifest -> Encoding # toJSONList :: [Manifest] -> Value # toEncodingList :: [Manifest] -> Encoding #

data Input Source #

Manifest info for an entry point parameter.

Constructors

Input
Fields inputName :: Text inputType :: Text inputUnique :: Bool

Instances

Instances details

Eq Input Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods (==) :: Input -> Input -> Bool # (/=) :: Input -> Input -> Bool #
Ord Input Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods compare :: Input -> Input -> Ordering # (<) :: Input -> Input -> Bool # (<=) :: Input -> Input -> Bool # (>) :: Input -> Input -> Bool # (>=) :: Input -> Input -> Bool # max :: Input -> Input -> Input # min :: Input -> Input -> Input #
Show Input Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods showsPrec :: Int -> Input -> ShowS # show :: Input -> String # showList :: [Input] -> ShowS #

data Output Source #

Manifest info for an entry point return value.

Constructors

Output
Fields outputType :: Text outputUnique :: Bool

Instances

Instances details

Eq Output Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods (==) :: Output -> Output -> Bool # (/=) :: Output -> Output -> Bool #
Ord Output Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods compare :: Output -> Output -> Ordering # (<) :: Output -> Output -> Bool # (<=) :: Output -> Output -> Bool # (>) :: Output -> Output -> Bool # (>=) :: Output -> Output -> Bool # max :: Output -> Output -> Output # min :: Output -> Output -> Output #
Show Output Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods showsPrec :: Int -> Output -> ShowS # show :: Output -> String # showList :: [Output] -> ShowS #

data EntryPoint Source #

Manifest info for an entry point.

Constructors

EntryPoint
Fields entryPointCFun :: Text entryPointOutputs :: [Output] entryPointInputs :: [Input]

Instances

Instances details

Eq EntryPoint Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods (==) :: EntryPoint -> EntryPoint -> Bool # (/=) :: EntryPoint -> EntryPoint -> Bool #
Ord EntryPoint Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods compare :: EntryPoint -> EntryPoint -> Ordering # (<) :: EntryPoint -> EntryPoint -> Bool # (<=) :: EntryPoint -> EntryPoint -> Bool # (>) :: EntryPoint -> EntryPoint -> Bool # (>=) :: EntryPoint -> EntryPoint -> Bool # max :: EntryPoint -> EntryPoint -> EntryPoint # min :: EntryPoint -> EntryPoint -> EntryPoint #
Show EntryPoint Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods showsPrec :: Int -> EntryPoint -> ShowS # show :: EntryPoint -> String # showList :: [EntryPoint] -> ShowS #

data Type Source #

Manifest info for a non-scalar type. Scalar types are not part of the manifest for a program.

Constructors

TypeArray Text Text Int ArrayOps	ctype, Futhark elemtype, rank.
TypeOpaque Text OpaqueOps

Instances

Instances details

Eq Type Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods (==) :: Type -> Type -> Bool # (/=) :: Type -> Type -> Bool #
Ord Type Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods compare :: Type -> Type -> Ordering # (<) :: Type -> Type -> Bool # (<=) :: Type -> Type -> Bool # (>) :: Type -> Type -> Bool # (>=) :: Type -> Type -> Bool # max :: Type -> Type -> Type # min :: Type -> Type -> Type #
Show Type Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods showsPrec :: Int -> Type -> ShowS # show :: Type -> String # showList :: [Type] -> ShowS #

data ArrayOps Source #

The names of the C functions implementing the operations on some array type.

Constructors

ArrayOps
Fields arrayFree :: Text arrayShape :: Text arrayValues :: Text arrayNew :: Text

Instances

Instances details

Eq ArrayOps Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods (==) :: ArrayOps -> ArrayOps -> Bool # (/=) :: ArrayOps -> ArrayOps -> Bool #
Ord ArrayOps Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods compare :: ArrayOps -> ArrayOps -> Ordering # (<) :: ArrayOps -> ArrayOps -> Bool # (<=) :: ArrayOps -> ArrayOps -> Bool # (>) :: ArrayOps -> ArrayOps -> Bool # (>=) :: ArrayOps -> ArrayOps -> Bool # max :: ArrayOps -> ArrayOps -> ArrayOps # min :: ArrayOps -> ArrayOps -> ArrayOps #
Show ArrayOps Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods showsPrec :: Int -> ArrayOps -> ShowS # show :: ArrayOps -> String # showList :: [ArrayOps] -> ShowS #
ToJSON ArrayOps Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods toJSON :: ArrayOps -> Value # toEncoding :: ArrayOps -> Encoding # toJSONList :: [ArrayOps] -> Value # toEncodingList :: [ArrayOps] -> Encoding #

data OpaqueOps Source #

The names of the C functions implementing the operations on some opaque type.

Constructors

OpaqueOps
Fields opaqueFree :: Text opaqueStore :: Text opaqueRestore :: Text

Instances

Instances details

Eq OpaqueOps Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods (==) :: OpaqueOps -> OpaqueOps -> Bool # (/=) :: OpaqueOps -> OpaqueOps -> Bool #
Ord OpaqueOps Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods compare :: OpaqueOps -> OpaqueOps -> Ordering # (<) :: OpaqueOps -> OpaqueOps -> Bool # (<=) :: OpaqueOps -> OpaqueOps -> Bool # (>) :: OpaqueOps -> OpaqueOps -> Bool # (>=) :: OpaqueOps -> OpaqueOps -> Bool # max :: OpaqueOps -> OpaqueOps -> OpaqueOps # min :: OpaqueOps -> OpaqueOps -> OpaqueOps #
Show OpaqueOps Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods showsPrec :: Int -> OpaqueOps -> ShowS # show :: OpaqueOps -> String # showList :: [OpaqueOps] -> ShowS #
ToJSON OpaqueOps Source #
Instance details Defined in Futhark.CodeGen.Backends.GenericC.Manifest Methods toJSON :: OpaqueOps -> Value # toEncoding :: OpaqueOps -> Encoding # toJSONList :: [OpaqueOps] -> Value # toEncodingList :: [OpaqueOps] -> Encoding #

manifestToJSON :: Manifest -> Text Source #

Serialise a manifest in JSON format, so it can be read from other tools. The schema supposed to be at https://futhark-lang.org/manifest.schema.json.