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                 nm->method()->is_method_handle_intrinsic()) {
 228                 return false;
 229             }
 230         }
 231     }
 232 
 233     // If the frame size is 0 something (or less) is bad because every nmethod has a non-zero frame size
 234     // because the return address counts against the callee's frame.
 235 
 236     if (sender_blob->frame_size() <= 0) {
 237       assert(!sender_blob->is_nmethod(), "should count return address at least");
 238       return false;
 239     }
 240 
 241     // We should never be able to see anything here except an nmethod. If something in the
 242     // code cache (current frame) is called by an entity within the code cache that entity
 243     // should not be anything but the call stub (already covered), the interpreter (already covered)
 244     // or an nmethod.
 245 
 246     if (!sender_blob->is_nmethod()) {
 247         return false;
 248     }
 249 
 250     // Could put some more validation for the potential non-interpreted sender
 251     // frame we'd create by calling sender if I could think of any. Wait for next crash in forte...
 252 
 253     // One idea is seeing if the sender_pc we have is one that we'd expect to call to current cb
 254 
 255     // We've validated the potential sender that would be created
 256     return true;
 257   }
 258 
 259   // Must be native-compiled frame. Since sender will try and use fp to find
 260   // linkages it must be safe
 261 
 262   if (!fp_safe) {
 263     return false;
 264   }
 265 
 266   // Will the pc we fetch be non-zero (which we'll find at the oldest frame)
 267 
 268   if ( (address) this->fp()[return_addr_offset] == NULL) return false;
 269 
 270 
 271   // could try and do some more potential verification of native frame if we could think of some...
 272 
 273   return true;
 274 
 275 }
 276 
 277 void frame::patch_pc(Thread* thread, address pc) {
 278   address* pc_addr = &(((address*) sp())[-1]);
 279   if (TracePcPatching) {
 280     tty->print_cr("patch_pc at address " INTPTR_FORMAT " [" INTPTR_FORMAT " -> " INTPTR_FORMAT "]",
 281                   p2i(pc_addr), p2i(*pc_addr), p2i(pc));
 282   }
 283   // Either the return address is the original one or we are going to
 284   // patch in the same address that's already there.
 285   assert(_pc == *pc_addr || pc == *pc_addr, "must be");
 286   *pc_addr = pc;
 287   _cb = CodeCache::find_blob(pc);
 288   address original_pc = nmethod::get_deopt_original_pc(this);
 289   if (original_pc != NULL) {
 290     assert(original_pc == _pc, "expected original PC to be stored before patching");
 291     _deopt_state = is_deoptimized;
 292     // leave _pc as is
 293   } else {
 294     _deopt_state = not_deoptimized;
 295     _pc = pc;
 296   }
 297 }
 298 
 299 bool frame::is_interpreted_frame() const  {
 300   return Interpreter::contains(pc());
 301 }
 302 
 303 int frame::frame_size(RegisterMap* map) const {
 304   frame sender = this->sender(map);
 305   return sender.sp() - sp();
 306 }
 307 
 308 intptr_t* frame::entry_frame_argument_at(int offset) const {
 309   // convert offset to index to deal with tsi
 310   int index = (Interpreter::expr_offset_in_bytes(offset)/wordSize);
 311   // Entry frame's arguments are always in relation to unextended_sp()
 312   return &unextended_sp()[index];
 313 }
 314 
 315 // sender_sp
 316 #ifdef CC_INTERP
 317 intptr_t* frame::interpreter_frame_sender_sp() const {
 318   assert(is_interpreted_frame(), "interpreted frame expected");
 319   // QQQ why does this specialize method exist if frame::sender_sp() does same thing?
 320   // seems odd and if we always know interpreted vs. non then sender_sp() is really
 321   // doing too much work.
 322   return get_interpreterState()->sender_sp();
 323 }
 324 
 325 // monitor elements
 326 
 327 BasicObjectLock* frame::interpreter_frame_monitor_begin() const {
 328   return get_interpreterState()->monitor_base();
 329 }
 330 
 331 BasicObjectLock* frame::interpreter_frame_monitor_end() const {
 332   return (BasicObjectLock*) get_interpreterState()->stack_base();
 333 }
 334 
 335 #else // CC_INTERP
 336 
 337 intptr_t* frame::interpreter_frame_sender_sp() const {
 338   assert(is_interpreted_frame(), "interpreted frame expected");
 339   return (intptr_t*) at(interpreter_frame_sender_sp_offset);
 340 }
 341 
 342 void frame::set_interpreter_frame_sender_sp(intptr_t* sender_sp) {
 343   assert(is_interpreted_frame(), "interpreted frame expected");
 344   ptr_at_put(interpreter_frame_sender_sp_offset, (intptr_t) sender_sp);
 345 }
 346 
 347 
 348 // monitor elements
 349 
 350 BasicObjectLock* frame::interpreter_frame_monitor_begin() const {
 351   return (BasicObjectLock*) addr_at(interpreter_frame_monitor_block_bottom_offset);
 352 }
 353 
 354 BasicObjectLock* frame::interpreter_frame_monitor_end() const {
 355   BasicObjectLock* result = (BasicObjectLock*) *addr_at(interpreter_frame_monitor_block_top_offset);
 356   // make sure the pointer points inside the frame
 357   assert(sp() <= (intptr_t*) result, "monitor end should be above the stack pointer");
 358   assert((intptr_t*) result < fp(),  "monitor end should be strictly below the frame pointer");
 359   return result;
 360 }
 361 
 362 void frame::interpreter_frame_set_monitor_end(BasicObjectLock* value) {
 363   *((BasicObjectLock**)addr_at(interpreter_frame_monitor_block_top_offset)) = value;
 364 }
 365 
 366 // Used by template based interpreter deoptimization
 367 void frame::interpreter_frame_set_last_sp(intptr_t* sp) {
 368     *((intptr_t**)addr_at(interpreter_frame_last_sp_offset)) = sp;
 369 }
 370 #endif // CC_INTERP
 371 
 372 frame frame::sender_for_entry_frame(RegisterMap* map) const {
 373   assert(map != NULL, "map must be set");
 374   // Java frame called from C; skip all C frames and return top C
 375   // frame of that chunk as the sender
 376   JavaFrameAnchor* jfa = entry_frame_call_wrapper()->anchor();
 377   assert(!entry_frame_is_first(), "next Java fp must be non zero");
 378   assert(jfa->last_Java_sp() > sp(), "must be above this frame on stack");
 379   map->clear();
 380   assert(map->include_argument_oops(), "should be set by clear");
 381   if (jfa->last_Java_pc() != NULL ) {
 382     frame fr(jfa->last_Java_sp(), jfa->last_Java_fp(), jfa->last_Java_pc());
 383     return fr;
 384   }
 385   frame fr(jfa->last_Java_sp(), jfa->last_Java_fp());
 386   return fr;
 387 }
 388 
 389 //------------------------------------------------------------------------------
 390 // frame::verify_deopt_original_pc
 391 //
 392 // Verifies the calculated original PC of a deoptimization PC for the
 393 // given unextended SP.
 394 #ifdef ASSERT
 395 void frame::verify_deopt_original_pc(nmethod* nm, intptr_t* unextended_sp) {
 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 }
 406 #endif
 407 
 408 //------------------------------------------------------------------------------
 409 // frame::adjust_unextended_sp
 410 void frame::adjust_unextended_sp() {
 411   // On aarch64, sites calling method handle intrinsics and lambda forms are treated
 412   // as any other call site. Therefore, no special action is needed when we are
 413   // returning to any of these call sites.
 414 
 415   nmethod* sender_nm = (_cb == NULL) ? NULL : _cb->as_nmethod_or_null();
 416   if (sender_nm != NULL) {
 417     // If the sender PC is a deoptimization point, get the original PC.
 418     if (sender_nm->is_deopt_entry(_pc) ||
 419         sender_nm->is_deopt_mh_entry(_pc)) {
 420       DEBUG_ONLY(verify_deopt_original_pc(sender_nm, _unextended_sp));
 421     }
 422   }
 423 }
 424 
 425 //------------------------------------------------------------------------------
 426 // frame::update_map_with_saved_link
 427 void frame::update_map_with_saved_link(RegisterMap* map, intptr_t** link_addr) {
 428   // The interpreter and compiler(s) always save fp in a known
 429   // location on entry. We must record where that location is
 430   // so that if fp was live on callout from c2 we can find
 431   // the saved copy no matter what it called.
 432 
 433   // Since the interpreter always saves fp if we record where it is then
 434   // we don't have to always save fp on entry and exit to c2 compiled
 435   // code, on entry will be enough.
 436   map->set_location(rfp->as_VMReg(), (address) link_addr);
 437   // this is weird "H" ought to be at a higher address however the
 438   // oopMaps seems to have the "H" regs at the same address and the
 439   // vanilla register.
 440   // XXXX make this go away
 441   if (true) {
 442     map->set_location(rfp->as_VMReg()->next(), (address) link_addr);
 443   }
 444 }
 445 
 446 
 447 //------------------------------------------------------------------------------
 448 // frame::sender_for_interpreter_frame
 449 frame frame::sender_for_interpreter_frame(RegisterMap* map) const {
 450   // SP is the raw SP from the sender after adapter or interpreter
 451   // extension.
 452   intptr_t* sender_sp = this->sender_sp();
 453 
 454   // This is the sp before any possible extension (adapter/locals).
 455   intptr_t* unextended_sp = interpreter_frame_sender_sp();
 456 
 457 #ifdef COMPILER2
 458   if (map->update_map()) {
 459     update_map_with_saved_link(map, (intptr_t**) addr_at(link_offset));
 460   }
 461 #endif // COMPILER2
 462 
 463   return frame(sender_sp, unextended_sp, link(), sender_pc());
 464 }
 465 
 466 
 467 //------------------------------------------------------------------------------
 468 // frame::sender_for_compiled_frame
 469 frame frame::sender_for_compiled_frame(RegisterMap* map) const {
 470   // we cannot rely upon the last fp having been saved to the thread
 471   // in C2 code but it will have been pushed onto the stack. so we
 472   // have to find it relative to the unextended sp
 473 
 474   assert(_cb->frame_size() >= 0, "must have non-zero frame size");
 475   intptr_t* l_sender_sp = unextended_sp() + _cb->frame_size();
 476   intptr_t* unextended_sp = l_sender_sp;
 477 
 478   // the return_address is always the word on the stack
 479   address sender_pc = (address) *(l_sender_sp-1);
 480 
 481   intptr_t** saved_fp_addr = (intptr_t**) (l_sender_sp - frame::sender_sp_offset);
 482 
 483   // assert (sender_sp() == l_sender_sp, "should be");
 484   // assert (*saved_fp_addr == link(), "should be");
 485 
 486   if (map->update_map()) {
 487     // Tell GC to use argument oopmaps for some runtime stubs that need it.
 488     // For C1, the runtime stub might not have oop maps, so set this flag
 489     // outside of update_register_map.
 490     map->set_include_argument_oops(_cb->caller_must_gc_arguments(map->thread()));
 491     if (_cb->oop_maps() != NULL) {
 492       OopMapSet::update_register_map(this, map);
 493     }
 494 
 495     // Since the prolog does the save and restore of FP there is no
 496     // oopmap for it so we must fill in its location as if there was
 497     // an oopmap entry since if our caller was compiled code there
 498     // could be live jvm state in it.
 499     update_map_with_saved_link(map, saved_fp_addr);
 500   }
 501 
 502   return frame(l_sender_sp, unextended_sp, *saved_fp_addr, sender_pc);
 503 }
 504 
 505 //------------------------------------------------------------------------------
 506 // frame::sender
 507 frame frame::sender(RegisterMap* map) const {
 508   // Default is we done have to follow them. The sender_for_xxx will
 509   // update it accordingly
 510    map->set_include_argument_oops(false);
 511 
 512   if (is_entry_frame())
 513     return sender_for_entry_frame(map);
 514   if (is_interpreted_frame())
 515     return sender_for_interpreter_frame(map);
 516   assert(_cb == CodeCache::find_blob(pc()),"Must be the same");
 517 
 518   // This test looks odd: why is it not is_compiled_frame() ?  That's
 519   // because stubs also have OOP maps.
 520   if (_cb != NULL) {
 521     return sender_for_compiled_frame(map);
 522   }
 523 
 524   // Must be native-compiled frame, i.e. the marshaling code for native
 525   // methods that exists in the core system.
 526   return frame(sender_sp(), link(), sender_pc());
 527 }
 528 
 529 bool frame::interpreter_frame_equals_unpacked_fp(intptr_t* fp) {
 530   assert(is_interpreted_frame(), "must be interpreter frame");
 531   Method* method = interpreter_frame_method();
 532   // When unpacking an optimized frame the frame pointer is
 533   // adjusted with:
 534   int diff = (method->max_locals() - method->size_of_parameters()) *
 535              Interpreter::stackElementWords;
 536   return _fp == (fp - diff);
 537 }
 538 
 539 bool frame::is_interpreted_frame_valid(JavaThread* thread) const {
 540 // QQQ
 541 #ifdef CC_INTERP
 542 #else
 543   assert(is_interpreted_frame(), "Not an interpreted frame");
 544   // These are reasonable sanity checks
 545   if (fp() == 0 || (intptr_t(fp()) & (wordSize-1)) != 0) {
 546     return false;
 547   }
 548   if (sp() == 0 || (intptr_t(sp()) & (wordSize-1)) != 0) {
 549     return false;
 550   }
 551   if (fp() + interpreter_frame_initial_sp_offset < sp()) {
 552     return false;
 553   }
 554   // These are hacks to keep us out of trouble.
 555   // The problem with these is that they mask other problems
 556   if (fp() <= sp()) {        // this attempts to deal with unsigned comparison above
 557     return false;
 558   }
 559 
 560   // do some validation of frame elements
 561 
 562   // first the method
 563 
 564   Method* m = *interpreter_frame_method_addr();
 565 
 566   // validate the method we'd find in this potential sender
 567   if (!m->is_valid_method()) return false;
 568 
 569   // stack frames shouldn't be much larger than max_stack elements
 570   // this test requires the use of unextended_sp which is the sp as seen by
 571   // the current frame, and not sp which is the "raw" pc which could point
 572   // further because of local variables of the callee method inserted after
 573   // method arguments
 574   if (fp() - unextended_sp() > 1024 + m->max_stack()*Interpreter::stackElementSize) {
 575     return false;
 576   }
 577 
 578   // validate bci/bcx
 579 
 580   address  bcp    = interpreter_frame_bcp();
 581   if (m->validate_bci_from_bcp(bcp) < 0) {
 582     return false;
 583   }
 584 
 585   // validate constantPoolCache*
 586   ConstantPoolCache* cp = *interpreter_frame_cache_addr();
 587   if (cp == NULL || !cp->is_metaspace_object()) return false;
 588 
 589   // validate locals
 590 
 591   address locals =  (address) *interpreter_frame_locals_addr();
 592 
 593   if (locals > thread->stack_base() || locals < (address) fp()) return false;
 594 
 595   // We'd have to be pretty unlucky to be mislead at this point
 596 
 597 #endif // CC_INTERP
 598   return true;
 599 }
 600 
 601 BasicType frame::interpreter_frame_result(oop* oop_result, jvalue* value_result) {
 602 #ifdef CC_INTERP
 603   // Needed for JVMTI. The result should always be in the
 604   // interpreterState object
 605   interpreterState istate = get_interpreterState();
 606 #endif // CC_INTERP
 607   assert(is_interpreted_frame(), "interpreted frame expected");
 608   Method* method = interpreter_frame_method();
 609   BasicType type = method->result_type();
 610 
 611   intptr_t* tos_addr;
 612   if (method->is_native()) {
 613     // TODO : ensure AARCH64 does the same as Intel here i.e. push v0 then r0
 614     // Prior to calling into the runtime to report the method_exit the possible
 615     // return value is pushed to the native stack. If the result is a jfloat/jdouble
 616     // then ST0 is saved before EAX/EDX. See the note in generate_native_result
 617     tos_addr = (intptr_t*)sp();
 618     if (type == T_FLOAT || type == T_DOUBLE) {
 619       // This is times two because we do a push(ltos) after pushing XMM0
 620       // and that takes two interpreter stack slots.
 621       tos_addr += 2 * Interpreter::stackElementWords;
 622     }
 623   } else {
 624     tos_addr = (intptr_t*)interpreter_frame_tos_address();
 625   }
 626 
 627   switch (type) {
 628     case T_OBJECT  :
 629     case T_ARRAY   : {
 630       oop obj;
 631       if (method->is_native()) {
 632 #ifdef CC_INTERP
 633         obj = istate->_oop_temp;
 634 #else
 635         obj = cast_to_oop(at(interpreter_frame_oop_temp_offset));
 636 #endif // CC_INTERP
 637       } else {
 638         oop* obj_p = (oop*)tos_addr;
 639         obj = (obj_p == NULL) ? (oop)NULL : *obj_p;
 640       }
 641       assert(obj == NULL || Universe::heap()->is_in(obj), "sanity check");
 642       *oop_result = obj;
 643       break;
 644     }
 645     case T_BOOLEAN : value_result->z = *(jboolean*)tos_addr; break;
 646     case T_BYTE    : value_result->b = *(jbyte*)tos_addr; break;
 647     case T_CHAR    : value_result->c = *(jchar*)tos_addr; break;
 648     case T_SHORT   : value_result->s = *(jshort*)tos_addr; break;
 649     case T_INT     : value_result->i = *(jint*)tos_addr; break;
 650     case T_LONG    : value_result->j = *(jlong*)tos_addr; break;
 651     case T_FLOAT   : {
 652         value_result->f = *(jfloat*)tos_addr;
 653       break;
 654     }
 655     case T_DOUBLE  : value_result->d = *(jdouble*)tos_addr; break;
 656     case T_VOID    : /* Nothing to do */ break;
 657     default        : ShouldNotReachHere();
 658   }
 659 
 660   return type;
 661 }
 662 
 663 
 664 intptr_t* frame::interpreter_frame_tos_at(jint offset) const {
 665   int index = (Interpreter::expr_offset_in_bytes(offset)/wordSize);
 666   return &interpreter_frame_tos_address()[index];
 667 }
 668 
 669 #ifndef PRODUCT
 670 
 671 #define DESCRIBE_FP_OFFSET(name) \
 672   values.describe(frame_no, fp() + frame::name##_offset, #name)
 673 
 674 void frame::describe_pd(FrameValues& values, int frame_no) {
 675   if (is_interpreted_frame()) {
 676     DESCRIBE_FP_OFFSET(interpreter_frame_sender_sp);
 677     DESCRIBE_FP_OFFSET(interpreter_frame_last_sp);
 678     DESCRIBE_FP_OFFSET(interpreter_frame_method);
 679     DESCRIBE_FP_OFFSET(interpreter_frame_mdp);
 680     DESCRIBE_FP_OFFSET(interpreter_frame_cache);
 681     DESCRIBE_FP_OFFSET(interpreter_frame_locals);
 682     DESCRIBE_FP_OFFSET(interpreter_frame_bcp);
 683     DESCRIBE_FP_OFFSET(interpreter_frame_initial_sp);
 684   }
 685 }
 686 #endif
 687 
 688 intptr_t *frame::initial_deoptimization_info() {
 689   // Not used on aarch64, but we must return something.
 690   return NULL;
 691 }
 692 
 693 intptr_t* frame::real_fp() const {
 694   if (_cb != NULL) {
 695     // use the frame size if valid
 696     int size = _cb->frame_size();
 697     if (size > 0) {
 698       return unextended_sp() + size;
 699     }
 700   }
 701   // else rely on fp()
 702   assert(! is_compiled_frame(), "unknown compiled frame size");
 703   return fp();
 704 }
 705 
 706 #undef DESCRIBE_FP_OFFSET
 707 
 708 #define DESCRIBE_FP_OFFSET(name)                                        \
 709   {                                                                     \
 710     unsigned long *p = (unsigned long *)fp;                             \
 711     printf("0x%016lx 0x%016lx %s\n", (unsigned long)(p + frame::name##_offset), \
 712            p[frame::name##_offset], #name);                             \
 713   }
 714 
 715 static __thread unsigned long nextfp;
 716 static __thread unsigned long nextpc;
 717 static __thread unsigned long nextsp;
 718 static __thread RegisterMap *reg_map;
 719 
 720 static void printbc(Method *m, intptr_t bcx) {
 721   const char *name;
 722   char buf[16];
 723   if (m->validate_bci_from_bcp((address)bcx) < 0
 724       || !m->contains((address)bcx)) {
 725     name = "???";
 726     snprintf(buf, sizeof buf, "(bad)");
 727   } else {
 728     int bci = m->bci_from((address)bcx);
 729     snprintf(buf, sizeof buf, "%d", bci);
 730     name = Bytecodes::name(m->code_at(bci));
 731   }
 732   ResourceMark rm;
 733   printf("%s : %s ==> %s\n", m->name_and_sig_as_C_string(), buf, name);
 734 }
 735 
 736 void internal_pf(unsigned long sp, unsigned long fp, unsigned long pc, unsigned long bcx) {
 737   if (! fp)
 738     return;
 739 
 740   DESCRIBE_FP_OFFSET(return_addr);
 741   DESCRIBE_FP_OFFSET(link);
 742   DESCRIBE_FP_OFFSET(interpreter_frame_sender_sp);
 743   DESCRIBE_FP_OFFSET(interpreter_frame_last_sp);
 744   DESCRIBE_FP_OFFSET(interpreter_frame_method);
 745   DESCRIBE_FP_OFFSET(interpreter_frame_mdp);
 746   DESCRIBE_FP_OFFSET(interpreter_frame_cache);
 747   DESCRIBE_FP_OFFSET(interpreter_frame_locals);
 748   DESCRIBE_FP_OFFSET(interpreter_frame_bcp);
 749   DESCRIBE_FP_OFFSET(interpreter_frame_initial_sp);
 750   unsigned long *p = (unsigned long *)fp;
 751 
 752   // We want to see all frames, native and Java.  For compiled and
 753   // interpreted frames we have special information that allows us to
 754   // unwind them; for everything else we assume that the native frame
 755   // pointer chain is intact.
 756   frame this_frame((intptr_t*)sp, (intptr_t*)fp, (address)pc);
 757   if (this_frame.is_compiled_frame() ||
 758       this_frame.is_interpreted_frame()) {
 759     frame sender = this_frame.sender(reg_map);
 760     nextfp = (unsigned long)sender.fp();
 761     nextpc = (unsigned long)sender.pc();
 762     nextsp = (unsigned long)sender.unextended_sp();
 763   } else {
 764     nextfp = p[frame::link_offset];
 765     nextpc = p[frame::return_addr_offset];
 766     nextsp = (unsigned long)&p[frame::sender_sp_offset];
 767   }
 768 
 769   if (bcx == -1ul)
 770     bcx = p[frame::interpreter_frame_bcp_offset];
 771 
 772   if (Interpreter::contains((address)pc)) {
 773     Method* m = (Method*)p[frame::interpreter_frame_method_offset];
 774     if(m && m->is_method()) {
 775       printbc(m, bcx);
 776     } else
 777       printf("not a Method\n");
 778   } else {
 779     CodeBlob *cb = CodeCache::find_blob((address)pc);
 780     if (cb != NULL) {
 781       if (cb->is_nmethod()) {
 782         ResourceMark rm;
 783         nmethod* nm = (nmethod*)cb;
 784         printf("nmethod %s\n", nm->method()->name_and_sig_as_C_string());
 785       } else if (cb->name()) {
 786         printf("CodeBlob %s\n", cb->name());
 787       }
 788     }
 789   }
 790 }
 791 
 792 extern "C" void npf() {
 793   CodeBlob *cb = CodeCache::find_blob((address)nextpc);
 794   // C2 does not always chain the frame pointers when it can, instead
 795   // preferring to use fixed offsets from SP, so a simple leave() does
 796   // not work.  Instead, it adds the frame size to SP then pops FP and
 797   // LR.  We have to do the same thing to get a good call chain.
 798   if (cb && cb->frame_size())
 799     nextfp = nextsp + wordSize * (cb->frame_size() - 2);
 800   internal_pf (nextsp, nextfp, nextpc, -1);
 801 }
 802 
 803 extern "C" void pf(unsigned long sp, unsigned long fp, unsigned long pc,
 804                    unsigned long bcx, unsigned long thread) {
 805   RegisterMap map((JavaThread*)thread, false);
 806   if (!reg_map) {
 807     reg_map = (RegisterMap*)os::malloc(sizeof map, mtNone);
 808   }
 809   memcpy(reg_map, &map, sizeof map);
 810   {
 811     CodeBlob *cb = CodeCache::find_blob((address)pc);
 812     if (cb && cb->frame_size())
 813       fp = sp + wordSize * (cb->frame_size() - 2);
 814   }
 815   internal_pf(sp, fp, pc, bcx);
 816 }
 817 
 818 // support for printing out where we are in a Java method
 819 // needs to be passed current fp and bcp register values
 820 // prints method name, bc index and bytecode name
 821 extern "C" void pm(unsigned long fp, unsigned long bcx) {
 822   DESCRIBE_FP_OFFSET(interpreter_frame_method);
 823   unsigned long *p = (unsigned long *)fp;
 824   Method* m = (Method*)p[frame::interpreter_frame_method_offset];
 825   printbc(m, bcx);
 826 }
 827 
 828 #ifndef PRODUCT
 829 // This is a generic constructor which is only used by pns() in debug.cpp.
 830 frame::frame(void* sp, void* fp, void* pc) {
 831   init((intptr_t*)sp, (intptr_t*)fp, (address)pc);
 832 }
 833 #endif