1 /*
2 * Copyright (c) 1997, 2010, 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_VM_RUNTIME_JAVA_HPP
26 #define SHARE_VM_RUNTIME_JAVA_HPP
27
28 #include "runtime/os.hpp"
29
30 // Register function to be called by before_exit
31 extern "C" { void register_on_exit_function(void (*func)(void)) ;}
32
33 // Execute code before all handles are released and thread is killed; prologue to vm_exit
34 extern void before_exit(JavaThread * thread);
35
36 // Forced VM exit (i.e, internal error or JVM_Exit)
37 extern void vm_exit(int code);
38
39 // Wrapper for ::exit()
40 extern void vm_direct_exit(int code);
41
42 // Shutdown the VM but do not exit the process
43 extern void vm_shutdown();
44 // Shutdown the VM and abort the process
45 extern void vm_abort(bool dump_core=true);
46
47 // Trigger any necessary notification of the VM being shutdown
48 extern void notify_vm_shutdown();
49
50 // VM exit if error occurs during initialization of VM
51 extern void vm_exit_during_initialization(Handle exception);
52 extern void vm_exit_during_initialization(symbolHandle exception_name, const char* message);
53 extern void vm_exit_during_initialization(const char* error, const char* message = NULL);
54 extern void vm_shutdown_during_initialization(const char* error, const char* message = NULL);
55
56 /**
57 * Discovering the JDK_Version during initialization is tricky when the
58 * running JDK is less than JDK6. For JDK6 and greater, a "GetVersion"
59 * function exists in libjava.so and we simply call it during the
60 * 'initialize()' call to find the version. For JDKs with version < 6, no
61 * such call exists and we have to probe the JDK in order to determine
62 * the exact version. This probing cannot happen during late in
63 * the VM initialization process so there's a period of time during
64 * initialization when we don't know anything about the JDK version other than
65 * that it less than version 6. This is the "partially initialized" time,
66 * when we can answer only certain version queries (such as, is the JDK
67 * version greater than 5? Answer: no). Once the JDK probing occurs, we
68 * know the version and are considered fully initialized.
69 */
70 class JDK_Version VALUE_OBJ_CLASS_SPEC {
71 friend class VMStructs;
72 friend class Universe;
73 friend void JDK_Version_init();
74 private:
75
76 static JDK_Version _current;
77
78 // In this class, we promote the minor version of release to be the
79 // major version for releases >= 5 in anticipation of the JDK doing the
80 // same thing. For example, we represent "1.5.0" as major version 5 (we
81 // drop the leading 1 and use 5 as the 'major').
82
83 uint8_t _major;
84 uint8_t _minor;
85 uint8_t _micro;
86 uint8_t _update;
87 uint8_t _special;
88 uint8_t _build;
89
90 // If partially initialized, the above fields are invalid and we know
91 // that we're less than major version 6.
92 bool _partially_initialized;
93
94 bool _thread_park_blocker;
95
96 bool is_valid() const {
97 return (_major != 0 || _partially_initialized);
98 }
99
100 // initializes or partially initializes the _current static field
101 static void initialize();
102
103 // Completes initialization for a pre-JDK6 version.
104 static void fully_initialize(uint8_t major, uint8_t minor = 0,
105 uint8_t micro = 0, uint8_t update = 0);
106
107 public:
108
109 // Returns true if the the current version has only been partially initialized
110 static bool is_partially_initialized() {
111 return _current._partially_initialized;
112 }
113
114 JDK_Version() : _major(0), _minor(0), _micro(0), _update(0),
115 _special(0), _build(0), _partially_initialized(false),
116 _thread_park_blocker(false) {}
117
118 JDK_Version(uint8_t major, uint8_t minor = 0, uint8_t micro = 0,
119 uint8_t update = 0, uint8_t special = 0, uint8_t build = 0,
120 bool thread_park_blocker = false) :
121 _major(major), _minor(minor), _micro(micro), _update(update),
122 _special(special), _build(build), _partially_initialized(false),
123 _thread_park_blocker(thread_park_blocker) {}
124
125 // Returns the current running JDK version
126 static JDK_Version current() { return _current; }
127
128 // Factory methods for convenience
129 static JDK_Version jdk(uint8_t m) {
130 return JDK_Version(m);
131 }
132
133 static JDK_Version jdk_update(uint8_t major, uint8_t update_number) {
134 return JDK_Version(major, 0, 0, update_number);
135 }
136
137 uint8_t major_version() const { return _major; }
138 uint8_t minor_version() const { return _minor; }
139 uint8_t micro_version() const { return _micro; }
140 uint8_t update_version() const { return _update; }
141 uint8_t special_update_version() const { return _special; }
142 uint8_t build_number() const { return _build; }
143
144 bool supports_thread_park_blocker() const {
145 return _thread_park_blocker;
146 }
147
148 // Performs a full ordering comparison using all fields (update, build, etc.)
149 int compare(const JDK_Version& other) const;
150
151 /**
152 * Performs comparison using only the major version, returning negative
153 * if the major version of 'this' is less than the parameter, 0 if it is
154 * equal, and a positive value if it is greater.
155 */
156 int compare_major(int version) const {
157 if (_partially_initialized) {
158 if (version >= 6) {
159 return -1;
160 } else {
161 assert(false, "Can't make this comparison during init time");
162 return -1; // conservative
163 }
164 } else {
165 return major_version() - version;
166 }
167 }
168
169 void to_string(char* buffer, size_t buflen) const;
170
171 // Convenience methods for queries on the current major/minor version
172 static bool is_jdk12x_version() {
173 return current().compare_major(2) == 0;
174 }
175
176 static bool is_jdk13x_version() {
177 return current().compare_major(3) == 0;
178 }
179
180 static bool is_jdk14x_version() {
181 return current().compare_major(4) == 0;
182 }
183
184 static bool is_jdk15x_version() {
185 return current().compare_major(5) == 0;
186 }
187
188 static bool is_jdk16x_version() {
189 return current().compare_major(6) == 0;
190 }
191
192 static bool is_jdk17x_version() {
193 return current().compare_major(7) == 0;
194 }
195
196 static bool is_gte_jdk13x_version() {
197 return current().compare_major(3) >= 0;
198 }
199
200 static bool is_gte_jdk14x_version() {
201 return current().compare_major(4) >= 0;
202 }
203
204 static bool is_gte_jdk15x_version() {
205 return current().compare_major(5) >= 0;
206 }
207
208 static bool is_gte_jdk16x_version() {
209 return current().compare_major(6) >= 0;
210 }
211
212 static bool is_gte_jdk17x_version() {
213 return current().compare_major(7) >= 0;
214 }
215 };
216
217 #endif // SHARE_VM_RUNTIME_JAVA_HPP