zgu@3900: /*
drchase@6680:  * Copyright (c) 2012, 2014, Oracle and/or its affiliates. All rights reserved.
zgu@3900:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
zgu@3900:  *
zgu@3900:  * This code is free software; you can redistribute it and/or modify it
zgu@3900:  * under the terms of the GNU General Public License version 2 only, as
zgu@3900:  * published by the Free Software Foundation.
zgu@3900:  *
zgu@3900:  * This code is distributed in the hope that it will be useful, but WITHOUT
zgu@3900:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
zgu@3900:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
zgu@3900:  * version 2 for more details (a copy is included in the LICENSE file that
zgu@3900:  * accompanied this code).
zgu@3900:  *
zgu@3900:  * You should have received a copy of the GNU General Public License version
zgu@3900:  * 2 along with this work; if not, write to the Free Software Foundation,
zgu@3900:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
zgu@3900:  *
zgu@3900:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
zgu@3900:  * or visit www.oracle.com if you need additional information or have any
zgu@3900:  * questions.
zgu@3900:  *
zgu@3900:  */
zgu@3900: #include "precompiled.hpp"
zgu@7074: 
zgu@7074: #include "runtime/mutexLocker.hpp"
zgu@3900: #include "services/nmtDCmd.hpp"
zgu@3900: #include "services/memReporter.hpp"
zgu@3900: #include "services/memTracker.hpp"
zgu@3900: #include "utilities/globalDefinitions.hpp"
zgu@3900: 
zgu@3900: NMTDCmd::NMTDCmd(outputStream* output,
zgu@3900:   bool heap): DCmdWithParser(output, heap),
zgu@3900:   _summary("summary", "request runtime to report current memory summary, " \
zgu@3900:            "which includes total reserved and committed memory, along " \
zgu@3900:            "with memory usage summary by each subsytem.",
zgu@3900:            "BOOLEAN", false, "false"),
zgu@3900:   _detail("detail", "request runtime to report memory allocation >= "
zgu@3900:            "1K by each callsite.",
zgu@3900:            "BOOLEAN", false, "false"),
zgu@3900:   _baseline("baseline", "request runtime to baseline current memory usage, " \
zgu@3900:             "so it can be compared against in later time.",
zgu@3900:             "BOOLEAN", false, "false"),
zgu@3900:   _summary_diff("summary.diff", "request runtime to report memory summary " \
zgu@3900:             "comparison against previous baseline.",
zgu@3900:             "BOOLEAN", false, "false"),
zgu@3900:   _detail_diff("detail.diff", "request runtime to report memory detail " \
zgu@3900:             "comparison against previous baseline, which shows the memory " \
zgu@3900:             "allocation activities at different callsites.",
zgu@3900:             "BOOLEAN", false, "false"),
zgu@3900:   _shutdown("shutdown", "request runtime to shutdown itself and free the " \
zgu@3900:             "memory used by runtime.",
zgu@3900:             "BOOLEAN", false, "false"),
zgu@7074:   _statistics("statistics", "print tracker statistics for tuning purpose.", \
zgu@3900:             "BOOLEAN", false, "false"),
zgu@3900:   _scale("scale", "Memory usage in which scale, KB, MB or GB",
zgu@3900:        "STRING", false, "KB") {
zgu@3900:   _dcmdparser.add_dcmd_option(&_summary);
zgu@3900:   _dcmdparser.add_dcmd_option(&_detail);
zgu@3900:   _dcmdparser.add_dcmd_option(&_baseline);
zgu@3900:   _dcmdparser.add_dcmd_option(&_summary_diff);
zgu@3900:   _dcmdparser.add_dcmd_option(&_detail_diff);
zgu@3900:   _dcmdparser.add_dcmd_option(&_shutdown);
zgu@7074:   _dcmdparser.add_dcmd_option(&_statistics);
zgu@3900:   _dcmdparser.add_dcmd_option(&_scale);
zgu@3900: }
zgu@3900: 
zgu@7074: 
zgu@7074: size_t NMTDCmd::get_scale(const char* scale) const {
zgu@7074:   if (scale == NULL) return 0;
zgu@7074:   return NMTUtil::scale_from_name(scale);
zgu@7074: }
zgu@7074: 
fparain@5047: void NMTDCmd::execute(DCmdSource source, TRAPS) {
zgu@7074:   // Check NMT state
zgu@7074:   //  native memory tracking has to be on
zgu@7074:   if (MemTracker::tracking_level() == NMT_off) {
zgu@7074:     output()->print_cr("Native memory tracking is not enabled");
zgu@7074:     return;
zgu@7074:   } else if (MemTracker::tracking_level() == NMT_minimal) {
zgu@7074:      output()->print_cr("Native memory tracking has been shutdown");
zgu@7074:      return;
zgu@7074:   }
zgu@7074: 
zgu@3900:   const char* scale_value = _scale.value();
zgu@7074:   size_t scale_unit = get_scale(scale_value);
zgu@7074:   if (scale_unit == 0) {
zgu@3900:     output()->print_cr("Incorrect scale value: %s", scale_value);
zgu@3900:     return;
zgu@3900:   }
zgu@3900: 
zgu@3900:   int nopt = 0;
zgu@4810:   if (_summary.is_set() && _summary.value()) { ++nopt; }
zgu@4810:   if (_detail.is_set() && _detail.value()) { ++nopt; }
zgu@4810:   if (_baseline.is_set() && _baseline.value()) { ++nopt; }
zgu@4810:   if (_summary_diff.is_set() && _summary_diff.value()) { ++nopt; }
zgu@4810:   if (_detail_diff.is_set() && _detail_diff.value()) { ++nopt; }
zgu@4810:   if (_shutdown.is_set() && _shutdown.value()) { ++nopt; }
zgu@7074:   if (_statistics.is_set() && _statistics.value()) { ++nopt; }
zgu@3900: 
zgu@4810:   if (nopt > 1) {
zgu@3900:       output()->print_cr("At most one of the following option can be specified: " \
zgu@7074:         "summary, detail, baseline, summary.diff, detail.diff, shutdown");
zgu@3900:       return;
zgu@4348:   } else if (nopt == 0) {
zgu@4348:     if (_summary.is_set()) {
zgu@4348:       output()->print_cr("No command to execute");
zgu@4348:       return;
zgu@4348:     } else {
zgu@3900:       _summary.set_value(true);
zgu@4348:     }
zgu@3900:   }
zgu@3900: 
zgu@7074:   // Serialize NMT query
zgu@7074:   MutexLocker locker(MemTracker::query_lock());
zgu@7074: 
zgu@7074:   if (_summary.value()) {
zgu@7074:     report(true, scale_unit);
zgu@7074:   } else if (_detail.value()) {
zgu@7074:     if (!check_detail_tracking_level(output())) {
zgu@3900:     return;
zgu@3900:   }
zgu@7074:     report(false, scale_unit);
zgu@7074:   } else if (_baseline.value()) {
zgu@7074:     MemBaseline& baseline = MemTracker::get_baseline();
zgu@7074:     if (!baseline.baseline(MemTracker::tracking_level() != NMT_detail)) {
zgu@7074:       output()->print_cr("Baseline failed");
zgu@7074:     } else {
zgu@7074:       output()->print_cr("Baseline succeeded");
zgu@7074:     }
zgu@7074:   } else if (_summary_diff.value()) {
zgu@7074:     MemBaseline& baseline = MemTracker::get_baseline();
zgu@7074:     if (baseline.baseline_type() >= MemBaseline::Summary_baselined) {
zgu@7074:       report_diff(true, scale_unit);
zgu@7074:     } else {
zgu@7074:       output()->print_cr("No baseline for comparison");
zgu@7074:     }
zgu@7074:   } else if (_detail_diff.value()) {
zgu@7074:     if (!check_detail_tracking_level(output())) {
zgu@3900:     return;
zgu@3900:   }
zgu@7074:     MemBaseline& baseline = MemTracker::get_baseline();
zgu@7074:     if (baseline.baseline_type() == MemBaseline::Detail_baselined) {
zgu@7074:       report_diff(false, scale_unit);
zgu@3900:     } else {
zgu@7074:       output()->print_cr("No detail baseline for comparison");
zgu@3900:     }
zgu@3900:   } else if (_shutdown.value()) {
zgu@7074:     MemTracker::shutdown();
zgu@7074:     output()->print_cr("Native memory tracking has been turned off");
zgu@7074:   } else if (_statistics.value()) {
zgu@7074:     if (check_detail_tracking_level(output())) {
zgu@7074:       MemTracker::tuning_statistics(output());
zgu@7074:     }
zgu@3900:   } else {
zgu@3900:     ShouldNotReachHere();
zgu@3900:     output()->print_cr("Unknown command");
zgu@3900:   }
zgu@3900: }
zgu@3900: 
zgu@3900: int NMTDCmd::num_arguments() {
zgu@3900:   ResourceMark rm;
zgu@3900:   NMTDCmd* dcmd = new NMTDCmd(NULL, false);
zgu@3900:   if (dcmd != NULL) {
zgu@3900:     DCmdMark mark(dcmd);
zgu@3900:     return dcmd->_dcmdparser.num_arguments();
zgu@3900:   } else {
zgu@3900:     return 0;
zgu@3900:   }
zgu@3900: }
zgu@3900: 
zgu@7074: void NMTDCmd::report(bool summaryOnly, size_t scale_unit) {
zgu@7074:   MemBaseline baseline;
zgu@7074:   if (baseline.baseline(summaryOnly)) {
zgu@7074:     if (summaryOnly) {
zgu@7074:       MemSummaryReporter rpt(baseline, output(), scale_unit);
zgu@7074:       rpt.report();
zgu@7074:     } else {
zgu@7074:       MemDetailReporter rpt(baseline, output(), scale_unit);
zgu@7074:       rpt.report();
zgu@7074:     }
zgu@7074:   }
zgu@7074: }
zgu@7074: 
zgu@7074: void NMTDCmd::report_diff(bool summaryOnly, size_t scale_unit) {
zgu@7074:   MemBaseline& early_baseline = MemTracker::get_baseline();
zgu@7074:   assert(early_baseline.baseline_type() != MemBaseline::Not_baselined,
zgu@7074:     "Not yet baselined");
zgu@7074:   assert(summaryOnly || early_baseline.baseline_type() == MemBaseline::Detail_baselined,
zgu@7074:     "Not a detail baseline");
zgu@7074: 
zgu@7074:   MemBaseline baseline;
zgu@7074:   if (baseline.baseline(summaryOnly)) {
zgu@7074:     if (summaryOnly) {
zgu@7074:       MemSummaryDiffReporter rpt(early_baseline, baseline, output(), scale_unit);
zgu@7074:       rpt.report_diff();
zgu@7074:     } else {
zgu@7074:       MemDetailDiffReporter rpt(early_baseline, baseline, output(), scale_unit);
zgu@7074:       rpt.report_diff();
zgu@7074:     }
zgu@7074:   }
zgu@7074: }
zgu@7074: 
zgu@7074: bool NMTDCmd::check_detail_tracking_level(outputStream* out) {
zgu@7074:   if (MemTracker::tracking_level() == NMT_detail) {
zgu@7074:     return true;
zgu@7074:   } else if (MemTracker::cmdline_tracking_level() == NMT_detail) {
zgu@7074:     out->print_cr("Tracking level has been downgraded due to lack of resources");
zgu@7074:     return false;
zgu@7074:   } else {
zgu@7074:     out->print_cr("Detail tracking is not enabled");
zgu@7074:     return false;
zgu@7074:   }
zgu@7074: }