1 /* 2 * Copyright (c) 2011, 2012, 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 "gc_implementation/shared/vmGCOperations.hpp" 27 #include "runtime/javaCalls.hpp" 28 #include "services/diagnosticArgument.hpp" 29 #include "services/diagnosticCommand.hpp" 30 #include "services/diagnosticFramework.hpp" 31 #include "services/heapDumper.hpp" 32 #include "services/management.hpp" 33 34 void DCmdRegistrant::register_dcmds(){ 35 // Registration of the diagnostic commands 36 // First boolean argument specifies if the command is enabled 37 // Second boolean argument specifies if the command is hidden 38 DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<HelpDCmd>(true, false)); 39 DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<VersionDCmd>(true, false)); 40 DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<CommandLineDCmd>(true, false)); 41 DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<PrintSystemPropertiesDCmd>(true, false)); 42 DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<PrintVMFlagsDCmd>(true, false)); 43 DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<VMUptimeDCmd>(true, false)); 44 DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<SystemGCDCmd>(true, false)); 45 DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<RunFinalizationDCmd>(true, false)); 46 #if INCLUDE_SERVICES // Heap dumping supported 47 DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<HeapDumpDCmd>(true, false)); 48 #endif // INCLUDE_SERVICES 49 DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<ClassHistogramDCmd>(true, false)); 50 DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<ThreadDumpDCmd>(true, false)); 51 52 //Enhanced JMX Agent Support 53 DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<JMXStartRemoteDCmd>(true,false)); 54 DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<JMXStartLocalDCmd>(true,false)); 55 DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<JMXStopRemoteDCmd>(true,false)); 56 57 } 58 59 #ifndef HAVE_EXTRA_DCMD 60 void DCmdRegistrant::register_dcmds_ext(){ 61 // Do nothing here 62 } 63 #endif 64 65 66 HelpDCmd::HelpDCmd(outputStream* output, bool heap) : DCmdWithParser(output, heap), 67 _all("-all", "Show help for all commands", "BOOLEAN", false, "false"), 68 _cmd("command name", "The name of the command for which we want help", 69 "STRING", false) { 70 _dcmdparser.add_dcmd_option(&_all); 71 _dcmdparser.add_dcmd_argument(&_cmd); 72 }; 73 74 void HelpDCmd::execute(TRAPS) { 75 if (_all.value()) { 76 GrowableArray<const char*>* cmd_list = DCmdFactory::DCmd_list(); 77 for (int i = 0; i < cmd_list->length(); i++) { 78 DCmdFactory* factory = DCmdFactory::factory(cmd_list->at(i), 79 strlen(cmd_list->at(i))); 80 if (!factory->is_hidden()) { 81 output()->print_cr("%s%s", factory->name(), 82 factory->is_enabled() ? "" : " [disabled]"); 83 output()->print_cr("\t%s", factory->description()); 84 output()->cr(); 85 } 86 factory = factory->next(); 87 } 88 } else if (_cmd.has_value()) { 89 DCmd* cmd = NULL; 90 DCmdFactory* factory = DCmdFactory::factory(_cmd.value(), 91 strlen(_cmd.value())); 92 if (factory != NULL) { 93 output()->print_cr("%s%s", factory->name(), 94 factory->is_enabled() ? "" : " [disabled]"); 95 output()->print_cr(factory->description()); 96 output()->print_cr("\nImpact: %s", factory->impact()); 97 output()->cr(); 98 cmd = factory->create_resource_instance(output()); 99 if (cmd != NULL) { 100 DCmdMark mark(cmd); 101 cmd->print_help(factory->name()); 102 } 103 } else { 104 output()->print_cr("Help unavailable : '%s' : No such command", _cmd.value()); 105 } 106 } else { 107 output()->print_cr("The following commands are available:"); 108 GrowableArray<const char *>* cmd_list = DCmdFactory::DCmd_list(); 109 for (int i = 0; i < cmd_list->length(); i++) { 110 DCmdFactory* factory = DCmdFactory::factory(cmd_list->at(i), 111 strlen(cmd_list->at(i))); 112 if (!factory->is_hidden()) { 113 output()->print_cr("%s%s", factory->name(), 114 factory->is_enabled() ? "" : " [disabled]"); 115 } 116 factory = factory->_next; 117 } 118 output()->print_cr("\nFor more information about a specific command use 'help <command>'."); 119 } 120 } 121 122 int HelpDCmd::num_arguments() { 123 ResourceMark rm; 124 HelpDCmd* dcmd = new HelpDCmd(NULL, false); 125 if (dcmd != NULL) { 126 DCmdMark mark(dcmd); 127 return dcmd->_dcmdparser.num_arguments(); 128 } else { 129 return 0; 130 } 131 } 132 133 void VersionDCmd::execute(TRAPS) { 134 output()->print_cr("%s version %s", Abstract_VM_Version::vm_name(), 135 Abstract_VM_Version::vm_release()); 136 JDK_Version jdk_version = JDK_Version::current(); 137 if (jdk_version.update_version() > 0) { 138 output()->print_cr("JDK %d.%d_%02d", jdk_version.major_version(), 139 jdk_version.minor_version(), jdk_version.update_version()); 140 } else { 141 output()->print_cr("JDK %d.%d", jdk_version.major_version(), 142 jdk_version.minor_version()); 143 } 144 } 145 146 PrintVMFlagsDCmd::PrintVMFlagsDCmd(outputStream* output, bool heap) : 147 DCmdWithParser(output, heap), 148 _all("-all", "Print all flags supported by the VM", "BOOLEAN", false, "false") { 149 _dcmdparser.add_dcmd_option(&_all); 150 } 151 152 void PrintVMFlagsDCmd::execute(TRAPS) { 153 if (_all.value()) { 154 CommandLineFlags::printFlags(output(), true); 155 } else { 156 CommandLineFlags::printSetFlags(output()); 157 } 158 } 159 160 int PrintVMFlagsDCmd::num_arguments() { 161 ResourceMark rm; 162 PrintVMFlagsDCmd* dcmd = new PrintVMFlagsDCmd(NULL, false); 163 if (dcmd != NULL) { 164 DCmdMark mark(dcmd); 165 return dcmd->_dcmdparser.num_arguments(); 166 } else { 167 return 0; 168 } 169 } 170 171 void PrintSystemPropertiesDCmd::execute(TRAPS) { 172 // load sun.misc.VMSupport 173 Symbol* klass = vmSymbols::sun_misc_VMSupport(); 174 Klass* k = SystemDictionary::resolve_or_fail(klass, true, CHECK); 175 instanceKlassHandle ik (THREAD, k); 176 if (ik->should_be_initialized()) { 177 ik->initialize(THREAD); 178 } 179 if (HAS_PENDING_EXCEPTION) { 180 java_lang_Throwable::print(PENDING_EXCEPTION, output()); 181 output()->cr(); 182 CLEAR_PENDING_EXCEPTION; 183 return; 184 } 185 186 // invoke the serializePropertiesToByteArray method 187 JavaValue result(T_OBJECT); 188 JavaCallArguments args; 189 190 Symbol* signature = vmSymbols::serializePropertiesToByteArray_signature(); 191 JavaCalls::call_static(&result, 192 ik, 193 vmSymbols::serializePropertiesToByteArray_name(), 194 signature, 195 &args, 196 THREAD); 197 if (HAS_PENDING_EXCEPTION) { 198 java_lang_Throwable::print(PENDING_EXCEPTION, output()); 199 output()->cr(); 200 CLEAR_PENDING_EXCEPTION; 201 return; 202 } 203 204 // The result should be a [B 205 oop res = (oop)result.get_jobject(); 206 assert(res->is_typeArray(), "just checking"); 207 assert(typeArrayKlass::cast(res->klass())->element_type() == T_BYTE, "just checking"); 208 209 // copy the bytes to the output stream 210 typeArrayOop ba = typeArrayOop(res); 211 jbyte* addr = typeArrayOop(res)->byte_at_addr(0); 212 output()->print_raw((const char*)addr, ba->length()); 213 } 214 215 VMUptimeDCmd::VMUptimeDCmd(outputStream* output, bool heap) : 216 DCmdWithParser(output, heap), 217 _date("-date", "Add a prefix with current date", "BOOLEAN", false, "false") { 218 _dcmdparser.add_dcmd_option(&_date); 219 } 220 221 void VMUptimeDCmd::execute(TRAPS) { 222 if (_date.value()) { 223 output()->date_stamp(true, "", ": "); 224 } 225 output()->time_stamp().update_to(tty->time_stamp().ticks()); 226 output()->stamp(); 227 output()->print_cr(" s"); 228 } 229 230 int VMUptimeDCmd::num_arguments() { 231 ResourceMark rm; 232 VMUptimeDCmd* dcmd = new VMUptimeDCmd(NULL, false); 233 if (dcmd != NULL) { 234 DCmdMark mark(dcmd); 235 return dcmd->_dcmdparser.num_arguments(); 236 } else { 237 return 0; 238 } 239 } 240 241 void SystemGCDCmd::execute(TRAPS) { 242 Universe::heap()->collect(GCCause::_java_lang_system_gc); 243 } 244 245 void RunFinalizationDCmd::execute(TRAPS) { 246 Klass* k = SystemDictionary::resolve_or_fail(vmSymbols::java_lang_System(), 247 true, CHECK); 248 instanceKlassHandle klass(THREAD, k); 249 JavaValue result(T_VOID); 250 JavaCalls::call_static(&result, klass, 251 vmSymbols::run_finalization_name(), 252 vmSymbols::void_method_signature(), CHECK); 253 } 254 255 #if INCLUDE_SERVICES // Heap dumping supported 256 HeapDumpDCmd::HeapDumpDCmd(outputStream* output, bool heap) : 257 DCmdWithParser(output, heap), 258 _filename("filename","Name of the dump file", "STRING",true), 259 _all("-all", "Dump all objects, including unreachable objects", 260 "BOOLEAN", false, "false") { 261 _dcmdparser.add_dcmd_option(&_all); 262 _dcmdparser.add_dcmd_argument(&_filename); 263 } 264 265 void HeapDumpDCmd::execute(TRAPS) { 266 // Request a full GC before heap dump if _all is false 267 // This helps reduces the amount of unreachable objects in the dump 268 // and makes it easier to browse. 269 HeapDumper dumper(!_all.value() /* request GC if _all is false*/); 270 int res = dumper.dump(_filename.value()); 271 if (res == 0) { 272 output()->print_cr("Heap dump file created"); 273 } else { 274 // heap dump failed 275 ResourceMark rm; 276 char* error = dumper.error_as_C_string(); 277 if (error == NULL) { 278 output()->print_cr("Dump failed - reason unknown"); 279 } else { 280 output()->print_cr("%s", error); 281 } 282 } 283 } 284 285 int HeapDumpDCmd::num_arguments() { 286 ResourceMark rm; 287 HeapDumpDCmd* dcmd = new HeapDumpDCmd(NULL, false); 288 if (dcmd != NULL) { 289 DCmdMark mark(dcmd); 290 return dcmd->_dcmdparser.num_arguments(); 291 } else { 292 return 0; 293 } 294 } 295 #endif // INCLUDE_SERVICES 296 297 ClassHistogramDCmd::ClassHistogramDCmd(outputStream* output, bool heap) : 298 DCmdWithParser(output, heap), 299 _all("-all", "Inspect all objects, including unreachable objects", 300 "BOOLEAN", false, "false") { 301 _dcmdparser.add_dcmd_option(&_all); 302 } 303 304 void ClassHistogramDCmd::execute(TRAPS) { 305 VM_GC_HeapInspection heapop(output(), 306 !_all.value() /* request full gc if false */, 307 true /* need_prologue */); 308 VMThread::execute(&heapop); 309 } 310 311 int ClassHistogramDCmd::num_arguments() { 312 ResourceMark rm; 313 ClassHistogramDCmd* dcmd = new ClassHistogramDCmd(NULL, false); 314 if (dcmd != NULL) { 315 DCmdMark mark(dcmd); 316 return dcmd->_dcmdparser.num_arguments(); 317 } else { 318 return 0; 319 } 320 } 321 322 ThreadDumpDCmd::ThreadDumpDCmd(outputStream* output, bool heap) : 323 DCmdWithParser(output, heap), 324 _locks("-l", "print java.util.concurrent locks", "BOOLEAN", false, "false") { 325 _dcmdparser.add_dcmd_option(&_locks); 326 } 327 328 void ThreadDumpDCmd::execute(TRAPS) { 329 // thread stacks 330 VM_PrintThreads op1(output(), _locks.value()); 331 VMThread::execute(&op1); 332 333 // JNI global handles 334 VM_PrintJNI op2(output()); 335 VMThread::execute(&op2); 336 337 // Deadlock detection 338 VM_FindDeadlocks op3(output()); 339 VMThread::execute(&op3); 340 } 341 342 int ThreadDumpDCmd::num_arguments() { 343 ResourceMark rm; 344 ThreadDumpDCmd* dcmd = new ThreadDumpDCmd(NULL, false); 345 if (dcmd != NULL) { 346 DCmdMark mark(dcmd); 347 return dcmd->_dcmdparser.num_arguments(); 348 } else { 349 return 0; 350 } 351 } 352 353 // Enhanced JMX Agent support 354 355 JMXStartRemoteDCmd::JMXStartRemoteDCmd(outputStream *output, bool heap_allocated) : 356 357 DCmdWithParser(output, heap_allocated), 358 359 _config_file 360 ("config.file", 361 "set com.sun.management.config.file", "STRING", false), 362 363 _jmxremote_port 364 ("jmxremote.port", 365 "set com.sun.management.jmxremote.port", "STRING", false), 366 367 _jmxremote_rmi_port 368 ("jmxremote.rmi.port", 369 "set com.sun.management.jmxremote.rmi.port", "STRING", false), 370 371 _jmxremote_ssl 372 ("jmxremote.ssl", 373 "set com.sun.management.jmxremote.ssl", "STRING", false), 374 375 _jmxremote_registry_ssl 376 ("jmxremote.registry.ssl", 377 "set com.sun.management.jmxremote.registry.ssl", "STRING", false), 378 379 _jmxremote_authenticate 380 ("jmxremote.authenticate", 381 "set com.sun.management.jmxremote.authenticate", "STRING", false), 382 383 _jmxremote_password_file 384 ("jmxremote.password.file", 385 "set com.sun.management.jmxremote.password.file", "STRING", false), 386 387 _jmxremote_access_file 388 ("jmxremote.access.file", 389 "set com.sun.management.jmxremote.access.file", "STRING", false), 390 391 _jmxremote_login_config 392 ("jmxremote.login.config", 393 "set com.sun.management.jmxremote.login.config", "STRING", false), 394 395 _jmxremote_ssl_enabled_cipher_suites 396 ("jmxremote.ssl.enabled.cipher.suites", 397 "set com.sun.management.jmxremote.ssl.enabled.cipher.suite", "STRING", false), 398 399 _jmxremote_ssl_enabled_protocols 400 ("jmxremote.ssl.enabled.protocols", 401 "set com.sun.management.jmxremote.ssl.enabled.protocols", "STRING", false), 402 403 _jmxremote_ssl_need_client_auth 404 ("jmxremote.ssl.need.client.auth", 405 "set com.sun.management.jmxremote.need.client.auth", "STRING", false), 406 407 _jmxremote_ssl_config_file 408 ("jmxremote.ssl.config.file", 409 "set com.sun.management.jmxremote.ssl_config_file", "STRING", false) 410 411 { 412 _dcmdparser.add_dcmd_option(&_config_file); 413 _dcmdparser.add_dcmd_option(&_jmxremote_port); 414 _dcmdparser.add_dcmd_option(&_jmxremote_rmi_port); 415 _dcmdparser.add_dcmd_option(&_jmxremote_ssl); 416 _dcmdparser.add_dcmd_option(&_jmxremote_registry_ssl); 417 _dcmdparser.add_dcmd_option(&_jmxremote_authenticate); 418 _dcmdparser.add_dcmd_option(&_jmxremote_password_file); 419 _dcmdparser.add_dcmd_option(&_jmxremote_access_file); 420 _dcmdparser.add_dcmd_option(&_jmxremote_login_config); 421 _dcmdparser.add_dcmd_option(&_jmxremote_ssl_enabled_cipher_suites); 422 _dcmdparser.add_dcmd_option(&_jmxremote_ssl_enabled_protocols); 423 _dcmdparser.add_dcmd_option(&_jmxremote_ssl_need_client_auth); 424 _dcmdparser.add_dcmd_option(&_jmxremote_ssl_config_file); 425 } 426 427 428 int JMXStartRemoteDCmd::num_arguments() { 429 ResourceMark rm; 430 JMXStartRemoteDCmd* dcmd = new JMXStartRemoteDCmd(NULL, false); 431 if (dcmd != NULL) { 432 DCmdMark mark(dcmd); 433 return dcmd->_dcmdparser.num_arguments(); 434 } else { 435 return 0; 436 } 437 } 438 439 440 void JMXStartRemoteDCmd::execute(TRAPS) { 441 ResourceMark rm(THREAD); 442 HandleMark hm(THREAD); 443 444 // Load and initialize the sun.management.Agent class 445 // invoke startRemoteManagementAgent(string) method to start 446 // the remote management server. 447 // throw java.lang.NoSuchMethodError if the method doesn't exist 448 449 Handle loader = Handle(THREAD, SystemDictionary::java_system_loader()); 450 Klass* k = SystemDictionary::resolve_or_fail(vmSymbols::sun_management_Agent(), loader, Handle(), true, CHECK); 451 instanceKlassHandle ik (THREAD, k); 452 453 JavaValue result(T_VOID); 454 455 // Pass all command line arguments to java as key=value,... 456 // All checks are done on java side 457 458 int len = 0; 459 stringStream options; 460 char comma[2] = {0,0}; 461 462 // Leave default values on Agent.class side and pass only 463 // agruments explicitly set by user. All arguments passed 464 // to jcmd override properties with the same name set by 465 // command line with -D or by managmenent.properties 466 // file. 467 #define PUT_OPTION(a) \ 468 if ( (a).is_set() ){ \ 469 options.print("%scom.sun.management.%s=%s", comma, (a).name(), (a).value()); \ 470 comma[0] = ','; \ 471 } 472 473 PUT_OPTION(_config_file); 474 PUT_OPTION(_jmxremote_port); 475 PUT_OPTION(_jmxremote_rmi_port); 476 PUT_OPTION(_jmxremote_ssl); 477 PUT_OPTION(_jmxremote_registry_ssl); 478 PUT_OPTION(_jmxremote_authenticate); 479 PUT_OPTION(_jmxremote_password_file); 480 PUT_OPTION(_jmxremote_access_file); 481 PUT_OPTION(_jmxremote_login_config); 482 PUT_OPTION(_jmxremote_ssl_enabled_cipher_suites); 483 PUT_OPTION(_jmxremote_ssl_enabled_protocols); 484 PUT_OPTION(_jmxremote_ssl_need_client_auth); 485 PUT_OPTION(_jmxremote_ssl_config_file); 486 487 #undef PUT_OPTION 488 489 Handle str = java_lang_String::create_from_str(options.as_string(), CHECK); 490 JavaCalls::call_static(&result, ik, vmSymbols::startRemoteAgent_name(), vmSymbols::string_void_signature(), str, CHECK); 491 } 492 493 JMXStartLocalDCmd::JMXStartLocalDCmd(outputStream *output, bool heap_allocated) : 494 DCmd(output, heap_allocated) 495 { 496 // do nothing 497 } 498 499 void JMXStartLocalDCmd::execute(TRAPS) { 500 ResourceMark rm(THREAD); 501 HandleMark hm(THREAD); 502 503 // Load and initialize the sun.management.Agent class 504 // invoke startLocalManagementAgent(void) method to start 505 // the local management server 506 // throw java.lang.NoSuchMethodError if method doesn't exist 507 508 Handle loader = Handle(THREAD, SystemDictionary::java_system_loader()); 509 Klass* k = SystemDictionary::resolve_or_fail(vmSymbols::sun_management_Agent(), loader, Handle(), true, CHECK); 510 instanceKlassHandle ik (THREAD, k); 511 512 JavaValue result(T_VOID); 513 JavaCalls::call_static(&result, ik, vmSymbols::startLocalAgent_name(), vmSymbols::void_method_signature(), CHECK); 514 } 515 516 517 void JMXStopRemoteDCmd::execute(TRAPS) { 518 ResourceMark rm(THREAD); 519 HandleMark hm(THREAD); 520 521 // Load and initialize the sun.management.Agent class 522 // invoke stopRemoteManagementAgent method to stop the 523 // management server 524 // throw java.lang.NoSuchMethodError if method doesn't exist 525 526 Handle loader = Handle(THREAD, SystemDictionary::java_system_loader()); 527 Klass* k = SystemDictionary::resolve_or_fail(vmSymbols::sun_management_Agent(), loader, Handle(), true, CHECK); 528 instanceKlassHandle ik (THREAD, k); 529 530 JavaValue result(T_VOID); 531 JavaCalls::call_static(&result, ik, vmSymbols::stopRemoteAgent_name(), vmSymbols::void_method_signature(), CHECK); 532 } 533