Futhark.CodeGen.ImpCode.OpenCL

Imperative code with an OpenCL component.

Apart from ordinary imperative code, this also carries around an OpenCL program as a string, as well as a list of kernels defined by the OpenCL program.

The imperative code has been augmented with a LaunchKernel operation that allows one to execute an OpenCL kernel.

Documentation

data Program

An program calling OpenCL kernels.

Constructors

Program

Fields

• openClProgram :: Text
• openClPrelude :: Text

  Must be prepended to the program.

• openClMacroDefs :: [(Name, KernelConstExp)]

  Definitions to be passed as macro definitions to the kernel compiler.

• openClKernelNames :: Map KernelName KernelSafety
• openClUsedTypes :: [PrimType]

  So we can detect whether the device is capable.

• openClParams :: ParamMap

  Runtime-configurable constants.

• openClFailures :: [FailureMsg]

  Assertion failure error messages.

• hostDefinitions :: Definitions OpenCL

type KernelName = Name

The name of a kernel.

data KernelArg

An argument to be passed to a kernel.

Constructors

ValueKArg Exp PrimType

Pass the value of this scalar expression as argument.

MemKArg VName

Pass this pointer as argument.

Instances

Show KernelArg

Defined in Futhark.CodeGen.ImpCode.OpenCL

Methods

showsPrec :: Int -> KernelArg -> ShowS

show :: KernelArg -> String

showList :: [KernelArg] -> ShowS

type CLCode = Code OpenCL

A piece of code calling OpenCL.

data OpenCL

Host-level OpenCL operation.

Constructors

LaunchKernel KernelSafety KernelName (Count Bytes (TExp Int64)) [KernelArg] [Exp] [BlockDim]

GetSize VName Name

CmpSizeLe VName Name Exp

GetSizeMax VName SizeClass

Instances

Show OpenCL

Defined in Futhark.CodeGen.ImpCode.OpenCL

Methods

showsPrec :: Int -> OpenCL -> ShowS

show :: OpenCL -> String

showList :: [OpenCL] -> ShowS

Pretty OpenCL

Defined in Futhark.CodeGen.ImpCode.OpenCL

Methods

pretty :: OpenCL -> Doc ann

prettyList :: [OpenCL] -> Doc ann

data KernelSafety

Information about bounds checks and how sensitive it is to errors. Ordered by least demanding to most.

Constructors

SafetyNone

Does not need to know if we are in a failing state, and also cannot fail.

SafetyCheap

Needs to be told if there's a global failure, and that's it, and cannot fail.

SafetyFull

Needs all parameters, may fail itself.

Instances

Show KernelSafety

Defined in Futhark.CodeGen.ImpCode.OpenCL

Methods

showsPrec :: Int -> KernelSafety -> ShowS

show :: KernelSafety -> String

showList :: [KernelSafety] -> ShowS

Eq KernelSafety

Defined in Futhark.CodeGen.ImpCode.OpenCL

Methods

(==) :: KernelSafety -> KernelSafety -> Bool

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

Ord KernelSafety

Defined in Futhark.CodeGen.ImpCode.OpenCL

Methods

compare :: KernelSafety -> KernelSafety -> Ordering

(<) :: KernelSafety -> KernelSafety -> Bool

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

(>) :: KernelSafety -> KernelSafety -> Bool

(>=) :: KernelSafety -> KernelSafety -> Bool

max :: KernelSafety -> KernelSafety -> KernelSafety

min :: KernelSafety -> KernelSafety -> KernelSafety

numFailureParams :: KernelSafety -> Int

How many leading failure arguments we must pass when launching a kernel with these safety characteristics.

data KernelTarget

The target platform when compiling imperative code to a Program

Constructors

TargetOpenCL

TargetCUDA

TargetHIP

Instances

Eq KernelTarget

Defined in Futhark.CodeGen.ImpCode.OpenCL

Methods

(==) :: KernelTarget -> KernelTarget -> Bool

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

data FailureMsg

Something that can go wrong in a kernel. Part of the machinery for reporting error messages from within kernels.

Constructors

FailureMsg

Fields

• failureError :: ErrorMsg Exp
• failureBacktrace :: String

type BlockDim = Either Exp KernelConstExp

The size of one dimension of a block.

data KernelConst

A run-time constant related to kernels.

Constructors

SizeConst Name SizeClass

SizeMaxConst SizeClass

Instances

Show KernelConst

Defined in Futhark.CodeGen.ImpCode.GPU

Methods

showsPrec :: Int -> KernelConst -> ShowS

show :: KernelConst -> String

showList :: [KernelConst] -> ShowS

FreeIn KernelConst

Defined in Futhark.CodeGen.ImpCode.GPU

Methods

freeIn' :: KernelConst -> FV

Eq KernelConst

Defined in Futhark.CodeGen.ImpCode.GPU

Methods

(==) :: KernelConst -> KernelConst -> Bool

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

Ord KernelConst

Defined in Futhark.CodeGen.ImpCode.GPU

Methods

compare :: KernelConst -> KernelConst -> Ordering

(<) :: KernelConst -> KernelConst -> Bool

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

(>) :: KernelConst -> KernelConst -> Bool

(>=) :: KernelConst -> KernelConst -> Bool

max :: KernelConst -> KernelConst -> KernelConst

min :: KernelConst -> KernelConst -> KernelConst

Pretty KernelConst

Defined in Futhark.CodeGen.ImpCode.GPU

Methods

pretty :: KernelConst -> Doc ann

prettyList :: [KernelConst] -> Doc ann

type KernelConstExp = PrimExp KernelConst

An expression whose variables are kernel constants.

module Futhark.CodeGen.ImpCode

module Futhark.IR.GPU.Sizes