1 /*
2 * Copyright (c) 2023, 2025, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #include "cds/aotLogging.hpp"
26 #include "cds/aotMapLogger.hpp"
27 #include "cds/archiveHeapLoader.hpp"
28 #include "cds/cdsConfig.hpp"
29 #include "cds/classListWriter.hpp"
30 #include "cds/filemap.hpp"
31 #include "cds/heapShared.hpp"
32 #include "classfile/classLoaderDataShared.hpp"
33 #include "classfile/moduleEntry.hpp"
34 #include "code/aotCodeCache.hpp"
35 #include "include/jvm_io.h"
36 #include "logging/log.hpp"
37 #include "memory/universe.hpp"
38 #include "prims/jvmtiAgentList.hpp"
39 #include "runtime/arguments.hpp"
40 #include "runtime/globals_extension.hpp"
41 #include "runtime/java.hpp"
42 #include "runtime/vmThread.hpp"
43 #include "utilities/defaultStream.hpp"
44 #include "utilities/formatBuffer.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
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_archive() ? IS_DUMPING_ARCHIVE : 0) |
70 (is_dumping_method_handles() ? IS_DUMPING_METHOD_HANDLES : 0) |
71 (is_dumping_static_archive() ? IS_DUMPING_STATIC_ARCHIVE : 0) |
72 (is_logging_lambda_form_invokers() ? IS_LOGGING_LAMBDA_FORM_INVOKERS : 0) |
73 (is_using_archive() ? IS_USING_ARCHIVE : 0);
74 }
75
76 DEBUG_ONLY(static bool _cds_ergo_initialize_started = false);
77
78 void CDSConfig::ergo_initialize() {
79 DEBUG_ONLY(_cds_ergo_initialize_started = true);
80
81 if (is_dumping_static_archive() && !is_dumping_final_static_archive()) {
82 // Note: -Xshare and -XX:AOTMode flags are mutually exclusive.
83 // - Classic workflow: -Xshare:on and -Xshare:dump cannot take effect at the same time.
84 // - JEP 483 workflow: -XX:AOTMode:record and -XX:AOTMode=on cannot take effect at the same time.
85 // So we can never come to here with RequireSharedSpaces==true.
86 assert(!RequireSharedSpaces, "sanity");
87
88 // If dumping the classic archive, or making an AOT training run (dumping a preimage archive),
89 // for sanity, parse all classes from classfiles.
90 // TODO: in the future, if we want to support re-training on top of an existing AOT cache, this
91 // needs to be changed.
92 UseSharedSpaces = false;
93 }
94
95 // Initialize shared archive paths which could include both base and dynamic archive paths
96 // This must be after set_ergonomics_flags() called so flag UseCompressedOops is set properly.
97 if (is_dumping_static_archive() || is_using_archive()) {
98 if (new_aot_flags_used()) {
99 ergo_init_aot_paths();
100 } else {
101 ergo_init_classic_archive_paths();
102 }
103 }
104
105 if (!is_dumping_heap()) {
106 _is_dumping_full_module_graph = false;
107 }
108
109 AOTMapLogger::ergo_initialize();
110 }
111
112 const char* CDSConfig::default_archive_path() {
113 // The path depends on UseCompressedOops, etc, which are set by GC ergonomics just
114 // before CDSConfig::ergo_initialize() is called.
115 assert(_cds_ergo_initialize_started, "sanity");
116 if (_default_archive_path == nullptr) {
117 stringStream tmp;
118 if (is_vm_statically_linked()) {
119 // It's easier to form the path using JAVA_HOME as os::jvm_path
120 // gives the path to the launcher executable on static JDK.
121 const char* subdir = WINDOWS_ONLY("bin") NOT_WINDOWS("lib");
122 tmp.print("%s%s%s%s%s%sclasses",
123 Arguments::get_java_home(), os::file_separator(),
124 subdir, os::file_separator(),
125 Abstract_VM_Version::vm_variant(), os::file_separator());
126 } else {
127 // Assume .jsa is in the same directory where libjvm resides on
128 // non-static JDK.
129 char jvm_path[JVM_MAXPATHLEN];
130 os::jvm_path(jvm_path, sizeof(jvm_path));
131 char *end = strrchr(jvm_path, *os::file_separator());
132 if (end != nullptr) *end = '\0';
133 tmp.print("%s%sclasses", jvm_path, os::file_separator());
134 }
135 #ifdef _LP64
136 if (!UseCompressedOops) {
137 tmp.print_raw("_nocoops");
138 }
139 if (UseCompactObjectHeaders) {
140 // Note that generation of xxx_coh.jsa variants require
141 // --enable-cds-archive-coh at build time
142 tmp.print_raw("_coh");
143 }
144 #endif
145 tmp.print_raw(".jsa");
146 _default_archive_path = os::strdup(tmp.base());
147 }
148 return _default_archive_path;
149 }
150
151 int CDSConfig::num_archive_paths(const char* path_spec) {
152 if (path_spec == nullptr) {
153 return 0;
154 }
155 int npaths = 1;
156 char* p = (char*)path_spec;
157 while (*p != '\0') {
158 if (*p == os::path_separator()[0]) {
159 npaths++;
160 }
161 p++;
162 }
163 return npaths;
164 }
165
166 void CDSConfig::extract_archive_paths(const char* archive_path,
167 const char** base_archive_path,
168 const char** top_archive_path) {
169 char* begin_ptr = (char*)archive_path;
170 char* end_ptr = strchr((char*)archive_path, os::path_separator()[0]);
171 if (end_ptr == nullptr || end_ptr == begin_ptr) {
172 vm_exit_during_initialization("Base archive was not specified", archive_path);
173 }
174 size_t len = end_ptr - begin_ptr;
175 char* cur_path = NEW_C_HEAP_ARRAY(char, len + 1, mtInternal);
176 strncpy(cur_path, begin_ptr, len);
177 cur_path[len] = '\0';
178 *base_archive_path = cur_path;
179
180 begin_ptr = ++end_ptr;
181 if (*begin_ptr == '\0') {
182 vm_exit_during_initialization("Top archive was not specified", archive_path);
183 }
184 end_ptr = strchr(begin_ptr, '\0');
185 assert(end_ptr != nullptr, "sanity");
186 len = end_ptr - begin_ptr;
187 cur_path = NEW_C_HEAP_ARRAY(char, len + 1, mtInternal);
188 strncpy(cur_path, begin_ptr, len + 1);
189 *top_archive_path = cur_path;
190 }
191
192 void CDSConfig::ergo_init_classic_archive_paths() {
193 assert(_cds_ergo_initialize_started, "sanity");
194 if (ArchiveClassesAtExit != nullptr) {
195 assert(!RecordDynamicDumpInfo, "already checked");
196 if (is_dumping_static_archive()) {
197 vm_exit_during_initialization("-XX:ArchiveClassesAtExit cannot be used with -Xshare:dump");
198 }
199 check_unsupported_dumping_module_options();
200
201 if (os::same_files(default_archive_path(), ArchiveClassesAtExit)) {
202 vm_exit_during_initialization(
203 "Cannot specify the default CDS archive for -XX:ArchiveClassesAtExit", default_archive_path());
204 }
205 }
206
207 if (SharedArchiveFile == nullptr) {
208 _input_static_archive_path = default_archive_path();
209 if (is_dumping_static_archive()) {
210 _output_archive_path = _input_static_archive_path;
211 }
212 } else {
213 int num_archives = num_archive_paths(SharedArchiveFile);
214 assert(num_archives > 0, "must be");
215
216 if (is_dumping_archive() && num_archives > 1) {
217 vm_exit_during_initialization(
218 "Cannot have more than 1 archive file specified in -XX:SharedArchiveFile during CDS dumping");
219 }
220
221 if (is_dumping_static_archive()) {
222 assert(num_archives == 1, "just checked above");
223 // Static dump is simple: only one archive is allowed in SharedArchiveFile. This file
224 // will be overwritten regardless of its contents
225 _output_archive_path = SharedArchiveFile;
226 } else {
227 // SharedArchiveFile may specify one or two files. In case (c), the path for base.jsa
228 // is read from top.jsa
229 // (a) 1 file: -XX:SharedArchiveFile=base.jsa
230 // (b) 2 files: -XX:SharedArchiveFile=base.jsa:top.jsa
231 // (c) 2 files: -XX:SharedArchiveFile=top.jsa
232 //
233 // However, if either RecordDynamicDumpInfo or ArchiveClassesAtExit is used, we do not
234 // allow cases (b) and (c). Case (b) is already checked above.
235
236 if (num_archives > 2) {
237 vm_exit_during_initialization(
238 "Cannot have more than 2 archive files specified in the -XX:SharedArchiveFile option");
239 }
240
241 if (num_archives == 1) {
242 const char* base_archive_path = nullptr;
243 bool success =
244 FileMapInfo::get_base_archive_name_from_header(SharedArchiveFile, &base_archive_path);
245 if (!success) {
246 // If +AutoCreateSharedArchive and the specified shared archive does not exist,
247 // regenerate the dynamic archive base on default archive.
248 if (AutoCreateSharedArchive && !os::file_exists(SharedArchiveFile)) {
249 enable_dumping_dynamic_archive(SharedArchiveFile);
250 FLAG_SET_ERGO(ArchiveClassesAtExit, SharedArchiveFile);
251 _input_static_archive_path = default_archive_path();
252 FLAG_SET_ERGO(SharedArchiveFile, nullptr);
253 } else {
254 if (AutoCreateSharedArchive) {
255 warning("-XX:+AutoCreateSharedArchive is unsupported when base CDS archive is not loaded. Run with -Xlog:cds for more info.");
256 AutoCreateSharedArchive = false;
257 }
258 aot_log_error(aot)("Not a valid %s (%s)", type_of_archive_being_loaded(), SharedArchiveFile);
259 Arguments::no_shared_spaces("invalid archive");
260 }
261 } else if (base_archive_path == nullptr) {
262 // User has specified a single archive, which is a static archive.
263 _input_static_archive_path = SharedArchiveFile;
264 } else {
265 // User has specified a single archive, which is a dynamic archive.
266 _input_dynamic_archive_path = SharedArchiveFile;
267 _input_static_archive_path = base_archive_path; // has been c-heap allocated.
268 }
269 } else {
270 extract_archive_paths(SharedArchiveFile,
271 &_input_static_archive_path, &_input_dynamic_archive_path);
272 if (_input_static_archive_path == nullptr) {
273 assert(_input_dynamic_archive_path == nullptr, "must be");
274 Arguments::no_shared_spaces("invalid archive");
275 }
276 }
277
278 if (_input_dynamic_archive_path != nullptr) {
279 // Check for case (c)
280 if (RecordDynamicDumpInfo) {
281 vm_exit_during_initialization("-XX:+RecordDynamicDumpInfo is unsupported when a dynamic CDS archive is specified in -XX:SharedArchiveFile",
282 SharedArchiveFile);
283 }
284 if (ArchiveClassesAtExit != nullptr) {
285 vm_exit_during_initialization("-XX:ArchiveClassesAtExit is unsupported when a dynamic CDS archive is specified in -XX:SharedArchiveFile",
286 SharedArchiveFile);
287 }
288 }
289
290 if (ArchiveClassesAtExit != nullptr && os::same_files(SharedArchiveFile, ArchiveClassesAtExit)) {
291 vm_exit_during_initialization(
292 "Cannot have the same archive file specified for -XX:SharedArchiveFile and -XX:ArchiveClassesAtExit",
293 SharedArchiveFile);
294 }
295 }
296 }
297 }
298
299 void CDSConfig::check_internal_module_property(const char* key, const char* value) {
300 if (Arguments::is_incompatible_cds_internal_module_property(key)) {
301 stop_using_optimized_module_handling();
302 aot_log_info(aot)("optimized module handling: disabled due to incompatible property: %s=%s", key, value);
303 }
304 }
305
306 void CDSConfig::check_incompatible_property(const char* key, const char* value) {
307 static const char* incompatible_properties[] = {
308 "java.system.class.loader",
309 "jdk.module.showModuleResolution",
310 "jdk.module.validation"
311 };
312
313 for (const char* property : incompatible_properties) {
314 if (strcmp(key, property) == 0) {
315 stop_dumping_full_module_graph();
316 stop_using_full_module_graph();
317 aot_log_info(aot)("full module graph: disabled due to incompatible property: %s=%s", key, value);
318 break;
319 }
320 }
321
322 }
323
324 // Returns any JVM command-line option, such as "--patch-module", that's not supported by CDS.
325 static const char* find_any_unsupported_module_option() {
326 // Note that arguments.cpp has translated the command-line options into properties. If we find an
327 // unsupported property, translate it back to its command-line option for better error reporting.
328
329 // The following properties are checked by Arguments::is_internal_module_property() and cannot be
330 // directly specified in the command-line.
331 static const char* unsupported_module_properties[] = {
332 "jdk.module.limitmods",
333 "jdk.module.upgrade.path",
334 "jdk.module.patch.0"
335 };
336 static const char* unsupported_module_options[] = {
337 "--limit-modules",
338 "--upgrade-module-path",
339 "--patch-module"
340 };
341
342 assert(ARRAY_SIZE(unsupported_module_properties) == ARRAY_SIZE(unsupported_module_options), "must be");
343 SystemProperty* sp = Arguments::system_properties();
344 while (sp != nullptr) {
345 for (uint i = 0; i < ARRAY_SIZE(unsupported_module_properties); i++) {
346 if (strcmp(sp->key(), unsupported_module_properties[i]) == 0) {
347 return unsupported_module_options[i];
348 }
349 }
350 sp = sp->next();
351 }
352
353 return nullptr; // not found
354 }
355
356 void CDSConfig::check_unsupported_dumping_module_options() {
357 assert(is_dumping_archive(), "this function is only used with CDS dump time");
358 const char* option = find_any_unsupported_module_option();
359 if (option != nullptr) {
360 vm_exit_during_initialization("Cannot use the following option when dumping the shared archive", option);
361 }
362 // Check for an exploded module build in use with -Xshare:dump.
363 if (!Arguments::has_jimage()) {
364 vm_exit_during_initialization("Dumping the shared archive is not supported with an exploded module build");
365 }
366 }
367
368 bool CDSConfig::has_unsupported_runtime_module_options() {
369 assert(is_using_archive(), "this function is only used with -Xshare:{on,auto}");
370 if (ArchiveClassesAtExit != nullptr) {
371 // dynamic dumping, just return false for now.
372 // check_unsupported_dumping_properties() will be called later to check the same set of
373 // properties, and will exit the VM with the correct error message if the unsupported properties
374 // are used.
375 return false;
376 }
377 const char* option = find_any_unsupported_module_option();
378 if (option != nullptr) {
379 if (RequireSharedSpaces) {
380 warning("CDS is disabled when the %s option is specified.", option);
381 } else {
382 if (new_aot_flags_used()) {
383 aot_log_warning(aot)("AOT cache is disabled when the %s option is specified.", option);
384 } else {
385 aot_log_info(aot)("CDS is disabled when the %s option is specified.", option);
386 }
387 }
388 return true;
389 }
390 return false;
391 }
392
393 #define CHECK_NEW_FLAG(f) check_new_flag(FLAG_IS_DEFAULT(f), #f)
394
395 void CDSConfig::check_new_flag(bool new_flag_is_default, const char* new_flag_name) {
396 if (old_cds_flags_used() && !new_flag_is_default) {
397 vm_exit_during_initialization(err_msg("Option %s cannot be used at the same time with "
398 "-Xshare:on, -Xshare:auto, -Xshare:off, -Xshare:dump, "
399 "DumpLoadedClassList, SharedClassListFile, or SharedArchiveFile",
400 new_flag_name));
401 }
402 }
403
404 #define CHECK_SINGLE_PATH(f) check_flag_single_path(#f, f)
405
406 void CDSConfig::check_flag_single_path(const char* flag_name, const char* value) {
407 if (value != nullptr && num_archive_paths(value) != 1) {
408 vm_exit_during_initialization(err_msg("Option %s must specify a single file name", flag_name));
409 }
410 }
411
412 void CDSConfig::check_aot_flags() {
413 if (!FLAG_IS_DEFAULT(DumpLoadedClassList) ||
414 !FLAG_IS_DEFAULT(SharedClassListFile) ||
415 !FLAG_IS_DEFAULT(SharedArchiveFile)) {
416 _old_cds_flags_used = true;
417 }
418
419 // "New" AOT flags must not be mixed with "classic" CDS flags such as -Xshare:dump
420 CHECK_NEW_FLAG(AOTCache);
421 CHECK_NEW_FLAG(AOTCacheOutput);
422 CHECK_NEW_FLAG(AOTConfiguration);
423 CHECK_NEW_FLAG(AOTMode);
424
425 CHECK_SINGLE_PATH(AOTCache);
426 CHECK_SINGLE_PATH(AOTCacheOutput);
427 CHECK_SINGLE_PATH(AOTConfiguration);
428
429 if (FLAG_IS_DEFAULT(AOTCache) && AOTAdapterCaching) {
430 log_debug(aot,codecache,init)("AOTCache is not specified - AOTAdapterCaching is ignored");
431 }
432 if (FLAG_IS_DEFAULT(AOTCache) && AOTStubCaching) {
433 log_debug(aot,codecache,init)("AOTCache is not specified - AOTStubCaching is ignored");
434 }
435
436 bool has_cache = !FLAG_IS_DEFAULT(AOTCache);
437 bool has_cache_output = !FLAG_IS_DEFAULT(AOTCacheOutput);
438 bool has_config = !FLAG_IS_DEFAULT(AOTConfiguration);
439 bool has_mode = !FLAG_IS_DEFAULT(AOTMode);
440
441 if (!has_cache && !has_cache_output && !has_config && !has_mode) {
442 // AOT flags are not used. Use classic CDS workflow
443 return;
444 }
445
446 if (has_cache && has_cache_output) {
447 vm_exit_during_initialization("Only one of AOTCache or AOTCacheOutput can be specified");
448 }
449
450 if (!has_cache && (!has_mode || strcmp(AOTMode, "auto") == 0)) {
451 if (has_cache_output) {
452 // If AOTCacheOutput has been set, effective mode is "record".
453 // Default value for AOTConfiguration, if necessary, will be assigned in check_aotmode_record().
454 log_info(aot)("Selected AOTMode=record because AOTCacheOutput is specified");
455 FLAG_SET_ERGO(AOTMode, "record");
456 }
457 }
458
459 // At least one AOT flag has been used
460 _new_aot_flags_used = true;
461
462 if (FLAG_IS_DEFAULT(AOTMode) || strcmp(AOTMode, "auto") == 0 || strcmp(AOTMode, "on") == 0) {
463 check_aotmode_auto_or_on();
464 } else if (strcmp(AOTMode, "off") == 0) {
465 check_aotmode_off();
466 } else if (strcmp(AOTMode, "record") == 0) {
467 check_aotmode_record();
468 } else {
469 assert(strcmp(AOTMode, "create") == 0, "checked by AOTModeConstraintFunc");
470 check_aotmode_create();
471 }
472
473 // This is an old flag used by CDS regression testing only. It doesn't apply
474 // to the AOT workflow.
475 FLAG_SET_ERGO(AllowArchivingWithJavaAgent, false);
476 }
477
478 void CDSConfig::check_aotmode_off() {
479 UseSharedSpaces = false;
480 RequireSharedSpaces = false;
481 }
482
483 void CDSConfig::check_aotmode_auto_or_on() {
484 if (!FLAG_IS_DEFAULT(AOTConfiguration)) {
485 vm_exit_during_initialization(err_msg("AOTConfiguration can only be used with when AOTMode is record or create (selected AOTMode = %s)",
486 FLAG_IS_DEFAULT(AOTMode) ? "auto" : AOTMode));
487 }
488
489 UseSharedSpaces = true;
490 if (FLAG_IS_DEFAULT(AOTMode) || (strcmp(AOTMode, "auto") == 0)) {
491 RequireSharedSpaces = false;
492 } else {
493 assert(strcmp(AOTMode, "on") == 0, "already checked");
494 RequireSharedSpaces = true;
495 }
496 }
497
498 // %p substitution in AOTCache, AOTCacheOutput and AOTCacheConfiguration
499 static void substitute_aot_filename(JVMFlagsEnum flag_enum) {
500 JVMFlag* flag = JVMFlag::flag_from_enum(flag_enum);
501 const char* filename = flag->read<const char*>();
502 assert(filename != nullptr, "must not have default value");
503
504 // For simplicity, we don't allow %p/%t to be specified twice, because make_log_name()
505 // substitutes only the first occurrence. Otherwise, if we run with
506 // java -XX:AOTCacheOutput=%p%p.aot
507 // it will end up with both the pid of the training process and the assembly process.
508 const char* first_p = strstr(filename, "%p");
509 if (first_p != nullptr && strstr(first_p + 2, "%p") != nullptr) {
510 vm_exit_during_initialization(err_msg("%s cannot contain more than one %%p", flag->name()));
511 }
512 const char* first_t = strstr(filename, "%t");
513 if (first_t != nullptr && strstr(first_t + 2, "%t") != nullptr) {
514 vm_exit_during_initialization(err_msg("%s cannot contain more than one %%t", flag->name()));
515 }
516
517 // Note: with single-command training, %p will be the pid of the training process, not the
518 // assembly process.
519 const char* new_filename = make_log_name(filename, nullptr);
520 if (strcmp(filename, new_filename) != 0) {
521 JVMFlag::Error err = JVMFlagAccess::set_ccstr(flag, &new_filename, JVMFlagOrigin::ERGONOMIC);
522 assert(err == JVMFlag::SUCCESS, "must never fail");
523 }
524 FREE_C_HEAP_ARRAY(char, new_filename);
525 }
526
527 void CDSConfig::check_aotmode_record() {
528 bool has_config = !FLAG_IS_DEFAULT(AOTConfiguration);
529 bool has_output = !FLAG_IS_DEFAULT(AOTCacheOutput);
530
531 if (!has_output && !has_config) {
532 vm_exit_during_initialization("At least one of AOTCacheOutput and AOTConfiguration must be specified when using -XX:AOTMode=record");
533 }
534
535 if (has_output) {
536 _is_single_command_training = true;
537 substitute_aot_filename(FLAG_MEMBER_ENUM(AOTCacheOutput));
538 if (!has_config) {
539 // Too early; can't use resource allocation yet.
540 size_t len = strlen(AOTCacheOutput) + 10;
541 char* temp = AllocateHeap(len, mtArguments);
542 jio_snprintf(temp, len, "%s.config", AOTCacheOutput);
543 FLAG_SET_ERGO(AOTConfiguration, temp);
544 FreeHeap(temp);
545 _has_temp_aot_config_file = true;
546 }
547 }
548
549 if (!FLAG_IS_DEFAULT(AOTCache)) {
550 vm_exit_during_initialization("AOTCache must not be specified when using -XX:AOTMode=record");
551 }
552
553 substitute_aot_filename(FLAG_MEMBER_ENUM(AOTConfiguration));
554
555 UseSharedSpaces = false;
556 RequireSharedSpaces = false;
557 _is_dumping_static_archive = true;
558 _is_dumping_preimage_static_archive = true;
559
560 // At VM exit, the module graph may be contaminated with program states.
561 // We will rebuild the module graph when dumping the CDS final image.
562 disable_heap_dumping();
563 }
564
565 void CDSConfig::check_aotmode_create() {
566 if (FLAG_IS_DEFAULT(AOTConfiguration)) {
567 vm_exit_during_initialization("AOTConfiguration must be specified when using -XX:AOTMode=create");
568 }
569
570 bool has_cache = !FLAG_IS_DEFAULT(AOTCache);
571 bool has_cache_output = !FLAG_IS_DEFAULT(AOTCacheOutput);
572
573 assert(!(has_cache && has_cache_output), "already checked");
574
575 if (!has_cache && !has_cache_output) {
576 vm_exit_during_initialization("AOTCache or AOTCacheOutput must be specified when using -XX:AOTMode=create");
577 }
578
579 if (!has_cache) {
580 precond(has_cache_output);
581 FLAG_SET_ERGO(AOTCache, AOTCacheOutput);
582 }
583 // No need to check for (!has_cache_output), as we don't look at AOTCacheOutput after here.
584
585 substitute_aot_filename(FLAG_MEMBER_ENUM(AOTCache));
586
587 _is_dumping_final_static_archive = true;
588 UseSharedSpaces = true;
589 RequireSharedSpaces = true;
590
591 if (!FileMapInfo::is_preimage_static_archive(AOTConfiguration)) {
592 vm_exit_during_initialization("Must be a valid AOT configuration generated by the current JVM", AOTConfiguration);
593 }
594
595 CDSConfig::enable_dumping_static_archive();
596
597 // We don't load any agents in the assembly phase, so we can ensure that the agents
598 // cannot affect the contents of the AOT cache. E.g., we don't want the agents to
599 // redefine any cached classes. We also don't want the agents to modify heap objects that
600 // are cached.
601 //
602 // Since application is not executed in the assembly phase, there's no need to load
603 // the agents anyway -- no one will notice that the agents are not loaded.
604 log_info(aot)("Disabled all JVMTI agents during -XX:AOTMode=create");
605 JvmtiAgentList::disable_agent_list();
606 }
607
608 void CDSConfig::ergo_init_aot_paths() {
609 assert(_cds_ergo_initialize_started, "sanity");
610 if (is_dumping_static_archive()) {
611 if (is_dumping_preimage_static_archive()) {
612 _output_archive_path = AOTConfiguration;
613 } else {
614 assert(is_dumping_final_static_archive(), "must be");
615 _input_static_archive_path = AOTConfiguration;
616 _output_archive_path = AOTCache;
617 }
618 } else if (is_using_archive()) {
619 if (FLAG_IS_DEFAULT(AOTCache)) {
620 // Only -XX:AOTMode={auto,on} is specified
621 _input_static_archive_path = default_archive_path();
622 } else {
623 _input_static_archive_path = AOTCache;
624 }
625 }
626 }
627
628 bool CDSConfig::check_vm_args_consistency(bool patch_mod_javabase, bool mode_flag_cmd_line) {
629 assert(!_cds_ergo_initialize_started, "This is called earlier than CDSConfig::ergo_initialize()");
630
631 check_aot_flags();
632
633 if (!FLAG_IS_DEFAULT(AOTMode)) {
634 // Using any form of the new AOTMode switch enables enhanced optimizations.
635 FLAG_SET_ERGO_IF_DEFAULT(AOTClassLinking, true);
636 }
637
638 setup_compiler_args();
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 if (is_dumping_classic_static_archive() && AOTClassLinking) {
719 if (JvmtiAgentList::disable_agent_list()) {
720 FLAG_SET_ERGO(AllowArchivingWithJavaAgent, false);
721 log_warning(cds)("Disabled all JVMTI agents with -Xshare:dump -XX:+AOTClassLinking");
722 }
723 }
724
725 return true;
726 }
727
728 void CDSConfig::setup_compiler_args() {
729 // AOT profiles and AOT-compiled code are supported only in the JEP 483 workflow.
730 bool can_dump_profile_and_compiled_code = AOTClassLinking && new_aot_flags_used();
731
732 if (is_dumping_preimage_static_archive() && can_dump_profile_and_compiled_code) {
733 // JEP 483 workflow -- training
734 FLAG_SET_ERGO_IF_DEFAULT(AOTRecordTraining, true);
735 FLAG_SET_ERGO(AOTReplayTraining, false);
736 AOTCodeCache::disable_caching(); // No AOT code generation during training run
737 } else if (is_dumping_final_static_archive() && can_dump_profile_and_compiled_code) {
738 // JEP 483 workflow -- assembly
739 FLAG_SET_ERGO(AOTRecordTraining, false);
740 FLAG_SET_ERGO_IF_DEFAULT(AOTReplayTraining, true);
741 AOTCodeCache::enable_caching(); // Generate AOT code during assembly phase.
742 disable_dumping_aot_code(); // Don't dump AOT code until metadata and heap are dumped.
743 } else if (is_using_archive() && new_aot_flags_used()) {
744 // JEP 483 workflow -- production
745 FLAG_SET_ERGO(AOTRecordTraining, false);
746 FLAG_SET_ERGO_IF_DEFAULT(AOTReplayTraining, true);
747 AOTCodeCache::enable_caching();
748 } else {
749 FLAG_SET_ERGO(AOTReplayTraining, false);
750 FLAG_SET_ERGO(AOTRecordTraining, false);
751 AOTCodeCache::disable_caching();
752 }
753 }
754
755 void CDSConfig::prepare_for_dumping() {
756 assert(CDSConfig::is_dumping_archive(), "sanity");
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 != nullptr && (t->is_VM_thread() || t == _dumper_thread);
865 }
866
867 const char* CDSConfig::type_of_archive_being_loaded() {
868 if (is_dumping_final_static_archive()) {
869 return "AOT configuration file";
870 } else if (new_aot_flags_used()) {
871 return "AOT cache";
872 } else {
873 return "shared archive file";
874 }
875 }
876
877 const char* CDSConfig::type_of_archive_being_written() {
878 if (is_dumping_preimage_static_archive()) {
879 return "AOT configuration file";
880 } else if (new_aot_flags_used()) {
881 return "AOT cache";
882 } else {
883 return "shared archive file";
884 }
885 }
886
887 // If an incompatible VM options is found, return a text message that explains why
888 static const char* check_options_incompatible_with_dumping_heap() {
889 #if INCLUDE_CDS_JAVA_HEAP
890 if (!UseCompressedClassPointers) {
891 return "UseCompressedClassPointers must be true";
892 }
893
894 // Almost all GCs support heap region dump, except ZGC (so far).
895 if (UseZGC) {
896 return "ZGC is not supported";
897 }
898
899 return nullptr;
900 #else
901 return "JVM not configured for writing Java heap objects";
902 #endif
903 }
904
905 void CDSConfig::log_reasons_for_not_dumping_heap() {
906 const char* reason;
907
908 assert(!is_dumping_heap(), "sanity");
909
910 if (_disable_heap_dumping) {
911 reason = "Programmatically disabled";
912 } else {
913 reason = check_options_incompatible_with_dumping_heap();
914 }
915
916 assert(reason != nullptr, "sanity");
917 aot_log_info(aot)("Archived java heap is not supported: %s", reason);
918 }
919
920 // This is *Legacy* optimization for lambdas before JEP 483. May be removed in the future.
921 bool CDSConfig::is_dumping_lambdas_in_legacy_mode() {
922 return !is_dumping_method_handles();
923 }
924
925 #if INCLUDE_CDS_JAVA_HEAP
926 bool CDSConfig::are_vm_options_incompatible_with_dumping_heap() {
927 return check_options_incompatible_with_dumping_heap() != nullptr;
928 }
929
930 bool CDSConfig::is_dumping_heap() {
931 if (!(is_dumping_classic_static_archive() || is_dumping_final_static_archive())
932 || are_vm_options_incompatible_with_dumping_heap()
933 || _disable_heap_dumping) {
934 return false;
935 }
936 return true;
937 }
938
939 bool CDSConfig::is_loading_heap() {
940 return ArchiveHeapLoader::is_in_use();
941 }
942
943 bool CDSConfig::is_using_full_module_graph() {
944 if (ClassLoaderDataShared::is_full_module_graph_loaded()) {
945 return true;
946 }
947
948 if (!_is_using_full_module_graph) {
949 return false;
950 }
951
952 if (is_using_archive() && ArchiveHeapLoader::can_use()) {
953 // Classes used by the archived full module graph are loaded in JVMTI early phase.
954 assert(!(JvmtiExport::should_post_class_file_load_hook() && JvmtiExport::has_early_class_hook_env()),
955 "CDS should be disabled if early class hooks are enabled");
956 return true;
957 } else {
958 _is_using_full_module_graph = false;
959 return false;
960 }
961 }
962
963 void CDSConfig::stop_dumping_full_module_graph(const char* reason) {
964 if (_is_dumping_full_module_graph) {
965 _is_dumping_full_module_graph = false;
966 if (reason != nullptr) {
967 aot_log_info(aot)("full module graph cannot be dumped: %s", reason);
968 }
969 }
970 }
971
972 void CDSConfig::stop_using_full_module_graph(const char* reason) {
973 assert(!ClassLoaderDataShared::is_full_module_graph_loaded(), "you call this function too late!");
974 if (_is_using_full_module_graph) {
975 _is_using_full_module_graph = false;
976 if (reason != nullptr) {
977 aot_log_info(aot)("full module graph cannot be loaded: %s", reason);
978 }
979 }
980 }
981
982 bool CDSConfig::is_dumping_aot_linked_classes() {
983 if (is_dumping_preimage_static_archive()) {
984 return false;
985 } else if (is_dumping_dynamic_archive()) {
986 return is_using_full_module_graph() && AOTClassLinking;
987 } else if (is_dumping_static_archive()) {
988 return is_dumping_full_module_graph() && AOTClassLinking;
989 } else {
990 return false;
991 }
992 }
993
994 bool CDSConfig::is_using_aot_linked_classes() {
995 // Make sure we have the exact same module graph as in the assembly phase, or else
996 // some aot-linked classes may not be visible so cannot be loaded.
997 return is_using_full_module_graph() && _has_aot_linked_classes;
998 }
999
1000 void CDSConfig::set_has_aot_linked_classes(bool has_aot_linked_classes) {
1001 _has_aot_linked_classes |= has_aot_linked_classes;
1002 }
1003
1004 bool CDSConfig::is_initing_classes_at_dump_time() {
1005 return is_dumping_heap() && is_dumping_aot_linked_classes();
1006 }
1007
1008 bool CDSConfig::is_dumping_invokedynamic() {
1009 // Requires is_dumping_aot_linked_classes(). Otherwise the classes of some archived heap
1010 // objects used by the archive indy callsites may be replaced at runtime.
1011 return AOTInvokeDynamicLinking && is_dumping_aot_linked_classes() && is_dumping_heap();
1012 }
1013
1014 // When we are dumping aot-linked classes and we are able to write archived heap objects, we automatically
1015 // enable the archiving of MethodHandles. This will in turn enable the archiving of MethodTypes and hidden
1016 // classes that are used in the implementation of MethodHandles.
1017 // Archived MethodHandles are required for higher-level optimizations such as AOT resolution of invokedynamic
1018 // and dynamic proxies.
1019 bool CDSConfig::is_dumping_method_handles() {
1020 return is_initing_classes_at_dump_time();
1021 }
1022
1023 #endif // INCLUDE_CDS_JAVA_HEAP
1024
1025 // AOT code generation and its archiving is disabled by default.
1026 // We enable it only in the final image dump after the metadata and heap are dumped.
1027 // This affects only JITed code because it may have embedded oops and metadata pointers
1028 // which AOT code encodes as offsets in final CDS archive regions.
1029
1030 static bool _is_dumping_aot_code = false;
1031
1032 bool CDSConfig::is_dumping_aot_code() {
1033 return _is_dumping_aot_code;
1034 }
1035
1036 void CDSConfig::disable_dumping_aot_code() {
1037 _is_dumping_aot_code = false;
1038 }
1039
1040 void CDSConfig::enable_dumping_aot_code() {
1041 _is_dumping_aot_code = true;
1042 }
1043
1044 bool CDSConfig::is_dumping_adapters() {
1045 return (AOTAdapterCaching && is_dumping_final_static_archive());
1046 }