/*

 * Copyright (c) 2011, 2018, 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 "classfile/classLoaderStats.hpp"

#include "classfile/compactHashtable.hpp"

#include "compiler/compileBroker.hpp"

#include "compiler/directivesParser.hpp"

#include "gc/shared/vmGCOperations.hpp"

#include "memory/resourceArea.hpp"

#include "oops/objArrayOop.inline.hpp"

#include "oops/oop.inline.hpp"

#include "oops/typeArrayOop.inline.hpp"

#include "runtime/globals.hpp"

#include "runtime/handles.inline.hpp"

#include "runtime/javaCalls.hpp"

#include "runtime/os.hpp"

#include "services/diagnosticArgument.hpp"

#include "services/diagnosticCommand.hpp"

#include "services/diagnosticFramework.hpp"

#include "services/heapDumper.hpp"

#include "services/management.hpp"

#include "services/writeableFlags.hpp"

#include "utilities/debug.hpp"

#include "utilities/formatBuffer.hpp"

#include "utilities/macros.hpp"

static void loadAgentModule(TRAPS) {

  ResourceMark rm(THREAD);

  HandleMark hm(THREAD);

  JavaValue result(T_OBJECT);

  Handle h_module_name = java_lang_String::create_from_str("jdk.management.agent", CHECK);

  JavaCalls::call_static(&result,

                         SystemDictionary::module_Modules_klass(),

                         vmSymbols::loadModule_name(),

                         vmSymbols::loadModule_signature(),

                         h_module_name,

                         THREAD);

}

void DCmdRegistrant::register_dcmds(){

  // Registration of the diagnostic commands

  // First argument specifies which interfaces will export the command

  // Second argument specifies if the command is enabled

  // Third  argument specifies if the command is hidden

  uint32_t full_export = DCmd_Source_Internal | DCmd_Source_AttachAPI

                         | DCmd_Source_MBean;

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<HelpDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<VersionDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<CommandLineDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<PrintSystemPropertiesDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<PrintVMFlagsDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<SetVMFlagDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<VMDynamicLibrariesDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<VMUptimeDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<VMInfoDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<SystemGCDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<RunFinalizationDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<HeapInfoDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<FinalizerInfoDCmd>(full_export, true, false));

#if INCLUDE_SERVICES

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<HeapDumpDCmd>(DCmd_Source_Internal | DCmd_Source_AttachAPI, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<ClassHistogramDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<ClassStatsDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<SystemDictionaryDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<ClassHierarchyDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<SymboltableDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<StringtableDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<MetaspaceDCmd>(full_export, true, false));

#if INCLUDE_JVMTI // Both JVMTI and SERVICES have to be enabled to have this dcmd

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<JVMTIAgentLoadDCmd>(full_export, true, false));

#endif // INCLUDE_JVMTI

#endif // INCLUDE_SERVICES

#if INCLUDE_JVMTI

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<JVMTIDataDumpDCmd>(full_export, true, false));

#endif // INCLUDE_JVMTI

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<ThreadDumpDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<ClassLoaderStatsDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<CompileQueueDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<CodeListDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<CodeCacheDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<TouchedMethodsDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<CodeHeapAnalyticsDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<CompilerDirectivesPrintDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<CompilerDirectivesAddDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<CompilerDirectivesRemoveDCmd>(full_export, true, false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<CompilerDirectivesClearDCmd>(full_export, true, false));

  // Enhanced JMX Agent Support

  // These commands won't be exported via the DiagnosticCommandMBean until an

  // appropriate permission is created for them

  uint32_t jmx_agent_export_flags = DCmd_Source_Internal | DCmd_Source_AttachAPI;

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<JMXStartRemoteDCmd>(jmx_agent_export_flags, true,false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<JMXStartLocalDCmd>(jmx_agent_export_flags, true,false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<JMXStopRemoteDCmd>(jmx_agent_export_flags, true,false));

  DCmdFactory::register_DCmdFactory(new DCmdFactoryImpl<JMXStatusDCmd>(jmx_agent_export_flags, true,false));

}

#ifndef HAVE_EXTRA_DCMD

void DCmdRegistrant::register_dcmds_ext(){

   // Do nothing here

}

#endif

HelpDCmd::HelpDCmd(outputStream* output, bool heap) : DCmdWithParser(output, heap),

  _all("-all", "Show help for all commands", "BOOLEAN", false, "false"),

  _cmd("command name", "The name of the command for which we want help",

        "STRING", false) {

  _dcmdparser.add_dcmd_option(&_all);

  _dcmdparser.add_dcmd_argument(&_cmd);

};

static int compare_strings(const char** s1, const char** s2) {

  return ::strcmp(*s1, *s2);

}

void HelpDCmd::execute(DCmdSource source, TRAPS) {

  if (_all.value()) {

    GrowableArray<const char*>* cmd_list = DCmdFactory::DCmd_list(source);

    cmd_list->sort(compare_strings);

    for (int i = 0; i < cmd_list->length(); i++) {

      DCmdFactory* factory = DCmdFactory::factory(source, cmd_list->at(i),

                                                  strlen(cmd_list->at(i)));

      output()->print_cr("%s%s", factory->name(),

                         factory->is_enabled() ? "" : " [disabled]");

      output()->print_cr("\t%s", factory->description());

      output()->cr();

      factory = factory->next();

    }

  } else if (_cmd.has_value()) {

    DCmd* cmd = NULL;

    DCmdFactory* factory = DCmdFactory::factory(source, _cmd.value(),

                                                strlen(_cmd.value()));

    if (factory != NULL) {

      output()->print_cr("%s%s", factory->name(),

                         factory->is_enabled() ? "" : " [disabled]");

      output()->print_cr("%s", factory->description());

      output()->print_cr("\nImpact: %s", factory->impact());

      JavaPermission p = factory->permission();

      if(p._class != NULL) {

        if(p._action != NULL) {

          output()->print_cr("\nPermission: %s(%s, %s)",

                  p._class, p._name == NULL ? "null" : p._name, p._action);

        } else {

          output()->print_cr("\nPermission: %s(%s)",

                  p._class, p._name == NULL ? "null" : p._name);

        }

      }

      output()->cr();

      cmd = factory->create_resource_instance(output());

      if (cmd != NULL) {

        DCmdMark mark(cmd);

        cmd->print_help(factory->name());

      }

    } else {

      output()->print_cr("Help unavailable : '%s' : No such command", _cmd.value());

    }

  } else {

    output()->print_cr("The following commands are available:");

    GrowableArray<const char *>* cmd_list = DCmdFactory::DCmd_list(source);

    cmd_list->sort(compare_strings);

    for (int i = 0; i < cmd_list->length(); i++) {

      DCmdFactory* factory = DCmdFactory::factory(source, cmd_list->at(i),

                                                  strlen(cmd_list->at(i)));

      output()->print_cr("%s%s", factory->name(),

                         factory->is_enabled() ? "" : " [disabled]");

      factory = factory->_next;

    }

    output()->print_cr("\nFor more information about a specific command use 'help <command>'.");

  }

}

int HelpDCmd::num_arguments() {

  ResourceMark rm;

  HelpDCmd* dcmd = new HelpDCmd(NULL, false);

  if (dcmd != NULL) {

    DCmdMark mark(dcmd);

    return dcmd->_dcmdparser.num_arguments();

  } else {

    return 0;

  }

}

void VersionDCmd::execute(DCmdSource source, TRAPS) {

  output()->print_cr("%s version %s", Abstract_VM_Version::vm_name(),

          Abstract_VM_Version::vm_release());

  JDK_Version jdk_version = JDK_Version::current();

  if (jdk_version.patch_version() > 0) {

    output()->print_cr("JDK %d.%d.%d.%d", jdk_version.major_version(),

            jdk_version.minor_version(), jdk_version.security_version(),

            jdk_version.patch_version());

  } else {

    output()->print_cr("JDK %d.%d.%d", jdk_version.major_version(),

            jdk_version.minor_version(), jdk_version.security_version());

  }

}

PrintVMFlagsDCmd::PrintVMFlagsDCmd(outputStream* output, bool heap) :

                                   DCmdWithParser(output, heap),

  _all("-all", "Print all flags supported by the VM", "BOOLEAN", false, "false") {

  _dcmdparser.add_dcmd_option(&_all);

}

void PrintVMFlagsDCmd::execute(DCmdSource source, TRAPS) {

  if (_all.value()) {

    CommandLineFlags::printFlags(output(), true);

  } else {

    CommandLineFlags::printSetFlags(output());

  }

}

int PrintVMFlagsDCmd::num_arguments() {

    ResourceMark rm;

    PrintVMFlagsDCmd* dcmd = new PrintVMFlagsDCmd(NULL, false);

    if (dcmd != NULL) {

      DCmdMark mark(dcmd);

      return dcmd->_dcmdparser.num_arguments();

    } else {

      return 0;

    }

}

SetVMFlagDCmd::SetVMFlagDCmd(outputStream* output, bool heap) :

                                   DCmdWithParser(output, heap),

  _flag("flag name", "The name of the flag we want to set",

        "STRING", true),

  _value("string value", "The value we want to set", "STRING", false) {

  _dcmdparser.add_dcmd_argument(&_flag);

  _dcmdparser.add_dcmd_argument(&_value);

}

void SetVMFlagDCmd::execute(DCmdSource source, TRAPS) {

  const char* val = NULL;

  if (_value.value() != NULL) {

    val = _value.value();

  }

  FormatBuffer<80> err_msg("%s", "");

  int ret = WriteableFlags::set_flag(_flag.value(), val, Flag::MANAGEMENT, err_msg);

  if (ret != Flag::SUCCESS) {

    output()->print_cr("%s", err_msg.buffer());

  }

}

int SetVMFlagDCmd::num_arguments() {

  ResourceMark rm;

  SetVMFlagDCmd* dcmd = new SetVMFlagDCmd(NULL, false);

  if (dcmd != NULL) {

    DCmdMark mark(dcmd);

    return dcmd->_dcmdparser.num_arguments();

  } else {

    return 0;

  }

}

void JVMTIDataDumpDCmd::execute(DCmdSource source, TRAPS) {

  if (JvmtiExport::should_post_data_dump()) {

    JvmtiExport::post_data_dump();

  }

}

#if INCLUDE_SERVICES

JVMTIAgentLoadDCmd::JVMTIAgentLoadDCmd(outputStream* output, bool heap) :

                                       DCmdWithParser(output, heap),

  _libpath("library path", "Absolute path of the JVMTI agent to load.",

           "STRING", true),

  _option("agent option", "Option string to pass the agent.", "STRING", false) {

  _dcmdparser.add_dcmd_argument(&_libpath);

  _dcmdparser.add_dcmd_argument(&_option);

}

void JVMTIAgentLoadDCmd::execute(DCmdSource source, TRAPS) {

  if (_libpath.value() == NULL) {

    output()->print_cr("JVMTI.agent_load dcmd needs library path.");

    return;

  }

  char *suffix = strrchr(_libpath.value(), '.');

  bool is_java_agent = (suffix != NULL) && (strncmp(".jar", suffix, 4) == 0);

  if (is_java_agent) {

    if (_option.value() == NULL) {

      JvmtiExport::load_agent_library("instrument", "false",

                                      _libpath.value(), output());

    } else {

      size_t opt_len = strlen(_libpath.value()) + strlen(_option.value()) + 2;

      if (opt_len > 4096) {

        output()->print_cr("JVMTI agent attach failed: Options is too long.");

        return;

      }

      char *opt = (char *)os::malloc(opt_len, mtInternal);

      if (opt == NULL) {

        output()->print_cr("JVMTI agent attach failed: "

                           "Could not allocate " SIZE_FORMAT " bytes for argument.",

                           opt_len);

        return;

      }

      jio_snprintf(opt, opt_len, "%s=%s", _libpath.value(), _option.value());

      JvmtiExport::load_agent_library("instrument", "false", opt, output());

      os::free(opt);

    }

  } else {

    JvmtiExport::load_agent_library(_libpath.value(), "true",

                                    _option.value(), output());

  }

}

int JVMTIAgentLoadDCmd::num_arguments() {

  ResourceMark rm;

  JVMTIAgentLoadDCmd* dcmd = new JVMTIAgentLoadDCmd(NULL, false);

  if (dcmd != NULL) {

    DCmdMark mark(dcmd);

    return dcmd->_dcmdparser.num_arguments();

  } else {

    return 0;

  }

}

#endif // INCLUDE_SERVICES

void PrintSystemPropertiesDCmd::execute(DCmdSource source, TRAPS) {

  // load VMSupport

  Symbol* klass = vmSymbols::jdk_internal_vm_VMSupport();

  Klass* k = SystemDictionary::resolve_or_fail(klass, true, CHECK);

  InstanceKlass* ik = InstanceKlass::cast(k);

  if (ik->should_be_initialized()) {

    ik->initialize(THREAD);

  }

  if (HAS_PENDING_EXCEPTION) {

    java_lang_Throwable::print(PENDING_EXCEPTION, output());

    output()->cr();

    CLEAR_PENDING_EXCEPTION;

    return;

  }

  // invoke the serializePropertiesToByteArray method

  JavaValue result(T_OBJECT);

  JavaCallArguments args;

  Symbol* signature = vmSymbols::serializePropertiesToByteArray_signature();

  JavaCalls::call_static(&result,

                         ik,

                         vmSymbols::serializePropertiesToByteArray_name(),

                         signature,

                         &args,

                         THREAD);

  if (HAS_PENDING_EXCEPTION) {

    java_lang_Throwable::print(PENDING_EXCEPTION, output());

    output()->cr();

    CLEAR_PENDING_EXCEPTION;

    return;

  }

  // The result should be a [B

  oop res = (oop)result.get_jobject();

  assert(res->is_typeArray(), "just checking");

  assert(TypeArrayKlass::cast(res->klass())->element_type() == T_BYTE, "just checking");

  // copy the bytes to the output stream

  typeArrayOop ba = typeArrayOop(res);

  jbyte* addr = typeArrayOop(res)->byte_at_addr(0);

  output()->print_raw((const char*)addr, ba->length());

}

VMUptimeDCmd::VMUptimeDCmd(outputStream* output, bool heap) :

                           DCmdWithParser(output, heap),

  _date("-date", "Add a prefix with current date", "BOOLEAN", false, "false") {

  _dcmdparser.add_dcmd_option(&_date);

}

void VMUptimeDCmd::execute(DCmdSource source, TRAPS) {

  if (_date.value()) {

    output()->date_stamp(true, "", ": ");

  }

  output()->time_stamp().update_to(tty->time_stamp().ticks());

  output()->stamp();

  output()->print_cr(" s");

}

int VMUptimeDCmd::num_arguments() {

  ResourceMark rm;

  VMUptimeDCmd* dcmd = new VMUptimeDCmd(NULL, false);

  if (dcmd != NULL) {

    DCmdMark mark(dcmd);

    return dcmd->_dcmdparser.num_arguments();

  } else {

    return 0;

  }

}

void VMInfoDCmd::execute(DCmdSource source, TRAPS) {

  VMError::print_vm_info(_output);

}

void SystemGCDCmd::execute(DCmdSource source, TRAPS) {

  Universe::heap()->collect(GCCause::_dcmd_gc_run);

}

void RunFinalizationDCmd::execute(DCmdSource source, TRAPS) {

  Klass* k = SystemDictionary::resolve_or_fail(vmSymbols::java_lang_System(),

                                                 true, CHECK);

  JavaValue result(T_VOID);

  JavaCalls::call_static(&result, k,

                         vmSymbols::run_finalization_name(),

                         vmSymbols::void_method_signature(), CHECK);

}

void HeapInfoDCmd::execute(DCmdSource source, TRAPS) {

  MutexLocker hl(Heap_lock);

  Universe::heap()->print_on(output());

}

void FinalizerInfoDCmd::execute(DCmdSource source, TRAPS) {

  ResourceMark rm;

  Klass* k = SystemDictionary::resolve_or_fail(

    vmSymbols::finalizer_histogram_klass(), true, CHECK);

  JavaValue result(T_ARRAY);

  // We are calling lang.ref.FinalizerHistogram.getFinalizerHistogram() method

  // and expect it to return array of FinalizerHistogramEntry as Object[]

  JavaCalls::call_static(&result, k,

                         vmSymbols::get_finalizer_histogram_name(),

                         vmSymbols::void_finalizer_histogram_entry_array_signature(), CHECK);

  objArrayOop result_oop = (objArrayOop) result.get_jobject();

  if (result_oop->length() == 0) {

    output()->print_cr("No instances waiting for finalization found");

    return;

  }

  oop foop = result_oop->obj_at(0);

  InstanceKlass* ik = InstanceKlass::cast(foop->klass());

  fieldDescriptor count_fd, name_fd;

  Klass* count_res = ik->find_field(

    vmSymbols::finalizer_histogram_entry_count_field(), vmSymbols::int_signature(), &count_fd);

  Klass* name_res = ik->find_field(

    vmSymbols::finalizer_histogram_entry_name_field(), vmSymbols::string_signature(), &name_fd);

  assert(count_res != NULL && name_res != NULL, "Unexpected layout of FinalizerHistogramEntry");

  output()->print_cr("Unreachable instances waiting for finalization");

  output()->print_cr("#instances  class name");

  output()->print_cr("-----------------------");

  for (int i = 0; i < result_oop->length(); ++i) {

    oop element_oop = result_oop->obj_at(i);

    oop str_oop = element_oop->obj_field(name_fd.offset());

    char *name = java_lang_String::as_utf8_string(str_oop);

    int count = element_oop->int_field(count_fd.offset());

    output()->print_cr("%10d  %s", count, name);

  }

}

#if INCLUDE_SERVICES // Heap dumping/inspection supported