1 /*
2 * Copyright (c) 2023, 2026, 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 #include "cds/aotLogging.hpp"
26 #include "cds/aotMapLogger.hpp"
27 #include "cds/cdsConfig.hpp"
28 #include "cds/classListWriter.hpp"
29 #include "cds/filemap.hpp"
30 #include "cds/heapShared.inline.hpp"
31 #include "classfile/classLoaderDataShared.hpp"
32 #include "classfile/moduleEntry.hpp"
33 #include "code/aotCodeCache.hpp"
34 #include "include/jvm_io.h"
35 #include "logging/log.hpp"
36 #include "memory/universe.hpp"
37 #include "prims/jvmtiAgentList.hpp"
38 #include "runtime/arguments.hpp"
39 #include "runtime/globals_extension.hpp"
40 #include "runtime/java.hpp"
41 #include "runtime/vmThread.hpp"
42 #include "utilities/defaultStream.hpp"
43 #include "utilities/formatBuffer.hpp"
44 #include "utilities/globalDefinitions.hpp"
45
46 bool CDSConfig::_is_dumping_static_archive = false;
47 bool CDSConfig::_is_dumping_preimage_static_archive = false;
48 bool CDSConfig::_is_dumping_final_static_archive = false;
49 bool CDSConfig::_is_dumping_dynamic_archive = false;
50 bool CDSConfig::_is_using_optimized_module_handling = true;
51 bool CDSConfig::_is_dumping_full_module_graph = true;
52 bool CDSConfig::_is_using_full_module_graph = true;
53 bool CDSConfig::_has_aot_linked_classes = false;
54 bool CDSConfig::_is_single_command_training = false;
55 bool CDSConfig::_has_temp_aot_config_file = false;
56 bool CDSConfig::_old_cds_flags_used = false;
57 bool CDSConfig::_new_aot_flags_used = false;
58 bool CDSConfig::_disable_heap_dumping = false;
59 bool CDSConfig::_is_at_aot_safepoint = false;
60
61 const char* CDSConfig::_default_archive_path = nullptr;
62 const char* CDSConfig::_input_static_archive_path = nullptr;
63 const char* CDSConfig::_input_dynamic_archive_path = nullptr;
64 const char* CDSConfig::_output_archive_path = nullptr;
65
66 JavaThread* CDSConfig::_dumper_thread = nullptr;
67
68 int CDSConfig::get_status() {
69 assert(Universe::is_fully_initialized(), "status is finalized only after Universe is initialized");
70 return (is_dumping_aot_linked_classes() ? IS_DUMPING_AOT_LINKED_CLASSES : 0) |
71 (is_dumping_archive() ? IS_DUMPING_ARCHIVE : 0) |
72 (is_dumping_method_handles() ? IS_DUMPING_METHOD_HANDLES : 0) |
73 (is_dumping_static_archive() ? IS_DUMPING_STATIC_ARCHIVE : 0) |
74 (is_logging_lambda_form_invokers() ? IS_LOGGING_LAMBDA_FORM_INVOKERS : 0) |
75 (is_using_archive() ? IS_USING_ARCHIVE : 0);
76 }
77
78 DEBUG_ONLY(static bool _cds_ergo_initialize_started = false);
79
80 void CDSConfig::ergo_initialize() {
81 DEBUG_ONLY(_cds_ergo_initialize_started = true);
82
83 if (is_dumping_static_archive() && !is_dumping_final_static_archive()) {
84 // Note: -Xshare and -XX:AOTMode flags are mutually exclusive.
85 // - Classic workflow: -Xshare:on and -Xshare:dump cannot take effect at the same time.
86 // - JEP 483 workflow: -XX:AOTMode:record and -XX:AOTMode=on cannot take effect at the same time.
87 // So we can never come to here with RequireSharedSpaces==true.
88 assert(!RequireSharedSpaces, "sanity");
89
90 // If dumping the classic archive, or making an AOT training run (dumping a preimage archive),
91 // for sanity, parse all classes from classfiles.
92 // TODO: in the future, if we want to support re-training on top of an existing AOT cache, this
93 // needs to be changed.
94 UseSharedSpaces = false;
95 }
96
97 // Initialize shared archive paths which could include both base and dynamic archive paths
98 // This must be after set_ergonomics_flags() called so flag UseCompressedOops is set properly.
99 if (is_dumping_static_archive() || is_using_archive()) {
100 if (new_aot_flags_used()) {
101 ergo_init_aot_paths();
102 } else {
103 ergo_init_classic_archive_paths();
104 }
105 }
106
107 if (!is_dumping_heap()) {
108 _is_dumping_full_module_graph = false;
109 }
110
111 AOTMapLogger::ergo_initialize();
112
113 setup_compiler_args();
114
115 if (is_dumping_full_module_graph()) {
116 precond(allow_only_single_java_thread());
117
118 // The AttachListenerThread may execute Java code or load new classes. It might see
119 // unexpected results after HeapShared::prepare_for_archiving().
120 //
121 // We disable all new incoming attach requests, so you can't use jcmd, etc, on this JVM.
122 // Since we are not running any application code in this JVM and only executed a very
123 // limited set of Java code (for module system init, class loading, indy resolution,
124 // etc), there is usually no need to attach to this JVM.
125 FLAG_SET_ERGO(DisableAttachMechanism, true);
126 }
127
128 if (!AOTMetaspace::shared_base_valid((char*)SharedBaseAddress)) {
129 log_warning(cds)("SharedBaseAddress " PTR_FORMAT " is invalid. Reverting to " PTR_FORMAT,
130 p2i((void*)SharedBaseAddress), p2i((void*)DEFAULT_SHARED_BASE_ADDRESS));
131 FLAG_SET_ERGO(SharedBaseAddress, DEFAULT_SHARED_BASE_ADDRESS);
132 }
133 }
134
135 const char* CDSConfig::default_archive_path() {
136 // The path depends on UseCompressedOops, etc, which are set by GC ergonomics just
137 // before CDSConfig::ergo_initialize() is called.
138 assert(_cds_ergo_initialize_started, "sanity");
139 if (_default_archive_path == nullptr) {
140 stringStream tmp;
141 if (is_vm_statically_linked()) {
142 // It's easier to form the path using JAVA_HOME as os::jvm_path
143 // gives the path to the launcher executable on static JDK.
144 const char* subdir = WINDOWS_ONLY("bin") NOT_WINDOWS("lib");
145 tmp.print("%s%s%s%s%s%sclasses",
146 Arguments::get_java_home(), os::file_separator(),
147 subdir, os::file_separator(),
148 Abstract_VM_Version::vm_variant(), os::file_separator());
149 } else {
150 // Assume .jsa is in the same directory where libjvm resides on
151 // non-static JDK.
152 char jvm_path[JVM_MAXPATHLEN];
153 os::jvm_path(jvm_path, sizeof(jvm_path));
154 char *end = strrchr(jvm_path, *os::file_separator());
155 if (end != nullptr) *end = '\0';
156 tmp.print("%s%sclasses", jvm_path, os::file_separator());
157 }
158 #ifdef _LP64
159 if (!UseCompressedOops) {
160 tmp.print_raw("_nocoops");
161 }
162 if (!UseCompactObjectHeaders) {
163 // Note that generation of xxx_nocoh.jsa variants require
164 // --enable-cds-archive-nocoh at build time
165 tmp.print_raw("_nocoh");
166 }
167 #endif
168 tmp.print_raw(".jsa");
169 _default_archive_path = os::strdup(tmp.base());
170 }
171 return _default_archive_path;
172 }
173
174 int CDSConfig::num_archive_paths(const char* path_spec) {
175 if (path_spec == nullptr) {
176 return 0;
177 }
178 int npaths = 1;
179 char* p = (char*)path_spec;
180 while (*p != '\0') {
181 if (*p == os::path_separator()[0]) {
182 npaths++;
183 }
184 p++;
185 }
186 return npaths;
187 }
188
189 void CDSConfig::extract_archive_paths(const char* archive_path,
190 const char** base_archive_path,
191 const char** top_archive_path) {
192 char* begin_ptr = (char*)archive_path;
193 char* end_ptr = strchr((char*)archive_path, os::path_separator()[0]);
194 if (end_ptr == nullptr || end_ptr == begin_ptr) {
195 vm_exit_during_initialization("Base archive was not specified", archive_path);
196 }
197 size_t len = end_ptr - begin_ptr;
198 char* cur_path = NEW_C_HEAP_ARRAY(char, len + 1, mtInternal);
199 strncpy(cur_path, begin_ptr, len);
200 cur_path[len] = '\0';
201 *base_archive_path = cur_path;
202
203 begin_ptr = ++end_ptr;
204 if (*begin_ptr == '\0') {
205 vm_exit_during_initialization("Top archive was not specified", archive_path);
206 }
207 end_ptr = strchr(begin_ptr, '\0');
208 assert(end_ptr != nullptr, "sanity");
209 len = end_ptr - begin_ptr;
210 cur_path = NEW_C_HEAP_ARRAY(char, len + 1, mtInternal);
211 strncpy(cur_path, begin_ptr, len + 1);
212 *top_archive_path = cur_path;
213 }
214
215 void CDSConfig::ergo_init_classic_archive_paths() {
216 assert(_cds_ergo_initialize_started, "sanity");
217 if (ArchiveClassesAtExit != nullptr) {
218 assert(!RecordDynamicDumpInfo, "already checked");
219 if (is_dumping_static_archive()) {
220 vm_exit_during_initialization("-XX:ArchiveClassesAtExit cannot be used with -Xshare:dump");
221 }
222 check_unsupported_dumping_module_options();
223
224 if (os::same_files(default_archive_path(), ArchiveClassesAtExit)) {
225 vm_exit_during_initialization(
226 "Cannot specify the default CDS archive for -XX:ArchiveClassesAtExit", default_archive_path());
227 }
228 }
229
230 if (SharedArchiveFile == nullptr) {
231 _input_static_archive_path = default_archive_path();
232 if (is_dumping_static_archive()) {
233 _output_archive_path = _input_static_archive_path;
234 }
235 } else {
236 int num_archives = num_archive_paths(SharedArchiveFile);
237 assert(num_archives > 0, "must be");
238
239 if (is_dumping_archive() && num_archives > 1) {
240 vm_exit_during_initialization(
241 "Cannot have more than 1 archive file specified in -XX:SharedArchiveFile during CDS dumping");
242 }
243
244 if (is_dumping_static_archive()) {
245 assert(num_archives == 1, "just checked above");
246 // Static dump is simple: only one archive is allowed in SharedArchiveFile. This file
247 // will be overwritten regardless of its contents
248 _output_archive_path = SharedArchiveFile;
249 } else {
250 // SharedArchiveFile may specify one or two files. In case (c), the path for base.jsa
251 // is read from top.jsa
252 // (a) 1 file: -XX:SharedArchiveFile=base.jsa
253 // (b) 2 files: -XX:SharedArchiveFile=base.jsa:top.jsa
254 // (c) 2 files: -XX:SharedArchiveFile=top.jsa
255 //
256 // However, if either RecordDynamicDumpInfo or ArchiveClassesAtExit is used, we do not
257 // allow cases (b) and (c). Case (b) is already checked above.
258
259 if (num_archives > 2) {
260 vm_exit_during_initialization(
261 "Cannot have more than 2 archive files specified in the -XX:SharedArchiveFile option");
262 }
263
264 if (num_archives == 1) {
265 const char* base_archive_path = nullptr;
266 bool success =
267 FileMapInfo::get_base_archive_name_from_header(SharedArchiveFile, &base_archive_path);
268 if (!success) {
269 // If +AutoCreateSharedArchive and the specified shared archive does not exist,
270 // regenerate the dynamic archive base on default archive.
271 if (AutoCreateSharedArchive && !os::file_exists(SharedArchiveFile)) {
272 enable_dumping_dynamic_archive(SharedArchiveFile);
273 FLAG_SET_ERGO(ArchiveClassesAtExit, SharedArchiveFile);
274 _input_static_archive_path = default_archive_path();
275 FLAG_SET_ERGO(SharedArchiveFile, nullptr);
276 } else {
277 if (AutoCreateSharedArchive) {
278 warning("-XX:+AutoCreateSharedArchive is unsupported when base CDS archive is not loaded. Run with -Xlog:cds for more info.");
279 AutoCreateSharedArchive = false;
280 }
281 aot_log_error(aot)("Not a valid %s (%s)", type_of_archive_being_loaded(), SharedArchiveFile);
282 Arguments::no_shared_spaces("invalid archive");
283 }
284 } else if (base_archive_path == nullptr) {
285 // User has specified a single archive, which is a static archive.
286 _input_static_archive_path = SharedArchiveFile;
287 } else {
288 // User has specified a single archive, which is a dynamic archive.
289 _input_dynamic_archive_path = SharedArchiveFile;
290 _input_static_archive_path = base_archive_path; // has been c-heap allocated.
291 }
292 } else {
293 extract_archive_paths(SharedArchiveFile,
294 &_input_static_archive_path, &_input_dynamic_archive_path);
295 if (_input_static_archive_path == nullptr) {
296 assert(_input_dynamic_archive_path == nullptr, "must be");
297 Arguments::no_shared_spaces("invalid archive");
298 }
299 }
300
301 if (_input_dynamic_archive_path != nullptr) {
302 // Check for case (c)
303 if (RecordDynamicDumpInfo) {
304 vm_exit_during_initialization("-XX:+RecordDynamicDumpInfo is unsupported when a dynamic CDS archive is specified in -XX:SharedArchiveFile",
305 SharedArchiveFile);
306 }
307 if (ArchiveClassesAtExit != nullptr) {
308 vm_exit_during_initialization("-XX:ArchiveClassesAtExit is unsupported when a dynamic CDS archive is specified in -XX:SharedArchiveFile",
309 SharedArchiveFile);
310 }
311 }
312
313 if (ArchiveClassesAtExit != nullptr && os::same_files(SharedArchiveFile, ArchiveClassesAtExit)) {
314 vm_exit_during_initialization(
315 "Cannot have the same archive file specified for -XX:SharedArchiveFile and -XX:ArchiveClassesAtExit",
316 SharedArchiveFile);
317 }
318 }
319 }
320 }
321
322 void CDSConfig::check_internal_module_property(const char* key, const char* value) {
323 if (Arguments::is_incompatible_cds_internal_module_property(key)) {
324 stop_using_optimized_module_handling();
325 aot_log_info(aot)("optimized module handling: disabled due to incompatible property: %s=%s", key, value);
326 }
327 }
328
329 void CDSConfig::check_incompatible_property(const char* key, const char* value) {
330 static const char* incompatible_properties[] = {
331 "java.system.class.loader",
332 "jdk.module.showModuleResolution",
333 "jdk.module.validation"
334 };
335
336 for (const char* property : incompatible_properties) {
337 if (strcmp(key, property) == 0) {
338 stop_dumping_full_module_graph();
339 stop_using_full_module_graph();
340 aot_log_info(aot)("full module graph: disabled due to incompatible property: %s=%s", key, value);
341 break;
342 }
343 }
344
345 }
346
347 // Returns any JVM command-line option, such as "--patch-module", that's not supported by CDS.
348 static const char* find_any_unsupported_module_option() {
349 // Note that arguments.cpp has translated the command-line options into properties. If we find an
350 // unsupported property, translate it back to its command-line option for better error reporting.
351
352 // The following properties are checked by Arguments::is_internal_module_property() and cannot be
353 // directly specified in the command-line.
354 static const char* unsupported_module_properties[] = {
355 "jdk.module.limitmods",
356 "jdk.module.upgrade.path",
357 "jdk.module.patch.0"
358 };
359 static const char* unsupported_module_options[] = {
360 "--limit-modules",
361 "--upgrade-module-path",
362 "--patch-module"
363 };
364
365 assert(ARRAY_SIZE(unsupported_module_properties) == ARRAY_SIZE(unsupported_module_options), "must be");
366 SystemProperty* sp = Arguments::system_properties();
367 while (sp != nullptr) {
368 for (uint i = 0; i < ARRAY_SIZE(unsupported_module_properties); i++) {
369 if (strcmp(sp->key(), unsupported_module_properties[i]) == 0) {
370 return unsupported_module_options[i];
371 }
372 }
373 sp = sp->next();
374 }
375
376 return nullptr; // not found
377 }
378
379 void CDSConfig::check_unsupported_dumping_module_options() {
380 assert(is_dumping_archive(), "this function is only used with CDS dump time");
381 const char* option = find_any_unsupported_module_option();
382 if (option != nullptr) {
383 vm_exit_during_initialization("Cannot use the following option when dumping the shared archive", option);
384 }
385 // Check for an exploded module build in use with -Xshare:dump.
386 if (!Arguments::has_jimage()) {
387 vm_exit_during_initialization("Dumping the shared archive is not supported with an exploded module build");
388 }
389 }
390
391 bool CDSConfig::has_unsupported_runtime_module_options() {
392 assert(is_using_archive(), "this function is only used with -Xshare:{on,auto}");
393 if (ArchiveClassesAtExit != nullptr) {
394 // dynamic dumping, just return false for now.
395 // check_unsupported_dumping_properties() will be called later to check the same set of
396 // properties, and will exit the VM with the correct error message if the unsupported properties
397 // are used.
398 return false;
399 }
400 const char* option = find_any_unsupported_module_option();
401 if (option != nullptr) {
402 if (RequireSharedSpaces) {
403 warning("CDS is disabled when the %s option is specified.", option);
404 } else {
405 if (new_aot_flags_used()) {
406 aot_log_warning(aot)("AOT cache is disabled when the %s option is specified.", option);
407 } else {
408 aot_log_info(aot)("CDS is disabled when the %s option is specified.", option);
409 }
410 }
411 return true;
412 }
413 return false;
414 }
415
416 #define CHECK_NEW_FLAG(f) check_new_flag(FLAG_IS_DEFAULT(f), #f)
417
418 void CDSConfig::check_new_flag(bool new_flag_is_default, const char* new_flag_name) {
419 if (old_cds_flags_used() && !new_flag_is_default) {
420 vm_exit_during_initialization(err_msg("Option %s cannot be used at the same time with "
421 "-Xshare:on, -Xshare:auto, -Xshare:off, -Xshare:dump, "
422 "DumpLoadedClassList, SharedClassListFile, or SharedArchiveFile",
423 new_flag_name));
424 }
425 }
426
427 #define CHECK_SINGLE_PATH(f) check_flag_single_path(#f, f)
428
429 void CDSConfig::check_flag_single_path(const char* flag_name, const char* value) {
430 if (value != nullptr && num_archive_paths(value) != 1) {
431 vm_exit_during_initialization(err_msg("Option %s must specify a single file name", flag_name));
432 }
433 }
434
435 void CDSConfig::check_aot_flags() {
436 if (!FLAG_IS_DEFAULT(DumpLoadedClassList) ||
437 !FLAG_IS_DEFAULT(SharedClassListFile) ||
438 !FLAG_IS_DEFAULT(SharedArchiveFile)) {
439 _old_cds_flags_used = true;
440 }
441
442 // "New" AOT flags must not be mixed with "classic" CDS flags such as -Xshare:dump
443 CHECK_NEW_FLAG(AOTCache);
444 CHECK_NEW_FLAG(AOTCacheOutput);
445 CHECK_NEW_FLAG(AOTConfiguration);
446 CHECK_NEW_FLAG(AOTMode);
447
448 CHECK_SINGLE_PATH(AOTCache);
449 CHECK_SINGLE_PATH(AOTCacheOutput);
450 CHECK_SINGLE_PATH(AOTConfiguration);
451
452 if (FLAG_IS_DEFAULT(AOTCache) && AOTAdapterCaching) {
453 log_debug(aot,codecache,init)("AOTCache is not specified - AOTAdapterCaching is ignored");
454 }
455 if (FLAG_IS_DEFAULT(AOTCache) && AOTStubCaching) {
456 log_debug(aot,codecache,init)("AOTCache is not specified - AOTStubCaching is ignored");
457 }
458
459 bool has_cache = !FLAG_IS_DEFAULT(AOTCache);
460 bool has_cache_output = !FLAG_IS_DEFAULT(AOTCacheOutput);
461 bool has_config = !FLAG_IS_DEFAULT(AOTConfiguration);
462 bool has_mode = !FLAG_IS_DEFAULT(AOTMode);
463
464 if (!has_cache && !has_cache_output && !has_config && !has_mode) {
465 // AOT flags are not used. Use classic CDS workflow
466 return;
467 }
468
469 if (has_cache && has_cache_output) {
470 vm_exit_during_initialization("Only one of AOTCache or AOTCacheOutput can be specified");
471 }
472
473 if (!has_cache && (!has_mode || strcmp(AOTMode, "auto") == 0)) {
474 if (has_cache_output) {
475 // If AOTCacheOutput has been set, effective mode is "record".
476 // Default value for AOTConfiguration, if necessary, will be assigned in check_aotmode_record().
477 log_info(aot)("Selected AOTMode=record because AOTCacheOutput is specified");
478 FLAG_SET_ERGO(AOTMode, "record");
479 }
480 }
481
482 // At least one AOT flag has been used
483 _new_aot_flags_used = true;
484
485 if (FLAG_IS_DEFAULT(AOTMode) || strcmp(AOTMode, "auto") == 0 || strcmp(AOTMode, "on") == 0 || strcmp(AOTMode, "required") == 0) {
486 check_aotmode_auto_or_on();
487 } else if (strcmp(AOTMode, "off") == 0) {
488 check_aotmode_off();
489 } else if (strcmp(AOTMode, "record") == 0) {
490 check_aotmode_record();
491 } else {
492 assert(strcmp(AOTMode, "create") == 0, "checked by AOTModeConstraintFunc");
493 check_aotmode_create();
494 }
495 }
496
497 void CDSConfig::check_aotmode_off() {
498 UseSharedSpaces = false;
499 RequireSharedSpaces = false;
500 }
501
502 void CDSConfig::check_aotmode_auto_or_on() {
503 if (!FLAG_IS_DEFAULT(AOTConfiguration)) {
504 vm_exit_during_initialization(err_msg("AOTConfiguration can only be used with when AOTMode is record or create (selected AOTMode = %s)",
505 FLAG_IS_DEFAULT(AOTMode) ? "auto" : AOTMode));
506 }
507
508 UseSharedSpaces = true;
509 if (FLAG_IS_DEFAULT(AOTMode) || (strcmp(AOTMode, "auto") == 0)) {
510 RequireSharedSpaces = false;
511 } else {
512 assert(strcmp(AOTMode, "on") == 0 || strcmp(AOTMode, "required") == 0 , "already checked");
513 RequireSharedSpaces = true;
514 }
515 }
516
517 // %p substitution in AOTCache, AOTCacheOutput and AOTCacheConfiguration
518 static void substitute_aot_filename(JVMFlagsEnum flag_enum) {
519 JVMFlag* flag = JVMFlag::flag_from_enum(flag_enum);
520 const char* filename = flag->read<const char*>();
521 assert(filename != nullptr, "must not have default value");
522
523 // For simplicity, we don't allow %p/%t to be specified twice, because make_log_name()
524 // substitutes only the first occurrence. Otherwise, if we run with
525 // java -XX:AOTCacheOutput=%p%p.aot
526 // it will end up with both the pid of the training process and the assembly process.
527 const char* first_p = strstr(filename, "%p");
528 if (first_p != nullptr && strstr(first_p + 2, "%p") != nullptr) {
529 vm_exit_during_initialization(err_msg("%s cannot contain more than one %%p", flag->name()));
530 }
531 const char* first_t = strstr(filename, "%t");
532 if (first_t != nullptr && strstr(first_t + 2, "%t") != nullptr) {
533 vm_exit_during_initialization(err_msg("%s cannot contain more than one %%t", flag->name()));
534 }
535
536 // Note: with single-command training, %p will be the pid of the training process, not the
537 // assembly process.
538 const char* new_filename = make_log_name(filename, nullptr);
539 if (strcmp(filename, new_filename) != 0) {
540 JVMFlag::Error err = JVMFlagAccess::set_ccstr(flag, &new_filename, JVMFlagOrigin::ERGONOMIC);
541 assert(err == JVMFlag::SUCCESS, "must never fail");
542 }
543 FREE_C_HEAP_ARRAY(new_filename);
544 }
545
546 void CDSConfig::check_aotmode_record() {
547 bool has_config = !FLAG_IS_DEFAULT(AOTConfiguration);
548 bool has_output = !FLAG_IS_DEFAULT(AOTCacheOutput);
549
550 if (!has_output && !has_config) {
551 vm_exit_during_initialization("At least one of AOTCacheOutput and AOTConfiguration must be specified when using -XX:AOTMode=record");
552 }
553
554 if (has_output) {
555 _is_single_command_training = true;
556 substitute_aot_filename(FLAG_MEMBER_ENUM(AOTCacheOutput));
557 if (!has_config) {
558 // Too early; can't use resource allocation yet.
559 size_t len = strlen(AOTCacheOutput) + 10;
560 char* temp = AllocateHeap(len, mtArguments);
561 jio_snprintf(temp, len, "%s.config", AOTCacheOutput);
562 FLAG_SET_ERGO(AOTConfiguration, temp);
563 FreeHeap(temp);
564 _has_temp_aot_config_file = true;
565 }
566 }
567
568 if (!FLAG_IS_DEFAULT(AOTCache)) {
569 vm_exit_during_initialization("AOTCache must not be specified when using -XX:AOTMode=record");
570 }
571
572 substitute_aot_filename(FLAG_MEMBER_ENUM(AOTConfiguration));
573
574 UseSharedSpaces = false;
575 RequireSharedSpaces = false;
576 _is_dumping_static_archive = true;
577 _is_dumping_preimage_static_archive = true;
578
579 // At VM exit, the module graph may be contaminated with program states.
580 // We will rebuild the module graph when dumping the CDS final image.
581 _is_using_optimized_module_handling = false;
582 _is_using_full_module_graph = false;
583 _is_dumping_full_module_graph = false;
584 }
585
586 void CDSConfig::check_aotmode_create() {
587 if (FLAG_IS_DEFAULT(AOTConfiguration)) {
588 vm_exit_during_initialization("AOTConfiguration must be specified when using -XX:AOTMode=create");
589 }
590
591 bool has_cache = !FLAG_IS_DEFAULT(AOTCache);
592 bool has_cache_output = !FLAG_IS_DEFAULT(AOTCacheOutput);
593
594 assert(!(has_cache && has_cache_output), "already checked");
595
596 if (!has_cache && !has_cache_output) {
597 vm_exit_during_initialization("AOTCache or AOTCacheOutput must be specified when using -XX:AOTMode=create");
598 }
599
600 if (!has_cache) {
601 precond(has_cache_output);
602 FLAG_SET_ERGO(AOTCache, AOTCacheOutput);
603 }
604 // No need to check for (!has_cache_output), as we don't look at AOTCacheOutput after here.
605
606 substitute_aot_filename(FLAG_MEMBER_ENUM(AOTCache));
607
608 _is_dumping_final_static_archive = true;
609 _is_using_full_module_graph = false;
610 UseSharedSpaces = true;
611 RequireSharedSpaces = true;
612
613 if (!FileMapInfo::is_preimage_static_archive(AOTConfiguration)) {
614 vm_exit_during_initialization("Must be a valid AOT configuration generated by the current JVM", AOTConfiguration);
615 }
616
617 CDSConfig::enable_dumping_static_archive();
618
619 // We don't load any agents in the assembly phase, so we can ensure that the agents
620 // cannot affect the contents of the AOT cache. E.g., we don't want the agents to
621 // redefine any cached classes. We also don't want the agents to modify heap objects that
622 // are cached.
623 //
624 // Since application is not executed in the assembly phase, there's no need to load
625 // the agents anyway -- no one will notice that the agents are not loaded.
626 log_info(aot)("Disabled all JVMTI agents during -XX:AOTMode=create");
627 JvmtiAgentList::disable_agent_list();
628 }
629
630 void CDSConfig::ergo_init_aot_paths() {
631 assert(_cds_ergo_initialize_started, "sanity");
632 if (is_dumping_static_archive()) {
633 if (is_dumping_preimage_static_archive()) {
634 _output_archive_path = AOTConfiguration;
635 } else {
636 assert(is_dumping_final_static_archive(), "must be");
637 _input_static_archive_path = AOTConfiguration;
638 _output_archive_path = AOTCache;
639 }
640 } else if (is_using_archive()) {
641 if (FLAG_IS_DEFAULT(AOTCache)) {
642 // Only -XX:AOTMode={auto,on} is specified
643 _input_static_archive_path = default_archive_path();
644 } else {
645 _input_static_archive_path = AOTCache;
646 }
647 }
648 }
649
650 bool CDSConfig::check_vm_args_consistency(bool patch_mod_javabase, bool mode_flag_cmd_line) {
651 assert(!_cds_ergo_initialize_started, "This is called earlier than CDSConfig::ergo_initialize()");
652
653 check_aot_flags();
654
655 if (!FLAG_IS_DEFAULT(AOTMode)) {
656 // Using any form of the new AOTMode switch enables enhanced optimizations.
657 FLAG_SET_ERGO_IF_DEFAULT(AOTClassLinking, true);
658 }
659
660 if (AOTClassLinking) {
661 // If AOTClassLinking is specified, enable all AOT optimizations by default.
662 FLAG_SET_ERGO_IF_DEFAULT(AOTInvokeDynamicLinking, true);
663 } else {
664 // AOTInvokeDynamicLinking depends on AOTClassLinking.
665 FLAG_SET_ERGO(AOTInvokeDynamicLinking, false);
666 }
667
668 if (is_dumping_static_archive()) {
669 if (is_dumping_preimage_static_archive()) {
670 // Don't tweak execution mode during AOT training run
671 } else if (is_dumping_final_static_archive()) {
672 if (Arguments::mode() == Arguments::_comp) {
673 // AOT assembly phase submits the non-blocking compilation requests
674 // for methods collected during training run, then waits for all compilations
675 // to complete. With -Xcomp, we block for each compilation request, which is
676 // counter-productive. Switching back to mixed mode improves testing time
677 // with AOT and -Xcomp.
678 Arguments::set_mode_flags(Arguments::_mixed);
679 }
680 } else if (!mode_flag_cmd_line) {
681 // By default, -Xshare:dump runs in interpreter-only mode, which is required for deterministic archive.
682 //
683 // If your classlist is large and you don't care about deterministic dumping, you can use
684 // -Xshare:dump -Xmixed to improve dumping speed.
685 Arguments::set_mode_flags(Arguments::_int);
686 } else if (Arguments::mode() == Arguments::_comp) {
687 // -Xcomp may use excessive CPU for the test tiers. Also, -Xshare:dump runs a small and fixed set of
688 // Java code, so there's not much benefit in running -Xcomp.
689 aot_log_info(aot)("reduced -Xcomp to -Xmixed for static dumping");
690 Arguments::set_mode_flags(Arguments::_mixed);
691 }
692
693 // String deduplication may cause CDS to iterate the strings in different order from one
694 // run to another which resulting in non-determinstic CDS archives.
695 // Disable UseStringDeduplication while dumping CDS archive.
696 UseStringDeduplication = false;
697 }
698
699 // RecordDynamicDumpInfo is not compatible with ArchiveClassesAtExit
700 if (ArchiveClassesAtExit != nullptr && RecordDynamicDumpInfo) {
701 jio_fprintf(defaultStream::output_stream(),
702 "-XX:+RecordDynamicDumpInfo cannot be used with -XX:ArchiveClassesAtExit.\n");
703 return false;
704 }
705
706 if (ArchiveClassesAtExit == nullptr && !RecordDynamicDumpInfo) {
707 disable_dumping_dynamic_archive();
708 } else {
709 enable_dumping_dynamic_archive(ArchiveClassesAtExit);
710 }
711
712 if (AutoCreateSharedArchive) {
713 if (SharedArchiveFile == nullptr) {
714 aot_log_warning(aot)("-XX:+AutoCreateSharedArchive requires -XX:SharedArchiveFile");
715 return false;
716 }
717 if (ArchiveClassesAtExit != nullptr) {
718 aot_log_warning(aot)("-XX:+AutoCreateSharedArchive does not work with ArchiveClassesAtExit");
719 return false;
720 }
721 }
722
723 if (is_using_archive() && patch_mod_javabase) {
724 Arguments::no_shared_spaces("CDS is disabled when " JAVA_BASE_NAME " module is patched.");
725 }
726 if (is_using_archive() && has_unsupported_runtime_module_options()) {
727 UseSharedSpaces = false;
728 }
729
730 if (is_dumping_archive()) {
731 // Always verify non-system classes during CDS dump
732 if (!BytecodeVerificationRemote) {
733 BytecodeVerificationRemote = true;
734 aot_log_info(aot)("All non-system classes will be verified (-Xverify:remote) during CDS dump time.");
735 }
736 }
737
738 return true;
739 }
740
741 void CDSConfig::setup_compiler_args() {
742 // AOT profiles and AOT-compiled code are supported only in the JEP 483 workflow.
743 bool can_dump_profile_and_compiled_code = AOTClassLinking && new_aot_flags_used();
744
745 if (is_dumping_preimage_static_archive() && can_dump_profile_and_compiled_code) {
746 // JEP 483 workflow -- training
747 FLAG_SET_ERGO_IF_DEFAULT(AOTRecordTraining, true);
748 FLAG_SET_ERGO(AOTReplayTraining, false);
749 AOTCodeCache::disable_caching(); // No AOT code generation during training run
750 } else if (is_dumping_final_static_archive() && can_dump_profile_and_compiled_code) {
751 // JEP 483 workflow -- assembly
752 FLAG_SET_ERGO(AOTRecordTraining, false);
753 FLAG_SET_ERGO_IF_DEFAULT(AOTReplayTraining, true);
754 AOTCodeCache::enable_caching(); // Generate AOT code during assembly phase.
755 disable_dumping_aot_code(); // Don't dump AOT code until metadata and heap are dumped.
756 } else if (is_using_archive() && new_aot_flags_used()) {
757 // JEP 483 workflow -- production
758 FLAG_SET_ERGO(AOTRecordTraining, false);
759 FLAG_SET_ERGO_IF_DEFAULT(AOTReplayTraining, true);
760 AOTCodeCache::enable_caching();
761 } else {
762 FLAG_SET_ERGO(AOTReplayTraining, false);
763 FLAG_SET_ERGO(AOTRecordTraining, false);
764 AOTCodeCache::disable_caching();
765 }
766 }
767
768 void CDSConfig::prepare_for_dumping() {
769 assert(CDSConfig::is_dumping_archive(), "sanity");
770
771 if (is_dumping_dynamic_archive() && AOTClassLinking) {
772 if (FLAG_IS_CMDLINE(AOTClassLinking)) {
773 log_warning(cds)("AOTClassLinking is not supported for dynamic CDS archive");
774 }
775 FLAG_SET_ERGO(AOTClassLinking, false);
776 }
777
778 if (is_dumping_dynamic_archive() && !is_using_archive()) {
779 assert(!is_dumping_static_archive(), "cannot be dumping both static and dynamic archives");
780
781 // This could happen if SharedArchiveFile has failed to load:
782 // - -Xshare:off was specified
783 // - SharedArchiveFile points to an non-existent file.
784 // - SharedArchiveFile points to an archive that has failed CRC check
785 // - SharedArchiveFile is not specified and the VM doesn't have a compatible default archive
786
787 #define __THEMSG " is unsupported when base CDS archive is not loaded. Run with -Xlog:cds for more info."
788 if (RecordDynamicDumpInfo) {
789 aot_log_error(aot)("-XX:+RecordDynamicDumpInfo%s", __THEMSG);
790 AOTMetaspace::unrecoverable_loading_error();
791 } else {
792 assert(ArchiveClassesAtExit != nullptr, "sanity");
793 aot_log_warning(aot)("-XX:ArchiveClassesAtExit" __THEMSG);
794 }
795 #undef __THEMSG
796 disable_dumping_dynamic_archive();
797 return;
798 }
799
800 check_unsupported_dumping_module_options();
801 }
802
803 bool CDSConfig::is_dumping_classic_static_archive() {
804 return _is_dumping_static_archive &&
805 !is_dumping_preimage_static_archive() &&
806 !is_dumping_final_static_archive();
807 }
808
809 bool CDSConfig::is_dumping_preimage_static_archive() {
810 return _is_dumping_preimage_static_archive;
811 }
812
813 bool CDSConfig::is_dumping_final_static_archive() {
814 return _is_dumping_final_static_archive;
815 }
816
817 void CDSConfig::enable_dumping_dynamic_archive(const char* output_path) {
818 _is_dumping_dynamic_archive = true;
819 if (output_path == nullptr) {
820 // output_path can be null when the VM is started with -XX:+RecordDynamicDumpInfo
821 // in anticipation of "jcmd VM.cds dynamic_dump", which will provide the actual
822 // output path.
823 _output_archive_path = nullptr;
824 } else {
825 _output_archive_path = os::strdup_check_oom(output_path, mtArguments);
826 }
827 }
828
829 bool CDSConfig::allow_only_single_java_thread() {
830 // See comments in JVM_StartThread()
831 return is_dumping_classic_static_archive() || is_dumping_final_static_archive();
832 }
833
834 bool CDSConfig::is_using_archive() {
835 return UseSharedSpaces;
836 }
837
838 bool CDSConfig::is_using_only_default_archive() {
839 return is_using_archive() &&
840 input_static_archive_path() != nullptr &&
841 default_archive_path() != nullptr &&
842 strcmp(input_static_archive_path(), default_archive_path()) == 0 &&
843 input_dynamic_archive_path() == nullptr;
844 }
845
846 bool CDSConfig::is_logging_lambda_form_invokers() {
847 return ClassListWriter::is_enabled() || is_dumping_dynamic_archive();
848 }
849
850 bool CDSConfig::is_dumping_regenerated_lambdaform_invokers() {
851 if (is_dumping_final_static_archive()) {
852 // No need to regenerate -- the lambda form invokers should have been regenerated
853 // in the preimage archive (if allowed)
854 return false;
855 } else if (is_dumping_dynamic_archive() && is_using_aot_linked_classes()) {
856 // The base archive has aot-linked classes that may have AOT-resolved CP references
857 // that point to the lambda form invokers in the base archive. Such pointers will
858 // be invalid if lambda form invokers are regenerated in the dynamic archive.
859 return false;
860 } else {
861 return is_dumping_archive();
862 }
863 }
864
865 void CDSConfig::stop_using_optimized_module_handling() {
866 _is_using_optimized_module_handling = false;
867 _is_dumping_full_module_graph = false; // This requires is_using_optimized_module_handling()
868 _is_using_full_module_graph = false; // This requires is_using_optimized_module_handling()
869 }
870
871
872 CDSConfig::DumperThreadMark::DumperThreadMark(JavaThread* current) {
873 assert(_dumper_thread == nullptr, "sanity");
874 _dumper_thread = current;
875 }
876
877 CDSConfig::DumperThreadMark::~DumperThreadMark() {
878 assert(_dumper_thread != nullptr, "sanity");
879 _dumper_thread = nullptr;
880 }
881
882 bool CDSConfig::current_thread_is_vm_or_dumper() {
883 Thread* t = Thread::current();
884 return t->is_VM_thread() || t == _dumper_thread;
885 }
886
887 bool CDSConfig::current_thread_is_dumper() {
888 return Thread::current() == _dumper_thread;
889 }
890
891 const char* CDSConfig::type_of_archive_being_loaded() {
892 if (is_dumping_final_static_archive()) {
893 return "AOT configuration file";
894 } else if (new_aot_flags_used()) {
895 return "AOT cache";
896 } else {
897 return "shared archive file";
898 }
899 }
900
901 const char* CDSConfig::type_of_archive_being_written() {
902 if (is_dumping_preimage_static_archive()) {
903 return "AOT configuration file";
904 } else if (new_aot_flags_used()) {
905 return "AOT cache";
906 } else {
907 return "shared archive file";
908 }
909 }
910
911 // If an incompatible VM options is found, return a text message that explains why
912 static const char* check_options_incompatible_with_dumping_heap() {
913 #if INCLUDE_CDS_JAVA_HEAP
914 return nullptr;
915 #else
916 return "JVM not configured for writing Java heap objects";
917 #endif
918 }
919
920 void CDSConfig::log_reasons_for_not_dumping_heap() {
921 const char* reason;
922
923 assert(!is_dumping_heap(), "sanity");
924
925 if (_disable_heap_dumping) {
926 reason = "Programmatically disabled";
927 } else {
928 reason = check_options_incompatible_with_dumping_heap();
929 }
930
931 assert(reason != nullptr, "sanity");
932 aot_log_info(aot)("Archived java heap is not supported: %s", reason);
933 }
934
935 // This is *Legacy* optimization for lambdas before JEP 483. May be removed in the future.
936 bool CDSConfig::is_dumping_lambdas_in_legacy_mode() {
937 return !is_dumping_method_handles();
938 }
939
940 bool CDSConfig::is_preserving_verification_constraints() {
941 // Verification dependencies are classes used in assignability checks by the
942 // bytecode verifier. In the following example, the verification dependencies
943 // for X are A and B.
944 //
945 // class X {
946 // A getA() { return new B(); }
947 // }
948 //
949 // With the AOT cache, we can ensure that all the verification dependencies
950 // (A and B in the above example) are unconditionally loaded during the bootstrap
951 // of the production run. This means that if a class was successfully verified
952 // in the assembly phase, all of the verifier's assignability checks will remain
953 // valid in the production run, so we don't need to verify aot-linked classes again.
954
955 if (is_dumping_preimage_static_archive()) { // writing AOT config
956 return AOTClassLinking;
957 } else if (is_dumping_final_static_archive()) { // writing AOT cache
958 return is_dumping_aot_linked_classes();
959 } else if (is_dumping_classic_static_archive()) {
960 return is_dumping_aot_linked_classes();
961 } else {
962 return false;
963 }
964 }
965
966 bool CDSConfig::is_old_class_for_verifier(const InstanceKlass* ik) {
967 return ik->major_version() < 50 /*JAVA_6_VERSION*/;
968 }
969
970 #if INCLUDE_CDS_JAVA_HEAP
971 bool CDSConfig::are_vm_options_incompatible_with_dumping_heap() {
972 return check_options_incompatible_with_dumping_heap() != nullptr;
973 }
974
975 bool CDSConfig::is_dumping_heap() {
976 // Note: when dumping preimage static archive, only a very limited set of oops
977 // are dumped.
978 if (!is_dumping_static_archive()
979 || are_vm_options_incompatible_with_dumping_heap()
980 || _disable_heap_dumping) {
981 return false;
982 }
983 return true;
984 }
985
986 bool CDSConfig::is_loading_heap() {
987 return HeapShared::is_archived_heap_in_use();
988 }
989
990 bool CDSConfig::is_dumping_klass_subgraphs() {
991 if (is_dumping_aot_linked_classes()) {
992 // KlassSubGraphs (see heapShared.cpp) is a legacy mechanism for archiving oops. It
993 // has been superceded by AOT class linking. This feature is used only when
994 // AOT class linking is disabled.
995 return false;
996 }
997
998 if (is_dumping_preimage_static_archive()) {
999 // KlassSubGraphs are disabled in the preimage static archive, which contains a very
1000 // limited set of oops.
1001 return false;
1002 }
1003
1004 if (!is_dumping_full_module_graph()) {
1005 // KlassSubGraphs cannot be partially disabled. Since some of the KlassSubGraphs
1006 // are used for (legacy support) of the archived full module graph, if
1007 // is_dumping_full_module_graph() is calse, we must disable all KlassSubGraphs.
1008 return false;
1009 }
1010
1011 return is_dumping_heap();
1012 }
1013
1014 bool CDSConfig::is_using_klass_subgraphs() {
1015 return (is_loading_heap() &&
1016 !CDSConfig::is_using_aot_linked_classes() &&
1017 !CDSConfig::is_dumping_final_static_archive());
1018 }
1019
1020 bool CDSConfig::is_using_full_module_graph() {
1021 if (ClassLoaderDataShared::is_full_module_graph_loaded()) {
1022 return true;
1023 }
1024
1025 if (!_is_using_full_module_graph) {
1026 return false;
1027 }
1028
1029 if (is_using_archive() && HeapShared::can_use_archived_heap()) {
1030 // Classes used by the archived full module graph are loaded in JVMTI early phase.
1031 assert(!(JvmtiExport::should_post_class_file_load_hook() && JvmtiExport::has_early_class_hook_env()),
1032 "CDS should be disabled if early class hooks are enabled");
1033 return true;
1034 } else {
1035 _is_using_full_module_graph = false;
1036 return false;
1037 }
1038 }
1039
1040 void CDSConfig::stop_dumping_full_module_graph(const char* reason) {
1041 if (_is_dumping_full_module_graph) {
1042 _is_dumping_full_module_graph = false;
1043 if (reason != nullptr) {
1044 aot_log_info(aot)("full module graph cannot be dumped: %s", reason);
1045 }
1046 }
1047 }
1048
1049 void CDSConfig::stop_using_full_module_graph(const char* reason) {
1050 assert(!ClassLoaderDataShared::is_full_module_graph_loaded(), "you call this function too late!");
1051 if (_is_using_full_module_graph) {
1052 _is_using_full_module_graph = false;
1053 if (reason != nullptr) {
1054 aot_log_info(aot)("full module graph cannot be loaded: %s", reason);
1055 }
1056 }
1057 }
1058
1059 bool CDSConfig::is_dumping_aot_linked_classes() {
1060 if (is_dumping_classic_static_archive() || is_dumping_final_static_archive()) {
1061 // FMG is required to guarantee that all cached boot/platform/app classes
1062 // are visible in the production run, so they can be unconditionally
1063 // loaded during VM bootstrap.
1064 return is_dumping_full_module_graph() && AOTClassLinking;
1065 } else {
1066 return false;
1067 }
1068 }
1069
1070 bool CDSConfig::is_using_aot_linked_classes() {
1071 // Make sure we have the exact same module graph as in the assembly phase, or else
1072 // some aot-linked classes may not be visible so cannot be loaded.
1073 return is_using_full_module_graph() && _has_aot_linked_classes;
1074 }
1075
1076 void CDSConfig::set_has_aot_linked_classes(bool has_aot_linked_classes) {
1077 _has_aot_linked_classes |= has_aot_linked_classes;
1078 }
1079
1080 bool CDSConfig::is_dumping_invokedynamic() {
1081 // Requires is_dumping_aot_linked_classes(). Otherwise the classes of some archived heap
1082 // objects used by the archive indy callsites may be replaced at runtime.
1083 return AOTInvokeDynamicLinking && is_dumping_aot_linked_classes() && is_dumping_heap();
1084 }
1085
1086 // When we are dumping aot-linked classes, we automatically enable the archiving of MethodHandles.
1087 // This will in turn enable the archiving of MethodTypes and hidden
1088 // classes that are used in the implementation of MethodHandles.
1089 // Archived MethodHandles are required for higher-level optimizations such as AOT resolution of invokedynamic
1090 // and dynamic proxies.
1091 bool CDSConfig::is_dumping_method_handles() {
1092 return is_dumping_aot_linked_classes();
1093 }
1094
1095 #endif // INCLUDE_CDS_JAVA_HEAP
1096
1097 // AOT code generation and its archiving is disabled by default.
1098 // We enable it only in the final image dump after the metadata and heap are dumped.
1099 // This affects only JITed code because it may have embedded oops and metadata pointers
1100 // which AOT code encodes as offsets in final CDS archive regions.
1101
1102 static bool _is_dumping_aot_code = false;
1103
1104 bool CDSConfig::is_dumping_aot_code() {
1105 return _is_dumping_aot_code;
1106 }
1107
1108 void CDSConfig::disable_dumping_aot_code() {
1109 _is_dumping_aot_code = false;
1110 }
1111
1112 void CDSConfig::enable_dumping_aot_code() {
1113 _is_dumping_aot_code = true;
1114 }
1115
1116 bool CDSConfig::is_dumping_adapters() {
1117 return (AOTAdapterCaching && is_dumping_final_static_archive());
1118 }