Futhark.Pipeline

Definition of the core compiler driver building blocks. The spine of the compiler is the FutharkM monad, although note that individual passes are pure functions, and do not use the FutharkM monad (see Futhark.Pass).

Running the compiler involves producing an initial IR program (see Futhark.Compiler.Program), running a Pipeline to produce a final program (still in IR), then running an Action, which is usually a code generator.

Documentation

data Pipeline fromlore tolore

A compiler pipeline is conceptually a function from programs to programs, where the actual representation may change. Pipelines can be composed using their Category instance.

Instances

Category Pipeline

Defined in Futhark.Pipeline

Methods

id :: forall (a :: k). Pipeline a a

(.) :: forall (b :: k) (c :: k) (a :: k). Pipeline b c -> Pipeline a b -> Pipeline a c

data PipelineConfig

Configuration object for running a compiler pipeline.

Constructors

PipelineConfig

Fields

• pipelineVerbose :: Bool
• pipelineValidate :: Bool

data Action lore

A compilation always ends with some kind of action.

Constructors

Action

Fields

• actionName :: String
• actionDescription :: String
• actionProcedure :: Prog lore -> FutharkM ()

data FutharkM a

The main Futhark compiler driver monad - basically some state tracking on top if IO.

Instances

Monad FutharkM

Defined in Futhark.Pipeline

Methods

(>>=) :: FutharkM a -> (a -> FutharkM b) -> FutharkM b

(>>) :: FutharkM a -> FutharkM b -> FutharkM b

return :: a -> FutharkM a

Functor FutharkM

Defined in Futhark.Pipeline

Methods

fmap :: (a -> b) -> FutharkM a -> FutharkM b

(<$) :: a -> FutharkM b -> FutharkM a

Applicative FutharkM

Defined in Futhark.Pipeline

Methods

pure :: a -> FutharkM a

(<*>) :: FutharkM (a -> b) -> FutharkM a -> FutharkM b

liftA2 :: (a -> b -> c) -> FutharkM a -> FutharkM b -> FutharkM c

(*>) :: FutharkM a -> FutharkM b -> FutharkM b

(<*) :: FutharkM a -> FutharkM b -> FutharkM a

MonadIO FutharkM

Defined in Futhark.Pipeline

Methods

liftIO :: IO a -> FutharkM a

MonadLogger FutharkM

Defined in Futhark.Pipeline

Methods

logMsg :: ToLog a => a -> FutharkM ()

addLog :: Log -> FutharkM ()

MonadFreshNames FutharkM

Defined in Futhark.Pipeline

Methods

getNameSource :: FutharkM VNameSource

putNameSource :: VNameSource -> FutharkM ()

MonadError CompilerError FutharkM

Defined in Futhark.Pipeline

Methods

throwError :: CompilerError -> FutharkM a

catchError :: FutharkM a -> (CompilerError -> FutharkM a) -> FutharkM a

runFutharkM :: FutharkM a -> Verbosity -> IO (Either CompilerError a)

Run a FutharkM action.

data Verbosity

How much information to print to stderr while the compiler is running.

Constructors

NotVerbose

Silence is golden.

Verbose

Print messages about which pass is running.

VeryVerbose

Also print logs from individual passes.

Instances

Eq Verbosity

Defined in Futhark.Pipeline

Methods

(==) :: Verbosity -> Verbosity -> Bool

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

Ord Verbosity

Defined in Futhark.Pipeline

Methods

compare :: Verbosity -> Verbosity -> Ordering

(<) :: Verbosity -> Verbosity -> Bool

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

(>) :: Verbosity -> Verbosity -> Bool

(>=) :: Verbosity -> Verbosity -> Bool

max :: Verbosity -> Verbosity -> Verbosity

min :: Verbosity -> Verbosity -> Verbosity

module Futhark.Error

onePass :: Checkable tolore => Pass fromlore tolore -> Pipeline fromlore tolore

Construct a pipeline from a single compiler pass.

passes :: Checkable lore => [Pass lore lore] -> Pipeline lore lore

Create a pipeline from a list of passes.

runPipeline :: Pipeline fromlore tolore -> PipelineConfig -> Prog fromlore -> FutharkM (Prog tolore)

Run the pipeline on the given program.