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

FromJSON Manifest

Defined in Futhark.Manifest

Methods

parseJSON :: Value -> Parser Manifest

parseJSONList :: Value -> Parser [Manifest]

omittedField :: Maybe Manifest

ToJSON Manifest

Defined in Futhark.Manifest

Methods

toJSON :: Manifest -> Value

toEncoding :: Manifest -> Encoding

toJSONList :: [Manifest] -> Value

toEncodingList :: [Manifest] -> Encoding

omitField :: Manifest -> Bool

Show Manifest

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> Manifest -> ShowS

show :: Manifest -> String

showList :: [Manifest] -> ShowS

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

data Input

Manifest info for an entry point parameter.

Constructors

Input

Fields

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

Instances

FromJSON Input

Defined in Futhark.Manifest

Methods

parseJSON :: Value -> Parser Input

parseJSONList :: Value -> Parser [Input]

omittedField :: Maybe Input

Show Input

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> Input -> ShowS

show :: Input -> String

showList :: [Input] -> ShowS

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

data Output

Manifest info for an entry point return value.

Constructors

Output

Fields

• outputType :: TypeName
• outputUnique :: Bool

Instances

FromJSON Output

Defined in Futhark.Manifest

Methods

parseJSON :: Value -> Parser Output

parseJSONList :: Value -> Parser [Output]

omittedField :: Maybe Output

Show Output

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> Output -> ShowS

show :: Output -> String

showList :: [Output] -> ShowS

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

data EntryPoint

Manifest info for an entry point.

Constructors

EntryPoint

Fields

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

Instances

FromJSON EntryPoint

Defined in Futhark.Manifest

Methods

parseJSON :: Value -> Parser EntryPoint

parseJSONList :: Value -> Parser [EntryPoint]

omittedField :: Maybe EntryPoint

Show EntryPoint

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> EntryPoint -> ShowS

show :: EntryPoint -> String

showList :: [EntryPoint] -> ShowS

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

data Type

Manifest info for a non-scalar type. Scalar types are not part of the manifest for a program. Although this representation allows a type to be both a a record and a sum type, this will never actually happen.

Constructors

TypeArray CTypeName TypeName Int ArrayOps

ctype, Futhark elemtype, rank.

TypeOpaque CTypeName OpaqueOps (Maybe OpaqueExtraOps)

Instances

FromJSON Type

Defined in Futhark.Manifest

Methods

parseJSON :: Value -> Parser Type

parseJSONList :: Value -> Parser [Type]

omittedField :: Maybe Type

Show Type

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> Type -> ShowS

show :: Type -> String

showList :: [Type] -> ShowS

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

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
• arrayNewRaw :: CFuncName
• arrayValuesRaw :: CFuncName
• arrayIndex :: CFuncName

Instances

FromJSON ArrayOps

Defined in Futhark.Manifest

Methods

parseJSON :: Value -> Parser ArrayOps

parseJSONList :: Value -> Parser [ArrayOps]

omittedField :: Maybe ArrayOps

ToJSON ArrayOps

Defined in Futhark.Manifest

Methods

toJSON :: ArrayOps -> Value

toEncoding :: ArrayOps -> Encoding

toJSONList :: [ArrayOps] -> Value

toEncodingList :: [ArrayOps] -> Encoding

omitField :: ArrayOps -> Bool

Show ArrayOps

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> ArrayOps -> ShowS

show :: ArrayOps -> String

showList :: [ArrayOps] -> ShowS

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

data RecordField

Information about a record field. Also used for fields of record arrays; see RecordArrayOps.

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

FromJSON RecordField

Defined in Futhark.Manifest

Methods

parseJSON :: Value -> Parser RecordField

parseJSONList :: Value -> Parser [RecordField]

omittedField :: Maybe RecordField

ToJSON RecordField

Defined in Futhark.Manifest

Methods

toJSON :: RecordField -> Value

toEncoding :: RecordField -> Encoding

toJSONList :: [RecordField] -> Value

toEncodingList :: [RecordField] -> Encoding

omitField :: RecordField -> Bool

Show RecordField

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> RecordField -> ShowS

show :: RecordField -> String

showList :: [RecordField] -> ShowS

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

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

FromJSON RecordOps

Defined in Futhark.Manifest

Methods

parseJSON :: Value -> Parser RecordOps

parseJSONList :: Value -> Parser [RecordOps]

omittedField :: Maybe RecordOps

ToJSON RecordOps

Defined in Futhark.Manifest

Methods

toJSON :: RecordOps -> Value

toEncoding :: RecordOps -> Encoding

toJSONList :: [RecordOps] -> Value

toEncodingList :: [RecordOps] -> Encoding

omitField :: RecordOps -> Bool

Show RecordOps

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> RecordOps -> ShowS

show :: RecordOps -> String

showList :: [RecordOps] -> ShowS

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

data SumVariant

Information about a variant of a sum type.

Constructors

SumVariant

Fields

• sumVariantName :: Text

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

• sumVariantPayload :: [TypeName]

  The payload of this variant; also corresponding to the arguments of the constructor and destructor functions.

• sumVariantConstruct :: CFuncName
• sumVariantDestruct :: CFuncName

  Note that despite the name, "destruction" does not entail freeing the sum type value.

Instances

FromJSON SumVariant

Defined in Futhark.Manifest

Methods

parseJSON :: Value -> Parser SumVariant

parseJSONList :: Value -> Parser [SumVariant]

omittedField :: Maybe SumVariant

ToJSON SumVariant

Defined in Futhark.Manifest

Methods

toJSON :: SumVariant -> Value

toEncoding :: SumVariant -> Encoding

toJSONList :: [SumVariant] -> Value

toEncodingList :: [SumVariant] -> Encoding

omitField :: SumVariant -> Bool

Show SumVariant

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> SumVariant -> ShowS

show :: SumVariant -> String

showList :: [SumVariant] -> ShowS

Eq SumVariant

Defined in Futhark.Manifest

Methods

(==) :: SumVariant -> SumVariant -> Bool

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

Ord SumVariant

Defined in Futhark.Manifest

Methods

compare :: SumVariant -> SumVariant -> Ordering

(<) :: SumVariant -> SumVariant -> Bool

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

(>) :: SumVariant -> SumVariant -> Bool

(>=) :: SumVariant -> SumVariant -> Bool

max :: SumVariant -> SumVariant -> SumVariant

min :: SumVariant -> SumVariant -> SumVariant

data SumOps

Some opaque types are sum types, from which we can (try to) extract the payload of a constructor, as well as construct them from payloads. As with records, we can ignore these facilities and simply treat them as completely opaque.

Constructors

SumOps

Fields

• sumVariants :: [SumVariant]
• sumVariant :: CFuncName

  This function returns an integer that identifies which variant a value is an instance of. This integer is a valid index in sumVariants.

Instances

FromJSON SumOps

Defined in Futhark.Manifest

Methods

parseJSON :: Value -> Parser SumOps

parseJSONList :: Value -> Parser [SumOps]

omittedField :: Maybe SumOps

ToJSON SumOps

Defined in Futhark.Manifest

Methods

toJSON :: SumOps -> Value

toEncoding :: SumOps -> Encoding

toJSONList :: [SumOps] -> Value

toEncodingList :: [SumOps] -> Encoding

omitField :: SumOps -> Bool

Show SumOps

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> SumOps -> ShowS

show :: SumOps -> String

showList :: [SumOps] -> ShowS

Eq SumOps

Defined in Futhark.Manifest

Methods

(==) :: SumOps -> SumOps -> Bool

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

Ord SumOps

Defined in Futhark.Manifest

Methods

compare :: SumOps -> SumOps -> Ordering

(<) :: SumOps -> SumOps -> Bool

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

(>) :: SumOps -> SumOps -> Bool

(>=) :: SumOps -> SumOps -> Bool

max :: SumOps -> SumOps -> SumOps

min :: SumOps -> SumOps -> SumOps

data OpaqueArrayOps

Some opaque types are arrays of opaque types. These still support some array-like operations, but their types are somewhat different. Note that arrays of primitives are TypeArrays, and arrays of records support RecordArrayOps.

Constructors

OpaqueArrayOps

Fields

• opaqueArrayRank :: Int
• opaqueArrayElemType :: TypeName
• opaqueArrayIndex :: CFuncName
• opaqueArrayShape :: CFuncName

Instances

FromJSON OpaqueArrayOps

Defined in Futhark.Manifest

Methods

parseJSON :: Value -> Parser OpaqueArrayOps

parseJSONList :: Value -> Parser [OpaqueArrayOps]

omittedField :: Maybe OpaqueArrayOps

ToJSON OpaqueArrayOps

Defined in Futhark.Manifest

Methods

toJSON :: OpaqueArrayOps -> Value

toEncoding :: OpaqueArrayOps -> Encoding

toJSONList :: [OpaqueArrayOps] -> Value

toEncodingList :: [OpaqueArrayOps] -> Encoding

omitField :: OpaqueArrayOps -> Bool

Show OpaqueArrayOps

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> OpaqueArrayOps -> ShowS

show :: OpaqueArrayOps -> String

showList :: [OpaqueArrayOps] -> ShowS

Eq OpaqueArrayOps

Defined in Futhark.Manifest

Methods

(==) :: OpaqueArrayOps -> OpaqueArrayOps -> Bool

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

Ord OpaqueArrayOps

Defined in Futhark.Manifest

Methods

compare :: OpaqueArrayOps -> OpaqueArrayOps -> Ordering

(<) :: OpaqueArrayOps -> OpaqueArrayOps -> Bool

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

(>) :: OpaqueArrayOps -> OpaqueArrayOps -> Bool

(>=) :: OpaqueArrayOps -> OpaqueArrayOps -> Bool

max :: OpaqueArrayOps -> OpaqueArrayOps -> OpaqueArrayOps

min :: OpaqueArrayOps -> OpaqueArrayOps -> OpaqueArrayOps

data RecordArrayOps

Some opaque types are arrays of records. The RecordFields here will contain array types, and the projection functions will retrieve arrays.

Constructors

RecordArrayOps

Fields

• recordArrayRank :: Int
• recordArrayElemType :: TypeName
• recordArrayFields :: [RecordField]
• recordArrayZip :: CFuncName
• recordArrayIndex :: CFuncName
• recordArrayShape :: CFuncName

Instances

FromJSON RecordArrayOps

Defined in Futhark.Manifest

Methods

parseJSON :: Value -> Parser RecordArrayOps

parseJSONList :: Value -> Parser [RecordArrayOps]

omittedField :: Maybe RecordArrayOps

ToJSON RecordArrayOps

Defined in Futhark.Manifest

Methods

toJSON :: RecordArrayOps -> Value

toEncoding :: RecordArrayOps -> Encoding

toJSONList :: [RecordArrayOps] -> Value

toEncodingList :: [RecordArrayOps] -> Encoding

omitField :: RecordArrayOps -> Bool

Show RecordArrayOps

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> RecordArrayOps -> ShowS

show :: RecordArrayOps -> String

showList :: [RecordArrayOps] -> ShowS

Eq RecordArrayOps

Defined in Futhark.Manifest

Methods

(==) :: RecordArrayOps -> RecordArrayOps -> Bool

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

Ord RecordArrayOps

Defined in Futhark.Manifest

Methods

compare :: RecordArrayOps -> RecordArrayOps -> Ordering

(<) :: RecordArrayOps -> RecordArrayOps -> Bool

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

(>) :: RecordArrayOps -> RecordArrayOps -> Bool

(>=) :: RecordArrayOps -> RecordArrayOps -> Bool

max :: RecordArrayOps -> RecordArrayOps -> RecordArrayOps

min :: RecordArrayOps -> RecordArrayOps -> RecordArrayOps

data OpaqueExtraOps

Some opaque types have a known structure, which allows additional operations.

Constructors

OpaqueRecord RecordOps

OpaqueSum SumOps

OpaqueArray OpaqueArrayOps

OpaqueRecordArray RecordArrayOps

Instances

Show OpaqueExtraOps

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> OpaqueExtraOps -> ShowS

show :: OpaqueExtraOps -> String

showList :: [OpaqueExtraOps] -> ShowS

Eq OpaqueExtraOps

Defined in Futhark.Manifest

Methods

(==) :: OpaqueExtraOps -> OpaqueExtraOps -> Bool

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

Ord OpaqueExtraOps

Defined in Futhark.Manifest

Methods

compare :: OpaqueExtraOps -> OpaqueExtraOps -> Ordering

(<) :: OpaqueExtraOps -> OpaqueExtraOps -> Bool

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

(>) :: OpaqueExtraOps -> OpaqueExtraOps -> Bool

(>=) :: OpaqueExtraOps -> OpaqueExtraOps -> Bool

max :: OpaqueExtraOps -> OpaqueExtraOps -> OpaqueExtraOps

min :: OpaqueExtraOps -> OpaqueExtraOps -> OpaqueExtraOps

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

FromJSON OpaqueOps

Defined in Futhark.Manifest

Methods

parseJSON :: Value -> Parser OpaqueOps

parseJSONList :: Value -> Parser [OpaqueOps]

omittedField :: Maybe OpaqueOps

ToJSON OpaqueOps

Defined in Futhark.Manifest

Methods

toJSON :: OpaqueOps -> Value

toEncoding :: OpaqueOps -> Encoding

toJSONList :: [OpaqueOps] -> Value

toEncodingList :: [OpaqueOps] -> Encoding

omitField :: OpaqueOps -> Bool

Show OpaqueOps

Defined in Futhark.Manifest

Methods

showsPrec :: Int -> OpaqueOps -> ShowS

show :: OpaqueOps -> String

showList :: [OpaqueOps] -> ShowS

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

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.