1 /*
2 * Copyright (c) 2023, 2024, 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 #ifndef SHARE_CDS_CDSCONFIG_HPP
26 #define SHARE_CDS_CDSCONFIG_HPP
27
28 #include "memory/allStatic.hpp"
29 #include "utilities/globalDefinitions.hpp"
30 #include "utilities/macros.hpp"
31
32 class CDSConfig : public AllStatic {
33 #if INCLUDE_CDS
34 static bool _is_dumping_static_archive;
35 static bool _is_dumping_dynamic_archive;
36 static bool _dumping_full_module_graph_disabled;
37 static bool _loading_full_module_graph_disabled;
38
39 static bool _module_patching_disables_cds;
40 static bool _java_base_module_patching_disables_cds;
41
42 static char* _default_archive_path;
43 static char* _static_archive_path;
44 static char* _dynamic_archive_path;
45 #endif
46
47 static void extract_shared_archive_paths(const char* archive_path,
48 char** base_archive_path,
49 char** top_archive_path);
50 static void init_shared_archive_paths();
51 static bool check_unsupported_cds_runtime_properties();
52
53 public:
54 // Initialization and command-line checking
55 static void initialize() NOT_CDS_RETURN;
56 static void check_system_property(const char* key, const char* value) NOT_CDS_RETURN;
57 static void check_unsupported_dumping_properties() NOT_CDS_RETURN;
58 static bool check_vm_args_consistency(bool mode_flag_cmd_line) NOT_CDS_RETURN_(true);
59
60 static bool module_patching_disables_cds() { return _module_patching_disables_cds; }
61 static void set_module_patching_disables_cds() { _module_patching_disables_cds = true; }
62 static bool java_base_module_patching_disables_cds() { return _java_base_module_patching_disables_cds; }
63 static void set_java_base_module_patching_disables_cds() { _java_base_module_patching_disables_cds = true; }
64
65 // Basic CDS features
66 static bool is_dumping_archive() { return is_dumping_static_archive() || is_dumping_dynamic_archive(); }
67 static bool is_dumping_static_archive() { return CDS_ONLY(_is_dumping_static_archive) NOT_CDS(false); }
68 static void enable_dumping_static_archive() { CDS_ONLY(_is_dumping_static_archive = true); }
69 static bool is_dumping_dynamic_archive() { return CDS_ONLY(_is_dumping_dynamic_archive) NOT_CDS(false); }
70 static void enable_dumping_dynamic_archive() { CDS_ONLY(_is_dumping_dynamic_archive = true); }
71 static void disable_dumping_dynamic_archive() { CDS_ONLY(_is_dumping_dynamic_archive = false); }
72
73 // Archive paths
74 // Points to the classes.jsa in $JAVA_HOME
75 static char* default_archive_path() NOT_CDS_RETURN_(nullptr);
76 // The actual static archive (if any) selected at runtime
77 static const char* static_archive_path() { return CDS_ONLY(_static_archive_path) NOT_CDS(nullptr); }
78 // The actual dynamic archive (if any) selected at runtime
79 static const char* dynamic_archive_path() { return CDS_ONLY(_dynamic_archive_path) NOT_CDS(nullptr); }
80
81 static int num_archives(const char* archive_path) NOT_CDS_RETURN_(0);
82
83
84 // CDS archived heap
85 static bool is_dumping_heap() NOT_CDS_JAVA_HEAP_RETURN_(false);
86 static void disable_dumping_full_module_graph(const char* reason = nullptr) NOT_CDS_JAVA_HEAP_RETURN;
87 static bool is_dumping_full_module_graph() NOT_CDS_JAVA_HEAP_RETURN_(false);
88 static void disable_loading_full_module_graph(const char* reason = nullptr) NOT_CDS_JAVA_HEAP_RETURN;
89 static bool is_loading_full_module_graph() NOT_CDS_JAVA_HEAP_RETURN_(false);
90
91 static bool is_valhalla_preview();
92 };
93
94 #endif // SHARE_CDS_CDSCONFIG_HPP