Mercurial > hg > graal-jvmci-8
diff src/share/vm/services/diagnosticFramework.hpp @ 10215:31a4e55f8c9d
8004095: Add support for JMX interface to Diagnostic Framework and Commands
Reviewed-by: acorn, sla
author | fparain |
---|---|
date | Fri, 03 May 2013 05:05:31 -0700 |
parents | 5a1f452f8f90 |
children |
line wrap: on
line diff
--- a/src/share/vm/services/diagnosticFramework.hpp Wed May 01 09:00:39 2013 -0700 +++ b/src/share/vm/services/diagnosticFramework.hpp Fri May 03 05:05:31 2013 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2011, 2013, 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 @@ -34,6 +34,22 @@ #include "utilities/ostream.hpp" +enum DCmdSource { + DCmd_Source_Internal = 0x01U, // invocation from the JVM + DCmd_Source_AttachAPI = 0x02U, // invocation via the attachAPI + DCmd_Source_MBean = 0x04U // invocation via a MBean +}; + +// Warning: strings referenced by the JavaPermission struct are passed to +// the native part of the JDK. Avoid use of dynamically allocated strings +// that could be de-allocated before the JDK native code had time to +// convert them into Java Strings. +struct JavaPermission { + const char* _class; + const char* _name; + const char* _action; +}; + // CmdLine is the class used to handle a command line containing a single // diagnostic command and its arguments. It provides methods to access the // command name and the beginning of the arguments. The class is also @@ -113,26 +129,30 @@ // used to export the description to the JMX interface of the framework. class DCmdInfo : public ResourceObj { protected: - const char* _name; - const char* _description; - const char* _impact; - int _num_arguments; - bool _is_enabled; + const char* _name; /* Name of the diagnostic command */ + const char* _description; /* Short description */ + const char* _impact; /* Impact on the JVM */ + JavaPermission _permission; /* Java Permission required to execute this command if any */ + int _num_arguments; /* Number of supported options or arguments */ + bool _is_enabled; /* True if the diagnostic command can be invoked, false otherwise */ public: DCmdInfo(const char* name, const char* description, const char* impact, + JavaPermission permission, int num_arguments, bool enabled) { this->_name = name; this->_description = description; this->_impact = impact; + this->_permission = permission; this->_num_arguments = num_arguments; this->_is_enabled = enabled; } const char* name() const { return _name; } const char* description() const { return _description; } const char* impact() const { return _impact; } + JavaPermission permission() const { return _permission; } int num_arguments() const { return _num_arguments; } bool is_enabled() const { return _is_enabled; } @@ -144,16 +164,20 @@ // framework. class DCmdArgumentInfo : public ResourceObj { protected: - const char* _name; - const char* _description; - const char* _type; - const char* _default_string; - bool _mandatory; - bool _option; - int _position; + const char* _name; /* Option/Argument name*/ + const char* _description; /* Short description */ + const char* _type; /* Type: STRING, BOOLEAN, etc. */ + const char* _default_string; /* Default value in a parsable string */ + bool _mandatory; /* True if the option/argument is mandatory */ + bool _option; /* True if it is an option, false if it is an argument */ + /* (see diagnosticFramework.hpp for option/argument definitions) */ + bool _multiple; /* True is the option can be specified several time */ + int _position; /* Expected position for this argument (this field is */ + /* meaningless for options) */ public: DCmdArgumentInfo(const char* name, const char* description, const char* type, - const char* default_string, bool mandatory, bool option) { + const char* default_string, bool mandatory, bool option, + bool multiple) { this->_name = name; this->_description = description; this->_type = type; @@ -161,11 +185,12 @@ this->_option = option; this->_mandatory = mandatory; this->_option = option; + this->_multiple = multiple; this->_position = -1; } DCmdArgumentInfo(const char* name, const char* description, const char* type, const char* default_string, bool mandatory, bool option, - int position) { + bool multiple, int position) { this->_name = name; this->_description = description; this->_type = type; @@ -173,6 +198,7 @@ this->_option = option; this->_mandatory = mandatory; this->_option = option; + this->_multiple = multiple; this->_position = position; } const char* name() const { return _name; } @@ -181,11 +207,29 @@ const char* default_string() const { return _default_string; } bool is_mandatory() const { return _mandatory; } bool is_option() const { return _option; } + bool is_multiple() const { return _multiple; } int position() const { return _position; } }; // The DCmdParser class can be used to create an argument parser for a // diagnostic command. It is not mandatory to use it to parse arguments. +// The DCmdParser parses a CmdLine instance according to the parameters that +// have been declared by its associated diagnostic command. A parameter can +// either be an option or an argument. Options are identified by the option name +// while arguments are identified by their position in the command line. The +// position of an argument is defined relative to all arguments passed on the +// command line, options are not considered when defining an argument position. +// The generic syntax of a diagnostic command is: +// +// <command name> [<option>=<value>] [<argument_value>] +// +// Example: +// +// command_name option1=value1 option2=value argumentA argumentB argumentC +// +// In this command line, the diagnostic command receives five parameters, two +// options named option1 and option2, and three arguments. argumentA's position +// is 0, argumentB's position is 1 and argumentC's position is 2. class DCmdParser { private: GenDCmdArgument* _options; @@ -249,6 +293,19 @@ // longer description can provide more specific details like the fact that Thread Dump // impact depends on the heap size. static const char* impact() { return "Low: No impact"; } + // The permission() method returns the description of Java Permission. This + // permission is required when the diagnostic command is invoked via the + // DiagnosticCommandMBean. The rationale for this permission check is that + // the DiagnosticCommandMBean can be used to perform remote invocations of + // diagnostic commands through the PlatformMBeanServer. The (optional) Java + // Permission associated with each diagnostic command should ease the work + // of system administrators to write policy files granting permissions to + // execute diagnostic commands to remote users. Any diagnostic command with + // a potential impact on security should overwrite this method. + static const JavaPermission permission() { + JavaPermission p = {NULL, NULL, NULL}; + return p; + } static int num_arguments() { return 0; } outputStream* output() { return _output; } bool is_heap_allocated() { return _is_heap_allocated; } @@ -263,7 +320,7 @@ "The argument list of this diagnostic command should be empty."); } } - virtual void execute(TRAPS) { } + virtual void execute(DCmdSource source, TRAPS) { } virtual void reset(TRAPS) { } virtual void cleanup() { } @@ -278,7 +335,7 @@ } // main method to invoke the framework - static void parse_and_execute(outputStream* out, const char* cmdline, + static void parse_and_execute(DCmdSource source, outputStream* out, const char* cmdline, char delim, TRAPS); }; @@ -291,9 +348,10 @@ static const char* description() { return "No Help";} static const char* disabled_message() { return "Diagnostic command currently disabled"; } static const char* impact() { return "Low: No impact"; } + static const JavaPermission permission() {JavaPermission p = {NULL, NULL, NULL}; return p; } static int num_arguments() { return 0; } virtual void parse(CmdLine *line, char delim, TRAPS); - virtual void execute(TRAPS) { } + virtual void execute(DCmdSource source, TRAPS) { } virtual void reset(TRAPS); virtual void cleanup(); virtual void print_help(const char* name); @@ -323,6 +381,8 @@ class DCmdFactory: public CHeapObj<mtInternal> { private: static Mutex* _dcmdFactory_lock; + static bool _send_jmx_notification; + static bool _has_pending_jmx_notification; // Pointer to the next factory in the singly-linked list of registered // diagnostic commands DCmdFactory* _next; @@ -333,19 +393,23 @@ // When hidden, a diagnostic command doesn't appear in the list of commands // provided by the 'help' command. bool _hidden; + uint32_t _export_flags; int _num_arguments; static DCmdFactory* _DCmdFactoryList; public: - DCmdFactory(int num_arguments, bool enabled, bool hidden) { + DCmdFactory(int num_arguments, uint32_t flags, bool enabled, bool hidden) { _next = NULL; _enabled = enabled; _hidden = hidden; + _export_flags = flags; _num_arguments = num_arguments; } bool is_enabled() const { return _enabled; } void set_enabled(bool b) { _enabled = b; } bool is_hidden() const { return _hidden; } void set_hidden(bool b) { _hidden = b; } + uint32_t export_flags() { return _export_flags; } + void set_export_flags(uint32_t f) { _export_flags = f; } int num_arguments() { return _num_arguments; } DCmdFactory* next() { return _next; } virtual DCmd* create_Cheap_instance(outputStream* output) = 0; @@ -353,19 +417,29 @@ virtual const char* name() const = 0; virtual const char* description() const = 0; virtual const char* impact() const = 0; + virtual const JavaPermission permission() const = 0; virtual const char* disabled_message() const = 0; // Register a DCmdFactory to make a diagnostic command available. // Once registered, a diagnostic command must not be unregistered. // To prevent a diagnostic command from being executed, just set the // enabled flag to false. static int register_DCmdFactory(DCmdFactory* factory); - static DCmdFactory* factory(const char* cmd, size_t len); + static DCmdFactory* factory(DCmdSource source, const char* cmd, size_t len); // Returns a C-heap allocated diagnostic command for the given command line - static DCmd* create_global_DCmd(CmdLine &line, outputStream* out, TRAPS); + static DCmd* create_global_DCmd(DCmdSource source, CmdLine &line, outputStream* out, TRAPS); // Returns a resourceArea allocated diagnostic command for the given command line - static DCmd* create_local_DCmd(CmdLine &line, outputStream* out, TRAPS); - static GrowableArray<const char*>* DCmd_list(); - static GrowableArray<DCmdInfo*>* DCmdInfo_list(); + static DCmd* create_local_DCmd(DCmdSource source, CmdLine &line, outputStream* out, TRAPS); + static GrowableArray<const char*>* DCmd_list(DCmdSource source); + static GrowableArray<DCmdInfo*>* DCmdInfo_list(DCmdSource source); + + static void set_jmx_notification_enabled(bool enabled) { + _send_jmx_notification = enabled; + } + static void push_jmx_notification_request(); + static bool has_pending_jmx_notification() { return _has_pending_jmx_notification; } + static void send_notification(TRAPS); +private: + static void send_notification_internal(TRAPS); friend class HelpDCmd; }; @@ -374,8 +448,8 @@ // where this template is used to create and register factories. template <class DCmdClass> class DCmdFactoryImpl : public DCmdFactory { public: - DCmdFactoryImpl(bool enabled, bool hidden) : - DCmdFactory(DCmdClass::num_arguments(), enabled, hidden) { } + DCmdFactoryImpl(uint32_t flags, bool enabled, bool hidden) : + DCmdFactory(DCmdClass::num_arguments(), flags, enabled, hidden) { } // Returns a C-heap allocated instance virtual DCmd* create_Cheap_instance(outputStream* output) { return new (ResourceObj::C_HEAP, mtInternal) DCmdClass(output, true); @@ -393,6 +467,9 @@ virtual const char* impact() const { return DCmdClass::impact(); } + virtual const JavaPermission permission() const { + return DCmdClass::permission(); + } virtual const char* disabled_message() const { return DCmdClass::disabled_message(); }