fparain@3329: /*
fparain@5047:  * Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved.
fparain@3329:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
fparain@3329:  *
fparain@3329:  * This code is free software; you can redistribute it and/or modify it
fparain@3329:  * under the terms of the GNU General Public License version 2 only, as
fparain@3329:  * published by the Free Software Foundation.
fparain@3329:  *
fparain@3329:  * This code is distributed in the hope that it will be useful, but WITHOUT
fparain@3329:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
fparain@3329:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
fparain@3329:  * version 2 for more details (a copy is included in the LICENSE file that
fparain@3329:  * accompanied this code).
fparain@3329:  *
fparain@3329:  * You should have received a copy of the GNU General Public License version
fparain@3329:  * 2 along with this work; if not, write to the Free Software Foundation,
fparain@3329:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
fparain@3329:  *
fparain@3329:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
fparain@3329:  * or visit www.oracle.com if you need additional information or have any
fparain@3329:  * questions.
fparain@3329:  *
fparain@3329:  */
fparain@3329: 
fparain@3329: #ifndef SHARE_VM_SERVICES_DIAGNOSTICFRAMEWORK_HPP
fparain@3329: #define SHARE_VM_SERVICES_DIAGNOSTICFRAMEWORK_HPP
fparain@3329: 
fparain@3329: #include "classfile/vmSymbols.hpp"
fparain@3329: #include "memory/allocation.hpp"
fparain@3329: #include "runtime/arguments.hpp"
fparain@3329: #include "runtime/os.hpp"
fparain@3329: #include "runtime/vm_version.hpp"
fparain@3329: #include "runtime/vmThread.hpp"
fparain@3329: #include "utilities/ostream.hpp"
fparain@3329: 
fparain@3329: 
fparain@5047: enum DCmdSource {
fparain@5047:   DCmd_Source_Internal  = 0x01U,  // invocation from the JVM
fparain@5047:   DCmd_Source_AttachAPI = 0x02U,  // invocation via the attachAPI
fparain@5047:   DCmd_Source_MBean     = 0x04U   // invocation via a MBean
fparain@5047: };
fparain@5047: 
fparain@5047: // Warning: strings referenced by the JavaPermission struct are passed to
fparain@5047: // the native part of the JDK. Avoid use of dynamically allocated strings
fparain@5047: // that could be de-allocated before the JDK native code had time to
fparain@5047: // convert them into Java Strings.
fparain@5047: struct JavaPermission {
fparain@5047:   const char* _class;
fparain@5047:   const char* _name;
fparain@5047:   const char* _action;
fparain@5047: };
fparain@5047: 
fparain@3329: // CmdLine is the class used to handle a command line containing a single
fparain@3329: // diagnostic command and its arguments. It provides methods to access the
fparain@3329: // command name and the beginning of the arguments. The class is also
fparain@3329: // able to identify commented command lines and the "stop" keyword
fparain@3329: class CmdLine : public StackObj {
fparain@3329: private:
fparain@3329:   const char* _cmd;
fparain@3329:   size_t      _cmd_len;
fparain@3329:   const char* _args;
fparain@3329:   size_t      _args_len;
fparain@3329: public:
fparain@3329:   CmdLine(const char* line, size_t len, bool no_command_name);
fparain@3329:   const char* args_addr() const { return _args; }
fparain@3329:   size_t args_len() const { return _args_len; }
fparain@3329:   const char* cmd_addr() const { return _cmd; }
fparain@3329:   size_t cmd_len() const { return _cmd_len; }
fparain@3329:   bool is_empty() { return _cmd_len == 0; }
fparain@3329:   bool is_executable() { return is_empty() || _cmd[0] != '#'; }
fparain@3329:   bool is_stop() { return !is_empty() && strncmp("stop", _cmd, _cmd_len) == 0; }
fparain@3329: };
fparain@3329: 
fparain@3329: // Iterator class taking a character string in input and returning a CmdLine
fparain@3329: // instance for each command line. The argument delimiter has to be specified.
fparain@3329: class DCmdIter : public StackObj {
fparain@3329:   friend class DCmd;
fparain@3329: private:
fparain@3329:   const char* _str;
fparain@3329:   char        _delim;
fparain@3329:   size_t      _len;
fparain@3329:   size_t      _cursor;
fparain@3329: public:
fparain@3329: 
fparain@3329:   DCmdIter(const char* str, char delim) {
fparain@3329:     _str = str;
fparain@3329:     _delim = delim;
fparain@3329:     _len = strlen(str);
fparain@3329:     _cursor = 0;
fparain@3329:   }
fparain@3329:   bool has_next() { return _cursor < _len; }
fparain@3329:   CmdLine next() {
fparain@3329:     assert(_cursor <= _len, "Cannot iterate more");
fparain@3329:     size_t n = _cursor;
fparain@3329:     while (n < _len && _str[n] != _delim) n++;
fparain@3329:     CmdLine line(&(_str[_cursor]), n - _cursor, false);
fparain@3329:     _cursor = n + 1;
fparain@3329:     // The default copy constructor of CmdLine is used to return a CmdLine
fparain@3329:     // instance to the caller.
fparain@3329:     return line;
fparain@3329:   }
fparain@3329: };
fparain@3329: 
fparain@3329: // Iterator class to iterate over diagnostic command arguments
fparain@3329: class DCmdArgIter : public ResourceObj {
fparain@3329:   const char* _buffer;
fparain@3329:   size_t      _len;
fparain@3329:   size_t      _cursor;
fparain@3329:   const char* _key_addr;
fparain@3329:   size_t      _key_len;
fparain@3329:   const char* _value_addr;
fparain@3329:   size_t      _value_len;
fparain@3329:   char        _delim;
fparain@3329: public:
fparain@3329:   DCmdArgIter(const char* buf, size_t len, char delim) {
fparain@3329:     _buffer = buf;
fparain@3329:     _len = len;
fparain@3329:     _delim = delim;
fparain@3329:     _cursor = 0;
fparain@3329:   }
fparain@3329:   bool next(TRAPS);
fparain@3329:   const char* key_addr() { return _key_addr; }
fparain@3329:   size_t key_length() { return _key_len; }
fparain@3329:   const char* value_addr() { return _value_addr; }
fparain@3329:   size_t value_length() { return _value_len; }
fparain@3329: };
fparain@3329: 
fparain@3329: // A DCmdInfo instance provides a description of a diagnostic command. It is
fparain@3329: // used to export the description to the JMX interface of the framework.
fparain@3329: class DCmdInfo : public ResourceObj {
fparain@3329: protected:
fparain@5047:   const char* _name;           /* Name of the diagnostic command */
fparain@5047:   const char* _description;    /* Short description */
fparain@5047:   const char* _impact;         /* Impact on the JVM */
fparain@5047:   JavaPermission _permission;  /* Java Permission required to execute this command if any */
fparain@5047:   int         _num_arguments;  /* Number of supported options or arguments */
fparain@5047:   bool        _is_enabled;     /* True if the diagnostic command can be invoked, false otherwise */
fparain@3329: public:
fparain@3329:   DCmdInfo(const char* name,
fparain@3329:           const char* description,
fparain@3329:           const char* impact,
fparain@5047:           JavaPermission permission,
fparain@3329:           int num_arguments,
fparain@3329:           bool enabled) {
fparain@3329:     this->_name = name;
fparain@3329:     this->_description = description;
fparain@3329:     this->_impact = impact;
fparain@5047:     this->_permission = permission;
fparain@3329:     this->_num_arguments = num_arguments;
fparain@3329:     this->_is_enabled = enabled;
fparain@3329:   }
fparain@3329:   const char* name() const { return _name; }
fparain@3329:   const char* description() const { return _description; }
fparain@3329:   const char* impact() const { return _impact; }
fparain@5047:   JavaPermission permission() const { return _permission; }
fparain@3329:   int num_arguments() const { return _num_arguments; }
fparain@3329:   bool is_enabled() const { return _is_enabled; }
fparain@3329: 
fparain@3329:   static bool by_name(void* name, DCmdInfo* info);
fparain@3329: };
fparain@3329: 
fparain@3329: // A DCmdArgumentInfo instance provides a description of a diagnostic command
fparain@3329: // argument. It is used to export the description to the JMX interface of the
fparain@3329: // framework.
fparain@3329: class DCmdArgumentInfo : public ResourceObj {
fparain@3329: protected:
fparain@5047:   const char* _name;            /* Option/Argument name*/
fparain@5047:   const char* _description;     /* Short description */
fparain@5047:   const char* _type;            /* Type: STRING, BOOLEAN, etc. */
fparain@5047:   const char* _default_string;  /* Default value in a parsable string */
fparain@5047:   bool        _mandatory;       /* True if the option/argument is mandatory */
fparain@5047:   bool        _option;          /* True if it is an option, false if it is an argument */
fparain@5047:                                 /* (see diagnosticFramework.hpp for option/argument definitions) */
fparain@5047:   bool        _multiple;        /* True is the option can be specified several time */
fparain@5047:   int         _position;        /* Expected position for this argument (this field is */
fparain@5047:                                 /* meaningless for options) */
fparain@3329: public:
fparain@3329:   DCmdArgumentInfo(const char* name, const char* description, const char* type,
fparain@5047:                    const char* default_string, bool mandatory, bool option,
fparain@5047:                    bool multiple) {
fparain@3329:     this->_name = name;
fparain@3329:     this->_description = description;
fparain@3329:     this->_type = type;
fparain@3329:     this->_default_string = default_string;
fparain@3329:     this->_option = option;
fparain@3329:     this->_mandatory = mandatory;
fparain@3329:     this->_option = option;
fparain@5047:     this->_multiple = multiple;
fparain@3329:     this->_position = -1;
fparain@3329:   }
fparain@3329:   DCmdArgumentInfo(const char* name, const char* description, const char* type,
fparain@3329:                    const char* default_string, bool mandatory, bool option,
fparain@5047:                    bool multiple, int position) {
fparain@3329:     this->_name = name;
fparain@3329:     this->_description = description;
fparain@3329:     this->_type = type;
fparain@3329:     this->_default_string = default_string;
fparain@3329:     this->_option = option;
fparain@3329:     this->_mandatory = mandatory;
fparain@3329:     this->_option = option;
fparain@5047:     this->_multiple = multiple;
fparain@3329:     this->_position = position;
fparain@3329:   }
fparain@3329:   const char* name() const { return _name; }
fparain@3329:   const char* description() const { return _description; }
fparain@3329:   const char* type() const { return _type; }
fparain@3329:   const char* default_string() const { return _default_string; }
fparain@3329:   bool is_mandatory() const { return _mandatory; }
fparain@3329:   bool is_option() const { return _option; }
fparain@5047:   bool is_multiple() const { return _multiple; }
fparain@3329:   int position() const { return _position; }
fparain@3329: };
fparain@3329: 
fparain@3329: // The DCmdParser class can be used to create an argument parser for a
fparain@3329: // diagnostic command. It is not mandatory to use it to parse arguments.
fparain@5047: // The DCmdParser parses a CmdLine instance according to the parameters that
fparain@5047: // have been declared by its associated diagnostic command. A parameter can
fparain@5047: // either be an option or an argument. Options are identified by the option name
fparain@5047: // while arguments are identified by their position in the command line. The
fparain@5047: // position of an argument is defined relative to all arguments passed on the
fparain@5047: // command line, options are not considered when defining an argument position.
fparain@5047: // The generic syntax of a diagnostic command is:
fparain@5047: //
fparain@5047: //    <command name> [<option>=<value>] [<argument_value>]
fparain@5047: //
fparain@5047: // Example:
fparain@5047: //
fparain@5047: //    command_name option1=value1 option2=value argumentA argumentB argumentC
fparain@5047: //
fparain@5047: // In this command line, the diagnostic command receives five parameters, two
fparain@5047: // options named option1 and option2, and three arguments. argumentA's position
fparain@5047: // is 0, argumentB's position is 1 and argumentC's position is 2.
fparain@3329: class DCmdParser {
fparain@3329: private:
fparain@3329:   GenDCmdArgument* _options;
fparain@3329:   GenDCmdArgument* _arguments_list;
fparain@3329:   char             _delim;
fparain@3329: public:
fparain@3329:   DCmdParser() {
fparain@3329:     _options = NULL;
fparain@3329:     _arguments_list = NULL;
fparain@3559:     _delim = ' ';
fparain@3329:   }
fparain@3329:   void add_dcmd_option(GenDCmdArgument* arg);
fparain@3329:   void add_dcmd_argument(GenDCmdArgument* arg);
fparain@3329:   GenDCmdArgument* lookup_dcmd_option(const char* name, size_t len);
fparain@3329:   GenDCmdArgument* arguments_list() { return _arguments_list; };
fparain@3329:   void check(TRAPS);
fparain@3329:   void parse(CmdLine* line, char delim, TRAPS);
fparain@3329:   void print_help(outputStream* out, const char* cmd_name);
fparain@3329:   void reset(TRAPS);
fparain@3329:   void cleanup();
fparain@3329:   int num_arguments();
fparain@3329:   GrowableArray<const char*>* argument_name_array();
fparain@3329:   GrowableArray<DCmdArgumentInfo*>* argument_info_array();
fparain@3329: };
fparain@3329: 
fparain@3329: // The DCmd class is the parent class of all diagnostic commands
fparain@3329: // Diagnostic command instances should not be instantiated directly but
fparain@3329: // created using the associated factory. The factory can be retrieved with
fparain@3329: // the DCmdFactory::getFactory() method.
fparain@3329: // A diagnostic command instance can either be allocated in the resource Area
fparain@3329: // or in the C-heap. Allocation in the resource area is recommended when the
fparain@3329: // current thread is the only one which will access the diagnostic command
fparain@3329: // instance. Allocation in the C-heap is required when the diagnostic command
fparain@3329: // is accessed by several threads (for instance to perform asynchronous
fparain@3329: // execution).
fparain@3329: // To ensure a proper cleanup, it's highly recommended to use a DCmdMark for
fparain@3329: // each diagnostic command instance. In case of a C-heap allocated diagnostic
fparain@3329: // command instance, the DCmdMark must be created in the context of the last
fparain@3329: // thread that will access the instance.
fparain@3329: class DCmd : public ResourceObj {
fparain@3329: protected:
fparain@3329:   outputStream* _output;
fparain@3329:   bool          _is_heap_allocated;
fparain@3329: public:
fparain@3329:   DCmd(outputStream* output, bool heap_allocated) {
fparain@3329:     _output = output;
fparain@3329:     _is_heap_allocated = heap_allocated;
fparain@3329:   }
fparain@3329: 
fparain@3329:   static const char* name() { return "No Name";}
fparain@3329:   static const char* description() { return "No Help";}
fparain@3329:   static const char* disabled_message() { return "Diagnostic command currently disabled"; }
sla@3905:   // The impact() method returns a description of the intrusiveness of the diagnostic
sla@3905:   // command on the Java Virtual Machine behavior. The rational for this method is that some
sla@3905:   // diagnostic commands can seriously disrupt the behavior of the Java Virtual Machine
sla@3905:   // (for instance a Thread Dump for an application with several tens of thousands of threads,
sla@3905:   // or a Head Dump with a 40GB+ heap size) and other diagnostic commands have no serious
sla@3905:   // impact on the JVM (for instance, getting the command line arguments or the JVM version).
sla@3905:   // The recommended format for the description is <impact level>: [longer description],
sla@3905:   // where the impact level is selected among this list: {Low, Medium, High}. The optional
sla@3905:   // longer description can provide more specific details like the fact that Thread Dump
sla@3905:   // impact depends on the heap size.
fparain@3329:   static const char* impact() { return "Low: No impact"; }
fparain@5047:   // The permission() method returns the description of Java Permission. This
fparain@5047:   // permission is required when the diagnostic command is invoked via the
fparain@5047:   // DiagnosticCommandMBean. The rationale for this permission check is that
fparain@5047:   // the DiagnosticCommandMBean can be used to perform remote invocations of
fparain@5047:   // diagnostic commands through the PlatformMBeanServer. The (optional) Java
fparain@5047:   // Permission associated with each diagnostic command should ease the work
fparain@5047:   // of system administrators to write policy files granting permissions to
fparain@5047:   // execute diagnostic commands to remote users. Any diagnostic command with
fparain@5047:   // a potential impact on security should overwrite this method.
fparain@5047:   static const JavaPermission permission() {
fparain@5047:     JavaPermission p = {NULL, NULL, NULL};
fparain@5047:     return p;
fparain@5047:   }
fparain@3329:   static int num_arguments() { return 0; }
fparain@3329:   outputStream* output() { return _output; }
fparain@3329:   bool is_heap_allocated()  { return _is_heap_allocated; }
fparain@3402:   virtual void print_help(const char* name) {
fparain@3402:     output()->print_cr("Syntax: %s", name);
fparain@3402:   }
fparain@3402:   virtual void parse(CmdLine* line, char delim, TRAPS) {
fparain@3402:     DCmdArgIter iter(line->args_addr(), line->args_len(), delim);
fparain@3402:     bool has_arg = iter.next(CHECK);
fparain@3402:     if (has_arg) {
fparain@3402:       THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
sla@3905:                 "The argument list of this diagnostic command should be empty.");
fparain@3402:     }
fparain@3402:   }
fparain@5047:   virtual void execute(DCmdSource source, TRAPS) { }
fparain@3329:   virtual void reset(TRAPS) { }
fparain@3329:   virtual void cleanup() { }
fparain@3329: 
fparain@3329:   // support for the JMX interface
fparain@3329:   virtual GrowableArray<const char*>* argument_name_array() {
fparain@3329:     GrowableArray<const char*>* array = new GrowableArray<const char*>(0);
fparain@3329:     return array;
fparain@3329:   }
fparain@3329:   virtual GrowableArray<DCmdArgumentInfo*>* argument_info_array() {
fparain@3329:     GrowableArray<DCmdArgumentInfo*>* array = new GrowableArray<DCmdArgumentInfo*>(0);
fparain@3329:     return array;
fparain@3329:   }
fparain@3329: 
fparain@3329:   // main method to invoke the framework
fparain@5047:   static void parse_and_execute(DCmdSource source, outputStream* out, const char* cmdline,
fparain@3329:                                 char delim, TRAPS);
fparain@3329: };
fparain@3329: 
fparain@3402: class DCmdWithParser : public DCmd {
fparain@3402: protected:
fparain@3402:   DCmdParser _dcmdparser;
fparain@3402: public:
fparain@3402:   DCmdWithParser (outputStream *output, bool heap=false) : DCmd(output, heap) { }
fparain@3402:   static const char* name() { return "No Name";}
fparain@3402:   static const char* description() { return "No Help";}
fparain@3402:   static const char* disabled_message() { return "Diagnostic command currently disabled"; }
fparain@3402:   static const char* impact() { return "Low: No impact"; }
fparain@5047:   static const JavaPermission permission() {JavaPermission p = {NULL, NULL, NULL}; return p; }
fparain@3402:   static int num_arguments() { return 0; }
fparain@3402:   virtual void parse(CmdLine *line, char delim, TRAPS);
fparain@5047:   virtual void execute(DCmdSource source, TRAPS) { }
fparain@3402:   virtual void reset(TRAPS);
fparain@3402:   virtual void cleanup();
fparain@3402:   virtual void print_help(const char* name);
fparain@3402:   virtual GrowableArray<const char*>* argument_name_array();
fparain@3402:   virtual GrowableArray<DCmdArgumentInfo*>* argument_info_array();
fparain@3402: };
fparain@3402: 
fparain@3329: class DCmdMark : public StackObj {
fparain@3329:   DCmd* _ref;
fparain@3329: public:
fparain@3329:   DCmdMark(DCmd* cmd) { _ref = cmd; }
fparain@3329:   ~DCmdMark() {
fparain@3329:     if (_ref != NULL) {
fparain@3329:       _ref->cleanup();
fparain@3329:       if (_ref->is_heap_allocated()) {
fparain@3329:         delete _ref;
fparain@3329:       }
fparain@3329:     }
fparain@3329:   }
fparain@3329: };
fparain@3329: 
fparain@3329: // Diagnostic commands are not directly instantiated but created with a factory.
fparain@3329: // Each diagnostic command class has its own factory. The DCmdFactory class also
fparain@3329: // manages the status of the diagnostic command (hidden, enabled). A DCmdFactory
fparain@3329: // has to be registered to make the diagnostic command available (see
fparain@3329: // management.cpp)
zgu@3900: class DCmdFactory: public CHeapObj<mtInternal> {
fparain@3329: private:
fparain@3329:   static Mutex*       _dcmdFactory_lock;
fparain@5047:   static bool         _send_jmx_notification;
fparain@5047:   static bool         _has_pending_jmx_notification;
fparain@3329:   // Pointer to the next factory in the singly-linked list of registered
fparain@3329:   // diagnostic commands
fparain@3329:   DCmdFactory*        _next;
fparain@3329:   // When disabled, a diagnostic command cannot be executed. Any attempt to
fparain@3329:   // execute it will result in the printing of the disabled message without
fparain@3329:   // instantiating the command.
fparain@3329:   bool                _enabled;
fparain@3329:   // When hidden, a diagnostic command doesn't appear in the list of commands
fparain@3329:   // provided by the 'help' command.
fparain@3329:   bool                _hidden;
fparain@5047:   uint32_t            _export_flags;
fparain@3329:   int                 _num_arguments;
fparain@3329:   static DCmdFactory* _DCmdFactoryList;
fparain@3329: public:
fparain@5047:   DCmdFactory(int num_arguments, uint32_t flags, bool enabled, bool hidden) {
fparain@3329:     _next = NULL;
fparain@3329:     _enabled = enabled;
fparain@3329:     _hidden = hidden;
fparain@5047:     _export_flags = flags;
fparain@3329:     _num_arguments = num_arguments;
fparain@3329:   }
fparain@3329:   bool is_enabled() const { return _enabled; }
fparain@3329:   void set_enabled(bool b) { _enabled = b; }
fparain@3329:   bool is_hidden() const { return _hidden; }
fparain@3329:   void set_hidden(bool b) { _hidden = b; }
fparain@5047:   uint32_t export_flags() { return _export_flags; }
fparain@5047:   void set_export_flags(uint32_t f) { _export_flags = f; }
fparain@3329:   int num_arguments() { return _num_arguments; }
fparain@3329:   DCmdFactory* next() { return _next; }
fparain@3329:   virtual DCmd* create_Cheap_instance(outputStream* output) = 0;
fparain@3329:   virtual DCmd* create_resource_instance(outputStream* output) = 0;
fparain@3329:   virtual const char* name() const = 0;
fparain@3329:   virtual const char* description() const = 0;
fparain@3329:   virtual const char* impact() const = 0;
fparain@5047:   virtual const JavaPermission permission() const = 0;
fparain@3329:   virtual const char* disabled_message() const = 0;
fparain@3329:   // Register a DCmdFactory to make a diagnostic command available.
fparain@3329:   // Once registered, a diagnostic command must not be unregistered.
fparain@3329:   // To prevent a diagnostic command from being executed, just set the
fparain@3329:   // enabled flag to false.
fparain@3329:   static int register_DCmdFactory(DCmdFactory* factory);
fparain@5047:   static DCmdFactory* factory(DCmdSource source, const char* cmd, size_t len);
fparain@3329:   // Returns a C-heap allocated diagnostic command for the given command line
fparain@5047:   static DCmd* create_global_DCmd(DCmdSource source, CmdLine &line, outputStream* out, TRAPS);
fparain@3329:   // Returns a resourceArea allocated diagnostic command for the given command line
fparain@5047:   static DCmd* create_local_DCmd(DCmdSource source, CmdLine &line, outputStream* out, TRAPS);
fparain@5047:   static GrowableArray<const char*>* DCmd_list(DCmdSource source);
fparain@5047:   static GrowableArray<DCmdInfo*>* DCmdInfo_list(DCmdSource source);
fparain@5047: 
fparain@5047:   static void set_jmx_notification_enabled(bool enabled) {
fparain@5047:     _send_jmx_notification = enabled;
fparain@5047:   }
fparain@5047:   static void push_jmx_notification_request();
fparain@5047:   static bool has_pending_jmx_notification() { return _has_pending_jmx_notification; }
fparain@5047:   static void send_notification(TRAPS);
fparain@5047: private:
fparain@5047:   static void send_notification_internal(TRAPS);
fparain@3329: 
fparain@3329:   friend class HelpDCmd;
fparain@3329: };
fparain@3329: 
fparain@3329: // Template to easily create DCmdFactory instances. See management.cpp
fparain@3329: // where this template is used to create and register factories.
fparain@3329: template <class DCmdClass> class DCmdFactoryImpl : public DCmdFactory {
fparain@3329: public:
fparain@5047:   DCmdFactoryImpl(uint32_t flags, bool enabled, bool hidden) :
fparain@5047:     DCmdFactory(DCmdClass::num_arguments(), flags, enabled, hidden) { }
fparain@3329:   // Returns a C-heap allocated instance
fparain@3329:   virtual DCmd* create_Cheap_instance(outputStream* output) {
zgu@3900:     return new (ResourceObj::C_HEAP, mtInternal) DCmdClass(output, true);
fparain@3329:   }
fparain@3329:   // Returns a resourceArea allocated instance
fparain@3329:   virtual DCmd* create_resource_instance(outputStream* output) {
fparain@3329:     return new DCmdClass(output, false);
fparain@3329:   }
fparain@3329:   virtual const char* name() const {
fparain@3329:     return DCmdClass::name();
fparain@3329:   }
fparain@3329:   virtual const char* description() const {
fparain@3329:     return DCmdClass::description();
fparain@3329:   }
fparain@3329:   virtual const char* impact() const {
fparain@3329:     return DCmdClass::impact();
fparain@3329:   }
fparain@5047:   virtual const JavaPermission permission() const {
fparain@5047:     return DCmdClass::permission();
fparain@5047:   }
fparain@3329:   virtual const char* disabled_message() const {
fparain@3329:      return DCmdClass::disabled_message();
fparain@3329:   }
fparain@3329: };
fparain@3329: 
dsamersoff@3478: // This class provides a convenient way to register Dcmds, without a need to change
dsamersoff@3478: // management.cpp every time. Body of these two methods resides in
dsamersoff@3478: // diagnosticCommand.cpp
dsamersoff@3478: 
dsamersoff@3478: class DCmdRegistrant : public AllStatic {
dsamersoff@3478: 
dsamersoff@3478: private:
dsamersoff@3478:     static void register_dcmds();
dsamersoff@3478:     static void register_dcmds_ext();
dsamersoff@3478: 
dsamersoff@3478:     friend class Management;
dsamersoff@3478: };
dsamersoff@3478: 
fparain@3329: #endif // SHARE_VM_SERVICES_DIAGNOSTICFRAMEWORK_HPP