Futhark.CodeGen.ImpGen

Entry Points

compileProg :: (ExplicitMemorish lore, MonadFreshNames m) => Operations lore op -> Space -> [Space] -> Prog lore -> m (Either InternalError (Functions op))

Pluggable Compiler

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

How to compile an ExpT.

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

How to compile an Exp.

type CopyCompiler lore op

Arguments

 = PrimType

-> MemLocation

-> MemLocation

-> Count Elements

Number of row elements of the source.

-> ImpM lore op ()

type StmsCompiler lore op = Names -> [Stm lore] -> ImpM lore op () -> ImpM lore op ()

How to compile some Stms.

data Operations lore op

Constructors

Operations

Fields

• opsExpCompiler :: ExpCompiler lore op
• opsOpCompiler :: OpCompiler lore op
• opsStmsCompiler :: StmsCompiler lore op
• opsCopyCompiler :: CopyCompiler lore op

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

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

data ValueDestination

Instances

Show ValueDestination

Defined in Futhark.CodeGen.ImpGen

Methods

showsPrec :: Int -> ValueDestination -> ShowS

show :: ValueDestination -> String

showList :: [ValueDestination] -> ShowS

arrayDestination :: MemLocation -> ValueDestination

data MemLocation

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

Constructors

MemLocation

Fields

• memLocationName :: VName
• memLocationShape :: [DimSize]
• memLocationIxFun :: IxFun Exp

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

data MemEntry

Constructors

MemEntry

Fields

• entryMemSize :: MemSize
• 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 op a

Instances

MonadError InternalError (ImpM lore op)

Defined in Futhark.CodeGen.ImpGen

Methods

throwError :: InternalError -> ImpM lore op a

catchError :: ImpM lore op a -> (InternalError -> ImpM lore op a) -> ImpM lore op a

HasScope SOACS (ImpM lore op)

Defined in Futhark.CodeGen.ImpGen

Methods

lookupType :: VName -> ImpM lore op Type

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

askScope :: ImpM lore op (Scope SOACS)

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

MonadWriter (Code op) (ImpM lore op)

Defined in Futhark.CodeGen.ImpGen

Methods

writer :: (a, Code op) -> ImpM lore op a

tell :: Code op -> ImpM lore op ()

listen :: ImpM lore op a -> ImpM lore op (a, Code op)

pass :: ImpM lore op (a, Code op -> Code op) -> ImpM lore op a

Monad (ImpM lore op)

Defined in Futhark.CodeGen.ImpGen

Methods

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

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

return :: a -> ImpM lore op a

fail :: String -> ImpM lore op a

Functor (ImpM lore op)

Defined in Futhark.CodeGen.ImpGen

Methods

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

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

MonadFail (ImpM lore op)

Defined in Futhark.CodeGen.ImpGen

Methods

fail :: String -> ImpM lore op a

Applicative (ImpM lore op)

Defined in Futhark.CodeGen.ImpGen

Methods

pure :: a -> ImpM lore op a

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

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

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

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

MonadFreshNames (ImpM lore op)

Defined in Futhark.CodeGen.ImpGen

Methods

getNameSource :: ImpM lore op VNameSource

putNameSource :: VNameSource -> ImpM lore op ()

MonadReader (Env lore op) (ImpM lore op)

Defined in Futhark.CodeGen.ImpGen

Methods

ask :: ImpM lore op (Env lore op)

local :: (Env lore op -> Env lore op) -> ImpM lore op a -> ImpM lore op a

reader :: (Env lore op -> a) -> ImpM lore op a

data Env lore op

Instances

MonadReader (Env lore op) (ImpM lore op)

Defined in Futhark.CodeGen.ImpGen

Methods

ask :: ImpM lore op (Env lore op)

local :: (Env lore op -> Env lore op) -> ImpM lore op a -> ImpM lore op a

reader :: (Env lore op -> a) -> ImpM lore op a

type VTable lore = Map VName (VarEntry lore)

The symbol table used during compilation.

getVTable :: ImpM lore op (VTable lore)

Get the current symbol table.

localVTable :: (VTable lore -> VTable lore) -> ImpM lore op a -> ImpM lore 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 :: Operations lore' op' -> ImpM lore' op' a -> ImpM lore op (a, Code op')

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

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

Emit some generated imperative code.

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

Emit a function in the generated code.

hasFunction :: Name -> ImpM lore op Bool

Check if a function of a given name exists.

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

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

comment :: String -> ImpM lore op () -> ImpM lore 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

Annotations 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 op (VarEntry lore)

lookupArray :: VName -> ImpM lore op ArrayEntry

lookupMemory :: VName -> ImpM lore op MemEntry

Building Blocks

compileSubExp :: SubExp -> ImpM lore op Exp

compileSubExpOfType :: PrimType -> SubExp -> Exp

compileSubExpTo :: VName -> SubExp -> ImpM lore op ()

compilePrimExp :: PrimExp VName -> Exp

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

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

subExpToDimSize :: SubExp -> ImpM lore op DimSize

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

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

compileBody' :: (ExplicitMemorish lore, attr ~ LetAttr lore) => [Param attr] -> Body lore -> ImpM lore op ()

compileLoopBody :: [VName] -> Body lore -> ImpM lore op ()

defCompileStms :: (ExplicitMemorish lore, FreeIn op) => Names -> [Stm lore] -> ImpM lore op () -> ImpM lore op ()

compileStms :: Names -> [Stm lore] -> ImpM lore op () -> ImpM lore op ()

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

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

offsetArray :: MemLocation -> Exp -> MemLocation

strideArray :: MemLocation -> Exp -> MemLocation

fullyIndexArray :: VName -> [Exp] -> ImpM lore op (VName, Space, Count Bytes)

fullyIndexArray' :: MemLocation -> [Exp] -> PrimType -> ImpM lore op (VName, Space, Count Bytes)

varIndex :: VName -> Exp

dimSizeToExp :: DimSize -> Count Elements

dimSizeToSubExp :: Size -> SubExp

copy :: CopyCompiler lore op

copyDWIM :: VName -> [Exp] -> SubExp -> [Exp] -> ImpM lore 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.

copyDWIMDest :: ValueDestination -> [Exp] -> SubExp -> [Exp] -> ImpM lore op ()

Like copyDWIM, but the target is a ValueDestination instead of a variable name.

copyElementWise :: CopyCompiler lore op

Constructing code.

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

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

dScope :: Maybe (Exp lore) -> Scope ExplicitMemory -> ImpM lore op ()

dScopes :: [(Maybe (Exp lore), Scope ExplicitMemory)] -> ImpM lore op ()

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

dPrim :: String -> PrimType -> ImpM lore op VName

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

dPrimV :: String -> Exp -> ImpM lore op VName

sFor :: VName -> IntType -> Exp -> ImpM lore op () -> ImpM lore op ()

sWhile :: Exp -> ImpM lore op () -> ImpM lore op ()

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

sIf :: Exp -> ImpM lore op () -> ImpM lore op () -> ImpM lore op ()

sWhen :: Exp -> ImpM lore op () -> ImpM lore op ()

sUnless :: Exp -> ImpM lore op () -> ImpM lore op ()

sOp :: op -> ImpM lore op ()

sDeclareMem :: String -> Count Bytes -> Space -> ImpM lore op (VName, MemSize)

sAlloc :: String -> Count Bytes -> Space -> ImpM lore op VName

sAlloc_ :: VName -> MemSize -> Space -> ImpM lore op ()

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

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

Uses linear/iota index function.

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

Uses linear/iota index function.

sWrite :: VName -> [Exp] -> PrimExp ExpLeaf -> ImpM lore op ()

sUpdate :: VName -> Slice Exp -> SubExp -> ImpM lore op ()

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

ASsignment.