/*

 * Copyright 2003-2007 Sun Microsystems, Inc.  All Rights Reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 *

 */

# include "incls/_precompiled.incl"

# include "incls/_vmError.cpp.incl"

// List of environment variables that should be reported in error log file.

const char *env_list[] = {

  // All platforms

  "JAVA_HOME", "JRE_HOME", "JAVA_TOOL_OPTIONS", "_JAVA_OPTIONS", "CLASSPATH",

  "JAVA_COMPILER", "PATH", "USERNAME",

  // Env variables that are defined on Solaris/Linux

  "LD_LIBRARY_PATH", "LD_PRELOAD", "SHELL", "DISPLAY",

  "HOSTTYPE", "OSTYPE", "ARCH", "MACHTYPE",

  // defined on Linux

  "LD_ASSUME_KERNEL", "_JAVA_SR_SIGNUM",

  // defined on Windows

  "OS", "PROCESSOR_IDENTIFIER", "_ALT_JAVA_HOME_DIR",

  (const char *)0

};

// Fatal error handler for internal errors and crashes.

//

// The default behavior of fatal error handler is to print a brief message

// to standard out (defaultStream::output_fd()), then save detailed information

// into an error report file (hs_err_pid<pid>.log) and abort VM. If multiple

// threads are having troubles at the same time, only one error is reported.

// The thread that is reporting error will abort VM when it is done, all other

// threads are blocked forever inside report_and_die().

// Constructor for crashes

VMError::VMError(Thread* thread, int sig, address pc, void* siginfo, void* context) {

    _thread = thread;

    _id = sig;

    _pc   = pc;

    _siginfo = siginfo;

    _context = context;

    _verbose = false;

    _current_step = 0;

    _current_step_info = NULL;

    _message = "";

    _filename = NULL;

    _lineno = 0;

    _size = 0;

}

// Constructor for internal errors

VMError::VMError(Thread* thread, const char* message, const char* filename, int lineno) {

    _thread = thread;

    _id = internal_error;     // set it to a value that's not an OS exception/signal

    _filename = filename;

    _lineno = lineno;

    _message = message;

    _verbose = false;

    _current_step = 0;

    _current_step_info = NULL;

    _pc = NULL;

    _siginfo = NULL;

    _context = NULL;

    _size = 0;

}

// Constructor for OOM errors

VMError::VMError(Thread* thread, size_t size, const char* message, const char* filename, int lineno) {

    _thread = thread;

    _id = oom_error;     // set it to a value that's not an OS exception/signal

    _filename = filename;

    _lineno = lineno;

    _message = message;

    _verbose = false;

    _current_step = 0;

    _current_step_info = NULL;

    _pc = NULL;

    _siginfo = NULL;

    _context = NULL;

    _size = size;

}

// Constructor for non-fatal errors

VMError::VMError(const char* message) {

    _thread = NULL;

    _id = internal_error;     // set it to a value that's not an OS exception/signal

    _filename = NULL;

    _lineno = 0;

    _message = message;

    _verbose = false;

    _current_step = 0;

    _current_step_info = NULL;

    _pc = NULL;

    _siginfo = NULL;

    _context = NULL;

    _size = 0;

}

// -XX:OnError=<string>, where <string> can be a list of commands, separated

// by ';'. "%p" is replaced by current process id (pid); "%%" is replaced by

// a single "%". Some examples:

//

// -XX:OnError="pmap %p"                // show memory map

// -XX:OnError="gcore %p; dbx - %p"     // dump core and launch debugger

// -XX:OnError="cat hs_err_pid%p.log | mail my_email@sun.com"

// -XX:OnError="kill -9 %p"             // ?#!@#

// A simple parser for -XX:OnError, usage:

//  ptr = OnError;

//  while ((cmd = next_OnError_command(buffer, sizeof(buffer), &ptr) != NULL)

//     ... ...

static char* next_OnError_command(char* buf, int buflen, const char** ptr) {

  if (ptr == NULL || *ptr == NULL) return NULL;

  const char* cmd = *ptr;

  // skip leading blanks or ';'

  while (*cmd == ' ' || *cmd == ';') cmd++;

  if (*cmd == '\0') return NULL;

  const char * cmdend = cmd;

  while (*cmdend != '\0' && *cmdend != ';') cmdend++;

  Arguments::copy_expand_pid(cmd, cmdend - cmd, buf, buflen);

  *ptr = (*cmdend == '\0' ? cmdend : cmdend + 1);

  return buf;

}

static void print_bug_submit_message(outputStream *out, Thread *thread) {

  if (out == NULL) return;

  out->print_raw_cr("# If you would like to submit a bug report, please visit:");

  out->print_raw   ("#   ");

  out->print_raw_cr(Arguments::java_vendor_url_bug());

  // If the crash is in native code, encourage user to submit a bug to the

  // provider of that code.

  if (thread && thread->is_Java_thread()) {

    JavaThread* jt = (JavaThread*)thread;

    if (jt->thread_state() == _thread_in_native) {

      out->print_cr("# The crash happened outside the Java Virtual Machine in native code.\n# See problematic frame for where to report the bug.");

    }

  }

  out->print_raw_cr("#");

}

// Return a string to describe the error

char* VMError::error_string(char* buf, int buflen) {

  char signame_buf[64];

  const char *signame = os::exception_name(_id, signame_buf, sizeof(signame_buf));

  if (signame) {

    jio_snprintf(buf, buflen,

                 "%s (0x%x) at pc=" PTR_FORMAT ", pid=%d, tid=" UINTX_FORMAT,

                 signame, _id, _pc,

                 os::current_process_id(), os::current_thread_id());

  } else {

    if (_filename != NULL && _lineno > 0) {

      // skip directory names

      char separator = os::file_separator()[0];

      const char *p = strrchr(_filename, separator);

      jio_snprintf(buf, buflen,

        "Internal Error at %s:%d, pid=%d, tid=" UINTX_FORMAT " \nError: %s",

        p ? p + 1 : _filename, _lineno,

        os::current_process_id(), os::current_thread_id(),

        _message ? _message : "");

    } else {

      jio_snprintf(buf, buflen,

        "Internal Error (0x%x), pid=%d, tid=" UINTX_FORMAT,

        _id, os::current_process_id(), os::current_thread_id());

    }

  }

  return buf;

}

// This is the main function to report a fatal error. Only one thread can

// call this function, so we don't need to worry about MT-safety. But it's

// possible that the error handler itself may crash or die on an internal

// error, for example, when the stack/heap is badly damaged. We must be

// able to handle recursive errors that happen inside error handler.

//

// Error reporting is done in several steps. If a crash or internal error

// occurred when reporting an error, the nested signal/exception handler

// can skip steps that are already (or partially) done. Error reporting will

// continue from the next step. This allows us to retrieve and print

// information that may be unsafe to get after a fatal error. If it happens,

// you may find nested report_and_die() frames when you look at the stack

// in a debugger.

//

// In general, a hang in error handler is much worse than a crash or internal

// error, as it's harder to recover from a hang. Deadlock can happen if we

// try to grab a lock that is already owned by current thread, or if the

// owner is blocked forever (e.g. in os::infinite_sleep()). If possible, the

// error handler and all the functions it called should avoid grabbing any

// lock. An important thing to notice is that memory allocation needs a lock.

//

// We should avoid using large stack allocated buffers. Many errors happen

// when stack space is already low. Making things even worse is that there

// could be nested report_and_die() calls on stack (see above). Only one

// thread can report error, so large buffers are statically allocated in data

// segment.

void VMError::report(outputStream* st) {

# define BEGIN if (_current_step == 0) { _current_step = 1;

# define STEP(n, s) } if (_current_step < n) { _current_step = n; _current_step_info = s;

# define END }

  // don't allocate large buffer on stack

  static char buf[O_BUFLEN];

  BEGIN

  STEP(10, "(printing unexpected error message)")

     st->print_cr("#");

     st->print_cr("# An unexpected error has been detected by Java Runtime Environment:");

  STEP(15, "(printing type of error)")

     switch(_id) {

       case oom_error:

         st->print_cr("#");

         st->print("# java.lang.OutOfMemoryError: ");

         if (_size) {

           st->print("requested ");

           sprintf(buf,"%d",_size);

           st->print(buf);

           st->print(" bytes");

           if (_message != NULL) {

             st->print(" for ");

             st->print(_message);

           }

           st->print_cr(". Out of swap space?");

         } else {

           if (_message != NULL)

             st->print_cr(_message);

         }

         break;

       case internal_error:

       default:

         break;

     }

  STEP(20, "(printing exception/signal name)")

     st->print_cr("#");

     st->print("#  ");

     // Is it an OS exception/signal?

     if (os::exception_name(_id, buf, sizeof(buf))) {

       st->print("%s", buf);

       st->print(" (0x%x)", _id);                // signal number

       st->print(" at pc=" PTR_FORMAT, _pc);

     } else {

       st->print("Internal Error");

       if (_filename != NULL && _lineno > 0) {

#ifdef PRODUCT

         // In product mode chop off pathname?

         char separator = os::file_separator()[0];

         const char *p = strrchr(_filename, separator);

         const char *file = p ? p+1 : _filename;

#else

         const char *file = _filename;

#endif

         size_t len = strlen(file);

         size_t buflen = sizeof(buf);

         strncpy(buf, file, buflen);

         if (len + 10 < buflen) {

           sprintf(buf + len, ":" SIZE_FORMAT, _lineno);

         }

         st->print(" (%s)", buf);

       } else {

         st->print(" (0x%x)", _id);

       }

     }

  STEP(30, "(printing current thread and pid)")

     // process id, thread id

     st->print(", pid=%d", os::current_process_id());

     st->print(", tid=" UINTX_FORMAT, os::current_thread_id());

     st->cr();

  STEP(40, "(printing error message)")

     // error message

     if (_message && _message[0] != '\0') {

       st->print_cr("#  Error: %s", _message);

     }

  STEP(50, "(printing Java version string)")

     // VM version

     st->print_cr("#");

     st->print_cr("# Java VM: %s (%s %s %s)",

                   Abstract_VM_Version::vm_name(),

                   Abstract_VM_Version::vm_release(),

                   Abstract_VM_Version::vm_info_string(),

                   Abstract_VM_Version::vm_platform_string()

                 );

  STEP(60, "(printing problematic frame)")

     // Print current frame if we have a context (i.e. it's a crash)

     if (_context) {

       st->print_cr("# Problematic frame:");

       st->print("# ");

       frame fr = os::fetch_frame_from_context(_context);

       fr.print_on_error(st, buf, sizeof(buf));

       st->cr();

       st->print_cr("#");

     }

  STEP(65, "(printing bug submit message)")

     if (_verbose) print_bug_submit_message(st, _thread);

  STEP(70, "(printing thread)" )

     if (_verbose) {

       st->cr();

       st->print_cr("---------------  T H R E A D  ---------------");

       st->cr();

     }

  STEP(80, "(printing current thread)" )

     // current thread

     if (_verbose) {

       if (_thread) {

         st->print("Current thread (" PTR_FORMAT "):  ", _thread);

         _thread->print_on_error(st, buf, sizeof(buf));

         st->cr();

       } else {

         st->print_cr("Current thread is native thread");

       }

       st->cr();

     }

  STEP(90, "(printing siginfo)" )

     // signal no, signal code, address that caused the fault

     if (_verbose && _siginfo) {

       os::print_siginfo(st, _siginfo);

       st->cr();

     }

  STEP(100, "(printing registers, top of stack, instructions near pc)")

     // registers, top of stack, instructions near pc

     if (_verbose && _context) {

       os::print_context(st, _context);

       st->cr();

     }

  STEP(110, "(printing stack bounds)" )

     if (_verbose) {

       st->print("Stack: ");

       address stack_top;

       size_t stack_size;

       if (_thread) {

          stack_top = _thread->stack_base();

          stack_size = _thread->stack_size();

       } else {

          stack_top = os::current_stack_base();

          stack_size = os::current_stack_size();

       }

       address stack_bottom = stack_top - stack_size;

       st->print("[" PTR_FORMAT "," PTR_FORMAT "]", stack_bottom, stack_top);

       frame fr = _context ? os::fetch_frame_from_context(_context)

                           : os::current_frame();

       if (fr.sp()) {

         st->print(",  sp=" PTR_FORMAT, fr.sp());

         st->print(",  free space=%dk",

                     ((intptr_t)fr.sp() - (intptr_t)stack_bottom) >> 10);

       }

       st->cr();

     }

  STEP(120, "(printing native stack)" )

     if (_verbose) {

       frame fr = _context ? os::fetch_frame_from_context(_context)

                           : os::current_frame();

       // see if it's a valid frame

       if (fr.pc()) {

          st->print_cr("Native frames: (J=compiled Java code, j=interpreted, Vv=VM code, C=native code)");

          int count = 0;

          while (count++ < StackPrintLimit) {

             fr.print_on_error(st, buf, sizeof(buf));

             st->cr();

             if (os::is_first_C_frame(&fr)) break;

             fr = os::get_sender_for_C_frame(&fr);

          }

          if (count > StackPrintLimit) {

             st->print_cr("...<more frames>...");

          }

          st->cr();

       }

     }

  STEP(130, "(printing Java stack)" )

     if (_verbose && _thread && _thread->is_Java_thread()) {

       JavaThread* jt = (JavaThread*)_thread;

       if (jt->has_last_Java_frame()) {

         st->print_cr("Java frames: (J=compiled Java code, j=interpreted, Vv=VM code)");

         for(StackFrameStream sfs(jt); !sfs.is_done(); sfs.next()) {

           sfs.current()->print_on_error(st, buf, sizeof(buf));

           st->cr();

         }

       }

     }

  STEP(140, "(printing VM operation)" )

     if (_verbose && _thread && _thread->is_VM_thread()) {

        VMThread* t = (VMThread*)_thread;

        VM_Operation* op = t->vm_operation();

        if (op) {

          op->print_on_error(st);

          st->cr();

          st->cr();

        }

     }

  STEP(150, "(printing current compile task)" )

     if (_verbose && _thread && _thread->is_Compiler_thread()) {

        CompilerThread* t = (CompilerThread*)_thread;

        if (t->task()) {

           st->cr();

           st->print_cr("Current CompileTask:");

           t->task()->print_line_on_error(st, buf, sizeof(buf));

           st->cr();

        }

     }

  STEP(160, "(printing process)" )

     if (_verbose) {

       st->cr();

       st->print_cr("---------------  P R O C E S S  ---------------");

       st->cr();

     }

  STEP(170, "(printing all threads)" )

     // all threads

     if (_verbose && _thread) {

       Threads::print_on_error(st, _thread, buf, sizeof(buf));

       st->cr();

     }

  STEP(175, "(printing VM state)" )

     if (_verbose) {

       // Safepoint state

       st->print("VM state:");

       if (SafepointSynchronize::is_synchronizing()) st->print("synchronizing");

       else if (SafepointSynchronize::is_at_safepoint()) st->print("at safepoint");

       else st->print("not at safepoint");

       // Also see if error occurred during initialization or shutdown

       if (!Universe::is_fully_initialized()) {

         st->print(" (not fully initialized)");

       } else if (VM_Exit::vm_exited()) {

         st->print(" (shutting down)");

       } else {

         st->print(" (normal execution)");

       }

       st->cr();

       st->cr();

     }

  STEP(180, "(printing owned locks on error)" )