/*

 * Copyright (c) 2012, 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 "memory/allocation.hpp"

#include "services/mallocTracker.hpp"

#include "services/memReporter.hpp"

#include "services/threadStackTracker.hpp"

#include "services/virtualMemoryTracker.hpp"

#include "utilities/globalDefinitions.hpp"

size_t MemReporterBase::reserved_total(const MallocMemory* malloc, const VirtualMemory* vm) const {

  return malloc->malloc_size() + malloc->arena_size() + vm->reserved();

}

size_t MemReporterBase::committed_total(const MallocMemory* malloc, const VirtualMemory* vm) const {

  return malloc->malloc_size() + malloc->arena_size() + vm->committed();

}

void MemReporterBase::print_total(size_t reserved, size_t committed) const {

  const char* scale = current_scale();

  output()->print("reserved=" SIZE_FORMAT "%s, committed=" SIZE_FORMAT "%s",

    amount_in_current_scale(reserved), scale, amount_in_current_scale(committed), scale);

}

void MemReporterBase::print_malloc(size_t amount, size_t count, MEMFLAGS flag) const {

  const char* scale = current_scale();

  outputStream* out = output();

  const char* alloc_type = (flag == mtThreadStack) ? "" : "malloc=";

  if (flag != mtNone) {

    out->print("(%s" SIZE_FORMAT "%s type=%s", alloc_type,

      amount_in_current_scale(amount), scale, NMTUtil::flag_to_name(flag));

  } else {

    out->print("(%s" SIZE_FORMAT "%s", alloc_type,

      amount_in_current_scale(amount), scale);

  }

  if (count > 0) {

    out->print(" #" SIZE_FORMAT "", count);

  }

  out->print(")");

}

void MemReporterBase::print_virtual_memory(size_t reserved, size_t committed) const {

  const char* scale = current_scale();

  output()->print("(mmap: reserved=" SIZE_FORMAT "%s, committed=" SIZE_FORMAT "%s)",

    amount_in_current_scale(reserved), scale, amount_in_current_scale(committed), scale);

}

void MemReporterBase::print_malloc_line(size_t amount, size_t count) const {

  output()->print("%28s", " ");

  print_malloc(amount, count);

  output()->print_cr(" ");

}

void MemReporterBase::print_virtual_memory_line(size_t reserved, size_t committed) const {

  output()->print("%28s", " ");

  print_virtual_memory(reserved, committed);

  output()->print_cr(" ");

}

void MemReporterBase::print_arena_line(size_t amount, size_t count) const {

  const char* scale = current_scale();

  output()->print_cr("%27s (arena=" SIZE_FORMAT "%s #" SIZE_FORMAT ")", " ",

    amount_in_current_scale(amount), scale, count);

}

void MemReporterBase::print_virtual_memory_region(const char* type, address base, size_t size) const {

  const char* scale = current_scale();

  output()->print("[" PTR_FORMAT " - " PTR_FORMAT "] %s " SIZE_FORMAT "%s",

    p2i(base), p2i(base + size), type, amount_in_current_scale(size), scale);

}

void MemSummaryReporter::report() {

  const char* scale = current_scale();

  outputStream* out = output();

  size_t total_reserved_amount = _malloc_snapshot->total() +

    _vm_snapshot->total_reserved();

  size_t total_committed_amount = _malloc_snapshot->total() +

    _vm_snapshot->total_committed();

  // Overall total

  out->print_cr("\nNative Memory Tracking:\n");

  out->print("Total: ");

  print_total(total_reserved_amount, total_committed_amount);

  out->print("\n");

  // Summary by memory type

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

    MEMFLAGS flag = NMTUtil::index_to_flag(index);

    // thread stack is reported as part of thread category

    if (flag == mtThreadStack) continue;

    MallocMemory* malloc_memory = _malloc_snapshot->by_type(flag);

    VirtualMemory* virtual_memory = _vm_snapshot->by_type(flag);

    report_summary_of_type(flag, malloc_memory, virtual_memory);

  }

}

void MemSummaryReporter::report_summary_of_type(MEMFLAGS flag,

  MallocMemory*  malloc_memory, VirtualMemory* virtual_memory) {

  size_t reserved_amount  = reserved_total (malloc_memory, virtual_memory);

  size_t committed_amount = committed_total(malloc_memory, virtual_memory);

  // Count thread's native stack in "Thread" category

  if (flag == mtThread) {

    if (ThreadStackTracker::track_as_vm()) {

      const VirtualMemory* thread_stack_usage =

        (const VirtualMemory*)_vm_snapshot->by_type(mtThreadStack);

      reserved_amount  += thread_stack_usage->reserved();

      committed_amount += thread_stack_usage->committed();

    } else {

      const MallocMemory* thread_stack_usage =

        (const MallocMemory*)_malloc_snapshot->by_type(mtThreadStack);

      reserved_amount += thread_stack_usage->malloc_size();

      committed_amount += thread_stack_usage->malloc_size();

    }

  } else if (flag == mtNMT) {

    // Count malloc headers in "NMT" category

    reserved_amount  += _malloc_snapshot->malloc_overhead()->size();

    committed_amount += _malloc_snapshot->malloc_overhead()->size();

  }

  if (amount_in_current_scale(reserved_amount) > 0) {

    outputStream* out   = output();

    const char*   scale = current_scale();

    out->print("-%26s (", NMTUtil::flag_to_name(flag));

    print_total(reserved_amount, committed_amount);

    out->print_cr(")");

    if (flag == mtClass) {

      // report class count

      out->print_cr("%27s (classes #" SIZE_FORMAT ")",

        " ", (_instance_class_count + _array_class_count));

      out->print_cr("%27s (  instance classes #" SIZE_FORMAT ", array classes #" SIZE_FORMAT ")",

        " ", _instance_class_count, _array_class_count);

    } else if (flag == mtThread) {

      if (ThreadStackTracker::track_as_vm()) {

        const VirtualMemory* thread_stack_usage =

         _vm_snapshot->by_type(mtThreadStack);

        // report thread count

        out->print_cr("%27s (thread #" SIZE_FORMAT ")", " ", ThreadStackTracker::thread_count());

        out->print("%27s (stack: ", " ");

        print_total(thread_stack_usage->reserved(), thread_stack_usage->committed());

      } else {

        MallocMemory* thread_stack_memory = _malloc_snapshot->by_type(mtThreadStack);

        const char* scale = current_scale();

        // report thread count

        assert(ThreadStackTracker::thread_count() == 0, "Not used");

        out->print_cr("%27s (thread #" SIZE_FORMAT ")", " ", thread_stack_memory->malloc_count());

        out->print("%27s (Stack: " SIZE_FORMAT "%s", " ",

          amount_in_current_scale(thread_stack_memory->malloc_size()), scale);

      }

      out->print_cr(")");

    }

     // report malloc'd memory

    if (amount_in_current_scale(malloc_memory->malloc_size()) > 0) {

      // We don't know how many arena chunks are in used, so don't report the count

      size_t count = (flag == mtChunk) ? 0 : malloc_memory->malloc_count();

      print_malloc_line(malloc_memory->malloc_size(), count);

    }

    if (amount_in_current_scale(virtual_memory->reserved()) > 0) {

      print_virtual_memory_line(virtual_memory->reserved(), virtual_memory->committed());

    }

    if (amount_in_current_scale(malloc_memory->arena_size()) > 0) {

      print_arena_line(malloc_memory->arena_size(), malloc_memory->arena_count());

    }

    if (flag == mtNMT &&

      amount_in_current_scale(_malloc_snapshot->malloc_overhead()->size()) > 0) {

      out->print_cr("%27s (tracking overhead=" SIZE_FORMAT "%s)", " ",

        amount_in_current_scale(_malloc_snapshot->malloc_overhead()->size()), scale);

    } else if (flag == mtClass) {

      // Metadata information

      report_metadata(Metaspace::NonClassType);

      if (Metaspace::using_class_space()) {

        report_metadata(Metaspace::ClassType);

      }

    }

    out->print_cr(" ");

  }

}

void MemSummaryReporter::report_metadata(Metaspace::MetadataType type) const {

  assert(type == Metaspace::NonClassType || type == Metaspace::ClassType,

    "Invalid metadata type");

  const char* name = (type == Metaspace::NonClassType) ?

    "Metadata:   " : "Class space:";

  outputStream* out = output();

  const char* scale = current_scale();

  size_t committed   = MetaspaceUtils::committed_bytes(type);

  size_t used = MetaspaceUtils::used_bytes(type);

  size_t free = (MetaspaceUtils::capacity_bytes(type) - used)

              + MetaspaceUtils::free_chunks_total_bytes(type)

              + MetaspaceUtils::free_in_vs_bytes(type);

  assert(committed >= used + free, "Sanity");

  size_t waste = committed - (used + free);

  out->print_cr("%27s (  %s)", " ", name);

  out->print("%27s (    ", " ");

  print_total(MetaspaceUtils::reserved_bytes(type), committed);

  out->print_cr(")");

  out->print_cr("%27s (    used=" SIZE_FORMAT "%s)", " ", amount_in_current_scale(used), scale);

  out->print_cr("%27s (    free=" SIZE_FORMAT "%s)", " ", amount_in_current_scale(free), scale);

  out->print_cr("%27s (    waste=" SIZE_FORMAT "%s =%2.2f%%)", " ", amount_in_current_scale(waste),

    scale, ((float)waste * 100)/committed);

}

void MemDetailReporter::report_detail() {

  // Start detail report

  outputStream* out = output();

  out->print_cr("Details:\n");

  report_malloc_sites();

  report_virtual_memory_allocation_sites();

}

void MemDetailReporter::report_malloc_sites() {

  MallocSiteIterator         malloc_itr = _baseline.malloc_sites(MemBaseline::by_size);

  if (malloc_itr.is_empty()) return;

  outputStream* out = output();

  const MallocSite* malloc_site;

  while ((malloc_site = malloc_itr.next()) != NULL) {

    // Don't report if size is too small

    if (amount_in_current_scale(malloc_site->size()) == 0)

      continue;

    const NativeCallStack* stack = malloc_site->call_stack();

    stack->print_on(out);

    out->print("%29s", " ");

    MEMFLAGS flag = malloc_site->flag();

    assert((flag >= 0 && flag < (int)mt_number_of_types) && flag != mtNone,

      "Must have a valid memory type");

    print_malloc(malloc_site->size(), malloc_site->count(),flag);

    out->print_cr("\n");

  }

}

void MemDetailReporter::report_virtual_memory_allocation_sites()  {

  VirtualMemorySiteIterator  virtual_memory_itr =

    _baseline.virtual_memory_sites(MemBaseline::by_size);

  if (virtual_memory_itr.is_empty()) return;

  outputStream* out = output();

  const VirtualMemoryAllocationSite*  virtual_memory_site;

  while ((virtual_memory_site = virtual_memory_itr.next()) != NULL) {

    // Don't report if size is too small

    if (amount_in_current_scale(virtual_memory_site->reserved()) == 0)

      continue;

    const NativeCallStack* stack = virtual_memory_site->call_stack();

    stack->print_on(out);

    out->print("%28s (", " ");

    print_total(virtual_memory_site->reserved(), virtual_memory_site->committed());

    MEMFLAGS flag = virtual_memory_site->flag();

    if (flag != mtNone) {

      out->print(" Type=%s", NMTUtil::flag_to_name(flag));

    }

    out->print_cr(")\n");

  }

}

void MemDetailReporter::report_virtual_memory_map() {

  // Virtual memory map always in base address order

  VirtualMemoryAllocationIterator itr = _baseline.virtual_memory_allocations();

  const ReservedMemoryRegion* rgn;

  output()->print_cr("Virtual memory map:");

  while ((rgn = itr.next()) != NULL) {

    report_virtual_memory_region(rgn);

  }

}

void MemDetailReporter::report_virtual_memory_region(const ReservedMemoryRegion* reserved_rgn) {

  assert(reserved_rgn != NULL, "NULL pointer");

  // Don't report if size is too small

  if (amount_in_current_scale(reserved_rgn->size()) == 0) return;

  outputStream* out = output();

  const char* scale = current_scale();

  const NativeCallStack*  stack = reserved_rgn->call_stack();

  bool all_committed = reserved_rgn->size() == reserved_rgn->committed_size();

  const char* region_type = (all_committed ? "reserved and committed" : "reserved");

  out->print_cr(" ");

  print_virtual_memory_region(region_type, reserved_rgn->base(), reserved_rgn->size());

  out->print(" for %s", NMTUtil::flag_to_name(reserved_rgn->flag()));

  if (stack->is_empty()) {

    out->print_cr(" ");

  } else {

    out->print_cr(" from");

    stack->print_on(out, 4);

  }

  if (all_committed) {

    CommittedRegionIterator itr = reserved_rgn->iterate_committed_regions();

    const CommittedMemoryRegion* committed_rgn = itr.next();

    if (committed_rgn->size() == reserved_rgn->size() && committed_rgn->call_stack()->equals(*stack)) {

      // One region spanning the entire reserved region, with the same stack trace.

      // Don't print this regions because the "reserved and committed" line above

      // already indicates that the region is comitted.

      assert(itr.next() == NULL, "Unexpectedly more than one regions");

      return;

    }

  }

  CommittedRegionIterator itr = reserved_rgn->iterate_committed_regions();

  const CommittedMemoryRegion* committed_rgn;

  while ((committed_rgn = itr.next()) != NULL) {

    // Don't report if size is too small

    if (amount_in_current_scale(committed_rgn->size()) == 0) continue;

    stack = committed_rgn->call_stack();

    out->print("\n\t");

    print_virtual_memory_region("committed", committed_rgn->base(), committed_rgn->size());

    if (stack->is_empty()) {

      out->print_cr(" ");

    } else {

      out->print_cr(" from");

      stack->print_on(out, 12);

    }

  }

}

void MemSummaryDiffReporter::report_diff() {

  const char* scale = current_scale();

  outputStream* out = output();

  out->print_cr("\nNative Memory Tracking:\n");

  // Overall diff

  out->print("Total: ");

  print_virtual_memory_diff(_current_baseline.total_reserved_memory(),

    _current_baseline.total_committed_memory(), _early_baseline.total_reserved_memory(),

    _early_baseline.total_committed_memory());

  out->print_cr("\n");

  // Summary diff by memory type

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

    MEMFLAGS flag = NMTUtil::index_to_flag(index);

    // thread stack is reported as part of thread category

    if (flag == mtThreadStack) continue;

    diff_summary_of_type(flag,

      _early_baseline.malloc_memory(flag),

      _early_baseline.virtual_memory(flag),

      _early_baseline.metaspace_snapshot(),

      _current_baseline.malloc_memory(flag),

      _current_baseline.virtual_memory(flag),

      _current_baseline.metaspace_snapshot());

  }

}

void MemSummaryDiffReporter::print_malloc_diff(size_t current_amount, size_t current_count,

    size_t early_amount, size_t early_count, MEMFLAGS flags) const {

  const char* scale = current_scale();

  outputStream* out = output();

  const char* alloc_type = (flags == mtThread) ? "" : "malloc=";

  out->print("%s" SIZE_FORMAT "%s", alloc_type, amount_in_current_scale(current_amount), scale);

  // Report type only if it is valid and not under "thread" category

  if (flags != mtNone && flags != mtThread) {

    out->print(" type=%s", NMTUtil::flag_to_name(flags));

  }

  long amount_diff = diff_in_current_scale(current_amount, early_amount);

  if (amount_diff != 0) {

    out->print(" %+ld%s", amount_diff, scale);

  }

  if (current_count > 0) {

    out->print(" #" SIZE_FORMAT "", current_count);

    if (current_count != early_count) {

      out->print(" %+d", (int)(current_count - early_count));

    }

  }

}

void MemSummaryDiffReporter::print_arena_diff(size_t current_amount, size_t current_count,

  size_t early_amount, size_t early_count) const {

  const char* scale = current_scale();

  outputStream* out = output();

  out->print("arena=" SIZE_FORMAT "%s", amount_in_current_scale(current_amount), scale);

  if (diff_in_current_scale(current_amount, early_amount) != 0) {

    out->print(" %+ld", diff_in_current_scale(current_amount, early_amount));

  }

  out->print(" #" SIZE_FORMAT "", current_count);

  if (current_count != early_count) {

    out->print(" %+d", (int)(current_count - early_count));

  }

}

void MemSummaryDiffReporter::print_virtual_memory_diff(size_t current_reserved, size_t current_committed,

    size_t early_reserved, size_t early_committed) const {

  const char* scale = current_scale();

  outputStream* out = output();

  out->print("reserved=" SIZE_FORMAT "%s", amount_in_current_scale(current_reserved), scale);

  long reserved_diff = diff_in_current_scale(current_reserved, early_reserved);

  if (reserved_diff != 0) {

    out->print(" %+ld%s", reserved_diff, scale);

  }

  out->print(", committed=" SIZE_FORMAT "%s", amount_in_current_scale(current_committed), scale);

  long committed_diff = diff_in_current_scale(current_committed, early_committed);

  if (committed_diff != 0) {

    out->print(" %+ld%s", committed_diff, scale);

  }

}

void MemSummaryDiffReporter::diff_summary_of_type(MEMFLAGS flag,

  const MallocMemory* early_malloc, const VirtualMemory* early_vm,

  const MetaspaceSnapshot* early_ms,

  const MallocMemory* current_malloc, const VirtualMemory* current_vm,

  const MetaspaceSnapshot* current_ms) const {

  outputStream* out = output();

  const char* scale = current_scale();

  // Total reserved and committed memory in current baseline

  size_t current_reserved_amount  = reserved_total (current_malloc, current_vm);

  size_t current_committed_amount = committed_total(current_malloc, current_vm);

  // Total reserved and committed memory in early baseline

  size_t early_reserved_amount  = reserved_total(early_malloc, early_vm);

  size_t early_committed_amount = committed_total(early_malloc, early_vm);

  // Adjust virtual memory total

  if (flag == mtThread) {

    const VirtualMemory* early_thread_stack_usage =

      _early_baseline.virtual_memory(mtThreadStack);

    const VirtualMemory* current_thread_stack_usage =

      _current_baseline.virtual_memory(mtThreadStack);

    early_reserved_amount  += early_thread_stack_usage->reserved();

    early_committed_amount += early_thread_stack_usage->committed();

    current_reserved_amount  += current_thread_stack_usage->reserved();

    current_committed_amount += current_thread_stack_usage->committed();

  } else if (flag == mtNMT) {

    early_reserved_amount  += _early_baseline.malloc_tracking_overhead();

    early_committed_amount += _early_baseline.malloc_tracking_overhead();

    current_reserved_amount  += _current_baseline.malloc_tracking_overhead();

    current_committed_amount += _current_baseline.malloc_tracking_overhead();

  }

  if (amount_in_current_scale(current_reserved_amount) > 0 ||

      diff_in_current_scale(current_reserved_amount, early_reserved_amount) != 0) {

    // print summary line

    out->print("-%26s (", NMTUtil::flag_to_name(flag));

    print_virtual_memory_diff(current_reserved_amount, current_committed_amount,

      early_reserved_amount, early_committed_amount);

    out->print_cr(")");

    // detail lines

    if (flag == mtClass) {

      // report class count

      out->print("%27s (classes #" SIZE_FORMAT "", " ", _current_baseline.class_count());