1 /*
2 * Copyright (c) 1999, 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 "asm/codeBuffer.hpp"
26 #include "c1/c1_CodeStubs.hpp"
27 #include "c1/c1_Defs.hpp"
28 #include "c1/c1_LIRAssembler.hpp"
29 #include "c1/c1_MacroAssembler.hpp"
30 #include "c1/c1_Runtime1.hpp"
31 #include "classfile/javaClasses.inline.hpp"
32 #include "classfile/vmClasses.hpp"
33 #include "classfile/vmSymbols.hpp"
34 #include "code/aotCodeCache.hpp"
35 #include "code/codeBlob.hpp"
36 #include "code/compiledIC.hpp"
37 #include "code/scopeDesc.hpp"
38 #include "code/vtableStubs.hpp"
39 #include "compiler/compilationPolicy.hpp"
40 #include "compiler/disassembler.hpp"
41 #include "compiler/oopMap.hpp"
42 #include "gc/shared/barrierSet.hpp"
43 #include "gc/shared/c1/barrierSetC1.hpp"
44 #include "gc/shared/collectedHeap.hpp"
45 #include "interpreter/bytecode.hpp"
46 #include "interpreter/interpreter.hpp"
47 #include "jfr/support/jfrIntrinsics.hpp"
48 #include "logging/log.hpp"
49 #include "memory/oopFactory.hpp"
50 #include "memory/resourceArea.hpp"
51 #include "memory/universe.hpp"
52 #include "oops/access.inline.hpp"
53 #include "oops/objArrayKlass.hpp"
54 #include "oops/objArrayOop.inline.hpp"
55 #include "oops/oop.inline.hpp"
56 #include "prims/jvmtiExport.hpp"
57 #include "runtime/atomicAccess.hpp"
58 #include "runtime/fieldDescriptor.inline.hpp"
59 #include "runtime/frame.inline.hpp"
60 #include "runtime/handles.inline.hpp"
61 #include "runtime/interfaceSupport.inline.hpp"
62 #include "runtime/javaCalls.hpp"
63 #include "runtime/sharedRuntime.hpp"
64 #include "runtime/stackWatermarkSet.hpp"
65 #include "runtime/stubInfo.hpp"
66 #include "runtime/stubRoutines.hpp"
67 #include "runtime/vframe.inline.hpp"
68 #include "runtime/vframeArray.hpp"
69 #include "runtime/vm_version.hpp"
70 #include "utilities/copy.hpp"
71 #include "utilities/events.hpp"
72
73
74 // Implementation of StubAssembler
75
76 StubAssembler::StubAssembler(CodeBuffer* code, const char * name, int stub_id) : C1_MacroAssembler(code) {
77 _name = name;
78 _must_gc_arguments = false;
79 _frame_size = no_frame_size;
80 _num_rt_args = 0;
81 _stub_id = stub_id;
82 }
83
84
85 void StubAssembler::set_info(const char* name, bool must_gc_arguments) {
86 _name = name;
87 _must_gc_arguments = must_gc_arguments;
88 }
89
90
91 void StubAssembler::set_frame_size(int size) {
92 if (_frame_size == no_frame_size) {
93 _frame_size = size;
94 }
95 assert(_frame_size == size, "can't change the frame size");
96 }
97
98
99 void StubAssembler::set_num_rt_args(int args) {
100 if (_num_rt_args == 0) {
101 _num_rt_args = args;
102 }
103 assert(_num_rt_args == args, "can't change the number of args");
104 }
105
106 // Implementation of Runtime1
107 CodeBlob* Runtime1::_blobs[StubInfo::C1_STUB_COUNT];
108
109 #ifndef PRODUCT
110 // statistics
111 uint Runtime1::_generic_arraycopystub_cnt = 0;
112 uint Runtime1::_arraycopy_slowcase_cnt = 0;
113 uint Runtime1::_arraycopy_checkcast_cnt = 0;
114 uint Runtime1::_arraycopy_checkcast_attempt_cnt = 0;
115 uint Runtime1::_new_type_array_slowcase_cnt = 0;
116 uint Runtime1::_new_object_array_slowcase_cnt = 0;
117 uint Runtime1::_new_instance_slowcase_cnt = 0;
118 uint Runtime1::_new_multi_array_slowcase_cnt = 0;
119 uint Runtime1::_monitorenter_slowcase_cnt = 0;
120 uint Runtime1::_monitorexit_slowcase_cnt = 0;
121 uint Runtime1::_patch_code_slowcase_cnt = 0;
122 uint Runtime1::_throw_range_check_exception_count = 0;
123 uint Runtime1::_throw_index_exception_count = 0;
124 uint Runtime1::_throw_div0_exception_count = 0;
125 uint Runtime1::_throw_null_pointer_exception_count = 0;
126 uint Runtime1::_throw_class_cast_exception_count = 0;
127 uint Runtime1::_throw_incompatible_class_change_error_count = 0;
128 uint Runtime1::_throw_count = 0;
129
130 static uint _byte_arraycopy_stub_cnt = 0;
131 static uint _short_arraycopy_stub_cnt = 0;
132 static uint _int_arraycopy_stub_cnt = 0;
133 static uint _long_arraycopy_stub_cnt = 0;
134 static uint _oop_arraycopy_stub_cnt = 0;
135
136 address Runtime1::arraycopy_count_address(BasicType type) {
137 switch (type) {
138 case T_BOOLEAN:
139 case T_BYTE: return (address)&_byte_arraycopy_stub_cnt;
140 case T_CHAR:
141 case T_SHORT: return (address)&_short_arraycopy_stub_cnt;
142 case T_FLOAT:
143 case T_INT: return (address)&_int_arraycopy_stub_cnt;
144 case T_DOUBLE:
145 case T_LONG: return (address)&_long_arraycopy_stub_cnt;
146 case T_ARRAY:
147 case T_OBJECT: return (address)&_oop_arraycopy_stub_cnt;
148 default:
149 ShouldNotReachHere();
150 return nullptr;
151 }
152 }
153
154
155 #endif
156
157 // Simple helper to see if the caller of a runtime stub which
158 // entered the VM has been deoptimized
159
160 static bool caller_is_deopted(JavaThread* current) {
161 RegisterMap reg_map(current,
162 RegisterMap::UpdateMap::skip,
163 RegisterMap::ProcessFrames::include,
164 RegisterMap::WalkContinuation::skip);
165 frame runtime_frame = current->last_frame();
166 frame caller_frame = runtime_frame.sender(®_map);
167 assert(caller_frame.is_compiled_frame(), "must be compiled");
168 return caller_frame.is_deoptimized_frame();
169 }
170
171 // Stress deoptimization
172 static void deopt_caller(JavaThread* current) {
173 if (!caller_is_deopted(current)) {
174 RegisterMap reg_map(current,
175 RegisterMap::UpdateMap::skip,
176 RegisterMap::ProcessFrames::include,
177 RegisterMap::WalkContinuation::skip);
178 frame runtime_frame = current->last_frame();
179 frame caller_frame = runtime_frame.sender(®_map);
180 Deoptimization::deoptimize_frame(current, caller_frame.id());
181 assert(caller_is_deopted(current), "Must be deoptimized");
182 }
183 }
184
185 class C1StubAssemblerCodeGenClosure: public StubAssemblerCodeGenClosure {
186 private:
187 StubId _id;
188 public:
189 C1StubAssemblerCodeGenClosure(StubId id) : _id(id) {
190 assert(StubInfo::is_c1(_id), "not a c1 stub id %s", StubInfo::name(_id));
191 }
192 virtual OopMapSet* generate_code(StubAssembler* sasm) {
193 return Runtime1::generate_code_for(_id, sasm);
194 }
195 };
196
197 CodeBlob* Runtime1::generate_blob(BufferBlob* buffer_blob, StubId id, const char* name, bool expect_oop_map, StubAssemblerCodeGenClosure* cl) {
198 if (id != StubId::NO_STUBID) {
199 CodeBlob* blob = AOTCodeCache::load_code_blob(AOTCodeEntry::C1Blob, StubInfo::blob(id));
200 if (blob != nullptr) {
201 return blob;
202 }
203 }
204
205 ResourceMark rm;
206 // create code buffer for code storage
207 CodeBuffer code(buffer_blob);
208
209 OopMapSet* oop_maps;
210 int frame_size;
211 bool must_gc_arguments;
212
213 Compilation::setup_code_buffer(&code, 0);
214
215 // create assembler for code generation
216 StubAssembler* sasm = new StubAssembler(&code, name, (int)id);
217 // generate code for runtime stub
218 oop_maps = cl->generate_code(sasm);
219 assert(oop_maps == nullptr || sasm->frame_size() != no_frame_size,
220 "if stub has an oop map it must have a valid frame size");
221 assert(!expect_oop_map || oop_maps != nullptr, "must have an oopmap");
222
223 // align so printing shows nop's instead of random code at the end (SimpleStubs are aligned)
224 sasm->align(BytesPerWord);
225 // make sure all code is in code buffer
226 sasm->flush();
227
228 frame_size = sasm->frame_size();
229 must_gc_arguments = sasm->must_gc_arguments();
230 // create blob - distinguish a few special cases
231 CodeBlob* blob = RuntimeStub::new_runtime_stub(name,
232 &code,
233 CodeOffsets::frame_never_safe,
234 frame_size,
235 oop_maps,
236 must_gc_arguments,
237 false /* alloc_fail_is_fatal */ );
238 if (blob != nullptr && (int)id >= 0) {
239 AOTCodeCache::store_code_blob(*blob, AOTCodeEntry::C1Blob, StubInfo::blob(id));
240 }
241 return blob;
242 }
243
244 bool Runtime1::generate_blob_for(BufferBlob* buffer_blob, StubId id) {
245 assert(StubInfo::is_c1(id), "not a c1 stub %s", StubInfo::name(id));
246 bool expect_oop_map = true;
247 #ifdef ASSERT
248 // Make sure that stubs that need oopmaps have them
249 switch (id) {
250 // These stubs don't need to have an oopmap
251 case StubId::c1_dtrace_object_alloc_id:
252 case StubId::c1_slow_subtype_check_id:
253 case StubId::c1_fpu2long_stub_id:
254 case StubId::c1_unwind_exception_id:
255 case StubId::c1_counter_overflow_id:
256 case StubId::c1_is_instance_of_id:
257 expect_oop_map = false;
258 break;
259 default:
260 break;
261 }
262 #endif
263 C1StubAssemblerCodeGenClosure cl(id);
264 CodeBlob* blob = generate_blob(buffer_blob, id, name_for(id), expect_oop_map, &cl);
265 // install blob
266 int idx = StubInfo::c1_offset(id); // will assert on non-c1 id
267 _blobs[idx] = blob;
268 return blob != nullptr;
269 }
270
271 bool Runtime1::initialize(BufferBlob* blob) {
272 // platform-dependent initialization
273 initialize_pd();
274 // iterate blobs in C1 group and generate a single stub per blob
275 StubId id = StubInfo::stub_base(StubGroup::C1);
276 StubId limit = StubInfo::next(StubInfo::stub_max(StubGroup::C1));
277 for (; id != limit; id = StubInfo::next(id)) {
278 if (!generate_blob_for(blob, id)) {
279 return false;
280 }
281 if (id == StubId::c1_forward_exception_id) {
282 // publish early c1 stubs at this point so later stubs can refer to them
283 AOTCodeCache::init_early_c1_table();
284 }
285 }
286 // printing
287 #ifndef PRODUCT
288 if (PrintSimpleStubs) {
289 ResourceMark rm;
290 id = StubInfo::stub_base(StubGroup::C1);
291 for (; id != limit; id = StubInfo::next(id)) {
292 CodeBlob* blob = blob_for(id);
293 blob->print();
294 if (blob->oop_maps() != nullptr) {
295 blob->oop_maps()->print();
296 }
297 }
298 }
299 #endif
300 BarrierSetC1* bs = BarrierSet::barrier_set()->barrier_set_c1();
301 return bs->generate_c1_runtime_stubs(blob);
302 }
303
304 CodeBlob* Runtime1::blob_for(StubId id) {
305 int idx = StubInfo::c1_offset(id); // will assert on non-c1 id
306 return _blobs[idx];
307 }
308
309
310 const char* Runtime1::name_for(StubId id) {
311 return StubInfo::name(id);
312 }
313
314 const char* Runtime1::name_for_address(address entry) {
315 // iterate stubs starting from C1 group base
316 StubId id = StubInfo::stub_base(StubGroup::C1);
317 StubId limit = StubInfo::next(StubInfo::stub_max(StubGroup::C1));
318 for (; id != limit; id = StubInfo::next(id)) {
319 if (entry == entry_for(id)) return StubInfo::name(id);
320 }
321
322 #define FUNCTION_CASE(a, f) \
323 if ((intptr_t)a == CAST_FROM_FN_PTR(intptr_t, f)) return #f
324
325 FUNCTION_CASE(entry, os::javaTimeMillis);
326 FUNCTION_CASE(entry, os::javaTimeNanos);
327 FUNCTION_CASE(entry, SharedRuntime::OSR_migration_end);
328 FUNCTION_CASE(entry, SharedRuntime::d2f);
329 FUNCTION_CASE(entry, SharedRuntime::d2i);
330 FUNCTION_CASE(entry, SharedRuntime::d2l);
331 FUNCTION_CASE(entry, SharedRuntime::dcos);
332 FUNCTION_CASE(entry, SharedRuntime::dexp);
333 FUNCTION_CASE(entry, SharedRuntime::dlog);
334 FUNCTION_CASE(entry, SharedRuntime::dlog10);
335 FUNCTION_CASE(entry, SharedRuntime::dpow);
336 FUNCTION_CASE(entry, SharedRuntime::drem);
337 FUNCTION_CASE(entry, SharedRuntime::dsin);
338 FUNCTION_CASE(entry, SharedRuntime::dtan);
339 FUNCTION_CASE(entry, SharedRuntime::f2i);
340 FUNCTION_CASE(entry, SharedRuntime::f2l);
341 FUNCTION_CASE(entry, SharedRuntime::frem);
342 FUNCTION_CASE(entry, SharedRuntime::l2d);
343 FUNCTION_CASE(entry, SharedRuntime::l2f);
344 FUNCTION_CASE(entry, SharedRuntime::ldiv);
345 FUNCTION_CASE(entry, SharedRuntime::lmul);
346 FUNCTION_CASE(entry, SharedRuntime::lrem);
347 FUNCTION_CASE(entry, SharedRuntime::lrem);
348 FUNCTION_CASE(entry, SharedRuntime::dtrace_method_entry);
349 FUNCTION_CASE(entry, SharedRuntime::dtrace_method_exit);
350 FUNCTION_CASE(entry, is_instance_of);
351 FUNCTION_CASE(entry, trace_block_entry);
352 #ifdef JFR_HAVE_INTRINSICS
353 FUNCTION_CASE(entry, JfrTime::time_function());
354 #endif
355 FUNCTION_CASE(entry, StubRoutines::updateBytesCRC32());
356 FUNCTION_CASE(entry, StubRoutines::updateBytesCRC32C());
357 FUNCTION_CASE(entry, StubRoutines::vectorizedMismatch());
358 FUNCTION_CASE(entry, StubRoutines::dexp());
359 FUNCTION_CASE(entry, StubRoutines::dlog());
360 FUNCTION_CASE(entry, StubRoutines::dlog10());
361 FUNCTION_CASE(entry, StubRoutines::dpow());
362 FUNCTION_CASE(entry, StubRoutines::dsin());
363 FUNCTION_CASE(entry, StubRoutines::dcos());
364 FUNCTION_CASE(entry, StubRoutines::dtan());
365 FUNCTION_CASE(entry, StubRoutines::dsinh());
366 FUNCTION_CASE(entry, StubRoutines::dtanh());
367 FUNCTION_CASE(entry, StubRoutines::dcbrt());
368
369 #undef FUNCTION_CASE
370
371 // Soft float adds more runtime names.
372 return pd_name_for_address(entry);
373 }
374
375
376 JRT_ENTRY(void, Runtime1::new_instance(JavaThread* current, Klass* klass))
377 #ifndef PRODUCT
378 if (PrintC1Statistics) {
379 _new_instance_slowcase_cnt++;
380 }
381 #endif
382 assert(klass->is_klass(), "not a class");
383 Handle holder(current, klass->klass_holder()); // keep the klass alive
384 InstanceKlass* h = InstanceKlass::cast(klass);
385 h->check_valid_for_instantiation(true, CHECK);
386 // make sure klass is initialized
387 h->initialize(CHECK);
388 // allocate instance and return via TLS
389 oop obj = h->allocate_instance(CHECK);
390 current->set_vm_result_oop(obj);
391 JRT_END
392
393
394 JRT_ENTRY(void, Runtime1::new_type_array(JavaThread* current, Klass* klass, jint length))
395 #ifndef PRODUCT
396 if (PrintC1Statistics) {
397 _new_type_array_slowcase_cnt++;
398 }
399 #endif
400 // Note: no handle for klass needed since they are not used
401 // anymore after new_typeArray() and no GC can happen before.
402 // (This may have to change if this code changes!)
403 assert(klass->is_klass(), "not a class");
404 BasicType elt_type = TypeArrayKlass::cast(klass)->element_type();
405 oop obj = oopFactory::new_typeArray(elt_type, length, CHECK);
406 current->set_vm_result_oop(obj);
407 // This is pretty rare but this runtime patch is stressful to deoptimization
408 // if we deoptimize here so force a deopt to stress the path.
409 if (DeoptimizeALot) {
410 deopt_caller(current);
411 }
412
413 JRT_END
414
415
416 JRT_ENTRY(void, Runtime1::new_object_array(JavaThread* current, Klass* array_klass, jint length))
417 #ifndef PRODUCT
418 if (PrintC1Statistics) {
419 _new_object_array_slowcase_cnt++;
420 }
421 #endif
422 // Note: no handle for klass needed since they are not used
423 // anymore after new_objArray() and no GC can happen before.
424 // (This may have to change if this code changes!)
425 assert(array_klass->is_klass(), "not a class");
426 Handle holder(current, array_klass->klass_holder()); // keep the klass alive
427 Klass* elem_klass = ObjArrayKlass::cast(array_klass)->element_klass();
428 objArrayOop obj = oopFactory::new_objArray(elem_klass, length, CHECK);
429 current->set_vm_result_oop(obj);
430 // This is pretty rare but this runtime patch is stressful to deoptimization
431 // if we deoptimize here so force a deopt to stress the path.
432 if (DeoptimizeALot) {
433 deopt_caller(current);
434 }
435 JRT_END
436
437
438 JRT_ENTRY(void, Runtime1::new_multi_array(JavaThread* current, Klass* klass, int rank, jint* dims))
439 #ifndef PRODUCT
440 if (PrintC1Statistics) {
441 _new_multi_array_slowcase_cnt++;
442 }
443 #endif
444 assert(klass->is_klass(), "not a class");
445 assert(rank >= 1, "rank must be nonzero");
446 Handle holder(current, klass->klass_holder()); // keep the klass alive
447 oop obj = ArrayKlass::cast(klass)->multi_allocate(rank, dims, CHECK);
448 current->set_vm_result_oop(obj);
449 JRT_END
450
451
452 JRT_ENTRY(void, Runtime1::unimplemented_entry(JavaThread* current, StubId id))
453 tty->print_cr("Runtime1::entry_for(%d) returned unimplemented entry point", (int)id);
454 JRT_END
455
456
457 JRT_ENTRY(void, Runtime1::throw_array_store_exception(JavaThread* current, oopDesc* obj))
458 ResourceMark rm(current);
459 const char* klass_name = obj->klass()->external_name();
460 SharedRuntime::throw_and_post_jvmti_exception(current, vmSymbols::java_lang_ArrayStoreException(), klass_name);
461 JRT_END
462
463
464 // counter_overflow() is called from within C1-compiled methods. The enclosing method is the method
465 // associated with the top activation record. The inlinee (that is possibly included in the enclosing
466 // method) method is passed as an argument. In order to do that it is embedded in the code as
467 // a constant.
468 static nmethod* counter_overflow_helper(JavaThread* current, int branch_bci, Method* m) {
469 nmethod* osr_nm = nullptr;
470 methodHandle method(current, m);
471
472 RegisterMap map(current,
473 RegisterMap::UpdateMap::skip,
474 RegisterMap::ProcessFrames::include,
475 RegisterMap::WalkContinuation::skip);
476 frame fr = current->last_frame().sender(&map);
477 nmethod* nm = (nmethod*) fr.cb();
478 assert(nm!= nullptr && nm->is_nmethod(), "Sanity check");
479 methodHandle enclosing_method(current, nm->method());
480
481 CompLevel level = (CompLevel)nm->comp_level();
482 int bci = InvocationEntryBci;
483 if (branch_bci != InvocationEntryBci) {
484 // Compute destination bci
485 address pc = method()->code_base() + branch_bci;
486 Bytecodes::Code branch = Bytecodes::code_at(method(), pc);
487 int offset = 0;
488 switch (branch) {
489 case Bytecodes::_if_icmplt: case Bytecodes::_iflt:
490 case Bytecodes::_if_icmpgt: case Bytecodes::_ifgt:
491 case Bytecodes::_if_icmple: case Bytecodes::_ifle:
492 case Bytecodes::_if_icmpge: case Bytecodes::_ifge:
493 case Bytecodes::_if_icmpeq: case Bytecodes::_if_acmpeq: case Bytecodes::_ifeq:
494 case Bytecodes::_if_icmpne: case Bytecodes::_if_acmpne: case Bytecodes::_ifne:
495 case Bytecodes::_ifnull: case Bytecodes::_ifnonnull: case Bytecodes::_goto:
496 offset = (int16_t)Bytes::get_Java_u2(pc + 1);
497 break;
498 case Bytecodes::_goto_w:
499 offset = Bytes::get_Java_u4(pc + 1);
500 break;
501 default: ;
502 }
503 bci = branch_bci + offset;
504 }
505 osr_nm = CompilationPolicy::event(enclosing_method, method, branch_bci, bci, level, nm, current);
506 return osr_nm;
507 }
508
509 JRT_BLOCK_ENTRY(address, Runtime1::counter_overflow(JavaThread* current, int bci, Method* method))
510 nmethod* osr_nm;
511 JRT_BLOCK_NO_ASYNC
512 osr_nm = counter_overflow_helper(current, bci, method);
513 if (osr_nm != nullptr) {
514 RegisterMap map(current,
515 RegisterMap::UpdateMap::skip,
516 RegisterMap::ProcessFrames::include,
517 RegisterMap::WalkContinuation::skip);
518 frame fr = current->last_frame().sender(&map);
519 Deoptimization::deoptimize_frame(current, fr.id());
520 }
521 JRT_BLOCK_END
522 return nullptr;
523 JRT_END
524
525 extern void vm_exit(int code);
526
527 // Enter this method from compiled code handler below. This is where we transition
528 // to VM mode. This is done as a helper routine so that the method called directly
529 // from compiled code does not have to transition to VM. This allows the entry
530 // method to see if the nmethod that we have just looked up a handler for has
531 // been deoptimized while we were in the vm. This simplifies the assembly code
532 // cpu directories.
533 //
534 // We are entering here from exception stub (via the entry method below)
535 // If there is a compiled exception handler in this method, we will continue there;
536 // otherwise we will unwind the stack and continue at the caller of top frame method
537 // Note: we enter in Java using a special JRT wrapper. This wrapper allows us to
538 // control the area where we can allow a safepoint. After we exit the safepoint area we can
539 // check to see if the handler we are going to return is now in a nmethod that has
540 // been deoptimized. If that is the case we return the deopt blob
541 // unpack_with_exception entry instead. This makes life for the exception blob easier
542 // because making that same check and diverting is painful from assembly language.
543 JRT_ENTRY_NO_ASYNC(static address, exception_handler_for_pc_helper(JavaThread* current, oopDesc* ex, address pc, nmethod*& nm))
544 MACOS_AARCH64_ONLY(current->wx_enable_write());
545 Handle exception(current, ex);
546
547 // This function is called when we are about to throw an exception. Therefore,
548 // we have to poll the stack watermark barrier to make sure that not yet safe
549 // stack frames are made safe before returning into them.
550 if (current->last_frame().cb() == Runtime1::blob_for(StubId::c1_handle_exception_from_callee_id)) {
551 // The StubId::c1_handle_exception_from_callee_id handler is invoked after the
552 // frame has been unwound. It instead builds its own stub frame, to call the
553 // runtime. But the throwing frame has already been unwound here.
554 StackWatermarkSet::after_unwind(current);
555 }
556
557 nm = CodeCache::find_nmethod(pc);
558 assert(nm != nullptr, "this is not an nmethod");
559 // Adjust the pc as needed/
560 if (nm->is_deopt_pc(pc)) {
561 RegisterMap map(current,
562 RegisterMap::UpdateMap::skip,
563 RegisterMap::ProcessFrames::include,
564 RegisterMap::WalkContinuation::skip);
565 frame exception_frame = current->last_frame().sender(&map);
566 // if the frame isn't deopted then pc must not correspond to the caller of last_frame
567 assert(exception_frame.is_deoptimized_frame(), "must be deopted");
568 pc = exception_frame.pc();
569 }
570 assert(exception.not_null(), "null exceptions should be handled by throw_exception");
571 // Check that exception is a subclass of Throwable
572 assert(exception->is_a(vmClasses::Throwable_klass()),
573 "Exception not subclass of Throwable");
574
575 // debugging support
576 // tracing
577 if (log_is_enabled(Info, exceptions)) {
578 ResourceMark rm; // print_value_string
579 stringStream tempst;
580 assert(nm->method() != nullptr, "Unexpected null method()");
581 tempst.print("C1 compiled method <%s>\n"
582 " at PC" INTPTR_FORMAT " for thread " INTPTR_FORMAT,
583 nm->method()->print_value_string(), p2i(pc), p2i(current));
584 Exceptions::log_exception(exception, tempst.freeze());
585 }
586 // for AbortVMOnException flag
587 Exceptions::debug_check_abort(exception);
588
589 // Check the stack guard pages and re-enable them if necessary and there is
590 // enough space on the stack to do so. Use fast exceptions only if the guard
591 // pages are enabled.
592 bool guard_pages_enabled = current->stack_overflow_state()->reguard_stack_if_needed();
593
594 if (JvmtiExport::can_post_on_exceptions()) {
595 // To ensure correct notification of exception catches and throws
596 // we have to deoptimize here. If we attempted to notify the
597 // catches and throws during this exception lookup it's possible
598 // we could deoptimize on the way out of the VM and end back in
599 // the interpreter at the throw site. This would result in double
600 // notifications since the interpreter would also notify about
601 // these same catches and throws as it unwound the frame.
602
603 RegisterMap reg_map(current,
604 RegisterMap::UpdateMap::include,
605 RegisterMap::ProcessFrames::include,
606 RegisterMap::WalkContinuation::skip);
607 frame stub_frame = current->last_frame();
608 frame caller_frame = stub_frame.sender(®_map);
609
610 // We don't really want to deoptimize the nmethod itself since we
611 // can actually continue in the exception handler ourselves but I
612 // don't see an easy way to have the desired effect.
613 Deoptimization::deoptimize_frame(current, caller_frame.id());
614 assert(caller_is_deopted(current), "Must be deoptimized");
615
616 return SharedRuntime::deopt_blob()->unpack_with_exception_in_tls();
617 }
618
619 // ExceptionCache is used only for exceptions at call sites and not for implicit exceptions
620 if (guard_pages_enabled) {
621 address fast_continuation = nm->handler_for_exception_and_pc(exception, pc);
622 if (fast_continuation != nullptr) {
623 return fast_continuation;
624 }
625 }
626
627 // If the stack guard pages are enabled, check whether there is a handler in
628 // the current method. Otherwise (guard pages disabled), force an unwind and
629 // skip the exception cache update (i.e., just leave continuation as null).
630 address continuation = nullptr;
631 if (guard_pages_enabled) {
632
633 // New exception handling mechanism can support inlined methods
634 // with exception handlers since the mappings are from PC to PC
635
636 // Clear out the exception oop and pc since looking up an
637 // exception handler can cause class loading, which might throw an
638 // exception and those fields are expected to be clear during
639 // normal bytecode execution.
640 current->clear_exception_oop_and_pc();
641
642 bool recursive_exception = false;
643 continuation = SharedRuntime::compute_compiled_exc_handler(nm, pc, exception, false, false, recursive_exception);
644 // If an exception was thrown during exception dispatch, the exception oop may have changed
645 current->set_exception_oop(exception());
646 current->set_exception_pc(pc);
647
648 // the exception cache is used only by non-implicit exceptions
649 // Update the exception cache only when there didn't happen
650 // another exception during the computation of the compiled
651 // exception handler. Checking for exception oop equality is not
652 // sufficient because some exceptions are pre-allocated and reused.
653 if (continuation != nullptr && !recursive_exception) {
654 nm->add_handler_for_exception_and_pc(exception, pc, continuation);
655 }
656 }
657
658 current->set_vm_result_oop(exception());
659
660 if (log_is_enabled(Info, exceptions)) {
661 ResourceMark rm;
662 log_info(exceptions)("Thread " PTR_FORMAT " continuing at PC " PTR_FORMAT
663 " for exception thrown at PC " PTR_FORMAT,
664 p2i(current), p2i(continuation), p2i(pc));
665 }
666
667 return continuation;
668 JRT_END
669
670 // Enter this method from compiled code only if there is a Java exception handler
671 // in the method handling the exception.
672 // We are entering here from exception stub. We don't do a normal VM transition here.
673 // We do it in a helper. This is so we can check to see if the nmethod we have just
674 // searched for an exception handler has been deoptimized in the meantime.
675 address Runtime1::exception_handler_for_pc(JavaThread* current) {
676 oop exception = current->exception_oop();
677 address pc = current->exception_pc();
678 // Still in Java mode
679 DEBUG_ONLY(NoHandleMark nhm);
680 nmethod* nm = nullptr;
681 address continuation = nullptr;
682 {
683 // Enter VM mode by calling the helper
684 ResetNoHandleMark rnhm;
685 continuation = exception_handler_for_pc_helper(current, exception, pc, nm);
686 }
687 // Back in JAVA, use no oops DON'T safepoint
688
689 // Now check to see if the nmethod we were called from is now deoptimized.
690 // If so we must return to the deopt blob and deoptimize the nmethod
691 if (nm != nullptr && caller_is_deopted(current)) {
692 continuation = SharedRuntime::deopt_blob()->unpack_with_exception_in_tls();
693 }
694
695 assert(continuation != nullptr, "no handler found");
696 return continuation;
697 }
698
699
700 JRT_ENTRY(void, Runtime1::throw_range_check_exception(JavaThread* current, int index, arrayOopDesc* a))
701 #ifndef PRODUCT
702 if (PrintC1Statistics) {
703 _throw_range_check_exception_count++;
704 }
705 #endif
706 const int len = 35;
707 assert(len < strlen("Index %d out of bounds for length %d"), "Must allocate more space for message.");
708 char message[2 * jintAsStringSize + len];
709 os::snprintf_checked(message, sizeof(message), "Index %d out of bounds for length %d", index, a->length());
710 SharedRuntime::throw_and_post_jvmti_exception(current, vmSymbols::java_lang_ArrayIndexOutOfBoundsException(), message);
711 JRT_END
712
713
714 JRT_ENTRY(void, Runtime1::throw_index_exception(JavaThread* current, int index))
715 #ifndef PRODUCT
716 if (PrintC1Statistics) {
717 _throw_index_exception_count++;
718 }
719 #endif
720 char message[16];
721 os::snprintf_checked(message, sizeof(message), "%d", index);
722 SharedRuntime::throw_and_post_jvmti_exception(current, vmSymbols::java_lang_IndexOutOfBoundsException(), message);
723 JRT_END
724
725
726 JRT_ENTRY(void, Runtime1::throw_div0_exception(JavaThread* current))
727 #ifndef PRODUCT
728 if (PrintC1Statistics) {
729 _throw_div0_exception_count++;
730 }
731 #endif
732 SharedRuntime::throw_and_post_jvmti_exception(current, vmSymbols::java_lang_ArithmeticException(), "/ by zero");
733 JRT_END
734
735
736 JRT_ENTRY(void, Runtime1::throw_null_pointer_exception(JavaThread* current))
737 #ifndef PRODUCT
738 if (PrintC1Statistics) {
739 _throw_null_pointer_exception_count++;
740 }
741 #endif
742 SharedRuntime::throw_and_post_jvmti_exception(current, vmSymbols::java_lang_NullPointerException());
743 JRT_END
744
745
746 JRT_ENTRY(void, Runtime1::throw_class_cast_exception(JavaThread* current, oopDesc* object))
747 #ifndef PRODUCT
748 if (PrintC1Statistics) {
749 _throw_class_cast_exception_count++;
750 }
751 #endif
752 ResourceMark rm(current);
753 char* message = SharedRuntime::generate_class_cast_message(current, object->klass());
754 SharedRuntime::throw_and_post_jvmti_exception(current, vmSymbols::java_lang_ClassCastException(), message);
755 JRT_END
756
757
758 JRT_ENTRY(void, Runtime1::throw_incompatible_class_change_error(JavaThread* current))
759 #ifndef PRODUCT
760 if (PrintC1Statistics) {
761 _throw_incompatible_class_change_error_count++;
762 }
763 #endif
764 ResourceMark rm(current);
765 SharedRuntime::throw_and_post_jvmti_exception(current, vmSymbols::java_lang_IncompatibleClassChangeError());
766 JRT_END
767
768
769 JRT_BLOCK_ENTRY(void, Runtime1::monitorenter(JavaThread* current, oopDesc* obj, BasicObjectLock* lock))
770 #ifndef PRODUCT
771 if (PrintC1Statistics) {
772 _monitorenter_slowcase_cnt++;
773 }
774 #endif
775 assert(obj == lock->obj(), "must match");
776 SharedRuntime::monitor_enter_helper(obj, lock->lock(), current);
777 JRT_END
778
779
780 JRT_LEAF(void, Runtime1::monitorexit(JavaThread* current, BasicObjectLock* lock))
781 assert(current == JavaThread::current(), "pre-condition");
782 #ifndef PRODUCT
783 if (PrintC1Statistics) {
784 _monitorexit_slowcase_cnt++;
785 }
786 #endif
787 assert(current->last_Java_sp(), "last_Java_sp must be set");
788 oop obj = lock->obj();
789 assert(oopDesc::is_oop(obj), "must be null or an object");
790 SharedRuntime::monitor_exit_helper(obj, lock->lock(), current);
791 JRT_END
792
793 // Cf. OptoRuntime::deoptimize_caller_frame
794 JRT_ENTRY(void, Runtime1::deoptimize(JavaThread* current, jint trap_request))
795 // Called from within the owner thread, so no need for safepoint
796 RegisterMap reg_map(current,
797 RegisterMap::UpdateMap::skip,
798 RegisterMap::ProcessFrames::include,
799 RegisterMap::WalkContinuation::skip);
800 frame stub_frame = current->last_frame();
801 assert(stub_frame.is_runtime_frame(), "Sanity check");
802 frame caller_frame = stub_frame.sender(®_map);
803 nmethod* nm = caller_frame.cb()->as_nmethod_or_null();
804 assert(nm != nullptr, "Sanity check");
805 methodHandle method(current, nm->method());
806 assert(nm == CodeCache::find_nmethod(caller_frame.pc()), "Should be the same");
807 Deoptimization::DeoptAction action = Deoptimization::trap_request_action(trap_request);
808 Deoptimization::DeoptReason reason = Deoptimization::trap_request_reason(trap_request);
809
810 if (action == Deoptimization::Action_make_not_entrant) {
811 if (nm->make_not_entrant(nmethod::InvalidationReason::C1_DEOPTIMIZE)) {
812 if (reason == Deoptimization::Reason_tenured) {
813 MethodData* trap_mdo = Deoptimization::get_method_data(current, method, true /*create_if_missing*/);
814 if (trap_mdo != nullptr) {
815 trap_mdo->inc_tenure_traps();
816 }
817 }
818 }
819 }
820
821 // Deoptimize the caller frame.
822 Deoptimization::deoptimize_frame(current, caller_frame.id());
823 // Return to the now deoptimized frame.
824 JRT_END
825
826
827 #ifndef DEOPTIMIZE_WHEN_PATCHING
828
829 static Klass* resolve_field_return_klass(const methodHandle& caller, int bci, TRAPS) {
830 Bytecode_field field_access(caller, bci);
831 // This can be static or non-static field access
832 Bytecodes::Code code = field_access.code();
833
834 // We must load class, initialize class and resolve the field
835 fieldDescriptor result; // initialize class if needed
836 constantPoolHandle constants(THREAD, caller->constants());
837 LinkResolver::resolve_field_access(result, constants, field_access.index(), caller, Bytecodes::java_code(code), CHECK_NULL);
838 return result.field_holder();
839 }
840
841
842 //
843 // This routine patches sites where a class wasn't loaded or
844 // initialized at the time the code was generated. It handles
845 // references to classes, fields and forcing of initialization. Most
846 // of the cases are straightforward and involving simply forcing
847 // resolution of a class, rewriting the instruction stream with the
848 // needed constant and replacing the call in this function with the
849 // patched code. The case for static field is more complicated since
850 // the thread which is in the process of initializing a class can
851 // access it's static fields but other threads can't so the code
852 // either has to deoptimize when this case is detected or execute a
853 // check that the current thread is the initializing thread. The
854 // current
855 //
856 // Patches basically look like this:
857 //
858 //
859 // patch_site: jmp patch stub ;; will be patched
860 // continue: ...
861 // ...
862 // ...
863 // ...
864 //
865 // They have a stub which looks like this:
866 //
867 // ;; patch body
868 // movl <const>, reg (for class constants)
869 // <or> movl [reg1 + <const>], reg (for field offsets)
870 // <or> movl reg, [reg1 + <const>] (for field offsets)
871 // <being_init offset> <bytes to copy> <bytes to skip>
872 // patch_stub: call Runtime1::patch_code (through a runtime stub)
873 // jmp patch_site
874 //
875 //
876 // A normal patch is done by rewriting the patch body, usually a move,
877 // and then copying it into place over top of the jmp instruction
878 // being careful to flush caches and doing it in an MP-safe way. The
879 // constants following the patch body are used to find various pieces
880 // of the patch relative to the call site for Runtime1::patch_code.
881 // The case for getstatic and putstatic is more complicated because
882 // getstatic and putstatic have special semantics when executing while
883 // the class is being initialized. getstatic/putstatic on a class
884 // which is being_initialized may be executed by the initializing
885 // thread but other threads have to block when they execute it. This
886 // is accomplished in compiled code by executing a test of the current
887 // thread against the initializing thread of the class. It's emitted
888 // as boilerplate in their stub which allows the patched code to be
889 // executed before it's copied back into the main body of the nmethod.
890 //
891 // being_init: get_thread(<tmp reg>
892 // cmpl [reg1 + <init_thread_offset>], <tmp reg>
893 // jne patch_stub
894 // movl [reg1 + <const>], reg (for field offsets) <or>
895 // movl reg, [reg1 + <const>] (for field offsets)
896 // jmp continue
897 // <being_init offset> <bytes to copy> <bytes to skip>
898 // patch_stub: jmp Runtime1::patch_code (through a runtime stub)
899 // jmp patch_site
900 //
901 // If the class is being initialized the patch body is rewritten and
902 // the patch site is rewritten to jump to being_init, instead of
903 // patch_stub. Whenever this code is executed it checks the current
904 // thread against the initializing thread so other threads will enter
905 // the runtime and end up blocked waiting the class to finish
906 // initializing inside the calls to resolve_field below. The
907 // initializing class will continue on it's way. Once the class is
908 // fully_initialized, the intializing_thread of the class becomes
909 // null, so the next thread to execute this code will fail the test,
910 // call into patch_code and complete the patching process by copying
911 // the patch body back into the main part of the nmethod and resume
912 // executing.
913
914 // NB:
915 //
916 // Patchable instruction sequences inherently exhibit race conditions,
917 // where thread A is patching an instruction at the same time thread B
918 // is executing it. The algorithms we use ensure that any observation
919 // that B can make on any intermediate states during A's patching will
920 // always end up with a correct outcome. This is easiest if there are
921 // few or no intermediate states. (Some inline caches have two
922 // related instructions that must be patched in tandem. For those,
923 // intermediate states seem to be unavoidable, but we will get the
924 // right answer from all possible observation orders.)
925 //
926 // When patching the entry instruction at the head of a method, or a
927 // linkable call instruction inside of a method, we try very hard to
928 // use a patch sequence which executes as a single memory transaction.
929 // This means, in practice, that when thread A patches an instruction,
930 // it should patch a 32-bit or 64-bit word that somehow overlaps the
931 // instruction or is contained in it. We believe that memory hardware
932 // will never break up such a word write, if it is naturally aligned
933 // for the word being written. We also know that some CPUs work very
934 // hard to create atomic updates even of naturally unaligned words,
935 // but we don't want to bet the farm on this always working.
936 //
937 // Therefore, if there is any chance of a race condition, we try to
938 // patch only naturally aligned words, as single, full-word writes.
939
940 JRT_ENTRY(void, Runtime1::patch_code(JavaThread* current, StubId stub_id ))
941 #ifndef PRODUCT
942 if (PrintC1Statistics) {
943 _patch_code_slowcase_cnt++;
944 }
945 #endif
946
947 ResourceMark rm(current);
948 RegisterMap reg_map(current,
949 RegisterMap::UpdateMap::skip,
950 RegisterMap::ProcessFrames::include,
951 RegisterMap::WalkContinuation::skip);
952 frame runtime_frame = current->last_frame();
953 frame caller_frame = runtime_frame.sender(®_map);
954
955 // last java frame on stack
956 vframeStream vfst(current, true);
957 assert(!vfst.at_end(), "Java frame must exist");
958
959 methodHandle caller_method(current, vfst.method());
960 // Note that caller_method->code() may not be same as caller_code because of OSR's
961 // Note also that in the presence of inlining it is not guaranteed
962 // that caller_method() == caller_code->method()
963
964 int bci = vfst.bci();
965 Bytecodes::Code code = caller_method()->java_code_at(bci);
966
967 // this is used by assertions in the access_field_patching_id
968 BasicType patch_field_type = T_ILLEGAL;
969 bool deoptimize_for_volatile = false;
970 bool deoptimize_for_atomic = false;
971 int patch_field_offset = -1;
972 Klass* init_klass = nullptr; // klass needed by load_klass_patching code
973 Klass* load_klass = nullptr; // klass needed by load_klass_patching code
974 Handle mirror(current, nullptr); // oop needed by load_mirror_patching code
975 Handle appendix(current, nullptr); // oop needed by appendix_patching code
976 bool load_klass_or_mirror_patch_id =
977 (stub_id == StubId::c1_load_klass_patching_id || stub_id == StubId::c1_load_mirror_patching_id);
978
979 if (stub_id == StubId::c1_access_field_patching_id) {
980
981 Bytecode_field field_access(caller_method, bci);
982 fieldDescriptor result; // initialize class if needed
983 Bytecodes::Code code = field_access.code();
984 constantPoolHandle constants(current, caller_method->constants());
985 LinkResolver::resolve_field_access(result, constants, field_access.index(), caller_method, Bytecodes::java_code(code), CHECK);
986 patch_field_offset = result.offset();
987
988 // If we're patching a field which is volatile then at compile it
989 // must not have been know to be volatile, so the generated code
990 // isn't correct for a volatile reference. The nmethod has to be
991 // deoptimized so that the code can be regenerated correctly.
992 // This check is only needed for access_field_patching since this
993 // is the path for patching field offsets. load_klass is only
994 // used for patching references to oops which don't need special
995 // handling in the volatile case.
996
997 deoptimize_for_volatile = result.access_flags().is_volatile();
998
999 // If we are patching a field which should be atomic, then
1000 // the generated code is not correct either, force deoptimizing.
1001 // We need to only cover T_LONG and T_DOUBLE fields, as we can
1002 // break access atomicity only for them.
1003
1004 // Strictly speaking, the deoptimization on 64-bit platforms
1005 // is unnecessary, and T_LONG stores on 32-bit platforms need
1006 // to be handled by special patching code when AlwaysAtomicAccesses
1007 // becomes product feature. At this point, we are still going
1008 // for the deoptimization for consistency against volatile
1009 // accesses.
1010
1011 patch_field_type = result.field_type();
1012 deoptimize_for_atomic = (AlwaysAtomicAccesses && (patch_field_type == T_DOUBLE || patch_field_type == T_LONG));
1013
1014 } else if (load_klass_or_mirror_patch_id) {
1015 Klass* k = nullptr;
1016 switch (code) {
1017 case Bytecodes::_putstatic:
1018 case Bytecodes::_getstatic:
1019 { Klass* klass = resolve_field_return_klass(caller_method, bci, CHECK);
1020 init_klass = klass;
1021 mirror = Handle(current, klass->java_mirror());
1022 }
1023 break;
1024 case Bytecodes::_new:
1025 { Bytecode_new bnew(caller_method(), caller_method->bcp_from(bci));
1026 k = caller_method->constants()->klass_at(bnew.index(), CHECK);
1027 }
1028 break;
1029 case Bytecodes::_multianewarray:
1030 { Bytecode_multianewarray mna(caller_method(), caller_method->bcp_from(bci));
1031 k = caller_method->constants()->klass_at(mna.index(), CHECK);
1032 }
1033 break;
1034 case Bytecodes::_instanceof:
1035 { Bytecode_instanceof io(caller_method(), caller_method->bcp_from(bci));
1036 k = caller_method->constants()->klass_at(io.index(), CHECK);
1037 }
1038 break;
1039 case Bytecodes::_checkcast:
1040 { Bytecode_checkcast cc(caller_method(), caller_method->bcp_from(bci));
1041 k = caller_method->constants()->klass_at(cc.index(), CHECK);
1042 }
1043 break;
1044 case Bytecodes::_anewarray:
1045 { Bytecode_anewarray anew(caller_method(), caller_method->bcp_from(bci));
1046 Klass* ek = caller_method->constants()->klass_at(anew.index(), CHECK);
1047 k = ek->array_klass(CHECK);
1048 }
1049 break;
1050 case Bytecodes::_ldc:
1051 case Bytecodes::_ldc_w:
1052 case Bytecodes::_ldc2_w:
1053 {
1054 Bytecode_loadconstant cc(caller_method, bci);
1055 oop m = cc.resolve_constant(CHECK);
1056 mirror = Handle(current, m);
1057 }
1058 break;
1059 default: fatal("unexpected bytecode for load_klass_or_mirror_patch_id");
1060 }
1061 load_klass = k;
1062 } else if (stub_id == StubId::c1_load_appendix_patching_id) {
1063 Bytecode_invoke bytecode(caller_method, bci);
1064 Bytecodes::Code bc = bytecode.invoke_code();
1065
1066 CallInfo info;
1067 constantPoolHandle pool(current, caller_method->constants());
1068 int index = bytecode.index();
1069 LinkResolver::resolve_invoke(info, Handle(), pool, index, bc, CHECK);
1070 switch (bc) {
1071 case Bytecodes::_invokehandle: {
1072 ResolvedMethodEntry* entry = pool->cache()->set_method_handle(index, info);
1073 appendix = Handle(current, pool->cache()->appendix_if_resolved(entry));
1074 break;
1075 }
1076 case Bytecodes::_invokedynamic: {
1077 appendix = Handle(current, pool->cache()->set_dynamic_call(info, index));
1078 break;
1079 }
1080 default: fatal("unexpected bytecode for load_appendix_patching_id");
1081 }
1082 } else {
1083 ShouldNotReachHere();
1084 }
1085
1086 if (deoptimize_for_volatile || deoptimize_for_atomic) {
1087 // At compile time we assumed the field wasn't volatile/atomic but after
1088 // loading it turns out it was volatile/atomic so we have to throw the
1089 // compiled code out and let it be regenerated.
1090 if (TracePatching) {
1091 if (deoptimize_for_volatile) {
1092 tty->print_cr("Deoptimizing for patching volatile field reference");
1093 }
1094 if (deoptimize_for_atomic) {
1095 tty->print_cr("Deoptimizing for patching atomic field reference");
1096 }
1097 }
1098
1099 // It's possible the nmethod was invalidated in the last
1100 // safepoint, but if it's still alive then make it not_entrant.
1101 nmethod* nm = CodeCache::find_nmethod(caller_frame.pc());
1102 if (nm != nullptr) {
1103 nm->make_not_entrant(nmethod::InvalidationReason::C1_CODEPATCH);
1104 }
1105
1106 Deoptimization::deoptimize_frame(current, caller_frame.id());
1107
1108 // Return to the now deoptimized frame.
1109 }
1110
1111 // Now copy code back
1112
1113 {
1114 MutexLocker ml_code (current, CodeCache_lock, Mutex::_no_safepoint_check_flag);
1115 //
1116 // Deoptimization may have happened while we waited for the lock.
1117 // In that case we don't bother to do any patching we just return
1118 // and let the deopt happen
1119 if (!caller_is_deopted(current)) {
1120 NativeGeneralJump* jump = nativeGeneralJump_at(caller_frame.pc());
1121 address instr_pc = jump->jump_destination();
1122 NativeInstruction* ni = nativeInstruction_at(instr_pc);
1123 if (ni->is_jump() ) {
1124 // the jump has not been patched yet
1125 // The jump destination is slow case and therefore not part of the stubs
1126 // (stubs are only for StaticCalls)
1127
1128 // format of buffer
1129 // ....
1130 // instr byte 0 <-- copy_buff
1131 // instr byte 1
1132 // ..
1133 // instr byte n-1
1134 // n
1135 // .... <-- call destination
1136
1137 address stub_location = caller_frame.pc() + PatchingStub::patch_info_offset();
1138 unsigned char* byte_count = (unsigned char*) (stub_location - 1);
1139 unsigned char* byte_skip = (unsigned char*) (stub_location - 2);
1140 unsigned char* being_initialized_entry_offset = (unsigned char*) (stub_location - 3);
1141 address copy_buff = stub_location - *byte_skip - *byte_count;
1142 address being_initialized_entry = stub_location - *being_initialized_entry_offset;
1143 if (TracePatching) {
1144 ttyLocker ttyl;
1145 tty->print_cr(" Patching %s at bci %d at address " INTPTR_FORMAT " (%s)", Bytecodes::name(code), bci,
1146 p2i(instr_pc), (stub_id == StubId::c1_access_field_patching_id) ? "field" : "klass");
1147 nmethod* caller_code = CodeCache::find_nmethod(caller_frame.pc());
1148 assert(caller_code != nullptr, "nmethod not found");
1149
1150 // NOTE we use pc() not original_pc() because we already know they are
1151 // identical otherwise we'd have never entered this block of code
1152
1153 const ImmutableOopMap* map = caller_code->oop_map_for_return_address(caller_frame.pc());
1154 assert(map != nullptr, "null check");
1155 map->print();
1156 tty->cr();
1157
1158 Disassembler::decode(copy_buff, copy_buff + *byte_count, tty);
1159 }
1160 // depending on the code below, do_patch says whether to copy the patch body back into the nmethod
1161 bool do_patch = true;
1162 if (stub_id == StubId::c1_access_field_patching_id) {
1163 // The offset may not be correct if the class was not loaded at code generation time.
1164 // Set it now.
1165 NativeMovRegMem* n_move = nativeMovRegMem_at(copy_buff);
1166 assert(n_move->offset() == 0 || (n_move->offset() == 4 && (patch_field_type == T_DOUBLE || patch_field_type == T_LONG)), "illegal offset for type");
1167 assert(patch_field_offset >= 0, "illegal offset");
1168 n_move->add_offset_in_bytes(patch_field_offset);
1169 } else if (load_klass_or_mirror_patch_id) {
1170 // If a getstatic or putstatic is referencing a klass which
1171 // isn't fully initialized, the patch body isn't copied into
1172 // place until initialization is complete. In this case the
1173 // patch site is setup so that any threads besides the
1174 // initializing thread are forced to come into the VM and
1175 // block.
1176 do_patch = (code != Bytecodes::_getstatic && code != Bytecodes::_putstatic) ||
1177 InstanceKlass::cast(init_klass)->is_initialized();
1178 NativeGeneralJump* jump = nativeGeneralJump_at(instr_pc);
1179 if (jump->jump_destination() == being_initialized_entry) {
1180 assert(do_patch == true, "initialization must be complete at this point");
1181 } else {
1182 // patch the instruction <move reg, klass>
1183 NativeMovConstReg* n_copy = nativeMovConstReg_at(copy_buff);
1184
1185 assert(n_copy->data() == 0 ||
1186 n_copy->data() == (intptr_t)Universe::non_oop_word(),
1187 "illegal init value");
1188 if (stub_id == StubId::c1_load_klass_patching_id) {
1189 assert(load_klass != nullptr, "klass not set");
1190 n_copy->set_data((intx) (load_klass));
1191 } else {
1192 // Don't need a G1 pre-barrier here since we assert above that data isn't an oop.
1193 n_copy->set_data(cast_from_oop<intx>(mirror()));
1194 }
1195
1196 if (TracePatching) {
1197 Disassembler::decode(copy_buff, copy_buff + *byte_count, tty);
1198 }
1199 }
1200 } else if (stub_id == StubId::c1_load_appendix_patching_id) {
1201 NativeMovConstReg* n_copy = nativeMovConstReg_at(copy_buff);
1202 assert(n_copy->data() == 0 ||
1203 n_copy->data() == (intptr_t)Universe::non_oop_word(),
1204 "illegal init value");
1205 n_copy->set_data(cast_from_oop<intx>(appendix()));
1206
1207 if (TracePatching) {
1208 Disassembler::decode(copy_buff, copy_buff + *byte_count, tty);
1209 }
1210 } else {
1211 ShouldNotReachHere();
1212 }
1213
1214 if (do_patch) {
1215 // replace instructions
1216 // first replace the tail, then the call
1217 #ifdef ARM
1218 if((load_klass_or_mirror_patch_id ||
1219 stub_id == StubId::c1_load_appendix_patching_id) &&
1220 nativeMovConstReg_at(copy_buff)->is_pc_relative()) {
1221 nmethod* nm = CodeCache::find_nmethod(instr_pc);
1222 address addr = nullptr;
1223 assert(nm != nullptr, "invalid nmethod_pc");
1224 RelocIterator mds(nm, copy_buff, copy_buff + 1);
1225 while (mds.next()) {
1226 if (mds.type() == relocInfo::oop_type) {
1227 assert(stub_id == StubId::c1_load_mirror_patching_id ||
1228 stub_id == StubId::c1_load_appendix_patching_id, "wrong stub id");
1229 oop_Relocation* r = mds.oop_reloc();
1230 addr = (address)r->oop_addr();
1231 break;
1232 } else if (mds.type() == relocInfo::metadata_type) {
1233 assert(stub_id == StubId::c1_load_klass_patching_id, "wrong stub id");
1234 metadata_Relocation* r = mds.metadata_reloc();
1235 addr = (address)r->metadata_addr();
1236 break;
1237 }
1238 }
1239 assert(addr != nullptr, "metadata relocation must exist");
1240 copy_buff -= *byte_count;
1241 NativeMovConstReg* n_copy2 = nativeMovConstReg_at(copy_buff);
1242 n_copy2->set_pc_relative_offset(addr, instr_pc);
1243 }
1244 #endif
1245
1246 for (int i = NativeGeneralJump::instruction_size; i < *byte_count; i++) {
1247 address ptr = copy_buff + i;
1248 int a_byte = (*ptr) & 0xFF;
1249 address dst = instr_pc + i;
1250 *(unsigned char*)dst = (unsigned char) a_byte;
1251 }
1252 ICache::invalidate_range(instr_pc, *byte_count);
1253 NativeGeneralJump::replace_mt_safe(instr_pc, copy_buff);
1254
1255 if (load_klass_or_mirror_patch_id ||
1256 stub_id == StubId::c1_load_appendix_patching_id) {
1257 relocInfo::relocType rtype =
1258 (stub_id == StubId::c1_load_klass_patching_id) ?
1259 relocInfo::metadata_type :
1260 relocInfo::oop_type;
1261 // update relocInfo to metadata
1262 nmethod* nm = CodeCache::find_nmethod(instr_pc);
1263 assert(nm != nullptr, "invalid nmethod_pc");
1264
1265 // The old patch site is now a move instruction so update
1266 // the reloc info so that it will get updated during
1267 // future GCs.
1268 RelocIterator iter(nm, (address)instr_pc, (address)(instr_pc + 1));
1269 relocInfo::change_reloc_info_for_address(&iter, (address) instr_pc,
1270 relocInfo::none, rtype);
1271 }
1272
1273 } else {
1274 ICache::invalidate_range(copy_buff, *byte_count);
1275 NativeGeneralJump::insert_unconditional(instr_pc, being_initialized_entry);
1276 }
1277 }
1278 }
1279 // If we are patching in a non-perm oop, make sure the nmethod
1280 // is on the right list.
1281 nmethod* nm = CodeCache::find_nmethod(caller_frame.pc());
1282 guarantee(nm != nullptr, "only nmethods can contain non-perm oops");
1283
1284 // Since we've patched some oops in the nmethod,
1285 // (re)register it with the heap.
1286 Universe::heap()->register_nmethod(nm);
1287 }
1288 JRT_END
1289
1290 #else // DEOPTIMIZE_WHEN_PATCHING
1291
1292 static bool is_patching_needed(JavaThread* current, StubId stub_id) {
1293 if (stub_id == StubId::c1_load_klass_patching_id ||
1294 stub_id == StubId::c1_load_mirror_patching_id) {
1295 // last java frame on stack
1296 vframeStream vfst(current, true);
1297 assert(!vfst.at_end(), "Java frame must exist");
1298
1299 methodHandle caller_method(current, vfst.method());
1300 int bci = vfst.bci();
1301 Bytecodes::Code code = caller_method()->java_code_at(bci);
1302
1303 switch (code) {
1304 case Bytecodes::_new:
1305 case Bytecodes::_anewarray:
1306 case Bytecodes::_multianewarray:
1307 case Bytecodes::_instanceof:
1308 case Bytecodes::_checkcast: {
1309 Bytecode bc(caller_method(), caller_method->bcp_from(bci));
1310 constantTag tag = caller_method->constants()->tag_at(bc.get_index_u2(code));
1311 if (tag.is_unresolved_klass_in_error()) {
1312 return false; // throws resolution error
1313 }
1314 break;
1315 }
1316
1317 default: break;
1318 }
1319 }
1320 return true;
1321 }
1322
1323 void Runtime1::patch_code(JavaThread* current, StubId stub_id) {
1324 #ifndef PRODUCT
1325 if (PrintC1Statistics) {
1326 _patch_code_slowcase_cnt++;
1327 }
1328 #endif
1329
1330 // Enable WXWrite: the function is called by c1 stub as a runtime function
1331 // (see another implementation above).
1332 MACOS_AARCH64_ONLY(ThreadWXEnable wx(WXWrite, current));
1333
1334 if (TracePatching) {
1335 tty->print_cr("Deoptimizing because patch is needed");
1336 }
1337
1338 RegisterMap reg_map(current,
1339 RegisterMap::UpdateMap::skip,
1340 RegisterMap::ProcessFrames::include,
1341 RegisterMap::WalkContinuation::skip);
1342
1343 frame runtime_frame = current->last_frame();
1344 frame caller_frame = runtime_frame.sender(®_map);
1345 assert(caller_frame.is_compiled_frame(), "Wrong frame type");
1346
1347 if (is_patching_needed(current, stub_id)) {
1348 // Make sure the nmethod is invalidated, i.e. made not entrant.
1349 nmethod* nm = CodeCache::find_nmethod(caller_frame.pc());
1350 if (nm != nullptr) {
1351 nm->make_not_entrant(nmethod::InvalidationReason::C1_DEOPTIMIZE_FOR_PATCHING);
1352 }
1353 }
1354
1355 Deoptimization::deoptimize_frame(current, caller_frame.id());
1356 // Return to the now deoptimized frame.
1357 postcond(caller_is_deopted(current));
1358 }
1359
1360 #endif // DEOPTIMIZE_WHEN_PATCHING
1361
1362 // Entry point for compiled code. We want to patch a nmethod.
1363 // We don't do a normal VM transition here because we want to
1364 // know after the patching is complete and any safepoint(s) are taken
1365 // if the calling nmethod was deoptimized. We do this by calling a
1366 // helper method which does the normal VM transition and when it
1367 // completes we can check for deoptimization. This simplifies the
1368 // assembly code in the cpu directories.
1369 //
1370 int Runtime1::move_klass_patching(JavaThread* current) {
1371 //
1372 // NOTE: we are still in Java
1373 //
1374 DEBUG_ONLY(NoHandleMark nhm;)
1375 {
1376 // Enter VM mode
1377 ResetNoHandleMark rnhm;
1378 patch_code(current, StubId::c1_load_klass_patching_id);
1379 }
1380 // Back in JAVA, use no oops DON'T safepoint
1381
1382 // Return true if calling code is deoptimized
1383
1384 return caller_is_deopted(current);
1385 }
1386
1387 int Runtime1::move_mirror_patching(JavaThread* current) {
1388 //
1389 // NOTE: we are still in Java
1390 //
1391 DEBUG_ONLY(NoHandleMark nhm;)
1392 {
1393 // Enter VM mode
1394 ResetNoHandleMark rnhm;
1395 patch_code(current, StubId::c1_load_mirror_patching_id);
1396 }
1397 // Back in JAVA, use no oops DON'T safepoint
1398
1399 // Return true if calling code is deoptimized
1400
1401 return caller_is_deopted(current);
1402 }
1403
1404 int Runtime1::move_appendix_patching(JavaThread* current) {
1405 //
1406 // NOTE: we are still in Java
1407 //
1408 DEBUG_ONLY(NoHandleMark nhm;)
1409 {
1410 // Enter VM mode
1411 ResetNoHandleMark rnhm;
1412 patch_code(current, StubId::c1_load_appendix_patching_id);
1413 }
1414 // Back in JAVA, use no oops DON'T safepoint
1415
1416 // Return true if calling code is deoptimized
1417
1418 return caller_is_deopted(current);
1419 }
1420
1421 // Entry point for compiled code. We want to patch a nmethod.
1422 // We don't do a normal VM transition here because we want to
1423 // know after the patching is complete and any safepoint(s) are taken
1424 // if the calling nmethod was deoptimized. We do this by calling a
1425 // helper method which does the normal VM transition and when it
1426 // completes we can check for deoptimization. This simplifies the
1427 // assembly code in the cpu directories.
1428 //
1429 int Runtime1::access_field_patching(JavaThread* current) {
1430 //
1431 // NOTE: we are still in Java
1432 //
1433 // Handles created in this function will be deleted by the
1434 // HandleMarkCleaner in the transition to the VM.
1435 NoHandleMark nhm;
1436 {
1437 // Enter VM mode
1438 ResetNoHandleMark rnhm;
1439 patch_code(current, StubId::c1_access_field_patching_id);
1440 }
1441 // Back in JAVA, use no oops DON'T safepoint
1442
1443 // Return true if calling code is deoptimized
1444
1445 return caller_is_deopted(current);
1446 }
1447
1448
1449 JRT_LEAF(void, Runtime1::trace_block_entry(jint block_id))
1450 // for now we just print out the block id
1451 tty->print("%d ", block_id);
1452 JRT_END
1453
1454
1455 JRT_LEAF(int, Runtime1::is_instance_of(oopDesc* mirror, oopDesc* obj))
1456 // had to return int instead of bool, otherwise there may be a mismatch
1457 // between the C calling convention and the Java one.
1458 // e.g., on x86, GCC may clear only %al when returning a bool false, but
1459 // JVM takes the whole %eax as the return value, which may misinterpret
1460 // the return value as a boolean true.
1461
1462 assert(mirror != nullptr, "should null-check on mirror before calling");
1463 Klass* k = java_lang_Class::as_Klass(mirror);
1464 return (k != nullptr && obj != nullptr && obj->is_a(k)) ? 1 : 0;
1465 JRT_END
1466
1467 JRT_ENTRY(void, Runtime1::predicate_failed_trap(JavaThread* current))
1468 ResourceMark rm;
1469
1470 RegisterMap reg_map(current,
1471 RegisterMap::UpdateMap::skip,
1472 RegisterMap::ProcessFrames::include,
1473 RegisterMap::WalkContinuation::skip);
1474 frame runtime_frame = current->last_frame();
1475 frame caller_frame = runtime_frame.sender(®_map);
1476
1477 nmethod* nm = CodeCache::find_nmethod(caller_frame.pc());
1478 assert (nm != nullptr, "no more nmethod?");
1479 nm->make_not_entrant(nmethod::InvalidationReason::C1_PREDICATE_FAILED_TRAP);
1480
1481 methodHandle m(current, nm->method());
1482 MethodData* mdo = m->method_data();
1483
1484 if (mdo == nullptr && !HAS_PENDING_EXCEPTION) {
1485 // Build an MDO. Ignore errors like OutOfMemory;
1486 // that simply means we won't have an MDO to update.
1487 Method::build_profiling_method_data(m, THREAD);
1488 if (HAS_PENDING_EXCEPTION) {
1489 // Only metaspace OOM is expected. No Java code executed.
1490 assert((PENDING_EXCEPTION->is_a(vmClasses::OutOfMemoryError_klass())), "we expect only an OOM error here");
1491 CLEAR_PENDING_EXCEPTION;
1492 }
1493 mdo = m->method_data();
1494 }
1495
1496 if (mdo != nullptr) {
1497 mdo->inc_trap_count(Deoptimization::Reason_none);
1498 }
1499
1500 if (TracePredicateFailedTraps) {
1501 stringStream ss1, ss2;
1502 vframeStream vfst(current);
1503 Method* inlinee = vfst.method();
1504 inlinee->print_short_name(&ss1);
1505 m->print_short_name(&ss2);
1506 tty->print_cr("Predicate failed trap in method %s at bci %d inlined in %s at pc " INTPTR_FORMAT, ss1.freeze(), vfst.bci(), ss2.freeze(), p2i(caller_frame.pc()));
1507 }
1508
1509
1510 Deoptimization::deoptimize_frame(current, caller_frame.id());
1511
1512 JRT_END
1513
1514 // Check exception if AbortVMOnException flag set
1515 JRT_LEAF(void, Runtime1::check_abort_on_vm_exception(oopDesc* ex))
1516 ResourceMark rm;
1517 const char* message = nullptr;
1518 if (ex->is_a(vmClasses::Throwable_klass())) {
1519 oop msg = java_lang_Throwable::message(ex);
1520 if (msg != nullptr) {
1521 message = java_lang_String::as_utf8_string(msg);
1522 }
1523 }
1524 Exceptions::debug_check_abort(ex->klass()->external_name(), message);
1525 JRT_END
1526
1527 #ifndef PRODUCT
1528 void Runtime1::print_statistics() {
1529 tty->print_cr("C1 Runtime statistics:");
1530 tty->print_cr(" _resolve_invoke_virtual_cnt: %u", SharedRuntime::_resolve_virtual_ctr);
1531 tty->print_cr(" _resolve_invoke_opt_virtual_cnt: %u", SharedRuntime::_resolve_opt_virtual_ctr);
1532 tty->print_cr(" _resolve_invoke_static_cnt: %u", SharedRuntime::_resolve_static_ctr);
1533 tty->print_cr(" _handle_wrong_method_cnt: %u", SharedRuntime::_wrong_method_ctr);
1534 tty->print_cr(" _ic_miss_cnt: %u", SharedRuntime::_ic_miss_ctr);
1535 tty->print_cr(" _generic_arraycopystub_cnt: %u", _generic_arraycopystub_cnt);
1536 tty->print_cr(" _byte_arraycopy_cnt: %u", _byte_arraycopy_stub_cnt);
1537 tty->print_cr(" _short_arraycopy_cnt: %u", _short_arraycopy_stub_cnt);
1538 tty->print_cr(" _int_arraycopy_cnt: %u", _int_arraycopy_stub_cnt);
1539 tty->print_cr(" _long_arraycopy_cnt: %u", _long_arraycopy_stub_cnt);
1540 tty->print_cr(" _oop_arraycopy_cnt: %u", _oop_arraycopy_stub_cnt);
1541 tty->print_cr(" _arraycopy_slowcase_cnt: %u", _arraycopy_slowcase_cnt);
1542 tty->print_cr(" _arraycopy_checkcast_cnt: %u", _arraycopy_checkcast_cnt);
1543 tty->print_cr(" _arraycopy_checkcast_attempt_cnt:%u", _arraycopy_checkcast_attempt_cnt);
1544
1545 tty->print_cr(" _new_type_array_slowcase_cnt: %u", _new_type_array_slowcase_cnt);
1546 tty->print_cr(" _new_object_array_slowcase_cnt: %u", _new_object_array_slowcase_cnt);
1547 tty->print_cr(" _new_instance_slowcase_cnt: %u", _new_instance_slowcase_cnt);
1548 tty->print_cr(" _new_multi_array_slowcase_cnt: %u", _new_multi_array_slowcase_cnt);
1549 tty->print_cr(" _monitorenter_slowcase_cnt: %u", _monitorenter_slowcase_cnt);
1550 tty->print_cr(" _monitorexit_slowcase_cnt: %u", _monitorexit_slowcase_cnt);
1551 tty->print_cr(" _patch_code_slowcase_cnt: %u", _patch_code_slowcase_cnt);
1552
1553 tty->print_cr(" _throw_range_check_exception_count: %u:", _throw_range_check_exception_count);
1554 tty->print_cr(" _throw_index_exception_count: %u:", _throw_index_exception_count);
1555 tty->print_cr(" _throw_div0_exception_count: %u:", _throw_div0_exception_count);
1556 tty->print_cr(" _throw_null_pointer_exception_count: %u:", _throw_null_pointer_exception_count);
1557 tty->print_cr(" _throw_class_cast_exception_count: %u:", _throw_class_cast_exception_count);
1558 tty->print_cr(" _throw_incompatible_class_change_error_count: %u:", _throw_incompatible_class_change_error_count);
1559 tty->print_cr(" _throw_count: %u:", _throw_count);
1560
1561 SharedRuntime::print_ic_miss_histogram();
1562 tty->cr();
1563 }
1564 #endif // PRODUCT