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