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