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
235 // type testers
236 bool frame::is_ignored_frame() const {
237 return false; // FIXME: some LambdaForm frames should be ignored
238 }
239
240 bool frame::is_native_frame() const {
241 return (_cb != nullptr &&
242 _cb->is_nmethod() &&
243 ((nmethod*)_cb)->is_native_method());
244 }
245
246 bool frame::is_java_frame() const {
247 if (is_interpreted_frame()) return true;
248 if (is_compiled_frame()) return true;
249 return false;
250 }
251
252 bool frame::is_runtime_frame() const {
253 return (_cb != nullptr && _cb->is_runtime_stub());
254 }
255
256 bool frame::is_safepoint_blob_frame() const {
257 return (_cb != nullptr && _cb->is_safepoint_stub());
258 }
259
260 // testers
261
262 bool frame::is_first_java_frame() const {
263 RegisterMap map(JavaThread::current(),
264 RegisterMap::UpdateMap::skip,
265 RegisterMap::ProcessFrames::include,
266 RegisterMap::WalkContinuation::skip); // No update
267 frame s;
268 for (s = sender(&map); !(s.is_java_frame() || s.is_first_frame()); s = s.sender(&map));
269 return s.is_first_frame();
270 }
271
272 bool frame::is_first_vthread_frame(JavaThread* thread) const {
273 return Continuation::is_continuation_enterSpecial(*this)
274 && Continuation::get_continuation_entry_for_entry_frame(thread, *this)->is_virtual_thread();
275 }
276
277 bool frame::entry_frame_is_first() const {
278 return entry_frame_call_wrapper()->is_first_frame();
279 }
280
281 JavaCallWrapper* frame::entry_frame_call_wrapper_if_safe(JavaThread* thread) const {
282 JavaCallWrapper** jcw = entry_frame_call_wrapper_addr();
283 address addr = (address) jcw;
284
285 // addr must be within the usable part of the stack
286 if (thread->is_in_usable_stack(addr)) {
287 return *jcw;
288 }
289
290 return nullptr;
291 }
292
293 bool frame::is_entry_frame_valid(JavaThread* thread) const {
294 // Validate the JavaCallWrapper an entry frame must have
295 address jcw = (address)entry_frame_call_wrapper();
296 if (!thread->is_in_stack_range_excl(jcw, (address)fp())) {
297 return false;
298 }
299
300 // Validate sp saved in the java frame anchor
301 JavaFrameAnchor* jfa = entry_frame_call_wrapper()->anchor();
302 return (jfa->last_Java_sp() > sp());
303 }
304
305 Method* frame::safe_interpreter_frame_method() const {
306 Method** m_addr = interpreter_frame_method_addr();
307 if (m_addr == nullptr) {
308 return nullptr;
309 }
310 return (Method*) SafeFetchN((intptr_t*) m_addr, 0);
311 }
312
313 bool frame::should_be_deoptimized() const {
314 if (_deopt_state == is_deoptimized ||
315 !is_compiled_frame() ) return false;
316 assert(_cb != nullptr && _cb->is_nmethod(), "must be an nmethod");
317 nmethod* nm = _cb->as_nmethod();
318 LogTarget(Debug, dependencies) lt;
319 if (lt.is_enabled()) {
320 LogStream ls(<);
321 ls.print("checking (%s) ", nm->is_marked_for_deoptimization() ? "true" : "false");
322 nm->print_value_on(&ls);
323 ls.cr();
324 }
325
326 if( !nm->is_marked_for_deoptimization() )
327 return false;
328
329 // If at the return point, then the frame has already been popped, and
330 // only the return needs to be executed. Don't deoptimize here.
331 return !nm->is_at_poll_return(pc());
332 }
333
334 bool frame::can_be_deoptimized() const {
335 if (!is_compiled_frame()) return false;
336 nmethod* nm = _cb->as_nmethod();
337
338 if(!nm->can_be_deoptimized())
339 return false;
340
341 return !nm->is_at_poll_return(pc());
342 }
343
344 void frame::deoptimize(JavaThread* thread) {
345 assert(thread == nullptr
346 || (thread->frame_anchor()->has_last_Java_frame() &&
347 thread->frame_anchor()->walkable()), "must be");
348 // Schedule deoptimization of an nmethod activation with this frame.
349 assert(_cb != nullptr && _cb->is_nmethod(), "must be");
350
351 // If the call site is a MethodHandle call site use the MH deopt handler.
352 nmethod* nm = _cb->as_nmethod();
353 address deopt = nm->is_method_handle_return(pc()) ?
354 nm->deopt_mh_handler_begin() :
355 nm->deopt_handler_begin();
356
357 NativePostCallNop* inst = nativePostCallNop_at(pc());
358
359 // Save the original pc before we patch in the new one
360 nm->set_original_pc(this, pc());
361 patch_pc(thread, deopt);
362 assert(is_deoptimized_frame(), "must be");
363
364 #ifdef ASSERT
365 if (thread != nullptr) {
366 frame check = thread->last_frame();
367 if (is_older(check.id())) {
368 RegisterMap map(thread,
369 RegisterMap::UpdateMap::skip,
370 RegisterMap::ProcessFrames::include,
371 RegisterMap::WalkContinuation::skip);
372 while (id() != check.id()) {
373 check = check.sender(&map);
374 }
375 assert(check.is_deoptimized_frame(), "missed deopt");
376 }
377 }
378 #endif // ASSERT
379 }
380
381 frame frame::java_sender() const {
382 RegisterMap map(JavaThread::current(),
383 RegisterMap::UpdateMap::skip,
384 RegisterMap::ProcessFrames::include,
385 RegisterMap::WalkContinuation::skip);
386 frame s;
387 for (s = sender(&map); !(s.is_java_frame() || s.is_first_frame()); s = s.sender(&map)) ;
388 guarantee(s.is_java_frame(), "tried to get caller of first java frame");
389 return s;
390 }
391
392 frame frame::real_sender(RegisterMap* map) const {
393 frame result = sender(map);
394 while (result.is_runtime_frame() ||
395 result.is_ignored_frame()) {
396 result = result.sender(map);
397 }
398 return result;
399 }
400
401 // Interpreter frames
402
403
404 Method* frame::interpreter_frame_method() const {
405 assert(is_interpreted_frame(), "interpreted frame expected");
406 Method* m = *interpreter_frame_method_addr();
407 assert(m->is_method(), "not a Method*");
408 return m;
409 }
410
411 void frame::interpreter_frame_set_method(Method* method) {
412 assert(is_interpreted_frame(), "interpreted frame expected");
413 *interpreter_frame_method_addr() = method;
414 }
415
416 void frame::interpreter_frame_set_mirror(oop mirror) {
417 assert(is_interpreted_frame(), "interpreted frame expected");
418 *interpreter_frame_mirror_addr() = mirror;
419 }
420
421 jint frame::interpreter_frame_bci() const {
422 assert(is_interpreted_frame(), "interpreted frame expected");
423 address bcp = interpreter_frame_bcp();
424 return interpreter_frame_method()->bci_from(bcp);
425 }
426
427 address frame::interpreter_frame_bcp() const {
428 assert(is_interpreted_frame(), "interpreted frame expected");
429 address bcp = (address)*interpreter_frame_bcp_addr();
430 return interpreter_frame_method()->bcp_from(bcp);
431 }
432
433 void frame::interpreter_frame_set_bcp(address bcp) {
434 assert(is_interpreted_frame(), "interpreted frame expected");
435 *interpreter_frame_bcp_addr() = (intptr_t)bcp;
436 }
437
438 address frame::interpreter_frame_mdp() const {
439 assert(ProfileInterpreter, "must be profiling interpreter");
440 assert(is_interpreted_frame(), "interpreted frame expected");
441 return (address)*interpreter_frame_mdp_addr();
442 }
443
444 void frame::interpreter_frame_set_mdp(address mdp) {
445 assert(is_interpreted_frame(), "interpreted frame expected");
446 assert(ProfileInterpreter, "must be profiling interpreter");
447 *interpreter_frame_mdp_addr() = (intptr_t)mdp;
448 }
449
450 BasicObjectLock* frame::next_monitor_in_interpreter_frame(BasicObjectLock* current) const {
451 assert(is_interpreted_frame(), "Not an interpreted frame");
452 #ifdef ASSERT
453 interpreter_frame_verify_monitor(current);
454 #endif
455 BasicObjectLock* next = (BasicObjectLock*) (((intptr_t*) current) + interpreter_frame_monitor_size());
456 return next;
457 }
458
459 BasicObjectLock* frame::previous_monitor_in_interpreter_frame(BasicObjectLock* current) const {
460 assert(is_interpreted_frame(), "Not an interpreted frame");
461 #ifdef ASSERT
462 // // This verification needs to be checked before being enabled
463 // interpreter_frame_verify_monitor(current);
464 #endif
465 BasicObjectLock* previous = (BasicObjectLock*) (((intptr_t*) current) - interpreter_frame_monitor_size());
466 return previous;
467 }
468
469 // Interpreter locals and expression stack locations.
470
471 intptr_t* frame::interpreter_frame_local_at(int index) const {
472 const int n = Interpreter::local_offset_in_bytes(index)/wordSize;
473 intptr_t* first = interpreter_frame_locals();
474 return &(first[n]);
475 }
476
477 intptr_t* frame::interpreter_frame_expression_stack_at(jint offset) const {
478 const int i = offset * interpreter_frame_expression_stack_direction();
479 const int n = i * Interpreter::stackElementWords;
480 return &(interpreter_frame_expression_stack()[n]);
481 }
482
483 jint frame::interpreter_frame_expression_stack_size() const {
484 // Number of elements on the interpreter expression stack
485 // Callers should span by stackElementWords
486 int element_size = Interpreter::stackElementWords;
487 size_t stack_size = 0;
488 if (frame::interpreter_frame_expression_stack_direction() < 0) {
489 stack_size = (interpreter_frame_expression_stack() -
490 interpreter_frame_tos_address() + 1)/element_size;
491 } else {
492 stack_size = (interpreter_frame_tos_address() -
493 interpreter_frame_expression_stack() + 1)/element_size;
494 }
495 assert(stack_size <= (size_t)max_jint, "stack size too big");
496 return (jint)stack_size;
497 }
498
499 // (frame::interpreter_frame_sender_sp accessor is in frame_<arch>.cpp)
500
501 const char* frame::print_name() const {
502 if (is_native_frame()) return "Native";
503 if (is_interpreted_frame()) return "Interpreted";
504 if (is_compiled_frame()) {
505 if (is_deoptimized_frame()) return "Deoptimized";
506 return "Compiled";
507 }
508 if (sp() == nullptr) return "Empty";
509 return "C";
510 }
511
512 void frame::print_value_on(outputStream* st) const {
513 NOT_PRODUCT(address begin = pc()-40;)
514 NOT_PRODUCT(address end = nullptr;)
515
516 st->print("%s frame (sp=" INTPTR_FORMAT " unextended sp=" INTPTR_FORMAT, print_name(), p2i(sp()), p2i(unextended_sp()));
517 if (sp() != nullptr)
518 st->print(", fp=" INTPTR_FORMAT ", real_fp=" INTPTR_FORMAT ", pc=" INTPTR_FORMAT,
519 p2i(fp()), p2i(real_fp()), p2i(pc()));
520 st->print_cr(")");
521
522 if (StubRoutines::contains(pc())) {
523 StubCodeDesc* desc = StubCodeDesc::desc_for(pc());
524 st->print("~Stub::%s", desc->name());
525 NOT_PRODUCT(begin = desc->begin(); end = desc->end();)
526 } else if (Interpreter::contains(pc())) {
527 InterpreterCodelet* desc = Interpreter::codelet_containing(pc());
528 if (desc != nullptr) {
529 st->print("~");
530 desc->print_on(st);
531 NOT_PRODUCT(begin = desc->code_begin(); end = desc->code_end();)
532 } else {
533 st->print("~interpreter");
534 }
535 }
536
537 #ifndef PRODUCT
538 if (_cb != nullptr) {
539 st->print(" ");
540 _cb->print_value_on(st);
541 if (end == nullptr) {
542 begin = _cb->code_begin();
543 end = _cb->code_end();
544 }
545 }
546 if (WizardMode && Verbose) Disassembler::decode(begin, end);
547 #endif
548 }
549
550 void frame::print_on(outputStream* st) const {
551 print_value_on(st);
552 if (is_interpreted_frame()) {
553 interpreter_frame_print_on(st);
554 }
555 }
556
557 void frame::interpreter_frame_print_on(outputStream* st) const {
558 #ifndef PRODUCT
559 assert(is_interpreted_frame(), "Not an interpreted frame");
560 jint i;
561 for (i = 0; i < interpreter_frame_method()->max_locals(); i++ ) {
562 intptr_t x = *interpreter_frame_local_at(i);
563 st->print(" - local [" INTPTR_FORMAT "]", x);
564 st->fill_to(23);
565 st->print_cr("; #%d", i);
566 }
567 for (i = interpreter_frame_expression_stack_size() - 1; i >= 0; --i ) {
568 intptr_t x = *interpreter_frame_expression_stack_at(i);
569 st->print(" - stack [" INTPTR_FORMAT "]", x);
570 st->fill_to(23);
571 st->print_cr("; #%d", i);
572 }
573 // locks for synchronization
574 for (BasicObjectLock* current = interpreter_frame_monitor_end();
575 current < interpreter_frame_monitor_begin();
576 current = next_monitor_in_interpreter_frame(current)) {
577 st->print(" - obj [%s", current->obj() == nullptr ? "null" : "");
578 oop obj = current->obj();
579 if (obj != nullptr) {
580 if (!is_heap_frame()) {
581 obj->print_value_on(st);
582 } else {
583 // Might be an invalid oop. We don't have the
584 // stackChunk to correct it so just print address.
585 st->print(INTPTR_FORMAT, p2i(obj));
586 }
587 }
588 st->print_cr("]");
589 st->print(" - lock [");
590 if (!is_heap_frame()) {
591 current->lock()->print_on(st, obj);
592 }
593 st->print_cr("]");
594 }
595 // monitor
596 st->print_cr(" - monitor[" INTPTR_FORMAT "]", p2i(interpreter_frame_monitor_begin()));
597 // bcp
598 st->print(" - bcp [" INTPTR_FORMAT "]", p2i(interpreter_frame_bcp()));
599 st->fill_to(23);
600 st->print_cr("; @%d", interpreter_frame_bci());
601 // locals
602 st->print_cr(" - locals [" INTPTR_FORMAT "]", p2i(interpreter_frame_local_at(0)));
603 // method
604 st->print(" - method [" INTPTR_FORMAT "]", p2i(interpreter_frame_method()));
605 st->fill_to(23);
606 st->print("; ");
607 interpreter_frame_method()->print_name(st);
608 st->cr();
609 #endif
610 }
611
612 // Print whether the frame is in the VM or OS indicating a HotSpot problem.
613 // Otherwise, it's likely a bug in the native library that the Java code calls,
614 // hopefully indicating where to submit bugs.
615 void frame::print_C_frame(outputStream* st, char* buf, int buflen, address pc) {
616 // C/C++ frame
617 bool in_vm = os::address_is_in_vm(pc);
618 st->print(in_vm ? "V" : "C");
619
620 int offset;
621 bool found;
622
623 if (buf == nullptr || buflen < 1) return;
624 // libname
625 buf[0] = '\0';
626 found = os::dll_address_to_library_name(pc, buf, buflen, &offset);
627 if (found && buf[0] != '\0') {
628 // skip directory names
629 const char *p1, *p2;
630 p1 = buf;
631 int len = (int)strlen(os::file_separator());
632 while ((p2 = strstr(p1, os::file_separator())) != nullptr) p1 = p2 + len;
633 st->print(" [%s+0x%x]", p1, offset);
634 } else {
635 st->print(" " PTR_FORMAT, p2i(pc));
636 }
637
638 found = os::dll_address_to_function_name(pc, buf, buflen, &offset);
639 if (found) {
640 st->print(" %s+0x%x", buf, offset);
641 }
642 }
643
644 // frame::print_on_error() is called by fatal error handler. Notice that we may
645 // crash inside this function if stack frame is corrupted. The fatal error
646 // handler can catch and handle the crash. Here we assume the frame is valid.
647 //
648 // First letter indicates type of the frame:
649 // J: Java frame (compiled)
650 // j: Java frame (interpreted)
651 // V: VM frame (C/C++)
652 // v: Other frames running VM generated code (e.g. stubs, adapters, etc.)
653 // C: C/C++ frame
654 //
655 // We don't need detailed frame type as that in frame::print_name(). "C"
656 // suggests the problem is in user lib; everything else is likely a VM bug.
657
658 void frame::print_on_error(outputStream* st, char* buf, int buflen, bool verbose) const {
659 if (_cb != nullptr) {
660 if (Interpreter::contains(pc())) {
661 Method* m = this->interpreter_frame_method();
662 if (m != nullptr) {
663 m->name_and_sig_as_C_string(buf, buflen);
664 st->print("j %s", buf);
665 st->print("+%d", this->interpreter_frame_bci());
666 ModuleEntry* module = m->method_holder()->module();
667 if (module->is_named()) {
668 module->name()->as_C_string(buf, buflen);
669 st->print(" %s", buf);
670 if (module->version() != nullptr) {
671 module->version()->as_C_string(buf, buflen);
672 st->print("@%s", buf);
673 }
674 }
675 } else {
676 st->print("j " PTR_FORMAT, p2i(pc()));
677 }
678 } else if (StubRoutines::contains(pc())) {
679 StubCodeDesc* desc = StubCodeDesc::desc_for(pc());
680 if (desc != nullptr) {
681 st->print("v ~StubRoutines::%s " PTR_FORMAT, desc->name(), p2i(pc()));
682 } else {
683 st->print("v ~StubRoutines::" PTR_FORMAT, p2i(pc()));
684 }
685 } else if (_cb->is_buffer_blob()) {
686 st->print("v ~BufferBlob::%s " PTR_FORMAT, ((BufferBlob *)_cb)->name(), p2i(pc()));
687 } else if (_cb->is_nmethod()) {
688 nmethod* nm = _cb->as_nmethod();
689 Method* m = nm->method();
690 if (m != nullptr) {
691 st->print("J %d%s", nm->compile_id(), (nm->is_osr_method() ? "%" : ""));
692 st->print(" %s", nm->compiler_name());
693 m->name_and_sig_as_C_string(buf, buflen);
694 st->print(" %s", buf);
695 ModuleEntry* module = m->method_holder()->module();
696 if (module->is_named()) {
697 module->name()->as_C_string(buf, buflen);
698 st->print(" %s", buf);
699 if (module->version() != nullptr) {
700 module->version()->as_C_string(buf, buflen);
701 st->print("@%s", buf);
702 }
703 }
704 st->print(" (%d bytes) @ " PTR_FORMAT " [" PTR_FORMAT "+" INTPTR_FORMAT "]",
705 m->code_size(), p2i(_pc), p2i(_cb->code_begin()), _pc - _cb->code_begin());
706 #if INCLUDE_JVMCI
707 const char* jvmciName = nm->jvmci_name();
708 if (jvmciName != nullptr) {
709 st->print(" (%s)", jvmciName);
710 }
711 #endif
712 } else {
713 st->print("J " PTR_FORMAT, p2i(pc()));
714 }
715 } else if (_cb->is_runtime_stub()) {
716 st->print("v ~RuntimeStub::%s " PTR_FORMAT, ((RuntimeStub *)_cb)->name(), p2i(pc()));
717 } else if (_cb->is_deoptimization_stub()) {
718 st->print("v ~DeoptimizationBlob " PTR_FORMAT, p2i(pc()));
719 } else if (_cb->is_exception_stub()) {
720 st->print("v ~ExceptionBlob " PTR_FORMAT, p2i(pc()));
721 } else if (_cb->is_safepoint_stub()) {
722 st->print("v ~SafepointBlob " PTR_FORMAT, p2i(pc()));
723 } else if (_cb->is_adapter_blob()) {
724 st->print("v ~AdapterBlob " PTR_FORMAT, p2i(pc()));
725 } else if (_cb->is_vtable_blob()) {
726 st->print("v ~VtableBlob " PTR_FORMAT, p2i(pc()));
727 } else if (_cb->is_method_handles_adapter_blob()) {
728 st->print("v ~MethodHandlesAdapterBlob " PTR_FORMAT, p2i(pc()));
729 } else if (_cb->is_uncommon_trap_stub()) {
730 st->print("v ~UncommonTrapBlob " PTR_FORMAT, p2i(pc()));
731 } else if (_cb->is_upcall_stub()) {
732 st->print("v ~UpcallStub::%s " PTR_FORMAT, _cb->name(), 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 template <typename RegisterMapT>
892 void frame::oops_interpreted_do(OopClosure* f, const RegisterMapT* map, bool query_oop_map_cache) const {
893 assert(is_interpreted_frame(), "Not an interpreted frame");
894 Thread *thread = Thread::current();
895 methodHandle m (thread, interpreter_frame_method());
896 jint bci = interpreter_frame_bci();
897
898 assert(!Universe::heap()->is_in(m()),
899 "must be valid oop");
900 assert(m->is_method(), "checking frame value");
901 assert((m->is_native() && bci == 0) ||
902 (!m->is_native() && bci >= 0 && bci < m->code_size()),
903 "invalid bci value");
904
905 // Handle the monitor elements in the activation
906 for (
907 BasicObjectLock* current = interpreter_frame_monitor_end();
908 current < interpreter_frame_monitor_begin();
909 current = next_monitor_in_interpreter_frame(current)
910 ) {
911 #ifdef ASSERT
912 interpreter_frame_verify_monitor(current);
913 #endif
914 current->oops_do(f);
915 }
916
917 if (m->is_native()) {
918 f->do_oop(interpreter_frame_temp_oop_addr());
919 }
920
921 // The method pointer in the frame might be the only path to the method's
922 // klass, and the klass needs to be kept alive while executing. The GCs
923 // don't trace through method pointers, so the mirror of the method's klass
924 // is installed as a GC root.
925 f->do_oop(interpreter_frame_mirror_addr());
926
927 int max_locals = m->is_native() ? m->size_of_parameters() : m->max_locals();
928
929 // Process a callee's arguments if we are at a call site
930 // (i.e., if we are at an invoke bytecode)
931 // This is used sometimes for calling into the VM, not for another
932 // interpreted or compiled frame.
933 if (!m->is_native() && map != nullptr && map->include_argument_oops()) {
934 Bytecode_invoke call = Bytecode_invoke_check(m, bci);
935 if (call.is_valid() && interpreter_frame_expression_stack_size() > 0) {
936 ResourceMark rm(thread); // is this right ???
937 Symbol* signature = call.signature();
938 bool has_receiver = call.has_receiver();
939 // we are at a call site & the expression stack is not empty
940 // => process callee's arguments
941 //
942 // Note: The expression stack can be empty if an exception
943 // occurred during method resolution/execution. In all
944 // cases we empty the expression stack completely be-
945 // fore handling the exception (the exception handling
946 // code in the interpreter calls a blocking runtime
947 // routine which can cause this code to be executed).
948 // (was bug gri 7/27/98)
949 // if (dolog) {
950 // log_trace(continuations, tracking)("Processing arguments");
951 // }
952 oops_interpreted_arguments_do(signature, has_receiver, f);
953 }
954 }
955
956 InterpreterFrameClosure blk(this, max_locals, m->max_stack(), f);
957
958 // process locals & expression stack
959 InterpreterOopMap mask;
960 if (query_oop_map_cache) {
961 m->mask_for(m, bci, &mask);
962 } else {
963 OopMapCache::compute_one_oop_map(m, bci, &mask);
964 }
965 mask.iterate_oop(&blk);
966 }
967
968 template void frame::oops_interpreted_do(OopClosure* f, const RegisterMap* map, bool query_oop_map_cache) const;
969 template void frame::oops_interpreted_do(OopClosure* f, const SmallRegisterMapNoArgs* map, bool query_oop_map_cache) const;
970 template void frame::oops_interpreted_do(OopClosure* f, const SmallRegisterMapWithArgs* map, bool query_oop_map_cache) const;
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 " (%zd)", 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 void frame::oops_upcall_do(OopClosure* f, const RegisterMap* map) const {
1132 assert(map != nullptr, "map must be set");
1133 if (map->include_argument_oops()) {
1134 // Upcall stubs call a MethodHandle impl method of which only the receiver
1135 // is ever an oop.
1136 // Currently we should not be able to get here, since there are no
1137 // safepoints in the one resolve stub we can get into (handle_wrong_method)
1138 // Leave this here as a trap in case we ever do:
1139 ShouldNotReachHere(); // not implemented
1140 }
1141 _cb->as_upcall_stub()->oops_do(f, *this);
1142 }
1143
1144 bool frame::is_deoptimized_frame() const {
1145 assert(_deopt_state != unknown, "not answerable");
1146 if (_deopt_state == is_deoptimized) {
1147 return true;
1148 }
1149
1150 /* This method only checks if the frame is deoptimized
1151 * as in return address being patched.
1152 * It doesn't care if the OP that we return to is a
1153 * deopt instruction */
1154 /*if (_cb != nullptr && _cb->is_nmethod()) {
1155 return NativeDeoptInstruction::is_deopt_at(_pc);
1156 }*/
1157 return false;
1158 }
1159
1160 void frame::oops_do_internal(OopClosure* f, NMethodClosure* cf,
1161 DerivedOopClosure* df, DerivedPointerIterationMode derived_mode,
1162 const RegisterMap* map, bool use_interpreter_oop_map_cache) const {
1163 #ifndef PRODUCT
1164 // simulate GC crash here to dump java thread in error report
1165 guarantee(!CrashGCForDumpingJavaThread, "");
1166 #endif
1167 if (is_interpreted_frame()) {
1168 oops_interpreted_do(f, map, use_interpreter_oop_map_cache);
1169 } else if (is_entry_frame()) {
1170 oops_entry_do(f, map);
1171 } else if (is_upcall_stub_frame()) {
1172 oops_upcall_do(f, map);
1173 } else if (CodeCache::contains(pc())) {
1174 oops_nmethod_do(f, cf, df, derived_mode, map);
1175 } else {
1176 ShouldNotReachHere();
1177 }
1178 }
1179
1180 void frame::nmethod_do(NMethodClosure* cf) const {
1181 if (_cb != nullptr && _cb->is_nmethod()) {
1182 cf->do_nmethod(_cb->as_nmethod());
1183 }
1184 }
1185
1186
1187 // Call f closure on the interpreted Method*s in the stack.
1188 void frame::metadata_do(MetadataClosure* f) const {
1189 ResourceMark rm;
1190 if (is_interpreted_frame()) {
1191 Method* m = this->interpreter_frame_method();
1192 assert(m != nullptr, "expecting a method in this frame");
1193 f->do_metadata(m);
1194 }
1195 }
1196
1197 void frame::verify(const RegisterMap* map) const {
1198 #ifndef PRODUCT
1199 if (TraceCodeBlobStacks) {
1200 tty->print_cr("*** verify");
1201 print_on(tty);
1202 }
1203 #endif
1204
1205 // for now make sure receiver type is correct
1206 if (is_interpreted_frame()) {
1207 Method* method = interpreter_frame_method();
1208 guarantee(method->is_method(), "method is wrong in frame::verify");
1209 if (!method->is_static()) {
1210 // fetch the receiver
1211 oop* p = (oop*) interpreter_frame_local_at(0);
1212 // make sure we have the right receiver type
1213 }
1214 }
1215 #if COMPILER2_OR_JVMCI
1216 assert(DerivedPointerTable::is_empty(), "must be empty before verify");
1217 #endif
1218
1219 if (map->update_map()) { // The map has to be up-to-date for the current frame
1220 oops_do_internal(&VerifyOopClosure::verify_oop, nullptr, nullptr, DerivedPointerIterationMode::_ignore, map, false);
1221 }
1222 }
1223
1224
1225 #ifdef ASSERT
1226 bool frame::verify_return_pc(address x) {
1227 #ifdef TARGET_ARCH_aarch64
1228 if (!pauth_ptr_is_raw(x)) {
1229 return false;
1230 }
1231 #endif
1232 if (StubRoutines::returns_to_call_stub(x)) {
1233 return true;
1234 }
1235 if (CodeCache::contains(x)) {
1236 return true;
1237 }
1238 if (Interpreter::contains(x)) {
1239 return true;
1240 }
1241 return false;
1242 }
1243 #endif
1244
1245 #ifdef ASSERT
1246 void frame::interpreter_frame_verify_monitor(BasicObjectLock* value) const {
1247 assert(is_interpreted_frame(), "Not an interpreted frame");
1248 // verify that the value is in the right part of the frame
1249 address low_mark = (address) interpreter_frame_monitor_end();
1250 address high_mark = (address) interpreter_frame_monitor_begin();
1251 address current = (address) value;
1252
1253 const int monitor_size = frame::interpreter_frame_monitor_size();
1254 guarantee((high_mark - current) % monitor_size == 0 , "Misaligned top of BasicObjectLock*");
1255 guarantee( high_mark > current , "Current BasicObjectLock* higher than high_mark");
1256
1257 guarantee((current - low_mark) % monitor_size == 0 , "Misaligned bottom of BasicObjectLock*");
1258 guarantee( current >= low_mark , "Current BasicObjectLock* below than low_mark");
1259 }
1260 #endif
1261
1262 #ifndef PRODUCT
1263
1264 // Returns true iff the address p is readable and *(intptr_t*)p != errvalue
1265 extern "C" bool dbg_is_safe(const void* p, intptr_t errvalue);
1266
1267 class FrameValuesOopClosure: public OopClosure, public DerivedOopClosure {
1268 private:
1269 GrowableArray<oop*>* _oops;
1270 GrowableArray<narrowOop*>* _narrow_oops;
1271 GrowableArray<derived_base*>* _base;
1272 GrowableArray<derived_pointer*>* _derived;
1273 NoSafepointVerifier nsv;
1274
1275 public:
1276 FrameValuesOopClosure() {
1277 _oops = new (mtThread) GrowableArray<oop*>(100, mtThread);
1278 _narrow_oops = new (mtThread) GrowableArray<narrowOop*>(100, mtThread);
1279 _base = new (mtThread) GrowableArray<derived_base*>(100, mtThread);
1280 _derived = new (mtThread) GrowableArray<derived_pointer*>(100, mtThread);
1281 }
1282 ~FrameValuesOopClosure() {
1283 delete _oops;
1284 delete _narrow_oops;
1285 delete _base;
1286 delete _derived;
1287 }
1288
1289 virtual void do_oop(oop* p) override { _oops->push(p); }
1290 virtual void do_oop(narrowOop* p) override { _narrow_oops->push(p); }
1291 virtual void do_derived_oop(derived_base* base_loc, derived_pointer* derived_loc) override {
1292 _base->push(base_loc);
1293 _derived->push(derived_loc);
1294 }
1295
1296 bool is_good(oop* p) {
1297 return *p == nullptr || (dbg_is_safe(*p, -1) && dbg_is_safe((*p)->klass(), -1) && oopDesc::is_oop_or_null(*p));
1298 }
1299 void describe(FrameValues& values, int frame_no) {
1300 for (int i = 0; i < _oops->length(); i++) {
1301 oop* p = _oops->at(i);
1302 values.describe(frame_no, (intptr_t*)p, err_msg("oop%s for #%d", is_good(p) ? "" : " (BAD)", frame_no));
1303 }
1304 for (int i = 0; i < _narrow_oops->length(); i++) {
1305 narrowOop* p = _narrow_oops->at(i);
1306 // we can't check for bad compressed oops, as decoding them might crash
1307 values.describe(frame_no, (intptr_t*)p, err_msg("narrow oop for #%d", frame_no));
1308 }
1309 assert(_base->length() == _derived->length(), "should be the same");
1310 for (int i = 0; i < _base->length(); i++) {
1311 derived_base* base = _base->at(i);
1312 derived_pointer* derived = _derived->at(i);
1313 values.describe(frame_no, (intptr_t*)derived, err_msg("derived pointer (base: " INTPTR_FORMAT ") for #%d", p2i(base), frame_no));
1314 }
1315 }
1316 };
1317
1318 class FrameValuesOopMapClosure: public OopMapClosure {
1319 private:
1320 const frame* _fr;
1321 const RegisterMap* _reg_map;
1322 FrameValues& _values;
1323 int _frame_no;
1324
1325 public:
1326 FrameValuesOopMapClosure(const frame* fr, const RegisterMap* reg_map, FrameValues& values, int frame_no)
1327 : _fr(fr), _reg_map(reg_map), _values(values), _frame_no(frame_no) {}
1328
1329 virtual void do_value(VMReg reg, OopMapValue::oop_types type) override {
1330 intptr_t* p = (intptr_t*)_fr->oopmapreg_to_location(reg, _reg_map);
1331 if (p != nullptr && (((intptr_t)p & WordAlignmentMask) == 0)) {
1332 const char* type_name = nullptr;
1333 switch(type) {
1334 case OopMapValue::oop_value: type_name = "oop"; break;
1335 case OopMapValue::narrowoop_value: type_name = "narrow oop"; break;
1336 case OopMapValue::callee_saved_value: type_name = "callee-saved"; break;
1337 case OopMapValue::derived_oop_value: type_name = "derived"; break;
1338 // case OopMapValue::live_value: type_name = "live"; break;
1339 default: break;
1340 }
1341 if (type_name != nullptr) {
1342 _values.describe(_frame_no, p, err_msg("%s for #%d", type_name, _frame_no));
1343 }
1344 }
1345 }
1346 };
1347
1348 // callers need a ResourceMark because of name_and_sig_as_C_string() usage,
1349 // RA allocated string is returned to the caller
1350 void frame::describe(FrameValues& values, int frame_no, const RegisterMap* reg_map, bool top) {
1351 // boundaries: sp and the 'real' frame pointer
1352 values.describe(-1, sp(), err_msg("sp for #%d", frame_no), 0);
1353 if (top) {
1354 values.describe(-1, sp() - 1, err_msg("sp[-1] for #%d", frame_no), 0);
1355 values.describe(-1, sp() - 2, err_msg("sp[-2] for #%d", frame_no), 0);
1356 }
1357
1358 intptr_t* frame_pointer = real_fp(); // Note: may differ from fp()
1359
1360 // print frame info at the highest boundary
1361 intptr_t* info_address = MAX2(sp(), frame_pointer);
1362
1363 if (info_address != frame_pointer) {
1364 // print frame_pointer explicitly if not marked by the frame info
1365 values.describe(-1, frame_pointer, err_msg("frame pointer for #%d", frame_no), 1);
1366 }
1367
1368 if (is_entry_frame() || is_compiled_frame() || is_interpreted_frame() || is_native_frame()) {
1369 // Label values common to most frames
1370 values.describe(-1, unextended_sp(), err_msg("unextended_sp for #%d", frame_no), 0);
1371 }
1372
1373 if (is_interpreted_frame()) {
1374 Method* m = interpreter_frame_method();
1375 int bci = interpreter_frame_bci();
1376 InterpreterCodelet* desc = Interpreter::codelet_containing(pc());
1377
1378 // Label the method and current bci
1379 values.describe(-1, info_address,
1380 FormatBuffer<1024>("#%d method %s @ %d", frame_no, m->name_and_sig_as_C_string(), bci), 3);
1381 if (desc != nullptr) {
1382 values.describe(-1, info_address, err_msg("- %s codelet: %s",
1383 desc->bytecode() >= 0 ? Bytecodes::name(desc->bytecode()) : "",
1384 desc->description() != nullptr ? desc->description() : "?"), 2);
1385 }
1386 values.describe(-1, info_address,
1387 err_msg("- %d locals %d max stack", m->max_locals(), m->max_stack()), 2);
1388 // return address will be emitted by caller in describe_pd
1389 // values.describe(frame_no, (intptr_t*)sender_pc_addr(), Continuation::is_return_barrier_entry(*sender_pc_addr()) ? "return address (return barrier)" : "return address");
1390
1391 if (m->max_locals() > 0) {
1392 intptr_t* l0 = interpreter_frame_local_at(0);
1393 intptr_t* ln = interpreter_frame_local_at(m->max_locals() - 1);
1394 values.describe(-1, MAX2(l0, ln), err_msg("locals for #%d", frame_no), 2);
1395 // Report each local and mark as owned by this frame
1396 for (int l = 0; l < m->max_locals(); l++) {
1397 intptr_t* l0 = interpreter_frame_local_at(l);
1398 values.describe(frame_no, l0, err_msg("local %d", l), 1);
1399 }
1400 }
1401
1402 if (interpreter_frame_monitor_begin() != interpreter_frame_monitor_end()) {
1403 values.describe(frame_no, (intptr_t*)interpreter_frame_monitor_begin(), "monitors begin");
1404 values.describe(frame_no, (intptr_t*)interpreter_frame_monitor_end(), "monitors end");
1405 }
1406
1407 // Compute the actual expression stack size
1408 InterpreterOopMap mask;
1409 OopMapCache::compute_one_oop_map(methodHandle(Thread::current(), m), bci, &mask);
1410 intptr_t* tos = nullptr;
1411 // Report each stack element and mark as owned by this frame
1412 for (int e = 0; e < mask.expression_stack_size(); e++) {
1413 tos = MAX2(tos, interpreter_frame_expression_stack_at(e));
1414 values.describe(frame_no, interpreter_frame_expression_stack_at(e),
1415 err_msg("stack %d", e), 1);
1416 }
1417 if (tos != nullptr) {
1418 values.describe(-1, tos, err_msg("expression stack for #%d", frame_no), 2);
1419 }
1420
1421 if (reg_map != nullptr) {
1422 FrameValuesOopClosure oopsFn;
1423 oops_do(&oopsFn, nullptr, &oopsFn, reg_map);
1424 oopsFn.describe(values, frame_no);
1425 }
1426 } else if (is_entry_frame()) {
1427 // For now just label the frame
1428 values.describe(-1, info_address, err_msg("#%d entry frame", frame_no), 2);
1429 } else if (is_compiled_frame()) {
1430 // For now just label the frame
1431 nmethod* nm = cb()->as_nmethod();
1432 values.describe(-1, info_address,
1433 FormatBuffer<1024>("#%d nmethod " INTPTR_FORMAT " for method J %s%s", frame_no,
1434 p2i(nm),
1435 nm->method()->name_and_sig_as_C_string(),
1436 (_deopt_state == is_deoptimized) ?
1437 " (deoptimized)" :
1438 ((_deopt_state == unknown) ? " (state unknown)" : "")),
1439 3);
1440
1441 { // mark arguments (see nmethod::print_nmethod_labels)
1442 Method* m = nm->method();
1443
1444 int stack_slot_offset = nm->frame_size() * wordSize; // offset, in bytes, to caller sp
1445 int sizeargs = m->size_of_parameters();
1446
1447 BasicType* sig_bt = NEW_RESOURCE_ARRAY(BasicType, sizeargs);
1448 VMRegPair* regs = NEW_RESOURCE_ARRAY(VMRegPair, sizeargs);
1449 {
1450 int sig_index = 0;
1451 if (!m->is_static()) {
1452 sig_bt[sig_index++] = T_OBJECT; // 'this'
1453 }
1454 for (SignatureStream ss(m->signature()); !ss.at_return_type(); ss.next()) {
1455 BasicType t = ss.type();
1456 assert(type2size[t] == 1 || type2size[t] == 2, "size is 1 or 2");
1457 sig_bt[sig_index++] = t;
1458 if (type2size[t] == 2) {
1459 sig_bt[sig_index++] = T_VOID;
1460 }
1461 }
1462 assert(sig_index == sizeargs, "");
1463 }
1464 int stack_arg_slots = SharedRuntime::java_calling_convention(sig_bt, regs, sizeargs);
1465 assert(stack_arg_slots == nm->as_nmethod()->num_stack_arg_slots(false /* rounded */) || nm->is_osr_method(), "");
1466 int out_preserve = SharedRuntime::out_preserve_stack_slots();
1467 int sig_index = 0;
1468 int arg_index = (m->is_static() ? 0 : -1);
1469 for (SignatureStream ss(m->signature()); !ss.at_return_type(); ) {
1470 bool at_this = (arg_index == -1);
1471 bool at_old_sp = false;
1472 BasicType t = (at_this ? T_OBJECT : ss.type());
1473 assert(t == sig_bt[sig_index], "sigs in sync");
1474 VMReg fst = regs[sig_index].first();
1475 if (fst->is_stack()) {
1476 assert(((int)fst->reg2stack()) >= 0, "reg2stack: %d", fst->reg2stack());
1477 int offset = (fst->reg2stack() + out_preserve) * VMRegImpl::stack_slot_size + stack_slot_offset;
1478 intptr_t* stack_address = (intptr_t*)((address)unextended_sp() + offset);
1479 if (at_this) {
1480 values.describe(frame_no, stack_address, err_msg("this for #%d", frame_no), 1);
1481 } else {
1482 values.describe(frame_no, stack_address, err_msg("param %d %s for #%d", arg_index, type2name(t), frame_no), 1);
1483 }
1484 }
1485 sig_index += type2size[t];
1486 arg_index += 1;
1487 if (!at_this) {
1488 ss.next();
1489 }
1490 }
1491 }
1492
1493 if (reg_map != nullptr && is_java_frame()) {
1494 int scope_no = 0;
1495 for (ScopeDesc* scope = nm->scope_desc_at(pc()); scope != nullptr; scope = scope->sender(), scope_no++) {
1496 Method* m = scope->method();
1497 int bci = scope->bci();
1498 values.describe(-1, info_address, err_msg("- #%d scope %s @ %d", scope_no, m->name_and_sig_as_C_string(), bci), 2);
1499
1500 { // mark locals
1501 GrowableArray<ScopeValue*>* scvs = scope->locals();
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("local %d for #%d (scope %d)", i, frame_no, scope_no), 1);
1507 }
1508 }
1509 }
1510 { // mark expression stack
1511 GrowableArray<ScopeValue*>* scvs = scope->expressions();
1512 int scvs_length = scvs != nullptr ? scvs->length() : 0;
1513 for (int i = 0; i < scvs_length; i++) {
1514 intptr_t* stack_address = (intptr_t*)StackValue::stack_value_address(this, reg_map, scvs->at(i));
1515 if (stack_address != nullptr) {
1516 values.describe(frame_no, stack_address, err_msg("stack %d for #%d (scope %d)", i, frame_no, scope_no), 1);
1517 }
1518 }
1519 }
1520 }
1521
1522 FrameValuesOopClosure oopsFn;
1523 oops_do(&oopsFn, nullptr, &oopsFn, reg_map);
1524 oopsFn.describe(values, frame_no);
1525
1526 if (oop_map() != nullptr) {
1527 FrameValuesOopMapClosure valuesFn(this, reg_map, values, frame_no);
1528 // also OopMapValue::live_value ??
1529 oop_map()->all_type_do(this, OopMapValue::callee_saved_value, &valuesFn);
1530 }
1531 }
1532 } else if (is_native_frame()) {
1533 // For now just label the frame
1534 nmethod* nm = cb()->as_nmethod_or_null();
1535 values.describe(-1, info_address,
1536 FormatBuffer<1024>("#%d nmethod " INTPTR_FORMAT " for native method %s", frame_no,
1537 p2i(nm), nm->method()->name_and_sig_as_C_string()), 2);
1538 if (nm->method()->is_continuation_enter_intrinsic()) {
1539 ContinuationEntry* ce = Continuation::get_continuation_entry_for_entry_frame(reg_map->thread(), *this); // (ContinuationEntry*)unextended_sp();
1540 ce->describe(values, frame_no);
1541 }
1542 } else {
1543 // provide default info if not handled before
1544 char *info = (char *) "special frame";
1545 if ((_cb != nullptr) &&
1546 (_cb->name() != nullptr)) {
1547 info = (char *)_cb->name();
1548 }
1549 values.describe(-1, info_address, err_msg("#%d <%s>", frame_no, info), 2);
1550 }
1551
1552 // platform dependent additional data
1553 describe_pd(values, frame_no);
1554 }
1555
1556 #endif
1557
1558 /**
1559 * Gets the caller frame of `fr` for thread `t`.
1560 *
1561 * @returns an invalid frame (i.e. fr.pc() === 0) if the caller cannot be obtained
1562 */
1563 frame frame::next_frame(frame fr, Thread* t) {
1564 // Compiled code may use EBP register on x86 so it looks like
1565 // non-walkable C frame. Use frame.sender() for java frames.
1566 frame invalid;
1567 if (t != nullptr && t->is_Java_thread()) {
1568 // Catch very first native frame by using stack address.
1569 // For JavaThread stack_base and stack_size should be set.
1570 if (!t->is_in_full_stack((address)(fr.real_fp() + 1))) {
1571 return invalid;
1572 }
1573 if (fr.is_interpreted_frame() || (fr.cb() != nullptr && fr.cb()->frame_size() > 0)) {
1574 RegisterMap map(JavaThread::cast(t),
1575 RegisterMap::UpdateMap::skip,
1576 RegisterMap::ProcessFrames::include,
1577 RegisterMap::WalkContinuation::skip); // No update
1578 return fr.sender(&map);
1579 } else {
1580 // is_first_C_frame() does only simple checks for frame pointer,
1581 // it will pass if java compiled code has a pointer in EBP.
1582 if (os::is_first_C_frame(&fr)) return invalid;
1583 return os::get_sender_for_C_frame(&fr);
1584 }
1585 } else {
1586 if (os::is_first_C_frame(&fr)) return invalid;
1587 return os::get_sender_for_C_frame(&fr);
1588 }
1589 }
1590
1591 #ifndef PRODUCT
1592
1593 void FrameValues::describe(int owner, intptr_t* location, const char* description, int priority) {
1594 FrameValue fv;
1595 fv.location = location;
1596 fv.owner = owner;
1597 fv.priority = priority;
1598 fv.description = NEW_RESOURCE_ARRAY(char, strlen(description) + 1);
1599 strcpy(fv.description, description);
1600 _values.append(fv);
1601 }
1602
1603
1604 #ifdef ASSERT
1605 void FrameValues::validate() {
1606 _values.sort(compare);
1607 bool error = false;
1608 FrameValue prev;
1609 prev.owner = -1;
1610 for (int i = _values.length() - 1; i >= 0; i--) {
1611 FrameValue fv = _values.at(i);
1612 if (fv.owner == -1) continue;
1613 if (prev.owner == -1) {
1614 prev = fv;
1615 continue;
1616 }
1617 if (prev.location == fv.location) {
1618 if (fv.owner != prev.owner) {
1619 tty->print_cr("overlapping storage");
1620 tty->print_cr(" " INTPTR_FORMAT ": " INTPTR_FORMAT " %s", p2i(prev.location), *prev.location, prev.description);
1621 tty->print_cr(" " INTPTR_FORMAT ": " INTPTR_FORMAT " %s", p2i(fv.location), *fv.location, fv.description);
1622 error = true;
1623 }
1624 } else {
1625 prev = fv;
1626 }
1627 }
1628 // if (error) { tty->cr(); print_on(static_cast<JavaThread*>(nullptr), tty); }
1629 assert(!error, "invalid layout");
1630 }
1631 #endif // ASSERT
1632
1633 void FrameValues::print_on(JavaThread* thread, outputStream* st) {
1634 _values.sort(compare);
1635
1636 // Sometimes values like the fp can be invalid values if the
1637 // register map wasn't updated during the walk. Trim out values
1638 // that aren't actually in the stack of the thread.
1639 int min_index = 0;
1640 int max_index = _values.length() - 1;
1641 intptr_t* v0 = _values.at(min_index).location;
1642 intptr_t* v1 = _values.at(max_index).location;
1643
1644 if (thread != nullptr) {
1645 if (thread == Thread::current()) {
1646 while (!thread->is_in_live_stack((address)v0)) v0 = _values.at(++min_index).location;
1647 while (!thread->is_in_live_stack((address)v1)) v1 = _values.at(--max_index).location;
1648 } else {
1649 while (!thread->is_in_full_stack((address)v0)) v0 = _values.at(++min_index).location;
1650 while (!thread->is_in_full_stack((address)v1)) v1 = _values.at(--max_index).location;
1651 }
1652 }
1653
1654 print_on(st, min_index, max_index, v0, v1);
1655 }
1656
1657 void FrameValues::print_on(stackChunkOop chunk, outputStream* st) {
1658 _values.sort(compare);
1659
1660 intptr_t* start = chunk->start_address();
1661 intptr_t* end = chunk->end_address() + 1;
1662
1663 int min_index = 0;
1664 int max_index = _values.length() - 1;
1665 intptr_t* v0 = _values.at(min_index).location;
1666 intptr_t* v1 = _values.at(max_index).location;
1667 while (!(start <= v0 && v0 <= end)) v0 = _values.at(++min_index).location;
1668 while (!(start <= v1 && v1 <= end)) v1 = _values.at(--max_index).location;
1669
1670 print_on(st, min_index, max_index, v0, v1);
1671 }
1672
1673 void FrameValues::print_on(outputStream* st, int min_index, int max_index, intptr_t* v0, intptr_t* v1) {
1674 intptr_t* min = MIN2(v0, v1);
1675 intptr_t* max = MAX2(v0, v1);
1676 intptr_t* cur = max;
1677 intptr_t* last = nullptr;
1678 intptr_t* fp = nullptr;
1679 for (int i = max_index; i >= min_index; i--) {
1680 FrameValue fv = _values.at(i);
1681 while (cur > fv.location) {
1682 st->print_cr(" " INTPTR_FORMAT ": " INTPTR_FORMAT, p2i(cur), *cur);
1683 cur--;
1684 }
1685 if (last == fv.location) {
1686 const char* spacer = " " LP64_ONLY(" ");
1687 st->print_cr(" %s %s %s", spacer, spacer, fv.description);
1688 } else {
1689 if (*fv.description == '#' && isdigit(fv.description[1])) {
1690 // The fv.description string starting with a '#' is the line for the
1691 // saved frame pointer eg. "#10 method java.lang.invoke.LambdaForm..."
1692 // basicaly means frame 10.
1693 fp = fv.location;
1694 }
1695 // To print a fp-relative value:
1696 // 1. The content of *fv.location must be such that we think it's a
1697 // fp-relative number, i.e [-100..100].
1698 // 2. We must have found the frame pointer.
1699 // 3. The line can not be the line for the saved frame pointer.
1700 // 4. Recognize it as being part of the "fixed frame".
1701 if (*fv.location != 0 && *fv.location > -100 && *fv.location < 100
1702 && fp != nullptr && *fv.description != '#'
1703 #if !defined(PPC64)
1704 && (strncmp(fv.description, "interpreter_frame_", 18) == 0 || strstr(fv.description, " method "))
1705 #else // !defined(PPC64)
1706 && (strcmp(fv.description, "sender_sp") == 0 || strcmp(fv.description, "top_frame_sp") == 0 ||
1707 strcmp(fv.description, "esp") == 0 || strcmp(fv.description, "monitors") == 0 ||
1708 strcmp(fv.description, "locals") == 0 || strstr(fv.description, " method "))
1709 #endif //!defined(PPC64)
1710 ) {
1711 st->print_cr(" " INTPTR_FORMAT ": " INTPTR_FORMAT " %-32s (relativized: fp%+d)",
1712 p2i(fv.location), p2i(&fp[*fv.location]), fv.description, (int)*fv.location);
1713 } else {
1714 st->print_cr(" " INTPTR_FORMAT ": " INTPTR_FORMAT " %s", p2i(fv.location), *fv.location, fv.description);
1715 }
1716 last = fv.location;
1717 cur--;
1718 }
1719 }
1720 }
1721
1722 #endif // ndef PRODUCT