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