Package org.openjdk.jmh.profile

Class JavaFlightRecorderProfiler

java.lang.Object

org.openjdk.jmh.profile.JavaFlightRecorderProfiler

All Implemented Interfaces:

ExternalProfiler, InternalProfiler, Profiler

public final class JavaFlightRecorderProfiler
extends java.lang.Object
implements ExternalProfiler, InternalProfiler

A profiler based on Java Flight Recorder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JavaFlightRecorderProfiler.PostProcessor

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	configName
private boolean	debugNonSafePoints
private java.util.Collection<java.lang.String>	flightRecorderOptions
private java.util.List<java.io.File>	generated
private int	measurementIterationCount
private boolean	measurementStarted
private java.io.File	outDir
private JavaFlightRecorderProfiler.PostProcessor	postProcessor
private java.lang.String	profileName
private boolean	verbose

Constructor Summary

Constructors

Constructor	Description
JavaFlightRecorderProfiler(java.lang.String initLine)

Method Summary

Modifier and Type	Method	Description
java.util.Collection<java.lang.String>	addJVMInvokeOptions(BenchmarkParams params)	Prepend JVM invocation with these commands.
java.util.Collection<java.lang.String>	addJVMOptions(BenchmarkParams params)	Add JVM these options to the run.
java.util.Collection<? extends Result>	afterIteration(BenchmarkParams benchmarkParams, IterationParams iterationParams, IterationResult iterationResult)	Run this code after a benchmark iteration finished
java.util.Collection<? extends Result>	afterTrial(BenchmarkResult br, long pid, java.io.File stdOut, java.io.File stdErr)	Run this code after the trial is done.
boolean	allowPrintErr()	If target VM communicates with profiler with standard error, this method can be used to shun the output to console.
boolean	allowPrintOut()	If target VM communicates with profiler with standard output, this method can be used to shun the output to console.
void	beforeIteration(BenchmarkParams benchmarkParams, IterationParams iterationParams)	Run this code before starting the next benchmark iteration.
void	beforeTrial(BenchmarkParams benchmarkParams)	Run this code before starting the trial.
private java.io.File	createTrialOutDir(BenchmarkParams benchmarkParams)
private void	execute(java.lang.String jvm, java.lang.String cmd, java.util.Collection<java.lang.String> options)
private java.io.File	findJcmd(java.lang.String jvm)
java.lang.String	getDescription()	Human-readable one-line description of the profiler.
private TextResult	result()

Methods inherited from class java.lang.Object

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

Field Detail

verbose

private final boolean verbose

outDir

private final java.io.File outDir

debugNonSafePoints

private final boolean debugNonSafePoints

configName

private final java.lang.String configName

flightRecorderOptions

private final java.util.Collection<java.lang.String> flightRecorderOptions

postProcessor

private JavaFlightRecorderProfiler.PostProcessor postProcessor

measurementStarted

private boolean measurementStarted

measurementIterationCount

private int measurementIterationCount

profileName

private java.lang.String profileName

generated

private final java.util.List<java.io.File> generated

Constructor Detail

JavaFlightRecorderProfiler

public JavaFlightRecorderProfiler(java.lang.String initLine)
                           throws ProfilerException

Throws:

ProfilerException

Method Detail

beforeIteration

public void beforeIteration(BenchmarkParams benchmarkParams,
                            IterationParams iterationParams)

Description copied from interface: InternalProfiler

Run this code before starting the next benchmark iteration.

Specified by:

beforeIteration in interface InternalProfiler

Parameters:

benchmarkParams - benchmark parameters used for current launch

iterationParams - iteration parameters used for current launch

afterIteration

public java.util.Collection<? extends Result> afterIteration(BenchmarkParams benchmarkParams,
                                                             IterationParams iterationParams,
                                                             IterationResult iterationResult)

Description copied from interface: InternalProfiler

Run this code after a benchmark iteration finished

Specified by:

afterIteration in interface InternalProfiler

Parameters:

benchmarkParams - benchmark parameters used for current launch

iterationParams - iteration parameters used for current launch

iterationResult - iteration result

Returns:

profiler results

result

private TextResult result()

createTrialOutDir

private java.io.File createTrialOutDir(BenchmarkParams benchmarkParams)

execute

private void execute(java.lang.String jvm,
                     java.lang.String cmd,
                     java.util.Collection<java.lang.String> options)

findJcmd

private java.io.File findJcmd(java.lang.String jvm)

addJVMInvokeOptions

public java.util.Collection<java.lang.String> addJVMInvokeOptions(BenchmarkParams params)

Description copied from interface: ExternalProfiler

Prepend JVM invocation with these commands.

Specified by:

addJVMInvokeOptions in interface ExternalProfiler

Parameters:

params - benchmark parameters used for current launch

Returns:

commands to prepend for JVM launch

addJVMOptions

public java.util.Collection<java.lang.String> addJVMOptions(BenchmarkParams params)

Description copied from interface: ExternalProfiler

Add JVM these options to the run.

Specified by:

addJVMOptions in interface ExternalProfiler

Parameters:

params - benchmark parameters used for current launch

Returns:

options to add to JVM launch

beforeTrial

public void beforeTrial(BenchmarkParams benchmarkParams)

Description copied from interface: ExternalProfiler

Run this code before starting the trial. This method will execute before starting the benchmark JVM.

Specified by:

beforeTrial in interface ExternalProfiler

Parameters:

benchmarkParams - benchmark parameters used for current launch

afterTrial

public java.util.Collection<? extends Result> afterTrial(BenchmarkResult br,
                                                         long pid,
                                                         java.io.File stdOut,
                                                         java.io.File stdErr)

Description copied from interface: ExternalProfiler

Run this code after the trial is done. This method will execute after benchmark JVM had stopped.

Specified by:

afterTrial in interface ExternalProfiler

Parameters:

br - benchmark result that was the result of the trial

pid - pid that the forked JVM had

stdOut - file containing the standard output from the benchmark JVM

stdErr - file containing the standard error from the benchmark JVM

Returns:

profiler results

allowPrintOut

public boolean allowPrintOut()

Description copied from interface: ExternalProfiler

If target VM communicates with profiler with standard output, this method can be used to shun the output to console. Profiler is responsible for consuming the standard output and printing the relevant data from there.

Specified by:

allowPrintOut in interface ExternalProfiler

Returns:

returns true, if profiler allows harness to print out the standard output

allowPrintErr

public boolean allowPrintErr()

Description copied from interface: ExternalProfiler

If target VM communicates with profiler with standard error, this method can be used to shun the output to console. Profiler is responsible for consuming the standard error and printing the relevant data from there.

Specified by:

allowPrintErr in interface ExternalProfiler

Returns:

returns true, if profiler allows harness to print out the standard errpr

getDescription

public java.lang.String getDescription()

Description copied from interface: Profiler

Human-readable one-line description of the profiler.

Specified by:

getDescription in interface Profiler

Returns:

description