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