1 /*
2 * Copyright (c) 2008, 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.hpp"
27 #include "code/codeCache.hpp"
28 #include "compiler/disassembler.hpp"
29 #include "gc_interface/collectedHeap.hpp"
30 #include "memory/cardTableModRefBS.hpp"
31 #include "runtime/fprofiler.hpp"
32 #include "runtime/handles.inline.hpp"
33 #include "runtime/stubCodeGenerator.hpp"
34 #include "runtime/stubRoutines.hpp"
35 #ifdef TARGET_ARCH_x86
36 # include "depChecker_x86.hpp"
37 #endif
38 #ifdef TARGET_ARCH_aarch64
39 # include "depChecker_aarch64.hpp"
40 #endif
41 #ifdef TARGET_ARCH_sparc
42 # include "depChecker_sparc.hpp"
43 #endif
44 #ifdef TARGET_ARCH_zero
45 # include "depChecker_zero.hpp"
46 #endif
47 #ifdef TARGET_ARCH_arm
48 # include "depChecker_arm.hpp"
49 #endif
50 #ifdef TARGET_ARCH_ppc
51 # include "depChecker_ppc.hpp"
52 #endif
53 #ifdef SHARK
54 #include "shark/sharkEntry.hpp"
55 #endif
56
57 PRAGMA_FORMAT_MUTE_WARNINGS_FOR_GCC
58
59 void* Disassembler::_library = NULL;
60 bool Disassembler::_tried_to_load_library = false;
61
62 // This routine is in the shared library:
63 Disassembler::decode_func_virtual Disassembler::_decode_instructions_virtual = NULL;
64 Disassembler::decode_func Disassembler::_decode_instructions = NULL;
65
66 static const char hsdis_library_name[] = "hsdis-" HOTSPOT_LIB_ARCH;
67 static const char decode_instructions_virtual_name[] = "decode_instructions_virtual";
68 static const char decode_instructions_name[] = "decode_instructions";
69 static bool use_new_version = true;
70 #define COMMENT_COLUMN 40 LP64_ONLY(+8) /*could be an option*/
71 #define BYTES_COMMENT ";..." /* funky byte display comment */
72
73 bool Disassembler::load_library() {
74 if (_decode_instructions_virtual != NULL || _decode_instructions != NULL) {
75 // Already succeeded.
76 return true;
77 }
78 if (_tried_to_load_library) {
79 // Do not try twice.
80 // To force retry in debugger: assign _tried_to_load_library=0
81 return false;
82 }
83 // Try to load it.
84 char ebuf[1024];
85 char buf[JVM_MAXPATHLEN];
86 os::jvm_path(buf, sizeof(buf));
87 int jvm_offset = -1;
88 int lib_offset = -1;
89 {
90 // Match "jvm[^/]*" in jvm_path.
91 const char* base = buf;
92 const char* p = strrchr(buf, '/');
93 if (p != NULL) lib_offset = p - base + 1;
94 p = strstr(p ? p : base, "jvm");
95 if (p != NULL) jvm_offset = p - base;
96 }
97 // Find the disassembler shared library.
98 // Search for several paths derived from libjvm, in this order:
99 // 1. <home>/jre/lib/<arch>/<vm>/libhsdis-<arch>.so (for compatibility)
100 // 2. <home>/jre/lib/<arch>/<vm>/hsdis-<arch>.so
101 // 3. <home>/jre/lib/<arch>/hsdis-<arch>.so
102 // 4. hsdis-<arch>.so (using LD_LIBRARY_PATH)
103 if (jvm_offset >= 0) {
104 // 1. <home>/jre/lib/<arch>/<vm>/libhsdis-<arch>.so
105 strcpy(&buf[jvm_offset], hsdis_library_name);
106 strcat(&buf[jvm_offset], os::dll_file_extension());
107 _library = os::dll_load(buf, ebuf, sizeof ebuf);
108 if (_library == NULL) {
109 // 2. <home>/jre/lib/<arch>/<vm>/hsdis-<arch>.so
110 strcpy(&buf[lib_offset], hsdis_library_name);
111 strcat(&buf[lib_offset], os::dll_file_extension());
112 _library = os::dll_load(buf, ebuf, sizeof ebuf);
113 }
114 if (_library == NULL) {
115 // 3. <home>/jre/lib/<arch>/hsdis-<arch>.so
116 buf[lib_offset - 1] = '\0';
117 const char* p = strrchr(buf, '/');
118 if (p != NULL) {
119 lib_offset = p - buf + 1;
120 strcpy(&buf[lib_offset], hsdis_library_name);
121 strcat(&buf[lib_offset], os::dll_file_extension());
122 _library = os::dll_load(buf, ebuf, sizeof ebuf);
123 }
124 }
125 }
126 if (_library == NULL) {
127 // 4. hsdis-<arch>.so (using LD_LIBRARY_PATH)
128 strcpy(&buf[0], hsdis_library_name);
129 strcat(&buf[0], os::dll_file_extension());
130 _library = os::dll_load(buf, ebuf, sizeof ebuf);
131 }
132 if (_library != NULL) {
133 _decode_instructions_virtual = CAST_TO_FN_PTR(Disassembler::decode_func_virtual,
134 os::dll_lookup(_library, decode_instructions_virtual_name));
135 }
136 if (_decode_instructions_virtual == NULL) {
137 // could not spot in new version, try old version
138 _decode_instructions = CAST_TO_FN_PTR(Disassembler::decode_func,
139 os::dll_lookup(_library, decode_instructions_name));
140 use_new_version = false;
141 } else {
142 use_new_version = true;
143 }
144 _tried_to_load_library = true;
145 if (_decode_instructions_virtual == NULL && _decode_instructions == NULL) {
146 tty->print_cr("Could not load %s; %s; %s", buf,
147 ((_library != NULL)
148 ? "entry point is missing"
149 : (WizardMode || PrintMiscellaneous)
150 ? (const char*)ebuf
151 : "library not loadable"),
152 "PrintAssembly is disabled");
153 return false;
154 }
155
156 // Success.
157 tty->print_cr("Loaded disassembler from %s", buf);
158 return true;
159 }
160
161
162 class decode_env {
163 private:
164 nmethod* _nm;
165 CodeBlob* _code;
166 CodeStrings _strings;
167 outputStream* _output;
168 address _start, _end;
169
170 char _option_buf[512];
171 char _print_raw;
172 bool _print_pc;
173 bool _print_bytes;
174 address _cur_insn;
175 int _total_ticks;
176 int _bytes_per_line; // arch-specific formatting option
177
178 static bool match(const char* event, const char* tag) {
179 size_t taglen = strlen(tag);
180 if (strncmp(event, tag, taglen) != 0)
181 return false;
182 char delim = event[taglen];
183 return delim == '\0' || delim == ' ' || delim == '/' || delim == '=';
184 }
185
186 void collect_options(const char* p) {
187 if (p == NULL || p[0] == '\0') return;
188 size_t opt_so_far = strlen(_option_buf);
189 if (opt_so_far + 1 + strlen(p) + 1 > sizeof(_option_buf)) return;
190 char* fillp = &_option_buf[opt_so_far];
191 if (opt_so_far > 0) *fillp++ = ',';
192 strcat(fillp, p);
193 // replace white space by commas:
194 char* q = fillp;
195 while ((q = strpbrk(q, " \t\n")) != NULL)
196 *q++ = ',';
197 // Note that multiple PrintAssemblyOptions flags accumulate with \n,
198 // which we want to be changed to a comma...
199 }
200
201 void print_insn_labels();
202 void print_insn_bytes(address pc0, address pc);
203 void print_address(address value);
204
205 public:
206 decode_env(CodeBlob* code, outputStream* output, CodeStrings c = CodeStrings());
207
208 address decode_instructions(address start, address end);
209
210 void start_insn(address pc) {
211 _cur_insn = pc;
212 output()->bol();
213 print_insn_labels();
214 }
215
216 void end_insn(address pc) {
217 address pc0 = cur_insn();
218 outputStream* st = output();
219 if (_print_bytes && pc > pc0)
220 print_insn_bytes(pc0, pc);
221 if (_nm != NULL) {
222 _nm->print_code_comment_on(st, COMMENT_COLUMN, pc0, pc);
223 // this calls reloc_string_for which calls oop::print_value_on
224 }
225
226 // Output pc bucket ticks if we have any
227 if (total_ticks() != 0) {
228 address bucket_pc = FlatProfiler::bucket_start_for(pc);
229 if (bucket_pc != NULL && bucket_pc > pc0 && bucket_pc <= pc) {
230 int bucket_count = FlatProfiler::bucket_count_for(pc0);
231 if (bucket_count != 0) {
232 st->bol();
233 st->print_cr("%3.1f%% [%d]", bucket_count*100.0/total_ticks(), bucket_count);
234 }
235 }
236 }
237 // follow each complete insn by a nice newline
238 st->cr();
239 }
240
241 address handle_event(const char* event, address arg);
242
243 outputStream* output() { return _output; }
244 address cur_insn() { return _cur_insn; }
245 int total_ticks() { return _total_ticks; }
246 void set_total_ticks(int n) { _total_ticks = n; }
247 const char* options() { return _option_buf; }
248 };
249
250 decode_env::decode_env(CodeBlob* code, outputStream* output, CodeStrings c) :
251 _nm((code != NULL && code->is_nmethod()) ? (nmethod*)code : NULL),
252 _code(code),
253 _strings(),
254 _output(output ? output : tty),
255 _start(NULL),
256 _end(NULL),
257 _print_raw(0),
258 // by default, output pc but not bytes:
259 _print_pc(true),
260 _print_bytes(false),
261 _cur_insn(NULL),
262 _total_ticks(0),
263 _bytes_per_line(Disassembler::pd_instruction_alignment())
264 {
265 memset(_option_buf, 0, sizeof(_option_buf));
266 _strings.copy(c);
267
268 // parse the global option string:
269 collect_options(Disassembler::pd_cpu_opts());
270 collect_options(PrintAssemblyOptions);
271
272 if (strstr(options(), "hsdis-")) {
273 if (strstr(options(), "hsdis-print-raw"))
274 _print_raw = (strstr(options(), "xml") ? 2 : 1);
275 if (strstr(options(), "hsdis-print-pc"))
276 _print_pc = !_print_pc;
277 if (strstr(options(), "hsdis-print-bytes"))
278 _print_bytes = !_print_bytes;
279 }
280 if (strstr(options(), "help")) {
281 tty->print_cr("PrintAssemblyOptions help:");
282 tty->print_cr(" hsdis-print-raw test plugin by requesting raw output");
283 tty->print_cr(" hsdis-print-raw-xml test plugin by requesting raw xml");
284 tty->print_cr(" hsdis-print-pc turn off PC printing (on by default)");
285 tty->print_cr(" hsdis-print-bytes turn on instruction byte output");
286 tty->print_cr("combined options: %s", options());
287 }
288 }
289
290 address decode_env::handle_event(const char* event, address arg) {
291 if (match(event, "insn")) {
292 start_insn(arg);
293 } else if (match(event, "/insn")) {
294 end_insn(arg);
295 } else if (match(event, "addr")) {
296 if (arg != NULL) {
297 print_address(arg);
298 return arg;
299 }
300 } else if (match(event, "mach")) {
301 static char buffer[32] = { 0, };
302 if (strcmp(buffer, (const char*)arg) != 0 ||
303 strlen((const char*)arg) > sizeof(buffer) - 1) {
304 // Only print this when the mach changes
305 strncpy(buffer, (const char*)arg, sizeof(buffer) - 1);
306 buffer[sizeof(buffer) - 1] = '\0';
307 output()->print_cr("[Disassembling for mach='%s']", arg);
308 }
309 } else if (match(event, "format bytes-per-line")) {
310 _bytes_per_line = (int) (intptr_t) arg;
311 } else {
312 // ignore unrecognized markup
313 }
314 return NULL;
315 }
316
317 // called by the disassembler to print out jump targets and data addresses
318 void decode_env::print_address(address adr) {
319 outputStream* st = _output;
320
321 if (adr == NULL) {
322 st->print("NULL");
323 return;
324 }
325
326 int small_num = (int)(intptr_t)adr;
327 if ((intptr_t)adr == (intptr_t)small_num
328 && -1 <= small_num && small_num <= 9) {
329 st->print("%d", small_num);
330 return;
331 }
332
333 if (Universe::is_fully_initialized()) {
334 if (StubRoutines::contains(adr)) {
335 StubCodeDesc* desc = StubCodeDesc::desc_for(adr);
336 if (desc == NULL)
337 desc = StubCodeDesc::desc_for(adr + frame::pc_return_offset);
338 if (desc != NULL) {
339 st->print("Stub::%s", desc->name());
340 if (desc->begin() != adr)
341 st->print("%+d 0x%p",adr - desc->begin(), adr);
342 else if (WizardMode) st->print(" " PTR_FORMAT, adr);
343 return;
344 }
345 st->print("Stub::<unknown> " PTR_FORMAT, adr);
346 return;
347 }
348
349 BarrierSet* bs = Universe::heap()->barrier_set();
350 if (bs->kind() == BarrierSet::CardTableModRef &&
351 adr == (address)((CardTableModRefBS*)(bs))->byte_map_base) {
352 st->print("word_map_base");
353 if (WizardMode) st->print(" " INTPTR_FORMAT, (intptr_t)adr);
354 return;
355 }
356
357 oop obj;
358 if (_nm != NULL
359 && (obj = _nm->embeddedOop_at(cur_insn())) != NULL
360 && (address) obj == adr
361 && Universe::heap()->is_in(obj)
362 && Universe::heap()->is_in(obj->klass())) {
363 julong c = st->count();
364 obj->print_value_on(st);
365 if (st->count() == c) {
366 // No output. (Can happen in product builds.)
367 st->print("(a %s)", obj->klass()->external_name());
368 }
369 return;
370 }
371 }
372
373 // Fall through to a simple (hexadecimal) numeral.
374 st->print(PTR_FORMAT, adr);
375 }
376
377 void decode_env::print_insn_labels() {
378 address p = cur_insn();
379 outputStream* st = output();
380 CodeBlob* cb = _code;
381 if (cb != NULL) {
382 cb->print_block_comment(st, p);
383 }
384 _strings.print_block_comment(st, (intptr_t)(p - _start));
385 if (_print_pc) {
386 st->print(" " PTR_FORMAT ": ", p);
387 }
388 }
389
390 void decode_env::print_insn_bytes(address pc, address pc_limit) {
391 outputStream* st = output();
392 size_t incr = 1;
393 size_t perline = _bytes_per_line;
394 if ((size_t) Disassembler::pd_instruction_alignment() >= sizeof(int)
395 && !((uintptr_t)pc % sizeof(int))
396 && !((uintptr_t)pc_limit % sizeof(int))) {
397 incr = sizeof(int);
398 if (perline % incr) perline += incr - (perline % incr);
399 }
400 while (pc < pc_limit) {
401 // tab to the desired column:
402 st->move_to(COMMENT_COLUMN);
403 address pc0 = pc;
404 address pc1 = pc + perline;
405 if (pc1 > pc_limit) pc1 = pc_limit;
406 for (; pc < pc1; pc += incr) {
407 if (pc == pc0)
408 st->print(BYTES_COMMENT);
409 else if ((uint)(pc - pc0) % sizeof(int) == 0)
410 st->print(" "); // put out a space on word boundaries
411 if (incr == sizeof(int))
412 st->print("%08lx", *(int*)pc);
413 else st->print("%02x", (*pc)&0xFF);
414 }
415 st->cr();
416 }
417 }
418
419
420 static void* event_to_env(void* env_pv, const char* event, void* arg) {
421 decode_env* env = (decode_env*) env_pv;
422 return env->handle_event(event, (address) arg);
423 }
424
425 ATTRIBUTE_PRINTF(2, 3)
426 static int printf_to_env(void* env_pv, const char* format, ...) {
427 decode_env* env = (decode_env*) env_pv;
428 outputStream* st = env->output();
429 size_t flen = strlen(format);
430 const char* raw = NULL;
431 if (flen == 0) return 0;
432 if (flen == 1 && format[0] == '\n') { st->bol(); return 1; }
433 if (flen < 2 ||
434 strchr(format, '%') == NULL) {
435 raw = format;
436 } else if (format[0] == '%' && format[1] == '%' &&
437 strchr(format+2, '%') == NULL) {
438 // happens a lot on machines with names like %foo
439 flen--;
440 raw = format+1;
441 }
442 if (raw != NULL) {
443 st->print_raw(raw, (int) flen);
444 return (int) flen;
445 }
446 va_list ap;
447 va_start(ap, format);
448 julong cnt0 = st->count();
449 st->vprint(format, ap);
450 julong cnt1 = st->count();
451 va_end(ap);
452 return (int)(cnt1 - cnt0);
453 }
454
455 address decode_env::decode_instructions(address start, address end) {
456 _start = start; _end = end;
457
458 assert(((((intptr_t)start | (intptr_t)end) % Disassembler::pd_instruction_alignment()) == 0), "misaligned insn addr");
459
460 const int show_bytes = false; // for disassembler debugging
461
462 //_version = Disassembler::pd_cpu_version();
463
464 if (!Disassembler::can_decode()) {
465 return NULL;
466 }
467
468 // decode a series of instructions and return the end of the last instruction
469
470 if (_print_raw) {
471 // Print whatever the library wants to print, w/o fancy callbacks.
472 // This is mainly for debugging the library itself.
473 FILE* out = stdout;
474 FILE* xmlout = (_print_raw > 1 ? out : NULL);
475 return use_new_version ?
476 (address)
477 (*Disassembler::_decode_instructions_virtual)((uintptr_t)start, (uintptr_t)end,
478 start, end - start,
479 NULL, (void*) xmlout,
480 NULL, (void*) out,
481 options(), 0/*nice new line*/)
482 :
483 (address)
484 (*Disassembler::_decode_instructions)(start, end,
485 NULL, (void*) xmlout,
486 NULL, (void*) out,
487 options());
488 }
489
490 return use_new_version ?
491 (address)
492 (*Disassembler::_decode_instructions_virtual)((uintptr_t)start, (uintptr_t)end,
493 start, end - start,
494 &event_to_env, (void*) this,
495 &printf_to_env, (void*) this,
496 options(), 0/*nice new line*/)
497 :
498 (address)
499 (*Disassembler::_decode_instructions)(start, end,
500 &event_to_env, (void*) this,
501 &printf_to_env, (void*) this,
502 options());
503 }
504
505
506 void Disassembler::decode(CodeBlob* cb, outputStream* st) {
507 if (!load_library()) return;
508 decode_env env(cb, st);
509 env.output()->print_cr("Decoding CodeBlob " PTR_FORMAT, cb);
510 env.decode_instructions(cb->code_begin(), cb->code_end());
511 }
512
513 void Disassembler::decode(address start, address end, outputStream* st, CodeStrings c) {
514 if (!load_library()) return;
515 decode_env env(CodeCache::find_blob_unsafe(start), st, c);
516 env.decode_instructions(start, end);
517 }
518
519 void Disassembler::decode(nmethod* nm, outputStream* st) {
520 if (!load_library()) return;
521 decode_env env(nm, st);
522 env.output()->print_cr("Decoding compiled method " PTR_FORMAT ":", nm);
523 env.output()->print_cr("Code:");
524
525 #ifdef SHARK
526 SharkEntry* entry = (SharkEntry *) nm->code_begin();
527 unsigned char* p = entry->code_start();
528 unsigned char* end = entry->code_limit();
529 #else
530 unsigned char* p = nm->code_begin();
531 unsigned char* end = nm->code_end();
532 #endif // SHARK
533
534 // If there has been profiling, print the buckets.
535 if (FlatProfiler::bucket_start_for(p) != NULL) {
536 unsigned char* p1 = p;
537 int total_bucket_count = 0;
538 while (p1 < end) {
539 unsigned char* p0 = p1;
540 p1 += pd_instruction_alignment();
541 address bucket_pc = FlatProfiler::bucket_start_for(p1);
542 if (bucket_pc != NULL && bucket_pc > p0 && bucket_pc <= p1)
543 total_bucket_count += FlatProfiler::bucket_count_for(p0);
544 }
545 env.set_total_ticks(total_bucket_count);
546 }
547
548 // Print constant table.
549 if (nm->consts_size() > 0) {
550 nm->print_nmethod_labels(env.output(), nm->consts_begin());
551 int offset = 0;
552 for (address p = nm->consts_begin(); p < nm->consts_end(); p += 4, offset += 4) {
553 if ((offset % 8) == 0) {
554 env.output()->print_cr(" " PTR_FORMAT " (offset: %4d): " PTR32_FORMAT " " PTR64_FORMAT, p, offset, *((int32_t*) p), *((int64_t*) p));
555 } else {
556 env.output()->print_cr(" " PTR_FORMAT " (offset: %4d): " PTR32_FORMAT, p, offset, *((int32_t*) p));
557 }
558 }
559 }
560
561 env.decode_instructions(p, end);
562 }