1 /*
2 * Copyright (c) 2017, 2021, 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 #ifndef SHARE_GC_SHENANDOAH_SHENANDOAHPHASETIMINGS_HPP
26 #define SHARE_GC_SHENANDOAH_SHENANDOAHPHASETIMINGS_HPP
27
28 #include "jfr/jfrEvents.hpp"
29 #include "gc/shenandoah/shenandoahNumberSeq.hpp"
30 #include "gc/shared/workerDataArray.hpp"
31 #include "memory/allocation.hpp"
32
33 class ShenandoahCollectorPolicy;
34 class outputStream;
35
36 #define SHENANDOAH_PAR_PHASE_DO(CNT_PREFIX, DESC_PREFIX, f) \
37 f(CNT_PREFIX ## TotalWork, DESC_PREFIX "<total>") \
38 f(CNT_PREFIX ## ThreadRoots, DESC_PREFIX "Thread Roots") \
39 f(CNT_PREFIX ## CodeCacheRoots, DESC_PREFIX "Code Cache Roots") \
40 f(CNT_PREFIX ## VMStrongRoots, DESC_PREFIX "VM Strong Roots") \
41 f(CNT_PREFIX ## VMWeakRoots, DESC_PREFIX "VM Weak Roots") \
42 f(CNT_PREFIX ## CLDGRoots, DESC_PREFIX "CLDG Roots") \
43 f(CNT_PREFIX ## CodeCacheUnload, DESC_PREFIX "Unload Code Caches") \
44 f(CNT_PREFIX ## CLDUnlink, DESC_PREFIX "Unlink CLDs") \
45 f(CNT_PREFIX ## WeakRefProc, DESC_PREFIX "Weak References") \
46 f(CNT_PREFIX ## ParallelMark, DESC_PREFIX "Parallel Mark") \
47 f(CNT_PREFIX ## ScanClusters, DESC_PREFIX "Scan Clusters")
48 // end
49
50 #define SHENANDOAH_PHASE_DO(f) \
51 f(conc_reset, "Concurrent Reset") \
52 \
53 f(init_mark_gross, "Pause Init Mark (G)") \
54 f(init_mark, "Pause Init Mark (N)") \
55 f(init_manage_tlabs, " Manage TLABs") \
56 f(init_swap_rset, " Swap Remembered Set") \
57 f(init_transfer_satb, " Transfer Old From SATB") \
58 f(init_update_region_states, " Update Region States") \
59 \
60 f(init_scan_rset, "Concurrent Scan Remembered Set") \
61 SHENANDOAH_PAR_PHASE_DO(init_scan_rset_, " RS: ", f) \
62 \
63 f(conc_mark_roots, "Concurrent Mark Roots ") \
64 SHENANDOAH_PAR_PHASE_DO(conc_mark_roots, " CMR: ", f) \
65 f(conc_mark, "Concurrent Marking") \
66 SHENANDOAH_PAR_PHASE_DO(conc_mark, " CM: ", f) \
67 \
68 f(final_mark_gross, "Pause Final Mark (G)") \
69 f(final_mark, "Pause Final Mark (N)") \
70 f(finish_mark, " Finish Mark") \
71 SHENANDOAH_PAR_PHASE_DO(finish_mark_, " FM: ", f) \
72 f(purge, " System Purge") \
73 SHENANDOAH_PAR_PHASE_DO(purge_cu_par_, " CU: ", f) \
74 f(purge_weak_par, " Weak Roots") \
75 SHENANDOAH_PAR_PHASE_DO(purge_weak_par_, " WR: ", f) \
76 f(final_update_region_states, " Update Region States") \
77 f(final_manage_labs, " Manage GC/TLABs") \
78 f(choose_cset, " Choose Collection Set") \
79 f(final_rebuild_freeset, " Rebuild Free Set") \
80 f(init_evac, " Initial Evacuation") \
81 SHENANDOAH_PAR_PHASE_DO(evac_, " E: ", f) \
82 \
83 f(conc_thread_roots, "Concurrent Thread Roots") \
84 SHENANDOAH_PAR_PHASE_DO(conc_thread_roots_, " CTR: ", f) \
85 f(conc_weak_refs, "Concurrent Weak References") \
86 SHENANDOAH_PAR_PHASE_DO(conc_weak_refs_, " CWRF: ", f) \
87 f(conc_weak_roots, "Concurrent Weak Roots") \
88 f(conc_weak_roots_work, " Roots") \
89 SHENANDOAH_PAR_PHASE_DO(conc_weak_roots_work_, " CWR: ", f) \
90 f(conc_weak_roots_rendezvous, " Rendezvous") \
91 f(conc_cleanup_early, "Concurrent Cleanup") \
92 f(conc_class_unload, "Concurrent Class Unloading") \
93 f(conc_class_unload_unlink, " Unlink Stale") \
94 f(conc_class_unload_unlink_sd, " System Dictionary") \
95 f(conc_class_unload_unlink_weak_klass, " Weak Class Links") \
96 f(conc_class_unload_unlink_code_roots, " Code Roots") \
97 f(conc_class_unload_rendezvous, " Rendezvous") \
98 f(conc_class_unload_purge, " Purge Unlinked") \
99 f(conc_class_unload_purge_coderoots, " Code Roots") \
100 f(conc_class_unload_purge_cldg, " CLDG") \
101 f(conc_class_unload_purge_ec, " Exception Caches") \
102 f(conc_strong_roots, "Concurrent Strong Roots") \
103 SHENANDOAH_PAR_PHASE_DO(conc_strong_roots_, " CSR: ", f) \
104 f(coalesce_and_fill, "Coalesce and Fill Old Dead") \
105 SHENANDOAH_PAR_PHASE_DO(coalesce_and_fill_, " CFOD: ", f) \
106 f(conc_evac, "Concurrent Evacuation") \
107 \
108 f(final_roots_gross, "Pause Final Roots (G)") \
109 f(final_roots, "Pause Final Roots (N)") \
110 \
111 f(init_update_refs_gross, "Pause Init Update Refs (G)") \
112 f(init_update_refs, "Pause Init Update Refs (N)") \
113 f(init_update_refs_manage_gclabs, " Manage GCLABs") \
114 \
115 f(conc_update_refs, "Concurrent Update Refs") \
116 f(conc_update_thread_roots, "Concurrent Update Thread Roots") \
117 \
118 f(final_update_refs_gross, "Pause Final Update Refs (G)") \
119 f(final_update_refs, "Pause Final Update Refs (N)") \
120 f(final_update_refs_finish_work, " Finish Work") \
121 f(final_update_refs_update_region_states, " Update Region States") \
122 f(final_update_refs_trash_cset, " Trash Collection Set") \
123 f(final_update_refs_rebuild_freeset, " Rebuild Free Set") \
124 \
125 f(conc_cleanup_complete, "Concurrent Cleanup") \
126 \
127 f(degen_gc_gross, "Pause Degenerated GC (G)") \
128 f(degen_gc, "Pause Degenerated GC (N)") \
129 f(degen_gc_stw_mark, " Degen STW Mark") \
130 SHENANDOAH_PAR_PHASE_DO(degen_gc_stw_mark_, " DSM: ", f) \
131 f(degen_gc_mark, " Degen Mark") \
132 SHENANDOAH_PAR_PHASE_DO(degen_gc_mark_, " DM: ", f) \
133 f(degen_gc_purge, " System Purge") \
134 f(degen_gc_weakrefs, " Weak References") \
135 SHENANDOAH_PAR_PHASE_DO(degen_gc_weakrefs_p_, " WRP: ", f) \
136 f(degen_gc_purge_class_unload, " Unload Classes") \
137 SHENANDOAH_PAR_PHASE_DO(degen_gc_purge_cu_par_, " DCU: ", f) \
138 f(degen_gc_purge_weak_par, " Weak Roots") \
139 SHENANDOAH_PAR_PHASE_DO(degen_gc_purge_weak_p_, " DWR: ", f) \
140 f(degen_gc_purge_cldg, " CLDG") \
141 f(degen_gc_final_update_region_states, " Update Region States") \
142 f(degen_gc_final_manage_labs, " Manage GC/TLABs") \
143 f(degen_gc_choose_cset, " Choose Collection Set") \
144 f(degen_gc_final_rebuild_freeset, " Rebuild Free Set") \
145 f(degen_gc_stw_evac, " Evacuation") \
146 f(degen_gc_init_update_refs_manage_gclabs, " Manage GCLABs") \
147 f(degen_gc_updaterefs, " Update References") \
148 f(degen_gc_final_update_refs_finish_work, " Finish Work") \
149 f(degen_gc_final_update_refs_update_region_states," Update Region States") \
150 f(degen_gc_final_update_refs_trash_cset, " Trash Collection Set") \
151 f(degen_gc_final_update_refs_rebuild_freeset, " Rebuild Free Set") \
152 f(degen_gc_update_roots, " Degen Update Roots") \
153 SHENANDOAH_PAR_PHASE_DO(degen_gc_update_, " DU: ", f) \
154 f(degen_gc_cleanup_complete, " Cleanup") \
155 \
156 f(full_gc_gross, "Pause Full GC (G)") \
157 f(full_gc, "Pause Full GC (N)") \
158 f(full_gc_heapdump_pre, " Pre Heap Dump") \
159 f(full_gc_prepare, " Prepare") \
160 f(full_gc_update_roots, " Update Roots") \
161 SHENANDOAH_PAR_PHASE_DO(full_gc_update_roots_, " FU: ", f) \
162 f(full_gc_mark, " Mark") \
163 SHENANDOAH_PAR_PHASE_DO(full_gc_mark_, " FM: ", f) \
164 f(full_gc_purge, " System Purge") \
165 f(full_gc_weakrefs, " Weak References") \
166 SHENANDOAH_PAR_PHASE_DO(full_gc_weakrefs_p_, " WRP: ", f) \
167 f(full_gc_purge_class_unload, " Unload Classes") \
168 SHENANDOAH_PAR_PHASE_DO(full_gc_purge_cu_par_, " CU: ", f) \
169 f(full_gc_purge_weak_par, " Weak Roots") \
170 SHENANDOAH_PAR_PHASE_DO(full_gc_purge_weak_p_, " WR: ", f) \
171 f(full_gc_purge_cldg, " CLDG") \
172 f(full_gc_calculate_addresses, " Calculate Addresses") \
173 f(full_gc_calculate_addresses_regular, " Regular Objects") \
174 f(full_gc_calculate_addresses_humong, " Humongous Objects") \
175 f(full_gc_adjust_pointers, " Adjust Pointers") \
176 f(full_gc_adjust_roots, " Adjust Roots") \
177 SHENANDOAH_PAR_PHASE_DO(full_gc_adjust_roots_, " FA: ", f) \
178 f(full_gc_copy_objects, " Copy Objects") \
179 f(full_gc_copy_objects_regular, " Regular Objects") \
180 f(full_gc_copy_objects_humong, " Humongous Objects") \
181 f(full_gc_copy_objects_reset_complete, " Reset Complete Bitmap") \
182 f(full_gc_copy_objects_rebuild, " Rebuild Region Sets") \
183 f(full_gc_reconstruct_remembered_set, " Reconstruct Remembered Set") \
184 f(full_gc_heapdump_post, " Post Heap Dump") \
185 \
186 f(conc_uncommit, "Concurrent Uncommit") \
187 f(pacing, "Pacing") \
188 \
189 f(heap_iteration_roots, "Heap Iteration") \
190 SHENANDOAH_PAR_PHASE_DO(heap_iteration_roots_, " HI: ", f) \
191 // end
192
193 typedef WorkerDataArray<double> ShenandoahWorkerData;
194
195 class ShenandoahPhaseTimings : public CHeapObj<mtGC> {
196 friend class ShenandoahGCPhase;
197 friend class ShenandoahWorkerTimingsTracker;
198 public:
199 #define SHENANDOAH_PHASE_DECLARE_ENUM(type, title) type,
200
201 enum Phase {
202 SHENANDOAH_PHASE_DO(SHENANDOAH_PHASE_DECLARE_ENUM)
203 _num_phases,
204 _invalid_phase = _num_phases
205 };
206
207 enum ParPhase {
208 SHENANDOAH_PAR_PHASE_DO(,, SHENANDOAH_PHASE_DECLARE_ENUM)
209 _num_par_phases
210 };
211
212 #undef SHENANDOAH_PHASE_DECLARE_ENUM
213
214 private:
215 uint _max_workers;
216 double _cycle_data[_num_phases];
217 HdrSeq _global_data[_num_phases];
218 static const char* _phase_names[_num_phases];
219
220 ShenandoahWorkerData* _worker_data[_num_phases];
221 ShenandoahCollectorPolicy* _policy;
222
223 static bool is_worker_phase(Phase phase);
224 static bool is_root_work_phase(Phase phase);
225
226 ShenandoahWorkerData* worker_data(Phase phase, ParPhase par_phase);
227 Phase worker_par_phase(Phase phase, ParPhase par_phase);
228
229 void set_cycle_data(Phase phase, double time);
230 static double uninitialized() { return -1; }
231
232 public:
233 ShenandoahPhaseTimings(uint max_workers);
234
235 void record_phase_time(Phase phase, double time);
236
237 void record_workers_start(Phase phase);
238 void record_workers_end(Phase phase);
239
240 void flush_par_workers_to_cycle();
241 void flush_cycle_to_global();
242
243 static const char* phase_name(Phase phase) {
244 assert(phase >= 0 && phase < _num_phases, "Out of bound");
245 return _phase_names[phase];
246 }
247
248 void print_cycle_on(outputStream* out) const;
249 void print_global_on(outputStream* out) const;
250 };
251
252 class ShenandoahWorkerTimingsTracker : public StackObj {
253 private:
254 ShenandoahPhaseTimings* const _timings;
255 ShenandoahPhaseTimings::Phase const _phase;
256 ShenandoahPhaseTimings::ParPhase const _par_phase;
257 uint const _worker_id;
258
259 double _start_time;
260 EventGCPhaseParallel _event;
261 public:
262 ShenandoahWorkerTimingsTracker(ShenandoahPhaseTimings::Phase phase, ShenandoahPhaseTimings::ParPhase par_phase,
263 uint worker_id, bool cumulative = false);
264 ~ShenandoahWorkerTimingsTracker();
265 };
266
267 #endif // SHARE_GC_SHENANDOAH_SHENANDOAHPHASETIMINGS_HPP