1 /*
2 * Copyright (c) 1998, 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 "cds/aotConstantPoolResolver.hpp"
26 #include "cds/archiveBuilder.hpp"
27 #include "cds/cdsConfig.hpp"
28 #include "cds/heapShared.hpp"
29 #include "classfile/resolutionErrors.hpp"
30 #include "classfile/systemDictionary.hpp"
31 #include "classfile/systemDictionaryShared.hpp"
32 #include "classfile/vmClasses.hpp"
33 #include "code/codeCache.hpp"
34 #include "interpreter/bytecodeStream.hpp"
35 #include "interpreter/bytecodes.hpp"
36 #include "interpreter/interpreter.hpp"
37 #include "interpreter/linkResolver.hpp"
38 #include "interpreter/rewriter.hpp"
39 #include "logging/log.hpp"
40 #include "logging/logStream.hpp"
41 #include "memory/metadataFactory.hpp"
42 #include "memory/metaspaceClosure.hpp"
43 #include "memory/resourceArea.hpp"
44 #include "oops/access.inline.hpp"
45 #include "oops/compressedOops.hpp"
46 #include "oops/constantPool.inline.hpp"
47 #include "oops/cpCache.inline.hpp"
48 #include "oops/method.inline.hpp"
49 #include "oops/objArrayOop.inline.hpp"
50 #include "oops/oop.inline.hpp"
51 #include "oops/method.inline.hpp"
52 #include "oops/resolvedFieldEntry.hpp"
53 #include "oops/resolvedIndyEntry.hpp"
54 #include "oops/resolvedMethodEntry.hpp"
55 #include "prims/methodHandles.hpp"
56 #include "runtime/arguments.hpp"
57 #include "runtime/atomic.hpp"
58 #include "runtime/handles.inline.hpp"
59 #include "runtime/mutexLocker.hpp"
60 #include "runtime/synchronizer.hpp"
61 #include "runtime/vm_version.hpp"
62 #include "utilities/macros.hpp"
63
64 // Implementation of ConstantPoolCache
65
66 template <class T>
67 static Array<T>* initialize_resolved_entries_array(ClassLoaderData* loader_data, GrowableArray<T> entries, TRAPS) {
68 Array<T>* resolved_entries;
69 if (entries.length() != 0) {
70 resolved_entries = MetadataFactory::new_array<T>(loader_data, entries.length(), CHECK_NULL);
71 for (int i = 0; i < entries.length(); i++) {
72 resolved_entries->at_put(i, entries.at(i));
73 }
74 return resolved_entries;
75 }
76 return nullptr;
77 }
78
79 void ConstantPoolCache::set_direct_or_vtable_call(Bytecodes::Code invoke_code,
80 int method_index,
81 const methodHandle& method,
82 int vtable_index,
83 bool sender_is_interface) {
84 bool is_vtable_call = (vtable_index >= 0); // FIXME: split this method on this boolean
85 assert(method->interpreter_entry() != nullptr, "should have been set at this point");
86 assert(!method->is_obsolete(), "attempt to write obsolete method to cpCache");
87
88 int byte_no = -1;
89 bool change_to_virtual = false;
90 InstanceKlass* holder = nullptr; // have to declare this outside the switch
91 ResolvedMethodEntry* method_entry = resolved_method_entry_at(method_index);
92 switch (invoke_code) {
93 case Bytecodes::_invokeinterface:
94 holder = method->method_holder();
95 // check for private interface method invocations
96 if (vtable_index == Method::nonvirtual_vtable_index && holder->is_interface() ) {
97 assert(method->is_private(), "unexpected non-private method");
98 assert(method->can_be_statically_bound(), "unexpected non-statically-bound method");
99
100 method_entry->set_flags(( 1 << ResolvedMethodEntry::is_vfinal_shift) |
101 ((method->is_final_method() ? 1 : 0) << ResolvedMethodEntry::is_final_shift));
102 method_entry->fill_in((u1)as_TosState(method->result_type()), (u2)method()->size_of_parameters());
103 assert(method_entry->is_vfinal(), "flags must be set");
104 method_entry->set_method(method());
105 byte_no = 2;
106 method_entry->set_klass(holder);
107 break;
108 }
109 else {
110 // We get here from InterpreterRuntime::resolve_invoke when an invokeinterface
111 // instruction links to a non-interface method (in Object). This can happen when
112 // an interface redeclares an Object method (like CharSequence declaring toString())
113 // or when invokeinterface is used explicitly.
114 // In that case, the method has no itable index and must be invoked as a virtual.
115 // Set a flag to keep track of this corner case.
116 assert(holder->is_interface() || holder == vmClasses::Object_klass(), "unexpected holder class");
117 assert(method->is_public(), "Calling non-public method in Object with invokeinterface");
118 change_to_virtual = true;
119
120 // ...and fall through as if we were handling invokevirtual:
121 }
122 case Bytecodes::_invokevirtual:
123 {
124 if (!is_vtable_call) {
125 assert(method->can_be_statically_bound(), "");
126 method_entry->set_flags(( 1 << ResolvedMethodEntry::is_vfinal_shift) |
127 ((method->is_final_method() ? 1 : 0) << ResolvedMethodEntry::is_final_shift) |
128 ((change_to_virtual ? 1 : 0) << ResolvedMethodEntry::is_forced_virtual_shift));
129 method_entry->fill_in((u1)as_TosState(method->result_type()), (u2)method()->size_of_parameters());
130 assert(method_entry->is_vfinal(), "flags must be set");
131 method_entry->set_method(method());
132 } else {
133 assert(!method->can_be_statically_bound(), "");
134 assert(vtable_index >= 0, "valid index");
135 assert(!method->is_final_method(), "sanity");
136 method_entry->set_flags((change_to_virtual ? 1 : 0) << ResolvedMethodEntry::is_forced_virtual_shift);
137 method_entry->fill_in((u1)as_TosState(method->result_type()), (u2)method()->size_of_parameters());
138 assert(!method_entry->is_vfinal(), "flags must not be set");
139 method_entry->set_table_index(vtable_index);
140 }
141 byte_no = 2;
142 break;
143 }
144
145 case Bytecodes::_invokespecial:
146 case Bytecodes::_invokestatic: {
147 assert(!is_vtable_call, "");
148 // Note: Read and preserve the value of the is_vfinal flag on any
149 // invokevirtual bytecode shared with this constant pool cache entry.
150 // It is cheap and safe to consult is_vfinal() at all times.
151 // Once is_vfinal is set, it must stay that way, lest we get a dangling oop.
152 bool vfinal = method_entry->is_vfinal();
153 method_entry->set_flags(((method->is_final_method() ? 1 : 0) << ResolvedMethodEntry::is_final_shift));
154 assert(vfinal == method_entry->is_vfinal(), "Vfinal flag must be preserved");
155 method_entry->fill_in((u1)as_TosState(method->result_type()), (u2)method()->size_of_parameters());
156 method_entry->set_method(method());
157 byte_no = 1;
158 break;
159 }
160 default:
161 ShouldNotReachHere();
162 break;
163 }
164
165 // Note: byte_no also appears in TemplateTable::resolve.
166 if (byte_no == 1) {
167 assert(invoke_code != Bytecodes::_invokevirtual &&
168 invoke_code != Bytecodes::_invokeinterface, "");
169 bool do_resolve = true;
170 // Don't mark invokespecial to method as resolved if sender is an interface. The receiver
171 // has to be checked that it is a subclass of the current class every time this bytecode
172 // is executed.
173 if (invoke_code == Bytecodes::_invokespecial && sender_is_interface &&
174 method->name() != vmSymbols::object_initializer_name()) {
175 do_resolve = false;
176 }
177 if (invoke_code == Bytecodes::_invokestatic) {
178 assert(method->method_holder()->is_initialized() ||
179 method->method_holder()->is_reentrant_initialization(JavaThread::current()) ||
180 (CDSConfig::is_dumping_archive() && VM_Version::supports_fast_class_init_checks()),
181 "invalid class initialization state for invoke_static");
182
183 if (!VM_Version::supports_fast_class_init_checks() && method->needs_clinit_barrier()) {
184 // Don't mark invokestatic to method as resolved if the holder class has not yet completed
185 // initialization. An invokestatic must only proceed if the class is initialized, but if
186 // we resolve it before then that class initialization check is skipped.
187 //
188 // When fast class initialization checks are supported (VM_Version::supports_fast_class_init_checks() == true),
189 // template interpreter supports fast class initialization check for
190 // invokestatic which doesn't require call site re-resolution to
191 // enforce class initialization barrier.
192 do_resolve = false;
193 }
194 }
195 if (do_resolve) {
196 method_entry->set_bytecode1(invoke_code);
197 }
198 } else if (byte_no == 2) {
199 if (change_to_virtual) {
200 assert(invoke_code == Bytecodes::_invokeinterface, "");
201 // NOTE: THIS IS A HACK - BE VERY CAREFUL!!!
202 //
203 // Workaround for the case where we encounter an invokeinterface, but we
204 // should really have an _invokevirtual since the resolved method is a
205 // virtual method in java.lang.Object. This is a corner case in the spec
206 // but is presumably legal. javac does not generate this code.
207 //
208 // We do not set bytecode_1() to _invokeinterface, because that is the
209 // bytecode # used by the interpreter to see if it is resolved. In this
210 // case, the method gets reresolved with caller for each interface call
211 // because the actual selected method may not be public.
212 //
213 // We set bytecode_2() to _invokevirtual.
214 // See also interpreterRuntime.cpp. (8/25/2000)
215 } else {
216 assert(invoke_code == Bytecodes::_invokevirtual ||
217 (invoke_code == Bytecodes::_invokeinterface &&
218 ((method->is_private() ||
219 (method->is_final() && method->method_holder() == vmClasses::Object_klass())))),
220 "unexpected invocation mode");
221 if (invoke_code == Bytecodes::_invokeinterface &&
222 (method->is_private() || method->is_final())) {
223 // We set bytecode_1() to _invokeinterface, because that is the
224 // bytecode # used by the interpreter to see if it is resolved.
225 // We set bytecode_2() to _invokevirtual.
226 method_entry->set_bytecode1(invoke_code);
227 }
228 }
229 // set up for invokevirtual, even if linking for invokeinterface also:
230 method_entry->set_bytecode2(Bytecodes::_invokevirtual);
231 } else {
232 ShouldNotReachHere();
233 }
234 }
235
236 void ConstantPoolCache::set_direct_call(Bytecodes::Code invoke_code, int method_index, const methodHandle& method,
237 bool sender_is_interface) {
238 int index = Method::nonvirtual_vtable_index;
239 // index < 0; FIXME: inline and customize set_direct_or_vtable_call
240 set_direct_or_vtable_call(invoke_code, method_index, method, index, sender_is_interface);
241 }
242
243 void ConstantPoolCache::set_vtable_call(Bytecodes::Code invoke_code, int method_index, const methodHandle& method, int index) {
244 // either the method is a miranda or its holder should accept the given index
245 assert(method->method_holder()->is_interface() || method->method_holder()->verify_vtable_index(index), "");
246 // index >= 0; FIXME: inline and customize set_direct_or_vtable_call
247 set_direct_or_vtable_call(invoke_code, method_index, method, index, false);
248 }
249
250 void ConstantPoolCache::set_itable_call(Bytecodes::Code invoke_code,
251 int method_index,
252 Klass* referenced_klass,
253 const methodHandle& method, int index) {
254 assert(method->method_holder()->verify_itable_index(index), "");
255 assert(invoke_code == Bytecodes::_invokeinterface, "");
256 InstanceKlass* interf = method->method_holder();
257 assert(interf->is_interface(), "must be an interface");
258 assert(!method->is_final_method(), "interfaces do not have final methods; cannot link to one here");
259 ResolvedMethodEntry* method_entry = resolved_method_entry_at(method_index);
260 method_entry->set_klass(static_cast<InstanceKlass*>(referenced_klass));
261 method_entry->set_method(method());
262 method_entry->fill_in((u1)as_TosState(method->result_type()), (u2)method()->size_of_parameters());
263 method_entry->set_bytecode1(Bytecodes::_invokeinterface);
264 }
265
266 ResolvedMethodEntry* ConstantPoolCache::set_method_handle(int method_index, const CallInfo &call_info) {
267 // NOTE: This method entry can be the subject of data races.
268 // There are three words to update: flags, refs[appendix_index], method (in that order).
269 // Writers must store all other values before method.
270 // Readers must test the method first for non-null before reading other fields.
271 // Competing writers must acquire exclusive access via a lock.
272 // A losing writer waits on the lock until the winner writes the method and leaves
273 // the lock, so that when the losing writer returns, he can use the linked
274 // cache entry.
275
276 // Lock fields to write
277 Bytecodes::Code invoke_code = Bytecodes::_invokehandle;
278
279 JavaThread* current = JavaThread::current();
280 objArrayHandle resolved_references(current, constant_pool()->resolved_references());
281 // Use the resolved_references() lock for this cpCache entry.
282 // resolved_references are created for all classes with Invokedynamic, MethodHandle
283 // or MethodType constant pool cache entries.
284 assert(resolved_references() != nullptr,
285 "a resolved_references array should have been created for this class");
286 ObjectLocker ol(resolved_references, current);
287
288 ResolvedMethodEntry* method_entry = resolved_method_entry_at(method_index);
289 if (method_entry->is_resolved(invoke_code)) {
290 return method_entry;
291 }
292
293 Method* adapter = call_info.resolved_method();
294 const Handle appendix = call_info.resolved_appendix();
295 const bool has_appendix = appendix.not_null();
296
297 // Write the flags.
298 // MHs are always sig-poly and have a local signature.
299 method_entry->fill_in((u1)as_TosState(adapter->result_type()), (u2)adapter->size_of_parameters());
300 method_entry->set_flags(((has_appendix ? 1 : 0) << ResolvedMethodEntry::has_appendix_shift ) |
301 ( 1 << ResolvedMethodEntry::has_local_signature_shift ) |
302 ( 1 << ResolvedMethodEntry::is_final_shift ));
303
304 // Method handle invokes use both a method and a resolved references index.
305 // refs[appendix_index], if not null, contains a value passed as a trailing argument to the adapter.
306 // In the general case, this could be the call site's MethodType,
307 // for use with java.lang.Invokers.checkExactType, or else a CallSite object.
308 // method_entry->method() contains the adapter method which manages the actual call.
309 // In the general case, this is a compiled LambdaForm.
310 // (The Java code is free to optimize these calls by binding other
311 // sorts of methods and appendices to call sites.)
312 // JVM-level linking is via the method, as if for invokespecial, and signatures are erased.
313 // The appendix argument (if any) is added to the signature, and is counted in the parameter_size bits.
314 // Even with the appendix, the method will never take more than 255 parameter slots.
315 //
316 // This means that given a call site like (List)mh.invoke("foo"),
317 // the method has signature '(Ljl/Object;Ljl/invoke/MethodType;)Ljl/Object;',
318 // not '(Ljava/lang/String;)Ljava/util/List;'.
319 // The fact that String and List are involved is encoded in the MethodType in refs[appendix_index].
320 // This allows us to create fewer Methods, while keeping type safety.
321 //
322
323 // Store appendix, if any.
324 if (has_appendix) {
325 const int appendix_index = method_entry->resolved_references_index();
326 assert(appendix_index >= 0 && appendix_index < resolved_references->length(), "oob");
327 assert(resolved_references->obj_at(appendix_index) == nullptr, "init just once");
328 resolved_references->obj_at_put(appendix_index, appendix());
329 }
330
331 method_entry->set_method(adapter); // This must be the last one to set (see NOTE above)!
332
333 // The interpreter assembly code does not check byte_2,
334 // but it is used by is_resolved, method_if_resolved, etc.
335 method_entry->set_bytecode1(invoke_code);
336
337 assert(has_appendix == method_entry->has_appendix(), "proper storage of appendix flag");
338 assert(method_entry->has_local_signature(), "proper storage of signature flag");
339 return method_entry;
340 }
341
342 Method* ConstantPoolCache::method_if_resolved(int method_index) const {
343 // Decode the action of set_method and set_interface_call
344 ResolvedMethodEntry* method_entry = resolved_method_entry_at(method_index);
345
346 Bytecodes::Code invoke_code = (Bytecodes::Code)method_entry->bytecode1();
347 switch (invoke_code) {
348 case Bytecodes::_invokeinterface:
349 case Bytecodes::_invokestatic:
350 case Bytecodes::_invokespecial:
351 assert(!method_entry->has_appendix(), "");
352 // fall through
353 case Bytecodes::_invokehandle:
354 return method_entry->method();
355 case Bytecodes::_invokedynamic:
356 ShouldNotReachHere();
357 default:
358 assert(invoke_code == (Bytecodes::Code)0, "unexpected bytecode");
359 break;
360 }
361
362 invoke_code = (Bytecodes::Code)method_entry->bytecode2();
363 if (invoke_code == Bytecodes::_invokevirtual) {
364 if (method_entry->is_vfinal()) {
365 return method_entry->method();
366 } else {
367 int holder_index = constant_pool()->uncached_klass_ref_index_at(method_entry->constant_pool_index());
368 if (constant_pool()->tag_at(holder_index).is_klass()) {
369 Klass* klass = constant_pool()->resolved_klass_at(holder_index);
370 return klass->method_at_vtable(method_entry->table_index());
371 }
372 }
373 }
374 return nullptr;
375 }
376
377 ConstantPoolCache* ConstantPoolCache::allocate(ClassLoaderData* loader_data,
378 const intStack& invokedynamic_map,
379 const GrowableArray<ResolvedIndyEntry> indy_entries,
380 const GrowableArray<ResolvedFieldEntry> field_entries,
381 const GrowableArray<ResolvedMethodEntry> method_entries,
382 TRAPS) {
383
384 int size = ConstantPoolCache::size();
385
386 // Initialize resolved entry arrays with available data
387 Array<ResolvedFieldEntry>* resolved_field_entries = initialize_resolved_entries_array(loader_data, field_entries, CHECK_NULL);
388 Array<ResolvedIndyEntry>* resolved_indy_entries = initialize_resolved_entries_array(loader_data, indy_entries, CHECK_NULL);
389 Array<ResolvedMethodEntry>* resolved_method_entries = initialize_resolved_entries_array(loader_data, method_entries, CHECK_NULL);
390
391 return new (loader_data, size, MetaspaceObj::ConstantPoolCacheType, THREAD)
392 ConstantPoolCache(invokedynamic_map, resolved_indy_entries, resolved_field_entries, resolved_method_entries);
393 }
394
395 // Record the GC marking cycle when redefined vs. when found in the loom stack chunks.
396 void ConstantPoolCache::record_gc_epoch() {
397 _gc_epoch = CodeCache::gc_epoch();
398 }
399
400 #if INCLUDE_CDS
401 void ConstantPoolCache::remove_unshareable_info() {
402 assert(CDSConfig::is_dumping_archive(), "sanity");
403
404 if (_resolved_indy_entries != nullptr) {
405 remove_resolved_indy_entries_if_non_deterministic();
406 }
407 if (_resolved_field_entries != nullptr) {
408 remove_resolved_field_entries_if_non_deterministic();
409 }
410 if (_resolved_method_entries != nullptr) {
411 remove_resolved_method_entries_if_non_deterministic();
412 }
413
414 #if INCLUDE_CDS_JAVA_HEAP
415 _archived_references_index = -1;
416 if (CDSConfig::is_dumping_heap()) {
417 ConstantPool* src_cp = ArchiveBuilder::current()->get_source_addr(constant_pool());
418 oop rr = HeapShared::scratch_resolved_references(src_cp);
419 if (rr != nullptr) {
420 _archived_references_index = HeapShared::append_root(rr);
421 }
422 }
423 #endif
424 }
425
426 void ConstantPoolCache::remove_resolved_field_entries_if_non_deterministic() {
427 ConstantPool* cp = constant_pool();
428 ConstantPool* src_cp = ArchiveBuilder::current()->get_source_addr(cp);
429 for (int i = 0; i < _resolved_field_entries->length(); i++) {
430 ResolvedFieldEntry* rfi = _resolved_field_entries->adr_at(i);
431 int cp_index = rfi->constant_pool_index();
432 bool archived = false;
433 bool resolved = rfi->is_resolved(Bytecodes::_getstatic) ||
434 rfi->is_resolved(Bytecodes::_putstatic) ||
435 rfi->is_resolved(Bytecodes::_getfield) ||
436 rfi->is_resolved(Bytecodes::_putfield);
437 if (resolved && AOTConstantPoolResolver::is_resolution_deterministic(src_cp, cp_index)) {
438 rfi->mark_and_relocate();
439 archived = true;
440 } else {
441 rfi->remove_unshareable_info();
442 }
443 if (resolved) {
444 LogStreamHandle(Trace, cds, resolve) log;
445 if (log.is_enabled()) {
446 ResourceMark rm;
447 int klass_cp_index = cp->uncached_klass_ref_index_at(cp_index);
448 Symbol* klass_name = cp->klass_name_at(klass_cp_index);
449 Symbol* name = cp->uncached_name_ref_at(cp_index);
450 Symbol* signature = cp->uncached_signature_ref_at(cp_index);
451 log.print("%s field CP entry [%3d]: %s => %s.%s:%s",
452 (archived ? "archived" : "reverted"),
453 cp_index,
454 cp->pool_holder()->name()->as_C_string(),
455 klass_name->as_C_string(), name->as_C_string(), signature->as_C_string());
456 }
457 }
458 ArchiveBuilder::alloc_stats()->record_field_cp_entry(archived, resolved && !archived);
459 }
460 }
461
462 void ConstantPoolCache::remove_resolved_method_entries_if_non_deterministic() {
463 ConstantPool* cp = constant_pool();
464 ConstantPool* src_cp = ArchiveBuilder::current()->get_source_addr(cp);
465 for (int i = 0; i < _resolved_method_entries->length(); i++) {
466 ResolvedMethodEntry* rme = _resolved_method_entries->adr_at(i);
467 int cp_index = rme->constant_pool_index();
468 bool archived = false;
469 bool resolved = rme->is_resolved(Bytecodes::_invokevirtual) ||
470 rme->is_resolved(Bytecodes::_invokespecial) ||
471 //rme->is_resolved(Bytecodes::_invokestatic) || // FIXME -- leyden+JEP483 merge
472 rme->is_resolved(Bytecodes::_invokeinterface) ||
473 rme->is_resolved(Bytecodes::_invokehandle);
474 if (resolved && can_archive_resolved_method(src_cp, rme)) {
475 rme->mark_and_relocate(src_cp);
476 archived = true;
477 } else {
478 rme->remove_unshareable_info();
479 }
480 if (resolved) {
481 LogStreamHandle(Trace, cds, resolve) log;
482 if (log.is_enabled()) {
483 ResourceMark rm;
484 int klass_cp_index = cp->uncached_klass_ref_index_at(cp_index);
485 Symbol* klass_name = cp->klass_name_at(klass_cp_index);
486 Symbol* name = cp->uncached_name_ref_at(cp_index);
487 Symbol* signature = cp->uncached_signature_ref_at(cp_index);
488 log.print("%s%s method CP entry [%3d]: %s %s.%s:%s",
489 (archived ? "archived" : "reverted"),
490 (rme->is_resolved(Bytecodes::_invokeinterface) ? " interface" : ""),
491 cp_index,
492 cp->pool_holder()->name()->as_C_string(),
493 klass_name->as_C_string(), name->as_C_string(), signature->as_C_string());
494 if (archived) {
495 Klass* resolved_klass = cp->resolved_klass_at(klass_cp_index);
496 log.print(" => %s%s",
497 resolved_klass->name()->as_C_string(),
498 (rme->is_resolved(Bytecodes::_invokestatic) ? " *** static" : ""));
499 }
500 }
501 ArchiveBuilder::alloc_stats()->record_method_cp_entry(archived, resolved && !archived);
502 }
503 }
504 }
505
506 void ConstantPoolCache::remove_resolved_indy_entries_if_non_deterministic() {
507 ConstantPool* cp = constant_pool();
508 ConstantPool* src_cp = ArchiveBuilder::current()->get_source_addr(cp);
509 for (int i = 0; i < _resolved_indy_entries->length(); i++) {
510 ResolvedIndyEntry* rei = _resolved_indy_entries->adr_at(i);
511 int cp_index = rei->constant_pool_index();
512 bool archived = false;
513 bool resolved = rei->is_resolved();
514 if (resolved && AOTConstantPoolResolver::is_resolution_deterministic(src_cp, cp_index)) {
515 rei->mark_and_relocate();
516 archived = true;
517 } else {
518 rei->remove_unshareable_info();
519 }
520 if (resolved) {
521 LogStreamHandle(Trace, cds, resolve) log;
522 if (log.is_enabled()) {
523 ResourceMark rm;
524 int bsm = cp->bootstrap_method_ref_index_at(cp_index);
525 int bsm_ref = cp->method_handle_index_at(bsm);
526 Symbol* bsm_name = cp->uncached_name_ref_at(bsm_ref);
527 Symbol* bsm_signature = cp->uncached_signature_ref_at(bsm_ref);
528 Symbol* bsm_klass = cp->klass_name_at(cp->uncached_klass_ref_index_at(bsm_ref));
529 log.print("%s indy CP entry [%3d]: %s (%d)",
530 (archived ? "archived" : "reverted"),
531 cp_index, cp->pool_holder()->name()->as_C_string(), i);
532 log.print(" %s %s.%s:%s", (archived ? "=>" : " "), bsm_klass->as_C_string(),
533 bsm_name->as_C_string(), bsm_signature->as_C_string());
534 }
535 ArchiveBuilder::alloc_stats()->record_indy_cp_entry(archived, resolved && !archived);
536 }
537 }
538 }
539
540 bool ConstantPoolCache::can_archive_resolved_method(ConstantPool* src_cp, ResolvedMethodEntry* method_entry) {
541 InstanceKlass* pool_holder = constant_pool()->pool_holder();
542 if (!(pool_holder->is_shared_boot_class() || pool_holder->is_shared_platform_class() ||
543 pool_holder->is_shared_app_class())) {
544 // Archiving resolved cp entries for classes from non-builtin loaders
545 // is not yet supported.
546 return false;
547 }
548
549 if (CDSConfig::is_dumping_dynamic_archive()) {
550 // InstanceKlass::methods() has been resorted. We need to
551 // update the vtable_index in method_entry (not implemented)
552 return false;
553 }
554
555 if (!method_entry->is_resolved(Bytecodes::_invokevirtual)) {
556 if (method_entry->method() == nullptr) {
557 return false;
558 }
559 if (method_entry->method()->is_continuation_native_intrinsic()) {
560 return false; // FIXME: corresponding stub is generated on demand during method resolution (see LinkResolver::resolve_static_call).
561 }
562 }
563
564 int cp_index = method_entry->constant_pool_index();
565 assert(src_cp->tag_at(cp_index).is_method() || src_cp->tag_at(cp_index).is_interface_method(), "sanity");
566
567 if (!AOTConstantPoolResolver::is_resolution_deterministic(src_cp, cp_index)) {
568 return false;
569 }
570
571 if (method_entry->is_resolved(Bytecodes::_invokestatic) ||
572 method_entry->is_resolved(Bytecodes::_invokeinterface) ||
573 method_entry->is_resolved(Bytecodes::_invokevirtual) ||
574 method_entry->is_resolved(Bytecodes::_invokespecial)) {
575 return true;
576 } else if (method_entry->is_resolved(Bytecodes::_invokehandle)) {
577 if (CDSConfig::is_dumping_invokedynamic()) {
578 // invokehandle depends on archived MethodType and LambdaForms.
579 return true;
580 } else {
581 return false;
582 }
583 } else {
584 return false;
585 }
586 }
587 #endif // INCLUDE_CDS
588
589 void ConstantPoolCache::deallocate_contents(ClassLoaderData* data) {
590 assert(!is_shared(), "shared caches are not deallocated");
591 data->remove_handle(_resolved_references);
592 set_resolved_references(OopHandle());
593 MetadataFactory::free_array<u2>(data, _reference_map);
594 set_reference_map(nullptr);
595 #if INCLUDE_CDS
596 if (_resolved_indy_entries != nullptr) {
597 MetadataFactory::free_array<ResolvedIndyEntry>(data, _resolved_indy_entries);
598 _resolved_indy_entries = nullptr;
599 }
600 if (_resolved_field_entries != nullptr) {
601 MetadataFactory::free_array<ResolvedFieldEntry>(data, _resolved_field_entries);
602 _resolved_field_entries = nullptr;
603 }
604 if (_resolved_method_entries != nullptr) {
605 MetadataFactory::free_array<ResolvedMethodEntry>(data, _resolved_method_entries);
606 _resolved_method_entries = nullptr;
607 }
608 #endif
609 }
610
611 #if INCLUDE_CDS_JAVA_HEAP
612 oop ConstantPoolCache::archived_references() {
613 if (_archived_references_index < 0) {
614 return nullptr;
615 }
616 return HeapShared::get_root(_archived_references_index);
617 }
618
619 void ConstantPoolCache::clear_archived_references() {
620 if (_archived_references_index >= 0) {
621 HeapShared::clear_root(_archived_references_index);
622 _archived_references_index = -1;
623 }
624 }
625 #endif
626
627 #if INCLUDE_JVMTI
628 static void log_adjust(const char* entry_type, Method* old_method, Method* new_method, bool* trace_name_printed) {
629 ResourceMark rm;
630
631 if (!(*trace_name_printed)) {
632 log_info(redefine, class, update)("adjust: name=%s", old_method->method_holder()->external_name());
633 *trace_name_printed = true;
634 }
635 log_trace(redefine, class, update, constantpool)
636 ("cpc %s entry update: %s", entry_type, new_method->external_name());
637 }
638
639 // RedefineClasses() API support:
640 // If any entry of this ConstantPoolCache points to any of
641 // old_methods, replace it with the corresponding new_method.
642 void ConstantPoolCache::adjust_method_entries(bool * trace_name_printed) {
643 if (_resolved_indy_entries != nullptr) {
644 for (int j = 0; j < _resolved_indy_entries->length(); j++) {
645 Method* old_method = resolved_indy_entry_at(j)->method();
646 if (old_method == nullptr || !old_method->is_old()) {
647 continue;
648 }
649 assert(!old_method->is_deleted(), "cannot delete these methods");
650 Method* new_method = old_method->get_new_method();
651 resolved_indy_entry_at(j)->adjust_method_entry(new_method);
652 log_adjust("indy", old_method, new_method, trace_name_printed);
653 }
654 }
655 if (_resolved_method_entries != nullptr) {
656 for (int i = 0; i < _resolved_method_entries->length(); i++) {
657 ResolvedMethodEntry* method_entry = resolved_method_entry_at(i);
658 // get interesting method entry
659 Method* old_method = method_entry->method();
660 if (old_method == nullptr || !old_method->is_old()) {
661 continue; // skip uninteresting entries
662 }
663 if (old_method->is_deleted()) {
664 // clean up entries with deleted methods
665 method_entry->reset_entry();
666 continue;
667 }
668 Method* new_method = old_method->get_new_method();
669 method_entry->adjust_method_entry(new_method);
670 log_adjust("non-indy", old_method, new_method, trace_name_printed);
671 }
672 }
673 }
674
675 // the constant pool cache should never contain old or obsolete methods
676 bool ConstantPoolCache::check_no_old_or_obsolete_entries() {
677 ResourceMark rm;
678 if (_resolved_indy_entries != nullptr) {
679 for (int i = 0; i < _resolved_indy_entries->length(); i++) {
680 Method* m = resolved_indy_entry_at(i)->method();
681 if (m != nullptr && !resolved_indy_entry_at(i)->check_no_old_or_obsolete_entry()) {
682 log_trace(redefine, class, update, constantpool)
683 ("cpcache check found old method entry: class: %s, old: %d, obsolete: %d, method: %s",
684 constant_pool()->pool_holder()->external_name(), m->is_old(), m->is_obsolete(), m->external_name());
685 return false;
686 }
687 }
688 }
689 if (_resolved_method_entries != nullptr) {
690 for (int i = 0; i < _resolved_method_entries->length(); i++) {
691 ResolvedMethodEntry* method_entry = resolved_method_entry_at(i);
692 Method* m = method_entry->method();
693 if (m != nullptr && !method_entry->check_no_old_or_obsolete_entry()) {
694 log_trace(redefine, class, update, constantpool)
695 ("cpcache check found old method entry: class: %s, old: %d, obsolete: %d, method: %s",
696 constant_pool()->pool_holder()->external_name(), m->is_old(), m->is_obsolete(), m->external_name());
697 return false;
698 }
699 }
700 }
701 return true;
702 }
703
704 void ConstantPoolCache::dump_cache() {
705 print_on(tty);
706 }
707 #endif // INCLUDE_JVMTI
708
709 void ConstantPoolCache::metaspace_pointers_do(MetaspaceClosure* it) {
710 log_trace(cds)("Iter(ConstantPoolCache): %p", this);
711 it->push(&_constant_pool);
712 it->push(&_reference_map);
713 if (_resolved_indy_entries != nullptr) {
714 it->push(&_resolved_indy_entries, MetaspaceClosure::_writable);
715 }
716 if (_resolved_field_entries != nullptr) {
717 it->push(&_resolved_field_entries, MetaspaceClosure::_writable);
718 }
719 if (_resolved_method_entries != nullptr) {
720 it->push(&_resolved_method_entries, MetaspaceClosure::_writable);
721 }
722 }
723
724 bool ConstantPoolCache::save_and_throw_indy_exc(
725 const constantPoolHandle& cpool, int cpool_index, int index, constantTag tag, TRAPS) {
726
727 assert(HAS_PENDING_EXCEPTION, "No exception got thrown!");
728 assert(PENDING_EXCEPTION->is_a(vmClasses::LinkageError_klass()),
729 "No LinkageError exception");
730
731 // Use the resolved_references() lock for this cpCache entry.
732 // resolved_references are created for all classes with Invokedynamic, MethodHandle
733 // or MethodType constant pool cache entries.
734 JavaThread* current = THREAD;
735 objArrayHandle resolved_references(current, cpool->resolved_references());
736 assert(resolved_references() != nullptr,
737 "a resolved_references array should have been created for this class");
738 ObjectLocker ol(resolved_references, current);
739
740 // if the indy_info is resolved or the indy_resolution_failed flag is set then another
741 // thread either succeeded in resolving the method or got a LinkageError
742 // exception, before this thread was able to record its failure. So, clear
743 // this thread's exception and return false so caller can use the earlier
744 // thread's result.
745 if (resolved_indy_entry_at(index)->is_resolved() || resolved_indy_entry_at(index)->resolution_failed()) {
746 CLEAR_PENDING_EXCEPTION;
747 return false;
748 }
749 ResourceMark rm(THREAD);
750 Symbol* error = PENDING_EXCEPTION->klass()->name();
751 const char* message = java_lang_Throwable::message_as_utf8(PENDING_EXCEPTION);
752
753 int encoded_index = ResolutionErrorTable::encode_indy_index(index);
754 SystemDictionary::add_resolution_error(cpool, encoded_index, error, message);
755 resolved_indy_entry_at(index)->set_resolution_failed();
756 return true;
757 }
758
759 oop ConstantPoolCache::set_dynamic_call(const CallInfo &call_info, int index) {
760 ResourceMark rm;
761
762 // Use the resolved_references() lock for this cpCache entry.
763 // resolved_references are created for all classes with Invokedynamic, MethodHandle
764 // or MethodType constant pool cache entries.
765 JavaThread* current = JavaThread::current();
766 constantPoolHandle cp(current, constant_pool());
767
768 objArrayHandle resolved_references(current, cp->resolved_references());
769 assert(resolved_references() != nullptr,
770 "a resolved_references array should have been created for this class");
771 ObjectLocker ol(resolved_references, current);
772 assert(index >= 0, "Indy index must be positive at this point");
773
774 if (resolved_indy_entry_at(index)->method() != nullptr) {
775 return cp->resolved_reference_from_indy(index);
776 }
777
778 if (resolved_indy_entry_at(index)->resolution_failed()) {
779 // Before we got here, another thread got a LinkageError exception during
780 // resolution. Ignore our success and throw their exception.
781 guarantee(index >= 0, "Invalid indy index");
782 int encoded_index = ResolutionErrorTable::encode_indy_index(index);
783 ConstantPool::throw_resolution_error(cp, encoded_index, current);
784 return nullptr;
785 }
786
787 Method* adapter = call_info.resolved_method();
788 const Handle appendix = call_info.resolved_appendix();
789 const bool has_appendix = appendix.not_null();
790
791 LogStream* log_stream = nullptr;
792 LogStreamHandle(Debug, methodhandles, indy) lsh_indy;
793 if (lsh_indy.is_enabled()) {
794 ResourceMark rm;
795 log_stream = &lsh_indy;
796 log_stream->print_cr("set_method_handle bc=%d appendix=" PTR_FORMAT "%s method=" PTR_FORMAT " (local signature) ",
797 0xba,
798 p2i(appendix()),
799 (has_appendix ? "" : " (unused)"),
800 p2i(adapter));
801 adapter->print_on(log_stream);
802 if (has_appendix) appendix()->print_on(log_stream);
803 }
804
805 if (has_appendix) {
806 const int appendix_index = resolved_indy_entry_at(index)->resolved_references_index();
807 assert(appendix_index >= 0 && appendix_index < resolved_references->length(), "oob");
808 assert(resolved_references->obj_at(appendix_index) == nullptr, "init just once");
809 resolved_references->obj_at_put(appendix_index, appendix());
810 }
811
812 // Populate entry with resolved information
813 assert(resolved_indy_entries() != nullptr, "Invokedynamic array is empty, cannot fill with resolved information");
814 resolved_indy_entry_at(index)->fill_in(adapter, adapter->size_of_parameters(), as_TosState(adapter->result_type()), has_appendix);
815
816 if (log_stream != nullptr) {
817 resolved_indy_entry_at(index)->print_on(log_stream);
818 }
819 return appendix();
820 }
821
822 oop ConstantPoolCache::appendix_if_resolved(int method_index) const {
823 ResolvedMethodEntry* method_entry = resolved_method_entry_at(method_index);
824 return appendix_if_resolved(method_entry);
825 }
826
827 oop ConstantPoolCache::appendix_if_resolved(ResolvedMethodEntry* method_entry) const {
828 if (!method_entry->has_appendix())
829 return nullptr;
830 const int ref_index = method_entry->resolved_references_index();
831 return constant_pool()->resolved_reference_at(ref_index);
832 }
833
834 // Printing
835
836 void ConstantPoolCache::print_on(outputStream* st) const {
837 st->print_cr("%s", internal_name());
838 // print constant pool cache entries
839 if (_resolved_field_entries != nullptr) {
840 print_resolved_field_entries(st);
841 }
842 if (_resolved_method_entries != nullptr) {
843 print_resolved_method_entries(st);
844 }
845 if (_resolved_indy_entries != nullptr) {
846 print_resolved_indy_entries(st);
847 }
848 }
849
850 void ConstantPoolCache::print_resolved_field_entries(outputStream* st) const {
851 for (int field_index = 0; field_index < resolved_field_entries_length(); field_index++) {
852 resolved_field_entry_at(field_index)->print_on(st);
853 }
854 }
855
856 void ConstantPoolCache::print_resolved_method_entries(outputStream* st) const {
857 for (int method_index = 0; method_index < resolved_method_entries_length(); method_index++) {
858 ResolvedMethodEntry* method_entry = resolved_method_entry_at(method_index);
859 method_entry->print_on(st);
860 if (method_entry->has_appendix()) {
861 st->print(" appendix: ");
862 constant_pool()->resolved_reference_from_method(method_index)->print_on(st);
863 }
864 }
865 }
866
867 void ConstantPoolCache::print_resolved_indy_entries(outputStream* st) const {
868 for (int indy_index = 0; indy_index < resolved_indy_entries_length(); indy_index++) {
869 ResolvedIndyEntry* indy_entry = resolved_indy_entry_at(indy_index);
870 indy_entry->print_on(st);
871 if (indy_entry->has_appendix()) {
872 st->print(" appendix: ");
873 constant_pool()->resolved_reference_from_indy(indy_index)->print_on(st);
874 }
875 }
876 }