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