src/share/vm/compiler/disassembler.cpp

Wed, 14 Oct 2020 17:44:48 +0800

author
aoqi
date
Wed, 14 Oct 2020 17:44:48 +0800
changeset 9931
fd44df5e3bc3
parent 9448
73d689add964
parent 9920
3a3803a0c789
child 10015
eb7ce841ccec
permissions
-rw-r--r--

Merge

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

mercurial