1 /*
2 * Copyright (c) 1997, 2026, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #include "classfile/moduleEntry.hpp"
26 #include "code/codeCache.hpp"
27 #include "code/scopeDesc.hpp"
28 #include "code/vmreg.inline.hpp"
29 #include "compiler/abstractCompiler.hpp"
30 #include "compiler/disassembler.hpp"
31 #include "compiler/oopMap.hpp"
32 #include "gc/shared/collectedHeap.inline.hpp"
33 #include "interpreter/interpreter.hpp"
34 #include "interpreter/oopMapCache.hpp"
35 #include "logging/log.hpp"
36 #include "memory/resourceArea.hpp"
37 #include "memory/universe.hpp"
38 #include "oops/inlineKlass.hpp"
39 #include "oops/markWord.hpp"
40 #include "oops/method.inline.hpp"
41 #include "oops/methodData.hpp"
42 #include "oops/oop.inline.hpp"
43 #include "oops/stackChunkOop.inline.hpp"
44 #include "oops/verifyOopClosure.hpp"
45 #include "prims/methodHandles.hpp"
46 #include "runtime/continuation.hpp"
47 #include "runtime/continuationEntry.inline.hpp"
48 #include "runtime/frame.inline.hpp"
49 #include "runtime/handles.inline.hpp"
50 #include "runtime/javaCalls.hpp"
51 #include "runtime/javaThread.hpp"
52 #include "runtime/monitorChunk.hpp"
53 #include "runtime/os.hpp"
54 #include "runtime/safefetch.hpp"
55 #include "runtime/sharedRuntime.hpp"
56 #include "runtime/signature.hpp"
57 #include "runtime/stackValue.hpp"
58 #include "runtime/stubCodeGenerator.hpp"
59 #include "runtime/stubRoutines.hpp"
60 #include "utilities/debug.hpp"
61 #include "utilities/decoder.hpp"
62 #include "utilities/formatBuffer.hpp"
63 #ifdef COMPILER1
64 #include "c1/c1_Runtime1.hpp"
65 #endif
66
67 RegisterMap::RegisterMap(JavaThread *thread, UpdateMap update_map, ProcessFrames process_frames, WalkContinuation walk_cont) {
68 _thread = thread;
69 _update_map = update_map == UpdateMap::include;
70 _process_frames = process_frames == ProcessFrames::include;
71 _walk_cont = walk_cont == WalkContinuation::include;
72 clear();
73 DEBUG_ONLY (_update_for_id = nullptr;)
74 NOT_PRODUCT(_skip_missing = false;)
75 NOT_PRODUCT(_async = false;)
76
77 if (walk_cont == WalkContinuation::include && thread != nullptr && thread->last_continuation() != nullptr) {
78 _chunk = stackChunkHandle(Thread::current()->handle_area()->allocate_null_handle(), true /* dummy */);
79 }
80 _chunk_index = -1;
81
82 #ifndef PRODUCT
83 for (int i = 0; i < reg_count ; i++ ) _location[i] = nullptr;
84 #endif /* PRODUCT */
85 }
86
87 RegisterMap::RegisterMap(oop continuation, UpdateMap update_map) {
88 _thread = nullptr;
89 _update_map = update_map == UpdateMap::include;
90 _process_frames = false;
91 _walk_cont = true;
92 clear();
93 DEBUG_ONLY (_update_for_id = nullptr;)
94 NOT_PRODUCT(_skip_missing = false;)
95 NOT_PRODUCT(_async = false;)
96
97 _chunk = stackChunkHandle(Thread::current()->handle_area()->allocate_null_handle(), true /* dummy */);
98 _chunk_index = -1;
99
100 #ifndef PRODUCT
101 for (int i = 0; i < reg_count ; i++ ) _location[i] = nullptr;
102 #endif /* PRODUCT */
103 }
104
105 RegisterMap::RegisterMap(const RegisterMap* map) {
106 assert(map != this, "bad initialization parameter");
107 assert(map != nullptr, "RegisterMap must be present");
108 _thread = map->thread();
109 _update_map = map->update_map();
110 _process_frames = map->process_frames();
111 _walk_cont = map->_walk_cont;
112 _include_argument_oops = map->include_argument_oops();
113 DEBUG_ONLY (_update_for_id = map->_update_for_id;)
114 NOT_PRODUCT(_skip_missing = map->_skip_missing;)
115 NOT_PRODUCT(_async = map->_async;)
116
117 // only the original RegisterMap's handle lives long enough for StackWalker; this is bound to cause trouble with nested continuations.
118 _chunk = map->_chunk;
119 _chunk_index = map->_chunk_index;
120
121 pd_initialize_from(map);
122 if (update_map()) {
123 for(int i = 0; i < location_valid_size; i++) {
124 LocationValidType bits = map->_location_valid[i];
125 _location_valid[i] = bits;
126 // for whichever bits are set, pull in the corresponding map->_location
127 int j = i*location_valid_type_size;
128 while (bits != 0) {
129 if ((bits & 1) != 0) {
130 assert(0 <= j && j < reg_count, "range check");
131 _location[j] = map->_location[j];
132 }
133 bits >>= 1;
134 j += 1;
135 }
136 }
137 }
138 }
139
140 oop RegisterMap::cont() const {
141 return _chunk() != nullptr ? _chunk()->cont() : (oop)nullptr;
142 }
143
144 void RegisterMap::set_stack_chunk(stackChunkOop chunk) {
145 assert(chunk == nullptr || _walk_cont, "");
146 assert(chunk == nullptr || _chunk.not_null(), "");
147 if (_chunk.is_null()) return;
148 log_trace(continuations)("set_stack_chunk: " INTPTR_FORMAT " this: " INTPTR_FORMAT, p2i((oopDesc*)chunk), p2i(this));
149 _chunk.replace(chunk); // reuse handle. see comment above in the constructor
150 if (chunk == nullptr) {
151 _chunk_index = -1;
152 } else {
153 _chunk_index++;
154 }
155 }
156
157 void RegisterMap::clear() {
158 set_include_argument_oops(true);
159 if (update_map()) {
160 for(int i = 0; i < location_valid_size; i++) {
161 _location_valid[i] = 0;
162 }
163 pd_clear();
164 } else {
165 pd_initialize();
166 }
167 }
168
169 #ifndef PRODUCT
170
171 VMReg RegisterMap::find_register_spilled_here(void* p, intptr_t* sp) {
172 for(int i = 0; i < RegisterMap::reg_count; i++) {
173 VMReg r = VMRegImpl::as_VMReg(i);
174 if (p == location(r, sp)) return r;
175 }
176 return nullptr;
177 }
178
179 void RegisterMap::print_on(outputStream* st) const {
180 st->print_cr("Register map");
181 for(int i = 0; i < reg_count; i++) {
182
183 VMReg r = VMRegImpl::as_VMReg(i);
184 intptr_t* src = (intptr_t*) location(r, nullptr);
185 if (src != nullptr) {
186
187 r->print_on(st);
188 st->print(" [" INTPTR_FORMAT "] = ", p2i(src));
189 if (((uintptr_t)src & (sizeof(*src)-1)) != 0) {
190 st->print_cr("<misaligned>");
191 } else {
192 st->print_cr(INTPTR_FORMAT, *src);
193 }
194 }
195 }
196 }
197
198 void RegisterMap::print() const {
199 print_on(tty);
200 }
201
202 #endif
203 // This returns the pc that if you were in the debugger you'd see. Not
204 // the idealized value in the frame object. This undoes the magic conversion
205 // that happens for deoptimized frames. In addition it makes the value the
206 // hardware would want to see in the native frame. The only user (at this point)
207 // is deoptimization. It likely no one else should ever use it.
208
209 address frame::raw_pc() const {
210 if (is_deoptimized_frame()) {
211 nmethod* nm = cb()->as_nmethod_or_null();
212 assert(nm != nullptr, "only nmethod is expected here");
213 return nm->deopt_handler_entry() - pc_return_offset;
214 } else {
215 return (pc() - pc_return_offset);
216 }
217 }
218
219 // Change the pc in a frame object. This does not change the actual pc in
220 // actual frame. To do that use patch_pc.
221 //
222 void frame::set_pc(address newpc) {
223 #ifdef ASSERT
224 if (_cb != nullptr && _cb->is_nmethod()) {
225 assert(!((nmethod*)_cb)->is_deopt_pc(_pc), "invariant violation");
226 }
227 #endif // ASSERT
228
229 // Unsafe to use the is_deoptimized tester after changing pc
230 _deopt_state = unknown;
231 _pc = newpc;
232 _cb = CodeCache::find_blob(_pc);
233 }
234
235 // This is optimized for intra-blob pc adjustments only.
236 void frame::adjust_pc(address newpc) {
237 assert(_cb != nullptr, "invariant");
238 assert(_cb == CodeCache::find_blob(newpc), "invariant");
239 // Unsafe to use the is_deoptimized tester after changing pc
240 _deopt_state = unknown;
241 _pc = newpc;
242 }
243
244 // type testers
245 bool frame::is_ignored_frame() const {
246 return false; // FIXME: some LambdaForm frames should be ignored
247 }
248
249 bool frame::is_native_frame() const {
250 return (_cb != nullptr &&
251 _cb->is_nmethod() &&
252 ((nmethod*)_cb)->is_native_method());
253 }
254
255 bool frame::is_java_frame() const {
256 if (is_interpreted_frame()) return true;
257 if (is_compiled_frame()) return true;
258 return false;
259 }
260
261 bool frame::is_runtime_frame() const {
262 return (_cb != nullptr && _cb->is_runtime_stub());
263 }
264
265 bool frame::is_safepoint_blob_frame() const {
266 return (_cb != nullptr && _cb->is_safepoint_stub());
267 }
268
269 // testers
270
271 bool frame::is_first_java_frame() const {
272 RegisterMap map(JavaThread::current(),
273 RegisterMap::UpdateMap::skip,
274 RegisterMap::ProcessFrames::include,
275 RegisterMap::WalkContinuation::skip); // No update
276 frame s;
277 for (s = sender(&map); !(s.is_java_frame() || s.is_first_frame()); s = s.sender(&map));
278 return s.is_first_frame();
279 }
280
281 bool frame::is_first_vthread_frame(JavaThread* thread) const {
282 return Continuation::is_continuation_enterSpecial(*this)
283 && Continuation::get_continuation_entry_for_entry_frame(thread, *this)->is_virtual_thread();
284 }
285
286 bool frame::entry_frame_is_first() const {
287 return entry_frame_call_wrapper()->is_first_frame();
288 }
289
290 JavaCallWrapper* frame::entry_frame_call_wrapper_if_safe(JavaThread* thread) const {
291 JavaCallWrapper** jcw = entry_frame_call_wrapper_addr();
292 address addr = (address) jcw;
293
294 // addr must be within the usable part of the stack
295 if (thread->is_in_usable_stack(addr)) {
296 return *jcw;
297 }
298
299 return nullptr;
300 }
301
302 bool frame::is_entry_frame_valid(JavaThread* thread) const {
303 // Validate the JavaCallWrapper an entry frame must have
304 address jcw = (address)entry_frame_call_wrapper();
305 if (!thread->is_in_stack_range_excl(jcw, (address)fp())) {
306 return false;
307 }
308
309 // Validate sp saved in the java frame anchor
310 JavaFrameAnchor* jfa = entry_frame_call_wrapper()->anchor();
311 return (jfa->last_Java_sp() > sp());
312 }
313
314 Method* frame::safe_interpreter_frame_method() const {
315 Method** m_addr = interpreter_frame_method_addr();
316 if (m_addr == nullptr) {
317 return nullptr;
318 }
319 return (Method*) SafeFetchN((intptr_t*) m_addr, 0);
320 }
321
322 bool frame::should_be_deoptimized() const {
323 if (_deopt_state == is_deoptimized ||
324 !is_compiled_frame() ) return false;
325 assert(_cb != nullptr && _cb->is_nmethod(), "must be an nmethod");
326 nmethod* nm = _cb->as_nmethod();
327 LogTarget(Debug, dependencies) lt;
328 if (lt.is_enabled()) {
329 LogStream ls(<);
330 ls.print("checking (%s) ", nm->is_marked_for_deoptimization() ? "true" : "false");
331 nm->print_value_on(&ls);
332 ls.cr();
333 }
334
335 if( !nm->is_marked_for_deoptimization() )
336 return false;
337
338 // If at the return point, then the frame has already been popped, and
339 // only the return needs to be executed. Don't deoptimize here.
340 return !nm->is_at_poll_return(pc());
341 }
342
343 bool frame::can_be_deoptimized() const {
344 if (!is_compiled_frame()) return false;
345 nmethod* nm = _cb->as_nmethod();
346
347 if(!nm->can_be_deoptimized())
348 return false;
349
350 return !nm->is_at_poll_return(pc());
351 }
352
353 void frame::deoptimize(JavaThread* thread) {
354 assert(thread == nullptr
355 || (thread->frame_anchor()->has_last_Java_frame() &&
356 thread->frame_anchor()->walkable()), "must be");
357 // Schedule deoptimization of an nmethod activation with this frame.
358 assert(_cb != nullptr && _cb->is_nmethod(), "must be");
359
360 // If the call site is a MethodHandle call site use the MH deopt handler.
361 nmethod* nm = _cb->as_nmethod();
362 address deopt = nm->deopt_handler_entry();
363
364 NativePostCallNop* inst = nativePostCallNop_at(pc());
365
366 // Save the original pc before we patch in the new one
367 nm->set_original_pc(this, pc());
368
369 #ifdef COMPILER1
370 if (nm->is_compiled_by_c1() && nm->method()->has_scalarized_args() &&
371 pc() < nm->verified_inline_entry_point()) {
372 // The VEP and VIEP(RO) of C1-compiled methods call into the runtime to buffer scalarized value
373 // type args. We can't deoptimize at that point because the buffers have not yet been initialized.
374 // Also, if the method is synchronized, we first need to acquire the lock.
375 // Don't patch the return pc to delay deoptimization until we enter the method body (the check
376 // added in LIRGenerator::do_Base will detect the pending deoptimization by checking the original_pc).
377 #if defined ASSERT && !defined AARCH64 // Stub call site does not look like NativeCall on AArch64
378 NativeCall* call = nativeCall_before(this->pc());
379 address dest = call->destination();
380 assert(dest == Runtime1::entry_for(StubId::c1_buffer_inline_args_no_receiver_id) ||
381 dest == Runtime1::entry_for(StubId::c1_buffer_inline_args_id), "unexpected safepoint in entry point");
382 #endif
383 return;
384 }
385 #endif
386
387 patch_pc(thread, deopt);
388 assert(is_deoptimized_frame(), "must be");
389
390 #ifdef ASSERT
391 if (thread != nullptr) {
392 frame fr = thread->last_frame();
393 RegisterMap map(thread,
394 RegisterMap::UpdateMap::skip,
395 RegisterMap::ProcessFrames::include,
396 !is_heap_frame() ? RegisterMap::WalkContinuation::skip : RegisterMap::WalkContinuation::include);
397 intptr_t* fr_id = fr.id();
398 while (id() != fr_id) {
399 fr = fr.sender(&map);
400 if (fr.is_heap_frame()) {
401 assert(is_heap_frame(), "");
402 frame derel_fr = map.stack_chunk()->derelativize(fr);
403 fr_id = derel_fr.id();
404 } else {
405 fr_id = fr.id();
406 }
407 }
408 assert(fr.is_deoptimized_frame(), "missed deopt");
409 }
410 #endif // ASSERT
411 }
412
413 frame frame::java_sender() const {
414 RegisterMap map(JavaThread::current(),
415 RegisterMap::UpdateMap::skip,
416 RegisterMap::ProcessFrames::include,
417 RegisterMap::WalkContinuation::skip);
418 frame s;
419 for (s = sender(&map); !(s.is_java_frame() || s.is_first_frame()); s = s.sender(&map)) ;
420 guarantee(s.is_java_frame(), "tried to get caller of first java frame");
421 return s;
422 }
423
424 frame frame::real_sender(RegisterMap* map) const {
425 frame result = sender(map);
426 while (result.is_runtime_frame() ||
427 result.is_ignored_frame()) {
428 result = result.sender(map);
429 }
430 return result;
431 }
432
433 // Interpreter frames
434
435
436 Method* frame::interpreter_frame_method() const {
437 assert(is_interpreted_frame(), "interpreted frame expected");
438 Method* m = *interpreter_frame_method_addr();
439 assert(m->is_method(), "not a Method*");
440 return m;
441 }
442
443 void frame::interpreter_frame_set_method(Method* method) {
444 assert(is_interpreted_frame(), "interpreted frame expected");
445 *interpreter_frame_method_addr() = method;
446 }
447
448 void frame::interpreter_frame_set_mirror(oop mirror) {
449 assert(is_interpreted_frame(), "interpreted frame expected");
450 *interpreter_frame_mirror_addr() = mirror;
451 }
452
453 jint frame::interpreter_frame_bci() const {
454 assert(is_interpreted_frame(), "interpreted frame expected");
455 address bcp = interpreter_frame_bcp();
456 return interpreter_frame_method()->bci_from(bcp);
457 }
458
459 address frame::interpreter_frame_bcp() const {
460 assert(is_interpreted_frame(), "interpreted frame expected");
461 address bcp = (address)*interpreter_frame_bcp_addr();
462 return interpreter_frame_method()->bcp_from(bcp);
463 }
464
465 void frame::interpreter_frame_set_bcp(address bcp) {
466 assert(is_interpreted_frame(), "interpreted frame expected");
467 *interpreter_frame_bcp_addr() = (intptr_t)bcp;
468 }
469
470 address frame::interpreter_frame_mdp() const {
471 assert(ProfileInterpreter, "must be profiling interpreter");
472 assert(is_interpreted_frame(), "interpreted frame expected");
473 return (address)*interpreter_frame_mdp_addr();
474 }
475
476 void frame::interpreter_frame_set_mdp(address mdp) {
477 assert(is_interpreted_frame(), "interpreted frame expected");
478 assert(ProfileInterpreter, "must be profiling interpreter");
479 *interpreter_frame_mdp_addr() = (intptr_t)mdp;
480 }
481
482 BasicObjectLock* frame::next_monitor_in_interpreter_frame(BasicObjectLock* current) const {
483 assert(is_interpreted_frame(), "Not an interpreted frame");
484 #ifdef ASSERT
485 interpreter_frame_verify_monitor(current);
486 #endif
487 BasicObjectLock* next = (BasicObjectLock*) (((intptr_t*) current) + interpreter_frame_monitor_size());
488 return next;
489 }
490
491 BasicObjectLock* frame::previous_monitor_in_interpreter_frame(BasicObjectLock* current) const {
492 assert(is_interpreted_frame(), "Not an interpreted frame");
493 #ifdef ASSERT
494 // // This verification needs to be checked before being enabled
495 // interpreter_frame_verify_monitor(current);
496 #endif
497 BasicObjectLock* previous = (BasicObjectLock*) (((intptr_t*) current) - interpreter_frame_monitor_size());
498 return previous;
499 }
500
501 // Interpreter locals and expression stack locations.
502
503 intptr_t* frame::interpreter_frame_local_at(int index) const {
504 const int n = Interpreter::local_offset_in_bytes(index)/wordSize;
505 intptr_t* first = interpreter_frame_locals();
506 return &(first[n]);
507 }
508
509 intptr_t* frame::interpreter_frame_expression_stack_at(jint offset) const {
510 const int i = offset * interpreter_frame_expression_stack_direction();
511 const int n = i * Interpreter::stackElementWords;
512 return &(interpreter_frame_expression_stack()[n]);
513 }
514
515 jint frame::interpreter_frame_expression_stack_size() const {
516 // Number of elements on the interpreter expression stack
517 // Callers should span by stackElementWords
518 int element_size = Interpreter::stackElementWords;
519 size_t stack_size = 0;
520 if (frame::interpreter_frame_expression_stack_direction() < 0) {
521 stack_size = (interpreter_frame_expression_stack() -
522 interpreter_frame_tos_address() + 1)/element_size;
523 } else {
524 stack_size = (interpreter_frame_tos_address() -
525 interpreter_frame_expression_stack() + 1)/element_size;
526 }
527 assert(stack_size <= (size_t)max_jint, "stack size too big");
528 return (jint)stack_size;
529 }
530
531 // (frame::interpreter_frame_sender_sp accessor is in frame_<arch>.cpp)
532
533 const char* frame::print_name() const {
534 if (is_native_frame()) return "Native";
535 if (is_interpreted_frame()) return "Interpreted";
536 if (is_compiled_frame()) {
537 if (is_deoptimized_frame()) return "Deoptimized";
538 return "Compiled";
539 }
540 if (sp() == nullptr) return "Empty";
541 return "C";
542 }
543
544 void frame::print_value_on(outputStream* st) const {
545 NOT_PRODUCT(address begin = pc()-40;)
546 NOT_PRODUCT(address end = nullptr;)
547
548 st->print("%s frame (sp=" INTPTR_FORMAT " unextended sp=" INTPTR_FORMAT, print_name(), p2i(sp()), p2i(unextended_sp()));
549 if (sp() != nullptr)
550 st->print(", fp=" INTPTR_FORMAT ", real_fp=" INTPTR_FORMAT ", pc=" INTPTR_FORMAT,
551 p2i(fp()), p2i(real_fp()), p2i(pc()));
552 st->print_cr(")");
553
554 if (StubRoutines::contains(pc())) {
555 StubCodeDesc* desc = StubCodeDesc::desc_for(pc());
556 st->print("~Stub::%s", desc->name());
557 NOT_PRODUCT(begin = desc->begin(); end = desc->end();)
558 } else if (Interpreter::contains(pc())) {
559 InterpreterCodelet* desc = Interpreter::codelet_containing(pc());
560 if (desc != nullptr) {
561 st->print("~");
562 desc->print_on(st);
563 NOT_PRODUCT(begin = desc->code_begin(); end = desc->code_end();)
564 } else {
565 st->print("~interpreter");
566 }
567 }
568
569 #ifndef PRODUCT
570 if (_cb != nullptr) {
571 st->print(" ");
572 _cb->print_value_on(st);
573 if (end == nullptr) {
574 begin = _cb->code_begin();
575 end = _cb->code_end();
576 }
577 }
578 if (WizardMode && Verbose) Disassembler::decode(begin, end);
579 #endif
580 }
581
582 void frame::print_on(outputStream* st) const {
583 print_value_on(st);
584 if (is_interpreted_frame()) {
585 interpreter_frame_print_on(st);
586 }
587 }
588
589 void frame::interpreter_frame_print_on(outputStream* st) const {
590 #ifndef PRODUCT
591 assert(is_interpreted_frame(), "Not an interpreted frame");
592 jint i;
593 for (i = 0; i < interpreter_frame_method()->max_locals(); i++ ) {
594 intptr_t x = *interpreter_frame_local_at(i);
595 st->print(" - local [" INTPTR_FORMAT "]", x);
596 st->fill_to(23);
597 st->print_cr("; #%d", i);
598 }
599 for (i = interpreter_frame_expression_stack_size() - 1; i >= 0; --i ) {
600 intptr_t x = *interpreter_frame_expression_stack_at(i);
601 st->print(" - stack [" INTPTR_FORMAT "]", x);
602 st->fill_to(23);
603 st->print_cr("; #%d", i);
604 }
605 // locks for synchronization
606 for (BasicObjectLock* current = interpreter_frame_monitor_end();
607 current < interpreter_frame_monitor_begin();
608 current = next_monitor_in_interpreter_frame(current)) {
609 st->print(" - obj [%s", current->obj() == nullptr ? "null" : "");
610 oop obj = current->obj();
611 if (obj != nullptr) {
612 if (!is_heap_frame()) {
613 obj->print_value_on(st);
614 } else {
615 // Might be an invalid oop. We don't have the
616 // stackChunk to correct it so just print address.
617 st->print(INTPTR_FORMAT, p2i(obj));
618 }
619 }
620 st->print_cr("]");
621 st->print(" - lock [");
622 if (!is_heap_frame()) {
623 current->lock()->print_on(st, obj);
624 }
625 st->print_cr("]");
626 }
627 // monitor
628 st->print_cr(" - monitor[" INTPTR_FORMAT "]", p2i(interpreter_frame_monitor_begin()));
629 // bcp
630 st->print(" - bcp [" INTPTR_FORMAT "]", p2i(interpreter_frame_bcp()));
631 st->fill_to(23);
632 st->print_cr("; @%d", interpreter_frame_bci());
633 // locals
634 st->print_cr(" - locals [" INTPTR_FORMAT "]", p2i(interpreter_frame_local_at(0)));
635 // method
636 st->print(" - method [" INTPTR_FORMAT "]", p2i(interpreter_frame_method()));
637 st->fill_to(23);
638 st->print("; ");
639 interpreter_frame_method()->print_name(st);
640 st->cr();
641 #endif
642 }
643
644 // Print whether the frame is in the VM or OS indicating a HotSpot problem.
645 // Otherwise, it's likely a bug in the native library that the Java code calls,
646 // hopefully indicating where to submit bugs.
647 void frame::print_C_frame(outputStream* st, char* buf, int buflen, address pc) {
648 // C/C++ frame
649 bool in_vm = os::address_is_in_vm(pc);
650 st->print(in_vm ? "V" : "C");
651
652 int offset;
653 bool found;
654
655 if (buf == nullptr || buflen < 1) return;
656 // libname
657 buf[0] = '\0';
658 found = os::dll_address_to_library_name(pc, buf, buflen, &offset);
659 if (found && buf[0] != '\0') {
660 // skip directory names
661 const char *p1, *p2;
662 p1 = buf;
663 int len = (int)strlen(os::file_separator());
664 while ((p2 = strstr(p1, os::file_separator())) != nullptr) p1 = p2 + len;
665 st->print(" [%s+0x%x]", p1, offset);
666 } else {
667 st->print(" " PTR_FORMAT, p2i(pc));
668 }
669
670 found = os::dll_address_to_function_name(pc, buf, buflen, &offset);
671 if (found) {
672 st->print(" %s+0x%x", buf, offset);
673 }
674 }
675
676 // frame::print_on_error() is called by fatal error handler. Notice that we may
677 // crash inside this function if stack frame is corrupted. The fatal error
678 // handler can catch and handle the crash. Here we assume the frame is valid.
679 //
680 // First letter indicates type of the frame:
681 // J: Java frame (compiled)
682 // j: Java frame (interpreted)
683 // V: VM frame (C/C++)
684 // v: Other frames running VM generated code (e.g. stubs, adapters, etc.)
685 // C: C/C++ frame
686 //
687 // We don't need detailed frame type as that in frame::print_name(). "C"
688 // suggests the problem is in user lib; everything else is likely a VM bug.
689
690 void frame::print_on_error(outputStream* st, char* buf, int buflen, bool verbose) const {
691 if (_cb != nullptr) {
692 if (Interpreter::contains(pc())) {
693 Method* m = this->interpreter_frame_method();
694 if (m != nullptr) {
695 m->name_and_sig_as_C_string(buf, buflen);
696 st->print("j %s", buf);
697 st->print("+%d", this->interpreter_frame_bci());
698 ModuleEntry* module = m->method_holder()->module();
699 if (module->is_named()) {
700 module->name()->as_C_string(buf, buflen);
701 st->print(" %s", buf);
702 if (module->version() != nullptr) {
703 module->version()->as_C_string(buf, buflen);
704 st->print("@%s", buf);
705 }
706 }
707 } else {
708 st->print("j " PTR_FORMAT, p2i(pc()));
709 }
710 } else if (StubRoutines::contains(pc())) {
711 StubCodeDesc* desc = StubCodeDesc::desc_for(pc());
712 if (desc != nullptr) {
713 st->print("v ~StubRoutines::%s " PTR_FORMAT, desc->name(), p2i(pc()));
714 } else {
715 st->print("v ~StubRoutines::" PTR_FORMAT, p2i(pc()));
716 }
717 } else if (_cb->is_buffer_blob()) {
718 st->print("v ~BufferBlob::%s " PTR_FORMAT, ((BufferBlob *)_cb)->name(), p2i(pc()));
719 } else if (_cb->is_nmethod()) {
720 nmethod* nm = _cb->as_nmethod();
721 Method* m = nm->method();
722 if (m != nullptr) {
723 st->print("J %d%s", nm->compile_id(), (nm->is_osr_method() ? "%" : ""));
724 st->print(" %s", nm->compiler_name());
725 m->name_and_sig_as_C_string(buf, buflen);
726 st->print(" %s", buf);
727 ModuleEntry* module = m->method_holder()->module();
728 if (module->is_named()) {
729 module->name()->as_C_string(buf, buflen);
730 st->print(" %s", buf);
731 if (module->version() != nullptr) {
732 module->version()->as_C_string(buf, buflen);
733 st->print("@%s", buf);
734 }
735 }
736 st->print(" (%d bytes) @ " PTR_FORMAT " [" PTR_FORMAT "+" INTPTR_FORMAT "]",
737 m->code_size(), p2i(_pc), p2i(_cb->code_begin()), _pc - _cb->code_begin());
738 } else {
739 st->print("J " PTR_FORMAT, p2i(pc()));
740 }
741 } else if (_cb->is_runtime_stub()) {
742 st->print("v ~RuntimeStub::%s " PTR_FORMAT, ((RuntimeStub *)_cb)->name(), p2i(pc()));
743 } else if (_cb->is_deoptimization_stub()) {
744 st->print("v ~DeoptimizationBlob " PTR_FORMAT, p2i(pc()));
745 } else if (_cb->is_exception_stub()) {
746 st->print("v ~ExceptionBlob " PTR_FORMAT, p2i(pc()));
747 } else if (_cb->is_safepoint_stub()) {
748 st->print("v ~SafepointBlob " PTR_FORMAT, p2i(pc()));
749 } else if (_cb->is_adapter_blob()) {
750 st->print("v ~AdapterBlob " PTR_FORMAT, p2i(pc()));
751 } else if (_cb->is_vtable_blob()) {
752 st->print("v ~VtableBlob " PTR_FORMAT, p2i(pc()));
753 } else if (_cb->is_method_handles_adapter_blob()) {
754 st->print("v ~MethodHandlesAdapterBlob " PTR_FORMAT, p2i(pc()));
755 } else if (_cb->is_uncommon_trap_stub()) {
756 st->print("v ~UncommonTrapBlob " PTR_FORMAT, p2i(pc()));
757 } else if (_cb->is_upcall_stub()) {
758 st->print("v ~UpcallStub::%s " PTR_FORMAT, _cb->name(), p2i(pc()));
759 } else {
760 st->print("v blob " PTR_FORMAT, p2i(pc()));
761 }
762 } else {
763 print_C_frame(st, buf, buflen, pc());
764 }
765 }
766
767
768 /*
769 The interpreter_frame_expression_stack_at method in the case of SPARC needs the
770 max_stack value of the method in order to compute the expression stack address.
771 It uses the Method* in order to get the max_stack value but during GC this
772 Method* value saved on the frame is changed by reverse_and_push and hence cannot
773 be used. So we save the max_stack value in the FrameClosure object and pass it
774 down to the interpreter_frame_expression_stack_at method
775 */
776 class InterpreterFrameClosure : public OffsetClosure {
777 private:
778 const frame* _fr;
779 OopClosure* _f;
780 int _max_locals;
781 int _max_stack;
782
783 public:
784 InterpreterFrameClosure(const frame* fr, int max_locals, int max_stack,
785 OopClosure* f) {
786 _fr = fr;
787 _max_locals = max_locals;
788 _max_stack = max_stack;
789 _f = f;
790 }
791
792 void offset_do(int offset) {
793 oop* addr;
794 if (offset < _max_locals) {
795 addr = (oop*) _fr->interpreter_frame_local_at(offset);
796 assert((intptr_t*)addr >= _fr->sp(), "must be inside the frame");
797 _f->do_oop(addr);
798 } else {
799 addr = (oop*) _fr->interpreter_frame_expression_stack_at((offset - _max_locals));
800 // In case of exceptions, the expression stack is invalid and the esp will be reset to express
801 // this condition. Therefore, we call f only if addr is 'inside' the stack (i.e., addr >= esp for Intel).
802 bool in_stack;
803 if (frame::interpreter_frame_expression_stack_direction() > 0) {
804 in_stack = (intptr_t*)addr <= _fr->interpreter_frame_tos_address();
805 } else {
806 in_stack = (intptr_t*)addr >= _fr->interpreter_frame_tos_address();
807 }
808 if (in_stack) {
809 _f->do_oop(addr);
810 }
811 }
812 }
813 };
814
815
816 class InterpretedArgumentOopFinder: public SignatureIterator {
817 private:
818 OopClosure* _f; // Closure to invoke
819 int _offset; // TOS-relative offset, decremented with each argument
820 bool _has_receiver; // true if the callee has a receiver
821 const frame* _fr;
822
823 friend class SignatureIterator; // so do_parameters_on can call do_type
824 void do_type(BasicType type) {
825 _offset -= parameter_type_word_count(type);
826 if (is_reference_type(type)) oop_offset_do();
827 }
828
829 void oop_offset_do() {
830 oop* addr;
831 addr = (oop*)_fr->interpreter_frame_tos_at(_offset);
832 _f->do_oop(addr);
833 }
834
835 public:
836 InterpretedArgumentOopFinder(Symbol* signature, bool has_receiver, const frame* fr, OopClosure* f) : SignatureIterator(signature), _has_receiver(has_receiver) {
837 // compute size of arguments
838 int args_size = ArgumentSizeComputer(signature).size() + (has_receiver ? 1 : 0);
839 assert(!fr->is_interpreted_frame() ||
840 args_size <= fr->interpreter_frame_expression_stack_size(),
841 "args cannot be on stack anymore");
842 // initialize InterpretedArgumentOopFinder
843 _f = f;
844 _fr = fr;
845 _offset = args_size;
846 }
847
848 void oops_do() {
849 if (_has_receiver) {
850 --_offset;
851 oop_offset_do();
852 }
853 do_parameters_on(this);
854 }
855 };
856
857
858 // Entry frame has following form (n arguments)
859 // +-----------+
860 // sp -> | last arg |
861 // +-----------+
862 // : ::: :
863 // +-----------+
864 // (sp+n)->| first arg|
865 // +-----------+
866
867
868
869 // visits and GC's all the arguments in entry frame
870 class EntryFrameOopFinder: public SignatureIterator {
871 private:
872 bool _is_static;
873 int _offset;
874 const frame* _fr;
875 OopClosure* _f;
876
877 friend class SignatureIterator; // so do_parameters_on can call do_type
878 void do_type(BasicType type) {
879 // decrement offset before processing the type
880 _offset -= parameter_type_word_count(type);
881 assert (_offset >= 0, "illegal offset");
882 if (is_reference_type(type)) oop_at_offset_do(_offset);
883 }
884
885 void oop_at_offset_do(int offset) {
886 assert (offset >= 0, "illegal offset");
887 oop* addr = (oop*) _fr->entry_frame_argument_at(offset);
888 _f->do_oop(addr);
889 }
890
891 public:
892 EntryFrameOopFinder(const frame* frame, Symbol* signature, bool is_static) : SignatureIterator(signature) {
893 _f = nullptr; // will be set later
894 _fr = frame;
895 _is_static = is_static;
896 _offset = ArgumentSizeComputer(signature).size(); // pre-decremented down to zero
897 }
898
899 void arguments_do(OopClosure* f) {
900 _f = f;
901 if (!_is_static) oop_at_offset_do(_offset); // do the receiver
902 do_parameters_on(this);
903 }
904
905 };
906
907 oop* frame::interpreter_callee_receiver_addr(Symbol* signature) {
908 ArgumentSizeComputer asc(signature);
909 int size = asc.size();
910 return (oop *)interpreter_frame_tos_at(size);
911 }
912
913 oop frame::interpreter_callee_receiver(Symbol* signature) {
914 return *interpreter_callee_receiver_addr(signature);
915 }
916
917 template <typename RegisterMapT>
918 void frame::oops_interpreted_do(OopClosure* f, const RegisterMapT* map, bool query_oop_map_cache) const {
919 assert(is_interpreted_frame(), "Not an interpreted frame");
920 Thread *thread = Thread::current();
921 methodHandle m (thread, interpreter_frame_method());
922 jint bci = interpreter_frame_bci();
923
924 assert(!Universe::heap()->is_in(m()),
925 "must be valid oop");
926 assert(m->is_method(), "checking frame value");
927 assert((m->is_native() && bci == 0) ||
928 (!m->is_native() && bci >= 0 && bci < m->code_size()),
929 "invalid bci value");
930
931 // Handle the monitor elements in the activation
932 for (
933 BasicObjectLock* current = interpreter_frame_monitor_end();
934 current < interpreter_frame_monitor_begin();
935 current = next_monitor_in_interpreter_frame(current)
936 ) {
937 #ifdef ASSERT
938 interpreter_frame_verify_monitor(current);
939 #endif
940 current->oops_do(f);
941 }
942
943 if (m->is_native()) {
944 f->do_oop(interpreter_frame_temp_oop_addr());
945 }
946
947 // The method pointer in the frame might be the only path to the method's
948 // klass, and the klass needs to be kept alive while executing. The GCs
949 // don't trace through method pointers, so the mirror of the method's klass
950 // is installed as a GC root.
951 f->do_oop(interpreter_frame_mirror_addr());
952
953 int max_locals = m->is_native() ? m->size_of_parameters() : m->max_locals();
954
955 // Process a callee's arguments if we are at a call site
956 // (i.e., if we are at an invoke bytecode)
957 // This is used sometimes for calling into the VM, not for another
958 // interpreted or compiled frame.
959 if (!m->is_native() && map != nullptr && map->include_argument_oops()) {
960 Bytecode_invoke call = Bytecode_invoke_check(m, bci);
961 if (call.is_valid() && interpreter_frame_expression_stack_size() > 0) {
962 ResourceMark rm(thread); // is this right ???
963 Symbol* signature = call.signature();
964 bool has_receiver = call.has_receiver();
965 // We are at a call site & the expression stack is not empty
966 // so we might have callee arguments we need to process.
967 oops_interpreted_arguments_do(signature, has_receiver, f);
968 }
969 }
970
971 InterpreterFrameClosure blk(this, max_locals, m->max_stack(), f);
972
973 // process locals & expression stack
974 InterpreterOopMap mask;
975 if (query_oop_map_cache) {
976 m->mask_for(m, bci, &mask);
977 } else {
978 OopMapCache::compute_one_oop_map(m, bci, &mask);
979 }
980 mask.iterate_oop(&blk);
981 }
982
983 template void frame::oops_interpreted_do(OopClosure* f, const RegisterMap* map, bool query_oop_map_cache) const;
984 template void frame::oops_interpreted_do(OopClosure* f, const SmallRegisterMapNoArgs* map, bool query_oop_map_cache) const;
985 template void frame::oops_interpreted_do(OopClosure* f, const SmallRegisterMapWithArgs* map, bool query_oop_map_cache) const;
986
987 void frame::oops_interpreted_arguments_do(Symbol* signature, bool has_receiver, OopClosure* f) const {
988 InterpretedArgumentOopFinder finder(signature, has_receiver, this, f);
989 finder.oops_do();
990 }
991
992 void frame::oops_nmethod_do(OopClosure* f, NMethodClosure* cf, DerivedOopClosure* df, DerivedPointerIterationMode derived_mode, const RegisterMap* reg_map) const {
993 assert(_cb != nullptr, "sanity check");
994 assert((oop_map() == nullptr) == (_cb->oop_maps() == nullptr), "frame and _cb must agree that oopmap is set or not");
995 if (oop_map() != nullptr) {
996 if (df != nullptr) {
997 _oop_map->oops_do(this, reg_map, f, df);
998 } else {
999 _oop_map->oops_do(this, reg_map, f, derived_mode);
1000 }
1001
1002 // Preserve potential arguments for a callee. We handle this by dispatching
1003 // on the codeblob. For c2i, we do
1004 if (reg_map->include_argument_oops() && _cb->is_nmethod()) {
1005 // Only nmethod preserves outgoing arguments at call.
1006 _cb->as_nmethod()->preserve_callee_argument_oops(*this, reg_map, f);
1007 }
1008 }
1009 // In cases where perm gen is collected, GC will want to mark
1010 // oops referenced from nmethods active on thread stacks so as to
1011 // prevent them from being collected. However, this visit should be
1012 // restricted to certain phases of the collection only. The
1013 // closure decides how it wants nmethods to be traced.
1014 if (cf != nullptr && _cb->is_nmethod())
1015 cf->do_nmethod(_cb->as_nmethod());
1016 }
1017
1018 class CompiledArgumentOopFinder: public SignatureIterator {
1019 protected:
1020 OopClosure* _f;
1021 int _offset; // the current offset, incremented with each argument
1022 bool _has_receiver; // true if the callee has a receiver
1023 bool _has_appendix; // true if the call has an appendix
1024 frame _fr;
1025 RegisterMap* _reg_map;
1026 int _arg_size;
1027 VMRegPair* _regs; // VMReg list of arguments
1028
1029 friend class SignatureIterator; // so do_parameters_on can call do_type
1030 void do_type(BasicType type) {
1031 if (is_reference_type(type)) handle_oop_offset();
1032 _offset += parameter_type_word_count(type);
1033 }
1034
1035 virtual void handle_oop_offset() {
1036 // Extract low order register number from register array.
1037 // In LP64-land, the high-order bits are valid but unhelpful.
1038 assert(_offset < _arg_size, "out of bounds");
1039 VMReg reg = _regs[_offset].first();
1040 oop *loc = _fr.oopmapreg_to_oop_location(reg, _reg_map);
1041 #ifdef ASSERT
1042 if (loc == nullptr) {
1043 if (_reg_map->should_skip_missing()) {
1044 return;
1045 }
1046 tty->print_cr("Error walking frame oops:");
1047 _fr.print_on(tty);
1048 assert(loc != nullptr, "missing register map entry reg: %d %s loc: " INTPTR_FORMAT, reg->value(), reg->name(), p2i(loc));
1049 }
1050 #endif
1051 _f->do_oop(loc);
1052 }
1053
1054 public:
1055 CompiledArgumentOopFinder(Symbol* signature, bool has_receiver, bool has_appendix, OopClosure* f, frame fr, const RegisterMap* reg_map)
1056 : SignatureIterator(signature) {
1057
1058 // initialize CompiledArgumentOopFinder
1059 _f = f;
1060 _offset = 0;
1061 _has_receiver = has_receiver;
1062 _has_appendix = has_appendix;
1063 _fr = fr;
1064 _reg_map = (RegisterMap*)reg_map;
1065 _regs = SharedRuntime::find_callee_arguments(signature, has_receiver, has_appendix, &_arg_size);
1066 }
1067
1068 void oops_do() {
1069 if (_has_receiver) {
1070 handle_oop_offset();
1071 _offset++;
1072 }
1073 do_parameters_on(this);
1074 if (_has_appendix) {
1075 handle_oop_offset();
1076 _offset++;
1077 }
1078 }
1079 };
1080
1081 void frame::oops_compiled_arguments_do(Symbol* signature, bool has_receiver, bool has_appendix,
1082 const RegisterMap* reg_map, OopClosure* f) const {
1083 // ResourceMark rm;
1084 CompiledArgumentOopFinder finder(signature, has_receiver, has_appendix, f, *this, reg_map);
1085 finder.oops_do();
1086 }
1087
1088 // Get receiver out of callers frame, i.e. find parameter 0 in callers
1089 // frame. Consult ADLC for where parameter 0 is to be found. Then
1090 // check local reg_map for it being a callee-save register or argument
1091 // register, both of which are saved in the local frame. If not found
1092 // there, it must be an in-stack argument of the caller.
1093 // Note: caller.sp() points to callee-arguments
1094 oop frame::retrieve_receiver(RegisterMap* reg_map) {
1095 frame caller = *this;
1096
1097 // First consult the ADLC on where it puts parameter 0 for this signature.
1098 VMReg reg = SharedRuntime::name_for_receiver();
1099 oop* oop_adr = caller.oopmapreg_to_oop_location(reg, reg_map);
1100 if (oop_adr == nullptr) {
1101 guarantee(oop_adr != nullptr, "bad register save location");
1102 return nullptr;
1103 }
1104 oop r = *oop_adr;
1105 assert(Universe::heap()->is_in_or_null(r), "bad receiver: " INTPTR_FORMAT " (%zd)", p2i(r), p2i(r));
1106 return r;
1107 }
1108
1109
1110 BasicLock* frame::get_native_monitor() const {
1111 nmethod* nm = (nmethod*)_cb;
1112 assert(_cb != nullptr && _cb->is_nmethod() && nm->method()->is_native(),
1113 "Should not call this unless it's a native nmethod");
1114 int byte_offset = in_bytes(nm->native_basic_lock_sp_offset());
1115 assert(byte_offset >= 0, "should not see invalid offset");
1116 return (BasicLock*) &sp()[byte_offset / wordSize];
1117 }
1118
1119 oop frame::get_native_receiver() const {
1120 nmethod* nm = (nmethod*)_cb;
1121 assert(_cb != nullptr && _cb->is_nmethod() && nm->method()->is_native(),
1122 "Should not call this unless it's a native nmethod");
1123 int byte_offset = in_bytes(nm->native_receiver_sp_offset());
1124 assert(byte_offset >= 0, "should not see invalid offset");
1125 oop owner = ((oop*) sp())[byte_offset / wordSize];
1126 assert( Universe::heap()->is_in(owner), "bad receiver" );
1127 return owner;
1128 }
1129
1130 void frame::oops_entry_do(OopClosure* f, const RegisterMap* map) const {
1131 assert(map != nullptr, "map must be set");
1132 if (map->include_argument_oops()) {
1133 // must collect argument oops, as nobody else is doing it
1134 Thread *thread = Thread::current();
1135 methodHandle m (thread, entry_frame_call_wrapper()->callee_method());
1136 EntryFrameOopFinder finder(this, m->signature(), m->is_static());
1137 finder.arguments_do(f);
1138 }
1139 // Traverse the Handle Block saved in the entry frame
1140 entry_frame_call_wrapper()->oops_do(f);
1141 }
1142
1143 void frame::oops_upcall_do(OopClosure* f, const RegisterMap* map) const {
1144 assert(map != nullptr, "map must be set");
1145 if (map->include_argument_oops()) {
1146 // Upcall stubs call a MethodHandle impl method of which only the receiver
1147 // is ever an oop.
1148 // Currently we should not be able to get here, since there are no
1149 // safepoints in the one resolve stub we can get into (handle_wrong_method)
1150 // Leave this here as a trap in case we ever do:
1151 ShouldNotReachHere(); // not implemented
1152 }
1153 _cb->as_upcall_stub()->oops_do(f, *this);
1154 }
1155
1156 void frame::oops_do_internal(OopClosure* f, NMethodClosure* cf,
1157 DerivedOopClosure* df, DerivedPointerIterationMode derived_mode,
1158 const RegisterMap* map, bool use_interpreter_oop_map_cache) const {
1159 #ifndef PRODUCT
1160 // simulate GC crash here to dump java thread in error report
1161 guarantee(!CrashGCForDumpingJavaThread, "");
1162 #endif
1163 if (is_interpreted_frame()) {
1164 oops_interpreted_do(f, map, use_interpreter_oop_map_cache);
1165 } else if (is_entry_frame()) {
1166 oops_entry_do(f, map);
1167 } else if (is_upcall_stub_frame()) {
1168 oops_upcall_do(f, map);
1169 } else if (CodeCache::contains(pc())) {
1170 oops_nmethod_do(f, cf, df, derived_mode, map);
1171 } else {
1172 ShouldNotReachHere();
1173 }
1174 }
1175
1176 void frame::nmethod_do(NMethodClosure* cf) const {
1177 if (_cb != nullptr && _cb->is_nmethod()) {
1178 cf->do_nmethod(_cb->as_nmethod());
1179 }
1180 }
1181
1182
1183 // Call f closure on the interpreted Method*s in the stack.
1184 void frame::metadata_do(MetadataClosure* f) const {
1185 ResourceMark rm;
1186 if (is_interpreted_frame()) {
1187 Method* m = this->interpreter_frame_method();
1188 assert(m != nullptr, "expecting a method in this frame");
1189 f->do_metadata(m);
1190 }
1191 }
1192
1193 void frame::verify(const RegisterMap* map) const {
1194 #ifndef PRODUCT
1195 if (TraceCodeBlobStacks) {
1196 tty->print_cr("*** verify");
1197 print_on(tty);
1198 }
1199 #endif
1200
1201 // for now make sure receiver type is correct
1202 if (is_interpreted_frame()) {
1203 Method* method = interpreter_frame_method();
1204 guarantee(method->is_method(), "method is wrong in frame::verify");
1205 if (!method->is_static()) {
1206 // fetch the receiver
1207 oop* p = (oop*) interpreter_frame_local_at(0);
1208 // make sure we have the right receiver type
1209 }
1210 }
1211 #ifdef COMPILER2
1212 assert(DerivedPointerTable::is_empty(), "must be empty before verify");
1213 #endif // COMPILER2
1214
1215 if (map->update_map()) { // The map has to be up-to-date for the current frame
1216 oops_do_internal(&VerifyOopClosure::verify_oop, nullptr, nullptr, DerivedPointerIterationMode::_ignore, map, false);
1217 }
1218 }
1219
1220
1221 #ifdef ASSERT
1222 bool frame::verify_return_pc(address x) {
1223 #ifdef TARGET_ARCH_aarch64
1224 if (!pauth_ptr_is_raw(x)) {
1225 return false;
1226 }
1227 #endif
1228 if (StubRoutines::returns_to_call_stub(x)) {
1229 return true;
1230 }
1231 if (CodeCache::contains(x)) {
1232 return true;
1233 }
1234 if (Interpreter::contains(x)) {
1235 return true;
1236 }
1237 return false;
1238 }
1239 #endif
1240
1241 #ifdef ASSERT
1242 void frame::interpreter_frame_verify_monitor(BasicObjectLock* value) const {
1243 assert(is_interpreted_frame(), "Not an interpreted frame");
1244 // verify that the value is in the right part of the frame
1245 address low_mark = (address) interpreter_frame_monitor_end();
1246 address high_mark = (address) interpreter_frame_monitor_begin();
1247 address current = (address) value;
1248
1249 const int monitor_size = frame::interpreter_frame_monitor_size();
1250 guarantee((high_mark - current) % monitor_size == 0 , "Misaligned top of BasicObjectLock*");
1251 guarantee( high_mark > current , "Current BasicObjectLock* higher than high_mark");
1252
1253 guarantee((current - low_mark) % monitor_size == 0 , "Misaligned bottom of BasicObjectLock*");
1254 guarantee( current >= low_mark , "Current BasicObjectLock* below than low_mark");
1255 }
1256 #endif
1257
1258 #ifndef PRODUCT
1259
1260 // Returns true iff the address p is readable and *(intptr_t*)p != errvalue
1261 extern "C" bool dbg_is_safe(const void* p, intptr_t errvalue);
1262
1263 class FrameValuesOopClosure: public OopClosure, public DerivedOopClosure {
1264 private:
1265 GrowableArray<oop*>* _oops;
1266 GrowableArray<narrowOop*>* _narrow_oops;
1267 GrowableArray<derived_base*>* _base;
1268 GrowableArray<derived_pointer*>* _derived;
1269 NoSafepointVerifier nsv;
1270
1271 public:
1272 FrameValuesOopClosure() {
1273 _oops = new (mtThread) GrowableArray<oop*>(100, mtThread);
1274 _narrow_oops = new (mtThread) GrowableArray<narrowOop*>(100, mtThread);
1275 _base = new (mtThread) GrowableArray<derived_base*>(100, mtThread);
1276 _derived = new (mtThread) GrowableArray<derived_pointer*>(100, mtThread);
1277 }
1278 ~FrameValuesOopClosure() {
1279 delete _oops;
1280 delete _narrow_oops;
1281 delete _base;
1282 delete _derived;
1283 }
1284
1285 virtual void do_oop(oop* p) override { _oops->push(p); }
1286 virtual void do_oop(narrowOop* p) override { _narrow_oops->push(p); }
1287 virtual void do_derived_oop(derived_base* base_loc, derived_pointer* derived_loc) override {
1288 _base->push(base_loc);
1289 _derived->push(derived_loc);
1290 }
1291
1292 bool is_good(oop* p) {
1293 return *p == nullptr || (dbg_is_safe(*p, -1) && dbg_is_safe((*p)->klass_without_asserts(), -1) && oopDesc::is_oop_or_null(*p));
1294 }
1295 void describe(FrameValues& values, int frame_no) {
1296 for (int i = 0; i < _oops->length(); i++) {
1297 oop* p = _oops->at(i);
1298 values.describe(frame_no, (intptr_t*)p, err_msg("oop%s for #%d", is_good(p) ? "" : " (BAD)", frame_no));
1299 }
1300 for (int i = 0; i < _narrow_oops->length(); i++) {
1301 narrowOop* p = _narrow_oops->at(i);
1302 // we can't check for bad compressed oops, as decoding them might crash
1303 values.describe(frame_no, (intptr_t*)p, err_msg("narrow oop for #%d", frame_no));
1304 }
1305 assert(_base->length() == _derived->length(), "should be the same");
1306 for (int i = 0; i < _base->length(); i++) {
1307 derived_base* base = _base->at(i);
1308 derived_pointer* derived = _derived->at(i);
1309 values.describe(frame_no, (intptr_t*)derived, err_msg("derived pointer (base: " INTPTR_FORMAT ") for #%d", p2i(base), frame_no));
1310 }
1311 }
1312 };
1313
1314 class FrameValuesOopMapClosure: public OopMapClosure {
1315 private:
1316 const frame* _fr;
1317 const RegisterMap* _reg_map;
1318 FrameValues& _values;
1319 int _frame_no;
1320
1321 public:
1322 FrameValuesOopMapClosure(const frame* fr, const RegisterMap* reg_map, FrameValues& values, int frame_no)
1323 : _fr(fr), _reg_map(reg_map), _values(values), _frame_no(frame_no) {}
1324
1325 virtual void do_value(VMReg reg, OopMapValue::oop_types type) override {
1326 intptr_t* p = (intptr_t*)_fr->oopmapreg_to_location(reg, _reg_map);
1327 if (p != nullptr && (((intptr_t)p & WordAlignmentMask) == 0)) {
1328 const char* type_name = nullptr;
1329 switch(type) {
1330 case OopMapValue::oop_value: type_name = "oop"; break;
1331 case OopMapValue::narrowoop_value: type_name = "narrow oop"; break;
1332 case OopMapValue::callee_saved_value: type_name = "callee-saved"; break;
1333 case OopMapValue::derived_oop_value: type_name = "derived"; break;
1334 // case OopMapValue::live_value: type_name = "live"; break;
1335 default: break;
1336 }
1337 if (type_name != nullptr) {
1338 _values.describe(_frame_no, p, err_msg("%s for #%d", type_name, _frame_no));
1339 }
1340 }
1341 }
1342 };
1343
1344 // callers need a ResourceMark because of name_and_sig_as_C_string() usage,
1345 // RA allocated string is returned to the caller
1346 void frame::describe(FrameValues& values, int frame_no, const RegisterMap* reg_map, bool top) {
1347 // boundaries: sp and the 'real' frame pointer
1348 values.describe(-1, sp(), err_msg("sp for #%d", frame_no), 0);
1349 if (top) {
1350 values.describe(-1, sp() - 1, err_msg("sp[-1] for #%d", frame_no), 0);
1351 values.describe(-1, sp() - 2, err_msg("sp[-2] for #%d", frame_no), 0);
1352 }
1353
1354 intptr_t* frame_pointer = real_fp(); // Note: may differ from fp()
1355
1356 // print frame info at the highest boundary
1357 intptr_t* info_address = MAX2(sp(), frame_pointer);
1358
1359 if (info_address != frame_pointer) {
1360 // print frame_pointer explicitly if not marked by the frame info
1361 values.describe(-1, frame_pointer, err_msg("frame pointer for #%d", frame_no), 1);
1362 }
1363
1364 if (is_entry_frame() || is_compiled_frame() || is_interpreted_frame() || is_native_frame()) {
1365 // Label values common to most frames
1366 values.describe(-1, unextended_sp(), err_msg("unextended_sp for #%d", frame_no), 0);
1367 }
1368
1369 if (is_interpreted_frame()) {
1370 Method* m = interpreter_frame_method();
1371 int bci = interpreter_frame_bci();
1372 InterpreterCodelet* desc = Interpreter::codelet_containing(pc());
1373
1374 // Label the method and current bci
1375 values.describe(-1, info_address,
1376 FormatBuffer<1024>("#%d method %s @ %d", frame_no, m->name_and_sig_as_C_string(), bci), 3);
1377 if (desc != nullptr) {
1378 values.describe(-1, info_address, err_msg("- %s codelet: %s",
1379 desc->bytecode() >= 0 ? Bytecodes::name(desc->bytecode()) : "",
1380 desc->description() != nullptr ? desc->description() : "?"), 2);
1381 }
1382 values.describe(-1, info_address,
1383 err_msg("- %d locals %d max stack", m->max_locals(), m->max_stack()), 2);
1384 // return address will be emitted by caller in describe_pd
1385 // values.describe(frame_no, (intptr_t*)sender_pc_addr(), Continuation::is_return_barrier_entry(*sender_pc_addr()) ? "return address (return barrier)" : "return address");
1386
1387 if (m->max_locals() > 0) {
1388 intptr_t* l0 = interpreter_frame_local_at(0);
1389 intptr_t* ln = interpreter_frame_local_at(m->max_locals() - 1);
1390 values.describe(-1, MAX2(l0, ln), err_msg("locals for #%d", frame_no), 2);
1391 // Report each local and mark as owned by this frame
1392 for (int l = 0; l < m->max_locals(); l++) {
1393 intptr_t* l0 = interpreter_frame_local_at(l);
1394 values.describe(frame_no, l0, err_msg("local %d", l), 1);
1395 }
1396 }
1397
1398 if (interpreter_frame_monitor_begin() != interpreter_frame_monitor_end()) {
1399 values.describe(frame_no, (intptr_t*)interpreter_frame_monitor_begin(), "monitors begin");
1400 values.describe(frame_no, (intptr_t*)interpreter_frame_monitor_end(), "monitors end");
1401 }
1402
1403 // Compute the actual expression stack size
1404 InterpreterOopMap mask;
1405 OopMapCache::compute_one_oop_map(methodHandle(Thread::current(), m), bci, &mask);
1406 intptr_t* tos = nullptr;
1407 // Report each stack element and mark as owned by this frame
1408 for (int e = 0; e < mask.expression_stack_size(); e++) {
1409 tos = MAX2(tos, interpreter_frame_expression_stack_at(e));
1410 values.describe(frame_no, interpreter_frame_expression_stack_at(e),
1411 err_msg("stack %d", e), 1);
1412 }
1413 if (tos != nullptr) {
1414 values.describe(-1, tos, err_msg("expression stack for #%d", frame_no), 2);
1415 }
1416
1417 if (reg_map != nullptr) {
1418 FrameValuesOopClosure oopsFn;
1419 oops_do(&oopsFn, nullptr, &oopsFn, reg_map);
1420 oopsFn.describe(values, frame_no);
1421 }
1422 } else if (is_entry_frame()) {
1423 // For now just label the frame
1424 values.describe(-1, info_address, err_msg("#%d entry frame", frame_no), 2);
1425 } else if (is_compiled_frame()) {
1426 // For now just label the frame
1427 nmethod* nm = cb()->as_nmethod();
1428 values.describe(-1, info_address,
1429 FormatBuffer<1024>("#%d nmethod (%s %d) " INTPTR_FORMAT " for method J %s%s", frame_no,
1430 nm->is_compiled_by_c1() ? "c1" : "c2", nm->frame_size(), p2i(nm),
1431 nm->method()->name_and_sig_as_C_string(),
1432 (_deopt_state == is_deoptimized) ?
1433 " (deoptimized)" :
1434 ((_deopt_state == unknown) ? " (state unknown)" : "")),
1435 3);
1436
1437 { // mark arguments (see nmethod::print_nmethod_labels)
1438 Method* m = nm->method();
1439
1440 CompiledEntrySignature ces(m);
1441 ces.compute_calling_conventions(false);
1442 const GrowableArray<SigEntry>* sig_cc = nm->is_compiled_by_c2() ? ces.sig_cc() : ces.sig();
1443 const VMRegPair* regs = nm->is_compiled_by_c2() ? ces.regs_cc() : ces.regs();
1444
1445 int stack_slot_offset = nm->frame_size() * wordSize; // offset, in bytes, to caller sp
1446 int out_preserve = SharedRuntime::out_preserve_stack_slots();
1447 int sig_index = 0;
1448 int arg_index = (m->is_static() ? 0 : -1);
1449 for (ExtendedSignature sig = ExtendedSignature(sig_cc, SigEntryFilter()); !sig.at_end(); ++sig) {
1450 bool at_this = (arg_index == -1);
1451 BasicType t = (*sig)._bt;
1452 VMReg fst = regs[sig_index].first();
1453 if (fst->is_stack()) {
1454 assert(((int)fst->reg2stack()) >= 0, "reg2stack: %d", fst->reg2stack());
1455 int offset = (fst->reg2stack() + out_preserve) * VMRegImpl::stack_slot_size + stack_slot_offset;
1456 intptr_t* stack_address = (intptr_t*)((address)unextended_sp() + offset);
1457 if (at_this) {
1458 values.describe(frame_no, stack_address, err_msg("this for #%d", frame_no), 1);
1459 } else {
1460 values.describe(frame_no, stack_address, err_msg("param %d %s for #%d", arg_index, type2name(t), frame_no), 1);
1461 }
1462 }
1463 sig_index += type2size[t];
1464 arg_index += 1;
1465 }
1466 }
1467
1468 if (reg_map != nullptr && is_java_frame()) {
1469 int scope_no = 0;
1470 for (ScopeDesc* scope = nm->scope_desc_at(pc()); scope != nullptr; scope = scope->sender(), scope_no++) {
1471 Method* m = scope->method();
1472 int bci = scope->bci();
1473 values.describe(-1, info_address, err_msg("- #%d scope %s @ %d", scope_no, m->name_and_sig_as_C_string(), bci), 2);
1474
1475 { // mark locals
1476 GrowableArray<ScopeValue*>* scvs = scope->locals();
1477 int scvs_length = scvs != nullptr ? scvs->length() : 0;
1478 for (int i = 0; i < scvs_length; i++) {
1479 intptr_t* stack_address = (intptr_t*)StackValue::stack_value_address(this, reg_map, scvs->at(i));
1480 if (stack_address != nullptr) {
1481 values.describe(frame_no, stack_address, err_msg("local %d for #%d (scope %d)", i, frame_no, scope_no), 1);
1482 }
1483 }
1484 }
1485 { // mark expression stack
1486 GrowableArray<ScopeValue*>* scvs = scope->expressions();
1487 int scvs_length = scvs != nullptr ? scvs->length() : 0;
1488 for (int i = 0; i < scvs_length; i++) {
1489 intptr_t* stack_address = (intptr_t*)StackValue::stack_value_address(this, reg_map, scvs->at(i));
1490 if (stack_address != nullptr) {
1491 values.describe(frame_no, stack_address, err_msg("stack %d for #%d (scope %d)", i, frame_no, scope_no), 1);
1492 }
1493 }
1494 }
1495 }
1496
1497 FrameValuesOopClosure oopsFn;
1498 oops_do(&oopsFn, nullptr, &oopsFn, reg_map);
1499 oopsFn.describe(values, frame_no);
1500
1501 if (oop_map() != nullptr) {
1502 FrameValuesOopMapClosure valuesFn(this, reg_map, values, frame_no);
1503 // also OopMapValue::live_value ??
1504 oop_map()->all_type_do(this, OopMapValue::callee_saved_value, &valuesFn);
1505 }
1506 }
1507 } else if (is_native_frame()) {
1508 // For now just label the frame
1509 nmethod* nm = cb()->as_nmethod_or_null();
1510 values.describe(-1, info_address,
1511 FormatBuffer<1024>("#%d nmethod " INTPTR_FORMAT " for native method %s", frame_no,
1512 p2i(nm), nm->method()->name_and_sig_as_C_string()), 2);
1513 if (nm->method()->is_continuation_enter_intrinsic()) {
1514 ContinuationEntry* ce = Continuation::get_continuation_entry_for_entry_frame(reg_map->thread(), *this); // (ContinuationEntry*)unextended_sp();
1515 ce->describe(values, frame_no);
1516 }
1517 } else {
1518 // provide default info if not handled before
1519 char *info = (char *) "special frame";
1520 if ((_cb != nullptr) &&
1521 (_cb->name() != nullptr)) {
1522 info = (char *)_cb->name();
1523 }
1524 values.describe(-1, info_address, err_msg("#%d <%s>", frame_no, info), 2);
1525 }
1526
1527 // platform dependent additional data
1528 describe_pd(values, frame_no);
1529 }
1530
1531 #endif
1532
1533 /**
1534 * Gets the caller frame of `fr` for thread `t`.
1535 *
1536 * @returns an invalid frame (i.e. fr.pc() === 0) if the caller cannot be obtained
1537 */
1538 frame frame::next_frame(frame fr, Thread* t) {
1539 // Compiled code may use EBP register on x86 so it looks like
1540 // non-walkable C frame. Use frame.sender() for java frames.
1541 frame invalid;
1542 if (t != nullptr && t->is_Java_thread()) {
1543 // Catch very first native frame by using stack address.
1544 // For JavaThread stack_base and stack_size should be set.
1545 if (!t->is_in_full_stack((address)(fr.real_fp() + 1))) {
1546 return invalid;
1547 }
1548 if (fr.is_interpreted_frame() || (fr.cb() != nullptr && fr.cb()->frame_size() > 0)) {
1549 RegisterMap map(JavaThread::cast(t),
1550 RegisterMap::UpdateMap::skip,
1551 RegisterMap::ProcessFrames::include,
1552 RegisterMap::WalkContinuation::skip); // No update
1553 return fr.sender(&map);
1554 } else {
1555 // is_first_C_frame() does only simple checks for frame pointer,
1556 // it will pass if java compiled code has a pointer in EBP.
1557 if (os::is_first_C_frame(&fr)) return invalid;
1558 return os::get_sender_for_C_frame(&fr);
1559 }
1560 } else {
1561 if (os::is_first_C_frame(&fr)) return invalid;
1562 return os::get_sender_for_C_frame(&fr);
1563 }
1564 }
1565
1566 #ifndef PRODUCT
1567
1568 void FrameValues::describe(int owner, intptr_t* location, const char* description, int priority) {
1569 FrameValue fv;
1570 fv.location = location;
1571 fv.owner = owner;
1572 fv.priority = priority;
1573 fv.description = NEW_RESOURCE_ARRAY(char, strlen(description) + 1);
1574 strcpy(fv.description, description);
1575 _values.append(fv);
1576 }
1577
1578
1579 #ifdef ASSERT
1580 void FrameValues::validate() {
1581 _values.sort(compare);
1582 bool error = false;
1583 FrameValue prev;
1584 prev.owner = -1;
1585 for (int i = _values.length() - 1; i >= 0; i--) {
1586 FrameValue fv = _values.at(i);
1587 if (fv.owner == -1) continue;
1588 if (prev.owner == -1) {
1589 prev = fv;
1590 continue;
1591 }
1592 if (prev.location == fv.location) {
1593 if (fv.owner != prev.owner) {
1594 tty->print_cr("overlapping storage");
1595 tty->print_cr(" " INTPTR_FORMAT ": " INTPTR_FORMAT " %s", p2i(prev.location), *prev.location, prev.description);
1596 tty->print_cr(" " INTPTR_FORMAT ": " INTPTR_FORMAT " %s", p2i(fv.location), *fv.location, fv.description);
1597 error = true;
1598 }
1599 } else {
1600 prev = fv;
1601 }
1602 }
1603 // if (error) { tty->cr(); print_on(static_cast<JavaThread*>(nullptr), tty); }
1604 assert(!error, "invalid layout");
1605 }
1606 #endif // ASSERT
1607
1608 void FrameValues::print_on(JavaThread* thread, outputStream* st) {
1609 _values.sort(compare);
1610
1611 // Sometimes values like the fp can be invalid values if the
1612 // register map wasn't updated during the walk. Trim out values
1613 // that aren't actually in the stack of the thread.
1614 int min_index = 0;
1615 int max_index = _values.length() - 1;
1616 intptr_t* v0 = _values.at(min_index).location;
1617 intptr_t* v1 = _values.at(max_index).location;
1618
1619 if (thread != nullptr) {
1620 if (thread == Thread::current()) {
1621 while (!thread->is_in_live_stack((address)v0)) v0 = _values.at(++min_index).location;
1622 while (!thread->is_in_live_stack((address)v1)) v1 = _values.at(--max_index).location;
1623 } else {
1624 while (!thread->is_in_full_stack((address)v0)) v0 = _values.at(++min_index).location;
1625 while (!thread->is_in_full_stack((address)v1)) v1 = _values.at(--max_index).location;
1626 }
1627 }
1628
1629 print_on(st, min_index, max_index, v0, v1);
1630 }
1631
1632 void FrameValues::print_on(stackChunkOop chunk, outputStream* st) {
1633 _values.sort(compare);
1634
1635 intptr_t* start = chunk->start_address();
1636 intptr_t* end = chunk->end_address() + 1;
1637
1638 int min_index = 0;
1639 int max_index = _values.length() - 1;
1640 intptr_t* v0 = _values.at(min_index).location;
1641 intptr_t* v1 = _values.at(max_index).location;
1642 while (!(start <= v0 && v0 <= end)) v0 = _values.at(++min_index).location;
1643 while (!(start <= v1 && v1 <= end)) v1 = _values.at(--max_index).location;
1644
1645 print_on(st, min_index, max_index, v0, v1);
1646 }
1647
1648 void FrameValues::print_on(outputStream* st, int min_index, int max_index, intptr_t* v0, intptr_t* v1) {
1649 intptr_t* min = MIN2(v0, v1);
1650 intptr_t* max = MAX2(v0, v1);
1651 intptr_t* cur = max;
1652 intptr_t* last = nullptr;
1653 intptr_t* fp = nullptr;
1654 for (int i = max_index; i >= min_index; i--) {
1655 FrameValue fv = _values.at(i);
1656 while (cur > fv.location) {
1657 st->print_cr(" " INTPTR_FORMAT ": " INTPTR_FORMAT, p2i(cur), *cur);
1658 cur--;
1659 }
1660 if (last == fv.location) {
1661 const char* spacer = " " LP64_ONLY(" ");
1662 st->print_cr(" %s %s %s", spacer, spacer, fv.description);
1663 } else {
1664 if (*fv.description == '#' && isdigit(fv.description[1])) {
1665 // The fv.description string starting with a '#' is the line for the
1666 // saved frame pointer eg. "#10 method java.lang.invoke.LambdaForm..."
1667 // basicaly means frame 10.
1668 fp = fv.location;
1669 }
1670 // To print a fp-relative value:
1671 // 1. The content of *fv.location must be such that we think it's a
1672 // fp-relative number, i.e [-100..100].
1673 // 2. We must have found the frame pointer.
1674 // 3. The line can not be the line for the saved frame pointer.
1675 // 4. Recognize it as being part of the "fixed frame".
1676 if (*fv.location != 0 && *fv.location > -100 && *fv.location < 100
1677 && fp != nullptr && *fv.description != '#'
1678 #if !defined(PPC64)
1679 && (strncmp(fv.description, "interpreter_frame_", 18) == 0 || strstr(fv.description, " method "))
1680 #else // !defined(PPC64)
1681 && (strcmp(fv.description, "sender_sp") == 0 || strcmp(fv.description, "top_frame_sp") == 0 ||
1682 strcmp(fv.description, "esp") == 0 || strcmp(fv.description, "monitors") == 0 ||
1683 strcmp(fv.description, "locals") == 0 || strstr(fv.description, " method "))
1684 #endif //!defined(PPC64)
1685 ) {
1686 st->print_cr(" " INTPTR_FORMAT ": " INTPTR_FORMAT " %-32s (relativized: fp%+d)",
1687 p2i(fv.location), p2i(&fp[*fv.location]), fv.description, (int)*fv.location);
1688 } else {
1689 st->print_cr(" " INTPTR_FORMAT ": " INTPTR_FORMAT " %s", p2i(fv.location), *fv.location, fv.description);
1690 }
1691 last = fv.location;
1692 cur--;
1693 }
1694 }
1695 }
1696
1697 #endif // ndef PRODUCT