/*

 * Copyright (c) 2003, 2012, Oracle and/or its affiliates. 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 *

 */

#include "precompiled.hpp"

#include "compiler/compileBroker.hpp"

#include "gc_interface/collectedHeap.hpp"

#include "prims/whitebox.hpp"

#include "runtime/arguments.hpp"

#include "runtime/frame.inline.hpp"

#include "runtime/init.hpp"

#include "runtime/os.hpp"

#include "runtime/thread.hpp"

#include "runtime/vmThread.hpp"

#include "runtime/vm_operations.hpp"

#include "utilities/debug.hpp"

#include "utilities/decoder.hpp"

#include "utilities/defaultStream.hpp"

#include "utilities/errorReporter.hpp"

#include "utilities/events.hpp"

#include "utilities/top.hpp"

#include "utilities/vmError.hpp"

// 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/BSD

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

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

  // defined on Linux

  "LD_ASSUME_KERNEL", "_JAVA_SR_SIGNUM",

  // defined on Darwin

  "DYLD_LIBRARY_PATH", "DYLD_FALLBACK_LIBRARY_PATH",

  "DYLD_FRAMEWORK_PATH", "DYLD_FALLBACK_FRAMEWORK_PATH",

  "DYLD_INSERT_LIBRARIES",

  // 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, unsigned 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 = NULL;

    _detail_msg = NULL;

    _filename = NULL;

    _lineno = 0;

    _size = 0;

}

// Constructor for internal errors

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

                 const char* message, const char * detail_msg)

{

  _thread = thread;

  _id = internal_error;     // Value that's not an OS exception/signal

  _filename = filename;

  _lineno = lineno;

  _message = message;

  _detail_msg = detail_msg;

  _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, const char* filename, int lineno, size_t size,

                 const char* message) {

    _thread = thread;

    _id = oom_error;     // Value that's not an OS exception/signal

    _filename = filename;

    _lineno = lineno;

    _message = message;

    _detail_msg = NULL;

    _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;     // Value that's not an OS exception/signal

    _filename = NULL;

    _lineno = 0;

    _message = message;

    _detail_msg = NULL;

    _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() &&

      !thread->is_hidden_from_external_view()) {

    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("#");

}

bool VMError::coredump_status;

char VMError::coredump_message[O_BUFLEN];

void VMError::report_coredump_status(const char* message, bool status) {

  coredump_status = status;

  strncpy(coredump_message, message, sizeof(coredump_message));

  coredump_message[sizeof(coredump_message)-1] = 0;

}

// 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);

    int n = jio_snprintf(buf, buflen,

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

                         p ? p + 1 : _filename, _lineno,

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

    if (n >= 0 && n < buflen && _message) {

      if (_detail_msg) {

        jio_snprintf(buf + n, buflen - n, "%s%s: %s",

                     os::line_separator(), _message, _detail_msg);

      } else {

        jio_snprintf(buf + n, buflen - n, "%sError: %s",

                     os::line_separator(), _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;

}

void VMError::print_stack_trace(outputStream* st, JavaThread* jt,

                                char* buf, int buflen, bool verbose) {

#ifdef ZERO

  if (jt->zero_stack()->sp() && jt->top_zero_frame()) {

    // StackFrameStream uses the frame anchor, which may not have

    // been set up.  This can be done at any time in Zero, however,

    // so if it hasn't been set up then we just set it up now and

    // clear it again when we're done.

    bool has_last_Java_frame = jt->has_last_Java_frame();

    if (!has_last_Java_frame)

      jt->set_last_Java_frame();

    st->print("Java frames:");

    // If the top frame is a Shark frame and the frame anchor isn't

    // set up then it's possible that the information in the frame

    // is garbage: it could be from a previous decache, or it could

    // simply have never been written.  So we print a warning...

    StackFrameStream sfs(jt);

    if (!has_last_Java_frame && !sfs.is_done()) {

      if (sfs.current()->zeroframe()->is_shark_frame()) {

        st->print(" (TOP FRAME MAY BE JUNK)");

      }

    }

    st->cr();

    // Print the frames

    for(int i = 0; !sfs.is_done(); sfs.next(), i++) {

      sfs.current()->zero_print_on_error(i, st, buf, buflen);

      st->cr();

    }

    // Reset the frame anchor if necessary

    if (!has_last_Java_frame)

      jt->reset_last_Java_frame();

  }

#else

  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, buflen, verbose);

      st->cr();

    }

  }

#endif // ZERO

}

// 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 fatal error message)")

    st->print_cr("#");

    if (should_report_bug(_id)) {

      st->print_cr("# A fatal error has been detected by the Java Runtime Environment:");

    } else {

      st->print_cr("# There is insufficient memory for the Java "

                   "Runtime Environment to continue.");

    }

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

     switch(_id) {

       case oom_error:

         if (_size) {

           st->print("# Native memory allocation (malloc) failed to allocate ");

           jio_snprintf(buf, sizeof(buf), SIZE_FORMAT, _size);

           st->print(buf);

           st->print(" bytes");

           if (_message != NULL) {

             st->print(" for ");

             st->print(_message);

           }

           st->cr();

         } else {

           if (_message != NULL)

             st->print("# ");

             st->print_cr(_message);

         }

         // In error file give some solutions

         if (_verbose) {

           st->print_cr("# Possible reasons:");

           st->print_cr("#   The system is out of physical RAM or swap space");

           st->print_cr("#   In 32 bit mode, the process size limit was hit");

           st->print_cr("# Possible solutions:");

           st->print_cr("#   Reduce memory load on the system");

           st->print_cr("#   Increase physical memory or swap space");

           st->print_cr("#   Check if swap backing store is full");

           st->print_cr("#   Use 64 bit Java on a 64 bit OS");

           st->print_cr("#   Decrease Java heap size (-Xmx/-Xms)");

           st->print_cr("#   Decrease number of Java threads");

           st->print_cr("#   Decrease Java thread stack sizes (-Xss)");

           st->print_cr("#   Set larger code cache with -XX:ReservedCodeCacheSize=");

           st->print_cr("# This output file may be truncated or incomplete.");

         } else {

           return;  // that's enough for the screen

         }

         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 {

       if (should_report_bug(_id)) {

         st->print("Internal Error");

       } else {

         st->print("Out of Memory 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, ":%d", _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)")

     if (should_report_bug(_id)) {  // already printed the message.

       // error message

       if (_detail_msg) {

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

       } else if (_message) {

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

       }

    }

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

     // VM version

     st->print_cr("#");

     JDK_Version::current().to_string(buf, sizeof(buf));

     st->print_cr("# JRE version: %s", buf);

     st->print_cr("# Java VM: %s (%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(),

                   UseCompressedOops ? "compressed oops" : ""

                 );

  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(63, "(printing core file information)")

    st->print("# ");

    if (coredump_status) {

      st->print("Core dump written. Default location: %s", coredump_message);

    } else {

      st->print("Failed to write core dump. %s", coredump_message);

    }

    st->print_cr("");

    st->print_cr("#");

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

     if (should_report_bug(_id) && _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();

     }