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