src/share/vm/utilities/exceptions.hpp

Mon, 25 Jun 2012 21:33:35 -0400

author
coleenp
date
Mon, 25 Jun 2012 21:33:35 -0400
changeset 3875
246d977b51f2
parent 3452
20334ed5ed3c
child 3900
d2a62e0f25eb
permissions
-rw-r--r--

7178670: runtime/7158800/BadUtf8.java fails in SymbolTable::rehash_table
Summary: Cannot delete _buckets and HashtableEntries in shared space (CDS)
Reviewed-by: acorn, kvn, dlong, dcubed, kamg

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

mercurial