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 BasicObjectLock* frame::next_monitor_in_interpreter_frame(BasicObjectLock* current) const {
 447   assert(is_interpreted_frame(), "Not an interpreted frame");
 448 #ifdef ASSERT
 449   interpreter_frame_verify_monitor(current);
 450 #endif
 451   BasicObjectLock* next = (BasicObjectLock*) (((intptr_t*) current) + interpreter_frame_monitor_size());
 452   return next;
 453 }
 454 
 455 BasicObjectLock* frame::previous_monitor_in_interpreter_frame(BasicObjectLock* current) const {
 456   assert(is_interpreted_frame(), "Not an interpreted frame");
 457 #ifdef ASSERT
 458 //   // This verification needs to be checked before being enabled
 459 //   interpreter_frame_verify_monitor(current);
 460 #endif
 461   BasicObjectLock* previous = (BasicObjectLock*) (((intptr_t*) current) - interpreter_frame_monitor_size());
 462   return previous;
 463 }
 464 
 465 // Interpreter locals and expression stack locations.
 466 
 467 intptr_t* frame::interpreter_frame_local_at(int index) const {
 468   const int n = Interpreter::local_offset_in_bytes(index)/wordSize;
 469   return &((*interpreter_frame_locals_addr())[n]);
 470 }
 471 
 472 intptr_t* frame::interpreter_frame_expression_stack_at(jint offset) const {
 473   const int i = offset * interpreter_frame_expression_stack_direction();
 474   const int n = i * Interpreter::stackElementWords;
 475   return &(interpreter_frame_expression_stack()[n]);
 476 }
 477 
 478 jint frame::interpreter_frame_expression_stack_size() const {
 479   // Number of elements on the interpreter expression stack
 480   // Callers should span by stackElementWords
 481   int element_size = Interpreter::stackElementWords;
 482   size_t stack_size = 0;
 483   if (frame::interpreter_frame_expression_stack_direction() < 0) {
 484     stack_size = (interpreter_frame_expression_stack() -
 485                   interpreter_frame_tos_address() + 1)/element_size;
 486   } else {
 487     stack_size = (interpreter_frame_tos_address() -
 488                   interpreter_frame_expression_stack() + 1)/element_size;
 489   }
 490   assert( stack_size <= (size_t)max_jint, "stack size too big");
 491   return ((jint)stack_size);
 492 }
 493 
 494 
 495 // (frame::interpreter_frame_sender_sp accessor is in frame_<arch>.cpp)
 496 
 497 const char* frame::print_name() const {
 498   if (is_native_frame())      return "Native";
 499   if (is_interpreted_frame()) return "Interpreted";
 500   if (is_compiled_frame()) {
 501     if (is_deoptimized_frame()) return "Deoptimized";
 502     return "Compiled";
 503   }
 504   if (sp() == NULL)            return "Empty";
 505   return "C";
 506 }
 507 
 508 void frame::print_value_on(outputStream* st, JavaThread *thread) const {
 509   NOT_PRODUCT(address begin = pc()-40;)
 510   NOT_PRODUCT(address end   = NULL;)
 511 
 512   st->print("%s frame (sp=" INTPTR_FORMAT " unextended sp=" INTPTR_FORMAT, print_name(), p2i(sp()), p2i(unextended_sp()));
 513   if (sp() != NULL)
 514     st->print(", fp=" INTPTR_FORMAT ", real_fp=" INTPTR_FORMAT ", pc=" INTPTR_FORMAT,
 515               p2i(fp()), p2i(real_fp()), p2i(pc()));
 516 
 517   if (StubRoutines::contains(pc())) {
 518     st->print_cr(")");
 519     st->print("(");
 520     StubCodeDesc* desc = StubCodeDesc::desc_for(pc());
 521     st->print("~Stub::%s", desc->name());
 522     NOT_PRODUCT(begin = desc->begin(); end = desc->end();)
 523   } else if (Interpreter::contains(pc())) {
 524     st->print_cr(")");
 525     st->print("(");
 526     InterpreterCodelet* desc = Interpreter::codelet_containing(pc());
 527     if (desc != NULL) {
 528       st->print("~");
 529       desc->print_on(st);
 530       NOT_PRODUCT(begin = desc->code_begin(); end = desc->code_end();)
 531     } else {
 532       st->print("~interpreter");
 533     }
 534   }
 535   st->print_cr(")");
 536 
 537   if (_cb != NULL) {
 538     st->print("     ");
 539     _cb->print_value_on(st);
 540     st->cr();
 541 #ifndef PRODUCT
 542     if (end == NULL) {
 543       begin = _cb->code_begin();
 544       end   = _cb->code_end();
 545     }
 546 #endif
 547   }
 548   NOT_PRODUCT(if (WizardMode && Verbose) Disassembler::decode(begin, end);)
 549 }
 550 
 551 
 552 void frame::print_on(outputStream* st) const {
 553   print_value_on(st,NULL);
 554   if (is_interpreted_frame()) {
 555     interpreter_frame_print_on(st);
 556   }
 557 }
 558 
 559 
 560 void frame::interpreter_frame_print_on(outputStream* st) const {
 561 #ifndef PRODUCT
 562   assert(is_interpreted_frame(), "Not an interpreted frame");
 563   jint i;
 564   for (i = 0; i < interpreter_frame_method()->max_locals(); i++ ) {
 565     intptr_t x = *interpreter_frame_local_at(i);
 566     st->print(" - local  [" INTPTR_FORMAT "]", x);
 567     st->fill_to(23);
 568     st->print_cr("; #%d", i);
 569   }
 570   for (i = interpreter_frame_expression_stack_size() - 1; i >= 0; --i ) {
 571     intptr_t x = *interpreter_frame_expression_stack_at(i);
 572     st->print(" - stack  [" INTPTR_FORMAT "]", x);
 573     st->fill_to(23);
 574     st->print_cr("; #%d", i);
 575   }
 576   // locks for synchronization
 577   for (BasicObjectLock* current = interpreter_frame_monitor_end();
 578        current < interpreter_frame_monitor_begin();
 579        current = next_monitor_in_interpreter_frame(current)) {
 580     st->print(" - obj    [");
 581     current->obj()->print_value_on(st);
 582     st->print_cr("]");
 583     st->print(" - lock   [");
 584     current->lock()->print_on(st);
 585     st->print_cr("]");
 586   }
 587   // monitor
 588   st->print_cr(" - monitor[" INTPTR_FORMAT "]", p2i(interpreter_frame_monitor_begin()));
 589   // bcp
 590   st->print(" - bcp    [" INTPTR_FORMAT "]", p2i(interpreter_frame_bcp()));
 591   st->fill_to(23);
 592   st->print_cr("; @%d", interpreter_frame_bci());
 593   // locals
 594   st->print_cr(" - locals [" INTPTR_FORMAT "]", p2i(interpreter_frame_local_at(0)));
 595   // method
 596   st->print(" - method [" INTPTR_FORMAT "]", p2i(interpreter_frame_method()));
 597   st->fill_to(23);
 598   st->print("; ");
 599   interpreter_frame_method()->print_name(st);
 600   st->cr();
 601 #endif
 602 }
 603 
 604 // Print whether the frame is in the VM or OS indicating a HotSpot problem.
 605 // Otherwise, it's likely a bug in the native library that the Java code calls,
 606 // hopefully indicating where to submit bugs.
 607 void frame::print_C_frame(outputStream* st, char* buf, int buflen, address pc) {
 608   // C/C++ frame
 609   bool in_vm = os::address_is_in_vm(pc);
 610   st->print(in_vm ? "V" : "C");
 611 
 612   int offset;
 613   bool found;
 614 
 615   // libname
 616   found = os::dll_address_to_library_name(pc, buf, buflen, &offset);
 617   if (found) {
 618     // skip directory names
 619     const char *p1, *p2;
 620     p1 = buf;
 621     int len = (int)strlen(os::file_separator());
 622     while ((p2 = strstr(p1, os::file_separator())) != NULL) p1 = p2 + len;
 623     st->print("  [%s+0x%x]", p1, offset);
 624   } else {
 625     st->print("  " PTR_FORMAT, p2i(pc));
 626   }
 627 
 628   // function name - os::dll_address_to_function_name() may return confusing
 629   // names if pc is within jvm.dll or libjvm.so, because JVM only has
 630   // JVM_xxxx and a few other symbols in the dynamic symbol table. Do this
 631   // only for native libraries.
 632   if (!in_vm || Decoder::can_decode_C_frame_in_vm()) {
 633     found = os::dll_address_to_function_name(pc, buf, buflen, &offset);
 634 
 635     if (found) {
 636       st->print("  %s+0x%x", buf, offset);
 637     }
 638   }
 639 }
 640 
 641 // frame::print_on_error() is called by fatal error handler. Notice that we may
 642 // crash inside this function if stack frame is corrupted. The fatal error
 643 // handler can catch and handle the crash. Here we assume the frame is valid.
 644 //
 645 // First letter indicates type of the frame:
 646 //    J: Java frame (compiled)
 647 //    A: Java frame (aot compiled)
 648 //    j: Java frame (interpreted)
 649 //    V: VM frame (C/C++)
 650 //    v: Other frames running VM generated code (e.g. stubs, adapters, etc.)
 651 //    C: C/C++ frame
 652 //
 653 // We don't need detailed frame type as that in frame::print_name(). "C"
 654 // suggests the problem is in user lib; everything else is likely a VM bug.
 655 
 656 void frame::print_on_error(outputStream* st, char* buf, int buflen, bool verbose) const {
 657   if (_cb != NULL) {
 658     if (Interpreter::contains(pc())) {
 659       Method* m = this->interpreter_frame_method();
 660       if (m != NULL) {
 661         m->name_and_sig_as_C_string(buf, buflen);
 662         st->print("j  %s", buf);
 663         st->print("+%d", this->interpreter_frame_bci());
 664         ModuleEntry* module = m->method_holder()->module();
 665         if (module->is_named()) {
 666           module->name()->as_C_string(buf, buflen);
 667           st->print(" %s", buf);
 668           if (module->version() != NULL) {
 669             module->version()->as_C_string(buf, buflen);
 670             st->print("@%s", buf);
 671           }
 672         }
 673       } else {
 674         st->print("j  " PTR_FORMAT, p2i(pc()));
 675       }
 676     } else if (StubRoutines::contains(pc())) {
 677       StubCodeDesc* desc = StubCodeDesc::desc_for(pc());
 678       if (desc != NULL) {
 679         st->print("v  ~StubRoutines::%s", desc->name());
 680       } else {
 681         st->print("v  ~StubRoutines::" PTR_FORMAT, p2i(pc()));
 682       }
 683     } else if (_cb->is_buffer_blob()) {
 684       st->print("v  ~BufferBlob::%s", ((BufferBlob *)_cb)->name());
 685     } else if (_cb->is_compiled()) {
 686       CompiledMethod* cm = (CompiledMethod*)_cb;
 687       Method* m = cm->method();
 688       if (m != NULL) {
 689         if (cm->is_aot()) {
 690           st->print("A %d ", cm->compile_id());
 691         } else if (cm->is_nmethod()) {
 692           nmethod* nm = cm->as_nmethod();
 693           st->print("J %d%s", nm->compile_id(), (nm->is_osr_method() ? "%" : ""));
 694           st->print(" %s", nm->compiler_name());
 695         }
 696         m->name_and_sig_as_C_string(buf, buflen);
 697         st->print(" %s", buf);
 698         ModuleEntry* module = m->method_holder()->module();
 699         if (module->is_named()) {
 700           module->name()->as_C_string(buf, buflen);
 701           st->print(" %s", buf);
 702           if (module->version() != NULL) {
 703             module->version()->as_C_string(buf, buflen);
 704             st->print("@%s", buf);
 705           }
 706         }
 707         st->print(" (%d bytes) @ " PTR_FORMAT " [" PTR_FORMAT "+" INTPTR_FORMAT "]",
 708                   m->code_size(), p2i(_pc), p2i(_cb->code_begin()), _pc - _cb->code_begin());
 709 #if INCLUDE_JVMCI
 710         if (cm->is_nmethod()) {
 711           nmethod* nm = cm->as_nmethod();
 712           char* jvmciName = nm->jvmci_installed_code_name(buf, buflen);
 713           if (jvmciName != NULL) {
 714             st->print(" (%s)", jvmciName);
 715           }
 716         }
 717 #endif
 718       } else {
 719         st->print("J  " PTR_FORMAT, p2i(pc()));
 720       }
 721     } else if (_cb->is_runtime_stub()) {
 722       st->print("v  ~RuntimeStub::%s", ((RuntimeStub *)_cb)->name());
 723     } else if (_cb->is_deoptimization_stub()) {
 724       st->print("v  ~DeoptimizationBlob");
 725     } else if (_cb->is_exception_stub()) {
 726       st->print("v  ~ExceptionBlob");
 727     } else if (_cb->is_safepoint_stub()) {
 728       st->print("v  ~SafepointBlob");
 729     } else {
 730       st->print("v  blob " PTR_FORMAT, p2i(pc()));
 731     }
 732   } else {
 733     print_C_frame(st, buf, buflen, pc());
 734   }
 735 }
 736 
 737 
 738 /*
 739   The interpreter_frame_expression_stack_at method in the case of SPARC needs the
 740   max_stack value of the method in order to compute the expression stack address.
 741   It uses the Method* in order to get the max_stack value but during GC this
 742   Method* value saved on the frame is changed by reverse_and_push and hence cannot
 743   be used. So we save the max_stack value in the FrameClosure object and pass it
 744   down to the interpreter_frame_expression_stack_at method
 745 */
 746 class InterpreterFrameClosure : public OffsetClosure {
 747  private:
 748   frame* _fr;
 749   OopClosure* _f;
 750   int    _max_locals;
 751   int    _max_stack;
 752 
 753  public:
 754   InterpreterFrameClosure(frame* fr, int max_locals, int max_stack,
 755                           OopClosure* f) {
 756     _fr         = fr;
 757     _max_locals = max_locals;
 758     _max_stack  = max_stack;
 759     _f          = f;
 760   }
 761 
 762   void offset_do(int offset) {
 763     oop* addr;
 764     if (offset < _max_locals) {
 765       addr = (oop*) _fr->interpreter_frame_local_at(offset);
 766       assert((intptr_t*)addr >= _fr->sp(), "must be inside the frame");
 767       _f->do_oop(addr);
 768     } else {
 769       addr = (oop*) _fr->interpreter_frame_expression_stack_at((offset - _max_locals));
 770       // In case of exceptions, the expression stack is invalid and the esp will be reset to express
 771       // this condition. Therefore, we call f only if addr is 'inside' the stack (i.e., addr >= esp for Intel).
 772       bool in_stack;
 773       if (frame::interpreter_frame_expression_stack_direction() > 0) {
 774         in_stack = (intptr_t*)addr <= _fr->interpreter_frame_tos_address();
 775       } else {
 776         in_stack = (intptr_t*)addr >= _fr->interpreter_frame_tos_address();
 777       }
 778       if (in_stack) {
 779         _f->do_oop(addr);
 780       }
 781     }
 782   }
 783 
 784   int max_locals()  { return _max_locals; }
 785   frame* fr()       { return _fr; }
 786 };
 787 
 788 
 789 class InterpretedArgumentOopFinder: public SignatureInfo {
 790  private:
 791   OopClosure* _f;        // Closure to invoke
 792   int    _offset;        // TOS-relative offset, decremented with each argument
 793   bool   _has_receiver;  // true if the callee has a receiver
 794   frame* _fr;
 795 
 796   void set(int size, BasicType type) {
 797     _offset -= size;
 798     if (type == T_OBJECT || type == T_ARRAY) oop_offset_do();
 799   }
 800 
 801   void oop_offset_do() {
 802     oop* addr;
 803     addr = (oop*)_fr->interpreter_frame_tos_at(_offset);
 804     _f->do_oop(addr);
 805   }
 806 
 807  public:
 808   InterpretedArgumentOopFinder(Symbol* signature, bool has_receiver, frame* fr, OopClosure* f) : SignatureInfo(signature), _has_receiver(has_receiver) {
 809     // compute size of arguments
 810     int args_size = ArgumentSizeComputer(signature).size() + (has_receiver ? 1 : 0);
 811     assert(!fr->is_interpreted_frame() ||
 812            args_size <= fr->interpreter_frame_expression_stack_size(),
 813             "args cannot be on stack anymore");
 814     // initialize InterpretedArgumentOopFinder
 815     _f         = f;
 816     _fr        = fr;
 817     _offset    = args_size;
 818   }
 819 
 820   void oops_do() {
 821     if (_has_receiver) {
 822       --_offset;
 823       oop_offset_do();
 824     }
 825     iterate_parameters();
 826   }
 827 };
 828 
 829 
 830 // Entry frame has following form (n arguments)
 831 //         +-----------+
 832 //   sp -> |  last arg |
 833 //         +-----------+
 834 //         :    :::    :
 835 //         +-----------+
 836 // (sp+n)->|  first arg|
 837 //         +-----------+
 838 
 839 
 840 
 841 // visits and GC's all the arguments in entry frame
 842 class EntryFrameOopFinder: public SignatureInfo {
 843  private:
 844   bool   _is_static;
 845   int    _offset;
 846   frame* _fr;
 847   OopClosure* _f;
 848 
 849   void set(int size, BasicType type) {
 850     assert (_offset >= 0, "illegal offset");
 851     if (type == T_OBJECT || type == T_ARRAY) oop_at_offset_do(_offset);
 852     _offset -= size;
 853   }
 854 
 855   void oop_at_offset_do(int offset) {
 856     assert (offset >= 0, "illegal offset");
 857     oop* addr = (oop*) _fr->entry_frame_argument_at(offset);
 858     _f->do_oop(addr);
 859   }
 860 
 861  public:
 862    EntryFrameOopFinder(frame* frame, Symbol* signature, bool is_static) : SignatureInfo(signature) {
 863      _f = NULL; // will be set later
 864      _fr = frame;
 865      _is_static = is_static;
 866      _offset = ArgumentSizeComputer(signature).size() - 1; // last parameter is at index 0
 867    }
 868 
 869   void arguments_do(OopClosure* f) {
 870     _f = f;
 871     if (!_is_static) oop_at_offset_do(_offset+1); // do the receiver
 872     iterate_parameters();
 873   }
 874 
 875 };
 876 
 877 oop* frame::interpreter_callee_receiver_addr(Symbol* signature) {
 878   ArgumentSizeComputer asc(signature);
 879   int size = asc.size();
 880   return (oop *)interpreter_frame_tos_at(size);
 881 }
 882 
 883 
 884 void frame::oops_interpreted_do(OopClosure* f, const RegisterMap* map, bool query_oop_map_cache) {
 885   assert(is_interpreted_frame(), "Not an interpreted frame");
 886   assert(map != NULL, "map must be set");
 887   Thread *thread = Thread::current();
 888   methodHandle m (thread, interpreter_frame_method());
 889   jint      bci = interpreter_frame_bci();
 890 
 891   assert(!Universe::heap()->is_in(m()),
 892           "must be valid oop");
 893   assert(m->is_method(), "checking frame value");
 894   assert((m->is_native() && bci == 0)  ||
 895          (!m->is_native() && bci >= 0 && bci < m->code_size()),
 896          "invalid bci value");
 897 
 898   // Handle the monitor elements in the activation
 899   for (
 900     BasicObjectLock* current = interpreter_frame_monitor_end();
 901     current < interpreter_frame_monitor_begin();
 902     current = next_monitor_in_interpreter_frame(current)
 903   ) {
 904 #ifdef ASSERT
 905     interpreter_frame_verify_monitor(current);
 906 #endif
 907     current->oops_do(f);
 908   }
 909 
 910   if (m->is_native()) {
 911     f->do_oop(interpreter_frame_temp_oop_addr());
 912   }
 913 
 914   // The method pointer in the frame might be the only path to the method's
 915   // klass, and the klass needs to be kept alive while executing. The GCs
 916   // don't trace through method pointers, so the mirror of the method's klass
 917   // is installed as a GC root.
 918   f->do_oop(interpreter_frame_mirror_addr());
 919 
 920   int max_locals = m->is_native() ? m->size_of_parameters() : m->max_locals();
 921 
 922   Symbol* signature = NULL;
 923   bool has_receiver = false;
 924 
 925   // Process a callee's arguments if we are at a call site
 926   // (i.e., if we are at an invoke bytecode)
 927   // This is used sometimes for calling into the VM, not for another
 928   // interpreted or compiled frame.
 929   if (!m->is_native()) {
 930     Bytecode_invoke call = Bytecode_invoke_check(m, bci);
 931     if (call.is_valid()) {
 932       signature = call.signature();
 933       has_receiver = call.has_receiver();
 934       if (map->include_argument_oops() &&
 935           interpreter_frame_expression_stack_size() > 0) {
 936         ResourceMark rm(thread);  // is this right ???
 937         // we are at a call site & the expression stack is not empty
 938         // => process callee's arguments
 939         //
 940         // Note: The expression stack can be empty if an exception
 941         //       occurred during method resolution/execution. In all
 942         //       cases we empty the expression stack completely be-
 943         //       fore handling the exception (the exception handling
 944         //       code in the interpreter calls a blocking runtime
 945         //       routine which can cause this code to be executed).
 946         //       (was bug gri 7/27/98)
 947         oops_interpreted_arguments_do(signature, has_receiver, f);
 948       }
 949     }
 950   }
 951 
 952   InterpreterFrameClosure blk(this, max_locals, m->max_stack(), f);
 953 
 954   // process locals & expression stack
 955   InterpreterOopMap mask;
 956   if (query_oop_map_cache) {
 957     m->mask_for(bci, &mask);
 958   } else {
 959     OopMapCache::compute_one_oop_map(m, bci, &mask);
 960   }
 961   mask.iterate_oop(&blk);
 962 }
 963 
 964 
 965 void frame::oops_interpreted_arguments_do(Symbol* signature, bool has_receiver, OopClosure* f) {
 966   InterpretedArgumentOopFinder finder(signature, has_receiver, this, f);
 967   finder.oops_do();
 968 }
 969 
 970 void frame::oops_code_blob_do(OopClosure* f, CodeBlobClosure* cf, const RegisterMap* reg_map) {
 971   assert(_cb != NULL, "sanity check");
 972   if (_cb->oop_maps() != NULL) {
 973     OopMapSet::oops_do(this, reg_map, f);
 974 
 975     // Preserve potential arguments for a callee. We handle this by dispatching
 976     // on the codeblob. For c2i, we do
 977     if (reg_map->include_argument_oops()) {
 978       _cb->preserve_callee_argument_oops(*this, reg_map, f);
 979     }
 980   }
 981   // In cases where perm gen is collected, GC will want to mark
 982   // oops referenced from nmethods active on thread stacks so as to
 983   // prevent them from being collected. However, this visit should be
 984   // restricted to certain phases of the collection only. The
 985   // closure decides how it wants nmethods to be traced.
 986   if (cf != NULL)
 987     cf->do_code_blob(_cb);
 988 }
 989 
 990 class CompiledArgumentOopFinder: public SignatureInfo {
 991  protected:
 992   OopClosure*     _f;
 993   int             _offset;        // the current offset, incremented with each argument
 994   bool            _has_receiver;  // true if the callee has a receiver
 995   bool            _has_appendix;  // true if the call has an appendix
 996   frame           _fr;
 997   RegisterMap*    _reg_map;
 998   int             _arg_size;
 999   VMRegPair*      _regs;        // VMReg list of arguments
1000 
1001   void set(int size, BasicType type) {
1002     if (type == T_OBJECT || type == T_ARRAY) handle_oop_offset();
1003     _offset += size;
1004   }
1005 
1006   virtual void handle_oop_offset() {
1007     // Extract low order register number from register array.
1008     // In LP64-land, the high-order bits are valid but unhelpful.
1009     VMReg reg = _regs[_offset].first();
1010     oop *loc = _fr.oopmapreg_to_location(reg, _reg_map);
1011     _f->do_oop(loc);
1012   }
1013 
1014  public:
1015   CompiledArgumentOopFinder(Symbol* signature, bool has_receiver, bool has_appendix, OopClosure* f, frame fr,  const RegisterMap* reg_map)
1016     : SignatureInfo(signature) {
1017 
1018     // initialize CompiledArgumentOopFinder
1019     _f         = f;
1020     _offset    = 0;
1021     _has_receiver = has_receiver;
1022     _has_appendix = has_appendix;
1023     _fr        = fr;
1024     _reg_map   = (RegisterMap*)reg_map;
1025     _arg_size  = ArgumentSizeComputer(signature).size() + (has_receiver ? 1 : 0) + (has_appendix ? 1 : 0);
1026 
1027     int arg_size;
1028     _regs = SharedRuntime::find_callee_arguments(signature, has_receiver, has_appendix, &arg_size);
1029     assert(arg_size == _arg_size, "wrong arg size");
1030   }
1031 
1032   void oops_do() {
1033     if (_has_receiver) {
1034       handle_oop_offset();
1035       _offset++;
1036     }
1037     iterate_parameters();
1038     if (_has_appendix) {
1039       handle_oop_offset();
1040       _offset++;
1041     }
1042   }
1043 };
1044 
1045 void frame::oops_compiled_arguments_do(Symbol* signature, bool has_receiver, bool has_appendix,
1046                                        const RegisterMap* reg_map, OopClosure* f) {
1047   ResourceMark rm;
1048   CompiledArgumentOopFinder finder(signature, has_receiver, has_appendix, f, *this, reg_map);
1049   finder.oops_do();
1050 }
1051 
1052 
1053 // Get receiver out of callers frame, i.e. find parameter 0 in callers
1054 // frame.  Consult ADLC for where parameter 0 is to be found.  Then
1055 // check local reg_map for it being a callee-save register or argument
1056 // register, both of which are saved in the local frame.  If not found
1057 // there, it must be an in-stack argument of the caller.
1058 // Note: caller.sp() points to callee-arguments
1059 oop frame::retrieve_receiver(RegisterMap* reg_map) {
1060   frame caller = *this;
1061 
1062   // First consult the ADLC on where it puts parameter 0 for this signature.
1063   VMReg reg = SharedRuntime::name_for_receiver();
1064   oop* oop_adr = caller.oopmapreg_to_location(reg, reg_map);
1065   if (oop_adr == NULL) {
1066     guarantee(oop_adr != NULL, "bad register save location");
1067     return NULL;
1068   }
1069   oop r = *oop_adr;
1070   assert(Universe::heap()->is_in_or_null(r), "bad receiver: " INTPTR_FORMAT " (" INTX_FORMAT ")", p2i(r), p2i(r));
1071   return r;
1072 }
1073 
1074 
1075 oop* frame::oopmapreg_to_location(VMReg reg, const RegisterMap* reg_map) const {
1076   if(reg->is_reg()) {
1077     // If it is passed in a register, it got spilled in the stub frame.
1078     return (oop *)reg_map->location(reg);
1079   } else {
1080     int sp_offset_in_bytes = reg->reg2stack() * VMRegImpl::stack_slot_size;
1081     return (oop*)(((address)unextended_sp()) + sp_offset_in_bytes);
1082   }
1083 }
1084 
1085 BasicLock* frame::get_native_monitor() {
1086   nmethod* nm = (nmethod*)_cb;
1087   assert(_cb != NULL && _cb->is_nmethod() && nm->method()->is_native(),
1088          "Should not call this unless it's a native nmethod");
1089   int byte_offset = in_bytes(nm->native_basic_lock_sp_offset());
1090   assert(byte_offset >= 0, "should not see invalid offset");
1091   return (BasicLock*) &sp()[byte_offset / wordSize];
1092 }
1093 
1094 oop frame::get_native_receiver() {
1095   nmethod* nm = (nmethod*)_cb;
1096   assert(_cb != NULL && _cb->is_nmethod() && nm->method()->is_native(),
1097          "Should not call this unless it's a native nmethod");
1098   int byte_offset = in_bytes(nm->native_receiver_sp_offset());
1099   assert(byte_offset >= 0, "should not see invalid offset");
1100   oop owner = ((oop*) sp())[byte_offset / wordSize];
1101   assert( Universe::heap()->is_in(owner), "bad receiver" );
1102   return owner;
1103 }
1104 
1105 void frame::oops_entry_do(OopClosure* f, const RegisterMap* map) {
1106   assert(map != NULL, "map must be set");
1107   if (map->include_argument_oops()) {
1108     // must collect argument oops, as nobody else is doing it
1109     Thread *thread = Thread::current();
1110     methodHandle m (thread, entry_frame_call_wrapper()->callee_method());
1111     EntryFrameOopFinder finder(this, m->signature(), m->is_static());
1112     finder.arguments_do(f);
1113   }
1114   // Traverse the Handle Block saved in the entry frame
1115   entry_frame_call_wrapper()->oops_do(f);
1116 }
1117 
1118 
1119 void frame::oops_do_internal(OopClosure* f, CodeBlobClosure* cf, RegisterMap* map, bool use_interpreter_oop_map_cache) {
1120 #ifndef PRODUCT
1121   // simulate GC crash here to dump java thread in error report
1122   if (CrashGCForDumpingJavaThread) {
1123     char *t = NULL;
1124     *t = 'c';
1125   }
1126 #endif
1127   if (is_interpreted_frame()) {
1128     oops_interpreted_do(f, map, use_interpreter_oop_map_cache);
1129   } else if (is_entry_frame()) {
1130     oops_entry_do(f, map);
1131   } else if (CodeCache::contains(pc())) {
1132     oops_code_blob_do(f, cf, map);
1133 #ifdef SHARK
1134   } else if (is_fake_stub_frame()) {
1135     // nothing to do
1136 #endif // SHARK
1137   } else {
1138     ShouldNotReachHere();
1139   }
1140 }
1141 
1142 void frame::nmethods_do(CodeBlobClosure* cf) {
1143   if (_cb != NULL && _cb->is_nmethod()) {
1144     cf->do_code_blob(_cb);
1145   }
1146 }
1147 
1148 
1149 // call f() on the interpreted Method*s in the stack.
1150 // Have to walk the entire code cache for the compiled frames Yuck.
1151 void frame::metadata_do(void f(Metadata*)) {
1152   if (is_interpreted_frame()) {
1153     Method* m = this->interpreter_frame_method();
1154     assert(m != NULL, "expecting a method in this frame");
1155     f(m);
1156   }
1157 }
1158 
1159 void frame::verify(const RegisterMap* map) {
1160   // for now make sure receiver type is correct
1161   if (is_interpreted_frame()) {
1162     Method* method = interpreter_frame_method();
1163     guarantee(method->is_method(), "method is wrong in frame::verify");
1164     if (!method->is_static()) {
1165       // fetch the receiver
1166       oop* p = (oop*) interpreter_frame_local_at(0);
1167       // make sure we have the right receiver type
1168     }
1169   }
1170 #if defined(COMPILER2) || INCLUDE_JVMCI
1171   assert(DerivedPointerTable::is_empty(), "must be empty before verify");
1172 #endif
1173   oops_do_internal(&VerifyOopClosure::verify_oop, NULL, (RegisterMap*)map, false);
1174 }
1175 
1176 
1177 #ifdef ASSERT
1178 bool frame::verify_return_pc(address x) {
1179   if (StubRoutines::returns_to_call_stub(x)) {
1180     return true;
1181   }
1182   if (CodeCache::contains(x)) {
1183     return true;
1184   }
1185   if (Interpreter::contains(x)) {
1186     return true;
1187   }
1188   return false;
1189 }
1190 #endif
1191 
1192 #ifdef ASSERT
1193 void frame::interpreter_frame_verify_monitor(BasicObjectLock* value) const {
1194   assert(is_interpreted_frame(), "Not an interpreted frame");
1195   // verify that the value is in the right part of the frame
1196   address low_mark  = (address) interpreter_frame_monitor_end();
1197   address high_mark = (address) interpreter_frame_monitor_begin();
1198   address current   = (address) value;
1199 
1200   const int monitor_size = frame::interpreter_frame_monitor_size();
1201   guarantee((high_mark - current) % monitor_size  ==  0         , "Misaligned top of BasicObjectLock*");
1202   guarantee( high_mark > current                                , "Current BasicObjectLock* higher than high_mark");
1203 
1204   guarantee((current - low_mark) % monitor_size  ==  0         , "Misaligned bottom of BasicObjectLock*");
1205   guarantee( current >= low_mark                               , "Current BasicObjectLock* below than low_mark");
1206 }
1207 #endif
1208 
1209 #ifndef PRODUCT
1210 void frame::describe(FrameValues& values, int frame_no) {
1211   // boundaries: sp and the 'real' frame pointer
1212   values.describe(-1, sp(), err_msg("sp for #%d", frame_no), 1);
1213   intptr_t* frame_pointer = real_fp(); // Note: may differ from fp()
1214 
1215   // print frame info at the highest boundary
1216   intptr_t* info_address = MAX2(sp(), frame_pointer);
1217 
1218   if (info_address != frame_pointer) {
1219     // print frame_pointer explicitly if not marked by the frame info
1220     values.describe(-1, frame_pointer, err_msg("frame pointer for #%d", frame_no), 1);
1221   }
1222 
1223   if (is_entry_frame() || is_compiled_frame() || is_interpreted_frame() || is_native_frame()) {
1224     // Label values common to most frames
1225     values.describe(-1, unextended_sp(), err_msg("unextended_sp for #%d", frame_no));
1226   }
1227 
1228   if (is_interpreted_frame()) {
1229     Method* m = interpreter_frame_method();
1230     int bci = interpreter_frame_bci();
1231 
1232     // Label the method and current bci
1233     values.describe(-1, info_address,
1234                     FormatBuffer<1024>("#%d method %s @ %d", frame_no, m->name_and_sig_as_C_string(), bci), 2);
1235     values.describe(-1, info_address,
1236                     err_msg("- %d locals %d max stack", m->max_locals(), m->max_stack()), 1);
1237     if (m->max_locals() > 0) {
1238       intptr_t* l0 = interpreter_frame_local_at(0);
1239       intptr_t* ln = interpreter_frame_local_at(m->max_locals() - 1);
1240       values.describe(-1, MAX2(l0, ln), err_msg("locals for #%d", frame_no), 1);
1241       // Report each local and mark as owned by this frame
1242       for (int l = 0; l < m->max_locals(); l++) {
1243         intptr_t* l0 = interpreter_frame_local_at(l);
1244         values.describe(frame_no, l0, err_msg("local %d", l));
1245       }
1246     }
1247 
1248     // Compute the actual expression stack size
1249     InterpreterOopMap mask;
1250     OopMapCache::compute_one_oop_map(m, bci, &mask);
1251     intptr_t* tos = NULL;
1252     // Report each stack element and mark as owned by this frame
1253     for (int e = 0; e < mask.expression_stack_size(); e++) {
1254       tos = MAX2(tos, interpreter_frame_expression_stack_at(e));
1255       values.describe(frame_no, interpreter_frame_expression_stack_at(e),
1256                       err_msg("stack %d", e));
1257     }
1258     if (tos != NULL) {
1259       values.describe(-1, tos, err_msg("expression stack for #%d", frame_no), 1);
1260     }
1261     if (interpreter_frame_monitor_begin() != interpreter_frame_monitor_end()) {
1262       values.describe(frame_no, (intptr_t*)interpreter_frame_monitor_begin(), "monitors begin");
1263       values.describe(frame_no, (intptr_t*)interpreter_frame_monitor_end(), "monitors end");
1264     }
1265   } else if (is_entry_frame()) {
1266     // For now just label the frame
1267     values.describe(-1, info_address, err_msg("#%d entry frame", frame_no), 2);
1268   } else if (is_compiled_frame()) {
1269     // For now just label the frame
1270     CompiledMethod* cm = (CompiledMethod*)cb();
1271     values.describe(-1, info_address,
1272                     FormatBuffer<1024>("#%d nmethod " INTPTR_FORMAT " for method %s%s%s", frame_no,
1273                                        p2i(cm),
1274                                        (cm->is_aot() ? "A ": "J "),
1275                                        cm->method()->name_and_sig_as_C_string(),
1276                                        (_deopt_state == is_deoptimized) ?
1277                                        " (deoptimized)" :
1278                                        ((_deopt_state == unknown) ? " (state unknown)" : "")),
1279                     2);
1280   } else if (is_native_frame()) {
1281     // For now just label the frame
1282     nmethod* nm = cb()->as_nmethod_or_null();
1283     values.describe(-1, info_address,
1284                     FormatBuffer<1024>("#%d nmethod " INTPTR_FORMAT " for native method %s", frame_no,
1285                                        p2i(nm), nm->method()->name_and_sig_as_C_string()), 2);
1286   } else {
1287     // provide default info if not handled before
1288     char *info = (char *) "special frame";
1289     if ((_cb != NULL) &&
1290         (_cb->name() != NULL)) {
1291       info = (char *)_cb->name();
1292     }
1293     values.describe(-1, info_address, err_msg("#%d <%s>", frame_no, info), 2);
1294   }
1295 
1296   // platform dependent additional data
1297   describe_pd(values, frame_no);
1298 }
1299 
1300 #endif
1301 
1302 
1303 //-----------------------------------------------------------------------------------
1304 // StackFrameStream implementation
1305 
1306 StackFrameStream::StackFrameStream(JavaThread *thread, bool update) : _reg_map(thread, update) {
1307   assert(thread->has_last_Java_frame(), "sanity check");
1308   _fr = thread->last_frame();
1309   _is_done = false;
1310 }
1311 
1312 
1313 #ifndef PRODUCT
1314 
1315 void FrameValues::describe(int owner, intptr_t* location, const char* description, int priority) {
1316   FrameValue fv;
1317   fv.location = location;
1318   fv.owner = owner;
1319   fv.priority = priority;
1320   fv.description = NEW_RESOURCE_ARRAY(char, strlen(description) + 1);
1321   strcpy(fv.description, description);
1322   _values.append(fv);
1323 }
1324 
1325 
1326 #ifdef ASSERT
1327 void FrameValues::validate() {
1328   _values.sort(compare);
1329   bool error = false;
1330   FrameValue prev;
1331   prev.owner = -1;
1332   for (int i = _values.length() - 1; i >= 0; i--) {
1333     FrameValue fv = _values.at(i);
1334     if (fv.owner == -1) continue;
1335     if (prev.owner == -1) {
1336       prev = fv;
1337       continue;
1338     }
1339     if (prev.location == fv.location) {
1340       if (fv.owner != prev.owner) {
1341         tty->print_cr("overlapping storage");
1342         tty->print_cr(" " INTPTR_FORMAT ": " INTPTR_FORMAT " %s", p2i(prev.location), *prev.location, prev.description);
1343         tty->print_cr(" " INTPTR_FORMAT ": " INTPTR_FORMAT " %s", p2i(fv.location), *fv.location, fv.description);
1344         error = true;
1345       }
1346     } else {
1347       prev = fv;
1348     }
1349   }
1350   assert(!error, "invalid layout");
1351 }
1352 #endif // ASSERT
1353 
1354 void FrameValues::print(JavaThread* thread) {
1355   _values.sort(compare);
1356 
1357   // Sometimes values like the fp can be invalid values if the
1358   // register map wasn't updated during the walk.  Trim out values
1359   // that aren't actually in the stack of the thread.
1360   int min_index = 0;
1361   int max_index = _values.length() - 1;
1362   intptr_t* v0 = _values.at(min_index).location;
1363   intptr_t* v1 = _values.at(max_index).location;
1364 
1365   if (thread == Thread::current()) {
1366     while (!thread->is_in_stack((address)v0)) {
1367       v0 = _values.at(++min_index).location;
1368     }
1369     while (!thread->is_in_stack((address)v1)) {
1370       v1 = _values.at(--max_index).location;
1371     }
1372   } else {
1373     while (!thread->on_local_stack((address)v0)) {
1374       v0 = _values.at(++min_index).location;
1375     }
1376     while (!thread->on_local_stack((address)v1)) {
1377       v1 = _values.at(--max_index).location;
1378     }
1379   }
1380   intptr_t* min = MIN2(v0, v1);
1381   intptr_t* max = MAX2(v0, v1);
1382   intptr_t* cur = max;
1383   intptr_t* last = NULL;
1384   for (int i = max_index; i >= min_index; i--) {
1385     FrameValue fv = _values.at(i);
1386     while (cur > fv.location) {
1387       tty->print_cr(" " INTPTR_FORMAT ": " INTPTR_FORMAT, p2i(cur), *cur);
1388       cur--;
1389     }
1390     if (last == fv.location) {
1391       const char* spacer = "          " LP64_ONLY("        ");
1392       tty->print_cr(" %s  %s %s", spacer, spacer, fv.description);
1393     } else {
1394       tty->print_cr(" " INTPTR_FORMAT ": " INTPTR_FORMAT " %s", p2i(fv.location), *fv.location, fv.description);
1395       last = fv.location;
1396       cur--;
1397     }
1398   }
1399 }
1400 
1401 #endif // ndef PRODUCT