1 /*
2 * Copyright (c) 2018, 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_CDS_HEAPSHARED_HPP
26 #define SHARE_CDS_HEAPSHARED_HPP
27
28 #include "cds/cds_globals.hpp"
29 #include "cds/dumpTimeClassInfo.hpp"
30 #include "cds/metaspaceShared.hpp"
31 #include "classfile/compactHashtable.hpp"
32 #include "classfile/javaClasses.hpp"
33 #include "gc/shared/gc_globals.hpp"
34 #include "memory/allocation.hpp"
35 #include "memory/allStatic.hpp"
36 #include "oops/compressedOops.hpp"
37 #include "oops/oop.hpp"
38 #include "oops/oopHandle.hpp"
39 #include "oops/oopsHierarchy.hpp"
40 #include "utilities/growableArray.hpp"
41 #include "utilities/resourceHash.hpp"
42
43 #if INCLUDE_CDS_JAVA_HEAP
44 class DumpedInternedStrings;
45 class FileMapInfo;
46 class KlassSubGraphInfo;
47 class MetaspaceObjToOopHandleTable;
48 class ResourceBitMap;
49
50 struct ArchivableStaticFieldInfo;
51 class ArchiveHeapInfo;
52
53 #define ARCHIVED_BOOT_LAYER_CLASS "jdk/internal/module/ArchivedBootLayer"
54 #define ARCHIVED_BOOT_LAYER_FIELD "archivedBootLayer"
55
56 // A dump time sub-graph info for Klass _k. It includes the entry points
57 // (static fields in _k's mirror) of the archived sub-graphs reachable
58 // from _k's mirror. It also contains a list of Klasses of the objects
59 // within the sub-graphs.
60 class KlassSubGraphInfo: public CHeapObj<mtClass> {
61 private:
62 // The class that contains the static field(s) as the entry point(s)
63 // of archived object sub-graph(s).
64 Klass* _k;
65 // A list of classes need to be loaded and initialized before the archived
66 // object sub-graphs can be accessed at runtime.
67 GrowableArray<Klass*>* _subgraph_object_klasses;
68 // A list of _k's static fields as the entry points of archived sub-graphs.
69 // For each entry field, it is a tuple of field_offset, field_value
70 GrowableArray<int>* _subgraph_entry_fields;
71
72 // Does this KlassSubGraphInfo belong to the archived full module graph
73 bool _is_full_module_graph;
74
75 // Does this KlassSubGraphInfo references any classes that were loaded while
76 // JvmtiExport::is_early_phase()!=true. If so, this KlassSubGraphInfo cannot be
77 // used at runtime if JVMTI ClassFileLoadHook is enabled.
78 bool _has_non_early_klasses;
79 static bool is_non_early_klass(Klass* k);
80 static void check_allowed_klass(InstanceKlass* ik);
81 public:
82 KlassSubGraphInfo(Klass* k, bool is_full_module_graph) :
83 _k(k), _subgraph_object_klasses(nullptr),
84 _subgraph_entry_fields(nullptr),
85 _is_full_module_graph(is_full_module_graph),
86 _has_non_early_klasses(false) {}
87
88 ~KlassSubGraphInfo() {
89 if (_subgraph_object_klasses != nullptr) {
90 delete _subgraph_object_klasses;
91 }
92 if (_subgraph_entry_fields != nullptr) {
93 delete _subgraph_entry_fields;
94 }
95 };
96
97 Klass* klass() { return _k; }
98 GrowableArray<Klass*>* subgraph_object_klasses() {
99 return _subgraph_object_klasses;
100 }
101 GrowableArray<int>* subgraph_entry_fields() {
102 return _subgraph_entry_fields;
103 }
104 void add_subgraph_entry_field(int static_field_offset, oop v);
105 void add_subgraph_object_klass(Klass *orig_k);
106 int num_subgraph_object_klasses() {
107 return _subgraph_object_klasses == nullptr ? 0 :
108 _subgraph_object_klasses->length();
109 }
110 bool is_full_module_graph() const { return _is_full_module_graph; }
111 bool has_non_early_klasses() const { return _has_non_early_klasses; }
112 };
113
114 // An archived record of object sub-graphs reachable from static
115 // fields within _k's mirror. The record is reloaded from the archive
116 // at runtime.
117 class ArchivedKlassSubGraphInfoRecord {
118 private:
119 Klass* _k;
120 bool _is_full_module_graph;
121 bool _has_non_early_klasses;
122
123 // contains pairs of field offset and value for each subgraph entry field
124 Array<int>* _entry_field_records;
125
126 // klasses of objects in archived sub-graphs referenced from the entry points
127 // (static fields) in the containing class
128 Array<Klass*>* _subgraph_object_klasses;
129 public:
130 ArchivedKlassSubGraphInfoRecord() :
131 _k(nullptr), _entry_field_records(nullptr), _subgraph_object_klasses(nullptr) {}
132 void init(KlassSubGraphInfo* info);
133 Klass* klass() const { return _k; }
134 Array<int>* entry_field_records() const { return _entry_field_records; }
135 Array<Klass*>* subgraph_object_klasses() const { return _subgraph_object_klasses; }
136 bool is_full_module_graph() const { return _is_full_module_graph; }
137 bool has_non_early_klasses() const { return _has_non_early_klasses; }
138 };
139 #endif // INCLUDE_CDS_JAVA_HEAP
140
141 struct LoadedArchiveHeapRegion;
142
143 class HeapShared: AllStatic {
144 friend class VerifySharedOopClosure;
145
146 public:
147 // Can this VM write a heap region into the CDS archive? Currently only G1+compressed{oops,cp}
148 static bool can_write() {
149 CDS_JAVA_HEAP_ONLY(
150 if (_disable_writing) {
151 return false;
152 }
153 return (UseG1GC && UseCompressedClassPointers);
154 )
155 NOT_CDS_JAVA_HEAP(return false;)
156 }
157
158 static void disable_writing() {
159 CDS_JAVA_HEAP_ONLY(_disable_writing = true;)
160 }
161
162 static bool is_subgraph_root_class(InstanceKlass* ik);
163
164 // Scratch objects for archiving Klass::java_mirror()
165 static oop scratch_java_mirror(BasicType t) NOT_CDS_JAVA_HEAP_RETURN_(nullptr);
166 static oop scratch_java_mirror(Klass* k) NOT_CDS_JAVA_HEAP_RETURN_(nullptr);
167 static oop scratch_java_mirror(oop java_mirror) NOT_CDS_JAVA_HEAP_RETURN_(nullptr);
168 static bool is_archived_boot_layer_available(JavaThread* current) NOT_CDS_JAVA_HEAP_RETURN_(false);
169
170 private:
171 #if INCLUDE_CDS_JAVA_HEAP
172 static bool _disable_writing;
173 static DumpedInternedStrings *_dumped_interned_strings;
174
175 // statistics
176 constexpr static int ALLOC_STAT_SLOTS = 16;
177 static size_t _alloc_count[ALLOC_STAT_SLOTS];
178 static size_t _alloc_size[ALLOC_STAT_SLOTS];
179 static size_t _total_obj_count;
180 static size_t _total_obj_size; // in HeapWords
181
182 static void count_allocation(size_t size);
183 static void print_stats();
184 public:
185 static unsigned oop_hash(oop const& p);
186 static unsigned string_oop_hash(oop const& string) {
187 return java_lang_String::hash_code(string);
188 }
189
190 class CopyKlassSubGraphInfoToArchive;
191
192 class CachedOopInfo {
193 // Used by CDSHeapVerifier.
194 oop _orig_referrer;
195
196 // The location of this object inside ArchiveHeapWriter::_buffer
197 size_t _buffer_offset;
198
199 // One or more fields in this object are pointing to non-null oops.
200 bool _has_oop_pointers;
201
202 // One or more fields in this object are pointing to MetaspaceObj
203 bool _has_native_pointers;
204 public:
205 CachedOopInfo(oop orig_referrer, bool has_oop_pointers)
206 : _orig_referrer(orig_referrer),
207 _buffer_offset(0),
208 _has_oop_pointers(has_oop_pointers),
209 _has_native_pointers(false) {}
210 oop orig_referrer() const { return _orig_referrer; }
211 void set_buffer_offset(size_t offset) { _buffer_offset = offset; }
212 size_t buffer_offset() const { return _buffer_offset; }
213 bool has_oop_pointers() const { return _has_oop_pointers; }
214 bool has_native_pointers() const { return _has_native_pointers; }
215 void set_has_native_pointers() { _has_native_pointers = true; }
216 };
217
218 private:
219 static void check_enum_obj(int level, KlassSubGraphInfo* subgraph_info,
220 oop orig_obj);
221
222 static const int INITIAL_TABLE_SIZE = 15889; // prime number
223 static const int MAX_TABLE_SIZE = 1000000;
224 typedef ResizeableResourceHashtable<oop, CachedOopInfo,
225 AnyObj::C_HEAP,
226 mtClassShared,
227 HeapShared::oop_hash> ArchivedObjectCache;
228 static ArchivedObjectCache* _archived_object_cache;
229
230 class DumpTimeKlassSubGraphInfoTable
231 : public ResourceHashtable<Klass*, KlassSubGraphInfo,
232 137, // prime number
233 AnyObj::C_HEAP,
234 mtClassShared,
235 DumpTimeSharedClassTable_hash> {
236 public:
237 int _count;
238 };
239
240 public: // solaris compiler wants this for RunTimeKlassSubGraphInfoTable
241 inline static bool record_equals_compact_hashtable_entry(
242 const ArchivedKlassSubGraphInfoRecord* value, const Klass* key, int len_unused) {
243 return (value->klass() == key);
244 }
245
246 private:
247 typedef OffsetCompactHashtable<
248 const Klass*,
249 const ArchivedKlassSubGraphInfoRecord*,
250 record_equals_compact_hashtable_entry
251 > RunTimeKlassSubGraphInfoTable;
252
253 static DumpTimeKlassSubGraphInfoTable* _dump_time_subgraph_info_table;
254 static RunTimeKlassSubGraphInfoTable _run_time_subgraph_info_table;
255
256 static CachedOopInfo make_cached_oop_info(oop obj);
257 static ArchivedKlassSubGraphInfoRecord* archive_subgraph_info(KlassSubGraphInfo* info);
258 static void archive_object_subgraphs(ArchivableStaticFieldInfo fields[],
259 bool is_full_module_graph);
260
261 // Archive object sub-graph starting from the given static field
262 // in Klass k's mirror.
263 static void archive_reachable_objects_from_static_field(
264 InstanceKlass* k, const char* klass_name,
265 int field_offset, const char* field_name);
266
267 static void verify_subgraph_from_static_field(
268 InstanceKlass* k, int field_offset) PRODUCT_RETURN;
269 static void verify_reachable_objects_from(oop obj) PRODUCT_RETURN;
270 static void verify_subgraph_from(oop orig_obj) PRODUCT_RETURN;
271 static void check_default_subgraph_classes();
272
273 static KlassSubGraphInfo* init_subgraph_info(Klass *k, bool is_full_module_graph);
274 static KlassSubGraphInfo* get_subgraph_info(Klass *k);
275
276 static void init_subgraph_entry_fields(TRAPS) NOT_CDS_JAVA_HEAP_RETURN;
277 static void init_subgraph_entry_fields(ArchivableStaticFieldInfo fields[], TRAPS);
278
279 // UseCompressedOops only: Used by decode_from_archive
280 static address _narrow_oop_base;
281 static int _narrow_oop_shift;
282
283 // !UseCompressedOops only: used to relocate pointers to the archived objects
284 static ptrdiff_t _runtime_delta;
285
286 typedef ResizeableResourceHashtable<oop, bool,
287 AnyObj::C_HEAP,
288 mtClassShared,
289 HeapShared::oop_hash> SeenObjectsTable;
290
291 static SeenObjectsTable *_seen_objects_table;
292
293 // The "default subgraph" is the root of all archived objects that do not belong to any
294 // of the classes defined in the <xxx>_archive_subgraph_entry_fields[] arrays:
295 // - interned strings
296 // - Klass::java_mirror()
297 // - ConstantPool::resolved_references()
298 static KlassSubGraphInfo* _default_subgraph_info;
299 static ArchivedKlassSubGraphInfoRecord* _runtime_default_subgraph_info;
300
301 static GrowableArrayCHeap<oop, mtClassShared>* _pending_roots;
302 static GrowableArrayCHeap<oop, mtClassShared>* _trace; // for debugging unarchivable objects
303 static GrowableArrayCHeap<const char*, mtClassShared>* _context; // for debugging unarchivable objects
304 static OopHandle _roots;
305 static int _permobj_segments;
306 static OopHandle _scratch_basic_type_mirrors[T_VOID+1];
307 static MetaspaceObjToOopHandleTable* _scratch_java_mirror_table;
308 static MetaspaceObjToOopHandleTable* _scratch_references_table;
309
310 static void init_seen_objects_table() {
311 assert(_seen_objects_table == nullptr, "must be");
312 _seen_objects_table = new (mtClass)SeenObjectsTable(INITIAL_TABLE_SIZE, MAX_TABLE_SIZE);
313 }
314 static void delete_seen_objects_table() {
315 assert(_seen_objects_table != nullptr, "must be");
316 delete _seen_objects_table;
317 _seen_objects_table = nullptr;
318 }
319
320 class ArchivingObjectMark;
321 class ContextMark;
322
323 // Statistics (for one round of start_recording_subgraph ... done_recording_subgraph)
324 static int _num_new_walked_objs;
325 static int _num_new_archived_objs;
326 static int _num_old_recorded_klasses;
327
328 // Statistics (for all archived subgraphs)
329 static int _num_total_subgraph_recordings;
330 static int _num_total_walked_objs;
331 static int _num_total_archived_objs;
332 static int _num_total_recorded_klasses;
333 static int _num_total_verifications;
334
335 static void start_recording_subgraph(InstanceKlass *k, const char* klass_name,
336 bool is_full_module_graph);
337 static void done_recording_subgraph(InstanceKlass *k, const char* klass_name);
338
339 static bool has_been_seen_during_subgraph_recording(oop obj);
340 static void set_has_been_seen_during_subgraph_recording(oop obj);
341 static bool archive_object(oop obj);
342 static void copy_preinitialized_mirror(Klass* orig_k, oop orig_mirror, oop m);
343 static void copy_interned_strings();
344
345 static void resolve_classes_for_subgraphs(JavaThread* current, ArchivableStaticFieldInfo fields[]);
346 static void resolve_classes_for_subgraph_of(JavaThread* current, Klass* k);
347 static void clear_archived_roots_of(Klass* k);
348 static const ArchivedKlassSubGraphInfoRecord*
349 resolve_or_init_classes_for_subgraph_of(Klass* k, bool do_init, TRAPS);
350 static void resolve_or_init(const char* klass_name, bool do_init, TRAPS);
351 static void resolve_or_init(Klass* k, bool do_init, TRAPS);
352 static void init_archived_fields_for(Klass* k, const ArchivedKlassSubGraphInfoRecord* record);
353
354 static int init_loaded_regions(FileMapInfo* mapinfo, LoadedArchiveHeapRegion* loaded_regions,
355 MemRegion& archive_space);
356 static void sort_loaded_regions(LoadedArchiveHeapRegion* loaded_regions, int num_loaded_regions,
357 uintptr_t buffer);
358 static bool load_regions(FileMapInfo* mapinfo, LoadedArchiveHeapRegion* loaded_regions,
359 int num_loaded_regions, uintptr_t buffer);
360 static void init_loaded_heap_relocation(LoadedArchiveHeapRegion* reloc_info,
361 int num_loaded_regions);
362 static void fill_failed_loaded_region();
363 static void mark_native_pointers(oop orig_obj);
364 static bool has_been_archived(oop orig_obj);
365 static bool can_mirror_be_used_in_subgraph(oop orig_java_mirror);
366 static void archive_java_mirrors();
367 static void archive_strings();
368 static void exit_on_error();
369 public:
370 static void reset_archived_object_states(TRAPS);
371 static void create_archived_object_cache() {
372 _archived_object_cache =
373 new (mtClass)ArchivedObjectCache(INITIAL_TABLE_SIZE, MAX_TABLE_SIZE);
374 }
375 static void destroy_archived_object_cache() {
376 delete _archived_object_cache;
377 _archived_object_cache = nullptr;
378 }
379 static ArchivedObjectCache* archived_object_cache() {
380 return _archived_object_cache;
381 }
382
383 static int archive_exception_instance(oop exception);
384 static void archive_objects(ArchiveHeapInfo* heap_info);
385 static void copy_objects();
386 static void copy_special_objects();
387
388 static bool archive_reachable_objects_from(int level,
389 KlassSubGraphInfo* subgraph_info,
390 oop orig_obj);
391
392 static ResourceBitMap calculate_oopmap(MemRegion region); // marks all the oop pointers
393 static void add_to_dumped_interned_strings(oop string);
394
395 static void track_scratch_object(oop orig_obj, oop scratch_obj);
396
397 // Scratch objects for archiving Klass::java_mirror()
398 static void set_scratch_java_mirror(Klass* k, oop mirror);
399 static void remove_scratch_objects(Klass* k);
400 static void get_pointer_info(oop src_obj, bool& has_oop_pointers, bool& has_native_pointers);
401 static void set_has_native_pointers(oop src_obj);
402
403 // We use the HeapShared::roots() array to make sure that objects stored in the
404 // archived heap region are not prematurely collected. These roots include:
405 //
406 // - mirrors of classes that have not yet been loaded.
407 // - ConstantPool::resolved_references() of classes that have not yet been loaded.
408 // - ArchivedKlassSubGraphInfoRecords that have not been initialized
409 // - java.lang.Module objects that have not yet been added to the module graph
410 //
411 // When a mirror M becomes referenced by a newly loaded class K, M will be removed
412 // from HeapShared::roots() via clear_root(), and K will be responsible for
413 // keeping M alive.
414 //
415 // Other types of roots are also cleared similarly when they become referenced.
416
417 // Dump-time only. Returns the index of the root, which can be used at run time to read
418 // the root using get_root(index, ...).
419 static int append_root(oop obj);
420 static GrowableArrayCHeap<oop, mtClassShared>* pending_roots() { return _pending_roots; }
421
422 // Dump-time and runtime
423 static objArrayOop roots();
424 static oop get_root(int index, bool clear=false);
425
426 // Run-time only
427 static void clear_root(int index);
428 static void set_permobj_segments(int n) { _permobj_segments = n; }
429 static void setup_test_class(const char* test_class_name) PRODUCT_RETURN;
430 #endif // INCLUDE_CDS_JAVA_HEAP
431
432 public:
433 static oop orig_to_scratch_object(oop orig_obj);
434 static objArrayOop scratch_resolved_references(ConstantPool* src);
435 static void add_scratch_resolved_references(ConstantPool* src, objArrayOop dest) NOT_CDS_JAVA_HEAP_RETURN;
436 static void init_scratch_objects(TRAPS) NOT_CDS_JAVA_HEAP_RETURN;
437 static void init_box_classes(TRAPS) NOT_CDS_JAVA_HEAP_RETURN;
438 static bool is_heap_region(int idx) {
439 CDS_JAVA_HEAP_ONLY(return (idx == MetaspaceShared::hp);)
440 NOT_CDS_JAVA_HEAP_RETURN_(false);
441 }
442
443 static void resolve_classes(JavaThread* current) NOT_CDS_JAVA_HEAP_RETURN;
444 static void initialize_from_archived_subgraph(JavaThread* current, Klass* k) NOT_CDS_JAVA_HEAP_RETURN;
445
446 static void init_for_dumping(TRAPS) NOT_CDS_JAVA_HEAP_RETURN;
447 static void write_subgraph_info_table() NOT_CDS_JAVA_HEAP_RETURN;
448 static void serialize_misc_info(SerializeClosure* soc) NOT_CDS_JAVA_HEAP_RETURN;
449 static void init_roots(oop roots_oop) NOT_CDS_JAVA_HEAP_RETURN;
450 static void serialize_tables(SerializeClosure* soc) NOT_CDS_JAVA_HEAP_RETURN;
451
452 static bool is_a_test_class_in_unnamed_module(Klass* ik) NOT_CDS_JAVA_HEAP_RETURN_(false);
453
454 static void add_to_permanent_index_table(oop obj, int index);
455 // AOT-compile time only: get a stable index for an archived object.
456 // Returns 0 if obj is not archived.
457 static int get_archived_object_permanent_index(oop obj) NOT_CDS_JAVA_HEAP_RETURN_(-1);
458 // Runtime only: get back the same object for an index returned by
459 // get_archived_object_permanent_index().
460 static oop get_archived_object(int permanent_index) NOT_CDS_JAVA_HEAP_RETURN_(nullptr);
461
462 static void initialize_java_lang_invoke(TRAPS) NOT_CDS_JAVA_HEAP_RETURN;
463 static void initialize_default_subgraph_classes(Handle loader, TRAPS) NOT_CDS_JAVA_HEAP_RETURN;
464
465 static bool is_lambda_form_klass(InstanceKlass* ik) NOT_CDS_JAVA_HEAP_RETURN_(false);
466 static bool is_lambda_proxy_klass(InstanceKlass* ik) NOT_CDS_JAVA_HEAP_RETURN_(false);
467 static bool is_archivable_hidden_klass(InstanceKlass* ik) NOT_CDS_JAVA_HEAP_RETURN_(false);
468 };
469
470 #if INCLUDE_CDS_JAVA_HEAP
471 class DumpedInternedStrings :
472 public ResizeableResourceHashtable<oop, bool,
473 AnyObj::C_HEAP,
474 mtClassShared,
475 HeapShared::string_oop_hash>
476 {
477 public:
478 DumpedInternedStrings(unsigned size, unsigned max_size) :
479 ResizeableResourceHashtable<oop, bool,
480 AnyObj::C_HEAP,
481 mtClassShared,
482 HeapShared::string_oop_hash>(size, max_size) {}
483 };
484 #endif
485
486 #endif // SHARE_CDS_HEAPSHARED_HPP