1 /*
   2  * Copyright (c) 2003, 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 #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 VM_ReportJavaOutOfMemory;
  32 
  33 class VMError : public AllStatic {
  34   friend class VM_ReportJavaOutOfMemory;
  35   friend class Decoder;
  36 
  37   // used by fatal error handler
  38   static int          _current_step;
  39   static const char * _current_step_info;
  40   static int          _verbose;
  41   // Thread id of the first error. We must be able to handle native thread,
  42   // so use thread id instead of Thread* to identify thread.
  43   static volatile jlong    first_error_tid;
  44 
  45   // Core dump status, false if we have been unable to write a core/minidump for some reason
  46   static bool coredump_status;
  47 
  48   // When coredump_status is set to true this will contain the name/path to the core/minidump,
  49   // if coredump_status if false, this will (hopefully) contain a useful error explaining why
  50   // no core/minidump has been written to disk
  51   static char coredump_message[O_BUFLEN];
  52 
  53 
  54   // set signal handlers on Solaris/Linux or the default exception filter
  55   // on Windows, to handle recursive crashes.
  56   static void reset_signal_handlers();
  57 
  58   // handle -XX:+ShowMessageBoxOnError. buf is used to format the message string
  59   static void show_message_box(char* buf, int buflen, int id, const char* message,
  60                                const char* detail_fmt, va_list detail_args, address pc,
  61                                const char* filename, int lineno) ATTRIBUTE_PRINTF(5, 0);
  62 
  63   // generate an error report
  64   static void report(outputStream* st, int id, const char* message, const char* detail_fmt,
  65                      va_list detail_msg_args, Thread* thread, address pc, void* siginfo,
  66                      void* context, const char* filename, int lineno, size_t size) ATTRIBUTE_PRINTF(4, 0);
  67 
  68   // generate a stack trace
  69   static void print_stack_trace(outputStream* st, JavaThread* jt,
  70                                 char* buf, int buflen, bool verbose = false);
  71 
  72   static const char* gc_mode();
  73   static void print_oom_reasons(outputStream* st);
  74 
  75   static bool should_report_bug(unsigned int id) {
  76     return (id != OOM_MALLOC_ERROR) && (id != OOM_MMAP_ERROR);
  77   }
  78 
  79   static void report_and_die(Thread* thread, unsigned int sig, address pc, void* siginfo,
  80                              void* context, const char* detail_fmt, ...) ATTRIBUTE_PRINTF(6, 7);
  81   static void report_and_die(const char* message, const char* detail_fmt, ...) ATTRIBUTE_PRINTF(2, 3);
  82 
  83   static fdStream out;
  84   static fdStream log; // error log used by VMError::report_and_die()
  85 
  86 public:
  87 
  88   // return a string to describe the error
  89   static char* error_string(char* buf, int buflen, int id, const char* message,
  90                             const char* detail_fmt, va_list detail_args, address pc,
  91                             const char* filename, int lineno) ATTRIBUTE_PRINTF(5, 0);
  92 
  93   // Record status of core/minidump
  94   static void record_coredump_status(const char* message, bool status);
  95 
  96   /**
  97    * main error reporting function
  98    *
  99    * int          id;         // Solaris/Linux signals: 0 - SIGRTMAX
 100    *                          // Windows exceptions: 0xCxxxxxxx system errors
 101    *                          //                     0x8xxxxxxx system warnings
 102    * const char*  message;
 103    * const char*  detail_fmt;
 104    * va_list      detail_args;
 105    * Thread*      thread;     // NULL if it's native thread
 106    *
 107    * additional info for crashes
 108    *
 109    * address      pc;         // faulting PC
 110    * void*        siginfo;    // ExceptionRecord on Windows,
 111    *                          // siginfo_t on Solaris/Linux
 112    * void*        context;    // ContextRecord on Windows,
 113    *                          // ucontext_t on Solaris/Linux
 114    *
 115    * additional info for VM internal errors
 116    *
 117    * const char*  filename;
 118    * int          lineno;
 119    *
 120    * used by reporting about OOM
 121    *
 122    * size_t       size;
 123    */
 124   static void report_and_die(int id, const char* message, const char* detail_fmt, va_list detail_args,
 125                              Thread* thread, address pc, void* siginfo, void* context,
 126                              const char* filename, int lineno, size_t size) ATTRIBUTE_PRINTF(3, 0);
 127 
 128   static void report_and_die(Thread* thread, unsigned int sig, address pc,
 129                              void* siginfo, void* context);
 130 
 131   static void report_and_die(Thread* thread,const char* filename, int lineno, const char* message,
 132                              const char* detail_fmt, va_list detail_args) ATTRIBUTE_PRINTF(5, 0);
 133 
 134   static void report_and_die(Thread* thread, const char* filename, int lineno, size_t size,
 135                              VMErrorType vm_err_type, const char* detail_fmt,
 136                              va_list detail_args) ATTRIBUTE_PRINTF(6, 0);
 137 
 138   static void report_and_die(const char* message);
 139 
 140   // reporting OutOfMemoryError
 141   static void report_java_out_of_memory(const char* message);
 142 
 143   // returns original flags for signal, if it was resetted, or -1 if
 144   // signal was not changed by error reporter
 145   static int get_resetted_sigflags(int sig);
 146 
 147   // returns original handler for signal, if it was resetted, or NULL if
 148   // signal was not changed by error reporter
 149   static address get_resetted_sighandler(int sig);
 150 
 151   // check to see if fatal error reporting is in progress
 152   static bool fatal_error_in_progress() { return first_error_tid != -1; }
 153 
 154   static jlong get_first_error_tid() {
 155     return first_error_tid;
 156   }
 157 };
 158 
 159 #endif // SHARE_VM_UTILITIES_VMERROR_HPP