1 /*
 2  * Copyright (c) 2023, 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 char*  _default_archive_path;
40   static char*  _static_archive_path;
41   static char*  _dynamic_archive_path;
42 #endif
43 
44   static void extract_shared_archive_paths(const char* archive_path,
45                                            char** base_archive_path,
46                                            char** top_archive_path);
47   static void init_shared_archive_paths();
48   static bool check_unsupported_cds_runtime_properties();
49 
50 public:
51   // Initialization and command-line checking
52   static void initialize() NOT_CDS_RETURN;
53   static void check_system_property(const char* key, const char* value) NOT_CDS_RETURN;
54   static void check_unsupported_dumping_properties() NOT_CDS_RETURN;
55   static bool check_vm_args_consistency(bool patch_mod_javabase,  bool mode_flag_cmd_line) NOT_CDS_RETURN_(false);
56 
57   // Basic CDS features
58   static bool      is_dumping_archive()                      { return is_dumping_static_archive() || is_dumping_dynamic_archive(); }
59   static bool      is_dumping_static_archive()               { return CDS_ONLY(_is_dumping_static_archive) NOT_CDS(false); }
60   static void  enable_dumping_static_archive()               { CDS_ONLY(_is_dumping_static_archive = true); }
61   static bool      is_dumping_dynamic_archive()              { return CDS_ONLY(_is_dumping_dynamic_archive) NOT_CDS(false); }
62   static void  enable_dumping_dynamic_archive()              { CDS_ONLY(_is_dumping_dynamic_archive = true); }
63   static void disable_dumping_dynamic_archive()              { CDS_ONLY(_is_dumping_dynamic_archive = false); }
64 
65   // Archive paths
66   // Points to the classes.jsa in $JAVA_HOME
67   static char* default_archive_path()                         NOT_CDS_RETURN_(nullptr);
68   // The actual static archive  (if any) selected at runtime
69   static const char* static_archive_path()                   { return CDS_ONLY(_static_archive_path) NOT_CDS(nullptr); }
70   // The actual dynamic archive  (if any) selected at runtime
71   static const char* dynamic_archive_path()                  { return CDS_ONLY(_dynamic_archive_path) NOT_CDS(nullptr); }
72 
73   static int num_archives(const char* archive_path)          NOT_CDS_RETURN_(0);
74 
75 
76   // CDS archived heap
77   static bool      is_dumping_heap()                         NOT_CDS_JAVA_HEAP_RETURN_(false);
78   static void disable_dumping_full_module_graph(const char* reason = nullptr) NOT_CDS_JAVA_HEAP_RETURN;
79   static bool      is_dumping_full_module_graph()            NOT_CDS_JAVA_HEAP_RETURN_(false);
80   static void disable_loading_full_module_graph(const char* reason = nullptr) NOT_CDS_JAVA_HEAP_RETURN;
81   static bool      is_loading_full_module_graph()            NOT_CDS_JAVA_HEAP_RETURN_(false);
82 
83 };
84 
85 #endif // SHARE_CDS_CDSCONFIG_HPP