src/jdk.jfr/share/classes/jdk/jfr/internal/JVMSupport.java
author egahlin
Mon, 05 Nov 2018 14:40:16 +0100
changeset 52413 6372f5af9612
parent 50113 caf115bb98ad
permissions -rw-r--r--
8209960: -Xlog:jfr* doesn't work with the JFR Reviewed-by: mgronlun
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     1
/*
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     2
 * Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     4
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    10
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    15
 * accompanied this code).
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    16
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    20
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    23
 * questions.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    24
 */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    25
package jdk.jfr.internal;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    26
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    27
import java.io.IOException;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    28
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    29
/**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    30
 * Checks if the running VM supports Flight Recorder.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    31
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    32
 * Purpose of this helper class is to detect early and cleanly if the VM has
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    33
 * support for Flight Recorder, i.e. not throw {@link UnsatisfiedLinkError} in
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    34
 * unexpected places.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    35
 * <p>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    36
 * This is needed so a disabled-jfr.jar can be built for non Oracle JDKs.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    37
 */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    38
public final class JVMSupport {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    39
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    40
    private static final String UNSUPPORTED_VM_MESSAGE = "Flight Recorder is not supported on this VM";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    41
    private static final boolean notAvailable = !checkAvailability();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    42
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    43
    private static boolean checkAvailability() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    44
        // set jfr.unsupported.vm to true to test API on an unsupported VM
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    45
        try {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    46
            if (SecuritySupport.getBooleanProperty("jfr.unsupported.vm")) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    47
                return false;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    48
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    49
        } catch (NoClassDefFoundError cnfe) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    50
            // May happen on JDK 8, where jdk.internal.misc.Unsafe can't be found
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    51
            return false;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    52
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    53
        try {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    54
            // Will typically throw UnsatisfiedLinkError if
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    55
            // there is no native implementation
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    56
            JVM.getJVM().isAvailable();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    57
            return true;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    58
        } catch (Throwable t) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    59
            return false;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    60
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    61
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    62
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    63
    public static void ensureWithInternalError() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    64
        if (notAvailable) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    65
            throw new InternalError(UNSUPPORTED_VM_MESSAGE);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    66
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    67
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    68
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    69
    public static void ensureWithIOException() throws IOException {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    70
        if (notAvailable) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    71
            throw new IOException(UNSUPPORTED_VM_MESSAGE);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    72
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    73
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    74
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    75
    public static void ensureWithIllegalStateException() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    76
        if (notAvailable) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    77
            throw new IllegalStateException(UNSUPPORTED_VM_MESSAGE);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    78
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    79
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    80
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    81
    public static boolean isNotAvailable() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    82
        return notAvailable;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    83
    }
52413
6372f5af9612 8209960: -Xlog:jfr* doesn't work with the JFR
egahlin
parents: 50113
diff changeset
    84
6372f5af9612 8209960: -Xlog:jfr* doesn't work with the JFR
egahlin
parents: 50113
diff changeset
    85
    public static void tryToInitializeJVM() {
6372f5af9612 8209960: -Xlog:jfr* doesn't work with the JFR
egahlin
parents: 50113
diff changeset
    86
    }
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    87
}