src/hotspot/share/jfr/dcmd/jfrDcmds.hpp
author mgronlun
Wed, 30 Oct 2019 19:43:52 +0100
changeset 58863 c16ac7a2eba4
parent 53244 9807daeb47c4
permissions -rw-r--r--
8226511: Implement JFR Event Streaming Reviewed-by: egahlin, mseledtsov, mgronlun Contributed-by: erik.gahlin@oracle.com, mikhailo.seledtsov@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
/*
53244
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 52669
diff changeset
     2
 * Copyright (c) 2012, 2019, Oracle and/or its affiliates. All rights reserved.
50113
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
53244
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 52669
diff changeset
    25
#ifndef SHARE_JFR_DCMD_JFRDCMDS_HPP
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 52669
diff changeset
    26
#define SHARE_JFR_DCMD_JFRDCMDS_HPP
50113
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;
50745
a390cbb82d47 8203929: Limit amount of data for JFR.dump
egahlin
parents: 50113
diff changeset
    34
  DCmdArgument<NanoTimeArgument> _maxage;
a390cbb82d47 8203929: Limit amount of data for JFR.dump
egahlin
parents: 50113
diff changeset
    35
  DCmdArgument<MemorySizeArgument> _maxsize;
a390cbb82d47 8203929: Limit amount of data for JFR.dump
egahlin
parents: 50113
diff changeset
    36
  DCmdArgument<char*> _begin;
a390cbb82d47 8203929: Limit amount of data for JFR.dump
egahlin
parents: 50113
diff changeset
    37
  DCmdArgument<char*> _end;
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    38
  DCmdArgument<bool>  _path_to_gc_roots;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    39
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    40
 public:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    41
  JfrDumpFlightRecordingDCmd(outputStream* output, bool heap);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    42
  static const char* name() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    43
    return "JFR.dump";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    44
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    45
  static const char* description() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    46
    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
    47
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    48
  static const char* impact() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    49
    return "Low";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    50
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    51
  static const JavaPermission permission() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    52
    JavaPermission p = {"java.lang.management.ManagementPermission", "monitor", NULL};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    53
    return p;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    54
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    55
  static int num_arguments();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    56
  virtual void execute(DCmdSource source, TRAPS);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    57
};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    58
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    59
class JfrCheckFlightRecordingDCmd : public DCmdWithParser {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    60
 protected:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    61
  DCmdArgument<char*> _name;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    62
  DCmdArgument<bool>  _verbose;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    63
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    64
 public:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    65
  JfrCheckFlightRecordingDCmd(outputStream* output, bool heap);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    66
  static const char* name() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    67
    return "JFR.check";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    68
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    69
  static const char* description() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    70
    return "Checks running JFR recording(s)";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    71
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    72
  static const char* impact() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    73
    return "Low";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    74
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    75
  static const JavaPermission permission() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    76
    JavaPermission p = {"java.lang.management.ManagementPermission", "monitor", NULL};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    77
    return p;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    78
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    79
  static int num_arguments();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    80
  virtual void execute(DCmdSource source, TRAPS);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    81
};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    82
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    83
class JfrStartFlightRecordingDCmd : public DCmdWithParser {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    84
 protected:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    85
  DCmdArgument<char*> _name;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    86
  DCmdArgument<StringArrayArgument*> _settings;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    87
  DCmdArgument<NanoTimeArgument> _delay;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    88
  DCmdArgument<NanoTimeArgument> _duration;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    89
  DCmdArgument<bool> _disk;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    90
  DCmdArgument<char*> _filename;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    91
  DCmdArgument<NanoTimeArgument> _maxage;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    92
  DCmdArgument<MemorySizeArgument> _maxsize;
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 53244
diff changeset
    93
  DCmdArgument<NanoTimeArgument> _flush_interval;
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    94
  DCmdArgument<bool> _dump_on_exit;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    95
  DCmdArgument<bool> _path_to_gc_roots;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    96
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    97
 public:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    98
  JfrStartFlightRecordingDCmd(outputStream* output, bool heap);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    99
  static const char* name() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   100
    return "JFR.start";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   101
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   102
  static const char* description() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   103
    return "Starts a new JFR recording";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   104
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   105
  static const char* impact() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   106
    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
   107
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   108
  static const JavaPermission permission() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   109
    JavaPermission p = {"java.lang.management.ManagementPermission", "monitor", NULL};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   110
    return p;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   111
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   112
  static int num_arguments();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   113
  virtual void execute(DCmdSource source, TRAPS);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   114
};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   115
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   116
class JfrStopFlightRecordingDCmd : public DCmdWithParser {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   117
 protected:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   118
  DCmdArgument<char*> _name;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   119
  DCmdArgument<char*> _filename;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   120
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   121
 public:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   122
  JfrStopFlightRecordingDCmd(outputStream* output, bool heap);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   123
  static const char* name() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   124
    return "JFR.stop";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   125
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   126
  static const char* description() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   127
    return "Stops a JFR recording";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   128
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   129
  static const char* impact() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   130
    return "Low";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   131
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   132
  static const JavaPermission permission() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   133
    JavaPermission p = {"java.lang.management.ManagementPermission", "monitor", NULL};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   134
    return p;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   135
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   136
  static int num_arguments();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   137
  virtual void execute(DCmdSource source, TRAPS);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   138
};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   139
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   140
class JfrRuntimeOptions;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   141
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   142
class JfrConfigureFlightRecorderDCmd : public DCmdWithParser {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   143
  friend class JfrOptionSet;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   144
 protected:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   145
  DCmdArgument<char*> _repository_path;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   146
  DCmdArgument<char*> _dump_path;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   147
  DCmdArgument<jlong> _stack_depth;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   148
  DCmdArgument<jlong> _global_buffer_count;
52669
e21361bccfa1 8213015: Inconsistent settings between JFR.configure and -XX:FlightRecorderOptions
ysuenaga
parents: 50745
diff changeset
   149
  DCmdArgument<MemorySizeArgument> _global_buffer_size;
e21361bccfa1 8213015: Inconsistent settings between JFR.configure and -XX:FlightRecorderOptions
ysuenaga
parents: 50745
diff changeset
   150
  DCmdArgument<MemorySizeArgument> _thread_buffer_size;
e21361bccfa1 8213015: Inconsistent settings between JFR.configure and -XX:FlightRecorderOptions
ysuenaga
parents: 50745
diff changeset
   151
  DCmdArgument<MemorySizeArgument> _memory_size;
e21361bccfa1 8213015: Inconsistent settings between JFR.configure and -XX:FlightRecorderOptions
ysuenaga
parents: 50745
diff changeset
   152
  DCmdArgument<MemorySizeArgument> _max_chunk_size;
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   153
  DCmdArgument<bool>  _sample_threads;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   154
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   155
 public:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   156
  JfrConfigureFlightRecorderDCmd(outputStream* output, bool heap);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   157
  static const char* name() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   158
    return "JFR.configure";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   159
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   160
  static const char* description() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   161
    return "Configure JFR";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   162
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   163
  static const char* impact() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   164
    return "Low";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   165
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   166
  static const JavaPermission permission() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   167
    JavaPermission p = {"java.lang.management.ManagementPermission", "monitor", NULL};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   168
    return p;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   169
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   170
  static int num_arguments();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   171
  virtual void execute(DCmdSource source, TRAPS);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   172
};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   173
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   174
bool register_jfr_dcmds();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   175
53244
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 52669
diff changeset
   176
#endif // SHARE_JFR_DCMD_JFRDCMDS_HPP