duke@435: /*
never@3499:  * Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved.
duke@435:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435:  *
duke@435:  * This code is free software; you can redistribute it and/or modify it
duke@435:  * under the terms of the GNU General Public License version 2 only, as
duke@435:  * published by the Free Software Foundation.
duke@435:  *
duke@435:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@435:  * version 2 for more details (a copy is included in the LICENSE file that
duke@435:  * accompanied this code).
duke@435:  *
duke@435:  * You should have received a copy of the GNU General Public License version
duke@435:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@435:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435:  *
trims@1907:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
trims@1907:  * or visit www.oracle.com if you need additional information or have any
trims@1907:  * questions.
duke@435:  *
duke@435:  */
duke@435: 
stefank@2314: #include "precompiled.hpp"
stefank@2314: #include "classfile/systemDictionary.hpp"
stefank@2314: #include "classfile/vmSymbols.hpp"
stefank@2314: #include "compiler/compileBroker.hpp"
stefank@2314: #include "oops/oop.inline.hpp"
stefank@2314: #include "runtime/init.hpp"
stefank@2314: #include "runtime/java.hpp"
stefank@2314: #include "runtime/javaCalls.hpp"
stefank@4299: #include "runtime/thread.inline.hpp"
stefank@2314: #include "runtime/threadCritical.hpp"
stefank@2314: #include "utilities/events.hpp"
stefank@2314: #include "utilities/exceptions.hpp"
duke@435: 
duke@435: 
duke@435: // Implementation of ThreadShadow
duke@435: void check_ThreadShadow() {
duke@435:   const ByteSize offset1 = byte_offset_of(ThreadShadow, _pending_exception);
duke@435:   const ByteSize offset2 = Thread::pending_exception_offset();
duke@435:   if (offset1 != offset2) fatal("ThreadShadow::_pending_exception is not positioned correctly");
duke@435: }
duke@435: 
duke@435: 
duke@435: void ThreadShadow::set_pending_exception(oop exception, const char* file, int line) {
duke@435:   assert(exception != NULL && exception->is_oop(), "invalid exception oop");
duke@435:   _pending_exception = exception;
duke@435:   _exception_file    = file;
duke@435:   _exception_line    = line;
duke@435: }
duke@435: 
duke@435: void ThreadShadow::clear_pending_exception() {
duke@435:   if (TraceClearedExceptions) {
duke@435:     if (_pending_exception != NULL) {
duke@435:       tty->print_cr("Thread::clear_pending_exception: cleared exception:");
duke@435:       _pending_exception->print();
duke@435:     }
duke@435:   }
duke@435:   _pending_exception = NULL;
duke@435:   _exception_file    = NULL;
duke@435:   _exception_line    = 0;
duke@435: }
duke@435: // Implementation of Exceptions
duke@435: 
duke@435: bool Exceptions::special_exception(Thread* thread, const char* file, int line, Handle h_exception) {
duke@435:   // bootstrapping check
duke@435:   if (!Universe::is_fully_initialized()) {
duke@435:    vm_exit_during_initialization(h_exception);
duke@435:    ShouldNotReachHere();
duke@435:   }
duke@435: 
coleenp@2222: #ifdef ASSERT
coleenp@2222:   // Check for trying to throw stack overflow before initialization is complete
coleenp@2222:   // to prevent infinite recursion trying to initialize stack overflow without
coleenp@2222:   // adequate stack space.
coleenp@2222:   // This can happen with stress testing a large value of StackShadowPages
coleenp@2222:   if (h_exception()->klass() == SystemDictionary::StackOverflowError_klass()) {
coleenp@4037:     InstanceKlass* ik = InstanceKlass::cast(h_exception->klass());
coleenp@2222:     assert(ik->is_initialized(),
coleenp@2222:            "need to increase min_stack_allowed calculation");
coleenp@2222:   }
coleenp@2222: #endif // ASSERT
coleenp@2222: 
duke@435:   if (thread->is_VM_thread()
duke@435:       || thread->is_Compiler_thread() ) {
duke@435:     // We do not care what kind of exception we get for the vm-thread or a thread which
duke@435:     // is compiling.  We just install a dummy exception object
duke@435:     thread->set_pending_exception(Universe::vm_exception(), file, line);
duke@435:     return true;
duke@435:   }
duke@435: 
duke@435:   return false;
duke@435: }
duke@435: 
coleenp@2497: bool Exceptions::special_exception(Thread* thread, const char* file, int line, Symbol* h_name, const char* message) {
duke@435:   // bootstrapping check
duke@435:   if (!Universe::is_fully_initialized()) {
coleenp@2497:     if (h_name == NULL) {
duke@435:       // atleast an informative message.
duke@435:       vm_exit_during_initialization("Exception", message);
duke@435:     } else {
duke@435:       vm_exit_during_initialization(h_name, message);
duke@435:     }
duke@435:     ShouldNotReachHere();
duke@435:   }
duke@435: 
duke@435:   if (thread->is_VM_thread()
duke@435:       || thread->is_Compiler_thread() ) {
duke@435:     // We do not care what kind of exception we get for the vm-thread or a thread which
duke@435:     // is compiling.  We just install a dummy exception object
duke@435:     thread->set_pending_exception(Universe::vm_exception(), file, line);
duke@435:     return true;
duke@435:   }
duke@435:   return false;
duke@435: }
duke@435: 
duke@435: // This method should only be called from generated code,
duke@435: // therefore the exception oop should be in the oopmap.
duke@435: void Exceptions::_throw_oop(Thread* thread, const char* file, int line, oop exception) {
duke@435:   assert(exception != NULL, "exception should not be NULL");
duke@435:   Handle h_exception = Handle(thread, exception);
duke@435:   _throw(thread, file, line, h_exception);
duke@435: }
duke@435: 
never@1446: void Exceptions::_throw(Thread* thread, const char* file, int line, Handle h_exception, const char* message) {
duke@435:   assert(h_exception() != NULL, "exception should not be NULL");
duke@435: 
duke@435:   // tracing (do this up front - so it works during boot strapping)
duke@435:   if (TraceExceptions) {
duke@435:     ttyLocker ttyl;
duke@435:     ResourceMark rm;
never@1446:     tty->print_cr("Exception <%s>%s%s (" INTPTR_FORMAT " ) \n"
never@1446:                   "thrown [%s, line %d]\nfor thread " INTPTR_FORMAT,
never@1446:                   h_exception->print_value_string(),
never@1446:                   message ? ": " : "", message ? message : "",
never@1446:                   (address)h_exception(), file, line, thread);
duke@435:   }
duke@435:   // for AbortVMOnException flag
kvn@2039:   NOT_PRODUCT(Exceptions::debug_check_abort(h_exception, message));
duke@435: 
duke@435:   // Check for special boot-strapping/vm-thread handling
duke@435:   if (special_exception(thread, file, line, h_exception)) return;
duke@435: 
never@1577:   assert(h_exception->is_a(SystemDictionary::Throwable_klass()), "exception is not a subclass of java/lang/Throwable");
duke@435: 
duke@435:   // set the pending exception
duke@435:   thread->set_pending_exception(h_exception(), file, line);
duke@435: 
duke@435:   // vm log
never@3499:   Events::log_exception(thread, "Threw " INTPTR_FORMAT " at %s:%d", (address)h_exception(), file, line);
duke@435: }
duke@435: 
duke@435: 
twisti@3974: void Exceptions::_throw_msg(Thread* thread, const char* file, int line, Symbol* name, const char* message,
twisti@3974:                             Handle h_loader, Handle h_protection_domain) {
duke@435:   // Check for special boot-strapping/vm-thread handling
twisti@3974:   if (special_exception(thread, file, line, name, message)) return;
duke@435:   // Create and throw exception
duke@435:   Handle h_cause(thread, NULL);
twisti@3974:   Handle h_exception = new_exception(thread, name, message, h_cause, h_loader, h_protection_domain);
never@1446:   _throw(thread, file, line, h_exception, message);
duke@435: }
duke@435: 
twisti@3974: void Exceptions::_throw_msg_cause(Thread* thread, const char* file, int line, Symbol* name, const char* message, Handle h_cause,
twisti@3974:                                   Handle h_loader, Handle h_protection_domain) {
duke@435:   // Check for special boot-strapping/vm-thread handling
twisti@3974:   if (special_exception(thread, file, line, name, message)) return;
duke@435:   // Create and throw exception and init cause
twisti@3974:   Handle h_exception = new_exception(thread, name, message, h_cause, h_loader, h_protection_domain);
never@1446:   _throw(thread, file, line, h_exception, message);
duke@435: }
duke@435: 
twisti@3974: void Exceptions::_throw_cause(Thread* thread, const char* file, int line, Symbol* name, Handle h_cause,
twisti@3974:                               Handle h_loader, Handle h_protection_domain) {
twisti@3974:   // Check for special boot-strapping/vm-thread handling
twisti@3974:   if (special_exception(thread, file, line, h_cause)) return;
twisti@3974:   // Create and throw exception
twisti@3974:   Handle h_exception = new_exception(thread, name, h_cause, h_loader, h_protection_domain);
twisti@3974:   _throw(thread, file, line, h_exception, NULL);
duke@435: }
duke@435: 
twisti@3974: void Exceptions::_throw_args(Thread* thread, const char* file, int line, Symbol* name, Symbol* signature, JavaCallArguments *args) {
duke@435:   // Check for special boot-strapping/vm-thread handling
twisti@3974:   if (special_exception(thread, file, line, name, NULL)) return;
duke@435:   // Create and throw exception
duke@435:   Handle h_loader(thread, NULL);
duke@435:   Handle h_prot(thread, NULL);
twisti@3974:   Handle exception = new_exception(thread, name, signature, args, h_loader, h_prot);
duke@435:   _throw(thread, file, line, exception);
duke@435: }
duke@435: 
duke@435: 
twisti@3974: // Methods for default parameters.
twisti@3974: // NOTE: These must be here (and not in the header file) because of include circularities.
twisti@3974: void Exceptions::_throw_msg_cause(Thread* thread, const char* file, int line, Symbol* name, const char* message, Handle h_cause) {
twisti@3974:   _throw_msg_cause(thread, file, line, name, message, h_cause, Handle(thread, NULL), Handle(thread, NULL));
twisti@3974: }
twisti@3974: void Exceptions::_throw_msg(Thread* thread, const char* file, int line, Symbol* name, const char* message) {
twisti@3974:   _throw_msg(thread, file, line, name, message, Handle(thread, NULL), Handle(thread, NULL));
twisti@3974: }
twisti@3974: void Exceptions::_throw_cause(Thread* thread, const char* file, int line, Symbol* name, Handle h_cause) {
twisti@3974:   _throw_cause(thread, file, line, name, h_cause, Handle(thread, NULL), Handle(thread, NULL));
twisti@3974: }
twisti@3974: 
twisti@3974: 
coleenp@2804: void Exceptions::throw_stack_overflow_exception(Thread* THREAD, const char* file, int line, methodHandle method) {
duke@435:   Handle exception;
duke@435:   if (!THREAD->has_pending_exception()) {
coleenp@4037:     Klass* k = SystemDictionary::StackOverflowError_klass();
coleenp@4037:     oop e = InstanceKlass::cast(k)->allocate_instance(CHECK);
duke@435:     exception = Handle(THREAD, e);  // fill_in_stack trace does gc
coleenp@4037:     assert(InstanceKlass::cast(k)->is_initialized(), "need to increase min_stack_allowed calculation");
duke@435:     if (StackTraceInThrowable) {
coleenp@2804:       java_lang_Throwable::fill_in_stack_trace(exception, method());
duke@435:     }
duke@435:   } else {
duke@435:     // if prior exception, throw that one instead
duke@435:     exception = Handle(THREAD, THREAD->pending_exception());
duke@435:   }
coleenp@2804:   _throw(THREAD, file, line, exception);
duke@435: }
duke@435: 
coleenp@2497: void Exceptions::fthrow(Thread* thread, const char* file, int line, Symbol* h_name, const char* format, ...) {
duke@435:   const int max_msg_size = 1024;
duke@435:   va_list ap;
duke@435:   va_start(ap, format);
duke@435:   char msg[max_msg_size];
duke@435:   vsnprintf(msg, max_msg_size, format, ap);
duke@435:   msg[max_msg_size-1] = '\0';
duke@435:   va_end(ap);
duke@435:   _throw_msg(thread, file, line, h_name, msg);
duke@435: }
duke@435: 
duke@435: // Creates an exception oop, calls the <init> method with the given signature.
duke@435: // and returns a Handle
twisti@3974: Handle Exceptions::new_exception(Thread *thread, Symbol* name,
twisti@3974:                                  Symbol* signature, JavaCallArguments *args,
twisti@3974:                                  Handle h_loader, Handle h_protection_domain) {
duke@435:   assert(Universe::is_fully_initialized(),
duke@435:     "cannot be called during initialization");
duke@435:   assert(thread->is_Java_thread(), "can only be called by a Java thread");
duke@435:   assert(!thread->has_pending_exception(), "already has exception");
duke@435: 
duke@435:   Handle h_exception;
duke@435: 
duke@435:   // Resolve exception klass
coleenp@4037:   Klass* ik = SystemDictionary::resolve_or_fail(name, h_loader, h_protection_domain, true, thread);
twisti@3974:   instanceKlassHandle klass(thread, ik);
duke@435: 
duke@435:   if (!thread->has_pending_exception()) {
duke@435:     assert(klass.not_null(), "klass must exist");
duke@435:     // We are about to create an instance - so make sure that klass is initialized
duke@435:     klass->initialize(thread);
duke@435:     if (!thread->has_pending_exception()) {
duke@435:       // Allocate new exception
duke@435:       h_exception = klass->allocate_instance_handle(thread);
duke@435:       if (!thread->has_pending_exception()) {
duke@435:         JavaValue result(T_VOID);
duke@435:         args->set_receiver(h_exception);
duke@435:         // Call constructor
duke@435:         JavaCalls::call_special(&result, klass,
coleenp@2497:                                          vmSymbols::object_initializer_name(),
duke@435:                                          signature,
duke@435:                                          args,
duke@435:                                          thread);
duke@435:       }
duke@435:     }
duke@435:   }
duke@435: 
duke@435:   // Check if another exception was thrown in the process, if so rethrow that one
duke@435:   if (thread->has_pending_exception()) {
duke@435:     h_exception = Handle(thread, thread->pending_exception());
duke@435:     thread->clear_pending_exception();
duke@435:   }
duke@435:   return h_exception;
duke@435: }
duke@435: 
twisti@3974: // Creates an exception oop, calls the <init> method with the given signature.
twisti@3974: // and returns a Handle
twisti@3974: // Initializes the cause if cause non-null
twisti@3974: Handle Exceptions::new_exception(Thread *thread, Symbol* name,
twisti@3974:                                  Symbol* signature, JavaCallArguments *args,
twisti@3974:                                  Handle h_cause,
twisti@3974:                                  Handle h_loader, Handle h_protection_domain) {
twisti@3974:   Handle h_exception = new_exception(thread, name, signature, args, h_loader, h_protection_domain);
twisti@3974: 
twisti@3974:   // Future: object initializer should take a cause argument
twisti@3974:   if (h_cause.not_null()) {
twisti@3974:     assert(h_cause->is_a(SystemDictionary::Throwable_klass()),
twisti@3974:         "exception cause is not a subclass of java/lang/Throwable");
twisti@3974:     JavaValue result1(T_OBJECT);
twisti@3974:     JavaCallArguments args1;
twisti@3974:     args1.set_receiver(h_exception);
twisti@3974:     args1.push_oop(h_cause);
twisti@3974:     JavaCalls::call_virtual(&result1, h_exception->klass(),
twisti@3974:                                       vmSymbols::initCause_name(),
twisti@3974:                                       vmSymbols::throwable_throwable_signature(),
twisti@3974:                                       &args1,
twisti@3974:                                       thread);
twisti@3974:   }
twisti@3974: 
twisti@3974:   // Check if another exception was thrown in the process, if so rethrow that one
twisti@3974:   if (thread->has_pending_exception()) {
twisti@3974:     h_exception = Handle(thread, thread->pending_exception());
twisti@3974:     thread->clear_pending_exception();
twisti@3974:   }
twisti@3974:   return h_exception;
twisti@3974: }
twisti@3974: 
twisti@3974: // Convenience method. Calls either the <init>() or <init>(Throwable) method when
twisti@3974: // creating a new exception
twisti@3974: Handle Exceptions::new_exception(Thread* thread, Symbol* name,
twisti@3974:                                  Handle h_cause,
twisti@3974:                                  Handle h_loader, Handle h_protection_domain,
twisti@3974:                                  ExceptionMsgToUtf8Mode to_utf8_safe) {
twisti@3974:   JavaCallArguments args;
twisti@3974:   Symbol* signature = NULL;
twisti@3974:   if (h_cause.is_null()) {
twisti@3974:     signature = vmSymbols::void_method_signature();
twisti@3974:   } else {
twisti@3974:     signature = vmSymbols::throwable_void_signature();
twisti@3974:     args.push_oop(h_cause);
twisti@3974:   }
twisti@3974:   return new_exception(thread, name, signature, &args, h_loader, h_protection_domain);
twisti@3974: }
twisti@3974: 
duke@435: // Convenience method. Calls either the <init>() or <init>(String) method when
duke@435: // creating a new exception
twisti@3974: Handle Exceptions::new_exception(Thread* thread, Symbol* name,
duke@435:                                  const char* message, Handle h_cause,
twisti@3974:                                  Handle h_loader, Handle h_protection_domain,
duke@435:                                  ExceptionMsgToUtf8Mode to_utf8_safe) {
duke@435:   JavaCallArguments args;
coleenp@2497:   Symbol* signature = NULL;
duke@435:   if (message == NULL) {
coleenp@2497:     signature = vmSymbols::void_method_signature();
duke@435:   } else {
duke@435:     // We want to allocate storage, but we can't do that if there's
duke@435:     // a pending exception, so we preserve any pending exception
duke@435:     // around the allocation.
duke@435:     // If we get an exception from the allocation, prefer that to
duke@435:     // the exception we are trying to build, or the pending exception.
duke@435:     // This is sort of like what PRESERVE_EXCEPTION_MARK does, except
duke@435:     // for the preferencing and the early returns.
twisti@3974:     Handle incoming_exception(thread, NULL);
duke@435:     if (thread->has_pending_exception()) {
duke@435:       incoming_exception = Handle(thread, thread->pending_exception());
duke@435:       thread->clear_pending_exception();
duke@435:     }
duke@435:     Handle msg;
duke@435:     if (to_utf8_safe == safe_to_utf8) {
duke@435:       // Make a java UTF8 string.
duke@435:       msg = java_lang_String::create_from_str(message, thread);
duke@435:     } else {
duke@435:       // Make a java string keeping the encoding scheme of the original string.
duke@435:       msg = java_lang_String::create_from_platform_dependent_str(message, thread);
duke@435:     }
duke@435:     if (thread->has_pending_exception()) {
duke@435:       Handle exception(thread, thread->pending_exception());
duke@435:       thread->clear_pending_exception();
duke@435:       return exception;
duke@435:     }
duke@435:     if (incoming_exception.not_null()) {
duke@435:       return incoming_exception;
duke@435:     }
duke@435:     args.push_oop(msg);
coleenp@2497:     signature = vmSymbols::string_void_signature();
duke@435:   }
twisti@3974:   return new_exception(thread, name, signature, &args, h_cause, h_loader, h_protection_domain);
duke@435: }
duke@435: 
duke@435: // Another convenience method that creates handles for null class loaders and
duke@435: // protection domains and null causes.
duke@435: // If the last parameter 'to_utf8_mode' is safe_to_utf8,
duke@435: // it means we can safely ignore the encoding scheme of the message string and
duke@435: // convert it directly to a java UTF8 string. Otherwise, we need to take the
duke@435: // encoding scheme of the string into account. One thing we should do at some
duke@435: // point is to push this flag down to class java_lang_String since other
duke@435: // classes may need similar functionalities.
twisti@3974: Handle Exceptions::new_exception(Thread* thread, Symbol* name,
duke@435:                                  const char* message,
duke@435:                                  ExceptionMsgToUtf8Mode to_utf8_safe) {
duke@435: 
duke@435:   Handle       h_loader(thread, NULL);
duke@435:   Handle       h_prot(thread, NULL);
duke@435:   Handle       h_cause(thread, NULL);
coleenp@2497:   return Exceptions::new_exception(thread, name, message, h_cause, h_loader,
duke@435:                                    h_prot, to_utf8_safe);
duke@435: }
duke@435: 
duke@435: // Implementation of ExceptionMark
duke@435: 
duke@435: ExceptionMark::ExceptionMark(Thread*& thread) {
duke@435:   thread     = Thread::current();
duke@435:   _thread    = thread;
duke@435:   if (_thread->has_pending_exception()) {
duke@435:     oop exception = _thread->pending_exception();
duke@435:     _thread->clear_pending_exception(); // Needed to avoid infinite recursion
duke@435:     exception->print();
duke@435:     fatal("ExceptionMark constructor expects no pending exceptions");
duke@435:   }
duke@435: }
duke@435: 
duke@435: 
duke@435: ExceptionMark::~ExceptionMark() {
duke@435:   if (_thread->has_pending_exception()) {
duke@435:     Handle exception(_thread, _thread->pending_exception());
duke@435:     _thread->clear_pending_exception(); // Needed to avoid infinite recursion
duke@435:     if (is_init_completed()) {
duke@435:       exception->print();
duke@435:       fatal("ExceptionMark destructor expects no pending exceptions");
duke@435:     } else {
duke@435:       vm_exit_during_initialization(exception);
duke@435:     }
duke@435:   }
duke@435: }
duke@435: 
duke@435: // ----------------------------------------------------------------------------------------
duke@435: 
duke@435: #ifndef PRODUCT
duke@435: // caller frees value_string if necessary
kvn@2039: void Exceptions::debug_check_abort(const char *value_string, const char* message) {
duke@435:   if (AbortVMOnException != NULL && value_string != NULL &&
duke@435:       strstr(value_string, AbortVMOnException)) {
kvn@2039:     if (AbortVMOnExceptionMessage == NULL || message == NULL ||
kvn@2039:         strcmp(message, AbortVMOnExceptionMessage) == 0) {
kvn@2039:       fatal(err_msg("Saw %s, aborting", value_string));
kvn@2039:     }
duke@435:   }
duke@435: }
duke@435: 
kvn@2039: void Exceptions::debug_check_abort(Handle exception, const char* message) {
duke@435:   if (AbortVMOnException != NULL) {
duke@435:     ResourceMark rm;
kvn@2039:     if (message == NULL && exception->is_a(SystemDictionary::Throwable_klass())) {
kvn@2039:       oop msg = java_lang_Throwable::message(exception);
kvn@2039:       if (msg != NULL) {
kvn@2039:         message = java_lang_String::as_utf8_string(msg);
kvn@2039:       }
kvn@2039:     }
coleenp@4037:     debug_check_abort(InstanceKlass::cast(exception()->klass())->external_name(), message);
duke@435:   }
duke@435: }
duke@435: #endif