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