1 /*
2 * Copyright (c) 2023, 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_CDSCONFIG_HPP
26 #define SHARE_CDS_CDSCONFIG_HPP
27
28 #include "memory/allStatic.hpp"
29 #include "utilities/globalDefinitions.hpp"
30 #include "utilities/macros.hpp"
31
32 class JavaThread;
33
34 class CDSConfig : public AllStatic {
35 #if INCLUDE_CDS
36 static bool _is_dumping_static_archive;
37 static bool _is_dumping_preimage_static_archive;
38 static bool _is_dumping_final_static_archive;
39 static bool _is_dumping_dynamic_archive;
40 static bool _is_using_optimized_module_handling;
41 static bool _is_dumping_full_module_graph;
42 static bool _is_using_full_module_graph;
43 static bool _has_aot_linked_classes;
44
45 static bool _module_patching_disables_cds;
46 static bool _java_base_module_patching_disables_cds;
47
48 static char* _default_archive_path;
49 static char* _static_archive_path;
50 static char* _dynamic_archive_path;
51
52 static bool _old_cds_flags_used;
53 static bool _new_aot_flags_used;
54 static bool _disable_heap_dumping;
55
56 static JavaThread* _dumper_thread;
57 #endif
58
59 static void extract_shared_archive_paths(const char* archive_path,
60 char** base_archive_path,
61 char** top_archive_path);
62 static void init_shared_archive_paths();
63
64 static void check_flag_alias(bool alias_is_default, const char* alias_name);
65 static void check_aot_flags();
66 static void check_aotmode_off();
67 static void check_aotmode_auto_or_on();
68 static void check_aotmode_record();
69 static void check_aotmode_create();
70
71 public:
72 // Used by jdk.internal.misc.CDS.getCDSConfigStatus();
73 static const int IS_DUMPING_ARCHIVE = 1 << 0;
74 static const int IS_DUMPING_METHOD_HANDLES = 1 << 1;
75 static const int IS_DUMPING_STATIC_ARCHIVE = 1 << 2;
76 static const int IS_LOGGING_LAMBDA_FORM_INVOKERS = 1 << 3;
77 static const int IS_USING_ARCHIVE = 1 << 4;
78
79 static int get_status() NOT_CDS_RETURN_(0);
80
81 // Initialization and command-line checking
82 static void initialize() NOT_CDS_RETURN;
83 static void set_old_cds_flags_used() { CDS_ONLY(_old_cds_flags_used = true); }
84 static bool old_cds_flags_used() { return CDS_ONLY(_old_cds_flags_used) NOT_CDS(false); }
85 static bool new_aot_flags_used() { return CDS_ONLY(_new_aot_flags_used) NOT_CDS(false); }
86 static void check_internal_module_property(const char* key, const char* value) NOT_CDS_RETURN;
87 static void check_incompatible_property(const char* key, const char* value) NOT_CDS_RETURN;
88 static void check_unsupported_dumping_module_options() NOT_CDS_RETURN;
89 static bool has_unsupported_runtime_module_options() NOT_CDS_RETURN_(false);
90 static bool check_vm_args_consistency(bool mode_flag_cmd_line) NOT_CDS_RETURN_(true);
91
92 static bool module_patching_disables_cds() { return _module_patching_disables_cds; }
93 static void set_module_patching_disables_cds() { _module_patching_disables_cds = true; }
94 static bool java_base_module_patching_disables_cds() { return _java_base_module_patching_disables_cds; }
95 static void set_java_base_module_patching_disables_cds() { _java_base_module_patching_disables_cds = true; }
96 static const char* type_of_archive_being_loaded();
97 static const char* type_of_archive_being_written();
98
99 // --- Basic CDS features
100
101 // archive(s) in general
102 static bool is_dumping_archive() { return is_dumping_static_archive() || is_dumping_dynamic_archive(); }
103 static bool is_using_archive() NOT_CDS_RETURN_(false);
104 static int num_archives(const char* archive_path) NOT_CDS_RETURN_(0);
105
106 // static_archive
107 static bool is_dumping_static_archive() { return CDS_ONLY(_is_dumping_static_archive) NOT_CDS(false); }
108 static void enable_dumping_static_archive() { CDS_ONLY(_is_dumping_static_archive = true); }
109
110 // A static CDS archive can be dumped in three modes:
111 //
112 // "classic" - This is the traditional CDS workflow of
113 // "java -Xshare:dump -XX:SharedClassListFile=file.txt".
114 //
115 // "preimage" - This happens when we execute the JEP 483 training run, e.g:
116 // "java -XX:AOTMode=record -XX:AOTConfiguration=app.aotconfig -cp app.jar App"
117 // The above command writes app.aotconfig as a "CDS preimage". This
118 // is a binary file that contains all the classes loaded during the
119 // training run, plus profiling data (e.g., the resolved constant pool entries).
120 //
121 // "final" - This happens when we execute the JEP 483 assembly phase, e.g:
122 // "java -XX:AOTMode=create -XX:AOTConfiguration=app.aotconfig -XX:AOTCache=app.aot -cp app.jar"
123 // The above command loads all classes from app.aotconfig, perform additional linking,
124 // and writes app.aot as a "CDS final image" file.
125 //
126 // The main structural difference between "preimage" and "final" is that the preimage
127 // - has a different magic number (0xcafea07c)
128 // - does not have any archived Java heap objects
129 // - does not have aot-linked classes
130 static bool is_dumping_classic_static_archive() NOT_CDS_RETURN_(false);
131 static bool is_dumping_preimage_static_archive() NOT_CDS_RETURN_(false);
132 static bool is_dumping_final_static_archive() NOT_CDS_RETURN_(false);
133
134 // dynamic_archive
135 static bool is_dumping_dynamic_archive() { return CDS_ONLY(_is_dumping_dynamic_archive) NOT_CDS(false); }
136 static void enable_dumping_dynamic_archive() { CDS_ONLY(_is_dumping_dynamic_archive = true); }
137 static void disable_dumping_dynamic_archive() { CDS_ONLY(_is_dumping_dynamic_archive = false); }
138
139 // Misc CDS features
140 static bool allow_only_single_java_thread() NOT_CDS_RETURN_(false);
141
142 // This is *Legacy* optimization for lambdas before JEP 483. May be removed in the future.
143 static bool is_dumping_lambdas_in_legacy_mode() NOT_CDS_RETURN_(false);
144
145 // optimized_module_handling -- can we skip some expensive operations related to modules?
146 static bool is_using_optimized_module_handling() { return CDS_ONLY(_is_using_optimized_module_handling) NOT_CDS(false); }
147 static void stop_using_optimized_module_handling() NOT_CDS_RETURN;
148
149 static bool is_logging_lambda_form_invokers() NOT_CDS_RETURN_(false);
150
151 static bool is_dumping_aot_linked_classes() NOT_CDS_JAVA_HEAP_RETURN_(false);
152 static bool is_using_aot_linked_classes() NOT_CDS_JAVA_HEAP_RETURN_(false);
153 static void set_has_aot_linked_classes(bool has_aot_linked_classes) NOT_CDS_JAVA_HEAP_RETURN;
154
155 // archive_path
156
157 // Points to the classes.jsa in $JAVA_HOME
158 static char* default_archive_path() NOT_CDS_RETURN_(nullptr);
159 // The actual static archive (if any) selected at runtime
160 static const char* static_archive_path() { return CDS_ONLY(_static_archive_path) NOT_CDS(nullptr); }
161 // The actual dynamic archive (if any) selected at runtime
162 static const char* dynamic_archive_path() { return CDS_ONLY(_dynamic_archive_path) NOT_CDS(nullptr); }
163
164 // --- Archived java objects
165
166 static bool are_vm_options_incompatible_with_dumping_heap() NOT_CDS_JAVA_HEAP_RETURN_(true);
167 static void log_reasons_for_not_dumping_heap();
168
169 static void disable_heap_dumping() { CDS_ONLY(_disable_heap_dumping = true); }
170 static bool is_dumping_heap() NOT_CDS_JAVA_HEAP_RETURN_(false);
171 static bool is_loading_heap() NOT_CDS_JAVA_HEAP_RETURN_(false);
172 static bool is_initing_classes_at_dump_time() NOT_CDS_JAVA_HEAP_RETURN_(false);
173
174 static bool is_dumping_invokedynamic() NOT_CDS_JAVA_HEAP_RETURN_(false);
175 static bool is_dumping_method_handles() NOT_CDS_JAVA_HEAP_RETURN_(false);
176
177 // full_module_graph (requires optimized_module_handling)
178 static bool is_dumping_full_module_graph() { return CDS_ONLY(_is_dumping_full_module_graph) NOT_CDS(false); }
179 static bool is_using_full_module_graph() NOT_CDS_JAVA_HEAP_RETURN_(false);
180 static void stop_dumping_full_module_graph(const char* reason = nullptr) NOT_CDS_JAVA_HEAP_RETURN;
181 static void stop_using_full_module_graph(const char* reason = nullptr) NOT_CDS_JAVA_HEAP_RETURN;
182
183 static bool is_valhalla_preview();
184
185 // Some CDS functions assume that they are called only within a single-threaded context. I.e.,
186 // they are called from:
187 // - The VM thread (e.g., inside VM_PopulateDumpSharedSpace)
188 // - The thread that performs prepatory steps before switching to the VM thread
189 // Since these two threads never execute concurrently, we can avoid using locks in these CDS
190 // function. For safety, these functions should assert with CDSConfig::current_thread_is_vm_or_dumper().
191 class DumperThreadMark {
192 public:
193 DumperThreadMark(JavaThread* current);
194 ~DumperThreadMark();
195 };
196
197 static bool current_thread_is_vm_or_dumper() NOT_CDS_RETURN_(false);
198 };
199
200 #endif // SHARE_CDS_CDSCONFIG_HPP