Mercurial > jdk8-mips64-public > hotspot / file revision

 /*

  * Copyright (c) 2011, 2014, 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

  * under the terms of the GNU General Public License version 2 only, as

  * published by the Free Software Foundation.

  *

  * This code is distributed in the hope that it will be useful, but WITHOUT

  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

  * version 2 for more details (a copy is included in the LICENSE file that

  * accompanied this code).

  *

  * You should have received a copy of the GNU General Public License version

  * 2 along with this work; if not, write to the Free Software Foundation,

  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

  *

  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

  * or visit www.oracle.com if you need additional information or have any

  * questions.

  *

  */

 #include "precompiled.hpp"

 #include "memory/oopFactory.hpp"

 #include "runtime/javaCalls.hpp"

 #include "runtime/mutexLocker.hpp"

 #include "services/diagnosticArgument.hpp"

 #include "services/diagnosticFramework.hpp"

 #include "services/management.hpp"

 CmdLine::CmdLine(const char* line, size_t len, bool no_command_name) {

   assert(line != NULL, "Command line string should not be NULL");

   const char* line_end;

   const char* cmd_end;

   _cmd = line;

   line_end = &line[len];

   // Skip whitespace in the beginning of the line.

   while (_cmd < line_end && isspace((int) _cmd[0])) {

     _cmd++;

   }

   cmd_end = _cmd;

   if (no_command_name) {

     _cmd = NULL;

     _cmd_len = 0;

   } else {

     // Look for end of the command name

     while (cmd_end < line_end && !isspace((int) cmd_end[0])) {

       cmd_end++;

     }

     _cmd_len = cmd_end - _cmd;

   }

   _args = cmd_end;

   _args_len = line_end - _args;

 }

 bool DCmdArgIter::next(TRAPS) {

   if (_len == 0) return false;

   // skipping spaces

   while (_cursor < _len - 1 && _buffer[_cursor] == _delim) {

     _cursor++;

   }

   // handling end of command line

   if (_cursor >= _len - 1) {

     _cursor = _len - 1;

     _key_addr = &_buffer[_len - 1];

     _key_len = 0;

     _value_addr = &_buffer[_len - 1];

     _value_len = 0;

     return false;

   }

   // extracting first item, argument or option name

   _key_addr = &_buffer[_cursor];

   bool arg_had_quotes = false;

   while (_cursor <= _len - 1 && _buffer[_cursor] != '=' && _buffer[_cursor] != _delim) {

     // argument can be surrounded by single or double quotes

     if (_buffer[_cursor] == '\"' || _buffer[_cursor] == '\'') {

       _key_addr++;

       char quote = _buffer[_cursor];

       arg_had_quotes = true;

       while (_cursor < _len - 1) {

         _cursor++;

         if (_buffer[_cursor] == quote && _buffer[_cursor - 1] != '\\') {

           break;

         }

       }

       if (_buffer[_cursor] != quote) {

         THROW_MSG_(vmSymbols::java_lang_IllegalArgumentException(),

                 "Format error in diagnostic command arguments", false);

       }

       break;

     }

     _cursor++;

   }

   _key_len = &_buffer[_cursor] - _key_addr;

   if (arg_had_quotes) {

     // if the argument was quoted, we need to step past the last quote here

     _cursor++;

   }

   // check if the argument has the <key>=<value> format

   if (_cursor <= _len -1 && _buffer[_cursor] == '=') {

     _cursor++;

     _value_addr = &_buffer[_cursor];

     bool value_had_quotes = false;

     // extract the value

     while (_cursor <= _len - 1 && _buffer[_cursor] != _delim) {

       // value can be surrounded by simple or double quotes

       if (_buffer[_cursor] == '\"' || _buffer[_cursor] == '\'') {

         _value_addr++;

         char quote = _buffer[_cursor];

         value_had_quotes = true;

         while (_cursor < _len - 1) {

           _cursor++;

           if (_buffer[_cursor] == quote && _buffer[_cursor - 1] != '\\') {

             break;

           }

         }

         if (_buffer[_cursor] != quote) {

           THROW_MSG_(vmSymbols::java_lang_IllegalArgumentException(),

                   "Format error in diagnostic command arguments", false);

         }

         break;

       }

       _cursor++;

     }

     _value_len = &_buffer[_cursor] - _value_addr;

     if (value_had_quotes) {

       // if the value was quoted, we need to step past the last quote here

       _cursor++;

     }

   } else {

     _value_addr = NULL;

     _value_len = 0;

   }

   return _key_len != 0;

 }

 bool DCmdInfo::by_name(void* cmd_name, DCmdInfo* info) {

   if (info == NULL) return false;

   return strcmp((const char*)cmd_name, info->name()) == 0;

 }

 void DCmdParser::add_dcmd_option(GenDCmdArgument* arg) {

   assert(arg != NULL, "Sanity");

   if (_options == NULL) {

     _options = arg;

   } else {

     GenDCmdArgument* o = _options;

     while (o->next() != NULL) {

       o = o->next();

     }

     o->set_next(arg);

   }

   arg->set_next(NULL);

   Thread* THREAD = Thread::current();

   arg->init_value(THREAD);

   if (HAS_PENDING_EXCEPTION) {

     fatal("Initialization must be successful");

   }

 }

 void DCmdParser::add_dcmd_argument(GenDCmdArgument* arg) {

   assert(arg != NULL, "Sanity");

   if (_arguments_list == NULL) {

     _arguments_list = arg;

   } else {

     GenDCmdArgument* a = _arguments_list;

     while (a->next() != NULL) {

       a = a->next();

     }

     a->set_next(arg);

   }

   arg->set_next(NULL);

   Thread* THREAD = Thread::current();

   arg->init_value(THREAD);

   if (HAS_PENDING_EXCEPTION) {

     fatal("Initialization must be successful");

   }

 }

 void DCmdParser::parse(CmdLine* line, char delim, TRAPS) {

   GenDCmdArgument* next_argument = _arguments_list;

   DCmdArgIter iter(line->args_addr(), line->args_len(), delim);

   bool cont = iter.next(CHECK);

   while (cont) {

     GenDCmdArgument* arg = lookup_dcmd_option(iter.key_addr(),

             iter.key_length());

     if (arg != NULL) {

       arg->read_value(iter.value_addr(), iter.value_length(), CHECK);

     } else {

       if (next_argument != NULL) {

         arg = next_argument;

         arg->read_value(iter.key_addr(), iter.key_length(), CHECK);

         next_argument = next_argument->next();

       } else {

         const size_t buflen    = 120;

         const size_t argbuflen = 30;

         char buf[buflen];

         char argbuf[argbuflen];

         size_t len = MIN2<size_t>(iter.key_length(), argbuflen - 1);

         strncpy(argbuf, iter.key_addr(), len);

         argbuf[len] = '\0';

         jio_snprintf(buf, buflen - 1, "Unknown argument '%s' in diagnostic command.", argbuf);

         THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(), buf);

       }

     }

     cont = iter.next(CHECK);

   }

   check(CHECK);

 }

 GenDCmdArgument* DCmdParser::lookup_dcmd_option(const char* name, size_t len) {

   GenDCmdArgument* arg = _options;

   while (arg != NULL) {

     if (strlen(arg->name()) == len &&

       strncmp(name, arg->name(), len) == 0) {

       return arg;

     }

     arg = arg->next();

   }

   return NULL;

 }

 void DCmdParser::check(TRAPS) {

   const size_t buflen = 256;

   char buf[buflen];

   GenDCmdArgument* arg = _arguments_list;

   while (arg != NULL) {

     if (arg->is_mandatory() && !arg->has_value()) {

       jio_snprintf(buf, buflen - 1, "The argument '%s' is mandatory.", arg->name());

       THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(), buf);

     }

     arg = arg->next();

   }

   arg = _options;

   while (arg != NULL) {

     if (arg->is_mandatory() && !arg->has_value()) {

       jio_snprintf(buf, buflen - 1, "The option '%s' is mandatory.", arg->name());

       THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(), buf);

     }

     arg = arg->next();

   }

 }

 void DCmdParser::print_help(outputStream* out, const char* cmd_name) {

   out->print("Syntax : %s %s", cmd_name, _options == NULL ? "" : "[options]");

   GenDCmdArgument* arg = _arguments_list;

   while (arg != NULL) {

     if (arg->is_mandatory()) {

       out->print(" <%s>", arg->name());

     } else {

       out->print(" [<%s>]", arg->name());

     }

     arg = arg->next();

   }

   out->cr();

   if (_arguments_list != NULL) {

     out->print_cr("\nArguments:");

     arg = _arguments_list;

     while (arg != NULL) {

       out->print("\t%s : %s %s (%s, ", arg->name(),

                  arg->is_mandatory() ? "" : "[optional]",

                  arg->description(), arg->type());

       if (arg->has_default()) {

         out->print("%s", arg->default_string());

       } else {

         out->print("no default value");

       }

       out->print_cr(")");

       arg = arg->next();

     }

   }

   if (_options != NULL) {

     out->print_cr("\nOptions: (options must be specified using the <key> or <key>=<value> syntax)");

     arg = _options;

     while (arg != NULL) {

       out->print("\t%s : %s %s (%s, ", arg->name(),

                  arg->is_mandatory() ? "" : "[optional]",

                  arg->description(), arg->type());

       if (arg->has_default()) {

         out->print("%s", arg->default_string());

       } else {

         out->print("no default value");

       }

       out->print_cr(")");

       arg = arg->next();

     }

   }

 }

 void DCmdParser::reset(TRAPS) {

   GenDCmdArgument* arg = _arguments_list;

   while (arg != NULL) {

     arg->reset(CHECK);

     arg = arg->next();

   }

   arg = _options;

   while (arg != NULL) {

     arg->reset(CHECK);

     arg = arg->next();

   }

 }

 void DCmdParser::cleanup() {

   GenDCmdArgument* arg = _arguments_list;

   while (arg != NULL) {

     arg->cleanup();

     arg = arg->next();

   }

   arg = _options;

   while (arg != NULL) {

     arg->cleanup();

     arg = arg->next();

   }

 }

 int DCmdParser::num_arguments() {

   GenDCmdArgument* arg = _arguments_list;

   int count = 0;

   while (arg != NULL) {

     count++;

     arg = arg->next();

   }

   arg = _options;

   while (arg != NULL) {

     count++;

     arg = arg->next();

   }

   return count;

 }

 GrowableArray<const char *>* DCmdParser::argument_name_array() {

   int count = num_arguments();

   GrowableArray<const char *>* array = new GrowableArray<const char *>(count);

   GenDCmdArgument* arg = _arguments_list;

   while (arg != NULL) {

     array->append(arg->name());

     arg = arg->next();

   }

   arg = _options;

   while (arg != NULL) {

     array->append(arg->name());

     arg = arg->next();

   }

   return array;

 }

 GrowableArray<DCmdArgumentInfo*>* DCmdParser::argument_info_array() {

   int count = num_arguments();

   GrowableArray<DCmdArgumentInfo*>* array = new GrowableArray<DCmdArgumentInfo *>(count);

   int idx = 0;

   GenDCmdArgument* arg = _arguments_list;

   while (arg != NULL) {

     array->append(new DCmdArgumentInfo(arg->name(), arg->description(),

                   arg->type(), arg->default_string(), arg->is_mandatory(),

                   false, arg->allow_multiple(), idx));

     idx++;

     arg = arg->next();

   }

   arg = _options;

   while (arg != NULL) {

     array->append(new DCmdArgumentInfo(arg->name(), arg->description(),

                   arg->type(), arg->default_string(), arg->is_mandatory(),

                   true, arg->allow_multiple()));

     arg = arg->next();

   }

   return array;

 }

 DCmdFactory* DCmdFactory::_DCmdFactoryList = NULL;

 bool DCmdFactory::_has_pending_jmx_notification = false;

 void DCmd::parse_and_execute(DCmdSource source, outputStream* out,

                              const char* cmdline, char delim, TRAPS) {

   if (cmdline == NULL) return; // Nothing to do!

   DCmdIter iter(cmdline, '\n');

   int count = 0;

   while (iter.has_next()) {

     if(source == DCmd_Source_MBean && count > 0) {

       // When diagnostic commands are invoked via JMX, each command line

       // must contains one and only one command because of the Permission

       // checks performed by the DiagnosticCommandMBean

       THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),

               "Invalid syntax");

     }

     CmdLine line = iter.next();

     if (line.is_stop()) {

       break;

     }

     if (line.is_executable()) {

       DCmd* command = DCmdFactory::create_local_DCmd(source, line, out, CHECK);

       assert(command != NULL, "command error must be handled before this line");

       DCmdMark mark(command);

       command->parse(&line, delim, CHECK);

       command->execute(source, CHECK);

     }

     count++;

   }

 }

 void DCmdWithParser::parse(CmdLine* line, char delim, TRAPS) {

   _dcmdparser.parse(line, delim, CHECK);

 }

 void DCmdWithParser::print_help(const char* name) {

   _dcmdparser.print_help(output(), name);

 }

 void DCmdWithParser::reset(TRAPS) {

   _dcmdparser.reset(CHECK);

 }

 void DCmdWithParser::cleanup() {

   _dcmdparser.cleanup();

 }

 GrowableArray<const char*>* DCmdWithParser::argument_name_array() {

   return _dcmdparser.argument_name_array();

 }

 GrowableArray<DCmdArgumentInfo*>* DCmdWithParser::argument_info_array() {

   return _dcmdparser.argument_info_array();

 }

 void DCmdFactory::push_jmx_notification_request() {

   MutexLockerEx ml(Service_lock, Mutex::_no_safepoint_check_flag);

   _has_pending_jmx_notification = true;

   Service_lock->notify_all();

 }

 void DCmdFactory::send_notification(TRAPS) {

   DCmdFactory::send_notification_internal(THREAD);

   // Clearing pending exception to avoid premature termination of

   // the service thread

   if (HAS_PENDING_EXCEPTION) {

     CLEAR_PENDING_EXCEPTION;

   }

 }

 void DCmdFactory::send_notification_internal(TRAPS) {

   ResourceMark rm(THREAD);

   HandleMark hm(THREAD);

   bool notif = false;

   {

     MutexLockerEx ml(Service_lock, Mutex::_no_safepoint_check_flag);

     notif = _has_pending_jmx_notification;

     _has_pending_jmx_notification = false;

   }

   if (notif) {

     Klass* k = Management::sun_management_ManagementFactoryHelper_klass(CHECK);

     instanceKlassHandle mgmt_factory_helper_klass(THREAD, k);

     JavaValue result(T_OBJECT);

     JavaCalls::call_static(&result,

             mgmt_factory_helper_klass,

             vmSymbols::getDiagnosticCommandMBean_name(),

             vmSymbols::getDiagnosticCommandMBean_signature(),

             CHECK);

     instanceOop m = (instanceOop) result.get_jobject();

     instanceHandle dcmd_mbean_h(THREAD, m);

     Klass* k2 = Management::sun_management_DiagnosticCommandImpl_klass(CHECK);

     instanceKlassHandle dcmd_mbean_klass(THREAD, k2);

     if (!dcmd_mbean_h->is_a(k2)) {

       THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),

               "ManagementFactory.getDiagnosticCommandMBean didn't return a DiagnosticCommandMBean instance");

     }

     JavaValue result2(T_VOID);

     JavaCallArguments args2(dcmd_mbean_h);

     JavaCalls::call_virtual(&result2,

             dcmd_mbean_klass,

             vmSymbols::createDiagnosticFrameworkNotification_name(),

             vmSymbols::void_method_signature(),

             &args2,

             CHECK);

   }

 }

 Mutex* DCmdFactory::_dcmdFactory_lock = new Mutex(Mutex::leaf, "DCmdFactory", true);

 bool DCmdFactory::_send_jmx_notification = false;

 DCmdFactory* DCmdFactory::factory(DCmdSource source, const char* name, size_t len) {

   MutexLockerEx ml(_dcmdFactory_lock, Mutex::_no_safepoint_check_flag);

   DCmdFactory* factory = _DCmdFactoryList;

   while (factory != NULL) {

     if (strlen(factory->name()) == len &&

         strncmp(name, factory->name(), len) == 0) {

       if(factory->export_flags() & source) {

         return factory;

       } else {

         return NULL;

       }

     }

     factory = factory->_next;

   }

   return NULL;

 }

 int DCmdFactory::register_DCmdFactory(DCmdFactory* factory) {

   MutexLockerEx ml(_dcmdFactory_lock, Mutex::_no_safepoint_check_flag);

   factory->_next = _DCmdFactoryList;

   _DCmdFactoryList = factory;

   if (_send_jmx_notification && !factory->_hidden

       && (factory->_export_flags & DCmd_Source_MBean)) {

     DCmdFactory::push_jmx_notification_request();

   }

   return 0; // Actually, there's no checks for duplicates

 }

 DCmd* DCmdFactory::create_global_DCmd(DCmdSource source, CmdLine &line,

                                       outputStream* out, TRAPS) {

   DCmdFactory* f = factory(source, line.cmd_addr(), line.cmd_len());

   if (f != NULL) {

     if (f->is_enabled()) {

       THROW_MSG_NULL(vmSymbols::java_lang_IllegalArgumentException(),

                      f->disabled_message());

     }

     return f->create_Cheap_instance(out);

   }

   THROW_MSG_NULL(vmSymbols::java_lang_IllegalArgumentException(),

              "Unknown diagnostic command");

 }

 DCmd* DCmdFactory::create_local_DCmd(DCmdSource source, CmdLine &line,

                                      outputStream* out, TRAPS) {

   DCmdFactory* f = factory(source, line.cmd_addr(), line.cmd_len());

   if (f != NULL) {

     if (!f->is_enabled()) {

       THROW_MSG_NULL(vmSymbols::java_lang_IllegalArgumentException(),

                      f->disabled_message());

     }

     return f->create_resource_instance(out);

   }

   THROW_MSG_NULL(vmSymbols::java_lang_IllegalArgumentException(),

              "Unknown diagnostic command");

 }

 GrowableArray<const char*>* DCmdFactory::DCmd_list(DCmdSource source) {

   MutexLockerEx ml(_dcmdFactory_lock, Mutex::_no_safepoint_check_flag);

   GrowableArray<const char*>* array = new GrowableArray<const char*>();

   DCmdFactory* factory = _DCmdFactoryList;

   while (factory != NULL) {

     if (!factory->is_hidden() && (factory->export_flags() & source)) {

       array->append(factory->name());

     }

     factory = factory->next();

   }

   return array;

 }

 GrowableArray<DCmdInfo*>* DCmdFactory::DCmdInfo_list(DCmdSource source ) {

   MutexLockerEx ml(_dcmdFactory_lock, Mutex::_no_safepoint_check_flag);

   GrowableArray<DCmdInfo*>* array = new GrowableArray<DCmdInfo*>();

   DCmdFactory* factory = _DCmdFactoryList;

   while (factory != NULL) {

     if (!factory->is_hidden() && (factory->export_flags() & source)) {

       array->append(new DCmdInfo(factory->name(),

                     factory->description(), factory->impact(),

                     factory->permission(), factory->num_arguments(),

                     factory->is_enabled()));

     }

     factory = factory->next();

   }

   return array;

 }