1/*
2 * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25#include "precompiled.hpp"
26#include "gc/shared/collectedHeap.hpp"
27#include "jfr/leakprofiler/leakProfiler.hpp"
28#include "jfr/leakprofiler/chains/bfsClosure.hpp"
29#include "jfr/leakprofiler/chains/bitset.hpp"
30#include "jfr/leakprofiler/chains/dfsClosure.hpp"
31#include "jfr/leakprofiler/chains/edge.hpp"
32#include "jfr/leakprofiler/chains/edgeQueue.hpp"
33#include "jfr/leakprofiler/chains/edgeStore.hpp"
34#include "jfr/leakprofiler/chains/objectSampleMarker.hpp"
35#include "jfr/leakprofiler/chains/rootSetClosure.hpp"
36#include "jfr/leakprofiler/chains/edgeStore.hpp"
37#include "jfr/leakprofiler/chains/objectSampleMarker.hpp"
38#include "jfr/leakprofiler/chains/pathToGcRootsOperation.hpp"
39#include "jfr/leakprofiler/checkpoint/eventEmitter.hpp"
40#include "jfr/leakprofiler/checkpoint/objectSampleCheckpoint.hpp"
41#include "jfr/leakprofiler/sampling/objectSample.hpp"
42#include "jfr/leakprofiler/sampling/objectSampler.hpp"
43#include "jfr/leakprofiler/utilities/granularTimer.hpp"
44#include "logging/log.hpp"
45#include "memory/universe.hpp"
46#include "oops/markOop.hpp"
47#include "oops/oop.inline.hpp"
48#include "runtime/safepoint.hpp"
49#include "utilities/globalDefinitions.hpp"
50
51PathToGcRootsOperation::PathToGcRootsOperation(ObjectSampler* sampler, EdgeStore* edge_store, int64_t cutoff, bool emit_all) :
52 _sampler(sampler),_edge_store(edge_store), _cutoff_ticks(cutoff), _emit_all(emit_all) {}
53
54/* The EdgeQueue is backed by directly managed virtual memory.
55 * We will attempt to dimension an initial reservation
56 * in proportion to the size of the heap (represented by heap_region).
57 * Initial memory reservation: 5% of the heap OR at least 32 Mb
58 * Commit ratio: 1 : 10 (subject to allocation granularties)
59 */
60static size_t edge_queue_memory_reservation(const MemRegion& heap_region) {
61 const size_t memory_reservation_bytes = MAX2(heap_region.byte_size() / 20, 32*M);
62 assert(memory_reservation_bytes >= (size_t)32*M, "invariant");
63 return memory_reservation_bytes;
64}
65
66static size_t edge_queue_memory_commit_size(size_t memory_reservation_bytes) {
67 const size_t memory_commit_block_size_bytes = memory_reservation_bytes / 10;
68 assert(memory_commit_block_size_bytes >= (size_t)3*M, "invariant");
69 return memory_commit_block_size_bytes;
70}
71
72static void log_edge_queue_summary(const EdgeQueue& edge_queue) {
73 log_trace(jfr, system)("EdgeQueue reserved size total: " SIZE_FORMAT " [KB]", edge_queue.reserved_size() / K);
74 log_trace(jfr, system)("EdgeQueue edges total: " SIZE_FORMAT, edge_queue.top());
75 log_trace(jfr, system)("EdgeQueue liveset total: " SIZE_FORMAT " [KB]", edge_queue.live_set() / K);
76 if (edge_queue.reserved_size() > 0) {
77 log_trace(jfr, system)("EdgeQueue commit reserve ratio: %f\n",
78 ((double)edge_queue.live_set() / (double)edge_queue.reserved_size()));
79 }
80}
81
82void PathToGcRootsOperation::doit() {
83 assert(SafepointSynchronize::is_at_safepoint(), "invariant");
84 assert(_cutoff_ticks > 0, "invariant");
85
86 // The bitset used for marking is dimensioned as a function of the heap size
87 const MemRegion heap_region = Universe::heap()->reserved_region();
88 BitSet mark_bits(heap_region);
89
90 // The edge queue is dimensioned as a fraction of the heap size
91 const size_t edge_queue_reservation_size = edge_queue_memory_reservation(heap_region);
92 EdgeQueue edge_queue(edge_queue_reservation_size, edge_queue_memory_commit_size(edge_queue_reservation_size));
93
94 // The initialize() routines will attempt to reserve and allocate backing storage memory.
95 // Failure to accommodate will render root chain processing impossible.
96 // As a fallback on failure, just write out the existing samples, flat, without chains.
97 if (!(mark_bits.initialize() && edge_queue.initialize())) {
98 log_warning(jfr)("Unable to allocate memory for root chain processing");
99 return;
100 }
101
102 // Save the original markWord for the potential leak objects,
103 // to be restored on function exit
104 ObjectSampleMarker marker;
105 if (ObjectSampleCheckpoint::mark(_sampler, marker, _emit_all) == 0) {
106 // no valid samples to process
107 return;
108 }
109
110 // Necessary condition for attempting a root set iteration
111 Universe::heap()->ensure_parsability(false);
112
113 BFSClosure bfs(&edge_queue, _edge_store, &mark_bits);
114 RootSetClosure<BFSClosure> roots(&bfs);
115
116 GranularTimer::start(_cutoff_ticks, 1000000);
117 roots.process();
118 if (edge_queue.is_full()) {
119 // Pathological case where roots don't fit in queue
120 // Do a depth-first search, but mark roots first
121 // to avoid walking sideways over roots
122 DFSClosure::find_leaks_from_root_set(_edge_store, &mark_bits);
123 } else {
124 bfs.process();
125 }
126 GranularTimer::stop();
127 log_edge_queue_summary(edge_queue);
128
129 // Emit old objects including their reference chains as events
130 EventEmitter emitter(GranularTimer::start_time(), GranularTimer::end_time());
131 emitter.write_events(_sampler, _edge_store, _emit_all);
132}
133