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