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