Package org.openjdk.jmh.profile
Class AsyncProfiler
- java.lang.Object
-
- org.openjdk.jmh.profile.AsyncProfiler
-
- All Implemented Interfaces:
ExternalProfiler
,InternalProfiler
,Profiler
public final class AsyncProfiler extends Object implements ExternalProfiler, InternalProfiler
A profiler based on async-profiler.- Author:
- Jason Zaugg
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AsyncProfiler.CStackMode
static class
AsyncProfiler.Direction
static class
AsyncProfiler.JavaApi
static class
AsyncProfiler.OutputType
-
Constructor Summary
Constructors Constructor Description AsyncProfiler(String initLine)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Collection<String>
addJVMInvokeOptions(BenchmarkParams params)
Prepend JVM invocation with these commands.Collection<String>
addJVMOptions(BenchmarkParams params)
Add JVM these options to the run.Collection<? extends Result>
afterIteration(BenchmarkParams benchmarkParams, IterationParams iterationParams, IterationResult iterationResult)
Run this code after a benchmark iteration finishedCollection<? extends Result>
afterTrial(BenchmarkResult br, long pid, File stdOut, 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.String
getDescription()
Human-readable one-line description of the profiler.
-
-
-
Constructor Detail
-
AsyncProfiler
public AsyncProfiler(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 interfaceInternalProfiler
- Parameters:
benchmarkParams
- benchmark parameters used for current launchiterationParams
- iteration parameters used for current launch
-
afterIteration
public 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 interfaceInternalProfiler
- Parameters:
benchmarkParams
- benchmark parameters used for current launchiterationParams
- iteration parameters used for current launchiterationResult
- iteration result- Returns:
- profiler results
-
addJVMInvokeOptions
public Collection<String> addJVMInvokeOptions(BenchmarkParams params)
Description copied from interface:ExternalProfiler
Prepend JVM invocation with these commands.- Specified by:
addJVMInvokeOptions
in interfaceExternalProfiler
- Parameters:
params
- benchmark parameters used for current launch- Returns:
- commands to prepend for JVM launch
-
addJVMOptions
public Collection<String> addJVMOptions(BenchmarkParams params)
Description copied from interface:ExternalProfiler
Add JVM these options to the run.- Specified by:
addJVMOptions
in interfaceExternalProfiler
- 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 interfaceExternalProfiler
- Parameters:
benchmarkParams
- benchmark parameters used for current launch
-
afterTrial
public Collection<? extends Result> afterTrial(BenchmarkResult br, long pid, File stdOut, 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 interfaceExternalProfiler
- Parameters:
br
- benchmark result that was the result of the trialpid
- pid that the forked JVM hadstdOut
- file containing the standard output from the benchmark JVMstdErr
- 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 interfaceExternalProfiler
- 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 interfaceExternalProfiler
- Returns:
- returns true, if profiler allows harness to print out the standard errpr
-
getDescription
public String getDescription()
Description copied from interface:Profiler
Human-readable one-line description of the profiler.- Specified by:
getDescription
in interfaceProfiler
- Returns:
- description
-
-