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