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