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