src/share/vm/utilities/exceptions.hpp

Tue, 24 Jul 2018 13:22:11 +0800

author
aoqi
date
Tue, 24 Jul 2018 13:22:11 +0800
changeset 9137
dc1769738300
parent 6876
710a3c8b516e
child 9448
73d689add964
permissions
-rw-r--r--

#7048 added Loongson release info to hs_err crash files

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 1998, 2014, Oracle and/or its affiliates. All rights reserved.
aoqi@0 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0 4 *
aoqi@0 5 * This code is free software; you can redistribute it and/or modify it
aoqi@0 6 * under the terms of the GNU General Public License version 2 only, as
aoqi@0 7 * published by the Free Software Foundation.
aoqi@0 8 *
aoqi@0 9 * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0 12 * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0 13 * accompanied this code).
aoqi@0 14 *
aoqi@0 15 * You should have received a copy of the GNU General Public License version
aoqi@0 16 * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0 18 *
aoqi@0 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0 20 * or visit www.oracle.com if you need additional information or have any
aoqi@0 21 * questions.
aoqi@0 22 *
aoqi@0 23 */
aoqi@0 24
aoqi@0 25 #ifndef SHARE_VM_UTILITIES_EXCEPTIONS_HPP
aoqi@0 26 #define SHARE_VM_UTILITIES_EXCEPTIONS_HPP
aoqi@0 27
aoqi@0 28 #include "memory/allocation.hpp"
aoqi@0 29 #include "oops/oopsHierarchy.hpp"
aoqi@0 30 #include "utilities/sizes.hpp"
aoqi@0 31
aoqi@0 32 // This file provides the basic support for exception handling in the VM.
aoqi@0 33 // Note: We do not use C++ exceptions to avoid compiler dependencies and
aoqi@0 34 // unpredictable performance.
aoqi@0 35 //
aoqi@0 36 // Scheme: Exceptions are stored with the thread. There is never more
aoqi@0 37 // than one pending exception per thread. All functions that can throw
aoqi@0 38 // an exception carry a THREAD argument (usually the last argument and
aoqi@0 39 // declared with the TRAPS macro). Throwing an exception means setting
aoqi@0 40 // a pending exception in the thread. Upon return from a function that
aoqi@0 41 // can throw an exception, we must check if an exception is pending.
aoqi@0 42 // The CHECK macros do this in a convenient way. Carrying around the
aoqi@0 43 // thread provides also convenient access to it (e.g. for Handle
aoqi@0 44 // creation, w/o the need for recomputation).
aoqi@0 45
aoqi@0 46
aoqi@0 47
aoqi@0 48 // Forward declarations to be independent of the include structure.
aoqi@0 49 // This allows us to have exceptions.hpp included in top.hpp.
aoqi@0 50
aoqi@0 51 class Thread;
aoqi@0 52 class Handle;
aoqi@0 53 class Symbol;
aoqi@0 54 class JavaCallArguments;
aoqi@0 55
aoqi@0 56 // The ThreadShadow class is a helper class to access the _pending_exception
aoqi@0 57 // field of the Thread class w/o having access to the Thread's interface (for
aoqi@0 58 // include hierachy reasons).
aoqi@0 59
aoqi@0 60 class ThreadShadow: public CHeapObj<mtThread> {
aoqi@0 61 friend class VMStructs;
aoqi@0 62
aoqi@0 63 protected:
aoqi@0 64 oop _pending_exception; // Thread has gc actions.
aoqi@0 65 const char* _exception_file; // file information for exception (debugging only)
aoqi@0 66 int _exception_line; // line information for exception (debugging only)
aoqi@0 67 friend void check_ThreadShadow(); // checks _pending_exception offset
aoqi@0 68
aoqi@0 69 // The following virtual exists only to force creation of a vtable.
aoqi@0 70 // We need ThreadShadow to have a vtable, even in product builds,
aoqi@0 71 // so that its layout will start at an offset of zero relative to Thread.
aoqi@0 72 // Some C++ compilers are so "clever" that they put the ThreadShadow
aoqi@0 73 // base class at offset 4 in Thread (after Thread's vtable), if they
aoqi@0 74 // notice that Thread has a vtable but ThreadShadow does not.
aoqi@0 75 virtual void unused_initial_virtual() { }
aoqi@0 76
aoqi@0 77 public:
aoqi@0 78 oop pending_exception() const { return _pending_exception; }
aoqi@0 79 bool has_pending_exception() const { return _pending_exception != NULL; }
aoqi@0 80 const char* exception_file() const { return _exception_file; }
aoqi@0 81 int exception_line() const { return _exception_line; }
aoqi@0 82
aoqi@0 83 // Code generation support
aoqi@0 84 static ByteSize pending_exception_offset() { return byte_offset_of(ThreadShadow, _pending_exception); }
aoqi@0 85
aoqi@0 86 // use THROW whenever possible!
aoqi@0 87 void set_pending_exception(oop exception, const char* file, int line);
aoqi@0 88
aoqi@0 89 // use CLEAR_PENDING_EXCEPTION whenever possible!
aoqi@0 90 void clear_pending_exception();
aoqi@0 91
aoqi@0 92 ThreadShadow() : _pending_exception(NULL),
aoqi@0 93 _exception_file(NULL), _exception_line(0) {}
aoqi@0 94 };
aoqi@0 95
aoqi@0 96
aoqi@0 97 // Exceptions is a helper class that encapsulates all operations
aoqi@0 98 // that require access to the thread interface and which are
aoqi@0 99 // relatively rare. The Exceptions operations should only be
aoqi@0 100 // used directly if the macros below are insufficient.
aoqi@0 101
aoqi@0 102 class Exceptions {
aoqi@0 103 static bool special_exception(Thread *thread, const char* file, int line, Handle exception);
aoqi@0 104 static bool special_exception(Thread* thread, const char* file, int line, Symbol* name, const char* message);
aoqi@0 105 public:
aoqi@0 106 // this enum is defined to indicate whether it is safe to
aoqi@0 107 // ignore the encoding scheme of the original message string.
aoqi@0 108 typedef enum {
aoqi@0 109 safe_to_utf8 = 0,
aoqi@0 110 unsafe_to_utf8 = 1
aoqi@0 111 } ExceptionMsgToUtf8Mode;
aoqi@0 112 // Throw exceptions: w/o message, w/ message & with formatted message.
aoqi@0 113 static void _throw_oop(Thread* thread, const char* file, int line, oop exception);
aoqi@0 114 static void _throw(Thread* thread, const char* file, int line, Handle exception, const char* msg = NULL);
aoqi@0 115
aoqi@0 116 static void _throw_msg(Thread* thread, const char* file, int line, Symbol* name, const char* message);
aoqi@0 117 static void _throw_msg(Thread* thread, const char* file, int line, Symbol* name, const char* message,
aoqi@0 118 Handle loader, Handle protection_domain);
aoqi@0 119
aoqi@0 120 static void _throw_msg_cause(Thread* thread, const char* file, int line, Symbol* name, const char* message, Handle h_cause);
aoqi@0 121 static void _throw_msg_cause(Thread* thread, const char* file, int line, Symbol* name, const char* message, Handle h_cause,
aoqi@0 122 Handle h_loader, Handle h_protection_domain);
aoqi@0 123
aoqi@0 124 static void _throw_cause(Thread* thread, const char* file, int line, Symbol* name, Handle h_cause);
aoqi@0 125 static void _throw_cause(Thread* thread, const char* file, int line, Symbol* name, Handle h_cause,
aoqi@0 126 Handle h_loader, Handle h_protection_domain);
aoqi@0 127
aoqi@0 128 static void _throw_args(Thread* thread, const char* file, int line,
aoqi@0 129 Symbol* name, Symbol* signature,
aoqi@0 130 JavaCallArguments* args);
aoqi@0 131
aoqi@0 132 // There is no THROW... macro for this method. Caller should remember
aoqi@0 133 // to do a return after calling it.
aoqi@0 134 static void fthrow(Thread* thread, const char* file, int line, Symbol* name,
aoqi@0 135 const char* format, ...) ATTRIBUTE_PRINTF(5, 6);
aoqi@0 136
aoqi@0 137 // Create and initialize a new exception
aoqi@0 138 static Handle new_exception(Thread* thread, Symbol* name,
aoqi@0 139 Symbol* signature, JavaCallArguments* args,
aoqi@0 140 Handle loader, Handle protection_domain);
aoqi@0 141
aoqi@0 142 static Handle new_exception(Thread* thread, Symbol* name,
aoqi@0 143 Symbol* signature, JavaCallArguments* args,
aoqi@0 144 Handle cause,
aoqi@0 145 Handle loader, Handle protection_domain);
aoqi@0 146
aoqi@0 147 static Handle new_exception(Thread* thread, Symbol* name,
aoqi@0 148 Handle cause,
aoqi@0 149 Handle loader, Handle protection_domain,
aoqi@0 150 ExceptionMsgToUtf8Mode to_utf8_safe = safe_to_utf8);
aoqi@0 151
aoqi@0 152 static Handle new_exception(Thread* thread, Symbol* name,
aoqi@0 153 const char* message, Handle cause,
aoqi@0 154 Handle loader, Handle protection_domain,
aoqi@0 155 ExceptionMsgToUtf8Mode to_utf8_safe = safe_to_utf8);
aoqi@0 156
aoqi@0 157 static Handle new_exception(Thread* thread, Symbol* name,
aoqi@0 158 const char* message,
aoqi@0 159 ExceptionMsgToUtf8Mode to_utf8_safe = safe_to_utf8);
aoqi@0 160
aoqi@0 161 static void throw_stack_overflow_exception(Thread* thread, const char* file, int line, methodHandle method);
aoqi@0 162
aoqi@0 163 // for AbortVMOnException flag
aoqi@0 164 NOT_PRODUCT(static void debug_check_abort(Handle exception, const char* message = NULL);)
aoqi@0 165 NOT_PRODUCT(static void debug_check_abort(const char *value_string, const char* message = NULL);)
aoqi@0 166 };
aoqi@0 167
aoqi@0 168
aoqi@0 169 // The THREAD & TRAPS macros facilitate the declaration of functions that throw exceptions.
aoqi@0 170 // Convention: Use the TRAPS macro as the last argument of such a function; e.g.:
aoqi@0 171 //
aoqi@0 172 // int this_function_may_trap(int x, float y, TRAPS)
aoqi@0 173
aoqi@0 174 #define THREAD __the_thread__
aoqi@0 175 #define TRAPS Thread* THREAD
aoqi@0 176
aoqi@0 177
aoqi@0 178 // The CHECK... macros should be used to pass along a THREAD reference and to check for pending
aoqi@0 179 // exceptions. In special situations it is necessary to handle pending exceptions explicitly,
aoqi@0 180 // in these cases the PENDING_EXCEPTION helper macros should be used.
aoqi@0 181 //
aoqi@0 182 // Macro naming conventions: Macros that end with _ require a result value to be returned. They
aoqi@0 183 // are for functions with non-void result type. The result value is usually ignored because of
aoqi@0 184 // the exception and is only needed for syntactic correctness. The _0 ending is a shortcut for
aoqi@0 185 // _(0) since this is a frequent case. Example:
aoqi@0 186 //
aoqi@0 187 // int result = this_function_may_trap(x_arg, y_arg, CHECK_0);
aoqi@0 188 //
aoqi@0 189 // CAUTION: make sure that the function call using a CHECK macro is not the only statement of a
aoqi@0 190 // conditional branch w/o enclosing {} braces, since the CHECK macros expand into several state-
aoqi@0 191 // ments!
aoqi@0 192
aoqi@0 193 #define PENDING_EXCEPTION (((ThreadShadow*)THREAD)->pending_exception())
aoqi@0 194 #define HAS_PENDING_EXCEPTION (((ThreadShadow*)THREAD)->has_pending_exception())
aoqi@0 195 #define CLEAR_PENDING_EXCEPTION (((ThreadShadow*)THREAD)->clear_pending_exception())
aoqi@0 196
aoqi@0 197 #define CHECK THREAD); if (HAS_PENDING_EXCEPTION) return ; (void)(0
aoqi@0 198 #define CHECK_(result) THREAD); if (HAS_PENDING_EXCEPTION) return result; (void)(0
aoqi@0 199 #define CHECK_0 CHECK_(0)
aoqi@0 200 #define CHECK_NH CHECK_(Handle())
aoqi@0 201 #define CHECK_NULL CHECK_(NULL)
aoqi@0 202 #define CHECK_false CHECK_(false)
aoqi@0 203
aoqi@0 204 #define CHECK_AND_CLEAR THREAD); if (HAS_PENDING_EXCEPTION) { CLEAR_PENDING_EXCEPTION; return; } (void)(0
aoqi@0 205 #define CHECK_AND_CLEAR_(result) THREAD); if (HAS_PENDING_EXCEPTION) { CLEAR_PENDING_EXCEPTION; return result; } (void)(0
aoqi@0 206 #define CHECK_AND_CLEAR_0 CHECK_AND_CLEAR_(0)
aoqi@0 207 #define CHECK_AND_CLEAR_NH CHECK_AND_CLEAR_(Handle())
aoqi@0 208 #define CHECK_AND_CLEAR_NULL CHECK_AND_CLEAR_(NULL)
aoqi@0 209 #define CHECK_AND_CLEAR_false CHECK_AND_CLEAR_(false)
aoqi@0 210
aoqi@0 211 // The THROW... macros should be used to throw an exception. They require a THREAD variable to be
aoqi@0 212 // visible within the scope containing the THROW. Usually this is achieved by declaring the function
aoqi@0 213 // with a TRAPS argument.
aoqi@0 214
aoqi@0 215 #define THREAD_AND_LOCATION THREAD, __FILE__, __LINE__
aoqi@0 216
aoqi@0 217 #define THROW_OOP(e) \
aoqi@0 218 { Exceptions::_throw_oop(THREAD_AND_LOCATION, e); return; }
aoqi@0 219
aoqi@0 220 #define THROW_HANDLE(e) \
aoqi@0 221 { Exceptions::_throw(THREAD_AND_LOCATION, e); return; }
aoqi@0 222
aoqi@0 223 #define THROW(name) \
aoqi@0 224 { Exceptions::_throw_msg(THREAD_AND_LOCATION, name, NULL); return; }
aoqi@0 225
aoqi@0 226 #define THROW_MSG(name, message) \
aoqi@0 227 { Exceptions::_throw_msg(THREAD_AND_LOCATION, name, message); return; }
aoqi@0 228
aoqi@0 229 #define THROW_CAUSE(name, cause) \
aoqi@0 230 { Exceptions::_throw_cause(THREAD_AND_LOCATION, name, cause); return; }
aoqi@0 231
aoqi@0 232 #define THROW_MSG_LOADER(name, message, loader, protection_domain) \
aoqi@0 233 { Exceptions::_throw_msg(THREAD_AND_LOCATION, name, message, loader, protection_domain); return; }
aoqi@0 234
aoqi@0 235 #define THROW_ARG(name, signature, args) \
aoqi@0 236 { Exceptions::_throw_args(THREAD_AND_LOCATION, name, signature, args); return; }
aoqi@0 237
aoqi@0 238 #define THROW_OOP_(e, result) \
aoqi@0 239 { Exceptions::_throw_oop(THREAD_AND_LOCATION, e); return result; }
aoqi@0 240
aoqi@0 241 #define THROW_HANDLE_(e, result) \
aoqi@0 242 { Exceptions::_throw(THREAD_AND_LOCATION, e); return result; }
aoqi@0 243
aoqi@0 244 #define THROW_(name, result) \
aoqi@0 245 { Exceptions::_throw_msg(THREAD_AND_LOCATION, name, NULL); return result; }
aoqi@0 246
aoqi@0 247 #define THROW_MSG_(name, message, result) \
aoqi@0 248 { Exceptions::_throw_msg(THREAD_AND_LOCATION, name, message); return result; }
aoqi@0 249
aoqi@0 250 #define THROW_MSG_LOADER_(name, message, loader, protection_domain, result) \
aoqi@0 251 { Exceptions::_throw_msg(THREAD_AND_LOCATION, name, message, loader, protection_domain); return result; }
aoqi@0 252
aoqi@0 253 #define THROW_ARG_(name, signature, args, result) \
aoqi@0 254 { Exceptions::_throw_args(THREAD_AND_LOCATION, name, signature, args); return result; }
aoqi@0 255
aoqi@0 256 #define THROW_MSG_CAUSE(name, message, cause) \
aoqi@0 257 { Exceptions::_throw_msg_cause(THREAD_AND_LOCATION, name, message, cause); return; }
aoqi@0 258
aoqi@0 259 #define THROW_MSG_CAUSE_(name, message, cause, result) \
aoqi@0 260 { Exceptions::_throw_msg_cause(THREAD_AND_LOCATION, name, message, cause); return result; }
aoqi@0 261
aoqi@0 262
aoqi@0 263 #define THROW_OOP_0(e) THROW_OOP_(e, 0)
aoqi@0 264 #define THROW_HANDLE_0(e) THROW_HANDLE_(e, 0)
aoqi@0 265 #define THROW_0(name) THROW_(name, 0)
aoqi@0 266 #define THROW_MSG_0(name, message) THROW_MSG_(name, message, 0)
aoqi@0 267 #define THROW_WRAPPED_0(name, oop_to_wrap) THROW_WRAPPED_(name, oop_to_wrap, 0)
aoqi@0 268 #define THROW_ARG_0(name, signature, arg) THROW_ARG_(name, signature, arg, 0)
aoqi@0 269 #define THROW_MSG_CAUSE_0(name, message, cause) THROW_MSG_CAUSE_(name, message, cause, 0)
aoqi@0 270 #define THROW_MSG_CAUSE_NULL(name, message, cause) THROW_MSG_CAUSE_(name, message, cause, NULL)
aoqi@0 271
aoqi@0 272 #define THROW_NULL(name) THROW_(name, NULL)
aoqi@0 273 #define THROW_MSG_NULL(name, message) THROW_MSG_(name, message, NULL)
aoqi@0 274
aoqi@0 275 // The CATCH macro checks that no exception has been thrown by a function; it is used at
aoqi@0 276 // call sites about which is statically known that the callee cannot throw an exception
aoqi@0 277 // even though it is declared with TRAPS.
aoqi@0 278
aoqi@0 279 #define CATCH \
aoqi@0 280 THREAD); if (HAS_PENDING_EXCEPTION) { \
aoqi@0 281 oop ex = PENDING_EXCEPTION; \
aoqi@0 282 CLEAR_PENDING_EXCEPTION; \
aoqi@0 283 ex->print(); \
aoqi@0 284 ShouldNotReachHere(); \
aoqi@0 285 } (void)(0
aoqi@0 286
aoqi@0 287 // ExceptionMark is a stack-allocated helper class for local exception handling.
aoqi@0 288 // It is used with the EXCEPTION_MARK macro.
aoqi@0 289
aoqi@0 290 class ExceptionMark {
aoqi@0 291 private:
aoqi@0 292 Thread* _thread;
aoqi@0 293
aoqi@0 294 public:
aoqi@0 295 ExceptionMark(Thread*& thread);
aoqi@0 296 ~ExceptionMark();
aoqi@0 297 };
aoqi@0 298
aoqi@0 299
aoqi@0 300
aoqi@0 301 // Use an EXCEPTION_MARK for 'local' exceptions. EXCEPTION_MARK makes sure that no
aoqi@0 302 // pending exception exists upon entering its scope and tests that no pending exception
aoqi@0 303 // exists when leaving the scope.
aoqi@0 304
aoqi@0 305 // See also preserveException.hpp for PRESERVE_EXCEPTION_MARK macro,
aoqi@0 306 // which preserves pre-existing exceptions and does not allow new
aoqi@0 307 // exceptions.
aoqi@0 308
aoqi@0 309 #define EXCEPTION_MARK Thread* THREAD = NULL; ExceptionMark __em(THREAD);
aoqi@0 310
aoqi@0 311 #endif // SHARE_VM_UTILITIES_EXCEPTIONS_HPP

mercurial