1 /*
2 * Copyright (c) 2020, 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/archiveBuilder.hpp"
26 #include "cds/lambdaFormInvokers.hpp"
27 #include "cds/metaspaceShared.hpp"
28 #include "cds/regeneratedClasses.hpp"
29 #include "classfile/classFileStream.hpp"
30 #include "classfile/classLoadInfo.hpp"
31 #include "classfile/javaClasses.inline.hpp"
32 #include "classfile/klassFactory.hpp"
33 #include "classfile/symbolTable.hpp"
34 #include "classfile/systemDictionary.hpp"
35 #include "classfile/systemDictionaryShared.hpp"
36 #include "classfile/vmClasses.hpp"
37 #include "classfile/vmSymbols.hpp"
38 #include "logging/log.hpp"
39 #include "memory/oopFactory.hpp"
40 #include "memory/resourceArea.hpp"
41 #include "oops/instanceKlass.hpp"
42 #include "oops/klass.inline.hpp"
43 #include "oops/objArrayKlass.hpp"
44 #include "oops/objArrayOop.hpp"
45 #include "oops/oop.inline.hpp"
46 #include "oops/oopHandle.inline.hpp"
47 #include "oops/typeArrayOop.inline.hpp"
48 #include "runtime/handles.inline.hpp"
49 #include "runtime/javaCalls.hpp"
50 #include "runtime/mutexLocker.hpp"
51
52 GrowableArrayCHeap<char*, mtClassShared>* LambdaFormInvokers::_lambdaform_lines = nullptr;
53 Array<u4>* LambdaFormInvokers::_static_archive_invokers = nullptr;
54
55 #define NUM_FILTER 4
56 static const char* filter[NUM_FILTER] = {"java.lang.invoke.Invokers$Holder",
57 "java.lang.invoke.DirectMethodHandle$Holder",
58 "java.lang.invoke.DelegatingMethodHandle$Holder",
59 "java.lang.invoke.LambdaForm$Holder"};
60
61 static bool should_be_archived(char* line) {
62 for (int k = 0; k < NUM_FILTER; k++) {
63 if (strstr(line, filter[k]) != nullptr) {
64 return true;
65 }
66 }
67 return false;
68 }
69 #undef NUM_FILTER
70
71 void LambdaFormInvokers::append(char* line) {
72 MutexLocker ml(Thread::current(), LambdaFormInvokers_lock);
73 if (_lambdaform_lines == nullptr) {
74 _lambdaform_lines = new GrowableArrayCHeap<char*, mtClassShared>(150);
75 }
76 _lambdaform_lines->append(line);
77 }
78
79
80 // convenient output
81 class PrintLambdaFormMessage {
82 public:
83 PrintLambdaFormMessage() {
84 log_info(cds)("Regenerate MethodHandle Holder classes...");
85 }
86 ~PrintLambdaFormMessage() {
87 log_info(cds)("Regenerate MethodHandle Holder classes...done");
88 }
89 };
90
91 void LambdaFormInvokers::regenerate_holder_classes(TRAPS) {
92 PrintLambdaFormMessage plm;
93 if (_lambdaform_lines == nullptr || _lambdaform_lines->length() == 0) {
94 log_info(cds)("Nothing to regenerate for holder classes");
95 return;
96 }
97
98 if (CDSConfig::is_dumping_static_archive() && CDSConfig::is_dumping_invokedynamic()) {
99 // Work around JDK-8310831, as some methods in lambda form holder classes may not get generated.
100 log_info(cds)("Archived MethodHandles may refer to lambda form holder classes. Cannot regenerate.");
101 return;
102 }
103
104 if (CDSConfig::is_dumping_dynamic_archive() && CDSConfig::is_dumping_aot_linked_classes() &&
105 CDSConfig::is_using_aot_linked_classes()) {
106 // The base archive may have some pre-resolved CP entries that point to the lambda form holder
107 // classes in the base archive. If we generate new versions of these classes, those CP entries
108 // will be pointing to invalid classes.
109 log_info(cds)("Base archive already has aot-linked lambda form holder classes. Cannot regenerate.");
110 return;
111 }
112
113 ResourceMark rm(THREAD);
114
115 Symbol* cds_name = vmSymbols::jdk_internal_misc_CDS();
116 Klass* cds_klass = SystemDictionary::resolve_or_null(cds_name, THREAD);
117 guarantee(cds_klass != nullptr, "jdk/internal/misc/CDS must exist!");
118
119 HandleMark hm(THREAD);
120 int len = _lambdaform_lines->length();
121 objArrayHandle list_lines;
122 {
123 MutexLocker ml(Thread::current(), LambdaFormInvokers_lock);
124 list_lines = oopFactory::new_objArray_handle(vmClasses::String_klass(), len, CHECK);
125 for (int i = 0; i < len; i++) {
126 Handle h_line = java_lang_String::create_from_str(_lambdaform_lines->at(i), CHECK);
127 list_lines->obj_at_put(i, h_line());
128 }
129 } // Before calling into java, release vm lock.
130 //
131 // Object[] CDS.generateLambdaFormHolderClasses(String[] lines)
132 // the returned Object[] layout:
133 // name, byte[], name, byte[] ....
134 Symbol* method = vmSymbols::generateLambdaFormHolderClasses();
135 Symbol* signrs = vmSymbols::generateLambdaFormHolderClasses_signature();
136
137 JavaValue result(T_OBJECT);
138 JavaCalls::call_static(&result, cds_klass, method, signrs, list_lines, THREAD);
139
140 if (HAS_PENDING_EXCEPTION) {
141 if (!PENDING_EXCEPTION->is_a(vmClasses::OutOfMemoryError_klass())) {
142 log_error(cds)("%s: %s", PENDING_EXCEPTION->klass()->external_name(),
143 java_lang_String::as_utf8_string(java_lang_Throwable::message(PENDING_EXCEPTION)));
144 if (CDSConfig::is_dumping_static_archive()) {
145 log_error(cds)("Failed to generate LambdaForm holder classes. Is your classlist out of date?");
146 } else {
147 log_error(cds)("Failed to generate LambdaForm holder classes. Was the base archive generated with an outdated classlist?");
148 }
149 CLEAR_PENDING_EXCEPTION;
150 }
151 return;
152 }
153
154 objArrayHandle h_array(THREAD, (objArrayOop)result.get_oop());
155 int sz = h_array->length();
156 assert(sz % 2 == 0 && sz >= 2, "Must be even size of length");
157 for (int i = 0; i < sz; i+= 2) {
158 Handle h_name(THREAD, h_array->obj_at(i));
159 typeArrayHandle h_bytes(THREAD, (typeArrayOop)h_array->obj_at(i+1));
160 assert(h_name != nullptr, "Class name is null");
161 assert(h_bytes != nullptr, "Class bytes is null");
162
163 char *class_name = java_lang_String::as_utf8_string(h_name());
164 if (strstr(class_name, "java/lang/invoke/BoundMethodHandle$Species_") != nullptr) {
165 // The species classes are already loaded into the system dictionary
166 // during the execution of CDS.generateLambdaFormHolderClasses(). No
167 // need to regenerate.
168 TempNewSymbol class_name_sym = SymbolTable::new_symbol(class_name);
169 Klass* klass = SystemDictionary::resolve_or_null(class_name_sym, THREAD);
170 assert(klass != nullptr, "must already be loaded");
171 if (!klass->is_shared() && klass->shared_classpath_index() < 0) {
172 // Fake it, so that it will be included into the archive.
173 klass->set_shared_classpath_index(0);
174 // Set the "generated" bit, so it won't interfere with JVMTI.
175 // See SystemDictionaryShared::find_builtin_class().
176 klass->set_is_generated_shared_class();
177 }
178 } else {
179 int len = h_bytes->length();
180 // make a copy of class bytes so GC will not affect us.
181 char *buf = NEW_RESOURCE_ARRAY(char, len);
182 memcpy(buf, (char*)h_bytes->byte_at_addr(0), len);
183 ClassFileStream st((u1*)buf, len, nullptr);
184 regenerate_class(class_name, st, CHECK);
185 }
186 }
187 }
188
189 void LambdaFormInvokers::regenerate_class(char* class_name, ClassFileStream& st, TRAPS) {
190 TempNewSymbol class_name_sym = SymbolTable::new_symbol(class_name);
191 Klass* klass = SystemDictionary::resolve_or_null(class_name_sym, THREAD);
192 assert(klass != nullptr, "must exist");
193 assert(klass->is_instance_klass(), "Should be");
194
195 ClassLoaderData* cld = ClassLoaderData::the_null_class_loader_data();
196 Handle protection_domain;
197 ClassLoadInfo cl_info(protection_domain);
198
199 InstanceKlass* result = KlassFactory::create_from_stream(&st,
200 class_name_sym,
201 cld,
202 cl_info,
203 CHECK);
204
205 assert(result->java_mirror() != nullptr, "must be");
206 RegeneratedClasses::add_class(InstanceKlass::cast(klass), result);
207
208 result->add_to_hierarchy(THREAD);
209
210 // new class not linked yet.
211 MetaspaceShared::try_link_class(THREAD, result);
212 assert(!HAS_PENDING_EXCEPTION, "Invariant");
213
214 result->set_is_generated_shared_class();
215 if (!klass->is_shared()) {
216 SystemDictionaryShared::set_excluded(InstanceKlass::cast(klass)); // exclude the existing class from dump
217 }
218 log_info(cds, lambda)("Regenerated class %s, old: " INTPTR_FORMAT " new: " INTPTR_FORMAT,
219 class_name, p2i(klass), p2i(result));
220 }
221
222 void LambdaFormInvokers::dump_static_archive_invokers() {
223 if (_lambdaform_lines != nullptr && _lambdaform_lines->length() > 0) {
224 int count = 0;
225 int len = _lambdaform_lines->length();
226 for (int i = 0; i < len; i++) {
227 char* str = _lambdaform_lines->at(i);
228 if (should_be_archived(str)) {
229 count++;
230 }
231 }
232 if (count > 0) {
233 _static_archive_invokers = ArchiveBuilder::new_ro_array<u4>(count);
234 int index = 0;
235 for (int i = 0; i < len; i++) {
236 char* str = _lambdaform_lines->at(i);
237 if (should_be_archived(str)) {
238 size_t str_len = strlen(str) + 1; // including terminating zero
239 Array<char>* line = ArchiveBuilder::new_ro_array<char>((int)str_len);
240 strncpy(line->adr_at(0), str, str_len);
241
242 _static_archive_invokers->at_put(index, ArchiveBuilder::current()->any_to_offset_u4(line));
243 index++;
244 }
245 }
246 assert(index == count, "Should match");
247 }
248 log_debug(cds)("Total LF lines stored into static archive: %d", count);
249 }
250 }
251
252 void LambdaFormInvokers::read_static_archive_invokers() {
253 if (_static_archive_invokers != nullptr) {
254 for (int i = 0; i < _static_archive_invokers->length(); i++) {
255 u4 offset = _static_archive_invokers->at(i);
256 Array<char>* line = ArchiveUtils::offset_to_archived_address<Array<char>*>(offset);
257 char* str = line->adr_at(0);
258 append(str);
259 }
260 log_debug(cds)("Total LF lines read from static archive: %d", _static_archive_invokers->length());
261 }
262 }
263
264 void LambdaFormInvokers::serialize(SerializeClosure* soc) {
265 soc->do_ptr(&_static_archive_invokers);
266 if (soc->reading() && CDSConfig::is_dumping_final_static_archive()) {
267 LambdaFormInvokers::read_static_archive_invokers();
268 _static_archive_invokers = nullptr;
269 }
270 }