Futhark.Test

Facilities for reading Futhark test programs. A Futhark test program is an ordinary Futhark program where an initial comment block specifies input- and output-sets.

Documentation

testSpecFromFile :: FilePath -> IO (Either String ProgramTest)

Read the test specification from the given Futhark program.

testSpecFromFileOrDie :: FilePath -> IO ProgramTest

Like testSpecFromFile, but kills the process on error.

testSpecsFromPaths :: [FilePath] -> IO (Either String [(FilePath, ProgramTest)])

Read test specifications from the given paths, which can be a files or directories containing .fut files and further directories.

testSpecsFromPathsOrDie :: [FilePath] -> IO [(FilePath, ProgramTest)]

Like testSpecsFromPaths, but kills the process on errors.

valuesFromByteString :: String -> ByteString -> Either String [Value]

Try to parse a several values from a byte string. The String parameter is used for error messages.

newtype FutharkExe

The futhark executable we are using. This is merely a wrapper around the underlying file path, because we will be using a lot of different file paths here, and it is easy to mix them up.

Constructors

FutharkExe FilePath

Instances

Eq FutharkExe

Defined in Futhark.Test

Methods

(==) :: FutharkExe -> FutharkExe -> Bool

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

Ord FutharkExe

Defined in Futhark.Test

Methods

compare :: FutharkExe -> FutharkExe -> Ordering

(<) :: FutharkExe -> FutharkExe -> Bool

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

(>) :: FutharkExe -> FutharkExe -> Bool

(>=) :: FutharkExe -> FutharkExe -> Bool

max :: FutharkExe -> FutharkExe -> FutharkExe

min :: FutharkExe -> FutharkExe -> FutharkExe

Show FutharkExe

Defined in Futhark.Test

Methods

showsPrec :: Int -> FutharkExe -> ShowS

show :: FutharkExe -> String

showList :: [FutharkExe] -> ShowS

getValues :: (MonadFail m, MonadIO m) => FutharkExe -> FilePath -> Values -> m [Value]

Get the actual core Futhark values corresponding to a Values specification. The first FilePath is the path of the futhark executable, and the second is the directory which file paths are read relative to.

getValuesBS :: (MonadFail m, MonadIO m) => FutharkExe -> FilePath -> Values -> m ByteString

Extract a pretty representation of some Values. In the IO monad because this might involve reading from a file. There is no guarantee that the resulting byte string yields a readable value.

valuesAsVars :: (MonadError Text m, MonadIO m) => Server -> [(VarName, TypeName)] -> FutharkExe -> FilePath -> Values -> m ()

Make the provided Values available as server-side variables. This may involve arbitrary server-side computation. Error detection... dubious.

compareValues :: Tolerance -> Value -> Value -> [Mismatch]

Compare two Futhark values for equality.

checkResult :: (MonadError Text m, MonadIO m) => FilePath -> [Value] -> [Value] -> m ()

Check that the result is as expected, and write files and throw an error if not.

testRunReferenceOutput :: FilePath -> Text -> TestRun -> FilePath

When/if generating a reference output file for this run, what should it be called? Includes the "data/" folder.

getExpectedResult :: (MonadFail m, MonadIO m) => FutharkExe -> FilePath -> Text -> TestRun -> m (ExpectedResult [Value])

Get the values corresponding to an expected result, if any.

compileProgram :: (MonadIO m, MonadError [Text] m) => [String] -> FutharkExe -> String -> FilePath -> m (ByteString, ByteString)

compileProgram extra_options futhark backend program compiles program with the command futhark backend extra-options..., and returns stdout and stderr of the compiler. Throws an IO exception containing stderr if compilation fails.

runProgram :: FutharkExe -> FilePath -> [String] -> String -> Text -> Values -> IO (ExitCode, ByteString, ByteString)

runProgram futhark runner extra_options prog entry input runs the Futhark program prog (which must have the .fut suffix), executing the entry entry point and providing input on stdin. The program must have been compiled in advance with compileProgram. If runner is non-null, then it is used as "interpreter" for the compiled program (e.g. python when using the Python backends). The extra_options are passed to the program.

readResults :: (MonadIO m, MonadError Text m) => Server -> [VarName] -> m [Value]

Read the given variables from a running server.

ensureReferenceOutput :: (MonadIO m, MonadError [Text] m) => Maybe Int -> FutharkExe -> String -> FilePath -> [InputOutputs] -> m ()

Ensure that any reference output files exist, or create them (by compiling the program with the reference compiler and running it on the input) if necessary.

determineTuning :: MonadIO m => Maybe FilePath -> FilePath -> m ([String], String)

Determine the --tuning options to pass to the program. The first argument is the extension of the tuning file, or Nothing if none should be used.

binaryName :: FilePath -> FilePath

The name we use for compiled programs.

futharkServerCfg :: FilePath -> [String] -> ServerCfg

Create a Futhark server configuration suitable for use when testing/benchmarking Futhark programs.

data Mismatch

Two values differ in some way. The Show instance produces a human-readable explanation.

Instances

Show Mismatch

Defined in Futhark.Data.Compare

Methods

showsPrec :: Int -> Mismatch -> ShowS

show :: Mismatch -> String

showList :: [Mismatch] -> ShowS

data ProgramTest

Description of a test to be carried out on a Futhark program. The Futhark program is stored separately.

Constructors

ProgramTest

Fields

• testDescription :: Text
• testTags :: [Text]
• testAction :: TestAction

Instances

Show ProgramTest

Defined in Futhark.Test

Methods

showsPrec :: Int -> ProgramTest -> ShowS

show :: ProgramTest -> String

showList :: [ProgramTest] -> ShowS

data StructureTest

A structure test specifies a compilation pipeline, as well as metrics for the program coming out the other end.

Constructors

StructureTest StructurePipeline AstMetrics

Instances

Show StructureTest

Defined in Futhark.Test

Methods

showsPrec :: Int -> StructureTest -> ShowS

show :: StructureTest -> String

showList :: [StructureTest] -> ShowS

data StructurePipeline

How a program can be transformed.

Constructors

KernelsPipeline

SOACSPipeline

SequentialCpuPipeline

GpuPipeline

NoPipeline

Instances

Show StructurePipeline

Defined in Futhark.Test

Methods

showsPrec :: Int -> StructurePipeline -> ShowS

show :: StructurePipeline -> String

showList :: [StructurePipeline] -> ShowS

data WarningTest

A warning test requires that a warning matching the regular expression is produced. The program must also compile succesfully.

Constructors

ExpectedWarning Text Regex

Instances

Show WarningTest

Defined in Futhark.Test

Methods

showsPrec :: Int -> WarningTest -> ShowS

show :: WarningTest -> String

showList :: [WarningTest] -> ShowS

data TestAction

How to test a program.

Constructors

CompileTimeFailure ExpectedError

RunCases [InputOutputs] [StructureTest] [WarningTest]

Instances

Show TestAction

Defined in Futhark.Test

Methods

showsPrec :: Int -> TestAction -> ShowS

show :: TestAction -> String

showList :: [TestAction] -> ShowS

data ExpectedError

The error expected for a negative test.

Constructors

AnyError

ThisError Text Regex

Instances

Show ExpectedError

Defined in Futhark.Test

Methods

showsPrec :: Int -> ExpectedError -> ShowS

show :: ExpectedError -> String

showList :: [ExpectedError] -> ShowS

data InputOutputs

Input and output pairs for some entry point(s).

Constructors

InputOutputs

Fields

• iosEntryPoint :: Text
• iosTestRuns :: [TestRun]

Instances

Show InputOutputs

Defined in Futhark.Test

Methods

showsPrec :: Int -> InputOutputs -> ShowS

show :: InputOutputs -> String

showList :: [InputOutputs] -> ShowS

data TestRun

A condition for execution, input, and expected result.

Constructors

TestRun

Fields

• runTags :: [String]
• runInput :: Values
• runExpectedResult :: ExpectedResult Success
• runIndex :: Int
• runDescription :: String

Instances

Show TestRun

Defined in Futhark.Test

Methods

showsPrec :: Int -> TestRun -> ShowS

show :: TestRun -> String

showList :: [TestRun] -> ShowS

data ExpectedResult values

How a test case is expected to terminate.

Constructors

Succeeds (Maybe values)

Execution suceeds, with or without expected result values.

RunTimeFailure ExpectedError

Execution fails with this error.

Instances

Show values => Show (ExpectedResult values)

Defined in Futhark.Test

Methods

showsPrec :: Int -> ExpectedResult values -> ShowS

show :: ExpectedResult values -> String

showList :: [ExpectedResult values] -> ShowS

data Success

The result expected from a succesful execution.

Constructors

SuccessValues Values

These values are expected.

SuccessGenerateValues

Compute expected values from executing a known-good reference implementation.

Instances

Show Success

Defined in Futhark.Test

Methods

showsPrec :: Int -> Success -> ShowS

show :: Success -> String

showList :: [Success] -> ShowS

data Values

Several values - either literally, or by reference to a file, or to be generated on demand. All paths are relative to test program.

Constructors

Values [Value]

InFile FilePath

GenValues [GenValue]

ScriptValues Exp

ScriptFile FilePath

Instances

Show Values

Defined in Futhark.Test

Methods

showsPrec :: Int -> Values -> ShowS

show :: Values -> String

showList :: [Values] -> ShowS

data Value

An efficiently represented Futhark value, represented as a shape vector and a value vector, which contains elements in row-major order. The size of the value vector must be equal to the product of the shape vector. This is not enforced by the representation, but consuming functions may give unexpected results if this invariant is broken. Scalars are represented with an empty shape vector.

Use valueText to get a human-readable representation, and put to obtain binary a representation.

The Eq instance is the naive one, meaning that no values containing NaNs will be considered equal. Use the functions from Futhark.Data.Compare if this is not what you want.

Instances

Eq Value

Defined in Futhark.Data

Methods

(==) :: Value -> Value -> Bool

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

Show Value

Defined in Futhark.Data

Methods

showsPrec :: Int -> Value -> ShowS

show :: Value -> String

showList :: [Value] -> ShowS

Binary Value

Defined in Futhark.Data

Methods

put :: Value -> Put

get :: Get Value

putList :: [Value] -> Put

Pretty Value

Defined in Futhark.Test.Values

Methods

ppr :: Value -> Doc

pprPrec :: Int -> Value -> Doc

pprList :: [Value] -> Doc

PutValue [Value]

Defined in Futhark.Data

Methods

putValue :: [Value] -> Maybe Value

valueText :: Value -> Text

Construct a textual representation of the value as a strict text.