HSBencher

Convenience module that reexports the necessary bits.

The main entrypoints for building new benchmark suites.

defaultMainModifyConfig :: (Config -> Config) -> IO ()

An even more flexible version allows the user to install a hook which modifies the configuration just before bencharking begins. All trawling of the execution environment (command line args, environment variables) happens BEFORE the user sees the configuration.

This function doesn't take a benchmark list separately, because that simply corresponds to the benchlist field of the output Config.

addPlugin :: Plugin p => p -> PlugConf p -> Config -> Config

This abstracts over the actions we need to take to properly add an additional plugin to the Config.

addBenchmarks :: [Benchmark DefaultParamMeaning] -> Config -> Config

A convenience combinator for composing together with other Config transformers. This one adds benchmarks to whatever is already in the benchlist field.

Command-line configuration

data Flag

Command line flags to the benchmarking executable.

Constructors

ParBench

BenchsetName String

BinDir FilePath

NoRecomp

NoCabal

NoClean

ShortRun

KeepGoing

NumTrials String

SkipTo String

RunOnly Int

RetryFailed Int

RunID String

CIBuildID String

ForceHostName String

CabalPath String

GHCPath String

ShowHelp

ShowVersion

ShowBenchmarks

DisablePlug String

AddLSPCI

ExtraParam ParamSetting

SetAffinityPacked

SetAffinitySpreadOut

Instances

Show Flag

all_cli_options :: [(String, [OptDescr Flag])]

fullUsageInfo :: String

Multiple lines of usage info help docs.

All the types necessary for configuration and customization

Don't import the module below directly, but do click on this link to read its documentation.

module HSBencher.Types

module HSBencher.Harvesters