1 /*
   2  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
   3  * Copyright (c) 2014, Red Hat Inc. All rights reserved.
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This code is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License version 2 only, as
   8  * published by the Free Software Foundation.
   9  *
  10  * This code is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * version 2 for more details (a copy is included in the LICENSE file that
  14  * accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License version
  17  * 2 along with this work; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  19  *
  20  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  21  * or visit www.oracle.com if you need additional information or have any
  22  * questions.
  23  *
  24  */
  25 
  26 #include "precompiled.hpp"
  27 #include "interpreter/interpreter.hpp"
  28 #include "memory/resourceArea.hpp"
  29 #include "oops/markOop.hpp"
  30 #include "oops/method.hpp"
  31 #include "oops/oop.inline.hpp"
  32 #include "prims/methodHandles.hpp"
  33 #include "runtime/frame.inline.hpp"
  34 #include "runtime/handles.inline.hpp"
  35 #include "runtime/javaCalls.hpp"
  36 #include "runtime/monitorChunk.hpp"
  37 #include "runtime/os.hpp"
  38 #include "runtime/signature.hpp"
  39 #include "runtime/stubCodeGenerator.hpp"
  40 #include "runtime/stubRoutines.hpp"
  41 #include "vmreg_aarch64.inline.hpp"
  42 #ifdef COMPILER1
  43 #include "c1/c1_Runtime1.hpp"
  44 #include "runtime/vframeArray.hpp"
  45 #endif
  46 
  47 #ifdef ASSERT
  48 void RegisterMap::check_location_valid() {
  49 }
  50 #endif
  51 
  52 
  53 // Profiling/safepoint support
  54 
  55 bool frame::safe_for_sender(JavaThread *thread) {
  56   address   sp = (address)_sp;
  57   address   fp = (address)_fp;
  58   address   unextended_sp = (address)_unextended_sp;
  59 
  60   // consider stack guards when trying to determine "safe" stack pointers
  61   static size_t stack_guard_size = os::uses_stack_guard_pages() ? (StackYellowPages + StackRedPages) * os::vm_page_size() : 0;
  62   size_t usable_stack_size = thread->stack_size() - stack_guard_size;
  63 
  64   // sp must be within the usable part of the stack (not in guards)
  65   bool sp_safe = (sp < thread->stack_base()) &&
  66                  (sp >= thread->stack_base() - usable_stack_size);
  67 
  68 
  69   if (!sp_safe) {
  70     return false;
  71   }
  72 
  73   // unextended sp must be within the stack and above or equal sp
  74   bool unextended_sp_safe = (unextended_sp < thread->stack_base()) &&
  75                             (unextended_sp >= sp);
  76 
  77   if (!unextended_sp_safe) {
  78     return false;
  79   }
  80 
  81   // an fp must be within the stack and above (but not equal) sp
  82   // second evaluation on fp+ is added to handle situation where fp is -1
  83   bool fp_safe = (fp < thread->stack_base() && (fp > sp) && (((fp + (return_addr_offset * sizeof(void*))) < thread->stack_base())));
  84 
  85   // We know sp/unextended_sp are safe only fp is questionable here
  86 
  87   // If the current frame is known to the code cache then we can attempt to
  88   // to construct the sender and do some validation of it. This goes a long way
  89   // toward eliminating issues when we get in frame construction code
  90 
  91   if (_cb != NULL ) {
  92 
  93     // First check if frame is complete and tester is reliable
  94     // Unfortunately we can only check frame complete for runtime stubs and nmethod
  95     // other generic buffer blobs are more problematic so we just assume they are
  96     // ok. adapter blobs never have a frame complete and are never ok.
  97 
  98     if (!_cb->is_frame_complete_at(_pc)) {
  99       if (_cb->is_nmethod() || _cb->is_adapter_blob() || _cb->is_runtime_stub()) {
 100         return false;
 101       }
 102     }
 103 
 104     // Could just be some random pointer within the codeBlob
 105     if (!_cb->code_contains(_pc)) {
 106       return false;
 107     }
 108 
 109     // Entry frame checks
 110     if (is_entry_frame()) {
 111       // an entry frame must have a valid fp.
 112 
 113       if (!fp_safe) return false;
 114 
 115       // Validate the JavaCallWrapper an entry frame must have
 116 
 117       address jcw = (address)entry_frame_call_wrapper();
 118 
 119       bool jcw_safe = (jcw < thread->stack_base()) && ( jcw > fp);
 120 
 121       return jcw_safe;
 122 
 123     }
 124 
 125     intptr_t* sender_sp = NULL;
 126     intptr_t* sender_unextended_sp = NULL;
 127     address   sender_pc = NULL;
 128     intptr_t* saved_fp =  NULL;
 129 
 130     if (is_interpreted_frame()) {
 131       // fp must be safe
 132       if (!fp_safe) {
 133         return false;
 134       }
 135 
 136       sender_pc = (address) this->fp()[return_addr_offset];
 137       // for interpreted frames, the value below is the sender "raw" sp,
 138       // which can be different from the sender unextended sp (the sp seen
 139       // by the sender) because of current frame local variables
 140       sender_sp = (intptr_t*) addr_at(sender_sp_offset);
 141       sender_unextended_sp = (intptr_t*) this->fp()[interpreter_frame_sender_sp_offset];
 142       saved_fp = (intptr_t*) this->fp()[link_offset];
 143 
 144     } else {
 145       // must be some sort of compiled/runtime frame
 146       // fp does not have to be safe (although it could be check for c1?)
 147 
 148       // check for a valid frame_size, otherwise we are unlikely to get a valid sender_pc
 149       if (_cb->frame_size() <= 0) {
 150         return false;
 151       }
 152 
 153       sender_sp = _unextended_sp + _cb->frame_size();
 154       sender_unextended_sp = sender_sp;
 155       sender_pc = (address) *(sender_sp-1);
 156       // Note: frame::sender_sp_offset is only valid for compiled frame
 157       saved_fp = (intptr_t*) *(sender_sp - frame::sender_sp_offset);
 158     }
 159 
 160 
 161     // If the potential sender is the interpreter then we can do some more checking
 162     if (Interpreter::contains(sender_pc)) {
 163 
 164       // fp is always saved in a recognizable place in any code we generate. However
 165       // only if the sender is interpreted/call_stub (c1 too?) are we certain that the saved fp
 166       // is really a frame pointer.
 167 
 168       bool saved_fp_safe = ((address)saved_fp < thread->stack_base()) && (saved_fp > sender_sp);
 169 
 170       if (!saved_fp_safe) {
 171         return false;
 172       }
 173 
 174       // construct the potential sender
 175 
 176       frame sender(sender_sp, sender_unextended_sp, saved_fp, sender_pc);
 177 
 178       return sender.is_interpreted_frame_valid(thread);
 179 
 180     }
 181 
 182     // We must always be able to find a recognizable pc
 183     CodeBlob* sender_blob = CodeCache::find_blob_unsafe(sender_pc);
 184     if (sender_pc == NULL ||  sender_blob == NULL) {
 185       return false;
 186     }
 187 
 188     // Could be a zombie method
 189     if (sender_blob->is_zombie() || sender_blob->is_unloaded()) {
 190       return false;
 191     }
 192 
 193     // Could just be some random pointer within the codeBlob
 194     if (!sender_blob->code_contains(sender_pc)) {
 195       return false;
 196     }
 197 
 198     // We should never be able to see an adapter if the current frame is something from code cache
 199     if (sender_blob->is_adapter_blob()) {
 200       return false;
 201     }
 202 
 203     // Could be the call_stub
 204     if (StubRoutines::returns_to_call_stub(sender_pc)) {
 205       bool saved_fp_safe = ((address)saved_fp < thread->stack_base()) && (saved_fp > sender_sp);
 206 
 207       if (!saved_fp_safe) {
 208         return false;
 209       }
 210 
 211       // construct the potential sender
 212 
 213       frame sender(sender_sp, sender_unextended_sp, saved_fp, sender_pc);
 214 
 215       // Validate the JavaCallWrapper an entry frame must have
 216       address jcw = (address)sender.entry_frame_call_wrapper();
 217 
 218       bool jcw_safe = (jcw < thread->stack_base()) && ( jcw > (address)sender.fp());
 219 
 220       return jcw_safe;
 221     }
 222 
 223     if (sender_blob->is_nmethod()) {
 224         nmethod* nm = sender_blob->as_nmethod_or_null();
 225         if (nm != NULL) {
 226             if (nm->is_deopt_mh_entry(sender_pc) || nm->is_deopt_entry(sender_pc)) {
 227                 return false;
 228             }
 229         }
 230     }
 231 
 232     // If the frame size is 0 something (or less) is bad because every nmethod has a non-zero frame size
 233     // because the return address counts against the callee's frame.
 234 
 235     if (sender_blob->frame_size() <= 0) {
 236       assert(!sender_blob->is_nmethod(), "should count return address at least");
 237       return false;
 238     }
 239 
 240     // We should never be able to see anything here except an nmethod. If something in the
 241     // code cache (current frame) is called by an entity within the code cache that entity
 242     // should not be anything but the call stub (already covered), the interpreter (already covered)
 243     // or an nmethod.
 244 
 245     if (!sender_blob->is_nmethod()) {
 246         return false;
 247     }
 248 
 249     // Could put some more validation for the potential non-interpreted sender
 250     // frame we'd create by calling sender if I could think of any. Wait for next crash in forte...
 251 
 252     // One idea is seeing if the sender_pc we have is one that we'd expect to call to current cb
 253 
 254     // We've validated the potential sender that would be created
 255     return true;
 256   }
 257 
 258   // Must be native-compiled frame. Since sender will try and use fp to find
 259   // linkages it must be safe
 260 
 261   if (!fp_safe) {
 262     return false;
 263   }
 264 
 265   // Will the pc we fetch be non-zero (which we'll find at the oldest frame)
 266 
 267   if ( (address) this->fp()[return_addr_offset] == NULL) return false;
 268 
 269 
 270   // could try and do some more potential verification of native frame if we could think of some...
 271 
 272   return true;
 273 
 274 }
 275 
 276 void frame::patch_pc(Thread* thread, address pc) {
 277   address* pc_addr = &(((address*) sp())[-1]);
 278   if (TracePcPatching) {
 279     tty->print_cr("patch_pc at address " INTPTR_FORMAT " [" INTPTR_FORMAT " -> " INTPTR_FORMAT "]",
 280                   p2i(pc_addr), p2i(*pc_addr), p2i(pc));
 281   }
 282   // Either the return address is the original one or we are going to
 283   // patch in the same address that's already there.
 284   assert(_pc == *pc_addr || pc == *pc_addr, "must be");
 285   *pc_addr = pc;
 286   _cb = CodeCache::find_blob(pc);
 287   address original_pc = nmethod::get_deopt_original_pc(this);
 288   if (original_pc != NULL) {
 289     assert(original_pc == _pc, "expected original PC to be stored before patching");
 290     _deopt_state = is_deoptimized;
 291     // leave _pc as is
 292   } else {
 293     _deopt_state = not_deoptimized;
 294     _pc = pc;
 295   }
 296 }
 297 
 298 bool frame::is_interpreted_frame() const  {
 299   return Interpreter::contains(pc());
 300 }
 301 
 302 int frame::frame_size(RegisterMap* map) const {
 303   frame sender = this->sender(map);
 304   return sender.sp() - sp();
 305 }
 306 
 307 intptr_t* frame::entry_frame_argument_at(int offset) const {
 308   // convert offset to index to deal with tsi
 309   int index = (Interpreter::expr_offset_in_bytes(offset)/wordSize);
 310   // Entry frame's arguments are always in relation to unextended_sp()
 311   return &unextended_sp()[index];
 312 }
 313 
 314 // sender_sp
 315 #ifdef CC_INTERP
 316 intptr_t* frame::interpreter_frame_sender_sp() const {
 317   assert(is_interpreted_frame(), "interpreted frame expected");
 318   // QQQ why does this specialize method exist if frame::sender_sp() does same thing?
 319   // seems odd and if we always know interpreted vs. non then sender_sp() is really
 320   // doing too much work.
 321   return get_interpreterState()->sender_sp();
 322 }
 323 
 324 // monitor elements
 325 
 326 BasicObjectLock* frame::interpreter_frame_monitor_begin() const {
 327   return get_interpreterState()->monitor_base();
 328 }
 329 
 330 BasicObjectLock* frame::interpreter_frame_monitor_end() const {
 331   return (BasicObjectLock*) get_interpreterState()->stack_base();
 332 }
 333 
 334 #else // CC_INTERP
 335 
 336 intptr_t* frame::interpreter_frame_sender_sp() const {
 337   assert(is_interpreted_frame(), "interpreted frame expected");
 338   return (intptr_t*) at(interpreter_frame_sender_sp_offset);
 339 }
 340 
 341 void frame::set_interpreter_frame_sender_sp(intptr_t* sender_sp) {
 342   assert(is_interpreted_frame(), "interpreted frame expected");
 343   ptr_at_put(interpreter_frame_sender_sp_offset, (intptr_t) sender_sp);
 344 }
 345 
 346 
 347 // monitor elements
 348 
 349 BasicObjectLock* frame::interpreter_frame_monitor_begin() const {
 350   return (BasicObjectLock*) addr_at(interpreter_frame_monitor_block_bottom_offset);
 351 }
 352 
 353 BasicObjectLock* frame::interpreter_frame_monitor_end() const {
 354   BasicObjectLock* result = (BasicObjectLock*) *addr_at(interpreter_frame_monitor_block_top_offset);
 355   // make sure the pointer points inside the frame
 356   assert(sp() <= (intptr_t*) result, "monitor end should be above the stack pointer");
 357   assert((intptr_t*) result < fp(),  "monitor end should be strictly below the frame pointer");
 358   return result;
 359 }
 360 
 361 void frame::interpreter_frame_set_monitor_end(BasicObjectLock* value) {
 362   *((BasicObjectLock**)addr_at(interpreter_frame_monitor_block_top_offset)) = value;
 363 }
 364 
 365 // Used by template based interpreter deoptimization
 366 void frame::interpreter_frame_set_last_sp(intptr_t* sp) {
 367     *((intptr_t**)addr_at(interpreter_frame_last_sp_offset)) = sp;
 368 }
 369 #endif // CC_INTERP
 370 
 371 frame frame::sender_for_entry_frame(RegisterMap* map) const {
 372   assert(map != NULL, "map must be set");
 373   // Java frame called from C; skip all C frames and return top C
 374   // frame of that chunk as the sender
 375   JavaFrameAnchor* jfa = entry_frame_call_wrapper()->anchor();
 376   assert(!entry_frame_is_first(), "next Java fp must be non zero");
 377   assert(jfa->last_Java_sp() > sp(), "must be above this frame on stack");
 378   map->clear();
 379   assert(map->include_argument_oops(), "should be set by clear");
 380   if (jfa->last_Java_pc() != NULL ) {
 381     frame fr(jfa->last_Java_sp(), jfa->last_Java_fp(), jfa->last_Java_pc());
 382     return fr;
 383   }
 384   frame fr(jfa->last_Java_sp(), jfa->last_Java_fp());
 385   return fr;
 386 }
 387 
 388 //------------------------------------------------------------------------------
 389 // frame::verify_deopt_original_pc
 390 //
 391 // Verifies the calculated original PC of a deoptimization PC for the
 392 // given unextended SP.  The unextended SP might also be the saved SP
 393 // for MethodHandle call sites.
 394 #ifdef ASSERT
 395 void frame::verify_deopt_original_pc(nmethod* nm, intptr_t* unextended_sp, bool is_method_handle_return) {
 396   frame fr;
 397 
 398   // This is ugly but it's better than to change {get,set}_original_pc
 399   // to take an SP value as argument.  And it's only a debugging
 400   // method anyway.
 401   fr._unextended_sp = unextended_sp;
 402 
 403   address original_pc = nm->get_original_pc(&fr);
 404   assert(nm->insts_contains(original_pc), "original PC must be in nmethod");
 405   assert(nm->is_method_handle_return(original_pc) == is_method_handle_return, "must be");
 406 }
 407 #endif
 408 
 409 //------------------------------------------------------------------------------
 410 // frame::adjust_unextended_sp
 411 void frame::adjust_unextended_sp() {
 412   // If we are returning to a compiled MethodHandle call site, the
 413   // saved_fp will in fact be a saved value of the unextended SP.  The
 414   // simplest way to tell whether we are returning to such a call site
 415   // is as follows:
 416 
 417   nmethod* sender_nm = (_cb == NULL) ? NULL : _cb->as_nmethod_or_null();
 418   if (sender_nm != NULL) {
 419     // If the sender PC is a deoptimization point, get the original
 420     // PC.  For MethodHandle call site the unextended_sp is stored in
 421     // saved_fp.
 422     if (sender_nm->is_deopt_mh_entry(_pc)) {
 423       DEBUG_ONLY(verify_deopt_mh_original_pc(sender_nm, _fp));
 424       _unextended_sp = _fp;
 425     }
 426     else if (sender_nm->is_deopt_entry(_pc)) {
 427       DEBUG_ONLY(verify_deopt_original_pc(sender_nm, _unextended_sp));
 428     }
 429     else if (sender_nm->is_method_handle_return(_pc)) {
 430       _unextended_sp = _fp;
 431     }
 432   }
 433 }
 434 
 435 //------------------------------------------------------------------------------
 436 // frame::update_map_with_saved_link
 437 void frame::update_map_with_saved_link(RegisterMap* map, intptr_t** link_addr) {
 438   // The interpreter and compiler(s) always save fp in a known
 439   // location on entry. We must record where that location is
 440   // so that if fp was live on callout from c2 we can find
 441   // the saved copy no matter what it called.
 442 
 443   // Since the interpreter always saves fp if we record where it is then
 444   // we don't have to always save fp on entry and exit to c2 compiled
 445   // code, on entry will be enough.
 446   map->set_location(rfp->as_VMReg(), (address) link_addr);
 447   // this is weird "H" ought to be at a higher address however the
 448   // oopMaps seems to have the "H" regs at the same address and the
 449   // vanilla register.
 450   // XXXX make this go away
 451   if (true) {
 452     map->set_location(rfp->as_VMReg()->next(), (address) link_addr);
 453   }
 454 }
 455 
 456 
 457 //------------------------------------------------------------------------------
 458 // frame::sender_for_interpreter_frame
 459 frame frame::sender_for_interpreter_frame(RegisterMap* map) const {
 460   // SP is the raw SP from the sender after adapter or interpreter
 461   // extension.
 462   intptr_t* sender_sp = this->sender_sp();
 463 
 464   // This is the sp before any possible extension (adapter/locals).
 465   intptr_t* unextended_sp = interpreter_frame_sender_sp();
 466 
 467 #ifdef COMPILER2
 468   if (map->update_map()) {
 469     update_map_with_saved_link(map, (intptr_t**) addr_at(link_offset));
 470   }
 471 #endif // COMPILER2
 472 
 473   return frame(sender_sp, unextended_sp, link(), sender_pc());
 474 }
 475 
 476 
 477 //------------------------------------------------------------------------------
 478 // frame::sender_for_compiled_frame
 479 frame frame::sender_for_compiled_frame(RegisterMap* map) const {
 480   // we cannot rely upon the last fp having been saved to the thread
 481   // in C2 code but it will have been pushed onto the stack. so we
 482   // have to find it relative to the unextended sp
 483 
 484   assert(_cb->frame_size() >= 0, "must have non-zero frame size");
 485   intptr_t* l_sender_sp = unextended_sp() + _cb->frame_size();
 486   intptr_t* unextended_sp = l_sender_sp;
 487 
 488   // the return_address is always the word on the stack
 489   address sender_pc = (address) *(l_sender_sp-1);
 490 
 491   intptr_t** saved_fp_addr = (intptr_t**) (l_sender_sp - frame::sender_sp_offset);
 492 
 493   // assert (sender_sp() == l_sender_sp, "should be");
 494   // assert (*saved_fp_addr == link(), "should be");
 495 
 496   if (map->update_map()) {
 497     // Tell GC to use argument oopmaps for some runtime stubs that need it.
 498     // For C1, the runtime stub might not have oop maps, so set this flag
 499     // outside of update_register_map.
 500     map->set_include_argument_oops(_cb->caller_must_gc_arguments(map->thread()));
 501     if (_cb->oop_maps() != NULL) {
 502       OopMapSet::update_register_map(this, map);
 503     }
 504 
 505     // Since the prolog does the save and restore of FP there is no
 506     // oopmap for it so we must fill in its location as if there was
 507     // an oopmap entry since if our caller was compiled code there
 508     // could be live jvm state in it.
 509     update_map_with_saved_link(map, saved_fp_addr);
 510   }
 511 
 512   return frame(l_sender_sp, unextended_sp, *saved_fp_addr, sender_pc);
 513 }
 514 
 515 //------------------------------------------------------------------------------
 516 // frame::sender
 517 frame frame::sender(RegisterMap* map) const {
 518   // Default is we done have to follow them. The sender_for_xxx will
 519   // update it accordingly
 520    map->set_include_argument_oops(false);
 521 
 522   if (is_entry_frame())
 523     return sender_for_entry_frame(map);
 524   if (is_interpreted_frame())
 525     return sender_for_interpreter_frame(map);
 526   assert(_cb == CodeCache::find_blob(pc()),"Must be the same");
 527 
 528   // This test looks odd: why is it not is_compiled_frame() ?  That's
 529   // because stubs also have OOP maps.
 530   if (_cb != NULL) {
 531     return sender_for_compiled_frame(map);
 532   }
 533 
 534   // Must be native-compiled frame, i.e. the marshaling code for native
 535   // methods that exists in the core system.
 536   return frame(sender_sp(), link(), sender_pc());
 537 }
 538 
 539 bool frame::interpreter_frame_equals_unpacked_fp(intptr_t* fp) {
 540   assert(is_interpreted_frame(), "must be interpreter frame");
 541   Method* method = interpreter_frame_method();
 542   // When unpacking an optimized frame the frame pointer is
 543   // adjusted with:
 544   int diff = (method->max_locals() - method->size_of_parameters()) *
 545              Interpreter::stackElementWords;
 546   return _fp == (fp - diff);
 547 }
 548 
 549 bool frame::is_interpreted_frame_valid(JavaThread* thread) const {
 550 // QQQ
 551 #ifdef CC_INTERP
 552 #else
 553   assert(is_interpreted_frame(), "Not an interpreted frame");
 554   // These are reasonable sanity checks
 555   if (fp() == 0 || (intptr_t(fp()) & (wordSize-1)) != 0) {
 556     return false;
 557   }
 558   if (sp() == 0 || (intptr_t(sp()) & (wordSize-1)) != 0) {
 559     return false;
 560   }
 561   if (fp() + interpreter_frame_initial_sp_offset < sp()) {
 562     return false;
 563   }
 564   // These are hacks to keep us out of trouble.
 565   // The problem with these is that they mask other problems
 566   if (fp() <= sp()) {        // this attempts to deal with unsigned comparison above
 567     return false;
 568   }
 569 
 570   // do some validation of frame elements
 571 
 572   // first the method
 573 
 574   Method* m = *interpreter_frame_method_addr();
 575 
 576   // validate the method we'd find in this potential sender
 577   if (!m->is_valid_method()) return false;
 578 
 579   // stack frames shouldn't be much larger than max_stack elements
 580   // this test requires the use of unextended_sp which is the sp as seen by
 581   // the current frame, and not sp which is the "raw" pc which could point
 582   // further because of local variables of the callee method inserted after
 583   // method arguments
 584   if (fp() - unextended_sp() > 1024 + m->max_stack()*Interpreter::stackElementSize) {
 585     return false;
 586   }
 587 
 588   // validate bci/bcx
 589 
 590   address  bcp    = interpreter_frame_bcp();
 591   if (m->validate_bci_from_bcp(bcp) < 0) {
 592     return false;
 593   }
 594 
 595   // validate constantPoolCache*
 596   ConstantPoolCache* cp = *interpreter_frame_cache_addr();
 597   if (cp == NULL || !cp->is_metaspace_object()) return false;
 598 
 599   // validate locals
 600 
 601   address locals =  (address) *interpreter_frame_locals_addr();
 602 
 603   if (locals > thread->stack_base() || locals < (address) fp()) return false;
 604 
 605   // We'd have to be pretty unlucky to be mislead at this point
 606 
 607 #endif // CC_INTERP
 608   return true;
 609 }
 610 
 611 BasicType frame::interpreter_frame_result(oop* oop_result, jvalue* value_result) {
 612 #ifdef CC_INTERP
 613   // Needed for JVMTI. The result should always be in the
 614   // interpreterState object
 615   interpreterState istate = get_interpreterState();
 616 #endif // CC_INTERP
 617   assert(is_interpreted_frame(), "interpreted frame expected");
 618   Method* method = interpreter_frame_method();
 619   BasicType type = method->result_type();
 620 
 621   intptr_t* tos_addr;
 622   if (method->is_native()) {
 623     // TODO : ensure AARCH64 does the same as Intel here i.e. push v0 then r0
 624     // Prior to calling into the runtime to report the method_exit the possible
 625     // return value is pushed to the native stack. If the result is a jfloat/jdouble
 626     // then ST0 is saved before EAX/EDX. See the note in generate_native_result
 627     tos_addr = (intptr_t*)sp();
 628     if (type == T_FLOAT || type == T_DOUBLE) {
 629       // This is times two because we do a push(ltos) after pushing XMM0
 630       // and that takes two interpreter stack slots.
 631       tos_addr += 2 * Interpreter::stackElementWords;
 632     }
 633   } else {
 634     tos_addr = (intptr_t*)interpreter_frame_tos_address();
 635   }
 636 
 637   switch (type) {
 638     case T_OBJECT  :
 639     case T_ARRAY   : {
 640       oop obj;
 641       if (method->is_native()) {
 642 #ifdef CC_INTERP
 643         obj = istate->_oop_temp;
 644 #else
 645         obj = cast_to_oop(at(interpreter_frame_oop_temp_offset));
 646 #endif // CC_INTERP
 647       } else {
 648         oop* obj_p = (oop*)tos_addr;
 649         obj = (obj_p == NULL) ? (oop)NULL : *obj_p;
 650       }
 651       assert(obj == NULL || Universe::heap()->is_in(obj), "sanity check");
 652       *oop_result = obj;
 653       break;
 654     }
 655     case T_BOOLEAN : value_result->z = *(jboolean*)tos_addr; break;
 656     case T_BYTE    : value_result->b = *(jbyte*)tos_addr; break;
 657     case T_CHAR    : value_result->c = *(jchar*)tos_addr; break;
 658     case T_SHORT   : value_result->s = *(jshort*)tos_addr; break;
 659     case T_INT     : value_result->i = *(jint*)tos_addr; break;
 660     case T_LONG    : value_result->j = *(jlong*)tos_addr; break;
 661     case T_FLOAT   : {
 662         value_result->f = *(jfloat*)tos_addr;
 663       break;
 664     }
 665     case T_DOUBLE  : value_result->d = *(jdouble*)tos_addr; break;
 666     case T_VOID    : /* Nothing to do */ break;
 667     default        : ShouldNotReachHere();
 668   }
 669 
 670   return type;
 671 }
 672 
 673 
 674 intptr_t* frame::interpreter_frame_tos_at(jint offset) const {
 675   int index = (Interpreter::expr_offset_in_bytes(offset)/wordSize);
 676   return &interpreter_frame_tos_address()[index];
 677 }
 678 
 679 #ifndef PRODUCT
 680 
 681 #define DESCRIBE_FP_OFFSET(name) \
 682   values.describe(frame_no, fp() + frame::name##_offset, #name)
 683 
 684 void frame::describe_pd(FrameValues& values, int frame_no) {
 685   if (is_interpreted_frame()) {
 686     DESCRIBE_FP_OFFSET(interpreter_frame_sender_sp);
 687     DESCRIBE_FP_OFFSET(interpreter_frame_last_sp);
 688     DESCRIBE_FP_OFFSET(interpreter_frame_method);
 689     DESCRIBE_FP_OFFSET(interpreter_frame_mdp);
 690     DESCRIBE_FP_OFFSET(interpreter_frame_cache);
 691     DESCRIBE_FP_OFFSET(interpreter_frame_locals);
 692     DESCRIBE_FP_OFFSET(interpreter_frame_bcp);
 693     DESCRIBE_FP_OFFSET(interpreter_frame_initial_sp);
 694   }
 695 }
 696 #endif
 697 
 698 intptr_t *frame::initial_deoptimization_info() {
 699   // Not used on aarch64, but we must return something.
 700   return NULL;
 701 }
 702 
 703 intptr_t* frame::real_fp() const {
 704   if (_cb != NULL) {
 705     // use the frame size if valid
 706     int size = _cb->frame_size();
 707     if (size > 0) {
 708       return unextended_sp() + size;
 709     }
 710   }
 711   // else rely on fp()
 712   assert(! is_compiled_frame(), "unknown compiled frame size");
 713   return fp();
 714 }
 715 
 716 #undef DESCRIBE_FP_OFFSET
 717 
 718 #define DESCRIBE_FP_OFFSET(name)                                        \
 719   {                                                                     \
 720     unsigned long *p = (unsigned long *)fp;                             \
 721     printf("0x%016lx 0x%016lx %s\n", (unsigned long)(p + frame::name##_offset), \
 722            p[frame::name##_offset], #name);                             \
 723   }
 724 
 725 static __thread unsigned long nextfp;
 726 static __thread unsigned long nextpc;
 727 static __thread unsigned long nextsp;
 728 static __thread RegisterMap *reg_map;
 729 
 730 static void printbc(Method *m, intptr_t bcx) {
 731   const char *name;
 732   char buf[16];
 733   if (m->validate_bci_from_bcp((address)bcx) < 0
 734       || !m->contains((address)bcx)) {
 735     name = "???";
 736     snprintf(buf, sizeof buf, "(bad)");
 737   } else {
 738     int bci = m->bci_from((address)bcx);
 739     snprintf(buf, sizeof buf, "%d", bci);
 740     name = Bytecodes::name(m->code_at(bci));
 741   }
 742   ResourceMark rm;
 743   printf("%s : %s ==> %s\n", m->name_and_sig_as_C_string(), buf, name);
 744 }
 745 
 746 void internal_pf(unsigned long sp, unsigned long fp, unsigned long pc, unsigned long bcx) {
 747   if (! fp)
 748     return;
 749 
 750   DESCRIBE_FP_OFFSET(return_addr);
 751   DESCRIBE_FP_OFFSET(link);
 752   DESCRIBE_FP_OFFSET(interpreter_frame_sender_sp);
 753   DESCRIBE_FP_OFFSET(interpreter_frame_last_sp);
 754   DESCRIBE_FP_OFFSET(interpreter_frame_method);
 755   DESCRIBE_FP_OFFSET(interpreter_frame_mdp);
 756   DESCRIBE_FP_OFFSET(interpreter_frame_cache);
 757   DESCRIBE_FP_OFFSET(interpreter_frame_locals);
 758   DESCRIBE_FP_OFFSET(interpreter_frame_bcp);
 759   DESCRIBE_FP_OFFSET(interpreter_frame_initial_sp);
 760   unsigned long *p = (unsigned long *)fp;
 761 
 762   // We want to see all frames, native and Java.  For compiled and
 763   // interpreted frames we have special information that allows us to
 764   // unwind them; for everything else we assume that the native frame
 765   // pointer chain is intact.
 766   frame this_frame((intptr_t*)sp, (intptr_t*)fp, (address)pc);
 767   if (this_frame.is_compiled_frame() ||
 768       this_frame.is_interpreted_frame()) {
 769     frame sender = this_frame.sender(reg_map);
 770     nextfp = (unsigned long)sender.fp();
 771     nextpc = (unsigned long)sender.pc();
 772     nextsp = (unsigned long)sender.unextended_sp();
 773   } else {
 774     nextfp = p[frame::link_offset];
 775     nextpc = p[frame::return_addr_offset];
 776     nextsp = (unsigned long)&p[frame::sender_sp_offset];
 777   }
 778 
 779   if (bcx == -1ul)
 780     bcx = p[frame::interpreter_frame_bcp_offset];
 781 
 782   if (Interpreter::contains((address)pc)) {
 783     Method* m = (Method*)p[frame::interpreter_frame_method_offset];
 784     if(m && m->is_method()) {
 785       printbc(m, bcx);
 786     } else
 787       printf("not a Method\n");
 788   } else {
 789     CodeBlob *cb = CodeCache::find_blob((address)pc);
 790     if (cb != NULL) {
 791       if (cb->is_nmethod()) {
 792         ResourceMark rm;
 793         nmethod* nm = (nmethod*)cb;
 794         printf("nmethod %s\n", nm->method()->name_and_sig_as_C_string());
 795       } else if (cb->name()) {
 796         printf("CodeBlob %s\n", cb->name());
 797       }
 798     }
 799   }
 800 }
 801 
 802 extern "C" void npf() {
 803   CodeBlob *cb = CodeCache::find_blob((address)nextpc);
 804   // C2 does not always chain the frame pointers when it can, instead
 805   // preferring to use fixed offsets from SP, so a simple leave() does
 806   // not work.  Instead, it adds the frame size to SP then pops FP and
 807   // LR.  We have to do the same thing to get a good call chain.
 808   if (cb && cb->frame_size())
 809     nextfp = nextsp + wordSize * (cb->frame_size() - 2);
 810   internal_pf (nextsp, nextfp, nextpc, -1);
 811 }
 812 
 813 extern "C" void pf(unsigned long sp, unsigned long fp, unsigned long pc,
 814                    unsigned long bcx, unsigned long thread) {
 815   RegisterMap map((JavaThread*)thread, false);
 816   if (!reg_map) {
 817     reg_map = (RegisterMap*)os::malloc(sizeof map, mtNone);
 818   }
 819   memcpy(reg_map, &map, sizeof map);
 820   {
 821     CodeBlob *cb = CodeCache::find_blob((address)pc);
 822     if (cb && cb->frame_size())
 823       fp = sp + wordSize * (cb->frame_size() - 2);
 824   }
 825   internal_pf(sp, fp, pc, bcx);
 826 }
 827 
 828 // support for printing out where we are in a Java method
 829 // needs to be passed current fp and bcp register values
 830 // prints method name, bc index and bytecode name
 831 extern "C" void pm(unsigned long fp, unsigned long bcx) {
 832   DESCRIBE_FP_OFFSET(interpreter_frame_method);
 833   unsigned long *p = (unsigned long *)fp;
 834   Method* m = (Method*)p[frame::interpreter_frame_method_offset];
 835   printbc(m, bcx);
 836 }
 837 
 838 #ifndef PRODUCT
 839 // This is a generic constructor which is only used by pns() in debug.cpp.
 840 frame::frame(void* sp, void* fp, void* pc) {
 841   init((intptr_t*)sp, (intptr_t*)fp, (address)pc);
 842 }
 843 #endif