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