1 /*
2 * Copyright (c) 2024, 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/archiveUtils.inline.hpp"
28 #include "cds/cdsConfig.hpp"
29 #include "cds/finalImageRecipes.hpp"
30 #include "classfile/classLoader.hpp"
31 #include "classfile/javaClasses.hpp"
32 #include "classfile/systemDictionary.hpp"
33 #include "classfile/systemDictionaryShared.hpp"
34 #include "classfile/vmClasses.hpp"
35 #include "memory/oopFactory.hpp"
36 #include "memory/resourceArea.hpp"
37 #include "oops/constantPool.inline.hpp"
38 #include "runtime/handles.inline.hpp"
39 #include "runtime/mutexLocker.hpp"
40
41 GrowableArray<InstanceKlass*>* FinalImageRecipes::_tmp_reflect_klasses = nullptr;
42 GrowableArray<int>* FinalImageRecipes::_tmp_reflect_flags = nullptr;
43 GrowableArray<FinalImageRecipes::TmpDynamicProxyClassInfo>* FinalImageRecipes::_tmp_dynamic_proxy_classes = nullptr;
44 static FinalImageRecipes* _final_image_recipes = nullptr;
45
46 void* FinalImageRecipes::operator new(size_t size) throw() {
47 return ArchiveBuilder::current()->ro_region_alloc(size);
48 }
49
50 void FinalImageRecipes::record_all_classes() {
51 _all_klasses = ArchiveUtils::archive_array(ArchiveBuilder::current()->klasses());
52 ArchivePtrMarker::mark_pointer(&_all_klasses);
53 }
54
55 void FinalImageRecipes::record_recipes_for_constantpool() {
56 ResourceMark rm;
57
58 // The recipes are recorded regardless of CDSConfig::is_dumping_{invokedynamic,dynamic_proxies,reflection_data}().
59 // If some of these options are not enabled, the corresponding recipes will be
60 // ignored during the final image assembly.
61
62 GrowableArray<Array<int>*> tmp_cp_recipes;
63 GrowableArray<int> tmp_cp_flags;
64
65 GrowableArray<Klass*>* klasses = ArchiveBuilder::current()->klasses();
66 for (int i = 0; i < klasses->length(); i++) {
67 GrowableArray<int> cp_indices;
68 int flags = 0;
69
70 Klass* k = klasses->at(i);
71 if (k->is_instance_klass()) {
72 InstanceKlass* ik = InstanceKlass::cast(k);
73 ConstantPool* cp = ik->constants();
74 ConstantPoolCache* cp_cache = cp->cache();
75
76 for (int cp_index = 1; cp_index < cp->length(); cp_index++) { // Index 0 is unused
77 if (cp->tag_at(cp_index).value() == JVM_CONSTANT_Class) {
78 Klass* k = cp->resolved_klass_at(cp_index);
79 if (k->is_instance_klass()) {
80 cp_indices.append(cp_index);
81 flags |= HAS_CLASS;
82 }
83 }
84 }
85
86 if (cp_cache != nullptr) {
87 Array<ResolvedFieldEntry>* field_entries = cp_cache->resolved_field_entries();
88 if (field_entries != nullptr) {
89 for (int i = 0; i < field_entries->length(); i++) {
90 ResolvedFieldEntry* rfe = field_entries->adr_at(i);
91 if (rfe->is_resolved(Bytecodes::_getfield) ||
92 rfe->is_resolved(Bytecodes::_putfield)) {
93 cp_indices.append(rfe->constant_pool_index());
94 flags |= HAS_FIELD_AND_METHOD;
95 }
96 }
97 }
98
99 Array<ResolvedMethodEntry>* method_entries = cp_cache->resolved_method_entries();
100 if (method_entries != nullptr) {
101 for (int i = 0; i < method_entries->length(); i++) {
102 ResolvedMethodEntry* rme = method_entries->adr_at(i);
103 if (rme->is_resolved(Bytecodes::_invokevirtual) ||
104 rme->is_resolved(Bytecodes::_invokespecial) ||
105 rme->is_resolved(Bytecodes::_invokeinterface) ||
106 rme->is_resolved(Bytecodes::_invokestatic) ||
107 rme->is_resolved(Bytecodes::_invokehandle)) {
108 cp_indices.append(rme->constant_pool_index());
109 flags |= HAS_FIELD_AND_METHOD;
110 }
111 }
112 }
113
114 Array<ResolvedIndyEntry>* indy_entries = cp_cache->resolved_indy_entries();
115 if (indy_entries != nullptr) {
116 for (int i = 0; i < indy_entries->length(); i++) {
117 ResolvedIndyEntry* rie = indy_entries->adr_at(i);
118 int cp_index = rie->constant_pool_index();
119 if (rie->is_resolved()) {
120 cp_indices.append(cp_index);
121 flags |= HAS_INDY;
122 }
123 }
124 }
125 }
126 }
127
128 if (cp_indices.length() > 0) {
129 tmp_cp_recipes.append(ArchiveUtils::archive_array(&cp_indices));
130 } else {
131 tmp_cp_recipes.append(nullptr);
132 }
133 tmp_cp_flags.append(flags);
134 }
135
136 _cp_recipes = ArchiveUtils::archive_array(&tmp_cp_recipes);
137 ArchivePtrMarker::mark_pointer(&_cp_recipes);
138
139 _cp_flags = ArchiveUtils::archive_array(&tmp_cp_flags);
140 ArchivePtrMarker::mark_pointer(&_cp_flags);
141 }
142
143 void FinalImageRecipes::apply_recipes_for_constantpool(JavaThread* current) {
144 assert(CDSConfig::is_dumping_final_static_archive(), "must be");
145
146 for (int i = 0; i < _all_klasses->length(); i++) {
147 Array<int>* cp_indices = _cp_recipes->at(i);
148 int flags = _cp_flags->at(i);
149 if (cp_indices != nullptr) {
150 InstanceKlass* ik = InstanceKlass::cast(_all_klasses->at(i));
151 if (ik->is_loaded()) {
152 ResourceMark rm(current);
153 ConstantPool* cp = ik->constants();
154 GrowableArray<bool> preresolve_list(cp->length(), cp->length(), false);
155 for (int j = 0; j < cp_indices->length(); j++) {
156 preresolve_list.at_put(cp_indices->at(j), true);
157 }
158 if ((flags & HAS_CLASS) != 0) {
159 AOTConstantPoolResolver::preresolve_class_cp_entries(current, ik, &preresolve_list);
160 }
161 if ((flags & HAS_FIELD_AND_METHOD) != 0) {
162 AOTConstantPoolResolver::preresolve_field_and_method_cp_entries(current, ik, &preresolve_list);
163 }
164 if ((flags & HAS_INDY) != 0) {
165 AOTConstantPoolResolver::preresolve_indy_cp_entries(current, ik, &preresolve_list);
166 }
167 }
168 }
169 }
170 }
171
172 void FinalImageRecipes::record_recipes_for_reflection_data() {
173 int reflect_count = 0;
174 if (_tmp_reflect_klasses != nullptr) {
175 for (int i = _tmp_reflect_klasses->length() - 1; i >= 0; i--) {
176 InstanceKlass* ik = _tmp_reflect_klasses->at(i);
177 if (SystemDictionaryShared::is_excluded_class(ik)) {
178 _tmp_reflect_klasses->remove_at(i);
179 _tmp_reflect_flags->remove_at(i);
180 } else {
181 _tmp_reflect_klasses->at_put(i, ArchiveBuilder::current()->get_buffered_addr(ik));
182 }
183 }
184 if (_tmp_reflect_klasses->length() > 0) {
185 _reflect_klasses = ArchiveUtils::archive_array(_tmp_reflect_klasses);
186 _reflect_flags = ArchiveUtils::archive_array(_tmp_reflect_flags);
187
188 ArchivePtrMarker::mark_pointer(&_reflect_klasses);
189 ArchivePtrMarker::mark_pointer(&_reflect_flags);
190 reflect_count = _tmp_reflect_klasses->length();
191 }
192 }
193 log_info(cds)("ReflectionData of %d classes will be archived in final CDS image", reflect_count);
194 }
195
196 void FinalImageRecipes::record_recipes_for_dynamic_proxies() {
197 if (_tmp_dynamic_proxy_classes != nullptr) {
198 // Remove proxies for excluded classes
199 for (int i = _tmp_dynamic_proxy_classes->length() - 1; i >= 0; i--) {
200 TmpDynamicProxyClassInfo* tmp_info = _tmp_dynamic_proxy_classes->adr_at(i);
201 bool exclude = false;
202 for (int j = 0; j < tmp_info->_interfaces->length(); j++) {
203 if (SystemDictionaryShared::is_excluded_class(InstanceKlass::cast(tmp_info->_interfaces->at(j)))) {
204 exclude = true;
205 break;
206 }
207 }
208 if (exclude) {
209 _tmp_dynamic_proxy_classes->remove_at(i);
210 }
211 }
212 int len = _tmp_dynamic_proxy_classes->length();
213 _dynamic_proxy_classes = ArchiveBuilder::new_ro_array<DynamicProxyClassInfo>(len);
214 ArchivePtrMarker::mark_pointer(&_dynamic_proxy_classes);
215 for (int i = 0; i < len; i++) {
216 TmpDynamicProxyClassInfo* tmp_info = _tmp_dynamic_proxy_classes->adr_at(i);
217 DynamicProxyClassInfo* info = _dynamic_proxy_classes->adr_at(i);
218 info->_loader_type = tmp_info->_loader_type;
219 info->_access_flags = tmp_info->_access_flags;
220 info->_proxy_name = ArchiveBuilder::current()->ro_strdup(tmp_info->_proxy_name);
221
222 ResourceMark rm;
223 GrowableArray<Klass*> buffered_interfaces;
224 for (int j = 0; j < tmp_info->_interfaces->length(); j++) {
225 InstanceKlass* intf = InstanceKlass::cast(tmp_info->_interfaces->at(j));
226 assert(!SystemDictionaryShared::is_excluded_class(intf), "sanity");
227 buffered_interfaces.append(ArchiveBuilder::current()->get_buffered_addr(intf));
228 }
229 info->_interfaces = ArchiveUtils::archive_array(&buffered_interfaces);
230
231 ArchivePtrMarker::mark_pointer(&info->_proxy_name);
232 ArchivePtrMarker::mark_pointer(&info->_interfaces);
233 ArchiveBuilder::alloc_stats()->record_dynamic_proxy_class();
234 }
235 }
236 }
237
238 void FinalImageRecipes::load_all_classes(TRAPS) {
239 assert(CDSConfig::is_dumping_final_static_archive(), "sanity");
240 Handle class_loader(THREAD, SystemDictionary::java_system_loader());
241 for (int i = 0; i < _all_klasses->length(); i++) {
242 Klass* k = _all_klasses->at(i);
243 if (k->is_instance_klass()) {
244 InstanceKlass* ik = InstanceKlass::cast(k);
245 if (ik->is_shared_unregistered_class()) {
246 SystemDictionaryShared::init_dumptime_info(ik);
247 SystemDictionaryShared::add_unregistered_class(THREAD, ik);
248 SystemDictionaryShared::copy_unregistered_class_size_and_crc32(ik);
249 } else if (!ik->is_hidden()) {
250 Klass* actual = SystemDictionary::resolve_or_fail(ik->name(), class_loader, true, CHECK);
251 if (actual != ik) {
252 ResourceMark rm(THREAD);
253 log_error(cds)("Unable to resolve class from CDS archive: %s", ik->external_name());
254 log_error(cds)("Expected: " INTPTR_FORMAT ", actual: " INTPTR_FORMAT, p2i(ik), p2i(actual));
255 log_error(cds)("Please check if your VM command-line is the same as in the training run");
256 MetaspaceShared::unrecoverable_writing_error();
257 }
258 assert(ik->is_loaded(), "must be");
259 ik->link_class(CHECK);
260 }
261 }
262 }
263 }
264
265 void FinalImageRecipes::apply_recipes_for_reflection_data(JavaThread* current) {
266 assert(CDSConfig::is_dumping_final_static_archive(), "must be");
267
268 if (CDSConfig::is_dumping_reflection_data() && _reflect_klasses != nullptr) {
269 assert(_reflect_flags != nullptr, "must be");
270 for (int i = 0; i < _reflect_klasses->length(); i++) {
271 InstanceKlass* ik = _reflect_klasses->at(i);
272 int rd_flags = _reflect_flags->at(i);
273 AOTConstantPoolResolver::generate_reflection_data(current, ik, rd_flags);
274 }
275 }
276 }
277
278 void FinalImageRecipes::add_reflection_data_flags(InstanceKlass* ik, TRAPS) {
279 assert(CDSConfig::is_dumping_preimage_static_archive(), "must be");
280 if (ik->is_linked() &&
281 SystemDictionaryShared::is_builtin_loader(ik->class_loader_data()) && !ik->is_hidden() &&
282 java_lang_Class::has_reflection_data(ik->java_mirror())) {
283 int rd_flags = AOTConstantPoolResolver::class_reflection_data_flags(ik, CHECK);
284
285 MutexLocker mu(FinalImageRecipes_lock, Mutex::_no_safepoint_check_flag);
286 if (_tmp_reflect_klasses == nullptr) {
287 _tmp_reflect_klasses = new (mtClassShared) GrowableArray<InstanceKlass*>(100, mtClassShared);
288 _tmp_reflect_flags = new (mtClassShared) GrowableArray<int>(100, mtClassShared);
289 }
290 _tmp_reflect_klasses->append(ik);
291 _tmp_reflect_flags->append(rd_flags);
292 }
293 }
294
295 void FinalImageRecipes::add_dynamic_proxy_class(oop loader, const char* proxy_name, objArrayOop interfaces, int access_flags) {
296 int loader_type;
297 if (loader == nullptr) {
298 loader_type = ClassLoader::BOOT_LOADER;
299 } else if (loader == SystemDictionary::java_platform_loader()) {
300 loader_type = ClassLoader::PLATFORM_LOADER;
301 } else if (loader == SystemDictionary::java_system_loader()) {
302 loader_type = ClassLoader::APP_LOADER;
303 } else {
304 return;
305 }
306
307 MutexLocker mu(FinalImageRecipes_lock, Mutex::_no_safepoint_check_flag);
308 if (_tmp_dynamic_proxy_classes == nullptr) {
309 _tmp_dynamic_proxy_classes = new (mtClassShared) GrowableArray<TmpDynamicProxyClassInfo>(32, mtClassShared);
310 }
311
312 log_info(cds, dynamic, proxy)("Adding proxy name %s", proxy_name);
313
314 TmpDynamicProxyClassInfo info;
315 info._loader_type = loader_type;
316 info._access_flags = access_flags;
317 info._proxy_name = os::strdup(proxy_name);
318 info._interfaces = new (mtClassShared) GrowableArray<Klass*>(interfaces->length(), mtClassShared);
319 for (int i = 0; i < interfaces->length(); i++) {
320 Klass* intf = java_lang_Class::as_Klass(interfaces->obj_at(i));
321 info._interfaces->append(InstanceKlass::cast(intf));
322
323 if (log_is_enabled(Info, cds, dynamic, proxy)) {
324 ResourceMark rm;
325 log_info(cds, dynamic, proxy)("interface[%d] = %s", i, intf->external_name());
326 }
327 }
328 _tmp_dynamic_proxy_classes->append(info);
329 }
330
331 void FinalImageRecipes::apply_recipes_for_dynamic_proxies(TRAPS) {
332 if (CDSConfig::is_dumping_dynamic_proxies() && _dynamic_proxy_classes != nullptr) {
333 for (int proxy_index = 0; proxy_index < _dynamic_proxy_classes->length(); proxy_index++) {
334 DynamicProxyClassInfo* info = _dynamic_proxy_classes->adr_at(proxy_index);
335
336 Handle loader(THREAD, ArchiveUtils::builtin_loader_from_type(info->_loader_type));
337 oop proxy_name_oop = java_lang_String::create_oop_from_str(info->_proxy_name, CHECK);
338 Handle proxy_name(THREAD, proxy_name_oop);
339
340 int num_intfs = info->_interfaces->length();
341 objArrayOop interfaces_oop = oopFactory::new_objArray(vmClasses::Class_klass(), num_intfs, CHECK);
342 objArrayHandle interfaces(THREAD, interfaces_oop);
343 for (int intf_index = 0; intf_index < num_intfs; intf_index++) {
344 Klass* k = info->_interfaces->at(intf_index);
345 assert(k->java_mirror() != nullptr, "must be loaded");
346 interfaces()->obj_at_put(intf_index, k->java_mirror());
347 }
348
349 AOTConstantPoolResolver::define_dynamic_proxy_class(loader, proxy_name, interfaces, info->_access_flags, CHECK);
350 }
351 }
352 }
353
354 void FinalImageRecipes::record_recipes() {
355 assert(CDSConfig::is_dumping_preimage_static_archive(), "must be");
356 _final_image_recipes = new FinalImageRecipes();
357 _final_image_recipes->record_all_classes();
358 _final_image_recipes->record_recipes_for_constantpool();
359 _final_image_recipes->record_recipes_for_reflection_data();
360 _final_image_recipes->record_recipes_for_dynamic_proxies();
361 }
362
363 void FinalImageRecipes::apply_recipes(TRAPS) {
364 assert(CDSConfig::is_dumping_final_static_archive(), "must be");
365 if (_final_image_recipes != nullptr) {
366 _final_image_recipes->apply_recipes_impl(THREAD);
367 if (HAS_PENDING_EXCEPTION) {
368 log_error(cds)("%s: %s", PENDING_EXCEPTION->klass()->external_name(),
369 java_lang_String::as_utf8_string(java_lang_Throwable::message(PENDING_EXCEPTION)));
370 log_error(cds)("Please check if your VM command-line is the same as in the training run");
371 MetaspaceShared::unrecoverable_writing_error("Unexpected exception, use -Xlog:cds,exceptions=trace for detail");
372 }
373 }
374
375 // Set it to null as we don't need to write this table into the final image.
376 _final_image_recipes = nullptr;
377 }
378
379 void FinalImageRecipes::apply_recipes_impl(TRAPS) {
380 load_all_classes(CHECK);
381 apply_recipes_for_constantpool(THREAD);
382 apply_recipes_for_reflection_data(CHECK);
383 apply_recipes_for_dynamic_proxies(CHECK);
384 }
385
386 void FinalImageRecipes::serialize(SerializeClosure* soc) {
387 soc->do_ptr((void**)&_final_image_recipes);
388 }