Futhark.Manifest

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. This module documentation is not intended as a full description of the Futhark C API - you will need to consult the Futhark User's Guide to understand most of the information here.

The type aliases are purely informative and do not actually enforce correct usage. They are present only because most of the information here is ultimately just text.

Type aliases

type CFuncName = Text

The name of a C function.

type CTypeName = Text

The name of a C type (often of the form "struct foo*").

type TypeName = Text

The name of a Futhark-level type. This may be an array type (without sizes, just empty brackets), a primitive type, or another string denoting an opaque type. The latter must have a corresponding entry in manifestTypes.

Manifest

data Manifest

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 TypeName 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.

• manifestVersion :: Text

  The version of the compiler used to compile the program.

Instances

Eq Manifest

Defined in Futhark.Manifest

Methods

(==) :: Manifest -> Manifest -> Bool

(/=) :: Manifest -> Manifest -> Bool

Ord Manifest

Defined in Futhark.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

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> Manifest -> ShowS

show :: Manifest -> String

showList :: [Manifest] -> ShowS

ToJSON Manifest

Defined in Futhark.Manifest

Methods

toJSON :: Manifest -> Value

toEncoding :: Manifest -> Encoding

toJSONList :: [Manifest] -> Value

toEncodingList :: [Manifest] -> Encoding

FromJSON Manifest

Defined in Futhark.Manifest

Methods

parseJSON :: Value -> Parser Manifest

parseJSONList :: Value -> Parser [Manifest]

data Input

Manifest info for an entry point parameter.

Constructors

Input

Fields

• inputName :: Text
• inputType :: TypeName
• inputUnique :: Bool

Instances

Eq Input

Defined in Futhark.Manifest

Methods

(==) :: Input -> Input -> Bool

(/=) :: Input -> Input -> Bool

Ord Input

Defined in Futhark.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

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> Input -> ShowS

show :: Input -> String

showList :: [Input] -> ShowS

FromJSON Input

Defined in Futhark.Manifest

Methods

parseJSON :: Value -> Parser Input

parseJSONList :: Value -> Parser [Input]

data Output

Manifest info for an entry point return value.

Constructors

Output

Fields

• outputType :: TypeName
• outputUnique :: Bool

Instances

Eq Output

Defined in Futhark.Manifest

Methods

(==) :: Output -> Output -> Bool

(/=) :: Output -> Output -> Bool

Ord Output

Defined in Futhark.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

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> Output -> ShowS

show :: Output -> String

showList :: [Output] -> ShowS

FromJSON Output

Defined in Futhark.Manifest

Methods

parseJSON :: Value -> Parser Output

parseJSONList :: Value -> Parser [Output]

data EntryPoint

Manifest info for an entry point.

Constructors

EntryPoint

Fields

• entryPointCFun :: CFuncName
• entryPointOutputs :: [Output]
• entryPointInputs :: [Input]

Instances

Eq EntryPoint

Defined in Futhark.Manifest

Methods

(==) :: EntryPoint -> EntryPoint -> Bool

(/=) :: EntryPoint -> EntryPoint -> Bool

Ord EntryPoint

Defined in Futhark.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

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> EntryPoint -> ShowS

show :: EntryPoint -> String

showList :: [EntryPoint] -> ShowS

FromJSON EntryPoint

Defined in Futhark.Manifest

Methods

parseJSON :: Value -> Parser EntryPoint

parseJSONList :: Value -> Parser [EntryPoint]

data Type

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

Constructors

TypeArray CTypeName TypeName Int ArrayOps

ctype, Futhark elemtype, rank.

TypeOpaque CTypeName OpaqueOps (Maybe RecordOps)

Instances

Eq Type

Defined in Futhark.Manifest

Methods

(==) :: Type -> Type -> Bool

(/=) :: Type -> Type -> Bool

Ord Type

Defined in Futhark.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

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> Type -> ShowS

show :: Type -> String

showList :: [Type] -> ShowS

FromJSON Type

Defined in Futhark.Manifest

Methods

parseJSON :: Value -> Parser Type

parseJSONList :: Value -> Parser [Type]

data ArrayOps

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

Constructors

ArrayOps

Fields

• arrayFree :: CFuncName
• arrayShape :: CFuncName
• arrayValues :: CFuncName
• arrayNew :: CFuncName

Instances

Eq ArrayOps

Defined in Futhark.Manifest

Methods

(==) :: ArrayOps -> ArrayOps -> Bool

(/=) :: ArrayOps -> ArrayOps -> Bool

Ord ArrayOps

Defined in Futhark.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

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> ArrayOps -> ShowS

show :: ArrayOps -> String

showList :: [ArrayOps] -> ShowS

ToJSON ArrayOps

Defined in Futhark.Manifest

Methods

toJSON :: ArrayOps -> Value

toEncoding :: ArrayOps -> Encoding

toJSONList :: [ArrayOps] -> Value

toEncodingList :: [ArrayOps] -> Encoding

FromJSON ArrayOps

Defined in Futhark.Manifest

Methods

parseJSON :: Value -> Parser ArrayOps

parseJSONList :: Value -> Parser [ArrayOps]

data RecordField

Information about a record field.

Constructors

RecordField

Fields

• recordFieldName :: Text

  The original name of the field. This may be a name that is not a valid C identifier.

• recordFieldType :: TypeName

  The type of the field.

• recordFieldProject :: CFuncName

  The name of the projection function.

Instances

Eq RecordField

Defined in Futhark.Manifest

Methods

(==) :: RecordField -> RecordField -> Bool

(/=) :: RecordField -> RecordField -> Bool

Ord RecordField

Defined in Futhark.Manifest

Methods

compare :: RecordField -> RecordField -> Ordering

(<) :: RecordField -> RecordField -> Bool

(<=) :: RecordField -> RecordField -> Bool

(>) :: RecordField -> RecordField -> Bool

(>=) :: RecordField -> RecordField -> Bool

max :: RecordField -> RecordField -> RecordField

min :: RecordField -> RecordField -> RecordField

Show RecordField

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> RecordField -> ShowS

show :: RecordField -> String

showList :: [RecordField] -> ShowS

ToJSON RecordField

Defined in Futhark.Manifest

Methods

toJSON :: RecordField -> Value

toEncoding :: RecordField -> Encoding

toJSONList :: [RecordField] -> Value

toEncodingList :: [RecordField] -> Encoding

FromJSON RecordField

Defined in Futhark.Manifest

Methods

parseJSON :: Value -> Parser RecordField

parseJSONList :: Value -> Parser [RecordField]

data RecordOps

Some opaque types are records, from which we can extract fields, and also construct them from values for their fields. Beyond that, they support the usual opaque operations. These record facilities can be ignored if you wish, and the types treated as ordinary opaque types.

Constructors

RecordOps

Fields

• recordFields :: [RecordField]

  Note that the ordering of fields here is semantically significant - it is also the order that the "new" function expects.

• recordNew :: CFuncName

Instances

Eq RecordOps

Defined in Futhark.Manifest

Methods

(==) :: RecordOps -> RecordOps -> Bool

(/=) :: RecordOps -> RecordOps -> Bool

Ord RecordOps

Defined in Futhark.Manifest

Methods

compare :: RecordOps -> RecordOps -> Ordering

(<) :: RecordOps -> RecordOps -> Bool

(<=) :: RecordOps -> RecordOps -> Bool

(>) :: RecordOps -> RecordOps -> Bool

(>=) :: RecordOps -> RecordOps -> Bool

max :: RecordOps -> RecordOps -> RecordOps

min :: RecordOps -> RecordOps -> RecordOps

Show RecordOps

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> RecordOps -> ShowS

show :: RecordOps -> String

showList :: [RecordOps] -> ShowS

ToJSON RecordOps

Defined in Futhark.Manifest

Methods

toJSON :: RecordOps -> Value

toEncoding :: RecordOps -> Encoding

toJSONList :: [RecordOps] -> Value

toEncodingList :: [RecordOps] -> Encoding

FromJSON RecordOps

Defined in Futhark.Manifest

Methods

parseJSON :: Value -> Parser RecordOps

parseJSONList :: Value -> Parser [RecordOps]

data OpaqueOps

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

Constructors

OpaqueOps

Fields

• opaqueFree :: CFuncName
• opaqueStore :: CFuncName
• opaqueRestore :: CFuncName

Instances

Eq OpaqueOps

Defined in Futhark.Manifest

Methods

(==) :: OpaqueOps -> OpaqueOps -> Bool

(/=) :: OpaqueOps -> OpaqueOps -> Bool

Ord OpaqueOps

Defined in Futhark.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

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> OpaqueOps -> ShowS

show :: OpaqueOps -> String

showList :: [OpaqueOps] -> ShowS

ToJSON OpaqueOps

Defined in Futhark.Manifest

Methods

toJSON :: OpaqueOps -> Value

toEncoding :: OpaqueOps -> Encoding

toJSONList :: [OpaqueOps] -> Value

toEncodingList :: [OpaqueOps] -> Encoding

FromJSON OpaqueOps

Defined in Futhark.Manifest

Methods

parseJSON :: Value -> Parser OpaqueOps

parseJSONList :: Value -> Parser [OpaqueOps]

manifestToJSON :: Manifest -> Text

Serialise a manifest to JSON.

manifestFromJSON :: Text -> Maybe Manifest

Read a manifest from JSON. Returns Nothing if the text does not describe a Manifest.