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