FlightRecorderProfiler.java

/*
 * Copyright (c) 2003, PostgreSQL Global Development Group
 * See the LICENSE file in the project root for more information.
 */

package org.postgresql.benchmark.profilers;

import org.openjdk.jmh.infra.BenchmarkParams;
import org.openjdk.jmh.infra.IterationParams;
import org.openjdk.jmh.profile.ExternalProfiler;
import org.openjdk.jmh.results.BenchmarkResult;
import org.openjdk.jmh.results.Result;

import java.io.File;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.TimeUnit;

/**
 * Captures Flight Recorder log. Note: Flight Recorder is available in OracleJDK only. Usage of
 * Flight Recorder in production requires a LICENSE FEE, however Flight Recorder is free for use in
 * test systems. It is assumed you would not use pgjdbc benchmarks for running a production system,
 * thus it is believed to be safe.
 */
public class FlightRecorderProfiler implements ExternalProfiler {
  @Override
  public Collection<String> addJVMInvokeOptions(BenchmarkParams params) {
    return Collections.emptyList();
  }

  @Override
  public Collection<String> addJVMOptions(BenchmarkParams params) {
    StringBuilder sb = new StringBuilder();
    for (String param : params.getParamsKeys()) {
      if (sb.length() != 0) {
        sb.append('-');
      }
      sb.append(param).append('-').append(params.getParam(param));
    }

    long duration =
        getDurationSeconds(params.getWarmup()) + getDurationSeconds(params.getMeasurement());
    List<String> opts = new ArrayList<>();
    opts.add("-XX:+UnlockCommercialFeatures");
    opts.add("-XX:+FlightRecorder");
    if (!System.getProperty("java.version").startsWith("1.7")) {
      // DebugNonSafepoints requires java 1.8u40+
      opts.add("-XX:+UnlockDiagnosticVMOptions");
      opts.add("-XX:+DebugNonSafepoints");
    }
    opts.add("-XX:StartFlightRecording=settings=profile,duration=" + duration + "s,filename="
        + params.getBenchmark() + "_" + sb + ".jfr");
    return opts;
  }

  private static long getDurationSeconds(IterationParams warmup) {
    return warmup.getTime().convertTo(TimeUnit.SECONDS) * warmup.getCount();
  }

  @Override
  public void beforeTrial(BenchmarkParams benchmarkParams) {

  }

  @Override
  public Collection<? extends Result> afterTrial(BenchmarkResult br, long pid, File stdOut,
      File stdErr) {
    return Collections.emptyList();
  }

  @Override
  public boolean allowPrintOut() {
    return true;
  }

  @Override
  public boolean allowPrintErr() {
    return true;
  }

  @Override
  public String getDescription() {
    return "Collects Java Flight Recorder profile";
  }
}