src/jdk.jfr/share/classes/jdk/jfr/internal/tool/Main.java
author egahlin
Wed, 05 Dec 2018 16:40:12 +0100
changeset 52850 f527b24990d7
child 52888 9607fb16ccfe
permissions -rw-r--r--
8205516: JFR tool Reviewed-by: mgronlun
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
52850
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
     1
/*
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
     2
 * Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
     4
 *
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    10
 *
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    15
 * accompanied this code).
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    16
 *
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    20
 *
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    23
 * questions.
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    24
 */
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    25
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    26
package jdk.jfr.internal.tool;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    27
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    28
import java.util.Arrays;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    29
import java.util.Deque;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    30
import java.util.LinkedList;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    31
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    32
/**
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    33
 * Launcher class for the JDK_HOME\bin\jfr tool
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    34
 *
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    35
 */
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    36
public final class Main {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    37
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    38
    private static final int EXIT_OK = 0;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    39
    private static final int EXIT_FAILED = 1;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    40
    private static final int EXIT_WRONG_ARGUMENTS = 2;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    41
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    42
    public static void main(String... args) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    43
        Deque<String> argList = new LinkedList<>(Arrays.asList(args));
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    44
        if (argList.isEmpty()) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    45
            System.out.println(Command.title);
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    46
            System.out.println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    47
            System.out.println("Before using this tool, you must have a recording file.");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    48
            System.out.println("A file can be created by starting a recording from command line:");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    49
            System.out.println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    50
            System.out.println(" java -XX:StartFlightRecording:filename=recording.jfr,duration=30s ... ");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    51
            System.out.println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    52
            System.out.println("A recording can also be started on already running Java Virtual Machine:");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    53
            System.out.println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    54
            System.out.println(" jcmd (to list available pids)");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    55
            System.out.println(" jcmd <pid> JFR.start");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    56
            System.out.println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    57
            System.out.println("Recording data can be dumped to file using the JFR.dump command:");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    58
            System.out.println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    59
            System.out.println(" jcmd <pid> JFR.dump filename=recording.jfr");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    60
            System.out.println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    61
            System.out.println("The contents of the recording can then be printed, for example:");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    62
            System.out.println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    63
            System.out.println(" jfr print recording.jfr");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    64
            System.out.println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    65
            System.out.println(" jfr print --events CPULoad,GarbageCollection recording.jfr");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    66
            System.out.println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    67
            System.out.println(" jfr print --json --events CPULoad recording.jfr");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    68
            System.out.println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    69
            System.out.println(" jfr print --categories \"GC,JVM,Java*\" recording.jfr");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    70
            System.out.println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    71
            System.out.println(" jfr print --events \"jdk.*\" --stack-depth 64 recording.jfr");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    72
            System.out.println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    73
            System.out.println(" jfr summary recording.jfr");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    74
            System.out.println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    75
            System.out.println(" jfr metadata recoding.jfr");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    76
            System.out.println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    77
            System.out.println("For more information about available commands, use 'jfr help'");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    78
            System.exit(EXIT_OK);
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    79
        }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    80
        String command = argList.remove();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    81
        for (Command c : Command.getCommands()) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    82
            if (c.matches(command)) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    83
                try {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    84
                    c.execute(argList);
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    85
                    System.exit(EXIT_OK);
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    86
                } catch (UserDataException ude) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    87
                    System.err.println("jfr " + c.getName() + ": " + ude.getMessage());
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    88
                    System.exit(EXIT_FAILED);
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    89
                } catch (UserSyntaxException use) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    90
                    System.err.println("jfr " + c.getName() + ": " + use.getMessage());
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    91
                    System.err.println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    92
                    System.err.println("Usage:");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    93
                    System.err.println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    94
                    c.displayUsage(System.err);
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    95
                    System.exit(EXIT_WRONG_ARGUMENTS);
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    96
                } catch (Throwable e) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    97
                    System.err.println("jfr " + c.getName() + ": unexpected internal error, " + e.getMessage());
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    98
                    e.printStackTrace();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    99
                    System.exit(EXIT_FAILED);
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   100
                }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   101
            }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   102
        }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   103
        System.err.println("jfr: unknown command '" + command + "'");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   104
        System.err.println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   105
        System.err.println("List of available commands:");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   106
        System.err.println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   107
        Command.displayAvailableCommands(System.err);
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   108
        System.exit(EXIT_WRONG_ARGUMENTS);
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   109
    }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   110
}