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