1 /*
2 * Copyright (c) 2012, 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 #ifndef SHARE_CDS_AOTMETASPACE_HPP
26 #define SHARE_CDS_AOTMETASPACE_HPP
27
28 #include "memory/allocation.hpp"
29 #include "memory/memRegion.hpp"
30 #include "memory/reservedSpace.hpp"
31 #include "memory/virtualspace.hpp"
32 #include "oops/oop.hpp"
33 #include "utilities/macros.hpp"
34
35 class ArchiveBuilder;
36 class ArchiveHeapInfo;
37 class FileMapInfo;
38 class Method;
39 class outputStream;
40 class SerializeClosure;
41 class StaticArchiveBuilder;
42
43 template<class E> class Array;
44
45 enum MapArchiveResult {
46 MAP_ARCHIVE_SUCCESS,
47 MAP_ARCHIVE_MMAP_FAILURE,
48 MAP_ARCHIVE_OTHER_FAILURE
49 };
50
51 class StaticArchiveBuilder;
52
53 // Class Data Sharing Support
54 class AOTMetaspace : AllStatic {
55 static ReservedSpace _symbol_rs; // used only during -Xshare:dump
56 static VirtualSpace _symbol_vs; // used only during -Xshare:dump
57 static bool _archive_loading_failed;
58 static bool _remapped_readwrite;
59 static void* _aot_metaspace_static_top;
60 static intx _relocation_delta;
61 static char* _requested_base_address;
62 static bool _use_optimized_module_handling;
63 static Array<Method*>* _archived_method_handle_intrinsics;
64 static int volatile _preimage_static_archive_dumped;
65 static jlong _preimage_static_archive_recording_duration;
66
67 public:
68 enum {
69 // core archive spaces
70 rw = 0, // read-write
71 ro = 1, // read-only
72 bm = 2, // relocation bitmaps (freed after file mapping is finished)
73 hp = 3, // heap region
74 ac = 4, // aot code
75 num_core_region = 2, // rw and ro
76 n_regions = 5 // total number of regions
77 };
78
79 static void preload_and_dump(TRAPS) NOT_CDS_RETURN;
80 #ifdef _LP64
81 static void adjust_heap_sizes_for_dumping() NOT_CDS_JAVA_HEAP_RETURN;
82 #endif
83
84 private:
85 static void exercise_runtime_cds_code(TRAPS) NOT_CDS_RETURN;
86 static void preload_and_dump_impl(StaticArchiveBuilder& builder, TRAPS) NOT_CDS_RETURN;
87 static void preload_classes(TRAPS) NOT_CDS_RETURN;
88
89 public:
90 static Symbol* symbol_rs_base() {
91 return (Symbol*)_symbol_rs.base();
92 }
93
94 static void initialize_for_static_dump() NOT_CDS_RETURN;
95 static void open_static_archive() NOT_CDS_RETURN;
96 static void initialize_runtime_shared_and_meta_spaces() NOT_CDS_RETURN;
97 static void post_initialize(TRAPS) NOT_CDS_RETURN;
98
99 static void print_on(outputStream* st);
100
101 static void set_archive_loading_failed() {
102 _archive_loading_failed = true;
103 }
104
105 static void initialize_shared_spaces() NOT_CDS_RETURN;
106
107 // Return true if given address is in the shared metaspace regions (i.e., excluding the
108 // mapped heap region.)
109 static bool in_aot_cache(const void* p) {
110 return MetaspaceObj::in_aot_cache((const MetaspaceObj*)p);
111 }
112
113 static void set_aot_metaspace_range(void* base, void *static_top, void* top) NOT_CDS_RETURN;
114
115 // inside the metaspace of the AOT cache, or the static CDS archive
116 static bool in_aot_cache_static_region(void* p) NOT_CDS_RETURN_(false);
117
118 // inside the metaspace of the dynamic static CDS archive
119 static bool in_aot_cache_dynamic_region(void* p) NOT_CDS_RETURN_(false);
120
121 static bool is_recording_preimage_static_archive() NOT_CDS_RETURN_(false);
122 static jlong get_preimage_static_archive_recording_duration() NOT_CDS_RETURN_(0);
123
124 static void unrecoverable_loading_error(const char* message = "unrecoverable error");
125 static void report_loading_error(const char* format, ...) ATTRIBUTE_PRINTF(1, 0);
126 static void unrecoverable_writing_error(const char* message = nullptr);
127 static void writing_error(const char* message = nullptr);
128
129 static void make_method_handle_intrinsics_shareable() NOT_CDS_RETURN;
130 static void write_method_handle_intrinsics() NOT_CDS_RETURN;
131 static Array<Method*>* archived_method_handle_intrinsics() { return _archived_method_handle_intrinsics; }
132 static void early_serialize(SerializeClosure* sc) NOT_CDS_RETURN;
133 static void serialize(SerializeClosure* sc) NOT_CDS_RETURN;
134
135 // JVM/TI RedefineClasses() support:
136 // Remap the shared readonly space to shared readwrite, private if
137 // sharing is enabled. Simply returns true if sharing is not enabled
138 // or if the remapping has already been done by a prior call.
139 static bool remap_shared_readonly_as_readwrite() NOT_CDS_RETURN_(true);
140 static bool remapped_readwrite() {
141 CDS_ONLY(return _remapped_readwrite);
142 NOT_CDS(return false);
143 }
144
145 static bool try_link_class(JavaThread* current, InstanceKlass* ik);
146 static void link_shared_classes(TRAPS) NOT_CDS_RETURN;
147 static bool may_be_eagerly_linked(InstanceKlass* ik) NOT_CDS_RETURN_(false);
148
149 #if INCLUDE_CDS
150 // Alignment for the 2 core CDS regions (RW/RO) only.
151 // (Heap region alignments are decided by GC).
152 static size_t core_region_alignment();
153 static size_t protection_zone_size();
154 static void rewrite_nofast_bytecodes_and_calculate_fingerprints(Thread* thread, InstanceKlass* ik);
155 // print loaded classes names to file.
156 static void dump_loaded_classes(const char* file_name, TRAPS);
157 #endif
158
159 // Allocate a block of memory from the temporary "symbol" region.
160 static char* symbol_space_alloc(size_t num_bytes);
161
162 // This is the base address as specified by -XX:SharedBaseAddress during -Xshare:dump.
163 // Both the base/top archives are written using this as their base address.
164 //
165 // During static dump: _requested_base_address == SharedBaseAddress.
166 //
167 // During dynamic dump: _requested_base_address is not always the same as SharedBaseAddress:
168 // - SharedBaseAddress is used for *reading the base archive*. I.e., CompactHashtable uses
169 // it to convert offsets to pointers to Symbols in the base archive.
170 // The base archive may be mapped to an OS-selected address due to ASLR. E.g.,
171 // you may have SharedBaseAddress == 0x00ff123400000000.
172 // - _requested_base_address is used for *writing the output archive*. It's usually
173 // 0x800000000 (unless it was set by -XX:SharedBaseAddress during -Xshare:dump).
174 static char* requested_base_address() {
175 return _requested_base_address;
176 }
177
178 // Non-zero if the archive(s) need to be mapped a non-default location due to ASLR.
179 static intx relocation_delta() { return _relocation_delta; }
180
181 static bool use_windows_memory_mapping() {
182 const bool is_windows = (NOT_WINDOWS(false) WINDOWS_ONLY(true));
183 //const bool is_windows = true; // enable this to allow testing the windows mmap semantics on Linux, etc.
184 return is_windows;
185 }
186
187 // Can we skip some expensive operations related to modules?
188 static bool use_optimized_module_handling() { return NOT_CDS(false) CDS_ONLY(_use_optimized_module_handling); }
189 static void disable_optimized_module_handling() { _use_optimized_module_handling = false; }
190
191 private:
192 static void read_extra_data(JavaThread* current, const char* filename) NOT_CDS_RETURN;
193 static void fork_and_dump_final_static_archive(TRAPS);
194 static bool write_static_archive(ArchiveBuilder* builder, FileMapInfo* map_info, ArchiveHeapInfo* heap_info);
195 static FileMapInfo* open_dynamic_archive();
196 // use_requested_addr: If true (default), attempt to map at the address the
197 static MapArchiveResult map_archives(FileMapInfo* static_mapinfo, FileMapInfo* dynamic_mapinfo,
198 bool use_requested_addr);
199 static char* reserve_address_space_for_archives(FileMapInfo* static_mapinfo,
200 FileMapInfo* dynamic_mapinfo,
201 bool use_archive_base_addr,
202 ReservedSpace& total_space_rs,
203 ReservedSpace& archive_space_rs,
204 ReservedSpace& class_space_rs);
205 static void release_reserved_spaces(ReservedSpace& total_space_rs,
206 ReservedSpace& archive_space_rs,
207 ReservedSpace& class_space_rs);
208 static MapArchiveResult map_archive(FileMapInfo* mapinfo, char* mapped_base_address, ReservedSpace rs);
209 static void unmap_archive(FileMapInfo* mapinfo);
210 static void get_default_classlist(char* default_classlist, const size_t buf_size);
211 };
212 #endif // SHARE_CDS_AOTMETASPACE_HPP