1 /*
   2  * Copyright (c) 2013, 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 #ifndef SHARE_VM_GC_IMPLEMENTATION_G1_G1GCPHASETIMESLOG_HPP
  26 #define SHARE_VM_GC_IMPLEMENTATION_G1_G1GCPHASETIMESLOG_HPP
  27 
  28 #include "memory/allocation.hpp"
  29 #include "gc_interface/gcCause.hpp"
  30 
  31 template <class T>
  32 class WorkerDataArray  : public CHeapObj<mtGC> {
  33   T*          _data;
  34   uint        _length;
  35   const char* _print_format;
  36   bool        _print_sum;
  37 
  38   NOT_PRODUCT(static const T _uninitialized;)
  39 
  40   // We are caching the sum and average to only have to calculate them once.
  41   // This is not done in an MT-safe way. It is intended to allow single
  42   // threaded code to call sum() and average() multiple times in any order
  43   // without having to worry about the cost.
  44   bool   _has_new_data;
  45   T      _sum;
  46   double _average;
  47 
  48  public:
  49   WorkerDataArray(uint length, const char* print_format, bool print_sum = true) :
  50   _length(length), _print_format(print_format), _print_sum(print_sum), _has_new_data(true) {
  51     assert(length > 0, "Must have some workers to store data for");
  52     _data = NEW_C_HEAP_ARRAY(T, _length, mtGC);
  53   }
  54 
  55   ~WorkerDataArray() {
  56     FREE_C_HEAP_ARRAY(T, _data, mtGC);
  57   }
  58 
  59   void set(uint worker_i, T value) {
  60     assert(worker_i < _length, err_msg("Worker %d is greater than max: %d", worker_i, _length));
  61     assert(_data[worker_i] == (T)-1, err_msg("Overwriting data for worker %d", worker_i));
  62     _data[worker_i] = value;
  63     _has_new_data = true;
  64   }
  65 
  66   T get(uint worker_i) {
  67     assert(worker_i < _length, err_msg("Worker %d is greater than max: %d", worker_i, _length));
  68     assert(_data[worker_i] != (T)-1, err_msg("No data to add to for worker %d", worker_i));
  69     return _data[worker_i];
  70   }
  71 
  72   void add(uint worker_i, T value) {
  73     assert(worker_i < _length, err_msg("Worker %d is greater than max: %d", worker_i, _length));
  74     assert(_data[worker_i] != (T)-1, err_msg("No data to add to for worker %d", worker_i));
  75     _data[worker_i] += value;
  76     _has_new_data = true;
  77   }
  78 
  79   double average(){
  80     if (_has_new_data) {
  81       calculate_totals();
  82     }
  83     return _average;
  84   }
  85 
  86   T sum() {
  87     if (_has_new_data) {
  88       calculate_totals();
  89     }
  90     return _sum;
  91   }
  92 
  93   void print(int level, const char* title);
  94 
  95   void reset() PRODUCT_RETURN;
  96   void verify() PRODUCT_RETURN;
  97 
  98  private:
  99 
 100   void calculate_totals(){
 101     _sum = (T)0;
 102     for (uint i = 0; i < _length; ++i) {
 103       _sum += _data[i];
 104     }
 105     _average = (double)_sum / (double)_length;
 106     _has_new_data = false;
 107   }
 108 };
 109 
 110 class G1GCPhaseTimes : public CHeapObj<mtGC> {
 111 
 112  private:
 113   uint _active_gc_threads;
 114   uint _max_gc_threads;
 115 
 116   WorkerDataArray<double> _last_gc_worker_start_times_ms;
 117   WorkerDataArray<double> _last_ext_root_scan_times_ms;
 118   WorkerDataArray<double> _last_satb_filtering_times_ms;
 119   WorkerDataArray<double> _last_update_rs_times_ms;
 120   WorkerDataArray<int>    _last_update_rs_processed_buffers;
 121   WorkerDataArray<double> _last_scan_rs_times_ms;
 122   WorkerDataArray<double> _last_strong_code_root_scan_times_ms;
 123   WorkerDataArray<double> _last_strong_code_root_mark_times_ms;
 124   WorkerDataArray<double> _last_obj_copy_times_ms;
 125   WorkerDataArray<double> _last_termination_times_ms;
 126   WorkerDataArray<size_t> _last_termination_attempts;
 127   WorkerDataArray<double> _last_gc_worker_end_times_ms;
 128   WorkerDataArray<double> _last_gc_worker_times_ms;
 129   WorkerDataArray<double> _last_gc_worker_other_times_ms;
 130 
 131   double _cur_collection_par_time_ms;
 132   double _cur_collection_code_root_fixup_time_ms;
 133   double _cur_strong_code_root_migration_time_ms;
 134 
 135   double                  _cur_string_dedup_fixup_time_ms;
 136   WorkerDataArray<double> _cur_string_dedup_queue_fixup_worker_times_ms;
 137   WorkerDataArray<double> _cur_string_dedup_table_fixup_worker_times_ms;
 138 
 139   double _cur_clear_ct_time_ms;
 140   double _cur_ref_proc_time_ms;
 141   double _cur_ref_enq_time_ms;
 142 
 143   double _cur_collection_start_sec;
 144   double _root_region_scan_wait_time_ms;
 145 
 146   double _recorded_young_cset_choice_time_ms;
 147   double _recorded_non_young_cset_choice_time_ms;
 148 
 149   double _recorded_young_free_cset_time_ms;
 150   double _recorded_non_young_free_cset_time_ms;
 151 
 152   double _cur_verify_before_time_ms;
 153   double _cur_verify_after_time_ms;
 154 
 155   // Helper methods for detailed logging
 156   void print_stats(int level, const char* str, double value);
 157   void print_stats(int level, const char* str, double value, int workers);
 158 
 159  public:
 160   G1GCPhaseTimes(uint max_gc_threads);
 161   void note_gc_start(uint active_gc_threads);
 162   void note_gc_end();
 163   void print(double pause_time_sec);
 164 
 165   void record_gc_worker_start_time(uint worker_i, double ms) {
 166     _last_gc_worker_start_times_ms.set(worker_i, ms);
 167   }
 168 
 169   void record_ext_root_scan_time(uint worker_i, double ms) {
 170     _last_ext_root_scan_times_ms.set(worker_i, ms);
 171   }
 172 
 173   void record_satb_filtering_time(uint worker_i, double ms) {
 174     _last_satb_filtering_times_ms.set(worker_i, ms);
 175   }
 176 
 177   void record_update_rs_time(uint worker_i, double ms) {
 178     _last_update_rs_times_ms.set(worker_i, ms);
 179   }
 180 
 181   void record_update_rs_processed_buffers(uint worker_i, int processed_buffers) {
 182     _last_update_rs_processed_buffers.set(worker_i, processed_buffers);
 183   }
 184 
 185   void record_scan_rs_time(uint worker_i, double ms) {
 186     _last_scan_rs_times_ms.set(worker_i, ms);
 187   }
 188 
 189   void record_strong_code_root_scan_time(uint worker_i, double ms) {
 190     _last_strong_code_root_scan_times_ms.set(worker_i, ms);
 191   }
 192 
 193   void record_strong_code_root_mark_time(uint worker_i, double ms) {
 194     _last_strong_code_root_mark_times_ms.set(worker_i, ms);
 195   }
 196 
 197   void record_obj_copy_time(uint worker_i, double ms) {
 198     _last_obj_copy_times_ms.set(worker_i, ms);
 199   }
 200 
 201   void add_obj_copy_time(uint worker_i, double ms) {
 202     _last_obj_copy_times_ms.add(worker_i, ms);
 203   }
 204 
 205   void record_termination(uint worker_i, double ms, size_t attempts) {
 206     _last_termination_times_ms.set(worker_i, ms);
 207     _last_termination_attempts.set(worker_i, attempts);
 208   }
 209 
 210   void record_gc_worker_end_time(uint worker_i, double ms) {
 211     _last_gc_worker_end_times_ms.set(worker_i, ms);
 212   }
 213 
 214   void record_clear_ct_time(double ms) {
 215     _cur_clear_ct_time_ms = ms;
 216   }
 217 
 218   void record_par_time(double ms) {
 219     _cur_collection_par_time_ms = ms;
 220   }
 221 
 222   void record_code_root_fixup_time(double ms) {
 223     _cur_collection_code_root_fixup_time_ms = ms;
 224   }
 225 
 226   void record_strong_code_root_migration_time(double ms) {
 227     _cur_strong_code_root_migration_time_ms = ms;
 228   }
 229 
 230   void note_string_dedup_fixup_start();
 231   void note_string_dedup_fixup_end();
 232 
 233   void record_string_dedup_fixup_time(double ms) {
 234     _cur_string_dedup_fixup_time_ms = ms;
 235   }
 236 
 237   void record_string_dedup_queue_fixup_worker_time(uint worker_id, double ms) {
 238     _cur_string_dedup_queue_fixup_worker_times_ms.set(worker_id, ms);
 239   }
 240 
 241   void record_string_dedup_table_fixup_worker_time(uint worker_id, double ms) {
 242     _cur_string_dedup_table_fixup_worker_times_ms.set(worker_id, ms);
 243   }
 244 
 245   void record_ref_proc_time(double ms) {
 246     _cur_ref_proc_time_ms = ms;
 247   }
 248 
 249   void record_ref_enq_time(double ms) {
 250     _cur_ref_enq_time_ms = ms;
 251   }
 252 
 253   void record_root_region_scan_wait_time(double time_ms) {
 254     _root_region_scan_wait_time_ms = time_ms;
 255   }
 256 
 257   void record_young_free_cset_time_ms(double time_ms) {
 258     _recorded_young_free_cset_time_ms = time_ms;
 259   }
 260 
 261   void record_non_young_free_cset_time_ms(double time_ms) {
 262     _recorded_non_young_free_cset_time_ms = time_ms;
 263   }
 264 
 265   void record_young_cset_choice_time_ms(double time_ms) {
 266     _recorded_young_cset_choice_time_ms = time_ms;
 267   }
 268 
 269   void record_non_young_cset_choice_time_ms(double time_ms) {
 270     _recorded_non_young_cset_choice_time_ms = time_ms;
 271   }
 272 
 273   void record_cur_collection_start_sec(double time_ms) {
 274     _cur_collection_start_sec = time_ms;
 275   }
 276 
 277   void record_verify_before_time_ms(double time_ms) {
 278     _cur_verify_before_time_ms = time_ms;
 279   }
 280 
 281   void record_verify_after_time_ms(double time_ms) {
 282     _cur_verify_after_time_ms = time_ms;
 283   }
 284 
 285   double accounted_time_ms();
 286 
 287   double cur_collection_start_sec() {
 288     return _cur_collection_start_sec;
 289   }
 290 
 291   double cur_collection_par_time_ms() {
 292     return _cur_collection_par_time_ms;
 293   }
 294 
 295   double cur_clear_ct_time_ms() {
 296     return _cur_clear_ct_time_ms;
 297   }
 298 
 299   double root_region_scan_wait_time_ms() {
 300     return _root_region_scan_wait_time_ms;
 301   }
 302 
 303   double young_cset_choice_time_ms() {
 304     return _recorded_young_cset_choice_time_ms;
 305   }
 306 
 307   double young_free_cset_time_ms() {
 308     return _recorded_young_free_cset_time_ms;
 309   }
 310 
 311   double non_young_cset_choice_time_ms() {
 312     return _recorded_non_young_cset_choice_time_ms;
 313   }
 314 
 315   double non_young_free_cset_time_ms() {
 316     return _recorded_non_young_free_cset_time_ms;
 317   }
 318 
 319   double average_last_update_rs_time() {
 320     return _last_update_rs_times_ms.average();
 321   }
 322 
 323   int sum_last_update_rs_processed_buffers() {
 324     return _last_update_rs_processed_buffers.sum();
 325   }
 326 
 327   double average_last_scan_rs_time(){
 328     return _last_scan_rs_times_ms.average();
 329   }
 330 
 331   double average_last_strong_code_root_scan_time(){
 332     return _last_strong_code_root_scan_times_ms.average();
 333   }
 334 
 335   double average_last_strong_code_root_mark_time(){
 336     return _last_strong_code_root_mark_times_ms.average();
 337   }
 338 
 339   double average_last_obj_copy_time() {
 340     return _last_obj_copy_times_ms.average();
 341   }
 342 
 343   double average_last_termination_time() {
 344     return _last_termination_times_ms.average();
 345   }
 346 
 347   double average_last_ext_root_scan_time() {
 348     return _last_ext_root_scan_times_ms.average();
 349   }
 350 
 351   double average_last_satb_filtering_times_ms() {
 352     return _last_satb_filtering_times_ms.average();
 353   }
 354 };
 355 
 356 #endif // SHARE_VM_GC_IMPLEMENTATION_G1_G1GCPHASETIMESLOG_HPP