1 /*
   2  * Copyright (c) 1997, 2023, 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 "classfile/moduleEntry.hpp"
  27 #include "code/codeCache.hpp"
  28 #include "code/scopeDesc.hpp"
  29 #include "code/vmreg.inline.hpp"
  30 #include "compiler/abstractCompiler.hpp"
  31 #include "compiler/disassembler.hpp"
  32 #include "compiler/oopMap.hpp"
  33 #include "gc/shared/collectedHeap.inline.hpp"
  34 #include "interpreter/interpreter.hpp"
  35 #include "interpreter/oopMapCache.hpp"
  36 #include "logging/log.hpp"
  37 #include "memory/resourceArea.hpp"
  38 #include "memory/universe.hpp"
  39 #include "oops/markWord.hpp"
  40 #include "oops/method.inline.hpp"
  41 #include "oops/methodData.hpp"
  42 #include "oops/oop.inline.hpp"
  43 #include "oops/stackChunkOop.inline.hpp"
  44 #include "oops/verifyOopClosure.hpp"
  45 #include "prims/methodHandles.hpp"
  46 #include "runtime/continuation.hpp"
  47 #include "runtime/continuationEntry.inline.hpp"
  48 #include "runtime/frame.inline.hpp"
  49 #include "runtime/handles.inline.hpp"
  50 #include "runtime/javaCalls.hpp"
  51 #include "runtime/javaThread.hpp"
  52 #include "runtime/monitorChunk.hpp"
  53 #include "runtime/os.hpp"
  54 #include "runtime/sharedRuntime.hpp"
  55 #include "runtime/safefetch.hpp"
  56 #include "runtime/signature.hpp"
  57 #include "runtime/stackValue.hpp"
  58 #include "runtime/stubCodeGenerator.hpp"
  59 #include "runtime/stubRoutines.hpp"
  60 #include "utilities/debug.hpp"
  61 #include "utilities/decoder.hpp"
  62 #include "utilities/formatBuffer.hpp"
  63 
  64 RegisterMap::RegisterMap(JavaThread *thread, UpdateMap update_map, ProcessFrames process_frames, WalkContinuation walk_cont) {
  65   _thread         = thread;
  66   _update_map     = update_map == UpdateMap::include;
  67   _process_frames = process_frames == ProcessFrames::include;
  68   _walk_cont      = walk_cont == WalkContinuation::include;
  69   clear();
  70   DEBUG_ONLY (_update_for_id = nullptr;)
  71   NOT_PRODUCT(_skip_missing = false;)
  72   NOT_PRODUCT(_async = false;)
  73 
  74   if (walk_cont == WalkContinuation::include && thread != nullptr && thread->last_continuation() != nullptr) {
  75     _chunk = stackChunkHandle(Thread::current()->handle_area()->allocate_null_handle(), true /* dummy */);
  76   }
  77   _chunk_index = -1;
  78 
  79 #ifndef PRODUCT
  80   for (int i = 0; i < reg_count ; i++ ) _location[i] = nullptr;
  81 #endif /* PRODUCT */
  82 }
  83 
  84 RegisterMap::RegisterMap(oop continuation, UpdateMap update_map) {
  85   _thread         = nullptr;
  86   _update_map     = update_map == UpdateMap::include;
  87   _process_frames = false;
  88   _walk_cont      = true;
  89   clear();
  90   DEBUG_ONLY (_update_for_id = nullptr;)
  91   NOT_PRODUCT(_skip_missing = false;)
  92   NOT_PRODUCT(_async = false;)
  93 
  94   _chunk = stackChunkHandle(Thread::current()->handle_area()->allocate_null_handle(), true /* dummy */);
  95   _chunk_index = -1;
  96 
  97 #ifndef PRODUCT
  98   for (int i = 0; i < reg_count ; i++ ) _location[i] = nullptr;
  99 #endif /* PRODUCT */
 100 }
 101 
 102 RegisterMap::RegisterMap(const RegisterMap* map) {
 103   assert(map != this, "bad initialization parameter");
 104   assert(map != nullptr, "RegisterMap must be present");
 105   _thread                = map->thread();
 106   _update_map            = map->update_map();
 107   _process_frames        = map->process_frames();
 108   _walk_cont             = map->_walk_cont;
 109   _include_argument_oops = map->include_argument_oops();
 110   DEBUG_ONLY (_update_for_id = map->_update_for_id;)
 111   NOT_PRODUCT(_skip_missing = map->_skip_missing;)
 112   NOT_PRODUCT(_async = map->_async;)
 113 
 114   // only the original RegisterMap's handle lives long enough for StackWalker; this is bound to cause trouble with nested continuations.
 115   _chunk = map->_chunk;
 116   _chunk_index = map->_chunk_index;
 117 
 118   pd_initialize_from(map);
 119   if (update_map()) {
 120     for(int i = 0; i < location_valid_size; i++) {
 121       LocationValidType bits = map->_location_valid[i];
 122       _location_valid[i] = bits;
 123       // for whichever bits are set, pull in the corresponding map->_location
 124       int j = i*location_valid_type_size;
 125       while (bits != 0) {
 126         if ((bits & 1) != 0) {
 127           assert(0 <= j && j < reg_count, "range check");
 128           _location[j] = map->_location[j];
 129         }
 130         bits >>= 1;
 131         j += 1;
 132       }
 133     }
 134   }
 135 }
 136 
 137 oop RegisterMap::cont() const {
 138   return _chunk() != nullptr ? _chunk()->cont() : (oop)nullptr;
 139 }
 140 
 141 void RegisterMap::set_stack_chunk(stackChunkOop chunk) {
 142   assert(chunk == nullptr || _walk_cont, "");
 143   assert(chunk == nullptr || _chunk.not_null(), "");
 144   if (_chunk.is_null()) return;
 145   log_trace(continuations)("set_stack_chunk: " INTPTR_FORMAT " this: " INTPTR_FORMAT, p2i((oopDesc*)chunk), p2i(this));
 146   _chunk.replace(chunk); // reuse handle. see comment above in the constructor
 147   if (chunk == nullptr) {
 148     _chunk_index = -1;
 149   } else {
 150     _chunk_index++;
 151   }
 152 }
 153 
 154 void RegisterMap::clear() {
 155   set_include_argument_oops(true);
 156   if (update_map()) {
 157     for(int i = 0; i < location_valid_size; i++) {
 158       _location_valid[i] = 0;
 159     }
 160     pd_clear();
 161   } else {
 162     pd_initialize();
 163   }
 164 }
 165 
 166 #ifndef PRODUCT
 167 
 168 VMReg RegisterMap::find_register_spilled_here(void* p, intptr_t* sp) {
 169   for(int i = 0; i < RegisterMap::reg_count; i++) {
 170     VMReg r = VMRegImpl::as_VMReg(i);
 171     if (p == location(r, sp)) return r;
 172   }
 173   return nullptr;
 174 }
 175 
 176 void RegisterMap::print_on(outputStream* st) const {
 177   st->print_cr("Register map");
 178   for(int i = 0; i < reg_count; i++) {
 179 
 180     VMReg r = VMRegImpl::as_VMReg(i);
 181     intptr_t* src = (intptr_t*) location(r, nullptr);
 182     if (src != nullptr) {
 183 
 184       r->print_on(st);
 185       st->print(" [" INTPTR_FORMAT "] = ", p2i(src));
 186       if (((uintptr_t)src & (sizeof(*src)-1)) != 0) {
 187         st->print_cr("<misaligned>");
 188       } else {
 189         st->print_cr(INTPTR_FORMAT, *src);
 190       }
 191     }
 192   }
 193 }
 194 
 195 void RegisterMap::print() const {
 196   print_on(tty);
 197 }
 198 
 199 #endif
 200 // This returns the pc that if you were in the debugger you'd see. Not
 201 // the idealized value in the frame object. This undoes the magic conversion
 202 // that happens for deoptimized frames. In addition it makes the value the
 203 // hardware would want to see in the native frame. The only user (at this point)
 204 // is deoptimization. It likely no one else should ever use it.
 205 
 206 address frame::raw_pc() const {
 207   if (is_deoptimized_frame()) {
 208     CompiledMethod* cm = cb()->as_compiled_method_or_null();
 209     if (cm->is_method_handle_return(pc()))
 210       return cm->deopt_mh_handler_begin() - pc_return_offset;
 211     else
 212       return cm->deopt_handler_begin() - pc_return_offset;
 213   } else {
 214     return (pc() - pc_return_offset);
 215   }
 216 }
 217 
 218 // Change the pc in a frame object. This does not change the actual pc in
 219 // actual frame. To do that use patch_pc.
 220 //
 221 void frame::set_pc(address newpc) {
 222 #ifdef ASSERT
 223   if (_cb != nullptr && _cb->is_nmethod()) {
 224     assert(!((nmethod*)_cb)->is_deopt_pc(_pc), "invariant violation");
 225   }
 226 #endif // ASSERT
 227 
 228   // Unsafe to use the is_deoptimized tester after changing pc
 229   _deopt_state = unknown;
 230   _pc = newpc;
 231   _cb = CodeCache::find_blob(_pc);
 232 
 233 }
 234 
 235 // type testers
 236 bool frame::is_ignored_frame() const {
 237   return false;  // FIXME: some LambdaForm frames should be ignored
 238 }
 239 
 240 bool frame::is_native_frame() const {
 241   return (_cb != nullptr &&
 242           _cb->is_nmethod() &&
 243           ((nmethod*)_cb)->is_native_method());
 244 }
 245 
 246 bool frame::is_java_frame() const {
 247   if (is_interpreted_frame()) return true;
 248   if (is_compiled_frame())    return true;
 249   return false;
 250 }
 251 
 252 bool frame::is_runtime_frame() const {
 253   return (_cb != nullptr && _cb->is_runtime_stub());
 254 }
 255 
 256 bool frame::is_safepoint_blob_frame() const {
 257   return (_cb != nullptr && _cb->is_safepoint_stub());
 258 }
 259 
 260 // testers
 261 
 262 bool frame::is_first_java_frame() const {
 263   RegisterMap map(JavaThread::current(),
 264                   RegisterMap::UpdateMap::skip,
 265                   RegisterMap::ProcessFrames::include,
 266                   RegisterMap::WalkContinuation::skip); // No update
 267   frame s;
 268   for (s = sender(&map); !(s.is_java_frame() || s.is_first_frame()); s = s.sender(&map));
 269   return s.is_first_frame();
 270 }
 271 
 272 bool frame::is_first_vthread_frame(JavaThread* thread) const {
 273   return Continuation::is_continuation_enterSpecial(*this)
 274     && Continuation::get_continuation_entry_for_entry_frame(thread, *this)->is_virtual_thread();
 275 }
 276 
 277 bool frame::entry_frame_is_first() const {
 278   return entry_frame_call_wrapper()->is_first_frame();
 279 }
 280 
 281 JavaCallWrapper* frame::entry_frame_call_wrapper_if_safe(JavaThread* thread) const {
 282   JavaCallWrapper** jcw = entry_frame_call_wrapper_addr();
 283   address addr = (address) jcw;
 284 
 285   // addr must be within the usable part of the stack
 286   if (thread->is_in_usable_stack(addr)) {
 287     return *jcw;
 288   }
 289 
 290   return nullptr;
 291 }
 292 
 293 bool frame::is_entry_frame_valid(JavaThread* thread) const {
 294   // Validate the JavaCallWrapper an entry frame must have
 295   address jcw = (address)entry_frame_call_wrapper();
 296   if (!thread->is_in_stack_range_excl(jcw, (address)fp())) {
 297     return false;
 298   }
 299 
 300   // Validate sp saved in the java frame anchor
 301   JavaFrameAnchor* jfa = entry_frame_call_wrapper()->anchor();
 302   return (jfa->last_Java_sp() > sp());
 303 }
 304 
 305 Method* frame::safe_interpreter_frame_method() const {
 306   Method** m_addr = interpreter_frame_method_addr();
 307   if (m_addr == nullptr) {
 308     return nullptr;
 309   }
 310   return (Method*) SafeFetchN((intptr_t*) m_addr, 0);
 311 }
 312 
 313 bool frame::should_be_deoptimized() const {
 314   if (_deopt_state == is_deoptimized ||
 315       !is_compiled_frame() ) return false;
 316   assert(_cb != nullptr && _cb->is_compiled(), "must be an nmethod");
 317   CompiledMethod* nm = (CompiledMethod *)_cb;
 318   LogTarget(Debug, dependencies) lt;
 319   if (lt.is_enabled()) {
 320     LogStream ls(&lt);
 321     ls.print("checking (%s) ", nm->is_marked_for_deoptimization() ? "true" : "false");
 322     nm->print_value_on(&ls);
 323     ls.cr();
 324   }
 325 
 326   if( !nm->is_marked_for_deoptimization() )
 327     return false;
 328 
 329   // If at the return point, then the frame has already been popped, and
 330   // only the return needs to be executed. Don't deoptimize here.
 331   return !nm->is_at_poll_return(pc());
 332 }
 333 
 334 bool frame::can_be_deoptimized() const {
 335   if (!is_compiled_frame()) return false;
 336   CompiledMethod* nm = (CompiledMethod*)_cb;
 337 
 338   if(!nm->can_be_deoptimized())
 339     return false;
 340 
 341   return !nm->is_at_poll_return(pc());
 342 }
 343 
 344 void frame::deoptimize(JavaThread* thread) {
 345   assert(thread == nullptr
 346          || (thread->frame_anchor()->has_last_Java_frame() &&
 347              thread->frame_anchor()->walkable()), "must be");
 348   // Schedule deoptimization of an nmethod activation with this frame.
 349   assert(_cb != nullptr && _cb->is_compiled(), "must be");
 350 
 351   // If the call site is a MethodHandle call site use the MH deopt handler.
 352   CompiledMethod* cm = (CompiledMethod*) _cb;
 353   address deopt = cm->is_method_handle_return(pc()) ?
 354                         cm->deopt_mh_handler_begin() :
 355                         cm->deopt_handler_begin();
 356 
 357   NativePostCallNop* inst = nativePostCallNop_at(pc());
 358 
 359   // Save the original pc before we patch in the new one
 360   cm->set_original_pc(this, pc());
 361   patch_pc(thread, deopt);
 362   assert(is_deoptimized_frame(), "must be");
 363 
 364 #ifdef ASSERT
 365   if (thread != nullptr) {
 366     frame check = thread->last_frame();
 367     if (is_older(check.id())) {
 368       RegisterMap map(thread,
 369                       RegisterMap::UpdateMap::skip,
 370                       RegisterMap::ProcessFrames::include,
 371                       RegisterMap::WalkContinuation::skip);
 372       while (id() != check.id()) {
 373         check = check.sender(&map);
 374       }
 375       assert(check.is_deoptimized_frame(), "missed deopt");
 376     }
 377   }
 378 #endif // ASSERT
 379 }
 380 
 381 frame frame::java_sender() const {
 382   RegisterMap map(JavaThread::current(),
 383                   RegisterMap::UpdateMap::skip,
 384                   RegisterMap::ProcessFrames::include,
 385                   RegisterMap::WalkContinuation::skip);
 386   frame s;
 387   for (s = sender(&map); !(s.is_java_frame() || s.is_first_frame()); s = s.sender(&map)) ;
 388   guarantee(s.is_java_frame(), "tried to get caller of first java frame");
 389   return s;
 390 }
 391 
 392 frame frame::real_sender(RegisterMap* map) const {
 393   frame result = sender(map);
 394   while (result.is_runtime_frame() ||
 395          result.is_ignored_frame()) {
 396     result = result.sender(map);
 397   }
 398   return result;
 399 }
 400 
 401 // Interpreter frames
 402 
 403 
 404 Method* frame::interpreter_frame_method() const {
 405   assert(is_interpreted_frame(), "interpreted frame expected");
 406   Method* m = *interpreter_frame_method_addr();
 407   assert(m->is_method(), "not a Method*");
 408   return m;
 409 }
 410 
 411 void frame::interpreter_frame_set_method(Method* method) {
 412   assert(is_interpreted_frame(), "interpreted frame expected");
 413   *interpreter_frame_method_addr() = method;
 414 }
 415 
 416 void frame::interpreter_frame_set_mirror(oop mirror) {
 417   assert(is_interpreted_frame(), "interpreted frame expected");
 418   *interpreter_frame_mirror_addr() = mirror;
 419 }
 420 
 421 jint frame::interpreter_frame_bci() const {
 422   assert(is_interpreted_frame(), "interpreted frame expected");
 423   address bcp = interpreter_frame_bcp();
 424   return interpreter_frame_method()->bci_from(bcp);
 425 }
 426 
 427 address frame::interpreter_frame_bcp() const {
 428   assert(is_interpreted_frame(), "interpreted frame expected");
 429   address bcp = (address)*interpreter_frame_bcp_addr();
 430   return interpreter_frame_method()->bcp_from(bcp);
 431 }
 432 
 433 void frame::interpreter_frame_set_bcp(address bcp) {
 434   assert(is_interpreted_frame(), "interpreted frame expected");
 435   *interpreter_frame_bcp_addr() = (intptr_t)bcp;
 436 }
 437 
 438 address frame::interpreter_frame_mdp() const {
 439   assert(ProfileInterpreter, "must be profiling interpreter");
 440   assert(is_interpreted_frame(), "interpreted frame expected");
 441   return (address)*interpreter_frame_mdp_addr();
 442 }
 443 
 444 void frame::interpreter_frame_set_mdp(address mdp) {
 445   assert(is_interpreted_frame(), "interpreted frame expected");
 446   assert(ProfileInterpreter, "must be profiling interpreter");
 447   *interpreter_frame_mdp_addr() = (intptr_t)mdp;
 448 }
 449 
 450 BasicObjectLock* frame::next_monitor_in_interpreter_frame(BasicObjectLock* current) const {
 451   assert(is_interpreted_frame(), "Not an interpreted frame");
 452 #ifdef ASSERT
 453   interpreter_frame_verify_monitor(current);
 454 #endif
 455   BasicObjectLock* next = (BasicObjectLock*) (((intptr_t*) current) + interpreter_frame_monitor_size());
 456   return next;
 457 }
 458 
 459 BasicObjectLock* frame::previous_monitor_in_interpreter_frame(BasicObjectLock* current) const {
 460   assert(is_interpreted_frame(), "Not an interpreted frame");
 461 #ifdef ASSERT
 462 //   // This verification needs to be checked before being enabled
 463 //   interpreter_frame_verify_monitor(current);
 464 #endif
 465   BasicObjectLock* previous = (BasicObjectLock*) (((intptr_t*) current) - interpreter_frame_monitor_size());
 466   return previous;
 467 }
 468 
 469 // Interpreter locals and expression stack locations.
 470 
 471 intptr_t* frame::interpreter_frame_local_at(int index) const {
 472   const int n = Interpreter::local_offset_in_bytes(index)/wordSize;
 473   intptr_t* first = interpreter_frame_locals();
 474   return &(first[n]);
 475 }
 476 
 477 intptr_t* frame::interpreter_frame_expression_stack_at(jint offset) const {
 478   const int i = offset * interpreter_frame_expression_stack_direction();
 479   const int n = i * Interpreter::stackElementWords;
 480   return &(interpreter_frame_expression_stack()[n]);
 481 }
 482 
 483 jint frame::interpreter_frame_expression_stack_size() const {
 484   // Number of elements on the interpreter expression stack
 485   // Callers should span by stackElementWords
 486   int element_size = Interpreter::stackElementWords;
 487   size_t stack_size = 0;
 488   if (frame::interpreter_frame_expression_stack_direction() < 0) {
 489     stack_size = (interpreter_frame_expression_stack() -
 490                   interpreter_frame_tos_address() + 1)/element_size;
 491   } else {
 492     stack_size = (interpreter_frame_tos_address() -
 493                   interpreter_frame_expression_stack() + 1)/element_size;
 494   }
 495   assert(stack_size <= (size_t)max_jint, "stack size too big");
 496   return (jint)stack_size;
 497 }
 498 
 499 
 500 // (frame::interpreter_frame_sender_sp accessor is in frame_<arch>.cpp)
 501 
 502 const char* frame::print_name() const {
 503   if (is_native_frame())      return "Native";
 504   if (is_interpreted_frame()) return "Interpreted";
 505   if (is_compiled_frame()) {
 506     if (is_deoptimized_frame()) return "Deoptimized";
 507     return "Compiled";
 508   }
 509   if (sp() == nullptr)            return "Empty";
 510   return "C";
 511 }
 512 
 513 void frame::print_value_on(outputStream* st, JavaThread *thread) const {
 514   NOT_PRODUCT(address begin = pc()-40;)
 515   NOT_PRODUCT(address end   = nullptr;)
 516 
 517   st->print("%s frame (sp=" INTPTR_FORMAT " unextended sp=" INTPTR_FORMAT, print_name(), p2i(sp()), p2i(unextended_sp()));
 518   if (sp() != nullptr)
 519     st->print(", fp=" INTPTR_FORMAT ", real_fp=" INTPTR_FORMAT ", pc=" INTPTR_FORMAT,
 520               p2i(fp()), p2i(real_fp()), p2i(pc()));
 521   st->print_cr(")");
 522 
 523   if (StubRoutines::contains(pc())) {
 524     StubCodeDesc* desc = StubCodeDesc::desc_for(pc());
 525     st->print("~Stub::%s", desc->name());
 526     NOT_PRODUCT(begin = desc->begin(); end = desc->end();)
 527   } else if (Interpreter::contains(pc())) {
 528     InterpreterCodelet* desc = Interpreter::codelet_containing(pc());
 529     if (desc != nullptr) {
 530       st->print("~");
 531       desc->print_on(st);
 532       NOT_PRODUCT(begin = desc->code_begin(); end = desc->code_end();)
 533     } else {
 534       st->print("~interpreter");
 535     }
 536   }
 537 
 538 #ifndef PRODUCT
 539   if (_cb != nullptr) {
 540     st->print("     ");
 541     _cb->print_value_on(st);
 542     if (end == nullptr) {
 543       begin = _cb->code_begin();
 544       end   = _cb->code_end();
 545     }
 546   }
 547   if (WizardMode && Verbose) Disassembler::decode(begin, end);
 548 #endif
 549 }
 550 
 551 void frame::print_on(outputStream* st) const {
 552   print_value_on(st,nullptr);
 553   if (is_interpreted_frame()) {
 554     interpreter_frame_print_on(st);
 555   }
 556 }
 557 
 558 void frame::interpreter_frame_print_on(outputStream* st) const {
 559 #ifndef PRODUCT
 560   assert(is_interpreted_frame(), "Not an interpreted frame");
 561   jint i;
 562   for (i = 0; i < interpreter_frame_method()->max_locals(); i++ ) {
 563     intptr_t x = *interpreter_frame_local_at(i);
 564     st->print(" - local  [" INTPTR_FORMAT "]", x);
 565     st->fill_to(23);
 566     st->print_cr("; #%d", i);
 567   }
 568   for (i = interpreter_frame_expression_stack_size() - 1; i >= 0; --i ) {
 569     intptr_t x = *interpreter_frame_expression_stack_at(i);
 570     st->print(" - stack  [" INTPTR_FORMAT "]", x);
 571     st->fill_to(23);
 572     st->print_cr("; #%d", i);
 573   }
 574   // locks for synchronization
 575   for (BasicObjectLock* current = interpreter_frame_monitor_end();
 576        current < interpreter_frame_monitor_begin();
 577        current = next_monitor_in_interpreter_frame(current)) {
 578     st->print(" - obj    [%s", current->obj() == nullptr ? "null" : "");
 579     oop obj = current->obj();
 580     if (obj != nullptr) {
 581       if (!is_heap_frame()) {
 582         obj->print_value_on(st);
 583       } else {
 584         // Might be an invalid oop. We don't have the
 585         // stackChunk to correct it so just print address.
 586         st->print(INTPTR_FORMAT, p2i(obj));
 587       }
 588     }
 589     st->print_cr("]");
 590     st->print(" - lock   [");
 591     if (!is_heap_frame()) {
 592       current->lock()->print_on(st, obj);
 593     }
 594     st->print_cr("]");
 595   }
 596   // monitor
 597   st->print_cr(" - monitor[" INTPTR_FORMAT "]", p2i(interpreter_frame_monitor_begin()));
 598   // bcp
 599   st->print(" - bcp    [" INTPTR_FORMAT "]", p2i(interpreter_frame_bcp()));
 600   st->fill_to(23);
 601   st->print_cr("; @%d", interpreter_frame_bci());
 602   // locals
 603   st->print_cr(" - locals [" INTPTR_FORMAT "]", p2i(interpreter_frame_local_at(0)));
 604   // method
 605   st->print(" - method [" INTPTR_FORMAT "]", p2i(interpreter_frame_method()));
 606   st->fill_to(23);
 607   st->print("; ");
 608   interpreter_frame_method()->print_name(st);
 609   st->cr();
 610 #endif
 611 }
 612 
 613 // Print whether the frame is in the VM or OS indicating a HotSpot problem.
 614 // Otherwise, it's likely a bug in the native library that the Java code calls,
 615 // hopefully indicating where to submit bugs.
 616 void frame::print_C_frame(outputStream* st, char* buf, int buflen, address pc) {
 617   // C/C++ frame
 618   bool in_vm = os::address_is_in_vm(pc);
 619   st->print(in_vm ? "V" : "C");
 620 
 621   int offset;
 622   bool found;
 623 
 624   if (buf == nullptr || buflen < 1) return;
 625   // libname
 626   buf[0] = '\0';
 627   found = os::dll_address_to_library_name(pc, buf, buflen, &offset);
 628   if (found && buf[0] != '\0') {
 629     // skip directory names
 630     const char *p1, *p2;
 631     p1 = buf;
 632     int len = (int)strlen(os::file_separator());
 633     while ((p2 = strstr(p1, os::file_separator())) != nullptr) p1 = p2 + len;
 634     st->print("  [%s+0x%x]", p1, offset);
 635   } else {
 636     st->print("  " PTR_FORMAT, p2i(pc));
 637   }
 638 
 639   found = os::dll_address_to_function_name(pc, buf, buflen, &offset);
 640   if (found) {
 641     st->print("  %s+0x%x", buf, offset);
 642   }
 643 }
 644 
 645 // frame::print_on_error() is called by fatal error handler. Notice that we may
 646 // crash inside this function if stack frame is corrupted. The fatal error
 647 // handler can catch and handle the crash. Here we assume the frame is valid.
 648 //
 649 // First letter indicates type of the frame:
 650 //    J: Java frame (compiled)
 651 //    j: Java frame (interpreted)
 652 //    V: VM frame (C/C++)
 653 //    v: Other frames running VM generated code (e.g. stubs, adapters, etc.)
 654 //    C: C/C++ frame
 655 //
 656 // We don't need detailed frame type as that in frame::print_name(). "C"
 657 // suggests the problem is in user lib; everything else is likely a VM bug.
 658 
 659 void frame::print_on_error(outputStream* st, char* buf, int buflen, bool verbose) const {
 660   if (_cb != nullptr) {
 661     if (Interpreter::contains(pc())) {
 662       Method* m = this->interpreter_frame_method();
 663       if (m != nullptr) {
 664         m->name_and_sig_as_C_string(buf, buflen);
 665         st->print("j  %s", buf);
 666         st->print("+%d", this->interpreter_frame_bci());
 667         ModuleEntry* module = m->method_holder()->module();
 668         if (module->is_named()) {
 669           module->name()->as_C_string(buf, buflen);
 670           st->print(" %s", buf);
 671           if (module->version() != nullptr) {
 672             module->version()->as_C_string(buf, buflen);
 673             st->print("@%s", buf);
 674           }
 675         }
 676       } else {
 677         st->print("j  " PTR_FORMAT, p2i(pc()));
 678       }
 679     } else if (StubRoutines::contains(pc())) {
 680       StubCodeDesc* desc = StubCodeDesc::desc_for(pc());
 681       if (desc != nullptr) {
 682         st->print("v  ~StubRoutines::%s " PTR_FORMAT, desc->name(), p2i(pc()));
 683       } else {
 684         st->print("v  ~StubRoutines::" PTR_FORMAT, p2i(pc()));
 685       }
 686     } else if (_cb->is_buffer_blob()) {
 687       st->print("v  ~BufferBlob::%s " PTR_FORMAT, ((BufferBlob *)_cb)->name(), p2i(pc()));
 688     } else if (_cb->is_compiled()) {
 689       CompiledMethod* cm = (CompiledMethod*)_cb;
 690       Method* m = cm->method();
 691       if (m != nullptr) {
 692         if (cm->is_nmethod()) {
 693           nmethod* nm = cm->as_nmethod();
 694           st->print("J %d%s", nm->compile_id(), (nm->is_osr_method() ? "%" : ""));
 695           st->print(" %s", nm->compiler_name());
 696         }
 697         m->name_and_sig_as_C_string(buf, buflen);
 698         st->print(" %s", buf);
 699         ModuleEntry* module = m->method_holder()->module();
 700         if (module->is_named()) {
 701           module->name()->as_C_string(buf, buflen);
 702           st->print(" %s", buf);
 703           if (module->version() != nullptr) {
 704             module->version()->as_C_string(buf, buflen);
 705             st->print("@%s", buf);
 706           }
 707         }
 708         st->print(" (%d bytes) @ " PTR_FORMAT " [" PTR_FORMAT "+" INTPTR_FORMAT "]",
 709                   m->code_size(), p2i(_pc), p2i(_cb->code_begin()), _pc - _cb->code_begin());
 710 #if INCLUDE_JVMCI
 711         if (cm->is_nmethod()) {
 712           nmethod* nm = cm->as_nmethod();
 713           const char* jvmciName = nm->jvmci_name();
 714           if (jvmciName != nullptr) {
 715             st->print(" (%s)", jvmciName);
 716           }
 717         }
 718 #endif
 719       } else {
 720         st->print("J  " PTR_FORMAT, p2i(pc()));
 721       }
 722     } else if (_cb->is_runtime_stub()) {
 723       st->print("v  ~RuntimeStub::%s " PTR_FORMAT, ((RuntimeStub *)_cb)->name(), p2i(pc()));
 724     } else if (_cb->is_deoptimization_stub()) {
 725       st->print("v  ~DeoptimizationBlob " PTR_FORMAT, p2i(pc()));
 726     } else if (_cb->is_exception_stub()) {
 727       st->print("v  ~ExceptionBlob " PTR_FORMAT, p2i(pc()));
 728     } else if (_cb->is_safepoint_stub()) {
 729       st->print("v  ~SafepointBlob " PTR_FORMAT, p2i(pc()));
 730     } else if (_cb->is_adapter_blob()) {
 731       st->print("v  ~AdapterBlob " PTR_FORMAT, p2i(pc()));
 732     } else if (_cb->is_vtable_blob()) {
 733       st->print("v  ~VtableBlob " PTR_FORMAT, p2i(pc()));
 734     } else if (_cb->is_method_handles_adapter_blob()) {
 735       st->print("v  ~MethodHandlesAdapterBlob " PTR_FORMAT, p2i(pc()));
 736     } else if (_cb->is_uncommon_trap_stub()) {
 737       st->print("v  ~UncommonTrapBlob " PTR_FORMAT, p2i(pc()));
 738     } else {
 739       st->print("v  blob " PTR_FORMAT, p2i(pc()));
 740     }
 741   } else {
 742     print_C_frame(st, buf, buflen, pc());
 743   }
 744 }
 745 
 746 
 747 /*
 748   The interpreter_frame_expression_stack_at method in the case of SPARC needs the
 749   max_stack value of the method in order to compute the expression stack address.
 750   It uses the Method* in order to get the max_stack value but during GC this
 751   Method* value saved on the frame is changed by reverse_and_push and hence cannot
 752   be used. So we save the max_stack value in the FrameClosure object and pass it
 753   down to the interpreter_frame_expression_stack_at method
 754 */
 755 class InterpreterFrameClosure : public OffsetClosure {
 756  private:
 757   const frame* _fr;
 758   OopClosure*  _f;
 759   int          _max_locals;
 760   int          _max_stack;
 761 
 762  public:
 763   InterpreterFrameClosure(const frame* fr, int max_locals, int max_stack,
 764                           OopClosure* f) {
 765     _fr         = fr;
 766     _max_locals = max_locals;
 767     _max_stack  = max_stack;
 768     _f          = f;
 769   }
 770 
 771   void offset_do(int offset) {
 772     oop* addr;
 773     if (offset < _max_locals) {
 774       addr = (oop*) _fr->interpreter_frame_local_at(offset);
 775       assert((intptr_t*)addr >= _fr->sp(), "must be inside the frame");
 776       _f->do_oop(addr);
 777     } else {
 778       addr = (oop*) _fr->interpreter_frame_expression_stack_at((offset - _max_locals));
 779       // In case of exceptions, the expression stack is invalid and the esp will be reset to express
 780       // this condition. Therefore, we call f only if addr is 'inside' the stack (i.e., addr >= esp for Intel).
 781       bool in_stack;
 782       if (frame::interpreter_frame_expression_stack_direction() > 0) {
 783         in_stack = (intptr_t*)addr <= _fr->interpreter_frame_tos_address();
 784       } else {
 785         in_stack = (intptr_t*)addr >= _fr->interpreter_frame_tos_address();
 786       }
 787       if (in_stack) {
 788         _f->do_oop(addr);
 789       }
 790     }
 791   }
 792 };
 793 
 794 
 795 class InterpretedArgumentOopFinder: public SignatureIterator {
 796  private:
 797   OopClosure*  _f;             // Closure to invoke
 798   int          _offset;        // TOS-relative offset, decremented with each argument
 799   bool         _has_receiver;  // true if the callee has a receiver
 800   const frame* _fr;
 801 
 802   friend class SignatureIterator;  // so do_parameters_on can call do_type
 803   void do_type(BasicType type) {
 804     _offset -= parameter_type_word_count(type);
 805     if (is_reference_type(type)) oop_offset_do();
 806    }
 807 
 808   void oop_offset_do() {
 809     oop* addr;
 810     addr = (oop*)_fr->interpreter_frame_tos_at(_offset);
 811     _f->do_oop(addr);
 812   }
 813 
 814  public:
 815   InterpretedArgumentOopFinder(Symbol* signature, bool has_receiver, const frame* fr, OopClosure* f) : SignatureIterator(signature), _has_receiver(has_receiver) {
 816     // compute size of arguments
 817     int args_size = ArgumentSizeComputer(signature).size() + (has_receiver ? 1 : 0);
 818     assert(!fr->is_interpreted_frame() ||
 819            args_size <= fr->interpreter_frame_expression_stack_size(),
 820             "args cannot be on stack anymore");
 821     // initialize InterpretedArgumentOopFinder
 822     _f         = f;
 823     _fr        = fr;
 824     _offset    = args_size;
 825   }
 826 
 827   void oops_do() {
 828     if (_has_receiver) {
 829       --_offset;
 830       oop_offset_do();
 831     }
 832     do_parameters_on(this);
 833   }
 834 };
 835 
 836 
 837 // Entry frame has following form (n arguments)
 838 //         +-----------+
 839 //   sp -> |  last arg |
 840 //         +-----------+
 841 //         :    :::    :
 842 //         +-----------+
 843 // (sp+n)->|  first arg|
 844 //         +-----------+
 845 
 846 
 847 
 848 // visits and GC's all the arguments in entry frame
 849 class EntryFrameOopFinder: public SignatureIterator {
 850  private:
 851   bool         _is_static;
 852   int          _offset;
 853   const frame* _fr;
 854   OopClosure*  _f;
 855 
 856   friend class SignatureIterator;  // so do_parameters_on can call do_type
 857   void do_type(BasicType type) {
 858     // decrement offset before processing the type
 859     _offset -= parameter_type_word_count(type);
 860     assert (_offset >= 0, "illegal offset");
 861     if (is_reference_type(type))  oop_at_offset_do(_offset);
 862  }
 863 
 864   void oop_at_offset_do(int offset) {
 865     assert (offset >= 0, "illegal offset");
 866     oop* addr = (oop*) _fr->entry_frame_argument_at(offset);
 867     _f->do_oop(addr);
 868   }
 869 
 870  public:
 871   EntryFrameOopFinder(const frame* frame, Symbol* signature, bool is_static) : SignatureIterator(signature) {
 872     _f = nullptr; // will be set later
 873     _fr = frame;
 874     _is_static = is_static;
 875     _offset = ArgumentSizeComputer(signature).size();  // pre-decremented down to zero
 876   }
 877 
 878   void arguments_do(OopClosure* f) {
 879     _f = f;
 880     if (!_is_static)  oop_at_offset_do(_offset); // do the receiver
 881     do_parameters_on(this);
 882   }
 883 
 884 };
 885 
 886 oop* frame::interpreter_callee_receiver_addr(Symbol* signature) {
 887   ArgumentSizeComputer asc(signature);
 888   int size = asc.size();
 889   return (oop *)interpreter_frame_tos_at(size);
 890 }
 891 
 892 oop frame::interpreter_callee_receiver(Symbol* signature) {
 893   return *interpreter_callee_receiver_addr(signature);
 894 }
 895 
 896 void frame::oops_interpreted_do(OopClosure* f, const RegisterMap* map, bool query_oop_map_cache) const {
 897   assert(is_interpreted_frame(), "Not an interpreted frame");
 898   Thread *thread = Thread::current();
 899   methodHandle m (thread, interpreter_frame_method());
 900   jint      bci = interpreter_frame_bci();
 901 
 902   assert(!Universe::heap()->is_in(m()),
 903           "must be valid oop");
 904   assert(m->is_method(), "checking frame value");
 905   assert((m->is_native() && bci == 0)  ||
 906          (!m->is_native() && bci >= 0 && bci < m->code_size()),
 907          "invalid bci value");
 908 
 909   // Handle the monitor elements in the activation
 910   for (
 911     BasicObjectLock* current = interpreter_frame_monitor_end();
 912     current < interpreter_frame_monitor_begin();
 913     current = next_monitor_in_interpreter_frame(current)
 914   ) {
 915 #ifdef ASSERT
 916     interpreter_frame_verify_monitor(current);
 917 #endif
 918     current->oops_do(f);
 919   }
 920 
 921   if (m->is_native()) {
 922     f->do_oop(interpreter_frame_temp_oop_addr());
 923   }
 924 
 925   // The method pointer in the frame might be the only path to the method's
 926   // klass, and the klass needs to be kept alive while executing. The GCs
 927   // don't trace through method pointers, so the mirror of the method's klass
 928   // is installed as a GC root.
 929   f->do_oop(interpreter_frame_mirror_addr());
 930 
 931   int max_locals = m->is_native() ? m->size_of_parameters() : m->max_locals();
 932 
 933   Symbol* signature = nullptr;
 934   bool has_receiver = false;
 935 
 936   // Process a callee's arguments if we are at a call site
 937   // (i.e., if we are at an invoke bytecode)
 938   // This is used sometimes for calling into the VM, not for another
 939   // interpreted or compiled frame.
 940   if (!m->is_native()) {
 941     Bytecode_invoke call = Bytecode_invoke_check(m, bci);
 942     if (map != nullptr && call.is_valid()) {
 943       signature = call.signature();
 944       has_receiver = call.has_receiver();
 945       if (map->include_argument_oops() &&
 946           interpreter_frame_expression_stack_size() > 0) {
 947         ResourceMark rm(thread);  // is this right ???
 948         // we are at a call site & the expression stack is not empty
 949         // => process callee's arguments
 950         //
 951         // Note: The expression stack can be empty if an exception
 952         //       occurred during method resolution/execution. In all
 953         //       cases we empty the expression stack completely be-
 954         //       fore handling the exception (the exception handling
 955         //       code in the interpreter calls a blocking runtime
 956         //       routine which can cause this code to be executed).
 957         //       (was bug gri 7/27/98)
 958         oops_interpreted_arguments_do(signature, has_receiver, f);
 959       }
 960     }
 961   }
 962 
 963   InterpreterFrameClosure blk(this, max_locals, m->max_stack(), f);
 964 
 965   // process locals & expression stack
 966   InterpreterOopMap mask;
 967   if (query_oop_map_cache) {
 968     m->mask_for(bci, &mask);
 969   } else {
 970     OopMapCache::compute_one_oop_map(m, bci, &mask);
 971   }
 972   mask.iterate_oop(&blk);
 973 }
 974 
 975 
 976 void frame::oops_interpreted_arguments_do(Symbol* signature, bool has_receiver, OopClosure* f) const {
 977   InterpretedArgumentOopFinder finder(signature, has_receiver, this, f);
 978   finder.oops_do();
 979 }
 980 
 981 void frame::oops_code_blob_do(OopClosure* f, CodeBlobClosure* cf, DerivedOopClosure* df, DerivedPointerIterationMode derived_mode, const RegisterMap* reg_map) const {
 982   assert(_cb != nullptr, "sanity check");
 983   assert((oop_map() == nullptr) == (_cb->oop_maps() == nullptr), "frame and _cb must agree that oopmap is set or not");
 984   if (oop_map() != nullptr) {
 985     if (df != nullptr) {
 986       _oop_map->oops_do(this, reg_map, f, df);
 987     } else {
 988       _oop_map->oops_do(this, reg_map, f, derived_mode);
 989     }
 990 
 991     // Preserve potential arguments for a callee. We handle this by dispatching
 992     // on the codeblob. For c2i, we do
 993     if (reg_map->include_argument_oops()) {
 994       _cb->preserve_callee_argument_oops(*this, reg_map, f);
 995     }
 996   }
 997   // In cases where perm gen is collected, GC will want to mark
 998   // oops referenced from nmethods active on thread stacks so as to
 999   // prevent them from being collected. However, this visit should be
1000   // restricted to certain phases of the collection only. The
1001   // closure decides how it wants nmethods to be traced.
1002   if (cf != nullptr)
1003     cf->do_code_blob(_cb);
1004 }
1005 
1006 class CompiledArgumentOopFinder: public SignatureIterator {
1007  protected:
1008   OopClosure*     _f;
1009   int             _offset;        // the current offset, incremented with each argument
1010   bool            _has_receiver;  // true if the callee has a receiver
1011   bool            _has_appendix;  // true if the call has an appendix
1012   frame           _fr;
1013   RegisterMap*    _reg_map;
1014   int             _arg_size;
1015   VMRegPair*      _regs;        // VMReg list of arguments
1016 
1017   friend class SignatureIterator;  // so do_parameters_on can call do_type
1018   void do_type(BasicType type) {
1019     if (is_reference_type(type))  handle_oop_offset();
1020     _offset += parameter_type_word_count(type);
1021   }
1022 
1023   virtual void handle_oop_offset() {
1024     // Extract low order register number from register array.
1025     // In LP64-land, the high-order bits are valid but unhelpful.
1026     VMReg reg = _regs[_offset].first();
1027     oop *loc = _fr.oopmapreg_to_oop_location(reg, _reg_map);
1028   #ifdef ASSERT
1029     if (loc == nullptr) {
1030       if (_reg_map->should_skip_missing()) {
1031         return;
1032       }
1033       tty->print_cr("Error walking frame oops:");
1034       _fr.print_on(tty);
1035       assert(loc != nullptr, "missing register map entry reg: %d %s loc: " INTPTR_FORMAT, reg->value(), reg->name(), p2i(loc));
1036     }
1037   #endif
1038     _f->do_oop(loc);
1039   }
1040 
1041  public:
1042   CompiledArgumentOopFinder(Symbol* signature, bool has_receiver, bool has_appendix, OopClosure* f, frame fr, const RegisterMap* reg_map)
1043     : SignatureIterator(signature) {
1044 
1045     // initialize CompiledArgumentOopFinder
1046     _f         = f;
1047     _offset    = 0;
1048     _has_receiver = has_receiver;
1049     _has_appendix = has_appendix;
1050     _fr        = fr;
1051     _reg_map   = (RegisterMap*)reg_map;
1052     _arg_size  = ArgumentSizeComputer(signature).size() + (has_receiver ? 1 : 0) + (has_appendix ? 1 : 0);
1053 
1054     int arg_size;
1055     _regs = SharedRuntime::find_callee_arguments(signature, has_receiver, has_appendix, &arg_size);
1056     assert(arg_size == _arg_size, "wrong arg size");
1057   }
1058 
1059   void oops_do() {
1060     if (_has_receiver) {
1061       handle_oop_offset();
1062       _offset++;
1063     }
1064     do_parameters_on(this);
1065     if (_has_appendix) {
1066       handle_oop_offset();
1067       _offset++;
1068     }
1069   }
1070 };
1071 
1072 void frame::oops_compiled_arguments_do(Symbol* signature, bool has_receiver, bool has_appendix,
1073                                        const RegisterMap* reg_map, OopClosure* f) const {
1074   // ResourceMark rm;
1075   CompiledArgumentOopFinder finder(signature, has_receiver, has_appendix, f, *this, reg_map);
1076   finder.oops_do();
1077 }
1078 
1079 // Get receiver out of callers frame, i.e. find parameter 0 in callers
1080 // frame.  Consult ADLC for where parameter 0 is to be found.  Then
1081 // check local reg_map for it being a callee-save register or argument
1082 // register, both of which are saved in the local frame.  If not found
1083 // there, it must be an in-stack argument of the caller.
1084 // Note: caller.sp() points to callee-arguments
1085 oop frame::retrieve_receiver(RegisterMap* reg_map) {
1086   frame caller = *this;
1087 
1088   // First consult the ADLC on where it puts parameter 0 for this signature.
1089   VMReg reg = SharedRuntime::name_for_receiver();
1090   oop* oop_adr = caller.oopmapreg_to_oop_location(reg, reg_map);
1091   if (oop_adr == nullptr) {
1092     guarantee(oop_adr != nullptr, "bad register save location");
1093     return nullptr;
1094   }
1095   oop r = *oop_adr;
1096   assert(Universe::heap()->is_in_or_null(r), "bad receiver: " INTPTR_FORMAT " (" INTX_FORMAT ")", p2i(r), p2i(r));
1097   return r;
1098 }
1099 
1100 
1101 BasicLock* frame::get_native_monitor() const {
1102   nmethod* nm = (nmethod*)_cb;
1103   assert(_cb != nullptr && _cb->is_nmethod() && nm->method()->is_native(),
1104          "Should not call this unless it's a native nmethod");
1105   int byte_offset = in_bytes(nm->native_basic_lock_sp_offset());
1106   assert(byte_offset >= 0, "should not see invalid offset");
1107   return (BasicLock*) &sp()[byte_offset / wordSize];
1108 }
1109 
1110 oop frame::get_native_receiver() const {
1111   nmethod* nm = (nmethod*)_cb;
1112   assert(_cb != nullptr && _cb->is_nmethod() && nm->method()->is_native(),
1113          "Should not call this unless it's a native nmethod");
1114   int byte_offset = in_bytes(nm->native_receiver_sp_offset());
1115   assert(byte_offset >= 0, "should not see invalid offset");
1116   oop owner = ((oop*) sp())[byte_offset / wordSize];
1117   assert( Universe::heap()->is_in(owner), "bad receiver" );
1118   return owner;
1119 }
1120 
1121 void frame::oops_entry_do(OopClosure* f, const RegisterMap* map) const {
1122   assert(map != nullptr, "map must be set");
1123   if (map->include_argument_oops()) {
1124     // must collect argument oops, as nobody else is doing it
1125     Thread *thread = Thread::current();
1126     methodHandle m (thread, entry_frame_call_wrapper()->callee_method());
1127     EntryFrameOopFinder finder(this, m->signature(), m->is_static());
1128     finder.arguments_do(f);
1129   }
1130   // Traverse the Handle Block saved in the entry frame
1131   entry_frame_call_wrapper()->oops_do(f);
1132 }
1133 
1134 bool frame::is_deoptimized_frame() const {
1135   assert(_deopt_state != unknown, "not answerable");
1136   if (_deopt_state == is_deoptimized) {
1137     return true;
1138   }
1139 
1140   /* This method only checks if the frame is deoptimized
1141    * as in return address being patched.
1142    * It doesn't care if the OP that we return to is a
1143    * deopt instruction */
1144   /*if (_cb != nullptr && _cb->is_nmethod()) {
1145     return NativeDeoptInstruction::is_deopt_at(_pc);
1146   }*/
1147   return false;
1148 }
1149 
1150 void frame::oops_do_internal(OopClosure* f, CodeBlobClosure* cf,
1151                              DerivedOopClosure* df, DerivedPointerIterationMode derived_mode,
1152                              const RegisterMap* map, bool use_interpreter_oop_map_cache) const {
1153 #ifndef PRODUCT
1154   // simulate GC crash here to dump java thread in error report
1155   if (CrashGCForDumpingJavaThread) {
1156     char *t = nullptr;
1157     *t = 'c';
1158   }
1159 #endif
1160   if (is_interpreted_frame()) {
1161     oops_interpreted_do(f, map, use_interpreter_oop_map_cache);
1162   } else if (is_entry_frame()) {
1163     oops_entry_do(f, map);
1164   } else if (is_upcall_stub_frame()) {
1165     _cb->as_upcall_stub()->oops_do(f, *this);
1166   } else if (CodeCache::contains(pc())) {
1167     oops_code_blob_do(f, cf, df, derived_mode, map);
1168   } else {
1169     ShouldNotReachHere();
1170   }
1171 }
1172 
1173 void frame::nmethods_do(CodeBlobClosure* cf) const {
1174   if (_cb != nullptr && _cb->is_nmethod()) {
1175     cf->do_code_blob(_cb);
1176   }
1177 }
1178 
1179 
1180 // Call f closure on the interpreted Method*s in the stack.
1181 void frame::metadata_do(MetadataClosure* f) const {
1182   ResourceMark rm;
1183   if (is_interpreted_frame()) {
1184     Method* m = this->interpreter_frame_method();
1185     assert(m != nullptr, "expecting a method in this frame");
1186     f->do_metadata(m);
1187   }
1188 }
1189 
1190 void frame::verify(const RegisterMap* map) const {
1191 #ifndef PRODUCT
1192   if (TraceCodeBlobStacks) {
1193     tty->print_cr("*** verify");
1194     print_on(tty);
1195   }
1196 #endif
1197 
1198   // for now make sure receiver type is correct
1199   if (is_interpreted_frame()) {
1200     Method* method = interpreter_frame_method();
1201     guarantee(method->is_method(), "method is wrong in frame::verify");
1202     if (!method->is_static()) {
1203       // fetch the receiver
1204       oop* p = (oop*) interpreter_frame_local_at(0);
1205       // make sure we have the right receiver type
1206     }
1207   }
1208 #if COMPILER2_OR_JVMCI
1209   assert(DerivedPointerTable::is_empty(), "must be empty before verify");
1210 #endif
1211 
1212   if (map->update_map()) { // The map has to be up-to-date for the current frame
1213     oops_do_internal(&VerifyOopClosure::verify_oop, nullptr, nullptr, DerivedPointerIterationMode::_ignore, map, false);
1214   }
1215 }
1216 
1217 
1218 #ifdef ASSERT
1219 bool frame::verify_return_pc(address x) {
1220 #ifdef TARGET_ARCH_aarch64
1221   if (!pauth_ptr_is_raw(x)) {
1222     return false;
1223   }
1224 #endif
1225   if (StubRoutines::returns_to_call_stub(x)) {
1226     return true;
1227   }
1228   if (CodeCache::contains(x)) {
1229     return true;
1230   }
1231   if (Interpreter::contains(x)) {
1232     return true;
1233   }
1234   return false;
1235 }
1236 #endif
1237 
1238 #ifdef ASSERT
1239 void frame::interpreter_frame_verify_monitor(BasicObjectLock* value) const {
1240   assert(is_interpreted_frame(), "Not an interpreted frame");
1241   // verify that the value is in the right part of the frame
1242   address low_mark  = (address) interpreter_frame_monitor_end();
1243   address high_mark = (address) interpreter_frame_monitor_begin();
1244   address current   = (address) value;
1245 
1246   const int monitor_size = frame::interpreter_frame_monitor_size();
1247   guarantee((high_mark - current) % monitor_size  ==  0         , "Misaligned top of BasicObjectLock*");
1248   guarantee( high_mark > current                                , "Current BasicObjectLock* higher than high_mark");
1249 
1250   guarantee((current - low_mark) % monitor_size  ==  0         , "Misaligned bottom of BasicObjectLock*");
1251   guarantee( current >= low_mark                               , "Current BasicObjectLock* below than low_mark");
1252 }
1253 #endif
1254 
1255 #ifndef PRODUCT
1256 
1257 // Returns true iff the address p is readable and *(intptr_t*)p != errvalue
1258 extern "C" bool dbg_is_safe(const void* p, intptr_t errvalue);
1259 
1260 class FrameValuesOopClosure: public OopClosure, public DerivedOopClosure {
1261 private:
1262   GrowableArray<oop*>* _oops;
1263   GrowableArray<narrowOop*>* _narrow_oops;
1264   GrowableArray<derived_base*>* _base;
1265   GrowableArray<derived_pointer*>* _derived;
1266   NoSafepointVerifier nsv;
1267 
1268 public:
1269   FrameValuesOopClosure() {
1270     _oops = new (mtThread) GrowableArray<oop*>(100, mtThread);
1271     _narrow_oops = new (mtThread) GrowableArray<narrowOop*>(100, mtThread);
1272     _base = new (mtThread) GrowableArray<derived_base*>(100, mtThread);
1273     _derived = new (mtThread) GrowableArray<derived_pointer*>(100, mtThread);
1274   }
1275   ~FrameValuesOopClosure() {
1276     delete _oops;
1277     delete _narrow_oops;
1278     delete _base;
1279     delete _derived;
1280   }
1281 
1282   virtual void do_oop(oop* p) override { _oops->push(p); }
1283   virtual void do_oop(narrowOop* p) override { _narrow_oops->push(p); }
1284   virtual void do_derived_oop(derived_base* base_loc, derived_pointer* derived_loc) override {
1285     _base->push(base_loc);
1286     _derived->push(derived_loc);
1287   }
1288 
1289   bool is_good(oop* p) {
1290     return *p == nullptr || (dbg_is_safe(*p, -1) && oopDesc::is_oop_or_null(*p));
1291   }
1292   void describe(FrameValues& values, int frame_no) {
1293     for (int i = 0; i < _oops->length(); i++) {
1294       oop* p = _oops->at(i);
1295       values.describe(frame_no, (intptr_t*)p, err_msg("oop%s for #%d", is_good(p) ? "" : " (BAD)", frame_no));
1296     }
1297     for (int i = 0; i < _narrow_oops->length(); i++) {
1298       narrowOop* p = _narrow_oops->at(i);
1299       // we can't check for bad compressed oops, as decoding them might crash
1300       values.describe(frame_no, (intptr_t*)p, err_msg("narrow oop for #%d", frame_no));
1301     }
1302     assert(_base->length() == _derived->length(), "should be the same");
1303     for (int i = 0; i < _base->length(); i++) {
1304       derived_base* base = _base->at(i);
1305       derived_pointer* derived = _derived->at(i);
1306       values.describe(frame_no, (intptr_t*)derived, err_msg("derived pointer (base: " INTPTR_FORMAT ") for #%d", p2i(base), frame_no));
1307     }
1308   }
1309 };
1310 
1311 class FrameValuesOopMapClosure: public OopMapClosure {
1312 private:
1313   const frame* _fr;
1314   const RegisterMap* _reg_map;
1315   FrameValues& _values;
1316   int _frame_no;
1317 
1318 public:
1319   FrameValuesOopMapClosure(const frame* fr, const RegisterMap* reg_map, FrameValues& values, int frame_no)
1320    : _fr(fr), _reg_map(reg_map), _values(values), _frame_no(frame_no) {}
1321 
1322   virtual void do_value(VMReg reg, OopMapValue::oop_types type) override {
1323     intptr_t* p = (intptr_t*)_fr->oopmapreg_to_location(reg, _reg_map);
1324     if (p != nullptr && (((intptr_t)p & WordAlignmentMask) == 0)) {
1325       const char* type_name = nullptr;
1326       switch(type) {
1327         case OopMapValue::oop_value:          type_name = "oop";          break;
1328         case OopMapValue::narrowoop_value:    type_name = "narrow oop";   break;
1329         case OopMapValue::callee_saved_value: type_name = "callee-saved"; break;
1330         case OopMapValue::derived_oop_value:  type_name = "derived";      break;
1331         // case OopMapValue::live_value:         type_name = "live";         break;
1332         default: break;
1333       }
1334       if (type_name != nullptr) {
1335         _values.describe(_frame_no, p, err_msg("%s for #%d", type_name, _frame_no));
1336       }
1337     }
1338   }
1339 };
1340 
1341 // callers need a ResourceMark because of name_and_sig_as_C_string() usage,
1342 // RA allocated string is returned to the caller
1343 void frame::describe(FrameValues& values, int frame_no, const RegisterMap* reg_map, bool top) {
1344   // boundaries: sp and the 'real' frame pointer
1345   values.describe(-1, sp(), err_msg("sp for #%d", frame_no), 0);
1346   if (top) {
1347     values.describe(-1, sp() - 1, err_msg("sp[-1] for #%d", frame_no), 0);
1348     values.describe(-1, sp() - 2, err_msg("sp[-2] for #%d", frame_no), 0);
1349   }
1350 
1351   intptr_t* frame_pointer = real_fp(); // Note: may differ from fp()
1352 
1353   // print frame info at the highest boundary
1354   intptr_t* info_address = MAX2(sp(), frame_pointer);
1355 
1356   if (info_address != frame_pointer) {
1357     // print frame_pointer explicitly if not marked by the frame info
1358     values.describe(-1, frame_pointer, err_msg("frame pointer for #%d", frame_no), 1);
1359   }
1360 
1361   if (is_entry_frame() || is_compiled_frame() || is_interpreted_frame() || is_native_frame()) {
1362     // Label values common to most frames
1363     values.describe(-1, unextended_sp(), err_msg("unextended_sp for #%d", frame_no), 0);
1364   }
1365 
1366   if (is_interpreted_frame()) {
1367     Method* m = interpreter_frame_method();
1368     int bci = interpreter_frame_bci();
1369     InterpreterCodelet* desc = Interpreter::codelet_containing(pc());
1370 
1371     // Label the method and current bci
1372     values.describe(-1, info_address,
1373                     FormatBuffer<1024>("#%d method %s @ %d", frame_no, m->name_and_sig_as_C_string(), bci), 3);
1374     if (desc != nullptr) {
1375       values.describe(-1, info_address, err_msg("- %s codelet: %s",
1376         desc->bytecode()    >= 0    ? Bytecodes::name(desc->bytecode()) : "",
1377         desc->description() != nullptr ? desc->description()               : "?"), 2);
1378     }
1379     values.describe(-1, info_address,
1380                     err_msg("- %d locals %d max stack", m->max_locals(), m->max_stack()), 2);
1381     // return address will be emitted by caller in describe_pd
1382     // values.describe(frame_no, (intptr_t*)sender_pc_addr(), Continuation::is_return_barrier_entry(*sender_pc_addr()) ? "return address (return barrier)" : "return address");
1383 
1384     if (m->max_locals() > 0) {
1385       intptr_t* l0 = interpreter_frame_local_at(0);
1386       intptr_t* ln = interpreter_frame_local_at(m->max_locals() - 1);
1387       values.describe(-1, MAX2(l0, ln), err_msg("locals for #%d", frame_no), 2);
1388       // Report each local and mark as owned by this frame
1389       for (int l = 0; l < m->max_locals(); l++) {
1390         intptr_t* l0 = interpreter_frame_local_at(l);
1391         values.describe(frame_no, l0, err_msg("local %d", l), 1);
1392       }
1393     }
1394 
1395     if (interpreter_frame_monitor_begin() != interpreter_frame_monitor_end()) {
1396       values.describe(frame_no, (intptr_t*)interpreter_frame_monitor_begin(), "monitors begin");
1397       values.describe(frame_no, (intptr_t*)interpreter_frame_monitor_end(), "monitors end");
1398     }
1399 
1400     // Compute the actual expression stack size
1401     InterpreterOopMap mask;
1402     OopMapCache::compute_one_oop_map(methodHandle(Thread::current(), m), bci, &mask);
1403     intptr_t* tos = nullptr;
1404     // Report each stack element and mark as owned by this frame
1405     for (int e = 0; e < mask.expression_stack_size(); e++) {
1406       tos = MAX2(tos, interpreter_frame_expression_stack_at(e));
1407       values.describe(frame_no, interpreter_frame_expression_stack_at(e),
1408                       err_msg("stack %d", e), 1);
1409     }
1410     if (tos != nullptr) {
1411       values.describe(-1, tos, err_msg("expression stack for #%d", frame_no), 2);
1412     }
1413 
1414     if (reg_map != nullptr) {
1415       FrameValuesOopClosure oopsFn;
1416       oops_do(&oopsFn, nullptr, &oopsFn, reg_map);
1417       oopsFn.describe(values, frame_no);
1418     }
1419   } else if (is_entry_frame()) {
1420     // For now just label the frame
1421     values.describe(-1, info_address, err_msg("#%d entry frame", frame_no), 2);
1422   } else if (cb() && cb()->is_compiled()) {
1423     // For now just label the frame
1424     CompiledMethod* cm = cb()->as_compiled_method();
1425     values.describe(-1, info_address,
1426                     FormatBuffer<1024>("#%d nmethod " INTPTR_FORMAT " for method J %s%s", frame_no,
1427                                        p2i(cm),
1428                                        cm->method()->name_and_sig_as_C_string(),
1429                                        (_deopt_state == is_deoptimized) ?
1430                                        " (deoptimized)" :
1431                                        ((_deopt_state == unknown) ? " (state unknown)" : "")),
1432                     3);
1433 
1434     { // mark arguments (see nmethod::print_nmethod_labels)
1435       Method* m = cm->method();
1436 
1437       int stack_slot_offset = cm->frame_size() * wordSize; // offset, in bytes, to caller sp
1438       int sizeargs = m->size_of_parameters();
1439 
1440       BasicType* sig_bt = NEW_RESOURCE_ARRAY(BasicType, sizeargs);
1441       VMRegPair* regs   = NEW_RESOURCE_ARRAY(VMRegPair, sizeargs);
1442       {
1443         int sig_index = 0;
1444         if (!m->is_static()) {
1445           sig_bt[sig_index++] = T_OBJECT; // 'this'
1446         }
1447         for (SignatureStream ss(m->signature()); !ss.at_return_type(); ss.next()) {
1448           BasicType t = ss.type();
1449           assert(type2size[t] == 1 || type2size[t] == 2, "size is 1 or 2");
1450           sig_bt[sig_index++] = t;
1451           if (type2size[t] == 2) {
1452             sig_bt[sig_index++] = T_VOID;
1453           }
1454         }
1455         assert(sig_index == sizeargs, "");
1456       }
1457       int stack_arg_slots = SharedRuntime::java_calling_convention(sig_bt, regs, sizeargs);
1458       assert(stack_arg_slots ==  m->num_stack_arg_slots(false /* rounded */), "");
1459       int out_preserve = SharedRuntime::out_preserve_stack_slots();
1460       int sig_index = 0;
1461       int arg_index = (m->is_static() ? 0 : -1);
1462       for (SignatureStream ss(m->signature()); !ss.at_return_type(); ) {
1463         bool at_this = (arg_index == -1);
1464         bool at_old_sp = false;
1465         BasicType t = (at_this ? T_OBJECT : ss.type());
1466         assert(t == sig_bt[sig_index], "sigs in sync");
1467         VMReg fst = regs[sig_index].first();
1468         if (fst->is_stack()) {
1469           assert(((int)fst->reg2stack()) >= 0, "reg2stack: %d", fst->reg2stack());
1470           int offset = (fst->reg2stack() + out_preserve) * VMRegImpl::stack_slot_size + stack_slot_offset;
1471           intptr_t* stack_address = (intptr_t*)((address)unextended_sp() + offset);
1472           if (at_this) {
1473             values.describe(frame_no, stack_address, err_msg("this for #%d", frame_no), 1);
1474           } else {
1475             values.describe(frame_no, stack_address, err_msg("param %d %s for #%d", arg_index, type2name(t), frame_no), 1);
1476           }
1477         }
1478         sig_index += type2size[t];
1479         arg_index += 1;
1480         if (!at_this) {
1481           ss.next();
1482         }
1483       }
1484     }
1485 
1486     if (reg_map != nullptr && is_java_frame()) {
1487       int scope_no = 0;
1488       for (ScopeDesc* scope = cm->scope_desc_at(pc()); scope != nullptr; scope = scope->sender(), scope_no++) {
1489         Method* m = scope->method();
1490         int  bci = scope->bci();
1491         values.describe(-1, info_address, err_msg("- #%d scope %s @ %d", scope_no, m->name_and_sig_as_C_string(), bci), 2);
1492 
1493         { // mark locals
1494           GrowableArray<ScopeValue*>* scvs = scope->locals();
1495           int scvs_length = scvs != nullptr ? scvs->length() : 0;
1496           for (int i = 0; i < scvs_length; i++) {
1497             intptr_t* stack_address = (intptr_t*)StackValue::stack_value_address(this, reg_map, scvs->at(i));
1498             if (stack_address != nullptr) {
1499               values.describe(frame_no, stack_address, err_msg("local %d for #%d (scope %d)", i, frame_no, scope_no), 1);
1500             }
1501           }
1502         }
1503         { // mark expression stack
1504           GrowableArray<ScopeValue*>* scvs = scope->expressions();
1505           int scvs_length = scvs != nullptr ? scvs->length() : 0;
1506           for (int i = 0; i < scvs_length; i++) {
1507             intptr_t* stack_address = (intptr_t*)StackValue::stack_value_address(this, reg_map, scvs->at(i));
1508             if (stack_address != nullptr) {
1509               values.describe(frame_no, stack_address, err_msg("stack %d for #%d (scope %d)", i, frame_no, scope_no), 1);
1510             }
1511           }
1512         }
1513       }
1514 
1515       FrameValuesOopClosure oopsFn;
1516       oops_do(&oopsFn, nullptr, &oopsFn, reg_map);
1517       oopsFn.describe(values, frame_no);
1518 
1519       if (oop_map() != nullptr) {
1520         FrameValuesOopMapClosure valuesFn(this, reg_map, values, frame_no);
1521         // also OopMapValue::live_value ??
1522         oop_map()->all_type_do(this, OopMapValue::callee_saved_value, &valuesFn);
1523       }
1524     }
1525 
1526     if (cm->method()->is_continuation_enter_intrinsic()) {
1527       ContinuationEntry* ce = Continuation::get_continuation_entry_for_entry_frame(reg_map->thread(), *this); // (ContinuationEntry*)unextended_sp();
1528       ce->describe(values, frame_no);
1529     }
1530   } else if (is_native_frame()) {
1531     // For now just label the frame
1532     nmethod* nm = cb()->as_nmethod_or_null();
1533     values.describe(-1, info_address,
1534                     FormatBuffer<1024>("#%d nmethod " INTPTR_FORMAT " for native method %s", frame_no,
1535                                        p2i(nm), nm->method()->name_and_sig_as_C_string()), 2);
1536   } else {
1537     // provide default info if not handled before
1538     char *info = (char *) "special frame";
1539     if ((_cb != nullptr) &&
1540         (_cb->name() != nullptr)) {
1541       info = (char *)_cb->name();
1542     }
1543     values.describe(-1, info_address, err_msg("#%d <%s>", frame_no, info), 2);
1544   }
1545 
1546   // platform dependent additional data
1547   describe_pd(values, frame_no);
1548 }
1549 
1550 #endif
1551 
1552 #ifndef PRODUCT
1553 
1554 void FrameValues::describe(int owner, intptr_t* location, const char* description, int priority) {
1555   FrameValue fv;
1556   fv.location = location;
1557   fv.owner = owner;
1558   fv.priority = priority;
1559   fv.description = NEW_RESOURCE_ARRAY(char, strlen(description) + 1);
1560   strcpy(fv.description, description);
1561   _values.append(fv);
1562 }
1563 
1564 
1565 #ifdef ASSERT
1566 void FrameValues::validate() {
1567   _values.sort(compare);
1568   bool error = false;
1569   FrameValue prev;
1570   prev.owner = -1;
1571   for (int i = _values.length() - 1; i >= 0; i--) {
1572     FrameValue fv = _values.at(i);
1573     if (fv.owner == -1) continue;
1574     if (prev.owner == -1) {
1575       prev = fv;
1576       continue;
1577     }
1578     if (prev.location == fv.location) {
1579       if (fv.owner != prev.owner) {
1580         tty->print_cr("overlapping storage");
1581         tty->print_cr(" " INTPTR_FORMAT ": " INTPTR_FORMAT " %s", p2i(prev.location), *prev.location, prev.description);
1582         tty->print_cr(" " INTPTR_FORMAT ": " INTPTR_FORMAT " %s", p2i(fv.location), *fv.location, fv.description);
1583         error = true;
1584       }
1585     } else {
1586       prev = fv;
1587     }
1588   }
1589   // if (error) { tty->cr(); print_on(static_cast<JavaThread*>(nullptr), tty); }
1590   assert(!error, "invalid layout");
1591 }
1592 #endif // ASSERT
1593 
1594 void FrameValues::print_on(JavaThread* thread, outputStream* st) {
1595   _values.sort(compare);
1596 
1597   // Sometimes values like the fp can be invalid values if the
1598   // register map wasn't updated during the walk.  Trim out values
1599   // that aren't actually in the stack of the thread.
1600   int min_index = 0;
1601   int max_index = _values.length() - 1;
1602   intptr_t* v0 = _values.at(min_index).location;
1603   intptr_t* v1 = _values.at(max_index).location;
1604 
1605   if (thread != nullptr) {
1606     if (thread == Thread::current()) {
1607       while (!thread->is_in_live_stack((address)v0)) v0 = _values.at(++min_index).location;
1608       while (!thread->is_in_live_stack((address)v1)) v1 = _values.at(--max_index).location;
1609     } else {
1610       while (!thread->is_in_full_stack((address)v0)) v0 = _values.at(++min_index).location;
1611       while (!thread->is_in_full_stack((address)v1)) v1 = _values.at(--max_index).location;
1612     }
1613   }
1614 
1615   print_on(st, min_index, max_index, v0, v1);
1616 }
1617 
1618 void FrameValues::print_on(stackChunkOop chunk, outputStream* st) {
1619   _values.sort(compare);
1620 
1621   intptr_t* start = chunk->start_address();
1622   intptr_t* end = chunk->end_address() + 1;
1623 
1624   int min_index = 0;
1625   int max_index = _values.length() - 1;
1626   intptr_t* v0 = _values.at(min_index).location;
1627   intptr_t* v1 = _values.at(max_index).location;
1628   while (!(start <= v0 && v0 <= end)) v0 = _values.at(++min_index).location;
1629   while (!(start <= v1 && v1 <= end)) v1 = _values.at(--max_index).location;
1630 
1631   print_on(st, min_index, max_index, v0, v1);
1632 }
1633 
1634 void FrameValues::print_on(outputStream* st, int min_index, int max_index, intptr_t* v0, intptr_t* v1) {
1635   intptr_t* min = MIN2(v0, v1);
1636   intptr_t* max = MAX2(v0, v1);
1637   intptr_t* cur = max;
1638   intptr_t* last = nullptr;
1639   for (int i = max_index; i >= min_index; i--) {
1640     FrameValue fv = _values.at(i);
1641     while (cur > fv.location) {
1642       st->print_cr(" " INTPTR_FORMAT ": " INTPTR_FORMAT, p2i(cur), *cur);
1643       cur--;
1644     }
1645     if (last == fv.location) {
1646       const char* spacer = "          " LP64_ONLY("        ");
1647       st->print_cr(" %s  %s %s", spacer, spacer, fv.description);
1648     } else {
1649       if (*fv.location != 0 && *fv.location > -100 && *fv.location < 100
1650 #if !defined(PPC64)
1651           && (strncmp(fv.description, "interpreter_frame_", 18) == 0 || strstr(fv.description, " method "))
1652 #else  // !defined(PPC64)
1653           && (strcmp(fv.description, "sender_sp") == 0 || strcmp(fv.description, "top_frame_sp") == 0 ||
1654               strcmp(fv.description, "esp") == 0 || strcmp(fv.description, "monitors") == 0 ||
1655               strcmp(fv.description, "locals") == 0 || strstr(fv.description, " method "))
1656 #endif //!defined(PPC64)
1657           ) {
1658         st->print_cr(" " INTPTR_FORMAT ": %18d %s", p2i(fv.location), (int)*fv.location, fv.description);
1659       } else {
1660         st->print_cr(" " INTPTR_FORMAT ": " INTPTR_FORMAT " %s", p2i(fv.location), *fv.location, fv.description);
1661       }
1662       last = fv.location;
1663       cur--;
1664     }
1665   }
1666 }
1667 
1668 #endif // ndef PRODUCT