1 /*
   2  * Copyright (c) 1997, 2018, 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.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/valueKlass.hpp"
  40 #include "oops/verifyOopClosure.hpp"
  41 #include "prims/methodHandles.hpp"
  42 #include "runtime/frame.inline.hpp"
  43 #include "runtime/handles.inline.hpp"
  44 #include "runtime/javaCalls.hpp"
  45 #include "runtime/monitorChunk.hpp"
  46 #include "runtime/os.hpp"
  47 #include "runtime/sharedRuntime.hpp"
  48 #include "runtime/signature.hpp"
  49 #include "runtime/stubCodeGenerator.hpp"
  50 #include "runtime/stubRoutines.hpp"
  51 #include "runtime/thread.inline.hpp"
  52 #include "utilities/debug.hpp"
  53 #include "utilities/decoder.hpp"
  54 #include "utilities/formatBuffer.hpp"
  55 
  56 RegisterMap::RegisterMap(JavaThread *thread, bool update_map) {
  57   _thread         = thread;
  58   _update_map     = update_map;
  59   clear();
  60   debug_only(_update_for_id = NULL;)
  61 #ifndef PRODUCT
  62   for (int i = 0; i < reg_count ; i++ ) _location[i] = NULL;
  63 #endif /* PRODUCT */
  64 }
  65 
  66 RegisterMap::RegisterMap(const RegisterMap* map) {
  67   assert(map != this, "bad initialization parameter");
  68   assert(map != NULL, "RegisterMap must be present");
  69   _thread                = map->thread();
  70   _update_map            = map->update_map();
  71   _include_argument_oops = map->include_argument_oops();
  72   debug_only(_update_for_id = map->_update_for_id;)
  73   pd_initialize_from(map);
  74   if (update_map()) {
  75     for(int i = 0; i < location_valid_size; i++) {
  76       LocationValidType bits = !update_map() ? 0 : map->_location_valid[i];
  77       _location_valid[i] = bits;
  78       // for whichever bits are set, pull in the corresponding map->_location
  79       int j = i*location_valid_type_size;
  80       while (bits != 0) {
  81         if ((bits & 1) != 0) {
  82           assert(0 <= j && j < reg_count, "range check");
  83           _location[j] = map->_location[j];
  84         }
  85         bits >>= 1;
  86         j += 1;
  87       }
  88     }
  89   }
  90 }
  91 
  92 void RegisterMap::clear() {
  93   set_include_argument_oops(true);
  94   if (_update_map) {
  95     for(int i = 0; i < location_valid_size; i++) {
  96       _location_valid[i] = 0;
  97     }
  98     pd_clear();
  99   } else {
 100     pd_initialize();
 101   }
 102 }
 103 
 104 #ifndef PRODUCT
 105 
 106 void RegisterMap::print_on(outputStream* st) const {
 107   st->print_cr("Register map");
 108   for(int i = 0; i < reg_count; i++) {
 109 
 110     VMReg r = VMRegImpl::as_VMReg(i);
 111     intptr_t* src = (intptr_t*) location(r);
 112     if (src != NULL) {
 113 
 114       r->print_on(st);
 115       st->print(" [" INTPTR_FORMAT "] = ", p2i(src));
 116       if (((uintptr_t)src & (sizeof(*src)-1)) != 0) {
 117         st->print_cr("<misaligned>");
 118       } else {
 119         st->print_cr(INTPTR_FORMAT, *src);
 120       }
 121     }
 122   }
 123 }
 124 
 125 void RegisterMap::print() const {
 126   print_on(tty);
 127 }
 128 
 129 #endif
 130 // This returns the pc that if you were in the debugger you'd see. Not
 131 // the idealized value in the frame object. This undoes the magic conversion
 132 // that happens for deoptimized frames. In addition it makes the value the
 133 // hardware would want to see in the native frame. The only user (at this point)
 134 // is deoptimization. It likely no one else should ever use it.
 135 
 136 address frame::raw_pc() const {
 137   if (is_deoptimized_frame()) {
 138     CompiledMethod* cm = cb()->as_compiled_method_or_null();
 139     if (cm->is_method_handle_return(pc()))
 140       return cm->deopt_mh_handler_begin() - pc_return_offset;
 141     else
 142       return cm->deopt_handler_begin() - pc_return_offset;
 143   } else {
 144     return (pc() - pc_return_offset);
 145   }
 146 }
 147 
 148 // Change the pc in a frame object. This does not change the actual pc in
 149 // actual frame. To do that use patch_pc.
 150 //
 151 void frame::set_pc(address   newpc ) {
 152 #ifdef ASSERT
 153   if (_cb != NULL && _cb->is_nmethod()) {
 154     assert(!((nmethod*)_cb)->is_deopt_pc(_pc), "invariant violation");
 155   }
 156 #endif // ASSERT
 157 
 158   // Unsafe to use the is_deoptimzed tester after changing pc
 159   _deopt_state = unknown;
 160   _pc = newpc;
 161   _cb = CodeCache::find_blob_unsafe(_pc);
 162 
 163 }
 164 
 165 // type testers
 166 bool frame::is_ignored_frame() const {
 167   return false;  // FIXME: some LambdaForm frames should be ignored
 168 }
 169 bool frame::is_deoptimized_frame() const {
 170   assert(_deopt_state != unknown, "not answerable");
 171   return _deopt_state == is_deoptimized;
 172 }
 173 
 174 bool frame::is_native_frame() const {
 175   return (_cb != NULL &&
 176           _cb->is_nmethod() &&
 177           ((nmethod*)_cb)->is_native_method());
 178 }
 179 
 180 bool frame::is_java_frame() const {
 181   if (is_interpreted_frame()) return true;
 182   if (is_compiled_frame())    return true;
 183   return false;
 184 }
 185 
 186 
 187 bool frame::is_compiled_frame() const {
 188   if (_cb != NULL &&
 189       _cb->is_compiled() &&
 190       ((CompiledMethod*)_cb)->is_java_method()) {
 191     return true;
 192   }
 193   return false;
 194 }
 195 
 196 
 197 bool frame::is_runtime_frame() const {
 198   return (_cb != NULL && _cb->is_runtime_stub());
 199 }
 200 
 201 bool frame::is_safepoint_blob_frame() const {
 202   return (_cb != NULL && _cb->is_safepoint_stub());
 203 }
 204 
 205 // testers
 206 
 207 bool frame::is_first_java_frame() const {
 208   RegisterMap map(JavaThread::current(), false); // No update
 209   frame s;
 210   for (s = sender(&map); !(s.is_java_frame() || s.is_first_frame()); s = s.sender(&map));
 211   return s.is_first_frame();
 212 }
 213 
 214 
 215 bool frame::entry_frame_is_first() const {
 216   return entry_frame_call_wrapper()->is_first_frame();
 217 }
 218 
 219 JavaCallWrapper* frame::entry_frame_call_wrapper_if_safe(JavaThread* thread) const {
 220   JavaCallWrapper** jcw = entry_frame_call_wrapper_addr();
 221   address addr = (address) jcw;
 222 
 223   // addr must be within the usable part of the stack
 224   if (thread->is_in_usable_stack(addr)) {
 225     return *jcw;
 226   }
 227 
 228   return NULL;
 229 }
 230 
 231 bool frame::is_entry_frame_valid(JavaThread* thread) const {
 232   // Validate the JavaCallWrapper an entry frame must have
 233   address jcw = (address)entry_frame_call_wrapper();
 234   bool jcw_safe = (jcw < thread->stack_base()) && (jcw > (address)fp()); // less than stack base
 235   if (!jcw_safe) {
 236     return false;
 237   }
 238 
 239   // Validate sp saved in the java frame anchor
 240   JavaFrameAnchor* jfa = entry_frame_call_wrapper()->anchor();
 241   return (jfa->last_Java_sp() > sp());
 242 }
 243 
 244 bool frame::should_be_deoptimized() const {
 245   if (_deopt_state == is_deoptimized ||
 246       !is_compiled_frame() ) return false;
 247   assert(_cb != NULL && _cb->is_compiled(), "must be an nmethod");
 248   CompiledMethod* nm = (CompiledMethod *)_cb;
 249   if (TraceDependencies) {
 250     tty->print("checking (%s) ", nm->is_marked_for_deoptimization() ? "true" : "false");
 251     nm->print_value_on(tty);
 252     tty->cr();
 253   }
 254 
 255   if( !nm->is_marked_for_deoptimization() )
 256     return false;
 257 
 258   // If at the return point, then the frame has already been popped, and
 259   // only the return needs to be executed. Don't deoptimize here.
 260   return !nm->is_at_poll_return(pc());
 261 }
 262 
 263 bool frame::can_be_deoptimized() const {
 264   if (!is_compiled_frame()) return false;
 265   CompiledMethod* nm = (CompiledMethod*)_cb;
 266 
 267   if( !nm->can_be_deoptimized() )
 268     return false;
 269 
 270   return !nm->is_at_poll_return(pc());
 271 }
 272 
 273 void frame::deoptimize(JavaThread* thread) {
 274   // Schedule deoptimization of an nmethod activation with this frame.
 275   assert(_cb != NULL && _cb->is_compiled(), "must be");
 276 
 277   // This is a fix for register window patching race
 278   if (NeedsDeoptSuspend && Thread::current() != thread) {
 279     assert(SafepointSynchronize::is_at_safepoint(),
 280            "patching other threads for deopt may only occur at a safepoint");
 281 
 282     // It is possible especially with DeoptimizeALot/DeoptimizeRandom that
 283     // we could see the frame again and ask for it to be deoptimized since
 284     // it might move for a long time. That is harmless and we just ignore it.
 285     if (id() == thread->must_deopt_id()) {
 286       assert(thread->is_deopt_suspend(), "lost suspension");
 287       return;
 288     }
 289 
 290     // We are at a safepoint so the target thread can only be
 291     // in 4 states:
 292     //     blocked - no problem
 293     //     blocked_trans - no problem (i.e. could have woken up from blocked
 294     //                                 during a safepoint).
 295     //     native - register window pc patching race
 296     //     native_trans - momentary state
 297     //
 298     // We could just wait out a thread in native_trans to block.
 299     // Then we'd have all the issues that the safepoint code has as to
 300     // whether to spin or block. It isn't worth it. Just treat it like
 301     // native and be done with it.
 302     //
 303     // Examine the state of the thread at the start of safepoint since
 304     // threads that were in native at the start of the safepoint could
 305     // come to a halt during the safepoint, changing the current value
 306     // of the safepoint_state.
 307     JavaThreadState state = thread->safepoint_state()->orig_thread_state();
 308     if (state == _thread_in_native || state == _thread_in_native_trans) {
 309       // Since we are at a safepoint the target thread will stop itself
 310       // before it can return to java as long as we remain at the safepoint.
 311       // Therefore we can put an additional request for the thread to stop
 312       // no matter what no (like a suspend). This will cause the thread
 313       // to notice it needs to do the deopt on its own once it leaves native.
 314       //
 315       // The only reason we must do this is because on machine with register
 316       // windows we have a race with patching the return address and the
 317       // window coming live as the thread returns to the Java code (but still
 318       // in native mode) and then blocks. It is only this top most frame
 319       // that is at risk. So in truth we could add an additional check to
 320       // see if this frame is one that is at risk.
 321       RegisterMap map(thread, false);
 322       frame at_risk =  thread->last_frame().sender(&map);
 323       if (id() == at_risk.id()) {
 324         thread->set_must_deopt_id(id());
 325         thread->set_deopt_suspend();
 326         return;
 327       }
 328     }
 329   } // NeedsDeoptSuspend
 330 
 331 
 332   // If the call site is a MethodHandle call site use the MH deopt
 333   // handler.
 334   CompiledMethod* cm = (CompiledMethod*) _cb;
 335   address deopt = cm->is_method_handle_return(pc()) ?
 336                         cm->deopt_mh_handler_begin() :
 337                         cm->deopt_handler_begin();
 338 
 339   // Save the original pc before we patch in the new one
 340   cm->set_original_pc(this, pc());
 341   patch_pc(thread, deopt);
 342 
 343 #ifdef ASSERT
 344   {
 345     RegisterMap map(thread, false);
 346     frame check = thread->last_frame();
 347     while (id() != check.id()) {
 348       check = check.sender(&map);
 349     }
 350     assert(check.is_deoptimized_frame(), "missed deopt");
 351   }
 352 #endif // ASSERT
 353 }
 354 
 355 frame frame::java_sender() const {
 356   RegisterMap map(JavaThread::current(), false);
 357   frame s;
 358   for (s = sender(&map); !(s.is_java_frame() || s.is_first_frame()); s = s.sender(&map)) ;
 359   guarantee(s.is_java_frame(), "tried to get caller of first java frame");
 360   return s;
 361 }
 362 
 363 frame frame::real_sender(RegisterMap* map) const {
 364   frame result = sender(map);
 365   while (result.is_runtime_frame() ||
 366          result.is_ignored_frame()) {
 367     result = result.sender(map);
 368   }
 369   return result;
 370 }
 371 
 372 // Note: called by profiler - NOT for current thread
 373 frame frame::profile_find_Java_sender_frame(JavaThread *thread) {
 374 // If we don't recognize this frame, walk back up the stack until we do
 375   RegisterMap map(thread, false);
 376   frame first_java_frame = frame();
 377 
 378   // Find the first Java frame on the stack starting with input frame
 379   if (is_java_frame()) {
 380     // top frame is compiled frame or deoptimized frame
 381     first_java_frame = *this;
 382   } else if (safe_for_sender(thread)) {
 383     for (frame sender_frame = sender(&map);
 384       sender_frame.safe_for_sender(thread) && !sender_frame.is_first_frame();
 385       sender_frame = sender_frame.sender(&map)) {
 386       if (sender_frame.is_java_frame()) {
 387         first_java_frame = sender_frame;
 388         break;
 389       }
 390     }
 391   }
 392   return first_java_frame;
 393 }
 394 
 395 // Interpreter frames
 396 
 397 
 398 void frame::interpreter_frame_set_locals(intptr_t* locs)  {
 399   assert(is_interpreted_frame(), "Not an interpreted frame");
 400   *interpreter_frame_locals_addr() = locs;
 401 }
 402 
 403 Method* frame::interpreter_frame_method() const {
 404   assert(is_interpreted_frame(), "interpreted frame expected");
 405   Method* m = *interpreter_frame_method_addr();
 406   assert(m->is_method(), "not a Method*");
 407   return m;
 408 }
 409 
 410 void frame::interpreter_frame_set_method(Method* method) {
 411   assert(is_interpreted_frame(), "interpreted frame expected");
 412   *interpreter_frame_method_addr() = method;
 413 }
 414 
 415 void frame::interpreter_frame_set_mirror(oop mirror) {
 416   assert(is_interpreted_frame(), "interpreted frame expected");
 417   *interpreter_frame_mirror_addr() = mirror;
 418 }
 419 
 420 jint frame::interpreter_frame_bci() const {
 421   assert(is_interpreted_frame(), "interpreted frame expected");
 422   address bcp = interpreter_frame_bcp();
 423   return interpreter_frame_method()->bci_from(bcp);
 424 }
 425 
 426 address frame::interpreter_frame_bcp() const {
 427   assert(is_interpreted_frame(), "interpreted frame expected");
 428   address bcp = (address)*interpreter_frame_bcp_addr();
 429   return interpreter_frame_method()->bcp_from(bcp);
 430 }
 431 
 432 void frame::interpreter_frame_set_bcp(address bcp) {
 433   assert(is_interpreted_frame(), "interpreted frame expected");
 434   *interpreter_frame_bcp_addr() = (intptr_t)bcp;
 435 }
 436 
 437 address frame::interpreter_frame_mdp() const {
 438   assert(ProfileInterpreter, "must be profiling interpreter");
 439   assert(is_interpreted_frame(), "interpreted frame expected");
 440   return (address)*interpreter_frame_mdp_addr();
 441 }
 442 
 443 void frame::interpreter_frame_set_mdp(address mdp) {
 444   assert(is_interpreted_frame(), "interpreted frame expected");
 445   assert(ProfileInterpreter, "must be profiling interpreter");
 446   *interpreter_frame_mdp_addr() = (intptr_t)mdp;
 447 }
 448 
 449 BasicObjectLock* frame::next_monitor_in_interpreter_frame(BasicObjectLock* current) const {
 450   assert(is_interpreted_frame(), "Not an interpreted frame");
 451 #ifdef ASSERT
 452   interpreter_frame_verify_monitor(current);
 453 #endif
 454   BasicObjectLock* next = (BasicObjectLock*) (((intptr_t*) current) + interpreter_frame_monitor_size());
 455   return next;
 456 }
 457 
 458 BasicObjectLock* frame::previous_monitor_in_interpreter_frame(BasicObjectLock* current) const {
 459   assert(is_interpreted_frame(), "Not an interpreted frame");
 460 #ifdef ASSERT
 461 //   // This verification needs to be checked before being enabled
 462 //   interpreter_frame_verify_monitor(current);
 463 #endif
 464   BasicObjectLock* previous = (BasicObjectLock*) (((intptr_t*) current) - interpreter_frame_monitor_size());
 465   return previous;
 466 }
 467 
 468 // Interpreter locals and expression stack locations.
 469 
 470 intptr_t* frame::interpreter_frame_local_at(int index) const {
 471   const int n = Interpreter::local_offset_in_bytes(index)/wordSize;
 472   return &((*interpreter_frame_locals_addr())[n]);
 473 }
 474 
 475 intptr_t* frame::interpreter_frame_expression_stack_at(jint offset) const {
 476   const int i = offset * interpreter_frame_expression_stack_direction();
 477   const int n = i * Interpreter::stackElementWords;
 478   return &(interpreter_frame_expression_stack()[n]);
 479 }
 480 
 481 jint frame::interpreter_frame_expression_stack_size() const {
 482   // Number of elements on the interpreter expression stack
 483   // Callers should span by stackElementWords
 484   int element_size = Interpreter::stackElementWords;
 485   size_t stack_size = 0;
 486   if (frame::interpreter_frame_expression_stack_direction() < 0) {
 487     stack_size = (interpreter_frame_expression_stack() -
 488                   interpreter_frame_tos_address() + 1)/element_size;
 489   } else {
 490     stack_size = (interpreter_frame_tos_address() -
 491                   interpreter_frame_expression_stack() + 1)/element_size;
 492   }
 493   assert( stack_size <= (size_t)max_jint, "stack size too big");
 494   return ((jint)stack_size);
 495 }
 496 
 497 
 498 // (frame::interpreter_frame_sender_sp accessor is in frame_<arch>.cpp)
 499 
 500 const char* frame::print_name() const {
 501   if (is_native_frame())      return "Native";
 502   if (is_interpreted_frame()) return "Interpreted";
 503   if (is_compiled_frame()) {
 504     if (is_deoptimized_frame()) return "Deoptimized";
 505     return "Compiled";
 506   }
 507   if (sp() == NULL)            return "Empty";
 508   return "C";
 509 }
 510 
 511 void frame::print_value_on(outputStream* st, JavaThread *thread) const {
 512   NOT_PRODUCT(address begin = pc()-40;)
 513   NOT_PRODUCT(address end   = NULL;)
 514 
 515   st->print("%s frame (sp=" INTPTR_FORMAT " unextended sp=" INTPTR_FORMAT, print_name(), p2i(sp()), p2i(unextended_sp()));
 516   if (sp() != NULL)
 517     st->print(", fp=" INTPTR_FORMAT ", real_fp=" INTPTR_FORMAT ", pc=" INTPTR_FORMAT,
 518               p2i(fp()), p2i(real_fp()), p2i(pc()));
 519 
 520   if (StubRoutines::contains(pc())) {
 521     st->print_cr(")");
 522     st->print("(");
 523     StubCodeDesc* desc = StubCodeDesc::desc_for(pc());
 524     st->print("~Stub::%s", desc->name());
 525     NOT_PRODUCT(begin = desc->begin(); end = desc->end();)
 526   } else if (Interpreter::contains(pc())) {
 527     st->print_cr(")");
 528     st->print("(");
 529     InterpreterCodelet* desc = Interpreter::codelet_containing(pc());
 530     if (desc != NULL) {
 531       st->print("~");
 532       desc->print_on(st);
 533       NOT_PRODUCT(begin = desc->code_begin(); end = desc->code_end();)
 534     } else {
 535       st->print("~interpreter");
 536     }
 537   }
 538   st->print_cr(")");
 539 
 540   if (_cb != NULL) {
 541     st->print("     ");
 542     _cb->print_value_on(st);
 543     st->cr();
 544 #ifndef PRODUCT
 545     if (end == NULL) {
 546       begin = _cb->code_begin();
 547       end   = _cb->code_end();
 548     }
 549 #endif
 550   }
 551   NOT_PRODUCT(if (WizardMode && Verbose) Disassembler::decode(begin, end);)
 552 }
 553 
 554 
 555 void frame::print_on(outputStream* st) const {
 556   print_value_on(st,NULL);
 557   if (is_interpreted_frame()) {
 558     interpreter_frame_print_on(st);
 559   }
 560 }
 561 
 562 
 563 void frame::interpreter_frame_print_on(outputStream* st) const {
 564 #ifndef PRODUCT
 565   assert(is_interpreted_frame(), "Not an interpreted frame");
 566   jint i;
 567   for (i = 0; i < interpreter_frame_method()->max_locals(); i++ ) {
 568     intptr_t x = *interpreter_frame_local_at(i);
 569     st->print(" - local  [" INTPTR_FORMAT "]", x);
 570     st->fill_to(23);
 571     st->print_cr("; #%d", i);
 572   }
 573   for (i = interpreter_frame_expression_stack_size() - 1; i >= 0; --i ) {
 574     intptr_t x = *interpreter_frame_expression_stack_at(i);
 575     st->print(" - stack  [" INTPTR_FORMAT "]", x);
 576     st->fill_to(23);
 577     st->print_cr("; #%d", i);
 578   }
 579   // locks for synchronization
 580   for (BasicObjectLock* current = interpreter_frame_monitor_end();
 581        current < interpreter_frame_monitor_begin();
 582        current = next_monitor_in_interpreter_frame(current)) {
 583     st->print(" - obj    [");
 584     current->obj()->print_value_on(st);
 585     st->print_cr("]");
 586     st->print(" - lock   [");
 587     current->lock()->print_on(st);
 588     st->print_cr("]");
 589   }
 590   // monitor
 591   st->print_cr(" - monitor[" INTPTR_FORMAT "]", p2i(interpreter_frame_monitor_begin()));
 592   // bcp
 593   st->print(" - bcp    [" INTPTR_FORMAT "]", p2i(interpreter_frame_bcp()));
 594   st->fill_to(23);
 595   st->print_cr("; @%d", interpreter_frame_bci());
 596   // locals
 597   st->print_cr(" - locals [" INTPTR_FORMAT "]", p2i(interpreter_frame_local_at(0)));
 598   // method
 599   st->print(" - method [" INTPTR_FORMAT "]", p2i(interpreter_frame_method()));
 600   st->fill_to(23);
 601   st->print("; ");
 602   interpreter_frame_method()->print_name(st);
 603   st->cr();
 604 #endif
 605 }
 606 
 607 // Print whether the frame is in the VM or OS indicating a HotSpot problem.
 608 // Otherwise, it's likely a bug in the native library that the Java code calls,
 609 // hopefully indicating where to submit bugs.
 610 void frame::print_C_frame(outputStream* st, char* buf, int buflen, address pc) {
 611   // C/C++ frame
 612   bool in_vm = os::address_is_in_vm(pc);
 613   st->print(in_vm ? "V" : "C");
 614 
 615   int offset;
 616   bool found;
 617 
 618   // libname
 619   found = os::dll_address_to_library_name(pc, buf, buflen, &offset);
 620   if (found) {
 621     // skip directory names
 622     const char *p1, *p2;
 623     p1 = buf;
 624     int len = (int)strlen(os::file_separator());
 625     while ((p2 = strstr(p1, os::file_separator())) != NULL) p1 = p2 + len;
 626     st->print("  [%s+0x%x]", p1, offset);
 627   } else {
 628     st->print("  " PTR_FORMAT, p2i(pc));
 629   }
 630 
 631   found = os::dll_address_to_function_name(pc, buf, buflen, &offset);
 632   if (found) {
 633     st->print("  %s+0x%x", buf, offset);
 634   }
 635 }
 636 
 637 // frame::print_on_error() is called by fatal error handler. Notice that we may
 638 // crash inside this function if stack frame is corrupted. The fatal error
 639 // handler can catch and handle the crash. Here we assume the frame is valid.
 640 //
 641 // First letter indicates type of the frame:
 642 //    J: Java frame (compiled)
 643 //    A: Java frame (aot compiled)
 644 //    j: Java frame (interpreted)
 645 //    V: VM frame (C/C++)
 646 //    v: Other frames running VM generated code (e.g. stubs, adapters, etc.)
 647 //    C: C/C++ frame
 648 //
 649 // We don't need detailed frame type as that in frame::print_name(). "C"
 650 // suggests the problem is in user lib; everything else is likely a VM bug.
 651 
 652 void frame::print_on_error(outputStream* st, char* buf, int buflen, bool verbose) const {
 653   if (_cb != NULL) {
 654     if (Interpreter::contains(pc())) {
 655       Method* m = this->interpreter_frame_method();
 656       if (m != NULL) {
 657         m->name_and_sig_as_C_string(buf, buflen);
 658         st->print("j  %s", buf);
 659         st->print("+%d", this->interpreter_frame_bci());
 660         ModuleEntry* module = m->method_holder()->module();
 661         if (module->is_named()) {
 662           module->name()->as_C_string(buf, buflen);
 663           st->print(" %s", buf);
 664           if (module->version() != NULL) {
 665             module->version()->as_C_string(buf, buflen);
 666             st->print("@%s", buf);
 667           }
 668         }
 669       } else {
 670         st->print("j  " PTR_FORMAT, p2i(pc()));
 671       }
 672     } else if (StubRoutines::contains(pc())) {
 673       StubCodeDesc* desc = StubCodeDesc::desc_for(pc());
 674       if (desc != NULL) {
 675         st->print("v  ~StubRoutines::%s", desc->name());
 676       } else {
 677         st->print("v  ~StubRoutines::" PTR_FORMAT, p2i(pc()));
 678       }
 679     } else if (_cb->is_buffer_blob()) {
 680       st->print("v  ~BufferBlob::%s", ((BufferBlob *)_cb)->name());
 681     } else if (_cb->is_compiled()) {
 682       CompiledMethod* cm = (CompiledMethod*)_cb;
 683       Method* m = cm->method();
 684       if (m != NULL) {
 685         if (cm->is_aot()) {
 686           st->print("A %d ", cm->compile_id());
 687         } else if (cm->is_nmethod()) {
 688           nmethod* nm = cm->as_nmethod();
 689           st->print("J %d%s", nm->compile_id(), (nm->is_osr_method() ? "%" : ""));
 690           st->print(" %s", nm->compiler_name());
 691         }
 692         m->name_and_sig_as_C_string(buf, buflen);
 693         st->print(" %s", buf);
 694         ModuleEntry* module = m->method_holder()->module();
 695         if (module->is_named()) {
 696           module->name()->as_C_string(buf, buflen);
 697           st->print(" %s", buf);
 698           if (module->version() != NULL) {
 699             module->version()->as_C_string(buf, buflen);
 700             st->print("@%s", buf);
 701           }
 702         }
 703         st->print(" (%d bytes) @ " PTR_FORMAT " [" PTR_FORMAT "+" INTPTR_FORMAT "]",
 704                   m->code_size(), p2i(_pc), p2i(_cb->code_begin()), _pc - _cb->code_begin());
 705 #if INCLUDE_JVMCI
 706         if (cm->is_nmethod()) {
 707           nmethod* nm = cm->as_nmethod();
 708           char* jvmciName = nm->jvmci_installed_code_name(buf, buflen);
 709           if (jvmciName != NULL) {
 710             st->print(" (%s)", jvmciName);
 711           }
 712         }
 713 #endif
 714       } else {
 715         st->print("J  " PTR_FORMAT, p2i(pc()));
 716       }
 717     } else if (_cb->is_runtime_stub()) {
 718       st->print("v  ~RuntimeStub::%s", ((RuntimeStub *)_cb)->name());
 719     } else if (_cb->is_deoptimization_stub()) {
 720       st->print("v  ~DeoptimizationBlob");
 721     } else if (_cb->is_exception_stub()) {
 722       st->print("v  ~ExceptionBlob");
 723     } else if (_cb->is_safepoint_stub()) {
 724       st->print("v  ~SafepointBlob");
 725     } else if (_cb->is_adapter_blob()) {
 726       st->print("v  ~AdapterBlob");
 727     } else if (_cb->is_vtable_blob()) {
 728       st->print("v  ~VtableBlob");
 729     } else if (_cb->is_method_handles_adapter_blob()) {
 730       st->print("v  ~MethodHandlesAdapterBlob");
 731     } else if (_cb->is_uncommon_trap_stub()) {
 732       st->print("v  ~UncommonTrapBlob");
 733     } else {
 734       st->print("v  blob " PTR_FORMAT, p2i(pc()));
 735     }
 736   } else {
 737     print_C_frame(st, buf, buflen, pc());
 738   }
 739 }
 740 
 741 
 742 /*
 743   The interpreter_frame_expression_stack_at method in the case of SPARC needs the
 744   max_stack value of the method in order to compute the expression stack address.
 745   It uses the Method* in order to get the max_stack value but during GC this
 746   Method* value saved on the frame is changed by reverse_and_push and hence cannot
 747   be used. So we save the max_stack value in the FrameClosure object and pass it
 748   down to the interpreter_frame_expression_stack_at method
 749 */
 750 class InterpreterFrameClosure : public OffsetClosure {
 751  private:
 752   frame* _fr;
 753   OopClosure* _f;
 754   int    _max_locals;
 755   int    _max_stack;
 756 
 757  public:
 758   InterpreterFrameClosure(frame* fr, int max_locals, int max_stack,
 759                           OopClosure* f, BufferedValueClosure* bvt_f) {
 760     _fr         = fr;
 761     _max_locals = max_locals;
 762     _max_stack  = max_stack;
 763     _f          = f;
 764   }
 765 
 766   void offset_do(int offset) {
 767     oop* addr;
 768     if (offset < _max_locals) {
 769       addr = (oop*) _fr->interpreter_frame_local_at(offset);
 770       assert((intptr_t*)addr >= _fr->sp(), "must be inside the frame");
 771       if (_f != NULL) {
 772         _f->do_oop(addr);
 773       }
 774     } else {
 775       addr = (oop*) _fr->interpreter_frame_expression_stack_at((offset - _max_locals));
 776       // In case of exceptions, the expression stack is invalid and the esp will be reset to express
 777       // this condition. Therefore, we call f only if addr is 'inside' the stack (i.e., addr >= esp for Intel).
 778       bool in_stack;
 779       if (frame::interpreter_frame_expression_stack_direction() > 0) {
 780         in_stack = (intptr_t*)addr <= _fr->interpreter_frame_tos_address();
 781       } else {
 782         in_stack = (intptr_t*)addr >= _fr->interpreter_frame_tos_address();
 783       }
 784       if (in_stack) {
 785         if (_f != NULL) {
 786           _f->do_oop(addr);
 787         }
 788       }
 789     }
 790   }
 791 
 792   int max_locals()  { return _max_locals; }
 793   frame* fr()       { return _fr; }
 794 };
 795 
 796 
 797 class InterpretedArgumentOopFinder: public SignatureInfo {
 798  private:
 799   OopClosure* _f;        // Closure to invoke
 800   int    _offset;        // TOS-relative offset, decremented with each argument
 801   bool   _has_receiver;  // true if the callee has a receiver
 802   frame* _fr;
 803 
 804   void set(int size, BasicType type) {
 805     _offset -= size;
 806     if (type == T_OBJECT || type == T_ARRAY || type == T_VALUETYPE) oop_offset_do();
 807   }
 808 
 809   void oop_offset_do() {
 810     oop* addr;
 811     addr = (oop*)_fr->interpreter_frame_tos_at(_offset);
 812     _f->do_oop(addr);
 813   }
 814 
 815  public:
 816   InterpretedArgumentOopFinder(Symbol* signature, bool has_receiver, frame* fr, OopClosure* f) : SignatureInfo(signature), _has_receiver(has_receiver) {
 817     // compute size of arguments
 818     int args_size = ArgumentSizeComputer(signature).size() + (has_receiver ? 1 : 0);
 819     assert(!fr->is_interpreted_frame() ||
 820            args_size <= fr->interpreter_frame_expression_stack_size(),
 821             "args cannot be on stack anymore");
 822     // initialize InterpretedArgumentOopFinder
 823     _f         = f;
 824     _fr        = fr;
 825     _offset    = args_size;
 826   }
 827 
 828   void oops_do() {
 829     if (_has_receiver) {
 830       --_offset;
 831       oop_offset_do();
 832     }
 833     iterate_parameters();
 834   }
 835 };
 836 
 837 
 838 // Entry frame has following form (n arguments)
 839 //         +-----------+
 840 //   sp -> |  last arg |
 841 //         +-----------+
 842 //         :    :::    :
 843 //         +-----------+
 844 // (sp+n)->|  first arg|
 845 //         +-----------+
 846 
 847 
 848 
 849 // visits and GC's all the arguments in entry frame
 850 class EntryFrameOopFinder: public SignatureInfo {
 851  private:
 852   bool   _is_static;
 853   int    _offset;
 854   frame* _fr;
 855   OopClosure* _f;
 856 
 857   void set(int size, BasicType type) {
 858     assert (_offset >= 0, "illegal offset");
 859     if (type == T_OBJECT || type == T_ARRAY || type == T_VALUETYPE) oop_at_offset_do(_offset);
 860     _offset -= size;
 861   }
 862 
 863   void oop_at_offset_do(int offset) {
 864     assert (offset >= 0, "illegal offset");
 865     oop* addr = (oop*) _fr->entry_frame_argument_at(offset);
 866     _f->do_oop(addr);
 867   }
 868 
 869  public:
 870    EntryFrameOopFinder(frame* frame, Symbol* signature, bool is_static) : SignatureInfo(signature) {
 871      _f = NULL; // will be set later
 872      _fr = frame;
 873      _is_static = is_static;
 874      _offset = ArgumentSizeComputer(signature).size() - 1; // last parameter is at index 0
 875    }
 876 
 877   void arguments_do(OopClosure* f) {
 878     _f = f;
 879     if (!_is_static) oop_at_offset_do(_offset+1); // do the receiver
 880     iterate_parameters();
 881   }
 882 
 883 };
 884 
 885 oop* frame::interpreter_callee_receiver_addr(Symbol* signature) {
 886   ArgumentSizeComputer asc(signature);
 887   int size = asc.size();
 888   return (oop *)interpreter_frame_tos_at(size);
 889 }
 890 
 891 
 892 void frame::oops_interpreted_do(OopClosure* f, const RegisterMap* map, bool query_oop_map_cache) {
 893   assert(is_interpreted_frame(), "Not an interpreted frame");
 894   assert(map != NULL, "map must be set");
 895   Thread *thread = Thread::current();
 896   methodHandle m (thread, interpreter_frame_method());
 897   jint      bci = interpreter_frame_bci();
 898 
 899   assert(!Universe::heap()->is_in(m()),
 900           "must be valid oop");
 901   assert(m->is_method(), "checking frame value");
 902   assert((m->is_native() && bci == 0)  ||
 903          (!m->is_native() && bci >= 0 && bci < m->code_size()),
 904          "invalid bci value");
 905 
 906   // Handle the monitor elements in the activation
 907   for (
 908     BasicObjectLock* current = interpreter_frame_monitor_end();
 909     current < interpreter_frame_monitor_begin();
 910     current = next_monitor_in_interpreter_frame(current)
 911   ) {
 912 #ifdef ASSERT
 913     interpreter_frame_verify_monitor(current);
 914 #endif
 915     current->oops_do(f);
 916   }
 917 
 918   if (m->is_native()) {
 919     f->do_oop(interpreter_frame_temp_oop_addr());
 920   }
 921 
 922   // The method pointer in the frame might be the only path to the method's
 923   // klass, and the klass needs to be kept alive while executing. The GCs
 924   // don't trace through method pointers, so the mirror of the method's klass
 925   // is installed as a GC root.
 926   f->do_oop(interpreter_frame_mirror_addr());
 927 
 928   int max_locals = m->is_native() ? m->size_of_parameters() : m->max_locals();
 929 
 930   Symbol* signature = NULL;
 931   bool has_receiver = false;
 932 
 933   // Process a callee's arguments if we are at a call site
 934   // (i.e., if we are at an invoke bytecode)
 935   // This is used sometimes for calling into the VM, not for another
 936   // interpreted or compiled frame.
 937   if (!m->is_native()) {
 938     Bytecode_invoke call = Bytecode_invoke_check(m, bci);
 939     if (call.is_valid()) {
 940       signature = call.signature();
 941       has_receiver = call.has_receiver();
 942       if (map->include_argument_oops() &&
 943           interpreter_frame_expression_stack_size() > 0) {
 944         ResourceMark rm(thread);  // is this right ???
 945         // we are at a call site & the expression stack is not empty
 946         // => process callee's arguments
 947         //
 948         // Note: The expression stack can be empty if an exception
 949         //       occurred during method resolution/execution. In all
 950         //       cases we empty the expression stack completely be-
 951         //       fore handling the exception (the exception handling
 952         //       code in the interpreter calls a blocking runtime
 953         //       routine which can cause this code to be executed).
 954         //       (was bug gri 7/27/98)
 955         oops_interpreted_arguments_do(signature, has_receiver, f);
 956       }
 957     }
 958   }
 959 
 960   InterpreterFrameClosure blk(this, max_locals, m->max_stack(), f, NULL);
 961 
 962   // process locals & expression stack
 963   InterpreterOopMap mask;
 964   if (query_oop_map_cache) {
 965     m->mask_for(bci, &mask);
 966   } else {
 967     OopMapCache::compute_one_oop_map(m, bci, &mask);
 968   }
 969   mask.iterate_oop(&blk);
 970 }
 971 
 972 void frame::buffered_values_interpreted_do(BufferedValueClosure* f) {
 973   assert(is_interpreted_frame(), "Not an interpreted frame");
 974   Thread *thread = Thread::current();
 975   methodHandle m (thread, interpreter_frame_method());
 976   jint      bci = interpreter_frame_bci();
 977 
 978   assert(m->is_method(), "checking frame value");
 979   assert(!m->is_native() && bci >= 0 && bci < m->code_size(),
 980          "invalid bci value");
 981 
 982   InterpreterFrameClosure blk(this, m->max_locals(), m->max_stack(), NULL, f);
 983 
 984   // process locals & expression stack
 985   InterpreterOopMap mask;
 986   m->mask_for(bci, &mask);
 987   mask.iterate_oop(&blk);
 988 }
 989 
 990 void frame::oops_interpreted_arguments_do(Symbol* signature, bool has_receiver, OopClosure* f) {
 991   InterpretedArgumentOopFinder finder(signature, has_receiver, this, f);
 992   finder.oops_do();
 993 }
 994 
 995 void frame::oops_code_blob_do(OopClosure* f, CodeBlobClosure* cf, const RegisterMap* reg_map) {
 996   assert(_cb != NULL, "sanity check");
 997   if (_cb->oop_maps() != NULL) {
 998     OopMapSet::oops_do(this, reg_map, f);
 999 
1000     // Preserve potential arguments for a callee. We handle this by dispatching
1001     // on the codeblob. For c2i, we do
1002     if (reg_map->include_argument_oops()) {
1003       _cb->preserve_callee_argument_oops(*this, reg_map, f);
1004     }
1005   }
1006   // In cases where perm gen is collected, GC will want to mark
1007   // oops referenced from nmethods active on thread stacks so as to
1008   // prevent them from being collected. However, this visit should be
1009   // restricted to certain phases of the collection only. The
1010   // closure decides how it wants nmethods to be traced.
1011   if (cf != NULL)
1012     cf->do_code_blob(_cb);
1013 }
1014 
1015 class CompiledArgumentOopFinder: public SignatureInfo {
1016  protected:
1017   OopClosure*     _f;
1018   int             _offset;        // the current offset, incremented with each argument
1019   bool            _has_receiver;  // true if the callee has a receiver
1020   bool            _has_appendix;  // true if the call has an appendix
1021   frame           _fr;
1022   RegisterMap*    _reg_map;
1023   int             _arg_size;
1024   VMRegPair*      _regs;        // VMReg list of arguments
1025 
1026   void set(int size, BasicType type) {
1027     if (type == T_OBJECT || type == T_ARRAY || type == T_VALUETYPE) handle_oop_offset();
1028     _offset += size;
1029   }
1030 
1031   virtual void handle_oop_offset() {
1032     // Extract low order register number from register array.
1033     // In LP64-land, the high-order bits are valid but unhelpful.
1034     assert(_offset < _arg_size, "out of bounds");
1035     VMReg reg = _regs[_offset].first();
1036     oop *loc = _fr.oopmapreg_to_location(reg, _reg_map);
1037     _f->do_oop(loc);
1038   }
1039 
1040  public:
1041   CompiledArgumentOopFinder(Symbol* signature, bool has_receiver, bool has_appendix, OopClosure* f, frame fr, const RegisterMap* reg_map)
1042     : SignatureInfo(signature) {
1043 
1044     // initialize CompiledArgumentOopFinder
1045     _f         = f;
1046     _offset    = 0;
1047     _has_receiver = has_receiver;
1048     _has_appendix = has_appendix;
1049     _fr        = fr;
1050     _reg_map   = (RegisterMap*)reg_map;
1051     _regs = SharedRuntime::find_callee_arguments(signature, has_receiver, has_appendix, &_arg_size);
1052   }
1053 
1054   void oops_do() {
1055     if (_has_receiver) {
1056       handle_oop_offset();
1057       _offset++;
1058     }
1059     iterate_parameters();
1060     if (_has_appendix) {
1061       handle_oop_offset();
1062       _offset++;
1063     }
1064   }
1065 };
1066 
1067 void frame::oops_compiled_arguments_do(Symbol* signature, bool has_receiver, bool has_appendix,
1068                                        const RegisterMap* reg_map, OopClosure* f) {
1069   ResourceMark rm;
1070   CompiledArgumentOopFinder finder(signature, has_receiver, has_appendix, f, *this, reg_map);
1071   finder.oops_do();
1072 }
1073 
1074 
1075 // Get receiver out of callers frame, i.e. find parameter 0 in callers
1076 // frame.  Consult ADLC for where parameter 0 is to be found.  Then
1077 // check local reg_map for it being a callee-save register or argument
1078 // register, both of which are saved in the local frame.  If not found
1079 // there, it must be an in-stack argument of the caller.
1080 // Note: caller.sp() points to callee-arguments
1081 oop frame::retrieve_receiver(RegisterMap* reg_map) {
1082   frame caller = *this;
1083 
1084   // First consult the ADLC on where it puts parameter 0 for this signature.
1085   VMReg reg = SharedRuntime::name_for_receiver();
1086   oop* oop_adr = caller.oopmapreg_to_location(reg, reg_map);
1087   if (oop_adr == NULL) {
1088     guarantee(oop_adr != NULL, "bad register save location");
1089     return NULL;
1090   }
1091   oop r = *oop_adr;
1092   assert(Universe::heap()->is_in_or_null(r), "bad receiver: " INTPTR_FORMAT " (" INTX_FORMAT ")", p2i(r), p2i(r));
1093   return r;
1094 }
1095 
1096 
1097 BasicLock* frame::get_native_monitor() {
1098   nmethod* nm = (nmethod*)_cb;
1099   assert(_cb != NULL && _cb->is_nmethod() && nm->method()->is_native(),
1100          "Should not call this unless it's a native nmethod");
1101   int byte_offset = in_bytes(nm->native_basic_lock_sp_offset());
1102   assert(byte_offset >= 0, "should not see invalid offset");
1103   return (BasicLock*) &sp()[byte_offset / wordSize];
1104 }
1105 
1106 oop frame::get_native_receiver() {
1107   nmethod* nm = (nmethod*)_cb;
1108   assert(_cb != NULL && _cb->is_nmethod() && nm->method()->is_native(),
1109          "Should not call this unless it's a native nmethod");
1110   int byte_offset = in_bytes(nm->native_receiver_sp_offset());
1111   assert(byte_offset >= 0, "should not see invalid offset");
1112   oop owner = ((oop*) sp())[byte_offset / wordSize];
1113   assert( Universe::heap()->is_in(owner), "bad receiver" );
1114   return owner;
1115 }
1116 
1117 void frame::oops_entry_do(OopClosure* f, const RegisterMap* map) {
1118   assert(map != NULL, "map must be set");
1119   if (map->include_argument_oops()) {
1120     // must collect argument oops, as nobody else is doing it
1121     Thread *thread = Thread::current();
1122     methodHandle m (thread, entry_frame_call_wrapper()->callee_method());
1123     EntryFrameOopFinder finder(this, m->signature(), m->is_static());
1124     finder.arguments_do(f);
1125   }
1126   // Traverse the Handle Block saved in the entry frame
1127   entry_frame_call_wrapper()->oops_do(f);
1128 }
1129 
1130 
1131 void frame::oops_do_internal(OopClosure* f, CodeBlobClosure* cf, RegisterMap* map, bool use_interpreter_oop_map_cache) {
1132 #ifndef PRODUCT
1133 #if defined(__SUNPRO_CC) && __SUNPRO_CC >= 0x5140
1134 #pragma error_messages(off, SEC_NULL_PTR_DEREF)
1135 #endif
1136   // simulate GC crash here to dump java thread in error report
1137   if (CrashGCForDumpingJavaThread) {
1138     char *t = NULL;
1139     *t = 'c';
1140   }
1141 #endif
1142   if (is_interpreted_frame()) {
1143     oops_interpreted_do(f, map, use_interpreter_oop_map_cache);
1144   } else if (is_entry_frame()) {
1145     oops_entry_do(f, map);
1146   } else if (CodeCache::contains(pc())) {
1147     oops_code_blob_do(f, cf, map);
1148   } else {
1149     ShouldNotReachHere();
1150   }
1151 }
1152 
1153 void frame::nmethods_do(CodeBlobClosure* cf) {
1154   if (_cb != NULL && _cb->is_nmethod()) {
1155     cf->do_code_blob(_cb);
1156   }
1157 }
1158 
1159 
1160 // call f() on the interpreted Method*s in the stack.
1161 // Have to walk the entire code cache for the compiled frames Yuck.
1162 void frame::metadata_do(void f(Metadata*)) {
1163   if (is_interpreted_frame()) {
1164     Method* m = this->interpreter_frame_method();
1165     assert(m != NULL, "expecting a method in this frame");
1166     f(m);
1167   }
1168 }
1169 
1170 void frame::verify(const RegisterMap* map) {
1171   // for now make sure receiver type is correct
1172   if (is_interpreted_frame()) {
1173     Method* method = interpreter_frame_method();
1174     guarantee(method->is_method(), "method is wrong in frame::verify");
1175     if (!method->is_static()) {
1176       // fetch the receiver
1177       oop* p = (oop*) interpreter_frame_local_at(0);
1178       // make sure we have the right receiver type
1179     }
1180   }
1181 #if COMPILER2_OR_JVMCI
1182   assert(DerivedPointerTable::is_empty(), "must be empty before verify");
1183 #endif
1184   oops_do_internal(&VerifyOopClosure::verify_oop, NULL, (RegisterMap*)map, false);
1185 }
1186 
1187 
1188 #ifdef ASSERT
1189 bool frame::verify_return_pc(address x) {
1190   if (StubRoutines::returns_to_call_stub(x)) {
1191     return true;
1192   }
1193   if (CodeCache::contains(x)) {
1194     return true;
1195   }
1196   if (Interpreter::contains(x)) {
1197     return true;
1198   }
1199   return false;
1200 }
1201 #endif
1202 
1203 #ifdef ASSERT
1204 void frame::interpreter_frame_verify_monitor(BasicObjectLock* value) const {
1205   assert(is_interpreted_frame(), "Not an interpreted frame");
1206   // verify that the value is in the right part of the frame
1207   address low_mark  = (address) interpreter_frame_monitor_end();
1208   address high_mark = (address) interpreter_frame_monitor_begin();
1209   address current   = (address) value;
1210 
1211   const int monitor_size = frame::interpreter_frame_monitor_size();
1212   guarantee((high_mark - current) % monitor_size  ==  0         , "Misaligned top of BasicObjectLock*");
1213   guarantee( high_mark > current                                , "Current BasicObjectLock* higher than high_mark");
1214 
1215   guarantee((current - low_mark) % monitor_size  ==  0         , "Misaligned bottom of BasicObjectLock*");
1216   guarantee( current >= low_mark                               , "Current BasicObjectLock* below than low_mark");
1217 }
1218 #endif
1219 
1220 #ifndef PRODUCT
1221 void frame::describe(FrameValues& values, int frame_no) {
1222   // boundaries: sp and the 'real' frame pointer
1223   values.describe(-1, sp(), err_msg("sp for #%d", frame_no), 1);
1224   intptr_t* frame_pointer = real_fp(); // Note: may differ from fp()
1225 
1226   // print frame info at the highest boundary
1227   intptr_t* info_address = MAX2(sp(), frame_pointer);
1228 
1229   if (info_address != frame_pointer) {
1230     // print frame_pointer explicitly if not marked by the frame info
1231     values.describe(-1, frame_pointer, err_msg("frame pointer for #%d", frame_no), 1);
1232   }
1233 
1234   if (is_entry_frame() || is_compiled_frame() || is_interpreted_frame() || is_native_frame()) {
1235     // Label values common to most frames
1236     values.describe(-1, unextended_sp(), err_msg("unextended_sp for #%d", frame_no));
1237   }
1238 
1239   if (is_interpreted_frame()) {
1240     Method* m = interpreter_frame_method();
1241     int bci = interpreter_frame_bci();
1242 
1243     // Label the method and current bci
1244     values.describe(-1, info_address,
1245                     FormatBuffer<1024>("#%d method %s @ %d", frame_no, m->name_and_sig_as_C_string(), bci), 2);
1246     values.describe(-1, info_address,
1247                     err_msg("- %d locals %d max stack", m->max_locals(), m->max_stack()), 1);
1248     if (m->max_locals() > 0) {
1249       intptr_t* l0 = interpreter_frame_local_at(0);
1250       intptr_t* ln = interpreter_frame_local_at(m->max_locals() - 1);
1251       values.describe(-1, MAX2(l0, ln), err_msg("locals for #%d", frame_no), 1);
1252       // Report each local and mark as owned by this frame
1253       for (int l = 0; l < m->max_locals(); l++) {
1254         intptr_t* l0 = interpreter_frame_local_at(l);
1255         values.describe(frame_no, l0, err_msg("local %d", l));
1256       }
1257     }
1258 
1259     // Compute the actual expression stack size
1260     InterpreterOopMap mask;
1261     OopMapCache::compute_one_oop_map(m, bci, &mask);
1262     intptr_t* tos = NULL;
1263     // Report each stack element and mark as owned by this frame
1264     for (int e = 0; e < mask.expression_stack_size(); e++) {
1265       tos = MAX2(tos, interpreter_frame_expression_stack_at(e));
1266       values.describe(frame_no, interpreter_frame_expression_stack_at(e),
1267                       err_msg("stack %d", e));
1268     }
1269     if (tos != NULL) {
1270       values.describe(-1, tos, err_msg("expression stack for #%d", frame_no), 1);
1271     }
1272     if (interpreter_frame_monitor_begin() != interpreter_frame_monitor_end()) {
1273       values.describe(frame_no, (intptr_t*)interpreter_frame_monitor_begin(), "monitors begin");
1274       values.describe(frame_no, (intptr_t*)interpreter_frame_monitor_end(), "monitors end");
1275     }
1276   } else if (is_entry_frame()) {
1277     // For now just label the frame
1278     values.describe(-1, info_address, err_msg("#%d entry frame", frame_no), 2);
1279   } else if (is_compiled_frame()) {
1280     // For now just label the frame
1281     CompiledMethod* cm = (CompiledMethod*)cb();
1282     values.describe(-1, info_address,
1283                     FormatBuffer<1024>("#%d nmethod " INTPTR_FORMAT " for method %s%s%s", frame_no,
1284                                        p2i(cm),
1285                                        (cm->is_aot() ? "A ": "J "),
1286                                        cm->method()->name_and_sig_as_C_string(),
1287                                        (_deopt_state == is_deoptimized) ?
1288                                        " (deoptimized)" :
1289                                        ((_deopt_state == unknown) ? " (state unknown)" : "")),
1290                     2);
1291   } else if (is_native_frame()) {
1292     // For now just label the frame
1293     nmethod* nm = cb()->as_nmethod_or_null();
1294     values.describe(-1, info_address,
1295                     FormatBuffer<1024>("#%d nmethod " INTPTR_FORMAT " for native method %s", frame_no,
1296                                        p2i(nm), nm->method()->name_and_sig_as_C_string()), 2);
1297   } else {
1298     // provide default info if not handled before
1299     char *info = (char *) "special frame";
1300     if ((_cb != NULL) &&
1301         (_cb->name() != NULL)) {
1302       info = (char *)_cb->name();
1303     }
1304     values.describe(-1, info_address, err_msg("#%d <%s>", frame_no, info), 2);
1305   }
1306 
1307   // platform dependent additional data
1308   describe_pd(values, frame_no);
1309 }
1310 
1311 #endif
1312 
1313 
1314 //-----------------------------------------------------------------------------------
1315 // StackFrameStream implementation
1316 
1317 StackFrameStream::StackFrameStream(JavaThread *thread, bool update) : _reg_map(thread, update) {
1318   assert(thread->has_last_Java_frame(), "sanity check");
1319   _fr = thread->last_frame();
1320   _is_done = false;
1321 }
1322 
1323 
1324 #ifndef PRODUCT
1325 
1326 void FrameValues::describe(int owner, intptr_t* location, const char* description, int priority) {
1327   FrameValue fv;
1328   fv.location = location;
1329   fv.owner = owner;
1330   fv.priority = priority;
1331   fv.description = NEW_RESOURCE_ARRAY(char, strlen(description) + 1);
1332   strcpy(fv.description, description);
1333   _values.append(fv);
1334 }
1335 
1336 
1337 #ifdef ASSERT
1338 void FrameValues::validate() {
1339   _values.sort(compare);
1340   bool error = false;
1341   FrameValue prev;
1342   prev.owner = -1;
1343   for (int i = _values.length() - 1; i >= 0; i--) {
1344     FrameValue fv = _values.at(i);
1345     if (fv.owner == -1) continue;
1346     if (prev.owner == -1) {
1347       prev = fv;
1348       continue;
1349     }
1350     if (prev.location == fv.location) {
1351       if (fv.owner != prev.owner) {
1352         tty->print_cr("overlapping storage");
1353         tty->print_cr(" " INTPTR_FORMAT ": " INTPTR_FORMAT " %s", p2i(prev.location), *prev.location, prev.description);
1354         tty->print_cr(" " INTPTR_FORMAT ": " INTPTR_FORMAT " %s", p2i(fv.location), *fv.location, fv.description);
1355         error = true;
1356       }
1357     } else {
1358       prev = fv;
1359     }
1360   }
1361   assert(!error, "invalid layout");
1362 }
1363 #endif // ASSERT
1364 
1365 void FrameValues::print(JavaThread* thread) {
1366   _values.sort(compare);
1367 
1368   // Sometimes values like the fp can be invalid values if the
1369   // register map wasn't updated during the walk.  Trim out values
1370   // that aren't actually in the stack of the thread.
1371   int min_index = 0;
1372   int max_index = _values.length() - 1;
1373   intptr_t* v0 = _values.at(min_index).location;
1374   intptr_t* v1 = _values.at(max_index).location;
1375 
1376   if (thread == Thread::current()) {
1377     while (!thread->is_in_stack((address)v0)) {
1378       v0 = _values.at(++min_index).location;
1379     }
1380     while (!thread->is_in_stack((address)v1)) {
1381       v1 = _values.at(--max_index).location;
1382     }
1383   } else {
1384     while (!thread->on_local_stack((address)v0)) {
1385       v0 = _values.at(++min_index).location;
1386     }
1387     while (!thread->on_local_stack((address)v1)) {
1388       v1 = _values.at(--max_index).location;
1389     }
1390   }
1391   intptr_t* min = MIN2(v0, v1);
1392   intptr_t* max = MAX2(v0, v1);
1393   intptr_t* cur = max;
1394   intptr_t* last = NULL;
1395   for (int i = max_index; i >= min_index; i--) {
1396     FrameValue fv = _values.at(i);
1397     while (cur > fv.location) {
1398       tty->print_cr(" " INTPTR_FORMAT ": " INTPTR_FORMAT, p2i(cur), *cur);
1399       cur--;
1400     }
1401     if (last == fv.location) {
1402       const char* spacer = "          " LP64_ONLY("        ");
1403       tty->print_cr(" %s  %s %s", spacer, spacer, fv.description);
1404     } else {
1405       tty->print_cr(" " INTPTR_FORMAT ": " INTPTR_FORMAT " %s", p2i(fv.location), *fv.location, fv.description);
1406       last = fv.location;
1407       cur--;
1408     }
1409   }
1410 }
1411 
1412 #endif // ndef PRODUCT