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 InstanceKlass;
 33 
 34 class CDSConfig : public AllStatic {
 35 #if INCLUDE_CDS
 36   static bool _is_dumping_static_archive;
 37   static bool _is_dumping_dynamic_archive;
 38   static bool _is_using_optimized_module_handling;
 39   static bool _is_dumping_full_module_graph;
 40   static bool _is_using_full_module_graph;
 41   static bool _has_aot_linked_classes;
 42   static bool _has_archived_invokedynamic;
 43   static bool _is_loading_packages;
 44   static bool _is_loading_protection_domains;
 45 
 46   static bool _is_security_manager_allowed;
 47 
 48   static char* _default_archive_path;
 49   static char* _static_archive_path;
 50   static char* _dynamic_archive_path;
 51 
 52   static bool  _old_cds_flags_used;
 53 #endif
 54 
 55   static void extract_shared_archive_paths(const char* archive_path,
 56                                            char** base_archive_path,
 57                                            char** top_archive_path);
 58   static void init_shared_archive_paths();
 59 
 60   static void check_flag_alias(bool alias_is_default, const char* alias_name);
 61   static void check_flag_aliases();
 62 
 63 public:
 64   // Used by jdk.internal.misc.CDS.getCDSConfigStatus();
 65   static const int IS_DUMPING_ARCHIVE              = 1 << 0;
 66   static const int IS_DUMPING_STATIC_ARCHIVE       = 1 << 1;
 67   static const int IS_LOGGING_LAMBDA_FORM_INVOKERS = 1 << 2;
 68   static const int IS_USING_ARCHIVE                = 1 << 3;
 69   static const int IS_DUMPING_HEAP                 = 1 << 4;
 70   static const int IS_LOGGING_DYNAMIC_PROXIES      = 1 << 5;
 71   static const int IS_DUMPING_PACKAGES             = 1 << 6;
 72   static const int IS_DUMPING_PROTECTION_DOMAINS   = 1 << 7;
 73   static int get_status() NOT_CDS_RETURN_(0);
 74 
 75   // Initialization and command-line checking
 76   static void initialize() NOT_CDS_RETURN;
 77   static void set_old_cds_flags_used() { CDS_ONLY(_old_cds_flags_used = true); }
 78   static void check_internal_module_property(const char* key, const char* value) NOT_CDS_RETURN;
 79   static void check_incompatible_property(const char* key, const char* value) NOT_CDS_RETURN;
 80   static void check_unsupported_dumping_module_options() NOT_CDS_RETURN;
 81   static bool has_unsupported_runtime_module_options() NOT_CDS_RETURN_(false);
 82   static bool check_vm_args_consistency(bool patch_mod_javabase, bool mode_flag_cmd_line, bool xshare_auto_cmd_line) NOT_CDS_RETURN_(true);
 83 
 84   // --- Basic CDS features
 85 
 86   // archive(s) in general
 87   static bool is_dumping_archive()                           { return is_dumping_static_archive() || is_dumping_dynamic_archive(); }
 88   static bool is_using_archive()                             NOT_CDS_RETURN_(false);
 89   static int num_archives(const char* archive_path)          NOT_CDS_RETURN_(0);
 90 
 91   // static_archive
 92   static bool is_dumping_static_archive()                    { return (CDS_ONLY(_is_dumping_static_archive) NOT_CDS(false))
 93                                                                     || is_dumping_final_static_archive(); }
 94   static void enable_dumping_static_archive()                { CDS_ONLY(_is_dumping_static_archive = true); }
 95 
 96   static bool is_dumping_classic_static_archive()            NOT_CDS_RETURN_(false); // -Xshare:dump
 97   static bool is_dumping_preimage_static_archive()           NOT_CDS_RETURN_(false); // 1st phase of -XX:CacheDataStore dumping
 98   static bool is_dumping_final_static_archive()              NOT_CDS_RETURN_(false); // 2nd phase of -XX:CacheDataStore dumping
 99 
100   // dynamic_archive
101   static bool is_dumping_dynamic_archive()                   { return CDS_ONLY(_is_dumping_dynamic_archive) NOT_CDS(false); }
102   static void enable_dumping_dynamic_archive()               { CDS_ONLY(_is_dumping_dynamic_archive = true); }
103   static void disable_dumping_dynamic_archive()              { CDS_ONLY(_is_dumping_dynamic_archive = false); }
104 
105   // Misc CDS features
106   static bool preserve_all_dumptime_verification_states(const InstanceKlass* ik);
107   static bool allow_only_single_java_thread()                NOT_CDS_RETURN_(false);
108 
109   // optimized_module_handling -- can we skip some expensive operations related to modules?
110   static bool is_using_optimized_module_handling()           { return CDS_ONLY(_is_using_optimized_module_handling) NOT_CDS(false); }
111   static void stop_using_optimized_module_handling()         NOT_CDS_RETURN;
112 
113   static bool is_logging_lambda_form_invokers()              NOT_CDS_RETURN_(false);
114   static bool is_dumping_regenerated_lambdaform_invokers()   NOT_CDS_RETURN_(false);
115 
116   static bool is_dumping_aot_linked_classes()                NOT_CDS_JAVA_HEAP_RETURN_(false);
117   static bool is_using_aot_linked_classes()                  NOT_CDS_JAVA_HEAP_RETURN_(false);
118   static void set_has_aot_linked_classes(bool is_static_archive, bool has_aot_linked_classes) NOT_CDS_JAVA_HEAP_RETURN;
119 
120   // archive_path
121 
122   // Points to the classes.jsa in $JAVA_HOME
123   static char* default_archive_path()                        NOT_CDS_RETURN_(nullptr);
124   // The actual static archive  (if any) selected at runtime
125   static const char* static_archive_path()                   { return CDS_ONLY(_static_archive_path) NOT_CDS(nullptr); }
126   // The actual dynamic archive  (if any) selected at runtime
127   static const char* dynamic_archive_path()                  { return CDS_ONLY(_dynamic_archive_path) NOT_CDS(nullptr); }
128 
129   // --- Archived java objects
130 
131   static bool is_dumping_heap()                              NOT_CDS_JAVA_HEAP_RETURN_(false);
132   static bool is_loading_heap()                              NOT_CDS_JAVA_HEAP_RETURN_(false);
133   static bool is_initing_classes_at_dump_time()              NOT_CDS_JAVA_HEAP_RETURN_(false);
134 
135   static bool is_dumping_invokedynamic()                     NOT_CDS_JAVA_HEAP_RETURN_(false);
136   static bool is_loading_invokedynamic()                     NOT_CDS_JAVA_HEAP_RETURN_(false);
137   static void set_has_archived_invokedynamic()               { CDS_JAVA_HEAP_ONLY(_has_archived_invokedynamic = true); }
138 
139   static bool is_dumping_packages()                          NOT_CDS_JAVA_HEAP_RETURN_(false);
140   static bool is_loading_packages()                          NOT_CDS_JAVA_HEAP_RETURN_(false);
141   static void set_is_loading_packages()                      { CDS_JAVA_HEAP_ONLY(_is_loading_packages = true); }
142 
143   static bool is_dumping_protection_domains()                NOT_CDS_JAVA_HEAP_RETURN_(false);
144   static bool is_loading_protection_domains()                NOT_CDS_JAVA_HEAP_RETURN_(false);
145   static void set_is_loading_protection_domains()            { CDS_JAVA_HEAP_ONLY(_is_loading_protection_domains = true); }
146 
147   static bool is_dumping_reflection_data()                   NOT_CDS_JAVA_HEAP_RETURN_(false);
148 
149   static bool is_dumping_dynamic_proxies()                   NOT_CDS_JAVA_HEAP_RETURN_(false);
150   static bool is_logging_dynamic_proxies()                   NOT_CDS_RETURN_(false);
151 
152   // full_module_graph (requires optimized_module_handling)
153   static bool is_dumping_full_module_graph()                 { return CDS_ONLY(_is_dumping_full_module_graph) NOT_CDS(false); }
154   static bool is_using_full_module_graph()                   NOT_CDS_JAVA_HEAP_RETURN_(false);
155   static void stop_dumping_full_module_graph(const char* reason = nullptr) NOT_CDS_JAVA_HEAP_RETURN;
156   static void stop_using_full_module_graph(const char* reason = nullptr) NOT_CDS_JAVA_HEAP_RETURN;
157 
158   // --- AOT compiler
159 
160   static bool is_dumping_cached_code()                       NOT_CDS_RETURN_(false);
161   static void disable_dumping_cached_code()                  NOT_CDS_RETURN;
162   static void enable_dumping_cached_code()                   NOT_CDS_RETURN;
163 
164 };
165 
166 #endif // SHARE_CDS_CDSCONFIG_HPP