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