/*

 * Copyright (c) 2003, 2019, 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 "jvm.h"

#include "code/codeCache.hpp"

#include "compiler/compileBroker.hpp"

#include "compiler/disassembler.hpp"

#include "gc/shared/gcConfig.hpp"

#include "logging/logConfiguration.hpp"

#include "jfr/jfrEvents.hpp"

#include "memory/resourceArea.hpp"

#include "memory/universe.hpp"

#include "oops/compressedOops.hpp"

#include "prims/whitebox.hpp"

#include "runtime/arguments.hpp"

#include "runtime/atomic.hpp"

#include "runtime/frame.inline.hpp"

#include "runtime/init.hpp"

#include "runtime/os.hpp"

#include "runtime/thread.inline.hpp"

#include "runtime/threadSMR.hpp"

#include "runtime/vmThread.hpp"

#include "runtime/vmOperations.hpp"

#include "runtime/vm_version.hpp"

#include "runtime/flags/jvmFlag.hpp"

#include "services/memTracker.hpp"

#include "utilities/debug.hpp"

#include "utilities/decoder.hpp"

#include "utilities/defaultStream.hpp"

#include "utilities/events.hpp"

#include "utilities/vmError.hpp"

#include "utilities/macros.hpp"

#if INCLUDE_JFR

#include "jfr/jfr.hpp"

#endif

#ifndef PRODUCT

#include <signal.h>

#endif // PRODUCT

bool VMError::_error_reported = false;

// call this when the VM is dying--it might loosen some asserts

bool VMError::is_error_reported() { return _error_reported; }

// returns an address which is guaranteed to generate a SIGSEGV on read,

// for test purposes, which is not NULL and contains bits in every word

void* VMError::get_segfault_address() {

  return (void*)

#ifdef _LP64

    0xABC0000000000ABCULL;

#else

    0x00000ABC;

#endif

}

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

  "LIBPATH", "LDR_PRELOAD", "LDR_PRELOAD64",

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

};

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

  // 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::record_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 (strlen(_detail_msg) > 0) {

        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:");

    st->cr();

    // Print the frames

    StackFrameStream sfs(jt);

    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

}

void VMError::print_native_stack(outputStream* st, frame fr, Thread* t, char* buf, int buf_size) {

  // see if it's a valid frame

  if (fr.pc()) {

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

    int count = 0;

    while (count++ < StackPrintLimit) {

      fr.print_on_error(st, buf, buf_size);

      if (fr.pc()) { // print source file and line, if available

        char buf[128];

        int line_no;

        if (Decoder::get_source_info(fr.pc(), buf, sizeof(buf), &line_no)) {

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

        }

      }

      st->cr();

      // Compiled code may use EBP register on x86 so it looks like

      // non-walkable C frame. Use frame.sender() for java frames.

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

        // Catch very first native frame by using stack address.

        // For JavaThread stack_base and stack_size should be set.

        if (!t->on_local_stack((address)(fr.real_fp() + 1))) {

          break;

        }

        if (fr.is_java_frame() || fr.is_native_frame() || fr.is_runtime_frame()) {

          RegisterMap map((JavaThread*)t, false); // No update

          fr = fr.sender(&map);

        } else {

          // is_first_C_frame() does only simple checks for frame pointer,

          // it will pass if java compiled code has a pointer in EBP.

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

          fr = os::get_sender_for_C_frame(&fr);

        }

      } else {

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

  }

}

static void print_oom_reasons(outputStream* st) {

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

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

  if (UseCompressedOops) {

    st->print_cr("#   The process is running with CompressedOops enabled, and the Java Heap may be blocking the growth of the native heap");

  }

  if (LogBytesPerWord == 2) {

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

  if (LogBytesPerWord == 2) {

    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=");

  if (UseCompressedOops) {

    switch (CompressedOops::mode()) {

      case CompressedOops::UnscaledNarrowOop:

        st->print_cr("#   JVM is running with Unscaled Compressed Oops mode in which the Java heap is");

        st->print_cr("#     placed in the first 4GB address space. The Java Heap base address is the");

        st->print_cr("#     maximum limit for the native heap growth. Please use -XX:HeapBaseMinAddress");

        st->print_cr("#     to set the Java Heap base and to place the Java Heap above 4GB virtual address.");

        break;

      case CompressedOops::ZeroBasedNarrowOop:

        st->print_cr("#   JVM is running with Zero Based Compressed Oops mode in which the Java heap is");

        st->print_cr("#     placed in the first 32GB address space. The Java Heap base address is the");

        st->print_cr("#     maximum limit for the native heap growth. Please use -XX:HeapBaseMinAddress");

        st->print_cr("#     to set the Java Heap base and to place the Java Heap above 32GB virtual address.");

        break;

      default:

        break;

    }

  }

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

}

static void report_vm_version(outputStream* st, char* buf, int buflen) {

   // VM version

   st->print_cr("#");

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

   const char* runtime_name = JDK_Version::runtime_name() != NULL ?

                                JDK_Version::runtime_name() : "";

   const char* runtime_version = JDK_Version::runtime_version() != NULL ?

                                   JDK_Version::runtime_version() : "";

   const char* jdk_debug_level = VM_Version::printable_jdk_debug_level() != NULL ?

                                   VM_Version::printable_jdk_debug_level() : "";

   // This is the long version with some default settings added

                 VM_Version::vm_name(),

                 jdk_debug_level,

                 VM_Version::vm_release(),

                 VM_Version::vm_info_string(),

                 TieredCompilation ? ", tiered" : "",

#if INCLUDE_JVMCI

                 EnableJVMCI ? ", jvmci" : "",

                 UseJVMCICompiler ? ", jvmci compiler" : "",

#else

                 "", "",

#endif

                 UseCompressedOops ? ", compressed oops" : "",

                 GCConfig::hs_err_name(),

                 VM_Version::vm_platform_string()

               );

}

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

int          VMError::_current_step;

const char*  VMError::_current_step_info;

volatile jlong VMError::_reporting_start_time = -1;

volatile bool VMError::_reporting_did_timeout = false;

volatile jlong VMError::_step_start_time = -1;

volatile bool VMError::_step_did_timeout = false;

// Helper, return current timestamp for timeout handling.

jlong VMError::get_current_timestamp() {

  return os::javaTimeNanos();

}

// Factor to translate the timestamp to seconds.

#define TIMESTAMP_TO_SECONDS_FACTOR (1000 * 1000 * 1000)

void VMError::record_reporting_start_time() {

  const jlong now = get_current_timestamp();

  Atomic::store(now, &_reporting_start_time);

}

jlong VMError::get_reporting_start_time() {

  return Atomic::load(&_reporting_start_time);

}

void VMError::record_step_start_time() {

  const jlong now = get_current_timestamp();

  Atomic::store(now, &_step_start_time);

}

jlong VMError::get_step_start_time() {

  return Atomic::load(&_step_start_time);

}

void VMError::clear_step_start_time() {

  return Atomic::store((jlong)0, &_step_start_time);

}

void VMError::report(outputStream* st, bool _verbose) {

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

# define STEP(s) } if (_current_step < __LINE__) { _current_step = __LINE__; _current_step_info = s; \

  record_step_start_time(); _step_did_timeout = false;

# define END clear_step_start_time(); }

  // don't allocate large buffer on stack

  static char buf[O_BUFLEN];

  BEGIN

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

    }

#ifndef PRODUCT

  // Error handler self tests

  // test secondary error handling. Test it twice, to test that resetting

  // error handler after a secondary crash works.

  STEP("test secondary crash 1")

    if (_verbose && TestCrashInErrorHandler != 0) {

      st->print_cr("Will crash now (TestCrashInErrorHandler=" UINTX_FORMAT ")...",

        TestCrashInErrorHandler);

      controlled_crash(TestCrashInErrorHandler);

    }

  STEP("test secondary crash 2")

    if (_verbose && TestCrashInErrorHandler != 0) {

      st->print_cr("Will crash now (TestCrashInErrorHandler=" UINTX_FORMAT ")...",

        TestCrashInErrorHandler);

      controlled_crash(TestCrashInErrorHandler);

    }

  // TestUnresponsiveErrorHandler: We want to test both step timeouts and global timeout.

  // Step to global timeout ratio is 4:1, so in order to be absolutely sure we hit the

  // global timeout, let's execute the timeout step five times.

  // See corresponding test in test/runtime/ErrorHandling/TimeoutInErrorHandlingTest.java

  STEP("setup for test unresponsive error reporting step")

    if (_verbose && TestUnresponsiveErrorHandler) {

      // We record reporting_start_time for this test here because we

      // care about the time spent executing TIMEOUT_TEST_STEP and not

      // about the time it took us to get here.

      tty->print_cr("Recording reporting_start_time for TestUnresponsiveErrorHandler.");

      record_reporting_start_time();

    }

  #define TIMEOUT_TEST_STEP STEP("test unresponsive error reporting step") \

    if (_verbose && TestUnresponsiveErrorHandler) { os::infinite_sleep(); }

  TIMEOUT_TEST_STEP

  TIMEOUT_TEST_STEP

  TIMEOUT_TEST_STEP

  TIMEOUT_TEST_STEP

  TIMEOUT_TEST_STEP

  STEP("test safefetch in error handler")

    // test whether it is safe to use SafeFetch32 in Crash Handler. Test twice

    // to test that resetting the signal handler works correctly.

    if (_verbose && TestSafeFetchInErrorHandler) {

      st->print_cr("Will test SafeFetch...");

      if (CanUseSafeFetch32()) {

        int* const invalid_pointer = (int*) get_segfault_address();

        const int x = 0x76543210;

        int i1 = SafeFetch32(invalid_pointer, x);

        int i2 = SafeFetch32(invalid_pointer, x);

        if (i1 == x && i2 == x) {

          st->print_cr("SafeFetch OK."); // Correctly deflected and returned default pattern

        } else {

          st->print_cr("??");