/*

 * Copyright (c) 1997, 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 "aot/aotLoader.hpp"

#include "classfile/classLoader.hpp"

#include "classfile/classLoaderDataGraph.hpp"

#include "classfile/stringTable.hpp"

#include "classfile/symbolTable.hpp"

#include "classfile/systemDictionary.hpp"

#include "code/codeCache.hpp"

#include "compiler/compileBroker.hpp"

#include "compiler/compilerOracle.hpp"

#include "interpreter/bytecodeHistogram.hpp"

#include "jfr/jfrEvents.hpp"

#include "jfr/support/jfrThreadId.hpp"

#if INCLUDE_JVMCI

#include "jvmci/jvmci.hpp"

#endif

#include "logging/log.hpp"

#include "logging/logStream.hpp"

#include "memory/oopFactory.hpp"

#include "memory/resourceArea.hpp"

#include "memory/dynamicArchive.hpp"

#include "memory/universe.hpp"

#include "oops/constantPool.hpp"

#include "oops/generateOopMap.hpp"

#include "oops/instanceKlass.hpp"

#include "oops/instanceOop.hpp"

#include "oops/method.hpp"

#include "oops/objArrayOop.hpp"

#include "oops/oop.inline.hpp"

#include "oops/symbol.hpp"

#include "prims/jvmtiExport.hpp"

#include "runtime/arguments.hpp"

#include "runtime/biasedLocking.hpp"

#include "runtime/deoptimization.hpp"

#include "runtime/flags/flagSetting.hpp"

#include "runtime/handles.inline.hpp"

#include "runtime/init.hpp"

#include "runtime/interfaceSupport.inline.hpp"

#include "runtime/java.hpp"

#include "runtime/memprofiler.hpp"

#include "runtime/sharedRuntime.hpp"

#include "runtime/statSampler.hpp"

#include "runtime/sweeper.hpp"

#include "runtime/task.hpp"

#include "runtime/thread.inline.hpp"

#include "runtime/timer.hpp"

#include "runtime/vmOperations.hpp"

#include "services/memTracker.hpp"

#include "utilities/dtrace.hpp"

#include "utilities/globalDefinitions.hpp"

#include "utilities/histogram.hpp"

#include "utilities/macros.hpp"

#include "utilities/vmError.hpp"

#ifdef COMPILER1

#include "c1/c1_Compiler.hpp"

#include "c1/c1_Runtime1.hpp"

#endif

#ifdef COMPILER2

#include "code/compiledIC.hpp"

#include "opto/compile.hpp"

#include "opto/indexSet.hpp"

#include "opto/runtime.hpp"

#endif

#if INCLUDE_JFR

#include "jfr/jfr.hpp"

#endif

GrowableArray<Method*>* collected_profiled_methods;

int compare_methods(Method** a, Method** b) {

  // %%% there can be 32-bit overflow here

  return ((*b)->invocation_count() + (*b)->compiled_invocation_count())

       - ((*a)->invocation_count() + (*a)->compiled_invocation_count());

}

void collect_profiled_methods(Method* m) {

  Thread* thread = Thread::current();

  methodHandle mh(thread, m);

  if ((m->method_data() != NULL) &&

      (PrintMethodData || CompilerOracle::should_print(mh))) {

    collected_profiled_methods->push(m);

  }

}

void print_method_profiling_data() {

  if (ProfileInterpreter COMPILER1_PRESENT(|| C1UpdateMethodData) &&

     (PrintMethodData || CompilerOracle::should_print_methods())) {

    ResourceMark rm;

    HandleMark hm;

    collected_profiled_methods = new GrowableArray<Method*>(1024);

    SystemDictionary::methods_do(collect_profiled_methods);

    collected_profiled_methods->sort(&compare_methods);

    int count = collected_profiled_methods->length();

    int total_size = 0;

    if (count > 0) {

      for (int index = 0; index < count; index++) {

        Method* m = collected_profiled_methods->at(index);

        ttyLocker ttyl;

        tty->print_cr("------------------------------------------------------------------------");

        m->print_invocation_count();

        tty->print_cr("  mdo size: %d bytes", m->method_data()->size_in_bytes());

        tty->cr();

        // Dump data on parameters if any

        if (m->method_data() != NULL && m->method_data()->parameters_type_data() != NULL) {

          tty->fill_to(2);

          m->method_data()->parameters_type_data()->print_data_on(tty);

        }

        m->print_codes();

        total_size += m->method_data()->size_in_bytes();

      }

      tty->print_cr("------------------------------------------------------------------------");

      tty->print_cr("Total MDO size: %d bytes", total_size);

    }

  }

}

#ifndef PRODUCT

// Statistics printing (method invocation histogram)

GrowableArray<Method*>* collected_invoked_methods;

void collect_invoked_methods(Method* m) {

  if (m->invocation_count() + m->compiled_invocation_count() >= 1 ) {

    collected_invoked_methods->push(m);

  }

}

void print_method_invocation_histogram() {

  ResourceMark rm;

  HandleMark hm;

  collected_invoked_methods = new GrowableArray<Method*>(1024);

  SystemDictionary::methods_do(collect_invoked_methods);

  collected_invoked_methods->sort(&compare_methods);

  //

  tty->cr();

  tty->print_cr("Histogram Over Method Invocation Counters (cutoff = " INTX_FORMAT "):", MethodHistogramCutoff);

  tty->cr();

  tty->print_cr("____Count_(I+C)____Method________________________Module_________________");

  unsigned total = 0, int_total = 0, comp_total = 0, static_total = 0, final_total = 0,

      synch_total = 0, nativ_total = 0, acces_total = 0;

  for (int index = 0; index < collected_invoked_methods->length(); index++) {

    Method* m = collected_invoked_methods->at(index);

    int c = m->invocation_count() + m->compiled_invocation_count();

    if (c >= MethodHistogramCutoff) m->print_invocation_count();

    int_total  += m->invocation_count();

    comp_total += m->compiled_invocation_count();

    if (m->is_final())        final_total  += c;

    if (m->is_static())       static_total += c;

    if (m->is_synchronized()) synch_total  += c;

    if (m->is_native())       nativ_total  += c;

    if (m->is_accessor())     acces_total  += c;

  }

  tty->cr();

  total = int_total + comp_total;

  tty->print_cr("Invocations summary:");

  tty->print_cr("\t%9d (%4.1f%%) interpreted",  int_total,    100.0 * int_total    / total);

  tty->print_cr("\t%9d (%4.1f%%) compiled",     comp_total,   100.0 * comp_total   / total);

  tty->print_cr("\t%9d (100%%)  total",         total);

  tty->print_cr("\t%9d (%4.1f%%) synchronized", synch_total,  100.0 * synch_total  / total);

  tty->print_cr("\t%9d (%4.1f%%) final",        final_total,  100.0 * final_total  / total);

  tty->print_cr("\t%9d (%4.1f%%) static",       static_total, 100.0 * static_total / total);

  tty->print_cr("\t%9d (%4.1f%%) native",       nativ_total,  100.0 * nativ_total  / total);

  tty->print_cr("\t%9d (%4.1f%%) accessor",     acces_total,  100.0 * acces_total  / total);

  tty->cr();

  SharedRuntime::print_call_statistics(comp_total);

}

void print_bytecode_count() {

  if (CountBytecodes || TraceBytecodes || StopInterpreterAt) {

    tty->print_cr("[BytecodeCounter::counter_value = %d]", BytecodeCounter::counter_value());

  }

}

// General statistics printing (profiling ...)

void print_statistics() {

#ifdef ASSERT

  if (CountRuntimeCalls) {

    extern Histogram *RuntimeHistogram;

    RuntimeHistogram->print();

  }

  if (CountJNICalls) {

    extern Histogram *JNIHistogram;

    JNIHistogram->print();

  }

  if (CountJVMCalls) {

    extern Histogram *JVMHistogram;

    JVMHistogram->print();

  }

#endif

  if (MemProfiling) {

    MemProfiler::disengage();

  }

  if (CITime) {

    CompileBroker::print_times();

  }

#ifdef COMPILER1

  if ((PrintC1Statistics || LogVMOutput || LogCompilation) && UseCompiler) {

    FlagSetting fs(DisplayVMOutput, DisplayVMOutput && PrintC1Statistics);

    Runtime1::print_statistics();

    Deoptimization::print_statistics();

    SharedRuntime::print_statistics();

  }

#endif /* COMPILER1 */

#ifdef COMPILER2

  if ((PrintOptoStatistics || LogVMOutput || LogCompilation) && UseCompiler) {

    FlagSetting fs(DisplayVMOutput, DisplayVMOutput && PrintOptoStatistics);

    Compile::print_statistics();

#ifndef COMPILER1

    Deoptimization::print_statistics();

    SharedRuntime::print_statistics();

#endif //COMPILER1

    os::print_statistics();

  }

  if (PrintLockStatistics || PrintPreciseBiasedLockingStatistics || PrintPreciseRTMLockingStatistics) {

    OptoRuntime::print_named_counters();

  }

#ifdef ASSERT

  if (CollectIndexSetStatistics) {

    IndexSet::print_statistics();

  }

#endif // ASSERT

#else // COMPILER2

#if INCLUDE_JVMCI

#ifndef COMPILER1

  if ((TraceDeoptimization || LogVMOutput || LogCompilation) && UseCompiler) {

    FlagSetting fs(DisplayVMOutput, DisplayVMOutput && TraceDeoptimization);

    Deoptimization::print_statistics();

    SharedRuntime::print_statistics();

  }

#endif // COMPILER1

#endif // INCLUDE_JVMCI

#endif // COMPILER2

  if (PrintAOTStatistics) {

    AOTLoader::print_statistics();

  }

  if (PrintNMethodStatistics) {

    nmethod::print_statistics();

  }

  if (CountCompiledCalls) {

    print_method_invocation_histogram();

  }

  print_method_profiling_data();

  if (TimeOopMap) {

    GenerateOopMap::print_time();

  }

  if (PrintSymbolTableSizeHistogram) {

    SymbolTable::print_histogram();

  }

  if (CountBytecodes || TraceBytecodes || StopInterpreterAt) {

    BytecodeCounter::print();

  }

  if (PrintBytecodePairHistogram) {

    BytecodePairHistogram::print();

  }

  if (PrintCodeCache) {

    MutexLocker mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);

    CodeCache::print();

  }

  // CodeHeap State Analytics.

  // Does also call NMethodSweeper::print(tty)

  if (PrintCodeHeapAnalytics) {

    CompileBroker::print_heapinfo(NULL, "all", 4096); // details

  } else if (PrintMethodFlushingStatistics) {

    NMethodSweeper::print(tty);

  }

  if (PrintCodeCache2) {

    MutexLocker mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);

    CodeCache::print_internals();

  }

  if (PrintVtableStats) {

    klassVtable::print_statistics();

    klassItable::print_statistics();

  }

  if (VerifyOops && Verbose) {

    tty->print_cr("+VerifyOops count: %d", StubRoutines::verify_oop_count());

  }

  print_bytecode_count();

  if (PrintSystemDictionaryAtExit) {

    ResourceMark rm;

    MutexLocker mcld(ClassLoaderDataGraph_lock);

    SystemDictionary::print();

    ClassLoaderDataGraph::print();

  }

  if (LogTouchedMethods && PrintTouchedMethodsAtExit) {

    Method::print_touched_methods(tty);

  }

  if (PrintBiasedLockingStatistics) {

    BiasedLocking::print_counters();

  }

  // Native memory tracking data

  if (PrintNMTStatistics) {

    MemTracker::final_report(tty);

  }

  ThreadsSMRSupport::log_statistics();

}

#else // PRODUCT MODE STATISTICS

void print_statistics() {

  if (PrintMethodData) {

    print_method_profiling_data();

  }

  if (CITime) {

    CompileBroker::print_times();

  }

  if (PrintCodeCache) {

    MutexLocker mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);

    CodeCache::print();

  }

  // CodeHeap State Analytics.

  // Does also call NMethodSweeper::print(tty)

  if (PrintCodeHeapAnalytics) {

    CompileBroker::print_heapinfo(NULL, "all", 4096); // details

  } else if (PrintMethodFlushingStatistics) {

    NMethodSweeper::print(tty);

  }

#ifdef COMPILER2

  if (PrintPreciseBiasedLockingStatistics || PrintPreciseRTMLockingStatistics) {

    OptoRuntime::print_named_counters();

  }

#endif

  if (PrintBiasedLockingStatistics) {

    BiasedLocking::print_counters();

  }

  // Native memory tracking data

  if (PrintNMTStatistics) {

    MemTracker::final_report(tty);

  }

  if (LogTouchedMethods && PrintTouchedMethodsAtExit) {

    Method::print_touched_methods(tty);

  }

  ThreadsSMRSupport::log_statistics();

}

#endif

// Note: before_exit() can be executed only once, if more than one threads

//       are trying to shutdown the VM at the same time, only one thread

//       can run before_exit() and all other threads must wait.

void before_exit(JavaThread* thread) {

  #define BEFORE_EXIT_NOT_RUN 0

  #define BEFORE_EXIT_RUNNING 1

  #define BEFORE_EXIT_DONE    2

  static jint volatile _before_exit_status = BEFORE_EXIT_NOT_RUN;

  // Note: don't use a Mutex to guard the entire before_exit(), as

  // JVMTI post_thread_end_event and post_vm_death_event will run native code.

  // A CAS or OSMutex would work just fine but then we need to manipulate

  // thread state for Safepoint. Here we use Monitor wait() and notify_all()

  // for synchronization.

  { MonitorLocker ml(BeforeExit_lock);

    switch (_before_exit_status) {

    case BEFORE_EXIT_NOT_RUN:

      _before_exit_status = BEFORE_EXIT_RUNNING;

      break;

    case BEFORE_EXIT_RUNNING:

      while (_before_exit_status == BEFORE_EXIT_RUNNING) {

        ml.wait();

      }

      assert(_before_exit_status == BEFORE_EXIT_DONE, "invalid state");

      return;

    case BEFORE_EXIT_DONE:

      // need block to avoid SS compiler bug

      {

        return;

      }

    }

  }

#if INCLUDE_JVMCI

  JVMCI::shutdown();

#endif

  // Hang forever on exit if we're reporting an error.

  if (ShowMessageBoxOnError && VMError::is_error_reported()) {

    os::infinite_sleep();

  }

  EventThreadEnd event;

  if (event.should_commit()) {

    event.set_thread(JFR_THREAD_ID(thread));

    event.commit();

  }

  JFR_ONLY(Jfr::on_vm_shutdown();)

  // Stop the WatcherThread. We do this before disenrolling various

  // PeriodicTasks to reduce the likelihood of races.

  if (PeriodicTask::num_tasks() > 0) {

    WatcherThread::stop();

  }

  // shut down the StatSampler task

  StatSampler::disengage();

  StatSampler::destroy();

  // Stop concurrent GC threads

  Universe::heap()->stop();

  // Print GC/heap related information.

  Log(gc, heap, exit) log;

  if (log.is_info()) {

    ResourceMark rm;

    LogStream ls_info(log.info());

    Universe::print_on(&ls_info);

    if (log.is_trace()) {

      LogStream ls_trace(log.trace());

      MutexLocker mcld(ClassLoaderDataGraph_lock);

      ClassLoaderDataGraph::print_on(&ls_trace);

    }

  }

  if (PrintBytecodeHistogram) {

    BytecodeHistogram::print();

  }

  if (JvmtiExport::should_post_thread_life()) {

    JvmtiExport::post_thread_end(thread);

  }

  // Always call even when there are not JVMTI environments yet, since environments

  // may be attached late and JVMTI must track phases of VM execution

  JvmtiExport::post_vm_death();

  Threads::shutdown_vm_agents();

  // Terminate the signal thread

  // Note: we don't wait until it actually dies.

  os::terminate_signal_thread();

#if INCLUDE_CDS

  if (DynamicDumpSharedSpaces) {

    DynamicArchive::dump();

  }

#endif

  print_statistics();

  Universe::heap()->print_tracing_info();