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