src/hotspot/share/jfr/dcmd/jfrDcmds.hpp
author egahlin
Tue, 15 May 2018 20:24:34 +0200
changeset 50113 caf115bb98ad
child 50745 a390cbb82d47
permissions -rw-r--r--
8199712: Flight Recorder Reviewed-by: coleenp, ihse, erikj, dsamersoff, mseledtsov, egahlin, mgronlun Contributed-by: erik.gahlin@oracle.com, markus.gronlund@oracle.com
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.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     8
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    13
 * accompanied this code).
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    14
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    18
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    21
 * questions.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    22
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    23
 */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    24
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    25
#ifndef SHARE_VM_JFR_JFRDCMDS_HPP
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    26
#define SHARE_VM_JFR_JFRDCMDS_HPP
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    27
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    28
#include "services/diagnosticCommand.hpp"
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    29
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    30
class JfrDumpFlightRecordingDCmd : public DCmdWithParser {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    31
 protected:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    32
  DCmdArgument<char*> _name;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    33
  DCmdArgument<char*> _filename;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    34
  DCmdArgument<bool>  _path_to_gc_roots;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    35
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    36
 public:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    37
  JfrDumpFlightRecordingDCmd(outputStream* output, bool heap);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    38
  static const char* name() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    39
    return "JFR.dump";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    40
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    41
  static const char* description() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    42
    return "Copies contents of a JFR recording to file. Either the name or the recording id must be specified.";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    43
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    44
  static const char* impact() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    45
    return "Low";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    46
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    47
  static const JavaPermission permission() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    48
    JavaPermission p = {"java.lang.management.ManagementPermission", "monitor", NULL};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    49
    return p;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    50
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    51
  static int num_arguments();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    52
  virtual void execute(DCmdSource source, TRAPS);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    53
};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    54
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    55
class JfrCheckFlightRecordingDCmd : public DCmdWithParser {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    56
 protected:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    57
  DCmdArgument<char*> _name;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    58
  DCmdArgument<bool>  _verbose;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    59
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    60
 public:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    61
  JfrCheckFlightRecordingDCmd(outputStream* output, bool heap);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    62
  static const char* name() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    63
    return "JFR.check";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    64
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    65
  static const char* description() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    66
    return "Checks running JFR recording(s)";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    67
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    68
  static const char* impact() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    69
    return "Low";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    70
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    71
  static const JavaPermission permission() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    72
    JavaPermission p = {"java.lang.management.ManagementPermission", "monitor", NULL};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    73
    return p;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    74
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    75
  static int num_arguments();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    76
  virtual void execute(DCmdSource source, TRAPS);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    77
};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    78
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    79
class JfrStartFlightRecordingDCmd : public DCmdWithParser {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    80
 protected:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    81
  DCmdArgument<char*> _name;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    82
  DCmdArgument<StringArrayArgument*> _settings;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    83
  DCmdArgument<NanoTimeArgument> _delay;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    84
  DCmdArgument<NanoTimeArgument> _duration;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    85
  DCmdArgument<bool> _disk;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    86
  DCmdArgument<char*> _filename;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    87
  DCmdArgument<NanoTimeArgument> _maxage;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    88
  DCmdArgument<MemorySizeArgument> _maxsize;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    89
  DCmdArgument<bool> _dump_on_exit;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    90
  DCmdArgument<bool> _path_to_gc_roots;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    91
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    92
 public:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    93
  JfrStartFlightRecordingDCmd(outputStream* output, bool heap);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    94
  static const char* name() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    95
    return "JFR.start";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    96
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    97
  static const char* description() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    98
    return "Starts a new JFR recording";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    99
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   100
  static const char* impact() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   101
    return "Medium: Depending on the settings for a recording, the impact can range from low to high.";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   102
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   103
  static const JavaPermission permission() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   104
    JavaPermission p = {"java.lang.management.ManagementPermission", "monitor", NULL};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   105
    return p;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   106
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   107
  static int num_arguments();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   108
  virtual void execute(DCmdSource source, TRAPS);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   109
};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   110
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   111
class JfrStopFlightRecordingDCmd : public DCmdWithParser {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   112
 protected:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   113
  DCmdArgument<char*> _name;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   114
  DCmdArgument<char*> _filename;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   115
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   116
 public:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   117
  JfrStopFlightRecordingDCmd(outputStream* output, bool heap);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   118
  static const char* name() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   119
    return "JFR.stop";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   120
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   121
  static const char* description() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   122
    return "Stops a JFR recording";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   123
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   124
  static const char* impact() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   125
    return "Low";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   126
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   127
  static const JavaPermission permission() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   128
    JavaPermission p = {"java.lang.management.ManagementPermission", "monitor", NULL};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   129
    return p;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   130
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   131
  static int num_arguments();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   132
  virtual void execute(DCmdSource source, TRAPS);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   133
};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   134
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   135
class JfrRuntimeOptions;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   136
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   137
class JfrConfigureFlightRecorderDCmd : public DCmdWithParser {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   138
  friend class JfrOptionSet;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   139
 protected:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   140
  DCmdArgument<char*> _repository_path;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   141
  DCmdArgument<char*> _dump_path;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   142
  DCmdArgument<jlong> _stack_depth;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   143
  DCmdArgument<jlong> _global_buffer_count;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   144
  DCmdArgument<jlong> _global_buffer_size;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   145
  DCmdArgument<jlong> _thread_buffer_size;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   146
  DCmdArgument<jlong> _memory_size;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   147
  DCmdArgument<jlong> _max_chunk_size;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   148
  DCmdArgument<bool>  _sample_threads;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   149
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   150
 public:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   151
  JfrConfigureFlightRecorderDCmd(outputStream* output, bool heap);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   152
  static const char* name() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   153
    return "JFR.configure";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   154
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   155
  static const char* description() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   156
    return "Configure JFR";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   157
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   158
  static const char* impact() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   159
    return "Low";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   160
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   161
  static const JavaPermission permission() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   162
    JavaPermission p = {"java.lang.management.ManagementPermission", "monitor", NULL};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   163
    return p;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   164
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   165
  static int num_arguments();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   166
  virtual void execute(DCmdSource source, TRAPS);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   167
};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   168
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   169
bool register_jfr_dcmds();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   170
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   171
#endif // SHARE_VM_JFR_JFRDCMDS_HPP