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