1 /*
2 * Copyright (c) 2003, 2018, 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 #ifndef SHARE_VM_UTILITIES_VMERROR_HPP
26 #define SHARE_VM_UTILITIES_VMERROR_HPP
27
28 #include "utilities/globalDefinitions.hpp"
29
30 class Decoder;
31 class frame;
32 class VM_ReportJavaOutOfMemory;
33
34 class VMError : public AllStatic {
35 friend class VM_ReportJavaOutOfMemory;
36 friend class Decoder;
37 friend class VMStructs;
38
39 static int _id; // Solaris/Linux signals: 0 - SIGRTMAX
40 // Windows exceptions: 0xCxxxxxxx system errors
41 // 0x8xxxxxxx system warnings
42
43 static const char* _message;
44 static char _detail_msg[1024];
45
46 static Thread* _thread; // NULL if it's native thread
47
48 // additional info for crashes
49 static address _pc; // faulting PC
50 static void* _siginfo; // ExceptionRecord on Windows,
51 // siginfo_t on Solaris/Linux
52 static void* _context; // ContextRecord on Windows,
53 // ucontext_t on Solaris/Linux
54
55 // additional info for VM internal errors
56 static const char* _filename;
57 static int _lineno;
58
59 // used by reporting about OOM
60 static size_t _size;
61
62 // used by fatal error handler
63 static int _current_step;
64 static const char* _current_step_info;
65
66 // Thread id of the first error. We must be able to handle native thread,
67 // so use thread id instead of Thread* to identify thread.
68 static volatile intptr_t first_error_tid;
69
70 // Core dump status, false if we have been unable to write a core/minidump for some reason
71 static bool coredump_status;
72
73 // When coredump_status is set to true this will contain the name/path to the core/minidump,
74 // if coredump_status if false, this will (hopefully) contain a useful error explaining why
75 // no core/minidump has been written to disk
76 static char coredump_message[O_BUFLEN];
77
78 // Timeout handling:
79 // Timestamp at which error reporting started; -1 if no error reporting in progress.
80 static volatile jlong _reporting_start_time;
81 // Whether or not error reporting did timeout.
82 static volatile bool _reporting_did_timeout;
83 // Timestamp at which the last error reporting step started; -1 if no error reporting
84 // in progress.
85 static volatile jlong _step_start_time;
86 // Whether or not the last error reporting step did timeout.
87 static volatile bool _step_did_timeout;
88
89 static bool _error_reported;
90
91 // Whether fork and exec should call fork/vfork
92 static bool _vfork_mode;
93
94 public:
95
96 // set signal handlers on Solaris/Linux or the default exception filter
97 // on Windows, to handle recursive crashes.
98 static void reset_signal_handlers();
99
100 // handle -XX:+ShowMessageBoxOnError. buf is used to format the message string
101 static void show_message_box(char* buf, int buflen);
102
103 // generate an error report
104 static void report(outputStream* st, bool verbose);
105
106 // generate a stack trace
107 static void print_stack_trace(outputStream* st, JavaThread* jt,
108 char* buf, int buflen, bool verbose = false);
109
110 // public for use by the internal non-product debugger.
111 NOT_PRODUCT(public:)
112 static void print_native_stack(outputStream* st, frame fr, Thread* t,
113 char* buf, int buf_size);
114 NOT_PRODUCT(private:)
115
116 static bool should_report_bug(unsigned int id) {
117 return (id != OOM_MALLOC_ERROR) && (id != OOM_MMAP_ERROR);
118 }
119
120 // Write a hint to the stream in case siginfo relates to a segv/bus error
121 // and the offending address points into CDS store.
122 static void check_failing_cds_access(outputStream* st, const void* siginfo);
123
124 static void report_and_die(Thread* thread, unsigned int sig, address pc, void* siginfo,
125 void* context, const char* detail_fmt, ...) ATTRIBUTE_PRINTF(6, 7);
126 static void report_and_die(const char* message, const char* detail_fmt, ...) ATTRIBUTE_PRINTF(2, 3);
127
128 static fdStream out;
129 static fdStream log; // error log used by VMError::report_and_die()
130
131 // Timeout handling.
132 // Hook functions for platform dependend functionality:
133 static void reporting_started();
134 static void interrupt_reporting_thread();
135
136 // Helper function to get the current timestamp.
137 static jlong get_current_timestamp();
138
139 // Accessors to get/set the start times for step and total timeout.
140 static void record_reporting_start_time();
141 static jlong get_reporting_start_time();
142 static void record_step_start_time();
143 static jlong get_step_start_time();
144
145 public:
146
147 // return a string to describe the error
148 static char* error_string(char* buf, int buflen);
149
150 // Record status of core/minidump
151 static void record_coredump_status(const char* message, bool status);
152
153 // support for VM.info diagnostic command
154 static void print_vm_info(outputStream* st);
155
156 // main error reporting function
157 static void report_and_die(int id, const char* message, const char* detail_fmt, va_list detail_args,
158 Thread* thread, address pc, void* siginfo, void* context,
159 const char* filename, int lineno, size_t size) ATTRIBUTE_PRINTF(3, 0);
160
161 static void report_and_die(Thread* thread, unsigned int sig, address pc,
162 void* siginfo, void* context);
163
164 static void report_and_die(Thread* thread, void* context, const char* filename, int lineno, const char* message,
165 const char* detail_fmt, va_list detail_args) ATTRIBUTE_PRINTF(6, 0);
166
167 static void report_and_die(Thread* thread, const char* filename, int lineno, size_t size,
168 VMErrorType vm_err_type, const char* detail_fmt,
169 va_list detail_args) ATTRIBUTE_PRINTF(6, 0);
170
171 static void report_and_die(const char* message);
172
173 // reporting OutOfMemoryError
174 static void report_java_out_of_memory(const char* message);
175
176 // returns original flags for signal, if it was resetted, or -1 if
177 // signal was not changed by error reporter
178 static int get_resetted_sigflags(int sig);
179
180 // returns original handler for signal, if it was resetted, or NULL if
181 // signal was not changed by error reporter
182 static address get_resetted_sighandler(int sig);
183
184 // check to see if fatal error reporting is in progress
185 static bool fatal_error_in_progress() { return first_error_tid != -1; }
186
187 static intptr_t get_first_error_tid() { return first_error_tid; }
188
189 // Called by the WatcherThread to check if error reporting has timed-out.
190 // Returns true if error reporting has not completed within the ErrorLogTimeout limit.
191 static bool check_timeout();
192
193 // Support for avoiding multiple asserts
194 static bool is_error_reported();
195
196 static bool is_forkmode_vfork();
197
198 // Test vmassert(), fatal(), guarantee(), etc.
199 NOT_PRODUCT(static void test_error_handler();)
200 NOT_PRODUCT(static void controlled_crash(int how);)
201
202 // returns an address which is guaranteed to generate a SIGSEGV on read,
203 // for test purposes, which is not NULL and contains bits in every word
204 static void* get_segfault_address();
205 };
206 #endif // SHARE_VM_UTILITIES_VMERROR_HPP