1 /*
2 * Copyright (c) 1998, 2012, 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 #include "precompiled.hpp"
26 #include "classfile/systemDictionary.hpp"
27 #include "classfile/vmSymbols.hpp"
28 #include "compiler/compileBroker.hpp"
29 #include "oops/oop.inline.hpp"
30 #include "runtime/init.hpp"
31 #include "runtime/java.hpp"
32 #include "runtime/javaCalls.hpp"
33 #include "runtime/threadCritical.hpp"
34 #include "utilities/events.hpp"
35 #include "utilities/exceptions.hpp"
36 #ifdef TARGET_OS_FAMILY_linux
37 # include "thread_linux.inline.hpp"
38 #endif
39 #ifdef TARGET_OS_FAMILY_solaris
40 # include "thread_solaris.inline.hpp"
41 #endif
42 #ifdef TARGET_OS_FAMILY_windows
43 # include "thread_windows.inline.hpp"
44 #endif
45 #ifdef TARGET_OS_FAMILY_bsd
46 # include "thread_bsd.inline.hpp"
47 #endif
48
49
50 // Implementation of ThreadShadow
51 void check_ThreadShadow() {
52 const ByteSize offset1 = byte_offset_of(ThreadShadow, _pending_exception);
53 const ByteSize offset2 = Thread::pending_exception_offset();
54 if (offset1 != offset2) fatal("ThreadShadow::_pending_exception is not positioned correctly");
55 }
56
57
58 void ThreadShadow::set_pending_exception(oop exception, const char* file, int line) {
59 assert(exception != NULL && exception->is_oop(), "invalid exception oop");
60 _pending_exception = exception;
61 _exception_file = file;
62 _exception_line = line;
63 }
64
65 void ThreadShadow::clear_pending_exception() {
66 if (TraceClearedExceptions) {
67 if (_pending_exception != NULL) {
68 tty->print_cr("Thread::clear_pending_exception: cleared exception:");
69 _pending_exception->print();
70 }
71 }
72 _pending_exception = NULL;
73 _exception_file = NULL;
74 _exception_line = 0;
75 }
76 // Implementation of Exceptions
77
78 bool Exceptions::special_exception(Thread* thread, const char* file, int line, Handle h_exception) {
79 // bootstrapping check
80 if (!Universe::is_fully_initialized()) {
81 vm_exit_during_initialization(h_exception);
82 ShouldNotReachHere();
83 }
84
85 #ifdef ASSERT
86 // Check for trying to throw stack overflow before initialization is complete
87 // to prevent infinite recursion trying to initialize stack overflow without
88 // adequate stack space.
89 // This can happen with stress testing a large value of StackShadowPages
90 if (h_exception()->klass() == SystemDictionary::StackOverflowError_klass()) {
91 InstanceKlass* ik = InstanceKlass::cast(h_exception->klass());
92 assert(ik->is_initialized(),
93 "need to increase min_stack_allowed calculation");
94 }
95 #endif // ASSERT
96
97 if (thread->is_VM_thread()
98 || thread->is_Compiler_thread() ) {
99 // We do not care what kind of exception we get for the vm-thread or a thread which
100 // is compiling. We just install a dummy exception object
101 thread->set_pending_exception(Universe::vm_exception(), file, line);
102 return true;
103 }
104
105 return false;
106 }
107
108 bool Exceptions::special_exception(Thread* thread, const char* file, int line, Symbol* h_name, const char* message) {
109 // bootstrapping check
110 if (!Universe::is_fully_initialized()) {
111 if (h_name == NULL) {
112 // atleast an informative message.
113 vm_exit_during_initialization("Exception", message);
114 } else {
115 vm_exit_during_initialization(h_name, message);
116 }
117 ShouldNotReachHere();
118 }
119
120 if (thread->is_VM_thread()
121 || thread->is_Compiler_thread() ) {
122 // We do not care what kind of exception we get for the vm-thread or a thread which
123 // is compiling. We just install a dummy exception object
124 thread->set_pending_exception(Universe::vm_exception(), file, line);
125 return true;
126 }
127 return false;
128 }
129
130 // This method should only be called from generated code,
131 // therefore the exception oop should be in the oopmap.
132 void Exceptions::_throw_oop(Thread* thread, const char* file, int line, oop exception) {
133 assert(exception != NULL, "exception should not be NULL");
134 Handle h_exception = Handle(thread, exception);
135 _throw(thread, file, line, h_exception);
136 }
137
138 void Exceptions::_throw(Thread* thread, const char* file, int line, Handle h_exception, const char* message) {
139 assert(h_exception() != NULL, "exception should not be NULL");
140
141 // tracing (do this up front - so it works during boot strapping)
142 if (TraceExceptions) {
143 ttyLocker ttyl;
144 ResourceMark rm;
145 tty->print_cr("Exception <%s>%s%s (" INTPTR_FORMAT " ) \n"
146 "thrown [%s, line %d]\nfor thread " INTPTR_FORMAT,
147 h_exception->print_value_string(),
148 message ? ": " : "", message ? message : "",
149 (address)h_exception(), file, line, thread);
150 }
151 // for AbortVMOnException flag
152 NOT_PRODUCT(Exceptions::debug_check_abort(h_exception, message));
153
154 // Check for special boot-strapping/vm-thread handling
155 if (special_exception(thread, file, line, h_exception)) return;
156
157 assert(h_exception->is_a(SystemDictionary::Throwable_klass()), "exception is not a subclass of java/lang/Throwable");
158
159 // set the pending exception
160 thread->set_pending_exception(h_exception(), file, line);
161
162 // vm log
163 Events::log_exception(thread, "Threw " INTPTR_FORMAT " at %s:%d", (address)h_exception(), file, line);
164 }
165
166
167 void Exceptions::_throw_msg(Thread* thread, const char* file, int line, Symbol* name, const char* message,
168 Handle h_loader, Handle h_protection_domain) {
169 // Check for special boot-strapping/vm-thread handling
170 if (special_exception(thread, file, line, name, message)) return;
171 // Create and throw exception
172 Handle h_cause(thread, NULL);
173 Handle h_exception = new_exception(thread, name, message, h_cause, h_loader, h_protection_domain);
174 _throw(thread, file, line, h_exception, message);
175 }
176
177 void Exceptions::_throw_msg_cause(Thread* thread, const char* file, int line, Symbol* name, const char* message, Handle h_cause,
178 Handle h_loader, Handle h_protection_domain) {
179 // Check for special boot-strapping/vm-thread handling
180 if (special_exception(thread, file, line, name, message)) return;
181 // Create and throw exception and init cause
182 Handle h_exception = new_exception(thread, name, message, h_cause, h_loader, h_protection_domain);
183 _throw(thread, file, line, h_exception, message);
184 }
185
186 void Exceptions::_throw_cause(Thread* thread, const char* file, int line, Symbol* name, Handle h_cause,
187 Handle h_loader, Handle h_protection_domain) {
188 // Check for special boot-strapping/vm-thread handling
189 if (special_exception(thread, file, line, h_cause)) return;
190 // Create and throw exception
191 Handle h_exception = new_exception(thread, name, h_cause, h_loader, h_protection_domain);
192 _throw(thread, file, line, h_exception, NULL);
193 }
194
195 void Exceptions::_throw_args(Thread* thread, const char* file, int line, Symbol* name, Symbol* signature, JavaCallArguments *args) {
196 // Check for special boot-strapping/vm-thread handling
197 if (special_exception(thread, file, line, name, NULL)) return;
198 // Create and throw exception
199 Handle h_loader(thread, NULL);
200 Handle h_prot(thread, NULL);
201 Handle exception = new_exception(thread, name, signature, args, h_loader, h_prot);
202 _throw(thread, file, line, exception);
203 }
204
205
206 // Methods for default parameters.
207 // NOTE: These must be here (and not in the header file) because of include circularities.
208 void Exceptions::_throw_msg_cause(Thread* thread, const char* file, int line, Symbol* name, const char* message, Handle h_cause) {
209 _throw_msg_cause(thread, file, line, name, message, h_cause, Handle(thread, NULL), Handle(thread, NULL));
210 }
211 void Exceptions::_throw_msg(Thread* thread, const char* file, int line, Symbol* name, const char* message) {
212 _throw_msg(thread, file, line, name, message, Handle(thread, NULL), Handle(thread, NULL));
213 }
214 void Exceptions::_throw_cause(Thread* thread, const char* file, int line, Symbol* name, Handle h_cause) {
215 _throw_cause(thread, file, line, name, h_cause, Handle(thread, NULL), Handle(thread, NULL));
216 }
217
218
219 void Exceptions::throw_stack_overflow_exception(Thread* THREAD, const char* file, int line, methodHandle method) {
220 Handle exception;
221 if (!THREAD->has_pending_exception()) {
222 Klass* k = SystemDictionary::StackOverflowError_klass();
223 oop e = InstanceKlass::cast(k)->allocate_instance(CHECK);
224 exception = Handle(THREAD, e); // fill_in_stack trace does gc
225 assert(InstanceKlass::cast(k)->is_initialized(), "need to increase min_stack_allowed calculation");
226 if (StackTraceInThrowable) {
227 java_lang_Throwable::fill_in_stack_trace(exception, method());
228 }
229 } else {
230 // if prior exception, throw that one instead
231 exception = Handle(THREAD, THREAD->pending_exception());
232 }
233 _throw(THREAD, file, line, exception);
234 }
235
236 void Exceptions::fthrow(Thread* thread, const char* file, int line, Symbol* h_name, const char* format, ...) {
237 const int max_msg_size = 1024;
238 va_list ap;
239 va_start(ap, format);
240 char msg[max_msg_size];
241 vsnprintf(msg, max_msg_size, format, ap);
242 msg[max_msg_size-1] = '\0';
243 va_end(ap);
244 _throw_msg(thread, file, line, h_name, msg);
245 }
246
247 // Creates an exception oop, calls the <init> method with the given signature.
248 // and returns a Handle
249 Handle Exceptions::new_exception(Thread *thread, Symbol* name,
250 Symbol* signature, JavaCallArguments *args,
251 Handle h_loader, Handle h_protection_domain) {
252 assert(Universe::is_fully_initialized(),
253 "cannot be called during initialization");
254 assert(thread->is_Java_thread(), "can only be called by a Java thread");
255 assert(!thread->has_pending_exception(), "already has exception");
256
257 Handle h_exception;
258
259 // Resolve exception klass
260 Klass* ik = SystemDictionary::resolve_or_fail(name, h_loader, h_protection_domain, true, thread);
261 instanceKlassHandle klass(thread, ik);
262
263 if (!thread->has_pending_exception()) {
264 assert(klass.not_null(), "klass must exist");
265 // We are about to create an instance - so make sure that klass is initialized
266 klass->initialize(thread);
267 if (!thread->has_pending_exception()) {
268 // Allocate new exception
269 h_exception = klass->allocate_instance_handle(thread);
270 if (!thread->has_pending_exception()) {
271 JavaValue result(T_VOID);
272 args->set_receiver(h_exception);
273 // Call constructor
274 JavaCalls::call_special(&result, klass,
275 vmSymbols::object_initializer_name(),
276 signature,
277 args,
278 thread);
279 }
280 }
281 }
282
283 // Check if another exception was thrown in the process, if so rethrow that one
284 if (thread->has_pending_exception()) {
285 h_exception = Handle(thread, thread->pending_exception());
286 thread->clear_pending_exception();
287 }
288 return h_exception;
289 }
290
291 // Creates an exception oop, calls the <init> method with the given signature.
292 // and returns a Handle
293 // Initializes the cause if cause non-null
294 Handle Exceptions::new_exception(Thread *thread, Symbol* name,
295 Symbol* signature, JavaCallArguments *args,
296 Handle h_cause,
297 Handle h_loader, Handle h_protection_domain) {
298 Handle h_exception = new_exception(thread, name, signature, args, h_loader, h_protection_domain);
299
300 // Future: object initializer should take a cause argument
301 if (h_cause.not_null()) {
302 assert(h_cause->is_a(SystemDictionary::Throwable_klass()),
303 "exception cause is not a subclass of java/lang/Throwable");
304 JavaValue result1(T_OBJECT);
305 JavaCallArguments args1;
306 args1.set_receiver(h_exception);
307 args1.push_oop(h_cause);
308 JavaCalls::call_virtual(&result1, h_exception->klass(),
309 vmSymbols::initCause_name(),
310 vmSymbols::throwable_throwable_signature(),
311 &args1,
312 thread);
313 }
314
315 // Check if another exception was thrown in the process, if so rethrow that one
316 if (thread->has_pending_exception()) {
317 h_exception = Handle(thread, thread->pending_exception());
318 thread->clear_pending_exception();
319 }
320 return h_exception;
321 }
322
323 // Convenience method. Calls either the <init>() or <init>(Throwable) method when
324 // creating a new exception
325 Handle Exceptions::new_exception(Thread* thread, Symbol* name,
326 Handle h_cause,
327 Handle h_loader, Handle h_protection_domain,
328 ExceptionMsgToUtf8Mode to_utf8_safe) {
329 JavaCallArguments args;
330 Symbol* signature = NULL;
331 if (h_cause.is_null()) {
332 signature = vmSymbols::void_method_signature();
333 } else {
334 signature = vmSymbols::throwable_void_signature();
335 args.push_oop(h_cause);
336 }
337 return new_exception(thread, name, signature, &args, h_loader, h_protection_domain);
338 }
339
340 // Convenience method. Calls either the <init>() or <init>(String) method when
341 // creating a new exception
342 Handle Exceptions::new_exception(Thread* thread, Symbol* name,
343 const char* message, Handle h_cause,
344 Handle h_loader, Handle h_protection_domain,
345 ExceptionMsgToUtf8Mode to_utf8_safe) {
346 JavaCallArguments args;
347 Symbol* signature = NULL;
348 if (message == NULL) {
349 signature = vmSymbols::void_method_signature();
350 } else {
351 // We want to allocate storage, but we can't do that if there's
352 // a pending exception, so we preserve any pending exception
353 // around the allocation.
354 // If we get an exception from the allocation, prefer that to
355 // the exception we are trying to build, or the pending exception.
356 // This is sort of like what PRESERVE_EXCEPTION_MARK does, except
357 // for the preferencing and the early returns.
358 Handle incoming_exception(thread, NULL);
359 if (thread->has_pending_exception()) {
360 incoming_exception = Handle(thread, thread->pending_exception());
361 thread->clear_pending_exception();
362 }
363 Handle msg;
364 if (to_utf8_safe == safe_to_utf8) {
365 // Make a java UTF8 string.
366 msg = java_lang_String::create_from_str(message, thread);
367 } else {
368 // Make a java string keeping the encoding scheme of the original string.
369 msg = java_lang_String::create_from_platform_dependent_str(message, thread);
370 }
371 if (thread->has_pending_exception()) {
372 Handle exception(thread, thread->pending_exception());
373 thread->clear_pending_exception();
374 return exception;
375 }
376 if (incoming_exception.not_null()) {
377 return incoming_exception;
378 }
379 args.push_oop(msg);
380 signature = vmSymbols::string_void_signature();
381 }
382 return new_exception(thread, name, signature, &args, h_cause, h_loader, h_protection_domain);
383 }
384
385 // Another convenience method that creates handles for null class loaders and
386 // protection domains and null causes.
387 // If the last parameter 'to_utf8_mode' is safe_to_utf8,
388 // it means we can safely ignore the encoding scheme of the message string and
389 // convert it directly to a java UTF8 string. Otherwise, we need to take the
390 // encoding scheme of the string into account. One thing we should do at some
391 // point is to push this flag down to class java_lang_String since other
392 // classes may need similar functionalities.
393 Handle Exceptions::new_exception(Thread* thread, Symbol* name,
394 const char* message,
395 ExceptionMsgToUtf8Mode to_utf8_safe) {
396
397 Handle h_loader(thread, NULL);
398 Handle h_prot(thread, NULL);
399 Handle h_cause(thread, NULL);
400 return Exceptions::new_exception(thread, name, message, h_cause, h_loader,
401 h_prot, to_utf8_safe);
402 }
403
404 // Implementation of ExceptionMark
405
406 ExceptionMark::ExceptionMark(Thread*& thread) {
407 thread = Thread::current();
408 _thread = thread;
409 if (_thread->has_pending_exception()) {
410 oop exception = _thread->pending_exception();
411 _thread->clear_pending_exception(); // Needed to avoid infinite recursion
412 exception->print();
413 fatal("ExceptionMark constructor expects no pending exceptions");
414 }
415 }
416
417
418 ExceptionMark::~ExceptionMark() {
419 if (_thread->has_pending_exception()) {
420 Handle exception(_thread, _thread->pending_exception());
421 _thread->clear_pending_exception(); // Needed to avoid infinite recursion
422 if (is_init_completed()) {
423 exception->print();
424 fatal("ExceptionMark destructor expects no pending exceptions");
425 } else {
426 vm_exit_during_initialization(exception);
427 }
428 }
429 }
430
431 // ----------------------------------------------------------------------------------------
432
433 #ifndef PRODUCT
434 // caller frees value_string if necessary
435 void Exceptions::debug_check_abort(const char *value_string, const char* message) {
436 if (AbortVMOnException != NULL && value_string != NULL &&
437 strstr(value_string, AbortVMOnException)) {
438 if (AbortVMOnExceptionMessage == NULL || message == NULL ||
439 strcmp(message, AbortVMOnExceptionMessage) == 0) {
440 fatal(err_msg("Saw %s, aborting", value_string));
441 }
442 }
443 }
444
445 void Exceptions::debug_check_abort(Handle exception, const char* message) {
446 if (AbortVMOnException != NULL) {
447 ResourceMark rm;
448 if (message == NULL && exception->is_a(SystemDictionary::Throwable_klass())) {
449 oop msg = java_lang_Throwable::message(exception);
450 if (msg != NULL) {
451 message = java_lang_String::as_utf8_string(msg);
452 }
453 }
454 debug_check_abort(InstanceKlass::cast(exception()->klass())->external_name(), message);
455 }
456 }
457 #endif