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