1 /*
2 * Copyright (c) 2008, 2015, 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/shared/cardTableModRefBS.hpp"
30 #include "gc/shared/collectedHeap.hpp"
31 #include "oops/oop.inline.hpp"
32 #include "runtime/fprofiler.hpp"
33 #include "runtime/handles.inline.hpp"
34 #include "runtime/os.hpp"
35 #include "runtime/stubCodeGenerator.hpp"
36 #include "runtime/stubRoutines.hpp"
37 #ifdef TARGET_ARCH_x86
38 # include "depChecker_x86.hpp"
39 #endif
40 #ifdef TARGET_ARCH_sparc
41 # include "depChecker_sparc.hpp"
42 #endif
43 #ifdef TARGET_ARCH_zero
44 # include "depChecker_zero.hpp"
45 #endif
46 #ifdef TARGET_ARCH_arm
47 # include "depChecker_arm.hpp"
48 #endif
49 #ifdef TARGET_ARCH_ppc
50 # include "depChecker_ppc.hpp"
51 #endif
52 #ifdef TARGET_ARCH_aarch64
53 # include "depChecker_aarch64.hpp"
54 #endif
55 #ifdef SHARK
56 #include "shark/sharkEntry.hpp"
57 #endif
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, *os::file_separator());
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, *os::file_separator());
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 memset(this, 0, sizeof(*this)); // Beware, this zeroes bits of fields.
252 _output = output ? output : tty;
253 _code = code;
254 if (code != NULL && code->is_nmethod())
255 _nm = (nmethod*) code;
256 _strings.copy(c);
257
258 // by default, output pc but not bytes:
259 _print_pc = true;
260 _print_bytes = false;
261 _bytes_per_line = Disassembler::pd_instruction_alignment();
262
263 // parse the global option string:
264 collect_options(Disassembler::pd_cpu_opts());
265 collect_options(PrintAssemblyOptions);
266
267 if (strstr(options(), "hsdis-")) {
268 if (strstr(options(), "hsdis-print-raw"))
269 _print_raw = (strstr(options(), "xml") ? 2 : 1);
270 if (strstr(options(), "hsdis-print-pc"))
271 _print_pc = !_print_pc;
272 if (strstr(options(), "hsdis-print-bytes"))
273 _print_bytes = !_print_bytes;
274 }
275 if (strstr(options(), "help")) {
276 tty->print_cr("PrintAssemblyOptions help:");
277 tty->print_cr(" hsdis-print-raw test plugin by requesting raw output");
278 tty->print_cr(" hsdis-print-raw-xml test plugin by requesting raw xml");
279 tty->print_cr(" hsdis-print-pc turn off PC printing (on by default)");
280 tty->print_cr(" hsdis-print-bytes turn on instruction byte output");
281 tty->print_cr("combined options: %s", options());
282 }
283 }
284
285 address decode_env::handle_event(const char* event, address arg) {
286 if (match(event, "insn")) {
287 start_insn(arg);
288 } else if (match(event, "/insn")) {
289 end_insn(arg);
290 } else if (match(event, "addr")) {
291 if (arg != NULL) {
292 print_address(arg);
293 return arg;
294 }
295 } else if (match(event, "mach")) {
296 static char buffer[32] = { 0, };
297 if (strcmp(buffer, (const char*)arg) != 0 ||
298 strlen((const char*)arg) > sizeof(buffer) - 1) {
299 // Only print this when the mach changes
300 strncpy(buffer, (const char*)arg, sizeof(buffer) - 1);
301 buffer[sizeof(buffer) - 1] = '\0';
302 output()->print_cr("[Disassembling for mach='%s']", arg);
303 }
304 } else if (match(event, "format bytes-per-line")) {
305 _bytes_per_line = (int) (intptr_t) arg;
306 } else {
307 // ignore unrecognized markup
308 }
309 return NULL;
310 }
311
312 // called by the disassembler to print out jump targets and data addresses
313 void decode_env::print_address(address adr) {
314 outputStream* st = _output;
315
316 if (adr == NULL) {
317 st->print("NULL");
318 return;
319 }
320
321 int small_num = (int)(intptr_t)adr;
322 if ((intptr_t)adr == (intptr_t)small_num
323 && -1 <= small_num && small_num <= 9) {
324 st->print("%d", small_num);
325 return;
326 }
327
328 if (Universe::is_fully_initialized()) {
329 if (StubRoutines::contains(adr)) {
330 StubCodeDesc* desc = StubCodeDesc::desc_for(adr);
331 if (desc == NULL) {
332 desc = StubCodeDesc::desc_for(adr + frame::pc_return_offset);
333 }
334 if (desc != NULL) {
335 st->print("Stub::%s", desc->name());
336 if (desc->begin() != adr) {
337 st->print("%+d " PTR_FORMAT, (int)(adr - desc->begin()), p2i(adr));
338 } else if (WizardMode) {
339 st->print(" " PTR_FORMAT, p2i(adr));
340 }
341 return;
342 }
343 st->print("Stub::<unknown> " PTR_FORMAT, p2i(adr));
344 return;
345 }
346
347 BarrierSet* bs = Universe::heap()->barrier_set();
348 if (bs->is_a(BarrierSet::CardTableModRef) &&
349 adr == (address)(barrier_set_cast<CardTableModRefBS>(bs)->byte_map_base)) {
350 st->print("word_map_base");
351 if (WizardMode) st->print(" " INTPTR_FORMAT, p2i(adr));
352 return;
353 }
354 }
355
356 // Fall through to a simple (hexadecimal) numeral.
357 st->print(PTR_FORMAT, p2i(adr));
358 }
359
360 void decode_env::print_insn_labels() {
361 address p = cur_insn();
362 outputStream* st = output();
363 CodeBlob* cb = _code;
364 if (cb != NULL) {
365 cb->print_block_comment(st, p);
366 }
367 _strings.print_block_comment(st, (intptr_t)(p - _start));
368 if (_print_pc) {
369 st->print(" " PTR_FORMAT ": ", p2i(p));
370 }
371 }
372
373 void decode_env::print_insn_bytes(address pc, address pc_limit) {
374 outputStream* st = output();
375 size_t incr = 1;
376 size_t perline = _bytes_per_line;
377 if ((size_t) Disassembler::pd_instruction_alignment() >= sizeof(int)
378 && !((uintptr_t)pc % sizeof(int))
379 && !((uintptr_t)pc_limit % sizeof(int))) {
380 incr = sizeof(int);
381 if (perline % incr) perline += incr - (perline % incr);
382 }
383 while (pc < pc_limit) {
384 // tab to the desired column:
385 st->move_to(COMMENT_COLUMN);
386 address pc0 = pc;
387 address pc1 = pc + perline;
388 if (pc1 > pc_limit) pc1 = pc_limit;
389 for (; pc < pc1; pc += incr) {
390 if (pc == pc0) {
391 st->print(BYTES_COMMENT);
392 } else if ((uint)(pc - pc0) % sizeof(int) == 0) {
393 st->print(" "); // put out a space on word boundaries
394 }
395 if (incr == sizeof(int)) {
396 st->print("%08x", *(int*)pc);
397 } else {
398 st->print("%02x", (*pc)&0xFF);
399 }
400 }
401 st->cr();
402 }
403 }
404
405
406 static void* event_to_env(void* env_pv, const char* event, void* arg) {
407 decode_env* env = (decode_env*) env_pv;
408 return env->handle_event(event, (address) arg);
409 }
410
411 ATTRIBUTE_PRINTF(2, 3)
412 static int printf_to_env(void* env_pv, const char* format, ...) {
413 decode_env* env = (decode_env*) env_pv;
414 outputStream* st = env->output();
415 size_t flen = strlen(format);
416 const char* raw = NULL;
417 if (flen == 0) return 0;
418 if (flen == 1 && format[0] == '\n') { st->bol(); return 1; }
419 if (flen < 2 ||
420 strchr(format, '%') == NULL) {
421 raw = format;
422 } else if (format[0] == '%' && format[1] == '%' &&
423 strchr(format+2, '%') == NULL) {
424 // happens a lot on machines with names like %foo
425 flen--;
426 raw = format+1;
427 }
428 if (raw != NULL) {
429 st->print_raw(raw, (int) flen);
430 return (int) flen;
431 }
432 va_list ap;
433 va_start(ap, format);
434 julong cnt0 = st->count();
435 st->vprint(format, ap);
436 julong cnt1 = st->count();
437 va_end(ap);
438 return (int)(cnt1 - cnt0);
439 }
440
441 address decode_env::decode_instructions(address start, address end) {
442 _start = start; _end = end;
443
444 assert(((((intptr_t)start | (intptr_t)end) % Disassembler::pd_instruction_alignment()) == 0), "misaligned insn addr");
445
446 const int show_bytes = false; // for disassembler debugging
447
448 //_version = Disassembler::pd_cpu_version();
449
450 if (!Disassembler::can_decode()) {
451 return NULL;
452 }
453
454 // decode a series of instructions and return the end of the last instruction
455
456 if (_print_raw) {
457 // Print whatever the library wants to print, w/o fancy callbacks.
458 // This is mainly for debugging the library itself.
459 FILE* out = stdout;
460 FILE* xmlout = (_print_raw > 1 ? out : NULL);
461 return use_new_version ?
462 (address)
463 (*Disassembler::_decode_instructions_virtual)((uintptr_t)start, (uintptr_t)end,
464 start, end - start,
465 NULL, (void*) xmlout,
466 NULL, (void*) out,
467 options(), 0/*nice new line*/)
468 :
469 (address)
470 (*Disassembler::_decode_instructions)(start, end,
471 NULL, (void*) xmlout,
472 NULL, (void*) out,
473 options());
474 }
475
476 return use_new_version ?
477 (address)
478 (*Disassembler::_decode_instructions_virtual)((uintptr_t)start, (uintptr_t)end,
479 start, end - start,
480 &event_to_env, (void*) this,
481 &printf_to_env, (void*) this,
482 options(), 0/*nice new line*/)
483 :
484 (address)
485 (*Disassembler::_decode_instructions)(start, end,
486 &event_to_env, (void*) this,
487 &printf_to_env, (void*) this,
488 options());
489 }
490
491
492 void Disassembler::decode(CodeBlob* cb, outputStream* st) {
493 if (!load_library()) return;
494 decode_env env(cb, st);
495 env.output()->print_cr("Decoding CodeBlob " PTR_FORMAT, p2i(cb));
496 env.decode_instructions(cb->code_begin(), cb->code_end());
497 }
498
499 void Disassembler::decode(address start, address end, outputStream* st, CodeStrings c) {
500 if (!load_library()) return;
501 decode_env env(CodeCache::find_blob_unsafe(start), st, c);
502 env.decode_instructions(start, end);
503 }
504
505 void Disassembler::decode(nmethod* nm, outputStream* st) {
506 if (!load_library()) return;
507 decode_env env(nm, st);
508 env.output()->print_cr("Decoding compiled method " PTR_FORMAT ":", p2i(nm));
509 env.output()->print_cr("Code:");
510
511 #ifdef SHARK
512 SharkEntry* entry = (SharkEntry *) nm->code_begin();
513 unsigned char* p = entry->code_start();
514 unsigned char* end = entry->code_limit();
515 #else
516 unsigned char* p = nm->code_begin();
517 unsigned char* end = nm->code_end();
518 #endif // SHARK
519
520 // If there has been profiling, print the buckets.
521 if (FlatProfiler::bucket_start_for(p) != NULL) {
522 unsigned char* p1 = p;
523 int total_bucket_count = 0;
524 while (p1 < end) {
525 unsigned char* p0 = p1;
526 p1 += pd_instruction_alignment();
527 address bucket_pc = FlatProfiler::bucket_start_for(p1);
528 if (bucket_pc != NULL && bucket_pc > p0 && bucket_pc <= p1)
529 total_bucket_count += FlatProfiler::bucket_count_for(p0);
530 }
531 env.set_total_ticks(total_bucket_count);
532 }
533
534 // Print constant table.
535 if (nm->consts_size() > 0) {
536 nm->print_nmethod_labels(env.output(), nm->consts_begin());
537 int offset = 0;
538 for (address p = nm->consts_begin(); p < nm->consts_end(); p += 4, offset += 4) {
539 if ((offset % 8) == 0) {
540 env.output()->print_cr(" " PTR_FORMAT " (offset: %4d): " PTR32_FORMAT " " PTR64_FORMAT, p2i(p), offset, *((int32_t*) p), *((int64_t*) p));
541 } else {
542 env.output()->print_cr(" " PTR_FORMAT " (offset: %4d): " PTR32_FORMAT, p2i(p), offset, *((int32_t*) p));
543 }
544 }
545 }
546
547 env.decode_instructions(p, end);
548 }