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