1 /*
2 * Copyright (c) 1997, 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_RUNTIME_JAVA_HPP
26 #define SHARE_RUNTIME_JAVA_HPP
27
28 #include "runtime/os.hpp"
29 #include "utilities/globalDefinitions.hpp"
30
31 class Handle;
32 class JavaThread;
33 class Symbol;
34
35 // Execute code before all handles are released and thread is killed; prologue to vm_exit
36 extern void before_exit(JavaThread * thread, bool halt = false);
37
38 // Forced VM exit (i.e, internal error or JVM_Exit)
39 extern void vm_exit(int code);
40
41 // Wrapper for ::exit()
42 extern void vm_direct_exit(int code);
43 extern void vm_direct_exit(int code, const char* message);
44
45 // Shutdown the VM but do not exit the process
46 extern void vm_shutdown();
47 // Shutdown the VM and abort the process
48 extern void vm_abort(bool dump_core=true);
49
50 // Trigger any necessary notification of the VM being shutdown
51 extern void notify_vm_shutdown();
52
53 // VM exit if error occurs during initialization of VM
54 extern void vm_exit_during_initialization();
55 extern void vm_exit_during_initialization(Handle exception);
56 extern void vm_exit_during_initialization(Symbol* exception_name, const char* message);
57 extern void vm_exit_during_initialization(const char* error, const char* message = nullptr);
58 extern void vm_shutdown_during_initialization(const char* error, const char* message = nullptr);
59
60 extern void vm_exit_during_cds_dumping(const char* error, const char* message = nullptr);
61
62 // This is defined in linkType.cpp due to linking restraints
63 extern bool is_vm_statically_linked();
64
65 /**
66 * With the integration of the changes to handle the version string
67 * as defined by JEP-223, most of the code related to handle the version
68 * string prior to JDK 1.6 was removed (partial initialization)
69 */
70 class JDK_Version {
71 friend class VMStructs;
72 friend class Universe;
73 friend void JDK_Version_init();
74 private:
75
76 static JDK_Version _current;
77 static const char* _java_version;
78 static const char* _runtime_name;
79 static const char* _runtime_version;
80 static const char* _runtime_vendor_version;
81 static const char* _runtime_vendor_vm_bug_url;
82
83 int _major;
84 int _minor;
85 int _security;
86 int _patch;
87 int _build;
88
89 bool is_valid() const {
90 return (_major != 0);
91 }
92
93 // initializes or partially initializes the _current static field
94 static void initialize();
95
96 public:
97
98 JDK_Version() :
99 _major(0), _minor(0), _security(0), _patch(0), _build(0)
100 {}
101
102 JDK_Version(int major, int minor = 0, int security = 0,
103 int patch = 0, int build = 0) :
104 _major(major), _minor(minor), _security(security), _patch(patch), _build(build)
105 {}
106
107 // Returns the current running JDK version
108 static JDK_Version current() { return _current; }
109
110 // Factory methods for convenience
111 static JDK_Version jdk(int m) {
112 return JDK_Version(m);
113 }
114
115 static JDK_Version undefined() {
116 return JDK_Version(0);
117 }
118
119 bool is_undefined() const {
120 return _major == 0;
121 }
122
123 int major_version() const { return _major; }
124 int minor_version() const { return _minor; }
125 int security_version() const { return _security; }
126 int patch_version() const { return _patch; }
127 int build_number() const { return _build; }
128
129 // Performs a full ordering comparison using all fields (patch, build, etc.)
130 int compare(const JDK_Version& other) const;
131
132 void to_string(char* buffer, size_t buflen) const;
133
134 static const char* java_version() {
135 return _java_version;
136 }
137 static void set_java_version(const char* version) {
138 _java_version = os::strdup(version);
139 }
140
141 static const char* runtime_name() {
142 return _runtime_name;
143 }
144 static void set_runtime_name(const char* name) {
145 _runtime_name = os::strdup(name);
146 }
147
148 static const char* runtime_version() {
149 return _runtime_version;
150 }
151 static void set_runtime_version(const char* version) {
152 _runtime_version = os::strdup(version);
153 }
154
155 static const char* runtime_vendor_version() {
156 return _runtime_vendor_version;
157 }
158 static void set_runtime_vendor_version(const char* vendor_version) {
159 _runtime_vendor_version = os::strdup(vendor_version);
160 }
161
162 static const char* runtime_vendor_vm_bug_url() {
163 return _runtime_vendor_vm_bug_url;
164 }
165 static void set_runtime_vendor_vm_bug_url(const char* vendor_vm_bug_url) {
166 _runtime_vendor_vm_bug_url = os::strdup(vendor_vm_bug_url);
167 }
168
169 };
170
171 #endif // SHARE_RUNTIME_JAVA_HPP