1 /*
2 * Copyright (c) 2017, 2020, Red Hat, Inc. 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
27 #include "gc/shared/workerDataArray.inline.hpp"
28 #include "gc/shenandoah/shenandoahCollectorPolicy.hpp"
29 #include "gc/shenandoah/shenandoahPhaseTimings.hpp"
30 #include "gc/shenandoah/shenandoahHeap.inline.hpp"
31 #include "gc/shenandoah/shenandoahUtils.hpp"
32 #include "gc/shenandoah/heuristics/shenandoahHeuristics.hpp"
33 #include "runtime/orderAccess.hpp"
34 #include "utilities/ostream.hpp"
35
36 #define SHENANDOAH_PHASE_NAME_FORMAT "%-30s"
37 #define SHENANDOAH_S_TIME_FORMAT "%8.3lf"
38 #define SHENANDOAH_US_TIME_FORMAT "%8.0lf"
39 #define SHENANDOAH_US_WORKER_TIME_FORMAT "%3.0lf"
40 #define SHENANDOAH_US_WORKER_NOTIME_FORMAT "%3s"
41 #define SHENANDOAH_PARALLELISM_FORMAT "%4.2lf"
42
43 #define SHENANDOAH_PHASE_DECLARE_NAME(type, title) \
44 title,
45
46 const char* ShenandoahPhaseTimings::_phase_names[] = {
47 SHENANDOAH_PHASE_DO(SHENANDOAH_PHASE_DECLARE_NAME)
48 };
49
50 #undef SHENANDOAH_PHASE_DECLARE_NAME
51
52 ShenandoahPhaseTimings::ShenandoahPhaseTimings(uint max_workers) :
53 _max_workers(max_workers) {
54 assert(_max_workers > 0, "Must have some GC threads");
55
56 // Initialize everything to sane defaults
57 for (uint i = 0; i < _num_phases; i++) {
58 #define SHENANDOAH_WORKER_DATA_NULL(type, title) \
59 _worker_data[i] = NULL;
60 SHENANDOAH_PAR_PHASE_DO(,, SHENANDOAH_WORKER_DATA_NULL)
61 #undef SHENANDOAH_WORKER_DATA_NULL
62 _cycle_data[i] = uninitialized();
63 }
64
65 // Then punch in the worker-related data.
66 // Every worker phase get a bunch of internal objects, except
67 // the very first slot, which is "<total>" and is not populated.
68 for (uint i = 0; i < _num_phases; i++) {
69 if (is_worker_phase(Phase(i))) {
70 int c = 0;
71 #define SHENANDOAH_WORKER_DATA_INIT(type, title) \
72 if (c++ != 0) _worker_data[i + c] = new ShenandoahWorkerData(title, _max_workers);
73 SHENANDOAH_PAR_PHASE_DO(,, SHENANDOAH_WORKER_DATA_INIT)
74 #undef SHENANDOAH_WORKER_DATA_INIT
75 }
76 }
77
78 _policy = ShenandoahHeap::heap()->shenandoah_policy();
79 assert(_policy != NULL, "Can not be NULL");
80 }
81
82 ShenandoahPhaseTimings::Phase ShenandoahPhaseTimings::worker_par_phase(Phase phase, ParPhase par_phase) {
83 assert(is_worker_phase(phase), "Phase should accept worker phase times: %s", phase_name(phase));
84 Phase p = Phase(phase + 1 + par_phase);
85 assert(p >= 0 && p < _num_phases, "Out of bound for: %s", phase_name(phase));
86 return p;
87 }
88
89 ShenandoahWorkerData* ShenandoahPhaseTimings::worker_data(Phase phase, ParPhase par_phase) {
90 Phase p = worker_par_phase(phase, par_phase);
91 ShenandoahWorkerData* wd = _worker_data[p];
92 assert(wd != NULL, "Counter initialized: %s", phase_name(p));
93 return wd;
94 }
95
96 bool ShenandoahPhaseTimings::is_worker_phase(Phase phase) {
97 assert(phase >= 0 && phase < _num_phases, "Out of bounds");
98 switch (phase) {
99 case init_evac:
100 case scan_roots:
101 case update_roots:
102 case final_update_refs_roots:
103 case full_gc_scan_roots:
104 case full_gc_update_roots:
105 case full_gc_adjust_roots:
106 case degen_gc_update_roots:
107 case full_gc_purge_class_unload:
108 case full_gc_purge_weak_par:
109 case purge_class_unload:
110 case purge_weak_par:
111 case heap_iteration_roots:
112 case conc_weak_roots_work:
113 case conc_strong_roots:
114 return true;
115 default:
116 return false;
117 }
118 }
119
120 bool ShenandoahPhaseTimings::is_root_work_phase(Phase phase) {
121 switch (phase) {
122 case scan_roots:
123 case update_roots:
124 case init_evac:
125 case final_update_refs_roots:
126 case degen_gc_update_roots:
127 case full_gc_scan_roots:
128 case full_gc_update_roots:
129 case full_gc_adjust_roots:
130 return true;
131 default:
132 return false;
133 }
134 }
135
136 void ShenandoahPhaseTimings::set_cycle_data(Phase phase, double time) {
137 #ifdef ASSERT
138 double d = _cycle_data[phase];
139 assert(d == uninitialized(), "Should not be set yet: %s, current value: %lf", phase_name(phase), d);
140 #endif
141 _cycle_data[phase] = time;
142 }
143
144 void ShenandoahPhaseTimings::record_phase_time(Phase phase, double time) {
145 if (!_policy->is_at_shutdown()) {
146 set_cycle_data(phase, time);
147 }
148 }
149
150 void ShenandoahPhaseTimings::record_workers_start(Phase phase) {
151 assert(is_worker_phase(phase), "Phase should accept worker phase times: %s", phase_name(phase));
152
153 // Special case: these phases can enter multiple times, need to reset
154 // their worker data every time.
155 if (phase == heap_iteration_roots) {
156 for (uint i = 1; i < _num_par_phases; i++) {
157 worker_data(phase, ParPhase(i))->reset();
158 }
159 }
160
161 #ifdef ASSERT
162 for (uint i = 1; i < _num_par_phases; i++) {
163 ShenandoahWorkerData* wd = worker_data(phase, ParPhase(i));
164 for (uint c = 0; c < _max_workers; c++) {
165 assert(wd->get(c) == ShenandoahWorkerData::uninitialized(),
166 "Should not be set: %s", phase_name(worker_par_phase(phase, ParPhase(i))));
167 }
168 }
169 #endif
170 }
171
172 void ShenandoahPhaseTimings::record_workers_end(Phase phase) {
173 assert(is_worker_phase(phase), "Phase should accept worker phase times: %s", phase_name(phase));
174 }
175
176 void ShenandoahPhaseTimings::flush_par_workers_to_cycle() {
177 for (uint pi = 0; pi < _num_phases; pi++) {
178 Phase phase = Phase(pi);
179 if (is_worker_phase(phase)) {
180 double s = uninitialized();
181 for (uint i = 1; i < _num_par_phases; i++) {
182 ShenandoahWorkerData* wd = worker_data(phase, ParPhase(i));
183 double ws = uninitialized();
184 for (uint c = 0; c < _max_workers; c++) {
185 double v = wd->get(c);
186 if (v != ShenandoahWorkerData::uninitialized()) {
187 if (ws == uninitialized()) {
188 ws = v;
189 } else {
190 ws += v;
191 }
192 }
193 }
194 if (ws != uninitialized()) {
195 // add to each line in phase
196 set_cycle_data(Phase(phase + i + 1), ws);
197 if (s == uninitialized()) {
198 s = ws;
199 } else {
200 s += ws;
201 }
202 }
203 }
204 if (s != uninitialized()) {
205 // add to total for phase
206 set_cycle_data(Phase(phase + 1), s);
207 }
208 }
209 }
210 }
211
212 void ShenandoahPhaseTimings::flush_cycle_to_global() {
213 for (uint i = 0; i < _num_phases; i++) {
214 if (_cycle_data[i] != uninitialized()) {
215 _global_data[i].add(_cycle_data[i]);
216 _cycle_data[i] = uninitialized();
217 }
218 if (_worker_data[i] != NULL) {
219 _worker_data[i]->reset();
220 }
221 }
222 OrderAccess::fence();
223 }
224
225 void ShenandoahPhaseTimings::print_cycle_on(outputStream* out) const {
226 out->cr();
227 out->print_cr("All times are wall-clock times, except per-root-class counters, that are sum over");
228 out->print_cr("all workers. Dividing the <total> over the root stage time estimates parallelism.");
229 out->cr();
230 for (uint i = 0; i < _num_phases; i++) {
231 double v = _cycle_data[i] * 1000000.0;
232 if (v > 0) {
233 out->print(SHENANDOAH_PHASE_NAME_FORMAT " " SHENANDOAH_US_TIME_FORMAT " us", _phase_names[i], v);
234
235 if (is_worker_phase(Phase(i))) {
236 double total = _cycle_data[i + 1] * 1000000.0;
237 if (total > 0) {
238 out->print(", parallelism: " SHENANDOAH_PARALLELISM_FORMAT "x", total / v);
239 }
240 }
241
242 if (_worker_data[i] != NULL) {
243 out->print(", workers (us): ");
244 for (uint c = 0; c < _max_workers; c++) {
245 double tv = _worker_data[i]->get(c);
246 if (tv != ShenandoahWorkerData::uninitialized()) {
247 out->print(SHENANDOAH_US_WORKER_TIME_FORMAT ", ", tv * 1000000.0);
248 } else {
249 out->print(SHENANDOAH_US_WORKER_NOTIME_FORMAT ", ", "---");
250 }
251 }
252 }
253 out->cr();
254 }
255 }
256 }
257
258 void ShenandoahPhaseTimings::print_global_on(outputStream* out) const {
259 out->cr();
260 out->print_cr("GC STATISTICS:");
261 out->print_cr(" \"(G)\" (gross) pauses include VM time: time to notify and block threads, do the pre-");
262 out->print_cr(" and post-safepoint housekeeping. Use -Xlog:safepoint+stats to dissect.");
263 out->print_cr(" \"(N)\" (net) pauses are the times spent in the actual GC code.");
264 out->print_cr(" \"a\" is average time for each phase, look at levels to see if average makes sense.");
265 out->print_cr(" \"lvls\" are quantiles: 0%% (minimum), 25%%, 50%% (median), 75%%, 100%% (maximum).");
266 out->cr();
267 out->print_cr(" All times are wall-clock times, except per-root-class counters, that are sum over");
268 out->print_cr(" all workers. Dividing the <total> over the root stage time estimates parallelism.");
269 out->cr();
270
271 for (uint i = 0; i < _num_phases; i++) {
272 if (_global_data[i].maximum() != 0) {
273 out->print_cr(SHENANDOAH_PHASE_NAME_FORMAT " = " SHENANDOAH_S_TIME_FORMAT " s "
274 "(a = " SHENANDOAH_US_TIME_FORMAT " us) "
275 "(n = " INT32_FORMAT_W(5) ") (lvls, us = "
276 SHENANDOAH_US_TIME_FORMAT ", "
277 SHENANDOAH_US_TIME_FORMAT ", "
278 SHENANDOAH_US_TIME_FORMAT ", "
279 SHENANDOAH_US_TIME_FORMAT ", "
280 SHENANDOAH_US_TIME_FORMAT ")",
281 _phase_names[i],
282 _global_data[i].sum(),
283 _global_data[i].avg() * 1000000.0,
284 _global_data[i].num(),
285 _global_data[i].percentile(0) * 1000000.0,
286 _global_data[i].percentile(25) * 1000000.0,
287 _global_data[i].percentile(50) * 1000000.0,
288 _global_data[i].percentile(75) * 1000000.0,
289 _global_data[i].maximum() * 1000000.0
290 );
291 }
292 }
293 }
294
295 ShenandoahWorkerTimingsTracker::ShenandoahWorkerTimingsTracker(ShenandoahPhaseTimings::Phase phase,
296 ShenandoahPhaseTimings::ParPhase par_phase, uint worker_id) :
297 _timings(ShenandoahHeap::heap()->phase_timings()),
298 _phase(phase), _par_phase(par_phase), _worker_id(worker_id) {
299
300 assert(_timings->worker_data(_phase, _par_phase)->get(_worker_id) == ShenandoahWorkerData::uninitialized(),
301 "Should not be set yet: %s", ShenandoahPhaseTimings::phase_name(_timings->worker_par_phase(_phase, _par_phase)));
302 _start_time = os::elapsedTime();
303 }
304
305 ShenandoahWorkerTimingsTracker::~ShenandoahWorkerTimingsTracker() {
306 _timings->worker_data(_phase, _par_phase)->set(_worker_id, os::elapsedTime() - _start_time);
307
308 if (ShenandoahPhaseTimings::is_root_work_phase(_phase)) {
309 ShenandoahPhaseTimings::Phase root_phase = _phase;
310 ShenandoahPhaseTimings::Phase cur_phase = _timings->worker_par_phase(root_phase, _par_phase);
311 _event.commit(GCId::current(), _worker_id, ShenandoahPhaseTimings::phase_name(cur_phase));
312 }
313 }
314