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 extern void perf_jvm_print_on(outputStream* st);
 63 extern void perf_deoptimization_print_on(outputStream* st);
 64 
 65 extern void log_vm_init_stats(bool use_tty);
 66 
 67 // This is defined in linkType.cpp due to linking restraints
 68 extern bool is_vm_statically_linked();
 69 
 70 /**
 71  * With the integration of the changes to handle the version string
 72  * as defined by JEP-223, most of the code related to handle the version
 73  * string prior to JDK 1.6 was removed (partial initialization)
 74  */
 75 class JDK_Version {
 76   friend class VMStructs;
 77   friend class Universe;
 78   friend void JDK_Version_init();
 79  private:
 80 
 81   static JDK_Version _current;
 82   static const char* _java_version;
 83   static const char* _runtime_name;
 84   static const char* _runtime_version;
 85   static const char* _runtime_vendor_version;
 86   static const char* _runtime_vendor_vm_bug_url;
 87 
 88   int _major;
 89   int _minor;
 90   int _security;
 91   int _patch;
 92   int _build;
 93 
 94   bool is_valid() const {
 95     return (_major != 0);
 96   }
 97 
 98   // initializes or partially initializes the _current static field
 99   static void initialize();
100 
101  public:
102 
103   JDK_Version() :
104       _major(0), _minor(0), _security(0), _patch(0), _build(0)
105       {}
106 
107   JDK_Version(int major, int minor = 0, int security = 0,
108               int patch = 0, int build = 0) :
109       _major(major), _minor(minor), _security(security), _patch(patch), _build(build)
110       {}
111 
112   // Returns the current running JDK version
113   static JDK_Version current() { return _current; }
114 
115   // Factory methods for convenience
116   static JDK_Version jdk(int m) {
117     return JDK_Version(m);
118   }
119 
120   static JDK_Version undefined() {
121     return JDK_Version(0);
122   }
123 
124   bool is_undefined() const {
125     return _major == 0;
126   }
127 
128   int major_version() const          { return _major; }
129   int minor_version() const          { return _minor; }
130   int security_version() const       { return _security; }
131   int patch_version() const          { return _patch; }
132   int build_number() const           { return _build; }
133 
134   // Performs a full ordering comparison using all fields (patch, build, etc.)
135   int compare(const JDK_Version& other) const;
136 
137   void to_string(char* buffer, size_t buflen) const;
138 
139   static const char* java_version() {
140     return _java_version;
141   }
142   static void set_java_version(const char* version) {
143     _java_version = os::strdup(version);
144   }
145 
146   static const char* runtime_name() {
147     return _runtime_name;
148   }
149   static void set_runtime_name(const char* name) {
150     _runtime_name = os::strdup(name);
151   }
152 
153   static const char* runtime_version() {
154     return _runtime_version;
155   }
156   static void set_runtime_version(const char* version) {
157     _runtime_version = os::strdup(version);
158   }
159 
160   static const char* runtime_vendor_version() {
161     return _runtime_vendor_version;
162   }
163   static void set_runtime_vendor_version(const char* vendor_version) {
164     _runtime_vendor_version = os::strdup(vendor_version);
165   }
166 
167   static const char* runtime_vendor_vm_bug_url() {
168     return _runtime_vendor_vm_bug_url;
169   }
170   static void set_runtime_vendor_vm_bug_url(const char* vendor_vm_bug_url) {
171     _runtime_vendor_vm_bug_url = os::strdup(vendor_vm_bug_url);
172   }
173 
174 };
175 
176 #endif // SHARE_RUNTIME_JAVA_HPP