Package org.teavm.perf

Class BenchmarkBackend

java.lang.Object

org.teavm.perf.BenchmarkBackend

Direct Known Subclasses:

BrowserBackend, CBackend

public abstract class BenchmarkBackend
extends Object

Compiles benchmarks for a particular TeaVM backend and runs them.

Field Summary

Fields

Modifier and Type	Field	Description
protected final BenchmarkEnvironment	environment

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BenchmarkBackend(BenchmarkEnvironment environment)

Method Summary

Modifier and Type	Method	Description
protected final void	build(org.teavm.vm.TeaVMTarget target, String entryPoint, BenchmarkInfo benchmark, File directory, String fileName)
abstract CompiledBenchmark	compile(BenchmarkInfo benchmark, File directory)
protected final void	copyResource(String resource, File target)
abstract String	getDescription()	Human-readable description, used in reports.
abstract String	getName()	Short identifier of the backend, also used in command line.
abstract void	run(CompiledBenchmark benchmark, String argument, Consumer<String> outputConsumer)	Runs compiled benchmark once, i.e. performs a single JMH fork.
void	start()
void	stop()
boolean	supportsCpuProfiling()
String	takeCpuProfile(String title)	Returns CPU profile of measurement iterations of the last run, recorded with the given title.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

environment

protected final BenchmarkEnvironment environment

Constructor Details

BenchmarkBackend

protected BenchmarkBackend(BenchmarkEnvironment environment)

Method Details

getName

public abstract String getName()

Short identifier of the backend, also used in command line.

getDescription

public abstract String getDescription()

Human-readable description, used in reports. Mapped to vmName field of JMH JSON output.

compile

public abstract CompiledBenchmark compile(BenchmarkInfo benchmark,
 File directory)
                                   throws BenchmarkException

Throws:

BenchmarkException

start

public void start()
           throws BenchmarkException

Throws:

BenchmarkException

stop

public void stop()

run

public abstract void run(CompiledBenchmark benchmark,
 String argument,
 Consumer<String> outputConsumer)
                  throws BenchmarkException

Runs compiled benchmark once, i.e. performs a single JMH fork.

Parameters:

outputConsumer - receives every line written by benchmark to stdout.

Throws:

BenchmarkException

supportsCpuProfiling

public boolean supportsCpuProfiling()

takeCpuProfile

public String takeCpuProfile(String title)
                      throws BenchmarkException

Returns CPU profile of measurement iterations of the last run, recorded with the given title.

Returns:

profile in Chrome DevTools format (.cpuprofile).

Throws:

BenchmarkException

build

protected final void build(org.teavm.vm.TeaVMTarget target,
 String entryPoint,
 BenchmarkInfo benchmark,
 File directory,
 String fileName)
                    throws BenchmarkException

Throws:

BenchmarkException

copyResource

protected final void copyResource(String resource,
 File target)
                           throws BenchmarkException

Throws:

BenchmarkException