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