1 /*

     2  * Copyright (c) 1997, 2017, 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 "code/codeCache.hpp"

    27 #include "code/vmreg.inline.hpp"

    28 #include "compiler/abstractCompiler.hpp"

    29 #include "compiler/disassembler.hpp"

    30 #include "gc/shared/collectedHeap.inline.hpp"

    31 #include "interpreter/interpreter.hpp"

    32 #include "interpreter/oopMapCache.hpp"

    33 #include "memory/resourceArea.hpp"

    34 #include "memory/universe.inline.hpp"

    35 #include "oops/markOop.hpp"

    36 #include "oops/method.hpp"

    37 #include "oops/methodData.hpp"

    38 #include "oops/oop.inline.hpp"

    39 #include "oops/verifyOopClosure.hpp"

    40 #include "prims/methodHandles.hpp"

    41 #include "runtime/frame.inline.hpp"

    42 #include "runtime/handles.inline.hpp"

    43 #include "runtime/javaCalls.hpp"

    44 #include "runtime/monitorChunk.hpp"

    45 #include "runtime/os.hpp"

    46 #include "runtime/sharedRuntime.hpp"

    47 #include "runtime/signature.hpp"

    48 #include "runtime/stubCodeGenerator.hpp"

    49 #include "runtime/stubRoutines.hpp"

    50 #include "runtime/thread.inline.hpp"

    51 #include "utilities/debug.hpp"

    52 #include "utilities/decoder.hpp"

    53 #include "utilities/formatBuffer.hpp"

    54 

    55 RegisterMap::RegisterMap(JavaThread *thread, bool update_map) {

    56   _thread         = thread;

    57   _update_map     = update_map;

    58   clear();

    59   debug_only(_update_for_id = NULL;)

    60 #ifndef PRODUCT

    61   for (int i = 0; i < reg_count ; i++ ) _location[i] = NULL;

    62 #endif /* PRODUCT */

    63 }

    64 

    65 RegisterMap::RegisterMap(const RegisterMap* map) {

    66   assert(map != this, "bad initialization parameter");

    67   assert(map != NULL, "RegisterMap must be present");

    68   _thread                = map->thread();

    69   _update_map            = map->update_map();

    70   _include_argument_oops = map->include_argument_oops();

    71   debug_only(_update_for_id = map->_update_for_id;)

    72   pd_initialize_from(map);

    73   if (update_map()) {

    74     for(int i = 0; i < location_valid_size; i++) {

    75       LocationValidType bits = !update_map() ? 0 : map->_location_valid[i];

    76       _location_valid[i] = bits;

    77       // for whichever bits are set, pull in the corresponding map->_location

    78       int j = i*location_valid_type_size;

    79       while (bits != 0) {

    80         if ((bits & 1) != 0) {

    81           assert(0 <= j && j < reg_count, "range check");

    82           _location[j] = map->_location[j];

    83         }

    84         bits >>= 1;

    85         j += 1;

    86       }

    87     }

    88   }

    89 }

    90 

    91 void RegisterMap::clear() {

    92   set_include_argument_oops(true);

    93   if (_update_map) {

    94     for(int i = 0; i < location_valid_size; i++) {

    95       _location_valid[i] = 0;

    96     }

    97     pd_clear();

    98   } else {

    99     pd_initialize();

   100   }

   101 }

   102 

   103 #ifndef PRODUCT

   104 

   105 void RegisterMap::print_on(outputStream* st) const {

   106   st->print_cr("Register map");

   107   for(int i = 0; i < reg_count; i++) {

   108 

   109     VMReg r = VMRegImpl::as_VMReg(i);

   110     intptr_t* src = (intptr_t*) location(r);

   111     if (src != NULL) {

   112 

   113       r->print_on(st);

   114       st->print(" [" INTPTR_FORMAT "] = ", p2i(src));

   115       if (((uintptr_t)src & (sizeof(*src)-1)) != 0) {

   116         st->print_cr("<misaligned>");

   117       } else {

   118         st->print_cr(INTPTR_FORMAT, *src);

   119       }

   120     }

   121   }

   122 }

   123 

   124 void RegisterMap::print() const {

   125   print_on(tty);

   126 }

   127 

   128 #endif

   129 // This returns the pc that if you were in the debugger you'd see. Not

   130 // the idealized value in the frame object. This undoes the magic conversion

   131 // that happens for deoptimized frames. In addition it makes the value the

   132 // hardware would want to see in the native frame. The only user (at this point)

   133 // is deoptimization. It likely no one else should ever use it.

   134 

   135 address frame::raw_pc() const {

   136   if (is_deoptimized_frame()) {

   137     CompiledMethod* cm = cb()->as_compiled_method_or_null();

   138     if (cm->is_method_handle_return(pc()))

   139       return cm->deopt_mh_handler_begin() - pc_return_offset;

   140     else

   141       return cm->deopt_handler_begin() - pc_return_offset;

   142   } else {

   143     return (pc() - pc_return_offset);

   144   }

   145 }

   146 

   147 // Change the pc in a frame object. This does not change the actual pc in

   148 // actual frame. To do that use patch_pc.

   149 //

   150 void frame::set_pc(address   newpc ) {

   151 #ifdef ASSERT

   152   if (_cb != NULL && _cb->is_nmethod()) {

   153     assert(!((nmethod*)_cb)->is_deopt_pc(_pc), "invariant violation");

   154   }

   155 #endif // ASSERT

   156 

   157   // Unsafe to use the is_deoptimzed tester after changing pc

   158   _deopt_state = unknown;

   159   _pc = newpc;

   160   _cb = CodeCache::find_blob_unsafe(_pc);

   161 

   162 }

   163 

   164 // type testers

   165 bool frame::is_ignored_frame() const {

   166   return false;  // FIXME: some LambdaForm frames should be ignored

   167 }

   168 bool frame::is_deoptimized_frame() const {

   169   assert(_deopt_state != unknown, "not answerable");

   170   return _deopt_state == is_deoptimized;

   171 }

   172 

   173 bool frame::is_native_frame() const {

   174   return (_cb != NULL &&

   175           _cb->is_nmethod() &&

   176           ((nmethod*)_cb)->is_native_method());

   177 }

   178 

   179 bool frame::is_java_frame() const {

   180   if (is_interpreted_frame()) return true;

   181   if (is_compiled_frame())    return true;

   182   return false;

   183 }

   184 

   185 

   186 bool frame::is_compiled_frame() const {

   187   if (_cb != NULL &&

   188       _cb->is_compiled() &&

   189       ((CompiledMethod*)_cb)->is_java_method()) {

   190     return true;

   191   }

   192   return false;

   193 }

   194 

   195 

   196 bool frame::is_runtime_frame() const {

   197   return (_cb != NULL && _cb->is_runtime_stub());

   198 }

   199 

   200 bool frame::is_safepoint_blob_frame() const {

   201   return (_cb != NULL && _cb->is_safepoint_stub());

   202 }

   203 

   204 // testers

   205 

   206 bool frame::is_first_java_frame() const {

   207   RegisterMap map(JavaThread::current(), false); // No update

   208   frame s;

   209   for (s = sender(&map); !(s.is_java_frame() || s.is_first_frame()); s = s.sender(&map));

   210   return s.is_first_frame();

   211 }

   212 

   213 

   214 bool frame::entry_frame_is_first() const {

   215   return entry_frame_call_wrapper()->is_first_frame();

   216 }

   217 

   218 JavaCallWrapper* frame::entry_frame_call_wrapper_if_safe(JavaThread* thread) const {

   219   JavaCallWrapper** jcw = entry_frame_call_wrapper_addr();

   220   address addr = (address) jcw;

   221 

   222   // addr must be within the usable part of the stack

   223   if (thread->is_in_usable_stack(addr)) {

   224     return *jcw;

   225   }

   226 

   227   return NULL;

   228 }

   229 

   230 bool frame::is_entry_frame_valid(JavaThread* thread) const {

   231   // Validate the JavaCallWrapper an entry frame must have

   232   address jcw = (address)entry_frame_call_wrapper();

   233   bool jcw_safe = (jcw < thread->stack_base()) && (jcw > (address)fp()); // less than stack base

   234   if (!jcw_safe) {

   235     return false;

   236   }

   237 

   238   // Validate sp saved in the java frame anchor

   239   JavaFrameAnchor* jfa = entry_frame_call_wrapper()->anchor();

   240   return (jfa->last_Java_sp() > sp());

   241 }

   242 

   243 bool frame::should_be_deoptimized() const {

   244   if (_deopt_state == is_deoptimized ||

   245       !is_compiled_frame() ) return false;

   246   assert(_cb != NULL && _cb->is_compiled(), "must be an nmethod");

   247   CompiledMethod* nm = (CompiledMethod *)_cb;

   248   if (TraceDependencies) {

   249     tty->print("checking (%s) ", nm->is_marked_for_deoptimization() ? "true" : "false");

   250     nm->print_value_on(tty);

   251     tty->cr();

   252   }

   253 

   254   if( !nm->is_marked_for_deoptimization() )

   255     return false;

   256 

   257   // If at the return point, then the frame has already been popped, and

   258   // only the return needs to be executed. Don't deoptimize here.

   259   return !nm->is_at_poll_return(pc());

   260 }

   261 

   262 bool frame::can_be_deoptimized() const {

   263   if (!is_compiled_frame()) return false;

   264   CompiledMethod* nm = (CompiledMethod*)_cb;

   265 

   266   if( !nm->can_be_deoptimized() )

   267     return false;

   268 

   269   return !nm->is_at_poll_return(pc());

   270 }

   271 

   272 void frame::deoptimize(JavaThread* thread) {

   273   // Schedule deoptimization of an nmethod activation with this frame.

   274   assert(_cb != NULL && _cb->is_compiled(), "must be");

   275 

   276   // This is a fix for register window patching race

   277   if (NeedsDeoptSuspend && Thread::current() != thread) {

   278     assert(SafepointSynchronize::is_at_safepoint(),

   279            "patching other threads for deopt may only occur at a safepoint");

   280 

   281     // It is possible especially with DeoptimizeALot/DeoptimizeRandom that

   282     // we could see the frame again and ask for it to be deoptimized since

   283     // it might move for a long time. That is harmless and we just ignore it.

   284     if (id() == thread->must_deopt_id()) {

   285       assert(thread->is_deopt_suspend(), "lost suspension");

   286       return;

   287     }

   288 

   289     // We are at a safepoint so the target thread can only be

   290     // in 4 states:

   291     //     blocked - no problem

   292     //     blocked_trans - no problem (i.e. could have woken up from blocked

   293     //                                 during a safepoint).

   294     //     native - register window pc patching race

   295     //     native_trans - momentary state

   296     //

   297     // We could just wait out a thread in native_trans to block.

   298     // Then we'd have all the issues that the safepoint code has as to

   299     // whether to spin or block. It isn't worth it. Just treat it like

   300     // native and be done with it.

   301     //

   302     // Examine the state of the thread at the start of safepoint since

   303     // threads that were in native at the start of the safepoint could

   304     // come to a halt during the safepoint, changing the current value

   305     // of the safepoint_state.

   306     JavaThreadState state = thread->safepoint_state()->orig_thread_state();

   307     if (state == _thread_in_native || state == _thread_in_native_trans) {

   308       // Since we are at a safepoint the target thread will stop itself

   309       // before it can return to java as long as we remain at the safepoint.

   310       // Therefore we can put an additional request for the thread to stop

   311       // no matter what no (like a suspend). This will cause the thread

   312       // to notice it needs to do the deopt on its own once it leaves native.

   313       //

   314       // The only reason we must do this is because on machine with register

   315       // windows we have a race with patching the return address and the

   316       // window coming live as the thread returns to the Java code (but still

   317       // in native mode) and then blocks. It is only this top most frame

   318       // that is at risk. So in truth we could add an additional check to

   319       // see if this frame is one that is at risk.

   320       RegisterMap map(thread, false);

   321       frame at_risk =  thread->last_frame().sender(&map);

   322       if (id() == at_risk.id()) {

   323         thread->set_must_deopt_id(id());

   324         thread->set_deopt_suspend();

   325         return;

   326       }

   327     }

   328   } // NeedsDeoptSuspend

   329 

   330 

   331   // If the call site is a MethodHandle call site use the MH deopt

   332   // handler.

   333   CompiledMethod* cm = (CompiledMethod*) _cb;

   334   address deopt = cm->is_method_handle_return(pc()) ?

   335                         cm->deopt_mh_handler_begin() :

   336                         cm->deopt_handler_begin();

   337 

   338   // Save the original pc before we patch in the new one

   339   cm->set_original_pc(this, pc());

   340   patch_pc(thread, deopt);

   341 

   342 #ifdef ASSERT

   343   {

   344     RegisterMap map(thread, false);

   345     frame check = thread->last_frame();

   346     while (id() != check.id()) {

   347       check = check.sender(&map);

   348     }

   349     assert(check.is_deoptimized_frame(), "missed deopt");

   350   }

   351 #endif // ASSERT

   352 }

   353 

   354 frame frame::java_sender() const {

   355   RegisterMap map(JavaThread::current(), false);

   356   frame s;

   357   for (s = sender(&map); !(s.is_java_frame() || s.is_first_frame()); s = s.sender(&map)) ;

   358   guarantee(s.is_java_frame(), "tried to get caller of first java frame");

   359   return s;

   360 }

   361 

   362 frame frame::real_sender(RegisterMap* map) const {

   363   frame result = sender(map);

   364   while (result.is_runtime_frame() ||

   365          result.is_ignored_frame()) {

   366     result = result.sender(map);

   367   }

   368   return result;

   369 }

   370 

   371 // Note: called by profiler - NOT for current thread

   372 frame frame::profile_find_Java_sender_frame(JavaThread *thread) {

   373 // If we don't recognize this frame, walk back up the stack until we do

   374   RegisterMap map(thread, false);

   375   frame first_java_frame = frame();

   376 

   377   // Find the first Java frame on the stack starting with input frame

   378   if (is_java_frame()) {

   379     // top frame is compiled frame or deoptimized frame

   380     first_java_frame = *this;

   381   } else if (safe_for_sender(thread)) {

   382     for (frame sender_frame = sender(&map);

   383       sender_frame.safe_for_sender(thread) && !sender_frame.is_first_frame();

   384       sender_frame = sender_frame.sender(&map)) {

   385       if (sender_frame.is_java_frame()) {

   386         first_java_frame = sender_frame;

   387         break;

   388       }

   389     }

   390   }

   391   return first_java_frame;

   392 }

   393 

   394 // Interpreter frames

   395 

   396 

   397 void frame::interpreter_frame_set_locals(intptr_t* locs)  {

   398   assert(is_interpreted_frame(), "Not an interpreted frame");

   399   *interpreter_frame_locals_addr() = locs;

   400 }

   401 

   402 Method* frame::interpreter_frame_method() const {

   403   assert(is_interpreted_frame(), "interpreted frame expected");

   404   Method* m = *interpreter_frame_method_addr();

   405   assert(m->is_method(), "not a Method*");

   406   return m;

   407 }

   408 

   409 void frame::interpreter_frame_set_method(Method* method) {

   410   assert(is_interpreted_frame(), "interpreted frame expected");

   411   *interpreter_frame_method_addr() = method;

   412 }

   413 

   414 void frame::interpreter_frame_set_mirror(oop mirror) {

   415   assert(is_interpreted_frame(), "interpreted frame expected");

   416   *interpreter_frame_mirror_addr() = mirror;

   417 }

   418 

   419 jint frame::interpreter_frame_bci() const {

   420   assert(is_interpreted_frame(), "interpreted frame expected");

   421   address bcp = interpreter_frame_bcp();

   422   return interpreter_frame_method()->bci_from(bcp);

   423 }

   424 

   425 address frame::interpreter_frame_bcp() const {

   426   assert(is_interpreted_frame(), "interpreted frame expected");

   427   address bcp = (address)*interpreter_frame_bcp_addr();

   428   return interpreter_frame_method()->bcp_from(bcp);

   429 }

   430 

   431 void frame::interpreter_frame_set_bcp(address bcp) {

   432   assert(is_interpreted_frame(), "interpreted frame expected");

   433   *interpreter_frame_bcp_addr() = (intptr_t)bcp;

   434 }

   435 

   436 address frame::interpreter_frame_mdp() const {

   437   assert(ProfileInterpreter, "must be profiling interpreter");

   438   assert(is_interpreted_frame(), "interpreted frame expected");

   439   return (address)*interpreter_frame_mdp_addr();

   440 }

   441 

   442 void frame::interpreter_frame_set_mdp(address mdp) {

   443   assert(is_interpreted_frame(), "interpreted frame expected");

   444   assert(ProfileInterpreter, "must be profiling interpreter");

   445   *interpreter_frame_mdp_addr() = (intptr_t)mdp;

   446 }

   447 

   448 BasicObjectLock* frame::next_monitor_in_interpreter_frame(BasicObjectLock* current) const {

   449   assert(is_interpreted_frame(), "Not an interpreted frame");

   450 #ifdef ASSERT

   451   interpreter_frame_verify_monitor(current);

   452 #endif

   453   BasicObjectLock* next = (BasicObjectLock*) (((intptr_t*) current) + interpreter_frame_monitor_size());

   454   return next;

   455 }

   456 

   457 BasicObjectLock* frame::previous_monitor_in_interpreter_frame(BasicObjectLock* current) const {

   458   assert(is_interpreted_frame(), "Not an interpreted frame");

   459 #ifdef ASSERT

   460 //   // This verification needs to be checked before being enabled

   461 //   interpreter_frame_verify_monitor(current);

   462 #endif

   463   BasicObjectLock* previous = (BasicObjectLock*) (((intptr_t*) current) - interpreter_frame_monitor_size());

   464   return previous;

   465 }

   466 

   467 // Interpreter locals and expression stack locations.

   468 

   469 intptr_t* frame::interpreter_frame_local_at(int index) const {

   470   const int n = Interpreter::local_offset_in_bytes(index)/wordSize;

   471   return &((*interpreter_frame_locals_addr())[n]);

   472 }

   473 

   474 intptr_t* frame::interpreter_frame_expression_stack_at(jint offset) const {

   475   const int i = offset * interpreter_frame_expression_stack_direction();

   476   const int n = i * Interpreter::stackElementWords;

   477   return &(interpreter_frame_expression_stack()[n]);

   478 }

   479 

   480 jint frame::interpreter_frame_expression_stack_size() const {

   481   // Number of elements on the interpreter expression stack

   482   // Callers should span by stackElementWords

   483   int element_size = Interpreter::stackElementWords;

   484   size_t stack_size = 0;

   485   if (frame::interpreter_frame_expression_stack_direction() < 0) {

   486     stack_size = (interpreter_frame_expression_stack() -

   487                   interpreter_frame_tos_address() + 1)/element_size;

   488   } else {

   489     stack_size = (interpreter_frame_tos_address() -

   490                   interpreter_frame_expression_stack() + 1)/element_size;

   491   }

   492   assert( stack_size <= (size_t)max_jint, "stack size too big");

   493   return ((jint)stack_size);

   494 }

   495 

   496 

   497 // (frame::interpreter_frame_sender_sp accessor is in frame_<arch>.cpp)

   498 

   499 const char* frame::print_name() const {

   500   if (is_native_frame())      return "Native";

   501   if (is_interpreted_frame()) return "Interpreted";

   502   if (is_compiled_frame()) {

   503     if (is_deoptimized_frame()) return "Deoptimized";

   504     return "Compiled";

   505   }

   506   if (sp() == NULL)            return "Empty";

   507   return "C";

   508 }

   509 

   510 void frame::print_value_on(outputStream* st, JavaThread *thread) const {

   511   NOT_PRODUCT(address begin = pc()-40;)

   512   NOT_PRODUCT(address end   = NULL;)

   513 

   514   st->print("%s frame (sp=" INTPTR_FORMAT " unextended sp=" INTPTR_FORMAT, print_name(), p2i(sp()), p2i(unextended_sp()));

   515   if (sp() != NULL)

   516     st->print(", fp=" INTPTR_FORMAT ", real_fp=" INTPTR_FORMAT ", pc=" INTPTR_FORMAT,

   517               p2i(fp()), p2i(real_fp()), p2i(pc()));

   518 

   519   if (StubRoutines::contains(pc())) {

   520     st->print_cr(")");

   521     st->print("(");

   522     StubCodeDesc* desc = StubCodeDesc::desc_for(pc());

   523     st->print("~Stub::%s", desc->name());

   524     NOT_PRODUCT(begin = desc->begin(); end = desc->end();)

   525   } else if (Interpreter::contains(pc())) {

   526     st->print_cr(")");

   527     st->print("(");

   528     InterpreterCodelet* desc = Interpreter::codelet_containing(pc());

   529     if (desc != NULL) {

   530       st->print("~");

   531       desc->print_on(st);

   532       NOT_PRODUCT(begin = desc->code_begin(); end = desc->code_end();)

   533     } else {

   534       st->print("~interpreter");

   535     }

   536   }

   537   st->print_cr(")");

   538 

   539   if (_cb != NULL) {

   540     st->print("     ");

   541     _cb->print_value_on(st);

   542     st->cr();

   543 #ifndef PRODUCT

   544     if (end == NULL) {

   545       begin = _cb->code_begin();

   546       end   = _cb->code_end();

   547     }

   548 #endif

   549   }

   550   NOT_PRODUCT(if (WizardMode && Verbose) Disassembler::decode(begin, end);)

   551 }

   552 

   553 

   554 void frame::print_on(outputStream* st) const {

   555   print_value_on(st,NULL);

   556   if (is_interpreted_frame()) {

   557     interpreter_frame_print_on(st);

   558   }

   559 }

   560 

   561 

   562 void frame::interpreter_frame_print_on(outputStream* st) const {

   563 #ifndef PRODUCT

   564   assert(is_interpreted_frame(), "Not an interpreted frame");

   565   jint i;

   566   for (i = 0; i < interpreter_frame_method()->max_locals(); i++ ) {

   567     intptr_t x = *interpreter_frame_local_at(i);

   568     st->print(" - local  [" INTPTR_FORMAT "]", x);

   569     st->fill_to(23);

   570     st->print_cr("; #%d", i);

   571   }

   572   for (i = interpreter_frame_expression_stack_size() - 1; i >= 0; --i ) {

   573     intptr_t x = *interpreter_frame_expression_stack_at(i);

   574     st->print(" - stack  [" INTPTR_FORMAT "]", x);

   575     st->fill_to(23);

   576     st->print_cr("; #%d", i);

   577   }

   578   // locks for synchronization

   579   for (BasicObjectLock* current = interpreter_frame_monitor_end();

   580        current < interpreter_frame_monitor_begin();

   581        current = next_monitor_in_interpreter_frame(current)) {

   582     st->print(" - obj    [");

   583     current->obj()->print_value_on(st);

   584     st->print_cr("]");

   585     st->print(" - lock   [");

   586     current->lock()->print_on(st);

   587     st->print_cr("]");

   588   }

   589   // monitor

   590   st->print_cr(" - monitor[" INTPTR_FORMAT "]", p2i(interpreter_frame_monitor_begin()));

   591   // bcp

   592   st->print(" - bcp    [" INTPTR_FORMAT "]", p2i(interpreter_frame_bcp()));

   593   st->fill_to(23);

   594   st->print_cr("; @%d", interpreter_frame_bci());

   595   // locals

   596   st->print_cr(" - locals [" INTPTR_FORMAT "]", p2i(interpreter_frame_local_at(0)));

   597   // method

   598   st->print(" - method [" INTPTR_FORMAT "]", p2i(interpreter_frame_method()));

   599   st->fill_to(23);

   600   st->print("; ");

   601   interpreter_frame_method()->print_name(st);

   602   st->cr();

   603 #endif

   604 }

   605 

   606 // Print whether the frame is in the VM or OS indicating a HotSpot problem.

   607 // Otherwise, it's likely a bug in the native library that the Java code calls,

   608 // hopefully indicating where to submit bugs.

   609 void frame::print_C_frame(outputStream* st, char* buf, int buflen, address pc) {

   610   // C/C++ frame

   611   bool in_vm = os::address_is_in_vm(pc);

   612   st->print(in_vm ? "V" : "C");

   613 

   614   int offset;

   615   bool found;

   616 

   617   // libname

   618   found = os::dll_address_to_library_name(pc, buf, buflen, &offset);

   619   if (found) {

   620     // skip directory names

   621     const char *p1, *p2;

   622     p1 = buf;

   623     int len = (int)strlen(os::file_separator());

   624     while ((p2 = strstr(p1, os::file_separator())) != NULL) p1 = p2 + len;

   625     st->print("  [%s+0x%x]", p1, offset);

   626   } else {

   627     st->print("  " PTR_FORMAT, p2i(pc));

   628   }

   629 

   630   // function name - os::dll_address_to_function_name() may return confusing

   631   // names if pc is within jvm.dll or libjvm.so, because JVM only has

   632   // JVM_xxxx and a few other symbols in the dynamic symbol table. Do this

   633   // only for native libraries.

   634   if (!in_vm || Decoder::can_decode_C_frame_in_vm()) {

   635     found = os::dll_address_to_function_name(pc, buf, buflen, &offset);

   636 

   637     if (found) {

   638       st->print("  %s+0x%x", buf, offset);

   639     }

   640   }

   641 }

   642 

   643 // frame::print_on_error() is called by fatal error handler. Notice that we may

   644 // crash inside this function if stack frame is corrupted. The fatal error

   645 // handler can catch and handle the crash. Here we assume the frame is valid.

   646 //

   647 // First letter indicates type of the frame:

   648 //    J: Java frame (compiled)

   649 //    A: Java frame (aot compiled)

   650 //    j: Java frame (interpreted)

   651 //    V: VM frame (C/C++)

   652 //    v: Other frames running VM generated code (e.g. stubs, adapters, etc.)

   653 //    C: C/C++ frame

   654 //

   655 // We don't need detailed frame type as that in frame::print_name(). "C"

   656 // suggests the problem is in user lib; everything else is likely a VM bug.

   657 

   658 void frame::print_on_error(outputStream* st, char* buf, int buflen, bool verbose) const {

   659   if (_cb != NULL) {

   660     if (Interpreter::contains(pc())) {

   661       Method* m = this->interpreter_frame_method();

   662       if (m != NULL) {

   663         m->name_and_sig_as_C_string(buf, buflen);

   664         st->print("j  %s", buf);

   665         st->print("+%d", this->interpreter_frame_bci());

   666         ModuleEntry* module = m->method_holder()->module();

   667         if (module->is_named()) {

   668           module->name()->as_C_string(buf, buflen);

   669           st->print(" %s", buf);

   670           if (module->version() != NULL) {

   671             module->version()->as_C_string(buf, buflen);

   672             st->print("@%s", buf);

   673           }

   674         }

   675       } else {

   676         st->print("j  " PTR_FORMAT, p2i(pc()));

   677       }

   678     } else if (StubRoutines::contains(pc())) {

   679       StubCodeDesc* desc = StubCodeDesc::desc_for(pc());

   680       if (desc != NULL) {

   681         st->print("v  ~StubRoutines::%s", desc->name());

   682       } else {

   683         st->print("v  ~StubRoutines::" PTR_FORMAT, p2i(pc()));

   684       }

   685     } else if (_cb->is_buffer_blob()) {

   686       st->print("v  ~BufferBlob::%s", ((BufferBlob *)_cb)->name());

   687     } else if (_cb->is_compiled()) {

   688       CompiledMethod* cm = (CompiledMethod*)_cb;

   689       Method* m = cm->method();

   690       if (m != NULL) {

   691         if (cm->is_aot()) {

   692           st->print("A %d ", cm->compile_id());

   693         } else if (cm->is_nmethod()) {

   694           nmethod* nm = cm->as_nmethod();

   695           st->print("J %d%s", nm->compile_id(), (nm->is_osr_method() ? "%" : ""));

   696           st->print(" %s", nm->compiler_name());

   697         }

   698         m->name_and_sig_as_C_string(buf, buflen);

   699         st->print(" %s", buf);

   700         ModuleEntry* module = m->method_holder()->module();

   701         if (module->is_named()) {

   702           module->name()->as_C_string(buf, buflen);

   703           st->print(" %s", buf);

   704           if (module->version() != NULL) {

   705             module->version()->as_C_string(buf, buflen);

   706             st->print("@%s", buf);

   707           }

   708         }

   709         st->print(" (%d bytes) @ " PTR_FORMAT " [" PTR_FORMAT "+" INTPTR_FORMAT "]",

   710                   m->code_size(), p2i(_pc), p2i(_cb->code_begin()), _pc - _cb->code_begin());

   711 #if INCLUDE_JVMCI

   712         if (cm->is_nmethod()) {

   713           nmethod* nm = cm->as_nmethod();

   714           char* jvmciName = nm->jvmci_installed_code_name(buf, buflen);

   715           if (jvmciName != NULL) {

   716             st->print(" (%s)", jvmciName);

   717           }

   718         }

   719 #endif

   720       } else {

   721         st->print("J  " PTR_FORMAT, p2i(pc()));

   722       }

   723     } else if (_cb->is_runtime_stub()) {

   724       st->print("v  ~RuntimeStub::%s", ((RuntimeStub *)_cb)->name());

   725     } else if (_cb->is_deoptimization_stub()) {

   726       st->print("v  ~DeoptimizationBlob");

   727     } else if (_cb->is_exception_stub()) {

   728       st->print("v  ~ExceptionBlob");

   729     } else if (_cb->is_safepoint_stub()) {

   730       st->print("v  ~SafepointBlob");

   731     } else {

   732       st->print("v  blob " PTR_FORMAT, p2i(pc()));

   733     }

   734   } else {

   735     print_C_frame(st, buf, buflen, pc());

   736   }

   737 }

   738 

   739 

   740 /*

   741   The interpreter_frame_expression_stack_at method in the case of SPARC needs the

   742   max_stack value of the method in order to compute the expression stack address.

   743   It uses the Method* in order to get the max_stack value but during GC this

   744   Method* value saved on the frame is changed by reverse_and_push and hence cannot

   745   be used. So we save the max_stack value in the FrameClosure object and pass it

   746   down to the interpreter_frame_expression_stack_at method

   747 */

   748 class InterpreterFrameClosure : public OffsetClosure {

   749  private:

   750   frame* _fr;

   751   OopClosure* _f;

   752   int    _max_locals;

   753   int    _max_stack;

   754 

   755  public:

   756   InterpreterFrameClosure(frame* fr, int max_locals, int max_stack,

   757                           OopClosure* f) {

   758     _fr         = fr;

   759     _max_locals = max_locals;

   760     _max_stack  = max_stack;

   761     _f          = f;

   762   }

   763 

   764   void offset_do(int offset) {

   765     oop* addr;

   766     if (offset < _max_locals) {

   767       addr = (oop*) _fr->interpreter_frame_local_at(offset);

   768       assert((intptr_t*)addr >= _fr->sp(), "must be inside the frame");

   769       _f->do_oop(addr);

   770     } else {

   771       addr = (oop*) _fr->interpreter_frame_expression_stack_at((offset - _max_locals));

   772       // In case of exceptions, the expression stack is invalid and the esp will be reset to express

   773       // this condition. Therefore, we call f only if addr is 'inside' the stack (i.e., addr >= esp for Intel).

   774       bool in_stack;

   775       if (frame::interpreter_frame_expression_stack_direction() > 0) {

   776         in_stack = (intptr_t*)addr <= _fr->interpreter_frame_tos_address();

   777       } else {

   778         in_stack = (intptr_t*)addr >= _fr->interpreter_frame_tos_address();

   779       }

   780       if (in_stack) {

   781         _f->do_oop(addr);

   782       }

   783     }

   784   }

   785 

   786   int max_locals()  { return _max_locals; }

   787   frame* fr()       { return _fr; }

   788 };

   789 

   790 

   791 class InterpretedArgumentOopFinder: public SignatureInfo {

   792  private:

   793   OopClosure* _f;        // Closure to invoke

   794   int    _offset;        // TOS-relative offset, decremented with each argument

   795   bool   _has_receiver;  // true if the callee has a receiver

   796   frame* _fr;

   797 

   798   void set(int size, BasicType type) {

   799     _offset -= size;

   800     if (type == T_OBJECT || type == T_ARRAY) oop_offset_do();

   801   }

   802 

   803   void oop_offset_do() {

   804     oop* addr;

   805     addr = (oop*)_fr->interpreter_frame_tos_at(_offset);

   806     _f->do_oop(addr);

   807   }

   808 

   809  public:

   810   InterpretedArgumentOopFinder(Symbol* signature, bool has_receiver, frame* fr, OopClosure* f) : SignatureInfo(signature), _has_receiver(has_receiver) {

   811     // compute size of arguments

   812     int args_size = ArgumentSizeComputer(signature).size() + (has_receiver ? 1 : 0);

   813     assert(!fr->is_interpreted_frame() ||

   814            args_size <= fr->interpreter_frame_expression_stack_size(),

   815             "args cannot be on stack anymore");

   816     // initialize InterpretedArgumentOopFinder

   817     _f         = f;

   818     _fr        = fr;

   819     _offset    = args_size;

   820   }

   821 

   822   void oops_do() {

   823     if (_has_receiver) {

   824       --_offset;

   825       oop_offset_do();

   826     }

   827     iterate_parameters();

   828   }

   829 };

   830 

   831 

   832 // Entry frame has following form (n arguments)

   833 //         +-----------+

   834 //   sp -> |  last arg |

   835 //         +-----------+

   836 //         :    :::    :

   837 //         +-----------+

   838 // (sp+n)->|  first arg|

   839 //         +-----------+

   840 

   841 

   842 

   843 // visits and GC's all the arguments in entry frame

   844 class EntryFrameOopFinder: public SignatureInfo {

   845  private:

   846   bool   _is_static;

   847   int    _offset;

   848   frame* _fr;

   849   OopClosure* _f;

   850 

   851   void set(int size, BasicType type) {

   852     assert (_offset >= 0, "illegal offset");

   853     if (type == T_OBJECT || type == T_ARRAY) oop_at_offset_do(_offset);

   854     _offset -= size;

   855   }

   856 

   857   void oop_at_offset_do(int offset) {

   858     assert (offset >= 0, "illegal offset");

   859     oop* addr = (oop*) _fr->entry_frame_argument_at(offset);

   860     _f->do_oop(addr);

   861   }

   862 

   863  public:

   864    EntryFrameOopFinder(frame* frame, Symbol* signature, bool is_static) : SignatureInfo(signature) {

   865      _f = NULL; // will be set later

   866      _fr = frame;

   867      _is_static = is_static;

   868      _offset = ArgumentSizeComputer(signature).size() - 1; // last parameter is at index 0

   869    }

   870 

   871   void arguments_do(OopClosure* f) {

   872     _f = f;

   873     if (!_is_static) oop_at_offset_do(_offset+1); // do the receiver

   874     iterate_parameters();

   875   }

   876 

   877 };

   878 

   879 oop* frame::interpreter_callee_receiver_addr(Symbol* signature) {

   880   ArgumentSizeComputer asc(signature);

   881   int size = asc.size();

   882   return (oop *)interpreter_frame_tos_at(size);

   883 }

   884 

   885 

   886 void frame::oops_interpreted_do(OopClosure* f, const RegisterMap* map, bool query_oop_map_cache) {

   887   assert(is_interpreted_frame(), "Not an interpreted frame");

   888   assert(map != NULL, "map must be set");

   889   Thread *thread = Thread::current();

   890   methodHandle m (thread, interpreter_frame_method());

   891   jint      bci = interpreter_frame_bci();

   892 

   893   assert(!Universe::heap()->is_in(m()),

   894           "must be valid oop");

   895   assert(m->is_method(), "checking frame value");

   896   assert((m->is_native() && bci == 0)  ||

   897          (!m->is_native() && bci >= 0 && bci < m->code_size()),

   898          "invalid bci value");

   899 

   900   // Handle the monitor elements in the activation

   901   for (

   902     BasicObjectLock* current = interpreter_frame_monitor_end();

   903     current < interpreter_frame_monitor_begin();

   904     current = next_monitor_in_interpreter_frame(current)

   905   ) {

   906 #ifdef ASSERT

   907     interpreter_frame_verify_monitor(current);

   908 #endif

   909     current->oops_do(f);

   910   }

   911 

   912   if (m->is_native()) {

   913     f->do_oop(interpreter_frame_temp_oop_addr());

   914   }

   915 

   916   // The method pointer in the frame might be the only path to the method's

   917   // klass, and the klass needs to be kept alive while executing. The GCs

   918   // don't trace through method pointers, so the mirror of the method's klass

   919   // is installed as a GC root.

   920   f->do_oop(interpreter_frame_mirror_addr());

   921 

   922   int max_locals = m->is_native() ? m->size_of_parameters() : m->max_locals();

   923 

   924   Symbol* signature = NULL;

   925   bool has_receiver = false;

   926 

   927   // Process a callee's arguments if we are at a call site

   928   // (i.e., if we are at an invoke bytecode)

   929   // This is used sometimes for calling into the VM, not for another

   930   // interpreted or compiled frame.

   931   if (!m->is_native()) {

   932     Bytecode_invoke call = Bytecode_invoke_check(m, bci);

   933     if (call.is_valid()) {

   934       signature = call.signature();

   935       has_receiver = call.has_receiver();

   936       if (map->include_argument_oops() &&

   937           interpreter_frame_expression_stack_size() > 0) {

   938         ResourceMark rm(thread);  // is this right ???

   939         // we are at a call site & the expression stack is not empty

   940         // => process callee's arguments

   941         //

   942         // Note: The expression stack can be empty if an exception

   943         //       occurred during method resolution/execution. In all

   944         //       cases we empty the expression stack completely be-

   945         //       fore handling the exception (the exception handling

   946         //       code in the interpreter calls a blocking runtime

   947         //       routine which can cause this code to be executed).

   948         //       (was bug gri 7/27/98)

   949         oops_interpreted_arguments_do(signature, has_receiver, f);

   950       }

   951     }

   952   }

   953 

   954   InterpreterFrameClosure blk(this, max_locals, m->max_stack(), f);

   955 

   956   // process locals & expression stack

   957   InterpreterOopMap mask;

   958   if (query_oop_map_cache) {

   959     m->mask_for(bci, &mask);

   960   } else {

   961     OopMapCache::compute_one_oop_map(m, bci, &mask);

   962   }

   963   mask.iterate_oop(&blk);

   964 }

   965 

   966 

   967 void frame::oops_interpreted_arguments_do(Symbol* signature, bool has_receiver, OopClosure* f) {

   968   InterpretedArgumentOopFinder finder(signature, has_receiver, this, f);

   969   finder.oops_do();

   970 }

   971 

   972 void frame::oops_code_blob_do(OopClosure* f, CodeBlobClosure* cf, const RegisterMap* reg_map) {

   973   assert(_cb != NULL, "sanity check");

   974   if (_cb->oop_maps() != NULL) {

   975     OopMapSet::oops_do(this, reg_map, f);

   976 

   977     // Preserve potential arguments for a callee. We handle this by dispatching

   978     // on the codeblob. For c2i, we do

   979     if (reg_map->include_argument_oops()) {

   980       _cb->preserve_callee_argument_oops(*this, reg_map, f);

   981     }

   982   }

   983   // In cases where perm gen is collected, GC will want to mark

   984   // oops referenced from nmethods active on thread stacks so as to

   985   // prevent them from being collected. However, this visit should be

   986   // restricted to certain phases of the collection only. The

   987   // closure decides how it wants nmethods to be traced.

   988   if (cf != NULL)

   989     cf->do_code_blob(_cb);

   990 }

   991 

   992 class CompiledArgumentOopFinder: public SignatureInfo {

   993  protected:

   994   OopClosure*     _f;

   995   int             _offset;        // the current offset, incremented with each argument

   996   bool            _has_receiver;  // true if the callee has a receiver

   997   bool            _has_appendix;  // true if the call has an appendix

   998   frame           _fr;

   999   RegisterMap*    _reg_map;

  1000   int             _arg_size;

  1001   VMRegPair*      _regs;        // VMReg list of arguments

  1002 

  1003   void set(int size, BasicType type) {

  1004     if (type == T_OBJECT || type == T_ARRAY) handle_oop_offset();

  1005     _offset += size;

  1006   }

  1007 

  1008   virtual void handle_oop_offset() {

  1009     // Extract low order register number from register array.

  1010     // In LP64-land, the high-order bits are valid but unhelpful.

  1011     VMReg reg = _regs[_offset].first();

  1012     oop *loc = _fr.oopmapreg_to_location(reg, _reg_map);

  1013     _f->do_oop(loc);

  1014   }

  1015 

  1016  public:

  1017   CompiledArgumentOopFinder(Symbol* signature, bool has_receiver, bool has_appendix, OopClosure* f, frame fr,  const RegisterMap* reg_map)

  1018     : SignatureInfo(signature) {

  1019 

  1020     // initialize CompiledArgumentOopFinder

  1021     _f         = f;

  1022     _offset    = 0;

  1023     _has_receiver = has_receiver;

  1024     _has_appendix = has_appendix;

  1025     _fr        = fr;

  1026     _reg_map   = (RegisterMap*)reg_map;

  1027     _arg_size  = ArgumentSizeComputer(signature).size() + (has_receiver ? 1 : 0) + (has_appendix ? 1 : 0);

  1028 

  1029     int arg_size;

  1030     _regs = SharedRuntime::find_callee_arguments(signature, has_receiver, has_appendix, &arg_size);

  1031     assert(arg_size == _arg_size, "wrong arg size");

  1032   }

  1033 

  1034   void oops_do() {

  1035     if (_has_receiver) {

  1036       handle_oop_offset();

  1037       _offset++;

  1038     }

  1039     iterate_parameters();

  1040     if (_has_appendix) {

  1041       handle_oop_offset();

  1042       _offset++;

  1043     }

  1044   }

  1045 };

  1046 

  1047 void frame::oops_compiled_arguments_do(Symbol* signature, bool has_receiver, bool has_appendix,

  1048                                        const RegisterMap* reg_map, OopClosure* f) {

  1049   ResourceMark rm;

  1050   CompiledArgumentOopFinder finder(signature, has_receiver, has_appendix, f, *this, reg_map);

  1051   finder.oops_do();

  1052 }

  1053 

  1054 

  1055 // Get receiver out of callers frame, i.e. find parameter 0 in callers

  1056 // frame.  Consult ADLC for where parameter 0 is to be found.  Then

  1057 // check local reg_map for it being a callee-save register or argument

  1058 // register, both of which are saved in the local frame.  If not found

  1059 // there, it must be an in-stack argument of the caller.

  1060 // Note: caller.sp() points to callee-arguments

  1061 oop frame::retrieve_receiver(RegisterMap* reg_map) {

  1062   frame caller = *this;

  1063 

  1064   // First consult the ADLC on where it puts parameter 0 for this signature.

  1065   VMReg reg = SharedRuntime::name_for_receiver();

  1066   oop* oop_adr = caller.oopmapreg_to_location(reg, reg_map);

  1067   if (oop_adr == NULL) {

  1068     guarantee(oop_adr != NULL, "bad register save location");

  1069     return NULL;

  1070   }

  1071   oop r = *oop_adr;

  1072   assert(Universe::heap()->is_in_or_null(r), "bad receiver: " INTPTR_FORMAT " (" INTX_FORMAT ")", p2i(r), p2i(r));

  1073   return r;

  1074 }

  1075 

  1076 

  1077 BasicLock* frame::get_native_monitor() {

  1078   nmethod* nm = (nmethod*)_cb;

  1079   assert(_cb != NULL && _cb->is_nmethod() && nm->method()->is_native(),

  1080          "Should not call this unless it's a native nmethod");

  1081   int byte_offset = in_bytes(nm->native_basic_lock_sp_offset());

  1082   assert(byte_offset >= 0, "should not see invalid offset");

  1083   return (BasicLock*) &sp()[byte_offset / wordSize];

  1084 }

  1085 

  1086 oop frame::get_native_receiver() {

  1087   nmethod* nm = (nmethod*)_cb;

  1088   assert(_cb != NULL && _cb->is_nmethod() && nm->method()->is_native(),

  1089          "Should not call this unless it's a native nmethod");

  1090   int byte_offset = in_bytes(nm->native_receiver_sp_offset());

  1091   assert(byte_offset >= 0, "should not see invalid offset");

  1092   oop owner = ((oop*) sp())[byte_offset / wordSize];

  1093   assert( Universe::heap()->is_in(owner), "bad receiver" );

  1094   return owner;

  1095 }

  1096 

  1097 void frame::oops_entry_do(OopClosure* f, const RegisterMap* map) {

  1098   assert(map != NULL, "map must be set");

  1099   if (map->include_argument_oops()) {

  1100     // must collect argument oops, as nobody else is doing it

  1101     Thread *thread = Thread::current();

  1102     methodHandle m (thread, entry_frame_call_wrapper()->callee_method());

  1103     EntryFrameOopFinder finder(this, m->signature(), m->is_static());

  1104     finder.arguments_do(f);

  1105   }

  1106   // Traverse the Handle Block saved in the entry frame

  1107   entry_frame_call_wrapper()->oops_do(f);

  1108 }

  1109 

  1110 

  1111 void frame::oops_do_internal(OopClosure* f, CodeBlobClosure* cf, RegisterMap* map, bool use_interpreter_oop_map_cache) {

  1112 #ifndef PRODUCT

  1113   // simulate GC crash here to dump java thread in error report

  1114   if (CrashGCForDumpingJavaThread) {

  1115     char *t = NULL;

  1116     *t = 'c';

  1117   }

  1118 #endif

  1119   if (is_interpreted_frame()) {

  1120     oops_interpreted_do(f, map, use_interpreter_oop_map_cache);

  1121   } else if (is_entry_frame()) {

  1122     oops_entry_do(f, map);

  1123   } else if (CodeCache::contains(pc())) {

  1124     oops_code_blob_do(f, cf, map);

  1125 #ifdef SHARK

  1126   } else if (is_fake_stub_frame()) {

  1127     // nothing to do

  1128 #endif // SHARK

  1129   } else {

  1130     ShouldNotReachHere();

  1131   }

  1132 }

  1133 

  1134 void frame::nmethods_do(CodeBlobClosure* cf) {