1 /*
   2  * Copyright (c) 2011, 2017, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 #include "precompiled.hpp"
  26 #include "classfile/classLoaderStats.hpp"
  27 #include "classfile/compactHashtable.hpp"
  28 #include "compiler/compileBroker.hpp"
  29 #include "compiler/directivesParser.hpp"
  30 #include "gc/shared/vmGCOperations.hpp"
  31 #include "memory/resourceArea.hpp"
  32 #include "oops/oop.inline.hpp"
  33 #include "runtime/globals.hpp"
  34 #include "runtime/javaCalls.hpp"
  35 #include "runtime/os.hpp"
  36 #include "services/diagnosticArgument.hpp"
  37 #include "services/diagnosticCommand.hpp"
  38 #include "services/diagnosticFramework.hpp"
  39 #include "services/heapDumper.hpp"
  40 #include "services/management.hpp"
  41 #include "services/writeableFlags.hpp"
  42 #include "utilities/macros.hpp"
  43 #include "oops/objArrayOop.inline.hpp"
  44 
  45 void DCmdRegistrant::register_dcmds(){
  46   // Registration of the diagnostic commands
  47   // First argument specifies which interfaces will export the command
  48   // Second argument specifies if the command is enabled
  49   // Third  argument specifies if the command is hidden
  50   uint32_t full_export = DCmd_Source_Internal | DCmd_Source_AttachAPI
  51                          | DCmd_Source_MBean;
  52   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<HelpDCmd>(full_export, true, false));
  53   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<VersionDCmd>(full_export, true, false));
  54   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<CommandLineDCmd>(full_export, true, false));
  55   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<PrintSystemPropertiesDCmd>(full_export, true, false));
  56   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<PrintVMFlagsDCmd>(full_export, true, false));
  57   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<SetVMFlagDCmd>(full_export, true, false));
  58   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<VMDynamicLibrariesDCmd>(full_export, true, false));
  59   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<VMUptimeDCmd>(full_export, true, false));
  60   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<VMInfoDCmd>(full_export, true, false));
  61   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<SystemGCDCmd>(full_export, true, false));
  62   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<RunFinalizationDCmd>(full_export, true, false));
  63   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<HeapInfoDCmd>(full_export, true, false));
  64   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<FinalizerInfoDCmd>(full_export, true, false));
  65 #if INCLUDE_SERVICES
  66   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<HeapDumpDCmd>(DCmd_Source_Internal | DCmd_Source_AttachAPI, true, false));
  67   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<ClassHistogramDCmd>(full_export, true, false));
  68   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<ClassStatsDCmd>(full_export, true, false));
  69   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<ClassHierarchyDCmd>(full_export, true, false));
  70   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<SymboltableDCmd>(full_export, true, false));
  71   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<StringtableDCmd>(full_export, true, false));
  72 #if INCLUDE_JVMTI // Both JVMTI and SERVICES have to be enabled to have this dcmd
  73   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<JVMTIAgentLoadDCmd>(full_export, true, false));
  74 #endif // INCLUDE_JVMTI
  75 #endif // INCLUDE_SERVICES
  76 #if INCLUDE_JVMTI
  77   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<JVMTIDataDumpDCmd>(full_export, true, false));
  78 #endif // INCLUDE_JVMTI
  79   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<ThreadDumpDCmd>(full_export, true, false));
  80   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<ClassLoaderStatsDCmd>(full_export, true, false));
  81   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<CompileQueueDCmd>(full_export, true, false));
  82   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<CodeListDCmd>(full_export, true, false));
  83   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<CodeCacheDCmd>(full_export, true, false));
  84   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<TouchedMethodsDCmd>(full_export, true, false));
  85 
  86   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<CompilerDirectivesPrintDCmd>(full_export, true, false));
  87   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<CompilerDirectivesAddDCmd>(full_export, true, false));
  88   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<CompilerDirectivesRemoveDCmd>(full_export, true, false));
  89   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<CompilerDirectivesClearDCmd>(full_export, true, false));
  90 
  91   // Enhanced JMX Agent Support
  92   // These commands won't be exported via the DiagnosticCommandMBean until an
  93   // appropriate permission is created for them
  94   uint32_t jmx_agent_export_flags = DCmd_Source_Internal | DCmd_Source_AttachAPI;
  95   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<JMXStartRemoteDCmd>(jmx_agent_export_flags, true,false));
  96   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<JMXStartLocalDCmd>(jmx_agent_export_flags, true,false));
  97   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<JMXStopRemoteDCmd>(jmx_agent_export_flags, true,false));
  98   DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<JMXStatusDCmd>(jmx_agent_export_flags, true,false));
  99 
 100 }
 101 
 102 #ifndef HAVE_EXTRA_DCMD
 103 void DCmdRegistrant::register_dcmds_ext(){
 104    // Do nothing here
 105 }
 106 #endif
 107 
 108 
 109 HelpDCmd::HelpDCmd(outputStream* output, bool heap) : DCmdWithParser(output, heap),
 110   _all("-all", "Show help for all commands", "BOOLEAN", false, "false"),
 111   _cmd("command name", "The name of the command for which we want help",
 112         "STRING", false) {
 113   _dcmdparser.add_dcmd_option(&_all);
 114   _dcmdparser.add_dcmd_argument(&_cmd);
 115 };
 116 
 117 void HelpDCmd::execute(DCmdSource source, TRAPS) {
 118   if (_all.value()) {
 119     GrowableArray<const char*>* cmd_list = DCmdFactory::DCmd_list(source);
 120     for (int i = 0; i < cmd_list->length(); i++) {
 121       DCmdFactory* factory = DCmdFactory::factory(source, cmd_list->at(i),
 122                                                   strlen(cmd_list->at(i)));
 123       output()->print_cr("%s%s", factory->name(),
 124                          factory->is_enabled() ? "" : " [disabled]");
 125       output()->print_cr("\t%s", factory->description());
 126       output()->cr();
 127       factory = factory->next();
 128     }
 129   } else if (_cmd.has_value()) {
 130     DCmd* cmd = NULL;
 131     DCmdFactory* factory = DCmdFactory::factory(source, _cmd.value(),
 132                                                 strlen(_cmd.value()));
 133     if (factory != NULL) {
 134       output()->print_cr("%s%s", factory->name(),
 135                          factory->is_enabled() ? "" : " [disabled]");
 136       output()->print_cr("%s", factory->description());
 137       output()->print_cr("\nImpact: %s", factory->impact());
 138       JavaPermission p = factory->permission();
 139       if(p._class != NULL) {
 140         if(p._action != NULL) {
 141           output()->print_cr("\nPermission: %s(%s, %s)",
 142                   p._class, p._name == NULL ? "null" : p._name, p._action);
 143         } else {
 144           output()->print_cr("\nPermission: %s(%s)",
 145                   p._class, p._name == NULL ? "null" : p._name);
 146         }
 147       }
 148       output()->cr();
 149       cmd = factory->create_resource_instance(output());
 150       if (cmd != NULL) {
 151         DCmdMark mark(cmd);
 152         cmd->print_help(factory->name());
 153       }
 154     } else {
 155       output()->print_cr("Help unavailable : '%s' : No such command", _cmd.value());
 156     }
 157   } else {
 158     output()->print_cr("The following commands are available:");
 159     GrowableArray<const char *>* cmd_list = DCmdFactory::DCmd_list(source);
 160     for (int i = 0; i < cmd_list->length(); i++) {
 161       DCmdFactory* factory = DCmdFactory::factory(source, cmd_list->at(i),
 162                                                   strlen(cmd_list->at(i)));
 163       output()->print_cr("%s%s", factory->name(),
 164                          factory->is_enabled() ? "" : " [disabled]");
 165       factory = factory->_next;
 166     }
 167     output()->print_cr("\nFor more information about a specific command use 'help <command>'.");
 168   }
 169 }
 170 
 171 int HelpDCmd::num_arguments() {
 172   ResourceMark rm;
 173   HelpDCmd* dcmd = new HelpDCmd(NULL, false);
 174   if (dcmd != NULL) {
 175     DCmdMark mark(dcmd);
 176     return dcmd->_dcmdparser.num_arguments();
 177   } else {
 178     return 0;
 179   }
 180 }
 181 
 182 void VersionDCmd::execute(DCmdSource source, TRAPS) {
 183   output()->print_cr("%s version %s", Abstract_VM_Version::vm_name(),
 184           Abstract_VM_Version::vm_release());
 185   JDK_Version jdk_version = JDK_Version::current();
 186   if (jdk_version.patch_version() > 0) {
 187     output()->print_cr("JDK %d.%d.%d.%d", jdk_version.major_version(),
 188             jdk_version.minor_version(), jdk_version.security_version(),
 189             jdk_version.patch_version());
 190   } else {
 191     output()->print_cr("JDK %d.%d.%d", jdk_version.major_version(),
 192             jdk_version.minor_version(), jdk_version.security_version());
 193   }
 194 }
 195 
 196 PrintVMFlagsDCmd::PrintVMFlagsDCmd(outputStream* output, bool heap) :
 197                                    DCmdWithParser(output, heap),
 198   _all("-all", "Print all flags supported by the VM", "BOOLEAN", false, "false") {
 199   _dcmdparser.add_dcmd_option(&_all);
 200 }
 201 
 202 void PrintVMFlagsDCmd::execute(DCmdSource source, TRAPS) {
 203   if (_all.value()) {
 204     CommandLineFlags::printFlags(output(), true);
 205   } else {
 206     CommandLineFlags::printSetFlags(output());
 207   }
 208 }
 209 
 210 int PrintVMFlagsDCmd::num_arguments() {
 211     ResourceMark rm;
 212     PrintVMFlagsDCmd* dcmd = new PrintVMFlagsDCmd(NULL, false);
 213     if (dcmd != NULL) {
 214       DCmdMark mark(dcmd);
 215       return dcmd->_dcmdparser.num_arguments();
 216     } else {
 217       return 0;
 218     }
 219 }
 220 
 221 SetVMFlagDCmd::SetVMFlagDCmd(outputStream* output, bool heap) :
 222                                    DCmdWithParser(output, heap),
 223   _flag("flag name", "The name of the flag we want to set",
 224         "STRING", true),
 225   _value("string value", "The value we want to set", "STRING", false) {
 226   _dcmdparser.add_dcmd_argument(&_flag);
 227   _dcmdparser.add_dcmd_argument(&_value);
 228 }
 229 
 230 void SetVMFlagDCmd::execute(DCmdSource source, TRAPS) {
 231   const char* val = NULL;
 232   if (_value.value() != NULL) {
 233     val = _value.value();
 234   }
 235 
 236   FormatBuffer<80> err_msg("%s", "");
 237   int ret = WriteableFlags::set_flag(_flag.value(), val, Flag::MANAGEMENT, err_msg);
 238 
 239   if (ret != Flag::SUCCESS) {
 240     output()->print_cr("%s", err_msg.buffer());
 241   }
 242 }
 243 
 244 int SetVMFlagDCmd::num_arguments() {
 245   ResourceMark rm;
 246   SetVMFlagDCmd* dcmd = new SetVMFlagDCmd(NULL, false);
 247   if (dcmd != NULL) {
 248     DCmdMark mark(dcmd);
 249     return dcmd->_dcmdparser.num_arguments();
 250   } else {
 251     return 0;
 252   }
 253 }
 254 
 255 void JVMTIDataDumpDCmd::execute(DCmdSource source, TRAPS) {
 256   if (JvmtiExport::should_post_data_dump()) {
 257     JvmtiExport::post_data_dump();
 258   }
 259 }
 260 
 261 #if INCLUDE_SERVICES
 262 JVMTIAgentLoadDCmd::JVMTIAgentLoadDCmd(outputStream* output, bool heap) :
 263                                        DCmdWithParser(output, heap),
 264   _libpath("library path", "Absolute path of the JVMTI agent to load.",
 265            "STRING", true),
 266   _option("agent option", "Option string to pass the agent.", "STRING", false) {
 267   _dcmdparser.add_dcmd_argument(&_libpath);
 268   _dcmdparser.add_dcmd_argument(&_option);
 269 }
 270 
 271 void JVMTIAgentLoadDCmd::execute(DCmdSource source, TRAPS) {
 272 
 273   if (_libpath.value() == NULL) {
 274     output()->print_cr("JVMTI.agent_load dcmd needs library path.");
 275     return;
 276   }
 277 
 278   char *suffix = strrchr(_libpath.value(), '.');
 279   bool is_java_agent = (suffix != NULL) && (strncmp(".jar", suffix, 4) == 0);
 280 
 281   if (is_java_agent) {
 282     if (_option.value() == NULL) {
 283       JvmtiExport::load_agent_library("instrument", "false",
 284                                       _libpath.value(), output());
 285     } else {
 286       size_t opt_len = strlen(_libpath.value()) + strlen(_option.value()) + 2;
 287       if (opt_len > 4096) {
 288         output()->print_cr("JVMTI agent attach failed: Options is too long.");
 289         return;
 290       }
 291 
 292       char *opt = (char *)os::malloc(opt_len, mtInternal);
 293       if (opt == NULL) {
 294         output()->print_cr("JVMTI agent attach failed: "
 295                            "Could not allocate " SIZE_FORMAT " bytes for argument.",
 296                            opt_len);
 297         return;
 298       }
 299 
 300       jio_snprintf(opt, opt_len, "%s=%s", _libpath.value(), _option.value());
 301       JvmtiExport::load_agent_library("instrument", "false", opt, output());
 302 
 303       os::free(opt);
 304     }
 305   } else {
 306     JvmtiExport::load_agent_library(_libpath.value(), "true",
 307                                     _option.value(), output());
 308   }
 309 }
 310 
 311 int JVMTIAgentLoadDCmd::num_arguments() {
 312   ResourceMark rm;
 313   JVMTIAgentLoadDCmd* dcmd = new JVMTIAgentLoadDCmd(NULL, false);
 314   if (dcmd != NULL) {
 315     DCmdMark mark(dcmd);
 316     return dcmd->_dcmdparser.num_arguments();
 317   } else {
 318     return 0;
 319   }
 320 }
 321 #endif // INCLUDE_SERVICES
 322 
 323 void PrintSystemPropertiesDCmd::execute(DCmdSource source, TRAPS) {
 324   // load VMSupport
 325   Symbol* klass = vmSymbols::jdk_internal_vm_VMSupport();
 326   Klass* k = SystemDictionary::resolve_or_fail(klass, true, CHECK);
 327   instanceKlassHandle ik (THREAD, k);
 328   if (ik->should_be_initialized()) {
 329     ik->initialize(THREAD);
 330   }
 331   if (HAS_PENDING_EXCEPTION) {
 332     java_lang_Throwable::print(PENDING_EXCEPTION, output());
 333     output()->cr();
 334     CLEAR_PENDING_EXCEPTION;
 335     return;
 336   }
 337 
 338   // invoke the serializePropertiesToByteArray method
 339   JavaValue result(T_OBJECT);
 340   JavaCallArguments args;
 341 
 342   Symbol* signature = vmSymbols::serializePropertiesToByteArray_signature();
 343   JavaCalls::call_static(&result,
 344                          ik,
 345                          vmSymbols::serializePropertiesToByteArray_name(),
 346                          signature,
 347                          &args,
 348                          THREAD);
 349   if (HAS_PENDING_EXCEPTION) {
 350     java_lang_Throwable::print(PENDING_EXCEPTION, output());
 351     output()->cr();
 352     CLEAR_PENDING_EXCEPTION;
 353     return;
 354   }
 355 
 356   // The result should be a [B
 357   oop res = (oop)result.get_jobject();
 358   assert(res->is_typeArray(), "just checking");
 359   assert(TypeArrayKlass::cast(res->klass())->element_type() == T_BYTE, "just checking");
 360 
 361   // copy the bytes to the output stream
 362   typeArrayOop ba = typeArrayOop(res);
 363   jbyte* addr = typeArrayOop(res)->byte_at_addr(0);
 364   output()->print_raw((const char*)addr, ba->length());
 365 }
 366 
 367 VMUptimeDCmd::VMUptimeDCmd(outputStream* output, bool heap) :
 368                            DCmdWithParser(output, heap),
 369   _date("-date", "Add a prefix with current date", "BOOLEAN", false, "false") {
 370   _dcmdparser.add_dcmd_option(&_date);
 371 }
 372 
 373 void VMUptimeDCmd::execute(DCmdSource source, TRAPS) {
 374   if (_date.value()) {
 375     output()->date_stamp(true, "", ": ");
 376   }
 377   output()->time_stamp().update_to(tty->time_stamp().ticks());
 378   output()->stamp();
 379   output()->print_cr(" s");
 380 }
 381 
 382 int VMUptimeDCmd::num_arguments() {
 383   ResourceMark rm;
 384   VMUptimeDCmd* dcmd = new VMUptimeDCmd(NULL, false);
 385   if (dcmd != NULL) {
 386     DCmdMark mark(dcmd);
 387     return dcmd->_dcmdparser.num_arguments();
 388   } else {
 389     return 0;
 390   }
 391 }
 392 
 393 void VMInfoDCmd::execute(DCmdSource source, TRAPS) {
 394   VMError::print_vm_info(_output);
 395 }
 396 
 397 void SystemGCDCmd::execute(DCmdSource source, TRAPS) {
 398   if (!DisableExplicitGC) {
 399     Universe::heap()->collect(GCCause::_dcmd_gc_run);
 400   } else {
 401     output()->print_cr("Explicit GC is disabled, no GC has been performed.");
 402   }
 403 }
 404 
 405 void RunFinalizationDCmd::execute(DCmdSource source, TRAPS) {
 406   Klass* k = SystemDictionary::resolve_or_fail(vmSymbols::java_lang_System(),
 407                                                  true, CHECK);
 408   instanceKlassHandle klass(THREAD, k);
 409   JavaValue result(T_VOID);
 410   JavaCalls::call_static(&result, klass,
 411                          vmSymbols::run_finalization_name(),
 412                          vmSymbols::void_method_signature(), CHECK);
 413 }
 414 
 415 void HeapInfoDCmd::execute(DCmdSource source, TRAPS) {
 416   MutexLocker hl(Heap_lock);
 417   Universe::heap()->print_on(output());
 418 }
 419 
 420 void FinalizerInfoDCmd::execute(DCmdSource source, TRAPS) {
 421   ResourceMark rm;
 422 
 423   Klass* k = SystemDictionary::resolve_or_fail(
 424     vmSymbols::finalizer_histogram_klass(), true, CHECK);
 425 
 426   instanceKlassHandle klass(THREAD, k);
 427   JavaValue result(T_ARRAY);
 428 
 429   // We are calling lang.ref.FinalizerHistogram.getFinalizerHistogram() method
 430   // and expect it to return array of FinalizerHistogramEntry as Object[]
 431 
 432   JavaCalls::call_static(&result, klass,
 433                          vmSymbols::get_finalizer_histogram_name(),
 434                          vmSymbols::void_finalizer_histogram_entry_array_signature(), CHECK);
 435 
 436   objArrayOop result_oop = (objArrayOop) result.get_jobject();
 437   if (result_oop->length() == 0) {
 438     output()->print_cr("No instances waiting for finalization found");
 439     return;
 440   }
 441 
 442   oop foop = result_oop->obj_at(0);
 443   InstanceKlass* ik = InstanceKlass::cast(foop->klass());
 444 
 445   fieldDescriptor count_fd, name_fd;
 446 
 447   Klass* count_res = ik->find_field(
 448     vmSymbols::finalizer_histogram_entry_count_field(), vmSymbols::int_signature(), &count_fd);
 449 
 450   Klass* name_res = ik->find_field(
 451     vmSymbols::finalizer_histogram_entry_name_field(), vmSymbols::string_signature(), &name_fd);
 452 
 453   assert(count_res != NULL && name_res != NULL, "Unexpected layout of FinalizerHistogramEntry");
 454 
 455   output()->print_cr("Unreachable instances waiting for finalization");
 456   output()->print_cr("#instances  class name");
 457   output()->print_cr("-----------------------");
 458 
 459   for (int i = 0; i < result_oop->length(); ++i) {
 460     oop element_oop = result_oop->obj_at(i);
 461     oop str_oop = element_oop->obj_field(name_fd.offset());
 462     char *name = java_lang_String::as_utf8_string(str_oop);
 463     int count = element_oop->int_field(count_fd.offset());
 464     output()->print_cr("%10d  %s", count, name);
 465   }
 466 }
 467 
 468 #if INCLUDE_SERVICES // Heap dumping/inspection supported
 469 HeapDumpDCmd::HeapDumpDCmd(outputStream* output, bool heap) :
 470                            DCmdWithParser(output, heap),
 471   _filename("filename","Name of the dump file", "STRING",true),
 472   _all("-all", "Dump all objects, including unreachable objects",
 473        "BOOLEAN", false, "false") {
 474   _dcmdparser.add_dcmd_option(&_all);
 475   _dcmdparser.add_dcmd_argument(&_filename);
 476 }
 477 
 478 void HeapDumpDCmd::execute(DCmdSource source, TRAPS) {
 479   // Request a full GC before heap dump if _all is false
 480   // This helps reduces the amount of unreachable objects in the dump
 481   // and makes it easier to browse.
 482   HeapDumper dumper(!_all.value() /* request GC if _all is false*/);
 483   int res = dumper.dump(_filename.value());
 484   if (res == 0) {
 485     output()->print_cr("Heap dump file created");
 486   } else {
 487     // heap dump failed
 488     ResourceMark rm;
 489     char* error = dumper.error_as_C_string();
 490     if (error == NULL) {
 491       output()->print_cr("Dump failed - reason unknown");
 492     } else {
 493       output()->print_cr("%s", error);
 494     }
 495   }
 496 }
 497 
 498 int HeapDumpDCmd::num_arguments() {
 499   ResourceMark rm;
 500   HeapDumpDCmd* dcmd = new HeapDumpDCmd(NULL, false);
 501   if (dcmd != NULL) {
 502     DCmdMark mark(dcmd);
 503     return dcmd->_dcmdparser.num_arguments();
 504   } else {
 505     return 0;
 506   }
 507 }
 508 
 509 ClassHistogramDCmd::ClassHistogramDCmd(outputStream* output, bool heap) :
 510                                        DCmdWithParser(output, heap),
 511   _all("-all", "Inspect all objects, including unreachable objects",
 512        "BOOLEAN", false, "false") {
 513   _dcmdparser.add_dcmd_option(&_all);
 514 }
 515 
 516 void ClassHistogramDCmd::execute(DCmdSource source, TRAPS) {
 517   VM_GC_HeapInspection heapop(output(),
 518                               !_all.value() /* request full gc if false */);
 519   VMThread::execute(&heapop);
 520 }
 521 
 522 int ClassHistogramDCmd::num_arguments() {
 523   ResourceMark rm;
 524   ClassHistogramDCmd* dcmd = new ClassHistogramDCmd(NULL, false);
 525   if (dcmd != NULL) {
 526     DCmdMark mark(dcmd);
 527     return dcmd->_dcmdparser.num_arguments();
 528   } else {
 529     return 0;
 530   }
 531 }
 532 
 533 #define DEFAULT_COLUMNS "InstBytes,KlassBytes,CpAll,annotations,MethodCount,Bytecodes,MethodAll,ROAll,RWAll,Total"
 534 ClassStatsDCmd::ClassStatsDCmd(outputStream* output, bool heap) :
 535                                        DCmdWithParser(output, heap),
 536   _csv("-csv", "Print in CSV (comma-separated values) format for spreadsheets",
 537        "BOOLEAN", false, "false"),
 538   _all("-all", "Show all columns",
 539        "BOOLEAN", false, "false"),
 540   _help("-help", "Show meaning of all the columns",
 541        "BOOLEAN", false, "false"),
 542   _columns("columns", "Comma-separated list of all the columns to show. "
 543            "If not specified, the following columns are shown: " DEFAULT_COLUMNS,
 544            "STRING", false) {
 545   _dcmdparser.add_dcmd_option(&_all);
 546   _dcmdparser.add_dcmd_option(&_csv);
 547   _dcmdparser.add_dcmd_option(&_help);
 548   _dcmdparser.add_dcmd_argument(&_columns);
 549 }
 550 
 551 void ClassStatsDCmd::execute(DCmdSource source, TRAPS) {
 552   VM_GC_HeapInspection heapop(output(),
 553                               true /* request_full_gc */);
 554   heapop.set_csv_format(_csv.value());
 555   heapop.set_print_help(_help.value());
 556   heapop.set_print_class_stats(true);
 557   if (_all.value()) {
 558     if (_columns.has_value()) {
 559       output()->print_cr("Cannot specify -all and individual columns at the same time");
 560       return;
 561     } else {
 562       heapop.set_columns(NULL);
 563     }
 564   } else {
 565     if (_columns.has_value()) {
 566       heapop.set_columns(_columns.value());
 567     } else {
 568       heapop.set_columns(DEFAULT_COLUMNS);
 569     }
 570   }
 571   VMThread::execute(&heapop);
 572 }
 573 
 574 int ClassStatsDCmd::num_arguments() {
 575   ResourceMark rm;
 576   ClassStatsDCmd* dcmd = new ClassStatsDCmd(NULL, false);
 577   if (dcmd != NULL) {
 578     DCmdMark mark(dcmd);
 579     return dcmd->_dcmdparser.num_arguments();
 580   } else {
 581     return 0;
 582   }
 583 }
 584 #endif // INCLUDE_SERVICES
 585 
 586 ThreadDumpDCmd::ThreadDumpDCmd(outputStream* output, bool heap) :
 587                                DCmdWithParser(output, heap),
 588   _locks("-l", "print java.util.concurrent locks", "BOOLEAN", false, "false") {
 589   _dcmdparser.add_dcmd_option(&_locks);
 590 }
 591 
 592 void ThreadDumpDCmd::execute(DCmdSource source, TRAPS) {
 593   // thread stacks
 594   VM_PrintThreads op1(output(), _locks.value());
 595   VMThread::execute(&op1);
 596 
 597   // JNI global handles
 598   VM_PrintJNI op2(output());
 599   VMThread::execute(&op2);
 600 
 601   // Deadlock detection
 602   VM_FindDeadlocks op3(output());
 603   VMThread::execute(&op3);
 604 }
 605 
 606 int ThreadDumpDCmd::num_arguments() {
 607   ResourceMark rm;
 608   ThreadDumpDCmd* dcmd = new ThreadDumpDCmd(NULL, false);
 609   if (dcmd != NULL) {
 610     DCmdMark mark(dcmd);
 611     return dcmd->_dcmdparser.num_arguments();
 612   } else {
 613     return 0;
 614   }
 615 }
 616 
 617 // Enhanced JMX Agent support
 618 
 619 JMXStartRemoteDCmd::JMXStartRemoteDCmd(outputStream *output, bool heap_allocated) :
 620 
 621   DCmdWithParser(output, heap_allocated),
 622 
 623   _config_file
 624   ("config.file",
 625    "set com.sun.management.config.file", "STRING", false),
 626 
 627   _jmxremote_host
 628   ("jmxremote.host",
 629    "set com.sun.management.jmxremote.host", "STRING", false),
 630 
 631   _jmxremote_port
 632   ("jmxremote.port",
 633    "set com.sun.management.jmxremote.port", "STRING", false),
 634 
 635   _jmxremote_rmi_port
 636   ("jmxremote.rmi.port",
 637    "set com.sun.management.jmxremote.rmi.port", "STRING", false),
 638 
 639   _jmxremote_ssl
 640   ("jmxremote.ssl",
 641    "set com.sun.management.jmxremote.ssl", "STRING", false),
 642 
 643   _jmxremote_registry_ssl
 644   ("jmxremote.registry.ssl",
 645    "set com.sun.management.jmxremote.registry.ssl", "STRING", false),
 646 
 647   _jmxremote_authenticate
 648   ("jmxremote.authenticate",
 649    "set com.sun.management.jmxremote.authenticate", "STRING", false),
 650 
 651   _jmxremote_password_file
 652   ("jmxremote.password.file",
 653    "set com.sun.management.jmxremote.password.file", "STRING", false),
 654 
 655   _jmxremote_access_file
 656   ("jmxremote.access.file",
 657    "set com.sun.management.jmxremote.access.file", "STRING", false),
 658 
 659   _jmxremote_login_config
 660   ("jmxremote.login.config",
 661    "set com.sun.management.jmxremote.login.config", "STRING", false),
 662 
 663   _jmxremote_ssl_enabled_cipher_suites
 664   ("jmxremote.ssl.enabled.cipher.suites",
 665    "set com.sun.management.jmxremote.ssl.enabled.cipher.suite", "STRING", false),
 666 
 667   _jmxremote_ssl_enabled_protocols
 668   ("jmxremote.ssl.enabled.protocols",
 669    "set com.sun.management.jmxremote.ssl.enabled.protocols", "STRING", false),
 670 
 671   _jmxremote_ssl_need_client_auth
 672   ("jmxremote.ssl.need.client.auth",
 673    "set com.sun.management.jmxremote.need.client.auth", "STRING", false),
 674 
 675   _jmxremote_ssl_config_file
 676   ("jmxremote.ssl.config.file",
 677    "set com.sun.management.jmxremote.ssl_config_file", "STRING", false),
 678 
 679 // JDP Protocol support
 680   _jmxremote_autodiscovery
 681   ("jmxremote.autodiscovery",
 682    "set com.sun.management.jmxremote.autodiscovery", "STRING", false),
 683 
 684    _jdp_port
 685   ("jdp.port",
 686    "set com.sun.management.jdp.port", "INT", false),
 687 
 688    _jdp_address
 689   ("jdp.address",
 690    "set com.sun.management.jdp.address", "STRING", false),
 691 
 692    _jdp_source_addr
 693   ("jdp.source_addr",
 694    "set com.sun.management.jdp.source_addr", "STRING", false),
 695 
 696    _jdp_ttl
 697   ("jdp.ttl",
 698    "set com.sun.management.jdp.ttl", "INT", false),
 699 
 700    _jdp_pause
 701   ("jdp.pause",
 702    "set com.sun.management.jdp.pause", "INT", false),
 703 
 704    _jdp_name
 705   ("jdp.name",
 706    "set com.sun.management.jdp.name", "STRING", false)
 707 
 708   {
 709     _dcmdparser.add_dcmd_option(&_config_file);
 710     _dcmdparser.add_dcmd_option(&_jmxremote_host);
 711     _dcmdparser.add_dcmd_option(&_jmxremote_port);
 712     _dcmdparser.add_dcmd_option(&_jmxremote_rmi_port);
 713     _dcmdparser.add_dcmd_option(&_jmxremote_ssl);
 714     _dcmdparser.add_dcmd_option(&_jmxremote_registry_ssl);
 715     _dcmdparser.add_dcmd_option(&_jmxremote_authenticate);
 716     _dcmdparser.add_dcmd_option(&_jmxremote_password_file);
 717     _dcmdparser.add_dcmd_option(&_jmxremote_access_file);
 718     _dcmdparser.add_dcmd_option(&_jmxremote_login_config);
 719     _dcmdparser.add_dcmd_option(&_jmxremote_ssl_enabled_cipher_suites);
 720     _dcmdparser.add_dcmd_option(&_jmxremote_ssl_enabled_protocols);
 721     _dcmdparser.add_dcmd_option(&_jmxremote_ssl_need_client_auth);
 722     _dcmdparser.add_dcmd_option(&_jmxremote_ssl_config_file);
 723     _dcmdparser.add_dcmd_option(&_jmxremote_autodiscovery);
 724     _dcmdparser.add_dcmd_option(&_jdp_port);
 725     _dcmdparser.add_dcmd_option(&_jdp_address);
 726     _dcmdparser.add_dcmd_option(&_jdp_source_addr);
 727     _dcmdparser.add_dcmd_option(&_jdp_ttl);
 728     _dcmdparser.add_dcmd_option(&_jdp_pause);
 729     _dcmdparser.add_dcmd_option(&_jdp_name);
 730 }
 731 
 732 
 733 int JMXStartRemoteDCmd::num_arguments() {
 734   ResourceMark rm;
 735   JMXStartRemoteDCmd* dcmd = new JMXStartRemoteDCmd(NULL, false);
 736   if (dcmd != NULL) {
 737     DCmdMark mark(dcmd);
 738     return dcmd->_dcmdparser.num_arguments();
 739   } else {
 740     return 0;
 741   }
 742 }
 743 
 744 
 745 void JMXStartRemoteDCmd::execute(DCmdSource source, TRAPS) {
 746     ResourceMark rm(THREAD);
 747     HandleMark hm(THREAD);
 748 
 749     // Load and initialize the jdk.internal.agent.Agent class
 750     // invoke startRemoteManagementAgent(string) method to start
 751     // the remote management server.
 752     // throw java.lang.NoSuchMethodError if the method doesn't exist
 753 
 754     Handle loader = Handle(THREAD, SystemDictionary::java_system_loader());
 755     Klass* k = SystemDictionary::resolve_or_fail(vmSymbols::jdk_internal_agent_Agent(), loader, Handle(), true, CHECK);
 756     instanceKlassHandle ik (THREAD, k);
 757 
 758     JavaValue result(T_VOID);
 759 
 760     // Pass all command line arguments to java as key=value,...
 761     // All checks are done on java side
 762 
 763     int len = 0;
 764     stringStream options;
 765     char comma[2] = {0,0};
 766 
 767     // Leave default values on Agent.class side and pass only
 768     // agruments explicitly set by user. All arguments passed
 769     // to jcmd override properties with the same name set by
 770     // command line with -D or by managmenent.properties
 771     // file.
 772 #define PUT_OPTION(a) \
 773     do { \
 774         if ( (a).is_set() ){ \
 775             if ( *((a).type()) == 'I' ) { \
 776                 options.print("%scom.sun.management.%s=" JLONG_FORMAT, comma, (a).name(), (jlong)((a).value())); \
 777             } else { \
 778                 options.print("%scom.sun.management.%s=%s", comma, (a).name(), (char*)((a).value())); \
 779             } \
 780             comma[0] = ','; \
 781         }\
 782     } while(0);
 783 
 784 
 785     PUT_OPTION(_config_file);
 786     PUT_OPTION(_jmxremote_host);
 787     PUT_OPTION(_jmxremote_port);
 788     PUT_OPTION(_jmxremote_rmi_port);
 789     PUT_OPTION(_jmxremote_ssl);
 790     PUT_OPTION(_jmxremote_registry_ssl);
 791     PUT_OPTION(_jmxremote_authenticate);
 792     PUT_OPTION(_jmxremote_password_file);
 793     PUT_OPTION(_jmxremote_access_file);
 794     PUT_OPTION(_jmxremote_login_config);
 795     PUT_OPTION(_jmxremote_ssl_enabled_cipher_suites);
 796     PUT_OPTION(_jmxremote_ssl_enabled_protocols);
 797     PUT_OPTION(_jmxremote_ssl_need_client_auth);
 798     PUT_OPTION(_jmxremote_ssl_config_file);
 799     PUT_OPTION(_jmxremote_autodiscovery);
 800     PUT_OPTION(_jdp_port);
 801     PUT_OPTION(_jdp_address);
 802     PUT_OPTION(_jdp_source_addr);
 803     PUT_OPTION(_jdp_ttl);
 804     PUT_OPTION(_jdp_pause);
 805     PUT_OPTION(_jdp_name);
 806 
 807 #undef PUT_OPTION
 808 
 809     Handle str = java_lang_String::create_from_str(options.as_string(), CHECK);
 810     JavaCalls::call_static(&result, ik, vmSymbols::startRemoteAgent_name(), vmSymbols::string_void_signature(), str, CHECK);
 811 }
 812 
 813 JMXStartLocalDCmd::JMXStartLocalDCmd(outputStream *output, bool heap_allocated) :
 814   DCmd(output, heap_allocated) {
 815   // do nothing
 816 }
 817 
 818 void JMXStartLocalDCmd::execute(DCmdSource source, TRAPS) {
 819     ResourceMark rm(THREAD);
 820     HandleMark hm(THREAD);
 821 
 822     // Load and initialize the jdk.internal.agent.Agent class
 823     // invoke startLocalManagementAgent(void) method to start
 824     // the local management server
 825     // throw java.lang.NoSuchMethodError if method doesn't exist
 826 
 827     Handle loader = Handle(THREAD, SystemDictionary::java_system_loader());
 828     Klass* k = SystemDictionary::resolve_or_fail(vmSymbols::jdk_internal_agent_Agent(), loader, Handle(), true, CHECK);
 829     instanceKlassHandle ik (THREAD, k);
 830 
 831     JavaValue result(T_VOID);
 832     JavaCalls::call_static(&result, ik, vmSymbols::startLocalAgent_name(), vmSymbols::void_method_signature(), CHECK);
 833 }
 834 
 835 void JMXStopRemoteDCmd::execute(DCmdSource source, TRAPS) {
 836     ResourceMark rm(THREAD);
 837     HandleMark hm(THREAD);
 838 
 839     // Load and initialize the jdk.internal.agent.Agent class
 840     // invoke stopRemoteManagementAgent method to stop the
 841     // management server
 842     // throw java.lang.NoSuchMethodError if method doesn't exist
 843 
 844     Handle loader = Handle(THREAD, SystemDictionary::java_system_loader());
 845     Klass* k = SystemDictionary::resolve_or_fail(vmSymbols::jdk_internal_agent_Agent(), loader, Handle(), true, CHECK);
 846     instanceKlassHandle ik (THREAD, k);
 847 
 848     JavaValue result(T_VOID);
 849     JavaCalls::call_static(&result, ik, vmSymbols::stopRemoteAgent_name(), vmSymbols::void_method_signature(), CHECK);
 850 }
 851 
 852 JMXStatusDCmd::JMXStatusDCmd(outputStream *output, bool heap_allocated) :
 853   DCmd(output, heap_allocated) {
 854   // do nothing
 855 }
 856 
 857 void JMXStatusDCmd::execute(DCmdSource source, TRAPS) {
 858   ResourceMark rm(THREAD);
 859   HandleMark hm(THREAD);
 860 
 861   // Load and initialize the jdk.internal.agent.Agent class
 862   // invoke getManagementAgentStatus() method to generate the status info
 863   // throw java.lang.NoSuchMethodError if method doesn't exist
 864 
 865   Handle loader = Handle(THREAD, SystemDictionary::java_system_loader());
 866   Klass* k = SystemDictionary::resolve_or_fail(vmSymbols::jdk_internal_agent_Agent(), loader, Handle(), true, CHECK);
 867   instanceKlassHandle ik (THREAD, k);
 868 
 869   JavaValue result(T_OBJECT);
 870   JavaCalls::call_static(&result, ik, vmSymbols::getAgentStatus_name(), vmSymbols::void_string_signature(), CHECK);
 871 
 872   jvalue* jv = (jvalue*) result.get_value_addr();
 873   oop str = (oop) jv->l;
 874   if (str != NULL) {
 875       char* out = java_lang_String::as_utf8_string(str);
 876       if (out) {
 877           output()->print_cr("%s", out);
 878           return;
 879       }
 880   }
 881   output()->print_cr("Error obtaining management agent status");
 882 }
 883 
 884 VMDynamicLibrariesDCmd::VMDynamicLibrariesDCmd(outputStream *output, bool heap_allocated) :
 885   DCmd(output, heap_allocated) {
 886   // do nothing
 887 }
 888 
 889 void VMDynamicLibrariesDCmd::execute(DCmdSource source, TRAPS) {
 890   os::print_dll_info(output());
 891   output()->cr();
 892 }
 893 
 894 void CompileQueueDCmd::execute(DCmdSource source, TRAPS) {
 895   VM_PrintCompileQueue printCompileQueueOp(output());
 896   VMThread::execute(&printCompileQueueOp);
 897 }
 898 
 899 void CodeListDCmd::execute(DCmdSource source, TRAPS) {
 900   CodeCache::print_codelist(output());
 901 }
 902 
 903 void CodeCacheDCmd::execute(DCmdSource source, TRAPS) {
 904   CodeCache::print_layout(output());
 905 }
 906 
 907 void CompilerDirectivesPrintDCmd::execute(DCmdSource source, TRAPS) {
 908   DirectivesStack::print(output());
 909 }
 910 
 911 CompilerDirectivesAddDCmd::CompilerDirectivesAddDCmd(outputStream* output, bool heap) :
 912                            DCmdWithParser(output, heap),
 913   _filename("filename","Name of the directives file", "STRING",true) {
 914   _dcmdparser.add_dcmd_argument(&_filename);
 915 }
 916 
 917 void CompilerDirectivesAddDCmd::execute(DCmdSource source, TRAPS) {
 918   DirectivesParser::parse_from_file(_filename.value(), output());
 919 }
 920 
 921 int CompilerDirectivesAddDCmd::num_arguments() {
 922   ResourceMark rm;
 923   CompilerDirectivesAddDCmd* dcmd = new CompilerDirectivesAddDCmd(NULL, false);
 924   if (dcmd != NULL) {
 925     DCmdMark mark(dcmd);
 926     return dcmd->_dcmdparser.num_arguments();
 927   } else {
 928     return 0;
 929   }
 930 }
 931 
 932 void CompilerDirectivesRemoveDCmd::execute(DCmdSource source, TRAPS) {
 933   DirectivesStack::pop(1);
 934 }
 935 
 936 void CompilerDirectivesClearDCmd::execute(DCmdSource source, TRAPS) {
 937   DirectivesStack::clear();
 938 }
 939 #if INCLUDE_SERVICES
 940 ClassHierarchyDCmd::ClassHierarchyDCmd(outputStream* output, bool heap) :
 941                                        DCmdWithParser(output, heap),
 942   _print_interfaces("-i", "Inherited interfaces should be printed.", "BOOLEAN", false, "false"),
 943   _print_subclasses("-s", "If a classname is specified, print its subclasses. "
 944                     "Otherwise only its superclasses are printed.", "BOOLEAN", false, "false"),
 945   _classname("classname", "Name of class whose hierarchy should be printed. "
 946              "If not specified, all class hierarchies are printed.",
 947              "STRING", false) {
 948   _dcmdparser.add_dcmd_option(&_print_interfaces);
 949   _dcmdparser.add_dcmd_option(&_print_subclasses);
 950   _dcmdparser.add_dcmd_argument(&_classname);
 951 }
 952 
 953 void ClassHierarchyDCmd::execute(DCmdSource source, TRAPS) {
 954   VM_PrintClassHierarchy printClassHierarchyOp(output(), _print_interfaces.value(),
 955                                                _print_subclasses.value(), _classname.value());
 956   VMThread::execute(&printClassHierarchyOp);
 957 }
 958 
 959 int ClassHierarchyDCmd::num_arguments() {
 960   ResourceMark rm;
 961   ClassHierarchyDCmd* dcmd = new ClassHierarchyDCmd(NULL, false);
 962   if (dcmd != NULL) {
 963     DCmdMark mark(dcmd);
 964     return dcmd->_dcmdparser.num_arguments();
 965   } else {
 966     return 0;
 967   }
 968 }
 969 
 970 #endif
 971 
 972 class VM_DumpTouchedMethods : public VM_Operation {
 973 private:
 974   outputStream* _out;
 975 public:
 976   VM_DumpTouchedMethods(outputStream* out) {
 977     _out = out;
 978   }
 979 
 980   virtual VMOp_Type type() const { return VMOp_DumpTouchedMethods; }
 981 
 982   virtual void doit() {
 983     Method::print_touched_methods(_out);
 984   }
 985 };
 986 
 987 TouchedMethodsDCmd::TouchedMethodsDCmd(outputStream* output, bool heap) :
 988                                        DCmdWithParser(output, heap)
 989 {}
 990 
 991 void TouchedMethodsDCmd::execute(DCmdSource source, TRAPS) {
 992   if (!LogTouchedMethods) {
 993     output()->print_cr("VM.print_touched_methods command requires -XX:+LogTouchedMethods");
 994     return;
 995   }
 996   VM_DumpTouchedMethods dumper(output());
 997   VMThread::execute(&dumper);
 998 }
 999 
1000 int TouchedMethodsDCmd::num_arguments() {
1001   return 0;
1002 }