1 /*
2 * Copyright (c) 1998, 2017, 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 "logging/log.hpp"
30 #include "memory/resourceArea.hpp"
31 #include "oops/oop.inline.hpp"
32 #include "runtime/init.hpp"
33 #include "runtime/java.hpp"
34 #include "runtime/javaCalls.hpp"
35 #include "runtime/thread.inline.hpp"
36 #include "runtime/threadCritical.hpp"
37 #include "utilities/events.hpp"
38 #include "utilities/exceptions.hpp"
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 (_pending_exception != NULL && log_is_enabled(Debug, exceptions)) {
57 ResourceMark rm;
58 outputStream* logst = Log(exceptions)::debug_stream();
59 logst->print("Thread::clear_pending_exception: cleared exception:");
60 _pending_exception->print_on(logst);
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 java_thread_min_stack_allowed calculation");
84 }
85 #endif // ASSERT
86
87 if (thread->is_VM_thread()
88 || !thread->can_call_java()
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->can_call_java()
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(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 log_info(exceptions)("Exception <%s%s%s> (" INTPTR_FORMAT ") \n"
142 "thrown [%s, line %d]\nfor thread " INTPTR_FORMAT,
143 h_exception->print_value_string(),
144 message ? ": " : "", message ? message : "",
145 p2i(h_exception()), file, line, p2i(thread));
146 // for AbortVMOnException flag
147 Exceptions::debug_check_abort(h_exception, message);
148
149 // Check for special boot-strapping/vm-thread handling
150 if (special_exception(thread, file, line, h_exception)) {
151 return;
152 }
153
154 if (h_exception->is_a(SystemDictionary::OutOfMemoryError_klass())) {
155 count_out_of_memory_exceptions(h_exception);
156 }
157
158 assert(h_exception->is_a(SystemDictionary::Throwable_klass()), "exception is not a subclass of java/lang/Throwable");
159
160 // set the pending exception
161 thread->set_pending_exception(h_exception(), file, line);
162
163 // vm log
164 if (LogEvents){
165 Events::log_exception(thread, "Exception <%s%s%s> (" INTPTR_FORMAT ") thrown at [%s, line %d]",
166 h_exception->print_value_string(), message ? ": " : "", message ? message : "",
167 p2i(h_exception()), file, line);
168 }
169 }
170
171
172 void Exceptions::_throw_msg(Thread* thread, const char* file, int line, Symbol* name, const char* message,
173 Handle h_loader, Handle h_protection_domain) {
174 // Check for special boot-strapping/vm-thread handling
175 if (special_exception(thread, file, line, name, message)) return;
176 // Create and throw exception
177 Handle h_cause(thread, NULL);
178 Handle h_exception = new_exception(thread, name, message, h_cause, h_loader, h_protection_domain);
179 _throw(thread, file, line, h_exception, message);
180 }
181
182 void Exceptions::_throw_msg_cause(Thread* thread, const char* file, int line, Symbol* name, const char* message, Handle h_cause,
183 Handle h_loader, Handle h_protection_domain) {
184 // Check for special boot-strapping/vm-thread handling
185 if (special_exception(thread, file, line, name, message)) return;
186 // Create and throw exception and init cause
187 Handle h_exception = new_exception(thread, name, message, h_cause, h_loader, h_protection_domain);
188 _throw(thread, file, line, h_exception, message);
189 }
190
191 void Exceptions::_throw_cause(Thread* thread, const char* file, int line, Symbol* name, Handle h_cause,
192 Handle h_loader, Handle h_protection_domain) {
193 // Check for special boot-strapping/vm-thread handling
194 if (special_exception(thread, file, line, h_cause)) return;
195 // Create and throw exception
196 Handle h_exception = new_exception(thread, name, h_cause, h_loader, h_protection_domain);
197 _throw(thread, file, line, h_exception, NULL);
198 }
199
200 void Exceptions::_throw_args(Thread* thread, const char* file, int line, Symbol* name, Symbol* signature, JavaCallArguments *args) {
201 // Check for special boot-strapping/vm-thread handling
202 if (special_exception(thread, file, line, name, NULL)) return;
203 // Create and throw exception
204 Handle h_loader(thread, NULL);
205 Handle h_prot(thread, NULL);
206 Handle exception = new_exception(thread, name, signature, args, h_loader, h_prot);
207 _throw(thread, file, line, exception);
208 }
209
210
211 // Methods for default parameters.
212 // NOTE: These must be here (and not in the header file) because of include circularities.
213 void Exceptions::_throw_msg_cause(Thread* thread, const char* file, int line, Symbol* name, const char* message, Handle h_cause) {
214 _throw_msg_cause(thread, file, line, name, message, h_cause, Handle(thread, NULL), Handle(thread, NULL));
215 }
216 void Exceptions::_throw_msg(Thread* thread, const char* file, int line, Symbol* name, const char* message) {
217 _throw_msg(thread, file, line, name, message, Handle(thread, NULL), Handle(thread, NULL));
218 }
219 void Exceptions::_throw_cause(Thread* thread, const char* file, int line, Symbol* name, Handle h_cause) {
220 _throw_cause(thread, file, line, name, h_cause, Handle(thread, NULL), Handle(thread, NULL));
221 }
222
223
224 void Exceptions::throw_stack_overflow_exception(Thread* THREAD, const char* file, int line, const methodHandle& method) {
225 Handle exception;
226 if (!THREAD->has_pending_exception()) {
227 Klass* k = SystemDictionary::StackOverflowError_klass();
228 oop e = InstanceKlass::cast(k)->allocate_instance(CHECK);
229 exception = Handle(THREAD, e); // fill_in_stack trace does gc
230 assert(InstanceKlass::cast(k)->is_initialized(), "need to increase java_thread_min_stack_allowed calculation");
231 if (StackTraceInThrowable) {
232 java_lang_Throwable::fill_in_stack_trace(exception, method());
233 }
234 // Increment counter for hs_err file reporting
235 Atomic::inc(&Exceptions::_stack_overflow_errors);
236 } else {
237 // if prior exception, throw that one instead
238 exception = Handle(THREAD, THREAD->pending_exception());
239 }
240 _throw(THREAD, file, line, exception);
241 }
242
243 void Exceptions::fthrow(Thread* thread, const char* file, int line, Symbol* h_name, const char* format, ...) {
244 const int max_msg_size = 1024;
245 va_list ap;
246 va_start(ap, format);
247 char msg[max_msg_size];
248 vsnprintf(msg, max_msg_size, format, ap);
249 msg[max_msg_size-1] = '\0';
250 va_end(ap);
251 _throw_msg(thread, file, line, h_name, msg);
252 }
253
254
255 // Creates an exception oop, calls the <init> method with the given signature.
256 // and returns a Handle
257 Handle Exceptions::new_exception(Thread *thread, Symbol* name,
258 Symbol* signature, JavaCallArguments *args,
259 Handle h_loader, Handle h_protection_domain) {
260 assert(Universe::is_fully_initialized(),
261 "cannot be called during initialization");
262 assert(thread->is_Java_thread(), "can only be called by a Java thread");
263 assert(!thread->has_pending_exception(), "already has exception");
264
265 Handle h_exception;
266
267 // Resolve exception klass
268 InstanceKlass* klass = InstanceKlass::cast(SystemDictionary::resolve_or_fail(name, h_loader, h_protection_domain, true, thread));
269
270 if (!thread->has_pending_exception()) {
271 assert(klass != NULL, "klass must exist");
272 // We are about to create an instance - so make sure that klass is initialized
273 klass->initialize(thread);
274 if (!thread->has_pending_exception()) {
275 // Allocate new exception
276 h_exception = klass->allocate_instance_handle(thread);
277 if (!thread->has_pending_exception()) {
278 JavaValue result(T_VOID);
279 args->set_receiver(h_exception);
280 // Call constructor
281 JavaCalls::call_special(&result, klass,
282 vmSymbols::object_initializer_name(),
283 signature,
284 args,
285 thread);
286 }
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 // Creates an exception oop, calls the <init> method with the given signature.
299 // and returns a Handle
300 // Initializes the cause if cause non-null
301 Handle Exceptions::new_exception(Thread *thread, Symbol* name,
302 Symbol* signature, JavaCallArguments *args,
303 Handle h_cause,
304 Handle h_loader, Handle h_protection_domain) {
305 Handle h_exception = new_exception(thread, name, signature, args, h_loader, h_protection_domain);
306
307 // Future: object initializer should take a cause argument
308 if (h_cause.not_null()) {
309 assert(h_cause->is_a(SystemDictionary::Throwable_klass()),
310 "exception cause is not a subclass of java/lang/Throwable");
311 JavaValue result1(T_OBJECT);
312 JavaCallArguments args1;
313 args1.set_receiver(h_exception);
314 args1.push_oop(h_cause);
315 JavaCalls::call_virtual(&result1, h_exception->klass(),
316 vmSymbols::initCause_name(),
317 vmSymbols::throwable_throwable_signature(),
318 &args1,
319 thread);
320 }
321
322 // Check if another exception was thrown in the process, if so rethrow that one
323 if (thread->has_pending_exception()) {
324 h_exception = Handle(thread, thread->pending_exception());
325 thread->clear_pending_exception();
326 }
327 return h_exception;
328 }
329
330 // Convenience method. Calls either the <init>() or <init>(Throwable) method when
331 // creating a new exception
332 Handle Exceptions::new_exception(Thread* thread, Symbol* name,
333 Handle h_cause,
334 Handle h_loader, Handle h_protection_domain,
335 ExceptionMsgToUtf8Mode to_utf8_safe) {
336 JavaCallArguments args;
337 Symbol* signature = NULL;
338 if (h_cause.is_null()) {
339 signature = vmSymbols::void_method_signature();
340 } else {
341 signature = vmSymbols::throwable_void_signature();
342 args.push_oop(h_cause);
343 }
344 return new_exception(thread, name, signature, &args, h_loader, h_protection_domain);
345 }
346
347 // Convenience method. Calls either the <init>() or <init>(String) method when
348 // creating a new exception
349 Handle Exceptions::new_exception(Thread* thread, Symbol* name,
350 const char* message, Handle h_cause,
351 Handle h_loader, Handle h_protection_domain,
352 ExceptionMsgToUtf8Mode to_utf8_safe) {
353 JavaCallArguments args;
354 Symbol* signature = NULL;
355 if (message == NULL) {
356 signature = vmSymbols::void_method_signature();
357 } else {
358 // We want to allocate storage, but we can't do that if there's
359 // a pending exception, so we preserve any pending exception
360 // around the allocation.
361 // If we get an exception from the allocation, prefer that to
362 // the exception we are trying to build, or the pending exception.
363 // This is sort of like what PRESERVE_EXCEPTION_MARK does, except
364 // for the preferencing and the early returns.
365 Handle incoming_exception(thread, NULL);
366 if (thread->has_pending_exception()) {
367 incoming_exception = Handle(thread, thread->pending_exception());
368 thread->clear_pending_exception();
369 }
370 Handle msg;
371 if (to_utf8_safe == safe_to_utf8) {
372 // Make a java UTF8 string.
373 msg = java_lang_String::create_from_str(message, thread);
374 } else {
375 // Make a java string keeping the encoding scheme of the original string.
376 msg = java_lang_String::create_from_platform_dependent_str(message, thread);
377 }
378 if (thread->has_pending_exception()) {
379 Handle exception(thread, thread->pending_exception());
380 thread->clear_pending_exception();
381 return exception;
382 }
383 if (incoming_exception.not_null()) {
384 return incoming_exception;
385 }
386 args.push_oop(msg);
387 signature = vmSymbols::string_void_signature();
388 }
389 return new_exception(thread, name, signature, &args, h_cause, h_loader, h_protection_domain);
390 }
391
392 // Another convenience method that creates handles for null class loaders and
393 // protection domains and null causes.
394 // If the last parameter 'to_utf8_mode' is safe_to_utf8,
395 // it means we can safely ignore the encoding scheme of the message string and
396 // convert it directly to a java UTF8 string. Otherwise, we need to take the
397 // encoding scheme of the string into account. One thing we should do at some
398 // point is to push this flag down to class java_lang_String since other
399 // classes may need similar functionalities.
400 Handle Exceptions::new_exception(Thread* thread, Symbol* name,
401 const char* message,
402 ExceptionMsgToUtf8Mode to_utf8_safe) {
403
404 Handle h_loader(thread, NULL);
405 Handle h_prot(thread, NULL);
406 Handle h_cause(thread, NULL);
407 return Exceptions::new_exception(thread, name, message, h_cause, h_loader,
408 h_prot, to_utf8_safe);
409 }
410
411
412 // Exception counting for hs_err file
413 volatile int Exceptions::_stack_overflow_errors = 0;
414 volatile int Exceptions::_out_of_memory_error_java_heap_errors = 0;
415 volatile int Exceptions::_out_of_memory_error_metaspace_errors = 0;
416 volatile int Exceptions::_out_of_memory_error_class_metaspace_errors = 0;
417
418 void Exceptions::count_out_of_memory_exceptions(Handle exception) {
419 if (exception() == Universe::out_of_memory_error_metaspace()) {
420 Atomic::inc(&_out_of_memory_error_metaspace_errors);
421 } else if (exception() == Universe::out_of_memory_error_class_metaspace()) {
422 Atomic::inc(&_out_of_memory_error_class_metaspace_errors);
423 } else {
424 // everything else reported as java heap OOM
425 Atomic::inc(&_out_of_memory_error_java_heap_errors);
426 }
427 }
428
429 void print_oom_count(outputStream* st, const char *err, int count) {
430 if (count > 0) {
431 st->print_cr("OutOfMemoryError %s=%d", err, count);
432 }
433 }
434
435 bool Exceptions::has_exception_counts() {
436 return (_stack_overflow_errors + _out_of_memory_error_java_heap_errors +
437 _out_of_memory_error_metaspace_errors + _out_of_memory_error_class_metaspace_errors) > 0;
438 }
439
440 void Exceptions::print_exception_counts_on_error(outputStream* st) {
441 print_oom_count(st, "java_heap_errors", _out_of_memory_error_java_heap_errors);
442 print_oom_count(st, "metaspace_errors", _out_of_memory_error_metaspace_errors);
443 print_oom_count(st, "class_metaspace_errors", _out_of_memory_error_class_metaspace_errors);
444 if (_stack_overflow_errors > 0) {
445 st->print_cr("StackOverflowErrors=%d", _stack_overflow_errors);
446 }
447 }
448
449 // Implementation of ExceptionMark
450
451 ExceptionMark::ExceptionMark(Thread*& thread) {
452 thread = Thread::current();
453 _thread = thread;
454 if (_thread->has_pending_exception()) {
455 oop exception = _thread->pending_exception();
456 _thread->clear_pending_exception(); // Needed to avoid infinite recursion
457 exception->print();
458 fatal("ExceptionMark constructor expects no pending exceptions");
459 }
460 }
461
462
463 ExceptionMark::~ExceptionMark() {
464 if (_thread->has_pending_exception()) {
465 Handle exception(_thread, _thread->pending_exception());
466 _thread->clear_pending_exception(); // Needed to avoid infinite recursion
467 if (is_init_completed()) {
468 exception->print();
469 fatal("ExceptionMark destructor expects no pending exceptions");
470 } else {
471 vm_exit_during_initialization(exception);
472 }
473 }
474 }
475
476 // ----------------------------------------------------------------------------------------
477
478 // caller frees value_string if necessary
479 void Exceptions::debug_check_abort(const char *value_string, const char* message) {
480 if (AbortVMOnException != NULL && value_string != NULL &&
481 strstr(value_string, AbortVMOnException)) {
482 if (AbortVMOnExceptionMessage == NULL || (message != NULL &&
483 strstr(message, AbortVMOnExceptionMessage))) {
484 fatal("Saw %s, aborting", value_string);
485 }
486 }
487 }
488
489 void Exceptions::debug_check_abort(Handle exception, const char* message) {
490 if (AbortVMOnException != NULL) {
491 debug_check_abort_helper(exception, message);
492 }
493 }
494
495 void Exceptions::debug_check_abort_helper(Handle exception, const char* message) {
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(exception()->klass()->external_name(), message);
504 }
505
506 // for logging exceptions
507 void Exceptions::log_exception(Handle exception, stringStream tempst) {
508 ResourceMark rm;
509 Symbol* message = java_lang_Throwable::detail_message(exception());
510 if (message != NULL) {
511 log_info(exceptions)("Exception <%s: %s>\n thrown in %s",
512 exception->print_value_string(),
513 message->as_C_string(),
514 tempst.as_string());
515 } else {
516 log_info(exceptions)("Exception <%s>\n thrown in %s",
517 exception->print_value_string(),
518 tempst.as_string());
519 }
520 }