1 /*
2 * Copyright (c) 2014, 2023, 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 #ifndef SHARE_CLASSFILE_SYSTEMDICTIONARYSHARED_HPP
26 #define SHARE_CLASSFILE_SYSTEMDICTIONARYSHARED_HPP
27
28 #include "cds/cds_globals.hpp"
29 #include "cds/filemap.hpp"
30 #include "cds/dumpTimeClassInfo.hpp"
31 #include "cds/lambdaProxyClassDictionary.hpp"
32 #include "cds/runTimeClassInfo.hpp"
33 #include "classfile/classLoaderData.hpp"
34 #include "classfile/packageEntry.hpp"
35 #include "classfile/systemDictionary.hpp"
36 #include "oops/klass.hpp"
37 #include "oops/oopHandle.hpp"
38
39
40 /*===============================================================================
41
42 Handling of the classes in the AppCDS archive
43
44 To ensure safety and to simplify the implementation, archived classes are
45 "segregated" into 2 types. The following rules describe how they
46 are stored and looked up.
47
48 [1] Category of archived classes
49
50 There are 2 disjoint groups of classes stored in the AppCDS archive:
51
52 BUILTIN: These classes may be defined ONLY by the BOOT/PLATFORM/APP
53 loaders.
54
55 UNREGISTERED: These classes may be defined ONLY by a ClassLoader
56 instance that's not listed above (using fingerprint matching)
57
166 static DumpTimeLambdaProxyClassDictionary* _dumptime_lambda_proxy_class_dictionary;
167
168 static ArchiveInfo _static_archive;
169 static ArchiveInfo _dynamic_archive;
170
171 static ArchiveInfo* get_archive(bool is_static_archive) {
172 return is_static_archive ? &_static_archive : &_dynamic_archive;
173 }
174
175 static InstanceKlass* load_shared_class_for_builtin_loader(
176 Symbol* class_name,
177 Handle class_loader,
178 TRAPS);
179 static InstanceKlass* acquire_class_for_current_thread(
180 InstanceKlass *ik,
181 Handle class_loader,
182 Handle protection_domain,
183 const ClassFileStream* cfs,
184 TRAPS);
185
186 // Guaranteed to return non-null value for non-shared classes.
187 // k must not be a shared class.
188 static DumpTimeClassInfo* get_info(InstanceKlass* k);
189 static DumpTimeClassInfo* get_info_locked(InstanceKlass* k);
190
191 static void write_dictionary(RunTimeSharedDictionary* dictionary,
192 bool is_builtin);
193 static void write_lambda_proxy_class_dictionary(LambdaProxyClassDictionary* dictionary);
194 static void cleanup_lambda_proxy_class_dictionary();
195 static void reset_registered_lambda_proxy_class(InstanceKlass* ik);
196 static bool is_jfr_event_class(InstanceKlass *k);
197 static bool is_registered_lambda_proxy_class(InstanceKlass* ik);
198 static bool check_for_exclusion_impl(InstanceKlass* k);
199 static void remove_dumptime_info(InstanceKlass* k) NOT_CDS_RETURN;
200 static bool has_been_redefined(InstanceKlass* k);
201 static InstanceKlass* retrieve_lambda_proxy_class(const RunTimeLambdaProxyClassInfo* info) NOT_CDS_RETURN_(nullptr);
202
203 DEBUG_ONLY(static bool _class_loading_may_happen;)
204
205 public:
206 static bool is_hidden_lambda_proxy(InstanceKlass* ik);
207 static bool is_early_klass(InstanceKlass* k); // Was k loaded while JvmtiExport::is_early_phase()==true
208 static bool has_archived_enum_objs(InstanceKlass* ik);
209 static void set_has_archived_enum_objs(InstanceKlass* ik);
210
211 static InstanceKlass* find_builtin_class(Symbol* class_name);
212
213 static const RunTimeClassInfo* find_record(RunTimeSharedDictionary* static_dict,
214 RunTimeSharedDictionary* dynamic_dict,
215 Symbol* name);
216
217 static bool has_platform_or_app_classes();
218
219 // Called by PLATFORM/APP loader only
220 static InstanceKlass* find_or_load_shared_class(Symbol* class_name,
221 Handle class_loader,
222 TRAPS);
223
224
225 static void allocate_shared_data_arrays(int size, TRAPS);
226
227 static bool is_builtin_loader(ClassLoaderData* loader_data);
228
229 static InstanceKlass* lookup_super_for_unregistered_class(Symbol* class_name,
230 Symbol* super_name, bool is_superclass);
231
232 static void initialize() NOT_CDS_RETURN;
233 static void init_dumptime_info(InstanceKlass* k) NOT_CDS_RETURN;
234 static void handle_class_unloading(InstanceKlass* k) NOT_CDS_RETURN;
235
236 static Dictionary* boot_loader_dictionary() {
237 return ClassLoaderData::the_null_class_loader_data()->dictionary();
238 }
239
240 static void update_shared_entry(InstanceKlass* klass, int id);
241 static void set_shared_class_misc_info(InstanceKlass* k, ClassFileStream* cfs);
242
243 static InstanceKlass* lookup_from_stream(Symbol* class_name,
244 Handle class_loader,
245 Handle protection_domain,
246 const ClassFileStream* st,
247 TRAPS);
248 // "verification_constraints" are a set of checks performed by
249 // VerificationType::is_reference_assignable_from when verifying a shared class during
250 // dump time.
251 //
252 // With AppCDS, it is possible to override archived classes by calling
253 // ClassLoader.defineClass() directly. SystemDictionary::load_shared_class() already
254 // ensures that you cannot load a shared class if its super type(s) are changed. However,
255 // we need an additional check to ensure that the verification_constraints did not change
266 InstanceKlass* lambda_ik,
267 Symbol* invoked_name,
268 Symbol* invoked_type,
269 Symbol* method_type,
270 Method* member_method,
271 Symbol* instantiated_method_type, TRAPS) NOT_CDS_RETURN;
272 static void add_to_dump_time_lambda_proxy_class_dictionary(LambdaProxyClassKey& key,
273 InstanceKlass* proxy_klass) NOT_CDS_RETURN;
274 static InstanceKlass* get_shared_lambda_proxy_class(InstanceKlass* caller_ik,
275 Symbol* invoked_name,
276 Symbol* invoked_type,
277 Symbol* method_type,
278 Method* member_method,
279 Symbol* instantiated_method_type) NOT_CDS_RETURN_(nullptr);
280 static InstanceKlass* get_shared_nest_host(InstanceKlass* lambda_ik) NOT_CDS_RETURN_(nullptr);
281 static InstanceKlass* prepare_shared_lambda_proxy_class(InstanceKlass* lambda_ik,
282 InstanceKlass* caller_ik, TRAPS) NOT_CDS_RETURN_(nullptr);
283 static bool check_linking_constraints(Thread* current, InstanceKlass* klass) NOT_CDS_RETURN_(false);
284 static void record_linking_constraint(Symbol* name, InstanceKlass* klass,
285 Handle loader1, Handle loader2) NOT_CDS_RETURN;
286 static bool is_builtin(InstanceKlass* k) {
287 return (k->shared_classpath_index() != UNREGISTERED_INDEX);
288 }
289 static bool add_unregistered_class(Thread* current, InstanceKlass* k);
290
291 static void check_excluded_classes();
292 static bool check_for_exclusion(InstanceKlass* k, DumpTimeClassInfo* info);
293 static void validate_before_archiving(InstanceKlass* k);
294 static bool is_excluded_class(InstanceKlass* k);
295 static void set_excluded(InstanceKlass* k);
296 static void set_excluded_locked(InstanceKlass* k);
297 static bool warn_excluded(InstanceKlass* k, const char* reason);
298 static void dumptime_classes_do(class MetaspaceClosure* it);
299 static size_t estimate_size_for_archive();
300 static void write_to_archive(bool is_static_archive = true);
301 static void adjust_lambda_proxy_class_dictionary();
302 static void serialize_dictionary_headers(class SerializeClosure* soc,
303 bool is_static_archive = true);
304 static void serialize_vm_classes(class SerializeClosure* soc);
305 static void print() { return print_on(tty); }
306 static void print_on(outputStream* st) NOT_CDS_RETURN;
307 static void print_shared_archive(outputStream* st, bool is_static = true) NOT_CDS_RETURN;
308 static void print_table_statistics(outputStream* st) NOT_CDS_RETURN;
309 static bool is_dumptime_table_empty() NOT_CDS_RETURN_(true);
310 static bool is_supported_invokedynamic(BootstrapInfo* bsi) NOT_CDS_RETURN_(false);
311 DEBUG_ONLY(static bool class_loading_may_happen() {return _class_loading_may_happen;})
312
313 #ifdef ASSERT
314 // This object marks a critical period when writing the CDS archive. During this
315 // period, the JVM must not load any new classes, so as to avoid adding new
316 // items in the SystemDictionaryShared::_dumptime_table.
317 class NoClassLoadingMark: public StackObj {
318 public:
319 NoClassLoadingMark() {
320 assert(_class_loading_may_happen, "must not be nested");
321 _class_loading_may_happen = false;
322 }
323 ~NoClassLoadingMark() {
324 _class_loading_may_happen = true;
325 }
326 };
327 #endif
328
329 template <typename T>
330 static unsigned int hash_for_shared_dictionary_quick(T* ptr) {
331 assert(MetaspaceObj::is_shared((const MetaspaceObj*)ptr), "must be");
332 assert(ptr > (T*)SharedBaseAddress, "must be");
333 uintx offset = uintx(ptr) - uintx(SharedBaseAddress);
334 return primitive_hash<uintx>(offset);
335 }
336
337 static unsigned int hash_for_shared_dictionary(address ptr);
338 };
339
340 #endif // SHARE_CLASSFILE_SYSTEMDICTIONARYSHARED_HPP
|
1 /*
2 * Copyright (c) 2014, 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 #ifndef SHARE_CLASSFILE_SYSTEMDICTIONARYSHARED_HPP
26 #define SHARE_CLASSFILE_SYSTEMDICTIONARYSHARED_HPP
27
28 #include "cds/cds_globals.hpp"
29 #include "cds/filemap.hpp"
30 #include "cds/dumpTimeClassInfo.hpp"
31 #include "cds/lambdaProxyClassDictionary.hpp"
32 #include "cds/runTimeClassInfo.hpp"
33 #include "classfile/classLoaderData.hpp"
34 #include "classfile/packageEntry.hpp"
35 #include "classfile/systemDictionary.hpp"
36 #include "oops/klass.hpp"
37 #include "oops/oopHandle.hpp"
38 #include "oops/trainingData.hpp"
39
40
41 /*===============================================================================
42
43 Handling of the classes in the AppCDS archive
44
45 To ensure safety and to simplify the implementation, archived classes are
46 "segregated" into 2 types. The following rules describe how they
47 are stored and looked up.
48
49 [1] Category of archived classes
50
51 There are 2 disjoint groups of classes stored in the AppCDS archive:
52
53 BUILTIN: These classes may be defined ONLY by the BOOT/PLATFORM/APP
54 loaders.
55
56 UNREGISTERED: These classes may be defined ONLY by a ClassLoader
57 instance that's not listed above (using fingerprint matching)
58
167 static DumpTimeLambdaProxyClassDictionary* _dumptime_lambda_proxy_class_dictionary;
168
169 static ArchiveInfo _static_archive;
170 static ArchiveInfo _dynamic_archive;
171
172 static ArchiveInfo* get_archive(bool is_static_archive) {
173 return is_static_archive ? &_static_archive : &_dynamic_archive;
174 }
175
176 static InstanceKlass* load_shared_class_for_builtin_loader(
177 Symbol* class_name,
178 Handle class_loader,
179 TRAPS);
180 static InstanceKlass* acquire_class_for_current_thread(
181 InstanceKlass *ik,
182 Handle class_loader,
183 Handle protection_domain,
184 const ClassFileStream* cfs,
185 TRAPS);
186
187 static void find_all_archivable_classes_impl();
188 static void write_dictionary(RunTimeSharedDictionary* dictionary,
189 bool is_builtin);
190 static void write_lambda_proxy_class_dictionary(LambdaProxyClassDictionary* dictionary);
191 static void cleanup_lambda_proxy_class_dictionary();
192 static void reset_registered_lambda_proxy_class(InstanceKlass* ik);
193 static bool is_registered_lambda_proxy_class(InstanceKlass* ik);
194 static bool check_for_exclusion_impl(InstanceKlass* k);
195 static void remove_dumptime_info(InstanceKlass* k) NOT_CDS_RETURN;
196 static InstanceKlass* retrieve_lambda_proxy_class(const RunTimeLambdaProxyClassInfo* info) NOT_CDS_RETURN_(nullptr);
197 static void scan_constant_pool(InstanceKlass* k);
198 DEBUG_ONLY(static bool _class_loading_may_happen;)
199
200 public:
201 // Guaranteed to return non-null value for non-shared classes.
202 // k must not be a shared class.
203 static DumpTimeClassInfo* get_info(InstanceKlass* k);
204 static DumpTimeClassInfo* get_info_locked(InstanceKlass* k);
205 static DumpTimeSharedClassTable* dumptime_table() { return _dumptime_table; }
206
207 static bool should_hidden_class_be_archived(InstanceKlass* k);
208 static void mark_required_class(InstanceKlass* k);
209 static bool has_been_redefined(InstanceKlass* k);
210 static bool is_jfr_event_class(InstanceKlass *k);
211 static bool is_hidden_lambda_proxy(InstanceKlass* ik);
212 static bool is_early_klass(InstanceKlass* k); // Was k loaded while JvmtiExport::is_early_phase()==true
213 static bool has_archived_enum_objs(InstanceKlass* ik);
214 static void set_has_archived_enum_objs(InstanceKlass* ik);
215
216 static InstanceKlass* find_builtin_class(Symbol* class_name);
217
218 static const RunTimeClassInfo* find_record(RunTimeSharedDictionary* static_dict,
219 RunTimeSharedDictionary* dynamic_dict,
220 Symbol* name);
221
222 static bool has_platform_or_app_classes();
223
224 // Called by PLATFORM/APP loader only
225 static InstanceKlass* find_or_load_shared_class(Symbol* class_name,
226 Handle class_loader,
227 TRAPS);
228
229 static void preload_archived_classes(TRAPS);
230
231 static void allocate_shared_data_arrays(int size, TRAPS);
232
233 static bool is_builtin_loader(ClassLoaderData* loader_data);
234
235 static InstanceKlass* lookup_super_for_unregistered_class(Symbol* class_name,
236 Symbol* super_name, bool is_superclass);
237
238 static void initialize() NOT_CDS_RETURN;
239 static void init_dumptime_info(InstanceKlass* k) NOT_CDS_RETURN;
240 static void handle_class_unloading(InstanceKlass* k) NOT_CDS_RETURN;
241
242 static bool can_be_preinited(InstanceKlass* ik);
243 static bool can_be_preinited_locked(InstanceKlass* ik);
244 static void reset_preinit_check();
245
246 static Dictionary* boot_loader_dictionary() {
247 return ClassLoaderData::the_null_class_loader_data()->dictionary();
248 }
249
250 static void update_shared_entry(InstanceKlass* klass, int id);
251 static void set_shared_class_misc_info(InstanceKlass* k, ClassFileStream* cfs);
252
253 static InstanceKlass* lookup_from_stream(Symbol* class_name,
254 Handle class_loader,
255 Handle protection_domain,
256 const ClassFileStream* st,
257 TRAPS);
258 // "verification_constraints" are a set of checks performed by
259 // VerificationType::is_reference_assignable_from when verifying a shared class during
260 // dump time.
261 //
262 // With AppCDS, it is possible to override archived classes by calling
263 // ClassLoader.defineClass() directly. SystemDictionary::load_shared_class() already
264 // ensures that you cannot load a shared class if its super type(s) are changed. However,
265 // we need an additional check to ensure that the verification_constraints did not change
276 InstanceKlass* lambda_ik,
277 Symbol* invoked_name,
278 Symbol* invoked_type,
279 Symbol* method_type,
280 Method* member_method,
281 Symbol* instantiated_method_type, TRAPS) NOT_CDS_RETURN;
282 static void add_to_dump_time_lambda_proxy_class_dictionary(LambdaProxyClassKey& key,
283 InstanceKlass* proxy_klass) NOT_CDS_RETURN;
284 static InstanceKlass* get_shared_lambda_proxy_class(InstanceKlass* caller_ik,
285 Symbol* invoked_name,
286 Symbol* invoked_type,
287 Symbol* method_type,
288 Method* member_method,
289 Symbol* instantiated_method_type) NOT_CDS_RETURN_(nullptr);
290 static InstanceKlass* get_shared_nest_host(InstanceKlass* lambda_ik) NOT_CDS_RETURN_(nullptr);
291 static InstanceKlass* prepare_shared_lambda_proxy_class(InstanceKlass* lambda_ik,
292 InstanceKlass* caller_ik, TRAPS) NOT_CDS_RETURN_(nullptr);
293 static bool check_linking_constraints(Thread* current, InstanceKlass* klass) NOT_CDS_RETURN_(false);
294 static void record_linking_constraint(Symbol* name, InstanceKlass* klass,
295 Handle loader1, Handle loader2) NOT_CDS_RETURN;
296 static bool is_builtin(const InstanceKlass* k) {
297 return (k->shared_classpath_index() != UNREGISTERED_INDEX);
298 }
299 static bool add_unregistered_class(Thread* current, InstanceKlass* k);
300
301 static void find_all_archivable_classes();
302 static bool check_for_exclusion(Klass* k);
303 static bool check_for_exclusion(InstanceKlass* k, DumpTimeClassInfo* info);
304 static void validate_before_archiving(InstanceKlass* k);
305 static bool is_excluded_class(InstanceKlass* k);
306 static void set_excluded(InstanceKlass* k);
307 static void set_excluded_locked(InstanceKlass* k);
308 static bool warn_excluded(InstanceKlass* k, const char* reason);
309 static void dumptime_classes_do(class MetaspaceClosure* it);
310 static size_t estimate_size_for_archive();
311 static void write_to_archive(bool is_static_archive = true);
312 static void adjust_lambda_proxy_class_dictionary();
313
314 static void serialize_dictionary_headers(class SerializeClosure* soc,
315 bool is_static_archive = true);
316 static void serialize_vm_classes(class SerializeClosure* soc);
317 static void print() { return print_on(tty); }
318 static void print_on(outputStream* st) NOT_CDS_RETURN;
319 static void print_shared_archive(outputStream* st, bool is_static = true) NOT_CDS_RETURN;
320 static void print_table_statistics(outputStream* st) NOT_CDS_RETURN;
321 static bool is_dumptime_table_empty() NOT_CDS_RETURN_(true);
322 static bool is_supported_invokedynamic(BootstrapInfo* bsi) NOT_CDS_RETURN_(false);
323 DEBUG_ONLY(static bool class_loading_may_happen() {return _class_loading_may_happen;})
324 // Do not archive any new InstanceKlasses that are loaded after this method is called.
325 // This avoids polluting the archive with classes that are only used by GenerateJLIClassesHelper.
326 static void ignore_new_classes();
327
328 #ifdef ASSERT
329 // This object marks a critical period when writing the CDS archive. During this
330 // period, the JVM must not load any new classes, so as to avoid adding new
331 // items in the SystemDictionaryShared::_dumptime_table.
332 class NoClassLoadingMark: public StackObj {
333 public:
334 NoClassLoadingMark() {
335 assert(_class_loading_may_happen, "must not be nested");
336 _class_loading_may_happen = false;
337 }
338 ~NoClassLoadingMark() {
339 _class_loading_may_happen = true;
340 }
341 };
342 #endif
343
344 template <typename T>
345 static unsigned int hash_for_shared_dictionary_quick(T* ptr) {
346 assert(MetaspaceObj::is_shared((const MetaspaceObj*)ptr), "must be");
347 assert(ptr > (T*)SharedBaseAddress, "must be");
348 uintx offset = uintx(ptr) - uintx(SharedBaseAddress);
349 return primitive_hash<uintx>(offset);
350 }
351
352 static unsigned int hash_for_shared_dictionary(address ptr);
353 static const char* class_loader_name_for_shared(Klass* k);
354 static void create_loader_positive_lookup_cache(TRAPS);
355 };
356
357 #endif // SHARE_CLASSFILE_SYSTEMDICTIONARYSHARED_HPP
|