src/jdk.jfr/share/classes/jdk/jfr/internal/dcmd/DCmdCheck.java
author egahlin
Thu, 13 Dec 2018 14:21:04 +0100
changeset 53013 c8b2a408628b
parent 52413 6372f5af9612
permissions -rw-r--r--
8215175: Inconsistencies in JFR event metadata 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) 2012, 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.dcmd;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    26
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    27
import java.time.Duration;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    28
import java.util.ArrayList;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    29
import java.util.Collection;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    30
import java.util.Collections;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    31
import java.util.Comparator;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    32
import java.util.List;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    33
import java.util.Map;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    34
import java.util.StringJoiner;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    35
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    36
import jdk.jfr.EventType;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    37
import jdk.jfr.Recording;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    38
import jdk.jfr.SettingDescriptor;
50745
a390cbb82d47 8203929: Limit amount of data for JFR.dump
egahlin
parents: 50226
diff changeset
    39
import jdk.jfr.internal.LogLevel;
a390cbb82d47 8203929: Limit amount of data for JFR.dump
egahlin
parents: 50226
diff changeset
    40
import jdk.jfr.internal.LogTag;
a390cbb82d47 8203929: Limit amount of data for JFR.dump
egahlin
parents: 50226
diff changeset
    41
import jdk.jfr.internal.Logger;
53013
c8b2a408628b 8215175: Inconsistencies in JFR event metadata
egahlin
parents: 52413
diff changeset
    42
import jdk.jfr.internal.Utils;
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    43
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    44
/**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    45
 * JFR.check - invoked from native
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    46
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    47
 */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    48
final class DCmdCheck extends AbstractDCmd {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    49
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    50
     * Execute JFR.check
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    51
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    52
     * @param recordingText name or id of the recording to check, or
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    53
     *        <code>null</code> to show a list of all recordings.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    54
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    55
     * @param verbose if event settings should be included.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    56
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    57
     * @return result output
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    58
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    59
     * @throws DCmdException if the check could not be completed.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    60
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    61
    public String execute(String recordingText, Boolean verbose) throws DCmdException {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    62
        executeInternal(recordingText, verbose);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    63
        return getResult();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    64
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    65
50745
a390cbb82d47 8203929: Limit amount of data for JFR.dump
egahlin
parents: 50226
diff changeset
    66
    private void executeInternal(String name, Boolean verbose) throws DCmdException {
52413
6372f5af9612 8209960: -Xlog:jfr* doesn't work with the JFR
egahlin
parents: 50887
diff changeset
    67
        if (Logger.shouldLog(LogTag.JFR_DCMD, LogLevel.DEBUG)) {
50745
a390cbb82d47 8203929: Limit amount of data for JFR.dump
egahlin
parents: 50226
diff changeset
    68
            Logger.log(LogTag.JFR_DCMD, LogLevel.DEBUG, "Executing DCmdCheck: name=" + name + ", verbose=" + verbose);
a390cbb82d47 8203929: Limit amount of data for JFR.dump
egahlin
parents: 50226
diff changeset
    69
        }
a390cbb82d47 8203929: Limit amount of data for JFR.dump
egahlin
parents: 50226
diff changeset
    70
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    71
        if (verbose == null) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    72
            verbose = Boolean.FALSE;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    73
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    74
50745
a390cbb82d47 8203929: Limit amount of data for JFR.dump
egahlin
parents: 50226
diff changeset
    75
        if (name != null) {
a390cbb82d47 8203929: Limit amount of data for JFR.dump
egahlin
parents: 50226
diff changeset
    76
            printRecording(findRecording(name), verbose);
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    77
            return;
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
        List<Recording> recordings = getRecordings();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    81
        if (!verbose && recordings.isEmpty()) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    82
            println("No available recordings.");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    83
            println();
50887
fa91003ec489 8137164: Include PID in the JFR jcmd hint
egahlin
parents: 50886
diff changeset
    84
            println("Use jcmd " + getPid() + " JFR.start to start a recording.");
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    85
            return;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    86
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    87
        boolean first = true;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    88
        for (Recording recording : recordings) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    89
            // Print separation between recordings,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    90
            if (!first) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    91
                println();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    92
                if (Boolean.TRUE.equals(verbose)) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    93
                    println();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    94
                }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    95
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    96
            first = false;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    97
            printRecording(recording, verbose);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    98
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    99
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   100
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   101
    private void printRecording(Recording recording, boolean verbose) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   102
        printGeneral(recording);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   103
        if (verbose) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   104
            println();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   105
            printSetttings(recording);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   106
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   107
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   108
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   109
    private void printGeneral(Recording recording) {
50226
408021edf22f 8195819: Remove recording=x from jcmd JFR.check output
egahlin
parents: 50113
diff changeset
   110
        print("Recording " + recording.getId() + ": name=" + recording.getName());
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   111
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   112
        Duration duration = recording.getDuration();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   113
        if (duration != null) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   114
            print(" duration=");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   115
            printTimespan(duration, "");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   116
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   117
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   118
        long maxSize = recording.getMaxSize();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   119
        if (maxSize != 0) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   120
            print(" maxsize=");
53013
c8b2a408628b 8215175: Inconsistencies in JFR event metadata
egahlin
parents: 52413
diff changeset
   121
            print(Utils.formatBytesCompact(maxSize));
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   122
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   123
        Duration maxAge = recording.getMaxAge();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   124
        if (maxAge != null) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   125
            print(" maxage=");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   126
            printTimespan(maxAge, "");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   127
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   128
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   129
        print(" (" + recording.getState().toString().toLowerCase() + ")");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   130
        println();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   131
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   132
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   133
    private void printSetttings(Recording recording) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   134
        Map<String, String> settings = recording.getSettings();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   135
        for (EventType eventType : sortByEventPath(getFlightRecorder().getEventTypes())) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   136
            StringJoiner sj = new StringJoiner(",", "[", "]");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   137
            sj.setEmptyValue("");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   138
            for (SettingDescriptor s : eventType.getSettingDescriptors()) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   139
                String settingsPath = eventType.getName() + "#" + s.getName();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   140
                if (settings.containsKey(settingsPath)) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   141
                    sj.add(s.getName() + "=" + settings.get(settingsPath));
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   142
                }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   143
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   144
            String settingsText = sj.toString();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   145
            if (!settingsText.isEmpty()) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   146
                print(" %s (%s)", eventType.getLabel(), eventType.getName());
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   147
                println();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   148
                println("   " + settingsText);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   149
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   150
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   151
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   152
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   153
    private static List<EventType> sortByEventPath(Collection<EventType> events) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   154
        List<EventType> sorted = new ArrayList<>();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   155
        sorted.addAll(events);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   156
        Collections.sort(sorted, new Comparator<EventType>() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   157
            @Override
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   158
            public int compare(EventType e1, EventType e2) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   159
                return e1.getName().compareTo(e2.getName());
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   160
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   161
        });
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   162
        return sorted;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   163
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   164
}