Safe Haskell	Safe-Inferred
Language	GHC2021

Futhark.CodeGen.ImpCode.OpenCL

Description

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.

Synopsis

data Program = Program {
- openClProgram :: Text
- openClPrelude :: Text
- openClMacroDefs :: [(Name, KernelConstExp)]
- openClKernelNames :: Map KernelName KernelSafety
- openClUsedTypes :: [PrimType]
- openClParams :: ParamMap
- openClFailures :: [FailureMsg]
- hostDefinitions :: Definitions OpenCL
}
type KernelName = Name
data KernelArg
- = ValueKArg Exp PrimType
- | MemKArg VName
type CLCode = Code OpenCL
data OpenCL
- = LaunchKernel KernelSafety KernelName (Count Bytes (TExp Int64)) [KernelArg] [Exp] [BlockDim]
- | GetSize VName Name
- | CmpSizeLe VName Name Exp
- | GetSizeMax VName SizeClass
data KernelSafety
- = SafetyNone
- | SafetyCheap
- | SafetyFull
numFailureParams :: KernelSafety -> Int
data KernelTarget
- = TargetOpenCL
- | TargetCUDA
- | TargetHIP
data FailureMsg = FailureMsg {
- failureError :: ErrorMsg Exp
- failureBacktrace :: String
}
type BlockDim = Either Exp KernelConstExp
data KernelConst
- = SizeConst Name SizeClass
- | SizeMaxConst SizeClass
type KernelConstExp = PrimExp KernelConst
module Futhark.CodeGen.ImpCode
module Futhark.IR.GPU.Sizes

Documentation

data Program Source #

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 Source #

The name of a kernel.

data KernelArg Source #

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

Instances details

Show KernelArg Source #
Instance details Defined in Futhark.CodeGen.ImpCode.OpenCL Methods showsPrec :: Int -> KernelArg -> ShowS # show :: KernelArg -> String # showList :: [KernelArg] -> ShowS #

type CLCode = Code OpenCL Source #

A piece of code calling OpenCL.

data OpenCL Source #

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

Instances details

Show OpenCL Source #
Instance details Defined in Futhark.CodeGen.ImpCode.OpenCL Methods showsPrec :: Int -> OpenCL -> ShowS # show :: OpenCL -> String # showList :: [OpenCL] -> ShowS #
Pretty OpenCL Source #
Instance details Defined in Futhark.CodeGen.ImpCode.OpenCL Methods pretty :: OpenCL -> Doc ann # prettyList :: [OpenCL] -> Doc ann #

data KernelSafety Source #

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

Instances details

Show KernelSafety Source #
Instance details Defined in Futhark.CodeGen.ImpCode.OpenCL Methods showsPrec :: Int -> KernelSafety -> ShowS # show :: KernelSafety -> String # showList :: [KernelSafety] -> ShowS #
Eq KernelSafety Source #
Instance details Defined in Futhark.CodeGen.ImpCode.OpenCL Methods (==) :: KernelSafety -> KernelSafety -> Bool # (/=) :: KernelSafety -> KernelSafety -> Bool #
Ord KernelSafety Source #
Instance details 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 Source #

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

data KernelTarget Source #

The target platform when compiling imperative code to a Program

Constructors

TargetOpenCL
TargetCUDA
TargetHIP

Instances

Instances details

Eq KernelTarget Source #
Instance details Defined in Futhark.CodeGen.ImpCode.OpenCL Methods (==) :: KernelTarget -> KernelTarget -> Bool # (/=) :: KernelTarget -> KernelTarget -> Bool #

data FailureMsg Source #

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 Source #

The size of one dimension of a block.

data KernelConst Source #

A run-time constant related to kernels.

Constructors

SizeConst Name SizeClass
SizeMaxConst SizeClass

Instances

Instances details

Show KernelConst Source #
Instance details Defined in Futhark.CodeGen.ImpCode.GPU Methods showsPrec :: Int -> KernelConst -> ShowS # show :: KernelConst -> String # showList :: [KernelConst] -> ShowS #
FreeIn KernelConst Source #
Instance details Defined in Futhark.CodeGen.ImpCode.GPU Methods freeIn' :: KernelConst -> FV Source #
Eq KernelConst Source #
Instance details Defined in Futhark.CodeGen.ImpCode.GPU Methods (==) :: KernelConst -> KernelConst -> Bool # (/=) :: KernelConst -> KernelConst -> Bool #
Ord KernelConst Source #
Instance details 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 Source #
Instance details Defined in Futhark.CodeGen.ImpCode.GPU Methods pretty :: KernelConst -> Doc ann # prettyList :: [KernelConst] -> Doc ann #

type KernelConstExp = PrimExp KernelConst Source #

An expression whose variables are kernel constants.

module Futhark.CodeGen.ImpCode

module Futhark.IR.GPU.Sizes