1 /*
2 * Copyright (c) 1997, 2014, 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/javaClasses.inline.hpp"
27 #include "interpreter/bytecodeHistogram.hpp"
28 #include "interpreter/bytecodeTracer.hpp"
29 #include "interpreter/bytecodes.hpp"
30 #include "interpreter/interpreter.hpp"
31 #include "interpreter/interpreterRuntime.hpp"
32 #include "memory/resourceArea.hpp"
33 #include "oops/methodData.hpp"
34 #include "oops/method.hpp"
35 #include "runtime/mutexLocker.hpp"
36 #include "runtime/timer.hpp"
37
38
39 // Standard closure for BytecodeTracer: prints the current bytecode
40 // and its attributes using bytecode-specific information.
41
42 class BytecodePrinter: public BytecodeClosure {
43 private:
44 // %%% This field is not GC-ed, and so can contain garbage
45 // between critical sections. Use only pointer-comparison
46 // operations on the pointer, except within a critical section.
47 // (Also, ensure that occasional false positives are benign.)
48 Method* _current_method;
49 bool _is_wide;
50 Bytecodes::Code _code;
51 address _next_pc; // current decoding position
52
53 void align() { _next_pc = (address)round_to((intptr_t)_next_pc, sizeof(jint)); }
54 int get_byte() { return *(jbyte*) _next_pc++; } // signed
55 short get_short() { short i=Bytes::get_Java_u2(_next_pc); _next_pc+=2; return i; }
56 int get_int() { int i=Bytes::get_Java_u4(_next_pc); _next_pc+=4; return i; }
57
58 int get_index_u1() { return *(address)_next_pc++; }
59 int get_index_u2() { int i=Bytes::get_Java_u2(_next_pc); _next_pc+=2; return i; }
60 int get_index_u1_cpcache() { return get_index_u1() + ConstantPool::CPCACHE_INDEX_TAG; }
61 int get_index_u2_cpcache() { int i=Bytes::get_native_u2(_next_pc); _next_pc+=2; return i + ConstantPool::CPCACHE_INDEX_TAG; }
62 int get_index_u4() { int i=Bytes::get_native_u4(_next_pc); _next_pc+=4; return i; }
63 int get_index_special() { return (is_wide()) ? get_index_u2() : get_index_u1(); }
64 Method* method() { return _current_method; }
65 bool is_wide() { return _is_wide; }
66 Bytecodes::Code raw_code() { return Bytecodes::Code(_code); }
67
68
69 bool check_index(int i, int& cp_index, outputStream* st = tty);
70 bool check_cp_cache_index(int i, int& cp_index, outputStream* st = tty);
71 bool check_obj_index(int i, int& cp_index, outputStream* st = tty);
72 bool check_invokedynamic_index(int i, int& cp_index, outputStream* st = tty);
73 void print_constant(int i, outputStream* st = tty);
74 void print_field_or_method(int i, outputStream* st = tty);
75 void print_field_or_method(int orig_i, int i, outputStream* st = tty);
76 void print_attributes(int bci, outputStream* st = tty);
77 void bytecode_epilog(int bci, outputStream* st = tty);
78
79 public:
80 BytecodePrinter() {
81 _is_wide = false;
82 _code = Bytecodes::_illegal;
83 }
84
85 // This method is called while executing the raw bytecodes, so none of
86 // the adjustments that BytecodeStream performs applies.
87 void trace(methodHandle method, address bcp, uintptr_t tos, uintptr_t tos2, outputStream* st) {
88 ResourceMark rm;
89 if (_current_method != method()) {
90 // Note 1: This code will not work as expected with true MT/MP.
91 // Need an explicit lock or a different solution.
92 // It is possible for this block to be skipped, if a garbage
93 // _current_method pointer happens to have the same bits as
94 // the incoming method. We could lose a line of trace output.
95 // This is acceptable in a debug-only feature.
96 st->cr();
97 st->print("[%ld] ", (long) Thread::current()->osthread()->thread_id());
98 method->print_name(st);
99 st->cr();
100 _current_method = method();
101 }
102 Bytecodes::Code code;
103 if (is_wide()) {
104 // bcp wasn't advanced if previous bytecode was _wide.
105 code = Bytecodes::code_at(method(), bcp+1);
106 } else {
107 code = Bytecodes::code_at(method(), bcp);
108 }
109 _code = code;
110 int bci = bcp - method->code_base();
111 st->print("[%ld] ", (long) Thread::current()->osthread()->thread_id());
112 if (Verbose) {
113 st->print("%8d %4d " INTPTR_FORMAT " " INTPTR_FORMAT " %s",
114 BytecodeCounter::counter_value(), bci, tos, tos2, Bytecodes::name(code));
115 } else {
116 st->print("%8d %4d %s",
117 BytecodeCounter::counter_value(), bci, Bytecodes::name(code));
118 }
119 _next_pc = is_wide() ? bcp+2 : bcp+1;
120 print_attributes(bci);
121 // Set is_wide for the next one, since the caller of this doesn't skip
122 // the next bytecode.
123 _is_wide = (code == Bytecodes::_wide);
124 _code = Bytecodes::_illegal;
125 }
126
127 // Used for Method*::print_codes(). The input bcp comes from
128 // BytecodeStream, which will skip wide bytecodes.
129 void trace(methodHandle method, address bcp, outputStream* st) {
130 _current_method = method();
131 ResourceMark rm;
132 Bytecodes::Code code = Bytecodes::code_at(method(), bcp);
133 // Set is_wide
134 _is_wide = (code == Bytecodes::_wide);
135 if (is_wide()) {
136 code = Bytecodes::code_at(method(), bcp+1);
137 }
138 _code = code;
139 int bci = bcp - method->code_base();
140 // Print bytecode index and name
141 if (is_wide()) {
142 st->print("%d %s_w", bci, Bytecodes::name(code));
143 } else {
144 st->print("%d %s", bci, Bytecodes::name(code));
145 }
146 _next_pc = is_wide() ? bcp+2 : bcp+1;
147 print_attributes(bci, st);
148 bytecode_epilog(bci, st);
149 }
150 };
151
152
153 // Implementation of BytecodeTracer
154
155 // %%% This set_closure thing seems overly general, given that
156 // nobody uses it. Also, if BytecodePrinter weren't hidden
157 // then Method* could use instances of it directly and it
158 // would be easier to remove races on _current_method and bcp.
159 // Since this is not product functionality, we can defer cleanup.
160
161 BytecodeClosure* BytecodeTracer::_closure = NULL;
162
163 static BytecodePrinter std_closure;
164 BytecodeClosure* BytecodeTracer::std_closure() {
165 return &::std_closure;
166 }
167
168
169 void BytecodeTracer::trace(methodHandle method, address bcp, uintptr_t tos, uintptr_t tos2, outputStream* st) {
170 if (TraceBytecodes && BytecodeCounter::counter_value() >= TraceBytecodesAt) {
171 ttyLocker ttyl; // 5065316: keep the following output coherent
172 // The ttyLocker also prevents races between two threads
173 // trying to use the single instance of BytecodePrinter.
174 // Using the ttyLocker prevents the system from coming to
175 // a safepoint within this code, which is sensitive to Method*
176 // movement.
177 //
178 // There used to be a leaf mutex here, but the ttyLocker will
179 // work just as well, as long as the printing operations never block.
180 //
181 // We put the locker on the static trace method, not the
182 // virtual one, because the clients of this module go through
183 // the static method.
184 _closure->trace(method, bcp, tos, tos2, st);
185 }
186 }
187
188 void BytecodeTracer::trace(methodHandle method, address bcp, outputStream* st) {
189 ttyLocker ttyl; // 5065316: keep the following output coherent
190 _closure->trace(method, bcp, st);
191 }
192
193 void print_symbol(Symbol* sym, outputStream* st) {
194 char buf[40];
195 int len = sym->utf8_length();
196 if (len >= (int)sizeof(buf)) {
197 st->print_cr(" %s...[%d]", sym->as_C_string(buf, sizeof(buf)), len);
198 } else {
199 st->print(" ");
200 sym->print_on(st); st->cr();
201 }
202 }
203
204 void print_oop(oop value, outputStream* st) {
205 if (value == NULL) {
206 st->print_cr(" NULL");
207 } else if (java_lang_String::is_instance(value)) {
208 char buf[40];
209 int len = java_lang_String::utf8_length(value);
210 java_lang_String::as_utf8_string(value, buf, sizeof(buf));
211 if (len >= (int)sizeof(buf)) {
212 st->print_cr(" %s...[%d]", buf, len);
213 } else {
214 st->print_cr(" %s", buf);
215 }
216 } else {
217 st->print_cr(" " INTPTR_FORMAT, p2i((void *)value));
218 }
219 }
220
221 bool BytecodePrinter::check_index(int i, int& cp_index, outputStream* st) {
222 ConstantPool* constants = method()->constants();
223 int ilimit = constants->length();
224 Bytecodes::Code code = raw_code();
225
226 ConstantPoolCache* cache = NULL;
227 if (Bytecodes::uses_cp_cache(code)) {
228 bool okay = true;
229 switch (code) {
230 case Bytecodes::_fast_aldc:
231 case Bytecodes::_fast_aldc_w:
232 okay = check_obj_index(i, cp_index, st);
233 break;
234 case Bytecodes::_invokedynamic:
235 okay = check_invokedynamic_index(i, cp_index, st);
236 break;
237 default:
238 okay = check_cp_cache_index(i, cp_index, st);
239 break;
240 }
241 if (!okay) return false;
242 }
243
244
245 // check cp index
246 if (cp_index >= 0 && cp_index < ilimit) {
247 if (WizardMode) st->print(" cp[%d]", cp_index);
248 return true;
249 }
250
251 st->print_cr(" CP[%d] not in CP", cp_index);
252 return false;
253 }
254
255 bool BytecodePrinter::check_cp_cache_index(int i, int& cp_index, outputStream* st) {
256 ConstantPool* constants = method()->constants();
257 int ilimit = constants->length(), climit = 0;
258 Bytecodes::Code code = raw_code();
259
260 ConstantPoolCache* cache = constants->cache();
261 // If rewriter hasn't run, the index is the cp_index
262 if (cache == NULL) {
263 cp_index = i;
264 return true;
265 }
266 //climit = cache->length(); // %%% private!
267 size_t size = cache->size() * HeapWordSize;
268 size -= sizeof(ConstantPoolCache);
269 size /= sizeof(ConstantPoolCacheEntry);
270 climit = (int) size;
271
272 #ifdef ASSERT
273 {
274 const int CPCACHE_INDEX_TAG = ConstantPool::CPCACHE_INDEX_TAG;
275 if (i >= CPCACHE_INDEX_TAG && i < climit + CPCACHE_INDEX_TAG) {
276 i -= CPCACHE_INDEX_TAG;
277 } else {
278 st->print_cr(" CP[%d] missing bias?", i);
279 return false;
280 }
281 }
282 #endif //ASSERT
283 if (i >= 0 && i < climit) {
284 cp_index = cache->entry_at(i)->constant_pool_index();
285 } else {
286 st->print_cr("%d not in CP[*]?", i);
287 return false;
288 }
289 return true;
290 }
291
292
293 bool BytecodePrinter::check_obj_index(int i, int& cp_index, outputStream* st) {
294 ConstantPool* constants = method()->constants();
295 i -= ConstantPool::CPCACHE_INDEX_TAG;
296
297 if (i >= 0 && i < constants->resolved_references()->length()) {
298 cp_index = constants->object_to_cp_index(i);
299 return true;
300 } else {
301 st->print_cr("%d not in OBJ[*]?", i);
302 return false;
303 }
304 }
305
306
307 bool BytecodePrinter::check_invokedynamic_index(int i, int& cp_index, outputStream* st) {
308 ConstantPool* constants = method()->constants();
309 assert(ConstantPool::is_invokedynamic_index(i), "not secondary index?");
310 i = ConstantPool::decode_invokedynamic_index(i) + ConstantPool::CPCACHE_INDEX_TAG;
311
312 return check_cp_cache_index(i, cp_index, st);
313 }
314
315 void BytecodePrinter::print_constant(int i, outputStream* st) {
316 int orig_i = i;
317 if (!check_index(orig_i, i, st)) return;
318
319 ConstantPool* constants = method()->constants();
320 constantTag tag = constants->tag_at(i);
321
322 if (tag.is_int()) {
323 st->print_cr(" " INT32_FORMAT, constants->int_at(i));
324 } else if (tag.is_long()) {
325 st->print_cr(" " INT64_FORMAT, (int64_t)(constants->long_at(i)));
326 } else if (tag.is_float()) {
327 st->print_cr(" %f", constants->float_at(i));
328 } else if (tag.is_double()) {
329 st->print_cr(" %f", constants->double_at(i));
330 } else if (tag.is_string()) {
331 const char* string = constants->string_at_noresolve(i);
332 st->print_cr(" %s", string);
333 } else if (tag.is_klass()) {
334 st->print_cr(" %s", constants->resolved_klass_at(i)->external_name());
335 } else if (tag.is_unresolved_klass()) {
336 st->print_cr(" <unresolved klass at %d>", i);
337 } else if (tag.is_method_type()) {
338 int i2 = constants->method_type_index_at(i);
339 st->print(" <MethodType> %d", i2);
340 print_symbol(constants->symbol_at(i2), st);
341 } else if (tag.is_method_handle()) {
342 int kind = constants->method_handle_ref_kind_at(i);
343 int i2 = constants->method_handle_index_at(i);
344 st->print(" <MethodHandle of kind %d index at %d>", kind, i2);
345 print_field_or_method(-i, i2, st);
346 } else {
347 st->print_cr(" bad tag=%d at %d", tag.value(), i);
348 }
349 }
350
351 void BytecodePrinter::print_field_or_method(int i, outputStream* st) {
352 int orig_i = i;
353 if (!check_index(orig_i, i, st)) return;
354 print_field_or_method(orig_i, i, st);
355 }
356
357 void BytecodePrinter::print_field_or_method(int orig_i, int i, outputStream* st) {
358 ConstantPool* constants = method()->constants();
359 constantTag tag = constants->tag_at(i);
360
361 bool has_klass = true;
362
363 switch (tag.value()) {
364 case JVM_CONSTANT_InterfaceMethodref:
365 case JVM_CONSTANT_Methodref:
366 case JVM_CONSTANT_Fieldref:
367 break;
368 case JVM_CONSTANT_NameAndType:
369 case JVM_CONSTANT_InvokeDynamic:
370 has_klass = false;
371 break;
372 default:
373 st->print_cr(" bad tag=%d at %d", tag.value(), i);
374 return;
375 }
376
377 Symbol* name = constants->uncached_name_ref_at(i);
378 Symbol* signature = constants->uncached_signature_ref_at(i);
379 const char* sep = (tag.is_field() ? "/" : "");
380 if (has_klass) {
381 Symbol* klass = constants->klass_name_at(constants->uncached_klass_ref_index_at(i));
382 st->print_cr(" %d <%s.%s%s%s> ", i, klass->as_C_string(), name->as_C_string(), sep, signature->as_C_string());
383 } else {
384 if (tag.is_invoke_dynamic()) {
385 int bsm = constants->invoke_dynamic_bootstrap_method_ref_index_at(i);
386 st->print(" bsm=%d", bsm);
387 }
388 st->print_cr(" %d <%s%s%s>", i, name->as_C_string(), sep, signature->as_C_string());
389 }
390 }
391
392
393 PRAGMA_FORMAT_NONLITERAL_IGNORED_EXTERNAL
394 void BytecodePrinter::print_attributes(int bci, outputStream* st) {
395 // Show attributes of pre-rewritten codes
396 Bytecodes::Code code = Bytecodes::java_code(raw_code());
397 // If the code doesn't have any fields there's nothing to print.
398 // note this is ==1 because the tableswitch and lookupswitch are
399 // zero size (for some reason) and we want to print stuff out for them.
400 if (Bytecodes::length_for(code) == 1) {
401 st->cr();
402 return;
403 }
404
405 switch(code) {
406 // Java specific bytecodes only matter.
407 case Bytecodes::_bipush:
408 st->print_cr(" " INT32_FORMAT, get_byte());
409 break;
410 case Bytecodes::_sipush:
411 st->print_cr(" " INT32_FORMAT, get_short());
412 break;
413 case Bytecodes::_ldc:
414 if (Bytecodes::uses_cp_cache(raw_code())) {
415 print_constant(get_index_u1_cpcache(), st);
416 } else {
417 print_constant(get_index_u1(), st);
418 }
419 break;
420
421 case Bytecodes::_ldc_w:
422 case Bytecodes::_ldc2_w:
423 if (Bytecodes::uses_cp_cache(raw_code())) {
424 print_constant(get_index_u2_cpcache(), st);
425 } else {
426 print_constant(get_index_u2(), st);
427 }
428 break;
429
430 case Bytecodes::_iload:
431 case Bytecodes::_lload:
432 case Bytecodes::_fload:
433 case Bytecodes::_dload:
434 case Bytecodes::_aload:
435 case Bytecodes::_istore:
436 case Bytecodes::_lstore:
437 case Bytecodes::_fstore:
438 case Bytecodes::_dstore:
439 case Bytecodes::_astore:
440 st->print_cr(" #%d", get_index_special());
441 break;
442
443 case Bytecodes::_iinc:
444 { int index = get_index_special();
445 jint offset = is_wide() ? get_short(): get_byte();
446 st->print_cr(" #%d " INT32_FORMAT, index, offset);
447 }
448 break;
449
450 case Bytecodes::_newarray: {
451 BasicType atype = (BasicType)get_index_u1();
452 const char* str = type2name(atype);
453 if (str == NULL || atype == T_OBJECT || atype == T_ARRAY) {
454 assert(false, "Unidentified basic type");
455 }
456 st->print_cr(" %s", str);
457 }
458 break;
459 case Bytecodes::_anewarray: {
460 int klass_index = get_index_u2();
461 ConstantPool* constants = method()->constants();
462 Symbol* name = constants->klass_name_at(klass_index);
463 st->print_cr(" %s ", name->as_C_string());
464 }
465 break;
466 case Bytecodes::_multianewarray: {
467 int klass_index = get_index_u2();
468 int nof_dims = get_index_u1();
469 ConstantPool* constants = method()->constants();
470 Symbol* name = constants->klass_name_at(klass_index);
471 st->print_cr(" %s %d", name->as_C_string(), nof_dims);
472 }
473 break;
474
475 case Bytecodes::_ifeq:
476 case Bytecodes::_ifnull:
477 case Bytecodes::_iflt:
478 case Bytecodes::_ifle:
479 case Bytecodes::_ifne:
480 case Bytecodes::_ifnonnull:
481 case Bytecodes::_ifgt:
482 case Bytecodes::_ifge:
483 case Bytecodes::_if_icmpeq:
484 case Bytecodes::_if_icmpne:
485 case Bytecodes::_if_icmplt:
486 case Bytecodes::_if_icmpgt:
487 case Bytecodes::_if_icmple:
488 case Bytecodes::_if_icmpge:
489 case Bytecodes::_if_acmpeq:
490 case Bytecodes::_if_acmpne:
491 case Bytecodes::_goto:
492 case Bytecodes::_jsr:
493 st->print_cr(" %d", bci + get_short());
494 break;
495
496 case Bytecodes::_goto_w:
497 case Bytecodes::_jsr_w:
498 st->print_cr(" %d", bci + get_int());
499 break;
500
501 case Bytecodes::_ret: st->print_cr(" %d", get_index_special()); break;
502
503 case Bytecodes::_tableswitch:
504 { align();
505 int default_dest = bci + get_int();
506 int lo = get_int();
507 int hi = get_int();
508 int len = hi - lo + 1;
509 jint* dest = NEW_RESOURCE_ARRAY(jint, len);
510 for (int i = 0; i < len; i++) {
511 dest[i] = bci + get_int();
512 }
513 st->print(" %d " INT32_FORMAT " " INT32_FORMAT " ",
514 default_dest, lo, hi);
515 int first = true;
516 for (int ll = lo; ll <= hi; ll++, first = false) {
517 int idx = ll - lo;
518 const char *format = first ? " %d:" INT32_FORMAT " (delta: %d)" :
519 ", %d:" INT32_FORMAT " (delta: %d)";
520 PRAGMA_DIAG_PUSH
521 PRAGMA_FORMAT_NONLITERAL_IGNORED_INTERNAL
522 st->print(format, ll, dest[idx], dest[idx]-bci);
523 PRAGMA_DIAG_POP
524 }
525 st->cr();
526 }
527 break;
528 case Bytecodes::_lookupswitch:
529 { align();
530 int default_dest = bci + get_int();
531 int len = get_int();
532 jint* key = NEW_RESOURCE_ARRAY(jint, len);
533 jint* dest = NEW_RESOURCE_ARRAY(jint, len);
534 for (int i = 0; i < len; i++) {
535 key [i] = get_int();
536 dest[i] = bci + get_int();
537 };
538 st->print(" %d %d ", default_dest, len);
539 bool first = true;
540 for (int ll = 0; ll < len; ll++, first = false) {
541 const char *format = first ? " " INT32_FORMAT ":" INT32_FORMAT :
542 ", " INT32_FORMAT ":" INT32_FORMAT ;
543 PRAGMA_DIAG_PUSH
544 PRAGMA_FORMAT_NONLITERAL_IGNORED_INTERNAL
545 st->print(format, key[ll], dest[ll]);
546 PRAGMA_DIAG_POP
547 }
548 st->cr();
549 }
550 break;
551
552 case Bytecodes::_putstatic:
553 case Bytecodes::_getstatic:
554 case Bytecodes::_putfield:
555 case Bytecodes::_getfield:
556 print_field_or_method(get_index_u2_cpcache(), st);
557 break;
558
559 case Bytecodes::_invokevirtual:
560 case Bytecodes::_invokespecial:
561 case Bytecodes::_invokestatic:
562 print_field_or_method(get_index_u2_cpcache(), st);
563 break;
564
565 case Bytecodes::_invokeinterface:
566 { int i = get_index_u2_cpcache();
567 int n = get_index_u1();
568 get_byte(); // ignore zero byte
569 print_field_or_method(i, st);
570 }
571 break;
572
573 case Bytecodes::_invokedynamic:
574 print_field_or_method(get_index_u4(), st);
575 break;
576
577 case Bytecodes::_new:
578 case Bytecodes::_checkcast:
579 case Bytecodes::_instanceof:
580 { int i = get_index_u2();
581 ConstantPool* constants = method()->constants();
582 Symbol* name = constants->klass_name_at(i);
583 st->print_cr(" %d <%s>", i, name->as_C_string());
584 }
585 break;
586
587 case Bytecodes::_wide:
588 // length is zero not one, but printed with no more info.
589 break;
590
591 default:
592 ShouldNotReachHere();
593 break;
594 }
595 }
596
597
598 void BytecodePrinter::bytecode_epilog(int bci, outputStream* st) {
599 MethodData* mdo = method()->method_data();
600 if (mdo != NULL) {
601 ProfileData* data = mdo->bci_to_data(bci);
602 if (data != NULL) {
603 st->print(" %d", mdo->dp_to_di(data->dp()));
604 st->fill_to(6);
605 data->print_data_on(st, mdo);
606 }
607 }
608 }