Skip to content

Commit

Permalink
8157023: Integrate NMT with JFR
Browse files Browse the repository at this point in the history
Reviewed-by: stuefe, mgronlun, egahlin
  • Loading branch information
kstefanj committed Dec 7, 2022
1 parent e86f31b commit 3b8c7ef
Show file tree
Hide file tree
Showing 14 changed files with 582 additions and 8 deletions.
13 changes: 13 additions & 0 deletions src/hotspot/share/jfr/metadata/metadata.xml
Original file line number Diff line number Diff line change
Expand Up @@ -720,6 +720,19 @@
<Field type="OldObjectGcRoot" name="root" label="GC Root" />
</Event>

<Event name="NativeMemoryUsage" category="Java Virtual Machine, Memory" label="Native Memory Usage Per Type"
description="Native memory usage for a given memory type in the JVM" period="everyChunk">
<Field type="string" name="type" label="Memory Type" description="Type used for the native memory allocation" />
<Field type="ulong" contentType="bytes" name="reserved" label="Reserved Memory" description="Reserved bytes for this type" />
<Field type="ulong" contentType="bytes" name="committed" label="Committed Memory" description="Committed bytes for this type" />
</Event>

<Event name="NativeMemoryUsageTotal" category="Java Virtual Machine, Memory" label="Total Native Memory Usage"
description="Total native memory usage for the JVM. Might not be the exact sum of the NativeMemoryUsage events due to timeing." period="everyChunk">
<Field type="ulong" contentType="bytes" name="reserved" label="Reserved Memory" description="Total amount of reserved bytes for the JVM" />
<Field type="ulong" contentType="bytes" name="committed" label="Committed Memory" description="Total amount of committed bytes for the JVM" />
</Event>

<Event name="DumpReason" category="Flight Recorder" label="Recording Reason"
description="Who requested the recording and why"
startTime="false">
Expand Down
9 changes: 9 additions & 0 deletions src/hotspot/share/jfr/periodic/jfrPeriodic.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@
#include "runtime/vm_version.hpp"
#include "services/classLoadingService.hpp"
#include "services/management.hpp"
#include "services/memJfrReporter.hpp"
#include "services/threadService.hpp"
#include "utilities/exceptions.hpp"
#include "utilities/globalDefinitions.hpp"
Expand Down Expand Up @@ -624,3 +625,11 @@ TRACE_REQUEST_FUNC(FinalizerStatistics) {
log_debug(jfr, system)("Unable to generate requestable event FinalizerStatistics. The required jvm feature 'management' is missing.");
#endif
}

TRACE_REQUEST_FUNC(NativeMemoryUsage) {
MemJFRReporter::send_type_events();
}

TRACE_REQUEST_FUNC(NativeMemoryUsageTotal) {
MemJFRReporter::send_total_event();
}
7 changes: 6 additions & 1 deletion src/hotspot/share/services/mallocTracker.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,12 @@ class MallocMemorySnapshot : public ResourceObj {


public:
inline MallocMemory* by_type(MEMFLAGS flags) {
inline MallocMemory* by_type(MEMFLAGS flags) {
int index = NMTUtil::flag_to_index(flags);
return &_malloc[index];
}

inline const MallocMemory* by_type(MEMFLAGS flags) const {
int index = NMTUtil::flag_to_index(flags);
return &_malloc[index];
}
Expand Down
113 changes: 113 additions & 0 deletions src/hotspot/share/services/memJfrReporter.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
/*
* Copyright (c) 2022, 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 "jfr/jfrEvents.hpp"
#include "services/memJfrReporter.hpp"
#include "services/memTracker.hpp"
#include "services/nmtUsage.hpp"
#include "utilities/globalDefinitions.hpp"
#include "utilities/ticks.hpp"

// Helper class to avoid refreshing the NMTUsage to often and allow
// the two JFR events to use the same data.
class MemJFRCurrentUsage : public AllStatic {
private:
// The age threshold in milliseconds. If older than this refresh the usage.
static const uint64_t AgeThreshold = 50;

static Ticks _timestamp;
static NMTUsage* _usage;

public:
static NMTUsage* get_usage();
static Ticks get_timestamp();
};

Ticks MemJFRCurrentUsage::_timestamp;
NMTUsage* MemJFRCurrentUsage::_usage = nullptr;

NMTUsage* MemJFRCurrentUsage::get_usage() {
Tickspan since_baselined = Ticks::now() - _timestamp;

if (_usage == nullptr) {
// First time, create a new NMTUsage.
_usage = new NMTUsage(NMTUsage::OptionsNoTS);
} else if (since_baselined.milliseconds() < AgeThreshold) {
// There is recent enough usage information, return it.
return _usage;
}

// Refresh the usage information.
_usage->refresh();
_timestamp.stamp();

return _usage;
}

Ticks MemJFRCurrentUsage::get_timestamp() {
return _timestamp;
}

void MemJFRReporter::send_total_event() {
if (!MemTracker::enabled()) {
return;
}

NMTUsage* usage = MemJFRCurrentUsage::get_usage();
Ticks timestamp = MemJFRCurrentUsage::get_timestamp();

EventNativeMemoryUsageTotal event(UNTIMED);
event.set_starttime(timestamp);
event.set_reserved(usage->total_reserved());
event.set_committed(usage->total_committed());
event.commit();
}

void MemJFRReporter::send_type_event(const Ticks& starttime, const char* type, size_t reserved, size_t committed) {
EventNativeMemoryUsage event(UNTIMED);
event.set_starttime(starttime);
event.set_type(type);
event.set_reserved(reserved);
event.set_committed(committed);
event.commit();
}

void MemJFRReporter::send_type_events() {
if (!MemTracker::enabled()) {
return;
}

NMTUsage* usage = MemJFRCurrentUsage::get_usage();
Ticks timestamp = MemJFRCurrentUsage::get_timestamp();

for (int index = 0; index < mt_number_of_types; index ++) {
MEMFLAGS flag = NMTUtil::index_to_flag(index);
if (flag == mtNone) {
// Skip mtNone since it is not really used.
continue;
}
send_type_event(timestamp, NMTUtil::flag_to_name(flag), usage->reserved(flag), usage->committed(flag));
}
}
44 changes: 44 additions & 0 deletions src/hotspot/share/services/memJfrReporter.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
/*
* Copyright (c) 2022, 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.
*
*/

#ifndef SHARE_SERVICES_MEMJFRREPORTER_HPP
#define SHARE_SERVICES_MEMJFRREPORTER_HPP

#include "memory/allocation.hpp"
#include "services/nmtUsage.hpp"
#include "utilities/globalDefinitions.hpp"
#include "utilities/ticks.hpp"

// MemJFRReporter is only used by threads sending periodic JFR
// events. These threads are synchronized at a higher level,
// so no more synchronization is needed.
class MemJFRReporter : public AllStatic {
private:
static void send_type_event(const Ticks& starttime, const char* tag, size_t reserved, size_t committed);
public:
static void send_total_event();
static void send_type_events();
};

#endif //SHARE_SERVICES_MEMJFRREPORTER_HPP
4 changes: 2 additions & 2 deletions src/hotspot/share/services/memReporter.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@
#include "services/virtualMemoryTracker.hpp"
#include "utilities/globalDefinitions.hpp"

size_t MemReporterBase::reserved_total(const MallocMemory* malloc, const VirtualMemory* vm) const {
size_t MemReporterBase::reserved_total(const MallocMemory* malloc, const VirtualMemory* vm) {
return malloc->malloc_size() + malloc->arena_size() + vm->reserved();
}

size_t MemReporterBase::committed_total(const MallocMemory* malloc, const VirtualMemory* vm) const {
size_t MemReporterBase::committed_total(const MallocMemory* malloc, const VirtualMemory* vm) {
return malloc->malloc_size() + malloc->arena_size() + vm->committed();
}

Expand Down
10 changes: 5 additions & 5 deletions src/hotspot/share/services/memReporter.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,11 @@ class MemReporterBase : public StackObj {
_scale(scale), _output(out)
{}

// Helper functions
// Calculate total reserved and committed amount
static size_t reserved_total(const MallocMemory* malloc, const VirtualMemory* vm);
static size_t committed_total(const MallocMemory* malloc, const VirtualMemory* vm);

protected:
inline outputStream* output() const {
return _output;
Expand All @@ -73,11 +78,6 @@ class MemReporterBase : public StackObj {
return amount / scale;
}

// Helper functions
// Calculate total reserved and committed amount
size_t reserved_total(const MallocMemory* malloc, const VirtualMemory* vm) const;
size_t committed_total(const MallocMemory* malloc, const VirtualMemory* vm) const;

// Print summary total, malloc and virtual memory
void print_total(size_t reserved, size_t committed) const;
void print_malloc(const MemoryCounter* c, MEMFLAGS flag = mtNone) const;
Expand Down
129 changes: 129 additions & 0 deletions src/hotspot/share/services/nmtUsage.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
/*
* Copyright (c) 2022, 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 "runtime/threadCritical.hpp"
#include "services/nmtCommon.hpp"
#include "services/nmtUsage.hpp"
#include "services/mallocTracker.hpp"
#include "services/threadStackTracker.hpp"
#include "services/virtualMemoryTracker.hpp"

// Enabled all options for snapshot.
const NMTUsageOptions NMTUsage::OptionsAll = { true, true, true };
// Skip expensive thread stacks when refreshing usage.
const NMTUsageOptions NMTUsage::OptionsNoTS = { false, true, true };

NMTUsage::NMTUsage(NMTUsageOptions options) :
_malloc_by_type(),
_malloc_total(),
_vm_by_type(),
_vm_total(),
_usage_options(options) { }

void NMTUsage::walk_thread_stacks() {
// If backed by virtual memory, snapping the thread stacks involves walking
// them to to figure out how much memory is committed if they are backed by
// virtual memory. This needs ot happen before we take the snapshot of the
// virtual memory since it will update this information.
if (ThreadStackTracker::track_as_vm()) {
VirtualMemoryTracker::snapshot_thread_stacks();
}
}

void NMTUsage::update_malloc_usage() {
// Thread critical needed keep values in sync, total area size
// is deducted from mtChunk in the end to give correct values.
ThreadCritical tc;
const MallocMemorySnapshot* ms = MallocMemorySummary::as_snapshot();

size_t total_arena_size = 0;
for (int i = 0; i < mt_number_of_types; i++) {
MEMFLAGS flag = NMTUtil::index_to_flag(i);
const MallocMemory* mm = ms->by_type(flag);
_malloc_by_type[i] = mm->malloc_size() + mm->arena_size();
total_arena_size += mm->arena_size();
}

// Total malloc size.
_malloc_total = ms->total();

// Adjustment due to mtChunk double counting.
_malloc_by_type[NMTUtil::flag_to_index(mtChunk)] -= total_arena_size;
_malloc_total -= total_arena_size;

// Adjust mtNMT to include malloc overhead.
_malloc_by_type[NMTUtil::flag_to_index(mtNMT)] += ms->malloc_overhead();
}

void NMTUsage::update_vm_usage() {
const VirtualMemorySnapshot* vms = VirtualMemorySummary::as_snapshot();

// Reset total to allow recalculation.
_vm_total.committed = 0;
_vm_total.reserved = 0;
for (int i = 0; i < mt_number_of_types; i++) {
MEMFLAGS flag = NMTUtil::index_to_flag(i);
const VirtualMemory* vm = vms->by_type(flag);

_vm_by_type[i].reserved = vm->reserved();
_vm_by_type[i].committed = vm->committed();
_vm_total.reserved += vm->reserved();
_vm_total.committed += vm->committed();
}
}

void NMTUsage::refresh() {
if (_usage_options.include_malloc) {
update_malloc_usage();
}

if (_usage_options.include_vm) {
// Thread stacks only makes sense if virtual memory
// is also included. It must be executed before the
// over all usage is calculated.
if (_usage_options.update_thread_stacks) {
walk_thread_stacks();
}
update_vm_usage();
}
}

size_t NMTUsage::total_reserved() const {
return _malloc_total + _vm_total.reserved;
}

size_t NMTUsage::total_committed() const {
return _malloc_total + _vm_total.reserved;
}

size_t NMTUsage::reserved(MEMFLAGS flag) const {
int index = NMTUtil::flag_to_index(flag);
return _malloc_by_type[index] + _vm_by_type[index].reserved;
}

size_t NMTUsage::committed(MEMFLAGS flag) const {
int index = NMTUtil::flag_to_index(flag);
return _malloc_by_type[index] + _vm_by_type[index].committed;
}

1 comment on commit 3b8c7ef

@openjdk-notifier
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.