Futhark.CodeGen.ImpGen

Entry Points

compileProg :: (Mem lore, FreeIn op, MonadFreshNames m) => r -> Operations lore r op -> Space -> Prog lore -> m (Warnings, Definitions op)

Pluggable Compiler

type OpCompiler lore r op = Pattern lore -> Op lore -> ImpM lore r op ()

How to compile an Op.

type ExpCompiler lore r op = Pattern lore -> Exp lore -> ImpM lore r op ()

How to compile an Exp.

type CopyCompiler lore r op = PrimType -> MemLocation -> Slice (TExp Int64) -> MemLocation -> Slice (TExp Int64) -> ImpM lore r op ()

type StmsCompiler lore r op = Names -> Stms lore -> ImpM lore r op () -> ImpM lore r op ()

How to compile some Stms.

type AllocCompiler lore r op = VName -> Count Bytes (TExp Int64) -> ImpM lore r op ()

An alternate way of compiling an allocation.

data Operations lore r op

Constructors

Operations

Fields

• opsExpCompiler :: ExpCompiler lore r op
• opsOpCompiler :: OpCompiler lore r op
• opsStmsCompiler :: StmsCompiler lore r op
• opsCopyCompiler :: CopyCompiler lore r op
• opsAllocCompilers :: Map Space (AllocCompiler lore r op)

defaultOperations :: (Mem lore, FreeIn op) => OpCompiler lore r op -> Operations lore r op

An operations set for which the expression compiler always returns defCompileExp.

data MemLocation

When an array is dared, this is where it is stored.

Constructors

MemLocation

Fields

• memLocationName :: VName
• memLocationShape :: [DimSize]
• memLocationIxFun :: IxFun (TExp Int64)

Instances

Eq MemLocation

Defined in Futhark.CodeGen.ImpGen

Methods

(==) :: MemLocation -> MemLocation -> Bool

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

Show MemLocation

Defined in Futhark.CodeGen.ImpGen

Methods

showsPrec :: Int -> MemLocation -> ShowS

show :: MemLocation -> String

showList :: [MemLocation] -> ShowS

newtype MemEntry

Constructors

MemEntry

Fields

• entryMemSpace :: Space

Instances

Show MemEntry

Defined in Futhark.CodeGen.ImpGen

Methods

showsPrec :: Int -> MemEntry -> ShowS

show :: MemEntry -> String

showList :: [MemEntry] -> ShowS

newtype ScalarEntry

Constructors

ScalarEntry

Fields

• entryScalarType :: PrimType

Instances

Show ScalarEntry

Defined in Futhark.CodeGen.ImpGen

Methods

showsPrec :: Int -> ScalarEntry -> ShowS

show :: ScalarEntry -> String

showList :: [ScalarEntry] -> ShowS

Monadic Compiler Interface

data ImpM lore r op a

Instances

HasScope SOACS (ImpM lore r op)

Defined in Futhark.CodeGen.ImpGen

Methods

lookupType :: VName -> ImpM lore r op Type

lookupInfo :: VName -> ImpM lore r op (NameInfo SOACS)

askScope :: ImpM lore r op (Scope SOACS)

asksScope :: (Scope SOACS -> a) -> ImpM lore r op a

Monad (ImpM lore r op)

Defined in Futhark.CodeGen.ImpGen

Methods

(>>=) :: ImpM lore r op a -> (a -> ImpM lore r op b) -> ImpM lore r op b

(>>) :: ImpM lore r op a -> ImpM lore r op b -> ImpM lore r op b

return :: a -> ImpM lore r op a

Functor (ImpM lore r op)

Defined in Futhark.CodeGen.ImpGen

Methods

fmap :: (a -> b) -> ImpM lore r op a -> ImpM lore r op b

(<$) :: a -> ImpM lore r op b -> ImpM lore r op a

Applicative (ImpM lore r op)

Defined in Futhark.CodeGen.ImpGen

Methods

pure :: a -> ImpM lore r op a

(<*>) :: ImpM lore r op (a -> b) -> ImpM lore r op a -> ImpM lore r op b

liftA2 :: (a -> b -> c) -> ImpM lore r op a -> ImpM lore r op b -> ImpM lore r op c

(*>) :: ImpM lore r op a -> ImpM lore r op b -> ImpM lore r op b

(<*) :: ImpM lore r op a -> ImpM lore r op b -> ImpM lore r op a

MonadFreshNames (ImpM lore r op)

Defined in Futhark.CodeGen.ImpGen

Methods

getNameSource :: ImpM lore r op VNameSource

putNameSource :: VNameSource -> ImpM lore r op ()

localDefaultSpace :: Space -> ImpM lore r op a -> ImpM lore r op a

askFunction :: ImpM lore r op (Maybe Name)

newVNameForFun :: String -> ImpM lore r op VName

Generate a VName, prefixed with askFunction if it exists.

nameForFun :: String -> ImpM lore r op Name

Generate a Name, prefixed with askFunction if it exists.

askEnv :: ImpM lore r op r

localEnv :: (r -> r) -> ImpM lore r op a -> ImpM lore r op a

localOps :: Operations lore r op -> ImpM lore r op a -> ImpM lore r op a

type VTable lore = Map VName (VarEntry lore)

The symbol table used during compilation.

getVTable :: ImpM lore r op (VTable lore)

Get the current symbol table.

localVTable :: (VTable lore -> VTable lore) -> ImpM lore r op a -> ImpM lore r op a

Run an action with a modified symbol table. All changes to the symbol table will be reverted once the action is done!

subImpM :: r' -> Operations lore r' op' -> ImpM lore r' op' a -> ImpM lore r op (a, Code op')

subImpM_ :: r' -> Operations lore r' op' -> ImpM lore r' op' a -> ImpM lore r op (Code op')

emit :: Code op -> ImpM lore r op ()

Emit some generated imperative code.

emitFunction :: Name -> Function op -> ImpM lore r op ()

Emit a function in the generated code.

hasFunction :: Name -> ImpM lore r op Bool

Check if a function of a given name exists.

collect :: ImpM lore r op () -> ImpM lore r op (Code op)

Execute a code generation action, returning the code that was emitted.

collect' :: ImpM lore r op a -> ImpM lore r op (a, Code op)

comment :: String -> ImpM lore r op () -> ImpM lore r op ()

Execute a code generation action, wrapping the generated code within a Comment with the given description.

data VarEntry lore

Every non-scalar variable must be associated with an entry.

Constructors

ArrayVar (Maybe (Exp lore)) ArrayEntry

ScalarVar (Maybe (Exp lore)) ScalarEntry

MemVar (Maybe (Exp lore)) MemEntry

Instances

Decorations lore => Show (VarEntry lore)

Defined in Futhark.CodeGen.ImpGen

Methods

showsPrec :: Int -> VarEntry lore -> ShowS

show :: VarEntry lore -> String

showList :: [VarEntry lore] -> ShowS

data ArrayEntry

Constructors

ArrayEntry

Fields

• entryArrayLocation :: MemLocation
• entryArrayElemType :: PrimType

Instances

Show ArrayEntry

Defined in Futhark.CodeGen.ImpGen

Methods

showsPrec :: Int -> ArrayEntry -> ShowS

show :: ArrayEntry -> String

showList :: [ArrayEntry] -> ShowS

Lookups

lookupVar :: VName -> ImpM lore r op (VarEntry lore)

lookupArray :: VName -> ImpM lore r op ArrayEntry

lookupMemory :: VName -> ImpM lore r op MemEntry

Building Blocks

data TV t

A typed variable, which we can turn into a typed expression, or use as the target for an assignment. This is used to aid in type safety when doing code generation, by keeping the types straight. It is still easy to cheat when you need to.

mkTV :: VName -> PrimType -> TV t

Create a typed variable from a name and a dynamic type. Note that there is no guarantee that the dynamic type corresponds to the inferred static type, but the latter will at least have to be used consistently.

tvSize :: TV t -> DimSize

Convert a typed variable to a size (a SubExp).

tvExp :: TV t -> TExp t

Convert a typed variable to a similarly typed expression.

tvVar :: TV t -> VName

Extract the underlying variable name from a typed variable.

class ToExp a where

Compile things to Exp.

Minimal complete definition

toExp, toExp'

Methods

toExp :: a -> ImpM lore r op Exp

Compile to an Exp, where the type (must must still be a primitive) is deduced monadically.

toExp' :: PrimType -> a -> Exp

Compile where we know the type in advance.

toInt64Exp :: a -> TExp Int64

toBoolExp :: a -> TExp Bool

Instances

ToExp SubExp

Defined in Futhark.CodeGen.ImpGen

Methods

toExp :: SubExp -> ImpM lore r op Exp

toExp' :: PrimType -> SubExp -> Exp

toInt64Exp :: SubExp -> TExp Int64

toBoolExp :: SubExp -> TExp Bool

ToExp (PrimExp VName)

Defined in Futhark.CodeGen.ImpGen

Methods

toExp :: PrimExp VName -> ImpM lore r op Exp

toExp' :: PrimType -> PrimExp VName -> Exp

toInt64Exp :: PrimExp VName -> TExp Int64

toBoolExp :: PrimExp VName -> TExp Bool

compileAlloc :: Mem lore => Pattern lore -> SubExp -> Space -> ImpM lore r op ()

compileAlloc pat size space allocates n bytes of memory in space, writing the result to dest, which must be a single MemoryDestination,

everythingVolatile :: ImpM lore r op a -> ImpM lore r op a

compileBody :: Mem lore => Pattern lore -> Body lore -> ImpM lore r op ()

compileBody' :: [Param dec] -> Body lore -> ImpM lore r op ()

compileLoopBody :: Typed dec => [Param dec] -> Body lore -> ImpM lore r op ()

defCompileStms :: (Mem lore, FreeIn op) => Names -> Stms lore -> ImpM lore r op () -> ImpM lore r op ()

compileStms :: Names -> Stms lore -> ImpM lore r op () -> ImpM lore r op ()

compileExp :: Pattern lore -> Exp lore -> ImpM lore r op ()

defCompileExp :: Mem lore => Pattern lore -> Exp lore -> ImpM lore r op ()

fullyIndexArray :: VName -> [TExp Int64] -> ImpM lore r op (VName, Space, Count Elements (TExp Int64))

fullyIndexArray' :: MemLocation -> [TExp Int64] -> ImpM lore r op (VName, Space, Count Elements (TExp Int64))

copy :: CopyCompiler lore r op

copyDWIM :: VName -> [DimIndex (TExp Int64)] -> SubExp -> [DimIndex (TExp Int64)] -> ImpM lore r op ()

Copy from here to there; both destination and source be indexeded. If so, they better be arrays of enough dimensions. This function will generally just Do What I Mean, and Do The Right Thing. Both destination and source must be in scope.

copyDWIMFix :: VName -> [TExp Int64] -> SubExp -> [TExp Int64] -> ImpM lore r op ()

As copyDWIM, but implicitly DimFixes the indexes.

copyElementWise :: CopyCompiler lore r op

typeSize :: Type -> Count Bytes (TExp Int64)

The number of bytes needed to represent the array in a straightforward contiguous format, as an Int64 expression.

isMapTransposeCopy :: PrimType -> MemLocation -> Slice (TExp Int64) -> MemLocation -> Slice (TExp Int64) -> Maybe (TExp Int64, TExp Int64, TExp Int64, TExp Int64, TExp Int64)

Is this copy really a mapping with transpose?

Constructing code.

dLParams :: Mem lore => [LParam lore] -> ImpM lore r op ()

dFParams :: Mem lore => [FParam lore] -> ImpM lore r op ()

dScope :: Mem lore => Maybe (Exp lore) -> Scope lore -> ImpM lore r op ()

dArray :: VName -> PrimType -> ShapeBase SubExp -> MemBind -> ImpM lore r op ()

dPrim :: String -> PrimType -> ImpM lore r op (TV t)

The return type is polymorphic, so there is no guarantee it actually matches the PrimType, but at least we have to use it consistently.

dPrimVol :: String -> PrimType -> TExp t -> ImpM lore r op (TV t)

dPrim_ :: VName -> PrimType -> ImpM lore r op ()

dPrimV_ :: VName -> TExp t -> ImpM lore r op ()

dPrimV :: String -> TExp t -> ImpM lore r op (TV t)

dPrimVE :: String -> TExp t -> ImpM lore r op (TExp t)

sFor :: String -> TExp t -> (TExp t -> ImpM lore r op ()) -> ImpM lore r op ()

sWhile :: TExp Bool -> ImpM lore r op () -> ImpM lore r op ()

sComment :: String -> ImpM lore r op () -> ImpM lore r op ()

sIf :: TExp Bool -> ImpM lore r op () -> ImpM lore r op () -> ImpM lore r op ()

sWhen :: TExp Bool -> ImpM lore r op () -> ImpM lore r op ()

sUnless :: TExp Bool -> ImpM lore r op () -> ImpM lore r op ()

sOp :: op -> ImpM lore r op ()

sDeclareMem :: String -> Space -> ImpM lore r op VName

sAlloc :: String -> Count Bytes (TExp Int64) -> Space -> ImpM lore r op VName

sAlloc_ :: VName -> Count Bytes (TExp Int64) -> Space -> ImpM lore r op ()

sArray :: String -> PrimType -> ShapeBase SubExp -> MemBind -> ImpM lore r op VName

sArrayInMem :: String -> PrimType -> ShapeBase SubExp -> VName -> ImpM lore r op VName

Declare an array in row-major order in the given memory block.

sAllocArray :: String -> PrimType -> ShapeBase SubExp -> Space -> ImpM lore r op VName

Uses linear/iota index function.

sAllocArrayPerm :: String -> PrimType -> ShapeBase SubExp -> Space -> [Int] -> ImpM lore r op VName

Like sAllocArray, but permute the in-memory representation of the indices as specified.

sStaticArray :: String -> Space -> PrimType -> ArrayContents -> ImpM lore r op VName

Uses linear/iota index function.

sWrite :: VName -> [TExp Int64] -> Exp -> ImpM lore r op ()

sUpdate :: VName -> Slice (TExp Int64) -> SubExp -> ImpM lore r op ()

sLoopNest :: Shape -> ([TExp Int64] -> ImpM lore r op ()) -> ImpM lore r op ()

(<--) :: TV t -> TExp t -> ImpM lore r op () infixl 3

Typed assignment.

(<~~) :: VName -> Exp -> ImpM lore r op () infixl 3

Untyped assignment.

function :: Name -> [Param] -> [Param] -> ImpM lore r op () -> ImpM lore r op ()

Constructing an ad-hoc function that does not correspond to any of the IR functions in the input program.

warn :: Located loc => loc -> [loc] -> String -> ImpM lore r op ()

Emit a warning about something the user should be aware of.

module Language.Futhark.Warnings