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