8265271: JFR: Allow use of .jfc options when starting JFR

Reviewed-by: mgronlun

Author: egahlin

src/hotspot/share/jfr/dcmd/jfrDcmds.cpp

@@ -26,48 +26,56 @@
 #define SHARE_JFR_DCMD_JFRDCMDS_HPP
 
 #include "services/diagnosticCommand.hpp"
+class JfrJavaArguments;
 
-class JfrDumpFlightRecordingDCmd : public DCmdWithParser {
+class JfrDCmd : public DCmd {
+ private:
+  const char* _args;
+  char _delimiter;
+ public:
+  JfrDCmd(outputStream* output, bool heap) : DCmd(output,heap), _args(NULL), _delimiter('\0')  {}
+
+  virtual void execute(DCmdSource source, TRAPS);
+  virtual void print_help(const char* name) const;
+  virtual GrowableArray<const char*>* argument_name_array() const;
+  virtual GrowableArray<DCmdArgumentInfo*>* argument_info_array() const;
+  virtual void parse(CmdLine* line, char delim, TRAPS);
  protected:
-  DCmdArgument<char*> _name;
-  DCmdArgument<char*> _filename;
-  DCmdArgument<NanoTimeArgument> _maxage;
-  DCmdArgument<MemorySizeArgument> _maxsize;
-  DCmdArgument<char*> _begin;
-  DCmdArgument<char*> _end;
-  DCmdArgument<bool>  _path_to_gc_roots;
+  virtual const char* javaClass() const = 0;
+  void invoke(JfrJavaArguments& method, TRAPS) const;
+};
 
+class JfrStartFlightRecordingDCmd : public JfrDCmd {
  public:
-  JfrDumpFlightRecordingDCmd(outputStream* output, bool heap);
+  JfrStartFlightRecordingDCmd(outputStream* output, bool heap) : JfrDCmd(output, heap) {}
+
   static const char* name() {
-    return "JFR.dump";
+    return "JFR.start";
   }
   static const char* description() {
-    return "Copies contents of a JFR recording to file. Either the name or the recording id must be specified.";
+    return "Starts a new JFR recording";
   }
   static const char* impact() {
-    return "Low";
+    return "Medium: Depending on the settings for a recording, the impact can range from low to high.";
   }
   static const JavaPermission permission() {
     JavaPermission p = {"java.lang.management.ManagementPermission", "monitor", NULL};
     return p;
   }
-  static int num_arguments();
-  virtual void execute(DCmdSource source, TRAPS);
+  virtual const char* javaClass() const {
+    return "jdk/jfr/internal/dcmd/DCmdStart";
+  }
 };
 
-class JfrCheckFlightRecordingDCmd : public DCmdWithParser {
- protected:
-  DCmdArgument<char*> _name;
-  DCmdArgument<bool>  _verbose;
-
+class JfrDumpFlightRecordingDCmd : public JfrDCmd {
  public:
-  JfrCheckFlightRecordingDCmd(outputStream* output, bool heap);
+  JfrDumpFlightRecordingDCmd(outputStream* output, bool heap) : JfrDCmd(output, heap) {}
+
   static const char* name() {
-    return "JFR.check";
+    return "JFR.dump";
   }
   static const char* description() {
-    return "Checks running JFR recording(s)";
+    return "Copies contents of a JFR recording to file. Either the name or the recording id must be specified.";
   }
   static const char* impact() {
     return "Low";
@@ -76,50 +84,37 @@ class JfrCheckFlightRecordingDCmd : public DCmdWithParser {
     JavaPermission p = {"java.lang.management.ManagementPermission", "monitor", NULL};
     return p;
   }
-  static int num_arguments();
-  virtual void execute(DCmdSource source, TRAPS);
+  virtual const char* javaClass() const {
+    return "jdk/jfr/internal/dcmd/DCmdDump";
+  }
 };
 
-class JfrStartFlightRecordingDCmd : public DCmdWithParser {
- protected:
-  DCmdArgument<char*> _name;
-  DCmdArgument<StringArrayArgument*> _settings;
-  DCmdArgument<NanoTimeArgument> _delay;
-  DCmdArgument<NanoTimeArgument> _duration;
-  DCmdArgument<bool> _disk;
-  DCmdArgument<char*> _filename;
-  DCmdArgument<NanoTimeArgument> _maxage;
-  DCmdArgument<MemorySizeArgument> _maxsize;
-  DCmdArgument<NanoTimeArgument> _flush_interval;
-  DCmdArgument<bool> _dump_on_exit;
-  DCmdArgument<bool> _path_to_gc_roots;
-
+class JfrCheckFlightRecordingDCmd : public JfrDCmd {
  public:
-  JfrStartFlightRecordingDCmd(outputStream* output, bool heap);
+  JfrCheckFlightRecordingDCmd(outputStream* output, bool heap) : JfrDCmd(output, heap) {}
+
   static const char* name() {
-    return "JFR.start";
+    return "JFR.check";
   }
   static const char* description() {
-    return "Starts a new JFR recording";
+    return "Checks running JFR recording(s)";
   }
   static const char* impact() {
-    return "Medium: Depending on the settings for a recording, the impact can range from low to high.";
+    return "Low";
   }
   static const JavaPermission permission() {
     JavaPermission p = {"java.lang.management.ManagementPermission", "monitor", NULL};
     return p;
   }
-  static int num_arguments();
-  virtual void execute(DCmdSource source, TRAPS);
+  virtual const char* javaClass() const {
+    return "jdk/jfr/internal/dcmd/DCmdCheck";
+  }
 };
 
-class JfrStopFlightRecordingDCmd : public DCmdWithParser {
- protected:
-  DCmdArgument<char*> _name;
-  DCmdArgument<char*> _filename;
-
+class JfrStopFlightRecordingDCmd : public JfrDCmd {
  public:
-  JfrStopFlightRecordingDCmd(outputStream* output, bool heap);
+  JfrStopFlightRecordingDCmd(outputStream* output, bool heap) : JfrDCmd(output, heap) {}
+
   static const char* name() {
     return "JFR.stop";
   }
@@ -133,12 +128,11 @@ class JfrStopFlightRecordingDCmd : public DCmdWithParser {
     JavaPermission p = {"java.lang.management.ManagementPermission", "monitor", NULL};
     return p;
   }
-  static int num_arguments();
-  virtual void execute(DCmdSource source, TRAPS);
+  virtual const char* javaClass() const {
+    return "jdk/jfr/internal/dcmd/DCmdStop";
+  }
 };
 
-class JfrRuntimeOptions;
-
 class JfrConfigureFlightRecorderDCmd : public DCmdWithParser {
   friend class JfrOptionSet;
  protected:
@@ -173,8 +167,10 @@ class JfrConfigureFlightRecorderDCmd : public DCmdWithParser {
   }
   static int num_arguments();
   virtual void execute(DCmdSource source, TRAPS);
+  virtual void print_help(const char* name) const;
 };
 
+
 bool register_jfr_dcmds();
 
 #endif // SHARE_JFR_DCMD_JFRDCMDS_HPP

src/hotspot/share/jfr/dcmd/jfrDcmds.hpp

@@ -487,28 +487,30 @@ Klass* JfrJavaSupport::klass(const jobject handle) {
   return obj->klass();
 }
 
-// caller needs ResourceMark
-const char* JfrJavaSupport::c_str(oop string, JavaThread* t) {
+static char* allocate_string(bool c_heap, int length, JavaThread* jt) {
+  return c_heap ? NEW_C_HEAP_ARRAY(char, length, mtTracing) :
+                  NEW_RESOURCE_ARRAY_IN_THREAD(jt, char, length);
+}
+
+const char* JfrJavaSupport::c_str(oop string, JavaThread* t, bool c_heap /* false */) {
   DEBUG_ONLY(check_java_thread_in_vm(t));
-  char* resource_copy = NULL;
+  char* str = NULL;
   const typeArrayOop value = java_lang_String::value(string);
   if (value != NULL) {
     const int length = java_lang_String::utf8_length(string, value);
-    resource_copy = NEW_RESOURCE_ARRAY_IN_THREAD(t, char, (length + 1));
-    if (resource_copy == NULL) {
-      JfrJavaSupport::throw_out_of_memory_error("Unable to allocate thread local native memory", t);
+    str = allocate_string(c_heap, length + 1, t);
+    if (str == NULL) {
+      JfrJavaSupport::throw_out_of_memory_error("Unable to allocate native memory", t);
       return NULL;
     }
-    assert(resource_copy != NULL, "invariant");
-    java_lang_String::as_utf8_string(string, value, resource_copy, length + 1);
+    java_lang_String::as_utf8_string(string, value, str, length + 1);
   }
-  return resource_copy;
+  return str;
 }
 
-// caller needs ResourceMark
-const char* JfrJavaSupport::c_str(jstring string, JavaThread* t) {
+const char* JfrJavaSupport::c_str(jstring string, JavaThread* t, bool c_heap /* false */) {
   DEBUG_ONLY(check_java_thread_in_vm(t));
-  return string != NULL ? c_str(resolve_non_null(string), t) : NULL;
+  return string != NULL ? c_str(resolve_non_null(string), t, c_heap) : NULL;
 }
 
 /*

src/hotspot/share/jfr/jni/jfrJavaSupport.cpp

@@ -75,9 +75,8 @@ class JfrJavaSupport : public AllStatic {
 
   // misc
   static Klass* klass(const jobject handle);
-  // caller needs ResourceMark
-  static const char* c_str(jstring string, JavaThread* jt);
-  static const char* c_str(oop string, JavaThread* t);
+  static const char* c_str(jstring string, JavaThread* jt, bool c_heap = false);
+  static const char* c_str(oop string, JavaThread* jt, bool c_heap = false);
 
   // exceptions
   static void throw_illegal_state_exception(const char* message, TRAPS);

src/hotspot/share/jfr/jni/jfrJavaSupport.hpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -58,7 +58,8 @@
   JFR_LOG_TAG(jfr, metadata) \
   JFR_LOG_TAG(jfr, event) \
   JFR_LOG_TAG(jfr, setting) \
-  JFR_LOG_TAG(jfr, dcmd)
+  JFR_LOG_TAG(jfr, dcmd) \
+  JFR_LOG_TAG(jfr, start)
   /* NEW TAGS, DONT FORGET TO UPDATE JAVA SIDE */
 
 #endif // SHARE_JFR_UTILITIES_JFRLOGTAGSETS_HPP

src/hotspot/share/jfr/utilities/jfrLogTagSets.hpp

@@ -1757,6 +1757,22 @@ is needed.
 .PP
 You can specify values for multiple parameters by separating them with a
 comma.
+.PP
+Event settings and .jfc options can also be specified using the following
+syntax:
+.TP
+.B \f[CB]option=\f[R]\f[I]value\f[R]
+Specifies the option value to modify. To list available options, use the 
+JAVA_HOME/bin/jfr tool.
+.TP
+.B \f[CB]event-setting=\f[R]\f[I]value\f[R]
+Specifies the event setting value to modify. Use the form:
+<event-name>#<setting-name>=<value>
+To add a new event setting, prefix the event name with '+'.
+.PP
+In case of a conflict between a parameter and a .jfc option, the parameter
+will take precedence. The whitespace delimiter can be omitted for timespan values, i.e. 20ms. For
+more information about the settings syntax, see Javadoc of the jdk.jfr package.
 .RE
 .TP
 .B \f[CB]\-XX:ThreadStackSize=\f[R]\f[I]size\f[R]

src/java.base/share/man/java.1

@@ -562,6 +562,22 @@ is needed.
 Use \f[CB]none\f[R] to start a recording without a predefined
 configuration file.
 (STRING, \f[CB]JAVA\-HOME\f[R]/lib/jfr/default.jfc)
+.PP
+Event settings and .jfc options can also be specified using the following
+syntax:
+.TP
+.B \f[CB]option=\f[R]\f[I]value\f[R]
+Specifies the option value to modify. To list available options, use the
+JAVA_HOME/bin/jfr tool.
+.TP
+.B \f[CB]event-setting=\f[R]\f[I]value\f[R]
+Specifies the event setting value to modify. Use the form:
+<event-name>#<setting-name>=<value>
+To add a new event setting, prefix the event name with '+'.
+.PP
+In case of a conflict between a parameter and a .jfc option, the parameter
+will take precedence. The whitespace delimiter can be omitted for timespan values, i.e. 20ms. For
+more information about the settings syntax, see Javadoc of the jdk.jfr package.
 .RE
 .TP
 .B \f[CB]JFR.stop\f[R] [\f[I]options\f[R]]

src/jdk.jcmd/share/man/jcmd.1

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -85,7 +85,11 @@ public enum LogTag {
     /**
      * Covers usage of jcmd with JFR
      */
-    JFR_DCMD(12);
+    JFR_DCMD(12),
+    /**
+     * -XX:StartFlightRecording
+     */
+    JFR_START(13);
 
     /* set from native side */
     volatile int tagSetLevel = 100; // prevent logging if JVM log system has not been initialized