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