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