1 /*
2 * Copyright (c) 1998, 2025, 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_UTILITIES_EXCEPTIONS_HPP
26 #define SHARE_UTILITIES_EXCEPTIONS_HPP
27
28 #include "memory/allocation.hpp"
29 #include "oops/oopsHierarchy.hpp"
30 #include "utilities/ostream.hpp"
31 #include "utilities/sizes.hpp"
32
33 // This file provides the basic support for exception handling in the VM.
34 // Note: We do not use C++ exceptions to avoid compiler dependencies and
35 // unpredictable performance.
36 //
37 // Scheme: Exceptions are stored with the thread. There is never more
38 // than one pending exception per thread. All functions that can throw
39 // an exception carry a THREAD argument (usually the last argument and
40 // declared with the TRAPS macro). Throwing an exception means setting
41 // a pending exception in the thread. Upon return from a function that
42 // can throw an exception, we must check if an exception is pending.
43 // The CHECK macros do this in a convenient way. Carrying around the
44 // thread provides also convenient access to it (e.g. for Handle
45 // creation, w/o the need for recomputation).
46
47
48
49 // Forward declarations to be independent of the include structure.
50
51 class JavaThread;
52 class Handle;
53 class Symbol;
54 class JavaCallArguments;
55 class methodHandle;
56
57 // The ThreadShadow class is a helper class to access the _pending_exception
58 // field of the Thread class w/o having access to the Thread's interface (for
59 // include hierarchy reasons).
60
61 class ThreadShadow: public CHeapObj<mtThread> {
62 friend class VMStructs;
63 friend class JVMCIVMStructs;
64
65 protected:
66 oop _pending_exception; // Thread has gc actions.
67 const char* _exception_file; // file information for exception (debugging only)
68 int _exception_line; // line information for exception (debugging only)
69 friend void check_ThreadShadow(); // checks _pending_exception offset
70
71 // The following virtual exists only to force creation of a vtable.
72 // We need ThreadShadow to have a vtable, even in product builds,
73 // so that its layout will start at an offset of zero relative to Thread.
74 // Some C++ compilers are so "clever" that they put the ThreadShadow
75 // base class at offset 4 in Thread (after Thread's vtable), if they
76 // notice that Thread has a vtable but ThreadShadow does not.
77 virtual void unused_initial_virtual() { }
78
79 public:
80 oop pending_exception() const { return _pending_exception; }
81 bool has_pending_exception() const { return _pending_exception != nullptr; }
82 const char* exception_file() const { return _exception_file; }
83 int exception_line() const { return _exception_line; }
84
85 // Code generation support
86 static ByteSize pending_exception_offset() { return byte_offset_of(ThreadShadow, _pending_exception); }
87
88 // use THROW whenever possible!
89 void set_pending_exception(oop exception, const char* file, int line);
90
91 // use CLEAR_PENDING_EXCEPTION whenever possible!
92 void clear_pending_exception();
93
94 // use CLEAR_PENDING_NONASYNC_EXCEPTION to clear probable nonasync exception.
95 void clear_pending_nonasync_exception();
96
97 void set_pending_preempted_exception();
98 void clear_pending_preempted_exception();
99 void check_preempted_exception() NOT_DEBUG_RETURN;
100
101 ThreadShadow() : _pending_exception(nullptr),
102 _exception_file(nullptr), _exception_line(0) {}
103 };
104
105
106 // Exceptions is a helper class that encapsulates all operations
107 // that require access to the thread interface and which are
108 // relatively rare. The Exceptions operations should only be
109 // used directly if the macros below are insufficient.
110
111 class Exceptions {
112 // Either `exception` or `symbol` must be non-null but not both.
113 static bool special_exception(JavaThread* thread, const char* file, int line, Handle exception, Symbol* name = nullptr, const char* message = nullptr);
114
115 // Count out of memory errors that are interesting in error diagnosis
116 static volatile int _out_of_memory_error_java_heap_errors;
117 static volatile int _out_of_memory_error_metaspace_errors;
118 static volatile int _out_of_memory_error_class_metaspace_errors;
119
120 // Count linkage errors
121 static volatile int _linkage_errors;
122 public:
123 // this enum is defined to indicate whether it is safe to
124 // ignore the encoding scheme of the original message string.
125 typedef enum {
126 safe_to_utf8 = 0,
127 unsafe_to_utf8 = 1
128 } ExceptionMsgToUtf8Mode;
129 // Throw exceptions: w/o message, w/ message & with formatted message.
130 static void _throw_oop(JavaThread* thread, const char* file, int line, oop exception);
131 static void _throw(JavaThread* thread, const char* file, int line, Handle exception, const char* msg = nullptr);
132
133 static void _throw_msg(JavaThread* thread, const char* file, int line, Symbol* name, const char* message);
134 static void _throw_msg(JavaThread* thread, const char* file, int line, Symbol* name, const char* message,
135 Handle loader);
136
137 static void _throw_msg_cause(JavaThread* thread, const char* file, int line, Symbol* name, const char* message, Handle h_cause);
138 static void _throw_msg_cause(JavaThread* thread, const char* file, int line, Symbol* name, const char* message, Handle h_cause,
139 Handle h_loader);
140
141 static void _throw_cause(JavaThread* thread, const char* file, int line, Symbol* name, Handle h_cause);
142 static void _throw_cause(JavaThread* thread, const char* file, int line, Symbol* name, Handle h_cause,
143 Handle h_loader);
144
145 static void _throw_args(JavaThread* thread, const char* file, int line,
146 Symbol* name, Symbol* signature,
147 JavaCallArguments* args);
148
149 // There is no THROW... macro for this method. Caller should remember
150 // to do a return after calling it.
151 static void fthrow(JavaThread* thread, const char* file, int line, Symbol* name,
152 const char* format, ...) ATTRIBUTE_PRINTF(5, 6);
153
154 // Create and initialize a new exception
155 static Handle new_exception(JavaThread* thread, Symbol* name,
156 Symbol* signature, JavaCallArguments* args,
157 Handle loader);
158
159 static Handle new_exception(JavaThread* thread, Symbol* name,
160 Symbol* signature, JavaCallArguments* args,
161 Handle cause,
162 Handle loader);
163
164 static Handle new_exception(JavaThread* thread, Symbol* name,
165 Handle cause,
166 Handle loader,
167 ExceptionMsgToUtf8Mode to_utf8_safe = safe_to_utf8);
168
169 static Handle new_exception(JavaThread* thread, Symbol* name,
170 const char* message, Handle cause,
171 Handle loader,
172 ExceptionMsgToUtf8Mode to_utf8_safe = safe_to_utf8);
173
174 static Handle new_exception(JavaThread* thread, Symbol* name,
175 const char* message,
176 ExceptionMsgToUtf8Mode to_utf8_safe = safe_to_utf8);
177
178 static void throw_stack_overflow_exception(JavaThread* thread, const char* file, int line, const methodHandle& method);
179
180 static void wrap_dynamic_exception(bool is_indy, JavaThread* thread);
181
182 // Exception counting for error files of interesting exceptions that may have
183 // caused a problem for the jvm
184 static volatile int _stack_overflow_errors;
185
186 static bool has_exception_counts();
187 static void count_out_of_memory_exceptions(Handle exception);
188 static void print_exception_counts_on_error(outputStream* st);
189
190 // for AbortVMOnException flag
191 static void debug_check_abort(Handle exception, const char* message = nullptr);
192 static void debug_check_abort_helper(Handle exception, const char* message = nullptr);
193 static void debug_check_abort(const char *value_string, const char* message = nullptr);
194
195 // for logging exceptions
196 static void log_exception(Handle exception, const char* message);
197 static void log_exception_stacktrace(Handle exception);
198 static void log_exception_stacktrace(Handle exception, methodHandle method, int bci);
199 };
200
201
202 // The THREAD & TRAPS macros facilitate the declaration of functions that throw exceptions.
203 // Convention: Use the TRAPS macro as the last argument of such a function; e.g.:
204 //
205 // int this_function_may_trap(int x, float y, TRAPS)
206
207 #define THREAD __the_thread__
208 #define TRAPS JavaThread* THREAD
209
210
211 // The CHECK... macros should be used to pass along a THREAD reference and to check for pending
212 // exceptions. In special situations it is necessary to handle pending exceptions explicitly,
213 // in these cases the PENDING_EXCEPTION helper macros should be used.
214 //
215 // Macro naming conventions: Macros that end with _ require a result value to be returned. They
216 // are for functions with non-void result type. The result value is usually ignored because of
217 // the exception and is only needed for syntactic correctness. The _0 ending is a shortcut for
218 // _(0) since this is a frequent case. Example:
219 //
220 // int result = this_function_may_trap(x_arg, y_arg, CHECK_0);
221 //
222 // CAUTION: make sure that the function call using a CHECK macro is not the only statement of a
223 // conditional branch w/o enclosing {} braces, since the CHECK macros expand into several state-
224 // ments! Also make sure it is not used on a function call that is part of a return statement!
225
226 #define PENDING_EXCEPTION (((ThreadShadow*)THREAD)->pending_exception())
227 #define HAS_PENDING_EXCEPTION (((ThreadShadow*)THREAD)->has_pending_exception())
228 #define CLEAR_PENDING_EXCEPTION (((ThreadShadow*)THREAD)->clear_pending_exception())
229
230 #define CHECK THREAD); if (HAS_PENDING_EXCEPTION) return ; (void)(0
231 #define CHECK_(result) THREAD); if (HAS_PENDING_EXCEPTION) return result; (void)(0
232 #define CHECK_0 CHECK_(0)
233 #define CHECK_NH CHECK_(Handle())
234 #define CHECK_NULL CHECK_(nullptr)
235 #define CHECK_false CHECK_(false)
236 #define CHECK_JNI_ERR CHECK_(JNI_ERR)
237 #define CHECK_PREEMPTABLE THREAD); if (HAS_PENDING_EXCEPTION) { THREAD->check_preempted_exception(); return; } (void)(0
238 #define CHECK_PREEMPTABLE_false THREAD); if (HAS_PENDING_EXCEPTION) { THREAD->check_preempted_exception(); return false; } (void)(0
239
240 // CAUTION: These macros clears all exceptions including async exceptions, use it with caution.
241 #define CHECK_AND_CLEAR THREAD); if (HAS_PENDING_EXCEPTION) { CLEAR_PENDING_EXCEPTION; return; } (void)(0
242 #define CHECK_AND_CLEAR_(result) THREAD); if (HAS_PENDING_EXCEPTION) { CLEAR_PENDING_EXCEPTION; return result; } (void)(0
243 #define CHECK_AND_CLEAR_0 CHECK_AND_CLEAR_(0)
244 #define CHECK_AND_CLEAR_NH CHECK_AND_CLEAR_(Handle())
245 #define CHECK_AND_CLEAR_NULL CHECK_AND_CLEAR_(nullptr)
246 #define CHECK_AND_CLEAR_false CHECK_AND_CLEAR_(false)
247
248 // CAUTION: These macros clears all exceptions except probable async exceptions j.l.InternalError.
249 // So use it with caution.
250 #define CLEAR_PENDING_NONASYNC_EXCEPTION (((ThreadShadow*)THREAD)->clear_pending_nonasync_exception())
251 #define CHECK_AND_CLEAR_NONASYNC THREAD); if (HAS_PENDING_EXCEPTION) { CLEAR_PENDING_NONASYNC_EXCEPTION; return; } (void)(0
252 #define CHECK_AND_CLEAR_NONASYNC_(result) THREAD); if (HAS_PENDING_EXCEPTION) { CLEAR_PENDING_NONASYNC_EXCEPTION; return result; } (void)(0
253 #define CHECK_AND_CLEAR_NONASYNC_0 CHECK_AND_CLEAR_NONASYNC_(0)
254 #define CHECK_AND_CLEAR_NONASYNC_NH CHECK_AND_CLEAR_NONASYNC_(Handle())
255 #define CHECK_AND_CLEAR_NONASYNC_NULL CHECK_AND_CLEAR_NONASYNC_(nullptr)
256 #define CHECK_AND_CLEAR_NONASYNC_false CHECK_AND_CLEAR_NONASYNC_(false)
257
258 #define CLEAR_PENDING_PREEMPTED_EXCEPTION (((ThreadShadow*)THREAD)->clear_pending_preempted_exception())
259 #define CHECK_AND_CLEAR_PREEMPTED THREAD); if (HAS_PENDING_EXCEPTION) { CLEAR_PENDING_PREEMPTED_EXCEPTION; return; } (void)(0
260
261
262 // The THROW... macros should be used to throw an exception. They require a THREAD variable to be
263 // visible within the scope containing the THROW. Usually this is achieved by declaring the function
264 // with a TRAPS argument.
265
266 #define THREAD_AND_LOCATION THREAD, __FILE__, __LINE__
267
268 #define THROW_OOP(e) \
269 { Exceptions::_throw_oop(THREAD_AND_LOCATION, e); return; }
270
271 #define THROW_HANDLE(e) \
272 { Exceptions::_throw(THREAD_AND_LOCATION, e); return; }
273
274 #define THROW(name) \
275 { Exceptions::_throw_msg(THREAD_AND_LOCATION, name, nullptr); return; }
276
277 #define THROW_MSG(name, message) \
278 { Exceptions::_throw_msg(THREAD_AND_LOCATION, name, message); return; }
279
280 #define THROW_CAUSE(name, cause) \
281 { Exceptions::_throw_cause(THREAD_AND_LOCATION, name, cause); return; }
282
283 #define THROW_MSG_LOADER(name, message, loader) \
284 { Exceptions::_throw_msg(THREAD_AND_LOCATION, name, message, loader); return; }
285
286 #define THROW_ARG(name, signature, args) \
287 { Exceptions::_throw_args(THREAD_AND_LOCATION, name, signature, args); return; }
288
289 #define THROW_OOP_(e, result) \
290 { Exceptions::_throw_oop(THREAD_AND_LOCATION, e); return result; }
291
292 #define THROW_HANDLE_(e, result) \
293 { Exceptions::_throw(THREAD_AND_LOCATION, e); return result; }
294
295 #define THROW_(name, result) \
296 { Exceptions::_throw_msg(THREAD_AND_LOCATION, name, nullptr); return result; }
297
298 #define THROW_MSG_(name, message, result) \
299 { Exceptions::_throw_msg(THREAD_AND_LOCATION, name, message); return result; }
300
301 #define THROW_MSG_LOADER_(name, message, loader, result) \
302 { Exceptions::_throw_msg(THREAD_AND_LOCATION, name, message, loader); return result; }
303
304 #define THROW_ARG_(name, signature, args, result) \
305 { Exceptions::_throw_args(THREAD_AND_LOCATION, name, signature, args); return result; }
306
307 #define THROW_MSG_CAUSE(name, message, cause) \
308 { Exceptions::_throw_msg_cause(THREAD_AND_LOCATION, name, message, cause); return; }
309
310 #define THROW_MSG_CAUSE_(name, message, cause, result) \
311 { Exceptions::_throw_msg_cause(THREAD_AND_LOCATION, name, message, cause); return result; }
312
313
314 #define THROW_OOP_0(e) THROW_OOP_(e, 0)
315 #define THROW_HANDLE_0(e) THROW_HANDLE_(e, 0)
316 #define THROW_0(name) THROW_(name, 0)
317 #define THROW_MSG_0(name, message) THROW_MSG_(name, message, 0)
318 #define THROW_WRAPPED_0(name, oop_to_wrap) THROW_WRAPPED_(name, oop_to_wrap, 0)
319 #define THROW_ARG_0(name, signature, arg) THROW_ARG_(name, signature, arg, 0)
320 #define THROW_MSG_CAUSE_0(name, message, cause) THROW_MSG_CAUSE_(name, message, cause, 0)
321 #define THROW_MSG_CAUSE_NULL(name, message, cause) THROW_MSG_CAUSE_(name, message, cause, nullptr)
322
323 #define THROW_NULL(name) THROW_(name, nullptr)
324 #define THROW_MSG_NULL(name, message) THROW_MSG_(name, message, nullptr)
325
326 #define THROW_HANDLE_NULL(e) THROW_HANDLE_(e, nullptr)
327 #define THROW_ARG_NULL(name, signature, arg) THROW_ARG_(name, signature, arg, nullptr)
328
329 // The CATCH macro checks that no exception has been thrown by a function; it is used at
330 // call sites about which is statically known that the callee cannot throw an exception
331 // even though it is declared with TRAPS.
332
333 #define CATCH \
334 THREAD); if (HAS_PENDING_EXCEPTION) { \
335 oop ex = PENDING_EXCEPTION; \
336 CLEAR_PENDING_EXCEPTION; \
337 DEBUG_ONLY(ex->print();) \
338 assert(false, "CATCH"); \
339 } (void)(0
340
341 // ExceptionMark is a stack-allocated helper class for local exception handling.
342 // It is used with the EXCEPTION_MARK macro.
343
344 class ExceptionMark {
345 private:
346 JavaThread* _thread;
347 inline void check_no_pending_exception();
348
349 public:
350 ExceptionMark();
351 ExceptionMark(JavaThread* thread);
352 ~ExceptionMark();
353
354 JavaThread* thread() {
355 return _thread;
356 }
357 };
358
359 // Use an EXCEPTION_MARK for 'local' exceptions. EXCEPTION_MARK makes sure that no
360 // pending exception exists upon entering its scope and tests that no pending exception
361 // exists when leaving the scope.
362
363 // See also preserveException.hpp for PreserveExceptionMark
364 // which preserves pre-existing exceptions and does not allow new
365 // exceptions.
366
367 #define EXCEPTION_MARK ExceptionMark __em; JavaThread* THREAD = __em.thread();
368
369 #endif // SHARE_UTILITIES_EXCEPTIONS_HPP