jdk.jfr.internal.Utils Java Examples

public void dump(PlatformRecorder recorder, Recording recording, String name, String filename, Long maxSize, Boolean pathToGcRoots, Instant beginTime, Instant endTime) throws DCmdException {
    try (PlatformRecording r = newSnapShot(recorder, recording, pathToGcRoots)) {
        r.filter(beginTime, endTime, maxSize);
        if (r.getChunks().isEmpty()) {
            throw new DCmdException("Dump failed. No data found in the specified interval.");
        }
        SafePath dumpFile = resolvePath(recording, filename);

        // Needed for JVM
        Utils.touch(dumpFile.toPath());
        r.dumpStopped(new WriteableUserPath(dumpFile.toPath()));
        reportOperationComplete("Dumped", name, dumpFile);
    } catch (IOException | InvalidPathException e) {
        throw new DCmdException("Dump failed. Could not copy recording data. %s", e.getMessage());
    }
}
 

ValueDescriptor(Class<?> type, String name, List<AnnotationElement> annotations, boolean allowArray) {
    Objects.requireNonNull(annotations);
    Utils.checkRegisterPermission();
    if (!allowArray) {
        if (type.isArray()) {
            throw new IllegalArgumentException("Array types are not allowed");
        }
    }
    this.name = Objects.requireNonNull(name, "Name of value descriptor can't be null");
    this.type = Objects.requireNonNull(Utils.getValidType(Objects.requireNonNull(type), Objects.requireNonNull(name)));
    this.annotationConstruct = new AnnotationConstruct(annotations);
    this.javaFieldName = name; // Needed for dynamic events
    this.isArray = type.isArray();
    // Assume we always want to store String and Thread in constant pool
    this.constantPool = type == Class.class || type == Thread.class;
}
 

@Override
public String combine(Set<String> values) {
    Long min = null;
    String text = null;
    for (String value : values) {
        long l = Utils.parseTimespanWithInfinity(value);
        // always accept first value
        if (min == null) {
            min = l;
            text = value;
        } else {
            if (l < min) {
                text = value;
                min = l;
            }
        }
    }
    return text == null ? "0 ns" : text;
}
 

/**
 * Execute JFR.dump.
 *
 * @param recordingText name or id of the recording to dump, or
 *        <code>null</code>
 *
 * @param textPath file path where recording should be written.
 *
 * @return result output
 *
 * @throws DCmdException if the dump could not be completed
 */
public String execute(String recordingText, String textPath,  Boolean pathToGcRoots) throws DCmdException {
    if (textPath == null) {
        throw new DCmdException("Failed to dump %s, missing filename.", recordingText);
    }
    Recording recording = findRecording(recordingText);
    try {
        SafePath dumpFile = resolvePath(textPath, "Failed to dump %s");
        // create file for JVM
        Utils.touch(dumpFile.toPath());
        PlatformRecording r = PrivateAccess.getInstance().getPlatformRecording(recording);
        WriteableUserPath wup = new WriteableUserPath(dumpFile.toPath());

        Map<String, String> overlay = new HashMap<>();
        Utils.updateSettingPathToGcRoots(overlay, pathToGcRoots);

        r.copyTo(wup, "Dumped by user", overlay);
        reportOperationComplete("Dumped", recording, dumpFile);
    } catch (IOException | InvalidPathException e) {
        throw new DCmdException("Failed to dump %s. Could not copy recording for dump. %s", recordingText, e.getMessage());
    }
    return getResult();
}
 

private void printGeneral(Recording recording) {
    print("Recording " + recording.getId() + ": name=" + recording.getName());

    Duration duration = recording.getDuration();
    if (duration != null) {
        print(" duration=");
        printTimespan(duration, "");
    }

    long maxSize = recording.getMaxSize();
    if (maxSize != 0) {
        print(" maxsize=");
        print(Utils.formatBytesCompact(maxSize));
    }
    Duration maxAge = recording.getMaxAge();
    if (maxAge != null) {
        print(" maxage=");
        printTimespan(maxAge, "");
    }

    print(" (" + recording.getState().toString().toLowerCase() + ")");
    println();
}
 

@Override
public String combine(Set<String> values) {
    Long min = null;
    String text = null;
    for (String value : values) {
        long l = Utils.parseTimespanWithInfinity(value);
        // always accept first value
        if (min == null) {
            min = l;
            text = value;
        } else {
            if (l < min) {
                text = value;
                min = l;
            }
        }
    }
    return text == null ? "0 ns" : text;
}
 

private void printGeneral(Recording recording) {
    print("Recording " + recording.getId() + ": name=" + recording.getName());

    Duration duration = recording.getDuration();
    if (duration != null) {
        print(" duration=");
        printTimespan(duration, "");
    }

    long maxSize = recording.getMaxSize();
    if (maxSize != 0) {
        print(" maxsize=");
        print(Utils.formatBytesCompact(maxSize));
    }
    Duration maxAge = recording.getMaxAge();
    if (maxAge != null) {
        print(" maxage=");
        printTimespan(maxAge, "");
    }

    print(" (" + recording.getState().toString().toLowerCase() + ")");
    println();
}
 

public void dump(PlatformRecorder recorder, Recording recording, String name, String filename, Long maxSize, Boolean pathToGcRoots, Instant beginTime, Instant endTime) throws DCmdException {
    try (PlatformRecording r = newSnapShot(recorder, recording, pathToGcRoots)) {
        r.filter(beginTime, endTime, maxSize);
        if (r.getChunks().isEmpty()) {
            throw new DCmdException("Dump failed. No data found in the specified interval.");
        }
        SafePath dumpFile = resolvePath(recording, filename);

        // Needed for JVM
        Utils.touch(dumpFile.toPath());
        r.dumpStopped(new WriteableUserPath(dumpFile.toPath()));
        reportOperationComplete("Dumped", name, dumpFile);
    } catch (IOException | InvalidPathException e) {
        throw new DCmdException("Dump failed. Could not copy recording data. %s", e.getMessage());
    }
}
 

ValueDescriptor(Class<?> type, String name, List<AnnotationElement> annotations, boolean allowArray) {
    Objects.requireNonNull(annotations);
    Utils.checkRegisterPermission();
    if (!allowArray) {
        if (type.isArray()) {
            throw new IllegalArgumentException("Array types are not allowed");
        }
    }
    this.name = Objects.requireNonNull(name, "Name of value descriptor can't be null");
    this.type = Objects.requireNonNull(Utils.getValidType(Objects.requireNonNull(type), Objects.requireNonNull(name)));
    this.annotationConstruct = new AnnotationConstruct(annotations);
    this.javaFieldName = name; // Needed for dynamic events
    this.isArray = type.isArray();
    // Assume we always want to store String and Thread in constant pool
    this.constantPool = type == Class.class || type == Thread.class;
}
 

ValueDescriptor(Class<?> type, String name, List<AnnotationElement> annotations, boolean allowArray) {
    Objects.requireNonNull(annotations);
    Utils.checkRegisterPermission();
    if (!allowArray) {
        if (type.isArray()) {
            throw new IllegalArgumentException("Array types are not allowed");
        }
    }
    this.name = Objects.requireNonNull(name, "Name of value descriptor can't be null");
    this.type = Objects.requireNonNull(Utils.getValidType(Objects.requireNonNull(type), Objects.requireNonNull(name)));
    this.annotationConstruct = new AnnotationConstruct(annotations);
    this.javaFieldName = name; // Needed for dynamic events
    this.isArray = type.isArray();
    // Assume we always want to store String and Thread in constant pool
    this.constantPool = type == Class.class || type == Thread.class;
}
 

/**
 * Returns the Flight Recorder for the platform.
 *
 * @return a Flight Recorder instance, not {@code null}
 *
 * @throws IllegalStateException if Flight Recorder can't be created (for
 *         example, if the Java Virtual Machine (JVM) lacks Flight Recorder
 *         support, or if the file repository can't be created or accessed)
 *
 * @throws SecurityException if a security manager exists and the caller does
 *         not have {@code FlightRecorderPermission("accessFlightRecorder")}
 */
public static FlightRecorder getFlightRecorder() throws IllegalStateException, SecurityException {
    synchronized (PlatformRecorder.class) {
        Utils.checkAccessFlightRecorder();
        JVMSupport.ensureWithIllegalStateException();
        if (platformRecorder == null) {
            try {
                platformRecorder = new FlightRecorder(new PlatformRecorder());
            } catch (IllegalStateException ise) {
                throw ise;
            } catch (Exception e) {
                throw new IllegalStateException("Can't create Flight Recorder. " + e.getMessage(), e);
            }
            // Must be in synchronized block to prevent instance leaking out
            // before initialization is done
            initialized = true;
            Logger.log(JFR, INFO, "Flight Recorder initialized");
            Logger.log(JFR, DEBUG, "maxchunksize: " + Options.getMaxChunkSize()+ " bytes");
            Logger.log(JFR, DEBUG, "memorysize: " + Options.getMemorySize()+ " bytes");
            Logger.log(JFR, DEBUG, "globalbuffersize: " + Options.getGlobalBufferSize()+ " bytes");
            Logger.log(JFR, DEBUG, "globalbuffercount: " + Options.getGlobalBufferCount());
            Logger.log(JFR, DEBUG, "dumppath: " + Options.getDumpPath());
            Logger.log(JFR, DEBUG, "samplethreads: " + Options.getSampleThreads());
            Logger.log(JFR, DEBUG, "stackdepth: " + Options.getStackDepth());
            Logger.log(JFR, DEBUG, "threadbuffersize: " + Options.getThreadBufferSize());
            Logger.log(JFR, LogLevel.INFO, "Created repository " + Repository.getRepository().getRepositoryPath().toString());
            PlatformRecorder.notifyRecorderInitialized(platformRecorder);
        }
    }
    return platformRecorder;
}
 

public static long parseValueSafe(String value) {
    if (value == null) {
        return 0L;
    }
    try {
        return isInfinity(value) ? Long.MAX_VALUE : Utils.parseTimespan(value);
    } catch (NumberFormatException nfe) {
        return 0L;
    }
}
 

/**
 * Removes a callback hook for a periodic event.
 *
 * @param hook the hook to remove, not {@code null}
 * @return {@code true} if hook is removed, {@code false} otherwise
 * @throws SecurityException if a security manager exists and the caller
 *         does not have {@code FlightRecorderPermission("registerEvent")}
 */
public static boolean removePeriodicEvent(Runnable hook) throws SecurityException {
    Objects.requireNonNull(hook);
    Utils.checkRegisterPermission();
    if (JVMSupport.isNotAvailable()) {
        return false;
    }
    return RequestEngine.removeHook(hook);
}
 

/**
 * Returns the Flight Recorder for the platform.
 *
 * @return a Flight Recorder instance, not {@code null}
 *
 * @throws IllegalStateException if the platform Flight Recorder couldn't be
 *         created (for example, if the file repository can't be created or
 *         accessed)
 *
 * @throws SecurityException if a security manager exists and the caller does
 *         not have {@code FlightRecorderPermission("accessFlightRecorder")}
 */
public static FlightRecorder getFlightRecorder() throws IllegalStateException, SecurityException {
    synchronized (PlatformRecorder.class) {
        Utils.checkAccessFlightRecorder();
        JVMSupport.ensureWithIllegalStateException();
        if (platformRecorder == null) {
            try {
                platformRecorder = new FlightRecorder(new PlatformRecorder());
            } catch (IllegalStateException ise) {
                throw ise;
            } catch (Exception e) {
                throw new IllegalStateException("Can't create Flight Recorder. " + e.getMessage(), e);
            }
            // Must be in synchronized block to prevent instance leaking out
            // before initialization is done
            initialized = true;
            Logger.log(JFR, INFO, "Flight Recorder initialized");
            Logger.log(JFR, DEBUG, "maxchunksize: " + Options.getMaxChunkSize()+ " bytes");
            Logger.log(JFR, DEBUG, "memorysize: " + Options.getMemorySize()+ " bytes");
            Logger.log(JFR, DEBUG, "globalbuffersize: " + Options.getGlobalBufferSize()+ " bytes");
            Logger.log(JFR, DEBUG, "globalbuffercount: " + Options.getGlobalBufferCount());
            Logger.log(JFR, DEBUG, "dumppath: " + Options.getDumpPath());
            Logger.log(JFR, DEBUG, "samplethreads: " + Options.getSampleThreads());
            Logger.log(JFR, DEBUG, "stackdepth: " + Options.getStackDepth());
            Logger.log(JFR, DEBUG, "threadbuffersize: " + Options.getThreadBufferSize());
            Logger.log(JFR, LogLevel.INFO, "Created repository " + Repository.getRepository().getRepositoryPath().toString());
            PlatformRecorder.notifyRecorderInitialized(platformRecorder);
        }
    }
    return platformRecorder;
}
 

@Override
public String combine(Set<String> values) {
    long min = Long.MAX_VALUE;
    String text = "0 ns";
    for (String value : values) {
        long l = Utils.parseTimespan(value);
        if (l < min) {
            text = value;
            min = l;
        }
    }
    return text;
}
 

@Override
public String combine(Set<String> values) {
    long min = Long.MAX_VALUE;
    boolean beginChunk = false;
    boolean endChunk = false;
    String text = EVERY_CHUNK;
    for (String value : values) {
        switch (value) {
        case EVERY_CHUNK:
            beginChunk = true;
            endChunk = true;
            break;
        case BEGIN_CHUNK:
            beginChunk = true;
            break;
        case END_CHUNK:
            endChunk = true;
            break;
        default:
            long l = Utils.parseTimespan(value);
            if (l < min) {
                text = value;
                min = l;
            }
        }
    }
    if (min != Long.MAX_VALUE) {
        return text;
    }
    if (beginChunk && !endChunk) {
        return BEGIN_CHUNK;
    }
    if (!beginChunk && endChunk) {
        return END_CHUNK;
    }
    return text;
}
 

public static List<EventType> getEventTypes() {
    // would normally be checked when a Flight Recorder instance is created
    Utils.checkAccessFlightRecorder();
    if (JVMSupport.isNotAvailable()) {
        return new ArrayList<>();
    }
    JDKEvents.initialize(); // make sure JDK events are available
    return Collections.unmodifiableList(MetadataRepository.getInstance().getRegisteredEventTypes());
}
 

public static long parseValueSafe(String value) {
    if (value == null) {
        return 0L;
    }
    try {
        return Utils.parseTimespanWithInfinity(value);
    } catch (NumberFormatException nfe) {
        return 0L;
    }
}
 

/**
 * Returns the Flight Recorder for the platform.
 *
 * @return a Flight Recorder instance, not {@code null}
 *
 * @throws IllegalStateException if Flight Recorder can't be created (for
 *         example, if the Java Virtual Machine (JVM) lacks Flight Recorder
 *         support, or if the file repository can't be created or accessed)
 *
 * @throws SecurityException if a security manager exists and the caller does
 *         not have {@code FlightRecorderPermission("accessFlightRecorder")}
 */
public static FlightRecorder getFlightRecorder() throws IllegalStateException, SecurityException {
    synchronized (PlatformRecorder.class) {
        Utils.checkAccessFlightRecorder();
        JVMSupport.ensureWithIllegalStateException();
        if (platformRecorder == null) {
            try {
                platformRecorder = new FlightRecorder(new PlatformRecorder());
            } catch (IllegalStateException ise) {
                throw ise;
            } catch (Exception e) {
                throw new IllegalStateException("Can't create Flight Recorder. " + e.getMessage(), e);
            }
            // Must be in synchronized block to prevent instance leaking out
            // before initialization is done
            initialized = true;
            Logger.log(JFR, INFO, "Flight Recorder initialized");
            Logger.log(JFR, DEBUG, "maxchunksize: " + Options.getMaxChunkSize()+ " bytes");
            Logger.log(JFR, DEBUG, "memorysize: " + Options.getMemorySize()+ " bytes");
            Logger.log(JFR, DEBUG, "globalbuffersize: " + Options.getGlobalBufferSize()+ " bytes");
            Logger.log(JFR, DEBUG, "globalbuffercount: " + Options.getGlobalBufferCount());
            Logger.log(JFR, DEBUG, "dumppath: " + Options.getDumpPath());
            Logger.log(JFR, DEBUG, "samplethreads: " + Options.getSampleThreads());
            Logger.log(JFR, DEBUG, "stackdepth: " + Options.getStackDepth());
            Logger.log(JFR, DEBUG, "threadbuffersize: " + Options.getThreadBufferSize());
            Logger.log(JFR, LogLevel.INFO, "Created repository " + Repository.getRepository().getRepositoryPath().toString());
            PlatformRecorder.notifyRecorderInitialized(platformRecorder);
        }
    }
    return platformRecorder;
}
 

/**
 * Removes a hook for a periodic event.
 *
 * @param hook the hook to remove, not {@code null}
 * @return {@code true} if hook is removed, {@code false} otherwise
 * @throws SecurityException if a security manager exists and the caller
 *         does not have {@code FlightRecorderPermission("registerEvent")}
 */
public static boolean removePeriodicEvent(Runnable hook) throws SecurityException {
    Objects.requireNonNull(hook);
    Utils.checkRegisterPermission();
    if (JVMSupport.isNotAvailable()) {
        return false;
    }
    return RequestEngine.removeHook(hook);
}
 

public static List<EventType> getEventTypes() {
    // would normally be checked when a Flight Recorder instance is created
    Utils.checkAccessFlightRecorder();
    if (JVMSupport.isNotAvailable()) {
        return new ArrayList<>();
    }
    JDKEvents.initialize(); // make sure JDK events are available
    return Collections.unmodifiableList(MetadataRepository.getInstance().getRegisteredEventTypes());
}
 

public static List<EventType> getEventTypes() {
    // would normally be checked when a Flight Recorder instance is created
    Utils.checkAccessFlightRecorder();
    if (JVMSupport.isNotAvailable()) {
        return new ArrayList<>();
    }
    JDKEvents.initialize(); // make sure JDK events are available
    return Collections.unmodifiableList(MetadataRepository.getInstance().getRegisteredEventTypes());
}
 

@Override
public String combine(Set<String> values) {
    long max = 0;
    String text = "0 ns";
    for (String value : values) {
        long l =  Utils.parseTimespanWithInfinity(value);
        if (l > max) {
            text = value;
            max = l;
        }
    }
    return text;
}
 

public static long parseValueSafe(String value) {
    if (value == null) {
        return 0L;
    }
    try {
        return Utils.parseTimespanWithInfinity(value);
    } catch (NumberFormatException nfe) {
        return 0L;
    }
}
 

/**
 * Removes a hook for a periodic event.
 *
 * @param hook the hook to remove, not {@code null}
 * @return {@code true} if hook is removed, {@code false} otherwise
 * @throws SecurityException if a security manager exists and the caller
 *         does not have {@code FlightRecorderPermission("registerEvent")}
 */
public static boolean removePeriodicEvent(Runnable hook) throws SecurityException {
    Objects.requireNonNull(hook);
    Utils.checkRegisterPermission();
    if (JVMSupport.isNotAvailable()) {
        return false;
    }
    return RequestEngine.removeHook(hook);
}
 

@Override
public String combine(Set<String> values) {
    long max = 0;
    String text = "0 ns";
    for (String value : values) {
        long l =  Utils.parseTimespanWithInfinity(value);
        if (l > max) {
            text = value;
            max = l;
        }
    }
    return text;
}
 

@Override
public void setValue(String value) {
    long l =  Utils.parseTimespanWithInfinity(value);
    this.value = value;
    eventType.setCutoff(l);
}
 

@Override
public String combine(Set<String> values) {

    boolean beginChunk = false;
    boolean endChunk = false;
    Long min = null;
    String text = null;
    for (String value : values) {
        switch (value) {
        case EVERY_CHUNK:
            beginChunk = true;
            endChunk = true;
            break;
        case BEGIN_CHUNK:
            beginChunk = true;
            break;
        case END_CHUNK:
            endChunk = true;
            break;
        default:
            long l = Utils.parseTimespanWithInfinity(value);
            // Always accept first specified value
            if (min == null) {
                text = value;
                min = l;
            } else {
                if (l < min) {
                    text = value;
                    min = l;
                }
            }
        }
    }
    // A specified interval trumps *_CHUNK
    if (min != null) {
        return text;
    }
    if (beginChunk && !endChunk) {
        return BEGIN_CHUNK;
    }
    if (!beginChunk && endChunk) {
        return END_CHUNK;
    }
    return EVERY_CHUNK; // also default
}
 

@Override
public void setValue(String value) {
    long l = Utils.parseTimespanWithInfinity(value);
    this.value = value;
    eventType.setThreshold(l);
}
 

@Override
public String combine(Set<String> values) {

    boolean beginChunk = false;
    boolean endChunk = false;
    Long min = null;
    String text = null;
    for (String value : values) {
        switch (value) {
        case EVERY_CHUNK:
            beginChunk = true;
            endChunk = true;
            break;
        case BEGIN_CHUNK:
            beginChunk = true;
            break;
        case END_CHUNK:
            endChunk = true;
            break;
        default:
            long l = Utils.parseTimespanWithInfinity(value);
            // Always accept first specified value
            if (min == null) {
                text = value;
                min = l;
            } else {
                if (l < min) {
                    text = value;
                    min = l;
                }
            }
        }
    }
    // A specified interval trumps *_CHUNK
    if (min != null) {
        return text;
    }
    if (beginChunk && !endChunk) {
        return BEGIN_CHUNK;
    }
    if (!beginChunk && endChunk) {
        return END_CHUNK;
    }
    return EVERY_CHUNK; // also default
}